Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Haskell.Names

Contents

Functions
Types
Reading and writing environments
Pretty printing

Synopsis

resolve :: (Data l, Eq l) => [Module l] -> Environment -> Environment
annotate :: (Data l, Eq l, SrcInfo l) => Environment -> Module l -> Module (Scoped l)
type Environment = Map (ModuleName ()) [Symbol]
data Symbol
- = Value {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  }
- | Method {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  - className :: Name ()
  }
- | Selector {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  - typeName :: Name ()
  - constructors :: [Name ()]
  }
- | Constructor {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  - typeName :: Name ()
  }
- | Type {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  }
- | Data {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  }
- | NewType {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  }
- | TypeFam {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  - associate :: Maybe (Name ())
  }
- | DataFam {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  - associate :: Maybe (Name ())
  }
- | Class {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  }
- | PatternConstructor {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  - patternTypeName :: Maybe (Name ())
  }
- | PatternSelector {
  - symbolModule :: ModuleName ()
  - symbolName :: Name ()
  - patternTypeName :: Maybe (Name ())
  - patternConstructorName :: Name ()
  }
data Scoped l = Scoped (NameInfo l) l
data NameInfo l
- = GlobalSymbol Symbol (QName ())
- | LocalValue SrcLoc
- | TypeVar SrcLoc
- | ValueBinder
- | TypeBinder
- | Import (Map (QName ()) [Symbol])
- | ImportPart [Symbol]
- | Export [Symbol]
- | RecPatWildcard [Symbol]
- | RecExpWildcard [(Symbol, NameInfo l)]
- | None
- | ScopeError (Error l)
data Error l
- = ENotInScope (QName l)
- | EAmbiguous (QName l) [Symbol]
- | ETypeAsClass (QName l)
- | EClassAsType (QName l)
- | ENotExported (Maybe (Name l)) (Name l) (ModuleName l)
- | EModNotFound (ModuleName l)
- | EInternal String
readSymbols :: FilePath -> IO [Symbol]
writeSymbols :: FilePath -> [Symbol] -> IO ()
loadBase :: IO Environment
ppError :: SrcInfo l => Error l -> String
ppSymbol :: Symbol -> String

Functions

resolve :: (Data l, Eq l) => [Module l] -> Environment -> Environment Source #

Takes a list of modules and an environment and updates the environment with each of the given modules' exported symbols. The modules can appear in any order and can be mutually recursive.

annotate :: (Data l, Eq l, SrcInfo l) => Environment -> Module l -> Module (Scoped l) Source #

Annotate a module with scoping information using the given environment. All imports of the given module should be in the environment.

Types

type Environment = Map (ModuleName ()) [Symbol] Source #

A map from module name to list of symbols it exports.

data Symbol Source #

Information about an entity. Carries at least the module it was originally declared in and its name.

Constructors

Value	value or function
Fields symbolModule :: ModuleName () symbolName :: Name ()
Method	class method
Fields symbolModule :: ModuleName () symbolName :: Name () className :: Name ()
Selector	record field selector
Fields symbolModule :: ModuleName () symbolName :: Name () typeName :: Name () constructors :: [Name ()]
Constructor	data constructor
Fields symbolModule :: ModuleName () symbolName :: Name () typeName :: Name ()
Type	type synonym
Fields symbolModule :: ModuleName () symbolName :: Name ()
Data	data type
Fields symbolModule :: ModuleName () symbolName :: Name ()
NewType	newtype
Fields symbolModule :: ModuleName () symbolName :: Name ()
TypeFam	type family
Fields symbolModule :: ModuleName () symbolName :: Name () associate :: Maybe (Name ())
DataFam	data family
Fields symbolModule :: ModuleName () symbolName :: Name () associate :: Maybe (Name ())
Class	type class
Fields symbolModule :: ModuleName () symbolName :: Name ()
PatternConstructor	pattern synonym constructor
Fields symbolModule :: ModuleName () symbolName :: Name () patternTypeName :: Maybe (Name ())
PatternSelector	pattern synonym selector
Fields symbolModule :: ModuleName () symbolName :: Name () patternTypeName :: Maybe (Name ()) patternConstructorName :: Name ()

Instances

Instances details

