Copyright	(c) Christian Gram Kalhauge 2017
License	MIT
Maintainer	kalhuage@cs.ucla.edu
Safe Haskell	None
Language	Haskell2010

Language.JVM.Utils

Contents

Sized Data Structures
- Specific sizes
Bit Set
- Specific sizes
General Utilities

Description

This module contains utilities missing not in other libraries.

Synopsis

newtype SizedList w a = SizedList {
- unSizedList :: [a]
}
listSize :: Num w => SizedList w a -> w
newtype SizedByteString w = SizedByteString {
- unSizedByteString :: ByteString
}
byteStringSize :: Num w => SizedByteString w -> w
type SizedList8 = SizedList Word8
type SizedList16 = SizedList Word16
type SizedByteString32 = SizedByteString Word32
type SizedByteString16 = SizedByteString Word16
sizedByteStringFromText :: Text -> SizedByteString w
sizedByteStringToText :: SizedByteString w -> Either UnicodeException Text
tryDecode :: ByteString -> Either UnicodeException Text
newtype BitSet w a = BitSet {
- toSet :: Set a
}
class (Eq a, Ord a) => Enumish a where
- inOrder :: [(Int, a)]
- fromEnumish :: a -> Int
- toEnumish :: Int -> Maybe a
type BitSet16 = BitSet Word16
trd :: (a, b, c) -> c

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 Source #

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) Source #
Instance details Defined in Language.JVM.Utils Methods fmap :: (a -> b) -> SizedList w a -> SizedList w b # (<$) :: a -> SizedList w b -> SizedList w a #
Foldable (SizedList w) Source #
Instance details Defined in Language.JVM.Utils 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) Source #
Instance details Defined in Language.JVM.Utils 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) Source #
Instance details Defined in Language.JVM.Utils Methods (==) :: SizedList w a -> SizedList w a -> Bool # (/=) :: SizedList w a -> SizedList w a -> Bool #
Ord a => Ord (SizedList w a) Source #
Instance details Defined in Language.JVM.Utils Methods compare :: SizedList w a -> SizedList w a -> Ordering # (<) :: SizedList w a -> SizedList w a -> Bool # (<=) :: SizedList w a -> SizedList w a -> Bool # (>) :: SizedList w a -> SizedList w a -> Bool # (>=) :: SizedList w a -> SizedList w a -> Bool # max :: SizedList w a -> SizedList w a -> SizedList w a # min :: SizedList w a -> SizedList w a -> SizedList w a #
Show a => Show (SizedList w a) Source #
Instance details Defined in Language.JVM.Utils 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) Source #
Instance details Defined in Language.JVM.Utils Methods put :: SizedList w a -> Put # get :: Get (SizedList w a) # putList :: [SizedList w a] -> Put #
NFData a => NFData (SizedList w a) Source #
Instance details Defined in Language.JVM.Utils Methods rnf :: SizedList w a -> () #

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

Get the size of the sized list.

newtype SizedByteString w Source #

A byte string with a size w.

Constructors

SizedByteString
Fields unSizedByteString :: ByteString

Instances

Eq (SizedByteString w) Source #
Instance details Defined in Language.JVM.Utils Methods (==) :: SizedByteString w -> SizedByteString w -> Bool # (/=) :: SizedByteString w -> SizedByteString w -> Bool #
Ord (SizedByteString w) Source #
Instance details Defined in Language.JVM.Utils Methods compare :: SizedByteString w -> SizedByteString w -> Ordering # (<) :: SizedByteString w -> SizedByteString w -> Bool # (<=) :: SizedByteString w -> SizedByteString w -> Bool # (>) :: SizedByteString w -> SizedByteString w -> Bool # (>=) :: SizedByteString w -> SizedByteString w -> Bool # max :: SizedByteString w -> SizedByteString w -> SizedByteString w # min :: SizedByteString w -> SizedByteString w -> SizedByteString w #
Show (SizedByteString w) Source #
Instance details Defined in Language.JVM.Utils Methods showsPrec :: Int -> SizedByteString w -> ShowS # show :: SizedByteString w -> String # showList :: [SizedByteString w] -> ShowS #
IsString (SizedByteString w) Source #
Instance details Defined in Language.JVM.Utils Methods fromString :: String -> SizedByteString w #
(Binary w, Integral w) => Binary (SizedByteString w) Source #
Instance details Defined in Language.JVM.Utils Methods put :: SizedByteString w -> Put # get :: Get (SizedByteString w) # putList :: [SizedByteString w] -> Put #
NFData (SizedByteString w) Source #
Instance details Defined in Language.JVM.Utils Methods rnf :: SizedByteString w -> () #

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

