Safe Haskell	None
Language	Haskell2010

Development.IDE.Plugin.Completions.Types

Synopsis

data CachedCompletions = CC {
- allModNamesAsNS :: [Text]
- unqualCompls :: [CompItem]
- qualCompls :: QualCompls
- anyQualCompls :: [Maybe Text -> CompItem]
- importableModules :: [Text]
}
newtype QualCompls = QualCompls {
- getQualCompls :: Map Text [CompItem]
}
data CompItem = CI {
- compKind :: CompletionItemKind
- insertText :: Text
- provenance :: Provenance
- typeText :: Maybe Text
- label :: Text
- isInfix :: Maybe Backtick
- docs :: SpanDoc
- isTypeCompl :: Bool
- additionalTextEdits :: Maybe ExtendImport
}
data Provenance
- = ImportedFrom Text
- | DefinedIn Text
- | Local SrcSpan
data ExtendImport = ExtendImport {
- doc :: !Uri
- newThing :: !Text
- thingParent :: !(Maybe Text)
- importName :: !Text
- importQual :: !(Maybe Text)
}
data CompletionsConfig = CompletionsConfig {
- enableSnippets :: Bool
- enableAutoExtend :: Bool
- maxCompletions :: Int
}
data Backtick
- = Surrounded
- | LeftSide
data NonLocalCompletions = NonLocalCompletions
data LocalCompletions = LocalCompletions
extendImportCommandId :: Text
properties :: Properties '['PropertyKey "autoExtendOn" 'TBoolean, 'PropertyKey "snippetsOn" 'TBoolean]
getCompletionsConfig :: MonadLsp Config m => PluginId -> m CompletionsConfig

Documentation

data CachedCompletions Source #

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

Instances details

Show CachedCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods showsPrec :: Int -> CachedCompletions -> ShowS # show :: CachedCompletions -> String # showList :: [CachedCompletions] -> ShowS #
Semigroup CachedCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods (<>) :: CachedCompletions -> CachedCompletions -> CachedCompletions # sconcat :: NonEmpty CachedCompletions -> CachedCompletions # stimes :: Integral b => b -> CachedCompletions -> CachedCompletions #
Monoid CachedCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods mempty :: CachedCompletions # mappend :: CachedCompletions -> CachedCompletions -> CachedCompletions # mconcat :: [CachedCompletions] -> CachedCompletions #
NFData CachedCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods rnf :: CachedCompletions -> () #

newtype QualCompls Source #

Constructors

QualCompls
Fields getQualCompls :: Map Text [CompItem]

Instances

Instances details

Show QualCompls Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods showsPrec :: Int -> QualCompls -> ShowS # show :: QualCompls -> String # showList :: [QualCompls] -> ShowS #
Semigroup QualCompls Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods (<>) :: QualCompls -> QualCompls -> QualCompls # sconcat :: NonEmpty QualCompls -> QualCompls # stimes :: Integral b => b -> QualCompls -> QualCompls #
Monoid QualCompls Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods mempty :: QualCompls # mappend :: QualCompls -> QualCompls -> QualCompls # mconcat :: [QualCompls] -> QualCompls #

data CompItem Source #

Constructors

CI

Fields

compKind :: CompletionItemKind
insertText :: Text
Snippet for the completion
provenance :: Provenance
From where this item is imported from.
typeText :: Maybe Text
Available type information.
label :: Text
Label to display to the user.
isInfix :: Maybe Backtick
Did the completion happen in the context of an infix notation.
docs :: SpanDoc
Available documentation.
isTypeCompl :: Bool
additionalTextEdits :: Maybe ExtendImport

Instances

Instances details

Eq CompItem Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods (==) :: CompItem -> CompItem -> Bool # (/=) :: CompItem -> CompItem -> Bool #
Show CompItem Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods showsPrec :: Int -> CompItem -> ShowS # show :: CompItem -> String # showList :: [CompItem] -> ShowS #

data Provenance Source #

Constructors

ImportedFrom Text
DefinedIn Text
Local SrcSpan

Instances

Instances details

Eq Provenance Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods (==) :: Provenance -> Provenance -> Bool # (/=) :: Provenance -> Provenance -> Bool #
Ord Provenance Source #
Instance details 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 #
Show Provenance Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods showsPrec :: Int -> Provenance -> ShowS # show :: Provenance -> String # showList :: [Provenance] -> ShowS #

