Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.core.dom.ast
Interface IASTPreprocessorIncludeStatement

All Superinterfaces:
IASTNode, IASTPreprocessorStatement

public interface IASTPreprocessorIncludeStatement
extends IASTPreprocessorStatement

This interface represent a preprocessor #include statement.


Field Summary
static ASTNodeProperty INCLUDE_NAME
          INCLUDE_NAME describes the relationship between an include directive and it's name.
 
Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode
EMPTY_NODE_ARRAY
 
Method Summary
 IASTName getName()
          Returns the name of the file as specified in the directive.
 String getPath()
          Returns the absolute location of the file found through #include.
 boolean isActive()
          Returns whether this include directive was actually taken.
 boolean isResolved()
          Returns whether this include file was successfully resolved.
 boolean isSystemInclude()
          Returns whether this is a system include (one specified with angle brackets).
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode
accept, contains, getContainingFilename, getFileLocation, getNodeLocations, getParent, getPropertyInParent, getRawSignature, getTranslationUnit, setParent, setPropertyInParent
 

Field Detail

INCLUDE_NAME

public static final ASTNodeProperty INCLUDE_NAME
INCLUDE_NAME describes the relationship between an include directive and it's name.

Method Detail

getPath

public String getPath()
Returns the absolute location of the file found through #include. Only valid if isResolved() returns true.


getName

public IASTName getName()
Returns the name of the file as specified in the directive. Does not include quotes or angle brackets.

Since:
4.0

isSystemInclude

public boolean isSystemInclude()
Returns whether this is a system include (one specified with angle brackets).

Since:
4.0

isActive

public boolean isActive()
Returns whether this include directive was actually taken.

Since:
4.0

isResolved

public boolean isResolved()
Returns whether this include file was successfully resolved.

Since:
4.0

Eclipse CDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2004. All Rights Reserved.