Operator-precedence parser

<h2 id="relationship-to-other-parsers">Relationship to other parsers</h2>
An operator-precedence parser is a simple <a href="/facts/Shift-reduce_parser/rQyVrMQm">shift-reduce parser</a> that is capable of parsing a subset of <a href="/facts/LR_parser/bpMod8K0">LR(1)</a> grammars. More precisely, the operator-precedence parser can parse all LR(1) grammars where two consecutive <a href="/facts/Nonterminal/3BLz2wJU">nonterminals</a> and <a href="/facts/Empty_string/T7udJlmQ">epsilon</a> never appear in the right-hand side of any rule.
Operator-precedence parsers are not used often in practice; however they do have some properties that make them useful within a larger design. First, they are simple enough to write by hand, which is not generally the case with more sophisticated right shift-reduce parsers. Second, they can be written to consult an operator table at <a href="/facts/Run_time_(program_lifecycle_phase)/lCxKsrzB">run time</a>, which makes them suitable for languages that can add to or change their operators while parsing. (An example is <a href="/facts/Haskell_(programming_language)/4Htv9WLu">Haskell</a>, which allows user-defined infix operators with custom associativity and precedence; consequently, an operator-precedence parser must be run on the program after parsing of all referenced modules.)
<a href="/facts/Raku_(programming_language)/9eYW7vRJ">Raku</a> sandwiches an operator-precedence parser between two <a href="/facts/Recursive_descent_parser/ARhcuAv1">recursive descent parsers</a> in order to achieve a balance of speed and dynamism. <a href="/facts/GNU_Compiler_Collection/t07jh01k">GCC</a>'s C and C++ parsers, which are hand-coded recursive descent parsers, are both sped up by an operator-precedence parser that can quickly examine arithmetic expressions. Operator-precedence parsers are also embedded within <a href="/facts/Compiler-compiler/Ud51JPrv">compiler-compiler</a>-generated parsers to noticeably speed up the recursive descent approach to expression parsing.<a class="footnote-ref" id="fnref:1" href="#fn:1">1</a>

<h2 id="precedence-climbing-method">Precedence climbing method</h2>
The precedence climbing method is a compact, efficient, and flexible algorithm for parsing expressions that was first described by Martin Richards and Colin Whitby-Strevens.<a class="footnote-ref" id="fnref:2" href="#fn:2">2</a>
An infix-notation expression grammar in <a href="/facts/EBNF/89KI2QTe">EBNF</a> format will usually look like this:

expression ::= equality-expression
equality-expression ::= additive-expression ( ( '==' | '!=' ) additive-expression ) *
additive-expression ::= multiplicative-expression ( ( '+' | '-' ) multiplicative-expression ) *
multiplicative-expression ::= primary ( ( '*' | '/' ) primary ) *
primary ::= '(' expression ')' | NUMBER | VARIABLE | '-' primary

With many levels of precedence, implementing this grammar with a predictive recursive-descent parser can become inefficient. Parsing a number, for example, can require five function calls: one for each non-terminal in the grammar until reaching primary.
An operator-precedence parser can do the same more efficiently.<a class="footnote-ref" id="fnref:3" href="#fn:3">3</a> The idea is that we can left associate the arithmetic operations as long as we find operators with the same precedence, but we have to save a temporary result to evaluate higher precedence operators. The algorithm that is presented here does not need an explicit stack; instead, it uses recursive calls to implement the stack.
The algorithm is not a pure operator-precedence parser like the Dijkstra shunting yard algorithm. It assumes that the primary nonterminal is parsed in a separate subroutine, like in a recursive descent parser.

<h3>Pseudocode</h3>
The pseudocode for the algorithm is as follows. The parser starts at function parse_expression. Precedence levels are greater than or equal to 0.

parse_expression()
 return parse_expression_1(parse_primary(), 0)

parse_expression_1(lhs, min_precedence)
 lookahead := peek next token
 while lookahead is a binary operator whose precedence is >= min_precedence
 op := lookahead
 advance to next token
 rhs := parse_primary ()
 lookahead := peek next token
 while lookahead is a binary operator whose precedence is greater
 than op's, or a right-associative operator
 whose precedence is equal to op's
 rhs := parse_expression_1 (rhs, precedence of op + (1 if lookahead precedence is greater, else 0))
 lookahead := peek next token
 lhs := the result of applying op with operands lhs and rhs
 return lhs

Note that in the case of a production rule like this (where the operator can only appear once):

equality-expression ::= additive-expression ( '==' | '!=' ) additive-expression

the algorithm must be modified to accept only binary operators whose precedence is > min_precedence.

<h3>Example execution of the algorithm</h3>
An example execution on the expression 2 + 3 * 4 + 5 == 19 is as follows. We give precedence 0 to equality expressions, 1 to additive expressions, 2 to multiplicative expressions.
parse_expression_1 (lhs = 2, min_precedence = 0)

<ul><li>the lookahead token is +, with precedence 1. the outer while loop is entered.</li>
<li>op is + (precedence 1) and the input is advanced</li>
<li>rhs is 3</li>
<li>the lookahead token is *, with precedence 2. the inner while loop is entered.parse_expression_1 (lhs = 3, min_precedence = 2)</li></ul>
<ul><li>the lookahead token is *, with precedence 2. the outer while loop is entered.</li></ul>
<ul><li>op is * (precedence 2) and the input is advanced</li>
<li>rhs is 4</li>
<li>the next token is +, with precedence 1. the inner while loop is not entered.</li>
<li>lhs is assigned 3*4 = 12</li>
<li>the next token is +, with precedence 1. the outer while loop is left.</li></ul>
<ul><li>12 is returned.</li></ul>
<ul><li>the lookahead token is +, with precedence 1. the inner while loop is not entered.</li>
<li>lhs is assigned 2+12 = 14</li>
<li>the lookahead token is +, with precedence 1. the outer while loop is not left.</li>
<li>op is + (precedence 1) and the input is advanced</li>
<li>rhs is 5</li>
<li>the next token is ==, with precedence 0. the inner while loop is not entered.</li>
<li>lhs is assigned 14+5 = 19</li>
<li>the next token is ==, with precedence 0. the outer while loop is not left.</li>
<li>op is == (precedence 0) and the input is advanced</li>
<li>rhs is 19</li>
<li>the next token is end-of-line, which is not an operator. the inner while loop is not entered.</li>
<li>lhs is assigned the result of evaluating 19 == 19, for example 1 (as in the C standard).</li>
<li>the next token is end-of-line, which is not an operator. the outer while loop is left.</li></ul>
1 is returned.

<h2 id="pratt-parsing">Pratt parsing</h2>

Another precedence parser known as Pratt parsing was first described by <a href="/facts/Vaughan_Pratt/w8XlQrpl">Vaughan Pratt</a> in the 1973 paper "Top Down Operator Precedence",<a class="footnote-ref" id="fnref:4" href="#fn:4">4</a> based on <a href="/facts/Recursive_descent_parser/ARhcuAv1">recursive descent</a>. Though it predates precedence climbing, it can be viewed as a generalization of precedence climbing.<a class="footnote-ref" id="fnref:5" href="#fn:5">5</a>
Pratt designed the parser originally to implement the <a href="/facts/CGOL/beelnsym">CGOL</a> programming language, and it was treated in much more depth in a Masters Thesis under his supervision.<a class="footnote-ref" id="fnref:6" href="#fn:6">6</a>
Tutorials and implementations:

<ul><li><a href="/facts/Douglas_Crockford/wIFvJkte">Douglas Crockford</a> based the JavaScript parser in <a href="/facts/JSLint/5qjrSTcX">JSLint</a> on Pratt parsing.<a class="footnote-ref" id="fnref:7" href="#fn:7">7</a></li>
<li>Comparison between Python implementations of precedence climbing and Pratt parsing: <a href="http://www.oilshell.org/blog/2016/11/01.html">"Pratt Parsing and Precedence Climbing Are the Same Algorithm" (2016) by Andy Chu</a></li>
<li>Tutorial using <a href="/facts/Rust_(programming_language)/8JNMV19F">Rust</a>: <a href="https://matklad.github.io/2020/04/13/simple-but-powerful-pratt-parsing.html">"Simple but Powerful Pratt Parsing" (2020) by Aleksey Kladov</a></li>
<li>Tutorial using <a href="/facts/Rust_(programming_language)/8JNMV19F">Rust</a>: <a href="https://williamr.dev/posts/pratt-parsing/">"The Pratt Parsing Technique" (2024) by William Rågstad</a></li>
<li>Tutorial using <a href="/facts/Python_(programming_language)/YbuGqofa">Python</a>: <a href="http://effbot.org/zone/simple-top-down-parsing.htm">"Simple Top-Down Parsing in Python" (2008) by Fredrik Lundh</a> <a href="https://web.archive.org/web/20150228044653/http://effbot.org/zone/simple-top-down-parsing.htm">Archived</a> 2015-02-28 at the <a href="/facts/Wayback_Machine/nmQ3a6JC">Wayback Machine</a></li>
<li>Tutorial using <a href="/facts/Java_(programming_language)/9ScgFyAL">Java</a>: <a href="http://journal.stuffwithstuff.com/2011/03/19/pratt-parsers-expression-parsing-made-easy/">"Pratt Parsers: Expression Parsing Made Easy" (2011) by Bob Nystrom, author of Crafting Interpreters</a></li>
<li>Implementation in <a href="/facts/C_Sharp_(programming_language)/UC2gxeyb">C#</a>: <a href="https://github.com/atifaziz/Gratt">"Gratt: A Generic Vaughn Pratt's top-down operator precedence parser for .NET Standard"</a> (a <a href="/facts/Generic_programming/kqtqJk7p">generic</a> version inspired by the Java implementation presented by Bob Nystrom in <a href="http://journal.stuffwithstuff.com/2011/03/19/pratt-parsers-expression-parsing-made-easy/">"Pratt Parsers: Expression Parsing Made Easy"</a>)</li></ul>
<h2 id="alternative-methods">Alternative methods</h2>
There are other ways to apply operator precedence rules. One is to build a tree of the original expression and then apply tree rewrite rules to it.
Such trees do not necessarily need to be implemented using data structures conventionally used for trees. Instead, tokens can be stored in flat structures, such as tables, by simultaneously building a priority list which states what elements to process in which order.

