capnp 0.3.0.0 → 0.4.0.0

raw patch · 194 files changed

+31273/−13409 lines, 194 filesdep +asyncdep +focusdep +hashabledep −HUnitdep −arraydep −binarydep ~basedep ~bytesdep ~containersPVP ok

version bump matches the API change (PVP)

Dependencies added: async, focus, hashable, hspec, list-t, network, network-simple, safe-exceptions, stm, stm-containers, supervisors

Dependencies removed: HUnit, array, binary, cereal, dlist, test-framework, test-framework-hunit, test-framework-quickcheck2, utf8-string

Dependency ranges changed: base, bytes, containers, data-default, filepath, pretty-show, primitive

API changes (from Hackage documentation)

Files

• .gitattributes +2/−3
• .gitignore +25/−4
• .gitlab-ci.yml +17/−12
• CHANGELOG.md +30/−0
• CONTRIBUTING.md +39/−19
• README.md +26/−10
• capnp.cabal +181/−103
• ci/Dockerfile +56/−9
• ci/README.md +0/−3
• cmd/capnpc-haskell/Check.hs +57/−0
• cmd/capnpc-haskell/IR/Common.hs +128/−0
• cmd/capnpc-haskell/IR/Flat.hs +89/−0
• cmd/capnpc-haskell/IR/Haskell.hs +197/−0
• cmd/capnpc-haskell/IR/Name.hs +121/−0
• cmd/capnpc-haskell/IR/Pure.hs +80/−0
• cmd/capnpc-haskell/IR/Raw.hs +112/−0
• cmd/capnpc-haskell/IR/Stage1.hs +92/−0
• cmd/capnpc-haskell/Main.hs +61/−0
• cmd/capnpc-haskell/Trans/CgrToStage1.hs +306/−0
• cmd/capnpc-haskell/Trans/FlatToPure.hs +158/−0
• cmd/capnpc-haskell/Trans/FlatToRaw.hs +185/−0
• cmd/capnpc-haskell/Trans/HaskellToText.hs +298/−0
• cmd/capnpc-haskell/Trans/PureToHaskell.hs +730/−0
• cmd/capnpc-haskell/Trans/RawToHaskell.hs +866/−0
• cmd/capnpc-haskell/Trans/Stage1ToFlat.hs +235/−0
• cmd/capnpc-haskell/Trans/ToHaskellCommon.hs +235/−0
• core-schema/README.md +1/−1
• core-schema/capnp/json.capnp +59/−5
• core-schema/capnp/rpc.capnp +41/−31
• core-schema/capnp/schema.capnp +31/−0
• examples/gen/lib/Capnp/Gen/ById/X85150b117366d14b.hs +10/−0
• examples/gen/lib/Capnp/Gen/ById/X85150b117366d14b/Pure.hs +10/−0
• examples/gen/lib/Capnp/Gen/ById/Xd0a87f36fa0182f5.hs +10/−0
• examples/gen/lib/Capnp/Gen/ById/Xd0a87f36fa0182f5/Pure.hs +10/−0
• examples/gen/lib/Capnp/Gen/Calculator.hs +637/−0
• examples/gen/lib/Capnp/Gen/Calculator/Pure.hs +630/−0
• examples/gen/lib/Capnp/Gen/Echo.hs +131/−0
• examples/gen/lib/Capnp/Gen/Echo/Pure.hs +146/−0
• examples/lib/Examples/Rpc/CalculatorClient.hs +59/−0
• examples/lib/Examples/Rpc/CalculatorServer.hs +123/−0
• exe/capnpc-haskell/Backends/Common.hs +0/−32
• exe/capnpc-haskell/Backends/Pure.hs +0/−426
• exe/capnpc-haskell/Backends/Raw.hs +0/−669
• exe/capnpc-haskell/Fmt.hs +0/−57
• exe/capnpc-haskell/FrontEnd.hs +0/−541
• exe/capnpc-haskell/IR.hs +0/−262
• exe/capnpc-haskell/Main.hs +0/−31
• exe/capnpc-haskell/Util.hs +0/−28
• gen/lib/Capnp/Gen/ById/X8ef99297a43a5e34.hs +10/−0
• gen/lib/Capnp/Gen/ById/X8ef99297a43a5e34/Pure.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xa184c7885cdaf2a1.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xa184c7885cdaf2a1/Pure.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xa93fc509624c72d9.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xa93fc509624c72d9/Pure.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xb312981b2552a250.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xb312981b2552a250/Pure.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xb8630836983feed7.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xb8630836983feed7/Pure.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xbdf87d7bb8304e81.hs +10/−0
• gen/lib/Capnp/Gen/ById/Xbdf87d7bb8304e81/Pure.hs +10/−0
• gen/lib/Capnp/Gen/Capnp/Cxx.hs +24/−0
• gen/lib/Capnp/Gen/Capnp/Cxx/Pure.hs +28/−0
• gen/lib/Capnp/Gen/Capnp/Json.hs +403/−0
• gen/lib/Capnp/Gen/Capnp/Json/Pure.hs +253/−0
• gen/lib/Capnp/Gen/Capnp/Persistent.hs +250/−0
• gen/lib/Capnp/Gen/Capnp/Persistent/Pure.hs +270/−0
• gen/lib/Capnp/Gen/Capnp/Rpc.hs +1524/−0
• gen/lib/Capnp/Gen/Capnp/Rpc/Pure.hs +1066/−0
• gen/lib/Capnp/Gen/Capnp/RpcTwoparty.hs +288/−0
• gen/lib/Capnp/Gen/Capnp/RpcTwoparty/Pure.hs +272/−0
• gen/lib/Capnp/Gen/Capnp/Schema.hs +2475/−0
• gen/lib/Capnp/Gen/Capnp/Schema/Pure.hs +1680/−0
• gen/lib/Internal/Gen/Instances.hs +308/−0
• gen/tests/Capnp/Gen/Aircraft.hs +3754/−0
• gen/tests/Capnp/Gen/Aircraft/Pure.hs +2942/−0
• gen/tests/Capnp/Gen/ById/X832bcc6686a26d56.hs +10/−0
• gen/tests/Capnp/Gen/ById/X832bcc6686a26d56/Pure.hs +10/−0
• lib/Capnp.hs +77/−5
• lib/Capnp/Address.hs +87/−0
• lib/Capnp/Basics.hs +159/−0
• lib/Capnp/Basics/Pure.hs +96/−0
• lib/Capnp/Bits.hs +130/−0
• lib/Capnp/ById/X8ef99297a43a5e34.hs +0/−8
• lib/Capnp/ById/X8ef99297a43a5e34/Pure.hs +0/−8
• lib/Capnp/ById/Xa184c7885cdaf2a1.hs +0/−8
• lib/Capnp/ById/Xa184c7885cdaf2a1/Pure.hs +0/−8
• lib/Capnp/ById/Xa93fc509624c72d9.hs +0/−8
• lib/Capnp/ById/Xa93fc509624c72d9/Pure.hs +0/−8
• lib/Capnp/ById/Xb312981b2552a250.hs +0/−8
• lib/Capnp/ById/Xb312981b2552a250/Pure.hs +0/−8
• lib/Capnp/ById/Xb8630836983feed7.hs +0/−8
• lib/Capnp/ById/Xb8630836983feed7/Pure.hs +0/−8
• lib/Capnp/ById/Xbdf87d7bb8304e81.hs +0/−8
• lib/Capnp/ById/Xbdf87d7bb8304e81/Pure.hs +0/−8
• lib/Capnp/Capnp.hs +0/−8
• lib/Capnp/Capnp/Cxx.hs +0/−28
• lib/Capnp/Capnp/Cxx/Pure.hs +0/−35
• lib/Capnp/Capnp/Json.hs +0/−227
• lib/Capnp/Capnp/Json/Pure.hs +0/−147
• lib/Capnp/Capnp/Persistent.hs +0/−95
• lib/Capnp/Capnp/Persistent/Pure.hs +0/−81
• lib/Capnp/Capnp/Rpc.hs +0/−1228
• lib/Capnp/Capnp/Rpc/Pure.hs +0/−751
• lib/Capnp/Capnp/RpcTwoparty.hs +0/−191
• lib/Capnp/Capnp/RpcTwoparty/Pure.hs +0/−134
• lib/Capnp/Capnp/Schema.hs +0/−1870
• lib/Capnp/Capnp/Schema/Pure.hs +0/−1034
• lib/Capnp/Classes.hs +371/−0
• lib/Capnp/Convert.hs +123/−0
• lib/Capnp/Errors.hs +54/−0
• lib/Capnp/Gen.hs +9/−0
• lib/Capnp/Gen/Capnp.hs +8/−0
• lib/Capnp/GenHelpers.hs +76/−0
• lib/Capnp/GenHelpers/Pure.hs +63/−0
• lib/Capnp/GenHelpers/ReExports.hs +11/−0
• lib/Capnp/GenHelpers/ReExports/Control/Concurrent/STM.hs +5/−0
• lib/Capnp/GenHelpers/ReExports/Data/ByteString.hs +5/−0
• lib/Capnp/GenHelpers/ReExports/Data/Default.hs +5/−0
• lib/Capnp/GenHelpers/ReExports/Data/Text.hs +5/−0
• lib/Capnp/GenHelpers/ReExports/Data/Vector.hs +5/−0
• lib/Capnp/GenHelpers/ReExports/Supervisors.hs +5/−0
• lib/Capnp/GenHelpers/Rpc.hs +63/−0
• lib/Capnp/IO.hs +124/−0
• lib/Capnp/Message.hs +558/−0
• lib/Capnp/Pointer.hs +156/−0
• lib/Capnp/Rpc.hs +58/−0
• lib/Capnp/Rpc/Errors.hs +78/−0
• lib/Capnp/Rpc/Invoke.hs +118/−0
• lib/Capnp/Rpc/Promise.hs +136/−0
• lib/Capnp/Rpc/Server.hs +257/−0
• lib/Capnp/Rpc/Transport.hs +66/−0
• lib/Capnp/Rpc/Untyped.hs +1945/−0
• lib/Capnp/Rpc/Untyped.hs-boot +8/−0
• lib/Capnp/TraversalLimit.hs +129/−0
• lib/Capnp/Tutorial.hs +624/−0
• lib/Capnp/Untyped.hs +926/−0
• lib/Capnp/Untyped/Pure.hs +225/−0
• lib/Codec/Capnp.hs +3/−3
• lib/Data/Capnp.hs +0/−76
• lib/Data/Capnp/Address.hs +0/−104
• lib/Data/Capnp/Basics.hs +0/−119
• lib/Data/Capnp/Basics/Pure.hs +0/−75
• lib/Data/Capnp/Bits.hs +0/−133
• lib/Data/Capnp/Classes.hs +0/−259
• lib/Data/Capnp/Convert.hs +0/−118
• lib/Data/Capnp/Errors.hs +0/−54
• lib/Data/Capnp/GenHelpers.hs +0/−67
• lib/Data/Capnp/GenHelpers/Pure.hs +0/−40
• lib/Data/Capnp/IO.hs +0/−61
• lib/Data/Capnp/Message.hs +0/−417
• lib/Data/Capnp/Pointer.hs +0/−143
• lib/Data/Capnp/TraversalLimit.hs +0/−118
• lib/Data/Capnp/Tutorial.hs +0/−495
• lib/Data/Capnp/Untyped.hs +0/−893
• lib/Data/Capnp/Untyped/Pure.hs +0/−247
• lib/Internal/AppendVec.hs +13/−4
• lib/Internal/BuildPure.hs +14/−7
• lib/Internal/Finalizer.hs +67/−0
• lib/Internal/Gen/Instances.hs +0/−162
• lib/Internal/Rc.hs +72/−0
• lib/Internal/SnocList.hs +39/−0
• lib/Internal/TCloseQ.hs +69/−0
• lib/Internal/Util.hs +0/−17
• scripts/README.md +2/−2
• scripts/format.sh +1/−3
• scripts/gen-basic-instances.hs +17/−9
• scripts/hlint.sh +1/−3
• scripts/regen.sh +36/−8
• tests/CalculatorExample.hs +97/−0
• tests/Instances.hs +115/−44
• tests/Main.hs +30/−18
• tests/Module/Capnp/Basics.hs +29/−0
• tests/Module/Capnp/Bits.hs +46/−0
• tests/Module/Capnp/Gen/Capnp/Schema.hs +50/−0
• tests/Module/Capnp/Gen/Capnp/Schema/Pure.hs +512/−0
• tests/Module/Capnp/Pointer.hs +74/−0
• tests/Module/Capnp/Rpc.hs +440/−0
• tests/Module/Capnp/Untyped.hs +339/−0
• tests/Module/Capnp/Untyped/Pure.hs +57/−0
• tests/Regression.hs +38/−0
• tests/SchemaGeneration.hs +182/−0
• tests/SchemaQuickCheck.hs +62/−0
• tests/Tests/Module/Capnp/Capnp/Schema.hs +0/−53
• tests/Tests/Module/Capnp/Capnp/Schema/Pure.hs +0/−505
• tests/Tests/Module/Data/Capnp/Bits.hs +0/−51
• tests/Tests/Module/Data/Capnp/Pointer.hs +0/−83
• tests/Tests/Module/Data/Capnp/Untyped.hs +0/−343
• tests/Tests/Module/Data/Capnp/Untyped/Pure.hs +0/−60
• tests/Tests/SchemaGeneration.hs +0/−182
• tests/Tests/SchemaQuickCheck.hs +0/−58
• tests/Tests/Util.hs +0/−106
• tests/Tests/WalkSchemaCodeGenRequest.hs +0/−93
• tests/Util.hs +104/−0
• tests/WalkSchemaCodeGenRequest.hs +98/−0

