def Lean.FileMap.rangeContainsHoverPos (text : FileMap) (r : String.Range) (hoverPos : String.Pos) (includeStop : Bool := false) : Bool

Checks whether r contains hoverPos, taking into account EOF according to text.

Equations

• text.rangeContainsHoverPos r hoverPos includeStop = r.contains hoverPos (includeStop || r.stop == text.source.endPos)

inductive Lean.Language.SnapshotTree.foldSnaps.Control : Type

• done : Control
• proceed (foldChildren : Bool) : Control

def Lean.Language.SnapshotTree.foldSnaps {α : Type u_1} (tree : SnapshotTree) (init : α) (f : SnapshotTask SnapshotTree → α → Server.ServerTask (α × foldSnaps.Control)) : Server.ServerTask α

Equations

• tree.foldSnaps init f = Lean.Server.ServerTask.mapCheap (fun (x : α × Bool) => x.fst) (Lean.Language.SnapshotTree.foldSnaps.traverseTree f init tree)

partial def Lean.Language.SnapshotTree.foldSnaps.traverseTree {α : Type u_1} (f : SnapshotTask SnapshotTree → α → Server.ServerTask (α × Control)) (acc : α) (tree : SnapshotTree) : Server.ServerTask (α × Bool)

partial def Lean.Language.SnapshotTree.foldSnaps.traverseChildren {α : Type u_1} (f : SnapshotTask SnapshotTree → α → Server.ServerTask (α × Control)) (acc : α) : List (SnapshotTask SnapshotTree) → Server.ServerTask (α × Bool)

def Lean.Language.SnapshotTree.findInfoTreeAtPos (text : FileMap) (tree : SnapshotTree) (hoverPos : String.Pos) (includeStop : Bool) : Server.ServerTask (Option Elab.InfoTree)

Finds the first (in pre-order) snapshot task in tree that contains hoverPos (including whitespace) and which contains an info tree, and then returns that info tree, waiting for any snapshot tasks on the way. Subtrees that do not contain the position are skipped without forcing their tasks. If the caller of this function needs the correct snapshot when the cursor is on whitespace, then this function is likely the wrong one to call, as it simply yields the first snapshot that contains hoverPos in its whitespace, which is not necessarily the correct one (e.g. it may be indentation-sensitive).

Equations

• One or more equations did not get rendered due to their size.

structure Lean.Server.RequestError : Type

• code : JsonRpc.ErrorCode
• message : String

instance Lean.Server.instInhabitedRequestError : Inhabited RequestError

Equations

• Lean.Server.instInhabitedRequestError = { default := { code := default, message := default } }

def Lean.Server.RequestError.fileChanged : RequestError

Equations

• Lean.Server.RequestError.fileChanged = { code := Lean.JsonRpc.ErrorCode.contentModified, message := "File changed." }

def Lean.Server.RequestError.methodNotFound (method : String) : RequestError

Equations

• Lean.Server.RequestError.methodNotFound method = { code := Lean.JsonRpc.ErrorCode.methodNotFound, message := toString "No request handler found for '" ++ toString method ++ toString "'" }

def Lean.Server.RequestError.invalidParams (message : String) : RequestError

Equations

• Lean.Server.RequestError.invalidParams message = { code := Lean.JsonRpc.ErrorCode.invalidParams, message := message }

def Lean.Server.RequestError.internalError (message : String) : RequestError

Equations

• Lean.Server.RequestError.internalError message = { code := Lean.JsonRpc.ErrorCode.internalError, message := message }

def Lean.Server.RequestError.requestCancelled : RequestError

Equations

• Lean.Server.RequestError.requestCancelled = { code := Lean.JsonRpc.ErrorCode.requestCancelled, message := "" }

def Lean.Server.RequestError.ofException (e : Exception) : IO RequestError

Equations

• Lean.Server.RequestError.ofException e = do let __do_lift ← liftM e.toMessageData.toString pure (Lean.Server.RequestError.internalError __do_lift)

def Lean.Server.RequestError.ofIoError (e : IO.Error) : RequestError

Equations

• Lean.Server.RequestError.ofIoError e = Lean.Server.RequestError.internalError (toString e)

def Lean.Server.RequestError.toLspResponseError (id : JsonRpc.RequestID) (e : RequestError) : JsonRpc.ResponseError Unit

Equations

• Lean.Server.RequestError.toLspResponseError id e = { id := id, code := e.code, message := e.message, data? := none }

def Lean.Server.parseRequestParams (paramType : Type) [FromJson paramType] (params : Json) : Except RequestError paramType

Equations

• One or more equations did not get rendered due to their size.

structure Lean.Server.RequestContext : Type

• rpcSessions : RBMap UInt64 (IO.Ref FileWorker.RpcSession) compare
• srcSearchPathTask : ServerTask SearchPath
• doc : FileWorker.EditableDocument
• hLog : IO.FS.Stream
• initParams : Lsp.InitializeParams
• cancelTk : RequestCancellationToken

def Lean.Server.RequestContext.srcSearchPath (rc : RequestContext) : SearchPath

Equations

• rc.srcSearchPath = rc.srcSearchPathTask.get

@[reducible, inline]

abbrev Lean.Server.RequestTask (α : Type u_1) : Type u_1

Equations

• Lean.Server.RequestTask α = Lean.Server.ServerTask (Except Lean.Server.RequestError α)

@[reducible, inline]

abbrev Lean.Server.RequestT (m : Type → Type u_1) (α : Type) : Type u_1

Equations

• Lean.Server.RequestT m = ReaderT Lean.Server.RequestContext (ExceptT Lean.Server.RequestError m)

@[reducible, inline]

abbrev Lean.Server.RequestM (α : Type) : Type

Workers execute request handlers in this monad.

Equations

• Lean.Server.RequestM = ReaderT Lean.Server.RequestContext (EIO Lean.Server.RequestError)

@[reducible, inline]

abbrev Lean.Server.RequestTask.pure {α : Type u_1} (a : α) : RequestTask α

Equations

• Lean.Server.RequestTask.pure a = Lean.Server.ServerTask.pure (Except.ok a)

instance Lean.Server.instMonadLiftIORequestM : MonadLift IO RequestM

Equations

• One or more equations did not get rendered due to their size.

instance Lean.Server.instMonadLiftEIOExceptionRequestM : MonadLift (EIO Exception) RequestM

Equations

• One or more equations did not get rendered due to their size.

instance Lean.Server.instMonadLiftCancellableMRequestM : MonadLift CancellableM RequestM

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.runInIO {α : Type} (x : RequestM α) (ctx : RequestContext) : IO α

Equations

• x.runInIO ctx = EStateM.adaptExcept (fun (x : Lean.Server.RequestError) => IO.userError x.message) (ReaderT.run x ctx)

def Lean.Server.RequestM.readDoc {m : Type → Type u_1} [Monad m] [MonadReaderOf RequestContext m] : m FileWorker.EditableDocument

Equations

• Lean.Server.RequestM.readDoc = do let rc ← readThe Lean.Server.RequestContext pure rc.doc

def Lean.Server.RequestM.asTask {α : Type} (t : RequestM α) : RequestM (RequestTask α)

Equations

• t.asTask = do let rc ← readThe Lean.Server.RequestContext liftM (Lean.Server.ServerTask.EIO.asTask (ReaderT.run t rc))

def Lean.Server.RequestM.pureTask {α : Type} (t : RequestM α) : RequestM (RequestTask α)

Equations

• t.pureTask = do let r ← ReaderT.run t pure (Lean.Server.ServerTask.pure (Except.ok r))

def Lean.Server.RequestM.mapTaskCheap {α : Type u_1} {β : Type} (t : ServerTask α) (f : α → RequestM β) : RequestM (RequestTask β)

Equations

• Lean.Server.RequestM.mapTaskCheap t f = do let rc ← readThe Lean.Server.RequestContext liftM (Lean.Server.ServerTask.EIO.mapTaskCheap (fun (x : α) => f x rc) t)

