ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/interpreter/InterpreterConsole.java
/* ###
 * IP: GHIDRA
 *
 * 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 ghidra.app.plugin.core.interpreter;

import java.io.*;

import docking.action.DockingAction;
import ghidra.util.Disposable;
import utility.function.Callback;

/**
 * Interactive interpreter console.
 */
public interface InterpreterConsole extends Disposable {

	/* TODO: 
	 * The PythonPlugin is overly complicated because we have to startup a new thread that
	 * continuously checks the InterpreterConsole for new input.  It would be much easier
	 * if the InterpreterConsole could just asynchronously send an update to whoever is using 
	 * it every time a new thing is entered into it.  
	 * 
	 *The same problem applies to debugger interpreters / consoles.
	 */

	public void clear();

	public InputStream getStdin();

	public OutputStream getStdOut();

	public OutputStream getStdErr();

	public PrintWriter getOutWriter();

	public PrintWriter getErrWriter();

	public void setPrompt(String prompt);

	/**
	 * Signals that this console is one that the user can remove from the tool as desired. If this
	 * method is not called, then the user cannot remove the console from the tool, which means that
	 * closing the console only hides it.
	 */
	public void setTransient();

	public void addAction(DockingAction action);

	/**
	 * Adds the given callback which will get called the first time the interpreter console is
	 * activated.
	 * 
	 * @param activationCallback The callback to execute when activation occurs for the first time.
	 */
	public void addFirstActivationCallback(Callback activationCallback);

	/**
	 * Checks whether the user can input commands.
	 * 
	 * @return true if permitted, false if prohibited
	 */
	public boolean isInputPermitted();

	/**
	 * Controls whether the user can input commands.
	 * 
	 * @param permitted true to permit input, false to prohibit input
	 */
	public void setInputPermitted(boolean permitted);

	/**
	 * Check if the console is visible
	 * 
	 * <p>
	 * Note if the console is on-screen, but occluded by other windows, this still returns
	 * {@code true}.
	 * 
	 * @return true if visible, false if hidden
	 */
	public boolean isVisible();

	/**
	 * Show the console's provider in the tool
	 */
	public void show();

	/**
	 * Notify the tool that this console's title has changed
	 */
	public void updateTitle();
}