data ExtendImport Source #

Constructors

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

Instances

Instances details

Eq ExtendImport Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods (==) :: ExtendImport -> ExtendImport -> Bool # (/=) :: ExtendImport -> ExtendImport -> Bool #
Show ExtendImport Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods showsPrec :: Int -> ExtendImport -> ShowS # show :: ExtendImport -> String # showList :: [ExtendImport] -> ShowS #
Generic ExtendImport Source #
Instance details 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 #
ToJSON ExtendImport Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods toJSON :: ExtendImport -> Value # toEncoding :: ExtendImport -> Encoding # toJSONList :: [ExtendImport] -> Value # toEncodingList :: [ExtendImport] -> Encoding #
FromJSON ExtendImport Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods parseJSON :: Value -> Parser ExtendImport # parseJSONList :: Value -> Parser [ExtendImport] #
type Rep ExtendImport Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types type Rep ExtendImport = D1 ('MetaData "ExtendImport" "Development.IDE.Plugin.Completions.Types" "ghcide-1.6.0.0-6rn0EpOlTRZ4j4Z1t1BPzW" '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 Source #

Constructors

CompletionsConfig
Fields enableSnippets :: Bool enableAutoExtend :: Bool maxCompletions :: Int

data Backtick Source #

Constructors

Surrounded
LeftSide

Instances

Instances details

Eq Backtick Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods (==) :: Backtick -> Backtick -> Bool # (/=) :: Backtick -> Backtick -> Bool #
Ord Backtick Source #
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 #
Show Backtick Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods showsPrec :: Int -> Backtick -> ShowS # show :: Backtick -> String # showList :: [Backtick] -> ShowS #

data NonLocalCompletions Source #

Constructors

NonLocalCompletions

Instances

Instances details

Eq NonLocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods (==) :: NonLocalCompletions -> NonLocalCompletions -> Bool # (/=) :: NonLocalCompletions -> NonLocalCompletions -> Bool #
Show NonLocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods showsPrec :: Int -> NonLocalCompletions -> ShowS # show :: NonLocalCompletions -> String # showList :: [NonLocalCompletions] -> ShowS #
Generic NonLocalCompletions Source #
Instance details 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 #
Hashable NonLocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods hashWithSalt :: Int -> NonLocalCompletions -> Int # hash :: NonLocalCompletions -> Int #
NFData NonLocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods rnf :: NonLocalCompletions -> () #
type Rep NonLocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types type Rep NonLocalCompletions = D1 ('MetaData "NonLocalCompletions" "Development.IDE.Plugin.Completions.Types" "ghcide-1.6.0.0-6rn0EpOlTRZ4j4Z1t1BPzW" 'False) (C1 ('MetaCons "NonLocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult NonLocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types type RuleResult NonLocalCompletions = CachedCompletions

data LocalCompletions Source #

Constructors

LocalCompletions

Instances

Instances details

Eq LocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods (==) :: LocalCompletions -> LocalCompletions -> Bool # (/=) :: LocalCompletions -> LocalCompletions -> Bool #
Show LocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods showsPrec :: Int -> LocalCompletions -> ShowS # show :: LocalCompletions -> String # showList :: [LocalCompletions] -> ShowS #
Generic LocalCompletions Source #
Instance details 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 #
Hashable LocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods hashWithSalt :: Int -> LocalCompletions -> Int # hash :: LocalCompletions -> Int #
NFData LocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types Methods rnf :: LocalCompletions -> () #
type Rep LocalCompletions Source #
Instance details Defined in Development.IDE.Plugin.Completions.Types type Rep LocalCompletions = D1 ('MetaData "LocalCompletions" "Development.IDE.Plugin.Completions.Types" "ghcide-1.6.0.0-6rn0EpOlTRZ4j4Z1t1BPzW" 'False) (C1 ('MetaCons "LocalCompletions" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult LocalCompletions Source #	Produce completions info for a file
Instance details Defined in Development.IDE.Plugin.Completions.Types type RuleResult LocalCompletions = CachedCompletions

extendImportCommandId :: Text Source #

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

getCompletionsConfig :: MonadLsp Config m => PluginId -> m CompletionsConfig Source #