]> Git — Sourcephile - haskell/symantic-base.git/blob - symantic-base.cabal
doc: fix comment about `CurryN`
[haskell/symantic-base.git] / symantic-base.cabal
1 cabal-version: 3.0
2 name: symantic-base
3 maintainer: mailto:symantic-base@sourcephile.fr
4 bug-reports: https://mails.sourcephile.fr/inbox/symantic-base
5 homepage: https://git.sourcephile.fr/haskell/symantic-base
6 author: Julien Moutinho <julm+symantic-base@sourcephile.fr>
7 copyright: Julien Moutinho <julm+symantic-base@sourcephile.fr>
8 license: AGPL-3.0-or-later
9 license-file: LICENSES/AGPL-3.0-or-later.txt
10
11 -- PVP: +-+------- breaking API changes
12 -- | | +----- non-breaking API additions
13 -- | | | +--- code changes with no API change
14 version: 0.5.0.20221211
15 stability: experimental
16 category: Data Structures
17 synopsis:
18 Basic symantic combinators for Embedded Domain-Specific Languages (EDSL)
19
20 description:
21 This is a work-in-progress collection of basic tagless-final combinators,
22 along with some advanced utilities to exploit them.
23 * @Symantic.Syntaxes.Classes@
24 gathers commonly used tagless-final combinators
25 (the syntax part of symantics).
26 * @Symantic.Syntaxes.Data@ interprets combinators as data constructors
27 enabling to pattern-match on combinators while keeping their extensibility.
28 * @Symantic.Syntaxes.Derive@
29 to give a default value to combinators which avoids boilerplate code
30 when implementing combinators for an interpreter is factorizable.
31 * @Symantic.Syntaxes.EithersOfTuples@
32 leverages @GHC.Generics@ to generate reciprocal functions
33 between algebraic data type constructors and Eithers-of-Tuples.
34 * @Symantic.Syntaxes.TuplesOfFunctions@
35 enables the use of Tuples-of-Functions
36 instead of Eithers-of-Tuples.
37 * @Symantic.Syntaxes.CurryN@
38 gathers utilities for currying or uncurrying tuples
39 of size greater or equal to two.
40 * @Symantic.Semantics.SharingObserver@
41 interprets combinators to observe @let@ definitions
42 at the host language level (Haskell),
43 effectively turning infinite values into finite ones,
44 which is useful for example to inspect
45 and optimize recursive grammars.
46 Inspired by Andy Gill's [Type-safe observable sharing in Haskell](https://doi.org/10.1145/1596638.1596653).
47 For an example, see [symantic-parser](https://hackage.haskell.org/package/symantic-parser).
48 * @Symantic.Semantics.Viewer@
49 interprets combinators as human-readable text.
50 * @Symantic.Semantics.Viewer.Fixity@
51 gathers utilities for parsing or viewing
52 infix, prefix and postfix combinators.
53 * @Symantic.Syntaxes.Reader@
54 is an intermediate interpreter enabling to change
55 the syntax combinators using an environment.
56 * @Symantic.Utils.Reify@
57 enables the lifting to any interpreter
58 of any Haskell functions taking as arguments
59 only polymorphic types (possibly constrained)
60 or functions using such types.
61 Inspired by Oleg Kiselyov's [TDPE.hs](http://okmij.org/ftp/tagless-final/course/TDPE.hs).
62
63 build-type: Simple
64 tested-with: GHC ==8.10.4
65 extra-doc-files: ChangeLog.md
66 extra-source-files:
67 .envrc
68 cabal.project
69 flake.lock
70 flake.nix
71 Makefile
72
73 extra-tmp-files:
74
75 source-repository head
76 type: git
77 location: git://git.sourcephile.fr/haskell/symantic-base
78
79 library
80 hs-source-dirs: src
81 exposed-modules:
82 Symantic
83 Symantic.Semantics
84 Symantic.Semantics.Reader
85 Symantic.Semantics.SharingObserver
86 Symantic.Semantics.Viewer
87 Symantic.Semantics.Viewer.Fixity
88 Symantic.Syntaxes
89 Symantic.Syntaxes.Classes
90 Symantic.Syntaxes.CurryN
91 Symantic.Syntaxes.Data
92 Symantic.Syntaxes.Derive
93 Symantic.Syntaxes.EithersOfTuples
94 Symantic.Syntaxes.Reify
95 Symantic.Syntaxes.TuplesOfFunctions
96
97 default-language: Haskell2010
98 default-extensions:
99 NoImplicitPrelude
100 DefaultSignatures
101 FlexibleContexts
102 FlexibleInstances
103 GeneralizedNewtypeDeriving
104 ImportQualifiedPost
105 LambdaCase
106 MultiParamTypeClasses
107 NamedFieldPuns
108 RecordWildCards
109 ScopedTypeVariables
110 TupleSections
111 TypeApplications
112 TypeFamilies
113 TypeOperators
114
115 ghc-options:
116 -Wall -Wincomplete-uni-patterns -Wincomplete-record-updates
117 -Wpartial-fields -fprint-potential-instances
118
119 build-depends:
120 , base >=4.10 && <5
121 , containers
122 , hashable
123 , template-haskell
124 , transformers
125 , unordered-containers