@@ -1,4 +1,3 @@ # Mark generated output as such for GitHub diffs:-/lib/Capnp/ linguist-generated=true-/lib/Capnp/ linguist-generated=true-/lib/Internal/Gen/ linguist-generated=true+/gen/ linguist-generated=true+/examples/gen/ linguist-generated=true

@@ -1,8 +1,29 @@-/dist-/dist-newstyle+dist+dist-newstyle *.swp-/.cabal-sandbox-/cabal.sandbox.config+.cabal-sandbox+cabal.sandbox.config cabal.project.local+cabal.project.local~++# Profiler outputs (and formatted reports):+*.prof+*.hp+*.aux+*.ps+ .ghc.* result*++.hspec+.hspec-failures++# Code coverage:+.hpc+*.tix++# Generated code for examples & test suite. Note that we do *not*+# ignore generated code for the main library, as there are cyclic+# dependencies between it and the rest of the library.+/examples/Capnp+/tests/Capnp

@@ -10,19 +10,24 @@   - cabal update test:alltests:   image: zenhack/haskell-capnp-ci+  variables:+    CXX_CALCULATOR_CLIENT: /usr/local/bin/c++-calculator-client+    CXX_CALCULATOR_SERVER: /usr/local/bin/c++-calculator-server   script:-    - cabal new-build-    - cabal new-test-      # Linting:-    - ./scripts/hlint.sh-      # Run stylish-haskell, and fail if it changes anything:-    - ./scripts/format.sh-    - git diff --exit-code-      # Regenerate the schema, and make sure they're in-sync-      # with what was committed:+    # First build the code generator plugin.+    - cabal new-build capnpc-haskell+    # Then, regenerate the schema modules, and make sure they're in-sync+    # with what was committed. This is also necessary to generate the+    # Schema modules used by the test suite, which are not committed.     - ./scripts/regen.sh     - git diff --exit-code-      # Regenerate our other generated modules, and make sure-      # they're in-sync.-    - runhaskell scripts/gen-basic-instances.hs+    # Now build everything else (incl. examples):+    - cabal new-build all+    # ...run the tests. We use new-run so we can pass rts options+    # to the test binary -- these tell it to parallelize the tests.+    - cabal new-run test:tests -- +RTS -N+    # Linting:+    - ./scripts/hlint.sh+    # Run stylish-haskell, and fail if it changes anything:+    - ./scripts/format.sh     - git diff --exit-code

