Safe Haskell	None
Language	Haskell98

HsDev.Symbols.Types

Synopsis

Documentation

data ThingPart Source

What to exportimport for dataclass etc

Constructors

ThingNothing
ThingAll
ThingWith [Text]

Instances

Eq ThingPart Source
Ord ThingPart Source
Show ThingPart Source
ToJSON ThingPart Source
FromJSON ThingPart Source
NFData ThingPart Source

data Export Source

Module export

Constructors

ExportName
Fields _exportQualified :: Maybe Text _exportName :: Text _exportPart :: ThingPart
ExportModule
Fields _exportModule :: Text

Instances

Eq Export Source
Ord Export Source
Show Export Source
ToJSON Export Source
FromJSON Export Source
NFData Export Source

exportQualified :: Traversal' Export (Maybe Text) Source

exportName :: Traversal' Export Text Source

exportPart :: Traversal' Export ThingPart Source

exportModule :: Traversal' Export Text Source

data ImportSpec Source

Import spec

Constructors

ImportSpec
Fields _importSpecName :: Text _importSpecPart :: ThingPart

Instances

Eq ImportSpec Source
Ord ImportSpec Source
Show ImportSpec Source
ToJSON ImportSpec Source
FromJSON ImportSpec Source
NFData ImportSpec Source

importSpecName :: Lens' ImportSpec Text Source

importSpecPart :: Lens' ImportSpec ThingPart Source

data ImportList Source

Import list

Constructors

ImportList
Fields _hidingList :: Bool _importSpecs :: [ImportSpec]

Instances

Eq ImportList Source
Ord ImportList Source
Show ImportList Source
ToJSON ImportList Source
FromJSON ImportList Source
NFData ImportList Source

hidingList :: Lens' ImportList Bool Source

importSpecs :: Lens' ImportList [ImportSpec] Source

data Import Source

Module import

Constructors

Import
Fields _importModuleName :: Text _importIsQualified :: Bool _importAs :: Maybe Text _importList :: Maybe ImportList _importPosition :: Maybe Position

Instances

Eq Import Source
Ord Import Source
Show Import Source
ToJSON Import Source
FromJSON Import Source
NFData Import Source

importModuleName :: Lens' Import Text Source

importIsQualified :: Lens' Import Bool Source

importAs :: Lens' Import (Maybe Text) Source

importList :: Lens' Import (Maybe ImportList) Source

importPosition :: Lens' Import (Maybe Position) Source

data ModuleId Source

Module id

Constructors

ModuleId
Fields _moduleIdName :: Text _moduleIdLocation :: ModuleLocation

moduleIdName :: Lens' ModuleId Text Source

moduleIdLocation :: Lens' ModuleId ModuleLocation Source

data Module Source

Module

Constructors

Module
Fields _moduleName :: Text _moduleDocs :: Maybe Text _moduleLocation :: ModuleLocation _moduleExports :: Maybe [Export] _moduleImports :: [Import] _moduleDeclarations :: [Declaration]

moduleName :: Lens' Module Text Source

moduleDocs :: Lens' Module (Maybe Text) Source

moduleLocation :: Lens' Module ModuleLocation Source

moduleExports :: Lens' Module (Maybe [Export]) Source

moduleImports :: Lens' Module [Import] Source

moduleDeclarations :: Lens' Module [Declaration] Source

moduleContents :: Module -> [String] Source

Module contents

moduleId :: Simple Lens Module ModuleId Source

data Declaration Source

Declaration

Constructors

Declaration
Fields _declarationName :: Text _declarationDefined :: Maybe ModuleId Where declaration defined, `Nothing` if here _declarationImported :: Maybe [Import] Declaration imported with. `Nothing` if unknown (cabal modules) or here (source file) _declarationDocs :: Maybe Text _declarationPosition :: Maybe Position _declaration :: DeclarationInfo

declarationName :: Lens' Declaration Text Source

declarationDefined :: Lens' Declaration (Maybe ModuleId) Source

declarationImported :: Lens' Declaration (Maybe [Import]) Source

declarationDocs :: Lens' Declaration (Maybe Text) Source

declarationPosition :: Lens' Declaration (Maybe Position) Source

declaration :: Lens' Declaration DeclarationInfo Source

minimalDecl :: Lens' Declaration Declaration Source

Minimal declaration info without defined, docs and position

data TypeInfo Source

Common info for type, newtype, data and class

Constructors

TypeInfo
Fields _typeInfoContext :: Maybe Text _typeInfoArgs :: [Text] _typeInfoDefinition :: Maybe Text _typeInfoFunctions :: [Text]

Instances

Eq TypeInfo Source
Ord TypeInfo Source
Read TypeInfo Source
Show TypeInfo Source
ToJSON TypeInfo Source
FromJSON TypeInfo Source
NFData TypeInfo Source

typeInfoContext :: Lens' TypeInfo (Maybe Text) Source

typeInfoArgs :: Lens' TypeInfo [Text] Source

typeInfoDefinition :: Lens' TypeInfo (Maybe Text) Source

typeInfoFunctions :: Lens' TypeInfo [Text] Source

showTypeInfo :: TypeInfo -> String -> String -> String Source

data DeclarationInfo Source

Declaration info

Constructors

