clang::MacroDirective Class Reference

Encapsulates changes to the "macros namespace" (the location where the macro name became active, the location where it was undefined, etc.). More...

#include "clang/Lex/MacroInfo.h"

Inheritance diagram for clang::MacroDirective:

Classes
class	DefInfo

Public Types
enum	Kind { MD_Define , MD_Undefine , MD_Visibility }

Public Member Functions
Kind	getKind () const
SourceLocation	getLocation () const
void	setPrevious (MacroDirective *Prev)
	Set previous definition of the macro with the same name.
const MacroDirective *	getPrevious () const
	Get previous definition of the macro with the same name.
MacroDirective *	getPrevious ()
	Get previous definition of the macro with the same name.
bool	isFromPCH () const
	Return true if the macro directive was loaded from a PCH file.
void	setIsFromPCH ()
DefInfo	getDefinition ()
	Traverses the macro directives history and returns the next macro definition directive along with info about its undefined location (if there is one) and if it is public or private.
const DefInfo	getDefinition () const
bool	isDefined () const
const MacroInfo *	getMacroInfo () const
MacroInfo *	getMacroInfo ()
const DefInfo	findDirectiveAtLoc (SourceLocation L, const SourceManager &SM) const
	Find macro definition active in the specified source location.
void	dump () const

Static Public Member Functions
static bool	classof (const MacroDirective *)

Protected Member Functions
	MacroDirective (Kind K, SourceLocation Loc)

Protected Attributes
MacroDirective *	Previous = nullptr
	Previous macro directive for the same identifier, or nullptr.
SourceLocation	Loc
unsigned	MDKind: 2
	MacroDirective kind.
unsigned	IsFromPCH: 1
	True if the macro directive was loaded from a PCH file.
unsigned	IsPublic: 1
	Whether the macro has public visibility (when described in a module).

Detailed Description

Encapsulates changes to the "macros namespace" (the location where the macro name became active, the location where it was undefined, etc.).

MacroDirectives, associated with an identifier, are used to model the macro history. Usually a macro definition (MacroInfo) is where a macro name becomes active (MacroDirective) but #pragma push_macro / pop_macro can create additional DefMacroDirectives for the same MacroInfo.

Definition at line 313 of file MacroInfo.h.

Member Enumeration Documentation

Kind

enum clang::MacroDirective::Kind

Enumerator
MD_Define
MD_Undefine
MD_Visibility

Definition at line 315 of file MacroInfo.h.

Constructor & Destructor Documentation

MacroDirective()

clang::MacroDirective::MacroDirective ( Kind  K, SourceLocation  Loc  )

inlineprotected

Definition at line 342 of file MacroInfo.h.

Member Function Documentation

classof()

static bool clang::MacroDirective::classof ( const MacroDirective *  )

inlinestatic

Definition at line 428 of file MacroInfo.h.

dump()

LLVM_DUMP_METHOD void MacroDirective::dump

(

)

const

Definition at line 233 of file MacroInfo.cpp.

References getKind(), getPrevious(), IsFromPCH, IsPublic, MD_Define, MD_Undefine, and MD_Visibility.

findDirectiveAtLoc()

const MacroDirective::DefInfo MacroDirective::findDirectiveAtLoc	(	SourceLocation	L,
		const SourceManager &	SM
	)		const

Find macro definition active in the specified source location.

If this macro was not defined there, return NULL.

Definition at line 220 of file MacroInfo.cpp.

References getDefinition(), clang::MacroDirective::DefInfo::getPreviousDefinition(), clang::SourceLocation::isValid(), and SM.

getDefinition() [1/2]

MacroDirective::DefInfo MacroDirective::getDefinition

(

)

Traverses the macro directives history and returns the next macro definition directive along with info about its undefined location (if there is one) and if it is public or private.

Definition at line 198 of file MacroInfo.cpp.

References getPrevious(), and clang::VisibilityMacroDirective::isPublic().

Referenced by findDirectiveAtLoc(), getDefinition(), getMacroInfo(), and isDefined().

getDefinition() [2/2]

const DefInfo clang::MacroDirective::getDefinition ( ) const

inline

Definition at line 406 of file MacroInfo.h.

