git.iko.soy/rowtype-yoga/purescript-arraybuffer-builder
on master help sign in
14 files changed+285−272
since splitsnapshots
unifiedsplit
.github/workflows/ci.yml+46 .github/workflows/push-build.yml−42 CHANGELOG.md+14−1 DEVELOPMENT.md−43 README.md+56−32 bower.json+12−8 packages.dhall+2−2 psc-package.json−16 shell.nix−30 test.dhall → spago-dev.dhall+6−2 spago.dhall+4 src/Data/ArrayBuffer/Builder.purs+30−30 src/Data/ArrayBuffer/Internal.purs+63−45 test/Main.purs+52−21
.github/workflows/ci.ymlnew file+46
@@ -0,0 +1,46 @@
1+name: CI
2+
3+on:
4+ push:
5+ pull_request:
6+
7+jobs:
8+ build:
9+ runs-on: ubuntu-latest
10+
11+ steps:
12+ - uses: actions/checkout@v2
13+
14+ - name: Set up a PureScript toolchain
15+ uses: purescript-contrib/setup-purescript@main
16+ with:
17+ purescript: "unstable"
18+ purs-tidy: "latest"
19+
20+ - name: Cache PureScript dependencies
21+ uses: actions/cache@v2
22+ with:
23+ key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}-2
24+ path: |
25+ .spago
26+ output
27+ - name: Install dependencies
28+ run: spago install
29+
30+ - name: Build source
31+ run: spago build --no-install --purs-args '--censor-lib --strict --censor-codes='UserDefinedWarning''
32+
33+ - name: Install dev dependencies
34+ run: spago -x spago-dev.dhall install
35+
36+ - name: Run tests
37+ run: spago -x spago-dev.dhall test --no-install
38+
39+ - name: Check formatting
40+ run: purs-tidy check src test bench
41+
42+ - name: Verify Bower & Pulp
43+ run: |
44+ npm install bower pulp@16.0.0-0
45+ npx bower install
46+ npx pulp build -- --censor-lib --strict
.github/workflows/push-build.ymldeleted−42
@@ -1,42 +0,0 @@
1−name: CI
2−
3−on: [push]
4−
5−jobs:
6− build:
7−
8− runs-on: ubuntu-latest
9−
10− # https://github.com/purescript-contrib/setup-purescript
11−
12− steps:
13− # https://github.com/cachix/install-nix-action
14− - uses: actions/checkout@v2.3.4
15− - uses: cachix/install-nix-action@v13
16− with:
17− nix_path: nixpkgs=channel:nixos-unstable
18− - run: nix-shell --command 'spago --global-cache skip --config test.dhall test'
19−
20− # https://github.com/purescript-contrib/setup-purescript
21−
22− # - uses: actions/checkout@v2
23− # - name: Set up a PureScript toolchain
24− # uses: purescript-contrib/setup-purescript@main
25− # with:
26− # purescript: "0.14.1"
27− # spago: "0.20.1"
28−
29−# - name: Cache PureScript dependencies
30−# uses: actions/cache@v2
31−# # This cache uses the .dhall files to know when it should reinstall
32−# # and rebuild packages. It caches both the installed packages from
33−# # the `.spago` directory and compilation artifacts from the `output`
34−# # directory. When restored the compiler will rebuild any files that
35−# # have changed. If you do not want to cache compiled output, remove
36−# # the `output` path.
37−# with:
38−# key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
39−# path: |
40−# .spago
41−
42− # - run: spago -x test.dhall test
CHANGELOG.md+14−1
@@ -1,8 +1,21 @@
11# Changelog
22
3−## v3.0.0 2022-04-13
3+## v3.1.0 2022-12-10
4+
5+- Transfer to __rowtype-yoga__.
6+- Docs.
7+
8+## v3.0.1 2022-05-04
9+
10+CI repair. Change `test.dhall` to `spago-dev.dhall`.
11+
12+## v3.0.0 2022-05-04
413
514Build for PureScript v0.15.
15+
16+Added `MonadRec` constraint to `execPut`, `execPutM`, `foldl`, `foldM`,
17+they are now stack-safe.
18+
619## v2.1.0 2021-07-22
720
821Renamed `Data.ArrayBuffer.Internal.Bytes` and exported
DEVELOPMENT.mddeleted−43
@@ -1,43 +0,0 @@
1−# Development Notes
2−
3−All of the commands needed for development are in the `shell.nix` environment.
4−
5−```
6−$ nix-shell
7−```
8−
9−## Edit
10−
11−The `psc-ide` command is available for the [VS Code Purescript IDE extension](https://github.com/nwolverson/vscode-ide-purescript.git).
12−
13−```
14−[nix-shell:]$ code .
15−```
16−
17−## Build
18−
19−```
20−[nix-shell:]$ spago build
21−```
22−
23−## Test
24−
25−The test dependencies are specified seperately in `test.dhall`.
26−
27−```
28−[nix-shell:]$ spago -x test.dhall test
29−```
30−
31−## Publishing to Pursuit with `spago`
32−
33−[Publishing with `spago`](https://github.com/purescript/spago#publish-my-library).
34−
35−```
36−[nix-shell:]$ bower install --save
37−[nix-shell:]$ spago bump-version --no-dry-run major
38−[nix-shell:]$ pulp publish --no-push
39−```
40−
41−## Bower
42−
43−The `bower.json` is generated by running `spago bump-version`, do not edit it.
README.md+56−32
@@ -1,27 +1,21 @@
11# purescript-arraybuffer-builder
22
3−[![CI](https://github.com/jamesdbrock/purescript-arraybuffer-builder/workflows/CI/badge.svg?branch=master)](https://github.com/jamesdbrock/purescript-arraybuffer-builder/actions)
3+[![CI](https://github.com/rowtype-yoga/purescript-arraybuffer-builder/workflows/CI/badge.svg?branch=master)](https://github.com/rowtype-yoga/purescript-arraybuffer-builder/actions)
44[![Pursuit](http://pursuit.purescript.org/packages/purescript-arraybuffer-builder/badge)](http://pursuit.purescript.org/packages/purescript-arraybuffer-builder/)
5+[![Maintainer: jamesdbrock](https://img.shields.io/badge/maintainer-jamesdbrock-teal.svg)](https://github.com/jamesdbrock)
56
6−`ArrayBuffer` serialization in the “builder monoid” and “builder monad” style.
7−In this style, we build up serialized data structures by `append`ing to
8−a monoid in a Writer monad with do-notation. This style of serialization
7+
8+[`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)
9+serialization in the “builder monoid” and “builder monad” style.
10+In this style, we build up serialized data structures by `tell`ing to
11+a `Writer` monad with `do`-notation. This style of serialization
912has been used for a long time and we [insist that it works really well](https://wiki.haskell.org/Do_notation_considered_harmful#Library_design).
1013
1114This package provides a `Builder` monoid and a `PutM` monad which are roughly
1215equivalent to types of the same name in the Haskell
13−[`Data.Binary.Put`](https://hackage.haskell.org/package/binary/docs/Data-Binary-Put.html)
16+[__Data.Binary.Put__](https://hackage.haskell.org/package/binary/docs/Data-Binary-Put.html)
1417module.
1518
16−This package defines
17−[no typeclasses](http://code.slipthrough.net/2018/03/13/thoughts-on-typeclass-codecs/).
18−Typeclass-based
19−serialization/deserialization generally assumes that we are round-tripping
20−some data structures out to storage and then back into our program.
21−This package is designed for the case in which we are serializing some data
22−to be sent to another program which expects a serialization format
23−that we don't control.
24−
2519## Usage Examples
2620
2721All `ArrayBuffer` building must occur in `Effect`.
@@ -45,7 +39,7 @@ IEEE-754 double-precision floats.
4539import Data.ArrayBuffer.Builder (execPut, putFloat64be)
4640
4741do
48− arraybuffer :: ArrayBuffer <- execPut $ do
42+ arraybuffer :: ArrayBuffer <- execPut do
4943 putFloat64be 1.0
5044 putFloat64be 2.0
5145 putFloat64be 3.0
@@ -57,23 +51,26 @@ Encode a `String` as UTF8 with a length prefix into our `Builder`.
5751
5852We give this as an example, rather than supporting it in the library, because
5953it depends on
60−[`Data.TextEncoding.encodeUtf8`](https://pursuit.purescript.org/packages/purescript-text-encoding/docs/Data.TextEncoding#v:encodeUtf8).
54+[`Web.Encoding.TextEncoder`](https://pursuit.purescript.org/packages/purescript-web-encoding/docs/Web.Encoding.TextEncoder).
6155
6256```purescript
63−import Data.ArrayBuffer.Builder (PutM, putArrayBuffer, execPut)
57+import Effect.Class (class MonadEffect, liftEffect)
58+import Data.UInt (fromInt)
59+import Data.ArrayBuffer.Types (ArrayBuffer(..))
60+import Data.ArrayBuffer.Builder (PutM, putArrayBuffer, execPut, putUint32be)
6461import Data.ArrayBuffer.Typed (buffer)
65−import Data.TextEncoding (encodeUtf8)
6662import Data.ArrayBuffer.ArrayBuffer (byteLength)
63+import Web.Encoding.TextEncoder (new, TextEncoder, encode)
6764
68−putStringUtf8 :: forall m. (MonadEffect m) => String -> PutM m Unit
65+putStringUtf8 :: forall m. MonadEffect m => String -> PutM m Unit
6966putStringUtf8 s = do
70− let stringbuf = buffer $ encodeUtf8 s
71− -- Put a 32-bit big-endian length prefix for the length of the utf8 string, in bytes.
72− putInt32be $ byteLength stringbuf
67+ textEncoder <- liftEffect new
68+ let stringbuf = buffer $ encode s textEncoder
69+ -- Put a 32-bit big-endian length for the utf8 string, in bytes.
70+ putUint32be $ fromInt $ byteLength stringbuf
7371 putArrayBuffer stringbuf
7472
75−do
76− arraybuffer :: ArrayBuffer <- execPut $ putStringUtf8 "BLM"
73+arraybuffer :: ArrayBuffer <- execPut $ putStringUtf8 "🦝"
7774```
7875
7976### Serialize an `Array Int`
@@ -90,9 +87,9 @@ import Data.ArrayBuffer.Builder (execPut, putInt32be)
9087import Data.Foldable (traverse_)
9188import Data.Array (length)
9289
93−putArrayInt32 :: forall m. (MonadEffect m) => Array Int -> PutM m Unit
90+putArrayInt32 :: forall m. MonadEffect m => Array Int -> PutM m Unit
9491putArrayInt32 xs = do
95− -- Put a 64-bit big-endian length prefix for the length of the array.
92+ -- Put a 64-bit big-endian length prefix for the array.
9693 putInt32be 0
9794 putInt32be $ length xs
9895 traverse_ putInt32be xs
@@ -101,20 +98,47 @@ do
10198 arraybuffer <- execPut $ putArrayInt32 [1,2,3]
10299```
103100
101+### Serialize an `Array Int` stack-safe
102+
103+Stack-safe version of the `putArrayInt32` function above. For stack-safety
104+we use `foldRecM` instead of `traverse_` because `foldRecM` has a `MonadRec`
105+constraint which makes it stack-safe.
106+
107+```purescript
108+import Data.Array (foldRecM)
109+
110+putArrayInt32 :: forall m. MonadEffect m => MonadRec m => Array Int -> PutM m Unit
111+putArrayInt32 xs = do
112+ -- Put a 64-bit big-endian length prefix for the array.
113+ putInt32be 0
114+ putInt32be $ length xs
115+ foldRecM (\_ x -> putInt32be x) unit xs
116+```
117+
118+## Stack-safety
119+
120+This package will always be stack-safe if all of the functions called inside
121+of the `PutM` builder expression are stack-safe.
122+
104123## Deserialization
105124
106125This package is only for writing `ArrayBuffer`s, not reading them.
107126See
108−[__purescript-parsing-dataview__](https://pursuit.purescript.org/packages/purescript-parsing-dataview/)
127+[__parsing-dataview__](https://pursuit.purescript.org/packages/purescript-parsing-dataview/)
109128for a way to deserialize from `ArrayBuffer` back to Purescript data.
110129
111−## References
112−
113−* [MDN `ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)
114−
115130## Alternative packages for serializing to an `ArrayBuffer`
116131
117132* [__dynamic-buffers__](https://pursuit.purescript.org/packages/purescript-dynamic-buffers)
118133* [__node-buffer__](https://pursuit.purescript.org/packages/purescript-node-buffer)
119134* [__arraybuffer-class__](https://pursuit.purescript.org/packages/purescript-arraybuffer-class)
120−* [__bytestrings__](https://pursuit.purescript.org/packages/purescript-bytestrings/)
135+* [__bytestrings__](https://pursuit.purescript.org/packages/purescript-bytestrings/)
136+* [__array-builder__](https://pursuit.purescript.org/packages/purescript-array-builder)
137+
138+## Development
139+
140+To run the tests,
141+
142+```shell
143+spago -x spago-dev.dhall test
144+```
bower.json+12−8
@@ -14,13 +14,17 @@
1414 "output"
1515 ],
1616 "dependencies": {
17− "purescript-arraybuffer": "^v11.0.1",
18− "purescript-arraybuffer-types": "^v3.0.0",
19− "purescript-effect": "^v3.0.0",
20− "purescript-float32": "^v1.0.0",
21− "purescript-maybe": "^v5.0.0",
22− "purescript-prelude": "^v5.0.1",
23− "purescript-transformers": "^v5.1.0",
24− "purescript-uint": "^v6.0.3"
17+ "purescript-arraybuffer": "^v13.1.1",
18+ "purescript-arraybuffer-types": "^v3.0.2",
19+ "purescript-effect": "^v4.0.0",
20+ "purescript-float32": "^v2.0.0",
21+ "purescript-identity": "^v6.0.0",
22+ "purescript-lists": "^v7.0.0",
23+ "purescript-maybe": "^v6.0.0",
24+ "purescript-newtype": "^v5.0.0",
25+ "purescript-prelude": "^v6.0.1",
26+ "purescript-tailrec": "^v6.1.0",
27+ "purescript-transformers": "^v6.0.0",
28+ "purescript-uint": "^v7.0.0"
2529 }
2630}
packages.dhall+2−2
@@ -116,9 +116,9 @@ let additions =
116116 }
117117-------------------------------
118118-}
119−
120119let upstream =
121− https://raw.githubusercontent.com/purescript/package-sets/prepare-0.15/src/packages.dhall
120+ https://raw.githubusercontent.com/purescript/package-sets/psc-0.15.4-20221209/src/packages.dhall
121+ sha256:b55c24bf585df4041ae6e87124cab7b35d474a9a77c9c3862ee6bf1dae618d72
122122
123123let overrides = {=}
124124
psc-package.jsondeleted−16
@@ -1,16 +0,0 @@
1−{
2− "name": "purescript-arraybuffer-builder",
3− "set": "psc-0.14.1-20210429",
4− "source": "https://github.com/purescript/package-sets.git",
5− "depends": [
6− "prelude",
7− "effect",
8− "float32",
9− "maybe",
10− "prelude",
11− "transformers",
12− "uint",
13− "arraybuffer-types",
14− "arraybuffer"
15− ]
16−}
shell.nixdeleted−30
@@ -1,30 +0,0 @@
1−# Universal shell for PureScript repos
2−# { pkgs ? import <nixpkgs> { }
3−{ pkgs ? import (builtins.fetchGit {
4− # https://github.com/NixOS/nixpkgs/releases/tag/20.09
5− url = "https://github.com/nixos/nixpkgs/";
6− ref = "refs/tags/20.09";
7− rev = "cd63096d6d887d689543a0b97743d28995bc9bc3";
8− }) {}
9−}:
10−let
11− easy-ps = import (builtins.fetchGit {
12− url = "https://github.com/justinwoo/easy-purescript-nix.git";
13− rev = "bbef4245cd6810ea84e97a47c801947bfec9fadc";
14− }) { inherit pkgs; };
15−in
16−pkgs.mkShell {
17− nativeBuildInputs = [
18− easy-ps.purs-0_14_3
19− easy-ps.spago
20− easy-ps.pulp
21− easy-ps.psc-package
22− pkgs.nodejs-14_x
23− pkgs.nodePackages.bower
24− ];
25− LC_ALL = "C.UTF-8"; # https://github.com/purescript/spago/issues/507
26− # https://github.com/purescript/spago#install-autocompletions-for-bash
27− shellHook = ''
28− source <(spago --bash-completion-script `which spago`)
29− '';
30−}
test.dhall → spago-dev.dhallrenamed+6−2
@@ -12,5 +12,9 @@ let conf = ./spago.dhall
1212
1313in conf //
1414 { sources = conf.sources # [ "test/**/*.purs" ]
15− , dependencies = conf.dependencies # [ "assert" ]
16− }
15+ , dependencies = conf.dependencies #
16+ [ "assert"
17+ , "arrays"
18+ , "web-encoding"
19+ ]
20+ }
spago.dhall+4
@@ -4,12 +4,16 @@
44, dependencies =
55 [ "effect"
66 , "float32"
7+ , "identity"
8+ , "lists"
79 , "maybe"
10+ , "newtype"
811 , "prelude"
912 , "transformers"
1013 , "uint"
1114 , "arraybuffer-types"
1215 , "arraybuffer"
16+ , "tailrec"
1317 ]
1418, packages = ./packages.dhall
1519, sources = [ "src/**/*.purs" ]
src/Data/ArrayBuffer/Builder.purs+30−30
@@ -5,39 +5,39 @@
55-- | Writing to an `ArrayBuffer` is an `Effect`ful activity, so most
66-- | functions in this module must be run in a `MonadEffect` context.
77-- |
8−-- | For operations for working with `ArrayBuffer`, see
8+-- | For other operations for working with `ArrayBuffer`, see
99-- | module
1010-- | [`Data.ArrayBuffer.ArrayBuffer`](https://pursuit.purescript.org/packages/purescript-arraybuffer/docs/Data.ArrayBuffer.ArrayBuffer)
11−-- | in package __purescript-arraybuffer__.
11+-- | in package __arraybuffer__.
1212module Data.ArrayBuffer.Builder
13−( PutM
14−, Put
15−, execPutM
16−, execPut
17−, subBuilder
18−, putArrayBuffer
19−, putDataView
20−, putDataBuff
21−, putUint8
22−, putInt8
23−, putUint16be
24−, putUint16le
25−, putInt16be
26−, putInt16le
27−, putUint32be
28−, putUint32le
29−, putInt32be
30−, putInt32le
31−, putFloat32be
32−, putFloat32le
33−, putFloat64be
34−, putFloat64le
35−, module Data.ArrayBuffer.Builder.Internal
36−)
37−where
13+ ( PutM
14+ , Put
15+ , execPutM
16+ , execPut
17+ , subBuilder
18+ , putArrayBuffer
19+ , putDataView
20+ , putDataBuff
21+ , putUint8
22+ , putInt8
23+ , putUint16be
24+ , putUint16le
25+ , putInt16be
26+ , putInt16le
27+ , putUint32be
28+ , putUint32le
29+ , putInt32be
30+ , putInt32le
31+ , putFloat32be
32+ , putFloat32le
33+ , putFloat64be
34+ , putFloat64le
35+ , module Data.ArrayBuffer.Builder.Internal
36+ ) where
3837
3938import Prelude
4039
40+import Control.Monad.Rec.Class (class MonadRec)
4141import Control.Monad.Writer.Trans (WriterT, execWriterT, tell, lift)
4242import Data.ArrayBuffer.Builder.Internal (Builder, DataBuff(..), length, toView, (<>>))
4343import Data.ArrayBuffer.Builder.Internal as Internal
@@ -58,11 +58,11 @@ type PutM = WriterT Builder
5858-- | The `PutM` type reified to `Effect`, in other words `WriterT Builder Effect`.
5959type Put = PutM Effect
6060
61−-- | Build an `ArrayBuffer` with do-notation in any `MonadEffect`. *O(n)*
62−execPutM :: forall m. MonadEffect m => PutM m Unit -> m ArrayBuffer
61+-- | Build an `ArrayBuffer` with do-notation in any `MonadEffect`. *O(n)* Stack-safe.
62+execPutM :: forall m. MonadEffect m => MonadRec m => PutM m Unit -> m ArrayBuffer
6363execPutM = Internal.execBuilder <=< execWriterT
6464
65−-- | Build an `ArrayBuffer` with do-notation in `Effect`. *O(n)*
65+-- | Build an `ArrayBuffer` with do-notation in `Effect`. *O(n)* Stack-safe.
6666execPut :: Put Unit -> Effect ArrayBuffer
6767execPut = execPutM
6868
src/Data/ArrayBuffer/Internal.purs+63−45
@@ -79,42 +79,45 @@
7979-- | so that if we want to change the `Builder` implementation later then we can.
8080-- |
8181module Data.ArrayBuffer.Builder.Internal
82−( Builder(..)
83−, (<>>)
84−, DataBuff(..)
85−, toView
86−, execBuilder
87−, length
88−, foldl
89−, foldM
90−, singleton
91−, cons
92−, snoc
93−, encodeUint8
94−, encodeInt8
95−, encodeUint16be
96−, encodeUint16le
97−, encodeInt16be
98−, encodeInt16le
99−, encodeUint32be
100−, encodeUint32le
101−, encodeInt32be
102−, encodeInt32le
103−, encodeFloat32be
104−, encodeFloat32le
105−, encodeFloat64be
106−, encodeFloat64le
107−)
108−where
82+ ( Builder(..)
83+ , (<>>)
84+ , DataBuff(..)
85+ , toView
86+ , execBuilder
87+ , length
88+ , foldl
89+ , foldM
90+ , singleton
91+ , cons
92+ , snoc
93+ , encodeUint8
94+ , encodeInt8
95+ , encodeUint16be
96+ , encodeUint16le
97+ , encodeInt16be
98+ , encodeInt16le
99+ , encodeUint32be
100+ , encodeUint32le
101+ , encodeInt32be
102+ , encodeInt32le
103+ , encodeFloat32be
104+ , encodeFloat32le
105+ , encodeFloat64be
106+ , encodeFloat64le
107+ ) where
109108
110109import Prelude
111110
111+import Control.Monad.Rec.Class (class MonadRec, Step(..), tailRecM)
112112import Data.ArrayBuffer.ArrayBuffer as AB
113113import Data.ArrayBuffer.DataView as DV
114114import Data.ArrayBuffer.Typed as AT
115115import Data.ArrayBuffer.Types (ArrayBuffer, ByteLength, DataView, Uint8Array)
116116import Data.Float32 (Float32)
117+import Data.Identity (Identity)
118+import Data.List (List(..), uncons, (:))
117119import Data.Maybe (Maybe(..))
120+import Data.Newtype (unwrap)
118121import Data.UInt (UInt)
119122import Effect (Effect)
120123import Effect.Class (class MonadEffect, liftEffect)
@@ -127,7 +130,7 @@ data DataBuff
127130-- Concerning DataViews.
128131-- https://v8.dev/blog/dataview
129132
130− -- | View the contents of `DataBuff` as a `DataView`.
133+-- | View the contents of `DataBuff` as a `DataView`.
131134toView :: DataBuff -> DataView
132135toView (Buff ab) = DV.whole ab
133136toView (View dv) = dv
@@ -187,26 +190,39 @@ instance semigroupBuilder :: Semigroup Builder where
187190 append Null r = r
188191 append l (Node Null rx rr) = Node l rx rr -- this is the snoc case
189192 append (Node ll lx Null) r = Node ll lx r -- found the rightmost Null
190− -- of the left tree
193+ -- of the left tree
191194 append (Node ll lx lr) r = Node ll lx $ append lr r -- search down the right
192− -- side of the left tree
193− -- to find the rightmost
194− -- Null
195+
196+-- side of the left tree
197+-- to find the rightmost
198+-- Null
195199
196200infixl 5 append as <>>
197201
198202instance monoidBuilder :: Monoid Builder where
199203 mempty = Null
200204
201−-- | `Builder` is not an instance of `Foldable` because `Builder` is monomorphic.
202−foldl :: forall b. (b -> DataBuff -> b) -> b -> Builder -> b
203−foldl _ a Null = a
204−foldl f a (Node l x r) = foldl f (f (foldl f a l) x) r
205+-- | Stack-safe `foldl` over a `Builder`. *O(n)*
206+foldl :: forall a. (a -> DataBuff -> a) -> a -> Builder -> a
207+foldl f a0 b = (unwrap :: Identity a -> a) $ foldM (\a' b' -> pure (f a' b')) a0 b
205208
206−-- | Monomorphic foldM copied from
207−-- | [`Data.Foldable.foldM`](https://pursuit.purescript.org/packages/purescript-foldable-traversable/4.1.1/docs/Data.Foldable#v:foldM)
208−foldM :: forall b m. (Monad m) => (b -> DataBuff -> m b) -> b -> Builder -> m b
209−foldM f a0 = foldl (\ma b -> ma >>= flip f b) (pure a0)
209+-- | Stack-safe `foldM` over a `Builder`. *O(n)*.
210+foldM :: forall m a. MonadRec m => (a -> DataBuff -> m a) -> a -> Builder -> m a
211+-- The Art of Computer Programming 2.3.1
212+-- Inorder traversal using a stack
213+-- https://yuyuan.org/MorrisAlgorithm/
214+foldM f a0 b = tailRecM outer { p: b, stack: Nil, accum: a0 }
215+ where
216+ outer { p, stack, accum } = do
217+ stack' <- tailRecM inner { p_: p, stack_: stack }
218+ case uncons stack' of
219+ Nothing -> pure $ Done accum
220+ Just { head: Node _ x r, tail } -> do
221+ accum' <- f accum x
222+ pure $ Loop { p: r, stack: tail, accum: accum' }
223+ Just { head: Null } -> pure $ Done accum
224+ inner { p_: Null, stack_ } = pure $ Done stack_
225+ inner { p_: n@(Node l _ _), stack_ } = pure $ Loop { p_: l, stack_: n : stack_ }
210226
211227-- | Construct a `Builder` with a single `DataBuff`. *O(1)*
212228singleton :: DataBuff -> Builder
@@ -217,8 +233,8 @@ singleton buf = Node Null buf Null
217233length :: Builder -> ByteLength
218234length bldr = foldl (\b a -> b + len a) 0 bldr
219235 where
220− len (Buff ab) = AB.byteLength ab
221− len (View dv) = DV.byteLength dv
236+ len (Buff ab) = AB.byteLength ab
237+ len (View dv) = DV.byteLength dv
222238
223239-- | Prepend a `DataBuff` to the beginning of the `Builder`. *O(1)*
224240cons :: DataBuff -> Builder -> Builder
@@ -229,7 +245,7 @@ snoc :: Builder -> DataBuff -> Builder
229245snoc bs x = Node bs x Null
230246
231247-- | Build a single `ArrayBuffer` from a `Builder`. *O(n)*
232−execBuilder :: forall m. (MonadEffect m) => Builder -> m ArrayBuffer
248+execBuilder :: forall m. MonadEffect m => MonadRec m => Builder -> m ArrayBuffer
233249execBuilder bldr = do
234250 let buflen = length bldr
235251 -- Allocate the final ArrayBuffer
@@ -243,9 +259,11 @@ execBuilder bldr = do
243259 aview <- liftEffect $ toUint8Array a
244260 _ <- liftEffect $ AT.setTyped newview (Just offset) aview
245261 pure $ offset + AT.byteLength aview
246− ) 0 bldr
262+ )
263+ 0
264+ bldr
247265 pure buf
248− where
266+ where
249267 toUint8Array :: DataBuff -> Effect Uint8Array
250268 toUint8Array (Buff ab) = AT.whole ab
251269 toUint8Array (View dv) =
test/Main.purs+52−21
@@ -1,16 +1,24 @@
11module Test.Main where
22
3−import Data.ArrayBuffer.Builder
3+import Prelude
44
55import Control.Monad.Writer.Trans (tell)
6+import Data.Array (foldRecM)
7+import Data.Array as Array
8+import Data.ArrayBuffer.ArrayBuffer (byteLength)
9+import Data.ArrayBuffer.Builder (Builder, DataBuff(..), PutM, execPut, putArrayBuffer, putInt16be, putInt32be, putInt32le, putInt8, subBuilder)
610import Data.ArrayBuffer.Builder.Internal (cons, encodeInt8, execBuilder, length, singleton, (<>>))
711import Data.ArrayBuffer.DataView as DV
12+import Data.ArrayBuffer.Typed (buffer)
813import Data.ArrayBuffer.Typed as AT
9−import Data.ArrayBuffer.Types (ArrayBuffer, Uint8Array)
14+import Data.ArrayBuffer.Typed as AV
15+import Data.ArrayBuffer.Types (ArrayBuffer, Uint8Array, Int8Array)
1016import Data.UInt as UInt
1117import Effect (Effect)
12−import Prelude (Unit, bind, pure, discard, map, negate, ($), (<$>), (=<<), (<>))
18+import Effect.Class (class MonadEffect, liftEffect)
1319import Test.Assert (assertEqual')
20+import Web.Encoding.TextEncoder (encode)
21+import Web.Encoding.TextEncoder as TextEncoder
1422
1523asBytes :: ArrayBuffer -> Effect (Array Int)
1624asBytes x = do
@@ -20,48 +28,48 @@ asBytes x = do
2028putTest :: String -> Array Int -> PutM Effect Unit -> Effect Unit
2129putTest label expected put = do
2230 actual <- asBytes =<< execPut put
23− assertEqual' label {actual,expected}
31+ assertEqual' label { actual, expected }
2432
2533buildTest :: String -> Array Int -> Effect Builder -> Effect Unit
2634buildTest label expected bldr = do
2735 actual <- asBytes =<< execBuilder =<< bldr
28− assertEqual' label {actual,expected}
36+ assertEqual' label { actual, expected }
2937
3038main :: Effect Unit
3139main = do
32− putTest "Test 0" [6,7,8] $ do
40+ putTest "Test 0" [ 6, 7, 8 ] do
3341 putInt8 6
3442 putInt8 7
3543 putInt8 8
3644
37− putTest "Test 1" [255,254] $ do
45+ putTest "Test 1" [ 255, 254 ] do
3846 putInt16be (-2)
3947
40− putTest "Test 3" [3,0,0,0] $ do
48+ putTest "Test 3" [ 3, 0, 0, 0 ] do
4149 putInt32le 3
4250
43− buildTest "Test 4" [1,2,3,4] $ do
51+ buildTest "Test 4" [ 1, 2, 3, 4 ] do
4452 b1 <- Buff <$> encodeInt8 1
4553 b2 <- Buff <$> encodeInt8 2
4654 b3 <- Buff <$> encodeInt8 3
4755 b4 <- Buff <$> encodeInt8 4
4856 pure $ singleton b1 <> singleton b2 <> singleton b3 <> singleton b4
4957
50− buildTest "Test 5" [1,2,3,4] $ do
58+ buildTest "Test 5" [ 1, 2, 3, 4 ] do
5159 b1 <- Buff <$> encodeInt8 1
5260 b2 <- Buff <$> encodeInt8 2
5361 b3 <- Buff <$> encodeInt8 3
5462 b4 <- Buff <$> encodeInt8 4
5563 pure $ singleton b1 <>> singleton b2 <>> singleton b3 <>> singleton b4
5664
57− buildTest "Test 6" [1,2,3,4] $ do
65+ buildTest "Test 6" [ 1, 2, 3, 4 ] do
5866 b1 <- Buff <$> encodeInt8 1
5967 b2 <- Buff <$> encodeInt8 2
6068 b3 <- Buff <$> encodeInt8 3
6169 b4 <- Buff <$> encodeInt8 4
6270 pure $ singleton b1 <> (singleton b2 <> singleton b3) <> singleton b4
6371
64− buildTest "Test 6" [1,2,3,4,5,6,7,8] $ do
72+ buildTest "Test 6" [ 1, 2, 3, 4, 5, 6, 7, 8 ] do
6573 b1 <- Buff <$> encodeInt8 1
6674 b2 <- Buff <$> encodeInt8 2
6775 b3 <- Buff <$> encodeInt8 3
@@ -71,9 +79,11 @@ main = do
7179 b7 <- Buff <$> encodeInt8 7
7280 b8 <- Buff <$> encodeInt8 8
7381 pure $ singleton b1 <> (singleton b2 <> singleton b3) <> singleton b4
74− <> singleton b5 <> (singleton b6 <> singleton b7) <> singleton b8
82+ <> singleton b5
83+ <> (singleton b6 <> singleton b7)
84+ <> singleton b8
7585
76− buildTest "Test 7" [1,2,3,4,5,6,7,8] $ do
86+ buildTest "Test 7" [ 1, 2, 3, 4, 5, 6, 7, 8 ] do
7787 b1 <- Buff <$> encodeInt8 1
7888 b2 <- Buff <$> encodeInt8 2
7989 b3 <- Buff <$> encodeInt8 3
@@ -83,17 +93,17 @@ main = do
8393 b7 <- Buff <$> encodeInt8 7
8494 b8 <- Buff <$> encodeInt8 8
8595 pure $ ((singleton b1 <> singleton b2) <> (singleton b3 <> singleton b4))
86− <> ((singleton b5 <> singleton b6) <> (singleton b7 <> singleton b8))
96+ <> ((singleton b5 <> singleton b6) <> (singleton b7 <> singleton b8))
8797
88− buildTest "Test 8" [1,2,3,4] $ do
98+ buildTest "Test 8" [ 1, 2, 3, 4 ] do
8999 b1 <- Buff <$> encodeInt8 1
90100 b2 <- Buff <$> encodeInt8 2
91101 b3 <- Buff <$> encodeInt8 3
92102 b4 <- Buff <$> encodeInt8 4
93103 pure $ (cons b1 (singleton b2)) <> (cons b3 (singleton b4))
94104
95− putTest "Test 9" [1,2,2,3,4] $ do
96− x <- subBuilder $ do
105+ putTest "Test 9" [ 1, 2, 2, 3, 4 ] do
106+ x <- subBuilder do
97107 putInt8 3
98108 putInt8 4
99109 putInt8 1
@@ -101,7 +111,7 @@ main = do
101111 putInt8 $ length x
102112 tell x
103113
104− buildTest "Test 10" [1,2,3,4,5,6,7,8] $ do
114+ buildTest "Test 10" [ 1, 2, 3, 4, 5, 6, 7, 8 ] do
105115 b1 <- View <$> DV.whole <$> encodeInt8 1
106116 b2 <- View <$> DV.whole <$> encodeInt8 2
107117 b3 <- View <$> DV.whole <$> encodeInt8 3
@@ -111,5 +121,26 @@ main = do
111121 b7 <- View <$> DV.whole <$> encodeInt8 7
112122 b8 <- View <$> DV.whole <$> encodeInt8 8
113123 pure $ ((singleton b1 <> singleton b2) <> (singleton b3 <> singleton b4))
114− <> ((singleton b5 <> singleton b6) <> (singleton b7 <> singleton b8))
115−
124+ <> ((singleton b5 <> singleton b6) <> (singleton b7 <> singleton b8))
125+
126+ let stackblower = Array.replicate 20000 2
127+ putTest "Stack test" stackblower do
128+ foldRecM (\_ x -> putInt8 x) unit stackblower
129+
130+ do
131+ let
132+ putStringUtf8 :: forall m. MonadEffect m => String -> PutM m Unit
133+ putStringUtf8 s = do
134+ textEncoder <- liftEffect TextEncoder.new
135+ let stringbuf = buffer $ encode s textEncoder
136+ -- Put a 32-bit big-endian length prefix for the length of the utf8 string, in bytes.
137+ putInt32be $ byteLength stringbuf
138+ putArrayBuffer stringbuf
139+
140+ arraybuffer :: ArrayBuffer <- execPut $ putStringUtf8 "🦝"
141+ view :: Int8Array <- AV.whole arraybuffer
142+ viewarray <- AV.toArray view
143+ assertEqual' "utf-8 test"
144+ { actual: viewarray
145+ , expected: [ 0, 0, 0, 4, -16, -97, -90, -99 ]
146+ }