diff options
Diffstat (limited to 'vendor/lsp-types/src/lib.rs')
| -rw-r--r-- | vendor/lsp-types/src/lib.rs | 5490 |
1 files changed, 2798 insertions, 2692 deletions
diff --git a/vendor/lsp-types/src/lib.rs b/vendor/lsp-types/src/lib.rs index 7469e67a6..027e9ef89 100644 --- a/vendor/lsp-types/src/lib.rs +++ b/vendor/lsp-types/src/lib.rs @@ -1,2692 +1,2798 @@ -/*! - -Language Server Protocol types for Rust. - -Based on: <https://microsoft.github.io/language-server-protocol/specification> - -This library uses the URL crate for parsing URIs. Note that there is -some confusion on the meaning of URLs vs URIs: -<http://stackoverflow.com/a/28865728/393898>. According to that -information, on the classical sense of "URLs", "URLs" are a subset of -URIs, But on the modern/new meaning of URLs, they are the same as -URIs. The important take-away aspect is that the URL crate should be -able to parse any URI, such as `urn:isbn:0451450523`. - - -*/ -#![allow(non_upper_case_globals)] -#[forbid(unsafe_code)] -#[macro_use] -extern crate bitflags; - -use std::{collections::HashMap, fmt::Debug}; - -use serde::{de, de::Error as Error_, Deserialize, Serialize}; -use serde_json::Value; -pub use url::Url; - -// Large enough to contain any enumeration name defined in this crate -type PascalCaseBuf = [u8; 32]; -const fn fmt_pascal_case_const(name: &str) -> (PascalCaseBuf, usize) { - let mut buf = [0; 32]; - let mut buf_i = 0; - let mut name_i = 0; - let name = name.as_bytes(); - while name_i < name.len() { - let first = name[name_i]; - name_i += 1; - - buf[buf_i] = first; - buf_i += 1; - - while name_i < name.len() { - let rest = name[name_i]; - name_i += 1; - if rest == b'_' { - break; - } - - buf[buf_i] = rest.to_ascii_lowercase(); - buf_i += 1; - } - } - (buf, buf_i) -} - -fn fmt_pascal_case(f: &mut std::fmt::Formatter<'_>, name: &str) -> std::fmt::Result { - for word in name.split('_') { - let mut chars = word.chars(); - let first = chars.next().unwrap(); - write!(f, "{}", first)?; - for rest in chars { - write!(f, "{}", rest.to_lowercase())?; - } - } - Ok(()) -} - -macro_rules! lsp_enum { - (impl $typ: ident { $( $(#[$attr:meta])* pub const $name: ident : $enum_type: ty = $value: expr; )* }) => { - impl $typ { - $( - $(#[$attr])* - pub const $name: $enum_type = $value; - )* - } - - impl std::fmt::Debug for $typ { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - match *self { - $( - Self::$name => crate::fmt_pascal_case(f, stringify!($name)), - )* - _ => write!(f, "{}({})", stringify!($typ), self.0), - } - } - } - - impl std::convert::TryFrom<&str> for $typ { - type Error = &'static str; - fn try_from(value: &str) -> Result<Self, Self::Error> { - match () { - $( - _ if { - const X: (crate::PascalCaseBuf, usize) = crate::fmt_pascal_case_const(stringify!($name)); - let (buf, len) = X; - &buf[..len] == value.as_bytes() - } => Ok(Self::$name), - )* - _ => Err("unknown enum variant"), - } - } - } - - } -} - -pub mod error_codes; -pub mod notification; -pub mod request; - -mod call_hierarchy; -pub use call_hierarchy::*; - -mod code_action; -pub use code_action::*; - -mod code_lens; -pub use code_lens::*; - -mod color; -pub use color::*; - -mod completion; -pub use completion::*; - -mod document_highlight; -pub use document_highlight::*; - -mod document_link; -pub use document_link::*; - -mod document_symbols; -pub use document_symbols::*; - -mod file_operations; -pub use file_operations::*; - -mod folding_range; -pub use folding_range::*; - -mod formatting; -pub use formatting::*; - -mod hover; -pub use hover::*; - -#[cfg(feature = "proposed")] -mod inlay_hint; -#[cfg(feature = "proposed")] -pub use inlay_hint::*; - -mod moniker; -pub use moniker::*; - -mod progress; -pub use progress::*; - -mod references; -pub use references::*; - -mod rename; -pub use rename::*; - -pub mod selection_range; -pub use selection_range::*; - -mod semantic_tokens; -pub use semantic_tokens::*; - -mod signature_help; -pub use signature_help::*; - -mod linked_editing; -pub use linked_editing::*; - -mod window; -pub use window::*; - -mod workspace_folders; -pub use workspace_folders::*; - -mod workspace_symbols; -pub use workspace_symbols::*; - -pub mod lsif; - -mod trace; -pub use trace::*; - -/* ----------------- Auxiliary types ----------------- */ - -#[derive(Debug, Eq, Hash, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum NumberOrString { - Number(i32), - String(String), -} - -/* ----------------- Cancel support ----------------- */ - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct CancelParams { - /// The request id to cancel. - pub id: NumberOrString, -} - -/* ----------------- Basic JSON Structures ----------------- */ - -/// The LSP any type -/// -/// @since 3.17.0 -#[cfg(feature = "proposed")] -pub type LSPAny = serde_json::Value; - -/// LSP object definition. -/// -/// @since 3.17.0 -#[cfg(feature = "proposed")] -pub type LSPObject = serde_json::Map<String, serde_json::Value>; - -/// LSP arrays. -/// -/// @since 3.17.0 -#[cfg(feature = "proposed")] -pub type LSPArray = Vec<serde_json::Value>; - -/// Position in a text document expressed as zero-based line and character offset. -/// A position is between two characters like an 'insert' cursor in a editor. -#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Copy, Clone, Default, Deserialize, Serialize)] -pub struct Position { - /// Line position in a document (zero-based). - pub line: u32, - /// Character offset on a line in a document (zero-based). The meaning of this - /// offset is determined by the negotiated `PositionEncodingKind`. - /// - /// If the character value is greater than the line length it defaults back - /// to the line length. - pub character: u32, -} - -impl Position { - pub fn new(line: u32, character: u32) -> Position { - Position { line, character } - } -} - -/// A range in a text document expressed as (zero-based) start and end positions. -/// A range is comparable to a selection in an editor. Therefore the end position is exclusive. -#[derive(Debug, Eq, PartialEq, Copy, Clone, Default, Deserialize, Serialize)] -pub struct Range { - /// The range's start position. - pub start: Position, - /// The range's end position. - pub end: Position, -} - -impl Range { - pub fn new(start: Position, end: Position) -> Range { - Range { start, end } - } -} - -/// Represents a location inside a resource, such as a line inside a text file. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct Location { - pub uri: Url, - pub range: Range, -} - -impl Location { - pub fn new(uri: Url, range: Range) -> Location { - Location { uri, range } - } -} - -/// Represents a link between a source and a target location. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct LocationLink { - /// Span of the origin of this link. - /// - /// Used as the underlined span for mouse interaction. Defaults to the word range at - /// the mouse position. - #[serde(skip_serializing_if = "Option::is_none")] - pub origin_selection_range: Option<Range>, - - /// The target resource identifier of this link. - pub target_uri: Url, - - /// The full target range of this link. - pub target_range: Range, - - /// The span of this link. - pub target_selection_range: Range, -} - -/// A type indicating how positions are encoded, -/// specifically what column offsets mean. -/// -/// @since 3.17.0 -#[derive(Debug, Eq, PartialEq, Hash, PartialOrd, Clone, Deserialize, Serialize)] -#[cfg(feature = "proposed")] -pub struct PositionEncodingKind(std::borrow::Cow<'static, str>); - -#[cfg(feature = "proposed")] -impl PositionEncodingKind { - /// Character offsets count UTF-8 code units. - pub const UTF8: PositionEncodingKind = PositionEncodingKind::new("utf-8"); - - /// Character offsets count UTF-16 code units. - /// - /// This is the default and must always be supported - /// by servers - pub const UTF16: PositionEncodingKind = PositionEncodingKind::new("utf-16"); - - /// Character offsets count UTF-32 code units. - /// - /// Implementation note: these are the same as Unicode code points, - /// so this `PositionEncodingKind` may also be used for an - /// encoding-agnostic representation of character offsets. - pub const UTF32: PositionEncodingKind = PositionEncodingKind::new("utf-32"); - - pub const fn new(tag: &'static str) -> Self { - PositionEncodingKind(std::borrow::Cow::Borrowed(tag)) - } - - pub fn as_str(&self) -> &str { - &self.0 - } -} - -#[cfg(feature = "proposed")] -impl From<String> for PositionEncodingKind { - fn from(from: String) -> Self { - PositionEncodingKind(std::borrow::Cow::from(from)) - } -} - -#[cfg(feature = "proposed")] -impl From<&'static str> for PositionEncodingKind { - fn from(from: &'static str) -> Self { - PositionEncodingKind::new(from) - } -} - -/// Represents a diagnostic, such as a compiler error or warning. -/// Diagnostic objects are only valid in the scope of a resource. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct Diagnostic { - /// The range at which the message applies. - pub range: Range, - - /// The diagnostic's severity. Can be omitted. If omitted it is up to the - /// client to interpret diagnostics as error, warning, info or hint. - #[serde(skip_serializing_if = "Option::is_none")] - pub severity: Option<DiagnosticSeverity>, - - /// The diagnostic's code. Can be omitted. - #[serde(skip_serializing_if = "Option::is_none")] - pub code: Option<NumberOrString>, - - /// An optional property to describe the error code. - /// - /// since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub code_description: Option<CodeDescription>, - - /// A human-readable string describing the source of this - /// diagnostic, e.g. 'typescript' or 'super lint'. - #[serde(skip_serializing_if = "Option::is_none")] - pub source: Option<String>, - - /// The diagnostic's message. - pub message: String, - - /// An array of related diagnostic information, e.g. when symbol-names within - /// a scope collide all definitions can be marked via this property. - #[serde(skip_serializing_if = "Option::is_none")] - pub related_information: Option<Vec<DiagnosticRelatedInformation>>, - - /// Additional metadata about the diagnostic. - #[serde(skip_serializing_if = "Option::is_none")] - pub tags: Option<Vec<DiagnosticTag>>, - - /// A data entry field that is preserved between a `textDocument/publishDiagnostics` - /// notification and `textDocument/codeAction` request. - /// - /// since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub data: Option<serde_json::Value>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct CodeDescription { - pub href: Url, -} - -impl Diagnostic { - pub fn new( - range: Range, - severity: Option<DiagnosticSeverity>, - code: Option<NumberOrString>, - source: Option<String>, - message: String, - related_information: Option<Vec<DiagnosticRelatedInformation>>, - tags: Option<Vec<DiagnosticTag>>, - ) -> Diagnostic { - Diagnostic { - range, - severity, - code, - source, - message, - related_information, - tags, - ..Diagnostic::default() - } - } - - pub fn new_simple(range: Range, message: String) -> Diagnostic { - Self::new(range, None, None, None, message, None, None) - } - - pub fn new_with_code_number( - range: Range, - severity: DiagnosticSeverity, - code_number: i32, - source: Option<String>, - message: String, - ) -> Diagnostic { - let code = Some(NumberOrString::Number(code_number)); - Self::new(range, Some(severity), code, source, message, None, None) - } -} - -/// The protocol currently supports the following diagnostic severities: -#[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Deserialize, Serialize)] -#[serde(transparent)] -pub struct DiagnosticSeverity(i32); -lsp_enum! { -impl DiagnosticSeverity { - /// Reports an error. - pub const ERROR: DiagnosticSeverity = DiagnosticSeverity(1); - /// Reports a warning. - pub const WARNING: DiagnosticSeverity = DiagnosticSeverity(2); - /// Reports an information. - pub const INFORMATION: DiagnosticSeverity = DiagnosticSeverity(3); - /// Reports a hint. - pub const HINT: DiagnosticSeverity = DiagnosticSeverity(4); -} -} - -/// Represents a related message and source code location for a diagnostic. This -/// should be used to point to code locations that cause or related to a -/// diagnostics, e.g when duplicating a symbol in a scope. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct DiagnosticRelatedInformation { - /// The location of this related diagnostic information. - pub location: Location, - - /// The message of this related diagnostic information. - pub message: String, -} - -/// The diagnostic tags. -#[derive(Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(transparent)] -pub struct DiagnosticTag(i32); -lsp_enum! { -impl DiagnosticTag { - /// Unused or unnecessary code. - /// Clients are allowed to render diagnostics with this tag faded out instead of having - /// an error squiggle. - pub const UNNECESSARY: DiagnosticTag = DiagnosticTag(1); - - /// Deprecated or obsolete code. - /// Clients are allowed to rendered diagnostics with this tag strike through. - pub const DEPRECATED: DiagnosticTag = DiagnosticTag(2); -} -} - -/// Represents a reference to a command. Provides a title which will be used to represent a command in the UI. -/// Commands are identitifed using a string identifier and the protocol currently doesn't specify a set of -/// well known commands. So executing a command requires some tool extension code. -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -pub struct Command { - /// Title of the command, like `save`. - pub title: String, - /// The identifier of the actual command handler. - pub command: String, - /// Arguments that the command handler should be - /// invoked with. - #[serde(skip_serializing_if = "Option::is_none")] - pub arguments: Option<Vec<Value>>, -} - -impl Command { - pub fn new(title: String, command: String, arguments: Option<Vec<Value>>) -> Command { - Command { - title, - command, - arguments, - } - } -} - -/// A textual edit applicable to a text document. -/// -/// If n `TextEdit`s are applied to a text document all text edits describe changes to the initial document version. -/// Execution wise text edits should applied from the bottom to the top of the text document. Overlapping text edits -/// are not supported. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextEdit { - /// The range of the text document to be manipulated. To insert - /// text into a document create a range where start === end. - pub range: Range, - /// The string to be inserted. For delete operations use an - /// empty string. - pub new_text: String, -} - -impl TextEdit { - pub fn new(range: Range, new_text: String) -> TextEdit { - TextEdit { range, new_text } - } -} - -/// An identifier referring to a change annotation managed by a workspace -/// edit. -/// -/// @since 3.16.0. -pub type ChangeAnnotationIdentifier = String; - -/// A special text edit with an additional change annotation. -/// -/// @since 3.16.0. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct AnnotatedTextEdit { - #[serde(flatten)] - pub text_edit: TextEdit, - - /// The actual annotation - pub annotation_id: ChangeAnnotationIdentifier, -} - -/// Describes textual changes on a single text document. The text document is referred to as a -/// `OptionalVersionedTextDocumentIdentifier` to allow clients to check the text document version before an -/// edit is applied. A `TextDocumentEdit` describes all changes on a version Si and after they are -/// applied move the document to version Si+1. So the creator of a `TextDocumentEdit` doesn't need to -/// sort the array or do any kind of ordering. However the edits must be non overlapping. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentEdit { - /// The text document to change. - pub text_document: OptionalVersionedTextDocumentIdentifier, - - /// The edits to be applied. - /// - /// @since 3.16.0 - support for AnnotatedTextEdit. This is guarded by the - /// client capability `workspace.workspaceEdit.changeAnnotationSupport` - pub edits: Vec<OneOf<TextEdit, AnnotatedTextEdit>>, -} - -/// Additional information that describes document changes. -/// -/// @since 3.16.0. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ChangeAnnotation { - /// A human-readable string describing the actual change. The string - /// is rendered prominent in the user interface. - pub label: String, - - /// A flag which indicates that user confirmation is needed - /// before applying the change. - #[serde(skip_serializing_if = "Option::is_none")] - pub needs_confirmation: Option<bool>, - - /// A human-readable string which is rendered less prominent in - /// the user interface. - #[serde(skip_serializing_if = "Option::is_none")] - pub description: Option<String>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ChangeAnnotationWorkspaceEditClientCapabilities { - /// Whether the client groups edits with equal labels into tree nodes, - /// for instance all edits labelled with "Changes in Strings" would - /// be a tree node. - #[serde(skip_serializing_if = "Option::is_none")] - pub groups_on_label: Option<bool>, -} - -/// Options to create a file. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct CreateFileOptions { - /// Overwrite existing file. Overwrite wins over `ignoreIfExists` - #[serde(skip_serializing_if = "Option::is_none")] - pub overwrite: Option<bool>, - /// Ignore if exists. - #[serde(skip_serializing_if = "Option::is_none")] - pub ignore_if_exists: Option<bool>, -} - -/// Create file operation -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct CreateFile { - /// The resource to create. - pub uri: Url, - /// Additional options - #[serde(skip_serializing_if = "Option::is_none")] - pub options: Option<CreateFileOptions>, - - /// An optional annotation identifer describing the operation. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub annotation_id: Option<ChangeAnnotationIdentifier>, -} - -/// Rename file options -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct RenameFileOptions { - /// Overwrite target if existing. Overwrite wins over `ignoreIfExists` - #[serde(skip_serializing_if = "Option::is_none")] - pub overwrite: Option<bool>, - /// Ignores if target exists. - #[serde(skip_serializing_if = "Option::is_none")] - pub ignore_if_exists: Option<bool>, -} - -/// Rename file operation -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct RenameFile { - /// The old (existing) location. - pub old_uri: Url, - /// The new location. - pub new_uri: Url, - /// Rename options. - #[serde(skip_serializing_if = "Option::is_none")] - pub options: Option<RenameFileOptions>, - - /// An optional annotation identifer describing the operation. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub annotation_id: Option<ChangeAnnotationIdentifier>, -} - -/// Delete file options -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DeleteFileOptions { - /// Delete the content recursively if a folder is denoted. - #[serde(skip_serializing_if = "Option::is_none")] - pub recursive: Option<bool>, - /// Ignore the operation if the file doesn't exist. - #[serde(skip_serializing_if = "Option::is_none")] - pub ignore_if_not_exists: Option<bool>, - - /// An optional annotation identifer describing the operation. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub annotation_id: Option<ChangeAnnotationIdentifier>, -} - -/// Delete file operation -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DeleteFile { - /// The file to delete. - pub uri: Url, - /// Delete options. - #[serde(skip_serializing_if = "Option::is_none")] - pub options: Option<DeleteFileOptions>, -} - -/// A workspace edit represents changes to many resources managed in the workspace. -/// The edit should either provide `changes` or `documentChanges`. -/// If the client can handle versioned document edits and if `documentChanges` are present, -/// the latter are preferred over `changes`. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct WorkspaceEdit { - /// Holds changes to existing resources. - #[serde(with = "url_map")] - #[serde(skip_serializing_if = "Option::is_none")] - #[serde(default)] - pub changes: Option<HashMap<Url, Vec<TextEdit>>>, // changes?: { [uri: string]: TextEdit[]; }; - - /// Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes - /// are either an array of `TextDocumentEdit`s to express changes to n different text documents - /// where each text document edit addresses a specific version of a text document. Or it can contain - /// above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations. - /// - /// Whether a client supports versioned document edits is expressed via - /// `workspace.workspaceEdit.documentChanges` client capability. - /// - /// If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then - /// only plain `TextEdit`s using the `changes` property are supported. - #[serde(skip_serializing_if = "Option::is_none")] - pub document_changes: Option<DocumentChanges>, - - /// A map of change annotations that can be referenced in - /// `AnnotatedTextEdit`s or create, rename and delete file / folder - /// operations. - /// - /// Whether clients honor this property depends on the client capability - /// `workspace.changeAnnotationSupport`. - /// - /// @since 3.16.0 - /// - #[serde(skip_serializing_if = "Option::is_none")] - pub change_annotations: Option<HashMap<ChangeAnnotationIdentifier, ChangeAnnotation>>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum DocumentChanges { - Edits(Vec<TextDocumentEdit>), - Operations(Vec<DocumentChangeOperation>), -} - -// TODO: Once https://github.com/serde-rs/serde/issues/912 is solved -// we can remove ResourceOp and switch to the following implementation -// of DocumentChangeOperation: -// -// #[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -// #[serde(tag = "kind", rename_all="lowercase" )] -// pub enum DocumentChangeOperation { -// Create(CreateFile), -// Rename(RenameFile), -// Delete(DeleteFile), -// -// #[serde(other)] -// Edit(TextDocumentEdit), -// } - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged, rename_all = "lowercase")] -pub enum DocumentChangeOperation { - Op(ResourceOp), - Edit(TextDocumentEdit), -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(tag = "kind", rename_all = "lowercase")] -pub enum ResourceOp { - Create(CreateFile), - Rename(RenameFile), - Delete(DeleteFile), -} - -pub type DidChangeConfigurationClientCapabilities = DynamicRegistrationClientCapabilities; - -#[derive(Debug, Default, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ConfigurationParams { - pub items: Vec<ConfigurationItem>, -} - -#[derive(Debug, Default, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ConfigurationItem { - /// The scope to get the configuration section for. - #[serde(skip_serializing_if = "Option::is_none")] - pub scope_uri: Option<Url>, - - ///The configuration section asked for. - #[serde(skip_serializing_if = "Option::is_none")] - pub section: Option<String>, -} - -mod url_map { - use std::fmt; - - use super::*; - - pub fn deserialize<'de, D>( - deserializer: D, - ) -> Result<Option<HashMap<Url, Vec<TextEdit>>>, D::Error> - where - D: serde::Deserializer<'de>, - { - struct UrlMapVisitor; - impl<'de> de::Visitor<'de> for UrlMapVisitor { - type Value = HashMap<Url, Vec<TextEdit>>; - - fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { - formatter.write_str("map") - } - - fn visit_map<M>(self, mut visitor: M) -> Result<Self::Value, M::Error> - where - M: de::MapAccess<'de>, - { - let mut values = HashMap::with_capacity(visitor.size_hint().unwrap_or(0)); - - // While there are entries remaining in the input, add them - // into our map. - while let Some((key, value)) = visitor.next_entry::<Url, _>()? { - values.insert(key, value); - } - - Ok(values) - } - } - - struct OptionUrlMapVisitor; - impl<'de> de::Visitor<'de> for OptionUrlMapVisitor { - type Value = Option<HashMap<Url, Vec<TextEdit>>>; - - fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { - formatter.write_str("option") - } - - #[inline] - fn visit_unit<E>(self) -> Result<Self::Value, E> - where - E: serde::de::Error, - { - Ok(None) - } - - #[inline] - fn visit_none<E>(self) -> Result<Self::Value, E> - where - E: serde::de::Error, - { - Ok(None) - } - - #[inline] - fn visit_some<D>(self, deserializer: D) -> Result<Self::Value, D::Error> - where - D: serde::Deserializer<'de>, - { - deserializer.deserialize_map(UrlMapVisitor).map(Some) - } - } - - // Instantiate our Visitor and ask the Deserializer to drive - // it over the input data, resulting in an instance of MyMap. - deserializer.deserialize_option(OptionUrlMapVisitor) - } - - pub fn serialize<S>( - changes: &Option<HashMap<Url, Vec<TextEdit>>>, - serializer: S, - ) -> Result<S::Ok, S::Error> - where - S: serde::Serializer, - { - use serde::ser::SerializeMap; - - match *changes { - Some(ref changes) => { - let mut map = serializer.serialize_map(Some(changes.len()))?; - for (k, v) in changes { - map.serialize_entry(k.as_str(), v)?; - } - map.end() - } - None => serializer.serialize_none(), - } - } -} - -impl WorkspaceEdit { - pub fn new(changes: HashMap<Url, Vec<TextEdit>>) -> WorkspaceEdit { - WorkspaceEdit { - changes: Some(changes), - document_changes: None, - ..Default::default() - } - } -} - -/// Text documents are identified using a URI. On the protocol level, URIs are passed as strings. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct TextDocumentIdentifier { - // !!!!!! Note: - // In the spec VersionedTextDocumentIdentifier extends TextDocumentIdentifier - // This modelled by "mixing-in" TextDocumentIdentifier in VersionedTextDocumentIdentifier, - // so any changes to this type must be effected in the sub-type as well. - /// The text document's URI. - pub uri: Url, -} - -impl TextDocumentIdentifier { - pub fn new(uri: Url) -> TextDocumentIdentifier { - TextDocumentIdentifier { uri } - } -} - -/// An item to transfer a text document from the client to the server. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentItem { - /// The text document's URI. - pub uri: Url, - - /// The text document's language identifier. - pub language_id: String, - - /// The version number of this document (it will strictly increase after each - /// change, including undo/redo). - pub version: i32, - - /// The content of the opened text document. - pub text: String, -} - -impl TextDocumentItem { - pub fn new(uri: Url, language_id: String, version: i32, text: String) -> TextDocumentItem { - TextDocumentItem { - uri, - language_id, - version, - text, - } - } -} - -/// An identifier to denote a specific version of a text document. This information usually flows from the client to the server. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct VersionedTextDocumentIdentifier { - // This field was "mixed-in" from TextDocumentIdentifier - /// The text document's URI. - pub uri: Url, - - /// The version number of this document. - /// - /// The version number of a document will increase after each change, - /// including undo/redo. The number doesn't need to be consecutive. - pub version: i32, -} - -impl VersionedTextDocumentIdentifier { - pub fn new(uri: Url, version: i32) -> VersionedTextDocumentIdentifier { - VersionedTextDocumentIdentifier { uri, version } - } -} - -/// An identifier which optionally denotes a specific version of a text document. This information usually flows from the server to the client -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct OptionalVersionedTextDocumentIdentifier { - // This field was "mixed-in" from TextDocumentIdentifier - /// The text document's URI. - pub uri: Url, - - /// The version number of this document. If an optional versioned text document - /// identifier is sent from the server to the client and the file is not - /// open in the editor (the server has not received an open notification - /// before) the server can send `null` to indicate that the version is - /// known and the content on disk is the master (as specified with document - /// content ownership). - /// - /// The version number of a document will increase after each change, - /// including undo/redo. The number doesn't need to be consecutive. - pub version: Option<i32>, -} - -impl OptionalVersionedTextDocumentIdentifier { - pub fn new(uri: Url, version: i32) -> OptionalVersionedTextDocumentIdentifier { - OptionalVersionedTextDocumentIdentifier { - uri, - version: Some(version), - } - } -} - -/// A parameter literal used in requests to pass a text document and a position inside that document. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentPositionParams { - // !!!!!! Note: - // In the spec ReferenceParams extends TextDocumentPositionParams - // This modelled by "mixing-in" TextDocumentPositionParams in ReferenceParams, - // so any changes to this type must be effected in sub-type as well. - /// The text document. - pub text_document: TextDocumentIdentifier, - - /// The position inside the text document. - pub position: Position, -} - -impl TextDocumentPositionParams { - pub fn new( - text_document: TextDocumentIdentifier, - position: Position, - ) -> TextDocumentPositionParams { - TextDocumentPositionParams { - text_document, - position, - } - } -} - -/// A document filter denotes a document through properties like language, schema or pattern. -/// Examples are a filter that applies to TypeScript files on disk or a filter the applies to JSON -/// files with name package.json: -/// -/// { language: 'typescript', scheme: 'file' } -/// { language: 'json', pattern: '**/package.json' } -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct DocumentFilter { - /// A language id, like `typescript`. - #[serde(skip_serializing_if = "Option::is_none")] - pub language: Option<String>, - - /// A Uri [scheme](#Uri.scheme), like `file` or `untitled`. - #[serde(skip_serializing_if = "Option::is_none")] - pub scheme: Option<String>, - - /// A glob pattern, like `*.{ts,js}`. - #[serde(skip_serializing_if = "Option::is_none")] - pub pattern: Option<String>, -} - -/// A document selector is the combination of one or many document filters. -pub type DocumentSelector = Vec<DocumentFilter>; - -// ========================= Actual Protocol ========================= - -#[derive(Debug, PartialEq, Clone, Deserialize, Serialize, Default)] -#[serde(rename_all = "camelCase")] -pub struct InitializeParams { - /// The process Id of the parent process that started - /// the server. Is null if the process has not been started by another process. - /// If the parent process is not alive then the server should exit (see exit notification) its process. - pub process_id: Option<u32>, - - /// The rootPath of the workspace. Is null - /// if no folder is open. - #[serde(skip_serializing_if = "Option::is_none")] - #[deprecated(note = "Use `root_uri` instead when possible")] - pub root_path: Option<String>, - - /// The rootUri of the workspace. Is null if no - /// folder is open. If both `rootPath` and `rootUri` are set - /// `rootUri` wins. - /// - /// Deprecated in favour of `workspaceFolders` - #[serde(default)] - pub root_uri: Option<Url>, - - /// User provided initialization options. - #[serde(skip_serializing_if = "Option::is_none")] - pub initialization_options: Option<Value>, - - /// The capabilities provided by the client (editor or tool) - pub capabilities: ClientCapabilities, - - /// The initial trace setting. If omitted trace is disabled ('off'). - #[serde(default)] - #[serde(skip_serializing_if = "Option::is_none")] - pub trace: Option<TraceValue>, - - /// The workspace folders configured in the client when the server starts. - /// This property is only available if the client supports workspace folders. - /// It can be `null` if the client supports workspace folders but none are - /// configured. - #[serde(skip_serializing_if = "Option::is_none")] - pub workspace_folders: Option<Vec<WorkspaceFolder>>, - - /// Information about the client. - #[serde(skip_serializing_if = "Option::is_none")] - pub client_info: Option<ClientInfo>, - - /// The locale the client is currently showing the user interface - /// in. This must not necessarily be the locale of the operating - /// system. - /// - /// Uses IETF language tags as the value's syntax - /// (See <https://en.wikipedia.org/wiki/IETF_language_tag>) - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub locale: Option<String>, -} - -#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)] -pub struct ClientInfo { - /// The name of the client as defined by the client. - pub name: String, - /// The client's version as defined by the client. - #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option<String>, -} - -#[derive(Debug, PartialEq, Clone, Copy, Deserialize, Serialize)] -pub struct InitializedParams {} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct GenericRegistrationOptions { - #[serde(flatten)] - pub text_document_registration_options: TextDocumentRegistrationOptions, - - #[serde(flatten)] - pub options: GenericOptions, - - #[serde(flatten)] - pub static_registration_options: StaticRegistrationOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct GenericOptions { - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct GenericParams { - #[serde(flatten)] - pub text_document_position_params: TextDocumentPositionParams, - - #[serde(flatten)] - pub work_done_progress_params: WorkDoneProgressParams, - - #[serde(flatten)] - pub partial_result_params: PartialResultParams, -} - -#[derive(Debug, Eq, PartialEq, Clone, Copy, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DynamicRegistrationClientCapabilities { - /// This capability supports dynamic registration. - #[serde(skip_serializing_if = "Option::is_none")] - pub dynamic_registration: Option<bool>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Copy, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct GotoCapability { - #[serde(skip_serializing_if = "Option::is_none")] - pub dynamic_registration: Option<bool>, - - /// The client supports additional metadata in the form of definition links. - #[serde(skip_serializing_if = "Option::is_none")] - pub link_support: Option<bool>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct WorkspaceEditClientCapabilities { - /// The client supports versioned document changes in `WorkspaceEdit`s - #[serde(skip_serializing_if = "Option::is_none")] - pub document_changes: Option<bool>, - - /// The resource operations the client supports. Clients should at least - /// support 'create', 'rename' and 'delete' files and folders. - #[serde(skip_serializing_if = "Option::is_none")] - pub resource_operations: Option<Vec<ResourceOperationKind>>, - - /// The failure handling strategy of a client if applying the workspace edit - /// failes. - #[serde(skip_serializing_if = "Option::is_none")] - pub failure_handling: Option<FailureHandlingKind>, - - /// Whether the client normalizes line endings to the client specific - /// setting. - /// If set to `true` the client will normalize line ending characters - /// in a workspace edit containg to the client specific new line - /// character. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub normalizes_line_endings: Option<bool>, - - /// Whether the client in general supports change annotations on text edits, - /// create file, rename file and delete file changes. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub change_annotation_support: Option<ChangeAnnotationWorkspaceEditClientCapabilities>, -} - -#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Copy, Clone)] -#[serde(rename_all = "lowercase")] -pub enum ResourceOperationKind { - Create, - Rename, - Delete, -} - -#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Copy, Clone)] -#[serde(rename_all = "camelCase")] -pub enum FailureHandlingKind { - Abort, - Transactional, - TextOnlyTransactional, - Undo, -} - -/// A symbol kind. -#[derive(Eq, PartialEq, Copy, Clone, Serialize, Deserialize)] -#[serde(transparent)] -pub struct SymbolKind(i32); -lsp_enum! { -impl SymbolKind { - pub const FILE: SymbolKind = SymbolKind(1); - pub const MODULE: SymbolKind = SymbolKind(2); - pub const NAMESPACE: SymbolKind = SymbolKind(3); - pub const PACKAGE: SymbolKind = SymbolKind(4); - pub const CLASS: SymbolKind = SymbolKind(5); - pub const METHOD: SymbolKind = SymbolKind(6); - pub const PROPERTY: SymbolKind = SymbolKind(7); - pub const FIELD: SymbolKind = SymbolKind(8); - pub const CONSTRUCTOR: SymbolKind = SymbolKind(9); - pub const ENUM: SymbolKind = SymbolKind(10); - pub const INTERFACE: SymbolKind = SymbolKind(11); - pub const FUNCTION: SymbolKind = SymbolKind(12); - pub const VARIABLE: SymbolKind = SymbolKind(13); - pub const CONSTANT: SymbolKind = SymbolKind(14); - pub const STRING: SymbolKind = SymbolKind(15); - pub const NUMBER: SymbolKind = SymbolKind(16); - pub const BOOLEAN: SymbolKind = SymbolKind(17); - pub const ARRAY: SymbolKind = SymbolKind(18); - pub const OBJECT: SymbolKind = SymbolKind(19); - pub const KEY: SymbolKind = SymbolKind(20); - pub const NULL: SymbolKind = SymbolKind(21); - pub const ENUM_MEMBER: SymbolKind = SymbolKind(22); - pub const STRUCT: SymbolKind = SymbolKind(23); - pub const EVENT: SymbolKind = SymbolKind(24); - pub const OPERATOR: SymbolKind = SymbolKind(25); - pub const TYPE_PARAMETER: SymbolKind = SymbolKind(26); -} -} - -/// Specific capabilities for the `SymbolKind` in the `workspace/symbol` request. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct SymbolKindCapability { - /// The symbol kind values the client supports. When this - /// property exists the client also guarantees that it will - /// handle values outside its set gracefully and falls back - /// to a default value when unknown. - /// - /// If this property is not present the client only supports - /// the symbol kinds from `File` to `Array` as defined in - /// the initial version of the protocol. - pub value_set: Option<Vec<SymbolKind>>, -} - -/// Workspace specific client capabilities. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct WorkspaceClientCapabilities { - /// The client supports applying batch edits to the workspace by supporting - /// the request 'workspace/applyEdit' - #[serde(skip_serializing_if = "Option::is_none")] - pub apply_edit: Option<bool>, - - /// Capabilities specific to `WorkspaceEdit`s - #[serde(skip_serializing_if = "Option::is_none")] - pub workspace_edit: Option<WorkspaceEditClientCapabilities>, - - /// Capabilities specific to the `workspace/didChangeConfiguration` notification. - #[serde(skip_serializing_if = "Option::is_none")] - pub did_change_configuration: Option<DidChangeConfigurationClientCapabilities>, - - /// Capabilities specific to the `workspace/didChangeWatchedFiles` notification. - #[serde(skip_serializing_if = "Option::is_none")] - pub did_change_watched_files: Option<DidChangeWatchedFilesClientCapabilities>, - - /// Capabilities specific to the `workspace/symbol` request. - #[serde(skip_serializing_if = "Option::is_none")] - pub symbol: Option<WorkspaceSymbolClientCapabilities>, - - /// Capabilities specific to the `workspace/executeCommand` request. - #[serde(skip_serializing_if = "Option::is_none")] - pub execute_command: Option<ExecuteCommandClientCapabilities>, - - /// The client has support for workspace folders. - /// since 3.6.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub workspace_folders: Option<bool>, - - /// The client supports `workspace/configuration` requests. - /// since 3.6.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub configuration: Option<bool>, - - /// Capabilities specific to the semantic token requsts scoped to the workspace. - /// since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub semantic_tokens: Option<SemanticTokensWorkspaceClientCapabilities>, - - /// Capabilities specific to the code lens requests scoped to the workspace. - /// since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub code_lens: Option<CodeLensWorkspaceClientCapabilities>, - - /// The client has support for file requests/notifications. - /// since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub file_operations: Option<WorkspaceFileOperationsClientCapabilities>, - - #[serde(skip_serializing_if = "Option::is_none")] - #[cfg(feature = "proposed")] - pub inlay_hint: Option<InlayHintWorkspaceClientCapabilities>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentSyncClientCapabilities { - /// Whether text document synchronization supports dynamic registration. - #[serde(skip_serializing_if = "Option::is_none")] - pub dynamic_registration: Option<bool>, - - /// The client supports sending will save notifications. - #[serde(skip_serializing_if = "Option::is_none")] - pub will_save: Option<bool>, - - /// The client supports sending a will save request and - /// waits for a response providing text edits which will - /// be applied to the document before it is saved. - #[serde(skip_serializing_if = "Option::is_none")] - pub will_save_wait_until: Option<bool>, - - /// The client supports did save notifications. - #[serde(skip_serializing_if = "Option::is_none")] - pub did_save: Option<bool>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct PublishDiagnosticsClientCapabilities { - /// Whether the clients accepts diagnostics with related information. - #[serde(skip_serializing_if = "Option::is_none")] - pub related_information: Option<bool>, - - /// Client supports the tag property to provide meta data about a diagnostic. - /// Clients supporting tags have to handle unknown tags gracefully. - #[serde( - default, - skip_serializing_if = "Option::is_none", - deserialize_with = "TagSupport::deserialize_compat" - )] - pub tag_support: Option<TagSupport<DiagnosticTag>>, - - /// Whether the client interprets the version property of the - /// `textDocument/publishDiagnostics` notification's parameter. - /// - /// 3.15.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub version_support: Option<bool>, - - /// Client supports a codeDescription property - /// - /// 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub code_description_support: Option<bool>, - - /// Whether code action supports the `data` property which is - /// preserved between a `textDocument/publishDiagnostics` and - /// `textDocument/codeAction` request. - /// - /// 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub data_support: Option<bool>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TagSupport<T> { - /// The tags supported by the client. - pub value_set: Vec<T>, -} - -impl<T> TagSupport<T> { - /// Support for deserializing a boolean tag Support, in case it's present. - /// - /// This is currently the case for vscode 1.41.1 - fn deserialize_compat<'de, S>(serializer: S) -> Result<Option<TagSupport<T>>, S::Error> - where - S: serde::Deserializer<'de>, - T: serde::Deserialize<'de>, - { - Ok( - match Option::<Value>::deserialize(serializer).map_err(serde::de::Error::custom)? { - Some(Value::Bool(false)) => None, - Some(Value::Bool(true)) => Some(TagSupport { value_set: vec![] }), - Some(other) => { - Some(TagSupport::<T>::deserialize(other).map_err(serde::de::Error::custom)?) - } - None => None, - }, - ) - } -} - -/// Text document specific client capabilities. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentClientCapabilities { - #[serde(skip_serializing_if = "Option::is_none")] - pub synchronization: Option<TextDocumentSyncClientCapabilities>, - /// Capabilities specific to the `textDocument/completion` - #[serde(skip_serializing_if = "Option::is_none")] - pub completion: Option<CompletionClientCapabilities>, - - /// Capabilities specific to the `textDocument/hover` - #[serde(skip_serializing_if = "Option::is_none")] - pub hover: Option<HoverClientCapabilities>, - - /// Capabilities specific to the `textDocument/signatureHelp` - #[serde(skip_serializing_if = "Option::is_none")] - pub signature_help: Option<SignatureHelpClientCapabilities>, - - /// Capabilities specific to the `textDocument/references` - #[serde(skip_serializing_if = "Option::is_none")] - pub references: Option<ReferenceClientCapabilities>, - - /// Capabilities specific to the `textDocument/documentHighlight` - #[serde(skip_serializing_if = "Option::is_none")] - pub document_highlight: Option<DocumentHighlightClientCapabilities>, - - /// Capabilities specific to the `textDocument/documentSymbol` - #[serde(skip_serializing_if = "Option::is_none")] - pub document_symbol: Option<DocumentSymbolClientCapabilities>, - /// Capabilities specific to the `textDocument/formatting` - #[serde(skip_serializing_if = "Option::is_none")] - pub formatting: Option<DocumentFormattingClientCapabilities>, - - /// Capabilities specific to the `textDocument/rangeFormatting` - #[serde(skip_serializing_if = "Option::is_none")] - pub range_formatting: Option<DocumentRangeFormattingClientCapabilities>, - - /// Capabilities specific to the `textDocument/onTypeFormatting` - #[serde(skip_serializing_if = "Option::is_none")] - pub on_type_formatting: Option<DocumentOnTypeFormattingClientCapabilities>, - - /// Capabilities specific to the `textDocument/declaration` - #[serde(skip_serializing_if = "Option::is_none")] - pub declaration: Option<GotoCapability>, - - /// Capabilities specific to the `textDocument/definition` - #[serde(skip_serializing_if = "Option::is_none")] - pub definition: Option<GotoCapability>, - - /// Capabilities specific to the `textDocument/typeDefinition` - #[serde(skip_serializing_if = "Option::is_none")] - pub type_definition: Option<GotoCapability>, - - /// Capabilities specific to the `textDocument/implementation` - #[serde(skip_serializing_if = "Option::is_none")] - pub implementation: Option<GotoCapability>, - - /// Capabilities specific to the `textDocument/codeAction` - #[serde(skip_serializing_if = "Option::is_none")] - pub code_action: Option<CodeActionClientCapabilities>, - - /// Capabilities specific to the `textDocument/codeLens` - #[serde(skip_serializing_if = "Option::is_none")] - pub code_lens: Option<CodeLensClientCapabilities>, - - /// Capabilities specific to the `textDocument/documentLink` - #[serde(skip_serializing_if = "Option::is_none")] - pub document_link: Option<DocumentLinkClientCapabilities>, - - /// Capabilities specific to the `textDocument/documentColor` and the - /// `textDocument/colorPresentation` request. - #[serde(skip_serializing_if = "Option::is_none")] - pub color_provider: Option<DocumentColorClientCapabilities>, - - /// Capabilities specific to the `textDocument/rename` - #[serde(skip_serializing_if = "Option::is_none")] - pub rename: Option<RenameClientCapabilities>, - - /// Capabilities specific to `textDocument/publishDiagnostics`. - #[serde(skip_serializing_if = "Option::is_none")] - pub publish_diagnostics: Option<PublishDiagnosticsClientCapabilities>, - - /// Capabilities specific to `textDocument/foldingRange` requests. - #[serde(skip_serializing_if = "Option::is_none")] - pub folding_range: Option<FoldingRangeClientCapabilities>, - - /// Capabilities specific to the `textDocument/selectionRange` request. - /// - /// @since 3.15.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub selection_range: Option<SelectionRangeClientCapabilities>, - - /// Capabilities specific to `textDocument/linkedEditingRange` requests. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub linked_editing_range: Option<LinkedEditingRangeClientCapabilities>, - - /// Capabilities specific to the various call hierarchy requests. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub call_hierarchy: Option<CallHierarchyClientCapabilities>, - - /// Capabilities specific to the `textDocument/semanticTokens/*` requests. - #[serde(skip_serializing_if = "Option::is_none")] - pub semantic_tokens: Option<SemanticTokensClientCapabilities>, - - /// Capabilities specific to the `textDocument/moniker` request. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub moniker: Option<MonikerClientCapabilities>, - - /// Capabilities specific to the `textDocument/inlayHint` request. - /// - /// @since 3.17.0 - proposed state - #[serde(skip_serializing_if = "Option::is_none")] - #[cfg(feature = "proposed")] - pub inlay_hint: Option<InlayHintClientCapabilities>, -} - -/// Where ClientCapabilities are currently empty: -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ClientCapabilities { - /// Workspace specific client capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub workspace: Option<WorkspaceClientCapabilities>, - - /// Text document specific client capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub text_document: Option<TextDocumentClientCapabilities>, - - /// Window specific client capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub window: Option<WindowClientCapabilities>, - - /// General client capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub general: Option<GeneralClientCapabilities>, - - /// Unofficial UT8-offsets extension. - /// - /// See https://clangd.llvm.org/extensions.html#utf-8-offsets. - #[serde(skip_serializing_if = "Option::is_none")] - #[cfg(feature = "proposed")] - pub offset_encoding: Option<Vec<String>>, - - /// Experimental client capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub experimental: Option<Value>, -} - -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct GeneralClientCapabilities { - /// Client capabilities specific to regular expressions. - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub regular_expressions: Option<RegularExpressionsClientCapabilities>, - - /// Client capabilities specific to the client's markdown parser. - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub markdown: Option<MarkdownClientCapabilities>, - - /// @since 3.17.0 - #[cfg(feature = "proposed")] - #[serde(skip_serializing_if = "Option::is_none")] - pub stale_request_support: Option<StaleRequestSupportClientCapabilities>, - - /// The position encodings supported by the client. Client and server - /// have to agree on the same position encoding to ensure that offsets - /// (e.g. character position in a line) are interpreted the same on both - /// side. - /// - /// To keep the protocol backwards compatible the following applies: if - /// the value 'utf-16' is missing from the array of position encodings - /// servers can assume that the client supports UTF-16. UTF-16 is - /// therefore a mandatory encoding. - /// - /// If omitted it defaults to ['utf-16']. - /// - /// Implementation considerations: since the conversion from one encoding - /// into another requires the content of the file / line the conversion - /// is best done where the file is read which is usually on the server - /// side. - /// - /// @since 3.17.0 - #[cfg(feature = "proposed")] - #[serde(skip_serializing_if = "Option::is_none")] - pub position_encodings: Option<Vec<PositionEncodingKind>>, -} - -/// Client capability that signals how the client -/// handles stale requests (e.g. a request -/// for which the client will not process the response -/// anymore since the information is outdated). -/// -/// @since 3.17.0 -#[cfg(feature = "proposed")] -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct StaleRequestSupportClientCapabilities { - /// The client will actively cancel the request. - pub cancel: bool, - - /// The list of requests for which the client - /// will retry the request if it receives a - /// response with error code `ContentModified`` - pub retry_on_content_modified: Vec<String>, -} - -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct RegularExpressionsClientCapabilities { - /// The engine's name. - pub engine: String, - - /// The engine's version - #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option<String>, -} - -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct MarkdownClientCapabilities { - /// The name of the parser. - pub parser: String, - - /// The version of the parser. - #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option<String>, -} - -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct InitializeResult { - /// The capabilities the language server provides. - pub capabilities: ServerCapabilities, - - /// Information about the server. - #[serde(skip_serializing_if = "Option::is_none")] - pub server_info: Option<ServerInfo>, - - /// Unofficial UT8-offsets extension. - /// - /// See https://clangd.llvm.org/extensions.html#utf-8-offsets. - #[serde(skip_serializing_if = "Option::is_none")] - #[cfg(feature = "proposed")] - pub offset_encoding: Option<String>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -pub struct ServerInfo { - /// The name of the server as defined by the server. - pub name: String, - /// The servers's version as defined by the server. - #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option<String>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -pub struct InitializeError { - /// Indicates whether the client should retry to send the - /// initilize request after showing the message provided - /// in the ResponseError. - pub retry: bool, -} - -// The server can signal the following capabilities: - -/// Defines how the host (editor) should sync document changes to the language server. -#[derive(Eq, PartialEq, Clone, Copy, Deserialize, Serialize)] -#[serde(transparent)] -pub struct TextDocumentSyncKind(i32); -lsp_enum! { -impl TextDocumentSyncKind { - /// Documents should not be synced at all. - pub const NONE: TextDocumentSyncKind = TextDocumentSyncKind(0); - - /// Documents are synced by always sending the full content of the document. - pub const FULL: TextDocumentSyncKind = TextDocumentSyncKind(1); - - /// Documents are synced by sending the full content on open. After that only - /// incremental updates to the document are sent. - pub const INCREMENTAL: TextDocumentSyncKind = TextDocumentSyncKind(2); -} -} - -pub type ExecuteCommandClientCapabilities = DynamicRegistrationClientCapabilities; - -/// Execute command options. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -pub struct ExecuteCommandOptions { - /// The commands to be executed on the server - pub commands: Vec<String>, - - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -/// Save options. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct SaveOptions { - /// The client is supposed to include the content on save. - #[serde(skip_serializing_if = "Option::is_none")] - pub include_text: Option<bool>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum TextDocumentSyncSaveOptions { - Supported(bool), - SaveOptions(SaveOptions), -} - -impl From<SaveOptions> for TextDocumentSyncSaveOptions { - fn from(from: SaveOptions) -> Self { - Self::SaveOptions(from) - } -} - -impl From<bool> for TextDocumentSyncSaveOptions { - fn from(from: bool) -> Self { - Self::Supported(from) - } -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentSyncOptions { - /// Open and close notifications are sent to the server. - #[serde(skip_serializing_if = "Option::is_none")] - pub open_close: Option<bool>, - - /// Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full - /// and TextDocumentSyncKindIncremental. - #[serde(skip_serializing_if = "Option::is_none")] - pub change: Option<TextDocumentSyncKind>, - - /// Will save notifications are sent to the server. - #[serde(skip_serializing_if = "Option::is_none")] - pub will_save: Option<bool>, - - /// Will save wait until requests are sent to the server. - #[serde(skip_serializing_if = "Option::is_none")] - pub will_save_wait_until: Option<bool>, - - /// Save notifications are sent to the server. - #[serde(skip_serializing_if = "Option::is_none")] - pub save: Option<TextDocumentSyncSaveOptions>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum OneOf<A, B> { - Left(A), - Right(B), -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum TextDocumentSyncCapability { - Kind(TextDocumentSyncKind), - Options(TextDocumentSyncOptions), -} - -impl From<TextDocumentSyncOptions> for TextDocumentSyncCapability { - fn from(from: TextDocumentSyncOptions) -> Self { - Self::Options(from) - } -} - -impl From<TextDocumentSyncKind> for TextDocumentSyncCapability { - fn from(from: TextDocumentSyncKind) -> Self { - Self::Kind(from) - } -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum ImplementationProviderCapability { - Simple(bool), - Options(StaticTextDocumentRegistrationOptions), -} - -impl From<StaticTextDocumentRegistrationOptions> for ImplementationProviderCapability { - fn from(from: StaticTextDocumentRegistrationOptions) -> Self { - Self::Options(from) - } -} - -impl From<bool> for ImplementationProviderCapability { - fn from(from: bool) -> Self { - Self::Simple(from) - } -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum TypeDefinitionProviderCapability { - Simple(bool), - Options(StaticTextDocumentRegistrationOptions), -} - -impl From<StaticTextDocumentRegistrationOptions> for TypeDefinitionProviderCapability { - fn from(from: StaticTextDocumentRegistrationOptions) -> Self { - Self::Options(from) - } -} - -impl From<bool> for TypeDefinitionProviderCapability { - fn from(from: bool) -> Self { - Self::Simple(from) - } -} - -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ServerCapabilities { - /// The position encoding the server picked from the encodings offered - /// by the client via the client capability `general.positionEncodings`. - /// - /// If the client didn't provide any position encodings the only valid - /// value that a server can return is 'utf-16'. - /// - /// If omitted it defaults to 'utf-16'. - /// - /// @since 3.17.0 - #[serde(skip_serializing_if = "Option::is_none")] - #[cfg(feature = "proposed")] - pub position_encoding: Option<PositionEncodingKind>, - - /// Defines how text documents are synced. - #[serde(skip_serializing_if = "Option::is_none")] - pub text_document_sync: Option<TextDocumentSyncCapability>, - - /// Capabilities specific to `textDocument/selectionRange` requests. - #[serde(skip_serializing_if = "Option::is_none")] - pub selection_range_provider: Option<SelectionRangeProviderCapability>, - - /// The server provides hover support. - #[serde(skip_serializing_if = "Option::is_none")] - pub hover_provider: Option<HoverProviderCapability>, - - /// The server provides completion support. - #[serde(skip_serializing_if = "Option::is_none")] - pub completion_provider: Option<CompletionOptions>, - - /// The server provides signature help support. - #[serde(skip_serializing_if = "Option::is_none")] - pub signature_help_provider: Option<SignatureHelpOptions>, - - /// The server provides goto definition support. - #[serde(skip_serializing_if = "Option::is_none")] - pub definition_provider: Option<OneOf<bool, DefinitionOptions>>, - - /// The server provides goto type definition support. - #[serde(skip_serializing_if = "Option::is_none")] - pub type_definition_provider: Option<TypeDefinitionProviderCapability>, - - /// The server provides goto implementation support. - #[serde(skip_serializing_if = "Option::is_none")] - pub implementation_provider: Option<ImplementationProviderCapability>, - - /// The server provides find references support. - #[serde(skip_serializing_if = "Option::is_none")] - pub references_provider: Option<OneOf<bool, ReferencesOptions>>, - - /// The server provides document highlight support. - #[serde(skip_serializing_if = "Option::is_none")] - pub document_highlight_provider: Option<OneOf<bool, DocumentHighlightOptions>>, - - /// The server provides document symbol support. - #[serde(skip_serializing_if = "Option::is_none")] - pub document_symbol_provider: Option<OneOf<bool, DocumentSymbolOptions>>, - - /// The server provides workspace symbol support. - #[serde(skip_serializing_if = "Option::is_none")] - pub workspace_symbol_provider: Option<OneOf<bool, WorkspaceSymbolOptions>>, - - /// The server provides code actions. - #[serde(skip_serializing_if = "Option::is_none")] - pub code_action_provider: Option<CodeActionProviderCapability>, - - /// The server provides code lens. - #[serde(skip_serializing_if = "Option::is_none")] - pub code_lens_provider: Option<CodeLensOptions>, - - /// The server provides document formatting. - #[serde(skip_serializing_if = "Option::is_none")] - pub document_formatting_provider: Option<OneOf<bool, DocumentFormattingOptions>>, - - /// The server provides document range formatting. - #[serde(skip_serializing_if = "Option::is_none")] - pub document_range_formatting_provider: Option<OneOf<bool, DocumentRangeFormattingOptions>>, - - /// The server provides document formatting on typing. - #[serde(skip_serializing_if = "Option::is_none")] - pub document_on_type_formatting_provider: Option<DocumentOnTypeFormattingOptions>, - - /// The server provides rename support. - #[serde(skip_serializing_if = "Option::is_none")] - pub rename_provider: Option<OneOf<bool, RenameOptions>>, - - /// The server provides document link support. - #[serde(skip_serializing_if = "Option::is_none")] - pub document_link_provider: Option<DocumentLinkOptions>, - - /// The server provides color provider support. - #[serde(skip_serializing_if = "Option::is_none")] - pub color_provider: Option<ColorProviderCapability>, - - /// The server provides folding provider support. - #[serde(skip_serializing_if = "Option::is_none")] - pub folding_range_provider: Option<FoldingRangeProviderCapability>, - - /// The server provides go to declaration support. - #[serde(skip_serializing_if = "Option::is_none")] - pub declaration_provider: Option<DeclarationCapability>, - - /// The server provides execute command support. - #[serde(skip_serializing_if = "Option::is_none")] - pub execute_command_provider: Option<ExecuteCommandOptions>, - - /// Workspace specific server capabilities - #[serde(skip_serializing_if = "Option::is_none")] - pub workspace: Option<WorkspaceServerCapabilities>, - - /// Call hierarchy provider capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub call_hierarchy_provider: Option<CallHierarchyServerCapability>, - - /// Semantic tokens server capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub semantic_tokens_provider: Option<SemanticTokensServerCapabilities>, - - /// Whether server provides moniker support. - #[serde(skip_serializing_if = "Option::is_none")] - pub moniker_provider: Option<OneOf<bool, MonikerServerCapabilities>>, - - /// The server provides inlay hints. - /// - /// @since 3.17.0 - proposed state - #[serde(skip_serializing_if = "Option::is_none")] - #[cfg(feature = "proposed")] - pub inlay_hint_provider: Option<OneOf<bool, InlayHintServerCapabilities>>, - - /// The server provides linked editing range support. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub linked_editing_range_provider: Option<LinkedEditingRangeServerCapabilities>, - - /// Experimental server capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub experimental: Option<Value>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct WorkspaceServerCapabilities { - /// The server supports workspace folder. - #[serde(skip_serializing_if = "Option::is_none")] - pub workspace_folders: Option<WorkspaceFoldersServerCapabilities>, - - #[serde(skip_serializing_if = "Option::is_none")] - pub file_operations: Option<WorkspaceFileOperationsServerCapabilities>, -} - -/// General parameters to to register for a capability. -#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct Registration { - /// The id used to register the request. The id can be used to deregister - /// the request again. - pub id: String, - - /// The method / capability to register for. - pub method: String, - - /// Options necessary for the registration. - #[serde(skip_serializing_if = "Option::is_none")] - pub register_options: Option<Value>, -} - -#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)] -pub struct RegistrationParams { - pub registrations: Vec<Registration>, -} - -/// Since most of the registration options require to specify a document selector there is a base -/// interface that can be used. -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentRegistrationOptions { - /// A document selector to identify the scope of the registration. If set to null - /// the document selector provided on the client side will be used. - pub document_selector: Option<DocumentSelector>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum DeclarationCapability { - Simple(bool), - RegistrationOptions(DeclarationRegistrationOptions), - Options(DeclarationOptions), -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DeclarationRegistrationOptions { - #[serde(flatten)] - pub declaration_options: DeclarationOptions, - - #[serde(flatten)] - pub text_document_registration_options: TextDocumentRegistrationOptions, - - #[serde(flatten)] - pub static_registration_options: StaticRegistrationOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DeclarationOptions { - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct StaticRegistrationOptions { - #[serde(skip_serializing_if = "Option::is_none")] - pub id: Option<String>, -} - -#[derive(Debug, Default, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct WorkDoneProgressOptions { - #[serde(skip_serializing_if = "Option::is_none")] - pub work_done_progress: Option<bool>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DocumentFormattingOptions { - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DocumentRangeFormattingOptions { - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DefinitionOptions { - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DocumentSymbolOptions { - /// A human-readable string that is shown when multiple outlines trees are - /// shown for the same document. - /// - /// @since 3.16.0 - #[serde(skip_serializing_if = "Option::is_none")] - pub label: Option<String>, - - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ReferencesOptions { - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DocumentHighlightOptions { - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct WorkspaceSymbolOptions { - #[serde(flatten)] - pub work_done_progress_options: WorkDoneProgressOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct StaticTextDocumentRegistrationOptions { - /// A document selector to identify the scope of the registration. If set to null - /// the document selector provided on the client side will be used. - pub document_selector: Option<DocumentSelector>, - - #[serde(skip_serializing_if = "Option::is_none")] - pub id: Option<String>, -} - -/// General parameters to unregister a capability. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct Unregistration { - /// The id used to unregister the request or notification. Usually an id - /// provided during the register request. - pub id: String, - - /// The method / capability to unregister for. - pub method: String, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct UnregistrationParams { - pub unregisterations: Vec<Unregistration>, -} - -#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)] -pub struct DidChangeConfigurationParams { - /// The actual changed settings - pub settings: Value, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DidOpenTextDocumentParams { - /// The document that was opened. - pub text_document: TextDocumentItem, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DidChangeTextDocumentParams { - /// The document that did change. The version number points - /// to the version after all provided content changes have - /// been applied. - pub text_document: VersionedTextDocumentIdentifier, - /// The actual content changes. - pub content_changes: Vec<TextDocumentContentChangeEvent>, -} - -/// An event describing a change to a text document. If range and rangeLength are omitted -/// the new text is considered to be the full content of the document. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentContentChangeEvent { - /// The range of the document that changed. - #[serde(skip_serializing_if = "Option::is_none")] - pub range: Option<Range>, - - /// The length of the range that got replaced. - /// - /// Deprecated: Use range instead - #[serde(skip_serializing_if = "Option::is_none")] - pub range_length: Option<u32>, - - /// The new text of the document. - pub text: String, -} - -/// Descibe options to be used when registered for text document change events. -/// -/// Extends TextDocumentRegistrationOptions -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentChangeRegistrationOptions { - /// A document selector to identify the scope of the registration. If set to null - /// the document selector provided on the client side will be used. - pub document_selector: Option<DocumentSelector>, - - /// How documents are synced to the server. See TextDocumentSyncKind.Full - /// and TextDocumentSyncKindIncremental. - pub sync_kind: i32, -} - -/// The parameters send in a will save text document notification. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct WillSaveTextDocumentParams { - /// The document that will be saved. - pub text_document: TextDocumentIdentifier, - - /// The 'TextDocumentSaveReason'. - pub reason: TextDocumentSaveReason, -} - -/// Represents reasons why a text document is saved. -#[derive(Copy, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(transparent)] -pub struct TextDocumentSaveReason(i32); -lsp_enum! { -impl TextDocumentSaveReason { - /// Manually triggered, e.g. by the user pressing save, by starting debugging, - /// or by an API call. - pub const MANUAL: TextDocumentSaveReason = TextDocumentSaveReason(1); - - /// Automatic after a delay. - pub const AFTER_DELAY: TextDocumentSaveReason = TextDocumentSaveReason(2); - - /// When the editor lost focus. - pub const FOCUS_OUT: TextDocumentSaveReason = TextDocumentSaveReason(3); -} -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DidCloseTextDocumentParams { - /// The document that was closed. - pub text_document: TextDocumentIdentifier, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct DidSaveTextDocumentParams { - /// The document that was saved. - pub text_document: TextDocumentIdentifier, - - /// Optional the content when saved. Depends on the includeText value - /// when the save notification was requested. - #[serde(skip_serializing_if = "Option::is_none")] - pub text: Option<String>, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct TextDocumentSaveRegistrationOptions { - /// The client is supposed to include the content on save. - #[serde(skip_serializing_if = "Option::is_none")] - pub include_text: Option<bool>, - - #[serde(flatten)] - pub text_document_registration_options: TextDocumentRegistrationOptions, -} - -pub type DidChangeWatchedFilesClientCapabilities = DynamicRegistrationClientCapabilities; - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct DidChangeWatchedFilesParams { - /// The actual file events. - pub changes: Vec<FileEvent>, -} - -/// The file event type. -#[derive(Eq, PartialEq, Copy, Clone, Deserialize, Serialize)] -#[serde(transparent)] -pub struct FileChangeType(i32); -lsp_enum! { -impl FileChangeType { - /// The file got created. - pub const CREATED: FileChangeType = FileChangeType(1); - - /// The file got changed. - pub const CHANGED: FileChangeType = FileChangeType(2); - - /// The file got deleted. - pub const DELETED: FileChangeType = FileChangeType(3); -} -} - -/// An event describing a file change. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct FileEvent { - /// The file's URI. - pub uri: Url, - - /// The change type. - #[serde(rename = "type")] - pub typ: FileChangeType, -} - -impl FileEvent { - pub fn new(uri: Url, typ: FileChangeType) -> FileEvent { - FileEvent { uri, typ } - } -} - -/// Describe options to be used when registered for text document change events. -#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Deserialize, Serialize)] -pub struct DidChangeWatchedFilesRegistrationOptions { - /// The watchers to register. - pub watchers: Vec<FileSystemWatcher>, -} - -#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct FileSystemWatcher { - /// The glob pattern to watch - pub glob_pattern: String, - - /// The kind of events of interest. If omitted it defaults to WatchKind.Create | - /// WatchKind.Change | WatchKind.Delete which is 7. - #[serde(skip_serializing_if = "Option::is_none")] - pub kind: Option<WatchKind>, -} - -bitflags! { -pub struct WatchKind: u8 { - /// Interested in create events. - const Create = 1; - /// Interested in change events - const Change = 2; - /// Interested in delete events - const Delete = 4; -} -} - -impl<'de> serde::Deserialize<'de> for WatchKind { - fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> - where - D: serde::Deserializer<'de>, - { - let i = u8::deserialize(deserializer)?; - WatchKind::from_bits(i).ok_or_else(|| { - D::Error::invalid_value(de::Unexpected::Unsigned(u64::from(i)), &"Unknown flag") - }) - } -} - -impl serde::Serialize for WatchKind { - fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> - where - S: serde::Serializer, - { - serializer.serialize_u8(self.bits()) - } -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct PublishDiagnosticsParams { - /// The URI for which diagnostic information is reported. - pub uri: Url, - - /// An array of diagnostic information items. - pub diagnostics: Vec<Diagnostic>, - - /// Optional the version number of the document the diagnostics are published for. - #[serde(skip_serializing_if = "Option::is_none")] - pub version: Option<i32>, -} - -impl PublishDiagnosticsParams { - pub fn new( - uri: Url, - diagnostics: Vec<Diagnostic>, - version: Option<i32>, - ) -> PublishDiagnosticsParams { - PublishDiagnosticsParams { - uri, - diagnostics, - version, - } - } -} - -#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Clone)] -#[serde(untagged)] -pub enum Documentation { - String(String), - MarkupContent(MarkupContent), -} - -/// The marked string is rendered: -/// - as markdown if it is represented as a string -/// - as code block of the given langauge if it is represented as a pair of a language and a value -/// -/// The pair of a language and a value is an equivalent to markdown: -/// ```${language} -/// ${value} -/// ``` -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(untagged)] -pub enum MarkedString { - String(String), - LanguageString(LanguageString), -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct LanguageString { - pub language: String, - pub value: String, -} - -impl MarkedString { - pub fn from_markdown(markdown: String) -> MarkedString { - MarkedString::String(markdown) - } - - pub fn from_language_code(language: String, code_block: String) -> MarkedString { - MarkedString::LanguageString(LanguageString { - language, - value: code_block, - }) - } -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct GotoDefinitionParams { - #[serde(flatten)] - pub text_document_position_params: TextDocumentPositionParams, - - #[serde(flatten)] - pub work_done_progress_params: WorkDoneProgressParams, - - #[serde(flatten)] - pub partial_result_params: PartialResultParams, -} - -/// GotoDefinition response can be single location, or multiple Locations or a link. -#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)] -#[serde(untagged)] -pub enum GotoDefinitionResponse { - Scalar(Location), - Array(Vec<Location>), - Link(Vec<LocationLink>), -} - -impl From<Location> for GotoDefinitionResponse { - fn from(location: Location) -> Self { - GotoDefinitionResponse::Scalar(location) - } -} - -impl From<Vec<Location>> for GotoDefinitionResponse { - fn from(locations: Vec<Location>) -> Self { - GotoDefinitionResponse::Array(locations) - } -} - -impl From<Vec<LocationLink>> for GotoDefinitionResponse { - fn from(locations: Vec<LocationLink>) -> Self { - GotoDefinitionResponse::Link(locations) - } -} - -#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)] -pub struct ExecuteCommandParams { - /// The identifier of the actual command handler. - pub command: String, - /// Arguments that the command should be invoked with. - #[serde(default)] - pub arguments: Vec<Value>, - - #[serde(flatten)] - pub work_done_progress_params: WorkDoneProgressParams, -} - -/// Execute command registration options. -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -pub struct ExecuteCommandRegistrationOptions { - /// The commands to be executed on the server - pub commands: Vec<String>, - - #[serde(flatten)] - pub execute_command_options: ExecuteCommandOptions, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ApplyWorkspaceEditParams { - /// An optional label of the workspace edit. This label is - /// presented in the user interface for example on an undo - /// stack to undo the workspace edit. - #[serde(skip_serializing_if = "Option::is_none")] - pub label: Option<String>, - - /// The edits to apply. - pub edit: WorkspaceEdit, -} - -#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct ApplyWorkspaceEditResponse { - /// Indicates whether the edit was applied or not. - pub applied: bool, - - /// An optional textual description for why the edit was not applied. - /// This may be used may be used by the server for diagnostic - /// logging or to provide a suitable error for a request that - /// triggered the edit - #[serde(skip_serializing_if = "Option::is_none")] - pub failure_reason: Option<String>, - - /// Depending on the client's failure handling strategy `failedChange` might - /// contain the index of the change that failed. This property is only available - /// if the client signals a `failureHandlingStrategy` in its client capabilities. - #[serde(skip_serializing_if = "Option::is_none")] - pub failed_change: Option<u32>, -} - -/// Describes the content type that a client supports in various -/// result literals like `Hover`, `ParameterInfo` or `CompletionItem`. -/// -/// Please note that `MarkupKinds` must not start with a `$`. This kinds -/// are reserved for internal usage. -#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Clone)] -#[serde(rename_all = "lowercase")] -pub enum MarkupKind { - /// Plain text is supported as a content format - PlainText, - /// Markdown is supported as a content format - Markdown, -} - -/// A `MarkupContent` literal represents a string value which content can be represented in different formats. -/// Currently `plaintext` and `markdown` are supported formats. A `MarkupContent` is usually used in -/// documentation properties of result literals like `CompletionItem` or `SignatureInformation`. -/// If the format is `markdown` the content should follow the [GitHub Flavored Markdown Specification](https://github.github.com/gfm/). -/// -/// Here is an example how such a string can be constructed using JavaScript / TypeScript: -/// ```ignore -/// let markdown: MarkupContent = { -/// kind: MarkupKind::Markdown, -/// value: [ -/// "# Header", -/// "Some text", -/// "```typescript", -/// "someCode();", -/// "```" -/// ] -/// .join("\n"), -/// }; -/// ``` -/// -/// Please Note* that clients might sanitize the return markdown. A client could decide to -/// remove HTML from the markdown to avoid script execution. -#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Clone)] -pub struct MarkupContent { - pub kind: MarkupKind, - pub value: String, -} - -/// A parameter literal used to pass a partial result token. -#[derive(Debug, Eq, PartialEq, Default, Deserialize, Serialize, Clone)] -#[serde(rename_all = "camelCase")] -pub struct PartialResultParams { - #[serde(skip_serializing_if = "Option::is_none")] - pub partial_result_token: Option<ProgressToken>, -} - -/// Symbol tags are extra annotations that tweak the rendering of a symbol. -/// Since 3.15 -#[derive(Eq, PartialEq, Clone, Deserialize, Serialize)] -#[serde(transparent)] -pub struct SymbolTag(i32); -lsp_enum! { -impl SymbolTag { - /// Render a symbol as obsolete, usually using a strike-out. - pub const DEPRECATED: SymbolTag = SymbolTag(1); -} -} - -#[cfg(test)] -mod tests { - use serde::{Deserialize, Serialize}; - - use super::*; - - pub(crate) fn test_serialization<SER>(ms: &SER, expected: &str) - where - SER: Serialize + for<'de> Deserialize<'de> + PartialEq + std::fmt::Debug, - { - let json_str = serde_json::to_string(ms).unwrap(); - assert_eq!(&json_str, expected); - let deserialized: SER = serde_json::from_str(&json_str).unwrap(); - assert_eq!(&deserialized, ms); - } - - pub(crate) fn test_deserialization<T>(json: &str, expected: &T) - where - T: for<'de> Deserialize<'de> + PartialEq + std::fmt::Debug, - { - let value = serde_json::from_str::<T>(json).unwrap(); - assert_eq!(&value, expected); - } - - #[test] - fn one_of() { - test_serialization(&OneOf::<bool, ()>::Left(true), r#"true"#); - test_serialization(&OneOf::<String, ()>::Left("abcd".into()), r#""abcd""#); - test_serialization( - &OneOf::<String, WorkDoneProgressOptions>::Right(WorkDoneProgressOptions { - work_done_progress: Some(false), - }), - r#"{"workDoneProgress":false}"#, - ); - } - - #[test] - fn number_or_string() { - test_serialization(&NumberOrString::Number(123), r#"123"#); - - test_serialization(&NumberOrString::String("abcd".into()), r#""abcd""#); - } - - #[test] - fn marked_string() { - test_serialization(&MarkedString::from_markdown("xxx".into()), r#""xxx""#); - - test_serialization( - &MarkedString::from_language_code("lang".into(), "code".into()), - r#"{"language":"lang","value":"code"}"#, - ); - } - - #[test] - fn language_string() { - test_serialization( - &LanguageString { - language: "LL".into(), - value: "VV".into(), - }, - r#"{"language":"LL","value":"VV"}"#, - ); - } - - #[test] - fn workspace_edit() { - test_serialization( - &WorkspaceEdit { - changes: Some(vec![].into_iter().collect()), - document_changes: None, - ..Default::default() - }, - r#"{"changes":{}}"#, - ); - - test_serialization( - &WorkspaceEdit { - changes: None, - document_changes: None, - ..Default::default() - }, - r#"{}"#, - ); - - test_serialization( - &WorkspaceEdit { - changes: Some( - vec![(Url::parse("file://test").unwrap(), vec![])] - .into_iter() - .collect(), - ), - document_changes: None, - ..Default::default() - }, - r#"{"changes":{"file://test/":[]}}"#, - ); - } - - #[test] - fn root_uri_can_be_missing() { - serde_json::from_str::<InitializeParams>(r#"{ "capabilities": {} }"#).unwrap(); - } - - #[test] - fn test_watch_kind() { - test_serialization(&WatchKind::Create, "1"); - test_serialization(&(WatchKind::Create | WatchKind::Change), "3"); - test_serialization( - &(WatchKind::Create | WatchKind::Change | WatchKind::Delete), - "7", - ); - } - - #[test] - fn test_resource_operation_kind() { - test_serialization( - &vec![ - ResourceOperationKind::Create, - ResourceOperationKind::Rename, - ResourceOperationKind::Delete, - ], - r#"["create","rename","delete"]"#, - ); - } -} +/*!
+
+Language Server Protocol types for Rust.
+
+Based on: <https://microsoft.github.io/language-server-protocol/specification>
+
+This library uses the URL crate for parsing URIs. Note that there is
+some confusion on the meaning of URLs vs URIs:
+<http://stackoverflow.com/a/28865728/393898>. According to that
+information, on the classical sense of "URLs", "URLs" are a subset of
+URIs, But on the modern/new meaning of URLs, they are the same as
+URIs. The important take-away aspect is that the URL crate should be
+able to parse any URI, such as `urn:isbn:0451450523`.
+
+
+*/
+#![allow(non_upper_case_globals)]
+#[forbid(unsafe_code)]
+#[macro_use]
+extern crate bitflags;
+
+use std::{collections::HashMap, fmt::Debug};
+
+use serde::{de, de::Error as Error_, Deserialize, Serialize};
+use serde_json::Value;
+pub use url::Url;
+
+// Large enough to contain any enumeration name defined in this crate
+type PascalCaseBuf = [u8; 32];
+const fn fmt_pascal_case_const(name: &str) -> (PascalCaseBuf, usize) {
+ let mut buf = [0; 32];
+ let mut buf_i = 0;
+ let mut name_i = 0;
+ let name = name.as_bytes();
+ while name_i < name.len() {
+ let first = name[name_i];
+ name_i += 1;
+
+ buf[buf_i] = first;
+ buf_i += 1;
+
+ while name_i < name.len() {
+ let rest = name[name_i];
+ name_i += 1;
+ if rest == b'_' {
+ break;
+ }
+
+ buf[buf_i] = rest.to_ascii_lowercase();
+ buf_i += 1;
+ }
+ }
+ (buf, buf_i)
+}
+
+fn fmt_pascal_case(f: &mut std::fmt::Formatter<'_>, name: &str) -> std::fmt::Result {
+ for word in name.split('_') {
+ let mut chars = word.chars();
+ let first = chars.next().unwrap();
+ write!(f, "{}", first)?;
+ for rest in chars {
+ write!(f, "{}", rest.to_lowercase())?;
+ }
+ }
+ Ok(())
+}
+
+macro_rules! lsp_enum {
+ (impl $typ: ident { $( $(#[$attr:meta])* pub const $name: ident : $enum_type: ty = $value: expr; )* }) => {
+ impl $typ {
+ $(
+ $(#[$attr])*
+ pub const $name: $enum_type = $value;
+ )*
+ }
+
+ impl std::fmt::Debug for $typ {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ match *self {
+ $(
+ Self::$name => crate::fmt_pascal_case(f, stringify!($name)),
+ )*
+ _ => write!(f, "{}({})", stringify!($typ), self.0),
+ }
+ }
+ }
+
+ impl std::convert::TryFrom<&str> for $typ {
+ type Error = &'static str;
+ fn try_from(value: &str) -> Result<Self, Self::Error> {
+ match () {
+ $(
+ _ if {
+ const X: (crate::PascalCaseBuf, usize) = crate::fmt_pascal_case_const(stringify!($name));
+ let (buf, len) = X;
+ &buf[..len] == value.as_bytes()
+ } => Ok(Self::$name),
+ )*
+ _ => Err("unknown enum variant"),
+ }
+ }
+ }
+
+ }
+}
+
+pub mod error_codes;
+pub mod notification;
+pub mod request;
+
+mod call_hierarchy;
+pub use call_hierarchy::*;
+
+mod code_action;
+pub use code_action::*;
+
+mod code_lens;
+pub use code_lens::*;
+
+mod color;
+pub use color::*;
+
+mod completion;
+pub use completion::*;
+
+mod document_highlight;
+pub use document_highlight::*;
+
+mod document_link;
+pub use document_link::*;
+
+mod document_symbols;
+pub use document_symbols::*;
+
+mod file_operations;
+pub use file_operations::*;
+
+mod folding_range;
+pub use folding_range::*;
+
+mod formatting;
+pub use formatting::*;
+
+mod hover;
+pub use hover::*;
+
+mod inlay_hint;
+pub use inlay_hint::*;
+
+mod inline_value;
+pub use inline_value::*;
+
+mod moniker;
+pub use moniker::*;
+
+mod progress;
+pub use progress::*;
+
+mod references;
+pub use references::*;
+
+mod rename;
+pub use rename::*;
+
+pub mod selection_range;
+pub use selection_range::*;
+
+mod semantic_tokens;
+pub use semantic_tokens::*;
+
+mod signature_help;
+pub use signature_help::*;
+
+mod type_hierarchy;
+pub use type_hierarchy::*;
+
+mod linked_editing;
+pub use linked_editing::*;
+
+mod window;
+pub use window::*;
+
+mod workspace_folders;
+pub use workspace_folders::*;
+
+mod workspace_symbols;
+pub use workspace_symbols::*;
+
+pub mod lsif;
+
+mod trace;
+pub use trace::*;
+
+/* ----------------- Auxiliary types ----------------- */
+
+#[derive(Debug, Eq, Hash, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum NumberOrString {
+ Number(i32),
+ String(String),
+}
+
+/* ----------------- Cancel support ----------------- */
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct CancelParams {
+ /// The request id to cancel.
+ pub id: NumberOrString,
+}
+
+/* ----------------- Basic JSON Structures ----------------- */
+
+/// The LSP any type
+///
+/// @since 3.17.0
+pub type LSPAny = serde_json::Value;
+
+/// LSP object definition.
+///
+/// @since 3.17.0
+pub type LSPObject = serde_json::Map<String, serde_json::Value>;
+
+/// LSP arrays.
+///
+/// @since 3.17.0
+pub type LSPArray = Vec<serde_json::Value>;
+
+/// Position in a text document expressed as zero-based line and character offset.
+/// A position is between two characters like an 'insert' cursor in a editor.
+#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Copy, Clone, Default, Deserialize, Serialize)]
+pub struct Position {
+ /// Line position in a document (zero-based).
+ pub line: u32,
+ /// Character offset on a line in a document (zero-based). The meaning of this
+ /// offset is determined by the negotiated `PositionEncodingKind`.
+ ///
+ /// If the character value is greater than the line length it defaults back
+ /// to the line length.
+ pub character: u32,
+}
+
+impl Position {
+ pub fn new(line: u32, character: u32) -> Position {
+ Position { line, character }
+ }
+}
+
+/// A range in a text document expressed as (zero-based) start and end positions.
+/// A range is comparable to a selection in an editor. Therefore the end position is exclusive.
+#[derive(Debug, Eq, PartialEq, Copy, Clone, Default, Deserialize, Serialize)]
+pub struct Range {
+ /// The range's start position.
+ pub start: Position,
+ /// The range's end position.
+ pub end: Position,
+}
+
+impl Range {
+ pub fn new(start: Position, end: Position) -> Range {
+ Range { start, end }
+ }
+}
+
+/// Represents a location inside a resource, such as a line inside a text file.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct Location {
+ pub uri: Url,
+ pub range: Range,
+}
+
+impl Location {
+ pub fn new(uri: Url, range: Range) -> Location {
+ Location { uri, range }
+ }
+}
+
+/// Represents a link between a source and a target location.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LocationLink {
+ /// Span of the origin of this link.
+ ///
+ /// Used as the underlined span for mouse interaction. Defaults to the word range at
+ /// the mouse position.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub origin_selection_range: Option<Range>,
+
+ /// The target resource identifier of this link.
+ pub target_uri: Url,
+
+ /// The full target range of this link.
+ pub target_range: Range,
+
+ /// The span of this link.
+ pub target_selection_range: Range,
+}
+
+/// A type indicating how positions are encoded,
+/// specifically what column offsets mean.
+///
+/// @since 3.17.0
+#[derive(Debug, Eq, PartialEq, Hash, PartialOrd, Clone, Deserialize, Serialize)]
+pub struct PositionEncodingKind(std::borrow::Cow<'static, str>);
+
+impl PositionEncodingKind {
+ /// Character offsets count UTF-8 code units.
+ pub const UTF8: PositionEncodingKind = PositionEncodingKind::new("utf-8");
+
+ /// Character offsets count UTF-16 code units.
+ ///
+ /// This is the default and must always be supported
+ /// by servers
+ pub const UTF16: PositionEncodingKind = PositionEncodingKind::new("utf-16");
+
+ /// Character offsets count UTF-32 code units.
+ ///
+ /// Implementation note: these are the same as Unicode code points,
+ /// so this `PositionEncodingKind` may also be used for an
+ /// encoding-agnostic representation of character offsets.
+ pub const UTF32: PositionEncodingKind = PositionEncodingKind::new("utf-32");
+
+ pub const fn new(tag: &'static str) -> Self {
+ PositionEncodingKind(std::borrow::Cow::Borrowed(tag))
+ }
+
+ pub fn as_str(&self) -> &str {
+ &self.0
+ }
+}
+
+impl From<String> for PositionEncodingKind {
+ fn from(from: String) -> Self {
+ PositionEncodingKind(std::borrow::Cow::from(from))
+ }
+}
+
+impl From<&'static str> for PositionEncodingKind {
+ fn from(from: &'static str) -> Self {
+ PositionEncodingKind::new(from)
+ }
+}
+
+/// Represents a diagnostic, such as a compiler error or warning.
+/// Diagnostic objects are only valid in the scope of a resource.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Diagnostic {
+ /// The range at which the message applies.
+ pub range: Range,
+
+ /// The diagnostic's severity. Can be omitted. If omitted it is up to the
+ /// client to interpret diagnostics as error, warning, info or hint.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub severity: Option<DiagnosticSeverity>,
+
+ /// The diagnostic's code. Can be omitted.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub code: Option<NumberOrString>,
+
+ /// An optional property to describe the error code.
+ ///
+ /// since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub code_description: Option<CodeDescription>,
+
+ /// A human-readable string describing the source of this
+ /// diagnostic, e.g. 'typescript' or 'super lint'.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub source: Option<String>,
+
+ /// The diagnostic's message.
+ pub message: String,
+
+ /// An array of related diagnostic information, e.g. when symbol-names within
+ /// a scope collide all definitions can be marked via this property.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub related_information: Option<Vec<DiagnosticRelatedInformation>>,
+
+ /// Additional metadata about the diagnostic.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub tags: Option<Vec<DiagnosticTag>>,
+
+ /// A data entry field that is preserved between a `textDocument/publishDiagnostics`
+ /// notification and `textDocument/codeAction` request.
+ ///
+ /// since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub data: Option<serde_json::Value>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct CodeDescription {
+ pub href: Url,
+}
+
+impl Diagnostic {
+ pub fn new(
+ range: Range,
+ severity: Option<DiagnosticSeverity>,
+ code: Option<NumberOrString>,
+ source: Option<String>,
+ message: String,
+ related_information: Option<Vec<DiagnosticRelatedInformation>>,
+ tags: Option<Vec<DiagnosticTag>>,
+ ) -> Diagnostic {
+ Diagnostic {
+ range,
+ severity,
+ code,
+ source,
+ message,
+ related_information,
+ tags,
+ ..Diagnostic::default()
+ }
+ }
+
+ pub fn new_simple(range: Range, message: String) -> Diagnostic {
+ Self::new(range, None, None, None, message, None, None)
+ }
+
+ pub fn new_with_code_number(
+ range: Range,
+ severity: DiagnosticSeverity,
+ code_number: i32,
+ source: Option<String>,
+ message: String,
+ ) -> Diagnostic {
+ let code = Some(NumberOrString::Number(code_number));
+ Self::new(range, Some(severity), code, source, message, None, None)
+ }
+}
+
+/// The protocol currently supports the following diagnostic severities:
+#[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Deserialize, Serialize)]
+#[serde(transparent)]
+pub struct DiagnosticSeverity(i32);
+lsp_enum! {
+impl DiagnosticSeverity {
+ /// Reports an error.
+ pub const ERROR: DiagnosticSeverity = DiagnosticSeverity(1);
+ /// Reports a warning.
+ pub const WARNING: DiagnosticSeverity = DiagnosticSeverity(2);
+ /// Reports an information.
+ pub const INFORMATION: DiagnosticSeverity = DiagnosticSeverity(3);
+ /// Reports a hint.
+ pub const HINT: DiagnosticSeverity = DiagnosticSeverity(4);
+}
+}
+
+/// Represents a related message and source code location for a diagnostic. This
+/// should be used to point to code locations that cause or related to a
+/// diagnostics, e.g when duplicating a symbol in a scope.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct DiagnosticRelatedInformation {
+ /// The location of this related diagnostic information.
+ pub location: Location,
+
+ /// The message of this related diagnostic information.
+ pub message: String,
+}
+
+/// The diagnostic tags.
+#[derive(Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(transparent)]
+pub struct DiagnosticTag(i32);
+lsp_enum! {
+impl DiagnosticTag {
+ /// Unused or unnecessary code.
+ /// Clients are allowed to render diagnostics with this tag faded out instead of having
+ /// an error squiggle.
+ pub const UNNECESSARY: DiagnosticTag = DiagnosticTag(1);
+
+ /// Deprecated or obsolete code.
+ /// Clients are allowed to rendered diagnostics with this tag strike through.
+ pub const DEPRECATED: DiagnosticTag = DiagnosticTag(2);
+}
+}
+
+/// Represents a reference to a command. Provides a title which will be used to represent a command in the UI.
+/// Commands are identitifed using a string identifier and the protocol currently doesn't specify a set of
+/// well known commands. So executing a command requires some tool extension code.
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+pub struct Command {
+ /// Title of the command, like `save`.
+ pub title: String,
+ /// The identifier of the actual command handler.
+ pub command: String,
+ /// Arguments that the command handler should be
+ /// invoked with.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub arguments: Option<Vec<Value>>,
+}
+
+impl Command {
+ pub fn new(title: String, command: String, arguments: Option<Vec<Value>>) -> Command {
+ Command {
+ title,
+ command,
+ arguments,
+ }
+ }
+}
+
+/// A textual edit applicable to a text document.
+///
+/// If n `TextEdit`s are applied to a text document all text edits describe changes to the initial document version.
+/// Execution wise text edits should applied from the bottom to the top of the text document. Overlapping text edits
+/// are not supported.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextEdit {
+ /// The range of the text document to be manipulated. To insert
+ /// text into a document create a range where start === end.
+ pub range: Range,
+ /// The string to be inserted. For delete operations use an
+ /// empty string.
+ pub new_text: String,
+}
+
+impl TextEdit {
+ pub fn new(range: Range, new_text: String) -> TextEdit {
+ TextEdit { range, new_text }
+ }
+}
+
+/// An identifier referring to a change annotation managed by a workspace
+/// edit.
+///
+/// @since 3.16.0.
+pub type ChangeAnnotationIdentifier = String;
+
+/// A special text edit with an additional change annotation.
+///
+/// @since 3.16.0.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct AnnotatedTextEdit {
+ #[serde(flatten)]
+ pub text_edit: TextEdit,
+
+ /// The actual annotation
+ pub annotation_id: ChangeAnnotationIdentifier,
+}
+
+/// Describes textual changes on a single text document. The text document is referred to as a
+/// `OptionalVersionedTextDocumentIdentifier` to allow clients to check the text document version before an
+/// edit is applied. A `TextDocumentEdit` describes all changes on a version Si and after they are
+/// applied move the document to version Si+1. So the creator of a `TextDocumentEdit` doesn't need to
+/// sort the array or do any kind of ordering. However the edits must be non overlapping.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentEdit {
+ /// The text document to change.
+ pub text_document: OptionalVersionedTextDocumentIdentifier,
+
+ /// The edits to be applied.
+ ///
+ /// @since 3.16.0 - support for AnnotatedTextEdit. This is guarded by the
+ /// client capability `workspace.workspaceEdit.changeAnnotationSupport`
+ pub edits: Vec<OneOf<TextEdit, AnnotatedTextEdit>>,
+}
+
+/// Additional information that describes document changes.
+///
+/// @since 3.16.0.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ChangeAnnotation {
+ /// A human-readable string describing the actual change. The string
+ /// is rendered prominent in the user interface.
+ pub label: String,
+
+ /// A flag which indicates that user confirmation is needed
+ /// before applying the change.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub needs_confirmation: Option<bool>,
+
+ /// A human-readable string which is rendered less prominent in
+ /// the user interface.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub description: Option<String>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ChangeAnnotationWorkspaceEditClientCapabilities {
+ /// Whether the client groups edits with equal labels into tree nodes,
+ /// for instance all edits labelled with "Changes in Strings" would
+ /// be a tree node.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub groups_on_label: Option<bool>,
+}
+
+/// Options to create a file.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct CreateFileOptions {
+ /// Overwrite existing file. Overwrite wins over `ignoreIfExists`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub overwrite: Option<bool>,
+ /// Ignore if exists.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub ignore_if_exists: Option<bool>,
+}
+
+/// Create file operation
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct CreateFile {
+ /// The resource to create.
+ pub uri: Url,
+ /// Additional options
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub options: Option<CreateFileOptions>,
+
+ /// An optional annotation identifer describing the operation.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub annotation_id: Option<ChangeAnnotationIdentifier>,
+}
+
+/// Rename file options
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct RenameFileOptions {
+ /// Overwrite target if existing. Overwrite wins over `ignoreIfExists`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub overwrite: Option<bool>,
+ /// Ignores if target exists.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub ignore_if_exists: Option<bool>,
+}
+
+/// Rename file operation
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct RenameFile {
+ /// The old (existing) location.
+ pub old_uri: Url,
+ /// The new location.
+ pub new_uri: Url,
+ /// Rename options.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub options: Option<RenameFileOptions>,
+
+ /// An optional annotation identifer describing the operation.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub annotation_id: Option<ChangeAnnotationIdentifier>,
+}
+
+/// Delete file options
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DeleteFileOptions {
+ /// Delete the content recursively if a folder is denoted.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub recursive: Option<bool>,
+ /// Ignore the operation if the file doesn't exist.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub ignore_if_not_exists: Option<bool>,
+
+ /// An optional annotation identifer describing the operation.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub annotation_id: Option<ChangeAnnotationIdentifier>,
+}
+
+/// Delete file operation
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DeleteFile {
+ /// The file to delete.
+ pub uri: Url,
+ /// Delete options.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub options: Option<DeleteFileOptions>,
+}
+
+/// A workspace edit represents changes to many resources managed in the workspace.
+/// The edit should either provide `changes` or `documentChanges`.
+/// If the client can handle versioned document edits and if `documentChanges` are present,
+/// the latter are preferred over `changes`.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct WorkspaceEdit {
+ /// Holds changes to existing resources.
+ #[serde(with = "url_map")]
+ #[serde(skip_serializing_if = "Option::is_none")]
+ #[serde(default)]
+ pub changes: Option<HashMap<Url, Vec<TextEdit>>>, // changes?: { [uri: string]: TextEdit[]; };
+
+ /// Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
+ /// are either an array of `TextDocumentEdit`s to express changes to n different text documents
+ /// where each text document edit addresses a specific version of a text document. Or it can contain
+ /// above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.
+ ///
+ /// Whether a client supports versioned document edits is expressed via
+ /// `workspace.workspaceEdit.documentChanges` client capability.
+ ///
+ /// If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
+ /// only plain `TextEdit`s using the `changes` property are supported.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_changes: Option<DocumentChanges>,
+
+ /// A map of change annotations that can be referenced in
+ /// `AnnotatedTextEdit`s or create, rename and delete file / folder
+ /// operations.
+ ///
+ /// Whether clients honor this property depends on the client capability
+ /// `workspace.changeAnnotationSupport`.
+ ///
+ /// @since 3.16.0
+ ///
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub change_annotations: Option<HashMap<ChangeAnnotationIdentifier, ChangeAnnotation>>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum DocumentChanges {
+ Edits(Vec<TextDocumentEdit>),
+ Operations(Vec<DocumentChangeOperation>),
+}
+
+// TODO: Once https://github.com/serde-rs/serde/issues/912 is solved
+// we can remove ResourceOp and switch to the following implementation
+// of DocumentChangeOperation:
+//
+// #[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+// #[serde(tag = "kind", rename_all="lowercase" )]
+// pub enum DocumentChangeOperation {
+// Create(CreateFile),
+// Rename(RenameFile),
+// Delete(DeleteFile),
+//
+// #[serde(other)]
+// Edit(TextDocumentEdit),
+// }
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged, rename_all = "lowercase")]
+pub enum DocumentChangeOperation {
+ Op(ResourceOp),
+ Edit(TextDocumentEdit),
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(tag = "kind", rename_all = "lowercase")]
+pub enum ResourceOp {
+ Create(CreateFile),
+ Rename(RenameFile),
+ Delete(DeleteFile),
+}
+
+pub type DidChangeConfigurationClientCapabilities = DynamicRegistrationClientCapabilities;
+
+#[derive(Debug, Default, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ConfigurationParams {
+ pub items: Vec<ConfigurationItem>,
+}
+
+#[derive(Debug, Default, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ConfigurationItem {
+ /// The scope to get the configuration section for.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub scope_uri: Option<Url>,
+
+ ///The configuration section asked for.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub section: Option<String>,
+}
+
+mod url_map {
+ use std::fmt;
+
+ use super::*;
+
+ pub fn deserialize<'de, D>(
+ deserializer: D,
+ ) -> Result<Option<HashMap<Url, Vec<TextEdit>>>, D::Error>
+ where
+ D: serde::Deserializer<'de>,
+ {
+ struct UrlMapVisitor;
+ impl<'de> de::Visitor<'de> for UrlMapVisitor {
+ type Value = HashMap<Url, Vec<TextEdit>>;
+
+ fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
+ formatter.write_str("map")
+ }
+
+ fn visit_map<M>(self, mut visitor: M) -> Result<Self::Value, M::Error>
+ where
+ M: de::MapAccess<'de>,
+ {
+ let mut values = HashMap::with_capacity(visitor.size_hint().unwrap_or(0));
+
+ // While there are entries remaining in the input, add them
+ // into our map.
+ while let Some((key, value)) = visitor.next_entry::<Url, _>()? {
+ values.insert(key, value);
+ }
+
+ Ok(values)
+ }
+ }
+
+ struct OptionUrlMapVisitor;
+ impl<'de> de::Visitor<'de> for OptionUrlMapVisitor {
+ type Value = Option<HashMap<Url, Vec<TextEdit>>>;
+
+ fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
+ formatter.write_str("option")
+ }
+
+ #[inline]
+ fn visit_unit<E>(self) -> Result<Self::Value, E>
+ where
+ E: serde::de::Error,
+ {
+ Ok(None)
+ }
+
+ #[inline]
+ fn visit_none<E>(self) -> Result<Self::Value, E>
+ where
+ E: serde::de::Error,
+ {
+ Ok(None)
+ }
+
+ #[inline]
+ fn visit_some<D>(self, deserializer: D) -> Result<Self::Value, D::Error>
+ where
+ D: serde::Deserializer<'de>,
+ {
+ deserializer.deserialize_map(UrlMapVisitor).map(Some)
+ }
+ }
+
+ // Instantiate our Visitor and ask the Deserializer to drive
+ // it over the input data, resulting in an instance of MyMap.
+ deserializer.deserialize_option(OptionUrlMapVisitor)
+ }
+
+ pub fn serialize<S>(
+ changes: &Option<HashMap<Url, Vec<TextEdit>>>,
+ serializer: S,
+ ) -> Result<S::Ok, S::Error>
+ where
+ S: serde::Serializer,
+ {
+ use serde::ser::SerializeMap;
+
+ match *changes {
+ Some(ref changes) => {
+ let mut map = serializer.serialize_map(Some(changes.len()))?;
+ for (k, v) in changes {
+ map.serialize_entry(k.as_str(), v)?;
+ }
+ map.end()
+ }
+ None => serializer.serialize_none(),
+ }
+ }
+}
+
+impl WorkspaceEdit {
+ pub fn new(changes: HashMap<Url, Vec<TextEdit>>) -> WorkspaceEdit {
+ WorkspaceEdit {
+ changes: Some(changes),
+ document_changes: None,
+ ..Default::default()
+ }
+ }
+}
+
+/// Text documents are identified using a URI. On the protocol level, URIs are passed as strings.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct TextDocumentIdentifier {
+ // !!!!!! Note:
+ // In the spec VersionedTextDocumentIdentifier extends TextDocumentIdentifier
+ // This modelled by "mixing-in" TextDocumentIdentifier in VersionedTextDocumentIdentifier,
+ // so any changes to this type must be effected in the sub-type as well.
+ /// The text document's URI.
+ pub uri: Url,
+}
+
+impl TextDocumentIdentifier {
+ pub fn new(uri: Url) -> TextDocumentIdentifier {
+ TextDocumentIdentifier { uri }
+ }
+}
+
+/// An item to transfer a text document from the client to the server.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentItem {
+ /// The text document's URI.
+ pub uri: Url,
+
+ /// The text document's language identifier.
+ pub language_id: String,
+
+ /// The version number of this document (it will strictly increase after each
+ /// change, including undo/redo).
+ pub version: i32,
+
+ /// The content of the opened text document.
+ pub text: String,
+}
+
+impl TextDocumentItem {
+ pub fn new(uri: Url, language_id: String, version: i32, text: String) -> TextDocumentItem {
+ TextDocumentItem {
+ uri,
+ language_id,
+ version,
+ text,
+ }
+ }
+}
+
+/// An identifier to denote a specific version of a text document. This information usually flows from the client to the server.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct VersionedTextDocumentIdentifier {
+ // This field was "mixed-in" from TextDocumentIdentifier
+ /// The text document's URI.
+ pub uri: Url,
+
+ /// The version number of this document.
+ ///
+ /// The version number of a document will increase after each change,
+ /// including undo/redo. The number doesn't need to be consecutive.
+ pub version: i32,
+}
+
+impl VersionedTextDocumentIdentifier {
+ pub fn new(uri: Url, version: i32) -> VersionedTextDocumentIdentifier {
+ VersionedTextDocumentIdentifier { uri, version }
+ }
+}
+
+/// An identifier which optionally denotes a specific version of a text document. This information usually flows from the server to the client
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct OptionalVersionedTextDocumentIdentifier {
+ // This field was "mixed-in" from TextDocumentIdentifier
+ /// The text document's URI.
+ pub uri: Url,
+
+ /// The version number of this document. If an optional versioned text document
+ /// identifier is sent from the server to the client and the file is not
+ /// open in the editor (the server has not received an open notification
+ /// before) the server can send `null` to indicate that the version is
+ /// known and the content on disk is the master (as specified with document
+ /// content ownership).
+ ///
+ /// The version number of a document will increase after each change,
+ /// including undo/redo. The number doesn't need to be consecutive.
+ pub version: Option<i32>,
+}
+
+impl OptionalVersionedTextDocumentIdentifier {
+ pub fn new(uri: Url, version: i32) -> OptionalVersionedTextDocumentIdentifier {
+ OptionalVersionedTextDocumentIdentifier {
+ uri,
+ version: Some(version),
+ }
+ }
+}
+
+/// A parameter literal used in requests to pass a text document and a position inside that document.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentPositionParams {
+ // !!!!!! Note:
+ // In the spec ReferenceParams extends TextDocumentPositionParams
+ // This modelled by "mixing-in" TextDocumentPositionParams in ReferenceParams,
+ // so any changes to this type must be effected in sub-type as well.
+ /// The text document.
+ pub text_document: TextDocumentIdentifier,
+
+ /// The position inside the text document.
+ pub position: Position,
+}
+
+impl TextDocumentPositionParams {
+ pub fn new(
+ text_document: TextDocumentIdentifier,
+ position: Position,
+ ) -> TextDocumentPositionParams {
+ TextDocumentPositionParams {
+ text_document,
+ position,
+ }
+ }
+}
+
+/// A document filter denotes a document through properties like language, schema or pattern.
+/// Examples are a filter that applies to TypeScript files on disk or a filter the applies to JSON
+/// files with name package.json:
+///
+/// { language: 'typescript', scheme: 'file' }
+/// { language: 'json', pattern: '**/package.json' }
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct DocumentFilter {
+ /// A language id, like `typescript`.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub language: Option<String>,
+
+ /// A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub scheme: Option<String>,
+
+ /// A glob pattern, like `*.{ts,js}`.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub pattern: Option<String>,
+}
+
+/// A document selector is the combination of one or many document filters.
+pub type DocumentSelector = Vec<DocumentFilter>;
+
+// ========================= Actual Protocol =========================
+
+#[derive(Debug, PartialEq, Clone, Deserialize, Serialize, Default)]
+#[serde(rename_all = "camelCase")]
+pub struct InitializeParams {
+ /// The process Id of the parent process that started
+ /// the server. Is null if the process has not been started by another process.
+ /// If the parent process is not alive then the server should exit (see exit notification) its process.
+ pub process_id: Option<u32>,
+
+ /// The rootPath of the workspace. Is null
+ /// if no folder is open.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ #[deprecated(note = "Use `root_uri` instead when possible")]
+ pub root_path: Option<String>,
+
+ /// The rootUri of the workspace. Is null if no
+ /// folder is open. If both `rootPath` and `rootUri` are set
+ /// `rootUri` wins.
+ ///
+ /// Deprecated in favour of `workspaceFolders`
+ #[serde(default)]
+ pub root_uri: Option<Url>,
+
+ /// User provided initialization options.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub initialization_options: Option<Value>,
+
+ /// The capabilities provided by the client (editor or tool)
+ pub capabilities: ClientCapabilities,
+
+ /// The initial trace setting. If omitted trace is disabled ('off').
+ #[serde(default)]
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub trace: Option<TraceValue>,
+
+ /// The workspace folders configured in the client when the server starts.
+ /// This property is only available if the client supports workspace folders.
+ /// It can be `null` if the client supports workspace folders but none are
+ /// configured.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub workspace_folders: Option<Vec<WorkspaceFolder>>,
+
+ /// Information about the client.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub client_info: Option<ClientInfo>,
+
+ /// The locale the client is currently showing the user interface
+ /// in. This must not necessarily be the locale of the operating
+ /// system.
+ ///
+ /// Uses IETF language tags as the value's syntax
+ /// (See <https://en.wikipedia.org/wiki/IETF_language_tag>)
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub locale: Option<String>,
+}
+
+#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
+pub struct ClientInfo {
+ /// The name of the client as defined by the client.
+ pub name: String,
+ /// The client's version as defined by the client.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub version: Option<String>,
+}
+
+#[derive(Debug, PartialEq, Clone, Copy, Deserialize, Serialize)]
+pub struct InitializedParams {}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct GenericRegistrationOptions {
+ #[serde(flatten)]
+ pub text_document_registration_options: TextDocumentRegistrationOptions,
+
+ #[serde(flatten)]
+ pub options: GenericOptions,
+
+ #[serde(flatten)]
+ pub static_registration_options: StaticRegistrationOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct GenericOptions {
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct GenericParams {
+ #[serde(flatten)]
+ pub text_document_position_params: TextDocumentPositionParams,
+
+ #[serde(flatten)]
+ pub work_done_progress_params: WorkDoneProgressParams,
+
+ #[serde(flatten)]
+ pub partial_result_params: PartialResultParams,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Copy, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DynamicRegistrationClientCapabilities {
+ /// This capability supports dynamic registration.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub dynamic_registration: Option<bool>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Copy, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct GotoCapability {
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub dynamic_registration: Option<bool>,
+
+ /// The client supports additional metadata in the form of definition links.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub link_support: Option<bool>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct WorkspaceEditClientCapabilities {
+ /// The client supports versioned document changes in `WorkspaceEdit`s
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_changes: Option<bool>,
+
+ /// The resource operations the client supports. Clients should at least
+ /// support 'create', 'rename' and 'delete' files and folders.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub resource_operations: Option<Vec<ResourceOperationKind>>,
+
+ /// The failure handling strategy of a client if applying the workspace edit
+ /// failes.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub failure_handling: Option<FailureHandlingKind>,
+
+ /// Whether the client normalizes line endings to the client specific
+ /// setting.
+ /// If set to `true` the client will normalize line ending characters
+ /// in a workspace edit containg to the client specific new line
+ /// character.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub normalizes_line_endings: Option<bool>,
+
+ /// Whether the client in general supports change annotations on text edits,
+ /// create file, rename file and delete file changes.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub change_annotation_support: Option<ChangeAnnotationWorkspaceEditClientCapabilities>,
+}
+
+#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Copy, Clone)]
+#[serde(rename_all = "lowercase")]
+pub enum ResourceOperationKind {
+ Create,
+ Rename,
+ Delete,
+}
+
+#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Copy, Clone)]
+#[serde(rename_all = "camelCase")]
+pub enum FailureHandlingKind {
+ Abort,
+ Transactional,
+ TextOnlyTransactional,
+ Undo,
+}
+
+/// A symbol kind.
+#[derive(Eq, PartialEq, Copy, Clone, Serialize, Deserialize)]
+#[serde(transparent)]
+pub struct SymbolKind(i32);
+lsp_enum! {
+impl SymbolKind {
+ pub const FILE: SymbolKind = SymbolKind(1);
+ pub const MODULE: SymbolKind = SymbolKind(2);
+ pub const NAMESPACE: SymbolKind = SymbolKind(3);
+ pub const PACKAGE: SymbolKind = SymbolKind(4);
+ pub const CLASS: SymbolKind = SymbolKind(5);
+ pub const METHOD: SymbolKind = SymbolKind(6);
+ pub const PROPERTY: SymbolKind = SymbolKind(7);
+ pub const FIELD: SymbolKind = SymbolKind(8);
+ pub const CONSTRUCTOR: SymbolKind = SymbolKind(9);
+ pub const ENUM: SymbolKind = SymbolKind(10);
+ pub const INTERFACE: SymbolKind = SymbolKind(11);
+ pub const FUNCTION: SymbolKind = SymbolKind(12);
+ pub const VARIABLE: SymbolKind = SymbolKind(13);
+ pub const CONSTANT: SymbolKind = SymbolKind(14);
+ pub const STRING: SymbolKind = SymbolKind(15);
+ pub const NUMBER: SymbolKind = SymbolKind(16);
+ pub const BOOLEAN: SymbolKind = SymbolKind(17);
+ pub const ARRAY: SymbolKind = SymbolKind(18);
+ pub const OBJECT: SymbolKind = SymbolKind(19);
+ pub const KEY: SymbolKind = SymbolKind(20);
+ pub const NULL: SymbolKind = SymbolKind(21);
+ pub const ENUM_MEMBER: SymbolKind = SymbolKind(22);
+ pub const STRUCT: SymbolKind = SymbolKind(23);
+ pub const EVENT: SymbolKind = SymbolKind(24);
+ pub const OPERATOR: SymbolKind = SymbolKind(25);
+ pub const TYPE_PARAMETER: SymbolKind = SymbolKind(26);
+}
+}
+
+/// Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct SymbolKindCapability {
+ /// The symbol kind values the client supports. When this
+ /// property exists the client also guarantees that it will
+ /// handle values outside its set gracefully and falls back
+ /// to a default value when unknown.
+ ///
+ /// If this property is not present the client only supports
+ /// the symbol kinds from `File` to `Array` as defined in
+ /// the initial version of the protocol.
+ pub value_set: Option<Vec<SymbolKind>>,
+}
+
+/// Workspace specific client capabilities.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct WorkspaceClientCapabilities {
+ /// The client supports applying batch edits to the workspace by supporting
+ /// the request 'workspace/applyEdit'
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub apply_edit: Option<bool>,
+
+ /// Capabilities specific to `WorkspaceEdit`s
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub workspace_edit: Option<WorkspaceEditClientCapabilities>,
+
+ /// Capabilities specific to the `workspace/didChangeConfiguration` notification.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub did_change_configuration: Option<DidChangeConfigurationClientCapabilities>,
+
+ /// Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub did_change_watched_files: Option<DidChangeWatchedFilesClientCapabilities>,
+
+ /// Capabilities specific to the `workspace/symbol` request.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub symbol: Option<WorkspaceSymbolClientCapabilities>,
+
+ /// Capabilities specific to the `workspace/executeCommand` request.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub execute_command: Option<ExecuteCommandClientCapabilities>,
+
+ /// The client has support for workspace folders.
+ /// since 3.6.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub workspace_folders: Option<bool>,
+
+ /// The client supports `workspace/configuration` requests.
+ /// since 3.6.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub configuration: Option<bool>,
+
+ /// Capabilities specific to the semantic token requsts scoped to the workspace.
+ /// since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub semantic_tokens: Option<SemanticTokensWorkspaceClientCapabilities>,
+
+ /// Capabilities specific to the code lens requests scoped to the workspace.
+ /// since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub code_lens: Option<CodeLensWorkspaceClientCapabilities>,
+
+ /// The client has support for file requests/notifications.
+ /// since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub file_operations: Option<WorkspaceFileOperationsClientCapabilities>,
+
+ /// Client workspace capabilities specific to inline values.
+ /// since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub inline_value: Option<InlineValueWorkspaceClientCapabilities>,
+
+ /// Client workspace capabilities specific to inlay hints.
+ /// since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub inlay_hint: Option<InlayHintWorkspaceClientCapabilities>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentSyncClientCapabilities {
+ /// Whether text document synchronization supports dynamic registration.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub dynamic_registration: Option<bool>,
+
+ /// The client supports sending will save notifications.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub will_save: Option<bool>,
+
+ /// The client supports sending a will save request and
+ /// waits for a response providing text edits which will
+ /// be applied to the document before it is saved.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub will_save_wait_until: Option<bool>,
+
+ /// The client supports did save notifications.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub did_save: Option<bool>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct PublishDiagnosticsClientCapabilities {
+ /// Whether the clients accepts diagnostics with related information.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub related_information: Option<bool>,
+
+ /// Client supports the tag property to provide meta data about a diagnostic.
+ /// Clients supporting tags have to handle unknown tags gracefully.
+ #[serde(
+ default,
+ skip_serializing_if = "Option::is_none",
+ deserialize_with = "TagSupport::deserialize_compat"
+ )]
+ pub tag_support: Option<TagSupport<DiagnosticTag>>,
+
+ /// Whether the client interprets the version property of the
+ /// `textDocument/publishDiagnostics` notification's parameter.
+ ///
+ /// 3.15.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub version_support: Option<bool>,
+
+ /// Client supports a codeDescription property
+ ///
+ /// 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub code_description_support: Option<bool>,
+
+ /// Whether code action supports the `data` property which is
+ /// preserved between a `textDocument/publishDiagnostics` and
+ /// `textDocument/codeAction` request.
+ ///
+ /// 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub data_support: Option<bool>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TagSupport<T> {
+ /// The tags supported by the client.
+ pub value_set: Vec<T>,
+}
+
+impl<T> TagSupport<T> {
+ /// Support for deserializing a boolean tag Support, in case it's present.
+ ///
+ /// This is currently the case for vscode 1.41.1
+ fn deserialize_compat<'de, S>(serializer: S) -> Result<Option<TagSupport<T>>, S::Error>
+ where
+ S: serde::Deserializer<'de>,
+ T: serde::Deserialize<'de>,
+ {
+ Ok(
+ match Option::<Value>::deserialize(serializer).map_err(serde::de::Error::custom)? {
+ Some(Value::Bool(false)) => None,
+ Some(Value::Bool(true)) => Some(TagSupport { value_set: vec![] }),
+ Some(other) => {
+ Some(TagSupport::<T>::deserialize(other).map_err(serde::de::Error::custom)?)
+ }
+ None => None,
+ },
+ )
+ }
+}
+
+/// Text document specific client capabilities.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentClientCapabilities {
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub synchronization: Option<TextDocumentSyncClientCapabilities>,
+ /// Capabilities specific to the `textDocument/completion`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub completion: Option<CompletionClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/hover`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub hover: Option<HoverClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/signatureHelp`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub signature_help: Option<SignatureHelpClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/references`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub references: Option<ReferenceClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/documentHighlight`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_highlight: Option<DocumentHighlightClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/documentSymbol`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_symbol: Option<DocumentSymbolClientCapabilities>,
+ /// Capabilities specific to the `textDocument/formatting`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub formatting: Option<DocumentFormattingClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/rangeFormatting`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub range_formatting: Option<DocumentRangeFormattingClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/onTypeFormatting`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub on_type_formatting: Option<DocumentOnTypeFormattingClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/declaration`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub declaration: Option<GotoCapability>,
+
+ /// Capabilities specific to the `textDocument/definition`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub definition: Option<GotoCapability>,
+
+ /// Capabilities specific to the `textDocument/typeDefinition`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub type_definition: Option<GotoCapability>,
+
+ /// Capabilities specific to the `textDocument/implementation`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub implementation: Option<GotoCapability>,
+
+ /// Capabilities specific to the `textDocument/codeAction`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub code_action: Option<CodeActionClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/codeLens`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub code_lens: Option<CodeLensClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/documentLink`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_link: Option<DocumentLinkClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/documentColor` and the
+ /// `textDocument/colorPresentation` request.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub color_provider: Option<DocumentColorClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/rename`
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub rename: Option<RenameClientCapabilities>,
+
+ /// Capabilities specific to `textDocument/publishDiagnostics`.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub publish_diagnostics: Option<PublishDiagnosticsClientCapabilities>,
+
+ /// Capabilities specific to `textDocument/foldingRange` requests.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub folding_range: Option<FoldingRangeClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/selectionRange` request.
+ ///
+ /// @since 3.15.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub selection_range: Option<SelectionRangeClientCapabilities>,
+
+ /// Capabilities specific to `textDocument/linkedEditingRange` requests.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub linked_editing_range: Option<LinkedEditingRangeClientCapabilities>,
+
+ /// Capabilities specific to the various call hierarchy requests.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub call_hierarchy: Option<CallHierarchyClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/semanticTokens/*` requests.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub semantic_tokens: Option<SemanticTokensClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/moniker` request.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub moniker: Option<MonikerClientCapabilities>,
+
+ /// Capabilities specific to the various type hierarchy requests.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub type_hierarchy: Option<TypeHierarchyClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/inlineValue` request.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub inline_value: Option<InlineValueClientCapabilities>,
+
+ /// Capabilities specific to the `textDocument/inlayHint` request.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub inlay_hint: Option<InlayHintClientCapabilities>,
+}
+
+/// Where ClientCapabilities are currently empty:
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ClientCapabilities {
+ /// Workspace specific client capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub workspace: Option<WorkspaceClientCapabilities>,
+
+ /// Text document specific client capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub text_document: Option<TextDocumentClientCapabilities>,
+
+ /// Window specific client capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub window: Option<WindowClientCapabilities>,
+
+ /// General client capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub general: Option<GeneralClientCapabilities>,
+
+ /// Unofficial UT8-offsets extension.
+ ///
+ /// See https://clangd.llvm.org/extensions.html#utf-8-offsets.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ #[cfg(feature = "proposed")]
+ pub offset_encoding: Option<Vec<String>>,
+
+ /// Experimental client capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub experimental: Option<Value>,
+}
+
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct GeneralClientCapabilities {
+ /// Client capabilities specific to regular expressions.
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub regular_expressions: Option<RegularExpressionsClientCapabilities>,
+
+ /// Client capabilities specific to the client's markdown parser.
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub markdown: Option<MarkdownClientCapabilities>,
+
+ /// Client capability that signals how the client handles stale requests (e.g. a request for
+ /// which the client will not process the response anymore since the information is outdated).
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub stale_request_support: Option<StaleRequestSupportClientCapabilities>,
+
+ /// The position encodings supported by the client. Client and server
+ /// have to agree on the same position encoding to ensure that offsets
+ /// (e.g. character position in a line) are interpreted the same on both
+ /// side.
+ ///
+ /// To keep the protocol backwards compatible the following applies: if
+ /// the value 'utf-16' is missing from the array of position encodings
+ /// servers can assume that the client supports UTF-16. UTF-16 is
+ /// therefore a mandatory encoding.
+ ///
+ /// If omitted it defaults to ['utf-16'].
+ ///
+ /// Implementation considerations: since the conversion from one encoding
+ /// into another requires the content of the file / line the conversion
+ /// is best done where the file is read which is usually on the server
+ /// side.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub position_encodings: Option<Vec<PositionEncodingKind>>,
+}
+
+/// Client capability that signals how the client
+/// handles stale requests (e.g. a request
+/// for which the client will not process the response
+/// anymore since the information is outdated).
+///
+/// @since 3.17.0
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct StaleRequestSupportClientCapabilities {
+ /// The client will actively cancel the request.
+ pub cancel: bool,
+
+ /// The list of requests for which the client
+ /// will retry the request if it receives a
+ /// response with error code `ContentModified``
+ pub retry_on_content_modified: Vec<String>,
+}
+
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct RegularExpressionsClientCapabilities {
+ /// The engine's name.
+ pub engine: String,
+
+ /// The engine's version
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub version: Option<String>,
+}
+
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct MarkdownClientCapabilities {
+ /// The name of the parser.
+ pub parser: String,
+
+ /// The version of the parser.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub version: Option<String>,
+
+ /// A list of HTML tags that the client allows / supports in
+ /// Markdown.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub allowed_tags: Option<Vec<String>>,
+}
+
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct InitializeResult {
+ /// The capabilities the language server provides.
+ pub capabilities: ServerCapabilities,
+
+ /// Information about the server.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub server_info: Option<ServerInfo>,
+
+ /// Unofficial UT8-offsets extension.
+ ///
+ /// See https://clangd.llvm.org/extensions.html#utf-8-offsets.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ #[cfg(feature = "proposed")]
+ pub offset_encoding: Option<String>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+pub struct ServerInfo {
+ /// The name of the server as defined by the server.
+ pub name: String,
+ /// The servers's version as defined by the server.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub version: Option<String>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+pub struct InitializeError {
+ /// Indicates whether the client should retry to send the
+ /// initilize request after showing the message provided
+ /// in the ResponseError.
+ pub retry: bool,
+}
+
+// The server can signal the following capabilities:
+
+/// Defines how the host (editor) should sync document changes to the language server.
+#[derive(Eq, PartialEq, Clone, Copy, Deserialize, Serialize)]
+#[serde(transparent)]
+pub struct TextDocumentSyncKind(i32);
+lsp_enum! {
+impl TextDocumentSyncKind {
+ /// Documents should not be synced at all.
+ pub const NONE: TextDocumentSyncKind = TextDocumentSyncKind(0);
+
+ /// Documents are synced by always sending the full content of the document.
+ pub const FULL: TextDocumentSyncKind = TextDocumentSyncKind(1);
+
+ /// Documents are synced by sending the full content on open. After that only
+ /// incremental updates to the document are sent.
+ pub const INCREMENTAL: TextDocumentSyncKind = TextDocumentSyncKind(2);
+}
+}
+
+pub type ExecuteCommandClientCapabilities = DynamicRegistrationClientCapabilities;
+
+/// Execute command options.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+pub struct ExecuteCommandOptions {
+ /// The commands to be executed on the server
+ pub commands: Vec<String>,
+
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+/// Save options.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct SaveOptions {
+ /// The client is supposed to include the content on save.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub include_text: Option<bool>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum TextDocumentSyncSaveOptions {
+ Supported(bool),
+ SaveOptions(SaveOptions),
+}
+
+impl From<SaveOptions> for TextDocumentSyncSaveOptions {
+ fn from(from: SaveOptions) -> Self {
+ Self::SaveOptions(from)
+ }
+}
+
+impl From<bool> for TextDocumentSyncSaveOptions {
+ fn from(from: bool) -> Self {
+ Self::Supported(from)
+ }
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentSyncOptions {
+ /// Open and close notifications are sent to the server.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub open_close: Option<bool>,
+
+ /// Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
+ /// and TextDocumentSyncKindIncremental.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub change: Option<TextDocumentSyncKind>,
+
+ /// Will save notifications are sent to the server.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub will_save: Option<bool>,
+
+ /// Will save wait until requests are sent to the server.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub will_save_wait_until: Option<bool>,
+
+ /// Save notifications are sent to the server.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub save: Option<TextDocumentSyncSaveOptions>,
+}
+
+#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum OneOf<A, B> {
+ Left(A),
+ Right(B),
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum TextDocumentSyncCapability {
+ Kind(TextDocumentSyncKind),
+ Options(TextDocumentSyncOptions),
+}
+
+impl From<TextDocumentSyncOptions> for TextDocumentSyncCapability {
+ fn from(from: TextDocumentSyncOptions) -> Self {
+ Self::Options(from)
+ }
+}
+
+impl From<TextDocumentSyncKind> for TextDocumentSyncCapability {
+ fn from(from: TextDocumentSyncKind) -> Self {
+ Self::Kind(from)
+ }
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum ImplementationProviderCapability {
+ Simple(bool),
+ Options(StaticTextDocumentRegistrationOptions),
+}
+
+impl From<StaticTextDocumentRegistrationOptions> for ImplementationProviderCapability {
+ fn from(from: StaticTextDocumentRegistrationOptions) -> Self {
+ Self::Options(from)
+ }
+}
+
+impl From<bool> for ImplementationProviderCapability {
+ fn from(from: bool) -> Self {
+ Self::Simple(from)
+ }
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum TypeDefinitionProviderCapability {
+ Simple(bool),
+ Options(StaticTextDocumentRegistrationOptions),
+}
+
+impl From<StaticTextDocumentRegistrationOptions> for TypeDefinitionProviderCapability {
+ fn from(from: StaticTextDocumentRegistrationOptions) -> Self {
+ Self::Options(from)
+ }
+}
+
+impl From<bool> for TypeDefinitionProviderCapability {
+ fn from(from: bool) -> Self {
+ Self::Simple(from)
+ }
+}
+
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ServerCapabilities {
+ /// The position encoding the server picked from the encodings offered
+ /// by the client via the client capability `general.positionEncodings`.
+ ///
+ /// If the client didn't provide any position encodings the only valid
+ /// value that a server can return is 'utf-16'.
+ ///
+ /// If omitted it defaults to 'utf-16'.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub position_encoding: Option<PositionEncodingKind>,
+
+ /// Defines how text documents are synced.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub text_document_sync: Option<TextDocumentSyncCapability>,
+
+ /// Capabilities specific to `textDocument/selectionRange` requests.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub selection_range_provider: Option<SelectionRangeProviderCapability>,
+
+ /// The server provides hover support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub hover_provider: Option<HoverProviderCapability>,
+
+ /// The server provides completion support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub completion_provider: Option<CompletionOptions>,
+
+ /// The server provides signature help support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub signature_help_provider: Option<SignatureHelpOptions>,
+
+ /// The server provides goto definition support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub definition_provider: Option<OneOf<bool, DefinitionOptions>>,
+
+ /// The server provides goto type definition support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub type_definition_provider: Option<TypeDefinitionProviderCapability>,
+
+ /// The server provides goto implementation support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub implementation_provider: Option<ImplementationProviderCapability>,
+
+ /// The server provides find references support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub references_provider: Option<OneOf<bool, ReferencesOptions>>,
+
+ /// The server provides document highlight support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_highlight_provider: Option<OneOf<bool, DocumentHighlightOptions>>,
+
+ /// The server provides document symbol support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_symbol_provider: Option<OneOf<bool, DocumentSymbolOptions>>,
+
+ /// The server provides workspace symbol support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub workspace_symbol_provider: Option<OneOf<bool, WorkspaceSymbolOptions>>,
+
+ /// The server provides code actions.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub code_action_provider: Option<CodeActionProviderCapability>,
+
+ /// The server provides code lens.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub code_lens_provider: Option<CodeLensOptions>,
+
+ /// The server provides document formatting.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_formatting_provider: Option<OneOf<bool, DocumentFormattingOptions>>,
+
+ /// The server provides document range formatting.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_range_formatting_provider: Option<OneOf<bool, DocumentRangeFormattingOptions>>,
+
+ /// The server provides document formatting on typing.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_on_type_formatting_provider: Option<DocumentOnTypeFormattingOptions>,
+
+ /// The server provides rename support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub rename_provider: Option<OneOf<bool, RenameOptions>>,
+
+ /// The server provides document link support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub document_link_provider: Option<DocumentLinkOptions>,
+
+ /// The server provides color provider support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub color_provider: Option<ColorProviderCapability>,
+
+ /// The server provides folding provider support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub folding_range_provider: Option<FoldingRangeProviderCapability>,
+
+ /// The server provides go to declaration support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub declaration_provider: Option<DeclarationCapability>,
+
+ /// The server provides execute command support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub execute_command_provider: Option<ExecuteCommandOptions>,
+
+ /// Workspace specific server capabilities
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub workspace: Option<WorkspaceServerCapabilities>,
+
+ /// Call hierarchy provider capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub call_hierarchy_provider: Option<CallHierarchyServerCapability>,
+
+ /// Semantic tokens server capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub semantic_tokens_provider: Option<SemanticTokensServerCapabilities>,
+
+ /// Whether server provides moniker support.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub moniker_provider: Option<OneOf<bool, MonikerServerCapabilities>>,
+
+ /// The server provides inline values.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub inline_value_provider: Option<OneOf<bool, InlineValueServerCapabilities>>,
+
+ /// The server provides inlay hints.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub inlay_hint_provider: Option<OneOf<bool, InlayHintServerCapabilities>>,
+
+ /// The server provides linked editing range support.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub linked_editing_range_provider: Option<LinkedEditingRangeServerCapabilities>,
+
+ /// Experimental server capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub experimental: Option<Value>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct WorkspaceServerCapabilities {
+ /// The server supports workspace folder.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub workspace_folders: Option<WorkspaceFoldersServerCapabilities>,
+
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub file_operations: Option<WorkspaceFileOperationsServerCapabilities>,
+}
+
+/// General parameters to to register for a capability.
+#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Registration {
+ /// The id used to register the request. The id can be used to deregister
+ /// the request again.
+ pub id: String,
+
+ /// The method / capability to register for.
+ pub method: String,
+
+ /// Options necessary for the registration.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub register_options: Option<Value>,
+}
+
+#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
+pub struct RegistrationParams {
+ pub registrations: Vec<Registration>,
+}
+
+/// Since most of the registration options require to specify a document selector there is a base
+/// interface that can be used.
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentRegistrationOptions {
+ /// A document selector to identify the scope of the registration. If set to null
+ /// the document selector provided on the client side will be used.
+ pub document_selector: Option<DocumentSelector>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum DeclarationCapability {
+ Simple(bool),
+ RegistrationOptions(DeclarationRegistrationOptions),
+ Options(DeclarationOptions),
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DeclarationRegistrationOptions {
+ #[serde(flatten)]
+ pub declaration_options: DeclarationOptions,
+
+ #[serde(flatten)]
+ pub text_document_registration_options: TextDocumentRegistrationOptions,
+
+ #[serde(flatten)]
+ pub static_registration_options: StaticRegistrationOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DeclarationOptions {
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct StaticRegistrationOptions {
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub id: Option<String>,
+}
+
+#[derive(Debug, Default, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct WorkDoneProgressOptions {
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub work_done_progress: Option<bool>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DocumentFormattingOptions {
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DocumentRangeFormattingOptions {
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DefinitionOptions {
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DocumentSymbolOptions {
+ /// A human-readable string that is shown when multiple outlines trees are
+ /// shown for the same document.
+ ///
+ /// @since 3.16.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub label: Option<String>,
+
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ReferencesOptions {
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DocumentHighlightOptions {
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct WorkspaceSymbolOptions {
+ #[serde(flatten)]
+ pub work_done_progress_options: WorkDoneProgressOptions,
+
+ /// The server provides support to resolve additional
+ /// information for a workspace symbol.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub resolve_provider: Option<bool>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct StaticTextDocumentRegistrationOptions {
+ /// A document selector to identify the scope of the registration. If set to null
+ /// the document selector provided on the client side will be used.
+ pub document_selector: Option<DocumentSelector>,
+
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub id: Option<String>,
+}
+
+/// General parameters to unregister a capability.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct Unregistration {
+ /// The id used to unregister the request or notification. Usually an id
+ /// provided during the register request.
+ pub id: String,
+
+ /// The method / capability to unregister for.
+ pub method: String,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct UnregistrationParams {
+ pub unregisterations: Vec<Unregistration>,
+}
+
+#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
+pub struct DidChangeConfigurationParams {
+ /// The actual changed settings
+ pub settings: Value,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DidOpenTextDocumentParams {
+ /// The document that was opened.
+ pub text_document: TextDocumentItem,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DidChangeTextDocumentParams {
+ /// The document that did change. The version number points
+ /// to the version after all provided content changes have
+ /// been applied.
+ pub text_document: VersionedTextDocumentIdentifier,
+ /// The actual content changes.
+ pub content_changes: Vec<TextDocumentContentChangeEvent>,
+}
+
+/// An event describing a change to a text document. If range and rangeLength are omitted
+/// the new text is considered to be the full content of the document.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentContentChangeEvent {
+ /// The range of the document that changed.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub range: Option<Range>,
+
+ /// The length of the range that got replaced.
+ ///
+ /// Deprecated: Use range instead
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub range_length: Option<u32>,
+
+ /// The new text of the document.
+ pub text: String,
+}
+
+/// Descibe options to be used when registered for text document change events.
+///
+/// Extends TextDocumentRegistrationOptions
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentChangeRegistrationOptions {
+ /// A document selector to identify the scope of the registration. If set to null
+ /// the document selector provided on the client side will be used.
+ pub document_selector: Option<DocumentSelector>,
+
+ /// How documents are synced to the server. See TextDocumentSyncKind.Full
+ /// and TextDocumentSyncKindIncremental.
+ pub sync_kind: i32,
+}
+
+/// The parameters send in a will save text document notification.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct WillSaveTextDocumentParams {
+ /// The document that will be saved.
+ pub text_document: TextDocumentIdentifier,
+
+ /// The 'TextDocumentSaveReason'.
+ pub reason: TextDocumentSaveReason,
+}
+
+/// Represents reasons why a text document is saved.
+#[derive(Copy, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(transparent)]
+pub struct TextDocumentSaveReason(i32);
+lsp_enum! {
+impl TextDocumentSaveReason {
+ /// Manually triggered, e.g. by the user pressing save, by starting debugging,
+ /// or by an API call.
+ pub const MANUAL: TextDocumentSaveReason = TextDocumentSaveReason(1);
+
+ /// Automatic after a delay.
+ pub const AFTER_DELAY: TextDocumentSaveReason = TextDocumentSaveReason(2);
+
+ /// When the editor lost focus.
+ pub const FOCUS_OUT: TextDocumentSaveReason = TextDocumentSaveReason(3);
+}
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DidCloseTextDocumentParams {
+ /// The document that was closed.
+ pub text_document: TextDocumentIdentifier,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DidSaveTextDocumentParams {
+ /// The document that was saved.
+ pub text_document: TextDocumentIdentifier,
+
+ /// Optional the content when saved. Depends on the includeText value
+ /// when the save notification was requested.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub text: Option<String>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TextDocumentSaveRegistrationOptions {
+ /// The client is supposed to include the content on save.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub include_text: Option<bool>,
+
+ #[serde(flatten)]
+ pub text_document_registration_options: TextDocumentRegistrationOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Copy, Default, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DidChangeWatchedFilesClientCapabilities {
+ /// Did change watched files notification supports dynamic registration.
+ /// Please note that the current protocol doesn't support static
+ /// configuration for file changes from the server side.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub dynamic_registration: Option<bool>,
+
+ /// Whether the client has support for relative patterns
+ /// or not.
+ ///
+ /// @since 3.17.0
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub relative_pattern_support: Option<bool>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct DidChangeWatchedFilesParams {
+ /// The actual file events.
+ pub changes: Vec<FileEvent>,
+}
+
+/// The file event type.
+#[derive(Eq, PartialEq, Hash, Copy, Clone, Deserialize, Serialize)]
+#[serde(transparent)]
+pub struct FileChangeType(i32);
+lsp_enum! {
+impl FileChangeType {
+ /// The file got created.
+ pub const CREATED: FileChangeType = FileChangeType(1);
+
+ /// The file got changed.
+ pub const CHANGED: FileChangeType = FileChangeType(2);
+
+ /// The file got deleted.
+ pub const DELETED: FileChangeType = FileChangeType(3);
+}
+}
+
+/// An event describing a file change.
+#[derive(Debug, Eq, Hash, PartialEq, Clone, Deserialize, Serialize)]
+pub struct FileEvent {
+ /// The file's URI.
+ pub uri: Url,
+
+ /// The change type.
+ #[serde(rename = "type")]
+ pub typ: FileChangeType,
+}
+
+impl FileEvent {
+ pub fn new(uri: Url, typ: FileChangeType) -> FileEvent {
+ FileEvent { uri, typ }
+ }
+}
+
+/// Describe options to be used when registered for text document change events.
+#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Deserialize, Serialize)]
+pub struct DidChangeWatchedFilesRegistrationOptions {
+ /// The watchers to register.
+ pub watchers: Vec<FileSystemWatcher>,
+}
+
+#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct FileSystemWatcher {
+ /// The glob pattern to watch. See {@link GlobPattern glob pattern}
+ /// for more detail.
+ ///
+ /// @since 3.17.0 support for relative patterns.
+ pub glob_pattern: GlobPattern,
+
+ /// The kind of events of interest. If omitted it defaults to WatchKind.Create |
+ /// WatchKind.Change | WatchKind.Delete which is 7.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub kind: Option<WatchKind>,
+}
+
+/// The glob pattern. Either a string pattern or a relative pattern.
+///
+/// @since 3.17.0
+#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum GlobPattern {
+ String(Pattern),
+ Relative(RelativePattern),
+}
+
+impl From<Pattern> for GlobPattern {
+ #[inline]
+ fn from(from: Pattern) -> Self {
+ Self::String(from)
+ }
+}
+
+impl From<RelativePattern> for GlobPattern {
+ #[inline]
+ fn from(from: RelativePattern) -> Self {
+ Self::Relative(from)
+ }
+}
+
+/// A relative pattern is a helper to construct glob patterns that are matched
+/// relatively to a base URI. The common value for a `baseUri` is a workspace
+/// folder root, but it can be another absolute URI as well.
+///
+/// @since 3.17.0
+#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct RelativePattern {
+ /// A workspace folder or a base URI to which this pattern will be matched
+ /// against relatively.
+ pub base_uri: OneOf<WorkspaceFolder, Url>,
+
+ /// The actual glob pattern.
+ pub pattern: Pattern,
+}
+
+/// The glob pattern to watch relative to the base path. Glob patterns can have
+/// the following syntax:
+/// - `*` to match one or more characters in a path segment
+/// - `?` to match on one character in a path segment
+/// - `**` to match any number of path segments, including none
+/// - `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript
+/// and JavaScript files)
+/// - `[]` to declare a range of characters to match in a path segment
+/// (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+/// - `[!...]` to negate a range of characters to match in a path segment
+/// (e.g., `example.[!0-9]` to match on `example.a`, `example.b`,
+/// but not `example.0`)
+///
+/// @since 3.17.0
+pub type Pattern = String;
+
+bitflags! {
+pub struct WatchKind: u8 {
+ /// Interested in create events.
+ const Create = 1;
+ /// Interested in change events
+ const Change = 2;
+ /// Interested in delete events
+ const Delete = 4;
+}
+}
+
+impl<'de> serde::Deserialize<'de> for WatchKind {
+ fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+ where
+ D: serde::Deserializer<'de>,
+ {
+ let i = u8::deserialize(deserializer)?;
+ WatchKind::from_bits(i).ok_or_else(|| {
+ D::Error::invalid_value(de::Unexpected::Unsigned(u64::from(i)), &"Unknown flag")
+ })
+ }
+}
+
+impl serde::Serialize for WatchKind {
+ fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+ where
+ S: serde::Serializer,
+ {
+ serializer.serialize_u8(self.bits())
+ }
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct PublishDiagnosticsParams {
+ /// The URI for which diagnostic information is reported.
+ pub uri: Url,
+
+ /// An array of diagnostic information items.
+ pub diagnostics: Vec<Diagnostic>,
+
+ /// Optional the version number of the document the diagnostics are published for.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub version: Option<i32>,
+}
+
+impl PublishDiagnosticsParams {
+ pub fn new(
+ uri: Url,
+ diagnostics: Vec<Diagnostic>,
+ version: Option<i32>,
+ ) -> PublishDiagnosticsParams {
+ PublishDiagnosticsParams {
+ uri,
+ diagnostics,
+ version,
+ }
+ }
+}
+
+#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Clone)]
+#[serde(untagged)]
+pub enum Documentation {
+ String(String),
+ MarkupContent(MarkupContent),
+}
+
+/// The marked string is rendered:
+/// - as markdown if it is represented as a string
+/// - as code block of the given langauge if it is represented as a pair of a language and a value
+///
+/// The pair of a language and a value is an equivalent to markdown:
+/// ```${language}
+/// ${value}
+/// ```
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum MarkedString {
+ String(String),
+ LanguageString(LanguageString),
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct LanguageString {
+ pub language: String,
+ pub value: String,
+}
+
+impl MarkedString {
+ pub fn from_markdown(markdown: String) -> MarkedString {
+ MarkedString::String(markdown)
+ }
+
+ pub fn from_language_code(language: String, code_block: String) -> MarkedString {
+ MarkedString::LanguageString(LanguageString {
+ language,
+ value: code_block,
+ })
+ }
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct GotoDefinitionParams {
+ #[serde(flatten)]
+ pub text_document_position_params: TextDocumentPositionParams,
+
+ #[serde(flatten)]
+ pub work_done_progress_params: WorkDoneProgressParams,
+
+ #[serde(flatten)]
+ pub partial_result_params: PartialResultParams,
+}
+
+/// GotoDefinition response can be single location, or multiple Locations or a link.
+#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
+#[serde(untagged)]
+pub enum GotoDefinitionResponse {
+ Scalar(Location),
+ Array(Vec<Location>),
+ Link(Vec<LocationLink>),
+}
+
+impl From<Location> for GotoDefinitionResponse {
+ fn from(location: Location) -> Self {
+ GotoDefinitionResponse::Scalar(location)
+ }
+}
+
+impl From<Vec<Location>> for GotoDefinitionResponse {
+ fn from(locations: Vec<Location>) -> Self {
+ GotoDefinitionResponse::Array(locations)
+ }
+}
+
+impl From<Vec<LocationLink>> for GotoDefinitionResponse {
+ fn from(locations: Vec<LocationLink>) -> Self {
+ GotoDefinitionResponse::Link(locations)
+ }
+}
+
+#[derive(Debug, PartialEq, Clone, Default, Deserialize, Serialize)]
+pub struct ExecuteCommandParams {
+ /// The identifier of the actual command handler.
+ pub command: String,
+ /// Arguments that the command should be invoked with.
+ #[serde(default)]
+ pub arguments: Vec<Value>,
+
+ #[serde(flatten)]
+ pub work_done_progress_params: WorkDoneProgressParams,
+}
+
+/// Execute command registration options.
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct ExecuteCommandRegistrationOptions {
+ /// The commands to be executed on the server
+ pub commands: Vec<String>,
+
+ #[serde(flatten)]
+ pub execute_command_options: ExecuteCommandOptions,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ApplyWorkspaceEditParams {
+ /// An optional label of the workspace edit. This label is
+ /// presented in the user interface for example on an undo
+ /// stack to undo the workspace edit.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub label: Option<String>,
+
+ /// The edits to apply.
+ pub edit: WorkspaceEdit,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ApplyWorkspaceEditResponse {
+ /// Indicates whether the edit was applied or not.
+ pub applied: bool,
+
+ /// An optional textual description for why the edit was not applied.
+ /// This may be used may be used by the server for diagnostic
+ /// logging or to provide a suitable error for a request that
+ /// triggered the edit
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub failure_reason: Option<String>,
+
+ /// Depending on the client's failure handling strategy `failedChange` might
+ /// contain the index of the change that failed. This property is only available
+ /// if the client signals a `failureHandlingStrategy` in its client capabilities.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub failed_change: Option<u32>,
+}
+
+/// Describes the content type that a client supports in various
+/// result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
+///
+/// Please note that `MarkupKinds` must not start with a `$`. This kinds
+/// are reserved for internal usage.
+#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Clone)]
+#[serde(rename_all = "lowercase")]
+pub enum MarkupKind {
+ /// Plain text is supported as a content format
+ PlainText,
+ /// Markdown is supported as a content format
+ Markdown,
+}
+
+/// A `MarkupContent` literal represents a string value which content can be represented in different formats.
+/// Currently `plaintext` and `markdown` are supported formats. A `MarkupContent` is usually used in
+/// documentation properties of result literals like `CompletionItem` or `SignatureInformation`.
+/// If the format is `markdown` the content should follow the [GitHub Flavored Markdown Specification](https://github.github.com/gfm/).
+///
+/// Here is an example how such a string can be constructed using JavaScript / TypeScript:
+/// ```ignore
+/// let markdown: MarkupContent = {
+/// kind: MarkupKind::Markdown,
+/// value: [
+/// "# Header",
+/// "Some text",
+/// "```typescript",
+/// "someCode();",
+/// "```"
+/// ]
+/// .join("\n"),
+/// };
+/// ```
+///
+/// Please Note* that clients might sanitize the return markdown. A client could decide to
+/// remove HTML from the markdown to avoid script execution.
+#[derive(Debug, Eq, PartialEq, Deserialize, Serialize, Clone)]
+pub struct MarkupContent {
+ pub kind: MarkupKind,
+ pub value: String,
+}
+
+/// A parameter literal used to pass a partial result token.
+#[derive(Debug, Eq, PartialEq, Default, Deserialize, Serialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct PartialResultParams {
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub partial_result_token: Option<ProgressToken>,
+}
+
+/// Symbol tags are extra annotations that tweak the rendering of a symbol.
+/// Since 3.15
+#[derive(Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(transparent)]
+pub struct SymbolTag(i32);
+lsp_enum! {
+impl SymbolTag {
+ /// Render a symbol as obsolete, usually using a strike-out.
+ pub const DEPRECATED: SymbolTag = SymbolTag(1);
+}
+}
+
+#[cfg(test)]
+mod tests {
+ use serde::{Deserialize, Serialize};
+
+ use super::*;
+
+ pub(crate) fn test_serialization<SER>(ms: &SER, expected: &str)
+ where
+ SER: Serialize + for<'de> Deserialize<'de> + PartialEq + std::fmt::Debug,
+ {
+ let json_str = serde_json::to_string(ms).unwrap();
+ assert_eq!(&json_str, expected);
+ let deserialized: SER = serde_json::from_str(&json_str).unwrap();
+ assert_eq!(&deserialized, ms);
+ }
+
+ pub(crate) fn test_deserialization<T>(json: &str, expected: &T)
+ where
+ T: for<'de> Deserialize<'de> + PartialEq + std::fmt::Debug,
+ {
+ let value = serde_json::from_str::<T>(json).unwrap();
+ assert_eq!(&value, expected);
+ }
+
+ #[test]
+ fn one_of() {
+ test_serialization(&OneOf::<bool, ()>::Left(true), r#"true"#);
+ test_serialization(&OneOf::<String, ()>::Left("abcd".into()), r#""abcd""#);
+ test_serialization(
+ &OneOf::<String, WorkDoneProgressOptions>::Right(WorkDoneProgressOptions {
+ work_done_progress: Some(false),
+ }),
+ r#"{"workDoneProgress":false}"#,
+ );
+ }
+
+ #[test]
+ fn number_or_string() {
+ test_serialization(&NumberOrString::Number(123), r#"123"#);
+
+ test_serialization(&NumberOrString::String("abcd".into()), r#""abcd""#);
+ }
+
+ #[test]
+ fn marked_string() {
+ test_serialization(&MarkedString::from_markdown("xxx".into()), r#""xxx""#);
+
+ test_serialization(
+ &MarkedString::from_language_code("lang".into(), "code".into()),
+ r#"{"language":"lang","value":"code"}"#,
+ );
+ }
+
+ #[test]
+ fn language_string() {
+ test_serialization(
+ &LanguageString {
+ language: "LL".into(),
+ value: "VV".into(),
+ },
+ r#"{"language":"LL","value":"VV"}"#,
+ );
+ }
+
+ #[test]
+ fn workspace_edit() {
+ test_serialization(
+ &WorkspaceEdit {
+ changes: Some(vec![].into_iter().collect()),
+ document_changes: None,
+ ..Default::default()
+ },
+ r#"{"changes":{}}"#,
+ );
+
+ test_serialization(
+ &WorkspaceEdit {
+ changes: None,
+ document_changes: None,
+ ..Default::default()
+ },
+ r#"{}"#,
+ );
+
+ test_serialization(
+ &WorkspaceEdit {
+ changes: Some(
+ vec![(Url::parse("file://test").unwrap(), vec![])]
+ .into_iter()
+ .collect(),
+ ),
+ document_changes: None,
+ ..Default::default()
+ },
+ r#"{"changes":{"file://test/":[]}}"#,
+ );
+ }
+
+ #[test]
+ fn root_uri_can_be_missing() {
+ serde_json::from_str::<InitializeParams>(r#"{ "capabilities": {} }"#).unwrap();
+ }
+
+ #[test]
+ fn test_watch_kind() {
+ test_serialization(&WatchKind::Create, "1");
+ test_serialization(&(WatchKind::Create | WatchKind::Change), "3");
+ test_serialization(
+ &(WatchKind::Create | WatchKind::Change | WatchKind::Delete),
+ "7",
+ );
+ }
+
+ #[test]
+ fn test_resource_operation_kind() {
+ test_serialization(
+ &vec![
+ ResourceOperationKind::Create,
+ ResourceOperationKind::Rename,
+ ResourceOperationKind::Delete,
+ ],
+ r#"["create","rename","delete"]"#,
+ );
+ }
+}
|