@@ -1,3 +1,33 @@+# 0.4.0.0++* RPC support! This should be considered alpha quality for now. The API+  will likely change substantially.+* Many bug fixes; users are strongly encouraged to upgrade.+* Reorganization of the module hierarchy:+  * Generated code is now placed under `Capnp.Gen`, rather than `Capnp`.+  * The `Data` prefix has been removed from the `Data.Capnp` hierarchy.+* The included generated modules for the core schema have been updated+  to those shipped with version 0.7 of the reference implementation.+* Other miscellaneous API Changes:+  * `createPure` can now be used with any instance of `MonadThrow`, not+    just `Either SomeException`.+  * `LimitT m` is now an instance of `MonadIO`, provided that `m` is an+    instance.+  * More type class instances from elsewhere in the library are+    re-exported via the `Capnp` module.+  * The `IsPtr` type class has been split into `FromPtr` and `ToPtr`. Most+    user code should not care about this.+  * Generated high-level types no longer have Read instances; interfaces+    make this problematic.+  * Getters for anonymous unions are now `get_Foo'` instead of+    `get_Foo'union'`.+  * `newMessage` now accepts an optional size hint.+  * Instances of `Cerialize` now exist/are generated for+    `(Vector (Vector (Vector ...)))` up to a reasonable depth.+* Other improvements not directly reflected in the API:+  * The allocation strategy has changed to reduce unnecessary copying.+  * It is now possible to create messages with a size > 2GiB. Note that+    individual segments are still limited.  # 0.3.0.0 

@@ -1,7 +1,36 @@ Firstly, thanks! -# Style+The easiest way to contribute is just feedback: use the library, let me+know how the experience was. Tell me how you're using the library. Open+issues if you find them. +If you're looking to hack on the library, great! If you don't have+something specific in mind and you're looking for a task to get your+feet wet, there are a number of open issues labeled+["good first issue"](https://github.com/zenhack/haskell-capnp/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22);+these are self-contained, well-defined tasks that touch a relatively+small portion of the code, and so don't require deep understanding of+the structure of the library as a whole; as such they're great for new+contributors. If you want to work on an existing issue, leave a comment+on the issue saying you're planning on tacking a whack at it.  I'll+probably reply before too long. Send a pull request when you've got+something to review.++# Comments++A couple guidelines re comments:++* For implementation notes inside the code, we adopt GHC's [Note+  convention][2].+* Each thing that is exported from a module must have a haddock comment+  briefly describing what it does and how to use it. Most non-exported+  top level identifiers should have these as well, but this is more+  flexible.+* Prefer end-of-line (`--`) comments over block comments; very large+  block comments can confuse syntax highlighting in some editors.++# Style Guide+ Generally, do what the rest of the code does. Much of this section is bikeshed, but consistency is worth a bit of that. @@ -11,24 +40,14 @@   to change your code, let it; this solves a lot of consistency issues   without us needing to remember anything, and it gets run as part of   our CI, so failing to use it will likely cause failures. Running-  `./format.sh will apply it to the entire source tree, using this+  `./format.sh` will apply it to the entire source tree, using this   project's rules, but we recommend you configure your editor to use it   automatically. * Use a tabstop of 4 spaces in Haskell source code, 2 spaces in the   cabal file.-* Don't align things unless stylish-haskell wants to. It will get basic-  things like: -```haskell-data MyRecord = MyRecord-    { short      :: Int-    , longerName :: Bool-    }-```--Where it doesn't contradict you, use more regular indentation.--Bad:+Where stylish-haskell doesn't contradict you, use more regular+indentation. Bad:  ```haskell data MyVariant = Apples Int@@ -118,17 +137,18 @@  -- same structure for modules within our library: -import Data.Capnp.Untyped hiding (length)+import Capnp.Untyped hiding (length) -import Data.Capnp.Bits+import Capnp.Bits -import Data.Capnp.TraversalLimit(defaultLimit, evalLimitT)+import Capnp.TraversalLimit(defaultLimit, evalLimitT) -import qualified Data.Capnp.Message as M-import qualified Data.Capnp.Basics as B+import qualified Capnp.Message as M+import qualified Capnp.Basics as B ```  The formatter will take care of formatting the sections correctly, as long as you keep the line-breaks right.  [1]: https://github.com/jaspervdj/stylish-haskell+[2]: https://ghc.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Commentsinthesourcecode

