(
-- * Sessions
runSession
- , runSessionWithHandler
+ , runSessionWithHandles
+ , runSessionWithConfig
, Session
+ , SessionConfig(..)
+ , MonadSessionConfig(..)
+ , SessionException(..)
+ , anySessionException
-- * Sending
, sendRequest
, sendNotification
, (<|>)
, satisfy
-- * Utilities
+ , initializeResponse
, openDoc
- , getDocItem
+ , documentContents
+ , getDocumentEdit
, getDocUri
+ , noDiagnostics
+ , getDocumentSymbols
+ , getDiagnostics
) where
import Control.Applicative
import Control.Applicative.Combinators
+import Control.Concurrent
import Control.Monad
import Control.Monad.IO.Class
-import Control.Concurrent
-import Control.Lens hiding ((.=))
+import Control.Exception
+import Control.Lens hiding ((.=), List)
import qualified Data.Text as T
import qualified Data.Text.IO as T
import Data.Aeson
import qualified Data.ByteString.Lazy.Char8 as B
import Data.Default
-import System.Process
-import Language.Haskell.LSP.Types
-import qualified Language.Haskell.LSP.Types as LSP (error, id)
+import qualified Data.HashMap.Strict as HashMap
+import qualified Data.Map as Map
+import Data.Maybe
+import Language.Haskell.LSP.Types hiding (id, capabilities)
+import qualified Language.Haskell.LSP.Types as LSP
+import Language.Haskell.LSP.VFS
import Language.Haskell.LSP.Test.Compat
+import Language.Haskell.LSP.Test.Decoding
+import Language.Haskell.LSP.Test.Exceptions
+import Language.Haskell.LSP.Test.Parsing
+import Language.Haskell.LSP.Test.Session
+import Language.Haskell.LSP.Test.Server
import System.IO
import System.Directory
import System.FilePath
-import Language.Haskell.LSP.Test.Decoding
-import Language.Haskell.LSP.Test.Parsing
+import qualified Yi.Rope as Rope
-- | Starts a new session.
-runSession :: FilePath -- ^ The filepath to the root directory for the session.
+runSession :: String -- ^ The command to run the server.
+ -> FilePath -- ^ The filepath to the root directory for the session.
+ -> Session a -- ^ The session to run.
+ -> IO a
+runSession = runSessionWithConfig def
+
+-- | Starts a new sesion with a client with the specified capabilities.
+runSessionWithConfig :: SessionConfig -- ^ The capabilities the client should have.
+ -> String -- ^ The command to run the server.
+ -> FilePath -- ^ The filepath to the root directory for the session.
-> Session a -- ^ The session to run.
- -> IO ()
-runSession rootDir session = do
- pid <- getProcessID
+ -> IO a
+runSessionWithConfig config serverExe rootDir session = do
+ pid <- getCurrentProcessID
absRootDir <- canonicalizePath rootDir
let initializeParams = InitializeParams (Just pid)
(Just $ T.pack absRootDir)
(Just $ filePathToUri absRootDir)
Nothing
- def
+ (capabilities config)
(Just TraceOff)
-
- runSessionWithHandler listenServer rootDir $ do
+ withServer serverExe (logStdErr config) $ \serverIn serverOut _ ->
+ runSessionWithHandles serverIn serverOut listenServer config rootDir $ do
-- Wrap the session around initialize and shutdown calls
sendRequest Initialize initializeParams
- initRsp <- response :: Session InitializeResponse
- liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRsp ^. LSP.error)
+ initRspMsg <- response :: Session InitializeResponse
+
+ liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRspMsg ^. LSP.error)
+
+ initRspVar <- initRsp <$> ask
+ liftIO $ putMVar initRspVar initRspMsg
sendNotification Initialized InitializedParams
-- Run the actual test
- session
+ result <- session
sendNotification Exit ExitParams
--- | An internal version of 'runSession' that allows for a custom handler to listen to the server.
--- It also does not automatically send initialize and exit messages.
-runSessionWithHandler :: (Handle -> Session ())
- -> FilePath
- -> Session a
- -> IO a
-runSessionWithHandler serverHandler rootDir session = do
- absRootDir <- canonicalizePath rootDir
-
- (Just serverIn, Just serverOut, Nothing, serverProc) <- createProcess
- (proc "hie" ["--lsp", "-d", "-l", "/tmp/hie-test.log"])
- { std_in = CreatePipe, std_out = CreatePipe }
-
- hSetBuffering serverIn NoBuffering
- hSetBuffering serverOut NoBuffering
-
- reqMap <- newMVar newRequestMap
- messageChan <- newChan
- meaninglessChan <- newChan
-
- let context = SessionContext serverIn absRootDir messageChan reqMap
- initState = SessionState (IdInt 9)
-
- forkIO $ void $ runSession' meaninglessChan context initState (serverHandler serverOut)
- (result, _) <- runSession' messageChan context initState session
-
- terminateProcess serverProc
-
return result
-- | Listens to the server output, makes sure it matches the record and
context <- ask
reqMap <- liftIO $ readMVar $ requestMap context
- liftIO $ writeChan (messageChan context) $ decodeFromServerMsg reqMap msgBytes
+ let msg = decodeFromServerMsg reqMap msgBytes
+ liftIO $ writeChan (messageChan context) msg
listenServer serverOut
+-- | The current text contents of a document.
+documentContents :: TextDocumentIdentifier -> Session T.Text
+documentContents doc = do
+ vfs <- vfs <$> get
+ let file = vfs Map.! (doc ^. uri)
+ return $ Rope.toText $ Language.Haskell.LSP.VFS._text file
+
+-- | Parses an ApplyEditRequest, checks that it is for the passed document
+-- and returns the new content
+getDocumentEdit :: TextDocumentIdentifier -> Session T.Text
+getDocumentEdit doc = do
+ req <- request :: Session ApplyWorkspaceEditRequest
+
+ unless (checkDocumentChanges req || checkChanges req) $
+ liftIO $ throw (IncorrectApplyEditRequestException (show req))
+
+ documentContents doc
+ where
+ checkDocumentChanges :: ApplyWorkspaceEditRequest -> Bool
+ checkDocumentChanges req =
+ let changes = req ^. params . edit . documentChanges
+ maybeDocs = fmap (fmap (^. textDocument . uri)) changes
+ in case maybeDocs of
+ Just docs -> (doc ^. uri) `elem` docs
+ Nothing -> False
+ checkChanges :: ApplyWorkspaceEditRequest -> Bool
+ checkChanges req =
+ let mMap = req ^. params . edit . changes
+ in maybe False (HashMap.member (doc ^. uri)) mMap
+
-- | Sends a request to the server.
--
-- @
=> ClientMethod -- ^ The notification method.
-> a -- ^ The notification parameters.
-> Session ()
-sendNotification method params =
- let notif = NotificationMessage "2.0" method params
- in sendNotification' notif
+
+-- | Open a virtual file if we send a did open text document notification
+sendNotification TextDocumentDidOpen params = do
+ let params' = fromJust $ decode $ encode params
+ n :: DidOpenTextDocumentNotification
+ n = NotificationMessage "2.0" TextDocumentDidOpen params'
+ oldVFS <- vfs <$> get
+ newVFS <- liftIO $ openVFS oldVFS n
+ modify (\s -> s { vfs = newVFS })
+ sendNotification' n
+
+-- | Close a virtual file if we send a close text document notification
+sendNotification TextDocumentDidClose params = do
+ let params' = fromJust $ decode $ encode params
+ n :: DidCloseTextDocumentNotification
+ n = NotificationMessage "2.0" TextDocumentDidClose params'
+ oldVFS <- vfs <$> get
+ newVFS <- liftIO $ closeVFS oldVFS n
+ modify (\s -> s { vfs = newVFS })
+ sendNotification' n
+
+sendNotification method params = sendNotification' (NotificationMessage "2.0" method params)
sendNotification' :: (ToJSON a, ToJSON b) => NotificationMessage a b -> Session ()
sendNotification' = sendMessage
h <- serverIn <$> ask
liftIO $ B.hPut h $ addHeader (encode msg)
+-- | Returns the initialize response that was received from the server.
+-- The initialize requests and responses are not included the session,
+-- so if you need to test it use this.
+initializeResponse :: Session InitializeResponse
+initializeResponse = initRsp <$> ask >>= (liftIO . readMVar)
+
-- | Opens a text document and sends a notification to the client.
openDoc :: FilePath -> String -> Session TextDocumentIdentifier
openDoc file languageId = do
item <- getDocItem file languageId
sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams item)
TextDocumentIdentifier <$> getDocUri file
-
+ where
-- | Reads in a text document as the first version.
getDocItem :: FilePath -- ^ The path to the text document to read in.
-> String -- ^ The language ID, e.g "haskell" for .hs files.
context <- ask
let fp = rootDir context </> file
return $ filePathToUri fp
+
+getDiagnostics :: Session [Diagnostic]
+getDiagnostics = do
+ diagsNot <- notification :: Session PublishDiagnosticsNotification
+ let (List diags) = diagsNot ^. params . LSP.diagnostics
+ return diags
+
+-- | Expects a 'PublishDiagnosticsNotification' and throws an
+-- 'UnexpectedDiagnosticsException' if there are any diagnostics
+-- returned.
+noDiagnostics :: Session ()
+noDiagnostics = do
+ diagsNot <- notification :: Session PublishDiagnosticsNotification
+ when (diagsNot ^. params . LSP.diagnostics /= List []) $ liftIO $ throw UnexpectedDiagnosticsException
+
+-- | Returns the symbols in a document.
+getDocumentSymbols :: TextDocumentIdentifier -> Session DocumentSymbolsResponse
+getDocumentSymbols doc = do
+ sendRequest TextDocumentDocumentSymbol (DocumentSymbolParams doc)
+ response
\ No newline at end of file
projects / opengl.git / blobdiff