Language.Haskell.LSP.VFS

Handles the Language.Haskell.LSP.Types.TextDocumentDidChange / Language.Haskell.LSP.Types.TextDocumentDidOpen / Language.Haskell.LSP.Types.TextDocumentDidClose messages to keep an in-memory filesystem of the current client workspace. The server can access and edit files in the client workspace by operating on the VFS in LspFuncs.

Documentation

data VFS

Constructors

VFS

Fields

• vfsMap :: Map NormalizedUri VirtualFile
• vfsTempDir :: FilePath

  This is where all the temporary files will be written to

Instances

Show VFS

Defined in Language.Haskell.LSP.VFS

Methods

showsPrec :: Int -> VFS -> ShowS

show :: VFS -> String

showList :: [VFS] -> ShowS

data VirtualFile

Constructors

VirtualFile

Fields

• _lsp_version :: !Int

  The LSP version of the document

• _file_version :: !Int

  This number is only incremented whilst the file remains in the map.

• _text :: Rope

  The full contents of the document

Instances

Show VirtualFile

Defined in Language.Haskell.LSP.VFS

Methods

showsPrec :: Int -> VirtualFile -> ShowS

show :: VirtualFile -> String

showList :: [VirtualFile] -> ShowS

virtualFileText :: VirtualFile -> Text

virtualFileVersion :: VirtualFile -> Int

Managing the VFS

initVFS :: (VFS -> IO r) -> IO r

Applies the changes from a DidOpenTextDocumentNotification to the VFS

openVFS :: VFS -> DidOpenTextDocumentNotification -> (VFS, [String])

Applies a DidChangeTextDocumentNotification to the VFS

changeFromClientVFS :: VFS -> DidChangeTextDocumentNotification -> (VFS, [String])

changeFromServerVFS :: VFS -> ApplyWorkspaceEditRequest -> IO VFS

persistFileVFS :: VFS -> NormalizedUri -> Maybe (FilePath, IO ())

Write a virtual file to a temporary file if it exists in the VFS.

closeVFS :: VFS -> DidCloseTextDocumentNotification -> (VFS, [String])

updateVFS :: (VFSMap -> VFSMap) -> VFS -> VFS

Applies the changes from a ApplyWorkspaceEditRequest to the VFS

manipulating the file contents

rangeLinesFromVfs :: VirtualFile -> Range -> Text

data PosPrefixInfo

Describes the line at the current cursor position

Constructors

PosPrefixInfo

Fields

• fullLine :: Text

  The full contents of the line the cursor is at

• prefixModule :: Text

  If any, the module name that was typed right before the cursor position. For example, if the user has typed "Data.Maybe.from", then this property will be Data.Maybe

• prefixText :: Text

  The word right before the cursor position, after removing the module part. For example if the user has typed "Data.Maybe.from", then this property will be "from"

• cursorPos :: Position

  The cursor position

Instances

Eq PosPrefixInfo

Defined in Language.Haskell.LSP.VFS

Methods

(==) :: PosPrefixInfo -> PosPrefixInfo -> Bool

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

Show PosPrefixInfo

Defined in Language.Haskell.LSP.VFS

Methods

showsPrec :: Int -> PosPrefixInfo -> ShowS

show :: PosPrefixInfo -> String

showList :: [PosPrefixInfo] -> ShowS

getCompletionPrefix :: Monad m => Position -> VirtualFile -> m (Maybe PosPrefixInfo)

for tests

applyChanges :: Rope -> [TextDocumentContentChangeEvent] -> Rope

Apply the list of changes. Changes should be applied in the order that they are received from the client.

applyChange :: Rope -> TextDocumentContentChangeEvent -> Rope

changeChars :: Rope -> Int -> Int -> Text -> Rope