git.iko.soy/binary-bits
on master help sign in
swap
21adca762 ahead, 0 behind
14 files changed+1242−364
since splitsnapshots
unifiedsplit
.gitignore+4 .travis.yml+41 BitsQC.hs+304−44 Data/Binary/Bits.hs+6−6 Data/Binary/Bits/Alignment.hs+22 Data/Binary/Bits/BitOrder.hs+47 Data/Binary/Bits/Get.hs+271−243 Data/Binary/Bits/Internal.hs+176 Data/Binary/Bits/Put.hs+200−65 binary-bits.cabal+10−6 flake.lock+59 flake.nix+24 stack.yaml+66 stack.yaml.lock+12
.gitignorenew file+4
@@ -0,0 +1,4 @@
1+.cabal-sandbox
2+cabal.sandbox.config
3+dist/
4+.stack-work
.travis.ymlnew file+41
@@ -0,0 +1,41 @@
1+# NB: don't set `language: haskell` here
2+# See https://github.com/hvr/multi-ghc-travis for more information
3+
4+env:
5+ - CABALVER=1.18 GHCVER=7.4.2
6+ - CABALVER=1.18 GHCVER=7.6.3
7+ - CABALVER=1.18 GHCVER=7.8.3
8+ - CABALVER=1.22 GHCVER=7.10.1
9+
10+before_install:
11+ - sudo add-apt-repository -y ppa:hvr/ghc
12+ - sudo apt-get update
13+ - sudo apt-get install cabal-install-$CABALVER ghc-$GHCVER
14+ - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH
15+
16+install:
17+ - cabal update
18+ - cabal sandbox init
19+ - cabal install --only-dependencies --enable-tests --enable-benchmarks
20+
21+script:
22+ - cabal configure --enable-tests --enable-benchmarks -v2
23+ - cabal build
24+ - cabal test
25+# "cabal check" disabled due to -O2 warning
26+# - cabal check
27+ - cabal sdist
28+# check that the generated source-distribution can be built & installed
29+ - export SRC_TGZ=$(cabal info . | awk '{print $2 ".tar.gz";exit}') ;
30+ cd dist/;
31+ cabal sandbox init;
32+ if [ -f "$SRC_TGZ" ]; then
33+ cabal install --force-reinstalls "$SRC_TGZ";
34+ else
35+ echo "expected '$SRC_TGZ' not found";
36+ exit 1;
37+ fi
38+
39+notifications:
40+ email:
41+ - kolmodin@gmail.com
BitsQC.hs+304−44
@@ -1,34 +1,32 @@
1−{-# LANGUAGE FlexibleInstances, FlexibleContexts, TupleSections #-}
1+{-# LANGUAGE CPP, FlexibleInstances, FlexibleContexts, TupleSections #-}
22
3−module Main where
3+module Main ( main ) where
44
5−import Data.Binary ( encode, Binary(..) )
6−import Data.Binary.Get ( runGet )
5+import Data.Binary ( Binary(..) )
6+import Data.Binary.Get ( runGet, runGetIncremental, pushChunks, Decoder(..) )
77import Data.Binary.Put ( runPut )
88
9−import qualified Data.Binary.Get as BG ( getWord8, getWord16be, getWord32be, getWord64be )
10−import qualified Data.Binary.Put as BP ( putWord8, putWord16be, putWord32be, putWord64be )
11−
129import Data.Binary.Bits
1310import Data.Binary.Bits.Get
1411import Data.Binary.Bits.Put
12+import Data.Binary.Bits.BitOrder
1513
1614import qualified Data.ByteString as B
15+import qualified Data.ByteString.Lazy as L
1716
1817import Control.Applicative
1918import Data.Bits
20−import Data.Monoid
2119import Data.Word
2220import Foreign.Storable
23−import System.Random
21+import Data.Traversable (traverse)
22+import Data.Foldable (traverse_)
2423
25−import Test.Framework.Options ( TestOptions'(..) )
2624import Test.Framework.Providers.QuickCheck2 ( testProperty )
2725import Test.Framework.Runners.Console ( defaultMain )
28−import Test.Framework.Runners.Options ( RunnerOptions'(..) )
2926import Test.Framework ( Test, testGroup )
3027import Test.QuickCheck
3128
29+main :: IO ()
3230main = defaultMain tests
3331
3432tests :: [Test]
@@ -39,6 +37,29 @@ tests =
3937 , testGroup "Custom test cases"
4038 [ testProperty "prop_composite_case" prop_composite_case ]
4139
40+ , testGroup "getByteString"
41+ [ testProperty "prop_getByteString_negative" prop_getByteString_negative
42+ , testProperty "prop_putByteString_getByteString" (prop_putByteString_getByteString :: BitOrder -> B.ByteString -> Property)
43+ , testProperty "prop_putByteString_getByteString_many" (prop_putByteString_getByteString_many :: BitOrder -> [B.ByteString] -> Property)
44+ ]
45+
46+ , testGroup "getLazyByteString"
47+ [ testProperty "getLazyByteString == getByteString"
48+ prop_getLazyByteString_equal_to_ByteString
49+ , testProperty "getLazyByteString == getByteString (with shift)"
50+ prop_getLazyByteString_equal_to_ByteString2
51+ ]
52+
53+ , testGroup "isEmpty"
54+ [ testProperty "prop_isEmptyOfEmptyEmpty" prop_isEmptyOfEmptyEmpty
55+ , testProperty "prop_isEmptyOfNonEmptyEmpty" prop_isEmptyOfNonEmptyEmpty
56+ , testProperty "prop_isEmptyOfConsumedEmpty" prop_isEmptyOfConsumedEmpty
57+ , testProperty "prop_isEmptyOfNotConsumedNotEmpty" prop_isEmptyOfNotConsumedNotEmpty
58+ ]
59+
60+ , testGroup "Fail"
61+ [ testProperty "monadic fail" prop_fail ]
62+
4263 , testGroup "prop_bitput_with_get_from_binary"
4364 [ testProperty "Word8" (prop_bitput_with_get_from_binary :: W [Word8] -> Property)
4465 , testProperty "Word16" (prop_bitput_with_get_from_binary :: W [Word16] -> Property)
@@ -68,10 +89,10 @@ tests =
6889 ]
6990
7091 , testGroup "prop_put_with_bitreq"
71− [ testProperty "Word8" (prop_putget_with_bitreq :: W Word8 -> Property)
72− , testProperty "Word16" (prop_putget_with_bitreq :: W Word16 -> Property)
73− , testProperty "Word32" (prop_putget_with_bitreq :: W Word32 -> Property)
74− , testProperty "Word64" (prop_putget_with_bitreq :: W Word64 -> Property)
92+ [ testProperty "Word8" (prop_putget_with_bitreq :: BitOrder -> W Word8 -> Property)
93+ , testProperty "Word16" (prop_putget_with_bitreq :: BitOrder -> W Word16 -> Property)
94+ , testProperty "Word32" (prop_putget_with_bitreq :: BitOrder -> W Word32 -> Property)
95+ , testProperty "Word64" (prop_putget_with_bitreq :: BitOrder -> W Word64 -> Property)
7596 ]
7697
7798 , testGroup "prop_putget_list_simple"
@@ -82,6 +103,13 @@ tests =
82103 , testProperty "Word64" (prop_putget_list_simple :: W [Word64] -> Property)
83104 ]
84105
106+ , testGroup "prop_putget_applicative_with_bitreq"
107+ [ testProperty "Word8" (prop_putget_applicative_with_bitreq :: W [(Word8,Word8,Word8)] -> Property)
108+ , testProperty "Word16" (prop_putget_applicative_with_bitreq :: W [(Word16,Word16,Word16)] -> Property)
109+ , testProperty "Word32" (prop_putget_applicative_with_bitreq :: W [(Word32,Word32,Word32)] -> Property)
110+ , testProperty "Word64" (prop_putget_applicative_with_bitreq :: W [(Word64,Word64,Word64)] -> Property)
111+ ]
112+
85113 , testGroup "prop_putget_list_with_bitreq"
86114 [ testProperty "Word8" (prop_putget_list_with_bitreq :: W [Word8] -> Property)
87115 , testProperty "Word16" (prop_putget_list_with_bitreq :: W [Word16] -> Property)
@@ -89,20 +117,74 @@ tests =
89117 , testProperty "Word64" (prop_putget_list_with_bitreq :: W [Word64] -> Property)
90118 ]
91119 , testGroup "prop_bitget_bytestring_interspersed"
92− [ testProperty "Word8" (prop_bitget_bytestring_interspersed :: W Word8 -> [B.ByteString] -> Property)
93− , testProperty "Word16" (prop_bitget_bytestring_interspersed :: W Word16 -> [B.ByteString] -> Property)
94− , testProperty "Word32" (prop_bitget_bytestring_interspersed :: W Word32 -> [B.ByteString] -> Property)
95− , testProperty "Word64" (prop_bitget_bytestring_interspersed :: W Word64 -> [B.ByteString] -> Property)
120+ [ testProperty "Word8" (prop_bitget_bytestring_interspersed :: BitOrder -> W Word8 -> [B.ByteString] -> Property)
121+ , testProperty "Word16" (prop_bitget_bytestring_interspersed :: BitOrder -> W Word16 -> [B.ByteString] -> Property)
122+ , testProperty "Word32" (prop_bitget_bytestring_interspersed :: BitOrder -> W Word32 -> [B.ByteString] -> Property)
123+ , testProperty "Word64" (prop_bitget_bytestring_interspersed :: BitOrder -> W Word64 -> [B.ByteString] -> Property)
124+ ]
125+ , testGroup "Simulate programs"
126+ [ testProperty "primitive" prop_primitive
127+ , testProperty "many primitives in sequence" prop_program
96128 ]
97129 ]
98130
99−prop_putget_with_bitreq :: (BinaryBit a, Num a, Bits a, Ord a) => W a -> Property
100−prop_putget_with_bitreq (W w) = property $
131+prop_isEmptyOfEmptyEmpty :: Bool
132+prop_isEmptyOfEmptyEmpty = runGet (runBitGet isEmpty) L.empty
133+
134+prop_isEmptyOfNonEmptyEmpty :: L.ByteString -> Property
135+prop_isEmptyOfNonEmptyEmpty bs =
136+ not (L.null bs) ==> not (runGet (runBitGet isEmpty) bs)
137+
138+prop_isEmptyOfConsumedEmpty :: L.ByteString -> Property
139+prop_isEmptyOfConsumedEmpty bs =
140+ not (L.null bs) ==>
141+ runGet (runBitGet (getByteString n >> isEmpty)) bs
142+ where n = fromIntegral $ L.length bs
143+
144+prop_isEmptyOfNotConsumedNotEmpty :: L.ByteString -> Int -> Property
145+prop_isEmptyOfNotConsumedNotEmpty bs n =
146+ (fromIntegral n) < L.length bs && not (L.null bs) ==>
147+ not (runGet (runBitGet (getByteString n >> isEmpty)) bs)
148+
149+prop_getLazyByteString_equal_to_ByteString :: L.ByteString -> Int -> Property
150+prop_getLazyByteString_equal_to_ByteString bs n =
151+ (fromIntegral n) <= L.length bs ==>
152+ runGet (runBitGet (getLazyByteString (fromIntegral n))) bs ==
153+ (L.fromChunks . (:[]) $ runGet (runBitGet (getByteString n)) bs)
154+
155+prop_getLazyByteString_equal_to_ByteString2 :: L.ByteString -> Int -> Property
156+prop_getLazyByteString_equal_to_ByteString2 bs n =
157+ (L.length bs > 1) && (fromIntegral n) < L.length bs ==>
158+ runGet (runBitGet (getWord8 2 >> getLazyByteString (fromIntegral n))) bs ==
159+ (L.fromChunks . (:[]) $ runGet (runBitGet (getWord8 2 >> getByteString n)) bs)
160+
161+prop_getByteString_negative :: Int -> Property
162+prop_getByteString_negative n =
163+ n < 1 ==>
164+ runGet (runBitGet (getByteString n)) L.empty == B.empty
165+
166+prop_putByteString_getByteString :: BitOrder -> B.ByteString -> Property
167+prop_putByteString_getByteString bo bs = property $ bs' == bs
168+ where
169+ n = B.length bs
170+ w = runPut (runBitPut (withBitOrder bo (putByteString bs)))
171+ bs' = runGet (runBitGet (withBitOrder bo (getByteString n))) w
172+
173+prop_putByteString_getByteString_many :: BitOrder -> [B.ByteString] -> Property
174+prop_putByteString_getByteString_many bo bs = property $ bs' == bs
175+ where
176+ n = fmap B.length bs
177+ w = runPut (runBitPut (withBitOrder bo (traverse_ putByteString bs)))
178+ bs' = runGet (runBitGet (withBitOrder bo (traverse getByteString n))) w
179+
180+
181+prop_putget_with_bitreq :: (BinaryBit a, Num a, Bits a, Ord a) => BitOrder -> W a -> Property
182+prop_putget_with_bitreq bo (W w) = property $
101183 -- write all words with as many bits as it's required
102184 let p = putBits (bitreq w) w
103185 g = getBits (bitreq w)
104− lbs = runPut (runBitPut p)
105− w' = runGet (runBitGet g) lbs
186+ lbs = runPut (runBitPut (withBitOrder bo p))
187+ w' = runGet (runBitGet (withBitOrder bo g)) lbs
106188 in w == w'
107189
108190-- | Write a list of items. Each item is written with the maximum amount of
@@ -110,7 +192,7 @@ prop_putget_with_bitreq (W w) = property $
110192prop_putget_list_simple :: (BinaryBit a, Eq a, Storable a) => W [a] -> Property
111193prop_putget_list_simple (W ws) = property $
112194 let s = sizeOf (head ws) * 8
113− p = mapM_ (\v -> putBits s v) ws
195+ p = mapM_ (putBits s) ws
114196 g = mapM (const (getBits s)) ws
115197 lbs = runPut (runBitPut p)
116198 ws' = runGet (runBitGet g) lbs
@@ -129,6 +211,18 @@ prop_putget_list_with_bitreq (W ws) = property $
129211 where
130212 bitlist = map bitreq ws
131213
214+prop_putget_applicative_with_bitreq :: (BinaryBit a, Num a, Bits a, Ord a) => W [(a,a,a)] -> Property
215+prop_putget_applicative_with_bitreq (W ts) = property $
216+ let p = mapM_ (\(a,b,c) -> do putBits (bitreq a) a
217+ putBits (bitreq b) b
218+ putBits (bitreq c) c) ts
219+ g = mapM (\(a,b,c) -> (,,) <$> getBits a <*> getBits b <*> getBits c) bitlist
220+ lbs = runPut (runBitPut p)
221+ ts' = runGet (runBitGet g) lbs
222+ in ts == ts'
223+ where
224+ bitlist = map (\(a,b,c) -> (bitreq a, bitreq b, bitreq c)) ts
225+
132226-- | Write bits using this library, and read them back using the binary
133227-- library.
134228prop_bitput_with_get_from_binary :: (BinaryBit a, Binary a, Storable a, Eq a) => W [a] -> Property
@@ -152,33 +246,52 @@ prop_bitget_with_put_from_binary (W ws) = property $
152246 in ws == ws'
153247
154248-- | Write each 'ByteString' with a variable sized value as a separator.
155−prop_bitget_bytestring_interspersed :: (BinaryBit a, Binary a, Num a, Ord a, Bits a) => W a -> [B.ByteString] -> Property
156−prop_bitget_bytestring_interspersed (W ws) bss = property $
249+prop_bitget_bytestring_interspersed :: (BinaryBit a, Binary a, Num a, Ord a, Bits a) => BitOrder -> W a -> [B.ByteString] -> Property
250+prop_bitget_bytestring_interspersed bo (W ws) bss = property $
157251 let p = mapM_ (\bs -> putBits (bitreq ws) ws >> putByteString bs) bss
158− g = mapM (\bs -> (,) <$> (getBits (bitreq ws)) <*> (getByteString (B.length bs))) bss
159− lbs = runPut (runBitPut p)
160− r = runGet (runBitGet g) lbs
252+ g = mapM (\bs -> (,) <$> getBits (bitreq ws) <*> getByteString (B.length bs)) bss
253+ lbs = runPut (runBitPut (withBitOrder bo p))
254+ r = runGet (runBitGet (withBitOrder bo g)) lbs
161255 in map (ws,) bss == r
162256
257+-- | Test failing.
258+prop_fail :: L.ByteString -> String -> Property
259+prop_fail lbs errMsg0 = forAll (choose (0, 8 * L.length lbs)) $ \len ->
260+ let (bytes,bits) = len `divMod` 8
261+ expectedBytesConsumed
262+ | bits == 0 = bytes
263+ | otherwise = bytes + 1
264+ p = do _ <- getByteString (fromIntegral bytes)
265+ _ <- getBits (fromIntegral bits) :: BitGet Word8
266+ fail errMsg0
267+ r = runGetIncremental (runBitGet p) `pushChunks` lbs
268+ in case r of
269+ Fail remainingBS pos errMsg ->
270+ and [ L.fromChunks [remainingBS] == L.drop expectedBytesConsumed lbs
271+ , pos == expectedBytesConsumed
272+ , errMsg == errMsg0
273+ ]
274+ _ -> False
275+
163276-- | number of bits required to write @v@
164−bitreq :: (Num b, Bits a, Ord a) => a -> b
277+bitreq :: (Num b, Num a, Bits a, Ord a) => a -> b
165278bitreq v = fromIntegral . head $ [ req | (req, top) <- bittable, v <= top ]
166279
167−bittable :: Bits a => [(Integer, a)]
280+bittable :: (Bits a, Num a) => [(Integer, a)]
168281bittable = [ (fromIntegral x, (1 `shiftL` x) - 1) | x <- [1..64] ]
169282
170283prop_bitreq :: W Word64 -> Property
171284prop_bitreq (W w) = property $
172285 ( w == 0 && bitreq w == 1 )
173− || bitreq w == (bitreq (w `shiftR` 1)) + 1
286+ || bitreq w == bitreq (w `shiftR` 1) + 1
174287
175288prop_composite_case :: Bool -> W Word16 -> Property
176289prop_composite_case b (W w) = w < 0x8000 ==>
177290 let p = do putBool b
178− putWord16be 15 w
291+ putWord16 15 w
179292 g = do v <- getBool
180293 case v of
181− True -> getWord16be 15
294+ True -> getWord16 15
182295 False -> do
183296 msb <- getWord8 7
184297 lsb <- getWord8 8
@@ -187,7 +300,7 @@ prop_composite_case b (W w) = w < 0x8000 ==>
187300 w' = runGet (runBitGet g) lbs
188301 in w == w'
189302
190−prop_compare_put_with_naive :: (Bits a, BinaryBit a, Ord a) => W [a] -> Property
303+prop_compare_put_with_naive :: (Bits a, BinaryBit a, Ord a, Num a) => W [a] -> Property
191304prop_compare_put_with_naive (W ws) = property $
192305 let pn = mapM_ (\v -> naive_put (bitreq v) v) ws
193306 p = mapM_ (\v -> putBits (bitreq v) v) ws
@@ -204,7 +317,7 @@ prop_compare_get_with_naive (W ws) = property $
204317 rn = runGet (runBitGet gn) lbs
205318 r = runGet (runBitGet g ) lbs
206319 -- we must help our compiler to resolve the types of 'gn' and 'g'
207− types = rn == ws && r == ws
320+ _types = rn == ws && r == ws
208321 in rn == r
209322
210323-- | Write one bit at a time until the full word has been written
@@ -235,14 +348,16 @@ shrinker w = [ w `shiftR` 1 -- try to make everything roughly half size
235348
236349data W a = W { unW :: a } deriving (Show, Eq, Ord)
237350
351+arbitraryW :: (Arbitrary (W a)) => Gen a
352+arbitraryW = unW <$> arbitrary
353+
354+shrinkW :: (Arbitrary (W a)) => a -> [a]
355+shrinkW x = unW <$> shrink (W x)
356+
238357instance Arbitrary (W Bool) where
239358 arbitrary = W <$> arbitrary
240359 shrink = map W <$> shrink . unW
241360
242−instance (Arbitrary (W a)) => Arbitrary (W [a]) where
243− arbitrary = W . map unW <$> arbitrary
244− shrink = map (W . map unW) <$> mapM shrink . map W . unW
245−
246361instance Arbitrary (W Word8) where
247362 arbitrary = W <$> choose (minBound, maxBound)
248363 shrink = map W . shrinker . unW
@@ -263,11 +378,155 @@ instance Arbitrary B.ByteString where
263378 arbitrary = B.pack <$> arbitrary
264379 shrink bs = B.pack <$> shrink (B.unpack bs)
265380
266−integralRandomR :: (Integral a, RandomGen g) => (a,a) -> g -> (a,g)
267−integralRandomR (a,b) g = case randomR (fromIntegral a :: Integer,
268− fromIntegral b :: Integer) g of
269− (x,g) -> (fromIntegral x, g)
381+instance Arbitrary L.ByteString where
382+ arbitrary = L.fromChunks <$> arbitrary
383+ shrink bs = L.fromChunks <$> shrink (L.toChunks bs)
384+
385+instance (Arbitrary (W a)) => Arbitrary (W [a]) where
386+ arbitrary = W . map unW <$> arbitrary
387+ shrink = map (W . map unW) <$> mapM shrink . map W . unW
388+
389+instance (Arbitrary (W a), Arbitrary (W b)) => Arbitrary (W (a,b)) where
390+ arbitrary = (W .) . (,) <$> arbitraryW <*> arbitraryW
391+ shrink (W (a,b)) = (W .) . (,) <$> shrinkW a <*> shrinkW b
392+
393+instance (Arbitrary (W a), Arbitrary (W b), Arbitrary (W c)) => Arbitrary (W (a,b,c)) where
394+ arbitrary = ((W .) .) . (,,) <$> arbitraryW <*> arbitraryW <*> arbitraryW
395+ shrink (W (a,b,c)) = ((W .) .) . (,,) <$> shrinkW a <*> shrinkW b <*> shrinkW c
396+
397+data Primitive
398+ = Bool Bool
399+ | W8 Int Word8
400+ | W16 Int Word16
401+ | W32 Int Word32
402+ | W64 Int Word64
403+ | BS Int B.ByteString
404+ | LBS Int L.ByteString
405+ | Skip Int
406+ | IsEmpty
407+ deriving (Eq, Show)
408+
409+type Program = [Primitive]
410+
411+instance Arbitrary Primitive where
412+ arbitrary = do
413+ let gen c = do
414+ let (maxBits, _) = (\w -> (finiteBitSize w, c undefined w)) undefined
415+ bits <- choose (0, maxBits)
416+ n <- choose (0, fromIntegral (2^bits-1))
417+ return (c bits n)
418+ oneof
419+ [ Bool <$> arbitrary
420+ , gen W8
421+ , gen W16
422+ , gen W32
423+ , gen W64
424+ , Skip <$> choose (0, 3000)
425+ , do n <- choose (0,10)
426+ cs <- vector n
427+ return (BS n (B.pack cs))
428+ , do n <- choose (0,10)
429+ cs <- vector n
430+ return (LBS n (L.pack cs))
431+ , return IsEmpty
432+ ]
433+ shrink p =
434+ let snk c x = map (\x' -> c (bitreq x') x') (shrinker x) in
435+ case p of
436+ Bool b -> if b then [Bool False] else []
437+ W8 _ x -> snk W8 x
438+ W16 _ x -> snk W16 x
439+ W32 _ x -> snk W32 x
440+ W64 _ x -> snk W64 x
441+ Skip x -> Skip <$> shrink x
442+ BS _ bs -> let ws = B.unpack bs in map (\ws' -> BS (length ws') (B.pack ws')) (shrink ws)
443+ LBS _ lbs -> let ws = L.unpack lbs in map (\ws' -> LBS (length ws') (L.pack ws')) (shrink ws)
444+ IsEmpty -> []
445+
446+instance Arbitrary BitOrder where
447+ arbitrary = elements [BB, LB, LL, BL]
448+ shrink LL = [BB,LB,BL]
449+ shrink BL = [BB,LB]
450+ shrink LB = [BB]
451+ shrink BB = []
452+
453+
454+prop_primitive :: Primitive -> Property
455+prop_primitive prim = property $
456+ let p = putPrimitive prim
457+ g = getPrimitive prim
458+ lbs = runPut (runBitPut p)
459+ r = runGet (runBitGet g) lbs
460+ in r == prim
270461
462+prop_program :: Program -> Property
463+prop_program program = property $
464+ let p = mapM_ putPrimitive program
465+ g = verifyProgram (8 * fromIntegral (L.length lbs)) program
466+ lbs = runPut (runBitPut p)
467+ r = runGet (runBitGet g) lbs
468+ in r
469+
470+putPrimitive :: Primitive -> BitPut ()
471+putPrimitive p =
472+ case p of
473+ Bool b -> putBool b
474+ W8 n x -> putWord8 n x
475+ W16 n x -> putWord16 n x
476+ W32 n x -> putWord32 n x
477+ W64 n x -> putWord64 n x
478+ Skip n -> skipBits n
479+ BS _ bs -> putByteString bs
480+ LBS _ lbs -> mapM_ putByteString (L.toChunks lbs)
481+ IsEmpty -> return ()
482+
483+getPrimitive :: Primitive -> BitGet Primitive
484+getPrimitive p =
485+ case p of
486+ Bool _ -> Bool <$> getBool
487+ W8 n _ -> W8 n <$> getWord8 n
488+ W16 n _ -> W16 n <$> getWord16 n
489+ W32 n _ -> W32 n <$> getWord32 n
490+ W64 n _ -> W64 n <$> getWord64 n
491+ Skip n -> skipBits n >> return (Skip n)
492+ BS n _ -> BS n <$> getByteString n
493+ LBS n _ -> LBS n <$> getLazyByteString n
494+ IsEmpty -> isEmpty >> return IsEmpty
495+
496+getPrimitiveSize :: Primitive -> Int
497+getPrimitiveSize p = case p of
498+ Bool _ -> 1
499+ W8 n _ -> n
500+ W16 n _ -> n
501+ W32 n _ -> n
502+ W64 n _ -> n
503+ Skip n -> n
504+ BS n _ -> n*8
505+ LBS n _ -> n*8
506+ IsEmpty -> 0
507+
508+verifyProgram :: Int -> Program -> BitGet Bool
509+verifyProgram totalLength ps0 = go 0 ps0
510+ where
511+ go _ [] = return True
512+ go pos (p:ps) =
513+ case p of
514+ IsEmpty -> do
515+ let expected = pos == totalLength
516+ actual <- isEmpty
517+ if expected == actual
518+ then go pos ps
519+ else error $ "isEmpty returned wrong value, expected "
520+ ++ show expected ++ " but got " ++ show actual
521+ _ -> check p (getPrimitive p) >> go (pos + getPrimitiveSize p) ps
522+ check x g = do
523+ y <- g
524+ if x == y
525+ then return ()
526+ else error $ "Roundtrip error: Expected "
527+ ++ show x ++ " but got " ++ show y
528+
529+{-
271530instance Random Word where
272531 randomR = integralRandomR
273532 random = randomR (minBound,maxBound)
@@ -287,3 +546,4 @@ instance Random Word32 where
287546instance Random Word64 where
288547 randomR = integralRandomR
289548 random = randomR (minBound,maxBound)
549+-}
Data/Binary/Bits.hs+6−6
@@ -33,13 +33,13 @@ instance BinaryBit Word8 where
3333 getBits = getWord8
3434
3535instance BinaryBit Word16 where
36− putBits = putWord16be
37− getBits = getWord16be
36+ putBits = putWord16
37+ getBits = getWord16
3838
3939instance BinaryBit Word32 where
40− putBits = putWord32be
41− getBits = getWord32be
40+ putBits = putWord32
41+ getBits = getWord32
4242
4343instance BinaryBit Word64 where
44− putBits = putWord64be
45− getBits = getWord64be
44+ putBits = putWord64
45+ getBits = getWord64
Data/Binary/Bits/Alignment.hsnew file+22
@@ -0,0 +1,22 @@
1+-----------------------------------------------------------------------------
2+-- |
3+-- Module : Data.Binary.Bits.Get
4+-- Copyright : (c) Lennart Kolmodin 2010-2011
5+-- (c) Sylvain Henry 2015
6+-- License : BSD3-style (see LICENSE)
7+--
8+-- Maintainer : kolmodin@gmail.com
9+-- Stability : experimental
10+-- Portability : portable (should run where the package binary runs)
11+
12+module Data.Binary.Bits.Alignment
13+ ( Alignable(..)
14+ )
15+where
16+
17+class Monad m => Alignable m where
18+ -- | Skip the given number of bits
19+ skipBits :: Int -> m ()
20+
21+ -- | Skip bits if necessary to align to the next byte
22+ alignByte :: m ()
Data/Binary/Bits/BitOrder.hsnew file+47
@@ -0,0 +1,47 @@
1+-----------------------------------------------------------------------------
2+-- |
3+-- Module : Data.Binary.Bits.Get
4+-- Copyright : (c) Lennart Kolmodin 2010-2011
5+-- (c) Sylvain Henry 2015
6+-- License : BSD3-style (see LICENSE)
7+--
8+-- Maintainer : kolmodin@gmail.com
9+-- Stability : experimental
10+-- Portability : portable (should run where the package binary runs)
11+
12+module Data.Binary.Bits.BitOrder
13+ ( BitOrder(..)
14+ , BitOrderable(..)
15+ )
16+where
17+
18+-- | Bit order
19+--
20+-- E.g. two words of 5 bits: ABCDE, VWXYZ
21+-- - BB: ABCDEVWX YZxxxxxx
22+-- - LL: XYZABCDE xxxxxxVW
23+-- - BL: EDCBAZYX WVxxxxxx
24+-- - LB: XWVEDCBA xxxxxxZY
25+data BitOrder
26+ = BB -- ^ Big-endian bytes and bits
27+ | LB -- ^ Little-endian bytes, big-endian bits
28+ | BL -- ^ Big-endian bytes, little-endian bits
29+ | LL -- ^ Little-endian bytes and bits
30+ deriving (Show)
31+
32+
33+class Monad m => BitOrderable m where
34+ -- | Set the current bit-order
35+ setBitOrder :: BitOrder -> m ()
36+
37+ -- | Retrieve the current bit-order
38+ getBitOrder :: m BitOrder
39+
40+ -- | Perform the given action with the given bit-order
41+ withBitOrder :: BitOrder -> m a -> m a
42+ withBitOrder bo act = do
43+ bo' <- getBitOrder
44+ setBitOrder bo
45+ r <- act
46+ setBitOrder bo'
47+ return r
Data/Binary/Bits/Get.hs+271−243
@@ -4,6 +4,7 @@
44-- |
55-- Module : Data.Binary.Bits.Get
66-- Copyright : (c) Lennart Kolmodin 2010-2011
7+-- (c) Sylvain Henry 2015
78-- License : BSD3-style (see LICENSE)
89--
910-- Maintainer : kolmodin@gmail.com
@@ -59,11 +60,19 @@ module Data.Binary.Bits.Get
5960
6061 -- ** Get bytes
6162 , getBool
63+ , getBool#
6264 , getWord8
65+ , getWord16
66+ , getWord32
67+ , getWord64
6368 , getWord16be
6469 , getWord32be
6570 , getWord64be
6671
72+ -- ** Skip bits
73+ , skipBits
74+ , alignByte
75+
6776 -- * Blocks
6877
6978 -- $blocks
@@ -73,31 +82,41 @@ module Data.Binary.Bits.Get
7382 -- ** Read in Blocks
7483 , bool
7584 , word8
85+ , word16
86+ , word32
87+ , word64
7688 , word16be
7789 , word32be
7890 , word64be
7991 , byteString
8092 , Data.Binary.Bits.Get.getByteString
93+ , Data.Binary.Bits.Get.getLazyByteString
94+ , Data.Binary.Bits.Get.isEmpty
8195
8296 ) where
8397
84−import Data.Binary.Get as B ( runGet, Get, getByteString )
98+import Data.Binary.Get as B ( Get, getLazyByteString, isEmpty )
99+import Data.Binary.Get.Internal as B ( get, put, ensureN )
100+import Data.Binary.Bits.BitOrder
101+import Data.Binary.Bits.Internal
102+import Data.Binary.Bits.Alignment
85103
86104import Data.ByteString as B
105+import qualified Data.ByteString.Lazy as L
87106import Data.ByteString.Unsafe
107+import Foreign.Marshal.Alloc (mallocBytes)
108+import Foreign.Ptr
109+import Foreign.Storable (poke)
110+import System.IO.Unsafe (unsafePerformIO)
88111
89112import Data.Bits
90113import Data.Word
91−
92114import Control.Applicative
115+import Control.Monad (when,foldM_)
93116
94117import Prelude as P
95−
96−#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)
97−import GHC.Base
98118import GHC.Word
99−#endif
100−
119+import GHC.Base (uncheckedShiftLWord8#, wordToWord8#, Int (..), andWord8#, Word8#, (-#), Int#, xorI#, eqWord8#, TYPE)
101120
102121-- $bitget
103122-- Parse bits using a monad.
@@ -145,188 +164,121 @@ import GHC.Word
145164--ipv6Header = 'runBitGet' ('block' ipv6headerblock)
146165-- @
147166
148−data S = S !ByteString -- Input
149− !Int -- Bit offset (0-7)
167+data S = S {-# UNPACK #-} !ByteString -- Input
168+ {-# UNPACK #-} !Int -- Bit offset (0-7)
169+ !BitOrder -- Bit order
150170 deriving (Show)
151171
152−-- | A block that will be read with only one boundry check. Needs to know the
153−-- number of bits in advance.
154−data Block a = Block !Int (S -> a)
155−
156−instance Functor Block where
157− fmap f (Block i p) = Block i (\s -> f (p s))
158−
159−instance Applicative Block where
160− pure a = Block 0 (\_ -> a)
161− (Block i p) <*> (Block j q) = Block (i+j) (\s -> p s $ q (incS i s))
162− (Block i _) *> (Block j q) = Block (i+j) (q . incS i)
163− (Block i p) <* (Block j _) = Block (i+j) p
164−
165−-- | Get a block. Will be read with one single boundry check, and
166−-- therefore requires a statically known number of bits.
167−-- Build blocks using 'bool', 'word8', 'word16be', 'word32be', 'word64be',
168−-- 'byteString' and 'Applicative'.
169−block :: Block a -> BitGet a
170−block (Block i p) = do
171− ensureBits i
172− modifyState (\s -> (incS i s, p s))
173−
174−
172+-- | Increment the current bit offset
175173incS :: Int -> S -> S
176−incS o (S bs n) =
177− let !o' = (n+o)
178− !d = o' `shiftR` 3
179− !n' = o' .&. make_mask 3
180− in S (unsafeDrop d bs) n'
181−
182−-- | make_mask 3 = 00000111
183−make_mask :: Bits a => Int -> a
184−make_mask n = (1 `shiftL` fromIntegral n) - 1
185−{-# SPECIALIZE make_mask :: Int -> Int #-}
186−{-# SPECIALIZE make_mask :: Int -> Word #-}
187−{-# SPECIALIZE make_mask :: Int -> Word8 #-}
188−{-# SPECIALIZE make_mask :: Int -> Word16 #-}
189−{-# SPECIALIZE make_mask :: Int -> Word32 #-}
190−{-# SPECIALIZE make_mask :: Int -> Word64 #-}
191−
192−bit_offset :: Int -> Int
193−bit_offset n = make_mask 3 .&. n
194−
195−byte_offset :: Int -> Int
196−byte_offset n = n `shiftR` 3
174+incS o (S bs n bo) = S (unsafeDrop d bs) n' bo
175+ where
176+ !o' = (n+o)
177+ !d = byte_offset o'
178+ !n' = bit_offset o'
197179
180+-- | Read a single bit
198181readBool :: S -> Bool
199−readBool (S bs n) = testBit (unsafeHead bs) (7-n)
200−
201−readWord8 :: Int -> S -> Word8
202−readWord8 n (S bs o)
203− -- no bits at all, return 0
204− | n == 0 = 0
205−
206− -- all bits are in the same byte
207− -- we just need to shift and mask them right
208− | n <= 8 - o = let w = unsafeHead bs
209− m = make_mask n
210− w' = (w `shiftr_w8` (8 - o - n)) .&. m
211− in w'
212−
213− -- the bits are in two different bytes
214− -- make a word16 using both bytes, and then shift and mask
215− | n <= 8 = let w = (fromIntegral (unsafeHead bs) `shiftl_w16` 8) .|.
216− (fromIntegral (unsafeIndex bs 1))
217− m = make_mask n
218− w' = (w `shiftr_w16` (16 - o - n)) .&. m
219− in fromIntegral w'
220−
221−
222−readWord16be :: Int -> S -> Word16
223−readWord16be n s@(S bs o)
224−
225− -- 8 or fewer bits, use readWord8
226− | n <= 8 = fromIntegral (readWord8 n s)
227−
228− -- handle 9 or more bits, stored in two bytes
229−
230− -- no offset, plain and simple 16 bytes
231− | o == 0 && n == 16 = let msb = fromIntegral (unsafeHead bs)
232− lsb = fromIntegral (unsafeIndex bs 1)
233− w = (msb `shiftl_w16` 8) .|. lsb
234− in w
235−
236− -- no offset, but not full 16 bytes
237− | o == 0 = let msb = fromIntegral (unsafeHead bs)
238− lsb = fromIntegral (unsafeIndex bs 1)
239− w = (msb `shiftl_w16` (n-8)) .|. (lsb `shiftr_w16` (16-n))
240− in w
241−
242− -- with offset, and n=9-16
243− | n <= 16 = readWithOffset s shiftl_w16 shiftr_w16 n
244−
245− | otherwise = error "readWord16be: tried to read more than 16 bits"
246−
247−readWord32be :: Int -> S -> Word32
248−readWord32be n s@(S _ o)
249− -- 8 or fewer bits, use readWord8
250− | n <= 8 = fromIntegral (readWord8 n s)
251−
252− -- 16 or fewer bits, use readWord16be
253− | n <= 16 = fromIntegral (readWord16be n s)
254−
255− | o == 0 = readWithoutOffset s shiftl_w32 shiftr_w32 n
256−
257− | n <= 32 = readWithOffset s shiftl_w32 shiftr_w32 n
258−
259− | otherwise = error "readWord32be: tried to read more than 32 bits"
260−
261−
262−readWord64be :: Int -> S -> Word64
263−readWord64be n s@(S _ o)
264− -- 8 or fewer bits, use readWord8
265− | n <= 8 = fromIntegral (readWord8 n s)
266−
267− -- 16 or fewer bits, use readWord16be
268− | n <= 16 = fromIntegral (readWord16be n s)
269−
270− | o == 0 = readWithoutOffset s shiftl_w64 shiftr_w64 n
271−
272− | n <= 64 = readWithOffset s shiftl_w64 shiftr_w64 n
273−
274− | otherwise = error "readWord64be: tried to read more than 64 bits"
275−
276−
182+readBool (S bs o bo) = case bo of
183+ BB -> testBit (unsafeHead bs) (7-o)
184+ BL -> testBit (unsafeHead bs) (7-o)
185+ LL -> testBit (unsafeHead bs) o
186+ LB -> testBit (unsafeHead bs) o
187+
188+-- | Read a single bit
189+readBool# :: S -> Int
190+readBool# (S bs (I# o) bo) = case bo of
191+ BB -> testBit# (7# -# o)
192+ BL -> testBit# (7# -# o)
193+ LL -> testBit# o
194+ LB -> testBit# o
195+ where
196+ !(W8# w) = unsafeHead bs
197+ testBit# n = I# (((w `andWord8#` (wordToWord8# 1## `uncheckedShiftLWord8#` n)) `eqWord8#` wordToWord8# 0##) `xorI#` 1#)
198+
199+
200+-- | Extract a range of bits from (ws :: ByteString)
201+--
202+-- Constraint: 8 * (length ws -1 ) < o+n <= 8 * length ws
203+extract :: (Num a, FastBits a) => BitOrder -> ByteString -> Int -> Int -> a
204+extract bo bs o n
205+ | n == 0 = 0
206+ | B.length bs == 0 = error "Empty ByteString"
207+ | otherwise = rev . mask n . foldlWithIndex' f 0 $ bs
208+ where
209+ -- B.foldl' with index
210+ foldlWithIndex' op b = fst . B.foldl' g (b,0)
211+ where g (b',i) w = (op b' w i, (i+1))
212+
213+ -- 'or' correctly shifted words
214+ f b w i = b .|. (fromIntegral w `fastShift` off i)
215+
216+ -- co-offset
217+ r = B.length bs * 8 - (o + n)
218+
219+ -- shift offset depending on the byte position (0..B.length-1)
220+ off i = case bo of
221+ LL -> 8*i - o
222+ LB -> 8*i - o
223+ BB -> (B.length bs -1 - i) * 8 - r
224+ BL -> (B.length bs -1 - i) * 8 - r
225+
226+ -- reverse bits if necessary
227+ rev = case bo of
228+ LB -> reverseBits n
229+ BL -> reverseBits n
230+ BB -> id
231+ LL -> id
232+
233+
234+-- | Generic readWord
235+readWord :: (Num a, FastBits a) => Int -> S -> a
236+readWord n (S bs o bo)
237+ | n == 0 = 0
238+ | otherwise = extract bo (unsafeTake nbytes bs) o n
239+ where nbytes = byte_offset (o+n+7)
240+
241+-- | Check that the number of bits to read is not greater than the first parameter
242+{-# INLINE readWordChecked #-}
243+readWordChecked :: (Num a, FastBits a) => Int -> Int -> S -> a
244+readWordChecked m n s
245+ | n > m = error $ "Tried to read more than " ++ show m ++ " bits (" ++ show n ++")"
246+ | otherwise = readWord n s
247+
248+-- | Read the given number of bytes and return them in Big-Endian order
249+--
250+-- Examples:
251+-- BB: xxxABCDE FGHIJKLM NOPxxxxx -> ABCDEFGH IJKLMNOP
252+-- LL: LMNOPxxx DEFGHIJK xxxxxABC -> ABCDEFGH IJKLMNOP
253+-- BL: xxxPONML KJIHGFED CBAxxxxx -> ABCDEFGH IJKLMNOP
254+-- LB: EDCBAxxx MLKJIHGF xxxxxPON -> ABCDEFGH IJKLMNOP
277255readByteString :: Int -> S -> ByteString
278−readByteString n s@(S bs o)
279− -- no offset, easy.
280− | o == 0 = unsafeTake n bs
281− -- offset. ugg. this is really naive and slow. but also pretty easy :)
282− | otherwise = B.pack (P.map (readWord8 8) (P.take n (iterate (incS 8) s)))
283−
284−readWithoutOffset :: (Bits a, Num a)
285− => S -> (a -> Int -> a) -> (a -> Int -> a) -> Int -> a
286−readWithoutOffset (S bs o) shifterL shifterR n
287− | o /= 0 = error "readWithoutOffset: there is an offset"
288−
289− | bit_offset n == 0 && byte_offset n <= 4 =
290− let segs = byte_offset n
291− bn 0 = fromIntegral (unsafeHead bs)
292− bn n = (bn (n-1) `shifterL` 8) .|. fromIntegral (unsafeIndex bs n)
293−
294− in bn (segs-1)
256+readByteString n (S bs o bo) =
257+ let
258+ bs' = unsafeTake (n+1) bs
259+ bs'' = unsafeTake n bs
260+ rev = B.map (reverseBits 8)
261+ in case (o,bo) of
262+ (0,BB) -> bs''
263+ (0,LL) -> B.reverse bs''
264+ (0,LB) -> rev bs''
265+ (0,BL) -> rev . B.reverse $ bs''
266+ (_,LL) -> readByteString n (S (B.reverse bs') (8-o) BB)
267+ (_,BL) -> rev . B.reverse $ readByteString n (S bs' o BB)
268+ (_,LB) -> rev . B.reverse $ readByteString n (S bs' o LL)
269+ (_,BB) -> unsafePerformIO $ do
270+ let len = n+1
271+ ptr <- mallocBytes len
272+ let f r i = do
273+ let
274+ w = unsafeIndex bs (len-i)
275+ w' = (w `fastShiftL` o) .|. r
276+ r' = w `fastShiftR` (8-o)
277+ poke (ptr `plusPtr` (len-i)) w'
278+ return r'
279+ foldM_ f 0 [1..len]
280+ unsafeInit <$> unsafePackMallocCStringLen (ptr,len)
295281
296− | n <= 64 = let segs = byte_offset n
297− o' = bit_offset (n - 8 + o)
298−
299− bn 0 = fromIntegral (unsafeHead bs)
300− bn n = (bn (n-1) `shifterL` 8) .|. fromIntegral (unsafeIndex bs n)
301−
302− msegs = bn (segs-1) `shifterL` o'
303−
304− last = (fromIntegral (unsafeIndex bs segs)) `shifterR` (8 - o')
305−
306− w = msegs .|. last
307− in w
308−
309−readWithOffset :: (Bits a, Num a)
310− => S -> (a -> Int -> a) -> (a -> Int -> a) -> Int -> a
311−readWithOffset (S bs o) shifterL shifterR n
312− | n <= 64 = let bits_in_msb = 8 - o
313− (n',top) = (n - bits_in_msb
314− , (fromIntegral (unsafeHead bs) .&. make_mask bits_in_msb) `shifterL` n')
315−
316− segs = byte_offset n'
317−
318− bn 0 = 0
319− bn n = (bn (n-1) `shifterL` 8) .|. fromIntegral (unsafeIndex bs n)
320−
321− o' = bit_offset n'
322−
323− mseg = bn segs `shifterL` o'
324−
325− last | o' > 0 = (fromIntegral (unsafeIndex bs (segs + 1))) `shifterR` (8 - o')
326− | otherwise = 0
327−
328− w = top .|. mseg .|. last
329− in w
330282
331283------------------------------------------------------------------------
332284-- | 'BitGet' is a monad, applicative and a functor. See 'runBitGet'
@@ -335,7 +287,6 @@ newtype BitGet a = B { runState :: S -> Get (S,a) }
335287
336288instance Monad BitGet where
337289 return x = B $ \s -> return (s,x)
338− fail str = B $ \_s -> fail str
339290 (B f) >>= g = B $ \s -> do (s',a) <- f s
340291 runState (g a) s'
341292
@@ -346,123 +297,200 @@ instance Applicative BitGet where
346297 pure x = return x
347298 fm <*> m = fm >>= \f -> m >>= \v -> return (f v)
348299
300+instance BitOrderable BitGet where
301+ setBitOrder bo = do
302+ (S bs o _) <- getState
303+ putState (S bs o bo)
304+
305+ getBitOrder = do
306+ (S _ _ bo) <- getState
307+ return bo
308+
309+instance Alignable BitGet where
310+ -- | Skip the given number of bits
311+ skipBits n = do
312+ ensureBits n
313+ withState (incS n)
314+
315+ -- | Skip bits if necessary to align to the next byte
316+ alignByte = do
317+ (S _ o _) <- getState
318+ when (o /= 0) $
319+ skipBits (8-o)
320+
321+
322+
349323-- | Run a 'BitGet' within the Binary packages 'Get' monad. If a byte has
350324-- been partially consumed it will be discarded once 'runBitGet' is finished.
351325runBitGet :: BitGet a -> Get a
352326runBitGet bg = do
353− (_,a) <- runState bg (S B.empty 0)
327+ s <- mkInitState
328+ (s',a) <- runState bg s
329+ putBackState s'
354330 return a
355331
332+mkInitState :: Get S
333+mkInitState = do
334+ bs <- get
335+ put B.empty
336+ return (S bs 0 BB)
337+
338+putBackState :: S -> Get ()
339+putBackState (S bs o _) = do
340+ remaining <- get
341+ let bs' = case o of
342+ 0 -> bs
343+ _ -> unsafeDrop 1 bs
344+ put (bs' `B.append` remaining)
345+
356346getState :: BitGet S
357347getState = B $ \s -> return (s,s)
358348
359349putState :: S -> BitGet ()
360350putState s = B $ \_ -> return (s,())
361351
362−modifyState :: (S -> (S,a)) -> BitGet a
363−modifyState f = B $ \s -> return (f s)
352+withState :: (S -> S) -> BitGet ()
353+withState f = do
354+ s <- getState
355+ putState $! f s
364356
365357-- | Make sure there are at least @n@ bits.
366358ensureBits :: Int -> BitGet ()
367359ensureBits n = do
368− (S bs o) <- getState
360+ (S bs o bo) <- getState
369361 if n <= (B.length bs * 8 - o)
370362 then return ()
371363 else do let currentBits = B.length bs * 8 - o
372− let byteCount = (n - currentBits + 7) `div` 8
373− B $ \_ -> do bs' <- B.getByteString byteCount
374− return (S (bs`append`bs') o, ())
364+ let byteCount = byte_offset (n - currentBits + 7)
365+ B $ \_ -> do B.ensureN byteCount
366+ bs' <- B.get
367+ put B.empty
368+ return (S (bs`append`bs') o bo, ())
369+
370+-- | Test whether all input has been consumed, i.e. there are no remaining
371+-- undecoded bytes.
372+isEmpty :: BitGet Bool
373+isEmpty = B $ \ (S bs o bo) -> if B.null bs
374+ then B.isEmpty >>= \e -> return (S bs o bo, e)
375+ else return (S bs o bo, False)
375376
376377-- | Get 1 bit as a 'Bool'.
377378getBool :: BitGet Bool
378379getBool = block bool
379380
381+-- | Get 1 bit as a 'Bool'.
382+getBool# :: BitGet Int
383+getBool# = block bool#
384+
380385-- | Get @n@ bits as a 'Word8'. @n@ must be within @[0..8]@.
381386getWord8 :: Int -> BitGet Word8
382387getWord8 n = block (word8 n)
383388
384389-- | Get @n@ bits as a 'Word16'. @n@ must be within @[0..16]@.
390+getWord16 :: Int -> BitGet Word16
391+getWord16 n = block (word16 n)
392+
385393getWord16be :: Int -> BitGet Word16
386−getWord16be n = block (word16be n)
394+getWord16be = getWord16
395+{-# DEPRECATED getWord16be "Use 'getWord16' instead" #-}
387396
388397-- | Get @n@ bits as a 'Word32'. @n@ must be within @[0..32]@.
398+getWord32 :: Int -> BitGet Word32
399+getWord32 n = block (word32 n)
400+
389401getWord32be :: Int -> BitGet Word32
390−getWord32be n = block (word32be n)
402+getWord32be = getWord32
403+{-# DEPRECATED getWord32be "Use 'getWord32' instead" #-}
391404
392405-- | Get @n@ bits as a 'Word64'. @n@ must be within @[0..64]@.
406+getWord64 :: Int -> BitGet Word64
407+getWord64 n = block (word64 n)
408+
393409getWord64be :: Int -> BitGet Word64
394−getWord64be n = block (word64be n)
410+getWord64be = getWord64
411+{-# DEPRECATED getWord64be "Use 'getWord64' instead" #-}
395412
396413-- | Get @n@ bytes as a 'ByteString'.
397414getByteString :: Int -> BitGet ByteString
398415getByteString n = block (byteString n)
399416
417+-- | Get @n@ bytes as a lazy ByteString.
418+getLazyByteString :: Int -> BitGet L.ByteString
419+getLazyByteString n = do
420+ (S _ o bo) <- getState
421+ case o of
422+ 0 -> B $ \s -> do
423+ putBackState s
424+ lbs <- B.getLazyByteString (fromIntegral n)
425+ return (S B.empty 0 bo, lbs)
426+ _ -> L.fromChunks . (:[]) <$> Data.Binary.Bits.Get.getByteString n
427+
428+
429+
430+
431+
432+-- | A block that will be read with only one boundary check. Needs to know the
433+-- number of bits in advance.
434+data Block a = Block Int (S -> a)
435+
436+instance Functor Block where
437+ fmap f (Block i p) = Block i (\s -> f (p s))
438+
439+instance Applicative Block where
440+ pure a = Block 0 (\_ -> a)
441+ (Block i p) <*> (Block j q) = Block (i+j) (\s -> p s $ q (incS i s))
442+ (Block i _) *> (Block j q) = Block (i+j) (q . incS i)
443+ (Block i p) <* (Block j _) = Block (i+j) p
444+
445+-- | Get a block. Will be read with one single boundry check, and
446+-- therefore requires a statically known number of bits.
447+-- Build blocks using 'bool', 'word8', 'word16be', 'word32be', 'word64be',
448+-- 'byteString' and 'Applicative'.
449+block :: Block a -> BitGet a
450+block (Block i p) = do
451+ ensureBits i
452+ s <- getState
453+ putState $! (incS i s)
454+ return $! p s
455+
400456-- | Read a 1 bit 'Bool'.
401457bool :: Block Bool
402458bool = Block 1 readBool
403459
460+-- | Read a 1 bit 'Bool'.
461+bool# :: Block Int
462+bool# = Block 1 readBool#
463+
404464-- | Read @n@ bits as a 'Word8'. @n@ must be within @[0..8]@.
405465word8 :: Int -> Block Word8
406−word8 n = Block n (readWord8 n)
466+word8 n = Block n (readWordChecked 8 n)
407467
408468-- | Read @n@ bits as a 'Word16'. @n@ must be within @[0..16]@.
469+word16 :: Int -> Block Word16
470+word16 n = Block n (readWordChecked 16 n)
471+
409472word16be :: Int -> Block Word16
410−word16be n = Block n (readWord16be n)
473+word16be = word16
474+{-# DEPRECATED word16be "Use 'word16' instead" #-}
411475
412476-- | Read @n@ bits as a 'Word32'. @n@ must be within @[0..32]@.
477+word32 :: Int -> Block Word32
478+word32 n = Block n (readWordChecked 32 n)
479+
413480word32be :: Int -> Block Word32
414−word32be n = Block n (readWord32be n)
481+word32be = word32
482+{-# DEPRECATED word32be "Use 'word32' instead" #-}
415483
416484-- | Read @n@ bits as a 'Word64'. @n@ must be within @[0..64]@.
485+word64 :: Int -> Block Word64
486+word64 n = Block n (readWordChecked 64 n)
487+
417488word64be :: Int -> Block Word64
418−word64be n = Block n (readWord64be n)
489+word64be = word64
490+{-# DEPRECATED word64be "Use 'word64' instead" #-}
419491
420492-- | Read @n@ bytes as a 'ByteString'.
421493byteString :: Int -> Block ByteString
422−byteString n = Block (n*8) (readByteString n)
494+byteString n | n > 0 = Block (n*8) (readByteString n)
495+ | otherwise = Block 0 (\_ -> B.empty)
423496
424−------------------------------------------------------------------------
425−-- Unchecked shifts, from the package binary
426−
427−shiftl_w16 :: Word16 -> Int -> Word16
428−shiftl_w32 :: Word32 -> Int -> Word32
429−shiftl_w64 :: Word64 -> Int -> Word64
430−
431−#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)
432−shiftl_w8 (W8# w) (I# i) = W8# (w `uncheckedShiftL#` i)
433−shiftl_w16 (W16# w) (I# i) = W16# (w `uncheckedShiftL#` i)
434−shiftl_w32 (W32# w) (I# i) = W32# (w `uncheckedShiftL#` i)
435−
436−shiftr_w8 (W8# w) (I# i) = W8# (w `uncheckedShiftRL#` i)
437−shiftr_w16 (W16# w) (I# i) = W16# (w `uncheckedShiftRL#` i)
438−shiftr_w32 (W32# w) (I# i) = W32# (w `uncheckedShiftRL#` i)
439−
440−
441−#if WORD_SIZE_IN_BITS < 64
442−shiftl_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftL64#` i)
443−shiftr_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftRL64#` i)
444−
445−#if __GLASGOW_HASKELL__ <= 606
446−-- Exported by GHC.Word in GHC 6.8 and higher
447−foreign import ccall unsafe "stg_uncheckedShiftL64"
448− uncheckedShiftL64# :: Word64# -> Int# -> Word64#
449−foreign import ccall unsafe "stg_uncheckedShiftRL64"
450− uncheckedShiftRL64# :: Word64# -> Int# -> Word64#
451−#endif
452−
453−#else
454−shiftl_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftL#` i)
455−shiftr_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftRL#` i)
456−#endif
457−
458−#else
459−shiftl_w8 = shiftL
460−shiftl_w16 = shiftL
461−shiftl_w32 = shiftL
462−shiftl_w64 = shiftL
463−
464−shiftr_w8 = shiftR
465−shiftr_w16 = shiftR
466−shiftr_w32 = shiftR
467−shiftr_w64 = shiftR
468−#endif
Data/Binary/Bits/Internal.hsnew file+176
@@ -0,0 +1,176 @@
1+{-# LANGUAGE RankNTypes, MagicHash, BangPatterns, CPP #-}
2+
3+-----------------------------------------------------------------------------
4+-- |
5+-- Module : Data.Binary.Bits.Get
6+-- Copyright : (c) Lennart Kolmodin 2010-2011
7+-- License : BSD3-style (see LICENSE)
8+--
9+-- Maintainer : kolmodin@gmail.com
10+-- Stability : experimental
11+-- Portability : portable (should run where the package binary runs)
12+
13+module Data.Binary.Bits.Internal
14+ ( make_mask
15+ , make_mask#
16+ , mask
17+ , mask#
18+ , bit_offset
19+ , byte_offset
20+ , reverseBits
21+ , reverseBits#
22+ , FastBits(..)
23+ )
24+where
25+
26+import Data.Word
27+import Data.Bits
28+
29+#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)
30+import GHC.Base
31+import GHC.Word
32+#endif
33+
34+-- | make_mask 3 = 00000111
35+make_mask :: (Bits a, Num a) => Int -> a
36+make_mask n = (1 `shiftL` fromIntegral n) - 1
37+{-# SPECIALIZE make_mask :: Int -> Int #-}
38+{-# SPECIALIZE make_mask :: Int -> Word #-}
39+{-# SPECIALIZE make_mask :: Int -> Word8 #-}
40+{-# SPECIALIZE make_mask :: Int -> Word16 #-}
41+{-# SPECIALIZE make_mask :: Int -> Word32 #-}
42+{-# SPECIALIZE make_mask :: Int -> Word64 #-}
43+
44+make_mask# :: Int# -> Word#
45+make_mask# n = (1## `shiftL#` n) `minusWord#` 1##
46+
47+-- | Keep only the n least-significant bits of the given value
48+mask :: (Bits a, Num a) => Int -> a -> a
49+mask n v = v .&. make_mask n
50+{-# INLINE mask #-}
51+
52+-- | Keep only the n least-significant bits of the given value
53+mask# :: Int# -> Word# -> Word#
54+mask# n v = v `and#` make_mask# n
55+
56+-- | Compute bit offset (equivalent to x `mod` 8 but faster)
57+bit_offset :: Int -> Int
58+bit_offset n = make_mask 3 .&. n
59+{-# INLINE bit_offset #-}
60+
61+-- | Compute byte offset (equivalent to x `div` 8 but faster)
62+byte_offset :: Int -> Int
63+byte_offset n = n `shiftR` 3
64+{-# INLINE byte_offset #-}
65+
66+-- | Reverse the @n@ least important bits of the given value
67+reverseBits :: (Num a, FastBits a, Bits a) => Int -> a -> a
68+reverseBits n value = rec value n 0
69+ where
70+ -- rec v i r, where
71+ -- v is orginal value shifted
72+ -- i is the remaining number of bits
73+ -- r is current value
74+ rec 0 0 r = r
75+ rec 0 i r = r `fastShiftL` i
76+ rec v i r = rec (v `fastShiftR` 1) (i-1) ((r `fastShiftL` 1) .|. (v .&. 0x1))
77+
78+reverseBits# :: Int# -> Word# -> Word#
79+reverseBits# n value = rec value n 0##
80+ where
81+ -- rec v i r, where
82+ -- v is orginal value shifted
83+ -- i is the remaining number of bits
84+ -- r is current value
85+ rec 0## 0# r = r
86+ rec 0## i r = r `shiftL#` i
87+ rec v i r = rec (v `shiftRL#` 1#) (i -# 1#) ((r `shiftL#` 1#) `or#` (v `and#` 0x1##))
88+
89+
90+---------------------------------------------------------------------
91+-- Unchecked shifts, from the "binary" package
92+
93+-- | Class for types supporting fast bit shifting
94+class Bits a => FastBits a where
95+ fastShiftR :: a -> Int -> a
96+ fastShiftR = shiftR
97+
98+ fastShiftL :: a -> Int -> a
99+ fastShiftL = shiftL
100+
101+ {-# INLINE fastShift #-}
102+ fastShift :: a -> Int -> a
103+ fastShift x n
104+ | n > 0 = fastShiftL x n
105+ | n < 0 = fastShiftR x (negate n)
106+ | otherwise = x
107+
108+instance FastBits Word8 where
109+ fastShiftR = shiftr_w8
110+ fastShiftL = shiftl_w8
111+
112+instance FastBits Word16 where
113+ fastShiftR = shiftr_w16
114+ fastShiftL = shiftl_w16
115+
116+instance FastBits Word32 where
117+ fastShiftR = shiftr_w32
118+ fastShiftL = shiftl_w32
119+
120+instance FastBits Word64 where
121+ fastShiftR = shiftr_w64
122+ fastShiftL = shiftl_w64
123+
124+instance FastBits Int
125+
126+instance FastBits Word
127+
128+
129+shiftl_w8 :: Word8 -> Int -> Word8
130+shiftl_w16 :: Word16 -> Int -> Word16
131+shiftl_w32 :: Word32 -> Int -> Word32
132+shiftl_w64 :: Word64 -> Int -> Word64
133+
134+shiftr_w8 :: Word8 -> Int -> Word8
135+shiftr_w16 :: Word16 -> Int -> Word16
136+shiftr_w32 :: Word32 -> Int -> Word32
137+shiftr_w64 :: Word64 -> Int -> Word64
138+
139+#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)
140+shiftl_w8 w i = w `unsafeShiftL` i
141+shiftl_w16 w i = w `unsafeShiftL` i
142+shiftl_w32 w i = w `unsafeShiftL` i
143+
144+shiftr_w8 w i = w `unsafeShiftR` i
145+shiftr_w16 w i = w `unsafeShiftR` i
146+shiftr_w32 w i = w `unsafeShiftR` i
147+
148+
149+#if WORD_SIZE_IN_BITS < 64
150+shiftl_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftL64#` i)
151+shiftr_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftRL64#` i)
152+
153+#if __GLASGOW_HASKELL__ <= 606
154+-- Exported by GHC.Word in GHC 6.8 and higher
155+foreign import ccall unsafe "stg_uncheckedShiftL64"
156+ uncheckedShiftL64# :: Word64# -> Int# -> Word64#
157+foreign import ccall unsafe "stg_uncheckedShiftRL64"
158+ uncheckedShiftRL64# :: Word64# -> Int# -> Word64#
159+#endif
160+
161+#else
162+shiftl_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftL#` i)
163+shiftr_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftRL#` i)
164+#endif
165+
166+#else
167+shiftl_w8 = shiftL
168+shiftl_w16 = shiftL
169+shiftl_w32 = shiftL
170+shiftl_w64 = shiftL
171+
172+shiftr_w8 = shiftR
173+shiftr_w16 = shiftR
174+shiftr_w32 = shiftR
175+shiftr_w64 = shiftR
176+#endif
Data/Binary/Bits/Put.hs+200−65
@@ -1,7 +1,10 @@
1+{-# LANGUAGE MagicHash #-}
2+
13-----------------------------------------------------------------------------
24-- |
35-- Module : Data.Binary.Bits.Put
46-- Copyright : (c) Lennart Kolmodin 2010-2011
7+-- (c) Sylvain Henry 2015
58-- License : BSD3-style (see LICENSE)
69--
710-- Maintainer : kolmodin@gmail.com
@@ -19,9 +22,14 @@ module Data.Binary.Bits.Put
1922 -- * Data types
2023 -- ** Bool
2124 , putBool
25+ , putBool#
2226
2327 -- ** Words
28+ , putWord#
2429 , putWord8
30+ , putWord16
31+ , putWord32
32+ , putWord64
2533 , putWord16be
2634 , putWord32be
2735 , putWord64be
@@ -35,112 +43,222 @@ import qualified Data.Binary.Builder as B
3543import Data.Binary.Builder ( Builder )
3644import qualified Data.Binary.Put as Put
3745import Data.Binary.Put ( Put )
46+import Data.Binary.Bits.Internal
47+import Data.Binary.Bits.BitOrder
48+import Data.Binary.Bits.Alignment
3849
39−import Data.ByteString
50+import Data.ByteString as BS
51+import Data.ByteString.Unsafe as BS
4052
53+import Control.Monad (when)
4154import Data.Bits
42−import Data.Monoid
4355import Data.Word
56+import GHC.Base (Word#, shiftRL#, Int (..), Int#, (-#), (<#), isTrue#, (+#), shiftL#, wordToWord8#, orWord8#)
57+import GHC.Word (Word8(..))
4458
4559data BitPut a = BitPut { run :: (S -> PairS a) }
4660
4761data PairS a = PairS a {-# UNPACK #-} !S
4862
49−data S = S !Builder !Word8 !Int
63+data S = S !Builder !Word8 !Int !BitOrder
5064
5165-- | Put a 1 bit 'Bool'.
5266putBool :: Bool -> BitPut ()
53−putBool b = putWord8 1 (if b then 1 else 0)
67+putBool b = putWord8 1 (if b then 0xff else 0x00)
68+
69+-- | Put a 1 bit 'Bool'.
70+putBool# :: Word# -> BitPut ()
71+putBool# b = putWord# 1# b
72+
73+
74+-- | Generic putWord
75+putWord :: (Num a, FastBits a, Integral a) => Int -> a -> BitPut ()
76+putWord n w = BitPut $ \s -> PairS () (putWordS n w s)
77+
78+putWord# :: Int# -> Word# -> BitPut ()
79+putWord# n w = BitPut $ \s -> PairS () (putWordS# n w s)
80+
81+putWordS :: (Num a, FastBits a, Integral a) => Int -> a -> S -> S
82+putWordS n w s@(S builder b o bo) = s'
83+ where
84+ -- number of bits that will be stored in the current byte
85+ cn = min (8-o) n
86+
87+ -- new state
88+ s' = case n of
89+ 0 -> s
90+ _ -> putWordS (n-cn) w' (flush (S builder b' (o+cn) bo))
91+
92+ -- new current byte
93+ b' = shl (selectBits w) .|. b
94+
95+ -- Word containing the remaining (n-cn) bits to store in its LSB
96+ w' = case bo of
97+ BB -> w
98+ BL -> w `fastShiftR` cn
99+ LL -> w `fastShiftR` cn
100+ LB -> w
101+
102+ -- Select bits to store in the current byte.
103+ -- Put them in the correct order and return them in the least-significant
104+ -- bits of the returned value
105+ selectBits :: (Num a, FastBits a, Integral a) => a -> Word8
106+ selectBits x = fromIntegral $ case bo of
107+ BB -> mask cn $ x `fastShiftR` (n-cn)
108+ LB -> reverseBits cn $ mask cn $ x `fastShiftR` (n-cn)
109+ LL -> mask cn x
110+ BL -> reverseBits cn $ mask cn x
111+
112+ -- shift left at the correct position
113+ shl :: Word8 -> Word8
114+ shl x = case bo of
115+ BB -> x `fastShiftL` (8-o-cn)
116+ BL -> x `fastShiftL` (8-o-cn)
117+ LL -> x `fastShiftL` o
118+ LB -> x `fastShiftL` o
119+
120+ flush s2@(S b2 w2 o2 bo2)
121+ | o2 == 8 = S (b2 `mappend` B.singleton w2) 0 0 bo2
122+ | otherwise = s2
123+
124+putWordS# :: Int# -> Word# -> S -> S
125+putWordS# n w s@(S builder (W8# b) (I# o) bo) = s'
126+ where
127+ min# :: Int# -> Int# -> Int#
128+ min# x y | isTrue# (x <# y) = x
129+ min# _ y = y
130+
131+ -- number of bits that will be stored in the current byte
132+ cn = min# (8# -# o) n
133+
134+ -- new state
135+ s' = case n of
136+ 0# -> s
137+ _ -> putWordS# (n -# cn) w' (flush (S builder (W8# b') (I# (o +# cn)) bo))
138+
139+ -- new current byte
140+ b' = wordToWord8# (shl (selectBits w)) `orWord8#` b
141+
142+ -- Word containing the remaining (n-cn) bits to store in its LSB
143+ w' = case bo of
144+ BB -> w
145+ BL -> w `shiftRL#` cn
146+ LL -> w `shiftRL#` cn
147+ LB -> w
148+
149+ -- Select bits to store in the current byte.
150+ -- Put them in the correct order and return them in the least-significant
151+ -- bits of the returned value
152+ selectBits :: Word# -> Word#
153+ selectBits x = case bo of
154+ BB -> mask# cn (x `shiftRL#` (n -# cn))
155+ LB -> reverseBits# cn (mask# cn (x `shiftRL#` (n -# cn)))
156+ LL -> mask# cn x
157+ BL -> reverseBits# cn (mask# cn x)
158+
159+ -- shift left at the correct position
160+ shl :: Word# -> Word#
161+ shl x = case bo of
162+ BB -> x `shiftL#` (8# -# o -# cn)
163+ BL -> x `shiftL#` (8# -# o -# cn)
164+ LL -> x `shiftL#` o
165+ LB -> x `shiftL#` o
166+
167+ flush s2@(S b2 w2 o2 bo2)
168+ | o2 == 8 = S (b2 `mappend` B.singleton w2) 0 0 bo2
169+ | otherwise = s2
170+
54171
55172-- | Put the @n@ lower bits of a 'Word8'.
56173putWord8 :: Int -> Word8 -> BitPut ()
57−putWord8 n w = BitPut $ \s -> PairS () $
58− case s of
59− -- a whole word8, no offset
60− (S b t o) | n == 8 && o == 0 -> flush $ S b w n
61− -- less than a word8, will fit in the current word8
62− | n <= 8 - o -> flush $ S b (t .|. (w `shiftL` (8 - n - o))) (o+n)
63− -- will finish this word8, and spill into the next one
64− | otherwise -> flush $
65− let o' = o + n - 8
66− w' = t .|. (w `shiftR` o')
67− t' = w `shiftL` (8 - o')
68− in S (b `mappend` B.singleton w') t' o'
174+putWord8 = putWord
69175
70176-- | Put the @n@ lower bits of a 'Word16'.
177+putWord16 :: Int -> Word16 -> BitPut ()
178+putWord16 = putWord
179+
71180putWord16be :: Int -> Word16 -> BitPut ()
72−putWord16be n w
73− | n <= 8 = putWord8 n (fromIntegral w)
74− | otherwise =
75− BitPut $ \s -> PairS () $
76− case s of
77− -- as n>=9, it's too big to fit into one single byte
78− -- it'll either use 2 or 3 bytes
79− -- it'll fit in 2 bytes
80− (S b t o) | o + n <= 16 -> flush $
81− let o' = o + n - 8
82− w' = t .|. fromIntegral (w `shiftR` o')
83− t' = fromIntegral (w `shiftL` (8-o'))
84− in (S (b `mappend` B.singleton w') t' o')
85− -- 3 bytes required
86− | otherwise -> flush $
87− let o' = o + n - 16
88− w' = t .|. fromIntegral (w `shiftR` (o' + 8))
89− w'' = fromIntegral ((w `shiftR` o') .&. 0xff)
90− t' = fromIntegral (w `shiftL` (8-o'))
91− in (S (b `mappend` B.singleton w' `mappend` B.singleton w'') t' o')
181+putWord16be = putWord
182+{-# DEPRECATED putWord16be "Use 'putWord16' instead" #-}
92183
93184-- | Put the @n@ lower bits of a 'Word32'.
185+putWord32 :: Int -> Word32 -> BitPut ()
186+putWord32 = putWord
187+
94188putWord32be :: Int -> Word32 -> BitPut ()
95−putWord32be n w
96− | n <= 16 = putWord16be n (fromIntegral w)
97− | otherwise = do
98− putWord32be (n-16) (w`shiftR`16)
99− putWord32be 16 (w .&. 0x0000ffff)
189+putWord32be = putWord
190+{-# DEPRECATED putWord32be "Use 'putWord32' instead" #-}
100191
101192-- | Put the @n@ lower bits of a 'Word64'.
193+putWord64 :: Int -> Word64 -> BitPut ()
194+putWord64 = putWord
195+
102196putWord64be :: Int -> Word64 -> BitPut ()
103−putWord64be n w
104− | n <= 32 = putWord32be n (fromIntegral w)
105− | otherwise = do
106− putWord64be (n-32) (w`shiftR`32)
107− putWord64be 32 (w .&. 0xffffffff)
197+putWord64be = putWord
198+{-# DEPRECATED putWord64be "Use 'putWord64' instead" #-}
108199
109200-- | Put a 'ByteString'.
201+--
202+-- Examples: 3 bits are already written in the current byte
203+-- BB: ABCDEFGH IJKLMNOP -> xxxABCDE FGHIJKLM NOPxxxxx
204+-- LL: ABCDEFGH IJKLMNOP -> LMNOPxxx DEFGHIJK xxxxxABC
205+-- BL: ABCDEFGH IJKLMNOP -> xxxPONML KJIHGFED CBAxxxxx
206+-- LB: ABCDEFGH IJKLMNOP -> EDCBAxxx MLKJIHGF xxxxxPON
110207putByteString :: ByteString -> BitPut ()
111−putByteString bs = do
112− offset <- hasOffset
113− if offset
114− then mapM_ (putWord8 8) (unpack bs) -- naive
115− else joinPut (Put.putByteString bs)
116− where
117− hasOffset = BitPut $ \ s@(S _ _ o) -> PairS (o /= 0) s
208+putByteString bs = BitPut $ \s -> PairS () (putByteStringS bs s)
209+
210+putByteStringS :: ByteString -> S -> S
211+putByteStringS bs s
212+ | BS.null bs = s
213+ | otherwise = case s of
214+ (S builder b 0 BB) -> S (builder `mappend` B.fromByteString bs) b 0 BB
215+ (S builder b 0 LL) -> S (builder `mappend` B.fromByteString (BS.reverse bs)) b 0 LL
216+ (S builder b 0 LB) -> S (builder `mappend` B.fromByteString (rev bs)) b 0 LB
217+ (S builder b 0 BL) -> S (builder `mappend` B.fromByteString (rev (BS.reverse bs))) b 0 BL
218+ (S _ _ _ BB) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)
219+ (S _ _ _ LL) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)
220+ (S _ _ _ BL) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)
221+ (S _ _ _ LB) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)
222+ where
223+ rev = BS.map (reverseBits 8)
224+
118225
119226-- | Run a 'Put' inside 'BitPut'. Any partially written bytes will be flushed
120227-- before 'Put' executes to ensure byte alignment.
228+--
229+-- Warning: this method does not take bit order into account (i.e. BB assumed)
121230joinPut :: Put -> BitPut ()
122231joinPut m = BitPut $ \s0 -> PairS () $
123− let (S b0 _ _) = flushIncomplete s0
232+ let (S b0 _ _ bo) = flushIncomplete s0
124233 b = Put.execPut m
125− in (S (b0`mappend`b) 0 0)
126−
127−flush :: S -> S
128−flush s@(S b w o)
129− | o > 8 = error "flush: offset > 8"
130− | o == 8 = S (b `mappend` B.singleton w) 0 0
131− | otherwise = s
234+ in (S (b0`mappend`b) 0 0 bo)
132235
133236flushIncomplete :: S -> S
134−flushIncomplete s@(S b w o)
237+flushIncomplete s@(S b w o bo)
135238 | o == 0 = s
136− | otherwise = (S (b `mappend` B.singleton w) 0 0)
239+ | otherwise = (S (b `mappend` B.singleton w) 0 0 bo)
240+
241+getOffset :: BitPut Int
242+getOffset = BitPut $ \s@(S _ _ o _) -> PairS o s
137243
138244-- | Run the 'BitPut' monad inside 'Put'.
139245runBitPut :: BitPut () -> Put.Put
140246runBitPut m = Put.putBuilder b
141247 where
142− PairS _ s = run m (S mempty 0 0)
143− (S b _ _) = flushIncomplete s
248+ PairS _ s = run m (S mempty 0 0 BB)
249+ (S b _ _ _) = flushIncomplete s
250+
251+instance Functor BitPut where
252+ fmap f (BitPut k) = BitPut $ \s ->
253+ let PairS x s' = k s
254+ in PairS (f x) s'
255+
256+instance Applicative BitPut where
257+ pure a = BitPut (\s -> PairS a s)
258+ (BitPut f) <*> (BitPut g) = BitPut $ \s ->
259+ let PairS a s' = f s
260+ PairS b s'' = g s'
261+ in PairS (a b) s''
144262
145263instance Monad BitPut where
146264 m >>= k = BitPut $ \s ->
@@ -148,3 +266,20 @@ instance Monad BitPut where
148266 PairS b s'' = run (k a) s'
149267 in PairS b s''
150268 return x = BitPut $ \s -> PairS x s
269+
270+instance BitOrderable BitPut where
271+ setBitOrder bo = BitPut $ \(S bu b o _) -> PairS () (S bu b o bo)
272+
273+ getBitOrder = BitPut $ \s@(S _ _ _ bo) -> PairS bo s
274+
275+instance Alignable BitPut where
276+ -- | Skip the given number of bits
277+ skipBits n
278+ | n <= 64 = putWord64 n 0
279+ | otherwise = putWord64 64 0 >> skipBits (n-64)
280+
281+ -- | Skip bits if necessary to align to the next byte
282+ alignByte = do
283+ o <- getOffset
284+ when (o /= 0) $
285+ skipBits (8-o)
binary-bits.cabal+10−6
@@ -1,6 +1,6 @@
11-- http://www.haskell.org/cabal/release/cabal-latest/doc/users-guide/
22name: binary-bits
3−version: 0.1
3+version: 0.6
44synopsis: Bit parsing/writing on top of binary.
55description: Bit parsing/writing on top of binary. Provides functions to
66 read and write bits to and from 8\/16\/32\/64 words.
@@ -14,17 +14,20 @@ build-type: Simple
1414cabal-version: >=1.10
1515
1616source-repository head
17− type: darcs
18− location: http://code.haskell.org/binary-bits
17+ type: git
18+ location: git://github.com/kolmodin/binary-bits.git
1919
2020library
21− build-depends: base==4.*, binary, bytestring
21+ build-depends: base==4.*, binary >= 0.6.0.0, bytestring
2222
2323 other-extensions: RankNTypes, MagicHash, BangPatterns, CPP
2424
2525 exposed-modules: Data.Binary.Bits ,
2626 Data.Binary.Bits.Put ,
27− Data.Binary.Bits.Get
27+ Data.Binary.Bits.Get ,
28+ Data.Binary.Bits.BitOrder ,
29+ Data.Binary.Bits.Alignment
30+ other-modules: Data.Binary.Bits.Internal
2831
2932 default-language: Haskell98
3033
@@ -34,8 +37,9 @@ test-suite qc
3437 type: exitcode-stdio-1.0
3538 main-is: BitsQC.hs
3639 default-language: Haskell98
40+ --ghc-options: -O2 -Wall
3741
38− build-depends: base==4.*, binary, bytestring,
42+ build-depends: base==4.*, binary >= 0.6.0.0, bytestring,
3943 QuickCheck>=2, random,
4044 test-framework,
4145 test-framework-quickcheck2
flake.locknew file+59
@@ -0,0 +1,59 @@
1+{
2+ "nodes": {
3+ "flake-utils": {
4+ "inputs": {
5+ "systems": "systems"
6+ },
7+ "locked": {
8+ "lastModified": 1731533236,
9+ "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
10+ "owner": "numtide",
11+ "repo": "flake-utils",
12+ "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
13+ "type": "github"
14+ },
15+ "original": {
16+ "id": "flake-utils",
17+ "type": "indirect"
18+ }
19+ },
20+ "nixpkgs": {
21+ "locked": {
22+ "lastModified": 1737469691,
23+ "narHash": "sha256-nmKOgAU48S41dTPIXAq0AHZSehWUn6ZPrUKijHAMmIk=",
24+ "owner": "NixOS",
25+ "repo": "nixpkgs",
26+ "rev": "9e4d5190a9482a1fb9d18adf0bdb83c6e506eaab",
27+ "type": "github"
28+ },
29+ "original": {
30+ "id": "nixpkgs",
31+ "ref": "nixos-unstable",
32+ "type": "indirect"
33+ }
34+ },
35+ "root": {
36+ "inputs": {
37+ "flake-utils": "flake-utils",
38+ "nixpkgs": "nixpkgs"
39+ }
40+ },
41+ "systems": {
42+ "locked": {
43+ "lastModified": 1681028828,
44+ "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
45+ "owner": "nix-systems",
46+ "repo": "default",
47+ "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
48+ "type": "github"
49+ },
50+ "original": {
51+ "owner": "nix-systems",
52+ "repo": "default",
53+ "type": "github"
54+ }
55+ }
56+ },
57+ "root": "root",
58+ "version": 7
59+}
flake.nixnew file+24
@@ -0,0 +1,24 @@
1+{
2+ inputs = {
3+ nixpkgs.url = "nixpkgs/nixos-unstable";
4+ flake-utils.url = "flake-utils";
5+ };
6+
7+ outputs = { self, flake-utils, nixpkgs }:
8+ let
9+ supportedSystems =
10+ [ "x86_64-linux" "x86_64-darwin" "aarch64-darwin" "aarch64-linux" ];
11+ compilerVersion = "966";
12+ in flake-utils.lib.eachSystem supportedSystems (system:
13+ let pkgs = import nixpkgs { inherit system; };
14+ in {
15+ devShells.default = pkgs.mkShell {
16+ buildInputs = with pkgs; [
17+ haskell.compiler."ghc${compilerVersion}"
18+ (pkgs.haskell-language-server.override {
19+ supportedGhcVersions = [ compilerVersion ];
20+ })
21+ ];
22+ };
23+ });
24+}
stack.yamlnew file+66
@@ -0,0 +1,66 @@
1+# This file was automatically generated by 'stack init'
2+#
3+# Some commonly used options have been documented as comments in this file.
4+# For advanced use and comprehensive documentation of the format, please see:
5+# https://docs.haskellstack.org/en/stable/yaml_configuration/
6+
7+# Resolver to choose a 'specific' stackage snapshot or a compiler version.
8+# A snapshot resolver dictates the compiler version and the set of packages
9+# to be used for project dependencies. For example:
10+#
11+# resolver: lts-3.5
12+# resolver: nightly-2015-09-21
13+# resolver: ghc-7.10.2
14+#
15+# The location of a snapshot can be provided as a file or url. Stack assumes
16+# a snapshot provided as a file might change, whereas a url resource does not.
17+#
18+# resolver: ./custom-snapshot.yaml
19+# resolver: https://example.com/snapshots/2018-01-01.yaml
20+resolver: lts-22.43
21+
22+# User packages to be built.
23+# Various formats can be used as shown in the example below.
24+#
25+# packages:
26+# - some-directory
27+# - https://example.com/foo/bar/baz-0.0.2.tar.gz
28+# subdirs:
29+# - auto-update
30+# - wai
31+packages:
32+- .
33+# Dependency packages to be pulled from upstream that are not in the resolver.
34+# These entries can reference officially published versions as well as
35+# forks / in-progress versions pinned to a git hash. For example:
36+#
37+# extra-deps:
38+# - acme-missiles-0.3
39+# - git: https://github.com/commercialhaskell/stack.git
40+# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
41+#
42+# extra-deps: []
43+
44+# Override default flag values for local packages and extra-deps
45+# flags: {}
46+
47+# Extra package databases containing global packages
48+# extra-package-dbs: []
49+
50+# Control whether we use the GHC we find on the path
51+# system-ghc: true
52+#
53+# Require a specific version of stack, using version ranges
54+# require-stack-version: -any # Default
55+# require-stack-version: ">=2.9"
56+#
57+# Override the architecture used by stack, especially useful on Windows
58+# arch: i386
59+# arch: x86_64
60+#
61+# Extra directories used by stack for building
62+# extra-include-dirs: [/path/to/dir]
63+# extra-lib-dirs: [/path/to/dir]
64+#
65+# Allow a newer minor version of GHC than the snapshot specifies
66+# compiler-check: newer-minor
stack.yaml.locknew file+12
@@ -0,0 +1,12 @@
1+# This file was autogenerated by Stack.
2+# You should not edit this file by hand.
3+# For more information, please see the documentation at:
4+# https://docs.haskellstack.org/en/stable/lock_files
5+
6+packages: []
7+snapshots:
8+- completed:
9+ sha256: 08bd13ce621b41a8f5e51456b38d5b46d7783ce114a50ab604d6bbab0d002146
10+ size: 720271
11+ url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/22/43.yaml
12+ original: lts-22.43