FromJSON Symbol Source #
Instance details Defined in Language.Haskell.Names.Environment Methods parseJSON :: Value -> Parser Symbol # parseJSONList :: Value -> Parser [Symbol] # omittedField :: Maybe Symbol #
ToJSON Symbol Source #
Instance details Defined in Language.Haskell.Names.Environment Methods toJSON :: Symbol -> Value # toEncoding :: Symbol -> Encoding # toJSONList :: [Symbol] -> Value # toEncodingList :: [Symbol] -> Encoding # omitField :: Symbol -> Bool #
Data Symbol Source #
Instance details Defined in Language.Haskell.Names.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Symbol -> c Symbol # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Symbol # toConstr :: Symbol -> Constr # dataTypeOf :: Symbol -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Symbol) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Symbol) # gmapT :: (forall b. Data b => b -> b) -> Symbol -> Symbol # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Symbol -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Symbol -> r # gmapQ :: (forall d. Data d => d -> u) -> Symbol -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Symbol -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Symbol -> m Symbol # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Symbol -> m Symbol # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Symbol -> m Symbol #
Show Symbol Source #
Instance details Defined in Language.Haskell.Names.Types Methods showsPrec :: Int -> Symbol -> ShowS # show :: Symbol -> String # showList :: [Symbol] -> ShowS #
Eq Symbol Source #
Instance details Defined in Language.Haskell.Names.Types Methods (==) :: Symbol -> Symbol -> Bool # (/=) :: Symbol -> Symbol -> Bool #
Ord Symbol Source #
Instance details Defined in Language.Haskell.Names.Types 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 #

data Scoped l Source #

A pair of the name information and original annotation. Used as an annotation type for AST.

Constructors

Scoped (NameInfo l) l

Instances

Instances details

