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 :: !VFSData
• resDiagnostics :: !DiagnosticStore
• resConfig :: !(Maybe config)
• resLspId :: !(TVar Int)
• resLspFuncs :: LspFuncs config
• resCaptureContext :: !CaptureContext
• resWorkspaceFolders :: ![WorkspaceFolder]
• resProgressData :: !ProgressData

data VFSData

Constructors

VFSData

Fields

• vfsData :: !VFS
• reverseMap :: !(Map FilePath FilePath)

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))

  Function to return the VirtualFile associated with a given NormalizedUri, if there is one.

• persistVirtualFileFunc :: !(NormalizedUri -> IO (Maybe 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 withProgresswithIndefiniteProgress 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))
• documentOnTypeFormattingHandler :: !(Maybe (Handler DocumentOnTypeFormattingRequest))
• renameHandler :: !(Maybe (Handler RenameRequest))
• prepareRenameHandler :: !(Maybe (Handler PrepareRenameRequest))
• 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 that the server may configure. If you set handlers for some requests, you may need to set some of these options.

Constructors

Options

Fields

• textDocumentSync :: Maybe TextDocumentSyncOptions
• completionTriggerCharacters :: Maybe [Char]

  The characters that trigger completion automatically.

• completionAllCommitCharacters :: Maybe [Char]

  The list of all possible characters that commit a completion. This field can be used if clients don't support individual commmit characters per completion item. See _commitCharactersSupport.

• signatureHelpTriggerCharacters :: Maybe [Char]

  The characters that trigger signature help automatically.

• signatureHelpRetriggerCharacters :: Maybe [Char]

  List of characters that re-trigger signature help. These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.

• codeActionKinds :: Maybe [CodeActionKind]

  CodeActionKinds that this server may return. The list of kinds may be generic, such as Refactor, or the server may list out every specific kind they provide.

• documentOnTypeFormattingTriggerCharacters :: Maybe (NonEmpty Char)

  The list of characters that triggers on type formatting. If you set documentOnTypeFormattingHandler, you **must** set this. The first character is mandatory, so a NonEmpty should be passed.

• executeCommandCommands :: Maybe [Text]

  The commands to be executed on the server. If you set executeCommandHandler, you **must** set this.

Instances

Default Options

Defined in Language.Haskell.LSP.Core

Methods

def :: Options

defaultLanguageContextData :: Handlers -> Options -> LspFuncs config -> TVar Int -> SendFunc -> CaptureContext -> VFS -> LanguageContextData config

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

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

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

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.

data Priority

Priorities are used to define how important a log message is. Users can filter log messages based on priorities.

These have their roots on the traditional syslog system. The standard definitions are given below, but you are free to interpret them however you like. They are listed here in ascending importance order.

Constructors

DEBUG

Debug messages

INFO

Information

NOTICE

Normal runtime conditions

WARNING

General Warnings

ERROR

General Errors

CRITICAL

Severe situations

ALERT

Take immediate action

EMERGENCY

System is unusable

Instances

Bounded Priority

Defined in System.Log

Methods

minBound :: Priority

maxBound :: Priority

Enum Priority

Defined in System.Log

Methods

succ :: Priority -> Priority

pred :: Priority -> Priority

toEnum :: Int -> Priority

fromEnum :: Priority -> Int

enumFrom :: Priority -> [Priority]

enumFromThen :: Priority -> Priority -> [Priority]

enumFromTo :: Priority -> Priority -> [Priority]

enumFromThenTo :: Priority -> Priority -> Priority -> [Priority]

Eq Priority

Defined in System.Log

Methods

(==) :: Priority -> Priority -> Bool

(/=) :: Priority -> Priority -> Bool

Data Priority

Defined in System.Log

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Priority -> c Priority

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Priority

toConstr :: Priority -> Constr

dataTypeOf :: Priority -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Priority)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Priority)

gmapT :: (forall b. Data b => b -> b) -> Priority -> Priority

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Priority -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Priority -> r

gmapQ :: (forall d. Data d => d -> u) -> Priority -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Priority -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Priority -> m Priority

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Priority -> m Priority

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Priority -> m Priority

Ord Priority

Defined in System.Log

Methods

compare :: Priority -> Priority -> Ordering

(<) :: Priority -> Priority -> Bool

(<=) :: Priority -> Priority -> Bool

(>) :: Priority -> Priority -> Bool

(>=) :: Priority -> Priority -> Bool

max :: Priority -> Priority -> Priority

min :: Priority -> Priority -> Priority

Read Priority

Defined in System.Log

Methods

readsPrec :: Int -> ReadS Priority

readList :: ReadS [Priority]

readPrec :: ReadPrec Priority

readListPrec :: ReadPrec [Priority]

Show Priority

Defined in System.Log

Methods

showsPrec :: Int -> Priority -> ShowS

show :: Priority -> String

showList :: [Priority] -> ShowS

Generic Priority

Defined in System.Log

Associated Types

type Rep Priority :: Type -> Type

Methods

from :: Priority -> Rep Priority x

to :: Rep Priority x -> Priority

NFData Priority

Since: hslogger-1.3.1.0

Defined in System.Log

Methods

rnf :: Priority -> ()

type Rep Priority

Defined in System.Log

type Rep Priority = D1 ('MetaData "Priority" "System.Log" "hslogger-1.3.1.0-1gOGa33mZOW24lXQ2NncWL" 'False) (((C1 ('MetaCons "DEBUG" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "INFO" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NOTICE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WARNING" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ERROR" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CRITICAL" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ALERT" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EMERGENCY" 'PrefixI 'False) (U1 :: Type -> Type))))