Data.Bitfield.Internal

Documentation

newtype Bitfield (rep :: Type) (a :: Type)

A generic Bitfield

Represents type a with type rep.

Technically this allows any representation and any type to represent, however all methods are written with the implicit assumption of a representation with an Integral and Bits instance. The type to represent is also assumed to have a Generic instance and be a single constructor with named fields.

a's fields are also required to have an instance of AsRep and FiniteBits. This is provided for the most common types (Int/Word (and variants) and Bool).

Constructors

Bitfield rep

Instances

(HasField name a x, GOffset name (Rep a), AsRep rep x) => HasField (name :: Symbol) (Bitfield rep a) x

Defined in Data.Bitfield.Internal

Methods

getField :: Bitfield rep a -> x

AsRep r1 r2 => AsRep r1 (Bitfield r2 a)

Defined in Data.Bitfield.Internal

Methods

fromRep :: r1 -> Int -> Bitfield r2 a

toRep :: r1 -> Bitfield r2 a -> Int -> r1

Storable rep => Storable (Bitfield rep a)

Defined in Data.Bitfield.Internal

Methods

sizeOf :: Bitfield rep a -> Int

alignment :: Bitfield rep a -> Int

peekElemOff :: Ptr (Bitfield rep a) -> Int -> IO (Bitfield rep a)

pokeElemOff :: Ptr (Bitfield rep a) -> Int -> Bitfield rep a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Bitfield rep a)

pokeByteOff :: Ptr b -> Int -> Bitfield rep a -> IO ()

peek :: Ptr (Bitfield rep a) -> IO (Bitfield rep a)

poke :: Ptr (Bitfield rep a) -> Bitfield rep a -> IO ()

(Fits rep a, Generic a, GPackBitfield rep (Rep a), Show a) => Show (Bitfield rep a)

Defined in Data.Bitfield.Internal

Methods

showsPrec :: Int -> Bitfield rep a -> ShowS

show :: Bitfield rep a -> String

showList :: [Bitfield rep a] -> ShowS

KnownNat (BitSize r2) => HasFixedBitSize (Bitfield r2 a)

Defined in Data.Bitfield.Internal

Associated Types

type BitSize (Bitfield r2 a) :: Nat

Eq rep => Eq (Bitfield rep a)

Defined in Data.Bitfield.Internal

Methods

(==) :: Bitfield rep a -> Bitfield rep a -> Bool

(/=) :: Bitfield rep a -> Bitfield rep a -> Bool

Ord rep => Ord (Bitfield rep a)

Defined in Data.Bitfield.Internal

Methods

compare :: Bitfield rep a -> Bitfield rep a -> Ordering

(<) :: Bitfield rep a -> Bitfield rep a -> Bool

(<=) :: Bitfield rep a -> Bitfield rep a -> Bool

(>) :: Bitfield rep a -> Bitfield rep a -> Bool

(>=) :: Bitfield rep a -> Bitfield rep a -> Bool

max :: Bitfield rep a -> Bitfield rep a -> Bitfield rep a

min :: Bitfield rep a -> Bitfield rep a -> Bitfield rep a

type BitSize (Bitfield r2 a)

Defined in Data.Bitfield.Internal

type BitSize (Bitfield r2 a) = BitSize r2

unwrap :: Bitfield rep a -> rep

Access the underlying representation of the Bitfield

get :: forall name x rep a. (Fits rep a, HasField name (Bitfield rep a) x) => Bitfield rep a -> x

Access a single field

set :: forall name x rep a. (Fits rep a, HasField name (Bitfield rep a) x, GOffset name (Rep a), Bits rep, AsRep rep x) => Bitfield rep a -> x -> Bitfield rep a

Change a single field

pack :: forall rep a. (Fits rep a, Generic a, Bits rep, GPackBitfield rep (Rep a)) => a -> Bitfield rep a

Pack a datatype into a bitfield

Beware that updates should be done with set, as pack will recreate the entire Bitfield from scratch. The following will most likely *not* be optimised: pack $ (unpack bitfield) { example = True }

unpack :: forall rep a. (Fits rep a, Generic a, GPackBitfield rep (Rep a)) => Bitfield rep a -> a

Unpack the Bitfield and return the full datatype

class KnownNat (BitSize a) => HasFixedBitSize (a :: Type)

Types with a fixed bitsize. This could be a type family as well, but having it as a typeclass provides nicer error messages when one forgets to write an instance for it.

Associated Types

type BitSize a :: Nat

Instances

HasFixedBitSize Int16

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Int16 :: Nat

HasFixedBitSize Int32

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Int32 :: Nat

HasFixedBitSize Int64

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Int64 :: Nat

HasFixedBitSize Int8

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Int8 :: Nat

HasFixedBitSize Word16

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Word16 :: Nat

HasFixedBitSize Word32

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Word32 :: Nat

HasFixedBitSize Word64

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Word64 :: Nat

HasFixedBitSize Word8

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Word8 :: Nat

HasFixedBitSize Bool

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Bool :: Nat

HasFixedBitSize Int

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Int :: Nat

HasFixedBitSize Word

Defined in Data.Bitfield.Internal

Associated Types

type BitSize Word :: Nat

KnownNat (RoundUpLog2 (EnumSz (Rep a))) => HasFixedBitSize (GenericEnum a)

Defined in Data.Bitfield.Internal

Associated Types

type BitSize (GenericEnum a) :: Nat

KnownNat (BitSize r2) => HasFixedBitSize (Bitfield r2 a)

Defined in Data.Bitfield.Internal

Associated Types

type BitSize (Bitfield r2 a) :: Nat

KnownNat sz => HasFixedBitSize (ViaIntegral sz n)

Defined in Data.Bitfield.Internal

Associated Types

type BitSize (ViaIntegral sz n) :: Nat

class HasFixedBitSize a => AsRep rep a where

Typeclass which converts rep and a into each other (at specified offsets).

Methods

fromRep :: rep -> Int -> a

toRep :: rep -> a -> Int -> rep

Instances

Bits a => AsRep a Bool

Defined in Data.Bitfield.Internal

Methods

fromRep :: a -> Int -> Bool

toRep :: a -> Bool -> Int -> a

(Bits r, Integral r) => AsRep r Int16

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Int16

toRep :: r -> Int16 -> Int -> r

(Bits r, Integral r) => AsRep r Int32

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Int32

toRep :: r -> Int32 -> Int -> r

(Bits r, Integral r) => AsRep r Int64

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Int64

toRep :: r -> Int64 -> Int -> r

(Bits r, Integral r) => AsRep r Int8

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Int8

toRep :: r -> Int8 -> Int -> r

(Bits r, Integral r) => AsRep r Word16

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Word16

toRep :: r -> Word16 -> Int -> r

(Bits r, Integral r) => AsRep r Word32

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Word32

toRep :: r -> Word32 -> Int -> r

(Bits r, Integral r) => AsRep r Word64

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Word64

toRep :: r -> Word64 -> Int -> r

(Bits r, Integral r) => AsRep r Word8

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Word8

toRep :: r -> Word8 -> Int -> r

(Bits r, Integral r) => AsRep r Int

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Int

toRep :: r -> Int -> Int -> r

(Bits r, Integral r) => AsRep r Word

Defined in Data.Bitfield.Internal

Methods

fromRep :: r -> Int -> Word

toRep :: r -> Word -> Int -> r

(Generic a, Enum a, Bits rep, Integral rep, KnownNat (RoundUpLog2 (EnumSz (Rep a)))) => AsRep rep (GenericEnum a)

Defined in Data.Bitfield.Internal

Methods

fromRep :: rep -> Int -> GenericEnum a

toRep :: rep -> GenericEnum a -> Int -> rep

(Bits a, Integral a, Integral n, KnownNat sz) => AsRep a (ViaIntegral sz n)

Defined in Data.Bitfield.Internal

Methods

fromRep :: a -> Int -> ViaIntegral sz n

toRep :: a -> ViaIntegral sz n -> Int -> a

AsRep r1 r2 => AsRep r1 (Bitfield r2 a)

Defined in Data.Bitfield.Internal

Methods

fromRep :: r1 -> Int -> Bitfield r2 a

toRep :: r1 -> Bitfield r2 a -> Int -> r1

newtype ViaIntegral (sz :: Nat) a

Newtype wrapper with an AsRep instance for Integral representations and types.

The example below shows how to derive a 5 bit int field via a newtype:

newtype SmallInt = SmallInt Int
  deriving (HasFixedBitSize, AsRep r) via (ViaIntegral 5 Int)

Constructors

ViaIntegral a

Instances

(Bits a, Integral a, Integral n, KnownNat sz) => AsRep a (ViaIntegral sz n)

Defined in Data.Bitfield.Internal

Methods

fromRep :: a -> Int -> ViaIntegral sz n

toRep :: a -> ViaIntegral sz n -> Int -> a

Bits a => Bits (ViaIntegral sz a)

Defined in Data.Bitfield.Internal

Methods

(.&.) :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

(.|.) :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

xor :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

complement :: ViaIntegral sz a -> ViaIntegral sz a

shift :: ViaIntegral sz a -> Int -> ViaIntegral sz a

rotate :: ViaIntegral sz a -> Int -> ViaIntegral sz a

zeroBits :: ViaIntegral sz a

bit :: Int -> ViaIntegral sz a

setBit :: ViaIntegral sz a -> Int -> ViaIntegral sz a

clearBit :: ViaIntegral sz a -> Int -> ViaIntegral sz a

complementBit :: ViaIntegral sz a -> Int -> ViaIntegral sz a

testBit :: ViaIntegral sz a -> Int -> Bool

bitSizeMaybe :: ViaIntegral sz a -> Maybe Int

bitSize :: ViaIntegral sz a -> Int

isSigned :: ViaIntegral sz a -> Bool

