/*
 * $Id$
 *
 * Copyright (C) 2003-2015 JNode.org
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library 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 Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; If not, write to the Free Software Foundation, Inc., 
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package org.jnode.driver.console;

import java.io.PrintWriter;
import java.util.Set;

import org.jnode.driver.input.KeyboardListener;
import org.jnode.driver.input.PointerListener;

/**
 * @author epr
 */
public interface ConsoleManager extends KeyboardListener, PointerListener {

    /**
     * The name used to bind this manager in the InitialNaming namespace.
     */
    public static final Class<ConsoleManager> NAME = ConsoleManager.class;

    /**
     * Gets the console with the given index
     *
     * @param name
     * @return The console
     */
    public Console getConsole(String name);

    /**
     * Gets the console with the given accelerator keycode.
     *
     * @param keyCode
     * @return The console
     */
    public Console getConsoleByAccelerator(int keyCode);

    /**
     * Gets the names of all consoles currently registered
     *
     * @return a set of console names.
     */
    public Set<String> getConsoleNames();

    /**
     * Add a new console.
     *
     * @param console the console to be registered.
     */
    public void registerConsole(Console console);

    /**
     * Remove a currently registered console.
     *
     * @param console the console to be unregistered.
     */
    public void unregisterConsole(Console console);

    /**
     * Gets the console that currently has focus.
     *
     * @return the focussed console
     */
    public Console getFocus();

    /**
     * Gets the console that "hosts" the current thread.
     *
     * @return Console
     */
    public Console getContextConsole();

    /**
     * Focus the given console
     *
     * @param console
     */
    public void focus(Console console);

    /**
     * Return the parent of this console manager.
     *
     * @return the parent or {@code null}.
     */
    public ConsoleManager getParent();

    /**
     * Set the parent of this console manager.
     *
     * @param parent the new parent
     */
    public void setParent(ConsoleManager parent);

    /**
     * Option constants for use in {@link org.jnode.driver.console.ConsoleManager#createConsole(String, int)}
     *
     * @author Ewout Prangsma (epr@users.sourceforge.net)
     */
    public static final class CreateOptions {
        /**
         * Create a text console.
         */
        public static final int TEXT = 0x01;

        /**
         * Create a scrollable console.
         */
        public static final int SCROLLABLE = 0x02;

        /**
         * Do not claim System.out, err when focused.
         */
        public static final int NO_SYSTEM_OUT_ERR = 0x04;

        /**
         * Stack console on the current screen
         */
        public static final int STACKED = 0x08;

        /**
         * Do not create a line-editing input stream for the console.
         * The console's input will be whatever System.in currently is.
         */
        public static final int NO_LINE_EDITTING = 0x10;
    }

    /**
     * Create a new console with given properties and optionally a given name.
     *
     * @param name    The name of the new console, or {@code null} for an automatic name.
     * @param options The options that determine the properties of console to be created; 
     * see {@link CreateOptions}.
     * @return the new console.
     */
    public Console createConsole(String name, int options);

    public void printConsoles(PrintWriter pw);
}