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; default = ""; }
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 {
430 return this.kind.icon();
433 public string[] symbol_classes {
437 ret += this.kind.icon();
441 public string tooltip {
443 var detail = this.detail == "" ? (this.kind.to_string() + ": " + this.name) : this.detail;
444 return GLib.markup_escape_text(detail + "\nline: " + this.range.start.line.to_string());
452 public class SymbolInformation : Object {
453 public string name { get; set; }
454 public SymbolKind kind { get; set; }
455 public Location location { get; set; }
456 public string? containerName { get; set; }
458 public SymbolInformation.from_document_symbol (DocumentSymbol dsym, string uri) {
459 this.name = dsym.name;
460 this.kind = dsym.kind;
461 // this.location = new Location (uri, dsym.range);
462 this.containerName = dsym.parent_name;
466 [CCode (default_value = "LSP_SYMBOL_KIND_Variable")]
467 public enum SymbolKind {
495 public string icon () {
499 // case SymbolKind.Text: return "completion-snippet-symbolic";
500 case SymbolKind.Method: return "lang-method-symbolic";
501 case SymbolKind.Function: return "lang-function-symbolic";
502 case SymbolKind.Constructor: return "lang-method-symbolic";
503 case SymbolKind.Field: return "lang-struct-field-symbolic";
504 case SymbolKind.Variable: return "lang-variable-symbolic";
505 case SymbolKind.Class: return "lang-class-symbolic";
506 case SymbolKind.Interface: return "lang-class-symbolic";
507 case SymbolKind.Module: return "lang-namespace-symbolic";
508 case SymbolKind.Property:return "lang-struct-field-symbolic";
509 //case SymbolKind.Unit: return "lang-variable-symbolic";
510 //case SymbolKind.Value: return "lang-variable-symbolic";
511 case SymbolKind.Enum: return "lang-enum-symbolic";
512 //case SymbolKind.Keyword: return "completion-word-symbolic";
513 //case SymbolKind.Snippet: return "completion-snippet-symbolic";
515 //case SymbolKind.Color: return "lang-typedef-symbolic";
516 case SymbolKind.File:return "lang-typedef-symbolic";
517 //case SymbolKind.Reference: return "lang-typedef-symbolic";
518 //case SymbolKind.Folder:return "lang-typedef-symbolic";
519 case SymbolKind.EnumMember: return "lang-typedef-symbolic";
520 case SymbolKind.Constant:return "lang-typedef-symbolic";
521 case SymbolKind.Struct: return "lang-struct-symbolic";
522 case SymbolKind.Event:return "lang-typedef-symbolic";
523 case SymbolKind.Operator:return "lang-typedef-symbolic";
524 case SymbolKind.TypeParameter:return "lang-typedef-symbolic";
527 return "completion-snippet-symbolic";
534 public class CompletionList : Object, Json.Serializable {
535 public bool isIncomplete { get; set; }
536 public Gee.List<CompletionItem> items { get; private set; default = new Gee.LinkedList<CompletionItem> (); }
538 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
539 base.set_property (pspec.get_name (), value);
542 public new Value Json.Serializable.get_property (ParamSpec pspec) {
543 Value val = Value(pspec.value_type);
544 base.get_property (pspec.get_name (), ref val);
548 public unowned ParamSpec? find_property (string name) {
549 return this.get_class ().find_property (name);
552 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
553 if (property_name != "items")
554 return default_serialize_property (property_name, value, pspec);
555 var node = new Json.Node (Json.NodeType.ARRAY);
556 node.init_array (new Json.Array ());
557 var array = node.get_array ();
558 foreach (var child in items)
559 array.add_element (Json.gobject_serialize (child));
563 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
564 error ("deserialization not supported");
568 [CCode (default_value = "LSP_COMPLETION_TRIGGER_KIND_Invoked")]
569 public enum CompletionTriggerKind {
571 * Completion was triggered by typing an identifier (24x7 code
572 * complete), manual invocation (e.g Ctrl+Space) or via API.
577 * Completion was triggered by a trigger character specified by
578 * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
580 TriggerCharacter = 2,
583 * Completion was re-triggered as the current completion list is incomplete.
585 TriggerForIncompleteCompletions = 3
588 public class CompletionContext : Object {
589 public CompletionTriggerKind triggerKind { get; set;}
590 public string? triggerCharacter { get; set; }
593 public class CompletionParams : TextDocumentPositionParams {
595 * The completion context. This is only available if the client specifies
596 * to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
598 public CompletionContext? context { get; set; }
601 public enum CompletionItemTag {
602 // Render a completion as obsolete, usually using a strike-out.
606 [CCode (default_value = "LSP_INSERT_TEXT_FORMAT_PlainText")]
607 public enum InsertTextFormat {
609 * The primary text to be inserted is treated as a plain string.
614 * The primary text to be inserted is treated as a snippet.
616 * A snippet can define tab stops and placeholders with `$1`, `$2`
617 * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
618 * the end of the snippet. Placeholders with equal identifiers are linked,
619 * that is typing in one will update others too.
624 public class CompletionItem : Object, Gee.Hashable<CompletionItem>, Json.Serializable {
625 public string label { get; set; }
626 public CompletionItemKind kind { get; set; }
627 public string detail { get; set; }
628 public MarkupContent? documentation { get; set; }
629 public bool deprecated { get; set; }
630 public Gee.List<CompletionItemTag> tags { get; private set; default = new Gee.ArrayList<CompletionItemTag> (); }
631 public string? insertText { get; set; }
632 public InsertTextFormat insertTextFormat { get; set; default = InsertTextFormat.PlainText; }
635 private CompletionItem () {}
637 public CompletionItem.keyword (string keyword, string? insert_text = null, string? documentation = null) {
638 this.label = keyword;
639 this.kind = CompletionItemKind.Keyword;
640 this.insertText = insert_text;
641 if (insert_text != null && (insert_text.contains ("$0") || insert_text.contains ("${0")))
642 this.insertTextFormat = InsertTextFormat.Snippet;
643 if (documentation != null)
644 this.documentation = new MarkupContent.from_plaintext (documentation);
645 this._hash = @"$label $kind".hash ();
649 * A completion suggestion from an existing Vala symbol.
651 * @param instance_type the parent data type of data type of the expression where this symbol appears, or null
652 * @param sym the symbol itself
653 * @param scope the scope to display this in
654 * @param kind the kind of completion to display
655 * @param documentation the documentation to display
656 * @param label_override if non-null, override the displayed symbol name with this
659 public CompletionItem.from_symbol (Vala.DataType? instance_type, Vala.Symbol sym, Vala.Scope? scope,
660 CompletionItemKind kind,
661 Vls.DocComment? documentation, string? label_override = null) {
662 this.label = label_override ?? sym.name;
664 this.detail = Vls.CodeHelp.get_symbol_representation (instance_type, sym, scope, true, null, label_override, false);
665 this._hash = @"$label $kind".hash ();
667 if (documentation != null)
668 this.documentation = new MarkupContent.from_markdown (documentation.body);
670 var version = sym.get_attribute ("Version");
671 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
672 this.tags.add (CompletionItemTag.Deprecated);
673 this.deprecated = true;
678 * A completion suggestion from a data type and a synthetic symbol name.
680 * @param symbol_type the data type of the symbol
681 * @param symbol_name the name of the synthetic symbol
682 * @param scope the scope that this completion item is displayed in, or null
683 * @param kind the type of completion to display
684 * @param documentation the documentation for this symbol, or null
687 public CompletionItem.from_synthetic_symbol (Vala.DataType symbol_type, string symbol_name, Vala.Scope? scope,
688 CompletionItemKind kind, Vls.DocComment? documentation) {
689 this.label = symbol_name;
691 this.detail = @"$(Vls.CodeHelp.get_symbol_representation (symbol_type, null, scope, true, null, null, false)) $symbol_name";
692 this._hash = @"$label $kind".hash ();
694 if (documentation != null)
695 this.documentation = new MarkupContent.from_markdown (documentation.body);
699 public CompletionItem.from_unimplemented_symbol (Vala.Symbol sym,
700 string label, CompletionItemKind kind,
702 Vls.DocComment? documentation) {
705 this.insertText = insert_text;
706 if (insert_text.contains ("$0") || insert_text.contains ("${0"))
707 this.insertTextFormat = InsertTextFormat.Snippet;
708 this._hash = @"$label $kind".hash ();
709 if (documentation != null)
710 this.documentation = new MarkupContent.from_markdown (documentation.body);
714 public uint hash () {
718 public bool equal_to (CompletionItem other) {
719 return other.label == this.label && other.kind == this.kind;
722 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
723 base.set_property (pspec.get_name (), value);
726 public new Value Json.Serializable.get_property (ParamSpec pspec) {
727 Value val = Value(pspec.value_type);
728 base.get_property (pspec.get_name (), ref val);
732 public unowned ParamSpec? find_property (string name) {
733 return this.get_class ().find_property (name);
736 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
737 if (property_name != "tags")
738 return default_serialize_property (property_name, value, pspec);
740 var node = new Json.Node (Json.NodeType.ARRAY);
741 node.init_array (new Json.Array ());
742 var array = node.get_array ();
743 foreach (var tag in this.tags) {
744 array.add_int_element (tag);
749 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
751 if (property_name != "tags") {
752 return default_deserialize_property (property_name, out value, pspec, property_node);
754 value = GLib.Value (typeof(Gee.ArrayList));
755 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
756 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
760 var arguments = new Gee.ArrayList<CompletionItemTag>();
762 property_node.get_array ().foreach_element ((array, index, element) => {
764 arguments.add ((CompletionItemTag) Json.gvariant_deserialize (element, null).get_int32() );
766 warning ("argument %u to command could not be deserialized: %s", index, e.message);
770 value.set_object (arguments);
775 public class MarkupContent : Object {
776 public string kind { get; set; }
777 public string value { get; set; }
779 private MarkupContent () {}
782 * Create a MarkupContent with plain text.
784 public MarkupContent.from_plaintext (string doc) {
785 this.kind = "plaintext";
790 * Create a MarkupContent with markdown text.
792 public MarkupContent.from_markdown (string doc) {
793 this.kind = "markdown";
798 [CCode (default_value = "LSP_COMPLETION_ITEM_KIND_Text")]
799 public enum CompletionItemKind {
828 * Capabilities of the client/editor for `textDocument/documentSymbol`
830 public class DocumentSymbolCapabilities : Object {
831 public bool hierarchicalDocumentSymbolSupport { get; set; }
835 * Capabilities of the client/editor for `textDocument/rename`
837 public class RenameClientCapabilities : Object {
838 public bool prepareSupport { get; set; }
842 * Capabilities of the client/editor pertaining to language features.
844 public class TextDocumentClientCapabilities : Object {
845 public DocumentSymbolCapabilities documentSymbol { get; set; default = new DocumentSymbolCapabilities ();}
846 public RenameClientCapabilities rename { get; set; default = new RenameClientCapabilities (); }
850 * Capabilities of the client/editor.
852 public class ClientCapabilities : Object {
853 public TextDocumentClientCapabilities textDocument { get; set; default = new TextDocumentClientCapabilities (); }
856 public class InitializeParams : Object {
857 public int processId { get; set; }
858 public string? rootPath { get; set; }
859 public string? rootUri { get; set; }
860 public ClientCapabilities capabilities { get; set; default = new ClientCapabilities (); }
863 public class SignatureInformation : Object, Json.Serializable {
864 public string label { get; set; }
865 public MarkupContent documentation { get; set; }
867 public Gee.List<ParameterInformation> parameters { get; private set; default = new Gee.LinkedList<ParameterInformation> (); }
869 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
870 base.set_property (pspec.get_name (), value);
873 public new Value Json.Serializable.get_property (ParamSpec pspec) {
874 Value val = Value(pspec.value_type);
875 base.get_property (pspec.get_name (), ref val);
879 public unowned ParamSpec? find_property (string name) {
880 return this.get_class ().find_property (name);
883 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
884 if (property_name != "parameters")
885 return default_serialize_property (property_name, value, pspec);
886 var node = new Json.Node (Json.NodeType.ARRAY);
887 node.init_array (new Json.Array ());
888 var array = node.get_array ();
889 foreach (var child in parameters)
890 array.add_element (Json.gobject_serialize (child));
894 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
895 error ("deserialization not supported");
899 public class SignatureHelp : Object, Json.Serializable {
900 public Gee.Collection<SignatureInformation> signatures { get; set; default = new Gee.ArrayList<SignatureInformation> (); }
901 public int activeSignature { get; set; }
902 public int activeParameter { get; set; }
904 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
905 if (property_name != "signatures")
906 return default_serialize_property (property_name, value, pspec);
908 var node = new Json.Node (Json.NodeType.ARRAY);
909 node.init_array (new Json.Array ());
910 var array = node.get_array ();
911 foreach (var child in signatures)
912 array.add_element (Json.gobject_serialize (child));
916 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
917 error ("deserialization not supported");
921 public class ParameterInformation : Object {
922 public string label { get; set; }
923 public MarkupContent documentation { get; set; }
926 public class MarkedString : Object {
927 public MarkedString(string language, string value)
929 this.language = language;
931 GLib.debug("new marked string %s : %s", language, value);
933 public string language { get; set; }
934 public string value { get; set; }
937 public class Hover : Object, Json.Serializable {
938 public Gee.List<MarkedString> contents { get; set; default = new Gee.ArrayList<MarkedString> (); }
939 public Range range { get; set; }
941 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
942 base.set_property (pspec.get_name (), value);
945 public new Value Json.Serializable.get_property (ParamSpec pspec) {
946 Value val = Value(pspec.value_type);
947 base.get_property (pspec.get_name (), ref val);
951 public unowned ParamSpec? find_property (string name) {
952 return this.get_class ().find_property (name);
955 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
956 if (property_name != "contents")
957 return default_serialize_property (property_name, value, pspec);
958 var node = new Json.Node (Json.NodeType.ARRAY);
959 node.init_array (new Json.Array ());
960 var array = node.get_array ();
961 foreach (var child in contents) {
962 if (child.language != null)
963 array.add_element (Json.gobject_serialize (child));
965 array.add_element (new Json.Node (Json.NodeType.VALUE).init_string (child.value));
970 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
972 if (property_name == "contents") {
973 value = GLib.Value (typeof(Gee.ArrayList));
974 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
975 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
978 var contents = new Gee.ArrayList<MarkedString>();
980 property_node.get_array ().foreach_element ((array, index, element) => {
982 var add = new MarkedString(
983 array.get_object_element(index).get_string_member("language"),
984 array.get_object_element(index).get_string_member("value")
987 contents.add ( add );
989 warning ("argument %u to command could not be deserialized: %s", index, e.message);
992 value.set_object (contents);
996 return default_deserialize_property (property_name, out value, pspec, property_node);
1001 * A textual edit applicable to a text document.
1003 public class TextEdit : Object {
1005 * The range of the text document to be manipulated. To insert
1006 * text into a document create a range where ``start === end``.
1008 public Range range { get; set; }
1011 * The string to be inserted. For delete operations use an
1014 public string newText { get; set; }
1016 public TextEdit (Range range, string new_text = "") {
1018 this.newText = new_text;
1023 * Describes textual changes on a single text document. The text document is
1024 * referred to as a {@link VersionedTextDocumentIdentifier} to allow clients to
1025 * check the text document version before an edit is applied. A
1026 * {@link TextDocumentEdit} describes all changes on a version ``Si`` and after they are
1027 * applied move the document to version ``Si+1``. So the creator of a
1028 * {@link TextDocumentEdit} doesn’t need to sort the array of edits or do any kind
1029 * of ordering. However the edits must be non overlapping.
1031 public class TextDocumentEdit : Object, Json.Serializable {
1033 * The text document to change.
1035 public VersionedTextDocumentIdentifier textDocument { get; set; }
1038 * The edits to be applied.
1040 public Gee.ArrayList<TextEdit> edits { get; set; default = new Gee.ArrayList<TextEdit> (); }
1042 public TextDocumentEdit (VersionedTextDocumentIdentifier text_document) {
1043 this.textDocument = text_document;
1046 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1047 if (property_name != "edits")
1048 return default_serialize_property (property_name, value, pspec);
1050 var node = new Json.Node (Json.NodeType.ARRAY);
1051 node.init_array (new Json.Array ());
1052 var array = node.get_array ();
1053 foreach (var text_edit in edits) {
1054 array.add_element (Json.gobject_serialize (text_edit));
1059 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node) {
1060 error ("deserialization not supported");
1064 public abstract class CommandLike : Object, Json.Serializable {
1066 * The identifier of the actual command handler.
1068 public string command { get; set; }
1071 * Arguments that the command handler should be invoked with.
1073 public Array<Variant>? arguments { get; set; }
1075 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1076 if (property_name != "arguments" || arguments == null)
1077 return default_serialize_property (property_name, value, pspec);
1079 var array = new Json.Array ();
1080 for (int i = 0; i < arguments.length; i++)
1081 array.add_element (Json.gvariant_serialize (arguments.index (i)));
1083 var node = new Json.Node (Json.NodeType.ARRAY);
1084 node.set_array (array);
1088 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node)
1090 if (property_name == "arguments") {
1091 value = GLib.Value (typeof(Array));
1092 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1093 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1097 var arguments = new Array<Variant> ();
1099 property_node.get_array ().foreach_element ((array, index, element) => {
1101 arguments.append_val (Json.gvariant_deserialize (element, null));
1103 warning ("argument %u to command could not be deserialized: %s", index, e.message);
1107 value.set_boxed (arguments);
1109 } else if (property_name == "command") {
1110 // workaround for json-glib < 1.5.2 (Ubuntu 20.04 / eOS 6)
1111 if (property_node.get_value_type () != typeof (string)) {
1113 warning ("unexpected property node type for 'commands' %s", property_node.get_node_type ().to_string ());
1117 value = property_node.get_string ();
1120 return default_deserialize_property (property_name, out value, pspec, property_node);
1125 public class ExecuteCommandParams : CommandLike {
1129 * Represents a reference to a command. Provides a title which will be used
1130 * to represent a command in the UI. Commands are identified by a string
1131 * identifier. The recommended way to handle commands is to implement their
1132 * execution on the server side if the client and server provides the
1133 * corresponding capabilities. Alternatively the tool extension code could
1134 * handle the command. The protocol currently doesn’t specify a set of
1135 * well-known commands.
1137 public class Command : CommandLike {
1139 * The title of the command, like `save`.
1141 public string title { get; set; }
1145 * A code lens represents a command that should be shown along with
1146 * source text, like the number of references, a way to run tests, etc.
1148 * A code lens is _unresolved_ when no command is associated to it. For
1149 * performance reasons the creation of a code lens and resolving should be done
1152 public class CodeLens : Object {
1154 * The range in which this code lens is valid. Should only span a single
1157 public Range range { get; set; }
1160 * The command this code lens represents.
1162 public Command? command { get; set; }
1165 public class DocumentRangeFormattingParams : Object {
1166 public TextDocumentIdentifier textDocument { get; set; }
1167 public Range? range { get; set; }
1168 public FormattingOptions options { get; set; }
1171 public class FormattingOptions : Object {
1172 public uint tabSize { get; set; }
1173 public bool insertSpaces { get; set; }
1174 public bool trimTrailingWhitespace { get; set; }
1175 public bool insertFinalNewline { get; set; }
1176 public bool trimFinalNewlines { get; set; }
1179 public class CodeActionParams : Object {
1180 public TextDocumentIdentifier textDocument { get; set; }
1181 public Range range { get; set; }
1182 public CodeActionContext context { get; set; }
1186 public class CodeActionContext : Object, Json.Serializable {
1187 public Gee.List<Diagnostic> diagnostics { get; set; default = new Gee.ArrayList<Diagnostic> (); }
1188 public string[]? only { get; set; }
1190 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
1191 if (property_name != "diagnostics")
1192 return default_deserialize_property (property_name, out value, pspec, property_node);
1193 var diags = new Gee.ArrayList<Diagnostic> ();
1194 property_node.get_array ().foreach_element ((array, index, element) => {
1196 diags.add (Vls.Util.parse_variant<Diagnostic> (Json.gvariant_deserialize (element, null)));
1198 warning ("argument %u could not be deserialized: %s", index, e.message);
1208 public class Diagnostics : Object, Json.Serializable
1210 public Diagnostics()
1212 this.diagnostics = new Gee.ArrayList<Diagnostic>((a,b) => {
1217 public string uri { get; set; }
1219 public int version { get; set; default = 0; }
1220 public Gee.ArrayList<Diagnostic>? diagnostics { get; set; }
1222 public string filename {
1224 return File.new_for_uri (this.uri).get_path();
1229 public bool deserialize_property (string property_name, out GLib.Value val, GLib.ParamSpec pspec, Json.Node property_node) {
1230 if (property_name == "diagnostics") {
1231 val = GLib.Value (typeof(Gee.ArrayList));
1232 var diags = new Gee.ArrayList<Diagnostic> ((a,b) => {
1235 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1236 val.set_object(diags);
1237 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1243 property_node.get_array ().foreach_element ((array, index, element) => {
1245 diags.add (Json.gobject_deserialize (typeof (Lsp.Diagnostic), element) as Diagnostic );
1247 //warning ("argument %u to command could not be deserialized: %s", index, e.message);
1250 val.set_object(diags);
1255 return default_deserialize_property (property_name, out val, pspec, property_node);
1263 public class CodeAction : Object, Json.Serializable {
1264 public string title { get; set; }
1265 public string? kind { get; set; }
1266 public Gee.Collection<Diagnostic>? diagnostics { get; set; }
1267 public bool isPreferred { get; set; }
1268 public WorkspaceEdit? edit { get; set; }
1269 public Command? command { get; set; }
1270 public Object? data { get; set; }
1272 protected void add_diagnostic (Diagnostic diag) {
1273 if (diagnostics == null)
1274 diagnostics = new Gee.ArrayList<Diagnostic> ();
1275 diagnostics.add (diag);
1278 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1279 if (property_name != "diagnostics")
1280 return default_serialize_property (property_name, value, pspec);
1282 var array = new Json.Array ();
1283 if (diagnostics != null)
1284 foreach (var text_edit in diagnostics)
1285 array.add_element (Json.gobject_serialize (text_edit));
1286 return new Json.Node.alloc ().init_array (array);
1290 public class WorkspaceEdit : Object, Json.Serializable {
1291 public Gee.List<TextDocumentEdit>? documentChanges { get; set; }
1293 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1294 if (property_name != "documentChanges")
1295 return default_serialize_property (property_name, value, pspec);
1297 var node = new Json.Node (Json.NodeType.ARRAY);
1298 node.init_array (new Json.Array ());
1299 if (documentChanges != null) {
1300 var array = node.get_array ();
1301 foreach (var text_edit in documentChanges) {
1302 array.add_element (Json.gobject_serialize (text_edit));
1310 public enum SymbolTags {
1315 public class CallHierarchyItem : Object, Json.Serializable {
1316 public string name { get; set; }
1317 public SymbolKind kind { get; set; }
1318 public SymbolTags tags { get; set; }
1319 public string? detail { get; set; }
1320 public string uri { get; set; }
1321 public Range range { get; set; }
1322 public Range selectionRange { get; set; }
1324 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1325 if (property_name != "tags")
1326 return default_serialize_property (property_name, value, pspec);
1327 var array = new Json.Array ();
1328 if (SymbolTags.DEPRECATED in tags)
1329 array.add_int_element (SymbolTags.DEPRECATED);
1330 return new Json.Node.alloc ().init_array (array);
1333 public CallHierarchyItem.from_symbol (Vala.Symbol symbol) {
1334 this.name = symbol.get_full_name ();
1335 if (symbol is Vala.Method) {
1336 if (symbol.parent_symbol is Vala.Namespace)
1337 this.kind = SymbolKind.Function;
1339 this.kind = SymbolKind.Method;
1340 } else if (symbol is Vala.Signal) {
1341 this.kind = SymbolKind.Event;
1342 } else if (symbol is Vala.Constructor) {
1343 this.kind = SymbolKind.Constructor;
1345 this.kind = SymbolKind.Method;
1347 var version = symbol.get_attribute ("Version");
1348 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1349 this.tags |= SymbolTags.DEPRECATED;
1351 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1352 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1353 this.range = new Range.from_sourceref (symbol.source_reference);
1354 if (symbol.comment != null)
1355 this.range = new Range.from_sourceref (symbol.comment.source_reference).union (this.range);
1356 if (symbol is Vala.Subroutine && ((Vala.Subroutine)symbol).body != null)
1357 this.range = new Range.from_sourceref (((Vala.Subroutine)symbol).body.source_reference).union (this.range);
1358 this.selectionRange = new Range.from_sourceref (symbol.source_reference);
1363 public class CallHierarchyIncomingCall : Json.Serializable, Object {
1365 * The method that calls the query method.
1367 public CallHierarchyItem from { get; set; }
1370 * The ranges at which the query method is called by `from`.
1372 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1374 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1375 if (property_name == "from")
1376 return default_serialize_property (property_name, value, pspec);
1377 var array = new Json.Array ();
1378 foreach (var range in fromRanges)
1379 array.add_element (Json.gobject_serialize (range));
1380 return new Json.Node.alloc ().init_array (array);
1384 public class CallHierarchyOutgoingCall : Json.Serializable, Object {
1386 * The method that the query method calls.
1388 public CallHierarchyItem to { get; set; }
1391 * The ranges at which the method is called by the query method.
1393 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1395 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1396 if (property_name == "to")
1397 return default_serialize_property (property_name, value, pspec);
1398 var array = new Json.Array ();
1399 foreach (var range in fromRanges)
1400 array.add_element (Json.gobject_serialize (range));
1401 return new Json.Node.alloc ().init_array (array);
1405 public class InlayHintParams : Json.Serializable, Object {
1406 public TextDocumentIdentifier textDocument { get; set; }
1407 public Range range { get; set; }
1410 public enum InlayHintKind {
1416 public class InlayHint : Object {
1417 public Position position { get; set; }
1418 public string label { get; set; }
1419 public InlayHintKind kind { get; set; }
1420 public string? tooltip { get; set; }
1421 public bool paddingLeft { get; set; }
1422 public bool paddingRight { get; set; }
1425 public class TypeHierarchyItem : Object, Json.Serializable {
1427 * The name of this item
1429 public string name { get; set; }
1432 * The kind of this item
1434 public SymbolKind kind { get; set; }
1437 * Tags for this item
1439 public SymbolTags tags { get; set; }
1442 * More detail for this item, e.g. the signature of a function.
1444 public string? detail { get; set; }
1447 * The resource identifier of this item.
1449 public string uri { get; set; }
1452 * The range enclosing this symbol not including leading/trailing
1453 * whitespace, but everything else, e.g. comments and code.
1455 public Range range { get; set; }
1458 * The range that should be selected and revealed when this symbol
1459 * is being picked, e.g. the name of a function. Must be contained
1460 * by {@link TypeHierarchyItem.range}
1462 public Range selectionRange { get; set; }
1464 private TypeHierarchyItem () {}
1466 public TypeHierarchyItem.from_symbol (Vala.TypeSymbol symbol) {
1467 this.name = symbol.get_full_name ();
1468 if (symbol is Vala.Class)
1469 this.kind = SymbolKind.Class;
1470 else if (symbol is Vala.Delegate)
1471 this.kind = SymbolKind.Interface;
1472 else if (symbol is Vala.Enum)
1473 this.kind = SymbolKind.Enum;
1474 else if (symbol is Vala.ErrorCode)
1475 this.kind = SymbolKind.EnumMember;
1476 else if (symbol is Vala.ErrorDomain)
1477 this.kind = SymbolKind.Enum;
1478 else if (symbol is Vala.Interface)
1479 this.kind = SymbolKind.Interface;
1480 else if (symbol is Vala.Struct)
1481 this.kind = SymbolKind.Struct;
1482 else if (symbol is Vala.TypeParameter)
1483 this.kind = SymbolKind.TypeParameter;
1485 this.kind = SymbolKind.Module;
1486 warning ("unexpected symbol kind in type hierarchy: `%s'", symbol.type_name);
1489 var version = symbol.get_attribute ("Version");
1490 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1491 this.tags |= SymbolTags.DEPRECATED;
1493 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1494 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1495 this.range = new Range.from_sourceref (symbol.source_reference);
1496 this.selectionRange = this.range;
1498 // widen range to include all members
1499 if (symbol is Vala.ObjectTypeSymbol) {
1500 foreach (var member in ((Vala.ObjectTypeSymbol)symbol).get_members ()) {
1501 if (member.source_reference != null)
1502 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1504 } else if (symbol is Vala.Enum) {
1505 foreach (var member in ((Vala.Enum)symbol).get_values ()) {
1506 if (member.source_reference != null)
1507 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1509 foreach (var method in ((Vala.Enum)symbol).get_methods ()) {
1510 if (method.source_reference != null)
1511 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1513 } else if (symbol is Vala.ErrorDomain) {
1514 foreach (var member in ((Vala.ErrorDomain)symbol).get_codes ()) {
1515 if (member.source_reference != null)
1516 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1518 foreach (var method in ((Vala.ErrorDomain)symbol).get_methods ()) {
1519 if (method.source_reference != null)
1520 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1522 } else if (symbol is Vala.Struct) {
1523 foreach (var field in ((Vala.Struct)symbol).get_fields ()) {
1524 if (field.source_reference != null)
1525 this.range = this.range.union (new Range.from_sourceref (field.source_reference));
1527 foreach (var method in ((Vala.Struct)symbol).get_methods ()) {
1528 if (method.source_reference != null)
1529 this.range = this.range.union (new Range.from_sourceref (method.source_reference));