master..cb2cbc4 · binary-bits

git.iko.soy/binary-bits

12 files changed+94−432

unifiedsplit

.gitignore−1 BitsQC.hs+32−65 Data/Binary/Bits/Alignment.hs−22 Data/Binary/Bits/BitOrder.hs+2−2 Data/Binary/Bits/Get.hs+30−54 Data/Binary/Bits/Internal.hs+6−27 Data/Binary/Bits/Put.hs+22−96 binary-bits.cabal+2−4 flake.lock−59 flake.nix−24 stack.yaml−66 stack.yaml.lock−12

.gitignore−1

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

11.cabal-sandbox

22cabal.sandbox.config

33dist/

4−.stack-work

BitsQC.hs+32−65

@@ -9,7 +9,6 @@ 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

1312

1413import qualified Data.ByteString as B

1514import qualified Data.ByteString.Lazy as L

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

1817import Data.Bits

1918import Data.Word

2019import Foreign.Storable

21−import Data.Traversable (traverse)

22−import Data.Foldable (traverse_)

20+import System.Random

2321

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

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

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

3836 [ testProperty "prop_composite_case" prop_composite_case ]

3937

4038 , 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− ]

39+ [ testProperty "prop_getByteString_negative" prop_getByteString_negative ]

4540

4641 , testGroup "getLazyByteString"

4742 [ testProperty "getLazyByteString == getByteString"

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

8984 ]

9085

9186 , testGroup "prop_put_with_bitreq"

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)

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)

9691 ]

9792

9893 , testGroup "prop_putget_list_simple"

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

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

118113 ]

119114 , testGroup "prop_bitget_bytestring_interspersed"

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)

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)

124119 ]

125120 , testGroup "Simulate programs"

126121 [ testProperty "primitive" prop_primitive

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

163158 n < 1 ==>

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

165160

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 $

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

162+prop_putget_with_bitreq (W w) = property $

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

184164 let p = putBits (bitreq w) w

185165 g = getBits (bitreq w)

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

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

166+ lbs = runPut (runBitPut p)

167+ w' = runGet (runBitGet g) lbs

188168 in w == w'

189169

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

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

246226 in ws == ws'

247227

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

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 $

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 $

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

252232 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

233+ lbs = runPut (runBitPut p)

234+ r = runGet (runBitGet g) lbs

255235 in map (ws,) bss == r

256236

257237-- | Test failing.

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

261241 expectedBytesConsumed

262242 | bits == 0 = bytes

263243 | otherwise = bytes + 1

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

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

244+ p = do getByteString (fromIntegral bytes)

245+ getBits (fromIntegral bits) :: BitGet Word8

266246 fail errMsg0

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

268248 in case r of

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

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

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

396376

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+

397382data Primitive

398383 = Bool Bool

399384 | W8 Int Word8

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

402387 | W64 Int Word64

403388 | BS Int B.ByteString

404389 | LBS Int L.ByteString

405− | Skip Int

406390 | IsEmpty

407391 deriving (Eq, Show)

408392

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

421405 , gen W16

422406 , gen W32

423407 , gen W64

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

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

426409 cs <- vector n

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

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

438421 W16 _ x -> snk W16 x

439422 W32 _ x -> snk W32 x

440423 W64 _ x -> snk W64 x

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

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

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

444426 IsEmpty -> []

445427

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−

454428prop_primitive :: Primitive -> Property

455429prop_primitive prim = property $

456430 let p = putPrimitive prim

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

475449 W16 n x -> putWord16 n x

476450 W32 n x -> putWord32 n x

477451 W64 n x -> putWord64 n x

478− Skip n -> skipBits n

479452 BS _ bs -> putByteString bs

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

481454 IsEmpty -> return ()

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

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

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

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

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

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

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

494466 IsEmpty -> isEmpty >> return IsEmpty

495467

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

507468

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

509470verifyProgram totalLength ps0 = go 0 ps0

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

511472 go _ [] = return True

512473 go pos (p:ps) =

513474 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 (getWord16 n) >> go (pos+n) ps

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

479+ W64 n x -> check x (getWord64 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

514482 IsEmpty -> do

515483 let expected = pos == totalLength

516484 actual <- isEmpty

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

518486 then go pos ps

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

520488 ++ show expected ++ " but got " ++ show actual

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

522489 check x g = do

523490 y <- g

524491 if x == y

Data/Binary/Bits/Alignment.hsdeleted−22

@@ -1,22 +0,0 @@

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

1919--

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

2121-- - BB: ABCDEVWX YZxxxxxx

22−-- - LL: XYZABCDE xxxxxxVW

22+-- - LB: XYZABCDE xxxxxxVW

2323-- - BL: EDCBAZYX WVxxxxxx

24−-- - LB: XWVEDCBA xxxxxxZY

24+-- - LL: XWVEDCBA xxxxxxZY

2525data BitOrder

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

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

Data/Binary/Bits/Get.hs+30−54

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

6060

6161 -- ** Get bytes

6262 , getBool

63− , getBool#

6463 , getWord8

6564 , getWord16

6665 , getWord32

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

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

10099import Data.Binary.Bits.BitOrder

101100import Data.Binary.Bits.Internal

102−import Data.Binary.Bits.Alignment

103101

104102import Data.ByteString as B

105103import qualified Data.ByteString.Lazy as L

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

115113import Control.Monad (when,foldM_)

116114

117115import Prelude as P

118−import GHC.Word

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

120116

121117-- $bitget

122118-- Parse bits using a monad.

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

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

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

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

185− LL -> testBit (unsafeHead bs) o

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

182+ LL -> testBit (unsafeHead bs) o

199183

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

201185--

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

218202

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

220204 off i = case bo of

221− LL -> 8*i - o

222205 LB -> 8*i - o

206+ LL -> 8*i - o

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

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

225209

226210 -- reverse bits if necessary

227211 rev = case bo of

228− LB -> reverseBits n

212+ LL -> reverseBits n

229213 BL -> reverseBits n

230214 BB -> id

231− LL -> id

215+ LB -> id

232216

233217

234218-- | Generic readWord

@@ -249,23 +233,22 @@ readWordChecked m n s

249233--

250234-- Examples:

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

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

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

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

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

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

255239readByteString :: Int -> S -> ByteString

256240readByteString n (S bs o bo) =

257241 let

258− bs' = unsafeTake (n+1) bs

259− bs'' = unsafeTake n bs

260− rev = B.map (reverseBits 8)

242+ bs' = unsafeTake (n+1) bs

243+ rev = B.map (reverseBits 8)

261244 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)

245+ (0,BB) -> unsafeTake n bs

246+ (0,LB) -> B.reverse (unsafeTake n bs)

247+ (0,BL) -> rev (unsafeTake n bs)

248+ (0,LL) -> rev (B.reverse (unsafeTake n bs))

249+ (_,BL) -> rev (readByteString n (S (B.reverse bs') o LB))

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

251+ (_,LB) -> readByteString n (S (B.reverse bs') o BB)

269252 (_,BB) -> unsafePerformIO $ do

270253 let len = n+1

271254 ptr <- mallocBytes len

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

287270

288271instance Monad BitGet where

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

273+ fail str = B $ \s -> putBackState s >> fail str

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

291275 runState (g a) s'

292276

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

306290 (S _ _ bo) <- getState

307291 return bo

308292

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−

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

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

325295runBitGet :: BitGet a -> Get a

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

367337 put B.empty

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

369339

340+-- | Skip the given number of bits

341+skipBits :: Int -> BitGet ()

342+skipBits n = do

343+ ensureBits n

344+ withState (incS n)

345+

346+-- | Skip bits if necessary to align to the next byte

347+alignByte :: BitGet ()

348+alignByte = do

349+ (S _ o _) <- getState

350+ when (o /= 0) $

351+ skipBits (8-o)

352+

353+

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

371355-- undecoded bytes.

372356isEmpty :: BitGet Bool

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

378362getBool :: BitGet Bool

379363getBool = block bool

380364

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

382−getBool# :: BitGet Int

383−getBool# = block bool#

384−

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

386366getWord8 :: Int -> BitGet Word8

387367getWord8 n = block (word8 n)

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

457437bool :: Block Bool

458438bool = Block 1 readBool

459439

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

461−bool# :: Block Int

462−bool# = Block 1 readBool#

463−

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

465441word8 :: Int -> Block Word8

466442word8 n = Block n (readWordChecked 8 n)

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

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

1212

1313module Data.Binary.Bits.Internal

1414 ( make_mask

15− , make_mask#

1615 , mask

17− , mask#

1816 , bit_offset

1917 , byte_offset

2018 , reverseBits

21− , reverseBits#

2219 , FastBits(..)

2320 )

2421where

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

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

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

4340

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

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

46−

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

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

4943mask n v = v .&. make_mask n

5044{-# INLINE mask #-}

5145

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−

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

5747bit_offset :: Int -> Int

5848bit_offset n = make_mask 3 .&. n

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

7565 rec 0 i r = r `fastShiftL` i

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

7767

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−

8968

9069---------------------------------------------------------------------

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

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

137116shiftr_w64 :: Word64 -> Int -> Word64

138117

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

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

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

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

143122

144−shiftr_w8 w i = w `unsafeShiftR` i

145−shiftr_w16 w i = w `unsafeShiftR` i

146−shiftr_w32 w i = w `unsafeShiftR` i

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

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

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

147126

148127

149128#if WORD_SIZE_IN_BITS < 64

Data/Binary/Bits/Put.hs+22−96

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

1−{-# LANGUAGE MagicHash #-}

2−

31-----------------------------------------------------------------------------

42-- |

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

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

2220 -- * Data types

2321 -- ** Bool

2422 , putBool

25− , putBool#

2623

2724 -- ** Words

28− , putWord#

2925 , putWord8

3026 , putWord16

3127 , putWord32

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

4541import Data.Binary.Put ( Put )

4642import Data.Binary.Bits.Internal

4743import Data.Binary.Bits.BitOrder

48−import Data.Binary.Bits.Alignment

4944

5045import Data.ByteString as BS

5146import Data.ByteString.Unsafe as BS

5247

53−import Control.Monad (when)

48+import Control.Applicative

5449import Data.Bits

50+import Data.Monoid

5551import Data.Word

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

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

5852

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

6054

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

6660putBool :: Bool -> BitPut ()

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

6862

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

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

71−putBool# b = putWord# 1# b

72−

7363

7464-- | Generic putWord

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

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

7767

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

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

80−

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

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

8370 where

@@ -95,9 +82,9 @@ putWordS n w s@(S builder b o bo) = s'

9582 -- Word containing the remaining (n-cn) bits to store in its LSB

9683 w' = case bo of

9784 BB -> w

98− BL -> w `fastShiftR` cn

85+ BL -> w

86+ LB -> w `fastShiftR` cn

9987 LL -> w `fastShiftR` cn

100− LB -> w

10188

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

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

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

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

10693 selectBits x = fromIntegral $ case bo of

10794 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

95+ BL -> reverseBits cn $ mask cn $ x `fastShiftR` (n-cn)

96+ LB -> mask cn x

97+ LL -> reverseBits cn $ mask cn x

11198

11299 -- shift left at the correct position

113100 shl :: Word8 -> Word8

114101 shl x = case bo of

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

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

117− LL -> x `fastShiftL` o

118104 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

105+ LL -> x `fastShiftL` o

166106

167107 flush s2@(S b2 w2 o2 bo2)

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

@@ -201,26 +141,27 @@ putWord64be = putWord

201141--

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

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

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

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

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

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

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

207147putByteString :: ByteString -> BitPut ()

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

209149

210150putByteStringS :: ByteString -> S -> S

211−putByteStringS bs s

151+putByteStringS bs (S builder b 0 BB) = S (builder `mappend` B.fromByteString bs) b 0 BB

152+putByteStringS bs s@(S _ _ _ BB)

212153 | 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)

154+ | otherwise = putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)

155+putByteStringS bs (S builder b o bo) = putByteStringS bs' (S builder b o BB)

222156 where

223− rev = BS.map (reverseBits 8)

157+ rev = BS.map (reverseBits 8)

158+

159+ bs' = case bo of

160+ BL -> BS.reverse (rev bs)

161+ LB -> BS.reverse bs

162+ LL -> rev bs

163+ BB -> bs -- should not occur, already matched but the compiler doesn't detect it

164+

224165

225166

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

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

238179 | o == 0 = s

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

240181

241−getOffset :: BitPut Int

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

243−

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

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

246184runBitPut m = Put.putBuilder b

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

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

272210

273211 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+2−4

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

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

22name: binary-bits

3−version: 0.6

3+version: 0.5.1

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.

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

2525 exposed-modules: Data.Binary.Bits ,

2626 Data.Binary.Bits.Put ,

2727 Data.Binary.Bits.Get ,

28− Data.Binary.Bits.BitOrder ,

29− Data.Binary.Bits.Alignment

28+ Data.Binary.Bits.BitOrder

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

3130

3231 default-language: Haskell98

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

3736 type: exitcode-stdio-1.0

3837 main-is: BitsQC.hs

3938 default-language: Haskell98

40− --ghc-options: -O2 -Wall

4139

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

4341 QuickCheck>=2, random,

flake.lockdeleted−59

@@ -1,59 +0,0 @@

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.nixdeleted−24

@@ -1,24 +0,0 @@

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.yamldeleted−66

@@ -1,66 +0,0 @@

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.lockdeleted−12

@@ -1,12 +0,0 @@

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