Language.LSP.Client.Session

Documentation

data SessionState

Constructors

SessionState

Fields

• pendingRequests :: TVar RequestMap

  Response callbacks for sent requests waiting for a response. Once a response arrives the request is removed from this map.

• notificationHandlers :: TVar NotificationMap

  Notification callbacks that fire whenever a notification of their type is received.

• lastRequestId :: TVar Int32

  A counter to send each request to the server is sent with a unique ID, allowing us to pair it back with its response.

• serverCapabilities :: TVar (HashMap Text SomeRegistration)

  The capabilities that the server has dynamically registered with us so far.

• clientCapabilities :: ClientCapabilities

  The client capabilities advertised to the server. Not a TVar because it does not change during the session.

• progressTokens :: TVar (HashSet ProgressToken)

  Progress messages received from the server.

• outgoing :: TQueue FromClientMessage

  Messages that have been serialised but not yet written to the output handle.

• vfs :: TVar VFS

  Virtual, in-memory file system of the files known to the LSP.

• rootDir :: FilePath

  The root of the project as sent to the server. Document URIs are relative to it. Not a TVar because it does not change during the session.

Instances

MonadIO m => MonadSession (SessionT m)

Defined in Language.LSP.Client.Session

Methods

liftSession :: Session a -> SessionT m a

defaultSessionState :: MonadIO io => VFS -> io SessionState

type SessionT = ReaderT SessionState

A session representing one instance of launching and connecting to a server. It is essentially an STM-backed StateT: despite it being ReaderT, it can still mutate TVar values.

type Session = SessionT IO

class Monad m => MonadSession m where

Methods

liftSession :: forall a. Session a -> m a

Instances

MonadIO m => MonadSession (SessionT m)

Defined in Language.LSP.Client.Session

Methods

liftSession :: Session a -> SessionT m a

(MonadTrans t, MonadSession m, Monad (t m)) => MonadSession (t m)

Defined in Language.LSP.Client.Session

Methods

liftSession :: Session a -> t m a

documentChangeUri :: DocumentChange -> Uri

handleServerMessage :: MonadSession m => FromServerMessage -> m ()

Fires whenever the client receives a message from the server. Updates the session state as needed. Note that this does not provide any business logic beyond updating the session state; you most likely want to use sendRequest and receiveNotification to register callbacks for specific messages.

sendRequest :: forall (method :: Method 'ClientToServer 'Request) m. (TMessage method ~ TRequestMessage method, MonadSession m) => SMethod method -> MessageParams method -> (TResponseMessage method -> IO ()) -> m (LspId method)

Sends a request to the server, with a callback that fires when the response arrives. Multiple requests can be waiting at the same time.

sendResponse :: forall (method :: Method 'ServerToClient 'Request) m. MonadSession m => TRequestMessage method -> Either (TResponseError method) (MessageResult method) -> m ()

Send a response to the server. This is used internally to acknowledge server requests. Users of this library cannot register callbacks to server requests, so this function is probably of no use to them.

request :: forall (method :: Method 'ClientToServer 'Request) m. (TMessage method ~ TRequestMessage method, MonadSession m) => SMethod method -> MessageParams method -> m (TResponseMessage method)

Sends a request to the server and synchronously waits for its response.

getResponseResult :: Show (ErrorData m) => TResponseMessage m -> MessageResult m

Checks the response for errors and throws an exception if needed. Returns the result if successful.InitializeParams

sendNotification :: forall (method :: Method 'ClientToServer 'Notification) m. (TMessage method ~ TNotificationMessage method, MonadSession m) => SMethod method -> MessageParams method -> m ()

Sends a notification to the server. Updates the VFS if the notification is a document update.

receiveNotification :: forall (method :: Method 'ServerToClient 'Notification) m. (TMessage method ~ TNotificationMessage method, MonadSession m) => SMethod method -> (TMessage method -> IO ()) -> m ()

Registers a callback for notifications received from the server. If multiple callbacks are registered for the same notification method, they will all be called.

clearNotificationCallback :: forall (method :: Method 'ServerToClient 'Notification) m. MonadSession m => SMethod method -> m ()

Clears the registered callback for the given notification method, if any. If multiple callbacks have been registered, this clears all of them.

sendMessage :: MonadSession m => FromClientMessage -> m ()

Queues a message to be sent to the server at the client's earliest convenience.

lspClientInfo :: ClientInfo

initialize :: MonadSession m => Maybe Value -> m InitializeResult

Performs the initialisation handshake and synchronously waits for its completion. When the function completes, the session is initialised.

createDoc

Arguments

:: MonadSession m

=> FilePath

The path to the document to open, relative to the root directory.

-> LanguageKind

The text document's language

-> Text

The content of the text document to create.

-> m TextDocumentIdentifier

The identifier of the document just created.

Creates a new text document. This is different from openDoc as it sends a workspace/didChangeWatchedFiles notification letting the server know that a file was created within the workspace, __provided that the server has registered for it__, and the file matches any patterns the server registered for. It does not actually create a file on disk, but is useful for convincing the server that one does exist.

openDoc :: MonadSession m => FilePath -> LanguageKind -> m TextDocumentIdentifier

Opens a text document that exists on disk, and sends a textDocument/didOpen notification to the server.

openDoc' :: MonadSession m => FilePath -> LanguageKind -> Text -> m TextDocumentIdentifier

This is a variant of openDoc that takes the file content as an argument. Use this is the file exists outside of the current workspace.

closeDoc :: MonadSession m => TextDocumentIdentifier -> m ()

Closes a text document and sends a textDocument/didClose notification to the server.

changeDoc :: MonadSession m => TextDocumentIdentifier -> [TextDocumentContentChangeEvent] -> m ()

Changes a text document and sends a textDocument/didChange notification to the server.

getDocUri :: MonadSession m => FilePath -> m Uri

Gets the Uri for the file relative to the session's root directory.

documentContents :: MonadSession m => TextDocumentIdentifier -> m (Maybe Rope)

The current text contents of a document.

getVersionedDoc :: MonadSession m => TextDocumentIdentifier -> m VersionedTextDocumentIdentifier

Adds the current version to the document, as tracked by the session.

getAllVersionedDocs :: MonadSession m => m [VersionedTextDocumentIdentifier]

Get all the versioned documents tracked by the session.