VirtualBox

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

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

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