/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */

package netscape.jsdebug;

/**
* An implementation of the SourceLocation interface is used to represent
* a location in a source file.  Java classfiles only make source locations
* available at the line-by-line granularity, but other languages may
* include finer-grain information.  At this time only line number
* information is included.
*
* @author  John Bandhauer
* @author  Nick Thompson
* @version 1.0
* @since   1.0
*/
/* XXX must source locations be contiguous? */
public abstract class SourceLocation {
    /**
     * Gets the first line number associated with this SourceLocation.
     * This is the lowest common denominator information that will be
     * available: some implementations may choose to include more
     * specific location information in a subclass of SourceLocation.
     *
     * @returns source line number cooresponding to this location
     */
    public abstract int getLine();

    /**
     * Get the first PC associated with a given SourceLocation.
     * This is the place to set a breakpoint at that location.
     *
     * @returns pc object or null if there is no code corresponding 
     * to this source location.
     */
    public abstract PC getPC();
}