0e68a2b..master · binary-bits

git.iko.soy/binary-bits

13 files changed+814−321

unifiedsplit

.gitignore+1 BitsQC.hs+74−41 Data/Binary/Bits.hs+6−6 Data/Binary/Bits/Alignment.hs+22 Data/Binary/Bits/BitOrder.hs+47 Data/Binary/Bits/Get.hs+135−196 Data/Binary/Bits/Internal.hs+176 Data/Binary/Bits/Put.hs+186−76 binary-bits.cabal+6−2 flake.lock+59 flake.nix+24 stack.yaml+66 stack.yaml.lock+12

.gitignore+1

@@ -1,3 +1,4 @@

11.cabal-sandbox

22cabal.sandbox.config

33dist/

4+.stack-work

BitsQC.hs+74−41

@@ -9,6 +9,7 @@ import Data.Binary.Put ( runPut )

99import Data.Binary.Bits

1010import Data.Binary.Bits.Get

1111import Data.Binary.Bits.Put

12+import Data.Binary.Bits.BitOrder

1213

1314import qualified Data.ByteString as B

1415import qualified Data.ByteString.Lazy as L

@@ -17,7 +18,8 @@ import Control.Applicative

1718import Data.Bits

1819import Data.Word

1920import Foreign.Storable

20−import System.Random

21+import Data.Traversable (traverse)

22+import Data.Foldable (traverse_)

2123

2224import Test.Framework.Providers.QuickCheck2 ( testProperty )

2325import Test.Framework.Runners.Console ( defaultMain )

@@ -36,7 +38,10 @@ tests =

3638 [ testProperty "prop_composite_case" prop_composite_case ]

3739

3840 , testGroup "getByteString"

39− [ testProperty "prop_getByteString_negative" prop_getByteString_negative ]

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+ ]

4045

4146 , testGroup "getLazyByteString"

4247 [ testProperty "getLazyByteString == getByteString"

@@ -84,10 +89,10 @@ tests =

8489 ]

8590

8691 , testGroup "prop_put_with_bitreq"

87− [ testProperty "Word8" (prop_putget_with_bitreq :: W Word8 -> Property)

88− , testProperty "Word16" (prop_putget_with_bitreq :: W Word16 -> Property)

89− , testProperty "Word32" (prop_putget_with_bitreq :: W Word32 -> Property)

90− , 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)

9196 ]

9297

9398 , testGroup "prop_putget_list_simple"

@@ -112,10 +117,10 @@ tests =

112117 , testProperty "Word64" (prop_putget_list_with_bitreq :: W [Word64] -> Property)

113118 ]

114119 , testGroup "prop_bitget_bytestring_interspersed"

115− [ testProperty "Word8" (prop_bitget_bytestring_interspersed :: W Word8 -> [B.ByteString] -> Property)

116− , testProperty "Word16" (prop_bitget_bytestring_interspersed :: W Word16 -> [B.ByteString] -> Property)

117− , testProperty "Word32" (prop_bitget_bytestring_interspersed :: W Word32 -> [B.ByteString] -> Property)

118− , 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)

119124 ]

120125 , testGroup "Simulate programs"

