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