def Lean.Server.RequestM.mapTaskCostly {α : Type u_1} {β : Type} (t : ServerTask α) (f : α → RequestM β) : RequestM (RequestTask β)

Equations

• Lean.Server.RequestM.mapTaskCostly t f = do let rc ← readThe Lean.Server.RequestContext liftM (Lean.Server.ServerTask.EIO.mapTaskCostly (fun (x : α) => f x rc) t)

def Lean.Server.RequestM.bindTaskCheap {α : Type u_1} {β : Type} (t : ServerTask α) (f : α → RequestM (RequestTask β)) : RequestM (RequestTask β)

Equations

• Lean.Server.RequestM.bindTaskCheap t f = do let rc ← readThe Lean.Server.RequestContext liftM (Lean.Server.ServerTask.EIO.bindTaskCheap t fun (x : α) => f x rc)

def Lean.Server.RequestM.bindTaskCostly {α : Type u_1} {β : Type} (t : ServerTask α) (f : α → RequestM (RequestTask β)) : RequestM (RequestTask β)

Equations

• Lean.Server.RequestM.bindTaskCostly t f = do let rc ← readThe Lean.Server.RequestContext liftM (Lean.Server.ServerTask.EIO.bindTaskCostly t fun (x : α) => f x rc)

def Lean.Server.RequestM.checkCancelled : RequestM Unit

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.waitFindSnapAux {α : Type} (notFoundX : RequestM α) (x : Snapshots.Snapshot → RequestM α) : Except IO.Error (Option Snapshots.Snapshot) → RequestM α

Equations

• notFoundX.waitFindSnapAux x (Except.error e) = throw (Lean.Server.RequestError.ofIoError e)
• notFoundX.waitFindSnapAux x (Except.ok none) = notFoundX
• notFoundX.waitFindSnapAux x (Except.ok (some snap)) = x snap

def Lean.Server.RequestM.withWaitFindSnap {β : Type} (doc : FileWorker.EditableDocument) (p : Snapshots.Snapshot → Bool) (notFoundX : RequestM β) (x : Snapshots.Snapshot → RequestM β) : RequestM (RequestTask β)

Create a task which waits for the first snapshot matching p, handles various errors, and if a matching snapshot was found executes x with it. If not found, the task executes notFoundX.

Equations

• Lean.Server.RequestM.withWaitFindSnap doc p notFoundX x = Lean.Server.RequestM.mapTaskCostly (IO.AsyncList.waitFind? p doc.cmdSnaps) (notFoundX.waitFindSnapAux x)

def Lean.Server.RequestM.bindWaitFindSnap {β : Type} (doc : FileWorker.EditableDocument) (p : Snapshots.Snapshot → Bool) (notFoundX : RequestM (RequestTask β)) (x : Snapshots.Snapshot → RequestM (RequestTask β)) : RequestM (RequestTask β)

See withWaitFindSnap.

Equations

• Lean.Server.RequestM.bindWaitFindSnap doc p notFoundX x = Lean.Server.RequestM.bindTaskCostly (IO.AsyncList.waitFind? p doc.cmdSnaps) (notFoundX.waitFindSnapAux x)

def Lean.Server.RequestM.withWaitFindSnapAtPos {α : Type} (lspPos : Lsp.Position) (f : Snapshots.Snapshot → RequestM α) : RequestM (RequestTask α)

Create a task which waits for the snapshot containing lspPos and executes f with it. If no such snapshot exists, the request fails with an error.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.findCmdParsedSnap (doc : FileWorker.EditableDocument) (hoverPos : String.Pos) : ServerTask (Option Language.Lean.CommandParsedSnapshot)

Finds the first CommandParsedSnapshot containing hoverPos, asynchronously.

Equations

• One or more equations did not get rendered due to their size.

partial def Lean.Server.RequestM.findCmdParsedSnap.go (doc : FileWorker.EditableDocument) (hoverPos : String.Pos) (cmdParsed : Language.Lean.CommandParsedSnapshot) : ServerTask (Option Language.Lean.CommandParsedSnapshot)

