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