<h3>Full parenthesization</h3>
Another approach is to first fully parenthesize the expression, inserting a number of parentheses around each operator, such that they lead to the correct precedence even when parsed with a linear, left-to-right parser. This algorithm was used in the early <a href="/facts/Fortran/m1KqjcMU">FORTRAN I</a> compiler:<a class="footnote-ref" id="fnref:8" href="#fn:8">8</a>

<blockquote>
The Fortran I compiler would expand each operator with a sequence of parentheses. In a simplified form of the algorithm, it would

<ul><li>replace + and – with ))+(( and ))-((, respectively;</li>
<li>replace * and / with )*( and )/(, respectively;</li>
<li>add (( at the beginning of each expression and after each left parenthesis in the original expression; and</li>
<li>add )) at the end of the expression and before each right parenthesis in the original expression.</li></ul>
Although not obvious, the algorithm was correct, and, in the words of <a href="/facts/Donald_Knuth/GozNzDM6">Knuth</a>, “The resulting formula is properly parenthesized, believe it or not.”<a class="footnote-ref" id="fnref:9" href="#fn:9">9</a>

</blockquote>

Example code of a simple C application that handles parenthesisation of basic math operators (+, -, *, /, ^, ( and )):

#include <stdio.h>
#include <string.h>

// The command-line argument boundary is our lexer.
int main(int argc, char *argv[]) {
  int i;
  printf("((((");
  for (i=1; i!=argc; i++) {
    // strlen(argv[i]) == 2
    if (argv[i] && !argv[i][1]) {
      switch (*argv[i]) {
          case '(': printf("((((");  continue;
          case ')': printf("))))");  continue;
          case '^': printf(")^(");   continue;
          case '*': printf("))*(("); continue;
          case '/': printf("))/(("); continue;
          case '+':
            // unary check: either first or had an operator expecting secondary argument
            if (i == 1 || strchr("(^*/+-", *argv[i-1]))
              printf("+");
            else
              printf(")))+(((");
            continue;
          case '-':
            if (i == 1 || strchr("(^*/+-", *argv[i-1]))
              printf("-");
            else
              printf(")))-(((");
            continue;
      }
    }
    printf("%s", argv[i]);
  }
  printf("))))\n");
  return 0;
}

First, you need to compile your program. Assuming your program is written in C and the source code is in a file named program.c, you would use the following command:

gcc program.c -o program
The above command tells gcc to compile program.c and create an executable named program.
Command to run the program with parameters, For example; a * b + c ^ d / e

./program a '*' b + c '^' d / e
it produces

((((a))*((b)))+(((c)^(d))/((e))))
as output on the console.
A limitation to this strategy is that unary operators must all have higher precedence than infix operators. The "negative" operator in the above code has a higher precedence than exponentiation. Running the program with this input

- a ^ 2
produces this output

((((-a)^(2))))
which is probably not what is intended.

<h2 id="external-links">External links</h2>
<ul><li>Clarke, Keith (1992-05-26). <a href="https://groups.google.com/group/comp.compilers/browse_thread/thread/aee24b9504d527ca/1210ef8ae529accd#1210ef8ae529accd">"Re: compact recursive-descent parsing of expressions"</a>. Retrieved 2012-01-24.</li>
<li><a href="https://groups.google.com/group/comp.compilers/browse_thread/thread/442ca111b2dfb38d/5390237263b3625b#5390237263b3625b">Example C++ code by Keith Clarke for parsing infix expressions using the precedence climbing method</a></li>
<li><a href="/facts/Klaus_Samelson/l2JMyT6d">Samelson, Klaus</a>; <a href="/facts/Friedrich_L._Bauer/JlesFToV">Friedrich L. Bauer</a> (February 1960). <a href="https://doi.org/10.1145%2F366959.366968">"Sequential formula translation"</a>. Communications of the ACM. 3 (2): 76–83. <a href="/facts/Doi_(identifier)/muM9Etpq">doi</a>:<a href="https://doi.org/10.1145%2F366959.366968">10.1145/366959.366968</a>.</li>
<li><a href="https://web.archive.org/web/20160817143616/http://radovan-augustin.info/techpapers/parser/Parser.pdf">Parser for expression with infix notation using precedence lists</a></li></ul>

<h2 id="references">References</h2>

<ol>
<li id="fn:1">Harwell, Sam (2008-08-29). "Operator precedence parser". ANTLR3 Wiki. Retrieved 2017-10-25. <a href="https://theantlrguy.atlassian.net/wiki/spaces/ANTLR3/pages/2687077/Operator+precedence+parser" target="_blank">https://theantlrguy.atlassian.net/wiki/spaces/ANTLR3/pages/2687077/Operator+precedence+parser</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></li>
<li id="fn:2">Richards, Martin; Whitby-Strevens, Colin (1979). BCPL — the language and its compiler. Cambridge University Press. ISBN 9780521219655. <a href="9780521219655" target="_blank">9780521219655</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></li>
<li id="fn:3">Harwell, Sam (2008-08-29). "Operator precedence parser". ANTLR3 Wiki. Retrieved 2017-10-25. <a href="https://theantlrguy.atlassian.net/wiki/spaces/ANTLR3/pages/2687077/Operator+precedence+parser" target="_blank">https://theantlrguy.atlassian.net/wiki/spaces/ANTLR3/pages/2687077/Operator+precedence+parser</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></li>
<li id="fn:4">Pratt, Vaughan. "Top Down Operator Precedence." Proceedings of the 1st Annual ACM SIGACT-SIGPLAN Symposium on Principles of Programming Languages (1973). <a href="https://web.archive.org/web/20151223215421/http://hall.org.ua/halls/wizzard/pdf/Vaughan.Pratt.TDOP.pdf" target="_blank">https://web.archive.org/web/20151223215421/http://hall.org.ua/halls/wizzard/pdf/Vaughan.Pratt.TDOP.pdf</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></li>
<li id="fn:5">Norvell, Theodore. "Parsing Expressions by Recursive Descent". www.engr.mun.ca. The purpose of this post is to [... start] with precedence climbing and refactoring it to use the command pattern until we arrive at a Pratt parser. [This is the author who coined the term "precedence climbing".] <a href="http://www.engr.mun.ca/~theo/Misc/pratt_parsing.htm" target="_blank">http://www.engr.mun.ca/~theo/Misc/pratt_parsing.htm</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></li>
<li id="fn:6">Van De Vanter, Michael L. "A Formalization and Correctness Proof of the CGOL Language System." (Master's Thesis). MIT Laboratory for Computer Science Technical Report MIT-LCS-TR-147 (Cambridge, Massachusetts). 1975. <a href="http://publications.csail.mit.edu/lcs/specpub.php?id=715" target="_blank">http://publications.csail.mit.edu/lcs/specpub.php?id=715</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></li>
<li id="fn:7">Crockford, D (2007-02-21). "Top Down Operator Precedence". <a href="http://crockford.com/javascript/tdop/tdop.html" target="_blank">http://crockford.com/javascript/tdop/tdop.html</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></li>
<li id="fn:8">Padua, David (2000). "The Fortran I Compiler" (PDF). Computing in Science & Engineering. 2 (1): 70–75. Bibcode:2000CSE.....2a..70P. doi:10.1109/5992.814661. <a href="http://polaris.cs.uiuc.edu/publications/c1070.pdf" target="_blank">http://polaris.cs.uiuc.edu/publications/c1070.pdf</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></li>
<li id="fn:9">Knuth, Donald E. (1962). "A HISTORY OF WRITING COMPILERS". Computers and Automation. 11 (12). Edmund C. Berkeley: 8–14. <a href="https://archive.org/details/bitsavers_computersA_13990695" target="_blank">https://archive.org/details/bitsavers_computersA_13990695</a> <a href="#fnref:9" class="footnote-back-ref">↩</a></li>
</ol>

Operator-precedence parser open-in-new

Operator-precedence parser