def Lean.Server.RequestM.findCmdParsedSnap.containsHoverPos (doc : FileWorker.EditableDocument) (hoverPos : String.Pos) (cmdParsed : Language.Lean.CommandParsedSnapshot) : Bool

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.findCmdParsedSnap.isAfterHoverPos (hoverPos : String.Pos) (cmdParsed : Language.Lean.CommandParsedSnapshot) : Bool

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.findCmdDataAtPos (doc : FileWorker.EditableDocument) (hoverPos : String.Pos) (includeStop : Bool) : ServerTask (Option (Syntax × Elab.InfoTree))

Finds the command syntax and info tree of the first snapshot task containing pos, asynchronously. The info tree may be from a nested snapshot, such as a single tactic.

See SnapshotTree.findInfoTreeAtPos for details on how the search is done.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.findInfoTreeAtPos (doc : FileWorker.EditableDocument) (hoverPos : String.Pos) (includeStop : Bool) : ServerTask (Option Elab.InfoTree)

Finds the info tree of the first snapshot task containing pos, asynchronously. The info tree may be from a nested snapshot, such as a single tactic.

See SnapshotTree.findInfoTreeAtPos for details on how the search is done.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.runCommandElabM {α : Type} (snap : Snapshots.Snapshot) (c : RequestT Elab.Command.CommandElabM α) : RequestM α

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.runCoreM {α : Type} (snap : Snapshots.Snapshot) (c : RequestT CoreM α) : RequestM α

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.RequestM.runTermElabM {α : Type} (snap : Snapshots.Snapshot) (c : RequestT Elab.TermElabM α) : RequestM α

Equations

• One or more equations did not get rendered due to their size.

The global request handlers table

We maintain a global map of LSP request handlers. This allows user code such as plugins to register its own handlers, for example to support ITP functionality such as goal state visualization.

For details of how to register one, see registerLspRequestHandler.

structure Lean.Server.RequestHandler : Type

• fileSource : Json → Except RequestError Lsp.DocumentUri
• handle : Json → RequestM (RequestTask Json)

opaque Lean.Server.requestHandlers : IO.Ref (PersistentHashMap String RequestHandler)

def Lean.Server.registerLspRequestHandler (method : String) (paramType : Type) [FromJson paramType] [Lsp.FileSource paramType] (respType : Type) [ToJson respType] (handler : paramType → RequestM (RequestTask respType)) : IO Unit

NB: This method may only be called in initialize blocks (user or builtin).

A registration consists of:

• a type of JSON-parsable request data paramType
• a FileSource instance for it so the system knows where to route requests
• a type of JSON-serializable response data respType
• an actual handler which runs in the RequestM monad and is expected to produce an asynchronous RequestTask which does any waiting/computation

A handler task may be cancelled at any time, so it should check the cancellation token when possible to handle this cooperatively. Any exceptions thrown in a request handler will be reported to the client as LSP error responses.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.lookupLspRequestHandler (method : String) : IO (Option RequestHandler)

Equations

• Lean.Server.lookupLspRequestHandler method = do let __do_lift ← ST.Ref.get Lean.Server.requestHandlers pure (__do_lift.find? method)

def Lean.Server.chainLspRequestHandler (method : String) (paramType : Type) [FromJson paramType] (respType : Type) [FromJson respType] [ToJson respType] (handler : paramType → RequestTask respType → RequestM (RequestTask respType)) : IO Unit

NB: This method may only be called in initialize blocks (user or builtin).

Register another handler to invoke after the last one registered for a method. At least one handler for the method must have already been registered to perform chaining.

For more details on the registration of a handler, see registerLspRequestHandler.

Equations

• One or more equations did not get rendered due to their size.

inductive Lean.Server.RequestHandlerCompleteness : Type

• complete : RequestHandlerCompleteness
• partial (refreshMethod : String) (refreshIntervalMs : Nat) : RequestHandlerCompleteness

  A request handler is partial if the LSP spec states that the request method implemented by the handler should be responded to with the full state of the document, but our implementation of the handler only returns a partial result for the document (e.g. only for the processed regions of the document, to reduce latency after a didChange). A request handler can only be partial if LSP also specifies a corresponding refresh server-to-client request, e.g. workspace/inlayHint/refresh for textDocument/inlayHint. This is necessary because we use the refresh request to prompt the client to re-request the data for a partial request if we returned a partial response for that request in the past, so that the client eventually converges to a complete set of information for the full document.