Foldable Scoped Source #
Instance details Defined in Language.Haskell.Names.Types Methods fold :: Monoid m => Scoped m -> m # foldMap :: Monoid m => (a -> m) -> Scoped a -> m # foldMap' :: Monoid m => (a -> m) -> Scoped a -> m # foldr :: (a -> b -> b) -> b -> Scoped a -> b # foldr' :: (a -> b -> b) -> b -> Scoped a -> b # foldl :: (b -> a -> b) -> b -> Scoped a -> b # foldl' :: (b -> a -> b) -> b -> Scoped a -> b # foldr1 :: (a -> a -> a) -> Scoped a -> a # foldl1 :: (a -> a -> a) -> Scoped a -> a # toList :: Scoped a -> [a] # null :: Scoped a -> Bool # length :: Scoped a -> Int # elem :: Eq a => a -> Scoped a -> Bool # maximum :: Ord a => Scoped a -> a # minimum :: Ord a => Scoped a -> a # sum :: Num a => Scoped a -> a # product :: Num a => Scoped a -> a #
Traversable Scoped Source #
Instance details Defined in Language.Haskell.Names.Types Methods traverse :: Applicative f => (a -> f b) -> Scoped a -> f (Scoped b) # sequenceA :: Applicative f => Scoped (f a) -> f (Scoped a) # mapM :: Monad m => (a -> m b) -> Scoped a -> m (Scoped b) # sequence :: Monad m => Scoped (m a) -> m (Scoped a) #
Functor Scoped Source #
Instance details Defined in Language.Haskell.Names.Types Methods fmap :: (a -> b) -> Scoped a -> Scoped b # (<$) :: a -> Scoped b -> Scoped a #
Data l => Data (Scoped l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Scoped l -> c (Scoped l) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Scoped l) # toConstr :: Scoped l -> Constr # dataTypeOf :: Scoped l -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Scoped l)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Scoped l)) # gmapT :: (forall b. Data b => b -> b) -> Scoped l -> Scoped l # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Scoped l -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Scoped l -> r # gmapQ :: (forall d. Data d => d -> u) -> Scoped l -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Scoped l -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Scoped l -> m (Scoped l) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Scoped l -> m (Scoped l) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Scoped l -> m (Scoped l) #
Show l => Show (Scoped l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods showsPrec :: Int -> Scoped l -> ShowS # show :: Scoped l -> String # showList :: [Scoped l] -> ShowS #
Eq l => Eq (Scoped l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods (==) :: Scoped l -> Scoped l -> Bool # (/=) :: Scoped l -> Scoped l -> Bool #
Ord l => Ord (Scoped l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods compare :: Scoped l -> Scoped l -> Ordering # (<) :: Scoped l -> Scoped l -> Bool # (<=) :: Scoped l -> Scoped l -> Bool # (>) :: Scoped l -> Scoped l -> Bool # (>=) :: Scoped l -> Scoped l -> Bool # max :: Scoped l -> Scoped l -> Scoped l # min :: Scoped l -> Scoped l -> Scoped l #
Typeable a => Resolvable (Scoped a) Source #
Instance details Defined in Language.Haskell.Names.Open.Instances Methods rtraverse :: (Applicative f, ?alg :: Alg f) => Scoped a -> Scope -> f (Scoped a) Source #
SrcInfo l => SrcInfo (Scoped l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> Scoped l # fromSrcInfo :: SrcSpanInfo -> Scoped l # getPointLoc :: Scoped l -> SrcLoc # fileName :: Scoped l -> String # startLine :: Scoped l -> Int # startColumn :: Scoped l -> Int #

data NameInfo l Source #

Information about the names used in an AST.

Constructors

GlobalSymbol Symbol (QName ())	global entitiy and the way it is referenced
LocalValue SrcLoc	local value, and location where it is bound
TypeVar SrcLoc	type variable, and location where it is bound
ValueBinder	here the value name is bound
TypeBinder	here the type name is defined
Import (Map (QName ()) [Symbol])	`import` declaration, and the table of symbols that it introduces
ImportPart [Symbol]	part of an `import` declaration
Export [Symbol]	part of an `export` declaration
RecPatWildcard [Symbol]	wildcard in a record pattern. The list contains resolved names of the fields that are brought in scope by this pattern.
RecExpWildcard [(Symbol, NameInfo l)]	wildcard in a record construction expression. The list contains resolved names of the fields and information about values assigned to those fields.
None	no annotation
ScopeError (Error l)	scope error

Instances

Instances details

Foldable NameInfo Source #
Instance details Defined in Language.Haskell.Names.Types Methods fold :: Monoid m => NameInfo m -> m # foldMap :: Monoid m => (a -> m) -> NameInfo a -> m # foldMap' :: Monoid m => (a -> m) -> NameInfo a -> m # foldr :: (a -> b -> b) -> b -> NameInfo a -> b # foldr' :: (a -> b -> b) -> b -> NameInfo a -> b # foldl :: (b -> a -> b) -> b -> NameInfo a -> b # foldl' :: (b -> a -> b) -> b -> NameInfo a -> b # foldr1 :: (a -> a -> a) -> NameInfo a -> a # foldl1 :: (a -> a -> a) -> NameInfo a -> a # toList :: NameInfo a -> [a] # null :: NameInfo a -> Bool # length :: NameInfo a -> Int # elem :: Eq a => a -> NameInfo a -> Bool # maximum :: Ord a => NameInfo a -> a # minimum :: Ord a => NameInfo a -> a # sum :: Num a => NameInfo a -> a # product :: Num a => NameInfo a -> a #
Traversable NameInfo Source #
Instance details Defined in Language.Haskell.Names.Types Methods traverse :: Applicative f => (a -> f b) -> NameInfo a -> f (NameInfo b) # sequenceA :: Applicative f => NameInfo (f a) -> f (NameInfo a) # mapM :: Monad m => (a -> m b) -> NameInfo a -> m (NameInfo b) # sequence :: Monad m => NameInfo (m a) -> m (NameInfo a) #
Functor NameInfo Source #
Instance details Defined in Language.Haskell.Names.Types Methods fmap :: (a -> b) -> NameInfo a -> NameInfo b # (<$) :: a -> NameInfo b -> NameInfo a #
Data l => Data (NameInfo l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NameInfo l -> c (NameInfo l) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (NameInfo l) # toConstr :: NameInfo l -> Constr # dataTypeOf :: NameInfo l -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (NameInfo l)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (NameInfo l)) # gmapT :: (forall b. Data b => b -> b) -> NameInfo l -> NameInfo l # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NameInfo l -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NameInfo l -> r # gmapQ :: (forall d. Data d => d -> u) -> NameInfo l -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> NameInfo l -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> NameInfo l -> m (NameInfo l) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NameInfo l -> m (NameInfo l) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NameInfo l -> m (NameInfo l) #
Show l => Show (NameInfo l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods showsPrec :: Int -> NameInfo l -> ShowS # show :: NameInfo l -> String # showList :: [NameInfo l] -> ShowS #
Eq l => Eq (NameInfo l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods (==) :: NameInfo l -> NameInfo l -> Bool # (/=) :: NameInfo l -> NameInfo l -> Bool #
Ord l => Ord (NameInfo l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods compare :: NameInfo l -> NameInfo l -> Ordering # (<) :: NameInfo l -> NameInfo l -> Bool # (<=) :: NameInfo l -> NameInfo l -> Bool # (>) :: NameInfo l -> NameInfo l -> Bool # (>=) :: NameInfo l -> NameInfo l -> Bool # max :: NameInfo l -> NameInfo l -> NameInfo l # min :: NameInfo l -> NameInfo l -> NameInfo l #

data Error l Source #

Errors during name resolution.

Constructors

ENotInScope (QName l)	name is not in scope
EAmbiguous (QName l) [Symbol]	name is ambiguous
ETypeAsClass (QName l)	type is used where a type class is expected
EClassAsType (QName l)	type class is used where a type is expected
ENotExported (Maybe (Name l)) (Name l) (ModuleName l)	Attempt to explicitly import a name which is not exported (or, possibly, does not even exist). For example: import Prelude(Bool(Right)) The fields are: optional parent in the import list, e.g. `Bool` in `Bool(Right)` the name which is not exported the module which does not export the name
EModNotFound (ModuleName l)	module not found
EInternal String	internal error

Instances

Instances details

Foldable Error Source #
Instance details Defined in Language.Haskell.Names.Types Methods fold :: Monoid m => Error m -> m # foldMap :: Monoid m => (a -> m) -> Error a -> m # foldMap' :: Monoid m => (a -> m) -> Error a -> m # foldr :: (a -> b -> b) -> b -> Error a -> b # foldr' :: (a -> b -> b) -> b -> Error a -> b # foldl :: (b -> a -> b) -> b -> Error a -> b # foldl' :: (b -> a -> b) -> b -> Error a -> b # foldr1 :: (a -> a -> a) -> Error a -> a # foldl1 :: (a -> a -> a) -> Error a -> a # toList :: Error a -> [a] # null :: Error a -> Bool # length :: Error a -> Int # elem :: Eq a => a -> Error a -> Bool # maximum :: Ord a => Error a -> a # minimum :: Ord a => Error a -> a # sum :: Num a => Error a -> a # product :: Num a => Error a -> a #
Traversable Error Source #
Instance details Defined in Language.Haskell.Names.Types Methods traverse :: Applicative f => (a -> f b) -> Error a -> f (Error b) # sequenceA :: Applicative f => Error (f a) -> f (Error a) # mapM :: Monad m => (a -> m b) -> Error a -> m (Error b) # sequence :: Monad m => Error (m a) -> m (Error a) #
Functor Error Source #
Instance details Defined in Language.Haskell.Names.Types Methods fmap :: (a -> b) -> Error a -> Error b # (<$) :: a -> Error b -> Error a #
Data l => Data (Error l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Error l -> c (Error l) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Error l) # toConstr :: Error l -> Constr # dataTypeOf :: Error l -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Error l)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Error l)) # gmapT :: (forall b. Data b => b -> b) -> Error l -> Error l # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Error l -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Error l -> r # gmapQ :: (forall d. Data d => d -> u) -> Error l -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Error l -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Error l -> m (Error l) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Error l -> m (Error l) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Error l -> m (Error l) #
Show l => Show (Error l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods showsPrec :: Int -> Error l -> ShowS # show :: Error l -> String # showList :: [Error l] -> ShowS #
Eq l => Eq (Error l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods (==) :: Error l -> Error l -> Bool # (/=) :: Error l -> Error l -> Bool #
Ord l => Ord (Error l) Source #
Instance details Defined in Language.Haskell.Names.Types Methods compare :: Error l -> Error l -> Ordering # (<) :: Error l -> Error l -> Bool # (<=) :: Error l -> Error l -> Bool # (>) :: Error l -> Error l -> Bool # (>=) :: Error l -> Error l -> Bool # max :: Error l -> Error l -> Error l # min :: Error l -> Error l -> Error l #

Reading and writing environments

readSymbols :: FilePath -> IO [Symbol] Source #

Read symbols from a file.

writeSymbols :: FilePath -> [Symbol] -> IO () Source #

Write symbols to a file.

loadBase :: IO Environment Source #

Load a basic environment that contains modules very similar to GHC's base package.

Pretty printing

ppError :: SrcInfo l => Error l -> String Source #

Display an error.

Note: can span multiple lines; the trailing newline is included.

ppSymbol :: Symbol -> String Source #

Pretty print a symbol.