shiftL :: ViaIntegral sz a -> Int -> ViaIntegral sz a

unsafeShiftL :: ViaIntegral sz a -> Int -> ViaIntegral sz a

shiftR :: ViaIntegral sz a -> Int -> ViaIntegral sz a

unsafeShiftR :: ViaIntegral sz a -> Int -> ViaIntegral sz a

rotateL :: ViaIntegral sz a -> Int -> ViaIntegral sz a

rotateR :: ViaIntegral sz a -> Int -> ViaIntegral sz a

popCount :: ViaIntegral sz a -> Int

Enum a => Enum (ViaIntegral sz a)

Defined in Data.Bitfield.Internal

Methods

succ :: ViaIntegral sz a -> ViaIntegral sz a

pred :: ViaIntegral sz a -> ViaIntegral sz a

toEnum :: Int -> ViaIntegral sz a

fromEnum :: ViaIntegral sz a -> Int

enumFrom :: ViaIntegral sz a -> [ViaIntegral sz a]

enumFromThen :: ViaIntegral sz a -> ViaIntegral sz a -> [ViaIntegral sz a]

enumFromTo :: ViaIntegral sz a -> ViaIntegral sz a -> [ViaIntegral sz a]

enumFromThenTo :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a -> [ViaIntegral sz a]

Num a => Num (ViaIntegral sz a)

Defined in Data.Bitfield.Internal

Methods

(+) :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

(-) :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

(*) :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

negate :: ViaIntegral sz a -> ViaIntegral sz a

abs :: ViaIntegral sz a -> ViaIntegral sz a

signum :: ViaIntegral sz a -> ViaIntegral sz a

fromInteger :: Integer -> ViaIntegral sz a

Integral a => Integral (ViaIntegral sz a)

Defined in Data.Bitfield.Internal

Methods

quot :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

rem :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

div :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

mod :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

quotRem :: ViaIntegral sz a -> ViaIntegral sz a -> (ViaIntegral sz a, ViaIntegral sz a)

divMod :: ViaIntegral sz a -> ViaIntegral sz a -> (ViaIntegral sz a, ViaIntegral sz a)

toInteger :: ViaIntegral sz a -> Integer

Real a => Real (ViaIntegral sz a)

Defined in Data.Bitfield.Internal

Methods

toRational :: ViaIntegral sz a -> Rational

KnownNat sz => HasFixedBitSize (ViaIntegral sz n)

Defined in Data.Bitfield.Internal

Associated Types

type BitSize (ViaIntegral sz n) :: Nat

Eq a => Eq (ViaIntegral sz a)

Defined in Data.Bitfield.Internal

Methods

(==) :: ViaIntegral sz a -> ViaIntegral sz a -> Bool

(/=) :: ViaIntegral sz a -> ViaIntegral sz a -> Bool

Ord a => Ord (ViaIntegral sz a)

Defined in Data.Bitfield.Internal

Methods

compare :: ViaIntegral sz a -> ViaIntegral sz a -> Ordering

(<) :: ViaIntegral sz a -> ViaIntegral sz a -> Bool

(<=) :: ViaIntegral sz a -> ViaIntegral sz a -> Bool

(>) :: ViaIntegral sz a -> ViaIntegral sz a -> Bool

(>=) :: ViaIntegral sz a -> ViaIntegral sz a -> Bool

max :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

min :: ViaIntegral sz a -> ViaIntegral sz a -> ViaIntegral sz a

type BitSize (ViaIntegral sz n)

Defined in Data.Bitfield.Internal

type BitSize (ViaIntegral sz n) = sz

newtype GenericEnum a

Deriving via helper for Enum types. Requires that type to also have an instance of Generic.

data AEnum = A1 | A2 | A3
  deriving stock (Enum, Generic)
  deriving (HasFixedBitSize, AsRep r) via (GenericEnum AEnum)

Constructors

GenericEnum a

Instances

(Generic a, Enum a, Bits rep, Integral rep, KnownNat (RoundUpLog2 (EnumSz (Rep a)))) => AsRep rep (GenericEnum a)

Defined in Data.Bitfield.Internal

Methods

fromRep :: rep -> Int -> GenericEnum a

toRep :: rep -> GenericEnum a -> Int -> rep

KnownNat (RoundUpLog2 (EnumSz (Rep a))) => HasFixedBitSize (GenericEnum a)

Defined in Data.Bitfield.Internal

Associated Types

type BitSize (GenericEnum a) :: Nat

Eq a => Eq (GenericEnum a)

Defined in Data.Bitfield.Internal

Methods

(==) :: GenericEnum a -> GenericEnum a -> Bool

(/=) :: GenericEnum a -> GenericEnum a -> Bool

type BitSize (GenericEnum a)

Defined in Data.Bitfield.Internal

type BitSize (GenericEnum a)

type Fits rep a = FitsPred (ReqSz (Rep a) <=? BitSize rep) rep a

Constraint which checks if a datatype fits.