4c202bb...master · binary-bits

git.iko.soy/binary-bits

on master help sign in

.gitignore+1

since splitsnapshots

unifiedsplit

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

1.cabal-sandbox

2cabal.sandbox.config

3dist/

4+.stack-work

BitsQC.hs+19−15

@@ -18,7 +18,6 @@ import Control.Applicative

18import Data.Bits

19import Data.Word

20import Foreign.Storable

21−import System.Random

22import Data.Traversable (traverse)

21import Data.Traversable (traverse)

23import Data.Foldable (traverse_)

22import Data.Foldable (traverse_)

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

262 expectedBytesConsumed

261 expectedBytesConsumed

263 | bits == 0 = bytes

262 | bits == 0 = bytes

264 | otherwise = bytes + 1

263 | otherwise = bytes + 1

265− p = do getByteString (fromIntegral bytes)

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

266− getBits (fromIntegral bits) :: BitGet Word8

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

267 fail errMsg0

266 fail errMsg0

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

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

269 in case r of

268 in case r of

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

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

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

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

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

397

396

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

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

400− fromIntegral b :: Integer) g of

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

402−

403data Primitive

397data Primitive

404 = Bool Bool

398 = Bool Bool

405 | W8 Int Word8

399 | W8 Int Word8

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

408 | W64 Int Word64

402 | W64 Int Word64

409 | BS Int B.ByteString

403 | BS Int B.ByteString

410 | LBS Int L.ByteString

404 | LBS Int L.ByteString

405+ | Skip Int

411 | IsEmpty

406 | IsEmpty

412 deriving (Eq, Show)

407 deriving (Eq, Show)

413

408

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

426 , gen W16

421 , gen W16

427 , gen W32

422 , gen W32

428 , gen W64

423 , gen W64

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

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

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

430 cs <- vector n

426 cs <- vector n

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

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

@@ -442,6 +438,7 @@ instance Arbitrary Primitive where

442 W16 _ x -> snk W16 x

438 W16 _ x -> snk W16 x

443 W32 _ x -> snk W32 x

439 W32 _ x -> snk W32 x

444 W64 _ x -> snk W64 x

440 W64 _ x -> snk W64 x

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

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

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

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

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

447 IsEmpty -> []

444 IsEmpty -> []

@@ -478,6 +475,7 @@ putPrimitive p =

478 W16 n x -> putWord16 n x

475 W16 n x -> putWord16 n x

479 W32 n x -> putWord32 n x

476 W32 n x -> putWord32 n x

480 W64 n x -> putWord64 n x

477 W64 n x -> putWord64 n x

478+ Skip n -> skipBits n

481 BS _ bs -> putByteString bs

479 BS _ bs -> putByteString bs

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

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

483 IsEmpty -> return ()

481 IsEmpty -> return ()

@@ -490,10 +488,22 @@ getPrimitive p =

490 W16 n _ -> W16 n <$> getWord16 n

488 W16 n _ -> W16 n <$> getWord16 n

491 W32 n _ -> W32 n <$> getWord32 n

489 W32 n _ -> W32 n <$> getWord32 n

492 W64 n _ -> W64 n <$> getWord64 n

490 W64 n _ -> W64 n <$> getWord64 n

491+ Skip n -> skipBits n >> return (Skip n)

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

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

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

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

495 IsEmpty -> isEmpty >> return IsEmpty

494 IsEmpty -> isEmpty >> return IsEmpty

496

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

497

507

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

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

499verifyProgram totalLength ps0 = go 0 ps0

509verifyProgram totalLength ps0 = go 0 ps0

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

501 go _ [] = return True

511 go _ [] = return True

502 go pos (p:ps) =

512 go pos (p:ps) =

503 case p of

513 case p of

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

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

506− W16 n x -> check x (getWord16 n) >> go (pos+n) ps

507− W32 n x -> check x (getWord32 n) >> go (pos+n) ps

508− W64 n x -> check x (getWord64 n) >> go (pos+n) ps

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

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

511 IsEmpty -> do

514 IsEmpty -> do

512 let expected = pos == totalLength

515 let expected = pos == totalLength

513 actual <- isEmpty

516 actual <- isEmpty

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

515 then go pos ps

