reflex.debug.IReflexDebugger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Reflex Show documentation
null
There is a newer version: 3.0.4
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package reflex.debug;

import reflex.Scope;
import reflex.node.ReflexNode;
import reflex.util.function.LanguageRegistry;
import reflex.value.ReflexValue;

/**
 * This interface is used to implement a debugger for Reflex. As execution
 * proceeds methods on the debugger will be called to give a debugger the
 * opportunity to take over and interrupt execution, modify the scope, etc.
 * 
 * @author amkimian
 * 
 */
public interface IReflexDebugger {
    boolean isDebug();

    void setRegistry(LanguageRegistry languageRegistry);

    // Used if the original line needs to be displayed
    void setProgram(String program);

    void stepEnd(ReflexNode node, ReflexValue value, Scope scope);

    // for now, a trivial step
    void stepStart(ReflexNode node, Scope scope);

    // If supported, publish this message on an appropriate debug channel
    // this could be a status channel, the status of a running script, etc.
    void recordMessage(String message);
}