Eclipse CDT
7.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.IASTPreprocessorStatement
MACRO_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 isResolvedByHeuristics()
          Returns whether the inclusion was resolved using a heuristics.
 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, copy, getChildren, getContainingFilename, getFileLocation, getLeadingSyntax, getNodeLocations, getParent, getPropertyInParent, getRawSignature, getSyntax, getTrailingSyntax, getTranslationUnit, isFrozen, isPartOfTranslationUnitFile, setParent, setPropertyInParent
 

Field Detail

INCLUDE_NAME

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

Method Detail

getPath

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


getName

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

Since:
4.0

isSystemInclude

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

Since:
4.0

isActive

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

Specified by:
isActive in interface IASTNode
Since:
4.0

isResolved

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

Since:
4.0

isResolvedByHeuristics

boolean isResolvedByHeuristics()
Returns whether the inclusion was resolved using a heuristics.

Since:
5.1

Eclipse CDT
7.0

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