518 then go pos ps

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

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

517 ++ show expected ++ " but got " ++ show actual

520 ++ show expected ++ " but got " ++ show actual

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

518 check x g = do

522 check x g = do

519 y <- g

523 y <- g

520 if x == y

524 if x == y

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.hs+2−2

@@ -19,9 +19,9 @@ where

19--

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

21-- - BB: ABCDEVWX YZxxxxxx

22−-- - LB: XYZABCDE xxxxxxVW

22+-- - LL: XYZABCDE xxxxxxVW

23-- - BL: EDCBAZYX WVxxxxxx

24−-- - LL: XWVEDCBA xxxxxxZY

24+-- - LB: XWVEDCBA xxxxxxZY

25data BitOrder

26 = BB -- ^ Big-endian bytes and bits

27 | LB -- ^ Little-endian bytes, big-endian bits

Data/Binary/Bits/Get.hs+48−25

@@ -60,6 +60,7 @@ module Data.Binary.Bits.Get

61 -- ** Get bytes

62 , getBool

63+ , getBool#

63 , getWord8

64 , getWord8

64 , getWord16

65 , getWord16

65 , getWord32

66 , getWord32

@@ -98,6 +99,7 @@ import Data.Binary.Get as B ( Get, getLazyByteString, isEmpty )

98import Data.Binary.Get.Internal as B ( get, put, ensureN )

99import Data.Binary.Get.Internal as B ( get, put, ensureN )

99import Data.Binary.Bits.BitOrder

100import Data.Binary.Bits.BitOrder

100import Data.Binary.Bits.Internal

101import Data.Binary.Bits.Internal

102+import Data.Binary.Bits.Alignment

101

103

102import Data.ByteString as B

104import Data.ByteString as B

103import qualified Data.ByteString.Lazy as L

105import qualified Data.ByteString.Lazy as L

@@ -113,6 +115,8 @@ import Control.Applicative

113import Control.Monad (when,foldM_)

115import Control.Monad (when,foldM_)

114

116

115import Prelude as P

117import Prelude as P

118+import GHC.Word

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

116

120

117-- $bitget

121-- $bitget

118-- Parse bits using a monad.

122-- Parse bits using a monad.

@@ -178,8 +182,20 @@ readBool :: S -> Bool

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

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

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

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

180 BL -> testBit (unsafeHead bs) (7-o)

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

181− LB -> testBit (unsafeHead bs) o

182 LL -> testBit (unsafeHead bs) 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+

183

199

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

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

185--

201--

@@ -202,17 +218,17 @@ extract bo bs o n

202

218

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

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

204 off i = case bo of

220 off i = case bo of

205− LB -> 8*i - o

206 LL -> 8*i - o

221 LL -> 8*i - o

222+ LB -> 8*i - o

207 BB -> (B.length bs -1 - i) * 8 - r

223 BB -> (B.length bs -1 - i) * 8 - r

208 BL -> (B.length bs -1 - i) * 8 - r

224 BL -> (B.length bs -1 - i) * 8 - r

209

225

210 -- reverse bits if necessary

226 -- reverse bits if necessary

211 rev = case bo of

227 rev = case bo of

212− LL -> reverseBits n

228+ LB -> reverseBits n

213 BL -> reverseBits n

229 BL -> reverseBits n

214 BB -> id

230 BB -> id

215− LB -> id

231+ LL -> id

216

232

217

233

218-- | Generic readWord

234-- | Generic readWord

@@ -233,9 +249,9 @@ readWordChecked m n s

233--

249--

234-- Examples:

250-- Examples:

235-- BB: xxxABCDE FGHIJKLM NOPxxxxx -> ABCDEFGH IJKLMNOP

251-- BB: xxxABCDE FGHIJKLM NOPxxxxx -> ABCDEFGH IJKLMNOP

236−-- LB: LMNOPxxx DEFGHIJK xxxxxABC -> ABCDEFGH IJKLMNOP

252+-- LL: LMNOPxxx DEFGHIJK xxxxxABC -> ABCDEFGH IJKLMNOP

237-- BL: xxxPONML KJIHGFED CBAxxxxx -> ABCDEFGH IJKLMNOP

