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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
|
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>JJTree Task</title>
</head>
<body>
<h2 id="jjtree">JJTree</h2>
<h3>Description</h3>
<p>Invokes the <a href="https://javacc.org/" target="_top">JJTree</a> preprocessor for the JavaCC
compiler compiler. It inserts parse tree building actions at various places in the JavaCC source
that it generates. The output of JJTree is run through JavaCC to create the parser.</p>
<p>To use the <code>jjtree</code> task, set the <var>target</var> attribute to the name of the
JJTree grammar file to process. You also need to specify the directory containing the JavaCC
installation using the <var>javacchome</var> attribute, so that Ant can find the JavaCC
classes. Optionally, you can also set the <var>outputdirectory</var> to write the generated JavaCC
grammar and node files to a specific directory. Otherwise <code>jjtree</code> writes the generated
JavaCC grammar and node files to the directory containing the JJTree grammar file. As an extra
option, you can also set the <var>outputfile</var> to write the generated JavaCC grammar file to a
specific (directory and) file. Otherwise <code>jjtree</code> writes the generated JavaCC grammar
file as the JJTree grammar file with a suffix <samp>.jj</samp>.</p>
<p>This task only invokes JJTree if the grammar file is newer than the generated JavaCC file.</p>
<h3>Parameters</h3>
<table class="attr">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td>target</td>
<td>The JJTree grammar file to process.</td>
<td>Yes</td>
</tr>
<tr>
<td>javacchome</td>
<td>The directory containing the JavaCC distribution.</td>
<td>Yes</td>
</tr>
<tr>
<td>outputdirectory</td>
<td>The directory to write the generated JavaCC grammar and node files to. If not set, the files
are written to the directory containing the grammar file.</td>
<td>No</td>
</tr>
<tr>
<td>outputfile</td>
<td>The file to write the generated JavaCC grammar file to. If not set, the file is written with
the same name as the JJTree grammar file but with a the suffix <code>.jj</code>. This is a
filename relative to <var>outputdirectory</var> if specified, the project's basedir.</td>
<td>No</td>
</tr>
<tr>
<td>buildnodefiles</td>
<td>Sets the BUILD_NODE_FILES grammar option. This is a boolean option.</td>
<td>No</td>
</tr>
<tr>
<td>multi</td>
<td>Sets the MULTI grammar option. This is a boolean option.</td>
<td>No</td>
</tr>
<tr>
<td>nodedefaultvoid</td>
<td>Sets the NODE_DEFAULT_VOID grammar option. This is a boolean option.</td>
<td>No</td>
</tr>
<tr>
<td>nodefactory</td>
<td>Sets the NODE_FACTORY grammar option. This is boolean option.</td>
<td>No</td>
</tr>
<tr>
<td>nodescopehook</td>
<td>Sets the NODE_SCOPE_HOOK grammar option. This is a boolean option.</td>
<td>No</td>
</tr>
<tr>
<td>nodeusesparser</td>
<td>Sets the NODE_USES_PARSER grammar option. This is a boolean option.</td>
<td>No</td>
</tr>
<tr>
<td>static</td>
<td>Sets the STATIC grammar option. This is a boolean option.</td>
<td>No</td>
</tr>
<tr>
<td>visitor</td>
<td>Sets the VISITOR grammar option. This is a boolean option.</td>
<td>No</td>
</tr>
<tr>
<td>nodepackage</td>
<td>Sets the NODE_PACKAGE grammar option. This is a string option.</td>
<td>No</td>
</tr>
<tr>
<td>visitorexception</td>
<td>Sets the VISITOR_EXCEPTION grammar option. This is a string option.</td>
<td>No</td>
</tr>
<tr>
<td>nodeprefix</td>
<td>Sets the NODE_PREFIX grammar option. This is a string option.</td>
<td>No</td>
</tr>
<tr>
<td>maxmemory</td>
<td>Max amount of memory to allocate to the forked JVM. <em>since Ant 1.8.3</em></td>
<td>No</td>
</tr>
</table>
<h3>Example</h3>
<pre>
<jjtree target="src/Parser.jjt"
outputdirectory="build/src"
javacchome="c:/program files/JavaCC"
nodeusesparser="true"/></pre>
<p>This invokes JJTree on grammar file <samp>src/Parser.jjt</samp>, writing the generated grammar
file, <samp>Parser.jj</samp>, file to <samp>build/src</samp>. The grammar option NODE_USES_PARSER is
set to <q>true</q> when invoking JJTree.</p>
<h3>Comparison of output locations between command line JJTree and different Ant <code>taskdef</code>
versions</h3>
<table>
<thead class="no-bold">
<tr>
<th><strong>Command line JJTree options</strong> and <em>generated files</em> (working directory: <samp>/tmp</samp>)</th>
<th><strong>Ant 1.5.3</strong> versus command line</th>
<th><strong>Ant 1.6</strong> versus command line</th>
</tr>
</thead>
<tbody>
<tr>
<td><pre><b>jjtree grammar.jjt</b>
/tmp/grammar.jj
/tmp/<generated>.java</pre>
</td>
<td>Same</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree relative/grammar.jjt</b>
/tmp/grammar.jj
/tmp/<generated>.java</pre>
</td>
<td><pre>
/tmp/relative/grammar.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree /tmp/absolute/grammar.jjt</b>
/tmp/grammar.jj
/tmp/<generated>.java</pre>
</td>
<td><pre>
/tmp/absolute/grammar.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_DIRECTORY:relative grammar.jjt</b>
/tmp/relative/grammar.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Same</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
/tmp/relative/grammar.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Same</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
/tmp/relative/grammar.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Same</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
/tmp/absolute/grammar.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Same</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
/tmp/absolute/grammar.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Same</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
/tmp/absolute/grammar.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Same</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj grammar.jjt</b>
/tmp/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj relative/grammar.jjt</b>
/tmp/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj /tmp/absolute/grammar.jjt</b>
/tmp/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
/tmp/relative/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
/tmp/relative/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
/tmp/relative/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
/tmp/absolute/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
/tmp/absolute/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
/tmp/absolute/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj relative/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj /tmp/absolute/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
/tmp/relative/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
/tmp/relative/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
/tmp/relative/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
/tmp/absolute/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
/tmp/absolute/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
/tmp/absolute/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj relative/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj /tmp/absolute/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr id="footnote-1-back">
<td><pre><b>jjtree -OUTPUT_FILE:<i>D:</i>/tmp/subdir/output.jj grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Not Supported<a href="#footnote-1"><sup>*</sup></a></td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:<i>D:</i>/tmp/subdir/output.jj relative/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Not Supported<a href="#footnote-1"><sup>*</sup></a></td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:<i>D:</i>/tmp/subdir/output.jj /tmp/absolute/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Not Supported<a href="#footnote-1"><sup>*</sup></a></td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
/tmp/relative/tmp/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
/tmp/relative/tmp/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
/tmp/relative/tmp/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
/tmp/absolute/tmp/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
/tmp/absolute/tmp/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
<tr>
<td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
/tmp/absolute/tmp/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
</tbody>
</table>
<p id="footnote-1"><a href="#footnote-1-back"><strong>Note</strong></a>: When running JJTree with
the Ant <code>taskdef jjtree</code> the option <code>-OUTPUT_DIRECTORY</code> must always be set,
because the project's <var>basedir</var> and the Ant working directory might differ. So even if you
don't specify the <var>outputdirectory</var> for <code>taskdef jjtree</code>, JJTree will be called
with the <code>-OUTPUT_DIRECTORY</code> set to the project's <var>basedir</var>. But when
the <code>-OUTPUT_DIRECTORY</code> is set, the <code>-OUTPUT_FILE</code> setting is handled as if
relative to this <code>-OUTPUT_DIRECTORY</code>. Thus when the <code>-OUTPUT_FILE</code> is absolute
or contains a drive letter we have a problem. Therefore absolute <var>outputfile</var>s (when
the <var>outputdirectory</var> isn't specified) are made relative to the default directory. And for
this reason <var>outputfile</var>s that contain a drive letter can't be supported.</p>
<p>By the way: specifying a drive letter in the <code>-OUTPUT_FILE</code> when
the <code>-OUTPUT_DIRECTORY</code> is set, also results in strange behavior when running JJTree from
the command line.</p>
</body>
</html>
|
