master..858e615 · binary-bits

git.iko.soy/binary-bits

9 files changed+32−295

unifiedsplit

.gitignore−1 Data/Binary/Bits/BitOrder.hs+2−2 Data/Binary/Bits/Get.hs+11−33 Data/Binary/Bits/Internal.hs+6−27 Data/Binary/Bits/Put.hs+13−71 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

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+11−33

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

6060

6161 -- ** Get bytes

6262 , getBool

63− , getBool#

6463 , getWord8

6564 , getWord16

6665 , getWord32

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

115114import Control.Monad (when,foldM_)

116115

117116import Prelude as P

118−import GHC.Word

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

120117

121118-- $bitget

122119-- Parse bits using a monad.

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

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

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

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

185− LL -> testBit (unsafeHead bs) o

186182 LB -> testBit (unsafeHead bs) o

187−

188−-- | Read a single bit

189−readBool# :: S -> Int

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

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

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

193− LL -> testBit# o

194− LB -> testBit# o

195− where

196− !(W8# w) = unsafeHead bs

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

198−

183+ LL -> testBit (unsafeHead bs) o

199184

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

201186--

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

218203

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

220205 off i = case bo of

221− LL -> 8*i - o

222206 LB -> 8*i - o

207+ LL -> 8*i - o

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

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

225210

226211 -- reverse bits if necessary

227212 rev = case bo of

228− LB -> reverseBits n

213+ LL -> reverseBits n

229214 BL -> reverseBits n

230215 BB -> id

231− LL -> id

216+ LB -> id

232217

233218

234219-- | Generic readWord

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

249234--

250235-- Examples:

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

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

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

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

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

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

255240readByteString :: Int -> S -> ByteString

256241readByteString n (S bs o bo) =

257242 let

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

260245 rev = B.map (reverseBits 8)

261246 in case (o,bo) of

262247 (0,BB) -> bs''

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

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

248+ (0,LB) -> B.reverse bs''

249+ (0,LL) -> rev bs''

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

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

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

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

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

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

269254 (_,BB) -> unsafePerformIO $ do

270255 let len = n+1

271256 ptr <- mallocBytes len

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

287272

288273instance Monad BitGet where

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

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

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

291277 runState (g a) s'

292278

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

378364getBool :: BitGet Bool

379365getBool = block bool

380366

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

382−getBool# :: BitGet Int

383−getBool# = block bool#

384−

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

386368getWord8 :: Int -> BitGet Word8

387369getWord8 n = block (word8 n)

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

457439bool :: Block Bool

458440bool = Block 1 readBool

459441

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

461−bool# :: Block Int

462−bool# = Block 1 readBool#

463−

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

465443word8 :: Int -> Block Word8

466444word8 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+13−71

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

@@ -50,11 +46,11 @@ import Data.Binary.Bits.Alignment

5046import Data.ByteString as BS

5147import Data.ByteString.Unsafe as BS

5248

49+import Control.Applicative

5350import Control.Monad (when)

5451import Data.Bits

52+import Data.Monoid

5553import Data.Word

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

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

5854

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

6056

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

6662putBool :: Bool -> BitPut ()

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

6864

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

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

71−putBool# b = putWord# 1# b

72−

7365

7466-- | Generic putWord

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

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

7769

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

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

80−

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

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

8372 where

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

9685 w' = case bo of

9786 BB -> w

9887 BL -> w `fastShiftR` cn

99− LL -> w `fastShiftR` cn

100− LB -> w

88+ LB -> w `fastShiftR` cn

89+ LL -> w

10190

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

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

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

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

10695 selectBits x = fromIntegral $ case bo of

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

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

109− LL -> mask cn x

97+ LL -> reverseBits cn $ mask cn $ x `fastShiftR` (n-cn)

98+ LB -> mask cn x

11099 BL -> reverseBits cn $ mask cn x

111100

112101 -- shift left at the correct position

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

114103 shl x = case bo of

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

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

117− LL -> x `fastShiftL` o

118106 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

107+ LL -> x `fastShiftL` o

166108

167109 flush s2@(S b2 w2 o2 bo2)

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

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

201143--

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

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

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

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

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

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

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

207149putByteString :: ByteString -> BitPut ()

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

209151

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

212154 | BS.null bs = s

213155 | otherwise = case s of

214156 (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

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

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

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

218160 (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)

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

220162 (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)

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

222164 where

223165 rev = BS.map (reverseBits 8)

224166

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