, sendNotification
, sendRequest'
, sendNotification'
- , sendResponse'
+ , sendResponse
-- * Receving
- , getMessage
+ , anyRequest
+ , request
+ , anyResponse
+ , response
+ , anyNotification
+ , notification
+ , loggingNotification
+ , publishDiagnosticsNotification
+ -- * Combinators
+ , choice
+ , option
+ , optional
+ , between
+ , some
+ , many
+ , sepBy
+ , sepBy1
+ , sepEndBy1
+ , sepEndBy
+ , endBy1
+ , endBy
+ , count
+ , manyTill
+ , skipMany
+ , skipSome
+ , skipManyTill
+ , skipSomeTill
+ , (<|>)
+ , satisfy
-- * Utilities
+ , openDoc
, getDocItem
, getDocUri
) where
+import Control.Applicative
+import Control.Applicative.Combinators
import Control.Monad
-import Control.Monad.Trans.Class
import Control.Monad.IO.Class
-import Control.Monad.Trans.Reader
-import Control.Monad.Trans.State
import Control.Concurrent
+import Control.Lens hiding ((.=))
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 Data.Maybe
-import Data.Proxy
import System.Process
-import Language.Haskell.LSP.Types hiding (error, id)
+import Language.Haskell.LSP.Types
+import qualified Language.Haskell.LSP.Types as LSP (error, id)
import Language.Haskell.LSP.Test.Compat
import System.IO
import System.Directory
import System.FilePath
+import Language.Haskell.LSP.Test.Decoding
import Language.Haskell.LSP.Test.Parsing
-data SessionContext = SessionContext
- {
- messageSema :: MVar B.ByteString,
- serverIn :: Handle,
- rootDir :: FilePath
- }
-
-newtype SessionState = SessionState
- {
- curReqId :: LspId
- }
-
--- | A session representing one instance of launching and connecting to a server.
---
--- You can send and receive messages to the server within 'Session' via 'getMessage',
--- 'sendRequest' and 'sendNotification'.
---
--- @
--- runSession \"path\/to\/root\/dir\" $ do
--- docItem <- getDocItem "Desktop/simple.hs" "haskell"
--- sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams docItem)
--- diagnostics <- getMessage :: Session PublishDiagnosticsNotification
--- @
---
-type Session = StateT SessionState (ReaderT SessionContext IO)
-
-- | 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 ()
-runSession rootDir session = do
+runSession serverExe rootDir session = do
pid <- getProcessID
absRootDir <- canonicalizePath rootDir
def
(Just TraceOff)
- runSessionWithHandler listenServer rootDir $ do
+ runSessionWithHandler listenServer serverExe rootDir $ do
-- Wrap the session around initialize and shutdown calls
- sendRequest (Proxy :: Proxy InitializeRequest) Initialize initializeParams
- (ResponseMessage _ _ (Just (InitializeResponseCapabilities _)) e) <- getMessage
- liftIO $ maybe (return ()) (putStrLn . ("Error when initializing: " ++) . show ) e
+ sendRequest Initialize initializeParams
+ initRsp <- response :: Session InitializeResponse
+ liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRsp ^. LSP.error)
sendNotification Initialized InitializedParams
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 ())
+ -> String
-> FilePath
-> Session a
-> IO a
-runSessionWithHandler serverHandler rootDir session = do
+runSessionWithHandler serverHandler serverExe 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 }
+ let createProc = (shell serverExe) { std_in = CreatePipe, std_out = CreatePipe }
+ (Just serverIn, Just serverOut, Nothing, serverProc) <- createProcess createProc
hSetBuffering serverIn NoBuffering
hSetBuffering serverOut NoBuffering
- messageSema <- newEmptyMVar
+ reqMap <- newMVar newRequestMap
+ messageChan <- newChan
+ meaninglessChan <- newChan
- let context = SessionContext messageSema serverIn absRootDir
+ let context = SessionContext serverIn absRootDir messageChan reqMap
initState = SessionState (IdInt 9)
- forkIO $ void $ runReaderT (runStateT (serverHandler serverOut) initState) context
- (result, _) <- runReaderT (runStateT session initState) context
+ threadId <- forkIO $ void $ runSession' meaninglessChan context initState (serverHandler serverOut)
+ (result, _) <- runSession' messageChan context initState session
terminateProcess serverProc
+ killThread threadId
return result
-- signals any semaphores
listenServer :: Handle -> Session ()
listenServer serverOut = do
- context <- lift ask
msgBytes <- liftIO $ getNextMessage serverOut
- liftIO $ case decode msgBytes :: Maybe LogMessageNotification of
- -- Just print log and show messages
- Just (NotificationMessage _ WindowLogMessage (LogMessageParams _ msg)) -> T.putStrLn msg
- _ -> case decode msgBytes :: Maybe ShowMessageNotification of
- Just (NotificationMessage _ WindowShowMessage (ShowMessageParams _ msg)) -> T.putStrLn msg
- -- Give everything else for getMessage to handle
- _ -> putMVar (messageSema context) msgBytes
+ context <- ask
+ reqMap <- liftIO $ readMVar $ requestMap context
+
+ liftIO $ writeChan (messageChan context) $ decodeFromServerMsg reqMap msgBytes
listenServer serverOut
-- (DocumentSymbolParams docId)
-- @
sendRequest
- :: forall params resp. (ToJSON params, ToJSON resp, FromJSON resp)
- => Proxy (RequestMessage ClientMethod params resp) -- ^ A proxy to provide more type information about the request.
- -> ClientMethod -- ^ The request method.
+ :: (ToJSON params)
+ => --Proxy (RequestMessage ClientMethod params resp) -- ^ A proxy to provide more type information about the request.
+ ClientMethod -- ^ The request method.
-> params -- ^ The request parameters.
-> Session LspId -- ^ The id of the request that was sent.
-sendRequest _ method params = do
+sendRequest method params = do
id <- curReqId <$> get
- get >>= \c -> put c { curReqId = nextId id }
+ modify $ \c -> c { curReqId = nextId id }
- let req = RequestMessage "2.0" id method params :: RequestMessage ClientMethod params resp
+ let req = RequestMessage' "2.0" id method params
- sendRequest' req
+ -- Update the request map
+ reqMap <- requestMap <$> ask
+ liftIO $ modifyMVar_ reqMap $
+ \r -> return $ updateRequestMap r id method
+
+ sendMessage req
return id
where nextId (IdInt i) = IdInt (i + 1)
nextId (IdString s) = IdString $ T.pack $ show $ read (T.unpack s) + 1
-sendRequest' :: (ToJSON a, ToJSON b, ToJSON c) => RequestMessage a b c -> Session ()
-sendRequest' = sendMessage
+-- | A custom type for request message that doesn't
+-- need a response type, allows us to infer the request
+-- message type without using proxies.
+data RequestMessage' a = RequestMessage' T.Text LspId ClientMethod a
+
+instance ToJSON a => ToJSON (RequestMessage' a) where
+ toJSON (RequestMessage' rpc id method params) =
+ object ["jsonrpc" .= rpc, "id" .= id, "method" .= method, "params" .= params]
+
+
+sendRequest' :: (ToJSON a, ToJSON b) => RequestMessage ClientMethod a b -> Session ()
+sendRequest' req = do
+ -- Update the request map
+ reqMap <- requestMap <$> ask
+ liftIO $ modifyMVar_ reqMap $
+ \r -> return $ updateRequestMap r (req ^. LSP.id) (req ^. method)
+
+ sendMessage req
-- | Sends a notification to the server.
sendNotification :: ToJSON a
sendNotification' :: (ToJSON a, ToJSON b) => NotificationMessage a b -> Session ()
sendNotification' = sendMessage
-sendResponse' :: ToJSON a => ResponseMessage a -> Session ()
-sendResponse' = sendMessage
+sendResponse :: ToJSON a => ResponseMessage a -> Session ()
+sendResponse = sendMessage
sendMessage :: ToJSON a => a -> Session ()
sendMessage msg = do
- h <- serverIn <$> lift ask
+ h <- serverIn <$> ask
liftIO $ B.hPut h $ addHeader (encode msg)
--- | Reads in a message from the server.
-getMessage :: FromJSON a => Session a
-getMessage = do
- sema <- messageSema <$> lift ask
- bytes <- liftIO $ takeMVar sema
- return $ fromMaybe (error $ "Wrong type! Got: " ++ show bytes) (decode bytes)
+-- | 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
-- | 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.
-> Session TextDocumentItem
getDocItem file languageId = do
- context <- lift ask
+ context <- ask
let fp = rootDir context </> file
contents <- liftIO $ T.readFile fp
return $ TextDocumentItem (filePathToUri fp) (T.pack languageId) 0 contents
-- | Gets the Uri for the file corrected to the session directory.
getDocUri :: FilePath -> Session Uri
getDocUri file = do
- context <- lift ask
+ context <- ask
let fp = rootDir context </> file
return $ filePathToUri fp
projects / lsp-test.git / blobdiff