Added Data instances (#5)

Author: tonyday567

markup-parse.cabal

@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: markup-parse
-version: 0.2.0.0
+version: 0.2.1.0
 license: BSD-3-Clause
 license-file: LICENSE
 copyright: Copyright, Tony Day, 2023-
@@ -11,78 +11,100 @@ homepage: https://github.com/tonyday567/markup-parse#readme
 bug-reports: https://github.com/tonyday567/markup-parse/issues
 synopsis: A markup parser.
 description:
-    A markup parser and printer, from and to strict bytestrings, optimised for speed.
+  A markup parser and printer, from and to strict bytestrings, optimised for speed.
+
 build-type: Simple
 tested-with:
-    , GHC == 9.6.7
-    , GHC == 9.8.4
-    , GHC == 9.10.2
-    , GHC == 9.12.2
+  ghc ==9.6.7
+  ghc ==9.8.4
+  ghc ==9.10.2
+  ghc ==9.12.2
+
 extra-doc-files:
-    ChangeLog.md
-    other/*.html
-    other/*.svg
-    readme.md
+  ChangeLog.md
+  other/*.html
+  other/*.svg
+  readme.md
 
 source-repository head
-    type: git
-    location: https://github.com/tonyday567/markup-parse
+  type: git
+  location: https://github.com/tonyday567/markup-parse
 
 common ghc-options-exe-stanza
-    ghc-options:
-        -fforce-recomp
-        -funbox-strict-fields
-        -rtsopts
-        -threaded
+  ghc-options:
+    -fforce-recomp
+    -funbox-strict-fields
+    -rtsopts
+    -threaded
 
 common ghc-options-stanza
-    ghc-options:
-        -Wall
-        -Wcompat
-        -Wincomplete-record-updates
-        -Wincomplete-uni-patterns
-        -Wredundant-constraints
+  ghc-options:
+    -Wall
+    -Wcompat
+    -Wincomplete-record-updates
+    -Wincomplete-uni-patterns
+    -Wredundant-constraints
+
+common ghc2024-additions
+  default-extensions:
+    DataKinds
+    DerivingStrategies
+    DisambiguateRecordFields
+    ExplicitNamespaces
+    GADTs
+    LambdaCase
+    MonoLocalBinds
+    RoleAnnotations
 
-common ghc2021-stanza
-    default-language: GHC2021
+common ghc2024-stanza
+  if impl(ghc >=9.10)
+    default-language:
+      GHC2024
+  else
+    import: ghc2024-additions
+    default-language:
+      GHC2021
 
 library
-    import: ghc-options-stanza
-    import: ghc2021-stanza
-    hs-source-dirs: src
-    build-depends:
-        , base               >=4.14 && <5
-        , bytestring         >=0.11.3 && <0.13
-        , containers         >=0.6 && <0.9
-        , deepseq            >=1.4 && <1.6
-        , flatparse          >=0.3.5 && <0.6
-        , string-interpolate >=0.3 && <0.4
-        , these              >=1.1 && <1.3
-    exposed-modules:
-        MarkupParse
-        MarkupParse.Internal.FlatParse
+  import: ghc-options-stanza
+  import: ghc2024-stanza
+  hs-source-dirs: src
+  build-depends:
+    base >=4.14 && <5,
+    bytestring >=0.11.3 && <0.13,
+    containers >=0.6 && <0.9,
+    deepseq >=1.4 && <1.6,
+    flatparse >=0.3.5 && <0.6,
+    string-interpolate >=0.3 && <0.4,
+    these >=1.1 && <1.3,
+
+  exposed-modules:
+    MarkupParse
+    MarkupParse.Internal.FlatParse
 
 test-suite doctests
-    import: ghc2021-stanza
-    main-is: doctests.hs
-    hs-source-dirs: test
-    build-depends:
-        , base             >=4.14 && <5
-        , doctest-parallel >=0.3 && <0.5
-    ghc-options: -threaded
-    type: exitcode-stdio-1.0
+  import: ghc2024-stanza
+  main-is: doctests.hs
+  hs-source-dirs: test
+  build-depends:
+    base >=4.14 && <5,
+    doctest-parallel >=0.3 && <0.5,
+
+  ghc-options: -threaded
+  type: exitcode-stdio-1.0
 
 test-suite markup-parse-diff
-    import: ghc-options-exe-stanza
-    import: ghc-options-stanza
-    import: ghc2021-stanza
-    main-is: markup-parse-diff.hs
-    hs-source-dirs: app
-    build-depends:
-        , base               >=4.14 && <5
-        , bytestring         >=0.11.3 && <0.13
-        , markup-parse
-        , tasty              >=1.2 && <1.6
-        , tasty-golden       >=2.3.1.1 && <2.4
-        , Diff               >=1.0 && <1.1
-    type: exitcode-stdio-1.0
+  import: ghc-options-exe-stanza
+  import: ghc-options-stanza
+  import: ghc2024-stanza
+  main-is: markup-parse-diff.hs
+  hs-source-dirs: app
+  build-depends:
+    Diff >=1.0 && <1.1,
+    base >=4.14 && <5,
+    bytestring >=0.11.3 && <0.13,
+    markup-parse,
+    tasty >=1.2 && <1.6,
+    tasty-golden >=2.3.1.1 && <2.4,
+
+  type: exitcode-stdio-1.0

markup-parse.org

@@ -7,44 +7,35 @@
 
 * Development
 
-#+begin_src haskell :results output :exports both
+#+begin_src haskell-ng :results output :exports both
 :r
-:set prompt "> "
 :set -Wno-type-defaults
 :set -Wno-name-shadowing
 :set -XOverloadedStrings
 :set -XTemplateHaskell
 :set -XQuasiQuotes
 import Control.Monad
 import MarkupParse
-import MarkupParse.FlatParse
-import MarkupParse.Patch
+import MarkupParse.Internal.FlatParse
 import Data.ByteString qualified as B
 import Data.ByteString.Char8 qualified as C
 import Data.Map.Strict qualified as Map
 import Data.Function
 import FlatParse.Basic hiding (take)
 import Data.String.Interpolate
-import Data.TreeDiff
 import Control.Monad
 bs <- B.readFile "other/line.svg"
 C.length bs
 #+end_src
 
 #+RESULTS:
-: Preprocessing library for markup-parse-0.1.1..
-: GHCi, version 9.6.2: https://www.haskell.org/ghc/  :? for help
-: [1 of 3] Compiling MarkupParse.FlatParse ( src/MarkupParse/FlatParse.hs, interpreted )
-: [2 of 3] Compiling MarkupParse      ( src/MarkupParse.hs, interpreted )
-: [3 of 3] Compiling MarkupParse.Patch ( src/MarkupParse/Patch.hs, interpreted )
-: Ok, three modules loaded.
-: g
-: Ok, three modules loaded.
+: [1 of 2] Compiling MarkupParse.Internal.FlatParse ( src/MarkupParse/Internal/FlatParse.hs, interpreted ) [Flags changed]
+: Ok, two modules reloaded.
 : 7554
 
 * Main Pipeline types
 
-#+begin_src haskell :results output :exports both
+#+begin_src haskell-ng :results output :exports both
 :t tokenize Html
 :t gather Html
 :t normalize
@@ -62,30 +53,21 @@ C.length bs
 : tokenize Html >=> gather Html >=> (normalize >>> pure) >=> degather Html >=> (fmap (detokenize Html) >>> pure)
 :   :: ByteString -> These [MarkupWarning] [ByteString]
 
-Round trip equality
 
-#+begin_src haskell :results output :exports both
+** tests
+*** Round trip equality
+
+#+begin_src haskell-ng :results output :exports both
 m = markup_ Xml bs
 m == (markup_ Xml $ markdown_ Compact Xml m)
 #+end_src
 
 #+RESULTS:
 : True
 
-* MarkupParse.Patch
-
-Obviously, patch doesn't belong here long-term but has been very useful in testing and development.
-
-#+begin_src haskell :results output :exports both
-showPatch $ patch [1, 2, 3, 5] [0, 1, 2, 4, 6]
-#+end_src
-
-#+RESULTS:
-: [+0, -3, +4, -5, +6]
+*** wiki diff test debug
 
-* wiki diff test debug
-
-#+begin_src haskell :results output :exports both
+#+begin_src haskell-ng :results output :exports both
 bs <- B.readFile "other/Parsing - Wikipedia.html"
 m = markup_ Html bs
 m == (markup_ Html $ markdown_ Compact Html m)
@@ -113,15 +95,9 @@ m == (markup_ Html $ markdown_ Compact Html m)
 [[https://hackage.haskell.org/package/XMLParser][XMLParser]] & [[https://hackage.haskell.org/package/hexml][hexml]] are parsec-based parsers.
 
 * Performance
-
+** perf
 The [[https://hackage.haskell.org/package/perf][perf]] library has been used to measure performance of the library.
 
-`cabal bench` runs the default benchmarking:
-
-#+begin_src sh :results output :exports both
-cabal bench
-#+end_src
-
 #+RESULTS:
 #+begin_example
 Running 1 benchmarks...