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