Language.JVM.Utils

This module contains utilities missing not in other libraries.

Sized Data Structures

These data structures enables binary reading and writing of lists and byte strings that are prepended with the number of elements to read or write.

newtype SizedList w a

SizedList is a binary type, that reads a list of elements. It first reads a length N of type w and then N items of type a.

Constructors

SizedList

Fields

• unSizedList :: [a]

Instances

Functor (SizedList w)

Methods

fmap :: (a -> b) -> SizedList w a -> SizedList w b

(<$) :: a -> SizedList w b -> SizedList w a

Foldable (SizedList w)

Methods

fold :: Monoid m => SizedList w m -> m

foldMap :: Monoid m => (a -> m) -> SizedList w a -> m

foldr :: (a -> b -> b) -> b -> SizedList w a -> b

foldr' :: (a -> b -> b) -> b -> SizedList w a -> b

foldl :: (b -> a -> b) -> b -> SizedList w a -> b

foldl' :: (b -> a -> b) -> b -> SizedList w a -> b

foldr1 :: (a -> a -> a) -> SizedList w a -> a

foldl1 :: (a -> a -> a) -> SizedList w a -> a

toList :: SizedList w a -> [a]

null :: SizedList w a -> Bool

length :: SizedList w a -> Int

elem :: Eq a => a -> SizedList w a -> Bool

maximum :: Ord a => SizedList w a -> a

minimum :: Ord a => SizedList w a -> a

sum :: Num a => SizedList w a -> a

product :: Num a => SizedList w a -> a

Traversable (SizedList w)

Methods

traverse :: Applicative f => (a -> f b) -> SizedList w a -> f (SizedList w b)

sequenceA :: Applicative f => SizedList w (f a) -> f (SizedList w a)

mapM :: Monad m => (a -> m b) -> SizedList w a -> m (SizedList w b)

sequence :: Monad m => SizedList w (m a) -> m (SizedList w a)

Eq a => Eq (SizedList w a)

Methods

(==) :: SizedList w a -> SizedList w a -> Bool

(/=) :: SizedList w a -> SizedList w a -> Bool

Show a => Show (SizedList w a)

Methods

showsPrec :: Int -> SizedList w a -> ShowS

show :: SizedList w a -> String

showList :: [SizedList w a] -> ShowS

(Binary w, Integral w, Binary a) => Binary (SizedList w a)

Methods

put :: SizedList w a -> Put

get :: Get (SizedList w a)

putList :: [SizedList w a] -> Put

listSize :: Num w => SizedList w a -> w

Get the size of the sized list.

newtype SizedByteString w

A byte string with a size w.

Constructors

SizedByteString

Fields

• unSizedByteString :: ByteString

Instances

Eq (SizedByteString w)

Methods

(==) :: SizedByteString w -> SizedByteString w -> Bool

(/=) :: SizedByteString w -> SizedByteString w -> Bool

Show (SizedByteString w)

Methods

showsPrec :: Int -> SizedByteString w -> ShowS

show :: SizedByteString w -> String

showList :: [SizedByteString w] -> ShowS

(Binary w, Integral w) => Binary (SizedByteString w)

Methods

put :: SizedByteString w -> Put

get :: Get (SizedByteString w)

putList :: [SizedByteString w] -> Put

byteStringSize :: Num w => SizedByteString w -> w

Get the size of a SizedByteString

Specific sizes

type SizedList16 = SizedList Word16

A sized list using a 16 bit word as length

type SizedByteString32 = SizedByteString Word32

A sized bytestring using a 32 bit word as length

type SizedByteString16 = SizedByteString Word16

A sized bytestring using a 16 bit word as length

Bit Set

A bit set is a set where each element is represented a bit in a word. This section also defines the Enumish type class. It is different than a Enum in that the integers they represent does not have to be subsequent.

newtype BitSet w a

A bit set of size w

Constructors

BitSet

Fields

• toSet :: Set a

Instances

Eq a => Eq (BitSet w a)

Methods

(==) :: BitSet w a -> BitSet w a -> Bool

(/=) :: BitSet w a -> BitSet w a -> Bool

Ord a => Ord (BitSet w a)

Methods

compare :: BitSet w a -> BitSet w a -> Ordering

(<) :: BitSet w a -> BitSet w a -> Bool

(<=) :: BitSet w a -> BitSet w a -> Bool

(>) :: BitSet w a -> BitSet w a -> Bool

(>=) :: BitSet w a -> BitSet w a -> Bool

max :: BitSet w a -> BitSet w a -> BitSet w a

min :: BitSet w a -> BitSet w a -> BitSet w a

Show a => Show (BitSet w a)

Methods

showsPrec :: Int -> BitSet w a -> ShowS

show :: BitSet w a -> String

showList :: [BitSet w a] -> ShowS

(Bits w, Binary w, Enumish a) => Binary (BitSet w a)

Methods

put :: BitSet w a -> Put

get :: Get (BitSet w a)

putList :: [BitSet w a] -> Put

class (Eq a, Ord a) => Enumish a where

An Enumish value, all maps to a number, but not all integers maps to a enumsish value. There is no guarantee that the integers will be subsequent.

Minimal complete definition

inOrder

Methods

inOrder :: [(Int, a)]

The only needed implementation is a list of integer-enum pairs in ascending order, corresponding to their integer value.

fromEnumish :: a -> Int

toEnumish :: Int -> Maybe a

Instances

Enumish FAccessFlag

Methods

inOrder :: [(Int, FAccessFlag)]

fromEnumish :: FAccessFlag -> Int

toEnumish :: Int -> Maybe FAccessFlag

Enumish CAccessFlag

Methods

inOrder :: [(Int, CAccessFlag)]

fromEnumish :: CAccessFlag -> Int

toEnumish :: Int -> Maybe CAccessFlag

Enumish MAccessFlag

Methods

inOrder :: [(Int, MAccessFlag)]

fromEnumish :: MAccessFlag -> Int

toEnumish :: Int -> Maybe MAccessFlag

Specific sizes

type BitSet16 = BitSet Word16

A BitSet using a 16 bit word

General Utilities

trd :: (a, b, c) -> c

Takes the third element of a triple.