Language.Haskell.LSP.Core

Documentation

handleMessage :: Show config => InitializeCallbacks config -> TVar (LanguageContextData config) -> ByteString -> IO ()

data LanguageContextData config

state used by the LSP dispatcher to manage the message loop

Constructors

LanguageContextData

Fields

• resSeqDebugContextData :: !Int
• resHandlers :: !Handlers
• resOptions :: !Options
• resSendResponse :: !SendFunc
• resVFS :: !VFS
• reverseMap :: !(Map FilePath FilePath)
• resDiagnostics :: !DiagnosticStore
• resConfig :: !(Maybe config)
• resLspId :: !(TVar Int)
• resLspFuncs :: LspFuncs config
• resCaptureFile :: !(Maybe FilePath)
• resWorkspaceFolders :: ![WorkspaceFolder]
• resProgressData :: !ProgressData

type Handler b = b -> IO ()

The Handler type captures a function that receives local read-only state a, a function to send a reply message once encoded as a ByteString, and a received message of type b

data InitializeCallbacks config

Contains all the callbacks to use for initialized the language server. it is parameterized over a config type variable representing the type for the specific configuration data the language server needs to use.

Constructors

InitializeCallbacks

Fields

• onInitialConfiguration :: InitializeRequest -> Either Text config

  Invoked on the first message from the language client, containg the client configuration This callback should return either the parsed configuration data or an error indicating what went wrong. The parsed configuration object will be stored internally and passed to hanlder functions as context.

• onConfigurationChange :: DidChangeConfigurationNotification -> Either Text config

  Invoked whenever the clients sends a message with a changed client configuration. This callback should return either the parsed configuration data or an error indicating what went wrong. The parsed configuration object will be stored internally and passed to hanlder functions as context.

• onStartup :: LspFuncs config -> IO (Maybe ResponseError)

  Once the initial configuration has been received, this callback will be invoked to offer the language server implementation the chance to create any processes or start new threads that may be necesary for the server lifecycle.

data LspFuncs c

Returned to the server on startup, providing ways to interact with the client.

Constructors

LspFuncs

Fields

• clientCapabilities :: !ClientCapabilities
• config :: !(IO (Maybe c))

  Derived from the DidChangeConfigurationNotification message via a server-provided function.

• sendFunc :: !SendFunc
• getVirtualFileFunc :: !(NormalizedUri -> IO (Maybe VirtualFile))
• persistVirtualFileFunc :: !(NormalizedUri -> IO FilePath)
• reverseFileMapFunc :: !(IO (FilePath -> FilePath))
• publishDiagnosticsFunc :: !PublishDiagnosticsFunc
• flushDiagnosticsBySourceFunc :: !FlushDiagnosticsBySourceFunc
• getNextReqId :: !(IO LspId)
• rootPath :: !(Maybe FilePath)
• getWorkspaceFolders :: !(IO (Maybe [WorkspaceFolder]))
• withProgress :: !(forall a. Text -> ProgressCancellable -> ((Progress -> IO ()) -> IO a) -> IO a)

  Wrapper for reporting progress to the client during a long running task. withProgress title cancellable f starts a new progress reporting session, and finishes it once f is completed. f is provided with an update function that allows it to report on the progress during the session. If cancellable is Cancellable, f will be thrown a ProgressCancelledException if the user cancels the action in progress.

  Since: 0.10.0.0

• withIndefiniteProgress :: !(forall a. Text -> ProgressCancellable -> IO a -> IO a)

  Same as withProgress, but for processes that do not report the precentage complete.

  Since: 0.10.0.0

data Progress

A package indicating the perecentage of progress complete and a an optional message to go with it during a withProgress

Since: 0.10.0.0

Constructors

Progress (Maybe Double) (Maybe Text)

data ProgressCancellable

Whether or not the user should be able to cancel a 'withProgress'/'withIndefiniteProgress' session

Since: 0.11.0.0

Constructors

Cancellable

NotCancellable

data ProgressCancelledException

Thrown if the user cancels a Cancellable 'withProgress'/'withIndefiniteProgress'/ session

Since: 0.11.0.0

Instances

Show ProgressCancelledException

Defined in Language.Haskell.LSP.Core

Methods

showsPrec :: Int -> ProgressCancelledException -> ShowS

show :: ProgressCancelledException -> String

showList :: [ProgressCancelledException] -> ShowS

Exception ProgressCancelledException

Defined in Language.Haskell.LSP.Core

Methods

toException :: ProgressCancelledException -> SomeException

fromException :: SomeException -> Maybe ProgressCancelledException

displayException :: ProgressCancelledException -> String

type SendFunc = FromServerMessage -> IO ()

A function to send a message to the client

data Handlers

Callbacks from the language server to the language handler

Constructors

Handlers

Fields

