]> git.saurik.com Git - bison.git/blobdiff - NEWS
Use the new code_props interface for destructors and printers.
[bison.git] / NEWS
diff --git a/NEWS b/NEWS
index 2b7c1013ba90e9607a28c85f0162bce884e5ac73..119521ccd93a5ba67fee4f4152e5054de42e4704 100644 (file)
--- a/NEWS
+++ b/NEWS
 Bison News
 ----------
 
 Bison News
 ----------
 
-Changes in version 2.1a:
+Changes in version 2.3a+ (????-??-??):
+
+* The -g and --graph options now output graphs in Graphviz DOT format,
+  not VCG format.
+
+* An experimental directive %language specifies the language of the
+  generated parser, which can be C (the default) or C++.  This
+  directive affects the skeleton used, and the names of the generated
+  files if the grammar file's name ends in ".y".
+
+* The grammar file may now specify the name of the parser header file using
+  %defines.  For example:
+
+    %defines "parser.h"
+
+* The `=' that used to be required in the following declarations is now
+  deprecated:
+
+    %file-prefix "parser"
+    %name-prefix "c_"
+    %output "parser.c"
+
+* Revised warning: unset or unused mid-rule values
+
+  Since Bison 2.2, Bison has warned about mid-rule values that are set but not
+  used within any of the actions of the parent rule.  For example, Bison warns
+  about unused $2 in:
+
+    exp: '1' { $$ = 1; } '+' exp { $$ = $1 + $4; };
+
+  Now, Bison also warns about mid-rule values that are used but not set.  For
+  example, Bison warns about unset $$ in the mid-rule action in:
+
+    exp: '1' { $1 = 1; } '+' exp { $$ = $2 + $4; };
+
+  However, Bison now disables both of these warnings by default since they
+  sometimes prove to be false alarms in existing grammars employing the Yacc
+  constructs $0 or $-N (where N is some positive integer).
+
+  To enable these warnings, specify the flag `--warnings=midrule-values' or
+  `-W', which is a synonym for `--warnings=all'.
+
+* Bison now recognizes two separate kinds of default %destructor's and
+  %printer's:
+
+    1. Place `<*>' in a %destructor/%printer symbol list to define a default
+       %destructor/%printer for all grammar symbols for which you have formally
+       declared semantic type tags.
+
+    2. Place `<>' in a %destructor/%printer symbol list to define a default
+       %destructor/%printer for all grammar symbols without declared semantic
+       type tags.
+
+  Bison no longer supports the `%symbol-default' notation from Bison 2.3a.
+  `<*>' and `<>' combined achieve the same effect with one exception: Bison no
+  longer applies any %destructor to a mid-rule value if that mid-rule value is
+  not actually ever referenced using either $$ or $n in a semantic action.
+
+  The default %destructor's and %printer's are experimental.  More user
+  feedback will help to determine whether they should become permanent
+  features.
+
+  See the section `Freeing Discarded Symbols' in the Bison manual for further
+  details.
+
+* The Yacc prologue alternatives from Bison 2.3a have been rewritten as the
+  following directives:
+
+    1. %code {CODE}
+
+       Other than semantic actions, this is probably the most common place you
+       should write verbatim code for the parser implementation.  It replaces
+       the traditional Yacc prologue, `%{CODE%}', for most purposes.  Compare
+       with:
+
+         - `%{CODE%}' appearing after the first `%union {CODE}' in a grammar
+          file.  While Bison will continue to support `%{CODE%}' for backward
+          compatibility, `%code {CODE}' is cleaner as its functionality does
+          not depend on its position in the grammar file relative to any
+          `%union {CODE}'.  Specifically, `%code {CODE}' always inserts your
+          CODE into the parser code file after the usual contents of the
+          parser header file.
+         - `%after-header {CODE}', which only Bison 2.3a supported.
+
+    2. %requires {CODE}
+
+       This is the right place to write dependency code for externally exposed
+       definitions required by Bison.  Such exposed definitions are those
+       usually appearing in the parser header file.  Thus, this is the right
+       place to define types referenced in `%union {CODE}' directives, and it
+       is the right place to override Bison's default YYSTYPE and YYLTYPE
+       definitions.  Compare with:
+
+         - `%{CODE%}' appearing before the first `%union {CODE}' in a grammar
+           file.  Unlike `%{CODE%}', `%requires {CODE}' inserts your CODE both
+           into the parser code file and into the parser header file since
+           Bison's required definitions should depend on it in both places.
+         - `%start-header {CODE}', which only Bison 2.3a supported.
+
+    3. %provides {CODE}
+
+       This is the right place to write additional definitions you would like
+       Bison to expose externally.  That is, this directive inserts your CODE
+       both into the parser header file and into the parser code file after
+       Bison's required definitions.  Compare with:
+
+         - `%end-header {CODE}', which only Bison 2.3a supported.
+
+    4. %code-top {CODE}
+
+       Occasionally it is desirable to insert code near the top of the parser
+       code file.  For example:
+
+         %code-top {
+           #define _GNU_SOURCE
+           #include <stdio.h>
+         }
+
+       Compare with:
+
+         - `%{CODE%}' appearing before the first `%union {CODE}' in a grammar
+           file.  `%code-top {CODE}' is cleaner as its functionality does not
+           depend on its position in the grammar file relative to any
+           `%union {CODE}'.
+         - `%before-header {CODE}', which only Bison 2.3a supported.
+
+  If you have multiple occurrences of any one of the above four directives,
+  Bison will concatenate the contents in the order they appear in the grammar
+  file.
+
+  The prologue alternatives are experimental.  More user feedback will help to
+  determine whether they should become permanent features.
+
+  Also see the new section `Prologue Alternatives' in the Bison manual.
+
+Changes in version 2.3a, 2006-09-13:
+
+* Instead of %union, you can define and use your own union type
+  YYSTYPE if your grammar contains at least one <type> tag.
+  Your YYSTYPE need not be a macro; it can be a typedef.
+  This change is for compatibility with other Yacc implementations,
+  and is required by POSIX.
+
+* Locations columns and lines start at 1.
+  In accordance with the GNU Coding Standards and Emacs.
+
+* You may now declare per-type and default %destructor's and %printer's:
+
+  For example:
+
+    %union { char *string; }
+    %token <string> STRING1
+    %token <string> STRING2
+    %type  <string> string1
+    %type  <string> string2
+    %union { char character; }
+    %token <character> CHR
+    %type  <character> chr
+    %destructor { free ($$); } %symbol-default
+    %destructor { free ($$); printf ("%d", @$.first_line); } STRING1 string1
+    %destructor { } <character>
+
+  guarantees that, when the parser discards any user-defined symbol that has a
+  semantic type tag other than `<character>', it passes its semantic value to
+  `free'.  However, when the parser discards a `STRING1' or a `string1', it
+  also prints its line number to `stdout'.  It performs only the second
+  `%destructor' in this case, so it invokes `free' only once.
+
+  [Although we failed to mention this here in the 2.3a release, the default
+  %destructor's and %printer's were experimental, and they were rewritten in
+  future versions.]
+
+* Except for LALR(1) parsers in C with POSIX Yacc emulation enabled (with `-y',
+  `--yacc', or `%yacc'), Bison no longer generates #define statements for
+  associating token numbers with token names.  Removing the #define statements
+  helps to sanitize the global namespace during preprocessing, but POSIX Yacc
+  requires them.  Bison still generates an enum for token names in all cases.
+
+* Handling of traditional Yacc prologue blocks is now more consistent but
+  potentially incompatible with previous releases of Bison.
+
+  As before, you declare prologue blocks in your grammar file with the
+  `%{ ... %}' syntax.  To generate the pre-prologue, Bison concatenates all
+  prologue blocks that you've declared before the first %union.  To generate
+  the post-prologue, Bison concatenates all prologue blocks that you've
+  declared after the first %union.
+
+  Previous releases of Bison inserted the pre-prologue into both the header
+  file and the code file in all cases except for LALR(1) parsers in C.  In the
+  latter case, Bison inserted it only into the code file.  For parsers in C++,
+  the point of insertion was before any token definitions (which associate
+  token numbers with names).  For parsers in C, the point of insertion was
+  after the token definitions.
+
+  Now, Bison never inserts the pre-prologue into the header file.  In the code
+  file, it always inserts it before the token definitions.
+
+* Bison now provides a more flexible alternative to the traditional Yacc
+  prologue blocks: %before-header, %start-header, %end-header, and
+  %after-header.
+
+  For example, the following declaration order in the grammar file reflects the
+  order in which Bison will output these code blocks.  However, you are free to
+  declare these code blocks in your grammar file in whatever order is most
+  convenient for you:
+
+    %before-header {
+      /* Bison treats this block like a pre-prologue block: it inserts it into
+       * the code file before the contents of the header file.  It does *not*
+       * insert it into the header file.  This is a good place to put
+       * #include's that you want at the top of your code file.  A common
+       * example is `#include "system.h"'.  */
+    }
+    %start-header {
+      /* Bison inserts this block into both the header file and the code file.
+       * In both files, the point of insertion is before any Bison-generated
+       * token, semantic type, location type, and class definitions.  This is a
+       * good place to define %union dependencies, for example.  */
+    }
+    %union {
+      /* Unlike the traditional Yacc prologue blocks, the output order for the
+       * new %*-header blocks is not affected by their declaration position
+       * relative to any %union in the grammar file.  */
+    }
+    %end-header {
+      /* Bison inserts this block into both the header file and the code file.
+       * In both files, the point of insertion is after the Bison-generated
+       * definitions.  This is a good place to declare or define public
+       * functions or data structures that depend on the Bison-generated
+       * definitions.  */
+    }
+    %after-header {
+      /* Bison treats this block like a post-prologue block: it inserts it into
+       * the code file after the contents of the header file.  It does *not*
+       * insert it into the header file.  This is a good place to declare or
+       * define internal functions or data structures that depend on the
+       * Bison-generated definitions.  */
+    }
+
+  If you have multiple occurrences of any one of the above declarations, Bison
+  will concatenate the contents in declaration order.
+
+  [Although we failed to mention this here in the 2.3a release, the prologue
+  alternatives were experimental, and they were rewritten in future versions.]
+
+* The option `--report=look-ahead' has been changed to `--report=lookahead'.
+  The old spelling still works, but is not documented and may be removed
+  in a future release.
+
+Changes in version 2.3, 2006-06-05:
+
+* GLR grammars should now use `YYRECOVERING ()' instead of `YYRECOVERING',
+  for compatibility with LALR(1) grammars.
+
+* It is now documented that any definition of YYSTYPE or YYLTYPE should
+  be to a type name that does not contain parentheses or brackets.
+
+Changes in version 2.2, 2006-05-19:
+
+* The distribution terms for all Bison-generated parsers now permit
+  using the parsers in nonfree programs.  Previously, this permission
+  was granted only for Bison-generated LALR(1) parsers in C.
+
+* %name-prefix changes the namespace name in C++ outputs.
+
+* The C++ parsers export their token_type.
+
+* Bison now allows multiple %union declarations, and concatenates
+  their contents together.
 
 * New warning: unused values
 
 * New warning: unused values
-  Typed right-hand side symbols whose value are not used are reported.
-  For instance:
+  Right-hand side symbols whose values are not used are reported,
+  if the symbols have destructors.  For instance:
 
      exp: exp "?" exp ":" exp { $1 ? $1 : $3; }
        | exp "+" exp
 
      exp: exp "?" exp ":" exp { $1 ? $1 : $3; }
        | exp "+" exp
@@ -13,19 +281,27 @@ Changes in version 2.1a:
 
   will trigger a warning about $$ and $5 in the first rule, and $3 in
   the second ($1 is copied to $$ by the default rule).  This example
 
   will trigger a warning about $$ and $5 in the first rule, and $3 in
   the second ($1 is copied to $$ by the default rule).  This example
-  most likely contains three errors, and should be rewritten as:
+  most likely contains three errors, and could be rewritten as:
 
 
-     exp: exp "?" exp ":" exp { $$ = $1 ? $3 : $5; }
-       | exp "+" exp         { $$ = $1 + $3; }
+     exp: exp "?" exp ":" exp
+           { $$ = $1 ? $3 : $5; free ($1 ? $5 : $3); free ($1); }
+       | exp "+" exp
+           { $$ = $1 ? $1 : $3; if ($1) free ($3); }
        ;
 
        ;
 
