]> git.saurik.com Git - bison.git/blame - NEWS
Prepare for the possibility of a 2.5.1 release.
[bison.git] / NEWS
CommitLineData
6780ca7a
DM
1Bison News
2----------
3af4feb2 3
74553c98
AD
4* Changes in version ?.? (????-??-??):
5
2055a44e
AD
6** Additional yylex/yyparse arguments
7
8 The new directive %param declare additional argument to both yylex
bb9191dd 9 and yyparse. The %lex-param, %parse-param, and %param directives
2055a44e
AD
10 support one or more arguments. Instead of
11
12 %lex-param {arg1_type *arg1}
13 %lex-param {arg2_type *arg2}
14 %parse-param {arg1_type *arg1}
15 %parse-param {arg2_type *arg2}
16
17 one may now declare
18
19 %param {arg1_type *arg1} {arg2_type *arg2}
20
21** Java skeleton improvements
0ea583d2
AD
22
23 The constants for token names were moved to the Lexer interface.
24 Also, it is possible to add code to the parser's constructors using
25 "%code init" and "%define init_throws".
26
4c6622c2 27** Variable api.tokens.prefix
99c08fb6 28
4c6622c2 29 The variable api.tokens.prefix changes the way tokens are identified in
99c08fb6
AD
30 the generated files. This is especially useful to avoid collisions
31 with identifiers in the target language. For instance
32
33 %token FILE for ERROR
4c6622c2 34 %define api.tokens.prefix "TOK_"
99c08fb6
AD
35 %%
36 start: FILE for ERROR;
37
38 will generate the definition of the symbols TOK_FILE, TOK_for, and
39 TOK_ERROR in the generated sources. In particular, the scanner must
40 use these prefixed token names, although the grammar itself still
41 uses the short names (as in the sample rule given above).
42
67501061
AD
43** Variable api.namespace
44
45 The "namespace" variable is renamed "api.namespace". Backward
46 compatibility is ensured, but upgrading is recommended.
47
31b850d2
AD
48** Variable parse.error
49
50 The variable error controls the verbosity of error messages. The
51 use of the %error-verbose directive is deprecated in favor of
52 %define parse.error "verbose".
53
ca2a6d15
PH
54** Semantic predicates
55
56 The new, experimental, semantic-predicate feature allows actions of
57 the form %?{ BOOLEAN-EXPRESSION }, which cause syntax errors (as for
58 YYERROR) if the expression evaluates to 0, and are evaluated immediately
59 in GLR parsers, rather than being deferred. The result is that they
60 allow the programmer to prune possible parses based on the values of
61 runtime expressions.
62
df6e3db0
JD
63* Changes in version 2.5.1 (????-??-??):
64
28801043 65* Changes in version 2.5 (2011-05-14):
50cca368 66
82f3355e
JD
67** Grammar symbol names can now contain non-initial dashes:
68
69 Consistently with directives (such as %error-verbose) and with
70 %define variables (e.g. push-pull), grammar symbol names may contain
71 dashes in any position except the beginning. This is a GNU
72 extension over POSIX Yacc. Thus, use of this extension is reported
73 by -Wyacc and rejected in Yacc mode (--yacc).
74
f1b238df 75** Named references:
66381412
AR
76
77 Historically, Yacc and Bison have supported positional references
78 ($n, $$) to allow access to symbol values from inside of semantic
79 actions code.
80
81 Starting from this version, Bison can also accept named references.
82 When no ambiguity is possible, original symbol names may be used
83 as named references:
84
4b568fc0 85 if_stmt : "if" cond_expr "then" then_stmt ';'
66381412
AR
86 { $if_stmt = mk_if_stmt($cond_expr, $then_stmt); }
87
88 In the more common case, explicit names may be declared:
89
4b568fc0 90 stmt[res] : "if" expr[cond] "then" stmt[then] "else" stmt[else] ';'
66381412
AR
91 { $res = mk_if_stmt($cond, $then, $else); }
92
5b1ff423 93 Location information is also accessible using @name syntax. When
66381412
AR
94 accessing symbol names containing dots or dashes, explicit bracketing
95 ($[sym.1]) must be used.
96
5b1ff423 97 These features are experimental in this version. More user feedback
66381412
AR
98 will help to stabilize them.
99
f1b238df 100** IELR(1) and canonical LR(1):
eb45ef3b
JD
101
102 IELR(1) is a minimal LR(1) parser table generation algorithm. That
103 is, given any context-free grammar, IELR(1) generates parser tables
7262f54f 104 with the full language-recognition power of canonical LR(1) but with
f1b238df
JD
105 nearly the same number of parser states as LALR(1). This reduction
106 in parser states is often an order of magnitude. More importantly,
eb45ef3b
JD
107 because canonical LR(1)'s extra parser states may contain duplicate
108 conflicts in the case of non-LR(1) grammars, the number of conflicts
109 for IELR(1) is often an order of magnitude less as well. This can
110 significantly reduce the complexity of developing of a grammar.
111
112 Bison can now generate IELR(1) and canonical LR(1) parser tables in
113 place of its traditional LALR(1) parser tables, which remain the
114 default. You can specify the type of parser tables in the grammar
115 file with these directives:
116
cf499cff
JD
117 %define lr.type lalr
118 %define lr.type ielr
119 %define lr.type canonical-lr
eb45ef3b 120
7fceb615
JD
121 The default-reduction optimization in the parser tables can also be
122 adjusted using `%define lr.default-reductions'. For details on both
123 of these features, see the new section `Tuning LR' in the Bison
124 manual.
eb45ef3b
JD
125
126 These features are experimental. More user feedback will help to
127 stabilize them.
128
7fceb615 129** LAC (Lookahead Correction) for syntax error handling:
fcf834f9
JD
130
131 Canonical LR, IELR, and LALR can suffer from a couple of problems
132 upon encountering a syntax error. First, the parser might perform
133 additional parser stack reductions before discovering the syntax
7fceb615 134 error. Such reductions can perform user semantic actions that are
fcf834f9
JD
135 unexpected because they are based on an invalid token, and they
136 cause error recovery to begin in a different syntactic context than
137 the one in which the invalid token was encountered. Second, when
7fceb615
JD
138 verbose error messages are enabled (with %error-verbose or the
139 obsolete `#define YYERROR_VERBOSE'), the expected token list in the
140 syntax error message can both contain invalid tokens and omit valid
141 tokens.
fcf834f9
JD
142
143 The culprits for the above problems are %nonassoc, default
144 reductions in inconsistent states, and parser state merging. Thus,
145 IELR and LALR suffer the most. Canonical LR can suffer only if
146 %nonassoc is used or if default reductions are enabled for
147 inconsistent states.
148
7fceb615
JD
149 LAC is a new mechanism within the parsing algorithm that solves
150 these problems for canonical LR, IELR, and LALR without sacrificing
151 %nonassoc, default reductions, or state merging. When LAC is in
152 use, canonical LR and IELR behave almost exactly the same for both
153 syntactically acceptable and syntactically unacceptable input.
fcf834f9
JD
154 While LALR still does not support the full language-recognition
155 power of canonical LR and IELR, LAC at least enables LALR's syntax
156 error handling to correctly reflect LALR's language-recognition
157 power.
158
159 Currently, LAC is only supported for deterministic parsers in C.
160 You can enable LAC with the following directive:
161
162 %define parse.lac full
163
7fceb615
JD
164 See the new section `LAC' in the Bison manual for additional
165 details including a few caveats.
fcf834f9
JD
166
167 LAC is an experimental feature. More user feedback will help to
168 stabilize it.
169
d397d9f0 170** %define improvements:
cf499cff 171
f1b238df 172*** Can now be invoked via the command line:
50cca368 173
de5ab940 174 Each of these command-line options
50cca368 175
de5ab940
JD
176 -D NAME[=VALUE]
177 --define=NAME[=VALUE]
178
179 -F NAME[=VALUE]
180 --force-define=NAME[=VALUE]
50cca368
JD
181
182 is equivalent to this grammar file declaration
183
de5ab940 184 %define NAME ["VALUE"]
50cca368 185
de5ab940
JD
186 except that the manner in which Bison processes multiple definitions
187 for the same NAME differs. Most importantly, -F and --force-define
188 quietly override %define, but -D and --define do not. For further
4b568fc0 189 details, see the section `Bison Options' in the Bison manual.
50cca368 190
f1b238df 191*** Variables renamed:
67212941
JD
192
193 The following %define variables
194
195 api.push_pull
196 lr.keep_unreachable_states
197
198 have been renamed to
199
200 api.push-pull
201 lr.keep-unreachable-states
202
203 The old names are now deprecated but will be maintained indefinitely
204 for backward compatibility.
205
7262f54f 206*** Values no longer need to be quoted in the grammar file:
cf499cff
JD
207
208 If a %define value is an identifier, it no longer needs to be placed
209 within quotations marks. For example,
210
211 %define api.push-pull "push"
212
213 can be rewritten as
214
215 %define api.push-pull push
216
d397d9f0 217*** Unrecognized variables are now errors not warnings.
cdf3f113 218
d397d9f0
JD
219*** Multiple invocations for any variable is now an error not a warning.
220
221** Unrecognized %code qualifiers are now errors not warnings.
222
223** Character literals not of length one:
224
225 Previously, Bison quietly converted all character literals to length
226 one. For example, without warning, Bison interpreted the operators in
227 the following grammar to be the same token:
228
229 exp: exp '++'
230 | exp '+' exp
231 ;
232
233 Bison now warns when a character literal is not of length one. In
234 some future release, Bison will start reporting an error instead.
235
236** Destructor calls fixed for lookaheads altered in semantic actions:
237
238 Previously for deterministic parsers in C, if a user semantic action
239 altered yychar, the parser in some cases used the old yychar value to
240 determine which destructor to call for the lookahead upon a syntax
241 error or upon parser return. This bug has been fixed.
242
243** C++ parsers use YYRHSLOC:
244
245 Similarly to the C parsers, the C++ parsers now define the YYRHSLOC
246 macro and use it in the default YYLLOC_DEFAULT. You are encouraged
4b568fc0
JD
247 to use it. If, for instance, your location structure has `first'
248 and `last' members, instead of
d397d9f0
JD
249
250 # define YYLLOC_DEFAULT(Current, Rhs, N) \
251 do \
252 if (N) \
253 { \
254 (Current).first = (Rhs)[1].location.first; \
255 (Current).last = (Rhs)[N].location.last; \
256 } \
257 else \
258 { \
259 (Current).first = (Current).last = (Rhs)[0].location.last; \
260 } \
261 while (false)
262
263 use:
264
265 # define YYLLOC_DEFAULT(Current, Rhs, N) \
266 do \
267 if (N) \
268 { \
269 (Current).first = YYRHSLOC (Rhs, 1).first; \
270 (Current).last = YYRHSLOC (Rhs, N).last; \
271 } \
272 else \
273 { \
274 (Current).first = (Current).last = YYRHSLOC (Rhs, 0).last; \
275 } \
276 while (false)
277
278** YYLLOC_DEFAULT in C++:
279
280 The default implementation of YYLLOC_DEFAULT used to be issued in
281 the header file. It is now output in the implementation file, after
282 the user %code sections so that its #ifndef guard does not try to
283 override the user's YYLLOC_DEFAULT if provided.
cdf3f113 284
f1b238df 285** YYFAIL now produces warnings and Java parsers no longer implement it:
4395a9ff
JD
286
287 YYFAIL has existed for many years as an undocumented feature of
288 deterministic parsers in C generated by Bison. More recently, it was
289 a documented feature of Bison's experimental Java parsers. As
290 promised in Bison 2.4.2's NEWS entry, any appearance of YYFAIL in a
291 semantic action now produces a deprecation warning, and Java parsers
292 no longer implement YYFAIL at all. For further details, including a
293 discussion of how to suppress C preprocessor warnings about YYFAIL
294 being unused, see the Bison 2.4.2 NEWS entry.
295
f1b238df 296** Temporary hack for adding a semicolon to the user action:
197b82ba
JD
297
298 Previously, Bison appended a semicolon to every user action for
299 reductions when the output language defaulted to C (specifically, when
300 neither %yacc, %language, %skeleton, or equivalent command-line
301 options were specified). This allowed actions such as
302
303 exp: exp "+" exp { $$ = $1 + $3 };
304
305 instead of
306
307 exp: exp "+" exp { $$ = $1 + $3; };
308
309 As a first step in removing this misfeature, Bison now issues a
310 warning when it appends a semicolon. Moreover, in cases where Bison
311 cannot easily determine whether a semicolon is needed (for example, an
312 action ending with a cpp directive or a braced compound initializer),
313 it no longer appends one. Thus, the C compiler might now complain
314 about a missing semicolon where it did not before. Future releases of
315 Bison will cease to append semicolons entirely.
316
d2060f06
JD
317** Verbose syntax error message fixes:
318
7fceb615
JD
319 When %error-verbose or the obsolete `#define YYERROR_VERBOSE' is
320 specified, syntax error messages produced by the generated parser
321 include the unexpected token as well as a list of expected tokens.
322 The effect of %nonassoc on these verbose messages has been corrected
323 in two ways, but a more complete fix requires LAC, described above:
d2060f06
JD
324
325*** When %nonassoc is used, there can exist parser states that accept no
326 tokens, and so the parser does not always require a lookahead token
327 in order to detect a syntax error. Because no unexpected token or
328 expected tokens can then be reported, the verbose syntax error
329 message described above is suppressed, and the parser instead
4b568fc0 330 reports the simpler message, `syntax error'. Previously, this
d2060f06
JD
331 suppression was sometimes erroneously triggered by %nonassoc when a
332 lookahead was actually required. Now verbose messages are
333 suppressed only when all previous lookaheads have already been
334 shifted or discarded.
335
336*** Previously, the list of expected tokens erroneously included tokens
337 that would actually induce a syntax error because conflicts for them
338 were resolved with %nonassoc in the current parser state. Such
339 tokens are now properly omitted from the list.
340
341*** Expected token lists are still often wrong due to state merging
fcf834f9
JD
342 (from LALR or IELR) and default reductions, which can both add
343 invalid tokens and subtract valid tokens. Canonical LR almost
344 completely fixes this problem by eliminating state merging and
345 default reductions. However, there is one minor problem left even
346 when using canonical LR and even after the fixes above. That is,
347 if the resolution of a conflict with %nonassoc appears in a later
348 parser state than the one at which some syntax error is
349 discovered, the conflicted token is still erroneously included in
350 the expected token list. Bison's new LAC implementation,
351 described above, eliminates this problem and the need for
352 canonical LR. However, LAC is still experimental and is disabled
353 by default.
53f036ce 354
1a33f4f6
JD
355** Java skeleton fixes:
356
357*** A location handling bug has been fixed.
358
359*** The top element of each of the value stack and location stack is now
360 cleared when popped so that it can be garbage collected.
6771a463 361
02803d55
JD
362*** Parser traces now print the top element of the stack.
363
86408959
JD
364** -W/--warnings fixes:
365
4b568fc0 366*** Bison now properly recognizes the `no-' versions of categories:
86408959
JD
367
368 For example, given the following command line, Bison now enables all
369 warnings except warnings for incompatibilities with POSIX Yacc:
370
371 bison -Wall,no-yacc gram.y
372
786743d5
JD
373*** Bison now treats S/R and R/R conflicts like other warnings:
374
375 Previously, conflict reports were independent of Bison's normal
376 warning system. Now, Bison recognizes the warning categories
4b568fc0 377 `conflicts-sr' and `conflicts-rr'. This change has important
786743d5
JD
378 consequences for the -W and --warnings command-line options. For
379 example:
380
381 bison -Wno-conflicts-sr gram.y # S/R conflicts not reported
382 bison -Wno-conflicts-rr gram.y # R/R conflicts not reported
383 bison -Wnone gram.y # no conflicts are reported
384 bison -Werror gram.y # any conflict is an error
385
386 However, as before, if the %expect or %expect-rr directive is
387 specified, an unexpected number of conflicts is an error, and an
388 expected number of conflicts is not reported, so -W and --warning
389 then have no effect on the conflict report.
390
4b568fc0 391*** The `none' category no longer disables a preceding `error':
bf0e44e8
JD
392
393 For example, for the following command line, Bison now reports
394 errors instead of warnings for incompatibilities with POSIX Yacc:
395
396 bison -Werror,none,yacc gram.y
397
28801043 398*** The `none' category now disables all Bison warnings:
c39014ae 399
4b568fc0 400 Previously, the `none' category disabled only Bison warnings for
c39014ae
JD
401 which there existed a specific -W/--warning category. However,
402 given the following command line, Bison is now guaranteed to
403 suppress all warnings:
404
405 bison -Wnone gram.y
406
1f36f544
JD
407** Precedence directives can now assign token number 0:
408
409 Since Bison 2.3b, which restored the ability of precedence
410 directives to assign token numbers, doing so for token number 0 has
411 produced an assertion failure. For example:
412
413 %left END 0
414
415 This bug has been fixed.
416
64877e5e 417* Changes in version 2.4.3 (2010-08-05):
8b9e021f 418
2bfcac9a
JD
419** Bison now obeys -Werror and --warnings=error for warnings about
420 grammar rules that are useless in the parser due to conflicts.
421
8b9e021f
JD
422** Problems with spawning M4 on at least FreeBSD 8 and FreeBSD 9 have
423 been fixed.
424
4ad3921d
JD
425** Failures in the test suite for GCC 4.5 have been fixed.
426
06cb07d5
JD
427** Failures in the test suite for some versions of Sun Studio C++ have
428 been fixed.
429
9b5049bd
JD
430** Contrary to Bison 2.4.2's NEWS entry, it has been decided that
431 warnings about undefined %prec identifiers will not be converted to
432 errors in Bison 2.5. They will remain warnings, which should be
433 sufficient for POSIX while avoiding backward compatibility issues.
434
93d7dde9
JD
435** Minor documentation fixes.
436
e19a049c 437* Changes in version 2.4.2 (2010-03-20):
74553c98 438
f39ab286
JD
439** Some portability problems that resulted in failures and livelocks
440 in the test suite on some versions of at least Solaris, AIX, HP-UX,
e19a049c
JD
441 RHEL4, and Tru64 have been addressed. As a result, fatal Bison
442 errors should no longer cause M4 to report a broken pipe on the
f39ab286
JD
443 affected platforms.
444
8bb3a2e7
JD
445** `%prec IDENTIFIER' requires IDENTIFIER to be defined separately.
446
447 POSIX specifies that an error be reported for any identifier that does
448 not appear on the LHS of a grammar rule and that is not defined by
449 %token, %left, %right, or %nonassoc. Bison 2.3b and later lost this
450 error report for the case when an identifier appears only after a
451 %prec directive. It is now restored. However, for backward
452 compatibility with recent Bison releases, it is only a warning for
453 now. In Bison 2.5 and later, it will return to being an error.
9b5049bd
JD
454 [Between the 2.4.2 and 2.4.3 releases, it was decided that this
455 warning will not be converted to an error in Bison 2.5.]
8bb3a2e7 456
d8911864
EB
457** Detection of GNU M4 1.4.6 or newer during configure is improved.
458
a603c6e0
JD
459** Warnings from gcc's -Wundef option about undefined YYENABLE_NLS,
460 YYLTYPE_IS_TRIVIAL, and __STRICT_ANSI__ in C/C++ parsers are now
461 avoided.
c938d650 462
98a345a2
JD
463** %code is now a permanent feature.
464
465 A traditional Yacc prologue directive is written in the form:
466
467 %{CODE%}
468
469 To provide a more flexible alternative, Bison 2.3b introduced the
470 %code directive with the following forms for C/C++:
471
472 %code {CODE}
473 %code requires {CODE}
474 %code provides {CODE}
475 %code top {CODE}
476
477 These forms are now considered permanent features of Bison. See the
478 %code entries in the section "Bison Declaration Summary" in the Bison
479 manual for a summary of their functionality. See the section
480 "Prologue Alternatives" for a detailed discussion including the
481 advantages of %code over the traditional Yacc prologue directive.
482
483 Bison's Java feature as a whole including its current usage of %code
484 is still considered experimental.
485
1625df5b
JD
486** YYFAIL is deprecated and will eventually be removed.
487
488 YYFAIL has existed for many years as an undocumented feature of
489 deterministic parsers in C generated by Bison. Previously, it was
490 documented for Bison's experimental Java parsers. YYFAIL is no longer
491 documented for Java parsers and is formally deprecated in both cases.
492 Users are strongly encouraged to migrate to YYERROR, which is
493 specified by POSIX.
494
495 Like YYERROR, you can invoke YYFAIL from a semantic action in order to
496 induce a syntax error. The most obvious difference from YYERROR is
497 that YYFAIL will automatically invoke yyerror to report the syntax
498 error so that you don't have to. However, there are several other
499 subtle differences between YYERROR and YYFAIL, and YYFAIL suffers from
500 inherent flaws when %error-verbose or `#define YYERROR_VERBOSE' is
501 used. For a more detailed discussion, see:
502
503 http://lists.gnu.org/archive/html/bison-patches/2009-12/msg00024.html
504
505 The upcoming Bison 2.5 will remove YYFAIL from Java parsers, but
506 deterministic parsers in C will continue to implement it. However,
507 because YYFAIL is already flawed, it seems futile to try to make new
508 Bison features compatible with it. Thus, during parser generation,
509 Bison 2.5 will produce a warning whenever it discovers YYFAIL in a
510 rule action. In a later release, YYFAIL will be disabled for
511 %error-verbose and `#define YYERROR_VERBOSE'. Eventually, YYFAIL will
512 be removed altogether.
513
514 There exists at least one case where Bison 2.5's YYFAIL warning will
515 be a false positive. Some projects add phony uses of YYFAIL and other
516 Bison-defined macros for the sole purpose of suppressing C
517 preprocessor warnings (from GCC cpp's -Wunused-macros, for example).
518 To avoid Bison's future warning, such YYFAIL uses can be moved to the
519 epilogue (that is, after the second `%%') in the Bison input file. In
520 this release (2.4.2), Bison already generates its own code to suppress
521 C preprocessor warnings for YYFAIL, so projects can remove their own
522 phony uses of YYFAIL if compatibility with Bison releases prior to
523 2.4.2 is not necessary.
524
2755de8f
AD
525** Internationalization.
526
527 Fix a regression introduced in Bison 2.4: Under some circumstances,
528 message translations were not installed although supported by the
529 host system.
530
74553c98 531* Changes in version 2.4.1 (2008-12-11):
c9ba9e59 532
0ea583d2
AD
533** In the GLR defines file, unexpanded M4 macros in the yylval and yylloc
534 declarations have been fixed.
1979121c 535
0ea583d2
AD
536** Temporary hack for adding a semicolon to the user action.
537
538 Bison used to prepend a trailing semicolon at the end of the user
539 action for reductions. This allowed actions such as
540
541 exp: exp "+" exp { $$ = $1 + $3 };
542
543 instead of
544
545 exp: exp "+" exp { $$ = $1 + $3; };
546
547 Some grammars still depend on this `feature'. Bison 2.4.1 restores
548 the previous behavior in the case of C output (specifically, when
549 neither %language or %skeleton or equivalent command-line options
550 are used) to leave more time for grammars depending on the old
551 behavior to be adjusted. Future releases of Bison will disable this
552 feature.
553
554** A few minor improvements to the Bison manual.
c9ba9e59 555
402b123d 556* Changes in version 2.4 (2008-11-02):
7bd1665a 557
402b123d 558** %language is an experimental feature.
ed4d67dc
JD
559
560 We first introduced this feature in test release 2.3b as a cleaner
561 alternative to %skeleton. Since then, we have discussed the possibility of
562 modifying its effect on Bison's output file names. Thus, in this release,
563 we consider %language to be an experimental feature that will likely evolve
564 in future releases.
7bd1665a 565
402b123d 566** Forward compatibility with GNU M4 has been improved.
241fda7a 567
402b123d 568** Several bugs in the C++ skeleton and the experimental Java skeleton have been
241fda7a
JD
569 fixed.
570
402b123d 571* Changes in version 2.3b (2008-05-27):
35fe0834 572
402b123d 573** The quotes around NAME that used to be required in the following directive
d9df47b6
JD
574 are now deprecated:
575
576 %define NAME "VALUE"
577
402b123d 578** The directive `%pure-parser' is now deprecated in favor of:
d9df47b6
JD
579
580 %define api.pure
581
582 which has the same effect except that Bison is more careful to warn about
583 unreasonable usage in the latter case.
584
402b123d 585** Push Parsing
c373bf8b
JD
586
587 Bison can now generate an LALR(1) parser in C with a push interface. That
ef1b4273 588 is, instead of invoking `yyparse', which pulls tokens from `yylex', you can
c373bf8b
JD
589 push one token at a time to the parser using `yypush_parse', which will
590 return to the caller after processing each token. By default, the push
591 interface is disabled. Either of the following directives will enable it:
592
593 %define api.push_pull "push" // Just push; does not require yylex.
594 %define api.push_pull "both" // Push and pull; requires yylex.
595
596 See the new section `A Push Parser' in the Bison manual for details.
597
59da312b
JD
598 The current push parsing interface is experimental and may evolve. More user
599 feedback will help to stabilize it.
600
402b123d 601** The -g and --graph options now output graphs in Graphviz DOT format,
8e55b3aa
JD
602 not VCG format. Like --graph, -g now also takes an optional FILE argument
603 and thus cannot be bundled with other short options.
c373bf8b 604
402b123d 605** Java
59da312b
JD
606
607 Bison can now generate an LALR(1) parser in Java. The skeleton is
608 `data/lalr1.java'. Consider using the new %language directive instead of
609 %skeleton to select it.
610
611 See the new section `Java Parsers' in the Bison manual for details.
612
613 The current Java interface is experimental and may evolve. More user
614 feedback will help to stabilize it.
615
402b123d 616** %language
59da312b
JD
617
618 This new directive specifies the programming language of the generated
d43f77e7
PB
619 parser, which can be C (the default), C++, or Java. Besides the skeleton
620 that Bison uses, the directive affects the names of the generated files if
621 the grammar file's name ends in ".y".
59da312b 622
402b123d 623** XML Automaton Report
59da312b
JD
624
625 Bison can now generate an XML report of the LALR(1) automaton using the new
626 `--xml' option. The current XML schema is experimental and may evolve. More
627 user feedback will help to stabilize it.
c373bf8b 628
402b123d 629** The grammar file may now specify the name of the parser header file using
c373bf8b
JD
630 %defines. For example:
631
632 %defines "parser.h"
633
402b123d 634** When reporting useless rules, useless nonterminals, and unused terminals,
d80fb37a
JD
635 Bison now employs the terms "useless in grammar" instead of "useless",
636 "useless in parser" instead of "never reduced", and "unused in grammar"
637 instead of "unused".
cff03fb2 638
402b123d 639** Unreachable State Removal
c373bf8b
JD
640
641 Previously, Bison sometimes generated parser tables containing unreachable
31984206
JD
642 states. A state can become unreachable during conflict resolution if Bison
643 disables a shift action leading to it from a predecessor state. Bison now:
75ad86ee
JD
644
645 1. Removes unreachable states.
646
647 2. Does not report any conflicts that appeared in unreachable states.
648 WARNING: As a result, you may need to update %expect and %expect-rr
649 directives in existing grammar files.
650
651 3. For any rule used only in such states, Bison now reports the rule as
cff03fb2 652 "useless in parser due to conflicts".
75ad86ee 653
31984206
JD
654 This feature can be disabled with the following directive:
655
656 %define lr.keep_unreachable_states
657
658 See the %define entry in the `Bison Declaration Summary' in the Bison manual
659 for further discussion.
660
402b123d 661** Lookahead Set Correction in the `.output' Report
b1cc23c4 662
c373bf8b 663 When instructed to generate a `.output' file including lookahead sets
88c78747
JD
664 (using `--report=lookahead', for example), Bison now prints each reduction's
665 lookahead set only next to the associated state's one item that (1) is
666 associated with the same rule as the reduction and (2) has its dot at the end
667 of its RHS. Previously, Bison also erroneously printed the lookahead set
668 next to all of the state's other items associated with the same rule. This
669 bug affected only the `.output' file and not the generated parser source
670 code.
671
402b123d 672** --report-file=FILE is a new option to override the default `.output' file
59da312b 673 name.
1bb2bd75 674
402b123d 675** The `=' that used to be required in the following directives is now
02975b9a
JD
676 deprecated:
677
678 %file-prefix "parser"
679 %name-prefix "c_"
680 %output "parser.c"
681
402b123d 682** An Alternative to `%{...%}' -- `%code QUALIFIER {CODE}'
c373bf8b
JD
683
684 Bison 2.3a provided a new set of directives as a more flexible alternative to
8e0a5e9e
JD
685 the traditional Yacc prologue blocks. Those have now been consolidated into
686 a single %code directive with an optional qualifier field, which identifies
687 the purpose of the code and thus the location(s) where Bison should generate
688 it:
689
16dc6a9e
JD
690 1. `%code {CODE}' replaces `%after-header {CODE}'
691 2. `%code requires {CODE}' replaces `%start-header {CODE}'
692 3. `%code provides {CODE}' replaces `%end-header {CODE}'
693 4. `%code top {CODE}' replaces `%before-header {CODE}'
8e0a5e9e 694
61fee93e
JD
695 See the %code entries in section `Bison Declaration Summary' in the Bison
696 manual for a summary of the new functionality. See the new section `Prologue
8e0a5e9e
JD
697 Alternatives' for a detailed discussion including the advantages of %code
698 over the traditional Yacc prologues.
699
700 The prologue alternatives are experimental. More user feedback will help to
701 determine whether they should become permanent features.
702
402b123d 703** Revised warning: unset or unused mid-rule values
17bd8a73
JD
704
705 Since Bison 2.2, Bison has warned about mid-rule values that are set but not
706 used within any of the actions of the parent rule. For example, Bison warns
707 about unused $2 in:
708
709 exp: '1' { $$ = 1; } '+' exp { $$ = $1 + $4; };
710
711 Now, Bison also warns about mid-rule values that are used but not set. For
712 example, Bison warns about unset $$ in the mid-rule action in:
713
714 exp: '1' { $1 = 1; } '+' exp { $$ = $2 + $4; };
715
716 However, Bison now disables both of these warnings by default since they
717 sometimes prove to be false alarms in existing grammars employing the Yacc
718 constructs $0 or $-N (where N is some positive integer).
719
59da312b 720 To enable these warnings, specify the option `--warnings=midrule-values' or
17bd8a73
JD
721 `-W', which is a synonym for `--warnings=all'.
722
402b123d 723** Default %destructor or %printer with `<*>' or `<>'
c373bf8b
JD
724
725 Bison now recognizes two separate kinds of default %destructor's and
12e35840
JD
726 %printer's:
727
728 1. Place `<*>' in a %destructor/%printer symbol list to define a default
729 %destructor/%printer for all grammar symbols for which you have formally
730 declared semantic type tags.
731
3ebecc24 732 2. Place `<>' in a %destructor/%printer symbol list to define a default
12e35840
JD
733 %destructor/%printer for all grammar symbols without declared semantic
734 type tags.
735
736 Bison no longer supports the `%symbol-default' notation from Bison 2.3a.
3ebecc24 737 `<*>' and `<>' combined achieve the same effect with one exception: Bison no
12e35840
JD
738 longer applies any %destructor to a mid-rule value if that mid-rule value is
739 not actually ever referenced using either $$ or $n in a semantic action.
740
85894313
JD
741 The default %destructor's and %printer's are experimental. More user
742 feedback will help to determine whether they should become permanent
743 features.
744
12e35840
JD
745 See the section `Freeing Discarded Symbols' in the Bison manual for further
746 details.
747
402b123d 748** %left, %right, and %nonassoc can now declare token numbers. This is required
ab7f29f8
JD
749 by POSIX. However, see the end of section `Operator Precedence' in the Bison
750 manual for a caveat concerning the treatment of literal strings.
751
402b123d 752** The nonfunctional --no-parser, -n, and %no-parser options have been
b1cc23c4
JD
753 completely removed from Bison.
754
402b123d 755* Changes in version 2.3a, 2006-09-13:
742e4900 756
402b123d 757** Instead of %union, you can define and use your own union type
ddc8ede1
PE
758 YYSTYPE if your grammar contains at least one <type> tag.
759 Your YYSTYPE need not be a macro; it can be a typedef.
760 This change is for compatibility with other Yacc implementations,
761 and is required by POSIX.
762
402b123d 763** Locations columns and lines start at 1.
cd48d21d
AD
764 In accordance with the GNU Coding Standards and Emacs.
765
402b123d 766** You may now declare per-type and default %destructor's and %printer's:
ec5479ce
JD
767
768 For example:
769
b2a0b7ca
JD
770 %union { char *string; }
771 %token <string> STRING1
772 %token <string> STRING2
773 %type <string> string1
774 %type <string> string2
775 %union { char character; }
776 %token <character> CHR
777 %type <character> chr
778 %destructor { free ($$); } %symbol-default
779 %destructor { free ($$); printf ("%d", @$.first_line); } STRING1 string1
780 %destructor { } <character>
781
782 guarantees that, when the parser discards any user-defined symbol that has a
783 semantic type tag other than `<character>', it passes its semantic value to
784 `free'. However, when the parser discards a `STRING1' or a `string1', it
785 also prints its line number to `stdout'. It performs only the second
786 `%destructor' in this case, so it invokes `free' only once.
ec5479ce 787
85894313
JD
788 [Although we failed to mention this here in the 2.3a release, the default
789 %destructor's and %printer's were experimental, and they were rewritten in
790 future versions.]
791
402b123d 792** Except for LALR(1) parsers in C with POSIX Yacc emulation enabled (with `-y',
b931235e
JD
793 `--yacc', or `%yacc'), Bison no longer generates #define statements for
794 associating token numbers with token names. Removing the #define statements
795 helps to sanitize the global namespace during preprocessing, but POSIX Yacc
796 requires them. Bison still generates an enum for token names in all cases.
797
402b123d 798** Handling of traditional Yacc prologue blocks is now more consistent but
34f98f46 799 potentially incompatible with previous releases of Bison.
9bc0dd67
JD
800
801 As before, you declare prologue blocks in your grammar file with the
802 `%{ ... %}' syntax. To generate the pre-prologue, Bison concatenates all
34f98f46
JD
803 prologue blocks that you've declared before the first %union. To generate
804 the post-prologue, Bison concatenates all prologue blocks that you've
ddc8ede1 805 declared after the first %union.
9bc0dd67 806
34f98f46 807 Previous releases of Bison inserted the pre-prologue into both the header
9bc0dd67
JD
808 file and the code file in all cases except for LALR(1) parsers in C. In the
809 latter case, Bison inserted it only into the code file. For parsers in C++,
810 the point of insertion was before any token definitions (which associate
811 token numbers with names). For parsers in C, the point of insertion was
812 after the token definitions.
813
814 Now, Bison never inserts the pre-prologue into the header file. In the code
815 file, it always inserts it before the token definitions.
816
402b123d 817** Bison now provides a more flexible alternative to the traditional Yacc
34f98f46
JD
818 prologue blocks: %before-header, %start-header, %end-header, and
819 %after-header.
820
821 For example, the following declaration order in the grammar file reflects the
822 order in which Bison will output these code blocks. However, you are free to
823 declare these code blocks in your grammar file in whatever order is most
824 convenient for you:
825
826 %before-header {
827 /* Bison treats this block like a pre-prologue block: it inserts it into
828 * the code file before the contents of the header file. It does *not*
829 * insert it into the header file. This is a good place to put
830 * #include's that you want at the top of your code file. A common
831 * example is `#include "system.h"'. */
832 }
833 %start-header {
834 /* Bison inserts this block into both the header file and the code file.
835 * In both files, the point of insertion is before any Bison-generated
836 * token, semantic type, location type, and class definitions. This is a
837 * good place to define %union dependencies, for example. */
9bc0dd67
JD
838 }
839 %union {
34f98f46
JD
840 /* Unlike the traditional Yacc prologue blocks, the output order for the
841 * new %*-header blocks is not affected by their declaration position
842 * relative to any %union in the grammar file. */
9bc0dd67 843 }
34f98f46
JD
844 %end-header {
845 /* Bison inserts this block into both the header file and the code file.
846 * In both files, the point of insertion is after the Bison-generated
847 * definitions. This is a good place to declare or define public
848 * functions or data structures that depend on the Bison-generated
849 * definitions. */
9bc0dd67 850 }
34f98f46
JD
851 %after-header {
852 /* Bison treats this block like a post-prologue block: it inserts it into
853 * the code file after the contents of the header file. It does *not*
854 * insert it into the header file. This is a good place to declare or
855 * define internal functions or data structures that depend on the
856 * Bison-generated definitions. */
857 }
858
859 If you have multiple occurrences of any one of the above declarations, Bison
860 will concatenate the contents in declaration order.
9bc0dd67 861
85894313
JD
862 [Although we failed to mention this here in the 2.3a release, the prologue
863 alternatives were experimental, and they were rewritten in future versions.]
864
402b123d 865** The option `--report=look-ahead' has been changed to `--report=lookahead'.
9e6e7ed2
PE
866 The old spelling still works, but is not documented and may be removed
867 in a future release.
742e4900 868
402b123d 869* Changes in version 2.3, 2006-06-05:
4ad3ed84 870
402b123d 871** GLR grammars should now use `YYRECOVERING ()' instead of `YYRECOVERING',
4ad3ed84
PE
872 for compatibility with LALR(1) grammars.
873
402b123d 874** It is now documented that any definition of YYSTYPE or YYLTYPE should
4ad3ed84
PE
875 be to a type name that does not contain parentheses or brackets.
876
402b123d 877* Changes in version 2.2, 2006-05-19:
193d7c70 878
402b123d 879** The distribution terms for all Bison-generated parsers now permit
193d7c70
PE
880 using the parsers in nonfree programs. Previously, this permission
881 was granted only for Bison-generated LALR(1) parsers in C.
5f4236a0 882
402b123d 883** %name-prefix changes the namespace name in C++ outputs.
aa08666d 884
402b123d 885** The C++ parsers export their token_type.
5f4236a0 886
402b123d 887** Bison now allows multiple %union declarations, and concatenates
d6ca7905
PE
888 their contents together.
889
402b123d 890** New warning: unused values
4d7bc38c
PE
891 Right-hand side symbols whose values are not used are reported,
892 if the symbols have destructors. For instance:
affac613 893
8f3596a6 894 exp: exp "?" exp ":" exp { $1 ? $1 : $3; }
721be13c
PE
895 | exp "+" exp
896 ;
affac613 897
8f3596a6
AD
898 will trigger a warning about $$ and $5 in the first rule, and $3 in
899 the second ($1 is copied to $$ by the default rule). This example
4e26c69e 900 most likely contains three errors, and could be rewritten as:
affac613 901
4e26c69e
PE
902 exp: exp "?" exp ":" exp
903 { $$ = $1 ? $3 : $5; free ($1 ? $5 : $3); free ($1); }
904 | exp "+" exp
905 { $$ = $1 ? $1 : $3; if ($1) free ($3); }
721be13c 906 ;
affac613 907
4e26c69e
PE
908 However, if the original actions were really intended, memory leaks
909 and all, the warnings can be suppressed by letting Bison believe the
910 values are used, e.g.:
721be13c 911
8f3596a6 912 exp: exp "?" exp ":" exp { $1 ? $1 : $3; (void) ($$, $5); }
721be13c
PE
913 | exp "+" exp { $$ = $1; (void) $3; }
914 ;
915
84866159
AD
916 If there are mid-rule actions, the warning is issued if no action
917 uses it. The following triggers no warning: $1 and $3 are used.
918
919 exp: exp { push ($1); } '+' exp { push ($3); sum (); };
920
721be13c
PE
921 The warning is intended to help catching lost values and memory leaks.
922 If a value is ignored, its associated memory typically is not reclaimed.
affac613 923
402b123d 924** %destructor vs. YYABORT, YYACCEPT, and YYERROR.
9d9b8b70
PE
925 Destructors are now called when user code invokes YYABORT, YYACCEPT,
926 and YYERROR, for all objects on the stack, other than objects
927 corresponding to the right-hand side of the current rule.
a85284cf 928
402b123d 929** %expect, %expect-rr
035aa4a0
PE
930 Incorrect numbers of expected conflicts are now actual errors,
931 instead of warnings.
932
402b123d 933** GLR, YACC parsers.
4e26c69e
PE
934 The %parse-params are available in the destructors (and the
935 experimental printers) as per the documentation.
4b367315 936
402b123d 937** Bison now warns if it finds a stray `$' or `@' in an action.
ad6a9b97 938
402b123d 939** %require "VERSION"
4e26c69e
PE
940 This specifies that the grammar file depends on features implemented
941 in Bison version VERSION or higher.
b50d2359 942
402b123d 943** lalr1.cc: The token and value types are now class members.
e14d0ab6
AD
944 The tokens were defined as free form enums and cpp macros. YYSTYPE
945 was defined as a free form union. They are now class members:
fb9712a9
AD
946 tokens are enumerations of the `yy::parser::token' struct, and the
947 semantic values have the `yy::parser::semantic_type' type.
948
949 If you do not want or can update to this scheme, the directive
950 `%define "global_tokens_and_yystype" "1"' triggers the global
b50d2359
AD
951 definition of tokens and YYSTYPE. This change is suitable both
952 for previous releases of Bison, and this one.
fb9712a9 953
b50d2359 954 If you wish to update, then make sure older version of Bison will
ab8d9dc5 955 fail using `%require "2.2"'.
fb9712a9 956
402b123d 957** DJGPP support added.
193d7c70 958\f
402b123d 959* Changes in version 2.1, 2005-09-16:
1ce59070 960
402b123d 961** The C++ lalr1.cc skeleton supports %lex-param.
e14d0ab6 962
402b123d 963** Bison-generated parsers now support the translation of diagnostics like
baf785db
PE
964 "syntax error" into languages other than English. The default
965 language is still English. For details, please see the new
0410a6e0
PE
966 Internationalization section of the Bison manual. Software
967 distributors should also see the new PACKAGING file. Thanks to
968 Bruno Haible for this new feature.
1ce59070 969
402b123d 970** Wording in the Bison-generated parsers has been changed slightly to
1a059451
PE
971 simplify translation. In particular, the message "memory exhausted"
972 has replaced "parser stack overflow", as the old message was not
973 always accurate for modern Bison-generated parsers.
974
402b123d 975** Destructors are now called when the parser aborts, for all symbols left
258b75ca
PE
976 behind on the stack. Also, the start symbol is now destroyed after a
977 successful parse. In both cases, the behavior was formerly inconsistent.
978
402b123d 979** When generating verbose diagnostics, Bison-generated parsers no longer
72f000b0
PE
980 quote the literal strings associated with tokens. For example, for
981 a syntax error associated with '%token NUM "number"' they might
982 print 'syntax error, unexpected number' instead of 'syntax error,
983 unexpected "number"'.
193d7c70 984\f
402b123d 985* Changes in version 2.0, 2004-12-25:
efeed023 986
402b123d 987** Possibly-incompatible changes
d7e14fc0 988
82de6b0d
PE
989 - Bison-generated parsers no longer default to using the alloca function
990 (when available) to extend the parser stack, due to widespread
991 problems in unchecked stack-overflow detection. You can "#define
992 YYSTACK_USE_ALLOCA 1" to require the use of alloca, but please read
993 the manual to determine safe values for YYMAXDEPTH in that case.
8dd162d3 994
82de6b0d
PE
995 - Error token location.
996 During error recovery, the location of the syntax error is updated
997 to cover the whole sequence covered by the error token: it includes
998 the shifted symbols thrown away during the first part of the error
999 recovery, and the lookahead rejected during the second part.
18d192f0 1000
82de6b0d
PE
1001 - Semicolon changes:
1002 . Stray semicolons are no longer allowed at the start of a grammar.
1003 . Semicolons are now required after in-grammar declarations.
e342c3be 1004
82de6b0d
PE
1005 - Unescaped newlines are no longer allowed in character constants or
1006 string literals. They were never portable, and GCC 3.4.0 has
1007 dropped support for them. Better diagnostics are now generated if
1008 forget a closing quote.
8dd162d3 1009
82de6b0d 1010 - NUL bytes are no longer allowed in Bison string literals, unfortunately.
f74b6f91 1011
402b123d 1012** New features
1452af69 1013
82de6b0d 1014 - GLR grammars now support locations.
4febdd96 1015
82de6b0d
PE
1016 - New directive: %initial-action.
1017 This directive allows the user to run arbitrary code (including
1018 initializing @$) from yyparse before parsing starts.
1452af69 1019
82de6b0d
PE
1020 - A new directive "%expect-rr N" specifies the expected number of
1021 reduce/reduce conflicts in GLR parsers.
1452af69 1022
82de6b0d
PE
1023 - %token numbers can now be hexadecimal integers, e.g., `%token FOO 0x12d'.
1024 This is a GNU extension.
4febdd96 1025
82de6b0d 1026 - The option `--report=lookahead' was changed to `--report=look-ahead'.
9e6e7ed2 1027 [However, this was changed back after 2.3.]
1452af69 1028
82de6b0d 1029 - Experimental %destructor support has been added to lalr1.cc.
1452af69 1030
82de6b0d
PE
1031 - New configure option --disable-yacc, to disable installation of the
1032 yacc command and -ly library introduced in 1.875 for POSIX conformance.
6040d338 1033
402b123d 1034** Bug fixes
d5a3fe37 1035
82de6b0d
PE
1036 - For now, %expect-count violations are now just warnings, not errors.
1037 This is for compatibility with Bison 1.75 and earlier (when there are
1038 reduce/reduce conflicts) and with Bison 1.30 and earlier (when there
1039 are too many or too few shift/reduce conflicts). However, in future
1040 versions of Bison we plan to improve the %expect machinery so that
1041 these violations will become errors again.
3473d0f8 1042
82de6b0d
PE
1043 - Within Bison itself, numbers (e.g., goto numbers) are no longer
1044 arbitrarily limited to 16-bit counts.
d600ee67 1045
82de6b0d 1046 - Semicolons are now allowed before "|" in grammar rules, as POSIX requires.
d600ee67 1047\f
402b123d 1048* Changes in version 1.875, 2003-01-01:
963fcc17 1049
402b123d 1050** The documentation license has been upgraded to version 1.2
dc546b0f 1051 of the GNU Free Documentation License.
75eb3bc4 1052
402b123d 1053** syntax error processing
75eb3bc4 1054
dc546b0f
PE
1055 - In Yacc-style parsers YYLLOC_DEFAULT is now used to compute error
1056 locations too. This fixes bugs in error-location computation.
75eb3bc4 1057
dc546b0f
PE
1058 - %destructor
1059 It is now possible to reclaim the memory associated to symbols
1060 discarded during error recovery. This feature is still experimental.
20daca06 1061
dc546b0f
PE
1062 - %error-verbose
1063 This new directive is preferred over YYERROR_VERBOSE.
74724a70 1064
dc546b0f
PE
1065 - #defining yyerror to steal internal variables is discouraged.
1066 It is not guaranteed to work forever.
d1de5372 1067
402b123d 1068** POSIX conformance
d1de5372 1069
dc546b0f
PE
1070 - Semicolons are once again optional at the end of grammar rules.
1071 This reverts to the behavior of Bison 1.33 and earlier, and improves
1072 compatibility with Yacc.
74724a70 1073
dc546b0f
PE
1074 - `parse error' -> `syntax error'
1075 Bison now uniformly uses the term `syntax error'; formerly, the code
1076 and manual sometimes used the term `parse error' instead. POSIX
1077 requires `syntax error' in diagnostics, and it was thought better to
1078 be consistent.
74724a70 1079
dc546b0f
PE
1080 - The documentation now emphasizes that yylex and yyerror must be
1081 declared before use. C99 requires this.
d1de5372 1082
dc546b0f
PE
1083 - Bison now parses C99 lexical constructs like UCNs and
1084 backslash-newline within C escape sequences, as POSIX 1003.1-2001 requires.
d1de5372 1085
dc546b0f
PE
1086 - File names are properly escaped in C output. E.g., foo\bar.y is
1087 output as "foo\\bar.y".
6780ca7a 1088
dc546b0f
PE
1089 - Yacc command and library now available
1090 The Bison distribution now installs a `yacc' command, as POSIX requires.
1091 Also, Bison now installs a small library liby.a containing
1092 implementations of Yacc-compatible yyerror and main functions.
1093 This library is normally not useful, but POSIX requires it.
6e649e65 1094
dc546b0f 1095 - Type clashes now generate warnings, not errors.
6e649e65 1096
dc546b0f
PE
1097 - If the user does not define YYSTYPE as a macro, Bison now declares it
1098 using typedef instead of defining it as a macro.
1099 For consistency, YYLTYPE is also declared instead of defined.
9501dc6e 1100
402b123d 1101** Other compatibility issues
886a425c 1102
dc546b0f
PE
1103 - %union directives can now have a tag before the `{', e.g., the
1104 directive `%union foo {...}' now generates the C code
1105 `typedef union foo { ... } YYSTYPE;'; this is for Yacc compatibility.
1106 The default union tag is `YYSTYPE', for compatibility with Solaris 9 Yacc.
1107 For consistency, YYLTYPE's struct tag is now `YYLTYPE' not `yyltype'.
1108 This is for compatibility with both Yacc and Bison 1.35.
72f889cc 1109
dc546b0f
PE
1110 - `;' is output before the terminating `}' of an action, for
1111 compatibility with Bison 1.35.
886a425c 1112
dc546b0f
PE
1113 - Bison now uses a Yacc-style format for conflict reports, e.g.,
1114 `conflicts: 2 shift/reduce, 1 reduce/reduce'.
437c2d80 1115
dc546b0f
PE
1116 - `yystype' and `yyltype' are now obsolescent macros instead of being
1117 typedefs or tags; they are no longer documented and are planned to be
1118 withdrawn in a future release.
2a8d363a 1119
402b123d 1120** GLR parser notes
2a8d363a 1121
dc546b0f
PE
1122 - GLR and inline
1123 Users of Bison have to decide how they handle the portability of the
1124 C keyword `inline'.
959e5f51 1125
dc546b0f
PE
1126 - `parsing stack overflow...' -> `parser stack overflow'
1127 GLR parsers now report `parser stack overflow' as per the Bison manual.
900c5db5 1128
402b123d 1129** Bison now warns if it detects conflicting outputs to the same file,
dc546b0f
PE
1130 e.g., it generates a warning for `bison -d -o foo.h foo.y' since
1131 that command outputs both code and header to foo.h.
6e40b4eb 1132
402b123d 1133** #line in output files
dc546b0f 1134 - --no-line works properly.
6e40b4eb 1135
402b123d 1136** Bison can no longer be built by a K&R C compiler; it requires C89 or
6e40b4eb
AD
1137 later to be built. This change originally took place a few versions
1138 ago, but nobody noticed until we recently asked someone to try
1139 building Bison with a K&R C compiler.
d600ee67 1140\f
402b123d 1141* Changes in version 1.75, 2002-10-14:
7933f2b5 1142
402b123d 1143** Bison should now work on 64-bit hosts.
7933f2b5 1144
402b123d 1145** Indonesian translation thanks to Tedi Heriyanto.
7933f2b5 1146
402b123d 1147** GLR parsers
f50adbbd
AD
1148 Fix spurious parse errors.
1149
402b123d 1150** Pure parsers
f50adbbd
AD
1151 Some people redefine yyerror to steal yyparse' private variables.
1152 Reenable this trick until an official feature replaces it.
1153
402b123d 1154** Type Clashes
d90c934c
AD
1155 In agreement with POSIX and with other Yaccs, leaving a default
1156 action is valid when $$ is untyped, and $1 typed:
1157
1158 untyped: ... typed;
1159
1160 but the converse remains an error:
1161
1162 typed: ... untyped;
1163
402b123d 1164** Values of mid-rule actions
d90c934c
AD
1165 The following code:
1166
1167 foo: { ... } { $$ = $1; } ...
1168
1169 was incorrectly rejected: $1 is defined in the second mid-rule
1170 action, and is equal to the $$ of the first mid-rule action.
d600ee67 1171\f
402b123d 1172* Changes in version 1.50, 2002-10-04:
adc8c848 1173
402b123d 1174** GLR parsing
676385e2
PH
1175 The declaration
1176 %glr-parser
1177 causes Bison to produce a Generalized LR (GLR) parser, capable of handling
1178 almost any context-free grammar, ambiguous or not. The new declarations
e8832397 1179 %dprec and %merge on grammar rules allow parse-time resolution of
676385e2
PH
1180 ambiguities. Contributed by Paul Hilfinger.
1181
7933f2b5 1182 Unfortunately Bison 1.50 does not work properly on 64-bit hosts
420f93c8
PE
1183 like the Alpha, so please stick to 32-bit hosts for now.
1184
402b123d 1185** Output Directory
8c165d89 1186 When not in Yacc compatibility mode, when the output file was not
e88dbdbf 1187 specified, running `bison foo/bar.y' created `foo/bar.c'. It
8c165d89
AD
1188 now creates `bar.c'.
1189
402b123d 1190** Undefined token
007a50a4 1191 The undefined token was systematically mapped to 2 which prevented
e88dbdbf 1192 the use of 2 by the user. This is no longer the case.
007a50a4 1193
402b123d 1194** Unknown token numbers
e88dbdbf 1195 If yylex returned an out of range value, yyparse could die. This is
007a50a4
AD
1196 no longer the case.
1197
402b123d 1198** Error token
e88dbdbf 1199 According to POSIX, the error token must be 256.
23c5a174
AD
1200 Bison extends this requirement by making it a preference: *if* the
1201 user specified that one of her tokens is numbered 256, then error
1202 will be mapped onto another number.
1203
402b123d 1204** Verbose error messages
e88dbdbf 1205 They no longer report `..., expecting error or...' for states where
217598da
AD
1206 error recovery is possible.
1207
402b123d 1208** End token
217598da
AD
1209 Defaults to `$end' instead of `$'.
1210
402b123d 1211** Error recovery now conforms to documentation and to POSIX
68cd8af3
PE
1212 When a Bison-generated parser encounters a syntax error, it now pops
1213 the stack until it finds a state that allows shifting the error
1214 token. Formerly, it popped the stack until it found a state that
1215 allowed some non-error action other than a default reduction on the
1216 error token. The new behavior has long been the documented behavior,
1217 and has long been required by POSIX. For more details, please see
337116ba
PE
1218 Paul Eggert, "Reductions during Bison error handling" (2002-05-20)
1219 <http://lists.gnu.org/archive/html/bug-bison/2002-05/msg00038.html>.
68cd8af3 1220
402b123d 1221** Traces
5504898e
AD
1222 Popped tokens and nonterminals are now reported.
1223
402b123d 1224** Larger grammars
a861a339
PE
1225 Larger grammars are now supported (larger token numbers, larger grammar
1226 size (= sum of the LHS and RHS lengths), larger LALR tables).
1227 Formerly, many of these numbers ran afoul of 16-bit limits;
1228 now these limits are 32 bits on most hosts.
355e7c1c 1229
402b123d 1230** Explicit initial rule
643a5994
AD
1231 Bison used to play hacks with the initial rule, which the user does
1232 not write. It is now explicit, and visible in the reports and
1233 graphs as rule 0.
23c5a174 1234
402b123d 1235** Useless rules
643a5994 1236 Before, Bison reported the useless rules, but, although not used,
77714df2 1237 included them in the parsers. They are now actually removed.
23c5a174 1238
402b123d 1239** Useless rules, useless nonterminals
6b98e4b5
AD
1240 They are now reported, as a warning, with their locations.
1241
402b123d 1242** Rules never reduced
e8832397
AD
1243 Rules that can never be reduced because of conflicts are now
1244 reported.
1245
402b123d 1246** Incorrect `Token not used'
11652ab3
AD
1247 On a grammar such as
1248
1249 %token useless useful
1250 %%
1251 exp: '0' %prec useful;
1252
1253 where a token was used to set the precedence of the last rule,
1254 bison reported both `useful' and `useless' as useless tokens.
1255
402b123d 1256** Revert the C++ namespace changes introduced in 1.31
77714df2 1257 as they caused too many portability hassles.
0179dd65 1258
402b123d 1259** Default locations
b2d52318
AD
1260 By an accident of design, the default computation of @$ was
1261 performed after another default computation was performed: @$ = @1.
1262 The latter is now removed: YYLLOC_DEFAULT is fully responsible of
1263 the computation of @$.
adc8c848 1264
402b123d 1265** Token end-of-file
b7c49edf
AD
1266 The token end of file may be specified by the user, in which case,
1267 the user symbol is used in the reports, the graphs, and the verbose
a861a339 1268 error messages instead of `$end', which remains being the default.
b7c49edf 1269 For instance
7bd6c77e 1270 %token MYEOF 0
b7c49edf 1271 or
7bd6c77e 1272 %token MYEOF 0 "end of file"
fdbcd8e2 1273
402b123d 1274** Semantic parser
fdbcd8e2
AD
1275 This old option, which has been broken for ages, is removed.
1276
402b123d 1277** New translations
a861a339 1278 Brazilian Portuguese, thanks to Alexandre Folle de Menezes.
84614e13
AD
1279 Croatian, thanks to Denis Lackovic.
1280
402b123d 1281** Incorrect token definitions
e88dbdbf 1282 When given `%token 'a' "A"', Bison used to output `#define 'a' 65'.
b87f8b21 1283
402b123d 1284** Token definitions as enums
77714df2
AD
1285 Tokens are output both as the traditional #define's, and, provided
1286 the compiler supports ANSI C or is a C++ compiler, as enums.
e88dbdbf 1287 This lets debuggers display names instead of integers.
77714df2 1288
402b123d 1289** Reports
ec3bc396
AD
1290 In addition to --verbose, bison supports --report=THINGS, which
1291 produces additional information:
b408954b
AD
1292 - itemset
1293 complete the core item sets with their closure
9e6e7ed2
PE
1294 - lookahead [changed to `look-ahead' in 1.875e through 2.3, but changed back]
1295 explicitly associate lookahead tokens to items
b408954b
AD
1296 - solved
1297 describe shift/reduce conflicts solving.
1298 Bison used to systematically output this information on top of
1299 the report. Solved conflicts are now attached to their states.
ec3bc396 1300
402b123d 1301** Type clashes
9af3fbce
AD
1302 Previous versions don't complain when there is a type clash on
1303 the default action if the rule has a mid-rule action, such as in:
1304
1305 %type <foo> bar
1306 %%
1307 bar: '0' {} '0';
1308
1309 This is fixed.
a861a339 1310
402b123d 1311** GNU M4 is now required when using Bison.
f987e9d2 1312\f
402b123d 1313* Changes in version 1.35, 2002-03-25:
76551463 1314
402b123d 1315** C Skeleton
76551463
AD
1316 Some projects use Bison's C parser with C++ compilers, and define
1317 YYSTYPE as a class. The recent adjustment of C parsers for data
1318 alignment and 64 bit architectures made this impossible.
1319
1320 Because for the time being no real solution for C++ parser
1321 generation exists, kludges were implemented in the parser to
1322 maintain this use. In the future, when Bison has C++ parsers, this
1323 kludge will be disabled.
1324
1325 This kludge also addresses some C++ problems when the stack was
1326 extended.
76551463 1327\f
402b123d 1328* Changes in version 1.34, 2002-03-12:
76551463 1329
402b123d 1330** File name clashes are detected
76551463
AD
1331 $ bison foo.y -d -o foo.x
1332 fatal error: header and parser would both be named `foo.x'
1333
402b123d 1334** A missing `;' at the end of a rule triggers a warning
76551463
AD
1335 In accordance with POSIX, and in agreement with other
1336 Yacc implementations, Bison will mandate this semicolon in the near
1337 future. This eases the implementation of a Bison parser of Bison
1338 grammars by making this grammar LALR(1) instead of LR(2). To
1339 facilitate the transition, this release introduces a warning.
1340
402b123d 1341** Revert the C++ namespace changes introduced in 1.31, as they caused too
76551463
AD
1342 many portability hassles.
1343
402b123d 1344** DJGPP support added.
76551463 1345
402b123d 1346** Fix test suite portability problems.
76551463 1347\f
402b123d 1348* Changes in version 1.33, 2002-02-07:
76551463 1349
402b123d 1350** Fix C++ issues
76551463
AD
1351 Groff could not be compiled for the definition of size_t was lacking
1352 under some conditions.
1353
402b123d 1354** Catch invalid @n
76551463
AD
1355 As is done with $n.
1356\f
402b123d 1357* Changes in version 1.32, 2002-01-23:
76551463 1358
402b123d 1359** Fix Yacc output file names
76551463 1360
402b123d 1361** Portability fixes
76551463 1362
402b123d 1363** Italian, Dutch translations
76551463 1364\f
402b123d 1365* Changes in version 1.31, 2002-01-14:
52d1aeee 1366
402b123d 1367** Many Bug Fixes
52d1aeee 1368
402b123d 1369** GNU Gettext and %expect
52d1aeee
MA
1370 GNU Gettext asserts 10 s/r conflicts, but there are 7. Now that
1371 Bison dies on incorrect %expectations, we fear there will be
1372 too many bug reports for Gettext, so _for the time being_, %expect
1373 does not trigger an error when the input file is named `plural.y'.
1374
402b123d 1375** Use of alloca in parsers
52d1aeee
MA
1376 If YYSTACK_USE_ALLOCA is defined to 0, then the parsers will use
1377 malloc exclusively. Since 1.29, but was not NEWS'ed.
1378
1379 alloca is used only when compiled with GCC, to avoid portability
1380 problems as on AIX.
1381
402b123d 1382** yyparse now returns 2 if memory is exhausted; formerly it dumped core.
b47dbebe 1383
402b123d 1384** When the generated parser lacks debugging code, YYDEBUG is now 0
52d1aeee
MA
1385 (as POSIX requires) instead of being undefined.
1386
402b123d 1387** User Actions
52d1aeee
MA
1388 Bison has always permitted actions such as { $$ = $1 }: it adds the
1389 ending semicolon. Now if in Yacc compatibility mode, the semicolon
1390 is no longer output: one has to write { $$ = $1; }.
1391
402b123d 1392** Better C++ compliance
52d1aeee 1393 The output parsers try to respect C++ namespaces.
76551463 1394 [This turned out to be a failed experiment, and it was reverted later.]
52d1aeee 1395
402b123d 1396** Reduced Grammars
52d1aeee
MA
1397 Fixed bugs when reporting useless nonterminals.
1398
402b123d 1399** 64 bit hosts
52d1aeee
MA
1400 The parsers work properly on 64 bit hosts.
1401
402b123d 1402** Error messages
52d1aeee
MA
1403 Some calls to strerror resulted in scrambled or missing error messages.
1404
402b123d 1405** %expect
52d1aeee
MA
1406 When the number of shift/reduce conflicts is correct, don't issue
1407 any warning.
1408
402b123d 1409** The verbose report includes the rule line numbers.
52d1aeee 1410
402b123d 1411** Rule line numbers are fixed in traces.
52d1aeee 1412
402b123d 1413** Swedish translation
52d1aeee 1414
402b123d 1415** Parse errors
52d1aeee
MA
1416 Verbose parse error messages from the parsers are better looking.
1417 Before: parse error: unexpected `'/'', expecting `"number"' or `'-'' or `'(''
1418 Now: parse error: unexpected '/', expecting "number" or '-' or '('
1419
402b123d 1420** Fixed parser memory leaks.
52d1aeee
MA
1421 When the generated parser was using malloc to extend its stacks, the
1422 previous allocations were not freed.
1423
402b123d 1424** Fixed verbose output file.
52d1aeee
MA
1425 Some newlines were missing.
1426 Some conflicts in state descriptions were missing.
1427
402b123d 1428** Fixed conflict report.
52d1aeee
MA
1429 Option -v was needed to get the result.
1430
402b123d 1431** %expect
52d1aeee
MA
1432 Was not used.
1433 Mismatches are errors, not warnings.
1434
402b123d 1435** Fixed incorrect processing of some invalid input.
52d1aeee 1436
402b123d 1437** Fixed CPP guards: 9foo.h uses BISON_9FOO_H instead of 9FOO_H.
52d1aeee 1438
402b123d 1439** Fixed some typos in the documentation.
52d1aeee 1440
402b123d 1441** %token MY_EOF 0 is supported.
52d1aeee
MA
1442 Before, MY_EOF was silently renumbered as 257.
1443
402b123d 1444** doc/refcard.tex is updated.
52d1aeee 1445
402b123d 1446** %output, %file-prefix, %name-prefix.
52d1aeee
MA
1447 New.
1448
402b123d 1449** --output
52d1aeee
MA
1450 New, aliasing `--output-file'.
1451\f
402b123d 1452* Changes in version 1.30, 2001-10-26:
342b8b6e 1453
402b123d 1454** `--defines' and `--graph' have now an optional argument which is the
fdac0091 1455 output file name. `-d' and `-g' do not change; they do not take any
342b8b6e
AD
1456 argument.
1457
402b123d 1458** `%source_extension' and `%header_extension' are removed, failed
342b8b6e
AD
1459 experiment.
1460
402b123d 1461** Portability fixes.
f987e9d2 1462\f
402b123d 1463* Changes in version 1.29, 2001-09-07:
342b8b6e 1464
402b123d 1465** The output file does not define const, as this caused problems when used
342b8b6e
AD
1466 with common autoconfiguration schemes. If you still use ancient compilers
1467 that lack const, compile with the equivalent of the C compiler option
1468 `-Dconst='. autoconf's AC_C_CONST macro provides one way to do this.
1469
402b123d 1470** Added `-g' and `--graph'.
f87a2205 1471
402b123d 1472** The Bison manual is now distributed under the terms of the GNU FDL.
f2b5126e 1473
402b123d 1474** The input and the output files has automatically a similar extension.
234a3be3 1475
402b123d 1476** Russian translation added.
f87a2205 1477
402b123d 1478** NLS support updated; should hopefully be less troublesome.
f87a2205 1479
402b123d 1480** Added the old Bison reference card.
c33638bb 1481
402b123d 1482** Added `--locations' and `%locations'.
6deb4447 1483
402b123d 1484** Added `-S' and `--skeleton'.
cd5bd6ac 1485
402b123d 1486** `%raw', `-r', `--raw' is disabled.
62ab6972 1487
402b123d 1488** Special characters are escaped when output. This solves the problems
cd5bd6ac
AD
1489 of the #line lines with path names including backslashes.
1490
402b123d 1491** New directives.
4ecbf796
MA
1492 `%yacc', `%fixed_output_files', `%defines', `%no_parser', `%verbose',
1493 `%debug', `%source_extension' and `%header_extension'.
f987e9d2 1494
402b123d 1495** @$
f987e9d2 1496 Automatic location tracking.
f87a2205 1497\f
402b123d 1498* Changes in version 1.28, 1999-07-06:
d2e00347 1499
402b123d 1500** Should compile better now with K&R compilers.
d2e00347 1501
402b123d 1502** Added NLS.
d2e00347 1503
402b123d 1504** Fixed a problem with escaping the double quote character.
d2e00347 1505
402b123d 1506** There is now a FAQ.
d2e00347 1507\f
402b123d 1508* Changes in version 1.27:
5c31c3c2 1509
402b123d 1510** The make rule which prevented bison.simple from being created on
5c31c3c2
JT
1511 some systems has been fixed.
1512\f
402b123d 1513* Changes in version 1.26:
4be07551 1514
402b123d 1515** Bison now uses automake.
4be07551 1516
402b123d 1517** New mailing lists: <bug-bison@gnu.org> and <help-bison@gnu.org>.
4be07551 1518
402b123d 1519** Token numbers now start at 257 as previously documented, not 258.
4be07551 1520
402b123d 1521** Bison honors the TMPDIR environment variable.
4be07551 1522
402b123d 1523** A couple of buffer overruns have been fixed.
f51dbca1 1524
402b123d 1525** Problems when closing files should now be reported.
f51dbca1 1526
402b123d 1527** Generated parsers should now work even on operating systems which do
f51dbca1 1528 not provide alloca().
4be07551 1529\f
402b123d 1530* Changes in version 1.25, 1995-10-16:
df8878c5 1531
402b123d 1532** Errors in the input grammar are not fatal; Bison keeps reading
df8878c5 1533the grammar file, and reports all the errors found in it.
8c44d3ec 1534
402b123d 1535** Tokens can now be specified as multiple-character strings: for
df8878c5
RS
1536example, you could use "<=" for a token which looks like <=, instead
1537of chosing a name like LESSEQ.
1538
402b123d 1539** The %token_table declaration says to write a table of tokens (names
df8878c5
RS
1540and numbers) into the parser file. The yylex function can use this
1541table to recognize multiple-character string tokens, or for other
1542purposes.
1543
402b123d 1544** The %no_lines declaration says not to generate any #line preprocessor
df8878c5
RS
1545directives in the parser file.
1546
402b123d 1547** The %raw declaration says to use internal Bison token numbers, not
df8878c5
RS
1548Yacc-compatible token numbers, when token names are defined as macros.
1549
402b123d 1550** The --no-parser option produces the parser tables without including
df8878c5
RS
1551the parser engine; a project can now use its own parser engine.
1552The actions go into a separate file called NAME.act, in the form of
1553a switch statement body.
1554\f
402b123d 1555* Changes in version 1.23:
6780ca7a 1556
4d019228
DM
1557The user can define YYPARSE_PARAM as the name of an argument to be
1558passed into yyparse. The argument should have type void *. It should
1559actually point to an object. Grammar actions can access the variable
1560by casting it to the proper pointer type.
6780ca7a 1561
6780ca7a 1562Line numbers in output file corrected.
6780ca7a 1563\f
402b123d 1564* Changes in version 1.22:
6780ca7a
DM
1565
1566--help option added.
6780ca7a 1567\f
402b123d 1568* Changes in version 1.20:
6780ca7a
DM
1569
1570Output file does not redefine const for C++.
9f4503d6
AD
1571
1572Local Variables:
1573mode: outline
1574End:
76551463
AD
1575
1576-----
1577
575619af 1578Copyright (C) 1995-2011 Free Software Foundation, Inc.
76551463 1579
74553c98 1580This file is part of Bison, the GNU Parser Generator.
76551463 1581
f16b0819 1582This program is free software: you can redistribute it and/or modify
76551463 1583it under the terms of the GNU General Public License as published by
f16b0819
PE
1584the Free Software Foundation, either version 3 of the License, or
1585(at your option) any later version.
76551463 1586
f16b0819 1587This program is distributed in the hope that it will be useful,
76551463
AD
1588but WITHOUT ANY WARRANTY; without even the implied warranty of
1589MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1590GNU General Public License for more details.
1591
1592You should have received a copy of the GNU General Public License
f16b0819 1593along with this program. If not, see <http://www.gnu.org/licenses/>.