2 * QEMU Cocoa CG display driver
4 * Copyright (c) 2008 Mike Kronenberg
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
27 #import <Cocoa/Cocoa.h>
28 #include <crt_externs.h>
30 #include "qemu-common.h"
31 #include "ui/console.h"
33 #include "sysemu/sysemu.h"
34 #include "sysemu/runstate.h"
35 #include "sysemu/cpu-throttle.h"
36 #include "qapi/error.h"
37 #include "qapi/qapi-commands-block.h"
38 #include "qapi/qapi-commands-machine.h"
39 #include "qapi/qapi-commands-misc.h"
40 #include "sysemu/blockdev.h"
41 #include "qemu-version.h"
42 #include "qemu/main-loop.h"
43 #include "qemu/module.h"
44 #include <Carbon/Carbon.h>
45 #include "hw/core/cpu.h"
47 #ifndef MAC_OS_X_VERSION_10_13
48 #define MAC_OS_X_VERSION_10_13 101300
51 /* 10.14 deprecates NSOnState and NSOffState in favor of
52 * NSControlStateValueOn/Off, which were introduced in 10.13.
53 * Define for older versions
55 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_13
56 #define NSControlStateValueOn NSOnState
57 #define NSControlStateValueOff NSOffState
63 #define COCOA_DEBUG(...) { (void) fprintf (stdout, __VA_ARGS__); }
65 #define COCOA_DEBUG(...) ((void) 0)
68 #define cgrect(nsrect) (*(CGRect *)&(nsrect))
77 NSWindow *normalWindow, *about_window;
78 static DisplayChangeListener *dcl;
79 static int last_buttons;
80 static int cursor_hide = 1;
85 NSTextField *pauseLabel;
86 NSArray * supportedImageFileTypes;
88 static QemuSemaphore display_init_sem;
89 static QemuSemaphore app_started_sem;
90 static bool allow_events;
92 // Utility functions to run specified code block with iothread lock held
93 typedef void (^CodeBlock)(void);
94 typedef bool (^BoolCodeBlock)(void);
96 static void with_iothread_lock(CodeBlock block)
98 bool locked = qemu_mutex_iothread_locked();
100 qemu_mutex_lock_iothread();
104 qemu_mutex_unlock_iothread();
108 static bool bool_with_iothread_lock(BoolCodeBlock block)
110 bool locked = qemu_mutex_iothread_locked();
114 qemu_mutex_lock_iothread();
118 qemu_mutex_unlock_iothread();
123 // Mac to QKeyCode conversion
124 const int mac_to_qkeycode_map[] = {
125 [kVK_ANSI_A] = Q_KEY_CODE_A,
126 [kVK_ANSI_B] = Q_KEY_CODE_B,
127 [kVK_ANSI_C] = Q_KEY_CODE_C,
128 [kVK_ANSI_D] = Q_KEY_CODE_D,
129 [kVK_ANSI_E] = Q_KEY_CODE_E,
130 [kVK_ANSI_F] = Q_KEY_CODE_F,
131 [kVK_ANSI_G] = Q_KEY_CODE_G,
132 [kVK_ANSI_H] = Q_KEY_CODE_H,
133 [kVK_ANSI_I] = Q_KEY_CODE_I,
134 [kVK_ANSI_J] = Q_KEY_CODE_J,
135 [kVK_ANSI_K] = Q_KEY_CODE_K,
136 [kVK_ANSI_L] = Q_KEY_CODE_L,
137 [kVK_ANSI_M] = Q_KEY_CODE_M,
138 [kVK_ANSI_N] = Q_KEY_CODE_N,
139 [kVK_ANSI_O] = Q_KEY_CODE_O,
140 [kVK_ANSI_P] = Q_KEY_CODE_P,
141 [kVK_ANSI_Q] = Q_KEY_CODE_Q,
142 [kVK_ANSI_R] = Q_KEY_CODE_R,
143 [kVK_ANSI_S] = Q_KEY_CODE_S,
144 [kVK_ANSI_T] = Q_KEY_CODE_T,
145 [kVK_ANSI_U] = Q_KEY_CODE_U,
146 [kVK_ANSI_V] = Q_KEY_CODE_V,
147 [kVK_ANSI_W] = Q_KEY_CODE_W,
148 [kVK_ANSI_X] = Q_KEY_CODE_X,
149 [kVK_ANSI_Y] = Q_KEY_CODE_Y,
150 [kVK_ANSI_Z] = Q_KEY_CODE_Z,
152 [kVK_ANSI_0] = Q_KEY_CODE_0,
153 [kVK_ANSI_1] = Q_KEY_CODE_1,
154 [kVK_ANSI_2] = Q_KEY_CODE_2,
155 [kVK_ANSI_3] = Q_KEY_CODE_3,
156 [kVK_ANSI_4] = Q_KEY_CODE_4,
157 [kVK_ANSI_5] = Q_KEY_CODE_5,
158 [kVK_ANSI_6] = Q_KEY_CODE_6,
159 [kVK_ANSI_7] = Q_KEY_CODE_7,
160 [kVK_ANSI_8] = Q_KEY_CODE_8,
161 [kVK_ANSI_9] = Q_KEY_CODE_9,
163 [kVK_ANSI_Grave] = Q_KEY_CODE_GRAVE_ACCENT,
164 [kVK_ANSI_Minus] = Q_KEY_CODE_MINUS,
165 [kVK_ANSI_Equal] = Q_KEY_CODE_EQUAL,
166 [kVK_Delete] = Q_KEY_CODE_BACKSPACE,
167 [kVK_CapsLock] = Q_KEY_CODE_CAPS_LOCK,
168 [kVK_Tab] = Q_KEY_CODE_TAB,
169 [kVK_Return] = Q_KEY_CODE_RET,
170 [kVK_ANSI_LeftBracket] = Q_KEY_CODE_BRACKET_LEFT,
171 [kVK_ANSI_RightBracket] = Q_KEY_CODE_BRACKET_RIGHT,
172 [kVK_ANSI_Backslash] = Q_KEY_CODE_BACKSLASH,
173 [kVK_ANSI_Semicolon] = Q_KEY_CODE_SEMICOLON,
174 [kVK_ANSI_Quote] = Q_KEY_CODE_APOSTROPHE,
175 [kVK_ANSI_Comma] = Q_KEY_CODE_COMMA,
176 [kVK_ANSI_Period] = Q_KEY_CODE_DOT,
177 [kVK_ANSI_Slash] = Q_KEY_CODE_SLASH,
178 [kVK_Shift] = Q_KEY_CODE_SHIFT,
179 [kVK_RightShift] = Q_KEY_CODE_SHIFT_R,
180 [kVK_Control] = Q_KEY_CODE_CTRL,
181 [kVK_RightControl] = Q_KEY_CODE_CTRL_R,
182 [kVK_Option] = Q_KEY_CODE_ALT,
183 [kVK_RightOption] = Q_KEY_CODE_ALT_R,
184 [kVK_Command] = Q_KEY_CODE_META_L,
185 [0x36] = Q_KEY_CODE_META_R, /* There is no kVK_RightCommand */
186 [kVK_Space] = Q_KEY_CODE_SPC,
188 [kVK_ANSI_Keypad0] = Q_KEY_CODE_KP_0,
189 [kVK_ANSI_Keypad1] = Q_KEY_CODE_KP_1,
190 [kVK_ANSI_Keypad2] = Q_KEY_CODE_KP_2,
191 [kVK_ANSI_Keypad3] = Q_KEY_CODE_KP_3,
192 [kVK_ANSI_Keypad4] = Q_KEY_CODE_KP_4,
193 [kVK_ANSI_Keypad5] = Q_KEY_CODE_KP_5,
194 [kVK_ANSI_Keypad6] = Q_KEY_CODE_KP_6,
195 [kVK_ANSI_Keypad7] = Q_KEY_CODE_KP_7,
196 [kVK_ANSI_Keypad8] = Q_KEY_CODE_KP_8,
197 [kVK_ANSI_Keypad9] = Q_KEY_CODE_KP_9,
198 [kVK_ANSI_KeypadDecimal] = Q_KEY_CODE_KP_DECIMAL,
199 [kVK_ANSI_KeypadEnter] = Q_KEY_CODE_KP_ENTER,
200 [kVK_ANSI_KeypadPlus] = Q_KEY_CODE_KP_ADD,
201 [kVK_ANSI_KeypadMinus] = Q_KEY_CODE_KP_SUBTRACT,
202 [kVK_ANSI_KeypadMultiply] = Q_KEY_CODE_KP_MULTIPLY,
203 [kVK_ANSI_KeypadDivide] = Q_KEY_CODE_KP_DIVIDE,
204 [kVK_ANSI_KeypadEquals] = Q_KEY_CODE_KP_EQUALS,
205 [kVK_ANSI_KeypadClear] = Q_KEY_CODE_NUM_LOCK,
207 [kVK_UpArrow] = Q_KEY_CODE_UP,
208 [kVK_DownArrow] = Q_KEY_CODE_DOWN,
209 [kVK_LeftArrow] = Q_KEY_CODE_LEFT,
210 [kVK_RightArrow] = Q_KEY_CODE_RIGHT,
212 [kVK_Help] = Q_KEY_CODE_INSERT,
213 [kVK_Home] = Q_KEY_CODE_HOME,
214 [kVK_PageUp] = Q_KEY_CODE_PGUP,
215 [kVK_PageDown] = Q_KEY_CODE_PGDN,
216 [kVK_End] = Q_KEY_CODE_END,
217 [kVK_ForwardDelete] = Q_KEY_CODE_DELETE,
219 [kVK_Escape] = Q_KEY_CODE_ESC,
221 /* The Power key can't be used directly because the operating system uses
222 * it. This key can be emulated by using it in place of another key such as
223 * F1. Don't forget to disable the real key binding.
225 /* [kVK_F1] = Q_KEY_CODE_POWER, */
227 [kVK_F1] = Q_KEY_CODE_F1,
228 [kVK_F2] = Q_KEY_CODE_F2,
229 [kVK_F3] = Q_KEY_CODE_F3,
230 [kVK_F4] = Q_KEY_CODE_F4,
231 [kVK_F5] = Q_KEY_CODE_F5,
232 [kVK_F6] = Q_KEY_CODE_F6,
233 [kVK_F7] = Q_KEY_CODE_F7,
234 [kVK_F8] = Q_KEY_CODE_F8,
235 [kVK_F9] = Q_KEY_CODE_F9,
236 [kVK_F10] = Q_KEY_CODE_F10,
237 [kVK_F11] = Q_KEY_CODE_F11,
238 [kVK_F12] = Q_KEY_CODE_F12,
239 [kVK_F13] = Q_KEY_CODE_PRINT,
240 [kVK_F14] = Q_KEY_CODE_SCROLL_LOCK,
241 [kVK_F15] = Q_KEY_CODE_PAUSE,
244 * The eject and volume keys can't be used here because they are handled at
245 * a lower level than what an Application can see.
249 static int cocoa_keycode_to_qemu(int keycode)
251 if (ARRAY_SIZE(mac_to_qkeycode_map) <= keycode) {
252 fprintf(stderr, "(cocoa) warning unknown keycode 0x%x\n", keycode);
255 return mac_to_qkeycode_map[keycode];
258 /* Displays an alert dialog box with the specified message */
259 static void QEMU_Alert(NSString *message)
262 alert = [NSAlert new];
263 [alert setMessageText: message];
267 /* Handles any errors that happen with a device transaction */
268 static void handleAnyDeviceErrors(Error * err)
271 QEMU_Alert([NSString stringWithCString: error_get_pretty(err)
272 encoding: NSASCIIStringEncoding]);
278 ------------------------------------------------------
280 ------------------------------------------------------
282 @interface QemuCocoaView : NSView
285 NSWindow *fullScreenWindow;
286 float cx,cy,cw,ch,cdx,cdy;
287 CGDataProviderRef dataProviderRef;
288 pixman_image_t *pixman_image;
289 BOOL modifiers_state[256];
292 BOOL isAbsoluteEnabled;
293 BOOL isMouseDeassociated;
295 - (void) switchSurface:(pixman_image_t *)image;
297 - (void) ungrabMouse;
298 - (void) toggleFullScreen:(id)sender;
299 - (void) handleMonitorInput:(NSEvent *)event;
300 - (bool) handleEvent:(NSEvent *)event;
301 - (bool) handleEventLocked:(NSEvent *)event;
302 - (void) setAbsoluteEnabled:(BOOL)tIsAbsoluteEnabled;
303 /* The state surrounding mouse grabbing is potentially confusing.
304 * isAbsoluteEnabled tracks qemu_input_is_absolute() [ie "is the emulated
305 * pointing device an absolute-position one?"], but is only updated on
307 * isMouseGrabbed tracks whether GUI events are directed to the guest;
308 * it controls whether special keys like Cmd get sent to the guest,
309 * and whether we capture the mouse when in non-absolute mode.
310 * isMouseDeassociated tracks whether we've told MacOSX to disassociate
311 * the mouse and mouse cursor position by calling
312 * CGAssociateMouseAndMouseCursorPosition(FALSE)
313 * (which basically happens if we grab in non-absolute mode).
315 - (BOOL) isMouseGrabbed;
316 - (BOOL) isAbsoluteEnabled;
317 - (BOOL) isMouseDeassociated;
320 - (QEMUScreen) gscreen;
321 - (void) raiseAllKeys;
324 QemuCocoaView *cocoaView;
326 @implementation QemuCocoaView
327 - (id)initWithFrame:(NSRect)frameRect
329 COCOA_DEBUG("QemuCocoaView: initWithFrame\n");
331 self = [super initWithFrame:frameRect];
334 screen.bitsPerComponent = 8;
335 screen.bitsPerPixel = 32;
336 screen.width = frameRect.size.width;
337 screen.height = frameRect.size.height;
345 COCOA_DEBUG("QemuCocoaView: dealloc\n");
347 if (dataProviderRef) {
348 CGDataProviderRelease(dataProviderRef);
349 pixman_image_unref(pixman_image);
360 - (BOOL) screenContainsPoint:(NSPoint) p
362 return (p.x > -1 && p.x < screen.width && p.y > -1 && p.y < screen.height);
365 /* Get location of event and convert to virtual screen coordinate */
366 - (CGPoint) screenLocationOfEvent:(NSEvent *)ev
368 NSWindow *eventWindow = [ev window];
369 // XXX: Use CGRect and -convertRectFromScreen: to support macOS 10.10
370 CGRect r = CGRectZero;
371 r.origin = [ev locationInWindow];
374 return [[self window] convertRectFromScreen:r].origin;
376 CGPoint locationInSelfWindow = [[self window] convertRectFromScreen:r].origin;
377 CGPoint loc = [self convertPoint:locationInSelfWindow fromView:nil];
384 } else if ([[self window] isEqual:eventWindow]) {
388 CGPoint loc = [self convertPoint:r.origin fromView:nil];
396 return [[self window] convertRectFromScreen:[eventWindow convertRectToScreen:r]].origin;
408 - (void) unhideCursor
416 - (void) drawRect:(NSRect) rect
418 COCOA_DEBUG("QemuCocoaView: drawRect\n");
420 // get CoreGraphic context
421 CGContextRef viewContextRef = [[NSGraphicsContext currentContext] CGContext];
423 CGContextSetInterpolationQuality (viewContextRef, kCGInterpolationNone);
424 CGContextSetShouldAntialias (viewContextRef, NO);
426 // draw screen bitmap directly to Core Graphics context
427 if (!dataProviderRef) {
428 // Draw request before any guest device has set up a framebuffer:
429 // just draw an opaque black rectangle
430 CGContextSetRGBFillColor(viewContextRef, 0, 0, 0, 1.0);
431 CGContextFillRect(viewContextRef, NSRectToCGRect(rect));
433 CGImageRef imageRef = CGImageCreate(
434 screen.width, //width
435 screen.height, //height
436 screen.bitsPerComponent, //bitsPerComponent
437 screen.bitsPerPixel, //bitsPerPixel
438 (screen.width * (screen.bitsPerComponent/2)), //bytesPerRow
439 #ifdef __LITTLE_ENDIAN__
440 CGColorSpaceCreateWithName(kCGColorSpaceGenericRGB), //colorspace for OS X >= 10.4
441 kCGBitmapByteOrder32Little | kCGImageAlphaNoneSkipFirst,
443 CGColorSpaceCreateDeviceRGB(), //colorspace for OS X < 10.4 (actually ppc)
444 kCGImageAlphaNoneSkipFirst, //bitmapInfo
446 dataProviderRef, //provider
449 kCGRenderingIntentDefault //intent
451 // selective drawing code (draws only dirty rectangles) (OS X >= 10.4)
452 const NSRect *rectList;
455 CGImageRef clipImageRef;
458 [self getRectsBeingDrawn:&rectList count:&rectCount];
459 for (i = 0; i < rectCount; i++) {
460 clipRect.origin.x = rectList[i].origin.x / cdx;
461 clipRect.origin.y = (float)screen.height - (rectList[i].origin.y + rectList[i].size.height) / cdy;
462 clipRect.size.width = rectList[i].size.width / cdx;
463 clipRect.size.height = rectList[i].size.height / cdy;
464 clipImageRef = CGImageCreateWithImageInRect(
468 CGContextDrawImage (viewContextRef, cgrect(rectList[i]), clipImageRef);
469 CGImageRelease (clipImageRef);
471 CGImageRelease (imageRef);
475 - (void) setContentDimensions
477 COCOA_DEBUG("QemuCocoaView: setContentDimensions\n");
480 cdx = [[NSScreen mainScreen] frame].size.width / (float)screen.width;
481 cdy = [[NSScreen mainScreen] frame].size.height / (float)screen.height;
483 /* stretches video, but keeps same aspect ratio */
484 if (stretch_video == true) {
485 /* use smallest stretch value - prevents clipping on sides */
486 if (MIN(cdx, cdy) == cdx) {
491 } else { /* No stretching */
494 cw = screen.width * cdx;
495 ch = screen.height * cdy;
496 cx = ([[NSScreen mainScreen] frame].size.width - cw) / 2.0;
497 cy = ([[NSScreen mainScreen] frame].size.height - ch) / 2.0;
508 - (void) switchSurface:(pixman_image_t *)image
510 COCOA_DEBUG("QemuCocoaView: switchSurface\n");
512 int w = pixman_image_get_width(image);
513 int h = pixman_image_get_height(image);
514 pixman_format_code_t image_format = pixman_image_get_format(image);
515 /* cdx == 0 means this is our very first surface, in which case we need
516 * to recalculate the content dimensions even if it happens to be the size
517 * of the initial empty window.
519 bool isResize = (w != screen.width || h != screen.height || cdx == 0.0);
521 int oldh = screen.height;
523 // Resize before we trigger the redraw, or we'll redraw at the wrong size
524 COCOA_DEBUG("switchSurface: new size %d x %d\n", w, h);
527 [self setContentDimensions];
528 [self setFrame:NSMakeRect(cx, cy, cw, ch)];
531 // update screenBuffer
532 if (dataProviderRef) {
533 CGDataProviderRelease(dataProviderRef);
534 pixman_image_unref(pixman_image);
537 //sync host window color space with guests
538 screen.bitsPerPixel = PIXMAN_FORMAT_BPP(image_format);
539 screen.bitsPerComponent = DIV_ROUND_UP(screen.bitsPerPixel, 8) * 2;
541 pixman_image = image;
542 dataProviderRef = CGDataProviderCreateWithData(NULL, pixman_image_get_data(image), w * 4 * h, NULL);
546 [[fullScreenWindow contentView] setFrame:[[NSScreen mainScreen] frame]];
547 [normalWindow setFrame:NSMakeRect([normalWindow frame].origin.x, [normalWindow frame].origin.y - h + oldh, w, h + [normalWindow frame].size.height - oldh) display:NO animate:NO];
550 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s", qemu_name]];
551 [normalWindow setFrame:NSMakeRect([normalWindow frame].origin.x, [normalWindow frame].origin.y - h + oldh, w, h + [normalWindow frame].size.height - oldh) display:YES animate:NO];
555 [normalWindow center];
559 - (void) toggleFullScreen:(id)sender
561 COCOA_DEBUG("QemuCocoaView: toggleFullScreen\n");
563 if (isFullscreen) { // switch from fullscreen to desktop
564 isFullscreen = FALSE;
566 [self setContentDimensions];
567 if ([NSView respondsToSelector:@selector(exitFullScreenModeWithOptions:)]) { // test if "exitFullScreenModeWithOptions" is supported on host at runtime
568 [self exitFullScreenModeWithOptions:nil];
570 [fullScreenWindow close];
571 [normalWindow setContentView: self];
572 [normalWindow makeKeyAndOrderFront: self];
573 [NSMenu setMenuBarVisible:YES];
575 } else { // switch from desktop to fullscreen
577 [normalWindow orderOut: nil]; /* Hide the window */
579 [self setContentDimensions];
580 if ([NSView respondsToSelector:@selector(enterFullScreenMode:withOptions:)]) { // test if "enterFullScreenMode:withOptions" is supported on host at runtime
581 [self enterFullScreenMode:[NSScreen mainScreen] withOptions:[NSDictionary dictionaryWithObjectsAndKeys:
582 [NSNumber numberWithBool:NO], NSFullScreenModeAllScreens,
583 [NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:NO], kCGDisplayModeIsStretched, nil], NSFullScreenModeSetting,
586 [NSMenu setMenuBarVisible:NO];
587 fullScreenWindow = [[NSWindow alloc] initWithContentRect:[[NSScreen mainScreen] frame]
588 styleMask:NSWindowStyleMaskBorderless
589 backing:NSBackingStoreBuffered
591 [fullScreenWindow setAcceptsMouseMovedEvents: YES];
592 [fullScreenWindow setHasShadow:NO];
593 [fullScreenWindow setBackgroundColor: [NSColor blackColor]];
594 [self setFrame:NSMakeRect(cx, cy, cw, ch)];
595 [[fullScreenWindow contentView] addSubview: self];
596 [fullScreenWindow makeKeyAndOrderFront:self];
601 - (void) toggleModifier: (int)keycode {
602 // Toggle the stored state.
603 modifiers_state[keycode] = !modifiers_state[keycode];
604 // Send a keyup or keydown depending on the state.
605 qemu_input_event_send_key_qcode(dcl->con, keycode, modifiers_state[keycode]);
608 - (void) toggleStatefulModifier: (int)keycode {
609 // Toggle the stored state.
610 modifiers_state[keycode] = !modifiers_state[keycode];
611 // Generate keydown and keyup.
612 qemu_input_event_send_key_qcode(dcl->con, keycode, true);
613 qemu_input_event_send_key_qcode(dcl->con, keycode, false);
616 // Does the work of sending input to the monitor
617 - (void) handleMonitorInput:(NSEvent *)event
622 // if the control key is down
623 if ([event modifierFlags] & NSEventModifierFlagControl) {
627 /* translates Macintosh keycodes to QEMU's keysym */
629 int without_control_translation[] = {
630 [0 ... 0xff] = 0, // invalid key
632 [kVK_UpArrow] = QEMU_KEY_UP,
633 [kVK_DownArrow] = QEMU_KEY_DOWN,
634 [kVK_RightArrow] = QEMU_KEY_RIGHT,
635 [kVK_LeftArrow] = QEMU_KEY_LEFT,
636 [kVK_Home] = QEMU_KEY_HOME,
637 [kVK_End] = QEMU_KEY_END,
638 [kVK_PageUp] = QEMU_KEY_PAGEUP,
639 [kVK_PageDown] = QEMU_KEY_PAGEDOWN,
640 [kVK_ForwardDelete] = QEMU_KEY_DELETE,
641 [kVK_Delete] = QEMU_KEY_BACKSPACE,
644 int with_control_translation[] = {
645 [0 ... 0xff] = 0, // invalid key
647 [kVK_UpArrow] = QEMU_KEY_CTRL_UP,
648 [kVK_DownArrow] = QEMU_KEY_CTRL_DOWN,
649 [kVK_RightArrow] = QEMU_KEY_CTRL_RIGHT,
650 [kVK_LeftArrow] = QEMU_KEY_CTRL_LEFT,
651 [kVK_Home] = QEMU_KEY_CTRL_HOME,
652 [kVK_End] = QEMU_KEY_CTRL_END,
653 [kVK_PageUp] = QEMU_KEY_CTRL_PAGEUP,
654 [kVK_PageDown] = QEMU_KEY_CTRL_PAGEDOWN,
657 if (control_key != 0) { /* If the control key is being used */
658 if ([event keyCode] < ARRAY_SIZE(with_control_translation)) {
659 keysym = with_control_translation[[event keyCode]];
662 if ([event keyCode] < ARRAY_SIZE(without_control_translation)) {
663 keysym = without_control_translation[[event keyCode]];
667 // if not a key that needs translating
669 NSString *ks = [event characters];
670 if ([ks length] > 0) {
671 keysym = [ks characterAtIndex:0];
676 kbd_put_keysym(keysym);
680 - (bool) handleEvent:(NSEvent *)event
684 * Just let OSX have all events that arrive before
685 * applicationDidFinishLaunching.
686 * This avoids a deadlock on the iothread lock, which cocoa_display_init()
687 * will not drop until after the app_started_sem is posted. (In theory
688 * there should not be any such events, but OSX Catalina now emits some.)
692 return bool_with_iothread_lock(^{
693 return [self handleEventLocked:event];
697 - (bool) handleEventLocked:(NSEvent *)event
699 /* Return true if we handled the event, false if it should be given to OSX */
700 COCOA_DEBUG("QemuCocoaView: handleEvent\n");
703 bool mouse_event = false;
704 static bool switched_to_fullscreen = false;
705 // Location of event in virtual screen coordinates
706 NSPoint p = [self screenLocationOfEvent:event];
708 switch ([event type]) {
709 case NSEventTypeFlagsChanged:
710 if ([event keyCode] == 0) {
711 // When the Cocoa keyCode is zero that means keys should be
712 // synthesized based on the values in in the eventModifiers
715 if (qemu_console_is_graphic(NULL)) {
716 NSUInteger modifiers = [event modifierFlags];
718 if (!!(modifiers & NSEventModifierFlagCapsLock) != !!modifiers_state[Q_KEY_CODE_CAPS_LOCK]) {
719 [self toggleStatefulModifier:Q_KEY_CODE_CAPS_LOCK];
721 if (!!(modifiers & NSEventModifierFlagShift) != !!modifiers_state[Q_KEY_CODE_SHIFT]) {
722 [self toggleModifier:Q_KEY_CODE_SHIFT];
724 if (!!(modifiers & NSEventModifierFlagControl) != !!modifiers_state[Q_KEY_CODE_CTRL]) {
725 [self toggleModifier:Q_KEY_CODE_CTRL];
727 if (!!(modifiers & NSEventModifierFlagOption) != !!modifiers_state[Q_KEY_CODE_ALT]) {
728 [self toggleModifier:Q_KEY_CODE_ALT];
730 if (!!(modifiers & NSEventModifierFlagCommand) != !!modifiers_state[Q_KEY_CODE_META_L]) {
731 [self toggleModifier:Q_KEY_CODE_META_L];
735 keycode = cocoa_keycode_to_qemu([event keyCode]);
738 if ((keycode == Q_KEY_CODE_META_L || keycode == Q_KEY_CODE_META_R)
739 && !isMouseGrabbed) {
740 /* Don't pass command key changes to guest unless mouse is grabbed */
745 // emulate caps lock and num lock keydown and keyup
746 if (keycode == Q_KEY_CODE_CAPS_LOCK ||
747 keycode == Q_KEY_CODE_NUM_LOCK) {
748 [self toggleStatefulModifier:keycode];
749 } else if (qemu_console_is_graphic(NULL)) {
750 if (switched_to_fullscreen) {
751 switched_to_fullscreen = false;
753 [self toggleModifier:keycode];
759 case NSEventTypeKeyDown:
760 keycode = cocoa_keycode_to_qemu([event keyCode]);
762 // forward command key combos to the host UI unless the mouse is grabbed
763 if (!isMouseGrabbed && ([event modifierFlags] & NSEventModifierFlagCommand)) {
765 * Prevent the command key from being stuck down in the guest
766 * when using Command-F to switch to full screen mode.
768 if (keycode == Q_KEY_CODE_F) {
769 switched_to_fullscreen = true;
776 // handle control + alt Key Combos (ctrl+alt+[1..9,g] is reserved for QEMU)
777 if (([event modifierFlags] & NSEventModifierFlagControl) && ([event modifierFlags] & NSEventModifierFlagOption)) {
778 NSString *keychar = [event charactersIgnoringModifiers];
779 if ([keychar length] == 1) {
780 char key = [keychar characterAtIndex:0];
783 // enable graphic console
785 console_select(key - '0' - 1); /* ascii math */
788 // release the mouse grab
796 if (qemu_console_is_graphic(NULL)) {
797 qemu_input_event_send_key_qcode(dcl->con, keycode, true);
799 [self handleMonitorInput: event];
802 case NSEventTypeKeyUp:
803 keycode = cocoa_keycode_to_qemu([event keyCode]);
805 // don't pass the guest a spurious key-up if we treated this
806 // command-key combo as a host UI action
807 if (!isMouseGrabbed && ([event modifierFlags] & NSEventModifierFlagCommand)) {
811 if (qemu_console_is_graphic(NULL)) {
812 qemu_input_event_send_key_qcode(dcl->con, keycode, false);
815 case NSEventTypeMouseMoved:
816 if (isAbsoluteEnabled) {
817 // Cursor re-entered into a window might generate events bound to screen coordinates
818 // and `nil` window property, and in full screen mode, current window might not be
819 // key window, where event location alone should suffice.
820 if (![self screenContainsPoint:p] || !([[self window] isKeyWindow] || isFullscreen)) {
821 if (isMouseGrabbed) {
825 if (!isMouseGrabbed) {
832 case NSEventTypeLeftMouseDown:
833 if ([event modifierFlags] & NSEventModifierFlagCommand) {
834 buttons |= MOUSE_EVENT_RBUTTON;
836 buttons |= MOUSE_EVENT_LBUTTON;
840 case NSEventTypeRightMouseDown:
841 buttons |= MOUSE_EVENT_RBUTTON;
844 case NSEventTypeOtherMouseDown:
845 buttons |= MOUSE_EVENT_MBUTTON;
848 case NSEventTypeLeftMouseDragged:
849 if ([event modifierFlags] & NSEventModifierFlagCommand) {
850 buttons |= MOUSE_EVENT_RBUTTON;
852 buttons |= MOUSE_EVENT_LBUTTON;
856 case NSEventTypeRightMouseDragged:
857 buttons |= MOUSE_EVENT_RBUTTON;
860 case NSEventTypeOtherMouseDragged:
861 buttons |= MOUSE_EVENT_MBUTTON;
864 case NSEventTypeLeftMouseUp:
866 if (!isMouseGrabbed && [self screenContainsPoint:p]) {
868 * In fullscreen mode, the window of cocoaView may not be the
869 * key window, therefore the position relative to the virtual
870 * screen alone will be sufficient.
872 if(isFullscreen || [[self window] isKeyWindow]) {
877 case NSEventTypeRightMouseUp:
880 case NSEventTypeOtherMouseUp:
883 case NSEventTypeScrollWheel:
885 * Send wheel events to the guest regardless of window focus.
886 * This is in-line with standard Mac OS X UI behaviour.
890 * When deltaY is zero, it means that this scrolling event was
891 * either horizontal, or so fine that it only appears in
892 * scrollingDeltaY. So we drop the event.
894 if ([event deltaY] != 0) {
895 /* Determine if this is a scroll up or scroll down event */
896 buttons = ([event deltaY] > 0) ?
897 INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
898 qemu_input_queue_btn(dcl->con, buttons, true);
899 qemu_input_event_sync();
900 qemu_input_queue_btn(dcl->con, buttons, false);
901 qemu_input_event_sync();
904 * Since deltaY also reports scroll wheel events we prevent mouse
905 * movement code from executing.
914 /* Don't send button events to the guest unless we've got a
915 * mouse grab or window focus. If we have neither then this event
916 * is the user clicking on the background window to activate and
917 * bring us to the front, which will be done by the sendEvent
918 * call below. We definitely don't want to pass that click through
921 if ((isMouseGrabbed || [[self window] isKeyWindow]) &&
922 (last_buttons != buttons)) {
923 static uint32_t bmap[INPUT_BUTTON__MAX] = {
924 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
925 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
926 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON
928 qemu_input_update_buttons(dcl->con, bmap, last_buttons, buttons);
929 last_buttons = buttons;
931 if (isMouseGrabbed) {
932 if (isAbsoluteEnabled) {
933 /* Note that the origin for Cocoa mouse coords is bottom left, not top left.
934 * The check on screenContainsPoint is to avoid sending out of range values for
935 * clicks in the titlebar.
937 if ([self screenContainsPoint:p]) {
938 qemu_input_queue_abs(dcl->con, INPUT_AXIS_X, p.x, 0, screen.width);
939 qemu_input_queue_abs(dcl->con, INPUT_AXIS_Y, screen.height - p.y, 0, screen.height);
942 qemu_input_queue_rel(dcl->con, INPUT_AXIS_X, (int)[event deltaX]);
943 qemu_input_queue_rel(dcl->con, INPUT_AXIS_Y, (int)[event deltaY]);
948 qemu_input_event_sync();
955 COCOA_DEBUG("QemuCocoaView: grabMouse\n");
959 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s - (Press ctrl + alt + g to release Mouse)", qemu_name]];
961 [normalWindow setTitle:@"QEMU - (Press ctrl + alt + g to release Mouse)"];
964 if (!isAbsoluteEnabled) {
965 isMouseDeassociated = TRUE;
966 CGAssociateMouseAndMouseCursorPosition(FALSE);
968 isMouseGrabbed = TRUE; // while isMouseGrabbed = TRUE, QemuCocoaApp sends all events to [cocoaView handleEvent:]
973 COCOA_DEBUG("QemuCocoaView: ungrabMouse\n");
977 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s", qemu_name]];
979 [normalWindow setTitle:@"QEMU"];
982 if (isMouseDeassociated) {
983 CGAssociateMouseAndMouseCursorPosition(TRUE);
984 isMouseDeassociated = FALSE;
986 isMouseGrabbed = FALSE;
989 - (void) setAbsoluteEnabled:(BOOL)tIsAbsoluteEnabled {isAbsoluteEnabled = tIsAbsoluteEnabled;}
990 - (BOOL) isMouseGrabbed {return isMouseGrabbed;}
991 - (BOOL) isAbsoluteEnabled {return isAbsoluteEnabled;}
992 - (BOOL) isMouseDeassociated {return isMouseDeassociated;}
993 - (float) cdx {return cdx;}
994 - (float) cdy {return cdy;}
995 - (QEMUScreen) gscreen {return screen;}
998 * Makes the target think all down keys are being released.
999 * This prevents a stuck key problem, since we will not see
1000 * key up events for those keys after we have lost focus.
1002 - (void) raiseAllKeys
1004 const int max_index = ARRAY_SIZE(modifiers_state);
1006 with_iothread_lock(^{
1009 for (index = 0; index < max_index; index++) {
1010 if (modifiers_state[index]) {
1011 modifiers_state[index] = 0;
1012 qemu_input_event_send_key_qcode(dcl->con, index, false);
1022 ------------------------------------------------------
1023 QemuCocoaAppController
1024 ------------------------------------------------------
1026 @interface QemuCocoaAppController : NSObject
1027 <NSWindowDelegate, NSApplicationDelegate>
1030 - (void)doToggleFullScreen:(id)sender;
1031 - (void)toggleFullScreen:(id)sender;
1032 - (void)showQEMUDoc:(id)sender;
1033 - (void)zoomToFit:(id) sender;
1034 - (void)displayConsole:(id)sender;
1035 - (void)pauseQEMU:(id)sender;
1036 - (void)resumeQEMU:(id)sender;
1037 - (void)displayPause;
1038 - (void)removePause;
1039 - (void)restartQEMU:(id)sender;
1040 - (void)powerDownQEMU:(id)sender;
1041 - (void)ejectDeviceMedia:(id)sender;
1042 - (void)changeDeviceMedia:(id)sender;
1044 - (void)openDocumentation:(NSString *)filename;
1045 - (IBAction) do_about_menu_item: (id) sender;
1046 - (void)make_about_window;
1047 - (void)adjustSpeed:(id)sender;
1050 @implementation QemuCocoaAppController
1053 COCOA_DEBUG("QemuCocoaAppController: init\n");
1055 self = [super init];
1058 // create a view and add it to the window
1059 cocoaView = [[QemuCocoaView alloc] initWithFrame:NSMakeRect(0.0, 0.0, 640.0, 480.0)];
1061 fprintf(stderr, "(cocoa) can't create a view\n");
1066 normalWindow = [[NSWindow alloc] initWithContentRect:[cocoaView frame]
1067 styleMask:NSWindowStyleMaskTitled|NSWindowStyleMaskMiniaturizable|NSWindowStyleMaskClosable
1068 backing:NSBackingStoreBuffered defer:NO];
1070 fprintf(stderr, "(cocoa) can't create window\n");
1073 [normalWindow setAcceptsMouseMovedEvents:YES];
1074 [normalWindow setTitle:@"QEMU"];
1075 [normalWindow setContentView:cocoaView];
1076 [normalWindow makeKeyAndOrderFront:self];
1077 [normalWindow center];
1078 [normalWindow setDelegate: self];
1079 stretch_video = false;
1081 /* Used for displaying pause on the screen */
1082 pauseLabel = [NSTextField new];
1083 [pauseLabel setBezeled:YES];
1084 [pauseLabel setDrawsBackground:YES];
1085 [pauseLabel setBackgroundColor: [NSColor whiteColor]];
1086 [pauseLabel setEditable:NO];
1087 [pauseLabel setSelectable:NO];
1088 [pauseLabel setStringValue: @"Paused"];
1089 [pauseLabel setFont: [NSFont fontWithName: @"Helvetica" size: 90]];
1090 [pauseLabel setTextColor: [NSColor blackColor]];
1091 [pauseLabel sizeToFit];
1093 // set the supported image file types that can be opened
1094 supportedImageFileTypes = [NSArray arrayWithObjects: @"img", @"iso", @"dmg",
1095 @"qcow", @"qcow2", @"cloop", @"vmdk", @"cdr",
1097 [self make_about_window];
1104 COCOA_DEBUG("QemuCocoaAppController: dealloc\n");
1107 [cocoaView release];
1111 - (void)applicationDidFinishLaunching: (NSNotification *) note
1113 COCOA_DEBUG("QemuCocoaAppController: applicationDidFinishLaunching\n");
1114 allow_events = true;
1115 /* Tell cocoa_display_init to proceed */
1116 qemu_sem_post(&app_started_sem);
1119 - (void)applicationWillTerminate:(NSNotification *)aNotification
1121 COCOA_DEBUG("QemuCocoaAppController: applicationWillTerminate\n");
1123 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_UI);
1127 - (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication
1132 - (NSApplicationTerminateReply)applicationShouldTerminate:
1133 (NSApplication *)sender
1135 COCOA_DEBUG("QemuCocoaAppController: applicationShouldTerminate\n");
1136 return [self verifyQuit];
1139 /* Called when the user clicks on a window's close button */
1140 - (BOOL)windowShouldClose:(id)sender
1142 COCOA_DEBUG("QemuCocoaAppController: windowShouldClose\n");
1143 [NSApp terminate: sender];
1144 /* If the user allows the application to quit then the call to
1145 * NSApp terminate will never return. If we get here then the user
1146 * cancelled the quit, so we should return NO to not permit the
1147 * closing of this window.
1152 /* Called when QEMU goes into the background */
1153 - (void) applicationWillResignActive: (NSNotification *)aNotification
1155 COCOA_DEBUG("QemuCocoaAppController: applicationWillResignActive\n");
1156 [cocoaView raiseAllKeys];
1159 /* We abstract the method called by the Enter Fullscreen menu item
1160 * because Mac OS 10.7 and higher disables it. This is because of the
1161 * menu item's old selector's name toggleFullScreen:
1163 - (void) doToggleFullScreen:(id)sender
1165 [self toggleFullScreen:(id)sender];
1168 - (void)toggleFullScreen:(id)sender
1170 COCOA_DEBUG("QemuCocoaAppController: toggleFullScreen\n");
1172 [cocoaView toggleFullScreen:sender];
1175 /* Tries to find then open the specified filename */
1176 - (void) openDocumentation: (NSString *) filename
1178 /* Where to look for local files */
1179 NSString *path_array[] = {@"../share/doc/qemu/", @"../doc/qemu/", @"docs/"};
1180 NSString *full_file_path;
1181 NSURL *full_file_url;
1183 /* iterate thru the possible paths until the file is found */
1185 for (index = 0; index < ARRAY_SIZE(path_array); index++) {
1186 full_file_path = [[NSBundle mainBundle] executablePath];
1187 full_file_path = [full_file_path stringByDeletingLastPathComponent];
1188 full_file_path = [NSString stringWithFormat: @"%@/%@%@", full_file_path,
1189 path_array[index], filename];
1190 full_file_url = [NSURL fileURLWithPath: full_file_path
1191 isDirectory: false];
1192 if ([[NSWorkspace sharedWorkspace] openURL: full_file_url] == YES) {
1197 /* If none of the paths opened a file */
1199 QEMU_Alert(@"Failed to open file");
1202 - (void)showQEMUDoc:(id)sender
1204 COCOA_DEBUG("QemuCocoaAppController: showQEMUDoc\n");
1206 [self openDocumentation: @"index.html"];
1209 /* Stretches video to fit host monitor size */
1210 - (void)zoomToFit:(id) sender
1212 stretch_video = !stretch_video;
1213 if (stretch_video == true) {
1214 [sender setState: NSControlStateValueOn];
1216 [sender setState: NSControlStateValueOff];
1220 /* Displays the console on the screen */
1221 - (void)displayConsole:(id)sender
1223 console_select([sender tag]);
1226 /* Pause the guest */
1227 - (void)pauseQEMU:(id)sender
1229 with_iothread_lock(^{
1232 [sender setEnabled: NO];
1233 [[[sender menu] itemWithTitle: @"Resume"] setEnabled: YES];
1234 [self displayPause];
1237 /* Resume running the guest operating system */
1238 - (void)resumeQEMU:(id) sender
1240 with_iothread_lock(^{
1243 [sender setEnabled: NO];
1244 [[[sender menu] itemWithTitle: @"Pause"] setEnabled: YES];
1248 /* Displays the word pause on the screen */
1249 - (void)displayPause
1251 /* Coordinates have to be calculated each time because the window can change its size */
1252 int xCoord, yCoord, width, height;
1253 xCoord = ([normalWindow frame].size.width - [pauseLabel frame].size.width)/2;
1254 yCoord = [normalWindow frame].size.height - [pauseLabel frame].size.height - ([pauseLabel frame].size.height * .5);
1255 width = [pauseLabel frame].size.width;
1256 height = [pauseLabel frame].size.height;
1257 [pauseLabel setFrame: NSMakeRect(xCoord, yCoord, width, height)];
1258 [cocoaView addSubview: pauseLabel];
1261 /* Removes the word pause from the screen */
1264 [pauseLabel removeFromSuperview];
1268 - (void)restartQEMU:(id)sender
1270 with_iothread_lock(^{
1271 qmp_system_reset(NULL);
1275 /* Powers down QEMU */
1276 - (void)powerDownQEMU:(id)sender
1278 with_iothread_lock(^{
1279 qmp_system_powerdown(NULL);
1283 /* Ejects the media.
1284 * Uses sender's tag to figure out the device to eject.
1286 - (void)ejectDeviceMedia:(id)sender
1289 drive = [sender representedObject];
1292 QEMU_Alert(@"Failed to find drive to eject!");
1296 __block Error *err = NULL;
1297 with_iothread_lock(^{
1298 qmp_eject(true, [drive cStringUsingEncoding: NSASCIIStringEncoding],
1299 false, NULL, false, false, &err);
1301 handleAnyDeviceErrors(err);
1304 /* Displays a dialog box asking the user to select an image file to load.
1305 * Uses sender's represented object value to figure out which drive to use.
1307 - (void)changeDeviceMedia:(id)sender
1309 /* Find the drive name */
1311 drive = [sender representedObject];
1314 QEMU_Alert(@"Could not find drive!");
1318 /* Display the file open dialog */
1319 NSOpenPanel * openPanel;
1320 openPanel = [NSOpenPanel openPanel];
1321 [openPanel setCanChooseFiles: YES];
1322 [openPanel setAllowsMultipleSelection: NO];
1323 [openPanel setAllowedFileTypes: supportedImageFileTypes];
1324 if([openPanel runModal] == NSModalResponseOK) {
1325 NSString * file = [[[openPanel URLs] objectAtIndex: 0] path];
1328 QEMU_Alert(@"Failed to convert URL to file path!");
1332 __block Error *err = NULL;
1333 with_iothread_lock(^{
1334 qmp_blockdev_change_medium(true,
1335 [drive cStringUsingEncoding:
1336 NSASCIIStringEncoding],
1338 [file cStringUsingEncoding:
1339 NSASCIIStringEncoding],
1344 handleAnyDeviceErrors(err);
1348 /* Verifies if the user really wants to quit */
1351 NSAlert *alert = [NSAlert new];
1352 [alert autorelease];
1353 [alert setMessageText: @"Are you sure you want to quit QEMU?"];
1354 [alert addButtonWithTitle: @"Cancel"];
1355 [alert addButtonWithTitle: @"Quit"];
1356 if([alert runModal] == NSAlertSecondButtonReturn) {
1363 /* The action method for the About menu item */
1364 - (IBAction) do_about_menu_item: (id) sender
1366 [about_window makeKeyAndOrderFront: nil];
1369 /* Create and display the about dialog */
1370 - (void)make_about_window
1372 /* Make the window */
1373 int x = 0, y = 0, about_width = 400, about_height = 200;
1374 NSRect window_rect = NSMakeRect(x, y, about_width, about_height);
1375 about_window = [[NSWindow alloc] initWithContentRect:window_rect
1376 styleMask:NSWindowStyleMaskTitled | NSWindowStyleMaskClosable |
1377 NSWindowStyleMaskMiniaturizable
1378 backing:NSBackingStoreBuffered
1380 [about_window setTitle: @"About"];
1381 [about_window setReleasedWhenClosed: NO];
1382 [about_window center];
1383 NSView *superView = [about_window contentView];
1385 /* Create the dimensions of the picture */
1386 int picture_width = 80, picture_height = 80;
1387 x = (about_width - picture_width)/2;
1388 y = about_height - picture_height - 10;
1389 NSRect picture_rect = NSMakeRect(x, y, picture_width, picture_height);
1391 /* Get the path to the QEMU binary */
1392 NSString *binary_name = [NSString stringWithCString: gArgv[0]
1393 encoding: NSASCIIStringEncoding];
1394 binary_name = [binary_name lastPathComponent];
1395 NSString *program_path = [[NSString alloc] initWithFormat: @"%@/%@",
1396 [[NSBundle mainBundle] bundlePath], binary_name];
1398 /* Make the picture of QEMU */
1399 NSImageView *picture_view = [[NSImageView alloc] initWithFrame:
1401 NSImage *qemu_image = [[NSWorkspace sharedWorkspace] iconForFile:
1403 [picture_view setImage: qemu_image];
1404 [picture_view setImageScaling: NSImageScaleProportionallyUpOrDown];
1405 [superView addSubview: picture_view];
1407 /* Make the name label */
1410 int name_width = about_width, name_height = 20;
1411 NSRect name_rect = NSMakeRect(x, y, name_width, name_height);
1412 NSTextField *name_label = [[NSTextField alloc] initWithFrame: name_rect];
1413 [name_label setEditable: NO];
1414 [name_label setBezeled: NO];
1415 [name_label setDrawsBackground: NO];
1416 [name_label setAlignment: NSTextAlignmentCenter];
1417 NSString *qemu_name = [[NSString alloc] initWithCString: gArgv[0]
1418 encoding: NSASCIIStringEncoding];
1419 qemu_name = [qemu_name lastPathComponent];
1420 [name_label setStringValue: qemu_name];
1421 [superView addSubview: name_label];
1423 /* Set the version label's attributes */
1426 int version_width = about_width, version_height = 20;
1427 NSRect version_rect = NSMakeRect(x, y, version_width, version_height);
1428 NSTextField *version_label = [[NSTextField alloc] initWithFrame:
1430 [version_label setEditable: NO];
1431 [version_label setBezeled: NO];
1432 [version_label setAlignment: NSTextAlignmentCenter];
1433 [version_label setDrawsBackground: NO];
1435 /* Create the version string*/
1436 NSString *version_string;
1437 version_string = [[NSString alloc] initWithFormat:
1438 @"QEMU emulator version %s", QEMU_FULL_VERSION];
1439 [version_label setStringValue: version_string];
1440 [superView addSubview: version_label];
1442 /* Make copyright label */
1445 int copyright_width = about_width, copyright_height = 20;
1446 NSRect copyright_rect = NSMakeRect(x, y, copyright_width, copyright_height);
1447 NSTextField *copyright_label = [[NSTextField alloc] initWithFrame:
1449 [copyright_label setEditable: NO];
1450 [copyright_label setBezeled: NO];
1451 [copyright_label setDrawsBackground: NO];
1452 [copyright_label setAlignment: NSTextAlignmentCenter];
1453 [copyright_label setStringValue: [NSString stringWithFormat: @"%s",
1455 [superView addSubview: copyright_label];
1458 /* Used by the Speed menu items */
1459 - (void)adjustSpeed:(id)sender
1461 int throttle_pct; /* throttle percentage */
1464 menu = [sender menu];
1467 /* Unselect the currently selected item */
1468 for (NSMenuItem *item in [menu itemArray]) {
1469 if (item.state == NSControlStateValueOn) {
1470 [item setState: NSControlStateValueOff];
1476 // check the menu item
1477 [sender setState: NSControlStateValueOn];
1479 // get the throttle percentage
1480 throttle_pct = [sender tag];
1482 with_iothread_lock(^{
1483 cpu_throttle_set(throttle_pct);
1485 COCOA_DEBUG("cpu throttling at %d%c\n", cpu_throttle_get_percentage(), '%');
1490 @interface QemuApplication : NSApplication
1493 @implementation QemuApplication
1494 - (void)sendEvent:(NSEvent *)event
1496 COCOA_DEBUG("QemuApplication: sendEvent\n");
1497 if (![cocoaView handleEvent:event]) {
1498 [super sendEvent: event];
1503 static void create_initial_menus(void)
1507 NSMenuItem *menuItem;
1509 [NSApp setMainMenu:[[NSMenu alloc] init]];
1512 menu = [[NSMenu alloc] initWithTitle:@""];
1513 [menu addItemWithTitle:@"About QEMU" action:@selector(do_about_menu_item:) keyEquivalent:@""]; // About QEMU
1514 [menu addItem:[NSMenuItem separatorItem]]; //Separator
1515 [menu addItemWithTitle:@"Hide QEMU" action:@selector(hide:) keyEquivalent:@"h"]; //Hide QEMU
1516 menuItem = (NSMenuItem *)[menu addItemWithTitle:@"Hide Others" action:@selector(hideOtherApplications:) keyEquivalent:@"h"]; // Hide Others
1517 [menuItem setKeyEquivalentModifierMask:(NSEventModifierFlagOption|NSEventModifierFlagCommand)];
1518 [menu addItemWithTitle:@"Show All" action:@selector(unhideAllApplications:) keyEquivalent:@""]; // Show All
1519 [menu addItem:[NSMenuItem separatorItem]]; //Separator
1520 [menu addItemWithTitle:@"Quit QEMU" action:@selector(terminate:) keyEquivalent:@"q"];
1521 menuItem = [[NSMenuItem alloc] initWithTitle:@"Apple" action:nil keyEquivalent:@""];
1522 [menuItem setSubmenu:menu];
1523 [[NSApp mainMenu] addItem:menuItem];
1524 [NSApp performSelector:@selector(setAppleMenu:) withObject:menu]; // Workaround (this method is private since 10.4+)
1527 menu = [[NSMenu alloc] initWithTitle: @"Machine"];
1528 [menu setAutoenablesItems: NO];
1529 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Pause" action: @selector(pauseQEMU:) keyEquivalent: @""] autorelease]];
1530 menuItem = [[[NSMenuItem alloc] initWithTitle: @"Resume" action: @selector(resumeQEMU:) keyEquivalent: @""] autorelease];
1531 [menu addItem: menuItem];
1532 [menuItem setEnabled: NO];
1533 [menu addItem: [NSMenuItem separatorItem]];
1534 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Reset" action: @selector(restartQEMU:) keyEquivalent: @""] autorelease]];
1535 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Power Down" action: @selector(powerDownQEMU:) keyEquivalent: @""] autorelease]];
1536 menuItem = [[[NSMenuItem alloc] initWithTitle: @"Machine" action:nil keyEquivalent:@""] autorelease];
1537 [menuItem setSubmenu:menu];
1538 [[NSApp mainMenu] addItem:menuItem];
1541 menu = [[NSMenu alloc] initWithTitle:@"View"];
1542 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Enter Fullscreen" action:@selector(doToggleFullScreen:) keyEquivalent:@"f"] autorelease]]; // Fullscreen
1543 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Zoom To Fit" action:@selector(zoomToFit:) keyEquivalent:@""] autorelease]];
1544 menuItem = [[[NSMenuItem alloc] initWithTitle:@"View" action:nil keyEquivalent:@""] autorelease];
1545 [menuItem setSubmenu:menu];
1546 [[NSApp mainMenu] addItem:menuItem];
1549 menu = [[NSMenu alloc] initWithTitle:@"Speed"];
1551 // Add the rest of the Speed menu items
1552 int p, percentage, throttle_pct;
1553 for (p = 10; p >= 0; p--)
1555 percentage = p * 10 > 1 ? p * 10 : 1; // prevent a 0% menu item
1557 menuItem = [[[NSMenuItem alloc]
1558 initWithTitle: [NSString stringWithFormat: @"%d%%", percentage] action:@selector(adjustSpeed:) keyEquivalent:@""] autorelease];
1560 if (percentage == 100) {
1561 [menuItem setState: NSControlStateValueOn];
1564 /* Calculate the throttle percentage */
1565 throttle_pct = -1 * percentage + 100;
1567 [menuItem setTag: throttle_pct];
1568 [menu addItem: menuItem];
1570 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Speed" action:nil keyEquivalent:@""] autorelease];
1571 [menuItem setSubmenu:menu];
1572 [[NSApp mainMenu] addItem:menuItem];
1575 menu = [[NSMenu alloc] initWithTitle:@"Window"];
1576 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Minimize" action:@selector(performMiniaturize:) keyEquivalent:@"m"] autorelease]]; // Miniaturize
1577 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""] autorelease];
1578 [menuItem setSubmenu:menu];
1579 [[NSApp mainMenu] addItem:menuItem];
1580 [NSApp setWindowsMenu:menu];
1583 menu = [[NSMenu alloc] initWithTitle:@"Help"];
1584 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"QEMU Documentation" action:@selector(showQEMUDoc:) keyEquivalent:@"?"] autorelease]]; // QEMU Help
1585 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""] autorelease];
1586 [menuItem setSubmenu:menu];
1587 [[NSApp mainMenu] addItem:menuItem];
1590 /* Returns a name for a given console */
1591 static NSString * getConsoleName(QemuConsole * console)
1593 return [NSString stringWithFormat: @"%s", qemu_console_get_label(console)];
1596 /* Add an entry to the View menu for each console */
1597 static void add_console_menu_entries(void)
1600 NSMenuItem *menuItem;
1603 menu = [[[NSApp mainMenu] itemWithTitle:@"View"] submenu];
1605 [menu addItem:[NSMenuItem separatorItem]];
1607 while (qemu_console_lookup_by_index(index) != NULL) {
1608 menuItem = [[[NSMenuItem alloc] initWithTitle: getConsoleName(qemu_console_lookup_by_index(index))
1609 action: @selector(displayConsole:) keyEquivalent: @""] autorelease];
1610 [menuItem setTag: index];
1611 [menu addItem: menuItem];
1616 /* Make menu items for all removable devices.
1617 * Each device is given an 'Eject' and 'Change' menu item.
1619 static void addRemovableDevicesMenuItems(void)
1622 NSMenuItem *menuItem;
1623 BlockInfoList *currentDevice, *pointerToFree;
1624 NSString *deviceName;
1626 currentDevice = qmp_query_block(NULL);
1627 pointerToFree = currentDevice;
1628 if(currentDevice == NULL) {
1630 QEMU_Alert(@"Failed to query for block devices!");
1634 menu = [[[NSApp mainMenu] itemWithTitle:@"Machine"] submenu];
1636 // Add a separator between related groups of menu items
1637 [menu addItem:[NSMenuItem separatorItem]];
1639 // Set the attributes to the "Removable Media" menu item
1640 NSString *titleString = @"Removable Media";
1641 NSMutableAttributedString *attString=[[NSMutableAttributedString alloc] initWithString:titleString];
1642 NSColor *newColor = [NSColor blackColor];
1643 NSFontManager *fontManager = [NSFontManager sharedFontManager];
1644 NSFont *font = [fontManager fontWithFamily:@"Helvetica"
1645 traits:NSBoldFontMask|NSItalicFontMask
1648 [attString addAttribute:NSFontAttributeName value:font range:NSMakeRange(0, [titleString length])];
1649 [attString addAttribute:NSForegroundColorAttributeName value:newColor range:NSMakeRange(0, [titleString length])];
1650 [attString addAttribute:NSUnderlineStyleAttributeName value:[NSNumber numberWithInt: 1] range:NSMakeRange(0, [titleString length])];
1652 // Add the "Removable Media" menu item
1653 menuItem = [NSMenuItem new];
1654 [menuItem setAttributedTitle: attString];
1655 [menuItem setEnabled: NO];
1656 [menu addItem: menuItem];
1658 /* Loop through all the block devices in the emulator */
1659 while (currentDevice) {
1660 deviceName = [[NSString stringWithFormat: @"%s", currentDevice->value->device] retain];
1662 if(currentDevice->value->removable) {
1663 menuItem = [[NSMenuItem alloc] initWithTitle: [NSString stringWithFormat: @"Change %s...", currentDevice->value->device]
1664 action: @selector(changeDeviceMedia:)
1665 keyEquivalent: @""];
1666 [menu addItem: menuItem];
1667 [menuItem setRepresentedObject: deviceName];
1668 [menuItem autorelease];
1670 menuItem = [[NSMenuItem alloc] initWithTitle: [NSString stringWithFormat: @"Eject %s", currentDevice->value->device]
1671 action: @selector(ejectDeviceMedia:)
1672 keyEquivalent: @""];
1673 [menu addItem: menuItem];
1674 [menuItem setRepresentedObject: deviceName];
1675 [menuItem autorelease];
1677 currentDevice = currentDevice->next;
1679 qapi_free_BlockInfoList(pointerToFree);
1683 * The startup process for the OSX/Cocoa UI is complicated, because
1684 * OSX insists that the UI runs on the initial main thread, and so we
1685 * need to start a second thread which runs the vl.c qemu_main():
1687 * Initial thread: 2nd thread:
1689 * create qemu-main thread
1690 * wait on display_init semaphore
1693 * in cocoa_display_init():
1694 * post the display_init semaphore
1695 * wait on app_started semaphore
1696 * create application, menus, etc
1697 * enter OSX run loop
1698 * in applicationDidFinishLaunching:
1699 * post app_started semaphore
1700 * tell main thread to fullscreen if needed
1702 * run qemu main-loop
1704 * We do this in two stages so that we don't do the creation of the
1705 * GUI application menus and so on for command line options like --help
1706 * where we want to just print text to stdout and exit immediately.
1709 static void *call_qemu_main(void *opaque)
1713 COCOA_DEBUG("Second thread: calling qemu_main()\n");
1714 status = qemu_main(gArgc, gArgv, *_NSGetEnviron());
1715 COCOA_DEBUG("Second thread: qemu_main() returned, exiting\n");
1719 int main (int argc, const char * argv[]) {
1722 COCOA_DEBUG("Entered main()\n");
1724 gArgv = (char **)argv;
1726 qemu_sem_init(&display_init_sem, 0);
1727 qemu_sem_init(&app_started_sem, 0);
1729 qemu_thread_create(&thread, "qemu_main", call_qemu_main,
1730 NULL, QEMU_THREAD_DETACHED);
1732 COCOA_DEBUG("Main thread: waiting for display_init_sem\n");
1733 qemu_sem_wait(&display_init_sem);
1734 COCOA_DEBUG("Main thread: initializing app\n");
1736 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1738 // Pull this console process up to being a fully-fledged graphical
1739 // app with a menubar and Dock icon
1740 ProcessSerialNumber psn = { 0, kCurrentProcess };
1741 TransformProcessType(&psn, kProcessTransformToForegroundApplication);
1743 [QemuApplication sharedApplication];
1745 create_initial_menus();
1748 * Create the menu entries which depend on QEMU state (for consoles
1749 * and removeable devices). These make calls back into QEMU functions,
1750 * which is OK because at this point we know that the second thread
1751 * holds the iothread lock and is synchronously waiting for us to
1754 add_console_menu_entries();
1755 addRemovableDevicesMenuItems();
1757 // Create an Application controller
1758 QemuCocoaAppController *appController = [[QemuCocoaAppController alloc] init];
1759 [NSApp setDelegate:appController];
1761 // Start the main event loop
1762 COCOA_DEBUG("Main thread: entering OSX run loop\n");
1764 COCOA_DEBUG("Main thread: left OSX run loop, exiting\n");
1766 [appController release];
1775 static void cocoa_update(DisplayChangeListener *dcl,
1776 int x, int y, int w, int h)
1778 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1780 COCOA_DEBUG("qemu_cocoa: cocoa_update\n");
1782 dispatch_async(dispatch_get_main_queue(), ^{
1784 if ([cocoaView cdx] == 1.0) {
1785 rect = NSMakeRect(x, [cocoaView gscreen].height - y - h, w, h);
1788 x * [cocoaView cdx],
1789 ([cocoaView gscreen].height - y - h) * [cocoaView cdy],
1790 w * [cocoaView cdx],
1791 h * [cocoaView cdy]);
1793 [cocoaView setNeedsDisplayInRect:rect];
1799 static void cocoa_switch(DisplayChangeListener *dcl,
1800 DisplaySurface *surface)
1802 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1803 pixman_image_t *image = surface->image;
1805 COCOA_DEBUG("qemu_cocoa: cocoa_switch\n");
1807 // The DisplaySurface will be freed as soon as this callback returns.
1808 // We take a reference to the underlying pixman image here so it does
1809 // not disappear from under our feet; the switchSurface method will
1810 // deref the old image when it is done with it.
1811 pixman_image_ref(image);
1813 dispatch_async(dispatch_get_main_queue(), ^{
1814 [cocoaView switchSurface:image];
1819 static void cocoa_refresh(DisplayChangeListener *dcl)
1821 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1823 COCOA_DEBUG("qemu_cocoa: cocoa_refresh\n");
1824 graphic_hw_update(NULL);
1826 if (qemu_input_is_absolute()) {
1827 dispatch_async(dispatch_get_main_queue(), ^{
1828 if (![cocoaView isAbsoluteEnabled]) {
1829 if ([cocoaView isMouseGrabbed]) {
1830 [cocoaView ungrabMouse];
1833 [cocoaView setAbsoluteEnabled:YES];
1839 static void cocoa_cleanup(void)
1841 COCOA_DEBUG("qemu_cocoa: cocoa_cleanup\n");
1845 static const DisplayChangeListenerOps dcl_ops = {
1846 .dpy_name = "cocoa",
1847 .dpy_gfx_update = cocoa_update,
1848 .dpy_gfx_switch = cocoa_switch,
1849 .dpy_refresh = cocoa_refresh,
1852 static void cocoa_display_init(DisplayState *ds, DisplayOptions *opts)
1854 COCOA_DEBUG("qemu_cocoa: cocoa_display_init\n");
1856 /* Tell main thread to go ahead and create the app and enter the run loop */
1857 qemu_sem_post(&display_init_sem);
1858 qemu_sem_wait(&app_started_sem);
1859 COCOA_DEBUG("cocoa_display_init: app start completed\n");
1861 /* if fullscreen mode is to be used */
1862 if (opts->has_full_screen && opts->full_screen) {
1863 dispatch_async(dispatch_get_main_queue(), ^{
1864 [NSApp activateIgnoringOtherApps: YES];
1865 [(QemuCocoaAppController *)[[NSApplication sharedApplication] delegate] toggleFullScreen: nil];
1868 if (opts->has_show_cursor && opts->show_cursor) {
1872 dcl = g_malloc0(sizeof(DisplayChangeListener));
1874 // register vga output callbacks
1875 dcl->ops = &dcl_ops;
1876 register_displaychangelistener(dcl);
1878 // register cleanup function
1879 atexit(cocoa_cleanup);
1882 static QemuDisplay qemu_display_cocoa = {
1883 .type = DISPLAY_TYPE_COCOA,
1884 .init = cocoa_display_init,
1887 static void register_cocoa(void)
1889 qemu_display_register(&qemu_display_cocoa);
1892 type_init(register_cocoa);