[clang] NFCI: Use FileEntryRef in ASTReader::GetHeaderFileInfo()

This is the `ASTReader` counterpart to PR llvm#67383.

Author: jansvoboda11

clang-tools-extra/clangd/IncludeCleaner.cpp

@@ -102,7 +102,7 @@ bool mayConsiderUnused(const Inclusion &Inc, ParsedAST &AST,
  // Headers without include guards have side effects and are not
  // self-contained, skip them.
  if (!AST.getPreprocessor().getHeaderSearchInfo().isFileMultipleIncludeGuarded(
- &FE->getFileEntry())) {
+ *FE)) {
  dlog("{0} doesn't have header guard and will not be considered unused",
  FE->getName());
  return false;

clang-tools-extra/clangd/ParsedAST.cpp

@@ -499,8 +499,8 @@ ParsedAST::build(llvm::StringRef Filename, const ParseInputs &Inputs,
  // (The rest of HeaderFileInfo is not relevant for our purposes).
  if (Preamble && Preamble->MainIsIncludeGuarded) {
  const SourceManager &SM = Clang->getSourceManager();
- const FileEntry *MainFE = SM.getFileEntryForID(SM.getMainFileID());
- Clang->getPreprocessor().getHeaderSearchInfo().MarkFileIncludeOnce(MainFE);
+ OptionalFileEntryRef MainFE = SM.getFileEntryRefForID(SM.getMainFileID());
+ Clang->getPreprocessor().getHeaderSearchInfo().MarkFileIncludeOnce(*MainFE);
  }
 
  // Set up ClangTidy. Must happen after BeginSourceFile() so ASTContext exists.

clang-tools-extra/clangd/Preamble.cpp

@@ -122,10 +122,10 @@ class CppFilePreambleCallbacks : public PreambleCallbacks {
  CapturedCtx.emplace(CI);
 
  const SourceManager &SM = CI.getSourceManager();
- const FileEntry *MainFE = SM.getFileEntryForID(SM.getMainFileID());
+ OptionalFileEntryRef MainFE = SM.getFileEntryRefForID(SM.getMainFileID());
  IsMainFileIncludeGuarded =
  CI.getPreprocessor().getHeaderSearchInfo().isFileMultipleIncludeGuarded(
- MainFE);
+ *MainFE);
 
  if (Stats) {
  const ASTContext &AST = CI.getASTContext();

clang-tools-extra/clangd/unittests/ParsedASTTests.cpp

@@ -465,10 +465,10 @@ std::string once(llvm::StringRef Code) {
 
 bool mainIsGuarded(const ParsedAST &AST) {
  const auto &SM = AST.getSourceManager();
- const FileEntry *MainFE = SM.getFileEntryForID(SM.getMainFileID());
+ OptionalFileEntryRef MainFE = SM.getFileEntryRefForID(SM.getMainFileID());
  return AST.getPreprocessor()
  .getHeaderSearchInfo()
- .isFileMultipleIncludeGuarded(MainFE);
+ .isFileMultipleIncludeGuarded(*MainFE);
 }
 
 MATCHER_P(diag, Desc, "") {

clang-tools-extra/include-cleaner/lib/Record.cpp

@@ -188,8 +188,8 @@ class PragmaIncludes::RecordPragma : public PPCallbacks, public CommentHandler {
  if (Reason == PPCallbacks::ExitFile) {
  // At file exit time HeaderSearchInfo is valid and can be used to
  // determine whether the file was a self-contained header or not.
- if (const FileEntry *FE = SM.getFileEntryForID(PrevFID)) {
- if (tooling::isSelfContainedHeader(FE, SM, HeaderInfo))
+ if (OptionalFileEntryRef FE = SM.getFileEntryRefForID(PrevFID)) {
+ if (tooling::isSelfContainedHeader(*FE, SM, HeaderInfo))
  Out->NonSelfContainedFiles.erase(FE->getUniqueID());
  else
  Out->NonSelfContainedFiles.insert(FE->getUniqueID());

clang/include/clang/Lex/HeaderSearch.h

@@ -139,7 +139,7 @@ class ExternalHeaderFileInfoSource {
  /// \returns Header file information for the given file entry, with the
  /// \c External bit set. If the file entry is not known, return a
  /// default-constructed \c HeaderFileInfo.
- virtual HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) = 0;
+ virtual HeaderFileInfo GetHeaderFileInfo(FileEntryRef FE) = 0;
 };
 
 /// This structure is used to record entries in our framework cache.
@@ -487,7 +487,7 @@ class HeaderSearch {
  OptionalFileEntryRef LookupFile(
  StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
  ConstSearchDirIterator FromDir, ConstSearchDirIterator *CurDir,
- ArrayRef<std::pair<const FileEntry *, DirectoryEntryRef>> Includers,
+ ArrayRef<std::pair<OptionalFileEntryRef, DirectoryEntryRef>> Includers,
  SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
  Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule,
  bool *IsMapped, bool *IsFrameworkFound, bool SkipCache = false,
@@ -522,33 +522,32 @@ class HeaderSearch {
 
  /// Return whether the specified file is a normal header,
  /// a system header, or a C++ friendly system header.
- SrcMgr::CharacteristicKind getFileDirFlavor(const FileEntry *File) {
+ SrcMgr::CharacteristicKind getFileDirFlavor(FileEntryRef File) {
  return (SrcMgr::CharacteristicKind)getFileInfo(File).DirInfo;
  }
 
  /// Mark the specified file as a "once only" file due to
  /// \#pragma once.
- void MarkFileIncludeOnce(const FileEntry *File) {
+ void MarkFileIncludeOnce(FileEntryRef File) {
  HeaderFileInfo &FI = getFileInfo(File);
  FI.isPragmaOnce = true;
  }
 
  /// Mark the specified file as a system header, e.g. due to
  /// \#pragma GCC system_header.
- void MarkFileSystemHeader(const FileEntry *File) {
+ void MarkFileSystemHeader(FileEntryRef File) {
  getFileInfo(File).DirInfo = SrcMgr::C_System;
  }
 
  /// Mark the specified file as part of a module.
- void MarkFileModuleHeader(const FileEntry *FE,
- ModuleMap::ModuleHeaderRole Role,
+ void MarkFileModuleHeader(FileEntryRef FE, ModuleMap::ModuleHeaderRole Role,
  bool isCompilingModuleHeader);
 
  /// Mark the specified file as having a controlling macro.
  ///
  /// This is used by the multiple-include optimization to eliminate
  /// no-op \#includes.
- void SetFileControllingMacro(const FileEntry *File,
+ void SetFileControllingMacro(FileEntryRef File,
  const IdentifierInfo *ControllingMacro) {
  getFileInfo(File).ControllingMacro = ControllingMacro;
  }
@@ -558,10 +557,10 @@ class HeaderSearch {
  /// macro.
  ///
  /// This routine does not consider the effect of \#import
- bool isFileMultipleIncludeGuarded(const FileEntry *File) const;
+ bool isFileMultipleIncludeGuarded(FileEntryRef File) const;
 
  /// Determine whether the given file is known to have ever been \#imported.
- bool hasFileBeenImported(const FileEntry *File) const {
+ bool hasFileBeenImported(FileEntryRef File) const {
  const HeaderFileInfo *FI = getExistingFileInfo(File);
  return FI && FI->isImport;
  }
@@ -806,13 +805,13 @@ class HeaderSearch {
 
  /// Return the HeaderFileInfo structure for the specified FileEntry,
  /// in preparation for updating it in some way.
- HeaderFileInfo &getFileInfo(const FileEntry *FE);
+ HeaderFileInfo &getFileInfo(FileEntryRef FE);
 
  /// Return the HeaderFileInfo structure for the specified FileEntry,
  /// if it has ever been filled in.
  /// \param WantExternal Whether the caller wants purely-external header file
  /// info (where \p External is true).
- const HeaderFileInfo *getExistingFileInfo(const FileEntry *FE,
+ const HeaderFileInfo *getExistingFileInfo(FileEntryRef FE,
  bool WantExternal = true) const;
 
  SearchDirIterator search_dir_begin() { return {*this, 0}; }

clang/include/clang/Lex/Preprocessor.h

@@ -1483,13 +1483,13 @@ class Preprocessor {
 
  /// Mark the file as included.
  /// Returns true if this is the first time the file was included.
- bool markIncluded(const FileEntry *File) {
+ bool markIncluded(FileEntryRef File) {
  HeaderInfo.getFileInfo(File);
  return IncludedFiles.insert(File).second;
  }
 
  /// Return true if this header has already been included.
- bool alreadyIncluded(const FileEntry *File) const {
+ bool alreadyIncluded(FileEntryRef File) const {
  HeaderInfo.getFileInfo(File);
  return IncludedFiles.count(File);
  }

clang/include/clang/Serialization/ASTReader.h

@@ -1821,7 +1821,7 @@ class ASTReader
  SourceRange ReadSkippedRange(unsigned Index) override;
 
  /// Read the header file information for the given file entry.
- HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) override;
+ HeaderFileInfo GetHeaderFileInfo(FileEntryRef FE) override;
 
  void ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag);
 

clang/include/clang/Tooling/Inclusions/HeaderAnalysis.h

@@ -9,11 +9,11 @@
 #ifndef LLVM_CLANG_TOOLING_INCLUSIONS_HEADER_ANALYSIS_H
 #define LLVM_CLANG_TOOLING_INCLUSIONS_HEADER_ANALYSIS_H
 
+#include "clang/Basic/FileEntry.h"
 #include "llvm/ADT/StringRef.h"
 #include <optional>
 
 namespace clang {
-class FileEntry;
 class SourceManager;
 class HeaderSearch;
 
@@ -27,7 +27,7 @@ namespace tooling {
 ///
 /// This function can be expensive as it may scan the source code to find out
 /// dont-include-me pattern heuristically.
-bool isSelfContainedHeader(const FileEntry *FE, const SourceManager &SM,
+bool isSelfContainedHeader(FileEntryRef FE, const SourceManager &SM,
  const HeaderSearch &HeaderInfo);
 
 /// This scans the given source code to see if it contains #import(s).

clang/lib/Frontend/FrontendAction.cpp

@@ -830,8 +830,8 @@ bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
  HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
  // Relative searches begin from CWD.
  auto Dir = CI.getFileManager().getOptionalDirectoryRef(".");
- SmallVector<std::pair<const FileEntry *, DirectoryEntryRef>, 1> CWD;
- CWD.push_back({nullptr, *Dir});
+ SmallVector<std::pair<OptionalFileEntryRef, DirectoryEntryRef>, 1> CWD;
+ CWD.push_back({std::nullopt, *Dir});
  OptionalFileEntryRef FE =
  HS.LookupFile(FileName, SourceLocation(),
  /*Angled*/ Input.getKind().getHeaderUnitKind() ==