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