squiid/llvm
1
0
Fork 0
Code Issues Pull requests Activity

[clang][lex] Remove PPCallbacks::FileNotFound()

Browse source 
The purpose of the `FileNotFound` preprocessor callback was to add the ability to recover from failed header lookups. This was to support downstream project.

However, injecting additional search path while performing header search can invalidate currently used iterators/references to `DirectoryLookup` in `Preprocessor` and `HeaderSearch`.

The downstream project ended up maintaining a separate patch to further tweak the functionality. Since we don't have any upstream users nor open source downstream users, I'd like to remove this callback for good to prevent future misuse. I doubt there are any actual downstream users, since the functionality is definitely broken at the moment.

Reviewed By: ahoppen

Differential Revision: https://reviews.llvm.org/D119708
This commit is contained in:
Jan Svoboda 2022-02-15 09:17:22 +01:00
parent 8f55cd0178
commit 7a124f4859
5 changed files with 0 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
clang-tools-extra/clangd/ParsedAST.cpp
View file

@ -226,10 +226,6 @@ private:
/*Imported=*/nullptr, Inc.FileKind);
if (File)
Delegate->FileSkipped(*File, SynthesizedFilenameTok, Inc.FileKind);
else {
llvm::SmallString<1> UnusedRecovery;
Delegate->FileNotFound(WrittenFilename, UnusedRecovery);
}
}
}

10
clang-tools-extra/pp-trace/PPCallbacksTracker.cpp
View file

@ -128,16 +128,6 @@ void PPCallbacksTracker::FileSkipped(const FileEntryRef &SkippedFile,
appendArgument("FileType", FileType, CharacteristicKindStrings);
}
// Callback invoked whenever an inclusion directive results in a
// file-not-found error.
bool
PPCallbacksTracker::FileNotFound(llvm::StringRef FileName,
llvm::SmallVectorImpl<char> &RecoveryPath) {
beginCallback("FileNotFound");
appendFilePathArgument("FileName", FileName);
return false;
}
// Callback invoked whenever an inclusion directive of
// any kind (#include, #import, etc.) has been processed, regardless
// of whether the inclusion will actually result in an inclusion.

2
clang-tools-extra/pp-trace/PPCallbacksTracker.h
View file

@ -91,8 +91,6 @@ public:
FileID PrevFID = FileID()) override;
void FileSkipped(const FileEntryRef &SkippedFile, const Token &FilenameTok,
SrcMgr::CharacteristicKind FileType) override;
bool FileNotFound(llvm::StringRef FileName,
llvm::SmallVectorImpl<char> &RecoveryPath) override;
void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok,
llvm::StringRef FileName, bool IsAngled,
CharSourceRange FilenameRange, const FileEntry *File,

23
clang/include/clang/Lex/PPCallbacks.h
View file

@ -61,23 +61,6 @@ public:
const Token &FilenameTok,
SrcMgr::CharacteristicKind FileType) {}
/// Callback invoked whenever an inclusion directive results in a
/// file-not-found error.
///
/// \param FileName The name of the file being included, as written in the
/// source code.
///
/// \param RecoveryPath If this client indicates that it can recover from
/// this missing file, the client should set this as an additional header
/// search patch.
///
/// \returns true to indicate that the preprocessor should attempt to recover
/// by adding \p RecoveryPath as a header search path.
virtual bool FileNotFound(StringRef FileName,
SmallVectorImpl<char> &RecoveryPath) {
return false;
}
/// Callback invoked whenever an inclusion directive of
/// any kind (\c \#include, \c \#import, etc.) has been processed, regardless
/// of whether the inclusion will actually result in an inclusion.
@ -443,12 +426,6 @@ public:
Second->FileSkipped(SkippedFile, FilenameTok, FileType);
}
bool FileNotFound(StringRef FileName,
SmallVectorImpl<char> &RecoveryPath) override {
return First->FileNotFound(FileName, RecoveryPath) ||
Second->FileNotFound(FileName, RecoveryPath);
}
void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok,
StringRef FileName, bool IsAngled,
CharSourceRange FilenameRange, const FileEntry *File,

22
clang/lib/Lex/PPDirectives.cpp
View file

@ -1845,28 +1845,6 @@ Optional<FileEntryRef> Preprocessor::LookupHeaderIncludeOrImport(
if (File)
return File;
if (Callbacks) {
// Give the clients a chance to recover.
SmallString<128> RecoveryPath;
if (Callbacks->FileNotFound(Filename, RecoveryPath)) {
if (auto DE = FileMgr.getOptionalDirectoryRef(RecoveryPath)) {
// Add the recovery path to the list of search paths.
DirectoryLookup DL(*DE, SrcMgr::C_User, false);
HeaderInfo.AddSearchPath(DL, isAngled);
// Try the lookup again, skipping the cache.
Optional<FileEntryRef> File = LookupFile(
FilenameLoc,
LookupFilename, isAngled,
LookupFrom, LookupFromFile, CurDir, nullptr, nullptr,
&SuggestedModule, &IsMapped, /*IsFrameworkFound=*/nullptr,
/*SkipCache*/ true);
if (File)
return File;
}
}
}
if (SuppressIncludeNotFoundError)
return None;