master..ed53a4b · binary-bits

git.iko.soy/binary-bits

13 files changed+402−920

unifiedsplit

.gitignore−1 BitsQC.hs+41−74 Data/Binary/Bits.hs+6−6 Data/Binary/Bits/Alignment.hs−22 Data/Binary/Bits/BitOrder.hs−47 Data/Binary/Bits/Get.hs+277−241 Data/Binary/Bits/Internal.hs−176 Data/Binary/Bits/Put.hs+76−186 binary-bits.cabal+2−6 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+41−74

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

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

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

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

290270 let p = do putBool b

291− putWord16 15 w

271+ putWord16be 15 w

292272 g = do v <- getBool

293273 case v of

294− True -> getWord16 15

274+ True -> getWord16be 15

295275 False -> do

296276 msb <- getWord8 7

297277 lsb <- getWord8 8

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

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

411395instance Arbitrary Primitive where

412396 arbitrary = do

413397 let gen c = do

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

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

415399 bits <- choose (0, maxBits)

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

417401 return (c bits n)

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

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

472446 case p of

473447 Bool b -> putBool b

474448 W8 n x -> putWord8 n x

475− W16 n x -> putWord16 n x

476− W32 n x -> putWord32 n x

477− W64 n x -> putWord64 n x

478− Skip n -> skipBits n

449+ W16 n x -> putWord16be n x

450+ W32 n x -> putWord32be n x

451+ W64 n x -> putWord64be n x

479452 BS _ bs -> putByteString bs

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

481454 IsEmpty -> return ()

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

485458 case p of

486459 Bool _ -> Bool <$> getBool

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

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

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

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

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

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

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

