clang  3.9.0
Public Types | Public Member Functions | Friends | List of all members
clang::MacroInfo Class Reference

Encapsulates the data about a macro definition (e.g. More...

#include <MacroInfo.h>

Public Types

typedef IdentifierInfo *const * arg_iterator
 Arguments - The list of arguments for a function-like macro. More...
 
typedef SmallVectorImpl< Token >
::const_iterator 
tokens_iterator
 

Public Member Functions

SourceLocation getDefinitionLoc () const
 Return the location that the macro was defined at. More...
 
void setDefinitionEndLoc (SourceLocation EndLoc)
 Set the location of the last token in the macro. More...
 
SourceLocation getDefinitionEndLoc () const
 Return the location of the last token in the macro. More...
 
unsigned getDefinitionLength (SourceManager &SM) const
 Get length in characters of the macro definition. More...
 
bool isIdenticalTo (const MacroInfo &Other, Preprocessor &PP, bool Syntactically) const
 Return true if the specified macro definition is equal to this macro in spelling, arguments, and whitespace. More...
 
void setIsBuiltinMacro (bool Val=true)
 Set or clear the isBuiltinMacro flag. More...
 
void setIsUsed (bool Val)
 Set the value of the IsUsed flag. More...
 
void setIsAllowRedefinitionsWithoutWarning (bool Val)
 Set the value of the IsAllowRedefinitionsWithoutWarning flag. More...
 
void setIsWarnIfUnused (bool val)
 Set the value of the IsWarnIfUnused flag. More...
 
void setArgumentList (ArrayRef< IdentifierInfo * > List, llvm::BumpPtrAllocator &PPAllocator)
 Set the specified list of identifiers as the argument list for this macro. More...
 
bool arg_empty () const
 
arg_iterator arg_begin () const
 
arg_iterator arg_end () const
 
unsigned getNumArgs () const
 
ArrayRef< const IdentifierInfo * > args () const
 
int getArgumentNum (const IdentifierInfo *Arg) const
 Return the argument number of the specified identifier, or -1 if the identifier is not a formal argument identifier. More...
 
void setIsFunctionLike ()
 Function/Object-likeness. More...
 
bool isFunctionLike () const
 
bool isObjectLike () const
 
void setIsC99Varargs ()
 Varargs querying methods. This can only be set for function-like macros. More...
 
void setIsGNUVarargs ()
 
bool isC99Varargs () const
 
bool isGNUVarargs () const
 
bool isVariadic () const
 
bool isBuiltinMacro () const
 Return true if this macro requires processing before expansion. More...
 
bool hasCommaPasting () const
 
void setHasCommaPasting ()
 
bool isUsed () const
 Return false if this macro is defined in the main file and has not yet been used. More...
 
bool isAllowRedefinitionsWithoutWarning () const
 Return true if this macro can be redefined without warning. More...
 
bool isWarnIfUnused () const
 Return true if we should emit a warning if the macro is unused. More...
 
unsigned getNumTokens () const
 Return the number of tokens that this macro expands to. More...
 
const TokengetReplacementToken (unsigned Tok) const
 
tokens_iterator tokens_begin () const
 
tokens_iterator tokens_end () const
 
bool tokens_empty () const
 
ArrayRef< Tokentokens () const
 
void AddTokenToBody (const Token &Tok)
 Add the specified token to the replacement text for the macro. More...
 
bool isEnabled () const
 Return true if this macro is enabled. More...
 
void EnableMacro ()
 
void DisableMacro ()
 
bool isFromASTFile () const
 Determine whether this macro info came from an AST file (such as a precompiled header or module) rather than having been parsed. More...
 
bool isUsedForHeaderGuard () const
 Determine whether this macro was used for a header guard. More...
 
void setUsedForHeaderGuard (bool Val)
 
unsigned getOwningModuleID () const
 Retrieve the global ID of the module that owns this particular macro info. More...
 
void dump () const
 

Friends

class Preprocessor
 

Detailed Description

Encapsulates the data about a macro definition (e.g.

its tokens).

There's an instance of this class for every #define.

Definition at line 34 of file MacroInfo.h.

Member Typedef Documentation

Arguments - The list of arguments for a function-like macro.

This can be empty, for, e.g. "#define X()".

Definition at line 175 of file MacroInfo.h.

Definition at line 238 of file MacroInfo.h.

Member Function Documentation

void clang::MacroInfo::AddTokenToBody ( const Token Tok)
inline

Add the specified token to the replacement text for the macro.

Definition at line 245 of file MacroInfo.h.

Referenced by clang::ASTReader::ReadMacroRecord().

arg_iterator clang::MacroInfo::arg_begin ( ) const
inline
bool clang::MacroInfo::arg_empty ( ) const
inline

Definition at line 176 of file MacroInfo.h.

Referenced by PrintMacroDefinition().

arg_iterator clang::MacroInfo::arg_end ( ) const
inline
ArrayRef<const IdentifierInfo *> clang::MacroInfo::args ( ) const
inline

Definition at line 180 of file MacroInfo.h.

void clang::MacroInfo::DisableMacro ( )
inline

Definition at line 262 of file MacroInfo.h.

Referenced by clang::TokenLexer::Init().

LLVM_DUMP_METHOD void MacroInfo::dump ( ) const
void clang::MacroInfo::EnableMacro ( )
inline

Definition at line 257 of file MacroInfo.h.

Referenced by clang::TokenLexer::Lex().

int clang::MacroInfo::getArgumentNum ( const IdentifierInfo Arg) const
inline

Return the argument number of the specified identifier, or -1 if the identifier is not a formal argument identifier.

Definition at line 186 of file MacroInfo.h.

References arg_begin(), arg_end(), E, and I.

Referenced by isIdenticalTo().

SourceLocation clang::MacroInfo::getDefinitionEndLoc ( ) const
inline

Return the location of the last token in the macro.

Definition at line 126 of file MacroInfo.h.

unsigned clang::MacroInfo::getDefinitionLength ( SourceManager SM) const
inline

Get length in characters of the macro definition.

Definition at line 129 of file MacroInfo.h.

Referenced by clang::TokenLexer::Init().

SourceLocation clang::MacroInfo::getDefinitionLoc ( ) const
inline

Return the location that the macro was defined at.

Definition at line 120 of file MacroInfo.h.

Referenced by clang::Preprocessor::appendDefMacroDirective(), and clang::Preprocessor::markMacroAsUsed().

unsigned clang::MacroInfo::getNumArgs ( ) const
inline
unsigned clang::MacroInfo::getNumTokens ( ) const
inline

Return the number of tokens that this macro expands to.

Definition at line 231 of file MacroInfo.h.

Referenced by clang::Preprocessor::DumpMacro(), isConfigurationPattern(), and MacroDefinitionEquals().

unsigned clang::MacroInfo::getOwningModuleID ( ) const
inline

Retrieve the global ID of the module that owns this particular macro info.

Definition at line 278 of file MacroInfo.h.

References isFromASTFile().

const Token& clang::MacroInfo::getReplacementToken ( unsigned  Tok) const
inline
bool clang::MacroInfo::hasCommaPasting ( ) const
inline

Definition at line 214 of file MacroInfo.h.

bool clang::MacroInfo::isAllowRedefinitionsWithoutWarning ( ) const
inline

Return true if this macro can be redefined without warning.

Definition at line 222 of file MacroInfo.h.

bool clang::MacroInfo::isBuiltinMacro ( ) const
inline

Return true if this macro requires processing before expansion.

This is true only for builtin macro, such as __LINE__, whose values are not given by fixed textual expansions. Regular predefined macros from the "<built-in>" buffer are not reported as builtins by this function.

Definition at line 212 of file MacroInfo.h.

Referenced by clang::Preprocessor::CheckMacroName(), DoPrintMacros(), clang::ASTWriter::getMacroID(), and clang::ASTWriter::getMacroRef().

bool clang::MacroInfo::isC99Varargs ( ) const
inline
bool clang::MacroInfo::isEnabled ( ) const
inline

Return true if this macro is enabled.

In other words, that we are not currently in an expansion of this macro.

Definition at line 255 of file MacroInfo.h.

bool clang::MacroInfo::isFromASTFile ( ) const
inline

Determine whether this macro info came from an AST file (such as a precompiled header or module) rather than having been parsed.

Definition at line 269 of file MacroInfo.h.

Referenced by getOwningModuleID().

bool clang::MacroInfo::isFunctionLike ( ) const
inline
bool clang::MacroInfo::isGNUVarargs ( ) const
inline

Definition at line 203 of file MacroInfo.h.

Referenced by isIdenticalTo(), and PrintMacroDefinition().

bool MacroInfo::isIdenticalTo ( const MacroInfo Other,
Preprocessor PP,
bool  Syntactically 
) const

Return true if the specified macro definition is equal to this macro in spelling, arguments, and whitespace.

Parameters
Syntacticallyif true, the macro definitions can be identical even if they use different identifiers for the function macro parameters. Otherwise the comparison is lexical and this implements the rules in C99 6.10.3.

Definition at line 72 of file MacroInfo.cpp.

References arg_begin(), arg_end(), E, getArgumentNum(), clang::Token::getIdentifierInfo(), clang::Token::getKind(), getNumArgs(), clang::Preprocessor::getSpelling(), clang::Token::hasLeadingSpace(), I, clang::Token::isAtStartOfLine(), isC99Varargs(), isFunctionLike(), and isGNUVarargs().

bool clang::MacroInfo::isObjectLike ( ) const
inline
bool clang::MacroInfo::isUsed ( ) const
inline

Return false if this macro is defined in the main file and has not yet been used.

Definition at line 219 of file MacroInfo.h.

Referenced by clang::Preprocessor::markMacroAsUsed().

bool clang::MacroInfo::isUsedForHeaderGuard ( ) const
inline

Determine whether this macro was used for a header guard.

Definition at line 272 of file MacroInfo.h.

bool clang::MacroInfo::isVariadic ( ) const
inline
bool clang::MacroInfo::isWarnIfUnused ( ) const
inline

Return true if we should emit a warning if the macro is unused.

Definition at line 227 of file MacroInfo.h.

Referenced by clang::Preprocessor::markMacroAsUsed().

void clang::MacroInfo::setArgumentList ( ArrayRef< IdentifierInfo * >  List,
llvm::BumpPtrAllocator &  PPAllocator 
)
inline

Set the specified list of identifiers as the argument list for this macro.

Definition at line 161 of file MacroInfo.h.

Referenced by clang::ASTReader::ReadMacroRecord().

void clang::MacroInfo::setDefinitionEndLoc ( SourceLocation  EndLoc)
inline

Set the location of the last token in the macro.

Definition at line 123 of file MacroInfo.h.

Referenced by clang::ASTReader::ReadMacroRecord().

void clang::MacroInfo::setHasCommaPasting ( )
inline

Definition at line 215 of file MacroInfo.h.

Referenced by clang::ASTReader::ReadMacroRecord().

void clang::MacroInfo::setIsAllowRedefinitionsWithoutWarning ( bool  Val)
inline

Set the value of the IsAllowRedefinitionsWithoutWarning flag.

Definition at line 152 of file MacroInfo.h.

Referenced by clang::Preprocessor::HandlePragmaPushMacro().

void clang::MacroInfo::setIsBuiltinMacro ( bool  Val = true)
inline

Set or clear the isBuiltinMacro flag.

Definition at line 146 of file MacroInfo.h.

Referenced by RegisterBuiltinMacro().

void clang::MacroInfo::setIsC99Varargs ( )
inline

Varargs querying methods. This can only be set for function-like macros.

Definition at line 200 of file MacroInfo.h.

Referenced by clang::ASTReader::ReadMacroRecord().

void clang::MacroInfo::setIsFunctionLike ( )
inline

Function/Object-likeness.

Keep track of whether this macro has formal parameters.

Definition at line 195 of file MacroInfo.h.

Referenced by clang::ASTReader::ReadMacroRecord().

void clang::MacroInfo::setIsGNUVarargs ( )
inline

Definition at line 201 of file MacroInfo.h.

Referenced by clang::ASTReader::ReadMacroRecord().

void clang::MacroInfo::setIsUsed ( bool  Val)
inline

Set the value of the IsUsed flag.

Definition at line 149 of file MacroInfo.h.

Referenced by clang::Preprocessor::markMacroAsUsed(), and clang::ASTReader::ReadMacroRecord().

void clang::MacroInfo::setIsWarnIfUnused ( bool  val)
inline

Set the value of the IsWarnIfUnused flag.

Definition at line 157 of file MacroInfo.h.

void clang::MacroInfo::setUsedForHeaderGuard ( bool  Val)
inline

Definition at line 274 of file MacroInfo.h.

Referenced by clang::ASTReader::ReadMacroRecord().

ArrayRef<Token> clang::MacroInfo::tokens ( ) const
inline

Definition at line 242 of file MacroInfo.h.

Referenced by PrintMacroDefinition().

tokens_iterator clang::MacroInfo::tokens_begin ( ) const
inline
bool clang::MacroInfo::tokens_empty ( ) const
inline

Definition at line 241 of file MacroInfo.h.

Referenced by PrintMacroDefinition().

tokens_iterator clang::MacroInfo::tokens_end ( ) const
inline

Definition at line 240 of file MacroInfo.h.

Referenced by clang::TokenLexer::Init().

Friends And Related Function Documentation

friend class Preprocessor
friend

Definition at line 295 of file MacroInfo.h.


The documentation for this class was generated from the following files: