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