Skip to content

Commit

Permalink
[clangd] Allow using customized include path in URI.
Browse files Browse the repository at this point in the history
Summary:
Calculating the include path from absolute file path does not always
work for all build system, e.g. bazel uses symlink as the build working
directory. The absolute file path from editor and clang is diverged from
each other. We need to address it properly in build sysmtem integration.

This patch worksarounds the issue by providing a hook in URI which allows
clients to provide their customized include path.

Reviewers: sammccall

Subscribers: klimek, ilya-biryukov, jkorous-apple, ioeric, MaskRay, cfe-commits

Differential Revision: https://reviews.llvm.org/D45426

llvm-svn: 329578
  • Loading branch information
hokein committed Apr 9, 2018
1 parent 935474f commit e9a5a2f
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 0 deletions.
7 changes: 7 additions & 0 deletions clang-tools-extra/clangd/ClangdServer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,13 @@ static llvm::Expected<HeaderFile> toHeaderFile(StringRef Header,
auto U = URI::parse(Header);
if (!U)
return U.takeError();

auto IncludePath = URI::includeSpelling(*U);
if (!IncludePath)
return IncludePath.takeError();
if (!IncludePath->empty())
return HeaderFile{std::move(*IncludePath), /*Verbatim=*/true};

auto Resolved = URI::resolve(*U, HintPath);
if (!Resolved)
return Resolved.takeError();
Expand Down
7 changes: 7 additions & 0 deletions clang-tools-extra/clangd/URI.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -196,5 +196,12 @@ llvm::Expected<std::string> URI::resolve(const URI &Uri,
return S->get()->getAbsolutePath(Uri.Authority, Uri.Body, HintPath);
}

llvm::Expected<std::string> URI::includeSpelling(const URI &Uri) {
auto S = findSchemeByName(Uri.Scheme);
if (!S)
return S.takeError();
return S->get()->getIncludeSpelling(Uri);
}

} // namespace clangd
} // namespace clang
17 changes: 17 additions & 0 deletions clang-tools-extra/clangd/URI.h
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ class URI {
static llvm::Expected<std::string> resolve(const URI &U,
llvm::StringRef HintPath = "");

/// Gets the preferred spelling of this file for #include, if there is one,
/// e.g. <system_header.h>, "path/to/x.h".
///
/// This allows URI schemas to provide their customized include paths.
///
/// Returns an empty string if normal include-shortening based on the absolute
/// path should be used.
/// Fails if the URI is not valid in the schema.
static llvm::Expected<std::string> includeSpelling(const URI &U);

friend bool operator==(const URI &LHS, const URI &RHS) {
return std::tie(LHS.Scheme, LHS.Authority, LHS.Body) ==
std::tie(RHS.Scheme, RHS.Authority, RHS.Body);
Expand Down Expand Up @@ -94,6 +104,13 @@ class URIScheme {

virtual llvm::Expected<URI>
uriFromAbsolutePath(llvm::StringRef AbsolutePath) const = 0;

/// Returns the include path of the file (e.g. <path>, "path"), which can be
/// #included directly. See URI::includeSpelling for details.
virtual llvm::Expected<std::string>
getIncludeSpelling(const URI& U) const {
return ""; // no customized include path for this scheme.
}
};

/// By default, a "file" scheme is supported where URI paths are always absolute
Expand Down
26 changes: 26 additions & 0 deletions clang-tools-extra/unittests/clangd/ClangdTests.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,28 @@ class ClangdVFSTest : public ::testing::Test {
}
};

constexpr const char* ClangdTestScheme = "ClangdTests";
class TestURIScheme : public URIScheme {
public:
llvm::Expected<std::string>
getAbsolutePath(llvm::StringRef /*Authority*/, llvm::StringRef Body,
llvm::StringRef /*HintPath*/) const override {
llvm_unreachable("ClangdTests never makes absolute path.");
}

llvm::Expected<URI>
uriFromAbsolutePath(llvm::StringRef AbsolutePath) const override {
llvm_unreachable("ClangdTest never creates a test URI.");
}

llvm::Expected<std::string> getIncludeSpelling(const URI &U) const override {
return ("\"" + U.body().trim("/") + "\"").str();
}
};

static URISchemeRegistry::Add<TestURIScheme>
X(ClangdTestScheme, "Test scheme for ClangdTests.");

TEST_F(ClangdVFSTest, Parse) {
// FIXME: figure out a stable format for AST dumps, so that we can check the
// output of the dump itself is equal to the expected one, not just that it's
Expand Down Expand Up @@ -961,6 +983,10 @@ void f() {}
/*Preferred=*/"<Y.h>", "<Y.h>"));
EXPECT_TRUE(Inserted(OriginalHeader, PreferredHeader, "\"Y.h\""));
EXPECT_TRUE(Inserted("<y.h>", PreferredHeader, "\"Y.h\""));
auto TestURIHeader =
URI::parse(llvm::formatv("{0}:///x/y/z.h", ClangdTestScheme).str());
EXPECT_TRUE(static_cast<bool>(TestURIHeader));
EXPECT_TRUE(Inserted(TestURIHeader->toString(), "", "\"x/y/z.h\""));

// Check that includes are sorted.
const auto Expected = R"cpp(
Expand Down
Empty file.

0 comments on commit e9a5a2f

Please sign in to comment.