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:

[legend]

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 314 of file MacroInfo.h.

Member Enumeration Documentation

◆ Kind

enum clang::MacroDirective::Kind

Enumerator
MD_Define
MD_Undefine
MD_Visibility

Definition at line 316 of file MacroInfo.h.

Constructor & Destructor Documentation

◆ MacroDirective()

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

inlineprotected

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 429 of file MacroInfo.h.

References MacroDirective().

◆ dump()

LLVM_DUMP_METHOD void MacroDirective::dump ( ) const

Definition at line 228 of file MacroInfo.cpp.

References getKind(), getPrevious(), clang::isa(), 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 215 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 193 of file MacroInfo.cpp.

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

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