| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Language.PureScript.Ide.Types
Description
Type definitions for psc-ide
Synopsis
- type ModuleIdent = Text
- type ModuleMap a = Map ModuleName a
- data IdeDeclaration
- data IdeValue = IdeValue {}
- data IdeType = IdeType {}
- data IdeTypeSynonym = IdeTypeSynonym {}
- data IdeDataConstructor = IdeDataConstructor {}
- data IdeTypeClass = IdeTypeClass {}
- data IdeInstance = IdeInstance {}
- data IdeValueOperator = IdeValueOperator {}
- data IdeTypeOperator = IdeTypeOperator {}
- _IdeDeclValue :: Traversal' IdeDeclaration IdeValue
- _IdeDeclType :: Traversal' IdeDeclaration IdeType
- _IdeDeclTypeSynonym :: Traversal' IdeDeclaration IdeTypeSynonym
- _IdeDeclDataConstructor :: Traversal' IdeDeclaration IdeDataConstructor
- _IdeDeclTypeClass :: Traversal' IdeDeclaration IdeTypeClass
- _IdeDeclValueOperator :: Traversal' IdeDeclaration IdeValueOperator
- _IdeDeclTypeOperator :: Traversal' IdeDeclaration IdeTypeOperator
- _IdeDeclModule :: Traversal' IdeDeclaration ModuleName
- anyOf :: Getting Any s a -> (a -> Bool) -> s -> Bool
- ideValueType :: Lens' IdeValue SourceType
- ideValueIdent :: Lens' IdeValue Ident
- ideTypeName :: Lens' IdeType (ProperName 'TypeName)
- ideTypeKind :: Lens' IdeType SourceType
- ideTypeDtors :: Lens' IdeType [(ProperName 'ConstructorName, SourceType)]
- ideSynonymType :: Lens' IdeTypeSynonym SourceType
- ideSynonymName :: Lens' IdeTypeSynonym (ProperName 'TypeName)
- ideSynonymKind :: Lens' IdeTypeSynonym SourceType
- ideDtorTypeName :: Lens' IdeDataConstructor (ProperName 'TypeName)
- ideDtorType :: Lens' IdeDataConstructor SourceType
- ideDtorName :: Lens' IdeDataConstructor (ProperName 'ConstructorName)
- ideTCName :: Lens' IdeTypeClass (ProperName 'ClassName)
- ideTCKind :: Lens' IdeTypeClass SourceType
- ideTCInstances :: Lens' IdeTypeClass [IdeInstance]
- ideValueOpType :: Lens' IdeValueOperator (Maybe SourceType)
- ideValueOpPrecedence :: Lens' IdeValueOperator Precedence
- ideValueOpName :: Lens' IdeValueOperator (OpName 'ValueOpName)
- ideValueOpAssociativity :: Lens' IdeValueOperator Associativity
- ideValueOpAlias :: Lens' IdeValueOperator (Qualified (Either Ident (ProperName 'ConstructorName)))
- ideTypeOpPrecedence :: Lens' IdeTypeOperator Precedence
- ideTypeOpName :: Lens' IdeTypeOperator (OpName 'TypeOpName)
- ideTypeOpKind :: Lens' IdeTypeOperator (Maybe SourceType)
- ideTypeOpAssociativity :: Lens' IdeTypeOperator Associativity
- ideTypeOpAlias :: Lens' IdeTypeOperator (Qualified (ProperName 'TypeName))
- data IdeDeclarationAnn = IdeDeclarationAnn {}
- data Annotation = Annotation {}
- annTypeAnnotation :: Lens' Annotation (Maybe SourceType)
- annLocation :: Lens' Annotation (Maybe SourceSpan)
- annExportedFrom :: Lens' Annotation (Maybe ModuleName)
- annDocumentation :: Lens' Annotation (Maybe Text)
- idaDeclaration :: Lens' IdeDeclarationAnn IdeDeclaration
- idaAnnotation :: Lens' IdeDeclarationAnn Annotation
- emptyAnn :: Annotation
- type DefinitionSites a = Map IdeNamespaced a
- type TypeAnnotations = Map Ident SourceType
- newtype AstData a = AstData (ModuleMap (DefinitionSites a, TypeAnnotations))
- data IdeLogLevel
- = LogDebug
- | LogPerf
- | LogAll
- | LogDefault
- | LogNone
- data IdeConfiguration = IdeConfiguration {}
- data IdeEnvironment = IdeEnvironment {}
- type Ide m = (MonadIO m, MonadReader IdeEnvironment m)
- data IdeState = IdeState {}
- emptyIdeState :: IdeState
- emptyFileState :: IdeFileState
- emptyVolatileState :: IdeVolatileState
- data IdeFileState = IdeFileState {}
- data IdeVolatileState = IdeVolatileState {}
- newtype Match a = Match (ModuleName, a)
- data Completion = Completion {}
- identifierFromDeclarationRef :: DeclarationRef -> Text
- declarationType :: IdeDeclaration -> DeclarationType
- data Success
- encodeSuccess :: ToJSON a => a -> Value
- encodeImport :: (ModuleName, ImportDeclarationType, Maybe ModuleName) -> Value
- data IdeNamespace
- data IdeNamespaced = IdeNamespaced IdeNamespace Text
Documentation
type ModuleIdent = Text Source #
type ModuleMap a = Map ModuleName a Source #
data IdeDeclaration Source #
Constructors
Instances
Constructors
| IdeValue | |
Fields | |
Instances
| Generic IdeValue Source # | |
| Show IdeValue Source # | |
| NFData IdeValue Source # | |
Defined in Language.PureScript.Ide.Types | |
| Eq IdeValue Source # | |
| Ord IdeValue Source # | |
Defined in Language.PureScript.Ide.Types | |
| type Rep IdeValue Source # | |
Defined in Language.PureScript.Ide.Types type Rep IdeValue = D1 ('MetaData "IdeValue" "Language.PureScript.Ide.Types" "purescript-0.15.8-4tiSWAb69Er4UfMmbMY7A8" 'False) (C1 ('MetaCons "IdeValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ideValueIdent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Ident) :*: S1 ('MetaSel ('Just "_ideValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceType))) | |
Constructors
| IdeType | |
Fields | |
Instances
| Generic IdeType Source # | |
| Show IdeType Source # | |
| NFData IdeType Source # | |
Defined in Language.PureScript.Ide.Types | |
| Eq IdeType Source # | |
| Ord IdeType Source # | |
Defined in Language.PureScript.Ide.Types | |
| type Rep IdeType Source # | |
Defined in Language.PureScript.Ide.Types type Rep IdeType = D1 ('MetaData "IdeType" "Language.PureScript.Ide.Types" "purescript-0.15.8-4tiSWAb69Er4UfMmbMY7A8" 'False) (C1 ('MetaCons "IdeType" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ideTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProperName 'TypeName)) :*: (S1 ('MetaSel ('Just "_ideTypeKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceType) :*: S1 ('MetaSel ('Just "_ideTypeDtors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(ProperName 'ConstructorName, SourceType)])))) | |
data IdeTypeSynonym Source #
Constructors
| IdeTypeSynonym | |
Fields | |
Instances
data IdeDataConstructor Source #
Constructors
| IdeDataConstructor | |
Fields | |
Instances
data IdeTypeClass Source #
Constructors
| IdeTypeClass | |
Fields | |
Instances
data IdeInstance Source #
Constructors
| IdeInstance | |
Fields | |
Instances
data IdeValueOperator Source #
Constructors
| IdeValueOperator | |
Instances
data IdeTypeOperator Source #
Constructors
| IdeTypeOperator | |
Instances
ideTypeName :: Lens' IdeType (ProperName 'TypeName) Source #
ideValueOpAlias :: Lens' IdeValueOperator (Qualified (Either Ident (ProperName 'ConstructorName))) Source #
data IdeDeclarationAnn Source #
Constructors
| IdeDeclarationAnn | |
Fields | |
Instances
data Annotation Source #
Constructors
| Annotation | |
Instances
type DefinitionSites a = Map IdeNamespaced a Source #
type TypeAnnotations = Map Ident SourceType Source #
Constructors
| AstData (ModuleMap (DefinitionSites a, TypeAnnotations)) | SourceSpans for the definition sites of values and types as well as type annotations found in a module |
Instances
| Foldable AstData Source # | |
Defined in Language.PureScript.Ide.Types Methods fold :: Monoid m => AstData m -> m # foldMap :: Monoid m => (a -> m) -> AstData a -> m # foldMap' :: Monoid m => (a -> m) -> AstData a -> m # foldr :: (a -> b -> b) -> b -> AstData a -> b # foldr' :: (a -> b -> b) -> b -> AstData a -> b # foldl :: (b -> a -> b) -> b -> AstData a -> b # foldl' :: (b -> a -> b) -> b -> AstData a -> b # foldr1 :: (a -> a -> a) -> AstData a -> a # foldl1 :: (a -> a -> a) -> AstData a -> a # elem :: Eq a => a -> AstData a -> Bool # maximum :: Ord a => AstData a -> a # minimum :: Ord a => AstData a -> a # | |
| Functor AstData Source # | |
| Generic (AstData a) Source # | |
| Show a => Show (AstData a) Source # | |
| NFData a => NFData (AstData a) Source # | |
Defined in Language.PureScript.Ide.Types | |
| Eq a => Eq (AstData a) Source # | |
| Ord a => Ord (AstData a) Source # | |
| type Rep (AstData a) Source # | |
Defined in Language.PureScript.Ide.Types type Rep (AstData a) = D1 ('MetaData "AstData" "Language.PureScript.Ide.Types" "purescript-0.15.8-4tiSWAb69Er4UfMmbMY7A8" 'True) (C1 ('MetaCons "AstData" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ModuleMap (DefinitionSites a, TypeAnnotations))))) | |
data IdeLogLevel Source #
Constructors
| LogDebug | |
| LogPerf | |
| LogAll | |
| LogDefault | |
| LogNone |
Instances
| Show IdeLogLevel Source # | |
Defined in Language.PureScript.Ide.Types Methods showsPrec :: Int -> IdeLogLevel -> ShowS # show :: IdeLogLevel -> String # showList :: [IdeLogLevel] -> ShowS # | |
| Eq IdeLogLevel Source # | |
Defined in Language.PureScript.Ide.Types | |
data IdeConfiguration Source #
Constructors
| IdeConfiguration | |
Fields
| |
data IdeEnvironment Source #
Constructors
| IdeEnvironment | |
Fields | |
type Ide m = (MonadIO m, MonadReader IdeEnvironment m) Source #
Constructors
| IdeState | |
Fields | |
data IdeFileState Source #
IdeFileState holds data that corresponds 1-to-1 to an entity on the
filesystem. Externs correspond to the ExternsFiles the compiler emits into
the output folder, and modules are parsed ASTs from source files. This means,
that we can update single modules or ExternsFiles inside this state whenever
the corresponding entity changes on the file system.
Constructors
| IdeFileState | |
Instances
| Show IdeFileState Source # | |
Defined in Language.PureScript.Ide.Types Methods showsPrec :: Int -> IdeFileState -> ShowS # show :: IdeFileState -> String # showList :: [IdeFileState] -> ShowS # | |
data IdeVolatileState Source #
IdeVolatileState is derived from the IdeFileState and needs to be
invalidated and refreshed carefully. It holds AstData, which is the data we
extract from the parsed ASTs, as well as the IdeDeclarations, which contain
lots of denormalized data, so they need to fully rebuilt whenever
IdeFileState changes. The vsCachedRebuild field can hold a rebuild result
with open imports which is used to provide completions for module private
declarations
Constructors
| IdeVolatileState | |
Fields | |
Instances
| Show IdeVolatileState Source # | |
Defined in Language.PureScript.Ide.Types Methods showsPrec :: Int -> IdeVolatileState -> ShowS # show :: IdeVolatileState -> String # showList :: [IdeVolatileState] -> ShowS # | |
Constructors
| Match (ModuleName, a) |
data Completion Source #
A completion as it gets sent to the editors
Constructors
| Completion | |
Fields | |
Instances
| ToJSON Completion Source # | |
Defined in Language.PureScript.Ide.Types Methods toJSON :: Completion -> Value # toEncoding :: Completion -> Encoding # toJSONList :: [Completion] -> Value # toEncodingList :: [Completion] -> Encoding # | |
| Show Completion Source # | |
Defined in Language.PureScript.Ide.Types Methods showsPrec :: Int -> Completion -> ShowS # show :: Completion -> String # showList :: [Completion] -> ShowS # | |
| Eq Completion Source # | |
Defined in Language.PureScript.Ide.Types | |
| Ord Completion Source # | |
Defined in Language.PureScript.Ide.Types Methods compare :: Completion -> Completion -> Ordering # (<) :: Completion -> Completion -> Bool # (<=) :: Completion -> Completion -> Bool # (>) :: Completion -> Completion -> Bool # (>=) :: Completion -> Completion -> Bool # max :: Completion -> Completion -> Completion # min :: Completion -> Completion -> Completion # | |
Constructors
encodeSuccess :: ToJSON a => a -> Value Source #
data IdeNamespace Source #
Denotes the different namespaces a name in PureScript can reside in.
Constructors
| IdeNSValue | |
| IdeNSType | |
| IdeNSModule |
Instances
data IdeNamespaced Source #
A name tagged with a namespace
Constructors
| IdeNamespaced IdeNamespace Text |