]> git.saurik.com Git - bison.git/blame - NEWS
maint: credit Wojciech Polak
[bison.git] / NEWS
CommitLineData
ed7658fe 1GNU Bison NEWS
3af4feb2 2
0a7b8559
AD
3* Noteworthy changes in release ?.? (????-??-??) [?]
4
5
c13bb348 6* Noteworthy changes in release 2.7 (2012-12-12) [stable]
09a1cd5e 7
edf9a06f
AD
8** Bug fixes
9
10 Warnings about uninitialized yylloc in yyparse have been fixed.
11
1127a75a
AD
12 Restored C90 compliance (yet no report was ever made).
13
d4fe9e88
AD
14** Diagnostics are improved
15
16*** Changes in the format of error messages
17
18 This used to be the format of many error reports:
19
20 input.y:2.7-12: %type redeclaration for exp
21 input.y:1.7-12: previous declaration
22
23 It is now:
24
25 input.y:2.7-12: error: %type redeclaration for exp
26 input.y:1.7-12: previous declaration
effd30c0 27
d4fe9e88 28*** New format for error reports: carets
effd30c0 29
d4fe9e88 30 Caret errors have been added to Bison:
7bada535 31
d4fe9e88
AD
32 input.y:2.7-12: error: %type redeclaration for exp
33 %type <sval> exp
34 ^^^^^^
35 input.y:1.7-12: previous declaration
36 %type <ival> exp
37 ^^^^^^
38
39 or
7bada535
TR
40
41 input.y:3.20-23: error: ambiguous reference: '$exp'
fb6040f0 42 exp: exp '+' exp { $exp = $1 + $3; };
7bada535 43 ^^^^
fb6040f0
TR
44 input.y:3.1-3: refers to: $exp at $$
45 exp: exp '+' exp { $exp = $1 + $3; };
46 ^^^
47 input.y:3.6-8: refers to: $exp at $1
48 exp: exp '+' exp { $exp = $1 + $3; };
49 ^^^
50 input.y:3.14-16: refers to: $exp at $3
51 exp: exp '+' exp { $exp = $1 + $3; };
52 ^^^
7bada535 53
d4fe9e88
AD
54 The default behaviour for now is still not to display these unless
55 explictly asked with -fcaret (or -fall). However, in a later release, it
56 will be made the default behavior (but may still be deactivated with
57 -fno-caret).
7bada535 58
1f1bd572
TR
59** New value for %define variable: api.pure full
60
61 The %define variable api.pure requests a pure (reentrant) parser. However,
d4fe9e88
AD
62 for historical reasons, using it in a location-tracking Yacc parser
63 resulted in a yyerror function that did not take a location as a
64 parameter. With this new value, the user may request a better pure parser,
65 where yyerror does take a location as a parameter (in location-tracking
66 parsers).
1f1bd572
TR
67
68 The use of "%define api.pure true" is deprecated in favor of this new
69 "%define api.pure full".
70
7287be84 71** New %define variable: api.location.type (glr.cc, lalr1.cc, lalr1.java)
db8ab2be
AD
72
73 The %define variable api.location.type defines the name of the type to use
74 for locations. When defined, Bison no longer generates the position.hh
75 and location.hh files, nor does the parser will include them: the user is
76 then responsible to define her type.
77
78 This can be used in programs with several parsers to factor their location
7287be84
AD
79 and position files: let one of them generate them, and the others just use
80 them.
db8ab2be
AD
81
82 This feature was actually introduced, but not documented, in Bison 2.5,
83 under the name "location_type" (which is maintained for backward
84 compatibility).
85
7287be84
AD
86 For consistency, lalr1.java's %define variables location_type and
87 position_type are deprecated in favor of api.location.type and
88 api.position.type.
89
d4fe9e88
AD
90** Exception safety (lalr1.cc)
91
92 The parse function now catches exceptions, uses the %destructors to
93 release memory (the lookahead symbol and the symbols pushed on the stack)
94 before re-throwing the exception.
95
96 This feature is somewhat experimental. User feedback would be
97 appreciated.
98
9c16d399 99** Graph improvements in DOT and XSLT
fc4fdd62
TR
100
101 The graphical presentation of the states is more readable: their shape is
102 now rectangular, the state number is clearly displayed, and the items are
103 numbered and left-justified.
104
105 The reductions are now explicitly represented as transitions to other
106 diamond shaped nodes.
107
9c16d399
TR
108 These changes are present in both --graph output and xml2dot.xsl XSLT
109 processing, with minor (documented) differences.
110
d4fe9e88
AD
111** %language is no longer an experimental feature.
112
113 The introduction of this feature, in 2.4, was four years ago. The
114 --language option and the %language directive are no longer experimental.
9c16d399 115
53e2cd1e
AD
116** Documentation
117
118 The sections about shift/reduce and reduce/reduce conflicts resolution
119 have been fixed and extended.
9d2423f5 120
d4fe9e88
AD
121 Although introduced more than four years ago, XML and Graphviz reports
122 were not properly documented.
123
be22823e
AD
124 The translation of mid-rule actions is now described.
125
9d3f7eaf 126* Noteworthy changes in release 2.6.5 (2012-11-07) [stable]
6f1360bd 127
a68b1f23
AD
128 We consider compiler warnings about Bison generated parsers to be bugs.
129 Rather than working around them in your own project, please consider
130 reporting them to us.
131
132** Bug fixes
133
134 Warnings about uninitialized yylval and/or yylloc for push parsers with a
135 pure interface have been fixed for GCC 4.0 up to 4.8, and Clang 2.9 to
136 3.2.
137
138 Other issues in the test suite have been addressed.
6f1360bd 139
95066e92
AD
140 Nul characters are correctly displayed in error messages.
141
a1d1ab50
AD
142 When possible, yylloc is correctly initialized before calling yylex. It
143 is no longer necessary to initialize it in the %initial-action.
144
0ac15849 145* Noteworthy changes in release 2.6.4 (2012-10-23) [stable]
a4eb820f 146
468455e1 147 Bison 2.6.3's --version was incorrect. This release fixes this issue.
a4eb820f 148
6eb8f74f 149* Noteworthy changes in release 2.6.3 (2012-10-22) [stable]
933ec544 150
6b4cb804
AD
151** Bug fixes
152
9a50c55a 153 Bugs and portability issues in the test suite have been fixed.
6b4cb804
AD
154
155 Some errors in translations have been addressed, and --help now directs
156 users to the appropriate place to report them.
157
158 Stray Info files shipped by accident are removed.
159
160 Incorrect definitions of YY_, issued by yacc.c when no parser header is
161 generated, are removed.
933ec544 162
90b1335a
TR
163 All the generated headers are self-contained.
164
6192d2c6
AD
165** Header guards (yacc.c, glr.c, glr.cc)
166
167 In order to avoid collisions, the header guards are now
168 YY_<PREFIX>_<FILE>_INCLUDED, instead of merely <PREFIX>_<FILE>.
169 For instance the header generated from
170
171 %define api.prefix "calc"
172 %defines "lib/parse.h"
173
174 will use YY_CALC_LIB_PARSE_H_INCLUDED as guard.
175
7b70847e 176** Fix compiler warnings in the generated parser (yacc.c, glr.c)
8f8439ce
AD
177
178 The compilation of pure parsers (%define api.pure) can trigger GCC
179 warnings such as:
180
181 input.c: In function 'yyparse':
182 input.c:1503:12: warning: 'yylval' may be used uninitialized in this
183 function [-Wmaybe-uninitialized]
184 *++yyvsp = yylval;
185 ^
186
187 This is now fixed; pragmas to avoid these warnings are no longer needed.
188
7b70847e
AD
189 Warnings from clang ("equality comparison with extraneous parentheses" and
190 "function declared 'noreturn' should not return") have also been
191 addressed.
192
e1eeecd3 193* Noteworthy changes in release 2.6.2 (2012-08-03) [stable]
9c26b8fc 194
43ca8040
AD
195** Bug fixes
196
197 Buffer overruns, complaints from Flex, and portability issues in the test
198 suite have been fixed.
199
c9d546b2
AD
200** Spaces in %lex- and %parse-param (lalr1.cc, glr.cc)
201
202 Trailing end-of-lines in %parse-param or %lex-param would result in
203 invalid C++. This is fixed.
9c26b8fc 204
dcd5344d
AD
205** Spurious spaces and end-of-lines
206
207 The generated files no longer end (nor start) with empty lines.
208
77b214ef 209* Noteworthy changes in release 2.6.1 (2012-07-30) [stable]
a4107f24 210
cbaea010 211 Bison no longer executes user-specified M4 code when processing a grammar.
8617d87e 212
e20e6a50
AD
213** Future Changes
214
215 In addition to the removal of the features announced in Bison 2.6, the
216 next major release will remove the "Temporary hack for adding a semicolon
217 to the user action", as announced in the release 2.5. Instead of:
218
219 exp: exp "+" exp { $$ = $1 + $3 };
220
221 write:
222
223 exp: exp "+" exp { $$ = $1 + $3; };
224
8617d87e
AD
225** Bug fixes
226
0e164d43
AD
227*** Type names are now properly escaped.
228
229*** glr.cc: set_debug_level and debug_level work as expected.
a4107f24 230
26313726
AD
231*** Stray @ or $ in actions
232
233 While Bison used to warn about stray $ or @ in action rules, it did not
234 for other actions such as printers, destructors, or initial actions. It
235 now does.
236
cd735a8c 237** Type names in actions
4982f078
AD
238
239 For consistency with rule actions, it is now possible to qualify $$ by a
cd735a8c 240 type-name in destructors, printers, and initial actions. For instance:
4982f078
AD
241
242 %printer { fprintf (yyo, "(%d, %f)", $<ival>$, $<fval>$); } <*> <>;
243
244 will display two values for each typed and untyped symbol (provided
cd735a8c 245 that YYSTYPE has both "ival" and "fval" fields).
4982f078 246
1505e8bb 247* Noteworthy changes in release 2.6 (2012-07-19) [stable]
ad6b775f 248
c2425191 249** Future Changes
0f11eec2 250
55d1006f
AD
251 The next major release of Bison will drop support for the following
252 deprecated features. Please report disagreements to bug-bison@gnu.org.
0f11eec2 253
aaf61036 254*** K&R C parsers
55d1006f
AD
255
256 Support for generating parsers in K&R C will be removed. Parsers
242cc08e 257 generated for C support ISO C90, and are tested with ISO C99 and ISO C11
55d1006f
AD
258 compilers.
259
258cddbc 260*** Features deprecated since Bison 1.875
55d1006f 261
258cddbc
AD
262 The definitions of yystype and yyltype will be removed; use YYSTYPE and
263 YYLTYPE.
55d1006f 264
258cddbc
AD
265 YYPARSE_PARAM and YYLEX_PARAM, deprecated in favor of %parse-param and
266 %lex-param, will no longer be supported.
267
268 Support for the preprocessor symbol YYERROR_VERBOSE will be removed, use
269 %error-verbose.
55d1006f
AD
270
271*** The generated header will be included (yacc.c)
0f11eec2
AD
272
273 Instead of duplicating the content of the generated header (definition of
55d1006f
AD
274 YYSTYPE, yyparse declaration etc.), the generated parser will include it,
275 as is already the case for GLR or C++ parsers. This change is deferred
276 because existing versions of ylwrap (e.g., Automake 1.12.1) do not support
277 it.
0f11eec2 278
c2425191 279** Generated Parser Headers
56ca3d8f 280
258cddbc 281*** Guards (yacc.c, glr.c, glr.cc)
c3e9f08f
AD
282
283 The generated headers are now guarded, as is already the case for C++
242cc08e 284 parsers (lalr1.cc). For instance, with --defines=foo.h:
c3e9f08f 285
e29f0771
AD
286 #ifndef YY_FOO_H
287 # define YY_FOO_H
288 ...
289 #endif /* !YY_FOO_H */
c3e9f08f 290
258cddbc 291*** New declarations (yacc.c, glr.c)
56ca3d8f
AD
292
293 The generated header now declares yydebug and yyparse. Both honor
294 --name-prefix=bar_, and yield
295
e29f0771 296 int bar_parse (void);
56ca3d8f
AD
297
298 rather than
299
e29f0771
AD
300 #define yyparse bar_parse
301 int yyparse (void);
56ca3d8f
AD
302
303 in order to facilitate the inclusion of several parser headers inside a
304 single compilation unit.
c3e9f08f 305
258cddbc
AD
306*** Exported symbols in C++
307
308 The symbols YYTOKEN_TABLE and YYERROR_VERBOSE, which were defined in the
309 header, are removed, as they prevent the possibility of including several
310 generated headers from a single compilation unit.
311
694af10c
AD
312*** YYLSP_NEEDED
313
314 For the same reasons, the undocumented and unused macro YYLSP_NEEDED is no
315 longer defined.
316
4b3847c3
AD
317** New %define variable: api.prefix
318
319 Now that the generated headers are more complete and properly protected
320 against multiple inclusions, constant names, such as YYSTYPE are a
321 problem. While yyparse and others are properly renamed by %name-prefix,
322 YYSTYPE, YYDEBUG and others have never been affected by it. Because it
323 would introduce backward compatibility issues in projects not expecting
324 YYSTYPE to be renamed, instead of changing the behavior of %name-prefix,
325 it is deprecated in favor of a new %define variable: api.prefix.
326
327 The following examples compares both:
328
329 %name-prefix "bar_" | %define api.prefix "bar_"
330 %token <ival> FOO %token <ival> FOO
331 %union { int ival; } %union { int ival; }
332 %% %%
333 exp: 'a'; exp: 'a';
334
335 bison generates:
336
337 #ifndef BAR_FOO_H #ifndef BAR_FOO_H
338 # define BAR_FOO_H # define BAR_FOO_H
339
340 /* Enabling traces. */ /* Enabling traces. */
5f108727
AD
341 # ifndef YYDEBUG | # ifndef BAR_DEBUG
342 > # if defined YYDEBUG
343 > # if YYDEBUG
344 > # define BAR_DEBUG 1
345 > # else
346 > # define BAR_DEBUG 0
347 > # endif
348 > # else
349 # define YYDEBUG 0 | # define BAR_DEBUG 0
350 > # endif
351 # endif | # endif
352
353 # if YYDEBUG | # if BAR_DEBUG
4b3847c3
AD
354 extern int bar_debug; extern int bar_debug;
355 # endif # endif
356
357 /* Tokens. */ /* Tokens. */
358 # ifndef YYTOKENTYPE | # ifndef BAR_TOKENTYPE
359 # define YYTOKENTYPE | # define BAR_TOKENTYPE
360 enum yytokentype { | enum bar_tokentype {
361 FOO = 258 FOO = 258
362 }; };
363 # endif # endif
364
365 #if ! defined YYSTYPE \ | #if ! defined BAR_STYPE \
366 && ! defined YYSTYPE_IS_DECLARED | && ! defined BAR_STYPE_IS_DECLARED
367 typedef union YYSTYPE | typedef union BAR_STYPE
368 { {
369 int ival; int ival;
370 } YYSTYPE; | } BAR_STYPE;
371 # define YYSTYPE_IS_DECLARED 1 | # define BAR_STYPE_IS_DECLARED 1
372 #endif #endif
373
374 extern YYSTYPE bar_lval; | extern BAR_STYPE bar_lval;
375
376 int bar_parse (void); int bar_parse (void);
377
378 #endif /* !BAR_FOO_H */ #endif /* !BAR_FOO_H */
379
dfaac272 380* Noteworthy changes in release 2.5.1 (2012-06-05) [stable]
90dcd415 381
debe2c03 382** Future changes:
041308d0 383
e4ab1254 384 The next major release will drop support for generating parsers in K&R C.
ef51bfa7 385
466b4cf2 386** yacc.c: YYBACKUP works as expected.
94556574 387
d834eca0
AD
388** glr.c improvements:
389
390*** Location support is eliminated when not requested:
391
e4ab1254
AD
392 GLR parsers used to include location-related code even when locations were
393 not requested, and therefore not even usable.
d834eca0
AD
394
395*** __attribute__ is preserved:
debe2c03 396
e4ab1254
AD
397 __attribute__ is no longer disabled when __STRICT_ANSI__ is defined (i.e.,
398 when -std is passed to GCC).
debe2c03 399
466b4cf2 400** lalr1.java: several fixes:
041308d0 401
e4ab1254
AD
402 The Java parser no longer throws ArrayIndexOutOfBoundsException if the
403 first token leads to a syntax error. Some minor clean ups.
041308d0 404
22172d47
AD
405** Changes for C++:
406
407*** C++11 compatibility:
ef51bfa7 408
e4ab1254
AD
409 C and C++ parsers use "nullptr" instead of "0" when __cplusplus is 201103L
410 or higher.
ef51bfa7 411
22172d47
AD
412*** Header guards
413
414 The header files such as "parser.hh", "location.hh", etc. used a constant
415 name for preprocessor guards, for instance:
416
e29f0771
AD
417 #ifndef BISON_LOCATION_HH
418 # define BISON_LOCATION_HH
419 ...
420 #endif // !BISON_LOCATION_HH
22172d47
AD
421
422 The inclusion guard is now computed from "PREFIX/FILE-NAME", where lower
423 case characters are converted to upper case, and series of
424 non-alphanumerical characters are converted to an underscore.
425
426 With "bison -o lang++/parser.cc", "location.hh" would now include:
427
e29f0771
AD
428 #ifndef YY_LANG_LOCATION_HH
429 # define YY_LANG_LOCATION_HH
430 ...
431 #endif // !YY_LANG_LOCATION_HH
22172d47
AD
432
433*** C++ locations:
936c88d1 434
e4ab1254
AD
435 The position and location constructors (and their initialize methods)
436 accept new arguments for line and column. Several issues in the
437 documentation were fixed.
936c88d1 438
466b4cf2
AD
439** liby is no longer asking for "rpl_fprintf" on some platforms.
440
7e508a2b
AD
441** Changes in the manual:
442
443*** %printer is documented
444
e4ab1254
AD
445 The "%printer" directive, supported since at least Bison 1.50, is finally
446 documented. The "mfcalc" example is extended to demonstrate it.
7e508a2b 447
e4ab1254
AD
448 For consistency with the C skeletons, the C++ parsers now also support
449 "yyoutput" (as an alias to "debug_stream ()").
7e508a2b
AD
450
451*** Several improvements have been made:
466b4cf2 452
e4ab1254
AD
453 The layout for grammar excerpts was changed to a more compact scheme.
454 Named references are motivated. The description of the automaton
455 description file (*.output) is updated to the current format. Incorrect
456 index entries were fixed. Some other errors were fixed.
466b4cf2 457
86b08b49
AD
458** Building bison:
459
460*** Conflicting prototypes with recent/modified Flex.
461
e4ab1254
AD
462 Fixed build problems with the current, unreleased, version of Flex, and
463 some modified versions of 2.5.35, which have modified function prototypes.
466b4cf2 464
8ef26c2a
AD
465*** Warnings during the build procedure have been eliminated.
466
467*** Several portability problems in the test suite have been fixed:
466b4cf2 468
e4ab1254
AD
469 This includes warnings with some compilers, unexpected behavior of tools
470 such as diff, warning messages from the test suite itself, etc.
466b4cf2 471
91aadcc7 472*** The install-pdf target works properly:
8ef26c2a 473
e4ab1254
AD
474 Running "make install-pdf" (or -dvi, -html, -info, and -ps) no longer
475 halts in the middle of its course.
8ef26c2a 476
b2bc8a1b 477* Changes in version 2.5 (2011-05-14):
006faedf 478
eb8c66bb
JD
479** Grammar symbol names can now contain non-initial dashes:
480
481 Consistently with directives (such as %error-verbose) and with
482 %define variables (e.g. push-pull), grammar symbol names may contain
483 dashes in any position except the beginning. This is a GNU
484 extension over POSIX Yacc. Thus, use of this extension is reported
485 by -Wyacc and rejected in Yacc mode (--yacc).
486
3b1977ea 487** Named references:
348f5608
AR
488
489 Historically, Yacc and Bison have supported positional references
490 ($n, $$) to allow access to symbol values from inside of semantic
491 actions code.
492
493 Starting from this version, Bison can also accept named references.
494 When no ambiguity is possible, original symbol names may be used
495 as named references:
496
ac3297d5 497 if_stmt : "if" cond_expr "then" then_stmt ';'
348f5608
AR
498 { $if_stmt = mk_if_stmt($cond_expr, $then_stmt); }
499
500 In the more common case, explicit names may be declared:
501
ac3297d5 502 stmt[res] : "if" expr[cond] "then" stmt[then] "else" stmt[else] ';'
348f5608
AR
503 { $res = mk_if_stmt($cond, $then, $else); }
504
f840c05a 505 Location information is also accessible using @name syntax. When
348f5608
AR
506 accessing symbol names containing dots or dashes, explicit bracketing
507 ($[sym.1]) must be used.
508
f840c05a 509 These features are experimental in this version. More user feedback
348f5608 510 will help to stabilize them.
2bd435c3 511 Contributed by Alex Rozenman.
348f5608 512
3b1977ea 513** IELR(1) and canonical LR(1):
34a6c2d1
JD
514
515 IELR(1) is a minimal LR(1) parser table generation algorithm. That
516 is, given any context-free grammar, IELR(1) generates parser tables
723206df 517 with the full language-recognition power of canonical LR(1) but with
3b1977ea
JD
518 nearly the same number of parser states as LALR(1). This reduction
519 in parser states is often an order of magnitude. More importantly,
34a6c2d1
JD
520 because canonical LR(1)'s extra parser states may contain duplicate
521 conflicts in the case of non-LR(1) grammars, the number of conflicts
522 for IELR(1) is often an order of magnitude less as well. This can
523 significantly reduce the complexity of developing of a grammar.
524
525 Bison can now generate IELR(1) and canonical LR(1) parser tables in
526 place of its traditional LALR(1) parser tables, which remain the
527 default. You can specify the type of parser tables in the grammar
528 file with these directives:
529
f37495f6
JD
530 %define lr.type lalr
531 %define lr.type ielr
532 %define lr.type canonical-lr
34a6c2d1 533
6f04ee6c 534 The default-reduction optimization in the parser tables can also be
e4ab1254
AD
535 adjusted using "%define lr.default-reductions". For details on both
536 of these features, see the new section "Tuning LR" in the Bison
6f04ee6c 537 manual.
34a6c2d1
JD
538
539 These features are experimental. More user feedback will help to
540 stabilize them.
541
6f04ee6c 542** LAC (Lookahead Correction) for syntax error handling:
4c38b19e
JD
543
544 Canonical LR, IELR, and LALR can suffer from a couple of problems
545 upon encountering a syntax error. First, the parser might perform
546 additional parser stack reductions before discovering the syntax
6f04ee6c 547 error. Such reductions can perform user semantic actions that are
4c38b19e
JD
548 unexpected because they are based on an invalid token, and they
549 cause error recovery to begin in a different syntactic context than
550 the one in which the invalid token was encountered. Second, when
6f04ee6c 551 verbose error messages are enabled (with %error-verbose or the
e4ab1254 552 obsolete "#define YYERROR_VERBOSE"), the expected token list in the
6f04ee6c
JD
553 syntax error message can both contain invalid tokens and omit valid
554 tokens.
4c38b19e
JD
555
556 The culprits for the above problems are %nonassoc, default
557 reductions in inconsistent states, and parser state merging. Thus,
558 IELR and LALR suffer the most. Canonical LR can suffer only if
559 %nonassoc is used or if default reductions are enabled for
560 inconsistent states.
561
6f04ee6c
JD
562 LAC is a new mechanism within the parsing algorithm that solves
563 these problems for canonical LR, IELR, and LALR without sacrificing
564 %nonassoc, default reductions, or state merging. When LAC is in
565 use, canonical LR and IELR behave almost exactly the same for both
566 syntactically acceptable and syntactically unacceptable input.
4c38b19e
JD
567 While LALR still does not support the full language-recognition
568 power of canonical LR and IELR, LAC at least enables LALR's syntax
569 error handling to correctly reflect LALR's language-recognition
570 power.
571
572 Currently, LAC is only supported for deterministic parsers in C.
573 You can enable LAC with the following directive:
574
575 %define parse.lac full
576
e4ab1254 577 See the new section "LAC" in the Bison manual for additional
6f04ee6c 578 details including a few caveats.
4c38b19e
JD
579
580 LAC is an experimental feature. More user feedback will help to
581 stabilize it.
582
6ee881f6 583** %define improvements:
f37495f6 584
3b1977ea 585*** Can now be invoked via the command line:
4ecd3681 586
34d41938 587 Each of these command-line options
4ecd3681 588
34d41938
JD
589 -D NAME[=VALUE]
590 --define=NAME[=VALUE]
591
592 -F NAME[=VALUE]
593 --force-define=NAME[=VALUE]
4ecd3681
JD
594
595 is equivalent to this grammar file declaration
596
34d41938 597 %define NAME ["VALUE"]
4ecd3681 598
34d41938
JD
599 except that the manner in which Bison processes multiple definitions
600 for the same NAME differs. Most importantly, -F and --force-define
601 quietly override %define, but -D and --define do not. For further
e4ab1254 602 details, see the section "Bison Options" in the Bison manual.
4ecd3681 603
3b1977ea 604*** Variables renamed:
812775a0
JD
605
606 The following %define variables
607
608 api.push_pull
609 lr.keep_unreachable_states
610
611 have been renamed to
612
613 api.push-pull
614 lr.keep-unreachable-states
615
616 The old names are now deprecated but will be maintained indefinitely
617 for backward compatibility.
618
723206df 619*** Values no longer need to be quoted in the grammar file:
f37495f6
JD
620
621 If a %define value is an identifier, it no longer needs to be placed
622 within quotations marks. For example,
623
624 %define api.push-pull "push"
625
626 can be rewritten as
627
628 %define api.push-pull push
629
6ee881f6 630*** Unrecognized variables are now errors not warnings.
c046698e 631
6ee881f6
JD
632*** Multiple invocations for any variable is now an error not a warning.
633
634** Unrecognized %code qualifiers are now errors not warnings.
635
636** Character literals not of length one:
637
638 Previously, Bison quietly converted all character literals to length
639 one. For example, without warning, Bison interpreted the operators in
640 the following grammar to be the same token:
641
642 exp: exp '++'
643 | exp '+' exp
644 ;
645
646 Bison now warns when a character literal is not of length one. In
647 some future release, Bison will start reporting an error instead.
648
649** Destructor calls fixed for lookaheads altered in semantic actions:
650
651 Previously for deterministic parsers in C, if a user semantic action
652 altered yychar, the parser in some cases used the old yychar value to
653 determine which destructor to call for the lookahead upon a syntax
654 error or upon parser return. This bug has been fixed.
655
656** C++ parsers use YYRHSLOC:
657
658 Similarly to the C parsers, the C++ parsers now define the YYRHSLOC
659 macro and use it in the default YYLLOC_DEFAULT. You are encouraged
e4ab1254
AD
660 to use it. If, for instance, your location structure has "first"
661 and "last" members, instead of
6ee881f6 662
e29f0771
AD
663 # define YYLLOC_DEFAULT(Current, Rhs, N) \
664 do \
665 if (N) \
666 { \
667 (Current).first = (Rhs)[1].location.first; \
668 (Current).last = (Rhs)[N].location.last; \
669 } \
670 else \
671 { \
672 (Current).first = (Current).last = (Rhs)[0].location.last; \
673 } \
674 while (false)
6ee881f6
JD
675
676 use:
677
e29f0771
AD
678 # define YYLLOC_DEFAULT(Current, Rhs, N) \
679 do \
680 if (N) \
681 { \
682 (Current).first = YYRHSLOC (Rhs, 1).first; \
683 (Current).last = YYRHSLOC (Rhs, N).last; \
684 } \
685 else \
686 { \
687 (Current).first = (Current).last = YYRHSLOC (Rhs, 0).last; \
688 } \
689 while (false)
6ee881f6
JD
690
691** YYLLOC_DEFAULT in C++:
692
693 The default implementation of YYLLOC_DEFAULT used to be issued in
694 the header file. It is now output in the implementation file, after
695 the user %code sections so that its #ifndef guard does not try to
696 override the user's YYLLOC_DEFAULT if provided.
c046698e 697
3b1977ea 698** YYFAIL now produces warnings and Java parsers no longer implement it:
62efdd2a
JD
699
700 YYFAIL has existed for many years as an undocumented feature of
701 deterministic parsers in C generated by Bison. More recently, it was
702 a documented feature of Bison's experimental Java parsers. As
703 promised in Bison 2.4.2's NEWS entry, any appearance of YYFAIL in a
704 semantic action now produces a deprecation warning, and Java parsers
705 no longer implement YYFAIL at all. For further details, including a
706 discussion of how to suppress C preprocessor warnings about YYFAIL
707 being unused, see the Bison 2.4.2 NEWS entry.
708
3b1977ea 709** Temporary hack for adding a semicolon to the user action:
a2d05674
JD
710
711 Previously, Bison appended a semicolon to every user action for
712 reductions when the output language defaulted to C (specifically, when
713 neither %yacc, %language, %skeleton, or equivalent command-line
714 options were specified). This allowed actions such as
715
716 exp: exp "+" exp { $$ = $1 + $3 };
717
718 instead of
719
720 exp: exp "+" exp { $$ = $1 + $3; };
721
722 As a first step in removing this misfeature, Bison now issues a
723 warning when it appends a semicolon. Moreover, in cases where Bison
724 cannot easily determine whether a semicolon is needed (for example, an
725 action ending with a cpp directive or a braced compound initializer),
726 it no longer appends one. Thus, the C compiler might now complain
727 about a missing semicolon where it did not before. Future releases of
728 Bison will cease to append semicolons entirely.
729
095a1d11
JD
730** Verbose syntax error message fixes:
731
e4ab1254 732 When %error-verbose or the obsolete "#define YYERROR_VERBOSE" is
6f04ee6c
JD
733 specified, syntax error messages produced by the generated parser
734 include the unexpected token as well as a list of expected tokens.
735 The effect of %nonassoc on these verbose messages has been corrected
736 in two ways, but a more complete fix requires LAC, described above:
095a1d11
JD
737
738*** When %nonassoc is used, there can exist parser states that accept no
739 tokens, and so the parser does not always require a lookahead token
740 in order to detect a syntax error. Because no unexpected token or
741 expected tokens can then be reported, the verbose syntax error
742 message described above is suppressed, and the parser instead
e4ab1254 743 reports the simpler message, "syntax error". Previously, this
095a1d11
JD
744 suppression was sometimes erroneously triggered by %nonassoc when a
745 lookahead was actually required. Now verbose messages are
746 suppressed only when all previous lookaheads have already been
747 shifted or discarded.
748
749*** Previously, the list of expected tokens erroneously included tokens
750 that would actually induce a syntax error because conflicts for them
751 were resolved with %nonassoc in the current parser state. Such
752 tokens are now properly omitted from the list.
753
754*** Expected token lists are still often wrong due to state merging
4c38b19e
JD
755 (from LALR or IELR) and default reductions, which can both add
756 invalid tokens and subtract valid tokens. Canonical LR almost
757 completely fixes this problem by eliminating state merging and
758 default reductions. However, there is one minor problem left even
759 when using canonical LR and even after the fixes above. That is,
760 if the resolution of a conflict with %nonassoc appears in a later
761 parser state than the one at which some syntax error is
762 discovered, the conflicted token is still erroneously included in
763 the expected token list. Bison's new LAC implementation,
764 described above, eliminates this problem and the need for
765 canonical LR. However, LAC is still experimental and is disabled
766 by default.
1fa30307 767
4c2a6e42
JD
768** Java skeleton fixes:
769
770*** A location handling bug has been fixed.
771
772*** The top element of each of the value stack and location stack is now
773 cleared when popped so that it can be garbage collected.
77768165 774
f0e2c228
JD
775*** Parser traces now print the top element of the stack.
776
248dba53
JD
777** -W/--warnings fixes:
778
e4ab1254 779*** Bison now properly recognizes the "no-" versions of categories:
248dba53
JD
780
781 For example, given the following command line, Bison now enables all
782 warnings except warnings for incompatibilities with POSIX Yacc:
783
784 bison -Wall,no-yacc gram.y
785
6f8bdce2
JD
786*** Bison now treats S/R and R/R conflicts like other warnings:
787
788 Previously, conflict reports were independent of Bison's normal
789 warning system. Now, Bison recognizes the warning categories
e4ab1254 790 "conflicts-sr" and "conflicts-rr". This change has important
6f8bdce2
JD
791 consequences for the -W and --warnings command-line options. For
792 example:
793
794 bison -Wno-conflicts-sr gram.y # S/R conflicts not reported
795 bison -Wno-conflicts-rr gram.y # R/R conflicts not reported
796 bison -Wnone gram.y # no conflicts are reported
797 bison -Werror gram.y # any conflict is an error
798
799 However, as before, if the %expect or %expect-rr directive is
800 specified, an unexpected number of conflicts is an error, and an
801 expected number of conflicts is not reported, so -W and --warning
802 then have no effect on the conflict report.
803
e4ab1254 804*** The "none" category no longer disables a preceding "error":
dab96632
JD
805
806 For example, for the following command line, Bison now reports
807 errors instead of warnings for incompatibilities with POSIX Yacc:
808
809 bison -Werror,none,yacc gram.y
810
e4ab1254 811*** The "none" category now disables all Bison warnings:
8ffd7912 812
e4ab1254 813 Previously, the "none" category disabled only Bison warnings for
8ffd7912
JD
814 which there existed a specific -W/--warning category. However,
815 given the following command line, Bison is now guaranteed to
816 suppress all warnings:
817
818 bison -Wnone gram.y
819
9d6af153
JD
820** Precedence directives can now assign token number 0:
821
822 Since Bison 2.3b, which restored the ability of precedence
823 directives to assign token numbers, doing so for token number 0 has
824 produced an assertion failure. For example:
825
826 %left END 0
827
828 This bug has been fixed.
829
7527c744 830* Changes in version 2.4.3 (2010-08-05):
7a9c3cb3 831
4631c34f
JD
832** Bison now obeys -Werror and --warnings=error for warnings about
833 grammar rules that are useless in the parser due to conflicts.
834
7a9c3cb3
JD
835** Problems with spawning M4 on at least FreeBSD 8 and FreeBSD 9 have
836 been fixed.
837
132247cd
JD
838** Failures in the test suite for GCC 4.5 have been fixed.
839
88bb35d6
JD
840** Failures in the test suite for some versions of Sun Studio C++ have
841 been fixed.
842
43fdc9fd
JD
843** Contrary to Bison 2.4.2's NEWS entry, it has been decided that
844 warnings about undefined %prec identifiers will not be converted to
845 errors in Bison 2.5. They will remain warnings, which should be
846 sufficient for POSIX while avoiding backward compatibility issues.
847
cf22447c
JD
848** Minor documentation fixes.
849
ea66d039 850* Changes in version 2.4.2 (2010-03-20):
8defe11b 851
47fa5747
JD
852** Some portability problems that resulted in failures and livelocks
853 in the test suite on some versions of at least Solaris, AIX, HP-UX,
ea66d039
JD
854 RHEL4, and Tru64 have been addressed. As a result, fatal Bison
855 errors should no longer cause M4 to report a broken pipe on the
47fa5747
JD
856 affected platforms.
857
e4ab1254 858** "%prec IDENTIFIER" requires IDENTIFIER to be defined separately.
2c203528
JD
859
860 POSIX specifies that an error be reported for any identifier that does
861 not appear on the LHS of a grammar rule and that is not defined by
862 %token, %left, %right, or %nonassoc. Bison 2.3b and later lost this
863 error report for the case when an identifier appears only after a
864 %prec directive. It is now restored. However, for backward
865 compatibility with recent Bison releases, it is only a warning for
866 now. In Bison 2.5 and later, it will return to being an error.
43fdc9fd
JD
867 [Between the 2.4.2 and 2.4.3 releases, it was decided that this
868 warning will not be converted to an error in Bison 2.5.]
2c203528 869
c5196098
EB
870** Detection of GNU M4 1.4.6 or newer during configure is improved.
871
34731471
JD
872** Warnings from gcc's -Wundef option about undefined YYENABLE_NLS,
873 YYLTYPE_IS_TRIVIAL, and __STRICT_ANSI__ in C/C++ parsers are now
874 avoided.
af2ffe5c 875
966aba65
JD
876** %code is now a permanent feature.
877
878 A traditional Yacc prologue directive is written in the form:
879
880 %{CODE%}
881
882 To provide a more flexible alternative, Bison 2.3b introduced the
883 %code directive with the following forms for C/C++:
884
885 %code {CODE}
886 %code requires {CODE}
887 %code provides {CODE}
888 %code top {CODE}
889
890 These forms are now considered permanent features of Bison. See the
891 %code entries in the section "Bison Declaration Summary" in the Bison
892 manual for a summary of their functionality. See the section
893 "Prologue Alternatives" for a detailed discussion including the
894 advantages of %code over the traditional Yacc prologue directive.
895
896 Bison's Java feature as a whole including its current usage of %code
897 is still considered experimental.
898
41d35e54
JD
899** YYFAIL is deprecated and will eventually be removed.
900
901 YYFAIL has existed for many years as an undocumented feature of
902 deterministic parsers in C generated by Bison. Previously, it was
903 documented for Bison's experimental Java parsers. YYFAIL is no longer
904 documented for Java parsers and is formally deprecated in both cases.
905 Users are strongly encouraged to migrate to YYERROR, which is
906 specified by POSIX.
907
908 Like YYERROR, you can invoke YYFAIL from a semantic action in order to
909 induce a syntax error. The most obvious difference from YYERROR is
910 that YYFAIL will automatically invoke yyerror to report the syntax
911 error so that you don't have to. However, there are several other
912 subtle differences between YYERROR and YYFAIL, and YYFAIL suffers from
e4ab1254 913 inherent flaws when %error-verbose or "#define YYERROR_VERBOSE" is
41d35e54
JD
914 used. For a more detailed discussion, see:
915
916 http://lists.gnu.org/archive/html/bison-patches/2009-12/msg00024.html
917
918 The upcoming Bison 2.5 will remove YYFAIL from Java parsers, but
919 deterministic parsers in C will continue to implement it. However,
920 because YYFAIL is already flawed, it seems futile to try to make new
921 Bison features compatible with it. Thus, during parser generation,
922 Bison 2.5 will produce a warning whenever it discovers YYFAIL in a
923 rule action. In a later release, YYFAIL will be disabled for
e4ab1254 924 %error-verbose and "#define YYERROR_VERBOSE". Eventually, YYFAIL will
41d35e54
JD
925 be removed altogether.
926
927 There exists at least one case where Bison 2.5's YYFAIL warning will
928 be a false positive. Some projects add phony uses of YYFAIL and other
929 Bison-defined macros for the sole purpose of suppressing C
930 preprocessor warnings (from GCC cpp's -Wunused-macros, for example).
931 To avoid Bison's future warning, such YYFAIL uses can be moved to the
e4ab1254 932 epilogue (that is, after the second "%%") in the Bison input file. In
41d35e54
JD
933 this release (2.4.2), Bison already generates its own code to suppress
934 C preprocessor warnings for YYFAIL, so projects can remove their own
935 phony uses of YYFAIL if compatibility with Bison releases prior to
936 2.4.2 is not necessary.
937
dac8cc0d
AD
938** Internationalization.
939
940 Fix a regression introduced in Bison 2.4: Under some circumstances,
941 message translations were not installed although supported by the
942 host system.
943
41930e7a 944* Changes in version 2.4.1 (2008-12-11):
c9ba9e59 945
a957d06c
JD
946** In the GLR defines file, unexpanded M4 macros in the yylval and yylloc
947 declarations have been fixed.
948
738cde3e
AD
949** Temporary hack for adding a semicolon to the user action.
950
951 Bison used to prepend a trailing semicolon at the end of the user
952 action for reductions. This allowed actions such as
953
954 exp: exp "+" exp { $$ = $1 + $3 };
955
956 instead of
957
958 exp: exp "+" exp { $$ = $1 + $3; };
959
e4ab1254 960 Some grammars still depend on this "feature". Bison 2.4.1 restores
d07932ef
JD
961 the previous behavior in the case of C output (specifically, when
962 neither %language or %skeleton or equivalent command-line options
963 are used) to leave more time for grammars depending on the old
964 behavior to be adjusted. Future releases of Bison will disable this
965 feature.
a957d06c
JD
966
967** A few minor improvements to the Bison manual.
c9ba9e59 968
d6fb461d 969* Changes in version 2.4 (2008-11-02):
7bd1665a 970
d6fb461d 971** %language is an experimental feature.
ed4d67dc
JD
972
973 We first introduced this feature in test release 2.3b as a cleaner
974 alternative to %skeleton. Since then, we have discussed the possibility of
975 modifying its effect on Bison's output file names. Thus, in this release,
976 we consider %language to be an experimental feature that will likely evolve
977 in future releases.
7bd1665a 978
d6fb461d 979** Forward compatibility with GNU M4 has been improved.
241fda7a 980
d6fb461d 981** Several bugs in the C++ skeleton and the experimental Java skeleton have been
241fda7a
JD
982 fixed.
983
d6fb461d 984* Changes in version 2.3b (2008-05-27):
35fe0834 985
d6fb461d 986** The quotes around NAME that used to be required in the following directive
d9df47b6
JD
987 are now deprecated:
988
989 %define NAME "VALUE"
990
e4ab1254 991** The directive "%pure-parser" is now deprecated in favor of:
d9df47b6
JD
992
993 %define api.pure
994
995 which has the same effect except that Bison is more careful to warn about
996 unreasonable usage in the latter case.
997
d6fb461d 998** Push Parsing
c373bf8b
JD
999
1000 Bison can now generate an LALR(1) parser in C with a push interface. That
e4ab1254
AD
1001 is, instead of invoking "yyparse", which pulls tokens from "yylex", you can
1002 push one token at a time to the parser using "yypush_parse", which will
c373bf8b
JD
1003 return to the caller after processing each token. By default, the push
1004 interface is disabled. Either of the following directives will enable it:
1005
1006 %define api.push_pull "push" // Just push; does not require yylex.
1007 %define api.push_pull "both" // Push and pull; requires yylex.
1008
e4ab1254 1009 See the new section "A Push Parser" in the Bison manual for details.
c373bf8b 1010
59da312b
JD
1011 The current push parsing interface is experimental and may evolve. More user
1012 feedback will help to stabilize it.
1013
d6fb461d 1014** The -g and --graph options now output graphs in Graphviz DOT format,
8e55b3aa
JD
1015 not VCG format. Like --graph, -g now also takes an optional FILE argument
1016 and thus cannot be bundled with other short options.
c373bf8b 1017
d6fb461d 1018** Java
59da312b
JD
1019
1020 Bison can now generate an LALR(1) parser in Java. The skeleton is
e4ab1254 1021 "data/lalr1.java". Consider using the new %language directive instead of
59da312b
JD
1022 %skeleton to select it.
1023
e4ab1254 1024 See the new section "Java Parsers" in the Bison manual for details.
59da312b
JD
1025
1026 The current Java interface is experimental and may evolve. More user
1027 feedback will help to stabilize it.
2bd435c3 1028 Contributed by Paolo Bonzini.
59da312b 1029
d6fb461d 1030** %language
59da312b
JD
1031
1032 This new directive specifies the programming language of the generated
d43f77e7
PB
1033 parser, which can be C (the default), C++, or Java. Besides the skeleton
1034 that Bison uses, the directive affects the names of the generated files if
1035 the grammar file's name ends in ".y".
59da312b 1036
d6fb461d 1037** XML Automaton Report
59da312b
JD
1038
1039 Bison can now generate an XML report of the LALR(1) automaton using the new
e4ab1254 1040 "--xml" option. The current XML schema is experimental and may evolve. More
59da312b 1041 user feedback will help to stabilize it.
2bd435c3 1042 Contributed by Wojciech Polak.
c373bf8b 1043
d6fb461d 1044** The grammar file may now specify the name of the parser header file using
c373bf8b
JD
1045 %defines. For example:
1046
1047 %defines "parser.h"
1048
d6fb461d 1049** When reporting useless rules, useless nonterminals, and unused terminals,
d80fb37a
JD
1050 Bison now employs the terms "useless in grammar" instead of "useless",
1051 "useless in parser" instead of "never reduced", and "unused in grammar"
1052 instead of "unused".
cff03fb2 1053
d6fb461d 1054** Unreachable State Removal
c373bf8b
JD
1055
1056 Previously, Bison sometimes generated parser tables containing unreachable
31984206
JD
1057 states. A state can become unreachable during conflict resolution if Bison
1058 disables a shift action leading to it from a predecessor state. Bison now:
75ad86ee
JD
1059
1060 1. Removes unreachable states.
1061
1062 2. Does not report any conflicts that appeared in unreachable states.
1063 WARNING: As a result, you may need to update %expect and %expect-rr
1064 directives in existing grammar files.
1065
1066 3. For any rule used only in such states, Bison now reports the rule as
cff03fb2 1067 "useless in parser due to conflicts".
75ad86ee 1068
31984206
JD
1069 This feature can be disabled with the following directive:
1070
1071 %define lr.keep_unreachable_states
1072
e4ab1254 1073 See the %define entry in the "Bison Declaration Summary" in the Bison manual
31984206
JD
1074 for further discussion.
1075
e4ab1254 1076** Lookahead Set Correction in the ".output" Report
b1cc23c4 1077
e4ab1254
AD
1078 When instructed to generate a ".output" file including lookahead sets
1079 (using "--report=lookahead", for example), Bison now prints each reduction's
88c78747
JD
1080 lookahead set only next to the associated state's one item that (1) is
1081 associated with the same rule as the reduction and (2) has its dot at the end
1082 of its RHS. Previously, Bison also erroneously printed the lookahead set
1083 next to all of the state's other items associated with the same rule. This
e4ab1254 1084 bug affected only the ".output" file and not the generated parser source
88c78747
JD
1085 code.
1086
e4ab1254 1087** --report-file=FILE is a new option to override the default ".output" file
59da312b 1088 name.
1bb2bd75 1089
e4ab1254 1090** The "=" that used to be required in the following directives is now
02975b9a
JD
1091 deprecated:
1092
1093 %file-prefix "parser"
1094 %name-prefix "c_"
1095 %output "parser.c"
1096
e4ab1254 1097** An Alternative to "%{...%}" -- "%code QUALIFIER {CODE}"
c373bf8b
JD
1098
1099 Bison 2.3a provided a new set of directives as a more flexible alternative to
8e0a5e9e
JD
1100 the traditional Yacc prologue blocks. Those have now been consolidated into
1101 a single %code directive with an optional qualifier field, which identifies
1102 the purpose of the code and thus the location(s) where Bison should generate
1103 it:
1104
e4ab1254
AD
1105 1. "%code {CODE}" replaces "%after-header {CODE}"
1106 2. "%code requires {CODE}" replaces "%start-header {CODE}"
1107 3. "%code provides {CODE}" replaces "%end-header {CODE}"
1108 4. "%code top {CODE}" replaces "%before-header {CODE}"
8e0a5e9e 1109
e4ab1254
AD
1110 See the %code entries in section "Bison Declaration Summary" in the Bison
1111 manual for a summary of the new functionality. See the new section "Prologue
1112 Alternatives" for a detailed discussion including the advantages of %code
8e0a5e9e
JD
1113 over the traditional Yacc prologues.
1114
1115 The prologue alternatives are experimental. More user feedback will help to
1116 determine whether they should become permanent features.
1117
d6fb461d 1118** Revised warning: unset or unused mid-rule values
17bd8a73
JD
1119
1120 Since Bison 2.2, Bison has warned about mid-rule values that are set but not
1121 used within any of the actions of the parent rule. For example, Bison warns
1122 about unused $2 in:
1123
1124 exp: '1' { $$ = 1; } '+' exp { $$ = $1 + $4; };
1125
1126 Now, Bison also warns about mid-rule values that are used but not set. For
1127 example, Bison warns about unset $$ in the mid-rule action in:
1128
1129 exp: '1' { $1 = 1; } '+' exp { $$ = $2 + $4; };
1130
1131 However, Bison now disables both of these warnings by default since they
1132 sometimes prove to be false alarms in existing grammars employing the Yacc
1133 constructs $0 or $-N (where N is some positive integer).
1134
e4ab1254
AD
1135 To enable these warnings, specify the option "--warnings=midrule-values" or
1136 "-W", which is a synonym for "--warnings=all".
17bd8a73 1137
e4ab1254 1138** Default %destructor or %printer with "<*>" or "<>"
c373bf8b
JD
1139
1140 Bison now recognizes two separate kinds of default %destructor's and
12e35840
JD
1141 %printer's:
1142
e4ab1254 1143 1. Place "<*>" in a %destructor/%printer symbol list to define a default
12e35840
JD
1144 %destructor/%printer for all grammar symbols for which you have formally
1145 declared semantic type tags.
1146
e4ab1254 1147 2. Place "<>" in a %destructor/%printer symbol list to define a default
12e35840
JD
1148 %destructor/%printer for all grammar symbols without declared semantic
1149 type tags.
1150
e4ab1254
AD
1151 Bison no longer supports the "%symbol-default" notation from Bison 2.3a.
1152 "<*>" and "<>" combined achieve the same effect with one exception: Bison no
12e35840
JD
1153 longer applies any %destructor to a mid-rule value if that mid-rule value is
1154 not actually ever referenced using either $$ or $n in a semantic action.
1155
85894313
JD
1156 The default %destructor's and %printer's are experimental. More user
1157 feedback will help to determine whether they should become permanent
1158 features.
1159
e4ab1254 1160 See the section "Freeing Discarded Symbols" in the Bison manual for further
12e35840
JD
1161 details.
1162
d6fb461d 1163** %left, %right, and %nonassoc can now declare token numbers. This is required
e4ab1254 1164 by POSIX. However, see the end of section "Operator Precedence" in the Bison
ab7f29f8
JD
1165 manual for a caveat concerning the treatment of literal strings.
1166
d6fb461d 1167** The nonfunctional --no-parser, -n, and %no-parser options have been
b1cc23c4
JD
1168 completely removed from Bison.
1169
d6fb461d 1170* Changes in version 2.3a, 2006-09-13:
742e4900 1171
d6fb461d 1172** Instead of %union, you can define and use your own union type
ddc8ede1
PE
1173 YYSTYPE if your grammar contains at least one <type> tag.
1174 Your YYSTYPE need not be a macro; it can be a typedef.
1175 This change is for compatibility with other Yacc implementations,
1176 and is required by POSIX.
1177
d6fb461d 1178** Locations columns and lines start at 1.
cd48d21d
AD
1179 In accordance with the GNU Coding Standards and Emacs.
1180
d6fb461d 1181** You may now declare per-type and default %destructor's and %printer's:
ec5479ce
JD
1182
1183 For example:
1184
b2a0b7ca
JD
1185 %union { char *string; }
1186 %token <string> STRING1
1187 %token <string> STRING2
1188 %type <string> string1
1189 %type <string> string2
1190 %union { char character; }
1191 %token <character> CHR
1192 %type <character> chr
1193 %destructor { free ($$); } %symbol-default
1194 %destructor { free ($$); printf ("%d", @$.first_line); } STRING1 string1
1195 %destructor { } <character>
1196
1197 guarantees that, when the parser discards any user-defined symbol that has a
e4ab1254
AD
1198 semantic type tag other than "<character>", it passes its semantic value to
1199 "free". However, when the parser discards a "STRING1" or a "string1", it
1200 also prints its line number to "stdout". It performs only the second
1201 "%destructor" in this case, so it invokes "free" only once.
ec5479ce 1202
85894313
JD
1203 [Although we failed to mention this here in the 2.3a release, the default
1204 %destructor's and %printer's were experimental, and they were rewritten in
1205 future versions.]
1206
e4ab1254
AD
1207** Except for LALR(1) parsers in C with POSIX Yacc emulation enabled (with "-y",
1208 "--yacc", or "%yacc"), Bison no longer generates #define statements for
b931235e
JD
1209 associating token numbers with token names. Removing the #define statements
1210 helps to sanitize the global namespace during preprocessing, but POSIX Yacc
1211 requires them. Bison still generates an enum for token names in all cases.
1212
d6fb461d 1213** Handling of traditional Yacc prologue blocks is now more consistent but
34f98f46 1214 potentially incompatible with previous releases of Bison.
9bc0dd67
JD
1215
1216 As before, you declare prologue blocks in your grammar file with the
e4ab1254 1217 "%{ ... %}" syntax. To generate the pre-prologue, Bison concatenates all
34f98f46
JD
1218 prologue blocks that you've declared before the first %union. To generate
1219 the post-prologue, Bison concatenates all prologue blocks that you've
ddc8ede1 1220 declared after the first %union.
9bc0dd67 1221
34f98f46 1222 Previous releases of Bison inserted the pre-prologue into both the header
9bc0dd67
JD
1223 file and the code file in all cases except for LALR(1) parsers in C. In the
1224 latter case, Bison inserted it only into the code file. For parsers in C++,
1225 the point of insertion was before any token definitions (which associate
1226 token numbers with names). For parsers in C, the point of insertion was
1227 after the token definitions.
1228
1229 Now, Bison never inserts the pre-prologue into the header file. In the code
1230 file, it always inserts it before the token definitions.
1231
d6fb461d 1232** Bison now provides a more flexible alternative to the traditional Yacc
34f98f46
JD
1233 prologue blocks: %before-header, %start-header, %end-header, and
1234 %after-header.
1235
1236 For example, the following declaration order in the grammar file reflects the
1237 order in which Bison will output these code blocks. However, you are free to
1238 declare these code blocks in your grammar file in whatever order is most
1239 convenient for you:
1240
1241 %before-header {
1242 /* Bison treats this block like a pre-prologue block: it inserts it into
1243 * the code file before the contents of the header file. It does *not*
1244 * insert it into the header file. This is a good place to put
1245 * #include's that you want at the top of your code file. A common
e4ab1254 1246 * example is '#include "system.h"'. */
34f98f46
JD
1247 }
1248 %start-header {
1249 /* Bison inserts this block into both the header file and the code file.
1250 * In both files, the point of insertion is before any Bison-generated
1251 * token, semantic type, location type, and class definitions. This is a
1252 * good place to define %union dependencies, for example. */
9bc0dd67
JD
1253 }
1254 %union {
34f98f46
JD
1255 /* Unlike the traditional Yacc prologue blocks, the output order for the
1256 * new %*-header blocks is not affected by their declaration position
1257 * relative to any %union in the grammar file. */
9bc0dd67 1258 }
34f98f46
JD
1259 %end-header {
1260 /* Bison inserts this block into both the header file and the code file.
1261 * In both files, the point of insertion is after the Bison-generated
1262 * definitions. This is a good place to declare or define public
1263 * functions or data structures that depend on the Bison-generated
1264 * definitions. */
9bc0dd67 1265 }
34f98f46
JD
1266 %after-header {
1267 /* Bison treats this block like a post-prologue block: it inserts it into
1268 * the code file after the contents of the header file. It does *not*
1269 * insert it into the header file. This is a good place to declare or
1270 * define internal functions or data structures that depend on the
1271 * Bison-generated definitions. */
1272 }
1273
1274 If you have multiple occurrences of any one of the above declarations, Bison
1275 will concatenate the contents in declaration order.
9bc0dd67 1276
85894313
JD
1277 [Although we failed to mention this here in the 2.3a release, the prologue
1278 alternatives were experimental, and they were rewritten in future versions.]
1279
e4ab1254 1280** The option "--report=look-ahead" has been changed to "--report=lookahead".
9e6e7ed2
PE
1281 The old spelling still works, but is not documented and may be removed
1282 in a future release.
742e4900 1283
d6fb461d 1284* Changes in version 2.3, 2006-06-05:
4ad3ed84 1285
e4ab1254 1286** GLR grammars should now use "YYRECOVERING ()" instead of "YYRECOVERING",
4ad3ed84
PE
1287 for compatibility with LALR(1) grammars.
1288
d6fb461d 1289** It is now documented that any definition of YYSTYPE or YYLTYPE should
4ad3ed84
PE
1290 be to a type name that does not contain parentheses or brackets.
1291
d6fb461d 1292* Changes in version 2.2, 2006-05-19:
193d7c70 1293
d6fb461d 1294** The distribution terms for all Bison-generated parsers now permit
193d7c70
PE
1295 using the parsers in nonfree programs. Previously, this permission
1296 was granted only for Bison-generated LALR(1) parsers in C.
5f4236a0 1297
d6fb461d 1298** %name-prefix changes the namespace name in C++ outputs.
aa08666d 1299
d6fb461d 1300** The C++ parsers export their token_type.
5f4236a0 1301
d6fb461d 1302** Bison now allows multiple %union declarations, and concatenates
d6ca7905
PE
1303 their contents together.
1304
d6fb461d 1305** New warning: unused values
4d7bc38c
PE
1306 Right-hand side symbols whose values are not used are reported,
1307 if the symbols have destructors. For instance:
affac613 1308
8f3596a6 1309 exp: exp "?" exp ":" exp { $1 ? $1 : $3; }
e29f0771
AD
1310 | exp "+" exp
1311 ;
affac613 1312
8f3596a6
AD
1313 will trigger a warning about $$ and $5 in the first rule, and $3 in
1314 the second ($1 is copied to $$ by the default rule). This example
4e26c69e 1315 most likely contains three errors, and could be rewritten as:
affac613 1316
4e26c69e 1317 exp: exp "?" exp ":" exp
e29f0771
AD
1318 { $$ = $1 ? $3 : $5; free ($1 ? $5 : $3); free ($1); }
1319 | exp "+" exp
1320 { $$ = $1 ? $1 : $3; if ($1) free ($3); }
1321 ;
affac613 1322
4e26c69e
PE
1323 However, if the original actions were really intended, memory leaks
1324 and all, the warnings can be suppressed by letting Bison believe the
1325 values are used, e.g.:
721be13c 1326
8f3596a6 1327 exp: exp "?" exp ":" exp { $1 ? $1 : $3; (void) ($$, $5); }
e29f0771
AD
1328 | exp "+" exp { $$ = $1; (void) $3; }
1329 ;
721be13c 1330
84866159
AD
1331 If there are mid-rule actions, the warning is issued if no action
1332 uses it. The following triggers no warning: $1 and $3 are used.
1333
1334 exp: exp { push ($1); } '+' exp { push ($3); sum (); };
1335
721be13c
PE
1336 The warning is intended to help catching lost values and memory leaks.
1337 If a value is ignored, its associated memory typically is not reclaimed.
affac613 1338
d6fb461d 1339** %destructor vs. YYABORT, YYACCEPT, and YYERROR.
9d9b8b70
PE
1340 Destructors are now called when user code invokes YYABORT, YYACCEPT,
1341 and YYERROR, for all objects on the stack, other than objects
1342 corresponding to the right-hand side of the current rule.
a85284cf 1343
d6fb461d 1344** %expect, %expect-rr
035aa4a0
PE
1345 Incorrect numbers of expected conflicts are now actual errors,
1346 instead of warnings.
1347
d6fb461d 1348** GLR, YACC parsers.
4e26c69e
PE
1349 The %parse-params are available in the destructors (and the
1350 experimental printers) as per the documentation.
4b367315 1351
e4ab1254 1352** Bison now warns if it finds a stray "$" or "@" in an action.
ad6a9b97 1353
d6fb461d 1354** %require "VERSION"
4e26c69e
PE
1355 This specifies that the grammar file depends on features implemented
1356 in Bison version VERSION or higher.
b50d2359 1357
d6fb461d 1358** lalr1.cc: The token and value types are now class members.
e14d0ab6
AD
1359 The tokens were defined as free form enums and cpp macros. YYSTYPE
1360 was defined as a free form union. They are now class members:
e4ab1254
AD
1361 tokens are enumerations of the "yy::parser::token" struct, and the
1362 semantic values have the "yy::parser::semantic_type" type.
fb9712a9
AD
1363
1364 If you do not want or can update to this scheme, the directive
e4ab1254 1365 '%define "global_tokens_and_yystype" "1"' triggers the global
b50d2359
AD
1366 definition of tokens and YYSTYPE. This change is suitable both
1367 for previous releases of Bison, and this one.
fb9712a9 1368
b50d2359 1369 If you wish to update, then make sure older version of Bison will
e4ab1254 1370 fail using '%require "2.2"'.
fb9712a9 1371
d6fb461d 1372** DJGPP support added.
193d7c70 1373\f
d6fb461d 1374* Changes in version 2.1, 2005-09-16:
1ce59070 1375
d6fb461d 1376** The C++ lalr1.cc skeleton supports %lex-param.
e14d0ab6 1377
d6fb461d 1378** Bison-generated parsers now support the translation of diagnostics like
baf785db
PE
1379 "syntax error" into languages other than English. The default
1380 language is still English. For details, please see the new
0410a6e0
PE
1381 Internationalization section of the Bison manual. Software
1382 distributors should also see the new PACKAGING file. Thanks to
1383 Bruno Haible for this new feature.
1ce59070 1384
d6fb461d 1385** Wording in the Bison-generated parsers has been changed slightly to
1a059451
PE
1386 simplify translation. In particular, the message "memory exhausted"
1387 has replaced "parser stack overflow", as the old message was not
1388 always accurate for modern Bison-generated parsers.
1389
d6fb461d 1390** Destructors are now called when the parser aborts, for all symbols left
258b75ca
PE
1391 behind on the stack. Also, the start symbol is now destroyed after a
1392 successful parse. In both cases, the behavior was formerly inconsistent.
1393
d6fb461d 1394** When generating verbose diagnostics, Bison-generated parsers no longer
72f000b0
PE
1395 quote the literal strings associated with tokens. For example, for
1396 a syntax error associated with '%token NUM "number"' they might
1397 print 'syntax error, unexpected number' instead of 'syntax error,
1398 unexpected "number"'.
193d7c70 1399\f
d6fb461d 1400* Changes in version 2.0, 2004-12-25:
efeed023 1401
d6fb461d 1402** Possibly-incompatible changes
d7e14fc0 1403
82de6b0d
PE
1404 - Bison-generated parsers no longer default to using the alloca function
1405 (when available) to extend the parser stack, due to widespread
1406 problems in unchecked stack-overflow detection. You can "#define
1407 YYSTACK_USE_ALLOCA 1" to require the use of alloca, but please read
1408 the manual to determine safe values for YYMAXDEPTH in that case.
8dd162d3 1409
82de6b0d
PE
1410 - Error token location.
1411 During error recovery, the location of the syntax error is updated
1412 to cover the whole sequence covered by the error token: it includes
1413 the shifted symbols thrown away during the first part of the error
1414 recovery, and the lookahead rejected during the second part.
18d192f0 1415
82de6b0d
PE
1416 - Semicolon changes:
1417 . Stray semicolons are no longer allowed at the start of a grammar.
1418 . Semicolons are now required after in-grammar declarations.
e342c3be 1419
82de6b0d
PE
1420 - Unescaped newlines are no longer allowed in character constants or
1421 string literals. They were never portable, and GCC 3.4.0 has
1422 dropped support for them. Better diagnostics are now generated if
1423 forget a closing quote.
8dd162d3 1424
82de6b0d 1425 - NUL bytes are no longer allowed in Bison string literals, unfortunately.
f74b6f91 1426
d6fb461d 1427** New features
1452af69 1428
82de6b0d 1429 - GLR grammars now support locations.
4febdd96 1430
82de6b0d
PE
1431 - New directive: %initial-action.
1432 This directive allows the user to run arbitrary code (including
1433 initializing @$) from yyparse before parsing starts.
1452af69 1434
82de6b0d
PE
1435 - A new directive "%expect-rr N" specifies the expected number of
1436 reduce/reduce conflicts in GLR parsers.
1452af69 1437
e4ab1254 1438 - %token numbers can now be hexadecimal integers, e.g., "%token FOO 0x12d".
82de6b0d 1439 This is a GNU extension.
4febdd96 1440
e4ab1254 1441 - The option "--report=lookahead" was changed to "--report=look-ahead".
9e6e7ed2 1442 [However, this was changed back after 2.3.]
1452af69 1443
82de6b0d 1444 - Experimental %destructor support has been added to lalr1.cc.
1452af69 1445
82de6b0d
PE
1446 - New configure option --disable-yacc, to disable installation of the
1447 yacc command and -ly library introduced in 1.875 for POSIX conformance.
6040d338 1448
d6fb461d 1449** Bug fixes
d5a3fe37 1450
82de6b0d
PE
1451 - For now, %expect-count violations are now just warnings, not errors.
1452 This is for compatibility with Bison 1.75 and earlier (when there are
1453 reduce/reduce conflicts) and with Bison 1.30 and earlier (when there
1454 are too many or too few shift/reduce conflicts). However, in future
1455 versions of Bison we plan to improve the %expect machinery so that
1456 these violations will become errors again.
3473d0f8 1457
82de6b0d
PE
1458 - Within Bison itself, numbers (e.g., goto numbers) are no longer
1459 arbitrarily limited to 16-bit counts.
d600ee67 1460
82de6b0d 1461 - Semicolons are now allowed before "|" in grammar rules, as POSIX requires.
d600ee67 1462\f
d6fb461d 1463* Changes in version 1.875, 2003-01-01:
963fcc17 1464
d6fb461d 1465** The documentation license has been upgraded to version 1.2
dc546b0f 1466 of the GNU Free Documentation License.
75eb3bc4 1467
d6fb461d 1468** syntax error processing
75eb3bc4 1469
dc546b0f
PE
1470 - In Yacc-style parsers YYLLOC_DEFAULT is now used to compute error
1471 locations too. This fixes bugs in error-location computation.
75eb3bc4 1472
dc546b0f
PE
1473 - %destructor
1474 It is now possible to reclaim the memory associated to symbols
1475 discarded during error recovery. This feature is still experimental.
20daca06 1476
dc546b0f
PE
1477 - %error-verbose
1478 This new directive is preferred over YYERROR_VERBOSE.
74724a70 1479
dc546b0f
PE
1480 - #defining yyerror to steal internal variables is discouraged.
1481 It is not guaranteed to work forever.
d1de5372 1482
d6fb461d 1483** POSIX conformance
d1de5372 1484
dc546b0f
PE
1485 - Semicolons are once again optional at the end of grammar rules.
1486 This reverts to the behavior of Bison 1.33 and earlier, and improves
1487 compatibility with Yacc.
74724a70 1488
e4ab1254
AD
1489 - "parse error" -> "syntax error"
1490 Bison now uniformly uses the term "syntax error"; formerly, the code
1491 and manual sometimes used the term "parse error" instead. POSIX
1492 requires "syntax error" in diagnostics, and it was thought better to
dc546b0f 1493 be consistent.
74724a70 1494
dc546b0f
PE
1495 - The documentation now emphasizes that yylex and yyerror must be
1496 declared before use. C99 requires this.
d1de5372 1497
dc546b0f
PE
1498 - Bison now parses C99 lexical constructs like UCNs and
1499 backslash-newline within C escape sequences, as POSIX 1003.1-2001 requires.
d1de5372 1500
dc546b0f
PE
1501 - File names are properly escaped in C output. E.g., foo\bar.y is
1502 output as "foo\\bar.y".
6780ca7a 1503
dc546b0f 1504 - Yacc command and library now available
e4ab1254 1505 The Bison distribution now installs a "yacc" command, as POSIX requires.
dc546b0f
PE
1506 Also, Bison now installs a small library liby.a containing
1507 implementations of Yacc-compatible yyerror and main functions.
1508 This library is normally not useful, but POSIX requires it.
6e649e65 1509
dc546b0f 1510 - Type clashes now generate warnings, not errors.
6e649e65 1511
dc546b0f
PE
1512 - If the user does not define YYSTYPE as a macro, Bison now declares it
1513 using typedef instead of defining it as a macro.
1514 For consistency, YYLTYPE is also declared instead of defined.
9501dc6e 1515
d6fb461d 1516** Other compatibility issues
886a425c 1517
e4ab1254
AD
1518 - %union directives can now have a tag before the "{", e.g., the
1519 directive "%union foo {...}" now generates the C code
1520 "typedef union foo { ... } YYSTYPE;"; this is for Yacc compatibility.
1521 The default union tag is "YYSTYPE", for compatibility with Solaris 9 Yacc.
1522 For consistency, YYLTYPE's struct tag is now "YYLTYPE" not "yyltype".
dc546b0f 1523 This is for compatibility with both Yacc and Bison 1.35.
72f889cc 1524
e4ab1254 1525 - ";" is output before the terminating "}" of an action, for
dc546b0f 1526 compatibility with Bison 1.35.
886a425c 1527
dc546b0f 1528 - Bison now uses a Yacc-style format for conflict reports, e.g.,
e4ab1254 1529 "conflicts: 2 shift/reduce, 1 reduce/reduce".
437c2d80 1530
e4ab1254 1531 - "yystype" and "yyltype" are now obsolescent macros instead of being
dc546b0f
PE
1532 typedefs or tags; they are no longer documented and are planned to be
1533 withdrawn in a future release.
2a8d363a 1534
d6fb461d 1535** GLR parser notes
2a8d363a 1536
dc546b0f
PE
1537 - GLR and inline
1538 Users of Bison have to decide how they handle the portability of the
e4ab1254 1539 C keyword "inline".
959e5f51 1540
e4ab1254
AD
1541 - "parsing stack overflow..." -> "parser stack overflow"
1542 GLR parsers now report "parser stack overflow" as per the Bison manual.
900c5db5 1543
18ad57b3
AD
1544** %parse-param and %lex-param
1545 The macros YYPARSE_PARAM and YYLEX_PARAM provide a means to pass
1546 additional context to yyparse and yylex. They suffer from several
1547 shortcomings:
1548
1549 - a single argument only can be added,
1550 - their types are weak (void *),
242cc08e 1551 - this context is not passed to ancillary functions such as yyerror,
18ad57b3
AD
1552 - only yacc.c parsers support them.
1553
1554 The new %parse-param/%lex-param directives provide a more precise control.
1555 For instance:
1556
1557 %parse-param {int *nastiness}
1558 %lex-param {int *nastiness}
1559 %parse-param {int *randomness}
1560
1561 results in the following signatures:
1562
1563 int yylex (int *nastiness);
1564 int yyparse (int *nastiness, int *randomness);
1565
1566 or, if both %pure-parser and %locations are used:
1567
1568 int yylex (YYSTYPE *lvalp, YYLTYPE *llocp, int *nastiness);
1569 int yyparse (int *nastiness, int *randomness);
1570
d6fb461d 1571** Bison now warns if it detects conflicting outputs to the same file,
e4ab1254 1572 e.g., it generates a warning for "bison -d -o foo.h foo.y" since
dc546b0f 1573 that command outputs both code and header to foo.h.
6e40b4eb 1574
d6fb461d 1575** #line in output files
dc546b0f 1576 - --no-line works properly.
6e40b4eb 1577
d6fb461d 1578** Bison can no longer be built by a K&R C compiler; it requires C89 or
6e40b4eb
AD
1579 later to be built. This change originally took place a few versions
1580 ago, but nobody noticed until we recently asked someone to try
1581 building Bison with a K&R C compiler.
d600ee67 1582\f
d6fb461d 1583* Changes in version 1.75, 2002-10-14:
7933f2b5 1584
d6fb461d 1585** Bison should now work on 64-bit hosts.
7933f2b5 1586
d6fb461d 1587** Indonesian translation thanks to Tedi Heriyanto.
7933f2b5 1588
d6fb461d 1589** GLR parsers
f50adbbd
AD
1590 Fix spurious parse errors.
1591
d6fb461d 1592** Pure parsers
f50adbbd
AD
1593 Some people redefine yyerror to steal yyparse' private variables.
1594 Reenable this trick until an official feature replaces it.
1595
d6fb461d 1596** Type Clashes
d90c934c
AD
1597 In agreement with POSIX and with other Yaccs, leaving a default
1598 action is valid when $$ is untyped, and $1 typed:
1599
e29f0771 1600 untyped: ... typed;
d90c934c
AD
1601
1602 but the converse remains an error:
1603
e29f0771 1604 typed: ... untyped;
d90c934c 1605
d6fb461d 1606** Values of mid-rule actions
d90c934c
AD
1607 The following code:
1608
e29f0771 1609 foo: { ... } { $$ = $1; } ...
d90c934c
AD
1610
1611 was incorrectly rejected: $1 is defined in the second mid-rule
1612 action, and is equal to the $$ of the first mid-rule action.
d600ee67 1613\f
d6fb461d 1614* Changes in version 1.50, 2002-10-04:
adc8c848 1615
d6fb461d 1616** GLR parsing
676385e2
PH
1617 The declaration
1618 %glr-parser
1619 causes Bison to produce a Generalized LR (GLR) parser, capable of handling
1620 almost any context-free grammar, ambiguous or not. The new declarations
e8832397 1621 %dprec and %merge on grammar rules allow parse-time resolution of
676385e2
PH
1622 ambiguities. Contributed by Paul Hilfinger.
1623
7933f2b5 1624 Unfortunately Bison 1.50 does not work properly on 64-bit hosts
420f93c8
PE
1625 like the Alpha, so please stick to 32-bit hosts for now.
1626
d6fb461d 1627** Output Directory
8c165d89 1628 When not in Yacc compatibility mode, when the output file was not
e4ab1254
AD
1629 specified, running "bison foo/bar.y" created "foo/bar.c". It
1630 now creates "bar.c".
8c165d89 1631
d6fb461d 1632** Undefined token
007a50a4 1633 The undefined token was systematically mapped to 2 which prevented
e88dbdbf 1634 the use of 2 by the user. This is no longer the case.
007a50a4 1635
d6fb461d 1636** Unknown token numbers
e88dbdbf 1637 If yylex returned an out of range value, yyparse could die. This is
007a50a4
AD
1638 no longer the case.
1639
d6fb461d 1640** Error token
e88dbdbf 1641 According to POSIX, the error token must be 256.
23c5a174
AD
1642 Bison extends this requirement by making it a preference: *if* the
1643 user specified that one of her tokens is numbered 256, then error
1644 will be mapped onto another number.
1645
d6fb461d 1646** Verbose error messages
e4ab1254 1647 They no longer report "..., expecting error or..." for states where
217598da
AD
1648 error recovery is possible.
1649
d6fb461d 1650** End token
e4ab1254 1651 Defaults to "$end" instead of "$".
217598da 1652
d6fb461d 1653** Error recovery now conforms to documentation and to POSIX
68cd8af3
PE
1654 When a Bison-generated parser encounters a syntax error, it now pops
1655 the stack until it finds a state that allows shifting the error
1656 token. Formerly, it popped the stack until it found a state that
1657 allowed some non-error action other than a default reduction on the
1658 error token. The new behavior has long been the documented behavior,
1659 and has long been required by POSIX. For more details, please see
337116ba
PE
1660 Paul Eggert, "Reductions during Bison error handling" (2002-05-20)
1661 <http://lists.gnu.org/archive/html/bug-bison/2002-05/msg00038.html>.
68cd8af3 1662
d6fb461d 1663** Traces
5504898e
AD
1664 Popped tokens and nonterminals are now reported.
1665
d6fb461d 1666** Larger grammars
a861a339
PE
1667 Larger grammars are now supported (larger token numbers, larger grammar
1668 size (= sum of the LHS and RHS lengths), larger LALR tables).
1669 Formerly, many of these numbers ran afoul of 16-bit limits;
1670 now these limits are 32 bits on most hosts.
355e7c1c 1671
d6fb461d 1672** Explicit initial rule
643a5994
AD
1673 Bison used to play hacks with the initial rule, which the user does
1674 not write. It is now explicit, and visible in the reports and
1675 graphs as rule 0.
23c5a174 1676
d6fb461d 1677** Useless rules
643a5994 1678 Before, Bison reported the useless rules, but, although not used,
77714df2 1679 included them in the parsers. They are now actually removed.
23c5a174 1680
d6fb461d 1681** Useless rules, useless nonterminals
6b98e4b5
AD
1682 They are now reported, as a warning, with their locations.
1683
d6fb461d 1684** Rules never reduced
e8832397
AD
1685 Rules that can never be reduced because of conflicts are now
1686 reported.
1687
e4ab1254 1688** Incorrect "Token not used"
11652ab3
AD
1689 On a grammar such as
1690
e29f0771
AD
1691 %token useless useful
1692 %%
1693 exp: '0' %prec useful;
11652ab3
AD
1694
1695 where a token was used to set the precedence of the last rule,
e4ab1254 1696 bison reported both "useful" and "useless" as useless tokens.
11652ab3 1697
d6fb461d 1698** Revert the C++ namespace changes introduced in 1.31
77714df2 1699 as they caused too many portability hassles.
0179dd65 1700
d6fb461d 1701** Default locations
b2d52318
AD
1702 By an accident of design, the default computation of @$ was
1703 performed after another default computation was performed: @$ = @1.
1704 The latter is now removed: YYLLOC_DEFAULT is fully responsible of
1705 the computation of @$.
adc8c848 1706
d6fb461d 1707** Token end-of-file
b7c49edf
AD
1708 The token end of file may be specified by the user, in which case,
1709 the user symbol is used in the reports, the graphs, and the verbose
e4ab1254 1710 error messages instead of "$end", which remains being the default.
b7c49edf 1711 For instance
e29f0771 1712 %token MYEOF 0
b7c49edf 1713 or
e29f0771 1714 %token MYEOF 0 "end of file"
fdbcd8e2 1715
d6fb461d 1716** Semantic parser
fdbcd8e2
AD
1717 This old option, which has been broken for ages, is removed.
1718
d6fb461d 1719** New translations
a861a339 1720 Brazilian Portuguese, thanks to Alexandre Folle de Menezes.
84614e13
AD
1721 Croatian, thanks to Denis Lackovic.
1722
d6fb461d 1723** Incorrect token definitions
e4ab1254
AD
1724 When given
1725 %token 'a' "A"
1726 bison used to output
1727 #define 'a' 65
b87f8b21 1728
d6fb461d 1729** Token definitions as enums
77714df2
AD
1730 Tokens are output both as the traditional #define's, and, provided
1731 the compiler supports ANSI C or is a C++ compiler, as enums.
e88dbdbf 1732 This lets debuggers display names instead of integers.
77714df2 1733
d6fb461d 1734** Reports
ec3bc396
AD
1735 In addition to --verbose, bison supports --report=THINGS, which
1736 produces additional information:
b408954b
AD
1737 - itemset
1738 complete the core item sets with their closure
e4ab1254 1739 - lookahead [changed to "look-ahead" in 1.875e through 2.3, but changed back]
9e6e7ed2 1740 explicitly associate lookahead tokens to items
b408954b
AD
1741 - solved
1742 describe shift/reduce conflicts solving.
1743 Bison used to systematically output this information on top of
1744 the report. Solved conflicts are now attached to their states.
ec3bc396 1745
d6fb461d 1746** Type clashes
9af3fbce
AD
1747 Previous versions don't complain when there is a type clash on
1748 the default action if the rule has a mid-rule action, such as in:
1749
e29f0771
AD
1750 %type <foo> bar
1751 %%
1752 bar: '0' {} '0';
9af3fbce
AD
1753
1754 This is fixed.
a861a339 1755
d6fb461d 1756** GNU M4 is now required when using Bison.
f987e9d2 1757\f
d6fb461d 1758* Changes in version 1.35, 2002-03-25:
76551463 1759
d6fb461d 1760** C Skeleton
76551463
AD
1761 Some projects use Bison's C parser with C++ compilers, and define
1762 YYSTYPE as a class. The recent adjustment of C parsers for data
1763 alignment and 64 bit architectures made this impossible.
1764
1765 Because for the time being no real solution for C++ parser
1766 generation exists, kludges were implemented in the parser to
1767 maintain this use. In the future, when Bison has C++ parsers, this
1768 kludge will be disabled.
1769
1770 This kludge also addresses some C++ problems when the stack was
1771 extended.
76551463 1772\f
d6fb461d 1773* Changes in version 1.34, 2002-03-12:
76551463 1774
d6fb461d 1775** File name clashes are detected
76551463 1776 $ bison foo.y -d -o foo.x
e4ab1254 1777 fatal error: header and parser would both be named "foo.x"
76551463 1778
e4ab1254 1779** A missing ";" at the end of a rule triggers a warning
76551463
AD
1780 In accordance with POSIX, and in agreement with other
1781 Yacc implementations, Bison will mandate this semicolon in the near
1782 future. This eases the implementation of a Bison parser of Bison
1783 grammars by making this grammar LALR(1) instead of LR(2). To
1784 facilitate the transition, this release introduces a warning.
1785
d6fb461d 1786** Revert the C++ namespace changes introduced in 1.31, as they caused too
76551463
AD
1787 many portability hassles.
1788
d6fb461d 1789** DJGPP support added.
76551463 1790
d6fb461d 1791** Fix test suite portability problems.
76551463 1792\f
d6fb461d 1793* Changes in version 1.33, 2002-02-07:
76551463 1794
d6fb461d 1795** Fix C++ issues
76551463
AD
1796 Groff could not be compiled for the definition of size_t was lacking
1797 under some conditions.
1798
d6fb461d 1799** Catch invalid @n
76551463
AD
1800 As is done with $n.
1801\f
d6fb461d 1802* Changes in version 1.32, 2002-01-23:
76551463 1803
d6fb461d 1804** Fix Yacc output file names
76551463 1805
d6fb461d 1806** Portability fixes
76551463 1807
d6fb461d 1808** Italian, Dutch translations
76551463 1809\f
d6fb461d 1810* Changes in version 1.31, 2002-01-14:
52d1aeee 1811
d6fb461d 1812** Many Bug Fixes
52d1aeee 1813
d6fb461d 1814** GNU Gettext and %expect
52d1aeee
MA
1815 GNU Gettext asserts 10 s/r conflicts, but there are 7. Now that
1816 Bison dies on incorrect %expectations, we fear there will be
1817 too many bug reports for Gettext, so _for the time being_, %expect
e4ab1254 1818 does not trigger an error when the input file is named "plural.y".
52d1aeee 1819
d6fb461d 1820** Use of alloca in parsers
52d1aeee
MA
1821 If YYSTACK_USE_ALLOCA is defined to 0, then the parsers will use
1822 malloc exclusively. Since 1.29, but was not NEWS'ed.
1823
1824 alloca is used only when compiled with GCC, to avoid portability
1825 problems as on AIX.
1826
d6fb461d 1827** yyparse now returns 2 if memory is exhausted; formerly it dumped core.
b47dbebe 1828
d6fb461d 1829** When the generated parser lacks debugging code, YYDEBUG is now 0
52d1aeee
MA
1830 (as POSIX requires) instead of being undefined.
1831
d6fb461d 1832** User Actions
52d1aeee
MA
1833 Bison has always permitted actions such as { $$ = $1 }: it adds the
1834 ending semicolon. Now if in Yacc compatibility mode, the semicolon
1835 is no longer output: one has to write { $$ = $1; }.
1836
d6fb461d 1837** Better C++ compliance
52d1aeee 1838 The output parsers try to respect C++ namespaces.
76551463 1839 [This turned out to be a failed experiment, and it was reverted later.]
52d1aeee 1840
d6fb461d 1841** Reduced Grammars
52d1aeee
MA
1842 Fixed bugs when reporting useless nonterminals.
1843
d6fb461d 1844** 64 bit hosts
52d1aeee
MA
1845 The parsers work properly on 64 bit hosts.
1846
d6fb461d 1847** Error messages
52d1aeee
MA
1848 Some calls to strerror resulted in scrambled or missing error messages.
1849
d6fb461d 1850** %expect
52d1aeee
MA
1851 When the number of shift/reduce conflicts is correct, don't issue
1852 any warning.
1853
d6fb461d 1854** The verbose report includes the rule line numbers.
52d1aeee 1855
d6fb461d 1856** Rule line numbers are fixed in traces.
52d1aeee 1857
d6fb461d 1858** Swedish translation
52d1aeee 1859
d6fb461d 1860** Parse errors
52d1aeee
MA
1861 Verbose parse error messages from the parsers are better looking.
1862 Before: parse error: unexpected `'/'', expecting `"number"' or `'-'' or `'(''
1863 Now: parse error: unexpected '/', expecting "number" or '-' or '('
1864
d6fb461d 1865** Fixed parser memory leaks.
52d1aeee
MA
1866 When the generated parser was using malloc to extend its stacks, the
1867 previous allocations were not freed.
1868
d6fb461d 1869** Fixed verbose output file.
52d1aeee
MA
1870 Some newlines were missing.
1871 Some conflicts in state descriptions were missing.
1872
d6fb461d 1873** Fixed conflict report.
52d1aeee
MA
1874 Option -v was needed to get the result.
1875
d6fb461d 1876** %expect
52d1aeee
MA
1877 Was not used.
1878 Mismatches are errors, not warnings.
1879
d6fb461d 1880** Fixed incorrect processing of some invalid input.
52d1aeee 1881
d6fb461d 1882** Fixed CPP guards: 9foo.h uses BISON_9FOO_H instead of 9FOO_H.
52d1aeee 1883
d6fb461d 1884** Fixed some typos in the documentation.
52d1aeee 1885
d6fb461d 1886** %token MY_EOF 0 is supported.
52d1aeee
MA
1887 Before, MY_EOF was silently renumbered as 257.
1888
d6fb461d 1889** doc/refcard.tex is updated.
52d1aeee 1890
d6fb461d 1891** %output, %file-prefix, %name-prefix.
52d1aeee
MA
1892 New.
1893
d6fb461d 1894** --output
e4ab1254 1895 New, aliasing "--output-file".
52d1aeee 1896\f
d6fb461d 1897* Changes in version 1.30, 2001-10-26:
342b8b6e 1898
e4ab1254
AD
1899** "--defines" and "--graph" have now an optional argument which is the
1900 output file name. "-d" and "-g" do not change; they do not take any
342b8b6e
AD
1901 argument.
1902
e4ab1254 1903** "%source_extension" and "%header_extension" are removed, failed
342b8b6e
AD
1904 experiment.
1905
d6fb461d 1906** Portability fixes.
f987e9d2 1907\f
d6fb461d 1908* Changes in version 1.29, 2001-09-07:
342b8b6e 1909
d6fb461d 1910** The output file does not define const, as this caused problems when used
342b8b6e
AD
1911 with common autoconfiguration schemes. If you still use ancient compilers
1912 that lack const, compile with the equivalent of the C compiler option
e4ab1254 1913 "-Dconst=". Autoconf's AC_C_CONST macro provides one way to do this.
342b8b6e 1914
e4ab1254 1915** Added "-g" and "--graph".
f87a2205 1916
d6fb461d 1917** The Bison manual is now distributed under the terms of the GNU FDL.
f2b5126e 1918
d6fb461d 1919** The input and the output files has automatically a similar extension.
234a3be3 1920
d6fb461d 1921** Russian translation added.
f87a2205 1922
d6fb461d 1923** NLS support updated; should hopefully be less troublesome.
f87a2205 1924
d6fb461d 1925** Added the old Bison reference card.
c33638bb 1926
e4ab1254 1927** Added "--locations" and "%locations".
6deb4447 1928
e4ab1254 1929** Added "-S" and "--skeleton".
cd5bd6ac 1930
e4ab1254 1931** "%raw", "-r", "--raw" is disabled.
62ab6972 1932
d6fb461d 1933** Special characters are escaped when output. This solves the problems
cd5bd6ac
AD
1934 of the #line lines with path names including backslashes.
1935
d6fb461d 1936** New directives.
e4ab1254
AD
1937 "%yacc", "%fixed_output_files", "%defines", "%no_parser", "%verbose",
1938 "%debug", "%source_extension" and "%header_extension".
f987e9d2 1939
d6fb461d 1940** @$
f987e9d2 1941 Automatic location tracking.
f87a2205 1942\f
d6fb461d 1943* Changes in version 1.28, 1999-07-06:
d2e00347 1944
d6fb461d 1945** Should compile better now with K&R compilers.
d2e00347 1946
d6fb461d 1947** Added NLS.
d2e00347 1948
d6fb461d 1949** Fixed a problem with escaping the double quote character.
d2e00347 1950
d6fb461d 1951** There is now a FAQ.
d2e00347 1952\f
d6fb461d 1953* Changes in version 1.27:
5c31c3c2 1954
d6fb461d 1955** The make rule which prevented bison.simple from being created on
5c31c3c2
JT
1956 some systems has been fixed.
1957\f
d6fb461d 1958* Changes in version 1.26:
4be07551 1959
7e508a2b 1960** Bison now uses Automake.
4be07551 1961
d6fb461d 1962** New mailing lists: <bug-bison@gnu.org> and <help-bison@gnu.org>.
4be07551 1963
d6fb461d 1964** Token numbers now start at 257 as previously documented, not 258.
4be07551 1965
d6fb461d 1966** Bison honors the TMPDIR environment variable.
4be07551 1967
d6fb461d 1968** A couple of buffer overruns have been fixed.
f51dbca1 1969
d6fb461d 1970** Problems when closing files should now be reported.
f51dbca1 1971
d6fb461d 1972** Generated parsers should now work even on operating systems which do
f51dbca1 1973 not provide alloca().
4be07551 1974\f
d6fb461d 1975* Changes in version 1.25, 1995-10-16:
df8878c5 1976
d6fb461d 1977** Errors in the input grammar are not fatal; Bison keeps reading
df8878c5 1978the grammar file, and reports all the errors found in it.
8c44d3ec 1979
d6fb461d 1980** Tokens can now be specified as multiple-character strings: for
df8878c5 1981example, you could use "<=" for a token which looks like <=, instead
7e508a2b 1982of choosing a name like LESSEQ.
df8878c5 1983
d6fb461d 1984** The %token_table declaration says to write a table of tokens (names
df8878c5
RS
1985and numbers) into the parser file. The yylex function can use this
1986table to recognize multiple-character string tokens, or for other
1987purposes.
1988
d6fb461d 1989** The %no_lines declaration says not to generate any #line preprocessor
df8878c5
RS
1990directives in the parser file.
1991
d6fb461d 1992** The %raw declaration says to use internal Bison token numbers, not
df8878c5
RS
1993Yacc-compatible token numbers, when token names are defined as macros.
1994
d6fb461d 1995** The --no-parser option produces the parser tables without including
df8878c5
RS
1996the parser engine; a project can now use its own parser engine.
1997The actions go into a separate file called NAME.act, in the form of
1998a switch statement body.
1999\f
d6fb461d 2000* Changes in version 1.23:
6780ca7a 2001
4d019228
DM
2002The user can define YYPARSE_PARAM as the name of an argument to be
2003passed into yyparse. The argument should have type void *. It should
2004actually point to an object. Grammar actions can access the variable
2005by casting it to the proper pointer type.
6780ca7a 2006
6780ca7a 2007Line numbers in output file corrected.
6780ca7a 2008\f
d6fb461d 2009* Changes in version 1.22:
6780ca7a
DM
2010
2011--help option added.
6780ca7a 2012\f
d6fb461d 2013* Changes in version 1.20:
6780ca7a
DM
2014
2015Output file does not redefine const for C++.
9f4503d6 2016
76551463
AD
2017-----
2018
c932d613 2019Copyright (C) 1995-2012 Free Software Foundation, Inc.
76551463 2020
8defe11b 2021This file is part of Bison, the GNU Parser Generator.
76551463 2022
f16b0819 2023This program is free software: you can redistribute it and/or modify
76551463 2024it under the terms of the GNU General Public License as published by
f16b0819
PE
2025the Free Software Foundation, either version 3 of the License, or
2026(at your option) any later version.
76551463 2027
f16b0819 2028This program is distributed in the hope that it will be useful,
76551463
AD
2029but WITHOUT ANY WARRANTY; without even the implied warranty of
2030MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2031GNU General Public License for more details.
2032
2033You should have received a copy of the GNU General Public License
f16b0819 2034along with this program. If not, see <http://www.gnu.org/licenses/>.
7e508a2b
AD
2035
2036 LocalWords: yacc YYBACKUP glr GCC lalr ArrayIndexOutOfBoundsException nullptr
2037 LocalWords: cplusplus liby rpl fprintf mfcalc Wyacc stmt cond expr mk sym lr
2038 LocalWords: IELR ielr Lookahead YYERROR nonassoc LALR's api lookaheads yychar
2039 LocalWords: destructor lookahead YYRHSLOC YYLLOC Rhs ifndef YYFAIL cpp sr rr
2040 LocalWords: preprocessor initializer Wno Wnone Werror FreeBSD prec livelocks
2041 LocalWords: Solaris AIX UX RHEL Tru LHS gcc's Wundef YYENABLE NLS YYLTYPE VCG
2042 LocalWords: yyerror cpp's Wunused yylval yylloc prepend yyparse yylex yypush
2043 LocalWords: Graphviz xml nonterminals midrule destructor's YYSTYPE typedef ly
2044 LocalWords: CHR chr printf stdout namespace preprocessing enum pre include's
2045 LocalWords: YYRECOVERING nonfree destructors YYABORT YYACCEPT params enums de
2046 LocalWords: struct yystype DJGPP lex param Haible NUM alloca YYSTACK NUL goto
2047 LocalWords: YYMAXDEPTH Unescaped UCNs YYLTYPE's yyltype typedefs inline Yaccs
2048 LocalWords: Heriyanto Reenable dprec Hilfinger Eggert MYEOF Folle Menezes EOF
242cc08e 2049 LocalWords: Lackovic define's itemset Groff Gettext malloc NEWS'ed YYDEBUG YY
7e508a2b 2050 LocalWords: namespaces strerror const autoconfiguration Dconst Autoconf's FDL
242cc08e
AD
2051 LocalWords: Automake TMPDIR LESSEQ ylwrap endif yydebug YYTOKEN YYLSP ival hh
2052 LocalWords: extern YYTOKENTYPE TOKENTYPE yytokentype tokentype STYPE lval pdf
7287be84
AD
2053 LocalWords: lang yyoutput dvi html ps POSIX lvalp llocp calc yyo fval Wmaybe
2054 LocalWords: yyvsp pragmas noreturn java's
7e508a2b
AD
2055
2056Local Variables:
2057mode: outline
e4ab1254 2058fill-column: 76
7e508a2b 2059End: