# Mixfix Operators & Parser Combinators, Bonus Part 2a

This is a short bonus post in the Mixfix Operator series. Part 1 was an introduction to mixfix operators and in part 2 we looked at them more closely in the context of a grammar for a boolean algebra and arithmetic language. The implementation of a parser for the language is coming next, but before that I thought it would be interesting to see what the grammar would look like if we removed the mixfix abstraction and mechanically converted the precedence graph to BNF notation.

It turns out this is not that hard if we turn each operator group (graph node) into a separate production and leave out the irrelevant productions for the types of operators we don’t have in those groups. This is especially easy in our case since we only have the same types of operators in each group. I’ll use shorthand names here for brevity.

``` expr ::= or | and | not | eq | cmp        | add | mul | exp | neg | tightest```

``` or   ::= (or | or↑) "|" or↑ or↑  ::= and | not | eq | cmp | tightest and  ::= (and | and↑) "&" and↑ and↑ ::= not | eq | cmp | tightest not  ::= "!" (not | not↑) not↑ ::= eq | cmp | tightest eq   ::= (eq | eq↑) ("=" | "≠") eq↑ eq↑  ::= cmp | add | mul | exp | neg | tightest cmp  ::= (cmp | cmp↑) ("<" | ">") cmp↑ cmp↑ ::= add | mul | exp | neg | tightest add  ::= (add | add↑) ("+" | "-") add↑ add↑ ::= mul | exp | neg | tightest mul  ::= (mul | mul↑) ("*" | "/" | "mod") mul↑ mul↑ ::= exp | neg | tightest exp  ::= (exp | exp↑) "^" exp↑ exp↑ ::= neg | tightest neg  ::= "-" (neg | neg↑) neg↑ ::= tightest ```

```tightest := ("(" expr ")") | value ```

To be honest, encoding the whole graph as BNF is a lot simpler than I initially thought, and so is translating this into a combinator parser. It makes me think whether the mixfix grammar abstraction could be overkill. Of course, this is so easy only because we have relatively few different operators: only left-associative infix, prefix and closed. If we had more operators, with more holes in them, and different types of operators in one group (which is probably not usual, though), perhaps we wouldn’t find the conversion to be that simple any more.

Plainly this simplified scheme won’t help much with user-defined operators and precedence, so I think the mixfix parser abstraction is still useful. However, in cases where there are only a few operators/operator groups, maybe the straightforward translation of this BNF form into parser combinators is preferable. If there’s room left in the next post, I’ll include an alternative implementation based on this scheme.

# Mixfix Operators & Parser Combinators, Part 2

In the previous post I introduced the notion of mixfix operators. In this post we will look at them more closely, in the context of an actual grammar. In the next part we will implement the parser for this grammar, look at performance issues and try to fix them with packrat parsers.

We will implement a simple language that consists of boolean algebra and integer arithmetic expressions. The grammar for the language looks like the following (we’re only considering tokens here and assume that a lexical parser has already identified literals, identifiers and delimiters in the text)

```statement   ::= expression | declaration declaration ::= variable ":=" expression expression  ::= ??? | value value       ::= literal | variable literal     ::= booleanLiteral | integerLiteral variable    ::= identifier```

What should the expression productions look like, though? In examples of parsers and grammars we can commonly find an arithmetic expression language described with concepts of ‘factor’ and ‘term’ to create a precedence relation between addition and multiplication:

```expression ::= (term "+")* term term       ::= (factor "*")* factor factor     ::= constant | variable                | "(" expression ")"```

This seems simple, but when we add more precedence rules, it can get quite complex, especially if we are writing a parser for a general purpose programming language instead of a simple expression language, and we also do semantic actions (create AST nodes) in the parser. This also makes the set of operators rather fixed: you might have to change several grammar productions to add a new operator with a new precedence level. I didn’t even try building Slang’s precedence rules into the grammar in this fashion.