structure Lean.Server.LspResponse (α : Type) : Type

• response : α
• isComplete : Bool

structure Lean.Server.StatefulRequestHandler : Type

• fileSource : Json → Except RequestError Lsp.DocumentUri
• pureHandle : Json → Dynamic → RequestM (LspResponse Json × Dynamic)

  handle with explicit state management for chaining request handlers. This function is pure w.r.t. lastTaskMutex and stateRef, but not RequestM.

• handle : Json → RequestM (RequestTask (LspResponse Json))
• pureOnDidChange : Lsp.DidChangeTextDocumentParams → StateT Dynamic RequestM Unit

  onDidChange with explicit state management for chaining request handlers. This function is pure w.r.t. lastTaskMutex and stateRef, but not RequestM.

• onDidChange : Lsp.DidChangeTextDocumentParams → RequestM Unit
• lastTaskMutex : Std.Mutex (ServerTask Unit)
• initState : Dynamic
• stateRef : IO.Ref Dynamic

  stateRef is synchronized in registerStatefulLspRequestHandler by using lastTaskMutex to ensure that stateful request tasks for the same handler are executed sequentially (in order of arrival).

• completeness : RequestHandlerCompleteness

opaque Lean.Server.statefulRequestHandlers : IO.Ref (PersistentHashMap String StatefulRequestHandler)

def Lean.Server.registerCompleteStatefulLspRequestHandler (method : String) (paramType : Type) [FromJson paramType] [Lsp.FileSource paramType] (respType : Type) [ToJson respType] (stateType : Type) [TypeName stateType] (initState : stateType) (handler : paramType → stateType → RequestM (respType × stateType)) (onDidChange : Lsp.DidChangeTextDocumentParams → StateT stateType RequestM Unit) : IO Unit

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.registerPartialStatefulLspRequestHandler (method refreshMethod : String) (refreshIntervalMs : Nat) (paramType : Type) [FromJson paramType] [Lsp.FileSource paramType] (respType : Type) [ToJson respType] (stateType : Type) [TypeName stateType] (initState : stateType) (handler : paramType → stateType → RequestM (LspResponse respType × stateType)) (onDidChange : Lsp.DidChangeTextDocumentParams → StateT stateType RequestM Unit) : IO Unit

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.isStatefulLspRequestMethod (method : String) : BaseIO Bool

Equations

• Lean.Server.isStatefulLspRequestMethod method = do let __do_lift ← ST.Ref.get Lean.Server.statefulRequestHandlers pure (__do_lift.contains method)

def Lean.Server.lookupStatefulLspRequestHandler (method : String) : BaseIO (Option StatefulRequestHandler)

Equations

• Lean.Server.lookupStatefulLspRequestHandler method = do let __do_lift ← ST.Ref.get Lean.Server.statefulRequestHandlers pure (__do_lift.find? method)

def Lean.Server.partialLspRequestHandlerMethods : IO (Array (String × String × Nat))

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.chainStatefulLspRequestHandler (method : String) (paramType : Type) [FromJson paramType] [ToJson paramType] [Lsp.FileSource paramType] (respType : Type) [FromJson respType] [ToJson respType] (stateType : Type) [TypeName stateType] (handler : paramType → LspResponse respType → stateType → RequestM (LspResponse respType × stateType)) (onDidChange : Lsp.DidChangeTextDocumentParams → StateT stateType RequestM Unit) : IO Unit

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.handleOnDidChange (p : Lsp.DidChangeTextDocumentParams) : RequestM Unit

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.handleLspRequest (method : String) (params : Json) : RequestM (RequestTask (LspResponse Json))

Equations

• One or more equations did not get rendered due to their size.

def Lean.Server.routeLspRequest (method : String) (params : Json) : IO (Except RequestError Lsp.DocumentUri)

Equations

• One or more equations did not get rendered due to their size.