VBoxSDL.cpp revision 58e8f2bc3ec5551ada61c45bda246a97e9a945c0
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich/** @file
e1e1e620f76ef8d3cb2c022269bf846e6e392fbaAllen Rabinovich * VBox frontends: VBoxSDL (simple frontend based on SDL):
f0e0bfede101cfa5fbfb4ffe85a839033657b5d7Allen Rabinovich * Main code
f0e0bfede101cfa5fbfb4ffe85a839033657b5d7Allen Rabinovich */
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich/*
6e847ed42c6e59e53bca347d80876b6ecb5a60f7Allen Rabinovich * Copyright (C) 2006-2009 Sun Microsystems, Inc.
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich *
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich * This file is part of VirtualBox Open Source Edition (OSE), as
f0e0bfede101cfa5fbfb4ffe85a839033657b5d7Allen Rabinovich * available from http://www.virtualbox.org. This file is free software;
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich * you can redistribute it and/or modify it under the terms of the GNU
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich * General Public License (GPL) as published by the Free Software
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich * Foundation, in version 2 as it comes in the "COPYING" file of the
87fff29257e74dac31f23eac9e31c028a551057fAllen Rabinovich * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich *
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich * Clara, CA 95054 USA or visit http://www.sun.com if you need
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich * additional information or have any questions.
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich */
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich/*******************************************************************************
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich* Header Files *
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich*******************************************************************************/
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#define LOG_GROUP LOG_GROUP_GUI
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include <VBox/com/com.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include <VBox/com/string.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include <VBox/com/Guid.h>
f0e0bfede101cfa5fbfb4ffe85a839033657b5d7Allen Rabinovich#include <VBox/com/array.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include <VBox/com/ErrorInfo.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include <VBox/com/errorprint2.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include <VBox/com/EventQueue.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include <VBox/com/VirtualBox.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovichusing namespace com;
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#if defined (VBOXSDL_WITH_X11)
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich# include <X11/Xlib.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich# include <X11/cursorfont.h> /* for XC_left_ptr */
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich# if !defined (VBOX_WITHOUT_XCURSOR)
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich# include <X11/Xcursor/Xcursor.h>
f0e0bfede101cfa5fbfb4ffe85a839033657b5d7Allen Rabinovich# endif
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich# include <unistd.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#endif
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#ifndef RT_OS_DARWIN
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <SDL_syswm.h> /* for SDL_GetWMInfo() */
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#endif
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include "VBoxSDL.h"
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include "Framebuffer.h"
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include "Helper.h"
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <VBox/types.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <VBox/err.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <VBox/param.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <VBox/log.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <VBox/version.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <iprt/alloca.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich#include <iprt/asm.h>
f0e0bfede101cfa5fbfb4ffe85a839033657b5d7Allen Rabinovich#include <iprt/assert.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <iprt/env.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <iprt/file.h>
9c46bf9bc0ac9bab8d409ae4ab6d2a2ddc4dc55bJeff Conniff#include <iprt/ldr.h>
9c46bf9bc0ac9bab8d409ae4ab6d2a2ddc4dc55bJeff Conniff#include <iprt/initterm.h>
9c46bf9bc0ac9bab8d409ae4ab6d2a2ddc4dc55bJeff Conniff#include <iprt/path.h>
9c46bf9bc0ac9bab8d409ae4ab6d2a2ddc4dc55bJeff Conniff#include <iprt/process.h>
9c46bf9bc0ac9bab8d409ae4ab6d2a2ddc4dc55bJeff Conniff#include <iprt/semaphore.h>
9c46bf9bc0ac9bab8d409ae4ab6d2a2ddc4dc55bJeff Conniff#include <iprt/string.h>
9c46bf9bc0ac9bab8d409ae4ab6d2a2ddc4dc55bJeff Conniff#include <iprt/stream.h>
f0e0bfede101cfa5fbfb4ffe85a839033657b5d7Allen Rabinovich#include <iprt/uuid.h>
e459c407a404c834e5f9759744d1a134d820d41bAllen Rabinovich
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich#include <signal.h>
21257820ee962f4f2275b39088c43fcfd76f7fdeAllen Rabinovich
#include <vector>
#include <list>
/* Xlib would re-define our enums */
#undef True
#undef False
/*******************************************************************************
* Defined Constants And Macros *
*******************************************************************************/
#ifdef VBOX_SECURELABEL
/** extra data key for the secure label */
#define VBOXSDL_SECURELABEL_EXTRADATA "VBoxSDL/SecureLabel"
/** label area height in pixels */
#define SECURE_LABEL_HEIGHT 20
#endif
/** Enables the rawr[0|3], patm, and casm options. */
#define VBOXSDL_ADVANCED_OPTIONS
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
/** Pointer shape change event data strucure */
struct PointerShapeChangeData
{
PointerShapeChangeData (BOOL aVisible, BOOL aAlpha, ULONG aXHot, ULONG aYHot,
ULONG aWidth, ULONG aHeight, const uint8_t *aShape)
: visible (aVisible), alpha (aAlpha), xHot (aXHot), yHot (aYHot),
width (aWidth), height (aHeight), shape (NULL)
{
// make a copy of the shape
if (aShape)
{
uint32_t shapeSize = ((((aWidth + 7) / 8) * aHeight + 3) & ~3) + aWidth * 4 * aHeight;
shape = new uint8_t [shapeSize];
if (shape)
memcpy ((void *) shape, (void *) aShape, shapeSize);
}
}
~PointerShapeChangeData()
{
if (shape) delete[] shape;
}
const BOOL visible;
const BOOL alpha;
const ULONG xHot;
const ULONG yHot;
const ULONG width;
const ULONG height;
const uint8_t *shape;
};
enum TitlebarMode
{
TITLEBAR_NORMAL = 1,
TITLEBAR_STARTUP = 2,
TITLEBAR_SAVE = 3,
TITLEBAR_SNAPSHOT = 4
};
/*******************************************************************************
* Internal Functions *
*******************************************************************************/
static bool UseAbsoluteMouse(void);
static void ResetKeys(void);
static void ProcessKey(SDL_KeyboardEvent *ev);
static void InputGrabStart(void);
static void InputGrabEnd(void);
static void SendMouseEvent(int dz, int button, int down);
static void UpdateTitlebar(TitlebarMode mode, uint32_t u32User = 0);
static void SetPointerShape(const PointerShapeChangeData *data);
static void HandleGuestCapsChanged(void);
static int HandleHostKey(const SDL_KeyboardEvent *pEv);
static Uint32 StartupTimer(Uint32 interval, void *param);
static Uint32 ResizeTimer(Uint32 interval, void *param);
static Uint32 QuitTimer(Uint32 interval, void *param);
static int WaitSDLEvent(SDL_Event *event);
static void SetFullscreen(bool enable);
/*******************************************************************************
* Global Variables *
*******************************************************************************/
#if defined (DEBUG_dmik)
// my mini kbd doesn't have RCTRL...
static int gHostKeyMod = KMOD_RSHIFT;
static int gHostKeySym1 = SDLK_RSHIFT;
static int gHostKeySym2 = SDLK_UNKNOWN;
#else
static int gHostKeyMod = KMOD_RCTRL;
static int gHostKeySym1 = SDLK_RCTRL;
static int gHostKeySym2 = SDLK_UNKNOWN;
#endif
static const char *gHostKeyDisabledCombinations = "";
static const char *gpszPidFile;
static BOOL gfGrabbed = FALSE;
static BOOL gfGrabOnMouseClick = TRUE;
static BOOL gfFullscreenResize = FALSE;
static BOOL gfIgnoreNextResize = FALSE;
static BOOL gfAllowFullscreenToggle = TRUE;
static BOOL gfAbsoluteMouseHost = FALSE;
static BOOL gfAbsoluteMouseGuest = FALSE;
static BOOL gfGuestNeedsHostCursor = FALSE;
static BOOL gfOffCursorActive = FALSE;
static BOOL gfGuestNumLockPressed = FALSE;
static BOOL gfGuestCapsLockPressed = FALSE;
static BOOL gfGuestScrollLockPressed = FALSE;
static BOOL gfACPITerm = FALSE;
static int gcGuestNumLockAdaptions = 2;
static int gcGuestCapsLockAdaptions = 2;
static uint32_t gmGuestNormalXRes;
static uint32_t gmGuestNormalYRes;
/** modifier keypress status (scancode as index) */
static uint8_t gaModifiersState[256];
static ComPtr<IMachine> gMachine;
static ComPtr<IConsole> gConsole;
static ComPtr<IMachineDebugger> gMachineDebugger;
static ComPtr<IKeyboard> gKeyboard;
static ComPtr<IMouse> gMouse;
static ComPtr<IDisplay> gDisplay;
static ComPtr<IVRDPServer> gVrdpServer;
static ComPtr<IProgress> gProgress;
static VBoxSDLFB *gpFrameBuffer = NULL;
static SDL_Cursor *gpDefaultCursor = NULL;
#ifdef VBOXSDL_WITH_X11
static Cursor gpDefaultOrigX11Cursor;
static BOOL guseEvdevKeymap = FALSE;
#endif
static SDL_Cursor *gpCustomCursor = NULL;
static WMcursor *gpCustomOrigWMcursor = NULL;
static SDL_Cursor *gpOffCursor = NULL;
static SDL_TimerID gSdlResizeTimer = NULL;
static SDL_TimerID gSdlQuitTimer = NULL;
#ifdef VBOXSDL_WITH_X11
static SDL_SysWMinfo gSdlInfo;
#endif
#ifdef VBOX_SECURELABEL
#ifdef RT_OS_WINDOWS
#define LIBSDL_TTF_NAME "SDL_ttf"
#else
#define LIBSDL_TTF_NAME "libSDL_ttf-2.0.so.0"
#endif
RTLDRMOD gLibrarySDL_ttf = NIL_RTLDRMOD;
#endif
static RTSEMEVENT g_EventSemSDLEvents;
static volatile int32_t g_cNotifyUpdateEventsPending;
/**
* Callback handler for VirtualBox events
*/
class VBoxSDLCallback :
public IVirtualBoxCallback
{
public:
VBoxSDLCallback()
{
#if defined (RT_OS_WINDOWS)
refcnt = 0;
#endif
}
virtual ~VBoxSDLCallback()
{
}
#ifdef RT_OS_WINDOWS
STDMETHOD_(ULONG, AddRef)()
{
return ::InterlockedIncrement(&refcnt);
}
STDMETHOD_(ULONG, Release)()
{
long cnt = ::InterlockedDecrement(&refcnt);
if (cnt == 0)
delete this;
return cnt;
}
STDMETHOD(QueryInterface)(REFIID riid , void **ppObj)
{
if (riid == IID_IUnknown)
{
*ppObj = this;
AddRef();
return S_OK;
}
if (riid == IID_IVirtualBoxCallback)
{
*ppObj = this;
AddRef();
return S_OK;
}
*ppObj = NULL;
return E_NOINTERFACE;
}
#endif
NS_DECL_ISUPPORTS
STDMETHOD(OnMachineStateChange)(IN_GUID machineId, MachineState_T state)
{
return S_OK;
}
STDMETHOD(OnMachineDataChange)(IN_GUID machineId)
{
return S_OK;
}
STDMETHOD(OnExtraDataCanChange)(IN_GUID machineId, IN_BSTR key, IN_BSTR value,
BSTR *error, BOOL *changeAllowed)
{
/* we never disagree */
if (!changeAllowed)
return E_INVALIDARG;
*changeAllowed = TRUE;
return S_OK;
}
STDMETHOD(OnExtraDataChange)(IN_GUID machineId, IN_BSTR key, IN_BSTR value)
{
#ifdef VBOX_SECURELABEL
Assert(key);
if (gMachine)
{
/*
* check if we're interested in the message
*/
Guid ourGuid;
Guid messageGuid = machineId;
gMachine->COMGETTER(Id)(ourGuid.asOutParam());
if (ourGuid == messageGuid)
{
Bstr keyString = key;
if (keyString && keyString == VBOXSDL_SECURELABEL_EXTRADATA)
{
/*
* Notify SDL thread of the string update
*/
SDL_Event event = {0};
event.type = SDL_USEREVENT;
event.user.type = SDL_USER_EVENT_SECURELABEL_UPDATE;
PushSDLEventForSure(&event);
}
}
}
#endif /* VBOX_SECURELABEL */
return S_OK;
}
STDMETHOD(OnMediaRegistered) (IN_GUID mediaId, DeviceType_T mediaType,
BOOL registered)
{
NOREF (mediaId);
NOREF (mediaType);
NOREF (registered);
return S_OK;
}
STDMETHOD(OnMachineRegistered)(IN_GUID machineId, BOOL registered)
{
return S_OK;
}
STDMETHOD(OnSessionStateChange)(IN_GUID machineId, SessionState_T state)
{
return S_OK;
}
STDMETHOD(OnSnapshotTaken) (IN_GUID aMachineId, IN_GUID aSnapshotId)
{
return S_OK;
}
STDMETHOD(OnSnapshotDiscarded) (IN_GUID aMachineId, IN_GUID aSnapshotId)
{
return S_OK;
}
STDMETHOD(OnSnapshotChange) (IN_GUID aMachineId, IN_GUID aSnapshotId)
{
return S_OK;
}
STDMETHOD(OnGuestPropertyChange)(IN_GUID machineId, IN_BSTR key, IN_BSTR value, IN_BSTR flags)
{
return S_OK;
}
private:
#ifdef RT_OS_WINDOWS
long refcnt;
#endif
};
/**
* Callback handler for machine events
*/
class VBoxSDLConsoleCallback :
public IConsoleCallback
{
public:
VBoxSDLConsoleCallback() : m_fIgnorePowerOffEvents(false)
{
#if defined (RT_OS_WINDOWS)
refcnt = 0;
#endif
}
virtual ~VBoxSDLConsoleCallback()
{
}
#ifdef RT_OS_WINDOWS
STDMETHOD_(ULONG, AddRef)()
{
return ::InterlockedIncrement(&refcnt);
}
STDMETHOD_(ULONG, Release)()
{
long cnt = ::InterlockedDecrement(&refcnt);
if (cnt == 0)
delete this;
return cnt;
}
STDMETHOD(QueryInterface)(REFIID riid , void **ppObj)
{
if (riid == IID_IUnknown)
{
*ppObj = this;
AddRef();
return S_OK;
}
if (riid == IID_IConsoleCallback)
{
*ppObj = this;
AddRef();
return S_OK;
}
*ppObj = NULL;
return E_NOINTERFACE;
}
#endif
NS_DECL_ISUPPORTS
STDMETHOD(OnMousePointerShapeChange) (BOOL visible, BOOL alpha, ULONG xHot, ULONG yHot,
ULONG width, ULONG height, BYTE *shape)
{
PointerShapeChangeData *data;
data = new PointerShapeChangeData (visible, alpha, xHot, yHot, width, height,
shape);
Assert (data);
if (!data)
return E_FAIL;
SDL_Event event = {0};
event.type = SDL_USEREVENT;
event.user.type = SDL_USER_EVENT_POINTER_CHANGE;
event.user.data1 = data;
int rc = PushSDLEventForSure (&event);
if (rc)
delete data;
return S_OK;
}
STDMETHOD(OnMouseCapabilityChange)(BOOL supportsAbsolute, BOOL needsHostCursor)
{
LogFlow(("OnMouseCapabilityChange: supportsAbsolute = %d\n", supportsAbsolute));
gfAbsoluteMouseGuest = supportsAbsolute;
gfGuestNeedsHostCursor = needsHostCursor;
SDL_Event event = {0};
event.type = SDL_USEREVENT;
event.user.type = SDL_USER_EVENT_GUEST_CAP_CHANGED;
PushSDLEventForSure (&event);
return S_OK;
}
STDMETHOD(OnKeyboardLedsChange)(BOOL fNumLock, BOOL fCapsLock, BOOL fScrollLock)
{
/* Don't bother the guest with NumLock scancodes if he doesn't set the NumLock LED */
if (gfGuestNumLockPressed != fNumLock)
gcGuestNumLockAdaptions = 2;
if (gfGuestCapsLockPressed != fCapsLock)
gcGuestCapsLockAdaptions = 2;
gfGuestNumLockPressed = fNumLock;
gfGuestCapsLockPressed = fCapsLock;
gfGuestScrollLockPressed = fScrollLock;
return S_OK;
}
STDMETHOD(OnStateChange)(MachineState_T machineState)
{
LogFlow(("OnStateChange: machineState = %d (%s)\n", machineState, GetStateName(machineState)));
SDL_Event event = {0};
if ( machineState == MachineState_Aborted
|| (machineState == MachineState_Saved && !m_fIgnorePowerOffEvents)
|| (machineState == MachineState_PoweredOff && !m_fIgnorePowerOffEvents))
{
/*
* We have to inform the SDL thread that the application has be terminated
*/
event.type = SDL_USEREVENT;
event.user.type = SDL_USER_EVENT_TERMINATE;
event.user.code = machineState == MachineState_Aborted
? VBOXSDL_TERM_ABEND
: VBOXSDL_TERM_NORMAL;
}
else
{
/*
* Inform the SDL thread to refresh the titlebar
*/
event.type = SDL_USEREVENT;
event.user.type = SDL_USER_EVENT_UPDATE_TITLEBAR;
}
PushSDLEventForSure(&event);
return S_OK;
}
STDMETHOD(OnAdditionsStateChange)()
{
return S_OK;
}
STDMETHOD(OnDVDDriveChange)()
{
return S_OK;
}
STDMETHOD(OnFloppyDriveChange)()
{
return S_OK;
}
STDMETHOD(OnNetworkAdapterChange) (INetworkAdapter *aNetworkAdapter)
{
return S_OK;
}
STDMETHOD(OnSerialPortChange) (ISerialPort *aSerialPort)
{
return S_OK;
}
STDMETHOD(OnParallelPortChange) (IParallelPort *aParallelPort)
{
return S_OK;
}
STDMETHOD(OnVRDPServerChange)()
{
return S_OK;
}
STDMETHOD(OnUSBControllerChange)()
{
return S_OK;
}
STDMETHOD(OnUSBDeviceStateChange) (IUSBDevice *aDevice, BOOL aAttached,
IVirtualBoxErrorInfo *aError)
{
return S_OK;
}
STDMETHOD(OnSharedFolderChange) (Scope_T aScope)
{
return S_OK;
}
STDMETHOD(OnStorageControllerChange) ()
{
return S_OK;
}
STDMETHOD(OnRuntimeError)(BOOL fFatal, IN_BSTR id, IN_BSTR message)
{
MachineState_T machineState;
gMachine->COMGETTER(State)(&machineState);
const char *pszType;
bool fPaused = machineState == MachineState_Paused;
if (fFatal)
pszType = "FATAL ERROR";
else if (machineState == MachineState_Paused)
pszType = "Non-fatal ERROR";
else
pszType = "WARNING";
RTPrintf("\n%s: ** %lS **\n%lS\n%s\n", pszType, id, message,
fPaused ? "The VM was paused. Continue with HostKey + P after you solved the problem.\n" : "");
return S_OK;
}
STDMETHOD(OnCanShowWindow)(BOOL *canShow)
{
if (!canShow)
return E_POINTER;
#ifdef RT_OS_DARWIN
/* SDL feature not available on Quartz */
*canShow = TRUE;
#else
SDL_SysWMinfo info;
SDL_VERSION(&info.version);
*canShow = !!SDL_GetWMInfo(&info);
#endif
return S_OK;
}
STDMETHOD(OnShowWindow) (ULONG64 *winId)
{
#ifndef RT_OS_DARWIN
SDL_SysWMinfo info;
SDL_VERSION(&info.version);
if (SDL_GetWMInfo(&info))
{
#if defined (VBOXSDL_WITH_X11)
*winId = (ULONG64) info.info.x11.wmwindow;
#elif defined (RT_OS_WIN)
*winId = (ULONG64) info.window;
#else
AssertFailed();
return E_FAIL;
#endif
return S_OK;
}
#endif /* !RT_OS_DARWIN */
AssertFailed();
return E_FAIL;
}
static const char *GetStateName(MachineState_T machineState)
{
switch (machineState)
{
case MachineState_Null: return "<null>";
case MachineState_Running: return "Running";
case MachineState_Restoring: return "Restoring";
case MachineState_Starting: return "Starting";
case MachineState_PoweredOff: return "PoweredOff";
case MachineState_Saved: return "Saved";
case MachineState_Aborted: return "Aborted";
case MachineState_Stopping: return "Stopping";
default: return "no idea";
}
}
void ignorePowerOffEvents(bool fIgnore)
{
m_fIgnorePowerOffEvents = fIgnore;
}
private:
#ifdef RT_OS_WINDOWS
long refcnt;
#endif
bool m_fIgnorePowerOffEvents;
};
#ifdef VBOX_WITH_XPCOM
NS_DECL_CLASSINFO(VBoxSDLCallback)
NS_IMPL_ISUPPORTS1_CI(VBoxSDLCallback, IVirtualBoxCallback)
NS_DECL_CLASSINFO(VBoxSDLConsoleCallback)
NS_IMPL_ISUPPORTS1_CI(VBoxSDLConsoleCallback, IConsoleCallback)
#endif /* VBOX_WITH_XPCOM */
static void show_usage()
{
RTPrintf("Usage:\n"
" -vm <id|name> Virtual machine to start, either UUID or name\n"
" -hda <file> Set temporary first hard disk to file\n"
" -fda <file> Set temporary first floppy disk to file\n"
" -cdrom <file> Set temporary CDROM/DVD to file/device ('none' to unmount)\n"
" -boot <a|c|d|n> Set temporary boot device (a = floppy, c = 1st HD, d = DVD, n = network)\n"
" -m <size> Set temporary memory size in megabytes\n"
" -vram <size> Set temporary size of video memory in megabytes\n"
" -fullscreen Start VM in fullscreen mode\n"
" -fullscreenresize Resize the guest on fullscreen\n"
" -fixedmode <w> <h> <bpp> Use a fixed SDL video mode with given width, height and bits per pixel\n"
" -nofstoggle Forbid switching to/from fullscreen mode\n"
" -noresize Make the SDL frame non resizable\n"
" -nohostkey Disable all hostkey combinations\n"
" -nohostkeys ... Disable specific hostkey combinations, see below for valid keys\n"
" -nograbonclick Disable mouse/keyboard grabbing on mouse click w/o additions\n"
" -detecthostkey Get the hostkey identifier and modifier state\n"
" -hostkey <key> {<key2>} <mod> Set the host key to the values obtained using -detecthostkey\n"
" -termacpi Send an ACPI power button event when closing the window\n"
#if defined(RT_OS_LINUX) || defined(RT_OS_DARWIN) /** @todo UNIXISH_TAP stuff out of main and up to Config.kmk! */
" -evdevkeymap Use evdev keycode map\n"
#endif
#ifdef VBOX_WITH_VRDP
" -vrdp <port> Listen for VRDP connections on port (default if not specified)\n"
#endif
" -discardstate Discard saved state (if present) and revert to last snapshot (if present)\n"
#ifdef VBOX_SECURELABEL
" -securelabel Display a secure VM label at the top of the screen\n"
" -seclabelfnt TrueType (.ttf) font file for secure session label\n"
" -seclabelsiz Font point size for secure session label (default 12)\n"
" -seclabelofs Font offset within the secure label (default 0)\n"
" -seclabelfgcol <rgb> Secure label text color RGB value in 6 digit hexadecimal (eg: FFFF00)\n"
" -seclabelbgcol <rgb> Secure label background color RGB value in 6 digit hexadecimal (eg: FF0000)\n"
#endif
#ifdef VBOXSDL_ADVANCED_OPTIONS
" -[no]rawr0 Enable or disable raw ring 3\n"
" -[no]rawr3 Enable or disable raw ring 0\n"
" -[no]patm Enable or disable PATM\n"
" -[no]csam Enable or disable CSAM\n"
" -[no]hwvirtex Permit or deny the usage of VMX/SVN\n"
#endif
"\n"
" -convertSettings Allow to auto-convert settings files\n"
" -convertSettingsBackup Allow to auto-convert settings files\n"
" but create backup copies before\n"
" -convertSettingsIgnore Allow to auto-convert settings files\n"
" but don't explicitly save the results\n"
"\n"
"Key bindings:\n"
" <hostkey> + f Switch to full screen / restore to previous view\n"
" h Press ACPI power button\n"
" n Take a snapshot and continue execution\n"
" p Pause / resume execution\n"
" q Power off\n"
" r VM reset\n"
" s Save state and power off\n"
" <del> Send <ctrl><alt><del>\n"
" <F1>...<F12> Send <ctrl><alt><Fx>\n"
#if defined(DEBUG) || defined(VBOX_WITH_STATISTICS)
"\n"
"Further key bindings useful for debugging:\n"
" LCtrl + Alt + F12 Reset statistics counter\n"
" LCtrl + Alt + F11 Dump statistics to logfile\n"
" Alt + F12 Toggle R0 recompiler\n"
" Alt + F11 Toggle R3 recompiler\n"
" Alt + F10 Toggle PATM\n"
" Alt + F9 Toggle CSAM\n"
" Alt + F8 Toggle single step mode\n"
" LCtrl/RCtrl + F12 Toggle logger\n"
" F12 Write log marker to logfile\n"
#endif
"\n");
}
static void PrintError(const char *pszName, CBSTR pwszDescr, CBSTR pwszComponent=NULL)
{
const char *pszFile, *pszFunc, *pszStat;
char pszBuffer[1024];
com::ErrorInfo info;
RTStrPrintf(pszBuffer, sizeof(pszBuffer), "%lS", pwszDescr);
RTPrintf("\n%s! Error info:\n", pszName);
if ( (pszFile = strstr(pszBuffer, "At '"))
&& (pszFunc = strstr(pszBuffer, ") in "))
&& (pszStat = strstr(pszBuffer, "VBox status code: ")))
RTPrintf(" %.*s %.*s\n In%.*s %s",
pszFile-pszBuffer, pszBuffer,
pszFunc-pszFile+1, pszFile,
pszStat-pszFunc-4, pszFunc+4,
pszStat);
else
RTPrintf("%s\n", pszBuffer);
if (pwszComponent)
RTPrintf("(component %lS).\n", pwszComponent);
RTPrintf("\n");
}
#ifdef VBOXSDL_WITH_X11
/**
* Custom signal handler. Currently it is only used to release modifier
* keys when receiving the USR1 signal. When switching VTs, we might not
* get release events for Ctrl-Alt and in case a savestate is performed
* on the new VT, the VM will be saved with modifier keys stuck. This is
* annoying enough for introducing this hack.
*/
void signal_handler_SIGUSR1(int sig, siginfo_t *info, void *secret)
{
/* only SIGUSR1 is interesting */
if (sig == SIGUSR1)
{
/* just release the modifiers */
ResetKeys();
}
}
/**
* Custom signal handler for catching exit events.
*/
void signal_handler_SIGINT(int sig)
{
if (gpszPidFile)
RTFileDelete(gpszPidFile);
signal(SIGINT, SIG_DFL);
signal(SIGQUIT, SIG_DFL);
signal(SIGSEGV, SIG_DFL);
kill(getpid(), sig);
}
#endif /* VBOXSDL_WITH_X11 */
enum ConvertSettings
{
ConvertSettings_No = 0,
ConvertSettings_Yes = 1,
ConvertSettings_Backup = 2,
ConvertSettings_Ignore = 3,
};
/**
* Checks if any of the settings files were auto-converted and informs the
* user if so.
*
* @return @false if the program should terminate and @true otherwise.
*
* @note The function is taken from VBoxManage.cpp almost unchanged (except the
* help text).
*/
static bool checkForAutoConvertedSettings (ComPtr<IVirtualBox> virtualBox,
ComPtr<ISession> session,
ConvertSettings fConvertSettings)
{
/* return early if nothing to do */
if (fConvertSettings == ConvertSettings_Ignore)
return true;
HRESULT rc;
do
{
Bstr formatVersion;
CHECK_ERROR_BREAK(virtualBox, COMGETTER(SettingsFormatVersion) (formatVersion.asOutParam()));
bool isGlobalConverted = false;
std::list <ComPtr <IMachine> > cvtMachines;
std::list <Utf8Str> fileList;
Bstr version;
Bstr filePath;
com::SafeIfaceArray <IMachine> machines;
CHECK_ERROR_BREAK(virtualBox, COMGETTER(Machines)(ComSafeArrayAsOutParam (machines)));
for (size_t i = 0; i < machines.size(); ++ i)
{
BOOL accessible;
CHECK_ERROR_BREAK(machines[i], COMGETTER(Accessible) (&accessible));
if (!accessible)
continue;
CHECK_ERROR_BREAK(machines[i], COMGETTER(SettingsFileVersion) (version.asOutParam()));
if (version != formatVersion)
{
cvtMachines.push_back (machines[i]);
Bstr filePath;
CHECK_ERROR_BREAK(machines[i], COMGETTER(SettingsFilePath) (filePath.asOutParam()));
fileList.push_back (Utf8StrFmt ("%ls (%ls)", filePath.raw(),
version.raw()));
}
}
if (FAILED(rc))
break;
CHECK_ERROR_BREAK(virtualBox, COMGETTER(SettingsFileVersion) (version.asOutParam()));
if (version != formatVersion)
{
isGlobalConverted = true;
CHECK_ERROR_BREAK(virtualBox, COMGETTER(SettingsFilePath) (filePath.asOutParam()));
fileList.push_back (Utf8StrFmt ("%ls (%ls)", filePath.raw(),
version.raw()));
}
if (fileList.size() > 0)
{
switch (fConvertSettings)
{
case ConvertSettings_No:
{
RTPrintf (
"WARNING! The following VirtualBox settings files have been automatically\n"
"converted to the new settings file format version '%ls':\n"
"\n",
formatVersion.raw());
for (std::list <Utf8Str>::const_iterator f = fileList.begin();
f != fileList.end(); ++ f)
RTPrintf (" %S\n", (*f).raw());
RTPrintf (
"\n"
"The current command was aborted to prevent overwriting the above settings\n"
"files with the results of the auto-conversion without your permission.\n"
"Please add one of the following command line switches to the VBoxSDL command\n"
"line and repeat the command:\n"
"\n"
" -convertSettings - to save all auto-converted files (it will not\n"
" be possible to use these settings files with an\n"
" older version of VirtualBox in the future);\n"
" -convertSettingsBackup - to create backup copies of the settings files in\n"
" the old format before saving them in the new format;\n"
" -convertSettingsIgnore - to not save the auto-converted settings files.\n"
"\n"
"Note that if you use -convertSettingsIgnore, the auto-converted settings files\n"
"will be implicitly saved in the new format anyway once you change a setting or\n"
"start a virtual machine, but NO backup copies will be created in this case.\n");
return false;
}
case ConvertSettings_Yes:
case ConvertSettings_Backup:
{
break;
}
default:
AssertFailedReturn (false);
}
for (std::list <ComPtr <IMachine> >::const_iterator m = cvtMachines.begin();
m != cvtMachines.end(); ++ m)
{
Guid id;
CHECK_ERROR_BREAK((*m), COMGETTER(Id) (id.asOutParam()));
/* open a session for the VM */
CHECK_ERROR_BREAK (virtualBox, OpenSession (session, id));
ComPtr <IMachine> sm;
CHECK_ERROR_BREAK(session, COMGETTER(Machine) (sm.asOutParam()));
Bstr bakFileName;
if (fConvertSettings == ConvertSettings_Backup)
CHECK_ERROR (sm, SaveSettingsWithBackup (bakFileName.asOutParam()));
else
CHECK_ERROR (sm, SaveSettings());
session->Close();
if (FAILED(rc))
break;
}
if (FAILED(rc))
break;
if (isGlobalConverted)
{
Bstr bakFileName;
if (fConvertSettings == ConvertSettings_Backup)
CHECK_ERROR (virtualBox, SaveSettingsWithBackup (bakFileName.asOutParam()));
else
CHECK_ERROR (virtualBox, SaveSettings());
}
if (FAILED(rc))
break;
}
}
while (0);
return SUCCEEDED (rc);
}
/** entry point */
extern "C"
DECLEXPORT(int) TrustedMain(int argc, char **argv, char **envp)
{
#ifdef VBOXSDL_WITH_X11
/*
* Lock keys on SDL behave different from normal keys: A KeyPress event is generated
* if the lock mode gets active and a keyRelease event is genereated if the lock mode
* gets inactive, that is KeyPress and KeyRelease are sent when pressing the lock key
* to change the mode. The current lock mode is reflected in SDL_GetModState().
*
* Debian patched libSDL to make the lock keys behave like normal keys generating a
* KeyPress/KeyRelease event if the lock key was pressed/released. But the lock status
* is not reflected in the mod status anymore. We disable the Debian-specific extension
* to ensure a defined environment and work around the missing KeyPress/KeyRelease
* events in ProcessKeys().
*/
RTEnvSet("SDL_DISABLE_LOCK_KEYS", "1");
#endif
/*
* the hostkey detection mode is unrelated to VM processing, so handle it before
* we initialize anything COM related
*/
if (argc == 2 && !strcmp(argv[1], "-detecthostkey"))
{
int rc = SDL_InitSubSystem(SDL_INIT_VIDEO | SDL_INIT_TIMER | SDL_INIT_NOPARACHUTE);
if (rc != 0)
{
RTPrintf("Error: SDL_InitSubSystem failed with message '%s'\n", SDL_GetError());
return 1;
}
/* we need a video window for the keyboard stuff to work */
if (!SDL_SetVideoMode(640, 480, 16, SDL_SWSURFACE))
{
RTPrintf("Error: could not set SDL video mode\n");
return 1;
}
RTPrintf("Please hit one or two function key(s) to get the -hostkey value...\n");
SDL_Event event1;
while (SDL_WaitEvent(&event1))
{
if (event1.type == SDL_KEYDOWN)
{
SDL_Event event2;
unsigned mod = SDL_GetModState() & ~(KMOD_MODE | KMOD_NUM | KMOD_RESERVED);
while (SDL_WaitEvent(&event2))
{
if (event2.type == SDL_KEYDOWN || event2.type == SDL_KEYUP)
{
/* pressed additional host key */
RTPrintf("-hostkey %d", event1.key.keysym.sym);
if (event2.type == SDL_KEYDOWN)
{
RTPrintf(" %d", event2.key.keysym.sym);
RTPrintf(" %d\n", SDL_GetModState() & ~(KMOD_MODE | KMOD_NUM | KMOD_RESERVED));
}
else
{
RTPrintf(" %d\n", mod);
}
/* we're done */
break;
}
}
/* we're down */
break;
}
}
SDL_Quit();
return 1;
}
HRESULT rc;
Guid uuid;
char *vmName = NULL;
DeviceType_T bootDevice = DeviceType_Null;
uint32_t memorySize = 0;
uint32_t vramSize = 0;
VBoxSDLCallback *callback = NULL;
VBoxSDLConsoleCallback *consoleCallback = NULL;
bool fFullscreen = false;
bool fResizable = true;
#ifdef USE_XPCOM_QUEUE_THREAD
bool fXPCOMEventThreadSignaled = false;
#endif
char *hdaFile = NULL;
char *cdromFile = NULL;
char *fdaFile = NULL;
#ifdef VBOX_WITH_VRDP
int portVRDP = ~0;
#endif
bool fDiscardState = false;
#ifdef VBOX_SECURELABEL
BOOL fSecureLabel = false;
uint32_t secureLabelPointSize = 12;
uint32_t secureLabelFontOffs = 0;
char *secureLabelFontFile = NULL;
uint32_t secureLabelColorFG = 0x0000FF00;
uint32_t secureLabelColorBG = 0x00FFFF00;
#endif
#ifdef VBOXSDL_ADVANCED_OPTIONS
unsigned fRawR0 = ~0U;
unsigned fRawR3 = ~0U;
unsigned fPATM = ~0U;
unsigned fCSAM = ~0U;
TSBool_T fHWVirt = TSBool_Default;
uint32_t u32WarpDrive = 0;
#endif
#ifdef VBOX_WIN32_UI
bool fWin32UI = true;
uint64_t winId = 0;
#endif
bool fShowSDLConfig = false;
uint32_t fixedWidth = ~(uint32_t)0;
uint32_t fixedHeight = ~(uint32_t)0;
uint32_t fixedBPP = ~(uint32_t)0;
uint32_t uResizeWidth = ~(uint32_t)0;
uint32_t uResizeHeight = ~(uint32_t)0;
/* The damned GOTOs forces this to be up here - totally out of place. */
/*
* 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
* -----------------------------------------------
*/
enum HKEYSTATE
{
/** The initial and most common state, pass keystrokes to the guest.
* Next state: HKEYSTATE_DOWN
* Prev state: Any */
HKEYSTATE_NORMAL = 1,
/** The first host key was pressed down
*/
HKEYSTATE_DOWN_1ST,
/** The second host key was pressed down (if gHostKeySym2 != SDLK_UNKNOWN)
*/
HKEYSTATE_DOWN_2ND,
/** 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
} enmHKeyState = HKEYSTATE_NORMAL;
/** The host key down event which we have been hiding from the guest.
* Used when going from HKEYSTATE_DOWN to HKEYSTATE_NOT_IT. */
SDL_Event EvHKeyDown1;
SDL_Event EvHKeyDown2;
LogFlow(("SDL GUI started\n"));
RTPrintf("Sun VirtualBox SDL GUI version %s\n"
"(C) 2005-2009 Sun Microsystems, Inc.\n"
"All rights reserved.\n\n",
VBOX_VERSION_STRING);
// less than one parameter is not possible
if (argc < 2)
{
show_usage();
return 1;
}
rc = com::Initialize();
if (FAILED(rc))
{
RTPrintf("Error: COM initialization failed, rc = 0x%x!\n", rc);
return 1;
}
do
{
// scopes all the stuff till shutdown
////////////////////////////////////////////////////////////////////////////
ComPtr <IVirtualBox> virtualBox;
ComPtr <ISession> session;
bool sessionOpened = false;
rc = virtualBox.createLocalObject (CLSID_VirtualBox);
if (FAILED(rc))
{
com::ErrorInfo info;
if (info.isFullAvailable())
PrintError("Failed to create VirtualBox object",
info.getText().raw(), info.getComponent().raw());
else
RTPrintf("Failed to create VirtualBox object! No error information available (rc = 0x%x).\n", rc);
break;
}
rc = session.createInprocObject (CLSID_Session);
if (FAILED(rc))
{
RTPrintf("Failed to create session object, rc = 0x%x!\n", rc);
break;
}
// create the event queue
// (here it is necessary only to process remaining XPCOM/IPC events
// after the session is closed)
/// @todo
// EventQueue eventQ;
#ifdef USE_XPCOM_QUEUE_THREAD
nsCOMPtr<nsIEventQueue> eventQ;
NS_GetMainEventQ(getter_AddRefs(eventQ));
#endif /* USE_XPCOM_QUEUE_THREAD */
/* Get the number of network adapters */
ULONG NetworkAdapterCount = 0;
ComPtr <ISystemProperties> sysInfo;
virtualBox->COMGETTER(SystemProperties) (sysInfo.asOutParam());
sysInfo->COMGETTER (NetworkAdapterCount) (&NetworkAdapterCount);
ConvertSettings fConvertSettings = ConvertSettings_No;
// command line argument parsing stuff
for (int curArg = 1; curArg < argc; curArg++)
{
if ( strcmp(argv[curArg], "-vm") == 0
|| strcmp(argv[curArg], "-startvm") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: VM not specified (UUID or name)!\n");
rc = E_FAIL;
break;
}
// first check if a UUID was supplied
if (RT_FAILURE(RTUuidFromStr(uuid.ptr(), argv[curArg])))
{
LogFlow(("invalid UUID format, assuming it's a VM name\n"));
vmName = argv[curArg];
}
}
else if (strcmp(argv[curArg], "-boot") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing argument for boot drive!\n");
rc = E_FAIL;
break;
}
switch (argv[curArg][0])
{
case 'a':
{
bootDevice = DeviceType_Floppy;
break;
}
case 'c':
{
bootDevice = DeviceType_HardDisk;
break;
}
case 'd':
{
bootDevice = DeviceType_DVD;
break;
}
case 'n':
{
bootDevice = DeviceType_Network;
break;
}
default:
{
RTPrintf("Error: wrong argument for boot drive!\n");
rc = E_FAIL;
break;
}
}
if (FAILED (rc))
break;
}
else if (strcmp(argv[curArg], "-m") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing argument for memory size!\n");
rc = E_FAIL;
break;
}
memorySize = atoi(argv[curArg]);
}
else if (strcmp(argv[curArg], "-vram") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing argument for vram size!\n");
rc = E_FAIL;
break;
}
vramSize = atoi(argv[curArg]);
}
else if (strcmp(argv[curArg], "-fullscreen") == 0)
{
fFullscreen = true;
}
else if (strcmp(argv[curArg], "-fullscreenresize") == 0)
{
gfFullscreenResize = true;
#ifdef VBOXSDL_WITH_X11
RTEnvSet("SDL_VIDEO_X11_VIDMODE", "0");
#endif
}
else if (strcmp(argv[curArg], "-fixedmode") == 0)
{
/* three parameters follow */
if (curArg + 3 >= argc)
{
RTPrintf("Error: missing arguments for fixed video mode!\n");
rc = E_FAIL;
break;
}
fixedWidth = atoi(argv[++curArg]);
fixedHeight = atoi(argv[++curArg]);
fixedBPP = atoi(argv[++curArg]);
}
else if (strcmp(argv[curArg], "-nofstoggle") == 0)
{
gfAllowFullscreenToggle = FALSE;
}
else if (strcmp(argv[curArg], "-noresize") == 0)
{
fResizable = false;
}
else if (strcmp(argv[curArg], "-nohostkey") == 0)
{
gHostKeyMod = 0;
gHostKeySym1 = 0;
}
else if (strcmp(argv[curArg], "-nohostkeys") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing a string of disabled hostkey combinations\n");
rc = E_FAIL;
break;
}
gHostKeyDisabledCombinations = argv[curArg];
unsigned i, cStr = strlen(gHostKeyDisabledCombinations);
for (i=0; i<cStr; i++)
{
if (!strchr("fhnpqrs", gHostKeyDisabledCombinations[i]))
{
RTPrintf("Error: <hostkey> + '%c' is not a valid combination\n",
gHostKeyDisabledCombinations[i]);
rc = E_FAIL;
i = cStr;
break;
}
}
if (rc == E_FAIL)
break;
}
else if (strcmp(argv[curArg], "-nograbonclick") == 0)
{
gfGrabOnMouseClick = FALSE;
}
else if (strcmp(argv[curArg], "-termacpi") == 0)
{
gfACPITerm = TRUE;
}
else if (strcmp(argv[curArg], "-pidfile") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing file name for -pidfile!\n");
rc = E_FAIL;
break;
}
gpszPidFile = argv[curArg];
}
else if (strcmp(argv[curArg], "-hda") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing file name for first hard disk!\n");
rc = E_FAIL;
break;
}
/* resolve it. */
if (RTPathExists(argv[curArg]))
hdaFile = RTPathRealDup(argv[curArg]);
if (!hdaFile)
{
RTPrintf("Error: The path to the specified harddisk, '%s', could not be resolved.\n", argv[curArg]);
rc = E_FAIL;
break;
}
}
else if (strcmp(argv[curArg], "-fda") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing file/device name for first floppy disk!\n");
rc = E_FAIL;
break;
}
/* resolve it. */
if (RTPathExists(argv[curArg]))
fdaFile = RTPathRealDup(argv[curArg]);
if (!fdaFile)
{
RTPrintf("Error: The path to the specified floppy disk, '%s', could not be resolved.\n", argv[curArg]);
rc = E_FAIL;
break;
}
}
else if (strcmp(argv[curArg], "-cdrom") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing file/device name for cdrom!\n");
rc = E_FAIL;
break;
}
/* resolve it. */
if (RTPathExists(argv[curArg]))
cdromFile = RTPathRealDup(argv[curArg]);
if (!cdromFile)
{
RTPrintf("Error: The path to the specified cdrom, '%s', could not be resolved.\n", argv[curArg]);
rc = E_FAIL;
break;
}
}
#ifdef RT_OS_LINUX
else if (strcmp(argv[curArg], "-evdevkeymap") == 0)
{
guseEvdevKeymap = TRUE;
}
#endif /* RT_OS_LINUX */
#ifdef VBOX_WITH_VRDP
else if (strcmp(argv[curArg], "-vrdp") == 0)
{
// start with the standard VRDP port
portVRDP = 0;
// is there another argument
if (argc > (curArg + 1))
{
// check if the next argument is a number
int port = atoi(argv[curArg + 1]);
if (port > 0)
{
curArg++;
portVRDP = port;
LogFlow(("Using non standard VRDP port %d\n", portVRDP));
}
}
}
#endif /* VBOX_WITH_VRDP */
else if (strcmp(argv[curArg], "-discardstate") == 0)
{
fDiscardState = true;
}
#ifdef VBOX_SECURELABEL
else if (strcmp(argv[curArg], "-securelabel") == 0)
{
fSecureLabel = true;
LogFlow(("Secure labelling turned on\n"));
}
else if (strcmp(argv[curArg], "-seclabelfnt") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing font file name for secure label!\n");
rc = E_FAIL;
break;
}
secureLabelFontFile = argv[curArg];
}
else if (strcmp(argv[curArg], "-seclabelsiz") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing font point size for secure label!\n");
rc = E_FAIL;
break;
}
secureLabelPointSize = atoi(argv[curArg]);
}
else if (strcmp(argv[curArg], "-seclabelofs") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing font pixel offset for secure label!\n");
rc = E_FAIL;
break;
}
secureLabelFontOffs = atoi(argv[curArg]);
}
else if (strcmp(argv[curArg], "-seclabelfgcol") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing text color value for secure label!\n");
rc = E_FAIL;
break;
}
sscanf(argv[curArg], "%X", &secureLabelColorFG);
}
else if (strcmp(argv[curArg], "-seclabelbgcol") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing background color value for secure label!\n");
rc = E_FAIL;
break;
}
sscanf(argv[curArg], "%X", &secureLabelColorBG);
}
#endif
#ifdef VBOXSDL_ADVANCED_OPTIONS
else if (strcmp(argv[curArg], "-rawr0") == 0)
fRawR0 = true;
else if (strcmp(argv[curArg], "-norawr0") == 0)
fRawR0 = false;
else if (strcmp(argv[curArg], "-rawr3") == 0)
fRawR3 = true;
else if (strcmp(argv[curArg], "-norawr3") == 0)
fRawR3 = false;
else if (strcmp(argv[curArg], "-patm") == 0)
fPATM = true;
else if (strcmp(argv[curArg], "-nopatm") == 0)
fPATM = false;
else if (strcmp(argv[curArg], "-csam") == 0)
fCSAM = true;
else if (strcmp(argv[curArg], "-nocsam") == 0)
fCSAM = false;
else if (strcmp(argv[curArg], "-hwvirtex") == 0)
fHWVirt = TSBool_True;
else if (strcmp(argv[curArg], "-nohwvirtex") == 0)
fHWVirt = TSBool_False;
else if (strcmp(argv[curArg], "-warpdrive") == 0)
{
if (++curArg >= argc)
{
RTPrintf("Error: missing the rate value for the -warpdrive option!\n");
rc = E_FAIL;
break;
}
u32WarpDrive = RTStrToUInt32(argv[curArg]);
if (u32WarpDrive < 2 || u32WarpDrive > 20000)
{
RTPrintf("Error: the warp drive rate is restricted to [2..20000]. (%d)\n", u32WarpDrive);
rc = E_FAIL;
break;
}
}
#endif /* VBOXSDL_ADVANCED_OPTIONS */
#ifdef VBOX_WIN32_UI
else if (strcmp(argv[curArg], "-win32ui") == 0)
fWin32UI = true;
#endif
else if (strcmp(argv[curArg], "-showsdlconfig") == 0)
fShowSDLConfig = true;
else if (strcmp(argv[curArg], "-hostkey") == 0)
{
if (++curArg + 1 >= argc)
{
RTPrintf("Error: not enough arguments for host keys!\n");
rc = E_FAIL;
break;
}
gHostKeySym1 = atoi(argv[curArg++]);
if (curArg + 1 < argc && (argv[curArg+1][0] == '0' || atoi(argv[curArg+1]) > 0))
{
/* two-key sequence as host key specified */
gHostKeySym2 = atoi(argv[curArg++]);
}
gHostKeyMod = atoi(argv[curArg]);
}
else if (strcmp(argv[curArg], "-convertSettings") == 0)
fConvertSettings = ConvertSettings_Yes;
else if (strcmp(argv[curArg], "-convertSettingsBackup") == 0)
fConvertSettings = ConvertSettings_Backup;
else if (strcmp(argv[curArg], "-convertSettingsIgnore") == 0)
fConvertSettings = ConvertSettings_Ignore;
/* just show the help screen */
else
{
if ( strcmp(argv[curArg], "-h") != 0
&& strcmp(argv[curArg], "-help") != 0
&& strcmp(argv[curArg], "--help"))
RTPrintf("Error: unrecognized switch '%s'\n", argv[curArg]);
show_usage();
return 1;
}
}
if (FAILED (rc))
break;
if (!checkForAutoConvertedSettings (virtualBox, session, fConvertSettings))
break;
/*
* Do we have a name but no UUID?
*/
if (vmName && uuid.isEmpty())
{
ComPtr<IMachine> aMachine;
Bstr bstrVMName = vmName;
rc = virtualBox->FindMachine(bstrVMName, aMachine.asOutParam());
if ((rc == S_OK) && aMachine)
{
aMachine->COMGETTER(Id)(uuid.asOutParam());
}
else
{
RTPrintf("Error: machine with the given ID not found!\n");
goto leave;
}
}
else if (uuid.isEmpty())
{
RTPrintf("Error: no machine specified!\n");
goto leave;
}
/* create SDL event semaphore */
rc = RTSemEventCreate(&g_EventSemSDLEvents);
AssertReleaseRC(rc);
rc = virtualBox->OpenSession(session, uuid);
if (FAILED(rc))
{
com::ErrorInfo info;
if (info.isFullAvailable())
PrintError("Could not open VirtualBox session",
info.getText().raw(), info.getComponent().raw());
goto leave;
}
if (!session)
{
RTPrintf("Could not open VirtualBox session!\n");
goto leave;
}
sessionOpened = true;
// get the VM we're dealing with
session->COMGETTER(Machine)(gMachine.asOutParam());
if (!gMachine)
{
com::ErrorInfo info;
if (info.isFullAvailable())
PrintError("Cannot start VM!",
info.getText().raw(), info.getComponent().raw());
else
RTPrintf("Error: given machine not found!\n");
goto leave;
}
// get the VM console
session->COMGETTER(Console)(gConsole.asOutParam());
if (!gConsole)
{
RTPrintf("Given console not found!\n");
goto leave;
}
/*
* Are we supposed to use a different hard disk file?
*/
if (hdaFile)
{
/*
* Strategy: iterate through all registered hard disk
* and see if one of them points to the same file. If
* so, assign it. If not, register a new image and assing
* it to the VM.
*/
Bstr hdaFileBstr = hdaFile;
ComPtr<IHardDisk> hardDisk;
virtualBox->FindHardDisk(hdaFileBstr, hardDisk.asOutParam());
if (!hardDisk)
{
/* we've not found the image */
RTPrintf("Adding hard disk '%S'...\n", hdaFile);
virtualBox->OpenHardDisk(hdaFileBstr, AccessMode_ReadWrite, hardDisk.asOutParam());
}
/* do we have the right image now? */
if (hardDisk)
{
/*
* Go and attach it!
*/
Guid uuid;
hardDisk->COMGETTER(Id)(uuid.asOutParam());
gMachine->DetachHardDisk(Bstr("IDE"), 0, 0);
gMachine->AttachHardDisk(uuid, Bstr("IDE"), 0, 0);
/// @todo why is this attachment saved?
}
else
{
RTPrintf("Error: failed to mount the specified hard disk image!\n");
goto leave;
}
}
/*
* Mount a floppy if requested.
*/
if (fdaFile)
do
{
ComPtr<IFloppyDrive> drive;
CHECK_ERROR_BREAK (gMachine, COMGETTER(FloppyDrive)(drive.asOutParam()));
/*
* First special case 'none' to unmount
*/
if (strcmp (fdaFile, "none") == 0)
{
CHECK_ERROR_BREAK (drive, Unmount());
break;
}
Bstr medium = fdaFile;
bool done = false;
/* Assume it's a host drive name */
{
ComPtr <IHost> host;
CHECK_ERROR_BREAK (virtualBox, COMGETTER(Host)(host.asOutParam()));
com::SafeIfaceArray <IHostFloppyDrive> coll;
CHECK_ERROR_BREAK (host, COMGETTER(FloppyDrives)(ComSafeArrayAsOutParam(coll)));
ComPtr <IHostFloppyDrive> hostDrive;
rc = host->FindHostFloppyDrive (medium, hostDrive.asOutParam());
if (SUCCEEDED (rc))
{
done = true;
CHECK_ERROR_BREAK (drive, CaptureHostDrive (hostDrive));
}
}
/* Must be an image */
if (!done)
{
/* try to find an existing one */
ComPtr<IFloppyImage> image;
rc = virtualBox->FindFloppyImage (medium, image.asOutParam());
if (FAILED (rc))
{
/* try to add to the list */
RTPrintf ("Adding floppy image '%S'...\n", fdaFile);
Guid uuid;
CHECK_ERROR_BREAK (virtualBox, OpenFloppyImage (medium, uuid,
image.asOutParam()));
}
/* attach */
Guid uuid;
image->COMGETTER(Id)(uuid.asOutParam());
CHECK_ERROR_BREAK (drive, MountImage (uuid));
}
}
while (0);
if (FAILED (rc))
goto leave;
/*
* Mount a CD-ROM if requested.
*/
if (cdromFile)
do
{
ComPtr<IDVDDrive> drive;
CHECK_ERROR_BREAK (gMachine, COMGETTER(DVDDrive)(drive.asOutParam()));
/*
* First special case 'none' to unmount
*/
if (strcmp (cdromFile, "none") == 0)
{
CHECK_ERROR_BREAK (drive, Unmount());
break;
}
Bstr medium = cdromFile;
bool done = false;
/* Assume it's a host drive name */
{
ComPtr <IHost> host;
CHECK_ERROR_BREAK (virtualBox, COMGETTER(Host)(host.asOutParam()));
SafeIfaceArray <IHostDVDDrive> coll;
CHECK_ERROR_BREAK (host, COMGETTER(DVDDrives)(ComSafeArrayAsOutParam(coll)));
ComPtr <IHostDVDDrive> hostDrive;
rc = host->FindHostDVDDrive (medium, hostDrive.asOutParam());
if (SUCCEEDED (rc))
{
done = true;
CHECK_ERROR_BREAK (drive, CaptureHostDrive (hostDrive));
}
}
/* Must be an image */
if (!done)
{
/* try to find an existing one */
ComPtr <IDVDImage> image;
rc = virtualBox->FindDVDImage (medium, image.asOutParam());
if (FAILED (rc))
{
/* try to add to the list */
RTPrintf ("Adding ISO image '%S'...\n", cdromFile);
Guid uuid;
CHECK_ERROR_BREAK (virtualBox, OpenDVDImage (medium, uuid,
image.asOutParam()));
}
/* attach */
Guid uuid;
image->COMGETTER(Id)(uuid.asOutParam());
CHECK_ERROR_BREAK (drive, MountImage (uuid));
}
}
while (0);
if (FAILED (rc))
goto leave;
if (fDiscardState)
{
/*
* If the machine is currently saved,
* discard the saved state first.
*/
MachineState_T machineState;
gMachine->COMGETTER(State)(&machineState);
if (machineState == MachineState_Saved)
{
CHECK_ERROR(gConsole, DiscardSavedState());
}
/*
* If there are snapshots, discard the current state,
* i.e. revert to the last snapshot.
*/
ULONG cSnapshots;
gMachine->COMGETTER(SnapshotCount)(&cSnapshots);
if (cSnapshots)
{
gProgress = NULL;
CHECK_ERROR(gConsole, DiscardCurrentState(gProgress.asOutParam()));
rc = gProgress->WaitForCompletion(-1);
}
}
// get the machine debugger (does not have to be there)
gConsole->COMGETTER(Debugger)(gMachineDebugger.asOutParam());
if (gMachineDebugger)
{
Log(("Machine debugger available!\n"));
}
gConsole->COMGETTER(Display)(gDisplay.asOutParam());
if (!gDisplay)
{
RTPrintf("Error: could not get display object!\n");
goto leave;
}
// set the boot drive
if (bootDevice != DeviceType_Null)
{
rc = gMachine->SetBootOrder(1, bootDevice);
if (rc != S_OK)
{
RTPrintf("Error: could not set boot device, using default.\n");
}
}
// set the memory size if not default
if (memorySize)
{
rc = gMachine->COMSETTER(MemorySize)(memorySize);
if (rc != S_OK)
{
ULONG ramSize = 0;
gMachine->COMGETTER(MemorySize)(&ramSize);
RTPrintf("Error: could not set memory size, using current setting of %d MBytes\n", ramSize);
}
}
if (vramSize)
{
rc = gMachine->COMSETTER(VRAMSize)(vramSize);
if (rc != S_OK)
{
gMachine->COMGETTER(VRAMSize)((ULONG*)&vramSize);
RTPrintf("Error: could not set VRAM size, using current setting of %d MBytes\n", vramSize);
}
}
// we're always able to process absolute mouse events and we prefer that
gfAbsoluteMouseHost = TRUE;
#ifdef VBOX_WIN32_UI
if (fWin32UI)
{
/* initialize the Win32 user interface inside which SDL will be embedded */
if (initUI(fResizable, winId))
return 1;
}
#endif
// create our SDL framebuffer instance
gpFrameBuffer = new VBoxSDLFB(fFullscreen, fResizable, fShowSDLConfig, false,
fixedWidth, fixedHeight, fixedBPP);
if (!gpFrameBuffer)
{
RTPrintf("Error: could not create framebuffer object!\n");
goto leave;
}
#ifdef VBOX_WIN32_UI
gpFrameBuffer->setWinId(winId);
#endif
if (!gpFrameBuffer->initialized())
goto leave;
gpFrameBuffer->AddRef();
if (fFullscreen)
SetFullscreen(true);
#ifdef VBOX_SECURELABEL
if (fSecureLabel)
{
if (!secureLabelFontFile)
{
RTPrintf("Error: no font file specified for secure label!\n");
goto leave;
}
/* load the SDL_ttf library and get the required imports */
int rcVBox;
rcVBox = RTLdrLoad(LIBSDL_TTF_NAME, &gLibrarySDL_ttf);
if (RT_SUCCESS(rcVBox))
rcVBox = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_Init", (void**)&pTTF_Init);
if (RT_SUCCESS(rcVBox))
rcVBox = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_OpenFont", (void**)&pTTF_OpenFont);
if (RT_SUCCESS(rcVBox))
rcVBox = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_RenderUTF8_Solid", (void**)&pTTF_RenderUTF8_Solid);
if (RT_SUCCESS(rcVBox))
{
/* silently ignore errors here */
rcVBox = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_RenderUTF8_Blended", (void**)&pTTF_RenderUTF8_Blended);
if (RT_FAILURE(rcVBox))
pTTF_RenderUTF8_Blended = NULL;
rcVBox = VINF_SUCCESS;
}
if (RT_SUCCESS(rcVBox))
rcVBox = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_CloseFont", (void**)&pTTF_CloseFont);
if (RT_SUCCESS(rcVBox))
rcVBox = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_Quit", (void**)&pTTF_Quit);
if (RT_SUCCESS(rcVBox))
rcVBox = gpFrameBuffer->initSecureLabel(SECURE_LABEL_HEIGHT, secureLabelFontFile, secureLabelPointSize, secureLabelFontOffs);
if (RT_FAILURE(rcVBox))
{
RTPrintf("Error: could not initialize secure labeling: rc = %Rrc\n", rcVBox);
goto leave;
}
Bstr key = VBOXSDL_SECURELABEL_EXTRADATA;
Bstr label;
gMachine->GetExtraData(key, label.asOutParam());
Utf8Str labelUtf8 = label;
/*
* Now update the label
*/
gpFrameBuffer->setSecureLabelColor(secureLabelColorFG, secureLabelColorBG);
gpFrameBuffer->setSecureLabelText(labelUtf8.raw());
}
#endif
#ifdef VBOXSDL_WITH_X11
/* NOTE1: We still want Ctrl-C to work, so we undo the SDL redirections.
* NOTE2: We have to remove the PidFile if this file exists. */
signal(SIGINT, signal_handler_SIGINT);
signal(SIGQUIT, signal_handler_SIGINT);
signal(SIGSEGV, signal_handler_SIGINT);
#endif
// register our framebuffer
rc = gDisplay->RegisterExternalFramebuffer(gpFrameBuffer);
if (rc != S_OK)
{
RTPrintf("Error: could not register framebuffer object!\n");
goto leave;
}
// register a callback for global events
callback = new VBoxSDLCallback();
callback->AddRef();
virtualBox->RegisterCallback(callback);
// register a callback for machine events
consoleCallback = new VBoxSDLConsoleCallback();
consoleCallback->AddRef();
gConsole->RegisterCallback(consoleCallback);
// until we've tried to to start the VM, ignore power off events
consoleCallback->ignorePowerOffEvents(true);
#ifdef VBOX_WITH_VRDP
if (portVRDP != ~0)
{
rc = gMachine->COMGETTER(VRDPServer)(gVrdpServer.asOutParam());
AssertMsg((rc == S_OK) && gVrdpServer, ("Could not get VRDP Server! rc = 0x%x\n", rc));
if (gVrdpServer)
{
// has a non standard VRDP port been requested?
if (portVRDP > 0)
{
rc = gVrdpServer->COMSETTER(Port)(portVRDP);
if (rc != S_OK)
{
RTPrintf("Error: could not set VRDP port! rc = 0x%x\n", rc);
goto leave;
}
}
// now enable VRDP
rc = gVrdpServer->COMSETTER(Enabled)(TRUE);
if (rc != S_OK)
{
RTPrintf("Error: could not enable VRDP server! rc = 0x%x\n", rc);
goto leave;
}
}
}
#endif
rc = E_FAIL;
#ifdef VBOXSDL_ADVANCED_OPTIONS
if (fRawR0 != ~0U)
{
if (!gMachineDebugger)
{
RTPrintf("Error: No debugger object; -%srawr0 cannot be executed!\n", fRawR0 ? "" : "no");
goto leave;
}
gMachineDebugger->COMSETTER(RecompileSupervisor)(!fRawR0);
}
if (fRawR3 != ~0U)
{
if (!gMachineDebugger)
{
RTPrintf("Error: No debugger object; -%srawr3 cannot be executed!\n", fRawR0 ? "" : "no");
goto leave;
}
gMachineDebugger->COMSETTER(RecompileUser)(!fRawR3);
}
if (fPATM != ~0U)
{
if (!gMachineDebugger)
{
RTPrintf("Error: No debugger object; -%spatm cannot be executed!\n", fRawR0 ? "" : "no");
goto leave;
}
gMachineDebugger->COMSETTER(PATMEnabled)(fPATM);
}
if (fCSAM != ~0U)
{
if (!gMachineDebugger)
{
RTPrintf("Error: No debugger object; -%scsam cannot be executed!\n", fRawR0 ? "" : "no");
goto leave;
}
gMachineDebugger->COMSETTER(CSAMEnabled)(fCSAM);
}
if (fHWVirt != TSBool_Default)
{
gMachine->COMSETTER(HWVirtExEnabled)(fHWVirt);
}
if (u32WarpDrive != 0)
{
if (!gMachineDebugger)
{
RTPrintf("Error: No debugger object; -warpdrive %d cannot be executed!\n", u32WarpDrive);
goto leave;
}
gMachineDebugger->COMSETTER(VirtualTimeRate)(u32WarpDrive);
}
#endif /* VBOXSDL_ADVANCED_OPTIONS */
/* start with something in the titlebar */
UpdateTitlebar(TITLEBAR_NORMAL);
/* memorize the default cursor */
gpDefaultCursor = SDL_GetCursor();
#ifdef VBOXSDL_WITH_X11
/* Get Window Manager info. We only need the X11 display. */
SDL_VERSION(&gSdlInfo.version);
if (!SDL_GetWMInfo(&gSdlInfo))
{
RTPrintf("Error: could not get SDL Window Manager info!\n");
goto leave;
}
# if !defined(VBOX_WITHOUT_XCURSOR)
/* SDL uses its own (plain) default cursor. Use the left arrow cursor instead which might look
* much better if a mouse cursor theme is installed. */
gpDefaultOrigX11Cursor = *(Cursor*)gpDefaultCursor->wm_cursor;
*(Cursor*)gpDefaultCursor->wm_cursor = XCreateFontCursor(gSdlInfo.info.x11.display, XC_left_ptr);
SDL_SetCursor(gpDefaultCursor);
# endif
#endif /* VBOXSDL_WITH_X11 */
/* create a fake empty cursor */
{
uint8_t cursorData[1] = {0};
gpCustomCursor = SDL_CreateCursor(cursorData, cursorData, 8, 1, 0, 0);
gpCustomOrigWMcursor = gpCustomCursor->wm_cursor;
gpCustomCursor->wm_cursor = NULL;
}
/*
* Register our user signal handler.
*/
#ifdef VBOXSDL_WITH_X11
struct sigaction sa;
sa.sa_sigaction = signal_handler_SIGUSR1;
sigemptyset (&sa.sa_mask);
sa.sa_flags = SA_RESTART | SA_SIGINFO;
sigaction (SIGUSR1, &sa, NULL);
#endif /* VBOXSDL_WITH_X11 */
/*
* Start the VM execution thread. This has to be done
* asynchronously as powering up can take some time
* (accessing devices such as the host DVD drive). In
* the meantime, we have to service the SDL event loop.
*/
SDL_Event event;
LogFlow(("Powering up the VM...\n"));
rc = gConsole->PowerUp(gProgress.asOutParam());
if (rc != S_OK)
{
com::ErrorInfo info(gConsole);
if (info.isBasicAvailable())
PrintError("Failed to power up VM", info.getText().raw());
else
RTPrintf("Error: failed to power up VM! No error text available.\n");
goto leave;
}
#ifdef USE_XPCOM_QUEUE_THREAD
/*
* Before we starting to do stuff, we have to launch the XPCOM
* event queue thread. It will wait for events and send messages
* to the SDL thread. After having done this, we should fairly
* quickly start to process the SDL event queue as an XPCOM
* event storm might arrive. Stupid SDL has a ridiculously small
* event queue buffer!
*/
startXPCOMEventQueueThread(eventQ->GetEventQueueSelectFD());
#endif /* USE_XPCOM_QUEUE_THREAD */
/* termination flag */
bool fTerminateDuringStartup;
fTerminateDuringStartup = false;
LogRel(("VBoxSDL: NUM lock initially %s, CAPS lock initially %s\n",
!!(SDL_GetModState() & KMOD_NUM) ? "ON" : "OFF",
!!(SDL_GetModState() & KMOD_CAPS) ? "ON" : "OFF"));
/* start regular timer so we don't starve in the event loop */
SDL_TimerID sdlTimer;
sdlTimer = SDL_AddTimer(100, StartupTimer, NULL);
/* loop until the powerup processing is done */
MachineState_T machineState;
do
{
rc = gMachine->COMGETTER(State)(&machineState);
if ( rc == S_OK
&& ( machineState == MachineState_Starting
|| machineState == MachineState_Restoring))
{
/*
* wait for the next event. This is uncritical as
* power up guarantees to change the machine state
* to either running or aborted and a machine state
* change will send us an event. However, we have to
* service the XPCOM event queue!
*/
#ifdef USE_XPCOM_QUEUE_THREAD
if (!fXPCOMEventThreadSignaled)
{
signalXPCOMEventQueueThread();
fXPCOMEventThreadSignaled = true;
}
#endif
/*
* Wait for SDL events.
*/
if (WaitSDLEvent(&event))
{
switch (event.type)
{
/*
* Timer event. Used to have the titlebar updated.
*/
case SDL_USER_EVENT_TIMER:
{
/*
* Update the title bar.
*/
UpdateTitlebar(TITLEBAR_STARTUP);
break;
}
/*
* User specific resize event.
*/
case SDL_USER_EVENT_RESIZE:
{
LogFlow(("SDL_USER_EVENT_RESIZE\n"));
gpFrameBuffer->resizeGuest();
/* notify the display that the resize has been completed */
gDisplay->ResizeCompleted(0);
break;
}
#ifdef USE_XPCOM_QUEUE_THREAD
/*
* User specific XPCOM event queue event
*/
case SDL_USER_EVENT_XPCOM_EVENTQUEUE:
{
LogFlow(("SDL_USER_EVENT_XPCOM_EVENTQUEUE: processing XPCOM event queue...\n"));
eventQ->ProcessPendingEvents();
signalXPCOMEventQueueThread();
break;
}
#endif /* USE_XPCOM_QUEUE_THREAD */
/*
* Termination event from the on state change callback.
*/
case SDL_USER_EVENT_TERMINATE:
{
if (event.user.code != VBOXSDL_TERM_NORMAL)
{
com::ProgressErrorInfo info(gProgress);
if (info.isBasicAvailable())
PrintError("Failed to power up VM", info.getText().raw());
else
RTPrintf("Error: failed to power up VM! No error text available.\n");
}
fTerminateDuringStartup = true;
break;
}
default:
{
LogBird(("VBoxSDL: Unknown SDL event %d (pre)\n", event.type));
break;
}
}
}
}
} while ( rc == S_OK
&& ( machineState == MachineState_Starting
|| machineState == MachineState_Restoring));
/* kill the timer again */
SDL_RemoveTimer(sdlTimer);
sdlTimer = 0;
/* are we supposed to terminate the process? */
if (fTerminateDuringStartup)
goto leave;
/* did the power up succeed? */
if (machineState != MachineState_Running)
{
com::ProgressErrorInfo info(gProgress);
if (info.isBasicAvailable())
PrintError("Failed to power up VM", info.getText().raw());
else
RTPrintf("Error: failed to power up VM! No error text available (rc = 0x%x state = %d)\n", rc, machineState);
goto leave;
}
// accept power off events from now on because we're running
// note that there's a possible race condition here...
consoleCallback->ignorePowerOffEvents(false);
rc = gConsole->COMGETTER(Keyboard)(gKeyboard.asOutParam());
if (!gKeyboard)
{
RTPrintf("Error: could not get keyboard object!\n");
goto leave;
}
gConsole->COMGETTER(Mouse)(gMouse.asOutParam());
if (!gMouse)
{
RTPrintf("Error: could not get mouse object!\n");
goto leave;
}
UpdateTitlebar(TITLEBAR_NORMAL);
/*
* Enable keyboard repeats
*/
SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
/*
* Create PID file.
*/
if (gpszPidFile)
{
char szBuf[32];
const char *pcszLf = "\n";
RTFILE PidFile;
RTFileOpen(&PidFile, gpszPidFile, RTFILE_O_WRITE | RTFILE_O_CREATE_REPLACE);
RTStrFormatNumber(szBuf, RTProcSelf(), 10, 0, 0, 0);
RTFileWrite(PidFile, szBuf, strlen(szBuf), NULL);
RTFileWrite(PidFile, pcszLf, strlen(pcszLf), NULL);
RTFileClose(PidFile);
}
/*
* Main event loop
*/
#ifdef USE_XPCOM_QUEUE_THREAD
if (!fXPCOMEventThreadSignaled)
{
signalXPCOMEventQueueThread();
}
#endif
LogFlow(("VBoxSDL: Entering big event loop\n"));
while (WaitSDLEvent(&event))
{
switch (event.type)
{
/*
* The screen needs to be repainted.
*/
case SDL_VIDEOEXPOSE:
{
/// @todo that somehow doesn't seem to work!
gpFrameBuffer->repaint();
break;
}
/*
* Keyboard events.
*/
case SDL_KEYDOWN:
case SDL_KEYUP:
{
SDLKey ksym = event.key.keysym.sym;
switch (enmHKeyState)
{
case HKEYSTATE_NORMAL:
{
if ( event.type == SDL_KEYDOWN
&& ksym != SDLK_UNKNOWN
&& (ksym == gHostKeySym1 || ksym == gHostKeySym2))
{
EvHKeyDown1 = event;
enmHKeyState = ksym == gHostKeySym1 ? HKEYSTATE_DOWN_1ST
: HKEYSTATE_DOWN_2ND;
break;
}
ProcessKey(&event.key);
break;
}
case HKEYSTATE_DOWN_1ST:
case HKEYSTATE_DOWN_2ND:
{
if (gHostKeySym2 != SDLK_UNKNOWN)
{
if ( event.type == SDL_KEYDOWN
&& ksym != SDLK_UNKNOWN
&& ( (enmHKeyState == HKEYSTATE_DOWN_1ST && ksym == gHostKeySym2)
|| (enmHKeyState == HKEYSTATE_DOWN_2ND && ksym == gHostKeySym1)))
{
EvHKeyDown2 = event;
enmHKeyState = HKEYSTATE_DOWN;
break;
}
enmHKeyState = event.type == SDL_KEYUP ? HKEYSTATE_NORMAL
: HKEYSTATE_NOT_IT;
ProcessKey(&EvHKeyDown1.key);
ProcessKey(&event.key);
break;
}
/* fall through if no two-key sequence is used */
}
case HKEYSTATE_DOWN:
{
if (event.type == SDL_KEYDOWN)
{
/* potential host key combination, try execute it */
int rc = HandleHostKey(&event.key);
if (rc == VINF_SUCCESS)
{
enmHKeyState = HKEYSTATE_USED;
break;
}
if (RT_SUCCESS(rc))
goto leave;
}
else /* SDL_KEYUP */
{
if ( ksym != SDLK_UNKNOWN
&& (ksym == gHostKeySym1 || ksym == gHostKeySym2))
{
/* toggle grabbing state */
if (!gfGrabbed)
InputGrabStart();
else
InputGrabEnd();
/* SDL doesn't always reset the keystates, correct it */
ResetKeys();
enmHKeyState = HKEYSTATE_NORMAL;
break;
}
}
/* not host key */
enmHKeyState = HKEYSTATE_NOT_IT;
ProcessKey(&EvHKeyDown1.key);
if (gHostKeySym2 != SDLK_UNKNOWN)
ProcessKey(&EvHKeyDown2.key);
ProcessKey(&event.key);
break;
}
case HKEYSTATE_USED:
{
if ((SDL_GetModState() & ~(KMOD_MODE | KMOD_NUM | KMOD_RESERVED)) == 0)
enmHKeyState = HKEYSTATE_NORMAL;
if (event.type == SDL_KEYDOWN)
{
int rc = HandleHostKey(&event.key);
if (RT_SUCCESS(rc) && rc != VINF_SUCCESS)
goto leave;
}
break;
}
default:
AssertMsgFailed(("enmHKeyState=%d\n", enmHKeyState));
/* fall thru */
case HKEYSTATE_NOT_IT:
{
if ((SDL_GetModState() & ~(KMOD_MODE | KMOD_NUM | KMOD_RESERVED)) == 0)
enmHKeyState = HKEYSTATE_NORMAL;
ProcessKey(&event.key);
break;
}
} /* state switch */
break;
}
/*
* The window was closed.
*/
case SDL_QUIT:
{
if (!gfACPITerm || gSdlQuitTimer)
goto leave;
if (gConsole)
gConsole->PowerButton();
gSdlQuitTimer = SDL_AddTimer(1000, QuitTimer, NULL);
break;
}
/*
* The mouse has moved
*/
case SDL_MOUSEMOTION:
{
if (gfGrabbed || UseAbsoluteMouse())
{
SendMouseEvent(0, 0, 0);
}
break;
}
/*
* A mouse button has been clicked or released.
*/
case SDL_MOUSEBUTTONDOWN:
case SDL_MOUSEBUTTONUP:
{
SDL_MouseButtonEvent *bev = &event.button;
/* don't grab on mouse click if we have guest additions */
if (!gfGrabbed && !UseAbsoluteMouse() && gfGrabOnMouseClick)
{
if (event.type == SDL_MOUSEBUTTONDOWN && (bev->state & SDL_BUTTON_LMASK))
{
/* start grabbing all events */
InputGrabStart();
}
}
else if (gfGrabbed || UseAbsoluteMouse())
{
int dz = bev->button == SDL_BUTTON_WHEELUP
? -1
: bev->button == SDL_BUTTON_WHEELDOWN
? +1
: 0;
/* end host key combination (CTRL+MouseButton) */
switch (enmHKeyState)
{
case HKEYSTATE_DOWN_1ST:
case HKEYSTATE_DOWN_2ND:
enmHKeyState = HKEYSTATE_NOT_IT;
ProcessKey(&EvHKeyDown1.key);
break;
case HKEYSTATE_DOWN:
enmHKeyState = HKEYSTATE_NOT_IT;
ProcessKey(&EvHKeyDown1.key);
if (gHostKeySym2 != SDLK_UNKNOWN)
ProcessKey(&EvHKeyDown2.key);
break;
default:
break;
}
SendMouseEvent(dz, event.type == SDL_MOUSEBUTTONDOWN, bev->button);
}
break;
}
/*
* The window has gained or lost focus.
*/
case SDL_ACTIVEEVENT:
{
/*
* There is a strange behaviour in SDL when running without a window
* manager: When SDL_WM_GrabInput(SDL_GRAB_ON) is called we receive two
* consecutive events SDL_ACTIVEEVENTs (input lost, input gained).
* Asking SDL_GetAppState() seems the better choice.
*/
if (gfGrabbed && (SDL_GetAppState() & SDL_APPINPUTFOCUS) == 0)
{
/*
* another window has stolen the (keyboard) input focus
*/
InputGrabEnd();
}
break;
}
/*
* The SDL window was resized
*/
case SDL_VIDEORESIZE:
{
if (gDisplay)
{
if (gfIgnoreNextResize)
{
gfIgnoreNextResize = FALSE;
break;
}
uResizeWidth = event.resize.w;
#ifdef VBOX_SECURELABEL
if (fSecureLabel)
uResizeHeight = RT_MAX(0, event.resize.h - SECURE_LABEL_HEIGHT);
else
#endif
uResizeHeight = event.resize.h;
if (gSdlResizeTimer)
SDL_RemoveTimer(gSdlResizeTimer);
gSdlResizeTimer = SDL_AddTimer(300, ResizeTimer, NULL);
}
break;
}
/*
* User specific update event.
*/
/** @todo use a common user event handler so that SDL_PeepEvents() won't
* possibly remove other events in the queue!
*/
case SDL_USER_EVENT_UPDATERECT:
{
/*
* Decode event parameters.
*/
ASMAtomicDecS32(&g_cNotifyUpdateEventsPending);
#define DECODEX(event) ((intptr_t)(event).user.data1 >> 16)
#define DECODEY(event) ((intptr_t)(event).user.data1 & 0xFFFF)
#define DECODEW(event) ((intptr_t)(event).user.data2 >> 16)
#define DECODEH(event) ((intptr_t)(event).user.data2 & 0xFFFF)
int x = DECODEX(event);
int y = DECODEY(event);
int w = DECODEW(event);
int h = DECODEH(event);
LogFlow(("SDL_USER_EVENT_UPDATERECT: x = %d, y = %d, w = %d, h = %d\n",
x, y, w, h));
Assert(gpFrameBuffer);
gpFrameBuffer->update(x, y, w, h, true /* fGuestRelative */);
#undef DECODEX
#undef DECODEY
#undef DECODEW
#undef DECODEH
break;
}
/*
* User event: Window resize done
*/
case SDL_USER_EVENT_WINDOW_RESIZE_DONE:
{
/**
* @todo This is a workaround for synchronization problems between EMT and the
* SDL main thread. It can happen that the SDL thread already starts a
* new resize operation while the EMT is still busy with the old one
* leading to a deadlock. Therefore we call SetVideoModeHint only once
* when the mouse button was released.
*/
/* communicate the resize event to the guest */
gDisplay->SetVideoModeHint(uResizeWidth, uResizeHeight, 0, 0);
break;
}
/*
* User specific resize event.
*/
case SDL_USER_EVENT_RESIZE:
{
LogFlow(("SDL_USER_EVENT_RESIZE\n"));
gpFrameBuffer->resizeGuest();
/* notify the display that the resize has been completed */
gDisplay->ResizeCompleted(0);
break;
}
#ifdef USE_XPCOM_QUEUE_THREAD
/*
* User specific XPCOM event queue event
*/
case SDL_USER_EVENT_XPCOM_EVENTQUEUE:
{
LogFlow(("SDL_USER_EVENT_XPCOM_EVENTQUEUE: processing XPCOM event queue...\n"));
eventQ->ProcessPendingEvents();
signalXPCOMEventQueueThread();
break;
}
#endif /* USE_XPCOM_QUEUE_THREAD */
/*
* User specific update title bar notification event
*/
case SDL_USER_EVENT_UPDATE_TITLEBAR:
{
UpdateTitlebar(TITLEBAR_NORMAL);
break;
}
/*
* User specific termination event
*/
case SDL_USER_EVENT_TERMINATE:
{
if (event.user.code != VBOXSDL_TERM_NORMAL)
RTPrintf("Error: VM terminated abnormally!\n");
goto leave;
}
#ifdef VBOX_SECURELABEL
/*
* User specific secure label update event
*/
case SDL_USER_EVENT_SECURELABEL_UPDATE:
{
/*
* Query the new label text
*/
Bstr key = VBOXSDL_SECURELABEL_EXTRADATA;
Bstr label;
gMachine->GetExtraData(key, label.asOutParam());
Utf8Str labelUtf8 = label;
/*
* Now update the label
*/
gpFrameBuffer->setSecureLabelText(labelUtf8.raw());
break;
}
#endif /* VBOX_SECURELABEL */
/*
* User specific pointer shape change event
*/
case SDL_USER_EVENT_POINTER_CHANGE:
{
PointerShapeChangeData *data = (PointerShapeChangeData *) event.user.data1;
SetPointerShape (data);
delete data;
break;
}
/*
* User specific guest capabilities changed
*/
case SDL_USER_EVENT_GUEST_CAP_CHANGED:
{
HandleGuestCapsChanged();
break;
}
default:
{
LogBird(("unknown SDL event %d\n", event.type));
break;
}
}
}
leave:
if (gpszPidFile)
RTFileDelete(gpszPidFile);
LogFlow(("leaving...\n"));
#if defined(VBOX_WITH_XPCOM) && !defined(RT_OS_DARWIN) && !defined(RT_OS_OS2)
/* make sure the XPCOM event queue thread doesn't do anything harmful */
terminateXPCOMQueueThread();
#endif /* VBOX_WITH_XPCOM */
#ifdef VBOX_WITH_VRDP
if (gVrdpServer)
rc = gVrdpServer->COMSETTER(Enabled)(FALSE);
#endif
/*
* Get the machine state.
*/
if (gMachine)
gMachine->COMGETTER(State)(&machineState);
else
machineState = MachineState_Aborted;
/*
* Turn off the VM if it's running
*/
if ( gConsole
&& machineState == MachineState_Running)
{
consoleCallback->ignorePowerOffEvents(true);
rc = gConsole->PowerDown();
if (FAILED(rc))
{
com::ErrorInfo info;
if (info.isFullAvailable())
PrintError("Failed to power down VM",
info.getText().raw(), info.getComponent().raw());
else
RTPrintf("Failed to power down virtual machine! No error information available (rc = 0x%x).\n", rc);
break;
}
}
/*
* Now we discard all settings so that our changes will
* not be flushed to the permanent configuration
*/
if ( gMachine
&& machineState != MachineState_Saved)
{
rc = gMachine->DiscardSettings();
AssertComRC(rc);
}
/* close the session */
if (sessionOpened)
{
rc = session->Close();
AssertComRC(rc);
}
/* restore the default cursor and free the custom one if any */
if (gpDefaultCursor)
{
#ifdef VBOXSDL_WITH_X11
Cursor pDefaultTempX11Cursor = *(Cursor*)gpDefaultCursor->wm_cursor;
*(Cursor*)gpDefaultCursor->wm_cursor = gpDefaultOrigX11Cursor;
#endif /* VBOXSDL_WITH_X11 */
SDL_SetCursor(gpDefaultCursor);
#if defined(VBOXSDL_WITH_X11) && !defined(VBOX_WITHOUT_XCURSOR)
XFreeCursor(gSdlInfo.info.x11.display, pDefaultTempX11Cursor);
#endif /* VBOXSDL_WITH_X11 */
}
if (gpCustomCursor)
{
WMcursor *pCustomTempWMCursor = gpCustomCursor->wm_cursor;
gpCustomCursor->wm_cursor = gpCustomOrigWMcursor;
SDL_FreeCursor(gpCustomCursor);
if (pCustomTempWMCursor)
{
#if defined (RT_OS_WINDOWS)
::DestroyCursor(*(HCURSOR *) pCustomTempWMCursor);
#elif defined (VBOXSDL_WITH_X11) && !defined (VBOX_WITHOUT_XCURSOR)
XFreeCursor(gSdlInfo.info.x11.display, *(Cursor *) pCustomTempWMCursor);
#endif
free(pCustomTempWMCursor);
}
}
LogFlow(("Releasing mouse, keyboard, vrdpserver, display, console...\n"));
if (gDisplay)
gDisplay->SetupInternalFramebuffer(0);
gMouse = NULL;
gKeyboard = NULL;
gVrdpServer = NULL;
gDisplay = NULL;
gConsole = NULL;
gMachineDebugger = NULL;
gProgress = NULL;
// we can only uninitialize SDL here because it is not threadsafe
if (gpFrameBuffer)
{
LogFlow(("Releasing framebuffer...\n"));
gpFrameBuffer->uninit();
gpFrameBuffer->Release();
}
#ifdef VBOX_SECURELABEL
/* must do this after destructing the framebuffer */
if (gLibrarySDL_ttf)
RTLdrClose(gLibrarySDL_ttf);
#endif
LogFlow(("Releasing machine, session...\n"));
gMachine = NULL;
session = NULL;
LogFlow(("Releasing callback handlers...\n"));
if (callback)
callback->Release();
if (consoleCallback)
consoleCallback->Release();
LogFlow(("Releasing VirtualBox object...\n"));
virtualBox = NULL;
// end "all-stuff" scope
////////////////////////////////////////////////////////////////////////////
}
while (0);
LogFlow(("Uninitializing COM...\n"));
com::Shutdown();
LogFlow(("Returning from main()!\n"));
RTLogFlush(NULL);
return FAILED (rc) ? 1 : 0;
}
#ifndef VBOX_WITH_HARDENING
/**
* Main entry point
*/
int main(int argc, char **argv)
{
/*
* Before we do *anything*, we initialize the runtime.
*/
int rcRT = RTR3InitAndSUPLib();
if (RT_FAILURE(rcRT))
{
RTPrintf("Error: RTR3Init failed rcRC=%d\n", rcRT);
return 1;
}
return TrustedMain(argc, argv, NULL);
}
#endif /* !VBOX_WITH_HARDENING */
/**
* Returns whether the absolute mouse is in use, i.e. both host
* and guest have opted to enable it.
*
* @returns bool Flag whether the absolute mouse is in use
*/
static bool UseAbsoluteMouse(void)
{
return (gfAbsoluteMouseHost && gfAbsoluteMouseGuest);
}
#if defined(RT_OS_DARWIN) || defined(RT_OS_OS2)
/**
* Fallback keycode conversion using SDL symbols.
*
* This is used to catch keycodes that's missing from the translation table.
*
* @returns XT scancode
* @param ev SDL scancode
*/
static uint16_t Keyevent2KeycodeFallback(const SDL_KeyboardEvent *ev)
{
const SDLKey sym = ev->keysym.sym;
Log(("SDL key event: sym=%d scancode=%#x unicode=%#x\n",
sym, ev->keysym.scancode, ev->keysym.unicode));
switch (sym)
{ /* set 1 scan code */
case SDLK_ESCAPE: return 0x01;
case SDLK_EXCLAIM:
case SDLK_1: return 0x02;
case SDLK_AT:
case SDLK_2: return 0x03;
case SDLK_HASH:
case SDLK_3: return 0x04;
case SDLK_DOLLAR:
case SDLK_4: return 0x05;
/* % */
case SDLK_5: return 0x06;
case SDLK_CARET:
case SDLK_6: return 0x07;
case SDLK_AMPERSAND:
case SDLK_7: return 0x08;
case SDLK_ASTERISK:
case SDLK_8: return 0x09;
case SDLK_LEFTPAREN:
case SDLK_9: return 0x0a;
case SDLK_RIGHTPAREN:
case SDLK_0: return 0x0b;
case SDLK_UNDERSCORE:
case SDLK_MINUS: return 0x0c;
case SDLK_EQUALS:
case SDLK_PLUS: return 0x0d;
case SDLK_BACKSPACE: return 0x0e;
case SDLK_TAB: return 0x0f;
case SDLK_q: return 0x10;
case SDLK_w: return 0x11;
case SDLK_e: return 0x12;
case SDLK_r: return 0x13;
case SDLK_t: return 0x14;
case SDLK_y: return 0x15;
case SDLK_u: return 0x16;
case SDLK_i: return 0x17;
case SDLK_o: return 0x18;
case SDLK_p: return 0x19;
case SDLK_LEFTBRACKET: return 0x1a;
case SDLK_RIGHTBRACKET: return 0x1b;
case SDLK_RETURN: return 0x1c;
case SDLK_KP_ENTER: return 0x1c | 0x100;
case SDLK_LCTRL: return 0x1d;
case SDLK_RCTRL: return 0x1d | 0x100;
case SDLK_a: return 0x1e;
case SDLK_s: return 0x1f;
case SDLK_d: return 0x20;
case SDLK_f: return 0x21;
case SDLK_g: return 0x22;
case SDLK_h: return 0x23;
case SDLK_j: return 0x24;
case SDLK_k: return 0x25;
case SDLK_l: return 0x26;
case SDLK_COLON:
case SDLK_SEMICOLON: return 0x27;
case SDLK_QUOTEDBL:
case SDLK_QUOTE: return 0x28;
case SDLK_BACKQUOTE: return 0x29;
case SDLK_LSHIFT: return 0x2a;
case SDLK_BACKSLASH: return 0x2b;
case SDLK_z: return 0x2c;
case SDLK_x: return 0x2d;
case SDLK_c: return 0x2e;
case SDLK_v: return 0x2f;
case SDLK_b: return 0x30;
case SDLK_n: return 0x31;
case SDLK_m: return 0x32;
case SDLK_LESS:
case SDLK_COMMA: return 0x33;
case SDLK_GREATER:
case SDLK_PERIOD: return 0x34;
case SDLK_KP_DIVIDE: /*??*/
case SDLK_QUESTION:
case SDLK_SLASH: return 0x35;
case SDLK_RSHIFT: return 0x36;
case SDLK_KP_MULTIPLY:
case SDLK_PRINT: return 0x37; /* fixme */
case SDLK_LALT: return 0x38;
case SDLK_MODE: /* alt gr*/
case SDLK_RALT: return 0x38 | 0x100;
case SDLK_SPACE: return 0x39;
case SDLK_CAPSLOCK: return 0x3a;
case SDLK_F1: return 0x3b;
case SDLK_F2: return 0x3c;
case SDLK_F3: return 0x3d;
case SDLK_F4: return 0x3e;
case SDLK_F5: return 0x3f;
case SDLK_F6: return 0x40;
case SDLK_F7: return 0x41;
case SDLK_F8: return 0x42;
case SDLK_F9: return 0x43;
case SDLK_F10: return 0x44;
case SDLK_PAUSE: return 0x45; /* not right */
case SDLK_NUMLOCK: return 0x45;
case SDLK_SCROLLOCK: return 0x46;
case SDLK_KP7: return 0x47;
case SDLK_HOME: return 0x47 | 0x100;
case SDLK_KP8: return 0x48;
case SDLK_UP: return 0x48 | 0x100;
case SDLK_KP9: return 0x49;
case SDLK_PAGEUP: return 0x49 | 0x100;
case SDLK_KP_MINUS: return 0x4a;
case SDLK_KP4: return 0x4b;
case SDLK_LEFT: return 0x4b | 0x100;
case SDLK_KP5: return 0x4c;
case SDLK_KP6: return 0x4d;
case SDLK_RIGHT: return 0x4d | 0x100;
case SDLK_KP_PLUS: return 0x4e;
case SDLK_KP1: return 0x4f;
case SDLK_END: return 0x4f | 0x100;
case SDLK_KP2: return 0x50;
case SDLK_DOWN: return 0x50 | 0x100;
case SDLK_KP3: return 0x51;
case SDLK_PAGEDOWN: return 0x51 | 0x100;
case SDLK_KP0: return 0x52;
case SDLK_INSERT: return 0x52 | 0x100;
case SDLK_KP_PERIOD: return 0x53;
case SDLK_DELETE: return 0x53 | 0x100;
case SDLK_SYSREQ: return 0x54;
case SDLK_F11: return 0x57;
case SDLK_F12: return 0x58;
case SDLK_F13: return 0x5b;
case SDLK_LMETA:
case SDLK_LSUPER: return 0x5b | 0x100;
case SDLK_F14: return 0x5c;
case SDLK_RMETA:
case SDLK_RSUPER: return 0x5c | 0x100;
case SDLK_F15: return 0x5d;
case SDLK_MENU: return 0x5d | 0x100;
#if 0
case SDLK_CLEAR: return 0x;
case SDLK_KP_EQUALS: return 0x;
case SDLK_COMPOSE: return 0x;
case SDLK_HELP: return 0x;
case SDLK_BREAK: return 0x;
case SDLK_POWER: return 0x;
case SDLK_EURO: return 0x;
case SDLK_UNDO: return 0x;
#endif
default:
Log(("Unhandled sdl key event: sym=%d scancode=%#x unicode=%#x\n",
ev->keysym.sym, ev->keysym.scancode, ev->keysym.unicode));
return 0;
}
}
#endif /* RT_OS_DARWIN */
/**
* Converts an SDL keyboard eventcode to a XT scancode.
*
* @returns XT scancode
* @param ev SDL scancode
*/
static uint16_t Keyevent2Keycode(const SDL_KeyboardEvent *ev)
{
// start with the scancode determined by SDL
int keycode = ev->keysym.scancode;
#ifdef VBOXSDL_WITH_X11
// workaround for SDL keyboard translation issues on Linux
// keycodes > 0x100 are sent as 0xe0 keycode
// Note that these are the keycodes used by XFree86/X.org
// servers on a Linux host, and will almost certainly not
// work on other hosts or on other servers on Linux hosts.
// For a more general approach, see the Wine code in the GUI.
static const uint16_t x_keycode_to_pc_keycode[61] =
{
0x47|0x100, /* 97 Home */
0x48|0x100, /* 98 Up */
0x49|0x100, /* 99 PgUp */
0x4b|0x100, /* 100 Left */
0x4c, /* 101 KP-5 */
0x4d|0x100, /* 102 Right */
0x4f|0x100, /* 103 End */
0x50|0x100, /* 104 Down */
0x51|0x100, /* 105 PgDn */
0x52|0x100, /* 106 Ins */
0x53|0x100, /* 107 Del */
0x1c|0x100, /* 108 Enter */
0x1d|0x100, /* 109 Ctrl-R */
0x0, /* 110 Pause */
0x37|0x100, /* 111 Print */
0x35|0x100, /* 112 Divide */
0x38|0x100, /* 113 Alt-R */
0x46|0x100, /* 114 Break */
0x5b|0x100, /* 115 Win Left */
0x5c|0x100, /* 116 Win Right */
0x5d|0x100, /* 117 Win Menu */
0x0, /* 118 */
0x0, /* 119 */
0x0, /* 120 */
0xf1, /* 121 Korean Hangul to Latin?? */
0xf2, /* 122 Korean Hangul to Hanja?? */
0x0, /* 123 */
0x0, /* 124 */
0x0, /* 125 */
0x0, /* 126 */
0x0, /* 127 */
0x0, /* 128 */
0x79, /* 129 Japanese Henkan */
0x0, /* 130 */
0x7b, /* 131 Japanese Muhenkan */
0x0, /* 132 */
0x7d, /* 133 Japanese Yen */
0x7e, /* 134 Brazilian keypad */
0x0, /* 135 */
0x47, /* 136 KP_7 */
0x48, /* 137 KP_8 */
0x49, /* 138 KP_9 */
0x4b, /* 139 KP_4 */
0x4c, /* 140 KP_5 */
0x4d, /* 141 KP_6 */
0x4f, /* 142 KP_1 */
0x50, /* 143 KP_2 */
0x51, /* 144 KP_3 */
0x52, /* 145 KP_0 */
0x53, /* 146 KP_. */
0x47, /* 147 KP_HOME */
0x48, /* 148 KP_UP */
0x49, /* 149 KP_PgUp */
0x4b, /* 150 KP_Left */
0x4c, /* 151 KP_ */
0x4d, /* 152 KP_Right */
0x4f, /* 153 KP_End */
0x50, /* 154 KP_Down */
0x51, /* 155 KP_PgDn */
0x52, /* 156 KP_Ins */
0x53, /* 157 KP_Del */
};
// workaround for SDL keyboard translation issues on EVDEV
// keycodes > 0x100 are sent as 0xe0 keycode
// these values are simply pulled from x_keycode_to_pc_keycode
// not a whole lot of testing of the 'weird' values has taken
// place (I don't own a Japanese or Korean keyboard)
static const uint16_t evdev_keycode_to_pc_keycode[61] =
{
0x0, /* 97 EVDEV - RO ("Internet" Keyboards) */
0x0, /* 98 EVDEV - KATA (Katakana) */
0x0, /* 99 EVDEV - HIRA (Hiragana) */
0x79, /* 100 EVDEV - HENK (Henkan) */
0x70, /* 101 EVDEV - HKTG (Hiragana/Katakana toggle) */
0x7b, /* 102 EVDEV - MUHE (Muhenkan) */
0x0, /* 103 EVDEV - JPCM (KPJPComma) */
0x1c|0x100, /* 104 EVDEV - KPEN */
0x1d|0x100, /* 105 EVDEV - RCTL */
0x35|0x100, /* 106 EVDEV - KPDV */
0x37|0x100, /* 107 EVDEV - PRSC ***FIXME*** */
0x38|0x100, /* 108 EVDEV - RALT */
0x0, /* 109 EVDEV - LNFD ("Internet" Keyboards) */
0x47|0x100, /* 110 EVDEV - HOME ***FIXME*** */
0x48|0x100, /* 111 EVDEV - UP */
0x49|0x100, /* 112 EVDEV - PGUP */
0x4b|0x100, /* 113 EVDEV - LEFT */
0x4d|0x100, /* 114 EVDEV - RGHT */
0x4f|0x100, /* 115 EVDEV - END */
0x50|0x100, /* 116 EVDEV - DOWN */
0x51|0x100, /* 117 EVDEV - PGDN */
0x52|0x100, /* 118 EVDEV - INS */
0x53|0x100, /* 119 EVDEV - DELE */
0x0, /* 120 EVDEV - I120 ("Internet" Keyboards) */
//121-124 Solaris Compatibilty Stuff
0x0, /* 121 EVDEV - MUTE */
0x0, /* 122 EVDEV - VOL- */
0x0, /* 123 EVDEV - VOL+ */
0x0, /* 124 EVDEV - POWR */
0x0, /* 125 EVDEV - KPEQ */
0x0, /* 126 EVDEV - I126 ("Internet" Keyboards) */
0x0, /* 127 EVDEV - PAUS */
0x0, /* 128 EVDEV - ???? */
0x0, /* 129 EVDEV - I129 ("Internet" Keyboards) */
0xf1, /* 130 EVDEV - HNGL (Korean Hangul Latin toggle) */
0xf2, /* 131 EVDEV - HJCV (Korean Hangul Hanja toggle) */
0x7d, /* 132 EVDEV - AE13 (Yen) */
0x5b|0x100, /* 133 EVDEV - LWIN */
0x5c|0x100, /* 134 EVDEV - RWIN */
0x5d|0x100, /* 135 EVDEV - MENU */
//136-146 Solaris Stuff
0x0, /* 136 EVDEV - STOP */
0x0, /* 137 EVDEV - AGAI */
0x0, /* 138 EVDEV - PROP */
0x0, /* 139 EVDEV - UNDO */
0x0, /* 140 EVDEV - FRNT */
0x0, /* 141 EVDEV - COPY */
0x0, /* 142 EVDEV - OPEN */
0x0, /* 143 EVDEV - PAST */
0x0, /* 144 EVDEV - FIND */
0x0, /* 145 EVDEV - CUT */
0x0, /* 146 EVDEV - HELP */
//Extended Keys ("Internet" Keyboards)
0x0, /* 147 EVDEV - I147 */
0x0, /* 148 EVDEV - I148 */
0x0, /* 149 EVDEV - I149 */
0x0, /* 150 EVDEV - I150 */
0x0, /* 151 EVDEV - I151 */
0x0, /* 152 EVDEV - I152 */
0x0, /* 153 EVDEV - I153 */
0x0, /* 154 EVDEV - I154 */
0x0, /* 155 EVDEV - I156 */
0x0, /* 156 EVDEV - I157 */
0x0, /* 157 EVDEV - I158 */
};
if (keycode < 9)
{
keycode = 0;
}
else if (keycode < 97)
{
// just an offset (Xorg MIN_KEYCODE)
keycode -= 8;
}
else if (keycode < 158 && guseEvdevKeymap)
{
// apply EVDEV conversion table
keycode = evdev_keycode_to_pc_keycode[keycode - 97];
}
else if (keycode < 158)
{
// apply conversion table
keycode = x_keycode_to_pc_keycode[keycode - 97];
}
else if (keycode == 208)
{
// Japanese Hiragana to Katakana
keycode = 0x70;
}
else if (keycode == 211)
{
// Japanese backslash/underscore and Brazilian backslash/question mark
keycode = 0x73;
}
else
{
keycode = 0;
}
#elif defined(RT_OS_DARWIN)
/* This is derived partially from SDL_QuartzKeys.h and partially from testing. */
static const uint16_t s_aMacToSet1[] =
{
/* set-1 SDL_QuartzKeys.h */
0x1e, /* QZ_a 0x00 */
0x1f, /* QZ_s 0x01 */
0x20, /* QZ_d 0x02 */
0x21, /* QZ_f 0x03 */
0x23, /* QZ_h 0x04 */
0x22, /* QZ_g 0x05 */
0x2c, /* QZ_z 0x06 */
0x2d, /* QZ_x 0x07 */
0x2e, /* QZ_c 0x08 */
0x2f, /* QZ_v 0x09 */
0x56, /* between lshift and z. 'INT 1'? */
0x30, /* QZ_b 0x0B */
0x10, /* QZ_q 0x0C */
0x11, /* QZ_w 0x0D */
0x12, /* QZ_e 0x0E */
0x13, /* QZ_r 0x0F */
0x15, /* QZ_y 0x10 */
0x14, /* QZ_t 0x11 */
0x02, /* QZ_1 0x12 */
0x03, /* QZ_2 0x13 */
0x04, /* QZ_3 0x14 */
0x05, /* QZ_4 0x15 */
0x07, /* QZ_6 0x16 */
0x06, /* QZ_5 0x17 */
0x0d, /* QZ_EQUALS 0x18 */
0x0a, /* QZ_9 0x19 */
0x08, /* QZ_7 0x1A */
0x0c, /* QZ_MINUS 0x1B */
0x09, /* QZ_8 0x1C */
0x0b, /* QZ_0 0x1D */
0x1b, /* QZ_RIGHTBRACKET 0x1E */
0x18, /* QZ_o 0x1F */
0x16, /* QZ_u 0x20 */
0x1a, /* QZ_LEFTBRACKET 0x21 */
0x17, /* QZ_i 0x22 */
0x19, /* QZ_p 0x23 */
0x1c, /* QZ_RETURN 0x24 */
0x26, /* QZ_l 0x25 */
0x24, /* QZ_j 0x26 */
0x28, /* QZ_QUOTE 0x27 */
0x25, /* QZ_k 0x28 */
0x27, /* QZ_SEMICOLON 0x29 */
0x2b, /* QZ_BACKSLASH 0x2A */
0x33, /* QZ_COMMA 0x2B */
0x35, /* QZ_SLASH 0x2C */
0x31, /* QZ_n 0x2D */
0x32, /* QZ_m 0x2E */
0x34, /* QZ_PERIOD 0x2F */
0x0f, /* QZ_TAB 0x30 */
0x39, /* QZ_SPACE 0x31 */
0x29, /* QZ_BACKQUOTE 0x32 */
0x0e, /* QZ_BACKSPACE 0x33 */
0x9c, /* QZ_IBOOK_ENTER 0x34 */
0x01, /* QZ_ESCAPE 0x35 */
0x5c|0x100, /* QZ_RMETA 0x36 */
0x5b|0x100, /* QZ_LMETA 0x37 */
0x2a, /* QZ_LSHIFT 0x38 */
0x3a, /* QZ_CAPSLOCK 0x39 */
0x38, /* QZ_LALT 0x3A */
0x1d, /* QZ_LCTRL 0x3B */
0x36, /* QZ_RSHIFT 0x3C */
0x38|0x100, /* QZ_RALT 0x3D */
0x1d|0x100, /* QZ_RCTRL 0x3E */
0, /* */
0, /* */
0x53, /* QZ_KP_PERIOD 0x41 */
0, /* */
0x37, /* QZ_KP_MULTIPLY 0x43 */
0, /* */
0x4e, /* QZ_KP_PLUS 0x45 */
0, /* */
0x45, /* QZ_NUMLOCK 0x47 */
0, /* */
0, /* */
0, /* */
0x35|0x100, /* QZ_KP_DIVIDE 0x4B */
0x1c|0x100, /* QZ_KP_ENTER 0x4C */
0, /* */
0x4a, /* QZ_KP_MINUS 0x4E */
0, /* */
0, /* */
0x0d/*?*/, /* QZ_KP_EQUALS 0x51 */
0x52, /* QZ_KP0 0x52 */
0x4f, /* QZ_KP1 0x53 */
0x50, /* QZ_KP2 0x54 */
0x51, /* QZ_KP3 0x55 */
0x4b, /* QZ_KP4 0x56 */
0x4c, /* QZ_KP5 0x57 */
0x4d, /* QZ_KP6 0x58 */
0x47, /* QZ_KP7 0x59 */
0, /* */
0x48, /* QZ_KP8 0x5B */
0x49, /* QZ_KP9 0x5C */
0, /* */
0, /* */
0, /* */
0x3f, /* QZ_F5 0x60 */
0x40, /* QZ_F6 0x61 */
0x41, /* QZ_F7 0x62 */
0x3d, /* QZ_F3 0x63 */
0x42, /* QZ_F8 0x64 */
0x43, /* QZ_F9 0x65 */
0, /* */
0x57, /* QZ_F11 0x67 */
0, /* */
0x37|0x100, /* QZ_PRINT / F13 0x69 */
0x63, /* QZ_F16 0x6A */
0x46, /* QZ_SCROLLOCK 0x6B */
0, /* */
0x44, /* QZ_F10 0x6D */
0x5d|0x100, /* */
0x58, /* QZ_F12 0x6F */
0, /* */
0/* 0xe1,0x1d,0x45*/, /* QZ_PAUSE 0x71 */
0x52|0x100, /* QZ_INSERT / HELP 0x72 */
0x47|0x100, /* QZ_HOME 0x73 */
0x49|0x100, /* QZ_PAGEUP 0x74 */
0x53|0x100, /* QZ_DELETE 0x75 */
0x3e, /* QZ_F4 0x76 */
0x4f|0x100, /* QZ_END 0x77 */
0x3c, /* QZ_F2 0x78 */
0x51|0x100, /* QZ_PAGEDOWN 0x79 */
0x3b, /* QZ_F1 0x7A */
0x4b|0x100, /* QZ_LEFT 0x7B */
0x4d|0x100, /* QZ_RIGHT 0x7C */
0x50|0x100, /* QZ_DOWN 0x7D */
0x48|0x100, /* QZ_UP 0x7E */
0x5e|0x100, /* QZ_POWER 0x7F */ /* have different break key! */
};
if (keycode == 0)
{
/* This could be a modifier or it could be 'a'. */
switch (ev->keysym.sym)
{
case SDLK_LSHIFT: keycode = 0x2a; break;
case SDLK_RSHIFT: keycode = 0x36; break;
case SDLK_LCTRL: keycode = 0x1d; break;
case SDLK_RCTRL: keycode = 0x1d | 0x100; break;
case SDLK_LALT: keycode = 0x38; break;
case SDLK_MODE: /* alt gr */
case SDLK_RALT: keycode = 0x38 | 0x100; break;
case SDLK_RMETA:
case SDLK_RSUPER: keycode = 0x5c | 0x100; break;
case SDLK_LMETA:
case SDLK_LSUPER: keycode = 0x5b | 0x100; break;
/* Sssumes normal key. */
default: keycode = s_aMacToSet1[keycode]; break;
}
}
else
{
if ((unsigned)keycode < RT_ELEMENTS(s_aMacToSet1))
keycode = s_aMacToSet1[keycode];
else
keycode = 0;
if (!keycode)
{
#ifdef DEBUG_bird
RTPrintf("Untranslated: keycode=%#x (%d)\n", keycode, keycode);
#endif
keycode = Keyevent2KeycodeFallback(ev);
}
}
#ifdef DEBUG_bird
RTPrintf("scancode=%#x -> %#x\n", ev->keysym.scancode, keycode);
#endif
#elif RT_OS_OS2
keycode = Keyevent2KeycodeFallback(ev);
#endif /* RT_OS_DARWIN */
return keycode;
}
/**
* Releases any modifier keys that are currently in pressed state.
*/
static void ResetKeys(void)
{
int i;
if (!gKeyboard)
return;
for(i = 0; i < 256; i++)
{
if (gaModifiersState[i])
{
if (i & 0x80)
gKeyboard->PutScancode(0xe0);
gKeyboard->PutScancode(i | 0x80);
gaModifiersState[i] = 0;
}
}
}
/**
* Keyboard event handler.
*
* @param ev SDL keyboard event.
*/
static void ProcessKey(SDL_KeyboardEvent *ev)
{
#if defined(DEBUG) || defined(VBOX_WITH_STATISTICS)
if (gMachineDebugger && ev->type == SDL_KEYDOWN)
{
// first handle the debugger hotkeys
uint8_t *keystate = SDL_GetKeyState(NULL);
#if 0
// CTRL+ALT+Fn is not free on Linux hosts with Xorg ..
if (keystate[SDLK_LALT] && !keystate[SDLK_LCTRL])
#else
if (keystate[SDLK_LALT] && keystate[SDLK_LCTRL])
#endif
{
switch (ev->keysym.sym)
{
// pressing CTRL+ALT+F11 dumps the statistics counter
case SDLK_F12:
RTPrintf("ResetStats\n"); /* Visual feedback in console window */
gMachineDebugger->ResetStats(NULL);
break;
// pressing CTRL+ALT+F12 resets all statistics counter
case SDLK_F11:
gMachineDebugger->DumpStats(NULL);
RTPrintf("DumpStats\n"); /* Vistual feedback in console window */
break;
default:
break;
}
}
#if 1
else if (keystate[SDLK_LALT] && !keystate[SDLK_LCTRL])
{
switch (ev->keysym.sym)
{
// pressing Alt-F12 toggles the supervisor recompiler
case SDLK_F12:
{
BOOL recompileSupervisor;
gMachineDebugger->COMGETTER(RecompileSupervisor)(&recompileSupervisor);
gMachineDebugger->COMSETTER(RecompileSupervisor)(!recompileSupervisor);
break;
}
// pressing Alt-F11 toggles the user recompiler
case SDLK_F11:
{
BOOL recompileUser;
gMachineDebugger->COMGETTER(RecompileUser)(&recompileUser);
gMachineDebugger->COMSETTER(RecompileUser)(!recompileUser);
break;
}
// pressing Alt-F10 toggles the patch manager
case SDLK_F10:
{
BOOL patmEnabled;
gMachineDebugger->COMGETTER(PATMEnabled)(&patmEnabled);
gMachineDebugger->COMSETTER(PATMEnabled)(!patmEnabled);
break;
}
// pressing Alt-F9 toggles CSAM
case SDLK_F9:
{
BOOL csamEnabled;
gMachineDebugger->COMGETTER(CSAMEnabled)(&csamEnabled);
gMachineDebugger->COMSETTER(CSAMEnabled)(!csamEnabled);
break;
}
// pressing Alt-F8 toggles singlestepping mode
case SDLK_F8:
{
BOOL singlestepEnabled;
gMachineDebugger->COMGETTER(Singlestep)(&singlestepEnabled);
gMachineDebugger->COMSETTER(Singlestep)(!singlestepEnabled);
break;
}
default:
break;
}
}
#endif
// pressing Ctrl-F12 toggles the logger
else if ((keystate[SDLK_RCTRL] || keystate[SDLK_LCTRL]) && ev->keysym.sym == SDLK_F12)
{
BOOL logEnabled = TRUE;
gMachineDebugger->COMGETTER(LogEnabled)(&logEnabled);
gMachineDebugger->COMSETTER(LogEnabled)(!logEnabled);
#ifdef DEBUG_bird
return;
#endif
}
// pressing F12 sets a logmark
else if (ev->keysym.sym == SDLK_F12)
{
RTLogPrintf("****** LOGGING MARK ******\n");
RTLogFlush(NULL);
}
// now update the titlebar flags
UpdateTitlebar(TITLEBAR_NORMAL);
}
#endif // DEBUG || VBOX_WITH_STATISTICS
// the pause key is the weirdest, needs special handling
if (ev->keysym.sym == SDLK_PAUSE)
{
int v = 0;
if (ev->type == SDL_KEYUP)
v |= 0x80;
gKeyboard->PutScancode(0xe1);
gKeyboard->PutScancode(0x1d | v);
gKeyboard->PutScancode(0x45 | v);
return;
}
/*
* Perform SDL key event to scancode conversion
*/
int keycode = Keyevent2Keycode(ev);
switch(keycode)
{
case 0x00:
{
/* sent when leaving window: reset the modifiers state */
ResetKeys();
return;
}
case 0x2a: /* Left Shift */
case 0x36: /* Right Shift */
case 0x1d: /* Left CTRL */
case 0x1d|0x100: /* Right CTRL */
case 0x38: /* Left ALT */
case 0x38|0x100: /* Right ALT */
{
if (ev->type == SDL_KEYUP)
gaModifiersState[keycode & ~0x100] = 0;
else
gaModifiersState[keycode & ~0x100] = 1;
break;
}
case 0x45: /* Num Lock */
case 0x3a: /* Caps Lock */
{
/*
* SDL generates a KEYDOWN event if the lock key is active and a KEYUP event
* if the lock key is inactive. See SDL_DISABLE_LOCK_KEYS.
*/
if (ev->type == SDL_KEYDOWN || ev->type == SDL_KEYUP)
{
gKeyboard->PutScancode(keycode);
gKeyboard->PutScancode(keycode | 0x80);
}
return;
}
}
if (ev->type != SDL_KEYDOWN)
{
/*
* Some keyboards (e.g. the one of mine T60) don't send a NumLock scan code on every
* press of the key. Both the guest and the host should agree on the NumLock state.
* If they differ, we try to alter the guest NumLock state by sending the NumLock key
* scancode. We will get a feedback through the KBD_CMD_SET_LEDS command if the guest
* tries to set/clear the NumLock LED. If a (silly) guest doesn't change the LED, don't
* bother him with NumLock scancodes. At least our BIOS, Linux and Windows handle the
* NumLock LED well.
*/
if ( gcGuestNumLockAdaptions
&& (gfGuestNumLockPressed ^ !!(SDL_GetModState() & KMOD_NUM)))
{
gcGuestNumLockAdaptions--;
gKeyboard->PutScancode(0x45);
gKeyboard->PutScancode(0x45 | 0x80);
}
if ( gcGuestCapsLockAdaptions
&& (gfGuestCapsLockPressed ^ !!(SDL_GetModState() & KMOD_CAPS)))
{
gcGuestCapsLockAdaptions--;
gKeyboard->PutScancode(0x3a);
gKeyboard->PutScancode(0x3a | 0x80);
}
}
/*
* Now we send the event. Apply extended and release prefixes.
*/
if (keycode & 0x100)
gKeyboard->PutScancode(0xe0);
gKeyboard->PutScancode(ev->type == SDL_KEYUP ? (keycode & 0x7f) | 0x80
: (keycode & 0x7f));
}
#ifdef RT_OS_DARWIN
#include <Carbon/Carbon.h>
__BEGIN_DECLS
/* Private interface in 10.3 and later. */
typedef int CGSConnection;
typedef enum
{
kCGSGlobalHotKeyEnable = 0,
kCGSGlobalHotKeyDisable,
kCGSGlobalHotKeyInvalid = -1 /* bird */
} CGSGlobalHotKeyOperatingMode;
extern CGSConnection _CGSDefaultConnection(void);
extern CGError CGSGetGlobalHotKeyOperatingMode(CGSConnection Connection, CGSGlobalHotKeyOperatingMode *enmMode);
extern CGError CGSSetGlobalHotKeyOperatingMode(CGSConnection Connection, CGSGlobalHotKeyOperatingMode enmMode);
__END_DECLS
/** Keeping track of whether we disabled the hotkeys or not. */
static bool g_fHotKeysDisabled = false;
/** Whether we've connected or not. */
static bool g_fConnectedToCGS = false;
/** Cached connection. */
static CGSConnection g_CGSConnection;
/**
* Disables or enabled global hot keys.
*/
static void DisableGlobalHotKeys(bool fDisable)
{
if (!g_fConnectedToCGS)
{
g_CGSConnection = _CGSDefaultConnection();
g_fConnectedToCGS = true;
}
/* get current mode. */
CGSGlobalHotKeyOperatingMode enmMode = kCGSGlobalHotKeyInvalid;
CGSGetGlobalHotKeyOperatingMode(g_CGSConnection, &enmMode);
/* calc new mode. */
if (fDisable)
{
if (enmMode != kCGSGlobalHotKeyEnable)
return;
enmMode = kCGSGlobalHotKeyDisable;
}
else
{
if ( enmMode != kCGSGlobalHotKeyDisable
/*|| !g_fHotKeysDisabled*/)
return;
enmMode = kCGSGlobalHotKeyEnable;
}
/* try set it and check the actual result. */
CGSSetGlobalHotKeyOperatingMode(g_CGSConnection, enmMode);
CGSGlobalHotKeyOperatingMode enmNewMode = kCGSGlobalHotKeyInvalid;
CGSGetGlobalHotKeyOperatingMode(g_CGSConnection, &enmNewMode);
if (enmNewMode == enmMode)
g_fHotKeysDisabled = enmMode == kCGSGlobalHotKeyDisable;
}
#endif /* RT_OS_DARWIN */
/**
* Start grabbing the mouse.
*/
static void InputGrabStart(void)
{
#ifdef RT_OS_DARWIN
DisableGlobalHotKeys(true);
#endif
if (!gfGuestNeedsHostCursor)
SDL_ShowCursor(SDL_DISABLE);
SDL_WM_GrabInput(SDL_GRAB_ON);
// dummy read to avoid moving the mouse
SDL_GetRelativeMouseState(NULL, NULL);
gfGrabbed = TRUE;
UpdateTitlebar(TITLEBAR_NORMAL);
}
/**
* End mouse grabbing.
*/
static void InputGrabEnd(void)
{
SDL_WM_GrabInput(SDL_GRAB_OFF);
if (!gfGuestNeedsHostCursor)
SDL_ShowCursor(SDL_ENABLE);
#ifdef RT_OS_DARWIN
DisableGlobalHotKeys(false);
#endif
gfGrabbed = FALSE;
UpdateTitlebar(TITLEBAR_NORMAL);
}
/**
* Query mouse position and button state from SDL and send to the VM
*
* @param dz Relative mouse wheel movement
*/
static void SendMouseEvent(int dz, int down, int button)
{
int x, y, state, buttons;
bool abs;
/*
* If supported and we're not in grabbed mode, we'll use the absolute mouse.
* If we are in grabbed mode and the guest is not able to draw the mouse cursor
* itself, we have to use absolute coordinates, otherwise the host cursor and
* the coordinates the guest thinks the mouse is at could get out-of-sync. From
* the SDL mailing list:
*
* "The event processing is usually asynchronous and so somewhat delayed, and
* SDL_GetMouseState is returning the immediate mouse state. So at the time you
* call SDL_GetMouseState, the "button" is already up."
*/
abs = (UseAbsoluteMouse() && !gfGrabbed) || gfGuestNeedsHostCursor;
/* only used if abs == TRUE */
int xMin = gpFrameBuffer->getXOffset();
int yMin = gpFrameBuffer->getYOffset();
int xMax = xMin + (int)gpFrameBuffer->getGuestXRes();
int yMax = yMin + (int)gpFrameBuffer->getGuestYRes();
state = abs ? SDL_GetMouseState(&x, &y) : SDL_GetRelativeMouseState(&x, &y);
/*
* process buttons
*/
buttons = 0;
if (state & SDL_BUTTON(SDL_BUTTON_LEFT))
buttons |= MouseButtonState_LeftButton;
if (state & SDL_BUTTON(SDL_BUTTON_RIGHT))
buttons |= MouseButtonState_RightButton;
if (state & SDL_BUTTON(SDL_BUTTON_MIDDLE))
buttons |= MouseButtonState_MiddleButton;
if (abs)
{
/*
* Check if the mouse event is inside the guest area. This solves the
* following problem: Some guests switch off the VBox hardware mouse
* cursor and draw the mouse cursor itself instead. Moving the mouse
* outside the guest area then leads to annoying mouse hangs if we
* don't pass mouse motion events into the guest.
*/
if (x < xMin || y < yMin || x > xMax || y > yMax)
{
/*
* Cursor outside of valid guest area (outside window or in secure
* label area. Don't allow any mouse button press.
*/
button = 0;
/*
* Release any pressed button.
*/
#if 0
/* disabled on customers request */
buttons &= ~(MouseButtonState_LeftButton |
MouseButtonState_MiddleButton |
MouseButtonState_RightButton);
#endif
/*
* Prevent negative coordinates.
*/
if (x < xMin) x = xMin;
if (x > xMax) x = xMax;
if (y < yMin) y = yMin;
if (y > yMax) y = yMax;
if (!gpOffCursor)
{
gpOffCursor = SDL_GetCursor(); /* Cursor image */
gfOffCursorActive = SDL_ShowCursor(-1); /* enabled / disabled */
SDL_SetCursor(gpDefaultCursor);
SDL_ShowCursor (SDL_ENABLE);
}
}
else
{
if (gpOffCursor)
{
/*
* We just entered the valid guest area. Restore the guest mouse
* cursor.
*/
SDL_SetCursor(gpOffCursor);
SDL_ShowCursor(gfOffCursorActive ? SDL_ENABLE : SDL_DISABLE);
gpOffCursor = NULL;
}
}
}
/*
* Button was pressed but that press is not reflected in the button state?
*/
if (down && !(state & SDL_BUTTON(button)))
{
/*
* It can happen that a mouse up event follows a mouse down event immediately
* and we see the events when the bit in the button state is already cleared
* again. In that case we simulate the mouse down event.
*/
int tmp_button = 0;
switch (button)
{
case SDL_BUTTON_LEFT: tmp_button = MouseButtonState_LeftButton; break;
case SDL_BUTTON_MIDDLE: tmp_button = MouseButtonState_MiddleButton; break;
case SDL_BUTTON_RIGHT: tmp_button = MouseButtonState_RightButton; break;
}
if (abs)
{
/**
* @todo
* PutMouseEventAbsolute() expects x and y starting from 1,1.
* should we do the increment internally in PutMouseEventAbsolute()
* or state it in PutMouseEventAbsolute() docs?
*/
gMouse->PutMouseEventAbsolute(x + 1 - xMin,
y + 1 - yMin,
dz, buttons | tmp_button);
}
else
{
gMouse->PutMouseEvent(0, 0, dz, buttons | tmp_button);
}
}
// now send the mouse event
if (abs)
{
/**
* @todo
* PutMouseEventAbsolute() expects x and y starting from 1,1.
* should we do the increment internally in PutMouseEventAbsolute()
* or state it in PutMouseEventAbsolute() docs?
*/
gMouse->PutMouseEventAbsolute(x + 1 - xMin,
y + 1 - yMin,
dz, buttons);
}
else
{
gMouse->PutMouseEvent(x, y, dz, buttons);
}
}
/**
* Resets the VM
*/
void ResetVM(void)
{
if (gConsole)
gConsole->Reset();
}
/**
* Initiates a saved state and updates the titlebar with progress information
*/
void SaveState(void)
{
ResetKeys();
RTThreadYield();
if (gfGrabbed)
InputGrabEnd();
RTThreadYield();
UpdateTitlebar(TITLEBAR_SAVE);
gProgress = NULL;
HRESULT rc = gConsole->SaveState(gProgress.asOutParam());
if (FAILED(S_OK))
{
RTPrintf("Error saving state! rc = 0x%x\n", rc);
return;
}
Assert(gProgress);
/*
* Wait for the operation to be completed and work
* the title bar in the mean while.
*/
ULONG cPercent = 0;
#ifndef RT_OS_DARWIN /* don't break the other guys yet. */
for (;;)
{
BOOL fCompleted = false;
rc = gProgress->COMGETTER(Completed)(&fCompleted);
if (FAILED(rc) || fCompleted)
break;
ULONG cPercentNow;
rc = gProgress->COMGETTER(Percent)(&cPercentNow);
if (FAILED(rc))
break;
if (cPercentNow != cPercent)
{
UpdateTitlebar(TITLEBAR_SAVE, cPercent);
cPercent = cPercentNow;
}
/* wait */
rc = gProgress->WaitForCompletion(100);
if (FAILED(rc))
break;
/// @todo process gui events.
}
#else /* new loop which processes GUI events while saving. */
/* start regular timer so we don't starve in the event loop */
SDL_TimerID sdlTimer;
sdlTimer = SDL_AddTimer(100, StartupTimer, NULL);
for (;;)
{
/*
* Check for completion.
*/
BOOL fCompleted = false;
rc = gProgress->COMGETTER(Completed)(&fCompleted);
if (FAILED(rc) || fCompleted)
break;
ULONG cPercentNow;
rc = gProgress->COMGETTER(Percent)(&cPercentNow);
if (FAILED(rc))
break;
if (cPercentNow != cPercent)
{
UpdateTitlebar(TITLEBAR_SAVE, cPercent);
cPercent = cPercentNow;
}
/*
* Wait for and process GUI a event.
* This is necessary for XPCOM IPC and for updating the
* title bar on the Mac.
*/
SDL_Event event;
if (WaitSDLEvent(&event))
{
switch (event.type)
{
/*
* Timer event preventing us from getting stuck.
*/
case SDL_USER_EVENT_TIMER:
break;
#ifdef USE_XPCOM_QUEUE_THREAD
/*
* User specific XPCOM event queue event
*/
case SDL_USER_EVENT_XPCOM_EVENTQUEUE:
{
LogFlow(("SDL_USER_EVENT_XPCOM_EVENTQUEUE: processing XPCOM event queue...\n"));
eventQ->ProcessPendingEvents();
signalXPCOMEventQueueThread();
break;
}
#endif /* USE_XPCOM_QUEUE_THREAD */
/*
* Ignore all other events.
*/
case SDL_USER_EVENT_RESIZE:
case SDL_USER_EVENT_TERMINATE:
default:
break;
}
}
}
/* kill the timer */
SDL_RemoveTimer(sdlTimer);
sdlTimer = 0;
#endif /* RT_OS_DARWIN */
/*
* What's the result of the operation?
*/
HRESULT lrc;
rc = gProgress->COMGETTER(ResultCode)(&lrc);
if (FAILED(rc))
lrc = ~0;
if (!lrc)
{
UpdateTitlebar(TITLEBAR_SAVE, 100);
RTThreadYield();
RTPrintf("Saved the state successfully.\n");
}
else
RTPrintf("Error saving state, lrc=%d (%#x)\n", lrc, lrc);
}
/**
* Build the titlebar string
*/
static void UpdateTitlebar(TitlebarMode mode, uint32_t u32User)
{
static char szTitle[1024] = {0};
/* back up current title */
char szPrevTitle[1024];
strcpy(szPrevTitle, szTitle);
strcpy(szTitle, "Sun VirtualBox - ");
Bstr name;
gMachine->COMGETTER(Name)(name.asOutParam());
if (name)
strcat(szTitle, Utf8Str(name).raw());
else
strcat(szTitle, "<noname>");
/* which mode are we in? */
switch (mode)
{
case TITLEBAR_NORMAL:
{
MachineState_T machineState;
gMachine->COMGETTER(State)(&machineState);
if (machineState == MachineState_Paused)
strcat(szTitle, " - [Paused]");
if (gfGrabbed)
strcat(szTitle, " - [Input captured]");
// do we have a debugger interface
if (gMachineDebugger)
{
#if defined(DEBUG) || defined(VBOX_WITH_STATISTICS)
// query the machine state
BOOL recompileSupervisor = FALSE;
BOOL recompileUser = FALSE;
BOOL patmEnabled = FALSE;
BOOL csamEnabled = FALSE;
BOOL singlestepEnabled = FALSE;
BOOL logEnabled = FALSE;
BOOL hwVirtEnabled = FALSE;
ULONG virtualTimeRate = 100;
gMachineDebugger->COMGETTER(RecompileSupervisor)(&recompileSupervisor);
gMachineDebugger->COMGETTER(RecompileUser)(&recompileUser);
gMachineDebugger->COMGETTER(PATMEnabled)(&patmEnabled);
gMachineDebugger->COMGETTER(CSAMEnabled)(&csamEnabled);
gMachineDebugger->COMGETTER(LogEnabled)(&logEnabled);
gMachineDebugger->COMGETTER(Singlestep)(&singlestepEnabled);
gMachineDebugger->COMGETTER(HWVirtExEnabled)(&hwVirtEnabled);
gMachineDebugger->COMGETTER(VirtualTimeRate)(&virtualTimeRate);
RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
" [STEP=%d CS=%d PAT=%d RR0=%d RR3=%d LOG=%d HWVirt=%d",
singlestepEnabled == TRUE, csamEnabled == TRUE, patmEnabled == TRUE,
recompileSupervisor == FALSE, recompileUser == FALSE,
logEnabled == TRUE, hwVirtEnabled == TRUE);
char *psz = strchr(szTitle, '\0');
if (virtualTimeRate != 100)
RTStrPrintf(psz, &szTitle[sizeof(szTitle)] - psz, " WD=%d%%]", virtualTimeRate);
else
RTStrPrintf(psz, &szTitle[sizeof(szTitle)] - psz, "]");
#else
BOOL hwVirtEnabled = FALSE;
gMachineDebugger->COMGETTER(HWVirtExEnabled)(&hwVirtEnabled);
RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
"%s", hwVirtEnabled ? " (HWVirtEx)" : "");
#endif /* DEBUG */
}
break;
}
case TITLEBAR_STARTUP:
{
/*
* Format it.
*/
MachineState_T machineState;
gMachine->COMGETTER(State)(&machineState);
if (machineState == MachineState_Starting)
strcat(szTitle, " - Starting...");
else if (machineState == MachineState_Restoring)
{
ULONG cPercentNow;
HRESULT rc = gProgress->COMGETTER(Percent)(&cPercentNow);
if (SUCCEEDED(rc))
RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
" - Restoring %d%%...", (int)cPercentNow);
else
RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
" - Restoring...");
}
/* ignore other states, we could already be in running or aborted state */
break;
}
case TITLEBAR_SAVE:
{
AssertMsg(u32User <= 100, ("%d\n", u32User));
RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
" - Saving %d%%...", u32User);
break;
}
case TITLEBAR_SNAPSHOT:
{
AssertMsg(u32User <= 100, ("%d\n", u32User));
RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
" - Taking snapshot %d%%...", u32User);
break;
}
default:
RTPrintf("Error: Invalid title bar mode %d!\n", mode);
return;
}
/*
* Don't update if it didn't change.
*/
if (strcmp(szTitle, szPrevTitle) == 0)
return;
/*
* Set the new title
*/
#ifdef VBOX_WIN32_UI
setUITitle(szTitle);
#else
SDL_WM_SetCaption(szTitle, "Sun VirtualBox");
#endif
}
#if 0
static void vbox_show_shape (unsigned short w, unsigned short h,
uint32_t bg, const uint8_t *image)
{
size_t x, y;
unsigned short pitch;
const uint32_t *color;
const uint8_t *mask;
size_t size_mask;
mask = image;
pitch = (w + 7) / 8;
size_mask = (pitch * h + 3) & ~3;
color = (const uint32_t *) (image + size_mask);
printf ("show_shape %dx%d pitch %d size mask %d\n",
w, h, pitch, size_mask);
for (y = 0; y < h; ++y, mask += pitch, color += w)
{
for (x = 0; x < w; ++x) {
if (mask[x / 8] & (1 << (7 - (x % 8))))
printf (" ");
else
{
uint32_t c = color[x];
if (c == bg)
printf ("Y");
else
printf ("X");
}
}
printf ("\n");
}
}
#endif
/**
* Sets the pointer shape according to parameters.
* Must be called only from the main SDL thread.
*/
static void SetPointerShape (const PointerShapeChangeData *data)
{
/*
* don't allow to change the pointer shape if we are outside the valid
* guest area. In that case set standard mouse pointer is set and should
* not get overridden.
*/
if (gpOffCursor)
return;
if (data->shape)
{
bool ok = false;
uint32_t andMaskSize = (data->width + 7) / 8 * data->height;
uint32_t srcShapePtrScan = data->width * 4;
const uint8_t *srcAndMaskPtr = data->shape;
const uint8_t *srcShapePtr = data->shape + ((andMaskSize + 3) & ~3);
#if 0
/* pointer debugging code */
// vbox_show_shape(data->width, data->height, 0, data->shape);
uint32_t shapeSize = ((((data->width + 7) / 8) * data->height + 3) & ~3) + data->width * 4 * data->height;
printf("visible: %d\n", data->visible);
printf("width = %d\n", data->width);
printf("height = %d\n", data->height);
printf("alpha = %d\n", data->alpha);
printf("xhot = %d\n", data->xHot);
printf("yhot = %d\n", data->yHot);
printf("uint8_t pointerdata[] = { ");
for (uint32_t i = 0; i < shapeSize; i++)
{
printf("0x%x, ", data->shape[i]);
}
printf("};\n");
#endif
#if defined (RT_OS_WINDOWS)
BITMAPV5HEADER bi;
HBITMAP hBitmap;
void *lpBits;
HCURSOR hAlphaCursor = NULL;
::ZeroMemory (&bi, sizeof (BITMAPV5HEADER));
bi.bV5Size = sizeof (BITMAPV5HEADER);
bi.bV5Width = data->width;
bi.bV5Height = - (LONG) data->height;
bi.bV5Planes = 1;
bi.bV5BitCount = 32;
bi.bV5Compression = BI_BITFIELDS;
// specifiy a supported 32 BPP alpha format for Windows XP
bi.bV5RedMask = 0x00FF0000;
bi.bV5GreenMask = 0x0000FF00;
bi.bV5BlueMask = 0x000000FF;
if (data->alpha)
bi.bV5AlphaMask = 0xFF000000;
else
bi.bV5AlphaMask = 0;
HDC hdc = ::GetDC (NULL);
// create the DIB section with an alpha channel
hBitmap = ::CreateDIBSection (hdc, (BITMAPINFO *) &bi, DIB_RGB_COLORS,
(void **) &lpBits, NULL, (DWORD) 0);
::ReleaseDC (NULL, hdc);
HBITMAP hMonoBitmap = NULL;
if (data->alpha)
{
// create an empty mask bitmap
hMonoBitmap = ::CreateBitmap (data->width, data->height, 1, 1, NULL);
}
else
{
/* Word aligned AND mask. Will be allocated and created if necessary. */
uint8_t *pu8AndMaskWordAligned = NULL;
/* Width in bytes of the original AND mask scan line. */
uint32_t cbAndMaskScan = (data->width + 7) / 8;
if (cbAndMaskScan & 1)
{
/* Original AND mask is not word aligned. */
/* Allocate memory for aligned AND mask. */
pu8AndMaskWordAligned = (uint8_t *)RTMemTmpAllocZ ((cbAndMaskScan + 1) * data->height);
Assert(pu8AndMaskWordAligned);
if (pu8AndMaskWordAligned)
{
/* According to MSDN the padding bits must be 0.
* Compute the bit mask to set padding bits to 0 in the last byte of original AND mask.
*/
uint32_t u32PaddingBits = cbAndMaskScan * 8 - data->width;
Assert(u32PaddingBits < 8);
uint8_t u8LastBytesPaddingMask = (uint8_t)(0xFF << u32PaddingBits);
Log(("u8LastBytesPaddingMask = %02X, aligned w = %d, width = %d, cbAndMaskScan = %d\n",
u8LastBytesPaddingMask, (cbAndMaskScan + 1) * 8, data->width, cbAndMaskScan));
uint8_t *src = (uint8_t *)srcAndMaskPtr;
uint8_t *dst = pu8AndMaskWordAligned;
unsigned i;
for (i = 0; i < data->height; i++)
{
memcpy (dst, src, cbAndMaskScan);
dst[cbAndMaskScan - 1] &= u8LastBytesPaddingMask;
src += cbAndMaskScan;
dst += cbAndMaskScan + 1;
}
}
}
// create the AND mask bitmap
hMonoBitmap = ::CreateBitmap (data->width, data->height, 1, 1,
pu8AndMaskWordAligned? pu8AndMaskWordAligned: srcAndMaskPtr);
if (pu8AndMaskWordAligned)
{
RTMemTmpFree (pu8AndMaskWordAligned);
}
}
Assert (hBitmap);
Assert (hMonoBitmap);
if (hBitmap && hMonoBitmap)
{
DWORD *dstShapePtr = (DWORD *) lpBits;
for (uint32_t y = 0; y < data->height; y ++)
{
memcpy (dstShapePtr, srcShapePtr, srcShapePtrScan);
srcShapePtr += srcShapePtrScan;
dstShapePtr += data->width;
}
ICONINFO ii;
ii.fIcon = FALSE;
ii.xHotspot = data->xHot;
ii.yHotspot = data->yHot;
ii.hbmMask = hMonoBitmap;
ii.hbmColor = hBitmap;
hAlphaCursor = ::CreateIconIndirect (&ii);
Assert (hAlphaCursor);
if (hAlphaCursor)
{
// here we do a dirty trick by substituting a Window Manager's
// cursor handle with the handle we created
WMcursor *pCustomTempWMCursor = gpCustomCursor->wm_cursor;
// see SDL12/src/video/wincommon/SDL_sysmouse.c
void *wm_cursor = malloc (sizeof (HCURSOR) + sizeof (uint8_t *) * 2);
*(HCURSOR *) wm_cursor = hAlphaCursor;
gpCustomCursor->wm_cursor = (WMcursor *) wm_cursor;
SDL_SetCursor (gpCustomCursor);
SDL_ShowCursor (SDL_ENABLE);
if (pCustomTempWMCursor)
{
::DestroyCursor (* (HCURSOR *) pCustomTempWMCursor);
free (pCustomTempWMCursor);
}
ok = true;
}
}
if (hMonoBitmap)
::DeleteObject (hMonoBitmap);
if (hBitmap)
::DeleteObject (hBitmap);
#elif defined (VBOXSDL_WITH_X11) && !defined (VBOX_WITHOUT_XCURSOR)
XcursorImage *img = XcursorImageCreate (data->width, data->height);
Assert (img);
if (img)
{
img->xhot = data->xHot;
img->yhot = data->yHot;
XcursorPixel *dstShapePtr = img->pixels;
for (uint32_t y = 0; y < data->height; y ++)
{
memcpy (dstShapePtr, srcShapePtr, srcShapePtrScan);
if (!data->alpha)
{
// convert AND mask to the alpha channel
uint8_t byte = 0;
for (uint32_t x = 0; x < data->width; x ++)
{
if (!(x % 8))
byte = *(srcAndMaskPtr ++);
else
byte <<= 1;
if (byte & 0x80)
{
// Linux doesn't support inverted pixels (XOR ops,
// to be exact) in cursor shapes, so we detect such
// pixels and always replace them with black ones to
// make them visible at least over light colors
if (dstShapePtr [x] & 0x00FFFFFF)
dstShapePtr [x] = 0xFF000000;
else
dstShapePtr [x] = 0x00000000;
}
else
dstShapePtr [x] |= 0xFF000000;
}
}
srcShapePtr += srcShapePtrScan;
dstShapePtr += data->width;
}
Cursor cur = XcursorImageLoadCursor (gSdlInfo.info.x11.display, img);
Assert (cur);
if (cur)
{
// here we do a dirty trick by substituting a Window Manager's
// cursor handle with the handle we created
WMcursor *pCustomTempWMCursor = gpCustomCursor->wm_cursor;
// see SDL12/src/video/x11/SDL_x11mouse.c
void *wm_cursor = malloc (sizeof (Cursor));
*(Cursor *) wm_cursor = cur;
gpCustomCursor->wm_cursor = (WMcursor *) wm_cursor;
SDL_SetCursor (gpCustomCursor);
SDL_ShowCursor (SDL_ENABLE);
if (pCustomTempWMCursor)
{
XFreeCursor (gSdlInfo.info.x11.display, *(Cursor *) pCustomTempWMCursor);
free (pCustomTempWMCursor);
}
ok = true;
}
XcursorImageDestroy (img);
}
#endif
if (!ok)
{
SDL_SetCursor (gpDefaultCursor);
SDL_ShowCursor (SDL_ENABLE);
}
}
else
{
if (data->visible)
SDL_ShowCursor (SDL_ENABLE);
else if (gfAbsoluteMouseGuest)
/* Don't disable the cursor if the guest additions are not active (anymore) */
SDL_ShowCursor (SDL_DISABLE);
}
}
/**
* Handle changed mouse capabilities
*/
static void HandleGuestCapsChanged(void)
{
if (!gfAbsoluteMouseGuest)
{
// Cursor could be overwritten by the guest tools
SDL_SetCursor(gpDefaultCursor);
SDL_ShowCursor (SDL_ENABLE);
gpOffCursor = NULL;
}
if (gMouse && UseAbsoluteMouse())
{
// Actually switch to absolute coordinates
if (gfGrabbed)
InputGrabEnd();
gMouse->PutMouseEventAbsolute(-1, -1, 0, 0);
}
}
/**
* Handles a host key down event
*/
static int HandleHostKey(const SDL_KeyboardEvent *pEv)
{
/*
* Revalidate the host key modifier
*/
if ((SDL_GetModState() & ~(KMOD_MODE | KMOD_NUM | KMOD_RESERVED)) != gHostKeyMod)
return VERR_NOT_SUPPORTED;
/*
* What was pressed?
*/
switch (pEv->keysym.sym)
{
/* Control-Alt-Delete */
case SDLK_DELETE:
{
gKeyboard->PutCAD();
break;
}
/*
* Fullscreen / Windowed toggle.
*/
case SDLK_f:
{
if ( strchr(gHostKeyDisabledCombinations, 'f')
|| !gfAllowFullscreenToggle)
return VERR_NOT_SUPPORTED;
/*
* We have to pause/resume the machine during this
* process because there might be a short moment
* without a valid framebuffer
*/
MachineState_T machineState;
gMachine->COMGETTER(State)(&machineState);
if (machineState == MachineState_Running)
gConsole->Pause();
SetFullscreen(!gpFrameBuffer->getFullscreen());
if (machineState == MachineState_Running)
gConsole->Resume();
/*
* We have switched from/to fullscreen, so request a full
* screen repaint, just to be sure.
*/
gDisplay->InvalidateAndUpdate();
break;
}
/*
* Pause / Resume toggle.
*/
case SDLK_p:
{
if (strchr(gHostKeyDisabledCombinations, 'p'))
return VERR_NOT_SUPPORTED;
MachineState_T machineState;
gMachine->COMGETTER(State)(&machineState);
if (machineState == MachineState_Running)
{
if (gfGrabbed)
InputGrabEnd();
gConsole->Pause();
}
else if (machineState == MachineState_Paused)
{
gConsole->Resume();
}
UpdateTitlebar(TITLEBAR_NORMAL);
break;
}
/*
* Reset the VM
*/
case SDLK_r:
{
if (strchr(gHostKeyDisabledCombinations, 'r'))
return VERR_NOT_SUPPORTED;
ResetVM();
break;
}
/*
* Terminate the VM
*/
case SDLK_q:
{
if (strchr(gHostKeyDisabledCombinations, 'q'))
return VERR_NOT_SUPPORTED;
return VINF_EM_TERMINATE;
}
/*
* Save the machine's state and exit
*/
case SDLK_s:
{
if (strchr(gHostKeyDisabledCombinations, 's'))
return VERR_NOT_SUPPORTED;
SaveState();
return VINF_EM_TERMINATE;
}
case SDLK_h:
{
if (strchr(gHostKeyDisabledCombinations, 'h'))
return VERR_NOT_SUPPORTED;
if (gConsole)
gConsole->PowerButton();
break;
}
/*
* Perform an online snapshot. Continue operation.
*/
case SDLK_n:
{
if (strchr(gHostKeyDisabledCombinations, 'n'))
return VERR_NOT_SUPPORTED;
RTThreadYield();
ULONG cSnapshots = 0;
gMachine->COMGETTER(SnapshotCount)(&cSnapshots);
char pszSnapshotName[20];
RTStrPrintf(pszSnapshotName, sizeof(pszSnapshotName), "Snapshot %d", cSnapshots + 1);
gProgress = NULL;
HRESULT rc;
CHECK_ERROR(gConsole, TakeSnapshot(Bstr(pszSnapshotName), Bstr("Taken by VBoxSDL"),
gProgress.asOutParam()));
if (FAILED(rc))
{
RTPrintf("Error taking snapshot! rc = 0x%x\n", rc);
/* continue operation */
return VINF_SUCCESS;
}
/*
* Wait for the operation to be completed and work
* the title bar in the mean while.
*/
ULONG cPercent = 0;
for (;;)
{
BOOL fCompleted = false;
rc = gProgress->COMGETTER(Completed)(&fCompleted);
if (FAILED(rc) || fCompleted)
break;
ULONG cPercentNow;
rc = gProgress->COMGETTER(Percent)(&cPercentNow);
if (FAILED(rc))
break;
if (cPercentNow != cPercent)
{
UpdateTitlebar(TITLEBAR_SNAPSHOT, cPercent);
cPercent = cPercentNow;
}
/* wait */
rc = gProgress->WaitForCompletion(100);
if (FAILED(rc))
break;
/// @todo process gui events.
}
/* continue operation */
return VINF_SUCCESS;
}
case SDLK_F1: case SDLK_F2: case SDLK_F3:
case SDLK_F4: case SDLK_F5: case SDLK_F6:
case SDLK_F7: case SDLK_F8: case SDLK_F9:
case SDLK_F10: case SDLK_F11: case SDLK_F12:
{
// /* send Ctrl-Alt-Fx to guest */
com::SafeArray<LONG> keys(6);
keys[0] = 0x1d; // Ctrl down
keys[1] = 0x38; // Alt down
keys[2] = Keyevent2Keycode(pEv); // Fx down
keys[3] = keys[2] + 0x80; // Fx up
keys[4] = 0xb8; // Alt up
keys[5] = 0x9d; // Ctrl up
gKeyboard->PutScancodes(ComSafeArrayAsInParam(keys), NULL);
return VINF_SUCCESS;
}
/*
* Not a host key combination.
* Indicate this by returning false.
*/
default:
return VERR_NOT_SUPPORTED;
}
return VINF_SUCCESS;
}
/**
* Timer callback function for startup processing
*/
static Uint32 StartupTimer(Uint32 interval, void *param)
{
/* post message so we can do something in the startup loop */
SDL_Event event = {0};
event.type = SDL_USEREVENT;
event.user.type = SDL_USER_EVENT_TIMER;
SDL_PushEvent(&event);
RTSemEventSignal(g_EventSemSDLEvents);
return interval;
}
/**
* Timer callback function to check if resizing is finished
*/
static Uint32 ResizeTimer(Uint32 interval, void *param)
{
/* post message so the window is actually resized */
SDL_Event event = {0};
event.type = SDL_USEREVENT;
event.user.type = SDL_USER_EVENT_WINDOW_RESIZE_DONE;
PushSDLEventForSure(&event);
/* one-shot */
return 0;
}
/**
* Timer callback function to check if an ACPI power button event was handled by the guest.
*/
static Uint32 QuitTimer(Uint32 interval, void *param)
{
BOOL fHandled = FALSE;
gSdlQuitTimer = NULL;
if (gConsole)
{
int rc = gConsole->GetPowerButtonHandled(&fHandled);
LogRel(("QuitTimer: rc=%d handled=%d\n", rc, fHandled));
if (RT_FAILURE(rc) || !fHandled)
{
/* event was not handled, power down the guest */
gfACPITerm = FALSE;
SDL_Event event = {0};
event.type = SDL_QUIT;
PushSDLEventForSure(&event);
}
}
/* one-shot */
return 0;
}
/**
* Wait for the next SDL event. Don't use SDL_WaitEvent since this function
* calls SDL_Delay(10) if the event queue is empty.
*/
static int WaitSDLEvent(SDL_Event *event)
{
for (;;)
{
int rc = SDL_PollEvent (event);
if (rc == 1)
{
#ifdef USE_XPCOM_QUEUE_THREAD
if (event->type == SDL_USER_EVENT_XPCOM_EVENTQUEUE)
consumedXPCOMUserEvent();
#endif
return 1;
}
/* Immediately wake up if new SDL events are available. This does not
* work for internal SDL events. Don't wait more than 10ms. */
RTSemEventWait(g_EventSemSDLEvents, 10);
}
}
/**
* Ensure that an SDL event is really enqueued. Try multiple times if necessary.
*/
int PushSDLEventForSure(SDL_Event *event)
{
int ntries = 10;
for (; ntries > 0; ntries--)
{
int rc = SDL_PushEvent(event);
RTSemEventSignal(g_EventSemSDLEvents);
if (rc == 0)
return 0;
Log(("PushSDLEventForSure: waiting for 2ms\n"));
RTThreadSleep(2);
}
LogRel(("WARNING: Failed to enqueue SDL event %d.%d!\n",
event->type, event->type == SDL_USEREVENT ? event->user.type : 0));
return -1;
}
#ifdef VBOXSDL_WITH_X11
/**
* Special SDL_PushEvent function for NotifyUpdate events. These events may occur in bursts
* so make sure they don't flood the SDL event queue.
*/
void PushNotifyUpdateEvent(SDL_Event *event)
{
int rc = SDL_PushEvent(event);
RTSemEventSignal(g_EventSemSDLEvents);
AssertMsg(!rc, ("SDL_PushEvent returned SDL error\n"));
/* A global counter is faster than SDL_PeepEvents() */
if (!rc)
ASMAtomicIncS32(&g_cNotifyUpdateEventsPending);
/* In order to not flood the SDL event queue, yield the CPU or (if there are already many
* events queued) even sleep */
if (g_cNotifyUpdateEventsPending > 96)
{
/* Too many NotifyUpdate events, sleep for a small amount to give the main thread time
* to handle these events. The SDL queue can hold up to 128 events. */
Log(("PushNotifyUpdateEvent: Sleep 1ms\n"));
RTThreadSleep(1);
}
else
RTThreadYield();
}
#endif /* VBOXSDL_WITH_X11 */
/**
*
*/
static void SetFullscreen(bool enable)
{
if (enable == gpFrameBuffer->getFullscreen())
return;
if (!gfFullscreenResize)
{
/*
* The old/default way: SDL will resize the host to fit the guest screen resolution.
*/
gpFrameBuffer->setFullscreen(enable);
}
else
{
/*
* The alternate way: Switch to fullscreen with the host screen resolution and adapt
* the guest screen resolution to the host window geometry.
*/
uint32_t NewWidth = 0, NewHeight = 0;
if (enable)
{
/* switch to fullscreen */
gmGuestNormalXRes = gpFrameBuffer->getGuestXRes();
gmGuestNormalYRes = gpFrameBuffer->getGuestYRes();
gpFrameBuffer->getFullscreenGeometry(&NewWidth, &NewHeight);
}
else
{
/* switch back to saved geometry */
NewWidth = gmGuestNormalXRes;
NewHeight = gmGuestNormalYRes;
}
if (NewWidth != 0 && NewHeight != 0)
{
gpFrameBuffer->setFullscreen(enable);
gfIgnoreNextResize = TRUE;
gDisplay->SetVideoModeHint(NewWidth, NewHeight, 0, 0);
}
}
}