253-- BL: xxxPONML KJIHGFED CBAxxxxx -> ABCDEFGH IJKLMNOP

238−-- LL: EDCBAxxx MLKJIHGF xxxxxPON -> ABCDEFGH IJKLMNOP

254+-- LB: EDCBAxxx MLKJIHGF xxxxxPON -> ABCDEFGH IJKLMNOP

239readByteString :: Int -> S -> ByteString

255readByteString :: Int -> S -> ByteString

240readByteString n (S bs o bo) =

256readByteString n (S bs o bo) =

241 let

257 let

@@ -244,12 +260,12 @@ readByteString n (S bs o bo) =

244 rev = B.map (reverseBits 8)

260 rev = B.map (reverseBits 8)

245 in case (o,bo) of

261 in case (o,bo) of

246 (0,BB) -> bs''

262 (0,BB) -> bs''

247− (0,LB) -> B.reverse bs''

263+ (0,LL) -> B.reverse bs''

248− (0,LL) -> rev bs''

264+ (0,LB) -> rev bs''

249 (0,BL) -> rev . B.reverse $ bs''

265 (0,BL) -> rev . B.reverse $ bs''

250− (_,LB) -> readByteString n (S (B.reverse bs') (8-o) BB)

266+ (_,LL) -> readByteString n (S (B.reverse bs') (8-o) BB)

251 (_,BL) -> rev . B.reverse $ readByteString n (S bs' o BB)

267 (_,BL) -> rev . B.reverse $ readByteString n (S bs' o BB)

252− (_,LL) -> rev . B.reverse $ readByteString n (S bs' o LB)

268+ (_,LB) -> rev . B.reverse $ readByteString n (S bs' o LL)

253 (_,BB) -> unsafePerformIO $ do

269 (_,BB) -> unsafePerformIO $ do

254 let len = n+1

270 let len = n+1

255 ptr <- mallocBytes len

271 ptr <- mallocBytes len

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

271

287

272instance Monad BitGet where

288instance Monad BitGet where

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

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

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

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

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

276 runState (g a) s'

291 runState (g a) s'

277

292

@@ -291,6 +306,20 @@ instance BitOrderable BitGet where

291 (S _ _ bo) <- getState

306 (S _ _ bo) <- getState

292 return bo

307 return bo

293

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+

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

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

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

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

296runBitGet :: BitGet a -> Get a

325runBitGet :: BitGet a -> Get a

@@ -338,20 +367,6 @@ ensureBits n = do

338 put B.empty

367 put B.empty

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

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

340

369

341−-- | Skip the given number of bits

342−skipBits :: Int -> BitGet ()

343−skipBits n = do

344− ensureBits n

345− withState (incS n)

346−

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

348−alignByte :: BitGet ()

349−alignByte = do

350− (S _ o _) <- getState

351− when (o /= 0) $

352− skipBits (8-o)

353−

354−

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

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

356-- undecoded bytes.

371-- undecoded bytes.

357isEmpty :: BitGet Bool

372isEmpty :: BitGet Bool

@@ -363,6 +378,10 @@ isEmpty = B $ \ (S bs o bo) -> if B.null bs

363getBool :: BitGet Bool

378getBool :: BitGet Bool

364getBool = block bool

379getBool = block bool

365

380

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

382+getBool# :: BitGet Int

383+getBool# = block bool#

384+

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

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

367getWord8 :: Int -> BitGet Word8

386getWord8 :: Int -> BitGet Word8

368getWord8 n = block (word8 n)

387getWord8 n = block (word8 n)

@@ -438,6 +457,10 @@ block (Block i p) = do

438bool :: Block Bool

457bool :: Block Bool

439bool = Block 1 readBool

458bool = Block 1 readBool

440

459

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

461+bool# :: Block Int

462+bool# = Block 1 readBool#

463+

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

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

442word8 :: Int -> Block Word8

465word8 :: Int -> Block Word8

443word8 n = Block n (readWordChecked 8 n)

466word8 n = Block n (readWordChecked 8 n)

Data/Binary/Bits/Internal.hs+27−6

@@ -12,10 +12,13 @@

13module Data.Binary.Bits.Internal

14 ( make_mask

15+ , make_mask#

15 , mask

16 , mask

17+ , mask#

16 , bit_offset

18 , bit_offset

17 , byte_offset

19 , byte_offset

18 , reverseBits

20 , reverseBits

21+ , reverseBits#

19 , FastBits(..)

22 , FastBits(..)

20 )

23 )

21where

24where

@@ -38,11 +41,18 @@ make_mask n = (1 `shiftL` fromIntegral n) - 1

38{-# SPECIALIZE make_mask :: Int -> Word32 #-}

41{-# SPECIALIZE make_mask :: Int -> Word32 #-}

39{-# SPECIALIZE make_mask :: Int -> Word64 #-}

42{-# SPECIALIZE make_mask :: Int -> Word64 #-}

44+make_mask# :: Int# -> Word#

45+make_mask# n = (1## `shiftL#` n) `minusWord#` 1##

46+

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

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

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

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

43mask n v = v .&. make_mask n

49mask n v = v .&. make_mask n

44{-# INLINE mask #-}

50{-# INLINE mask #-}

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+

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

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

47bit_offset :: Int -> Int

57bit_offset :: Int -> Int

48bit_offset n = make_mask 3 .&. n

58bit_offset n = make_mask 3 .&. n

@@ -65,6 +75,17 @@ reverseBits n value = rec value n 0

65 rec 0 i r = r `fastShiftL` i

75 rec 0 i r = r `fastShiftL` i

66 rec v i r = rec (v `fastShiftR` 1) (i-1) ((r `fastShiftL` 1) .|. (v .&. 0x1))

76 rec v i r = rec (v `fastShiftR` 1) (i-1) ((r `fastShiftL` 1) .|. (v .&. 0x1))

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+

69---------------------------------------------------------------------

90---------------------------------------------------------------------

70-- Unchecked shifts, from the "binary" package

91-- Unchecked shifts, from the "binary" package

@@ -116,13 +137,13 @@ shiftr_w32 :: Word32 -> Int -> Word32

116shiftr_w64 :: Word64 -> Int -> Word64

137shiftr_w64 :: Word64 -> Int -> Word64

117

138

118#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)

139#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)

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

140+shiftl_w8 w i = w `unsafeShiftL` i

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

141+shiftl_w16 w i = w `unsafeShiftL` i

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

142+shiftl_w32 w i = w `unsafeShiftL` i

122

143

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

144+shiftr_w8 w i = w `unsafeShiftR` i

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

145+shiftr_w16 w i = w `unsafeShiftR` i

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

146+shiftr_w32 w i = w `unsafeShiftR` i

126

147

127

148

128#if WORD_SIZE_IN_BITS < 64

149#if WORD_SIZE_IN_BITS < 64

Data/Binary/Bits/Put.hs+88−13

@@ -1,3 +1,5 @@

1+{-# LANGUAGE MagicHash #-}

1-----------------------------------------------------------------------------

3-----------------------------------------------------------------------------

2-- |

4-- |

3-- Module : Data.Binary.Bits.Put

5-- Module : Data.Binary.Bits.Put

@@ -20,8 +22,10 @@ module Data.Binary.Bits.Put

20 -- * Data types

22 -- * Data types

21 -- ** Bool

23 -- ** Bool

22 , putBool

24 , putBool

25+ , putBool#

24 -- ** Words

27 -- ** Words

28+ , putWord#

25 , putWord8

29 , putWord8

26 , putWord16

30 , putWord16

27 , putWord32

31 , putWord32

@@ -41,14 +45,16 @@ import qualified Data.Binary.Put as Put

41import Data.Binary.Put ( Put )

45import Data.Binary.Put ( Put )

42import Data.Binary.Bits.Internal

46import Data.Binary.Bits.Internal

43import Data.Binary.Bits.BitOrder

47import Data.Binary.Bits.BitOrder

48+import Data.Binary.Bits.Alignment

45import Data.ByteString as BS

50import Data.ByteString as BS

46import Data.ByteString.Unsafe as BS

51import Data.ByteString.Unsafe as BS

48−import Control.Applicative

53+import Control.Monad (when)

49import Data.Bits

54import Data.Bits

50−import Data.Monoid

51import Data.Word

55import Data.Word

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

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

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

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

@@ -60,11 +66,18 @@ data S = S !Builder !Word8 !Int !BitOrder

60putBool :: Bool -> BitPut ()

66putBool :: Bool -> BitPut ()

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

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

69+-- | Put a 1 bit 'Bool'.

70+putBool# :: Word# -> BitPut ()

71+putBool# b = putWord# 1# b

72+

64-- | Generic putWord

74-- | Generic putWord

65putWord :: (Num a, FastBits a, Integral a) => Int -> a -> BitPut ()

75putWord :: (Num a, FastBits a, Integral a) => Int -> a -> BitPut ()

66putWord n w = BitPut $ \s -> PairS () (putWordS n w s)

76putWord n w = BitPut $ \s -> PairS () (putWordS n w s)

78+putWord# :: Int# -> Word# -> BitPut ()

79+putWord# n w = BitPut $ \s -> PairS () (putWordS# n w s)

80+

68putWordS :: (Num a, FastBits a, Integral a) => Int -> a -> S -> S

81putWordS :: (Num a, FastBits a, Integral a) => Int -> a -> S -> S

69putWordS n w s@(S builder b o bo) = s'

82putWordS n w s@(S builder b o bo) = s'

70 where

83 where

@@ -83,8 +96,8 @@ putWordS n w s@(S builder b o bo) = s'

83 w' = case bo of

96 w' = case bo of

84 BB -> w

97 BB -> w

85 BL -> w `fastShiftR` cn

98 BL -> w `fastShiftR` cn

86− LB -> w `fastShiftR` cn

99+ LL -> w `fastShiftR` cn

87− LL -> w

100+ LB -> w

101

89 -- Select bits to store in the current byte.

102 -- Select bits to store in the current byte.

90 -- Put them in the correct order and return them in the least-significant

103 -- Put them in the correct order and return them in the least-significant

@@ -92,8 +105,8 @@ putWordS n w s@(S builder b o bo) = s'

92 selectBits :: (Num a, FastBits a, Integral a) => a -> Word8

105 selectBits :: (Num a, FastBits a, Integral a) => a -> Word8

93 selectBits x = fromIntegral $ case bo of

106 selectBits x = fromIntegral $ case bo of

94 BB -> mask cn $ x `fastShiftR` (n-cn)

107 BB -> mask cn $ x `fastShiftR` (n-cn)

95− LL -> reverseBits cn $ mask cn $ x `fastShiftR` (n-cn)

108+ LB -> reverseBits cn $ mask cn $ x `fastShiftR` (n-cn)

96− LB -> mask cn x

109+ LL -> mask cn x

97 BL -> reverseBits cn $ mask cn x

110 BL -> reverseBits cn $ mask cn x

111

99 -- shift left at the correct position

112 -- shift left at the correct position

@@ -101,8 +114,55 @@ putWordS n w s@(S builder b o bo) = s'

101 shl x = case bo of

114 shl x = case bo of

102 BB -> x `fastShiftL` (8-o-cn)

115 BB -> x `fastShiftL` (8-o-cn)

103 BL -> x `fastShiftL` (8-o-cn)

116 BL -> x `fastShiftL` (8-o-cn)

104− LB -> x `fastShiftL` o

105 LL -> x `fastShiftL` o

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

106

166

107 flush s2@(S b2 w2 o2 bo2)

167 flush s2@(S b2 w2 o2 bo2)

108 | o2 == 8 = S (b2 `mappend` B.singleton w2) 0 0 bo2

168 | o2 == 8 = S (b2 `mappend` B.singleton w2) 0 0 bo2

@@ -141,9 +201,9 @@ putWord64be = putWord

141--

201--

142-- Examples: 3 bits are already written in the current byte

202-- Examples: 3 bits are already written in the current byte

143-- BB: ABCDEFGH IJKLMNOP -> xxxABCDE FGHIJKLM NOPxxxxx

203-- BB: ABCDEFGH IJKLMNOP -> xxxABCDE FGHIJKLM NOPxxxxx

144−-- LB: ABCDEFGH IJKLMNOP -> LMNOPxxx DEFGHIJK xxxxxABC

204+-- LL: ABCDEFGH IJKLMNOP -> LMNOPxxx DEFGHIJK xxxxxABC

145-- BL: ABCDEFGH IJKLMNOP -> xxxPONML KJIHGFED CBAxxxxx

205-- BL: ABCDEFGH IJKLMNOP -> xxxPONML KJIHGFED CBAxxxxx

146−-- LL: ABCDEFGH IJKLMNOP -> EDCBAxxx MLKJIHGF xxxxxPON

206+-- LB: ABCDEFGH IJKLMNOP -> EDCBAxxx MLKJIHGF xxxxxPON

147putByteString :: ByteString -> BitPut ()

207putByteString :: ByteString -> BitPut ()

148putByteString bs = BitPut $ \s -> PairS () (putByteStringS bs s)

208putByteString bs = BitPut $ \s -> PairS () (putByteStringS bs s)

149

209

@@ -152,13 +212,13 @@ putByteStringS bs s

152 | BS.null bs = s

212 | BS.null bs = s

153 | otherwise = case s of

213 | otherwise = case s of

154 (S builder b 0 BB) -> S (builder `mappend` B.fromByteString bs) b 0 BB

214 (S builder b 0 BB) -> S (builder `mappend` B.fromByteString bs) b 0 BB

155− (S builder b 0 LB) -> S (builder `mappend` B.fromByteString (BS.reverse bs)) b 0 LB

215+ (S builder b 0 LL) -> S (builder `mappend` B.fromByteString (BS.reverse bs)) b 0 LL

156− (S builder b 0 LL) -> S (builder `mappend` B.fromByteString (rev bs)) b 0 LL

216+ (S builder b 0 LB) -> S (builder `mappend` B.fromByteString (rev bs)) b 0 LB

157 (S builder b 0 BL) -> S (builder `mappend` B.fromByteString (rev (BS.reverse bs))) b 0 BL

217 (S builder b 0 BL) -> S (builder `mappend` B.fromByteString (rev (BS.reverse bs))) b 0 BL

158 (S _ _ _ BB) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)

218 (S _ _ _ BB) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)

159− (S _ _ _ LB) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)

219+ (S _ _ _ LL) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)

160 (S _ _ _ BL) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)

220 (S _ _ _ BL) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)

161− (S _ _ _ LL) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)

221+ (S _ _ _ LB) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)

162 where

222 where

163 rev = BS.map (reverseBits 8)

223 rev = BS.map (reverseBits 8)

164

224

@@ -178,6 +238,9 @@ flushIncomplete s@(S b w o bo)

178 | o == 0 = s

238 | o == 0 = s

179 | otherwise = (S (b `mappend` B.singleton w) 0 0 bo)

239 | otherwise = (S (b `mappend` B.singleton w) 0 0 bo)

180

240

241+getOffset :: BitPut Int

242+getOffset = BitPut $ \s@(S _ _ o _) -> PairS o s

243+

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

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

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

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

183runBitPut m = Put.putBuilder b

246runBitPut m = Put.putBuilder b

@@ -208,3 +271,15 @@ instance BitOrderable BitPut where

208 setBitOrder bo = BitPut $ \(S bu b o _) -> PairS () (S bu b o bo)

271 setBitOrder bo = BitPut $ \(S bu b o _) -> PairS () (S bu b o bo)

209

272

210 getBitOrder = BitPut $ \s@(S _ _ _ bo) -> PairS bo s

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+3−1

@@ -25,7 +25,8 @@ library

25 exposed-modules: Data.Binary.Bits ,

26 Data.Binary.Bits.Put ,

27 Data.Binary.Bits.Get ,

28− Data.Binary.Bits.BitOrder

28+ Data.Binary.Bits.BitOrder ,

29+ Data.Binary.Bits.Alignment

29 other-modules: Data.Binary.Bits.Internal

30 other-modules: Data.Binary.Bits.Internal

31 default-language: Haskell98

32 default-language: Haskell98

@@ -36,6 +37,7 @@ test-suite qc

36 type: exitcode-stdio-1.0

37 type: exitcode-stdio-1.0

37 main-is: BitsQC.hs

38 main-is: BitsQC.hs

38 default-language: Haskell98

39 default-language: Haskell98

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

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

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

41 QuickCheck>=2, random,

43 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