Frontends/VBoxBFE/ConsoleImpl.h

	ConsoleImpl.h revision 525cfe310305abf78e4fd4cb98bd0fa603694a65
/** @file
 *
 * VBox frontends: Basic Frontend (BFE):
 * Declaration of Console class
 */

/*
 * Copyright (C) 2006-2007 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

#ifndef ____H_CONSOLEIMPL
#define ____H_CONSOLEIMPL

#include <VBox/types.h>

/*
 * Host key handling.
 *
 * The golden rule is that host-key combinations should not be seen
 * by the guest. For instance a CAD should not have any extra RCtrl down
 * and RCtrl up around itself. Nor should a resume be followed by a Ctrl-P
 * that could encourage applications to start printing.
 *
 * We must not confuse the hostkey processing into any release sequences
 * either, the host key is supposed to be explicitly pressing one key.
 *
 * Quick state diagram:
 *
 *            host key down alone
 *  (Normal) ---------------
 *    ^ ^                  |
 *    | |                  v          host combination key down
 *    | |            (Host key down) ----------------
 *    | | host key up v    |                        |
 *    | |--------------    | other key down         v           host combination key down
 *    |                    |                  (host key used) -------------
 *    |                    |                        |      ^              |
 *    |              (not host key)--               |      |---------------
 *    |                    |     |  |               |
 *    |                    |     ---- other         |
 *    |  modifiers = 0     v                        v
 *    -----------------------------------------------
 */
typedef enum _HKEYSTATE
{
    /** The initial and most common state, pass keystrokes to the guest.
     * Next state: HKEYSTATE_DOWN
     * Prev state: Any */
    HKEYSTATE_NORMAL = 1,
    /** The host key has been pressed down.
     * Prev state: HKEYSTATE_NORMAL
     * Next state: HKEYSTATE_NORMAL - host key up, capture toggle.
     * Next state: HKEYSTATE_USED   - host key combination down.
     * Next state: HKEYSTATE_NOT_IT - non-host key combination down.
     */
    HKEYSTATE_DOWN,
    /** A host key combination was pressed.
     * Prev state: HKEYSTATE_DOWN
     * Next state: HKEYSTATE_NORMAL - when modifiers are all 0
     */
    HKEYSTATE_USED,
    /** A non-host key combination was attempted. Send hostkey down to the
     * guest and continue until all modifiers have been released.
     * Prev state: HKEYSTATE_DOWN
     * Next state: HKEYSTATE_NORMAL - when modifiers are all 0
     */
    HKEYSTATE_NOT_IT
} HKEYSTATE;

typedef enum _CONEVENT
{
    CONEVENT_SCREENUPDATE = 1,
    CONEVENT_KEYUP,
    CONEVENT_KEYDOWN,
    CONEVENT_MOUSEMOVE,
    CONEVENT_MOUSEBUTTONUP,
    CONEVENT_MOUSEBUTTONDOWN,
    CONEVENT_FOCUSCHANGE,

    CONEVENT_USR_QUIT,
    CONEVENT_USR_SCREENUPDATERECT,
    CONEVENT_USR_SCREENRESIZE,
    CONEVENT_USR_TITLEBARUPDATE,
    CONEVENT_USR_SECURELABELUPDATE,
    CONEVENT_USR_MOUSEPOINTERCHANGE,

    CONEVENT_QUIT,

    CONEVENT_NONE
} CONEVENT;

/**
 *  Checks the availability of the underlying VM device driver corresponding
 *  to the COM interface (IKeyboard, IMouse, IDisplay, etc.). When the driver is
 *  not available (NULL), sets error info and returns returns E_ACCESSDENIED.
 *  The translatable error message is defined in null context.
 *
 *  Intended to used only within Console children (i.e. Keyboard, Mouse,
 *  Display, etc.).
 *
 *  @param drv  driver pointer to check (compare it with NULL)
 */
#define CHECK_CONSOLE_DRV(drv) \
    do { \
        if (!(drv)) \
            return setError(E_ACCESSDENIED, tr("The console is not powered up")); \
    } while (0)

class VMMDev;
class Display;

class Console
{
public:
    Console()
    {
        enmHKeyState  = HKEYSTATE_NORMAL;
        mfInitialized = false;
        mfInputGrab   = false;
    }
    virtual ~Console() {}

    virtual void     updateTitlebar() = 0;
    virtual void     updateTitlebarProgress(const char *pszStr, int iPercent) = 0;

    virtual void     inputGrabStart() = 0;
    virtual void     inputGrabEnd() = 0;
    virtual bool     inputGrabbed() { return mfInputGrab; }
    virtual void     resetCursor() {}

    virtual void     mouseSendEvent(int dz) = 0;
    virtual void     onMousePointerShapeChange(bool fVisible,
                                               bool fAlpha, uint32_t xHot,
                                               uint32_t yHot, uint32_t width,
                                               uint32_t height, void *pShape) = 0;
    virtual void     onMouseCapabilityChange(bool fAbs, bool fRel,
                                             bool fNeedsHostCursor) {}

    virtual CONEVENT eventWait() = 0;
    virtual void     eventQuit() = 0;
            bool     initialized() { return mfInitialized; }
    virtual void     progressInfo(PVM pVM, unsigned uPercent, void *pvUser) = 0;
    virtual void     resetKeys(void) = 0;
    virtual VMMDev   *getVMMDev() = 0;
    virtual Display  *getDisplay() = 0;

protected:
    HKEYSTATE enmHKeyState;
    bool      mfInitialized;
    bool      mfInputGrab;
};

extern Console *gConsole;

#endif // ____H_CONSOLEIMPL