Mercurial > hg > truffle
diff graal/com.oracle.truffle.tools.debug.shell/src/com/oracle/truffle/tools/debug/shell/client/REPLClientContext.java @ 21568:3b8bbf51d320
Truffle/Debugging: add the Truffle DebugEngine and supporting code, as well as add a crude command-line debugging tool used mainly to test the DebugEngine. Migrate the small tols out of project com.oracle.truffle.api into the new project com.oracle.truffle.tools.
author | Michael Van De Vanter <michael.van.de.vanter@oracle.com> |
---|---|
date | Tue, 26 May 2015 16:38:13 -0700 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.truffle.tools.debug.shell/src/com/oracle/truffle/tools/debug/shell/client/REPLClientContext.java Tue May 26 16:38:13 2015 -0700 @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2015, 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.tools.debug.shell.client; + +import java.util.*; + +import com.oracle.truffle.api.source.*; +import com.oracle.truffle.tools.debug.shell.*; + +/** + * Client context for interaction with a program halted by the {@link REPLServer}. + */ +public interface REPLClientContext { + + /** + * The source code halted in this context. + */ + Source source(); + + /** + * The 1-based line at which execution is halted in this context; 0 means unknown. + */ + int lineNumber(); + + /** + * The Truffle stack where execution is halted in this context. + */ + List<REPLFrame> frames(); + + /** + * The nesting level of the execution context: 0 means evaluating shell commands outside any + * executing program. + */ + int level(); + + /** + * The source currently selected by the user; defaults to where halted. + */ + Source getSelectedSource(); + + /** + * The frame number in this execution context currently selected by the user; defaults to 0. + */ + int getSelectedFrameNumber(); + + /** + * Issue a command to the REPLServer that + * <ul> + * <li>can be specified by a single "op",</li> + * <li>produces information in the form of a single string, and</li> + * <li>has no effect on the execution state.</li> + * </ul> + */ + String stringQuery(String op); + + /** + * Sets a new "default" frame number for frame-related commands. + */ + void selectFrameNumber(int frameNumber); + + /** + * Sends an information message. + */ + void displayInfo(String message); + + void displayStack(); + + /** + * Send a message related to handling a command in this context. + */ + void displayReply(String message); + + /** + * Send a message related to failure while handling a command in this context. + */ + void displayFailReply(String message); + +}