clang-tools  14.0.0git
PathMapping.h
Go to the documentation of this file.
1 //===--- PathMapping.h - apply path mappings to LSP messages -===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 #include "llvm/ADT/Optional.h"
9 #include "llvm/ADT/StringRef.h"
10 #include "llvm/Support/Error.h"
11 #include "llvm/Support/JSON.h"
12 #include "llvm/Support/raw_ostream.h"
13 #include <memory>
14 #include <string>
15 #include <vector>
16 
17 namespace clang {
18 namespace clangd {
19 
20 class Transport;
21 
22 /// PathMappings are a collection of paired client and server paths.
23 /// These pairs are used to alter file:// URIs appearing in inbound and outbound
24 /// LSP messages, as the client's environment may have source files or
25 /// dependencies at different locations than the server. Therefore, both
26 /// paths are stored as they appear in file URI bodies, e.g. /usr/include or
27 /// /C:/config
28 ///
29 /// For example, if the mappings were {{"/home/user", "/workarea"}}, then
30 /// a client-to-server LSP message would have file:///home/user/foo.cpp
31 /// remapped to file:///workarea/foo.cpp, and the same would happen for replies
32 /// (in the opposite order).
33 struct PathMapping {
34  std::string ClientPath;
35  std::string ServerPath;
37 };
38 using PathMappings = std::vector<PathMapping>;
39 
40 llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, const PathMapping &M);
41 
42 /// Parse the command line \p RawPathMappings (e.g. "/client=/server") into
43 /// pairs. Returns an error if the mappings are malformed, i.e. not absolute or
44 /// not a proper pair.
45 llvm::Expected<PathMappings> parsePathMappings(llvm::StringRef RawPathMappings);
46 
47 /// Returns a modified \p S with the first matching path in \p Mappings
48 /// substituted, if applicable
49 llvm::Optional<std::string> doPathMapping(llvm::StringRef S,
51  const PathMappings &Mappings);
52 
53 /// Applies the \p Mappings to all the file:// URIs in \p Params.
54 /// NOTE: The first matching mapping will be applied, otherwise \p Params will
55 /// be untouched.
57  const PathMappings &Mappings);
58 
59 /// Creates a wrapping transport over \p Transp that applies the \p Mappings to
60 /// all inbound and outbound LSP messages. All calls are then delegated to the
61 /// regular transport (e.g. XPC, JSON).
62 std::unique_ptr<Transport>
63 createPathMappingTransport(std::unique_ptr<Transport> Transp,
64  PathMappings Mappings);
65 
66 } // namespace clangd
67 } // namespace clang
clang::clangd::PathMapping::Direction::ClientToServer
@ ClientToServer
clang::clangd::PathMapping::ServerPath
std::string ServerPath
Definition: PathMapping.h:35
clang::clangd::PathMapping::ClientPath
std::string ClientPath
Definition: PathMapping.h:34
clang::clangd::PathMappings
std::vector< PathMapping > PathMappings
Definition: PathMapping.h:38
M
const google::protobuf::Message & M
Definition: Server.cpp:309
clang::clangd::applyPathMappings
void applyPathMappings(llvm::json::Value &V, PathMapping::Direction Dir, const PathMappings &Mappings)
Applies the Mappings to all the file:// URIs in Params.
Definition: PathMapping.cpp:50
clang::clangd::PathMapping::Direction::ServerToClient
@ ServerToClient
clang::clangd::operator<<
llvm::raw_ostream & operator<<(llvm::raw_ostream &OS, const CodeCompletion &C)
Definition: CodeComplete.cpp:2016
clang::clangd::doPathMapping
llvm::Optional< std::string > doPathMapping(llvm::StringRef S, PathMapping::Direction Dir, const PathMappings &Mappings)
Returns a modified S with the first matching path in Mappings substituted, if applicable.
Definition: PathMapping.cpp:22
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
OS
llvm::raw_string_ostream OS
Definition: TraceTests.cpp:163
clang::clangd::parsePathMappings
llvm::Expected< PathMappings > parsePathMappings(llvm::StringRef RawPathMappings)
Parse the command line RawPathMappings (e.g.
Definition: PathMapping.cpp:170
clang::clangd::createPathMappingTransport
std::unique_ptr< Transport > createPathMappingTransport(std::unique_ptr< Transport > Transp, PathMappings Mappings)
Creates a wrapping transport over Transp that applies the Mappings to all inbound and outbound LSP me...
Definition: PathMapping.cpp:191
clang::clangd::PathMapping
PathMappings are a collection of paired client and server paths.
Definition: PathMapping.h:33
Value
static constexpr bool Value
Definition: SuspiciousCallArgumentCheck.cpp:72
clang::clangd::PathMapping::Direction
Direction
Definition: PathMapping.h:36