VBoxSDL.cpp@ 1055

Last change on this file since 1055 was 967, checked in by vboxsync, 18 years ago
XPCOM event queue stuff.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 142.8 KB

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

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

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

Download in other formats: