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