HsDev.Symbols.Types

Documentation

data Module

Module

Constructors

Module

Fields

• _moduleId :: ModuleId
• _moduleDocs :: Maybe Text
• _moduleImports :: [Text]
• _moduleExports :: [Symbol]
• _moduleFixities :: [Fixity]
• _moduleScope :: Map Name [Symbol]
• _moduleSource :: Maybe Parsed

Instances

Eq Module

Methods

(==) :: Module -> Module -> Bool

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

Ord Module

Methods

compare :: Module -> Module -> Ordering

(<) :: Module -> Module -> Bool

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

(>) :: Module -> Module -> Bool

(>=) :: Module -> Module -> Bool

max :: Module -> Module -> Module

min :: Module -> Module -> Module

Show InspectedModule

Methods

showsPrec :: Int -> InspectedModule -> ShowS

show :: InspectedModule -> String

showList :: [InspectedModule] -> ShowS

Show Module

Methods

showsPrec :: Int -> Module -> ShowS

show :: Module -> String

showList :: [Module] -> ShowS

NFData Module

Methods

rnf :: Module -> ()

ToJSON Module

Methods

toJSON :: Module -> Value

toEncoding :: Module -> Encoding

toJSONList :: [Module] -> Value

toEncodingList :: [Module] -> Encoding

FromJSON Module

Methods

parseJSON :: Value -> Parser Module

parseJSONList :: Value -> Parser [Module]

Sourced Module

Methods

sourcedName :: Lens' Module Text

sourcedDocs :: Traversal' Module Text

sourcedModule :: Lens' Module ModuleId

sourcedLocation :: Traversal' Module Position

Documented Module

Methods

brief :: Module -> Text

detailed :: Module -> Text

ToEnvironment Module

Methods

environment :: Module -> Environment

ToEnvironment [Module]

Methods

environment :: [Module] -> Environment

moduleSymbols :: Traversal' Module Symbol

Make each symbol appear only once

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 [Text]

moduleExports :: Lens' Module [Symbol]

moduleScope :: Lens' Module (Map Name [Symbol])

moduleSource :: Lens' Module (Maybe Parsed)

data Symbol

Constructors

Symbol

Fields

• _symbolId :: SymbolId
• _symbolDocs :: Maybe Text
• _symbolPosition :: Maybe Position
• _symbolInfo :: SymbolInfo

Instances

Eq Symbol

Methods

(==) :: Symbol -> Symbol -> Bool

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

Ord Symbol

Methods

compare :: Symbol -> Symbol -> Ordering

(<) :: Symbol -> Symbol -> Bool

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

(>) :: Symbol -> Symbol -> Bool

(>=) :: Symbol -> Symbol -> Bool

max :: Symbol -> Symbol -> Symbol

min :: Symbol -> Symbol -> Symbol

Show Symbol

Methods

showsPrec :: Int -> Symbol -> ShowS

show :: Symbol -> String

showList :: [Symbol] -> ShowS

NFData Symbol

Methods

rnf :: Symbol -> ()

ToJSON Symbol

Methods

toJSON :: Symbol -> Value

toEncoding :: Symbol -> Encoding

toJSONList :: [Symbol] -> Value

toEncodingList :: [Symbol] -> Encoding

FromJSON Symbol

Methods

parseJSON :: Value -> Parser Symbol

parseJSONList :: Value -> Parser [Symbol]

Sourced Symbol

Methods

sourcedName :: Lens' Symbol Text

sourcedDocs :: Traversal' Symbol Text

sourcedModule :: Lens' Symbol ModuleId

sourcedLocation :: Traversal' Symbol Position

Documented Symbol

Methods

brief :: Symbol -> Text

detailed :: Symbol -> Text

symbolId :: Lens' Symbol SymbolId

symbolDocs :: Lens' Symbol (Maybe Text)

symbolPosition :: Lens' Symbol (Maybe Position)

symbolInfo :: Lens' Symbol SymbolInfo

data SymbolInfo

Constructors

Function

Fields

• _functionType :: Maybe Text

Method

Fields

• _functionType :: Maybe Text
• _parentClass :: Text

Selector

Fields

• _functionType :: Maybe Text
• _parentType :: Text
• _selectorConstructors :: [Text]

Constructor

Fields

• _typeArgs :: [Text]
• _parentType :: Text

Type

Fields

• _typeArgs :: [Text]
• _typeContext :: [Text]

NewType

Fields

• _typeArgs :: [Text]
• _typeContext :: [Text]

Data

Fields

• _typeArgs :: [Text]
• _typeContext :: [Text]

Class

Fields

• _typeArgs :: [Text]
• _typeContext :: [Text]

TypeFam

Fields

• _typeArgs :: [Text]
• _typeContext :: [Text]
• _familyAssociate :: Maybe Text

DataFam

