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