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