Skip to content

Commit 5d609eb

Browse files
paulyoungpaulyoung
committed
Initial commit
0 parents  commit 5d609eb

File tree

9 files changed

+472
-0
lines changed

9 files changed

+472
-0
lines changed

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/bower_components/
2+
/node_modules/
3+
/.pulp-cache/
4+
/output/
5+
/generated-docs/
6+
/.psc-package/
7+
/.psc*
8+
/.purs*
9+
/.psa*

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2018 Paul Young
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# purescript-invertible-syntax
2+
3+
A PureScript implementation of invertible syntax descriptions, from the paper [Invertible Syntax Descriptions: Unifying Parsing and Pretty Printing (Rendel and Ostermann 2010)](http://www.informatik.uni-marburg.de/~rendel/unparse/rendel10invertible.pdf).
4+
5+
## Licensing
6+
7+
This project is licensed under the terms of the Apache-2.0 license.
8+
9+
However, some additional functionality not included in the paper has been included here, with inspiration taken from the Haskell package [`invertible-syntax`](http://hackage.haskell.org/package/invertible-syntax). The following copyright notice appears in conformance with its BSD-3-Clause license.
10+
11+
```
12+
Copyright (c) 2010-11 University of Marburg
13+
14+
All rights reserved.
15+
```

‎bower.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "purescript-invertible-syntax",
3+
"license": "Apache-2.0",
4+
"repository": {
5+
"type": "git",
6+
"url": "git://github.com/paulyoung/purescript-invertible-syntax.git"
7+
},
8+
"ignore": [
9+
"**/.*",
10+
"node_modules",
11+
"bower_components",
12+
"output"
13+
],
14+
"dependencies": {
15+
"purescript-either": "^3.2.0",
16+
"purescript-lists": "^4.12.0",
17+
"purescript-maybe": "^3.1.0",
18+
"purescript-partial-isomorphisms": "^1.0.0",
19+
"purescript-prelude": "^3.3.0",
20+
"purescript-strings": "^3.5.0",
21+
"purescript-tuples": "^4.1.0"
22+
},
23+
"devDependencies": {
24+
"purescript-psci-support": "^3.0.0"
25+
}
26+
}

‎src/Text/Syntax/Classes.purs‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
module Text.Syntax.Classes where
2+
3+
import Prelude hiding (($), (<*>), apply, map)
4+
5+
import Control.Isomorphism.Partial (class IsoFunctor)
6+
import Data.Tuple (Tuple)
7+
8+
9+
class ProductFunctor f where
10+
apply :: forall a b. f a -> f b -> f (Tuple a b)
11+
12+
infixr 6 apply as <*>
13+
14+
15+
class Alternative f where
16+
alt :: forall a. f a -> f a -> f a
17+
empty :: forall a. f a
18+
19+
infixl 3 alt as <|>
20+
21+
22+
class (IsoFunctor d, ProductFunctor d, Alternative d) <= Syntax d where
23+
pure :: forall a. Eq a => a -> d a
24+
token :: d Char

‎src/Text/Syntax/Combinators.purs‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
-- | Derived combinators
2+
module Text.Syntax.Combinators where
3+
4+
import Prelude hiding ((<$>),(<*>),(<*),(*>),pure,unit)
5+
6+
import Control.Isomorphism.Partial (Iso, inverse, (<$>))
7+
import Control.Isomorphism.Partial.Constructors (cons, left, nil, right)
8+
import Control.Isomorphism.Partial.Derived (foldl)
9+
import Control.Isomorphism.Partial.Prim (commute, element, ignore, unit)
10+
import Data.Either (Either)
11+
import Data.List (List(..), singleton)
12+
import Data.Maybe (Maybe(..))
13+
import Data.String (uncons)
14+
import Data.Tuple (Tuple(..))
15+
import Data.Unit as Unit
16+
import Text.Syntax.Classes (class Syntax, pure, token, (<*>), (<|>))
17+
18+
-- Lexemes
19+
20+
-- | `text` parses/prints a fixed text and consumes/produces a unit value.
21+
text :: forall d. Syntax d => String -> d Unit
22+
text s
23+
| Just { head: c, tail: s' } <- uncons s =
24+
inverse (element (Tuple Unit.unit Unit.unit))
25+
<$> (inverse (element c) <$> token)
26+
<*> text s'
27+
| otherwise = pure Unit.unit
28+
29+
comma :: forall d. Syntax d => d Unit
30+
comma = text ","
31+
32+
dot :: forall d. Syntax d => d Unit
33+
dot = text "."
34+
35+
-- Repetition
36+
37+
many :: forall d a. Syntax d => d a -> d (List a)
38+
many p = nil <$> pure Unit.unit <|> cons <$> p <*> many p
39+
40+
many1 :: forall d a. Syntax d => d a -> d (List a)
41+
many1 p = cons <$> p <*> many p
42+
43+
sepBy :: forall d a. Syntax d => d a -> d Unit -> d (List a)
44+
sepBy x sep = nil <$> text "" <|> cons <$> x <*> many (sep *> x)
45+
46+
-- | The `chainl1` combinator is used to parse a left-associative chain of
47+
-- | infix operators.
48+
chainl1
49+
:: forall d a b
50+
. Syntax d
51+
=> d a
52+
-> d b
53+
-> Iso (Tuple a (Tuple b a)) a
54+
-> d a
55+
chainl1 arg op f = foldl f <$> arg <*> many (op <*> arg)
56+
57+
-- Sequencing
58+
59+
-- | This variant of `<*>` ignores its left result. In contrast to its
60+
-- | counterpart derived from the `Apply` class, the ignored parts have type
61+
-- | `d Unit` rather than `d b` because otherwise information relevant for
62+
-- | pretty-printing would be lost.
63+
applySecond :: forall d a. Syntax d => d Unit -> d a -> d a
64+
applySecond p q = inverse unit <<< commute <$> p <*> q
65+
66+
infixl 9 applySecond as *>
67+
68+
-- | This variant of `<*>` ignores its right result. In contrast to its
69+
-- | counterpart derived from the `Apply` class, the ignored parts have type
70+
-- | `d Unit` rather than `d b` because otherwise information relevant for
71+
-- | pretty-printing would be lost.
72+
applyFirst :: forall d a. Syntax d => d a -> d Unit -> d a
73+
applyFirst p q = inverse unit <$> p <*> q
74+
75+
infixl 9 applyFirst as <*
76+
77+
-- | The `between` function combines `*>` and `<*` in the obvious way.
78+
between :: forall d a. Syntax d => d Unit -> d Unit -> d a -> d a
79+
between p q r = p *> r <* q
80+
81+
-- Alternation
82+
83+
alt :: forall d a b. Syntax d => d a -> d b -> d (Either a b)
84+
alt p q = (left <$> p) <|> (right <$> q)
85+
86+
infixl 4 alt as <+>
87+
88+
-- optional ::
89+
-- optional
90+
91+
-- Whitespace
92+
93+
-- | Expressing whitespace
94+
-- |
95+
-- | Parsers and pretty printers treat whitespace differently. Parsers specify
96+
-- | where whitespace is allowed or required to occur, while pretty printers
97+
-- | specify how much whitespace is to be inserted at these locations. To
98+
-- | account for these different roles of whitespace, the following three syntax
99+
-- | descriptions provide fine-grained control over where whitespace is allowed,
100+
-- | desired or required to occur.
101+
102+
-- | `skipSpace` marks a position where whitespace is allowed to occur. It
103+
-- | accepts arbitrary space while parsing, and produces no space while
104+
-- | printing.
105+
skipSpace :: forall d. Syntax d => d Unit
106+
skipSpace = ignore Nil <$> many (text " ")
107+
108+
-- | `optSpace` marks a position where whitespace is desired to occur. It
109+
-- | accepts arbitrary space while parsing, and produces a single space
110+
-- | character while printing.
111+
optSpace :: forall d. Syntax d => d Unit
112+
optSpace = ignore (singleton Unit.unit) <$> many (text " ")
113+
114+
-- | `sepSpace` marks a position where whitespace is required to occur. It
115+
-- | requires one or more space characters while parsing, and produces a single
116+
-- | space character while printing.
117+
sepSpace :: forall d. Syntax d => d Unit
118+
sepSpace = text " " <* skipSpace

0 commit comments

Comments
 (0)