Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 1 | //===--- ClangdLSPServer.cpp - LSP server ------------------------*- C++-*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
Kirill Bobyrev | 8e35f1e | 2018-08-14 16:03:32 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 9 | |
| 10 | #include "ClangdLSPServer.h" |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 11 | #include "Diagnostics.h" |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 12 | #include "JSONRPCDispatcher.h" |
Sam McCall | b536a2a | 2017-12-19 12:23:48 +0000 | [diff] [blame] | 13 | #include "SourceCode.h" |
Eric Liu | 78ed91a7 | 2018-01-29 15:37:46 +0000 | [diff] [blame] | 14 | #include "URI.h" |
Kadir Cetinkaya | 689bf93 | 2018-08-24 13:09:41 +0000 | [diff] [blame] | 15 | #include "llvm/ADT/ScopeExit.h" |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 16 | #include "llvm/Support/Errc.h" |
Marc-Andre Laperle | e7ec16a | 2017-11-03 13:39:15 +0000 | [diff] [blame] | 17 | #include "llvm/Support/FormatVariadic.h" |
Eric Liu | 5740ff5 | 2018-01-31 16:26:27 +0000 | [diff] [blame] | 18 | #include "llvm/Support/Path.h" |
Marc-Andre Laperle | e7ec16a | 2017-11-03 13:39:15 +0000 | [diff] [blame] | 19 | |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 20 | using namespace clang::clangd; |
| 21 | using namespace clang; |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 22 | using namespace llvm; |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 23 | |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 24 | namespace { |
| 25 | |
Eric Liu | 5740ff5 | 2018-01-31 16:26:27 +0000 | [diff] [blame] | 26 | /// \brief Supports a test URI scheme with relaxed constraints for lit tests. |
| 27 | /// The path in a test URI will be combined with a platform-specific fake |
| 28 | /// directory to form an absolute path. For example, test:///a.cpp is resolved |
| 29 | /// C:\clangd-test\a.cpp on Windows and /clangd-test/a.cpp on Unix. |
| 30 | class TestScheme : public URIScheme { |
| 31 | public: |
| 32 | llvm::Expected<std::string> |
| 33 | getAbsolutePath(llvm::StringRef /*Authority*/, llvm::StringRef Body, |
| 34 | llvm::StringRef /*HintPath*/) const override { |
| 35 | using namespace llvm::sys; |
| 36 | // Still require "/" in body to mimic file scheme, as we want lengths of an |
| 37 | // equivalent URI in both schemes to be the same. |
| 38 | if (!Body.startswith("/")) |
| 39 | return llvm::make_error<llvm::StringError>( |
| 40 | "Expect URI body to be an absolute path starting with '/': " + Body, |
| 41 | llvm::inconvertibleErrorCode()); |
| 42 | Body = Body.ltrim('/'); |
Nico Weber | 0da2290 | 2018-04-10 13:14:03 +0000 | [diff] [blame] | 43 | #ifdef _WIN32 |
Eric Liu | 5740ff5 | 2018-01-31 16:26:27 +0000 | [diff] [blame] | 44 | constexpr char TestDir[] = "C:\\clangd-test"; |
| 45 | #else |
| 46 | constexpr char TestDir[] = "/clangd-test"; |
| 47 | #endif |
| 48 | llvm::SmallVector<char, 16> Path(Body.begin(), Body.end()); |
| 49 | path::native(Path); |
| 50 | auto Err = fs::make_absolute(TestDir, Path); |
Eric Liu | cda2526 | 2018-02-01 12:44:52 +0000 | [diff] [blame] | 51 | if (Err) |
| 52 | llvm_unreachable("Failed to make absolute path in test scheme."); |
Eric Liu | 5740ff5 | 2018-01-31 16:26:27 +0000 | [diff] [blame] | 53 | return std::string(Path.begin(), Path.end()); |
| 54 | } |
| 55 | |
| 56 | llvm::Expected<URI> |
| 57 | uriFromAbsolutePath(llvm::StringRef AbsolutePath) const override { |
| 58 | llvm_unreachable("Clangd must never create a test URI."); |
| 59 | } |
| 60 | }; |
| 61 | |
| 62 | static URISchemeRegistry::Add<TestScheme> |
| 63 | X("test", "Test scheme for clangd lit tests."); |
| 64 | |
Marc-Andre Laperle | b387b6e | 2018-04-23 20:00:52 +0000 | [diff] [blame] | 65 | SymbolKindBitset defaultSymbolKinds() { |
| 66 | SymbolKindBitset Defaults; |
| 67 | for (size_t I = SymbolKindMin; I <= static_cast<size_t>(SymbolKind::Array); |
| 68 | ++I) |
| 69 | Defaults.set(I); |
| 70 | return Defaults; |
| 71 | } |
| 72 | |
Kadir Cetinkaya | 133d46f | 2018-09-27 17:13:07 +0000 | [diff] [blame] | 73 | CompletionItemKindBitset defaultCompletionItemKinds() { |
| 74 | CompletionItemKindBitset Defaults; |
| 75 | for (size_t I = CompletionItemKindMin; |
| 76 | I <= static_cast<size_t>(CompletionItemKind::Reference); ++I) |
| 77 | Defaults.set(I); |
| 78 | return Defaults; |
| 79 | } |
| 80 | |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 81 | } // namespace |
| 82 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 83 | void ClangdLSPServer::onInitialize(InitializeParams &Params) { |
Simon Marchi | abeed66 | 2018-10-16 15:55:03 +0000 | [diff] [blame^] | 84 | if (Params.initializationOptions) { |
| 85 | const ClangdInitializationOptions &Opts = *Params.initializationOptions; |
| 86 | |
| 87 | // Explicit compilation database path. |
| 88 | if (Opts.compilationDatabasePath.hasValue()) { |
| 89 | CDB.setCompileCommandsDir(Opts.compilationDatabasePath.getValue()); |
| 90 | } |
| 91 | |
| 92 | applyConfiguration(Opts.ParamsChange); |
| 93 | } |
Simon Marchi | 8801678 | 2018-08-01 11:28:49 +0000 | [diff] [blame] | 94 | |
Ilya Biryukov | 7d60d20 | 2018-02-16 12:20:47 +0000 | [diff] [blame] | 95 | if (Params.rootUri && *Params.rootUri) |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 96 | Server->setRootPath(Params.rootUri->file()); |
Ilya Biryukov | 23bc73b | 2018-02-15 14:32:57 +0000 | [diff] [blame] | 97 | else if (Params.rootPath && !Params.rootPath->empty()) |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 98 | Server->setRootPath(*Params.rootPath); |
Ilya Biryukov | 23bc73b | 2018-02-15 14:32:57 +0000 | [diff] [blame] | 99 | |
| 100 | CCOpts.EnableSnippets = |
| 101 | Params.capabilities.textDocument.completion.completionItem.snippetSupport; |
Alex Lorenz | 8626d36 | 2018-08-10 17:25:07 +0000 | [diff] [blame] | 102 | DiagOpts.EmbedFixesInDiagnostics = |
| 103 | Params.capabilities.textDocument.publishDiagnostics.clangdFixSupport; |
Alex Lorenz | 0ce8a7a | 2018-08-22 20:30:06 +0000 | [diff] [blame] | 104 | DiagOpts.SendDiagnosticCategory = |
| 105 | Params.capabilities.textDocument.publishDiagnostics.categorySupport; |
Ilya Biryukov | 23bc73b | 2018-02-15 14:32:57 +0000 | [diff] [blame] | 106 | |
Marc-Andre Laperle | b387b6e | 2018-04-23 20:00:52 +0000 | [diff] [blame] | 107 | if (Params.capabilities.workspace && Params.capabilities.workspace->symbol && |
Kadir Cetinkaya | 133d46f | 2018-09-27 17:13:07 +0000 | [diff] [blame] | 108 | Params.capabilities.workspace->symbol->symbolKind && |
| 109 | Params.capabilities.workspace->symbol->symbolKind->valueSet) { |
Marc-Andre Laperle | b387b6e | 2018-04-23 20:00:52 +0000 | [diff] [blame] | 110 | for (SymbolKind Kind : |
| 111 | *Params.capabilities.workspace->symbol->symbolKind->valueSet) { |
| 112 | SupportedSymbolKinds.set(static_cast<size_t>(Kind)); |
| 113 | } |
| 114 | } |
| 115 | |
Kadir Cetinkaya | 133d46f | 2018-09-27 17:13:07 +0000 | [diff] [blame] | 116 | if (Params.capabilities.textDocument.completion.completionItemKind && |
| 117 | Params.capabilities.textDocument.completion.completionItemKind->valueSet) |
| 118 | for (CompletionItemKind Kind : *Params.capabilities.textDocument.completion |
| 119 | .completionItemKind->valueSet) |
| 120 | SupportedCompletionItemKinds.set(static_cast<size_t>(Kind)); |
| 121 | |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 122 | reply(json::Object{ |
Sam McCall | 0930ab0 | 2017-11-07 15:49:35 +0000 | [diff] [blame] | 123 | {{"capabilities", |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 124 | json::Object{ |
Simon Marchi | 9808262 | 2018-03-26 14:41:40 +0000 | [diff] [blame] | 125 | {"textDocumentSync", (int)TextDocumentSyncKind::Incremental}, |
Sam McCall | 0930ab0 | 2017-11-07 15:49:35 +0000 | [diff] [blame] | 126 | {"documentFormattingProvider", true}, |
| 127 | {"documentRangeFormattingProvider", true}, |
| 128 | {"documentOnTypeFormattingProvider", |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 129 | json::Object{ |
Sam McCall | 0930ab0 | 2017-11-07 15:49:35 +0000 | [diff] [blame] | 130 | {"firstTriggerCharacter", "}"}, |
| 131 | {"moreTriggerCharacter", {}}, |
| 132 | }}, |
| 133 | {"codeActionProvider", true}, |
| 134 | {"completionProvider", |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 135 | json::Object{ |
Sam McCall | 0930ab0 | 2017-11-07 15:49:35 +0000 | [diff] [blame] | 136 | {"resolveProvider", false}, |
| 137 | {"triggerCharacters", {".", ">", ":"}}, |
| 138 | }}, |
| 139 | {"signatureHelpProvider", |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 140 | json::Object{ |
Sam McCall | 0930ab0 | 2017-11-07 15:49:35 +0000 | [diff] [blame] | 141 | {"triggerCharacters", {"(", ","}}, |
| 142 | }}, |
| 143 | {"definitionProvider", true}, |
Ilya Biryukov | 0e6a51f | 2017-12-12 12:27:47 +0000 | [diff] [blame] | 144 | {"documentHighlightProvider", true}, |
Marc-Andre Laperle | 3e618ed | 2018-02-16 21:38:15 +0000 | [diff] [blame] | 145 | {"hoverProvider", true}, |
Haojian Wu | 345099c | 2017-11-09 11:30:04 +0000 | [diff] [blame] | 146 | {"renameProvider", true}, |
Marc-Andre Laperle | 1be6970 | 2018-07-05 19:35:01 +0000 | [diff] [blame] | 147 | {"documentSymbolProvider", true}, |
Marc-Andre Laperle | b387b6e | 2018-04-23 20:00:52 +0000 | [diff] [blame] | 148 | {"workspaceSymbolProvider", true}, |
Sam McCall | 1ad142f | 2018-09-05 11:53:07 +0000 | [diff] [blame] | 149 | {"referencesProvider", true}, |
Sam McCall | 0930ab0 | 2017-11-07 15:49:35 +0000 | [diff] [blame] | 150 | {"executeCommandProvider", |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 151 | json::Object{ |
Eric Liu | 2c19053 | 2018-05-15 15:23:53 +0000 | [diff] [blame] | 152 | {"commands", {ExecuteCommandParams::CLANGD_APPLY_FIX_COMMAND}}, |
Sam McCall | 0930ab0 | 2017-11-07 15:49:35 +0000 | [diff] [blame] | 153 | }}, |
| 154 | }}}}); |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 155 | } |
| 156 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 157 | void ClangdLSPServer::onShutdown(ShutdownParams &Params) { |
Ilya Biryukov | 0d9b8a3 | 2017-10-25 08:45:41 +0000 | [diff] [blame] | 158 | // Do essentially nothing, just say we're ready to exit. |
| 159 | ShutdownRequestReceived = true; |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 160 | reply(nullptr); |
Sam McCall | 8a5dded | 2017-10-12 13:29:58 +0000 | [diff] [blame] | 161 | } |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 162 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 163 | void ClangdLSPServer::onExit(ExitParams &Params) { IsDone = true; } |
Ilya Biryukov | 0d9b8a3 | 2017-10-25 08:45:41 +0000 | [diff] [blame] | 164 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 165 | void ClangdLSPServer::onDocumentDidOpen(DidOpenTextDocumentParams &Params) { |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 166 | PathRef File = Params.textDocument.uri.file(); |
Alex Lorenz | f808786 | 2018-08-01 17:39:29 +0000 | [diff] [blame] | 167 | if (Params.metadata && !Params.metadata->extraFlags.empty()) |
| 168 | CDB.setExtraFlagsForFile(File, std::move(Params.metadata->extraFlags)); |
Ilya Biryukov | b10ef47 | 2018-06-13 09:20:41 +0000 | [diff] [blame] | 169 | |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 170 | std::string &Contents = Params.textDocument.text; |
| 171 | |
Simon Marchi | 9808262 | 2018-03-26 14:41:40 +0000 | [diff] [blame] | 172 | DraftMgr.addDraft(File, Contents); |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 173 | Server->addDocument(File, Contents, WantDiagnostics::Yes); |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 174 | } |
| 175 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 176 | void ClangdLSPServer::onDocumentDidChange(DidChangeTextDocumentParams &Params) { |
Eric Liu | 51fed18 | 2018-02-22 18:40:39 +0000 | [diff] [blame] | 177 | auto WantDiags = WantDiagnostics::Auto; |
| 178 | if (Params.wantDiagnostics.hasValue()) |
| 179 | WantDiags = Params.wantDiagnostics.getValue() ? WantDiagnostics::Yes |
| 180 | : WantDiagnostics::No; |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 181 | |
| 182 | PathRef File = Params.textDocument.uri.file(); |
Simon Marchi | 9808262 | 2018-03-26 14:41:40 +0000 | [diff] [blame] | 183 | llvm::Expected<std::string> Contents = |
| 184 | DraftMgr.updateDraft(File, Params.contentChanges); |
| 185 | if (!Contents) { |
| 186 | // If this fails, we are most likely going to be not in sync anymore with |
| 187 | // the client. It is better to remove the draft and let further operations |
| 188 | // fail rather than giving wrong results. |
| 189 | DraftMgr.removeDraft(File); |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 190 | Server->removeDocument(File); |
Ilya Biryukov | b10ef47 | 2018-06-13 09:20:41 +0000 | [diff] [blame] | 191 | CDB.invalidate(File); |
Sam McCall | bed5885 | 2018-07-11 10:35:11 +0000 | [diff] [blame] | 192 | elog("Failed to update {0}: {1}", File, Contents.takeError()); |
Simon Marchi | 9808262 | 2018-03-26 14:41:40 +0000 | [diff] [blame] | 193 | return; |
| 194 | } |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 195 | |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 196 | Server->addDocument(File, *Contents, WantDiags); |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 197 | } |
| 198 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 199 | void ClangdLSPServer::onFileEvent(DidChangeWatchedFilesParams &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 200 | Server->onFileEvent(Params); |
Marc-Andre Laperle | bf11424 | 2017-10-02 18:00:37 +0000 | [diff] [blame] | 201 | } |
| 202 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 203 | void ClangdLSPServer::onCommand(ExecuteCommandParams &Params) { |
Eric Liu | c5105f9 | 2018-02-16 14:15:55 +0000 | [diff] [blame] | 204 | auto ApplyEdit = [](WorkspaceEdit WE) { |
| 205 | ApplyWorkspaceEditParams Edit; |
| 206 | Edit.edit = std::move(WE); |
| 207 | // We don't need the response so id == 1 is OK. |
| 208 | // Ideally, we would wait for the response and if there is no error, we |
| 209 | // would reply success/failure to the original RPC. |
| 210 | call("workspace/applyEdit", Edit); |
| 211 | }; |
Marc-Andre Laperle | e7ec16a | 2017-11-03 13:39:15 +0000 | [diff] [blame] | 212 | if (Params.command == ExecuteCommandParams::CLANGD_APPLY_FIX_COMMAND && |
| 213 | Params.workspaceEdit) { |
| 214 | // The flow for "apply-fix" : |
| 215 | // 1. We publish a diagnostic, including fixits |
| 216 | // 2. The user clicks on the diagnostic, the editor asks us for code actions |
| 217 | // 3. We send code actions, with the fixit embedded as context |
| 218 | // 4. The user selects the fixit, the editor asks us to apply it |
| 219 | // 5. We unwrap the changes and send them back to the editor |
| 220 | // 6. The editor applies the changes (applyEdit), and sends us a reply (but |
| 221 | // we ignore it) |
| 222 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 223 | reply("Fix applied."); |
Eric Liu | c5105f9 | 2018-02-16 14:15:55 +0000 | [diff] [blame] | 224 | ApplyEdit(*Params.workspaceEdit); |
Marc-Andre Laperle | e7ec16a | 2017-11-03 13:39:15 +0000 | [diff] [blame] | 225 | } else { |
| 226 | // We should not get here because ExecuteCommandParams would not have |
| 227 | // parsed in the first place and this handler should not be called. But if |
| 228 | // more commands are added, this will be here has a safe guard. |
Ilya Biryukov | 940901e | 2017-12-13 12:51:22 +0000 | [diff] [blame] | 229 | replyError( |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 230 | ErrorCode::InvalidParams, |
Haojian Wu | 2375c92 | 2017-11-07 10:21:02 +0000 | [diff] [blame] | 231 | llvm::formatv("Unsupported command \"{0}\".", Params.command).str()); |
Marc-Andre Laperle | e7ec16a | 2017-11-03 13:39:15 +0000 | [diff] [blame] | 232 | } |
| 233 | } |
| 234 | |
Marc-Andre Laperle | b387b6e | 2018-04-23 20:00:52 +0000 | [diff] [blame] | 235 | void ClangdLSPServer::onWorkspaceSymbol(WorkspaceSymbolParams &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 236 | Server->workspaceSymbols( |
Marc-Andre Laperle | b387b6e | 2018-04-23 20:00:52 +0000 | [diff] [blame] | 237 | Params.query, CCOpts.Limit, |
| 238 | [this](llvm::Expected<std::vector<SymbolInformation>> Items) { |
| 239 | if (!Items) |
| 240 | return replyError(ErrorCode::InternalError, |
| 241 | llvm::toString(Items.takeError())); |
| 242 | for (auto &Sym : *Items) |
| 243 | Sym.kind = adjustKindToCapability(Sym.kind, SupportedSymbolKinds); |
| 244 | |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 245 | reply(json::Array(*Items)); |
Marc-Andre Laperle | b387b6e | 2018-04-23 20:00:52 +0000 | [diff] [blame] | 246 | }); |
| 247 | } |
| 248 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 249 | void ClangdLSPServer::onRename(RenameParams &Params) { |
Ilya Biryukov | 7d60d20 | 2018-02-16 12:20:47 +0000 | [diff] [blame] | 250 | Path File = Params.textDocument.uri.file(); |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 251 | llvm::Optional<std::string> Code = DraftMgr.getDraft(File); |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 252 | if (!Code) |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 253 | return replyError(ErrorCode::InvalidParams, |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 254 | "onRename called for non-added file"); |
| 255 | |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 256 | Server->rename( |
Ilya Biryukov | 2c5e8e8 | 2018-02-15 13:15:47 +0000 | [diff] [blame] | 257 | File, Params.position, Params.newName, |
| 258 | [File, Code, |
| 259 | Params](llvm::Expected<std::vector<tooling::Replacement>> Replacements) { |
| 260 | if (!Replacements) |
| 261 | return replyError(ErrorCode::InternalError, |
| 262 | llvm::toString(Replacements.takeError())); |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 263 | |
Eric Liu | 9133ecd | 2018-05-11 12:12:08 +0000 | [diff] [blame] | 264 | // Turn the replacements into the format specified by the Language |
| 265 | // Server Protocol. Fuse them into one big JSON array. |
| 266 | std::vector<TextEdit> Edits; |
| 267 | for (const auto &R : *Replacements) |
| 268 | Edits.push_back(replacementToEdit(*Code, R)); |
Ilya Biryukov | 2c5e8e8 | 2018-02-15 13:15:47 +0000 | [diff] [blame] | 269 | WorkspaceEdit WE; |
| 270 | WE.changes = {{Params.textDocument.uri.uri(), Edits}}; |
| 271 | reply(WE); |
| 272 | }); |
Haojian Wu | 345099c | 2017-11-09 11:30:04 +0000 | [diff] [blame] | 273 | } |
| 274 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 275 | void ClangdLSPServer::onDocumentDidClose(DidCloseTextDocumentParams &Params) { |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 276 | PathRef File = Params.textDocument.uri.file(); |
| 277 | DraftMgr.removeDraft(File); |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 278 | Server->removeDocument(File); |
Alex Lorenz | f808786 | 2018-08-01 17:39:29 +0000 | [diff] [blame] | 279 | CDB.invalidate(File); |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 280 | } |
| 281 | |
Sam McCall | 4db732a | 2017-09-30 10:08:52 +0000 | [diff] [blame] | 282 | void ClangdLSPServer::onDocumentOnTypeFormatting( |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 283 | DocumentOnTypeFormattingParams &Params) { |
Ilya Biryukov | 7d60d20 | 2018-02-16 12:20:47 +0000 | [diff] [blame] | 284 | auto File = Params.textDocument.uri.file(); |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 285 | auto Code = DraftMgr.getDraft(File); |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 286 | if (!Code) |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 287 | return replyError(ErrorCode::InvalidParams, |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 288 | "onDocumentOnTypeFormatting called for non-added file"); |
| 289 | |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 290 | auto ReplacementsOrError = Server->formatOnType(*Code, File, Params.position); |
Raoul Wols | 212bcf8 | 2017-12-12 20:25:06 +0000 | [diff] [blame] | 291 | if (ReplacementsOrError) |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 292 | reply(json::Array(replacementsToEdits(*Code, ReplacementsOrError.get()))); |
Raoul Wols | 212bcf8 | 2017-12-12 20:25:06 +0000 | [diff] [blame] | 293 | else |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 294 | replyError(ErrorCode::UnknownErrorCode, |
Ilya Biryukov | 940901e | 2017-12-13 12:51:22 +0000 | [diff] [blame] | 295 | llvm::toString(ReplacementsOrError.takeError())); |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 296 | } |
| 297 | |
Sam McCall | 4db732a | 2017-09-30 10:08:52 +0000 | [diff] [blame] | 298 | void ClangdLSPServer::onDocumentRangeFormatting( |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 299 | DocumentRangeFormattingParams &Params) { |
Ilya Biryukov | 7d60d20 | 2018-02-16 12:20:47 +0000 | [diff] [blame] | 300 | auto File = Params.textDocument.uri.file(); |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 301 | auto Code = DraftMgr.getDraft(File); |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 302 | if (!Code) |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 303 | return replyError(ErrorCode::InvalidParams, |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 304 | "onDocumentRangeFormatting called for non-added file"); |
| 305 | |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 306 | auto ReplacementsOrError = Server->formatRange(*Code, File, Params.range); |
Raoul Wols | 212bcf8 | 2017-12-12 20:25:06 +0000 | [diff] [blame] | 307 | if (ReplacementsOrError) |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 308 | reply(json::Array(replacementsToEdits(*Code, ReplacementsOrError.get()))); |
Raoul Wols | 212bcf8 | 2017-12-12 20:25:06 +0000 | [diff] [blame] | 309 | else |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 310 | replyError(ErrorCode::UnknownErrorCode, |
Ilya Biryukov | 940901e | 2017-12-13 12:51:22 +0000 | [diff] [blame] | 311 | llvm::toString(ReplacementsOrError.takeError())); |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 312 | } |
| 313 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 314 | void ClangdLSPServer::onDocumentFormatting(DocumentFormattingParams &Params) { |
Ilya Biryukov | 7d60d20 | 2018-02-16 12:20:47 +0000 | [diff] [blame] | 315 | auto File = Params.textDocument.uri.file(); |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 316 | auto Code = DraftMgr.getDraft(File); |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 317 | if (!Code) |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 318 | return replyError(ErrorCode::InvalidParams, |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 319 | "onDocumentFormatting called for non-added file"); |
| 320 | |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 321 | auto ReplacementsOrError = Server->formatFile(*Code, File); |
Raoul Wols | 212bcf8 | 2017-12-12 20:25:06 +0000 | [diff] [blame] | 322 | if (ReplacementsOrError) |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 323 | reply(json::Array(replacementsToEdits(*Code, ReplacementsOrError.get()))); |
Raoul Wols | 212bcf8 | 2017-12-12 20:25:06 +0000 | [diff] [blame] | 324 | else |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 325 | replyError(ErrorCode::UnknownErrorCode, |
Ilya Biryukov | 940901e | 2017-12-13 12:51:22 +0000 | [diff] [blame] | 326 | llvm::toString(ReplacementsOrError.takeError())); |
Sam McCall | 4db732a | 2017-09-30 10:08:52 +0000 | [diff] [blame] | 327 | } |
| 328 | |
Marc-Andre Laperle | 1be6970 | 2018-07-05 19:35:01 +0000 | [diff] [blame] | 329 | void ClangdLSPServer::onDocumentSymbol(DocumentSymbolParams &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 330 | Server->documentSymbols( |
Marc-Andre Laperle | 1be6970 | 2018-07-05 19:35:01 +0000 | [diff] [blame] | 331 | Params.textDocument.uri.file(), |
| 332 | [this](llvm::Expected<std::vector<SymbolInformation>> Items) { |
| 333 | if (!Items) |
| 334 | return replyError(ErrorCode::InvalidParams, |
| 335 | llvm::toString(Items.takeError())); |
| 336 | for (auto &Sym : *Items) |
| 337 | Sym.kind = adjustKindToCapability(Sym.kind, SupportedSymbolKinds); |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 338 | reply(json::Array(*Items)); |
Marc-Andre Laperle | 1be6970 | 2018-07-05 19:35:01 +0000 | [diff] [blame] | 339 | }); |
| 340 | } |
| 341 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 342 | void ClangdLSPServer::onCodeAction(CodeActionParams &Params) { |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 343 | // We provide a code action for each diagnostic at the requested location |
| 344 | // which has FixIts available. |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 345 | auto Code = DraftMgr.getDraft(Params.textDocument.uri.file()); |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 346 | if (!Code) |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 347 | return replyError(ErrorCode::InvalidParams, |
Ilya Biryukov | 261c72e | 2018-01-17 12:30:24 +0000 | [diff] [blame] | 348 | "onCodeAction called for non-added file"); |
| 349 | |
Sam McCall | cbf497f | 2018-10-12 16:51:48 +0000 | [diff] [blame] | 350 | std::vector<Command> Commands; |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 351 | for (Diagnostic &D : Params.context.diagnostics) { |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 352 | for (auto &F : getFixes(Params.textDocument.uri.file(), D)) { |
Sam McCall | dd0566b | 2017-11-06 15:40:30 +0000 | [diff] [blame] | 353 | WorkspaceEdit WE; |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 354 | std::vector<TextEdit> Edits(F.Edits.begin(), F.Edits.end()); |
Sam McCall | cbf497f | 2018-10-12 16:51:48 +0000 | [diff] [blame] | 355 | Commands.emplace_back(); |
| 356 | Commands.back().title = llvm::formatv("Apply fix: {0}", F.Message); |
| 357 | Commands.back().command = ExecuteCommandParams::CLANGD_APPLY_FIX_COMMAND; |
| 358 | Commands.back().workspaceEdit.emplace(); |
| 359 | Commands.back().workspaceEdit->changes = { |
| 360 | {Params.textDocument.uri.uri(), std::move(Edits)}, |
| 361 | }; |
Sam McCall | dd0566b | 2017-11-06 15:40:30 +0000 | [diff] [blame] | 362 | } |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 363 | } |
Sam McCall | cbf497f | 2018-10-12 16:51:48 +0000 | [diff] [blame] | 364 | reply(json::Array(Commands)); |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 365 | } |
| 366 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 367 | void ClangdLSPServer::onCompletion(TextDocumentPositionParams &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 368 | Server->codeComplete(Params.textDocument.uri.file(), Params.position, CCOpts, |
| 369 | [this](llvm::Expected<CodeCompleteResult> List) { |
| 370 | if (!List) |
| 371 | return replyError(List.takeError()); |
| 372 | CompletionList LSPList; |
| 373 | LSPList.isIncomplete = List->HasMore; |
Kadir Cetinkaya | 133d46f | 2018-09-27 17:13:07 +0000 | [diff] [blame] | 374 | for (const auto &R : List->Completions) { |
| 375 | CompletionItem C = R.render(CCOpts); |
| 376 | C.kind = adjustKindToCapability( |
| 377 | C.kind, SupportedCompletionItemKinds); |
| 378 | LSPList.items.push_back(std::move(C)); |
| 379 | } |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 380 | return reply(std::move(LSPList)); |
Ilya Biryukov | 2c5e8e8 | 2018-02-15 13:15:47 +0000 | [diff] [blame] | 381 | }); |
Ilya Biryukov | d9bdfe0 | 2017-10-06 11:54:17 +0000 | [diff] [blame] | 382 | } |
| 383 | |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 384 | void ClangdLSPServer::onSignatureHelp(TextDocumentPositionParams &Params) { |
| 385 | Server->signatureHelp(Params.textDocument.uri.file(), Params.position, |
| 386 | [](llvm::Expected<SignatureHelp> SignatureHelp) { |
| 387 | if (!SignatureHelp) |
| 388 | return replyError( |
| 389 | ErrorCode::InvalidParams, |
| 390 | llvm::toString(SignatureHelp.takeError())); |
| 391 | reply(*SignatureHelp); |
| 392 | }); |
| 393 | } |
| 394 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 395 | void ClangdLSPServer::onGoToDefinition(TextDocumentPositionParams &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 396 | Server->findDefinitions(Params.textDocument.uri.file(), Params.position, |
| 397 | [](llvm::Expected<std::vector<Location>> Items) { |
| 398 | if (!Items) |
| 399 | return replyError( |
| 400 | ErrorCode::InvalidParams, |
| 401 | llvm::toString(Items.takeError())); |
| 402 | reply(json::Array(*Items)); |
| 403 | }); |
Marc-Andre Laperle | 2cbf037 | 2017-06-28 16:12:10 +0000 | [diff] [blame] | 404 | } |
| 405 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 406 | void ClangdLSPServer::onSwitchSourceHeader(TextDocumentIdentifier &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 407 | llvm::Optional<Path> Result = Server->switchSourceHeader(Params.uri.file()); |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 408 | reply(Result ? URI::createFile(*Result).toString() : ""); |
Marc-Andre Laperle | 6571b3e | 2017-09-28 03:14:40 +0000 | [diff] [blame] | 409 | } |
| 410 | |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 411 | void ClangdLSPServer::onDocumentHighlight(TextDocumentPositionParams &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 412 | Server->findDocumentHighlights( |
Ilya Biryukov | 7d60d20 | 2018-02-16 12:20:47 +0000 | [diff] [blame] | 413 | Params.textDocument.uri.file(), Params.position, |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame] | 414 | [](llvm::Expected<std::vector<DocumentHighlight>> Highlights) { |
Ilya Biryukov | 2c5e8e8 | 2018-02-15 13:15:47 +0000 | [diff] [blame] | 415 | if (!Highlights) |
| 416 | return replyError(ErrorCode::InternalError, |
| 417 | llvm::toString(Highlights.takeError())); |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 418 | reply(json::Array(*Highlights)); |
Ilya Biryukov | 2c5e8e8 | 2018-02-15 13:15:47 +0000 | [diff] [blame] | 419 | }); |
Ilya Biryukov | 0e6a51f | 2017-12-12 12:27:47 +0000 | [diff] [blame] | 420 | } |
| 421 | |
Marc-Andre Laperle | 3e618ed | 2018-02-16 21:38:15 +0000 | [diff] [blame] | 422 | void ClangdLSPServer::onHover(TextDocumentPositionParams &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 423 | Server->findHover(Params.textDocument.uri.file(), Params.position, |
| 424 | [](llvm::Expected<llvm::Optional<Hover>> H) { |
| 425 | if (!H) { |
| 426 | replyError(ErrorCode::InternalError, |
| 427 | llvm::toString(H.takeError())); |
| 428 | return; |
| 429 | } |
Marc-Andre Laperle | 3e618ed | 2018-02-16 21:38:15 +0000 | [diff] [blame] | 430 | |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 431 | reply(*H); |
| 432 | }); |
Marc-Andre Laperle | 3e618ed | 2018-02-16 21:38:15 +0000 | [diff] [blame] | 433 | } |
| 434 | |
Simon Marchi | 8801678 | 2018-08-01 11:28:49 +0000 | [diff] [blame] | 435 | void ClangdLSPServer::applyConfiguration( |
Simon Marchi | abeed66 | 2018-10-16 15:55:03 +0000 | [diff] [blame^] | 436 | const ClangdConfigurationParamsChange &Params) { |
| 437 | // Per-file update to the compilation database. |
| 438 | if (Params.compilationDatabaseChanges) { |
| 439 | const auto &CompileCommandUpdates = *Params.compilationDatabaseChanges; |
Alex Lorenz | f808786 | 2018-08-01 17:39:29 +0000 | [diff] [blame] | 440 | bool ShouldReparseOpenFiles = false; |
| 441 | for (auto &Entry : CompileCommandUpdates) { |
| 442 | /// The opened files need to be reparsed only when some existing |
| 443 | /// entries are changed. |
| 444 | PathRef File = Entry.first; |
| 445 | if (!CDB.setCompilationCommandForFile( |
| 446 | File, tooling::CompileCommand( |
| 447 | std::move(Entry.second.workingDirectory), File, |
| 448 | std::move(Entry.second.compilationCommand), |
| 449 | /*Output=*/""))) |
| 450 | ShouldReparseOpenFiles = true; |
| 451 | } |
| 452 | if (ShouldReparseOpenFiles) |
| 453 | reparseOpenedFiles(); |
| 454 | } |
Simon Marchi | 5178f92 | 2018-02-22 14:00:39 +0000 | [diff] [blame] | 455 | } |
| 456 | |
Simon Marchi | 8801678 | 2018-08-01 11:28:49 +0000 | [diff] [blame] | 457 | // FIXME: This function needs to be properly tested. |
| 458 | void ClangdLSPServer::onChangeConfiguration( |
| 459 | DidChangeConfigurationParams &Params) { |
| 460 | applyConfiguration(Params.settings); |
| 461 | } |
| 462 | |
Sam McCall | 1ad142f | 2018-09-05 11:53:07 +0000 | [diff] [blame] | 463 | void ClangdLSPServer::onReference(ReferenceParams &Params) { |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 464 | Server->findReferences(Params.textDocument.uri.file(), Params.position, |
| 465 | [](llvm::Expected<std::vector<Location>> Locations) { |
| 466 | if (!Locations) |
| 467 | return replyError( |
| 468 | ErrorCode::InternalError, |
| 469 | llvm::toString(Locations.takeError())); |
| 470 | reply(llvm::json::Array(*Locations)); |
| 471 | }); |
Sam McCall | 1ad142f | 2018-09-05 11:53:07 +0000 | [diff] [blame] | 472 | } |
| 473 | |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 474 | ClangdLSPServer::ClangdLSPServer(JSONOutput &Out, |
Sam McCall | adccab6 | 2017-11-23 16:58:22 +0000 | [diff] [blame] | 475 | const clangd::CodeCompleteOptions &CCOpts, |
Eric Liu | bfac8f7 | 2017-12-19 18:00:37 +0000 | [diff] [blame] | 476 | llvm::Optional<Path> CompileCommandsDir, |
Alex Lorenz | f808786 | 2018-08-01 17:39:29 +0000 | [diff] [blame] | 477 | bool ShouldUseInMemoryCDB, |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 478 | const ClangdServer::Options &Opts) |
Alex Lorenz | f808786 | 2018-08-01 17:39:29 +0000 | [diff] [blame] | 479 | : Out(Out), CDB(ShouldUseInMemoryCDB ? CompilationDB::makeInMemory() |
| 480 | : CompilationDB::makeDirectoryBased( |
| 481 | std::move(CompileCommandsDir))), |
Ilya Biryukov | b10ef47 | 2018-06-13 09:20:41 +0000 | [diff] [blame] | 482 | CCOpts(CCOpts), SupportedSymbolKinds(defaultSymbolKinds()), |
Kadir Cetinkaya | 133d46f | 2018-09-27 17:13:07 +0000 | [diff] [blame] | 483 | SupportedCompletionItemKinds(defaultCompletionItemKinds()), |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 484 | Server(new ClangdServer(CDB.getCDB(), FSProvider, /*DiagConsumer=*/*this, |
| 485 | Opts)) {} |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 486 | |
Sam McCall | 27a07cf | 2018-06-05 09:34:46 +0000 | [diff] [blame] | 487 | bool ClangdLSPServer::run(std::FILE *In, JSONStreamStyle InputStyle) { |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 488 | assert(!IsDone && "Run was called before"); |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 489 | assert(Server); |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 490 | |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 491 | // Set up JSONRPCDispatcher. |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 492 | JSONRPCDispatcher Dispatcher([](const json::Value &Params) { |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 493 | replyError(ErrorCode::MethodNotFound, "method not found"); |
Ilya Biryukov | 940901e | 2017-12-13 12:51:22 +0000 | [diff] [blame] | 494 | }); |
Simon Marchi | 6e8eb9d | 2018-03-07 21:47:25 +0000 | [diff] [blame] | 495 | registerCallbackHandlers(Dispatcher, /*Callbacks=*/*this); |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 496 | |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 497 | // Run the Language Server loop. |
Sam McCall | 5ed599e | 2018-02-06 10:47:30 +0000 | [diff] [blame] | 498 | runLanguageServerLoop(In, Out, InputStyle, Dispatcher, IsDone); |
Ilya Biryukov | afb5554 | 2017-05-16 14:40:30 +0000 | [diff] [blame] | 499 | |
| 500 | // Make sure IsDone is set to true after this method exits to ensure assertion |
| 501 | // at the start of the method fires if it's ever executed again. |
| 502 | IsDone = true; |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 503 | // Destroy ClangdServer to ensure all worker threads finish. |
| 504 | Server.reset(); |
Ilya Biryukov | 0d9b8a3 | 2017-10-25 08:45:41 +0000 | [diff] [blame] | 505 | |
| 506 | return ShutdownRequestReceived; |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 507 | } |
| 508 | |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 509 | std::vector<Fix> ClangdLSPServer::getFixes(StringRef File, |
| 510 | const clangd::Diagnostic &D) { |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 511 | std::lock_guard<std::mutex> Lock(FixItsMutex); |
| 512 | auto DiagToFixItsIter = FixItsMap.find(File); |
| 513 | if (DiagToFixItsIter == FixItsMap.end()) |
| 514 | return {}; |
| 515 | |
| 516 | const auto &DiagToFixItsMap = DiagToFixItsIter->second; |
| 517 | auto FixItsIter = DiagToFixItsMap.find(D); |
| 518 | if (FixItsIter == DiagToFixItsMap.end()) |
| 519 | return {}; |
| 520 | |
| 521 | return FixItsIter->second; |
| 522 | } |
| 523 | |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame] | 524 | void ClangdLSPServer::onDiagnosticsReady(PathRef File, |
| 525 | std::vector<Diag> Diagnostics) { |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 526 | json::Array DiagnosticsJSON; |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 527 | |
| 528 | DiagnosticToReplacementMap LocalFixIts; // Temporary storage |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame] | 529 | for (auto &Diag : Diagnostics) { |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 530 | toLSPDiags(Diag, [&](clangd::Diagnostic Diag, llvm::ArrayRef<Fix> Fixes) { |
Alex Lorenz | 8626d36 | 2018-08-10 17:25:07 +0000 | [diff] [blame] | 531 | json::Object LSPDiag({ |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 532 | {"range", Diag.range}, |
| 533 | {"severity", Diag.severity}, |
| 534 | {"message", Diag.message}, |
| 535 | }); |
Alex Lorenz | 8626d36 | 2018-08-10 17:25:07 +0000 | [diff] [blame] | 536 | // LSP extension: embed the fixes in the diagnostic. |
| 537 | if (DiagOpts.EmbedFixesInDiagnostics && !Fixes.empty()) { |
| 538 | json::Array ClangdFixes; |
| 539 | for (const auto &Fix : Fixes) { |
| 540 | WorkspaceEdit WE; |
| 541 | URIForFile URI{File}; |
| 542 | WE.changes = {{URI.uri(), std::vector<TextEdit>(Fix.Edits.begin(), |
| 543 | Fix.Edits.end())}}; |
| 544 | ClangdFixes.push_back( |
| 545 | json::Object{{"edit", toJSON(WE)}, {"title", Fix.Message}}); |
| 546 | } |
| 547 | LSPDiag["clangd_fixes"] = std::move(ClangdFixes); |
| 548 | } |
Alex Lorenz | 0ce8a7a | 2018-08-22 20:30:06 +0000 | [diff] [blame] | 549 | if (DiagOpts.SendDiagnosticCategory && !Diag.category.empty()) |
Alex Lorenz | 3714643 | 2018-08-14 22:21:40 +0000 | [diff] [blame] | 550 | LSPDiag["category"] = Diag.category; |
Alex Lorenz | 8626d36 | 2018-08-10 17:25:07 +0000 | [diff] [blame] | 551 | DiagnosticsJSON.push_back(std::move(LSPDiag)); |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 552 | |
| 553 | auto &FixItsForDiagnostic = LocalFixIts[Diag]; |
Kirill Bobyrev | 4a5ff88 | 2018-10-07 14:49:41 +0000 | [diff] [blame] | 554 | llvm::copy(Fixes, std::back_inserter(FixItsForDiagnostic)); |
Sam McCall | dd0566b | 2017-11-06 15:40:30 +0000 | [diff] [blame] | 555 | }); |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 556 | } |
| 557 | |
| 558 | // Cache FixIts |
| 559 | { |
| 560 | // FIXME(ibiryukov): should be deleted when documents are removed |
| 561 | std::lock_guard<std::mutex> Lock(FixItsMutex); |
| 562 | FixItsMap[File] = LocalFixIts; |
| 563 | } |
| 564 | |
| 565 | // Publish diagnostics. |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 566 | Out.writeMessage(json::Object{ |
Sam McCall | dd0566b | 2017-11-06 15:40:30 +0000 | [diff] [blame] | 567 | {"jsonrpc", "2.0"}, |
| 568 | {"method", "textDocument/publishDiagnostics"}, |
| 569 | {"params", |
Sam McCall | d20d798 | 2018-07-09 14:25:59 +0000 | [diff] [blame] | 570 | json::Object{ |
Eric Liu | 78ed91a7 | 2018-01-29 15:37:46 +0000 | [diff] [blame] | 571 | {"uri", URIForFile{File}}, |
Sam McCall | dd0566b | 2017-11-06 15:40:30 +0000 | [diff] [blame] | 572 | {"diagnostics", std::move(DiagnosticsJSON)}, |
| 573 | }}, |
| 574 | }); |
Ilya Biryukov | 38d7977 | 2017-05-16 09:38:59 +0000 | [diff] [blame] | 575 | } |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 576 | |
| 577 | void ClangdLSPServer::reparseOpenedFiles() { |
| 578 | for (const Path &FilePath : DraftMgr.getActiveFiles()) |
Ilya Biryukov | 652364b | 2018-09-26 05:48:29 +0000 | [diff] [blame] | 579 | Server->addDocument(FilePath, *DraftMgr.getDraft(FilePath), |
| 580 | WantDiagnostics::Auto); |
Simon Marchi | 9569fd5 | 2018-03-16 14:30:42 +0000 | [diff] [blame] | 581 | } |
Alex Lorenz | f808786 | 2018-08-01 17:39:29 +0000 | [diff] [blame] | 582 | |
| 583 | ClangdLSPServer::CompilationDB ClangdLSPServer::CompilationDB::makeInMemory() { |
| 584 | return CompilationDB(llvm::make_unique<InMemoryCompilationDb>(), nullptr, |
| 585 | /*IsDirectoryBased=*/false); |
| 586 | } |
| 587 | |
| 588 | ClangdLSPServer::CompilationDB |
| 589 | ClangdLSPServer::CompilationDB::makeDirectoryBased( |
| 590 | llvm::Optional<Path> CompileCommandsDir) { |
| 591 | auto CDB = llvm::make_unique<DirectoryBasedGlobalCompilationDatabase>( |
| 592 | std::move(CompileCommandsDir)); |
| 593 | auto CachingCDB = llvm::make_unique<CachingCompilationDb>(*CDB); |
| 594 | return CompilationDB(std::move(CDB), std::move(CachingCDB), |
| 595 | /*IsDirectoryBased=*/true); |
| 596 | } |
| 597 | |
| 598 | void ClangdLSPServer::CompilationDB::invalidate(PathRef File) { |
| 599 | if (!IsDirectoryBased) |
| 600 | static_cast<InMemoryCompilationDb *>(CDB.get())->invalidate(File); |
| 601 | else |
| 602 | CachingCDB->invalidate(File); |
| 603 | } |
| 604 | |
| 605 | bool ClangdLSPServer::CompilationDB::setCompilationCommandForFile( |
| 606 | PathRef File, tooling::CompileCommand CompilationCommand) { |
| 607 | if (IsDirectoryBased) { |
| 608 | elog("Trying to set compile command for {0} while using directory-based " |
| 609 | "compilation database", |
| 610 | File); |
| 611 | return false; |
| 612 | } |
| 613 | return static_cast<InMemoryCompilationDb *>(CDB.get()) |
| 614 | ->setCompilationCommandForFile(File, std::move(CompilationCommand)); |
| 615 | } |
| 616 | |
| 617 | void ClangdLSPServer::CompilationDB::setExtraFlagsForFile( |
| 618 | PathRef File, std::vector<std::string> ExtraFlags) { |
| 619 | if (!IsDirectoryBased) { |
| 620 | elog("Trying to set extra flags for {0} while using in-memory compilation " |
| 621 | "database", |
| 622 | File); |
| 623 | return; |
| 624 | } |
| 625 | static_cast<DirectoryBasedGlobalCompilationDatabase *>(CDB.get()) |
| 626 | ->setExtraFlagsForFile(File, std::move(ExtraFlags)); |
| 627 | CachingCDB->invalidate(File); |
| 628 | } |
| 629 | |
| 630 | void ClangdLSPServer::CompilationDB::setCompileCommandsDir(Path P) { |
| 631 | if (!IsDirectoryBased) { |
| 632 | elog("Trying to set compile commands dir while using in-memory compilation " |
| 633 | "database"); |
| 634 | return; |
| 635 | } |
| 636 | static_cast<DirectoryBasedGlobalCompilationDatabase *>(CDB.get()) |
| 637 | ->setCompileCommandsDir(P); |
| 638 | CachingCDB->clear(); |
| 639 | } |
| 640 | |
| 641 | GlobalCompilationDatabase &ClangdLSPServer::CompilationDB::getCDB() { |
| 642 | if (CachingCDB) |
| 643 | return *CachingCDB; |
| 644 | return *CDB; |
| 645 | } |