Author: Haojian Wu Date: 2019-11-15T16:18:27+01:00 New Revision: 509efe5d8edee5637b26fcb645978325de0a7283
URL: https://github.com/llvm/llvm-project/commit/509efe5d8edee5637b26fcb645978325de0a7283 DIFF: https://github.com/llvm/llvm-project/commit/509efe5d8edee5637b26fcb645978325de0a7283.diff LOG: [clangd] Add isHeaderFile helper. Summary: we have a few places using `ASTCtx.getLangOpts().IsHeaderFile` to determine a header file, but it relies on "-x c-header" compiler flag, if the compilation command doesn't have this flag, we will get a false positive. We are encountering this issue in bazel build system. To solve this problem, we infer the file from file name, actual changes will come in follow-ups. Reviewers: sammccall Subscribers: ilya-biryukov, MaskRay, jkorous, arphaman, kadircet, usaxena95, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D70235 Added: Modified: clang-tools-extra/clangd/SourceCode.cpp clang-tools-extra/clangd/SourceCode.h clang-tools-extra/clangd/index/Background.cpp clang-tools-extra/clangd/unittests/SourceCodeTests.cpp Removed: ################################################################################ diff --git a/clang-tools-extra/clangd/SourceCode.cpp b/clang-tools-extra/clangd/SourceCode.cpp index d505645a74f6..b36d11d64a3e 100644 --- a/clang-tools-extra/clangd/SourceCode.cpp +++ b/clang-tools-extra/clangd/SourceCode.cpp @@ -17,6 +17,7 @@ #include "clang/Basic/SourceLocation.h" #include "clang/Basic/SourceManager.h" #include "clang/Basic/TokenKinds.h" +#include "clang/Driver/Types.h" #include "clang/Format/Format.h" #include "clang/Lex/Lexer.h" #include "clang/Lex/Preprocessor.h" @@ -1122,5 +1123,17 @@ EligibleRegion getEligiblePoints(llvm::StringRef Code, return ER; } +bool isHeaderFile(llvm::StringRef FileName, + llvm::Optional<LangOptions> LangOpts) { + // Respect the langOpts, for non-file-extension cases, e.g. standard library + // files. + if (LangOpts && LangOpts->IsHeaderFile) + return true; + namespace types = clang::driver::types; + auto Lang = types::lookupTypeForExtension( + llvm::sys::path::extension(FileName).substr(1)); + return Lang != types::TY_INVALID && types::onlyPrecompileType(Lang); +} + } // namespace clangd } // namespace clang diff --git a/clang-tools-extra/clangd/SourceCode.h b/clang-tools-extra/clangd/SourceCode.h index d20e03f5b87f..3b8aacef9bf1 100644 --- a/clang-tools-extra/clangd/SourceCode.h +++ b/clang-tools-extra/clangd/SourceCode.h @@ -292,10 +292,15 @@ struct DefinedMacro { llvm::StringRef Name; const MacroInfo *Info; }; -// Gets the macro at a specified \p Loc. +/// Gets the macro at a specified \p Loc. llvm::Optional<DefinedMacro> locateMacroAt(SourceLocation Loc, Preprocessor &PP); +/// Infers whether this is a header from the FileName and LangOpts (if +/// presents). +bool isHeaderFile(llvm::StringRef FileName, + llvm::Optional<LangOptions> LangOpts = llvm::None); + } // namespace clangd } // namespace clang #endif diff --git a/clang-tools-extra/clangd/index/Background.cpp b/clang-tools-extra/clangd/index/Background.cpp index ff6a9e522684..1fa9825291fe 100644 --- a/clang-tools-extra/clangd/index/Background.cpp +++ b/clang-tools-extra/clangd/index/Background.cpp @@ -205,11 +205,7 @@ BackgroundIndex::indexFileTask(tooling::CompileCommand Cmd) { } void BackgroundIndex::boostRelated(llvm::StringRef Path) { - namespace types = clang::driver::types; - auto Type = - types::lookupTypeForExtension(llvm::sys::path::extension(Path).substr(1)); - // is this a header? - if (Type != types::TY_INVALID && types::onlyPrecompileType(Type)) + if (isHeaderFile(Path)) Queue.boost(filenameWithoutExtension(Path), IndexBoostedFile); } diff --git a/clang-tools-extra/clangd/unittests/SourceCodeTests.cpp b/clang-tools-extra/clangd/unittests/SourceCodeTests.cpp index e9cd886e1dd1..adc09a4f311d 100644 --- a/clang-tools-extra/clangd/unittests/SourceCodeTests.cpp +++ b/clang-tools-extra/clangd/unittests/SourceCodeTests.cpp @@ -701,6 +701,30 @@ o foo2; collectIdentifierRanges("Foo", Code.code(), LangOpts)); } +TEST(SourceCodeTests, isHeaderFile) { + // Without lang options. + EXPECT_TRUE(isHeaderFile("foo.h")); + EXPECT_TRUE(isHeaderFile("foo.hh")); + EXPECT_TRUE(isHeaderFile("foo.hpp")); + + EXPECT_FALSE(isHeaderFile("foo.cpp")); + EXPECT_FALSE(isHeaderFile("foo.c++")); + EXPECT_FALSE(isHeaderFile("foo.cxx")); + EXPECT_FALSE(isHeaderFile("foo.cc")); + EXPECT_FALSE(isHeaderFile("foo.c")); + EXPECT_FALSE(isHeaderFile("foo.mm")); + EXPECT_FALSE(isHeaderFile("foo.m")); + + // With lang options + LangOptions LangOpts; + LangOpts.IsHeaderFile = true; + EXPECT_TRUE(isHeaderFile("string", LangOpts)); + // Emulate cases where there is no "-x header" flag for a .h file, we still + // want to treat it as a header. + LangOpts.IsHeaderFile = false; + EXPECT_TRUE(isHeaderFile("header.h", LangOpts)); +} + } // namespace } // namespace clangd } // namespace clang _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits