| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
HsDev.Symbols.Types
Contents
Synopsis
- data Import = Import {}
- importPosition :: Lens' Import Position
- importName :: Lens' Import Text
- importQualified :: Lens' Import Bool
- importAs :: Lens' Import (Maybe Text)
- data Module = Module {
- _moduleId :: ModuleId
- _moduleDocs :: Maybe Text
- _moduleImports :: [Import]
- _moduleExports :: [Symbol]
- _moduleFixities :: [Fixity]
- _moduleScope :: Map Name [Symbol]
- _moduleSource :: Maybe Parsed
- moduleSymbols :: Traversal' Module Symbol
- exportedSymbols :: Traversal' Module Symbol
- scopeSymbols :: Traversal' Module (Symbol, [Name])
- fixitiesMap :: Lens' Module (Map Name Fixity)
- moduleFixities :: Lens' Module [Fixity]
- moduleId :: Lens' Module ModuleId
- moduleDocs :: Lens' Module (Maybe Text)
- moduleImports :: Lens' Module [Import]
- moduleExports :: Lens' Module [Symbol]
- moduleScope :: Lens' Module (Map Name [Symbol])
- moduleSource :: Lens' Module (Maybe Parsed)
- data Symbol = Symbol {}
- symbolId :: Lens' Symbol SymbolId
- symbolDocs :: Lens' Symbol (Maybe Text)
- symbolPosition :: Lens' Symbol (Maybe Position)
- symbolInfo :: Lens' Symbol SymbolInfo
- data SymbolInfo
- = Function { }
- | Method { }
- | Selector { }
- | Constructor {
- _typeArgs :: [Text]
- _parentType :: Text
- | Type {
- _typeArgs :: [Text]
- _typeContext :: [Text]
- | NewType {
- _typeArgs :: [Text]
- _typeContext :: [Text]
- | Data {
- _typeArgs :: [Text]
- _typeContext :: [Text]
- | Class {
- _typeArgs :: [Text]
- _typeContext :: [Text]
- | TypeFam {
- _typeArgs :: [Text]
- _typeContext :: [Text]
- _familyAssociate :: Maybe Text
- | DataFam {
- _typeArgs :: [Text]
- _typeContext :: [Text]
- _familyAssociate :: Maybe Text
- | PatConstructor {
- _typeArgs :: [Text]
- _patternType :: Maybe Text
- | PatSelector { }
- functionType :: Traversal' SymbolInfo (Maybe Text)
- parentClass :: Traversal' SymbolInfo Text
- parentType :: Traversal' SymbolInfo Text
- selectorConstructors :: Traversal' SymbolInfo [Text]
- typeArgs :: Traversal' SymbolInfo [Text]
- typeContext :: Traversal' SymbolInfo [Text]
- familyAssociate :: Traversal' SymbolInfo (Maybe Text)
- symbolInfoType :: SymbolInfo -> String
- symbolType :: Symbol -> String
- patternType :: Traversal' SymbolInfo (Maybe Text)
- patternConstructor :: Traversal' SymbolInfo Text
- data Scoped a = Scoped {
- _scopeQualifier :: Maybe Text
- _scoped :: a
- scopeQualifier :: forall a. Lens' (Scoped a) (Maybe Text)
- scoped :: forall a a. Lens (Scoped a) (Scoped a) a a
- data SymbolUsage = SymbolUsage {}
- symbolUsed :: Lens' SymbolUsage Symbol
- symbolUsedQualifier :: Lens' SymbolUsage (Maybe Text)
- symbolUsedIn :: Lens' SymbolUsage ModuleId
- symbolUsedRegion :: Lens' SymbolUsage Region
- data ImportedSymbol = ImportedSymbol {}
- importedSymbol :: Lens' ImportedSymbol Symbol
- importedFrom :: Lens' ImportedSymbol ModuleId
- infoOf :: EmptySymbolInfo a => a -> SymbolInfo
- nullifyInfo :: SymbolInfo -> SymbolInfo
- data Inspection
- = InspectionNone
- | InspectionAt { }
- inspectionAt :: Traversal' Inspection POSIXTime
- inspectionOpts :: Traversal' Inspection [Text]
- fresh :: Inspection -> Inspection -> Bool
- data Inspected k t a = Inspected {
- _inspection :: Inspection
- _inspectedKey :: k
- _inspectionTags :: Set t
- _inspectionResult :: Either HsDevError a
- inspection :: forall k t a. Lens' (Inspected k t a) Inspection
- inspectedKey :: forall k t a k. Lens (Inspected k t a) (Inspected k t a) k k
- inspectionTags :: forall k t a t. Lens (Inspected k t a) (Inspected k t a) (Set t) (Set t)
- inspectionResult :: forall k t a a. Lens (Inspected k t a) (Inspected k t a) (Either HsDevError a) (Either HsDevError a)
- inspected :: Traversal (Inspected k t a) (Inspected k t b) a b
- newtype InspectM k t m a = InspectM {
- runInspectM :: ReaderT k (ExceptT HsDevError (StateT (Inspection, Set t) m)) a
- runInspect :: (Monad m, Ord t) => k -> InspectM k t m a -> m (Inspected k t a)
- continueInspect :: (Monad m, Ord t) => Inspected k t a -> (a -> InspectM k t m b) -> m (Inspected k t b)
- inspect :: MonadCatch m => m Inspection -> (k -> m a) -> InspectM k t m a
- inspect_ :: MonadCatch m => m Inspection -> m a -> InspectM k t m a
- withInspection :: MonadCatch m => m Inspection -> InspectM k t m a -> InspectM k t m a
- inspectedTup :: Inspected k t a -> (Inspection, k, Set t, Maybe a)
- noTags :: Set t
- tag :: t -> Set t
- data ModuleTag
- type InspectedModule = Inspected ModuleLocation ModuleTag Module
- notInspected :: ModuleLocation -> InspectedModule
- module HsDev.PackageDb.Types
- module HsDev.Project
- module HsDev.Symbols.Name
- module HsDev.Symbols.Class
- module HsDev.Symbols.Location
- module HsDev.Symbols.Documented
Documentation
Import
Constructors
| Import | |
Fields
| |
Instances
| Eq Import Source # | |
| Ord Import Source # | |
| Show Import Source # | |
| NFData Import Source # | |
Defined in HsDev.Symbols.Types | |
| ToJSON Import Source # | |
Defined in HsDev.Symbols.Types | |
| FromJSON Import Source # | |
| FromRow Import Source # | |
Defined in HsDev.Database.SQLite.Instances | |
| ToRow Import Source # | |
Defined in HsDev.Database.SQLite.Instances | |
Module
Constructors
| Module | |
Fields
| |
Instances
| Eq Module Source # | |
| Ord Module Source # | |
| Show InspectedModule Source # | |
Defined in HsDev.Symbols.Types Methods showsPrec :: Int -> InspectedModule -> ShowS # show :: InspectedModule -> String # showList :: [InspectedModule] -> ShowS # | |
| Show Module Source # | |
| NFData Module Source # | |
Defined in HsDev.Symbols.Types | |
| ToJSON Module Source # | |
Defined in HsDev.Symbols.Types | |
| FromJSON Module Source # | |
| Sourced Module Source # | |
Defined in HsDev.Symbols.Types Methods sourcedName :: Lens' Module Text Source # sourcedDocs :: Traversal' Module Text Source # | |
| Documented Module Source # | |
| ToEnvironment Module Source # | |
Defined in HsDev.Symbols.HaskellNames Methods environment :: Module -> Environment Source # | |
| ToEnvironment [Module] Source # | |
Defined in HsDev.Symbols.HaskellNames Methods environment :: [Module] -> Environment Source # | |
moduleSymbols :: Traversal' Module Symbol Source #
Make each symbol appear only once
scopeSymbols :: Traversal' Module (Symbol, [Name]) Source #
Constructors
| Symbol | |
Fields | |
Instances
| Eq Symbol Source # | |
| Ord Symbol Source # | |
| Show Symbol Source # | |
| NFData Symbol Source # | |
Defined in HsDev.Symbols.Types | |
| ToJSON Symbol Source # | |
Defined in HsDev.Symbols.Types | |
| FromJSON Symbol Source # | |
| FromRow Symbol Source # | |
Defined in HsDev.Database.SQLite.Instances | |
| ToRow Symbol Source # | |
Defined in HsDev.Database.SQLite.Instances | |
| Sourced Symbol Source # | |
Defined in HsDev.Symbols.Types Methods sourcedName :: Lens' Symbol Text Source # sourcedDocs :: Traversal' Symbol Text Source # | |
| Documented Symbol Source # | |
data SymbolInfo Source #
Constructors
| Function | |
Fields | |
| Method | |
Fields
| |
| Selector | |
Fields
| |
| Constructor | |
Fields
| |
| Type | |
Fields
| |
| NewType | |
Fields
| |
| Data | |
Fields
| |
| Class | |
Fields
| |
| TypeFam | |
Fields
| |
| DataFam | |
Fields
| |
| PatConstructor | |
Fields
| |
| PatSelector | |
Fields | |
Instances
typeArgs :: Traversal' SymbolInfo [Text] Source #
symbolInfoType :: SymbolInfo -> String Source #
symbolType :: Symbol -> String Source #
Scoped entity with qualifier
Constructors
| Scoped | |
Fields
| |
Instances
| Eq a => Eq (Scoped a) Source # | |
| Ord a => Ord (Scoped a) Source # | |
Defined in HsDev.Symbols.Types | |
| Show a => Show (Scoped a) Source # | |
| ToJSON a => ToJSON (Scoped a) Source # | |
Defined in HsDev.Symbols.Types | |
| FromJSON a => FromJSON (Scoped a) Source # | |
| FromRow a => FromRow (Scoped a) Source # | |
Defined in HsDev.Database.SQLite.Instances | |
| ToRow a => ToRow (Scoped a) Source # | |
Defined in HsDev.Database.SQLite.Instances | |
data SymbolUsage Source #
Symbol usage
Constructors
| SymbolUsage | |
Fields | |
Instances
| Eq SymbolUsage Source # | |
Defined in HsDev.Symbols.Types | |
| Ord SymbolUsage Source # | |
Defined in HsDev.Symbols.Types Methods compare :: SymbolUsage -> SymbolUsage -> Ordering # (<) :: SymbolUsage -> SymbolUsage -> Bool # (<=) :: SymbolUsage -> SymbolUsage -> Bool # (>) :: SymbolUsage -> SymbolUsage -> Bool # (>=) :: SymbolUsage -> SymbolUsage -> Bool # max :: SymbolUsage -> SymbolUsage -> SymbolUsage # min :: SymbolUsage -> SymbolUsage -> SymbolUsage # | |
| Show SymbolUsage Source # | |
Defined in HsDev.Symbols.Types Methods showsPrec :: Int -> SymbolUsage -> ShowS # show :: SymbolUsage -> String # showList :: [SymbolUsage] -> ShowS # | |
| ToJSON SymbolUsage Source # | |
Defined in HsDev.Symbols.Types Methods toJSON :: SymbolUsage -> Value # toEncoding :: SymbolUsage -> Encoding # toJSONList :: [SymbolUsage] -> Value # toEncodingList :: [SymbolUsage] -> Encoding # | |
| FromJSON SymbolUsage Source # | |
Defined in HsDev.Symbols.Types | |
| FromRow SymbolUsage Source # | |
Defined in HsDev.Database.SQLite.Instances Methods | |
data ImportedSymbol Source #
Symbol with module it's exported from
Constructors
| ImportedSymbol | |
Fields | |
Instances
infoOf :: EmptySymbolInfo a => a -> SymbolInfo Source #
nullifyInfo :: SymbolInfo -> SymbolInfo Source #
data Inspection Source #
Inspection data
Constructors
| InspectionNone | No inspection |
| InspectionAt | Time and flags of inspection |
Fields
| |
Instances
fresh :: Inspection -> Inspection -> Bool Source #
Is left Inspection fresh comparing to right one
Inspected entity
Constructors
| Inspected | |
Fields
| |
Instances
inspection :: forall k t a. Lens' (Inspected k t a) Inspection Source #
inspectionResult :: forall k t a a. Lens (Inspected k t a) (Inspected k t a) (Either HsDevError a) (Either HsDevError a) Source #
newtype InspectM k t m a Source #
Constructors
| InspectM | |
Fields
| |
Instances
continueInspect :: (Monad m, Ord t) => Inspected k t a -> (a -> InspectM k t m b) -> m (Inspected k t b) Source #
Continue inspection
inspect :: MonadCatch m => m Inspection -> (k -> m a) -> InspectM k t m a Source #
inspect_ :: MonadCatch m => m Inspection -> m a -> InspectM k t m a Source #
withInspection :: MonadCatch m => m Inspection -> InspectM k t m a -> InspectM k t m a Source #
inspectedTup :: Inspected k t a -> (Inspection, k, Set t, Maybe a) Source #
Instances
| Bounded ModuleTag Source # | |
| Enum ModuleTag Source # | |
Defined in HsDev.Symbols.Types Methods succ :: ModuleTag -> ModuleTag # pred :: ModuleTag -> ModuleTag # fromEnum :: ModuleTag -> Int # enumFrom :: ModuleTag -> [ModuleTag] # enumFromThen :: ModuleTag -> ModuleTag -> [ModuleTag] # enumFromTo :: ModuleTag -> ModuleTag -> [ModuleTag] # enumFromThenTo :: ModuleTag -> ModuleTag -> ModuleTag -> [ModuleTag] # | |
| Eq ModuleTag Source # | |
| Ord ModuleTag Source # | |
| Read ModuleTag Source # | |
| Show InspectedModule Source # | |
Defined in HsDev.Symbols.Types Methods showsPrec :: Int -> InspectedModule -> ShowS # show :: InspectedModule -> String # showList :: [InspectedModule] -> ShowS # | |
| Show ModuleTag Source # | |
| NFData ModuleTag Source # | |
Defined in HsDev.Symbols.Types | |
| ToJSON ModuleTag Source # | |
Defined in HsDev.Symbols.Types | |
| FromJSON ModuleTag Source # | |
| Display ModuleTag Source # | |
type InspectedModule = Inspected ModuleLocation ModuleTag Module Source #
Inspected module
module HsDev.PackageDb.Types
module HsDev.Project
module HsDev.Symbols.Name
module HsDev.Symbols.Class
module HsDev.Symbols.Location
module HsDev.Symbols.Documented
Orphan instances
| NFData Fixity Source # | |
| NFData Boxed Source # | |
| ToJSON Fixity Source # | |
| FromJSON Fixity Source # | |
| Documented ModuleId Source # | |
| Documented SymbolId Source # | |
| NFData l => NFData (Name l) Source # | |
| NFData l => NFData (ModuleName l) Source # | |
Methods rnf :: ModuleName l -> () # | |
| NFData l => NFData (SpecialCon l) Source # | |
Methods rnf :: SpecialCon l -> () # | |
| NFData l => NFData (QName l) Source # | |
| NFData (Assoc ()) Source # | |
| ToJSON (Assoc ()) Source # | |
| FromJSON (Assoc ()) Source # | |