blob: 44640e656f3df493c636a9424770d10a292d8dac (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
(.module:
[library
[lux {"-" [and not local]}
["$" documentation {"+" [documentation:]}]
[data
[text {"+" [\n]}
["%" format {"+" [format]}]]]
[macro
["." template]]]]
[\\library
["." /]])
(documentation: /.Offset
"An offset into a block of text.")
(documentation: (/.Parser it)
"A parser for text.")
(documentation: /.Slice
"A slice of a block of text.")
(documentation: /.result
(format "Executes a parser against a block of text."
\n "Verifies that the entire input has been processed.")
[(result parser input)])
(documentation: /.offset
"Yields the current offset into the input.")
(documentation: /.any
"Yields the next character without applying any logic.")
(documentation: /.any!
"Yields the next character (as a slice) without applying any logic.")
(template [<name> <caveat>]
[(`` (documentation: <name>
(format "Produce a character" (~~ (template.text [<caveat>])) " if the parser fails.")
[(<name> parser)]))]
[/.not ""]
[/.not! " (as a slice)"]
)
(documentation: /.this
"Checks that a specific text shows up in the input."
[(this reference)])
(documentation: /.end!
"Ensure the parser's input is empty.")
(documentation: /.next
"Yields the next character (without consuming it from the input).")
(documentation: /.remaining
"Get all of the remaining input (without consuming it).")
(documentation: /.range
"Only yields characters within a range."
[(range bottom top)])
(template [<name> <desc>]
[(documentation: <name>
(format "Only yields " <desc> " characters."))]
[/.upper "uppercase"]
[/.lower "lowercase"]
[/.decimal "decimal"]
[/.octal "octal"]
)
(documentation: /.alpha
"Yields alphabetic characters.")
(documentation: /.alpha_num
"Yields alphanumeric characters.")
(documentation: /.hexadecimal
"Yields hexadecimal digits.")
(template [<name> <description_modifier>]
[(documentation: <name>
(format "Yields characters that are" <description_modifier> " part of a piece of text.")
[(<name> options)])]
[/.one_of ""]
[/.none_of " not"]
)
(template [<name> <description_modifier>]
[(documentation: <name>
(format "Yields characters (as a slice) that are" <description_modifier> " part of a piece of text.")
[(<name> options)])]
[/.one_of! ""]
[/.none_of! " not"]
)
(documentation: /.satisfies
"Yields characters that satisfy a predicate."
[(satisfies parser)])
(documentation: /.space
"Yields white-space.")
(documentation: /.and
"Yields the outputs of both parsers composed together."
[(and left right)])
(documentation: /.and!
"Yields the outputs of both parsers composed together (as a slice)."
[(and! left right)])
(template [<text> <slice>]
[(`` (documentation: <text>
(format "Yields " (~~ (template.text [<name>])) " characters as a single continuous text.")
[(<text> parser)]))
(`` (documentation: <slice>
(format "Yields " (~~ (template.text [<name>])) " characters as a single continuous text (as a slice).")
[(<slice> parser)]))]
[/.some /.some!]
[/.many /.many!]
)
(template [<text> <slice> <doc_modifier>]
[(`` (documentation: <text>
(format "Yields " <doc_modifier> " N characters.")
[(<text> amount parser)]))
(`` (documentation: <slice>
(format "Yields " <doc_modifier> " N characters (as a slice).")
[(<slice> amount parser)]))]
[/.exactly /.exactly! "exactly"]
[/.at_most /.at_most! "at most"]
[/.at_least /.at_least! "at least"]
)
(documentation: /.between
""
[(between minimum additional parser)])
(documentation: /.between!
""
[(between! minimum additional parser)])
(documentation: /.enclosed
""
[(enclosed [start end] parser)])
(documentation: /.local
"Applies a parser against the given input."
[(local local_input parser)])
(documentation: /.slice
"Converts a slice to a block of text."
[(slice parser)])
(documentation: /.then
"Embeds a text parser into an arbitrary parser that yields text."
[(then structured text)])
(.def: .public documentation
(.List $.Module)
($.module /._
""
[..Offset
..Parser
..Slice
..result
..offset
..any ..any!
..not ..not!
..this
..end!
..next
..remaining
..range
..upper
..lower
..decimal
..octal
..alpha
..alpha_num
..hexadecimal
..one_of ..one_of!
..none_of ..none_of!
..satisfies
..space
..and ..and!
..some ..some!
..many ..many!
..exactly ..exactly!
..at_most ..at_most!
..at_least ..at_least!
..between
..between!
..enclosed
..local
..slice
..then
($.default /.unconsumed_input)
($.default /.expected_to_fail)
($.default /.cannot_parse)
($.default /.cannot_slice)
($.default /.cannot_match)
($.default /.character_should_be)
($.default /.character_should_not_be)
($.default /.character_does_not_satisfy_predicate)]
[]))
|
