com.mitchellbosecke.pebble.parser.Parser Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * This file is part of Pebble.
 * 
 * Copyright (c) 2014 by Mitchell Bösecke
 * 
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 ******************************************************************************/
package com.mitchellbosecke.pebble.parser;

import com.mitchellbosecke.pebble.error.ParserException;
import com.mitchellbosecke.pebble.lexer.TokenStream;
import com.mitchellbosecke.pebble.node.BodyNode;
import com.mitchellbosecke.pebble.node.RootNode;

public interface Parser {

    RootNode parse(TokenStream stream) throws ParserException;

    BodyNode subparse() throws ParserException;

    /**
     * Provides the stream of tokens which ultimately need to be "parsed" into
     * Nodes.
     *
     * @return TokenStream
     */
    TokenStream getStream();

    /**
     * Parses the existing TokenStream, starting at the current Token, and
     * ending when the stopCondition is fullfilled.
     *
     * @param stopCondition The condition to stop parsing a segment of the template.
     * @return A node representing the parsed section
     * @throws ParserException Thrown if a parsing error occurs.
     */
    BodyNode subparse(StoppingCondition stopCondition) throws ParserException;

    ExpressionParser getExpressionParser();

    String peekBlockStack();

    String popBlockStack();

    void pushBlockStack(String blockName);

}