References getDefinition().

getKind()

Kind clang::MacroDirective::getKind ( ) const

inline

Definition at line 346 of file MacroInfo.h.

References MDKind.

Referenced by clang::DefMacroDirective::classof(), clang::UndefMacroDirective::classof(), clang::VisibilityMacroDirective::classof(), and dump().

getLocation()

SourceLocation clang::MacroDirective::getLocation ( ) const

inline

Definition at line 348 of file MacroInfo.h.

References Loc.

Referenced by clang::MacroDirective::DefInfo::getLocation(), and shouldIgnoreMacro().

getMacroInfo() [1/2]

MacroInfo * clang::MacroDirective::getMacroInfo ( )

inline

Definition at line 419 of file MacroInfo.h.

References getDefinition(), and clang::MacroDirective::DefInfo::getMacroInfo().

getMacroInfo() [2/2]

const MacroInfo * clang::MacroDirective::getMacroInfo ( ) const

inline

Definition at line 416 of file MacroInfo.h.

References getDefinition(), and clang::MacroDirective::DefInfo::getMacroInfo().

Referenced by clang::extractapi::DeclarationFragmentsBuilder::getFragmentsForMacro(), clang::MacroPPCallbacks::MacroDefined(), and shouldIgnoreMacro().

getPrevious() [1/2]

MacroDirective * clang::MacroDirective::getPrevious ( )

inline

Get previous definition of the macro with the same name.

Definition at line 357 of file MacroInfo.h.

References Previous.

getPrevious() [2/2]

const MacroDirective * clang::MacroDirective::getPrevious ( ) const

inline

Get previous definition of the macro with the same name.

Definition at line 354 of file MacroInfo.h.

References Previous.

Referenced by clang::Preprocessor::appendMacroDirective(), dump(), getDefinition(), and clang::Preprocessor::LeaveSubmodule().

isDefined()

bool clang::MacroDirective::isDefined ( ) const

inline

Definition at line 410 of file MacroInfo.h.

References getDefinition().

Referenced by clang::Preprocessor::appendMacroDirective(), and clang::Preprocessor::setLoadedMacroDirective().

isFromPCH()

bool clang::MacroDirective::isFromPCH ( ) const

inline

Return true if the macro directive was loaded from a PCH file.

Definition at line 360 of file MacroInfo.h.

References IsFromPCH.

setIsFromPCH()

void clang::MacroDirective::setIsFromPCH ( )

inline

Definition at line 362 of file MacroInfo.h.

References IsFromPCH.

setPrevious()

void clang::MacroDirective::setPrevious ( MacroDirective *  Prev )

inline

Set previous definition of the macro with the same name.

Definition at line 351 of file MacroInfo.h.

References Previous.

Referenced by clang::Preprocessor::appendMacroDirective(), clang::ASTReader::resolvePendingMacro(), and clang::Preprocessor::setLoadedMacroDirective().

Member Data Documentation

IsFromPCH

unsigned clang::MacroDirective::IsFromPCH

protected

True if the macro directive was loaded from a PCH file.

Definition at line 333 of file MacroInfo.h.

Referenced by dump(), isFromPCH(), and setIsFromPCH().

IsPublic

unsigned clang::MacroDirective::IsPublic

protected

Whether the macro has public visibility (when described in a module).

Definition at line 340 of file MacroInfo.h.

Referenced by dump(), clang::VisibilityMacroDirective::isPublic(), and clang::VisibilityMacroDirective::VisibilityMacroDirective().

Loc

SourceLocation clang::MacroDirective::Loc

protected

Definition at line 325 of file MacroInfo.h.

Referenced by getLocation().

MDKind

unsigned clang::MacroDirective::MDKind

protected

MacroDirective kind.

Definition at line 329 of file MacroInfo.h.

Referenced by getKind().

Previous

MacroDirective* clang::MacroDirective::Previous = nullptr

protected

Previous macro directive for the same identifier, or nullptr.

Definition at line 323 of file MacroInfo.h.

Referenced by getPrevious(), and setPrevious().

---

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

• include/clang/Lex/MacroInfo.h
• lib/Lex/MacroInfo.cpp