Parboiled (Java)

parboiled Library

Developer(s)	Mathias Doenitz
Initial release	November 12, 2009 (2009-11-12)
Stable release	1.3.1 / June 24, 2019 (2019-06-24)
Repository	github.com/sirthias/parboiled
Written in	Java
Operating system	Cross-platform
License	Apache License 2.0
Website	parboiled.org

parboiled is an open-source Java library released under an Apache License. It provides support for defining PEG parsers directly in Java source code.

parboiled is commonly used as an alternative for regular expressions or parser generators (like ANTLR or JavaCC), especially for smaller and medium-size applications.

Apart from providing the constructs for grammar definition parboiled implements a complete recursive descent parser with support for abstract syntax tree construction, parse error reporting and parse error recovery.

Example

Since parsing with parboiled does not require a separate lexing phase and there is no special syntax to learn for grammar definition parboiled makes it comparatively easy to build custom parsers quickly.

Consider this the following classic "calculator" example, with these rules in a simple pseudo notation

Expression ← Term (('+' / '-') Term)*
Term ← Factor (('*' / '/') Factor)*
Factor ← Number / '(' Expression ')'
Number ← [0-9]+

With parboiled this rule description can be translated directly into the following Java code:

import org.parboiled.BaseParser;

public class CalculatorParser extends BaseParser<Object> {

    public Rule Expression() {
        return Sequence(
                Term(),
                ZeroOrMore(
                        Sequence(
                                FirstOf('+', '-'),
                                Term()
                        )
                )
        );
    }

    public Rule Term() {
        return Sequence(
                Factor(),
                ZeroOrMore(
                        Sequence(
                                FirstOf('*', '/'),
                                Factor()
                        )
                )
        );
    }

    public Rule Factor() {
        return FirstOf(
                Number(),
                Sequence('(', Expression(), ')')
        );
    }

    public Rule Number() {
        return OneOrMore(CharRange('0', '9'));
    }

}

The class defines the parser rules for the language (yet without any actions), which could be used to parse actual input with code such as this:

String input = "1+2";
CalculatorParser parser = Parboiled.createParser(CalculatorParser.class);
ParsingResult<?> result = ReportingParseRunner.run(parser.expression(), input);
String parseTreePrintOut = ParseTreeUtils.printNodeTree(result); 
System.out.println(parseTreePrintOut);

See also

• Parsing expression grammars
• Regular expressions
• ANTLR
• JavaCC

External links

• Official parboiled web site
• Example of a complete Java 6 parser written with parboiled