VirtualBox

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

Last change on this file since 91131 was 86650, checked in by vboxsync, 4 years ago

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