463+ W64 n _ -> W64 n <$> getWord64be 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 (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

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

@@ -33,13 +33,13 @@ instance BinaryBit Word8 where

3333 getBits = getWord8

3434

3535instance BinaryBit Word16 where

36− putBits = putWord16

37− getBits = getWord16

36+ putBits = putWord16be

37+ getBits = getWord16be

3838

3939instance BinaryBit Word32 where

40− putBits = putWord32

41− getBits = getWord32

40+ putBits = putWord32be

41+ getBits = getWord32be

4242

4343instance BinaryBit Word64 where

44− putBits = putWord64

45− getBits = getWord64

44+ putBits = putWord64be

45+ getBits = getWord64be

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.hsdeleted−47

@@ -1,47 +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.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+277−241

@@ -4,7 +4,6 @@

44-- |

55-- Module : Data.Binary.Bits.Get

66-- Copyright : (c) Lennart Kolmodin 2010-2011

7−-- (c) Sylvain Henry 2015

87-- License : BSD3-style (see LICENSE)

98--

109-- Maintainer : kolmodin@gmail.com

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

6059

6160 -- ** Get bytes

6261 , getBool

63− , getBool#

6462 , getWord8

65− , getWord16

66− , getWord32

67− , getWord64

6863 , getWord16be

6964 , getWord32be

7065 , getWord64be

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

8277 -- ** Read in Blocks

8378 , bool

8479 , word8

85− , word16

86− , word32

87− , word64

8880 , word16be

8981 , word32be

9082 , word64be

@@ -97,26 +89,23 @@ module Data.Binary.Bits.Get

9789

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

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

10392

10493import Data.ByteString as B

10594import qualified Data.ByteString.Lazy as L

10695import Data.ByteString.Unsafe

107−import Foreign.Marshal.Alloc (mallocBytes)

108−import Foreign.Ptr

109−import Foreign.Storable (poke)

110−import System.IO.Unsafe (unsafePerformIO)

11196

11297import Data.Bits

11398import Data.Word

11499import Control.Applicative

115−import Control.Monad (when,foldM_)

100+import Control.Monad (when)

116101

117102import Prelude as P

103+

104+#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)

105+import GHC.Base

118106import GHC.Word

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

107+#endif

108+

120109

121110-- $bitget

122111-- Parse bits using a monad.

@@ -165,120 +154,195 @@ import GHC.Base (uncheckedShiftLWord8#, wordToWord8#, Int (..), andWord8#, Word8

165154-- @

166155

167156data S = S {-# UNPACK #-} !ByteString -- Input

168− {-# UNPACK #-} !Int -- Bit offset (0-7)

169− !BitOrder -- Bit order

157+ {-# UNPACK #-} !Int -- Bit offset (0-7)

170158 deriving (Show)

171159

172−-- | Increment the current bit offset

160+-- | A block that will be read with only one boundry check. Needs to know the

161+-- number of bits in advance.

162+data Block a = Block Int (S -> a)

163+

164+instance Functor Block where

165+ fmap f (Block i p) = Block i (\s -> f (p s))

166+

167+instance Applicative Block where

168+ pure a = Block 0 (\_ -> a)

169+ (Block i p) <*> (Block j q) = Block (i+j) (\s -> p s $ q (incS i s))

170+ (Block i _) *> (Block j q) = Block (i+j) (q . incS i)

171+ (Block i p) <* (Block j _) = Block (i+j) p

172+

173+-- | Get a block. Will be read with one single boundry check, and

174+-- therefore requires a statically known number of bits.

175+-- Build blocks using 'bool', 'word8', 'word16be', 'word32be', 'word64be',

176+-- 'byteString' and 'Applicative'.

177+block :: Block a -> BitGet a

178+block (Block i p) = do

179+ ensureBits i

180+ s <- getState

181+ putState $! (incS i s)

182+ return $! p s

183+

173184incS :: Int -> S -> S

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

175− where

176− !o' = (n+o)

177− !d = byte_offset o'

178− !n' = bit_offset o'

185+incS o (S bs n) =

186+ let !o' = (n+o)

187+ !d = o' `shiftR` 3

188+ !n' = o' .&. make_mask 3

189+ in S (unsafeDrop d bs) n'

190+

191+-- | make_mask 3 = 00000111

192+make_mask :: (Bits a, Num a) => Int -> a

193+make_mask n = (1 `shiftL` fromIntegral n) - 1

194+{-# SPECIALIZE make_mask :: Int -> Int #-}

195+{-# SPECIALIZE make_mask :: Int -> Word #-}

196+{-# SPECIALIZE make_mask :: Int -> Word8 #-}

197+{-# SPECIALIZE make_mask :: Int -> Word16 #-}

198+{-# SPECIALIZE make_mask :: Int -> Word32 #-}

199+{-# SPECIALIZE make_mask :: Int -> Word64 #-}

200+

201+bit_offset :: Int -> Int

202+bit_offset n = make_mask 3 .&. n

203+

204+byte_offset :: Int -> Int

205+byte_offset n = n `shiftR` 3

179206

180−-- | Read a single bit

181207readBool :: S -> Bool

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

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

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

185− LL -> testBit (unsafeHead bs) o

186− LB -> testBit (unsafeHead bs) o

187−

188−-- | Read a single bit

189−readBool# :: S -> Int

190−readBool# (S bs (I# o) bo) = case bo of

191− BB -> testBit# (7# -# o)

192− BL -> testBit# (7# -# o)

193− LL -> testBit# o

194− LB -> testBit# o

195− where

196− !(W8# w) = unsafeHead bs

197− testBit# n = I# (((w `andWord8#` (wordToWord8# 1## `uncheckedShiftLWord8#` n)) `eqWord8#` wordToWord8# 0##) `xorI#` 1#)

198−

199−

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

201−--

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

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

204−extract bo bs o n

205− | n == 0 = 0

206− | B.length bs == 0 = error "Empty ByteString"

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

208− where

209− -- B.foldl' with index

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

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

212−

213− -- 'or' correctly shifted words

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

215−

216− -- co-offset

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

218−

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

220− off i = case bo of

221− LL -> 8*i - o

222− LB -> 8*i - o

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

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

225−

226− -- reverse bits if necessary

227− rev = case bo of

228− LB -> reverseBits n

229− BL -> reverseBits n

230− BB -> id

231− LL -> id

232−

233−

234−-- | Generic readWord

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

236−readWord n (S bs o bo)

237− | n == 0 = 0

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

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

240−

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

242−{-# INLINE readWordChecked #-}

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

244−readWordChecked m n s

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

246− | otherwise = readWord n s

247−

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

249−--

250−-- Examples:

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

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

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

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

208+readBool (S bs n) = testBit (unsafeHead bs) (7-n)

209+

210+{-# INLINE readWord8 #-}

211+readWord8 :: Int -> S -> Word8

212+readWord8 n (S bs o)

213+ -- no bits at all, return 0

214+ | n == 0 = 0

215+

216+ -- all bits are in the same byte

217+ -- we just need to shift and mask them right

218+ | n <= 8 - o = let w = unsafeHead bs

219+ m = make_mask n

220+ w' = (w `shiftr_w8` (8 - o - n)) .&. m

221+ in w'

222+

223+ -- the bits are in two different bytes

224+ -- make a word16 using both bytes, and then shift and mask

225+ -- n <= 8

226+ | otherwise = let

227+ w = (fromIntegral (unsafeHead bs) `shiftl_w16` 8) .|.

228+ (fromIntegral (unsafeIndex bs 1))

229+ m = make_mask n

230+ w' = (w `shiftr_w16` (16 - o - n)) .&. m

231+ in fromIntegral w'

232+

233+{-# INLINE readWord16be #-}

234+readWord16be :: Int -> S -> Word16

235+readWord16be n s@(S bs o)

236+

237+ -- 8 or fewer bits, use readWord8

238+ | n <= 8 = fromIntegral (readWord8 n s)

239+

240+ -- handle 9 or more bits, stored in two bytes

241+

242+ -- no offset, plain and simple 16 bytes

243+ | o == 0 && n == 16 = let msb = fromIntegral (unsafeHead bs)

244+ lsb = fromIntegral (unsafeIndex bs 1)

245+ w = (msb `shiftl_w16` 8) .|. lsb

246+ in w

247+

248+ -- no offset, but not full 16 bytes

249+ | o == 0 = let msb = fromIntegral (unsafeHead bs)

250+ lsb = fromIntegral (unsafeIndex bs 1)

251+ w = (msb `shiftl_w16` (n-8)) .|. (lsb `shiftr_w16` (16-n))

252+ in w

253+

254+ -- with offset, and n=9-16

255+ | n <= 16 = readWithOffset s shiftl_w16 shiftr_w16 n

256+

257+ | otherwise = error "readWord16be: tried to read more than 16 bits"

258+

259+{-# INLINE readWord32be #-}

260+readWord32be :: Int -> S -> Word32

261+readWord32be n s@(S _ o)

262+ -- 8 or fewer bits, use readWord8

263+ | n <= 8 = fromIntegral (readWord8 n s)

264+

265+ -- 16 or fewer bits, use readWord16be

266+ | n <= 16 = fromIntegral (readWord16be n s)

267+

268+ | o == 0 = readWithoutOffset s shiftl_w32 shiftr_w32 n

269+

270+ | n <= 32 = readWithOffset s shiftl_w32 shiftr_w32 n

271+

272+ | otherwise = error "readWord32be: tried to read more than 32 bits"

273+

274+

275+{-# INLINE readWord64be #-}

276+readWord64be :: Int -> S -> Word64

277+readWord64be n s@(S _ o)

278+ -- 8 or fewer bits, use readWord8

279+ | n <= 8 = fromIntegral (readWord8 n s)

280+

281+ -- 16 or fewer bits, use readWord16be

282+ | n <= 16 = fromIntegral (readWord16be n s)

283+

284+ | o == 0 = readWithoutOffset s shiftl_w64 shiftr_w64 n

285+

286+ | n <= 64 = readWithOffset s shiftl_w64 shiftr_w64 n

287+

288+ | otherwise = error "readWord64be: tried to read more than 64 bits"

289+

290+

255291readByteString :: Int -> S -> ByteString

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)

292+readByteString n s@(S bs o)

293+ -- no offset, easy.

294+ | o == 0 = unsafeTake n bs

295+ -- offset. ugg. this is really naive and slow. but also pretty easy :)

296+ | otherwise = B.pack (P.map (readWord8 8) (P.take n (iterate (incS 8) s)))

297+

298+readWithoutOffset :: (Bits a, Num a)

299+ => S -> (a -> Int -> a) -> (a -> Int -> a) -> Int -> a

300+readWithoutOffset (S bs o) shifterL shifterR n

301+ | o /= 0 = error "readWithoutOffset: there is an offset"

302+

303+ | bit_offset n == 0 && byte_offset n <= 4 =

304+ let segs = byte_offset n

305+ bn 0 = fromIntegral (unsafeHead bs)

306+ bn m = (bn (m-1) `shifterL` 8) .|. fromIntegral (unsafeIndex bs m)

307+

308+ in bn (segs-1)

309+

310+ -- n <= 64

311+ | otherwise = let segs = byte_offset n

312+ o' = bit_offset (n - 8 + o)

313+

314+ bn 0 = fromIntegral (unsafeHead bs)

315+ bn m = (bn (m-1) `shifterL` 8) .|. fromIntegral (unsafeIndex bs m)

316+

317+ msegs = bn (segs-1) `shifterL` o'

318+

319+ lst = (fromIntegral (unsafeIndex bs segs)) `shifterR` (8 - o')

320+

321+ w = msegs .|. lst

322+ in w

281323

324+readWithOffset :: (Bits a, Num a)

325+ => S -> (a -> Int -> a) -> (a -> Int -> a) -> Int -> a

326+readWithOffset (S bs o) shifterL shifterR n

327+ | n <= 64 = let bits_in_msb = 8 - o

328+ (n',top) = (n - bits_in_msb

329+ , (fromIntegral (unsafeHead bs) .&. make_mask bits_in_msb) `shifterL` n')

330+

331+ segs = byte_offset n'

332+

333+ bn 0 = 0

334+ bn m = (bn (m-1) `shifterL` 8) .|. fromIntegral (unsafeIndex bs m)

335+

336+ o' = bit_offset n'

337+

338+ mseg = bn segs `shifterL` o'

339+

340+ lst | o' > 0 = (fromIntegral (unsafeIndex bs (segs + 1))) `shifterR` (8 - o')

341+ | otherwise = 0

342+

343+ w = top .|. mseg .|. lst

344+ in w

345+ | otherwise = error $ "Invalid offset (" ++ show n ++ " > 64)"

282346

283347------------------------------------------------------------------------

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

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

287351

288352instance Monad BitGet where

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

354+ fail str = B $ \(S inp n) -> putBackState inp n >> fail str

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

291356 runState (g a) s'

292357

@@ -297,51 +362,25 @@ instance Applicative BitGet where

297362 pure x = return x

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

299364

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−

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

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

325367runBitGet :: BitGet a -> Get a

326368runBitGet bg = do

327369 s <- mkInitState

328− (s',a) <- runState bg s

329− putBackState s'

370+ ((S str' n),a) <- runState bg s

371+ putBackState str' n

330372 return a

331373

332374mkInitState :: Get S

333375mkInitState = do

334− bs <- get

376+ str <- get

335377 put B.empty

336− return (S bs 0 BB)

378+ return (S str 0)

337379

338−putBackState :: S -> Get ()

339−putBackState (S bs o _) = do

380+putBackState :: B.ByteString -> Int -> Get ()

381+putBackState bs n = do

340382 remaining <- get

341− let bs' = case o of

342− 0 -> bs

343− _ -> unsafeDrop 1 bs

344− put (bs' `B.append` remaining)

383+ put (B.drop (if n==0 then 0 else 1) bs `B.append` remaining)

345384

346385getState :: BitGet S

347386getState = B $ \s -> return (s,s)

@@ -349,66 +388,52 @@ getState = B $ \s -> return (s,s)

349388putState :: S -> BitGet ()

350389putState s = B $ \_ -> return (s,())

351390

352−withState :: (S -> S) -> BitGet ()

353−withState f = do

354− s <- getState

355− putState $! f s

356−

357391-- | Make sure there are at least @n@ bits.

358392ensureBits :: Int -> BitGet ()

359393ensureBits n = do

360− (S bs o bo) <- getState

394+ (S bs o) <- getState

361395 if n <= (B.length bs * 8 - o)

362396 then return ()

363397 else do let currentBits = B.length bs * 8 - o

364− let byteCount = byte_offset (n - currentBits + 7)

398+ let byteCount = (n - currentBits + 7) `div` 8

365399 B $ \_ -> do B.ensureN byteCount

366400 bs' <- B.get

367401 put B.empty

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

402+ return (S (bs`append`bs') o, ())

369403

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

371−-- undecoded bytes.

372−isEmpty :: BitGet Bool

373−isEmpty = B $ \ (S bs o bo) -> if B.null bs

374− then B.isEmpty >>= \e -> return (S bs o bo, e)

375− else return (S bs o bo, False)

404+-- | Skip the given number of bits

405+skipBits :: Int -> BitGet ()

406+skipBits n = do

407+ ensureBits n

408+ s <- getState

409+ putState $! (incS n s)

410+

411+-- | Skip bits if necessary to align on a byte

412+alignByte :: BitGet ()

413+alignByte = do

414+ (S _ n) <- getState

415+ when (n /= 0) $

416+ skipBits (8-n)

376417

377418-- | Get 1 bit as a 'Bool'.

378419getBool :: BitGet Bool

379420getBool = block bool

380421

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

382−getBool# :: BitGet Int

383−getBool# = block bool#

384−

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

386423getWord8 :: Int -> BitGet Word8

387424getWord8 n = block (word8 n)

388425

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

390−getWord16 :: Int -> BitGet Word16

391−getWord16 n = block (word16 n)

392−

393427getWord16be :: Int -> BitGet Word16

394−getWord16be = getWord16

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

428+getWord16be n = block (word16be n)

396429

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

398−getWord32 :: Int -> BitGet Word32

399−getWord32 n = block (word32 n)

400−

401431getWord32be :: Int -> BitGet Word32

402−getWord32be = getWord32

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

432+getWord32be n = block (word32be n)

404433

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

406−getWord64 :: Int -> BitGet Word64

407−getWord64 n = block (word64 n)

408−

409435getWord64be :: Int -> BitGet Word64

410−getWord64be = getWord64

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

436+getWord64be n = block (word64be n)

412437

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

414439getByteString :: Int -> BitGet ByteString

@@ -417,80 +442,91 @@ getByteString n = block (byteString n)

417442-- | Get @n@ bytes as a lazy ByteString.

418443getLazyByteString :: Int -> BitGet L.ByteString

419444getLazyByteString n = do

420− (S _ o bo) <- getState

445+ (S _ o) <- getState

421446 case o of

422− 0 -> B $ \s -> do

423− putBackState s

447+ 0 -> B $ \ (S bs o') -> do

448+ putBackState bs o'

424449 lbs <- B.getLazyByteString (fromIntegral n)

425− return (S B.empty 0 bo, lbs)

450+ return (S B.empty 0, lbs)

426451 _ -> L.fromChunks . (:[]) <$> Data.Binary.Bits.Get.getByteString n

427452

428−

429−

430−

431−

432−-- | A block that will be read with only one boundary check. Needs to know the

433−-- number of bits in advance.

434−data Block a = Block Int (S -> a)

435−

436−instance Functor Block where

437− fmap f (Block i p) = Block i (\s -> f (p s))

438−

439−instance Applicative Block where

440− pure a = Block 0 (\_ -> a)

441− (Block i p) <*> (Block j q) = Block (i+j) (\s -> p s $ q (incS i s))

442− (Block i _) *> (Block j q) = Block (i+j) (q . incS i)

443− (Block i p) <* (Block j _) = Block (i+j) p

444−

445−-- | Get a block. Will be read with one single boundry check, and

446−-- therefore requires a statically known number of bits.

447−-- Build blocks using 'bool', 'word8', 'word16be', 'word32be', 'word64be',

448−-- 'byteString' and 'Applicative'.

449−block :: Block a -> BitGet a

450−block (Block i p) = do

451− ensureBits i

452− s <- getState

453− putState $! (incS i s)

454− return $! p s

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

454+-- undecoded bytes.

455+isEmpty :: BitGet Bool

456+isEmpty = B $ \ (S bs o) -> if B.null bs

457+ then B.isEmpty >>= \e -> return (S bs o, e)

458+ else return (S bs o, False)

455459

456460-- | Read a 1 bit 'Bool'.

457461bool :: Block Bool

458462bool = Block 1 readBool

459463

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

461−bool# :: Block Int

462−bool# = Block 1 readBool#

463−

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

465465word8 :: Int -> Block Word8

466−word8 n = Block n (readWordChecked 8 n)

466+word8 n = Block n (readWord8 n)

467467

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

472469word16be :: Int -> Block Word16

473−word16be = word16

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

470+word16be n = Block n (readWord16be n)

475471

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

480473word32be :: Int -> Block Word32

481−word32be = word32

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

474+word32be n = Block n (readWord32be n)

483475

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

488477word64be :: Int -> Block Word64

489−word64be = word64

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

478+word64be n = Block n (readWord64be n)

491479

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

493481byteString :: Int -> Block ByteString

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

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

496484

485+------------------------------------------------------------------------

486+-- Unchecked shifts, from the package binary

487+

488+shiftl_w16 :: Word16 -> Int -> Word16

489+shiftl_w32 :: Word32 -> Int -> Word32

490+shiftl_w64 :: Word64 -> Int -> Word64

491+

492+shiftr_w8 :: Word8 -> Int -> Word8

493+shiftr_w16 :: Word16 -> Int -> Word16

494+shiftr_w32 :: Word32 -> Int -> Word32

495+shiftr_w64 :: Word64 -> Int -> Word64

496+

497+#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)

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

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

500+

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

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

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

504+

505+

506+#if WORD_SIZE_IN_BITS < 64

507+shiftl_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftL64#` i)

508+shiftr_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftRL64#` i)

509+

510+#if __GLASGOW_HASKELL__ <= 606

511+-- Exported by GHC.Word in GHC 6.8 and higher

512+foreign import ccall unsafe "stg_uncheckedShiftL64"

513+ uncheckedShiftL64# :: Word64# -> Int# -> Word64#

514+foreign import ccall unsafe "stg_uncheckedShiftRL64"

515+ uncheckedShiftRL64# :: Word64# -> Int# -> Word64#

516+#endif

517+

518+#else

519+shiftl_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftL#` i)

520+shiftr_w64 (W64# w) (I# i) = W64# (w `uncheckedShiftRL#` i)

521+#endif

522+

523+#else

524+shiftl_w16 = shiftL

525+shiftl_w32 = shiftL

526+shiftl_w64 = shiftL

527+

528+shiftr_w8 = shiftR

529+shiftr_w16 = shiftR

530+shiftr_w32 = shiftR

531+shiftr_w64 = shiftR

532+#endif

Data/Binary/Bits/Internal.hsdeleted−176

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

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

2−

3−-----------------------------------------------------------------------------

4−-- |

5−-- Module : Data.Binary.Bits.Get

6−-- Copyright : (c) Lennart Kolmodin 2010-2011

7−-- License : BSD3-style (see LICENSE)

8−--

9−-- Maintainer : kolmodin@gmail.com

10−-- Stability : experimental

11−-- Portability : portable (should run where the package binary runs)

12−

13−module Data.Binary.Bits.Internal

14− ( make_mask

15− , make_mask#

16− , mask

17− , mask#

18− , bit_offset

19− , byte_offset

20− , reverseBits

21− , reverseBits#

22− , FastBits(..)

23− )

24−where

25−

26−import Data.Word

27−import Data.Bits

28−

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

30−import GHC.Base

31−import GHC.Word

32−#endif

33−

34−-- | make_mask 3 = 00000111

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

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

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

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

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

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

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

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

43−

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

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

46−

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

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

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

50−{-# INLINE mask #-}

51−

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

53−mask# :: Int# -> Word# -> Word#

54−mask# n v = v `and#` make_mask# n

55−

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

57−bit_offset :: Int -> Int

58−bit_offset n = make_mask 3 .&. n

59−{-# INLINE bit_offset #-}

60−

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

62−byte_offset :: Int -> Int

63−byte_offset n = n `shiftR` 3

64−{-# INLINE byte_offset #-}

65−

66−-- | Reverse the @n@ least important bits of the given value

67−reverseBits :: (Num a, FastBits a, Bits a) => Int -> a -> a

68−reverseBits n value = rec value n 0

69− where

70− -- rec v i r, where

71− -- v is orginal value shifted

72− -- i is the remaining number of bits

73− -- r is current value

74− rec 0 0 r = r

75− rec 0 i r = r `fastShiftL` i

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

77−

78−reverseBits# :: Int# -> Word# -> Word#

79−reverseBits# n value = rec value n 0##

80− where

81− -- rec v i r, where

82− -- v is orginal value shifted

83− -- i is the remaining number of bits

84− -- r is current value

85− rec 0## 0# r = r

86− rec 0## i r = r `shiftL#` i

87− rec v i r = rec (v `shiftRL#` 1#) (i -# 1#) ((r `shiftL#` 1#) `or#` (v `and#` 0x1##))

88−

89−

90−---------------------------------------------------------------------

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

92−

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

94−class Bits a => FastBits a where

95− fastShiftR :: a -> Int -> a

96− fastShiftR = shiftR

97−

98− fastShiftL :: a -> Int -> a

99− fastShiftL = shiftL

100−

101− {-# INLINE fastShift #-}

102− fastShift :: a -> Int -> a

103− fastShift x n

104− | n > 0 = fastShiftL x n

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

106− | otherwise = x

107−

108−instance FastBits Word8 where

109− fastShiftR = shiftr_w8

110− fastShiftL = shiftl_w8

111−

112−instance FastBits Word16 where

113− fastShiftR = shiftr_w16

114− fastShiftL = shiftl_w16

115−

116−instance FastBits Word32 where

117− fastShiftR = shiftr_w32

118− fastShiftL = shiftl_w32

119−

120−instance FastBits Word64 where

121− fastShiftR = shiftr_w64

122− fastShiftL = shiftl_w64

123−

124−instance FastBits Int

125−

126−instance FastBits Word

127−

128−

129−shiftl_w8 :: Word8 -> Int -> Word8

130−shiftl_w16 :: Word16 -> Int -> Word16

131−shiftl_w32 :: Word32 -> Int -> Word32

132−shiftl_w64 :: Word64 -> Int -> Word64

133−

134−shiftr_w8 :: Word8 -> Int -> Word8

135−shiftr_w16 :: Word16 -> Int -> Word16

136−shiftr_w32 :: Word32 -> Int -> Word32

137−shiftr_w64 :: Word64 -> Int -> Word64

138−

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

140−shiftl_w8 w i = w `unsafeShiftL` i

141−shiftl_w16 w i = w `unsafeShiftL` i

142−shiftl_w32 w i = w `unsafeShiftL` i

143−

144−shiftr_w8 w i = w `unsafeShiftR` i

145−shiftr_w16 w i = w `unsafeShiftR` i

146−shiftr_w32 w i = w `unsafeShiftR` i

147−

148−

149−#if WORD_SIZE_IN_BITS < 64

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

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

152−

153−#if __GLASGOW_HASKELL__ <= 606

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

155−foreign import ccall unsafe "stg_uncheckedShiftL64"

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

157−foreign import ccall unsafe "stg_uncheckedShiftRL64"

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

159−#endif

160−

161−#else

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

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

164−#endif

165−

166−#else

167−shiftl_w8 = shiftL

168−shiftl_w16 = shiftL

169−shiftl_w32 = shiftL

170−shiftl_w64 = shiftL

171−

172−shiftr_w8 = shiftR

173−shiftr_w16 = shiftR

174−shiftr_w32 = shiftR

175−shiftr_w64 = shiftR

176−#endif

Data/Binary/Bits/Put.hs+76−186

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

1−{-# LANGUAGE MagicHash #-}

2−

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

42-- |

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

64-- Copyright : (c) Lennart Kolmodin 2010-2011

7−-- (c) Sylvain Henry 2015

85-- License : BSD3-style (see LICENSE)

96--

107-- Maintainer : kolmodin@gmail.com

@@ -22,14 +19,9 @@ module Data.Binary.Bits.Put

2219 -- * Data types

2320 -- ** Bool

2421 , putBool

25− , putBool#

2622

2723 -- ** Words

28− , putWord#

2924 , putWord8

30− , putWord16

31− , putWord32

32− , putWord64

3325 , putWord16be

3426 , putWord32be

3527 , putWord64be

@@ -43,210 +35,125 @@ import qualified Data.Binary.Builder as B

4335import Data.Binary.Builder ( Builder )

4436import qualified Data.Binary.Put as Put

4537import Data.Binary.Put ( Put )

46−import Data.Binary.Bits.Internal

47−import Data.Binary.Bits.BitOrder

48−import Data.Binary.Bits.Alignment

4938

50−import Data.ByteString as BS

51−import Data.ByteString.Unsafe as BS

39+import Data.ByteString

5240

53−import Control.Monad (when)

41+import Control.Applicative

5442import Data.Bits

43+import Data.Monoid

5544import Data.Word

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

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

5845

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

6047

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

6249

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

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

6451

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

6653putBool :: Bool -> BitPut ()

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

6855

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−

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

17165

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

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

174−putWord8 = putWord

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'

17581

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

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

178−putWord16 = putWord

179−

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

181−putWord16be = putWord

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

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

183105

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

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

186−putWord32 = putWord

187−

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

189−putWord32be = putWord

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

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)

191113

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

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

194−putWord64 = putWord

195−

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

197−putWord64be = putWord

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

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)

199121

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

207123putByteString :: ByteString -> BitPut ()

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−

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

225131

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

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

228−--

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

230134joinPut :: Put -> BitPut ()

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

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

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

233137 b = Put.execPut m

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

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

235145

236146flushIncomplete :: S -> S

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

147+flushIncomplete s@(S b w o)

238148 | o == 0 = s

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

149+ | otherwise = (S (b `mappend` B.singleton w) 0 0)

243150

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

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

246153runBitPut m = Put.putBuilder b

247154 where

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

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

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

156+ (S b _ _) = flushIncomplete s

250157

251158instance Functor BitPut where

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

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

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

267174 in PairS b s''

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

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

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,10 +24,7 @@ library

2424

2525 exposed-modules: Data.Binary.Bits ,

2626 Data.Binary.Bits.Put ,

27− Data.Binary.Bits.Get ,

28− Data.Binary.Bits.BitOrder ,

29− Data.Binary.Bits.Alignment

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

27+ Data.Binary.Bits.Get

3128

3229 default-language: Haskell98

3330

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

3734 type: exitcode-stdio-1.0

3835 main-is: BitsQC.hs

3936 default-language: Haskell98

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

4137

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

4339 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