3 * Copyright 2017-2019 Ben Iofel <ben@iofel.me>
4 * Copyright 2017-2020 Princeton Ferro <princetonferro@gmail.com>
5 * Copyright 2020 Sergii Fesenko <s.fesenko@outlook.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation, either version 2.1 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * Defines how the host (editor) should sync document changes to the language server.
25 [CCode (default_value = "LSP_TEXT_DOCUMENT_SYNC_KIND_Unset")]
26 public enum TextDocumentSyncKind {
29 * Documents should not be synced at all.
33 * Documents are synced by always sending the full content of the document.
37 * Documents are synced by sending the full content on open. After that only incremental
38 * updates to the document are sent.
43 public enum DiagnosticSeverity {
54 * Reports an information.
64 public class Position : Object, Gee.Comparable<Position> {
66 * Line position in a document (zero-based).
68 public uint line { get; set; default = -1; }
71 * Character offset on a line in a document (zero-based). Assuming that the line is
72 * represented as a string, the `character` value represents the gap between the
73 * `character` and `character + 1`.
75 * If the character value is greater than the line length it defaults back to the
78 public uint character { get; set; default = -1; }
80 public int compare_to (Position other) {
81 return line > other.line ? 1 :
83 (character > other.character ? 1 :
84 (character == other.character ? 0 : -1)) : -1);
86 public bool equals(Position o) {
87 return o.line == this.line && o.character == this.character;
90 public string to_string () {
91 return @"$line:$character";
94 public Position.from_libvala (Vala.SourceLocation sloc) {
96 character = sloc.column;
99 public Position dup () {
100 return this.translate ();
103 public Position translate (int dl = 0, int dc = 0) {
104 return new Position () {
105 line = this.line + dl,
106 character = this.character + dc
111 public class Range : Object, Gee.Hashable<Range>, Gee.Comparable<Range> {
113 public Range.simple(uint line, uint pos) {
114 var p = new Position () {
123 * The range's start position.
125 public Position start { get; set; }
128 * The range's end position.
130 public Position end { get; set; }
132 private string? filename;
134 public string to_string () { return (filename != null ? @"$filename:" : "") + @"$start -> $end"; }
136 public Range.from_pos (Position pos) {
138 this.end = pos.dup ();
141 public Range.from_sourceref (Vala.SourceReference sref) {
142 this.start = new Position.from_libvala (sref.begin);
143 this.end = new Position.from_libvala (sref.end);
144 this.start.character -= 1;
145 this.filename = sref.file.filename;
148 public uint hash () {
149 return this.to_string ().hash ();
152 public bool equal_to (Range other) { return this.to_string () == other.to_string (); }
153 public bool equals (Range o) {
154 return this.filename == o.filename && this.start.equals(o.start) && this.end.equals(o.end);
157 public int compare_to (Range other) {
158 return start.compare_to (other.start);
162 * Return a new range that includes `this` and `other`.
164 public Range union (Range other) {
165 var range = new Range () {
166 start = start.compare_to (other.start) < 0 ? start : other.start,
167 end = end.compare_to (other.end) < 0 ? other.end : end,
169 if (filename == other.filename)
170 range.filename = filename;
174 public bool contains (Position pos) {
175 return start.compare_to (pos) <= 0 && pos.compare_to (end) <= 0;
180 public class Diagnostic : Object {
182 public Diagnostic.simple ( int line, int character, string message)
184 this.message = message;
185 this.severity = DiagnosticSeverity.Error;
186 this.range = new Range.simple(line, character );
192 * The range at which the message applies.
194 public Range range { get; set; }
197 * The diagnostic's severity. Can be omitted. If omitted it is up to the
198 * client to interpret diagnostics as error, warning, info or hint.
200 public DiagnosticSeverity severity { get; set; }
203 * The diagnostic's code. Can be omitted.
205 public string? code { get; set; }
208 * A human-readable string describing the source of this
209 * diagnostic, e.g. 'typescript' or 'super lint'.
211 public string? source { get; set; }
214 * The diagnostic's message.
216 public string message { get; set; }
219 public string category {
221 switch(this.severity) {
223 case DiagnosticSeverity.Error :
225 case DiagnosticSeverity.Warning :
226 return this.message.contains("deprecated") ? "DEPR" : "WARN";
234 public bool equals(Lsp.Diagnostic o) {
235 var ret = this.range.equals(o.range) && this.severity == o.severity && this.message == o.message;
236 //GLib.debug("compare %s (%s == %s)", ret ? "YES" : "NO", this.to_string(), o.to_string());
241 public string to_string()
243 return "%s : %d - %s".printf(this.category, (int) this.range.start.line , this.message);
249 * An event describing a change to a text document. If range and rangeLength are omitted
250 * the new text is considered to be the full content of the document.
252 public class TextDocumentContentChangeEvent : Object {
253 public Range? range { get; set; }
254 public int rangeLength { get; set; }
255 public string text { get; set; }
258 public enum MessageType {
268 * An information message.
277 public class TextDocumentIdentifier : Object {
278 public string uri { get; set; }
281 public class VersionedTextDocumentIdentifier : TextDocumentIdentifier {
283 * The version number of this document. If a versioned text document identifier
284 * is sent from the server to the client and the file is not open in the editor
285 * (the server has not received an open notification before) the server can send
286 * `null` to indicate that the version is known and the content on disk is the
287 * master (as speced with document content ownership).
289 * The version number of a document will increase after each change, including
290 * undo/redo. The number doesn't need to be consecutive.
292 public int version { get; set; default = -1; }
295 public class TextDocumentPositionParams : Object {
296 public TextDocumentIdentifier textDocument { get; set; }
297 public Position position { get; set; }
300 public class ReferenceParams : TextDocumentPositionParams {
301 public class ReferenceContext : Object {
302 public bool includeDeclaration { get; set; }
304 public ReferenceContext? context { get; set; }
307 public class Location : Object {
308 public string uri { get; set; }
309 public Range range { get; set; }
311 public Location.from_sourceref (Vala.SourceReference sref) {
312 this (sref.file.filename, new Range.from_sourceref (sref));
315 public Location (string filename, Range range) {
316 this.uri = File.new_for_commandline_arg (filename).get_uri ();
321 [CCode (default_value = "LSP_DOCUMENT_HIGHLIGHT_KIND_Text")]
322 public enum DocumentHighlightKind {
328 public class DocumentHighlight : Object {
329 public Range range { get; set; }
330 public DocumentHighlightKind kind { get; set; }
333 public class DocumentSymbolParams: Object {
334 public TextDocumentIdentifier textDocument { get; set; }
337 public class DocumentSymbol : Object, Json.Serializable {
338 private Vala.SourceReference? _source_reference;
339 public string name { get; set; }
340 public string? detail { get; set; }
341 public SymbolKind kind { get; set; }
342 public bool deprecated { get; set; }
344 public Range range { get; set; }
345 public Range selectionRange { get; set; }
346 public GLib.ListStore children { get; set; default = new GLib.ListStore(typeof(DocumentSymbol)); }
347 public string? parent_name;
349 private DocumentSymbol () {}
352 * @param type the data type containing this symbol, if there was one (not available for Namespaces, for example)
353 * @param sym the symbol
356 public DocumentSymbol.from_vala_symbol (Vala.DataType? type, Vala.Symbol sym, SymbolKind kind) {
357 this.parent_name = sym.parent_symbol != null ? sym.parent_symbol.name : null;
358 this._initial_range = new Range.from_sourceref (sym.source_reference);
359 if (sym is Vala.Subroutine) {
360 var sub = (Vala.Subroutine) sym;
361 var body_sref = sub.body != null ? sub.body.source_reference : null;
362 // debug ("subroutine %s found (body @ %s)", sym.get_full_name (),
363 // body_sref != null ? body_sref.to_string () : null);
364 if (body_sref != null && (body_sref.begin.line < body_sref.end.line ||
365 val = GLib.Value (typeof(Gee.ArrayList)); body_sref.begin.line == body_sref.end.line && body_sref.begin.pos <= body_sref.end.pos)) {
366 this._initial_range = this._initial_range.union (new Range.from_sourceref (body_sref));
369 this.name = sym.name;
370 this.detail = Vls.CodeHelp.get_symbol_representation (type, sym, null, false);
372 this.selectionRange = new Range.from_sourceref (sym.source_reference);
373 this.deprecated = sym.version.deprecated;
376 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
377 base.set_property (pspec.get_name (), value);
380 public new Value Json.Serializable.get_property (ParamSpec pspec) {
381 Value val = Value (pspec.value_type);
382 base.get_property (pspec.get_name (), ref val);
386 public unowned ParamSpec? find_property (string name) {
387 return this.get_class ().find_property (name);
390 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
391 // if (property_name != "children")
392 return default_serialize_property (property_name, value, pspec);
393 /*var node = new Json.Node (Json.NodeType.ARRAY);
394 node.init_array (new Json.Array ());
395 var array = node.get_array ();
396 foreach (var child in children)
397 array.add_element (Json.gobject_serialize (child));
402 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
404 GLib.debug("deserialise property %s" , property_name);
405 if (property_name != "children") {
406 return default_deserialize_property (property_name, out value, pspec, property_node);
408 value = GLib.Value (typeof(GLib.ListStore));
409 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
410 GLib.debug ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
413 GLib.debug("got child length of %d", (int) property_node.get_array ().get_length());
414 var arguments = new GLib.ListStore(typeof(DocumentSymbol));
416 property_node.get_array ().foreach_element ((array, index, element) => {
418 var add= Json.gobject_deserialize ( typeof (DocumentSymbol), array.get_element(index)) as DocumentSymbol;
419 arguments.append( add);
424 value.set_object (arguments);
427 public string symbol_icon {
433 case Lsp.CompletionItemKind.Text: return "completion-snippet-symbolic"
434 case Lsp.CompletionItemKind.Method: return "lang-method-symbolic";
435 case Lsp.CompletionItemKind.Function: return "lang-function-symbolic";
436 case Lsp.CompletionItemKind.Constructor: return "lang-method-symbolic";
437 case Lsp.CompletionItemKind.Field: return "lang-struct-field-symbolic";
438 case Lsp.CompletionItemKind.Variable: return "lang-variable-symbolic";
439 case Lsp.CompletionItemKind.Class: return "lang-class-symbolic";
440 case Lsp.CompletionItemKind.Interface: return "lang-class-symbolic";
441 case Lsp.CompletionItemKind.Module: return "lang-namespace-symbolic";
442 case Lsp.CompletionItemKind.Property:return "lang-struct-field-symbolic";
443 case Lsp.CompletionItemKind.Unit: return "lang-variable-symbolic";
444 case Lsp.CompletionItemKind.Value: return "lang-variable-symbolic";
445 case Lsp.CompletionItemKind.Enum: return "lang-enum-symbolic";
446 case Lsp.CompletionItemKind.Keyword: return "completion-word-symbolic";
447 case Lsp.CompletionItemKind.Snippet: return "completion-snippet-symbolic";
449 case Lsp.CompletionItemKind.Color: return "lang-typedef-symbolic";
450 case Lsp.CompletionItemKind.File:return "lang-typedef-symbolic";
451 case Lsp.CompletionItemKind.Reference: return "lang-typedef-symbolic";
452 case Lsp.CompletionItemKind.Folder:return "lang-typedef-symbolic";
453 case Lsp.CompletionItemKind.EnumMember: return "lang-typedef-symbolic";
454 case Lsp.CompletionItemKind.Constant:return "lang-typedef-symbolic";
455 case Lsp.CompletionItemKind.Struct: return "lang-struct-symbolic";
456 case Lsp.CompletionItemKind.Event:return "lang-typedef-symbolic";
457 case Lsp.CompletionItemKind.Operator:return "lang-typedef-symbolic";
458 case Lsp.CompletionItemKind.TypeParameter:return "lang-typedef-symbolic";
460 return "completion-snippet-symbolic";
471 public class SymbolInformation : Object {
472 public string name { get; set; }
473 public SymbolKind kind { get; set; }
474 public Location location { get; set; }
475 public string? containerName { get; set; }
477 public SymbolInformation.from_document_symbol (DocumentSymbol dsym, string uri) {
478 this.name = dsym.name;
479 this.kind = dsym.kind;
480 // this.location = new Location (uri, dsym.range);
481 this.containerName = dsym.parent_name;
485 [CCode (default_value = "LSP_SYMBOL_KIND_Variable")]
486 public enum SymbolKind {
515 public class CompletionList : Object, Json.Serializable {
516 public bool isIncomplete { get; set; }
517 public Gee.List<CompletionItem> items { get; private set; default = new Gee.LinkedList<CompletionItem> (); }
519 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
520 base.set_property (pspec.get_name (), value);
523 public new Value Json.Serializable.get_property (ParamSpec pspec) {
524 Value val = Value(pspec.value_type);
525 base.get_property (pspec.get_name (), ref val);
529 public unowned ParamSpec? find_property (string name) {
530 return this.get_class ().find_property (name);
533 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
534 if (property_name != "items")
535 return default_serialize_property (property_name, value, pspec);
536 var node = new Json.Node (Json.NodeType.ARRAY);
537 node.init_array (new Json.Array ());
538 var array = node.get_array ();
539 foreach (var child in items)
540 array.add_element (Json.gobject_serialize (child));
544 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
545 error ("deserialization not supported");
549 [CCode (default_value = "LSP_COMPLETION_TRIGGER_KIND_Invoked")]
550 public enum CompletionTriggerKind {
552 * Completion was triggered by typing an identifier (24x7 code
553 * complete), manual invocation (e.g Ctrl+Space) or via API.
558 * Completion was triggered by a trigger character specified by
559 * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
561 TriggerCharacter = 2,
564 * Completion was re-triggered as the current completion list is incomplete.
566 TriggerForIncompleteCompletions = 3
569 public class CompletionContext : Object {
570 public CompletionTriggerKind triggerKind { get; set;}
571 public string? triggerCharacter { get; set; }
574 public class CompletionParams : TextDocumentPositionParams {
576 * The completion context. This is only available if the client specifies
577 * to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
579 public CompletionContext? context { get; set; }
582 public enum CompletionItemTag {
583 // Render a completion as obsolete, usually using a strike-out.
587 [CCode (default_value = "LSP_INSERT_TEXT_FORMAT_PlainText")]
588 public enum InsertTextFormat {
590 * The primary text to be inserted is treated as a plain string.
595 * The primary text to be inserted is treated as a snippet.
597 * A snippet can define tab stops and placeholders with `$1`, `$2`
598 * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
599 * the end of the snippet. Placeholders with equal identifiers are linked,
600 * that is typing in one will update others too.
605 public class CompletionItem : Object, Gee.Hashable<CompletionItem>, Json.Serializable {
606 public string label { get; set; }
607 public CompletionItemKind kind { get; set; }
608 public string detail { get; set; }
609 public MarkupContent? documentation { get; set; }
610 public bool deprecated { get; set; }
611 public Gee.List<CompletionItemTag> tags { get; private set; default = new Gee.ArrayList<CompletionItemTag> (); }
612 public string? insertText { get; set; }
613 public InsertTextFormat insertTextFormat { get; set; default = InsertTextFormat.PlainText; }
616 private CompletionItem () {}
618 public CompletionItem.keyword (string keyword, string? insert_text = null, string? documentation = null) {
619 this.label = keyword;
620 this.kind = CompletionItemKind.Keyword;
621 this.insertText = insert_text;
622 if (insert_text != null && (insert_text.contains ("$0") || insert_text.contains ("${0")))
623 this.insertTextFormat = InsertTextFormat.Snippet;
624 if (documentation != null)
625 this.documentation = new MarkupContent.from_plaintext (documentation);
626 this._hash = @"$label $kind".hash ();
630 * A completion suggestion from an existing Vala symbol.
632 * @param instance_type the parent data type of data type of the expression where this symbol appears, or null
633 * @param sym the symbol itself
634 * @param scope the scope to display this in
635 * @param kind the kind of completion to display
636 * @param documentation the documentation to display
637 * @param label_override if non-null, override the displayed symbol name with this
640 public CompletionItem.from_symbol (Vala.DataType? instance_type, Vala.Symbol sym, Vala.Scope? scope,
641 CompletionItemKind kind,
642 Vls.DocComment? documentation, string? label_override = null) {
643 this.label = label_override ?? sym.name;
645 this.detail = Vls.CodeHelp.get_symbol_representation (instance_type, sym, scope, true, null, label_override, false);
646 this._hash = @"$label $kind".hash ();
648 if (documentation != null)
649 this.documentation = new MarkupContent.from_markdown (documentation.body);
651 var version = sym.get_attribute ("Version");
652 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
653 this.tags.add (CompletionItemTag.Deprecated);
654 this.deprecated = true;
659 * A completion suggestion from a data type and a synthetic symbol name.
661 * @param symbol_type the data type of the symbol
662 * @param symbol_name the name of the synthetic symbol
663 * @param scope the scope that this completion item is displayed in, or null
664 * @param kind the type of completion to display
665 * @param documentation the documentation for this symbol, or null
668 public CompletionItem.from_synthetic_symbol (Vala.DataType symbol_type, string symbol_name, Vala.Scope? scope,
669 CompletionItemKind kind, Vls.DocComment? documentation) {
670 this.label = symbol_name;
672 this.detail = @"$(Vls.CodeHelp.get_symbol_representation (symbol_type, null, scope, true, null, null, false)) $symbol_name";
673 this._hash = @"$label $kind".hash ();
675 if (documentation != null)
676 this.documentation = new MarkupContent.from_markdown (documentation.body);
680 public CompletionItem.from_unimplemented_symbol (Vala.Symbol sym,
681 string label, CompletionItemKind kind,
683 Vls.DocComment? documentation) {
686 this.insertText = insert_text;
687 if (insert_text.contains ("$0") || insert_text.contains ("${0"))
688 this.insertTextFormat = InsertTextFormat.Snippet;
689 this._hash = @"$label $kind".hash ();
690 if (documentation != null)
691 this.documentation = new MarkupContent.from_markdown (documentation.body);
695 public uint hash () {
699 public bool equal_to (CompletionItem other) {
700 return other.label == this.label && other.kind == this.kind;
703 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
704 base.set_property (pspec.get_name (), value);
707 public new Value Json.Serializable.get_property (ParamSpec pspec) {
708 Value val = Value(pspec.value_type);
709 base.get_property (pspec.get_name (), ref val);
713 public unowned ParamSpec? find_property (string name) {
714 return this.get_class ().find_property (name);
717 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
718 if (property_name != "tags")
719 return default_serialize_property (property_name, value, pspec);
721 var node = new Json.Node (Json.NodeType.ARRAY);
722 node.init_array (new Json.Array ());
723 var array = node.get_array ();
724 foreach (var tag in this.tags) {
725 array.add_int_element (tag);
730 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
732 if (property_name != "tags") {
733 return default_deserialize_property (property_name, out value, pspec, property_node);
735 value = GLib.Value (typeof(Gee.ArrayList));
736 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
737 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
741 var arguments = new Gee.ArrayList<CompletionItemTag>();
743 property_node.get_array ().foreach_element ((array, index, element) => {
745 arguments.add ((CompletionItemTag) Json.gvariant_deserialize (element, null).get_int32() );
747 warning ("argument %u to command could not be deserialized: %s", index, e.message);
751 value.set_object (arguments);
756 public class MarkupContent : Object {
757 public string kind { get; set; }
758 public string value { get; set; }
760 private MarkupContent () {}
763 * Create a MarkupContent with plain text.
765 public MarkupContent.from_plaintext (string doc) {
766 this.kind = "plaintext";
771 * Create a MarkupContent with markdown text.
773 public MarkupContent.from_markdown (string doc) {
774 this.kind = "markdown";
779 [CCode (default_value = "LSP_COMPLETION_ITEM_KIND_Text")]
780 public enum CompletionItemKind {
809 * Capabilities of the client/editor for `textDocument/documentSymbol`
811 public class DocumentSymbolCapabilities : Object {
812 public bool hierarchicalDocumentSymbolSupport { get; set; }
816 * Capabilities of the client/editor for `textDocument/rename`
818 public class RenameClientCapabilities : Object {
819 public bool prepareSupport { get; set; }
823 * Capabilities of the client/editor pertaining to language features.
825 public class TextDocumentClientCapabilities : Object {
826 public DocumentSymbolCapabilities documentSymbol { get; set; default = new DocumentSymbolCapabilities ();}
827 public RenameClientCapabilities rename { get; set; default = new RenameClientCapabilities (); }
831 * Capabilities of the client/editor.
833 public class ClientCapabilities : Object {
834 public TextDocumentClientCapabilities textDocument { get; set; default = new TextDocumentClientCapabilities (); }
837 public class InitializeParams : Object {
838 public int processId { get; set; }
839 public string? rootPath { get; set; }
840 public string? rootUri { get; set; }
841 public ClientCapabilities capabilities { get; set; default = new ClientCapabilities (); }
844 public class SignatureInformation : Object, Json.Serializable {
845 public string label { get; set; }
846 public MarkupContent documentation { get; set; }
848 public Gee.List<ParameterInformation> parameters { get; private set; default = new Gee.LinkedList<ParameterInformation> (); }
850 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
851 base.set_property (pspec.get_name (), value);
854 public new Value Json.Serializable.get_property (ParamSpec pspec) {
855 Value val = Value(pspec.value_type);
856 base.get_property (pspec.get_name (), ref val);
860 public unowned ParamSpec? find_property (string name) {
861 return this.get_class ().find_property (name);
864 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
865 if (property_name != "parameters")
866 return default_serialize_property (property_name, value, pspec);
867 var node = new Json.Node (Json.NodeType.ARRAY);
868 node.init_array (new Json.Array ());
869 var array = node.get_array ();
870 foreach (var child in parameters)
871 array.add_element (Json.gobject_serialize (child));
875 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
876 error ("deserialization not supported");
880 public class SignatureHelp : Object, Json.Serializable {
881 public Gee.Collection<SignatureInformation> signatures { get; set; default = new Gee.ArrayList<SignatureInformation> (); }
882 public int activeSignature { get; set; }
883 public int activeParameter { get; set; }
885 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
886 if (property_name != "signatures")
887 return default_serialize_property (property_name, value, pspec);
889 var node = new Json.Node (Json.NodeType.ARRAY);
890 node.init_array (new Json.Array ());
891 var array = node.get_array ();
892 foreach (var child in signatures)
893 array.add_element (Json.gobject_serialize (child));
897 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
898 error ("deserialization not supported");
902 public class ParameterInformation : Object {
903 public string label { get; set; }
904 public MarkupContent documentation { get; set; }
907 public class MarkedString : Object {
908 public MarkedString(string language, string value)
910 this.language = language;
912 GLib.debug("new marked string %s : %s", language, value);
914 public string language { get; set; }
915 public string value { get; set; }
918 public class Hover : Object, Json.Serializable {
919 public Gee.List<MarkedString> contents { get; set; default = new Gee.ArrayList<MarkedString> (); }
920 public Range range { get; set; }
922 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
923 base.set_property (pspec.get_name (), value);
926 public new Value Json.Serializable.get_property (ParamSpec pspec) {
927 Value val = Value(pspec.value_type);
928 base.get_property (pspec.get_name (), ref val);
932 public unowned ParamSpec? find_property (string name) {
933 return this.get_class ().find_property (name);
936 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
937 if (property_name != "contents")
938 return default_serialize_property (property_name, value, pspec);
939 var node = new Json.Node (Json.NodeType.ARRAY);
940 node.init_array (new Json.Array ());
941 var array = node.get_array ();
942 foreach (var child in contents) {
943 if (child.language != null)
944 array.add_element (Json.gobject_serialize (child));
946 array.add_element (new Json.Node (Json.NodeType.VALUE).init_string (child.value));
951 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
953 if (property_name == "contents") {
954 value = GLib.Value (typeof(Gee.ArrayList));
955 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
956 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
959 var contents = new Gee.ArrayList<MarkedString>();
961 property_node.get_array ().foreach_element ((array, index, element) => {
963 var add = new MarkedString(
964 array.get_object_element(index).get_string_member("language"),
965 array.get_object_element(index).get_string_member("value")
968 contents.add ( add );
970 warning ("argument %u to command could not be deserialized: %s", index, e.message);
973 value.set_object (contents);
977 return default_deserialize_property (property_name, out value, pspec, property_node);
982 * A textual edit applicable to a text document.
984 public class TextEdit : Object {
986 * The range of the text document to be manipulated. To insert
987 * text into a document create a range where ``start === end``.
989 public Range range { get; set; }
992 * The string to be inserted. For delete operations use an
995 public string newText { get; set; }
997 public TextEdit (Range range, string new_text = "") {
999 this.newText = new_text;
1004 * Describes textual changes on a single text document. The text document is
1005 * referred to as a {@link VersionedTextDocumentIdentifier} to allow clients to
1006 * check the text document version before an edit is applied. A
1007 * {@link TextDocumentEdit} describes all changes on a version ``Si`` and after they are
1008 * applied move the document to version ``Si+1``. So the creator of a
1009 * {@link TextDocumentEdit} doesn’t need to sort the array of edits or do any kind
1010 * of ordering. However the edits must be non overlapping.
1012 public class TextDocumentEdit : Object, Json.Serializable {
1014 * The text document to change.
1016 public VersionedTextDocumentIdentifier textDocument { get; set; }
1019 * The edits to be applied.
1021 public Gee.ArrayList<TextEdit> edits { get; set; default = new Gee.ArrayList<TextEdit> (); }
1023 public TextDocumentEdit (VersionedTextDocumentIdentifier text_document) {
1024 this.textDocument = text_document;
1027 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1028 if (property_name != "edits")
1029 return default_serialize_property (property_name, value, pspec);
1031 var node = new Json.Node (Json.NodeType.ARRAY);
1032 node.init_array (new Json.Array ());
1033 var array = node.get_array ();
1034 foreach (var text_edit in edits) {
1035 array.add_element (Json.gobject_serialize (text_edit));
1040 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node) {
1041 error ("deserialization not supported");
1045 public abstract class CommandLike : Object, Json.Serializable {
1047 * The identifier of the actual command handler.
1049 public string command { get; set; }
1052 * Arguments that the command handler should be invoked with.
1054 public Array<Variant>? arguments { get; set; }
1056 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1057 if (property_name != "arguments" || arguments == null)
1058 return default_serialize_property (property_name, value, pspec);
1060 var array = new Json.Array ();
1061 for (int i = 0; i < arguments.length; i++)
1062 array.add_element (Json.gvariant_serialize (arguments.index (i)));
1064 var node = new Json.Node (Json.NodeType.ARRAY);
1065 node.set_array (array);
1069 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node)
1071 if (property_name == "arguments") {
1072 value = GLib.Value (typeof(Array));
1073 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1074 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1078 var arguments = new Array<Variant> ();
1080 property_node.get_array ().foreach_element ((array, index, element) => {
1082 arguments.append_val (Json.gvariant_deserialize (element, null));
1084 warning ("argument %u to command could not be deserialized: %s", index, e.message);
1088 value.set_boxed (arguments);
1090 } else if (property_name == "command") {
1091 // workaround for json-glib < 1.5.2 (Ubuntu 20.04 / eOS 6)
1092 if (property_node.get_value_type () != typeof (string)) {
1094 warning ("unexpected property node type for 'commands' %s", property_node.get_node_type ().to_string ());
1098 value = property_node.get_string ();
1101 return default_deserialize_property (property_name, out value, pspec, property_node);
1106 public class ExecuteCommandParams : CommandLike {
1110 * Represents a reference to a command. Provides a title which will be used
1111 * to represent a command in the UI. Commands are identified by a string
1112 * identifier. The recommended way to handle commands is to implement their
1113 * execution on the server side if the client and server provides the
1114 * corresponding capabilities. Alternatively the tool extension code could
1115 * handle the command. The protocol currently doesn’t specify a set of
1116 * well-known commands.
1118 public class Command : CommandLike {
1120 * The title of the command, like `save`.
1122 public string title { get; set; }
1126 * A code lens represents a command that should be shown along with
1127 * source text, like the number of references, a way to run tests, etc.
1129 * A code lens is _unresolved_ when no command is associated to it. For
1130 * performance reasons the creation of a code lens and resolving should be done
1133 public class CodeLens : Object {
1135 * The range in which this code lens is valid. Should only span a single
1138 public Range range { get; set; }
1141 * The command this code lens represents.
1143 public Command? command { get; set; }
1146 public class DocumentRangeFormattingParams : Object {
1147 public TextDocumentIdentifier textDocument { get; set; }
1148 public Range? range { get; set; }
1149 public FormattingOptions options { get; set; }
1152 public class FormattingOptions : Object {
1153 public uint tabSize { get; set; }
1154 public bool insertSpaces { get; set; }
1155 public bool trimTrailingWhitespace { get; set; }
1156 public bool insertFinalNewline { get; set; }
1157 public bool trimFinalNewlines { get; set; }
1160 public class CodeActionParams : Object {
1161 public TextDocumentIdentifier textDocument { get; set; }
1162 public Range range { get; set; }
1163 public CodeActionContext context { get; set; }
1167 public class CodeActionContext : Object, Json.Serializable {
1168 public Gee.List<Diagnostic> diagnostics { get; set; default = new Gee.ArrayList<Diagnostic> (); }
1169 public string[]? only { get; set; }
1171 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
1172 if (property_name != "diagnostics")
1173 return default_deserialize_property (property_name, out value, pspec, property_node);
1174 var diags = new Gee.ArrayList<Diagnostic> ();
1175 property_node.get_array ().foreach_element ((array, index, element) => {
1177 diags.add (Vls.Util.parse_variant<Diagnostic> (Json.gvariant_deserialize (element, null)));
1179 warning ("argument %u could not be deserialized: %s", index, e.message);
1189 public class Diagnostics : Object, Json.Serializable
1191 public Diagnostics()
1193 this.diagnostics = new Gee.ArrayList<Diagnostic>((a,b) => {
1198 public string uri { get; set; }
1200 public int version { get; set; default = 0; }
1201 public Gee.ArrayList<Diagnostic>? diagnostics { get; set; }
1203 public string filename {
1205 return File.new_for_uri (this.uri).get_path();
1210 public bool deserialize_property (string property_name, out GLib.Value val, GLib.ParamSpec pspec, Json.Node property_node) {
1211 if (property_name == "diagnostics") {
1212 val = GLib.Value (typeof(Gee.ArrayList));
1213 var diags = new Gee.ArrayList<Diagnostic> ((a,b) => {
1216 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1217 val.set_object(diags);
1218 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1224 property_node.get_array ().foreach_element ((array, index, element) => {
1226 diags.add (Json.gobject_deserialize (typeof (Lsp.Diagnostic), element) as Diagnostic );
1228 //warning ("argument %u to command could not be deserialized: %s", index, e.message);
1231 val.set_object(diags);
1236 return default_deserialize_property (property_name, out val, pspec, property_node);
1244 public class CodeAction : Object, Json.Serializable {
1245 public string title { get; set; }
1246 public string? kind { get; set; }
1247 public Gee.Collection<Diagnostic>? diagnostics { get; set; }
1248 public bool isPreferred { get; set; }
1249 public WorkspaceEdit? edit { get; set; }
1250 public Command? command { get; set; }
1251 public Object? data { get; set; }
1253 protected void add_diagnostic (Diagnostic diag) {
1254 if (diagnostics == null)
1255 diagnostics = new Gee.ArrayList<Diagnostic> ();
1256 diagnostics.add (diag);
1259 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1260 if (property_name != "diagnostics")
1261 return default_serialize_property (property_name, value, pspec);
1263 var array = new Json.Array ();
1264 if (diagnostics != null)
1265 foreach (var text_edit in diagnostics)
1266 array.add_element (Json.gobject_serialize (text_edit));
1267 return new Json.Node.alloc ().init_array (array);
1271 public class WorkspaceEdit : Object, Json.Serializable {
1272 public Gee.List<TextDocumentEdit>? documentChanges { get; set; }
1274 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1275 if (property_name != "documentChanges")
1276 return default_serialize_property (property_name, value, pspec);
1278 var node = new Json.Node (Json.NodeType.ARRAY);
1279 node.init_array (new Json.Array ());
1280 if (documentChanges != null) {
1281 var array = node.get_array ();
1282 foreach (var text_edit in documentChanges) {
1283 array.add_element (Json.gobject_serialize (text_edit));
1291 public enum SymbolTags {
1296 public class CallHierarchyItem : Object, Json.Serializable {
1297 public string name { get; set; }
1298 public SymbolKind kind { get; set; }
1299 public SymbolTags tags { get; set; }
1300 public string? detail { get; set; }
1301 public string uri { get; set; }
1302 public Range range { get; set; }
1303 public Range selectionRange { get; set; }
1305 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1306 if (property_name != "tags")
1307 return default_serialize_property (property_name, value, pspec);
1308 var array = new Json.Array ();
1309 if (SymbolTags.DEPRECATED in tags)
1310 array.add_int_element (SymbolTags.DEPRECATED);
1311 return new Json.Node.alloc ().init_array (array);
1314 public CallHierarchyItem.from_symbol (Vala.Symbol symbol) {
1315 this.name = symbol.get_full_name ();
1316 if (symbol is Vala.Method) {
1317 if (symbol.parent_symbol is Vala.Namespace)
1318 this.kind = SymbolKind.Function;
1320 this.kind = SymbolKind.Method;
1321 } else if (symbol is Vala.Signal) {
1322 this.kind = SymbolKind.Event;
1323 } else if (symbol is Vala.Constructor) {
1324 this.kind = SymbolKind.Constructor;
1326 this.kind = SymbolKind.Method;
1328 var version = symbol.get_attribute ("Version");
1329 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1330 this.tags |= SymbolTags.DEPRECATED;
1332 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1333 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1334 this.range = new Range.from_sourceref (symbol.source_reference);
1335 if (symbol.comment != null)
1336 this.range = new Range.from_sourceref (symbol.comment.source_reference).union (this.range);
1337 if (symbol is Vala.Subroutine && ((Vala.Subroutine)symbol).body != null)
1338 this.range = new Range.from_sourceref (((Vala.Subroutine)symbol).body.source_reference).union (this.range);
1339 this.selectionRange = new Range.from_sourceref (symbol.source_reference);
1344 public class CallHierarchyIncomingCall : Json.Serializable, Object {
1346 * The method that calls the query method.
1348 public CallHierarchyItem from { get; set; }
1351 * The ranges at which the query method is called by `from`.
1353 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1355 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1356 if (property_name == "from")
1357 return default_serialize_property (property_name, value, pspec);
1358 var array = new Json.Array ();
1359 foreach (var range in fromRanges)
1360 array.add_element (Json.gobject_serialize (range));
1361 return new Json.Node.alloc ().init_array (array);
1365 public class CallHierarchyOutgoingCall : Json.Serializable, Object {
1367 * The method that the query method calls.
1369 public CallHierarchyItem to { get; set; }
1372 * The ranges at which the method is called by the query method.
1374 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1376 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1377 if (property_name == "to")
1378 return default_serialize_property (property_name, value, pspec);
1379 var array = new Json.Array ();
1380 foreach (var range in fromRanges)
1381 array.add_element (Json.gobject_serialize (range));
1382 return new Json.Node.alloc ().init_array (array);
1386 public class InlayHintParams : Json.Serializable, Object {
1387 public TextDocumentIdentifier textDocument { get; set; }
1388 public Range range { get; set; }
1391 public enum InlayHintKind {
1397 public class InlayHint : Object {
1398 public Position position { get; set; }
1399 public string label { get; set; }
1400 public InlayHintKind kind { get; set; }
1401 public string? tooltip { get; set; }
1402 public bool paddingLeft { get; set; }
1403 public bool paddingRight { get; set; }
1406 public class TypeHierarchyItem : Object, Json.Serializable {
1408 * The name of this item
1410 public string name { get; set; }
1413 * The kind of this item
1415 public SymbolKind kind { get; set; }
1418 * Tags for this item
1420 public SymbolTags tags { get; set; }
1423 * More detail for this item, e.g. the signature of a function.
1425 public string? detail { get; set; }
1428 * The resource identifier of this item.
1430 public string uri { get; set; }
1433 * The range enclosing this symbol not including leading/trailing
1434 * whitespace, but everything else, e.g. comments and code.
1436 public Range range { get; set; }
1439 * The range that should be selected and revealed when this symbol
1440 * is being picked, e.g. the name of a function. Must be contained
1441 * by {@link TypeHierarchyItem.range}
1443 public Range selectionRange { get; set; }
1445 private TypeHierarchyItem () {}
1447 public TypeHierarchyItem.from_symbol (Vala.TypeSymbol symbol) {
1448 this.name = symbol.get_full_name ();
1449 if (symbol is Vala.Class)
1450 this.kind = SymbolKind.Class;
1451 else if (symbol is Vala.Delegate)
1452 this.kind = SymbolKind.Interface;
1453 else if (symbol is Vala.Enum)
1454 this.kind = SymbolKind.Enum;
1455 else if (symbol is Vala.ErrorCode)
1456 this.kind = SymbolKind.EnumMember;
1457 else if (symbol is Vala.ErrorDomain)
1458 this.kind = SymbolKind.Enum;
1459 else if (symbol is Vala.Interface)
1460 this.kind = SymbolKind.Interface;
1461 else if (symbol is Vala.Struct)
1462 this.kind = SymbolKind.Struct;
1463 else if (symbol is Vala.TypeParameter)
1464 this.kind = SymbolKind.TypeParameter;
1466 this.kind = SymbolKind.Module;
1467 warning ("unexpected symbol kind in type hierarchy: `%s'", symbol.type_name);
1470 var version = symbol.get_attribute ("Version");
1471 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1472 this.tags |= SymbolTags.DEPRECATED;
1474 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1475 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1476 this.range = new Range.from_sourceref (symbol.source_reference);
1477 this.selectionRange = this.range;
1479 // widen range to include all members
1480 if (symbol is Vala.ObjectTypeSymbol) {
1481 foreach (var member in ((Vala.ObjectTypeSymbol)symbol).get_members ()) {
1482 if (member.source_reference != null)
1483 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1485 } else if (symbol is Vala.Enum) {
1486 foreach (var member in ((Vala.Enum)symbol).get_values ()) {
1487 if (member.source_reference != null)
1488 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1490 foreach (var method in ((Vala.Enum)symbol).get_methods ()) {
1491 if (method.source_reference != null)
1492 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1494 } else if (symbol is Vala.ErrorDomain) {
1495 foreach (var member in ((Vala.ErrorDomain)symbol).get_codes ()) {
1496 if (member.source_reference != null)
1497 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1499 foreach (var method in ((Vala.ErrorDomain)symbol).get_methods ()) {
1500 if (method.source_reference != null)
1501 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1503 } else if (symbol is Vala.Struct) {
1504 foreach (var field in ((Vala.Struct)symbol).get_fields ()) {
1505 if (field.source_reference != null)
1506 this.range = this.range.union (new Range.from_sourceref (field.source_reference));
1508 foreach (var method in ((Vala.Struct)symbol).get_methods ()) {
1509 if (method.source_reference != null)
1510 this.range = this.range.union (new Range.from_sourceref (method.source_reference));