Function
Fields _functionType :: Maybe Text _localDeclarations :: [Declaration] _related :: Maybe Text
Type
Fields _typeInfo :: TypeInfo
NewType
Fields _typeInfo :: TypeInfo
Data
Fields _typeInfo :: TypeInfo
Class
Fields _typeInfo :: TypeInfo

Instances

Eq DeclarationInfo Source
Ord DeclarationInfo Source
ToJSON DeclarationInfo Source
FromJSON DeclarationInfo Source
NFData DeclarationInfo Source
Locals DeclarationInfo Source

functionType :: Traversal' DeclarationInfo (Maybe Text) Source

localDeclarations :: Traversal' DeclarationInfo [Declaration] Source

typeInfo :: Traversal' DeclarationInfo TypeInfo Source

declarationInfo :: DeclarationInfo -> Either (Maybe Text, [Declaration], Maybe Text) TypeInfo Source

Get function type of type info

declarationTypeCtor :: String -> TypeInfo -> DeclarationInfo Source

declarationTypeName :: DeclarationInfo -> Maybe String Source

data ModuleDeclaration Source

Symbol in context of some module

Constructors

ModuleDeclaration
Fields _declarationModuleId :: ModuleId _moduleDeclaration :: Declaration

declarationModuleId :: Lens' ModuleDeclaration ModuleId Source

moduleDeclaration :: Lens' ModuleDeclaration Declaration Source

data ExportedDeclaration Source

Symbol exported with

Constructors

ExportedDeclaration
Fields _exportedBy :: [ModuleId] _exportedDeclaration :: Declaration

Instances

Eq ExportedDeclaration Source
Ord ExportedDeclaration Source
Show ExportedDeclaration Source
ToJSON ExportedDeclaration Source
FromJSON ExportedDeclaration Source
NFData ExportedDeclaration Source

exportedBy :: Lens' ExportedDeclaration [ModuleId] Source

exportedDeclaration :: Lens' ExportedDeclaration Declaration Source

data Inspection Source

Inspection data

Constructors

InspectionNone	No inspection
InspectionAt	Time and flags of inspection
Fields _inspectionAt :: POSIXTime _inspectionOpts :: [String]

Instances

Eq Inspection Source
Ord Inspection Source
Show Inspection Source
ToJSON Inspection Source
FromJSON Inspection Source
Monoid Inspection Source
NFData Inspection Source

inspectionAt :: Traversal' Inspection POSIXTime Source

inspectionOpts :: Traversal' Inspection [String] Source

data Inspected i t a Source

Inspected entity

Constructors

Inspected
Fields _inspection :: Inspection _inspectedId :: i _inspectionTags :: Set t _inspectionResult :: Either HsDevError a

Instances

Show InspectedModule Source
ToJSON InspectedModule Source
FromJSON InspectedModule Source
Functor (Inspected i t) Source
Foldable (Inspected i t) Source
Traversable (Inspected i t) Source
(Eq i, Eq t, Eq a) => Eq (Inspected i t a) Source
(Ord i, Ord t, Ord a) => Ord (Inspected i t a) Source
(NFData i, NFData t, NFData a) => NFData (Inspected i t a) Source

inspection :: forall i t a. Lens' (Inspected i t a) Inspection Source

inspectedId :: forall i t a i. Lens (Inspected i t a) (Inspected i t a) i i Source

inspectionTags :: forall i t a t. Lens (Inspected i t a) (Inspected i t a) (Set t) (Set t) Source

inspectionResult :: forall i t a a. Lens (Inspected i t a) (Inspected i t a) (Either HsDevError a) (Either HsDevError a) Source

noTags :: Ord t => Set t Source

Empty tags

type InspectedModule = Inspected ModuleLocation ModuleTag Module Source

Inspected module

notInspected :: ModuleLocation -> InspectedModule Source

module HsDev.PackageDb

module HsDev.Project

module HsDev.Symbols.Class

module HsDev.Symbols.Documented

Eq ModuleId Source
Ord ModuleId Source
Show ModuleId Source
ToJSON ModuleId Source
FromJSON ModuleId Source
NFData ModuleId Source
Symbol ModuleId Source
Documented ModuleId Source
MonadState ResolvedTree ResolveM

Eq Module Source
Ord Module Source
Show InspectedModule Source
Show Module Source
ToJSON InspectedModule Source
ToJSON Module Source
FromJSON InspectedModule Source
FromJSON Module Source
NFData Module Source
Symbol Module Source
Documented Module Source

Eq Declaration Source
Ord Declaration Source
Show Declaration Source
ToJSON Declaration Source
FromJSON Declaration Source
NFData Declaration Source
Symbol Declaration Source
Documented Declaration Source
Locals Declaration Source

Eq ModuleDeclaration Source
Ord ModuleDeclaration Source
Show ModuleDeclaration Source
ToJSON ModuleDeclaration Source
FromJSON ModuleDeclaration Source
NFData ModuleDeclaration Source
Symbol ModuleDeclaration Source
Documented ModuleDeclaration Source

Bounded ModuleTag Source
Enum ModuleTag Source
Eq ModuleTag Source
Ord ModuleTag Source
Read ModuleTag Source
Show InspectedModule Source
Show ModuleTag Source
ToJSON InspectedModule Source
ToJSON ModuleTag Source
FromJSON InspectedModule Source
FromJSON ModuleTag Source
NFData ModuleTag Source