Mixfix parsers still make the precedence part of the grammar, but there is a layer of abstraction there: we describe operators and their precedence rules as a directed graph, where (groups of) operators are the nodes and precedences are the edges. Then we instantiate the grammar with that particular precedence graph.

Before getting to the precedence rules in the language we are about to create, lets look at the operators it will have. In the list below, `_` means a hole in the expression that can contain any other expression that “binds tighter” than the operator in question. In the case where the hole is closed on both left and right, it can contain any expression at all. Only a pair of parentheses forms a closed operator in this language.

`( _ )` – parentheses
`_ + _` – addition
`_ - _` – subtraction
`  - _` – negation
`_ * _` – multiplication
`_ / _` – division
`_ ^ _` – exponent
`_ mod _` – modulo/remainder
`_ = _` – equality test
`_ ≠ _` – inequality test
`_ < _` – less than
`_ > _` – greater than
`_ & _` – conjunction
`_ | _` – disjunction
`  ! _` – logical not

This doesn’t include many common operators in real programming languages, but it is enough to demonstrate some interesting aspects of mixfix operators and using a DAG to describe their precedence relations. I used `mod` instead of `%` to show that operators don’t have to be symbols.

Before defining the precedence rules, lets look at some sample expressions and how we want them to be interpreted, mostly sticking with existing well known precedence rules, such as those in C, Java or Scala, but occasionally deviating from them:

```a + b * c      = a + (b * c) a < b & b < c  = (a < b) & (b < c) -5 ^ 6         = (-5) ^ 6 a & !b | c     = (a & (!b)) | c 5 < 2 ≠ 6 > 3  = (5 < 2) ≠ (6 > 3) 1 < x & !x > 5 = (1 < x) & !(x > 5)```

I think that’s enough examples for now. Lets try to describe the rules behind these somewhat intuitive expectations as a precedence graph. First, we’ll put the operators into groups where all operators in one group bind just as tightly as the others in the same group. For example `1 + 2 - 3` will be `(1 + 2) - 3` and `1 - 2 + 3` will be `(1 - 2) + 3`

```parentheses   : () negation      : - (prefix) exponent      : ^ multiplication: *, /, mod addition      : +, - comparison    : <, > equality      : =, ≠ not           : ! (prefix) and           : & or            : |```

Negation (prefix `-`) is in it’s own group so that we can do: `-2 + 1`. If it was in the same group with infix `-` and `+`, then it couldn’t appear next to them without parentheses because prefix operators are treated as right-associative, but most infix operators, such as `-` and `+` are left-associative. And we can’t mix left-associative and right-associative operators of the same precedence level! Why? Take the expression

`1 + 2 - 3`

If `+` and `-` are left-associatve, it means `(1 + 2) - 3`.

If `-` is right-associative instead, then both `(1 + 2) - 3` and `1 + (2 - 3)` would be right!

We could read the list of operator groups above as an order of precedence, where the first group (`parentheses`) binds tightest and the last group (`or`) binds least tight. This would be mostly compatible with many programming languages and we would have a good enough set of precedence rules right there.

However, as mentioned earlier, Danielsson’s mixfix grammar scheme describes precedence relations as a directed graph. Each of the groups above is a node in the graph, and a directed edge from one node to another `a -> b` means: `b binds tighter than a`. So lets describe these relations as a graph instead — it will be in reverse order compared to the above list where we started from the most tightly binding:

``````or             -> and, not, equality, comparison, parentheses
and            -> not, equality, comparison, parentheses
not            -> equality, comparison, parentheses

equality       -> comparison, addition, multiplication, exponent, negation, parentheses
comparison     -> addition, multiplication, exponent, negation, parentheses

addition       -> multiplication, exponent, negation, parentheses
multiplication -> exponent, negation, parentheses
exponent       -> negation, parentheses
negation       -> parentheses``````

