X-Git-Url: https://git.saurik.com/bison.git/blobdiff_plain/8416323152330d563fcf329a2b593ac479511b3b..490abf53b1391c2bc49564bff71ac400880323ad:/doc/bison.texinfo diff --git a/doc/bison.texinfo b/doc/bison.texinfo index 03af981f..c7f4def9 100644 --- a/doc/bison.texinfo +++ b/doc/bison.texinfo @@ -46,7 +46,8 @@ END-INFO-DIR-ENTRY @ifinfo This file documents the Bison parser generator. -Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1995, 1998, 1999, 2000 +Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1995, 1998, 1999, +2000, 2001 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of @@ -88,7 +89,7 @@ instead of in the original English. @page @vskip 0pt plus 1filll Copyright @copyright{} 1988, 1989, 1990, 1991, 1992, 1993, 1995, 1998, -1999, 2000 +1999, 2000, 2001 Free Software Foundation, Inc. @sp 2 @@ -128,11 +129,13 @@ Cover art by Etienne Suvasa. @contents -@node Top, Introduction, (dir), (dir) +@ifnottex +@node Top +@top Bison -@ifinfo -This manual documents version @value{VERSION} of Bison. -@end ifinfo +This manual documents version @value{VERSION} of Bison, updated +@value{UPDATED}. +@end ifnottex @menu * Introduction:: @@ -155,9 +158,10 @@ Reference sections: * Invocation:: How to run Bison (to produce the parser source file). * Table of Symbols:: All the keywords of the Bison language are explained. * Glossary:: Basic concepts are explained. +* Copying This Manual:: License for copying this manual. * Index:: Cross-references to the text. - --- The Detailed Node Listing --- +@detailmenu --- The Detailed Node Listing --- The Concepts of Bison @@ -180,13 +184,14 @@ Examples * Infix Calc:: Infix (algebraic) notation calculator. Operator precedence is introduced. * Simple Error Recovery:: Continuing after syntax errors. +* Location Tracking Calc:: Demonstrating the use of @@@var{n} and @@$. * Multi-function Calc:: Calculator with memory and trig functions. It uses multiple data-types for semantic values. * Exercises:: Ideas for improving the multi-function calculator. Reverse Polish Notation Calculator -* Decls: Rpcalc Decls. Bison and C declarations for rpcalc. +* Decls: Rpcalc Decls. Prologue (declarations) for rpcalc. * Rules: Rpcalc Rules. Grammar Rules for rpcalc, with explanation. * Lexer: Rpcalc Lexer. The lexical analyzer. * Main: Rpcalc Main. The controlling function. @@ -200,6 +205,12 @@ Grammar Rules for @code{rpcalc} * Rpcalc Line:: * Rpcalc Expr:: +Location Tracking Calculator: @code{ltcalc} + +* Decls: Ltcalc Decls. Bison and C declarations for ltcalc. +* Rules: Ltcalc Rules. Grammar rules for ltcalc, with explanations. +* Lexer: Ltcalc Lexer. The lexical analyzer. + Multi-Function Calculator: @code{mfcalc} * Decl: Mfcalc Decl. Bison declarations for multi-function calculator. @@ -218,10 +229,10 @@ Bison Grammar Files Outline of a Bison Grammar -* C Declarations:: Syntax and usage of the C declarations section. +* Prologue:: Syntax and usage of the prologue (declarations section). * Bison Declarations:: Syntax and usage of the Bison declarations section. * Grammar Rules:: Syntax and usage of the grammar rules section. -* C Code:: Syntax and usage of the additional C code section. +* Epilogue:: Syntax and usage of the epilogue (additional code section). Defining Language Semantics @@ -294,9 +305,15 @@ Invoking Bison in alphabetical order by short options. * Option Cross Key:: Alphabetical list of long options. * VMS Invocation:: Bison command syntax on VMS. + +Copying This Manual + +* GNU Free Documentation License:: License for copying this manual. + +@end detailmenu @end menu -@node Introduction, Conditions, Top, Top +@node Introduction @unnumbered Introduction @cindex introduction @@ -322,7 +339,7 @@ multi-character string literals and other features. This edition corresponds to version @value{VERSION} of Bison. -@node Conditions, Copying, Introduction, Top +@node Conditions @unnumbered Conditions for Using Bison As of Bison version 1.24, we have changed the distribution terms for @@ -350,400 +367,9 @@ encourage people to make other software free. So we decided to make the practical conditions for using Bison match the practical conditions for using the other GNU tools. -@node Copying, Concepts, Conditions, Top -@unnumbered GNU GENERAL PUBLIC LICENSE -@center Version 2, June 1991 - -@display -Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc. -59 Temple Place - Suite 330, Boston, MA 02111-1307, USA - -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. -@end display - -@unnumberedsec Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software---to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - -@iftex -@unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION -@end iftex -@ifinfo -@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION -@end ifinfo - -@enumerate 0 -@item -This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The ``Program'', below, -refers to any such program or work, and a ``work based on the Program'' -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term ``modification''.) Each licensee is addressed as ``you''. - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - -@item -You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - -@item -You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - -@enumerate a -@item -You must cause the modified files to carry prominent notices -stating that you changed the files and the date of any change. - -@item -You must cause any work that you distribute or publish, that in -whole or in part contains or is derived from the Program or any -part thereof, to be licensed as a whole at no charge to all third -parties under the terms of this License. - -@item -If the modified program normally reads commands interactively -when run, you must cause it, when started running for such -interactive use in the most ordinary way, to print or display an -announcement including an appropriate copyright notice and a -notice that there is no warranty (or else, saying that you provide -a warranty) and that users may redistribute the program under -these conditions, and telling the user how to view a copy of this -License. (Exception: if the Program itself is interactive but -does not normally print such an announcement, your work based on -the Program is not required to print an announcement.) -@end enumerate - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - -@item -You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - -@enumerate a -@item -Accompany it with the complete corresponding machine-readable -source code, which must be distributed under the terms of Sections -1 and 2 above on a medium customarily used for software interchange; or, - -@item -Accompany it with a written offer, valid for at least three -years, to give any third party, for a charge no more than your -cost of physically performing source distribution, a complete -machine-readable copy of the corresponding source code, to be -distributed under the terms of Sections 1 and 2 above on a medium -customarily used for software interchange; or, - -@item -Accompany it with the information you received as to the offer -to distribute corresponding source code. (This alternative is -allowed only for noncommercial distribution and only if you -received the program in object code or executable form with such -an offer, in accord with Subsection b above.) -@end enumerate - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - -@item -You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - -@item -You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - -@item -Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - -@item -If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - -@item -If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - -@item -The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and ``any -later version'', you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - -@item -If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - -@iftex -@heading NO WARRANTY -@end iftex -@ifinfo -@center NO WARRANTY -@end ifinfo - -@item -BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - -@item -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. -@end enumerate - -@iftex -@heading END OF TERMS AND CONDITIONS -@end iftex -@ifinfo -@center END OF TERMS AND CONDITIONS -@end ifinfo - -@page -@unnumberedsec How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the ``copyright'' line and a pointer to where the full notice is found. - -@smallexample -@var{one line to give the program's name and a brief idea of what it does.} -Copyright (C) 19@var{yy} @var{name of author} - -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 59 Temple Place - Suite 330, -Boston, MA 02111-1307, USA. -@end smallexample - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - -@smallexample -Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author} -Gnomovision comes with ABSOLUTELY NO WARRANTY; for details -type `show w'. -This is free software, and you are welcome to redistribute it -under certain conditions; type `show c' for details. -@end smallexample +@include gpl.texi -The hypothetical commands @samp{show w} and @samp{show c} should show -the appropriate parts of the General Public License. Of course, the -commands you use may be called something other than @samp{show w} and -@samp{show c}; they could even be mouse-clicks or menu items---whatever -suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a ``copyright disclaimer'' for the program, if -necessary. Here is a sample; alter the names: - -@smallexample -Yoyodyne, Inc., hereby disclaims all copyright interest in the program -`Gnomovision' (which makes passes at compilers) written by James Hacker. - -@var{signature of Ty Coon}, 1 April 1989 -Ty Coon, President of Vice -@end smallexample - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. - -@node Concepts, Examples, Copying, Top +@node Concepts @chapter The Concepts of Bison This chapter introduces many of the basic concepts without which the @@ -765,7 +391,7 @@ use Bison or Yacc, we suggest you start by reading this chapter carefully. * Grammar Layout:: Overall structure of a Bison grammar file. @end menu -@node Language and Grammar, Grammar in Bison, , Concepts +@node Language and Grammar @section Languages and Context-Free Grammars @cindex context-free grammar @@ -874,7 +500,7 @@ the grammar's start symbol. If we use a grammar for C, the entire input must be a `sequence of definitions and declarations'. If not, the parser reports a syntax error. -@node Grammar in Bison, Semantic Values, Language and Grammar, Concepts +@node Grammar in Bison @section From Formal Rules to Bison Input @cindex Bison grammar @cindex grammar, Bison @@ -919,7 +545,7 @@ stmt: RETURN expr ';' @noindent @xref{Rules, ,Syntax of Grammar Rules}. -@node Semantic Values, Semantic Actions, Grammar in Bison, Concepts +@node Semantic Values @section Semantic Values @cindex semantic value @cindex value, semantic @@ -961,7 +587,7 @@ semantic value that is a number. In a compiler for a programming language, an expression typically has a semantic value that is a tree structure describing the meaning of the expression. -@node Semantic Actions, Locations Overview, Semantic Values, Concepts +@node Semantic Actions @section Semantic Actions @cindex semantic actions @cindex actions, semantic @@ -992,7 +618,7 @@ expr: expr '+' expr @{ $$ = $1 + $3; @} The action says how to produce the semantic value of the sum expression from the values of the two subexpressions. -@node Locations Overview, Bison Parser, Semantic Actions, Concepts +@node Locations Overview @section Locations @cindex location @cindex textual position @@ -1021,7 +647,7 @@ rule how @code{@@$} should be formed. When building a new location for a given grouping, the default behavior of the output parser is to take the beginning of the first symbol, and the end of the last symbol. -@node Bison Parser, Stages, Locations Overview, Concepts +@node Bison Parser @section Bison Output: the Parser File @cindex Bison parser @cindex Bison utility @@ -1066,7 +692,7 @@ Therefore, you should avoid using C identifiers starting with @samp{yy} or @samp{YY} in the Bison grammar file except for the ones defined in this manual. -@node Stages, Grammar Layout, Bison Parser, Concepts +@node Stages @section Stages in Using Bison @cindex stages in using Bison @cindex using Bison @@ -1108,7 +734,7 @@ Compile the code output by Bison, as well as any other source files. Link the object files to produce the finished product. @end enumerate -@node Grammar Layout, , Stages, Concepts +@node Grammar Layout @section The Overall Layout of a Bison Grammar @cindex grammar file @cindex file format @@ -1120,7 +746,7 @@ general form of a Bison grammar file is as follows: @example %@{ -@var{C declarations} +@var{Prologue (declarations)} %@} @var{Bison declarations} @@ -1128,15 +754,15 @@ general form of a Bison grammar file is as follows: %% @var{Grammar rules} %% -@var{Additional C code} +@var{Epilogue (additional code)} @end example @noindent The @samp{%%}, @samp{%@{} and @samp{%@}} are punctuation that appears in every Bison grammar file to separate the sections. -The C declarations may define types and variables used in the actions. -You can also use preprocessor commands to define macros used there, and use +The prologue may define types and variables used in the actions. You can +also use preprocessor commands to define macros used there, and use @code{#include} to include header files that do any of these things. The Bison declarations declare the names of the terminal and nonterminal @@ -1146,12 +772,12 @@ semantic values of various symbols. The grammar rules define how to construct each nonterminal symbol from its parts. -The additional C code can contain any C code you want to use. Often the -definition of the lexical analyzer @code{yylex} goes here, plus subroutines -called by the actions in the grammar rules. In a simple program, all the -rest of the program can go here. +The epilogue can contain any code you want to use. Often the definition of +the lexical analyzer @code{yylex} goes here, plus subroutines called by the +actions in the grammar rules. In a simple program, all the rest of the +program can go here. -@node Examples, Grammar File, Concepts, Top +@node Examples @chapter Examples @cindex simple examples @cindex examples, simple @@ -1175,12 +801,13 @@ to try them. * Infix Calc:: Infix (algebraic) notation calculator. Operator precedence is introduced. * Simple Error Recovery:: Continuing after syntax errors. +* Location Tracking Calc:: Demonstrating the use of @@@var{n} and @@$. * Multi-function Calc:: Calculator with memory and trig functions. It uses multiple data-types for semantic values. * Exercises:: Ideas for improving the multi-function calculator. @end menu -@node RPN Calc, Infix Calc, , Examples +@node RPN Calc @section Reverse Polish Notation Calculator @cindex reverse polish notation @cindex polish notation calculator @@ -1196,7 +823,7 @@ The source code for this calculator is named @file{rpcalc.y}. The @samp{.y} extension is a convention used for Bison input files. @menu -* Decls: Rpcalc Decls. Bison and C declarations for rpcalc. +* Decls: Rpcalc Decls. Prologue (declarations) for rpcalc. * Rules: Rpcalc Rules. Grammar Rules for rpcalc, with explanation. * Lexer: Rpcalc Lexer. The lexical analyzer. * Main: Rpcalc Main. The controlling function. @@ -1205,7 +832,7 @@ The source code for this calculator is named @file{rpcalc.y}. The * Comp: Rpcalc Compile. Run the C compiler on the output code. @end menu -@node Rpcalc Decls, Rpcalc Rules, , RPN Calc +@node Rpcalc Decls @subsection Declarations for @code{rpcalc} Here are the C and Bison declarations for the reverse polish notation @@ -1224,7 +851,7 @@ calculator. As in C, comments are placed between @samp{/*@dots{}*/}. %% /* Grammar rules and actions follow */ @end example -The C declarations section (@pxref{C Declarations, ,The C Declarations Section}) contains two +The declarations section (@pxref{Prologue, , The prologue}) contains two preprocessor directives. The @code{#define} directive defines the macro @code{YYSTYPE}, thus @@ -1245,7 +872,7 @@ arithmetic operators are designated by single-character literals, so the only terminal symbol that needs to be declared is @code{NUM}, the token type for numeric constants. -@node Rpcalc Rules, Rpcalc Lexer, Rpcalc Decls, RPN Calc +@node Rpcalc Rules @subsection Grammar Rules for @code{rpcalc} Here are the grammar rules for the reverse polish notation calculator. @@ -1296,7 +923,7 @@ rule are referred to as @code{$1}, @code{$2}, and so on. * Rpcalc Expr:: @end menu -@node Rpcalc Input, Rpcalc Line, , Rpcalc Rules +@node Rpcalc Input @subsubsection Explanation of @code{input} Consider the definition of @code{input}: @@ -1330,7 +957,7 @@ The parser function @code{yyparse} continues to process input until a grammatical error is seen or the lexical analyzer says there are no more input tokens; we will arrange for the latter to happen at end of file. -@node Rpcalc Line, Rpcalc Expr, Rpcalc Input, Rpcalc Rules +@node Rpcalc Line @subsubsection Explanation of @code{line} Now consider the definition of @code{line}: @@ -1355,7 +982,7 @@ uninitialized (its value will be unpredictable). This would be a bug if that value were ever used, but we don't use it: once rpcalc has printed the value of the user's input line, that value is no longer needed. -@node Rpcalc Expr, , Rpcalc Line, Rpcalc Rules +@node Rpcalc Expr @subsubsection Explanation of @code{expr} The @code{exp} grouping has several rules, one for each kind of expression. @@ -1414,7 +1041,7 @@ exp: NUM @noindent The latter, however, is much more readable. -@node Rpcalc Lexer, Rpcalc Main, Rpcalc Rules, RPN Calc +@node Rpcalc Lexer @subsection The @code{rpcalc} Lexical Analyzer @cindex writing a lexical analyzer @cindex lexical analyzer, writing @@ -1489,7 +1116,7 @@ yylex (void) @end group @end example -@node Rpcalc Main, Rpcalc Error, Rpcalc Lexer, RPN Calc +@node Rpcalc Main @subsection The Controlling Function @cindex controlling function @cindex main function in simple example @@ -1508,7 +1135,7 @@ main (void) @end group @end example -@node Rpcalc Error, Rpcalc Gen, Rpcalc Main, RPN Calc +@node Rpcalc Error @subsection The Error Reporting Routine @cindex error reporting routine @@ -1537,7 +1164,7 @@ have not written any error rules in this example, so any invalid input will cause the calculator program to exit. This is not clean behavior for a real calculator, but it is adequate for the first example. -@node Rpcalc Gen, Rpcalc Compile, Rpcalc Error, RPN Calc +@node Rpcalc Gen @subsection Running Bison to Make the Parser @cindex running Bison (introduction) @@ -1545,8 +1172,8 @@ Before running Bison to produce a parser, we need to decide how to arrange all the source code in one or more source files. For such a simple example, the easiest thing is to put everything in one file. The definitions of @code{yylex}, @code{yyerror} and @code{main} go at the -end, in the ``additional C code'' section of the file (@pxref{Grammar -Layout, ,The Overall Layout of a Bison Grammar}). +end, in the epilogue of the file +(@pxref{Grammar Layout, ,The Overall Layout of a Bison Grammar}). For a large project, you would probably have several source files, and use @code{make} to arrange to recompile them. @@ -1566,7 +1193,7 @@ Bison contains the source code for @code{yyparse}. The additional functions in the input file (@code{yylex}, @code{yyerror} and @code{main}) are copied verbatim to the output. -@node Rpcalc Compile, , Rpcalc Gen, RPN Calc +@node Rpcalc Compile @subsection Compiling the Parser File @cindex compiling the parser @@ -1611,7 +1238,7 @@ example session using @code{rpcalc}. % @end example -@node Infix Calc, Simple Error Recovery, RPN Calc, Examples +@node Infix Calc @section Infix Notation Calculator: @code{calc} @cindex infix notation calculator @cindex @code{calc} @@ -1697,7 +1324,7 @@ Here is a sample run of @file{calc.y}: 9 @end example -@node Simple Error Recovery, Multi-function Calc, Infix Calc, Examples +@node Simple Error Recovery @section Simple Error Recovery @cindex error recovery, simple @@ -1739,7 +1366,205 @@ input lines; it would also have to discard the rest of the current line of input. We won't discuss this issue further because it is not specific to Bison programs. -@node Multi-function Calc, Exercises, Simple Error Recovery, Examples +@node Location Tracking Calc +@section Location Tracking Calculator: @code{ltcalc} +@cindex location tracking calculator +@cindex @code{ltcalc} +@cindex calculator, location tracking + +This example extends the infix notation calculator with location tracking. +This feature will be used to improve error reporting, and provide better +error messages. + +For the sake of clarity, we will switch for this example to an integer +calculator, since most of the work needed to use locations will be done +in the lexical analyser. + +@menu +* Decls: Ltcalc Decls. Bison and C declarations for ltcalc. +* Rules: Ltcalc Rules. Grammar rules for ltcalc, with explanations. +* Lexer: Ltcalc Lexer. The lexical analyzer. +@end menu + +@node Ltcalc Decls +@subsection Declarations for @code{ltcalc} + +The C and Bison declarations for the location tracking calculator are the same +as the declarations for the infix notation calculator. + +@example +/* Location tracking calculator. */ + +%@{ +#define YYSTYPE int +#include +%@} + +/* Bison declarations. */ +%token NUM + +%left '-' '+' +%left '*' '/' +%left NEG +%right '^' + +%% /* Grammar follows */ +@end example + +In the code above, there are no declarations specific to locations. Defining +a data type for storing locations is not needed: we will use the type provided +by default (@pxref{Location Type, ,Data Types of Locations}), which is a four +member structure with the following integer fields: @code{first_line}, +@code{first_column}, @code{last_line} and @code{last_column}. + +@node Ltcalc Rules +@subsection Grammar Rules for @code{ltcalc} + +Whether you choose to handle locations or not has no effect on the syntax of +your language. Therefore, grammar rules for this example will be very close to +those of the previous example: we will only modify them to benefit from the new +informations we will have. + +Here, we will use locations to report divisions by zero, and locate the wrong +expressions or subexpressions. + +@example +@group +input : /* empty */ + | input line +; +@end group + +@group +line : '\n' + | exp '\n' @{ printf ("%d\n", $1); @} +; +@end group + +@group +exp : NUM @{ $$ = $1; @} + | exp '+' exp @{ $$ = $1 + $3; @} + | exp '-' exp @{ $$ = $1 - $3; @} + | exp '*' exp @{ $$ = $1 * $3; @} +@end group + | exp '/' exp +@group + @{ + if ($3) + $$ = $1 / $3; + else + @{ + $$ = 1; + printf("Division by zero, l%d,c%d-l%d,c%d", + @@3.first_line, @@3.first_column, + @@3.last_line, @@3.last_column); + @} + @} +@end group +@group + | '-' exp %preg NEG @{ $$ = -$2; @} + | exp '^' exp @{ $$ = pow ($1, $3); @} + | '(' exp ')' @{ $$ = $2; @} +@end group +@end example + +This code shows how to reach locations inside of semantic actions, by +using the pseudo-variables @code{@@@var{n}} for rule components, and the +pseudo-variable @code{@@$} for groupings. + +In this example, we never assign a value to @code{@@$}, because the +output parser can do this automatically. By default, before executing +the C code of each action, @code{@@$} is set to range from the beginning +of @code{@@1} to the end of @code{@@@var{n}}, for a rule with @var{n} +components. + +Of course, this behavior can be redefined (@pxref{Location Default +Action, , Default Action for Locations}), and for very specific rules, +@code{@@$} can be computed by hand. + +@node Ltcalc Lexer +@subsection The @code{ltcalc} Lexical Analyzer. + +Until now, we relied on Bison's defaults to enable location tracking. The next +step is to rewrite the lexical analyser, and make it able to feed the parser +with locations of tokens, as he already does for semantic values. + +To do so, we must take into account every single character of the input text, +to avoid the computed locations of being fuzzy or wrong: + +@example +@group +int +yylex (void) +@{ + int c; + + /* skip white space */ + while ((c = getchar ()) == ' ' || c == '\t') + ++yylloc.last_column; + + /* step */ + yylloc.first_line = yylloc.last_line; + yylloc.first_column = yylloc.last_column; +@end group + +@group + /* process numbers */ + if (isdigit (c)) + @{ + yylval = c - '0'; + ++yylloc.last_column; + while (isdigit (c = getchar ())) + @{ + ++yylloc.last_column; + yylval = yylval * 10 + c - '0'; + @} + ungetc (c, stdin); + return NUM; + @} +@end group + + /* return end-of-file */ + if (c == EOF) + return 0; + + /* return single chars and update location */ + if (c == '\n') + @{ + ++yylloc.last_line; + yylloc.last_column = 0; + @} + else + ++yylloc.last_column; + return c; +@} +@end example + +Basically, the lexical analyzer does the same processing as before: it skips +blanks and tabs, and reads numbers or single-character tokens. In addition +to this, it updates the @code{yylloc} global variable (of type @code{YYLTYPE}), +where the location of tokens is stored. + +Now, each time this function returns a token, the parser has it's number as +well as it's semantic value, and it's position in the text. The last needed +change is to initialize @code{yylloc}, for example in the controlling +function: + +@example +int +main (void) +@{ + yylloc.first_line = yylloc.last_line = 1; + yylloc.first_column = yylloc.last_column = 0; + return yyparse (); +@} +@end example + +Remember that computing locations is not a matter of syntax. Every character +must be associated to a location update, whether it is in valid input, in +comments, in literal strings, and so on... + +@node Multi-function Calc @section Multi-Function Calculator: @code{mfcalc} @cindex multi-function calculator @cindex @code{mfcalc} @@ -1791,7 +1616,7 @@ Note that multiple assignment and nested function calls are permitted. * Symtab: Mfcalc Symtab. Symbol table management subroutines. @end menu -@node Mfcalc Decl, Mfcalc Rules, , Multi-function Calc +@node Mfcalc Decl @subsection Declarations for @code{mfcalc} Here are the C and Bison declarations for the multi-function calculator. @@ -1842,7 +1667,7 @@ just as @code{%token} is used for declaring token types. We have not used implicitly by the rules that define them. But @code{exp} must be declared explicitly so we can specify its value type. @xref{Type Decl, ,Nonterminal Symbols}. -@node Mfcalc Rules, Mfcalc Symtab, Mfcalc Decl, Multi-function Calc +@node Mfcalc Rules @subsection Grammar Rules for @code{mfcalc} Here are the grammar rules for the multi-function calculator. @@ -1876,7 +1701,7 @@ exp: NUM @{ $$ = $1; @} %% @end smallexample -@node Mfcalc Symtab, , Mfcalc Rules, Multi-function Calc +@node Mfcalc Symtab @subsection The @code{mfcalc} Symbol Table @cindex symbol table example @@ -2117,7 +1942,7 @@ This program is both powerful and flexible. You may easily add new functions, and it is a simple job to modify this code to install predefined variables such as @code{pi} or @code{e} as well. -@node Exercises, , Multi-function Calc, Examples +@node Exercises @section Exercises @cindex exercises @@ -2135,7 +1960,7 @@ Make the program report an error if the user refers to an uninitialized variable in any way except to store a value in it. @end enumerate -@node Grammar File, Interface, Examples, Top +@node Grammar File @chapter Bison Grammar Files Bison takes as input a context-free grammar specification and produces a @@ -2155,7 +1980,7 @@ The Bison grammar input file conventionally has a name ending in @samp{.y}. * Multiple Parsers:: Putting more than one Bison parser in one program. @end menu -@node Grammar Outline, Symbols, , Grammar File +@node Grammar Outline @section Outline of a Bison Grammar A Bison grammar file has four main sections, shown here with the @@ -2163,7 +1988,7 @@ appropriate delimiters: @example %@{ -@var{C declarations} +@var{Prologue} %@} @var{Bison declarations} @@ -2172,24 +1997,25 @@ appropriate delimiters: @var{Grammar rules} %% -@var{Additional C code} +@var{Epilogue} @end example Comments enclosed in @samp{/* @dots{} */} may appear in any of the sections. @menu -* C Declarations:: Syntax and usage of the C declarations section. +* Prologue:: Syntax and usage of the prologue. * Bison Declarations:: Syntax and usage of the Bison declarations section. * Grammar Rules:: Syntax and usage of the grammar rules section. -* C Code:: Syntax and usage of the additional C code section. +* Epilogue:: Syntax and usage of the epilogue. @end menu -@node C Declarations, Bison Declarations, , Grammar Outline -@subsection The C Declarations Section -@cindex C declarations section -@cindex declarations, C +@node Prologue, Bison Declarations, , Grammar Outline +@subsection The prologue +@cindex declarations section +@cindex Prologue +@cindex declarations -The @var{C declarations} section contains macro definitions and +The @var{prologue} section contains macro definitions and declarations of functions and variables that are used in the actions in the grammar rules. These are copied to the beginning of the parser file so that they precede the definition of @code{yyparse}. You can use @@ -2197,7 +2023,7 @@ that they precede the definition of @code{yyparse}. You can use need any C declarations, you may omit the @samp{%@{} and @samp{%@}} delimiters that bracket this section. -@node Bison Declarations, Grammar Rules, C Declarations, Grammar Outline +@node Bison Declarations @subsection The Bison Declarations Section @cindex Bison declarations (introduction) @cindex declarations, Bison (introduction) @@ -2207,7 +2033,7 @@ terminal and nonterminal symbols, specify precedence, and so on. In some simple grammars you may not need any declarations. @xref{Declarations, ,Bison Declarations}. -@node Grammar Rules, C Code, Bison Declarations, Grammar Outline +@node Grammar Rules @subsection The Grammar Rules Section @cindex grammar rules section @cindex rules section for grammar @@ -2219,18 +2045,18 @@ There must always be at least one grammar rule, and the first @samp{%%} (which precedes the grammar rules) may never be omitted even if it is the first thing in the file. -@node C Code, , Grammar Rules, Grammar Outline -@subsection The Additional C Code Section +@node Epilogue, , Grammar Rules, Grammar Outline +@subsection The epilogue @cindex additional C code section +@cindex epilogue @cindex C code, section for additional -The @var{additional C code} section is copied verbatim to the end of the -parser file, just as the @var{C declarations} section is copied to the -beginning. This is the most convenient place to put anything that you -want to have in the parser file but which need not come before the -definition of @code{yyparse}. For example, the definitions of -@code{yylex} and @code{yyerror} often go here. @xref{Interface, ,Parser -C-Language Interface}. +The @var{epilogue} is copied verbatim to the end of the parser file, just as +the @var{prologue} is copied to the beginning. This is the most convenient +place to put anything that you want to have in the parser file but which need +not come before the definition of @code{yyparse}. For example, the +definitions of @code{yylex} and @code{yyerror} often go here. +@xref{Interface, ,Parser C-Language Interface}. If the last section is empty, you may omit the @samp{%%} that separates it from the grammar rules. @@ -2238,9 +2064,9 @@ from the grammar rules. The Bison parser itself contains many static variables whose names start with @samp{yy} and many macros whose names start with @samp{YY}. It is a good idea to avoid using any such names (except those documented in this -manual) in the additional C code section of the grammar file. +manual) in the epilogue of the grammar file. -@node Symbols, Rules, Grammar Outline, Grammar File +@node Symbols @section Symbols, Terminal and Nonterminal @cindex nonterminal symbol @cindex terminal symbol @@ -2352,7 +2178,7 @@ The symbol @code{error} is a terminal symbol reserved for error recovery (@pxref{Error Recovery}); you shouldn't use it for any other purpose. In particular, @code{yylex} should never return this value. -@node Rules, Recursion, Symbols, Grammar File +@node Rules @section Syntax of Grammar Rules @cindex rule syntax @cindex grammar rule syntax @@ -2447,7 +2273,7 @@ expseq1: exp It is customary to write a comment @samp{/* empty */} in each rule with no components. -@node Recursion, Semantics, Rules, Grammar File +@node Recursion @section Recursive Rules @cindex recursive rule @@ -2516,7 +2342,7 @@ primary: constant defines two mutually-recursive nonterminals, since each refers to the other. -@node Semantics, Locations, Recursion, Grammar File +@node Semantics @section Defining Language Semantics @cindex defining language semantics @cindex language semantics, defining @@ -2540,7 +2366,7 @@ the numbers associated with @var{x} and @var{y}. action in the middle of a rule. @end menu -@node Value Type, Multiple Types, , Semantics +@node Value Type @subsection Data Types of Semantic Values @cindex semantic value type @cindex value type, semantic @@ -2559,10 +2385,10 @@ specify some other type, define @code{YYSTYPE} as a macro, like this: @end example @noindent -This macro definition must go in the C declarations section of the grammar -file (@pxref{Grammar Outline, ,Outline of a Bison Grammar}). +This macro definition must go in the prologue of the grammar file +(@pxref{Grammar Outline, ,Outline of a Bison Grammar}). -@node Multiple Types, Actions, Value Type, Semantics +@node Multiple Types @subsection More Than One Value Type In most programs, you will need different data types for different kinds @@ -2586,7 +2412,7 @@ and for groupings with the @code{%type} Bison declaration (@pxref{Type Decl, ,Nonterminal Symbols}). @end itemize -@node Actions, Action Types, Multiple Types, Semantics +@node Actions @subsection Actions @cindex action @vindex $$ @@ -2662,7 +2488,7 @@ As long as @code{bar} is used only in the fashion shown here, @code{$0} always refers to the @code{expr} which precedes @code{bar} in the definition of @code{foo}. -@node Action Types, Mid-Rule Actions, Actions, Semantics +@node Action Types @subsection Data Types of Values in Actions @cindex action data types @cindex data types in actions @@ -2707,7 +2533,7 @@ reference. For example, if you have defined types as shown here: then you can write @code{$1} to refer to the first subunit of the rule as an integer, or @code{$1} to refer to it as a double. -@node Mid-Rule Actions, , Action Types, Semantics +@node Mid-Rule Actions @subsection Actions in Mid-Rule @cindex actions in mid-rule @cindex mid-rule actions @@ -2730,8 +2556,8 @@ The mid-rule action can also have a semantic value. The action can set its value with an assignment to @code{$$}, and actions later in the rule can refer to the value using @code{$@var{n}}. Since there is no symbol to name the action, there is no way to declare a data type for the value -in advance, so you must use the @samp{$<@dots{}>} construct to specify a -data type each time you refer to this value. +in advance, so you must use the @samp{$<@dots{}>@var{n}} construct to +specify a data type each time you refer to this value. There is no way to set the value of the entire rule with a mid-rule action, because assignments to @code{$$} do not have that effect. The @@ -2869,7 +2695,7 @@ the action is now at the end of its rule. Any mid-rule action can be converted to an end-of-rule action in this way, and this is what Bison actually does to implement mid-rule actions. -@node Locations, Declarations, Semantics, Grammar File +@node Locations @section Tracking Locations @cindex location @cindex textual position @@ -2877,7 +2703,9 @@ actually does to implement mid-rule actions. Though grammar rules and semantic actions are enough to write a fully functional parser, it can be useful to process some additionnal informations, -especially locations of tokens and groupings. +especially symbol locations. + +@c (terminal or not) ? The way locations are handled is defined by providing a data type, and actions to take when rules are matched. @@ -2888,7 +2716,7 @@ to take when rules are matched. * Location Default Action:: Defining a general way to compute locations. @end menu -@node Location Type, Actions and Locations, , Locations +@node Location Type @subsection Data Type of Locations @cindex data type of locations @cindex default location type @@ -2910,7 +2738,7 @@ struct @} @end example -@node Actions and Locations, Location Default Action, Location Type, Locations +@node Actions and Locations @subsection Actions and Locations @cindex location actions @cindex actions, location @@ -2927,61 +2755,101 @@ The location of the @var{n}th component of the right hand side is @code{@@@var{n}}, while the location of the left hand side grouping is @code{@@$}. -Here is a simple example using the default data type for locations: +Here is a basic example using the default data type for locations: @example @group exp: @dots{} - | exp '+' exp + | exp '/' exp @{ + @@$.first_column = @@1.first_column; + @@$.first_line = @@1.first_line; @@$.last_column = @@3.last_column; @@$.last_line = @@3.last_line; - $$ = $1 + $3; + if ($3) + $$ = $1 / $3; + else + @{ + $$ = 1; + printf("Division by zero, l%d,c%d-l%d,c%d", + @@3.first_line, @@3.first_column, + @@3.last_line, @@3.last_column); + @} @} @end group @end example -@noindent -In the example above, there is no need to set the beginning of @code{@@$}. The -output parser always sets @code{@@$} to @code{@@1} before executing the C -code of a given action, whether you provide a processing for locations or not. +As for semantic values, there is a default action for locations that is +run each time a rule is matched. It sets the beginning of @code{@@$} to the +beginning of the first symbol, and the end of @code{@@$} to the end of the +last symbol. + +With this default action, the location tracking can be fully automatic. The +example above simply rewrites this way: -@node Location Default Action, , Actions and Locations, Locations +@example +@group +exp: @dots{} + | exp '/' exp + @{ + if ($3) + $$ = $1 / $3; + else + @{ + $$ = 1; + printf("Division by zero, l%d,c%d-l%d,c%d", + @@3.first_line, @@3.first_column, + @@3.last_line, @@3.last_column); + @} + @} +@end group +@end example + +@node Location Default Action @subsection Default Action for Locations @vindex YYLLOC_DEFAULT Actually, actions are not the best place to compute locations. Since locations are much more general than semantic values, there is room in the output parser -to define a default action to take for each rule. The @code{YYLLOC_DEFAULT} -macro is called each time a rule is matched, before the associated action is -run. +to redefine the default action to take for each rule. The +@code{YYLLOC_DEFAULT} macro is called each time a rule is matched, before the +associated action is run. -@c Documentation for the old (?) YYLLOC_DEFAULT +Most of the time, this macro is general enough to suppress location +dedicated code from semantic actions. -This macro takes two parameters, the first one being the location of the -grouping (the result of the computation), and the second one being the -location of the last element matched. Of course, before @code{YYLLOC_DEFAULT} -is run, the result is set to the location of the first component matched. +The @code{YYLLOC_DEFAULT} macro takes three parameters. The first one is +the location of the grouping (the result of the computation). The second one +is an array holding locations of all right hand side elements of the rule +being matched. The last one is the size of the right hand side rule. -By default, this macro computes a location that ranges from the beginning of -the first element to the end of the last element. It is defined this way: +By default, it is defined this way: @example @group -#define YYLLOC_DEFAULT(Current, Last) \ - Current.last_line = Last.last_line; \ - Current.last_column = Last.last_column; +#define YYLLOC_DEFAULT(Current, Rhs, N) \ + Current.last_line = Rhs[N].last_line; \ + Current.last_column = Rhs[N].last_column; @end group @end example -@c not Documentation for the old (?) YYLLOC_DEFAULT +When defining @code{YYLLOC_DEFAULT}, you should consider that: -@noindent +@itemize @bullet +@item +All arguments are free of side-effects. However, only the first one (the +result) should be modified by @code{YYLLOC_DEFAULT}. -Most of the time, the default action for locations is general enough to -suppress location dedicated code from most actions. +@item +Before @code{YYLLOC_DEFAULT} is executed, the output parser sets @code{@@$} +to @code{@@1}. -@node Declarations, Multiple Parsers, Locations, Grammar File +@item +For consistency with semantic actions, valid indexes for the location array +range from 1 to @var{n}. +@end itemize + +@node Declarations @section Bison Declarations @cindex declarations, Bison @cindex Bison declarations @@ -3010,7 +2878,7 @@ it explicitly (@pxref{Language and Grammar, ,Languages and Context-Free Grammars * Decl Summary:: Table of all Bison declarations. @end menu -@node Token Decl, Precedence Decl, , Declarations +@node Token Decl @subsection Token Type Names @cindex declaring token type names @cindex token type names, declaring @@ -3084,7 +2952,7 @@ interchangeably in further declarations or the grammar rules. The @code{yylex} function can use the token name or the literal string to obtain the token type code number (@pxref{Calling Convention}). -@node Precedence Decl, Union Decl, Token Decl, Declarations +@node Precedence Decl @subsection Operator Precedence @cindex precedence declarations @cindex declaring operator precedence @@ -3133,7 +3001,7 @@ When two tokens declared in different precedence declarations associate, the one declared later has the higher precedence and is grouped first. @end itemize -@node Union Decl, Type Decl, Precedence Decl, Declarations +@node Union Decl @subsection The Collection of Value Types @cindex declaring value types @cindex value types, declaring @@ -3164,7 +3032,7 @@ for a terminal or nonterminal symbol (@pxref{Type Decl, ,Nonterminal Symbols}). Note that, unlike making a @code{union} declaration in C, you do not write a semicolon after the closing brace. -@node Type Decl, Expect Decl, Union Decl, Declarations +@node Type Decl @subsection Nonterminal Symbols @cindex declaring value types, nonterminals @cindex value types, nonterminals, declaring @@ -3191,7 +3059,7 @@ use the same @code{<@var{type}>} construction in a declaration for the terminal symbol. All kinds of token declarations allow @code{<@var{type}>}. -@node Expect Decl, Start Decl, Type Decl, Declarations +@node Expect Decl @subsection Suppressing Conflict Warnings @cindex suppressing conflict warnings @cindex preventing warnings about conflicts @@ -3239,7 +3107,7 @@ Now Bison will stop annoying you about the conflicts you have checked, but it will warn you again if changes in the grammar result in additional conflicts. -@node Start Decl, Pure Decl, Expect Decl, Declarations +@node Start Decl @subsection The Start-Symbol @cindex declaring the start symbol @cindex start symbol, declaring @@ -3254,7 +3122,7 @@ may override this restriction with the @code{%start} declaration as follows: %start @var{symbol} @end example -@node Pure Decl, Decl Summary, Start Decl, Declarations +@node Pure Decl @subsection A Pure (Reentrant) Parser @cindex reentrant parser @cindex pure parser @@ -3294,7 +3162,7 @@ Whether the parser is pure has nothing to do with the grammar rules. You can generate either a pure parser or a nonreentrant parser from any valid grammar. -@node Decl Summary, , Pure Decl, Declarations +@node Decl Summary @subsection Bison Declaration Summary @cindex Bison declaration summary @cindex declaration summary @@ -3387,6 +3255,21 @@ This output file is essential if you wish to put the definition of be able to refer to token type codes and the variable @code{yylval}. @xref{Token Values, ,Semantic Values of Tokens}.@refill +@c @item %source_extension +@c Specify the extension of the parser output file. +@c +@c For example, a grammar file named @file{foo.yy} and containing a +@c @code{%source_extension .cpp} directive will produce a parser file +@c named @file{foo.tab.cpp} +@c +@c @item %header_extension +@c Specify the extension of the parser header file generated when +@c @code{%define} or @samp{-d} are used. +@c +@c For example, a garmmar file named @file{foo.ypp} and containing a +@c @code{%header_extension .hh} directive will produce a header file +@c named @file{foo.tab.hh} + @item %verbose Write an extra output file containing verbose descriptions of the parser states and what is done for each type of look-ahead token in @@ -3436,7 +3319,7 @@ The number of parser states (@pxref{Parser States}). @end table @end table -@node Multiple Parsers,, Declarations, Grammar File +@node Multiple Parsers @section Multiple Parsers in the Same Program Most programs that use Bison parse only one language and therefore contain @@ -3466,7 +3349,7 @@ of the parser source file, defining @code{yyparse} as @code{@var{prefix}parse}, and so on. This effectively substitutes one name for the other in the entire parser file. -@node Interface, Algorithm, Grammar File, Top +@node Interface @chapter Parser C-Language Interface @cindex C-language interface @cindex interface @@ -3477,8 +3360,8 @@ functions that it needs to use. Keep in mind that the parser uses many C identifiers starting with @samp{yy} and @samp{YY} for internal purposes. If you use such an -identifier (aside from those in this manual) in an action or in additional -C code in the grammar file, you are likely to run into trouble. +identifier (aside from those in this manual) in an action or in epilogue +in the grammar file, you are likely to run into trouble. @menu * Parser Function:: How to call @code{yyparse} and what it returns. @@ -3488,7 +3371,7 @@ C code in the grammar file, you are likely to run into trouble. * Action Features:: Special features for use in actions. @end menu -@node Parser Function, Lexical, , Interface +@node Parser Function @section The Parser Function @code{yyparse} @findex yyparse @@ -3516,7 +3399,7 @@ Return immediately with value 0 (to report success). Return immediately with value 1 (to report failure). @end table -@node Lexical, Error Reporting, Parser Function, Interface +@node Lexical @section The Lexical Analyzer Function @code{yylex} @findex yylex @cindex lexical analyzer @@ -3545,7 +3428,7 @@ that need it. @xref{Invocation, ,Invoking Bison}.@refill in a pure parser (@pxref{Pure Decl, ,A Pure (Reentrant) Parser}). @end menu -@node Calling Convention, Token Values, , Lexical +@node Calling Convention @subsection Calling Convention for @code{yylex} The value that @code{yylex} returns must be the numeric code for the type @@ -3622,7 +3505,7 @@ The @code{yytname} table is generated only if you use the @code{%token_table} declaration. @xref{Decl Summary}. @end itemize -@node Token Values, Token Positions, Calling Convention, Lexical +@node Token Values @subsection Semantic Values of Tokens @vindex yylval @@ -3668,7 +3551,7 @@ then the code in @code{yylex} might look like this: @end group @end example -@node Token Positions, Pure Calling, Token Values, Lexical +@node Token Positions @subsection Textual Positions of Tokens @vindex yylloc @@ -3689,7 +3572,7 @@ feature makes the parser noticeably slower. @tindex YYLTYPE The data type of @code{yylloc} has the name @code{YYLTYPE}. -@node Pure Calling, , Token Positions, Lexical +@node Pure Calling @subsection Calling Conventions for Pure Parsers When you use the Bison declaration @code{%pure_parser} to request a @@ -3796,7 +3679,7 @@ You can use @samp{%pure_parser} to request a reentrant parser without also using @code{YYPARSE_PARAM}. Then you should call @code{yyparse} with no arguments, as usual. -@node Error Reporting, Action Features, Lexical, Interface +@node Error Reporting @section The Error Reporting Function @code{yyerror} @cindex error reporting function @findex yyerror @@ -3856,7 +3739,7 @@ encountered so far. Normally this variable is global; but if you request a pure parser (@pxref{Pure Decl, ,A Pure (Reentrant) Parser}) then it is a local variable which only the actions can access. -@node Action Features, , Error Reporting, Interface +@node Action Features @section Special Features for Use in Actions @cindex summary, action features @cindex action features summary @@ -3970,7 +3853,7 @@ Tracking Locations}. @end table -@node Algorithm, Error Recovery, Interface, Top +@node Algorithm @chapter The Bison Parser Algorithm @cindex Bison parser algorithm @cindex algorithm of parser @@ -4037,7 +3920,7 @@ This kind of parser is known in the literature as a bottom-up parser. * Stack Overflow:: What happens when stack gets full. How to avoid it. @end menu -@node Look-Ahead, Shift/Reduce, , Algorithm +@node Look-Ahead @section Look-Ahead Tokens @cindex look-ahead token @@ -4092,7 +3975,7 @@ doing so would produce on the stack the sequence of symbols @code{expr The current look-ahead token is stored in the variable @code{yychar}. @xref{Action Features, ,Special Features for Use in Actions}. -@node Shift/Reduce, Precedence, Look-Ahead, Algorithm +@node Shift/Reduce @section Shift/Reduce Conflicts @cindex conflicts @cindex shift/reduce conflicts @@ -4188,7 +4071,7 @@ expr: variable ; @end example -@node Precedence, Contextual Precedence, Shift/Reduce, Algorithm +@node Precedence @section Operator Precedence @cindex operator precedence @cindex precedence of operators @@ -4205,7 +4088,7 @@ shift and when to reduce. * How Precedence:: How they work. @end menu -@node Why Precedence, Using Precedence, , Precedence +@node Why Precedence @subsection When Precedence is Needed Consider the following ambiguous grammar fragment (ambiguous because the @@ -4252,7 +4135,7 @@ matter of whether the parser chooses to shift or reduce when the stack contains @w{@samp{1 - 2}} and the look-ahead token is @samp{-}: shifting makes right-associativity. -@node Using Precedence, Precedence Examples, Why Precedence, Precedence +@node Using Precedence @subsection Specifying Operator Precedence @findex %left @findex %right @@ -4273,7 +4156,7 @@ order in which they are declared. The first @code{%left} or precedence is lowest, the next such declaration declares the operators whose precedence is a little higher, and so on. -@node Precedence Examples, How Precedence, Using Precedence, Precedence +@node Precedence Examples @subsection Precedence Examples In our example, we would want the following declarations: @@ -4299,7 +4182,7 @@ declared with @code{'-'}: and so on. We assume that these tokens are more than one character long and therefore are represented by names, not character literals.) -@node How Precedence, , Precedence Examples, Precedence +@node How Precedence @subsection How Precedence Works The first effect of the precedence declarations is to assign precedence @@ -4320,7 +4203,7 @@ how each conflict was resolved. Not all rules and not all tokens have precedence. If either the rule or the look-ahead token has no precedence, then the default is to shift. -@node Contextual Precedence, Parser States, Precedence, Algorithm +@node Contextual Precedence @section Context-Dependent Precedence @cindex context-dependent precedence @cindex unary operator precedence @@ -4378,7 +4261,7 @@ exp: @dots{} @end group @end example -@node Parser States, Reduce/Reduce, Contextual Precedence, Algorithm +@node Parser States @section Parser States @cindex finite-state machine @cindex parser state @@ -4404,7 +4287,7 @@ There is one other alternative: the table can say that the look-ahead token is erroneous in the current state. This causes error processing to begin (@pxref{Error Recovery}). -@node Reduce/Reduce, Mystery Conflicts, Parser States, Algorithm +@node Reduce/Reduce @section Reduce/Reduce Conflicts @cindex reduce/reduce conflict @cindex conflicts, reduce/reduce @@ -4519,7 +4402,7 @@ redirects:redirect ; @end example -@node Mystery Conflicts, Stack Overflow, Reduce/Reduce, Algorithm +@node Mystery Conflicts @section Mysterious Reduce/Reduce Conflicts Sometimes reduce/reduce conflicts can occur that don't look warranted. @@ -4627,7 +4510,7 @@ return_spec: ; @end example -@node Stack Overflow, , Mystery Conflicts, Algorithm +@node Stack Overflow @section Stack Overflow, and How to Avoid It @cindex stack overflow @cindex parser stack overflow @@ -4661,7 +4544,7 @@ You can control how much stack is allocated initially by defining the macro @code{YYINITDEPTH}. This value too must be a compile-time constant integer. The default is 200. -@node Error Recovery, Context Dependency, Algorithm, Top +@node Error Recovery @chapter Error Recovery @cindex error recovery @cindex recovery from errors @@ -4779,7 +4662,7 @@ value 1 when the parser is recovering from a syntax error, and 0 the rest of the time. A value of 1 indicates that error messages are currently suppressed for new syntax errors. -@node Context Dependency, Debugging, Error Recovery, Top +@node Context Dependency @chapter Handling Context Dependencies The Bison paradigm is to parse tokens first, then group them into larger @@ -4798,7 +4681,7 @@ languages. (Actually, ``kludge'' means any technique that gets its job done but is neither clean nor robust.) -@node Semantic Tokens, Lexical Tie-ins, , Context Dependency +@node Semantic Tokens @section Semantic Info in Token Types The C language has a context dependency: the way an identifier is used @@ -4873,7 +4756,7 @@ here the information is global, and is used for other purposes in the program. A true lexical tie-in has a special-purpose flag controlled by the syntactic context. -@node Lexical Tie-ins, Tie-in Recovery, Semantic Tokens, Context Dependency +@node Lexical Tie-ins @section Lexical Tie-ins @cindex lexical tie-in @@ -4922,12 +4805,11 @@ Here we assume that @code{yylex} looks at the value of @code{hexflag}; when it is nonzero, all integers are parsed in hexadecimal, and tokens starting with letters are parsed as integers if possible. -The declaration of @code{hexflag} shown in the C declarations section of -the parser file is needed to make it accessible to the actions -(@pxref{C Declarations, ,The C Declarations Section}). You must also write the code in @code{yylex} -to obey the flag. +The declaration of @code{hexflag} shown in the prologue of the parser file +is needed to make it accessible to the actions (@pxref{Prologue, ,The Prologue}). +You must also write the code in @code{yylex} to obey the flag. -@node Tie-in Recovery, , Lexical Tie-ins, Context Dependency +@node Tie-in Recovery @section Lexical Tie-ins and Error Recovery Lexical tie-ins make strict demands on any error recovery rules you have. @@ -4982,7 +4864,7 @@ make sure your error recovery rules are not of this kind. Each rule must be such that you can be sure that it always will, or always won't, have to clear the flag. -@node Debugging, Invocation, Context Dependency, Top +@node Debugging @chapter Debugging Your Parser @findex YYDEBUG @findex yydebug @@ -4993,15 +4875,14 @@ If a Bison grammar compiles properly but doesn't do what you want when it runs, the @code{yydebug} parser-trace feature can help you figure out why. To enable compilation of trace facilities, you must define the macro -@code{YYDEBUG} when you compile the parser. You could use -@samp{-DYYDEBUG=1} as a compiler option or you could put @samp{#define -YYDEBUG 1} in the C declarations section of the grammar file -(@pxref{C Declarations, ,The C Declarations Section}). Alternatively, use the @samp{-t} option when -you run Bison (@pxref{Invocation, ,Invoking Bison}). We always define @code{YYDEBUG} so that -debugging is always possible. +@code{YYDEBUG} when you compile the parser. You could use @samp{-DYYDEBUG=1} +as a compiler option or you could put @samp{#define YYDEBUG 1} in the prologue +of the grammar file (@pxref{Prologue, , The Prologue}). Alternatively, use the +@samp{-t} option when you run Bison (@pxref{Invocation, ,Invoking Bison}). +We always define @code{YYDEBUG} so that debugging is always possible. -The trace facility uses @code{stderr}, so you must add @w{@code{#include -}} to the C declarations section unless it is already there. +The trace facility uses @code{stderr}, so you must add +@w{@code{#include }} to the prologue unless it is already there. Once you have compiled the program with trace facilities, the way to request a trace is to store a nonzero value in the variable @code{yydebug}. @@ -5064,7 +4945,7 @@ yyprint (FILE *file, int type, YYSTYPE value) @} @end smallexample -@node Invocation, Table of Symbols, Debugging, Top +@node Invocation @chapter Invoking Bison @cindex invoking Bison @cindex Bison invocation @@ -5081,7 +4962,7 @@ Here @var{infile} is the grammar file name, which usually ends in with @samp{.tab.c}. Thus, the @samp{bison foo.y} filename yields @file{foo.tab.c}, and the @samp{bison hack/foo.y} filename yields @file{hack/foo.tab.c}. It's is also possible, in case you are writting -C++ code instead of C in your grammar file, to name it @file{foo.ypp} +C++ code instead of C in your grammar file, to name it @file{foo.ypp} or @file{foo.y++}. Then, the output files will take an extention like the given one as input (repectively @file{foo.tab.cpp} and @file{foo.tab.c++}). This feature takes effect with all options that manipulate filenames like @@ -5110,7 +4991,7 @@ will produce @file{output.c++} and @file{outfile.h++}. * VMS Invocation:: Bison command syntax on VMS. @end menu -@node Bison Options, Environment Variables, , Invocation +@node Bison Options @section Bison Options Bison supports both traditional single-letter options and mnemonic long @@ -5203,12 +5084,16 @@ Adjust the output: @table @option @item -d -@itemx --defines Pretend that @code{%verbose} was specified, i.e., write an extra output file containing macro definitions for the token type names defined in the grammar and the semantic value type @code{YYSTYPE}, as well as a few @code{extern} variable declarations. @xref{Decl Summary}. +@item --defines=@var{defines-file} +The behaviour of @var{--defines} is the same than @samp{-d}. The only +difference is that it has an optionnal argument which is the name of +the output filename. + @item -b @var{file-prefix} @itemx --file-prefix=@var{prefix} Specify a prefix to use for all Bison output file names. The names are @@ -5226,9 +5111,19 @@ Specify the name @var{outfile} for the parser file. The other output files' names are constructed from @var{outfile} as described under the @samp{-v} and @samp{-d} options. + +@item -g +Output a VCG definition of the LALR(1) grammar automaton computed by +Bison. If the grammar file is @file{foo.y}, the VCG output file will +be @file{foo.vcg}. + +@item --graph=@var{graph-file} +The behaviour of @var{--graph} is the same than @samp{-g}. The only +difference is that it has an optionnal argument which is the name of +the output graph filename. @end table -@node Environment Variables, Option Cross Key, Bison Options, Invocation +@node Environment Variables @section Environment Variables @cindex environment variables @cindex BISON_HAIRY @@ -5253,7 +5148,7 @@ also be specified or overridden in a similar fashion, with the @end table -@node Option Cross Key, VMS Invocation, Environment Variables, Invocation +@node Option Cross Key @section Option Cross Key Here is a list of options, alphabetized by long option, to help you find @@ -5267,6 +5162,7 @@ the corresponding short option. \line{ --defines \leaderfill -d} \line{ --file-prefix \leaderfill -b} \line{ --fixed-output-files \leaderfill -y} +\line{ --graph \leaderfill -g} \line{ --help \leaderfill -h} \line{ --name-prefix \leaderfill -p} \line{ --no-lines \leaderfill -l} @@ -5282,9 +5178,10 @@ the corresponding short option. @ifinfo @example --debug -t ---defines -d +--defines=@var{defines-file} -d --file-prefix=@var{prefix} -b @var{file-prefix} --fixed-output-files --yacc -y +--graph=@var{graph-file} -d --help -h --name-prefix=@var{prefix} -p @var{name-prefix} --no-lines -l @@ -5296,7 +5193,7 @@ the corresponding short option. @end example @end ifinfo -@node VMS Invocation, , Option Cross Key, Invocation +@node VMS Invocation @section Invoking Bison under VMS @cindex invoking Bison under VMS @cindex VMS @@ -5324,7 +5221,7 @@ The VMS file system does not permit filenames such as @file{foo.tab.c}. In the above example, the output file would instead be named @file{foo_tab.c}. -@node Table of Symbols, Glossary, Invocation, Top +@node Table of Symbols @appendix Bison Symbols @cindex Bison symbols, table of @cindex symbols in Bison, table of @@ -5394,6 +5291,12 @@ accept. @xref{Pure Calling,, Calling Conventions for Pure Parsers}. Macro whose value indicates whether the parser is recovering from a syntax error. @xref{Action Features, ,Special Features for Use in Actions}. +@item YYSTACK_USE_ALLOCA +Macro used to control the use of @code{alloca}. If defined to @samp{0}, +the parser will not use @code{alloca} but @code{malloc} when trying to +grow its internal stacks. Do @emph{not} define @code{YYSTACK_USE_ALLOCA} +to anything else. + @item YYSTYPE Macro for the data type of semantic values; @code{int} by default. @xref{Value Type, ,Data Types of Semantic Values}. @@ -5457,6 +5360,14 @@ Equip the parser for debugging. @xref{Decl Summary}. Bison declaration to create a header file meant for the scanner. @xref{Decl Summary}. +@c @item %source_extension +@c Bison declaration to specify the generated parser output file extension. +@c @xref{Decl Summary}. +@c +@c @item %header_extension +@c Bison declaration to specify the generated parser header file extension +@c if required. @xref{Decl Summary}. + @item %left Bison declaration to assign left associativity to token(s). @xref{Precedence Decl, ,Operator Precedence}. @@ -5505,13 +5416,13 @@ These are the punctuation and delimiters used in Bison input: @table @samp @item %% Delimiter used to separate the grammar rule section from the -Bison declarations section or the additional C code section. +Bison declarations section or the epilogue. @xref{Grammar Layout, ,The Overall Layout of a Bison Grammar}. @item %@{ %@} All code listed between @samp{%@{} and @samp{%@}} is copied directly to -the output file uninterpreted. Such code forms the ``C declarations'' -section of the input file. @xref{Grammar Outline, ,Outline of a Bison +the output file uninterpreted. Such code forms the prologue of the input +file. @xref{Grammar Outline, ,Outline of a Bison Grammar}. @item /*@dots{}*/ @@ -5529,7 +5440,7 @@ Separates alternate rules for the same result nonterminal. @xref{Rules, ,Syntax of Grammar Rules}. @end table -@node Glossary, Index, Table of Symbols, Top +@node Glossary @appendix Glossary @cindex glossary @@ -5690,7 +5601,16 @@ grammatically indivisible. The piece of text it represents is a token. @xref{Language and Grammar, ,Languages and Context-Free Grammars}. @end table -@node Index, , Glossary, Top +@node Copying This Manual +@appendix Copying This Manual + +@menu +* GNU Free Documentation License:: License for copying this manual. +@end menu + +@include fdl.texi + +@node Index @unnumbered Index @printindex cp