clang API Documentation

Public Member Functions | Static Public Member Functions
clang::SrcMgr::ExpansionInfo Class Reference

#include <SourceManager.h>

List of all members.

Public Member Functions

SourceLocation getSpellingLoc () const
SourceLocation getExpansionLocStart () const
SourceLocation getExpansionLocEnd () const
std::pair< SourceLocation,
SourceLocation
getExpansionLocRange () const
bool isMacroArgExpansion () const
bool isFunctionMacroExpansion () const

Static Public Member Functions

static ExpansionInfo create (SourceLocation SpellingLoc, SourceLocation Start, SourceLocation End)
static ExpansionInfo createForMacroArg (SourceLocation SpellingLoc, SourceLocation ExpansionLoc)

Detailed Description

ExpansionInfo - Each ExpansionInfo encodes the expansion location - where the token was ultimately expanded, and the SpellingLoc - where the actual character data for the token came from.

Definition at line 268 of file SourceManager.h.


Member Function Documentation

static ExpansionInfo clang::SrcMgr::ExpansionInfo::create ( SourceLocation  SpellingLoc,
SourceLocation  Start,
SourceLocation  End 
) [inline, static]

create - Return a ExpansionInfo for an expansion. Start and End specify the expansion range (where the macro is expanded), and SpellingLoc specifies the spelling location (where the characters from the token come from). All three can refer to normal File SLocs or expansion locations.

Definition at line 315 of file SourceManager.h.

References clang::SourceLocation::getRawEncoding().

Referenced by createForMacroArg().

static ExpansionInfo clang::SrcMgr::ExpansionInfo::createForMacroArg ( SourceLocation  SpellingLoc,
SourceLocation  ExpansionLoc 
) [inline, static]

createForMacroArg - Return a special ExpansionInfo for the expansion of a macro argument into a function-like macro's body. ExpansionLoc specifies the expansion location (where the macro is expanded). This doesn't need to be a range because a macro is always expanded at a macro parameter reference, and macro parameters are always exactly one token. SpellingLoc specifies the spelling location (where the characters from the token come from). ExpansionLoc and SpellingLoc can both refer to normal File SLocs or expansion locations.

Given the code:

   #define F(x) f(x)
   F(42);

When expanding 'F(42)', the 'x' would call this with an SpellingLoc pointing at '42' anad an ExpansionLoc pointing at its location in the definition of 'F'.

Definition at line 342 of file SourceManager.h.

References create().

SourceLocation clang::SrcMgr::ExpansionInfo::getExpansionLocEnd ( ) const [inline]
std::pair<SourceLocation,SourceLocation> clang::SrcMgr::ExpansionInfo::getExpansionLocRange ( ) const [inline]
SourceLocation clang::SrcMgr::ExpansionInfo::getExpansionLocStart ( ) const [inline]
SourceLocation clang::SrcMgr::ExpansionInfo::getSpellingLoc ( ) const [inline]
bool clang::SrcMgr::ExpansionInfo::isFunctionMacroExpansion ( ) const [inline]
bool clang::SrcMgr::ExpansionInfo::isMacroArgExpansion ( ) const [inline]

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