Add window/showDocument

Author: michaelpj

lsp-test/src/Language/LSP/Test/Parsing.hs

@@ -198,6 +198,7 @@ loggingNotification = named "Logging notification" $ satisfy shouldSkip
     shouldSkip (FromServerMess SWindowLogMessage _) = True
     shouldSkip (FromServerMess SWindowShowMessage _) = True
     shouldSkip (FromServerMess SWindowShowMessageRequest _) = True
+    shouldSkip (FromServerMess SWindowShowDocument _) = True
     shouldSkip _ = False
 
 -- | Matches a 'Language.LSP.Types.TextDocumentPublishDiagnostics'

lsp-test/src/Language/LSP/Test/Session.hs

@@ -231,6 +231,7 @@ runSessionMonad context state (Session session) = runReaderT (runStateT conduit
 
     isLogNotification (ServerMessage (FromServerMess SWindowShowMessage _)) = True
     isLogNotification (ServerMessage (FromServerMess SWindowLogMessage _)) = True
+    isLogNotification (ServerMessage (FromServerMess SWindowShowDocument _)) = True
     isLogNotification _ = False
 
     watchdog :: ConduitM SessionMessage FromServerMessage (StateT SessionState (ReaderT SessionContext IO)) ()

lsp-types/src/Language/LSP/Types/Lens.hs

@@ -342,6 +342,8 @@ makeFieldsNoPrefix ''TypeDefinitionClientCapabilities
 makeFieldsNoPrefix ''ShowMessageParams
 makeFieldsNoPrefix ''MessageActionItem
 makeFieldsNoPrefix ''ShowMessageRequestParams
+makeFieldsNoPrefix ''ShowDocumentParams
+makeFieldsNoPrefix ''ShowDocumentResult
 makeFieldsNoPrefix ''LogMessageParams
 makeFieldsNoPrefix ''ProgressParams
 makeFieldsNoPrefix ''WorkDoneProgressBeginParams

lsp-types/src/Language/LSP/Types/Message.hs

@@ -136,6 +136,7 @@ type family MessageParams (m :: Method f t) :: Type where
   -- Window
   MessageParams WindowShowMessage                  = ShowMessageParams
   MessageParams WindowShowMessageRequest           = ShowMessageRequestParams
+  MessageParams WindowShowDocument                 = ShowDocumentParams
   MessageParams WindowLogMessage                   = LogMessageParams
   -- Progress
   MessageParams WindowWorkDoneProgressCreate       = WorkDoneProgressCreateParams
@@ -219,6 +220,7 @@ type family ResponseResult (m :: Method f Request) :: Type where
 -- Server
   -- Window
   ResponseResult WindowShowMessageRequest      = Maybe MessageActionItem
+  ResponseResult WindowShowDocument            = ShowDocumentResult
   ResponseResult WindowWorkDoneProgressCreate  = Empty
   -- Capability
   ResponseResult ClientRegisterCapability      = Empty

lsp-types/src/Language/LSP/Types/Method.hs

@@ -90,6 +90,7 @@ data Method (f :: From) (t :: MethodType) where
   -- Window
   WindowShowMessage                  :: Method FromServer Notification
   WindowShowMessageRequest           :: Method FromServer Request
+  WindowShowDocument                 :: Method FromServer Request
   WindowLogMessage                   :: Method FromServer Notification
   WindowWorkDoneProgressCancel       :: Method FromClient Notification
   WindowWorkDoneProgressCreate       :: Method FromServer Request
@@ -167,6 +168,7 @@ data SMethod (m :: Method f t) where
 
   SWindowShowMessage                  :: SMethod WindowShowMessage
   SWindowShowMessageRequest           :: SMethod WindowShowMessageRequest
+  SWindowShowDocument                 :: SMethod WindowShowDocument
   SWindowLogMessage                   :: SMethod WindowLogMessage
   SWindowWorkDoneProgressCreate       :: SMethod WindowWorkDoneProgressCreate
   SWindowWorkDoneProgressCancel       :: SMethod WindowWorkDoneProgressCancel
@@ -307,6 +309,7 @@ instance A.FromJSON SomeServerMethod where
   -- Window
   parseJSON (A.String "window/showMessage")                  = pure $ SomeServerMethod SWindowShowMessage
   parseJSON (A.String "window/showMessageRequest")           = pure $ SomeServerMethod SWindowShowMessageRequest
+  parseJSON (A.String "window/showDocument")                 = pure $ SomeServerMethod SWindowShowDocument
   parseJSON (A.String "window/logMessage")                   = pure $ SomeServerMethod SWindowLogMessage
   parseJSON (A.String "window/workDoneProgress/create")      = pure $ SomeServerMethod SWindowWorkDoneProgressCreate
   parseJSON (A.String "$/progress")                          = pure $ SomeServerMethod SProgress
@@ -400,6 +403,7 @@ instance A.ToJSON (SMethod m) where
   -- Window
   toJSON SWindowShowMessage                  = A.String "window/showMessage"
   toJSON SWindowShowMessageRequest           = A.String "window/showMessageRequest"
+  toJSON SWindowShowDocument                 = A.String "window/showDocument"
   toJSON SWindowLogMessage                   = A.String "window/logMessage"
   toJSON SWindowWorkDoneProgressCreate       = A.String "window/workDoneProgress/create"
   toJSON SProgress                           = A.String "$/progress"

lsp-types/src/Language/LSP/Types/Parsing.hs

@@ -267,6 +267,7 @@ splitClientMethod SCustomMethod{} = IsClientEither
 splitServerMethod :: SServerMethod m -> ServerNotOrReq m
 splitServerMethod SWindowShowMessage = IsServerNot
 splitServerMethod SWindowShowMessageRequest = IsServerReq
+splitServerMethod SWindowShowDocument = IsServerReq
 splitServerMethod SWindowLogMessage = IsServerNot
 splitServerMethod SWindowWorkDoneProgressCreate = IsServerReq
 splitServerMethod SProgress = IsServerNot

lsp-types/src/Language/LSP/Types/Window.hs

@@ -8,6 +8,8 @@ import qualified Data.Aeson                                 as A
 import           Data.Aeson.TH
 import           Data.Text                                  (Text)
 import           Language.LSP.Types.Utils
+import Language.LSP.Types.Uri
+import Language.LSP.Types.Location
 
 -- ---------------------------------------------------------------------
 
@@ -62,6 +64,45 @@ deriveJSON lspOptions ''ShowMessageRequestParams
 
 -- ---------------------------------------------------------------------
 
+-- | Params to show a document.
+--
+-- @since 3.16.0
+data ShowDocumentParams =
+  ShowDocumentParams {
+    -- | The document uri to show.
+    _uri :: Uri
+
+    -- | Indicates to show the resource in an external program.
+    -- To show for example `https://code.visualstudio.com/`
+    -- in the default WEB browser set `external` to `true`.
+  , _external :: Maybe Bool
+
+    -- | An optional property to indicate whether the editor
+    -- showing the document should take focus or not.
+    -- Clients might ignore this property if an external
+    -- program is started.
+  , _takeFocus :: Maybe Bool
+
+    -- | An optional selection range if the document is a text
+    -- document. Clients might ignore the property if an
+    -- external program is started or the file is not a text
+    -- file.
+  , _selection :: Maybe Range
+  } deriving (Show, Read, Eq)
+
+deriveJSON lspOptions ''ShowDocumentParams
+
+-- | The result of an show document request.
+--
+--  @since 3.16.0
+data ShowDocumentResult =
+  ShowDocumentResult {
+    -- | A boolean indicating if the show was successful.
+    _success :: Bool
+  } deriving (Show, Read, Eq)
+
+-- ---------------------------------------------------------------------
+
 data LogMessageParams =
   LogMessageParams {
     _xtype   :: MessageType