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