Safe Haskell	Safe
Language	Haskell2010

FreeC.IR.Reference

Contents

References
Finding References
Free Type Variables
Free Variables

Description

This module contains functions to extract the names of (type) constructors and variables that are referenced by AST nodes such as expressions and type expressions.

These functions are used to construct the dependency graph and to find free (type) variables in (type) expressions.

Synopsis

data Ref
- = VarRef {
  - unwrapRef :: ScopedName
  }
- | ConRef {
  - unwrapRef :: ScopedName
  }
refScope :: Ref -> Scope
refName :: Ref -> QName
isVarRef :: Ref -> Bool
isConRef :: Ref -> Bool
isTypeRef :: Ref -> Bool
isValueRef :: Ref -> Bool
class HasRefs a
refs :: HasRefs a => a -> [Ref]
typeRefs :: HasRefs a => a -> [QName]
valueRefs :: HasRefs a => a -> [QName]
freeTypeVars :: HasRefs a => a -> [TypeVarIdent]
freeTypeVarSet :: HasRefs a => a -> Set TypeVarIdent
freeVars :: HasRefs a => a -> [QName]
freeVarSet :: HasRefs a => a -> Set QName

References

data Ref Source #

Wrapper that is used to remember whether a name refers to a variable or constructor.

The wrapped names are ScopedNames such that we can use the same function to collect the type- and value-level references.

Constructors

VarRef
Fields unwrapRef :: ScopedName
ConRef
Fields unwrapRef :: ScopedName

Instances

Eq Ref Source #
Instance details Defined in FreeC.IR.Reference Methods (==) :: Ref -> Ref -> Bool Source # (/=) :: Ref -> Ref -> Bool Source #
Ord Ref Source #
Instance details Defined in FreeC.IR.Reference Methods compare :: Ref -> Ref -> Ordering Source # (<) :: Ref -> Ref -> Bool Source # (<=) :: Ref -> Ref -> Bool Source # (>) :: Ref -> Ref -> Bool Source # (>=) :: Ref -> Ref -> Bool Source # max :: Ref -> Ref -> Ref Source # min :: Ref -> Ref -> Ref Source #
Show Ref Source #
Instance details Defined in FreeC.IR.Reference Methods showsPrec :: Int -> Ref -> ShowS Source # show :: Ref -> String Source # showList :: [Ref] -> ShowS Source #

refScope :: Ref -> Scope Source #

Unwraps the given reference and discards the name.

refName :: Ref -> QName Source #

Unwraps the given reference and discards the scope information.

isVarRef :: Ref -> Bool Source #

Tests whether the given reference refers to a variable or type variable.

isConRef :: Ref -> Bool Source #

Tests whether the given reference refers to a constructor or type constructor.

isTypeRef :: Ref -> Bool Source #

Tests whether the given reference refers to a type-level entry.

isValueRef :: Ref -> Bool Source #

Tests whether the given reference refers to a value-level entry.

Finding References

class HasRefs a Source #

Type class for AST nodes that contain references to (type) variables and constructors.

Minimal complete definition

refSet

Instances

HasRefs Type Source #	Type expressions refer to the used type variables and type constructors.
Instance details Defined in FreeC.IR.Reference Methods refSet :: Type -> RefSet
HasRefs TypeScheme Source #	Type schemes refer to the types it's type expression refers to but not to the type variables that are bound by the type scheme.
Instance details Defined in FreeC.IR.Reference Methods refSet :: TypeScheme -> RefSet
HasRefs ConDecl Source #	Constructor declarations refer to the types their field types refer to.
Instance details Defined in FreeC.IR.Reference Methods refSet :: ConDecl -> RefSet
HasRefs TypeDecl Source #	Data type declarations refer to the types their constructors refer to and type synonym declarations refer to the types it's right-hand side refers to. Both don't refer to type variables that are bound by their type arguments.
Instance details Defined in FreeC.IR.Reference Methods refSet :: TypeDecl -> RefSet
HasRefs Bind Source #
Instance details Defined in FreeC.IR.Reference Methods refSet :: Bind -> RefSet
HasRefs VarPat Source #	Variable patterns refer to the types used in their type annotation.
Instance details Defined in FreeC.IR.Reference Methods refSet :: VarPat -> RefSet
HasRefs ConPat Source #	Constructor patterns refer to the matched constructor.
Instance details Defined in FreeC.IR.Reference Methods refSet :: ConPat -> RefSet
HasRefs Alt Source #	`case` expression alternatives refer to the matched constructor, the types the type annotations of the variable patterns refer to and the references of the right-hand side that are not bound by the variable patterns.
Instance details Defined in FreeC.IR.Reference Methods refSet :: Alt -> RefSet
HasRefs Expr Source #	Expression refer to the used variables and constructors as wells as the types used in type signatures and visible type applications. The error terms `undefined` and `error "msg"` refer to the functions `undefinedFuncName` and `errorFuncName` respectively. The term `trace "msg" expr` refers to the function `traceFuncName`.
Instance details Defined in FreeC.IR.Reference Methods refSet :: Expr -> RefSet
HasRefs FuncDecl Source #	Function declarations refer to the types their argument and return type annotations refer to as well as the references of their right-hand side except for the (type) variables bound by the function's (type) arguments.
Instance details Defined in FreeC.IR.Reference Methods refSet :: FuncDecl -> RefSet
HasRefs a => HasRefs [a] Source #	Utility instance to get the references of all elements in a list.
Instance details Defined in FreeC.IR.Reference Methods refSet :: [a] -> RefSet
HasRefs a => HasRefs (Maybe a) Source #	Utility instance to get the references of an optional value. Returns references of the wrapped value or an empty set for `Nothing`.
Instance details Defined in FreeC.IR.Reference Methods refSet :: Maybe a -> RefSet

refs :: HasRefs a => a -> [Ref] Source #

Gets all references to variables, constructors, type variables and type constructors in the given node as they occur from left to right.

typeRefs :: HasRefs a => a -> [QName] Source #

Gets the names of all type variables and type constructors the given node refers to.

valueRefs :: HasRefs a => a -> [QName] Source #

gets the names of all variable and constructors the given node refers to.

Free Type Variables

freeTypeVars :: HasRefs a => a -> [TypeVarIdent] Source #

The type variables that occur freely in the given node from left to right.

freeTypeVarSet :: HasRefs a => a -> Set TypeVarIdent Source #

The type variables that occur freely in the given node.

Free Variables

freeVars :: HasRefs a => a -> [QName] Source #

The variables that occur freely in the given node from left to right.

freeVarSet :: HasRefs a => a -> Set QName Source #

The variables that occur freely in the given node.