Get the size of a SizedByteString

Specific sizes

type SizedList8 = SizedList Word8 Source #

A sized list using a 8 bit word as length

type SizedList16 = SizedList Word16 Source #

A sized list using a 16 bit word as length

type SizedByteString32 = SizedByteString Word32 Source #

A sized bytestring using a 32 bit word as length

type SizedByteString16 = SizedByteString Word16 Source #

A sized bytestring using a 16 bit word as length

sizedByteStringFromText :: Text -> SizedByteString w Source #

Convert a Sized bytestring from Utf8 Text.

sizedByteStringToText :: SizedByteString w -> Either UnicodeException Text Source #

Convert a Sized bytestring to Utf8 Text.

tryDecode :: ByteString -> Either UnicodeException Text Source #

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 Source #

A bit set of size w

Constructors

BitSet
Fields toSet :: Set a

Instances

Eq a => Eq (BitSet w a) Source #
Instance details Defined in Language.JVM.Utils Methods (==) :: BitSet w a -> BitSet w a -> Bool # (/=) :: BitSet w a -> BitSet w a -> Bool #
Ord a => Ord (BitSet w a) Source #
Instance details Defined in Language.JVM.Utils 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) Source #
Instance details Defined in Language.JVM.Utils Methods showsPrec :: Int -> BitSet w a -> ShowS # show :: BitSet w a -> String # showList :: [BitSet w a] -> ShowS #
(Show w, Bits w, Binary w, Enumish a) => Binary (BitSet w a) Source #
Instance details Defined in Language.JVM.Utils Methods put :: BitSet w a -> Put # get :: Get (BitSet w a) # putList :: [BitSet w a] -> Put #
NFData a => NFData (BitSet w a) Source #
Instance details Defined in Language.JVM.Utils Methods rnf :: BitSet w a -> () #

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

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)] Source #

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

fromEnumish :: a -> Int Source #

toEnumish :: Int -> Maybe a Source #

Instances

Enumish PAccessFlag Source #
Instance details Defined in Language.JVM.AccessFlag Methods inOrder :: [(Int, PAccessFlag)] Source # fromEnumish :: PAccessFlag -> Int Source # toEnumish :: Int -> Maybe PAccessFlag Source #
Enumish FAccessFlag Source #
Instance details Defined in Language.JVM.AccessFlag Methods inOrder :: [(Int, FAccessFlag)] Source # fromEnumish :: FAccessFlag -> Int Source # toEnumish :: Int -> Maybe FAccessFlag Source #
Enumish ICAccessFlag Source #
Instance details Defined in Language.JVM.AccessFlag Methods inOrder :: [(Int, ICAccessFlag)] Source # fromEnumish :: ICAccessFlag -> Int Source # toEnumish :: Int -> Maybe ICAccessFlag Source #
Enumish CAccessFlag Source #
Instance details Defined in Language.JVM.AccessFlag Methods inOrder :: [(Int, CAccessFlag)] Source # fromEnumish :: CAccessFlag -> Int Source # toEnumish :: Int -> Maybe CAccessFlag Source #
Enumish MAccessFlag Source #
Instance details Defined in Language.JVM.AccessFlag Methods inOrder :: [(Int, MAccessFlag)] Source # fromEnumish :: MAccessFlag -> Int Source # toEnumish :: Int -> Maybe MAccessFlag Source #

Specific sizes

type BitSet16 = BitSet Word16 Source #

A BitSet using a 16 bit word

General Utilities

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

Takes the third element of a triple.