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