DebuggerController.java

/*
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.api.instrumentation.test.examples;

import com.oracle.truffle.api.instrumentation.EventContext;
import com.oracle.truffle.api.vm.PolyglotRuntime;

/**
 * Publicly exposed API of a debugger. Provides operations that its clients can use to control the
 * execution. Put this class into an API package of your instrument. The clients shall use
 * {@link PolyglotRuntime.Instrument#lookup(java.lang.Class)} with
 * <code>DebuggerController.<b>class</b></code> parameter to obtain the interface.
 */
// BEGIN: DebuggerController
public abstract class DebuggerController {
    DebuggerController() {
    }

    public abstract void installBreakpoint(int i, Callback callback);

    public abstract void stepInto(Callback callback);

    public abstract void stepOut(Callback callback);

    public abstract void stepOver(Callback callback);

    public interface Callback {

        void halted(DebuggerController debugger, EventContext haltedAt);

    }

}
// END: DebuggerController