Clash.Annotations.BitRepresentation.Internal

Documentation

buildCustomReprs :: [DataRepr'] -> CustomReprs

Create indices based on names of constructors and data types

dataReprAnnToDataRepr' :: DataReprAnn -> DataRepr'

constrReprToConstrRepr' :: Int -> ConstrRepr -> ConstrRepr'

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

Lookup constructor representation based on name

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

Unchecked version of getConstrRepr

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

Lookup data type representation based on name

thTypeToType' :: Type -> Type'

Convert template haskell type to simple representation of type

data ConstrRepr'

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

Eq ConstrRepr'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

(==) :: ConstrRepr' -> ConstrRepr' -> Bool

(/=) :: ConstrRepr' -> ConstrRepr' -> Bool

Ord ConstrRepr'

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'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

showsPrec :: Int -> ConstrRepr' -> ShowS

show :: ConstrRepr' -> String

showList :: [ConstrRepr'] -> ShowS

Generic ConstrRepr'

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'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

rnf :: ConstrRepr' -> ()

Hashable ConstrRepr'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

hashWithSalt :: Int -> ConstrRepr' -> Int

hash :: ConstrRepr' -> Int

type Rep ConstrRepr'

Defined in Clash.Annotations.BitRepresentation.Internal

type Rep ConstrRepr' = D1 ('MetaData "ConstrRepr'" "Clash.Annotations.BitRepresentation.Internal" "clash-prelude-1.8.0-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'

Internal version of DataRepr

Constructors

DataRepr'

Fields

• drType :: Type'

  Simple representation of data type

• drSize :: Size

  Size of data type

• drConstrs :: [ConstrRepr']

  Constructors

Instances

Eq DataRepr'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

(==) :: DataRepr' -> DataRepr' -> Bool

(/=) :: DataRepr' -> DataRepr' -> Bool

Ord DataRepr'

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'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

showsPrec :: Int -> DataRepr' -> ShowS

show :: DataRepr' -> String

showList :: [DataRepr'] -> ShowS

Generic DataRepr'

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'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

rnf :: DataRepr' -> ()

Hashable DataRepr'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

hashWithSalt :: Int -> DataRepr' -> Int

hash :: DataRepr' -> Int

type Rep DataRepr'

Defined in Clash.Annotations.BitRepresentation.Internal

type Rep DataRepr' = D1 ('MetaData "DataRepr'" "Clash.Annotations.BitRepresentation.Internal" "clash-prelude-1.8.0-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'

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

Eq Type'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

(==) :: Type' -> Type' -> Bool

(/=) :: Type' -> Type' -> Bool

Ord Type'

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'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

showsPrec :: Int -> Type' -> ShowS

show :: Type' -> String

showList :: [Type'] -> ShowS

Generic Type'

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'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

rnf :: Type' -> ()

Hashable Type'

Defined in Clash.Annotations.BitRepresentation.Internal

Methods

hashWithSalt :: Int -> Type' -> Int

hash :: Type' -> Int

type Rep Type'

Defined in Clash.Annotations.BitRepresentation.Internal

type Rep Type' = D1 ('MetaData "Type'" "Clash.Annotations.BitRepresentation.Internal" "clash-prelude-1.8.0-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')

Convenience type for index built by buildCustomReprs