VirtualBox

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

Last change on this file since 54608 was 53624, checked in by vboxsync, 10 years ago

scm automatic cleanups.

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