-  However, if the original actions were really intended, the warnings
-  can be suppressed by letting Bison believe the values are used, e.g.:
+  However, if the original actions were really intended, memory leaks
+  and all, the warnings can be suppressed by letting Bison believe the
+  values are used, e.g.:
 
      exp: exp "?" exp ":" exp { $1 ? $1 : $3; (void) ($$, $5); }
        | exp "+" exp         { $$ = $1; (void) $3; }
        ;
 
 
      exp: exp "?" exp ":" exp { $1 ? $1 : $3; (void) ($$, $5); }
        | exp "+" exp         { $$ = $1; (void) $3; }
        ;
 
+  If there are mid-rule actions, the warning is issued if no action
+  uses it.  The following triggers no warning: $1 and $3 are used.
+
+     exp: exp { push ($1); } '+' exp { push ($3); sum (); };
+
   The warning is intended to help catching lost values and memory leaks.
   If a value is ignored, its associated memory typically is not reclaimed.
 
   The warning is intended to help catching lost values and memory leaks.
   If a value is ignored, its associated memory typically is not reclaimed.
 
@@ -39,14 +315,14 @@ Changes in version 2.1a:
   instead of warnings.
 
 * GLR, YACC parsers.
   instead of warnings.
 
 * GLR, YACC parsers.
