/*
 * Copyright (c) 2002-2016, the original author or authors.
 *
 * This software is distributable under the BSD license. See the terms of the
 * BSD license in the documentation provided with this software.
 *
 * http://www.opensource.org/licenses/bsd-license.php
 */
package jdk.internal.org.jline.reader;

public interface Parser {

    ParsedLine parse(String line, int cursor, ParseContext context) throws SyntaxError;

    default ParsedLine parse(String line, int cursor) throws SyntaxError {
        return parse(line, cursor, ParseContext.UNSPECIFIED);
    }

    enum ParseContext {
        UNSPECIFIED,

        
Try a real "final" parse. May throw EOFError in which case we have incomplete input.
/** Try a real "final" parse. * May throw EOFError in which case we have incomplete input. */
ACCEPT_LINE,
Parse to find completions (typically after a Tab). We should tolerate and ignore errors.
/** Parse to find completions (typically after a Tab). * We should tolerate and ignore errors. */
COMPLETE,
Called when we need to update the secondary prompts. Specifically, when we need the 'missing' field from EOFError, which is used by a "%M" in a prompt pattern.
/** Called when we need to update the secondary prompts. * Specifically, when we need the 'missing' field from EOFError, * which is used by a "%M" in a prompt pattern. */
SECONDARY_PROMPT } }