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 "ui/kbd-state.h"
34 #include "sysemu/sysemu.h"
35 #include "sysemu/runstate.h"
36 #include "sysemu/cpu-throttle.h"
37 #include "qapi/error.h"
38 #include "qapi/qapi-commands-block.h"
39 #include "qapi/qapi-commands-machine.h"
40 #include "qapi/qapi-commands-misc.h"
41 #include "sysemu/blockdev.h"
42 #include "qemu-version.h"
43 #include "qemu/cutils.h"
44 #include "qemu/main-loop.h"
45 #include "qemu/module.h"
46 #include <Carbon/Carbon.h>
47 #include "hw/core/cpu.h"
49 #ifndef MAC_OS_X_VERSION_10_13
50 #define MAC_OS_X_VERSION_10_13 101300
53 /* 10.14 deprecates NSOnState and NSOffState in favor of
54 * NSControlStateValueOn/Off, which were introduced in 10.13.
55 * Define for older versions
57 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_13
58 #define NSControlStateValueOn NSOnState
59 #define NSControlStateValueOff NSOffState
65 #define COCOA_DEBUG(...) { (void) fprintf (stdout, __VA_ARGS__); }
67 #define COCOA_DEBUG(...) ((void) 0)
70 #define cgrect(nsrect) (*(CGRect *)&(nsrect))
77 static void cocoa_update(DisplayChangeListener *dcl,
78 int x, int y, int w, int h);
80 static void cocoa_switch(DisplayChangeListener *dcl,
81 DisplaySurface *surface);
83 static void cocoa_refresh(DisplayChangeListener *dcl);
85 static NSWindow *normalWindow, *about_window;
86 static const DisplayChangeListenerOps dcl_ops = {
88 .dpy_gfx_update = cocoa_update,
89 .dpy_gfx_switch = cocoa_switch,
90 .dpy_refresh = cocoa_refresh,
92 static DisplayChangeListener dcl = {
95 static int last_buttons;
96 static int cursor_hide = 1;
100 static bool stretch_video;
101 static NSTextField *pauseLabel;
102 static NSArray * supportedImageFileTypes;
104 static QemuSemaphore display_init_sem;
105 static QemuSemaphore app_started_sem;
106 static bool allow_events;
108 // Utility functions to run specified code block with iothread lock held
109 typedef void (^CodeBlock)(void);
110 typedef bool (^BoolCodeBlock)(void);
112 static void with_iothread_lock(CodeBlock block)
114 bool locked = qemu_mutex_iothread_locked();
116 qemu_mutex_lock_iothread();
120 qemu_mutex_unlock_iothread();
124 static bool bool_with_iothread_lock(BoolCodeBlock block)
126 bool locked = qemu_mutex_iothread_locked();
130 qemu_mutex_lock_iothread();
134 qemu_mutex_unlock_iothread();
139 // Mac to QKeyCode conversion
140 static const int mac_to_qkeycode_map[] = {
141 [kVK_ANSI_A] = Q_KEY_CODE_A,
142 [kVK_ANSI_B] = Q_KEY_CODE_B,
143 [kVK_ANSI_C] = Q_KEY_CODE_C,
144 [kVK_ANSI_D] = Q_KEY_CODE_D,
145 [kVK_ANSI_E] = Q_KEY_CODE_E,
146 [kVK_ANSI_F] = Q_KEY_CODE_F,
147 [kVK_ANSI_G] = Q_KEY_CODE_G,
148 [kVK_ANSI_H] = Q_KEY_CODE_H,
149 [kVK_ANSI_I] = Q_KEY_CODE_I,
150 [kVK_ANSI_J] = Q_KEY_CODE_J,
151 [kVK_ANSI_K] = Q_KEY_CODE_K,
152 [kVK_ANSI_L] = Q_KEY_CODE_L,
153 [kVK_ANSI_M] = Q_KEY_CODE_M,
154 [kVK_ANSI_N] = Q_KEY_CODE_N,
155 [kVK_ANSI_O] = Q_KEY_CODE_O,
156 [kVK_ANSI_P] = Q_KEY_CODE_P,
157 [kVK_ANSI_Q] = Q_KEY_CODE_Q,
158 [kVK_ANSI_R] = Q_KEY_CODE_R,
159 [kVK_ANSI_S] = Q_KEY_CODE_S,
160 [kVK_ANSI_T] = Q_KEY_CODE_T,
161 [kVK_ANSI_U] = Q_KEY_CODE_U,
162 [kVK_ANSI_V] = Q_KEY_CODE_V,
163 [kVK_ANSI_W] = Q_KEY_CODE_W,
164 [kVK_ANSI_X] = Q_KEY_CODE_X,
165 [kVK_ANSI_Y] = Q_KEY_CODE_Y,
166 [kVK_ANSI_Z] = Q_KEY_CODE_Z,
168 [kVK_ANSI_0] = Q_KEY_CODE_0,
169 [kVK_ANSI_1] = Q_KEY_CODE_1,
170 [kVK_ANSI_2] = Q_KEY_CODE_2,
171 [kVK_ANSI_3] = Q_KEY_CODE_3,
172 [kVK_ANSI_4] = Q_KEY_CODE_4,
173 [kVK_ANSI_5] = Q_KEY_CODE_5,
174 [kVK_ANSI_6] = Q_KEY_CODE_6,
175 [kVK_ANSI_7] = Q_KEY_CODE_7,
176 [kVK_ANSI_8] = Q_KEY_CODE_8,
177 [kVK_ANSI_9] = Q_KEY_CODE_9,
179 [kVK_ANSI_Grave] = Q_KEY_CODE_GRAVE_ACCENT,
180 [kVK_ANSI_Minus] = Q_KEY_CODE_MINUS,
181 [kVK_ANSI_Equal] = Q_KEY_CODE_EQUAL,
182 [kVK_Delete] = Q_KEY_CODE_BACKSPACE,
183 [kVK_CapsLock] = Q_KEY_CODE_CAPS_LOCK,
184 [kVK_Tab] = Q_KEY_CODE_TAB,
185 [kVK_Return] = Q_KEY_CODE_RET,
186 [kVK_ANSI_LeftBracket] = Q_KEY_CODE_BRACKET_LEFT,
187 [kVK_ANSI_RightBracket] = Q_KEY_CODE_BRACKET_RIGHT,
188 [kVK_ANSI_Backslash] = Q_KEY_CODE_BACKSLASH,
189 [kVK_ANSI_Semicolon] = Q_KEY_CODE_SEMICOLON,
190 [kVK_ANSI_Quote] = Q_KEY_CODE_APOSTROPHE,
191 [kVK_ANSI_Comma] = Q_KEY_CODE_COMMA,
192 [kVK_ANSI_Period] = Q_KEY_CODE_DOT,
193 [kVK_ANSI_Slash] = Q_KEY_CODE_SLASH,
194 [kVK_Space] = Q_KEY_CODE_SPC,
196 [kVK_ANSI_Keypad0] = Q_KEY_CODE_KP_0,
197 [kVK_ANSI_Keypad1] = Q_KEY_CODE_KP_1,
198 [kVK_ANSI_Keypad2] = Q_KEY_CODE_KP_2,
199 [kVK_ANSI_Keypad3] = Q_KEY_CODE_KP_3,
200 [kVK_ANSI_Keypad4] = Q_KEY_CODE_KP_4,
201 [kVK_ANSI_Keypad5] = Q_KEY_CODE_KP_5,
202 [kVK_ANSI_Keypad6] = Q_KEY_CODE_KP_6,
203 [kVK_ANSI_Keypad7] = Q_KEY_CODE_KP_7,
204 [kVK_ANSI_Keypad8] = Q_KEY_CODE_KP_8,
205 [kVK_ANSI_Keypad9] = Q_KEY_CODE_KP_9,
206 [kVK_ANSI_KeypadDecimal] = Q_KEY_CODE_KP_DECIMAL,
207 [kVK_ANSI_KeypadEnter] = Q_KEY_CODE_KP_ENTER,
208 [kVK_ANSI_KeypadPlus] = Q_KEY_CODE_KP_ADD,
209 [kVK_ANSI_KeypadMinus] = Q_KEY_CODE_KP_SUBTRACT,
210 [kVK_ANSI_KeypadMultiply] = Q_KEY_CODE_KP_MULTIPLY,
211 [kVK_ANSI_KeypadDivide] = Q_KEY_CODE_KP_DIVIDE,
212 [kVK_ANSI_KeypadEquals] = Q_KEY_CODE_KP_EQUALS,
213 [kVK_ANSI_KeypadClear] = Q_KEY_CODE_NUM_LOCK,
215 [kVK_UpArrow] = Q_KEY_CODE_UP,
216 [kVK_DownArrow] = Q_KEY_CODE_DOWN,
217 [kVK_LeftArrow] = Q_KEY_CODE_LEFT,
218 [kVK_RightArrow] = Q_KEY_CODE_RIGHT,
220 [kVK_Help] = Q_KEY_CODE_INSERT,
221 [kVK_Home] = Q_KEY_CODE_HOME,
222 [kVK_PageUp] = Q_KEY_CODE_PGUP,
223 [kVK_PageDown] = Q_KEY_CODE_PGDN,
224 [kVK_End] = Q_KEY_CODE_END,
225 [kVK_ForwardDelete] = Q_KEY_CODE_DELETE,
227 [kVK_Escape] = Q_KEY_CODE_ESC,
229 /* The Power key can't be used directly because the operating system uses
230 * it. This key can be emulated by using it in place of another key such as
231 * F1. Don't forget to disable the real key binding.
233 /* [kVK_F1] = Q_KEY_CODE_POWER, */
235 [kVK_F1] = Q_KEY_CODE_F1,
236 [kVK_F2] = Q_KEY_CODE_F2,
237 [kVK_F3] = Q_KEY_CODE_F3,
238 [kVK_F4] = Q_KEY_CODE_F4,
239 [kVK_F5] = Q_KEY_CODE_F5,
240 [kVK_F6] = Q_KEY_CODE_F6,
241 [kVK_F7] = Q_KEY_CODE_F7,
242 [kVK_F8] = Q_KEY_CODE_F8,
243 [kVK_F9] = Q_KEY_CODE_F9,
244 [kVK_F10] = Q_KEY_CODE_F10,
245 [kVK_F11] = Q_KEY_CODE_F11,
246 [kVK_F12] = Q_KEY_CODE_F12,
247 [kVK_F13] = Q_KEY_CODE_PRINT,
248 [kVK_F14] = Q_KEY_CODE_SCROLL_LOCK,
249 [kVK_F15] = Q_KEY_CODE_PAUSE,
251 // JIS keyboards only
252 [kVK_JIS_Yen] = Q_KEY_CODE_YEN,
253 [kVK_JIS_Underscore] = Q_KEY_CODE_RO,
254 [kVK_JIS_KeypadComma] = Q_KEY_CODE_KP_COMMA,
255 [kVK_JIS_Eisu] = Q_KEY_CODE_MUHENKAN,
256 [kVK_JIS_Kana] = Q_KEY_CODE_HENKAN,
259 * The eject and volume keys can't be used here because they are handled at
260 * a lower level than what an Application can see.
264 static int cocoa_keycode_to_qemu(int keycode)
266 if (ARRAY_SIZE(mac_to_qkeycode_map) <= keycode) {
267 error_report("(cocoa) warning unknown keycode 0x%x", keycode);
270 return mac_to_qkeycode_map[keycode];
273 /* Displays an alert dialog box with the specified message */
274 static void QEMU_Alert(NSString *message)
277 alert = [NSAlert new];
278 [alert setMessageText: message];
282 /* Handles any errors that happen with a device transaction */
283 static void handleAnyDeviceErrors(Error * err)
286 QEMU_Alert([NSString stringWithCString: error_get_pretty(err)
287 encoding: NSASCIIStringEncoding]);
293 ------------------------------------------------------
295 ------------------------------------------------------
297 @interface QemuCocoaView : NSView
300 NSWindow *fullScreenWindow;
301 float cx,cy,cw,ch,cdx,cdy;
302 pixman_image_t *pixman_image;
306 BOOL isAbsoluteEnabled;
308 - (void) switchSurface:(pixman_image_t *)image;
310 - (void) ungrabMouse;
311 - (void) toggleFullScreen:(id)sender;
312 - (void) handleMonitorInput:(NSEvent *)event;
313 - (bool) handleEvent:(NSEvent *)event;
314 - (bool) handleEventLocked:(NSEvent *)event;
315 - (void) setAbsoluteEnabled:(BOOL)tIsAbsoluteEnabled;
316 /* The state surrounding mouse grabbing is potentially confusing.
317 * isAbsoluteEnabled tracks qemu_input_is_absolute() [ie "is the emulated
318 * pointing device an absolute-position one?"], but is only updated on
320 * isMouseGrabbed tracks whether GUI events are directed to the guest;
321 * it controls whether special keys like Cmd get sent to the guest,
322 * and whether we capture the mouse when in non-absolute mode.
324 - (BOOL) isMouseGrabbed;
325 - (BOOL) isAbsoluteEnabled;
328 - (QEMUScreen) gscreen;
329 - (void) raiseAllKeys;
332 QemuCocoaView *cocoaView;
334 @implementation QemuCocoaView
335 - (id)initWithFrame:(NSRect)frameRect
337 COCOA_DEBUG("QemuCocoaView: initWithFrame\n");
339 self = [super initWithFrame:frameRect];
342 screen.width = frameRect.size.width;
343 screen.height = frameRect.size.height;
344 kbd = qkbd_state_init(dcl.con);
352 COCOA_DEBUG("QemuCocoaView: dealloc\n");
355 pixman_image_unref(pixman_image);
358 qkbd_state_free(kbd);
367 - (BOOL) screenContainsPoint:(NSPoint) p
369 return (p.x > -1 && p.x < screen.width && p.y > -1 && p.y < screen.height);
372 /* Get location of event and convert to virtual screen coordinate */
373 - (CGPoint) screenLocationOfEvent:(NSEvent *)ev
375 NSWindow *eventWindow = [ev window];
376 // XXX: Use CGRect and -convertRectFromScreen: to support macOS 10.10
377 CGRect r = CGRectZero;
378 r.origin = [ev locationInWindow];
381 return [[self window] convertRectFromScreen:r].origin;
383 CGPoint locationInSelfWindow = [[self window] convertRectFromScreen:r].origin;
384 CGPoint loc = [self convertPoint:locationInSelfWindow fromView:nil];
391 } else if ([[self window] isEqual:eventWindow]) {
395 CGPoint loc = [self convertPoint:r.origin fromView:nil];
403 return [[self window] convertRectFromScreen:[eventWindow convertRectToScreen:r]].origin;
415 - (void) unhideCursor
423 - (void) drawRect:(NSRect) rect
425 COCOA_DEBUG("QemuCocoaView: drawRect\n");
427 // get CoreGraphic context
428 CGContextRef viewContextRef = [[NSGraphicsContext currentContext] CGContext];
430 CGContextSetInterpolationQuality (viewContextRef, kCGInterpolationNone);
431 CGContextSetShouldAntialias (viewContextRef, NO);
433 // draw screen bitmap directly to Core Graphics context
435 // Draw request before any guest device has set up a framebuffer:
436 // just draw an opaque black rectangle
437 CGContextSetRGBFillColor(viewContextRef, 0, 0, 0, 1.0);
438 CGContextFillRect(viewContextRef, NSRectToCGRect(rect));
440 int w = pixman_image_get_width(pixman_image);
441 int h = pixman_image_get_height(pixman_image);
442 int bitsPerPixel = PIXMAN_FORMAT_BPP(pixman_image_get_format(pixman_image));
443 int stride = pixman_image_get_stride(pixman_image);
444 CGDataProviderRef dataProviderRef = CGDataProviderCreateWithData(
446 pixman_image_get_data(pixman_image),
450 CGImageRef imageRef = CGImageCreate(
453 DIV_ROUND_UP(bitsPerPixel, 8) * 2, //bitsPerComponent
454 bitsPerPixel, //bitsPerPixel
455 stride, //bytesPerRow
456 CGColorSpaceCreateWithName(kCGColorSpaceSRGB), //colorspace
457 kCGBitmapByteOrder32Little | kCGImageAlphaNoneSkipFirst, //bitmapInfo
458 dataProviderRef, //provider
461 kCGRenderingIntentDefault //intent
463 // selective drawing code (draws only dirty rectangles) (OS X >= 10.4)
464 const NSRect *rectList;
467 CGImageRef clipImageRef;
470 [self getRectsBeingDrawn:&rectList count:&rectCount];
471 for (i = 0; i < rectCount; i++) {
472 clipRect.origin.x = rectList[i].origin.x / cdx;
473 clipRect.origin.y = (float)h - (rectList[i].origin.y + rectList[i].size.height) / cdy;
474 clipRect.size.width = rectList[i].size.width / cdx;
475 clipRect.size.height = rectList[i].size.height / cdy;
476 clipImageRef = CGImageCreateWithImageInRect(
480 CGContextDrawImage (viewContextRef, cgrect(rectList[i]), clipImageRef);
481 CGImageRelease (clipImageRef);
483 CGImageRelease (imageRef);
484 CGDataProviderRelease(dataProviderRef);
488 - (void) setContentDimensions
490 COCOA_DEBUG("QemuCocoaView: setContentDimensions\n");
493 cdx = [[NSScreen mainScreen] frame].size.width / (float)screen.width;
494 cdy = [[NSScreen mainScreen] frame].size.height / (float)screen.height;
496 /* stretches video, but keeps same aspect ratio */
497 if (stretch_video == true) {
498 /* use smallest stretch value - prevents clipping on sides */
499 if (MIN(cdx, cdy) == cdx) {
504 } else { /* No stretching */
507 cw = screen.width * cdx;
508 ch = screen.height * cdy;
509 cx = ([[NSScreen mainScreen] frame].size.width - cw) / 2.0;
510 cy = ([[NSScreen mainScreen] frame].size.height - ch) / 2.0;
521 - (void) switchSurface:(pixman_image_t *)image
523 COCOA_DEBUG("QemuCocoaView: switchSurface\n");
525 int w = pixman_image_get_width(image);
526 int h = pixman_image_get_height(image);
527 /* cdx == 0 means this is our very first surface, in which case we need
528 * to recalculate the content dimensions even if it happens to be the size
529 * of the initial empty window.
531 bool isResize = (w != screen.width || h != screen.height || cdx == 0.0);
533 int oldh = screen.height;
535 // Resize before we trigger the redraw, or we'll redraw at the wrong size
536 COCOA_DEBUG("switchSurface: new size %d x %d\n", w, h);
539 [self setContentDimensions];
540 [self setFrame:NSMakeRect(cx, cy, cw, ch)];
543 // update screenBuffer
545 pixman_image_unref(pixman_image);
548 pixman_image = image;
552 [[fullScreenWindow contentView] setFrame:[[NSScreen mainScreen] frame]];
553 [normalWindow setFrame:NSMakeRect([normalWindow frame].origin.x, [normalWindow frame].origin.y - h + oldh, w, h + [normalWindow frame].size.height - oldh) display:NO animate:NO];
556 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s", qemu_name]];
557 [normalWindow setFrame:NSMakeRect([normalWindow frame].origin.x, [normalWindow frame].origin.y - h + oldh, w, h + [normalWindow frame].size.height - oldh) display:YES animate:NO];
561 [normalWindow center];
565 - (void) toggleFullScreen:(id)sender
567 COCOA_DEBUG("QemuCocoaView: toggleFullScreen\n");
569 if (isFullscreen) { // switch from fullscreen to desktop
570 isFullscreen = FALSE;
572 [self setContentDimensions];
573 [fullScreenWindow close];
574 [normalWindow setContentView: self];
575 [normalWindow makeKeyAndOrderFront: self];
576 [NSMenu setMenuBarVisible:YES];
577 } else { // switch from desktop to fullscreen
579 [normalWindow orderOut: nil]; /* Hide the window */
581 [self setContentDimensions];
582 [NSMenu setMenuBarVisible:NO];
583 fullScreenWindow = [[NSWindow alloc] initWithContentRect:[[NSScreen mainScreen] frame]
584 styleMask:NSWindowStyleMaskBorderless
585 backing:NSBackingStoreBuffered
587 [fullScreenWindow setAcceptsMouseMovedEvents: YES];
588 [fullScreenWindow setHasShadow:NO];
589 [fullScreenWindow setBackgroundColor: [NSColor blackColor]];
590 [self setFrame:NSMakeRect(cx, cy, cw, ch)];
591 [[fullScreenWindow contentView] addSubview: self];
592 [fullScreenWindow makeKeyAndOrderFront:self];
596 - (void) toggleKey: (int)keycode {
597 qkbd_state_key_event(kbd, keycode, !qkbd_state_key_get(kbd, keycode));
600 // Does the work of sending input to the monitor
601 - (void) handleMonitorInput:(NSEvent *)event
606 // if the control key is down
607 if ([event modifierFlags] & NSEventModifierFlagControl) {
611 /* translates Macintosh keycodes to QEMU's keysym */
613 int without_control_translation[] = {
614 [0 ... 0xff] = 0, // invalid key
616 [kVK_UpArrow] = QEMU_KEY_UP,
617 [kVK_DownArrow] = QEMU_KEY_DOWN,
618 [kVK_RightArrow] = QEMU_KEY_RIGHT,
619 [kVK_LeftArrow] = QEMU_KEY_LEFT,
620 [kVK_Home] = QEMU_KEY_HOME,
621 [kVK_End] = QEMU_KEY_END,
622 [kVK_PageUp] = QEMU_KEY_PAGEUP,
623 [kVK_PageDown] = QEMU_KEY_PAGEDOWN,
624 [kVK_ForwardDelete] = QEMU_KEY_DELETE,
625 [kVK_Delete] = QEMU_KEY_BACKSPACE,
628 int with_control_translation[] = {
629 [0 ... 0xff] = 0, // invalid key
631 [kVK_UpArrow] = QEMU_KEY_CTRL_UP,
632 [kVK_DownArrow] = QEMU_KEY_CTRL_DOWN,
633 [kVK_RightArrow] = QEMU_KEY_CTRL_RIGHT,
634 [kVK_LeftArrow] = QEMU_KEY_CTRL_LEFT,
635 [kVK_Home] = QEMU_KEY_CTRL_HOME,
636 [kVK_End] = QEMU_KEY_CTRL_END,
637 [kVK_PageUp] = QEMU_KEY_CTRL_PAGEUP,
638 [kVK_PageDown] = QEMU_KEY_CTRL_PAGEDOWN,
641 if (control_key != 0) { /* If the control key is being used */
642 if ([event keyCode] < ARRAY_SIZE(with_control_translation)) {
643 keysym = with_control_translation[[event keyCode]];
646 if ([event keyCode] < ARRAY_SIZE(without_control_translation)) {
647 keysym = without_control_translation[[event keyCode]];
651 // if not a key that needs translating
653 NSString *ks = [event characters];
654 if ([ks length] > 0) {
655 keysym = [ks characterAtIndex:0];
660 kbd_put_keysym(keysym);
664 - (bool) handleEvent:(NSEvent *)event
668 * Just let OSX have all events that arrive before
669 * applicationDidFinishLaunching.
670 * This avoids a deadlock on the iothread lock, which cocoa_display_init()
671 * will not drop until after the app_started_sem is posted. (In theory
672 * there should not be any such events, but OSX Catalina now emits some.)
676 return bool_with_iothread_lock(^{
677 return [self handleEventLocked:event];
681 - (bool) handleEventLocked:(NSEvent *)event
683 /* Return true if we handled the event, false if it should be given to OSX */
684 COCOA_DEBUG("QemuCocoaView: handleEvent\n");
687 bool mouse_event = false;
688 static bool switched_to_fullscreen = false;
689 // Location of event in virtual screen coordinates
690 NSPoint p = [self screenLocationOfEvent:event];
691 NSUInteger modifiers = [event modifierFlags];
693 // emulate caps lock keydown and keyup
694 if (!!(modifiers & NSEventModifierFlagCapsLock) !=
695 qkbd_state_modifier_get(kbd, QKBD_MOD_CAPSLOCK)) {
696 qkbd_state_key_event(kbd, Q_KEY_CODE_CAPS_LOCK, true);
697 qkbd_state_key_event(kbd, Q_KEY_CODE_CAPS_LOCK, false);
700 if (!(modifiers & NSEventModifierFlagShift)) {
701 qkbd_state_key_event(kbd, Q_KEY_CODE_SHIFT, false);
702 qkbd_state_key_event(kbd, Q_KEY_CODE_SHIFT_R, false);
704 if (!(modifiers & NSEventModifierFlagControl)) {
705 qkbd_state_key_event(kbd, Q_KEY_CODE_CTRL, false);
706 qkbd_state_key_event(kbd, Q_KEY_CODE_CTRL_R, false);
708 if (!(modifiers & NSEventModifierFlagOption)) {
709 qkbd_state_key_event(kbd, Q_KEY_CODE_ALT, false);
710 qkbd_state_key_event(kbd, Q_KEY_CODE_ALT_R, false);
712 if (!(modifiers & NSEventModifierFlagCommand)) {
713 qkbd_state_key_event(kbd, Q_KEY_CODE_META_L, false);
714 qkbd_state_key_event(kbd, Q_KEY_CODE_META_R, false);
717 switch ([event type]) {
718 case NSEventTypeFlagsChanged:
719 switch ([event keyCode]) {
721 if (!!(modifiers & NSEventModifierFlagShift)) {
722 [self toggleKey:Q_KEY_CODE_SHIFT];
727 if (!!(modifiers & NSEventModifierFlagShift)) {
728 [self toggleKey:Q_KEY_CODE_SHIFT_R];
733 if (!!(modifiers & NSEventModifierFlagControl)) {
734 [self toggleKey:Q_KEY_CODE_CTRL];
738 case kVK_RightControl:
739 if (!!(modifiers & NSEventModifierFlagControl)) {
740 [self toggleKey:Q_KEY_CODE_CTRL_R];
745 if (!!(modifiers & NSEventModifierFlagOption)) {
746 [self toggleKey:Q_KEY_CODE_ALT];
750 case kVK_RightOption:
751 if (!!(modifiers & NSEventModifierFlagOption)) {
752 [self toggleKey:Q_KEY_CODE_ALT_R];
756 /* Don't pass command key changes to guest unless mouse is grabbed */
758 if (isMouseGrabbed &&
759 !!(modifiers & NSEventModifierFlagCommand)) {
760 [self toggleKey:Q_KEY_CODE_META_L];
764 case kVK_RightCommand:
765 if (isMouseGrabbed &&
766 !!(modifiers & NSEventModifierFlagCommand)) {
767 [self toggleKey:Q_KEY_CODE_META_R];
772 case NSEventTypeKeyDown:
773 keycode = cocoa_keycode_to_qemu([event keyCode]);
775 // forward command key combos to the host UI unless the mouse is grabbed
776 if (!isMouseGrabbed && ([event modifierFlags] & NSEventModifierFlagCommand)) {
778 * Prevent the command key from being stuck down in the guest
779 * when using Command-F to switch to full screen mode.
781 if (keycode == Q_KEY_CODE_F) {
782 switched_to_fullscreen = true;
789 // handle control + alt Key Combos (ctrl+alt+[1..9,g] is reserved for QEMU)
790 if (([event modifierFlags] & NSEventModifierFlagControl) && ([event modifierFlags] & NSEventModifierFlagOption)) {
791 NSString *keychar = [event charactersIgnoringModifiers];
792 if ([keychar length] == 1) {
793 char key = [keychar characterAtIndex:0];
796 // enable graphic console
798 console_select(key - '0' - 1); /* ascii math */
801 // release the mouse grab
809 if (qemu_console_is_graphic(NULL)) {
810 qkbd_state_key_event(kbd, keycode, true);
812 [self handleMonitorInput: event];
815 case NSEventTypeKeyUp:
816 keycode = cocoa_keycode_to_qemu([event keyCode]);
818 // don't pass the guest a spurious key-up if we treated this
819 // command-key combo as a host UI action
820 if (!isMouseGrabbed && ([event modifierFlags] & NSEventModifierFlagCommand)) {
824 if (qemu_console_is_graphic(NULL)) {
825 qkbd_state_key_event(kbd, keycode, false);
828 case NSEventTypeMouseMoved:
829 if (isAbsoluteEnabled) {
830 // Cursor re-entered into a window might generate events bound to screen coordinates
831 // and `nil` window property, and in full screen mode, current window might not be
832 // key window, where event location alone should suffice.
833 if (![self screenContainsPoint:p] || !([[self window] isKeyWindow] || isFullscreen)) {
834 if (isMouseGrabbed) {
838 if (!isMouseGrabbed) {
845 case NSEventTypeLeftMouseDown:
846 buttons |= MOUSE_EVENT_LBUTTON;
849 case NSEventTypeRightMouseDown:
850 buttons |= MOUSE_EVENT_RBUTTON;
853 case NSEventTypeOtherMouseDown:
854 buttons |= MOUSE_EVENT_MBUTTON;
857 case NSEventTypeLeftMouseDragged:
858 buttons |= MOUSE_EVENT_LBUTTON;
861 case NSEventTypeRightMouseDragged:
862 buttons |= MOUSE_EVENT_RBUTTON;
865 case NSEventTypeOtherMouseDragged:
866 buttons |= MOUSE_EVENT_MBUTTON;
869 case NSEventTypeLeftMouseUp:
871 if (!isMouseGrabbed && [self screenContainsPoint:p]) {
873 * In fullscreen mode, the window of cocoaView may not be the
874 * key window, therefore the position relative to the virtual
875 * screen alone will be sufficient.
877 if(isFullscreen || [[self window] isKeyWindow]) {
882 case NSEventTypeRightMouseUp:
885 case NSEventTypeOtherMouseUp:
888 case NSEventTypeScrollWheel:
890 * Send wheel events to the guest regardless of window focus.
891 * This is in-line with standard Mac OS X UI behaviour.
895 * When deltaY is zero, it means that this scrolling event was
896 * either horizontal, or so fine that it only appears in
897 * scrollingDeltaY. So we drop the event.
899 if ([event deltaY] != 0) {
900 /* Determine if this is a scroll up or scroll down event */
901 buttons = ([event deltaY] > 0) ?
902 INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
903 qemu_input_queue_btn(dcl.con, buttons, true);
904 qemu_input_event_sync();
905 qemu_input_queue_btn(dcl.con, buttons, false);
906 qemu_input_event_sync();
909 * Since deltaY also reports scroll wheel events we prevent mouse
910 * movement code from executing.
919 /* Don't send button events to the guest unless we've got a
920 * mouse grab or window focus. If we have neither then this event
921 * is the user clicking on the background window to activate and
922 * bring us to the front, which will be done by the sendEvent
923 * call below. We definitely don't want to pass that click through
926 if ((isMouseGrabbed || [[self window] isKeyWindow]) &&
927 (last_buttons != buttons)) {
928 static uint32_t bmap[INPUT_BUTTON__MAX] = {
929 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
930 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
931 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON
933 qemu_input_update_buttons(dcl.con, bmap, last_buttons, buttons);
934 last_buttons = buttons;
936 if (isMouseGrabbed) {
937 if (isAbsoluteEnabled) {
938 /* Note that the origin for Cocoa mouse coords is bottom left, not top left.
939 * The check on screenContainsPoint is to avoid sending out of range values for
940 * clicks in the titlebar.
942 if ([self screenContainsPoint:p]) {
943 qemu_input_queue_abs(dcl.con, INPUT_AXIS_X, p.x, 0, screen.width);
944 qemu_input_queue_abs(dcl.con, INPUT_AXIS_Y, screen.height - p.y, 0, screen.height);
947 qemu_input_queue_rel(dcl.con, INPUT_AXIS_X, (int)[event deltaX]);
948 qemu_input_queue_rel(dcl.con, INPUT_AXIS_Y, (int)[event deltaY]);
953 qemu_input_event_sync();
960 COCOA_DEBUG("QemuCocoaView: grabMouse\n");
964 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s - (Press ctrl + alt + g to release Mouse)", qemu_name]];
966 [normalWindow setTitle:@"QEMU - (Press ctrl + alt + g to release Mouse)"];
969 CGAssociateMouseAndMouseCursorPosition(isAbsoluteEnabled);
970 isMouseGrabbed = TRUE; // while isMouseGrabbed = TRUE, QemuCocoaApp sends all events to [cocoaView handleEvent:]
975 COCOA_DEBUG("QemuCocoaView: ungrabMouse\n");
979 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s", qemu_name]];
981 [normalWindow setTitle:@"QEMU"];
984 CGAssociateMouseAndMouseCursorPosition(TRUE);
985 isMouseGrabbed = FALSE;
988 - (void) setAbsoluteEnabled:(BOOL)tIsAbsoluteEnabled {
989 isAbsoluteEnabled = tIsAbsoluteEnabled;
990 if (isMouseGrabbed) {
991 CGAssociateMouseAndMouseCursorPosition(isAbsoluteEnabled);
994 - (BOOL) isMouseGrabbed {return isMouseGrabbed;}
995 - (BOOL) isAbsoluteEnabled {return isAbsoluteEnabled;}
996 - (float) cdx {return cdx;}
997 - (float) cdy {return cdy;}
998 - (QEMUScreen) gscreen {return screen;}
1001 * Makes the target think all down keys are being released.
1002 * This prevents a stuck key problem, since we will not see
1003 * key up events for those keys after we have lost focus.
1005 - (void) raiseAllKeys
1007 with_iothread_lock(^{
1008 qkbd_state_lift_all_keys(kbd);
1016 ------------------------------------------------------
1017 QemuCocoaAppController
1018 ------------------------------------------------------
1020 @interface QemuCocoaAppController : NSObject
1021 <NSWindowDelegate, NSApplicationDelegate>
1024 - (void)doToggleFullScreen:(id)sender;
1025 - (void)toggleFullScreen:(id)sender;
1026 - (void)showQEMUDoc:(id)sender;
1027 - (void)zoomToFit:(id) sender;
1028 - (void)displayConsole:(id)sender;
1029 - (void)pauseQEMU:(id)sender;
1030 - (void)resumeQEMU:(id)sender;
1031 - (void)displayPause;
1032 - (void)removePause;
1033 - (void)restartQEMU:(id)sender;
1034 - (void)powerDownQEMU:(id)sender;
1035 - (void)ejectDeviceMedia:(id)sender;
1036 - (void)changeDeviceMedia:(id)sender;
1038 - (void)openDocumentation:(NSString *)filename;
1039 - (IBAction) do_about_menu_item: (id) sender;
1040 - (void)make_about_window;
1041 - (void)adjustSpeed:(id)sender;
1044 @implementation QemuCocoaAppController
1047 COCOA_DEBUG("QemuCocoaAppController: init\n");
1049 self = [super init];
1052 // create a view and add it to the window
1053 cocoaView = [[QemuCocoaView alloc] initWithFrame:NSMakeRect(0.0, 0.0, 640.0, 480.0)];
1055 error_report("(cocoa) can't create a view");
1060 normalWindow = [[NSWindow alloc] initWithContentRect:[cocoaView frame]
1061 styleMask:NSWindowStyleMaskTitled|NSWindowStyleMaskMiniaturizable|NSWindowStyleMaskClosable
1062 backing:NSBackingStoreBuffered defer:NO];
1064 error_report("(cocoa) can't create window");
1067 [normalWindow setAcceptsMouseMovedEvents:YES];
1068 [normalWindow setTitle:@"QEMU"];
1069 [normalWindow setContentView:cocoaView];
1070 [normalWindow makeKeyAndOrderFront:self];
1071 [normalWindow center];
1072 [normalWindow setDelegate: self];
1073 stretch_video = false;
1075 /* Used for displaying pause on the screen */
1076 pauseLabel = [NSTextField new];
1077 [pauseLabel setBezeled:YES];
1078 [pauseLabel setDrawsBackground:YES];
1079 [pauseLabel setBackgroundColor: [NSColor whiteColor]];
1080 [pauseLabel setEditable:NO];
1081 [pauseLabel setSelectable:NO];
1082 [pauseLabel setStringValue: @"Paused"];
1083 [pauseLabel setFont: [NSFont fontWithName: @"Helvetica" size: 90]];
1084 [pauseLabel setTextColor: [NSColor blackColor]];
1085 [pauseLabel sizeToFit];
1087 // set the supported image file types that can be opened
1088 supportedImageFileTypes = [NSArray arrayWithObjects: @"img", @"iso", @"dmg",
1089 @"qcow", @"qcow2", @"cloop", @"vmdk", @"cdr",
1091 [self make_about_window];
1098 COCOA_DEBUG("QemuCocoaAppController: dealloc\n");
1101 [cocoaView release];
1105 - (void)applicationDidFinishLaunching: (NSNotification *) note
1107 COCOA_DEBUG("QemuCocoaAppController: applicationDidFinishLaunching\n");
1108 allow_events = true;
1109 /* Tell cocoa_display_init to proceed */
1110 qemu_sem_post(&app_started_sem);
1113 - (void)applicationWillTerminate:(NSNotification *)aNotification
1115 COCOA_DEBUG("QemuCocoaAppController: applicationWillTerminate\n");
1117 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_UI);
1120 * Sleep here, because returning will cause OSX to kill us
1121 * immediately; the QEMU main loop will handle the shutdown
1122 * request and terminate the process.
1124 [NSThread sleepForTimeInterval:INFINITY];
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 /* Make the picture of QEMU */
1392 NSImageView *picture_view = [[NSImageView alloc] initWithFrame:
1394 char *qemu_image_path_c = get_relocated_path(CONFIG_QEMU_ICONDIR "/hicolor/512x512/apps/qemu.png");
1395 NSString *qemu_image_path = [NSString stringWithUTF8String:qemu_image_path_c];
1396 g_free(qemu_image_path_c);
1397 NSImage *qemu_image = [[NSImage alloc] initWithContentsOfFile:qemu_image_path];
1398 [picture_view setImage: qemu_image];
1399 [picture_view setImageScaling: NSImageScaleProportionallyUpOrDown];
1400 [superView addSubview: picture_view];
1402 /* Make the name label */
1403 NSBundle *bundle = [NSBundle mainBundle];
1407 int name_width = about_width, name_height = 20;
1408 NSRect name_rect = NSMakeRect(x, y, name_width, name_height);
1409 NSTextField *name_label = [[NSTextField alloc] initWithFrame: name_rect];
1410 [name_label setEditable: NO];
1411 [name_label setBezeled: NO];
1412 [name_label setDrawsBackground: NO];
1413 [name_label setAlignment: NSTextAlignmentCenter];
1414 NSString *qemu_name = [[bundle executablePath] lastPathComponent];
1415 [name_label setStringValue: qemu_name];
1416 [superView addSubview: name_label];
1419 /* Set the version label's attributes */
1422 int version_width = about_width, version_height = 20;
1423 NSRect version_rect = NSMakeRect(x, y, version_width, version_height);
1424 NSTextField *version_label = [[NSTextField alloc] initWithFrame:
1426 [version_label setEditable: NO];
1427 [version_label setBezeled: NO];
1428 [version_label setAlignment: NSTextAlignmentCenter];
1429 [version_label setDrawsBackground: NO];
1431 /* Create the version string*/
1432 NSString *version_string;
1433 version_string = [[NSString alloc] initWithFormat:
1434 @"QEMU emulator version %s", QEMU_FULL_VERSION];
1435 [version_label setStringValue: version_string];
1436 [superView addSubview: version_label];
1438 /* Make copyright label */
1441 int copyright_width = about_width, copyright_height = 20;
1442 NSRect copyright_rect = NSMakeRect(x, y, copyright_width, copyright_height);
1443 NSTextField *copyright_label = [[NSTextField alloc] initWithFrame:
1445 [copyright_label setEditable: NO];
1446 [copyright_label setBezeled: NO];
1447 [copyright_label setDrawsBackground: NO];
1448 [copyright_label setAlignment: NSTextAlignmentCenter];
1449 [copyright_label setStringValue: [NSString stringWithFormat: @"%s",
1451 [superView addSubview: copyright_label];
1454 /* Used by the Speed menu items */
1455 - (void)adjustSpeed:(id)sender
1457 int throttle_pct; /* throttle percentage */
1460 menu = [sender menu];
1463 /* Unselect the currently selected item */
1464 for (NSMenuItem *item in [menu itemArray]) {
1465 if (item.state == NSControlStateValueOn) {
1466 [item setState: NSControlStateValueOff];
1472 // check the menu item
1473 [sender setState: NSControlStateValueOn];
1475 // get the throttle percentage
1476 throttle_pct = [sender tag];
1478 with_iothread_lock(^{
1479 cpu_throttle_set(throttle_pct);
1481 COCOA_DEBUG("cpu throttling at %d%c\n", cpu_throttle_get_percentage(), '%');
1486 @interface QemuApplication : NSApplication
1489 @implementation QemuApplication
1490 - (void)sendEvent:(NSEvent *)event
1492 COCOA_DEBUG("QemuApplication: sendEvent\n");
1493 if (![cocoaView handleEvent:event]) {
1494 [super sendEvent: event];
1499 static void create_initial_menus(void)
1503 NSMenuItem *menuItem;
1505 [NSApp setMainMenu:[[NSMenu alloc] init]];
1508 menu = [[NSMenu alloc] initWithTitle:@""];
1509 [menu addItemWithTitle:@"About QEMU" action:@selector(do_about_menu_item:) keyEquivalent:@""]; // About QEMU
1510 [menu addItem:[NSMenuItem separatorItem]]; //Separator
1511 [menu addItemWithTitle:@"Hide QEMU" action:@selector(hide:) keyEquivalent:@"h"]; //Hide QEMU
1512 menuItem = (NSMenuItem *)[menu addItemWithTitle:@"Hide Others" action:@selector(hideOtherApplications:) keyEquivalent:@"h"]; // Hide Others
1513 [menuItem setKeyEquivalentModifierMask:(NSEventModifierFlagOption|NSEventModifierFlagCommand)];
1514 [menu addItemWithTitle:@"Show All" action:@selector(unhideAllApplications:) keyEquivalent:@""]; // Show All
1515 [menu addItem:[NSMenuItem separatorItem]]; //Separator
1516 [menu addItemWithTitle:@"Quit QEMU" action:@selector(terminate:) keyEquivalent:@"q"];
1517 menuItem = [[NSMenuItem alloc] initWithTitle:@"Apple" action:nil keyEquivalent:@""];
1518 [menuItem setSubmenu:menu];
1519 [[NSApp mainMenu] addItem:menuItem];
1520 [NSApp performSelector:@selector(setAppleMenu:) withObject:menu]; // Workaround (this method is private since 10.4+)
1523 menu = [[NSMenu alloc] initWithTitle: @"Machine"];
1524 [menu setAutoenablesItems: NO];
1525 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Pause" action: @selector(pauseQEMU:) keyEquivalent: @""] autorelease]];
1526 menuItem = [[[NSMenuItem alloc] initWithTitle: @"Resume" action: @selector(resumeQEMU:) keyEquivalent: @""] autorelease];
1527 [menu addItem: menuItem];
1528 [menuItem setEnabled: NO];
1529 [menu addItem: [NSMenuItem separatorItem]];
1530 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Reset" action: @selector(restartQEMU:) keyEquivalent: @""] autorelease]];
1531 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Power Down" action: @selector(powerDownQEMU:) keyEquivalent: @""] autorelease]];
1532 menuItem = [[[NSMenuItem alloc] initWithTitle: @"Machine" action:nil keyEquivalent:@""] autorelease];
1533 [menuItem setSubmenu:menu];
1534 [[NSApp mainMenu] addItem:menuItem];
1537 menu = [[NSMenu alloc] initWithTitle:@"View"];
1538 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Enter Fullscreen" action:@selector(doToggleFullScreen:) keyEquivalent:@"f"] autorelease]]; // Fullscreen
1539 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Zoom To Fit" action:@selector(zoomToFit:) keyEquivalent:@""] autorelease]];
1540 menuItem = [[[NSMenuItem alloc] initWithTitle:@"View" action:nil keyEquivalent:@""] autorelease];
1541 [menuItem setSubmenu:menu];
1542 [[NSApp mainMenu] addItem:menuItem];
1545 menu = [[NSMenu alloc] initWithTitle:@"Speed"];
1547 // Add the rest of the Speed menu items
1548 int p, percentage, throttle_pct;
1549 for (p = 10; p >= 0; p--)
1551 percentage = p * 10 > 1 ? p * 10 : 1; // prevent a 0% menu item
1553 menuItem = [[[NSMenuItem alloc]
1554 initWithTitle: [NSString stringWithFormat: @"%d%%", percentage] action:@selector(adjustSpeed:) keyEquivalent:@""] autorelease];
1556 if (percentage == 100) {
1557 [menuItem setState: NSControlStateValueOn];
1560 /* Calculate the throttle percentage */
1561 throttle_pct = -1 * percentage + 100;
1563 [menuItem setTag: throttle_pct];
1564 [menu addItem: menuItem];
1566 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Speed" action:nil keyEquivalent:@""] autorelease];
1567 [menuItem setSubmenu:menu];
1568 [[NSApp mainMenu] addItem:menuItem];
1571 menu = [[NSMenu alloc] initWithTitle:@"Window"];
1572 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Minimize" action:@selector(performMiniaturize:) keyEquivalent:@"m"] autorelease]]; // Miniaturize
1573 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""] autorelease];
1574 [menuItem setSubmenu:menu];
1575 [[NSApp mainMenu] addItem:menuItem];
1576 [NSApp setWindowsMenu:menu];
1579 menu = [[NSMenu alloc] initWithTitle:@"Help"];
1580 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"QEMU Documentation" action:@selector(showQEMUDoc:) keyEquivalent:@"?"] autorelease]]; // QEMU Help
1581 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""] autorelease];
1582 [menuItem setSubmenu:menu];
1583 [[NSApp mainMenu] addItem:menuItem];
1586 /* Returns a name for a given console */
1587 static NSString * getConsoleName(QemuConsole * console)
1589 return [NSString stringWithFormat: @"%s", qemu_console_get_label(console)];
1592 /* Add an entry to the View menu for each console */
1593 static void add_console_menu_entries(void)
1596 NSMenuItem *menuItem;
1599 menu = [[[NSApp mainMenu] itemWithTitle:@"View"] submenu];
1601 [menu addItem:[NSMenuItem separatorItem]];
1603 while (qemu_console_lookup_by_index(index) != NULL) {
1604 menuItem = [[[NSMenuItem alloc] initWithTitle: getConsoleName(qemu_console_lookup_by_index(index))
1605 action: @selector(displayConsole:) keyEquivalent: @""] autorelease];
1606 [menuItem setTag: index];
1607 [menu addItem: menuItem];
1612 /* Make menu items for all removable devices.
1613 * Each device is given an 'Eject' and 'Change' menu item.
1615 static void addRemovableDevicesMenuItems(void)
1618 NSMenuItem *menuItem;
1619 BlockInfoList *currentDevice, *pointerToFree;
1620 NSString *deviceName;
1622 currentDevice = qmp_query_block(NULL);
1623 pointerToFree = currentDevice;
1624 if(currentDevice == NULL) {
1626 QEMU_Alert(@"Failed to query for block devices!");
1630 menu = [[[NSApp mainMenu] itemWithTitle:@"Machine"] submenu];
1632 // Add a separator between related groups of menu items
1633 [menu addItem:[NSMenuItem separatorItem]];
1635 // Set the attributes to the "Removable Media" menu item
1636 NSString *titleString = @"Removable Media";
1637 NSMutableAttributedString *attString=[[NSMutableAttributedString alloc] initWithString:titleString];
1638 NSColor *newColor = [NSColor blackColor];
1639 NSFontManager *fontManager = [NSFontManager sharedFontManager];
1640 NSFont *font = [fontManager fontWithFamily:@"Helvetica"
1641 traits:NSBoldFontMask|NSItalicFontMask
1644 [attString addAttribute:NSFontAttributeName value:font range:NSMakeRange(0, [titleString length])];
1645 [attString addAttribute:NSForegroundColorAttributeName value:newColor range:NSMakeRange(0, [titleString length])];
1646 [attString addAttribute:NSUnderlineStyleAttributeName value:[NSNumber numberWithInt: 1] range:NSMakeRange(0, [titleString length])];
1648 // Add the "Removable Media" menu item
1649 menuItem = [NSMenuItem new];
1650 [menuItem setAttributedTitle: attString];
1651 [menuItem setEnabled: NO];
1652 [menu addItem: menuItem];
1654 /* Loop through all the block devices in the emulator */
1655 while (currentDevice) {
1656 deviceName = [[NSString stringWithFormat: @"%s", currentDevice->value->device] retain];
1658 if(currentDevice->value->removable) {
1659 menuItem = [[NSMenuItem alloc] initWithTitle: [NSString stringWithFormat: @"Change %s...", currentDevice->value->device]
1660 action: @selector(changeDeviceMedia:)
1661 keyEquivalent: @""];
1662 [menu addItem: menuItem];
1663 [menuItem setRepresentedObject: deviceName];
1664 [menuItem autorelease];
1666 menuItem = [[NSMenuItem alloc] initWithTitle: [NSString stringWithFormat: @"Eject %s", currentDevice->value->device]
1667 action: @selector(ejectDeviceMedia:)
1668 keyEquivalent: @""];
1669 [menu addItem: menuItem];
1670 [menuItem setRepresentedObject: deviceName];
1671 [menuItem autorelease];
1673 currentDevice = currentDevice->next;
1675 qapi_free_BlockInfoList(pointerToFree);
1679 * The startup process for the OSX/Cocoa UI is complicated, because
1680 * OSX insists that the UI runs on the initial main thread, and so we
1681 * need to start a second thread which runs the vl.c qemu_main():
1683 * Initial thread: 2nd thread:
1685 * create qemu-main thread
1686 * wait on display_init semaphore
1689 * in cocoa_display_init():
1690 * post the display_init semaphore
1691 * wait on app_started semaphore
1692 * create application, menus, etc
1693 * enter OSX run loop
1694 * in applicationDidFinishLaunching:
1695 * post app_started semaphore
1696 * tell main thread to fullscreen if needed
1698 * run qemu main-loop
1700 * We do this in two stages so that we don't do the creation of the
1701 * GUI application menus and so on for command line options like --help
1702 * where we want to just print text to stdout and exit immediately.
1705 static void *call_qemu_main(void *opaque)
1709 COCOA_DEBUG("Second thread: calling qemu_main()\n");
1710 status = qemu_main(gArgc, gArgv, *_NSGetEnviron());
1711 COCOA_DEBUG("Second thread: qemu_main() returned, exiting\n");
1715 int main (int argc, const char * argv[]) {
1718 COCOA_DEBUG("Entered main()\n");
1720 gArgv = (char **)argv;
1722 qemu_sem_init(&display_init_sem, 0);
1723 qemu_sem_init(&app_started_sem, 0);
1725 qemu_thread_create(&thread, "qemu_main", call_qemu_main,
1726 NULL, QEMU_THREAD_DETACHED);
1728 COCOA_DEBUG("Main thread: waiting for display_init_sem\n");
1729 qemu_sem_wait(&display_init_sem);
1730 COCOA_DEBUG("Main thread: initializing app\n");
1732 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1734 // Pull this console process up to being a fully-fledged graphical
1735 // app with a menubar and Dock icon
1736 ProcessSerialNumber psn = { 0, kCurrentProcess };
1737 TransformProcessType(&psn, kProcessTransformToForegroundApplication);
1739 [QemuApplication sharedApplication];
1741 create_initial_menus();
1744 * Create the menu entries which depend on QEMU state (for consoles
1745 * and removeable devices). These make calls back into QEMU functions,
1746 * which is OK because at this point we know that the second thread
1747 * holds the iothread lock and is synchronously waiting for us to
1750 add_console_menu_entries();
1751 addRemovableDevicesMenuItems();
1753 // Create an Application controller
1754 QemuCocoaAppController *appController = [[QemuCocoaAppController alloc] init];
1755 [NSApp setDelegate:appController];
1757 // Start the main event loop
1758 COCOA_DEBUG("Main thread: entering OSX run loop\n");
1760 COCOA_DEBUG("Main thread: left OSX run loop, exiting\n");
1762 [appController release];
1771 static void cocoa_update(DisplayChangeListener *dcl,
1772 int x, int y, int w, int h)
1774 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1776 COCOA_DEBUG("qemu_cocoa: cocoa_update\n");
1778 dispatch_async(dispatch_get_main_queue(), ^{
1780 if ([cocoaView cdx] == 1.0) {
1781 rect = NSMakeRect(x, [cocoaView gscreen].height - y - h, w, h);
1784 x * [cocoaView cdx],
1785 ([cocoaView gscreen].height - y - h) * [cocoaView cdy],
1786 w * [cocoaView cdx],
1787 h * [cocoaView cdy]);
1789 [cocoaView setNeedsDisplayInRect:rect];
1795 static void cocoa_switch(DisplayChangeListener *dcl,
1796 DisplaySurface *surface)
1798 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1799 pixman_image_t *image = surface->image;
1801 COCOA_DEBUG("qemu_cocoa: cocoa_switch\n");
1803 // The DisplaySurface will be freed as soon as this callback returns.
1804 // We take a reference to the underlying pixman image here so it does
1805 // not disappear from under our feet; the switchSurface method will
1806 // deref the old image when it is done with it.
1807 pixman_image_ref(image);
1809 dispatch_async(dispatch_get_main_queue(), ^{
1810 [cocoaView switchSurface:image];
1815 static void cocoa_refresh(DisplayChangeListener *dcl)
1817 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1819 COCOA_DEBUG("qemu_cocoa: cocoa_refresh\n");
1820 graphic_hw_update(NULL);
1822 if (qemu_input_is_absolute()) {
1823 dispatch_async(dispatch_get_main_queue(), ^{
1824 if (![cocoaView isAbsoluteEnabled]) {
1825 if ([cocoaView isMouseGrabbed]) {
1826 [cocoaView ungrabMouse];
1829 [cocoaView setAbsoluteEnabled:YES];
1835 static void cocoa_display_init(DisplayState *ds, DisplayOptions *opts)
1837 COCOA_DEBUG("qemu_cocoa: cocoa_display_init\n");
1839 /* Tell main thread to go ahead and create the app and enter the run loop */
1840 qemu_sem_post(&display_init_sem);
1841 qemu_sem_wait(&app_started_sem);
1842 COCOA_DEBUG("cocoa_display_init: app start completed\n");
1844 /* if fullscreen mode is to be used */
1845 if (opts->has_full_screen && opts->full_screen) {
1846 dispatch_async(dispatch_get_main_queue(), ^{
1847 [NSApp activateIgnoringOtherApps: YES];
1848 [(QemuCocoaAppController *)[[NSApplication sharedApplication] delegate] toggleFullScreen: nil];
1851 if (opts->has_show_cursor && opts->show_cursor) {
1855 // register vga output callbacks
1856 register_displaychangelistener(&dcl);
1859 static QemuDisplay qemu_display_cocoa = {
1860 .type = DISPLAY_TYPE_COCOA,
1861 .init = cocoa_display_init,
1864 static void register_cocoa(void)
1866 qemu_display_register(&qemu_display_cocoa);
1869 type_init(register_cocoa);