Eclipse CDT
7.0

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

All Superinterfaces:
IASTNode, IASTPreprocessorStatement, IFileNomination

public interface IASTPreprocessorIncludeStatement
extends IASTPreprocessorStatement, IFileNomination

This interface represents a preprocessor #include statement.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode
IASTNode.CopyStyle
 
Field Summary
static ASTNodeProperty INCLUDE_NAME
          INCLUDE_NAME describes the relationship between an include directive and its 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
 boolean createsAST()
          Returns true, if an attempt will be or has been made to create AST for the target of this inclusion.
 org.eclipse.cdt.core.index.IIndexFile getImportedIndexFile()
          Returns the file from the index that this include statement has pulled in, or null if the include creates AST or is unresolved or skipped.
 long getIncludedFileContentsHash()
          Returns a hash-code for the contents of the file included, or 0 if the content has not been parsed.
 long getIncludedFileReadTime()
          Returns time when the included file was read.
 long getIncludedFileSize()
          Returns the size of the included file, or -1 if the file was not read.
 long getIncludedFileTimestamp()
          Returns the modification time of the included file, or -1 if the file was not read.
 org.eclipse.cdt.core.parser.ISignificantMacros[] getLoadedVersions()
          Returns the list of versions of the target file, each of which is identified by its significant macros, that had been included in this translation-unit prior to this statement.
 IASTName getName()
          Returns the name of the file as specified in the directive.
 java.lang.String getPath()
          Returns the absolute location of the file found through #include, or an empty string if include was not resolved.
 boolean isActive()
          Returns whether this include directive was actually taken.
 boolean isErrorInIncludedFile()
          Returns true if I/O errors were encountered while reading the included file.
 boolean isIncludedFileExported()
          Returns true if the included file is exported by the including header.
 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, copy, getChildren, getContainingFilename, getFileLocation, getLeadingSyntax, getNodeLocations, getOriginalNode, getParent, getPropertyInParent, getRawSignature, getSyntax, getTrailingSyntax, getTranslationUnit, isFrozen, isPartOfTranslationUnitFile, setParent, setPropertyInParent
 
Methods inherited from interface org.eclipse.cdt.core.dom.ast.IFileNomination
getSignificantMacros, hasPragmaOnceSemantics
 

Field Detail

INCLUDE_NAME

static final ASTNodeProperty INCLUDE_NAME
INCLUDE_NAME describes the relationship between an include directive and its name.

Method Detail

getPath

java.lang.String getPath()
Returns the absolute location of the file found through #include, or an empty string if include was not resolved.


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

getLoadedVersions

org.eclipse.cdt.core.parser.ISignificantMacros[] getLoadedVersions()
Returns the list of versions of the target file, each of which is identified by its significant macros, that had been included in this translation-unit prior to this statement.


getIncludedFileTimestamp

long getIncludedFileTimestamp()
Returns the modification time of the included file, or -1 if the file was not read.

Since:
5.4

getIncludedFileSize

long getIncludedFileSize()
Returns the size of the included file, or -1 if the file was not read.

Since:
5.4

getIncludedFileContentsHash

long getIncludedFileContentsHash()
Returns a hash-code for the contents of the file included, or 0 if the content has not been parsed.

Since:
5.4

getIncludedFileReadTime

long getIncludedFileReadTime()
Returns time when the included file was read. Corresponds to the start of reading.

Returns:
time before reading started in milliseconds since epoch
Since:
5.4

isErrorInIncludedFile

boolean isErrorInIncludedFile()
Returns true if I/O errors were encountered while reading the included file.

Since:
5.4

isIncludedFileExported

boolean isIncludedFileExported()
Returns true if the included file is exported by the including header.

Since:
5.5
See Also:
"https://code.google.com/p/include-what-you-use/wiki/IWYUPragmas"

createsAST

boolean createsAST()
Returns true, if an attempt will be or has been made to create AST for the target of this inclusion.

Since:
5.4

getImportedIndexFile

org.eclipse.cdt.core.index.IIndexFile getImportedIndexFile()
Returns the file from the index that this include statement has pulled in, or null if the include creates AST or is unresolved or skipped.

Since:
5.4

Eclipse CDT
7.0

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