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