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