Notice that from each group we draw the edge not into a single group, but into all of the groups that bind tighter. This is because of the non-transitivity of precedence in this scheme: each pair of operator groups that is to have a precedence relation must have an edge between them in the graph. The advantage of this is that we don’t need to describe the precedence between operators that aren’t related at all. This is one of the motivations for using a directed graph to represent operator precedence.

I hope that from the names of the operators it was clear that some of them will apply only to booleans and some only to integers. For example, the `&` operator isn’t defined as bitwise `&`, only as logical conjunction. Thus, assuming that our language is strongly typed, some of the operators can’t appear in the holes of some other operators in a correct program.

A parser doesn’t do type checking of course, but with this mixfix grammar scheme, it does implicitly do precedence correctness checking. For example `4 + 5 & 6 + 4` is not precedence correct, as we didn’t define a precedence relation between `addition` and `and`. And due to the parser’s precedence checking, this expression will not even parse.

If we had used a total precedence order instead, we would have `+` binding tighter than `&`. The expression would be interpreted as `(4 + 5) & (6 + 4)` but would probably yield a type error as `&` works on booleans, but `+` works on integers. We could write `(4 + 5) & (6 + 4)` ourselves and that would also parse, because we made the precedence explicit. Well, actually parentheses follow the same rules: remember that in our graph, `()` bind tighter than everything.

The fact that the parser only produces precedence correct expressions can be both a blessing and a curse.

On one hand, this allows us to view some unrelated groups of operators almost as sublanguages. In our case, boolean algebra and integer arithmetic. This might be good for implementing internal DSLs in the presence of extremely flexible user-defined mixfix operators. We could allow users to extend our precedence graph or even replace it completely with their own. If a DSL has boolean logic in it, but no arithmetic, it might have precedence relations to logical operators, but not to arithmetic operators. This would preclude arithmetic operators from appearing in the DSL without being surrounded by parentheses. Or the DSL could even disallow parentheses. Implementing this much flexibility in a host language is complicated, though. For example, the parser would have to know about any custom mixfix grammars defined in imported modules.

On the other hand, this puts some correctness checks at the wrong level. Arguably, a parser should only validate the syntax of a program and nothing else. If a simple mistake such as using a wrong operator (equal to calling a non-existing method in some languages) would prevent the whole program from being parsed, it would also prevent the compiler from doing other interesting and useful things, or reporting better error messages.

So maybe this grammar scheme isn’t ideal for a general purpose programming language. I am sticking with it in Slang for now, because the scheme is relatively simple and works for me at least as long as I’m the only user of Slang :) And perhaps there are workarounds that would allow a precedence-incorrect expression to be accepted by the parser still. But I don’t have immediate plans to allow a wide variety of user-defined mixfix operators or operator precedence.

Anyway, for our simple language, I think this scheme works well enough as long as we don’t care whether it is the parser or the type checker that reports the errors in incorrect programs. There aren’t any useful direct precedence relations between boolean algebra operators and arithmetic operators here. Only by having `equality`, `comparison` or `parentheses` between them, can we put them in the same expression.

Lets look at one of the consequences of our rules more closely. Many languages, including Java and C, would put most prefix (unary) operators such as `!` and `-` at the same level of precedence, binding tighter than all infix (binary) operators. In Java, `!6 == 5` is a type error because the operator `!` is bound to `6`, not to `6 == 5`, and `!` isn’t defined on integers. In our language, it isn’t necessary to have `!` at the same level as `-`, though. Since there is no (precedence) relation between logical and arithmetic operators, `!6 + 5` will not parse. But `!` does have a relation to comparison and equality tests (they bind tighter), so you can write `!6 = 5` and it will mean `!(6 = 5)`.

The precedence rules that have `=` binding tighter than boolean operators is based on the assumption that booleans are rarely compared to each other, but multiple comparisons of other types of values are often used in disjunctions, conjunctions and complements.

