eu.cqse.check.framework.preprocessor.c.new_c_preprocessor

Class MacroDefinition

java.lang.Object

eu.cqse.check.framework.preprocessor.c.new_c_preprocessor.MacroDefinition

All Implemented Interfaces:

java.io.Serializable

public class MacroDefinition
extends java.lang.Object
implements java.io.Serializable

Representation of a C preprocessor macro. Contains all information from the define directive that defines the macro including the TextRegionLocation of the define.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	hasVariadicParameter Whether the last parameter in this macro definition is a variadic parameter.
boolean	isFunctionMacro Whether this is a function macro (otherwise an object macro).
TextRegionLocation	macroDeclarationLocation Location where this macro was declared in the source code.
java.lang.String	macroName The identifier used to invoke this macro.
UnmodifiableList<java.lang.String>	parameterNames The names of the parameters of this function.
java.util.List<IToken>	replacementList The "content" of the macro.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.List<java.lang.String>	getParametersThatRequireExpansion() Returns all parameter names that need to be expanded recursively during expansion of this macro.
int	hashCode()
static boolean	isStringificationToken(IToken token) Returns whether the given token's text starts with # and is not one of the "common" preprocessor directives.
static MacroDefinition	parseMacroDefinition(java.lang.String macroDefinition, TextRegionLocation location) Parses the given macro definition and generates a MacroDefinition object from it.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

macroName

public final java.lang.String macroName

The identifier used to invoke this macro. For the macro definition #define CAT(x,y) x##y, this is "CAT".

replacementList

public final java.util.List<IToken> replacementList

The "content" of the macro. This is the string/token list that is expanded and then replaces the macro-invocation tokens.

For the macro definition #define CAT(x,y) x##y, this is "x##y".

isFunctionMacro

public final boolean isFunctionMacro

Whether this is a function macro (otherwise an object macro). Function macros accept parameters and require parentheses to be invoked.

parameterNames

public final UnmodifiableList<java.lang.String> parameterNames

The names of the parameters of this function. Empty if isFunctionMacro is false.

If the last parameter in the macro declaration is "..." (variadic parameter), its name is "__VA_ARGS__" in this list. If the last parameter in the macro declaration is "xy..." (named variadic parameter, common gcc extension), its name is "xy" in this list. In both cases we store the id with which the parameter value can be referred to in the replacement list.

hasVariadicParameter

public final boolean hasVariadicParameter

Whether the last parameter in this macro definition is a variadic parameter. False if isFunctionMacro is false.

macroDeclarationLocation

public final TextRegionLocation macroDeclarationLocation

Location where this macro was declared in the source code.

Method Detail

parseMacroDefinition

public static MacroDefinition parseMacroDefinition(java.lang.String macroDefinition,
                                                   TextRegionLocation location)

Parses the given macro definition and generates a MacroDefinition object from it. The parameter should be the definition string except for the leading "#define ".

For example parseMacroDefinition("FOO(x) x"). The parameter must not be null. This never returns null.

isStringificationToken

public static boolean isStringificationToken(IToken token)

Returns whether the given token's text starts with # and is not one of the "common" preprocessor directives. If this returns true, we assume that the token is a "stringification" token in a macro replacement list (#xy will be expanded with the value of the parameter xy).

getParametersThatRequireExpansion

public java.util.List<java.lang.String> getParametersThatRequireExpansion()

Returns all parameter names that need to be expanded recursively during expansion of this macro. If a parameter is only used in stringification, it is not contained in the result (does not need to be expanded).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object