Fields

• _typeArgs :: [Text]
• _typeContext :: [Text]
• _familyAssociate :: Maybe Text

PatConstructor

Fields

• _typeArgs :: [Text]
• _patternType :: Maybe Text

PatSelector

Fields

• _functionType :: Maybe Text
• _patternType :: Maybe Text
• _patternConstructor :: Text

Instances

Eq SymbolInfo

Methods

(==) :: SymbolInfo -> SymbolInfo -> Bool

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

Ord SymbolInfo

Methods

compare :: SymbolInfo -> SymbolInfo -> Ordering

(<) :: SymbolInfo -> SymbolInfo -> Bool

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

(>) :: SymbolInfo -> SymbolInfo -> Bool

(>=) :: SymbolInfo -> SymbolInfo -> Bool

max :: SymbolInfo -> SymbolInfo -> SymbolInfo

min :: SymbolInfo -> SymbolInfo -> SymbolInfo

Read SymbolInfo

Methods

readsPrec :: Int -> ReadS SymbolInfo

readList :: ReadS [SymbolInfo]

readPrec :: ReadPrec SymbolInfo

readListPrec :: ReadPrec [SymbolInfo]

Show SymbolInfo

Methods

showsPrec :: Int -> SymbolInfo -> ShowS

show :: SymbolInfo -> String

showList :: [SymbolInfo] -> ShowS

NFData SymbolInfo

Methods

rnf :: SymbolInfo -> ()

ToJSON SymbolInfo

Methods

toJSON :: SymbolInfo -> Value

toEncoding :: SymbolInfo -> Encoding

toJSONList :: [SymbolInfo] -> Value

toEncodingList :: [SymbolInfo] -> Encoding

FromJSON SymbolInfo

Methods

parseJSON :: Value -> Parser SymbolInfo

parseJSONList :: Value -> Parser [SymbolInfo]

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)

symbolType :: Symbol -> String

patternType :: Traversal' SymbolInfo (Maybe Text)

patternConstructor :: Traversal' SymbolInfo Text

data Scoped a

Scoped entity with qualifier

Constructors

Scoped

Fields

• _scopeQualifier :: Maybe Text
• _scoped :: a

Instances

Eq a => Eq (Scoped a)

Methods

(==) :: Scoped a -> Scoped a -> Bool

(/=) :: Scoped a -> Scoped a -> Bool

Ord a => Ord (Scoped a)

Methods

compare :: Scoped a -> Scoped a -> Ordering

(<) :: Scoped a -> Scoped a -> Bool

(<=) :: Scoped a -> Scoped a -> Bool

(>) :: Scoped a -> Scoped a -> Bool

(>=) :: Scoped a -> Scoped a -> Bool

max :: Scoped a -> Scoped a -> Scoped a

min :: Scoped a -> Scoped a -> Scoped a

Show a => Show (Scoped a)

Methods

showsPrec :: Int -> Scoped a -> ShowS

show :: Scoped a -> String

showList :: [Scoped a] -> ShowS

ToJSON a => ToJSON (Scoped a)

Methods

toJSON :: Scoped a -> Value

toEncoding :: Scoped a -> Encoding

toJSONList :: [Scoped a] -> Value

toEncodingList :: [Scoped a] -> Encoding

FromJSON a => FromJSON (Scoped a)

Methods

parseJSON :: Value -> Parser (Scoped a)

parseJSONList :: Value -> Parser [Scoped a]

scopeQualifier :: forall a. Lens' (Scoped a) (Maybe Text)

scoped :: forall a a. Lens (Scoped a) (Scoped a) a a

data SymbolUsage

Symbol usage

Constructors

SymbolUsage

Fields

• _symbolUsed :: Symbol
• _symbolUsedIn :: ModuleId
• _symbolUsedPosition :: Position

Instances

Eq SymbolUsage

Methods

(==) :: SymbolUsage -> SymbolUsage -> Bool

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

Ord SymbolUsage

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

Methods

showsPrec :: Int -> SymbolUsage -> ShowS

show :: SymbolUsage -> String

showList :: [SymbolUsage] -> ShowS

ToJSON SymbolUsage

Methods

toJSON :: SymbolUsage -> Value

toEncoding :: SymbolUsage -> Encoding

toJSONList :: [SymbolUsage] -> Value

toEncodingList :: [SymbolUsage] -> Encoding

FromJSON SymbolUsage

Methods

parseJSON :: Value -> Parser SymbolUsage

parseJSONList :: Value -> Parser [SymbolUsage]

symbolUsed :: Lens' SymbolUsage Symbol

symbolUsedIn :: Lens' SymbolUsage ModuleId

symbolUsedPosition :: Lens' SymbolUsage Position

infoOf :: EmptySymbolInfo a => a -> SymbolInfo

