HsDev.Symbols.Types

Synopsis

• data ExportPart
  • = ExportNothing
  • | ExportAll
  • | ExportWith [Text]
• data Export
  • = ExportName {
    • _exportQualified :: Maybe Text
    • _exportName :: Text
    • _exportPart :: ExportPart
    }
  • | ExportModule {
    • _exportModule :: Text
    }
• data ImportList = ImportList {
  • _hidingList :: Bool
  • _importSpec :: [Text]
  }
• data Import = Import {
  • _importModuleName :: Text
  • _importIsQualified :: Bool
  • _importAs :: Maybe Text
  • _importList :: Maybe ImportList
  • _importPosition :: Maybe Position
  }
• data ModuleId = ModuleId {
  • _moduleIdName :: Text
  • _moduleIdLocation :: ModuleLocation
  }
• data Module = Module {
  • _moduleName :: Text
  • _moduleDocs :: Maybe Text
  • _moduleLocation :: ModuleLocation
  • _moduleExports :: Maybe [Export]
  • _moduleImports :: [Import]
  • _moduleDeclarations :: [Declaration]
  }
• moduleContents :: Module -> [String]
• moduleId :: Simple Lens Module ModuleId
• data Declaration = Declaration {
  • _declarationName :: Text
  • _declarationDefined :: Maybe ModuleId
  • _declarationImported :: Maybe [Import]
  • _declarationDocs :: Maybe Text
  • _declarationPosition :: Maybe Position
  • _declaration :: DeclarationInfo
  }
• minimalDecl :: Lens' Declaration Declaration
• data TypeInfo = TypeInfo {
  • _typeInfoContext :: Maybe Text
  • _typeInfoArgs :: [Text]
  • _typeInfoDefinition :: Maybe Text
  • _typeInfoFunctions :: [Text]
  }
• showTypeInfo :: TypeInfo -> String -> String -> String
• data DeclarationInfo
  • = Function {
    • _functionType :: Maybe Text
    • _localDeclarations :: [Declaration]
    • _related :: Maybe Text
    }
  • | Type {
    • _typeInfo :: TypeInfo
    }
  • | NewType {
    • _typeInfo :: TypeInfo
    }
  • | Data {
    • _typeInfo :: TypeInfo
    }
  • | Class {
    • _typeInfo :: TypeInfo
    }
• declarationInfo :: DeclarationInfo -> Either (Maybe Text, [Declaration], Maybe Text) TypeInfo
• declarationTypeCtor :: String -> TypeInfo -> DeclarationInfo
• declarationTypeName :: DeclarationInfo -> Maybe String
• data ModuleDeclaration = ModuleDeclaration {
  • _declarationModuleId :: ModuleId
  • _moduleDeclaration :: Declaration
  }
• data ExportedDeclaration = ExportedDeclaration {
  • _exportedBy :: [ModuleId]
  • _exportedDeclaration :: Declaration
  }
• data Inspection
  • = InspectionNone
  • | InspectionAt {
    • _inspectionAt :: POSIXTime
    • _inspectionOpts :: [String]
    }
• data Inspected i a = Inspected {
  • _inspection :: Inspection
  • _inspectedId :: i
  • _inspectionResult :: Either String a
  }
• type InspectedModule = Inspected ModuleLocation Module
• exportQualified :: Traversal' Export (Maybe Text)
• exportName :: Traversal' Export Text
• exportPart :: Traversal' Export ExportPart
• exportModule :: Traversal' Export Text
• hidingList :: Lens' ImportList Bool
• importSpec :: Lens' ImportList [Text]
• importModuleName :: Lens' Import Text
• importIsQualified :: Lens' Import Bool
• importAs :: Lens' Import (Maybe Text)
• importList :: Lens' Import (Maybe ImportList)
• importPosition :: Lens' Import (Maybe Position)
• moduleIdName :: Lens' ModuleId Text
• moduleIdLocation :: Lens' ModuleId ModuleLocation
• moduleName :: Lens' Module Text
• moduleDocs :: Lens' Module (Maybe Text)
• moduleLocation :: Lens' Module ModuleLocation
• moduleExports :: Lens' Module (Maybe [Export])
• moduleImports :: Lens' Module [Import]
• moduleDeclarations :: Lens' Module [Declaration]
• declarationName :: Lens' Declaration Text
• declarationDefined :: Lens' Declaration (Maybe ModuleId)
• declarationImported :: Lens' Declaration (Maybe [Import])
• declarationDocs :: Lens' Declaration (Maybe Text)
• declarationPosition :: Lens' Declaration (Maybe Position)
• declaration :: Lens' Declaration DeclarationInfo
• typeInfoContext :: Lens' TypeInfo (Maybe Text)
• typeInfoArgs :: Lens' TypeInfo [Text]
• typeInfoDefinition :: Lens' TypeInfo (Maybe Text)
• typeInfoFunctions :: Lens' TypeInfo [Text]
• functionType :: Traversal' DeclarationInfo (Maybe Text)
• localDeclarations :: Traversal' DeclarationInfo [Declaration]
• related :: Traversal' DeclarationInfo (Maybe Text)
• typeInfo :: Traversal' DeclarationInfo TypeInfo
• declarationModuleId :: Lens' ModuleDeclaration ModuleId
• moduleDeclaration :: Lens' ModuleDeclaration Declaration
• exportedBy :: Lens' ExportedDeclaration [ModuleId]
• exportedDeclaration :: Lens' ExportedDeclaration Declaration
• inspectionAt :: Traversal' Inspection POSIXTime
• inspectionOpts :: Traversal' Inspection [String]
• inspection :: forall i a. Lens' (Inspected i a) Inspection
• inspectedId :: forall i a i. Lens (Inspected i a) (Inspected i a) i i
• inspectionResult :: forall i a a. Lens (Inspected i a) (Inspected i a) (Either String a) (Either String a)
• module HsDev.Cabal
• module HsDev.Project
• module HsDev.Symbols.Class
• module HsDev.Symbols.Documented

Documentation