To get back to the question in the beginning of the post, what would the expression production in the grammar look like instead of `expression ::= ??? | value`? The short answer is that we replace `???` with the mixfix grammar scheme instantiated with our particular precedence graph. The long answer would probably take an entire blog post by itself. You can read more about this scheme in the Agda paper, or look at the source code of my mixfix library. The scheme looks somewhat like the parser combinators in the following pseudo-code (`~` means sequential composition):

``````value = variable | literal
expression = mixfixGrammar(precedenceGraph) | value

mixfixGrammar(graph) = {
// graph - the precedence graph
// g - an operator group, node in the graph
// op - an operator in a group

⋁(parsers) = // returns the result of the first parser in the list to succeed

opsLeft(g)   = // all left-associative infix operators in g
opsRight(g)  = // all right-associative infix operators in g
opsNon(g)    = // all non-associative infix operators in g
opsClosed(g) = // all closed operators in g
opsPre(g)    = // all prefix operators in g
opsPost(g)   = // all postfix operators in g

operator(op) =
if (op.internalArity == 0)
op.namePart1
if (op.internalArity == 1)
op.namePart1 ~ expression ~ op.namePart2
// expression is an recursive reference back to the "outer" production
// these are the internal "holes" that can take any expression

group(g)  = closed(g) | non(g) | left(g) | right(g)    // any ops in this group

closed(g) = ⋁{ opsClosed(g) map operator }             // closed ops

non(g)    = ↑(g) ~ ⋁{ opsNon(g) map operator } ~ ↑(g)  // non-associative ops

left(g)   = (left(g) | ↑(g))                           // left-associative ops
~ ( ⋁{ opsPost(g) map operator }
| ⋁{ opsLeft(g) map operator } ~ ↑(g) )

right(g)  = ( ⋁{ opsPre(g) map operator }              // right-associative ops
| ↑(g) ~ ⋁{ opsRight(g) map operator } )
~ (right(g) | ↑(g))

↑(g) = ⋁{ graph.groupsTighterThan(g) map group } // every group that binds tighter than g
| value                                   // or the tightest "group" of values

return ⋁{ graph.nodes map group }
}``````

If you don’t understand this right now, no big deal — it’s late enough that I couldn’t come up with a better representation of the actual code that would fit in this post. And if you are not familiar with parser combinators I would recommend reading Daniel Spiewak’s post on the subject, at least before continuing to the next part of this series.

If you notice, the `value` and `expression` productions are referenced inside the `mixfixGrammar`. This is no good if the mixfix library is to be a separate module, so I actually implemented that by introducing a pseudo operator group that has a custom parser. This pseudo-group is then added to the precedence graph along with edges from every other group into that “really tight” group.

This concludes part 2. In the next part we will forget this pseudo-code and use Scala’s parser combinators and my mixfix library to implement an actual parser for the language, and maybe an AST and an interpreter as well.

Thanks to Miles Sabin and Daniel Spiewak for reviewing drafts for this series of posts.

# Mixfix Operators & Parser Combinators, Part 1

Until recently, Slang’s parser really sucked. It was a quick hack implemented with Scala’s parser combinator library. Nothing really wrong about that in particular, but there was a gaping hole in the grammar: no operator precedence. So to get an expression like `a + b * c` to mean `a + (b * c)` I had to add the parentheses myself. In fact, there were even more problems — some things that should have been left-associative were right-associative. This resulted in very hairy test code, with lots of parentheses everywhere.

Although I think parsers are cool, I am actually not very good at writing one for a complex grammar. I feel that I just know too little about the theory behind them or how to put it to practical use. I’ve used parser combinators before and think they are probably the easiest way for newbies like me to implement parsers, so that’s what I used. The use of symbolic names in the library might be scary the first time, but actually I think parsing is one of the few contexts where use of lots of symbols and extremeley concise code is desirable. It allows one to put a lot of code on a few lines, and when you are looking at or writing a parser, you want to see many productions of the grammar at the same time to understand what is going on. At least I do.