@@ -1,28 +1,44 @@ [![build status][ci-img]][ci] [![hackage][hackage-img]][hackage] -A Haskell library for the [Cap'N Proto][1] Cerialization protocol.+A Haskell library for the [Cap'N Proto][1] Cerialization and RPC+protocol. -Serialization (read & write) support is mostly finished, and already-usable, with some limitations:+# Getting Started +There is a module `Capnp.Tutorial` which contains an introduction+to the library; users are *strongly* encouraged to read this first, as+the reference documentation can be bewildering without that context.++# Status++Serialization support works, with some limitations:+ * Generated schema currently ignore type parameters ([#29][issue29]).-* Schema which define custom default values for fields of pointer type-  are rejected ([#28][issue28]).+* We do not support define custom default values for fields of pointer+  type; see ([#28][issue28]). * We currently do not correctly handle decoding lists of structs from   non-composite lists ([#27][issue27]). This means that, contrary to the   [protocol evolution rules][2], it is not safe to change a field from   type List(T) (where T is any non-struct type) to a list of a struct   type. -There is a module `Data.Capnp.Tutorial` which contains an introduction-to the library; users are *strongly* encouraged to read this first, as-the reference documentation can be bewildering without that context.+Level 1 RPC support is implemented and usable, though there are a couple+gaps in the API. It should be considered alpha quality for now. Specific+things to be aware of: +* The implementation is *not* robust against resource exhaustion+  attacks; for now users are strongly discouraged from using it to do+  RPC with untrusted peers.+* While most of the machinery for it is in place, the API does not+  currently expose a way to do field projection on remote promises.+  As a consequence, actually pipelining method calls is not currently+  possible, so the library is currently best suited to environments+  which are already low-latency.+ The API is considered unstable. It will likely see changes, for the sake of polish, consistency, etc. as well as to improve performance and-accommodate more features as we add them (RPC in particular will-probably require changing some interfaces).+accommodate more features as we add them.  [1]: https://capnproto.org/ [2]: https://capnproto.org/language.html#evolving-your-protocol

