]> git.saurik.com Git - bison.git/blame - NEWS
Implement %define lr.default_rules.
[bison.git] / NEWS
CommitLineData
6780ca7a
DM
1Bison News
2----------
3af4feb2 3
74553c98
AD
4* Changes in version ?.? (????-??-??):
5
0ea583d2
AD
6** Java skeleton improvements:
7
8 The constants for token names were moved to the Lexer interface.
9 Also, it is possible to add code to the parser's constructors using
10 "%code init" and "%define init_throws".
11
50cca368
JD
12* Changes in version 2.5 (????-??-??):
13
14** %define can now be invoked via the command line.
15
16 Each of these bison command-line options
17
18 -D NAME=VALUE
19 --define=NAME=VALUE
20
21 is equivalent to this grammar file declaration
22
23 %define NAME "VALUE"
24
25 for any NAME and VALUE. Omitting `=VALUE' on the command line is
26 equivalent to omitting `"VALUE"' in the declaration.
27
197b82ba
JD
28** Temporary hack for adding a semicolon to the user action.
29
30 Previously, Bison appended a semicolon to every user action for
31 reductions when the output language defaulted to C (specifically, when
32 neither %yacc, %language, %skeleton, or equivalent command-line
33 options were specified). This allowed actions such as
34
35 exp: exp "+" exp { $$ = $1 + $3 };
36
37 instead of
38
39 exp: exp "+" exp { $$ = $1 + $3; };
40
41 As a first step in removing this misfeature, Bison now issues a
42 warning when it appends a semicolon. Moreover, in cases where Bison
43 cannot easily determine whether a semicolon is needed (for example, an
44 action ending with a cpp directive or a braced compound initializer),
45 it no longer appends one. Thus, the C compiler might now complain
46 about a missing semicolon where it did not before. Future releases of
47 Bison will cease to append semicolons entirely.
48
74553c98
AD
49* Changes in version 2.4.2 (????-??-??):
50
51* Changes in version 2.4.1 (2008-12-11):
c9ba9e59 52
0ea583d2
AD
53** In the GLR defines file, unexpanded M4 macros in the yylval and yylloc
54 declarations have been fixed.
1979121c 55
0ea583d2
AD
56** Temporary hack for adding a semicolon to the user action.
57
58 Bison used to prepend a trailing semicolon at the end of the user
59 action for reductions. This allowed actions such as
60
61 exp: exp "+" exp { $$ = $1 + $3 };
62
63 instead of
64
65 exp: exp "+" exp { $$ = $1 + $3; };
66
67 Some grammars still depend on this `feature'. Bison 2.4.1 restores
68 the previous behavior in the case of C output (specifically, when
69 neither %language or %skeleton or equivalent command-line options
70 are used) to leave more time for grammars depending on the old
71 behavior to be adjusted. Future releases of Bison will disable this
72 feature.
73
74** A few minor improvements to the Bison manual.
c9ba9e59 75
402b123d 76* Changes in version 2.4 (2008-11-02):
7bd1665a 77
402b123d 78** %language is an experimental feature.
ed4d67dc
JD
79
80 We first introduced this feature in test release 2.3b as a cleaner
81 alternative to %skeleton. Since then, we have discussed the possibility of
82 modifying its effect on Bison's output file names. Thus, in this release,
83 we consider %language to be an experimental feature that will likely evolve
84 in future releases.
7bd1665a 85
402b123d 86** Forward compatibility with GNU M4 has been improved.
241fda7a 87
402b123d 88** Several bugs in the C++ skeleton and the experimental Java skeleton have been
241fda7a
JD
89 fixed.
90
402b123d 91* Changes in version 2.3b (2008-05-27):
35fe0834 92
402b123d 93** The quotes around NAME that used to be required in the following directive
d9df47b6
JD
94 are now deprecated:
95
96 %define NAME "VALUE"
97
402b123d 98** The directive `%pure-parser' is now deprecated in favor of:
d9df47b6
JD
99
100 %define api.pure
101
102 which has the same effect except that Bison is more careful to warn about
103 unreasonable usage in the latter case.
104
402b123d 105** Push Parsing
c373bf8b
JD
106
107 Bison can now generate an LALR(1) parser in C with a push interface. That
ef1b4273 108 is, instead of invoking `yyparse', which pulls tokens from `yylex', you can
c373bf8b
JD
109 push one token at a time to the parser using `yypush_parse', which will
110 return to the caller after processing each token. By default, the push
111 interface is disabled. Either of the following directives will enable it:
112
113 %define api.push_pull "push" // Just push; does not require yylex.
114 %define api.push_pull "both" // Push and pull; requires yylex.
115
116 See the new section `A Push Parser' in the Bison manual for details.
117
59da312b
JD
118 The current push parsing interface is experimental and may evolve. More user
119 feedback will help to stabilize it.
120
402b123d 121** The -g and --graph options now output graphs in Graphviz DOT format,
8e55b3aa
JD
122 not VCG format. Like --graph, -g now also takes an optional FILE argument
123 and thus cannot be bundled with other short options.
c373bf8b 124
402b123d 125** Java
59da312b
JD
126
127 Bison can now generate an LALR(1) parser in Java. The skeleton is
128 `data/lalr1.java'. Consider using the new %language directive instead of
129 %skeleton to select it.
130
131 See the new section `Java Parsers' in the Bison manual for details.
132
133 The current Java interface is experimental and may evolve. More user
134 feedback will help to stabilize it.
135
402b123d 136** %language
59da312b
JD
137
138 This new directive specifies the programming language of the generated
d43f77e7
PB
139 parser, which can be C (the default), C++, or Java. Besides the skeleton
140 that Bison uses, the directive affects the names of the generated files if
141 the grammar file's name ends in ".y".
59da312b 142
402b123d 143** XML Automaton Report
59da312b
JD
144
145 Bison can now generate an XML report of the LALR(1) automaton using the new
146 `--xml' option. The current XML schema is experimental and may evolve. More
147 user feedback will help to stabilize it.
c373bf8b 148
402b123d 149** The grammar file may now specify the name of the parser header file using
c373bf8b
JD
150 %defines. For example:
151
152 %defines "parser.h"
153
402b123d 154** When reporting useless rules, useless nonterminals, and unused terminals,
d80fb37a
JD
155 Bison now employs the terms "useless in grammar" instead of "useless",
156 "useless in parser" instead of "never reduced", and "unused in grammar"
157 instead of "unused".
cff03fb2 158
402b123d 159** Unreachable State Removal
c373bf8b
JD
160
161 Previously, Bison sometimes generated parser tables containing unreachable
31984206
JD
162 states. A state can become unreachable during conflict resolution if Bison
163 disables a shift action leading to it from a predecessor state. Bison now:
75ad86ee
JD
164
165 1. Removes unreachable states.
166
167 2. Does not report any conflicts that appeared in unreachable states.
168 WARNING: As a result, you may need to update %expect and %expect-rr
169 directives in existing grammar files.
170
171 3. For any rule used only in such states, Bison now reports the rule as
cff03fb2 172 "useless in parser due to conflicts".
75ad86ee 173
31984206
JD
174 This feature can be disabled with the following directive:
175
176 %define lr.keep_unreachable_states
177
178 See the %define entry in the `Bison Declaration Summary' in the Bison manual
179 for further discussion.
180
402b123d 181** Lookahead Set Correction in the `.output' Report
b1cc23c4 182
c373bf8b 183 When instructed to generate a `.output' file including lookahead sets
88c78747
JD
184 (using `--report=lookahead', for example), Bison now prints each reduction's
185 lookahead set only next to the associated state's one item that (1) is
186 associated with the same rule as the reduction and (2) has its dot at the end
187 of its RHS. Previously, Bison also erroneously printed the lookahead set
188 next to all of the state's other items associated with the same rule. This
189 bug affected only the `.output' file and not the generated parser source
190 code.
191
402b123d 192** --report-file=FILE is a new option to override the default `.output' file
59da312b 193 name.
1bb2bd75 194
402b123d 195** The `=' that used to be required in the following directives is now
02975b9a
JD
196 deprecated:
197
198 %file-prefix "parser"
199 %name-prefix "c_"
200 %output "parser.c"
201
402b123d 202** An Alternative to `%{...%}' -- `%code QUALIFIER {CODE}'
c373bf8b
JD
203
204 Bison 2.3a provided a new set of directives as a more flexible alternative to
8e0a5e9e
JD
205 the traditional Yacc prologue blocks. Those have now been consolidated into
206 a single %code directive with an optional qualifier field, which identifies
207 the purpose of the code and thus the location(s) where Bison should generate
208 it:
209
16dc6a9e
JD
210 1. `%code {CODE}' replaces `%after-header {CODE}'
211 2. `%code requires {CODE}' replaces `%start-header {CODE}'
212 3. `%code provides {CODE}' replaces `%end-header {CODE}'
213 4. `%code top {CODE}' replaces `%before-header {CODE}'
8e0a5e9e 214
61fee93e
JD
215 See the %code entries in section `Bison Declaration Summary' in the Bison
216 manual for a summary of the new functionality. See the new section `Prologue
8e0a5e9e
JD
217 Alternatives' for a detailed discussion including the advantages of %code
218 over the traditional Yacc prologues.
219
220 The prologue alternatives are experimental. More user feedback will help to
221 determine whether they should become permanent features.
222
402b123d 223** Revised warning: unset or unused mid-rule values
17bd8a73
JD
224
225 Since Bison 2.2, Bison has warned about mid-rule values that are set but not
226 used within any of the actions of the parent rule. For example, Bison warns
227 about unused $2 in:
228
229 exp: '1' { $$ = 1; } '+' exp { $$ = $1 + $4; };
230
231 Now, Bison also warns about mid-rule values that are used but not set. For
232 example, Bison warns about unset $$ in the mid-rule action in:
233
234 exp: '1' { $1 = 1; } '+' exp { $$ = $2 + $4; };
235
236 However, Bison now disables both of these warnings by default since they
237 sometimes prove to be false alarms in existing grammars employing the Yacc
238 constructs $0 or $-N (where N is some positive integer).
239
59da312b 240 To enable these warnings, specify the option `--warnings=midrule-values' or
17bd8a73
JD
241 `-W', which is a synonym for `--warnings=all'.
242
402b123d 243** Default %destructor or %printer with `<*>' or `<>'
c373bf8b
JD
244
245 Bison now recognizes two separate kinds of default %destructor's and
12e35840
JD
246 %printer's:
247
248 1. Place `<*>' in a %destructor/%printer symbol list to define a default
249 %destructor/%printer for all grammar symbols for which you have formally
250 declared semantic type tags.
251
3ebecc24 252 2. Place `<>' in a %destructor/%printer symbol list to define a default
12e35840
JD
253 %destructor/%printer for all grammar symbols without declared semantic
254 type tags.
255
256 Bison no longer supports the `%symbol-default' notation from Bison 2.3a.
3ebecc24 257 `<*>' and `<>' combined achieve the same effect with one exception: Bison no
12e35840
JD
258 longer applies any %destructor to a mid-rule value if that mid-rule value is
259 not actually ever referenced using either $$ or $n in a semantic action.
260
85894313
JD
261 The default %destructor's and %printer's are experimental. More user
262 feedback will help to determine whether they should become permanent
263 features.
264
12e35840
JD
265 See the section `Freeing Discarded Symbols' in the Bison manual for further
266 details.
267
402b123d 268** %left, %right, and %nonassoc can now declare token numbers. This is required
ab7f29f8
JD
269 by POSIX. However, see the end of section `Operator Precedence' in the Bison
270 manual for a caveat concerning the treatment of literal strings.
271
402b123d 272** The nonfunctional --no-parser, -n, and %no-parser options have been
b1cc23c4
JD
273 completely removed from Bison.
274
402b123d 275* Changes in version 2.3a, 2006-09-13:
742e4900 276
402b123d 277** Instead of %union, you can define and use your own union type
ddc8ede1
PE
278 YYSTYPE if your grammar contains at least one <type> tag.
279 Your YYSTYPE need not be a macro; it can be a typedef.
280 This change is for compatibility with other Yacc implementations,
281 and is required by POSIX.
282
402b123d 283** Locations columns and lines start at 1.
cd48d21d
AD
284 In accordance with the GNU Coding Standards and Emacs.
285
402b123d 286** You may now declare per-type and default %destructor's and %printer's:
ec5479ce
JD
287
288 For example:
289
b2a0b7ca
JD
290 %union { char *string; }
291 %token <string> STRING1
292 %token <string> STRING2
293 %type <string> string1
294 %type <string> string2
295 %union { char character; }
296 %token <character> CHR
297 %type <character> chr
298 %destructor { free ($$); } %symbol-default
299 %destructor { free ($$); printf ("%d", @$.first_line); } STRING1 string1
300 %destructor { } <character>
301
302 guarantees that, when the parser discards any user-defined symbol that has a
303 semantic type tag other than `<character>', it passes its semantic value to
304 `free'. However, when the parser discards a `STRING1' or a `string1', it
305 also prints its line number to `stdout'. It performs only the second
306 `%destructor' in this case, so it invokes `free' only once.
ec5479ce 307
85894313
JD
308 [Although we failed to mention this here in the 2.3a release, the default
309 %destructor's and %printer's were experimental, and they were rewritten in
310 future versions.]
311
402b123d 312** Except for LALR(1) parsers in C with POSIX Yacc emulation enabled (with `-y',
b931235e
JD
313 `--yacc', or `%yacc'), Bison no longer generates #define statements for
314 associating token numbers with token names. Removing the #define statements
315 helps to sanitize the global namespace during preprocessing, but POSIX Yacc
316 requires them. Bison still generates an enum for token names in all cases.
317
402b123d 318** Handling of traditional Yacc prologue blocks is now more consistent but
34f98f46 319 potentially incompatible with previous releases of Bison.
9bc0dd67
JD
320
321 As before, you declare prologue blocks in your grammar file with the
322 `%{ ... %}' syntax. To generate the pre-prologue, Bison concatenates all
34f98f46
JD
323 prologue blocks that you've declared before the first %union. To generate
324 the post-prologue, Bison concatenates all prologue blocks that you've
ddc8ede1 325 declared after the first %union.
9bc0dd67 326
34f98f46 327 Previous releases of Bison inserted the pre-prologue into both the header
9bc0dd67
JD
328 file and the code file in all cases except for LALR(1) parsers in C. In the
329 latter case, Bison inserted it only into the code file. For parsers in C++,
330 the point of insertion was before any token definitions (which associate
331 token numbers with names). For parsers in C, the point of insertion was
332 after the token definitions.
333
334 Now, Bison never inserts the pre-prologue into the header file. In the code
335 file, it always inserts it before the token definitions.
336
402b123d 337** Bison now provides a more flexible alternative to the traditional Yacc
34f98f46
JD
338 prologue blocks: %before-header, %start-header, %end-header, and
339 %after-header.
340
341 For example, the following declaration order in the grammar file reflects the
342 order in which Bison will output these code blocks. However, you are free to
343 declare these code blocks in your grammar file in whatever order is most
344 convenient for you:
345
346 %before-header {
347 /* Bison treats this block like a pre-prologue block: it inserts it into
348 * the code file before the contents of the header file. It does *not*
349 * insert it into the header file. This is a good place to put
350 * #include's that you want at the top of your code file. A common
351 * example is `#include "system.h"'. */
352 }
353 %start-header {
354 /* Bison inserts this block into both the header file and the code file.
355 * In both files, the point of insertion is before any Bison-generated
356 * token, semantic type, location type, and class definitions. This is a
357 * good place to define %union dependencies, for example. */
9bc0dd67
JD
358 }
359 %union {
34f98f46
JD
360 /* Unlike the traditional Yacc prologue blocks, the output order for the
361 * new %*-header blocks is not affected by their declaration position
362 * relative to any %union in the grammar file. */
9bc0dd67 363 }
34f98f46
JD
364 %end-header {
365 /* Bison inserts this block into both the header file and the code file.
366 * In both files, the point of insertion is after the Bison-generated
367 * definitions. This is a good place to declare or define public
368 * functions or data structures that depend on the Bison-generated
369 * definitions. */
9bc0dd67 370 }
34f98f46
JD
371 %after-header {
372 /* Bison treats this block like a post-prologue block: it inserts it into
373 * the code file after the contents of the header file. It does *not*
374 * insert it into the header file. This is a good place to declare or
375 * define internal functions or data structures that depend on the
376 * Bison-generated definitions. */
377 }
378
379 If you have multiple occurrences of any one of the above declarations, Bison
380 will concatenate the contents in declaration order.
9bc0dd67 381
85894313
JD
382 [Although we failed to mention this here in the 2.3a release, the prologue
383 alternatives were experimental, and they were rewritten in future versions.]
384
402b123d 385** The option `--report=look-ahead' has been changed to `--report=lookahead'.
9e6e7ed2
PE
386 The old spelling still works, but is not documented and may be removed
387 in a future release.
742e4900 388
402b123d 389* Changes in version 2.3, 2006-06-05:
4ad3ed84 390
402b123d 391** GLR grammars should now use `YYRECOVERING ()' instead of `YYRECOVERING',
4ad3ed84
PE
392 for compatibility with LALR(1) grammars.
393
402b123d 394** It is now documented that any definition of YYSTYPE or YYLTYPE should
4ad3ed84
PE
395 be to a type name that does not contain parentheses or brackets.
396
402b123d 397* Changes in version 2.2, 2006-05-19:
193d7c70 398
402b123d 399** The distribution terms for all Bison-generated parsers now permit
193d7c70
PE
400 using the parsers in nonfree programs. Previously, this permission
401 was granted only for Bison-generated LALR(1) parsers in C.
5f4236a0 402
402b123d 403** %name-prefix changes the namespace name in C++ outputs.
aa08666d 404
402b123d 405** The C++ parsers export their token_type.
5f4236a0 406
402b123d 407** Bison now allows multiple %union declarations, and concatenates
d6ca7905
PE
408 their contents together.
409
402b123d 410** New warning: unused values
4d7bc38c
PE
411 Right-hand side symbols whose values are not used are reported,
412 if the symbols have destructors. For instance:
affac613 413
8f3596a6 414 exp: exp "?" exp ":" exp { $1 ? $1 : $3; }
721be13c
PE
415 | exp "+" exp
416 ;
affac613 417
8f3596a6
AD
418 will trigger a warning about $$ and $5 in the first rule, and $3 in
419 the second ($1 is copied to $$ by the default rule). This example
4e26c69e 420 most likely contains three errors, and could be rewritten as:
affac613 421
4e26c69e
PE
422 exp: exp "?" exp ":" exp
423 { $$ = $1 ? $3 : $5; free ($1 ? $5 : $3); free ($1); }
424 | exp "+" exp
425 { $$ = $1 ? $1 : $3; if ($1) free ($3); }
721be13c 426 ;
affac613 427
4e26c69e
PE
428 However, if the original actions were really intended, memory leaks
429 and all, the warnings can be suppressed by letting Bison believe the
430 values are used, e.g.:
721be13c 431
8f3596a6 432 exp: exp "?" exp ":" exp { $1 ? $1 : $3; (void) ($$, $5); }
721be13c
PE
433 | exp "+" exp { $$ = $1; (void) $3; }
434 ;
435
84866159
AD
436 If there are mid-rule actions, the warning is issued if no action
437 uses it. The following triggers no warning: $1 and $3 are used.
438
439 exp: exp { push ($1); } '+' exp { push ($3); sum (); };
440
721be13c
PE
441 The warning is intended to help catching lost values and memory leaks.
442 If a value is ignored, its associated memory typically is not reclaimed.
affac613 443
402b123d 444** %destructor vs. YYABORT, YYACCEPT, and YYERROR.
9d9b8b70
PE
445 Destructors are now called when user code invokes YYABORT, YYACCEPT,
446 and YYERROR, for all objects on the stack, other than objects
447 corresponding to the right-hand side of the current rule.
a85284cf 448
402b123d 449** %expect, %expect-rr
035aa4a0
PE
450 Incorrect numbers of expected conflicts are now actual errors,
451 instead of warnings.
452
402b123d 453** GLR, YACC parsers.
4e26c69e
PE
454 The %parse-params are available in the destructors (and the
455 experimental printers) as per the documentation.
4b367315 456
402b123d 457** Bison now warns if it finds a stray `$' or `@' in an action.
ad6a9b97 458
402b123d 459** %require "VERSION"
4e26c69e
PE
460 This specifies that the grammar file depends on features implemented
461 in Bison version VERSION or higher.
b50d2359 462
402b123d 463** lalr1.cc: The token and value types are now class members.
e14d0ab6
AD
464 The tokens were defined as free form enums and cpp macros. YYSTYPE
465 was defined as a free form union. They are now class members:
fb9712a9
AD
466 tokens are enumerations of the `yy::parser::token' struct, and the
467 semantic values have the `yy::parser::semantic_type' type.
468
469 If you do not want or can update to this scheme, the directive
470 `%define "global_tokens_and_yystype" "1"' triggers the global
b50d2359
AD
471 definition of tokens and YYSTYPE. This change is suitable both
472 for previous releases of Bison, and this one.
fb9712a9 473
b50d2359 474 If you wish to update, then make sure older version of Bison will
ab8d9dc5 475 fail using `%require "2.2"'.
fb9712a9 476
402b123d 477** DJGPP support added.
193d7c70 478\f
402b123d 479* Changes in version 2.1, 2005-09-16:
1ce59070 480
402b123d 481** The C++ lalr1.cc skeleton supports %lex-param.
e14d0ab6 482
402b123d 483** Bison-generated parsers now support the translation of diagnostics like
baf785db
PE
484 "syntax error" into languages other than English. The default
485 language is still English. For details, please see the new
0410a6e0
PE
486 Internationalization section of the Bison manual. Software
487 distributors should also see the new PACKAGING file. Thanks to
488 Bruno Haible for this new feature.
1ce59070 489
402b123d 490** Wording in the Bison-generated parsers has been changed slightly to
1a059451
PE
491 simplify translation. In particular, the message "memory exhausted"
492 has replaced "parser stack overflow", as the old message was not
493 always accurate for modern Bison-generated parsers.
494
402b123d 495** Destructors are now called when the parser aborts, for all symbols left
258b75ca
PE
496 behind on the stack. Also, the start symbol is now destroyed after a
497 successful parse. In both cases, the behavior was formerly inconsistent.
498
402b123d 499** When generating verbose diagnostics, Bison-generated parsers no longer
72f000b0
PE
500 quote the literal strings associated with tokens. For example, for
501 a syntax error associated with '%token NUM "number"' they might
502 print 'syntax error, unexpected number' instead of 'syntax error,
503 unexpected "number"'.
193d7c70 504\f
402b123d 505* Changes in version 2.0, 2004-12-25:
efeed023 506
402b123d 507** Possibly-incompatible changes
d7e14fc0 508
82de6b0d
PE
509 - Bison-generated parsers no longer default to using the alloca function
510 (when available) to extend the parser stack, due to widespread
511 problems in unchecked stack-overflow detection. You can "#define
512 YYSTACK_USE_ALLOCA 1" to require the use of alloca, but please read
513 the manual to determine safe values for YYMAXDEPTH in that case.
8dd162d3 514
82de6b0d
PE
515 - Error token location.
516 During error recovery, the location of the syntax error is updated
517 to cover the whole sequence covered by the error token: it includes
518 the shifted symbols thrown away during the first part of the error
519 recovery, and the lookahead rejected during the second part.
18d192f0 520
82de6b0d
PE
521 - Semicolon changes:
522 . Stray semicolons are no longer allowed at the start of a grammar.
523 . Semicolons are now required after in-grammar declarations.
e342c3be 524
82de6b0d
PE
525 - Unescaped newlines are no longer allowed in character constants or
526 string literals. They were never portable, and GCC 3.4.0 has
527 dropped support for them. Better diagnostics are now generated if
528 forget a closing quote.
8dd162d3 529
82de6b0d 530 - NUL bytes are no longer allowed in Bison string literals, unfortunately.
f74b6f91 531
402b123d 532** New features
1452af69 533
82de6b0d 534 - GLR grammars now support locations.
4febdd96 535
82de6b0d
PE
536 - New directive: %initial-action.
537 This directive allows the user to run arbitrary code (including
538 initializing @$) from yyparse before parsing starts.
1452af69 539
82de6b0d
PE
540 - A new directive "%expect-rr N" specifies the expected number of
541 reduce/reduce conflicts in GLR parsers.
1452af69 542
82de6b0d
PE
543 - %token numbers can now be hexadecimal integers, e.g., `%token FOO 0x12d'.
544 This is a GNU extension.
4febdd96 545
82de6b0d 546 - The option `--report=lookahead' was changed to `--report=look-ahead'.
9e6e7ed2 547 [However, this was changed back after 2.3.]
1452af69 548
82de6b0d 549 - Experimental %destructor support has been added to lalr1.cc.
1452af69 550
82de6b0d
PE
551 - New configure option --disable-yacc, to disable installation of the
552 yacc command and -ly library introduced in 1.875 for POSIX conformance.
6040d338 553
402b123d 554** Bug fixes
d5a3fe37 555
82de6b0d
PE
556 - For now, %expect-count violations are now just warnings, not errors.
557 This is for compatibility with Bison 1.75 and earlier (when there are
558 reduce/reduce conflicts) and with Bison 1.30 and earlier (when there
559 are too many or too few shift/reduce conflicts). However, in future
560 versions of Bison we plan to improve the %expect machinery so that
561 these violations will become errors again.
3473d0f8 562
82de6b0d
PE
563 - Within Bison itself, numbers (e.g., goto numbers) are no longer
564 arbitrarily limited to 16-bit counts.
d600ee67 565
82de6b0d 566 - Semicolons are now allowed before "|" in grammar rules, as POSIX requires.
d600ee67 567\f
402b123d 568* Changes in version 1.875, 2003-01-01:
963fcc17 569
402b123d 570** The documentation license has been upgraded to version 1.2
dc546b0f 571 of the GNU Free Documentation License.
75eb3bc4 572
402b123d 573** syntax error processing
75eb3bc4 574
dc546b0f
PE
575 - In Yacc-style parsers YYLLOC_DEFAULT is now used to compute error
576 locations too. This fixes bugs in error-location computation.
75eb3bc4 577
dc546b0f
PE
578 - %destructor
579 It is now possible to reclaim the memory associated to symbols
580 discarded during error recovery. This feature is still experimental.
20daca06 581
dc546b0f
PE
582 - %error-verbose
583 This new directive is preferred over YYERROR_VERBOSE.
74724a70 584
dc546b0f
PE
585 - #defining yyerror to steal internal variables is discouraged.
586 It is not guaranteed to work forever.
d1de5372 587
402b123d 588** POSIX conformance
d1de5372 589
dc546b0f
PE
590 - Semicolons are once again optional at the end of grammar rules.
591 This reverts to the behavior of Bison 1.33 and earlier, and improves
592 compatibility with Yacc.
74724a70 593
dc546b0f
PE
594 - `parse error' -> `syntax error'
595 Bison now uniformly uses the term `syntax error'; formerly, the code
596 and manual sometimes used the term `parse error' instead. POSIX
597 requires `syntax error' in diagnostics, and it was thought better to
598 be consistent.
74724a70 599
dc546b0f
PE
600 - The documentation now emphasizes that yylex and yyerror must be
601 declared before use. C99 requires this.
d1de5372 602
dc546b0f
PE
603 - Bison now parses C99 lexical constructs like UCNs and
604 backslash-newline within C escape sequences, as POSIX 1003.1-2001 requires.
d1de5372 605
dc546b0f
PE
606 - File names are properly escaped in C output. E.g., foo\bar.y is
607 output as "foo\\bar.y".
6780ca7a 608
dc546b0f
PE
609 - Yacc command and library now available
610 The Bison distribution now installs a `yacc' command, as POSIX requires.
611 Also, Bison now installs a small library liby.a containing
612 implementations of Yacc-compatible yyerror and main functions.
613 This library is normally not useful, but POSIX requires it.
6e649e65 614
dc546b0f 615 - Type clashes now generate warnings, not errors.
6e649e65 616
dc546b0f
PE
617 - If the user does not define YYSTYPE as a macro, Bison now declares it
618 using typedef instead of defining it as a macro.
619 For consistency, YYLTYPE is also declared instead of defined.
9501dc6e 620
402b123d 621** Other compatibility issues
886a425c 622
dc546b0f
PE
623 - %union directives can now have a tag before the `{', e.g., the
624 directive `%union foo {...}' now generates the C code
625 `typedef union foo { ... } YYSTYPE;'; this is for Yacc compatibility.
626 The default union tag is `YYSTYPE', for compatibility with Solaris 9 Yacc.
627 For consistency, YYLTYPE's struct tag is now `YYLTYPE' not `yyltype'.
628 This is for compatibility with both Yacc and Bison 1.35.
72f889cc 629
dc546b0f
PE
630 - `;' is output before the terminating `}' of an action, for
631 compatibility with Bison 1.35.
886a425c 632
dc546b0f
PE
633 - Bison now uses a Yacc-style format for conflict reports, e.g.,
634 `conflicts: 2 shift/reduce, 1 reduce/reduce'.
437c2d80 635
dc546b0f
PE
636 - `yystype' and `yyltype' are now obsolescent macros instead of being
637 typedefs or tags; they are no longer documented and are planned to be
638 withdrawn in a future release.
2a8d363a 639
402b123d 640** GLR parser notes
2a8d363a 641
dc546b0f
PE
642 - GLR and inline
643 Users of Bison have to decide how they handle the portability of the
644 C keyword `inline'.
959e5f51 645
dc546b0f
PE
646 - `parsing stack overflow...' -> `parser stack overflow'
647 GLR parsers now report `parser stack overflow' as per the Bison manual.
900c5db5 648
402b123d 649** Bison now warns if it detects conflicting outputs to the same file,
dc546b0f
PE
650 e.g., it generates a warning for `bison -d -o foo.h foo.y' since
651 that command outputs both code and header to foo.h.
6e40b4eb 652
402b123d 653** #line in output files
dc546b0f 654 - --no-line works properly.
6e40b4eb 655
402b123d 656** Bison can no longer be built by a K&R C compiler; it requires C89 or
6e40b4eb
AD
657 later to be built. This change originally took place a few versions
658 ago, but nobody noticed until we recently asked someone to try
659 building Bison with a K&R C compiler.
d600ee67 660\f
402b123d 661* Changes in version 1.75, 2002-10-14:
7933f2b5 662
402b123d 663** Bison should now work on 64-bit hosts.
7933f2b5 664
402b123d 665** Indonesian translation thanks to Tedi Heriyanto.
7933f2b5 666
402b123d 667** GLR parsers
f50adbbd
AD
668 Fix spurious parse errors.
669
402b123d 670** Pure parsers
f50adbbd
AD
671 Some people redefine yyerror to steal yyparse' private variables.
672 Reenable this trick until an official feature replaces it.
673
402b123d 674** Type Clashes
d90c934c
AD
675 In agreement with POSIX and with other Yaccs, leaving a default
676 action is valid when $$ is untyped, and $1 typed:
677
678 untyped: ... typed;
679
680 but the converse remains an error:
681
682 typed: ... untyped;
683
402b123d 684** Values of mid-rule actions
d90c934c
AD
685 The following code:
686
687 foo: { ... } { $$ = $1; } ...
688
689 was incorrectly rejected: $1 is defined in the second mid-rule
690 action, and is equal to the $$ of the first mid-rule action.
d600ee67 691\f
402b123d 692* Changes in version 1.50, 2002-10-04:
adc8c848 693
402b123d 694** GLR parsing
676385e2
PH
695 The declaration
696 %glr-parser
697 causes Bison to produce a Generalized LR (GLR) parser, capable of handling
698 almost any context-free grammar, ambiguous or not. The new declarations
e8832397 699 %dprec and %merge on grammar rules allow parse-time resolution of
676385e2
PH
700 ambiguities. Contributed by Paul Hilfinger.
701
7933f2b5 702 Unfortunately Bison 1.50 does not work properly on 64-bit hosts
420f93c8
PE
703 like the Alpha, so please stick to 32-bit hosts for now.
704
402b123d 705** Output Directory
8c165d89 706 When not in Yacc compatibility mode, when the output file was not
e88dbdbf 707 specified, running `bison foo/bar.y' created `foo/bar.c'. It
8c165d89
AD
708 now creates `bar.c'.
709
402b123d 710** Undefined token
007a50a4 711 The undefined token was systematically mapped to 2 which prevented
e88dbdbf 712 the use of 2 by the user. This is no longer the case.
007a50a4 713
402b123d 714** Unknown token numbers
e88dbdbf 715 If yylex returned an out of range value, yyparse could die. This is
007a50a4
AD
716 no longer the case.
717
402b123d 718** Error token
e88dbdbf 719 According to POSIX, the error token must be 256.
23c5a174
AD
720 Bison extends this requirement by making it a preference: *if* the
721 user specified that one of her tokens is numbered 256, then error
722 will be mapped onto another number.
723
402b123d 724** Verbose error messages
e88dbdbf 725 They no longer report `..., expecting error or...' for states where
217598da
AD
726 error recovery is possible.
727
402b123d 728** End token
217598da
AD
729 Defaults to `$end' instead of `$'.
730
402b123d 731** Error recovery now conforms to documentation and to POSIX
68cd8af3
PE
732 When a Bison-generated parser encounters a syntax error, it now pops
733 the stack until it finds a state that allows shifting the error
734 token. Formerly, it popped the stack until it found a state that
735 allowed some non-error action other than a default reduction on the
736 error token. The new behavior has long been the documented behavior,
737 and has long been required by POSIX. For more details, please see
337116ba
PE
738 Paul Eggert, "Reductions during Bison error handling" (2002-05-20)
739 <http://lists.gnu.org/archive/html/bug-bison/2002-05/msg00038.html>.
68cd8af3 740
402b123d 741** Traces
5504898e
AD
742 Popped tokens and nonterminals are now reported.
743
402b123d 744** Larger grammars
a861a339
PE
745 Larger grammars are now supported (larger token numbers, larger grammar
746 size (= sum of the LHS and RHS lengths), larger LALR tables).
747 Formerly, many of these numbers ran afoul of 16-bit limits;
748 now these limits are 32 bits on most hosts.
355e7c1c 749
402b123d 750** Explicit initial rule
643a5994
AD
751 Bison used to play hacks with the initial rule, which the user does
752 not write. It is now explicit, and visible in the reports and
753 graphs as rule 0.
23c5a174 754
402b123d 755** Useless rules
643a5994 756 Before, Bison reported the useless rules, but, although not used,
77714df2 757 included them in the parsers. They are now actually removed.
23c5a174 758
402b123d 759** Useless rules, useless nonterminals
6b98e4b5
AD
760 They are now reported, as a warning, with their locations.
761
402b123d 762** Rules never reduced
e8832397
AD
763 Rules that can never be reduced because of conflicts are now
764 reported.
765
402b123d 766** Incorrect `Token not used'
11652ab3
AD
767 On a grammar such as
768
769 %token useless useful
770 %%
771 exp: '0' %prec useful;
772
773 where a token was used to set the precedence of the last rule,
774 bison reported both `useful' and `useless' as useless tokens.
775
402b123d 776** Revert the C++ namespace changes introduced in 1.31
77714df2 777 as they caused too many portability hassles.
0179dd65 778
402b123d 779** Default locations
b2d52318
AD
780 By an accident of design, the default computation of @$ was
781 performed after another default computation was performed: @$ = @1.
782 The latter is now removed: YYLLOC_DEFAULT is fully responsible of
783 the computation of @$.
adc8c848 784
402b123d 785** Token end-of-file
b7c49edf
AD
786 The token end of file may be specified by the user, in which case,
787 the user symbol is used in the reports, the graphs, and the verbose
a861a339 788 error messages instead of `$end', which remains being the default.
b7c49edf 789 For instance
7bd6c77e 790 %token MYEOF 0
b7c49edf 791 or
7bd6c77e 792 %token MYEOF 0 "end of file"
fdbcd8e2 793
402b123d 794** Semantic parser
fdbcd8e2
AD
795 This old option, which has been broken for ages, is removed.
796
402b123d 797** New translations
a861a339 798 Brazilian Portuguese, thanks to Alexandre Folle de Menezes.
84614e13
AD
799 Croatian, thanks to Denis Lackovic.
800
402b123d 801** Incorrect token definitions
e88dbdbf 802 When given `%token 'a' "A"', Bison used to output `#define 'a' 65'.
b87f8b21 803
402b123d 804** Token definitions as enums
77714df2
AD
805 Tokens are output both as the traditional #define's, and, provided
806 the compiler supports ANSI C or is a C++ compiler, as enums.
e88dbdbf 807 This lets debuggers display names instead of integers.
77714df2 808
402b123d 809** Reports
ec3bc396
AD
810 In addition to --verbose, bison supports --report=THINGS, which
811 produces additional information:
b408954b
AD
812 - itemset
813 complete the core item sets with their closure
9e6e7ed2
PE
814 - lookahead [changed to `look-ahead' in 1.875e through 2.3, but changed back]
815 explicitly associate lookahead tokens to items
b408954b
AD
816 - solved
817 describe shift/reduce conflicts solving.
818 Bison used to systematically output this information on top of
819 the report. Solved conflicts are now attached to their states.
ec3bc396 820
402b123d 821** Type clashes
9af3fbce
AD
822 Previous versions don't complain when there is a type clash on
823 the default action if the rule has a mid-rule action, such as in:
824
825 %type <foo> bar
826 %%
827 bar: '0' {} '0';
828
829 This is fixed.
a861a339 830
402b123d 831** GNU M4 is now required when using Bison.
f987e9d2 832\f
402b123d 833* Changes in version 1.35, 2002-03-25:
76551463 834
402b123d 835** C Skeleton
76551463
AD
836 Some projects use Bison's C parser with C++ compilers, and define
837 YYSTYPE as a class. The recent adjustment of C parsers for data
838 alignment and 64 bit architectures made this impossible.
839
840 Because for the time being no real solution for C++ parser
841 generation exists, kludges were implemented in the parser to
842 maintain this use. In the future, when Bison has C++ parsers, this
843 kludge will be disabled.
844
845 This kludge also addresses some C++ problems when the stack was
846 extended.
76551463 847\f
402b123d 848* Changes in version 1.34, 2002-03-12:
76551463 849
402b123d 850** File name clashes are detected
76551463
AD
851 $ bison foo.y -d -o foo.x
852 fatal error: header and parser would both be named `foo.x'
853
402b123d 854** A missing `;' at the end of a rule triggers a warning
76551463
AD
855 In accordance with POSIX, and in agreement with other
856 Yacc implementations, Bison will mandate this semicolon in the near
857 future. This eases the implementation of a Bison parser of Bison
858 grammars by making this grammar LALR(1) instead of LR(2). To
859 facilitate the transition, this release introduces a warning.
860
402b123d 861** Revert the C++ namespace changes introduced in 1.31, as they caused too
76551463
AD
862 many portability hassles.
863
402b123d 864** DJGPP support added.
76551463 865
402b123d 866** Fix test suite portability problems.
76551463 867\f
402b123d 868* Changes in version 1.33, 2002-02-07:
76551463 869
402b123d 870** Fix C++ issues
76551463
AD
871 Groff could not be compiled for the definition of size_t was lacking
872 under some conditions.
873
402b123d 874** Catch invalid @n
76551463
AD
875 As is done with $n.
876\f
402b123d 877* Changes in version 1.32, 2002-01-23:
76551463 878
402b123d 879** Fix Yacc output file names
76551463 880
402b123d 881** Portability fixes
76551463 882
402b123d 883** Italian, Dutch translations
76551463 884\f
402b123d 885* Changes in version 1.31, 2002-01-14:
52d1aeee 886
402b123d 887** Many Bug Fixes
52d1aeee 888
402b123d 889** GNU Gettext and %expect
52d1aeee
MA
890 GNU Gettext asserts 10 s/r conflicts, but there are 7. Now that
891 Bison dies on incorrect %expectations, we fear there will be
892 too many bug reports for Gettext, so _for the time being_, %expect
893 does not trigger an error when the input file is named `plural.y'.
894
402b123d 895** Use of alloca in parsers
52d1aeee
MA
896 If YYSTACK_USE_ALLOCA is defined to 0, then the parsers will use
897 malloc exclusively. Since 1.29, but was not NEWS'ed.
898
899 alloca is used only when compiled with GCC, to avoid portability
900 problems as on AIX.
901
402b123d 902** yyparse now returns 2 if memory is exhausted; formerly it dumped core.
b47dbebe 903
402b123d 904** When the generated parser lacks debugging code, YYDEBUG is now 0
52d1aeee
MA
905 (as POSIX requires) instead of being undefined.
906
402b123d 907** User Actions
52d1aeee
MA
908 Bison has always permitted actions such as { $$ = $1 }: it adds the
909 ending semicolon. Now if in Yacc compatibility mode, the semicolon
910 is no longer output: one has to write { $$ = $1; }.
911
402b123d 912** Better C++ compliance
52d1aeee 913 The output parsers try to respect C++ namespaces.
76551463 914 [This turned out to be a failed experiment, and it was reverted later.]
52d1aeee 915
402b123d 916** Reduced Grammars
52d1aeee
MA
917 Fixed bugs when reporting useless nonterminals.
918
402b123d 919** 64 bit hosts
52d1aeee
MA
920 The parsers work properly on 64 bit hosts.
921
402b123d 922** Error messages
52d1aeee
MA
923 Some calls to strerror resulted in scrambled or missing error messages.
924
402b123d 925** %expect
52d1aeee
MA
926 When the number of shift/reduce conflicts is correct, don't issue
927 any warning.
928
402b123d 929** The verbose report includes the rule line numbers.
52d1aeee 930
402b123d 931** Rule line numbers are fixed in traces.
52d1aeee 932
402b123d 933** Swedish translation
52d1aeee 934
402b123d 935** Parse errors
52d1aeee
MA
936 Verbose parse error messages from the parsers are better looking.
937 Before: parse error: unexpected `'/'', expecting `"number"' or `'-'' or `'(''
938 Now: parse error: unexpected '/', expecting "number" or '-' or '('
939
402b123d 940** Fixed parser memory leaks.
52d1aeee
MA
941 When the generated parser was using malloc to extend its stacks, the
942 previous allocations were not freed.
943
402b123d 944** Fixed verbose output file.
52d1aeee
MA
945 Some newlines were missing.
946 Some conflicts in state descriptions were missing.
947
402b123d 948** Fixed conflict report.
52d1aeee
MA
949 Option -v was needed to get the result.
950
402b123d 951** %expect
52d1aeee
MA
952 Was not used.
953 Mismatches are errors, not warnings.
954
402b123d 955** Fixed incorrect processing of some invalid input.
52d1aeee 956
402b123d 957** Fixed CPP guards: 9foo.h uses BISON_9FOO_H instead of 9FOO_H.
52d1aeee 958
402b123d 959** Fixed some typos in the documentation.
52d1aeee 960
402b123d 961** %token MY_EOF 0 is supported.
52d1aeee
MA
962 Before, MY_EOF was silently renumbered as 257.
963
402b123d 964** doc/refcard.tex is updated.
52d1aeee 965
402b123d 966** %output, %file-prefix, %name-prefix.
52d1aeee
MA
967 New.
968
402b123d 969** --output
52d1aeee
MA
970 New, aliasing `--output-file'.
971\f
402b123d 972* Changes in version 1.30, 2001-10-26:
342b8b6e 973
402b123d 974** `--defines' and `--graph' have now an optional argument which is the
fdac0091 975 output file name. `-d' and `-g' do not change; they do not take any
342b8b6e
AD
976 argument.
977
402b123d 978** `%source_extension' and `%header_extension' are removed, failed
342b8b6e
AD
979 experiment.
980
402b123d 981** Portability fixes.
f987e9d2 982\f
402b123d 983* Changes in version 1.29, 2001-09-07:
342b8b6e 984
402b123d 985** The output file does not define const, as this caused problems when used
342b8b6e
AD
986 with common autoconfiguration schemes. If you still use ancient compilers
987 that lack const, compile with the equivalent of the C compiler option
988 `-Dconst='. autoconf's AC_C_CONST macro provides one way to do this.
989
402b123d 990** Added `-g' and `--graph'.
f87a2205 991
402b123d 992** The Bison manual is now distributed under the terms of the GNU FDL.
f2b5126e 993
402b123d 994** The input and the output files has automatically a similar extension.
234a3be3 995
402b123d 996** Russian translation added.
f87a2205 997
402b123d 998** NLS support updated; should hopefully be less troublesome.
f87a2205 999
402b123d 1000** Added the old Bison reference card.
c33638bb 1001
402b123d 1002** Added `--locations' and `%locations'.
6deb4447 1003
402b123d 1004** Added `-S' and `--skeleton'.
cd5bd6ac 1005
402b123d 1006** `%raw', `-r', `--raw' is disabled.
62ab6972 1007
402b123d 1008** Special characters are escaped when output. This solves the problems
cd5bd6ac
AD
1009 of the #line lines with path names including backslashes.
1010
402b123d 1011** New directives.
4ecbf796
MA
1012 `%yacc', `%fixed_output_files', `%defines', `%no_parser', `%verbose',
1013 `%debug', `%source_extension' and `%header_extension'.
f987e9d2 1014
402b123d 1015** @$
f987e9d2 1016 Automatic location tracking.
f87a2205 1017\f
402b123d 1018* Changes in version 1.28, 1999-07-06:
d2e00347 1019
402b123d 1020** Should compile better now with K&R compilers.
d2e00347 1021
402b123d 1022** Added NLS.
d2e00347 1023
402b123d 1024** Fixed a problem with escaping the double quote character.
d2e00347 1025
402b123d 1026** There is now a FAQ.
d2e00347 1027\f
402b123d 1028* Changes in version 1.27:
5c31c3c2 1029
402b123d 1030** The make rule which prevented bison.simple from being created on
5c31c3c2
JT
1031 some systems has been fixed.
1032\f
402b123d 1033* Changes in version 1.26:
4be07551 1034
402b123d 1035** Bison now uses automake.
4be07551 1036
402b123d 1037** New mailing lists: <bug-bison@gnu.org> and <help-bison@gnu.org>.
4be07551 1038
402b123d 1039** Token numbers now start at 257 as previously documented, not 258.
4be07551 1040
402b123d 1041** Bison honors the TMPDIR environment variable.
4be07551 1042
402b123d 1043** A couple of buffer overruns have been fixed.
f51dbca1 1044
402b123d 1045** Problems when closing files should now be reported.
f51dbca1 1046
402b123d 1047** Generated parsers should now work even on operating systems which do
f51dbca1 1048 not provide alloca().
4be07551 1049\f
402b123d 1050* Changes in version 1.25, 1995-10-16:
df8878c5 1051
402b123d 1052** Errors in the input grammar are not fatal; Bison keeps reading
df8878c5 1053the grammar file, and reports all the errors found in it.
8c44d3ec 1054
402b123d 1055** Tokens can now be specified as multiple-character strings: for
df8878c5
RS
1056example, you could use "<=" for a token which looks like <=, instead
1057of chosing a name like LESSEQ.
1058
402b123d 1059** The %token_table declaration says to write a table of tokens (names
df8878c5
RS
1060and numbers) into the parser file. The yylex function can use this
1061table to recognize multiple-character string tokens, or for other
1062purposes.
1063
402b123d 1064** The %no_lines declaration says not to generate any #line preprocessor
df8878c5
RS
1065directives in the parser file.
1066
402b123d 1067** The %raw declaration says to use internal Bison token numbers, not
df8878c5
RS
1068Yacc-compatible token numbers, when token names are defined as macros.
1069
402b123d 1070** The --no-parser option produces the parser tables without including
df8878c5
RS
1071the parser engine; a project can now use its own parser engine.
1072The actions go into a separate file called NAME.act, in the form of
1073a switch statement body.
1074\f
402b123d 1075* Changes in version 1.23:
6780ca7a 1076
4d019228
DM
1077The user can define YYPARSE_PARAM as the name of an argument to be
1078passed into yyparse. The argument should have type void *. It should
1079actually point to an object. Grammar actions can access the variable
1080by casting it to the proper pointer type.
6780ca7a 1081
6780ca7a 1082Line numbers in output file corrected.
6780ca7a 1083\f
402b123d 1084* Changes in version 1.22:
6780ca7a
DM
1085
1086--help option added.
6780ca7a 1087\f
402b123d 1088* Changes in version 1.20:
6780ca7a
DM
1089
1090Output file does not redefine const for C++.
9f4503d6
AD
1091
1092Local Variables:
1093mode: outline
1094End:
76551463
AD
1095
1096-----
1097
d6ca7905 1098Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
74553c98 10992004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
76551463 1100
74553c98 1101This file is part of Bison, the GNU Parser Generator.
76551463 1102
f16b0819 1103This program is free software: you can redistribute it and/or modify
76551463 1104it under the terms of the GNU General Public License as published by
f16b0819
PE
1105the Free Software Foundation, either version 3 of the License, or
1106(at your option) any later version.
76551463 1107
f16b0819 1108This program is distributed in the hope that it will be useful,
76551463
AD
1109but WITHOUT ANY WARRANTY; without even the implied warranty of
1110MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1111GNU General Public License for more details.
1112
1113You should have received a copy of the GNU General Public License
f16b0819 1114along with this program. If not, see <http://www.gnu.org/licenses/>.