Safe Haskell	Safe
Language	Haskell2010

Generic.Data.Internal.Meta

Contents

Constructor information on generic representations
Find a constructor tag by name
Type families

Description

Type metadata accessors

Type names, constructor names...

Warning

This is an internal module: it is not subject to any versioning policy, breaking changes can happen at any time.

If something here seems useful, please report it or create a pull request to export it from an external module.

Synopsis

gdatatypeName :: forall a. (Generic a, GDatatype (Rep a)) => String
gmoduleName :: forall a. (Generic a, GDatatype (Rep a)) => String
gpackageName :: forall a. (Generic a, GDatatype (Rep a)) => String
gisNewtype :: forall a. (Generic a, GDatatype (Rep a)) => Bool
fromDatatype :: forall d r. Datatype d => (M1 D d Proxy () -> r) -> r
class GDatatype f where
- gDatatypeName :: String
- gModuleName :: String
- gPackageName :: String
- gIsNewtype :: Bool
gconName :: forall a. Constructors a => a -> String
gconFixity :: forall a. Constructors a => a -> Fixity
gconIsRecord :: forall a. Constructors a => a -> Bool
gconNum :: forall a. Constructors a => Int
gconIndex :: forall a. Constructors a => a -> Int
newtype ConId a = ConId Int
conId :: forall a. Constructors a => a -> ConId a
conIdToInt :: forall a. ConId a -> Int
conIdToString :: forall a. Constructors a => ConId a -> String
conIdEnum :: forall a. Constructors a => [ConId a]
conIdMin :: forall a. Constructors a => ConId a
conIdMax :: forall a. Constructors a => ConId a
conIdNamed :: forall s a. ConIdNamed s a => ConId a
class (Generic a, GConstructors (Rep a)) => Constructors a
class (Generic a, KnownNat (ConIdNamed' n a)) => ConIdNamed n a
newtype GConId r = GConId Int
gConIdToInt :: GConId r -> Int
toConId :: forall a. Generic a => GConId (Rep a) -> ConId a
fromConId :: forall a. Generic a => ConId a -> GConId (Rep a)
reGConId :: GConId r -> GConId s
gConIdMin :: forall r. GConstructors r => GConId r
gConIdMax :: forall r. GConstructors r => GConId r
class GConstructors r where
- gConIdToString :: GConId r -> String
- gConId :: r p -> GConId r
- gConNum :: Int
- gConFixity :: r p -> Fixity
- gConIsRecord :: r p -> Bool
type ConIdNamed' n t = GConIdNamedIf n t (GConIdNamed n (Rep t))
type GConIdNamed n f = GConIdNamed' n f 0 Nothing
type family GConIdNamed' (n :: Symbol) (f :: k -> *) (i :: Nat) (o :: Maybe Nat) :: Maybe Nat where ...
type family GConIdNamedIf (n :: Symbol) (t :: *) (o :: Maybe Nat) :: Nat where ...
type family MetaOf (f :: * -> *) :: Meta where ...
type family MetaDataName (m :: Meta) :: Symbol where ...
type family MetaDataModule (m :: Meta) :: Symbol where ...
type family MetaDataPackage (m :: Meta) :: Symbol where ...
type family MetaDataNewtype (m :: Meta) :: Bool where ...
type family MetaConsName (m :: Meta) :: Symbol where ...
type family MetaConsFixity (m :: Meta) :: FixityI where ...
type family MetaConsRecord (m :: Meta) :: Bool where ...
type family MetaSelNameM (m :: Meta) :: Maybe Symbol where ...
type family MetaSelName (m :: Meta) :: Symbol where ...
type family MetaSelUnpack (m :: Meta) :: SourceUnpackedness where ...
type family MetaSelSourceStrictness (m :: Meta) :: SourceStrictness where ...
type family MetaSelStrictness (m :: Meta) :: DecidedStrictness where ...
type DummyMeta = MetaData "" "" "" False
type family UnM1 (f :: k -> *) :: k -> *

Documentation

>>> :set -XDataKinds -XTypeApplications
>>> import Control.Applicative (ZipList)
>>> import Data.Monoid (Sum(..))

gdatatypeName :: forall a. (Generic a, GDatatype (Rep a)) => String Source #

Name of the first data constructor in a type as a string.

>>> gdatatypeName @(Maybe Int)
"Maybe"

gmoduleName :: forall a. (Generic a, GDatatype (Rep a)) => String Source #

Name of the module where the first type constructor is defined.

>>> gmoduleName @(ZipList Int)
"Control.Applicative"

gpackageName :: forall a. (Generic a, GDatatype (Rep a)) => String Source #

Name of the package where the first type constructor is defined.

>>> gpackageName @(Maybe Int)
"base"

gisNewtype :: forall a. (Generic a, GDatatype (Rep a)) => Bool Source #

True if the first type constructor is a newtype.

>>> gisNewtype @[Int]
False
>>> gisNewtype @(ZipList Int)
True

fromDatatype :: forall d r. Datatype d => (M1 D d Proxy () -> r) -> r Source #

class GDatatype f where Source #

Generic representations that contain datatype metadata.

Methods

gDatatypeName :: String Source #

gModuleName :: String Source #

gPackageName :: String Source #

gIsNewtype :: Bool Source #

Instances

Datatype d => GDatatype (M1 D d f :: k -> Type) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods gDatatypeName :: String Source # gModuleName :: String Source # gPackageName :: String Source # gIsNewtype :: Bool Source #

gconName :: forall a. Constructors a => a -> String Source #

Name of the first constructor in a value.

>>> gconName (Just 0)
"Just"

gconFixity :: forall a. Constructors a => a -> Fixity Source #

The fixity of the first constructor.

>>> gconFixity (Just 0)
Prefix
>>> gconFixity ([] :*: id)
Infix RightAssociative 6

gconIsRecord :: forall a. Constructors a => a -> Bool Source #

True if the constructor is a record.

>>> gconIsRecord (Just 0)
False
>>> gconIsRecord (Sum 0)   -- Note:  newtype Sum a = Sum { getSum :: a }
True

gconNum :: forall a. Constructors a => Int Source #

Number of constructors.

>>> gconNum @(Maybe Int)
2

gconIndex :: forall a. Constructors a => a -> Int Source #

Index of a constructor.

>>> gconIndex Nothing
0
>>> gconIndex (Just "test")
1

newtype ConId a Source #

An opaque identifier for a constructor.

Constructors

ConId Int

Instances

Eq (ConId a) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods (==) :: ConId a -> ConId a -> Bool # (/=) :: ConId a -> ConId a -> Bool #
Ord (ConId a) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods compare :: ConId a -> ConId a -> Ordering # (<) :: ConId a -> ConId a -> Bool # (<=) :: ConId a -> ConId a -> Bool # (>) :: ConId a -> ConId a -> Bool # (>=) :: ConId a -> ConId a -> Bool # max :: ConId a -> ConId a -> ConId a # min :: ConId a -> ConId a -> ConId a #
Show (ConId a) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods showsPrec :: Int -> ConId a -> ShowS # show :: ConId a -> String # showList :: [ConId a] -> ShowS #

conId :: forall a. Constructors a => a -> ConId a Source #

Identifier of a constructor.

conIdToInt :: forall a. ConId a -> Int Source #

Index of a constructor, given its identifier. See also gconIndex.

conIdToString :: forall a. Constructors a => ConId a -> String Source #

Name of a constructor. See also gconName.

conIdEnum :: forall a. Constructors a => [ConId a] Source #

All constructor identifiers. This must not be called on an empty type.

gconNum @a = length (conIdEnum @a)

conIdMin :: forall a. Constructors a => ConId a Source #

This must not be called on an empty type.

conIdMax :: forall a. Constructors a => ConId a Source #

This must not be called on an empty type.

conIdNamed :: forall s a. ConIdNamed s a => ConId a Source #

Get a ConId by name.

>>> conIdNamed @"Nothing" :: ConId (Maybe Int)
ConId 0
>>> conIdNamed @"Just"    :: ConId (Maybe Int)
ConId 1

class (Generic a, GConstructors (Rep a)) => Constructors a Source #

Constraint synonym for Generic and GConstructors.

Instances

(Generic a, GConstructors (Rep a)) => Constructors a Source #
Instance details Defined in Generic.Data.Internal.Meta

class (Generic a, KnownNat (ConIdNamed' n a)) => ConIdNamed n a Source #

Constraint synonym for generic types a with a constructor named n.

Instances

(Generic a, KnownNat (ConIdNamed' n a)) => ConIdNamed n a Source #
Instance details Defined in Generic.Data.Internal.Meta

Constructor information on generic representations

newtype GConId r Source #

Constructors

GConId Int

Instances

Eq (GConId r) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods (==) :: GConId r -> GConId r -> Bool # (/=) :: GConId r -> GConId r -> Bool #
Ord (GConId r) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods compare :: GConId r -> GConId r -> Ordering # (<) :: GConId r -> GConId r -> Bool # (<=) :: GConId r -> GConId r -> Bool # (>) :: GConId r -> GConId r -> Bool # (>=) :: GConId r -> GConId r -> Bool # max :: GConId r -> GConId r -> GConId r # min :: GConId r -> GConId r -> GConId r #

gConIdToInt :: GConId r -> Int Source #

toConId :: forall a. Generic a => GConId (Rep a) -> ConId a Source #

fromConId :: forall a. Generic a => ConId a -> GConId (Rep a) Source #

reGConId :: GConId r -> GConId s Source #

gConIdMin :: forall r. GConstructors r => GConId r Source #

gConIdMax :: forall r. GConstructors r => GConId r Source #

class GConstructors r where Source #

Generic representations that contain constructor metadata.

Methods

gConIdToString :: GConId r -> String Source #

gConId :: r p -> GConId r Source #

gConNum :: Int Source #

gConFixity :: r p -> Fixity Source #

gConIsRecord :: r p -> Bool Source #

Instances

(GConstructors f, GConstructors g) => GConstructors (f :+: g :: k -> Type) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods gConIdToString :: GConId (f :+: g) -> String Source # gConId :: (f :+: g) p -> GConId (f :+: g) Source # gConNum :: Int Source # gConFixity :: (f :+: g) p -> Fixity Source # gConIsRecord :: (f :+: g) p -> Bool Source #
Constructor c => GConstructors (M1 C c f :: k -> Type) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods gConIdToString :: GConId (M1 C c f) -> String Source # gConId :: M1 C c f p -> GConId (M1 C c f) Source # gConNum :: Int Source # gConFixity :: M1 C c f p -> Fixity Source # gConIsRecord :: M1 C c f p -> Bool Source #
GConstructors f => GConstructors (M1 D c f :: k -> Type) Source #
Instance details Defined in Generic.Data.Internal.Meta Methods gConIdToString :: GConId (M1 D c f) -> String Source # gConId :: M1 D c f p -> GConId (M1 D c f) Source # gConNum :: Int Source # gConFixity :: M1 D c f p -> Fixity Source # gConIsRecord :: M1 D c f p -> Bool Source #

Find a constructor tag by name

type ConIdNamed' n t = GConIdNamedIf n t (GConIdNamed n (Rep t)) Source #

type GConIdNamed n f = GConIdNamed' n f 0 Nothing Source #

type family GConIdNamed' (n :: Symbol) (f :: k -> *) (i :: Nat) (o :: Maybe Nat) :: Maybe Nat where ... Source #

Equations

GConIdNamed' n (M1 D _c f) i r = GConIdNamed' n f i r
GConIdNamed' n (f :+: g) i r = GConIdNamed' n f i (GConIdNamed' n g (i + NConstructors f) r)
GConIdNamed' n (M1 C (MetaCons n _f _s) _g) i _r = Just i
GConIdNamed' n (M1 C (MetaCons _n _f _s) _g) _i r = r
GConIdNamed' _n V1 _i r = r

type family GConIdNamedIf (n :: Symbol) (t :: *) (o :: Maybe Nat) :: Nat where ... Source #

Equations

GConIdNamedIf _n _t (Just i) = i
GConIdNamedIf n t Nothing = TypeError (((Text "No constructor named " :<>: ShowType n) :<>: Text " in generic type ") :<>: ShowType t)