@@ -1,8 +1,7 @@ cabal-version:            2.2 name:                     capnp-version:                  0.3.0.0-stability:                Experimental-category:                 Data, Serialization+version:                  0.4.0.0+category:                 Data, Serialization, Network, Rpc copyright:                2016-2018 haskell-capnp contributors (see CONTRIBUTORS file). author:                   Ian Denhardt maintainer:               ian@zenhack.net@@ -12,14 +11,12 @@ bug-reports:              https://github.com/zenhack/haskell-capnp/issues synopsis:                 Cap'n Proto for Haskell description:-  A native Haskell implementation of the Cap'N Proto cerialization format.+  A native Haskell implementation of the Cap'N Proto cerialization format and+  RPC protocol.   .-  This library is currently serialization-only. RPC support is planned but not-  yet implemented. It works, but bear in mind that the API is considered-  unstable, and is likely to change to accomodate RPC, facilitate improved-  performance, etc.+  The library implements serialization and level 1 RPC.   .-  The "Data.Capnp.Tutorial" module is the best place to start reading; the+  The "Capnp.Tutorial" module is the best place to start reading; the   reference documentation can seem bewildering without that context. build-type:               Simple extra-source-files:@@ -44,12 +41,11 @@   , .gitattributes   , .gitignore   , .gitlab-ci.yml-  -- FIXME: add a CHANGELOG.md and add it to this list tested-with:   -- Our Gitlab CI uses this version:-    GHC == 8.2.1+    GHC == 8.4.3   -- @zenhack currently uses this version:-  , GHC == 8.4.3+  , GHC == 8.6.3  -------------------------------------------------------------------------------- @@ -62,149 +58,231 @@  common shared-opts   build-depends:-        base                              >= 4.8  && < 5.0-      , array                             ^>= 0.5+        base                              >= 4.11  && < 4.13       , bytes                             ^>= 0.15.4       , bytestring                        ^>= 0.10+      , containers                        ^>= 0.5.9+      , data-default                      ^>= 0.7.1       , exceptions                        ^>= 0.10.0       , mtl                               ^>= 2.2.2       , primitive                         ^>= 0.6.3       , reinterpret-cast                  ^>= 0.1.0+      , safe-exceptions                   ^>= 0.1.7       , text                              >= 1.2 && < 2.0       , transformers                      ^>= 0.5.2       , vector                            ^>= 0.12.0   ghc-options:-    -Wnoncanonical-monad-instances-    -Wincomplete-patterns-    -Wunused-imports+    -Wall++    -- This warning is triggered by normal use of NamedFieldPuns, so it's a no-go+    -- for us:+    -Wno-name-shadowing++    -- I(zenhack) find it rather odd that orphan instances are flagged when the+    -- class and the type are in different modules but, the same *package*. We do+    -- this in a number of places in the capnp package, so we disable this+    -- warning. It's not super easy to write a package-level orphan by accident,+    -- so we're not losing much.+    -Wno-orphans   default-language:     Haskell2010  -------------------------------------------------------------------------------- +-- main runtime library. library     import: shared-opts-    hs-source-dirs:       lib+    hs-source-dirs:+      lib+      -- generated code:+      gen/lib     exposed-modules:-        Data.Capnp-      , Data.Capnp.Address-      , Data.Capnp.Basics-      , Data.Capnp.Basics.Pure-      , Data.Capnp.Bits-      , Data.Capnp.Classes-      , Data.Capnp.Convert-      , Data.Capnp.Errors-      , Data.Capnp.GenHelpers-      , Data.Capnp.GenHelpers.Pure-      , Data.Capnp.IO-      , Data.Capnp.Message-      , Data.Capnp.Pointer-      , Data.Capnp.Untyped-      , Data.Capnp.Untyped.Pure-      , Data.Capnp.TraversalLimit-      , Data.Capnp.Tutorial+        Capnp+      , Capnp.Address+      , Capnp.Basics+      , Capnp.Basics.Pure+      , Capnp.Bits+      , Capnp.Classes+      , Capnp.Convert+      , Capnp.Errors+      , Capnp.GenHelpers+      , Capnp.GenHelpers.Pure+      , Capnp.GenHelpers.Rpc+      , Capnp.IO+      , Capnp.Message+      , Capnp.Pointer+      , Capnp.Untyped+      , Capnp.Untyped.Pure+      , Capnp.TraversalLimit+      , Capnp.Rpc+      , Capnp.Rpc.Promise+      , Capnp.Rpc.Invoke+      , Capnp.Rpc.Untyped+      , Capnp.Rpc.Errors+      , Capnp.Rpc.Transport+      , Capnp.Rpc.Server+      , Capnp.Tutorial +      , Capnp.GenHelpers.ReExports+      , Capnp.GenHelpers.ReExports.Supervisors+      , Capnp.GenHelpers.ReExports.Data.Default+      , Capnp.GenHelpers.ReExports.Data.Text+      , Capnp.GenHelpers.ReExports.Data.ByteString+      , Capnp.GenHelpers.ReExports.Data.Vector+      , Capnp.GenHelpers.ReExports.Control.Concurrent.STM+       , Data.Mutable -      , Capnp-      , Capnp.Capnp+      , Capnp.Gen+      , Capnp.Gen.Capnp        -- BEGIN GENERATED SCHEMA MODULES-      , Capnp.Capnp.Cxx.Pure-      , Capnp.Capnp.Json.Pure-      , Capnp.Capnp.Persistent.Pure-      , Capnp.Capnp.Rpc.Pure-      , Capnp.Capnp.RpcTwoparty.Pure-      , Capnp.Capnp.Schema.Pure-      , Capnp.Capnp.Cxx-      , Capnp.Capnp.Json-      , Capnp.Capnp.Persistent-      , Capnp.Capnp.Rpc-      , Capnp.Capnp.RpcTwoparty-      , Capnp.Capnp.Schema-      , Capnp.ById.Xbdf87d7bb8304e81.Pure-      , Capnp.ById.X8ef99297a43a5e34.Pure-      , Capnp.ById.Xb8630836983feed7.Pure-      , Capnp.ById.Xb312981b2552a250.Pure-      , Capnp.ById.Xa184c7885cdaf2a1.Pure-      , Capnp.ById.Xa93fc509624c72d9.Pure-      , Capnp.ById.Xbdf87d7bb8304e81-      , Capnp.ById.X8ef99297a43a5e34-      , Capnp.ById.Xb8630836983feed7-      , Capnp.ById.Xb312981b2552a250-      , Capnp.ById.Xa184c7885cdaf2a1-      , Capnp.ById.Xa93fc509624c72d9+      , Capnp.Gen.Capnp.Cxx.Pure+      , Capnp.Gen.Capnp.Json.Pure+      , Capnp.Gen.Capnp.Persistent.Pure+      , Capnp.Gen.Capnp.Rpc.Pure+      , Capnp.Gen.Capnp.RpcTwoparty.Pure+      , Capnp.Gen.Capnp.Schema.Pure+      , Capnp.Gen.Capnp.Cxx+      , Capnp.Gen.Capnp.Json+      , Capnp.Gen.Capnp.Persistent+      , Capnp.Gen.Capnp.Rpc+      , Capnp.Gen.Capnp.RpcTwoparty+      , Capnp.Gen.Capnp.Schema+      , Capnp.Gen.ById.Xbdf87d7bb8304e81.Pure+      , Capnp.Gen.ById.X8ef99297a43a5e34.Pure+      , Capnp.Gen.ById.Xb8630836983feed7.Pure+      , Capnp.Gen.ById.Xb312981b2552a250.Pure+      , Capnp.Gen.ById.Xa184c7885cdaf2a1.Pure+      , Capnp.Gen.ById.Xa93fc509624c72d9.Pure+      , Capnp.Gen.ById.Xbdf87d7bb8304e81+      , Capnp.Gen.ById.X8ef99297a43a5e34+      , Capnp.Gen.ById.Xb8630836983feed7+      , Capnp.Gen.ById.Xb312981b2552a250+      , Capnp.Gen.ById.Xa184c7885cdaf2a1+      , Capnp.Gen.ById.Xa93fc509624c72d9       -- END GENERATED SCHEMA MODULES     other-modules:-        Internal.Util-      , Internal.AppendVec+        Internal.AppendVec+      , Internal.Finalizer+      , Internal.SnocList+      , Internal.Rc+      , Internal.TCloseQ       , Internal.Gen.Instances       , Internal.BuildPure       , Codec.Capnp     -- other-extensions:     build-depends:         cpu                               ^>= 0.1.2-      , data-default                      ^>= 0.7.1+      , hashable                          ^>= 1.2.7       , data-default-instances-vector     ^>= 0.0.1+      , stm                               ^>= 2.5.0+      , stm-containers                    ^>= 1.1.0+      , list-t                            ^>= 1.0.2+      , focus                             ^>= 1.0.1+      , async                             ^>= 2.2.1+      , network-simple                    ^>= 0.4+      , network                           ^>= 2.8.0+      , supervisors                       ^>= 0.2.0+      , pretty-show                       ^>= 1.9.5  -------------------------------------------------------------------------------- +-- code generator plugin executable capnpc-haskell-    import: shared-opts-    main-is:              Main.hs-    other-modules:-        FrontEnd-      , Fmt-      , IR-      , Backends.Common-      , Backends.Pure-      , Backends.Raw-      , Util-    hs-source-dirs:       exe/capnpc-haskell-    build-depends:-        capnp-      , binary                            ^>= 0.8.5-      , cereal                            ^>= 0.5.5-      , containers                        ^>= 0.5.10-      , directory                         ^>= 1.3.0-      , dlist                             ^>= 0.8.0-      , filepath                          ^>= 1.4.1-      , utf8-string                       ^>= 1.0.1-      , wl-pprint-text                    ^>= 1.2+  import: shared-opts+  hs-source-dirs:       cmd/capnpc-haskell+  main-is: Main.hs+  other-modules:+      IR.Name+    , IR.Common+    , IR.Stage1+    , IR.Flat+    , IR.Pure+    , IR.Raw+    , IR.Haskell+    , Trans.CgrToStage1+    , Trans.Stage1ToFlat+    , Trans.FlatToRaw+    , Trans.FlatToPure+    , Trans.ToHaskellCommon+    , Trans.PureToHaskell+    , Trans.RawToHaskell+    , Trans.HaskellToText+    , Check+  build-depends:+      capnp+    , wl-pprint-text ^>= 1.2+    , filepath ^>= 1.4.2+    , directory ^>= 1.3.0  -------------------------------------------------------------------------------- -test-suite simple-tests+test-suite tests     import: shared-opts     type:                 exitcode-stdio-1.0     main-is:              Main.hs-    hs-source-dirs:       tests+    hs-source-dirs:+      tests+      gen/tests+      examples/lib+      examples/gen/lib+    ghc-options:+      -threaded     other-modules:-        Tests.Module.Capnp.Capnp.Schema-      , Tests.Module.Capnp.Capnp.Schema.Pure-      , Tests.Module.Data.Capnp.Untyped-      , Tests.Module.Data.Capnp.Untyped.Pure-      , Tests.Module.Data.Capnp.Pointer-      , Tests.Module.Data.Capnp.Bits-      , Tests.WalkSchemaCodeGenRequest-      , Tests.SchemaGeneration-      , Tests.SchemaQuickCheck-      , Tests.Util+      -- Utilities+        Util       , Instances+      , SchemaGeneration++      , Examples.Rpc.CalculatorClient+      , Examples.Rpc.CalculatorServer++      -- Generated code for examples/calculator.capnp+      , Capnp.Gen.ById.X85150b117366d14b+      , Capnp.Gen.ById.X85150b117366d14b.Pure+      , Capnp.Gen.Calculator+      , Capnp.Gen.Calculator.Pure++      -- Generated code for examples/echo.capnp+      , Capnp.Gen.Echo+      , Capnp.Gen.Echo.Pure+      , Capnp.Gen.ById.Xd0a87f36fa0182f5+      , Capnp.Gen.ById.Xd0a87f36fa0182f5.Pure++      -- generated from tests/data/aircraft.capnp+      , Capnp.Gen.Aircraft+      , Capnp.Gen.Aircraft.Pure+      , Capnp.Gen.ById.X832bcc6686a26d56+      , Capnp.Gen.ById.X832bcc6686a26d56.Pure++      -- Actual tests:+      , Module.Capnp.Gen.Capnp.Schema+      , Module.Capnp.Gen.Capnp.Schema.Pure+      , Module.Capnp.Rpc+      , Module.Capnp.Untyped+      , Module.Capnp.Untyped.Pure+      , Module.Capnp.Pointer+      , Module.Capnp.Bits+      , Module.Capnp.Basics+      , Regression+      , WalkSchemaCodeGenRequest+      , SchemaQuickCheck+      , CalculatorExample     build-depends:         capnp-      , data-default+      , network+      , network-simple+      , stm+      , async       , process       , process-extras       , QuickCheck       , quickcheck-io       , quickcheck-instances-      , HUnit-      , test-framework-      , test-framework-hunit-      , test-framework-quickcheck2-      , binary+      , hspec       , directory       , resourcet       , heredoc       , deepseq       , pretty-show+      , supervisors

