Implements # directive processing for the Preprocessor. More...

#include "clang/Basic/AttributeCommonInfo.h"
#include "clang/Basic/Attributes.h"
#include "clang/Basic/CharInfo.h"
#include "clang/Basic/DirectoryEntry.h"
#include "clang/Basic/FileManager.h"
#include "clang/Basic/IdentifierTable.h"
#include "clang/Basic/LangOptions.h"
#include "clang/Basic/Module.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Basic/TargetInfo.h"
#include "clang/Basic/TokenKinds.h"
#include "clang/Lex/CodeCompletionHandler.h"
#include "clang/Lex/HeaderSearch.h"
#include "clang/Lex/LexDiagnostic.h"
#include "clang/Lex/LiteralSupport.h"
#include "clang/Lex/MacroInfo.h"
#include "clang/Lex/ModuleLoader.h"
#include "clang/Lex/ModuleMap.h"
#include "clang/Lex/PPCallbacks.h"
#include "clang/Lex/Pragma.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Lex/PreprocessorOptions.h"
#include "clang/Lex/Token.h"
#include "clang/Lex/VariadicMacroSupport.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/ScopeExit.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/StringSwitch.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/SaveAndRestore.h"
#include <algorithm>
#include <cassert>
#include <cstring>
#include <optional>
#include <string>
#include <utility>

Classes
class	clang::Preprocessor::ResetMacroExpansionHelper

Enumerations
enum	MacroDiag { MD_NoWarn , MD_KeywordDef , MD_ReservedMacro , MD_ReservedAttributeIdentifier }
	Enumerates possible cases of #define/#undef a reserved identifier. More...
enum	PPElifDiag { PED_Elif , PED_Elifdef , PED_Elifndef }
	Enumerates possible select values for the pp_err_elif_after_else and pp_err_elif_without_if diagnostics. More...

Functions
static bool	isFeatureTestMacro (StringRef MacroName)
static bool	isLanguageDefinedBuiltin (const SourceManager &SourceMgr, const MacroInfo *MI, const StringRef MacroName)
static bool	isReservedCXXAttributeName (Preprocessor &PP, IdentifierInfo *II)
static MacroDiag	shouldWarnOnMacroDef (Preprocessor &PP, IdentifierInfo *II)
static MacroDiag	shouldWarnOnMacroUndef (Preprocessor &PP, IdentifierInfo *II)
static bool	warnByDefaultOnWrongCase (StringRef Include)
static std::optional< StringRef >	findSimilarStr (StringRef LHS, const std::vector< StringRef > &Candidates)
	Find a similar string in Candidates.
static bool	GetLineValue (Token &DigitTok, unsigned &Val, unsigned DiagID, Preprocessor &PP, bool IsGNULineDirective=false)
	GetLineValue - Convert a numeric token into an unsigned value, emitting Diagnostic DiagID if it is invalid, and returning the value in Val.
static bool	ReadLineMarkerFlags (bool &IsFileEntry, bool &IsFileExit, SrcMgr::CharacteristicKind &FileKind, Preprocessor &PP)
	ReadLineMarkerFlags - Parse and validate any flags at the end of a GNU line marker directive.
static void	diagnoseAutoModuleImport (Preprocessor &PP, SourceLocation HashLoc, Token &IncludeTok, ArrayRef< IdentifierLoc > Path, SourceLocation PathEnd)
	Produce a diagnostic informing the user that a #include or similar was implicitly treated as a module import.
static bool	trySimplifyPath (SmallVectorImpl< StringRef > &Components, StringRef RealPathName, llvm::sys::path::Style Separator)
static bool	isConfigurationPattern (Token &MacroName, MacroInfo *MI, const LangOptions &LOptions)
static bool	isObjCProtectedMacro (const IdentifierInfo *II)

Detailed Description

Implements # directive processing for the Preprocessor.

Definition in file PPDirectives.cpp.

Enumeration Type Documentation

◆ MacroDiag

enum MacroDiag

Enumerates possible cases of #define/#undef a reserved identifier.

Enumerator
MD_NoWarn
MD_KeywordDef
MD_ReservedMacro
MD_ReservedAttributeIdentifier

Definition at line 99 of file PPDirectives.cpp.

◆ PPElifDiag

enum PPElifDiag

Enumerates possible select values for the pp_err_elif_after_else and pp_err_elif_without_if diagnostics.

Enumerator
PED_Elif
PED_Elifdef
PED_Elifndef

Definition at line 108 of file PPDirectives.cpp.

Function Documentation

◆ diagnoseAutoModuleImport()

void diagnoseAutoModuleImport	(	Preprocessor &	PP,
		SourceLocation	HashLoc,
		Token &	IncludeTok,
		ArrayRef< IdentifierLoc >	Path,
		SourceLocation	PathEnd )

static

Produce a diagnostic informing the user that a #include or similar was implicitly treated as a module import.

Definition at line 1922 of file PPDirectives.cpp.

References clang::Preprocessor::Diag(), clang::Token::getIdentifierInfo(), and clang::IdentifierInfo::getPPKeywordID().

◆ findSimilarStr()

std::optional< StringRef > findSimilarStr	(	StringRef	LHS,
		const std::vector< StringRef > &	Candidates )

static

Find a similar string in Candidates.

Parameters

LHS	a string for a similar string in Candidates
Candidates	the candidates to find a similar string.

Returns: a similar string if exists. If no similar string exists, returns std::nullopt.

Definition at line 306 of file PPDirectives.cpp.

References clang::C.

◆ GetLineValue()

bool GetLineValue	(	Token &	DigitTok,
		unsigned &	Val,
		unsigned	DiagID,
		Preprocessor &	PP,
		bool	IsGNULineDirective = false )

static

GetLineValue - Convert a numeric token into an unsigned value, emitting Diagnostic DiagID if it is invalid, and returning the value in Val.

Definition at line 1442 of file PPDirectives.cpp.

References clang::Preprocessor::AdvanceToTokenCharacter(), clang::Preprocessor::Diag(), clang::Preprocessor::DiscardUntilEndOfDirective(), clang::Token::getLength(), clang::Token::getLocation(), clang::Preprocessor::getSpelling(), clang::Invalid, clang::isDigit(), and clang::Token::isNot().

Referenced by ReadLineMarkerFlags().

◆ isConfigurationPattern()

bool isConfigurationPattern	(	Token &	MacroName,
		MacroInfo *	MI,
		const LangOptions &	LOptions )

static

Definition at line 2891 of file PPDirectives.cpp.

References clang::Token::getIdentifierInfo(), clang::Token::getKind(), clang::Value::getKind(), clang::IdentifierInfo::getName(), clang::MacroInfo::getNumTokens(), clang::MacroInfo::getReplacementToken(), clang::IdentifierInfo::isKeyword(), and clang::Token::isOneOf().

◆ isFeatureTestMacro()

bool isFeatureTestMacro ( StringRef MacroName )

static

Definition at line 114 of file PPDirectives.cpp.

Referenced by shouldWarnOnMacroDef().

◆ isLanguageDefinedBuiltin()

bool isLanguageDefinedBuiltin	(	const SourceManager &	SourceMgr,
		const MacroInfo *	MI,
		const StringRef	MacroName )

static

Definition at line 154 of file PPDirectives.cpp.

References clang::MacroInfo::getDefinitionLoc(), and clang::MacroInfo::isBuiltinMacro().

◆ isObjCProtectedMacro()

bool isObjCProtectedMacro ( const IdentifierInfo * II )

static

Definition at line 3172 of file PPDirectives.cpp.

References clang::IdentifierInfo::isStr().

◆ isReservedCXXAttributeName()

bool isReservedCXXAttributeName	(	Preprocessor &	PP,
		IdentifierInfo *	II )

static

Definition at line 178 of file PPDirectives.cpp.

References clang::AttributeCommonInfo::AS_CXX11, clang::AttributeCommonInfo::getCXX11AttrArgsInfo(), clang::Preprocessor::getLangOpts(), clang::Preprocessor::getTargetInfo(), clang::hasAttribute(), clang::Preprocessor::isNextPPTokenOneOf(), clang::AttributeCommonInfo::Optional, and clang::AttributeCommonInfo::Required.

Referenced by shouldWarnOnMacroDef(), and shouldWarnOnMacroUndef().

◆ ReadLineMarkerFlags()

bool ReadLineMarkerFlags	(	bool &	IsFileEntry,
		bool &	IsFileExit,
		SrcMgr::CharacteristicKind &	FileKind,
		Preprocessor &	PP )

static

ReadLineMarkerFlags - Parse and validate any flags at the end of a GNU line marker directive.

Definition at line 1579 of file PPDirectives.cpp.

References clang::SrcMgr::C_ExternCSystem, clang::SrcMgr::C_System, clang::Preprocessor::Diag(), clang::Preprocessor::DiscardUntilEndOfDirective(), clang::PresumedLoc::getIncludeLoc(), GetLineValue(), clang::Token::getLocation(), clang::Preprocessor::getSourceManager(), clang::Token::is(), clang::PresumedLoc::isInvalid(), clang::SourceLocation::isInvalid(), clang::Preprocessor::Lex(), and SM.

◆ shouldWarnOnMacroDef()

MacroDiag shouldWarnOnMacroDef	(	Preprocessor &	PP,
		IdentifierInfo *	II )

static

Definition at line 194 of file PPDirectives.cpp.

References clang::Preprocessor::getLangOpts(), clang::IdentifierInfo::getName(), isFeatureTestMacro(), clang::IdentifierInfo::isKeyword(), clang::IdentifierInfo::isReserved(), isReservedCXXAttributeName(), clang::isReservedInAllContexts(), MD_KeywordDef, MD_NoWarn, MD_ReservedAttributeIdentifier, MD_ReservedMacro, and clang::Text.

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

◆ shouldWarnOnMacroUndef()

MacroDiag shouldWarnOnMacroUndef	(	Preprocessor &	PP,
		IdentifierInfo *	II )

static

Definition at line 208 of file PPDirectives.cpp.

References clang::Preprocessor::getLangOpts(), clang::IdentifierInfo::isReserved(), isReservedCXXAttributeName(), clang::isReservedInAllContexts(), MD_NoWarn, MD_ReservedAttributeIdentifier, and MD_ReservedMacro.

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

◆ trySimplifyPath()

bool trySimplifyPath	(	SmallVectorImpl< StringRef > &	Components,
		StringRef	RealPathName,
		llvm::sys::path::Style	Separator )

static

Definition at line 1962 of file PPDirectives.cpp.

◆ warnByDefaultOnWrongCase()

bool warnByDefaultOnWrongCase ( StringRef Include )

static

Definition at line 223 of file PPDirectives.cpp.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ MacroDiag

◆ PPElifDiag

Function Documentation

◆ diagnoseAutoModuleImport()

◆ findSimilarStr()

◆ GetLineValue()

◆ isConfigurationPattern()

◆ isFeatureTestMacro()

◆ isLanguageDefinedBuiltin()

◆ isObjCProtectedMacro()

◆ isReservedCXXAttributeName()

◆ ReadLineMarkerFlags()

◆ shouldWarnOnMacroDef()

◆ shouldWarnOnMacroUndef()

◆ trySimplifyPath()

◆ warnByDefaultOnWrongCase()