-  The %parse-params are available in the %destructor's (and the
-  experimental %printer's) as per the documentation.
+  The %parse-params are available in the destructors (and the
+  experimental printers) as per the documentation.
 
 * Bison now warns if it finds a stray `$' or `@' in an action.
 
 * %require "VERSION"
 
 * Bison now warns if it finds a stray `$' or `@' in an action.
 
 * %require "VERSION"
-  To specify that the grammar file depends on features implemented in
-  Bison version VERSION or higher.
+  This specifies that the grammar file depends on features implemented
+  in Bison version VERSION or higher.
 
 * lalr1.cc: The token and value types are now class members.
   The tokens were defined as free form enums and cpp macros.  YYSTYPE
 
 * lalr1.cc: The token and value types are now class members.
   The tokens were defined as free form enums and cpp macros.  YYSTYPE
@@ -60,10 +336,10 @@ Changes in version 2.1a:
   for previous releases of Bison, and this one.
 
   If you wish to update, then make sure older version of Bison will
   for previous releases of Bison, and this one.
 
   If you wish to update, then make sure older version of Bison will
-  fail using `%require "2.1a"'.
+  fail using `%require "2.2"'.
 
 * DJGPP support added.
 
 * DJGPP support added.
-
+\f
 Changes in version 2.1, 2005-09-16:
 
 * The C++ lalr1.cc skeleton supports %lex-param.
 Changes in version 2.1, 2005-09-16:
 
 * The C++ lalr1.cc skeleton supports %lex-param.
@@ -89,7 +365,7 @@ Changes in version 2.1, 2005-09-16:
   a syntax error associated with '%token NUM "number"' they might
   print 'syntax error, unexpected number' instead of 'syntax error,
   unexpected "number"'.
   a syntax error associated with '%token NUM "number"' they might
   print 'syntax error, unexpected number' instead of 'syntax error,
   unexpected "number"'.
-
+\f
 Changes in version 2.0, 2004-12-25:
 
 * Possibly-incompatible changes
 Changes in version 2.0, 2004-12-25:
 
 * Possibly-incompatible changes
@@ -132,8 +408,7 @@ Changes in version 2.0, 2004-12-25:
     This is a GNU extension.
 
   - The option `--report=lookahead' was changed to `--report=look-ahead'.
     This is a GNU extension.
 
   - The option `--report=lookahead' was changed to `--report=look-ahead'.
-    The old spelling still works, but is not documented and will be
-    removed.
+    [However, this was changed back after 2.3.]
 
   - Experimental %destructor support has been added to lalr1.cc.
 
 
   - Experimental %destructor support has been added to lalr1.cc.
 
@@ -400,8 +675,8 @@ Changes in version 1.50, 2002-10-04:
   produces additional information:
   - itemset
     complete the core item sets with their closure
   produces additional information:
   - itemset
     complete the core item sets with their closure
-  - lookahead [changed to `look-ahead' in 1.875e and later]
-    explicitly associate look-ahead tokens to items
+  - lookahead [changed to `look-ahead' in 1.875e through 2.3, but changed back]
+    explicitly associate lookahead tokens to items
   - solved
     describe shift/reduce conflicts solving.
     Bison used to systematically output this information on top of
   - solved
     describe shift/reduce conflicts solving.
     Bison used to systematically output this information on top of
@@ -684,8 +959,8 @@ End:
 
 -----
 
 
 -----
 
-Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
-Free Software Foundation, Inc.
+Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
+2004, 2005, 2006 Free Software Foundation, Inc.
 
 This file is part of Bison, the GNU Compiler Compiler.
 
 
 This file is part of Bison, the GNU Compiler Compiler.