org.parboiled.MatcherContext Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014 Francis Galiegue 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.parboiled;

import com.github.parboiled1.grappa.matchers.base.Matcher;

public interface MatcherContext
    extends Context
{
    MatcherContext getParent();

    /*
     * TODO! Only used in ActionMatcher, MemoMismatchesMatcher,
     * VarFramingMatcher
     */
    void setMatcher(Matcher matcher);

    void setStartIndex(int startIndex);

    void setCurrentIndex(int currentIndex);

    void advanceIndex(int delta);

    Node getNode();

    void setIntTag(int intTag);

    /*
     * TODO: only used from MemoMismatchesMatcher
     */
    boolean hasMismatched();

    /*
     * TODO: only used from MemoMismatchesMatcher
     */
    void memoizeMismatch();

    void createNode();

    /*
     * TODO! Only called from ActionMatcher and DefaultMatcherContext
     */
    MatcherContext getBasicSubContext();

    // TODO: only overriden in ActionMatcher and AbstractMatcher
    MatcherContext getSubContext(Matcher matcher);

    boolean runMatcher();
}