Generics.MRSOP.Base.Metadata

Metadata maintenance; usefull for pretty-printing values.

Documentation

type ModuleName = String

type FamilyName = String

type ConstructorName = String

type FieldName = String

data DatatypeName

Since we only handled fully saturated datatypes, a DatatypeName needs to remember what were the arguments applied to a type.

The type [Int] is represented by Name "[]" :: Name Int

Constructors

Name String

DatatypeName :@: DatatypeName infixl 5

Instances

Eq DatatypeName

Defined in Generics.MRSOP.Base.Metadata

Methods

(==) :: DatatypeName -> DatatypeName -> Bool

(/=) :: DatatypeName -> DatatypeName -> Bool

Show DatatypeName

Defined in Generics.MRSOP.Base.Metadata

Methods

showsPrec :: Int -> DatatypeName -> ShowS

show :: DatatypeName -> String

showList :: [DatatypeName] -> ShowS

data DatatypeInfo :: [[Atom kon]] -> * where

Provides information about the declaration of a datatype.

Constructors

ADT :: ModuleName -> DatatypeName -> NP ConstructorInfo c -> DatatypeInfo c

New :: ModuleName -> DatatypeName -> ConstructorInfo '[c] -> DatatypeInfo '['[c]]

Instances

All (Compose Show (ConstructorInfo :: [Atom kon] -> Type)) code => Show (DatatypeInfo code)

Defined in Generics.MRSOP.Base.Metadata

Methods

showsPrec :: Int -> DatatypeInfo code -> ShowS

show :: DatatypeInfo code -> String

showList :: [DatatypeInfo code] -> ShowS

moduleName :: DatatypeInfo code -> ModuleName

Returns the name of a module

datatypeName :: DatatypeInfo code -> DatatypeName

Returns the name of a datatype

constructorInfo :: DatatypeInfo code -> NP ConstructorInfo code

Returns information about the constructor fields

data Associativity

Associativity information for infix constructors.

Constructors

LeftAssociative

RightAssociative

NotAssociative

Instances

Eq Associativity

Defined in Generics.MRSOP.Base.Metadata

Methods

(==) :: Associativity -> Associativity -> Bool

(/=) :: Associativity -> Associativity -> Bool

Show Associativity

Defined in Generics.MRSOP.Base.Metadata

Methods

showsPrec :: Int -> Associativity -> ShowS

show :: Associativity -> String

showList :: [Associativity] -> ShowS

type Fixity = Int

Fixity information for infix constructors.

data ConstructorInfo :: [Atom kon] -> * where

Constructor metadata.

Constructors

Constructor :: ConstructorName -> ConstructorInfo xs

Infix :: ConstructorName -> Associativity -> Fixity -> ConstructorInfo '[x, y]

Record :: ConstructorName -> NP FieldInfo xs -> ConstructorInfo xs

Instances

All (Compose Show (FieldInfo :: Atom kon -> Type)) code => Show (ConstructorInfo code)

Defined in Generics.MRSOP.Base.Metadata

Methods

showsPrec :: Int -> ConstructorInfo code -> ShowS

show :: ConstructorInfo code -> String

showList :: [ConstructorInfo code] -> ShowS

constructorName :: ConstructorInfo con -> ConstructorName

Returns the name of a constructor

data FieldInfo :: Atom kon -> * where

Record fields metadata

Constructors

FieldInfo

Fields

• :: { fieldName :: FieldName
•    } -> FieldInfo k

Instances

Show (FieldInfo atom)

Defined in Generics.MRSOP.Base.Metadata

Methods

showsPrec :: Int -> FieldInfo atom -> ShowS

show :: FieldInfo atom -> String

showList :: [FieldInfo atom] -> ShowS

class Family ki fam codes => HasDatatypeInfo ki fam codes | fam -> codes ki where

Given a Family, provides the DatatypeInfo for the type with index ix in family fam.

Methods

datatypeInfo :: Proxy fam -> SNat ix -> DatatypeInfo (Lkup ix codes)

Instances

HasDatatypeInfo Singl FamRose CodesRose

Defined in Generics.MRSOP.Examples.RoseTree

Methods

datatypeInfo :: Proxy FamRose -> SNat ix -> DatatypeInfo (Lkup ix CodesRose)

datatypeInfoFor :: forall ki fam codes ix ty. (HasDatatypeInfo ki fam codes, ix ~ Idx ty fam, Lkup ix fam ~ ty, IsNat ix) => Proxy fam -> Proxy ty -> DatatypeInfo (Lkup ix codes)

Sometimes it is more convenient to use a proxy of the type in the family instead of indexes.

Name Lookup

constrInfoLkup :: Constr sum c -> DatatypeInfo sum -> ConstructorInfo (Lkup c sum)

This is essentially a list lookup, but needs significant type information to go through. Returns the name of the cth constructor of a sum-type.

constrInfoFor :: HasDatatypeInfo ki fam codes => Proxy fam -> SNat ix -> Constr (Lkup ix codes) c -> ConstructorInfo (Lkup c (Lkup ix codes))

Returns the constructor information for a given type in the family.