Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.DataDeclaration

Synopsis

data DataDeclaration v a = DataDeclaration {
- modifier :: Modifier
- annotation :: a
- bound :: [v]
- constructors' :: [(a, v, Type v a)]
}
newtype EffectDeclaration v a = EffectDeclaration {
- toDataDecl :: DataDeclaration v a
}
type Decl v a = Either (EffectDeclaration v a) (DataDeclaration v a)
data DeclOrBuiltin v a
- = Builtin ConstructorType
- | Decl (Decl v a)
data Modifier
- = Structural
- | Unique Text
allVars :: Ord v => DataDeclaration v a -> Set v
asDataDecl :: Decl v a -> DataDeclaration v a
bindReferences :: Var v => (v -> Name) -> Set v -> Map Name Reference -> DataDeclaration v a -> ResolutionResult a (DataDeclaration v a)
constructorCount :: DataDeclaration v a -> Int
constructorNames :: Var v => DataDeclaration v a -> [Text]
constructors :: DataDeclaration v a -> [(v, Type v a)]
constructorType :: Decl v a -> ConstructorType
constructorTypes :: DataDeclaration v a -> [Type v a]
constructorVars :: DataDeclaration v a -> [v]
constructorIds :: DataDeclaration v a -> [ConstructorId]
declConstructorReferents :: TypeReferenceId -> Decl v a -> [Id]
declTypeDependencies :: Ord v => Decl v a -> Set Reference
labeledDeclTypeDependencies :: Ord v => Decl v a -> Set LabeledDependency
labeledDeclDependenciesIncludingSelf :: Ord v => TypeReference -> Decl v a -> Set LabeledDependency
declFields :: Var v => Decl v a -> Either [Int] [Int]
typeDependencies :: Ord v => DataDeclaration v a -> Set TypeReference
labeledTypeDependencies :: Ord v => DataDeclaration v a -> Set LabeledDependency
unhashComponent :: forall v a. Var v => Map Id (Decl v a) -> Map Id (v, Decl v a)
mkDataDecl' :: Modifier -> a -> [v] -> [(a, v, Type v a)] -> DataDeclaration v a
mkEffectDecl' :: Modifier -> a -> [v] -> [(a, v, Type v a)] -> EffectDeclaration v a
typeOfConstructor :: DataDeclaration v a -> ConstructorId -> Maybe (Type v a)
withEffectDeclM :: Functor f => (DataDeclaration v a -> f (DataDeclaration v' a')) -> EffectDeclaration v a -> f (EffectDeclaration v' a')
amap :: (a -> a2) -> Decl v a -> Decl v a2
updateDependencies :: Ord v => Map Reference Reference -> Decl v a -> Decl v a
constructors_ :: Lens' (DataDeclaration v a) [(a, v, Type v a)]
asDataDecl_ :: Iso' (EffectDeclaration v a) (DataDeclaration v a)
declAsDataDecl_ :: Lens' (Decl v a) (DataDeclaration v a)
setConstructorNames :: [v] -> Decl v a -> Decl v a

Documentation

data DataDeclaration v a Source #

Constructors

DataDeclaration
Fields modifier :: Modifier annotation :: a bound :: [v] constructors' :: [(a, v, Type v a)]

Instances

Instances details