For Slang, I implemented something minimal that could parse the language. I had no idea how to solve operator precedence well with parser combinators, and I didn’t want to spend a lot of time studying parsers, because the next compiler phases seemed more interesting at first. But getting the parser right is important for actually using the language because it’s the first thing that processes the code and reports errors. A parser that only kind of works can be very annoying.

Thankfully Miles Sabin suggested that I should look into mixfix operator parsers, and I did. I don’t know exactly where the word mixfix comes from, so I’m assuming it means mixed fixity — operators can be prefix, infix, postfix or closed. Here are some samples:

• prefix : `-a`
• infix : `a + b`
• postfix: `n!`
• closed : `(a)`

Of course, most languages have operators with all of these fixities. The term mixfix actually refers to something more flexible than that — a mixfix operator can be seen as a sequence of alternating name parts and “holes in the expression”. A hole is where the operator’s arguments go.

`_ + _` has two holes and one name part `+` (and is infix)
`if _ then _ else _` has three name parts `if`, `then`, `else` and three holes (and is prefix)

In the mixfix viewpoint, many syntactic constructs might be seen as operators that can have precedence in relation to others, and this concept of many name parts can make it easier to let users define their own operators in a more flexible way than just a single prefix or infix word (as is allowed by Scala). I think this would be a really nice way of creating internal DSL-s. In Slang, like in Scala, most operators are really methods. Slang doesn’t allow user-defined fixity or precedence for methods yet (or even multiple argument lists), but I may add this feature one day.

There are existing languages that support mixfix operators, such as Agda, Maude and BitC. To my knowledge, all these languages assign numeric precedence values to operators, and no language currently uses the exact scheme we will look at, although it was proposed for Agda.

Mixfix operators can be implemented in many ways, but one of the first things I found was the paper Parsing Mixfix Operators by Anders Danielsson and Ulf Norell that was a great help to me. I was able to implement the grammar scheme described in that paper on top of Scala’s parser combinators and patch that into Slang’s existing parser with minimal changes to existing productions. The characteristics of the grammar scheme described in Danielsson’s paper seemed like a good enough fit for what I wanted for Slang:

• operator name parts and holes alternate — there can’t be two subsequent name parts or two subsequent holes

`if _ then _ else _` is ok, `if _ _ else _` is not

• operator precedence is described as a directed acyclic graph (DAG), not as a total or partial ordering. You only have to describe the precedence relations where they make sense (more about this in the next post)

a directed edge `'+' -> '*'` means “`*` binds tighter than `-`

• operator precedence is not transitive

`'=' -> '+'` and `'&' -> '='` does not mean “`+` binds tighter than `&`

• prefix operators are treated as right-associative

`!!a = !(!(a))`

• postfix operators are treated as left-associative

`n!! = ((n)!)!`

• left-associative and right-associative operators of the same precedence can’t appear next to each other

assuming `+:` is a right-associative `+`, `a + b +: c` would not be allowed

• parses are precedence correct
• implementation using left-recursion is possible, for example when using Scala’s Packrat parsers

There weren’t any restrictions I couldn’t live with (in fact, we could relax some of the above requirements and the scheme would still work for some grammars), so I decided to implement this grammar scheme for Slang, pretty much as described in the paper. Although I didn’t really grok all of the Agda code samples, the principles were easily understandable. I implemented it as a separate library (available on GitHub) that builds on top of the existing Scala parser combinator library. It might even be somewhat usable in it’s current state, but needs improvement.

In the next post we’ll look at how to define a grammar for an arithmetic and boolean algebra language using mixfix operators. In the third part, we will actually implement the parser for the grammar, look at performance issues and whether we can solve them with packrat parsers.

Thanks to Miles Sabin and Daniel Spiewak for reviewing drafts for this series of posts.