diff --git a/clang/include/clang/ExtractAPI/FrontendActions.h b/clang/include/clang/ExtractAPI/FrontendActions.h index 2cb8ef130fdd7..dec3b5ca93d18 100644 --- a/clang/include/clang/ExtractAPI/FrontendActions.h +++ b/clang/include/clang/ExtractAPI/FrontendActions.h @@ -40,10 +40,7 @@ class ExtractAPIAction : public ASTFrontendAction { std::unique_ptr Buffer; /// The input file originally provided on the command line. - /// - /// This captures the spelling used to include the file and whether the - /// include is quoted or not. - SmallVector, bool>> KnownInputFiles; + std::vector KnownInputFiles; /// Prepare to execute the action on the given CompilerInstance. /// diff --git a/clang/lib/ExtractAPI/ExtractAPIConsumer.cpp b/clang/lib/ExtractAPI/ExtractAPIConsumer.cpp index 317bcd1be8256..b1de2674b622b 100644 --- a/clang/lib/ExtractAPI/ExtractAPIConsumer.cpp +++ b/clang/lib/ExtractAPI/ExtractAPIConsumer.cpp @@ -38,10 +38,7 @@ #include "llvm/ADT/DenseSet.h" #include "llvm/ADT/STLExtras.h" #include "llvm/ADT/SmallVector.h" -#include "llvm/Support/FileSystem.h" #include "llvm/Support/MemoryBuffer.h" -#include "llvm/Support/Path.h" -#include "llvm/Support/Regex.h" #include "llvm/Support/raw_ostream.h" #include #include @@ -58,128 +55,10 @@ StringRef getTypedefName(const TagDecl *Decl) { return {}; } -Optional getRelativeIncludeName(const CompilerInstance &CI, - StringRef File, - bool *IsQuoted = nullptr) { - assert(CI.hasFileManager() && - "CompilerInstance does not have a FileNamager!"); - - using namespace llvm::sys; - // Matches framework include patterns - const llvm::Regex Rule("/(.+)\\.framework/(.+)?Headers/(.+)"); - - const auto &FS = CI.getVirtualFileSystem(); - - SmallString<128> FilePath(File.begin(), File.end()); - FS.makeAbsolute(FilePath); - path::remove_dots(FilePath, true); - File = FilePath; - - // Checks whether `Dir` is a strict path prefix of `File`. If so returns - // the prefix length. Otherwise return 0. - auto CheckDir = [&](llvm::StringRef Dir) -> unsigned { - llvm::SmallString<32> DirPath(Dir.begin(), Dir.end()); - FS.makeAbsolute(DirPath); - path::remove_dots(DirPath, true); - Dir = DirPath; - for (auto NI = path::begin(File), NE = path::end(File), - DI = path::begin(Dir), DE = path::end(Dir); - /*termination condition in loop*/; ++NI, ++DI) { - // '.' components in File are ignored. - while (NI != NE && *NI == ".") - ++NI; - if (NI == NE) - break; - - // '.' components in Dir are ignored. - while (DI != DE && *DI == ".") - ++DI; - - // Dir is a prefix of File, up to '.' components and choice of path - // separators. - if (DI == DE) - return NI - path::begin(File); - - // Consider all path separators equal. - if (NI->size() == 1 && DI->size() == 1 && - path::is_separator(NI->front()) && path::is_separator(DI->front())) - continue; - - // Special case Apple .sdk folders since the search path is typically a - // symlink like `iPhoneSimulator14.5.sdk` while the file is instead - // located in `iPhoneSimulator.sdk` (the real folder). - if (NI->endswith(".sdk") && DI->endswith(".sdk")) { - StringRef NBasename = path::stem(*NI); - StringRef DBasename = path::stem(*DI); - if (DBasename.startswith(NBasename)) - continue; - } - - if (*NI != *DI) - break; - } - return 0; - }; - - unsigned PrefixLength = 0; - - // Go through the search paths and find the first one that is a prefix of - // the header. - for (const auto &Entry : CI.getHeaderSearchOpts().UserEntries) { - // Note whether the match is found in a quoted entry. - if (IsQuoted) - *IsQuoted = Entry.Group == frontend::Quoted; - - if (auto EntryFile = CI.getFileManager().getOptionalFileRef(Entry.Path)) { - if (auto HMap = HeaderMap::Create(*EntryFile, CI.getFileManager())) { - // If this is a headermap entry, try to reverse lookup the full path - // for a spelled name before mapping. - StringRef SpelledFilename = - HMap->reverseLookupFilename(path::convert_to_slash(File)); - if (!SpelledFilename.empty()) - return SpelledFilename.str(); - - // No matching mapping in this headermap, try next search entry. - continue; - } - } - - // Entry is a directory search entry, try to check if it's a prefix of File. - PrefixLength = CheckDir(Entry.Path); - if (PrefixLength > 0) { - // The header is found in a framework path, construct the framework-style - // include name `` - if (Entry.IsFramework) { - SmallVector Matches; - // Convert the file path to forward slashes for matching the framework - // regex. - Rule.match(path::convert_to_slash(File), &Matches); - // Returned matches are always in stable order. - if (Matches.size() != 4) - return None; - - return path::convert_to_slash( - (Matches[1].drop_front(Matches[1].rfind('/') + 1) + "/" + - Matches[3]) - .str()); - - } - - // The header is found in a normal search path, strip the search path - // prefix to get an include name. - return path::convert_to_slash(File.drop_front(PrefixLength)); - } - } - - // Couldn't determine a include name, use full path instead. - return None; -} - struct LocationFileChecker { bool isLocationInKnownFile(SourceLocation Loc) { // If the loc refers to a macro expansion we need to first get the file // location of the expansion. - auto &SM = CI.getSourceManager(); auto FileLoc = SM.getFileLoc(Loc); FileID FID = SM.getFileID(FileLoc); if (FID.isInvalid()) @@ -192,44 +71,20 @@ struct LocationFileChecker { if (KnownFileEntries.count(File)) return true; - if (ExternalFileEntries.count(File)) - return false; - - StringRef FileName = File->tryGetRealPathName().empty() - ? File->getName() - : File->tryGetRealPathName(); - - // Try to reduce the include name the same way we tried to include it. - bool IsQuoted = false; - if (auto IncludeName = getRelativeIncludeName(CI, FileName, &IsQuoted)) - if (llvm::find_if(KnownFiles, - [&IsQuoted, &IncludeName](const auto &KnownFile) { - return KnownFile.first.equals(*IncludeName) && - KnownFile.second == IsQuoted; - }) != KnownFiles.end()) { - KnownFileEntries.insert(File); - return true; - } - - // Record that the file was not found to avoid future reverse lookup for - // the same file. - ExternalFileEntries.insert(File); return false; } - LocationFileChecker(const CompilerInstance &CI, - SmallVector, bool>> &KnownFiles) - : CI(CI), KnownFiles(KnownFiles), ExternalFileEntries() { - for (const auto &KnownFile : KnownFiles) - if (auto FileEntry = CI.getFileManager().getFile(KnownFile.first)) + LocationFileChecker(const SourceManager &SM, + const std::vector &KnownFiles) + : SM(SM) { + for (const auto &KnownFilePath : KnownFiles) + if (auto FileEntry = SM.getFileManager().getFile(KnownFilePath)) KnownFileEntries.insert(*FileEntry); } private: - const CompilerInstance &CI; - SmallVector, bool>> &KnownFiles; + const SourceManager &SM; llvm::DenseSet KnownFileEntries; - llvm::DenseSet ExternalFileEntries; }; /// The RecursiveASTVisitor to traverse symbol declarations and collect API @@ -888,7 +743,8 @@ ExtractAPIAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) { CI.getTarget().getTriple(), CI.getFrontendOpts().Inputs.back().getKind().getLanguage()); - auto LCF = std::make_unique(CI, KnownInputFiles); + auto LCF = std::make_unique(CI.getSourceManager(), + KnownInputFiles); CI.getPreprocessor().addPPCallbacks(std::make_unique( CI.getSourceManager(), *LCF, *API, CI.getPreprocessor())); @@ -902,47 +758,22 @@ bool ExtractAPIAction::PrepareToExecuteAction(CompilerInstance &CI) { if (Inputs.empty()) return true; - if (!CI.hasFileManager()) - if (!CI.createFileManager()) - return false; - auto Kind = Inputs[0].getKind(); // Convert the header file inputs into a single input buffer. SmallString<256> HeaderContents; - bool IsQuoted = false; for (const FrontendInputFile &FIF : Inputs) { if (Kind.isObjectiveC()) HeaderContents += "#import"; else HeaderContents += "#include"; + HeaderContents += " \""; + HeaderContents += FIF.getFile(); + HeaderContents += "\"\n"; - StringRef FilePath = FIF.getFile(); - if (auto RelativeName = getRelativeIncludeName(CI, FilePath, &IsQuoted)) { - if (IsQuoted) - HeaderContents += " \""; - else - HeaderContents += " <"; - - HeaderContents += *RelativeName; - - if (IsQuoted) - HeaderContents += "\"\n"; - else - HeaderContents += ">\n"; - KnownInputFiles.emplace_back(*RelativeName, IsQuoted); - } else { - HeaderContents += " \""; - HeaderContents += FilePath; - HeaderContents += "\"\n"; - KnownInputFiles.emplace_back(FilePath, true); - } + KnownInputFiles.emplace_back(FIF.getFile()); } - if (CI.getHeaderSearchOpts().Verbose) - CI.getVerboseOutputStream() << getInputBufferName() << ":\n" - << HeaderContents << "\n"; - Buffer = llvm::MemoryBuffer::getMemBufferCopy(HeaderContents, getInputBufferName()); diff --git a/clang/test/ExtractAPI/known_files_only_hmap.c b/clang/test/ExtractAPI/known_files_only_hmap.c new file mode 100644 index 0000000000000..3b7609a73b267 --- /dev/null +++ b/clang/test/ExtractAPI/known_files_only_hmap.c @@ -0,0 +1,176 @@ +// RUN: rm -rf %t +// RUN: split-file %s %t +// RUN: sed -e "s@INPUT_DIR@%{/t:regex_replacement}@g" \ +// RUN: %t/reference.output.json.in >> %t/reference.output.json +// RUN: sed -e "s@INPUT_DIR@%{/t:regex_replacement}@g" \ +// RUN: %t/known_files_only.hmap.json.in >> %t/known_files_only.hmap.json +// RUN: %hmaptool write %t/known_files_only.hmap.json %t/known_files_only.hmap +// RUN: %clang -extract-api --product-name=KnownFilesOnlyHmap -target arm64-apple-macosx \ +// RUN: -I%t/known_files_only.hmap -I%t/subdir %t/subdir/subdir1/input.h \ +// RUN: %t/subdir/subdir2/known_file.h -o %t/output.json | FileCheck -allow-empty %s + +// Generator version is not consistent across test runs, normalize it. +// RUN: sed -e "s@\"generator\": \".*\"@\"generator\": \"?\"@g" \ +// RUN: %t/output.json >> %t/output-normalized.json +// RUN: diff %t/reference.output.json %t/output-normalized.json + +// CHECK-NOT: error: +// CHECK-NOT: warning: +//--- known_files_only.hmap.json.in +{ + "mappings" : + { + "subdir2/known_file.h" : "INPUT_DIR/subdir/subdir3/unknown.h" + } +} + +//--- subdir/subdir1/input.h +int num; +#include "subdir2/known_file.h" + +//--- subdir/subdir2/known_file.h +int known_num; + +//--- subdir/subdir3/unknown.h +// Ensure that these symbols are not emitted in the Symbol Graph. +#ifndef INPUT4_H +#define INPUT4_H + +#define HELLO 1 +char not_emitted; +void foo(int); +struct Foo { int a; }; + +#endif + +//--- reference.output.json.in +{ + "metadata": { + "formatVersion": { + "major": 0, + "minor": 5, + "patch": 3 + }, + "generator": "?" + }, + "module": { + "name": "KnownFilesOnlyHmap", + "platform": { + "architecture": "arm64", + "operatingSystem": { + "minimumVersion": { + "major": 11, + "minor": 0, + "patch": 0 + }, + "name": "macosx" + }, + "vendor": "apple" + } + }, + "relationships": [], + "symbols": [ + { + "accessLevel": "public", + "declarationFragments": [ + { + "kind": "typeIdentifier", + "preciseIdentifier": "c:I", + "spelling": "int" + }, + { + "kind": "text", + "spelling": " " + }, + { + "kind": "identifier", + "spelling": "num" + } + ], + "identifier": { + "interfaceLanguage": "c", + "precise": "c:@num" + }, + "kind": { + "displayName": "Global Variable", + "identifier": "c.var" + }, + "location": { + "position": { + "character": 5, + "line": 1 + }, + "uri": "file://INPUT_DIR/subdir/subdir1/input.h" + }, + "names": { + "navigator": [ + { + "kind": "identifier", + "spelling": "num" + } + ], + "subHeading": [ + { + "kind": "identifier", + "spelling": "num" + } + ], + "title": "num" + }, + "pathComponents": [ + "num" + ] + }, + { + "accessLevel": "public", + "declarationFragments": [ + { + "kind": "typeIdentifier", + "preciseIdentifier": "c:I", + "spelling": "int" + }, + { + "kind": "text", + "spelling": " " + }, + { + "kind": "identifier", + "spelling": "known_num" + } + ], + "identifier": { + "interfaceLanguage": "c", + "precise": "c:@known_num" + }, + "kind": { + "displayName": "Global Variable", + "identifier": "c.var" + }, + "location": { + "position": { + "character": 5, + "line": 1 + }, + "uri": "file://INPUT_DIR/subdir/subdir2/known_file.h" + }, + "names": { + "navigator": [ + { + "kind": "identifier", + "spelling": "known_num" + } + ], + "subHeading": [ + { + "kind": "identifier", + "spelling": "known_num" + } + ], + "title": "known_num" + }, + "pathComponents": [ + "known_num" + ] + } + ] +} diff --git a/clang/test/ExtractAPI/relative_include.m b/clang/test/ExtractAPI/relative_include.m deleted file mode 100644 index a1483a36921d9..0000000000000 --- a/clang/test/ExtractAPI/relative_include.m +++ /dev/null @@ -1,193 +0,0 @@ -// RUN: rm -rf %t -// RUN: split-file %s %t - -// Setup framework root -// RUN: mkdir -p %t/Frameworks/MyFramework.framework/Headers -// RUN: cp %t/MyFramework.h %t/Frameworks/MyFramework.framework/Headers/ -// RUN: cp %t/MyHeader.h %t/Frameworks/MyFramework.framework/Headers/ - -// RUN: sed -e "s@SRCROOT@%{/t:regex_replacement}@g" \ -// RUN: %t/reference.output.json.in >> %t/reference.output.json - -// Headermap maps headers to the source root SRCROOT -// RUN: sed -e "s@SRCROOT@%{/t:regex_replacement}@g" \ -// RUN: %t/headermap.hmap.json.in >> %t/headermap.hmap.json -// RUN: %hmaptool write %t/headermap.hmap.json %t/headermap.hmap - -// Input headers use paths to the framework root/DSTROOT -// RUN: %clang_cc1 -extract-api -v --product-name=MyFramework \ -// RUN: -triple arm64-apple-macosx \ -// RUN: -iquote%t -I%t/headermap.hmap -F%t/Frameworks \ -// RUN: -x objective-c-header \ -// RUN: %t/Frameworks/MyFramework.framework/Headers/MyFramework.h \ -// RUN: %t/Frameworks/MyFramework.framework/Headers/MyHeader.h \ -// RUN: %t/QuotedHeader.h \ -// RUN: -o %t/output.json 2>&1 -verify | FileCheck -allow-empty %s - -// Generator version is not consistent across test runs, normalize it. -// RUN: sed -e "s@\"generator\": \".*\"@\"generator\": \"?\"@g" \ -// RUN: %t/output.json >> %t/output-normalized.json -// RUN: diff %t/reference.output.json %t/output-normalized.json - -// CHECK: : -// CHECK-NEXT: #import -// CHECK-NEXT: #import -// CHECK-NEXT: #import "QuotedHeader.h" - -//--- headermap.hmap.json.in -{ - "mappings" : - { - "MyFramework/MyHeader.h" : "SRCROOT/MyHeader.h" - } -} - -//--- MyFramework.h -// Umbrella for MyFramework -#import -// expected-no-diagnostics - -//--- MyHeader.h -#import -int MyInt; -// expected-no-diagnostics - -//--- QuotedHeader.h -char MyChar; -// expected-no-diagnostics - -//--- Frameworks/OtherFramework.framework/Headers/OtherHeader.h -int OtherInt; -// expected-no-diagnostics - -//--- reference.output.json.in -{ - "metadata": { - "formatVersion": { - "major": 0, - "minor": 5, - "patch": 3 - }, - "generator": "?" - }, - "module": { - "name": "MyFramework", - "platform": { - "architecture": "arm64", - "operatingSystem": { - "minimumVersion": { - "major": 11, - "minor": 0, - "patch": 0 - }, - "name": "macosx" - }, - "vendor": "apple" - } - }, - "relationships": [], - "symbols": [ - { - "accessLevel": "public", - "declarationFragments": [ - { - "kind": "typeIdentifier", - "preciseIdentifier": "c:I", - "spelling": "int" - }, - { - "kind": "text", - "spelling": " " - }, - { - "kind": "identifier", - "spelling": "MyInt" - } - ], - "identifier": { - "interfaceLanguage": "objective-c", - "precise": "c:@MyInt" - }, - "kind": { - "displayName": "Global Variable", - "identifier": "objective-c.var" - }, - "location": { - "position": { - "character": 5, - "line": 2 - }, - "uri": "file://SRCROOT/MyHeader.h" - }, - "names": { - "navigator": [ - { - "kind": "identifier", - "spelling": "MyInt" - } - ], - "subHeading": [ - { - "kind": "identifier", - "spelling": "MyInt" - } - ], - "title": "MyInt" - }, - "pathComponents": [ - "MyInt" - ] - }, - { - "accessLevel": "public", - "declarationFragments": [ - { - "kind": "typeIdentifier", - "preciseIdentifier": "c:C", - "spelling": "char" - }, - { - "kind": "text", - "spelling": " " - }, - { - "kind": "identifier", - "spelling": "MyChar" - } - ], - "identifier": { - "interfaceLanguage": "objective-c", - "precise": "c:@MyChar" - }, - "kind": { - "displayName": "Global Variable", - "identifier": "objective-c.var" - }, - "location": { - "position": { - "character": 6, - "line": 1 - }, - "uri": "file://SRCROOT/QuotedHeader.h" - }, - "names": { - "navigator": [ - { - "kind": "identifier", - "spelling": "MyChar" - } - ], - "subHeading": [ - { - "kind": "identifier", - "spelling": "MyChar" - } - ], - "title": "MyChar" - }, - "pathComponents": [ - "MyChar" - ] - } - ] -}