• hoverHandler :: !(Maybe (Handler HoverRequest))
• completionHandler :: !(Maybe (Handler CompletionRequest))
• completionResolveHandler :: !(Maybe (Handler CompletionItemResolveRequest))
• signatureHelpHandler :: !(Maybe (Handler SignatureHelpRequest))
• definitionHandler :: !(Maybe (Handler DefinitionRequest))
• typeDefinitionHandler :: !(Maybe (Handler TypeDefinitionRequest))
• implementationHandler :: !(Maybe (Handler ImplementationRequest))
• referencesHandler :: !(Maybe (Handler ReferencesRequest))
• documentHighlightHandler :: !(Maybe (Handler DocumentHighlightRequest))
• documentSymbolHandler :: !(Maybe (Handler DocumentSymbolRequest))
• workspaceSymbolHandler :: !(Maybe (Handler WorkspaceSymbolRequest))
• codeActionHandler :: !(Maybe (Handler CodeActionRequest))
• codeLensHandler :: !(Maybe (Handler CodeLensRequest))
• codeLensResolveHandler :: !(Maybe (Handler CodeLensResolveRequest))
• documentColorHandler :: !(Maybe (Handler DocumentColorRequest))
• colorPresentationHandler :: !(Maybe (Handler ColorPresentationRequest))
• documentFormattingHandler :: !(Maybe (Handler DocumentFormattingRequest))
• documentRangeFormattingHandler :: !(Maybe (Handler DocumentRangeFormattingRequest))
• documentTypeFormattingHandler :: !(Maybe (Handler DocumentOnTypeFormattingRequest))
• renameHandler :: !(Maybe (Handler RenameRequest))
• foldingRangeHandler :: !(Maybe (Handler FoldingRangeRequest))
• documentLinkHandler :: !(Maybe (Handler DocumentLinkRequest))
• documentLinkResolveHandler :: !(Maybe (Handler DocumentLinkResolveRequest))
• executeCommandHandler :: !(Maybe (Handler ExecuteCommandRequest))
• willSaveWaitUntilTextDocHandler :: !(Maybe (Handler WillSaveWaitUntilTextDocumentRequest))
• didChangeConfigurationParamsHandler :: !(Maybe (Handler DidChangeConfigurationNotification))
• didOpenTextDocumentNotificationHandler :: !(Maybe (Handler DidOpenTextDocumentNotification))
• didChangeTextDocumentNotificationHandler :: !(Maybe (Handler DidChangeTextDocumentNotification))

  Note: If you need to keep track of document changes, Language.Haskell.LSP.VFS will take care of these messages for you!

• didCloseTextDocumentNotificationHandler :: !(Maybe (Handler DidCloseTextDocumentNotification))
• didSaveTextDocumentNotificationHandler :: !(Maybe (Handler DidSaveTextDocumentNotification))
• didChangeWatchedFilesNotificationHandler :: !(Maybe (Handler DidChangeWatchedFilesNotification))
• didChangeWorkspaceFoldersNotificationHandler :: !(Maybe (Handler DidChangeWorkspaceFoldersNotification))
• initializedHandler :: !(Maybe (Handler InitializedNotification))
• willSaveTextDocumentNotificationHandler :: !(Maybe (Handler WillSaveTextDocumentNotification))
• cancelNotificationHandler :: !(Maybe (Handler CancelNotification))
• responseHandler :: !(Maybe (Handler BareResponseMessage))
• initializeRequestHandler :: !(Maybe (Handler InitializeRequest))
• exitNotificationHandler :: !(Maybe (Handler ExitNotification))
• customRequestHandler :: !(Maybe (Handler CustomClientRequest))
• customNotificationHandler :: !(Maybe (Handler CustomClientNotification))

Instances

Default Handlers

Defined in Language.Haskell.LSP.Core

Methods

def :: Handlers

data Options

Language Server Protocol options supported by the given language server. These are automatically turned into capabilities reported to the client during initialization.

Constructors

Options

Fields

• textDocumentSync :: Maybe TextDocumentSyncOptions
• completionProvider :: Maybe CompletionOptions
• signatureHelpProvider :: Maybe SignatureHelpOptions
• typeDefinitionProvider :: Maybe GotoOptions
• implementationProvider :: Maybe GotoOptions
• codeLensProvider :: Maybe CodeLensOptions
• documentOnTypeFormattingProvider :: Maybe DocumentOnTypeFormattingOptions
• documentLinkProvider :: Maybe DocumentLinkOptions
• colorProvider :: Maybe ColorOptions
• foldingRangeProvider :: Maybe FoldingRangeOptions
• executeCommandProvider :: Maybe ExecuteCommandOptions

Instances

Default Options

Defined in Language.Haskell.LSP.Core

Methods

def :: Options

defaultLanguageContextData :: Handlers -> Options -> LspFuncs config -> TVar Int -> SendFunc -> Maybe FilePath -> LanguageContextData config

makeResponseMessage :: RequestMessage ClientMethod req resp -> resp -> ResponseMessage resp

makeResponseError :: LspIdRsp -> ResponseError -> ResponseMessage ()

setupLogger :: Maybe FilePath -> [String] -> Priority -> IO ()

===============================================================

utility

Logger

sendErrorResponseS :: SendFunc -> LspIdRsp -> ErrorCode -> Text -> IO ()

sendErrorLogS :: SendFunc -> Text -> IO ()

sendErrorShowS :: SendFunc -> Text -> IO ()

reverseSortEdit :: WorkspaceEdit -> WorkspaceEdit

The changes in a workspace edit should be applied from the end of the file toward the start. Sort them into this order.