ghcide-2.4.0.0: The core of an IDE
Safe HaskellSafe-Inferred
LanguageHaskell2010

Development.IDE.Plugin.Completions.Types

Synopsis

Documentation

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

Instances

Instances details
Show PosPrefixInfo # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> PosPrefixInfo -> ShowS #

show :: PosPrefixInfo -> String #

showList :: [PosPrefixInfo] -> ShowS #

Eq PosPrefixInfo # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

data CachedCompletions #

End result of the completions

Constructors

CC 

Fields

data LocalCompletions #

Constructors

LocalCompletions 

Instances

Instances details
Generic LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep LocalCompletions :: Type -> Type

Show LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> LocalCompletions -> ShowS #

show :: LocalCompletions -> String #

showList :: [LocalCompletions] -> ShowS #

NFData LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

rnf :: LocalCompletions -> () #

Eq LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Hashable LocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

hashWithSalt :: Int -> LocalCompletions -> Int #

hash :: LocalCompletions -> Int #

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.4.0.0-2GLANXY6yWhIRmLZNYhiFQ" '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
Generic NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep NonLocalCompletions :: Type -> Type

Show NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

NFData NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

rnf :: NonLocalCompletions -> () #

Eq NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Hashable NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

hashWithSalt :: Int -> NonLocalCompletions -> Int #

hash :: NonLocalCompletions -> Int #

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.4.0.0-2GLANXY6yWhIRmLZNYhiFQ" 'False) (C1 ('MetaCons "NonLocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult NonLocalCompletions # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

data Backtick #

Constructors

Surrounded 
LeftSide 

Instances

Instances details
Show Backtick # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> Backtick -> ShowS #

show :: Backtick -> String #

showList :: [Backtick] -> ShowS #

Eq Backtick # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

(==) :: Backtick -> Backtick -> Bool #

(/=) :: Backtick -> Backtick -> Bool #

Ord Backtick # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

compare :: Backtick -> Backtick -> Ordering

(<) :: Backtick -> Backtick -> Bool

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

(>) :: Backtick -> Backtick -> Bool

(>=) :: Backtick -> Backtick -> Bool

max :: Backtick -> Backtick -> Backtick

min :: Backtick -> Backtick -> Backtick

data CompletionsConfig #

Constructors

CompletionsConfig 

Fields

data ExtendImport #

Constructors

ExtendImport 

Fields

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 :: Type -> Type

Show ExtendImport # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> ExtendImport -> ShowS #

show :: ExtendImport -> String #

showList :: [ExtendImport] -> ShowS #

Eq ExtendImport # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

(==) :: ExtendImport -> ExtendImport -> Bool #

(/=) :: ExtendImport -> ExtendImport -> Bool #

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.4.0.0-2GLANXY6yWhIRmLZNYhiFQ" '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))))))

data Provenance #

Instances

Instances details
Show Provenance # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> Provenance -> ShowS #

show :: Provenance -> String #

showList :: [Provenance] -> ShowS #

Eq Provenance # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

(==) :: Provenance -> Provenance -> Bool #

(/=) :: Provenance -> Provenance -> Bool #

Ord Provenance # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

data CompItem #

Constructors

CI 

Fields

Instances

Instances details
Show CompItem # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> CompItem -> ShowS #

show :: CompItem -> String #

showList :: [CompItem] -> ShowS #

Eq CompItem # 
Instance details

Defined in Development.IDE.Plugin.Completions.Types

Methods

(==) :: CompItem -> CompItem -> Bool #

(/=) :: CompItem -> CompItem -> Bool #

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 

newtype QualCompls #

Constructors

QualCompls 

Fields

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 :: Type -> Type

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.4.0.0-2GLANXY6yWhIRmLZNYhiFQ" '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))))

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