Protocol 3.17

protocol_3_17/base-protocol.go

@@ -0,0 +1,130 @@
+package protocol
+
+import (
+	"encoding/json"
+	"strconv"
+
+	"github.com/tliron/glsp"
+)
+
+var True bool = true
+var False bool = false
+
+type Method = string
+
+// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#number
+
+/**
+ * Defines an integer number in the range of -2^31 to 2^31 - 1.
+ */
+type Integer = int32
+
+/**
+ * Defines an unsigned integer number in the range of 0 to 2^31 - 1.
+ */
+type UInteger = uint32
+
+/**
+ * Defines a decimal number. Since decimal numbers are very
+ * rare in the language server specification we denote the
+ * exact range with every decimal using the mathematics
+ * interval notation (e.g. [0, 1] denotes all decimals d with
+ * 0 <= d <= 1.
+ */
+type Decimal = float32
+
+type IntegerOrString struct {
+	Value any // Integer | string
+}
+
+// ([json.Marshaler] interface)
+func (self *IntegerOrString) MarshalJSON() ([]byte, error) {
+	return json.Marshal(self.Value)
+}
+
+// ([json.Unmarshaler] interface)
+func (self *IntegerOrString) UnmarshalJSON(data []byte) error {
+	var value Integer
+	if err := json.Unmarshal(data, &value); err == nil {
+		self.Value = value
+		return nil
+	} else {
+		var value string
+		if err := json.Unmarshal(data, &value); err == nil {
+			self.Value = value
+			return nil
+		} else {
+			return err
+		}
+	}
+}
+
+type BoolOrString struct {
+	Value any // bool | string
+}
+
+// ([json.Marshaler] interface)
+func (self BoolOrString) MarshalJSON() ([]byte, error) {
+	return json.Marshal(self.Value)
+}
+
+// ([json.Unmarshaler] interface)
+func (self *BoolOrString) UnmarshalJSON(data []byte) error {
+	var value bool
+	if err := json.Unmarshal(data, &value); err == nil {
+		self.Value = value
+		return nil
+	} else {
+		var value string
+		if err := json.Unmarshal(data, &value); err == nil {
+			self.Value = value
+			return nil
+		} else {
+			return err
+		}
+	}
+}
+
+// ([fmt.Stringer] interface)
+func (self BoolOrString) String() string {
+	if value, ok := self.Value.(bool); ok {
+		return strconv.FormatBool(value)
+	}
+	if value, ok := self.Value.(string); ok {
+		return value
+	}
+	return ""
+}
+
+// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#cancelRequest
+
+const MethodCancelRequest = Method("$/cancelRequest")
+
+type CancelRequestFunc func(context *glsp.Context, params *CancelParams) error
+
+type CancelParams struct {
+	/**
+	 * The request id to cancel.
+	 */
+	ID IntegerOrString `json:"id"`
+}
+
+// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#progress
+
+const MethodProgress = Method("$/progress")
+
+type ProgressFunc func(context *glsp.Context, params *ProgressParams) error
+
+type ProgressParams struct {
+	/**
+	 * The progress token provided by the client or server.
+	 */
+	Token ProgressToken `json:"token"`
+
+	/**
+	 * The progress data.
+	 */
+	Value any `json:"value"`
+}
+
+type ProgressToken = IntegerOrString