|
@@ -0,0 +1,4501 @@
|
|
|
|
+<HTML>
|
|
|
|
+<HEAD>
|
|
|
|
+<!-- This HTML file has been created by texi2html 1.52
|
|
|
|
+ from bison.texinfo on 2 October 1998 -->
|
|
|
|
+<TITLE>Bison 1.24
|
|
|
|
+</TITLE>
|
|
|
|
+</HEAD>
|
|
|
|
+<BODY>
|
|
|
|
+<H1>Bison
|
|
|
|
+</H1>
|
|
|
|
+<H2>The YACC-compatible Parser Generator
|
|
|
|
+</H2>
|
|
|
|
+<H2>May 1995, Bison Version 1.24
|
|
|
|
+</H2>
|
|
|
|
+<ADDRESS>by Charles Donnelly and Richard Stallman
|
|
|
|
+</ADDRESS>
|
|
|
|
+<P>
|
|
|
|
+<P><HR><P>
|
|
|
|
+<H1>Table of Contents</H1>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC1" HREF="bison.html#SEC1">Introduction</A>
|
|
|
|
+<LI><A NAME="TOC2" HREF="bison.html#SEC2">Conditions for Using Bison</A>
|
|
|
|
+<LI><A NAME="TOC3" HREF="bison.html#SEC3">GNU GENERAL PUBLIC LICENSE</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC4" HREF="bison.html#SEC4">Preamble</A>
|
|
|
|
+<LI><A NAME="TOC5" HREF="bison.html#SEC5">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A>
|
|
|
|
+<LI><A NAME="TOC6" HREF="bison.html#SEC6">How to Apply These Terms to Your New Programs</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC7" HREF="bison.html#SEC7">The Concepts of Bison</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC8" HREF="bison.html#SEC8">Languages and Context-Free Grammars</A>
|
|
|
|
+<LI><A NAME="TOC9" HREF="bison.html#SEC9">From Formal Rules to Bison Input</A>
|
|
|
|
+<LI><A NAME="TOC10" HREF="bison.html#SEC10">Semantic Values</A>
|
|
|
|
+<LI><A NAME="TOC11" HREF="bison.html#SEC11">Semantic Actions</A>
|
|
|
|
+<LI><A NAME="TOC12" HREF="bison.html#SEC12">Bison Output: the Parser File</A>
|
|
|
|
+<LI><A NAME="TOC13" HREF="bison.html#SEC13">Stages in Using Bison</A>
|
|
|
|
+<LI><A NAME="TOC14" HREF="bison.html#SEC14">The Overall Layout of a Bison Grammar</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC15" HREF="bison.html#SEC15">Examples</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC16" HREF="bison.html#SEC16">Reverse Polish Notation Calculator</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC17" HREF="bison.html#SEC17">Declarations for <CODE>rpcalc</CODE></A>
|
|
|
|
+<LI><A NAME="TOC18" HREF="bison.html#SEC18">Grammar Rules for <CODE>rpcalc</CODE></A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC19" HREF="bison.html#SEC19">Explanation of <CODE>input</CODE></A>
|
|
|
|
+<LI><A NAME="TOC20" HREF="bison.html#SEC20">Explanation of <CODE>line</CODE></A>
|
|
|
|
+<LI><A NAME="TOC21" HREF="bison.html#SEC21">Explanation of <CODE>expr</CODE></A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC22" HREF="bison.html#SEC22">The <CODE>rpcalc</CODE> Lexical Analyzer</A>
|
|
|
|
+<LI><A NAME="TOC23" HREF="bison.html#SEC23">The Controlling Function</A>
|
|
|
|
+<LI><A NAME="TOC24" HREF="bison.html#SEC24">The Error Reporting Routine</A>
|
|
|
|
+<LI><A NAME="TOC25" HREF="bison.html#SEC25">Running Bison to Make the Parser</A>
|
|
|
|
+<LI><A NAME="TOC26" HREF="bison.html#SEC26">Compiling the Parser File</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC27" HREF="bison.html#SEC27">Infix Notation Calculator: <CODE>calc</CODE></A>
|
|
|
|
+<LI><A NAME="TOC28" HREF="bison.html#SEC28">Simple Error Recovery</A>
|
|
|
|
+<LI><A NAME="TOC29" HREF="bison.html#SEC29">Multi-Function Calculator: <CODE>mfcalc</CODE></A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC30" HREF="bison.html#SEC30">Declarations for <CODE>mfcalc</CODE></A>
|
|
|
|
+<LI><A NAME="TOC31" HREF="bison.html#SEC31">Grammar Rules for <CODE>mfcalc</CODE></A>
|
|
|
|
+<LI><A NAME="TOC32" HREF="bison.html#SEC32">The <CODE>mfcalc</CODE> Symbol Table</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC33" HREF="bison.html#SEC33">Exercises</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC34" HREF="bison.html#SEC34">Bison Grammar Files</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC35" HREF="bison.html#SEC35">Outline of a Bison Grammar</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC36" HREF="bison.html#SEC36">The C Declarations Section</A>
|
|
|
|
+<LI><A NAME="TOC37" HREF="bison.html#SEC37">The Bison Declarations Section</A>
|
|
|
|
+<LI><A NAME="TOC38" HREF="bison.html#SEC38">The Grammar Rules Section</A>
|
|
|
|
+<LI><A NAME="TOC39" HREF="bison.html#SEC39">The Additional C Code Section</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC40" HREF="bison.html#SEC40">Symbols, Terminal and Nonterminal</A>
|
|
|
|
+<LI><A NAME="TOC41" HREF="bison.html#SEC41">Syntax of Grammar Rules</A>
|
|
|
|
+<LI><A NAME="TOC42" HREF="bison.html#SEC42">Recursive Rules</A>
|
|
|
|
+<LI><A NAME="TOC43" HREF="bison.html#SEC43">Defining Language Semantics</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC44" HREF="bison.html#SEC44">Data Types of Semantic Values</A>
|
|
|
|
+<LI><A NAME="TOC45" HREF="bison.html#SEC45">More Than One Value Type</A>
|
|
|
|
+<LI><A NAME="TOC46" HREF="bison.html#SEC46">Actions</A>
|
|
|
|
+<LI><A NAME="TOC47" HREF="bison.html#SEC47">Data Types of Values in Actions</A>
|
|
|
|
+<LI><A NAME="TOC48" HREF="bison.html#SEC48">Actions in Mid-Rule</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC49" HREF="bison.html#SEC49">Bison Declarations</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC50" HREF="bison.html#SEC50">Token Type Names</A>
|
|
|
|
+<LI><A NAME="TOC51" HREF="bison.html#SEC51">Operator Precedence</A>
|
|
|
|
+<LI><A NAME="TOC52" HREF="bison.html#SEC52">The Collection of Value Types</A>
|
|
|
|
+<LI><A NAME="TOC53" HREF="bison.html#SEC53">Nonterminal Symbols</A>
|
|
|
|
+<LI><A NAME="TOC54" HREF="bison.html#SEC54">Suppressing Conflict Warnings</A>
|
|
|
|
+<LI><A NAME="TOC55" HREF="bison.html#SEC55">The Start-Symbol</A>
|
|
|
|
+<LI><A NAME="TOC56" HREF="bison.html#SEC56">A Pure (Reentrant) Parser</A>
|
|
|
|
+<LI><A NAME="TOC57" HREF="bison.html#SEC57">Bison Declaration Summary</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC58" HREF="bison.html#SEC58">Multiple Parsers in the Same Program</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC59" HREF="bison.html#SEC59">Parser C-Language Interface</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC60" HREF="bison.html#SEC60">The Parser Function <CODE>yyparse</CODE></A>
|
|
|
|
+<LI><A NAME="TOC61" HREF="bison.html#SEC61">The Lexical Analyzer Function <CODE>yylex</CODE></A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC62" HREF="bison.html#SEC62">Calling Convention for <CODE>yylex</CODE></A>
|
|
|
|
+<LI><A NAME="TOC63" HREF="bison.html#SEC63">Semantic Values of Tokens</A>
|
|
|
|
+<LI><A NAME="TOC64" HREF="bison.html#SEC64">Textual Positions of Tokens</A>
|
|
|
|
+<LI><A NAME="TOC65" HREF="bison.html#SEC65">Calling Conventions for Pure Parsers</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC66" HREF="bison.html#SEC66">The Error Reporting Function <CODE>yyerror</CODE></A>
|
|
|
|
+<LI><A NAME="TOC67" HREF="bison.html#SEC67">Special Features for Use in Actions</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC68" HREF="bison.html#SEC68">The Bison Parser Algorithm</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC69" HREF="bison.html#SEC69">Look-Ahead Tokens</A>
|
|
|
|
+<LI><A NAME="TOC70" HREF="bison.html#SEC70">Shift/Reduce Conflicts</A>
|
|
|
|
+<LI><A NAME="TOC71" HREF="bison.html#SEC71">Operator Precedence</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC72" HREF="bison.html#SEC72">When Precedence is Needed</A>
|
|
|
|
+<LI><A NAME="TOC73" HREF="bison.html#SEC73">Specifying Operator Precedence</A>
|
|
|
|
+<LI><A NAME="TOC74" HREF="bison.html#SEC74">Precedence Examples</A>
|
|
|
|
+<LI><A NAME="TOC75" HREF="bison.html#SEC75">How Precedence Works</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC76" HREF="bison.html#SEC76">Context-Dependent Precedence</A>
|
|
|
|
+<LI><A NAME="TOC77" HREF="bison.html#SEC77">Parser States</A>
|
|
|
|
+<LI><A NAME="TOC78" HREF="bison.html#SEC78">Reduce/Reduce Conflicts</A>
|
|
|
|
+<LI><A NAME="TOC79" HREF="bison.html#SEC79">Mysterious Reduce/Reduce Conflicts</A>
|
|
|
|
+<LI><A NAME="TOC80" HREF="bison.html#SEC80">Stack Overflow, and How to Avoid It</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC81" HREF="bison.html#SEC81">Error Recovery</A>
|
|
|
|
+<LI><A NAME="TOC82" HREF="bison.html#SEC82">Handling Context Dependencies</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC83" HREF="bison.html#SEC83">Semantic Info in Token Types</A>
|
|
|
|
+<LI><A NAME="TOC84" HREF="bison.html#SEC84">Lexical Tie-ins</A>
|
|
|
|
+<LI><A NAME="TOC85" HREF="bison.html#SEC85">Lexical Tie-ins and Error Recovery</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC86" HREF="bison.html#SEC86">Debugging Your Parser</A>
|
|
|
|
+<LI><A NAME="TOC87" HREF="bison.html#SEC87">Invoking Bison</A>
|
|
|
|
+<UL>
|
|
|
|
+<LI><A NAME="TOC88" HREF="bison.html#SEC88">Bison Options</A>
|
|
|
|
+<LI><A NAME="TOC89" HREF="bison.html#SEC89">Option Cross Key</A>
|
|
|
|
+<LI><A NAME="TOC90" HREF="bison.html#SEC90">Invoking Bison under VMS</A>
|
|
|
|
+</UL>
|
|
|
|
+<LI><A NAME="TOC91" HREF="bison.html#SEC91">Bison Symbols</A>
|
|
|
|
+<LI><A NAME="TOC92" HREF="bison.html#SEC92">Glossary</A>
|
|
|
|
+<LI><A NAME="TOC93" HREF="bison.html#SEC93">Index</A>
|
|
|
|
+</UL>
|
|
|
|
+<P><HR><P>
|
|
|
|
+<ul>
|
|
|
|
+<H1><A NAME="SEC1" HREF="bison.html#TOC1">Introduction</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX1"></A>
|
|
|
|
+<EM>Bison</EM> is a general-purpose parser generator that converts a
|
|
|
|
+grammar description for an LALR(1) context-free grammar into a C
|
|
|
|
+program to parse that grammar. Once you are proficient with Bison,
|
|
|
|
+you may use it to develop a wide range of language parsers, from those
|
|
|
|
+used in simple desk calculators to complex programming languages.
|
|
|
|
+<p>
|
|
|
|
+Bison is upward compatible with Yacc: all properly-written Yacc grammars
|
|
|
|
+ought to work with Bison with no change. Anyone familiar with Yacc
|
|
|
|
+should be able to use Bison with little trouble. You need to be fluent in
|
|
|
|
+C programming in order to use Bison or to understand this manual.
|
|
|
|
+<p>
|
|
|
|
+We begin with tutorial chapters that explain the basic concepts of using
|
|
|
|
+Bison and show three explained examples, each building on the last. If you
|
|
|
|
+don't know Bison or Yacc, start by reading these chapters. Reference
|
|
|
|
+chapters follow which describe specific aspects of Bison in detail.
|
|
|
|
+<p>
|
|
|
|
+Bison was written primarily by Robert Corbett; Richard Stallman made
|
|
|
|
+it Yacc-compatible. This edition corresponds to version 1.24 of Bison.
|
|
|
|
+<p>
|
|
|
|
+<H1><A NAME="SEC2" HREF="bison.html#TOC2">Conditions for Using Bison</A></H1>
|
|
|
|
+<P>
|
|
|
|
+As of Bison version 1.24, we have changed the distribution terms for
|
|
|
|
+<CODE>yyparse</CODE> to permit using Bison's output in non-free programs.
|
|
|
|
+Formerly, Bison parsers could be used only in programs that were free
|
|
|
|
+software.
|
|
|
|
+<p>
|
|
|
|
+The other GNU programming tools, such as the GNU C compiler, have never
|
|
|
|
+had such a requirement. They could always be used for non-free
|
|
|
|
+software. The reason Bison was different was not due to a special
|
|
|
|
+policy decision; it resulted from applying the usual General Public
|
|
|
|
+License to all of the Bison source code.
|
|
|
|
+<p>
|
|
|
|
+The output of the Bison utility--the Bison parser file--contains a
|
|
|
|
+verbatim copy of a sizable piece of Bison, which is the code for the
|
|
|
|
+<CODE>yyparse</CODE> function. (The actions from your grammar are inserted
|
|
|
|
+into this function at one point, but the rest of the function is not
|
|
|
|
+changed.) When we applied the GPL terms to the code for <CODE>yyparse</CODE>,
|
|
|
|
+the effect was to restrict the use of Bison output to free software.
|
|
|
|
+<p>
|
|
|
|
+We didn't change the terms because of sympathy for people who want to
|
|
|
|
+make software proprietary. <STRONG>Software should be free.</STRONG> But we
|
|
|
|
+concluded that limiting Bison's use to free software was doing little to
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<H1><A NAME="SEC3" HREF="bison.html#TOC3">GNU GENERAL PUBLIC LICENSE</A></H1>
|
|
|
|
+<P>
|
|
|
|
+Version 2, June 1991
|
|
|
|
+<PRE>
|
|
|
|
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
|
|
|
+675 Mass Ave, Cambridge, MA 02139, USA
|
|
|
|
+<p>
|
|
|
|
+Everyone is permitted to copy and distribute verbatim copies
|
|
|
|
+of this license document, but changing it is not allowed.
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC4" HREF="bison.html#TOC4">Preamble</A></H2>
|
|
|
|
+<P>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+ The precise terms and conditions for copying, distribution and
|
|
|
|
+modification follow.
|
|
|
|
+<p>
|
|
|
|
+<H2><A NAME="SEC5" HREF="bison.html#TOC5">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<OL>
|
|
|
|
+<LI>
|
|
|
|
+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".
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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:
|
|
|
|
+<p>
|
|
|
|
+<OL>
|
|
|
|
+<LI>
|
|
|
|
+You must cause the modified files to carry prominent notices
|
|
|
|
+stating that you changed the files and the date of any change.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.)
|
|
|
|
+<p>
|
|
|
|
+</OL>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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:
|
|
|
|
+<p>
|
|
|
|
+<OL>
|
|
|
|
+<LI>
|
|
|
|
+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,
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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,
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.)
|
|
|
|
+<p>
|
|
|
|
+</OL>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+This section is intended to make thoroughly clear what is believed to
|
|
|
|
+be a consequence of the rest of this License.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<P><STRONG>NO WARRANTY</STRONG></P>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<LI>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+</OL>
|
|
|
|
+<P>
|
|
|
|
+<P><STRONG>END OF TERMS AND CONDITIONS</STRONG></P>
|
|
|
|
+<p>
|
|
|
|
+<H2><A NAME="SEC6" HREF="bison.html#TOC6">How to Apply These Terms to Your New Programs</A></H2>
|
|
|
|
+<P>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+ 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.
|
|
|
|
+<p>
|
|
|
|
+<ul><pre>
|
|
|
|
+<VAR>one line to give the program's name and a brief idea of what it does.</VAR>
|
|
|
|
+Copyright (C) 19<VAR>yy</VAR> <VAR>name of author</VAR>
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+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., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
|
+</PRE>
|
|
|
|
+</ul>
|
|
|
|
+<P>
|
|
|
|
+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:
|
|
|
|
+<ul>
|
|
|
|
+<PRE>
|
|
|
|
+Gnomovision version 69, Copyright (C) 19<VAR>yy</VAR> <VAR>name of author</VAR>
|
|
|
|
+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.
|
|
|
|
+</PRE>
|
|
|
|
+</ul>
|
|
|
|
+<P>
|
|
|
|
+The hypothetical commands <SAMP>`show w'</SAMP> and <SAMP>`show c'</SAMP> 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'</SAMP> and
|
|
|
|
+<SAMP>`show c'</SAMP>; they could even be mouse-clicks or menu items--whatever
|
|
|
|
+suits your program.
|
|
|
|
+<p>
|
|
|
|
+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:
|
|
|
|
+<p>
|
|
|
|
+<ul>
|
|
|
|
+<PRE>
|
|
|
|
+Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
|
|
|
+`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
|
|
|
+<p>
|
|
|
|
+<VAR>signature of Ty Coon</VAR>, 1 April 1989
|
|
|
|
+Ty Coon, President of Vice
|
|
|
|
+</PRE>
|
|
|
|
+</ul>
|
|
|
|
+<P>
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<H1><A NAME="SEC7" HREF="bison.html#TOC7">The Concepts of Bison</A></H1>
|
|
|
|
+<P>
|
|
|
|
+This chapter introduces many of the basic concepts without which the
|
|
|
|
+details of Bison will not make sense. If you do not already know how to
|
|
|
|
+use Bison or Yacc, we suggest you start by reading this chapter carefully.
|
|
|
|
+<H2><A NAME="SEC8" HREF="bison.html#TOC8">Languages and Context-Free Grammars</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX2"></A>
|
|
|
|
+<A NAME="IDX3"></A>
|
|
|
|
+<BOL>In order for Bison to parse a language, it must be described by a
|
|
|
|
+<EM>context-free grammar</EM>. This means that you specify one or more
|
|
|
|
+<EM>syntactic groupings</EM> and give rules for constructing them from their
|
|
|
|
+parts. For example, in the C language, one kind of grouping is called an
|
|
|
|
+`expression'. One rule for making an expression might be, "An expression
|
|
|
|
+can be made of a minus sign and another expression". Another would be,
|
|
|
|
+"An expression can be an integer". As you can see, rules are often
|
|
|
|
+recursive, but there must be at least one rule which leads out of the
|
|
|
|
+recursion.
|
|
|
|
+<p>
|
|
|
|
+<A NAME="IDX4"></A>
|
|
|
|
+<A NAME="IDX5"></A>
|
|
|
|
+The most common formal system for presenting such rules for humans to read
|
|
|
|
+is <EM>Backus-Naur Form</EM> or "BNF", which was developed in order to
|
|
|
|
+specify the language Algol 60. Any grammar expressed in BNF is a
|
|
|
|
+context-free grammar. The input to Bison is essentially machine-readable
|
|
|
|
+BNF.
|
|
|
|
+<p>
|
|
|
|
+Not all context-free languages can be handled by Bison, only those
|
|
|
|
+that are LALR(1). In brief, this means that it must be possible to
|
|
|
|
+tell how to parse any portion of an input string with just a single
|
|
|
|
+token of look-ahead. Strictly speaking, that is a description of an
|
|
|
|
+LR(1) grammar, and LALR(1) involves additional restrictions that are
|
|
|
|
+hard to explain simply; but it is rare in actual practice to find an
|
|
|
|
+LR(1) grammar that fails to be LALR(1). See section <A HREF="bison.html#SEC79">Mysterious Reduce/Reduce Conflicts</A>, for more information on this.
|
|
|
|
+<p>
|
|
|
|
+<A NAME="IDX6"></A>
|
|
|
|
+<A NAME="IDX7"></A>
|
|
|
|
+<A NAME="IDX8"></A>
|
|
|
|
+<A NAME="IDX9"></A>
|
|
|
|
+In the formal grammatical rules for a language, each kind of syntactic unit
|
|
|
|
+or grouping is named by a <EM>symbol</EM>. Those which are built by grouping
|
|
|
|
+smaller constructs according to grammatical rules are called
|
|
|
|
+<EM>nonterminal symbols</EM>; those which can't be subdivided are called
|
|
|
|
+<EM>terminal symbols</EM> or <EM>token types</EM>. We call a piece of input
|
|
|
|
+corresponding to a single terminal symbol a <EM>token</EM>, and a piece
|
|
|
|
+corresponding to a single nonterminal symbol a <EM>grouping</EM>.
|
|
|
|
+We can use the C language as an example of what symbols, terminal and
|
|
|
|
+nonterminal, mean. The tokens of C are identifiers, constants (numeric and
|
|
|
|
+string), and the various keywords, arithmetic operators and punctuation
|
|
|
|
+marks. So the terminal symbols of a grammar for C include `identifier',
|
|
|
|
+`number', `string', plus one symbol for each keyword, operator or
|
|
|
|
+punctuation mark: `if', `return', `const', `static', `int', `char',
|
|
|
|
+`plus-sign', `open-brace', `close-brace', `comma' and many more. (These
|
|
|
|
+tokens can be subdivided into characters, but that is a matter of
|
|
|
|
+lexicography, not grammar.)
|
|
|
|
+<p>
|
|
|
|
+Here is a simple C function subdivided into tokens:
|
|
|
|
+<p>
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+<PRE>
|
|
|
|
+int /* keyword `int' */
|
|
|
|
+square (x) /* identifier, open-paren, */
|
|
|
|
+ /* identifier, close-paren */
|
|
|
|
+ int x; /* keyword `int', identifier, semicolon */
|
|
|
|
+{ /* open-brace */
|
|
|
|
+ return x * x; /* keyword `return', identifier, */
|
|
|
|
+ /* asterisk, identifier, semicolon */
|
|
|
|
+} /* close-brace */
|
|
|
|
+</PRE>
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+The syntactic groupings of C include the expression, the statement, the
|
|
|
|
+declaration, and the function definition. These are represented in the
|
|
|
|
+grammar of C by nonterminal symbols `expression', `statement',
|
|
|
|
+`declaration' and `function definition'. The full grammar uses dozens of
|
|
|
|
+additional language constructs, each with its own nonterminal symbol, in
|
|
|
|
+order to express the meanings of these four. The example above is a
|
|
|
|
+function definition; it contains one declaration, and one statement. In
|
|
|
|
+the statement, each <SAMP>`x'</SAMP> is an expression and so is <SAMP>`x * x'</SAMP>.
|
|
|
|
+Each nonterminal symbol must have grammatical rules showing how it is made
|
|
|
|
+out of simpler constructs. For example, one kind of C statement is the
|
|
|
|
+<CODE>return</CODE> statement; this would be described with a grammar rule which
|
|
|
|
+reads informally as follows:
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+A `statement' can be made of a `return' keyword, an `expression' and a
|
|
|
|
+`semicolon'.
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+There would be many other rules for `statement', one for each kind of
|
|
|
|
+statement in C.
|
|
|
|
+<p>
|
|
|
|
+<A NAME="IDX10"></A>
|
|
|
|
+One nonterminal symbol must be distinguished as the special one which
|
|
|
|
+defines a complete utterance in the language. It is called the <EM>start
|
|
|
|
+symbol</EM>. In a compiler, this means a complete input program. In the C
|
|
|
|
+language, the nonterminal symbol `sequence of definitions and declarations'
|
|
|
|
+plays this role.
|
|
|
|
+<p>
|
|
|
|
+For example, <SAMP>`1 + 2'</SAMP> is a valid C expression--a valid part of a C
|
|
|
|
+program--but it is not valid as an <EM>entire</EM> C program. In the
|
|
|
|
+context-free grammar of C, this follows from the fact that `expression' is
|
|
|
|
+not the start symbol.
|
|
|
|
+<p>
|
|
|
|
+The Bison parser reads a sequence of tokens as its input, and groups the
|
|
|
|
+tokens using the grammar rules. If the input is valid, the end result is
|
|
|
|
+that the entire token sequence reduces to a single grouping whose symbol is
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<H2><A NAME="SEC9" HREF="bison.html#TOC9">From Formal Rules to Bison Input</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX11"></A>
|
|
|
|
+<A NAME="IDX12"></A>
|
|
|
|
+<A NAME="IDX13"></A>
|
|
|
|
+A formal grammar is a mathematical construct. To define the language
|
|
|
|
+for Bison, you must write a file expressing the grammar in Bison syntax:
|
|
|
|
+a <EM>Bison grammar</EM> file. See section <A HREF="bison.html#SEC34">Bison Grammar Files</A>.
|
|
|
|
+A nonterminal symbol in the formal grammar is represented in Bison input
|
|
|
|
+as an identifier, like an identifier in C. By convention, it should be
|
|
|
|
+in lower case, such as <CODE>expr</CODE>, <CODE>stmt</CODE> or <CODE>declaration</CODE>.
|
|
|
|
+The Bison representation for a terminal symbol is also called a <EM>token
|
|
|
|
+type</EM>. Token types as well can be represented as C-like identifiers. By
|
|
|
|
+convention, these identifiers should be upper case to distinguish them from
|
|
|
|
+nonterminals: for example, <CODE>INTEGER</CODE>, <CODE>IDENTIFIER</CODE>, <CODE>IF</CODE> or
|
|
|
|
+<CODE>RETURN</CODE>. A terminal symbol that stands for a particular keyword in
|
|
|
|
+the language should be named after that keyword converted to upper case.
|
|
|
|
+The terminal symbol <CODE>error</CODE> is reserved for error recovery.
|
|
|
|
+<p>
|
|
|
|
+See section <A HREF="bison.html#SEC40">Symbols, Terminal and Nonterminal</A>.
|
|
|
|
+A terminal symbol can also be represented as a character literal, just like
|
|
|
|
+a C character constant. You should do this whenever a token is just a
|
|
|
|
+single character (parenthesis, plus-sign, etc.): use that same character in
|
|
|
|
+a literal as the terminal symbol for that token.
|
|
|
|
+<p>
|
|
|
|
+The grammar rules also have an expression in Bison syntax. For example,
|
|
|
|
+here is the Bison rule for a C <CODE>return</CODE> statement. The semicolon in
|
|
|
|
+quotes is a literal character token, representing part of the C syntax for
|
|
|
|
+the statement; the naked semicolon, and the colon, are Bison punctuation
|
|
|
|
+used in every rule.
|
|
|
|
+<p>
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+<PRE>
|
|
|
|
+stmt: RETURN expr ';'
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+See section <A HREF="bison.html#SEC41">Syntax of Grammar Rules</A>.
|
|
|
|
+<p>
|
|
|
|
+<H2><A NAME="SEC10" HREF="bison.html#TOC10">Semantic Values</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX14"></A>
|
|
|
|
+<A NAME="IDX15"></A>
|
|
|
|
+A formal grammar selects tokens only by their classifications: for example,
|
|
|
|
+if a rule mentions the terminal symbol `integer constant', it means that
|
|
|
|
+<EM>any</EM> integer constant is grammatically valid in that position. The
|
|
|
|
+precise value of the constant is irrelevant to how to parse the input: if
|
|
|
|
+<SAMP>`x+4'</SAMP> is grammatical then <SAMP>`x+1'</SAMP> or <SAMP>`x+3989'</SAMP> is equally
|
|
|
|
+grammatical.
|
|
|
|
+<p>
|
|
|
|
+But the precise value is very important for what the input means once it is
|
|
|
|
+parsed. A compiler is useless if it fails to distinguish between 4, 1 and
|
|
|
|
+3989 as constants in the program! Therefore, each token in a Bison grammar
|
|
|
|
+has both a token type and a <EM>semantic value</EM>. See section <A HREF="bison.html#SEC43">Defining Language Semantics</A>,
|
|
|
|
+for details.
|
|
|
|
+<p>
|
|
|
|
+The token type is a terminal symbol defined in the grammar, such as
|
|
|
|
+<CODE>INTEGER</CODE>, <CODE>IDENTIFIER</CODE> or <CODE>','</CODE>. It tells everything
|
|
|
|
+you need to know to decide where the token may validly appear and how to
|
|
|
|
+group it with other tokens. The grammar rules know nothing about tokens
|
|
|
|
+except their types.
|
|
|
|
+<p>
|
|
|
|
+The semantic value has all the rest of the information about the
|
|
|
|
+meaning of the token, such as the value of an integer, or the name of an
|
|
|
|
+identifier. (A token such as <CODE>','</CODE> which is just punctuation doesn't
|
|
|
|
+need to have any semantic value.)
|
|
|
|
+<p>
|
|
|
|
+For example, an input token might be classified as token type
|
|
|
|
+<CODE>INTEGER</CODE> and have the semantic value 4. Another input token might
|
|
|
|
+have the same token type <CODE>INTEGER</CODE> but value 3989. When a grammar
|
|
|
|
+rule says that <CODE>INTEGER</CODE> is allowed, either of these tokens is
|
|
|
|
+acceptable because each is an <CODE>INTEGER</CODE>. When the parser accepts the
|
|
|
|
+token, it keeps track of the token's semantic value.
|
|
|
|
+<p>
|
|
|
|
+Each grouping can also have a semantic value as well as its nonterminal
|
|
|
|
+symbol. For example, in a calculator, an expression typically has a
|
|
|
|
+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.
|
|
|
|
+<p>
|
|
|
|
+<H2><A NAME="SEC11" HREF="bison.html#TOC11">Semantic Actions</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX16"></A>
|
|
|
|
+<A NAME="IDX17"></A>
|
|
|
|
+In order to be useful, a program must do more than parse input; it must
|
|
|
|
+also produce some output based on the input. In a Bison grammar, a grammar
|
|
|
|
+rule can have an <EM>action</EM> made up of C statements. Each time the
|
|
|
|
+parser recognizes a match for that rule, the action is executed.
|
|
|
|
+See section <A HREF="bison.html#SEC46">Actions</A>.
|
|
|
|
+<p>
|
|
|
|
+Most of the time, the purpose of an action is to compute the semantic value
|
|
|
|
+of the whole construct from the semantic values of its parts. For example,
|
|
|
|
+suppose we have a rule which says an expression can be the sum of two
|
|
|
|
+expressions. When the parser recognizes such a sum, each of the
|
|
|
|
+subexpressions has a semantic value which describes how it was built up.
|
|
|
|
+The action for this rule should create a similar sort of value for the
|
|
|
|
+newly recognized larger expression.
|
|
|
|
+For example, here is a rule that says an expression can be the sum of
|
|
|
|
+two subexpressions:
|
|
|
|
+<p>
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+<PRE>
|
|
|
|
+expr: expr '+' expr { $$ = $1 + $3; }
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+The action says how to produce the semantic value of the sum expression
|
|
|
|
+from the values of the two subexpressions.
|
|
|
|
+<H2><A NAME="SEC12" HREF="bison.html#TOC12">Bison Output: the Parser File</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX18"></A>
|
|
|
|
+<A NAME="IDX19"></A>
|
|
|
|
+<A NAME="IDX20"></A>
|
|
|
|
+<A NAME="IDX21"></A>
|
|
|
|
+When you run Bison, you give it a Bison grammar file as input. The output
|
|
|
|
+is a C source file that parses the language described by the grammar.
|
|
|
|
+This file is called a <EM>Bison parser</EM>. Keep in mind that the Bison
|
|
|
|
+utility and the Bison parser are two distinct programs: the Bison utility
|
|
|
|
+is a program whose output is the Bison parser that becomes part of your
|
|
|
|
+program.
|
|
|
|
+<p>
|
|
|
|
+The job of the Bison parser is to group tokens into groupings according to
|
|
|
|
+the grammar rules--for example, to build identifiers and operators into
|
|
|
|
+expressions. As it does this, it runs the actions for the grammar rules it
|
|
|
|
+uses.
|
|
|
|
+<p>
|
|
|
|
+The tokens come from a function called the <EM>lexical analyzer</EM> that you
|
|
|
|
+must supply in some fashion (such as by writing it in C). The Bison parser
|
|
|
|
+calls the lexical analyzer each time it wants a new token. It doesn't know
|
|
|
|
+what is "inside" the tokens (though their semantic values may reflect
|
|
|
|
+this). Typically the lexical analyzer makes the tokens by parsing
|
|
|
|
+characters of text, but Bison does not depend on this. See section <A HREF="bison.html#SEC61">The Lexical Analyzer Function <CODE>yylex</CODE></A>.
|
|
|
|
+The Bison parser file is C code which defines a function named
|
|
|
|
+<CODE>yyparse</CODE> which implements that grammar. This function does not make
|
|
|
|
+a complete C program: you must supply some additional functions. One is
|
|
|
|
+the lexical analyzer. Another is an error-reporting function which the
|
|
|
|
+parser calls to report an error. In addition, a complete C program must
|
|
|
|
+start with a function called <CODE>main</CODE>; you have to provide this, and
|
|
|
|
+arrange for it to call <CODE>yyparse</CODE> or the parser will never run.
|
|
|
|
+See section <A HREF="bison.html#SEC59">Parser C-Language Interface</A>.
|
|
|
|
+Aside from the token type names and the symbols in the actions you
|
|
|
|
+write, all variable and function names used in the Bison parser file
|
|
|
|
+begin with <SAMP>`yy'</SAMP> or <SAMP>`YY'</SAMP>. This includes interface functions
|
|
|
|
+such as the lexical analyzer function <CODE>yylex</CODE>, the error reporting
|
|
|
|
+function <CODE>yyerror</CODE> and the parser function <CODE>yyparse</CODE> itself.
|
|
|
|
+This also includes numerous identifiers used for internal purposes.
|
|
|
|
+Therefore, you should avoid using C identifiers starting with <SAMP>`yy'</SAMP>
|
|
|
|
+or <SAMP>`YY'</SAMP> in the Bison grammar file except for the ones defined in
|
|
|
|
+this manual.
|
|
|
|
+<H2><A NAME="SEC13" HREF="bison.html#TOC13">Stages in Using Bison</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX22"></A>
|
|
|
|
+<A NAME="IDX23"></A>
|
|
|
|
+The actual language-design process using Bison, from grammar specification
|
|
|
|
+to a working compiler or interpreter, has these parts:
|
|
|
|
+<OL>
|
|
|
|
+<LI>
|
|
|
|
+Formally specify the grammar in a form recognized by Bison
|
|
|
|
+(see section <A HREF="bison.html#SEC34">Bison Grammar Files</A>). For each grammatical rule in the language,
|
|
|
|
+describe the action that is to be taken when an instance of that rule
|
|
|
|
+is recognized. The action is described by a sequence of C statements.
|
|
|
|
+<LI>
|
|
|
|
+Write a lexical analyzer to process input and pass tokens to the
|
|
|
|
+parser. The lexical analyzer may be written by hand in C
|
|
|
|
+(see section <A HREF="bison.html#SEC61">The Lexical Analyzer Function <CODE>yylex</CODE></A>). It could also be produced using Lex, but the use
|
|
|
|
+of Lex is not discussed in this manual.
|
|
|
|
+<LI>
|
|
|
|
+Write a controlling function that calls the Bison-produced parser.
|
|
|
|
+<LI>
|
|
|
|
+Write error-reporting routines.
|
|
|
|
+</OL>
|
|
|
|
+<P>
|
|
|
|
+To turn this source code as written into a runnable program, you
|
|
|
|
+must follow these steps:
|
|
|
|
+<OL>
|
|
|
|
+<LI>
|
|
|
|
+Run Bison on the grammar to produce the parser.
|
|
|
|
+<LI>
|
|
|
|
+Compile the code output by Bison, as well as any other source files.
|
|
|
|
+<LI>
|
|
|
|
+Link the object files to produce the finished product.
|
|
|
|
+</OL>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC14" HREF="bison.html#TOC14">The Overall Layout of a Bison Grammar</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX24"></A>
|
|
|
|
+<A NAME="IDX25"></A>
|
|
|
|
+<A NAME="IDX26"></A>
|
|
|
|
+<A NAME="IDX27"></A>
|
|
|
|
+The input file for the Bison utility is a <EM>Bison grammar file</EM>. The
|
|
|
|
+general form of a Bison grammar file is as follows:
|
|
|
|
+<PRE>
|
|
|
|
+%{
|
|
|
|
+<VAR>C declarations</VAR>
|
|
|
|
+%}
|
|
|
|
+<VAR>Bison declarations</VAR>
|
|
|
|
+%%
|
|
|
|
+<VAR>Grammar rules</VAR>
|
|
|
|
+%%
|
|
|
|
+<VAR>Additional C code</VAR>
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The <SAMP>`%%'</SAMP>, <SAMP>`%{'</SAMP> and <SAMP>`%}'</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
|
|
|
|
+<CODE>#include</CODE> to include header files that do any of these things.
|
|
|
|
+The Bison declarations declare the names of the terminal and nonterminal
|
|
|
|
+symbols, and may also describe operator precedence and the data types of
|
|
|
|
+semantic values of various symbols.
|
|
|
|
+<P>
|
|
|
|
+The grammar rules define how to construct each nonterminal symbol from its
|
|
|
|
+parts.
|
|
|
|
+<P>
|
|
|
|
+The additional C code can contain any C code you want to use. Often the
|
|
|
|
+definition of the lexical analyzer <CODE>yylex</CODE> 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.
|
|
|
|
+<P>
|
|
|
|
+<H1><A NAME="SEC15" HREF="bison.html#TOC15">Examples</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX28"></A>
|
|
|
|
+<A NAME="IDX29"></A>
|
|
|
|
+Now we show and explain three sample programs written using Bison: a
|
|
|
|
+reverse polish notation calculator, an algebraic (infix) notation
|
|
|
|
+calculator, and a multi-function calculator. All three have been tested
|
|
|
|
+under BSD Unix 4.3; each produces a usable, though limited, interactive
|
|
|
|
+desk-top calculator.
|
|
|
|
+<P>
|
|
|
|
+These examples are simple, but Bison grammars for real programming
|
|
|
|
+languages are written the same way.
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC16" HREF="bison.html#TOC16">Reverse Polish Notation Calculator</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX30"></A>
|
|
|
|
+<A NAME="IDX31"></A>
|
|
|
|
+<A NAME="IDX32"></A>
|
|
|
|
+<A NAME="IDX33"></A>
|
|
|
|
+The first example is that of a simple double-precision <EM>reverse polish
|
|
|
|
+notation</EM> calculator (a calculator using postfix operators). This example
|
|
|
|
+provides a good starting point, since operator precedence is not an issue.
|
|
|
|
+<P>
|
|
|
|
+The second example will illustrate how operator precedence is handled.
|
|
|
|
+The source code for this calculator is named <TT>`rpcalc.y'</TT>. The
|
|
|
|
+<SAMP>`.y'</SAMP> extension is a convention used for Bison input files.
|
|
|
|
+<H3><A NAME="SEC17" HREF="bison.html#TOC17">Declarations for <CODE>rpcalc</CODE></A></H3>
|
|
|
|
+<P>
|
|
|
|
+Here are the C and Bison declarations for the reverse polish notation
|
|
|
|
+calculator. As in C, comments are placed between <SAMP>`/*...*/'</SAMP>.
|
|
|
|
+<P>
|
|
|
|
+<PRE>
|
|
|
|
+/* Reverse polish notation calculator. */
|
|
|
|
+%{
|
|
|
|
+#define YYSTYPE double
|
|
|
|
+#include <math.h>
|
|
|
|
+%}
|
|
|
|
+%token NUM
|
|
|
|
+%% /* Grammar rules and actions follow */
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The C declarations section (see section <A HREF="bison.html#SEC36">The C Declarations Section</A>) contains two
|
|
|
|
+preprocessor directives.
|
|
|
|
+<P>
|
|
|
|
+The <CODE>#define</CODE> directive defines the macro <CODE>YYSTYPE</CODE>, thus
|
|
|
|
+specifying the C data type for semantic values of both tokens and groupings
|
|
|
|
+(see section <A HREF="bison.html#SEC44">Data Types of Semantic Values</A>). The Bison parser will use whatever type
|
|
|
|
+<CODE>YYSTYPE</CODE> is defined as; if you don't define it, <CODE>int</CODE> is the
|
|
|
|
+default. Because we specify <CODE>double</CODE>, each token and each expression
|
|
|
|
+has an associated value, which is a floating point number.
|
|
|
|
+<P>
|
|
|
|
+The <CODE>#include</CODE> directive is used to declare the exponentiation
|
|
|
|
+function <CODE>pow</CODE>.
|
|
|
|
+<P>
|
|
|
|
+The second section, Bison declarations, provides information to Bison about
|
|
|
|
+the token types (see section <A HREF="bison.html#SEC37">The Bison Declarations Section</A>). Each terminal symbol that is
|
|
|
|
+not a single-character literal must be declared here. (Single-character
|
|
|
|
+literals normally don't need to be declared.) In this example, all the
|
|
|
|
+arithmetic operators are designated by single-character literals, so the
|
|
|
|
+only terminal symbol that needs to be declared is <CODE>NUM</CODE>, the token
|
|
|
|
+type for numeric constants.
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC18" HREF="bison.html#TOC18">Grammar Rules for <CODE>rpcalc</CODE></A></H3>
|
|
|
|
+<P>
|
|
|
|
+Here are the grammar rules for the reverse polish notation calculator.
|
|
|
|
+<P>
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+<PRE>
|
|
|
|
+input: /* empty */
|
|
|
|
+ | input line
|
|
|
|
+;
|
|
|
|
+line: '\n'
|
|
|
|
+ | exp '\n' { printf ("\t%.10g\n", $1); }
|
|
|
|
+;
|
|
|
|
+exp: NUM { $$ = $1; }
|
|
|
|
+ | exp exp '+' { $$ = $1 + $2; }
|
|
|
|
+ | exp exp '-' { $$ = $1 - $2; }
|
|
|
|
+ | exp exp '*' { $$ = $1 * $2; }
|
|
|
|
+ | exp exp '/' { $$ = $1 / $2; }
|
|
|
|
+ /* Exponentiation */
|
|
|
|
+ | exp exp '^' { $$ = pow ($1, $2); }
|
|
|
|
+ /* Unary minus */
|
|
|
|
+ | exp 'n' { $$ = -$1; }
|
|
|
|
+;
|
|
|
|
+%%
|
|
|
|
+</PRE>
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+The groupings of the rpcalc "language" defined here are the expression
|
|
|
|
+(given the name <CODE>exp</CODE>), the line of input (<CODE>line</CODE>), and the
|
|
|
|
+complete input transcript (<CODE>input</CODE>). Each of these nonterminal
|
|
|
|
+symbols has several alternate rules, joined by the <SAMP>`|'</SAMP> punctuator
|
|
|
|
+which is read as "or". The following sections explain what these rules
|
|
|
|
+mean.
|
|
|
|
+<P>
|
|
|
|
+The semantics of the language is determined by the actions taken when a
|
|
|
|
+grouping is recognized. The actions are the C code that appears inside
|
|
|
|
+braces. See section <A HREF="bison.html#SEC46">Actions</A>.
|
|
|
|
+<P>
|
|
|
|
+You must specify these actions in C, but Bison provides the means for
|
|
|
|
+passing semantic values between the rules. In each action, the
|
|
|
|
+pseudo-variable <CODE>$$</CODE> stands for the semantic value for the grouping
|
|
|
|
+that the rule is going to construct. Assigning a value to <CODE>$$</CODE> is the
|
|
|
|
+main job of most actions. The semantic values of the components of the
|
|
|
|
+rule are referred to as <CODE>$1</CODE>, <CODE>$2</CODE>, and so on.
|
|
|
|
+<P>
|
|
|
|
+<H4><A NAME="SEC19" HREF="bison.html#TOC19">Explanation of <CODE>input</CODE></A></H4>
|
|
|
|
+<P>
|
|
|
|
+Consider the definition of <CODE>input</CODE>:
|
|
|
|
+<P>
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+<PRE>
|
|
|
|
+input: /* empty */
|
|
|
|
+ | input line
|
|
|
|
+;
|
|
|
|
+</PRE>
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+This definition reads as follows: "A complete input is either an empty
|
|
|
|
+string, or a complete input followed by an input line". Notice that
|
|
|
|
+"complete input" is defined in terms of itself. This definition is said
|
|
|
|
+to be <EM>left recursive</EM> since <CODE>input</CODE> appears always as the
|
|
|
|
+leftmost symbol in the sequence. See section <A HREF="bison.html#SEC42">Recursive Rules</A>.
|
|
|
|
+<P>
|
|
|
|
+The first alternative is empty because there are no symbols between the
|
|
|
|
+colon and the first <SAMP>`|'</SAMP>; this means that <CODE>input</CODE> can match an
|
|
|
|
+empty string of input (no tokens). We write the rules this way because it
|
|
|
|
+is legitimate to type <KBD>Ctrl-d</KBD> right after you start the calculator.
|
|
|
|
+<P>
|
|
|
|
+It's conventional to put an empty alternative first and write the comment
|
|
|
|
+<SAMP>`/* empty */'</SAMP> in it.
|
|
|
|
+<P>
|
|
|
|
+The second alternate rule (<CODE>input line</CODE>) handles all nontrivial input.
|
|
|
|
+It means, "After reading any number of lines, read one more line if
|
|
|
|
+possible." The left recursion makes this rule into a loop. Since the
|
|
|
|
+first alternative matches empty input, the loop can be executed zero or
|
|
|
|
+more times.
|
|
|
|
+<P>
|
|
|
|
+The parser function <CODE>yyparse</CODE> 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.
|
|
|
|
+<H4><A NAME="SEC20" HREF="bison.html#TOC20">Explanation of <CODE>line</CODE></A></H4>
|
|
|
|
+<P>
|
|
|
|
+Now consider the definition of <CODE>line</CODE>:
|
|
|
|
+<PRE>
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+line: '\n'
|
|
|
|
+ | exp '\n' { printf ("\t%.10g\n", $1); }
|
|
|
|
+;
|
|
|
|
+</PRE>
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+The first alternative is a token which is a newline character; this means
|
|
|
|
+that rpcalc accepts a blank line (and ignores it, since there is no
|
|
|
|
+action). The second alternative is an expression followed by a newline.
|
|
|
|
+This is the alternative that makes rpcalc useful. The semantic value of
|
|
|
|
+the <CODE>exp</CODE> grouping is the value of <CODE>$1</CODE> because the <CODE>exp</CODE> in
|
|
|
|
+question is the first symbol in the alternative. The action prints this
|
|
|
|
+value, which is the result of the computation the user asked for.
|
|
|
|
+This action is unusual because it does not assign a value to <CODE>$$</CODE>. As
|
|
|
|
+a consequence, the semantic value associated with the <CODE>line</CODE> is
|
|
|
|
+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.
|
|
|
|
+<H4><A NAME="SEC21" HREF="bison.html#TOC21">Explanation of <CODE>expr</CODE></A></H4>
|
|
|
|
+<P>
|
|
|
|
+The <CODE>exp</CODE> grouping has several rules, one for each kind of expression.
|
|
|
|
+The first rule handles the simplest expressions: those that are just numbers.
|
|
|
|
+The second handles an addition-expression, which looks like two expressions
|
|
|
|
+followed by a plus-sign. The third handles subtraction, and so on.
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+<PRE>
|
|
|
|
+exp: NUM
|
|
|
|
+ | exp exp '+' { $$ = $1 + $2; }
|
|
|
|
+ | exp exp '-' { $$ = $1 - $2; }
|
|
|
|
+ ...
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+We have used <SAMP>`|'</SAMP> to join all the rules for <CODE>exp</CODE>, but we could
|
|
|
|
+equally well have written them separately:
|
|
|
|
+<BLOCKQUOTE>
|
|
|
|
+<PRE>
|
|
|
|
+exp: NUM ;
|
|
|
|
+exp: exp exp '+' { $$ = $1 + $2; } ;
|
|
|
|
+exp: exp exp '-' { $$ = $1 - $2; } ;
|
|
|
|
+ ...
|
|
|
|
+</PRE>
|
|
|
|
+</BLOCKQUOTE>
|
|
|
|
+<P>
|
|
|
|
+Most of the rules have actions that compute the value of the expression in
|
|
|
|
+terms of the value of its parts. For example, in the rule for addition,
|
|
|
|
+<CODE>$1</CODE> refers to the first component <CODE>exp</CODE> and <CODE>$2</CODE> refers to
|
|
|
|
+the second one. The third component, <CODE>'+'</CODE>, has no meaningful
|
|
|
|
+associated semantic value, but if it had one you could refer to it as
|
|
|
|
+<CODE>$3</CODE>. When <CODE>yyparse</CODE> recognizes a sum expression using this
|
|
|
|
+rule, the sum of the two subexpressions' values is produced as the value of
|
|
|
|
+the entire expression. See section <A HREF="bison.html#SEC46">Actions</A>.
|
|
|
|
+You don't have to give an action for every rule. When a rule has no
|
|
|
|
+action, Bison by default copies the value of <CODE>$1</CODE> into <CODE>$$</CODE>.
|
|
|
|
+This is what happens in the first rule (the one that uses <CODE>NUM</CODE>).
|
|
|
|
+The formatting shown here is the recommended convention, but Bison does
|
|
|
|
+not require it. You can add or change whitespace as much as you wish.
|
|
|
|
+For example, this:
|
|
|
|
+<PRE>
|
|
|
|
+exp : NUM | exp exp '+' {$$ = $1 + $2; } | ...
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+means the same thing as this:
|
|
|
|
+<PRE>
|
|
|
|
+exp: NUM
|
|
|
|
+ | exp exp '+' { $$ = $1 + $2; }
|
|
|
|
+ | ...
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The latter, however, is much more readable.
|
|
|
|
+<H3><A NAME="SEC22" HREF="bison.html#TOC22">The <CODE>rpcalc</CODE> Lexical Analyzer</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX34"></A>
|
|
|
|
+<A NAME="IDX35"></A>
|
|
|
|
+The lexical analyzer's job is low-level parsing: converting characters or
|
|
|
|
+sequences of characters into tokens. The Bison parser gets its tokens by
|
|
|
|
+calling the lexical analyzer. See section <A HREF="bison.html#SEC61">The Lexical Analyzer Function <CODE>yylex</CODE></A>.
|
|
|
|
+Only a simple lexical analyzer is needed for the RPN calculator. This
|
|
|
|
+lexical analyzer skips blanks and tabs, then reads in numbers as
|
|
|
|
+<CODE>double</CODE> and returns them as <CODE>NUM</CODE> tokens. Any other character
|
|
|
|
+that isn't part of a number is a separate token. Note that the token-code
|
|
|
|
+for such a single-character token is the character itself.
|
|
|
|
+The return value of the lexical analyzer function is a numeric code which
|
|
|
|
+represents a token type. The same text used in Bison rules to stand for
|
|
|
|
+this token type is also a C expression for the numeric code for the type.
|
|
|
|
+This works in two ways. If the token type is a character literal, then its
|
|
|
|
+numeric code is the ASCII code for that character; you can use the same
|
|
|
|
+character literal in the lexical analyzer to express the number. If the
|
|
|
|
+token type is an identifier, that identifier is defined by Bison as a C
|
|
|
|
+macro whose definition is the appropriate number. In this example,
|
|
|
|
+therefore, <CODE>NUM</CODE> becomes a macro for <CODE>yylex</CODE> to use.
|
|
|
|
+The semantic value of the token (if it has one) is stored into the global
|
|
|
|
+variable <CODE>yylval</CODE>, which is where the Bison parser will look for it.
|
|
|
|
+(The C data type of <CODE>yylval</CODE> is <CODE>YYSTYPE</CODE>, which was defined
|
|
|
|
+at the beginning of the grammar; see section <A HREF="bison.html#SEC17">Declarations for <CODE>rpcalc</CODE></A>.)
|
|
|
|
+A token type code of zero is returned if the end-of-file is encountered.
|
|
|
|
+(Bison recognizes any nonpositive value as indicating the end of the
|
|
|
|
+input.)
|
|
|
|
+Here is the code for the lexical analyzer:
|
|
|
|
+<PRE>
|
|
|
|
+/* Lexical analyzer returns a double floating point
|
|
|
|
+ number on the stack and the token NUM, or the ASCII
|
|
|
|
+ character read if not a number. Skips all blanks
|
|
|
|
+ and tabs, returns 0 for EOF. */
|
|
|
|
+#include <ctype.h>
|
|
|
|
+yylex ()
|
|
|
|
+{
|
|
|
|
+ int c;
|
|
|
|
+ /* skip white space */
|
|
|
|
+ while ((c = getchar ()) == ' ' || c == '\t')
|
|
|
|
+ ;
|
|
|
|
+ /* process numbers */
|
|
|
|
+ if (c == '.' || isdigit (c))
|
|
|
|
+ {
|
|
|
|
+ ungetc (c, stdin);
|
|
|
|
+ scanf ("%lf", &yylval);
|
|
|
|
+ return NUM;
|
|
|
|
+ }
|
|
|
|
+ /* return end-of-file */
|
|
|
|
+ if (c == EOF)
|
|
|
|
+ return 0;
|
|
|
|
+ /* return single chars */
|
|
|
|
+ return c;
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC23" HREF="bison.html#TOC23">The Controlling Function</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX36"></A>
|
|
|
|
+<A NAME="IDX37"></A>
|
|
|
|
+In keeping with the spirit of this example, the controlling function is
|
|
|
|
+kept to the bare minimum. The only requirement is that it call
|
|
|
|
+<CODE>yyparse</CODE> to start the process of parsing.
|
|
|
|
+<PRE>
|
|
|
|
+main ()
|
|
|
|
+{
|
|
|
|
+ yyparse ();
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC24" HREF="bison.html#TOC24">The Error Reporting Routine</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX38"></A>
|
|
|
|
+When <CODE>yyparse</CODE> detects a syntax error, it calls the error reporting
|
|
|
|
+function <CODE>yyerror</CODE> to print an error message (usually but not always
|
|
|
|
+<CODE>"parse error"</CODE>). It is up to the programmer to supply <CODE>yyerror</CODE>
|
|
|
|
+(see section <A HREF="bison.html#SEC59">Parser C-Language Interface</A>), so here is the definition we will use:
|
|
|
|
+<PRE>
|
|
|
|
+#include <stdio.h>
|
|
|
|
+yyerror (s) /* Called by yyparse on error */
|
|
|
|
+ char *s;
|
|
|
|
+{
|
|
|
|
+ printf ("%s\n", s);
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+After <CODE>yyerror</CODE> returns, the Bison parser may recover from the error
|
|
|
|
+and continue parsing if the grammar contains a suitable error rule
|
|
|
|
+(see section <A HREF="bison.html#SEC81">Error Recovery</A>). Otherwise, <CODE>yyparse</CODE> returns nonzero. We
|
|
|
|
+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 in the first example.
|
|
|
|
+<H3><A NAME="SEC25" HREF="bison.html#TOC25">Running Bison to Make the Parser</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX39"></A>
|
|
|
|
+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>, <CODE>yyerror</CODE> and <CODE>main</CODE> go at the end, in the
|
|
|
|
+"additional C code" section of the file (see section <A HREF="bison.html#SEC14">The Overall Layout of a Bison Grammar</A>).
|
|
|
|
+For a large project, you would probably have several source files, and use
|
|
|
|
+<CODE>make</CODE> to arrange to recompile them.
|
|
|
|
+With all the source in a single file, you use the following command to
|
|
|
|
+convert it into a parser file:
|
|
|
|
+<PRE>
|
|
|
|
+bison <VAR>file_name</VAR>.y
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+In this example the file was called <TT>`rpcalc.y'</TT> (for "Reverse Polish
|
|
|
|
+CALCulator"). Bison produces a file named <TT>`<VAR>file_name</VAR>.tab.c'</TT>,
|
|
|
|
+removing the <SAMP>`.y'</SAMP> from the original file name. The file output by
|
|
|
|
+Bison contains the source code for <CODE>yyparse</CODE>. The additional
|
|
|
|
+functions in the input file (<CODE>yylex</CODE>, <CODE>yyerror</CODE> and <CODE>main</CODE>)
|
|
|
|
+are copied verbatim to the output.
|
|
|
|
+<H3><A NAME="SEC26" HREF="bison.html#TOC26">Compiling the Parser File</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX40"></A>
|
|
|
|
+Here is how to compile and run the parser file:
|
|
|
|
+<PRE>
|
|
|
|
+# List files in current directory.
|
|
|
|
+% ls
|
|
|
|
+rpcalc.tab.c rpcalc.y
|
|
|
|
+# Compile the Bison parser.
|
|
|
|
+# <SAMP>`-lm'</SAMP> tells compiler to search math library for <CODE>pow</CODE>.
|
|
|
|
+% cc rpcalc.tab.c -lm -o rpcalc
|
|
|
|
+# List files again.
|
|
|
|
+% ls
|
|
|
|
+rpcalc rpcalc.tab.c rpcalc.y
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The file <TT>`rpcalc'</TT> now contains the executable code. Here is an
|
|
|
|
+example session using <CODE>rpcalc</CODE>.
|
|
|
|
+<PRE>
|
|
|
|
+% rpcalc
|
|
|
|
+4 9 +
|
|
|
|
+13
|
|
|
|
+3 7 + 3 4 5 *+-
|
|
|
|
+-13
|
|
|
|
+3 7 + 3 4 5 * + - n Note the unary minus, <SAMP>`n'</SAMP>
|
|
|
|
+13
|
|
|
|
+5 6 / 4 n +
|
|
|
|
+-3.166666667
|
|
|
|
+3 4 ^ Exponentiation
|
|
|
|
+81
|
|
|
|
+^D End-of-file indicator
|
|
|
|
+%
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC27" HREF="bison.html#TOC27">Infix Notation Calculator: <CODE>calc</CODE></A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX41"></A>
|
|
|
|
+<A NAME="IDX42"></A>
|
|
|
|
+<A NAME="IDX43"></A>
|
|
|
|
+We now modify rpcalc to handle infix operators instead of postfix. Infix
|
|
|
|
+notation involves the concept of operator precedence and the need for
|
|
|
|
+parentheses nested to arbitrary depth. Here is the Bison code for
|
|
|
|
+<TT>`calc.y'</TT>, an infix desk-top calculator.
|
|
|
|
+<PRE>
|
|
|
|
+/* Infix notation calculator--calc */
|
|
|
|
+%{
|
|
|
|
+#define YYSTYPE double
|
|
|
|
+#include <math.h>
|
|
|
|
+%}
|
|
|
|
+/* BISON Declarations */
|
|
|
|
+%token NUM
|
|
|
|
+%left '-' '+'
|
|
|
|
+%left '*' '/'
|
|
|
|
+%left NEG /* negation--unary minus */
|
|
|
|
+%right '^' /* exponentiation */
|
|
|
|
+/* Grammar follows */
|
|
|
|
+%%
|
|
|
|
+input: /* empty string */
|
|
|
|
+ | input line
|
|
|
|
+;
|
|
|
|
+line: '\n'
|
|
|
|
+ | exp '\n' { printf ("\t%.10g\n", $1); }
|
|
|
|
+;
|
|
|
|
+exp: NUM { $$ = $1; }
|
|
|
|
+ | exp '+' exp { $$ = $1 + $3; }
|
|
|
|
+ | exp '-' exp { $$ = $1 - $3; }
|
|
|
|
+ | exp '*' exp { $$ = $1 * $3; }
|
|
|
|
+ | exp '/' exp { $$ = $1 / $3; }
|
|
|
|
+ | '-' exp %prec NEG { $$ = -$2; }
|
|
|
|
+ | exp '^' exp { $$ = pow ($1, $3); }
|
|
|
|
+ | '(' exp ')' { $$ = $2; }
|
|
|
|
+;
|
|
|
|
+%%
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The functions <CODE>yylex</CODE>, <CODE>yyerror</CODE> and <CODE>main</CODE> can be the same
|
|
|
|
+as before.
|
|
|
|
+There are two important new features shown in this code.
|
|
|
|
+In the second section (Bison declarations), <CODE>%left</CODE> declares token
|
|
|
|
+types and says they are left-associative operators. The declarations
|
|
|
|
+<CODE>%left</CODE> and <CODE>%right</CODE> (right associativity) take the place of
|
|
|
|
+<CODE>%token</CODE> which is used to declare a token type name without
|
|
|
|
+associativity. (These tokens are single-character literals, which
|
|
|
|
+ordinarily don't need to be declared. We declare them here to specify
|
|
|
|
+the associativity.)
|
|
|
|
+Operator precedence is determined by the line ordering of the
|
|
|
|
+declarations; the higher the line number of the declaration (lower on
|
|
|
|
+the page or screen), the higher the precedence. Hence, exponentiation
|
|
|
|
+has the highest precedence, unary minus (<CODE>NEG</CODE>) is next, followed
|
|
|
|
+by <SAMP>`*'</SAMP> and <SAMP>`/'</SAMP>, and so on. See section <A HREF="bison.html#SEC71">Operator Precedence</A>.
|
|
|
|
+The other important new feature is the <CODE>%prec</CODE> in the grammar section
|
|
|
|
+for the unary minus operator. The <CODE>%prec</CODE> simply instructs Bison that
|
|
|
|
+the rule <SAMP>`| '-' exp'</SAMP> has the same precedence as <CODE>NEG</CODE>---in this
|
|
|
|
+case the next-to-highest. See section <A HREF="bison.html#SEC76">Context-Dependent Precedence</A>.
|
|
|
|
+Here is a sample run of <TT>`calc.y'</TT>:
|
|
|
|
+<PRE>
|
|
|
|
+% calc
|
|
|
|
+4 + 4.5 - (34/(8*3+-3))
|
|
|
|
+6.880952381
|
|
|
|
+-56 + 2
|
|
|
|
+-54
|
|
|
|
+3 ^ 2
|
|
|
|
+9
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC28" HREF="bison.html#TOC28">Simple Error Recovery</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX44"></A>
|
|
|
|
+Up to this point, this manual has not addressed the issue of <EM>error
|
|
|
|
+recovery</EM>---how to continue parsing after the parser detects a syntax
|
|
|
|
+error. All we have handled is error reporting with <CODE>yyerror</CODE>. Recall
|
|
|
|
+that by default <CODE>yyparse</CODE> returns after calling <CODE>yyerror</CODE>. This
|
|
|
|
+means that an erroneous input line causes the calculator program to exit.
|
|
|
|
+Now we show how to rectify this deficiency.
|
|
|
|
+The Bison language itself includes the reserved word <CODE>error</CODE>, which
|
|
|
|
+may be included in the grammar rules. In the example below it has
|
|
|
|
+been added to one of the alternatives for <CODE>line</CODE>:
|
|
|
|
+<PRE>
|
|
|
|
+line: '\n'
|
|
|
|
+ | exp '\n' { printf ("\t%.10g\n", $1); }
|
|
|
|
+ | error '\n' { yyerrok; }
|
|
|
|
+;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+This addition to the grammar allows for simple error recovery in the event
|
|
|
|
+of a parse error. If an expression that cannot be evaluated is read, the
|
|
|
|
+error will be recognized by the third rule for <CODE>line</CODE>, and parsing
|
|
|
|
+will continue. (The <CODE>yyerror</CODE> function is still called upon to print
|
|
|
|
+its message as well.) The action executes the statement <CODE>yyerrok</CODE>, a
|
|
|
|
+macro defined automatically by Bison; its meaning is that error recovery is
|
|
|
|
+complete (see section <A HREF="bison.html#SEC81">Error Recovery</A>). Note the difference between
|
|
|
|
+<CODE>yyerrok</CODE> and <CODE>yyerror</CODE>; neither one is a misprint.
|
|
|
|
+This form of error recovery deals with syntax errors. There are other
|
|
|
|
+kinds of errors; for example, division by zero, which raises an exception
|
|
|
|
+signal that is normally fatal. A real calculator program must handle this
|
|
|
|
+signal and use <CODE>longjmp</CODE> to return to <CODE>main</CODE> and resume parsing
|
|
|
|
+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.
|
|
|
|
+<H2><A NAME="SEC29" HREF="bison.html#TOC29">Multi-Function Calculator: <CODE>mfcalc</CODE></A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX45"></A>
|
|
|
|
+<A NAME="IDX46"></A>
|
|
|
|
+<A NAME="IDX47"></A>
|
|
|
|
+Now that the basics of Bison have been discussed, it is time to move on to
|
|
|
|
+a more advanced problem. The above calculators provided only five
|
|
|
|
+functions, <SAMP>`+'</SAMP>, <SAMP>`-'</SAMP>, <SAMP>`*'</SAMP>, <SAMP>`/'</SAMP> and <SAMP>`^'</SAMP>. It would
|
|
|
|
+be nice to have a calculator that provides other mathematical functions such
|
|
|
|
+as <CODE>sin</CODE>, <CODE>cos</CODE>, etc.
|
|
|
|
+It is easy to add new operators to the infix calculator as long as they are
|
|
|
|
+only single-character literals. The lexical analyzer <CODE>yylex</CODE> passes
|
|
|
|
+back all non-number characters as tokens, so new grammar rules suffice for
|
|
|
|
+adding a new operator. But we want something more flexible: built-in
|
|
|
|
+functions whose syntax has this form:
|
|
|
|
+<PRE>
|
|
|
|
+<VAR>function_name</VAR> (<VAR>argument</VAR>)
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+At the same time, we will add memory to the calculator, by allowing you
|
|
|
|
+to create named variables, store values in them, and use them later.
|
|
|
|
+Here is a sample session with the multi-function calculator:
|
|
|
|
+<PRE>
|
|
|
|
+% mfcalc
|
|
|
|
+pi = 3.141592653589
|
|
|
|
+3.1415926536
|
|
|
|
+sin(pi)
|
|
|
|
+0.0000000000
|
|
|
|
+alpha = beta1 = 2.3
|
|
|
|
+2.3000000000
|
|
|
|
+alpha
|
|
|
|
+2.3000000000
|
|
|
|
+ln(alpha)
|
|
|
|
+0.8329091229
|
|
|
|
+exp(ln(beta1))
|
|
|
|
+2.3000000000
|
|
|
|
+%
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Note that multiple assignment and nested function calls are permitted.
|
|
|
|
+<H3><A NAME="SEC30" HREF="bison.html#TOC30">Declarations for <CODE>mfcalc</CODE></A></H3>
|
|
|
|
+<P>
|
|
|
|
+Here are the C and Bison declarations for the multi-function calculator.
|
|
|
|
+<PRE>
|
|
|
|
+%{
|
|
|
|
+#include <math.h> /* For math functions, cos(), sin(), etc. */
|
|
|
|
+#include "calc.h" /* Contains definition of `symrec' */
|
|
|
|
+%}
|
|
|
|
+%union {
|
|
|
|
+double val; /* For returning numbers. */
|
|
|
|
+symrec *tptr; /* For returning symbol-table pointers */
|
|
|
|
+}
|
|
|
|
+%token <val> NUM /* Simple double precision number */
|
|
|
|
+%token <tptr> VAR FNCT /* Variable and Function */
|
|
|
|
+%type <val> exp
|
|
|
|
+%right '='
|
|
|
|
+%left '-' '+'
|
|
|
|
+%left '*' '/'
|
|
|
|
+%left NEG /* Negation--unary minus */
|
|
|
|
+%right '^' /* Exponentiation */
|
|
|
|
+/* Grammar follows */
|
|
|
|
+%%
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The above grammar introduces only two new features of the Bison language.
|
|
|
|
+These features allow semantic values to have various data types
|
|
|
|
+(see section <A HREF="bison.html#SEC45">More Than One Value Type</A>).
|
|
|
|
+The <CODE>%union</CODE> declaration specifies the entire list of possible types;
|
|
|
|
+this is instead of defining <CODE>YYSTYPE</CODE>. The allowable types are now
|
|
|
|
+double-floats (for <CODE>exp</CODE> and <CODE>NUM</CODE>) and pointers to entries in
|
|
|
|
+the symbol table. See section <A HREF="bison.html#SEC52">The Collection of Value Types</A>.
|
|
|
|
+Since values can now have various types, it is necessary to associate a
|
|
|
|
+type with each grammar symbol whose semantic value is used. These symbols
|
|
|
|
+are <CODE>NUM</CODE>, <CODE>VAR</CODE>, <CODE>FNCT</CODE>, and <CODE>exp</CODE>. Their
|
|
|
|
+declarations are augmented with information about their data type (placed
|
|
|
|
+between angle brackets).
|
|
|
|
+The Bison construct <CODE>%type</CODE> is used for declaring nonterminal symbols,
|
|
|
|
+just as <CODE>%token</CODE> is used for declaring token types. We have not used
|
|
|
|
+<CODE>%type</CODE> before because nonterminal symbols are normally declared
|
|
|
|
+implicitly by the rules that define them. But <CODE>exp</CODE> must be declared
|
|
|
|
+explicitly so we can specify its value type. See section <A HREF="bison.html#SEC53">Nonterminal Symbols</A>.
|
|
|
|
+<H3><A NAME="SEC31" HREF="bison.html#TOC31">Grammar Rules for <CODE>mfcalc</CODE></A></H3>
|
|
|
|
+<P>
|
|
|
|
+Here are the grammar rules for the multi-function calculator.
|
|
|
|
+Most of them are copied directly from <CODE>calc</CODE>; three rules,
|
|
|
|
+those which mention <CODE>VAR</CODE> or <CODE>FNCT</CODE>, are new.
|
|
|
|
+<PRE>
|
|
|
|
+input: /* empty */
|
|
|
|
+ | input line
|
|
|
|
+;
|
|
|
|
+line:
|
|
|
|
+ '\n'
|
|
|
|
+ | exp '\n' { printf ("\t%.10g\n", $1); }
|
|
|
|
+ | error '\n' { yyerrok; }
|
|
|
|
+;
|
|
|
|
+exp: NUM { $$ = $1; }
|
|
|
|
+ | VAR { $$ = $1->value.var; }
|
|
|
|
+ | VAR '=' exp { $$ = $3; $1->value.var = $3; }
|
|
|
|
+ | FNCT '(' exp ')' { $$ = (*($1->value.fnctptr))($3); }
|
|
|
|
+ | exp '+' exp { $$ = $1 + $3; }
|
|
|
|
+ | exp '-' exp { $$ = $1 - $3; }
|
|
|
|
+ | exp '*' exp { $$ = $1 * $3; }
|
|
|
|
+ | exp '/' exp { $$ = $1 / $3; }
|
|
|
|
+ | '-' exp %prec NEG { $$ = -$2; }
|
|
|
|
+ | exp '^' exp { $$ = pow ($1, $3); }
|
|
|
|
+ | '(' exp ')' { $$ = $2; }
|
|
|
|
+;
|
|
|
|
+/* End of grammar */
|
|
|
|
+%%
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC32" HREF="bison.html#TOC32">The <CODE>mfcalc</CODE> Symbol Table</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX48"></A>
|
|
|
|
+The multi-function calculator requires a symbol table to keep track of the
|
|
|
|
+names and meanings of variables and functions. This doesn't affect the
|
|
|
|
+grammar rules (except for the actions) or the Bison declarations, but it
|
|
|
|
+requires some additional C functions for support.
|
|
|
|
+The symbol table itself consists of a linked list of records. Its
|
|
|
|
+definition, which is kept in the header <TT>`calc.h'</TT>, is as follows. It
|
|
|
|
+provides for either functions or variables to be placed in the table.
|
|
|
|
+<PRE>
|
|
|
|
+/* Data type for links in the chain of symbols. */
|
|
|
|
+struct symrec
|
|
|
|
+{
|
|
|
|
+ char *name; /* name of symbol */
|
|
|
|
+ int type; /* type of symbol: either VAR or FNCT */
|
|
|
|
+ union {
|
|
|
|
+ double var; /* value of a VAR */
|
|
|
|
+ double (*fnctptr)(); /* value of a FNCT */
|
|
|
|
+ } value;
|
|
|
|
+ struct symrec *next; /* link field */
|
|
|
|
+};
|
|
|
|
+typedef struct symrec symrec;
|
|
|
|
+/* The symbol table: a chain of `struct symrec'. */
|
|
|
|
+extern symrec *sym_table;
|
|
|
|
+symrec *putsym ();
|
|
|
|
+symrec *getsym ();
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The new version of <CODE>main</CODE> includes a call to <CODE>init_table</CODE>, a
|
|
|
|
+function that initializes the symbol table. Here it is, and
|
|
|
|
+<CODE>init_table</CODE> as well:
|
|
|
|
+<PRE>
|
|
|
|
+#include <stdio.h>
|
|
|
|
+main ()
|
|
|
|
+{
|
|
|
|
+ init_table ();
|
|
|
|
+ yyparse ();
|
|
|
|
+}
|
|
|
|
+yyerror (s) /* Called by yyparse on error */
|
|
|
|
+ char *s;
|
|
|
|
+{
|
|
|
|
+ printf ("%s\n", s);
|
|
|
|
+}
|
|
|
|
+struct init
|
|
|
|
+{
|
|
|
|
+ char *fname;
|
|
|
|
+ double (*fnct)();
|
|
|
|
+};
|
|
|
|
+struct init arith_fncts[]
|
|
|
|
+ = {
|
|
|
|
+ "sin", sin,
|
|
|
|
+ "cos", cos,
|
|
|
|
+ "atan", atan,
|
|
|
|
+ "ln", log,
|
|
|
|
+ "exp", exp,
|
|
|
|
+ "sqrt", sqrt,
|
|
|
|
+ 0, 0
|
|
|
|
+ };
|
|
|
|
+/* The symbol table: a chain of `struct symrec'. */
|
|
|
|
+symrec *sym_table = (symrec *)0;
|
|
|
|
+init_table () /* puts arithmetic functions in table. */
|
|
|
|
+{
|
|
|
|
+ int i;
|
|
|
|
+ symrec *ptr;
|
|
|
|
+ for (i = 0; arith_fncts[i].fname != 0; i++)
|
|
|
|
+ {
|
|
|
|
+ ptr = putsym (arith_fncts[i].fname, FNCT);
|
|
|
|
+ ptr->value.fnctptr = arith_fncts[i].fnct;
|
|
|
|
+ }
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+By simply editing the initialization list and adding the necessary include
|
|
|
|
+files, you can add additional functions to the calculator.
|
|
|
|
+Two important functions allow look-up and installation of symbols in the
|
|
|
|
+symbol table. The function <CODE>putsym</CODE> is passed a name and the type
|
|
|
|
+(<CODE>VAR</CODE> or <CODE>FNCT</CODE>) of the object to be installed. The object is
|
|
|
|
+linked to the front of the list, and a pointer to the object is returned.
|
|
|
|
+The function <CODE>getsym</CODE> is passed the name of the symbol to look up. If
|
|
|
|
+found, a pointer to that symbol is returned; otherwise zero is returned.
|
|
|
|
+<PRE>
|
|
|
|
+symrec *
|
|
|
|
+putsym (sym_name,sym_type)
|
|
|
|
+ char *sym_name;
|
|
|
|
+ int sym_type;
|
|
|
|
+{
|
|
|
|
+ symrec *ptr;
|
|
|
|
+ ptr = (symrec *) malloc (sizeof (symrec));
|
|
|
|
+ ptr->name = (char *) malloc (strlen (sym_name) + 1);
|
|
|
|
+ strcpy (ptr->name,sym_name);
|
|
|
|
+ ptr->type = sym_type;
|
|
|
|
+ ptr->value.var = 0; /* set value to 0 even if fctn. */
|
|
|
|
+ ptr->next = (struct symrec *)sym_table;
|
|
|
|
+ sym_table = ptr;
|
|
|
|
+ return ptr;
|
|
|
|
+}
|
|
|
|
+symrec *
|
|
|
|
+getsym (sym_name)
|
|
|
|
+ char *sym_name;
|
|
|
|
+{
|
|
|
|
+ symrec *ptr;
|
|
|
|
+ for (ptr = sym_table; ptr != (symrec *) 0;
|
|
|
|
+ ptr = (symrec *)ptr->next)
|
|
|
|
+ if (strcmp (ptr->name,sym_name) == 0)
|
|
|
|
+ return ptr;
|
|
|
|
+ return 0;
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The function <CODE>yylex</CODE> must now recognize variables, numeric values, and
|
|
|
|
+the single-character arithmetic operators. Strings of alphanumeric
|
|
|
|
+characters with a leading nondigit are recognized as either variables or
|
|
|
|
+functions depending on what the symbol table says about them.
|
|
|
|
+The string is passed to <CODE>getsym</CODE> for look up in the symbol table. If
|
|
|
|
+the name appears in the table, a pointer to its location and its type
|
|
|
|
+(<CODE>VAR</CODE> or <CODE>FNCT</CODE>) is returned to <CODE>yyparse</CODE>. If it is not
|
|
|
|
+already in the table, then it is installed as a <CODE>VAR</CODE> using
|
|
|
|
+<CODE>putsym</CODE>. Again, a pointer and its type (which must be <CODE>VAR</CODE>) is
|
|
|
|
+returned to <CODE>yyparse</CODE>.
|
|
|
|
+No change is needed in the handling of numeric values and arithmetic
|
|
|
|
+operators in <CODE>yylex</CODE>.
|
|
|
|
+<PRE>
|
|
|
|
+#include <ctype.h>
|
|
|
|
+yylex ()
|
|
|
|
+{
|
|
|
|
+ int c;
|
|
|
|
+ /* Ignore whitespace, get first nonwhite character. */
|
|
|
|
+ while ((c = getchar ()) == ' ' || c == '\t');
|
|
|
|
+ if (c == EOF)
|
|
|
|
+ return 0;
|
|
|
|
+ /* Char starts a number => parse the number. */
|
|
|
|
+ if (c == '.' || isdigit (c))
|
|
|
|
+ {
|
|
|
|
+ ungetc (c, stdin);
|
|
|
|
+ scanf ("%lf", &yylval.val);
|
|
|
|
+ return NUM;
|
|
|
|
+ }
|
|
|
|
+ /* Char starts an identifier => read the name. */
|
|
|
|
+ if (isalpha (c))
|
|
|
|
+ {
|
|
|
|
+ symrec *s;
|
|
|
|
+ static char *symbuf = 0;
|
|
|
|
+ static int length = 0;
|
|
|
|
+ int i;
|
|
|
|
+ /* Initially make the buffer long enough
|
|
|
|
+ for a 40-character symbol name. */
|
|
|
|
+ if (length == 0)
|
|
|
|
+ length = 40, symbuf = (char *)malloc (length + 1);
|
|
|
|
+ i = 0;
|
|
|
|
+ do
|
|
|
|
+ {
|
|
|
|
+ /* If buffer is full, make it bigger. */
|
|
|
|
+ if (i == length)
|
|
|
|
+ {
|
|
|
|
+ length *= 2;
|
|
|
|
+ symbuf = (char *)realloc (symbuf, length + 1);
|
|
|
|
+ }
|
|
|
|
+ /* Add this character to the buffer. */
|
|
|
|
+ symbuf[i++] = c;
|
|
|
|
+ /* Get another character. */
|
|
|
|
+ c = getchar ();
|
|
|
|
+ }
|
|
|
|
+ while (c != EOF && isalnum (c));
|
|
|
|
+ ungetc (c, stdin);
|
|
|
|
+ symbuf[i] = '\0';
|
|
|
|
+ s = getsym (symbuf);
|
|
|
|
+ if (s == 0)
|
|
|
|
+ s = putsym (symbuf, VAR);
|
|
|
|
+ yylval.tptr = s;
|
|
|
|
+ return s->type;
|
|
|
|
+ }
|
|
|
|
+ /* Any other character is a token by itself. */
|
|
|
|
+ return c;
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+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</CODE> or <CODE>e</CODE> as well.
|
|
|
|
+<H2><A NAME="SEC33" HREF="bison.html#TOC33">Exercises</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX49"></A>
|
|
|
|
+<OL>
|
|
|
|
+<LI>
|
|
|
|
+Add some new functions from <TT>`math.h'</TT> to the initialization list.
|
|
|
|
+<LI>
|
|
|
|
+Add another array that contains constants and their values. Then
|
|
|
|
+modify <CODE>init_table</CODE> to add these constants to the symbol table.
|
|
|
|
+It will be easiest to give the constants type <CODE>VAR</CODE>.
|
|
|
|
+<LI>
|
|
|
|
+Make the program report an error if the user refers to an
|
|
|
|
+uninitialized variable in any way except to store a value in it.
|
|
|
|
+</OL>
|
|
|
|
+<P>
|
|
|
|
+<H1><A NAME="SEC34" HREF="bison.html#TOC34">Bison Grammar Files</A></H1>
|
|
|
|
+<P>
|
|
|
|
+Bison takes as input a context-free grammar specification and produces a
|
|
|
|
+C-language function that recognizes correct instances of the grammar.
|
|
|
|
+The Bison grammar input file conventionally has a name ending in <SAMP>`.y'</SAMP>.
|
|
|
|
+<H2><A NAME="SEC35" HREF="bison.html#TOC35">Outline of a Bison Grammar</A></H2>
|
|
|
|
+<P>
|
|
|
|
+A Bison grammar file has four main sections, shown here with the
|
|
|
|
+appropriate delimiters:
|
|
|
|
+<PRE>
|
|
|
|
+%{
|
|
|
|
+<VAR>C declarations</VAR>
|
|
|
|
+%}
|
|
|
|
+<VAR>Bison declarations</VAR>
|
|
|
|
+%%
|
|
|
|
+<VAR>Grammar rules</VAR>
|
|
|
|
+%%
|
|
|
|
+<VAR>Additional C code</VAR>
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Comments enclosed in <SAMP>`/* ... */'</SAMP> may appear in any of the sections.
|
|
|
|
+<H3><A NAME="SEC36" HREF="bison.html#TOC36">The C Declarations Section</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX50"></A>
|
|
|
|
+<A NAME="IDX51"></A>
|
|
|
|
+The <VAR>C declarations</VAR> 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</CODE>. You can use
|
|
|
|
+<SAMP>`#include'</SAMP> to get the declarations from a header file. If you don't
|
|
|
|
+need any C declarations, you may omit the <SAMP>`%{'</SAMP> and <SAMP>`%}'</SAMP>
|
|
|
|
+delimiters that bracket this section.
|
|
|
|
+<H3><A NAME="SEC37" HREF="bison.html#TOC37">The Bison Declarations Section</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX52"></A>
|
|
|
|
+<A NAME="IDX53"></A>
|
|
|
|
+The <VAR>Bison declarations</VAR> section contains declarations that define
|
|
|
|
+terminal and nonterminal symbols, specify precedence, and so on.
|
|
|
|
+In some simple grammars you may not need any declarations.
|
|
|
|
+See section <A HREF="bison.html#SEC49">Bison Declarations</A>.
|
|
|
|
+<H3><A NAME="SEC38" HREF="bison.html#TOC38">The Grammar Rules Section</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX54"></A>
|
|
|
|
+<A NAME="IDX55"></A>
|
|
|
|
+The <EM>grammar rules</EM> section contains one or more Bison grammar
|
|
|
|
+rules, and nothing else. See section <A HREF="bison.html#SEC41">Syntax of Grammar Rules</A>.
|
|
|
|
+There must always be at least one grammar rule, and the first
|
|
|
|
+<SAMP>`%%'</SAMP> (which precedes the grammar rules) may never be omitted even
|
|
|
|
+if it is the first thing in the file.
|
|
|
|
+<H3><A NAME="SEC39" HREF="bison.html#TOC39">The Additional C Code Section</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX56"></A>
|
|
|
|
+<A NAME="IDX57"></A>
|
|
|
|
+The <VAR>additional C code</VAR> section is copied verbatim to the end of
|
|
|
|
+the parser file, just as the <VAR>C declarations</VAR> 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</CODE>. For example, the definitions of
|
|
|
|
+<CODE>yylex</CODE> and <CODE>yyerror</CODE> often go here. See section <A HREF="bison.html#SEC59">Parser C-Language Interface</A>.
|
|
|
|
+If the last section is empty, you may omit the <SAMP>`%%'</SAMP> that separates it
|
|
|
|
+from the grammar rules.
|
|
|
|
+The Bison parser itself contains many static variables whose names start
|
|
|
|
+with <SAMP>`yy'</SAMP> and many macros whose names start with <SAMP>`YY'</SAMP>. 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.
|
|
|
|
+<H2><A NAME="SEC40" HREF="bison.html#TOC40">Symbols, Terminal and Nonterminal</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX58"></A>
|
|
|
|
+<A NAME="IDX59"></A>
|
|
|
|
+<A NAME="IDX60"></A>
|
|
|
|
+<A NAME="IDX61"></A>
|
|
|
|
+<EM>Symbols</EM> in Bison grammars represent the grammatical classifications
|
|
|
|
+of the language.
|
|
|
|
+A <EM>terminal symbol</EM> (also known as a <EM>token type</EM>) represents a
|
|
|
|
+class of syntactically equivalent tokens. You use the symbol in grammar
|
|
|
|
+rules to mean that a token in that class is allowed. The symbol is
|
|
|
|
+represented in the Bison parser by a numeric code, and the <CODE>yylex</CODE>
|
|
|
|
+function returns a token type code to indicate what kind of token has been
|
|
|
|
+read. You don't need to know what the code value is; you can use the
|
|
|
|
+symbol to stand for it.
|
|
|
|
+A <EM>nonterminal symbol</EM> stands for a class of syntactically equivalent
|
|
|
|
+groupings. The symbol name is used in writing grammar rules. By convention,
|
|
|
|
+it should be all lower case.
|
|
|
|
+Symbol names can contain letters, digits (not at the beginning),
|
|
|
|
+underscores and periods. Periods make sense only in nonterminals.
|
|
|
|
+There are two ways of writing terminal symbols in the grammar:
|
|
|
|
+<UL>
|
|
|
|
+<LI>
|
|
|
|
+A <EM>named token type</EM> is written with an identifier, like an
|
|
|
|
+identifier in C. By convention, it should be all upper case. Each
|
|
|
|
+such name must be defined with a Bison declaration such as
|
|
|
|
+<CODE>%token</CODE>. See section <A HREF="bison.html#SEC50">Token Type Names</A>.
|
|
|
|
+<LI>
|
|
|
|
+<A NAME="IDX62"></A>
|
|
|
|
+<A NAME="IDX63"></A>
|
|
|
|
+<A NAME="IDX64"></A>
|
|
|
|
+A <EM>character token type</EM> (or <EM>literal token</EM>) is written in
|
|
|
|
+the grammar using the same syntax used in C for character constants;
|
|
|
|
+for example, <CODE>'+'</CODE> is a character token type. A character token
|
|
|
|
+type doesn't need to be declared unless you need to specify its
|
|
|
|
+semantic value data type (see section <A HREF="bison.html#SEC44">Data Types of Semantic Values</A>), associativity, or
|
|
|
|
+precedence (see section <A HREF="bison.html#SEC71">Operator Precedence</A>).
|
|
|
|
+By convention, a character token type is used only to represent a
|
|
|
|
+token that consists of that particular character. Thus, the token
|
|
|
|
+type <CODE>'+'</CODE> is used to represent the character <SAMP>`+'</SAMP> as a
|
|
|
|
+token. Nothing enforces this convention, but if you depart from it,
|
|
|
|
+your program will confuse other readers.
|
|
|
|
+All the usual escape sequences used in character literals in C can be
|
|
|
|
+used in Bison as well, but you must not use the null character as a
|
|
|
|
+character literal because its ASCII code, zero, is the code
|
|
|
|
+<CODE>yylex</CODE> returns for end-of-input (see section <A HREF="bison.html#SEC62">Calling Convention for <CODE>yylex</CODE></A>).
|
|
|
|
+</UL>
|
|
|
|
+<P>
|
|
|
|
+How you choose to write a terminal symbol has no effect on its
|
|
|
|
+grammatical meaning. That depends only on where it appears in rules and
|
|
|
|
+on when the parser function returns that symbol.
|
|
|
|
+The value returned by <CODE>yylex</CODE> is always one of the terminal symbols
|
|
|
|
+(or 0 for end-of-input). Whichever way you write the token type in the
|
|
|
|
+grammar rules, you write it the same way in the definition of <CODE>yylex</CODE>.
|
|
|
|
+The numeric code for a character token type is simply the ASCII code for
|
|
|
|
+the character, so <CODE>yylex</CODE> can use the identical character constant to
|
|
|
|
+generate the requisite code. Each named token type becomes a C macro in
|
|
|
|
+the parser file, so <CODE>yylex</CODE> can use the name to stand for the code.
|
|
|
|
+(This is why periods don't make sense in terminal symbols.)
|
|
|
|
+See section <A HREF="bison.html#SEC62">Calling Convention for <CODE>yylex</CODE></A>.
|
|
|
|
+If <CODE>yylex</CODE> is defined in a separate file, you need to arrange for the
|
|
|
|
+token-type macro definitions to be available there. Use the <SAMP>`-d'</SAMP>
|
|
|
|
+option when you run Bison, so that it will write these macro definitions
|
|
|
|
+into a separate header file <TT>`<VAR>name</VAR>.tab.h'</TT> which you can include
|
|
|
|
+in the other source files that need it. See section <A HREF="bison.html#SEC87">Invoking Bison</A>.
|
|
|
|
+The symbol <CODE>error</CODE> is a terminal symbol reserved for error recovery
|
|
|
|
+(see section <A HREF="bison.html#SEC81">Error Recovery</A>); you shouldn't use it for any other purpose.
|
|
|
|
+In particular, <CODE>yylex</CODE> should never return this value.
|
|
|
|
+<H2><A NAME="SEC41" HREF="bison.html#TOC41">Syntax of Grammar Rules</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX65"></A>
|
|
|
|
+<A NAME="IDX66"></A>
|
|
|
|
+<A NAME="IDX67"></A>
|
|
|
|
+A Bison grammar rule has the following general form:
|
|
|
|
+<PRE>
|
|
|
|
+<VAR>result</VAR>: <VAR>components</VAR>...
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+where <VAR>result</VAR> is the nonterminal symbol that this rule describes
|
|
|
|
+and <VAR>components</VAR> are various terminal and nonterminal symbols that
|
|
|
|
+are put together by this rule (see section <A HREF="bison.html#SEC40">Symbols, Terminal and Nonterminal</A>).
|
|
|
|
+For example,
|
|
|
|
+<PRE>
|
|
|
|
+exp: exp '+' exp
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+says that two groupings of type <CODE>exp</CODE>, with a <SAMP>`+'</SAMP> token in between,
|
|
|
|
+can be combined into a larger grouping of type <CODE>exp</CODE>.
|
|
|
|
+Whitespace in rules is significant only to separate symbols. You can add
|
|
|
|
+extra whitespace as you wish.
|
|
|
|
+Scattered among the components can be <VAR>actions</VAR> that determine
|
|
|
|
+the semantics of the rule. An action looks like this:
|
|
|
|
+<PRE>
|
|
|
|
+{<VAR>C statements</VAR>}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Usually there is only one action and it follows the components.
|
|
|
|
+See section <A HREF="bison.html#SEC46">Actions</A>.
|
|
|
|
+<A NAME="IDX68"></A>
|
|
|
|
+Multiple rules for the same <VAR>result</VAR> can be written separately or can
|
|
|
|
+be joined with the vertical-bar character <SAMP>`|'</SAMP> as follows:
|
|
|
|
+<PRE>
|
|
|
|
+<VAR>result</VAR>: <VAR>rule1-components</VAR>...
|
|
|
|
+ | <VAR>rule2-components</VAR>...
|
|
|
|
+ ...
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+They are still considered distinct rules even when joined in this way.
|
|
|
|
+If <VAR>components</VAR> in a rule is empty, it means that <VAR>result</VAR> can
|
|
|
|
+match the empty string. For example, here is how to define a
|
|
|
|
+comma-separated sequence of zero or more <CODE>exp</CODE> groupings:
|
|
|
|
+<PRE>
|
|
|
|
+expseq: /* empty */
|
|
|
|
+ | expseq1
|
|
|
|
+ ;
|
|
|
|
+expseq1: exp
|
|
|
|
+ | expseq1 ',' exp
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+It is customary to write a comment <SAMP>`/* empty */'</SAMP> in each rule
|
|
|
|
+with no components.
|
|
|
|
+<H2><A NAME="SEC42" HREF="bison.html#TOC42">Recursive Rules</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX69"></A>
|
|
|
|
+A rule is called <EM>recursive</EM> when its <VAR>result</VAR> nonterminal appears
|
|
|
|
+also on its right hand side. Nearly all Bison grammars need to use
|
|
|
|
+recursion, because that is the only way to define a sequence of any number
|
|
|
|
+of somethings. Consider this recursive definition of a comma-separated
|
|
|
|
+sequence of one or more expressions:
|
|
|
|
+<PRE>
|
|
|
|
+expseq1: exp
|
|
|
|
+ | expseq1 ',' exp
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX70"></A>
|
|
|
|
+<A NAME="IDX71"></A>
|
|
|
|
+Since the recursive use of <CODE>expseq1</CODE> is the leftmost symbol in the
|
|
|
|
+right hand side, we call this <EM>left recursion</EM>. By contrast, here
|
|
|
|
+the same construct is defined using <EM>right recursion</EM>:
|
|
|
|
+<PRE>
|
|
|
|
+expseq1: exp
|
|
|
|
+ | exp ',' expseq1
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Any kind of sequence can be defined using either left recursion or
|
|
|
|
+right recursion, but you should always use left recursion, because it
|
|
|
|
+can parse a sequence of any number of elements with bounded stack
|
|
|
|
+space. Right recursion uses up space on the Bison stack in proportion
|
|
|
|
+to the number of elements in the sequence, because all the elements
|
|
|
|
+must be shifted onto the stack before the rule can be applied even
|
|
|
|
+once. See section <A HREF="bison.html#SEC68">The Bison Parser Algorithm</A>, for
|
|
|
|
+further explanation of this.
|
|
|
|
+<A NAME="IDX72"></A>
|
|
|
|
+<EM>Indirect</EM> or <EM>mutual</EM> recursion occurs when the result of the
|
|
|
|
+rule does not appear directly on its right hand side, but does appear
|
|
|
|
+in rules for other nonterminals which do appear on its right hand
|
|
|
|
+side.
|
|
|
|
+For example:
|
|
|
|
+<PRE>
|
|
|
|
+expr: primary
|
|
|
|
+ | primary '+' primary
|
|
|
|
+ ;
|
|
|
|
+primary: constant
|
|
|
|
+ | '(' expr ')'
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+defines two mutually-recursive nonterminals, since each refers to the
|
|
|
|
+other.
|
|
|
|
+<H2><A NAME="SEC43" HREF="bison.html#TOC43">Defining Language Semantics</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX73"></A>
|
|
|
|
+<A NAME="IDX74"></A>
|
|
|
|
+The grammar rules for a language determine only the syntax. The semantics
|
|
|
|
+are determined by the semantic values associated with various tokens and
|
|
|
|
+groupings, and by the actions taken when various groupings are recognized.
|
|
|
|
+For example, the calculator calculates properly because the value
|
|
|
|
+associated with each expression is the proper number; it adds properly
|
|
|
|
+because the action for the grouping <SAMP>`<VAR>x</VAR> + <VAR>y</VAR>'</SAMP> is to add
|
|
|
|
+the numbers associated with <VAR>x</VAR> and <VAR>y</VAR>.
|
|
|
|
+<H3><A NAME="SEC44" HREF="bison.html#TOC44">Data Types of Semantic Values</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX75"></A>
|
|
|
|
+<A NAME="IDX76"></A>
|
|
|
|
+<A NAME="IDX77"></A>
|
|
|
|
+<A NAME="IDX78"></A>
|
|
|
|
+In a simple program it may be sufficient to use the same data type for
|
|
|
|
+the semantic values of all language constructs. This was true in the
|
|
|
|
+RPN and infix calculator examples (see section <A HREF="bison.html#SEC16">Reverse Polish Notation Calculator</A>).
|
|
|
|
+Bison's default is to use type <CODE>int</CODE> for all semantic values. To
|
|
|
|
+specify some other type, define <CODE>YYSTYPE</CODE> as a macro, like this:
|
|
|
|
+<PRE>
|
|
|
|
+#define YYSTYPE double
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+This macro definition must go in the C declarations section of the grammar
|
|
|
|
+file (see section <A HREF="bison.html#SEC35">Outline of a Bison Grammar</A>).
|
|
|
|
+<H3><A NAME="SEC45" HREF="bison.html#TOC45">More Than One Value Type</A></H3>
|
|
|
|
+<P>
|
|
|
|
+In most programs, you will need different data types for different kinds
|
|
|
|
+of tokens and groupings. For example, a numeric constant may need type
|
|
|
|
+<CODE>int</CODE> or <CODE>long</CODE>, while a string constant needs type <CODE>char *</CODE>,
|
|
|
|
+and an identifier might need a pointer to an entry in the symbol table.
|
|
|
|
+To use more than one data type for semantic values in one parser, Bison
|
|
|
|
+requires you to do two things:
|
|
|
|
+<UL>
|
|
|
|
+<LI>
|
|
|
|
+Specify the entire collection of possible data types, with the
|
|
|
|
+<CODE>%union</CODE> Bison declaration (see section <A HREF="bison.html#SEC52">The Collection of Value Types</A>).
|
|
|
|
+<LI>
|
|
|
|
+Choose one of those types for each symbol (terminal or nonterminal)
|
|
|
|
+for which semantic values are used. This is done for tokens with the
|
|
|
|
+<CODE>%token</CODE> Bison declaration (see section <A HREF="bison.html#SEC50">Token Type Names</A>) and for groupings
|
|
|
|
+with the <CODE>%type</CODE> Bison declaration (see section <A HREF="bison.html#SEC53">Nonterminal Symbols</A>).
|
|
|
|
+</UL>
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC46" HREF="bison.html#TOC46">Actions</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX79"></A>
|
|
|
|
+<A NAME="IDX80"></A>
|
|
|
|
+<A NAME="IDX81"></A>
|
|
|
|
+An action accompanies a syntactic rule and contains C code to be executed
|
|
|
|
+each time an instance of that rule is recognized. The task of most actions
|
|
|
|
+is to compute a semantic value for the grouping built by the rule from the
|
|
|
|
+semantic values associated with tokens or smaller groupings.
|
|
|
|
+An action consists of C statements surrounded by braces, much like a
|
|
|
|
+compound statement in C. It can be placed at any position in the rule; it
|
|
|
|
+is executed at that position. Most rules have just one action at the end
|
|
|
|
+of the rule, following all the components. Actions in the middle of a rule
|
|
|
|
+are tricky and used only for special purposes (see section <A HREF="bison.html#SEC48">Actions in Mid-Rule</A>).
|
|
|
|
+The C code in an action can refer to the semantic values of the components
|
|
|
|
+matched by the rule with the construct <CODE>$<VAR>n</VAR></CODE>, which stands for
|
|
|
|
+the value of the <VAR>n</VAR>th component. The semantic value for the grouping
|
|
|
|
+being constructed is <CODE>$$</CODE>. (Bison translates both of these constructs
|
|
|
|
+into array element references when it copies the actions into the parser
|
|
|
|
+file.)
|
|
|
|
+Here is a typical example:
|
|
|
|
+<PRE>
|
|
|
|
+exp: ...
|
|
|
|
+ | exp '+' exp
|
|
|
|
+ { $$ = $1 + $3; }
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+This rule constructs an <CODE>exp</CODE> from two smaller <CODE>exp</CODE> groupings
|
|
|
|
+connected by a plus-sign token. In the action, <CODE>$1</CODE> and <CODE>$3</CODE>
|
|
|
|
+refer to the semantic values of the two component <CODE>exp</CODE> groupings,
|
|
|
|
+which are the first and third symbols on the right hand side of the rule.
|
|
|
|
+The sum is stored into <CODE>$$</CODE> so that it becomes the semantic value of
|
|
|
|
+the addition-expression just recognized by the rule. If there were a
|
|
|
|
+useful semantic value associated with the <SAMP>`+'</SAMP> token, it could be
|
|
|
|
+referred to as <CODE>$2</CODE>.
|
|
|
|
+<A NAME="IDX82"></A>
|
|
|
|
+If you don't specify an action for a rule, Bison supplies a default:
|
|
|
|
+<CODE>$$ = $1</CODE>. Thus, the value of the first symbol in the rule becomes
|
|
|
|
+the value of the whole rule. Of course, the default rule is valid only
|
|
|
|
+if the two data types match. There is no meaningful default action for
|
|
|
|
+an empty rule; every empty rule must have an explicit action unless the
|
|
|
|
+rule's value does not matter.
|
|
|
|
+<CODE>$<VAR>n</VAR></CODE> with <VAR>n</VAR> zero or negative is allowed for reference
|
|
|
|
+to tokens and groupings on the stack <EM>before</EM> those that match the
|
|
|
|
+current rule. This is a very risky practice, and to use it reliably
|
|
|
|
+you must be certain of the context in which the rule is applied. Here
|
|
|
|
+is a case in which you can use this reliably:
|
|
|
|
+<PRE>
|
|
|
|
+foo: expr bar '+' expr { ... }
|
|
|
|
+ | expr bar '-' expr { ... }
|
|
|
|
+ ;
|
|
|
|
+bar: /* empty */
|
|
|
|
+ { previous_expr = $0; }
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+As long as <CODE>bar</CODE> is used only in the fashion shown here, <CODE>$0</CODE>
|
|
|
|
+always refers to the <CODE>expr</CODE> which precedes <CODE>bar</CODE> in the
|
|
|
|
+definition of <CODE>foo</CODE>.
|
|
|
|
+<H3><A NAME="SEC47" HREF="bison.html#TOC47">Data Types of Values in Actions</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX83"></A>
|
|
|
|
+<A NAME="IDX84"></A>
|
|
|
|
+If you have chosen a single data type for semantic values, the <CODE>$$</CODE>
|
|
|
|
+and <CODE>$<VAR>n</VAR></CODE> constructs always have that data type.
|
|
|
|
+If you have used <CODE>%union</CODE> to specify a variety of data types, then you
|
|
|
|
+must declare a choice among these types for each terminal or nonterminal
|
|
|
|
+symbol that can have a semantic value. Then each time you use <CODE>$$</CODE> or
|
|
|
|
+<CODE>$<VAR>n</VAR></CODE>, its data type is determined by which symbol it refers to
|
|
|
|
+in the rule. In this example,
|
|
|
|
+<PRE>
|
|
|
|
+exp: ...
|
|
|
|
+ | exp '+' exp
|
|
|
|
+ { $$ = $1 + $3; }
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<CODE>$1</CODE> and <CODE>$3</CODE> refer to instances of <CODE>exp</CODE>, so they all
|
|
|
|
+have the data type declared for the nonterminal symbol <CODE>exp</CODE>. If
|
|
|
|
+<CODE>$2</CODE> were used, it would have the data type declared for the
|
|
|
|
+terminal symbol <CODE>'+'</CODE>, whatever that might be.
|
|
|
|
+Alternatively, you can specify the data type when you refer to the value,
|
|
|
|
+by inserting <SAMP>`<<VAR>type</VAR>>'</SAMP> after the <SAMP>`$'</SAMP> at the beginning of the
|
|
|
|
+reference. For example, if you have defined types as shown here:
|
|
|
|
+<PRE>
|
|
|
|
+%union {
|
|
|
|
+ int itype;
|
|
|
|
+ double dtype;
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+then you can write <CODE>$<itype>1</CODE> to refer to the first subunit of the
|
|
|
|
+rule as an integer, or <CODE>$<dtype>1</CODE> to refer to it as a double.
|
|
|
|
+<H3><A NAME="SEC48" HREF="bison.html#TOC48">Actions in Mid-Rule</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX85"></A>
|
|
|
|
+<A NAME="IDX86"></A>
|
|
|
|
+Occasionally it is useful to put an action in the middle of a rule.
|
|
|
|
+These actions are written just like usual end-of-rule actions, but they
|
|
|
|
+are executed before the parser even recognizes the following components.
|
|
|
|
+A mid-rule action may refer to the components preceding it using
|
|
|
|
+<CODE>$<VAR>n</VAR></CODE>, but it may not refer to subsequent components because
|
|
|
|
+it is run before they are parsed.
|
|
|
|
+The mid-rule action itself counts as one of the components of the rule.
|
|
|
|
+This makes a difference when there is another action later in the same rule
|
|
|
|
+(and usually there is another at the end): you have to count the actions
|
|
|
|
+along with the symbols when working out which number <VAR>n</VAR> to use in
|
|
|
|
+<CODE>$<VAR>n</VAR></CODE>.
|
|
|
|
+The mid-rule action can also have a semantic value. The action can set
|
|
|
|
+its value with an assignment to <CODE>$$</CODE>, and actions later in the rule
|
|
|
|
+can refer to the value using <CODE>$<VAR>n</VAR></CODE>. 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>`$<...>'</SAMP> 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>$$</CODE> do not have that effect. The
|
|
|
|
+only way to set the value for the entire rule is with an ordinary action
|
|
|
|
+at the end of the rule.
|
|
|
|
+Here is an example from a hypothetical compiler, handling a <CODE>let</CODE>
|
|
|
|
+statement that looks like <SAMP>`let (<VAR>variable</VAR>) <VAR>statement</VAR>'</SAMP> and
|
|
|
|
+serves to create a variable named <VAR>variable</VAR> temporarily for the
|
|
|
|
+duration of <VAR>statement</VAR>. To parse this construct, we must put
|
|
|
|
+<VAR>variable</VAR> into the symbol table while <VAR>statement</VAR> is parsed, then
|
|
|
|
+remove it afterward. Here is how it is done:
|
|
|
|
+<PRE>
|
|
|
|
+stmt: LET '(' var ')'
|
|
|
|
+ { $<context>$ = push_context ();
|
|
|
|
+ declare_variable ($3); }
|
|
|
|
+ stmt { $$ = $6;
|
|
|
|
+ pop_context ($<context>5); }
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+As soon as <SAMP>`let (<VAR>variable</VAR>)'</SAMP> has been recognized, the first
|
|
|
|
+action is run. It saves a copy of the current semantic context (the
|
|
|
|
+list of accessible variables) as its semantic value, using alternative
|
|
|
|
+<CODE>context</CODE> in the data-type union. Then it calls
|
|
|
|
+<CODE>declare_variable</CODE> to add the new variable to that list. Once the
|
|
|
|
+first action is finished, the embedded statement <CODE>stmt</CODE> can be
|
|
|
|
+parsed. Note that the mid-rule action is component number 5, so the
|
|
|
|
+<SAMP>`stmt'</SAMP> is component number 6.
|
|
|
|
+After the embedded statement is parsed, its semantic value becomes the
|
|
|
|
+value of the entire <CODE>let</CODE>-statement. Then the semantic value from the
|
|
|
|
+earlier action is used to restore the prior list of variables. This
|
|
|
|
+removes the temporary <CODE>let</CODE>-variable from the list so that it won't
|
|
|
|
+appear to exist while the rest of the program is parsed.
|
|
|
|
+Taking action before a rule is completely recognized often leads to
|
|
|
|
+conflicts since the parser must commit to a parse in order to execute the
|
|
|
|
+action. For example, the following two rules, without mid-rule actions,
|
|
|
|
+can coexist in a working parser because the parser can shift the open-brace
|
|
|
|
+token and look at what follows before deciding whether there is a
|
|
|
|
+declaration or not:
|
|
|
|
+<PRE>
|
|
|
|
+compound: '{' declarations statements '}'
|
|
|
|
+ | '{' statements '}'
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+But when we add a mid-rule action as follows, the rules become nonfunctional:
|
|
|
|
+<PRE>
|
|
|
|
+compound: { prepare_for_local_variables (); }
|
|
|
|
+ '{' declarations statements '}'
|
|
|
|
+ | '{' statements '}'
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Now the parser is forced to decide whether to run the mid-rule action
|
|
|
|
+when it has read no farther than the open-brace. In other words, it
|
|
|
|
+must commit to using one rule or the other, without sufficient
|
|
|
|
+information to do it correctly. (The open-brace token is what is called
|
|
|
|
+the <EM>look-ahead</EM> token at this time, since the parser is still
|
|
|
|
+deciding what to do about it. See section <A HREF="bison.html#SEC69">Look-Ahead Tokens</A>.)
|
|
|
|
+You might think that you could correct the problem by putting identical
|
|
|
|
+actions into the two rules, like this:
|
|
|
|
+<PRE>
|
|
|
|
+compound: { prepare_for_local_variables (); }
|
|
|
|
+ '{' declarations statements '}'
|
|
|
|
+ | { prepare_for_local_variables (); }
|
|
|
|
+ '{' statements '}'
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+But this does not help, because Bison does not realize that the two actions
|
|
|
|
+are identical. (Bison never tries to understand the C code in an action.)
|
|
|
|
+If the grammar is such that a declaration can be distinguished from a
|
|
|
|
+statement by the first token (which is true in C), then one solution which
|
|
|
|
+does work is to put the action after the open-brace, like this:
|
|
|
|
+<PRE>
|
|
|
|
+compound: '{' { prepare_for_local_variables (); }
|
|
|
|
+ declarations statements '}'
|
|
|
|
+ | '{' statements '}'
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Now the first token of the following declaration or statement,
|
|
|
|
+which would in any case tell Bison which rule to use, can still do so.
|
|
|
|
+Another solution is to bury the action inside a nonterminal symbol which
|
|
|
|
+serves as a subroutine:
|
|
|
|
+<PRE>
|
|
|
|
+subroutine: /* empty */
|
|
|
|
+ { prepare_for_local_variables (); }
|
|
|
|
+ ;
|
|
|
|
+compound: subroutine
|
|
|
|
+ '{' declarations statements '}'
|
|
|
|
+ | subroutine
|
|
|
|
+ '{' statements '}'
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Now Bison can execute the action in the rule for <CODE>subroutine</CODE> without
|
|
|
|
+deciding which rule for <CODE>compound</CODE> it will eventually use. Note that
|
|
|
|
+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.
|
|
|
|
+<H2><A NAME="SEC49" HREF="bison.html#TOC49">Bison Declarations</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX87"></A>
|
|
|
|
+<A NAME="IDX88"></A>
|
|
|
|
+The <EM>Bison declarations</EM> section of a Bison grammar defines the symbols
|
|
|
|
+used in formulating the grammar and the data types of semantic values.
|
|
|
|
+See section <A HREF="bison.html#SEC40">Symbols, Terminal and Nonterminal</A>.
|
|
|
|
+All token type names (but not single-character literal tokens such as
|
|
|
|
+<CODE>'+'</CODE> and <CODE>'*'</CODE>) must be declared. Nonterminal symbols must be
|
|
|
|
+declared if you need to specify which data type to use for the semantic
|
|
|
|
+value (see section <A HREF="bison.html#SEC45">More Than One Value Type</A>).
|
|
|
|
+The first rule in the file also specifies the start symbol, by default.
|
|
|
|
+If you want some other symbol to be the start symbol, you must declare
|
|
|
|
+it explicitly (see section <A HREF="bison.html#SEC8">Languages and Context-Free Grammars</A>).
|
|
|
|
+<H3><A NAME="SEC50" HREF="bison.html#TOC50">Token Type Names</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX89"></A>
|
|
|
|
+<A NAME="IDX90"></A>
|
|
|
|
+<A NAME="IDX91"></A>
|
|
|
|
+The basic way to declare a token type name (terminal symbol) is as follows:
|
|
|
|
+<PRE>
|
|
|
|
+%token <VAR>name</VAR>
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Bison will convert this into a <CODE>#define</CODE> directive in
|
|
|
|
+the parser, so that the function <CODE>yylex</CODE> (if it is in this file)
|
|
|
|
+can use the name <VAR>name</VAR> to stand for this token type's code.
|
|
|
|
+Alternatively, you can use <CODE>%left</CODE>, <CODE>%right</CODE>, or <CODE>%nonassoc</CODE>
|
|
|
|
+instead of <CODE>%token</CODE>, if you wish to specify precedence.
|
|
|
|
+See section <A HREF="bison.html#SEC51">Operator Precedence</A>.
|
|
|
|
+You can explicitly specify the numeric code for a token type by appending
|
|
|
|
+an integer value in the field immediately following the token name:
|
|
|
|
+<PRE>
|
|
|
|
+%token NUM 300
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+It is generally best, however, to let Bison choose the numeric codes for
|
|
|
|
+all token types. Bison will automatically select codes that don't conflict
|
|
|
|
+with each other or with ASCII characters.
|
|
|
|
+In the event that the stack type is a union, you must augment the
|
|
|
|
+<CODE>%token</CODE> or other token declaration to include the data type
|
|
|
|
+alternative delimited by angle-brackets (see section <A HREF="bison.html#SEC45">More Than One Value Type</A>).
|
|
|
|
+For example:
|
|
|
|
+<PRE>
|
|
|
|
+%union { /* define stack type */
|
|
|
|
+ double val;
|
|
|
|
+ symrec *tptr;
|
|
|
|
+}
|
|
|
|
+%token <val> NUM /* define token NUM and its type */
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC51" HREF="bison.html#TOC51">Operator Precedence</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX92"></A>
|
|
|
|
+<A NAME="IDX93"></A>
|
|
|
|
+<A NAME="IDX94"></A>
|
|
|
|
+Use the <CODE>%left</CODE>, <CODE>%right</CODE> or <CODE>%nonassoc</CODE> declaration to
|
|
|
|
+declare a token and specify its precedence and associativity, all at
|
|
|
|
+once. These are called <EM>precedence declarations</EM>.
|
|
|
|
+See section <A HREF="bison.html#SEC71">Operator Precedence</A>, for general information on operator precedence.
|
|
|
|
+The syntax of a precedence declaration is the same as that of
|
|
|
|
+<CODE>%token</CODE>: either
|
|
|
|
+<PRE>
|
|
|
|
+%left <VAR>symbols</VAR>...
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+or
|
|
|
|
+<PRE>
|
|
|
|
+%left <<VAR>type</VAR>> <VAR>symbols</VAR>...
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+And indeed any of these declarations serves the purposes of <CODE>%token</CODE>.
|
|
|
|
+But in addition, they specify the associativity and relative precedence for
|
|
|
|
+all the <VAR>symbols</VAR>:
|
|
|
|
+<UL>
|
|
|
|
+<LI>
|
|
|
|
+The associativity of an operator <VAR>op</VAR> determines how repeated uses
|
|
|
|
+of the operator nest: whether <SAMP>`<VAR>x</VAR> <VAR>op</VAR> <VAR>y</VAR> <VAR>op</VAR>
|
|
|
|
+<VAR>z</VAR>'</SAMP> is parsed by grouping <VAR>x</VAR> with <VAR>y</VAR> first or by
|
|
|
|
+grouping <VAR>y</VAR> with <VAR>z</VAR> first. <CODE>%left</CODE> specifies
|
|
|
|
+left-associativity (grouping <VAR>x</VAR> with <VAR>y</VAR> first) and
|
|
|
|
+<CODE>%right</CODE> specifies right-associativity (grouping <VAR>y</VAR> with
|
|
|
|
+<VAR>z</VAR> first). <CODE>%nonassoc</CODE> specifies no associativity, which
|
|
|
|
+means that <SAMP>`<VAR>x</VAR> <VAR>op</VAR> <VAR>y</VAR> <VAR>op</VAR> <VAR>z</VAR>'</SAMP> is
|
|
|
|
+considered a syntax error.
|
|
|
|
+<LI>
|
|
|
|
+The precedence of an operator determines how it nests with other operators.
|
|
|
|
+All the tokens declared in a single precedence declaration have equal
|
|
|
|
+precedence and nest together according to their associativity.
|
|
|
|
+When two tokens declared in different precedence declarations associate,
|
|
|
|
+the one declared later has the higher precedence and is grouped first.
|
|
|
|
+</UL>
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC52" HREF="bison.html#TOC52">The Collection of Value Types</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX95"></A>
|
|
|
|
+<A NAME="IDX96"></A>
|
|
|
|
+<A NAME="IDX97"></A>
|
|
|
|
+The <CODE>%union</CODE> declaration specifies the entire collection of possible
|
|
|
|
+data types for semantic values. The keyword <CODE>%union</CODE> is followed by a
|
|
|
|
+pair of braces containing the same thing that goes inside a <CODE>union</CODE> in
|
|
|
|
+C.
|
|
|
|
+For example:
|
|
|
|
+<PRE>
|
|
|
|
+%union {
|
|
|
|
+ double val;
|
|
|
|
+ symrec *tptr;
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+This says that the two alternative types are <CODE>double</CODE> and <CODE>symrec
|
|
|
|
+*</CODE>. They are given names <CODE>val</CODE> and <CODE>tptr</CODE>; these names are used
|
|
|
|
+in the <CODE>%token</CODE> and <CODE>%type</CODE> declarations to pick one of the types
|
|
|
|
+for a terminal or nonterminal symbol (see section <A HREF="bison.html#SEC53">Nonterminal Symbols</A>).
|
|
|
|
+Note that, unlike making a <CODE>union</CODE> declaration in C, you do not write
|
|
|
|
+a semicolon after the closing brace.
|
|
|
|
+<H3><A NAME="SEC53" HREF="bison.html#TOC53">Nonterminal Symbols</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX98"></A>
|
|
|
|
+<A NAME="IDX99"></A>
|
|
|
|
+<A NAME="IDX100"></A>
|
|
|
|
+When you use <CODE>%union</CODE> to specify multiple value types, you must
|
|
|
|
+declare the value type of each nonterminal symbol for which values are
|
|
|
|
+used. This is done with a <CODE>%type</CODE> declaration, like this:
|
|
|
|
+<PRE>
|
|
|
|
+%type <<VAR>type</VAR>> <VAR>nonterminal</VAR>...
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Here <VAR>nonterminal</VAR> is the name of a nonterminal symbol, and <VAR>type</VAR>
|
|
|
|
+is the name given in the <CODE>%union</CODE> to the alternative that you want
|
|
|
|
+(see section <A HREF="bison.html#SEC52">The Collection of Value Types</A>). You can give any number of nonterminal symbols in
|
|
|
|
+the same <CODE>%type</CODE> declaration, if they have the same value type. Use
|
|
|
|
+spaces to separate the symbol names.
|
|
|
|
+<H3><A NAME="SEC54" HREF="bison.html#TOC54">Suppressing Conflict Warnings</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX101"></A>
|
|
|
|
+<A NAME="IDX102"></A>
|
|
|
|
+<A NAME="IDX103"></A>
|
|
|
|
+<A NAME="IDX104"></A>
|
|
|
|
+<A NAME="IDX105"></A>
|
|
|
|
+Bison normally warns if there are any conflicts in the grammar
|
|
|
|
+(see section <A HREF="bison.html#SEC70">Shift/Reduce Conflicts</A>), but most real grammars have harmless shift/reduce
|
|
|
|
+conflicts which are resolved in a predictable way and would be difficult to
|
|
|
|
+eliminate. It is desirable to suppress the warning about these conflicts
|
|
|
|
+unless the number of conflicts changes. You can do this with the
|
|
|
|
+<CODE>%expect</CODE> declaration.
|
|
|
|
+The declaration looks like this:
|
|
|
|
+<PRE>
|
|
|
|
+%expect <VAR>n</VAR>
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Here <VAR>n</VAR> is a decimal integer. The declaration says there should be no
|
|
|
|
+warning if there are <VAR>n</VAR> shift/reduce conflicts and no reduce/reduce
|
|
|
|
+conflicts. The usual warning is given if there are either more or fewer
|
|
|
|
+conflicts, or if there are any reduce/reduce conflicts.
|
|
|
|
+In general, using <CODE>%expect</CODE> involves these steps:
|
|
|
|
+<UL>
|
|
|
|
+<LI>
|
|
|
|
+Compile your grammar without <CODE>%expect</CODE>. Use the <SAMP>`-v'</SAMP> option
|
|
|
|
+to get a verbose list of where the conflicts occur. Bison will also
|
|
|
|
+print the number of conflicts.
|
|
|
|
+<LI>
|
|
|
|
+Check each of the conflicts to make sure that Bison's default
|
|
|
|
+resolution is what you really want. If not, rewrite the grammar and
|
|
|
|
+go back to the beginning.
|
|
|
|
+<LI>
|
|
|
|
+Add an <CODE>%expect</CODE> declaration, copying the number <VAR>n</VAR> from the
|
|
|
|
+number which Bison printed.
|
|
|
|
+</UL>
|
|
|
|
+<P>
|
|
|
|
+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.
|
|
|
|
+<H3><A NAME="SEC55" HREF="bison.html#TOC55">The Start-Symbol</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX106"></A>
|
|
|
|
+<A NAME="IDX107"></A>
|
|
|
|
+<A NAME="IDX108"></A>
|
|
|
|
+<A NAME="IDX109"></A>
|
|
|
|
+Bison assumes by default that the start symbol for the grammar is the first
|
|
|
|
+nonterminal specified in the grammar specification section. The programmer
|
|
|
|
+may override this restriction with the <CODE>%start</CODE> declaration as follows:
|
|
|
|
+<PRE>
|
|
|
|
+%start <VAR>symbol</VAR>
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC56" HREF="bison.html#TOC56">A Pure (Reentrant) Parser</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX110"></A>
|
|
|
|
+<A NAME="IDX111"></A>
|
|
|
|
+<A NAME="IDX112"></A>
|
|
|
|
+A <EM>reentrant</EM> program is one which does not alter in the course of
|
|
|
|
+execution; in other words, it consists entirely of <EM>pure</EM> (read-only)
|
|
|
|
+code. Reentrancy is important whenever asynchronous execution is possible;
|
|
|
|
+for example, a nonreentrant program may not be safe to call from a signal
|
|
|
|
+handler. In systems with multiple threads of control, a nonreentrant
|
|
|
|
+program must be called only within interlocks.
|
|
|
|
+The Bison parser is not normally a reentrant program, because it uses
|
|
|
|
+statically allocated variables for communication with <CODE>yylex</CODE>. These
|
|
|
|
+variables include <CODE>yylval</CODE> and <CODE>yylloc</CODE>.
|
|
|
|
+The Bison declaration <CODE>%pure_parser</CODE> says that you want the parser
|
|
|
|
+to be reentrant. It looks like this:
|
|
|
|
+<PRE>
|
|
|
|
+%pure_parser
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The effect is that the two communication variables become local
|
|
|
|
+variables in <CODE>yyparse</CODE>, and a different calling convention is used
|
|
|
|
+for the lexical analyzer function <CODE>yylex</CODE>. See section <A HREF="bison.html#SEC65">Calling Conventions for Pure Parsers</A>, for the details of this. The
|
|
|
|
+variable <CODE>yynerrs</CODE> also becomes local in <CODE>yyparse</CODE>
|
|
|
|
+(see section <A HREF="bison.html#SEC66">The Error Reporting Function <CODE>yyerror</CODE></A>).
|
|
|
|
+The convention for calling <CODE>yyparse</CODE> itself is unchanged.
|
|
|
|
+<H3><A NAME="SEC57" HREF="bison.html#TOC57">Bison Declaration Summary</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX113"></A>
|
|
|
|
+<A NAME="IDX114"></A>
|
|
|
|
+<A NAME="IDX115"></A>
|
|
|
|
+Here is a summary of all Bison declarations:
|
|
|
|
+<DL COMPACT>
|
|
|
|
+<DT><CODE>%union</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Declare the collection of data types that semantic values may have
|
|
|
|
+(see section <A HREF="bison.html#SEC52">The Collection of Value Types</A>).
|
|
|
|
+<DT><CODE>%token</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Declare a terminal symbol (token type name) with no precedence
|
|
|
|
+or associativity specified (see section <A HREF="bison.html#SEC50">Token Type Names</A>).
|
|
|
|
+<DT><CODE>%right</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Declare a terminal symbol (token type name) that is right-associative
|
|
|
|
+(see section <A HREF="bison.html#SEC51">Operator Precedence</A>).
|
|
|
|
+<DT><CODE>%left</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Declare a terminal symbol (token type name) that is left-associative
|
|
|
|
+(see section <A HREF="bison.html#SEC51">Operator Precedence</A>).
|
|
|
|
+<DT><CODE>%nonassoc</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Declare a terminal symbol (token type name) that is nonassociative
|
|
|
|
+(using it in a way that would be associative is a syntax error)
|
|
|
|
+(see section <A HREF="bison.html#SEC51">Operator Precedence</A>).
|
|
|
|
+<DT><CODE>%type</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Declare the type of semantic values for a nonterminal symbol
|
|
|
|
+(see section <A HREF="bison.html#SEC53">Nonterminal Symbols</A>).
|
|
|
|
+<DT><CODE>%start</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Specify the grammar's start symbol (see section <A HREF="bison.html#SEC55">The Start-Symbol</A>).
|
|
|
|
+<DT><CODE>%expect</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Declare the expected number of shift-reduce conflicts
|
|
|
|
+(see section <A HREF="bison.html#SEC54">Suppressing Conflict Warnings</A>).
|
|
|
|
+<DT><CODE>%pure_parser</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Request a pure (reentrant) parser program (see section <A HREF="bison.html#SEC56">A Pure (Reentrant) Parser</A>).
|
|
|
|
+</DL>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC58" HREF="bison.html#TOC58">Multiple Parsers in the Same Program</A></H2>
|
|
|
|
+<P>
|
|
|
|
+Most programs that use Bison parse only one language and therefore contain
|
|
|
|
+only one Bison parser. But what if you want to parse more than one
|
|
|
|
+language with the same program? Then you need to avoid a name conflict
|
|
|
|
+between different definitions of <CODE>yyparse</CODE>, <CODE>yylval</CODE>, and so on.
|
|
|
|
+The easy way to do this is to use the option <SAMP>`-p <VAR>prefix</VAR>'</SAMP>
|
|
|
|
+(see section <A HREF="bison.html#SEC87">Invoking Bison</A>). This renames the interface functions and
|
|
|
|
+variables of the Bison parser to start with <VAR>prefix</VAR> instead of
|
|
|
|
+<SAMP>`yy'</SAMP>. You can use this to give each parser distinct names that do
|
|
|
|
+not conflict.
|
|
|
|
+The precise list of symbols renamed is <CODE>yyparse</CODE>, <CODE>yylex</CODE>,
|
|
|
|
+<CODE>yyerror</CODE>, <CODE>yynerrs</CODE>, <CODE>yylval</CODE>, <CODE>yychar</CODE> and
|
|
|
|
+<CODE>yydebug</CODE>. For example, if you use <SAMP>`-p c'</SAMP>, the names become
|
|
|
|
+<CODE>cparse</CODE>, <CODE>clex</CODE>, and so on.
|
|
|
|
+<STRONG>All the other variables and macros associated with Bison are not
|
|
|
|
+renamed.</STRONG> These others are not global; there is no conflict if the same
|
|
|
|
+name is used in different parsers. For example, <CODE>YYSTYPE</CODE> is not
|
|
|
|
+renamed, but defining this in different ways in different parsers causes
|
|
|
|
+no trouble (see section <A HREF="bison.html#SEC44">Data Types of Semantic Values</A>).
|
|
|
|
+The <SAMP>`-p'</SAMP> option works by adding macro definitions to the beginning
|
|
|
|
+of the parser source file, defining <CODE>yyparse</CODE> as
|
|
|
|
+<CODE><VAR>prefix</VAR>parse</CODE>, and so on. This effectively substitutes one
|
|
|
|
+name for the other in the entire parser file.
|
|
|
|
+<H1><A NAME="SEC59" HREF="bison.html#TOC59">Parser C-Language Interface</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX116"></A>
|
|
|
|
+<A NAME="IDX117"></A>
|
|
|
|
+The Bison parser is actually a C function named <CODE>yyparse</CODE>. Here we
|
|
|
|
+describe the interface conventions of <CODE>yyparse</CODE> and the other
|
|
|
|
+functions that it needs to use.
|
|
|
|
+Keep in mind that the parser uses many C identifiers starting with
|
|
|
|
+<SAMP>`yy'</SAMP> and <SAMP>`YY'</SAMP> 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.
|
|
|
|
+<H2><A NAME="SEC60" HREF="bison.html#TOC60">The Parser Function <CODE>yyparse</CODE></A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX118"></A>
|
|
|
|
+You call the function <CODE>yyparse</CODE> to cause parsing to occur. This
|
|
|
|
+function reads tokens, executes actions, and ultimately returns when it
|
|
|
|
+encounters end-of-input or an unrecoverable syntax error. You can also
|
|
|
|
+write an action which directs <CODE>yyparse</CODE> to return immediately without
|
|
|
|
+reading further.
|
|
|
|
+The value returned by <CODE>yyparse</CODE> is 0 if parsing was successful (return
|
|
|
|
+is due to end-of-input).
|
|
|
|
+The value is 1 if parsing failed (return is due to a syntax error).
|
|
|
|
+In an action, you can cause immediate return from <CODE>yyparse</CODE> by using
|
|
|
|
+these macros:
|
|
|
|
+<DL COMPACT>
|
|
|
|
+<DT><CODE>YYACCEPT</CODE>
|
|
|
|
+<DD>
|
|
|
|
+<A NAME="IDX119"></A>
|
|
|
|
+Return immediately with value 0 (to report success).
|
|
|
|
+<DT><CODE>YYABORT</CODE>
|
|
|
|
+<DD>
|
|
|
|
+<A NAME="IDX120"></A>
|
|
|
|
+Return immediately with value 1 (to report failure).
|
|
|
|
+</DL>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC61" HREF="bison.html#TOC61">The Lexical Analyzer Function <CODE>yylex</CODE></A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX121"></A>
|
|
|
|
+<A NAME="IDX122"></A>
|
|
|
|
+The <EM>lexical analyzer</EM> function, <CODE>yylex</CODE>, recognizes tokens from
|
|
|
|
+the input stream and returns them to the parser. Bison does not create
|
|
|
|
+this function automatically; you must write it so that <CODE>yyparse</CODE> can
|
|
|
|
+call it. The function is sometimes referred to as a lexical scanner.
|
|
|
|
+In simple programs, <CODE>yylex</CODE> is often defined at the end of the Bison
|
|
|
|
+grammar file. If <CODE>yylex</CODE> is defined in a separate source file, you
|
|
|
|
+need to arrange for the token-type macro definitions to be available there.
|
|
|
|
+To do this, use the <SAMP>`-d'</SAMP> option when you run Bison, so that it will
|
|
|
|
+write these macro definitions into a separate header file
|
|
|
|
+<TT>`<VAR>name</VAR>.tab.h'</TT> which you can include in the other source files
|
|
|
|
+that need it. See section <A HREF="bison.html#SEC87">Invoking Bison</A>.
|
|
|
|
+<H3><A NAME="SEC62" HREF="bison.html#TOC62">Calling Convention for <CODE>yylex</CODE></A></H3>
|
|
|
|
+<P>
|
|
|
|
+The value that <CODE>yylex</CODE> returns must be the numeric code for the type
|
|
|
|
+of token it has just found, or 0 for end-of-input.
|
|
|
|
+When a token is referred to in the grammar rules by a name, that name
|
|
|
|
+in the parser file becomes a C macro whose definition is the proper
|
|
|
|
+numeric code for that token type. So <CODE>yylex</CODE> can use the name
|
|
|
|
+to indicate that type. See section <A HREF="bison.html#SEC40">Symbols, Terminal and Nonterminal</A>.
|
|
|
|
+When a token is referred to in the grammar rules by a character literal,
|
|
|
|
+the numeric code for that character is also the code for the token type.
|
|
|
|
+So <CODE>yylex</CODE> can simply return that character code. The null character
|
|
|
|
+must not be used this way, because its code is zero and that is what
|
|
|
|
+signifies end-of-input.
|
|
|
|
+Here is an example showing these things:
|
|
|
|
+<PRE>
|
|
|
|
+yylex ()
|
|
|
|
+{
|
|
|
|
+ ...
|
|
|
|
+ if (c == EOF) /* Detect end of file. */
|
|
|
|
+ return 0;
|
|
|
|
+ ...
|
|
|
|
+ if (c == '+' || c == '-')
|
|
|
|
+ return c; /* Assume token type for `+' is '+'. */
|
|
|
|
+ ...
|
|
|
|
+ return INT; /* Return the type of the token. */
|
|
|
|
+ ...
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+This interface has been designed so that the output from the <CODE>lex</CODE>
|
|
|
|
+utility can be used without change as the definition of <CODE>yylex</CODE>.
|
|
|
|
+<H3><A NAME="SEC63" HREF="bison.html#TOC63">Semantic Values of Tokens</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX123"></A>
|
|
|
|
+In an ordinary (nonreentrant) parser, the semantic value of the token must
|
|
|
|
+be stored into the global variable <CODE>yylval</CODE>. When you are using
|
|
|
|
+just one data type for semantic values, <CODE>yylval</CODE> has that type.
|
|
|
|
+Thus, if the type is <CODE>int</CODE> (the default), you might write this in
|
|
|
|
+<CODE>yylex</CODE>:
|
|
|
|
+<PRE>
|
|
|
|
+ ...
|
|
|
|
+ yylval = value; /* Put value onto Bison stack. */
|
|
|
|
+ return INT; /* Return the type of the token. */
|
|
|
|
+ ...
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+When you are using multiple data types, <CODE>yylval</CODE>'s type is a union
|
|
|
|
+made from the <CODE>%union</CODE> declaration (see section <A HREF="bison.html#SEC52">The Collection of Value Types</A>). So when
|
|
|
|
+you store a token's value, you must use the proper member of the union.
|
|
|
|
+If the <CODE>%union</CODE> declaration looks like this:
|
|
|
|
+<PRE>
|
|
|
|
+%union {
|
|
|
|
+ int intval;
|
|
|
|
+ double val;
|
|
|
|
+ symrec *tptr;
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+then the code in <CODE>yylex</CODE> might look like this:
|
|
|
|
+<PRE>
|
|
|
|
+ ...
|
|
|
|
+ yylval.intval = value; /* Put value onto Bison stack. */
|
|
|
|
+ return INT; /* Return the type of the token. */
|
|
|
|
+ ...
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H3><A NAME="SEC64" HREF="bison.html#TOC64">Textual Positions of Tokens</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX124"></A>
|
|
|
|
+If you are using the <SAMP>`@<VAR>n</VAR>'</SAMP>-feature (see section <A HREF="bison.html#SEC67">Special Features for Use in Actions</A>) in
|
|
|
|
+actions to keep track of the textual locations of tokens and groupings,
|
|
|
|
+then you must provide this information in <CODE>yylex</CODE>. The function
|
|
|
|
+<CODE>yyparse</CODE> expects to find the textual location of a token just parsed
|
|
|
|
+in the global variable <CODE>yylloc</CODE>. So <CODE>yylex</CODE> must store the
|
|
|
|
+proper data in that variable. The value of <CODE>yylloc</CODE> is a structure
|
|
|
|
+and you need only initialize the members that are going to be used by the
|
|
|
|
+actions. The four members are called <CODE>first_line</CODE>,
|
|
|
|
+<CODE>first_column</CODE>, <CODE>last_line</CODE> and <CODE>last_column</CODE>. Note that
|
|
|
|
+the use of this feature makes the parser noticeably slower.
|
|
|
|
+<A NAME="IDX125"></A>
|
|
|
|
+The data type of <CODE>yylloc</CODE> has the name <CODE>YYLTYPE</CODE>.
|
|
|
|
+<H3><A NAME="SEC65" HREF="bison.html#TOC65">Calling Conventions for Pure Parsers</A></H3>
|
|
|
|
+<P>
|
|
|
|
+When you use the Bison declaration <CODE>%pure_parser</CODE> to request a
|
|
|
|
+pure, reentrant parser, the global communication variables <CODE>yylval</CODE>
|
|
|
|
+and <CODE>yylloc</CODE> cannot be used. (See section <A HREF="bison.html#SEC56">A Pure (Reentrant) Parser</A>.) In such parsers the two global variables are replaced by
|
|
|
|
+pointers passed as arguments to <CODE>yylex</CODE>. You must declare them as
|
|
|
|
+shown here, and pass the information back by storing it through those
|
|
|
|
+pointers.
|
|
|
|
+<PRE>
|
|
|
|
+yylex (lvalp, llocp)
|
|
|
|
+ YYSTYPE *lvalp;
|
|
|
|
+ YYLTYPE *llocp;
|
|
|
|
+{
|
|
|
|
+ ...
|
|
|
|
+ *lvalp = value; /* Put value onto Bison stack. */
|
|
|
|
+ return INT; /* Return the type of the token. */
|
|
|
|
+ ...
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+If the grammar file does not use the <SAMP>`@'</SAMP> constructs to refer to
|
|
|
|
+textual positions, then the type <CODE>YYLTYPE</CODE> will not be defined. In
|
|
|
|
+this case, omit the second argument; <CODE>yylex</CODE> will be called with
|
|
|
|
+only one argument.
|
|
|
|
+<A NAME="IDX126"></A>
|
|
|
|
+You can pass parameter information to a reentrant parser in a reentrant
|
|
|
|
+way. Define the macro <CODE>YYPARSE_PARAM</CODE> as a variable name. The
|
|
|
|
+resulting <CODE>yyparse</CODE> function then accepts one argument, of type
|
|
|
|
+<CODE>void *</CODE>, with that name.
|
|
|
|
+When you call <CODE>yyparse</CODE>, pass the address of an object, casting the
|
|
|
|
+address to <CODE>void *</CODE>. The grammar actions can refer to the contents
|
|
|
|
+of the object by casting the pointer value back to its proper type and
|
|
|
|
+then dereferencing it. Here's an example. Write this in the parser:
|
|
|
|
+<PRE>
|
|
|
|
+%{
|
|
|
|
+struct parser_control
|
|
|
|
+{
|
|
|
|
+ int nastiness;
|
|
|
|
+ int randomness;
|
|
|
|
+};
|
|
|
|
+#define YYPARSE_PARAM parm
|
|
|
|
+%}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Then call the parser like this:
|
|
|
|
+<PRE>
|
|
|
|
+struct parser_control
|
|
|
|
+{
|
|
|
|
+ int nastiness;
|
|
|
|
+ int randomness;
|
|
|
|
+};
|
|
|
|
+...
|
|
|
|
+{
|
|
|
|
+ struct parser_control foo;
|
|
|
|
+ ... /* Store proper data in <CODE>foo</CODE>. */
|
|
|
|
+ value = yyparse ((void *) &foo);
|
|
|
|
+ ...
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+In the grammar actions, use expressions like this to refer to the data:
|
|
|
|
+<PRE>
|
|
|
|
+((struct parser_control *) parm)->randomness
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX127"></A>
|
|
|
|
+If you wish to pass the additional parameter data to <CODE>yylex</CODE>,
|
|
|
|
+define the macro <CODE>YYLEX_PARAM</CODE> just like <CODE>YYPARSE_PARAM</CODE>, as
|
|
|
|
+shown here:
|
|
|
|
+<PRE>
|
|
|
|
+%{
|
|
|
|
+struct parser_control
|
|
|
|
+{
|
|
|
|
+ int nastiness;
|
|
|
|
+ int randomness;
|
|
|
|
+};
|
|
|
|
+#define YYPARSE_PARAM parm
|
|
|
|
+#define YYLEX_PARAM parm
|
|
|
|
+%}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+You should then define <CODE>yylex</CODE> to accept one additional
|
|
|
|
+argument--the value of <CODE>parm</CODE>. (This makes either two or three
|
|
|
|
+arguments in total, depending on whether an argument of type
|
|
|
|
+<CODE>YYLTYPE</CODE> is passed.) You can declare the argument as a pointer to
|
|
|
|
+the proper object type, or you can declare it as <CODE>void *</CODE> and
|
|
|
|
+access the contents as shown above.
|
|
|
|
+<H2><A NAME="SEC66" HREF="bison.html#TOC66">The Error Reporting Function <CODE>yyerror</CODE></A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX128"></A>
|
|
|
|
+<A NAME="IDX129"></A>
|
|
|
|
+<A NAME="IDX130"></A>
|
|
|
|
+<A NAME="IDX131"></A>
|
|
|
|
+The Bison parser detects a <EM>parse error</EM> or <EM>syntax error</EM>
|
|
|
|
+whenever it reads a token which cannot satisfy any syntax rule. A
|
|
|
|
+action in the grammar can also explicitly proclaim an error, using the
|
|
|
|
+macro <CODE>YYERROR</CODE> (see section <A HREF="bison.html#SEC67">Special Features for Use in Actions</A>).
|
|
|
|
+The Bison parser expects to report the error by calling an error
|
|
|
|
+reporting function named <CODE>yyerror</CODE>, which you must supply. It is
|
|
|
|
+called by <CODE>yyparse</CODE> whenever a syntax error is found, and it
|
|
|
|
+receives one argument. For a parse error, the string is normally
|
|
|
|
+<CODE>"parse error"</CODE>.
|
|
|
|
+<A NAME="IDX132"></A>
|
|
|
|
+If you define the macro <CODE>YYERROR_VERBOSE</CODE> in the Bison declarations
|
|
|
|
+section (see section <A HREF="bison.html#SEC37">The Bison Declarations Section</A>), then Bison provides a more verbose
|
|
|
|
+and specific error message string instead of just plain <CODE>"parse
|
|
|
|
+error"</CODE>. It doesn't matter what definition you use for
|
|
|
|
+<CODE>YYERROR_VERBOSE</CODE>, just whether you define it.
|
|
|
|
+The parser can detect one other kind of error: stack overflow. This
|
|
|
|
+happens when the input contains constructions that are very deeply
|
|
|
|
+nested. It isn't likely you will encounter this, since the Bison
|
|
|
|
+parser extends its stack automatically up to a very large limit. But
|
|
|
|
+if overflow happens, <CODE>yyparse</CODE> calls <CODE>yyerror</CODE> in the usual
|
|
|
|
+fashion, except that the argument string is <CODE>"parser stack
|
|
|
|
+overflow"</CODE>.
|
|
|
|
+The following definition suffices in simple programs:
|
|
|
|
+<PRE>
|
|
|
|
+yyerror (s)
|
|
|
|
+ char *s;
|
|
|
|
+{
|
|
|
|
+ fprintf (stderr, "%s\n", s);
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+After <CODE>yyerror</CODE> returns to <CODE>yyparse</CODE>, the latter will attempt
|
|
|
|
+error recovery if you have written suitable error recovery grammar rules
|
|
|
|
+(see section <A HREF="bison.html#SEC81">Error Recovery</A>). If recovery is impossible, <CODE>yyparse</CODE> will
|
|
|
|
+immediately return 1.
|
|
|
|
+<A NAME="IDX133"></A>
|
|
|
|
+The variable <CODE>yynerrs</CODE> contains the number of syntax errors
|
|
|
|
+encountered so far. Normally this variable is global; but if you
|
|
|
|
+request a pure parser (see section <A HREF="bison.html#SEC56">A Pure (Reentrant) Parser</A>) then it is a local variable
|
|
|
|
+which only the actions can access.
|
|
|
|
+<H2><A NAME="SEC67" HREF="bison.html#TOC67">Special Features for Use in Actions</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX134"></A>
|
|
|
|
+<A NAME="IDX135"></A>
|
|
|
|
+Here is a table of Bison constructs, variables and macros that
|
|
|
|
+are useful in actions.
|
|
|
|
+<DL COMPACT>
|
|
|
|
+<DT><SAMP>`$$'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Acts like a variable that contains the semantic value for the
|
|
|
|
+grouping made by the current rule. See section <A HREF="bison.html#SEC46">Actions</A>.
|
|
|
|
+<DT><SAMP>`$<VAR>n</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Acts like a variable that contains the semantic value for the
|
|
|
|
+<VAR>n</VAR>th component of the current rule. See section <A HREF="bison.html#SEC46">Actions</A>.
|
|
|
|
+<DT><SAMP>`$<<VAR>typealt</VAR>>$'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Like <CODE>$$</CODE> but specifies alternative <VAR>typealt</VAR> in the union
|
|
|
|
+specified by the <CODE>%union</CODE> declaration. See section <A HREF="bison.html#SEC47">Data Types of Values in Actions</A>.
|
|
|
|
+<DT><SAMP>`$<<VAR>typealt</VAR>><VAR>n</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Like <CODE>$<VAR>n</VAR></CODE> but specifies alternative <VAR>typealt</VAR> in the
|
|
|
|
+union specified by the <CODE>%union</CODE> declaration.
|
|
|
|
+See section <A HREF="bison.html#SEC47">Data Types of Values in Actions</A>.
|
|
|
|
+<DT><SAMP>`YYABORT;'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Return immediately from <CODE>yyparse</CODE>, indicating failure.
|
|
|
|
+See section <A HREF="bison.html#SEC60">The Parser Function <CODE>yyparse</CODE></A>.
|
|
|
|
+<DT><SAMP>`YYACCEPT;'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Return immediately from <CODE>yyparse</CODE>, indicating success.
|
|
|
|
+See section <A HREF="bison.html#SEC60">The Parser Function <CODE>yyparse</CODE></A>.
|
|
|
|
+<DT><SAMP>`YYBACKUP (<VAR>token</VAR>, <VAR>value</VAR>);'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<A NAME="IDX136"></A>
|
|
|
|
+Unshift a token. This macro is allowed only for rules that reduce
|
|
|
|
+a single value, and only when there is no look-ahead token.
|
|
|
|
+It installs a look-ahead token with token type <VAR>token</VAR> and
|
|
|
|
+semantic value <VAR>value</VAR>; then it discards the value that was
|
|
|
|
+going to be reduced by this rule.
|
|
|
|
+If the macro is used when it is not valid, such as when there is
|
|
|
|
+a look-ahead token already, then it reports a syntax error with
|
|
|
|
+a message <SAMP>`cannot back up'</SAMP> and performs ordinary error
|
|
|
|
+recovery.
|
|
|
|
+In either case, the rest of the action is not executed.
|
|
|
|
+<DT><SAMP>`YYEMPTY'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<A NAME="IDX137"></A>
|
|
|
|
+Value stored in <CODE>yychar</CODE> when there is no look-ahead token.
|
|
|
|
+<DT><SAMP>`YYERROR;'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<A NAME="IDX138"></A>
|
|
|
|
+Cause an immediate syntax error. This statement initiates error
|
|
|
|
+recovery just as if the parser itself had detected an error; however, it
|
|
|
|
+does not call <CODE>yyerror</CODE>, and does not print any message. If you
|
|
|
|
+want to print an error message, call <CODE>yyerror</CODE> explicitly before
|
|
|
|
+the <SAMP>`YYERROR;'</SAMP> statement. See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT><SAMP>`YYRECOVERING'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+This macro stands for an expression that has the value 1 when the parser
|
|
|
|
+is recovering from a syntax error, and 0 the rest of the time.
|
|
|
|
+See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT><SAMP>`yychar'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Variable containing the current look-ahead token. (In a pure parser,
|
|
|
|
+this is actually a local variable within <CODE>yyparse</CODE>.) When there is
|
|
|
|
+no look-ahead token, the value <CODE>YYEMPTY</CODE> is stored in the variable.
|
|
|
|
+See section <A HREF="bison.html#SEC69">Look-Ahead Tokens</A>.
|
|
|
|
+<DT><SAMP>`yyclearin;'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Discard the current look-ahead token. This is useful primarily in
|
|
|
|
+error rules. See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT><SAMP>`yyerrok;'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Resume generating error messages immediately for subsequent syntax
|
|
|
|
+errors. This is useful primarily in error rules.
|
|
|
|
+See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT><SAMP>`@<VAR>n</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<A NAME="IDX139"></A>
|
|
|
|
+Acts like a structure variable containing information on the line
|
|
|
|
+numbers and column numbers of the <VAR>n</VAR>th component of the current
|
|
|
|
+rule. The structure has four members, like this:
|
|
|
|
+<PRE>
|
|
|
|
+struct {
|
|
|
|
+ int first_line, last_line;
|
|
|
|
+ int first_column, last_column;
|
|
|
|
+};
|
|
|
|
+</PRE>
|
|
|
|
+Thus, to get the starting line number of the third component, use
|
|
|
|
+<SAMP>`@3.first_line'</SAMP>.
|
|
|
|
+In order for the members of this structure to contain valid information,
|
|
|
|
+you must make <CODE>yylex</CODE> supply this information about each token.
|
|
|
|
+If you need only certain members, then <CODE>yylex</CODE> need only fill in
|
|
|
|
+those members.
|
|
|
|
+The use of this feature makes the parser noticeably slower.
|
|
|
|
+</DL>
|
|
|
|
+<P>
|
|
|
|
+<H1><A NAME="SEC68" HREF="bison.html#TOC68">The Bison Parser Algorithm</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX140"></A>
|
|
|
|
+<A NAME="IDX141"></A>
|
|
|
|
+<A NAME="IDX142"></A>
|
|
|
|
+<A NAME="IDX143"></A>
|
|
|
|
+<A NAME="IDX144"></A>
|
|
|
|
+<A NAME="IDX145"></A>
|
|
|
|
+As Bison reads tokens, it pushes them onto a stack along with their
|
|
|
|
+semantic values. The stack is called the <EM>parser stack</EM>. Pushing a
|
|
|
|
+token is traditionally called <EM>shifting</EM>.
|
|
|
|
+For example, suppose the infix calculator has read <SAMP>`1 + 5 *'</SAMP>, with a
|
|
|
|
+<SAMP>`3'</SAMP> to come. The stack will have four elements, one for each token
|
|
|
|
+that was shifted.
|
|
|
|
+But the stack does not always have an element for each token read. When
|
|
|
|
+the last <VAR>n</VAR> tokens and groupings shifted match the components of a
|
|
|
|
+grammar rule, they can be combined according to that rule. This is called
|
|
|
|
+<EM>reduction</EM>. Those tokens and groupings are replaced on the stack by a
|
|
|
|
+single grouping whose symbol is the result (left hand side) of that rule.
|
|
|
|
+Running the rule's action is part of the process of reduction, because this
|
|
|
|
+is what computes the semantic value of the resulting grouping.
|
|
|
|
+For example, if the infix calculator's parser stack contains this:
|
|
|
|
+<PRE>
|
|
|
|
+1 + 5 * 3
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+and the next input token is a newline character, then the last three
|
|
|
|
+elements can be reduced to 15 via the rule:
|
|
|
|
+<PRE>
|
|
|
|
+expr: expr '*' expr;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Then the stack contains just these three elements:
|
|
|
|
+<PRE>
|
|
|
|
+1 + 15
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+At this point, another reduction can be made, resulting in the single value
|
|
|
|
+16. Then the newline token can be shifted.
|
|
|
|
+The parser tries, by shifts and reductions, to reduce the entire input down
|
|
|
|
+to a single grouping whose symbol is the grammar's start-symbol
|
|
|
|
+(see section <A HREF="bison.html#SEC8">Languages and Context-Free Grammars</A>).
|
|
|
|
+This kind of parser is known in the literature as a bottom-up parser.
|
|
|
|
+<H2><A NAME="SEC69" HREF="bison.html#TOC69">Look-Ahead Tokens</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX146"></A>
|
|
|
|
+The Bison parser does <EM>not</EM> always reduce immediately as soon as the
|
|
|
|
+last <VAR>n</VAR> tokens and groupings match a rule. This is because such a
|
|
|
|
+simple strategy is inadequate to handle most languages. Instead, when a
|
|
|
|
+reduction is possible, the parser sometimes "looks ahead" at the next
|
|
|
|
+token in order to decide what to do.
|
|
|
|
+When a token is read, it is not immediately shifted; first it becomes the
|
|
|
|
+<EM>look-ahead token</EM>, which is not on the stack. Now the parser can
|
|
|
|
+perform one or more reductions of tokens and groupings on the stack, while
|
|
|
|
+the look-ahead token remains off to the side. When no more reductions
|
|
|
|
+should take place, the look-ahead token is shifted onto the stack. This
|
|
|
|
+does not mean that all possible reductions have been done; depending on the
|
|
|
|
+token type of the look-ahead token, some rules may choose to delay their
|
|
|
|
+application.
|
|
|
|
+Here is a simple case where look-ahead is needed. These three rules define
|
|
|
|
+expressions which contain binary addition operators and postfix unary
|
|
|
|
+factorial operators (<SAMP>`!'</SAMP>), and allow parentheses for grouping.
|
|
|
|
+<PRE>
|
|
|
|
+expr: term '+' expr
|
|
|
|
+ | term
|
|
|
|
+ ;
|
|
|
|
+term: '(' expr ')'
|
|
|
|
+ | term '!'
|
|
|
|
+ | NUMBER
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Suppose that the tokens <SAMP>`1 + 2'</SAMP> have been read and shifted; what
|
|
|
|
+should be done? If the following token is <SAMP>`)'</SAMP>, then the first three
|
|
|
|
+tokens must be reduced to form an <CODE>expr</CODE>. This is the only valid
|
|
|
|
+course, because shifting the <SAMP>`)'</SAMP> would produce a sequence of symbols
|
|
|
|
+<CODE>term ')'</CODE>, and no rule allows this.
|
|
|
|
+If the following token is <SAMP>`!'</SAMP>, then it must be shifted immediately so
|
|
|
|
+that <SAMP>`2 !'</SAMP> can be reduced to make a <CODE>term</CODE>. If instead the
|
|
|
|
+parser were to reduce before shifting, <SAMP>`1 + 2'</SAMP> would become an
|
|
|
|
+<CODE>expr</CODE>. It would then be impossible to shift the <SAMP>`!'</SAMP> because
|
|
|
|
+doing so would produce on the stack the sequence of symbols <CODE>expr
|
|
|
|
+'!'</CODE>. No rule allows that sequence.
|
|
|
|
+<A NAME="IDX147"></A>
|
|
|
|
+The current look-ahead token is stored in the variable <CODE>yychar</CODE>.
|
|
|
|
+See section <A HREF="bison.html#SEC67">Special Features for Use in Actions</A>.
|
|
|
|
+<H2><A NAME="SEC70" HREF="bison.html#TOC70">Shift/Reduce Conflicts</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX148"></A>
|
|
|
|
+<A NAME="IDX149"></A>
|
|
|
|
+<A NAME="IDX150"></A>
|
|
|
|
+<A NAME="IDX151"></A>
|
|
|
|
+Suppose we are parsing a language which has if-then and if-then-else
|
|
|
|
+statements, with a pair of rules like this:
|
|
|
|
+<PRE>
|
|
|
|
+if_stmt:
|
|
|
|
+ IF expr THEN stmt
|
|
|
|
+ | IF expr THEN stmt ELSE stmt
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Here we assume that <CODE>IF</CODE>, <CODE>THEN</CODE> and <CODE>ELSE</CODE> are
|
|
|
|
+terminal symbols for specific keyword tokens.
|
|
|
|
+When the <CODE>ELSE</CODE> token is read and becomes the look-ahead token, the
|
|
|
|
+contents of the stack (assuming the input is valid) are just right for
|
|
|
|
+reduction by the first rule. But it is also legitimate to shift the
|
|
|
|
+<CODE>ELSE</CODE>, because that would lead to eventual reduction by the second
|
|
|
|
+rule.
|
|
|
|
+This situation, where either a shift or a reduction would be valid, is
|
|
|
|
+called a <EM>shift/reduce conflict</EM>. Bison is designed to resolve
|
|
|
|
+these conflicts by choosing to shift, unless otherwise directed by
|
|
|
|
+operator precedence declarations. To see the reason for this, let's
|
|
|
|
+contrast it with the other alternative.
|
|
|
|
+Since the parser prefers to shift the <CODE>ELSE</CODE>, the result is to attach
|
|
|
|
+the else-clause to the innermost if-statement, making these two inputs
|
|
|
|
+equivalent:
|
|
|
|
+<PRE>
|
|
|
|
+if x then if y then win (); else lose;
|
|
|
|
+if x then do; if y then win (); else lose; end;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+But if the parser chose to reduce when possible rather than shift, the
|
|
|
|
+result would be to attach the else-clause to the outermost if-statement,
|
|
|
|
+making these two inputs equivalent:
|
|
|
|
+<PRE>
|
|
|
|
+if x then if y then win (); else lose;
|
|
|
|
+if x then do; if y then win (); end; else lose;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The conflict exists because the grammar as written is ambiguous: either
|
|
|
|
+parsing of the simple nested if-statement is legitimate. The established
|
|
|
|
+convention is that these ambiguities are resolved by attaching the
|
|
|
|
+else-clause to the innermost if-statement; this is what Bison accomplishes
|
|
|
|
+by choosing to shift rather than reduce. (It would ideally be cleaner to
|
|
|
|
+write an unambiguous grammar, but that is very hard to do in this case.)
|
|
|
|
+This particular ambiguity was first encountered in the specifications of
|
|
|
|
+Algol 60 and is called the "dangling <CODE>else</CODE>" ambiguity.
|
|
|
|
+To avoid warnings from Bison about predictable, legitimate shift/reduce
|
|
|
|
+conflicts, use the <CODE>%expect <VAR>n</VAR></CODE> declaration. There will be no
|
|
|
|
+warning as long as the number of shift/reduce conflicts is exactly <VAR>n</VAR>.
|
|
|
|
+See section <A HREF="bison.html#SEC54">Suppressing Conflict Warnings</A>.
|
|
|
|
+The definition of <CODE>if_stmt</CODE> above is solely to blame for the
|
|
|
|
+conflict, but the conflict does not actually appear without additional
|
|
|
|
+rules. Here is a complete Bison input file that actually manifests the
|
|
|
|
+conflict:
|
|
|
|
+<PRE>
|
|
|
|
+%token IF THEN ELSE variable
|
|
|
|
+%%
|
|
|
|
+stmt: expr
|
|
|
|
+ | if_stmt
|
|
|
|
+ ;
|
|
|
|
+if_stmt:
|
|
|
|
+ IF expr THEN stmt
|
|
|
|
+ | IF expr THEN stmt ELSE stmt
|
|
|
|
+ ;
|
|
|
|
+expr: variable
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC71" HREF="bison.html#TOC71">Operator Precedence</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX152"></A>
|
|
|
|
+<A NAME="IDX153"></A>
|
|
|
|
+Another situation where shift/reduce conflicts appear is in arithmetic
|
|
|
|
+expressions. Here shifting is not always the preferred resolution; the
|
|
|
|
+Bison declarations for operator precedence allow you to specify when to
|
|
|
|
+shift and when to reduce.
|
|
|
|
+<H3><A NAME="SEC72" HREF="bison.html#TOC72">When Precedence is Needed</A></H3>
|
|
|
|
+<P>
|
|
|
|
+Consider the following ambiguous grammar fragment (ambiguous because the
|
|
|
|
+input <SAMP>`1 - 2 * 3'</SAMP> can be parsed in two different ways):
|
|
|
|
+<PRE>
|
|
|
|
+expr: expr '-' expr
|
|
|
|
+ | expr '*' expr
|
|
|
|
+ | expr '<' expr
|
|
|
|
+ | '(' expr ')'
|
|
|
|
+ ...
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Suppose the parser has seen the tokens <SAMP>`1'</SAMP>, <SAMP>`-'</SAMP> and <SAMP>`2'</SAMP>;
|
|
|
|
+should it reduce them via the rule for the addition operator? It depends
|
|
|
|
+on the next token. Of course, if the next token is <SAMP>`)'</SAMP>, we must
|
|
|
|
+reduce; shifting is invalid because no single rule can reduce the token
|
|
|
|
+sequence <SAMP>`- 2 )'</SAMP> or anything starting with that. But if the next
|
|
|
|
+token is <SAMP>`*'</SAMP> or <SAMP>`<'</SAMP>, we have a choice: either shifting or
|
|
|
|
+reduction would allow the parse to complete, but with different
|
|
|
|
+results.
|
|
|
|
+To decide which one Bison should do, we must consider the
|
|
|
|
+results. If the next operator token <VAR>op</VAR> is shifted, then it
|
|
|
|
+must be reduced first in order to permit another opportunity to
|
|
|
|
+reduce the sum. The result is (in effect) <SAMP>`1 - (2
|
|
|
|
+<VAR>op</VAR> 3)'</SAMP>. On the other hand, if the subtraction is reduced
|
|
|
|
+before shifting <VAR>op</VAR>, the result is <SAMP>`(1 - 2) <VAR>op</VAR>
|
|
|
|
+3'</SAMP>. Clearly, then, the choice of shift or reduce should depend
|
|
|
|
+on the relative precedence of the operators <SAMP>`-'</SAMP> and
|
|
|
|
+<VAR>op</VAR>: <SAMP>`*'</SAMP> should be shifted first, but not <SAMP>`<'</SAMP>.
|
|
|
|
+<A NAME="IDX154"></A>
|
|
|
|
+What about input such as <SAMP>`1 - 2 - 5'</SAMP>; should this be
|
|
|
|
+<SAMP>`(1 - 2) - 5'</SAMP> or should it be <SAMP>`1 - (2 - 5)'</SAMP>? For
|
|
|
|
+most operators we prefer the former, which is called <EM>left
|
|
|
|
+association</EM>. The latter alternative, <EM>right association</EM>, is
|
|
|
|
+desirable for assignment operators. The choice of left or right
|
|
|
|
+association is a matter of whether the parser chooses to shift or
|
|
|
|
+reduce when the stack contains <SAMP>`1 - 2'</SAMP> and the look-ahead
|
|
|
|
+token is <SAMP>`-'</SAMP>: shifting makes right-associativity.
|
|
|
|
+<H3><A NAME="SEC73" HREF="bison.html#TOC73">Specifying Operator Precedence</A></H3>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX155"></A>
|
|
|
|
+<A NAME="IDX156"></A>
|
|
|
|
+<A NAME="IDX157"></A>
|
|
|
|
+Bison allows you to specify these choices with the operator precedence
|
|
|
|
+declarations <CODE>%left</CODE> and <CODE>%right</CODE>. Each such declaration
|
|
|
|
+contains a list of tokens, which are operators whose precedence and
|
|
|
|
+associativity is being declared. The <CODE>%left</CODE> declaration makes all
|
|
|
|
+those operators left-associative and the <CODE>%right</CODE> declaration makes
|
|
|
|
+them right-associative. A third alternative is <CODE>%nonassoc</CODE>, which
|
|
|
|
+declares that it is a syntax error to find the same operator twice "in a
|
|
|
|
+row".
|
|
|
|
+The relative precedence of different operators is controlled by the
|
|
|
|
+order in which they are declared. The first <CODE>%left</CODE> or
|
|
|
|
+<CODE>%right</CODE> declaration in the file declares the operators whose
|
|
|
|
+precedence is lowest, the next such declaration declares the operators
|
|
|
|
+whose precedence is a little higher, and so on.
|
|
|
|
+<H3><A NAME="SEC74" HREF="bison.html#TOC74">Precedence Examples</A></H3>
|
|
|
|
+<P>
|
|
|
|
+In our example, we would want the following declarations:
|
|
|
|
+<PRE>
|
|
|
|
+%left '<'
|
|
|
|
+%left '-'
|
|
|
|
+%left '*'
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+In a more complete example, which supports other operators as well, we
|
|
|
|
+would declare them in groups of equal precedence. For example, <CODE>'+'</CODE> is
|
|
|
|
+declared with <CODE>'-'</CODE>:
|
|
|
|
+<PRE>
|
|
|
|
+%left '<' '>' '=' NE LE GE
|
|
|
|
+%left '+' '-'
|
|
|
|
+%left '*' '/'
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+(Here <CODE>NE</CODE> and so on stand for the operators for "not equal"
|
|
|
|
+and so on. We assume that these tokens are more than one character long
|
|
|
|
+and therefore are represented by names, not character literals.)
|
|
|
|
+<H3><A NAME="SEC75" HREF="bison.html#TOC75">How Precedence Works</A></H3>
|
|
|
|
+<P>
|
|
|
|
+The first effect of the precedence declarations is to assign precedence
|
|
|
|
+levels to the terminal symbols declared. The second effect is to assign
|
|
|
|
+precedence levels to certain rules: each rule gets its precedence from the
|
|
|
|
+last terminal symbol mentioned in the components. (You can also specify
|
|
|
|
+explicitly the precedence of a rule. See section <A HREF="bison.html#SEC76">Context-Dependent Precedence</A>.)
|
|
|
|
+Finally, the resolution of conflicts works by comparing the
|
|
|
|
+precedence of the rule being considered with that of the
|
|
|
|
+look-ahead token. If the token's precedence is higher, the
|
|
|
|
+choice is to shift. If the rule's precedence is higher, the
|
|
|
|
+choice is to reduce. If they have equal precedence, the choice
|
|
|
|
+is made based on the associativity of that precedence level. The
|
|
|
|
+verbose output file made by <SAMP>`-v'</SAMP> (see section <A HREF="bison.html#SEC87">Invoking Bison</A>) says
|
|
|
|
+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.
|
|
|
|
+<H2><A NAME="SEC76" HREF="bison.html#TOC76">Context-Dependent Precedence</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX158"></A>
|
|
|
|
+<A NAME="IDX159"></A>
|
|
|
|
+<A NAME="IDX160"></A>
|
|
|
|
+<A NAME="IDX161"></A>
|
|
|
|
+<A NAME="IDX162"></A>
|
|
|
|
+Often the precedence of an operator depends on the context. This sounds
|
|
|
|
+outlandish at first, but it is really very common. For example, a minus
|
|
|
|
+sign typically has a very high precedence as a unary operator, and a
|
|
|
|
+somewhat lower precedence (lower than multiplication) as a binary operator.
|
|
|
|
+The Bison precedence declarations, <CODE>%left</CODE>, <CODE>%right</CODE> and
|
|
|
|
+<CODE>%nonassoc</CODE>, can only be used once for a given token; so a token has
|
|
|
|
+only one precedence declared in this way. For context-dependent
|
|
|
|
+precedence, you need to use an additional mechanism: the <CODE>%prec</CODE>
|
|
|
|
+modifier for rules.
|
|
|
|
+The <CODE>%prec</CODE> modifier declares the precedence of a particular rule by
|
|
|
|
+specifying a terminal symbol whose precedence should be used for that rule.
|
|
|
|
+It's not necessary for that symbol to appear otherwise in the rule. The
|
|
|
|
+modifier's syntax is:
|
|
|
|
+<PRE>
|
|
|
|
+%prec <VAR>terminal-symbol</VAR>
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+and it is written after the components of the rule. Its effect is to
|
|
|
|
+assign the rule the precedence of <VAR>terminal-symbol</VAR>, overriding
|
|
|
|
+the precedence that would be deduced for it in the ordinary way. The
|
|
|
|
+altered rule precedence then affects how conflicts involving that rule
|
|
|
|
+are resolved (see section <A HREF="bison.html#SEC71">Operator Precedence</A>).
|
|
|
|
+Here is how <CODE>%prec</CODE> solves the problem of unary minus. First, declare
|
|
|
|
+a precedence for a fictitious terminal symbol named <CODE>UMINUS</CODE>. There
|
|
|
|
+are no tokens of this type, but the symbol serves to stand for its
|
|
|
|
+precedence:
|
|
|
|
+<PRE>
|
|
|
|
+...
|
|
|
|
+%left '+' '-'
|
|
|
|
+%left '*'
|
|
|
|
+%left UMINUS
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Now the precedence of <CODE>UMINUS</CODE> can be used in specific rules:
|
|
|
|
+<PRE>
|
|
|
|
+exp: ...
|
|
|
|
+ | exp '-' exp
|
|
|
|
+ ...
|
|
|
|
+ | '-' exp %prec UMINUS
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC77" HREF="bison.html#TOC77">Parser States</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX163"></A>
|
|
|
|
+<A NAME="IDX164"></A>
|
|
|
|
+<A NAME="IDX165"></A>
|
|
|
|
+The function <CODE>yyparse</CODE> is implemented using a finite-state machine.
|
|
|
|
+The values pushed on the parser stack are not simply token type codes; they
|
|
|
|
+represent the entire sequence of terminal and nonterminal symbols at or
|
|
|
|
+near the top of the stack. The current state collects all the information
|
|
|
|
+about previous input which is relevant to deciding what to do next.
|
|
|
|
+Each time a look-ahead token is read, the current parser state together
|
|
|
|
+with the type of look-ahead token are looked up in a table. This table
|
|
|
|
+entry can say, "Shift the look-ahead token." In this case, it also
|
|
|
|
+specifies the new parser state, which is pushed onto the top of the
|
|
|
|
+parser stack. Or it can say, "Reduce using rule number <VAR>n</VAR>."
|
|
|
|
+This means that a certain number of tokens or groupings are taken off
|
|
|
|
+the top of the stack, and replaced by one grouping. In other words,
|
|
|
|
+that number of states are popped from the stack, and one new state is
|
|
|
|
+pushed.
|
|
|
|
+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
|
|
|
|
+(see section <A HREF="bison.html#SEC81">Error Recovery</A>).
|
|
|
|
+<H2><A NAME="SEC78" HREF="bison.html#TOC78">Reduce/Reduce Conflicts</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX166"></A>
|
|
|
|
+<A NAME="IDX167"></A>
|
|
|
|
+A reduce/reduce conflict occurs if there are two or more rules that apply
|
|
|
|
+to the same sequence of input. This usually indicates a serious error
|
|
|
|
+in the grammar.
|
|
|
|
+For example, here is an erroneous attempt to define a sequence
|
|
|
|
+of zero or more <CODE>word</CODE> groupings.
|
|
|
|
+<PRE>
|
|
|
|
+sequence: /* empty */
|
|
|
|
+ { printf ("empty sequence\n"); }
|
|
|
|
+ | maybeword
|
|
|
|
+ | sequence word
|
|
|
|
+ { printf ("added word %s\n", $2); }
|
|
|
|
+ ;
|
|
|
|
+maybeword: /* empty */
|
|
|
|
+ { printf ("empty maybeword\n"); }
|
|
|
|
+ | word
|
|
|
|
+ { printf ("single word %s\n", $1); }
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The error is an ambiguity: there is more than one way to parse a single
|
|
|
|
+<CODE>word</CODE> into a <CODE>sequence</CODE>. It could be reduced to a
|
|
|
|
+<CODE>maybeword</CODE> and then into a <CODE>sequence</CODE> via the second rule.
|
|
|
|
+Alternatively, nothing-at-all could be reduced into a <CODE>sequence</CODE>
|
|
|
|
+via the first rule, and this could be combined with the <CODE>word</CODE>
|
|
|
|
+using the third rule for <CODE>sequence</CODE>.
|
|
|
|
+There is also more than one way to reduce nothing-at-all into a
|
|
|
|
+<CODE>sequence</CODE>. This can be done directly via the first rule,
|
|
|
|
+or indirectly via <CODE>maybeword</CODE> and then the second rule.
|
|
|
|
+You might think that this is a distinction without a difference, because it
|
|
|
|
+does not change whether any particular input is valid or not. But it does
|
|
|
|
+affect which actions are run. One parsing order runs the second rule's
|
|
|
|
+action; the other runs the first rule's action and the third rule's action.
|
|
|
|
+In this example, the output of the program changes.
|
|
|
|
+Bison resolves a reduce/reduce conflict by choosing to use the rule that
|
|
|
|
+appears first in the grammar, but it is very risky to rely on this. Every
|
|
|
|
+reduce/reduce conflict must be studied and usually eliminated. Here is the
|
|
|
|
+proper way to define <CODE>sequence</CODE>:
|
|
|
|
+<PRE>
|
|
|
|
+sequence: /* empty */
|
|
|
|
+ { printf ("empty sequence\n"); }
|
|
|
|
+ | sequence word
|
|
|
|
+ { printf ("added word %s\n", $2); }
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Here is another common error that yields a reduce/reduce conflict:
|
|
|
|
+<PRE>
|
|
|
|
+sequence: /* empty */
|
|
|
|
+ | sequence words
|
|
|
|
+ | sequence redirects
|
|
|
|
+ ;
|
|
|
|
+words: /* empty */
|
|
|
|
+ | words word
|
|
|
|
+ ;
|
|
|
|
+redirects:/* empty */
|
|
|
|
+ | redirects redirect
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The intention here is to define a sequence which can contain either
|
|
|
|
+<CODE>word</CODE> or <CODE>redirect</CODE> groupings. The individual definitions of
|
|
|
|
+<CODE>sequence</CODE>, <CODE>words</CODE> and <CODE>redirects</CODE> are error-free, but the
|
|
|
|
+three together make a subtle ambiguity: even an empty input can be parsed
|
|
|
|
+in infinitely many ways!
|
|
|
|
+Consider: nothing-at-all could be a <CODE>words</CODE>. Or it could be two
|
|
|
|
+<CODE>words</CODE> in a row, or three, or any number. It could equally well be a
|
|
|
|
+<CODE>redirects</CODE>, or two, or any number. Or it could be a <CODE>words</CODE>
|
|
|
|
+followed by three <CODE>redirects</CODE> and another <CODE>words</CODE>. And so on.
|
|
|
|
+Here are two ways to correct these rules. First, to make it a single level
|
|
|
|
+of sequence:
|
|
|
|
+<PRE>
|
|
|
|
+sequence: /* empty */
|
|
|
|
+ | sequence word
|
|
|
|
+ | sequence redirect
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Second, to prevent either a <CODE>words</CODE> or a <CODE>redirects</CODE>
|
|
|
|
+from being empty:
|
|
|
|
+<PRE>
|
|
|
|
+sequence: /* empty */
|
|
|
|
+ | sequence words
|
|
|
|
+ | sequence redirects
|
|
|
|
+ ;
|
|
|
|
+words: word
|
|
|
|
+ | words word
|
|
|
|
+ ;
|
|
|
|
+redirects:redirect
|
|
|
|
+ | redirects redirect
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC79" HREF="bison.html#TOC79">Mysterious Reduce/Reduce Conflicts</A></H2>
|
|
|
|
+<P>
|
|
|
|
+Sometimes reduce/reduce conflicts can occur that don't look warranted.
|
|
|
|
+Here is an example:
|
|
|
|
+<PRE>
|
|
|
|
+%token ID
|
|
|
|
+%%
|
|
|
|
+def: param_spec return_spec ','
|
|
|
|
+ ;
|
|
|
|
+param_spec:
|
|
|
|
+ type
|
|
|
|
+ | name_list ':' type
|
|
|
|
+ ;
|
|
|
|
+return_spec:
|
|
|
|
+ type
|
|
|
|
+ | name ':' type
|
|
|
|
+ ;
|
|
|
|
+type: ID
|
|
|
|
+ ;
|
|
|
|
+name: ID
|
|
|
|
+ ;
|
|
|
|
+name_list:
|
|
|
|
+ name
|
|
|
|
+ | name ',' name_list
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+It would seem that this grammar can be parsed with only a single token
|
|
|
|
+of look-ahead: when a <CODE>param_spec</CODE> is being read, an <CODE>ID</CODE> is
|
|
|
|
+a <CODE>name</CODE> if a comma or colon follows, or a <CODE>type</CODE> if another
|
|
|
|
+<CODE>ID</CODE> follows. In other words, this grammar is LR(1).
|
|
|
|
+<A NAME="IDX168"></A>
|
|
|
|
+<A NAME="IDX169"></A>
|
|
|
|
+However, Bison, like most parser generators, cannot actually handle all
|
|
|
|
+LR(1) grammars. In this grammar, two contexts, that after an <CODE>ID</CODE>
|
|
|
|
+at the beginning of a <CODE>param_spec</CODE> and likewise at the beginning of
|
|
|
|
+a <CODE>return_spec</CODE>, are similar enough that Bison assumes they are the
|
|
|
|
+same. They appear similar because the same set of rules would be
|
|
|
|
+active--the rule for reducing to a <CODE>name</CODE> and that for reducing to
|
|
|
|
+a <CODE>type</CODE>. Bison is unable to determine at that stage of processing
|
|
|
|
+that the rules would require different look-ahead tokens in the two
|
|
|
|
+contexts, so it makes a single parser state for them both. Combining
|
|
|
|
+the two contexts causes a conflict later. In parser terminology, this
|
|
|
|
+occurrence means that the grammar is not LALR(1).
|
|
|
|
+In general, it is better to fix deficiencies than to document them. But
|
|
|
|
+this particular deficiency is intrinsically hard to fix; parser
|
|
|
|
+generators that can handle LR(1) grammars are hard to write and tend to
|
|
|
|
+produce parsers that are very large. In practice, Bison is more useful
|
|
|
|
+as it is now.
|
|
|
|
+When the problem arises, you can often fix it by identifying the two
|
|
|
|
+parser states that are being confused, and adding something to make them
|
|
|
|
+look distinct. In the above example, adding one rule to
|
|
|
|
+<CODE>return_spec</CODE> as follows makes the problem go away:
|
|
|
|
+<PRE>
|
|
|
|
+%token BOGUS
|
|
|
|
+...
|
|
|
|
+%%
|
|
|
|
+...
|
|
|
|
+return_spec:
|
|
|
|
+ type
|
|
|
|
+ | name ':' type
|
|
|
|
+ /* This rule is never used. */
|
|
|
|
+ | ID BOGUS
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+This corrects the problem because it introduces the possibility of an
|
|
|
|
+additional active rule in the context after the <CODE>ID</CODE> at the beginning of
|
|
|
|
+<CODE>return_spec</CODE>. This rule is not active in the corresponding context
|
|
|
|
+in a <CODE>param_spec</CODE>, so the two contexts receive distinct parser states.
|
|
|
|
+As long as the token <CODE>BOGUS</CODE> is never generated by <CODE>yylex</CODE>,
|
|
|
|
+the added rule cannot alter the way actual input is parsed.
|
|
|
|
+In this particular example, there is another way to solve the problem:
|
|
|
|
+rewrite the rule for <CODE>return_spec</CODE> to use <CODE>ID</CODE> directly
|
|
|
|
+instead of via <CODE>name</CODE>. This also causes the two confusing
|
|
|
|
+contexts to have different sets of active rules, because the one for
|
|
|
|
+<CODE>return_spec</CODE> activates the altered rule for <CODE>return_spec</CODE>
|
|
|
|
+rather than the one for <CODE>name</CODE>.
|
|
|
|
+<PRE>
|
|
|
|
+param_spec:
|
|
|
|
+ type
|
|
|
|
+ | name_list ':' type
|
|
|
|
+ ;
|
|
|
|
+return_spec:
|
|
|
|
+ type
|
|
|
|
+ | ID ':' type
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC80" HREF="bison.html#TOC80">Stack Overflow, and How to Avoid It</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX170"></A>
|
|
|
|
+<A NAME="IDX171"></A>
|
|
|
|
+<A NAME="IDX172"></A>
|
|
|
|
+The Bison parser stack can overflow if too many tokens are shifted and
|
|
|
|
+not reduced. When this happens, the parser function <CODE>yyparse</CODE>
|
|
|
|
+returns a nonzero value, pausing only to call <CODE>yyerror</CODE> to report
|
|
|
|
+the overflow.
|
|
|
|
+<A NAME="IDX173"></A>
|
|
|
|
+By defining the macro <CODE>YYMAXDEPTH</CODE>, you can control how deep the
|
|
|
|
+parser stack can become before a stack overflow occurs. Define the
|
|
|
|
+macro with a value that is an integer. This value is the maximum number
|
|
|
|
+of tokens that can be shifted (and not reduced) before overflow.
|
|
|
|
+It must be a constant expression whose value is known at compile time.
|
|
|
|
+The stack space allowed is not necessarily allocated. If you specify a
|
|
|
|
+large value for <CODE>YYMAXDEPTH</CODE>, the parser actually allocates a small
|
|
|
|
+stack at first, and then makes it bigger by stages as needed. This
|
|
|
|
+increasing allocation happens automatically and silently. Therefore,
|
|
|
|
+you do not need to make <CODE>YYMAXDEPTH</CODE> painfully small merely to save
|
|
|
|
+space for ordinary inputs that do not need much stack.
|
|
|
|
+<A NAME="IDX174"></A>
|
|
|
|
+The default value of <CODE>YYMAXDEPTH</CODE>, if you do not define it, is
|
|
|
|
+10000.
|
|
|
|
+<A NAME="IDX175"></A>
|
|
|
|
+You can control how much stack is allocated initially by defining the
|
|
|
|
+macro <CODE>YYINITDEPTH</CODE>. This value too must be a compile-time
|
|
|
|
+constant integer. The default is 200.
|
|
|
|
+<H1><A NAME="SEC81" HREF="bison.html#TOC81">Error Recovery</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX176"></A>
|
|
|
|
+<A NAME="IDX177"></A>
|
|
|
|
+It is not usually acceptable to have a program terminate on a parse
|
|
|
|
+error. For example, a compiler should recover sufficiently to parse the
|
|
|
|
+rest of the input file and check it for errors; a calculator should accept
|
|
|
|
+another expression.
|
|
|
|
+In a simple interactive command parser where each input is one line, it may
|
|
|
|
+be sufficient to allow <CODE>yyparse</CODE> to return 1 on error and have the
|
|
|
|
+caller ignore the rest of the input line when that happens (and then call
|
|
|
|
+<CODE>yyparse</CODE> again). But this is inadequate for a compiler, because it
|
|
|
|
+forgets all the syntactic context leading up to the error. A syntax error
|
|
|
|
+deep within a function in the compiler input should not cause the compiler
|
|
|
|
+to treat the following line like the beginning of a source file.
|
|
|
|
+<A NAME="IDX178"></A>
|
|
|
|
+You can define how to recover from a syntax error by writing rules to
|
|
|
|
+recognize the special token <CODE>error</CODE>. This is a terminal symbol that
|
|
|
|
+is always defined (you need not declare it) and reserved for error
|
|
|
|
+handling. The Bison parser generates an <CODE>error</CODE> token whenever a
|
|
|
|
+syntax error happens; if you have provided a rule to recognize this token
|
|
|
|
+in the current context, the parse can continue.
|
|
|
|
+For example:
|
|
|
|
+<PRE>
|
|
|
|
+stmnts: /* empty string */
|
|
|
|
+ | stmnts '\n'
|
|
|
|
+ | stmnts exp '\n'
|
|
|
|
+ | stmnts error '\n'
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The fourth rule in this example says that an error followed by a newline
|
|
|
|
+makes a valid addition to any <CODE>stmnts</CODE>.
|
|
|
|
+What happens if a syntax error occurs in the middle of an <CODE>exp</CODE>? The
|
|
|
|
+error recovery rule, interpreted strictly, applies to the precise sequence
|
|
|
|
+of a <CODE>stmnts</CODE>, an <CODE>error</CODE> and a newline. If an error occurs in
|
|
|
|
+the middle of an <CODE>exp</CODE>, there will probably be some additional tokens
|
|
|
|
+and subexpressions on the stack after the last <CODE>stmnts</CODE>, and there
|
|
|
|
+will be tokens to read before the next newline. So the rule is not
|
|
|
|
+applicable in the ordinary way.
|
|
|
|
+But Bison can force the situation to fit the rule, by discarding part of
|
|
|
|
+the semantic context and part of the input. First it discards states and
|
|
|
|
+objects from the stack until it gets back to a state in which the
|
|
|
|
+<CODE>error</CODE> token is acceptable. (This means that the subexpressions
|
|
|
|
+already parsed are discarded, back to the last complete <CODE>stmnts</CODE>.) At
|
|
|
|
+this point the <CODE>error</CODE> token can be shifted. Then, if the old
|
|
|
|
+look-ahead token is not acceptable to be shifted next, the parser reads
|
|
|
|
+tokens and discards them until it finds a token which is acceptable. In
|
|
|
|
+this example, Bison reads and discards input until the next newline
|
|
|
|
+so that the fourth rule can apply.
|
|
|
|
+The choice of error rules in the grammar is a choice of strategies for
|
|
|
|
+error recovery. A simple and useful strategy is simply to skip the rest of
|
|
|
|
+the current input line or current statement if an error is detected:
|
|
|
|
+<PRE>
|
|
|
|
+stmnt: error ';' /* on error, skip until ';' is read */
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+It is also useful to recover to the matching close-delimiter of an
|
|
|
|
+opening-delimiter that has already been parsed. Otherwise the
|
|
|
|
+close-delimiter will probably appear to be unmatched, and generate another,
|
|
|
|
+spurious error message:
|
|
|
|
+<PRE>
|
|
|
|
+primary: '(' expr ')'
|
|
|
|
+ | '(' error ')'
|
|
|
|
+ ...
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Error recovery strategies are necessarily guesses. When they guess wrong,
|
|
|
|
+one syntax error often leads to another. In the above example, the error
|
|
|
|
+recovery rule guesses that an error is due to bad input within one
|
|
|
|
+<CODE>stmnt</CODE>. Suppose that instead a spurious semicolon is inserted in the
|
|
|
|
+middle of a valid <CODE>stmnt</CODE>. After the error recovery rule recovers
|
|
|
|
+from the first error, another syntax error will be found straightaway,
|
|
|
|
+since the text following the spurious semicolon is also an invalid
|
|
|
|
+<CODE>stmnt</CODE>.
|
|
|
|
+To prevent an outpouring of error messages, the parser will output no error
|
|
|
|
+message for another syntax error that happens shortly after the first; only
|
|
|
|
+after three consecutive input tokens have been successfully shifted will
|
|
|
|
+error messages resume.
|
|
|
|
+Note that rules which accept the <CODE>error</CODE> token may have actions, just
|
|
|
|
+as any other rules can.
|
|
|
|
+<A NAME="IDX179"></A>
|
|
|
|
+You can make error messages resume immediately by using the macro
|
|
|
|
+<CODE>yyerrok</CODE> in an action. If you do this in the error rule's action, no
|
|
|
|
+error messages will be suppressed. This macro requires no arguments;
|
|
|
|
+<SAMP>`yyerrok;'</SAMP> is a valid C statement.
|
|
|
|
+<A NAME="IDX180"></A>
|
|
|
|
+The previous look-ahead token is reanalyzed immediately after an error. If
|
|
|
|
+this is unacceptable, then the macro <CODE>yyclearin</CODE> may be used to clear
|
|
|
|
+this token. Write the statement <SAMP>`yyclearin;'</SAMP> in the error rule's
|
|
|
|
+action.
|
|
|
|
+For example, suppose that on a parse error, an error handling routine is
|
|
|
|
+called that advances the input stream to some point where parsing should
|
|
|
|
+once again commence. The next symbol returned by the lexical scanner is
|
|
|
|
+probably correct. The previous look-ahead token ought to be discarded
|
|
|
|
+with <SAMP>`yyclearin;'</SAMP>.
|
|
|
|
+<A NAME="IDX181"></A>
|
|
|
|
+The macro <CODE>YYRECOVERING</CODE> stands for an expression that has the
|
|
|
|
+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.
|
|
|
|
+<H1><A NAME="SEC82" HREF="bison.html#TOC82">Handling Context Dependencies</A></H1>
|
|
|
|
+<P>
|
|
|
|
+The Bison paradigm is to parse tokens first, then group them into larger
|
|
|
|
+syntactic units. In many languages, the meaning of a token is affected by
|
|
|
|
+its context. Although this violates the Bison paradigm, certain techniques
|
|
|
|
+(known as <EM>kludges</EM>) may enable you to write Bison parsers for such
|
|
|
|
+languages.
|
|
|
|
+(Actually, "kludge" means any technique that gets its job done but is
|
|
|
|
+neither clean nor robust.)
|
|
|
|
+<H2><A NAME="SEC83" HREF="bison.html#TOC83">Semantic Info in Token Types</A></H2>
|
|
|
|
+<P>
|
|
|
|
+The C language has a context dependency: the way an identifier is used
|
|
|
|
+depends on what its current meaning is. For example, consider this:
|
|
|
|
+<PRE>
|
|
|
|
+foo (x);
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+This looks like a function call statement, but if <CODE>foo</CODE> is a typedef
|
|
|
|
+name, then this is actually a declaration of <CODE>x</CODE>. How can a Bison
|
|
|
|
+parser for C decide how to parse this input?
|
|
|
|
+The method used in GNU C is to have two different token types,
|
|
|
|
+<CODE>IDENTIFIER</CODE> and <CODE>TYPENAME</CODE>. When <CODE>yylex</CODE> finds an
|
|
|
|
+identifier, it looks up the current declaration of the identifier in order
|
|
|
|
+to decide which token type to return: <CODE>TYPENAME</CODE> if the identifier is
|
|
|
|
+declared as a typedef, <CODE>IDENTIFIER</CODE> otherwise.
|
|
|
|
+The grammar rules can then express the context dependency by the choice of
|
|
|
|
+token type to recognize. <CODE>IDENTIFIER</CODE> is accepted as an expression,
|
|
|
|
+but <CODE>TYPENAME</CODE> is not. <CODE>TYPENAME</CODE> can start a declaration, but
|
|
|
|
+<CODE>IDENTIFIER</CODE> cannot. In contexts where the meaning of the identifier
|
|
|
|
+is <EM>not</EM> significant, such as in declarations that can shadow a
|
|
|
|
+typedef name, either <CODE>TYPENAME</CODE> or <CODE>IDENTIFIER</CODE> is
|
|
|
|
+accepted--there is one rule for each of the two token types.
|
|
|
|
+This technique is simple to use if the decision of which kinds of
|
|
|
|
+identifiers to allow is made at a place close to where the identifier is
|
|
|
|
+parsed. But in C this is not always so: C allows a declaration to
|
|
|
|
+redeclare a typedef name provided an explicit type has been specified
|
|
|
|
+earlier:
|
|
|
|
+<PRE>
|
|
|
|
+typedef int foo, bar, lose;
|
|
|
|
+static foo (bar); /* redeclare <CODE>bar</CODE> as static variable */
|
|
|
|
+static int foo (lose); /* redeclare <CODE>foo</CODE> as function */
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Unfortunately, the name being declared is separated from the declaration
|
|
|
|
+construct itself by a complicated syntactic structure--the "declarator".
|
|
|
|
+As a result, the part of Bison parser for C needs to be duplicated, with
|
|
|
|
+all the nonterminal names changed: once for parsing a declaration in which
|
|
|
|
+a typedef name can be redefined, and once for parsing a declaration in
|
|
|
|
+which that can't be done. Here is a part of the duplication, with actions
|
|
|
|
+omitted for brevity:
|
|
|
|
+<PRE>
|
|
|
|
+initdcl:
|
|
|
|
+ declarator maybeasm '='
|
|
|
|
+ init
|
|
|
|
+ | declarator maybeasm
|
|
|
|
+ ;
|
|
|
|
+notype_initdcl:
|
|
|
|
+ notype_declarator maybeasm '='
|
|
|
|
+ init
|
|
|
|
+ | notype_declarator maybeasm
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Here <CODE>initdcl</CODE> can redeclare a typedef name, but <CODE>notype_initdcl</CODE>
|
|
|
|
+cannot. The distinction between <CODE>declarator</CODE> and
|
|
|
|
+<CODE>notype_declarator</CODE> is the same sort of thing.
|
|
|
|
+There is some similarity between this technique and a lexical tie-in
|
|
|
|
+(described next), in that information which alters the lexical analysis is
|
|
|
|
+changed during parsing by other parts of the program. The difference is
|
|
|
|
+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.
|
|
|
|
+<H2><A NAME="SEC84" HREF="bison.html#TOC84">Lexical Tie-ins</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX182"></A>
|
|
|
|
+One way to handle context-dependency is the <EM>lexical tie-in</EM>: a flag
|
|
|
|
+which is set by Bison actions, whose purpose is to alter the way tokens are
|
|
|
|
+parsed.
|
|
|
|
+For example, suppose we have a language vaguely like C, but with a special
|
|
|
|
+construct <SAMP>`hex (<VAR>hex-expr</VAR>)'</SAMP>. After the keyword <CODE>hex</CODE> comes
|
|
|
|
+an expression in parentheses in which all integers are hexadecimal. In
|
|
|
|
+particular, the token <SAMP>`a1b'</SAMP> must be treated as an integer rather than
|
|
|
|
+as an identifier if it appears in that context. Here is how you can do it:
|
|
|
|
+<PRE>
|
|
|
|
+%{
|
|
|
|
+int hexflag;
|
|
|
|
+%}
|
|
|
|
+%%
|
|
|
|
+...
|
|
|
|
+expr: IDENTIFIER
|
|
|
|
+ | constant
|
|
|
|
+ | HEX '('
|
|
|
|
+ { hexflag = 1; }
|
|
|
|
+ expr ')'
|
|
|
|
+ { hexflag = 0;
|
|
|
|
+ $$ = $4; }
|
|
|
|
+ | expr '+' expr
|
|
|
|
+ { $$ = make_sum ($1, $3); }
|
|
|
|
+ ...
|
|
|
|
+ ;
|
|
|
|
+constant:
|
|
|
|
+ INTEGER
|
|
|
|
+ | STRING
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Here we assume that <CODE>yylex</CODE> looks at the value of <CODE>hexflag</CODE>; 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</CODE> shown in the C declarations section of
|
|
|
|
+the parser file is needed to make it accessible to the actions
|
|
|
|
+(see section <A HREF="bison.html#SEC36">The C Declarations Section</A>). You must also write the code in <CODE>yylex</CODE>
|
|
|
|
+to obey the flag.
|
|
|
|
+<H2><A NAME="SEC85" HREF="bison.html#TOC85">Lexical Tie-ins and Error Recovery</A></H2>
|
|
|
|
+<P>
|
|
|
|
+Lexical tie-ins make strict demands on any error recovery rules you have.
|
|
|
|
+See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+The reason for this is that the purpose of an error recovery rule is to
|
|
|
|
+abort the parsing of one construct and resume in some larger construct.
|
|
|
|
+For example, in C-like languages, a typical error recovery rule is to skip
|
|
|
|
+tokens until the next semicolon, and then start a new statement, like this:
|
|
|
|
+<PRE>
|
|
|
|
+stmt: expr ';'
|
|
|
|
+ | IF '(' expr ')' stmt { ... }
|
|
|
|
+ ...
|
|
|
|
+ error ';'
|
|
|
|
+ { hexflag = 0; }
|
|
|
|
+ ;
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+If there is a syntax error in the middle of a <SAMP>`hex (<VAR>expr</VAR>)'</SAMP>
|
|
|
|
+construct, this error rule will apply, and then the action for the
|
|
|
|
+completed <SAMP>`hex (<VAR>expr</VAR>)'</SAMP> will never run. So <CODE>hexflag</CODE> would
|
|
|
|
+remain set for the entire rest of the input, or until the next <CODE>hex</CODE>
|
|
|
|
+keyword, causing identifiers to be misinterpreted as integers.
|
|
|
|
+To avoid this problem the error recovery rule itself clears <CODE>hexflag</CODE>.
|
|
|
|
+There may also be an error recovery rule that works within expressions.
|
|
|
|
+For example, there could be a rule which applies within parentheses
|
|
|
|
+and skips to the close-parenthesis:
|
|
|
|
+<PRE>
|
|
|
|
+expr: ...
|
|
|
|
+ | '(' expr ')'
|
|
|
|
+ { $$ = $2; }
|
|
|
|
+ | '(' error ')'
|
|
|
|
+ ...
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+If this rule acts within the <CODE>hex</CODE> construct, it is not going to abort
|
|
|
|
+that construct (since it applies to an inner level of parentheses within
|
|
|
|
+the construct). Therefore, it should not clear the flag: the rest of
|
|
|
|
+the <CODE>hex</CODE> construct should be parsed with the flag still in effect.
|
|
|
|
+What if there is an error recovery rule which might abort out of the
|
|
|
|
+<CODE>hex</CODE> construct or might not, depending on circumstances? There is no
|
|
|
|
+way you can write the action to determine whether a <CODE>hex</CODE> construct is
|
|
|
|
+being aborted or not. So if you are using a lexical tie-in, you had better
|
|
|
|
+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.
|
|
|
|
+<H1><A NAME="SEC86" HREF="bison.html#TOC86">Debugging Your Parser</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX183"></A>
|
|
|
|
+<A NAME="IDX184"></A>
|
|
|
|
+<A NAME="IDX185"></A>
|
|
|
|
+<A NAME="IDX186"></A>
|
|
|
|
+If a Bison grammar compiles properly but doesn't do what you want when it
|
|
|
|
+runs, the <CODE>yydebug</CODE> parser-trace feature can help you figure out why.
|
|
|
|
+To enable compilation of trace facilities, you must define the macro
|
|
|
|
+<CODE>YYDEBUG</CODE> when you compile the parser. You could use
|
|
|
|
+<SAMP>`-DYYDEBUG=1'</SAMP> as a compiler option or you could put <SAMP>`#define
|
|
|
|
+YYDEBUG 1'</SAMP> in the C declarations section of the grammar file
|
|
|
|
+(see section <A HREF="bison.html#SEC36">The C Declarations Section</A>). Alternatively, use the <SAMP>`-t'</SAMP> option when
|
|
|
|
+you run Bison (see section <A HREF="bison.html#SEC87">Invoking Bison</A>). We always define <CODE>YYDEBUG</CODE> so that
|
|
|
|
+debugging is always possible.
|
|
|
|
+The trace facility uses <CODE>stderr</CODE>, so you must add <CODE>#include
|
|
|
|
+<stdio.h></CODE> to the C declarations section 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</CODE>.
|
|
|
|
+You can do this by making the C code do it (in <CODE>main</CODE>, perhaps), or
|
|
|
|
+you can alter the value with a C debugger.
|
|
|
|
+Each step taken by the parser when <CODE>yydebug</CODE> is nonzero produces a
|
|
|
|
+line or two of trace information, written on <CODE>stderr</CODE>. The trace
|
|
|
|
+messages tell you these things:
|
|
|
|
+<UL>
|
|
|
|
+<LI>
|
|
|
|
+Each time the parser calls <CODE>yylex</CODE>, what kind of token was read.
|
|
|
|
+<LI>
|
|
|
|
+Each time a token is shifted, the depth and complete contents of the
|
|
|
|
+state stack (see section <A HREF="bison.html#SEC77">Parser States</A>).
|
|
|
|
+<LI>
|
|
|
|
+Each time a rule is reduced, which rule it is, and the complete contents
|
|
|
|
+of the state stack afterward.
|
|
|
|
+</UL>
|
|
|
|
+<P>
|
|
|
|
+To make sense of this information, it helps to refer to the listing file
|
|
|
|
+produced by the Bison <SAMP>`-v'</SAMP> option (see section <A HREF="bison.html#SEC87">Invoking Bison</A>). This file
|
|
|
|
+shows the meaning of each state in terms of positions in various rules, and
|
|
|
|
+also what each state will do with each possible input token. As you read
|
|
|
|
+the successive trace messages, you can see that the parser is functioning
|
|
|
|
+according to its specification in the listing file. Eventually you will
|
|
|
|
+arrive at the place where something undesirable happens, and you will see
|
|
|
|
+which parts of the grammar are to blame.
|
|
|
|
+The parser file is a C program and you can use C debuggers on it, but it's
|
|
|
|
+not easy to interpret what it is doing. The parser function is a
|
|
|
|
+finite-state machine interpreter, and aside from the actions it executes
|
|
|
|
+the same code over and over. Only the values of variables show where in
|
|
|
|
+the grammar it is working.
|
|
|
|
+<A NAME="IDX187"></A>
|
|
|
|
+The debugging information normally gives the token type of each token
|
|
|
|
+read, but not its semantic value. You can optionally define a macro
|
|
|
|
+named <CODE>YYPRINT</CODE> to provide a way to print the value. If you define
|
|
|
|
+<CODE>YYPRINT</CODE>, it should take three arguments. The parser will pass a
|
|
|
|
+standard I/O stream, the numeric code for the token type, and the token
|
|
|
|
+value (from <CODE>yylval</CODE>).
|
|
|
|
+Here is an example of <CODE>YYPRINT</CODE> suitable for the multi-function
|
|
|
|
+calculator (see section <A HREF="bison.html#SEC30">Declarations for <CODE>mfcalc</CODE></A>):
|
|
|
|
+<PRE>
|
|
|
|
+#define YYPRINT(file, type, value) yyprint (file, type, value)
|
|
|
|
+static void
|
|
|
|
+yyprint (file, type, value)
|
|
|
|
+ FILE *file;
|
|
|
|
+ int type;
|
|
|
|
+ YYSTYPE value;
|
|
|
|
+{
|
|
|
|
+ if (type == VAR)
|
|
|
|
+ fprintf (file, " %s", value.tptr->name);
|
|
|
|
+ else if (type == NUM)
|
|
|
|
+ fprintf (file, " %d", value.val);
|
|
|
|
+}
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+<H1><A NAME="SEC87" HREF="bison.html#TOC87">Invoking Bison</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX188"></A>
|
|
|
|
+<A NAME="IDX189"></A>
|
|
|
|
+<A NAME="IDX190"></A>
|
|
|
|
+The usual way to invoke Bison is as follows:
|
|
|
|
+<PRE>
|
|
|
|
+bison <VAR>infile</VAR>
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+Here <VAR>infile</VAR> is the grammar file name, which usually ends in
|
|
|
|
+<SAMP>`.y'</SAMP>. The parser file's name is made by replacing the <SAMP>`.y'</SAMP>
|
|
|
|
+with <SAMP>`.tab.c'</SAMP>. Thus, the <SAMP>`bison foo.y'</SAMP> filename yields
|
|
|
|
+<TT>`foo.tab.c'</TT>, and the <SAMP>`bison hack/foo.y'</SAMP> filename yields
|
|
|
|
+<TT>`hack/foo.tab.c'</TT>.
|
|
|
|
+<H2><A NAME="SEC88" HREF="bison.html#TOC88">Bison Options</A></H2>
|
|
|
|
+<P>
|
|
|
|
+Bison supports both traditional single-letter options and mnemonic long
|
|
|
|
+option names. Long option names are indicated with <SAMP>`--'</SAMP> instead of
|
|
|
|
+<SAMP>`-'</SAMP>. Abbreviations for option names are allowed as long as they
|
|
|
|
+are unique. When a long option takes an argument, like
|
|
|
|
+<SAMP>`--file-prefix'</SAMP>, connect the option name and the argument with
|
|
|
|
+<SAMP>`='</SAMP>.
|
|
|
|
+Here is a list of options that can be used with Bison, alphabetized by
|
|
|
|
+short option. It is followed by a cross key alphabetized by long
|
|
|
|
+option.
|
|
|
|
+<DL COMPACT>
|
|
|
|
+<DT><SAMP>`-b <VAR>file-prefix</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--file-prefix=<VAR>prefix</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Specify a prefix to use for all Bison output file names. The names are
|
|
|
|
+chosen as if the input file were named <TT>`<VAR>prefix</VAR>.c'</TT>.
|
|
|
|
+<DT><SAMP>`-d'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--defines'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Write an extra output file containing macro definitions for the token
|
|
|
|
+type names defined in the grammar and the semantic value type
|
|
|
|
+<CODE>YYSTYPE</CODE>, as well as a few <CODE>extern</CODE> variable declarations.
|
|
|
|
+If the parser output file is named <TT>`<VAR>name</VAR>.c'</TT> then this file
|
|
|
|
+is named <TT>`<VAR>name</VAR>.h'</TT>.
|
|
|
|
+This output file is essential if you wish to put the definition of
|
|
|
|
+<CODE>yylex</CODE> in a separate source file, because <CODE>yylex</CODE> needs to
|
|
|
|
+be able to refer to token type codes and the variable
|
|
|
|
+<CODE>yylval</CODE>. See section <A HREF="bison.html#SEC63">Semantic Values of Tokens</A>.
|
|
|
|
+<DT><SAMP>`-l'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--no-lines'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Don't put any <CODE>#line</CODE> preprocessor commands in the parser file.
|
|
|
|
+Ordinarily Bison puts them in the parser file so that the C compiler
|
|
|
|
+and debuggers will associate errors with your source file, the
|
|
|
|
+grammar file. This option causes them to associate errors with the
|
|
|
|
+parser file, treating it an independent source file in its own right.
|
|
|
|
+<DT><SAMP>`-o <VAR>outfile</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--output-file=<VAR>outfile</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Specify the name <VAR>outfile</VAR> for the parser file.
|
|
|
|
+The other output files' names are constructed from <VAR>outfile</VAR>
|
|
|
|
+as described under the <SAMP>`-v'</SAMP> and <SAMP>`-d'</SAMP> switches.
|
|
|
|
+<DT><SAMP>`-p <VAR>prefix</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--name-prefix=<VAR>prefix</VAR>'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Rename the external symbols used in the parser so that they start with
|
|
|
|
+<VAR>prefix</VAR> instead of <SAMP>`yy'</SAMP>. The precise list of symbols renamed
|
|
|
|
+is <CODE>yyparse</CODE>, <CODE>yylex</CODE>, <CODE>yyerror</CODE>, <CODE>yynerrs</CODE>,
|
|
|
|
+<CODE>yylval</CODE>, <CODE>yychar</CODE> and <CODE>yydebug</CODE>.
|
|
|
|
+For example, if you use <SAMP>`-p c'</SAMP>, the names become <CODE>cparse</CODE>,
|
|
|
|
+<CODE>clex</CODE>, and so on.
|
|
|
|
+See section <A HREF="bison.html#SEC58">Multiple Parsers in the Same Program</A>.
|
|
|
|
+<DT><SAMP>`-t'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--debug'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Output a definition of the macro <CODE>YYDEBUG</CODE> into the parser file,
|
|
|
|
+so that the debugging facilities are compiled. See section <A HREF="bison.html#SEC86">Debugging Your Parser</A>.
|
|
|
|
+<DT><SAMP>`-v'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--verbose'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Write an extra output file containing verbose descriptions of the
|
|
|
|
+parser states and what is done for each type of look-ahead token in
|
|
|
|
+that state.
|
|
|
|
+This file also describes all the conflicts, both those resolved by
|
|
|
|
+operator precedence and the unresolved ones.
|
|
|
|
+The file's name is made by removing <SAMP>`.tab.c'</SAMP> or <SAMP>`.c'</SAMP> from
|
|
|
|
+the parser output file name, and adding <SAMP>`.output'</SAMP> instead.
|
|
|
|
+Therefore, if the input file is <TT>`foo.y'</TT>, then the parser file is
|
|
|
|
+called <TT>`foo.tab.c'</TT> by default. As a consequence, the verbose
|
|
|
|
+output file is called <TT>`foo.output'</TT>.
|
|
|
|
+<DT><SAMP>`-V'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--version'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Print the version number of Bison and exit.
|
|
|
|
+<DT><SAMP>`-h'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--help'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Print a summary of the command-line options to Bison and exit.
|
|
|
|
+<DT><SAMP>`-y'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--yacc'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+<DT><SAMP>`--fixed-output-files'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Equivalent to <SAMP>`-o y.tab.c'</SAMP>; the parser output file is called
|
|
|
|
+<TT>`y.tab.c'</TT>, and the other outputs are called <TT>`y.output'</TT> and
|
|
|
|
+<TT>`y.tab.h'</TT>. The purpose of this switch is to imitate Yacc's output
|
|
|
|
+file name conventions. Thus, the following shell script can substitute
|
|
|
|
+for Yacc:
|
|
|
|
+<PRE>
|
|
|
|
+bison -y $*
|
|
|
|
+</PRE>
|
|
|
|
+</DL>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="SEC89" HREF="bison.html#TOC89">Option Cross Key</A></H2>
|
|
|
|
+<P>
|
|
|
|
+Here is a list of options, alphabetized by long option, to help you find
|
|
|
|
+the corresponding short option.
|
|
|
|
+<H2><A NAME="SEC90" HREF="bison.html#TOC90">Invoking Bison under VMS</A></H2>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX191"></A>
|
|
|
|
+<A NAME="IDX192"></A>
|
|
|
|
+The command line syntax for Bison on VMS is a variant of the usual
|
|
|
|
+Bison command syntax--adapted to fit VMS conventions.
|
|
|
|
+To find the VMS equivalent for any Bison option, start with the long
|
|
|
|
+option, and substitute a <SAMP>`/'</SAMP> for the leading <SAMP>`--'</SAMP>, and
|
|
|
|
+substitute a <SAMP>`_'</SAMP> for each <SAMP>`-'</SAMP> in the name of the long option.
|
|
|
|
+For example, the following invocation under VMS:
|
|
|
|
+<PRE>
|
|
|
|
+bison /debug/name_prefix=bar foo.y
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+is equivalent to the following command under POSIX.
|
|
|
|
+<PRE>
|
|
|
|
+bison --debug --name-prefix=bar foo.y
|
|
|
|
+</PRE>
|
|
|
|
+<P>
|
|
|
|
+The VMS file system does not permit filenames such as
|
|
|
|
+<TT>`foo.tab.c'</TT>. In the above example, the output file
|
|
|
|
+would instead be named <TT>`foo_tab.c'</TT>.
|
|
|
|
+<H1><A NAME="SEC91" HREF="bison.html#TOC91">Bison Symbols</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX193"></A>
|
|
|
|
+<A NAME="IDX194"></A>
|
|
|
|
+<DL COMPACT>
|
|
|
|
+<DT><CODE>error</CODE>
|
|
|
|
+<DD>
|
|
|
|
+A token name reserved for error recovery. This token may be used in
|
|
|
|
+grammar rules so as to allow the Bison parser to recognize an error in
|
|
|
|
+the grammar without halting the process. In effect, a sentence
|
|
|
|
+containing an error may be recognized as valid. On a parse error, the
|
|
|
|
+token <CODE>error</CODE> becomes the current look-ahead token. Actions
|
|
|
|
+corresponding to <CODE>error</CODE> are then executed, and the look-ahead
|
|
|
|
+token is reset to the token that originally caused the violation.
|
|
|
|
+See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT><CODE>YYABORT</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro to pretend that an unrecoverable syntax error has occurred, by
|
|
|
|
+making <CODE>yyparse</CODE> return 1 immediately. The error reporting
|
|
|
|
+function <CODE>yyerror</CODE> is not called. See section <A HREF="bison.html#SEC60">The Parser Function <CODE>yyparse</CODE></A>.
|
|
|
|
+<DT><CODE>YYACCEPT</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro to pretend that a complete utterance of the language has been
|
|
|
|
+read, by making <CODE>yyparse</CODE> return 0 immediately.
|
|
|
|
+See section <A HREF="bison.html#SEC60">The Parser Function <CODE>yyparse</CODE></A>.
|
|
|
|
+<DT><CODE>YYBACKUP</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro to discard a value from the parser stack and fake a look-ahead
|
|
|
|
+token. See section <A HREF="bison.html#SEC67">Special Features for Use in Actions</A>.
|
|
|
|
+<DT><CODE>YYERROR</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro to pretend that a syntax error has just been detected: call
|
|
|
|
+<CODE>yyerror</CODE> and then perform normal error recovery if possible
|
|
|
|
+(see section <A HREF="bison.html#SEC81">Error Recovery</A>), or (if recovery is impossible) make
|
|
|
|
+<CODE>yyparse</CODE> return 1. See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT><CODE>YYERROR_VERBOSE</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro that you define with <CODE>#define</CODE> in the Bison declarations
|
|
|
|
+section to request verbose, specific error message strings when
|
|
|
|
+<CODE>yyerror</CODE> is called.
|
|
|
|
+<DT><CODE>YYINITDEPTH</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro for specifying the initial size of the parser stack.
|
|
|
|
+See section <A HREF="bison.html#SEC80">Stack Overflow, and How to Avoid It</A>.
|
|
|
|
+<DT><CODE>YYLEX_PARAM</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro for specifying an extra argument (or list of extra arguments) for
|
|
|
|
+<CODE>yyparse</CODE> to pass to <CODE>yylex</CODE>. See section <A HREF="bison.html#SEC65">Calling Conventions for Pure Parsers</A>.
|
|
|
|
+<DT><CODE>YYLTYPE</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro for the data type of <CODE>yylloc</CODE>; a structure with four
|
|
|
|
+members. See section <A HREF="bison.html#SEC64">Textual Positions of Tokens</A>.
|
|
|
|
+<DT><CODE>YYMAXDEPTH</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro for specifying the maximum size of the parser stack.
|
|
|
|
+See section <A HREF="bison.html#SEC80">Stack Overflow, and How to Avoid It</A>.
|
|
|
|
+<DT><CODE>YYPARSE_PARAM</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro for specifying the name of a parameter that <CODE>yyparse</CODE> should
|
|
|
|
+accept. See section <A HREF="bison.html#SEC65">Calling Conventions for Pure Parsers</A>.
|
|
|
|
+<DT><CODE>YYRECOVERING</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro whose value indicates whether the parser is recovering from a
|
|
|
|
+syntax error. See section <A HREF="bison.html#SEC67">Special Features for Use in Actions</A>.
|
|
|
|
+<DT><CODE>YYSTYPE</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro for the data type of semantic values; <CODE>int</CODE> by default.
|
|
|
|
+See section <A HREF="bison.html#SEC44">Data Types of Semantic Values</A>.
|
|
|
|
+<DT><CODE>yychar</CODE>
|
|
|
|
+<DD>
|
|
|
|
+External integer variable that contains the integer value of the
|
|
|
|
+current look-ahead token. (In a pure parser, it is a local variable
|
|
|
|
+within <CODE>yyparse</CODE>.) Error-recovery rule actions may examine this
|
|
|
|
+variable. See section <A HREF="bison.html#SEC67">Special Features for Use in Actions</A>.
|
|
|
|
+<DT><CODE>yyclearin</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro used in error-recovery rule actions. It clears the previous
|
|
|
|
+look-ahead token. See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT><CODE>yydebug</CODE>
|
|
|
|
+<DD>
|
|
|
|
+External integer variable set to zero by default. If <CODE>yydebug</CODE>
|
|
|
|
+is given a nonzero value, the parser will output information on input
|
|
|
|
+symbols and parser action. See section <A HREF="bison.html#SEC86">Debugging Your Parser</A>.
|
|
|
|
+<DT><CODE>yyerrok</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Macro to cause parser to recover immediately to its normal mode
|
|
|
|
+after a parse error. See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT><CODE>yyerror</CODE>
|
|
|
|
+<DD>
|
|
|
|
+User-supplied function to be called by <CODE>yyparse</CODE> on error. The
|
|
|
|
+function receives one argument, a pointer to a character string
|
|
|
|
+containing an error message. See section <A HREF="bison.html#SEC66">The Error Reporting Function <CODE>yyerror</CODE></A>.
|
|
|
|
+<DT><CODE>yylex</CODE>
|
|
|
|
+<DD>
|
|
|
|
+User-supplied lexical analyzer function, called with no arguments
|
|
|
|
+to get the next token. See section <A HREF="bison.html#SEC61">The Lexical Analyzer Function <CODE>yylex</CODE></A>.
|
|
|
|
+<DT><CODE>yylval</CODE>
|
|
|
|
+<DD>
|
|
|
|
+External variable in which <CODE>yylex</CODE> should place the semantic
|
|
|
|
+value associated with a token. (In a pure parser, it is a local
|
|
|
|
+variable within <CODE>yyparse</CODE>, and its address is passed to
|
|
|
|
+<CODE>yylex</CODE>.) See section <A HREF="bison.html#SEC63">Semantic Values of Tokens</A>.
|
|
|
|
+<DT><CODE>yylloc</CODE>
|
|
|
|
+<DD>
|
|
|
|
+External variable in which <CODE>yylex</CODE> should place the line and
|
|
|
|
+column numbers associated with a token. (In a pure parser, it is a
|
|
|
|
+local variable within <CODE>yyparse</CODE>, and its address is passed to
|
|
|
|
+<CODE>yylex</CODE>.) You can ignore this variable if you don't use the
|
|
|
|
+<SAMP>`@'</SAMP> feature in the grammar actions. See section <A HREF="bison.html#SEC64">Textual Positions of Tokens</A>.
|
|
|
|
+<DT><CODE>yynerrs</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Global variable which Bison increments each time there is a parse
|
|
|
|
+error. (In a pure parser, it is a local variable within
|
|
|
|
+<CODE>yyparse</CODE>.) See section <A HREF="bison.html#SEC66">The Error Reporting Function <CODE>yyerror</CODE></A>.
|
|
|
|
+<DT><CODE>yyparse</CODE>
|
|
|
|
+<DD>
|
|
|
|
+The parser function produced by Bison; call this function to start
|
|
|
|
+parsing. See section <A HREF="bison.html#SEC60">The Parser Function <CODE>yyparse</CODE></A>.
|
|
|
|
+<DT><CODE>%left</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to assign left associativity to token(s).
|
|
|
|
+See section <A HREF="bison.html#SEC51">Operator Precedence</A>.
|
|
|
|
+<DT><CODE>%nonassoc</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to assign nonassociativity to token(s).
|
|
|
|
+See section <A HREF="bison.html#SEC51">Operator Precedence</A>.
|
|
|
|
+<DT><CODE>%prec</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to assign a precedence to a specific rule.
|
|
|
|
+See section <A HREF="bison.html#SEC76">Context-Dependent Precedence</A>.
|
|
|
|
+<DT><CODE>%pure_parser</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to request a pure (reentrant) parser.
|
|
|
|
+See section <A HREF="bison.html#SEC56">A Pure (Reentrant) Parser</A>.
|
|
|
|
+<DT><CODE>%right</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to assign right associativity to token(s).
|
|
|
|
+See section <A HREF="bison.html#SEC51">Operator Precedence</A>.
|
|
|
|
+<DT><CODE>%start</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to specify the start symbol. See section <A HREF="bison.html#SEC55">The Start-Symbol</A>.
|
|
|
|
+<DT><CODE>%token</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to declare token(s) without specifying precedence.
|
|
|
|
+See section <A HREF="bison.html#SEC50">Token Type Names</A>.
|
|
|
|
+<DT><CODE>%type</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to declare nonterminals. See section <A HREF="bison.html#SEC53">Nonterminal Symbols</A>.
|
|
|
|
+<DT><CODE>%union</CODE>
|
|
|
|
+<DD>
|
|
|
|
+Bison declaration to specify several possible data types for semantic
|
|
|
|
+values. See section <A HREF="bison.html#SEC52">The Collection of Value Types</A>.
|
|
|
|
+</DL>
|
|
|
|
+<P>
|
|
|
|
+These are the punctuation and delimiters used in Bison input:
|
|
|
|
+<DL COMPACT>
|
|
|
|
+<DT><SAMP>`%%'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Delimiter used to separate the grammar rule section from the
|
|
|
|
+Bison declarations section or the additional C code section.
|
|
|
|
+See section <A HREF="bison.html#SEC14">The Overall Layout of a Bison Grammar</A>.
|
|
|
|
+<DT><SAMP>`%{ %}'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+All code listed between <SAMP>`%{'</SAMP> and <SAMP>`%}'</SAMP> is copied directly
|
|
|
|
+to the output file uninterpreted. Such code forms the "C
|
|
|
|
+declarations" section of the input file. See section <A HREF="bison.html#SEC35">Outline of a Bison Grammar</A>.
|
|
|
|
+<DT><SAMP>`/*...*/'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Comment delimiters, as in C.
|
|
|
|
+<DT><SAMP>`:'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Separates a rule's result from its components. See section <A HREF="bison.html#SEC41">Syntax of Grammar Rules</A>.
|
|
|
|
+<DT><SAMP>`;'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Terminates a rule. See section <A HREF="bison.html#SEC41">Syntax of Grammar Rules</A>.
|
|
|
|
+<DT><SAMP>`|'</SAMP>
|
|
|
|
+<DD>
|
|
|
|
+Separates alternate rules for the same result nonterminal.
|
|
|
|
+See section <A HREF="bison.html#SEC41">Syntax of Grammar Rules</A>.
|
|
|
|
+</DL>
|
|
|
|
+<P>
|
|
|
|
+<H1><A NAME="SEC92" HREF="bison.html#TOC92">Glossary</A></H1>
|
|
|
|
+<P>
|
|
|
|
+<A NAME="IDX195"></A>
|
|
|
|
+<DL COMPACT>
|
|
|
|
+<DT>Backus-Naur Form (BNF)
|
|
|
|
+<DD>
|
|
|
|
+Formal method of specifying context-free grammars. BNF was first used
|
|
|
|
+in the <CITE>ALGOL-60</CITE> report, 1963. See section <A HREF="bison.html#SEC8">Languages and Context-Free Grammars</A>.
|
|
|
|
+<DT>Context-free grammars
|
|
|
|
+<DD>
|
|
|
|
+Grammars specified as rules that can be applied regardless of context.
|
|
|
|
+Thus, if there is a rule which says that an integer can be used as an
|
|
|
|
+expression, integers are allowed <EM>anywhere</EM> an expression is
|
|
|
|
+permitted. See section <A HREF="bison.html#SEC8">Languages and Context-Free Grammars</A>.
|
|
|
|
+<DT>Dynamic allocation
|
|
|
|
+<DD>
|
|
|
|
+Allocation of memory that occurs during execution, rather than at
|
|
|
|
+compile time or on entry to a function.
|
|
|
|
+<DT>Empty string
|
|
|
|
+<DD>
|
|
|
|
+Analogous to the empty set in set theory, the empty string is a
|
|
|
|
+character string of length zero.
|
|
|
|
+<DT>Finite-state stack machine
|
|
|
|
+<DD>
|
|
|
|
+A "machine" that has discrete states in which it is said to exist at
|
|
|
|
+each instant in time. As input to the machine is processed, the
|
|
|
|
+machine moves from state to state as specified by the logic of the
|
|
|
|
+machine. In the case of the parser, the input is the language being
|
|
|
|
+parsed, and the states correspond to various stages in the grammar
|
|
|
|
+rules. See section <A HREF="bison.html#SEC68">The Bison Parser Algorithm</A>.
|
|
|
|
+<DT>Grouping
|
|
|
|
+<DD>
|
|
|
|
+A language construct that is (in general) grammatically divisible;
|
|
|
|
+for example, `expression' or `declaration' in C.
|
|
|
|
+See section <A HREF="bison.html#SEC8">Languages and Context-Free Grammars</A>.
|
|
|
|
+<DT>Infix operator
|
|
|
|
+<DD>
|
|
|
|
+An arithmetic operator that is placed between the operands on which it
|
|
|
|
+performs some operation.
|
|
|
|
+<DT>Input stream
|
|
|
|
+<DD>
|
|
|
|
+A continuous flow of data between devices or programs.
|
|
|
|
+<DT>Language construct
|
|
|
|
+<DD>
|
|
|
|
+One of the typical usage schemas of the language. For example, one of
|
|
|
|
+the constructs of the C language is the <CODE>if</CODE> statement.
|
|
|
|
+See section <A HREF="bison.html#SEC8">Languages and Context-Free Grammars</A>.
|
|
|
|
+<DT>Left associativity
|
|
|
|
+<DD>
|
|
|
|
+Operators having left associativity are analyzed from left to right:
|
|
|
|
+<SAMP>`a+b+c'</SAMP> first computes <SAMP>`a+b'</SAMP> and then combines with
|
|
|
|
+<SAMP>`c'</SAMP>. See section <A HREF="bison.html#SEC71">Operator Precedence</A>.
|
|
|
|
+<DT>Left recursion
|
|
|
|
+<DD>
|
|
|
|
+A rule whose result symbol is also its first component symbol;
|
|
|
|
+for example, <SAMP>`expseq1 : expseq1 ',' exp;'</SAMP>. See section <A HREF="bison.html#SEC42">Recursive Rules</A>.
|
|
|
|
+<DT>Left-to-right parsing
|
|
|
|
+<DD>
|
|
|
|
+Parsing a sentence of a language by analyzing it token by token from
|
|
|
|
+left to right. See section <A HREF="bison.html#SEC68">The Bison Parser Algorithm</A>.
|
|
|
|
+<DT>Lexical analyzer (scanner)
|
|
|
|
+<DD>
|
|
|
|
+A function that reads an input stream and returns tokens one by one.
|
|
|
|
+See section <A HREF="bison.html#SEC61">The Lexical Analyzer Function <CODE>yylex</CODE></A>.
|
|
|
|
+<DT>Lexical tie-in
|
|
|
|
+<DD>
|
|
|
|
+A flag, set by actions in the grammar rules, which alters the way
|
|
|
|
+tokens are parsed. See section <A HREF="bison.html#SEC84">Lexical Tie-ins</A>.
|
|
|
|
+<DT>Look-ahead token
|
|
|
|
+<DD>
|
|
|
|
+A token already read but not yet shifted. See section <A HREF="bison.html#SEC69">Look-Ahead Tokens</A>.
|
|
|
|
+<DT>LALR(1)
|
|
|
|
+<DD>
|
|
|
|
+The class of context-free grammars that Bison (like most other parser
|
|
|
|
+generators) can handle; a subset of LR(1). See section <A HREF="bison.html#SEC79">Mysterious Reduce/Reduce Conflicts</A>.
|
|
|
|
+<DT>LR(1)
|
|
|
|
+<DD>
|
|
|
|
+The class of context-free grammars in which at most one token of
|
|
|
|
+look-ahead is needed to disambiguate the parsing of any piece of input.
|
|
|
|
+<DT>Nonterminal symbol
|
|
|
|
+<DD>
|
|
|
|
+A grammar symbol standing for a grammatical construct that can
|
|
|
|
+be expressed through rules in terms of smaller constructs; in other
|
|
|
|
+words, a construct that is not a token. See section <A HREF="bison.html#SEC40">Symbols, Terminal and Nonterminal</A>.
|
|
|
|
+<DT>Parse error
|
|
|
|
+<DD>
|
|
|
|
+An error encountered during parsing of an input stream due to invalid
|
|
|
|
+syntax. See section <A HREF="bison.html#SEC81">Error Recovery</A>.
|
|
|
|
+<DT>Parser
|
|
|
|
+<DD>
|
|
|
|
+A function that recognizes valid sentences of a language by analyzing
|
|
|
|
+the syntax structure of a set of tokens passed to it from a lexical
|
|
|
|
+analyzer.
|
|
|
|
+<DT>Postfix operator
|
|
|
|
+<DD>
|
|
|
|
+An arithmetic operator that is placed after the operands upon which it
|
|
|
|
+performs some operation.
|
|
|
|
+<DT>Reduction
|
|
|
|
+<DD>
|
|
|
|
+Replacing a string of nonterminals and/or terminals with a single
|
|
|
|
+nonterminal, according to a grammar rule. See section <A HREF="bison.html#SEC68">The Bison Parser Algorithm</A>.
|
|
|
|
+<DT>Reentrant
|
|
|
|
+<DD>
|
|
|
|
+A reentrant subprogram is a subprogram which can be in invoked any
|
|
|
|
+number of times in parallel, without interference between the various
|
|
|
|
+invocations. See section <A HREF="bison.html#SEC56">A Pure (Reentrant) Parser</A>.
|
|
|
|
+<DT>Reverse polish notation
|
|
|
|
+<DD>
|
|
|
|
+A language in which all operators are postfix operators.
|
|
|
|
+<DT>Right recursion
|
|
|
|
+<DD>
|
|
|
|
+A rule whose result symbol is also its last component symbol;
|
|
|
|
+for example, <SAMP>`expseq1: exp ',' expseq1;'</SAMP>. See section <A HREF="bison.html#SEC42">Recursive Rules</A>.
|
|
|
|
+<DT>Semantics
|
|
|
|
+<DD>
|
|
|
|
+In computer languages, the semantics are specified by the actions
|
|
|
|
+taken for each instance of the language, i.e., the meaning of
|
|
|
|
+each statement. See section <A HREF="bison.html#SEC43">Defining Language Semantics</A>.
|
|
|
|
+<DT>Shift
|
|
|
|
+<DD>
|
|
|
|
+A parser is said to shift when it makes the choice of analyzing
|
|
|
|
+further input from the stream rather than reducing immediately some
|
|
|
|
+already-recognized rule. See section <A HREF="bison.html#SEC68">The Bison Parser Algorithm</A>.
|
|
|
|
+<DT>Single-character literal
|
|
|
|
+<DD>
|
|
|
|
+A single character that is recognized and interpreted as is.
|
|
|
|
+See section <A HREF="bison.html#SEC9">From Formal Rules to Bison Input</A>.
|
|
|
|
+<DT>Start symbol
|
|
|
|
+<DD>
|
|
|
|
+The nonterminal symbol that stands for a complete valid utterance in
|
|
|
|
+the language being parsed. The start symbol is usually listed as the
|
|
|
|
+first nonterminal symbol in a language specification.
|
|
|
|
+See section <A HREF="bison.html#SEC55">The Start-Symbol</A>.
|
|
|
|
+<DT>Symbol table
|
|
|
|
+<DD>
|
|
|
|
+A data structure where symbol names and associated data are stored
|
|
|
|
+during parsing to allow for recognition and use of existing
|
|
|
|
+information in repeated uses of a symbol. See section <A HREF="bison.html#SEC29">Multi-Function Calculator: <CODE>mfcalc</CODE></A>.
|
|
|
|
+<DT>Token
|
|
|
|
+<DD>
|
|
|
|
+A basic, grammatically indivisible unit of a language. The symbol
|
|
|
|
+that describes a token in the grammar is a terminal symbol.
|
|
|
|
+The input of the Bison parser is a stream of tokens which comes from
|
|
|
|
+the lexical analyzer. See section <A HREF="bison.html#SEC40">Symbols, Terminal and Nonterminal</A>.
|
|
|
|
+<DT>Terminal symbol
|
|
|
|
+<DD>
|
|
|
|
+A grammar symbol that has no rules in the grammar and therefore
|
|
|
|
+is grammatically indivisible. The piece of text it represents
|
|
|
|
+is a token. See section <A HREF="bison.html#SEC8">Languages and Context-Free Grammars</A>.
|
|
|
|
+</DL>
|
|
|
|
+<P>
|
|
|
|
+<H1><A NAME="SEC93" HREF="bison.html#TOC93">Index</A></H1>
|
|
|
|
+<P>
|
|
|
|
+Jump to:
|
|
|
|
+<A HREF="#$">$</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#%">%</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#@">@</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#a">a</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#b">b</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#c">c</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#d">d</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#e">e</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#f">f</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#g">g</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#i">i</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#l">l</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#m">m</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#n">n</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#o">o</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#p">p</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#r">r</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#s">s</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#t">t</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#u">u</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#v">v</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#w">w</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#y">y</A>
|
|
|
|
+-
|
|
|
|
+<A HREF="#|">|</A>
|
|
|
|
+<P>
|
|
|
|
+<H2><A NAME="$">$</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX80">$$</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX81">$<VAR>n</VAR></A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="%">%</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX105">%expect</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX155">%left</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX157">%nonassoc</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX162">%prec</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX112">%pure_parser</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX156">%right</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX109">%start</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX91">%token</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX100">%type</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX97">%union</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="@">@</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX139">@<VAR>n</VAR></A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="a">a</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX79">action</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX83">action data types</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX135">action features summary</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX85">actions in mid-rule</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX17">actions, semantic</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX56">additional C code section</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX141">algorithm of parser</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX154">associativity</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="b">b</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX5">Backus-Naur form</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX113">Bison declaration summary</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX88">Bison declarations</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX52">Bison declarations (introduction)</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX11">Bison grammar</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX189">Bison invocation</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX18">Bison parser</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX140">Bison parser algorithm</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX193">Bison symbols, table of</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX19">Bison utility</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX4">BNF</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="c">c</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX57">C code, section for additional</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX50">C declarations section</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX116">C-language interface</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX42"><CODE>calc</CODE></A>
|
|
|
|
+<LI><A HREF="bison.html#IDX43">calculator, infix notation</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX47">calculator, multi-function</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX33">calculator, simple</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX62">character token</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX40">compiling the parser</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX148">conflicts</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX167">conflicts, reduce/reduce</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX104">conflicts, suppressing warnings of</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX158">context-dependent precedence</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX2">context-free grammar</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX36">controlling function</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="d">d</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX150">dangling <CODE>else</CODE></A>
|
|
|
|
+<LI><A HREF="bison.html#IDX84">data types in actions</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX77">data types of semantic values</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX185">debugging</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX114">declaration summary</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX87">declarations, Bison</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX53">declarations, Bison (introduction)</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX51">declarations, C</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX93">declaring operator precedence</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX106">declaring the start symbol</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX89">declaring token type names</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX95">declaring value types</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX98">declaring value types, nonterminals</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX82">default action</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX78">default data type</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX174">default stack limit</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX108">default start symbol</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX73">defining language semantics</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="e">e</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX151"><CODE>else</CODE>, dangling</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX178">error</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX176">error recovery</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX44">error recovery, simple</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX128">error reporting function</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX38">error reporting routine</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX29">examples, simple</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX49">exercises</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="f">f</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX25">file format</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX163">finite-state machine</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX13">formal grammar</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX26">format of grammar file</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="g">g</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX195">glossary</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX24">grammar file</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX66">grammar rule syntax</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX54">grammar rules section</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX12">grammar, Bison</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX3">grammar, context-free</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX9">grouping, syntactic</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="i">i</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX41">infix notation calculator</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX117">interface</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX1">introduction</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX188">invoking Bison</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX191">invoking Bison under VMS</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="l">l</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX169">LALR(1)</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX74">language semantics, defining</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX27">layout of Bison grammar</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX70">left recursion</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX122">lexical analyzer</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX20">lexical analyzer, purpose</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX35">lexical analyzer, writing</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX182">lexical tie-in</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX63">literal token</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX146">look-ahead token</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX168">LR(1)</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="m">m</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX37">main function in simple example</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX46"><CODE>mfcalc</CODE></A>
|
|
|
|
+<LI><A HREF="bison.html#IDX86">mid-rule actions</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX45">multi-function calculator</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX72">mutual recursion</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="n">n</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX58">nonterminal symbol</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="o">o</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX152">operator precedence</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX94">operator precedence, declaring</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX190">options for invoking Bison</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX172">overflow of parser stack</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="p">p</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX130">parse error</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX21">parser</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX144">parser stack</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX171">parser stack overflow</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX164">parser state</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX31">polish notation calculator</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX92">precedence declarations</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX153">precedence of operators</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX160">precedence, context-dependent</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX161">precedence, unary operator</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX102">preventing warnings about conflicts</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX111">pure parser</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="r">r</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX177">recovery from errors</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX69">recursive rule</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX166">reduce/reduce conflict</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX143">reduction</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX110">reentrant parser</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX30">reverse polish notation</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX71">right recursion</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX32"><CODE>rpcalc</CODE></A>
|
|
|
|
+<LI><A HREF="bison.html#IDX65">rule syntax</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX55">rules section for grammar</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX39">running Bison (introduction)</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="s">s</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX16">semantic actions</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX14">semantic value</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX75">semantic value type</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX149">shift/reduce conflicts</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX142">shifting</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX28">simple examples</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX64">single-character literal</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX170">stack overflow</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX145">stack, parser</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX22">stages in using Bison</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX10">start symbol</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX107">start symbol, declaring</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX165">state (of parser)</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX134">summary, action features</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX115">summary, Bison declaration</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX101">suppressing conflict warnings</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX61">symbol</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX48">symbol table example</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX6">symbols (abstract)</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX194">symbols in Bison, table of</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX8">syntactic grouping</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX131">syntax error</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX67">syntax of grammar rules</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="t">t</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX59">terminal symbol</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX7">token</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX60">token type</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX90">token type names, declaring</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX186">tracing the parser</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="u">u</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX159">unary operator precedence</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX23">using Bison</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="v">v</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX76">value type, semantic</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX96">value types, declaring</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX99">value types, nonterminals, declaring</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX15">value, semantic</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX192">VMS</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="w">w</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX103">warnings, preventing</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX34">writing a lexical analyzer</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="y">y</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX120">YYABORT</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX119">YYACCEPT</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX136">YYBACKUP</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX147">yychar</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX180">yyclearin</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX183">YYDEBUG</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX184">yydebug</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX137">YYEMPTY</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX179">yyerrok</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX129">yyerror</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX138">YYERROR</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX132">YYERROR_VERBOSE</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX175">YYINITDEPTH</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX121">yylex</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX127">YYLEX_PARAM</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX124">yylloc</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX125">YYLTYPE</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX123">yylval</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX173">YYMAXDEPTH</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX133">yynerrs</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX118">yyparse</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX126">YYPARSE_PARAM</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX187">YYPRINT</A>
|
|
|
|
+<LI><A HREF="bison.html#IDX181">YYRECOVERING</A>
|
|
|
|
+</DIR>
|
|
|
|
+<H2><A NAME="|">|</A></H2>
|
|
|
|
+<DIR>
|
|
|
|
+<LI><A HREF="bison.html#IDX68">|</A>
|
|
|
|
+</DIR>
|
|
|
|
+<P><HR><P>
|
|
|
|
+This document was generated on 2 October 1998 using the
|
|
|
|
+<A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>
|
|
|
|
+translator version 1.52.</P>
|
|
|
|
+</BODY>
|
|
|
|
+</HTML>
|