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