Ide.Types

Documentation

newtype IdePlugins ideState

Constructors

IdePlugins

Fields

• ipMap :: [(PluginId, PluginDescriptor ideState)]

Instances

Semigroup (IdePlugins ideState)

Defined in Ide.Types

Methods

(<>) :: IdePlugins ideState -> IdePlugins ideState -> IdePlugins ideState

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

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

Monoid (IdePlugins ideState)

Defined in Ide.Types

Methods

mempty :: IdePlugins ideState

mappend :: IdePlugins ideState -> IdePlugins ideState -> IdePlugins ideState

mconcat :: [IdePlugins ideState] -> IdePlugins ideState

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

Semigroup DynFlagsModifications

Defined in Ide.Types

Methods

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

sconcat :: NonEmpty DynFlagsModifications -> DynFlagsModifications

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

Monoid DynFlagsModifications

Defined in Ide.Types

Methods

mempty :: DynFlagsModifications

mappend :: DynFlagsModifications -> DynFlagsModifications -> DynFlagsModifications

mconcat :: [DynFlagsModifications] -> DynFlagsModifications

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 PluginDescriptor ideState

Constructors

PluginDescriptor

Fields

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

data CustomConfig

An existential wrapper of Properties

Constructors

forall r. CustomConfig (Properties r)

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

• configEnableGenericConfig :: Bool

  Whether or not to generate generic configs.

• 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.

mkCustomConfig :: Properties r -> CustomConfig

defaultConfigDescriptor :: ConfigDescriptor

class HasTracing (MessageParams m) => PluginMethod m 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

pluginEnabled

Methods

pluginEnabled :: SMethod m -> PluginId -> Config -> Bool

Parse the configuration to check if this plugin is enabled

combineResponses

Arguments

:: SMethod m

-> Config

IDE Configuration

-> ClientCapabilities

-> MessageParams m

-> NonEmpty (ResponseResult m)

-> ResponseResult m

How to combine responses from different plugins

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

Instances

PluginMethod 'CallHierarchyOutgoingCalls

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'CallHierarchyOutgoingCalls -> PluginId -> Config -> Bool

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

PluginMethod 'CallHierarchyIncomingCalls

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'CallHierarchyIncomingCalls -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentPrepareCallHierarchy

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentPrepareCallHierarchy -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentSelectionRange

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentSelectionRange -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentRename

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentRename -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentRangeFormatting

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentRangeFormatting -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentFormatting

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentFormatting -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentCodeLens

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentCodeLens -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentCodeAction

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentCodeAction -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentDocumentSymbol

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentDocumentSymbol -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentHover

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentHover -> PluginId -> Config -> Bool

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

PluginMethod 'TextDocumentCompletion

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'TextDocumentCompletion -> PluginId -> Config -> Bool

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

PluginMethod ('CustomMethod :: Method f 'Request)

Defined in Ide.Types

Methods

pluginEnabled :: SMethod 'CustomMethod -> PluginId -> Config -> Bool

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

data IdeMethod (m :: Method FromClient Request)

Methods which have a PluginMethod instance

Constructors

PluginMethod m => IdeMethod (SMethod m)

Instances

GEq IdeMethod

Defined in Ide.Types

Methods

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

GCompare IdeMethod

Defined in Ide.Types

Methods

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

data IdeNotification (m :: Method FromClient Notification)

Methods which have a PluginMethod instance

Constructors

HasTracing (MessageParams m) => IdeNotification (SMethod m)

Instances

GEq IdeNotification

Defined in Ide.Types

Methods

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

GCompare IdeNotification

Defined in Ide.Types

Methods

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

newtype PluginHandler a (m :: Method FromClient Request)

Combine handlers for the

Constructors

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

newtype PluginNotificationHandler a (m :: Method FromClient Notification)

Constructors

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

newtype PluginHandlers a

Constructors

PluginHandlers (DMap IdeMethod (PluginHandler a))

Instances

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

Monoid (PluginHandlers a)

Defined in Ide.Types

Methods

mempty :: PluginHandlers a

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

mconcat :: [PluginHandlers a] -> PluginHandlers a

newtype PluginNotificationHandlers a

Constructors

PluginNotificationHandlers (DMap IdeNotification (PluginNotificationHandler a))

Instances

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

Monoid (PluginNotificationHandlers a)

Defined in Ide.Types

Methods

mempty :: PluginNotificationHandlers a

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

mconcat :: [PluginNotificationHandlers a] -> PluginNotificationHandlers a

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

type PluginNotificationMethodHandler a m = a -> VFS -> PluginId -> MessageParams m -> LspM Config ()

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

Make a handler for plugins with no extra data

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

Make a handler for plugins with no extra data

defaultPluginDescriptor :: PluginId -> PluginDescriptor ideState

newtype CommandId

Constructors

CommandId Text

Instances

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

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

IsString CommandId

Defined in Ide.Types

Methods

fromString :: String -> CommandId

data PluginCommand ideState

Constructors

forall a.FromJSON a => PluginCommand

Fields

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

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

newtype PluginId

Constructors

PluginId Text

Instances

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

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

IsString PluginId

Defined in Ide.Types

Methods

fromString :: String -> PluginId

configForPlugin :: Config -> PluginId -> PluginConfig

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

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

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

responseError :: Text -> ResponseError

data FallbackCodeActionParams

Constructors

FallbackCodeActionParams

Fields

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

Instances

Generic FallbackCodeActionParams

Defined in Ide.Types

Associated Types

type Rep FallbackCodeActionParams :: Type -> Type

Methods

from :: FallbackCodeActionParams -> Rep FallbackCodeActionParams x

to :: Rep FallbackCodeActionParams x -> FallbackCodeActionParams

ToJSON FallbackCodeActionParams

Defined in Ide.Types

Methods

toJSON :: FallbackCodeActionParams -> Value

toEncoding :: FallbackCodeActionParams -> Encoding

toJSONList :: [FallbackCodeActionParams] -> Value

toEncodingList :: [FallbackCodeActionParams] -> Encoding

FromJSON FallbackCodeActionParams

Defined in Ide.Types

Methods

parseJSON :: Value -> Parser FallbackCodeActionParams

parseJSONList :: Value -> Parser [FallbackCodeActionParams]

type Rep FallbackCodeActionParams

Defined in Ide.Types

type Rep FallbackCodeActionParams = D1 ('MetaData "FallbackCodeActionParams" "Ide.Types" "hls-plugin-api-1.4.0.0-D4lE1R4ksV3HdBQp6Opb7Q" '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))))

otSetUri :: SpanInFlight -> Uri -> IO ()

class HasTracing a where

Minimal complete definition

Nothing

Methods

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

Instances

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

Defined in Ide.Types

Methods

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

HasTracing Value

Defined in Ide.Types

Methods

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

HasTracing InitializeParams

Defined in Ide.Types

Methods

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

HasTracing WorkspaceSymbolParams

Defined in Ide.Types

Methods

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

HasTracing DidChangeWorkspaceFoldersParams

Defined in Ide.Types

Methods

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

HasTracing DidChangeWatchedFilesParams

Defined in Ide.Types

Methods

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

HasTracing CallHierarchyOutgoingCallsParams

Defined in Ide.Types

Methods

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

HasTracing CallHierarchyIncomingCallsParams

Defined in Ide.Types

Methods

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

HasTracing ExecuteCommandParams

Defined in Ide.Types

Methods

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

HasTracing DidChangeConfigurationParams

Defined in Ide.Types

Methods

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

HasTracing (Maybe InitializedParams)

Defined in Ide.Types

Methods

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

pROCESS_ID :: Text

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

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

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.

getProcessID :: IO Int

installSigUsr1Handler :: IO () -> IO ()