Functor (DataDeclaration v) Source #
Instance details Defined in Unison.DataDeclaration Methods fmap :: (a -> b) -> DataDeclaration v a -> DataDeclaration v b # (<$) :: a -> DataDeclaration v b -> DataDeclaration v a #
Generic (DataDeclaration v a) Source #
Instance details Defined in Unison.DataDeclaration Associated Types type Rep (DataDeclaration v a) :: Type -> Type # Methods from :: DataDeclaration v a -> Rep (DataDeclaration v a) x # to :: Rep (DataDeclaration v a) x -> DataDeclaration v a #
(Show a, Show v) => Show (DataDeclaration v a) Source #
Instance details Defined in Unison.DataDeclaration Methods showsPrec :: Int -> DataDeclaration v a -> ShowS # show :: DataDeclaration v a -> String # showList :: [DataDeclaration v a] -> ShowS #
(Eq a, Var v) => Eq (DataDeclaration v a) Source #
Instance details Defined in Unison.DataDeclaration Methods (==) :: DataDeclaration v a -> DataDeclaration v a -> Bool # (/=) :: DataDeclaration v a -> DataDeclaration v a -> Bool #
(Var v, Ord a) => Ord (DataDeclaration v a) Source #
Instance details Defined in Unison.DataDeclaration Methods compare :: DataDeclaration v a -> DataDeclaration v a -> Ordering # (<) :: DataDeclaration v a -> DataDeclaration v a -> Bool # (<=) :: DataDeclaration v a -> DataDeclaration v a -> Bool # (>) :: DataDeclaration v a -> DataDeclaration v a -> Bool # (>=) :: DataDeclaration v a -> DataDeclaration v a -> Bool # max :: DataDeclaration v a -> DataDeclaration v a -> DataDeclaration v a # min :: DataDeclaration v a -> DataDeclaration v a -> DataDeclaration v a #
type Rep (DataDeclaration v a) Source #
Instance details Defined in Unison.DataDeclaration type Rep (DataDeclaration v a) = D1 ('MetaData "DataDeclaration" "Unison.DataDeclaration" "unison-core1-0.0.0-Kp7ZcNnt5XdB8ImvFwyntI" 'False) (C1 ('MetaCons "DataDeclaration" 'PrefixI 'True) ((S1 ('MetaSel ('Just "modifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Modifier) :: S1 ('MetaSel ('Just "annotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :: (S1 ('MetaSel ('Just "bound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [v]) :*: S1 ('MetaSel ('Just "constructors'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(a, v, Type v a)]))))

newtype EffectDeclaration v a Source #

Constructors

EffectDeclaration
Fields toDataDecl :: DataDeclaration v a

Instances

Instances details

Functor (EffectDeclaration v) Source #
Instance details Defined in Unison.DataDeclaration Methods fmap :: (a -> b) -> EffectDeclaration v a -> EffectDeclaration v b # (<$) :: a -> EffectDeclaration v b -> EffectDeclaration v a #
(Show a, Show v) => Show (EffectDeclaration v a) Source #
Instance details Defined in Unison.DataDeclaration Methods showsPrec :: Int -> EffectDeclaration v a -> ShowS # show :: EffectDeclaration v a -> String # showList :: [EffectDeclaration v a] -> ShowS #
(Var v, Eq a) => Eq (EffectDeclaration v a) Source #
Instance details Defined in Unison.DataDeclaration Methods (==) :: EffectDeclaration v a -> EffectDeclaration v a -> Bool # (/=) :: EffectDeclaration v a -> EffectDeclaration v a -> Bool #
(Var v, Ord a) => Ord (EffectDeclaration v a) Source #
Instance details Defined in Unison.DataDeclaration Methods compare :: EffectDeclaration v a -> EffectDeclaration v a -> Ordering # (<) :: EffectDeclaration v a -> EffectDeclaration v a -> Bool # (<=) :: EffectDeclaration v a -> EffectDeclaration v a -> Bool # (>) :: EffectDeclaration v a -> EffectDeclaration v a -> Bool # (>=) :: EffectDeclaration v a -> EffectDeclaration v a -> Bool # max :: EffectDeclaration v a -> EffectDeclaration v a -> EffectDeclaration v a # min :: EffectDeclaration v a -> EffectDeclaration v a -> EffectDeclaration v a #

type Decl v a = Either (EffectDeclaration v a) (DataDeclaration v a) Source #

data DeclOrBuiltin v a Source #

Constructors

Builtin ConstructorType
Decl (Decl v a)

Instances

Instances details

(Show a, Show v) => Show (DeclOrBuiltin v a) Source #
Instance details Defined in Unison.DataDeclaration Methods showsPrec :: Int -> DeclOrBuiltin v a -> ShowS # show :: DeclOrBuiltin v a -> String # showList :: [DeclOrBuiltin v a] -> ShowS #
(Var v, Eq a) => Eq (DeclOrBuiltin v a) Source #
Instance details Defined in Unison.DataDeclaration Methods (==) :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> Bool # (/=) :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> Bool #
(Var v, Ord a) => Ord (DeclOrBuiltin v a) Source #
Instance details Defined in Unison.DataDeclaration Methods compare :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> Ordering # (<) :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> Bool # (<=) :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> Bool # (>) :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> Bool # (>=) :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> Bool # max :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> DeclOrBuiltin v a # min :: DeclOrBuiltin v a -> DeclOrBuiltin v a -> DeclOrBuiltin v a #

data Modifier Source #

Constructors

Structural
Unique Text

Instances

Instances details

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

allVars :: Ord v => DataDeclaration v a -> Set v Source #

All variables mentioned in the given data declaration. Includes both term and type variables, both free and bound.

asDataDecl :: Decl v a -> DataDeclaration v a Source #

bindReferences :: Var v => (v -> Name) -> Set v -> Map Name Reference -> DataDeclaration v a -> ResolutionResult a (DataDeclaration v a) Source #

constructorCount :: DataDeclaration v a -> Int Source #

constructorNames :: Var v => DataDeclaration v a -> [Text] Source #

constructors :: DataDeclaration v a -> [(v, Type v a)] Source #

constructorType :: Decl v a -> ConstructorType Source #

constructorTypes :: DataDeclaration v a -> [Type v a] Source #

constructorVars :: DataDeclaration v a -> [v] Source #

constructorIds :: DataDeclaration v a -> [ConstructorId] Source #

The constructor ids for the given data declaration.

declConstructorReferents :: TypeReferenceId -> Decl v a -> [Id] Source #

declTypeDependencies :: Ord v => Decl v a -> Set Reference Source #

labeledDeclTypeDependencies :: Ord v => Decl v a -> Set LabeledDependency Source #

labeledDeclDependenciesIncludingSelf :: Ord v => TypeReference -> Decl v a -> Set LabeledDependency Source #

Compute the dependencies of a data declaration, including the type itself and references for each of its constructors.

NOTE: You may prefer labeledDeclDependenciesIncludingSelfAndFieldAccessors in Unison.DataDeclaration.Dependencies, it also includes Referents for accessors of record fields.

declFields :: Var v => Decl v a -> Either [Int] [Int] Source #

typeDependencies :: Ord v => DataDeclaration v a -> Set TypeReference Source #

All references to types mentioned in the given data declaration's fields/constructors Note: Does not include references to the constructors or the decl itself (unless the decl is self-referential) Note: Does NOT include the referents for fields and field accessors. Those must be computed separately because we need access to the typechecker to do so.

labeledTypeDependencies :: Ord v => DataDeclaration v a -> Set LabeledDependency Source #

unhashComponent :: forall v a. Var v => Map Id (Decl v a) -> Map Id (v, Decl v a) Source #

This converts References it finds that are in the input Map back to free variables.

In the result map, any of the references inside the Decls which are keys of the input map; have been replaced with the corresponding output vs in the output Decls, which are fresh with respect to all input Decls.

mkDataDecl' :: Modifier -> a -> [v] -> [(a, v, Type v a)] -> DataDeclaration v a Source #

mkEffectDecl' :: Modifier -> a -> [v] -> [(a, v, Type v a)] -> EffectDeclaration v a Source #

typeOfConstructor :: DataDeclaration v a -> ConstructorId -> Maybe (Type v a) Source #

withEffectDeclM :: Functor f => (DataDeclaration v a -> f (DataDeclaration v' a')) -> EffectDeclaration v a -> f (EffectDeclaration v' a') Source #

amap :: (a -> a2) -> Decl v a -> Decl v a2 Source #

updateDependencies :: Ord v => Map Reference Reference -> Decl v a -> Decl v a Source #

constructors_ :: Lens' (DataDeclaration v a) [(a, v, Type v a)] Source #

asDataDecl_ :: Iso' (EffectDeclaration v a) (DataDeclaration v a) Source #

declAsDataDecl_ :: Lens' (Decl v a) (DataDeclaration v a) Source #

setConstructorNames :: [v] -> Decl v a -> Decl v a Source #

Overwrite the constructor names with the given list, given in canonical order, which is assumed to be of the correct length.

Presumably this is called because the decl was loaded from the database outside of the context of a namespace, since it's not stored with names there, so we had plugged in dummy names like Constructor1, Constructor2, ...

Then, at some point, we discover the constructors' names in a namespace, and now we'd like to combine the two together to get a Decl structure in memory with good/correct names for constructors.