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