nullifyInfo :: SymbolInfo -> SymbolInfo

data Inspection

Inspection data

Constructors

InspectionNone

No inspection

InspectionAt

Time and flags of inspection

Fields

• _inspectionAt :: POSIXTime
• _inspectionOpts :: [Text]

Instances

Eq Inspection

Methods

(==) :: Inspection -> Inspection -> Bool

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

Ord Inspection

Methods

compare :: Inspection -> Inspection -> Ordering

(<) :: Inspection -> Inspection -> Bool

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

(>) :: Inspection -> Inspection -> Bool

(>=) :: Inspection -> Inspection -> Bool

max :: Inspection -> Inspection -> Inspection

min :: Inspection -> Inspection -> Inspection

Show Inspection

Methods

showsPrec :: Int -> Inspection -> ShowS

show :: Inspection -> String

showList :: [Inspection] -> ShowS

Monoid Inspection

Methods

mempty :: Inspection

mappend :: Inspection -> Inspection -> Inspection

mconcat :: [Inspection] -> Inspection

NFData Inspection

Methods

rnf :: Inspection -> ()

ToJSON Inspection

Methods

toJSON :: Inspection -> Value

toEncoding :: Inspection -> Encoding

toJSONList :: [Inspection] -> Value

toEncodingList :: [Inspection] -> Encoding

FromJSON Inspection

Methods

parseJSON :: Value -> Parser Inspection

parseJSONList :: Value -> Parser [Inspection]

inspectionAt :: Traversal' Inspection POSIXTime

inspectionOpts :: Traversal' Inspection [Text]

fresh :: Inspection -> Inspection -> Bool

Is left Inspection fresh comparing to right one

data Inspected k t a

Inspected entity

Constructors

Inspected

Fields

• _inspection :: Inspection
• _inspectedKey :: k
• _inspectionTags :: Set t
• _inspectionResult :: Either HsDevError a

Instances

Show InspectedModule

Methods

showsPrec :: Int -> InspectedModule -> ShowS

show :: InspectedModule -> String

showList :: [InspectedModule] -> ShowS

Functor (Inspected k t)

Methods

fmap :: (a -> b) -> Inspected k t a -> Inspected k t b

(<$) :: a -> Inspected k t b -> Inspected k t a

Foldable (Inspected k t)

Methods

fold :: Monoid m => Inspected k t m -> m

foldMap :: Monoid m => (a -> m) -> Inspected k t a -> m

foldr :: (a -> b -> b) -> b -> Inspected k t a -> b

foldr' :: (a -> b -> b) -> b -> Inspected k t a -> b

foldl :: (b -> a -> b) -> b -> Inspected k t a -> b

foldl' :: (b -> a -> b) -> b -> Inspected k t a -> b

foldr1 :: (a -> a -> a) -> Inspected k t a -> a

foldl1 :: (a -> a -> a) -> Inspected k t a -> a

toList :: Inspected k t a -> [a]

null :: Inspected k t a -> Bool

length :: Inspected k t a -> Int

elem :: Eq a => a -> Inspected k t a -> Bool

maximum :: Ord a => Inspected k t a -> a

minimum :: Ord a => Inspected k t a -> a

sum :: Num a => Inspected k t a -> a

product :: Num a => Inspected k t a -> a

Traversable (Inspected k t)

Methods

traverse :: Applicative f => (a -> f b) -> Inspected k t a -> f (Inspected k t b)

sequenceA :: Applicative f => Inspected k t (f a) -> f (Inspected k t a)

mapM :: Monad m => (a -> m b) -> Inspected k t a -> m (Inspected k t b)

sequence :: Monad m => Inspected k t (m a) -> m (Inspected k t a)

(Eq k, Eq t, Eq a) => Eq (Inspected k t a)

Methods

(==) :: Inspected k t a -> Inspected k t a -> Bool

(/=) :: Inspected k t a -> Inspected k t a -> Bool

(Ord k, Ord t, Ord a) => Ord (Inspected k t a)

Methods

compare :: Inspected k t a -> Inspected k t a -> Ordering

(<) :: Inspected k t a -> Inspected k t a -> Bool

(<=) :: Inspected k t a -> Inspected k t a -> Bool

(>) :: Inspected k t a -> Inspected k t a -> Bool

(>=) :: Inspected k t a -> Inspected k t a -> Bool

max :: Inspected k t a -> Inspected k t a -> Inspected k t a

min :: Inspected k t a -> Inspected k t a -> Inspected k t a

(NFData k, NFData t, NFData a) => NFData (Inspected k t a)

Methods

rnf :: Inspected k t a -> ()

(ToJSON k, ToJSON t, ToJSON a) => ToJSON (Inspected k t a)

Methods

toJSON :: Inspected k t a -> Value

toEncoding :: Inspected k t a -> Encoding

