Wingman.AbstractLSP.Types

Documentation

data Interaction where

An Interaction is an existential Continuation, which handles both sides of the request/response interaction for LSP.

Constructors

Interaction :: (IsTarget target, IsContinuationSort sort, ToJSON b, FromJSON b) => Continuation sort target b -> Interaction

data Metadata

Metadata for a command. Used by both code actions and lenses, though for lenses, only md_title is currently used.

Constructors

Metadata

Fields

• md_title :: Text
• md_kind :: CodeActionKind
• md_preferred :: Bool

Instances

Eq Metadata

Defined in Wingman.AbstractLSP.Types

Methods

(==) :: Metadata -> Metadata -> Bool

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

Show Metadata

Defined in Wingman.AbstractLSP.Types

Methods

showsPrec :: Int -> Metadata -> ShowS

show :: Metadata -> String

showList :: [Metadata] -> ShowS

data SynthesizeCommand a b

Whether we're defining a CodeAction or CodeLens.

Constructors

SynthesizeCodeAction (LspEnv -> TargetArgs a -> MaybeT (LspM Config) [(Metadata, b)])

SynthesizeCodeLens (LspEnv -> TargetArgs a -> MaybeT (LspM Config) [(Range, Metadata, b)])

class IsContinuationSort a where

Transform a "continuation sort" into a CommandId.

Methods

toCommandId :: a -> CommandId

Instances

IsContinuationSort Text

Defined in Wingman.AbstractLSP.Types

Methods

toCommandId :: Text -> CommandId

IsContinuationSort CommandId

Defined in Wingman.AbstractLSP.Types

Methods

toCommandId :: CommandId -> CommandId

IsContinuationSort TacticCommand

Defined in Wingman.LanguageServer.TacticProviders

Methods

toCommandId :: TacticCommand -> CommandId

IsContinuationSort EmptyCaseT

Defined in Wingman.EmptyCase

Methods

toCommandId :: EmptyCaseT -> CommandId

data ContinuationResult

Ways a Continuation can resolve.

Constructors

ErrorMessages [UserFacingMessage]

Produce some error messages.

RawEdit WorkspaceEdit

Produce an explicit WorkspaceEdit.

GraftEdit (Graft (Either String) ParsedSource)

Produce a Graft, corresponding to a transformation of the current AST.

data Continuation sort target payload

A Continuation is a single object corresponding to an action that users can take via LSP. It generalizes codeactions and codelenses, allowing for a significant amount of code reuse.

Given Continuation sort target payload:

the sort corresponds to a CommandId, allowing you to namespace actions rather than working directly with text. This functionality is driven via IsContinuationSort.

the target is used to fetch data from LSP on both sides of the request/response barrier. For example, you can use it to resolve what node in the AST the incoming range refers to. This functionality is driven via IsTarget.

the payload is used for data you'd explicitly like to send from the request to the response. It's like target, but only gets computed once. This is beneficial if you can do it, but requires that your data is serializable via JSON.

Constructors

Continuation

Fields

• c_sort :: sort
• c_makeCommand :: SynthesizeCommand target payload
• c_runCommand :: LspEnv -> TargetArgs target -> FileContext -> payload -> MaybeT (LspM Config) [ContinuationResult]

data FileContext

What file are we looking at, and what bit of it?

Constructors

FileContext

Fields

• fc_uri :: Uri
• fc_range :: Maybe (Tracked 'Current Range)

  For code actions, this is Just. For code lenses, you'll get a Nothing in the request, and a Just in the response.

Instances

Eq FileContext

Defined in Wingman.AbstractLSP.Types

Methods

(==) :: FileContext -> FileContext -> Bool

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

Ord FileContext

Defined in Wingman.AbstractLSP.Types

Methods

compare :: FileContext -> FileContext -> Ordering

(<) :: FileContext -> FileContext -> Bool

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

(>) :: FileContext -> FileContext -> Bool

(>=) :: FileContext -> FileContext -> Bool

max :: FileContext -> FileContext -> FileContext

min :: FileContext -> FileContext -> FileContext

Show FileContext

Defined in Wingman.AbstractLSP.Types

Methods

showsPrec :: Int -> FileContext -> ShowS

show :: FileContext -> String

showList :: [FileContext] -> ShowS

Generic FileContext

Defined in Wingman.AbstractLSP.Types

Associated Types

type Rep FileContext :: Type -> Type

Methods

from :: FileContext -> Rep FileContext x

to :: Rep FileContext x -> FileContext

ToJSON FileContext

Defined in Wingman.AbstractLSP.Types

Methods

toJSON :: FileContext -> Value

toEncoding :: FileContext -> Encoding

toJSONList :: [FileContext] -> Value

toEncodingList :: [FileContext] -> Encoding

FromJSON FileContext

Defined in Wingman.AbstractLSP.Types

Methods

parseJSON :: Value -> Parser FileContext

parseJSONList :: Value -> Parser [FileContext]

type Rep FileContext

Defined in Wingman.AbstractLSP.Types

type Rep FileContext = D1 ('MetaData "FileContext" "Wingman.AbstractLSP.Types" "hls-tactics-plugin-1.6.2.0-2EBx0y4aTAr9z5wB8w8nAU" 'False) (C1 ('MetaCons "FileContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "fc_uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uri) :*: S1 ('MetaSel ('Just "fc_range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Tracked 'Current Range)))))

data LspEnv

Everything we need to resolve continuations.

Constructors

LspEnv

Fields

• le_ideState :: IdeState
• le_pluginId :: PluginId
• le_dflags :: DynFlags
• le_config :: Config
• le_fileContext :: FileContext

class IsTarget t where

Extract some information from LSP, so it can be passed to the requests and responses of a Continuation.

Associated Types

type TargetArgs t

Methods

fetchTargetArgs :: LspEnv -> MaybeT (LspM Config) (TargetArgs t)

Instances

IsTarget HoleTarget

Defined in Wingman.AbstractLSP.Types

Associated Types

type TargetArgs HoleTarget

Methods

fetchTargetArgs :: LspEnv -> MaybeT (LspM Config) (TargetArgs HoleTarget)

IsTarget EmptyCaseT

Defined in Wingman.EmptyCase

Associated Types

type TargetArgs EmptyCaseT

Methods

fetchTargetArgs :: LspEnv -> MaybeT (LspM Config) (TargetArgs EmptyCaseT)

data HoleTarget

A HoleTarget is a target (see IsTarget) which succeeds if the given range is an HsExpr hole. It gives continuations access to the resulting tactic judgement.

Constructors

HoleTarget

Instances

Bounded HoleTarget

Defined in Wingman.AbstractLSP.Types

Methods

minBound :: HoleTarget

maxBound :: HoleTarget

Enum HoleTarget

Defined in Wingman.AbstractLSP.Types

Methods

succ :: HoleTarget -> HoleTarget

pred :: HoleTarget -> HoleTarget

toEnum :: Int -> HoleTarget

fromEnum :: HoleTarget -> Int

enumFrom :: HoleTarget -> [HoleTarget]

enumFromThen :: HoleTarget -> HoleTarget -> [HoleTarget]

enumFromTo :: HoleTarget -> HoleTarget -> [HoleTarget]

enumFromThenTo :: HoleTarget -> HoleTarget -> HoleTarget -> [HoleTarget]

Eq HoleTarget

Defined in Wingman.AbstractLSP.Types

Methods

(==) :: HoleTarget -> HoleTarget -> Bool

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

Ord HoleTarget

Defined in Wingman.AbstractLSP.Types

Methods

compare :: HoleTarget -> HoleTarget -> Ordering

(<) :: HoleTarget -> HoleTarget -> Bool

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

(>) :: HoleTarget -> HoleTarget -> Bool

(>=) :: HoleTarget -> HoleTarget -> Bool

max :: HoleTarget -> HoleTarget -> HoleTarget

min :: HoleTarget -> HoleTarget -> HoleTarget

Show HoleTarget

Defined in Wingman.AbstractLSP.Types

Methods

showsPrec :: Int -> HoleTarget -> ShowS

show :: HoleTarget -> String

showList :: [HoleTarget] -> ShowS

IsTarget HoleTarget

Defined in Wingman.AbstractLSP.Types

Associated Types

type TargetArgs HoleTarget

Methods

fetchTargetArgs :: LspEnv -> MaybeT (LspM Config) (TargetArgs HoleTarget)

type TargetArgs HoleTarget

Defined in Wingman.AbstractLSP.Types

type TargetArgs HoleTarget = HoleJudgment

getNfp :: Applicative m => Uri -> MaybeT m NormalizedFilePath