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