Safe Haskell	None
Language	Haskell2010

Generics.SOP.Metadata

Contents

re-exports

Description

Metadata about what a datatype looks like

In generics-sop, the metadata is completely independent of the main universe. Many generic functions will use this metadata, but other don't, and yet others might need completely different metadata.

This module defines a datatype to represent standard metadata, i.e., names of the datatype, its constructors, and possibly its record selectors. Metadata descriptions are in general GADTs indexed by the code of the datatype they're associated with, so matching on the metadata will reveal information about the shape of the datatype.

Synopsis

constructorInfo :: forall (xss :: [[Type]]). DatatypeInfo xss -> NP ConstructorInfo xss
constructorName :: forall (xs :: [Type]). ConstructorInfo xs -> ConstructorName
datatypeName :: forall (xss :: [[Type]]). DatatypeInfo xss -> DatatypeName
fieldName :: FieldInfo a -> FieldName
moduleName :: forall (xss :: [[Type]]). DatatypeInfo xss -> ModuleName
data ConstructorInfo (a :: [Type]) where
- Constructor :: forall (a :: [Type]). SListI a => ConstructorName -> ConstructorInfo a
- Infix :: forall x y. ConstructorName -> Associativity -> Fixity -> ConstructorInfo '[x, y]
- Record :: forall (a :: [Type]). SListI a => ConstructorName -> NP FieldInfo a -> ConstructorInfo a
type ConstructorName = String
data DatatypeInfo (a :: [[Type]]) where
- ADT :: forall (a :: [[Type]]). ModuleName -> DatatypeName -> NP ConstructorInfo a -> POP StrictnessInfo a -> DatatypeInfo a
- Newtype :: forall x. ModuleName -> DatatypeName -> ConstructorInfo '[x] -> DatatypeInfo '['[x]]
type DatatypeName = String
data FieldInfo a where
- FieldInfo :: forall a. FieldName -> FieldInfo a
type FieldName = String
type Fixity = Int
type ModuleName = String
data StrictnessInfo a where
- StrictnessInfo :: forall a. SourceUnpackedness -> SourceStrictness -> DecidedStrictness -> StrictnessInfo a
data Associativity
- = LeftAssociative
- | RightAssociative
- | NotAssociative
data DecidedStrictness
- = DecidedLazy
- | DecidedStrict
- | DecidedUnpack
data SourceStrictness
- = NoSourceStrictness
- | SourceLazy
- | SourceStrict
data SourceUnpackedness

Documentation

constructorInfo :: forall (xss :: [[Type]]). DatatypeInfo xss -> NP ConstructorInfo xss Source #

The constructor info for a datatype (or newtype).

Since: 0.2.3.0

constructorName :: forall (xs :: [Type]). ConstructorInfo xs -> ConstructorName Source #

The name of a constructor.

Since: 0.2.3.0

datatypeName :: forall (xss :: [[Type]]). DatatypeInfo xss -> DatatypeName Source #

The name of a datatype (or newtype).

Since: 0.2.3.0

fieldName :: FieldInfo a -> FieldName Source #

The name of a field.

Since: 0.2.3.0

moduleName :: forall (xss :: [[Type]]). DatatypeInfo xss -> ModuleName Source #

The module name where a datatype is defined.

Since: 0.2.3.0

data ConstructorInfo (a :: [Type]) where Source #

Metadata for a single constructor.

This is indexed by the product structure of the constructor components.

Constructors

Constructor :: forall (a :: [Type]). SListI a => ConstructorName -> ConstructorInfo a
Infix :: forall x y. ConstructorName -> Associativity -> Fixity -> ConstructorInfo '[x, y]
Record :: forall (a :: [Type]). SListI a => ConstructorName -> NP FieldInfo a -> ConstructorInfo a

Instances

Instances details

All (Compose Show FieldInfo) xs => Show (ConstructorInfo xs) Source #
Instance details Defined in Generics.SOP.Metadata Methods showsPrec :: Int -> ConstructorInfo xs -> ShowS show :: ConstructorInfo xs -> String showList :: [ConstructorInfo xs] -> ShowS
All (Compose Eq FieldInfo) xs => Eq (ConstructorInfo xs) Source #
Instance details Defined in Generics.SOP.Metadata Methods (==) :: ConstructorInfo xs -> ConstructorInfo xs -> Bool (/=) :: ConstructorInfo xs -> ConstructorInfo xs -> Bool
(All (Compose Eq FieldInfo) xs, All (Compose Ord FieldInfo) xs) => Ord (ConstructorInfo xs) Source #
Instance details Defined in Generics.SOP.Metadata Methods compare :: ConstructorInfo xs -> ConstructorInfo xs -> Ordering (<) :: ConstructorInfo xs -> ConstructorInfo xs -> Bool (<=) :: ConstructorInfo xs -> ConstructorInfo xs -> Bool (>) :: ConstructorInfo xs -> ConstructorInfo xs -> Bool (>=) :: ConstructorInfo xs -> ConstructorInfo xs -> Bool max :: ConstructorInfo xs -> ConstructorInfo xs -> ConstructorInfo xs min :: ConstructorInfo xs -> ConstructorInfo xs -> ConstructorInfo xs

type ConstructorName = String Source #

The name of a data constructor.

data DatatypeInfo (a :: [[Type]]) where Source #

Metadata for a datatype.

A value of type DatatypeInfo c contains the information about a datatype that is not contained in Code c. This information consists primarily of the names of the datatype, its constructors, and possibly its record selectors.

The constructor indicates whether the datatype has been declared using newtype or not.

Constructors

ADT :: forall (a :: [[Type]]). ModuleName -> DatatypeName -> NP ConstructorInfo a -> POP StrictnessInfo a -> DatatypeInfo a
Newtype :: forall x. ModuleName -> DatatypeName -> ConstructorInfo '[x] -> DatatypeInfo '['[x]]

Instances

Instances details

(All (Compose Show ConstructorInfo) xs, All (Compose Show (NP StrictnessInfo)) xs) => Show (DatatypeInfo xs) Source #
Instance details Defined in Generics.SOP.Metadata Methods showsPrec :: Int -> DatatypeInfo xs -> ShowS show :: DatatypeInfo xs -> String showList :: [DatatypeInfo xs] -> ShowS
(All (Compose Eq ConstructorInfo) xs, All (Compose Eq (NP StrictnessInfo)) xs) => Eq (DatatypeInfo xs) Source #
Instance details Defined in Generics.SOP.Metadata Methods (==) :: DatatypeInfo xs -> DatatypeInfo xs -> Bool (/=) :: DatatypeInfo xs -> DatatypeInfo xs -> Bool
(All (Compose Eq ConstructorInfo) xs, All (Compose Ord ConstructorInfo) xs, All (Compose Eq (NP StrictnessInfo)) xs, All (Compose Ord (NP StrictnessInfo)) xs) => Ord (DatatypeInfo xs) Source #
Instance details Defined in Generics.SOP.Metadata Methods compare :: DatatypeInfo xs -> DatatypeInfo xs -> Ordering (<) :: DatatypeInfo xs -> DatatypeInfo xs -> Bool (<=) :: DatatypeInfo xs -> DatatypeInfo xs -> Bool (>) :: DatatypeInfo xs -> DatatypeInfo xs -> Bool (>=) :: DatatypeInfo xs -> DatatypeInfo xs -> Bool max :: DatatypeInfo xs -> DatatypeInfo xs -> DatatypeInfo xs min :: DatatypeInfo xs -> DatatypeInfo xs -> DatatypeInfo xs

type DatatypeName = String Source #

The name of a datatype.

data FieldInfo a where Source #

For records, this functor maps the component to its selector name.

Constructors

FieldInfo :: forall a. FieldName -> FieldInfo a

Instances

Instances details

Functor FieldInfo Source #
Instance details Defined in Generics.SOP.Metadata Methods fmap :: (a -> b) -> FieldInfo a -> FieldInfo b (<$) :: a -> FieldInfo b -> FieldInfo a
Show (FieldInfo a) Source #
Instance details Defined in Generics.SOP.Metadata Methods showsPrec :: Int -> FieldInfo a -> ShowS show :: FieldInfo a -> String showList :: [FieldInfo a] -> ShowS
Eq (FieldInfo a) Source #
Instance details Defined in Generics.SOP.Metadata Methods (==) :: FieldInfo a -> FieldInfo a -> Bool (/=) :: FieldInfo a -> FieldInfo a -> Bool
Ord (FieldInfo a) Source #
Instance details Defined in Generics.SOP.Metadata Methods compare :: FieldInfo a -> FieldInfo a -> Ordering (<) :: FieldInfo a -> FieldInfo a -> Bool (<=) :: FieldInfo a -> FieldInfo a -> Bool (>) :: FieldInfo a -> FieldInfo a -> Bool (>=) :: FieldInfo a -> FieldInfo a -> Bool max :: FieldInfo a -> FieldInfo a -> FieldInfo a min :: FieldInfo a -> FieldInfo a -> FieldInfo a

type FieldName = String Source #

The name of a field / record selector.

type Fixity = Int Source #

The fixity of an infix constructor.

type ModuleName = String Source #

The name of a module.

data StrictnessInfo a where Source #

Metadata for strictness information of a field.

Indexed by the type of the field.

Since: 0.4.0.0

Constructors

StrictnessInfo :: forall a. SourceUnpackedness -> SourceStrictness -> DecidedStrictness -> StrictnessInfo a

Instances

Instances details

Functor StrictnessInfo Source #
Instance details Defined in Generics.SOP.Metadata Methods fmap :: (a -> b) -> StrictnessInfo a -> StrictnessInfo b (<$) :: a -> StrictnessInfo b -> StrictnessInfo a
Show (StrictnessInfo a) Source #
Instance details Defined in Generics.SOP.Metadata Methods showsPrec :: Int -> StrictnessInfo a -> ShowS show :: StrictnessInfo a -> String showList :: [StrictnessInfo a] -> ShowS
Eq (StrictnessInfo a) Source #
Instance details Defined in Generics.SOP.Metadata Methods (==) :: StrictnessInfo a -> StrictnessInfo a -> Bool (/=) :: StrictnessInfo a -> StrictnessInfo a -> Bool
Ord (StrictnessInfo a) Source #
Instance details Defined in Generics.SOP.Metadata Methods compare :: StrictnessInfo a -> StrictnessInfo a -> Ordering (<) :: StrictnessInfo a -> StrictnessInfo a -> Bool (<=) :: StrictnessInfo a -> StrictnessInfo a -> Bool (>) :: StrictnessInfo a -> StrictnessInfo a -> Bool (>=) :: StrictnessInfo a -> StrictnessInfo a -> Bool max :: StrictnessInfo a -> StrictnessInfo a -> StrictnessInfo a min :: StrictnessInfo a -> StrictnessInfo a -> StrictnessInfo a

re-exports

data Associativity #

Constructors

LeftAssociative
RightAssociative
NotAssociative

Instances

Instances details

Generic Associativity Source #

Instance details

Defined in Generics.SOP.Instances

Associated Types

type Code Associativity
Instance details Defined in Generics.SOP.Instances type Code Associativity = '['[] :: [Type], '[] :: [Type], '[] :: [Type]]

Methods

from :: Associativity -> Rep Associativity Source #

to :: Rep Associativity -> Associativity Source #

HasDatatypeInfo Associativity Source #

Instance details

Defined in Generics.SOP.Instances

Associated Types

type DatatypeInfoOf Associativity
Instance details Defined in Generics.SOP.Instances type DatatypeInfoOf Associativity = 'ADT "GHC.Internal.Generics" "Associativity" '['Constructor "LeftAssociative", 'Constructor "RightAssociative", 'Constructor "NotAssociative"] '['[] :: [StrictnessInfo], '[] :: [StrictnessInfo], '[] :: [StrictnessInfo]]

Methods

datatypeInfo :: proxy Associativity -> DatatypeInfo (Code Associativity) Source #

Data Associativity #

Instance details

Defined in GHC.Internal.Data.Data

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Associativity -> c Associativity

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Associativity

toConstr :: Associativity -> Constr

dataTypeOf :: Associativity -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Associativity)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Associativity)

gmapT :: (forall b. Data b => b -> b) -> Associativity -> Associativity

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Associativity -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Associativity -> r

gmapQ :: (forall d. Data d => d -> u) -> Associativity -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Associativity -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Associativity -> m Associativity

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Associativity -> m Associativity

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Associativity -> m Associativity

Bounded Associativity #

Instance details