4 * Changes in version ?.? (????-??-??):
6 ** Additional yylex/yyparse arguments
8 The new directive %param declare additional argument to both yylex
9 and yyparse. The %lex-param, %parse-param, and %param directives
10 support one or more arguments. Instead of
12 %lex-param {arg1_type *arg1}
13 %lex-param {arg2_type *arg2}
14 %parse-param {arg1_type *arg1}
15 %parse-param {arg2_type *arg2}
19 %param {arg1_type *arg1} {arg2_type *arg2}
21 ** Java skeleton improvements
23 The constants for token names were moved to the Lexer interface.
24 Also, it is possible to add code to the parser's constructors using
25 "%code init" and "%define init_throws".
27 ** Variable api.tokens.prefix
29 The variable api.tokens.prefix changes the way tokens are identified in
30 the generated files. This is especially useful to avoid collisions
31 with identifiers in the target language. For instance
34 %define api.tokens.prefix "TOK_"
36 start: FILE for ERROR;
38 will generate the definition of the symbols TOK_FILE, TOK_for, and
39 TOK_ERROR in the generated sources. In particular, the scanner must
40 use these prefixed token names, although the grammar itself still
41 uses the short names (as in the sample rule given above).
43 ** Variable api.namespace
45 The "namespace" variable is renamed "api.namespace". Backward
46 compatibility is ensured, but upgrading is recommended.
48 ** Variable parse.error
50 The variable error controls the verbosity of error messages. The
51 use of the %error-verbose directive is deprecated in favor of
52 %define parse.error "verbose".
54 ** Semantic predicates
56 The new, experimental, semantic-predicate feature allows actions of
57 the form %?{ BOOLEAN-EXPRESSION }, which cause syntax errors (as for
58 YYERROR) if the expression evaluates to 0, and are evaluated immediately
59 in GLR parsers, rather than being deferred. The result is that they
60 allow the programmer to prune possible parses based on the values of
63 * Changes in version 2.5 (????-??-??):
65 ** Named References Support
67 Historically, Yacc and Bison have supported positional references
68 ($n, $$) to allow access to symbol values from inside of semantic
71 Starting from this version, Bison can also accept named references.
72 When no ambiguity is possible, original symbol names may be used
75 if_stmt : 'if' cond_expr 'then' then_stmt ';'
76 { $if_stmt = mk_if_stmt($cond_expr, $then_stmt); }
78 In the more common case, explicit names may be declared:
80 stmt[res] : 'if' expr[cond] 'then' stmt[then] 'else' stmt[else] ';'
81 { $res = mk_if_stmt($cond, $then, $else); }
83 Location information is also accessible using @name syntax. When
84 accessing symbol names containing dots or dashes, explicit bracketing
85 ($[sym.1]) must be used.
87 These features are experimental in this version. More user feedback
88 will help to stabilize them.
90 ** IELR(1) and Canonical LR(1) Support
92 IELR(1) is a minimal LR(1) parser table generation algorithm. That
93 is, given any context-free grammar, IELR(1) generates parser tables
94 with the full language recognition power of canonical LR(1) but with
95 nearly the same number of parser states as LALR(1). This reduction in
96 parser states is often an order of magnitude. More importantly,
97 because canonical LR(1)'s extra parser states may contain duplicate
98 conflicts in the case of non-LR(1) grammars, the number of conflicts
99 for IELR(1) is often an order of magnitude less as well. This can
100 significantly reduce the complexity of developing of a grammar.
102 Bison can now generate IELR(1) and canonical LR(1) parser tables in
103 place of its traditional LALR(1) parser tables, which remain the
104 default. You can specify the type of parser tables in the grammar
105 file with these directives:
109 %define lr.type canonical-lr
111 The default reduction optimization in the parser tables can also be
112 adjusted using `%define lr.default-reductions'. See the documentation
113 for `%define lr.type' and `%define lr.default-reductions' in the
114 section `Bison Declaration Summary' in the Bison manual for the
117 These features are experimental. More user feedback will help to
120 ** Unrecognized %code qualifiers are now an error not a warning.
122 ** %define improvements.
124 *** Unrecognized variables are now an error not a warning.
126 *** Multiple invocations for any variable is now an error not a warning.
128 *** Can now be invoked via the command line.
130 Each of these command-line options
133 --define=NAME[=VALUE]
136 --force-define=NAME[=VALUE]
138 is equivalent to this grammar file declaration
140 %define NAME ["VALUE"]
142 except that the manner in which Bison processes multiple definitions
143 for the same NAME differs. Most importantly, -F and --force-define
144 quietly override %define, but -D and --define do not. For further
145 details, see the section "Bison Options" in the Bison manual.
147 *** Variables renamed.
149 The following %define variables
152 lr.keep_unreachable_states
157 lr.keep-unreachable-states
159 The old names are now deprecated but will be maintained indefinitely
160 for backward compatibility.
162 *** Values no longer need to be quoted in grammar file.
164 If a %define value is an identifier, it no longer needs to be placed
165 within quotations marks. For example,
167 %define api.push-pull "push"
171 %define api.push-pull push
175 Consistently with directives (such as %error-verbose) and variables
176 (e.g. push-pull), symbol names may include dashes in any position,
177 similarly to periods and underscores. This is GNU extension over
178 POSIX Yacc whose use is reported by -Wyacc, and rejected in Yacc
181 ** YYFAIL now produces warnings and Java parsers no longer implement it.
183 YYFAIL has existed for many years as an undocumented feature of
184 deterministic parsers in C generated by Bison. More recently, it was
185 a documented feature of Bison's experimental Java parsers. As
186 promised in Bison 2.4.2's NEWS entry, any appearance of YYFAIL in a
187 semantic action now produces a deprecation warning, and Java parsers
188 no longer implement YYFAIL at all. For further details, including a
189 discussion of how to suppress C preprocessor warnings about YYFAIL
190 being unused, see the Bison 2.4.2 NEWS entry.
192 ** Temporary hack for adding a semicolon to the user action.
194 Previously, Bison appended a semicolon to every user action for
195 reductions when the output language defaulted to C (specifically, when
196 neither %yacc, %language, %skeleton, or equivalent command-line
197 options were specified). This allowed actions such as
199 exp: exp "+" exp { $$ = $1 + $3 };
203 exp: exp "+" exp { $$ = $1 + $3; };
205 As a first step in removing this misfeature, Bison now issues a
206 warning when it appends a semicolon. Moreover, in cases where Bison
207 cannot easily determine whether a semicolon is needed (for example, an
208 action ending with a cpp directive or a braced compound initializer),
209 it no longer appends one. Thus, the C compiler might now complain
210 about a missing semicolon where it did not before. Future releases of
211 Bison will cease to append semicolons entirely.
213 ** Character literals not of length one.
215 Previously, Bison quietly converted all character literals to length
216 one. For example, without warning, Bison interpreted the operators in
217 the following grammar to be the same token:
223 Bison now warns when a character literal is not of length one. In
224 some future release, Bison will report an error instead.
226 ** Verbose syntax error message fixes:
228 When %error-verbose or `#define YYERROR_VERBOSE' is specified, syntax
229 error messages produced by the generated parser include the unexpected
230 token as well as a list of expected tokens. The effect of %nonassoc
231 on these verbose messages has been corrected in two ways, but
232 additional fixes are still being implemented:
234 *** When %nonassoc is used, there can exist parser states that accept no
235 tokens, and so the parser does not always require a lookahead token
236 in order to detect a syntax error. Because no unexpected token or
237 expected tokens can then be reported, the verbose syntax error
238 message described above is suppressed, and the parser instead
239 reports the simpler message, "syntax error". Previously, this
240 suppression was sometimes erroneously triggered by %nonassoc when a
241 lookahead was actually required. Now verbose messages are
242 suppressed only when all previous lookaheads have already been
243 shifted or discarded.
245 *** Previously, the list of expected tokens erroneously included tokens
246 that would actually induce a syntax error because conflicts for them
247 were resolved with %nonassoc in the current parser state. Such
248 tokens are now properly omitted from the list.
250 *** Expected token lists are still often wrong due to state merging
251 (from LALR or IELR) and default reductions, which can both add and
252 subtract valid tokens. Canonical LR almost completely fixes this
253 problem by eliminating state merging and default reductions.
254 However, there is one minor problem left even when using canonical
255 LR and even after the fixes above. That is, if the resolution of a
256 conflict with %nonassoc appears in a later parser state than the one
257 at which some syntax error is discovered, the conflicted token is
258 still erroneously included in the expected token list. We are
259 currently working on a fix to eliminate this problem and to
260 eliminate the need for canonical LR.
262 ** Destructor calls fixed for lookaheads altered in semantic actions.
264 Previously for deterministic parsers in C, if a user semantic action
265 altered yychar, the parser in some cases used the old yychar value to
266 determine which destructor to call for the lookahead upon a syntax
267 error or upon parser return. This bug has been fixed.
269 ** C++ parsers use YYRHSLOC
271 Similarly to the C parsers, the C++ parsers now define the YYRHSLOC
272 macro and use it in the default YYLLOC_DEFAULT. You are encouraged
273 to use it. If, for instance, your location structure has "first"
274 and "last" members, instead of
276 # define YYLLOC_DEFAULT(Current, Rhs, N) \
280 (Current).first = (Rhs)[1].location.first; \
281 (Current).last = (Rhs)[N].location.last; \
285 (Current).first = (Current).last = (Rhs)[0].location.last; \
291 # define YYLLOC_DEFAULT(Current, Rhs, N) \
295 (Current).first = YYRHSLOC (Rhs, 1).first; \
296 (Current).last = YYRHSLOC (Rhs, N).last; \
300 (Current).first = (Current).last = YYRHSLOC (Rhs, 0).last; \
304 ** YYLLOC_DEFAULT in C++
306 The default implementation of YYLLOC_DEFAULT used to be issued in
307 the header file. It is now output in the implementation file, after
308 the user %code sections so that its #ifndef guard does not try to
309 override the user's YYLLOC_DEFAULT if provided.
311 * Changes in version 2.4.3 (2010-08-05):
313 ** Bison now obeys -Werror and --warnings=error for warnings about
314 grammar rules that are useless in the parser due to conflicts.
316 ** Problems with spawning M4 on at least FreeBSD 8 and FreeBSD 9 have
319 ** Failures in the test suite for GCC 4.5 have been fixed.
321 ** Failures in the test suite for some versions of Sun Studio C++ have
324 ** Contrary to Bison 2.4.2's NEWS entry, it has been decided that
325 warnings about undefined %prec identifiers will not be converted to
326 errors in Bison 2.5. They will remain warnings, which should be
327 sufficient for POSIX while avoiding backward compatibility issues.
329 ** Minor documentation fixes.
331 * Changes in version 2.4.2 (2010-03-20):
333 ** Some portability problems that resulted in failures and livelocks
334 in the test suite on some versions of at least Solaris, AIX, HP-UX,
335 RHEL4, and Tru64 have been addressed. As a result, fatal Bison
336 errors should no longer cause M4 to report a broken pipe on the
339 ** `%prec IDENTIFIER' requires IDENTIFIER to be defined separately.
341 POSIX specifies that an error be reported for any identifier that does
342 not appear on the LHS of a grammar rule and that is not defined by
343 %token, %left, %right, or %nonassoc. Bison 2.3b and later lost this
344 error report for the case when an identifier appears only after a
345 %prec directive. It is now restored. However, for backward
346 compatibility with recent Bison releases, it is only a warning for
347 now. In Bison 2.5 and later, it will return to being an error.
348 [Between the 2.4.2 and 2.4.3 releases, it was decided that this
349 warning will not be converted to an error in Bison 2.5.]
351 ** Detection of GNU M4 1.4.6 or newer during configure is improved.
353 ** Warnings from gcc's -Wundef option about undefined YYENABLE_NLS,
354 YYLTYPE_IS_TRIVIAL, and __STRICT_ANSI__ in C/C++ parsers are now
357 ** %code is now a permanent feature.
359 A traditional Yacc prologue directive is written in the form:
363 To provide a more flexible alternative, Bison 2.3b introduced the
364 %code directive with the following forms for C/C++:
367 %code requires {CODE}
368 %code provides {CODE}
371 These forms are now considered permanent features of Bison. See the
372 %code entries in the section "Bison Declaration Summary" in the Bison
373 manual for a summary of their functionality. See the section
374 "Prologue Alternatives" for a detailed discussion including the
375 advantages of %code over the traditional Yacc prologue directive.
377 Bison's Java feature as a whole including its current usage of %code
378 is still considered experimental.
380 ** YYFAIL is deprecated and will eventually be removed.
382 YYFAIL has existed for many years as an undocumented feature of
383 deterministic parsers in C generated by Bison. Previously, it was
384 documented for Bison's experimental Java parsers. YYFAIL is no longer
385 documented for Java parsers and is formally deprecated in both cases.
386 Users are strongly encouraged to migrate to YYERROR, which is
389 Like YYERROR, you can invoke YYFAIL from a semantic action in order to
390 induce a syntax error. The most obvious difference from YYERROR is
391 that YYFAIL will automatically invoke yyerror to report the syntax
392 error so that you don't have to. However, there are several other
393 subtle differences between YYERROR and YYFAIL, and YYFAIL suffers from
394 inherent flaws when %error-verbose or `#define YYERROR_VERBOSE' is
395 used. For a more detailed discussion, see:
397 http://lists.gnu.org/archive/html/bison-patches/2009-12/msg00024.html
399 The upcoming Bison 2.5 will remove YYFAIL from Java parsers, but
400 deterministic parsers in C will continue to implement it. However,
401 because YYFAIL is already flawed, it seems futile to try to make new
402 Bison features compatible with it. Thus, during parser generation,
403 Bison 2.5 will produce a warning whenever it discovers YYFAIL in a
404 rule action. In a later release, YYFAIL will be disabled for
405 %error-verbose and `#define YYERROR_VERBOSE'. Eventually, YYFAIL will
406 be removed altogether.
408 There exists at least one case where Bison 2.5's YYFAIL warning will
409 be a false positive. Some projects add phony uses of YYFAIL and other
410 Bison-defined macros for the sole purpose of suppressing C
411 preprocessor warnings (from GCC cpp's -Wunused-macros, for example).
412 To avoid Bison's future warning, such YYFAIL uses can be moved to the
413 epilogue (that is, after the second `%%') in the Bison input file. In
414 this release (2.4.2), Bison already generates its own code to suppress
415 C preprocessor warnings for YYFAIL, so projects can remove their own
416 phony uses of YYFAIL if compatibility with Bison releases prior to
417 2.4.2 is not necessary.
419 ** Internationalization.
421 Fix a regression introduced in Bison 2.4: Under some circumstances,
422 message translations were not installed although supported by the
425 * Changes in version 2.4.1 (2008-12-11):
427 ** In the GLR defines file, unexpanded M4 macros in the yylval and yylloc
428 declarations have been fixed.
430 ** Temporary hack for adding a semicolon to the user action.
432 Bison used to prepend a trailing semicolon at the end of the user
433 action for reductions. This allowed actions such as
435 exp: exp "+" exp { $$ = $1 + $3 };
439 exp: exp "+" exp { $$ = $1 + $3; };
441 Some grammars still depend on this `feature'. Bison 2.4.1 restores
442 the previous behavior in the case of C output (specifically, when
443 neither %language or %skeleton or equivalent command-line options
444 are used) to leave more time for grammars depending on the old
445 behavior to be adjusted. Future releases of Bison will disable this
448 ** A few minor improvements to the Bison manual.
450 * Changes in version 2.4 (2008-11-02):
452 ** %language is an experimental feature.
454 We first introduced this feature in test release 2.3b as a cleaner
455 alternative to %skeleton. Since then, we have discussed the possibility of
456 modifying its effect on Bison's output file names. Thus, in this release,
457 we consider %language to be an experimental feature that will likely evolve
460 ** Forward compatibility with GNU M4 has been improved.
462 ** Several bugs in the C++ skeleton and the experimental Java skeleton have been
465 * Changes in version 2.3b (2008-05-27):
467 ** The quotes around NAME that used to be required in the following directive
472 ** The directive `%pure-parser' is now deprecated in favor of:
476 which has the same effect except that Bison is more careful to warn about
477 unreasonable usage in the latter case.
481 Bison can now generate an LALR(1) parser in C with a push interface. That
482 is, instead of invoking `yyparse', which pulls tokens from `yylex', you can
483 push one token at a time to the parser using `yypush_parse', which will
484 return to the caller after processing each token. By default, the push
485 interface is disabled. Either of the following directives will enable it:
487 %define api.push_pull "push" // Just push; does not require yylex.
488 %define api.push_pull "both" // Push and pull; requires yylex.
490 See the new section `A Push Parser' in the Bison manual for details.
492 The current push parsing interface is experimental and may evolve. More user
493 feedback will help to stabilize it.
495 ** The -g and --graph options now output graphs in Graphviz DOT format,
496 not VCG format. Like --graph, -g now also takes an optional FILE argument
497 and thus cannot be bundled with other short options.
501 Bison can now generate an LALR(1) parser in Java. The skeleton is
502 `data/lalr1.java'. Consider using the new %language directive instead of
503 %skeleton to select it.
505 See the new section `Java Parsers' in the Bison manual for details.
507 The current Java interface is experimental and may evolve. More user
508 feedback will help to stabilize it.
512 This new directive specifies the programming language of the generated
513 parser, which can be C (the default), C++, or Java. Besides the skeleton
514 that Bison uses, the directive affects the names of the generated files if
515 the grammar file's name ends in ".y".
517 ** XML Automaton Report
519 Bison can now generate an XML report of the LALR(1) automaton using the new
520 `--xml' option. The current XML schema is experimental and may evolve. More
521 user feedback will help to stabilize it.
523 ** The grammar file may now specify the name of the parser header file using
524 %defines. For example:
528 ** When reporting useless rules, useless nonterminals, and unused terminals,
529 Bison now employs the terms "useless in grammar" instead of "useless",
530 "useless in parser" instead of "never reduced", and "unused in grammar"
533 ** Unreachable State Removal
535 Previously, Bison sometimes generated parser tables containing unreachable
536 states. A state can become unreachable during conflict resolution if Bison
537 disables a shift action leading to it from a predecessor state. Bison now:
539 1. Removes unreachable states.
541 2. Does not report any conflicts that appeared in unreachable states.
542 WARNING: As a result, you may need to update %expect and %expect-rr
543 directives in existing grammar files.
545 3. For any rule used only in such states, Bison now reports the rule as
546 "useless in parser due to conflicts".
548 This feature can be disabled with the following directive:
550 %define lr.keep_unreachable_states
552 See the %define entry in the `Bison Declaration Summary' in the Bison manual
553 for further discussion.
555 ** Lookahead Set Correction in the `.output' Report
557 When instructed to generate a `.output' file including lookahead sets
558 (using `--report=lookahead', for example), Bison now prints each reduction's
559 lookahead set only next to the associated state's one item that (1) is
560 associated with the same rule as the reduction and (2) has its dot at the end
561 of its RHS. Previously, Bison also erroneously printed the lookahead set
562 next to all of the state's other items associated with the same rule. This
563 bug affected only the `.output' file and not the generated parser source
566 ** --report-file=FILE is a new option to override the default `.output' file
569 ** The `=' that used to be required in the following directives is now
572 %file-prefix "parser"
576 ** An Alternative to `%{...%}' -- `%code QUALIFIER {CODE}'
578 Bison 2.3a provided a new set of directives as a more flexible alternative to
579 the traditional Yacc prologue blocks. Those have now been consolidated into
580 a single %code directive with an optional qualifier field, which identifies
581 the purpose of the code and thus the location(s) where Bison should generate
584 1. `%code {CODE}' replaces `%after-header {CODE}'
585 2. `%code requires {CODE}' replaces `%start-header {CODE}'
586 3. `%code provides {CODE}' replaces `%end-header {CODE}'
587 4. `%code top {CODE}' replaces `%before-header {CODE}'
589 See the %code entries in section `Bison Declaration Summary' in the Bison
590 manual for a summary of the new functionality. See the new section `Prologue
591 Alternatives' for a detailed discussion including the advantages of %code
592 over the traditional Yacc prologues.
594 The prologue alternatives are experimental. More user feedback will help to
595 determine whether they should become permanent features.
597 ** Revised warning: unset or unused mid-rule values
599 Since Bison 2.2, Bison has warned about mid-rule values that are set but not
600 used within any of the actions of the parent rule. For example, Bison warns
603 exp: '1' { $$ = 1; } '+' exp { $$ = $1 + $4; };
605 Now, Bison also warns about mid-rule values that are used but not set. For
606 example, Bison warns about unset $$ in the mid-rule action in:
608 exp: '1' { $1 = 1; } '+' exp { $$ = $2 + $4; };
610 However, Bison now disables both of these warnings by default since they
611 sometimes prove to be false alarms in existing grammars employing the Yacc
612 constructs $0 or $-N (where N is some positive integer).
614 To enable these warnings, specify the option `--warnings=midrule-values' or
615 `-W', which is a synonym for `--warnings=all'.
617 ** Default %destructor or %printer with `<*>' or `<>'
619 Bison now recognizes two separate kinds of default %destructor's and
622 1. Place `<*>' in a %destructor/%printer symbol list to define a default
623 %destructor/%printer for all grammar symbols for which you have formally
624 declared semantic type tags.
626 2. Place `<>' in a %destructor/%printer symbol list to define a default
627 %destructor/%printer for all grammar symbols without declared semantic
630 Bison no longer supports the `%symbol-default' notation from Bison 2.3a.
631 `<*>' and `<>' combined achieve the same effect with one exception: Bison no
632 longer applies any %destructor to a mid-rule value if that mid-rule value is
633 not actually ever referenced using either $$ or $n in a semantic action.
635 The default %destructor's and %printer's are experimental. More user
636 feedback will help to determine whether they should become permanent
639 See the section `Freeing Discarded Symbols' in the Bison manual for further
642 ** %left, %right, and %nonassoc can now declare token numbers. This is required
643 by POSIX. However, see the end of section `Operator Precedence' in the Bison
644 manual for a caveat concerning the treatment of literal strings.
646 ** The nonfunctional --no-parser, -n, and %no-parser options have been
647 completely removed from Bison.
649 * Changes in version 2.3a, 2006-09-13:
651 ** Instead of %union, you can define and use your own union type
652 YYSTYPE if your grammar contains at least one <type> tag.
653 Your YYSTYPE need not be a macro; it can be a typedef.
654 This change is for compatibility with other Yacc implementations,
655 and is required by POSIX.
657 ** Locations columns and lines start at 1.
658 In accordance with the GNU Coding Standards and Emacs.
660 ** You may now declare per-type and default %destructor's and %printer's:
664 %union { char *string; }
665 %token <string> STRING1
666 %token <string> STRING2
667 %type <string> string1
668 %type <string> string2
669 %union { char character; }
670 %token <character> CHR
671 %type <character> chr
672 %destructor { free ($$); } %symbol-default
673 %destructor { free ($$); printf ("%d", @$.first_line); } STRING1 string1
674 %destructor { } <character>
676 guarantees that, when the parser discards any user-defined symbol that has a
677 semantic type tag other than `<character>', it passes its semantic value to
678 `free'. However, when the parser discards a `STRING1' or a `string1', it
679 also prints its line number to `stdout'. It performs only the second
680 `%destructor' in this case, so it invokes `free' only once.
682 [Although we failed to mention this here in the 2.3a release, the default
683 %destructor's and %printer's were experimental, and they were rewritten in
686 ** Except for LALR(1) parsers in C with POSIX Yacc emulation enabled (with `-y',
687 `--yacc', or `%yacc'), Bison no longer generates #define statements for
688 associating token numbers with token names. Removing the #define statements
689 helps to sanitize the global namespace during preprocessing, but POSIX Yacc
690 requires them. Bison still generates an enum for token names in all cases.
692 ** Handling of traditional Yacc prologue blocks is now more consistent but
693 potentially incompatible with previous releases of Bison.
695 As before, you declare prologue blocks in your grammar file with the
696 `%{ ... %}' syntax. To generate the pre-prologue, Bison concatenates all
697 prologue blocks that you've declared before the first %union. To generate
698 the post-prologue, Bison concatenates all prologue blocks that you've
699 declared after the first %union.
701 Previous releases of Bison inserted the pre-prologue into both the header
702 file and the code file in all cases except for LALR(1) parsers in C. In the
703 latter case, Bison inserted it only into the code file. For parsers in C++,
704 the point of insertion was before any token definitions (which associate
705 token numbers with names). For parsers in C, the point of insertion was
706 after the token definitions.
708 Now, Bison never inserts the pre-prologue into the header file. In the code
709 file, it always inserts it before the token definitions.
711 ** Bison now provides a more flexible alternative to the traditional Yacc
712 prologue blocks: %before-header, %start-header, %end-header, and
715 For example, the following declaration order in the grammar file reflects the
716 order in which Bison will output these code blocks. However, you are free to
717 declare these code blocks in your grammar file in whatever order is most
721 /* Bison treats this block like a pre-prologue block: it inserts it into
722 * the code file before the contents of the header file. It does *not*
723 * insert it into the header file. This is a good place to put
724 * #include's that you want at the top of your code file. A common
725 * example is `#include "system.h"'. */
728 /* Bison inserts this block into both the header file and the code file.
729 * In both files, the point of insertion is before any Bison-generated
730 * token, semantic type, location type, and class definitions. This is a
731 * good place to define %union dependencies, for example. */
734 /* Unlike the traditional Yacc prologue blocks, the output order for the
735 * new %*-header blocks is not affected by their declaration position
736 * relative to any %union in the grammar file. */
739 /* Bison inserts this block into both the header file and the code file.
740 * In both files, the point of insertion is after the Bison-generated
741 * definitions. This is a good place to declare or define public
742 * functions or data structures that depend on the Bison-generated
746 /* Bison treats this block like a post-prologue block: it inserts it into
747 * the code file after the contents of the header file. It does *not*
748 * insert it into the header file. This is a good place to declare or
749 * define internal functions or data structures that depend on the
750 * Bison-generated definitions. */
753 If you have multiple occurrences of any one of the above declarations, Bison
754 will concatenate the contents in declaration order.
756 [Although we failed to mention this here in the 2.3a release, the prologue
757 alternatives were experimental, and they were rewritten in future versions.]
759 ** The option `--report=look-ahead' has been changed to `--report=lookahead'.
760 The old spelling still works, but is not documented and may be removed
763 * Changes in version 2.3, 2006-06-05:
765 ** GLR grammars should now use `YYRECOVERING ()' instead of `YYRECOVERING',
766 for compatibility with LALR(1) grammars.
768 ** It is now documented that any definition of YYSTYPE or YYLTYPE should
769 be to a type name that does not contain parentheses or brackets.
771 * Changes in version 2.2, 2006-05-19:
773 ** The distribution terms for all Bison-generated parsers now permit
774 using the parsers in nonfree programs. Previously, this permission
775 was granted only for Bison-generated LALR(1) parsers in C.
777 ** %name-prefix changes the namespace name in C++ outputs.
779 ** The C++ parsers export their token_type.
781 ** Bison now allows multiple %union declarations, and concatenates
782 their contents together.
784 ** New warning: unused values
785 Right-hand side symbols whose values are not used are reported,
786 if the symbols have destructors. For instance:
788 exp: exp "?" exp ":" exp { $1 ? $1 : $3; }
792 will trigger a warning about $$ and $5 in the first rule, and $3 in
793 the second ($1 is copied to $$ by the default rule). This example
794 most likely contains three errors, and could be rewritten as:
796 exp: exp "?" exp ":" exp
797 { $$ = $1 ? $3 : $5; free ($1 ? $5 : $3); free ($1); }
799 { $$ = $1 ? $1 : $3; if ($1) free ($3); }
802 However, if the original actions were really intended, memory leaks
803 and all, the warnings can be suppressed by letting Bison believe the
804 values are used, e.g.:
806 exp: exp "?" exp ":" exp { $1 ? $1 : $3; (void) ($$, $5); }
807 | exp "+" exp { $$ = $1; (void) $3; }
810 If there are mid-rule actions, the warning is issued if no action
811 uses it. The following triggers no warning: $1 and $3 are used.
813 exp: exp { push ($1); } '+' exp { push ($3); sum (); };
815 The warning is intended to help catching lost values and memory leaks.
816 If a value is ignored, its associated memory typically is not reclaimed.
818 ** %destructor vs. YYABORT, YYACCEPT, and YYERROR.
819 Destructors are now called when user code invokes YYABORT, YYACCEPT,
820 and YYERROR, for all objects on the stack, other than objects
821 corresponding to the right-hand side of the current rule.
823 ** %expect, %expect-rr
824 Incorrect numbers of expected conflicts are now actual errors,
827 ** GLR, YACC parsers.
828 The %parse-params are available in the destructors (and the
829 experimental printers) as per the documentation.
831 ** Bison now warns if it finds a stray `$' or `@' in an action.
833 ** %require "VERSION"
834 This specifies that the grammar file depends on features implemented
835 in Bison version VERSION or higher.
837 ** lalr1.cc: The token and value types are now class members.
838 The tokens were defined as free form enums and cpp macros. YYSTYPE
839 was defined as a free form union. They are now class members:
840 tokens are enumerations of the `yy::parser::token' struct, and the
841 semantic values have the `yy::parser::semantic_type' type.
843 If you do not want or can update to this scheme, the directive
844 `%define "global_tokens_and_yystype" "1"' triggers the global
845 definition of tokens and YYSTYPE. This change is suitable both
846 for previous releases of Bison, and this one.
848 If you wish to update, then make sure older version of Bison will
849 fail using `%require "2.2"'.
851 ** DJGPP support added.
853 * Changes in version 2.1, 2005-09-16:
855 ** The C++ lalr1.cc skeleton supports %lex-param.
857 ** Bison-generated parsers now support the translation of diagnostics like
858 "syntax error" into languages other than English. The default
859 language is still English. For details, please see the new
860 Internationalization section of the Bison manual. Software
861 distributors should also see the new PACKAGING file. Thanks to
862 Bruno Haible for this new feature.
864 ** Wording in the Bison-generated parsers has been changed slightly to
865 simplify translation. In particular, the message "memory exhausted"
866 has replaced "parser stack overflow", as the old message was not
867 always accurate for modern Bison-generated parsers.
869 ** Destructors are now called when the parser aborts, for all symbols left
870 behind on the stack. Also, the start symbol is now destroyed after a
871 successful parse. In both cases, the behavior was formerly inconsistent.
873 ** When generating verbose diagnostics, Bison-generated parsers no longer
874 quote the literal strings associated with tokens. For example, for
875 a syntax error associated with '%token NUM "number"' they might
876 print 'syntax error, unexpected number' instead of 'syntax error,
877 unexpected "number"'.
879 * Changes in version 2.0, 2004-12-25:
881 ** Possibly-incompatible changes
883 - Bison-generated parsers no longer default to using the alloca function
884 (when available) to extend the parser stack, due to widespread
885 problems in unchecked stack-overflow detection. You can "#define
886 YYSTACK_USE_ALLOCA 1" to require the use of alloca, but please read
887 the manual to determine safe values for YYMAXDEPTH in that case.
889 - Error token location.
890 During error recovery, the location of the syntax error is updated
891 to cover the whole sequence covered by the error token: it includes
892 the shifted symbols thrown away during the first part of the error
893 recovery, and the lookahead rejected during the second part.
896 . Stray semicolons are no longer allowed at the start of a grammar.
897 . Semicolons are now required after in-grammar declarations.
899 - Unescaped newlines are no longer allowed in character constants or
900 string literals. They were never portable, and GCC 3.4.0 has
901 dropped support for them. Better diagnostics are now generated if
902 forget a closing quote.
904 - NUL bytes are no longer allowed in Bison string literals, unfortunately.
908 - GLR grammars now support locations.
910 - New directive: %initial-action.
911 This directive allows the user to run arbitrary code (including
912 initializing @$) from yyparse before parsing starts.
914 - A new directive "%expect-rr N" specifies the expected number of
915 reduce/reduce conflicts in GLR parsers.
917 - %token numbers can now be hexadecimal integers, e.g., `%token FOO 0x12d'.
918 This is a GNU extension.
920 - The option `--report=lookahead' was changed to `--report=look-ahead'.
921 [However, this was changed back after 2.3.]
923 - Experimental %destructor support has been added to lalr1.cc.
925 - New configure option --disable-yacc, to disable installation of the
926 yacc command and -ly library introduced in 1.875 for POSIX conformance.
930 - For now, %expect-count violations are now just warnings, not errors.
931 This is for compatibility with Bison 1.75 and earlier (when there are
932 reduce/reduce conflicts) and with Bison 1.30 and earlier (when there
933 are too many or too few shift/reduce conflicts). However, in future
934 versions of Bison we plan to improve the %expect machinery so that
935 these violations will become errors again.
937 - Within Bison itself, numbers (e.g., goto numbers) are no longer
938 arbitrarily limited to 16-bit counts.
940 - Semicolons are now allowed before "|" in grammar rules, as POSIX requires.
942 * Changes in version 1.875, 2003-01-01:
944 ** The documentation license has been upgraded to version 1.2
945 of the GNU Free Documentation License.
947 ** syntax error processing
949 - In Yacc-style parsers YYLLOC_DEFAULT is now used to compute error
950 locations too. This fixes bugs in error-location computation.
953 It is now possible to reclaim the memory associated to symbols
954 discarded during error recovery. This feature is still experimental.
957 This new directive is preferred over YYERROR_VERBOSE.
959 - #defining yyerror to steal internal variables is discouraged.
960 It is not guaranteed to work forever.
964 - Semicolons are once again optional at the end of grammar rules.
965 This reverts to the behavior of Bison 1.33 and earlier, and improves
966 compatibility with Yacc.
968 - `parse error' -> `syntax error'
969 Bison now uniformly uses the term `syntax error'; formerly, the code
970 and manual sometimes used the term `parse error' instead. POSIX
971 requires `syntax error' in diagnostics, and it was thought better to
974 - The documentation now emphasizes that yylex and yyerror must be
975 declared before use. C99 requires this.
977 - Bison now parses C99 lexical constructs like UCNs and
978 backslash-newline within C escape sequences, as POSIX 1003.1-2001 requires.
980 - File names are properly escaped in C output. E.g., foo\bar.y is
981 output as "foo\\bar.y".
983 - Yacc command and library now available
984 The Bison distribution now installs a `yacc' command, as POSIX requires.
985 Also, Bison now installs a small library liby.a containing
986 implementations of Yacc-compatible yyerror and main functions.
987 This library is normally not useful, but POSIX requires it.
989 - Type clashes now generate warnings, not errors.
991 - If the user does not define YYSTYPE as a macro, Bison now declares it
992 using typedef instead of defining it as a macro.
993 For consistency, YYLTYPE is also declared instead of defined.
995 ** Other compatibility issues
997 - %union directives can now have a tag before the `{', e.g., the
998 directive `%union foo {...}' now generates the C code
999 `typedef union foo { ... } YYSTYPE;'; this is for Yacc compatibility.
1000 The default union tag is `YYSTYPE', for compatibility with Solaris 9 Yacc.
1001 For consistency, YYLTYPE's struct tag is now `YYLTYPE' not `yyltype'.
1002 This is for compatibility with both Yacc and Bison 1.35.
1004 - `;' is output before the terminating `}' of an action, for
1005 compatibility with Bison 1.35.
1007 - Bison now uses a Yacc-style format for conflict reports, e.g.,
1008 `conflicts: 2 shift/reduce, 1 reduce/reduce'.
1010 - `yystype' and `yyltype' are now obsolescent macros instead of being
1011 typedefs or tags; they are no longer documented and are planned to be
1012 withdrawn in a future release.
1017 Users of Bison have to decide how they handle the portability of the
1020 - `parsing stack overflow...' -> `parser stack overflow'
1021 GLR parsers now report `parser stack overflow' as per the Bison manual.
1023 ** Bison now warns if it detects conflicting outputs to the same file,
1024 e.g., it generates a warning for `bison -d -o foo.h foo.y' since
1025 that command outputs both code and header to foo.h.
1027 ** #line in output files
1028 - --no-line works properly.
1030 ** Bison can no longer be built by a K&R C compiler; it requires C89 or
1031 later to be built. This change originally took place a few versions
1032 ago, but nobody noticed until we recently asked someone to try
1033 building Bison with a K&R C compiler.
1035 * Changes in version 1.75, 2002-10-14:
1037 ** Bison should now work on 64-bit hosts.
1039 ** Indonesian translation thanks to Tedi Heriyanto.
1042 Fix spurious parse errors.
1045 Some people redefine yyerror to steal yyparse' private variables.
1046 Reenable this trick until an official feature replaces it.
1049 In agreement with POSIX and with other Yaccs, leaving a default
1050 action is valid when $$ is untyped, and $1 typed:
1054 but the converse remains an error:
1058 ** Values of mid-rule actions
1061 foo: { ... } { $$ = $1; } ...
1063 was incorrectly rejected: $1 is defined in the second mid-rule
1064 action, and is equal to the $$ of the first mid-rule action.
1066 * Changes in version 1.50, 2002-10-04:
1071 causes Bison to produce a Generalized LR (GLR) parser, capable of handling
1072 almost any context-free grammar, ambiguous or not. The new declarations
1073 %dprec and %merge on grammar rules allow parse-time resolution of
1074 ambiguities. Contributed by Paul Hilfinger.
1076 Unfortunately Bison 1.50 does not work properly on 64-bit hosts
1077 like the Alpha, so please stick to 32-bit hosts for now.
1080 When not in Yacc compatibility mode, when the output file was not
1081 specified, running `bison foo/bar.y' created `foo/bar.c'. It
1082 now creates `bar.c'.
1085 The undefined token was systematically mapped to 2 which prevented
1086 the use of 2 by the user. This is no longer the case.
1088 ** Unknown token numbers
1089 If yylex returned an out of range value, yyparse could die. This is
1093 According to POSIX, the error token must be 256.
1094 Bison extends this requirement by making it a preference: *if* the
1095 user specified that one of her tokens is numbered 256, then error
1096 will be mapped onto another number.
1098 ** Verbose error messages
1099 They no longer report `..., expecting error or...' for states where
1100 error recovery is possible.
1103 Defaults to `$end' instead of `$'.
1105 ** Error recovery now conforms to documentation and to POSIX
1106 When a Bison-generated parser encounters a syntax error, it now pops
1107 the stack until it finds a state that allows shifting the error
1108 token. Formerly, it popped the stack until it found a state that
1109 allowed some non-error action other than a default reduction on the
1110 error token. The new behavior has long been the documented behavior,
1111 and has long been required by POSIX. For more details, please see
1112 Paul Eggert, "Reductions during Bison error handling" (2002-05-20)
1113 <http://lists.gnu.org/archive/html/bug-bison/2002-05/msg00038.html>.
1116 Popped tokens and nonterminals are now reported.
1119 Larger grammars are now supported (larger token numbers, larger grammar
1120 size (= sum of the LHS and RHS lengths), larger LALR tables).
1121 Formerly, many of these numbers ran afoul of 16-bit limits;
1122 now these limits are 32 bits on most hosts.
1124 ** Explicit initial rule
1125 Bison used to play hacks with the initial rule, which the user does
1126 not write. It is now explicit, and visible in the reports and
1130 Before, Bison reported the useless rules, but, although not used,
1131 included them in the parsers. They are now actually removed.
1133 ** Useless rules, useless nonterminals
1134 They are now reported, as a warning, with their locations.
1136 ** Rules never reduced
1137 Rules that can never be reduced because of conflicts are now
1140 ** Incorrect `Token not used'
1141 On a grammar such as
1143 %token useless useful
1145 exp: '0' %prec useful;
1147 where a token was used to set the precedence of the last rule,
1148 bison reported both `useful' and `useless' as useless tokens.
1150 ** Revert the C++ namespace changes introduced in 1.31
1151 as they caused too many portability hassles.
1153 ** Default locations
1154 By an accident of design, the default computation of @$ was
1155 performed after another default computation was performed: @$ = @1.
1156 The latter is now removed: YYLLOC_DEFAULT is fully responsible of
1157 the computation of @$.
1159 ** Token end-of-file
1160 The token end of file may be specified by the user, in which case,
1161 the user symbol is used in the reports, the graphs, and the verbose
1162 error messages instead of `$end', which remains being the default.
1166 %token MYEOF 0 "end of file"
1169 This old option, which has been broken for ages, is removed.
1172 Brazilian Portuguese, thanks to Alexandre Folle de Menezes.
1173 Croatian, thanks to Denis Lackovic.
1175 ** Incorrect token definitions
1176 When given `%token 'a' "A"', Bison used to output `#define 'a' 65'.
1178 ** Token definitions as enums
1179 Tokens are output both as the traditional #define's, and, provided
1180 the compiler supports ANSI C or is a C++ compiler, as enums.
1181 This lets debuggers display names instead of integers.
1184 In addition to --verbose, bison supports --report=THINGS, which
1185 produces additional information:
1187 complete the core item sets with their closure
1188 - lookahead [changed to `look-ahead' in 1.875e through 2.3, but changed back]
1189 explicitly associate lookahead tokens to items
1191 describe shift/reduce conflicts solving.
1192 Bison used to systematically output this information on top of
1193 the report. Solved conflicts are now attached to their states.
1196 Previous versions don't complain when there is a type clash on
1197 the default action if the rule has a mid-rule action, such as in:
1205 ** GNU M4 is now required when using Bison.
1207 * Changes in version 1.35, 2002-03-25:
1210 Some projects use Bison's C parser with C++ compilers, and define
1211 YYSTYPE as a class. The recent adjustment of C parsers for data
1212 alignment and 64 bit architectures made this impossible.
1214 Because for the time being no real solution for C++ parser
1215 generation exists, kludges were implemented in the parser to
1216 maintain this use. In the future, when Bison has C++ parsers, this
1217 kludge will be disabled.
1219 This kludge also addresses some C++ problems when the stack was
1222 * Changes in version 1.34, 2002-03-12:
1224 ** File name clashes are detected
1225 $ bison foo.y -d -o foo.x
1226 fatal error: header and parser would both be named `foo.x'
1228 ** A missing `;' at the end of a rule triggers a warning
1229 In accordance with POSIX, and in agreement with other
1230 Yacc implementations, Bison will mandate this semicolon in the near
1231 future. This eases the implementation of a Bison parser of Bison
1232 grammars by making this grammar LALR(1) instead of LR(2). To
1233 facilitate the transition, this release introduces a warning.
1235 ** Revert the C++ namespace changes introduced in 1.31, as they caused too
1236 many portability hassles.
1238 ** DJGPP support added.
1240 ** Fix test suite portability problems.
1242 * Changes in version 1.33, 2002-02-07:
1245 Groff could not be compiled for the definition of size_t was lacking
1246 under some conditions.
1251 * Changes in version 1.32, 2002-01-23:
1253 ** Fix Yacc output file names
1255 ** Portability fixes
1257 ** Italian, Dutch translations
1259 * Changes in version 1.31, 2002-01-14:
1263 ** GNU Gettext and %expect
1264 GNU Gettext asserts 10 s/r conflicts, but there are 7. Now that
1265 Bison dies on incorrect %expectations, we fear there will be
1266 too many bug reports for Gettext, so _for the time being_, %expect
1267 does not trigger an error when the input file is named `plural.y'.
1269 ** Use of alloca in parsers
1270 If YYSTACK_USE_ALLOCA is defined to 0, then the parsers will use
1271 malloc exclusively. Since 1.29, but was not NEWS'ed.
1273 alloca is used only when compiled with GCC, to avoid portability
1276 ** yyparse now returns 2 if memory is exhausted; formerly it dumped core.
1278 ** When the generated parser lacks debugging code, YYDEBUG is now 0
1279 (as POSIX requires) instead of being undefined.
1282 Bison has always permitted actions such as { $$ = $1 }: it adds the
1283 ending semicolon. Now if in Yacc compatibility mode, the semicolon
1284 is no longer output: one has to write { $$ = $1; }.
1286 ** Better C++ compliance
1287 The output parsers try to respect C++ namespaces.
1288 [This turned out to be a failed experiment, and it was reverted later.]
1291 Fixed bugs when reporting useless nonterminals.
1294 The parsers work properly on 64 bit hosts.
1297 Some calls to strerror resulted in scrambled or missing error messages.
1300 When the number of shift/reduce conflicts is correct, don't issue
1303 ** The verbose report includes the rule line numbers.
1305 ** Rule line numbers are fixed in traces.
1307 ** Swedish translation
1310 Verbose parse error messages from the parsers are better looking.
1311 Before: parse error: unexpected `'/'', expecting `"number"' or `'-'' or `'(''
1312 Now: parse error: unexpected '/', expecting "number" or '-' or '('
1314 ** Fixed parser memory leaks.
1315 When the generated parser was using malloc to extend its stacks, the
1316 previous allocations were not freed.
1318 ** Fixed verbose output file.
1319 Some newlines were missing.
1320 Some conflicts in state descriptions were missing.
1322 ** Fixed conflict report.
1323 Option -v was needed to get the result.
1327 Mismatches are errors, not warnings.
1329 ** Fixed incorrect processing of some invalid input.
1331 ** Fixed CPP guards: 9foo.h uses BISON_9FOO_H instead of 9FOO_H.
1333 ** Fixed some typos in the documentation.
1335 ** %token MY_EOF 0 is supported.
1336 Before, MY_EOF was silently renumbered as 257.
1338 ** doc/refcard.tex is updated.
1340 ** %output, %file-prefix, %name-prefix.
1344 New, aliasing `--output-file'.
1346 * Changes in version 1.30, 2001-10-26:
1348 ** `--defines' and `--graph' have now an optional argument which is the
1349 output file name. `-d' and `-g' do not change; they do not take any
1352 ** `%source_extension' and `%header_extension' are removed, failed
1355 ** Portability fixes.
1357 * Changes in version 1.29, 2001-09-07:
1359 ** The output file does not define const, as this caused problems when used
1360 with common autoconfiguration schemes. If you still use ancient compilers
1361 that lack const, compile with the equivalent of the C compiler option
1362 `-Dconst='. autoconf's AC_C_CONST macro provides one way to do this.
1364 ** Added `-g' and `--graph'.
1366 ** The Bison manual is now distributed under the terms of the GNU FDL.
1368 ** The input and the output files has automatically a similar extension.
1370 ** Russian translation added.
1372 ** NLS support updated; should hopefully be less troublesome.
1374 ** Added the old Bison reference card.
1376 ** Added `--locations' and `%locations'.
1378 ** Added `-S' and `--skeleton'.
1380 ** `%raw', `-r', `--raw' is disabled.
1382 ** Special characters are escaped when output. This solves the problems
1383 of the #line lines with path names including backslashes.
1386 `%yacc', `%fixed_output_files', `%defines', `%no_parser', `%verbose',
1387 `%debug', `%source_extension' and `%header_extension'.
1390 Automatic location tracking.
1392 * Changes in version 1.28, 1999-07-06:
1394 ** Should compile better now with K&R compilers.
1398 ** Fixed a problem with escaping the double quote character.
1400 ** There is now a FAQ.
1402 * Changes in version 1.27:
1404 ** The make rule which prevented bison.simple from being created on
1405 some systems has been fixed.
1407 * Changes in version 1.26:
1409 ** Bison now uses automake.
1411 ** New mailing lists: <bug-bison@gnu.org> and <help-bison@gnu.org>.
1413 ** Token numbers now start at 257 as previously documented, not 258.
1415 ** Bison honors the TMPDIR environment variable.
1417 ** A couple of buffer overruns have been fixed.
1419 ** Problems when closing files should now be reported.
1421 ** Generated parsers should now work even on operating systems which do
1422 not provide alloca().
1424 * Changes in version 1.25, 1995-10-16:
1426 ** Errors in the input grammar are not fatal; Bison keeps reading
1427 the grammar file, and reports all the errors found in it.
1429 ** Tokens can now be specified as multiple-character strings: for
1430 example, you could use "<=" for a token which looks like <=, instead
1431 of chosing a name like LESSEQ.
1433 ** The %token_table declaration says to write a table of tokens (names
1434 and numbers) into the parser file. The yylex function can use this
1435 table to recognize multiple-character string tokens, or for other
1438 ** The %no_lines declaration says not to generate any #line preprocessor
1439 directives in the parser file.
1441 ** The %raw declaration says to use internal Bison token numbers, not
1442 Yacc-compatible token numbers, when token names are defined as macros.
1444 ** The --no-parser option produces the parser tables without including
1445 the parser engine; a project can now use its own parser engine.
1446 The actions go into a separate file called NAME.act, in the form of
1447 a switch statement body.
1449 * Changes in version 1.23:
1451 The user can define YYPARSE_PARAM as the name of an argument to be
1452 passed into yyparse. The argument should have type void *. It should
1453 actually point to an object. Grammar actions can access the variable
1454 by casting it to the proper pointer type.
1456 Line numbers in output file corrected.
1458 * Changes in version 1.22:
1460 --help option added.
1462 * Changes in version 1.20:
1464 Output file does not redefine const for C++.
1472 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
1473 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation,
1476 This file is part of Bison, the GNU Parser Generator.
1478 This program is free software: you can redistribute it and/or modify
1479 it under the terms of the GNU General Public License as published by
1480 the Free Software Foundation, either version 3 of the License, or
1481 (at your option) any later version.
1483 This program is distributed in the hope that it will be useful,
1484 but WITHOUT ANY WARRANTY; without even the implied warranty of
1485 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1486 GNU General Public License for more details.
1488 You should have received a copy of the GNU General Public License
1489 along with this program. If not, see <http://www.gnu.org/licenses/>.