Development.IDE.Plugin.Completions.Types

Documentation

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

• itemFile :: Uri
• itemNeedsType :: Bool

  Do we need to lookup a type for this item?

• itemName :: NameDetails

Instances

FromJSON CompletionResolveData

Defined in Development.IDE.Plugin.Completions.Types

Methods

parseJSON :: Value -> Parser CompletionResolveData

parseJSONList :: Value -> Parser [CompletionResolveData]

ToJSON CompletionResolveData

Defined in Development.IDE.Plugin.Completions.Types

Methods

toJSON :: CompletionResolveData -> Value

toEncoding :: CompletionResolveData -> Encoding

toJSONList :: [CompletionResolveData] -> Value

toEncodingList :: [CompletionResolveData] -> Encoding

Generic CompletionResolveData

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep CompletionResolveData :: Type -> Type

Methods

from :: CompletionResolveData -> Rep CompletionResolveData x

to :: Rep CompletionResolveData x -> CompletionResolveData

type Rep CompletionResolveData

Defined in Development.IDE.Plugin.Completions.Types

type Rep CompletionResolveData = D1 ('MetaData "CompletionResolveData" "Development.IDE.Plugin.Completions.Types" "ghcide-2.5.0.0-FXD8of4zg5MGRRhTNvOFwl" '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))))

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

Instances

FromJSON NameDetails

Defined in Development.IDE.Plugin.Completions.Types

Methods

parseJSON :: Value -> Parser NameDetails

parseJSONList :: Value -> Parser [NameDetails]

ToJSON NameDetails

Defined in Development.IDE.Plugin.Completions.Types

Methods

toJSON :: NameDetails -> Value

toEncoding :: NameDetails -> Encoding

toJSONList :: [NameDetails] -> Value

toEncodingList :: [NameDetails] -> Encoding

Show NameDetails

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> NameDetails -> ShowS

show :: NameDetails -> String

showList :: [NameDetails] -> ShowS

Eq NameDetails

Defined in Development.IDE.Plugin.Completions.Types

Methods

(==) :: NameDetails -> NameDetails -> Bool

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

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

Show PosPrefixInfo

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> PosPrefixInfo -> ShowS

show :: PosPrefixInfo -> String

showList :: [PosPrefixInfo] -> ShowS

Eq PosPrefixInfo

Defined in Development.IDE.Plugin.Completions.Types

Methods

(==) :: PosPrefixInfo -> PosPrefixInfo -> Bool

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

data CachedCompletions

End result of the completions

Constructors

CC

Fields

• allModNamesAsNS :: [Text]

  All module names in scope. Prelude is a single module

• unqualCompls :: [CompItem]

  Unqualified completion items

• qualCompls :: QualCompls

  Completion items associated to to a specific module name.

• anyQualCompls :: [Maybe Text -> CompItem]

  Items associated to any qualifier

• importableModules :: [Text]

  All modules that may be imported.

Instances

Monoid CachedCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

mempty :: CachedCompletions

mappend :: CachedCompletions -> CachedCompletions -> CachedCompletions

mconcat :: [CachedCompletions] -> CachedCompletions

Semigroup CachedCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

(<>) :: CachedCompletions -> CachedCompletions -> CachedCompletions

sconcat :: NonEmpty CachedCompletions -> CachedCompletions

stimes :: Integral b => b -> CachedCompletions -> CachedCompletions

Show CachedCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> CachedCompletions -> ShowS

show :: CachedCompletions -> String

showList :: [CachedCompletions] -> ShowS

NFData CachedCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

rnf :: CachedCompletions -> ()

newtype QualCompls

Constructors

QualCompls

Fields

• getQualCompls :: Map Text [CompItem]

Instances

Monoid QualCompls

Defined in Development.IDE.Plugin.Completions.Types

Methods

mempty :: QualCompls

mappend :: QualCompls -> QualCompls -> QualCompls

mconcat :: [QualCompls] -> QualCompls

Semigroup QualCompls

Defined in Development.IDE.Plugin.Completions.Types

Methods

(<>) :: QualCompls -> QualCompls -> QualCompls

sconcat :: NonEmpty QualCompls -> QualCompls

stimes :: Integral b => b -> QualCompls -> QualCompls

Show QualCompls

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> QualCompls -> ShowS

show :: QualCompls -> String

showList :: [QualCompls] -> ShowS

data CompItem

Constructors

CI

Fields

• compKind :: CompletionItemKind
• insertText :: Text

  Snippet for the completion

• provenance :: Provenance

  From where this item is imported from.

• label :: Text

  Label to display to the user.

• typeText :: Maybe Text
• isInfix :: Maybe Backtick

  Did the completion happen in the context of an infix notation.

• isTypeCompl :: Bool
• additionalTextEdits :: Maybe ExtendImport
• nameDetails :: Maybe NameDetails

  For resolving purposes

• isLocalCompletion :: Bool

  Is it from this module?

Instances

Show CompItem

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> CompItem -> ShowS

show :: CompItem -> String

showList :: [CompItem] -> ShowS

Eq CompItem

Defined in Development.IDE.Plugin.Completions.Types

Methods

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

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

data Provenance

Constructors

