Ide.Types

Documentation

data PluginDescriptor (ideState :: *)

Constructors

PluginDescriptor

Fields

• pluginId :: !PluginId

  Unique identifier of the plugin.

• pluginPriority :: Natural

  Plugin handlers are called in priority order, higher priority first

• pluginRules :: !(Rules ())
• pluginCommands :: ![PluginCommand ideState]
• pluginHandlers :: PluginHandlers ideState
• pluginConfigDescriptor :: ConfigDescriptor
• pluginNotificationHandlers :: PluginNotificationHandlers ideState
• pluginModifyDynflags :: DynFlagsModifications
• pluginCli :: Maybe (ParserInfo (IdeCommand ideState))
• pluginFileType :: [Text]

  File extension of the files the plugin is responsible for. The plugin is only allowed to handle files with these extensions When writing handlers, etc. for this plugin it can be assumed that all handled files are of this type. The file extension must have a leading ..

defaultPluginDescriptor :: PluginId -> PluginDescriptor ideState

Set up a plugin descriptor, initialized with default values. This is plugin descriptor is prepared for haskell files, such as

• .hs

• .lhs

• .hs-boot

and handlers will be enabled for files with the appropriate file extensions.

defaultCabalPluginDescriptor :: PluginId -> PluginDescriptor ideState

Set up a plugin descriptor, initialized with default values. This is plugin descriptor is prepared for .cabal files and as such, will only respond / run when .cabal files are currently in scope.

Handles files with the following extensions: * .cabal

defaultPluginPriority :: Natural

newtype IdeCommand state

Constructors

IdeCommand (state -> IO ())

Instances

Show (IdeCommand st)

Defined in Ide.Types

Methods

showsPrec :: Int -> IdeCommand st -> ShowS

show :: IdeCommand st -> String

showList :: [IdeCommand st] -> ShowS

data IdeMethod (m :: Method FromClient Request)

Methods which have a PluginMethod instance

Constructors

PluginRequestMethod m => IdeMethod (SMethod m)

Instances

GCompare IdeMethod

Defined in Ide.Types

Methods

gcompare :: forall (a :: k) (b :: k). IdeMethod a -> IdeMethod b -> GOrdering a b

GEq IdeMethod

Defined in Ide.Types

Methods

geq :: forall (a :: k) (b :: k). IdeMethod a -> IdeMethod b -> Maybe (a :~: b)

data IdeNotification (m :: Method FromClient Notification)

Methods which have a PluginMethod instance

Constructors

PluginNotificationMethod m => IdeNotification (SMethod m)

Instances

GCompare IdeNotification

Defined in Ide.Types

Methods

gcompare :: forall (a :: k) (b :: k). IdeNotification a -> IdeNotification b -> GOrdering a b

GEq IdeNotification

Defined in Ide.Types

Methods

geq :: forall (a :: k) (b :: k). IdeNotification a -> IdeNotification b -> Maybe (a :~: b)

data IdePlugins ideState where

Bundled Patterns

pattern IdePlugins :: [PluginDescriptor ideState] -> IdePlugins ideState

Smart constructor that deduplicates plugins

Instances

Monoid (IdePlugins a)

Defined in Ide.Types

Methods

mempty :: IdePlugins a

mappend :: IdePlugins a -> IdePlugins a -> IdePlugins a

mconcat :: [IdePlugins a] -> IdePlugins a

Semigroup (IdePlugins a)

Defined in Ide.Types

Methods

(<>) :: IdePlugins a -> IdePlugins a -> IdePlugins a

sconcat :: NonEmpty (IdePlugins a) -> IdePlugins a

stimes :: Integral b => b -> IdePlugins a -> IdePlugins a

data DynFlagsModifications

Hooks for modifying the DynFlags at different times of the compilation process. Plugins can install a DynFlagsModifications via pluginModifyDynflags in their PluginDescriptor.

Constructors

DynFlagsModifications

Fields

• dynFlagsModifyGlobal :: DynFlags -> DynFlags

  Invoked immediately at the package level. Changes to the DynFlags made in dynFlagsModifyGlobal are guaranteed to be seen everywhere in the compilation pipeline.

