16#include "clang/Basic/LLVM.h"
17#include "clang/Index/IndexSymbol.h"
18#include "llvm/ADT/StringExtras.h"
19#include "llvm/ADT/StringRef.h"
20#include "llvm/ADT/StringSwitch.h"
21#include "llvm/Support/ErrorHandling.h"
22#include "llvm/Support/JSON.h"
23#include "llvm/Support/Path.h"
24#include "llvm/Support/raw_ostream.h"
32bool mapOptOrNull(
const llvm::json::Value &Params, llvm::StringLiteral Prop,
33 T &
Out, llvm::json::Path P) {
34 auto *O = Params.getAsObject();
36 auto *V = O->get(Prop);
38 if (!V || V->getAsNull())
47 llvm::StringRef TUPath) {
48 assert(llvm::sys::path::is_absolute(AbsPath) &&
"the path is relative");
51 elog(
"URIForFile: failed to resolve path {0} with TU path {1}: "
52 "{2}.\nUsing unresolved path.",
53 AbsPath, TUPath, Resolved.takeError());
60 llvm::StringRef HintPath) {
63 return Resolved.takeError();
68 if (
auto S =
E.getAsString()) {
71 consumeError(Parsed.takeError());
72 P.report(
"failed to parse URI");
75 if (Parsed->scheme() !=
"file" && Parsed->scheme() !=
"test") {
76 P.report(
"clangd only supports 'file' URI scheme for workspace files");
82 P.report(
"unresolvable URI");
83 consumeError(U.takeError());
99 return llvm::json::Object{{
"uri", R.
uri}};
103 llvm::json::Path P) {
104 llvm::json::ObjectMapper O(Params, P);
105 return O && O.map(
"uri", R.
uri);
110 Result.getAsObject()->try_emplace(
"version", R.
version);
116 llvm::json::ObjectMapper O(Params, P);
122 llvm::json::Path P) {
123 llvm::json::ObjectMapper O(Params, P);
124 return O && O.map(
"line", R.
line) && O.map(
"character", R.
character);
128 return llvm::json::Object{
138bool fromJSON(
const llvm::json::Value &Params,
Range &R, llvm::json::Path P) {
139 llvm::json::ObjectMapper O(Params, P);
140 return O && O.map(
"start", R.
start) && O.map(
"end", R.
end);
144 return llvm::json::Object{
155 return llvm::json::Object{
162 return OS << L.range <<
'@' << L.uri;
166 llvm::json::Object Result{
177 return OS << L.range <<
'@' << L.uri <<
" (container: " << L.containerName
182 llvm::json::Path P) {
183 llvm::json::ObjectMapper O(Params, P);
184 return O && O.map(
"uri", R.
uri) && O.map(
"languageId", R.
languageId) &&
185 O.map(
"version", R.
version) && O.map(
"text", R.
text);
189 llvm::json::Path P) {
190 llvm::json::ObjectMapper O(Params, P);
191 return O && O.map(
"range", R.
range) && O.map(
"newText", R.
newText) &&
196 llvm::json::Object Result{
206 llvm::json::Path P) {
207 llvm::json::ObjectMapper O(Params, P);
208 return O && O.map(
"label", R.
label) &&
213 llvm::json::Object Result{{
"label", CA.
label}};
222 llvm::json::Path P) {
223 llvm::json::ObjectMapper O(Params, P);
227 llvm::json::Object Result{{
"textDocument", P.
textDocument},
234 llvm::printEscapedString(TE.
newText,
OS);
239 if (
auto S =
E.getAsString()) {
244 if (*S ==
"messages") {
248 if (*S ==
"verbose") {
257 if (
auto T =
E.getAsInteger()) {
258 if (*T <
static_cast<int>(SymbolKind::File) ||
259 *T >
static_cast<int>(SymbolKind::TypeParameter))
268 llvm::json::Path P) {
269 if (
auto *A =
E.getAsArray()) {
270 for (
size_t I = 0; I < A->size(); ++I) {
272 if (
fromJSON((*A)[I], KindOut, P.index(I)))
273 Out.set(
size_t(KindOut));
282 auto KindVal =
static_cast<size_t>(
Kind);
283 if (KindVal >=
SymbolKindMin && KindVal <= SupportedSymbolKinds.size() &&
284 SupportedSymbolKinds[KindVal])
289 case SymbolKind::Struct:
290 return SymbolKind::Class;
291 case SymbolKind::EnumMember:
292 return SymbolKind::Enum;
294 return SymbolKind::String;
300 case index::SymbolKind::Unknown:
301 return SymbolKind::Variable;
302 case index::SymbolKind::Module:
303 return SymbolKind::Module;
304 case index::SymbolKind::Namespace:
305 return SymbolKind::Namespace;
306 case index::SymbolKind::NamespaceAlias:
307 return SymbolKind::Namespace;
308 case index::SymbolKind::Macro:
309 return SymbolKind::String;
310 case index::SymbolKind::Enum:
311 return SymbolKind::Enum;
312 case index::SymbolKind::Struct:
313 return SymbolKind::Struct;
314 case index::SymbolKind::Class:
315 return SymbolKind::Class;
316 case index::SymbolKind::Protocol:
317 return SymbolKind::Interface;
318 case index::SymbolKind::Extension:
319 return SymbolKind::Interface;
320 case index::SymbolKind::Union:
321 return SymbolKind::Class;
322 case index::SymbolKind::TypeAlias:
323 return SymbolKind::Class;
324 case index::SymbolKind::Function:
325 return SymbolKind::Function;
326 case index::SymbolKind::Variable:
327 return SymbolKind::Variable;
328 case index::SymbolKind::Field:
329 return SymbolKind::Field;
330 case index::SymbolKind::EnumConstant:
331 return SymbolKind::EnumMember;
332 case index::SymbolKind::InstanceMethod:
333 case index::SymbolKind::ClassMethod:
334 case index::SymbolKind::StaticMethod:
335 return SymbolKind::Method;
336 case index::SymbolKind::InstanceProperty:
337 case index::SymbolKind::ClassProperty:
338 case index::SymbolKind::StaticProperty:
339 return SymbolKind::Property;
340 case index::SymbolKind::Constructor:
341 case index::SymbolKind::Destructor:
342 return SymbolKind::Constructor;
343 case index::SymbolKind::ConversionFunction:
344 return SymbolKind::Function;
345 case index::SymbolKind::Parameter:
346 case index::SymbolKind::NonTypeTemplateParm:
347 return SymbolKind::Variable;
348 case index::SymbolKind::Using:
349 return SymbolKind::Namespace;
350 case index::SymbolKind::TemplateTemplateParm:
351 case index::SymbolKind::TemplateTypeParm:
352 return SymbolKind::TypeParameter;
353 case index::SymbolKind::Concept:
354 return SymbolKind::Interface;
356 llvm_unreachable(
"invalid symbol kind");
360 llvm::json::Path P) {
361 const llvm::json::Object *O = Params.getAsObject();
363 P.report(
"expected object");
366 if (
auto *TextDocument = O->getObject(
"textDocument")) {
367 if (
auto *SemanticHighlighting =
368 TextDocument->getObject(
"semanticHighlightingCapabilities")) {
369 if (
auto SemanticHighlightingSupport =
370 SemanticHighlighting->getBoolean(
"semanticHighlighting"))
373 if (
auto *InactiveRegions =
374 TextDocument->getObject(
"inactiveRegionsCapabilities")) {
375 if (
auto InactiveRegionsSupport =
376 InactiveRegions->getBoolean(
"inactiveRegions")) {
380 if (TextDocument->getObject(
"semanticTokens"))
382 if (
auto *
Diagnostics = TextDocument->getObject(
"publishDiagnostics")) {
383 if (
auto CategorySupport =
Diagnostics->getBoolean(
"categorySupport"))
385 if (
auto CodeActions =
Diagnostics->getBoolean(
"codeActionsInline"))
387 if (
auto RelatedInfo =
Diagnostics->getBoolean(
"relatedInformation"))
390 if (
auto *
References = TextDocument->getObject(
"references"))
391 if (
auto ContainerSupport =
References->getBoolean(
"container"))
393 if (
auto *Completion = TextDocument->getObject(
"completion")) {
394 if (
auto *Item = Completion->getObject(
"completionItem")) {
395 if (
auto SnippetSupport = Item->getBoolean(
"snippetSupport"))
397 if (
auto LabelDetailsSupport = Item->getBoolean(
"labelDetailsSupport"))
399 if (
const auto *DocumentationFormat =
400 Item->getArray(
"documentationFormat")) {
401 for (
const auto &Format : *DocumentationFormat) {
407 if (
auto *ItemKind = Completion->getObject(
"completionItemKind")) {
408 if (
auto *ValueSet = ItemKind->get(
"valueSet")) {
411 P.field(
"textDocument")
413 .field(
"completionItemKind")
418 if (
auto EditsNearCursor = Completion->getBoolean(
"editsNearCursor"))
421 if (
auto *
CodeAction = TextDocument->getObject(
"codeAction")) {
422 if (
CodeAction->getObject(
"codeActionLiteralSupport"))
425 if (
auto *
DocumentSymbol = TextDocument->getObject(
"documentSymbol")) {
426 if (
auto HierarchicalSupport =
430 if (
auto *
Hover = TextDocument->getObject(
"hover")) {
431 if (
auto *ContentFormat =
Hover->getArray(
"contentFormat")) {
432 for (
const auto &Format : *ContentFormat) {
438 if (
auto *Help = TextDocument->getObject(
"signatureHelp")) {
440 if (
auto *
Info = Help->getObject(
"signatureInformation")) {
441 if (
auto *
Parameter =
Info->getObject(
"parameterInformation")) {
442 if (
auto OffsetSupport =
Parameter->getBoolean(
"labelOffsetSupport"))
445 if (
const auto *DocumentationFormat =
446 Info->getArray(
"documentationFormat")) {
447 for (
const auto &Format : *DocumentationFormat) {
454 if (
auto *Folding = TextDocument->getObject(
"foldingRange")) {
455 if (
auto LineFolding = Folding->getBoolean(
"lineFoldingOnly"))
458 if (
auto *Rename = TextDocument->getObject(
"rename")) {
459 if (
auto RenameSupport = Rename->getBoolean(
"prepareSupport"))
463 if (
auto *Workspace = O->getObject(
"workspace")) {
464 if (
auto *
Symbol = Workspace->getObject(
"symbol")) {
466 if (
auto *ValueSet =
SymbolKind->get(
"valueSet")) {
477 if (
auto *
SemanticTokens = Workspace->getObject(
"semanticTokens")) {
478 if (
auto RefreshSupport =
SemanticTokens->getBoolean(
"refreshSupport"))
481 if (
auto *
WorkspaceEdit = Workspace->getObject(
"workspaceEdit")) {
482 if (
auto DocumentChanges =
WorkspaceEdit->getBoolean(
"documentChanges"))
489 if (
auto *Window = O->getObject(
"window")) {
490 if (
auto WorkDoneProgress = Window->getBoolean(
"workDoneProgress"))
492 if (
auto Implicit = Window->getBoolean(
"implicitWorkDoneProgressCreate"))
495 if (
auto *General = O->getObject(
"general")) {
496 if (
auto *StaleRequestSupport = General->getObject(
"staleRequestSupport")) {
497 if (
auto Cancel = StaleRequestSupport->getBoolean(
"cancel"))
504 P.field(
"offsetEncoding")))
511 llvm::json::Path P) {
512 llvm::json::ObjectMapper O(Params, P);
521 if (
auto *RawCaps = Params.getAsObject()->getObject(
"capabilities"))
523 O.map(
"trace", R.
trace);
529 return llvm::json::Object{{
"token", P.
token}};
533 llvm::json::Object Result{
538 Result[
"cancellable"] =
true;
540 Result[
"percentage"] = 0;
543 return std::move(Result);
547 llvm::json::Object Result{{
"kind",
"report"}};
551 Result[
"message"] = *P.
message;
555 return std::move(Result);
559 llvm::json::Object Result{{
"kind",
"end"}};
561 Result[
"message"] = *P.
message;
563 return std::move(Result);
567 return static_cast<int64_t
>(R);
571 return llvm::json::Object{{
"type", R.
type}, {
"message", R.
message}};
575 llvm::json::Path P) {
576 llvm::json::ObjectMapper O(Params, P);
581 llvm::json::Path P) {
582 llvm::json::ObjectMapper O(Params, P);
587 llvm::json::Path P) {
588 llvm::json::ObjectMapper O(Params, P);
593 llvm::json::Path P) {
594 llvm::json::ObjectMapper O(Params, P);
598 mapOptOrNull(Params,
"forceRebuild", R.
forceRebuild, P);
602 llvm::json::Path P) {
603 if (
auto T =
E.getAsInteger()) {
614 llvm::json::Path P) {
615 llvm::json::ObjectMapper O(Params, P);
616 return O && O.map(
"uri", R.
uri) && O.map(
"type", R.
type);
620 llvm::json::Path P) {
621 llvm::json::ObjectMapper O(Params, P);
622 return O && O.map(
"changes", R.
changes);
627 llvm::json::ObjectMapper O(Params, P);
628 return O && O.map(
"range", R.
range) && O.map(
"rangeLength", R.
rangeLength) &&
629 O.map(
"text", R.
text);
633 llvm::json::Path P) {
634 llvm::json::ObjectMapper O(Params, P);
640 llvm::json::ObjectMapper O(Params, P);
642 O.map(
"position", R.
position) && O.map(
"ch", R.
ch);
646 llvm::json::Path P) {
647 llvm::json::ObjectMapper O(Params, P);
652 llvm::json::Path P) {
653 llvm::json::ObjectMapper O(Params, P);
658 return llvm::json::Object{
667 return llvm::json::Object{{
"href", D.href}};
671 llvm::json::Object
Diag{
673 {
"severity", D.severity},
674 {
"message", D.message},
677 Diag[
"category"] = *D.category;
679 Diag[
"codeActions"] = D.codeActions;
681 Diag[
"code"] = D.code;
682 if (D.codeDescription)
683 Diag[
"codeDescription"] = *D.codeDescription;
684 if (!D.source.empty())
685 Diag[
"source"] = D.source;
686 if (D.relatedInformation)
687 Diag[
"relatedInformation"] = *D.relatedInformation;
689 Diag[
"data"] = llvm::json::Object(D.data);
691 Diag[
"tags"] = llvm::json::Array{D.tags};
693 return std::move(
Diag);
697 llvm::json::Path P) {
698 llvm::json::ObjectMapper O(Params, P);
701 if (
auto *Data = Params.getAsObject()->getObject(
"data"))
703 return O.map(
"range", R.
range) && O.map(
"message", R.
message) &&
704 mapOptOrNull(Params,
"severity", R.
severity, P) &&
705 mapOptOrNull(Params,
"category", R.
category, P) &&
706 mapOptOrNull(Params,
"code", R.
code, P) &&
707 mapOptOrNull(Params,
"source", R.
source, P);
711 llvm::json::Object Result{
716 Result[
"version"] = PDP.
version;
717 return std::move(Result);
721 llvm::json::Path P) {
722 llvm::json::ObjectMapper O(Params, P);
725 O.map(
"only", R.
only);
730 OS << D.range <<
" [";
731 switch (D.severity) {
748 return OS <<
'(' << D.severity <<
"): " << D.message <<
"]";
752 llvm::json::Path P) {
753 llvm::json::ObjectMapper O(Params, P);
759 llvm::json::Path P) {
760 llvm::json::ObjectMapper O(Params, P);
761 return O && O.map(
"changes", R.
changes) &&
767 llvm::json::Path P) {
768 llvm::json::ObjectMapper O(Params, P);
769 if (!O || !O.map(
"command", R.
command))
772 const auto *
Args = Params.getAsObject()->get(
"arguments");
775 const auto *ArgsArray =
Args->getAsArray();
777 P.field(
"arguments").report(
"expected array");
780 if (ArgsArray->size() > 1) {
781 P.field(
"arguments").report(
"Command should have 0 or 1 argument");
784 if (ArgsArray->size() == 1) {
791 llvm::json::Object O{
793 {
"kind",
static_cast<int>(P.
kind)},
798 O[
"score"] = *P.
score;
816 llvm::json::Object Result{{
"name", llvm::json::Value(
nullptr)},
817 {
"containerName", llvm::json::Value(
nullptr)},
818 {
"usr", llvm::json::Value(
nullptr)},
819 {
"id", llvm::json::Value(
nullptr)}};
822 Result[
"name"] = P.
name;
828 Result[
"usr"] = P.
USR;
831 Result[
"id"] = P.
ID.
str();
840 return std::move(Result);
846 llvm::StringRef ContNameRef;
847 if (!ContNameRef.endswith(
"::")) {
856 llvm::json::Path P) {
857 llvm::json::ObjectMapper O(Params, P);
858 return O && O.map(
"query", R.
query) &&
859 mapOptOrNull(Params,
"limit", R.
limit, P);
863 auto Cmd = llvm::json::Object{{
"title",
C.title}, {
"command",
C.command}};
864 if (!
C.argument.getAsNull())
865 Cmd[
"arguments"] = llvm::json::Array{
C.argument};
866 return std::move(Cmd);
893 llvm::json::Object Result{{
"name", S.
name},
894 {
"kind",
static_cast<int>(S.
kind)},
899 Result[
"detail"] = S.
detail;
903 Result[
"deprecated"] =
true;
905 return std::move(Result);
909 llvm::json::Object Result;
911 llvm::json::Object FileChanges;
912 for (
auto &Change : *WE.
changes)
913 FileChanges[Change.first] = llvm::json::Array(Change.second);
914 Result[
"changes"] = std::move(FileChanges);
919 llvm::json::Object ChangeAnnotations;
921 ChangeAnnotations[Annotation.first] = Annotation.second;
922 Result[
"changeAnnotations"] = std::move(ChangeAnnotations);
928 llvm::json::Path P) {
929 llvm::json::ObjectMapper O(Params, P);
930 return O && O.map(
"file", A.file) && O.map(
"selection", A.selection) &&
931 O.map(
"tweakID", A.tweakID);
935 return llvm::json::Object{
936 {
"tweakID", A.tweakID}, {
"selection", A.selection}, {
"file", A.file}};
940 return llvm::json::Object{{
"edit", Params.
edit}};
944 llvm::json::Path P) {
945 llvm::json::ObjectMapper O(Response, P);
946 return O && O.map(
"applied", R.
applied) &&
951 llvm::json::Path P) {
952 llvm::json::ObjectMapper O(Params, P);
958 llvm::json::Path P) {
959 llvm::json::ObjectMapper O(Params, P);
961 if (!O || !O.map(
"triggerKind", TriggerKind) ||
969 llvm::json::Path P) {
971 !mapOptOrNull(Params,
"limit", R.
limit, P))
973 if (
auto *
Context = Params.getAsObject()->
get(
"context"))
985 llvm_unreachable(
"Invalid MarkupKind");
989 auto Str = V.getAsString();
991 P.report(
"expected string");
994 if (*Str ==
"plaintext")
996 else if (*Str ==
"markdown")
999 P.report(
"unknown markup kind");
1010 if (MC.
value.empty())
1013 return llvm::json::Object{
1015 {
"value", MC.
value},
1020 llvm::json::Object Result{{
"contents",
toJSON(H.contents)}};
1023 Result[
"range"] =
toJSON(*H.range);
1025 return std::move(Result);
1029 llvm::json::Path P) {
1030 if (
auto T =
E.getAsInteger()) {
1043 auto KindVal =
static_cast<size_t>(
Kind);
1045 KindVal <= SupportedCompletionItemKinds.size() &&
1046 SupportedCompletionItemKinds[KindVal])
1063 llvm::json::Path P) {
1064 if (
auto *A =
E.getAsArray()) {
1065 for (
size_t I = 0; I < A->size(); ++I) {
1067 if (
fromJSON((*A)[I], KindOut, P.index(I)))
1068 Out.set(
size_t(KindOut));
1076 llvm::json::Object Result;
1078 Result[
"detail"] = CD.
detail;
1085 if (!
C.labelDetails)
1087 if (!
C.labelDetails->detail.empty())
1088 C.label +=
C.labelDetails->detail;
1089 if (!
C.labelDetails->description.empty())
1090 C.label =
C.labelDetails->description +
C.label;
1091 C.labelDetails.reset();
1095 assert(!
CI.label.empty() &&
"completion item label is required");
1096 llvm::json::Object Result{{
"label",
CI.label}};
1098 Result[
"kind"] =
static_cast<int>(
CI.kind);
1099 if (!
CI.detail.empty())
1100 Result[
"detail"] =
CI.detail;
1101 if (
CI.labelDetails)
1102 Result[
"labelDetails"] = *
CI.labelDetails;
1103 if (
CI.documentation)
1104 Result[
"documentation"] =
CI.documentation;
1105 if (!
CI.sortText.empty())
1106 Result[
"sortText"] =
CI.sortText;
1107 if (!
CI.filterText.empty())
1108 Result[
"filterText"] =
CI.filterText;
1109 if (!
CI.insertText.empty())
1110 Result[
"insertText"] =
CI.insertText;
1112 Result[
"insertTextFormat"] =
static_cast<int>(
CI.insertTextFormat);
1114 Result[
"textEdit"] = *
CI.textEdit;
1115 if (!
CI.additionalTextEdits.empty())
1116 Result[
"additionalTextEdits"] = llvm::json::Array(
CI.additionalTextEdits);
1118 Result[
"deprecated"] =
CI.deprecated;
1119 Result[
"score"] =
CI.score;
1120 return std::move(Result);
1129 return (L.sortText.empty() ? L.label : L.sortText) <
1134 return llvm::json::Object{
1135 {
"isIncomplete", L.isIncomplete},
1136 {
"items", llvm::json::Array(L.items)},
1141 assert((PI.labelOffsets || !PI.labelString.empty()) &&
1142 "parameter information label is required");
1143 llvm::json::Object Result;
1144 if (PI.labelOffsets)
1146 llvm::json::Array({PI.labelOffsets->first, PI.labelOffsets->second});
1148 Result[
"label"] = PI.labelString;
1149 if (!PI.documentation.empty())
1150 Result[
"documentation"] = PI.documentation;
1151 return std::move(Result);
1155 assert(!SI.
label.empty() &&
"signature information label is required");
1156 llvm::json::Object Result{
1157 {
"label", SI.
label},
1158 {
"parameters", llvm::json::Array(SI.
parameters)},
1162 return std::move(Result);
1173 "Unexpected negative value for number of active signatures.");
1175 "Unexpected negative value for active parameter index");
1176 return llvm::json::Object{
1179 {
"signatures", llvm::json::Array(SH.
signatures)},
1184 llvm::json::Path P) {
1185 llvm::json::ObjectMapper O(Params, P);
1191 return llvm::json::Object{
1193 {
"kind",
static_cast<int>(DH.
kind)},
1198 return llvm::json::Object{
1199 {
"uri", FStatus.
uri},
1200 {
"state", FStatus.
state},
1206 llvm::json::Array Result;
1208 for (
const auto &Tok : Toks) {
1209 Result.push_back(Tok.deltaLine);
1210 Result.push_back(Tok.deltaStart);
1211 Result.push_back(Tok.length);
1212 Result.push_back(Tok.tokenType);
1213 Result.push_back(Tok.tokenModifiers);
1216 return std::move(Result);
1220 return std::tie(L.deltaLine, L.deltaStart, L.length, L.tokenType,
1227 return llvm::json::Object{{
"resultId", Tokens.resultId},
1232 return llvm::json::Object{
1239 llvm::json::Object Result{{
"resultId", TE.
resultId}};
1241 Result[
"edits"] = *TE.
edits;
1244 return std::move(Result);
1248 llvm::json::Path P) {
1249 llvm::json::ObjectMapper O(Params, P);
1254 llvm::json::Path P) {
1255 llvm::json::ObjectMapper O(Params, P);
1261 return llvm::json::Object{
1278 llvm::json::ObjectMapper O(Params, P);
1279 return O && O.map(
"settings", CCP.
settings);
1283 llvm::json::Path P) {
1284 llvm::json::ObjectMapper O(Params, P);
1290 llvm::json::Path P) {
1291 llvm::json::ObjectMapper O(Params, P);
1294 return mapOptOrNull(Params,
"compilationDatabaseChanges",
1299 llvm::json::Path P) {
1300 llvm::json::ObjectMapper O(Params, P);
1304 return fromJSON(Params, Opts.ConfigSettings, P) &&
1305 O.map(
"compilationDatabasePath", Opts.compilationDatabasePath) &&
1306 mapOptOrNull(Params,
"fallbackFlags", Opts.fallbackFlags, P) &&
1307 mapOptOrNull(Params,
"clangdFileStatus", Opts.FileStatus, P);
1311 llvm::json::Path P) {
1312 auto T =
E.getAsInteger();
1323 llvm::json::Path P) {
1324 llvm::json::ObjectMapper O(Params, P);
1327 mapOptOrNull(Params,
"resolve", R.
resolve, P) &&
1328 mapOptOrNull(Params,
"direction", R.
direction, P);
1337 llvm::json::Object Result{{
"symbolID", RP.
symbolID}};
1339 Result[
"parents"] = RP.
parents;
1340 return std::move(Result);
1344 llvm::json::ObjectMapper O(Params, P);
1345 return O && O.map(
"symbolID", RP.
symbolID) &&
1346 mapOptOrNull(Params,
"parents", RP.
parents, P);
1350 llvm::json::Object Result{
1351 {
"name", I.
name}, {
"kind",
static_cast<int>(I.
kind)},
1353 {
"uri", I.
uri}, {
"data", I.
data},
1357 Result[
"detail"] = I.
detail;
1358 return std::move(Result);
1362 llvm::json::Path P) {
1363 llvm::json::ObjectMapper O(Params, P);
1366 return O && O.map(
"name", I.
name) && O.map(
"kind", I.
kind) &&
1367 O.map(
"uri", I.
uri) && O.map(
"range", I.
range) &&
1369 mapOptOrNull(Params,
"detail", I.
detail, P) &&
1370 mapOptOrNull(Params,
"deprecated", I.
deprecated, P) &&
1371 mapOptOrNull(Params,
"parents", I.
parents, P) &&
1372 mapOptOrNull(Params,
"children", I.
children, P) &&
1373 mapOptOrNull(Params,
"data", I.
data, P);
1378 llvm::json::ObjectMapper O(Params, P);
1379 return O && O.map(
"item", R.
item) &&
1380 mapOptOrNull(Params,
"resolve", R.
resolve, P) &&
1381 mapOptOrNull(Params,
"direction", R.
direction, P);
1385 llvm::json::Path P) {
1386 llvm::json::ObjectMapper O(Params, P);
1391 llvm::json::Path P) {
1393 llvm::json::ObjectMapper O(Params, P);
1394 return fromJSON(Params, Base, P) && O && O.mapOptional(
"context", R.
context);
1398 return llvm::json::Value{
static_cast<int>(
Tag)};
1402 llvm::json::Object Result{{
"name", I.
name},
1403 {
"kind",
static_cast<int>(I.
kind)},
1407 if (!I.
tags.empty())
1408 Result[
"tags"] = I.
tags;
1410 Result[
"detail"] = I.
detail;
1411 if (!I.
data.empty())
1412 Result[
"data"] = I.
data;
1413 return std::move(Result);
1417 llvm::json::Path P) {
1418 llvm::json::ObjectMapper O(Params, P);
1423 return O && O.map(
"name", I.
name) && O.map(
"kind", I.
kind) &&
1424 O.map(
"uri", I.
uri) && O.map(
"range", I.
range) &&
1426 mapOptOrNull(Params,
"data", I.
data, P);
1431 llvm::json::ObjectMapper O(Params, P);
1432 return O.map(
"item",
C.item);
1436 return llvm::json::Object{{
"from",
C.from}, {
"fromRanges",
C.fromRanges}};
1441 llvm::json::ObjectMapper O(Params, P);
1442 return O.map(
"item",
C.item);
1446 return llvm::json::Object{{
"to",
C.to}, {
"fromRanges",
C.fromRanges}};
1450 llvm::json::Path P) {
1451 llvm::json::ObjectMapper O(Params, P);
1466 llvm_unreachable(
"Unknown clang.clangd.InlayHintKind");
1470 llvm::json::Object Result{{
"position", H.position},
1472 {
"paddingLeft", H.paddingLeft},
1473 {
"paddingRight", H.paddingRight}};
1476 Result[
"kind"] = std::move(
K);
1477 return std::move(Result);
1480 return std::tie(A.position, A.range, A.kind, A.label) ==
1481 std::tie(B.position, B.range, B.kind, B.label);
1484 return std::tie(A.position, A.range, A.kind, A.label) <
1485 std::tie(B.position, B.range, B.kind, B.label);
1496 return "designator";
1500 llvm_unreachable(
"Unknown clang.clangd.InlayHintKind");
1502 return OS << ToString(
Kind);
1516 llvm_unreachable(
"Unknown clang.clangd.OffsetEncoding");
1520 llvm::json::Path P) {
1521 auto Str = V.getAsString();
1524 OE = llvm::StringSwitch<OffsetEncoding>(*Str)
1536 llvm::json::Path P) {
1537 llvm::json::ObjectMapper O(Params, P);
1544 return llvm::json::Object{{
"range",
Out.range},
1547 return llvm::json::Object{{
"range",
Out.range}};
1551 llvm::json::Path P) {
1552 llvm::json::ObjectMapper O(Params, P);
1557 return llvm::json::Object{
1564 llvm::json::Path P) {
1565 llvm::json::ObjectMapper O(Params, P);
1574 llvm::json::Object Result{
1575 {
"startLine",
Range.startLine},
1576 {
"endLine",
Range.endLine},
1578 if (
Range.startCharacter)
1579 Result[
"startCharacter"] =
Range.startCharacter;
1580 if (
Range.endCharacter)
1581 Result[
"endCharacter"] =
Range.endCharacter;
1582 if (!
Range.kind.empty())
1583 Result[
"kind"] =
Range.kind;
1588 llvm::json::Object
Out;
1593 Total += *Child.getAsObject()->getInteger(
"_total");
1594 Out[
Entry.first] = std::move(Child);
1601 llvm::json::Path P) {
1602 llvm::json::ObjectMapper O(Params, P);
1607 llvm::json::Object Result{
1614 Result[
"detail"] = N.
detail;
1616 Result[
"arcana"] = N.
arcana;
1618 Result[
"range"] = *N.
range;
1623 std::function<void(
const ASTNode &,
unsigned)> Print = [&](
const ASTNode &N,
1625 OS.indent(2 * Level) << N.
role <<
": " << N.
kind;
1630 Print(
C, Level + 1);
1637 auto Str =
E.getAsString();
1639 P.report(
"expected a string");
1644 elog(
"Malformed symbolid: {0}",
ID.takeError());
1645 P.report(
"malformed symbolid");
CompiledFragmentImpl & Out
std::unique_ptr< CompilerInvocation > CI
WantDiagnostics Diagnostics
llvm::raw_string_ostream OS
A context is an immutable container for per-request data that must be propagated through layers that ...
const Type * get(const Key< Type > &Key) const
Get data stored for a typed Key.
static llvm::Expected< SymbolID > fromStr(llvm::StringRef)
A URI describes the location of a source file.
static llvm::Expected< std::string > resolvePath(llvm::StringRef AbsPath, llvm::StringRef HintPath="")
Resolves AbsPath into a canonical path of its URI, by converting AbsPath to URI and resolving the URI...
static llvm::Expected< std::string > resolve(const URI &U, llvm::StringRef HintPath="")
Resolves the absolute path of U.
static llvm::Expected< URI > parse(llvm::StringRef Uri)
Parse a URI string "<scheme>:[//<authority>/]<path>".
@ Created
The file got created.
@ Deleted
The file got deleted.
@ Info
An information message.
std::bitset< SymbolKindMax+1 > SymbolKindBitset
constexpr auto CompletionItemKindMin
constexpr auto SymbolKindMin
CompletionItemKind
The kind of a completion entry.
static const char * toString(OffsetEncoding OE)
bool operator==(const Inclusion &LHS, const Inclusion &RHS)
constexpr unsigned SemanticTokenEncodingSize
llvm::raw_ostream & operator<<(llvm::raw_ostream &OS, const CodeCompletion &C)
llvm::json::Value toJSON(const FuzzyFindRequest &Request)
SymbolKind adjustKindToCapability(SymbolKind Kind, SymbolKindBitset &SupportedSymbolKinds)
void removeCompletionLabelDetails(CompletionItem &C)
Remove the labelDetails field (for clients that don't support it).
bool operator<(const Ref &L, const Ref &R)
SymbolKind indexSymbolKindToSymbolKind(index::SymbolKind Kind)
static llvm::StringRef toTextKind(MarkupKind Kind)
InlayHintKind
Inlay hint kinds.
@ BlockEnd
A hint after function, type or namespace definition, indicating the defined symbol name of the defini...
@ Parameter
An inlay hint that is for a parameter.
@ Type
An inlay hint that for a type annotation.
@ Designator
A hint before an element of an aggregate braced initializer list, indicating what it is initializing.
static llvm::json::Value encodeTokens(llvm::ArrayRef< SemanticToken > Toks)
std::bitset< CompletionItemKindMax+1 > CompletionItemKindBitset
void elog(const char *Fmt, Ts &&... Vals)
bool fromJSON(const llvm::json::Value &Parameters, FuzzyFindRequest &Request, llvm::json::Path P)
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Simplified description of a clang AST node.
std::optional< Range > range
The range of the original source file covered by this node.
std::vector< ASTNode > children
Nodes nested within this one, such as the operands of a BinaryOperator.
std::string role
The general kind of node, such as "expression" Corresponds to the base AST node type such as Expr.
std::string kind
The specific kind of node this is, such as "BinaryOperator".
std::string detail
Brief additional information, such as "||" for the particular operator.
std::string arcana
A one-line dump of detailed information about the node.
Payload for textDocument/ast request.
std::optional< Range > range
The position of the node to be dumped.
TextDocumentIdentifier textDocument
The text document.
std::optional< std::string > failureReason
Represents an incoming call, e.g. a caller of a method or constructor.
The parameter of a callHierarchy/incomingCalls request.
Represents programming constructs like functions or constructors in the context of call hierarchy.
std::string name
The name of this item.
URIForFile uri
The resource identifier of this item.
Range range
The range enclosing this symbol not including leading / trailing whitespace but everything else,...
SymbolKind kind
The kind of this item.
std::vector< SymbolTag > tags
Tags for this item.
std::string data
An optional 'data' field, which can be used to identify a call hierarchy item in an incomingCalls or ...
std::string detail
More detaill for this item, e.g. the signature of a function.
Range selectionRange
The range that should be selected and revealed when this symbol is being picked, e....
Represents an outgoing call, e.g.
The parameter of a callHierarchy/outgoingCalls request.
std::string description
A human-readable string which is rendered less prominent in the user interface.
std::string label
A human-readable string describing the actual change.
std::optional< bool > needsConfirmation
A flag which indicates that user confirmation is needed before applying the change.
Clangd extension that's used in the 'compilationDatabaseChanges' in workspace/didChangeConfiguration ...
std::string workingDirectory
std::vector< std::string > compilationCommand
bool HierarchicalDocumentSymbol
Client supports hierarchical document symbols.
bool WorkDoneProgress
The client supports progress notifications.
bool DiagnosticCategory
Whether the client accepts diagnostics with category attached to it using the "category" extension.
bool CompletionLabelDetail
The client has support for completion item label details.
MarkupKind HoverContentFormat
The content format that should be used for Hover requests.
bool CodeActionStructure
Client supports CodeAction return value for textDocument/codeAction.
bool OffsetsInSignatureHelp
Client supports processing label offsets instead of a simple label string.
bool DiagnosticFixes
Whether the client accepts diagnostics with codeActions attached inline.
bool HasSignatureHelp
Client supports signature help.
bool TheiaSemanticHighlighting
Client supports Theia semantic highlighting extension.
bool SemanticTokenRefreshSupport
Whether the client implementation supports a refresh request sent from the server to the client.
bool DocumentChanges
The client supports versioned document changes for WorkspaceEdit.
bool ImplicitProgressCreation
The client supports implicit $/progress work-done progress streams, without a preceding window/workDo...
MarkupKind SignatureHelpDocumentationFormat
The documentation format that should be used for textDocument/signatureHelp.
bool DiagnosticRelatedInformation
Whether the client accepts diagnostics with related locations.
bool CompletionFixes
Client supports completions with additionalTextEdit near the cursor.
bool RenamePrepareSupport
The client supports testing for validity of rename operations before execution.
bool CancelsStaleRequests
Whether the client claims to cancel stale requests.
std::optional< CompletionItemKindBitset > CompletionItemKinds
The supported set of CompletionItemKinds for textDocument/completion.
bool CompletionSnippets
Client supports snippets as insert text.
MarkupKind CompletionDocumentationFormat
The documentation format that should be used for textDocument/completion.
bool SemanticTokens
Client advertises support for the semanticTokens feature.
bool ChangeAnnotation
The client supports change annotations on text edits,.
bool LineFoldingOnly
Client signals that it only supports folding complete lines.
bool InactiveRegions
Whether the client supports the textDocument/inactiveRegions notification.
std::optional< SymbolKindBitset > WorkspaceSymbolKinds
The supported set of SymbolKinds for workspace/symbol.
std::optional< std::vector< OffsetEncoding > > offsetEncoding
Supported encodings for LSP character offsets. (clangd extension).
bool ReferenceContainer
Client supports displaying a container string for results of textDocument/reference (clangd extension...
std::vector< Diagnostic > diagnostics
An array of diagnostics known on the client side overlapping the range provided to the textDocument/c...
std::vector< std::string > only
Requested kind of actions to return.
CodeActionContext context
Context carrying additional information.
TextDocumentIdentifier textDocument
The document in which the command was invoked.
Range range
The range for which the command was invoked.
A code action represents a change that can be performed in code, e.g.
static const llvm::StringLiteral INFO_KIND
bool isPreferred
Marks this as a preferred action.
static const llvm::StringLiteral REFACTOR_KIND
std::optional< std::vector< Diagnostic > > diagnostics
The diagnostics that this code action resolves.
static const llvm::StringLiteral QUICKFIX_KIND
std::optional< WorkspaceEdit > edit
The workspace edit this code action performs.
std::optional< Command > command
A command this code action executes.
std::optional< std::string > kind
The kind of the code action.
std::string title
A short, human-readable, title for this code action.
Structure to capture a description for an error code.
CompletionTriggerKind triggerKind
How the completion was triggered.
std::string triggerCharacter
The trigger character (a single character) that has trigger code complete.
Additional details for a completion item label.
std::string detail
An optional string which is rendered less prominently directly after label without any spacing.
std::string description
An optional string which is rendered less prominently after CompletionItemLabelDetails....
std::string sortText
A string that should be used when comparing this item with other items.
std::string label
The label of this completion item.
Represents a collection of completion items to be presented in the editor.
std::optional< int > limit
Max results to return, overriding global default.
CompletionContext context
Clangd extension: parameters configurable at any time, via the workspace/didChangeConfiguration notif...
std::map< std::string, ClangdCompileCommand > compilationDatabaseChanges
A top-level diagnostic that may have Notes and Fixes.
llvm::json::Object data
A data entry field that is preserved between a textDocument/publishDiagnostics notification and textD...
std::string code
The diagnostic's code. Can be omitted.
Range range
The range at which the message applies.
std::string source
A human-readable string describing the source of this diagnostic, e.g.
std::string message
The diagnostic's message.
int severity
The diagnostic's severity.
std::optional< std::string > category
The diagnostic's category.
ConfigurationSettings settings
bool forceRebuild
Force a complete rebuild of the file, ignoring all cached state.
VersionedTextDocumentIdentifier textDocument
The document that did change.
std::optional< bool > wantDiagnostics
Forces diagnostics to be generated, or to not be generated, for this version of the file.
std::vector< TextDocumentContentChangeEvent > contentChanges
The actual content changes.
std::vector< FileEvent > changes
The actual file events.
TextDocumentIdentifier textDocument
The document that was closed.
TextDocumentItem textDocument
The document that was opened.
TextDocumentIdentifier textDocument
The document that was saved.
A document highlight is a range inside a text document which deserves special attention.
Range range
The range this highlight applies to.
DocumentHighlightKind kind
The highlight kind, default is DocumentHighlightKind.Text.
Parameters for the document link request.
TextDocumentIdentifier textDocument
The document to provide document links for.
A range in a text document that links to an internal or external resource, like another text document...
Range range
The range this link applies to.
URIForFile target
The uri this link points to. If missing a resolve request is sent later.
TextDocumentIdentifier textDocument
Represents programming constructs like variables, classes, interfaces etc.
Range selectionRange
The range that should be selected and revealed when this symbol is being picked, e....
std::vector< DocumentSymbol > children
Children of this symbol, e.g. properties of a class.
std::string detail
More detail for this symbol, e.g the signature of a function.
std::string name
The name of this symbol.
Range range
The range enclosing this symbol not including leading/trailing whitespace but everything else like co...
bool deprecated
Indicates if this symbol is deprecated.
SymbolKind kind
The kind of this symbol.
A set of edits generated for a single file.
llvm::json::Value argument
std::string command
The identifier of the actual command handler.
FileChangeType type
The change type.
URIForFile uri
The file's URI.
Clangd extension: indicates the current state of the file in clangd, sent from server via the textDoc...
URIForFile uri
The text document's URI.
std::string state
The human-readable string presents the current state of the file, can be shown in the UI (e....
TextDocumentIdentifier textDocument
Stores information about a region of code that can be folded.
static const llvm::StringLiteral REGION_KIND
static const llvm::StringLiteral COMMENT_KIND
static const llvm::StringLiteral IMPORT_KIND
Parameters for the inactive regions (server-side) push notification.
TextDocumentIdentifier TextDocument
The textdocument these inactive regions belong to.
std::vector< Range > InactiveRegions
The inactive regions that should be sent.
Clangd extension: parameters configurable at initialize time.
llvm::json::Object rawCapabilities
The same data as capabilities, but not parsed (to expose to modules).
InitializationOptions initializationOptions
User-provided initialization options.
ClientCapabilities capabilities
The capabilities provided by the client (editor or tool)
std::optional< TraceLevel > trace
The initial trace setting. If omitted trace is disabled ('off').
std::optional< int > processId
The process Id of the parent process that started the server.
std::optional< std::string > rootPath
The rootPath of the workspace.
std::optional< URIForFile > rootUri
The rootUri of the workspace.
A parameter literal used in inlay hint requests.
std::optional< Range > range
The visible document range for which inlay hints should be computed.
TextDocumentIdentifier textDocument
The text document.
URIForFile uri
The text document's URI.
A tree that can be used to represent memory usage of nested components while preserving the hierarchy...
const llvm::DenseMap< llvm::StringRef, MemoryTree > & children() const
Returns edges to direct children of this node.
size_t self() const
Returns total number of bytes used by this node only.
int line
Line position in a document (zero-based).
int character
Character offset on a line in a document (zero-based).
std::vector< Diagnostic > diagnostics
An array of diagnostic information items.
std::optional< int64_t > version
The version number of the document the diagnostics are published for.
URIForFile uri
The URI for which diagnostic information is reported.
Position start
The range's start position.
Position end
The range's end position.
bool includeDeclaration
Include the declaration of the current symbol.
Extends Locations returned by textDocument/references with extra info.
std::optional< std::string > containerName
clangd extension: contains the name of the function or class in which the reference occurs
TextDocumentIdentifier textDocument
The document that was opened.
Position position
The position at which this request was sent.
std::string newName
The new name of the symbol.
Parameters for the typeHierarchy/resolve request.
TypeHierarchyItem item
The item to resolve.
int resolve
The hierarchy levels to resolve. 0 indicates no level.
TypeHierarchyDirection direction
The direction of the hierarchy levels to resolve.
TextDocumentIdentifier textDocument
The text document.
std::vector< Position > positions
The positions inside the text document.
Specifies a single semantic token in the document.
unsigned length
the length of the token. A token cannot be multiline
unsigned deltaStart
token start character, relative to the previous token (relative to 0 or the previous token's start if...
unsigned deltaLine
token line number, relative to the previous token
unsigned tokenType
will be looked up in SemanticTokensLegend.tokenTypes
unsigned tokenModifiers
each set bit will be looked up in SemanticTokensLegend.tokenModifiers
Body of textDocument/semanticTokens/full/delta request.
TextDocumentIdentifier textDocument
The text document.
std::string previousResultId
The previous result id.
Describes a replacement of a contiguous range of semanticTokens.
This models LSP SemanticTokensDelta | SemanticTokens, which is the result of textDocument/semanticTok...
std::optional< std::vector< SemanticToken > > tokens
Set if we computed a fresh set of tokens.
std::optional< std::vector< SemanticTokensEdit > > edits
Set if we computed edits relative to a previous set of tokens.
Body of textDocument/semanticTokens/full request.
TextDocumentIdentifier textDocument
The text document.
A versioned set of tokens.
The show message notification is sent from a server to a client to ask the client to display a partic...
MessageType type
The message type.
std::string message
The actual message.
Represents the signature of a callable.
int activeSignature
The active signature.
std::vector< SignatureInformation > signatures
The resulting signatures.
int activeParameter
The active parameter of the active signature.
Represents information about identifier.
std::optional< Location > definitionRange
std::string containerName
std::optional< Location > declarationRange
std::string USR
Unified Symbol Resolution identifier This is an opaque string uniquely identifying a symbol.
The class presents a C++ symbol, e.g.
std::optional< Range > range
The range of the document that changed.
std::string text
The new text of the range/document.
std::optional< int > rangeLength
The length of the range that got replaced.
VersionedTextDocumentIdentifier textDocument
The text document to change.
std::vector< TextEdit > edits
The edits to be applied.
URIForFile uri
The text document's URI.
std::string languageId
The text document's language identifier.
std::optional< int64_t > version
The version number of this document (it will strictly increase after each change, including undo/redo...
URIForFile uri
The text document's URI.
std::string text
The content of the opened text document.
TextDocumentIdentifier textDocument
The text document.
Position position
The position inside the text document.
std::string newText
The string to be inserted.
ChangeAnnotationIdentifier annotationId
The actual annotation identifier (optional) If empty, then this field is nullopt.
Range range
The range of the text document to be manipulated.
Arguments for the 'applyTweak' command.
Used to resolve a client provided item back.
std::optional< std::vector< ResolveParams > > parents
std::nullopt means parents aren't resolved and empty is no parents.
Range range
The range enclosing this symbol not including leading/trailing whitespace but everything else,...
URIForFile uri
The resource identifier of this item.
Range selectionRange
The range that should be selected and revealed when this symbol is being picked, e....
SymbolKind kind
The kind of this item.
std::optional< std::vector< TypeHierarchyItem > > children
If this type hierarchy item is resolved, it contains the direct children of the current item.
std::optional< std::vector< TypeHierarchyItem > > parents
This is a clangd exntesion.
bool deprecated
true if the hierarchy item is deprecated.
std::optional< std::string > detail
More detail for this item, e.g. the signature of a function.
ResolveParams data
A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requ...
std::string name
The name of this item.
The type hierarchy params is an extension of the TextDocumentPositionsParams with optional properties...
int resolve
The hierarchy levels to resolve.
TypeHierarchyDirection direction
The direction of the hierarchy levels to resolve.
static llvm::Expected< URIForFile > fromURI(const URI &U, llvm::StringRef HintPath)
static URIForFile canonicalize(llvm::StringRef AbsPath, llvm::StringRef TUPath)
Canonicalizes AbsPath via URI.
std::optional< std::int64_t > version
The version number of this document.
To start progress reporting a $/progress notification with the following payload must be sent.
bool percentage
Optional progress percentage to display (value 100 is considered 100%).
bool cancellable
Controls if a cancel button should show to allow the user to cancel the long-running operation.
std::string title
Mandatory title of the progress operation.
llvm::json::Value token
The token to be used to report progress.
Signals the end of progress reporting.
std::optional< std::string > message
Optional, a final message indicating to for example indicate the outcome of the operation.
Reporting progress is done using the following payload.
std::optional< unsigned > percentage
Optional progress percentage to display (value 100 is considered 100%).
std::optional< bool > cancellable
Controls enablement state of a cancel button.
std::optional< std::string > message
Optional, more detailed associated progress message.
The edit should either provide changes or documentChanges.
std::optional< std::vector< TextDocumentEdit > > documentChanges
Versioned document edits.
std::map< std::string, ChangeAnnotation > changeAnnotations
A map of change annotations that can be referenced in AnnotatedTextEdit.
std::optional< std::map< std::string, std::vector< TextEdit > > > changes
Holds changes to existing resources.
The parameters of a Workspace Symbol Request.
std::string query
A query string to filter symbols by.
std::optional< int > limit
Max results to return, overriding global default.