From 8743516f6ac8b9a5e7dbdee05cb22ca5b135b111 Mon Sep 17 00:00:00 2001
From: Julien Moutinho <julm+symantic-parser@sourcephile.fr>
Date: Sat, 17 Jul 2021 00:23:28 +0200
Subject: [PATCH] doc: update
---
Makefile | 13 +++++++------
ReadMe.md | 8 ++++----
flake.lock | 12 ++++++------
3 files changed, 17 insertions(+), 16 deletions(-)
diff --git a/Makefile b/Makefile
index 5735b7a..b9a56b2 100644
--- a/Makefile
+++ b/Makefile
@@ -1,8 +1,9 @@
-override RTS_OPTIONS += -L100
-override TEST_OPTIONS += --color always --size-cutoff 1000000 $(addprefix -p ,$t)
-override GHC_PROF_OPTIONS += -eventlog -fprof-auto -fprof-auto-calls
override BENCHMARK_OPTIONS += --output benchmarks/html/$(version).html --match glob $b
+override GHCID_OPTIONS += --no-height-limit --reverse-errors
+override GHC_PROF_OPTIONS += -eventlog -fprof-auto -fprof-auto-calls
override REPL_OPTIONS += -ignore-dot-ghci
+override RTS_OPTIONS += -L100
+override TEST_OPTIONS += --color always --size-cutoff 1000000 $(addprefix -p ,$t)
cabal := $(wildcard *.cabal)
package := $(notdir ./$(cabal:.cabal=))
@@ -17,14 +18,14 @@ clean c:
repl:
cabal repl $(CABAL_REPL_FLAGS) $(project)
ghcid:
- ghcid -c 'cabal repl $(CABAL_REPL_FLAGS) $(project) --repl-options "$(REPL_OPTIONS)"' --reverse-errors
+ ghcid $(GHCID_OPTIONS) -c 'cabal repl $(CABAL_REPL_FLAGS) $(project) $(addprefix --repl-options ,$(REPL_OPTIONS))'
.PHONY: parsers
parsers:
cabal build $(CABAL_BUILD_FLAGS) $(project):parsers
parsers/repl:
cabal repl $(CABAL_REPL_FLAGS) $(project):parsers
parsers/ghcid:
- ghcid -c 'cabal repl $(CABAL_REPL_FLAGS) $(project):parsers --repl-options "$(REPL_OPTIONS)"' --reverse-errors
+ ghcid $(GHCID_OPTIONS) -c 'cabal repl $(CABAL_REPL_FLAGS) $(project):parsers $(addprefix --repl-options ,$(REPL_OPTIONS))'
parsers/prof-th:
cabal v2-build lib:$(project) --enable-profiling $(GHC_PROF_OPTIONS) --write-ghc-environment-files=always
cabal build $(CABAL_BUILD_FLAGS) $(project):parsers \
@@ -51,7 +52,7 @@ tests/prof-th:
tests/repl:
cabal repl $(CABAL_REPL_FLAGS) --enable-tests $(project)-test
tests/ghcid:
- ghcid -c 'cabal repl $(CABAL_REPL_FLAGS) $(project):tests --test-options "$(TEST_OPTIONS)"' --reverse-errors
+ ghcid $(GHCID_OPTIONS) -c 'cabal repl $(CABAL_REPL_FLAGS) $(project):tests --test-options "$(TEST_OPTIONS)"'
%/accept: TEST_OPTIONS += --accept
%/accept: %
diff --git a/ReadMe.md b/ReadMe.md
index a27614c..1cad39c 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -2,17 +2,17 @@
- Primitive grammar combinators are extensible, including the optimization pass for which they are the current top-level combinator.
-- Error messages are based upon the farthest input position reached (not yet implemented in `ParsleyHaskell`) and a there is a preliminary support for error messages based upon [labeled failures](https://dl.acm.org/doi/10.1145/2851613.2851750).
+- Error messages are based upon the farthest input position reached (not yet implemented in `ParsleyHaskell`) and there is a preliminary support for error messages based upon [labeled failures](https://dl.acm.org/doi/10.1145/2851613.2851750).
- Minimal input length checks ("horizon" checks) required for a successful parsing are statically computed using a [polyfix](http://okmij.org/ftp/Computation/fixed-point-combinators.html#Poly-variadic) to see beyond calls to subroutines, which is not (yet) possible in `ParsleyHaskell`.
-- No dependency upon GHC plugins: `lift-plugin`, `idioms-plugin` or `parsley-garnish` for users. Those provide convenient syntaxic-sugar (by quoting an Haskell expression as itself and its `TemplateHaskell` equivalent) for writing grammar productions, but are experimental, but I do not understand them that much and do not feel confortable to maintain them in case their authors abandon them.
+- Symantics are used for grammars productions instead of GHC plugins: `lift-plugin`, `idioms-plugin` or `parsley-garnish` for users. Those provide convenient syntaxic-sugar (by quoting an Haskell expression as itself and its `TemplateHaskell` equivalent), but I do not understand them that much and do not feel confortable to maintain them in case their authors abandon them.
-- No dependency upon `dependent-map` by keeping observed sharing in `shareable` and `ref` combinators, instead of passing by a `DMap`. And also when introducing the join-points optimization, where fresh `TemplateHaskell` names are also directly used instead of passing by a `DMap`.
+- Fresh `TemplateHaskell` names are used directly (when observing sharingm introducing join-points, etc.) instead of a detour depending upon `dependent-map`.
- No support (yet?) for general purpose registers in the `Machine` producing the `TemplateHaskell` splices. Hence `symantic-parser` generates parser much slower than `ParsleyHaskell`, comparable to `attoparsec` in the Brainfuck benchmark.
-- License is `AGPL-3.0-or-later` not `BSD-3-Clause`.
+- Code is a common published under the copyleft license `AGPL-3.0-or-later`, instead of the more liberal `BSD-3-Clause` of `ParsleyHaskell`.
- Testing grammars have their generated machines and `TemplateHaskell` splices followed by golden tests.
diff --git a/flake.lock b/flake.lock
index e85fe53..fe556a7 100644
--- a/flake.lock
+++ b/flake.lock
@@ -32,8 +32,8 @@
},
"nixpkgs": {
"locked": {
- "narHash": "sha256-3C35/g5bJ3KH67fOpxTkqDpfJ1CHYrO2bbl+fPgqfMQ=",
- "path": "/nix/store/6g7dgkinzm4rvwmpfp9avklsb4hiqals-nixpkgs-patched",
+ "narHash": "sha256-JenJ8F1xebz8VhfSxUcod1DsR9hRCYG5A+KNSsK5yWs=",
+ "path": "/nix/store/fcf9j9allbj8d4qlhq5sr6h8098aa78k-nixpkgs-patched",
"type": "path"
},
"original": {
@@ -56,11 +56,11 @@
]
},
"locked": {
- "lastModified": 1626033315,
- "narHash": "sha256-vHRFhc9Bg2cxrAR9R1TSXn2f6ZwzOIMRD+0n3cXzl54=",
+ "lastModified": 1626241645,
+ "narHash": "sha256-BYpVYkzNuPmKSLYp9UEqbzTWEDX/Ffd6e4ORhHCI42Y=",
"ref": "master",
- "rev": "29078a0e7fbe8df3204bcf86dd902a301072574f",
- "revCount": 14,
+ "rev": "768058451dc46a32c54e542c1dbbad4983d4a509",
+ "revCount": 15,
"type": "git",
"url": "git://git.sourcephile.fr/haskell/symantic-base"
},
--
2.47.2