#include <HeaderSearch.h>

Collaboration diagram for clang::HeaderFileInfo:

Public Member Functions
	HeaderFileInfo ()
const IdentifierInfo *	getControllingMacro (ExternalIdentifierLookup *External)
	Retrieve the controlling macro for this header file, if any.
bool	isNonDefault () const
	Determine whether this is a non-default header file info, e.g., it corresponds to an actual header we've included or tried to include.
Public Attributes
unsigned	isImport: 1
	isImport - True if this is a #import'd or #pragma once file.
unsigned	isPragmaOnce: 1
	isPragmaOnce - True if this is #pragma once file.
unsigned	DirInfo: 2
unsigned	External: 1
	Whether this header file info was supplied by an external source.
unsigned	Resolved: 1
	Whether this structure is considered to already have been "resolved", meaning that it was loaded from the external source.
unsigned	IndexHeaderMapHeader: 1
	Whether this is a header inside a framework that is currently being built.
unsigned short	NumIncludes
unsigned	ControllingMacroID
	The ID number of the controlling macro.
const IdentifierInfo *	ControllingMacro
StringRef	Framework
	If this header came from a framework include, this is the name of the framework.

Detailed Description

HeaderFileInfo - The preprocessor keeps track of this information for each file that is #included.

Definition at line 35 of file HeaderSearch.h.

Constructor & Destructor Documentation

clang::HeaderFileInfo::HeaderFileInfo ( ) [inline]

Definition at line 89 of file HeaderSearch.h.

Member Function Documentation

const IdentifierInfo * HeaderFileInfo::getControllingMacro ( ExternalIdentifierLookup * External )

Retrieve the controlling macro for this header file, if any.

Definition at line 28 of file HeaderSearch.cpp.

References ControllingMacro, ControllingMacroID, and clang::ExternalIdentifierLookup::GetIdentifier().

Referenced by clang::HeaderSearch::ShouldEnterIncludeFile().

bool clang::HeaderFileInfo::isNonDefault ( ) const [inline]

Determine whether this is a non-default header file info, e.g., it corresponds to an actual header we've included or tried to include.

Definition at line 100 of file HeaderSearch.h.

References ControllingMacro, ControllingMacroID, isImport, isPragmaOnce, and NumIncludes.

Member Data Documentation

const IdentifierInfo* clang::HeaderFileInfo::ControllingMacro

ControllingMacro - If this file has a #ifndef XXX (or equivalent) guard that protects the entire contents of the file, this is the identifier for the macro that controls whether or not it has any effect.

Note: Most clients should use getControllingMacro() to access the controlling macro of this header, since getControllingMacro() is able to load a controlling macro from external storage.

Definition at line 83 of file HeaderSearch.h.

Referenced by getControllingMacro(), clang::HeaderSearch::isFileMultipleIncludeGuarded(), isNonDefault(), mergeHeaderFileInfo(), and clang::HeaderSearch::SetFileControllingMacro().

unsigned clang::HeaderFileInfo::ControllingMacroID

The ID number of the controlling macro.

This ID number will be non-zero when there is a controlling macro whose IdentifierInfo may not yet have been loaded from external storage.

Definition at line 73 of file HeaderSearch.h.

Referenced by getControllingMacro(), clang::HeaderSearch::isFileMultipleIncludeGuarded(), isNonDefault(), and mergeHeaderFileInfo().

unsigned clang::HeaderFileInfo::DirInfo

DirInfo - Keep track of whether this is a system header, and if so, whether it is C++ clean or not. This can be set by the include paths or by #pragma gcc system_header. This is an instance of SrcMgr::CharacteristicKind.

Definition at line 46 of file HeaderSearch.h.

Referenced by clang::HeaderSearch::getFileDirFlavor(), clang::HeaderSearch::LookupFile(), clang::HeaderSearch::LookupSubframeworkHeader(), clang::HeaderSearch::MarkFileSystemHeader(), and mergeHeaderFileInfo().

unsigned clang::HeaderFileInfo::External

Whether this header file info was supplied by an external source.

Definition at line 49 of file HeaderSearch.h.

Referenced by mergeHeaderFileInfo().

StringRef clang::HeaderFileInfo::Framework

If this header came from a framework include, this is the name of the framework.

Definition at line 87 of file HeaderSearch.h.

Referenced by clang::HeaderSearch::LookupFile(), and mergeHeaderFileInfo().

unsigned clang::HeaderFileInfo::IndexHeaderMapHeader

Whether this is a header inside a framework that is currently being built.

When a framework is being built, the headers have not yet been placed into the appropriate framework subdirectories, and therefore are provided via a header map. This bit indicates when this is one of those framework headers.

Definition at line 62 of file HeaderSearch.h.

Referenced by clang::HeaderSearch::LookupFile(), and mergeHeaderFileInfo().

unsigned clang::HeaderFileInfo::isImport

isImport - True if this is a #import'd or #pragma once file.

Definition at line 37 of file HeaderSearch.h.

Referenced by isNonDefault(), clang::HeaderSearch::MarkFileIncludeOnce(), mergeHeaderFileInfo(), clang::serialization::reader::HeaderFileInfoTrait::ReadData(), and clang::HeaderSearch::ShouldEnterIncludeFile().

unsigned clang::HeaderFileInfo::isPragmaOnce

isPragmaOnce - True if this is #pragma once file.

Definition at line 40 of file HeaderSearch.h.

Referenced by clang::HeaderSearch::isFileMultipleIncludeGuarded(), isNonDefault(), clang::HeaderSearch::MarkFileIncludeOnce(), and mergeHeaderFileInfo().

unsigned short clang::HeaderFileInfo::NumIncludes

NumIncludes - This is the number of times the file has been included already.