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