HsDev.Symbols

Information

data Export

Module export

Constructors

ExportName (Maybe Text) Text

ExportModule Text

Instances

Eq Export

Ord Export

Show Export

ToJSON Export

FromJSON Export

NFData Export

export :: Export -> Text

Get name of export

data ImportList

Import list

Constructors

ImportList

Fields

hidingList :: Bool

importSpec :: [Text]

Instances

Eq ImportList

Ord ImportList

Show ImportList

ToJSON ImportList

FromJSON ImportList

NFData ImportList

passImportList :: ImportList -> Text -> Bool

Check whether name pass import list

data Import

Module import

Constructors

Import

Fields

importModuleName :: Text

importIsQualified :: Bool

importAs :: Maybe Text

importList :: Maybe ImportList

importPosition :: Maybe Position

Instances

Eq Import

Ord Import

Show Import

ToJSON Import

FromJSON Import

NFData Import

importName :: Import -> Text

Get import module name

import_ :: Text -> Import

Simple import

class Symbol a where

Methods

symbolName :: a -> Text

symbolQualifiedName :: a -> Text

symbolDocs :: a -> Maybe Text

symbolLocation :: a -> Location

Instances

Symbol ModuleDeclaration

Symbol Declaration

Symbol Module

Symbol ModuleId

Symbol HayooSymbol

data ModuleId

Module id

Constructors

ModuleId

Fields

moduleIdName :: Text

moduleIdLocation :: ModuleLocation

Instances

Eq ModuleId

Ord ModuleId

Show ModuleId

ToJSON ModuleId

FromJSON ModuleId

NFData ModuleId

Symbol ModuleId

Documented ModuleId

MonadState ResolvedTree ResolveM

unnamedModuleId :: ModuleLocation -> ModuleId

data Module

Module

Constructors

Module

Fields

moduleName :: Text

moduleDocs :: Maybe Text

moduleLocation :: ModuleLocation

moduleExports :: Maybe [Export]

moduleImports :: [Import]

moduleDeclarations :: [Declaration]

Instances

Eq Module

Ord Module

Show InspectedModule

Show Module

ToJSON InspectedModule

ToJSON Module

FromJSON InspectedModule

FromJSON Module

NFData Module

Symbol Module

Documented Module

sortDeclarations :: [Declaration] -> [Declaration]

moduleLocals :: Module -> Module

Bring locals to top

setDefinedIn :: Module -> Module

Set all declaration definedIn to this module

dropExternals :: Module -> Module

Drop all declarations, that not defined in this module

clearDefinedIn :: Module -> Module

Clear definedIn information

moduleLocalDeclarations :: Module -> [Declaration]

Get declarations with locals

moduleModuleDeclarations :: Module -> [ModuleDeclaration]

Get list of declarations as ModuleDeclaration

moduleId :: Module -> ModuleId

class Locals a where

Methods

locals :: a -> [Declaration]

where_ :: a -> [Declaration] -> a

Instances

Locals DeclarationInfo

Locals Declaration

data Declaration

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

Instances

Eq Declaration

Ord Declaration

Show Declaration

ToJSON Declaration

FromJSON Declaration

NFData Declaration

Symbol Declaration

Documented Declaration

Locals Declaration

decl :: Text -> DeclarationInfo -> Declaration

definedIn :: Declaration -> ModuleId -> Declaration

declarationLocals :: Declaration -> [Declaration]

scopes :: Declaration -> [Maybe Text]

Get scopes of Declaration, where Nothing is global scope

data TypeInfo

Common info for type, newtype, data and class

Constructors

TypeInfo

Fields

typeInfoContext :: Maybe Text

typeInfoArgs :: [Text]

typeInfoDefinition :: Maybe Text

Instances

Eq TypeInfo

Ord TypeInfo

Read TypeInfo

Show TypeInfo

ToJSON TypeInfo

FromJSON TypeInfo

NFData TypeInfo

data DeclarationInfo

Declaration info

Constructors

Function

Fields

