001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.drjava.model.repl;
038:
039: import java.io.File;
040: import java.io.IOException;
041:
042: /** Callback interface which allows an InteractionsModel to respond to events in a remote Java interpreter.
043: * @version $Id: InteractionsModelCallback.java 4255 2007-08-28 19:17:37Z mgricken $
044: */
045: public interface InteractionsModelCallback {
046:
047: /** Returns an available port number to use for debugging a remote interpreter.
048: * @throws IOException if unable to get a valid port number.
049: */
050: public int getDebugPort() throws IOException;
051:
052: /** Called when the repl prints to System.out.
053: * @param s String to print
054: */
055: public void replSystemOutPrint(String s);
056:
057: /** Called when input is request from System.in.
058: * @return the input given to System.in
059: */
060: public String getConsoleInput();
061:
062: /** Sets the listener for any type of single-source input event. The listener can only be changed with
063: * the changeInputListener method.
064: * @param listener a listener that reacts to input requests
065: * @throws IllegalStateException if the input listener is locked
066: */
067: public void setInputListener(InputListener listener);
068:
069: /** Changes the input listener. Takes in the old listener to ensure that the owner of the original
070: * listener is aware that it is being changed.
071: * @param oldListener the previous listener
072: * @param newListener the listener to install
073: * @throws IllegalArgumentException if oldListener is not the currently installed listener
074: */
075: public void changeInputListener(InputListener oldListener,
076: InputListener newListener);
077:
078: /** Called when the repl prints to System.err.
079: * @param s String to print
080: */
081: public void replSystemErrPrint(String s);
082:
083: /**
084: * Signifies that the most recent interpretation completed successfully,
085: * returning no value.
086: */
087: public void replReturnedVoid();
088:
089: /**
090: * Signifies that the most recent interpretation completed successfully,
091: * returning a value.
092: *
093: * @param result The .toString-ed version of the value that was returned
094: * by the interpretation. We must return the String form
095: * because returning the Object directly would require the
096: * data type to be serializable.
097: */
098: public void replReturnedResult(String result, String style);
099:
100: /** Signifies that the most recent interpretation was ended due to an exception being thrown.
101: * @param exceptionClass The name of the class of the thrown exception
102: * @param message The exception's message
103: * @param stackTrace The stack trace of the exception
104: */
105: public void replThrewException(String exceptionClass,
106: String message, String stackTrace, String specialMessage);
107:
108: /** Signifies that the most recent interpretation was preempted by a syntax error.
109: * @param errorMessage The syntax error message
110: * @param startRow The starting row of the error
111: * @param startCol The starting column of the error
112: * @param endRow The end row of the error
113: * @param endCol The end column of the error
114: */
115: public void replReturnedSyntaxError(String errorMessage,
116: String interaction, int startRow, int startCol, int endRow,
117: int endCol);
118:
119: /** Signifies that the most recent interpretation contained a call to System.exit.
120: * @param status The exit status that will be returned.
121: */
122: public void replCalledSystemExit(int status);
123:
124: /** This method is called by the Main JVM if the Interpreter JVM cannot be exited (likely because of its
125: * having a security manager)
126: * @param th The Throwable thrown by System.exit
127: */
128: public void interpreterResetFailed(Throwable th);
129:
130: /** Called when the interpreter starts to reset. */
131: public void interpreterResetting();
132:
133: /** Called when a new Java interpreter has registered and is ready for use. */
134: public void interpreterReady(File wd);
135:
136: /** Called when the slave JVM is used */
137: public void slaveJVMUsed();
138: }
|