/*******************************************************************************
* Copyright (c) 2004, 2014 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Doug Schaefer (IBM) - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.core.dom.ast;
/**
* Represents a node location that is directly in the source file.
*
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IASTFileLocation extends IASTNodeLocation {
/**
* The name of the file.
*
* @return the name of the file
*/
public String getFileName();
/**
* Returns the offset within the file where this location starts.
*/
@Override
public int getNodeOffset();
/**
* Returns the length of this location in terms of characters.
*/
@Override
public int getNodeLength();
/**
* Returns the starting line number. Locations obtained via the index do not have line numbers
* and return {@code 0}.
*
* @return the 1-based line number, or {@code 0} if not applicable
*/
public int getStartingLineNumber();
/**
* Returns the ending line number. Locations obtained via the index do not have line numbers
* and return {@code 0}.
*
* @return the 1-based line number, or {@code 0} if not applicable
*/
public int getEndingLineNumber();
/**
* Returns the inclusion statement that included this file, or {@code null} for
* a top-level file.
* Also {@code null} when the file location does not belong to an AST node, e.g.
* if it is obtained from a name in the index.
* @since 5.4
*/
public IASTPreprocessorIncludeStatement getContextInclusionStatement();
}