lsp.hpp 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978
  1. /*************************************************************************/
  2. /* lsp.hpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef GODOT_LSP_H
  31. #define GODOT_LSP_H
  32. #include "core/doc_data.h"
  33. #include "core/object/class_db.h"
  34. #include "core/templates/list.h"
  35. namespace lsp {
  36. typedef String DocumentUri;
  37. /** Format BBCode documentation from DocData to markdown */
  38. static String marked_documentation(const String &p_bbcode);
  39. /**
  40. * Text documents are identified using a URI. On the protocol level, URIs are passed as strings.
  41. */
  42. struct TextDocumentIdentifier {
  43. /**
  44. * The text document's URI.
  45. */
  46. DocumentUri uri;
  47. _FORCE_INLINE_ void load(const Dictionary &p_params) {
  48. uri = p_params["uri"];
  49. }
  50. _FORCE_INLINE_ Dictionary to_json() const {
  51. Dictionary dict;
  52. dict["uri"] = uri;
  53. return dict;
  54. }
  55. };
  56. /**
  57. * Position in a text document expressed as zero-based line and zero-based character offset.
  58. * A position is between two characters like an ‘insert’ cursor in a editor.
  59. * Special values like for example -1 to denote the end of a line are not supported.
  60. */
  61. struct Position {
  62. /**
  63. * Line position in a document (zero-based).
  64. */
  65. int line = 0;
  66. /**
  67. * Character offset on a line in a document (zero-based). Assuming that the line is
  68. * represented as a string, the `character` value represents the gap between the
  69. * `character` and `character + 1`.
  70. *
  71. * If the character value is greater than the line length it defaults back to the
  72. * line length.
  73. */
  74. int character = 0;
  75. _FORCE_INLINE_ void load(const Dictionary &p_params) {
  76. line = p_params["line"];
  77. character = p_params["character"];
  78. }
  79. _FORCE_INLINE_ Dictionary to_json() const {
  80. Dictionary dict;
  81. dict["line"] = line;
  82. dict["character"] = character;
  83. return dict;
  84. }
  85. };
  86. /**
  87. * A range in a text document expressed as (zero-based) start and end positions.
  88. * A range is comparable to a selection in an editor. Therefore the end position is exclusive.
  89. * If you want to specify a range that contains a line including the line ending character(s) then use an end position denoting the start of the next line.
  90. */
  91. struct Range {
  92. /**
  93. * The range's start position.
  94. */
  95. Position start;
  96. /**
  97. * The range's end position.
  98. */
  99. Position end;
  100. _FORCE_INLINE_ void load(const Dictionary &p_params) {
  101. start.load(p_params["start"]);
  102. end.load(p_params["end"]);
  103. }
  104. _FORCE_INLINE_ Dictionary to_json() const {
  105. Dictionary dict;
  106. dict["start"] = start.to_json();
  107. dict["end"] = end.to_json();
  108. return dict;
  109. }
  110. };
  111. /**
  112. * Represents a location inside a resource, such as a line inside a text file.
  113. */
  114. struct Location {
  115. DocumentUri uri;
  116. Range range;
  117. _FORCE_INLINE_ void load(const Dictionary &p_params) {
  118. uri = p_params["uri"];
  119. range.load(p_params["range"]);
  120. }
  121. _FORCE_INLINE_ Dictionary to_json() const {
  122. Dictionary dict;
  123. dict["uri"] = uri;
  124. dict["range"] = range.to_json();
  125. return dict;
  126. }
  127. };
  128. /**
  129. * Represents a link between a source and a target location.
  130. */
  131. struct LocationLink {
  132. /**
  133. * Span of the origin of this link.
  134. *
  135. * Used as the underlined span for mouse interaction. Defaults to the word range at
  136. * the mouse position.
  137. */
  138. Range *originSelectionRange = nullptr;
  139. /**
  140. * The target resource identifier of this link.
  141. */
  142. String targetUri;
  143. /**
  144. * The full target range of this link. If the target for example is a symbol then target range is the
  145. * range enclosing this symbol not including leading/trailing whitespace but everything else
  146. * like comments. This information is typically used to highlight the range in the editor.
  147. */
  148. Range targetRange;
  149. /**
  150. * The range that should be selected and revealed when this link is being followed, e.g the name of a function.
  151. * Must be contained by the the `targetRange`. See also `DocumentSymbol#range`
  152. */
  153. Range targetSelectionRange;
  154. };
  155. /**
  156. * A parameter literal used in requests to pass a text document and a position inside that document.
  157. */
  158. struct TextDocumentPositionParams {
  159. /**
  160. * The text document.
  161. */
  162. TextDocumentIdentifier textDocument;
  163. /**
  164. * The position inside the text document.
  165. */
  166. Position position;
  167. _FORCE_INLINE_ void load(const Dictionary &p_params) {
  168. textDocument.load(p_params["textDocument"]);
  169. position.load(p_params["position"]);
  170. }
  171. _FORCE_INLINE_ Dictionary to_json() const {
  172. Dictionary dict;
  173. dict["textDocument"] = textDocument.to_json();
  174. dict["position"] = position.to_json();
  175. return dict;
  176. }
  177. };
  178. struct DocumentLinkParams {
  179. /**
  180. * The document to provide document links for.
  181. */
  182. TextDocumentIdentifier textDocument;
  183. _FORCE_INLINE_ void load(const Dictionary &p_params) {
  184. textDocument.load(p_params["textDocument"]);
  185. }
  186. };
  187. /**
  188. * A document link is a range in a text document that links to an internal or external resource, like another
  189. * text document or a web site.
  190. */
  191. struct DocumentLink {
  192. /**
  193. * The range this link applies to.
  194. */
  195. Range range;
  196. /**
  197. * The uri this link points to. If missing a resolve request is sent later.
  198. */
  199. DocumentUri target;
  200. Dictionary to_json() const {
  201. Dictionary dict;
  202. dict["range"] = range.to_json();
  203. dict["target"] = target;
  204. return dict;
  205. }
  206. };
  207. /**
  208. * A textual edit applicable to a text document.
  209. */
  210. struct TextEdit {
  211. /**
  212. * The range of the text document to be manipulated. To insert
  213. * text into a document create a range where start === end.
  214. */
  215. Range range;
  216. /**
  217. * The string to be inserted. For delete operations use an
  218. * empty string.
  219. */
  220. String newText;
  221. };
  222. /**
  223. * The edits to be applied.
  224. */
  225. struct WorkspaceEdit {
  226. /**
  227. * Holds changes to existing resources.
  228. */
  229. Map<String, Vector<TextEdit>> changes;
  230. _FORCE_INLINE_ void add_edit(const String &uri, const TextEdit &edit) {
  231. if (changes.has(uri)) {
  232. changes[uri].push_back(edit);
  233. } else {
  234. Vector<TextEdit> edits;
  235. edits.push_back(edit);
  236. changes[uri] = edits;
  237. }
  238. }
  239. _FORCE_INLINE_ Dictionary to_json() const {
  240. Dictionary dict;
  241. Dictionary out_changes;
  242. for (const KeyValue<String, Vector<TextEdit>> &E : changes) {
  243. Array edits;
  244. for (int i = 0; i < E.value.size(); ++i) {
  245. Dictionary text_edit;
  246. text_edit["range"] = E.value[i].range.to_json();
  247. text_edit["newText"] = E.value[i].newText;
  248. edits.push_back(text_edit);
  249. }
  250. out_changes[E.key] = edits;
  251. }
  252. dict["changes"] = out_changes;
  253. return dict;
  254. }
  255. _FORCE_INLINE_ void add_change(const String &uri, const int &line, const int &start_character, const int &end_character, const String &new_text) {
  256. if (Map<String, Vector<TextEdit>>::Element *E = changes.find(uri)) {
  257. Vector<TextEdit> edit_list = E->value();
  258. for (int i = 0; i < edit_list.size(); ++i) {
  259. TextEdit edit = edit_list[i];
  260. if (edit.range.start.character == start_character) {
  261. return;
  262. }
  263. }
  264. }
  265. TextEdit new_edit;
  266. new_edit.newText = new_text;
  267. new_edit.range.start.line = line;
  268. new_edit.range.start.character = start_character;
  269. new_edit.range.end.line = line;
  270. new_edit.range.end.character = end_character;
  271. if (Map<String, Vector<TextEdit>>::Element *E = changes.find(uri)) {
  272. E->value().push_back(new_edit);
  273. } else {
  274. Vector<TextEdit> edit_list;
  275. edit_list.push_back(new_edit);
  276. changes.insert(uri, edit_list);
  277. }
  278. }
  279. };
  280. /**
  281. * Represents a reference to a command.
  282. * Provides a title which will be used to represent a command in the UI.
  283. * Commands are identified by a string identifier.
  284. * The recommended way to handle commands is to implement their execution on the server side if the client and server provides the corresponding capabilities.
  285. * Alternatively the tool extension code could handle the command. The protocol currently doesn’t specify a set of well-known commands.
  286. */
  287. struct Command {
  288. /**
  289. * Title of the command, like `save`.
  290. */
  291. String title;
  292. /**
  293. * The identifier of the actual command handler.
  294. */
  295. String command;
  296. /**
  297. * Arguments that the command handler should be
  298. * invoked with.
  299. */
  300. Array arguments;
  301. Dictionary to_json() const {
  302. Dictionary dict;
  303. dict["title"] = title;
  304. dict["command"] = command;
  305. if (arguments.size()) {
  306. dict["arguments"] = arguments;
  307. }
  308. return dict;
  309. }
  310. };
  311. // Use namespace instead of enumeration to follow the LSP specifications
  312. // lsp::EnumName::EnumValue is OK but lsp::EnumValue is not
  313. namespace TextDocumentSyncKind {
  314. /**
  315. * Documents should not be synced at all.
  316. */
  317. static const int None = 0;
  318. /**
  319. * Documents are synced by always sending the full content
  320. * of the document.
  321. */
  322. static const int Full = 1;
  323. /**
  324. * Documents are synced by sending the full content on open.
  325. * After that only incremental updates to the document are
  326. * send.
  327. */
  328. static const int Incremental = 2;
  329. }; // namespace TextDocumentSyncKind
  330. /**
  331. * Completion options.
  332. */
  333. struct CompletionOptions {
  334. /**
  335. * The server provides support to resolve additional
  336. * information for a completion item.
  337. */
  338. bool resolveProvider = true;
  339. /**
  340. * The characters that trigger completion automatically.
  341. */
  342. Vector<String> triggerCharacters;
  343. CompletionOptions() {
  344. triggerCharacters.push_back(".");
  345. triggerCharacters.push_back("$");
  346. triggerCharacters.push_back("'");
  347. triggerCharacters.push_back("\"");
  348. }
  349. Dictionary to_json() const {
  350. Dictionary dict;
  351. dict["resolveProvider"] = resolveProvider;
  352. dict["triggerCharacters"] = triggerCharacters;
  353. return dict;
  354. }
  355. };
  356. /**
  357. * Signature help options.
  358. */
  359. struct SignatureHelpOptions {
  360. /**
  361. * The characters that trigger signature help
  362. * automatically.
  363. */
  364. Vector<String> triggerCharacters;
  365. Dictionary to_json() {
  366. Dictionary dict;
  367. dict["triggerCharacters"] = triggerCharacters;
  368. return dict;
  369. }
  370. };
  371. /**
  372. * Code Lens options.
  373. */
  374. struct CodeLensOptions {
  375. /**
  376. * Code lens has a resolve provider as well.
  377. */
  378. bool resolveProvider = false;
  379. Dictionary to_json() {
  380. Dictionary dict;
  381. dict["resolveProvider"] = resolveProvider;
  382. return dict;
  383. }
  384. };
  385. /**
  386. * Rename options
  387. */
  388. struct RenameOptions {
  389. /**
  390. * Renames should be checked and tested before being executed.
  391. */
  392. bool prepareProvider = false;
  393. Dictionary to_json() {
  394. Dictionary dict;
  395. dict["prepareProvider"] = prepareProvider;
  396. return dict;
  397. }
  398. };
  399. /**
  400. * Document link options.
  401. */
  402. struct DocumentLinkOptions {
  403. /**
  404. * Document links have a resolve provider as well.
  405. */
  406. bool resolveProvider = false;
  407. Dictionary to_json() {
  408. Dictionary dict;
  409. dict["resolveProvider"] = resolveProvider;
  410. return dict;
  411. }
  412. };
  413. /**
  414. * Execute command options.
  415. */
  416. struct ExecuteCommandOptions {
  417. /**
  418. * The commands to be executed on the server
  419. */
  420. Vector<String> commands;
  421. Dictionary to_json() {
  422. Dictionary dict;
  423. dict["commands"] = commands;
  424. return dict;
  425. }
  426. };
  427. /**
  428. * Save options.
  429. */
  430. struct SaveOptions {
  431. /**
  432. * The client is supposed to include the content on save.
  433. */
  434. bool includeText = true;
  435. Dictionary to_json() {
  436. Dictionary dict;
  437. dict["includeText"] = includeText;
  438. return dict;
  439. }
  440. };
  441. /**
  442. * Color provider options.
  443. */
  444. struct ColorProviderOptions {
  445. Dictionary to_json() {
  446. Dictionary dict;
  447. return dict;
  448. }
  449. };
  450. /**
  451. * Folding range provider options.
  452. */
  453. struct FoldingRangeProviderOptions {
  454. Dictionary to_json() {
  455. Dictionary dict;
  456. return dict;
  457. }
  458. };
  459. struct TextDocumentSyncOptions {
  460. /**
  461. * Open and close notifications are sent to the server. If omitted open close notification should not
  462. * be sent.
  463. */
  464. bool openClose = true;
  465. /**
  466. * Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
  467. * and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
  468. */
  469. int change = TextDocumentSyncKind::Full;
  470. /**
  471. * If present will save notifications are sent to the server. If omitted the notification should not be
  472. * sent.
  473. */
  474. bool willSave = false;
  475. /**
  476. * If present will save wait until requests are sent to the server. If omitted the request should not be
  477. * sent.
  478. */
  479. bool willSaveWaitUntil = false;
  480. /**
  481. * If present save notifications are sent to the server. If omitted the notification should not be
  482. * sent.
  483. */
  484. SaveOptions save;
  485. Dictionary to_json() {
  486. Dictionary dict;
  487. dict["willSaveWaitUntil"] = willSaveWaitUntil;
  488. dict["willSave"] = willSave;
  489. dict["openClose"] = openClose;
  490. dict["change"] = change;
  491. dict["save"] = save.to_json();
  492. return dict;
  493. }
  494. };
  495. /**
  496. * Static registration options to be returned in the initialize request.
  497. */
  498. struct StaticRegistrationOptions {
  499. /**
  500. * The id used to register the request. The id can be used to deregister
  501. * the request again. See also Registration#id.
  502. */
  503. String id;
  504. };
  505. /**
  506. * Format document on type options.
  507. */
  508. struct DocumentOnTypeFormattingOptions {
  509. /**
  510. * A character on which formatting should be triggered, like `}`.
  511. */
  512. String firstTriggerCharacter;
  513. /**
  514. * More trigger characters.
  515. */
  516. Vector<String> moreTriggerCharacter;
  517. Dictionary to_json() {
  518. Dictionary dict;
  519. dict["firstTriggerCharacter"] = firstTriggerCharacter;
  520. dict["moreTriggerCharacter"] = moreTriggerCharacter;
  521. return dict;
  522. }
  523. };
  524. struct TextDocumentItem {
  525. /**
  526. * The text document's URI.
  527. */
  528. DocumentUri uri;
  529. /**
  530. * The text document's language identifier.
  531. */
  532. String languageId;
  533. /**
  534. * The version number of this document (it will increase after each
  535. * change, including undo/redo).
  536. */
  537. int version = 0;
  538. /**
  539. * The content of the opened text document.
  540. */
  541. String text;
  542. void load(const Dictionary &p_dict) {
  543. uri = p_dict["uri"];
  544. languageId = p_dict["languageId"];
  545. version = p_dict["version"];
  546. text = p_dict["text"];
  547. }
  548. Dictionary to_json() const {
  549. Dictionary dict;
  550. dict["uri"] = uri;
  551. dict["languageId"] = languageId;
  552. dict["version"] = version;
  553. dict["text"] = text;
  554. return dict;
  555. }
  556. };
  557. /**
  558. * An event describing a change to a text document. If range and rangeLength are omitted
  559. * the new text is considered to be the full content of the document.
  560. */
  561. struct TextDocumentContentChangeEvent {
  562. /**
  563. * The range of the document that changed.
  564. */
  565. Range range;
  566. /**
  567. * The length of the range that got replaced.
  568. */
  569. int rangeLength = 0;
  570. /**
  571. * The new text of the range/document.
  572. */
  573. String text;
  574. void load(const Dictionary &p_params) {
  575. text = p_params["text"];
  576. rangeLength = p_params["rangeLength"];
  577. range.load(p_params["range"]);
  578. }
  579. };
  580. // Use namespace instead of enumeration to follow the LSP specifications
  581. namespace DiagnosticSeverity {
  582. /**
  583. * Reports an error.
  584. */
  585. static const int Error = 1;
  586. /**
  587. * Reports a warning.
  588. */
  589. static const int Warning = 2;
  590. /**
  591. * Reports an information.
  592. */
  593. static const int Information = 3;
  594. /**
  595. * Reports a hint.
  596. */
  597. static const int Hint = 4;
  598. }; // namespace DiagnosticSeverity
  599. /**
  600. * Represents a related message and source code location for a diagnostic. This should be
  601. * used to point to code locations that cause or related to a diagnostics, e.g when duplicating
  602. * a symbol in a scope.
  603. */
  604. struct DiagnosticRelatedInformation {
  605. /**
  606. * The location of this related diagnostic information.
  607. */
  608. Location location;
  609. /**
  610. * The message of this related diagnostic information.
  611. */
  612. String message;
  613. Dictionary to_json() const {
  614. Dictionary dict;
  615. dict["location"] = location.to_json(),
  616. dict["message"] = message;
  617. return dict;
  618. }
  619. };
  620. /**
  621. * Represents a diagnostic, such as a compiler error or warning.
  622. * Diagnostic objects are only valid in the scope of a resource.
  623. */
  624. struct Diagnostic {
  625. /**
  626. * The range at which the message applies.
  627. */
  628. Range range;
  629. /**
  630. * The diagnostic's severity. Can be omitted. If omitted it is up to the
  631. * client to interpret diagnostics as error, warning, info or hint.
  632. */
  633. int severity = 0;
  634. /**
  635. * The diagnostic's code, which might appear in the user interface.
  636. */
  637. int code = 0;
  638. /**
  639. * A human-readable string describing the source of this
  640. * diagnostic, e.g. 'typescript' or 'super lint'.
  641. */
  642. String source;
  643. /**
  644. * The diagnostic's message.
  645. */
  646. String message;
  647. /**
  648. * An array of related diagnostic information, e.g. when symbol-names within
  649. * a scope collide all definitions can be marked via this property.
  650. */
  651. Vector<DiagnosticRelatedInformation> relatedInformation;
  652. Dictionary to_json() const {
  653. Dictionary dict;
  654. dict["range"] = range.to_json();
  655. dict["code"] = code;
  656. dict["severity"] = severity;
  657. dict["message"] = message;
  658. dict["source"] = source;
  659. if (!relatedInformation.is_empty()) {
  660. Array arr;
  661. arr.resize(relatedInformation.size());
  662. for (int i = 0; i < relatedInformation.size(); i++) {
  663. arr[i] = relatedInformation[i].to_json();
  664. }
  665. dict["relatedInformation"] = arr;
  666. }
  667. return dict;
  668. }
  669. };
  670. // Use namespace instead of enumeration to follow the LSP specifications
  671. /**
  672. * Describes the content type that a client supports in various
  673. * result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
  674. *
  675. * Please note that `MarkupKinds` must not start with a `$`. This kinds
  676. * are reserved for internal usage.
  677. */
  678. namespace MarkupKind {
  679. static const String PlainText = "plaintext";
  680. static const String Markdown = "markdown";
  681. }; // namespace MarkupKind
  682. /**
  683. * A `MarkupContent` literal represents a string value which content is interpreted base on its
  684. * kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
  685. *
  686. * If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
  687. * See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
  688. *
  689. * Here is an example how such a string can be constructed using JavaScript / TypeScript:
  690. * ```typescript
  691. * let markdown: MarkdownContent = {
  692. * kind: MarkupKind.Markdown,
  693. * value: [
  694. * '# Header',
  695. * 'Some text',
  696. * '```typescript',
  697. * 'someCode();',
  698. * '```'
  699. * ].join('\n')
  700. * };
  701. * ```
  702. *
  703. * *Please Note* that clients might sanitize the return markdown. A client could decide to
  704. * remove HTML from the markdown to avoid script execution.
  705. */
  706. struct MarkupContent {
  707. /**
  708. * The type of the Markup
  709. */
  710. String kind;
  711. /**
  712. * The content itself
  713. */
  714. String value;
  715. MarkupContent() {
  716. kind = MarkupKind::Markdown;
  717. }
  718. MarkupContent(const String &p_value) {
  719. value = p_value;
  720. kind = MarkupKind::Markdown;
  721. }
  722. Dictionary to_json() const {
  723. Dictionary dict;
  724. dict["kind"] = kind;
  725. dict["value"] = value;
  726. return dict;
  727. }
  728. };
  729. // Use namespace instead of enumeration to follow the LSP specifications
  730. // lsp::EnumName::EnumValue is OK but lsp::EnumValue is not
  731. // And here C++ compilers are unhappy with our enumeration name like Color, File, RefCounted etc.
  732. /**
  733. * The kind of a completion entry.
  734. */
  735. namespace CompletionItemKind {
  736. static const int Text = 1;
  737. static const int Method = 2;
  738. static const int Function = 3;
  739. static const int Constructor = 4;
  740. static const int Field = 5;
  741. static const int Variable = 6;
  742. static const int Class = 7;
  743. static const int Interface = 8;
  744. static const int Module = 9;
  745. static const int Property = 10;
  746. static const int Unit = 11;
  747. static const int Value = 12;
  748. static const int Enum = 13;
  749. static const int Keyword = 14;
  750. static const int Snippet = 15;
  751. static const int Color = 16;
  752. static const int File = 17;
  753. static const int RefCounted = 18;
  754. static const int Folder = 19;
  755. static const int EnumMember = 20;
  756. static const int Constant = 21;
  757. static const int Struct = 22;
  758. static const int Event = 23;
  759. static const int Operator = 24;
  760. static const int TypeParameter = 25;
  761. }; // namespace CompletionItemKind
  762. // Use namespace instead of enumeration to follow the LSP specifications
  763. /**
  764. * Defines whether the insert text in a completion item should be interpreted as
  765. * plain text or a snippet.
  766. */
  767. namespace InsertTextFormat {
  768. /**
  769. * The primary text to be inserted is treated as a plain string.
  770. */
  771. static const int PlainText = 1;
  772. /**
  773. * The primary text to be inserted is treated as a snippet.
  774. *
  775. * A snippet can define tab stops and placeholders with `$1`, `$2`
  776. * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
  777. * the end of the snippet. Placeholders with equal identifiers are linked,
  778. * that is typing in one will update others too.
  779. */
  780. static const int Snippet = 2;
  781. }; // namespace InsertTextFormat
  782. struct CompletionItem {
  783. /**
  784. * The label of this completion item. By default
  785. * also the text that is inserted when selecting
  786. * this completion.
  787. */
  788. String label;
  789. /**
  790. * The kind of this completion item. Based of the kind
  791. * an icon is chosen by the editor. The standardized set
  792. * of available values is defined in `CompletionItemKind`.
  793. */
  794. int kind = 0;
  795. /**
  796. * A human-readable string with additional information
  797. * about this item, like type or symbol information.
  798. */
  799. String detail;
  800. /**
  801. * A human-readable string that represents a doc-comment.
  802. */
  803. MarkupContent documentation;
  804. /**
  805. * Indicates if this item is deprecated.
  806. */
  807. bool deprecated = false;
  808. /**
  809. * Select this item when showing.
  810. *
  811. * *Note* that only one completion item can be selected and that the
  812. * tool / client decides which item that is. The rule is that the *first*
  813. * item of those that match best is selected.
  814. */
  815. bool preselect = false;
  816. /**
  817. * A string that should be used when comparing this item
  818. * with other items. When `falsy` the label is used.
  819. */
  820. String sortText;
  821. /**
  822. * A string that should be used when filtering a set of
  823. * completion items. When `falsy` the label is used.
  824. */
  825. String filterText;
  826. /**
  827. * A string that should be inserted into a document when selecting
  828. * this completion. When `falsy` the label is used.
  829. *
  830. * The `insertText` is subject to interpretation by the client side.
  831. * Some tools might not take the string literally. For example
  832. * VS Code when code complete is requested in this example `con<cursor position>`
  833. * and a completion item with an `insertText` of `console` is provided it
  834. * will only insert `sole`. Therefore it is recommended to use `textEdit` instead
  835. * since it avoids additional client side interpretation.
  836. *
  837. * @deprecated Use textEdit instead.
  838. */
  839. String insertText;
  840. /**
  841. * The format of the insert text. The format applies to both the `insertText` property
  842. * and the `newText` property of a provided `textEdit`.
  843. */
  844. int insertTextFormat = 0;
  845. /**
  846. * An edit which is applied to a document when selecting this completion. When an edit is provided the value of
  847. * `insertText` is ignored.
  848. *
  849. * *Note:* The range of the edit must be a single line range and it must contain the position at which completion
  850. * has been requested.
  851. */
  852. TextEdit textEdit;
  853. /**
  854. * An optional array of additional text edits that are applied when
  855. * selecting this completion. Edits must not overlap (including the same insert position)
  856. * with the main edit nor with themselves.
  857. *
  858. * Additional text edits should be used to change text unrelated to the current cursor position
  859. * (for example adding an import statement at the top of the file if the completion item will
  860. * insert an unqualified type).
  861. */
  862. Vector<TextEdit> additionalTextEdits;
  863. /**
  864. * An optional set of characters that when pressed while this completion is active will accept it first and
  865. * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
  866. * characters will be ignored.
  867. */
  868. Vector<String> commitCharacters;
  869. /**
  870. * An optional command that is executed *after* inserting this completion. *Note* that
  871. * additional modifications to the current document should be described with the
  872. * additionalTextEdits-property.
  873. */
  874. Command command;
  875. /**
  876. * A data entry field that is preserved on a completion item between
  877. * a completion and a completion resolve request.
  878. */
  879. Variant data;
  880. _FORCE_INLINE_ Dictionary to_json(bool resolved = false) const {
  881. Dictionary dict;
  882. dict["label"] = label;
  883. dict["kind"] = kind;
  884. dict["data"] = data;
  885. dict["insertText"] = insertText;
  886. if (resolved) {
  887. dict["detail"] = detail;
  888. dict["documentation"] = documentation.to_json();
  889. dict["deprecated"] = deprecated;
  890. dict["preselect"] = preselect;
  891. dict["sortText"] = sortText;
  892. dict["filterText"] = filterText;
  893. if (commitCharacters.size()) {
  894. dict["commitCharacters"] = commitCharacters;
  895. }
  896. dict["command"] = command.to_json();
  897. }
  898. return dict;
  899. }
  900. void load(const Dictionary &p_dict) {
  901. if (p_dict.has("label")) {
  902. label = p_dict["label"];
  903. }
  904. if (p_dict.has("kind")) {
  905. kind = p_dict["kind"];
  906. }
  907. if (p_dict.has("detail")) {
  908. detail = p_dict["detail"];
  909. }
  910. if (p_dict.has("documentation")) {
  911. Variant doc = p_dict["documentation"];
  912. if (doc.get_type() == Variant::STRING) {
  913. documentation.value = doc;
  914. } else if (doc.get_type() == Variant::DICTIONARY) {
  915. Dictionary v = doc;
  916. documentation.value = v["value"];
  917. }
  918. }
  919. if (p_dict.has("deprecated")) {
  920. deprecated = p_dict["deprecated"];
  921. }
  922. if (p_dict.has("preselect")) {
  923. preselect = p_dict["preselect"];
  924. }
  925. if (p_dict.has("sortText")) {
  926. sortText = p_dict["sortText"];
  927. }
  928. if (p_dict.has("filterText")) {
  929. filterText = p_dict["filterText"];
  930. }
  931. if (p_dict.has("insertText")) {
  932. insertText = p_dict["insertText"];
  933. }
  934. if (p_dict.has("data")) {
  935. data = p_dict["data"];
  936. }
  937. }
  938. };
  939. /**
  940. * Represents a collection of [completion items](#CompletionItem) to be presented
  941. * in the editor.
  942. */
  943. struct CompletionList {
  944. /**
  945. * This list it not complete. Further typing should result in recomputing
  946. * this list.
  947. */
  948. bool isIncomplete = false;
  949. /**
  950. * The completion items.
  951. */
  952. Vector<CompletionItem> items;
  953. };
  954. // Use namespace instead of enumeration to follow the LSP specifications
  955. // lsp::EnumName::EnumValue is OK but lsp::EnumValue is not
  956. // And here C++ compilers are unhappy with our enumeration name like String, Array, Object etc
  957. /**
  958. * A symbol kind.
  959. */
  960. namespace SymbolKind {
  961. static const int File = 1;
  962. static const int Module = 2;
  963. static const int Namespace = 3;
  964. static const int Package = 4;
  965. static const int Class = 5;
  966. static const int Method = 6;
  967. static const int Property = 7;
  968. static const int Field = 8;
  969. static const int Constructor = 9;
  970. static const int Enum = 10;
  971. static const int Interface = 11;
  972. static const int Function = 12;
  973. static const int Variable = 13;
  974. static const int Constant = 14;
  975. static const int String = 15;
  976. static const int Number = 16;
  977. static const int Boolean = 17;
  978. static const int Array = 18;
  979. static const int Object = 19;
  980. static const int Key = 20;
  981. static const int Null = 21;
  982. static const int EnumMember = 22;
  983. static const int Struct = 23;
  984. static const int Event = 24;
  985. static const int Operator = 25;
  986. static const int TypeParameter = 26;
  987. }; // namespace SymbolKind
  988. /**
  989. * Represents information about programming constructs like variables, classes,
  990. * interfaces etc.
  991. */
  992. struct SymbolInformation {
  993. /**
  994. * The name of this symbol.
  995. */
  996. String name;
  997. /**
  998. * The kind of this symbol.
  999. */
  1000. int kind = SymbolKind::File;
  1001. /**
  1002. * Indicates if this symbol is deprecated.
  1003. */
  1004. bool deprecated = false;
  1005. /**
  1006. * The location of this symbol. The location's range is used by a tool
  1007. * to reveal the location in the editor. If the symbol is selected in the
  1008. * tool the range's start information is used to position the cursor. So
  1009. * the range usually spans more then the actual symbol's name and does
  1010. * normally include things like visibility modifiers.
  1011. *
  1012. * The range doesn't have to denote a node range in the sense of a abstract
  1013. * syntax tree. It can therefore not be used to re-construct a hierarchy of
  1014. * the symbols.
  1015. */
  1016. Location location;
  1017. /**
  1018. * The name of the symbol containing this symbol. This information is for
  1019. * user interface purposes (e.g. to render a qualifier in the user interface
  1020. * if necessary). It can't be used to re-infer a hierarchy for the document
  1021. * symbols.
  1022. */
  1023. String containerName;
  1024. _FORCE_INLINE_ Dictionary to_json() const {
  1025. Dictionary dict;
  1026. dict["name"] = name;
  1027. dict["kind"] = kind;
  1028. dict["deprecated"] = deprecated;
  1029. dict["location"] = location.to_json();
  1030. dict["containerName"] = containerName;
  1031. return dict;
  1032. }
  1033. };
  1034. struct DocumentedSymbolInformation : public SymbolInformation {
  1035. /**
  1036. * A human-readable string with additional information
  1037. */
  1038. String detail;
  1039. /**
  1040. * A human-readable string that represents a doc-comment.
  1041. */
  1042. String documentation;
  1043. };
  1044. /**
  1045. * Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be
  1046. * hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range,
  1047. * e.g. the range of an identifier.
  1048. */
  1049. struct DocumentSymbol {
  1050. /**
  1051. * The name of this symbol. Will be displayed in the user interface and therefore must not be
  1052. * an empty string or a string only consisting of white spaces.
  1053. */
  1054. String name;
  1055. /**
  1056. * More detail for this symbol, e.g the signature of a function.
  1057. */
  1058. String detail;
  1059. /**
  1060. * Documentation for this symbol
  1061. */
  1062. String documentation;
  1063. /**
  1064. * Class name for the native symbols
  1065. */
  1066. String native_class;
  1067. /**
  1068. * The kind of this symbol.
  1069. */
  1070. int kind = SymbolKind::File;
  1071. /**
  1072. * Indicates if this symbol is deprecated.
  1073. */
  1074. bool deprecated = false;
  1075. /**
  1076. * The range enclosing this symbol not including leading/trailing whitespace but everything else
  1077. * like comments. This information is typically used to determine if the clients cursor is
  1078. * inside the symbol to reveal in the symbol in the UI.
  1079. */
  1080. Range range;
  1081. /**
  1082. * The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
  1083. * Must be contained by the `range`.
  1084. */
  1085. Range selectionRange;
  1086. DocumentUri uri;
  1087. String script_path;
  1088. /**
  1089. * Children of this symbol, e.g. properties of a class.
  1090. */
  1091. Vector<DocumentSymbol> children;
  1092. Dictionary to_json(bool with_doc = false) const {
  1093. Dictionary dict;
  1094. dict["name"] = name;
  1095. dict["detail"] = detail;
  1096. dict["kind"] = kind;
  1097. dict["deprecated"] = deprecated;
  1098. dict["range"] = range.to_json();
  1099. dict["selectionRange"] = selectionRange.to_json();
  1100. if (with_doc) {
  1101. dict["documentation"] = documentation;
  1102. dict["native_class"] = native_class;
  1103. }
  1104. Array arr;
  1105. arr.resize(children.size());
  1106. for (int i = 0; i < children.size(); i++) {
  1107. arr[i] = children[i].to_json(with_doc);
  1108. }
  1109. dict["children"] = arr;
  1110. return dict;
  1111. }
  1112. void symbol_tree_as_list(const String &p_uri, Vector<DocumentedSymbolInformation> &r_list, const String &p_container = "", bool p_join_name = false) const {
  1113. DocumentedSymbolInformation si;
  1114. if (p_join_name && !p_container.is_empty()) {
  1115. si.name = p_container + ">" + name;
  1116. } else {
  1117. si.name = name;
  1118. }
  1119. si.kind = kind;
  1120. si.containerName = p_container;
  1121. si.deprecated = deprecated;
  1122. si.location.uri = p_uri;
  1123. si.location.range = range;
  1124. si.detail = detail;
  1125. si.documentation = documentation;
  1126. r_list.push_back(si);
  1127. for (int i = 0; i < children.size(); i++) {
  1128. children[i].symbol_tree_as_list(p_uri, r_list, si.name, p_join_name);
  1129. }
  1130. }
  1131. _FORCE_INLINE_ MarkupContent render() const {
  1132. MarkupContent markdown;
  1133. if (detail.length()) {
  1134. markdown.value = "\t" + detail + "\n\n";
  1135. }
  1136. if (documentation.length()) {
  1137. markdown.value += marked_documentation(documentation) + "\n\n";
  1138. }
  1139. if (script_path.length()) {
  1140. markdown.value += "Defined in [" + script_path + "](" + uri + ")";
  1141. }
  1142. return markdown;
  1143. }
  1144. _FORCE_INLINE_ CompletionItem make_completion_item(bool resolved = false) const {
  1145. lsp::CompletionItem item;
  1146. item.label = name;
  1147. if (resolved) {
  1148. item.documentation = render();
  1149. }
  1150. switch (kind) {
  1151. case lsp::SymbolKind::Enum:
  1152. item.kind = lsp::CompletionItemKind::Enum;
  1153. break;
  1154. case lsp::SymbolKind::Class:
  1155. item.kind = lsp::CompletionItemKind::Class;
  1156. break;
  1157. case lsp::SymbolKind::Property:
  1158. item.kind = lsp::CompletionItemKind::Property;
  1159. break;
  1160. case lsp::SymbolKind::Method:
  1161. case lsp::SymbolKind::Function:
  1162. item.kind = lsp::CompletionItemKind::Method;
  1163. break;
  1164. case lsp::SymbolKind::Event:
  1165. item.kind = lsp::CompletionItemKind::Event;
  1166. break;
  1167. case lsp::SymbolKind::Constant:
  1168. item.kind = lsp::CompletionItemKind::Constant;
  1169. break;
  1170. case lsp::SymbolKind::Variable:
  1171. item.kind = lsp::CompletionItemKind::Variable;
  1172. break;
  1173. case lsp::SymbolKind::File:
  1174. item.kind = lsp::CompletionItemKind::File;
  1175. break;
  1176. default:
  1177. item.kind = lsp::CompletionItemKind::Text;
  1178. break;
  1179. }
  1180. return item;
  1181. }
  1182. };
  1183. struct ApplyWorkspaceEditParams {
  1184. WorkspaceEdit edit;
  1185. Dictionary to_json() {
  1186. Dictionary dict;
  1187. dict["edit"] = edit.to_json();
  1188. return dict;
  1189. }
  1190. };
  1191. struct NativeSymbolInspectParams {
  1192. String native_class;
  1193. String symbol_name;
  1194. void load(const Dictionary &p_params) {
  1195. native_class = p_params["native_class"];
  1196. symbol_name = p_params["symbol_name"];
  1197. }
  1198. };
  1199. /**
  1200. * Enum of known range kinds
  1201. */
  1202. namespace FoldingRangeKind {
  1203. /**
  1204. * Folding range for a comment
  1205. */
  1206. static const String Comment = "comment";
  1207. /**
  1208. * Folding range for a imports or includes
  1209. */
  1210. static const String Imports = "imports";
  1211. /**
  1212. * Folding range for a region (e.g. `#region`)
  1213. */
  1214. static const String Region = "region";
  1215. } // namespace FoldingRangeKind
  1216. /**
  1217. * Represents a folding range.
  1218. */
  1219. struct FoldingRange {
  1220. /**
  1221. * The zero-based line number from where the folded range starts.
  1222. */
  1223. int startLine = 0;
  1224. /**
  1225. * The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
  1226. */
  1227. int startCharacter = 0;
  1228. /**
  1229. * The zero-based line number where the folded range ends.
  1230. */
  1231. int endLine = 0;
  1232. /**
  1233. * The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
  1234. */
  1235. int endCharacter = 0;
  1236. /**
  1237. * Describes the kind of the folding range such as `comment' or 'region'. The kind
  1238. * is used to categorize folding ranges and used by commands like 'Fold all comments'. See
  1239. * [FoldingRangeKind](#FoldingRangeKind) for an enumeration of standardized kinds.
  1240. */
  1241. String kind = FoldingRangeKind::Region;
  1242. _FORCE_INLINE_ Dictionary to_json() const {
  1243. Dictionary dict;
  1244. dict["startLine"] = startLine;
  1245. dict["startCharacter"] = startCharacter;
  1246. dict["endLine"] = endLine;
  1247. dict["endCharacter"] = endCharacter;
  1248. return dict;
  1249. }
  1250. };
  1251. // Use namespace instead of enumeration to follow the LSP specifications
  1252. /**
  1253. * How a completion was triggered
  1254. */
  1255. namespace CompletionTriggerKind {
  1256. /**
  1257. * Completion was triggered by typing an identifier (24x7 code
  1258. * complete), manual invocation (e.g Ctrl+Space) or via API.
  1259. */
  1260. static const int Invoked = 1;
  1261. /**
  1262. * Completion was triggered by a trigger character specified by
  1263. * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
  1264. */
  1265. static const int TriggerCharacter = 2;
  1266. /**
  1267. * Completion was re-triggered as the current completion list is incomplete.
  1268. */
  1269. static const int TriggerForIncompleteCompletions = 3;
  1270. } // namespace CompletionTriggerKind
  1271. /**
  1272. * Contains additional information about the context in which a completion request is triggered.
  1273. */
  1274. struct CompletionContext {
  1275. /**
  1276. * How the completion was triggered.
  1277. */
  1278. int triggerKind = CompletionTriggerKind::TriggerCharacter;
  1279. /**
  1280. * The trigger character (a single character) that has trigger code complete.
  1281. * Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
  1282. */
  1283. String triggerCharacter;
  1284. void load(const Dictionary &p_params) {
  1285. triggerKind = int(p_params["triggerKind"]);
  1286. triggerCharacter = p_params["triggerCharacter"];
  1287. }
  1288. };
  1289. struct CompletionParams : public TextDocumentPositionParams {
  1290. /**
  1291. * The completion context. This is only available if the client specifies
  1292. * to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
  1293. */
  1294. CompletionContext context;
  1295. void load(const Dictionary &p_params) {
  1296. TextDocumentPositionParams::load(p_params);
  1297. context.load(p_params["context"]);
  1298. }
  1299. };
  1300. /**
  1301. * The result of a hover request.
  1302. */
  1303. struct Hover {
  1304. /**
  1305. * The hover's content
  1306. */
  1307. MarkupContent contents;
  1308. /**
  1309. * An optional range is a range inside a text document
  1310. * that is used to visualize a hover, e.g. by changing the background color.
  1311. */
  1312. Range range;
  1313. _FORCE_INLINE_ Dictionary to_json() const {
  1314. Dictionary dict;
  1315. dict["range"] = range.to_json();
  1316. dict["contents"] = contents.to_json();
  1317. return dict;
  1318. }
  1319. };
  1320. /**
  1321. * Represents a parameter of a callable-signature. A parameter can
  1322. * have a label and a doc-comment.
  1323. */
  1324. struct ParameterInformation {
  1325. /**
  1326. * The label of this parameter information.
  1327. *
  1328. * Either a string or an inclusive start and exclusive end offsets within its containing
  1329. * signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
  1330. * string representation as `Position` and `Range` does.
  1331. *
  1332. * *Note*: a label of type string should be a substring of its containing signature label.
  1333. * Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
  1334. */
  1335. String label;
  1336. /**
  1337. * The human-readable doc-comment of this parameter. Will be shown
  1338. * in the UI but can be omitted.
  1339. */
  1340. MarkupContent documentation;
  1341. Dictionary to_json() const {
  1342. Dictionary dict;
  1343. dict["label"] = label;
  1344. dict["documentation"] = documentation.to_json();
  1345. return dict;
  1346. }
  1347. };
  1348. /**
  1349. * Represents the signature of something callable. A signature
  1350. * can have a label, like a function-name, a doc-comment, and
  1351. * a set of parameters.
  1352. */
  1353. struct SignatureInformation {
  1354. /**
  1355. * The label of this signature. Will be shown in
  1356. * the UI.
  1357. */
  1358. String label;
  1359. /**
  1360. * The human-readable doc-comment of this signature. Will be shown
  1361. * in the UI but can be omitted.
  1362. */
  1363. MarkupContent documentation;
  1364. /**
  1365. * The parameters of this signature.
  1366. */
  1367. Vector<ParameterInformation> parameters;
  1368. Dictionary to_json() const {
  1369. Dictionary dict;
  1370. dict["label"] = label;
  1371. dict["documentation"] = documentation.to_json();
  1372. Array args;
  1373. for (int i = 0; i < parameters.size(); i++) {
  1374. args.push_back(parameters[i].to_json());
  1375. }
  1376. dict["parameters"] = args;
  1377. return dict;
  1378. }
  1379. };
  1380. /**
  1381. * Signature help represents the signature of something
  1382. * callable. There can be multiple signature but only one
  1383. * active and only one active parameter.
  1384. */
  1385. struct SignatureHelp {
  1386. /**
  1387. * One or more signatures.
  1388. */
  1389. Vector<SignatureInformation> signatures;
  1390. /**
  1391. * The active signature. If omitted or the value lies outside the
  1392. * range of `signatures` the value defaults to zero or is ignored if
  1393. * `signatures.length === 0`. Whenever possible implementors should
  1394. * make an active decision about the active signature and shouldn't
  1395. * rely on a default value.
  1396. * In future version of the protocol this property might become
  1397. * mandatory to better express this.
  1398. */
  1399. int activeSignature = 0;
  1400. /**
  1401. * The active parameter of the active signature. If omitted or the value
  1402. * lies outside the range of `signatures[activeSignature].parameters`
  1403. * defaults to 0 if the active signature has parameters. If
  1404. * the active signature has no parameters it is ignored.
  1405. * In future version of the protocol this property might become
  1406. * mandatory to better express the active parameter if the
  1407. * active signature does have any.
  1408. */
  1409. int activeParameter = 0;
  1410. Dictionary to_json() const {
  1411. Dictionary dict;
  1412. Array sigs;
  1413. for (int i = 0; i < signatures.size(); i++) {
  1414. sigs.push_back(signatures[i].to_json());
  1415. }
  1416. dict["signatures"] = sigs;
  1417. dict["activeSignature"] = activeSignature;
  1418. dict["activeParameter"] = activeParameter;
  1419. return dict;
  1420. }
  1421. };
  1422. /**
  1423. * A pattern to describe in which file operation requests or notifications
  1424. * the server is interested in.
  1425. */
  1426. struct FileOperationPattern {
  1427. /**
  1428. * The glob pattern to match.
  1429. */
  1430. String glob = "**/*.gd";
  1431. /**
  1432. * Whether to match `file`s or `folder`s with this pattern.
  1433. *
  1434. * Matches both if undefined.
  1435. */
  1436. String matches = "file";
  1437. Dictionary to_json() const {
  1438. Dictionary dict;
  1439. dict["glob"] = glob;
  1440. dict["matches"] = matches;
  1441. return dict;
  1442. }
  1443. };
  1444. /**
  1445. * A filter to describe in which file operation requests or notifications
  1446. * the server is interested in.
  1447. */
  1448. struct FileOperationFilter {
  1449. /**
  1450. * The actual file operation pattern.
  1451. */
  1452. FileOperationPattern pattern;
  1453. Dictionary to_json() const {
  1454. Dictionary dict;
  1455. dict["pattern"] = pattern.to_json();
  1456. return dict;
  1457. }
  1458. };
  1459. /**
  1460. * The options to register for file operations.
  1461. */
  1462. struct FileOperationRegistrationOptions {
  1463. /**
  1464. * The actual filters.
  1465. */
  1466. Vector<FileOperationFilter> filters;
  1467. FileOperationRegistrationOptions() {
  1468. filters.push_back(FileOperationFilter());
  1469. }
  1470. Dictionary to_json() const {
  1471. Dictionary dict;
  1472. Array filts;
  1473. for (int i = 0; i < filters.size(); i++) {
  1474. filts.push_back(filters[i].to_json());
  1475. }
  1476. dict["filters"] = filts;
  1477. return dict;
  1478. }
  1479. };
  1480. /**
  1481. * The server is interested in file notifications/requests.
  1482. */
  1483. struct FileOperations {
  1484. /**
  1485. * The server is interested in receiving didDeleteFiles file notifications.
  1486. */
  1487. FileOperationRegistrationOptions didDelete;
  1488. Dictionary to_json() const {
  1489. Dictionary dict;
  1490. dict["didDelete"] = didDelete.to_json();
  1491. return dict;
  1492. }
  1493. };
  1494. /**
  1495. * Workspace specific server capabilities
  1496. */
  1497. struct Workspace {
  1498. /**
  1499. * The server is interested in file notifications/requests.
  1500. */
  1501. FileOperations fileOperations;
  1502. Dictionary to_json() const {
  1503. Dictionary dict;
  1504. dict["fileOperations"] = fileOperations.to_json();
  1505. return dict;
  1506. }
  1507. };
  1508. struct ServerCapabilities {
  1509. /**
  1510. * Defines how text documents are synced. Is either a detailed structure defining each notification or
  1511. * for backwards compatibility the TextDocumentSyncKind number. If omitted it defaults to `TextDocumentSyncKind.None`.
  1512. */
  1513. TextDocumentSyncOptions textDocumentSync;
  1514. /**
  1515. * The server provides hover support.
  1516. */
  1517. bool hoverProvider = true;
  1518. /**
  1519. * The server provides completion support.
  1520. */
  1521. CompletionOptions completionProvider;
  1522. /**
  1523. * The server provides signature help support.
  1524. */
  1525. SignatureHelpOptions signatureHelpProvider;
  1526. /**
  1527. * The server provides goto definition support.
  1528. */
  1529. bool definitionProvider = true;
  1530. /**
  1531. * The server provides Goto Type Definition support.
  1532. *
  1533. * Since 3.6.0
  1534. */
  1535. bool typeDefinitionProvider = false;
  1536. /**
  1537. * The server provides Goto Implementation support.
  1538. *
  1539. * Since 3.6.0
  1540. */
  1541. bool implementationProvider = false;
  1542. /**
  1543. * The server provides find references support.
  1544. */
  1545. bool referencesProvider = false;
  1546. /**
  1547. * The server provides document highlight support.
  1548. */
  1549. bool documentHighlightProvider = false;
  1550. /**
  1551. * The server provides document symbol support.
  1552. */
  1553. bool documentSymbolProvider = true;
  1554. /**
  1555. * The server provides workspace symbol support.
  1556. */
  1557. bool workspaceSymbolProvider = true;
  1558. /**
  1559. * The server supports workspace folder.
  1560. */
  1561. Workspace workspace;
  1562. /**
  1563. * The server provides code actions. The `CodeActionOptions` return type is only
  1564. * valid if the client signals code action literal support via the property
  1565. * `textDocument.codeAction.codeActionLiteralSupport`.
  1566. */
  1567. bool codeActionProvider = false;
  1568. /**
  1569. * The server provides code lens.
  1570. */
  1571. CodeLensOptions codeLensProvider;
  1572. /**
  1573. * The server provides document formatting.
  1574. */
  1575. bool documentFormattingProvider = false;
  1576. /**
  1577. * The server provides document range formatting.
  1578. */
  1579. bool documentRangeFormattingProvider = false;
  1580. /**
  1581. * The server provides document formatting on typing.
  1582. */
  1583. DocumentOnTypeFormattingOptions documentOnTypeFormattingProvider;
  1584. /**
  1585. * The server provides rename support. RenameOptions may only be
  1586. * specified if the client states that it supports
  1587. * `prepareSupport` in its initial `initialize` request.
  1588. */
  1589. RenameOptions renameProvider;
  1590. /**
  1591. * The server provides document link support.
  1592. */
  1593. DocumentLinkOptions documentLinkProvider;
  1594. /**
  1595. * The server provides color provider support.
  1596. *
  1597. * Since 3.6.0
  1598. */
  1599. ColorProviderOptions colorProvider;
  1600. /**
  1601. * The server provides folding provider support.
  1602. *
  1603. * Since 3.10.0
  1604. */
  1605. FoldingRangeProviderOptions foldingRangeProvider;
  1606. /**
  1607. * The server provides go to declaration support.
  1608. *
  1609. * Since 3.14.0
  1610. */
  1611. bool declarationProvider = true;
  1612. /**
  1613. * The server provides execute command support.
  1614. */
  1615. ExecuteCommandOptions executeCommandProvider;
  1616. _FORCE_INLINE_ Dictionary to_json() {
  1617. Dictionary dict;
  1618. dict["textDocumentSync"] = textDocumentSync.to_json();
  1619. dict["completionProvider"] = completionProvider.to_json();
  1620. signatureHelpProvider.triggerCharacters.push_back(",");
  1621. signatureHelpProvider.triggerCharacters.push_back("(");
  1622. dict["signatureHelpProvider"] = signatureHelpProvider.to_json();
  1623. //dict["codeLensProvider"] = codeLensProvider.to_json();
  1624. dict["documentOnTypeFormattingProvider"] = documentOnTypeFormattingProvider.to_json();
  1625. dict["renameProvider"] = renameProvider.to_json();
  1626. dict["documentLinkProvider"] = documentLinkProvider.to_json();
  1627. dict["colorProvider"] = false; // colorProvider.to_json();
  1628. dict["foldingRangeProvider"] = false; //foldingRangeProvider.to_json();
  1629. dict["executeCommandProvider"] = executeCommandProvider.to_json();
  1630. dict["hoverProvider"] = hoverProvider;
  1631. dict["definitionProvider"] = definitionProvider;
  1632. dict["typeDefinitionProvider"] = typeDefinitionProvider;
  1633. dict["implementationProvider"] = implementationProvider;
  1634. dict["referencesProvider"] = referencesProvider;
  1635. dict["documentHighlightProvider"] = documentHighlightProvider;
  1636. dict["documentSymbolProvider"] = documentSymbolProvider;
  1637. dict["workspaceSymbolProvider"] = workspaceSymbolProvider;
  1638. dict["workspace"] = workspace.to_json();
  1639. dict["codeActionProvider"] = codeActionProvider;
  1640. dict["documentFormattingProvider"] = documentFormattingProvider;
  1641. dict["documentRangeFormattingProvider"] = documentRangeFormattingProvider;
  1642. dict["declarationProvider"] = declarationProvider;
  1643. return dict;
  1644. }
  1645. };
  1646. struct InitializeResult {
  1647. /**
  1648. * The capabilities the language server provides.
  1649. */
  1650. ServerCapabilities capabilities;
  1651. _FORCE_INLINE_ Dictionary to_json() {
  1652. Dictionary dict;
  1653. dict["capabilities"] = capabilities.to_json();
  1654. return dict;
  1655. }
  1656. };
  1657. struct GodotNativeClassInfo {
  1658. String name;
  1659. const DocData::ClassDoc *class_doc = nullptr;
  1660. const ClassDB::ClassInfo *class_info = nullptr;
  1661. Dictionary to_json() {
  1662. Dictionary dict;
  1663. dict["name"] = name;
  1664. dict["inherits"] = class_doc->inherits;
  1665. return dict;
  1666. }
  1667. };
  1668. /** Features not included in the standard lsp specifications */
  1669. struct GodotCapabilities {
  1670. /**
  1671. * Native class list
  1672. */
  1673. List<GodotNativeClassInfo> native_classes;
  1674. Dictionary to_json() {
  1675. Dictionary dict;
  1676. Array classes;
  1677. for (List<GodotNativeClassInfo>::Element *E = native_classes.front(); E; E = E->next()) {
  1678. classes.push_back(E->get().to_json());
  1679. }
  1680. dict["native_classes"] = classes;
  1681. return dict;
  1682. }
  1683. };
  1684. /** Format BBCode documentation from DocData to markdown */
  1685. static String marked_documentation(const String &p_bbcode) {
  1686. String markdown = p_bbcode.strip_edges();
  1687. Vector<String> lines = markdown.split("\n");
  1688. bool in_code_block = false;
  1689. int code_block_indent = -1;
  1690. markdown = "";
  1691. for (int i = 0; i < lines.size(); i++) {
  1692. String line = lines[i];
  1693. int block_start = line.find("[codeblock]");
  1694. if (block_start != -1) {
  1695. code_block_indent = block_start;
  1696. in_code_block = true;
  1697. line = "\n";
  1698. } else if (in_code_block) {
  1699. line = "\t" + line.substr(code_block_indent, line.length());
  1700. }
  1701. if (in_code_block && line.contains("[/codeblock]")) {
  1702. line = "\n";
  1703. in_code_block = false;
  1704. }
  1705. if (!in_code_block) {
  1706. line = line.strip_edges();
  1707. line = line.replace("[code]", "`");
  1708. line = line.replace("[/code]", "`");
  1709. line = line.replace("[i]", "*");
  1710. line = line.replace("[/i]", "*");
  1711. line = line.replace("[b]", "**");
  1712. line = line.replace("[/b]", "**");
  1713. line = line.replace("[u]", "__");
  1714. line = line.replace("[/u]", "__");
  1715. line = line.replace("[method ", "`");
  1716. line = line.replace("[member ", "`");
  1717. line = line.replace("[signal ", "`");
  1718. line = line.replace("[enum ", "`");
  1719. line = line.replace("[constant ", "`");
  1720. line = line.replace("[", "`");
  1721. line = line.replace("]", "`");
  1722. }
  1723. if (!in_code_block && i < lines.size() - 1) {
  1724. line += "\n\n";
  1725. } else if (i < lines.size() - 1) {
  1726. line += "\n";
  1727. }
  1728. markdown += line;
  1729. }
  1730. return markdown;
  1731. }
  1732. } // namespace lsp
  1733. #endif