@@ -1,18 +1,65 @@-FROM haskell+FROM alpine:3.8 WORKDIR /usr/src/ -# Install various system packages needed for building capnproto.-RUN apt-get update-RUN apt-get install -y wget file make+# Cabal does not like busybox's wget:+RUN apk add \+	wget -# Build and install a recent version of capnproto. jessie-backports has 0.5.3,-# which is missing some features used in our test suite.-RUN wget "https://capnproto.org/capnproto-c++-0.6.1.tar.gz"-RUN tar -xvf *.tar.gz-RUN cd capnproto-*/ && ./configure --prefix=/usr/local && make && make install+# Install the Haskell tooling.+RUN apk add \+	build-base \+	ghc \+	cabal  # Install the linters up front; this saves a lot of build time during the actual # CI run. RUN cabal update RUN cabal install happy alex RUN cabal install hlint stylish-haskell++# We're getting an error from cabal re: creating these symlinks automatically,+# so we just do it ourselves. TODO: figure out why this is happening++RUN ln -s /root/.cabal/bin/hlint /usr/local/bin/hlint+RUN ln -s /root/.cabal/bin/stylish-haskell /usr/local/bin/stylish-haskell++# Install stuff needed to build capnproto:+RUN apk add \+	autoconf \+	automake \+	libtool \+	linux-headers++# Build and install a recent version of capnproto; it isn't in the alpine+# repos. Furthermore, we use the calculator-client & server examples as+# part of our test suite, so we need to build that anyway:+RUN wget "https://github.com/capnproto/capnproto/archive/v0.6.1.tar.gz"+RUN tar -xvf *.tar.gz+RUN cd capnproto-*/c++ && \+	autoreconf -i && \+	./configure --prefix=/usr/local && \+	make -j && \+	make install++# Build and install the C++ calculator example client & server, which+# we'll use to validate our own implementations:+RUN cd capnproto-*/c++/samples && \+	capnpc -oc++ calculator.capnp && \+	c++ \+		calculator-client.c++ \+		-std=c++14 \+		calculator.capnp.c++ \+		$(pkg-config --cflags --libs capnp-rpc) \+		-o calculator-client && \+	c++ \+		calculator-server.c++ \+		-std=c++14 \+		calculator.capnp.c++ \+		$(pkg-config --cflags --libs capnp-rpc) \+		-o calculator-server && \+	install -Dm755 calculator-client /usr/local/bin/c++-calculator-client && \+	install -Dm755 calculator-server /usr/local/bin/c++-calculator-server++# Add other tools we use during the run:+RUN apk add \+	git

@@ -3,6 +3,3 @@ <https://hub.docker.com/r/zenhack/haskell-capnp-ci/>  ...which is used by ../.gitlab-ci.yml.--It's just the standard haskell docker image, plus capnproto 0.6.1 and-some linters already installed.

