| /- | |
| Copyright (c) 2020 Marc Huisinga. All rights reserved. | |
| Released under Apache 2.0 license as described in the file LICENSE. | |
| Authors: Marc Huisinga, Wojciech Nawrocki | |
| -/ | |
| module | |
| prelude | |
| public import Lean.Data.Lsp.TextSync | |
| public import Lean.Server.Rpc.Basic | |
| public section | |
| /-! This file contains Lean-specific extensions to LSP. See the structures below for which | |
| additional requests and notifications are supported. -/ | |
| namespace Lean.Lsp | |
| open Json | |
| /-- | |
| Controls when dependencies are built on `textDocument/didOpen` notifications. | |
| -/ | |
| inductive DependencyBuildMode where | |
| /-- Always build dependencies. -/ | |
| | always | |
| /-- Build dependencies once, but then do not build them again on import changes / crashes. Used for `didOpen` notifications that are explicitly intended for manually triggering the build. -/ | |
| | once | |
| /-- Never build dependencies. -/ | |
| | never | |
| deriving FromJson, ToJson, Inhabited | |
| structure LeanDidOpenTextDocumentParams extends DidOpenTextDocumentParams where | |
| dependencyBuildMode? : Option DependencyBuildMode := none -- `none`: Compatibility with clients pre-build-mode | |
| deriving FromJson, ToJson | |
| /-- `textDocument/waitForDiagnostics` client->server request. | |
| Yields a response when all the diagnostics for a version of the document greater or equal to the | |
| specified one have been emitted. If the request specifies a version above the most recently | |
| processed one, the server will delay the response until it does receive the specified version. | |
| Exists for synchronization purposes, e.g. during testing or when external tools might want to use | |
| our LSP server. -/ | |
| structure WaitForDiagnosticsParams where | |
| uri : DocumentUri | |
| version : Nat | |
| deriving FromJson, ToJson | |
| /-- `textDocument/waitForDiagnostics` client<-server reply. -/ | |
| structure WaitForDiagnostics | |
| instance : FromJson WaitForDiagnostics := | |
| ⟨fun _ => pure WaitForDiagnostics.mk⟩ | |
| instance : ToJson WaitForDiagnostics := | |
| ⟨fun _ => mkObj []⟩ | |
| /-- | |
| Internal `$/lean/waitForILeans` client->server request. | |
| Yields a response once the watchdog process has loaded all .ilean files and has received | |
| an ILean finalization notification for the worker and the document version designated in the request. | |
| Used for test stability in tests that use the .ileans. | |
| -/ | |
| structure WaitForILeansParams where | |
| uri? : Option DocumentUri := none | |
| version? : Option Nat := none | |
| deriving FromJson, ToJson | |
| structure WaitForILeans where | |
| deriving FromJson, ToJson | |
| inductive LeanFileProgressKind | |
| | processing | fatalError | |
| deriving Inhabited, BEq | |
| instance : FromJson LeanFileProgressKind := ⟨fun j => | |
| match j.getNat? with | |
| | Except.ok 1 => return LeanFileProgressKind.processing | |
| | Except.ok 2 => return LeanFileProgressKind.fatalError | |
| | _ => throw s!"unknown LeanFileProgressKind '{j}'"⟩ | |
| instance : ToJson LeanFileProgressKind := ⟨fun | |
| | LeanFileProgressKind.processing => 1 | |
| | LeanFileProgressKind.fatalError => 2⟩ | |
| structure LeanFileProgressProcessingInfo where | |
| range : Range | |
| kind : LeanFileProgressKind := LeanFileProgressKind.processing | |
| deriving FromJson, ToJson | |
| /-- `$/lean/fileProgress` client<-server notification. | |
| Contains the ranges of the document that are currently being processed by the server. -/ | |
| structure LeanFileProgressParams where | |
| textDocument : VersionedTextDocumentIdentifier | |
| processing : Array LeanFileProgressProcessingInfo | |
| deriving FromJson, ToJson | |
| /-- `$/lean/plainGoal` client->server request. | |
| If there is a tactic proof at the specified position, returns the current goals. | |
| Otherwise returns `null`. -/ | |
| structure PlainGoalParams extends TextDocumentPositionParams | |
| deriving FromJson, ToJson | |
| /-- `$/lean/plainGoal` client<-server reply. -/ | |
| structure PlainGoal where | |
| /-- The goals as pretty-printed Markdown, or something like "no goals" if accomplished. -/ | |
| rendered : String | |
| /-- The pretty-printed goals, empty if all accomplished. -/ | |
| goals : Array String | |
| deriving FromJson, ToJson | |
| /-- `$/lean/plainTermGoal` client->server request. | |
| Returns the expected type at the specified position, pretty-printed as a string. -/ | |
| structure PlainTermGoalParams extends TextDocumentPositionParams | |
| deriving FromJson, ToJson | |
| /-- `$/lean/plainTermGoal` client<-server reply. -/ | |
| structure PlainTermGoal where | |
| goal : String | |
| range : Range | |
| deriving FromJson, ToJson | |
| structure ModuleHierarchyOptions where | |
| deriving FromJson, ToJson | |
| structure HighlightMatchesOptions where | |
| deriving FromJson, ToJson | |
| structure RpcOptions where | |
| highlightMatchesProvider? : Option HighlightMatchesOptions := none | |
| deriving FromJson, ToJson | |
| structure LeanModule where | |
| name : String | |
| uri : DocumentUri | |
| data? : Option Json := none | |
| deriving FromJson, ToJson | |
| /-- | |
| `$/lean/prepareModuleHierarchy` client->server request. | |
| Response type: `Option LeanModule` | |
| -/ | |
| structure LeanPrepareModuleHierarchyParams where | |
| textDocument : TextDocumentIdentifier | |
| deriving FromJson, ToJson | |
| inductive LeanImportMetaKind where | |
| /-- `meta` flag was not set on this import. -/ | |
| | nonMeta | |
| /-- `meta` flag was set on this import. -/ | |
| | «meta» | |
| /-- This import is imported twice; once with `meta`, once without. -/ | |
| | full | |
| deriving Inhabited, FromJson, ToJson | |
| structure LeanImportKind where | |
| isPrivate : Bool | |
| isAll : Bool | |
| metaKind : LeanImportMetaKind | |
| deriving FromJson, ToJson | |
| structure LeanImport where | |
| module : LeanModule | |
| kind : LeanImportKind | |
| deriving FromJson, ToJson | |
| /-- | |
| `$/lean/moduleHierarchy/imports` client->server request. | |
| Response type: `Array LeanImport` | |
| -/ | |
| structure LeanModuleHierarchyImportsParams where | |
| module : LeanModule | |
| deriving FromJson, ToJson | |
| /-- | |
| `$/lean/moduleHierarchy/importedBy` client->server request. | |
| Response type: `Array LeanImport` | |
| -/ | |
| structure LeanModuleHierarchyImportedByParams where | |
| module : LeanModule | |
| deriving FromJson, ToJson | |
| /-- `$/lean/rpc/connect` client->server request. | |
| Starts an RPC session at the given file's worker, replying with the new session ID. | |
| Multiple sessions may be started and operating concurrently. | |
| A session may be destroyed by the server at any time (e.g. due to a crash), in which case further | |
| RPC requests for that session will reply with `RpcNeedsReconnect` errors. The client should discard | |
| references held from that session and `connect` again. -/ | |
| structure RpcConnectParams where | |
| uri : DocumentUri | |
| deriving FromJson, ToJson | |
| /-- `$/lean/rpc/connect` client<-server reply. | |
| Indicates that an RPC connection had been made and a session started for it. -/ | |
| structure RpcConnected where | |
| sessionId : UInt64 | |
| deriving FromJson, ToJson | |
| /-- `$/lean/rpc/call` client->server request. | |
| A request to execute a procedure bound for RPC. If an incorrect session ID is present, the server | |
| errors with `RpcNeedsReconnect`. | |
| Extending TDPP is weird. But in Lean, symbols exist in the context of a position within a source | |
| file. So we need this to refer to code in the environment at that position. -/ | |
| structure RpcCallParams extends TextDocumentPositionParams where | |
| sessionId : UInt64 | |
| /-- Procedure to invoke. Must be fully qualified. -/ | |
| method : Name | |
| params : Json | |
| deriving FromJson, ToJson | |
| /-- `$/lean/rpc/release` client->server notification. | |
| A notification to release remote references. Should be sent by the client when it no longer needs | |
| `RpcRef`s it has previously received from the server. Not doing so is safe but will leak memory. -/ | |
| structure RpcReleaseParams where | |
| uri : DocumentUri | |
| sessionId : UInt64 | |
| refs : Array RpcRef | |
| deriving FromJson, ToJson | |
| /-- `$/lean/rpc/keepAlive` client->server notification. | |
| The client must send an RPC notification every 10s in order to keep the RPC session alive. | |
| This is the simplest one. On not seeing any notifications for three 10s periods, the server | |
| will drop the RPC session and its associated references. -/ | |
| structure RpcKeepAliveParams where | |
| uri : DocumentUri | |
| sessionId : UInt64 | |
| deriving FromJson, ToJson | |
| /-- | |
| Range of lines in a document, including `start` but excluding `end`. | |
| -/ | |
| structure LineRange where | |
| start : Nat | |
| «end» : Nat | |
| deriving Inhabited, Repr, FromJson, ToJson | |
| end Lean.Lsp |