toJSONList :: [Inspected k t a] -> Value

toEncodingList :: [Inspected k t a] -> Encoding

(FromJSON k, Ord t, FromJSON t, FromJSON a) => FromJSON (Inspected k t a)

Methods

parseJSON :: Value -> Parser (Inspected k t a)

parseJSONList :: Value -> Parser [Inspected k t 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

inspectedTup :: Inspected k t a -> (Inspection, k, Set t, Maybe a)

noTags :: Set t

Empty tags

tag :: t -> Set t

One tag

data ModuleTag

Constructors

InferredTypesTag

RefinedDocsTag

OnlyHeaderTag

Instances

Bounded ModuleTag

Methods

minBound :: ModuleTag

maxBound :: ModuleTag

Enum ModuleTag

Methods

succ :: ModuleTag -> ModuleTag

pred :: ModuleTag -> ModuleTag

toEnum :: Int -> ModuleTag

fromEnum :: ModuleTag -> Int

enumFrom :: ModuleTag -> [ModuleTag]

enumFromThen :: ModuleTag -> ModuleTag -> [ModuleTag]

enumFromTo :: ModuleTag -> ModuleTag -> [ModuleTag]

enumFromThenTo :: ModuleTag -> ModuleTag -> ModuleTag -> [ModuleTag]

Eq ModuleTag

Methods

(==) :: ModuleTag -> ModuleTag -> Bool

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

Ord ModuleTag

Methods

compare :: ModuleTag -> ModuleTag -> Ordering

(<) :: ModuleTag -> ModuleTag -> Bool

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

(>) :: ModuleTag -> ModuleTag -> Bool

(>=) :: ModuleTag -> ModuleTag -> Bool

max :: ModuleTag -> ModuleTag -> ModuleTag

min :: ModuleTag -> ModuleTag -> ModuleTag

Read ModuleTag

Methods

readsPrec :: Int -> ReadS ModuleTag

readList :: ReadS [ModuleTag]

readPrec :: ReadPrec ModuleTag

readListPrec :: ReadPrec [ModuleTag]

Show InspectedModule

Methods

showsPrec :: Int -> InspectedModule -> ShowS

show :: InspectedModule -> String

showList :: [InspectedModule] -> ShowS

Show ModuleTag

Methods

showsPrec :: Int -> ModuleTag -> ShowS

show :: ModuleTag -> String

showList :: [ModuleTag] -> ShowS

NFData ModuleTag

Methods

rnf :: ModuleTag -> ()

ToJSON ModuleTag

Methods

toJSON :: ModuleTag -> Value

toEncoding :: ModuleTag -> Encoding

toJSONList :: [ModuleTag] -> Value

toEncodingList :: [ModuleTag] -> Encoding

FromJSON ModuleTag

Methods

parseJSON :: Value -> Parser ModuleTag

parseJSONList :: Value -> Parser [ModuleTag]

Display ModuleTag

Methods

display :: ModuleTag -> String

displayType :: ModuleTag -> String

type InspectedModule = Inspected ModuleLocation ModuleTag Module

Inspected 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

Orphan instances

Read POSIXTime

Methods

readsPrec :: Int -> ReadS POSIXTime

readList :: ReadS [POSIXTime]

readPrec :: ReadPrec POSIXTime

readListPrec :: ReadPrec [POSIXTime]

NFData Fixity

Methods

rnf :: Fixity -> ()

NFData Boxed

Methods

rnf :: Boxed -> ()

ToJSON Fixity

Methods

toJSON :: Fixity -> Value

toEncoding :: Fixity -> Encoding

toJSONList :: [Fixity] -> Value

toEncodingList :: [Fixity] -> Encoding

FromJSON Fixity

Methods

parseJSON :: Value -> Parser Fixity

parseJSONList :: Value -> Parser [Fixity]

Documented ModuleId

Methods

brief :: ModuleId -> Text

detailed :: ModuleId -> Text

Documented SymbolId

Methods

brief :: SymbolId -> Text

detailed :: SymbolId -> Text

NFData l => NFData (Name l)

Methods

rnf :: Name l -> ()

NFData l => NFData (ModuleName l)

Methods

rnf :: ModuleName l -> ()

NFData l => NFData (SpecialCon l)

Methods

rnf :: SpecialCon l -> ()

NFData l => NFData (QName l)

Methods

rnf :: QName l -> ()

NFData (Assoc ())

Methods

rnf :: Assoc () -> ()

ToJSON (Assoc ())

Methods

toJSON :: Assoc () -> Value

toEncoding :: Assoc () -> Encoding

toJSONList :: [Assoc ()] -> Value

toEncodingList :: [Assoc ()] -> Encoding

FromJSON (Assoc ())

Methods

parseJSON :: Value -> Parser (Assoc ())

parseJSONList :: Value -> Parser [Assoc ()]