Jump to content

Parboiled (Java)

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Cydebot (talk | contribs) at 01:20, 11 December 2014 (Robot - Speedily moving category Java programming language to Category:Java (programming language) per CFDS.). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.
parboiled Library
Developer(s)Mathias Doenitz
Initial releaseNovember 12, 2009 (2009-11-12)
Stable release
1.1.6 / 2 May 2013; 12 years ago (2013-05-02)
Repository
Written inJava
Operating systemCross-platform
LicenseApache License 2.0
Websitehttp://www.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

ExpressionTerm ((‘+’ / ‘-’) Term)*
TermFactor (('*' / '/') Factor)*
FactorNumber / '(' 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