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))
75 static void cocoa_update(DisplayChangeListener *dcl,
76 int x, int y, int w, int h);
78 static void cocoa_switch(DisplayChangeListener *dcl,
79 DisplaySurface *surface);
81 static void cocoa_refresh(DisplayChangeListener *dcl);
83 NSWindow *normalWindow, *about_window;
84 static const DisplayChangeListenerOps dcl_ops = {
86 .dpy_gfx_update = cocoa_update,
87 .dpy_gfx_switch = cocoa_switch,
88 .dpy_refresh = cocoa_refresh,
90 static DisplayChangeListener dcl = {
93 static int last_buttons;
94 static int cursor_hide = 1;
99 NSTextField *pauseLabel;
100 NSArray * supportedImageFileTypes;
102 static QemuSemaphore display_init_sem;
103 static QemuSemaphore app_started_sem;
104 static bool allow_events;
106 // Utility functions to run specified code block with iothread lock held
107 typedef void (^CodeBlock)(void);
108 typedef bool (^BoolCodeBlock)(void);
110 static void with_iothread_lock(CodeBlock block)
112 bool locked = qemu_mutex_iothread_locked();
114 qemu_mutex_lock_iothread();
118 qemu_mutex_unlock_iothread();
122 static bool bool_with_iothread_lock(BoolCodeBlock block)
124 bool locked = qemu_mutex_iothread_locked();
128 qemu_mutex_lock_iothread();
132 qemu_mutex_unlock_iothread();
137 // Mac to QKeyCode conversion
138 const int mac_to_qkeycode_map[] = {
139 [kVK_ANSI_A] = Q_KEY_CODE_A,
140 [kVK_ANSI_B] = Q_KEY_CODE_B,
141 [kVK_ANSI_C] = Q_KEY_CODE_C,
142 [kVK_ANSI_D] = Q_KEY_CODE_D,
143 [kVK_ANSI_E] = Q_KEY_CODE_E,
144 [kVK_ANSI_F] = Q_KEY_CODE_F,
145 [kVK_ANSI_G] = Q_KEY_CODE_G,
146 [kVK_ANSI_H] = Q_KEY_CODE_H,
147 [kVK_ANSI_I] = Q_KEY_CODE_I,
148 [kVK_ANSI_J] = Q_KEY_CODE_J,
149 [kVK_ANSI_K] = Q_KEY_CODE_K,
150 [kVK_ANSI_L] = Q_KEY_CODE_L,
151 [kVK_ANSI_M] = Q_KEY_CODE_M,
152 [kVK_ANSI_N] = Q_KEY_CODE_N,
153 [kVK_ANSI_O] = Q_KEY_CODE_O,
154 [kVK_ANSI_P] = Q_KEY_CODE_P,
155 [kVK_ANSI_Q] = Q_KEY_CODE_Q,
156 [kVK_ANSI_R] = Q_KEY_CODE_R,
157 [kVK_ANSI_S] = Q_KEY_CODE_S,
158 [kVK_ANSI_T] = Q_KEY_CODE_T,
159 [kVK_ANSI_U] = Q_KEY_CODE_U,
160 [kVK_ANSI_V] = Q_KEY_CODE_V,
161 [kVK_ANSI_W] = Q_KEY_CODE_W,
162 [kVK_ANSI_X] = Q_KEY_CODE_X,
163 [kVK_ANSI_Y] = Q_KEY_CODE_Y,
164 [kVK_ANSI_Z] = Q_KEY_CODE_Z,
166 [kVK_ANSI_0] = Q_KEY_CODE_0,
167 [kVK_ANSI_1] = Q_KEY_CODE_1,
168 [kVK_ANSI_2] = Q_KEY_CODE_2,
169 [kVK_ANSI_3] = Q_KEY_CODE_3,
170 [kVK_ANSI_4] = Q_KEY_CODE_4,
171 [kVK_ANSI_5] = Q_KEY_CODE_5,
172 [kVK_ANSI_6] = Q_KEY_CODE_6,
173 [kVK_ANSI_7] = Q_KEY_CODE_7,
174 [kVK_ANSI_8] = Q_KEY_CODE_8,
175 [kVK_ANSI_9] = Q_KEY_CODE_9,
177 [kVK_ANSI_Grave] = Q_KEY_CODE_GRAVE_ACCENT,
178 [kVK_ANSI_Minus] = Q_KEY_CODE_MINUS,
179 [kVK_ANSI_Equal] = Q_KEY_CODE_EQUAL,
180 [kVK_Delete] = Q_KEY_CODE_BACKSPACE,
181 [kVK_CapsLock] = Q_KEY_CODE_CAPS_LOCK,
182 [kVK_Tab] = Q_KEY_CODE_TAB,
183 [kVK_Return] = Q_KEY_CODE_RET,
184 [kVK_ANSI_LeftBracket] = Q_KEY_CODE_BRACKET_LEFT,
185 [kVK_ANSI_RightBracket] = Q_KEY_CODE_BRACKET_RIGHT,
186 [kVK_ANSI_Backslash] = Q_KEY_CODE_BACKSLASH,
187 [kVK_ANSI_Semicolon] = Q_KEY_CODE_SEMICOLON,
188 [kVK_ANSI_Quote] = Q_KEY_CODE_APOSTROPHE,
189 [kVK_ANSI_Comma] = Q_KEY_CODE_COMMA,
190 [kVK_ANSI_Period] = Q_KEY_CODE_DOT,
191 [kVK_ANSI_Slash] = Q_KEY_CODE_SLASH,
192 [kVK_Shift] = Q_KEY_CODE_SHIFT,
193 [kVK_RightShift] = Q_KEY_CODE_SHIFT_R,
194 [kVK_Control] = Q_KEY_CODE_CTRL,
195 [kVK_RightControl] = Q_KEY_CODE_CTRL_R,
196 [kVK_Option] = Q_KEY_CODE_ALT,
197 [kVK_RightOption] = Q_KEY_CODE_ALT_R,
198 [kVK_Command] = Q_KEY_CODE_META_L,
199 [0x36] = Q_KEY_CODE_META_R, /* There is no kVK_RightCommand */
200 [kVK_Space] = Q_KEY_CODE_SPC,
202 [kVK_ANSI_Keypad0] = Q_KEY_CODE_KP_0,
203 [kVK_ANSI_Keypad1] = Q_KEY_CODE_KP_1,
204 [kVK_ANSI_Keypad2] = Q_KEY_CODE_KP_2,
205 [kVK_ANSI_Keypad3] = Q_KEY_CODE_KP_3,
206 [kVK_ANSI_Keypad4] = Q_KEY_CODE_KP_4,
207 [kVK_ANSI_Keypad5] = Q_KEY_CODE_KP_5,
208 [kVK_ANSI_Keypad6] = Q_KEY_CODE_KP_6,
209 [kVK_ANSI_Keypad7] = Q_KEY_CODE_KP_7,
210 [kVK_ANSI_Keypad8] = Q_KEY_CODE_KP_8,
211 [kVK_ANSI_Keypad9] = Q_KEY_CODE_KP_9,
212 [kVK_ANSI_KeypadDecimal] = Q_KEY_CODE_KP_DECIMAL,
213 [kVK_ANSI_KeypadEnter] = Q_KEY_CODE_KP_ENTER,
214 [kVK_ANSI_KeypadPlus] = Q_KEY_CODE_KP_ADD,
215 [kVK_ANSI_KeypadMinus] = Q_KEY_CODE_KP_SUBTRACT,
216 [kVK_ANSI_KeypadMultiply] = Q_KEY_CODE_KP_MULTIPLY,
217 [kVK_ANSI_KeypadDivide] = Q_KEY_CODE_KP_DIVIDE,
218 [kVK_ANSI_KeypadEquals] = Q_KEY_CODE_KP_EQUALS,
219 [kVK_ANSI_KeypadClear] = Q_KEY_CODE_NUM_LOCK,
221 [kVK_UpArrow] = Q_KEY_CODE_UP,
222 [kVK_DownArrow] = Q_KEY_CODE_DOWN,
223 [kVK_LeftArrow] = Q_KEY_CODE_LEFT,
224 [kVK_RightArrow] = Q_KEY_CODE_RIGHT,
226 [kVK_Help] = Q_KEY_CODE_INSERT,
227 [kVK_Home] = Q_KEY_CODE_HOME,
228 [kVK_PageUp] = Q_KEY_CODE_PGUP,
229 [kVK_PageDown] = Q_KEY_CODE_PGDN,
230 [kVK_End] = Q_KEY_CODE_END,
231 [kVK_ForwardDelete] = Q_KEY_CODE_DELETE,
233 [kVK_Escape] = Q_KEY_CODE_ESC,
235 /* The Power key can't be used directly because the operating system uses
236 * it. This key can be emulated by using it in place of another key such as
237 * F1. Don't forget to disable the real key binding.
239 /* [kVK_F1] = Q_KEY_CODE_POWER, */
241 [kVK_F1] = Q_KEY_CODE_F1,
242 [kVK_F2] = Q_KEY_CODE_F2,
243 [kVK_F3] = Q_KEY_CODE_F3,
244 [kVK_F4] = Q_KEY_CODE_F4,
245 [kVK_F5] = Q_KEY_CODE_F5,
246 [kVK_F6] = Q_KEY_CODE_F6,
247 [kVK_F7] = Q_KEY_CODE_F7,
248 [kVK_F8] = Q_KEY_CODE_F8,
249 [kVK_F9] = Q_KEY_CODE_F9,
250 [kVK_F10] = Q_KEY_CODE_F10,
251 [kVK_F11] = Q_KEY_CODE_F11,
252 [kVK_F12] = Q_KEY_CODE_F12,
253 [kVK_F13] = Q_KEY_CODE_PRINT,
254 [kVK_F14] = Q_KEY_CODE_SCROLL_LOCK,
255 [kVK_F15] = Q_KEY_CODE_PAUSE,
257 // JIS keyboards only
258 [kVK_JIS_Yen] = Q_KEY_CODE_YEN,
259 [kVK_JIS_Underscore] = Q_KEY_CODE_RO,
260 [kVK_JIS_KeypadComma] = Q_KEY_CODE_KP_COMMA,
261 [kVK_JIS_Eisu] = Q_KEY_CODE_MUHENKAN,
262 [kVK_JIS_Kana] = Q_KEY_CODE_HENKAN,
265 * The eject and volume keys can't be used here because they are handled at
266 * a lower level than what an Application can see.
270 static int cocoa_keycode_to_qemu(int keycode)
272 if (ARRAY_SIZE(mac_to_qkeycode_map) <= keycode) {
273 error_report("(cocoa) warning unknown keycode 0x%x", keycode);
276 return mac_to_qkeycode_map[keycode];
279 /* Displays an alert dialog box with the specified message */
280 static void QEMU_Alert(NSString *message)
283 alert = [NSAlert new];
284 [alert setMessageText: message];
288 /* Handles any errors that happen with a device transaction */
289 static void handleAnyDeviceErrors(Error * err)
292 QEMU_Alert([NSString stringWithCString: error_get_pretty(err)
293 encoding: NSASCIIStringEncoding]);
299 ------------------------------------------------------
301 ------------------------------------------------------
303 @interface QemuCocoaView : NSView
306 NSWindow *fullScreenWindow;
307 float cx,cy,cw,ch,cdx,cdy;
308 pixman_image_t *pixman_image;
309 BOOL modifiers_state[256];
312 BOOL isAbsoluteEnabled;
313 BOOL isMouseDeassociated;
315 - (void) switchSurface:(pixman_image_t *)image;
317 - (void) ungrabMouse;
318 - (void) toggleFullScreen:(id)sender;
319 - (void) handleMonitorInput:(NSEvent *)event;
320 - (bool) handleEvent:(NSEvent *)event;
321 - (bool) handleEventLocked:(NSEvent *)event;
322 - (void) setAbsoluteEnabled:(BOOL)tIsAbsoluteEnabled;
323 /* The state surrounding mouse grabbing is potentially confusing.
324 * isAbsoluteEnabled tracks qemu_input_is_absolute() [ie "is the emulated
325 * pointing device an absolute-position one?"], but is only updated on
327 * isMouseGrabbed tracks whether GUI events are directed to the guest;
328 * it controls whether special keys like Cmd get sent to the guest,
329 * and whether we capture the mouse when in non-absolute mode.
330 * isMouseDeassociated tracks whether we've told MacOSX to disassociate
331 * the mouse and mouse cursor position by calling
332 * CGAssociateMouseAndMouseCursorPosition(FALSE)
333 * (which basically happens if we grab in non-absolute mode).
335 - (BOOL) isMouseGrabbed;
336 - (BOOL) isAbsoluteEnabled;
337 - (BOOL) isMouseDeassociated;
340 - (QEMUScreen) gscreen;
341 - (void) raiseAllKeys;
344 QemuCocoaView *cocoaView;
346 @implementation QemuCocoaView
347 - (id)initWithFrame:(NSRect)frameRect
349 COCOA_DEBUG("QemuCocoaView: initWithFrame\n");
351 self = [super initWithFrame:frameRect];
354 screen.width = frameRect.size.width;
355 screen.height = frameRect.size.height;
363 COCOA_DEBUG("QemuCocoaView: dealloc\n");
366 pixman_image_unref(pixman_image);
377 - (BOOL) screenContainsPoint:(NSPoint) p
379 return (p.x > -1 && p.x < screen.width && p.y > -1 && p.y < screen.height);
382 /* Get location of event and convert to virtual screen coordinate */
383 - (CGPoint) screenLocationOfEvent:(NSEvent *)ev
385 NSWindow *eventWindow = [ev window];
386 // XXX: Use CGRect and -convertRectFromScreen: to support macOS 10.10
387 CGRect r = CGRectZero;
388 r.origin = [ev locationInWindow];
391 return [[self window] convertRectFromScreen:r].origin;
393 CGPoint locationInSelfWindow = [[self window] convertRectFromScreen:r].origin;
394 CGPoint loc = [self convertPoint:locationInSelfWindow fromView:nil];
401 } else if ([[self window] isEqual:eventWindow]) {
405 CGPoint loc = [self convertPoint:r.origin fromView:nil];
413 return [[self window] convertRectFromScreen:[eventWindow convertRectToScreen:r]].origin;
425 - (void) unhideCursor
433 - (void) drawRect:(NSRect) rect
435 COCOA_DEBUG("QemuCocoaView: drawRect\n");
437 // get CoreGraphic context
438 CGContextRef viewContextRef = [[NSGraphicsContext currentContext] CGContext];
440 CGContextSetInterpolationQuality (viewContextRef, kCGInterpolationNone);
441 CGContextSetShouldAntialias (viewContextRef, NO);
443 // draw screen bitmap directly to Core Graphics context
445 // Draw request before any guest device has set up a framebuffer:
446 // just draw an opaque black rectangle
447 CGContextSetRGBFillColor(viewContextRef, 0, 0, 0, 1.0);
448 CGContextFillRect(viewContextRef, NSRectToCGRect(rect));
450 int w = pixman_image_get_width(pixman_image);
451 int h = pixman_image_get_height(pixman_image);
452 int bitsPerPixel = PIXMAN_FORMAT_BPP(pixman_image_get_format(pixman_image));
453 int stride = pixman_image_get_stride(pixman_image);
454 CGDataProviderRef dataProviderRef = CGDataProviderCreateWithData(
456 pixman_image_get_data(pixman_image),
460 CGImageRef imageRef = CGImageCreate(
463 DIV_ROUND_UP(bitsPerPixel, 8) * 2, //bitsPerComponent
464 bitsPerPixel, //bitsPerPixel
465 stride, //bytesPerRow
466 #ifdef __LITTLE_ENDIAN__
467 CGColorSpaceCreateWithName(kCGColorSpaceGenericRGB), //colorspace for OS X >= 10.4
468 kCGBitmapByteOrder32Little | kCGImageAlphaNoneSkipFirst,
470 CGColorSpaceCreateDeviceRGB(), //colorspace for OS X < 10.4 (actually ppc)
471 kCGImageAlphaNoneSkipFirst, //bitmapInfo
473 dataProviderRef, //provider
476 kCGRenderingIntentDefault //intent
478 // selective drawing code (draws only dirty rectangles) (OS X >= 10.4)
479 const NSRect *rectList;
482 CGImageRef clipImageRef;
485 [self getRectsBeingDrawn:&rectList count:&rectCount];
486 for (i = 0; i < rectCount; i++) {
487 clipRect.origin.x = rectList[i].origin.x / cdx;
488 clipRect.origin.y = (float)h - (rectList[i].origin.y + rectList[i].size.height) / cdy;
489 clipRect.size.width = rectList[i].size.width / cdx;
490 clipRect.size.height = rectList[i].size.height / cdy;
491 clipImageRef = CGImageCreateWithImageInRect(
495 CGContextDrawImage (viewContextRef, cgrect(rectList[i]), clipImageRef);
496 CGImageRelease (clipImageRef);
498 CGImageRelease (imageRef);
499 CGDataProviderRelease(dataProviderRef);
503 - (void) setContentDimensions
505 COCOA_DEBUG("QemuCocoaView: setContentDimensions\n");
508 cdx = [[NSScreen mainScreen] frame].size.width / (float)screen.width;
509 cdy = [[NSScreen mainScreen] frame].size.height / (float)screen.height;
511 /* stretches video, but keeps same aspect ratio */
512 if (stretch_video == true) {
513 /* use smallest stretch value - prevents clipping on sides */
514 if (MIN(cdx, cdy) == cdx) {
519 } else { /* No stretching */
522 cw = screen.width * cdx;
523 ch = screen.height * cdy;
524 cx = ([[NSScreen mainScreen] frame].size.width - cw) / 2.0;
525 cy = ([[NSScreen mainScreen] frame].size.height - ch) / 2.0;
536 - (void) switchSurface:(pixman_image_t *)image
538 COCOA_DEBUG("QemuCocoaView: switchSurface\n");
540 int w = pixman_image_get_width(image);
541 int h = pixman_image_get_height(image);
542 /* cdx == 0 means this is our very first surface, in which case we need
543 * to recalculate the content dimensions even if it happens to be the size
544 * of the initial empty window.
546 bool isResize = (w != screen.width || h != screen.height || cdx == 0.0);
548 int oldh = screen.height;
550 // Resize before we trigger the redraw, or we'll redraw at the wrong size
551 COCOA_DEBUG("switchSurface: new size %d x %d\n", w, h);
554 [self setContentDimensions];
555 [self setFrame:NSMakeRect(cx, cy, cw, ch)];
558 // update screenBuffer
560 pixman_image_unref(pixman_image);
563 pixman_image = image;
567 [[fullScreenWindow contentView] setFrame:[[NSScreen mainScreen] frame]];
568 [normalWindow setFrame:NSMakeRect([normalWindow frame].origin.x, [normalWindow frame].origin.y - h + oldh, w, h + [normalWindow frame].size.height - oldh) display:NO animate:NO];
571 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s", qemu_name]];
572 [normalWindow setFrame:NSMakeRect([normalWindow frame].origin.x, [normalWindow frame].origin.y - h + oldh, w, h + [normalWindow frame].size.height - oldh) display:YES animate:NO];
576 [normalWindow center];
580 - (void) toggleFullScreen:(id)sender
582 COCOA_DEBUG("QemuCocoaView: toggleFullScreen\n");
584 if (isFullscreen) { // switch from fullscreen to desktop
585 isFullscreen = FALSE;
587 [self setContentDimensions];
588 [fullScreenWindow close];
589 [normalWindow setContentView: self];
590 [normalWindow makeKeyAndOrderFront: self];
591 [NSMenu setMenuBarVisible:YES];
592 } else { // switch from desktop to fullscreen
594 [normalWindow orderOut: nil]; /* Hide the window */
596 [self setContentDimensions];
597 [NSMenu setMenuBarVisible:NO];
598 fullScreenWindow = [[NSWindow alloc] initWithContentRect:[[NSScreen mainScreen] frame]
599 styleMask:NSWindowStyleMaskBorderless
600 backing:NSBackingStoreBuffered
602 [fullScreenWindow setAcceptsMouseMovedEvents: YES];
603 [fullScreenWindow setHasShadow:NO];
604 [fullScreenWindow setBackgroundColor: [NSColor blackColor]];
605 [self setFrame:NSMakeRect(cx, cy, cw, ch)];
606 [[fullScreenWindow contentView] addSubview: self];
607 [fullScreenWindow makeKeyAndOrderFront:self];
611 - (void) toggleModifier: (int)keycode {
612 // Toggle the stored state.
613 modifiers_state[keycode] = !modifiers_state[keycode];
614 // Send a keyup or keydown depending on the state.
615 qemu_input_event_send_key_qcode(dcl.con, keycode, modifiers_state[keycode]);
618 - (void) toggleStatefulModifier: (int)keycode {
619 // Toggle the stored state.
620 modifiers_state[keycode] = !modifiers_state[keycode];
621 // Generate keydown and keyup.
622 qemu_input_event_send_key_qcode(dcl.con, keycode, true);
623 qemu_input_event_send_key_qcode(dcl.con, keycode, false);
626 // Does the work of sending input to the monitor
627 - (void) handleMonitorInput:(NSEvent *)event
632 // if the control key is down
633 if ([event modifierFlags] & NSEventModifierFlagControl) {
637 /* translates Macintosh keycodes to QEMU's keysym */
639 int without_control_translation[] = {
640 [0 ... 0xff] = 0, // invalid key
642 [kVK_UpArrow] = QEMU_KEY_UP,
643 [kVK_DownArrow] = QEMU_KEY_DOWN,
644 [kVK_RightArrow] = QEMU_KEY_RIGHT,
645 [kVK_LeftArrow] = QEMU_KEY_LEFT,
646 [kVK_Home] = QEMU_KEY_HOME,
647 [kVK_End] = QEMU_KEY_END,
648 [kVK_PageUp] = QEMU_KEY_PAGEUP,
649 [kVK_PageDown] = QEMU_KEY_PAGEDOWN,
650 [kVK_ForwardDelete] = QEMU_KEY_DELETE,
651 [kVK_Delete] = QEMU_KEY_BACKSPACE,
654 int with_control_translation[] = {
655 [0 ... 0xff] = 0, // invalid key
657 [kVK_UpArrow] = QEMU_KEY_CTRL_UP,
658 [kVK_DownArrow] = QEMU_KEY_CTRL_DOWN,
659 [kVK_RightArrow] = QEMU_KEY_CTRL_RIGHT,
660 [kVK_LeftArrow] = QEMU_KEY_CTRL_LEFT,
661 [kVK_Home] = QEMU_KEY_CTRL_HOME,
662 [kVK_End] = QEMU_KEY_CTRL_END,
663 [kVK_PageUp] = QEMU_KEY_CTRL_PAGEUP,
664 [kVK_PageDown] = QEMU_KEY_CTRL_PAGEDOWN,
667 if (control_key != 0) { /* If the control key is being used */
668 if ([event keyCode] < ARRAY_SIZE(with_control_translation)) {
669 keysym = with_control_translation[[event keyCode]];
672 if ([event keyCode] < ARRAY_SIZE(without_control_translation)) {
673 keysym = without_control_translation[[event keyCode]];
677 // if not a key that needs translating
679 NSString *ks = [event characters];
680 if ([ks length] > 0) {
681 keysym = [ks characterAtIndex:0];
686 kbd_put_keysym(keysym);
690 - (bool) handleEvent:(NSEvent *)event
694 * Just let OSX have all events that arrive before
695 * applicationDidFinishLaunching.
696 * This avoids a deadlock on the iothread lock, which cocoa_display_init()
697 * will not drop until after the app_started_sem is posted. (In theory
698 * there should not be any such events, but OSX Catalina now emits some.)
702 return bool_with_iothread_lock(^{
703 return [self handleEventLocked:event];
707 - (bool) handleEventLocked:(NSEvent *)event
709 /* Return true if we handled the event, false if it should be given to OSX */
710 COCOA_DEBUG("QemuCocoaView: handleEvent\n");
713 bool mouse_event = false;
714 static bool switched_to_fullscreen = false;
715 // Location of event in virtual screen coordinates
716 NSPoint p = [self screenLocationOfEvent:event];
718 switch ([event type]) {
719 case NSEventTypeFlagsChanged:
720 if ([event keyCode] == 0) {
721 // When the Cocoa keyCode is zero that means keys should be
722 // synthesized based on the values in in the eventModifiers
725 if (qemu_console_is_graphic(NULL)) {
726 NSUInteger modifiers = [event modifierFlags];
728 if (!!(modifiers & NSEventModifierFlagCapsLock) != !!modifiers_state[Q_KEY_CODE_CAPS_LOCK]) {
729 [self toggleStatefulModifier:Q_KEY_CODE_CAPS_LOCK];
731 if (!!(modifiers & NSEventModifierFlagShift) != !!modifiers_state[Q_KEY_CODE_SHIFT]) {
732 [self toggleModifier:Q_KEY_CODE_SHIFT];
734 if (!!(modifiers & NSEventModifierFlagControl) != !!modifiers_state[Q_KEY_CODE_CTRL]) {
735 [self toggleModifier:Q_KEY_CODE_CTRL];
737 if (!!(modifiers & NSEventModifierFlagOption) != !!modifiers_state[Q_KEY_CODE_ALT]) {
738 [self toggleModifier:Q_KEY_CODE_ALT];
740 if (!!(modifiers & NSEventModifierFlagCommand) != !!modifiers_state[Q_KEY_CODE_META_L]) {
741 [self toggleModifier:Q_KEY_CODE_META_L];
745 keycode = cocoa_keycode_to_qemu([event keyCode]);
748 if ((keycode == Q_KEY_CODE_META_L || keycode == Q_KEY_CODE_META_R)
749 && !isMouseGrabbed) {
750 /* Don't pass command key changes to guest unless mouse is grabbed */
755 // emulate caps lock and num lock keydown and keyup
756 if (keycode == Q_KEY_CODE_CAPS_LOCK ||
757 keycode == Q_KEY_CODE_NUM_LOCK) {
758 [self toggleStatefulModifier:keycode];
759 } else if (qemu_console_is_graphic(NULL)) {
760 if (switched_to_fullscreen) {
761 switched_to_fullscreen = false;
763 [self toggleModifier:keycode];
769 case NSEventTypeKeyDown:
770 keycode = cocoa_keycode_to_qemu([event keyCode]);
772 // forward command key combos to the host UI unless the mouse is grabbed
773 if (!isMouseGrabbed && ([event modifierFlags] & NSEventModifierFlagCommand)) {
775 * Prevent the command key from being stuck down in the guest
776 * when using Command-F to switch to full screen mode.
778 if (keycode == Q_KEY_CODE_F) {
779 switched_to_fullscreen = true;
786 // handle control + alt Key Combos (ctrl+alt+[1..9,g] is reserved for QEMU)
787 if (([event modifierFlags] & NSEventModifierFlagControl) && ([event modifierFlags] & NSEventModifierFlagOption)) {
788 NSString *keychar = [event charactersIgnoringModifiers];
789 if ([keychar length] == 1) {
790 char key = [keychar characterAtIndex:0];
793 // enable graphic console
795 console_select(key - '0' - 1); /* ascii math */
798 // release the mouse grab
806 if (qemu_console_is_graphic(NULL)) {
807 qemu_input_event_send_key_qcode(dcl.con, keycode, true);
809 [self handleMonitorInput: event];
812 case NSEventTypeKeyUp:
813 keycode = cocoa_keycode_to_qemu([event keyCode]);
815 // don't pass the guest a spurious key-up if we treated this
816 // command-key combo as a host UI action
817 if (!isMouseGrabbed && ([event modifierFlags] & NSEventModifierFlagCommand)) {
821 if (qemu_console_is_graphic(NULL)) {
822 qemu_input_event_send_key_qcode(dcl.con, keycode, false);
825 case NSEventTypeMouseMoved:
826 if (isAbsoluteEnabled) {
827 // Cursor re-entered into a window might generate events bound to screen coordinates
828 // and `nil` window property, and in full screen mode, current window might not be
829 // key window, where event location alone should suffice.
830 if (![self screenContainsPoint:p] || !([[self window] isKeyWindow] || isFullscreen)) {
831 if (isMouseGrabbed) {
835 if (!isMouseGrabbed) {
842 case NSEventTypeLeftMouseDown:
843 buttons |= MOUSE_EVENT_LBUTTON;
846 case NSEventTypeRightMouseDown:
847 buttons |= MOUSE_EVENT_RBUTTON;
850 case NSEventTypeOtherMouseDown:
851 buttons |= MOUSE_EVENT_MBUTTON;
854 case NSEventTypeLeftMouseDragged:
855 buttons |= MOUSE_EVENT_LBUTTON;
858 case NSEventTypeRightMouseDragged:
859 buttons |= MOUSE_EVENT_RBUTTON;
862 case NSEventTypeOtherMouseDragged:
863 buttons |= MOUSE_EVENT_MBUTTON;
866 case NSEventTypeLeftMouseUp:
868 if (!isMouseGrabbed && [self screenContainsPoint:p]) {
870 * In fullscreen mode, the window of cocoaView may not be the
871 * key window, therefore the position relative to the virtual
872 * screen alone will be sufficient.
874 if(isFullscreen || [[self window] isKeyWindow]) {
879 case NSEventTypeRightMouseUp:
882 case NSEventTypeOtherMouseUp:
885 case NSEventTypeScrollWheel:
887 * Send wheel events to the guest regardless of window focus.
888 * This is in-line with standard Mac OS X UI behaviour.
892 * When deltaY is zero, it means that this scrolling event was
893 * either horizontal, or so fine that it only appears in
894 * scrollingDeltaY. So we drop the event.
896 if ([event deltaY] != 0) {
897 /* Determine if this is a scroll up or scroll down event */
898 buttons = ([event deltaY] > 0) ?
899 INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
900 qemu_input_queue_btn(dcl.con, buttons, true);
901 qemu_input_event_sync();
902 qemu_input_queue_btn(dcl.con, buttons, false);
903 qemu_input_event_sync();
906 * Since deltaY also reports scroll wheel events we prevent mouse
907 * movement code from executing.
916 /* Don't send button events to the guest unless we've got a
917 * mouse grab or window focus. If we have neither then this event
918 * is the user clicking on the background window to activate and
919 * bring us to the front, which will be done by the sendEvent
920 * call below. We definitely don't want to pass that click through
923 if ((isMouseGrabbed || [[self window] isKeyWindow]) &&
924 (last_buttons != buttons)) {
925 static uint32_t bmap[INPUT_BUTTON__MAX] = {
926 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
927 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
928 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON
930 qemu_input_update_buttons(dcl.con, bmap, last_buttons, buttons);
931 last_buttons = buttons;
933 if (isMouseGrabbed) {
934 if (isAbsoluteEnabled) {
935 /* Note that the origin for Cocoa mouse coords is bottom left, not top left.
936 * The check on screenContainsPoint is to avoid sending out of range values for
937 * clicks in the titlebar.
939 if ([self screenContainsPoint:p]) {
940 qemu_input_queue_abs(dcl.con, INPUT_AXIS_X, p.x, 0, screen.width);
941 qemu_input_queue_abs(dcl.con, INPUT_AXIS_Y, screen.height - p.y, 0, screen.height);
944 qemu_input_queue_rel(dcl.con, INPUT_AXIS_X, (int)[event deltaX]);
945 qemu_input_queue_rel(dcl.con, INPUT_AXIS_Y, (int)[event deltaY]);
950 qemu_input_event_sync();
957 COCOA_DEBUG("QemuCocoaView: grabMouse\n");
961 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s - (Press ctrl + alt + g to release Mouse)", qemu_name]];
963 [normalWindow setTitle:@"QEMU - (Press ctrl + alt + g to release Mouse)"];
966 if (!isAbsoluteEnabled) {
967 isMouseDeassociated = TRUE;
968 CGAssociateMouseAndMouseCursorPosition(FALSE);
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 if (isMouseDeassociated) {
985 CGAssociateMouseAndMouseCursorPosition(TRUE);
986 isMouseDeassociated = FALSE;
988 isMouseGrabbed = FALSE;
991 - (void) setAbsoluteEnabled:(BOOL)tIsAbsoluteEnabled {isAbsoluteEnabled = tIsAbsoluteEnabled;}
992 - (BOOL) isMouseGrabbed {return isMouseGrabbed;}
993 - (BOOL) isAbsoluteEnabled {return isAbsoluteEnabled;}
994 - (BOOL) isMouseDeassociated {return isMouseDeassociated;}
995 - (float) cdx {return cdx;}
996 - (float) cdy {return cdy;}
997 - (QEMUScreen) gscreen {return screen;}
1000 * Makes the target think all down keys are being released.
1001 * This prevents a stuck key problem, since we will not see
1002 * key up events for those keys after we have lost focus.
1004 - (void) raiseAllKeys
1006 const int max_index = ARRAY_SIZE(modifiers_state);
1008 with_iothread_lock(^{
1011 for (index = 0; index < max_index; index++) {
1012 if (modifiers_state[index]) {
1013 modifiers_state[index] = 0;
1014 qemu_input_event_send_key_qcode(dcl.con, index, false);
1024 ------------------------------------------------------
1025 QemuCocoaAppController
1026 ------------------------------------------------------
1028 @interface QemuCocoaAppController : NSObject
1029 <NSWindowDelegate, NSApplicationDelegate>
1032 - (void)doToggleFullScreen:(id)sender;
1033 - (void)toggleFullScreen:(id)sender;
1034 - (void)showQEMUDoc:(id)sender;
1035 - (void)zoomToFit:(id) sender;
1036 - (void)displayConsole:(id)sender;
1037 - (void)pauseQEMU:(id)sender;
1038 - (void)resumeQEMU:(id)sender;
1039 - (void)displayPause;
1040 - (void)removePause;
1041 - (void)restartQEMU:(id)sender;
1042 - (void)powerDownQEMU:(id)sender;
1043 - (void)ejectDeviceMedia:(id)sender;
1044 - (void)changeDeviceMedia:(id)sender;
1046 - (void)openDocumentation:(NSString *)filename;
1047 - (IBAction) do_about_menu_item: (id) sender;
1048 - (void)make_about_window;
1049 - (void)adjustSpeed:(id)sender;
1052 @implementation QemuCocoaAppController
1055 COCOA_DEBUG("QemuCocoaAppController: init\n");
1057 self = [super init];
1060 // create a view and add it to the window
1061 cocoaView = [[QemuCocoaView alloc] initWithFrame:NSMakeRect(0.0, 0.0, 640.0, 480.0)];
1063 error_report("(cocoa) can't create a view");
1068 normalWindow = [[NSWindow alloc] initWithContentRect:[cocoaView frame]
1069 styleMask:NSWindowStyleMaskTitled|NSWindowStyleMaskMiniaturizable|NSWindowStyleMaskClosable
1070 backing:NSBackingStoreBuffered defer:NO];
1072 error_report("(cocoa) can't create window");
1075 [normalWindow setAcceptsMouseMovedEvents:YES];
1076 [normalWindow setTitle:@"QEMU"];
1077 [normalWindow setContentView:cocoaView];
1078 [normalWindow makeKeyAndOrderFront:self];
1079 [normalWindow center];
1080 [normalWindow setDelegate: self];
1081 stretch_video = false;
1083 /* Used for displaying pause on the screen */
1084 pauseLabel = [NSTextField new];
1085 [pauseLabel setBezeled:YES];
1086 [pauseLabel setDrawsBackground:YES];
1087 [pauseLabel setBackgroundColor: [NSColor whiteColor]];
1088 [pauseLabel setEditable:NO];
1089 [pauseLabel setSelectable:NO];
1090 [pauseLabel setStringValue: @"Paused"];
1091 [pauseLabel setFont: [NSFont fontWithName: @"Helvetica" size: 90]];
1092 [pauseLabel setTextColor: [NSColor blackColor]];
1093 [pauseLabel sizeToFit];
1095 // set the supported image file types that can be opened
1096 supportedImageFileTypes = [NSArray arrayWithObjects: @"img", @"iso", @"dmg",
1097 @"qcow", @"qcow2", @"cloop", @"vmdk", @"cdr",
1099 [self make_about_window];
1106 COCOA_DEBUG("QemuCocoaAppController: dealloc\n");
1109 [cocoaView release];
1113 - (void)applicationDidFinishLaunching: (NSNotification *) note
1115 COCOA_DEBUG("QemuCocoaAppController: applicationDidFinishLaunching\n");
1116 allow_events = true;
1117 /* Tell cocoa_display_init to proceed */
1118 qemu_sem_post(&app_started_sem);
1121 - (void)applicationWillTerminate:(NSNotification *)aNotification
1123 COCOA_DEBUG("QemuCocoaAppController: applicationWillTerminate\n");
1125 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_UI);
1129 - (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication
1134 - (NSApplicationTerminateReply)applicationShouldTerminate:
1135 (NSApplication *)sender
1137 COCOA_DEBUG("QemuCocoaAppController: applicationShouldTerminate\n");
1138 return [self verifyQuit];
1141 /* Called when the user clicks on a window's close button */
1142 - (BOOL)windowShouldClose:(id)sender
1144 COCOA_DEBUG("QemuCocoaAppController: windowShouldClose\n");
1145 [NSApp terminate: sender];
1146 /* If the user allows the application to quit then the call to
1147 * NSApp terminate will never return. If we get here then the user
1148 * cancelled the quit, so we should return NO to not permit the
1149 * closing of this window.
1154 /* Called when QEMU goes into the background */
1155 - (void) applicationWillResignActive: (NSNotification *)aNotification
1157 COCOA_DEBUG("QemuCocoaAppController: applicationWillResignActive\n");
1158 [cocoaView raiseAllKeys];
1161 /* We abstract the method called by the Enter Fullscreen menu item
1162 * because Mac OS 10.7 and higher disables it. This is because of the
1163 * menu item's old selector's name toggleFullScreen:
1165 - (void) doToggleFullScreen:(id)sender
1167 [self toggleFullScreen:(id)sender];
1170 - (void)toggleFullScreen:(id)sender
1172 COCOA_DEBUG("QemuCocoaAppController: toggleFullScreen\n");
1174 [cocoaView toggleFullScreen:sender];
1177 /* Tries to find then open the specified filename */
1178 - (void) openDocumentation: (NSString *) filename
1180 /* Where to look for local files */
1181 NSString *path_array[] = {@"../share/doc/qemu/", @"../doc/qemu/", @"docs/"};
1182 NSString *full_file_path;
1183 NSURL *full_file_url;
1185 /* iterate thru the possible paths until the file is found */
1187 for (index = 0; index < ARRAY_SIZE(path_array); index++) {
1188 full_file_path = [[NSBundle mainBundle] executablePath];
1189 full_file_path = [full_file_path stringByDeletingLastPathComponent];
1190 full_file_path = [NSString stringWithFormat: @"%@/%@%@", full_file_path,
1191 path_array[index], filename];
1192 full_file_url = [NSURL fileURLWithPath: full_file_path
1193 isDirectory: false];
1194 if ([[NSWorkspace sharedWorkspace] openURL: full_file_url] == YES) {
1199 /* If none of the paths opened a file */
1201 QEMU_Alert(@"Failed to open file");
1204 - (void)showQEMUDoc:(id)sender
1206 COCOA_DEBUG("QemuCocoaAppController: showQEMUDoc\n");
1208 [self openDocumentation: @"index.html"];
1211 /* Stretches video to fit host monitor size */
1212 - (void)zoomToFit:(id) sender
1214 stretch_video = !stretch_video;
1215 if (stretch_video == true) {
1216 [sender setState: NSControlStateValueOn];
1218 [sender setState: NSControlStateValueOff];
1222 /* Displays the console on the screen */
1223 - (void)displayConsole:(id)sender
1225 console_select([sender tag]);
1228 /* Pause the guest */
1229 - (void)pauseQEMU:(id)sender
1231 with_iothread_lock(^{
1234 [sender setEnabled: NO];
1235 [[[sender menu] itemWithTitle: @"Resume"] setEnabled: YES];
1236 [self displayPause];
1239 /* Resume running the guest operating system */
1240 - (void)resumeQEMU:(id) sender
1242 with_iothread_lock(^{
1245 [sender setEnabled: NO];
1246 [[[sender menu] itemWithTitle: @"Pause"] setEnabled: YES];
1250 /* Displays the word pause on the screen */
1251 - (void)displayPause
1253 /* Coordinates have to be calculated each time because the window can change its size */
1254 int xCoord, yCoord, width, height;
1255 xCoord = ([normalWindow frame].size.width - [pauseLabel frame].size.width)/2;
1256 yCoord = [normalWindow frame].size.height - [pauseLabel frame].size.height - ([pauseLabel frame].size.height * .5);
1257 width = [pauseLabel frame].size.width;
1258 height = [pauseLabel frame].size.height;
1259 [pauseLabel setFrame: NSMakeRect(xCoord, yCoord, width, height)];
1260 [cocoaView addSubview: pauseLabel];
1263 /* Removes the word pause from the screen */
1266 [pauseLabel removeFromSuperview];
1270 - (void)restartQEMU:(id)sender
1272 with_iothread_lock(^{
1273 qmp_system_reset(NULL);
1277 /* Powers down QEMU */
1278 - (void)powerDownQEMU:(id)sender
1280 with_iothread_lock(^{
1281 qmp_system_powerdown(NULL);
1285 /* Ejects the media.
1286 * Uses sender's tag to figure out the device to eject.
1288 - (void)ejectDeviceMedia:(id)sender
1291 drive = [sender representedObject];
1294 QEMU_Alert(@"Failed to find drive to eject!");
1298 __block Error *err = NULL;
1299 with_iothread_lock(^{
1300 qmp_eject(true, [drive cStringUsingEncoding: NSASCIIStringEncoding],
1301 false, NULL, false, false, &err);
1303 handleAnyDeviceErrors(err);
1306 /* Displays a dialog box asking the user to select an image file to load.
1307 * Uses sender's represented object value to figure out which drive to use.
1309 - (void)changeDeviceMedia:(id)sender
1311 /* Find the drive name */
1313 drive = [sender representedObject];
1316 QEMU_Alert(@"Could not find drive!");
1320 /* Display the file open dialog */
1321 NSOpenPanel * openPanel;
1322 openPanel = [NSOpenPanel openPanel];
1323 [openPanel setCanChooseFiles: YES];
1324 [openPanel setAllowsMultipleSelection: NO];
1325 [openPanel setAllowedFileTypes: supportedImageFileTypes];
1326 if([openPanel runModal] == NSModalResponseOK) {
1327 NSString * file = [[[openPanel URLs] objectAtIndex: 0] path];
1330 QEMU_Alert(@"Failed to convert URL to file path!");
1334 __block Error *err = NULL;
1335 with_iothread_lock(^{
1336 qmp_blockdev_change_medium(true,
1337 [drive cStringUsingEncoding:
1338 NSASCIIStringEncoding],
1340 [file cStringUsingEncoding:
1341 NSASCIIStringEncoding],
1346 handleAnyDeviceErrors(err);
1350 /* Verifies if the user really wants to quit */
1353 NSAlert *alert = [NSAlert new];
1354 [alert autorelease];
1355 [alert setMessageText: @"Are you sure you want to quit QEMU?"];
1356 [alert addButtonWithTitle: @"Cancel"];
1357 [alert addButtonWithTitle: @"Quit"];
1358 if([alert runModal] == NSAlertSecondButtonReturn) {
1365 /* The action method for the About menu item */
1366 - (IBAction) do_about_menu_item: (id) sender
1368 [about_window makeKeyAndOrderFront: nil];
1371 /* Create and display the about dialog */
1372 - (void)make_about_window
1374 /* Make the window */
1375 int x = 0, y = 0, about_width = 400, about_height = 200;
1376 NSRect window_rect = NSMakeRect(x, y, about_width, about_height);
1377 about_window = [[NSWindow alloc] initWithContentRect:window_rect
1378 styleMask:NSWindowStyleMaskTitled | NSWindowStyleMaskClosable |
1379 NSWindowStyleMaskMiniaturizable
1380 backing:NSBackingStoreBuffered
1382 [about_window setTitle: @"About"];
1383 [about_window setReleasedWhenClosed: NO];
1384 [about_window center];
1385 NSView *superView = [about_window contentView];
1387 /* Create the dimensions of the picture */
1388 int picture_width = 80, picture_height = 80;
1389 x = (about_width - picture_width)/2;
1390 y = about_height - picture_height - 10;
1391 NSRect picture_rect = NSMakeRect(x, y, picture_width, picture_height);
1393 /* Get the path to the QEMU binary */
1394 NSString *binary_name = [NSString stringWithCString: gArgv[0]
1395 encoding: NSASCIIStringEncoding];
1396 binary_name = [binary_name lastPathComponent];
1397 NSString *program_path = [[NSString alloc] initWithFormat: @"%@/%@",
1398 [[NSBundle mainBundle] bundlePath], binary_name];
1400 /* Make the picture of QEMU */
1401 NSImageView *picture_view = [[NSImageView alloc] initWithFrame:
1403 NSImage *qemu_image = [[NSWorkspace sharedWorkspace] iconForFile:
1405 [picture_view setImage: qemu_image];
1406 [picture_view setImageScaling: NSImageScaleProportionallyUpOrDown];
1407 [superView addSubview: picture_view];
1409 /* Make the name label */
1412 int name_width = about_width, name_height = 20;
1413 NSRect name_rect = NSMakeRect(x, y, name_width, name_height);
1414 NSTextField *name_label = [[NSTextField alloc] initWithFrame: name_rect];
1415 [name_label setEditable: NO];
1416 [name_label setBezeled: NO];
1417 [name_label setDrawsBackground: NO];
1418 [name_label setAlignment: NSTextAlignmentCenter];
1419 NSString *qemu_name = [[NSString alloc] initWithCString: gArgv[0]
1420 encoding: NSASCIIStringEncoding];
1421 qemu_name = [qemu_name lastPathComponent];
1422 [name_label setStringValue: qemu_name];
1423 [superView addSubview: name_label];
1425 /* Set the version label's attributes */
1428 int version_width = about_width, version_height = 20;
1429 NSRect version_rect = NSMakeRect(x, y, version_width, version_height);
1430 NSTextField *version_label = [[NSTextField alloc] initWithFrame:
1432 [version_label setEditable: NO];
1433 [version_label setBezeled: NO];
1434 [version_label setAlignment: NSTextAlignmentCenter];
1435 [version_label setDrawsBackground: NO];
1437 /* Create the version string*/
1438 NSString *version_string;
1439 version_string = [[NSString alloc] initWithFormat:
1440 @"QEMU emulator version %s", QEMU_FULL_VERSION];
1441 [version_label setStringValue: version_string];
1442 [superView addSubview: version_label];
1444 /* Make copyright label */
1447 int copyright_width = about_width, copyright_height = 20;
1448 NSRect copyright_rect = NSMakeRect(x, y, copyright_width, copyright_height);
1449 NSTextField *copyright_label = [[NSTextField alloc] initWithFrame:
1451 [copyright_label setEditable: NO];
1452 [copyright_label setBezeled: NO];
1453 [copyright_label setDrawsBackground: NO];
1454 [copyright_label setAlignment: NSTextAlignmentCenter];
1455 [copyright_label setStringValue: [NSString stringWithFormat: @"%s",
1457 [superView addSubview: copyright_label];
1460 /* Used by the Speed menu items */
1461 - (void)adjustSpeed:(id)sender
1463 int throttle_pct; /* throttle percentage */
1466 menu = [sender menu];
1469 /* Unselect the currently selected item */
1470 for (NSMenuItem *item in [menu itemArray]) {
1471 if (item.state == NSControlStateValueOn) {
1472 [item setState: NSControlStateValueOff];
1478 // check the menu item
1479 [sender setState: NSControlStateValueOn];
1481 // get the throttle percentage
1482 throttle_pct = [sender tag];
1484 with_iothread_lock(^{
1485 cpu_throttle_set(throttle_pct);
1487 COCOA_DEBUG("cpu throttling at %d%c\n", cpu_throttle_get_percentage(), '%');
1492 @interface QemuApplication : NSApplication
1495 @implementation QemuApplication
1496 - (void)sendEvent:(NSEvent *)event
1498 COCOA_DEBUG("QemuApplication: sendEvent\n");
1499 if (![cocoaView handleEvent:event]) {
1500 [super sendEvent: event];
1505 static void create_initial_menus(void)
1509 NSMenuItem *menuItem;
1511 [NSApp setMainMenu:[[NSMenu alloc] init]];
1514 menu = [[NSMenu alloc] initWithTitle:@""];
1515 [menu addItemWithTitle:@"About QEMU" action:@selector(do_about_menu_item:) keyEquivalent:@""]; // About QEMU
1516 [menu addItem:[NSMenuItem separatorItem]]; //Separator
1517 [menu addItemWithTitle:@"Hide QEMU" action:@selector(hide:) keyEquivalent:@"h"]; //Hide QEMU
1518 menuItem = (NSMenuItem *)[menu addItemWithTitle:@"Hide Others" action:@selector(hideOtherApplications:) keyEquivalent:@"h"]; // Hide Others
1519 [menuItem setKeyEquivalentModifierMask:(NSEventModifierFlagOption|NSEventModifierFlagCommand)];
1520 [menu addItemWithTitle:@"Show All" action:@selector(unhideAllApplications:) keyEquivalent:@""]; // Show All
1521 [menu addItem:[NSMenuItem separatorItem]]; //Separator
1522 [menu addItemWithTitle:@"Quit QEMU" action:@selector(terminate:) keyEquivalent:@"q"];
1523 menuItem = [[NSMenuItem alloc] initWithTitle:@"Apple" action:nil keyEquivalent:@""];
1524 [menuItem setSubmenu:menu];
1525 [[NSApp mainMenu] addItem:menuItem];
1526 [NSApp performSelector:@selector(setAppleMenu:) withObject:menu]; // Workaround (this method is private since 10.4+)
1529 menu = [[NSMenu alloc] initWithTitle: @"Machine"];
1530 [menu setAutoenablesItems: NO];
1531 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Pause" action: @selector(pauseQEMU:) keyEquivalent: @""] autorelease]];
1532 menuItem = [[[NSMenuItem alloc] initWithTitle: @"Resume" action: @selector(resumeQEMU:) keyEquivalent: @""] autorelease];
1533 [menu addItem: menuItem];
1534 [menuItem setEnabled: NO];
1535 [menu addItem: [NSMenuItem separatorItem]];
1536 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Reset" action: @selector(restartQEMU:) keyEquivalent: @""] autorelease]];
1537 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Power Down" action: @selector(powerDownQEMU:) keyEquivalent: @""] autorelease]];
1538 menuItem = [[[NSMenuItem alloc] initWithTitle: @"Machine" action:nil keyEquivalent:@""] autorelease];
1539 [menuItem setSubmenu:menu];
1540 [[NSApp mainMenu] addItem:menuItem];
1543 menu = [[NSMenu alloc] initWithTitle:@"View"];
1544 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Enter Fullscreen" action:@selector(doToggleFullScreen:) keyEquivalent:@"f"] autorelease]]; // Fullscreen
1545 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Zoom To Fit" action:@selector(zoomToFit:) keyEquivalent:@""] autorelease]];
1546 menuItem = [[[NSMenuItem alloc] initWithTitle:@"View" action:nil keyEquivalent:@""] autorelease];
1547 [menuItem setSubmenu:menu];
1548 [[NSApp mainMenu] addItem:menuItem];
1551 menu = [[NSMenu alloc] initWithTitle:@"Speed"];
1553 // Add the rest of the Speed menu items
1554 int p, percentage, throttle_pct;
1555 for (p = 10; p >= 0; p--)
1557 percentage = p * 10 > 1 ? p * 10 : 1; // prevent a 0% menu item
1559 menuItem = [[[NSMenuItem alloc]
1560 initWithTitle: [NSString stringWithFormat: @"%d%%", percentage] action:@selector(adjustSpeed:) keyEquivalent:@""] autorelease];
1562 if (percentage == 100) {
1563 [menuItem setState: NSControlStateValueOn];
1566 /* Calculate the throttle percentage */
1567 throttle_pct = -1 * percentage + 100;
1569 [menuItem setTag: throttle_pct];
1570 [menu addItem: menuItem];
1572 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Speed" action:nil keyEquivalent:@""] autorelease];
1573 [menuItem setSubmenu:menu];
1574 [[NSApp mainMenu] addItem:menuItem];
1577 menu = [[NSMenu alloc] initWithTitle:@"Window"];
1578 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Minimize" action:@selector(performMiniaturize:) keyEquivalent:@"m"] autorelease]]; // Miniaturize
1579 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""] autorelease];
1580 [menuItem setSubmenu:menu];
1581 [[NSApp mainMenu] addItem:menuItem];
1582 [NSApp setWindowsMenu:menu];
1585 menu = [[NSMenu alloc] initWithTitle:@"Help"];
1586 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"QEMU Documentation" action:@selector(showQEMUDoc:) keyEquivalent:@"?"] autorelease]]; // QEMU Help
1587 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""] autorelease];
1588 [menuItem setSubmenu:menu];
1589 [[NSApp mainMenu] addItem:menuItem];
1592 /* Returns a name for a given console */
1593 static NSString * getConsoleName(QemuConsole * console)
1595 return [NSString stringWithFormat: @"%s", qemu_console_get_label(console)];
1598 /* Add an entry to the View menu for each console */
1599 static void add_console_menu_entries(void)
1602 NSMenuItem *menuItem;
1605 menu = [[[NSApp mainMenu] itemWithTitle:@"View"] submenu];
1607 [menu addItem:[NSMenuItem separatorItem]];
1609 while (qemu_console_lookup_by_index(index) != NULL) {
1610 menuItem = [[[NSMenuItem alloc] initWithTitle: getConsoleName(qemu_console_lookup_by_index(index))
1611 action: @selector(displayConsole:) keyEquivalent: @""] autorelease];
1612 [menuItem setTag: index];
1613 [menu addItem: menuItem];
1618 /* Make menu items for all removable devices.
1619 * Each device is given an 'Eject' and 'Change' menu item.
1621 static void addRemovableDevicesMenuItems(void)
1624 NSMenuItem *menuItem;
1625 BlockInfoList *currentDevice, *pointerToFree;
1626 NSString *deviceName;
1628 currentDevice = qmp_query_block(NULL);
1629 pointerToFree = currentDevice;
1630 if(currentDevice == NULL) {
1632 QEMU_Alert(@"Failed to query for block devices!");
1636 menu = [[[NSApp mainMenu] itemWithTitle:@"Machine"] submenu];
1638 // Add a separator between related groups of menu items
1639 [menu addItem:[NSMenuItem separatorItem]];
1641 // Set the attributes to the "Removable Media" menu item
1642 NSString *titleString = @"Removable Media";
1643 NSMutableAttributedString *attString=[[NSMutableAttributedString alloc] initWithString:titleString];
1644 NSColor *newColor = [NSColor blackColor];
1645 NSFontManager *fontManager = [NSFontManager sharedFontManager];
1646 NSFont *font = [fontManager fontWithFamily:@"Helvetica"
1647 traits:NSBoldFontMask|NSItalicFontMask
1650 [attString addAttribute:NSFontAttributeName value:font range:NSMakeRange(0, [titleString length])];
1651 [attString addAttribute:NSForegroundColorAttributeName value:newColor range:NSMakeRange(0, [titleString length])];
1652 [attString addAttribute:NSUnderlineStyleAttributeName value:[NSNumber numberWithInt: 1] range:NSMakeRange(0, [titleString length])];
1654 // Add the "Removable Media" menu item
1655 menuItem = [NSMenuItem new];
1656 [menuItem setAttributedTitle: attString];
1657 [menuItem setEnabled: NO];
1658 [menu addItem: menuItem];
1660 /* Loop through all the block devices in the emulator */
1661 while (currentDevice) {
1662 deviceName = [[NSString stringWithFormat: @"%s", currentDevice->value->device] retain];
1664 if(currentDevice->value->removable) {
1665 menuItem = [[NSMenuItem alloc] initWithTitle: [NSString stringWithFormat: @"Change %s...", currentDevice->value->device]
1666 action: @selector(changeDeviceMedia:)
1667 keyEquivalent: @""];
1668 [menu addItem: menuItem];
1669 [menuItem setRepresentedObject: deviceName];
1670 [menuItem autorelease];
1672 menuItem = [[NSMenuItem alloc] initWithTitle: [NSString stringWithFormat: @"Eject %s", currentDevice->value->device]
1673 action: @selector(ejectDeviceMedia:)
1674 keyEquivalent: @""];
1675 [menu addItem: menuItem];
1676 [menuItem setRepresentedObject: deviceName];
1677 [menuItem autorelease];
1679 currentDevice = currentDevice->next;
1681 qapi_free_BlockInfoList(pointerToFree);
1685 * The startup process for the OSX/Cocoa UI is complicated, because
1686 * OSX insists that the UI runs on the initial main thread, and so we
1687 * need to start a second thread which runs the vl.c qemu_main():
1689 * Initial thread: 2nd thread:
1691 * create qemu-main thread
1692 * wait on display_init semaphore
1695 * in cocoa_display_init():
1696 * post the display_init semaphore
1697 * wait on app_started semaphore
1698 * create application, menus, etc
1699 * enter OSX run loop
1700 * in applicationDidFinishLaunching:
1701 * post app_started semaphore
1702 * tell main thread to fullscreen if needed
1704 * run qemu main-loop
1706 * We do this in two stages so that we don't do the creation of the
1707 * GUI application menus and so on for command line options like --help
1708 * where we want to just print text to stdout and exit immediately.
1711 static void *call_qemu_main(void *opaque)
1715 COCOA_DEBUG("Second thread: calling qemu_main()\n");
1716 status = qemu_main(gArgc, gArgv, *_NSGetEnviron());
1717 COCOA_DEBUG("Second thread: qemu_main() returned, exiting\n");
1721 int main (int argc, const char * argv[]) {
1724 COCOA_DEBUG("Entered main()\n");
1726 gArgv = (char **)argv;
1728 qemu_sem_init(&display_init_sem, 0);
1729 qemu_sem_init(&app_started_sem, 0);
1731 qemu_thread_create(&thread, "qemu_main", call_qemu_main,
1732 NULL, QEMU_THREAD_DETACHED);
1734 COCOA_DEBUG("Main thread: waiting for display_init_sem\n");
1735 qemu_sem_wait(&display_init_sem);
1736 COCOA_DEBUG("Main thread: initializing app\n");
1738 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1740 // Pull this console process up to being a fully-fledged graphical
1741 // app with a menubar and Dock icon
1742 ProcessSerialNumber psn = { 0, kCurrentProcess };
1743 TransformProcessType(&psn, kProcessTransformToForegroundApplication);
1745 [QemuApplication sharedApplication];
1747 create_initial_menus();
1750 * Create the menu entries which depend on QEMU state (for consoles
1751 * and removeable devices). These make calls back into QEMU functions,
1752 * which is OK because at this point we know that the second thread
1753 * holds the iothread lock and is synchronously waiting for us to
1756 add_console_menu_entries();
1757 addRemovableDevicesMenuItems();
1759 // Create an Application controller
1760 QemuCocoaAppController *appController = [[QemuCocoaAppController alloc] init];
1761 [NSApp setDelegate:appController];
1763 // Start the main event loop
1764 COCOA_DEBUG("Main thread: entering OSX run loop\n");
1766 COCOA_DEBUG("Main thread: left OSX run loop, exiting\n");
1768 [appController release];
1777 static void cocoa_update(DisplayChangeListener *dcl,
1778 int x, int y, int w, int h)
1780 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1782 COCOA_DEBUG("qemu_cocoa: cocoa_update\n");
1784 dispatch_async(dispatch_get_main_queue(), ^{
1786 if ([cocoaView cdx] == 1.0) {
1787 rect = NSMakeRect(x, [cocoaView gscreen].height - y - h, w, h);
1790 x * [cocoaView cdx],
1791 ([cocoaView gscreen].height - y - h) * [cocoaView cdy],
1792 w * [cocoaView cdx],
1793 h * [cocoaView cdy]);
1795 [cocoaView setNeedsDisplayInRect:rect];
1801 static void cocoa_switch(DisplayChangeListener *dcl,
1802 DisplaySurface *surface)
1804 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1805 pixman_image_t *image = surface->image;
1807 COCOA_DEBUG("qemu_cocoa: cocoa_switch\n");
1809 // The DisplaySurface will be freed as soon as this callback returns.
1810 // We take a reference to the underlying pixman image here so it does
1811 // not disappear from under our feet; the switchSurface method will
1812 // deref the old image when it is done with it.
1813 pixman_image_ref(image);
1815 dispatch_async(dispatch_get_main_queue(), ^{
1816 [cocoaView switchSurface:image];
1821 static void cocoa_refresh(DisplayChangeListener *dcl)
1823 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1825 COCOA_DEBUG("qemu_cocoa: cocoa_refresh\n");
1826 graphic_hw_update(NULL);
1828 if (qemu_input_is_absolute()) {
1829 dispatch_async(dispatch_get_main_queue(), ^{
1830 if (![cocoaView isAbsoluteEnabled]) {
1831 if ([cocoaView isMouseGrabbed]) {
1832 [cocoaView ungrabMouse];
1835 [cocoaView setAbsoluteEnabled:YES];
1841 static void cocoa_display_init(DisplayState *ds, DisplayOptions *opts)
1843 COCOA_DEBUG("qemu_cocoa: cocoa_display_init\n");
1845 /* Tell main thread to go ahead and create the app and enter the run loop */
1846 qemu_sem_post(&display_init_sem);
1847 qemu_sem_wait(&app_started_sem);
1848 COCOA_DEBUG("cocoa_display_init: app start completed\n");
1850 /* if fullscreen mode is to be used */
1851 if (opts->has_full_screen && opts->full_screen) {
1852 dispatch_async(dispatch_get_main_queue(), ^{
1853 [NSApp activateIgnoringOtherApps: YES];
1854 [(QemuCocoaAppController *)[[NSApplication sharedApplication] delegate] toggleFullScreen: nil];
1857 if (opts->has_show_cursor && opts->show_cursor) {
1861 // register vga output callbacks
1862 register_displaychangelistener(&dcl);
1865 static QemuDisplay qemu_display_cocoa = {
1866 .type = DISPLAY_TYPE_COCOA,
1867 .init = cocoa_display_init,
1870 static void register_cocoa(void)
1872 qemu_display_register(&qemu_display_cocoa);
1875 type_init(register_cocoa);