-
Notifications
You must be signed in to change notification settings - Fork 15
/
debug.scala
231 lines (221 loc) · 9.4 KB
/
debug.scala
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
222
223
224
225
226
227
228
229
230
231
/* SPDX-FileCopyrightText: © 2021 Parsley Contributors <https://github.com/j-mie6/Parsley/graphs/contributors>
* SPDX-License-Identifier: BSD-3-Clause
*/
package parsley
import parsley.errors.ErrorBuilder
import parsley.internal.deepembedding.frontend
/** This module contains the very useful debugging combinator, as well as breakpoints.
*
* @groupprio comb 0
* @groupname comb Debug Combinator Extension Methods
* @groupdesc comb
* These are the debugging combinators, which are enabled by bringing these implicit classes
* into scope.
*
* @groupprio break 10
* @groupname break Breakpoints
* @groupdesc break
* These can be used to control how the `debug` combinator operates: when a breakpoint is used
* it can halt the execution of the combinator and print out information about the parsers state.
*
* @groupprio ctrl 5
* @groupname ctrl Debug Control
* @groupdesc ctrl
* These methods can control how the debug mechanism functions in a general way.
*/
// $COVERAGE-OFF$
object debug {
/** Base trait for breakpoints.
*
* @group break
*/
sealed trait Breakpoint
/** Indicates that no breaking should occur.
*
* @group break
*/
case object NoBreak extends Breakpoint
/** Break on entry to the combinator, require user input to advance.
*
* @group break
*/
case object EntryBreak extends Breakpoint
/** Break on exit to the combinator, require user input to advance.
*
* @group break
*/
case object ExitBreak extends Breakpoint
/** Break on both entry and exit to the combinator, require user input to advance in both cases.
*
* @group break
*/
case object FullBreak extends Breakpoint
private [parsley] var renderAscii = false
/** This method can be used to disable the coloured debug output for terminals that don't support it.
*
* @group ctrl
*/
def disableColourRendering(): Unit = renderAscii = true
/** This class enables the `debug` combinator on parsers.
*
* This extension class operates on values that are convertible to parsers. It enables the use of
* the `debug` combinator, which can be used to trace the execution through a parser.
*
* @constructor This constructor should not be called manually, it is designed to be used via Scala's implicit resolution.
* @param p the value that this class is enabling methods on.
* @param con a conversion that allows values convertible to parsers to be used.
* @tparam P the type of base value that this class is used on (the conversion to `Parsley`) is summoned automatically.
* @group comb
*
* @define debug This combinator allows this parser to be debugged by providing a trace through the execution.
*
* When this combinator is entered, it will print the name assigned to the parser,
* as well as the current currenting input context for a few characters on either side.
* This parser is then executed. If it succeeded, this combinator again reports the
* name along with "`Good`" and the input context. If it failed, it reports the name
* along with "`Bad`" and the input context.
*
* When breakpoints are used, the execution of the combinator will pause on either entry,
* exit, or both. The parse is resumed by entering a newline on standard input. Breakpoints
* will cause additional information about the internal state of the parser to be reported.
*/
implicit class DebugCombinators[P, A](p: P)(implicit con: P => Parsley[A]) {
/** $debug
*
* @example {{{
* scala> import parsley.debug.DebugCombinators, parsley.character.string, parsley.Parsley.attempt
* scala> val abc = attempt(string("abc").debug("string abc")).debug("attempt")
* scala> val abd = string("abd").debug("string abd")
* scala> val p = (abc <|> abd).debug("or")
* scala> p.parse("abd")
* >or> (1, 1): abd•
* ^
* >attempt> (1, 1): abd•
* ^
* >string abc> (1, 1): abd•
* ^
* <string abc< (1, 3): abd• Fail
* ^
* <attempt< (1, 1): abd• Fail
* ^
* >string abd> (1, 1): abd•
* ^
* <string abd< (1, 4): abd• Good
* ^
* <or< (1, 4): abd• Good
* ^
* val res0 = Success("abd")
* }}}
*
* @param name The name to be assigned to this parser
* @param break The breakpoint properties of this parser, defaults to NoBreak
* @param coloured Whether to render with colour (default true: render colours)
*/
def debug(name: String, break: Breakpoint, coloured: Boolean): Parsley[A] = {
new Parsley(new frontend.Debug[A](con(p).internal, name, !coloured, break))
}
/** $debug
*
* @example {{{
* scala> import parsley.debug.DebugCombinators, parsley.character.string, parsley.Parsley.attempt
* scala> val abc = attempt(string("abc").debug("string abc")).debug("attempt")
* scala> val abd = string("abd").debug("string abd")
* scala> val p = (abc <|> abd).debug("or")
* scala> p.parse("abd")
* >or> (1, 1): abd•
* ^
* >attempt> (1, 1): abd•
* ^
* >string abc> (1, 1): abd•
* ^
* <string abc< (1, 3): abd• Fail
* ^
* <attempt< (1, 1): abd• Fail
* ^
* >string abd> (1, 1): abd•
* ^
* <string abd< (1, 4): abd• Good
* ^
* <or< (1, 4): abd• Good
* ^
* val res0 = Success("abd")
* }}}
*
* Renders in colour.
*
* @param name The name to be assigned to this parser
* @param break The breakpoint properties of this parser, defaults to NoBreak
*/
def debug(name: String, break: Breakpoint): Parsley[A] = debug(name, break, coloured = true)
/** $debug
*
* @example {{{
* scala> import parsley.debug.DebugCombinators, parsley.character.string, parsley.Parsley.attempt
* scala> val abc = attempt(string("abc").debug("string abc")).debug("attempt")
* scala> val abd = string("abd").debug("string abd")
* scala> val p = (abc <|> abd).debug("or")
* scala> p.parse("abd")
* >or> (1, 1): abd•
* ^
* >attempt> (1, 1): abd•
* ^
* >string abc> (1, 1): abd•
* ^
* <string abc< (1, 3): abd• Fail
* ^
* <attempt< (1, 1): abd• Fail
* ^
* >string abd> (1, 1): abd•
* ^
* <string abd< (1, 4): abd• Good
* ^
* <or< (1, 4): abd• Good
* ^
* val res0 = Success("abd")
* }}}
*
* No break-points.
*
* @param name The name to be assigned to this parser
* @param coloured Whether to render with colour
*/
def debug(name: String, coloured: Boolean): Parsley[A] = debug(name, break = NoBreak, coloured)
/** $debug
*
* @example {{{
* scala> import parsley.debug.DebugCombinators, parsley.character.string, parsley.Parsley.attempt
* scala> val abc = attempt(string("abc").debug("string abc")).debug("attempt")
* scala> val abd = string("abd").debug("string abd")
* scala> val p = (abc <|> abd).debug("or")
* scala> p.parse("abd")
* >or> (1, 1): abd•
* ^
* >attempt> (1, 1): abd•
* ^
* >string abc> (1, 1): abd•
* ^
* <string abc< (1, 3): abd• Fail
* ^
* <attempt< (1, 1): abd• Fail
* ^
* >string abd> (1, 1): abd•
* ^
* <string abd< (1, 4): abd• Good
* ^
* <or< (1, 4): abd• Good
* ^
* val res0 = Success("abd")
* }}}
*
* Renders in colour with no break-point.
*
* @param name The name to be assigned to this parser
*/
def debug(name: String): Parsley[A] = debug(name, break = NoBreak, coloured = true)
def debugError(name: String, coloured: Boolean)(implicit errBuilder: ErrorBuilder[_]): Parsley[A] = {
new Parsley(new frontend.DebugError[A](con(p).internal, name, !coloured, errBuilder))
}
def debugError(name: String)(implicit errBuilder: ErrorBuilder[_]): Parsley[A] = debugError(name, coloured = true)
}
}
// $COVERAGE-ON$