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

All Superinterfaces:

IASTNameOwner, IASTNode, IASTPreprocessorStatement

All Known Subinterfaces:

IASTPreprocessorFunctionStyleMacroDefinition, IASTPreprocessorObjectStyleMacroDefinition

public interface IASTPreprocessorMacroDefinition
extends IASTPreprocessorStatement, IASTNameOwner

This represents the definition of a macro.

Field Summary

static ASTNodeProperty

MACRO_NAME MACRO_NAME describes the relationship between a macro definition and it's name.

Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode

EMPTY_NODE_ARRAY

Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTNameOwner

r_declaration, r_definition, r_reference, r_unclear

Method Summary

String	getExpansion() Returns the macro expansion, or an empty string for dynamic style macros.
IASTFileLocation	getExpansionLocation() Returns the location of the macro expansion, or null if not supported.
IASTName	getName() Get the macro name.
void	setExpansion(String exp) Set the macro expansion.
void	setName(IASTName name) Set the macro name.

Methods inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode

accept, contains, getContainingFilename, getFileLocation, getNodeLocations, getParent, getPropertyInParent, getRawSignature, getTranslationUnit, isPartOfTranslationUnitFile, setParent, setPropertyInParent

Methods inherited from interface org.eclipse.cdt.core.dom.ast.IASTNameOwner

getRoleForName

Field Detail

MACRO_NAME

static final ASTNodeProperty MACRO_NAME

MACRO_NAME describes the relationship between a macro definition and it's name.

Method Detail

getName

IASTName getName()

Get the macro name.

Returns:

IASTName

setName

void setName(IASTName name)

Set the macro name.

Parameters:

name -

getExpansion

String getExpansion()

Returns the macro expansion, or an empty string for dynamic style macros.

getExpansionLocation

IASTFileLocation getExpansionLocation()

Returns the location of the macro expansion, or null if not supported. For built-in macros the location will always be null.

Since:

5.0

setExpansion

void setExpansion(String exp)

Set the macro expansion.

Parameters:

exp - String