ImportedFrom Text

DefinedIn Text

Local SrcSpan

Instances

Show Provenance

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> Provenance -> ShowS

show :: Provenance -> String

showList :: [Provenance] -> ShowS

Eq Provenance

Defined in Development.IDE.Plugin.Completions.Types

Methods

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

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

Ord Provenance

Defined in Development.IDE.Plugin.Completions.Types

Methods

compare :: Provenance -> Provenance -> Ordering

(<) :: Provenance -> Provenance -> Bool

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

(>) :: Provenance -> Provenance -> Bool

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

max :: Provenance -> Provenance -> Provenance

min :: Provenance -> Provenance -> Provenance

data ExtendImport

Constructors

ExtendImport

Fields

• doc :: !Uri
• newThing :: !Text
• thingParent :: !(Maybe Text)
• importName :: !Text
• importQual :: !(Maybe Text)

Instances

FromJSON ExtendImport

Defined in Development.IDE.Plugin.Completions.Types

Methods

parseJSON :: Value -> Parser ExtendImport

parseJSONList :: Value -> Parser [ExtendImport]

ToJSON ExtendImport

Defined in Development.IDE.Plugin.Completions.Types

Methods

toJSON :: ExtendImport -> Value

toEncoding :: ExtendImport -> Encoding

toJSONList :: [ExtendImport] -> Value

toEncodingList :: [ExtendImport] -> Encoding

Generic ExtendImport

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep ExtendImport :: Type -> Type

Methods

from :: ExtendImport -> Rep ExtendImport x

to :: Rep ExtendImport x -> ExtendImport

Show ExtendImport

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> ExtendImport -> ShowS

show :: ExtendImport -> String

showList :: [ExtendImport] -> ShowS

Eq ExtendImport

Defined in Development.IDE.Plugin.Completions.Types

Methods

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

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

type Rep ExtendImport

Defined in Development.IDE.Plugin.Completions.Types

type Rep ExtendImport = D1 ('MetaData "ExtendImport" "Development.IDE.Plugin.Completions.Types" "ghcide-2.5.0.0-FXD8of4zg5MGRRhTNvOFwl" '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 CompletionsConfig

Constructors

CompletionsConfig

Fields

• enableSnippets :: Bool
• enableAutoExtend :: Bool
• maxCompletions :: Int

data Backtick

Constructors

Surrounded

LeftSide

Instances

Show Backtick

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> Backtick -> ShowS

show :: Backtick -> String

showList :: [Backtick] -> ShowS

Eq Backtick

Defined in Development.IDE.Plugin.Completions.Types

Methods

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

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

Ord Backtick

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 NonLocalCompletions

Constructors

NonLocalCompletions

Instances

Generic NonLocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep NonLocalCompletions :: Type -> Type

Methods

from :: NonLocalCompletions -> Rep NonLocalCompletions x

to :: Rep NonLocalCompletions x -> NonLocalCompletions

Show NonLocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> NonLocalCompletions -> ShowS

show :: NonLocalCompletions -> String

showList :: [NonLocalCompletions] -> ShowS

NFData NonLocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

rnf :: NonLocalCompletions -> ()

Eq NonLocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

(==) :: NonLocalCompletions -> NonLocalCompletions -> Bool

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

Hashable NonLocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

hashWithSalt :: Int -> NonLocalCompletions -> Int

hash :: NonLocalCompletions -> Int

type Rep NonLocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

type Rep NonLocalCompletions = D1 ('MetaData "NonLocalCompletions" "Development.IDE.Plugin.Completions.Types" "ghcide-2.5.0.0-FXD8of4zg5MGRRhTNvOFwl" 'False) (C1 ('MetaCons "NonLocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult NonLocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

type RuleResult NonLocalCompletions = CachedCompletions

data LocalCompletions

Constructors

LocalCompletions

Instances

Generic LocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Associated Types

type Rep LocalCompletions :: Type -> Type

Methods

from :: LocalCompletions -> Rep LocalCompletions x

to :: Rep LocalCompletions x -> LocalCompletions

Show LocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

showsPrec :: Int -> LocalCompletions -> ShowS

show :: LocalCompletions -> String

showList :: [LocalCompletions] -> ShowS

NFData LocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

rnf :: LocalCompletions -> ()

Eq LocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

(==) :: LocalCompletions -> LocalCompletions -> Bool

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

Hashable LocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

Methods

hashWithSalt :: Int -> LocalCompletions -> Int

hash :: LocalCompletions -> Int

type Rep LocalCompletions

Defined in Development.IDE.Plugin.Completions.Types

type Rep LocalCompletions = D1 ('MetaData "LocalCompletions" "Development.IDE.Plugin.Completions.Types" "ghcide-2.5.0.0-FXD8of4zg5MGRRhTNvOFwl" 'False) (C1 ('MetaCons "LocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))

type RuleResult LocalCompletions

Produce completions info for a file

Defined in Development.IDE.Plugin.Completions.Types

type RuleResult LocalCompletions = CachedCompletions

extendImportCommandId :: Text

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

nsJSON :: NameSpace -> Value

parseNs :: Value -> Parser NameSpace