VBoxSDL.cpp@ 32718

Last change on this file since 32718 was 32718, checked in by vboxsync, 14 years ago
com/string: Remove bool conversion operator and other convenience error operators. They are hiding programming errors (like incorrect empty string checks, and in one case a free of the wrong pointer).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 168.5 KB

Line
1	/** @file
2	* VBox frontends: VBoxSDL (simple frontend based on SDL):
3	* Main code
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	/*******************************************************************************
19	* Header Files *
20	*******************************************************************************/
21	#define LOG_GROUP LOG_GROUP_GUI
22
23	#include <VBox/com/com.h>
24	#include <VBox/com/string.h>
25	#include <VBox/com/Guid.h>
26	#include <VBox/com/array.h>
27	#include <VBox/com/ErrorInfo.h>
28	#include <VBox/com/errorprint.h>
29
30	#include <VBox/com/EventQueue.h>
31	#include <VBox/com/VirtualBox.h>
32
33	using namespace com;
34
35	#if defined(VBOXSDL_WITH_X11)
36	# include <VBox/VBoxKeyboard.h>
37
38	# include <X11/Xlib.h>
39	# include <X11/cursorfont.h> /* for XC_left_ptr */
40	# if !defined(VBOX_WITHOUT_XCURSOR)
41	# include <X11/Xcursor/Xcursor.h>
42	# endif
43	# include <unistd.h>
44	#endif
45
46	#ifndef RT_OS_DARWIN
47	#include <SDL_syswm.h> /* for SDL_GetWMInfo() */
48	#endif
49
50	#include "VBoxSDL.h"
51	#include "Framebuffer.h"
52	#include "Helper.h"
53
54	#include <VBox/types.h>
55	#include <VBox/err.h>
56	#include <VBox/param.h>
57	#include <VBox/log.h>
58	#include <VBox/version.h>
59	#include <VBox/VBoxVideo.h>
60
61	#include <iprt/alloca.h>
62	#include <iprt/asm.h>
63	#include <iprt/assert.h>
64	#include <iprt/env.h>
65	#include <iprt/file.h>
66	#include <iprt/ldr.h>
67	#include <iprt/initterm.h>
68	#include <iprt/path.h>
69	#include <iprt/process.h>
70	#include <iprt/semaphore.h>
71	#include <iprt/string.h>
72	#include <iprt/stream.h>
73	#include <iprt/uuid.h>
74
75	#include <signal.h>
76
77	#include <vector>
78	#include <list>
79
80	/* Xlib would re-define our enums */
81	#undef True
82	#undef False
83
84	/*******************************************************************************
85	* Defined Constants And Macros *
86	*******************************************************************************/
87	#ifdef VBOX_SECURELABEL
88	/** extra data key for the secure label */
89	#define VBOXSDL_SECURELABEL_EXTRADATA "VBoxSDL/SecureLabel"
90	/** label area height in pixels */
91	#define SECURE_LABEL_HEIGHT 20
92	#endif
93
94	/** Enables the rawr[0\|3], patm, and casm options. */
95	#define VBOXSDL_ADVANCED_OPTIONS
96
97	/*******************************************************************************
98	* Structures and Typedefs *
99	*******************************************************************************/
100	/** Pointer shape change event data strucure */
101	struct PointerShapeChangeData
102	{
103	PointerShapeChangeData(BOOL aVisible, BOOL aAlpha, ULONG aXHot, ULONG aYHot,
104	ULONG aWidth, ULONG aHeight, ComSafeArrayIn(BYTE,pShape))
105	: visible(aVisible), alpha(aAlpha), xHot(aXHot), yHot(aYHot),
106	width(aWidth), height(aHeight)
107	{
108	// make a copy of the shape
109	com::SafeArray <BYTE> aShape(ComSafeArrayInArg (pShape));
110	size_t cbShapeSize = aShape.size();
111	if (cbShapeSize > 0)
112	{
113	shape.resize(cbShapeSize);
114	::memcpy(shape.raw(), aShape.raw(), cbShapeSize);
115	}
116	}
117
118	~PointerShapeChangeData()
119	{
120	}
121
122	const BOOL visible;
123	const BOOL alpha;
124	const ULONG xHot;
125	const ULONG yHot;
126	const ULONG width;
127	const ULONG height;
128	com::SafeArray<BYTE> shape;
129	};
130
131	enum TitlebarMode
132	{
133	TITLEBAR_NORMAL = 1,
134	TITLEBAR_STARTUP = 2,
135	TITLEBAR_SAVE = 3,
136	TITLEBAR_SNAPSHOT = 4
137	};
138
139	/*******************************************************************************
140	* Internal Functions *
141	*******************************************************************************/
142	static bool UseAbsoluteMouse(void);
143	static void ResetKeys(void);
144	static void ProcessKey(SDL_KeyboardEvent *ev);
145	static void InputGrabStart(void);
146	static void InputGrabEnd(void);
147	static void SendMouseEvent(VBoxSDLFB *fb, int dz, int button, int down);
148	static void UpdateTitlebar(TitlebarMode mode, uint32_t u32User = 0);
149	static void SetPointerShape(const PointerShapeChangeData *data);
150	static void HandleGuestCapsChanged(void);
151	static int HandleHostKey(const SDL_KeyboardEvent *pEv);
152	static Uint32 StartupTimer(Uint32 interval, void *param);
153	static Uint32 ResizeTimer(Uint32 interval, void *param);
154	static Uint32 QuitTimer(Uint32 interval, void *param);
155	static int WaitSDLEvent(SDL_Event *event);
156	static void SetFullscreen(bool enable);
157	#ifdef VBOX_WITH_SDL13
158	static VBoxSDLFB * getFbFromWinId(SDL_WindowID id);
159	#endif
160
161
162	/*******************************************************************************
163	* Global Variables *
164	*******************************************************************************/
165	static int gHostKeyMod = KMOD_RCTRL;
166	static int gHostKeySym1 = SDLK_RCTRL;
167	static int gHostKeySym2 = SDLK_UNKNOWN;
168	static const char *gHostKeyDisabledCombinations = "";
169	static const char *gpszPidFile;
170	static BOOL gfGrabbed = FALSE;
171	static BOOL gfGrabOnMouseClick = TRUE;
172	static BOOL gfFullscreenResize = FALSE;
173	static BOOL gfIgnoreNextResize = FALSE;
174	static BOOL gfAllowFullscreenToggle = TRUE;
175	static BOOL gfAbsoluteMouseHost = FALSE;
176	static BOOL gfAbsoluteMouseGuest = FALSE;
177	static BOOL gfRelativeMouseGuest = TRUE;
178	static BOOL gfGuestNeedsHostCursor = FALSE;
179	static BOOL gfOffCursorActive = FALSE;
180	static BOOL gfGuestNumLockPressed = FALSE;
181	static BOOL gfGuestCapsLockPressed = FALSE;
182	static BOOL gfGuestScrollLockPressed = FALSE;
183	static BOOL gfACPITerm = FALSE;
184	static BOOL gfXCursorEnabled = FALSE;
185	static int gcGuestNumLockAdaptions = 2;
186	static int gcGuestCapsLockAdaptions = 2;
187	static uint32_t gmGuestNormalXRes;
188	static uint32_t gmGuestNormalYRes;
189
190	/** modifier keypress status (scancode as index) */
191	static uint8_t gaModifiersState[256];
192
193	static ComPtr<IMachine> gMachine;
194	static ComPtr<IConsole> gConsole;
195	static ComPtr<IMachineDebugger> gMachineDebugger;
196	static ComPtr<IKeyboard> gKeyboard;
197	static ComPtr<IMouse> gMouse;
198	static ComPtr<IDisplay> gDisplay;
199	static ComPtr<IVRDPServer> gVrdpServer;
200	static ComPtr<IProgress> gProgress;
201
202	static ULONG gcMonitors = 1;
203	static VBoxSDLFB *gpFramebuffer[64];
204	static SDL_Cursor *gpDefaultCursor = NULL;
205	#ifdef VBOXSDL_WITH_X11
206	static Cursor gpDefaultOrigX11Cursor;
207	#endif
208	static SDL_Cursor *gpCustomCursor = NULL;
209	#ifndef VBOX_WITH_SDL13
210	static WMcursor *gpCustomOrigWMcursor = NULL;
211	#endif
212	static SDL_Cursor *gpOffCursor = NULL;
213	static SDL_TimerID gSdlResizeTimer = NULL;
214	static SDL_TimerID gSdlQuitTimer = NULL;
215
216	#if defined(VBOXSDL_WITH_X11) && !defined(VBOX_WITH_SDL13)
217	static SDL_SysWMinfo gSdlInfo;
218	#endif
219
220	#ifdef VBOX_SECURELABEL
221	#ifdef RT_OS_WINDOWS
222	#define LIBSDL_TTF_NAME "SDL_ttf"
223	#else
224	#define LIBSDL_TTF_NAME "libSDL_ttf-2.0.so.0"
225	#endif
226	RTLDRMOD gLibrarySDL_ttf = NIL_RTLDRMOD;
227	#endif
228
229	static RTSEMEVENT g_EventSemSDLEvents;
230	static volatile int32_t g_cNotifyUpdateEventsPending;
231
232	/**
233	* Event handler for VirtualBox events
234	*/
235	class VBoxSDLEventListener :
236	VBOX_SCRIPTABLE_IMPL(IEventListener)
237	{
238	public:
239	VBoxSDLEventListener()
240	{
241	#if defined(RT_OS_WINDOWS)
242	refcnt = 0;
243	#endif
244	}
245
246	virtual ~VBoxSDLEventListener()
247	{
248	}
249
250	#ifdef RT_OS_WINDOWS
251	STDMETHOD_(ULONG, AddRef)()
252	{
253	return ::InterlockedIncrement(&refcnt);
254	}
255	STDMETHOD_(ULONG, Release)()
256	{
257	long cnt = ::InterlockedDecrement(&refcnt);
258	if (cnt == 0)
259	delete this;
260	return cnt;
261	}
262	#endif
263	VBOX_SCRIPTABLE_DISPATCH_IMPL(IEventListener)
264
265	NS_DECL_ISUPPORTS
266
267
268	STDMETHOD(HandleEvent)(IEvent * aEvent)
269	{
270	VBoxEventType_T aType = VBoxEventType_Invalid;
271
272	aEvent->COMGETTER(Type)(&aType);
273	switch (aType)
274	{
275	case VBoxEventType_OnExtraDataChanged:
276	{
277	#ifdef VBOX_SECURELABEL
278	ComPtr<IExtraDataChangedEvent> edcev = aEvent;
279	Assert(edcev);
280	Bstr key, machineId;
281	edcev->COMGETTER(MachineId)(machineId.asOutParam());
282	if (gMachine)
283	{
284	/*
285	* check if we're interested in the message
286	*/
287	Bstr ourGuid;
288	gMachine->COMGETTER(Id)(ourGuid.asOutParam());
289	if (ourGuid == machineId)
290	{
291	Bstr keyString;
292	edcev->COMGETTER(Key)(keyString.asOutParam());
293	if (keyString == VBOXSDL_SECURELABEL_EXTRADATA)
294	{
295	/*
296	* Notify SDL thread of the string update
297	*/
298	SDL_Event event = {0};
299	event.type = SDL_USEREVENT;
300	event.user.type = SDL_USER_EVENT_SECURELABEL_UPDATE;
301	PushSDLEventForSure(&event);
302	}
303	}
304	}
305	#endif
306	break;
307	}
308	default:
309	AssertFailed();
310	}
311
312	return S_OK;
313	}
314
315	private:
316	#ifdef RT_OS_WINDOWS
317	long refcnt;
318	#endif
319
320	};
321
322	/**
323	* Event handler for machine events
324	*/
325	class VBoxSDLConsoleEventListener :
326	VBOX_SCRIPTABLE_IMPL(IEventListener)
327	{
328	public:
329	VBoxSDLConsoleEventListener() : m_fIgnorePowerOffEvents(false)
330	{
331	#if defined(RT_OS_WINDOWS)
332	refcnt = 0;
333	#endif
334	}
335
336	virtual ~VBoxSDLConsoleEventListener()
337	{
338	}
339
340	#ifdef RT_OS_WINDOWS
341	STDMETHOD_(ULONG, AddRef)()
342	{
343	return ::InterlockedIncrement(&refcnt);
344	}
345	STDMETHOD_(ULONG, Release)()
346	{
347	long cnt = ::InterlockedDecrement(&refcnt);
348	if (cnt == 0)
349	delete this;
350	return cnt;
351	}
352	#endif
353	VBOX_SCRIPTABLE_DISPATCH_IMPL(IEventListener)
354
355	NS_DECL_ISUPPORTS
356
357	STDMETHOD(HandleEvent)(IEvent * aEvent)
358	{
359	VBoxEventType_T aType = VBoxEventType_Invalid;
360
361	aEvent->COMGETTER(Type)(&aType);
362	// likely all this double copy is now excessive, and we can just use existing event object
363	// @todo: eliminate it
364	switch (aType)
365	{
366	case VBoxEventType_OnMousePointerShapeChanged:
367	{
368	ComPtr<IMousePointerShapeChangedEvent> mpscev = aEvent;
369	Assert(mpscev);
370	PointerShapeChangeData *data;
371	BOOL visible, alpha;
372	ULONG xHot, yHot, width, height;
373	com::SafeArray <BYTE> shape;
374
375	mpscev->COMGETTER(Visible)(&visible);
376	mpscev->COMGETTER(Alpha)(&alpha);
377	mpscev->COMGETTER(Xhot)(&xHot);
378	mpscev->COMGETTER(Yhot)(&yHot);
379	mpscev->COMGETTER(Width)(&width);
380	mpscev->COMGETTER(Height)(&height);
381	mpscev->COMGETTER(Shape)(ComSafeArrayAsOutParam(shape));
382	data = new PointerShapeChangeData(visible, alpha, xHot, yHot, width, height,
383	ComSafeArrayAsInParam(shape));
384	Assert(data);
385	if (!data)
386	break;
387
388	SDL_Event event = {0};
389	event.type = SDL_USEREVENT;
390	event.user.type = SDL_USER_EVENT_POINTER_CHANGE;
391	event.user.data1 = data;
392
393	int rc = PushSDLEventForSure(&event);
394	if (rc)
395	delete data;
396
397	break;
398	}
399	case VBoxEventType_OnMouseCapabilityChanged:
400	{
401	ComPtr<IMouseCapabilityChangedEvent> mccev = aEvent;
402	Assert(mccev);
403	mccev->COMGETTER(SupportsAbsolute)(&gfAbsoluteMouseGuest);
404	mccev->COMGETTER(SupportsRelative)(&gfRelativeMouseGuest);
405	mccev->COMGETTER(NeedsHostCursor)(&gfGuestNeedsHostCursor);
406	SDL_Event event = {0};
407	event.type = SDL_USEREVENT;
408	event.user.type = SDL_USER_EVENT_GUEST_CAP_CHANGED;
409
410	PushSDLEventForSure(&event);
411	break;
412	}
413	case VBoxEventType_OnKeyboardLedsChanged:
414	{
415	ComPtr<IKeyboardLedsChangedEvent> klcev = aEvent;
416	Assert(klcev);
417	BOOL fNumLock, fCapsLock, fScrollLock;
418	klcev->COMGETTER(NumLock)(&fNumLock);
419	klcev->COMGETTER(CapsLock)(&fCapsLock);
420	klcev->COMGETTER(ScrollLock)(&fScrollLock);
421	/* Don't bother the guest with NumLock scancodes if he doesn't set the NumLock LED */
422	if (gfGuestNumLockPressed != fNumLock)
423	gcGuestNumLockAdaptions = 2;
424	if (gfGuestCapsLockPressed != fCapsLock)
425	gcGuestCapsLockAdaptions = 2;
426	gfGuestNumLockPressed = fNumLock;
427	gfGuestCapsLockPressed = fCapsLock;
428	gfGuestScrollLockPressed = fScrollLock;
429	break;
430	}
431
432	case VBoxEventType_OnStateChanged:
433	{
434	ComPtr<IStateChangedEvent> scev = aEvent;
435	Assert(scev);
436	MachineState_T machineState;
437	scev->COMGETTER(State)(&machineState);
438	LogFlow(("OnStateChange: machineState = %d (%s)\n", machineState, GetStateName(machineState)));
439	SDL_Event event = {0};
440
441	if ( machineState == MachineState_Aborted
442	\|\| machineState == MachineState_Teleported
443	\|\| (machineState == MachineState_Saved && !m_fIgnorePowerOffEvents)
444	\|\| (machineState == MachineState_PoweredOff && !m_fIgnorePowerOffEvents)
445	)
446	{
447	/*
448	* We have to inform the SDL thread that the application has be terminated
449	*/
450	event.type = SDL_USEREVENT;
451	event.user.type = SDL_USER_EVENT_TERMINATE;
452	event.user.code = machineState == MachineState_Aborted
453	? VBOXSDL_TERM_ABEND
454	: VBOXSDL_TERM_NORMAL;
455	}
456	else
457	{
458	/*
459	* Inform the SDL thread to refresh the titlebar
460	*/
461	event.type = SDL_USEREVENT;
462	event.user.type = SDL_USER_EVENT_UPDATE_TITLEBAR;
463	}
464
465	PushSDLEventForSure(&event);
466	break;
467	}
468
469	case VBoxEventType_OnRuntimeError:
470	{
471	ComPtr<IRuntimeErrorEvent> rteev = aEvent;
472	Assert(rteev);
473	Bstr id, message;
474	BOOL fFatal;
475
476	rteev->COMGETTER(Fatal)(&fFatal);
477	MachineState_T machineState;
478	gMachine->COMGETTER(State)(&machineState);
479	const char *pszType;
480	bool fPaused = machineState == MachineState_Paused;
481	if (fFatal)
482	pszType = "FATAL ERROR";
483	else if (machineState == MachineState_Paused)
484	pszType = "Non-fatal ERROR";
485	else
486	pszType = "WARNING";
487	rteev->COMGETTER(Id)(id.asOutParam());
488	rteev->COMGETTER(Message)(message.asOutParam());
489	RTPrintf("\n%s: %lS \n%lS\n%s\n", pszType, id.raw(), message.raw(),
490	fPaused ? "The VM was paused. Continue with HostKey + P after you solved the problem.\n" : "");
491	break;
492	}
493
494	case VBoxEventType_OnCanShowWindow:
495	{
496	ComPtr<ICanShowWindowEvent> cswev = aEvent;
497	Assert(cswev);
498	#ifdef RT_OS_DARWIN
499	/* SDL feature not available on Quartz */
500	#else
501	SDL_SysWMinfo info;
502	SDL_VERSION(&info.version);
503	if (!SDL_GetWMInfo(&info))
504	cswev->AddVeto(NULL);
505	#endif
506	break;
507	}
508
509	case VBoxEventType_OnShowWindow:
510	{
511	ComPtr<IShowWindowEvent> swev = aEvent;
512	Assert(swev);
513	#ifndef RT_OS_DARWIN
514	SDL_SysWMinfo info;
515	SDL_VERSION(&info.version);
516	if (SDL_GetWMInfo(&info))
517	{
518	#if defined(VBOXSDL_WITH_X11)
519	swev->COMSETTER(WinId)((LONG64)info.info.x11.wmwindow);
520	#elif defined(RT_OS_WINDOWS)
521	swev->COMSETTER(WinId)((LONG64)info.window);
522	#else
523	AssertFailed();
524	#endif
525	}
526	#endif /* !RT_OS_DARWIN */
527	break;
528	}
529
530	default:
531	AssertFailed();
532	}
533	return S_OK;
534	}
535
536	static const char *GetStateName(MachineState_T machineState)
537	{
538	switch (machineState)
539	{
540	case MachineState_Null: return "<null>";
541	case MachineState_PoweredOff: return "PoweredOff";
542	case MachineState_Saved: return "Saved";
543	case MachineState_Teleported: return "Teleported";
544	case MachineState_Aborted: return "Aborted";
545	case MachineState_Running: return "Running";
546	case MachineState_Teleporting: return "Teleporting";
547	case MachineState_LiveSnapshotting: return "LiveSnapshotting";
548	case MachineState_Paused: return "Paused";
549	case MachineState_Stuck: return "GuruMeditation";
550	case MachineState_Starting: return "Starting";
551	case MachineState_Stopping: return "Stopping";
552	case MachineState_Saving: return "Saving";
553	case MachineState_Restoring: return "Restoring";
554	case MachineState_TeleportingPausedVM: return "TeleportingPausedVM";
555	case MachineState_TeleportingIn: return "TeleportingIn";
556	case MachineState_RestoringSnapshot: return "RestoringSnapshot";
557	case MachineState_DeletingSnapshot: return "DeletingSnapshot";
558	case MachineState_SettingUp: return "SettingUp";
559	default: return "no idea";
560	}
561	}
562
563	void ignorePowerOffEvents(bool fIgnore)
564	{
565	m_fIgnorePowerOffEvents = fIgnore;
566	}
567
568	private:
569	#ifdef RT_OS_WINDOWS
570	long refcnt;
571	#endif
572	bool m_fIgnorePowerOffEvents;
573	};
574
575	#ifdef VBOX_WITH_XPCOM
576	NS_DECL_CLASSINFO(VBoxSDLEventListener)
577	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(VBoxSDLEventListener, IEventListener)
578	NS_DECL_CLASSINFO(VBoxSDLConsoleEventListener)
579	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(VBoxSDLConsoleEventListener, IEventListener)
580	#endif /* VBOX_WITH_XPCOM */
581
582	static void show_usage()
583	{
584	RTPrintf("Usage:\n"
585	" --startvm <uuid\|name> Virtual machine to start, either UUID or name\n"
586	" --hda <file> Set temporary first hard disk to file\n"
587	" --fda <file> Set temporary first floppy disk to file\n"
588	" --cdrom <file> Set temporary CDROM/DVD to file/device ('none' to unmount)\n"
589	" --boot <a\|c\|d\|n> Set temporary boot device (a = floppy, c = 1st HD, d = DVD, n = network)\n"
590	" --memory <size> Set temporary memory size in megabytes\n"
591	" --vram <size> Set temporary size of video memory in megabytes\n"
592	" --fullscreen Start VM in fullscreen mode\n"
593	" --fullscreenresize Resize the guest on fullscreen\n"
594	" --fixedmode <w> <h> <bpp> Use a fixed SDL video mode with given width, height and bits per pixel\n"
595	" --nofstoggle Forbid switching to/from fullscreen mode\n"
596	" --noresize Make the SDL frame non resizable\n"
597	" --nohostkey Disable all hostkey combinations\n"
598	" --nohostkeys ... Disable specific hostkey combinations, see below for valid keys\n"
599	" --nograbonclick Disable mouse/keyboard grabbing on mouse click w/o additions\n"
600	" --detecthostkey Get the hostkey identifier and modifier state\n"
601	" --hostkey <key> {<key2>} <mod> Set the host key to the values obtained using --detecthostkey\n"
602	" --termacpi Send an ACPI power button event when closing the window\n"
603	#ifdef VBOX_WITH_VRDP
604	" --vrdp <ports> Listen for VRDP connections on one of specified ports (default if not specified)\n"
605	#endif
606	" --discardstate Discard saved state (if present) and revert to last snapshot (if present)\n"
607	#ifdef VBOX_SECURELABEL
608	" --securelabel Display a secure VM label at the top of the screen\n"
609	" --seclabelfnt TrueType (.ttf) font file for secure session label\n"
610	" --seclabelsiz Font point size for secure session label (default 12)\n"
611	" --seclabelofs Font offset within the secure label (default 0)\n"
612	" --seclabelfgcol <rgb> Secure label text color RGB value in 6 digit hexadecimal (eg: FFFF00)\n"
613	" --seclabelbgcol <rgb> Secure label background color RGB value in 6 digit hexadecimal (eg: FF0000)\n"
614	#endif
615	#ifdef VBOXSDL_ADVANCED_OPTIONS
616	" --[no]rawr0 Enable or disable raw ring 3\n"
617	" --[no]rawr3 Enable or disable raw ring 0\n"
618	" --[no]patm Enable or disable PATM\n"
619	" --[no]csam Enable or disable CSAM\n"
620	" --[no]hwvirtex Permit or deny the usage of VT-x/AMD-V\n"
621	#endif
622	"\n"
623	"Key bindings:\n"
624	" <hostkey> + f Switch to full screen / restore to previous view\n"
625	" h Press ACPI power button\n"
626	" n Take a snapshot and continue execution\n"
627	" p Pause / resume execution\n"
628	" q Power off\n"
629	" r VM reset\n"
630	" s Save state and power off\n"
631	" <del> Send <ctrl><alt><del>\n"
632	" <F1>...<F12> Send <ctrl><alt><Fx>\n"
633	#if defined(DEBUG) \|\| defined(VBOX_WITH_STATISTICS)
634	"\n"
635	"Further key bindings useful for debugging:\n"
636	" LCtrl + Alt + F12 Reset statistics counter\n"
637	" LCtrl + Alt + F11 Dump statistics to logfile\n"
638	" Alt + F12 Toggle R0 recompiler\n"
639	" Alt + F11 Toggle R3 recompiler\n"
640	" Alt + F10 Toggle PATM\n"
641	" Alt + F9 Toggle CSAM\n"
642	" Alt + F8 Toggle single step mode\n"
643	" LCtrl/RCtrl + F12 Toggle logger\n"
644	" F12 Write log marker to logfile\n"
645	#endif
646	"\n");
647	}
648
649	static void PrintError(const char *pszName, CBSTR pwszDescr, CBSTR pwszComponent=NULL)
650	{
651	const char pszFile, pszFunc, *pszStat;
652	char pszBuffer[1024];
653	com::ErrorInfo info;
654
655	RTStrPrintf(pszBuffer, sizeof(pszBuffer), "%lS", pwszDescr);
656
657	RTPrintf("\n%s! Error info:\n", pszName);
658	if ( (pszFile = strstr(pszBuffer, "At '"))
659	&& (pszFunc = strstr(pszBuffer, ") in "))
660	&& (pszStat = strstr(pszBuffer, "VBox status code: ")))
661	RTPrintf(" %.s %.s\n In%.*s %s",
662	pszFile-pszBuffer, pszBuffer,
663	pszFunc-pszFile+1, pszFile,
664	pszStat-pszFunc-4, pszFunc+4,
665	pszStat);
666	else
667	RTPrintf("%s\n", pszBuffer);
668
669	if (pwszComponent)
670	RTPrintf("(component %lS).\n", pwszComponent);
671
672	RTPrintf("\n");
673	}
674
675	#ifdef VBOXSDL_WITH_X11
676	/**
677	* Custom signal handler. Currently it is only used to release modifier
678	* keys when receiving the USR1 signal. When switching VTs, we might not
679	* get release events for Ctrl-Alt and in case a savestate is performed
680	* on the new VT, the VM will be saved with modifier keys stuck. This is
681	* annoying enough for introducing this hack.
682	*/
683	void signal_handler_SIGUSR1(int sig, siginfo_t info, void secret)
684	{
685	/* only SIGUSR1 is interesting */
686	if (sig == SIGUSR1)
687	{
688	/* just release the modifiers */
689	ResetKeys();
690	}
691	}
692
693	/**
694	* Custom signal handler for catching exit events.
695	*/
696	void signal_handler_SIGINT(int sig)
697	{
698	if (gpszPidFile)
699	RTFileDelete(gpszPidFile);
700	signal(SIGINT, SIG_DFL);
701	signal(SIGQUIT, SIG_DFL);
702	signal(SIGSEGV, SIG_DFL);
703	kill(getpid(), sig);
704	}
705	#endif /* VBOXSDL_WITH_X11 */
706
707	/** entry point */
708	extern "C"
709	DECLEXPORT(int) TrustedMain(int argc, char argv, char envp)
710	{
711	#ifdef VBOXSDL_WITH_X11
712	/*
713	* Lock keys on SDL behave different from normal keys: A KeyPress event is generated
714	* if the lock mode gets active and a keyRelease event is genereated if the lock mode
715	* gets inactive, that is KeyPress and KeyRelease are sent when pressing the lock key
716	* to change the mode. The current lock mode is reflected in SDL_GetModState().
717	*
718	* Debian patched libSDL to make the lock keys behave like normal keys generating a
719	* KeyPress/KeyRelease event if the lock key was pressed/released. But the lock status
720	* is not reflected in the mod status anymore. We disable the Debian-specific extension
721	* to ensure a defined environment and work around the missing KeyPress/KeyRelease
722	* events in ProcessKeys().
723	*/
724	RTEnvSet("SDL_DISABLE_LOCK_KEYS", "1");
725	#endif
726
727	/*
728	* the hostkey detection mode is unrelated to VM processing, so handle it before
729	* we initialize anything COM related
730	*/
731	if (argc == 2 && ( !strcmp(argv[1], "-detecthostkey")
732	\|\| !strcmp(argv[1], "--detecthostkey")))
733	{
734	int rc = SDL_InitSubSystem(SDL_INIT_VIDEO \| SDL_INIT_TIMER \| SDL_INIT_NOPARACHUTE);
735	if (rc != 0)
736	{
737	RTPrintf("Error: SDL_InitSubSystem failed with message '%s'\n", SDL_GetError());
738	return 1;
739	}
740	/* we need a video window for the keyboard stuff to work */
741	if (!SDL_SetVideoMode(640, 480, 16, SDL_SWSURFACE))
742	{
743	RTPrintf("Error: could not set SDL video mode\n");
744	return 1;
745	}
746
747	RTPrintf("Please hit one or two function key(s) to get the --hostkey value...\n");
748
749	SDL_Event event1;
750	while (SDL_WaitEvent(&event1))
751	{
752	if (event1.type == SDL_KEYDOWN)
753	{
754	SDL_Event event2;
755	unsigned mod = SDL_GetModState() & ~(KMOD_MODE \| KMOD_NUM \| KMOD_RESERVED);
756	while (SDL_WaitEvent(&event2))
757	{
758	if (event2.type == SDL_KEYDOWN \|\| event2.type == SDL_KEYUP)
759	{
760	/* pressed additional host key */
761	RTPrintf("--hostkey %d", event1.key.keysym.sym);
762	if (event2.type == SDL_KEYDOWN)
763	{
764	RTPrintf(" %d", event2.key.keysym.sym);
765	RTPrintf(" %d\n", SDL_GetModState() & ~(KMOD_MODE \| KMOD_NUM \| KMOD_RESERVED));
766	}
767	else
768	{
769	RTPrintf(" %d\n", mod);
770	}
771	/* we're done */
772	break;
773	}
774	}
775	/* we're down */
776	break;
777	}
778	}
779	SDL_Quit();
780	return 1;
781	}
782
783	HRESULT rc;
784	int vrc;
785	Guid uuidVM;
786	char *vmName = NULL;
787	DeviceType_T bootDevice = DeviceType_Null;
788	uint32_t memorySize = 0;
789	uint32_t vramSize = 0;
790	VBoxSDLEventListener *vboxListener = NULL;
791	VBoxSDLConsoleEventListener *consoleListener = NULL;
792
793	bool fFullscreen = false;
794	bool fResizable = true;
795	#ifdef USE_XPCOM_QUEUE_THREAD
796	bool fXPCOMEventThreadSignaled = false;
797	#endif
798	char *hdaFile = NULL;
799	char *cdromFile = NULL;
800	char *fdaFile = NULL;
801	#ifdef VBOX_WITH_VRDP
802	const char *portVRDP = NULL;
803	#endif
804	bool fDiscardState = false;
805	#ifdef VBOX_SECURELABEL
806	BOOL fSecureLabel = false;
807	uint32_t secureLabelPointSize = 12;
808	uint32_t secureLabelFontOffs = 0;
809	char *secureLabelFontFile = NULL;
810	uint32_t secureLabelColorFG = 0x0000FF00;
811	uint32_t secureLabelColorBG = 0x00FFFF00;
812	#endif
813	#ifdef VBOXSDL_ADVANCED_OPTIONS
814	unsigned fRawR0 = ~0U;
815	unsigned fRawR3 = ~0U;
816	unsigned fPATM = ~0U;
817	unsigned fCSAM = ~0U;
818	unsigned fHWVirt = ~0U;
819	uint32_t u32WarpDrive = 0;
820	#endif
821	#ifdef VBOX_WIN32_UI
822	bool fWin32UI = true;
823	int64_t winId = 0;
824	#endif
825	bool fShowSDLConfig = false;
826	uint32_t fixedWidth = ~(uint32_t)0;
827	uint32_t fixedHeight = ~(uint32_t)0;
828	uint32_t fixedBPP = ~(uint32_t)0;
829	uint32_t uResizeWidth = ~(uint32_t)0;
830	uint32_t uResizeHeight = ~(uint32_t)0;
831
832	/* The damned GOTOs forces this to be up here - totally out of place. */
833	/*
834	* Host key handling.
835	*
836	* The golden rule is that host-key combinations should not be seen
837	* by the guest. For instance a CAD should not have any extra RCtrl down
838	* and RCtrl up around itself. Nor should a resume be followed by a Ctrl-P
839	* that could encourage applications to start printing.
840	*
841	* We must not confuse the hostkey processing into any release sequences
842	* either, the host key is supposed to be explicitly pressing one key.
843	*
844	* Quick state diagram:
845	*
846	* host key down alone
847	* (Normal) ---------------
848	* ^ ^ \|
849	* \| \| v host combination key down
850	* \| \| (Host key down) ----------------
851	* \| \| host key up v \| \|
852	* \| \|-------------- \| other key down v host combination key down
853	* \| \| (host key used) -------------
854	* \| \| \| ^ \|
855	* \| (not host key)-- \| \|---------------
856	* \| \| \| \| \|
857	* \| \| ---- other \|
858	* \| modifiers = 0 v v
859	* -----------------------------------------------
860	*/
861	enum HKEYSTATE
862	{
863	/** The initial and most common state, pass keystrokes to the guest.
864	* Next state: HKEYSTATE_DOWN
865	* Prev state: Any */
866	HKEYSTATE_NORMAL = 1,
867	/** The first host key was pressed down
868	*/
869	HKEYSTATE_DOWN_1ST,
870	/** The second host key was pressed down (if gHostKeySym2 != SDLK_UNKNOWN)
871	*/
872	HKEYSTATE_DOWN_2ND,
873	/** The host key has been pressed down.
874	* Prev state: HKEYSTATE_NORMAL
875	* Next state: HKEYSTATE_NORMAL - host key up, capture toggle.
876	* Next state: HKEYSTATE_USED - host key combination down.
877	* Next state: HKEYSTATE_NOT_IT - non-host key combination down.
878	*/
879	HKEYSTATE_DOWN,
880	/** A host key combination was pressed.
881	* Prev state: HKEYSTATE_DOWN
882	* Next state: HKEYSTATE_NORMAL - when modifiers are all 0
883	*/
884	HKEYSTATE_USED,
885	/** A non-host key combination was attempted. Send hostkey down to the
886	* guest and continue until all modifiers have been released.
887	* Prev state: HKEYSTATE_DOWN
888	* Next state: HKEYSTATE_NORMAL - when modifiers are all 0
889	*/
890	HKEYSTATE_NOT_IT
891	} enmHKeyState = HKEYSTATE_NORMAL;
892	/** The host key down event which we have been hiding from the guest.
893	* Used when going from HKEYSTATE_DOWN to HKEYSTATE_NOT_IT. */
894	SDL_Event EvHKeyDown1;
895	SDL_Event EvHKeyDown2;
896
897	LogFlow(("SDL GUI started\n"));
898	RTPrintf(VBOX_PRODUCT " SDL GUI version %s\n"
899	"(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
900	"All rights reserved.\n\n",
901	VBOX_VERSION_STRING);
902
903	// less than one parameter is not possible
904	if (argc < 2)
905	{
906	show_usage();
907	return 1;
908	}
909
910	// command line argument parsing stuff
911	for (int curArg = 1; curArg < argc; curArg++)
912	{
913	if ( !strcmp(argv[curArg], "--vm")
914	\|\| !strcmp(argv[curArg], "-vm")
915	\|\| !strcmp(argv[curArg], "--startvm")
916	\|\| !strcmp(argv[curArg], "-startvm")
917	\|\| !strcmp(argv[curArg], "-s")
918	)
919	{
920	if (++curArg >= argc)
921	{
922	RTPrintf("Error: VM not specified (UUID or name)!\n");
923	return 1;
924	}
925	// first check if a UUID was supplied
926	if (RT_FAILURE(RTUuidFromStr(uuidVM.ptr(), argv[curArg])))
927	{
928	LogFlow(("invalid UUID format, assuming it's a VM name\n"));
929	vmName = argv[curArg];
930	}
931	}
932	else if ( !strcmp(argv[curArg], "--comment")
933	\|\| !strcmp(argv[curArg], "-comment"))
934	{
935	if (++curArg >= argc)
936	{
937	RTPrintf("Error: missing argument for comment!\n");
938	return 1;
939	}
940	}
941	else if ( !strcmp(argv[curArg], "--boot")
942	\|\| !strcmp(argv[curArg], "-boot"))
943	{
944	if (++curArg >= argc)
945	{
946	RTPrintf("Error: missing argument for boot drive!\n");
947	return 1;
948	}
949	switch (argv[curArg][0])
950	{
951	case 'a':
952	{
953	bootDevice = DeviceType_Floppy;
954	break;
955	}
956
957	case 'c':
958	{
959	bootDevice = DeviceType_HardDisk;
960	break;
961	}
962
963	case 'd':
964	{
965	bootDevice = DeviceType_DVD;
966	break;
967	}
968
969	case 'n':
970	{
971	bootDevice = DeviceType_Network;
972	break;
973	}
974
975	default:
976	{
977	RTPrintf("Error: wrong argument for boot drive!\n");
978	return 1;
979	}
980	}
981	}
982	else if ( !strcmp(argv[curArg], "--memory")
983	\|\| !strcmp(argv[curArg], "-memory")
984	\|\| !strcmp(argv[curArg], "-m"))
985	{
986	if (++curArg >= argc)
987	{
988	RTPrintf("Error: missing argument for memory size!\n");
989	return 1;
990	}
991	memorySize = atoi(argv[curArg]);
992	}
993	else if ( !strcmp(argv[curArg], "--vram")
994	\|\| !strcmp(argv[curArg], "-vram"))
995	{
996	if (++curArg >= argc)
997	{
998	RTPrintf("Error: missing argument for vram size!\n");
999	return 1;
1000	}
1001	vramSize = atoi(argv[curArg]);
1002	}
1003	else if ( !strcmp(argv[curArg], "--fullscreen")
1004	\|\| !strcmp(argv[curArg], "-fullscreen"))
1005	{
1006	fFullscreen = true;
1007	}
1008	else if ( !strcmp(argv[curArg], "--fullscreenresize")
1009	\|\| !strcmp(argv[curArg], "-fullscreenresize"))
1010	{
1011	gfFullscreenResize = true;
1012	#ifdef VBOXSDL_WITH_X11
1013	RTEnvSet("SDL_VIDEO_X11_VIDMODE", "0");
1014	#endif
1015	}
1016	else if ( !strcmp(argv[curArg], "--fixedmode")
1017	\|\| !strcmp(argv[curArg], "-fixedmode"))
1018	{
1019	/* three parameters follow */
1020	if (curArg + 3 >= argc)
1021	{
1022	RTPrintf("Error: missing arguments for fixed video mode!\n");
1023	return 1;
1024	}
1025	fixedWidth = atoi(argv[++curArg]);
1026	fixedHeight = atoi(argv[++curArg]);
1027	fixedBPP = atoi(argv[++curArg]);
1028	}
1029	else if ( !strcmp(argv[curArg], "--nofstoggle")
1030	\|\| !strcmp(argv[curArg], "-nofstoggle"))
1031	{
1032	gfAllowFullscreenToggle = FALSE;
1033	}
1034	else if ( !strcmp(argv[curArg], "--noresize")
1035	\|\| !strcmp(argv[curArg], "-noresize"))
1036	{
1037	fResizable = false;
1038	}
1039	else if ( !strcmp(argv[curArg], "--nohostkey")
1040	\|\| !strcmp(argv[curArg], "-nohostkey"))
1041	{
1042	gHostKeyMod = 0;
1043	gHostKeySym1 = 0;
1044	}
1045	else if ( !strcmp(argv[curArg], "--nohostkeys")
1046	\|\| !strcmp(argv[curArg], "-nohostkeys"))
1047	{
1048	if (++curArg >= argc)
1049	{
1050	RTPrintf("Error: missing a string of disabled hostkey combinations\n");
1051	return 1;
1052	}
1053	gHostKeyDisabledCombinations = argv[curArg];
1054	size_t cch = strlen(gHostKeyDisabledCombinations);
1055	for (size_t i = 0; i < cch; i++)
1056	{
1057	if (!strchr("fhnpqrs", gHostKeyDisabledCombinations[i]))
1058	{
1059	RTPrintf("Error: <hostkey> + '%c' is not a valid combination\n",
1060	gHostKeyDisabledCombinations[i]);
1061	return 1;
1062	}
1063	}
1064	}
1065	else if ( !strcmp(argv[curArg], "--nograbonclick")
1066	\|\| !strcmp(argv[curArg], "-nograbonclick"))
1067	{
1068	gfGrabOnMouseClick = FALSE;
1069	}
1070	else if ( !strcmp(argv[curArg], "--termacpi")
1071	\|\| !strcmp(argv[curArg], "-termacpi"))
1072	{
1073	gfACPITerm = TRUE;
1074	}
1075	else if ( !strcmp(argv[curArg], "--pidfile")
1076	\|\| !strcmp(argv[curArg], "-pidfile"))
1077	{
1078	if (++curArg >= argc)
1079	{
1080	RTPrintf("Error: missing file name for --pidfile!\n");
1081	return 1;
1082	}
1083	gpszPidFile = argv[curArg];
1084	}
1085	else if ( !strcmp(argv[curArg], "--hda")
1086	\|\| !strcmp(argv[curArg], "-hda"))
1087	{
1088	if (++curArg >= argc)
1089	{
1090	RTPrintf("Error: missing file name for first hard disk!\n");
1091	return 1;
1092	}
1093	/* resolve it. */
1094	if (RTPathExists(argv[curArg]))
1095	hdaFile = RTPathRealDup(argv[curArg]);
1096	if (!hdaFile)
1097	{
1098	RTPrintf("Error: The path to the specified harddisk, '%s', could not be resolved.\n", argv[curArg]);
1099	return 1;
1100	}
1101	}
1102	else if ( !strcmp(argv[curArg], "--fda")
1103	\|\| !strcmp(argv[curArg], "-fda"))
1104	{
1105	if (++curArg >= argc)
1106	{
1107	RTPrintf("Error: missing file/device name for first floppy disk!\n");
1108	return 1;
1109	}
1110	/* resolve it. */
1111	if (RTPathExists(argv[curArg]))
1112	fdaFile = RTPathRealDup(argv[curArg]);
1113	if (!fdaFile)
1114	{
1115	RTPrintf("Error: The path to the specified floppy disk, '%s', could not be resolved.\n", argv[curArg]);
1116	return 1;
1117	}
1118	}
1119	else if ( !strcmp(argv[curArg], "--cdrom")
1120	\|\| !strcmp(argv[curArg], "-cdrom"))
1121	{
1122	if (++curArg >= argc)
1123	{
1124	RTPrintf("Error: missing file/device name for cdrom!\n");
1125	return 1;
1126	}
1127	/* resolve it. */
1128	if (RTPathExists(argv[curArg]))
1129	cdromFile = RTPathRealDup(argv[curArg]);
1130	if (!cdromFile)
1131	{
1132	RTPrintf("Error: The path to the specified cdrom, '%s', could not be resolved.\n", argv[curArg]);
1133	return 1;
1134	}
1135	}
1136	#ifdef VBOX_WITH_VRDP
1137	else if ( !strcmp(argv[curArg], "--vrdp")
1138	\|\| !strcmp(argv[curArg], "-vrdp"))
1139	{
1140	// start with the standard VRDP port
1141	portVRDP = "0";
1142
1143	// is there another argument
1144	if (argc > (curArg + 1))
1145	{
1146	curArg++;
1147	portVRDP = argv[curArg];
1148	LogFlow(("Using non standard VRDP port %s\n", portVRDP));
1149	}
1150	}
1151	#endif /* VBOX_WITH_VRDP */
1152	else if ( !strcmp(argv[curArg], "--discardstate")
1153	\|\| !strcmp(argv[curArg], "-discardstate"))
1154	{
1155	fDiscardState = true;
1156	}
1157	#ifdef VBOX_SECURELABEL
1158	else if ( !strcmp(argv[curArg], "--securelabel")
1159	\|\| !strcmp(argv[curArg], "-securelabel"))
1160	{
1161	fSecureLabel = true;
1162	LogFlow(("Secure labelling turned on\n"));
1163	}
1164	else if ( !strcmp(argv[curArg], "--seclabelfnt")
1165	\|\| !strcmp(argv[curArg], "-seclabelfnt"))
1166	{
1167	if (++curArg >= argc)
1168	{
1169	RTPrintf("Error: missing font file name for secure label!\n");
1170	return 1;
1171	}
1172	secureLabelFontFile = argv[curArg];
1173	}
1174	else if ( !strcmp(argv[curArg], "--seclabelsiz")
1175	\|\| !strcmp(argv[curArg], "-seclabelsiz"))
1176	{
1177	if (++curArg >= argc)
1178	{
1179	RTPrintf("Error: missing font point size for secure label!\n");
1180	return 1;
1181	}
1182	secureLabelPointSize = atoi(argv[curArg]);
1183	}
1184	else if ( !strcmp(argv[curArg], "--seclabelofs")
1185	\|\| !strcmp(argv[curArg], "-seclabelofs"))
1186	{
1187	if (++curArg >= argc)
1188	{
1189	RTPrintf("Error: missing font pixel offset for secure label!\n");
1190	return 1;
1191	}
1192	secureLabelFontOffs = atoi(argv[curArg]);
1193	}
1194	else if ( !strcmp(argv[curArg], "--seclabelfgcol")
1195	\|\| !strcmp(argv[curArg], "-seclabelfgcol"))
1196	{
1197	if (++curArg >= argc)
1198	{
1199	RTPrintf("Error: missing text color value for secure label!\n");
1200	return 1;
1201	}
1202	sscanf(argv[curArg], "%X", &secureLabelColorFG);
1203	}
1204	else if ( !strcmp(argv[curArg], "--seclabelbgcol")
1205	\|\| !strcmp(argv[curArg], "-seclabelbgcol"))
1206	{
1207	if (++curArg >= argc)
1208	{
1209	RTPrintf("Error: missing background color value for secure label!\n");
1210	return 1;
1211	}
1212	sscanf(argv[curArg], "%X", &secureLabelColorBG);
1213	}
1214	#endif
1215	#ifdef VBOXSDL_ADVANCED_OPTIONS
1216	else if ( !strcmp(argv[curArg], "--rawr0")
1217	\|\| !strcmp(argv[curArg], "-rawr0"))
1218	fRawR0 = true;
1219	else if ( !strcmp(argv[curArg], "--norawr0")
1220	\|\| !strcmp(argv[curArg], "-norawr0"))
1221	fRawR0 = false;
1222	else if ( !strcmp(argv[curArg], "--rawr3")
1223	\|\| !strcmp(argv[curArg], "-rawr3"))
1224	fRawR3 = true;
1225	else if ( !strcmp(argv[curArg], "--norawr3")
1226	\|\| !strcmp(argv[curArg], "-norawr3"))
1227	fRawR3 = false;
1228	else if ( !strcmp(argv[curArg], "--patm")
1229	\|\| !strcmp(argv[curArg], "-patm"))
1230	fPATM = true;
1231	else if ( !strcmp(argv[curArg], "--nopatm")
1232	\|\| !strcmp(argv[curArg], "-nopatm"))
1233	fPATM = false;
1234	else if ( !strcmp(argv[curArg], "--csam")
1235	\|\| !strcmp(argv[curArg], "-csam"))
1236	fCSAM = true;
1237	else if ( !strcmp(argv[curArg], "--nocsam")
1238	\|\| !strcmp(argv[curArg], "-nocsam"))
1239	fCSAM = false;
1240	else if ( !strcmp(argv[curArg], "--hwvirtex")
1241	\|\| !strcmp(argv[curArg], "-hwvirtex"))
1242	fHWVirt = true;
1243	else if ( !strcmp(argv[curArg], "--nohwvirtex")
1244	\|\| !strcmp(argv[curArg], "-nohwvirtex"))
1245	fHWVirt = false;
1246	else if ( !strcmp(argv[curArg], "--warpdrive")
1247	\|\| !strcmp(argv[curArg], "-warpdrive"))
1248	{
1249	if (++curArg >= argc)
1250	{
1251	RTPrintf("Error: missing the rate value for the --warpdrive option!\n");
1252	return 1;
1253	}
1254	u32WarpDrive = RTStrToUInt32(argv[curArg]);
1255	if (u32WarpDrive < 2 \|\| u32WarpDrive > 20000)
1256	{
1257	RTPrintf("Error: the warp drive rate is restricted to [2..20000]. (%d)\n", u32WarpDrive);
1258	return 1;
1259	}
1260	}
1261	#endif /* VBOXSDL_ADVANCED_OPTIONS */
1262	#ifdef VBOX_WIN32_UI
1263	else if ( !strcmp(argv[curArg], "--win32ui")
1264	\|\| !strcmp(argv[curArg], "-win32ui"))
1265	fWin32UI = true;
1266	#endif
1267	else if ( !strcmp(argv[curArg], "--showsdlconfig")
1268	\|\| !strcmp(argv[curArg], "-showsdlconfig"))
1269	fShowSDLConfig = true;
1270	else if ( !strcmp(argv[curArg], "--hostkey")
1271	\|\| !strcmp(argv[curArg], "-hostkey"))
1272	{
1273	if (++curArg + 1 >= argc)
1274	{
1275	RTPrintf("Error: not enough arguments for host keys!\n");
1276	return 1;
1277	}
1278	gHostKeySym1 = atoi(argv[curArg++]);
1279	if (curArg + 1 < argc && (argv[curArg+1][0] == '0' \|\| atoi(argv[curArg+1]) > 0))
1280	{
1281	/* two-key sequence as host key specified */
1282	gHostKeySym2 = atoi(argv[curArg++]);
1283	}
1284	gHostKeyMod = atoi(argv[curArg]);
1285	}
1286	/* just show the help screen */
1287	else
1288	{
1289	if ( strcmp(argv[curArg], "-h")
1290	&& strcmp(argv[curArg], "-help")
1291	&& strcmp(argv[curArg], "--help"))
1292	RTPrintf("Error: unrecognized switch '%s'\n", argv[curArg]);
1293	show_usage();
1294	return 1;
1295	}
1296	}
1297
1298	rc = com::Initialize();
1299	if (FAILED(rc))
1300	{
1301	RTPrintf("Error: COM initialization failed, rc = 0x%x!\n", rc);
1302	return 1;
1303	}
1304
1305	/* NOTE: do not convert the following scope to a "do {} while (0);", as
1306	* this would make it all too tempting to use "break;" incorrectly - it
1307	* would skip over the cleanup. */
1308	{
1309	// scopes all the stuff till shutdown
1310	////////////////////////////////////////////////////////////////////////////
1311
1312	ComPtr <IVirtualBox> virtualBox;
1313	ComPtr <ISession> session;
1314	bool sessionOpened = false;
1315	EventQueue* eventQ = com::EventQueue::getMainEventQueue();
1316	const CLSID sessionID = CLSID_Session;
1317
1318	ComPtr<IMachine> pMachine;
1319
1320	rc = virtualBox.createLocalObject(CLSID_VirtualBox);
1321	if (FAILED(rc))
1322	{
1323	com::ErrorInfo info;
1324	if (info.isFullAvailable())
1325	PrintError("Failed to create VirtualBox object",
1326	info.getText().raw(), info.getComponent().raw());
1327	else
1328	RTPrintf("Failed to create VirtualBox object! No error information available (rc = 0x%x).\n", rc);
1329	goto leave;
1330	}
1331	rc = session.createInprocObject(sessionID);
1332	if (FAILED(rc))
1333	{
1334	RTPrintf("Failed to create session object, rc = 0x%x!\n", rc);
1335	goto leave;
1336	}
1337
1338	/*
1339	* Do we have a name but no UUID?
1340	*/
1341	if (vmName && uuidVM.isEmpty())
1342	{
1343	Bstr bstrVMName = vmName;
1344	rc = virtualBox->FindMachine(bstrVMName.raw(), pMachine.asOutParam());
1345	if ((rc == S_OK) && pMachine)
1346	{
1347	Bstr id;
1348	pMachine->COMGETTER(Id)(id.asOutParam());
1349	uuidVM = Guid(id);
1350	}
1351	else
1352	{
1353	RTPrintf("Error: machine with the given ID not found!\n");
1354	goto leave;
1355	}
1356	}
1357	else if (uuidVM.isEmpty())
1358	{
1359	RTPrintf("Error: no machine specified!\n");
1360	goto leave;
1361	}
1362
1363	/* create SDL event semaphore */
1364	vrc = RTSemEventCreate(&g_EventSemSDLEvents);
1365	AssertReleaseRC(vrc);
1366
1367	rc = pMachine->LockMachine(session, LockType_Write);
1368	if (FAILED(rc))
1369	{
1370	com::ErrorInfo info;
1371	if (info.isFullAvailable())
1372	PrintError("Could not open VirtualBox session",
1373	info.getText().raw(), info.getComponent().raw());
1374	goto leave;
1375	}
1376	if (!session)
1377	{
1378	RTPrintf("Could not open VirtualBox session!\n");
1379	goto leave;
1380	}
1381	sessionOpened = true;
1382	// get the mutable VM we're dealing with
1383	session->COMGETTER(Machine)(gMachine.asOutParam());
1384	if (!gMachine)
1385	{
1386	com::ErrorInfo info;
1387	if (info.isFullAvailable())
1388	PrintError("Cannot start VM!",
1389	info.getText().raw(), info.getComponent().raw());
1390	else
1391	RTPrintf("Error: given machine not found!\n");
1392	goto leave;
1393	}
1394	// get the VM console
1395	session->COMGETTER(Console)(gConsole.asOutParam());
1396	if (!gConsole)
1397	{
1398	RTPrintf("Given console not found!\n");
1399	goto leave;
1400	}
1401
1402	/*
1403	* Are we supposed to use a different hard disk file?
1404	*/
1405	if (hdaFile)
1406	{
1407	/*
1408	* Strategy: iterate through all registered hard disk
1409	* and see if one of them points to the same file. If
1410	* so, assign it. If not, register a new image and assign
1411	* it to the VM.
1412	*/
1413	Bstr hdaFileBstr = hdaFile;
1414	ComPtr<IMedium> hardDisk;
1415	virtualBox->FindMedium(hdaFileBstr.raw(), DeviceType_HardDisk,
1416	hardDisk.asOutParam());
1417	if (!hardDisk)
1418	{
1419	/* we've not found the image */
1420	RTPrintf("Adding hard disk '%S'...\n", hdaFile);
1421	virtualBox->OpenMedium(hdaFileBstr.raw(), DeviceType_HardDisk,
1422	AccessMode_ReadWrite, hardDisk.asOutParam());
1423	}
1424	/* do we have the right image now? */
1425	if (hardDisk)
1426	{
1427	/*
1428	* Go and attach it!
1429	*/
1430	Bstr storageCtlName;
1431
1432	/* get the first IDE controller to attach the harddisk to
1433	* and if there is none, add one temporarily
1434	*/
1435	{
1436	ComPtr<IStorageController> storageCtl;
1437	com::SafeIfaceArray<IStorageController> aStorageControllers;
1438	CHECK_ERROR(gMachine, COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(aStorageControllers)));
1439	for (size_t i = 0; i < aStorageControllers.size(); ++ i)
1440	{
1441	StorageBus_T storageBus = StorageBus_Null;
1442
1443	CHECK_ERROR(aStorageControllers[i], COMGETTER(Bus)(&storageBus));
1444	if (storageBus == StorageBus_IDE)
1445	{
1446	storageCtl = aStorageControllers[i];
1447	break;
1448	}
1449	}
1450
1451	if (storageCtl)
1452	{
1453	CHECK_ERROR(storageCtl, COMGETTER(Name)(storageCtlName.asOutParam()));
1454	gMachine->DetachDevice(storageCtlName.raw(), 0, 0);
1455	}
1456	else
1457	{
1458	storageCtlName = "IDE Controller";
1459	CHECK_ERROR(gMachine, AddStorageController(storageCtlName.raw(),
1460	StorageBus_IDE,
1461	storageCtl.asOutParam()));
1462	}
1463	}
1464
1465	gMachine->AttachDevice(storageCtlName.raw(), 0, 0,
1466	DeviceType_HardDisk, hardDisk);
1467	/// @todo why is this attachment saved?
1468	}
1469	else
1470	{
1471	RTPrintf("Error: failed to mount the specified hard disk image!\n");
1472	goto leave;
1473	}
1474	}
1475
1476	/*
1477	* Mount a floppy if requested.
1478	*/
1479	if (fdaFile)
1480	do
1481	{
1482	ComPtr<IMedium> floppyMedium;
1483
1484	/* unmount? */
1485	if (!strcmp(fdaFile, "none"))
1486	{
1487	/* nothing to do, NULL object will cause unmount */
1488	}
1489	else
1490	{
1491	Bstr medium = fdaFile;
1492
1493	/* Assume it's a host drive name */
1494	ComPtr <IHost> host;
1495	CHECK_ERROR_BREAK(virtualBox, COMGETTER(Host)(host.asOutParam()));
1496	rc = host->FindHostFloppyDrive(medium.raw(),
1497	floppyMedium.asOutParam());
1498	if (FAILED(rc))
1499	{
1500	/* try to find an existing one */
1501	rc = virtualBox->FindMedium(medium.raw(), DeviceType_Floppy,
1502	floppyMedium.asOutParam());
1503	if (FAILED(rc))
1504	{
1505	/* try to add to the list */
1506	RTPrintf("Adding floppy image '%S'...\n", fdaFile);
1507	CHECK_ERROR_BREAK(virtualBox,
1508	OpenMedium(medium.raw(),
1509	DeviceType_Floppy,
1510	AccessMode_ReadWrite,
1511	floppyMedium.asOutParam()));
1512	}
1513	}
1514	}
1515
1516	Bstr id;
1517	Bstr storageCtlName;
1518	floppyMedium->COMGETTER(Id)(id.asOutParam());
1519
1520	/* get the first floppy controller to attach the floppy to
1521	* and if there is none, add one temporarily
1522	*/
1523	{
1524	ComPtr<IStorageController> storageCtl;
1525	com::SafeIfaceArray<IStorageController> aStorageControllers;
1526	CHECK_ERROR(gMachine, COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(aStorageControllers)));
1527	for (size_t i = 0; i < aStorageControllers.size(); ++ i)
1528	{
1529	StorageBus_T storageBus = StorageBus_Null;
1530
1531	CHECK_ERROR(aStorageControllers[i], COMGETTER(Bus)(&storageBus));
1532	if (storageBus == StorageBus_Floppy)
1533	{
1534	storageCtl = aStorageControllers[i];
1535	break;
1536	}
1537	}
1538
1539	if (storageCtl)
1540	{
1541	ComPtr<IMediumAttachment> floppyAttachment;
1542
1543	CHECK_ERROR(storageCtl, COMGETTER(Name)(storageCtlName.asOutParam()));
1544	rc = gMachine->GetMediumAttachment(storageCtlName.raw(), 0, 0,
1545	floppyAttachment.asOutParam());
1546	if (FAILED(rc))
1547	CHECK_ERROR(gMachine, AttachDevice(storageCtlName.raw(), 0, 0,
1548	DeviceType_Floppy, NULL));
1549	}
1550	else
1551	{
1552	storageCtlName = "Floppy Controller";
1553	CHECK_ERROR(gMachine, AddStorageController(storageCtlName.raw(),
1554	StorageBus_Floppy,
1555	storageCtl.asOutParam()));
1556	CHECK_ERROR(gMachine, AttachDevice(storageCtlName.raw(), 0, 0,
1557	DeviceType_Floppy, NULL));
1558	}
1559	}
1560
1561	CHECK_ERROR(gMachine, MountMedium(storageCtlName.raw(), 0, 0, id.raw(),
1562	FALSE /* aForce */));
1563	}
1564	while (0);
1565	if (FAILED(rc))
1566	goto leave;
1567
1568	/*
1569	* Mount a CD-ROM if requested.
1570	*/
1571	if (cdromFile)
1572	do
1573	{
1574	ComPtr<IMedium> dvdMedium;
1575
1576	/* unmount? */
1577	if (!strcmp(cdromFile, "none"))
1578	{
1579	/* nothing to do, NULL object will cause unmount */
1580	}
1581	else
1582	{
1583	Bstr medium = cdromFile;
1584
1585	/* Assume it's a host drive name */
1586	ComPtr <IHost> host;
1587	CHECK_ERROR_BREAK(virtualBox, COMGETTER(Host)(host.asOutParam()));
1588	rc = host->FindHostDVDDrive(medium.raw(), dvdMedium.asOutParam());
1589	if (FAILED(rc))
1590	{
1591	/* try to find an existing one */
1592	rc = virtualBox->FindMedium(medium.raw(), DeviceType_DVD,
1593	dvdMedium.asOutParam());
1594	if (FAILED(rc))
1595	{
1596	/* try to add to the list */
1597	RTPrintf("Adding ISO image '%S'...\n", cdromFile);
1598	CHECK_ERROR_BREAK(virtualBox, OpenMedium(medium.raw(),
1599	DeviceType_DVD,
1600	AccessMode_ReadWrite,
1601	dvdMedium.asOutParam()));
1602	}
1603	}
1604	}
1605
1606	Bstr id;
1607	Bstr storageCtlName;
1608	dvdMedium->COMGETTER(Id)(id.asOutParam());
1609
1610	/* get the first IDE controller to attach the DVD Drive to
1611	* and if there is none, add one temporarily
1612	*/
1613	{
1614	ComPtr<IStorageController> storageCtl;
1615	com::SafeIfaceArray<IStorageController> aStorageControllers;
1616	CHECK_ERROR(gMachine, COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(aStorageControllers)));
1617	for (size_t i = 0; i < aStorageControllers.size(); ++ i)
1618	{
1619	StorageBus_T storageBus = StorageBus_Null;
1620
1621	CHECK_ERROR(aStorageControllers[i], COMGETTER(Bus)(&storageBus));
1622	if (storageBus == StorageBus_IDE)
1623	{
1624	storageCtl = aStorageControllers[i];
1625	break;
1626	}
1627	}
1628
1629	if (storageCtl)
1630	{
1631	ComPtr<IMediumAttachment> dvdAttachment;
1632
1633	CHECK_ERROR(storageCtl, COMGETTER(Name)(storageCtlName.asOutParam()));
1634	gMachine->DetachDevice(storageCtlName.raw(), 1, 0);
1635	CHECK_ERROR(gMachine, AttachDevice(storageCtlName.raw(), 1, 0,
1636	DeviceType_DVD, NULL));
1637	}
1638	else
1639	{
1640	storageCtlName = "IDE Controller";
1641	CHECK_ERROR(gMachine, AddStorageController(storageCtlName.raw(),
1642	StorageBus_IDE,
1643	storageCtl.asOutParam()));
1644	CHECK_ERROR(gMachine, AttachDevice(storageCtlName.raw(), 1, 0,
1645	DeviceType_DVD, NULL));
1646	}
1647	}
1648
1649	CHECK_ERROR(gMachine, MountMedium(storageCtlName.raw(), 1, 0, id.raw(),
1650	FALSE /aForce /));
1651	}
1652	while (0);
1653	if (FAILED(rc))
1654	goto leave;
1655
1656	if (fDiscardState)
1657	{
1658	/*
1659	* If the machine is currently saved,
1660	* discard the saved state first.
1661	*/
1662	MachineState_T machineState;
1663	gMachine->COMGETTER(State)(&machineState);
1664	if (machineState == MachineState_Saved)
1665	{
1666	CHECK_ERROR(gConsole, DiscardSavedState(true /* fDeleteFile */));
1667	}
1668	/*
1669	* If there are snapshots, discard the current state,
1670	* i.e. revert to the last snapshot.
1671	*/
1672	ULONG cSnapshots;
1673	gMachine->COMGETTER(SnapshotCount)(&cSnapshots);
1674	if (cSnapshots)
1675	{
1676	gProgress = NULL;
1677
1678	ComPtr<ISnapshot> pCurrentSnapshot;
1679	CHECK_ERROR(gMachine, COMGETTER(CurrentSnapshot)(pCurrentSnapshot.asOutParam()));
1680	if (FAILED(rc))
1681	goto leave;
1682
1683	CHECK_ERROR(gConsole, RestoreSnapshot(pCurrentSnapshot, gProgress.asOutParam()));
1684	rc = gProgress->WaitForCompletion(-1);
1685	}
1686	}
1687
1688	// get the machine debugger (does not have to be there)
1689	gConsole->COMGETTER(Debugger)(gMachineDebugger.asOutParam());
1690	if (gMachineDebugger)
1691	{
1692	Log(("Machine debugger available!\n"));
1693	}
1694	gConsole->COMGETTER(Display)(gDisplay.asOutParam());
1695	if (!gDisplay)
1696	{
1697	RTPrintf("Error: could not get display object!\n");
1698	goto leave;
1699	}
1700
1701	// set the boot drive
1702	if (bootDevice != DeviceType_Null)
1703	{
1704	rc = gMachine->SetBootOrder(1, bootDevice);
1705	if (rc != S_OK)
1706	{
1707	RTPrintf("Error: could not set boot device, using default.\n");
1708	}
1709	}
1710
1711	// set the memory size if not default
1712	if (memorySize)
1713	{
1714	rc = gMachine->COMSETTER(MemorySize)(memorySize);
1715	if (rc != S_OK)
1716	{
1717	ULONG ramSize = 0;
1718	gMachine->COMGETTER(MemorySize)(&ramSize);
1719	RTPrintf("Error: could not set memory size, using current setting of %d MBytes\n", ramSize);
1720	}
1721	}
1722
1723	if (vramSize)
1724	{
1725	rc = gMachine->COMSETTER(VRAMSize)(vramSize);
1726	if (rc != S_OK)
1727	{
1728	gMachine->COMGETTER(VRAMSize)((ULONG*)&vramSize);
1729	RTPrintf("Error: could not set VRAM size, using current setting of %d MBytes\n", vramSize);
1730	}
1731	}
1732
1733	// we're always able to process absolute mouse events and we prefer that
1734	gfAbsoluteMouseHost = TRUE;
1735
1736	#ifdef VBOX_WIN32_UI
1737	if (fWin32UI)
1738	{
1739	/* initialize the Win32 user interface inside which SDL will be embedded */
1740	if (initUI(fResizable, winId))
1741	return 1;
1742	}
1743	#endif
1744
1745	/* static initialization of the SDL stuff */
1746	if (!VBoxSDLFB::init(fShowSDLConfig))
1747	goto leave;
1748
1749	gMachine->COMGETTER(MonitorCount)(&gcMonitors);
1750	if (gcMonitors > 64)
1751	gcMonitors = 64;
1752
1753	for (unsigned i = 0; i < gcMonitors; i++)
1754	{
1755	// create our SDL framebuffer instance
1756	gpFramebuffer[i] = new VBoxSDLFB(i, fFullscreen, fResizable, fShowSDLConfig, false,
1757	fixedWidth, fixedHeight, fixedBPP);
1758
1759	if (!gpFramebuffer[i])
1760	{
1761	RTPrintf("Error: could not create framebuffer object!\n");
1762	goto leave;
1763	}
1764	}
1765
1766	#ifdef VBOX_WIN32_UI
1767	gpFramebuffer[0]->setWinId(winId);
1768	#endif
1769
1770	for (unsigned i = 0; i < gcMonitors; i++)
1771	{
1772	if (!gpFramebuffer[i]->initialized())
1773	goto leave;
1774	gpFramebuffer[i]->AddRef();
1775	if (fFullscreen)
1776	SetFullscreen(true);
1777	}
1778
1779	#ifdef VBOX_SECURELABEL
1780	if (fSecureLabel)
1781	{
1782	if (!secureLabelFontFile)
1783	{
1784	RTPrintf("Error: no font file specified for secure label!\n");
1785	goto leave;
1786	}
1787	/* load the SDL_ttf library and get the required imports */
1788	vrc = RTLdrLoad(LIBSDL_TTF_NAME, &gLibrarySDL_ttf);
1789	if (RT_SUCCESS(vrc))
1790	vrc = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_Init", (void**)&pTTF_Init);
1791	if (RT_SUCCESS(vrc))
1792	vrc = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_OpenFont", (void**)&pTTF_OpenFont);
1793	if (RT_SUCCESS(vrc))
1794	vrc = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_RenderUTF8_Solid", (void**)&pTTF_RenderUTF8_Solid);
1795	if (RT_SUCCESS(vrc))
1796	{
1797	/* silently ignore errors here */
1798	vrc = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_RenderUTF8_Blended", (void**)&pTTF_RenderUTF8_Blended);
1799	if (RT_FAILURE(vrc))
1800	pTTF_RenderUTF8_Blended = NULL;
1801	vrc = VINF_SUCCESS;
1802	}
1803	if (RT_SUCCESS(vrc))
1804	vrc = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_CloseFont", (void**)&pTTF_CloseFont);
1805	if (RT_SUCCESS(vrc))
1806	vrc = RTLdrGetSymbol(gLibrarySDL_ttf, "TTF_Quit", (void**)&pTTF_Quit);
1807	if (RT_SUCCESS(vrc))
1808	vrc = gpFramebuffer[0]->initSecureLabel(SECURE_LABEL_HEIGHT, secureLabelFontFile, secureLabelPointSize, secureLabelFontOffs);
1809	if (RT_FAILURE(vrc))
1810	{
1811	RTPrintf("Error: could not initialize secure labeling: rc = %Rrc\n", vrc);
1812	goto leave;
1813	}
1814	Bstr key = VBOXSDL_SECURELABEL_EXTRADATA;
1815	Bstr label;
1816	gMachine->GetExtraData(key.raw(), label.asOutParam());
1817	Utf8Str labelUtf8 = label;
1818	/*
1819	* Now update the label
1820	*/
1821	gpFramebuffer[0]->setSecureLabelColor(secureLabelColorFG, secureLabelColorBG);
1822	gpFramebuffer[0]->setSecureLabelText(labelUtf8.c_str());
1823	}
1824	#endif
1825
1826	#ifdef VBOXSDL_WITH_X11
1827	/* NOTE1: We still want Ctrl-C to work, so we undo the SDL redirections.
1828	* NOTE2: We have to remove the PidFile if this file exists. */
1829	signal(SIGINT, signal_handler_SIGINT);
1830	signal(SIGQUIT, signal_handler_SIGINT);
1831	signal(SIGSEGV, signal_handler_SIGINT);
1832	#endif
1833
1834
1835	for (ULONG i = 0; i < gcMonitors; i++)
1836	{
1837	// register our framebuffer
1838	rc = gDisplay->SetFramebuffer(i, gpFramebuffer[i]);
1839	if (FAILED(rc))
1840	{
1841	RTPrintf("Error: could not register framebuffer object!\n");
1842	goto leave;
1843	}
1844	IFramebuffer *dummyFb;
1845	LONG xOrigin, yOrigin;
1846	rc = gDisplay->GetFramebuffer(i, &dummyFb, &xOrigin, &yOrigin);
1847	gpFramebuffer[i]->setOrigin(xOrigin, yOrigin);
1848	}
1849
1850	{
1851	// register listener for global events
1852	ComPtr<IEventSource> es;
1853	CHECK_ERROR(virtualBox, COMGETTER(EventSource)(es.asOutParam()));
1854	vboxListener = new VBoxSDLEventListener();
1855	vboxListener->AddRef();
1856	com::SafeArray <VBoxEventType_T> eventTypes;
1857	eventTypes.push_back(VBoxEventType_OnExtraDataChanged);
1858	CHECK_ERROR(es, RegisterListener(vboxListener, ComSafeArrayAsInParam(eventTypes), true));
1859	}
1860
1861	{
1862	// register listener for machine events
1863	ComPtr<IEventSource> es;
1864	CHECK_ERROR(gConsole, COMGETTER(EventSource)(es.asOutParam()));
1865	consoleListener = new VBoxSDLConsoleEventListener();
1866	consoleListener->AddRef();
1867	com::SafeArray <VBoxEventType_T> eventTypes;
1868	eventTypes.push_back(VBoxEventType_OnMousePointerShapeChanged);
1869	eventTypes.push_back(VBoxEventType_OnMouseCapabilityChanged);
1870	eventTypes.push_back(VBoxEventType_OnKeyboardLedsChanged);
1871	eventTypes.push_back(VBoxEventType_OnStateChanged);
1872	eventTypes.push_back(VBoxEventType_OnRuntimeError);
1873	eventTypes.push_back(VBoxEventType_OnCanShowWindow);
1874	eventTypes.push_back(VBoxEventType_OnShowWindow);
1875	CHECK_ERROR(es, RegisterListener(consoleListener, ComSafeArrayAsInParam(eventTypes), true));
1876	// until we've tried to to start the VM, ignore power off events
1877	consoleListener->ignorePowerOffEvents(true);
1878	}
1879
1880	#ifdef VBOX_WITH_VRDP
1881	if (portVRDP)
1882	{
1883	rc = gMachine->COMGETTER(VRDPServer)(gVrdpServer.asOutParam());
1884	AssertMsg((rc == S_OK) && gVrdpServer, ("Could not get VRDP Server! rc = 0x%x\n", rc));
1885	if (gVrdpServer)
1886	{
1887	// has a non standard VRDP port been requested?
1888	if (portVRDP > 0)
1889	{
1890	Bstr bstr = portVRDP;
1891	rc = gVrdpServer->COMSETTER(Ports)(bstr.raw());
1892	if (rc != S_OK)
1893	{
1894	RTPrintf("Error: could not set VRDP port! rc = 0x%x\n", rc);
1895	goto leave;
1896	}
1897	}
1898	// now enable VRDP
1899	rc = gVrdpServer->COMSETTER(Enabled)(TRUE);
1900	if (rc != S_OK)
1901	{
1902	RTPrintf("Error: could not enable VRDP server! rc = 0x%x\n", rc);
1903	goto leave;
1904	}
1905	}
1906	}
1907	#endif
1908
1909	rc = E_FAIL;
1910	#ifdef VBOXSDL_ADVANCED_OPTIONS
1911	if (fRawR0 != ~0U)
1912	{
1913	if (!gMachineDebugger)
1914	{
1915	RTPrintf("Error: No debugger object; -%srawr0 cannot be executed!\n", fRawR0 ? "" : "no");
1916	goto leave;
1917	}
1918	gMachineDebugger->COMSETTER(RecompileSupervisor)(!fRawR0);
1919	}
1920	if (fRawR3 != ~0U)
1921	{
1922	if (!gMachineDebugger)
1923	{
1924	RTPrintf("Error: No debugger object; -%srawr3 cannot be executed!\n", fRawR0 ? "" : "no");
1925	goto leave;
1926	}
1927	gMachineDebugger->COMSETTER(RecompileUser)(!fRawR3);
1928	}
1929	if (fPATM != ~0U)
1930	{
1931	if (!gMachineDebugger)
1932	{
1933	RTPrintf("Error: No debugger object; -%spatm cannot be executed!\n", fRawR0 ? "" : "no");
1934	goto leave;
1935	}
1936	gMachineDebugger->COMSETTER(PATMEnabled)(fPATM);
1937	}
1938	if (fCSAM != ~0U)
1939	{
1940	if (!gMachineDebugger)
1941	{
1942	RTPrintf("Error: No debugger object; -%scsam cannot be executed!\n", fRawR0 ? "" : "no");
1943	goto leave;
1944	}
1945	gMachineDebugger->COMSETTER(CSAMEnabled)(fCSAM);
1946	}
1947	if (fHWVirt != ~0U)
1948	{
1949	gMachine->SetHWVirtExProperty(HWVirtExPropertyType_Enabled, fHWVirt);
1950	}
1951	if (u32WarpDrive != 0)
1952	{
1953	if (!gMachineDebugger)
1954	{
1955	RTPrintf("Error: No debugger object; --warpdrive %d cannot be executed!\n", u32WarpDrive);
1956	goto leave;
1957	}
1958	gMachineDebugger->COMSETTER(VirtualTimeRate)(u32WarpDrive);
1959	}
1960	#endif /* VBOXSDL_ADVANCED_OPTIONS */
1961
1962	/* start with something in the titlebar */
1963	UpdateTitlebar(TITLEBAR_NORMAL);
1964
1965	/* memorize the default cursor */
1966	gpDefaultCursor = SDL_GetCursor();
1967
1968	#if !defined(VBOX_WITH_SDL13)
1969	# if defined(VBOXSDL_WITH_X11)
1970	/* Get Window Manager info. We only need the X11 display. */
1971	SDL_VERSION(&gSdlInfo.version);
1972	if (!SDL_GetWMInfo(&gSdlInfo))
1973	RTPrintf("Error: could not get SDL Window Manager info -- no Xcursor support!\n");
1974	else
1975	gfXCursorEnabled = TRUE;
1976
1977	# if !defined(VBOX_WITHOUT_XCURSOR)
1978	/* SDL uses its own (plain) default cursor. Use the left arrow cursor instead which might look
1979	* much better if a mouse cursor theme is installed. */
1980	if (gfXCursorEnabled)
1981	{
1982	gpDefaultOrigX11Cursor = (Cursor)gpDefaultCursor->wm_cursor;
1983	(Cursor)gpDefaultCursor->wm_cursor = XCreateFontCursor(gSdlInfo.info.x11.display, XC_left_ptr);
1984	SDL_SetCursor(gpDefaultCursor);
1985	}
1986	# endif
1987	/* Initialise the keyboard */
1988	X11DRV_InitKeyboard(gSdlInfo.info.x11.display, NULL, NULL, NULL);
1989	# endif /* VBOXSDL_WITH_X11 */
1990
1991	/* create a fake empty cursor */
1992	{
1993	uint8_t cursorData[1] = {0};
1994	gpCustomCursor = SDL_CreateCursor(cursorData, cursorData, 8, 1, 0, 0);
1995	gpCustomOrigWMcursor = gpCustomCursor->wm_cursor;
1996	gpCustomCursor->wm_cursor = NULL;
1997	}
1998	#endif /* !VBOX_WITH_SDL13 */
1999
2000	/*
2001	* Register our user signal handler.
2002	*/
2003	#ifdef VBOXSDL_WITH_X11
2004	struct sigaction sa;
2005	sa.sa_sigaction = signal_handler_SIGUSR1;
2006	sigemptyset(&sa.sa_mask);
2007	sa.sa_flags = SA_RESTART \| SA_SIGINFO;
2008	sigaction(SIGUSR1, &sa, NULL);
2009	#endif /* VBOXSDL_WITH_X11 */
2010
2011	/*
2012	* Start the VM execution thread. This has to be done
2013	* asynchronously as powering up can take some time
2014	* (accessing devices such as the host DVD drive). In
2015	* the meantime, we have to service the SDL event loop.
2016	*/
2017	SDL_Event event;
2018
2019	LogFlow(("Powering up the VM...\n"));
2020	rc = gConsole->PowerUp(gProgress.asOutParam());
2021	if (rc != S_OK)
2022	{
2023	com::ErrorInfo info(gConsole, COM_IIDOF(IConsole));
2024	if (info.isBasicAvailable())
2025	PrintError("Failed to power up VM", info.getText().raw());
2026	else
2027	RTPrintf("Error: failed to power up VM! No error text available.\n");
2028	goto leave;
2029	}
2030
2031	#ifdef USE_XPCOM_QUEUE_THREAD
2032	/*
2033	* Before we starting to do stuff, we have to launch the XPCOM
2034	* event queue thread. It will wait for events and send messages
2035	* to the SDL thread. After having done this, we should fairly
2036	* quickly start to process the SDL event queue as an XPCOM
2037	* event storm might arrive. Stupid SDL has a ridiculously small
2038	* event queue buffer!
2039	*/
2040	startXPCOMEventQueueThread(eventQ->getSelectFD());
2041	#endif /* USE_XPCOM_QUEUE_THREAD */
2042
2043	/* termination flag */
2044	bool fTerminateDuringStartup;
2045	fTerminateDuringStartup = false;
2046
2047	LogRel(("VBoxSDL: NUM lock initially %s, CAPS lock initially %s\n",
2048	!!(SDL_GetModState() & KMOD_NUM) ? "ON" : "OFF",
2049	!!(SDL_GetModState() & KMOD_CAPS) ? "ON" : "OFF"));
2050
2051	/* start regular timer so we don't starve in the event loop */
2052	SDL_TimerID sdlTimer;
2053	sdlTimer = SDL_AddTimer(100, StartupTimer, NULL);
2054
2055	/* loop until the powerup processing is done */
2056	MachineState_T machineState;
2057	do
2058	{
2059	rc = gMachine->COMGETTER(State)(&machineState);
2060	if ( rc == S_OK
2061	&& ( machineState == MachineState_Starting
2062	\|\| machineState == MachineState_Restoring
2063	\|\| machineState == MachineState_TeleportingIn
2064	)
2065	)
2066	{
2067	/*
2068	* wait for the next event. This is uncritical as
2069	* power up guarantees to change the machine state
2070	* to either running or aborted and a machine state
2071	* change will send us an event. However, we have to
2072	* service the XPCOM event queue!
2073	*/
2074	#ifdef USE_XPCOM_QUEUE_THREAD
2075	if (!fXPCOMEventThreadSignaled)
2076	{
2077	signalXPCOMEventQueueThread();
2078	fXPCOMEventThreadSignaled = true;
2079	}
2080	#endif
2081	/*
2082	* Wait for SDL events.
2083	*/
2084	if (WaitSDLEvent(&event))
2085	{
2086	switch (event.type)
2087	{
2088	/*
2089	* Timer event. Used to have the titlebar updated.
2090	*/
2091	case SDL_USER_EVENT_TIMER:
2092	{
2093	/*
2094	* Update the title bar.
2095	*/
2096	UpdateTitlebar(TITLEBAR_STARTUP);
2097	break;
2098	}
2099
2100	/*
2101	* User specific resize event.
2102	*/
2103	case SDL_USER_EVENT_RESIZE:
2104	{
2105	LogFlow(("SDL_USER_EVENT_RESIZE\n"));
2106	IFramebuffer *dummyFb;
2107	LONG xOrigin, yOrigin;
2108	gpFramebuffer[event.user.code]->resizeGuest();
2109	/* update xOrigin, yOrigin -> mouse */
2110	rc = gDisplay->GetFramebuffer(event.user.code, &dummyFb, &xOrigin, &yOrigin);
2111	gpFramebuffer[event.user.code]->setOrigin(xOrigin, yOrigin);
2112	/* notify the display that the resize has been completed */
2113	gDisplay->ResizeCompleted(event.user.code);
2114	break;
2115	}
2116
2117	#ifdef USE_XPCOM_QUEUE_THREAD
2118	/*
2119	* User specific XPCOM event queue event
2120	*/
2121	case SDL_USER_EVENT_XPCOM_EVENTQUEUE:
2122	{
2123	LogFlow(("SDL_USER_EVENT_XPCOM_EVENTQUEUE: processing XPCOM event queue...\n"));
2124	eventQ->processEventQueue(0);
2125	signalXPCOMEventQueueThread();
2126	break;
2127	}
2128	#endif /* USE_XPCOM_QUEUE_THREAD */
2129
2130	/*
2131	* Termination event from the on state change callback.
2132	*/
2133	case SDL_USER_EVENT_TERMINATE:
2134	{
2135	if (event.user.code != VBOXSDL_TERM_NORMAL)
2136	{
2137	com::ProgressErrorInfo info(gProgress);
2138	if (info.isBasicAvailable())
2139	PrintError("Failed to power up VM", info.getText().raw());
2140	else
2141	RTPrintf("Error: failed to power up VM! No error text available.\n");
2142	}
2143	fTerminateDuringStartup = true;
2144	break;
2145	}
2146
2147	default:
2148	{
2149	LogBird(("VBoxSDL: Unknown SDL event %d (pre)\n", event.type));
2150	break;
2151	}
2152	}
2153
2154	}
2155	}
2156	eventQ->processEventQueue(0);
2157	} while ( rc == S_OK
2158	&& ( machineState == MachineState_Starting
2159	\|\| machineState == MachineState_Restoring
2160	\|\| machineState == MachineState_TeleportingIn
2161	)
2162	);
2163
2164	/* kill the timer again */
2165	SDL_RemoveTimer(sdlTimer);
2166	sdlTimer = 0;
2167
2168	/* are we supposed to terminate the process? */
2169	if (fTerminateDuringStartup)
2170	goto leave;
2171
2172	/* did the power up succeed? */
2173	if (machineState != MachineState_Running)
2174	{
2175	com::ProgressErrorInfo info(gProgress);
2176	if (info.isBasicAvailable())
2177	PrintError("Failed to power up VM", info.getText().raw());
2178	else
2179	RTPrintf("Error: failed to power up VM! No error text available (rc = 0x%x state = %d)\n", rc, machineState);
2180	goto leave;
2181	}
2182
2183	// accept power off events from now on because we're running
2184	// note that there's a possible race condition here...
2185	consoleListener->ignorePowerOffEvents(false);
2186
2187	rc = gConsole->COMGETTER(Keyboard)(gKeyboard.asOutParam());
2188	if (!gKeyboard)
2189	{
2190	RTPrintf("Error: could not get keyboard object!\n");
2191	goto leave;
2192	}
2193	gConsole->COMGETTER(Mouse)(gMouse.asOutParam());
2194	if (!gMouse)
2195	{
2196	RTPrintf("Error: could not get mouse object!\n");
2197	goto leave;
2198	}
2199
2200	UpdateTitlebar(TITLEBAR_NORMAL);
2201
2202	/*
2203	* Enable keyboard repeats
2204	*/
2205	SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
2206
2207	/*
2208	* Create PID file.
2209	*/
2210	if (gpszPidFile)
2211	{
2212	char szBuf[32];
2213	const char *pcszLf = "\n";
2214	RTFILE PidFile;
2215	RTFileOpen(&PidFile, gpszPidFile, RTFILE_O_WRITE \| RTFILE_O_CREATE_REPLACE \| RTFILE_O_DENY_NONE);
2216	RTStrFormatNumber(szBuf, RTProcSelf(), 10, 0, 0, 0);
2217	RTFileWrite(PidFile, szBuf, strlen(szBuf), NULL);
2218	RTFileWrite(PidFile, pcszLf, strlen(pcszLf), NULL);
2219	RTFileClose(PidFile);
2220	}
2221
2222	/*
2223	* Main event loop
2224	*/
2225	#ifdef USE_XPCOM_QUEUE_THREAD
2226	if (!fXPCOMEventThreadSignaled)
2227	{
2228	signalXPCOMEventQueueThread();
2229	}
2230	#endif
2231	LogFlow(("VBoxSDL: Entering big event loop\n"));
2232	while (WaitSDLEvent(&event))
2233	{
2234	switch (event.type)
2235	{
2236	/*
2237	* The screen needs to be repainted.
2238	*/
2239	#ifdef VBOX_WITH_SDL13
2240	case SDL_WINDOWEVENT:
2241	{
2242	switch (event.window.event)
2243	{
2244	case SDL_WINDOWEVENT_EXPOSED:
2245	{
2246	VBoxSDLFB *fb = getFbFromWinId(event.window.windowID);
2247	if (fb)
2248	fb->repaint();
2249	break;
2250	}
2251	case SDL_WINDOWEVENT_FOCUS_GAINED:
2252	{
2253	break;
2254	}
2255	default:
2256	break;
2257	}
2258	}
2259	#else
2260	case SDL_VIDEOEXPOSE:
2261	{
2262	gpFramebuffer[0]->repaint();
2263	break;
2264	}
2265	#endif
2266
2267	/*
2268	* Keyboard events.
2269	*/
2270	case SDL_KEYDOWN:
2271	case SDL_KEYUP:
2272	{
2273	SDLKey ksym = event.key.keysym.sym;
2274
2275	switch (enmHKeyState)
2276	{
2277	case HKEYSTATE_NORMAL:
2278	{
2279	if ( event.type == SDL_KEYDOWN
2280	&& ksym != SDLK_UNKNOWN
2281	&& (ksym == gHostKeySym1 \|\| ksym == gHostKeySym2))
2282	{
2283	EvHKeyDown1 = event;
2284	enmHKeyState = ksym == gHostKeySym1 ? HKEYSTATE_DOWN_1ST
2285	: HKEYSTATE_DOWN_2ND;
2286	break;
2287	}
2288	ProcessKey(&event.key);
2289	break;
2290	}
2291
2292	case HKEYSTATE_DOWN_1ST:
2293	case HKEYSTATE_DOWN_2ND:
2294	{
2295	if (gHostKeySym2 != SDLK_UNKNOWN)
2296	{
2297	if ( event.type == SDL_KEYDOWN
2298	&& ksym != SDLK_UNKNOWN
2299	&& ( (enmHKeyState == HKEYSTATE_DOWN_1ST && ksym == gHostKeySym2)
2300	\|\| (enmHKeyState == HKEYSTATE_DOWN_2ND && ksym == gHostKeySym1)))
2301	{
2302	EvHKeyDown2 = event;
2303	enmHKeyState = HKEYSTATE_DOWN;
2304	break;
2305	}
2306	enmHKeyState = event.type == SDL_KEYUP ? HKEYSTATE_NORMAL
2307	: HKEYSTATE_NOT_IT;
2308	ProcessKey(&EvHKeyDown1.key);
2309	/* ugly hack: Some guests (e.g. mstsc.exe on Windows XP)
2310	* expect a small delay between two key events. 5ms work
2311	* reliable here so use 10ms to be on the safe side. A
2312	* better but more complicated fix would be to introduce
2313	* a new state and don't wait here. */
2314	RTThreadSleep(10);
2315	ProcessKey(&event.key);
2316	break;
2317	}
2318	/* fall through if no two-key sequence is used */
2319	}
2320
2321	case HKEYSTATE_DOWN:
2322	{
2323	if (event.type == SDL_KEYDOWN)
2324	{
2325	/* potential host key combination, try execute it */
2326	int irc = HandleHostKey(&event.key);
2327	if (irc == VINF_SUCCESS)
2328	{
2329	enmHKeyState = HKEYSTATE_USED;
2330	break;
2331	}
2332	if (RT_SUCCESS(irc))
2333	goto leave;
2334	}
2335	else /* SDL_KEYUP */
2336	{
2337	if ( ksym != SDLK_UNKNOWN
2338	&& (ksym == gHostKeySym1 \|\| ksym == gHostKeySym2))
2339	{
2340	/* toggle grabbing state */
2341	if (!gfGrabbed)
2342	InputGrabStart();
2343	else
2344	InputGrabEnd();
2345
2346	/* SDL doesn't always reset the keystates, correct it */
2347	ResetKeys();
2348	enmHKeyState = HKEYSTATE_NORMAL;
2349	break;
2350	}
2351	}
2352
2353	/* not host key */
2354	enmHKeyState = HKEYSTATE_NOT_IT;
2355	ProcessKey(&EvHKeyDown1.key);
2356	/* see the comment for the 2-key case above */
2357	RTThreadSleep(10);
2358	if (gHostKeySym2 != SDLK_UNKNOWN)
2359	{
2360	ProcessKey(&EvHKeyDown2.key);
2361	/* see the comment for the 2-key case above */
2362	RTThreadSleep(10);
2363	}
2364	ProcessKey(&event.key);
2365	break;
2366	}
2367
2368	case HKEYSTATE_USED:
2369	{
2370	if ((SDL_GetModState() & ~(KMOD_MODE \| KMOD_NUM \| KMOD_RESERVED)) == 0)
2371	enmHKeyState = HKEYSTATE_NORMAL;
2372	if (event.type == SDL_KEYDOWN)
2373	{
2374	int irc = HandleHostKey(&event.key);
2375	if (RT_SUCCESS(irc) && irc != VINF_SUCCESS)
2376	goto leave;
2377	}
2378	break;
2379	}
2380
2381	default:
2382	AssertMsgFailed(("enmHKeyState=%d\n", enmHKeyState));
2383	/* fall thru */
2384	case HKEYSTATE_NOT_IT:
2385	{
2386	if ((SDL_GetModState() & ~(KMOD_MODE \| KMOD_NUM \| KMOD_RESERVED)) == 0)
2387	enmHKeyState = HKEYSTATE_NORMAL;
2388	ProcessKey(&event.key);
2389	break;
2390	}
2391	} /* state switch */
2392	break;
2393	}
2394
2395	/*
2396	* The window was closed.
2397	*/
2398	case SDL_QUIT:
2399	{
2400	if (!gfACPITerm \|\| gSdlQuitTimer)
2401	goto leave;
2402	if (gConsole)
2403	gConsole->PowerButton();
2404	gSdlQuitTimer = SDL_AddTimer(1000, QuitTimer, NULL);
2405	break;
2406	}
2407
2408	/*
2409	* The mouse has moved
2410	*/
2411	case SDL_MOUSEMOTION:
2412	{
2413	if (gfGrabbed \|\| UseAbsoluteMouse())
2414	{
2415	VBoxSDLFB *fb;
2416	#ifdef VBOX_WITH_SDL13
2417	fb = getFbFromWinId(event.motion.windowID);
2418	#else
2419	fb = gpFramebuffer[0];
2420	#endif
2421	SendMouseEvent(fb, 0, 0, 0);
2422	}
2423	break;
2424	}
2425
2426	/*
2427	* A mouse button has been clicked or released.
2428	*/
2429	case SDL_MOUSEBUTTONDOWN:
2430	case SDL_MOUSEBUTTONUP:
2431	{
2432	SDL_MouseButtonEvent *bev = &event.button;
2433	/* don't grab on mouse click if we have guest additions */
2434	if (!gfGrabbed && !UseAbsoluteMouse() && gfGrabOnMouseClick)
2435	{
2436	if (event.type == SDL_MOUSEBUTTONDOWN && (bev->state & SDL_BUTTON_LMASK))
2437	{
2438	/* start grabbing all events */
2439	InputGrabStart();
2440	}
2441	}
2442	else if (gfGrabbed \|\| UseAbsoluteMouse())
2443	{
2444	int dz = bev->button == SDL_BUTTON_WHEELUP
2445	? -1
2446	: bev->button == SDL_BUTTON_WHEELDOWN
2447	? +1
2448	: 0;
2449
2450	/* end host key combination (CTRL+MouseButton) */
2451	switch (enmHKeyState)
2452	{
2453	case HKEYSTATE_DOWN_1ST:
2454	case HKEYSTATE_DOWN_2ND:
2455	enmHKeyState = HKEYSTATE_NOT_IT;
2456	ProcessKey(&EvHKeyDown1.key);
2457	/* ugly hack: small delay to ensure that the key event is
2458	* actually handled _prior_ to the mouse click event */
2459	RTThreadSleep(20);
2460	break;
2461	case HKEYSTATE_DOWN:
2462	enmHKeyState = HKEYSTATE_NOT_IT;
2463	ProcessKey(&EvHKeyDown1.key);
2464	if (gHostKeySym2 != SDLK_UNKNOWN)
2465	ProcessKey(&EvHKeyDown2.key);
2466	/* ugly hack: small delay to ensure that the key event is
2467	* actually handled _prior_ to the mouse click event */
2468	RTThreadSleep(20);
2469	break;
2470	default:
2471	break;
2472	}
2473
2474	VBoxSDLFB *fb;
2475	#ifdef VBOX_WITH_SDL13
2476	fb = getFbFromWinId(event.button.windowID);
2477	#else
2478	fb = gpFramebuffer[0];
2479	#endif
2480	SendMouseEvent(fb, dz, event.type == SDL_MOUSEBUTTONDOWN, bev->button);
2481	}
2482	break;
2483	}
2484
2485	/*
2486	* The window has gained or lost focus.
2487	*/
2488	case SDL_ACTIVEEVENT:
2489	{
2490	/*
2491	* There is a strange behaviour in SDL when running without a window
2492	* manager: When SDL_WM_GrabInput(SDL_GRAB_ON) is called we receive two
2493	* consecutive events SDL_ACTIVEEVENTs (input lost, input gained).
2494	* Asking SDL_GetAppState() seems the better choice.
2495	*/
2496	if (gfGrabbed && (SDL_GetAppState() & SDL_APPINPUTFOCUS) == 0)
2497	{
2498	/*
2499	* another window has stolen the (keyboard) input focus
2500	*/
2501	InputGrabEnd();
2502	}
2503	break;
2504	}
2505
2506	/*
2507	* The SDL window was resized
2508	*/
2509	case SDL_VIDEORESIZE:
2510	{
2511	if (gDisplay)
2512	{
2513	if (gfIgnoreNextResize)
2514	{
2515	gfIgnoreNextResize = FALSE;
2516	break;
2517	}
2518	uResizeWidth = event.resize.w;
2519	#ifdef VBOX_SECURELABEL
2520	if (fSecureLabel)
2521	uResizeHeight = RT_MAX(0, event.resize.h - SECURE_LABEL_HEIGHT);
2522	else
2523	#endif
2524	uResizeHeight = event.resize.h;
2525	if (gSdlResizeTimer)
2526	SDL_RemoveTimer(gSdlResizeTimer);
2527	gSdlResizeTimer = SDL_AddTimer(300, ResizeTimer, NULL);
2528	}
2529	break;
2530	}
2531
2532	/*
2533	* User specific update event.
2534	*/
2535	/** @todo use a common user event handler so that SDL_PeepEvents() won't
2536	* possibly remove other events in the queue!
2537	*/
2538	case SDL_USER_EVENT_UPDATERECT:
2539	{
2540	/*
2541	* Decode event parameters.
2542	*/
2543	ASMAtomicDecS32(&g_cNotifyUpdateEventsPending);
2544	#define DECODEX(event) (int)((intptr_t)(event).user.data1 >> 16)
2545	#define DECODEY(event) (int)((intptr_t)(event).user.data1 & 0xFFFF)
2546	#define DECODEW(event) (int)((intptr_t)(event).user.data2 >> 16)
2547	#define DECODEH(event) (int)((intptr_t)(event).user.data2 & 0xFFFF)
2548	int x = DECODEX(event);
2549	int y = DECODEY(event);
2550	int w = DECODEW(event);
2551	int h = DECODEH(event);
2552	LogFlow(("SDL_USER_EVENT_UPDATERECT: x = %d, y = %d, w = %d, h = %d\n",
2553	x, y, w, h));
2554
2555	Assert(gpFramebuffer[event.user.code]);
2556	gpFramebuffer[event.user.code]->update(x, y, w, h, true /* fGuestRelative */);
2557
2558	#undef DECODEX
2559	#undef DECODEY
2560	#undef DECODEW
2561	#undef DECODEH
2562	break;
2563	}
2564
2565	/*
2566	* User event: Window resize done
2567	*/
2568	case SDL_USER_EVENT_WINDOW_RESIZE_DONE:
2569	{
2570	/**
2571	* @todo This is a workaround for synchronization problems between EMT and the
2572	* SDL main thread. It can happen that the SDL thread already starts a
2573	* new resize operation while the EMT is still busy with the old one
2574	* leading to a deadlock. Therefore we call SetVideoModeHint only once
2575	* when the mouse button was released.
2576	*/
2577	/* communicate the resize event to the guest */
2578	gDisplay->SetVideoModeHint(uResizeWidth, uResizeHeight, 0, 0);
2579	break;
2580
2581	}
2582
2583	/*
2584	* User specific resize event.
2585	*/
2586	case SDL_USER_EVENT_RESIZE:
2587	{
2588	LogFlow(("SDL_USER_EVENT_RESIZE\n"));
2589	IFramebuffer *dummyFb;
2590	LONG xOrigin, yOrigin;
2591	gpFramebuffer[event.user.code]->resizeGuest();
2592	/* update xOrigin, yOrigin -> mouse */
2593	rc = gDisplay->GetFramebuffer(event.user.code, &dummyFb, &xOrigin, &yOrigin);
2594	gpFramebuffer[event.user.code]->setOrigin(xOrigin, yOrigin);
2595	/* notify the display that the resize has been completed */
2596	gDisplay->ResizeCompleted(event.user.code);
2597	break;
2598	}
2599
2600	#ifdef USE_XPCOM_QUEUE_THREAD
2601	/*
2602	* User specific XPCOM event queue event
2603	*/
2604	case SDL_USER_EVENT_XPCOM_EVENTQUEUE:
2605	{
2606	LogFlow(("SDL_USER_EVENT_XPCOM_EVENTQUEUE: processing XPCOM event queue...\n"));
2607	eventQ->processEventQueue(0);
2608	signalXPCOMEventQueueThread();
2609	break;
2610	}
2611	#endif /* USE_XPCOM_QUEUE_THREAD */
2612
2613	/*
2614	* User specific update title bar notification event
2615	*/
2616	case SDL_USER_EVENT_UPDATE_TITLEBAR:
2617	{
2618	UpdateTitlebar(TITLEBAR_NORMAL);
2619	break;
2620	}
2621
2622	/*
2623	* User specific termination event
2624	*/
2625	case SDL_USER_EVENT_TERMINATE:
2626	{
2627	if (event.user.code != VBOXSDL_TERM_NORMAL)
2628	RTPrintf("Error: VM terminated abnormally!\n");
2629	goto leave;
2630	}
2631
2632	#ifdef VBOX_SECURELABEL
2633	/*
2634	* User specific secure label update event
2635	*/
2636	case SDL_USER_EVENT_SECURELABEL_UPDATE:
2637	{
2638	/*
2639	* Query the new label text
2640	*/
2641	Bstr key = VBOXSDL_SECURELABEL_EXTRADATA;
2642	Bstr label;
2643	gMachine->GetExtraData(key.raw(), label.asOutParam());
2644	Utf8Str labelUtf8 = label;
2645	/*
2646	* Now update the label
2647	*/
2648	gpFramebuffer[0]->setSecureLabelText(labelUtf8.c_str());
2649	break;
2650	}
2651	#endif /* VBOX_SECURELABEL */
2652
2653	/*
2654	* User specific pointer shape change event
2655	*/
2656	case SDL_USER_EVENT_POINTER_CHANGE:
2657	{
2658	PointerShapeChangeData data = (PointerShapeChangeData )event.user.data1;
2659	SetPointerShape (data);
2660	delete data;
2661	break;
2662	}
2663
2664	/*
2665	* User specific guest capabilities changed
2666	*/
2667	case SDL_USER_EVENT_GUEST_CAP_CHANGED:
2668	{
2669	HandleGuestCapsChanged();
2670	break;
2671	}
2672
2673	default:
2674	{
2675	LogBird(("unknown SDL event %d\n", event.type));
2676	break;
2677	}
2678	}
2679	}
2680
2681	leave:
2682	if (gpszPidFile)
2683	RTFileDelete(gpszPidFile);
2684
2685	LogFlow(("leaving...\n"));
2686	#if defined(VBOX_WITH_XPCOM) && !defined(RT_OS_DARWIN) && !defined(RT_OS_OS2)
2687	/* make sure the XPCOM event queue thread doesn't do anything harmful */
2688	terminateXPCOMQueueThread();
2689	#endif /* VBOX_WITH_XPCOM */
2690
2691	#ifdef VBOX_WITH_VRDP
2692	if (gVrdpServer)
2693	rc = gVrdpServer->COMSETTER(Enabled)(FALSE);
2694	#endif
2695
2696	/*
2697	* Get the machine state.
2698	*/
2699	if (gMachine)
2700	gMachine->COMGETTER(State)(&machineState);
2701	else
2702	machineState = MachineState_Aborted;
2703
2704	/*
2705	* Turn off the VM if it's running
2706	*/
2707	if ( gConsole
2708	&& ( machineState == MachineState_Running
2709	\|\| machineState == MachineState_Teleporting
2710	\|\| machineState == MachineState_LiveSnapshotting
2711	/** @todo power off paused VMs too? */
2712	)
2713	)
2714	do
2715	{
2716	consoleListener->ignorePowerOffEvents(true);
2717	ComPtr<IProgress> progress;
2718	CHECK_ERROR_BREAK(gConsole, PowerDown(progress.asOutParam()));
2719	CHECK_ERROR_BREAK(progress, WaitForCompletion(-1));
2720	BOOL completed;
2721	CHECK_ERROR_BREAK(progress, COMGETTER(Completed)(&completed));
2722	ASSERT(completed);
2723	LONG hrc;
2724	CHECK_ERROR_BREAK(progress, COMGETTER(ResultCode)(&hrc));
2725	if (FAILED(hrc))
2726	{
2727	com::ErrorInfo info;
2728	if (info.isFullAvailable())
2729	PrintError("Failed to power down VM",
2730	info.getText().raw(), info.getComponent().raw());
2731	else
2732	RTPrintf("Failed to power down virtual machine! No error information available (rc = 0x%x).\n", hrc);
2733	break;
2734	}
2735	} while (0);
2736
2737	/* unregister console listener */
2738	if (consoleListener)
2739	{
2740	ComPtr<IEventSource> es;
2741	CHECK_ERROR(gConsole, COMGETTER(EventSource)(es.asOutParam()));
2742	CHECK_ERROR(es, UnregisterListener(consoleListener));
2743	consoleListener->Release();
2744	consoleListener = NULL;
2745	}
2746
2747	/*
2748	* Now we discard all settings so that our changes will
2749	* not be flushed to the permanent configuration
2750	*/
2751	if ( gMachine
2752	&& machineState != MachineState_Saved)
2753	{
2754	rc = gMachine->DiscardSettings();
2755	AssertComRC(rc);
2756	}
2757
2758	/* close the session */
2759	if (sessionOpened)
2760	{
2761	rc = session->UnlockMachine();
2762	AssertComRC(rc);
2763	}
2764
2765	#ifndef VBOX_WITH_SDL13
2766	/* restore the default cursor and free the custom one if any */
2767	if (gpDefaultCursor)
2768	{
2769	# ifdef VBOXSDL_WITH_X11
2770	Cursor pDefaultTempX11Cursor = 0;
2771	if (gfXCursorEnabled)
2772	{
2773	pDefaultTempX11Cursor = (Cursor)gpDefaultCursor->wm_cursor;
2774	(Cursor)gpDefaultCursor->wm_cursor = gpDefaultOrigX11Cursor;
2775	}
2776	# endif /* VBOXSDL_WITH_X11 */
2777	SDL_SetCursor(gpDefaultCursor);
2778	# if defined(VBOXSDL_WITH_X11) && !defined(VBOX_WITHOUT_XCURSOR)
2779	if (gfXCursorEnabled)
2780	XFreeCursor(gSdlInfo.info.x11.display, pDefaultTempX11Cursor);
2781	# endif /* VBOXSDL_WITH_X11 && !VBOX_WITHOUT_XCURSOR */
2782	}
2783
2784	if (gpCustomCursor)
2785	{
2786	WMcursor *pCustomTempWMCursor = gpCustomCursor->wm_cursor;
2787	gpCustomCursor->wm_cursor = gpCustomOrigWMcursor;
2788	SDL_FreeCursor(gpCustomCursor);
2789	if (pCustomTempWMCursor)
2790	{
2791	# if defined(RT_OS_WINDOWS)
2792	::DestroyCursor((HCURSOR )pCustomTempWMCursor);
2793	# elif defined(VBOXSDL_WITH_X11) && !defined(VBOX_WITHOUT_XCURSOR)
2794	if (gfXCursorEnabled)
2795	XFreeCursor(gSdlInfo.info.x11.display, (Cursor )pCustomTempWMCursor);
2796	# endif /* VBOXSDL_WITH_X11 && !VBOX_WITHOUT_XCURSOR */
2797	free(pCustomTempWMCursor);
2798	}
2799	}
2800	#endif
2801
2802	LogFlow(("Releasing mouse, keyboard, vrdpserver, display, console...\n"));
2803	if (gDisplay)
2804	{
2805	for (unsigned i = 0; i < gcMonitors; i++)
2806	gDisplay->SetFramebuffer(i, NULL);
2807	}
2808
2809	gMouse = NULL;
2810	gKeyboard = NULL;
2811	gVrdpServer = NULL;
2812	gDisplay = NULL;
2813	gConsole = NULL;
2814	gMachineDebugger = NULL;
2815	gProgress = NULL;
2816	// we can only uninitialize SDL here because it is not threadsafe
2817
2818	for (unsigned i = 0; i < gcMonitors; i++)
2819	{
2820	if (gpFramebuffer[i])
2821	{
2822	LogFlow(("Releasing framebuffer...\n"));
2823	gpFramebuffer[i]->Release();
2824	gpFramebuffer[i] = NULL;
2825	}
2826	}
2827
2828	VBoxSDLFB::uninit();
2829
2830	#ifdef VBOX_SECURELABEL
2831	/* must do this after destructing the framebuffer */
2832	if (gLibrarySDL_ttf)
2833	RTLdrClose(gLibrarySDL_ttf);
2834	#endif
2835
2836	/* global listener unregistration. */
2837	if (vboxListener)
2838	{
2839	ComPtr<IEventSource> es;
2840	CHECK_ERROR(virtualBox, COMGETTER(EventSource)(es.asOutParam()));
2841	CHECK_ERROR(es, UnregisterListener(vboxListener));
2842	vboxListener->Release();
2843	vboxListener = NULL;
2844	}
2845	LogFlow(("Releasing machine, session...\n"));
2846	gMachine = NULL;
2847	session = NULL;
2848	LogFlow(("Releasing VirtualBox object...\n"));
2849	virtualBox = NULL;
2850
2851	// end "all-stuff" scope
2852	////////////////////////////////////////////////////////////////////////////
2853	}
2854
2855	/* Must be before com::Shutdown() */
2856	LogFlow(("Uninitializing COM...\n"));
2857	com::Shutdown();
2858
2859	LogFlow(("Returning from main()!\n"));
2860	RTLogFlush(NULL);
2861	return FAILED(rc) ? 1 : 0;
2862	}
2863
2864
2865	#ifndef VBOX_WITH_HARDENING
2866	/**
2867	* Main entry point
2868	*/
2869	int main(int argc, char **argv)
2870	{
2871	/*
2872	* Before we do anything, we initialize the runtime.
2873	*/
2874	int rcRT = RTR3InitAndSUPLib();
2875	if (RT_FAILURE(rcRT))
2876	{
2877	RTPrintf("Error: RTR3Init failed rcRC=%d\n", rcRT);
2878	return 1;
2879	}
2880	return TrustedMain(argc, argv, NULL);
2881	}
2882	#endif /* !VBOX_WITH_HARDENING */
2883
2884
2885	/**
2886	* Returns whether the absolute mouse is in use, i.e. both host
2887	* and guest have opted to enable it.
2888	*
2889	* @returns bool Flag whether the absolute mouse is in use
2890	*/
2891	static bool UseAbsoluteMouse(void)
2892	{
2893	return (gfAbsoluteMouseHost && gfAbsoluteMouseGuest);
2894	}
2895
2896	#if defined(RT_OS_DARWIN) \|\| defined(RT_OS_OS2)
2897	/**
2898	* Fallback keycode conversion using SDL symbols.
2899	*
2900	* This is used to catch keycodes that's missing from the translation table.
2901	*
2902	* @returns XT scancode
2903	* @param ev SDL scancode
2904	*/
2905	static uint16_t Keyevent2KeycodeFallback(const SDL_KeyboardEvent *ev)
2906	{
2907	const SDLKey sym = ev->keysym.sym;
2908	Log(("SDL key event: sym=%d scancode=%#x unicode=%#x\n",
2909	sym, ev->keysym.scancode, ev->keysym.unicode));
2910	switch (sym)
2911	{ /* set 1 scan code */
2912	case SDLK_ESCAPE: return 0x01;
2913	case SDLK_EXCLAIM:
2914	case SDLK_1: return 0x02;
2915	case SDLK_AT:
2916	case SDLK_2: return 0x03;
2917	case SDLK_HASH:
2918	case SDLK_3: return 0x04;
2919	case SDLK_DOLLAR:
2920	case SDLK_4: return 0x05;
2921	/* % */
2922	case SDLK_5: return 0x06;
2923	case SDLK_CARET:
2924	case SDLK_6: return 0x07;
2925	case SDLK_AMPERSAND:
2926	case SDLK_7: return 0x08;
2927	case SDLK_ASTERISK:
2928	case SDLK_8: return 0x09;
2929	case SDLK_LEFTPAREN:
2930	case SDLK_9: return 0x0a;
2931	case SDLK_RIGHTPAREN:
2932	case SDLK_0: return 0x0b;
2933	case SDLK_UNDERSCORE:
2934	case SDLK_MINUS: return 0x0c;
2935	case SDLK_EQUALS:
2936	case SDLK_PLUS: return 0x0d;
2937	case SDLK_BACKSPACE: return 0x0e;
2938	case SDLK_TAB: return 0x0f;
2939	case SDLK_q: return 0x10;
2940	case SDLK_w: return 0x11;
2941	case SDLK_e: return 0x12;
2942	case SDLK_r: return 0x13;
2943	case SDLK_t: return 0x14;
2944	case SDLK_y: return 0x15;
2945	case SDLK_u: return 0x16;
2946	case SDLK_i: return 0x17;
2947	case SDLK_o: return 0x18;
2948	case SDLK_p: return 0x19;
2949	case SDLK_LEFTBRACKET: return 0x1a;
2950	case SDLK_RIGHTBRACKET: return 0x1b;
2951	case SDLK_RETURN: return 0x1c;
2952	case SDLK_KP_ENTER: return 0x1c \| 0x100;
2953	case SDLK_LCTRL: return 0x1d;
2954	case SDLK_RCTRL: return 0x1d \| 0x100;
2955	case SDLK_a: return 0x1e;
2956	case SDLK_s: return 0x1f;
2957	case SDLK_d: return 0x20;
2958	case SDLK_f: return 0x21;
2959	case SDLK_g: return 0x22;
2960	case SDLK_h: return 0x23;
2961	case SDLK_j: return 0x24;
2962	case SDLK_k: return 0x25;
2963	case SDLK_l: return 0x26;
2964	case SDLK_COLON:
2965	case SDLK_SEMICOLON: return 0x27;
2966	case SDLK_QUOTEDBL:
2967	case SDLK_QUOTE: return 0x28;
2968	case SDLK_BACKQUOTE: return 0x29;
2969	case SDLK_LSHIFT: return 0x2a;
2970	case SDLK_BACKSLASH: return 0x2b;
2971	case SDLK_z: return 0x2c;
2972	case SDLK_x: return 0x2d;
2973	case SDLK_c: return 0x2e;
2974	case SDLK_v: return 0x2f;
2975	case SDLK_b: return 0x30;
2976	case SDLK_n: return 0x31;
2977	case SDLK_m: return 0x32;
2978	case SDLK_LESS:
2979	case SDLK_COMMA: return 0x33;
2980	case SDLK_GREATER:
2981	case SDLK_PERIOD: return 0x34;
2982	case SDLK_KP_DIVIDE: /??/
2983	case SDLK_QUESTION:
2984	case SDLK_SLASH: return 0x35;
2985	case SDLK_RSHIFT: return 0x36;
2986	case SDLK_KP_MULTIPLY:
2987	case SDLK_PRINT: return 0x37; /* fixme */
2988	case SDLK_LALT: return 0x38;
2989	case SDLK_MODE: /* alt gr*/
2990	case SDLK_RALT: return 0x38 \| 0x100;
2991	case SDLK_SPACE: return 0x39;
2992	case SDLK_CAPSLOCK: return 0x3a;
2993	case SDLK_F1: return 0x3b;
2994	case SDLK_F2: return 0x3c;
2995	case SDLK_F3: return 0x3d;
2996	case SDLK_F4: return 0x3e;
2997	case SDLK_F5: return 0x3f;
2998	case SDLK_F6: return 0x40;
2999	case SDLK_F7: return 0x41;
3000	case SDLK_F8: return 0x42;
3001	case SDLK_F9: return 0x43;
3002	case SDLK_F10: return 0x44;
3003	case SDLK_PAUSE: return 0x45; /* not right */
3004	case SDLK_NUMLOCK: return 0x45;
3005	case SDLK_SCROLLOCK: return 0x46;
3006	case SDLK_KP7: return 0x47;
3007	case SDLK_HOME: return 0x47 \| 0x100;
3008	case SDLK_KP8: return 0x48;
3009	case SDLK_UP: return 0x48 \| 0x100;
3010	case SDLK_KP9: return 0x49;
3011	case SDLK_PAGEUP: return 0x49 \| 0x100;
3012	case SDLK_KP_MINUS: return 0x4a;
3013	case SDLK_KP4: return 0x4b;
3014	case SDLK_LEFT: return 0x4b \| 0x100;
3015	case SDLK_KP5: return 0x4c;
3016	case SDLK_KP6: return 0x4d;
3017	case SDLK_RIGHT: return 0x4d \| 0x100;
3018	case SDLK_KP_PLUS: return 0x4e;
3019	case SDLK_KP1: return 0x4f;
3020	case SDLK_END: return 0x4f \| 0x100;
3021	case SDLK_KP2: return 0x50;
3022	case SDLK_DOWN: return 0x50 \| 0x100;
3023	case SDLK_KP3: return 0x51;
3024	case SDLK_PAGEDOWN: return 0x51 \| 0x100;
3025	case SDLK_KP0: return 0x52;
3026	case SDLK_INSERT: return 0x52 \| 0x100;
3027	case SDLK_KP_PERIOD: return 0x53;
3028	case SDLK_DELETE: return 0x53 \| 0x100;
3029	case SDLK_SYSREQ: return 0x54;
3030	case SDLK_F11: return 0x57;
3031	case SDLK_F12: return 0x58;
3032	case SDLK_F13: return 0x5b;
3033	case SDLK_LMETA:
3034	case SDLK_LSUPER: return 0x5b \| 0x100;
3035	case SDLK_F14: return 0x5c;
3036	case SDLK_RMETA:
3037	case SDLK_RSUPER: return 0x5c \| 0x100;
3038	case SDLK_F15: return 0x5d;
3039	case SDLK_MENU: return 0x5d \| 0x100;
3040	#if 0
3041	case SDLK_CLEAR: return 0x;
3042	case SDLK_KP_EQUALS: return 0x;
3043	case SDLK_COMPOSE: return 0x;
3044	case SDLK_HELP: return 0x;
3045	case SDLK_BREAK: return 0x;
3046	case SDLK_POWER: return 0x;
3047	case SDLK_EURO: return 0x;
3048	case SDLK_UNDO: return 0x;
3049	#endif
3050	default:
3051	Log(("Unhandled sdl key event: sym=%d scancode=%#x unicode=%#x\n",
3052	ev->keysym.sym, ev->keysym.scancode, ev->keysym.unicode));
3053	return 0;
3054	}
3055	}
3056	#endif /* RT_OS_DARWIN */
3057
3058	/**
3059	* Converts an SDL keyboard eventcode to a XT scancode.
3060	*
3061	* @returns XT scancode
3062	* @param ev SDL scancode
3063	*/
3064	static uint16_t Keyevent2Keycode(const SDL_KeyboardEvent *ev)
3065	{
3066	// start with the scancode determined by SDL
3067	int keycode = ev->keysym.scancode;
3068
3069	#ifdef VBOXSDL_WITH_X11
3070	# ifdef VBOX_WITH_SDL13
3071
3072	switch (ev->keysym.sym)
3073	{
3074	case SDLK_ESCAPE: return 0x01;
3075	case SDLK_EXCLAIM:
3076	case SDLK_1: return 0x02;
3077	case SDLK_AT:
3078	case SDLK_2: return 0x03;
3079	case SDLK_HASH:
3080	case SDLK_3: return 0x04;
3081	case SDLK_DOLLAR:
3082	case SDLK_4: return 0x05;
3083	/* % */
3084	case SDLK_5: return 0x06;
3085	case SDLK_CARET:
3086	case SDLK_6: return 0x07;
3087	case SDLK_AMPERSAND:
3088	case SDLK_7: return 0x08;
3089	case SDLK_ASTERISK:
3090	case SDLK_8: return 0x09;
3091	case SDLK_LEFTPAREN:
3092	case SDLK_9: return 0x0a;
3093	case SDLK_RIGHTPAREN:
3094	case SDLK_0: return 0x0b;
3095	case SDLK_UNDERSCORE:
3096	case SDLK_MINUS: return 0x0c;
3097	case SDLK_PLUS: return 0x0d;
3098	case SDLK_BACKSPACE: return 0x0e;
3099	case SDLK_TAB: return 0x0f;
3100	case SDLK_q: return 0x10;
3101	case SDLK_w: return 0x11;
3102	case SDLK_e: return 0x12;
3103	case SDLK_r: return 0x13;
3104	case SDLK_t: return 0x14;
3105	case SDLK_y: return 0x15;
3106	case SDLK_u: return 0x16;
3107	case SDLK_i: return 0x17;
3108	case SDLK_o: return 0x18;
3109	case SDLK_p: return 0x19;
3110	case SDLK_RETURN: return 0x1c;
3111	case SDLK_KP_ENTER: return 0x1c \| 0x100;
3112	case SDLK_LCTRL: return 0x1d;
3113	case SDLK_RCTRL: return 0x1d \| 0x100;
3114	case SDLK_a: return 0x1e;
3115	case SDLK_s: return 0x1f;
3116	case SDLK_d: return 0x20;
3117	case SDLK_f: return 0x21;
3118	case SDLK_g: return 0x22;
3119	case SDLK_h: return 0x23;
3120	case SDLK_j: return 0x24;
3121	case SDLK_k: return 0x25;
3122	case SDLK_l: return 0x26;
3123	case SDLK_COLON: return 0x27;
3124	case SDLK_QUOTEDBL:
3125	case SDLK_QUOTE: return 0x28;
3126	case SDLK_BACKQUOTE: return 0x29;
3127	case SDLK_LSHIFT: return 0x2a;
3128	case SDLK_z: return 0x2c;
3129	case SDLK_x: return 0x2d;
3130	case SDLK_c: return 0x2e;
3131	case SDLK_v: return 0x2f;
3132	case SDLK_b: return 0x30;
3133	case SDLK_n: return 0x31;
3134	case SDLK_m: return 0x32;
3135	case SDLK_LESS: return 0x33;
3136	case SDLK_GREATER: return 0x34;
3137	case SDLK_KP_DIVIDE: /??/
3138	case SDLK_QUESTION: return 0x35;
3139	case SDLK_RSHIFT: return 0x36;
3140	case SDLK_KP_MULTIPLY:
3141	case SDLK_PRINT: return 0x37; /* fixme */
3142	case SDLK_LALT: return 0x38;
3143	case SDLK_MODE: /* alt gr*/
3144	case SDLK_RALT: return 0x38 \| 0x100;
3145	case SDLK_SPACE: return 0x39;
3146	case SDLK_CAPSLOCK: return 0x3a;
3147	case SDLK_F1: return 0x3b;
3148	case SDLK_F2: return 0x3c;
3149	case SDLK_F3: return 0x3d;
3150	case SDLK_F4: return 0x3e;
3151	case SDLK_F5: return 0x3f;
3152	case SDLK_F6: return 0x40;
3153	case SDLK_F7: return 0x41;
3154	case SDLK_F8: return 0x42;
3155	case SDLK_F9: return 0x43;
3156	case SDLK_F10: return 0x44;
3157	case SDLK_PAUSE: return 0x45; /* not right */
3158	case SDLK_NUMLOCK: return 0x45;
3159	case SDLK_SCROLLOCK: return 0x46;
3160	case SDLK_KP7: return 0x47;
3161	case SDLK_HOME: return 0x47 \| 0x100;
3162	case SDLK_KP8: return 0x48;
3163	case SDLK_UP: return 0x48 \| 0x100;
3164	case SDLK_KP9: return 0x49;
3165	case SDLK_PAGEUP: return 0x49 \| 0x100;
3166	case SDLK_KP_MINUS: return 0x4a;
3167	case SDLK_KP4: return 0x4b;
3168	case SDLK_LEFT: return 0x4b \| 0x100;
3169	case SDLK_KP5: return 0x4c;
3170	case SDLK_KP6: return 0x4d;
3171	case SDLK_RIGHT: return 0x4d \| 0x100;
3172	case SDLK_KP_PLUS: return 0x4e;
3173	case SDLK_KP1: return 0x4f;
3174	case SDLK_END: return 0x4f \| 0x100;
3175	case SDLK_KP2: return 0x50;
3176	case SDLK_DOWN: return 0x50 \| 0x100;
3177	case SDLK_KP3: return 0x51;
3178	case SDLK_PAGEDOWN: return 0x51 \| 0x100;
3179	case SDLK_KP0: return 0x52;
3180	case SDLK_INSERT: return 0x52 \| 0x100;
3181	case SDLK_KP_PERIOD: return 0x53;
3182	case SDLK_DELETE: return 0x53 \| 0x100;
3183	case SDLK_SYSREQ: return 0x54;
3184	case SDLK_F11: return 0x57;
3185	case SDLK_F12: return 0x58;
3186	case SDLK_F13: return 0x5b;
3187	case SDLK_F14: return 0x5c;
3188	case SDLK_F15: return 0x5d;
3189	case SDLK_MENU: return 0x5d \| 0x100;
3190	default:
3191	return 0;
3192	}
3193	# else
3194	keycode = X11DRV_KeyEvent(gSdlInfo.info.x11.display, keycode);
3195	# endif
3196	#elif defined(RT_OS_DARWIN)
3197	/* This is derived partially from SDL_QuartzKeys.h and partially from testing. */
3198	static const uint16_t s_aMacToSet1[] =
3199	{
3200	/* set-1 SDL_QuartzKeys.h */
3201	0x1e, /* QZ_a 0x00 */
3202	0x1f, /* QZ_s 0x01 */
3203	0x20, /* QZ_d 0x02 */
3204	0x21, /* QZ_f 0x03 */
3205	0x23, /* QZ_h 0x04 */
3206	0x22, /* QZ_g 0x05 */
3207	0x2c, /* QZ_z 0x06 */
3208	0x2d, /* QZ_x 0x07 */
3209	0x2e, /* QZ_c 0x08 */
3210	0x2f, /* QZ_v 0x09 */
3211	0x56, /* between lshift and z. 'INT 1'? */
3212	0x30, /* QZ_b 0x0B */
3213	0x10, /* QZ_q 0x0C */
3214	0x11, /* QZ_w 0x0D */
3215	0x12, /* QZ_e 0x0E */
3216	0x13, /* QZ_r 0x0F */
3217	0x15, /* QZ_y 0x10 */
3218	0x14, /* QZ_t 0x11 */
3219	0x02, /* QZ_1 0x12 */
3220	0x03, /* QZ_2 0x13 */
3221	0x04, /* QZ_3 0x14 */
3222	0x05, /* QZ_4 0x15 */
3223	0x07, /* QZ_6 0x16 */
3224	0x06, /* QZ_5 0x17 */
3225	0x0d, /* QZ_EQUALS 0x18 */
3226	0x0a, /* QZ_9 0x19 */
3227	0x08, /* QZ_7 0x1A */
3228	0x0c, /* QZ_MINUS 0x1B */
3229	0x09, /* QZ_8 0x1C */
3230	0x0b, /* QZ_0 0x1D */
3231	0x1b, /* QZ_RIGHTBRACKET 0x1E */
3232	0x18, /* QZ_o 0x1F */
3233	0x16, /* QZ_u 0x20 */
3234	0x1a, /* QZ_LEFTBRACKET 0x21 */
3235	0x17, /* QZ_i 0x22 */
3236	0x19, /* QZ_p 0x23 */
3237	0x1c, /* QZ_RETURN 0x24 */
3238	0x26, /* QZ_l 0x25 */
3239	0x24, /* QZ_j 0x26 */
3240	0x28, /* QZ_QUOTE 0x27 */
3241	0x25, /* QZ_k 0x28 */
3242	0x27, /* QZ_SEMICOLON 0x29 */
3243	0x2b, /* QZ_BACKSLASH 0x2A */
3244	0x33, /* QZ_COMMA 0x2B */
3245	0x35, /* QZ_SLASH 0x2C */
3246	0x31, /* QZ_n 0x2D */
3247	0x32, /* QZ_m 0x2E */
3248	0x34, /* QZ_PERIOD 0x2F */
3249	0x0f, /* QZ_TAB 0x30 */
3250	0x39, /* QZ_SPACE 0x31 */
3251	0x29, /* QZ_BACKQUOTE 0x32 */
3252	0x0e, /* QZ_BACKSPACE 0x33 */
3253	0x9c, /* QZ_IBOOK_ENTER 0x34 */
3254	0x01, /* QZ_ESCAPE 0x35 */
3255	0x5c\|0x100, /* QZ_RMETA 0x36 */
3256	0x5b\|0x100, /* QZ_LMETA 0x37 */
3257	0x2a, /* QZ_LSHIFT 0x38 */
3258	0x3a, /* QZ_CAPSLOCK 0x39 */
3259	0x38, /* QZ_LALT 0x3A */
3260	0x1d, /* QZ_LCTRL 0x3B */
3261	0x36, /* QZ_RSHIFT 0x3C */
3262	0x38\|0x100, /* QZ_RALT 0x3D */
3263	0x1d\|0x100, /* QZ_RCTRL 0x3E */
3264	0, /* */
3265	0, /* */
3266	0x53, /* QZ_KP_PERIOD 0x41 */
3267	0, /* */
3268	0x37, /* QZ_KP_MULTIPLY 0x43 */
3269	0, /* */
3270	0x4e, /* QZ_KP_PLUS 0x45 */
3271	0, /* */
3272	0x45, /* QZ_NUMLOCK 0x47 */
3273	0, /* */
3274	0, /* */
3275	0, /* */
3276	0x35\|0x100, /* QZ_KP_DIVIDE 0x4B */
3277	0x1c\|0x100, /* QZ_KP_ENTER 0x4C */
3278	0, /* */
3279	0x4a, /* QZ_KP_MINUS 0x4E */
3280	0, /* */
3281	0, /* */
3282	0x0d/?/, /* QZ_KP_EQUALS 0x51 */
3283	0x52, /* QZ_KP0 0x52 */
3284	0x4f, /* QZ_KP1 0x53 */
3285	0x50, /* QZ_KP2 0x54 */
3286	0x51, /* QZ_KP3 0x55 */
3287	0x4b, /* QZ_KP4 0x56 */
3288	0x4c, /* QZ_KP5 0x57 */
3289	0x4d, /* QZ_KP6 0x58 */
3290	0x47, /* QZ_KP7 0x59 */
3291	0, /* */
3292	0x48, /* QZ_KP8 0x5B */
3293	0x49, /* QZ_KP9 0x5C */
3294	0, /* */
3295	0, /* */
3296	0, /* */
3297	0x3f, /* QZ_F5 0x60 */
3298	0x40, /* QZ_F6 0x61 */
3299	0x41, /* QZ_F7 0x62 */
3300	0x3d, /* QZ_F3 0x63 */
3301	0x42, /* QZ_F8 0x64 */
3302	0x43, /* QZ_F9 0x65 */
3303	0, /* */
3304	0x57, /* QZ_F11 0x67 */
3305	0, /* */
3306	0x37\|0x100, /* QZ_PRINT / F13 0x69 */
3307	0x63, /* QZ_F16 0x6A */
3308	0x46, /* QZ_SCROLLOCK 0x6B */
3309	0, /* */
3310	0x44, /* QZ_F10 0x6D */
3311	0x5d\|0x100, /* */
3312	0x58, /* QZ_F12 0x6F */
3313	0, /* */
3314	0/* 0xe1,0x1d,0x45/, / QZ_PAUSE 0x71 */
3315	0x52\|0x100, /* QZ_INSERT / HELP 0x72 */
3316	0x47\|0x100, /* QZ_HOME 0x73 */
3317	0x49\|0x100, /* QZ_PAGEUP 0x74 */
3318	0x53\|0x100, /* QZ_DELETE 0x75 */
3319	0x3e, /* QZ_F4 0x76 */
3320	0x4f\|0x100, /* QZ_END 0x77 */
3321	0x3c, /* QZ_F2 0x78 */
3322	0x51\|0x100, /* QZ_PAGEDOWN 0x79 */
3323	0x3b, /* QZ_F1 0x7A */
3324	0x4b\|0x100, /* QZ_LEFT 0x7B */
3325	0x4d\|0x100, /* QZ_RIGHT 0x7C */
3326	0x50\|0x100, /* QZ_DOWN 0x7D */
3327	0x48\|0x100, /* QZ_UP 0x7E */
3328	0x5e\|0x100, /* QZ_POWER 0x7F / / have different break key! */
3329	};
3330
3331	if (keycode == 0)
3332	{
3333	/* This could be a modifier or it could be 'a'. */
3334	switch (ev->keysym.sym)
3335	{
3336	case SDLK_LSHIFT: keycode = 0x2a; break;
3337	case SDLK_RSHIFT: keycode = 0x36; break;
3338	case SDLK_LCTRL: keycode = 0x1d; break;
3339	case SDLK_RCTRL: keycode = 0x1d \| 0x100; break;
3340	case SDLK_LALT: keycode = 0x38; break;
3341	case SDLK_MODE: /* alt gr */
3342	case SDLK_RALT: keycode = 0x38 \| 0x100; break;
3343	case SDLK_RMETA:
3344	case SDLK_RSUPER: keycode = 0x5c \| 0x100; break;
3345	case SDLK_LMETA:
3346	case SDLK_LSUPER: keycode = 0x5b \| 0x100; break;
3347	/* Sssumes normal key. */
3348	default: keycode = s_aMacToSet1[keycode]; break;
3349	}
3350	}
3351	else
3352	{
3353	if ((unsigned)keycode < RT_ELEMENTS(s_aMacToSet1))
3354	keycode = s_aMacToSet1[keycode];
3355	else
3356	keycode = 0;
3357	if (!keycode)
3358	{
3359	#ifdef DEBUG_bird
3360	RTPrintf("Untranslated: keycode=%#x (%d)\n", keycode, keycode);
3361	#endif
3362	keycode = Keyevent2KeycodeFallback(ev);
3363	}
3364	}
3365	#ifdef DEBUG_bird
3366	RTPrintf("scancode=%#x -> %#x\n", ev->keysym.scancode, keycode);
3367	#endif
3368
3369	#elif RT_OS_OS2
3370	keycode = Keyevent2KeycodeFallback(ev);
3371	#endif /* RT_OS_DARWIN */
3372	return keycode;
3373	}
3374
3375	/**
3376	* Releases any modifier keys that are currently in pressed state.
3377	*/
3378	static void ResetKeys(void)
3379	{
3380	int i;
3381
3382	if (!gKeyboard)
3383	return;
3384
3385	for(i = 0; i < 256; i++)
3386	{
3387	if (gaModifiersState[i])
3388	{
3389	if (i & 0x80)
3390	gKeyboard->PutScancode(0xe0);
3391	gKeyboard->PutScancode(i \| 0x80);
3392	gaModifiersState[i] = 0;
3393	}
3394	}
3395	}
3396
3397	/**
3398	* Keyboard event handler.
3399	*
3400	* @param ev SDL keyboard event.
3401	*/
3402	static void ProcessKey(SDL_KeyboardEvent *ev)
3403	{
3404	#if (defined(DEBUG) \|\| defined(VBOX_WITH_STATISTICS)) && !defined(VBOX_WITH_SDL13)
3405	if (gMachineDebugger && ev->type == SDL_KEYDOWN)
3406	{
3407	// first handle the debugger hotkeys
3408	uint8_t *keystate = SDL_GetKeyState(NULL);
3409	#if 0
3410	// CTRL+ALT+Fn is not free on Linux hosts with Xorg ..
3411	if (keystate[SDLK_LALT] && !keystate[SDLK_LCTRL])
3412	#else
3413	if (keystate[SDLK_LALT] && keystate[SDLK_LCTRL])
3414	#endif
3415	{
3416	switch (ev->keysym.sym)
3417	{
3418	// pressing CTRL+ALT+F11 dumps the statistics counter
3419	case SDLK_F12:
3420	RTPrintf("ResetStats\n"); /* Visual feedback in console window */
3421	gMachineDebugger->ResetStats(NULL);
3422	break;
3423	// pressing CTRL+ALT+F12 resets all statistics counter
3424	case SDLK_F11:
3425	gMachineDebugger->DumpStats(NULL);
3426	RTPrintf("DumpStats\n"); /* Vistual feedback in console window */
3427	break;
3428	default:
3429	break;
3430	}
3431	}
3432	#if 1
3433	else if (keystate[SDLK_LALT] && !keystate[SDLK_LCTRL])
3434	{
3435	switch (ev->keysym.sym)
3436	{
3437	// pressing Alt-F12 toggles the supervisor recompiler
3438	case SDLK_F12:
3439	{
3440	BOOL recompileSupervisor;
3441	gMachineDebugger->COMGETTER(RecompileSupervisor)(&recompileSupervisor);
3442	gMachineDebugger->COMSETTER(RecompileSupervisor)(!recompileSupervisor);
3443	break;
3444	}
3445	// pressing Alt-F11 toggles the user recompiler
3446	case SDLK_F11:
3447	{
3448	BOOL recompileUser;
3449	gMachineDebugger->COMGETTER(RecompileUser)(&recompileUser);
3450	gMachineDebugger->COMSETTER(RecompileUser)(!recompileUser);
3451	break;
3452	}
3453	// pressing Alt-F10 toggles the patch manager
3454	case SDLK_F10:
3455	{
3456	BOOL patmEnabled;
3457	gMachineDebugger->COMGETTER(PATMEnabled)(&patmEnabled);
3458	gMachineDebugger->COMSETTER(PATMEnabled)(!patmEnabled);
3459	break;
3460	}
3461	// pressing Alt-F9 toggles CSAM
3462	case SDLK_F9:
3463	{
3464	BOOL csamEnabled;
3465	gMachineDebugger->COMGETTER(CSAMEnabled)(&csamEnabled);
3466	gMachineDebugger->COMSETTER(CSAMEnabled)(!csamEnabled);
3467	break;
3468	}
3469	// pressing Alt-F8 toggles singlestepping mode
3470	case SDLK_F8:
3471	{
3472	BOOL singlestepEnabled;
3473	gMachineDebugger->COMGETTER(Singlestep)(&singlestepEnabled);
3474	gMachineDebugger->COMSETTER(Singlestep)(!singlestepEnabled);
3475	break;
3476	}
3477	default:
3478	break;
3479	}
3480	}
3481	#endif
3482	// pressing Ctrl-F12 toggles the logger
3483	else if ((keystate[SDLK_RCTRL] \|\| keystate[SDLK_LCTRL]) && ev->keysym.sym == SDLK_F12)
3484	{
3485	BOOL logEnabled = TRUE;
3486	gMachineDebugger->COMGETTER(LogEnabled)(&logEnabled);
3487	gMachineDebugger->COMSETTER(LogEnabled)(!logEnabled);
3488	#ifdef DEBUG_bird
3489	return;
3490	#endif
3491	}
3492	// pressing F12 sets a logmark
3493	else if (ev->keysym.sym == SDLK_F12)
3494	{
3495	RTLogPrintf("**** LOGGING MARK ****\n");
3496	RTLogFlush(NULL);
3497	}
3498	// now update the titlebar flags
3499	UpdateTitlebar(TITLEBAR_NORMAL);
3500	}
3501	#endif // DEBUG \|\| VBOX_WITH_STATISTICS
3502
3503	// the pause key is the weirdest, needs special handling
3504	if (ev->keysym.sym == SDLK_PAUSE)
3505	{
3506	int v = 0;
3507	if (ev->type == SDL_KEYUP)
3508	v \|= 0x80;
3509	gKeyboard->PutScancode(0xe1);
3510	gKeyboard->PutScancode(0x1d \| v);
3511	gKeyboard->PutScancode(0x45 \| v);
3512	return;
3513	}
3514
3515	/*
3516	* Perform SDL key event to scancode conversion
3517	*/
3518	int keycode = Keyevent2Keycode(ev);
3519
3520	switch(keycode)
3521	{
3522	case 0x00:
3523	{
3524	/* sent when leaving window: reset the modifiers state */
3525	ResetKeys();
3526	return;
3527	}
3528
3529	case 0x2a: /* Left Shift */
3530	case 0x36: /* Right Shift */
3531	case 0x1d: /* Left CTRL */
3532	case 0x1d\|0x100: /* Right CTRL */
3533	case 0x38: /* Left ALT */
3534	case 0x38\|0x100: /* Right ALT */
3535	{
3536	if (ev->type == SDL_KEYUP)
3537	gaModifiersState[keycode & ~0x100] = 0;
3538	else
3539	gaModifiersState[keycode & ~0x100] = 1;
3540	break;
3541	}
3542
3543	case 0x45: /* Num Lock */
3544	case 0x3a: /* Caps Lock */
3545	{
3546	/*
3547	* SDL generates a KEYDOWN event if the lock key is active and a KEYUP event
3548	* if the lock key is inactive. See SDL_DISABLE_LOCK_KEYS.
3549	*/
3550	if (ev->type == SDL_KEYDOWN \|\| ev->type == SDL_KEYUP)
3551	{
3552	gKeyboard->PutScancode(keycode);
3553	gKeyboard->PutScancode(keycode \| 0x80);
3554	}
3555	return;
3556	}
3557	}
3558
3559	if (ev->type != SDL_KEYDOWN)
3560	{
3561	/*
3562	* Some keyboards (e.g. the one of mine T60) don't send a NumLock scan code on every
3563	* press of the key. Both the guest and the host should agree on the NumLock state.
3564	* If they differ, we try to alter the guest NumLock state by sending the NumLock key
3565	* scancode. We will get a feedback through the KBD_CMD_SET_LEDS command if the guest
3566	* tries to set/clear the NumLock LED. If a (silly) guest doesn't change the LED, don't
3567	* bother him with NumLock scancodes. At least our BIOS, Linux and Windows handle the
3568	* NumLock LED well.
3569	*/
3570	if ( gcGuestNumLockAdaptions
3571	&& (gfGuestNumLockPressed ^ !!(SDL_GetModState() & KMOD_NUM)))
3572	{
3573	gcGuestNumLockAdaptions--;
3574	gKeyboard->PutScancode(0x45);
3575	gKeyboard->PutScancode(0x45 \| 0x80);
3576	}
3577	if ( gcGuestCapsLockAdaptions
3578	&& (gfGuestCapsLockPressed ^ !!(SDL_GetModState() & KMOD_CAPS)))
3579	{
3580	gcGuestCapsLockAdaptions--;
3581	gKeyboard->PutScancode(0x3a);
3582	gKeyboard->PutScancode(0x3a \| 0x80);
3583	}
3584	}
3585
3586	/*
3587	* Now we send the event. Apply extended and release prefixes.
3588	*/
3589	if (keycode & 0x100)
3590	gKeyboard->PutScancode(0xe0);
3591
3592	gKeyboard->PutScancode(ev->type == SDL_KEYUP ? (keycode & 0x7f) \| 0x80
3593	: (keycode & 0x7f));
3594	}
3595
3596	#ifdef RT_OS_DARWIN
3597	#include <Carbon/Carbon.h>
3598	RT_C_DECLS_BEGIN
3599	/* Private interface in 10.3 and later. */
3600	typedef int CGSConnection;
3601	typedef enum
3602	{
3603	kCGSGlobalHotKeyEnable = 0,
3604	kCGSGlobalHotKeyDisable,
3605	kCGSGlobalHotKeyInvalid = -1 /* bird */
3606	} CGSGlobalHotKeyOperatingMode;
3607	extern CGSConnection _CGSDefaultConnection(void);
3608	extern CGError CGSGetGlobalHotKeyOperatingMode(CGSConnection Connection, CGSGlobalHotKeyOperatingMode *enmMode);
3609	extern CGError CGSSetGlobalHotKeyOperatingMode(CGSConnection Connection, CGSGlobalHotKeyOperatingMode enmMode);
3610	RT_C_DECLS_END
3611
3612	/** Keeping track of whether we disabled the hotkeys or not. */
3613	static bool g_fHotKeysDisabled = false;
3614	/** Whether we've connected or not. */
3615	static bool g_fConnectedToCGS = false;
3616	/** Cached connection. */
3617	static CGSConnection g_CGSConnection;
3618
3619	/**
3620	* Disables or enabled global hot keys.
3621	*/
3622	static void DisableGlobalHotKeys(bool fDisable)
3623	{
3624	if (!g_fConnectedToCGS)
3625	{
3626	g_CGSConnection = _CGSDefaultConnection();
3627	g_fConnectedToCGS = true;
3628	}
3629
3630	/* get current mode. */
3631	CGSGlobalHotKeyOperatingMode enmMode = kCGSGlobalHotKeyInvalid;
3632	CGSGetGlobalHotKeyOperatingMode(g_CGSConnection, &enmMode);
3633
3634	/* calc new mode. */
3635	if (fDisable)
3636	{
3637	if (enmMode != kCGSGlobalHotKeyEnable)
3638	return;
3639	enmMode = kCGSGlobalHotKeyDisable;
3640	}
3641	else
3642	{
3643	if ( enmMode != kCGSGlobalHotKeyDisable
3644	/\|\| !g_fHotKeysDisabled/)
3645	return;
3646	enmMode = kCGSGlobalHotKeyEnable;
3647	}
3648
3649	/* try set it and check the actual result. */
3650	CGSSetGlobalHotKeyOperatingMode(g_CGSConnection, enmMode);
3651	CGSGlobalHotKeyOperatingMode enmNewMode = kCGSGlobalHotKeyInvalid;
3652	CGSGetGlobalHotKeyOperatingMode(g_CGSConnection, &enmNewMode);
3653	if (enmNewMode == enmMode)
3654	g_fHotKeysDisabled = enmMode == kCGSGlobalHotKeyDisable;
3655	}
3656	#endif /* RT_OS_DARWIN */
3657
3658	/**
3659	* Start grabbing the mouse.
3660	*/
3661	static void InputGrabStart(void)
3662	{
3663	#ifdef RT_OS_DARWIN
3664	DisableGlobalHotKeys(true);
3665	#endif
3666	if (!gfGuestNeedsHostCursor && gfRelativeMouseGuest)
3667	SDL_ShowCursor(SDL_DISABLE);
3668	SDL_WM_GrabInput(SDL_GRAB_ON);
3669	// dummy read to avoid moving the mouse
3670	SDL_GetRelativeMouseState(
3671	#ifdef VBOX_WITH_SDL13
3672	0,
3673	#endif
3674	NULL, NULL);
3675	gfGrabbed = TRUE;
3676	UpdateTitlebar(TITLEBAR_NORMAL);
3677	}
3678
3679	/**
3680	* End mouse grabbing.
3681	*/
3682	static void InputGrabEnd(void)
3683	{
3684	SDL_WM_GrabInput(SDL_GRAB_OFF);
3685	if (!gfGuestNeedsHostCursor && gfRelativeMouseGuest)
3686	SDL_ShowCursor(SDL_ENABLE);
3687	#ifdef RT_OS_DARWIN
3688	DisableGlobalHotKeys(false);
3689	#endif
3690	gfGrabbed = FALSE;
3691	UpdateTitlebar(TITLEBAR_NORMAL);
3692	}
3693
3694	/**
3695	* Query mouse position and button state from SDL and send to the VM
3696	*
3697	* @param dz Relative mouse wheel movement
3698	*/
3699	static void SendMouseEvent(VBoxSDLFB *fb, int dz, int down, int button)
3700	{
3701	int x, y, state, buttons;
3702	bool abs;
3703
3704	#ifdef VBOX_WITH_SDL13
3705	if (!fb)
3706	{
3707	SDL_GetMouseState(0, &x, &y);
3708	RTPrintf("MouseEvent: Cannot find fb mouse = %d,%d\n", x, y);
3709	return;
3710	}
3711	#else
3712	AssertRelease(fb != NULL);
3713	#endif
3714
3715	/*
3716	* If supported and we're not in grabbed mode, we'll use the absolute mouse.
3717	* If we are in grabbed mode and the guest is not able to draw the mouse cursor
3718	* itself, or can't handle relative reporting, we have to use absolute
3719	* coordinates, otherwise the host cursor and
3720	* the coordinates the guest thinks the mouse is at could get out-of-sync. From
3721	* the SDL mailing list:
3722	*
3723	* "The event processing is usually asynchronous and so somewhat delayed, and
3724	* SDL_GetMouseState is returning the immediate mouse state. So at the time you
3725	* call SDL_GetMouseState, the "button" is already up."
3726	*/
3727	abs = (UseAbsoluteMouse() && !gfGrabbed)
3728	\|\| gfGuestNeedsHostCursor
3729	\|\| !gfRelativeMouseGuest;
3730
3731	/* only used if abs == TRUE */
3732	int xOrigin = fb->getOriginX();
3733	int yOrigin = fb->getOriginY();
3734	int xMin = fb->getXOffset() + xOrigin;
3735	int yMin = fb->getYOffset() + yOrigin;
3736	int xMax = xMin + (int)fb->getGuestXRes();
3737	int yMax = yMin + (int)fb->getGuestYRes();
3738
3739	state = abs ? SDL_GetMouseState(
3740	#ifdef VBOX_WITH_SDL13
3741	0,
3742	#endif
3743	&x, &y)
3744	: SDL_GetRelativeMouseState(
3745	#ifdef VBOX_WITH_SDL13
3746	0,
3747	#endif
3748	&x, &y);
3749
3750	/*
3751	* process buttons
3752	*/
3753	buttons = 0;
3754	if (state & SDL_BUTTON(SDL_BUTTON_LEFT))
3755	buttons \|= MouseButtonState_LeftButton;
3756	if (state & SDL_BUTTON(SDL_BUTTON_RIGHT))
3757	buttons \|= MouseButtonState_RightButton;
3758	if (state & SDL_BUTTON(SDL_BUTTON_MIDDLE))
3759	buttons \|= MouseButtonState_MiddleButton;
3760
3761	if (abs)
3762	{
3763	x += xOrigin;
3764	y += yOrigin;
3765
3766	/*
3767	* Check if the mouse event is inside the guest area. This solves the
3768	* following problem: Some guests switch off the VBox hardware mouse
3769	* cursor and draw the mouse cursor itself instead. Moving the mouse
3770	* outside the guest area then leads to annoying mouse hangs if we
3771	* don't pass mouse motion events into the guest.
3772	*/
3773	if (x < xMin \|\| y < yMin \|\| x > xMax \|\| y > yMax)
3774	{
3775	/*
3776	* Cursor outside of valid guest area (outside window or in secure
3777	* label area. Don't allow any mouse button press.
3778	*/
3779	button = 0;
3780
3781	/*
3782	* Release any pressed button.
3783	*/
3784	#if 0
3785	/* disabled on customers request */
3786	buttons &= ~(MouseButtonState_LeftButton \|
3787	MouseButtonState_MiddleButton \|
3788	MouseButtonState_RightButton);
3789	#endif
3790
3791	/*
3792	* Prevent negative coordinates.
3793	*/
3794	if (x < xMin) x = xMin;
3795	if (x > xMax) x = xMax;
3796	if (y < yMin) y = yMin;
3797	if (y > yMax) y = yMax;
3798
3799	if (!gpOffCursor)
3800	{
3801	gpOffCursor = SDL_GetCursor(); /* Cursor image */
3802	gfOffCursorActive = SDL_ShowCursor(-1); /* enabled / disabled */
3803	SDL_SetCursor(gpDefaultCursor);
3804	SDL_ShowCursor(SDL_ENABLE);
3805	}
3806	}
3807	else
3808	{
3809	if (gpOffCursor)
3810	{
3811	/*
3812	* We just entered the valid guest area. Restore the guest mouse
3813	* cursor.
3814	*/
3815	SDL_SetCursor(gpOffCursor);
3816	SDL_ShowCursor(gfOffCursorActive ? SDL_ENABLE : SDL_DISABLE);
3817	gpOffCursor = NULL;
3818	}
3819	}
3820	}
3821
3822	/*
3823	* Button was pressed but that press is not reflected in the button state?
3824	*/
3825	if (down && !(state & SDL_BUTTON(button)))
3826	{
3827	/*
3828	* It can happen that a mouse up event follows a mouse down event immediately
3829	* and we see the events when the bit in the button state is already cleared
3830	* again. In that case we simulate the mouse down event.
3831	*/
3832	int tmp_button = 0;
3833	switch (button)
3834	{
3835	case SDL_BUTTON_LEFT: tmp_button = MouseButtonState_LeftButton; break;
3836	case SDL_BUTTON_MIDDLE: tmp_button = MouseButtonState_MiddleButton; break;
3837	case SDL_BUTTON_RIGHT: tmp_button = MouseButtonState_RightButton; break;
3838	}
3839
3840	if (abs)
3841	{
3842	/**
3843	* @todo
3844	* PutMouseEventAbsolute() expects x and y starting from 1,1.
3845	* should we do the increment internally in PutMouseEventAbsolute()
3846	* or state it in PutMouseEventAbsolute() docs?
3847	*/
3848	gMouse->PutMouseEventAbsolute(x + 1 - xMin + xOrigin,
3849	y + 1 - yMin + yOrigin,
3850	dz, 0 /* horizontal scroll wheel */,
3851	buttons \| tmp_button);
3852	}
3853	else
3854	{
3855	gMouse->PutMouseEvent(0, 0, dz,
3856	0 /* horizontal scroll wheel */,
3857	buttons \| tmp_button);
3858	}
3859	}
3860
3861	// now send the mouse event
3862	if (abs)
3863	{
3864	/**
3865	* @todo
3866	* PutMouseEventAbsolute() expects x and y starting from 1,1.
3867	* should we do the increment internally in PutMouseEventAbsolute()
3868	* or state it in PutMouseEventAbsolute() docs?
3869	*/
3870	gMouse->PutMouseEventAbsolute(x + 1 - xMin + xOrigin,
3871	y + 1 - yMin + yOrigin,
3872	dz, 0 /* Horizontal wheel */, buttons);
3873	}
3874	else
3875	{
3876	gMouse->PutMouseEvent(x, y, dz, 0 /* Horizontal wheel */, buttons);
3877	}
3878	}
3879
3880	/**
3881	* Resets the VM
3882	*/
3883	void ResetVM(void)
3884	{
3885	if (gConsole)
3886	gConsole->Reset();
3887	}
3888
3889	/**
3890	* Initiates a saved state and updates the titlebar with progress information
3891	*/
3892	void SaveState(void)
3893	{
3894	ResetKeys();
3895	RTThreadYield();
3896	if (gfGrabbed)
3897	InputGrabEnd();
3898	RTThreadYield();
3899	UpdateTitlebar(TITLEBAR_SAVE);
3900	gProgress = NULL;
3901	HRESULT rc = gConsole->SaveState(gProgress.asOutParam());
3902	if (FAILED(S_OK))
3903	{
3904	RTPrintf("Error saving state! rc = 0x%x\n", rc);
3905	return;
3906	}
3907	Assert(gProgress);
3908
3909	/*
3910	* Wait for the operation to be completed and work
3911	* the title bar in the mean while.
3912	*/
3913	ULONG cPercent = 0;
3914	#ifndef RT_OS_DARWIN /* don't break the other guys yet. */
3915	for (;;)
3916	{
3917	BOOL fCompleted = false;
3918	rc = gProgress->COMGETTER(Completed)(&fCompleted);
3919	if (FAILED(rc) \|\| fCompleted)
3920	break;
3921	ULONG cPercentNow;
3922	rc = gProgress->COMGETTER(Percent)(&cPercentNow);
3923	if (FAILED(rc))
3924	break;
3925	if (cPercentNow != cPercent)
3926	{
3927	UpdateTitlebar(TITLEBAR_SAVE, cPercent);
3928	cPercent = cPercentNow;
3929	}
3930
3931	/* wait */
3932	rc = gProgress->WaitForCompletion(100);
3933	if (FAILED(rc))
3934	break;
3935	/// @todo process gui events.
3936	}
3937
3938	#else /* new loop which processes GUI events while saving. */
3939
3940	/* start regular timer so we don't starve in the event loop */
3941	SDL_TimerID sdlTimer;
3942	sdlTimer = SDL_AddTimer(100, StartupTimer, NULL);
3943
3944	for (;;)
3945	{
3946	/*
3947	* Check for completion.
3948	*/
3949	BOOL fCompleted = false;
3950	rc = gProgress->COMGETTER(Completed)(&fCompleted);
3951	if (FAILED(rc) \|\| fCompleted)
3952	break;
3953	ULONG cPercentNow;
3954	rc = gProgress->COMGETTER(Percent)(&cPercentNow);
3955	if (FAILED(rc))
3956	break;
3957	if (cPercentNow != cPercent)
3958	{
3959	UpdateTitlebar(TITLEBAR_SAVE, cPercent);
3960	cPercent = cPercentNow;
3961	}
3962
3963	/*
3964	* Wait for and process GUI a event.
3965	* This is necessary for XPCOM IPC and for updating the
3966	* title bar on the Mac.
3967	*/
3968	SDL_Event event;
3969	if (WaitSDLEvent(&event))
3970	{
3971	switch (event.type)
3972	{
3973	/*
3974	* Timer event preventing us from getting stuck.
3975	*/
3976	case SDL_USER_EVENT_TIMER:
3977	break;
3978
3979	#ifdef USE_XPCOM_QUEUE_THREAD
3980	/*
3981	* User specific XPCOM event queue event
3982	*/
3983	case SDL_USER_EVENT_XPCOM_EVENTQUEUE:
3984	{
3985	LogFlow(("SDL_USER_EVENT_XPCOM_EVENTQUEUE: processing XPCOM event queue...\n"));
3986	eventQ->ProcessPendingEvents();
3987	signalXPCOMEventQueueThread();
3988	break;
3989	}
3990	#endif /* USE_XPCOM_QUEUE_THREAD */
3991
3992
3993	/*
3994	* Ignore all other events.
3995	*/
3996	case SDL_USER_EVENT_RESIZE:
3997	case SDL_USER_EVENT_TERMINATE:
3998	default:
3999	break;
4000	}
4001	}
4002	}
4003
4004	/* kill the timer */
4005	SDL_RemoveTimer(sdlTimer);
4006	sdlTimer = 0;
4007
4008	#endif /* RT_OS_DARWIN */
4009
4010	/*
4011	* What's the result of the operation?
4012	*/
4013	LONG lrc;
4014	rc = gProgress->COMGETTER(ResultCode)(&lrc);
4015	if (FAILED(rc))
4016	lrc = ~0;
4017	if (!lrc)
4018	{
4019	UpdateTitlebar(TITLEBAR_SAVE, 100);
4020	RTThreadYield();
4021	RTPrintf("Saved the state successfully.\n");
4022	}
4023	else
4024	RTPrintf("Error saving state, lrc=%d (%#x)\n", lrc, lrc);
4025	}
4026
4027	/**
4028	* Build the titlebar string
4029	*/
4030	static void UpdateTitlebar(TitlebarMode mode, uint32_t u32User)
4031	{
4032	static char szTitle[1024] = {0};
4033
4034	/* back up current title */
4035	char szPrevTitle[1024];
4036	strcpy(szPrevTitle, szTitle);
4037
4038	Bstr name;
4039	gMachine->COMGETTER(Name)(name.asOutParam());
4040
4041	RTStrPrintf(szTitle, sizeof(szTitle), "%s - " VBOX_PRODUCT,
4042	!name.isEmpty() ? Utf8Str(name).c_str() : "<noname>");
4043
4044	/* which mode are we in? */
4045	switch (mode)
4046	{
4047	case TITLEBAR_NORMAL:
4048	{
4049	MachineState_T machineState;
4050	gMachine->COMGETTER(State)(&machineState);
4051	if (machineState == MachineState_Paused)
4052	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle), " - [Paused]");
4053
4054	if (gfGrabbed)
4055	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle), " - [Input captured]");
4056
4057	#if defined(DEBUG) \|\| defined(VBOX_WITH_STATISTICS)
4058	// do we have a debugger interface
4059	if (gMachineDebugger)
4060	{
4061	// query the machine state
4062	BOOL recompileSupervisor = FALSE;
4063	BOOL recompileUser = FALSE;
4064	BOOL patmEnabled = FALSE;
4065	BOOL csamEnabled = FALSE;
4066	BOOL singlestepEnabled = FALSE;
4067	BOOL logEnabled = FALSE;
4068	BOOL hwVirtEnabled = FALSE;
4069	ULONG virtualTimeRate = 100;
4070	gMachineDebugger->COMGETTER(RecompileSupervisor)(&recompileSupervisor);
4071	gMachineDebugger->COMGETTER(RecompileUser)(&recompileUser);
4072	gMachineDebugger->COMGETTER(PATMEnabled)(&patmEnabled);
4073	gMachineDebugger->COMGETTER(CSAMEnabled)(&csamEnabled);
4074	gMachineDebugger->COMGETTER(LogEnabled)(&logEnabled);
4075	gMachineDebugger->COMGETTER(Singlestep)(&singlestepEnabled);
4076	gMachineDebugger->COMGETTER(HWVirtExEnabled)(&hwVirtEnabled);
4077	gMachineDebugger->COMGETTER(VirtualTimeRate)(&virtualTimeRate);
4078	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
4079	" [STEP=%d CS=%d PAT=%d RR0=%d RR3=%d LOG=%d HWVirt=%d",
4080	singlestepEnabled == TRUE, csamEnabled == TRUE, patmEnabled == TRUE,
4081	recompileSupervisor == FALSE, recompileUser == FALSE,
4082	logEnabled == TRUE, hwVirtEnabled == TRUE);
4083	char *psz = strchr(szTitle, '\0');
4084	if (virtualTimeRate != 100)
4085	RTStrPrintf(psz, &szTitle[sizeof(szTitle)] - psz, " WD=%d%%]", virtualTimeRate);
4086	else
4087	RTStrPrintf(psz, &szTitle[sizeof(szTitle)] - psz, "]");
4088	}
4089	#endif /* DEBUG \|\| VBOX_WITH_STATISTICS */
4090	break;
4091	}
4092
4093	case TITLEBAR_STARTUP:
4094	{
4095	/*
4096	* Format it.
4097	*/
4098	MachineState_T machineState;
4099	gMachine->COMGETTER(State)(&machineState);
4100	if (machineState == MachineState_Starting)
4101	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
4102	" - Starting...");
4103	else if (machineState == MachineState_Restoring)
4104	{
4105	ULONG cPercentNow;
4106	HRESULT rc = gProgress->COMGETTER(Percent)(&cPercentNow);
4107	if (SUCCEEDED(rc))
4108	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
4109	" - Restoring %d%%...", (int)cPercentNow);
4110	else
4111	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
4112	" - Restoring...");
4113	}
4114	else if (machineState == MachineState_TeleportingIn)
4115	{
4116	ULONG cPercentNow;
4117	HRESULT rc = gProgress->COMGETTER(Percent)(&cPercentNow);
4118	if (SUCCEEDED(rc))
4119	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
4120	" - Teleporting %d%%...", (int)cPercentNow);
4121	else
4122	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
4123	" - Teleporting...");
4124	}
4125	/* ignore other states, we could already be in running or aborted state */
4126	break;
4127	}
4128
4129	case TITLEBAR_SAVE:
4130	{
4131	AssertMsg(u32User <= 100, ("%d\n", u32User));
4132	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
4133	" - Saving %d%%...", u32User);
4134	break;
4135	}
4136
4137	case TITLEBAR_SNAPSHOT:
4138	{
4139	AssertMsg(u32User <= 100, ("%d\n", u32User));
4140	RTStrPrintf(szTitle + strlen(szTitle), sizeof(szTitle) - strlen(szTitle),
4141	" - Taking snapshot %d%%...", u32User);
4142	break;
4143	}
4144
4145	default:
4146	RTPrintf("Error: Invalid title bar mode %d!\n", mode);
4147	return;
4148	}
4149
4150	/*
4151	* Don't update if it didn't change.
4152	*/
4153	if (!strcmp(szTitle, szPrevTitle))
4154	return;
4155
4156	/*
4157	* Set the new title
4158	*/
4159	#ifdef VBOX_WIN32_UI
4160	setUITitle(szTitle);
4161	#else
4162	SDL_WM_SetCaption(szTitle, VBOX_PRODUCT);
4163	#endif
4164	}
4165
4166	#if 0
4167	static void vbox_show_shape (unsigned short w, unsigned short h,
4168	uint32_t bg, const uint8_t *image)
4169	{
4170	size_t x, y;
4171	unsigned short pitch;
4172	const uint32_t *color;
4173	const uint8_t *mask;
4174	size_t size_mask;
4175
4176	mask = image;
4177	pitch = (w + 7) / 8;
4178	size_mask = (pitch * h + 3) & ~3;
4179
4180	color = (const uint32_t *)(image + size_mask);
4181
4182	printf("show_shape %dx%d pitch %d size mask %d\n",
4183	w, h, pitch, size_mask);
4184	for (y = 0; y < h; ++y, mask += pitch, color += w)
4185	{
4186	for (x = 0; x < w; ++x) {
4187	if (mask[x / 8] & (1 << (7 - (x % 8))))
4188	printf(" ");
4189	else
4190	{
4191	uint32_t c = color[x];
4192	if (c == bg)
4193	printf("Y");
4194	else
4195	printf("X");
4196	}
4197	}
4198	printf("\n");
4199	}
4200	}
4201	#endif
4202
4203	/**
4204	* Sets the pointer shape according to parameters.
4205	* Must be called only from the main SDL thread.
4206	*/
4207	static void SetPointerShape(const PointerShapeChangeData *data)
4208	{
4209	/*
4210	* don't allow to change the pointer shape if we are outside the valid
4211	* guest area. In that case set standard mouse pointer is set and should
4212	* not get overridden.
4213	*/
4214	if (gpOffCursor)
4215	return;
4216
4217	if (data->shape.size() > 0)
4218	{
4219	bool ok = false;
4220
4221	uint32_t andMaskSize = (data->width + 7) / 8 * data->height;
4222	uint32_t srcShapePtrScan = data->width * 4;
4223
4224	const uint8_t* shape = data->shape.raw();
4225	const uint8_t *srcAndMaskPtr = shape;
4226	const uint8_t *srcShapePtr = shape + ((andMaskSize + 3) & ~3);
4227
4228	#if 0
4229	/* pointer debugging code */
4230	// vbox_show_shape(data->width, data->height, 0, data->shape);
4231	uint32_t shapeSize = ((((data->width + 7) / 8) * data->height + 3) & ~3) + data->width * 4 * data->height;
4232	printf("visible: %d\n", data->visible);
4233	printf("width = %d\n", data->width);
4234	printf("height = %d\n", data->height);
4235	printf("alpha = %d\n", data->alpha);
4236	printf("xhot = %d\n", data->xHot);
4237	printf("yhot = %d\n", data->yHot);
4238	printf("uint8_t pointerdata[] = { ");
4239	for (uint32_t i = 0; i < shapeSize; i++)
4240	{
4241	printf("0x%x, ", data->shape[i]);
4242	}
4243	printf("};\n");
4244	#endif
4245
4246	#if defined(RT_OS_WINDOWS)
4247
4248	BITMAPV5HEADER bi;
4249	HBITMAP hBitmap;
4250	void *lpBits;
4251	HCURSOR hAlphaCursor = NULL;
4252
4253	::ZeroMemory(&bi, sizeof(BITMAPV5HEADER));
4254	bi.bV5Size = sizeof(BITMAPV5HEADER);
4255	bi.bV5Width = data->width;
4256	bi.bV5Height = -(LONG)data->height;
4257	bi.bV5Planes = 1;
4258	bi.bV5BitCount = 32;
4259	bi.bV5Compression = BI_BITFIELDS;
4260	// specifiy a supported 32 BPP alpha format for Windows XP
4261	bi.bV5RedMask = 0x00FF0000;
4262	bi.bV5GreenMask = 0x0000FF00;
4263	bi.bV5BlueMask = 0x000000FF;
4264	if (data->alpha)
4265	bi.bV5AlphaMask = 0xFF000000;
4266	else
4267	bi.bV5AlphaMask = 0;
4268
4269	HDC hdc = ::GetDC(NULL);
4270
4271	// create the DIB section with an alpha channel
4272	hBitmap = ::CreateDIBSection(hdc, (BITMAPINFO *)&bi, DIB_RGB_COLORS,
4273	(void **)&lpBits, NULL, (DWORD)0);
4274
4275	::ReleaseDC(NULL, hdc);
4276
4277	HBITMAP hMonoBitmap = NULL;
4278	if (data->alpha)
4279	{
4280	// create an empty mask bitmap
4281	hMonoBitmap = ::CreateBitmap(data->width, data->height, 1, 1, NULL);
4282	}
4283	else
4284	{
4285	/* Word aligned AND mask. Will be allocated and created if necessary. */
4286	uint8_t *pu8AndMaskWordAligned = NULL;
4287
4288	/* Width in bytes of the original AND mask scan line. */
4289	uint32_t cbAndMaskScan = (data->width + 7) / 8;
4290
4291	if (cbAndMaskScan & 1)
4292	{
4293	/* Original AND mask is not word aligned. */
4294
4295	/* Allocate memory for aligned AND mask. */
4296	pu8AndMaskWordAligned = (uint8_t )RTMemTmpAllocZ((cbAndMaskScan + 1) data->height);
4297
4298	Assert(pu8AndMaskWordAligned);
4299
4300	if (pu8AndMaskWordAligned)
4301	{
4302	/* According to MSDN the padding bits must be 0.
4303	* Compute the bit mask to set padding bits to 0 in the last byte of original AND mask.
4304	*/
4305	uint32_t u32PaddingBits = cbAndMaskScan * 8 - data->width;
4306	Assert(u32PaddingBits < 8);
4307	uint8_t u8LastBytesPaddingMask = (uint8_t)(0xFF << u32PaddingBits);
4308
4309	Log(("u8LastBytesPaddingMask = %02X, aligned w = %d, width = %d, cbAndMaskScan = %d\n",
4310	u8LastBytesPaddingMask, (cbAndMaskScan + 1) * 8, data->width, cbAndMaskScan));
4311
4312	uint8_t src = (uint8_t )srcAndMaskPtr;
4313	uint8_t *dst = pu8AndMaskWordAligned;
4314
4315	unsigned i;
4316	for (i = 0; i < data->height; i++)
4317	{
4318	memcpy(dst, src, cbAndMaskScan);
4319
4320	dst[cbAndMaskScan - 1] &= u8LastBytesPaddingMask;
4321
4322	src += cbAndMaskScan;
4323	dst += cbAndMaskScan + 1;
4324	}
4325	}
4326	}
4327
4328	// create the AND mask bitmap
4329	hMonoBitmap = ::CreateBitmap(data->width, data->height, 1, 1,
4330	pu8AndMaskWordAligned? pu8AndMaskWordAligned: srcAndMaskPtr);
4331
4332	if (pu8AndMaskWordAligned)
4333	{
4334	RTMemTmpFree(pu8AndMaskWordAligned);
4335	}
4336	}
4337
4338	Assert(hBitmap);
4339	Assert(hMonoBitmap);
4340	if (hBitmap && hMonoBitmap)
4341	{
4342	DWORD dstShapePtr = (DWORD )lpBits;
4343
4344	for (uint32_t y = 0; y < data->height; y ++)
4345	{
4346	memcpy(dstShapePtr, srcShapePtr, srcShapePtrScan);
4347	srcShapePtr += srcShapePtrScan;
4348	dstShapePtr += data->width;
4349	}
4350
4351	ICONINFO ii;
4352	ii.fIcon = FALSE;
4353	ii.xHotspot = data->xHot;
4354	ii.yHotspot = data->yHot;
4355	ii.hbmMask = hMonoBitmap;
4356	ii.hbmColor = hBitmap;
4357
4358	hAlphaCursor = ::CreateIconIndirect(&ii);
4359	Assert(hAlphaCursor);
4360	if (hAlphaCursor)
4361	{
4362	// here we do a dirty trick by substituting a Window Manager's
4363	// cursor handle with the handle we created
4364
4365	WMcursor *pCustomTempWMCursor = gpCustomCursor->wm_cursor;
4366
4367	// see SDL12/src/video/wincommon/SDL_sysmouse.c
4368	void wm_cursor = malloc(sizeof(HCURSOR) + sizeof(uint8_t ) * 2);
4369	(HCURSOR )wm_cursor = hAlphaCursor;
4370
4371	gpCustomCursor->wm_cursor = (WMcursor *)wm_cursor;
4372	SDL_SetCursor(gpCustomCursor);
4373	SDL_ShowCursor(SDL_ENABLE);
4374
4375	if (pCustomTempWMCursor)
4376	{
4377	::DestroyCursor((HCURSOR )pCustomTempWMCursor);
4378	free(pCustomTempWMCursor);
4379	}
4380
4381	ok = true;
4382	}
4383	}
4384
4385	if (hMonoBitmap)
4386	::DeleteObject(hMonoBitmap);
4387	if (hBitmap)
4388	::DeleteObject(hBitmap);
4389
4390	#elif defined(VBOXSDL_WITH_X11) && !defined(VBOX_WITHOUT_XCURSOR)
4391
4392	if (gfXCursorEnabled)
4393	{
4394	XcursorImage *img = XcursorImageCreate(data->width, data->height);
4395	Assert(img);
4396	if (img)
4397	{
4398	img->xhot = data->xHot;
4399	img->yhot = data->yHot;
4400
4401	XcursorPixel *dstShapePtr = img->pixels;
4402
4403	for (uint32_t y = 0; y < data->height; y ++)
4404	{
4405	memcpy(dstShapePtr, srcShapePtr, srcShapePtrScan);
4406
4407	if (!data->alpha)
4408	{
4409	// convert AND mask to the alpha channel
4410	uint8_t byte = 0;
4411	for (uint32_t x = 0; x < data->width; x ++)
4412	{
4413	if (!(x % 8))
4414	byte = *(srcAndMaskPtr ++);
4415	else
4416	byte <<= 1;
4417
4418	if (byte & 0x80)
4419	{
4420	// Linux doesn't support inverted pixels (XOR ops,
4421	// to be exact) in cursor shapes, so we detect such
4422	// pixels and always replace them with black ones to
4423	// make them visible at least over light colors
4424	if (dstShapePtr [x] & 0x00FFFFFF)
4425	dstShapePtr [x] = 0xFF000000;
4426	else
4427	dstShapePtr [x] = 0x00000000;
4428	}
4429	else
4430	dstShapePtr [x] \|= 0xFF000000;
4431	}
4432	}
4433
4434	srcShapePtr += srcShapePtrScan;
4435	dstShapePtr += data->width;
4436	}
4437
4438	#ifndef VBOX_WITH_SDL13
4439	Cursor cur = XcursorImageLoadCursor(gSdlInfo.info.x11.display, img);
4440	Assert(cur);
4441	if (cur)
4442	{
4443	// here we do a dirty trick by substituting a Window Manager's
4444	// cursor handle with the handle we created
4445
4446	WMcursor *pCustomTempWMCursor = gpCustomCursor->wm_cursor;
4447
4448	// see SDL12/src/video/x11/SDL_x11mouse.c
4449	void *wm_cursor = malloc(sizeof(Cursor));
4450	(Cursor )wm_cursor = cur;
4451
4452	gpCustomCursor->wm_cursor = (WMcursor *)wm_cursor;
4453	SDL_SetCursor(gpCustomCursor);
4454	SDL_ShowCursor(SDL_ENABLE);
4455
4456	if (pCustomTempWMCursor)
4457	{
4458	XFreeCursor(gSdlInfo.info.x11.display, (Cursor )pCustomTempWMCursor);
4459	free(pCustomTempWMCursor);
4460	}
4461
4462	ok = true;
4463	}
4464	#endif
4465	}
4466	XcursorImageDestroy(img);
4467	}
4468
4469	#endif /* VBOXSDL_WITH_X11 && !VBOX_WITHOUT_XCURSOR */
4470
4471	if (!ok)
4472	{
4473	SDL_SetCursor(gpDefaultCursor);
4474	SDL_ShowCursor(SDL_ENABLE);
4475	}
4476	}
4477	else
4478	{
4479	if (data->visible)
4480	SDL_ShowCursor(SDL_ENABLE);
4481	else if (gfAbsoluteMouseGuest)
4482	/* Don't disable the cursor if the guest additions are not active (anymore) */
4483	SDL_ShowCursor(SDL_DISABLE);
4484	}
4485	}
4486
4487	/**
4488	* Handle changed mouse capabilities
4489	*/
4490	static void HandleGuestCapsChanged(void)
4491	{
4492	if (!gfAbsoluteMouseGuest)
4493	{
4494	// Cursor could be overwritten by the guest tools
4495	SDL_SetCursor(gpDefaultCursor);
4496	SDL_ShowCursor(SDL_ENABLE);
4497	gpOffCursor = NULL;
4498	}
4499	if (gMouse && UseAbsoluteMouse())
4500	{
4501	// Actually switch to absolute coordinates
4502	if (gfGrabbed)
4503	InputGrabEnd();
4504	gMouse->PutMouseEventAbsolute(-1, -1, 0, 0, 0);
4505	}
4506	}
4507
4508	/**
4509	* Handles a host key down event
4510	*/
4511	static int HandleHostKey(const SDL_KeyboardEvent *pEv)
4512	{
4513	/*
4514	* Revalidate the host key modifier
4515	*/
4516	if ((SDL_GetModState() & ~(KMOD_MODE \| KMOD_NUM \| KMOD_RESERVED)) != gHostKeyMod)
4517	return VERR_NOT_SUPPORTED;
4518
4519	/*
4520	* What was pressed?
4521	*/
4522	switch (pEv->keysym.sym)
4523	{
4524	/* Control-Alt-Delete */
4525	case SDLK_DELETE:
4526	{
4527	gKeyboard->PutCAD();
4528	break;
4529	}
4530
4531	/*
4532	* Fullscreen / Windowed toggle.
4533	*/
4534	case SDLK_f:
4535	{
4536	if ( strchr(gHostKeyDisabledCombinations, 'f')
4537	\|\| !gfAllowFullscreenToggle)
4538	return VERR_NOT_SUPPORTED;
4539
4540	/*
4541	* We have to pause/resume the machine during this
4542	* process because there might be a short moment
4543	* without a valid framebuffer
4544	*/
4545	MachineState_T machineState;
4546	gMachine->COMGETTER(State)(&machineState);
4547	bool fPauseIt = machineState == MachineState_Running
4548	\|\| machineState == MachineState_Teleporting
4549	\|\| machineState == MachineState_LiveSnapshotting;
4550	if (fPauseIt)
4551	gConsole->Pause();
4552	SetFullscreen(!gpFramebuffer[0]->getFullscreen());
4553	if (fPauseIt)
4554	gConsole->Resume();
4555
4556	/*
4557	* We have switched from/to fullscreen, so request a full
4558	* screen repaint, just to be sure.
4559	*/
4560	gDisplay->InvalidateAndUpdate();
4561	break;
4562	}
4563
4564	/*
4565	* Pause / Resume toggle.
4566	*/
4567	case SDLK_p:
4568	{
4569	if (strchr(gHostKeyDisabledCombinations, 'p'))
4570	return VERR_NOT_SUPPORTED;
4571
4572	MachineState_T machineState;
4573	gMachine->COMGETTER(State)(&machineState);
4574	if ( machineState == MachineState_Running
4575	\|\| machineState == MachineState_Teleporting
4576	\|\| machineState == MachineState_LiveSnapshotting
4577	)
4578	{
4579	if (gfGrabbed)
4580	InputGrabEnd();
4581	gConsole->Pause();
4582	}
4583	else if (machineState == MachineState_Paused)
4584	{
4585	gConsole->Resume();
4586	}
4587	UpdateTitlebar(TITLEBAR_NORMAL);
4588	break;
4589	}
4590
4591	/*
4592	* Reset the VM
4593	*/
4594	case SDLK_r:
4595	{
4596	if (strchr(gHostKeyDisabledCombinations, 'r'))
4597	return VERR_NOT_SUPPORTED;
4598
4599	ResetVM();
4600	break;
4601	}
4602
4603	/*
4604	* Terminate the VM
4605	*/
4606	case SDLK_q:
4607	{
4608	if (strchr(gHostKeyDisabledCombinations, 'q'))
4609	return VERR_NOT_SUPPORTED;
4610
4611	return VINF_EM_TERMINATE;
4612	}
4613
4614	/*
4615	* Save the machine's state and exit
4616	*/
4617	case SDLK_s:
4618	{
4619	if (strchr(gHostKeyDisabledCombinations, 's'))
4620	return VERR_NOT_SUPPORTED;
4621
4622	SaveState();
4623	return VINF_EM_TERMINATE;
4624	}
4625
4626	case SDLK_h:
4627	{
4628	if (strchr(gHostKeyDisabledCombinations, 'h'))
4629	return VERR_NOT_SUPPORTED;
4630
4631	if (gConsole)
4632	gConsole->PowerButton();
4633	break;
4634	}
4635
4636	/*
4637	* Perform an online snapshot. Continue operation.
4638	*/
4639	case SDLK_n:
4640	{
4641	if (strchr(gHostKeyDisabledCombinations, 'n'))
4642	return VERR_NOT_SUPPORTED;
4643
4644	RTThreadYield();
4645	ULONG cSnapshots = 0;
4646	gMachine->COMGETTER(SnapshotCount)(&cSnapshots);
4647	char pszSnapshotName[20];
4648	RTStrPrintf(pszSnapshotName, sizeof(pszSnapshotName), "Snapshot %d", cSnapshots + 1);
4649	gProgress = NULL;
4650	HRESULT rc;
4651	CHECK_ERROR(gConsole, TakeSnapshot(Bstr(pszSnapshotName).raw(),
4652	Bstr("Taken by VBoxSDL").raw(),
4653	gProgress.asOutParam()));
4654	if (FAILED(rc))
4655	{
4656	RTPrintf("Error taking snapshot! rc = 0x%x\n", rc);
4657	/* continue operation */
4658	return VINF_SUCCESS;
4659	}
4660	/*
4661	* Wait for the operation to be completed and work
4662	* the title bar in the mean while.
4663	*/
4664	ULONG cPercent = 0;
4665	for (;;)
4666	{
4667	BOOL fCompleted = false;
4668	rc = gProgress->COMGETTER(Completed)(&fCompleted);
4669	if (FAILED(rc) \|\| fCompleted)
4670	break;
4671	ULONG cPercentNow;
4672	rc = gProgress->COMGETTER(Percent)(&cPercentNow);
4673	if (FAILED(rc))
4674	break;
4675	if (cPercentNow != cPercent)
4676	{
4677	UpdateTitlebar(TITLEBAR_SNAPSHOT, cPercent);
4678	cPercent = cPercentNow;
4679	}
4680
4681	/* wait */
4682	rc = gProgress->WaitForCompletion(100);
4683	if (FAILED(rc))
4684	break;
4685	/// @todo process gui events.
4686	}
4687
4688	/* continue operation */
4689	return VINF_SUCCESS;
4690	}
4691
4692	case SDLK_F1: case SDLK_F2: case SDLK_F3:
4693	case SDLK_F4: case SDLK_F5: case SDLK_F6:
4694	case SDLK_F7: case SDLK_F8: case SDLK_F9:
4695	case SDLK_F10: case SDLK_F11: case SDLK_F12:
4696	{
4697	// /* send Ctrl-Alt-Fx to guest */
4698	com::SafeArray<LONG> keys(6);
4699
4700	keys[0] = 0x1d; // Ctrl down
4701	keys[1] = 0x38; // Alt down
4702	keys[2] = Keyevent2Keycode(pEv); // Fx down
4703	keys[3] = keys[2] + 0x80; // Fx up
4704	keys[4] = 0xb8; // Alt up
4705	keys[5] = 0x9d; // Ctrl up
4706
4707	gKeyboard->PutScancodes(ComSafeArrayAsInParam(keys), NULL);
4708	return VINF_SUCCESS;
4709	}
4710
4711	/*
4712	* Not a host key combination.
4713	* Indicate this by returning false.
4714	*/
4715	default:
4716	return VERR_NOT_SUPPORTED;
4717	}
4718
4719	return VINF_SUCCESS;
4720	}
4721
4722	/**
4723	* Timer callback function for startup processing
4724	*/
4725	static Uint32 StartupTimer(Uint32 interval, void *param)
4726	{
4727	/* post message so we can do something in the startup loop */
4728	SDL_Event event = {0};
4729	event.type = SDL_USEREVENT;
4730	event.user.type = SDL_USER_EVENT_TIMER;
4731	SDL_PushEvent(&event);
4732	RTSemEventSignal(g_EventSemSDLEvents);
4733	return interval;
4734	}
4735
4736	/**
4737	* Timer callback function to check if resizing is finished
4738	*/
4739	static Uint32 ResizeTimer(Uint32 interval, void *param)
4740	{
4741	/* post message so the window is actually resized */
4742	SDL_Event event = {0};
4743	event.type = SDL_USEREVENT;
4744	event.user.type = SDL_USER_EVENT_WINDOW_RESIZE_DONE;
4745	PushSDLEventForSure(&event);
4746	/* one-shot */
4747	return 0;
4748	}
4749
4750	/**
4751	* Timer callback function to check if an ACPI power button event was handled by the guest.
4752	*/
4753	static Uint32 QuitTimer(Uint32 interval, void *param)
4754	{
4755	BOOL fHandled = FALSE;
4756
4757	gSdlQuitTimer = NULL;
4758	if (gConsole)
4759	{
4760	int rc = gConsole->GetPowerButtonHandled(&fHandled);
4761	LogRel(("QuitTimer: rc=%d handled=%d\n", rc, fHandled));
4762	if (RT_FAILURE(rc) \|\| !fHandled)
4763	{
4764	/* event was not handled, power down the guest */
4765	gfACPITerm = FALSE;
4766	SDL_Event event = {0};
4767	event.type = SDL_QUIT;
4768	PushSDLEventForSure(&event);
4769	}
4770	}
4771	/* one-shot */
4772	return 0;
4773	}
4774
4775	/**
4776	* Wait for the next SDL event. Don't use SDL_WaitEvent since this function
4777	* calls SDL_Delay(10) if the event queue is empty.
4778	*/
4779	static int WaitSDLEvent(SDL_Event *event)
4780	{
4781	for (;;)
4782	{
4783	int rc = SDL_PollEvent(event);
4784	if (rc == 1)
4785	{
4786	#ifdef USE_XPCOM_QUEUE_THREAD
4787	if (event->type == SDL_USER_EVENT_XPCOM_EVENTQUEUE)
4788	consumedXPCOMUserEvent();
4789	#endif
4790	return 1;
4791	}
4792	/* Immediately wake up if new SDL events are available. This does not
4793	* work for internal SDL events. Don't wait more than 10ms. */
4794	RTSemEventWait(g_EventSemSDLEvents, 10);
4795	}
4796	}
4797
4798	/**
4799	* Ensure that an SDL event is really enqueued. Try multiple times if necessary.
4800	*/
4801	int PushSDLEventForSure(SDL_Event *event)
4802	{
4803	int ntries = 10;
4804	for (; ntries > 0; ntries--)
4805	{
4806	int rc = SDL_PushEvent(event);
4807	RTSemEventSignal(g_EventSemSDLEvents);
4808	#ifdef VBOX_WITH_SDL13
4809	if (rc == 1)
4810	#else
4811	if (rc == 0)
4812	#endif
4813	return 0;
4814	Log(("PushSDLEventForSure: waiting for 2ms (rc = %d)\n", rc));
4815	RTThreadSleep(2);
4816	}
4817	LogRel(("WARNING: Failed to enqueue SDL event %d.%d!\n",
4818	event->type, event->type == SDL_USEREVENT ? event->user.type : 0));
4819	return -1;
4820	}
4821
4822	#ifdef VBOXSDL_WITH_X11
4823	/**
4824	* Special SDL_PushEvent function for NotifyUpdate events. These events may occur in bursts
4825	* so make sure they don't flood the SDL event queue.
4826	*/
4827	void PushNotifyUpdateEvent(SDL_Event *event)
4828	{
4829	int rc = SDL_PushEvent(event);
4830	#ifdef VBOX_WITH_SDL13
4831	bool fSuccess = (rc == 1);
4832	#else
4833	bool fSuccess = (rc == 0);
4834	#endif
4835
4836	RTSemEventSignal(g_EventSemSDLEvents);
4837	AssertMsg(fSuccess, ("SDL_PushEvent returned SDL error\n"));
4838	/* A global counter is faster than SDL_PeepEvents() */
4839	if (fSuccess)
4840	ASMAtomicIncS32(&g_cNotifyUpdateEventsPending);
4841	/* In order to not flood the SDL event queue, yield the CPU or (if there are already many
4842	* events queued) even sleep */
4843	if (g_cNotifyUpdateEventsPending > 96)
4844	{
4845	/* Too many NotifyUpdate events, sleep for a small amount to give the main thread time
4846	* to handle these events. The SDL queue can hold up to 128 events. */
4847	Log(("PushNotifyUpdateEvent: Sleep 1ms\n"));
4848	RTThreadSleep(1);
4849	}
4850	else
4851	RTThreadYield();
4852	}
4853	#endif /* VBOXSDL_WITH_X11 */
4854
4855	/**
4856	*
4857	*/
4858	static void SetFullscreen(bool enable)
4859	{
4860	if (enable == gpFramebuffer[0]->getFullscreen())
4861	return;
4862
4863	if (!gfFullscreenResize)
4864	{
4865	/*
4866	* The old/default way: SDL will resize the host to fit the guest screen resolution.
4867	*/
4868	gpFramebuffer[0]->setFullscreen(enable);
4869	}
4870	else
4871	{
4872	/*
4873	* The alternate way: Switch to fullscreen with the host screen resolution and adapt
4874	* the guest screen resolution to the host window geometry.
4875	*/
4876	uint32_t NewWidth = 0, NewHeight = 0;
4877	if (enable)
4878	{
4879	/* switch to fullscreen */
4880	gmGuestNormalXRes = gpFramebuffer[0]->getGuestXRes();
4881	gmGuestNormalYRes = gpFramebuffer[0]->getGuestYRes();
4882	gpFramebuffer[0]->getFullscreenGeometry(&NewWidth, &NewHeight);
4883	}
4884	else
4885	{
4886	/* switch back to saved geometry */
4887	NewWidth = gmGuestNormalXRes;
4888	NewHeight = gmGuestNormalYRes;
4889	}
4890	if (NewWidth != 0 && NewHeight != 0)
4891	{
4892	gpFramebuffer[0]->setFullscreen(enable);
4893	gfIgnoreNextResize = TRUE;
4894	gDisplay->SetVideoModeHint(NewWidth, NewHeight, 0, 0);
4895	}
4896	}
4897	}
4898
4899	#ifdef VBOX_WITH_SDL13
4900	static VBoxSDLFB * getFbFromWinId(SDL_WindowID id)
4901	{
4902	for (unsigned i = 0; i < gcMonitors; i++)
4903	if (gpFramebuffer[i]->hasWindow(id))
4904	return gpFramebuffer[i];
4905
4906	return NULL;
4907	}
4908	#endif

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Frontends/VBoxSDL/VBoxSDL.cpp@ 32718

Download in other formats: