ghcide-2.9.0.0: The core of an IDE
Safe HaskellNone
LanguageGHC2021

Development.IDE.Plugin.Completions.Types

Synopsis

Documentation

data CompItem #

Constructors

CI 

Fields

Instances

Instances details
Show CompItem # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Eq CompItem # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

data CachedCompletions #

End result of the completions

Constructors

CC 

Fields

data ExtendImport #

Constructors

ExtendImport 

Instances

Instances details
FromJSON ExtendImport # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

ToJSON ExtendImport # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Generic ExtendImport # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep ExtendImport 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep ExtendImport = D1 ('MetaData "ExtendImport" "Development.IDE.Plugin.Completions.Types" "ghcide-2.9.0.0-1G3u1vh8JKWDpMQ8kfXrG1" 'False) (C1 ('MetaCons "ExtendImport" 'PrefixI 'True) ((S1 ('MetaSel ('Just "doc") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Uri) :*: S1 ('MetaSel ('Just "newThing") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "thingParent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "importName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "importQual") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))))))
Show ExtendImport # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Eq ExtendImport # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep ExtendImport # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep ExtendImport = D1 ('MetaData "ExtendImport" "Development.IDE.Plugin.Completions.Types" "ghcide-2.9.0.0-1G3u1vh8JKWDpMQ8kfXrG1" 'False) (C1 ('MetaCons "ExtendImport" 'PrefixI 'True) ((S1 ('MetaSel ('Just "doc") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Uri) :*: S1 ('MetaSel ('Just "newThing") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "thingParent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "importName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "importQual") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))))))

properties :: Properties '['PropertyKey "autoExtendOn" 'TBoolean, 'PropertyKey "snippetsOn" 'TBoolean] #

data LocalCompletions #

Constructors

LocalCompletions 

Instances

Instances details
NFData LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

rnf :: LocalCompletions -> () #

Generic LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep LocalCompletions 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep LocalCompletions = D1 ('MetaData "LocalCompletions" "Development.IDE.Plugin.Completions.Types" "ghcide-2.9.0.0-1G3u1vh8JKWDpMQ8kfXrG1" 'False) (C1 ('MetaCons "LocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))
Show LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Eq LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Hashable LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep LocalCompletions = D1 ('MetaData "LocalCompletions" "Development.IDE.Plugin.Completions.Types" "ghcide-2.9.0.0-1G3u1vh8JKWDpMQ8kfXrG1" 'False) (C1 ('MetaCons "LocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult LocalCompletions #

Produce completions info for a file

Instance details

Defined in Development.IDE.Plugin.Completions.Types

data NonLocalCompletions #

Constructors

NonLocalCompletions 

Instances

Instances details
NFData NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

rnf :: NonLocalCompletions -> () #

Generic NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep NonLocalCompletions 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep NonLocalCompletions = D1 ('MetaData "NonLocalCompletions" "Development.IDE.Plugin.Completions.Types" "ghcide-2.9.0.0-1G3u1vh8JKWDpMQ8kfXrG1" 'False) (C1 ('MetaCons "NonLocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))
Show NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Eq NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Hashable NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep NonLocalCompletions = D1 ('MetaData "NonLocalCompletions" "Development.IDE.Plugin.Completions.Types" "ghcide-2.9.0.0-1G3u1vh8JKWDpMQ8kfXrG1" 'False) (C1 ('MetaCons "NonLocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

data NameDetails #

This is a JSON serialisable representation of a GHC Name that we include in completion responses so that we can recover the original name corresponding to the completion item. This is used to resolve additional details on demand about the item like its type and documentation.

Constructors

NameDetails Module OccName 

data PosPrefixInfo #

Describes the line at the current cursor position

Constructors

PosPrefixInfo 

Fields

  • fullLine :: !Text

    The full contents of the line the cursor is at

  • prefixScope :: !Text

    If any, the module name that was typed right before the cursor position. For example, if the user has typed "Data.Maybe.from", then this property will be Data.Maybe If OverloadedRecordDot is enabled, "Shape.rect.width" will be "Shape.rect"

  • prefixText :: !Text

    The word right before the cursor position, after removing the module part. For example if the user has typed "Data.Maybe.from", then this property will be "from"

  • cursorPos :: !Position

    The cursor position

data CompletionResolveData #

The data that is actually sent for resolve support We need the URI to be able to reconstruct the GHC environment in the file the completion was triggered in.

Constructors

CompletionResolveData 

Fields

Instances

Instances details
FromJSON CompletionResolveData # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

ToJSON CompletionResolveData # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Generic CompletionResolveData # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep CompletionResolveData 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep CompletionResolveData = D1 ('MetaData "CompletionResolveData" "Development.IDE.Plugin.Completions.Types" "ghcide-2.9.0.0-1G3u1vh8JKWDpMQ8kfXrG1" 'False) (C1 ('MetaCons "CompletionResolveData" 'PrefixI 'True) (S1 ('MetaSel ('Just "itemFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uri) :*: (S1 ('MetaSel ('Just "itemNeedsType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "itemName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NameDetails))))
type Rep CompletionResolveData # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

type Rep CompletionResolveData = D1 ('MetaData "CompletionResolveData" "Development.IDE.Plugin.Completions.Types" "ghcide-2.9.0.0-1G3u1vh8JKWDpMQ8kfXrG1" 'False) (C1 ('MetaCons "CompletionResolveData" 'PrefixI 'True) (S1 ('MetaSel ('Just "itemFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uri) :*: (S1 ('MetaSel ('Just "itemNeedsType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "itemName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NameDetails))))