@@ -0,0 +1,57 @@+{-# LANGUAGE DuplicateRecordFields #-}+{-# LANGUAGE LambdaCase            #-}+{-# LANGUAGE NamedFieldPuns        #-}+module Check (reportIssues) where++import Data.Foldable (for_)+import System.IO     (hPutStrLn, stderr)++import qualified Data.Vector as V++import Capnp.Gen.Capnp.Schema.Pure++-- | Scan the code generator request for certain issues, and warn the user+-- if found.+--+-- We still assume the input is *valid*, so these are issues regarding things+-- that our implementation can't handle.+reportIssues :: CodeGeneratorRequest -> IO ()+reportIssues CodeGeneratorRequest{nodes} =+    let problemFields =+            [ (displayName, name)+            | Node{displayName, union'=Node'struct Node'struct'{fields}} <- V.toList nodes+            , Field+                { name+                , union'=Field'slot Field'slot'{hadExplicitDefault, defaultValue}+                } <- V.toList fields+            , hadExplicitDefault && isPtrValue defaultValue+            ]+    in+    for_ problemFields $ \(displayName, name) ->+        hPutStrLn stderr $ concat+            [ "WARNING: the field ", show name, " in ", show displayName, "\n"+            , " has a custom default value, but haskell-capnp does not\n"+            , " support this for pointer-valued fields. The custom\n"+            , " default will be ignored; please be careful. See:\n"+            , "\n"+            , "https://github.com/zenhack/haskell-capnp/issues/28\n"+            , "\n"+            , "for more information.\n"+            ]++isPtrValue :: Value -> Bool+isPtrValue = \case+    Value'void -> False+    Value'bool _ -> False+    Value'int8 _ -> False+    Value'int16 _ -> False+    Value'int32 _ -> False+    Value'int64 _ -> False+    Value'uint8 _ -> False+    Value'uint16 _ -> False+    Value'uint32 _ -> False+    Value'uint64 _ -> False+    Value'float32 _ -> False+    Value'float64 _ -> False+    Value'enum _ -> False+    _ -> True

@@ -0,0 +1,128 @@+-- Data types that are used by more than one intermediate form.+-- See also IR.Name, which defines identifiers, which are also+-- used in more than one IR.+{-# LANGUAGE DeriveFunctor #-}+{-# LANGUAGE LambdaCase    #-}+module IR.Common where++import Data.Word++import qualified Capnp.Untyped.Pure as U++newtype TypeId = TypeId Word64+    deriving(Show, Read, Eq, Ord)++data IntType = IntType !Sign !IntSize+    deriving(Show, Read, Eq)++data Sign+    = Signed+    | Unsigned+    deriving(Show, Read, Eq)++data IntSize+    = Sz8+    | Sz16+    | Sz32+    | Sz64+    deriving(Show, Read, Eq)++sizeBits :: IntSize -> Int+sizeBits Sz8  = 8+sizeBits Sz16 = 16+sizeBits Sz32 = 32+sizeBits Sz64 = 64++-- | Return the size in bits of a type that belongs in the data section of a struct.+dataFieldSize :: WordType r -> Int+dataFieldSize = \case+    EnumType _                          -> 16+    PrimWord (PrimInt (IntType _ size)) -> sizeBits size+    PrimWord PrimFloat32                -> 32+    PrimWord PrimFloat64                -> 64+    PrimWord PrimBool                   -> 1++-- Capnproto types. The 'r' type parameter is the type of references to other nodes,+-- which may be different in different stages of the pipeline.++data Type r+    = CompositeType (CompositeType r)+    | VoidType+    | WordType (WordType r)+    | PtrType (PtrType r)+    deriving(Show, Read, Eq, Functor)++newtype CompositeType r+    = StructType r+    deriving(Show, Read, Eq, Functor)++data WordType r+    = EnumType r+    | PrimWord PrimWord+    deriving(Show, Read, Eq, Functor)++data PtrType r+    = ListOf (Type r)+    | PrimPtr PrimPtr+    | PtrComposite (CompositeType r)+    | PtrInterface r+    deriving(Show, Read, Eq, Functor)++data PrimWord+    = PrimInt IntType+    | PrimFloat32+    | PrimFloat64+    | PrimBool+    deriving(Show, Read, Eq)++data PrimPtr+    = PrimText+    | PrimData+    | PrimAnyPtr AnyPtr+    deriving(Show, Read, Eq)++data AnyPtr+    = Struct+    | List+    | Cap+    | Ptr+    deriving(Show, Read, Eq)++-- | The type and location of a field.+data FieldLocType r+    -- | The field is in the struct's data section.+    = DataField DataLoc (WordType r)+    -- | The field is in the struct's pointer section (the argument is the+    -- index).+    | PtrField !Word16 (PtrType r)+    -- | The field is a group or union; it's "location" is the whole struct.+    | HereField (CompositeType r)+    -- | The field is of type void (and thus is zero-size).+    | VoidField+    deriving(Show, Read, Eq, Functor)++-- | The location of a field within a struct's data section.+data DataLoc = DataLoc+    { dataIdx :: !Int+    -- ^ The index of the 64-bit word containing the field.+    , dataOff :: !Int+    -- ^ The bit offset inside the 64-bit word.+    , dataDef :: !Word64+    -- ^ The value is stored xor-ed with this value. This is used+    -- to allow for encoding default values. Note that this is xor-ed+    -- with the bits representing the value, not the whole word.+    }+    deriving(Show, Read, Eq)++data Value r+    = VoidValue+    | WordValue (WordType r) !Word64+    | PtrValue (PtrType r) (Maybe U.Ptr)+    deriving(Show, Eq, Functor)++-- | Extract the type from a 'FildLocType'.+fieldType :: FieldLocType r -> Type r+fieldType (DataField _ ty) = WordType ty+fieldType (PtrField _ ty)  = PtrType ty+fieldType (HereField ty)   = CompositeType ty+fieldType VoidField        = VoidType

@@ -0,0 +1,89 @@+{-# LANGUAGE DuplicateRecordFields #-}+{-# LANGUAGE NamedFieldPuns        #-}+module IR.Flat+    ( File(..)+    , CodeGenReq(..)+    , Node(..)+    , Node'(..)+    , Field(..)+    , Method(..)+    , Variant(..)+    , Union(..)+    ) where++import Data.Word++import qualified IR.Common as Common+import qualified IR.Name   as Name++data CodeGenReq = CodeGenReq+    { allNodes :: [Node]+    , reqFiles :: [File]+    }+    deriving(Show, Eq)++data File = File+    { nodes    :: [Node]+    , fileId   :: !Word64+    , fileName :: FilePath+    }+    deriving(Show, Eq)++data Node = Node+    { name   :: Name.CapnpQ+    , nodeId :: !Word64+    , union_ :: Node'+    }+    deriving(Show, Eq)++data Node'+    = Enum [Name.UnQ]+    | Struct+        { fields        :: [Field]+        -- ^ The struct's fields, excluding an anonymous union, if any.+        , isGroup       :: !Bool+        , dataWordCount :: !Word16+        , pointerCount  :: !Word16+        , union         :: Maybe Union+        -- ^ The struct's anonymous union, if any.+        }+    | Interface+        { methods   :: [Method]+        , supers    :: [Node]+        -- ^ Immediate superclasses+        , ancestors :: [Node]+        -- ^ All ancestors, including 'supers'.+        }+    | Constant+        { value :: Common.Value Node+        }+    | Other+    deriving(Show, Eq)+++data Method = Method+    { name       :: Name.UnQ+    , paramType  :: Name.CapnpQ+    , resultType :: Name.CapnpQ+    }+    deriving(Show, Eq)+++data Union = Union+    { tagOffset :: !Word32+    , variants  :: [Variant]+    }+    deriving(Show, Eq)++data Field = Field+    { fieldName    :: Name.CapnpQ+    , fieldLocType :: Common.FieldLocType Node+    }+    deriving(Show, Eq)++data Variant = Variant+    { tagValue :: !Word16+    , field    :: Field+    -- ^ The field's name is really the name of the variant.+    }+    deriving(Show, Eq)

@@ -0,0 +1,197 @@+{-# LANGUAGE DuplicateRecordFields #-}+{-# LANGUAGE NamedFieldPuns        #-}+{-# LANGUAGE OverloadedStrings     #-}+-- A last-leg intermediate form, before emitting actually Haskell source code.+--+-- This module contains a *simplified* Haskell AST; it only includes the+-- features we actually need. We roll our own for two reasons:+--+-- 1. Full Haskell ASTs are actually quite complex, and the data types exposed+--    by libraries for working with Haskell source reflect this. What we need+--    is much simpler.+-- 2. At some point we'll want to inject Haddock comments into the source (see+--    #32), and I(zenhack) don't see a good way to do that with the libraries+--    I looked at.+module IR.Haskell+    ( modFilePath++    , DataArgs(..)+    , DataDecl(..)+    , DataVariant(..)+    , ClassDecl(..)+    , Decl(..)+    , Do(..)+    , Exp(..)+    , Export(..)+    , Import(..)+    , InstanceDef(..)+    , Module(..)+    , Pattern(..)+    , Type(..)+    , TypeAlias(..)+    , ValueDef(..)+    ) where++import Data.List (intercalate)++import qualified Data.ByteString.Lazy as LBS+import qualified Data.Text            as T++import qualified IR.Common as Common+import qualified IR.Name   as Name++-- | A Haskell module+data Module = Module+    { modName        :: [Name.UnQ]+    -- ^ The parts of the module path+    , modLangPragmas :: [T.Text]+    -- ^ The language extensions enabled in this module.+    , modExports     :: Maybe [Export]+    -- ^ The export list. If it is 'Nothing' that means there is no export+    -- list (and therefore everything is exported).+    , modDecls       :: [Decl]+    -- ^ The declarations in the module.+    , modImports     :: [Import]+    -- ^ Modules to import.+    }+    deriving(Show, Read, Eq)++data Export+    = ExportMod [Name.UnQ] -- module Foo.Bar+    | ExportGCtors Name.GlobalQ -- Foo.Bar.Baz(..)+    | ExportLCtors Name.LocalQ -- Baz(..)+    | ExportGName Name.GlobalQ -- Foo.Bar.Baz+    | ExportLName Name.LocalQ -- Baz+    deriving(Show, Read, Eq)++data Import+    = ImportAs -- import qualified Foo.Bar as Bar+        { importAs :: Name.UnQ+        , parts    :: [Name.UnQ]+        }+    | ImportQual -- import qualified Foo.Bar+        { parts :: [Name.UnQ]+        }+    | ImportAll -- import Foo.Bar+        { parts :: [Name.UnQ]+        }+    deriving(Show, Read, Eq)++-- | A declaration.+data Decl+    = DcData DataDecl+    | DcValue+        { typ :: Type+        , def :: ValueDef+        }+    | DcInstance+        { ctx  :: [Type]+        , typ  :: Type+        , defs :: [InstanceDef]+        }+    | DcClass+        { ctx    :: [Type]+        , name   :: Name.LocalQ+        , params :: [Name.UnQ]+        , decls  :: [ClassDecl]+        }+    deriving(Show, Read, Eq)++data DataDecl = Data+    { dataName     :: Name.UnQ+    -- ^ The name of the declared type.+    , typeArgs     :: [Type]+    , dataVariants :: [DataVariant]+    -- ^ The variants/data constructors for the type.+    , derives      :: [Name.UnQ]+    -- ^ A list of type classes to include in the deriving clause.+    , dataNewtype  :: !Bool+    -- ^ Whether the declarationis a "newtype" or "data" declaration.+    }+    deriving(Show, Read, Eq)++data ClassDecl+    = CdValueDecl Name.UnQ Type+    | CdValueDef ValueDef+    | CdMinimal [Name.UnQ]+    -- ^ A MINIMAL pragma.+    deriving(Show, Read, Eq)++data InstanceDef+    = IdValue ValueDef+    | IdData DataDecl+    | IdType TypeAlias+    deriving(Show, Read, Eq)++data TypeAlias = TypeAlias Name.UnQ [Type] Type+    deriving(Show, Read, Eq)++data ValueDef = DfValue+    { name   :: Name.UnQ+    , value  :: Exp+    , params :: [Pattern]+    }+    deriving(Show, Read, Eq)++-- | A data constructor+data DataVariant = DataVariant+    { dvCtorName :: Name.UnQ+    -- ^ The name of the constructor.+    , dvArgs     :: DataArgs+    }+    deriving(Show, Read, Eq)++-- | Arguments to a data constructor+data DataArgs+    = APos [Type]+    | ARec [(Name.UnQ, Type)]+    deriving(Show, Read, Eq)++data Type+    = TGName Name.GlobalQ+    | TLName Name.LocalQ+    | TVar T.Text+    | TApp Type [Type]+    | TFn [Type]+    | TCtx [Type] Type+    | TPrim Common.PrimWord+    | TUnit+    deriving(Show, Read, Eq)++data Exp+    = EApp Exp [Exp]+    | EFApp Exp [Exp]+    -- ^ "Functorial" application, i.e. f <$> x <*> y <*> z.+    | EGName Name.GlobalQ+    | ELName Name.LocalQ+    | EInt Integer+    | EDo [Do] Exp+    | EBind Exp Exp+    -- ^ A call to (>>=)+    | ETup [Exp]+    | EBytes LBS.ByteString+    | ECase Exp [(Pattern, Exp)]+    | ETypeAnno Exp Type+    | ELambda [Pattern] Exp+    | ERecord Exp [(Name.UnQ, Exp)]+    deriving(Show, Read, Eq)++data Do+    = DoBind Name.UnQ Exp+    | DoE Exp+    deriving(Show, Read, Eq)++data Pattern+    = PVar T.Text+    | PLCtor Name.LocalQ [Pattern]+    | PGCtor Name.GlobalQ [Pattern]+    | PInt Integer+    -- | Name{..}+    | PLRecordWildCard Name.LocalQ+    deriving(Show, Read, Eq)++-- | Get the file path for a module. For example, the module @Foo.Bar.Baz@ will+-- have a file path of @Foo/Bar/Baz.hs@.+modFilePath :: Module -> FilePath+modFilePath Module{modName} =+    intercalate "/" (map (T.unpack . Name.renderUnQ) modName) ++ ".hs"