• dynFlagsModifyParser :: DynFlags -> DynFlags

  Invoked just before the parsing step, and reset immediately afterwards. dynFlagsModifyParser allows plugins to enable language extensions only during parsing. for example, to let them enable certain pieces of syntax.

Instances

Monoid DynFlagsModifications

Defined in Ide.Types

Methods

mempty :: DynFlagsModifications

mappend :: DynFlagsModifications -> DynFlagsModifications -> DynFlagsModifications

mconcat :: [DynFlagsModifications] -> DynFlagsModifications

Semigroup DynFlagsModifications

Defined in Ide.Types

Methods

(<>) :: DynFlagsModifications -> DynFlagsModifications -> DynFlagsModifications

sconcat :: NonEmpty DynFlagsModifications -> DynFlagsModifications

stimes :: Integral b => b -> DynFlagsModifications -> DynFlagsModifications

data Config

We (initially anyway) mirror the hie configuration, so that existing clients can simply switch executable and not have any nasty surprises. There will be surprises relating to config options being ignored, initially though.

Constructors

Config

Fields

• checkParents :: CheckParents
• checkProject :: !Bool
• formattingProvider :: !Text
• cabalFormattingProvider :: !Text
• maxCompletions :: !Int
• plugins :: !(Map PluginId PluginConfig)

Instances

ToJSON Config

Defined in Ide.Types

Methods

toJSON :: Config -> Value

toEncoding :: Config -> Encoding

toJSONList :: [Config] -> Value

toEncodingList :: [Config] -> Encoding

Show Config

Defined in Ide.Types

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Default Config

Defined in Ide.Types

Methods

def :: Config

Eq Config

Defined in Ide.Types

Methods

(==) :: Config -> Config -> Bool

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

data PluginConfig

A PluginConfig is a generic configuration for a given HLS plugin. It provides a "big switch" to turn it on or off as a whole, as well as small switches per feature, and a slot for custom config. This provides a regular naming scheme for all plugin config.

Constructors

PluginConfig

Fields

• plcGlobalOn :: !Bool
• plcCallHierarchyOn :: !Bool
• plcCodeActionsOn :: !Bool
• plcCodeLensOn :: !Bool
• plcDiagnosticsOn :: !Bool
• plcHoverOn :: !Bool
• plcSymbolsOn :: !Bool
• plcCompletionOn :: !Bool
• plcRenameOn :: !Bool
• plcSelectionRangeOn :: !Bool
• plcFoldingRangeOn :: !Bool
• plcConfig :: !Object

Instances

ToJSON PluginConfig

Defined in Ide.Types

Methods

toJSON :: PluginConfig -> Value

toEncoding :: PluginConfig -> Encoding

toJSONList :: [PluginConfig] -> Value

toEncodingList :: [PluginConfig] -> Encoding

Show PluginConfig

Defined in Ide.Types

Methods

showsPrec :: Int -> PluginConfig -> ShowS

show :: PluginConfig -> String

showList :: [PluginConfig] -> ShowS

Default PluginConfig

Defined in Ide.Types

Methods

def :: PluginConfig

Eq PluginConfig

Defined in Ide.Types

Methods

(==) :: PluginConfig -> PluginConfig -> Bool

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

data CheckParents

Constructors

NeverCheck

CheckOnSave

AlwaysCheck

Instances

FromJSON CheckParents

Defined in Ide.Types

Methods

parseJSON :: Value -> Parser CheckParents

parseJSONList :: Value -> Parser [CheckParents]

ToJSON CheckParents

Defined in Ide.Types

Methods

toJSON :: CheckParents -> Value

toEncoding :: CheckParents -> Encoding

toJSONList :: [CheckParents] -> Value

toEncodingList :: [CheckParents] -> Encoding

Generic CheckParents

Defined in Ide.Types

Associated Types

type Rep CheckParents :: Type -> Type

Methods

from :: CheckParents -> Rep CheckParents x

to :: Rep CheckParents x -> CheckParents

Show CheckParents

Defined in Ide.Types

Methods

showsPrec :: Int -> CheckParents -> ShowS

show :: CheckParents -> String

showList :: [CheckParents] -> ShowS

Eq CheckParents

Defined in Ide.Types

Methods

(==) :: CheckParents -> CheckParents -> Bool

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

Ord CheckParents

Defined in Ide.Types

Methods

compare :: CheckParents -> CheckParents -> Ordering

(<) :: CheckParents -> CheckParents -> Bool

(<=) :: CheckParents -> CheckParents -> Bool

(>) :: CheckParents -> CheckParents -> Bool

(>=) :: CheckParents -> CheckParents -> Bool

max :: CheckParents -> CheckParents -> CheckParents

min :: CheckParents -> CheckParents -> CheckParents

type Rep CheckParents

Defined in Ide.Types

type Rep CheckParents = D1 ('MetaData "CheckParents" "Ide.Types" "hls-plugin-api-1.6.0.0-FBBe7YX7CAV7fcO2QVUIWy" 'False) (C1 ('MetaCons "NeverCheck" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CheckOnSave" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AlwaysCheck" 'PrefixI 'False) (U1 :: Type -> Type)))

data ConfigDescriptor

Describes the configuration a plugin. A plugin may be configurable in such form:

{
 "plugin-id": {
   "globalOn": true,
   "codeActionsOn": true,
   "codeLensOn": true,
   "config": {
     "property1": "foo"
    }
  }
}

globalOn, codeActionsOn, and codeLensOn etc. are called generic configs, which can be inferred from handlers registered by the plugin. config is called custom config, which is defined using Properties.

Constructors

ConfigDescriptor

Fields

• configInitialGenericConfig :: PluginConfig

  Initial values for the generic config

• configHasDiagnostics :: Bool

  Whether or not to generate diagnosticsOn config. Diagnostics emit in arbitrary shake rules, so we can't know statically if the plugin produces diagnostics

• configCustomConfig :: CustomConfig

  Custom config.

defaultConfigDescriptor :: ConfigDescriptor

configForPlugin :: Config -> PluginDescriptor c -> PluginConfig

Lookup the current config for a plugin

pluginEnabledConfig :: (PluginConfig -> Bool) -> PluginConfig -> Bool

Checks that a given plugin is both enabled and the specific feature is enabled

data CustomConfig

An existential wrapper of Properties

Constructors

forall r. CustomConfig (Properties r)

mkCustomConfig :: Properties r -> CustomConfig

data FallbackCodeActionParams

Constructors

FallbackCodeActionParams

Fields

• fallbackWorkspaceEdit :: Maybe WorkspaceEdit
• fallbackCommand :: Maybe Command

Instances

FromJSON FallbackCodeActionParams

Defined in Ide.Types

Methods

parseJSON :: Value -> Parser FallbackCodeActionParams

parseJSONList :: Value -> Parser [FallbackCodeActionParams]

ToJSON FallbackCodeActionParams

Defined in Ide.Types

Methods

toJSON :: FallbackCodeActionParams -> Value

toEncoding :: FallbackCodeActionParams -> Encoding

toJSONList :: [FallbackCodeActionParams] -> Value

toEncodingList :: [FallbackCodeActionParams] -> Encoding

Generic FallbackCodeActionParams

Defined in Ide.Types

Associated Types

type Rep FallbackCodeActionParams :: Type -> Type

Methods

from :: FallbackCodeActionParams -> Rep FallbackCodeActionParams x

to :: Rep FallbackCodeActionParams x -> FallbackCodeActionParams

type Rep FallbackCodeActionParams

Defined in Ide.Types

type Rep FallbackCodeActionParams = D1 ('MetaData "FallbackCodeActionParams" "Ide.Types" "hls-plugin-api-1.6.0.0-FBBe7YX7CAV7fcO2QVUIWy" 'False) (C1 ('MetaCons "FallbackCodeActionParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "fallbackWorkspaceEdit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe WorkspaceEdit)) :*: S1 ('MetaSel ('Just "fallbackCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Command))))

data FormattingType

Format the given Text as a whole or only a Range of it. Range must be relative to the text to format. To format the whole document, read the Text from the file and use FormatText as the FormattingType.

Constructors

FormatText

FormatRange Range

type FormattingMethod m = (HasOptions (MessageParams m) FormattingOptions, HasTextDocument (MessageParams m) TextDocumentIdentifier, ResponseResult m ~ List TextEdit)

type FormattingHandler a = a -> FormattingType -> Text -> NormalizedFilePath -> FormattingOptions -> LspM Config (Either ResponseError (List TextEdit))

mkFormattingHandlers :: forall a. FormattingHandler a -> PluginHandlers a

class HasTracing a where

Minimal complete definition

Nothing

Methods

traceWithSpan :: SpanInFlight -> a -> IO ()

Instances

HasTracing Value

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> Value -> IO ()

HasTracing CallHierarchyIncomingCallsParams

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> CallHierarchyIncomingCallsParams -> IO ()

HasTracing CallHierarchyOutgoingCallsParams

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> CallHierarchyOutgoingCallsParams -> IO ()

HasTracing ExecuteCommandParams

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> ExecuteCommandParams -> IO ()

HasTracing CompletionItem

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> CompletionItem -> IO ()

HasTracing DidChangeConfigurationParams

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> DidChangeConfigurationParams -> IO ()

HasTracing InitializeParams

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> InitializeParams -> IO ()

HasTracing DidChangeWatchedFilesParams

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> DidChangeWatchedFilesParams -> IO ()

HasTracing DidChangeWorkspaceFoldersParams

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> DidChangeWorkspaceFoldersParams -> IO ()

HasTracing WorkspaceSymbolParams

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> WorkspaceSymbolParams -> IO ()

(HasTextDocument a doc, HasUri doc Uri) => HasTracing a

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> a -> IO ()

HasTracing (Maybe InitializedParams)

Defined in Ide.Types

Methods

traceWithSpan :: SpanInFlight -> Maybe InitializedParams -> IO ()

data PluginCommand ideState

Constructors

forall a.FromJSON a => PluginCommand

Fields

• commandId :: CommandId
• commandDesc :: Text
• commandFunc :: CommandFunction ideState a

newtype CommandId

Constructors

CommandId Text

Instances

IsString CommandId

Defined in Ide.Types

Methods

fromString :: String -> CommandId

Read CommandId

Defined in Ide.Types

Methods

readsPrec :: Int -> ReadS CommandId

readList :: ReadS [CommandId]

readPrec :: ReadPrec CommandId

readListPrec :: ReadPrec [CommandId]

Show CommandId

Defined in Ide.Types

Methods

showsPrec :: Int -> CommandId -> ShowS

show :: CommandId -> String

showList :: [CommandId] -> ShowS

Eq CommandId

Defined in Ide.Types

Methods

(==) :: CommandId -> CommandId -> Bool

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

Ord CommandId

Defined in Ide.Types

Methods

compare :: CommandId -> CommandId -> Ordering

(<) :: CommandId -> CommandId -> Bool

(<=) :: CommandId -> CommandId -> Bool

(>) :: CommandId -> CommandId -> Bool

(>=) :: CommandId -> CommandId -> Bool

max :: CommandId -> CommandId -> CommandId

min :: CommandId -> CommandId -> CommandId

type CommandFunction ideState a = ideState -> a -> LspM Config (Either ResponseError Value)

mkLspCommand :: PluginId -> CommandId -> Text -> Maybe [Value] -> Command

mkLspCmdId :: Text -> PluginId -> CommandId -> Text

newtype PluginId

Constructors

PluginId Text

Instances

FromJSON PluginId

Defined in Ide.Types

Methods

parseJSON :: Value -> Parser PluginId

parseJSONList :: Value -> Parser [PluginId]

IsString PluginId

Defined in Ide.Types

Methods

fromString :: String -> PluginId

Read PluginId

Defined in Ide.Types

Methods

readsPrec :: Int -> ReadS PluginId

readList :: ReadS [PluginId]

readPrec :: ReadPrec PluginId

readListPrec :: ReadPrec [PluginId]

Show PluginId

Defined in Ide.Types

Methods

showsPrec :: Int -> PluginId -> ShowS

show :: PluginId -> String

showList :: [PluginId] -> ShowS

Eq PluginId

Defined in Ide.Types

Methods

(==) :: PluginId -> PluginId -> Bool

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

Ord PluginId

Defined in Ide.Types

Methods

compare :: PluginId -> PluginId -> Ordering

(<) :: PluginId -> PluginId -> Bool

(<=) :: PluginId -> PluginId -> Bool

(>) :: PluginId -> PluginId -> Bool

(>=) :: PluginId -> PluginId -> Bool

max :: PluginId -> PluginId -> PluginId

min :: PluginId -> PluginId -> PluginId

Hashable PluginId

Defined in Ide.Types

Methods

hashWithSalt :: Int -> PluginId -> Int

hash :: PluginId -> Int

newtype PluginHandler a (m :: Method FromClient Request)

Combine handlers for the

Constructors

PluginHandler (PluginId -> a -> MessageParams m -> LspM Config (NonEmpty (Either ResponseError (ResponseResult m))))

mkPluginHandler :: PluginRequestMethod m => SClientMethod m -> PluginMethodHandler ideState m -> PluginHandlers ideState

Make a handler for plugins with no extra data

newtype PluginHandlers a

Constructors

PluginHandlers (DMap IdeMethod (PluginHandler a))

Instances

Monoid (PluginHandlers a)

Defined in Ide.Types

Methods

mempty :: PluginHandlers a

mappend :: PluginHandlers a -> PluginHandlers a -> PluginHandlers a

mconcat :: [PluginHandlers a] -> PluginHandlers a

Semigroup (PluginHandlers a)

Defined in Ide.Types

Methods

(<>) :: PluginHandlers a -> PluginHandlers a -> PluginHandlers a

sconcat :: NonEmpty (PluginHandlers a) -> PluginHandlers a

stimes :: Integral b => b -> PluginHandlers a -> PluginHandlers a

class HasTracing (MessageParams m) => PluginMethod (k :: MethodType) (m :: Method FromClient k) where

Methods that can be handled by plugins. ExtraParams captures any extra data the IDE passes to the handlers for this method Only methods for which we know how to combine responses can be instances of PluginMethod

Minimal complete definition

Nothing

Methods

pluginEnabled

Arguments

:: SMethod m

Method type.

-> MessageParams m

Whether a plugin is enabled might depend on the message parameters eg pluginFileType specifies what file extension a plugin is allowed to handle

-> PluginDescriptor c

Contains meta information such as PluginId and what file types this plugin is able to handle.

-> Config

Generic config description, expected to hold PluginConfig configuration for this plugin

-> Bool

Is this plugin enabled and allowed to respond to the given request with the given parameters?

Parse the configuration to check if this plugin is enabled. Perform sanity checks on the message to see whether plugin is enabled for this message in particular. If a plugin is not enabled, its handlers, commands, etc... will not be run for the given message.

Semantically, this method described whether a Plugin is enabled configuration wise and is allowed to respond to the message. This might depend on the URI that is associated to the Message Parameters, but doesn't have to. There are requests with no associated URI that, consequentially, can't inspect the URI.

Common reason why a plugin might not be allowed to respond although it is enabled: * Plugin can not handle requests associated to the specific URI * Since the implementation of cabal plugins HLS knows plugins specific for Haskell and specific for Cabal file descriptions

Strictly speaking, we are conflating two concepts here: * Dynamically enabled (e.g. enabled on a per-message basis) * Statically enabled (e.g. by configuration in the lsp-client) * Strictly speaking, this might also change dynamically

But there is no use to split it up currently into two different methods for now.

default pluginEnabled :: (HasTextDocument (MessageParams m) doc, HasUri doc Uri) => SMethod m -> MessageParams m -> PluginDescriptor c -> Config -> Bool

Instances

PluginMethod 'Notification 'Initialized

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'Initialized -> MessageParams 'Initialized -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Notification 'TextDocumentDidChange

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentDidChange -> MessageParams 'TextDocumentDidChange -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Notification 'TextDocumentDidClose

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentDidClose -> MessageParams 'TextDocumentDidClose -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Notification 'TextDocumentDidOpen

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentDidOpen -> MessageParams 'TextDocumentDidOpen -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Notification 'TextDocumentDidSave

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentDidSave -> MessageParams 'TextDocumentDidSave -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Notification 'WorkspaceDidChangeConfiguration

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'WorkspaceDidChangeConfiguration -> MessageParams 'WorkspaceDidChangeConfiguration -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Notification 'WorkspaceDidChangeWatchedFiles

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'WorkspaceDidChangeWatchedFiles -> MessageParams 'WorkspaceDidChangeWatchedFiles -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Notification 'WorkspaceDidChangeWorkspaceFolders

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'WorkspaceDidChangeWorkspaceFolders -> MessageParams 'WorkspaceDidChangeWorkspaceFolders -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'CallHierarchyIncomingCalls

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'CallHierarchyIncomingCalls -> MessageParams 'CallHierarchyIncomingCalls -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'CallHierarchyOutgoingCalls

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'CallHierarchyOutgoingCalls -> MessageParams 'CallHierarchyOutgoingCalls -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'CompletionItemResolve

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'CompletionItemResolve -> MessageParams 'CompletionItemResolve -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentCodeAction

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentCodeAction -> MessageParams 'TextDocumentCodeAction -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentCodeLens

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentCodeLens -> MessageParams 'TextDocumentCodeLens -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentCompletion

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentCompletion -> MessageParams 'TextDocumentCompletion -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentDefinition

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentDefinition -> MessageParams 'TextDocumentDefinition -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentDocumentHighlight

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentDocumentHighlight -> MessageParams 'TextDocumentDocumentHighlight -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentDocumentSymbol

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentDocumentSymbol -> MessageParams 'TextDocumentDocumentSymbol -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentFoldingRange

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentFoldingRange -> MessageParams 'TextDocumentFoldingRange -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentFormatting

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentFormatting -> MessageParams 'TextDocumentFormatting -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentHover

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentHover -> MessageParams 'TextDocumentHover -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentPrepareCallHierarchy

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentPrepareCallHierarchy -> MessageParams 'TextDocumentPrepareCallHierarchy -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentRangeFormatting

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentRangeFormatting -> MessageParams 'TextDocumentRangeFormatting -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentReferences

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentReferences -> MessageParams 'TextDocumentReferences -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentRename

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentRename -> MessageParams 'TextDocumentRename -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentSelectionRange

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentSelectionRange -> MessageParams 'TextDocumentSelectionRange -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'TextDocumentTypeDefinition

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentTypeDefinition -> MessageParams 'TextDocumentTypeDefinition -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request 'WorkspaceSymbol

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'WorkspaceSymbol -> MessageParams 'WorkspaceSymbol -> PluginDescriptor c -> Config -> Bool

PluginMethod 'Request ('CustomMethod :: Method 'FromClient 'Request)

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'CustomMethod -> MessageParams 'CustomMethod -> PluginDescriptor c -> Config -> Bool

type PluginMethodHandler a m = a -> PluginId -> MessageParams m -> LspM Config (Either ResponseError (ResponseResult m))

newtype PluginNotificationHandler a (m :: Method FromClient Notification)

Constructors

PluginNotificationHandler (PluginId -> a -> VFS -> MessageParams m -> LspM Config ())

mkPluginNotificationHandler :: PluginNotificationMethod m => SClientMethod (m :: Method FromClient Notification) -> PluginNotificationMethodHandler ideState m -> PluginNotificationHandlers ideState

Make a handler for plugins with no extra data

newtype PluginNotificationHandlers a

Constructors

PluginNotificationHandlers (DMap IdeNotification (PluginNotificationHandler a))

Instances

Monoid (PluginNotificationHandlers a)

Defined in Ide.Types

Methods

mempty :: PluginNotificationHandlers a

mappend :: PluginNotificationHandlers a -> PluginNotificationHandlers a -> PluginNotificationHandlers a

mconcat :: [PluginNotificationHandlers a] -> PluginNotificationHandlers a

Semigroup (PluginNotificationHandlers a)

Defined in Ide.Types

Methods

(<>) :: PluginNotificationHandlers a -> PluginNotificationHandlers a -> PluginNotificationHandlers a

sconcat :: NonEmpty (PluginNotificationHandlers a) -> PluginNotificationHandlers a

stimes :: Integral b => b -> PluginNotificationHandlers a -> PluginNotificationHandlers a

class PluginMethod Request m => PluginRequestMethod (m :: Method FromClient Request) where

Minimal complete definition

Nothing

Methods

combineResponses

Arguments

:: SMethod m

-> Config

IDE Configuration

-> ClientCapabilities

-> MessageParams m

-> NonEmpty (ResponseResult m)

-> ResponseResult m

How to combine responses from different plugins.

For example, for Hover requests, we might have multiple producers of Hover information, we do not want to decide which one to display to the user but allow here to define how to merge two hover request responses into one glorious hover box.

However, sometimes only one handler of a request can realistically exist, such as TextDocumentFormatting, it is safe to just unconditionally report back one arbitrary result (arbitrary since it should only be one anyway).

default combineResponses :: Semigroup (ResponseResult m) => SMethod m -> Config -> ClientCapabilities -> MessageParams m -> NonEmpty (ResponseResult m) -> ResponseResult m

Instances

PluginRequestMethod 'CallHierarchyIncomingCalls

Defined in Ide.Types

Methods

combineResponses :: SMethod 'CallHierarchyIncomingCalls -> Config -> ClientCapabilities -> MessageParams 'CallHierarchyIncomingCalls -> NonEmpty (ResponseResult 'CallHierarchyIncomingCalls) -> ResponseResult 'CallHierarchyIncomingCalls

PluginRequestMethod 'CallHierarchyOutgoingCalls

Defined in Ide.Types

Methods

combineResponses :: SMethod 'CallHierarchyOutgoingCalls -> Config -> ClientCapabilities -> MessageParams 'CallHierarchyOutgoingCalls -> NonEmpty (ResponseResult 'CallHierarchyOutgoingCalls) -> ResponseResult 'CallHierarchyOutgoingCalls

PluginRequestMethod 'CompletionItemResolve

Defined in Ide.Types

Methods

combineResponses :: SMethod 'CompletionItemResolve -> Config -> ClientCapabilities -> MessageParams 'CompletionItemResolve -> NonEmpty (ResponseResult 'CompletionItemResolve) -> ResponseResult 'CompletionItemResolve

PluginRequestMethod 'TextDocumentCodeAction

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentCodeAction -> Config -> ClientCapabilities -> MessageParams 'TextDocumentCodeAction -> NonEmpty (ResponseResult 'TextDocumentCodeAction) -> ResponseResult 'TextDocumentCodeAction

PluginRequestMethod 'TextDocumentCodeLens

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentCodeLens -> Config -> ClientCapabilities -> MessageParams 'TextDocumentCodeLens -> NonEmpty (ResponseResult 'TextDocumentCodeLens) -> ResponseResult 'TextDocumentCodeLens

PluginRequestMethod 'TextDocumentCompletion

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentCompletion -> Config -> ClientCapabilities -> MessageParams 'TextDocumentCompletion -> NonEmpty (ResponseResult 'TextDocumentCompletion) -> ResponseResult 'TextDocumentCompletion

PluginRequestMethod 'TextDocumentDefinition

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentDefinition -> Config -> ClientCapabilities -> MessageParams 'TextDocumentDefinition -> NonEmpty (ResponseResult 'TextDocumentDefinition) -> ResponseResult 'TextDocumentDefinition

PluginRequestMethod 'TextDocumentDocumentHighlight

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentDocumentHighlight -> Config -> ClientCapabilities -> MessageParams 'TextDocumentDocumentHighlight -> NonEmpty (ResponseResult 'TextDocumentDocumentHighlight) -> ResponseResult 'TextDocumentDocumentHighlight

PluginRequestMethod 'TextDocumentDocumentSymbol

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentDocumentSymbol -> Config -> ClientCapabilities -> MessageParams 'TextDocumentDocumentSymbol -> NonEmpty (ResponseResult 'TextDocumentDocumentSymbol) -> ResponseResult 'TextDocumentDocumentSymbol

PluginRequestMethod 'TextDocumentFoldingRange

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentFoldingRange -> Config -> ClientCapabilities -> MessageParams 'TextDocumentFoldingRange -> NonEmpty (ResponseResult 'TextDocumentFoldingRange) -> ResponseResult 'TextDocumentFoldingRange

PluginRequestMethod 'TextDocumentFormatting

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentFormatting -> Config -> ClientCapabilities -> MessageParams 'TextDocumentFormatting -> NonEmpty (ResponseResult 'TextDocumentFormatting) -> ResponseResult 'TextDocumentFormatting

PluginRequestMethod 'TextDocumentHover

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentHover -> Config -> ClientCapabilities -> MessageParams 'TextDocumentHover -> NonEmpty (ResponseResult 'TextDocumentHover) -> ResponseResult 'TextDocumentHover

PluginRequestMethod 'TextDocumentPrepareCallHierarchy

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentPrepareCallHierarchy -> Config -> ClientCapabilities -> MessageParams 'TextDocumentPrepareCallHierarchy -> NonEmpty (ResponseResult 'TextDocumentPrepareCallHierarchy) -> ResponseResult 'TextDocumentPrepareCallHierarchy

PluginRequestMethod 'TextDocumentRangeFormatting

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentRangeFormatting -> Config -> ClientCapabilities -> MessageParams 'TextDocumentRangeFormatting -> NonEmpty (ResponseResult 'TextDocumentRangeFormatting) -> ResponseResult 'TextDocumentRangeFormatting

PluginRequestMethod 'TextDocumentReferences

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentReferences -> Config -> ClientCapabilities -> MessageParams 'TextDocumentReferences -> NonEmpty (ResponseResult 'TextDocumentReferences) -> ResponseResult 'TextDocumentReferences

