Safe Haskell	None
Language	Haskell2010

Language.LSP.VFS

Contents

Managing the VFS
manipulating the file contents
for tests

Description

Handles the Language.LSP.Types.TextDocumentDidChange / Language.LSP.Types.TextDocumentDidOpen / Language.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.

Synopsis

data VFS = VFS {
- vfsMap :: !(Map NormalizedUri VirtualFile)
- vfsTempDir :: !FilePath
}
data VirtualFile = VirtualFile {
- _lsp_version :: !Int32
- _file_version :: !Int
- _text :: !Rope
}
virtualFileText :: VirtualFile -> Text
virtualFileVersion :: VirtualFile -> Int32
initVFS :: (VFS -> IO r) -> IO r
openVFS :: VFS -> Message 'TextDocumentDidOpen -> (VFS, [String])
changeFromClientVFS :: VFS -> Message 'TextDocumentDidChange -> (VFS, [String])
changeFromServerVFS :: VFS -> Message 'WorkspaceApplyEdit -> IO VFS
persistFileVFS :: VFS -> NormalizedUri -> Maybe (FilePath, IO ())
closeVFS :: VFS -> Message 'TextDocumentDidClose -> (VFS, [String])
updateVFS :: (VFSMap -> VFSMap) -> VFS -> VFS
rangeLinesFromVfs :: VirtualFile -> Range -> Text
data PosPrefixInfo = PosPrefixInfo {
- fullLine :: !Text
- prefixModule :: !Text
- prefixText :: !Text
- cursorPos :: !Position
}
getCompletionPrefix :: Monad m => Position -> VirtualFile -> m (Maybe PosPrefixInfo)
applyChanges :: Rope -> [TextDocumentContentChangeEvent] -> Rope
applyChange :: Rope -> TextDocumentContentChangeEvent -> Rope
changeChars :: Rope -> Int -> Int -> Text -> Rope

Documentation

data VFS Source #

Constructors

VFS
Fields vfsMap :: !(Map NormalizedUri VirtualFile) vfsTempDir :: !FilePath This is where all the temporary files will be written to

Instances

Instances details

Show VFS Source #
Instance details Defined in Language.LSP.VFS Methods showsPrec :: Int -> VFS -> ShowS # show :: VFS -> String # showList :: [VFS] -> ShowS #

data VirtualFile Source #

Constructors

VirtualFile
Fields _lsp_version :: !Int32 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

Instances details

Show VirtualFile Source #
Instance details Defined in Language.LSP.VFS Methods showsPrec :: Int -> VirtualFile -> ShowS # show :: VirtualFile -> String # showList :: [VirtualFile] -> ShowS #

virtualFileText :: VirtualFile -> Text Source #

virtualFileVersion :: VirtualFile -> Int32 Source #

Managing the VFS

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

openVFS :: VFS -> Message 'TextDocumentDidOpen -> (VFS, [String]) Source #

Applies a DidChangeTextDocumentNotification to the VFS

Applies the changes from a DidOpenTextDocument to the VFS

changeFromClientVFS :: VFS -> Message 'TextDocumentDidChange -> (VFS, [String]) Source #

changeFromServerVFS :: VFS -> Message 'WorkspaceApplyEdit -> IO VFS Source #

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

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

closeVFS :: VFS -> Message 'TextDocumentDidClose -> (VFS, [String]) Source #

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

manipulating the file contents

rangeLinesFromVfs :: VirtualFile -> Range -> Text Source #

data PosPrefixInfo Source #

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

Instances details

Eq PosPrefixInfo Source #
Instance details Defined in Language.LSP.VFS Methods (==) :: PosPrefixInfo -> PosPrefixInfo -> Bool # (/=) :: PosPrefixInfo -> PosPrefixInfo -> Bool #
Show PosPrefixInfo Source #
Instance details Defined in Language.LSP.VFS Methods showsPrec :: Int -> PosPrefixInfo -> ShowS # show :: PosPrefixInfo -> String # showList :: [PosPrefixInfo] -> ShowS #

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

for tests

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

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

applyChange :: Rope -> TextDocumentContentChangeEvent -> Rope Source #

changeChars :: Rope -> Int -> Int -> Text -> Rope Source #