functionType :: Maybe Text

localDeclarations :: [Declaration]

Type

Fields

typeInfo :: TypeInfo

NewType

Fields

newTypeInfo :: TypeInfo

Data

Fields

dataInfo :: TypeInfo

Class

Fields

classInfo :: TypeInfo

Instances

Eq DeclarationInfo

Ord DeclarationInfo

ToJSON DeclarationInfo

FromJSON DeclarationInfo

NFData DeclarationInfo

Locals DeclarationInfo

data ModuleDeclaration

Symbol in context of some module

Constructors

ModuleDeclaration

Fields

declarationModuleId :: ModuleId

moduleDeclaration :: Declaration

Instances

Eq ModuleDeclaration

Ord ModuleDeclaration

Show ModuleDeclaration

ToJSON ModuleDeclaration

FromJSON ModuleDeclaration

NFData ModuleDeclaration

Symbol ModuleDeclaration

Documented ModuleDeclaration

data ExportedDeclaration

Symbol exported with

Constructors

ExportedDeclaration

Fields

exportedBy :: [ModuleId]

exportedDeclaration :: Declaration

Instances

Eq ExportedDeclaration

Ord ExportedDeclaration

Show ExportedDeclaration

ToJSON ExportedDeclaration

FromJSON ExportedDeclaration

NFData ExportedDeclaration

mergeExported :: [ModuleDeclaration] -> [ExportedDeclaration]

Merge ModuleDeclaration into ExportedDeclaration

data Inspection

Inspection data

Constructors

InspectionNone

No inspection

InspectionAt POSIXTime [String]

Time and flags of inspection

Instances

Eq Inspection

Ord Inspection

Show Inspection

ToJSON Inspection

FromJSON Inspection

NFData Inspection

inspectionOpts :: Inspection -> [String]

Get inspection opts

data Inspected i a

Inspected entity

Constructors

Inspected

Fields

inspection :: Inspection

inspectedId :: i

inspectionResult :: Either String a

Instances

Show InspectedModule

ToJSON InspectedModule

FromJSON InspectedModule

Functor (Inspected i)

Foldable (Inspected i)

Traversable (Inspected i)

(Eq i, Eq a) => Eq (Inspected i a)

(Ord i, Ord a) => Ord (Inspected i a)

(NFData i, NFData a) => NFData (Inspected i a)

type InspectedModule = Inspected ModuleLocation Module

Inspected module

Functions

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

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

Get function type of type info

declarationTypeInfo :: DeclarationInfo -> Maybe TypeInfo

Get type info of declaration

declarationTypeCtor :: String -> TypeInfo -> DeclarationInfo

declarationTypeName :: DeclarationInfo -> Maybe String

qualifiedName :: ModuleId -> Declaration -> Text

Returns qualified name of symbol

importQualifier :: Maybe Text -> Import -> Bool

Imported module can be accessed via qualifier

Utility

class Canonicalize a where

Canonicalize all paths within something

Methods

canonicalize :: a -> IO a

Instances

Canonicalize Cabal

Canonicalize Project

Canonicalize ModuleLocation

locateProject :: FilePath -> IO (Maybe Project)

Find project file is related to

searchProject :: FilePath -> IO (Maybe Project)

Search project up

locateSourceDir :: FilePath -> IO (Maybe FilePath)

Locate source dir of file

sourceModuleRoot :: Text -> FilePath -> FilePath

Get source module root directory, i.e. for "...srcFooBar.hs" with module Bar will return "...src"

importedModulePath :: Text -> FilePath -> Text -> FilePath

Get path of imported module >importedModulePath Foo.Bar "...srcFooBar.hs" Quux.Blah = "...srcQuuxBlah.hs"

Modifiers

addDeclaration :: Declaration -> Module -> Module

Add declaration to module

Other

unalias :: Module -> Text -> [Text]

Unalias import name

moduleContents :: Module -> [String]

Module contents

Reexports

module HsDev.Symbols.Class

module HsDev.Symbols.Documented