VirtualBox

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

Last change on this file since 34575 was 33976, checked in by vboxsync, 14 years ago

now for real

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette