15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- MacroInfo.cpp - Information about #defined identifiers -----------===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file implements the MacroInfo interface. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Lex/MacroInfo.h" 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Lex/Preprocessor.h" 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerusing namespace clang; 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 188a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander KornienkoMacroInfo::MacroInfo(SourceLocation DefLoc) 198a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko : Location(DefLoc), 206bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines ArgumentList(nullptr), 218a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko NumArguments(0), 228a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko IsDefinitionLengthCached(false), 238a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko IsFunctionLike(false), 248a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko IsC99Varargs(false), 258a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko IsGNUVarargs(false), 268a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko IsBuiltinMacro(false), 274fa4b480270c14dfdcd0dfd4f76938e973082e3bEli Friedman HasCommaPasting(false), 288a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko IsDisabled(false), 298a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko IsUsed(false), 308a64bb58c3b24d7d97895e435bbc0965c99bd3beAlexander Kornienko IsAllowRedefinitionsWithoutWarning(false), 31baa74bd3968028d8e5b10ee9b50d0dceb41e85a9Argyrios Kyrtzidis IsWarnIfUnused(false), 326bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines FromASTFile(false), 336bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines UsedForHeaderGuard(false) { 3466da0abf7ab7cd449bb1d5134b2ef97d9d34d812Alexander Kornienko} 3566da0abf7ab7cd449bb1d5134b2ef97d9d34d812Alexander Kornienko 36b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidisunsigned MacroInfo::getDefinitionLengthSlow(SourceManager &SM) const { 37b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis assert(!IsDefinitionLengthCached); 38b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis IsDefinitionLengthCached = true; 39b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 40b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis if (ReplacementTokens.empty()) 41b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis return (DefinitionLength = 0); 42b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 43b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis const Token &firstToken = ReplacementTokens.front(); 44b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis const Token &lastToken = ReplacementTokens.back(); 45b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis SourceLocation macroStart = firstToken.getLocation(); 46b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis SourceLocation macroEnd = lastToken.getLocation(); 47b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis assert(macroStart.isValid() && macroEnd.isValid()); 48b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis assert((macroStart.isFileID() || firstToken.is(tok::comment)) && 49b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis "Macro defined in macro?"); 50b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis assert((macroEnd.isFileID() || lastToken.is(tok::comment)) && 51b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis "Macro defined in macro?"); 52b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis std::pair<FileID, unsigned> 53e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth startInfo = SM.getDecomposedExpansionLoc(macroStart); 54b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis std::pair<FileID, unsigned> 55e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth endInfo = SM.getDecomposedExpansionLoc(macroEnd); 56b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis assert(startInfo.first == endInfo.first && 57b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis "Macro definition spanning multiple FileIDs ?"); 58b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis assert(startInfo.second <= endInfo.second); 59b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis DefinitionLength = endInfo.second - startInfo.second; 60b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis DefinitionLength += lastToken.getLength(); 61b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 62b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis return DefinitionLength; 63b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis} 64b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 65bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis/// \brief Return true if the specified macro definition is equal to 66bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis/// this macro in spelling, arguments, and whitespace. 67bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis/// 68bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis/// \param Syntactically if true, the macro definitions can be identical even 69bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis/// if they use different identifiers for the function macro parameters. 70bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis/// Otherwise the comparison is lexical and this implements the rules in 71bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis/// C99 6.10.3. 72bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidisbool MacroInfo::isIdenticalTo(const MacroInfo &Other, Preprocessor &PP, 73bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis bool Syntactically) const { 74bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis bool Lexically = !Syntactically; 75bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Check # tokens in replacement, number of args, and various flags all match. 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (ReplacementTokens.size() != Other.ReplacementTokens.size() || 7825c9648909193d380a4e135d2e3d25394ba12922Chris Lattner getNumArgs() != Other.getNumArgs() || 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer isFunctionLike() != Other.isFunctionLike() || 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer isC99Varargs() != Other.isC99Varargs() || 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer isGNUVarargs() != Other.isGNUVarargs()) 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return false; 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 84bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis if (Lexically) { 85bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis // Check arguments. 86bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis for (arg_iterator I = arg_begin(), OI = Other.arg_begin(), E = arg_end(); 87bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis I != E; ++I, ++OI) 88bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis if (*I != *OI) return false; 89bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis } 901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Check all the tokens. 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer for (unsigned i = 0, e = ReplacementTokens.size(); i != e; ++i) { 93d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner const Token &A = ReplacementTokens[i]; 94d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner const Token &B = Other.ReplacementTokens[i]; 95688a248e03f31312161db97e5e11a950b5b1369cChris Lattner if (A.getKind() != B.getKind()) 96688a248e03f31312161db97e5e11a950b5b1369cChris Lattner return false; 971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 98688a248e03f31312161db97e5e11a950b5b1369cChris Lattner // If this isn't the first first token, check that the whitespace and 99688a248e03f31312161db97e5e11a950b5b1369cChris Lattner // start-of-line characteristics match. 100688a248e03f31312161db97e5e11a950b5b1369cChris Lattner if (i != 0 && 101688a248e03f31312161db97e5e11a950b5b1369cChris Lattner (A.isAtStartOfLine() != B.isAtStartOfLine() || 102688a248e03f31312161db97e5e11a950b5b1369cChris Lattner A.hasLeadingSpace() != B.hasLeadingSpace())) 1035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return false; 1041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // If this is an identifier, it is easy. 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (A.getIdentifierInfo() || B.getIdentifierInfo()) { 107bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis if (A.getIdentifierInfo() == B.getIdentifierInfo()) 108bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis continue; 109bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis if (Lexically) 110bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis return false; 111bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis // With syntactic equivalence the parameter names can be different as long 112bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis // as they are used in the same place. 113bd25ff8632e18bb3af761369fd3b0f1b48fdf061Argyrios Kyrtzidis int AArgNum = getArgumentNum(A.getIdentifierInfo()); 1144ad33d0f971da3eba5041f13fbd034f80ea9bfebArgyrios Kyrtzidis if (AArgNum == -1) 1154ad33d0f971da3eba5041f13fbd034f80ea9bfebArgyrios Kyrtzidis return false; 1164ad33d0f971da3eba5041f13fbd034f80ea9bfebArgyrios Kyrtzidis if (AArgNum != Other.getArgumentNum(B.getIdentifierInfo())) 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return false; 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer continue; 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Otherwise, check the spelling. 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (PP.getSpelling(A) != PP.getSpelling(B)) 1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return false; 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return true; 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1289818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis 129651f13cea278ec967336033dd032faef0e9fc2ecStephen HinesMacroDirective::DefInfo MacroDirective::getDefinition() { 130c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis MacroDirective *MD = this; 131c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis SourceLocation UndefLoc; 132c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis Optional<bool> isPublic; 133c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis for (; MD; MD = MD->getPrevious()) { 134c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis if (DefMacroDirective *DefMD = dyn_cast<DefMacroDirective>(MD)) 135c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis return DefInfo(DefMD, UndefLoc, 136c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis !isPublic.hasValue() || isPublic.getValue()); 137c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis 138c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis if (UndefMacroDirective *UndefMD = dyn_cast<UndefMacroDirective>(MD)) { 139c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis UndefLoc = UndefMD->getLocation(); 140c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis continue; 141c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis } 142c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis 143c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis VisibilityMacroDirective *VisMD = cast<VisibilityMacroDirective>(MD); 144c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis if (!isPublic.hasValue()) 145c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis isPublic = VisMD->isPublic(); 146c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis } 147c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis 1486bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DefInfo(nullptr, UndefLoc, 1496bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines !isPublic.hasValue() || isPublic.getValue()); 150c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis} 151c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis 152c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidisconst MacroDirective::DefInfo 1539818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios KyrtzidisMacroDirective::findDirectiveAtLoc(SourceLocation L, SourceManager &SM) const { 1549818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis assert(L.isValid() && "SourceLocation is invalid."); 155c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis for (DefInfo Def = getDefinition(); Def; Def = Def.getPreviousDefinition()) { 156c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis if (Def.getLocation().isInvalid() || // For macros defined on the command line. 157c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis SM.isBeforeInTranslationUnit(Def.getLocation(), L)) 158c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis return (!Def.isUndefined() || 159c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis SM.isBeforeInTranslationUnit(L, Def.getUndefLocation())) 160c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis ? Def : DefInfo(); 1619818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis } 162c56fff7fd231aebf4b152f60f8f11ef91835c48aArgyrios Kyrtzidis return DefInfo(); 1639818a1d443e97677dd3422305de9cc2b1fb2a8c1Argyrios Kyrtzidis} 164