Copyright	(C) 2018 Google Inc. 2022 LUMI GUIDE FIETSDETECTIE B.V.
License	BSD2 (see the file LICENSE)
Maintainer	Christiaan Baaij <christiaan.baaij@gmail.com>
Safe Haskell	None
Language	Haskell2010

Clash.Annotations.BitRepresentation.Internal

Description

Synopsis

buildCustomReprs :: [DataRepr'] -> CustomReprs
dataReprAnnToDataRepr' :: DataReprAnn -> DataRepr'
constrReprToConstrRepr' :: Int -> ConstrRepr -> ConstrRepr'
getConstrRepr :: Text -> CustomReprs -> Maybe ConstrRepr'
uncheckedGetConstrRepr :: HasCallStack => Text -> CustomReprs -> ConstrRepr'
getDataRepr :: Type' -> CustomReprs -> Maybe DataRepr'
thTypeToType' :: Type -> Type'
data ConstrRepr' = ConstrRepr' {
- crName :: Text
- crPosition :: Int
- crMask :: BitMask
- crValue :: Value
- crFieldAnns :: [FieldAnn]
}
data DataRepr' = DataRepr' {
- drType :: Type'
- drSize :: Size
- drConstrs :: [ConstrRepr']
}
data Type'
- = AppTy' Type' Type'
- | ConstTy' Text
- | LitTy' Integer
- | SymLitTy' Text
type CustomReprs = (Map Type' DataRepr', Map Text ConstrRepr')

Documentation

buildCustomReprs :: [DataRepr'] -> CustomReprs Source #

Create indices based on names of constructors and data types

dataReprAnnToDataRepr' :: DataReprAnn -> DataRepr' Source #

constrReprToConstrRepr' :: Int -> ConstrRepr -> ConstrRepr' Source #

getConstrRepr :: Text -> CustomReprs -> Maybe ConstrRepr' Source #

Lookup constructor representation based on name

uncheckedGetConstrRepr :: HasCallStack => Text -> CustomReprs -> ConstrRepr' Source #

Unchecked version of getConstrRepr

getDataRepr :: Type' -> CustomReprs -> Maybe DataRepr' Source #

Lookup data type representation based on name

thTypeToType' :: Type -> Type' Source #

Convert template haskell type to simple representation of type

data ConstrRepr' Source #

Internal version of ConstrRepr

Constructors

ConstrRepr'
Fields crName :: Text Qualified name of constructor crPosition :: Int Syntactical position in the custom representations definition crMask :: BitMask Mask needed to determine constructor crValue :: Value Value after applying mask crFieldAnns :: [FieldAnn] Indicates where fields are stored

Instances

Instances details

Eq ConstrRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods (==) :: ConstrRepr' -> ConstrRepr' -> Bool # (/=) :: ConstrRepr' -> ConstrRepr' -> Bool #
Ord ConstrRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods compare :: ConstrRepr' -> ConstrRepr' -> Ordering # (<) :: ConstrRepr' -> ConstrRepr' -> Bool # (<=) :: ConstrRepr' -> ConstrRepr' -> Bool # (>) :: ConstrRepr' -> ConstrRepr' -> Bool # (>=) :: ConstrRepr' -> ConstrRepr' -> Bool # max :: ConstrRepr' -> ConstrRepr' -> ConstrRepr' # min :: ConstrRepr' -> ConstrRepr' -> ConstrRepr' #
Show ConstrRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods showsPrec :: Int -> ConstrRepr' -> ShowS # show :: ConstrRepr' -> String # showList :: [ConstrRepr'] -> ShowS #
Generic ConstrRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Associated Types type Rep ConstrRepr' :: Type -> Type # Methods from :: ConstrRepr' -> Rep ConstrRepr' x # to :: Rep ConstrRepr' x -> ConstrRepr' #
NFData ConstrRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods rnf :: ConstrRepr' -> () #
Hashable ConstrRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods hashWithSalt :: Int -> ConstrRepr' -> Int # hash :: ConstrRepr' -> Int #
type Rep ConstrRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal type Rep ConstrRepr' = D1 ('MetaData "ConstrRepr'" "Clash.Annotations.BitRepresentation.Internal" "clash-prelude-1.6.5-inplace" 'False) (C1 ('MetaCons "ConstrRepr'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "crPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :: (S1 ('MetaSel ('Just "crMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BitMask) :: (S1 ('MetaSel ('Just "crValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value) :: S1 ('MetaSel ('Just "crFieldAnns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FieldAnn])))))

data DataRepr' Source #

Internal version of DataRepr

Constructors

DataRepr'
Fields drType :: Type' Simple representation of data type drSize :: Size Size of data type drConstrs :: [ConstrRepr'] Constructors

Instances

Instances details

Eq DataRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods (==) :: DataRepr' -> DataRepr' -> Bool # (/=) :: DataRepr' -> DataRepr' -> Bool #
Ord DataRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods compare :: DataRepr' -> DataRepr' -> Ordering # (<) :: DataRepr' -> DataRepr' -> Bool # (<=) :: DataRepr' -> DataRepr' -> Bool # (>) :: DataRepr' -> DataRepr' -> Bool # (>=) :: DataRepr' -> DataRepr' -> Bool # max :: DataRepr' -> DataRepr' -> DataRepr' # min :: DataRepr' -> DataRepr' -> DataRepr' #
Show DataRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods showsPrec :: Int -> DataRepr' -> ShowS # show :: DataRepr' -> String # showList :: [DataRepr'] -> ShowS #
Generic DataRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Associated Types type Rep DataRepr' :: Type -> Type # Methods from :: DataRepr' -> Rep DataRepr' x # to :: Rep DataRepr' x -> DataRepr' #
NFData DataRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods rnf :: DataRepr' -> () #
Hashable DataRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods hashWithSalt :: Int -> DataRepr' -> Int # hash :: DataRepr' -> Int #
type Rep DataRepr' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal type Rep DataRepr' = D1 ('MetaData "DataRepr'" "Clash.Annotations.BitRepresentation.Internal" "clash-prelude-1.6.5-inplace" 'False) (C1 ('MetaCons "DataRepr'" 'PrefixI 'True) (S1 ('MetaSel ('Just "drType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type') :: (S1 ('MetaSel ('Just "drSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Size) :: S1 ('MetaSel ('Just "drConstrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ConstrRepr']))))

data Type' Source #

Simple version of template haskell type. Used internally to match on.

Constructors

AppTy' Type' Type'	Type application
ConstTy' Text	Qualified name of type
LitTy' Integer	Numeral literal (used in BitVector 10, for example)
SymLitTy' Text	Symbol literal (used in for example (Signal System Int))

Instances

Instances details

Eq Type' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods (==) :: Type' -> Type' -> Bool # (/=) :: Type' -> Type' -> Bool #
Ord Type' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods compare :: Type' -> Type' -> Ordering # (<) :: Type' -> Type' -> Bool # (<=) :: Type' -> Type' -> Bool # (>) :: Type' -> Type' -> Bool # (>=) :: Type' -> Type' -> Bool # max :: Type' -> Type' -> Type' # min :: Type' -> Type' -> Type' #
Show Type' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods showsPrec :: Int -> Type' -> ShowS # show :: Type' -> String # showList :: [Type'] -> ShowS #
Generic Type' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Associated Types type Rep Type' :: Type -> Type # Methods from :: Type' -> Rep Type' x # to :: Rep Type' x -> Type' #
NFData Type' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods rnf :: Type' -> () #
Hashable Type' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal Methods hashWithSalt :: Int -> Type' -> Int # hash :: Type' -> Int #
type Rep Type' Source #
Instance details Defined in Clash.Annotations.BitRepresentation.Internal type Rep Type' = D1 ('MetaData "Type'" "Clash.Annotations.BitRepresentation.Internal" "clash-prelude-1.6.5-inplace" 'False) ((C1 ('MetaCons "AppTy'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type') :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')) :+: C1 ('MetaCons "ConstTy'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :+: (C1 ('MetaCons "LitTy'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :+: C1 ('MetaCons "SymLitTy'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

type CustomReprs = (Map Type' DataRepr', Map Text ConstrRepr') Source #

Convenience type for index built by buildCustomReprs