PluginRequestMethod 'TextDocumentRename

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentRename -> Config -> ClientCapabilities -> MessageParams 'TextDocumentRename -> NonEmpty (ResponseResult 'TextDocumentRename) -> ResponseResult 'TextDocumentRename

PluginRequestMethod 'TextDocumentSelectionRange

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentSelectionRange -> Config -> ClientCapabilities -> MessageParams 'TextDocumentSelectionRange -> NonEmpty (ResponseResult 'TextDocumentSelectionRange) -> ResponseResult 'TextDocumentSelectionRange

PluginRequestMethod 'TextDocumentTypeDefinition

Defined in Ide.Types

Methods

combineResponses :: SMethod 'TextDocumentTypeDefinition -> Config -> ClientCapabilities -> MessageParams 'TextDocumentTypeDefinition -> NonEmpty (ResponseResult 'TextDocumentTypeDefinition) -> ResponseResult 'TextDocumentTypeDefinition

PluginRequestMethod 'WorkspaceSymbol

Defined in Ide.Types

Methods

combineResponses :: SMethod 'WorkspaceSymbol -> Config -> ClientCapabilities -> MessageParams 'WorkspaceSymbol -> NonEmpty (ResponseResult 'WorkspaceSymbol) -> ResponseResult 'WorkspaceSymbol

PluginRequestMethod ('CustomMethod :: Method 'FromClient 'Request)

Defined in Ide.Types

Methods

combineResponses :: SMethod 'CustomMethod -> Config -> ClientCapabilities -> MessageParams 'CustomMethod -> NonEmpty (ResponseResult 'CustomMethod) -> ResponseResult 'CustomMethod

getProcessID :: IO Int

getPid :: IO Text

Get the operating system process id for the running server instance. This should be the same for the lifetime of the instance, and different from that of any other currently running instance.

installSigUsr1Handler :: IO () -> IO ()

responseError :: Text -> ResponseError

lookupCommandProvider :: IdePlugins ideState -> CommandId -> Maybe PluginId