121126 [ testProperty "primitive" prop_primitive

@@ -158,13 +163,28 @@ prop_getByteString_negative n =

158163 n < 1 ==>

159164 runGet (runBitGet (getByteString n)) L.empty == B.empty

160165

161−prop_putget_with_bitreq :: (BinaryBit a, Num a, Bits a, Ord a) => W a -> Property

162−prop_putget_with_bitreq (W w) = property $

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 $

163183 -- write all words with as many bits as it's required

164184 let p = putBits (bitreq w) w

165185 g = getBits (bitreq w)

166− lbs = runPut (runBitPut p)

167− w' = runGet (runBitGet g) lbs

186+ lbs = runPut (runBitPut (withBitOrder bo p))

187+ w' = runGet (runBitGet (withBitOrder bo g)) lbs

168188 in w == w'

169189

170190-- | Write a list of items. Each item is written with the maximum amount of

@@ -226,12 +246,12 @@ prop_bitget_with_put_from_binary (W ws) = property $

226246 in ws == ws'

227247

228248-- | Write each 'ByteString' with a variable sized value as a separator.

229−prop_bitget_bytestring_interspersed :: (BinaryBit a, Binary a, Num a, Ord a, Bits a) => W a -> [B.ByteString] -> Property

230−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 $

231251 let p = mapM_ (\bs -> putBits (bitreq ws) ws >> putByteString bs) bss

232252 g = mapM (\bs -> (,) <$> getBits (bitreq ws) <*> getByteString (B.length bs)) bss

233− lbs = runPut (runBitPut p)

234− r = runGet (runBitGet g) lbs

253+ lbs = runPut (runBitPut (withBitOrder bo p))

254+ r = runGet (runBitGet (withBitOrder bo g)) lbs

235255 in map (ws,) bss == r

236256

237257-- | Test failing.

@@ -241,8 +261,8 @@ prop_fail lbs errMsg0 = forAll (choose (0, 8 * L.length lbs)) $ \len ->

241261 expectedBytesConsumed

242262 | bits == 0 = bytes

243263 | otherwise = bytes + 1

244− p = do getByteString (fromIntegral bytes)

245− getBits (fromIntegral bits) :: BitGet Word8

264+ p = do _ <- getByteString (fromIntegral bytes)

265+ _ <- getBits (fromIntegral bits) :: BitGet Word8

246266 fail errMsg0

247267 r = runGetIncremental (runBitGet p) `pushChunks` lbs

248268 in case r of

@@ -268,10 +288,10 @@ prop_bitreq (W w) = property $

268288prop_composite_case :: Bool -> W Word16 -> Property

269289prop_composite_case b (W w) = w < 0x8000 ==>

270290 let p = do putBool b

271− putWord16be 15 w

291+ putWord16 15 w

272292 g = do v <- getBool

273293 case v of

274− True -> getWord16be 15

294+ True -> getWord16 15

275295 False -> do

276296 msb <- getWord8 7

277297 lsb <- getWord8 8

@@ -374,11 +394,6 @@ instance (Arbitrary (W a), Arbitrary (W b), Arbitrary (W c)) => Arbitrary (W (a,

374394 arbitrary = ((W .) .) . (,,) <$> arbitraryW <*> arbitraryW <*> arbitraryW

375395 shrink (W (a,b,c)) = ((W .) .) . (,,) <$> shrinkW a <*> shrinkW b <*> shrinkW c

376396

377−integralRandomR :: (Integral a, RandomGen g) => (a,a) -> g -> (a,g)

378−integralRandomR (a,b) g = case randomR (fromIntegral a :: Integer,

379− fromIntegral b :: Integer) g of

380− (x,g) -> (fromIntegral x, g)

381−

382397data Primitive

383398 = Bool Bool

384399 | W8 Int Word8

@@ -387,6 +402,7 @@ data Primitive

387402 | W64 Int Word64

388403 | BS Int B.ByteString

389404 | LBS Int L.ByteString

405+ | Skip Int

390406 | IsEmpty

391407 deriving (Eq, Show)

392408

@@ -395,7 +411,7 @@ type Program = [Primitive]

395411instance Arbitrary Primitive where

396412 arbitrary = do

397413 let gen c = do

398− let (maxBits, _) = (\w -> (bitSize w, c undefined w)) undefined

414+ let (maxBits, _) = (\w -> (finiteBitSize w, c undefined w)) undefined

399415 bits <- choose (0, maxBits)

400416 n <- choose (0, fromIntegral (2^bits-1))

401417 return (c bits n)

@@ -405,6 +421,7 @@ instance Arbitrary Primitive where

405421 , gen W16

406422 , gen W32

407423 , gen W64

424+ , Skip <$> choose (0, 3000)

408425 , do n <- choose (0,10)

409426 cs <- vector n

410427 return (BS n (B.pack cs))

@@ -421,10 +438,19 @@ instance Arbitrary Primitive where

421438 W16 _ x -> snk W16 x

422439 W32 _ x -> snk W32 x

423440 W64 _ x -> snk W64 x

441+ Skip x -> Skip <$> shrink x

424442 BS _ bs -> let ws = B.unpack bs in map (\ws' -> BS (length ws') (B.pack ws')) (shrink ws)

425443 LBS _ lbs -> let ws = L.unpack lbs in map (\ws' -> LBS (length ws') (L.pack ws')) (shrink ws)

426444 IsEmpty -> []

427445

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+

428454prop_primitive :: Primitive -> Property

429455prop_primitive prim = property $

430456 let p = putPrimitive prim

@@ -446,9 +472,10 @@ putPrimitive p =

446472 case p of

447473 Bool b -> putBool b

448474 W8 n x -> putWord8 n x

449− W16 n x -> putWord16be n x

450− W32 n x -> putWord32be n x

451− W64 n x -> putWord64be 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

452479 BS _ bs -> putByteString bs

453480 LBS _ lbs -> mapM_ putByteString (L.toChunks lbs)

454481 IsEmpty -> return ()

@@ -458,13 +485,25 @@ getPrimitive p =

458485 case p of

459486 Bool _ -> Bool <$> getBool

460487 W8 n _ -> W8 n <$> getWord8 n

461− W16 n _ -> W16 n <$> getWord16be n

462− W32 n _ -> W32 n <$> getWord32be n

463− W64 n _ -> W64 n <$> getWord64be 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)

464492 BS n _ -> BS n <$> getByteString n

465493 LBS n _ -> LBS n <$> getLazyByteString n

466494 IsEmpty -> isEmpty >> return IsEmpty

467495

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

468507

469508verifyProgram :: Int -> Program -> BitGet Bool

470509verifyProgram totalLength ps0 = go 0 ps0

@@ -472,13 +511,6 @@ verifyProgram totalLength ps0 = go 0 ps0

472511 go _ [] = return True

473512 go pos (p:ps) =

474513 case p of

475− Bool x -> check x getBool >> go (pos+1) ps

476− W8 n x -> check x (getWord8 n) >> go (pos+n) ps

477− W16 n x -> check x (getWord16be n) >> go (pos+n) ps

478− W32 n x -> check x (getWord32be n) >> go (pos+n) ps

479− W64 n x -> check x (getWord64be n) >> go (pos+n) ps

480− BS n x -> check x (getByteString n) >> go (pos+(8*n)) ps

481− LBS n x -> check x (getLazyByteString n) >> go (pos+(8*n)) ps

482514 IsEmpty -> do

483515 let expected = pos == totalLength

484516 actual <- isEmpty

@@ -486,6 +518,7 @@ verifyProgram totalLength ps0 = go 0 ps0

486518 then go pos ps

487519 else error $ "isEmpty returned wrong value, expected "

488520 ++ show expected ++ " but got " ++ show actual

521+ _ -> check p (getPrimitive p) >> go (pos + getPrimitiveSize p) ps

489522 check x g = do

490523 y <- g

491524 if x == y

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+135−196

@@ -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

@@ -55,13 +56,15 @@ module Data.Binary.Bits.Get

5556 -- $bitget

5657

5758 BitGet

58− , BitOrder(..)

5959 , runBitGet

60− , selectBitOrder

6160

6261 -- ** Get bytes

6362 , getBool

63+ , getBool#

6464 , getWord8

65+ , getWord16

66+ , getWord32

67+ , getWord64

6568 , getWord16be

6669 , getWord32be

6770 , getWord64be

@@ -79,6 +82,9 @@ module Data.Binary.Bits.Get

7982 -- ** Read in Blocks

8083 , bool

8184 , word8

85+ , word16

86+ , word32

87+ , word64

8288 , word16be

8389 , word32be

8490 , word64be

@@ -91,6 +97,9 @@ module Data.Binary.Bits.Get

9197

9298import Data.Binary.Get as B ( Get, getLazyByteString, isEmpty )

9399import 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

94103

95104import Data.ByteString as B

96105import qualified Data.ByteString.Lazy as L

@@ -106,12 +115,8 @@ import Control.Applicative

106115import Control.Monad (when,foldM_)

107116

108117import Prelude as P

109−

110−#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)

111−import GHC.Base

112118import GHC.Word

113−#endif

114−

119+import GHC.Base (uncheckedShiftLWord8#, wordToWord8#, Int (..), andWord8#, Word8#, (-#), Int#, xorI#, eqWord8#, TYPE)

115120

116121-- $bitget

117122-- Parse bits using a monad.

@@ -164,16 +169,6 @@ data S = S {-# UNPACK #-} !ByteString -- Input

164169 !BitOrder -- Bit order

165170 deriving (Show)

166171

167−-- | Compute bit offset (equivalent to x `mod` 8 but faster)

168−bit_offset :: Int -> Int

169−bit_offset n = make_mask 3 .&. n

170−{-# INLINE bit_offset #-}

171−

172−-- | Compute byte offset (equivalent to x `div` 8 but faster)

173−byte_offset :: Int -> Int

174−byte_offset n = n `shiftR` 3

175−{-# INLINE byte_offset #-}

176−

177172-- | Increment the current bit offset

178173incS :: Int -> S -> S

179174incS o (S bs n bo) = S (unsafeDrop d bs) n' bo

@@ -182,83 +177,70 @@ incS o (S bs n bo) = S (unsafeDrop d bs) n' bo

182177 !d = byte_offset o'

183178 !n' = bit_offset o'

184179

185−-- | Select the bit ordering

186−selectBitOrderS :: BitOrder -> S -> S

187−selectBitOrderS bo (S bs o _) = S bs o bo

188−

189−-- | make_mask 3 = 00000111

190−make_mask :: (Bits a, Num a) => Int -> a

191−make_mask n = (1 `shiftL` fromIntegral n) - 1

192−{-# SPECIALIZE make_mask :: Int -> Int #-}

193−{-# SPECIALIZE make_mask :: Int -> Word #-}

194−{-# SPECIALIZE make_mask :: Int -> Word8 #-}

195−{-# SPECIALIZE make_mask :: Int -> Word16 #-}

196−{-# SPECIALIZE make_mask :: Int -> Word32 #-}

197−{-# SPECIALIZE make_mask :: Int -> Word64 #-}

198−

199−-- | Keep only the n least-significant bits of the given value

200−mask :: (Bits a, Num a) => Int -> a -> a

201−mask n v = v .&. make_mask n

202−{-# INLINE mask #-}

203−

204−-- | Bit order

205−--

206−-- E.g. two words of 5 bits: ABCDE, VWXYZ

207−-- - BB: ABCDEVWX YZxxxxxx

208−-- - LB: XYZABCDE xxxxxxVW

209−-- - BL: EDCBAZYX WVxxxxxx -- not implemented

210−-- - LL: XWVEDCBA xxxxxxZY -- not implemented

211−data BitOrder = BB | LB deriving (Show)

212−

213−

214180-- | Read a single bit

215181readBool :: S -> Bool

216182readBool (S bs o bo) = case bo of

217183 BB -> testBit (unsafeHead bs) (7-o)

184+ BL -> testBit (unsafeHead bs) (7-o)

185+ LL -> testBit (unsafeHead bs) o

218186 LB -> testBit (unsafeHead bs) o

219187

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+

220200-- | Extract a range of bits from (ws :: ByteString)

221201--

222202-- Constraint: 8 * (length ws -1 ) < o+n <= 8 * length ws

223−extract :: (Num a, Bits a, FastBits a) => BitOrder -> ByteString -> Int -> Int -> a

203+extract :: (Num a, FastBits a) => BitOrder -> ByteString -> Int -> Int -> a

224204extract bo bs o n

225205 | n == 0 = 0

226206 | B.length bs == 0 = error "Empty ByteString"

227− | otherwise = mask n (foldlWithIndex' f 0 bs)

207+ | otherwise = rev . mask n . foldlWithIndex' f 0 $ bs

228208 where

229209 -- B.foldl' with index

230210 foldlWithIndex' op b = fst . B.foldl' g (b,0)

231211 where g (b',i) w = (op b' w i, (i+1))

232212

233213 -- 'or' correctly shifted words

234− f b w i = b .|. (fromIntegral w `fastShift` off i)

214+ f b w i = b .|. (fromIntegral w `fastShift` off i)

235215

236216 -- co-offset

237− r = B.length bs * 8 - (o + n)

217+ r = B.length bs * 8 - (o + n)

238218

239219 -- shift offset depending on the byte position (0..B.length-1)

240− off i = case bo of

220+ off i = case bo of

221+ LL -> 8*i - o

241222 LB -> 8*i - o

242223 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

243232

244233

245234-- | Generic readWord

246−readWord :: (Num a, Bits a, FastBits a) => Int -> S -> a

235+readWord :: (Num a, FastBits a) => Int -> S -> a

247236readWord n (S bs o bo)

248237 | n == 0 = 0

249− | o+n <= 8 = extract bo (unsafeTake 1 bs) o n

250− | o+n <= 16 = extract bo (unsafeTake 2 bs) o n

251− | o+n <= 24 = extract bo (unsafeTake 3 bs) o n

252− | o+n <= 32 = extract bo (unsafeTake 4 bs) o n

253− | o+n <= 40 = extract bo (unsafeTake 5 bs) o n

254− | o+n <= 48 = extract bo (unsafeTake 6 bs) o n

255− | o+n <= 56 = extract bo (unsafeTake 7 bs) o n

256− | o+n <= 64 = extract bo (unsafeTake 8 bs) o n

257− | otherwise = extract bo (unsafeTake ((o+n+7) `div` 8) bs) o n

238+ | otherwise = extract bo (unsafeTake nbytes bs) o n

239+ where nbytes = byte_offset (o+n+7)

258240

259241-- | Check that the number of bits to read is not greater than the first parameter

260242{-# INLINE readWordChecked #-}

261−readWordChecked :: (Num a, Bits a, FastBits a) => Int -> Int -> S -> a

243+readWordChecked :: (Num a, FastBits a) => Int -> Int -> S -> a

262244readWordChecked m n s

263245 | n > m = error $ "Tried to read more than " ++ show m ++ " bits (" ++ show n ++")"

264246 | otherwise = readWord n s

@@ -266,36 +248,37 @@ readWordChecked m n s

266248-- | Read the given number of bytes and return them in Big-Endian order

267249--

268250-- Examples:

269−-- BB: xxxABCDE FGHIJKLM NOPQRxxx -> ABCDEFGH IJKLMNOP QRxxxxxx

270−-- LB: NOPQRxxx FGHIJKLM xxxABCDE -> ABCDEFGH IJKLMNOP QRxxxxxx

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

271255readByteString :: Int -> S -> ByteString

272−readByteString n (S bs o bo)

273− | o == 0 = unsafeTake n bs

274− | otherwise = unsafePerformIO $ do

275− let len = n+1

276− ptr <- mallocBytes len

277− case bo of

278− BB -> do

279− let f r i = do

280− let

281− w = unsafeIndex bs (len-i)

282− w' = (w `fastShiftL` o) .|. r

283− r' = w `fastShiftR` (8-o)

284− poke (ptr `plusPtr` (len-i)) w'

285− return r'

286− foldM_ f 0 [1..len]

287− unsafeInit <$> unsafePackMallocCStringLen (ptr,len)

288−

289− LB -> do

290− let f r i = do

291− let

292− w = unsafeIndex bs (i-1)

293− w' = (w `fastShiftL` (8-o)) .|. r

294− r' = w `fastShiftR` o

295− poke (ptr `plusPtr` (len-i)) w'

296− return r'

297− foldM_ f 0 [1..len]

298− unsafeTail <$> unsafePackMallocCStringLen (ptr,len)

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)

281+

299282

300283------------------------------------------------------------------------

301284-- | 'BitGet' is a monad, applicative and a functor. See 'runBitGet'

@@ -304,7 +287,6 @@ newtype BitGet a = B { runState :: S -> Get (S,a) }

304287

305288instance Monad BitGet where

306289 return x = B $ \s -> return (s,x)

307− fail str = B $ \s -> putBackState s >> fail str

308290 (B f) >>= g = B $ \s -> do (s',a) <- f s

309291 runState (g a) s'

310292

@@ -315,6 +297,29 @@ instance Applicative BitGet where

315297 pure x = return x

316298 fm <*> m = fm >>= \f -> m >>= \v -> return (f v)

317299

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+

318323-- | Run a 'BitGet' within the Binary packages 'Get' monad. If a byte has

319324-- been partially consumed it will be discarded once 'runBitGet' is finished.

320325runBitGet :: BitGet a -> Get a

@@ -362,23 +367,6 @@ ensureBits n = do

362367 put B.empty

363368 return (S (bs`append`bs') o bo, ())

364369

365−-- | Skip the given number of bits

366−skipBits :: Int -> BitGet ()

367−skipBits n = do

368− ensureBits n

369− withState (incS n)

370−

371−-- | Skip bits if necessary to align to the next byte

372−alignByte :: BitGet ()

373−alignByte = do

374− (S _ o _) <- getState

375− when (o /= 0) $

376− skipBits (8-o)

377−

378−-- | Select the bit ordering

379−selectBitOrder :: BitOrder -> BitGet ()

380−selectBitOrder = withState . selectBitOrderS

381−

382370-- | Test whether all input has been consumed, i.e. there are no remaining

383371-- undecoded bytes.

384372isEmpty :: BitGet Bool

@@ -390,21 +378,37 @@ isEmpty = B $ \ (S bs o bo) -> if B.null bs

390378getBool :: BitGet Bool

391379getBool = block bool

392380

381+-- | Get 1 bit as a 'Bool'.

382+getBool# :: BitGet Int

383+getBool# = block bool#

384+

393385-- | Get @n@ bits as a 'Word8'. @n@ must be within @[0..8]@.

394386getWord8 :: Int -> BitGet Word8

395387getWord8 n = block (word8 n)

396388

397389-- | Get @n@ bits as a 'Word16'. @n@ must be within @[0..16]@.

390+getWord16 :: Int -> BitGet Word16

391+getWord16 n = block (word16 n)

392+

398393getWord16be :: Int -> BitGet Word16

399−getWord16be n = block (word16be n)

394+getWord16be = getWord16

395+{-# DEPRECATED getWord16be "Use 'getWord16' instead" #-}

400396

401397-- | Get @n@ bits as a 'Word32'. @n@ must be within @[0..32]@.

398+getWord32 :: Int -> BitGet Word32

399+getWord32 n = block (word32 n)

400+

402401getWord32be :: Int -> BitGet Word32

403−getWord32be n = block (word32be n)

402+getWord32be = getWord32

403+{-# DEPRECATED getWord32be "Use 'getWord32' instead" #-}

404404

405405-- | Get @n@ bits as a 'Word64'. @n@ must be within @[0..64]@.

406+getWord64 :: Int -> BitGet Word64

407+getWord64 n = block (word64 n)

408+

406409getWord64be :: Int -> BitGet Word64

407−getWord64be n = block (word64be n)

410+getWord64be = getWord64

411+{-# DEPRECATED getWord64be "Use 'getWord64' instead" #-}

408412

409413-- | Get @n@ bytes as a 'ByteString'.

410414getByteString :: Int -> BitGet ByteString

@@ -453,105 +457,40 @@ block (Block i p) = do

453457bool :: Block Bool

454458bool = Block 1 readBool

455459

460+-- | Read a 1 bit 'Bool'.

461+bool# :: Block Int

462+bool# = Block 1 readBool#

463+

456464-- | Read @n@ bits as a 'Word8'. @n@ must be within @[0..8]@.

457465word8 :: Int -> Block Word8

458466word8 n = Block n (readWordChecked 8 n)

459467

460468-- | 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+

461472word16be :: Int -> Block Word16

462−word16be n = Block n (readWordChecked 16 n)

473+word16be = word16

474+{-# DEPRECATED word16be "Use 'word16' instead" #-}

463475

464476-- | 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+

465480word32be :: Int -> Block Word32

466−word32be n = Block n (readWordChecked 32 n)

481+word32be = word32

482+{-# DEPRECATED word32be "Use 'word32' instead" #-}

467483

468484-- | 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+

469488word64be :: Int -> Block Word64

470−word64be n = Block n (readWordChecked 64 n)

489+word64be = word64

490+{-# DEPRECATED word64be "Use 'word64' instead" #-}

471491

472492-- | Read @n@ bytes as a 'ByteString'.

473493byteString :: Int -> Block ByteString

474494byteString n | n > 0 = Block (n*8) (readByteString n)

475495 | otherwise = Block 0 (\_ -> B.empty)

476496

477−

478−---------------------------------------------------------------------

479−-- Unchecked shifts, from the "binary" package

480−

481−-- | Class for types supporting fast bit shifting

482−class FastBits a where

483− fastShiftR :: a -> Int -> a

484− fastShiftL :: a -> Int -> a

485−

486− {-# INLINE fastShift #-}

487− fastShift :: a -> Int -> a

488− fastShift x n

489− | n > 0 = fastShiftL x n

490− | n < 0 = fastShiftR x (negate n)

491− | otherwise = x

492−

493−instance FastBits Word8 where

494− fastShiftR = shiftr_w8

495− fastShiftL = shiftl_w8

496−

497−instance FastBits Word16 where

498− fastShiftR = shiftr_w16

499− fastShiftL = shiftl_w16

500−

501−instance FastBits Word32 where

502− fastShiftR = shiftr_w32

503− fastShiftL = shiftl_w32

504−

505−instance FastBits Word64 where

506− fastShiftR = shiftr_w64

507− fastShiftL = shiftl_w64

508−

509−

510−shiftl_w8 :: Word8 -> Int -> Word8

511−shiftl_w16 :: Word16 -> Int -> Word16

512−shiftl_w32 :: Word32 -> Int -> Word32

513−shiftl_w64 :: Word64 -> Int -> Word64

514−

515−shiftr_w8 :: Word8 -> Int -> Word8

516−shiftr_w16 :: Word16 -> Int -> Word16

517−shiftr_w32 :: Word32 -> Int -> Word32

518−shiftr_w64 :: Word64 -> Int -> Word64

519−

520−#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)

521−shiftl_w8 (W8# w) (I# i) = W8# (w `uncheckedShiftL#` i)

522−shiftl_w16 (W16# w) (I# i) = W16# (w `uncheckedShiftL#` i)

523−shiftl_w32 (W32# w) (I# i) = W32# (w `uncheckedShiftL#` i)

524−

525−shiftr_w8 (W8# w) (I# i) = W8# (w `uncheckedShiftRL#` i)

526−shiftr_w16 (W16# w) (I# i) = W16# (w `uncheckedShiftRL#` i)

527−shiftr_w32 (W32# w) (I# i) = W32# (w `uncheckedShiftRL#` i)

528−

529−

530−#if WORD_SIZE_IN_BITS < 64

531−shiftl_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftL64#` i)

532−shiftr_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftRL64#` i)

533−

534−#if __GLASGOW_HASKELL__ <= 606

535−-- Exported by GHC.Word in GHC 6.8 and higher

536−foreign import ccall unsafe "stg_uncheckedShiftL64"

537− uncheckedShiftL64# :: Word64# -> Int# -> Word64#

538−foreign import ccall unsafe "stg_uncheckedShiftRL64"

539− uncheckedShiftRL64# :: Word64# -> Int# -> Word64#

540−#endif

541−

542−#else

543−shiftl_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftL#` i)

544−shiftr_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftRL#` i)

545−#endif

546−

547−#else

548−shiftl_w8 = shiftL

549−shiftl_w16 = shiftL

550−shiftl_w32 = shiftL

551−shiftl_w64 = shiftL

552−

553−shiftr_w8 = shiftR

554−shiftr_w16 = shiftR

555−shiftr_w32 = shiftR

556−shiftr_w64 = shiftR

557−#endif

Data/Binary/Bits/Internal.hsnew file+176

@@ -0,0 +1,176 @@

1+{-# LANGUAGE RankNTypes, MagicHash, BangPatterns, CPP #-}

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+186−76

@@ -1,7 +1,10 @@

1+{-# LANGUAGE MagicHash #-}

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,125 +43,210 @@ 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

41−import Control.Applicative

53+import Control.Monad (when)

4254import Data.Bits

43−import Data.Monoid

4455import Data.Word

56+import GHC.Base (Word#, shiftRL#, Int (..), Int#, (-#), (<#), isTrue#, (+#), shiftL#, wordToWord8#, orWord8#)

57+import GHC.Word (Word8(..))

4558

4659data BitPut a = BitPut { run :: (S -> PairS a) }

4760

4861data PairS a = PairS a {-# UNPACK #-} !S

4962

50−data S = S !Builder !Word8 !Int

63+data S = S !Builder !Word8 !Int !BitOrder

5164

5265-- | Put a 1 bit 'Bool'.

5366putBool :: Bool -> BitPut ()

5467putBool b = putWord8 1 (if b then 0xff else 0x00)

5568

56−-- | make_mask 3 = 00000111

57−make_mask :: (Bits a, Num a) => Int -> a

58−make_mask n = (1 `shiftL` fromIntegral n) - 1

59−{-# SPECIALIZE make_mask :: Int -> Int #-}

60−{-# SPECIALIZE make_mask :: Int -> Word #-}

61−{-# SPECIALIZE make_mask :: Int -> Word8 #-}

62−{-# SPECIALIZE make_mask :: Int -> Word16 #-}

63−{-# SPECIALIZE make_mask :: Int -> Word32 #-}

64−{-# SPECIALIZE make_mask :: Int -> Word64 #-}

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+

65171

66172-- | Put the @n@ lower bits of a 'Word8'.

67173putWord8 :: Int -> Word8 -> BitPut ()

68−putWord8 n w = BitPut $ \s -> PairS () $

69− let w' = make_mask n .&. w in

70− case s of

71− -- a whole word8, no offset

72− (S b t o) | n == 8 && o == 0 -> flush $ S b w n

73− -- less than a word8, will fit in the current word8

74− | n <= 8 - o -> flush $ S b (t .|. (w' `shiftL` (8 - n - o))) (o+n)

75− -- will finish this word8, and spill into the next one

76− | otherwise -> flush $

77− let o' = o + n - 8

78− b' = t .|. (w' `shiftR` o')

79− t' = w `shiftL` (8 - o')

80− in S (b `mappend` B.singleton b') t' o'

174+putWord8 = putWord

81175

82176-- | Put the @n@ lower bits of a 'Word16'.

177+putWord16 :: Int -> Word16 -> BitPut ()

178+putWord16 = putWord

179+

83180putWord16be :: Int -> Word16 -> BitPut ()

84−putWord16be n w

85− | n <= 8 = putWord8 n (fromIntegral w)

86− | otherwise =

87− BitPut $ \s -> PairS () $

88− let w' = make_mask n .&. w in

89− case s of

90− -- as n>=9, it's too big to fit into one single byte

91− -- it'll either use 2 or 3 bytes

92− -- it'll fit in 2 bytes

93− (S b t o) | o + n <= 16 -> flush $

94− let o' = o + n - 8

95− b' = t .|. fromIntegral (w' `shiftR` o')

96− t' = fromIntegral (w `shiftL` (8-o'))

97− in (S (b `mappend` B.singleton b') t' o')

98− -- 3 bytes required

99− | otherwise -> flush $

100− let o' = o + n - 16

101− b' = t .|. fromIntegral (w' `shiftR` (o' + 8))

102− b'' = fromIntegral ((w `shiftR` o') .&. 0xff)

103− t' = fromIntegral (w `shiftL` (8-o'))

104− in (S (b `mappend` B.singleton b' `mappend` B.singleton b'') t' o')

181+putWord16be = putWord

182+{-# DEPRECATED putWord16be "Use 'putWord16' instead" #-}

105183

106184-- | Put the @n@ lower bits of a 'Word32'.

185+putWord32 :: Int -> Word32 -> BitPut ()

186+putWord32 = putWord

187+

107188putWord32be :: Int -> Word32 -> BitPut ()

108−putWord32be n w

109− | n <= 16 = putWord16be n (fromIntegral w)

110− | otherwise = do

111− putWord32be (n-16) (w`shiftR`16)

112− putWord32be 16 (w .&. 0x0000ffff)

189+putWord32be = putWord

190+{-# DEPRECATED putWord32be "Use 'putWord32' instead" #-}

113191

114192-- | Put the @n@ lower bits of a 'Word64'.

193+putWord64 :: Int -> Word64 -> BitPut ()

194+putWord64 = putWord

195+

115196putWord64be :: Int -> Word64 -> BitPut ()

116−putWord64be n w

117− | n <= 32 = putWord32be n (fromIntegral w)

118− | otherwise = do

119− putWord64be (n-32) (w`shiftR`32)

120− putWord64be 32 (w .&. 0xffffffff)

197+putWord64be = putWord

198+{-# DEPRECATED putWord64be "Use 'putWord64' instead" #-}

121199

122200-- | 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

123207putByteString :: ByteString -> BitPut ()

124−putByteString bs = do

125− offset <- hasOffset

126− if offset

127− then mapM_ (putWord8 8) (unpack bs) -- naive

128− else joinPut (Put.putByteString bs)

129− where

130− 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+

131225

132226-- | Run a 'Put' inside 'BitPut'. Any partially written bytes will be flushed

133227-- before 'Put' executes to ensure byte alignment.

228+--

229+-- Warning: this method does not take bit order into account (i.e. BB assumed)

134230joinPut :: Put -> BitPut ()

135231joinPut m = BitPut $ \s0 -> PairS () $

136− let (S b0 _ _) = flushIncomplete s0

232+ let (S b0 _ _ bo) = flushIncomplete s0

137233 b = Put.execPut m

138− in (S (b0`mappend`b) 0 0)

139−

140−flush :: S -> S

141−flush s@(S b w o)

142− | o > 8 = error "flush: offset > 8"

143− | o == 8 = S (b `mappend` B.singleton w) 0 0

144− | otherwise = s

234+ in (S (b0`mappend`b) 0 0 bo)

145235

146236flushIncomplete :: S -> S

147−flushIncomplete s@(S b w o)

237+flushIncomplete s@(S b w o bo)

148238 | o == 0 = s

149− | 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

150243

151244-- | Run the 'BitPut' monad inside 'Put'.

152245runBitPut :: BitPut () -> Put.Put

153246runBitPut m = Put.putBuilder b

154247 where

155− PairS _ s = run m (S mempty 0 0)

156− (S b _ _) = flushIncomplete s

248+ PairS _ s = run m (S mempty 0 0 BB)

249+ (S b _ _ _) = flushIncomplete s

157250

158251instance Functor BitPut where

159252 fmap f (BitPut k) = BitPut $ \s ->

@@ -173,3 +266,20 @@ instance Monad BitPut where

173266 PairS b s'' = run (k a) s'

174267 in PairS b s''

175268 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+6−2

@@ -1,6 +1,6 @@

11-- http://www.haskell.org/cabal/release/cabal-latest/doc/users-guide/

22name: binary-bits

3−version: 0.5.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.

@@ -24,7 +24,10 @@ library

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,6 +37,7 @@ test-suite qc

3437 type: exitcode-stdio-1.0

3538 main-is: BitsQC.hs

3639 default-language: Haskell98

40+ --ghc-options: -O2 -Wall

3741

3842 build-depends: base==4.*, binary >= 0.6.0.0, bytestring,

3943 QuickCheck>=2, random,

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+ };

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/

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

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