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/help-texts.h"
31 #include "qemu-main.h"
32 #include "ui/clipboard.h"
33 #include "ui/console.h"
35 #include "ui/kbd-state.h"
36 #include "sysemu/sysemu.h"
37 #include "sysemu/runstate.h"
38 #include "sysemu/runstate-action.h"
39 #include "sysemu/cpu-throttle.h"
40 #include "qapi/error.h"
41 #include "qapi/qapi-commands-block.h"
42 #include "qapi/qapi-commands-machine.h"
43 #include "qapi/qapi-commands-misc.h"
44 #include "sysemu/blockdev.h"
45 #include "qemu-version.h"
46 #include "qemu/cutils.h"
47 #include "qemu/main-loop.h"
48 #include "qemu/module.h"
49 #include "qemu/error-report.h"
50 #include <Carbon/Carbon.h>
51 #include "hw/core/cpu.h"
53 #ifndef MAC_OS_X_VERSION_10_13
54 #define MAC_OS_X_VERSION_10_13 101300
57 /* 10.14 deprecates NSOnState and NSOffState in favor of
58 * NSControlStateValueOn/Off, which were introduced in 10.13.
59 * Define for older versions
61 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_13
62 #define NSControlStateValueOn NSOnState
63 #define NSControlStateValueOff NSOffState
69 #define COCOA_DEBUG(...) { (void) fprintf (stdout, __VA_ARGS__); }
71 #define COCOA_DEBUG(...) ((void) 0)
74 #define cgrect(nsrect) (*(CGRect *)&(nsrect))
76 #define UC_CTRL_KEY "\xe2\x8c\x83"
77 #define UC_ALT_KEY "\xe2\x8c\xa5"
84 static void cocoa_update(DisplayChangeListener *dcl,
85 int x, int y, int w, int h);
87 static void cocoa_switch(DisplayChangeListener *dcl,
88 DisplaySurface *surface);
90 static void cocoa_refresh(DisplayChangeListener *dcl);
92 static NSWindow *normalWindow;
93 static const DisplayChangeListenerOps dcl_ops = {
95 .dpy_gfx_update = cocoa_update,
96 .dpy_gfx_switch = cocoa_switch,
97 .dpy_refresh = cocoa_refresh,
99 static DisplayChangeListener dcl = {
102 static int last_buttons;
103 static int cursor_hide = 1;
104 static int left_command_key_enabled = 1;
105 static bool swap_opt_cmd;
107 static bool stretch_video;
108 static NSTextField *pauseLabel;
110 static bool allow_events;
112 static NSInteger cbchangecount = -1;
113 static QemuClipboardInfo *cbinfo;
114 static QemuEvent cbevent;
116 // Utility functions to run specified code block with iothread lock held
117 typedef void (^CodeBlock)(void);
118 typedef bool (^BoolCodeBlock)(void);
120 static void with_iothread_lock(CodeBlock block)
122 bool locked = qemu_mutex_iothread_locked();
124 qemu_mutex_lock_iothread();
128 qemu_mutex_unlock_iothread();
132 static bool bool_with_iothread_lock(BoolCodeBlock block)
134 bool locked = qemu_mutex_iothread_locked();
138 qemu_mutex_lock_iothread();
142 qemu_mutex_unlock_iothread();
147 // Mac to QKeyCode conversion
148 static const int mac_to_qkeycode_map[] = {
149 [kVK_ANSI_A] = Q_KEY_CODE_A,
150 [kVK_ANSI_B] = Q_KEY_CODE_B,
151 [kVK_ANSI_C] = Q_KEY_CODE_C,
152 [kVK_ANSI_D] = Q_KEY_CODE_D,
153 [kVK_ANSI_E] = Q_KEY_CODE_E,
154 [kVK_ANSI_F] = Q_KEY_CODE_F,
155 [kVK_ANSI_G] = Q_KEY_CODE_G,
156 [kVK_ANSI_H] = Q_KEY_CODE_H,
157 [kVK_ANSI_I] = Q_KEY_CODE_I,
158 [kVK_ANSI_J] = Q_KEY_CODE_J,
159 [kVK_ANSI_K] = Q_KEY_CODE_K,
160 [kVK_ANSI_L] = Q_KEY_CODE_L,
161 [kVK_ANSI_M] = Q_KEY_CODE_M,
162 [kVK_ANSI_N] = Q_KEY_CODE_N,
163 [kVK_ANSI_O] = Q_KEY_CODE_O,
164 [kVK_ANSI_P] = Q_KEY_CODE_P,
165 [kVK_ANSI_Q] = Q_KEY_CODE_Q,
166 [kVK_ANSI_R] = Q_KEY_CODE_R,
167 [kVK_ANSI_S] = Q_KEY_CODE_S,
168 [kVK_ANSI_T] = Q_KEY_CODE_T,
169 [kVK_ANSI_U] = Q_KEY_CODE_U,
170 [kVK_ANSI_V] = Q_KEY_CODE_V,
171 [kVK_ANSI_W] = Q_KEY_CODE_W,
172 [kVK_ANSI_X] = Q_KEY_CODE_X,
173 [kVK_ANSI_Y] = Q_KEY_CODE_Y,
174 [kVK_ANSI_Z] = Q_KEY_CODE_Z,
176 [kVK_ANSI_0] = Q_KEY_CODE_0,
177 [kVK_ANSI_1] = Q_KEY_CODE_1,
178 [kVK_ANSI_2] = Q_KEY_CODE_2,
179 [kVK_ANSI_3] = Q_KEY_CODE_3,
180 [kVK_ANSI_4] = Q_KEY_CODE_4,
181 [kVK_ANSI_5] = Q_KEY_CODE_5,
182 [kVK_ANSI_6] = Q_KEY_CODE_6,
183 [kVK_ANSI_7] = Q_KEY_CODE_7,
184 [kVK_ANSI_8] = Q_KEY_CODE_8,
185 [kVK_ANSI_9] = Q_KEY_CODE_9,
187 [kVK_ANSI_Grave] = Q_KEY_CODE_GRAVE_ACCENT,
188 [kVK_ANSI_Minus] = Q_KEY_CODE_MINUS,
189 [kVK_ANSI_Equal] = Q_KEY_CODE_EQUAL,
190 [kVK_Delete] = Q_KEY_CODE_BACKSPACE,
191 [kVK_CapsLock] = Q_KEY_CODE_CAPS_LOCK,
192 [kVK_Tab] = Q_KEY_CODE_TAB,
193 [kVK_Return] = Q_KEY_CODE_RET,
194 [kVK_ANSI_LeftBracket] = Q_KEY_CODE_BRACKET_LEFT,
195 [kVK_ANSI_RightBracket] = Q_KEY_CODE_BRACKET_RIGHT,
196 [kVK_ANSI_Backslash] = Q_KEY_CODE_BACKSLASH,
197 [kVK_ANSI_Semicolon] = Q_KEY_CODE_SEMICOLON,
198 [kVK_ANSI_Quote] = Q_KEY_CODE_APOSTROPHE,
199 [kVK_ANSI_Comma] = Q_KEY_CODE_COMMA,
200 [kVK_ANSI_Period] = Q_KEY_CODE_DOT,
201 [kVK_ANSI_Slash] = Q_KEY_CODE_SLASH,
202 [kVK_Space] = Q_KEY_CODE_SPC,
204 [kVK_ANSI_Keypad0] = Q_KEY_CODE_KP_0,
205 [kVK_ANSI_Keypad1] = Q_KEY_CODE_KP_1,
206 [kVK_ANSI_Keypad2] = Q_KEY_CODE_KP_2,
207 [kVK_ANSI_Keypad3] = Q_KEY_CODE_KP_3,
208 [kVK_ANSI_Keypad4] = Q_KEY_CODE_KP_4,
209 [kVK_ANSI_Keypad5] = Q_KEY_CODE_KP_5,
210 [kVK_ANSI_Keypad6] = Q_KEY_CODE_KP_6,
211 [kVK_ANSI_Keypad7] = Q_KEY_CODE_KP_7,
212 [kVK_ANSI_Keypad8] = Q_KEY_CODE_KP_8,
213 [kVK_ANSI_Keypad9] = Q_KEY_CODE_KP_9,
214 [kVK_ANSI_KeypadDecimal] = Q_KEY_CODE_KP_DECIMAL,
215 [kVK_ANSI_KeypadEnter] = Q_KEY_CODE_KP_ENTER,
216 [kVK_ANSI_KeypadPlus] = Q_KEY_CODE_KP_ADD,
217 [kVK_ANSI_KeypadMinus] = Q_KEY_CODE_KP_SUBTRACT,
218 [kVK_ANSI_KeypadMultiply] = Q_KEY_CODE_KP_MULTIPLY,
219 [kVK_ANSI_KeypadDivide] = Q_KEY_CODE_KP_DIVIDE,
220 [kVK_ANSI_KeypadEquals] = Q_KEY_CODE_KP_EQUALS,
221 [kVK_ANSI_KeypadClear] = Q_KEY_CODE_NUM_LOCK,
223 [kVK_UpArrow] = Q_KEY_CODE_UP,
224 [kVK_DownArrow] = Q_KEY_CODE_DOWN,
225 [kVK_LeftArrow] = Q_KEY_CODE_LEFT,
226 [kVK_RightArrow] = Q_KEY_CODE_RIGHT,
228 [kVK_Help] = Q_KEY_CODE_INSERT,
229 [kVK_Home] = Q_KEY_CODE_HOME,
230 [kVK_PageUp] = Q_KEY_CODE_PGUP,
231 [kVK_PageDown] = Q_KEY_CODE_PGDN,
232 [kVK_End] = Q_KEY_CODE_END,
233 [kVK_ForwardDelete] = Q_KEY_CODE_DELETE,
235 [kVK_Escape] = Q_KEY_CODE_ESC,
237 /* The Power key can't be used directly because the operating system uses
238 * it. This key can be emulated by using it in place of another key such as
239 * F1. Don't forget to disable the real key binding.
241 /* [kVK_F1] = Q_KEY_CODE_POWER, */
243 [kVK_F1] = Q_KEY_CODE_F1,
244 [kVK_F2] = Q_KEY_CODE_F2,
245 [kVK_F3] = Q_KEY_CODE_F3,
246 [kVK_F4] = Q_KEY_CODE_F4,
247 [kVK_F5] = Q_KEY_CODE_F5,
248 [kVK_F6] = Q_KEY_CODE_F6,
249 [kVK_F7] = Q_KEY_CODE_F7,
250 [kVK_F8] = Q_KEY_CODE_F8,
251 [kVK_F9] = Q_KEY_CODE_F9,
252 [kVK_F10] = Q_KEY_CODE_F10,
253 [kVK_F11] = Q_KEY_CODE_F11,
254 [kVK_F12] = Q_KEY_CODE_F12,
255 [kVK_F13] = Q_KEY_CODE_PRINT,
256 [kVK_F14] = Q_KEY_CODE_SCROLL_LOCK,
257 [kVK_F15] = Q_KEY_CODE_PAUSE,
259 // JIS keyboards only
260 [kVK_JIS_Yen] = Q_KEY_CODE_YEN,
261 [kVK_JIS_Underscore] = Q_KEY_CODE_RO,
262 [kVK_JIS_KeypadComma] = Q_KEY_CODE_KP_COMMA,
263 [kVK_JIS_Eisu] = Q_KEY_CODE_MUHENKAN,
264 [kVK_JIS_Kana] = Q_KEY_CODE_HENKAN,
267 * The eject and volume keys can't be used here because they are handled at
268 * a lower level than what an Application can see.
272 static int cocoa_keycode_to_qemu(int keycode)
274 if (ARRAY_SIZE(mac_to_qkeycode_map) <= keycode) {
275 error_report("(cocoa) warning unknown keycode 0x%x", keycode);
278 return mac_to_qkeycode_map[keycode];
281 /* Displays an alert dialog box with the specified message */
282 static void QEMU_Alert(NSString *message)
285 alert = [NSAlert new];
286 [alert setMessageText: message];
290 /* Handles any errors that happen with a device transaction */
291 static void handleAnyDeviceErrors(Error * err)
294 QEMU_Alert([NSString stringWithCString: error_get_pretty(err)
295 encoding: NSASCIIStringEncoding]);
301 ------------------------------------------------------
303 ------------------------------------------------------
305 @interface QemuCocoaView : NSView
308 NSWindow *fullScreenWindow;
309 float cx,cy,cw,ch,cdx,cdy;
310 pixman_image_t *pixman_image;
314 BOOL isAbsoluteEnabled;
315 CFMachPortRef eventsTap;
317 - (void) switchSurface:(pixman_image_t *)image;
319 - (void) ungrabMouse;
320 - (void) toggleFullScreen:(id)sender;
321 - (void) setFullGrab:(id)sender;
322 - (void) handleMonitorInput:(NSEvent *)event;
323 - (bool) handleEvent:(NSEvent *)event;
324 - (bool) handleEventLocked:(NSEvent *)event;
325 - (void) setAbsoluteEnabled:(BOOL)tIsAbsoluteEnabled;
326 /* The state surrounding mouse grabbing is potentially confusing.
327 * isAbsoluteEnabled tracks qemu_input_is_absolute() [ie "is the emulated
328 * pointing device an absolute-position one?"], but is only updated on
330 * isMouseGrabbed tracks whether GUI events are directed to the guest;
331 * it controls whether special keys like Cmd get sent to the guest,
332 * and whether we capture the mouse when in non-absolute mode.
334 - (BOOL) isMouseGrabbed;
335 - (BOOL) isAbsoluteEnabled;
338 - (QEMUScreen) gscreen;
339 - (void) raiseAllKeys;
342 QemuCocoaView *cocoaView;
344 static CGEventRef handleTapEvent(CGEventTapProxy proxy, CGEventType type, CGEventRef cgEvent, void *userInfo)
346 QemuCocoaView *cocoaView = userInfo;
347 NSEvent *event = [NSEvent eventWithCGEvent:cgEvent];
348 if ([cocoaView isMouseGrabbed] && [cocoaView handleEvent:event]) {
349 COCOA_DEBUG("Global events tap: qemu handled the event, capturing!\n");
352 COCOA_DEBUG("Global events tap: qemu did not handle the event, letting it through...\n");
357 @implementation QemuCocoaView
358 - (id)initWithFrame:(NSRect)frameRect
360 COCOA_DEBUG("QemuCocoaView: initWithFrame\n");
362 self = [super initWithFrame:frameRect];
365 screen.width = frameRect.size.width;
366 screen.height = frameRect.size.height;
367 kbd = qkbd_state_init(dcl.con);
375 COCOA_DEBUG("QemuCocoaView: dealloc\n");
378 pixman_image_unref(pixman_image);
381 qkbd_state_free(kbd);
384 CFRelease(eventsTap);
395 - (BOOL) screenContainsPoint:(NSPoint) p
397 return (p.x > -1 && p.x < screen.width && p.y > -1 && p.y < screen.height);
400 /* Get location of event and convert to virtual screen coordinate */
401 - (CGPoint) screenLocationOfEvent:(NSEvent *)ev
403 NSWindow *eventWindow = [ev window];
404 // XXX: Use CGRect and -convertRectFromScreen: to support macOS 10.10
405 CGRect r = CGRectZero;
406 r.origin = [ev locationInWindow];
409 return [[self window] convertRectFromScreen:r].origin;
411 CGPoint locationInSelfWindow = [[self window] convertRectFromScreen:r].origin;
412 CGPoint loc = [self convertPoint:locationInSelfWindow fromView:nil];
419 } else if ([[self window] isEqual:eventWindow]) {
423 CGPoint loc = [self convertPoint:r.origin fromView:nil];
431 return [[self window] convertRectFromScreen:[eventWindow convertRectToScreen:r]].origin;
443 - (void) unhideCursor
451 - (void) drawRect:(NSRect) rect
453 COCOA_DEBUG("QemuCocoaView: drawRect\n");
455 // get CoreGraphic context
456 CGContextRef viewContextRef = [[NSGraphicsContext currentContext] CGContext];
458 CGContextSetInterpolationQuality (viewContextRef, kCGInterpolationNone);
459 CGContextSetShouldAntialias (viewContextRef, NO);
461 // draw screen bitmap directly to Core Graphics context
463 // Draw request before any guest device has set up a framebuffer:
464 // just draw an opaque black rectangle
465 CGContextSetRGBFillColor(viewContextRef, 0, 0, 0, 1.0);
466 CGContextFillRect(viewContextRef, NSRectToCGRect(rect));
468 int w = pixman_image_get_width(pixman_image);
469 int h = pixman_image_get_height(pixman_image);
470 int bitsPerPixel = PIXMAN_FORMAT_BPP(pixman_image_get_format(pixman_image));
471 int stride = pixman_image_get_stride(pixman_image);
472 CGDataProviderRef dataProviderRef = CGDataProviderCreateWithData(
474 pixman_image_get_data(pixman_image),
478 CGImageRef imageRef = CGImageCreate(
481 DIV_ROUND_UP(bitsPerPixel, 8) * 2, //bitsPerComponent
482 bitsPerPixel, //bitsPerPixel
483 stride, //bytesPerRow
484 CGColorSpaceCreateWithName(kCGColorSpaceSRGB), //colorspace
485 kCGBitmapByteOrder32Little | kCGImageAlphaNoneSkipFirst, //bitmapInfo
486 dataProviderRef, //provider
489 kCGRenderingIntentDefault //intent
491 // selective drawing code (draws only dirty rectangles) (OS X >= 10.4)
492 const NSRect *rectList;
495 CGImageRef clipImageRef;
498 [self getRectsBeingDrawn:&rectList count:&rectCount];
499 for (i = 0; i < rectCount; i++) {
500 clipRect.origin.x = rectList[i].origin.x / cdx;
501 clipRect.origin.y = (float)h - (rectList[i].origin.y + rectList[i].size.height) / cdy;
502 clipRect.size.width = rectList[i].size.width / cdx;
503 clipRect.size.height = rectList[i].size.height / cdy;
504 clipImageRef = CGImageCreateWithImageInRect(
508 CGContextDrawImage (viewContextRef, cgrect(rectList[i]), clipImageRef);
509 CGImageRelease (clipImageRef);
511 CGImageRelease (imageRef);
512 CGDataProviderRelease(dataProviderRef);
516 - (void) setContentDimensions
518 COCOA_DEBUG("QemuCocoaView: setContentDimensions\n");
521 cdx = [[NSScreen mainScreen] frame].size.width / (float)screen.width;
522 cdy = [[NSScreen mainScreen] frame].size.height / (float)screen.height;
524 /* stretches video, but keeps same aspect ratio */
525 if (stretch_video == true) {
526 /* use smallest stretch value - prevents clipping on sides */
527 if (MIN(cdx, cdy) == cdx) {
532 } else { /* No stretching */
535 cw = screen.width * cdx;
536 ch = screen.height * cdy;
537 cx = ([[NSScreen mainScreen] frame].size.width - cw) / 2.0;
538 cy = ([[NSScreen mainScreen] frame].size.height - ch) / 2.0;
549 - (void) updateUIInfoLocked
551 /* Must be called with the iothread lock, i.e. via updateUIInfo */
555 if (!qemu_console_is_graphic(dcl.con)) {
560 NSDictionary *description = [[[self window] screen] deviceDescription];
561 CGDirectDisplayID display = [[description objectForKey:@"NSScreenNumber"] unsignedIntValue];
562 NSSize screenSize = [[[self window] screen] frame].size;
563 CGSize screenPhysicalSize = CGDisplayScreenSize(display);
564 CVDisplayLinkRef displayLink;
566 frameSize = isFullscreen ? screenSize : [self frame].size;
568 if (!CVDisplayLinkCreateWithCGDisplay(display, &displayLink)) {
569 CVTime period = CVDisplayLinkGetNominalOutputVideoRefreshPeriod(displayLink);
570 CVDisplayLinkRelease(displayLink);
571 if (!(period.flags & kCVTimeIsIndefinite)) {
572 update_displaychangelistener(&dcl,
573 1000 * period.timeValue / period.timeScale);
574 info.refresh_rate = (int64_t)1000 * period.timeScale / period.timeValue;
578 info.width_mm = frameSize.width / screenSize.width * screenPhysicalSize.width;
579 info.height_mm = frameSize.height / screenSize.height * screenPhysicalSize.height;
581 frameSize = [self frame].size;
588 info.width = frameSize.width;
589 info.height = frameSize.height;
591 dpy_set_ui_info(dcl.con, &info, TRUE);
594 - (void) updateUIInfo
598 * Don't try to tell QEMU about UI information in the application
599 * startup phase -- we haven't yet registered dcl with the QEMU UI
601 * When cocoa_display_init() does register the dcl, the UI layer
602 * will call cocoa_switch(), which will call updateUIInfo, so
603 * we don't lose any information here.
608 with_iothread_lock(^{
609 [self updateUIInfoLocked];
613 - (void)viewDidMoveToWindow
618 - (void) switchSurface:(pixman_image_t *)image
620 COCOA_DEBUG("QemuCocoaView: switchSurface\n");
622 int w = pixman_image_get_width(image);
623 int h = pixman_image_get_height(image);
624 /* cdx == 0 means this is our very first surface, in which case we need
625 * to recalculate the content dimensions even if it happens to be the size
626 * of the initial empty window.
628 bool isResize = (w != screen.width || h != screen.height || cdx == 0.0);
630 int oldh = screen.height;
632 // Resize before we trigger the redraw, or we'll redraw at the wrong size
633 COCOA_DEBUG("switchSurface: new size %d x %d\n", w, h);
636 [self setContentDimensions];
637 [self setFrame:NSMakeRect(cx, cy, cw, ch)];
640 // update screenBuffer
642 pixman_image_unref(pixman_image);
645 pixman_image = image;
649 [[fullScreenWindow contentView] setFrame:[[NSScreen mainScreen] frame]];
650 [normalWindow setFrame:NSMakeRect([normalWindow frame].origin.x, [normalWindow frame].origin.y - h + oldh, w, h + [normalWindow frame].size.height - oldh) display:NO animate:NO];
653 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s", qemu_name]];
654 [normalWindow setFrame:NSMakeRect([normalWindow frame].origin.x, [normalWindow frame].origin.y - h + oldh, w, h + [normalWindow frame].size.height - oldh) display:YES animate:NO];
658 [normalWindow center];
662 - (void) toggleFullScreen:(id)sender
664 COCOA_DEBUG("QemuCocoaView: toggleFullScreen\n");
666 if (isFullscreen) { // switch from fullscreen to desktop
667 isFullscreen = FALSE;
669 [self setContentDimensions];
670 [fullScreenWindow close];
671 [normalWindow setContentView: self];
672 [normalWindow makeKeyAndOrderFront: self];
673 [NSMenu setMenuBarVisible:YES];
674 } else { // switch from desktop to fullscreen
676 [normalWindow orderOut: nil]; /* Hide the window */
678 [self setContentDimensions];
679 [NSMenu setMenuBarVisible:NO];
680 fullScreenWindow = [[NSWindow alloc] initWithContentRect:[[NSScreen mainScreen] frame]
681 styleMask:NSWindowStyleMaskBorderless
682 backing:NSBackingStoreBuffered
684 [fullScreenWindow setAcceptsMouseMovedEvents: YES];
685 [fullScreenWindow setHasShadow:NO];
686 [fullScreenWindow setBackgroundColor: [NSColor blackColor]];
687 [self setFrame:NSMakeRect(cx, cy, cw, ch)];
688 [[fullScreenWindow contentView] addSubview: self];
689 [fullScreenWindow makeKeyAndOrderFront:self];
693 - (void) setFullGrab:(id)sender
695 COCOA_DEBUG("QemuCocoaView: setFullGrab\n");
697 CGEventMask mask = CGEventMaskBit(kCGEventKeyDown) | CGEventMaskBit(kCGEventKeyUp) | CGEventMaskBit(kCGEventFlagsChanged);
698 eventsTap = CGEventTapCreate(kCGHIDEventTap, kCGHeadInsertEventTap, kCGEventTapOptionDefault,
699 mask, handleTapEvent, self);
701 warn_report("Could not create event tap, system key combos will not be captured.\n");
704 COCOA_DEBUG("Global events tap created! Will capture system key combos.\n");
707 CFRunLoopRef runLoop = CFRunLoopGetCurrent();
709 warn_report("Could not obtain current CF RunLoop, system key combos will not be captured.\n");
713 CFRunLoopSourceRef tapEventsSrc = CFMachPortCreateRunLoopSource(kCFAllocatorDefault, eventsTap, 0);
714 if (!tapEventsSrc ) {
715 warn_report("Could not obtain current CF RunLoop, system key combos will not be captured.\n");
719 CFRunLoopAddSource(runLoop, tapEventsSrc, kCFRunLoopDefaultMode);
720 CFRelease(tapEventsSrc);
723 - (void) toggleKey: (int)keycode {
724 qkbd_state_key_event(kbd, keycode, !qkbd_state_key_get(kbd, keycode));
727 // Does the work of sending input to the monitor
728 - (void) handleMonitorInput:(NSEvent *)event
733 // if the control key is down
734 if ([event modifierFlags] & NSEventModifierFlagControl) {
738 /* translates Macintosh keycodes to QEMU's keysym */
740 static const int without_control_translation[] = {
741 [0 ... 0xff] = 0, // invalid key
743 [kVK_UpArrow] = QEMU_KEY_UP,
744 [kVK_DownArrow] = QEMU_KEY_DOWN,
745 [kVK_RightArrow] = QEMU_KEY_RIGHT,
746 [kVK_LeftArrow] = QEMU_KEY_LEFT,
747 [kVK_Home] = QEMU_KEY_HOME,
748 [kVK_End] = QEMU_KEY_END,
749 [kVK_PageUp] = QEMU_KEY_PAGEUP,
750 [kVK_PageDown] = QEMU_KEY_PAGEDOWN,
751 [kVK_ForwardDelete] = QEMU_KEY_DELETE,
752 [kVK_Delete] = QEMU_KEY_BACKSPACE,
755 static const int with_control_translation[] = {
756 [0 ... 0xff] = 0, // invalid key
758 [kVK_UpArrow] = QEMU_KEY_CTRL_UP,
759 [kVK_DownArrow] = QEMU_KEY_CTRL_DOWN,
760 [kVK_RightArrow] = QEMU_KEY_CTRL_RIGHT,
761 [kVK_LeftArrow] = QEMU_KEY_CTRL_LEFT,
762 [kVK_Home] = QEMU_KEY_CTRL_HOME,
763 [kVK_End] = QEMU_KEY_CTRL_END,
764 [kVK_PageUp] = QEMU_KEY_CTRL_PAGEUP,
765 [kVK_PageDown] = QEMU_KEY_CTRL_PAGEDOWN,
768 if (control_key != 0) { /* If the control key is being used */
769 if ([event keyCode] < ARRAY_SIZE(with_control_translation)) {
770 keysym = with_control_translation[[event keyCode]];
773 if ([event keyCode] < ARRAY_SIZE(without_control_translation)) {
774 keysym = without_control_translation[[event keyCode]];
778 // if not a key that needs translating
780 NSString *ks = [event characters];
781 if ([ks length] > 0) {
782 keysym = [ks characterAtIndex:0];
787 kbd_put_keysym(keysym);
791 - (bool) handleEvent:(NSEvent *)event
793 return bool_with_iothread_lock(^{
794 return [self handleEventLocked:event];
798 - (bool) handleEventLocked:(NSEvent *)event
800 /* Return true if we handled the event, false if it should be given to OSX */
801 COCOA_DEBUG("QemuCocoaView: handleEvent\n");
804 bool mouse_event = false;
805 // Location of event in virtual screen coordinates
806 NSPoint p = [self screenLocationOfEvent:event];
807 NSUInteger modifiers = [event modifierFlags];
810 * Check -[NSEvent modifierFlags] here.
812 * There is a NSEventType for an event notifying the change of
813 * -[NSEvent modifierFlags], NSEventTypeFlagsChanged but these operations
814 * are performed for any events because a modifier state may change while
815 * the application is inactive (i.e. no events fire) and we don't want to
816 * wait for another modifier state change to detect such a change.
818 * NSEventModifierFlagCapsLock requires a special treatment. The other flags
819 * are handled in similar manners.
821 * NSEventModifierFlagCapsLock
822 * ---------------------------
824 * If CapsLock state is changed, "up" and "down" events will be fired in
825 * sequence, effectively updates CapsLock state on the guest.
830 * If a flag is not set, fire "up" events for all keys which correspond to
831 * the flag. Note that "down" events are not fired here because the flags
832 * checked here do not tell what exact keys are down.
834 * If one of the keys corresponding to a flag is down, we rely on
835 * -[NSEvent keyCode] of an event whose -[NSEvent type] is
836 * NSEventTypeFlagsChanged to know the exact key which is down, which has
837 * the following two downsides:
838 * - It does not work when the application is inactive as described above.
839 * - It malfactions *after* the modifier state is changed while the
840 * application is inactive. It is because -[NSEvent keyCode] does not tell
841 * if the key is up or down, and requires to infer the current state from
842 * the previous state. It is still possible to fix such a malfanction by
843 * completely leaving your hands from the keyboard, which hopefully makes
844 * this implementation usable enough.
846 if (!!(modifiers & NSEventModifierFlagCapsLock) !=
847 qkbd_state_modifier_get(kbd, QKBD_MOD_CAPSLOCK)) {
848 qkbd_state_key_event(kbd, Q_KEY_CODE_CAPS_LOCK, true);
849 qkbd_state_key_event(kbd, Q_KEY_CODE_CAPS_LOCK, false);
852 if (!(modifiers & NSEventModifierFlagShift)) {
853 qkbd_state_key_event(kbd, Q_KEY_CODE_SHIFT, false);
854 qkbd_state_key_event(kbd, Q_KEY_CODE_SHIFT_R, false);
856 if (!(modifiers & NSEventModifierFlagControl)) {
857 qkbd_state_key_event(kbd, Q_KEY_CODE_CTRL, false);
858 qkbd_state_key_event(kbd, Q_KEY_CODE_CTRL_R, false);
860 if (!(modifiers & NSEventModifierFlagOption)) {
862 qkbd_state_key_event(kbd, Q_KEY_CODE_META_L, false);
863 qkbd_state_key_event(kbd, Q_KEY_CODE_META_R, false);
865 qkbd_state_key_event(kbd, Q_KEY_CODE_ALT, false);
866 qkbd_state_key_event(kbd, Q_KEY_CODE_ALT_R, false);
869 if (!(modifiers & NSEventModifierFlagCommand)) {
871 qkbd_state_key_event(kbd, Q_KEY_CODE_ALT, false);
872 qkbd_state_key_event(kbd, Q_KEY_CODE_ALT_R, false);
874 qkbd_state_key_event(kbd, Q_KEY_CODE_META_L, false);
875 qkbd_state_key_event(kbd, Q_KEY_CODE_META_R, false);
879 switch ([event type]) {
880 case NSEventTypeFlagsChanged:
881 switch ([event keyCode]) {
883 if (!!(modifiers & NSEventModifierFlagShift)) {
884 [self toggleKey:Q_KEY_CODE_SHIFT];
889 if (!!(modifiers & NSEventModifierFlagShift)) {
890 [self toggleKey:Q_KEY_CODE_SHIFT_R];
895 if (!!(modifiers & NSEventModifierFlagControl)) {
896 [self toggleKey:Q_KEY_CODE_CTRL];
900 case kVK_RightControl:
901 if (!!(modifiers & NSEventModifierFlagControl)) {
902 [self toggleKey:Q_KEY_CODE_CTRL_R];
907 if (!!(modifiers & NSEventModifierFlagOption)) {
909 [self toggleKey:Q_KEY_CODE_META_L];
911 [self toggleKey:Q_KEY_CODE_ALT];
916 case kVK_RightOption:
917 if (!!(modifiers & NSEventModifierFlagOption)) {
919 [self toggleKey:Q_KEY_CODE_META_R];
921 [self toggleKey:Q_KEY_CODE_ALT_R];
926 /* Don't pass command key changes to guest unless mouse is grabbed */
928 if (isMouseGrabbed &&
929 !!(modifiers & NSEventModifierFlagCommand) &&
930 left_command_key_enabled) {
932 [self toggleKey:Q_KEY_CODE_ALT];
934 [self toggleKey:Q_KEY_CODE_META_L];
939 case kVK_RightCommand:
940 if (isMouseGrabbed &&
941 !!(modifiers & NSEventModifierFlagCommand)) {
943 [self toggleKey:Q_KEY_CODE_ALT_R];
945 [self toggleKey:Q_KEY_CODE_META_R];
951 case NSEventTypeKeyDown:
952 keycode = cocoa_keycode_to_qemu([event keyCode]);
954 // forward command key combos to the host UI unless the mouse is grabbed
955 if (!isMouseGrabbed && ([event modifierFlags] & NSEventModifierFlagCommand)) {
961 // handle control + alt Key Combos (ctrl+alt+[1..9,g] is reserved for QEMU)
962 if (([event modifierFlags] & NSEventModifierFlagControl) && ([event modifierFlags] & NSEventModifierFlagOption)) {
963 NSString *keychar = [event charactersIgnoringModifiers];
964 if ([keychar length] == 1) {
965 char key = [keychar characterAtIndex:0];
968 // enable graphic console
970 console_select(key - '0' - 1); /* ascii math */
973 // release the mouse grab
981 if (qemu_console_is_graphic(NULL)) {
982 qkbd_state_key_event(kbd, keycode, true);
984 [self handleMonitorInput: event];
987 case NSEventTypeKeyUp:
988 keycode = cocoa_keycode_to_qemu([event keyCode]);
990 // don't pass the guest a spurious key-up if we treated this
991 // command-key combo as a host UI action
992 if (!isMouseGrabbed && ([event modifierFlags] & NSEventModifierFlagCommand)) {
996 if (qemu_console_is_graphic(NULL)) {
997 qkbd_state_key_event(kbd, keycode, false);
1000 case NSEventTypeMouseMoved:
1001 if (isAbsoluteEnabled) {
1002 // Cursor re-entered into a window might generate events bound to screen coordinates
1003 // and `nil` window property, and in full screen mode, current window might not be
1004 // key window, where event location alone should suffice.
1005 if (![self screenContainsPoint:p] || !([[self window] isKeyWindow] || isFullscreen)) {
1006 if (isMouseGrabbed) {
1010 if (!isMouseGrabbed) {
1017 case NSEventTypeLeftMouseDown:
1018 buttons |= MOUSE_EVENT_LBUTTON;
1021 case NSEventTypeRightMouseDown:
1022 buttons |= MOUSE_EVENT_RBUTTON;
1025 case NSEventTypeOtherMouseDown:
1026 buttons |= MOUSE_EVENT_MBUTTON;
1029 case NSEventTypeLeftMouseDragged:
1030 buttons |= MOUSE_EVENT_LBUTTON;
1033 case NSEventTypeRightMouseDragged:
1034 buttons |= MOUSE_EVENT_RBUTTON;
1037 case NSEventTypeOtherMouseDragged:
1038 buttons |= MOUSE_EVENT_MBUTTON;
1041 case NSEventTypeLeftMouseUp:
1043 if (!isMouseGrabbed && [self screenContainsPoint:p]) {
1045 * In fullscreen mode, the window of cocoaView may not be the
1046 * key window, therefore the position relative to the virtual
1047 * screen alone will be sufficient.
1049 if(isFullscreen || [[self window] isKeyWindow]) {
1054 case NSEventTypeRightMouseUp:
1057 case NSEventTypeOtherMouseUp:
1060 case NSEventTypeScrollWheel:
1062 * Send wheel events to the guest regardless of window focus.
1063 * This is in-line with standard Mac OS X UI behaviour.
1067 * We shouldn't have got a scroll event when deltaY and delta Y
1068 * are zero, hence no harm in dropping the event
1070 if ([event deltaY] != 0 || [event deltaX] != 0) {
1071 /* Determine if this is a scroll up or scroll down event */
1072 if ([event deltaY] != 0) {
1073 buttons = ([event deltaY] > 0) ?
1074 INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1075 } else if ([event deltaX] != 0) {
1076 buttons = ([event deltaX] > 0) ?
1077 INPUT_BUTTON_WHEEL_LEFT : INPUT_BUTTON_WHEEL_RIGHT;
1080 qemu_input_queue_btn(dcl.con, buttons, true);
1081 qemu_input_event_sync();
1082 qemu_input_queue_btn(dcl.con, buttons, false);
1083 qemu_input_event_sync();
1087 * Since deltaX/deltaY also report scroll wheel events we prevent mouse
1088 * movement code from executing.
1090 mouse_event = false;
1097 /* Don't send button events to the guest unless we've got a
1098 * mouse grab or window focus. If we have neither then this event
1099 * is the user clicking on the background window to activate and
1100 * bring us to the front, which will be done by the sendEvent
1101 * call below. We definitely don't want to pass that click through
1104 if ((isMouseGrabbed || [[self window] isKeyWindow]) &&
1105 (last_buttons != buttons)) {
1106 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1107 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1108 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1109 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON
1111 qemu_input_update_buttons(dcl.con, bmap, last_buttons, buttons);
1112 last_buttons = buttons;
1114 if (isMouseGrabbed) {
1115 if (isAbsoluteEnabled) {
1116 /* Note that the origin for Cocoa mouse coords is bottom left, not top left.
1117 * The check on screenContainsPoint is to avoid sending out of range values for
1118 * clicks in the titlebar.
1120 if ([self screenContainsPoint:p]) {
1121 qemu_input_queue_abs(dcl.con, INPUT_AXIS_X, p.x, 0, screen.width);
1122 qemu_input_queue_abs(dcl.con, INPUT_AXIS_Y, screen.height - p.y, 0, screen.height);
1125 qemu_input_queue_rel(dcl.con, INPUT_AXIS_X, (int)[event deltaX]);
1126 qemu_input_queue_rel(dcl.con, INPUT_AXIS_Y, (int)[event deltaY]);
1131 qemu_input_event_sync();
1138 COCOA_DEBUG("QemuCocoaView: grabMouse\n");
1140 if (!isFullscreen) {
1142 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s - (Press " UC_CTRL_KEY " " UC_ALT_KEY " G to release Mouse)", qemu_name]];
1144 [normalWindow setTitle:@"QEMU - (Press " UC_CTRL_KEY " " UC_ALT_KEY " G to release Mouse)"];
1147 CGAssociateMouseAndMouseCursorPosition(isAbsoluteEnabled);
1148 isMouseGrabbed = TRUE; // while isMouseGrabbed = TRUE, QemuCocoaApp sends all events to [cocoaView handleEvent:]
1151 - (void) ungrabMouse
1153 COCOA_DEBUG("QemuCocoaView: ungrabMouse\n");
1155 if (!isFullscreen) {
1157 [normalWindow setTitle:[NSString stringWithFormat:@"QEMU %s", qemu_name]];
1159 [normalWindow setTitle:@"QEMU"];
1161 [self unhideCursor];
1162 CGAssociateMouseAndMouseCursorPosition(TRUE);
1163 isMouseGrabbed = FALSE;
1166 - (void) setAbsoluteEnabled:(BOOL)tIsAbsoluteEnabled {
1167 isAbsoluteEnabled = tIsAbsoluteEnabled;
1168 if (isMouseGrabbed) {
1169 CGAssociateMouseAndMouseCursorPosition(isAbsoluteEnabled);
1172 - (BOOL) isMouseGrabbed {return isMouseGrabbed;}
1173 - (BOOL) isAbsoluteEnabled {return isAbsoluteEnabled;}
1174 - (float) cdx {return cdx;}
1175 - (float) cdy {return cdy;}
1176 - (QEMUScreen) gscreen {return screen;}
1179 * Makes the target think all down keys are being released.
1180 * This prevents a stuck key problem, since we will not see
1181 * key up events for those keys after we have lost focus.
1183 - (void) raiseAllKeys
1185 with_iothread_lock(^{
1186 qkbd_state_lift_all_keys(kbd);
1194 ------------------------------------------------------
1195 QemuCocoaAppController
1196 ------------------------------------------------------
1198 @interface QemuCocoaAppController : NSObject
1199 <NSWindowDelegate, NSApplicationDelegate>
1202 - (void)doToggleFullScreen:(id)sender;
1203 - (void)toggleFullScreen:(id)sender;
1204 - (void)showQEMUDoc:(id)sender;
1205 - (void)zoomToFit:(id) sender;
1206 - (void)displayConsole:(id)sender;
1207 - (void)pauseQEMU:(id)sender;
1208 - (void)resumeQEMU:(id)sender;
1209 - (void)displayPause;
1210 - (void)removePause;
1211 - (void)restartQEMU:(id)sender;
1212 - (void)powerDownQEMU:(id)sender;
1213 - (void)ejectDeviceMedia:(id)sender;
1214 - (void)changeDeviceMedia:(id)sender;
1216 - (void)openDocumentation:(NSString *)filename;
1217 - (IBAction) do_about_menu_item: (id) sender;
1218 - (void)adjustSpeed:(id)sender;
1221 @implementation QemuCocoaAppController
1224 COCOA_DEBUG("QemuCocoaAppController: init\n");
1226 self = [super init];
1229 // create a view and add it to the window
1230 cocoaView = [[QemuCocoaView alloc] initWithFrame:NSMakeRect(0.0, 0.0, 640.0, 480.0)];
1232 error_report("(cocoa) can't create a view");
1237 normalWindow = [[NSWindow alloc] initWithContentRect:[cocoaView frame]
1238 styleMask:NSWindowStyleMaskTitled|NSWindowStyleMaskMiniaturizable|NSWindowStyleMaskClosable
1239 backing:NSBackingStoreBuffered defer:NO];
1241 error_report("(cocoa) can't create window");
1244 [normalWindow setAcceptsMouseMovedEvents:YES];
1245 [normalWindow setTitle:@"QEMU"];
1246 [normalWindow setContentView:cocoaView];
1247 [normalWindow makeKeyAndOrderFront:self];
1248 [normalWindow center];
1249 [normalWindow setDelegate: self];
1250 stretch_video = false;
1252 /* Used for displaying pause on the screen */
1253 pauseLabel = [NSTextField new];
1254 [pauseLabel setBezeled:YES];
1255 [pauseLabel setDrawsBackground:YES];
1256 [pauseLabel setBackgroundColor: [NSColor whiteColor]];
1257 [pauseLabel setEditable:NO];
1258 [pauseLabel setSelectable:NO];
1259 [pauseLabel setStringValue: @"Paused"];
1260 [pauseLabel setFont: [NSFont fontWithName: @"Helvetica" size: 90]];
1261 [pauseLabel setTextColor: [NSColor blackColor]];
1262 [pauseLabel sizeToFit];
1269 COCOA_DEBUG("QemuCocoaAppController: dealloc\n");
1272 [cocoaView release];
1276 - (void)applicationDidFinishLaunching: (NSNotification *) note
1278 COCOA_DEBUG("QemuCocoaAppController: applicationDidFinishLaunching\n");
1279 allow_events = true;
1282 - (void)applicationWillTerminate:(NSNotification *)aNotification
1284 COCOA_DEBUG("QemuCocoaAppController: applicationWillTerminate\n");
1286 with_iothread_lock(^{
1287 shutdown_action = SHUTDOWN_ACTION_POWEROFF;
1288 qemu_system_shutdown_request(SHUTDOWN_CAUSE_HOST_UI);
1292 * Sleep here, because returning will cause OSX to kill us
1293 * immediately; the QEMU main loop will handle the shutdown
1294 * request and terminate the process.
1296 [NSThread sleepForTimeInterval:INFINITY];
1299 - (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication
1304 - (NSApplicationTerminateReply)applicationShouldTerminate:
1305 (NSApplication *)sender
1307 COCOA_DEBUG("QemuCocoaAppController: applicationShouldTerminate\n");
1308 return [self verifyQuit];
1311 - (void)windowDidChangeScreen:(NSNotification *)notification
1313 [cocoaView updateUIInfo];
1316 - (void)windowDidResize:(NSNotification *)notification
1318 [cocoaView updateUIInfo];
1321 /* Called when the user clicks on a window's close button */
1322 - (BOOL)windowShouldClose:(id)sender
1324 COCOA_DEBUG("QemuCocoaAppController: windowShouldClose\n");
1325 [NSApp terminate: sender];
1326 /* If the user allows the application to quit then the call to
1327 * NSApp terminate will never return. If we get here then the user
1328 * cancelled the quit, so we should return NO to not permit the
1329 * closing of this window.
1335 * Called when QEMU goes into the background. Note that
1336 * [-NSWindowDelegate windowDidResignKey:] is used here instead of
1337 * [-NSApplicationDelegate applicationWillResignActive:] because it cannot
1338 * detect that the window loses focus when the deck is clicked on macOS 13.2.1.
1340 - (void) windowDidResignKey: (NSNotification *)aNotification
1342 COCOA_DEBUG("%s\n", __func__);
1343 [cocoaView ungrabMouse];
1344 [cocoaView raiseAllKeys];
1347 /* We abstract the method called by the Enter Fullscreen menu item
1348 * because Mac OS 10.7 and higher disables it. This is because of the
1349 * menu item's old selector's name toggleFullScreen:
1351 - (void) doToggleFullScreen:(id)sender
1353 [self toggleFullScreen:(id)sender];
1356 - (void)toggleFullScreen:(id)sender
1358 COCOA_DEBUG("QemuCocoaAppController: toggleFullScreen\n");
1360 [cocoaView toggleFullScreen:sender];
1363 - (void) setFullGrab:(id)sender
1365 COCOA_DEBUG("QemuCocoaAppController: setFullGrab\n");
1367 [cocoaView setFullGrab:sender];
1370 /* Tries to find then open the specified filename */
1371 - (void) openDocumentation: (NSString *) filename
1373 /* Where to look for local files */
1374 NSString *path_array[] = {@"../share/doc/qemu/", @"../doc/qemu/", @"docs/"};
1375 NSString *full_file_path;
1376 NSURL *full_file_url;
1378 /* iterate thru the possible paths until the file is found */
1380 for (index = 0; index < ARRAY_SIZE(path_array); index++) {
1381 full_file_path = [[NSBundle mainBundle] executablePath];
1382 full_file_path = [full_file_path stringByDeletingLastPathComponent];
1383 full_file_path = [NSString stringWithFormat: @"%@/%@%@", full_file_path,
1384 path_array[index], filename];
1385 full_file_url = [NSURL fileURLWithPath: full_file_path
1386 isDirectory: false];
1387 if ([[NSWorkspace sharedWorkspace] openURL: full_file_url] == YES) {
1392 /* If none of the paths opened a file */
1394 QEMU_Alert(@"Failed to open file");
1397 - (void)showQEMUDoc:(id)sender
1399 COCOA_DEBUG("QemuCocoaAppController: showQEMUDoc\n");
1401 [self openDocumentation: @"index.html"];
1404 /* Stretches video to fit host monitor size */
1405 - (void)zoomToFit:(id) sender
1407 stretch_video = !stretch_video;
1408 if (stretch_video == true) {
1409 [sender setState: NSControlStateValueOn];
1411 [sender setState: NSControlStateValueOff];
1415 /* Displays the console on the screen */
1416 - (void)displayConsole:(id)sender
1418 console_select([sender tag]);
1421 /* Pause the guest */
1422 - (void)pauseQEMU:(id)sender
1424 with_iothread_lock(^{
1427 [sender setEnabled: NO];
1428 [[[sender menu] itemWithTitle: @"Resume"] setEnabled: YES];
1429 [self displayPause];
1432 /* Resume running the guest operating system */
1433 - (void)resumeQEMU:(id) sender
1435 with_iothread_lock(^{
1438 [sender setEnabled: NO];
1439 [[[sender menu] itemWithTitle: @"Pause"] setEnabled: YES];
1443 /* Displays the word pause on the screen */
1444 - (void)displayPause
1446 /* Coordinates have to be calculated each time because the window can change its size */
1447 int xCoord, yCoord, width, height;
1448 xCoord = ([normalWindow frame].size.width - [pauseLabel frame].size.width)/2;
1449 yCoord = [normalWindow frame].size.height - [pauseLabel frame].size.height - ([pauseLabel frame].size.height * .5);
1450 width = [pauseLabel frame].size.width;
1451 height = [pauseLabel frame].size.height;
1452 [pauseLabel setFrame: NSMakeRect(xCoord, yCoord, width, height)];
1453 [cocoaView addSubview: pauseLabel];
1456 /* Removes the word pause from the screen */
1459 [pauseLabel removeFromSuperview];
1463 - (void)restartQEMU:(id)sender
1465 with_iothread_lock(^{
1466 qmp_system_reset(NULL);
1470 /* Powers down QEMU */
1471 - (void)powerDownQEMU:(id)sender
1473 with_iothread_lock(^{
1474 qmp_system_powerdown(NULL);
1478 /* Ejects the media.
1479 * Uses sender's tag to figure out the device to eject.
1481 - (void)ejectDeviceMedia:(id)sender
1484 drive = [sender representedObject];
1487 QEMU_Alert(@"Failed to find drive to eject!");
1491 __block Error *err = NULL;
1492 with_iothread_lock(^{
1493 qmp_eject([drive cStringUsingEncoding: NSASCIIStringEncoding],
1494 NULL, false, false, &err);
1496 handleAnyDeviceErrors(err);
1499 /* Displays a dialog box asking the user to select an image file to load.
1500 * Uses sender's represented object value to figure out which drive to use.
1502 - (void)changeDeviceMedia:(id)sender
1504 /* Find the drive name */
1506 drive = [sender representedObject];
1509 QEMU_Alert(@"Could not find drive!");
1513 /* Display the file open dialog */
1514 NSOpenPanel * openPanel;
1515 openPanel = [NSOpenPanel openPanel];
1516 [openPanel setCanChooseFiles: YES];
1517 [openPanel setAllowsMultipleSelection: NO];
1518 if([openPanel runModal] == NSModalResponseOK) {
1519 NSString * file = [[[openPanel URLs] objectAtIndex: 0] path];
1522 QEMU_Alert(@"Failed to convert URL to file path!");
1526 __block Error *err = NULL;
1527 with_iothread_lock(^{
1528 qmp_blockdev_change_medium([drive cStringUsingEncoding:
1529 NSASCIIStringEncoding],
1531 [file cStringUsingEncoding:
1532 NSASCIIStringEncoding],
1538 handleAnyDeviceErrors(err);
1542 /* Verifies if the user really wants to quit */
1545 NSAlert *alert = [NSAlert new];
1546 [alert autorelease];
1547 [alert setMessageText: @"Are you sure you want to quit QEMU?"];
1548 [alert addButtonWithTitle: @"Cancel"];
1549 [alert addButtonWithTitle: @"Quit"];
1550 if([alert runModal] == NSAlertSecondButtonReturn) {
1557 /* The action method for the About menu item */
1558 - (IBAction) do_about_menu_item: (id) sender
1560 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
1561 char *icon_path_c = get_relocated_path(CONFIG_QEMU_ICONDIR "/hicolor/512x512/apps/qemu.png");
1562 NSString *icon_path = [NSString stringWithUTF8String:icon_path_c];
1563 g_free(icon_path_c);
1564 NSImage *icon = [[NSImage alloc] initWithContentsOfFile:icon_path];
1565 NSString *version = @"QEMU emulator version " QEMU_FULL_VERSION;
1566 NSString *copyright = @QEMU_COPYRIGHT;
1567 NSDictionary *options;
1570 NSAboutPanelOptionApplicationIcon : icon,
1571 NSAboutPanelOptionApplicationVersion : version,
1572 @"Copyright" : copyright,
1577 NSAboutPanelOptionApplicationVersion : version,
1578 @"Copyright" : copyright,
1581 [NSApp orderFrontStandardAboutPanelWithOptions:options];
1585 /* Used by the Speed menu items */
1586 - (void)adjustSpeed:(id)sender
1588 int throttle_pct; /* throttle percentage */
1591 menu = [sender menu];
1594 /* Unselect the currently selected item */
1595 for (NSMenuItem *item in [menu itemArray]) {
1596 if (item.state == NSControlStateValueOn) {
1597 [item setState: NSControlStateValueOff];
1603 // check the menu item
1604 [sender setState: NSControlStateValueOn];
1606 // get the throttle percentage
1607 throttle_pct = [sender tag];
1609 with_iothread_lock(^{
1610 cpu_throttle_set(throttle_pct);
1612 COCOA_DEBUG("cpu throttling at %d%c\n", cpu_throttle_get_percentage(), '%');
1617 @interface QemuApplication : NSApplication
1620 @implementation QemuApplication
1621 - (void)sendEvent:(NSEvent *)event
1623 COCOA_DEBUG("QemuApplication: sendEvent\n");
1624 if (![cocoaView handleEvent:event]) {
1625 [super sendEvent: event];
1630 static void create_initial_menus(void)
1634 NSMenuItem *menuItem;
1636 [NSApp setMainMenu:[[NSMenu alloc] init]];
1637 [NSApp setServicesMenu:[[NSMenu alloc] initWithTitle:@"Services"]];
1640 menu = [[NSMenu alloc] initWithTitle:@""];
1641 [menu addItemWithTitle:@"About QEMU" action:@selector(do_about_menu_item:) keyEquivalent:@""]; // About QEMU
1642 [menu addItem:[NSMenuItem separatorItem]]; //Separator
1643 menuItem = [menu addItemWithTitle:@"Services" action:nil keyEquivalent:@""];
1644 [menuItem setSubmenu:[NSApp servicesMenu]];
1645 [menu addItem:[NSMenuItem separatorItem]];
1646 [menu addItemWithTitle:@"Hide QEMU" action:@selector(hide:) keyEquivalent:@"h"]; //Hide QEMU
1647 menuItem = (NSMenuItem *)[menu addItemWithTitle:@"Hide Others" action:@selector(hideOtherApplications:) keyEquivalent:@"h"]; // Hide Others
1648 [menuItem setKeyEquivalentModifierMask:(NSEventModifierFlagOption|NSEventModifierFlagCommand)];
1649 [menu addItemWithTitle:@"Show All" action:@selector(unhideAllApplications:) keyEquivalent:@""]; // Show All
1650 [menu addItem:[NSMenuItem separatorItem]]; //Separator
1651 [menu addItemWithTitle:@"Quit QEMU" action:@selector(terminate:) keyEquivalent:@"q"];
1652 menuItem = [[NSMenuItem alloc] initWithTitle:@"Apple" action:nil keyEquivalent:@""];
1653 [menuItem setSubmenu:menu];
1654 [[NSApp mainMenu] addItem:menuItem];
1655 [NSApp performSelector:@selector(setAppleMenu:) withObject:menu]; // Workaround (this method is private since 10.4+)
1658 menu = [[NSMenu alloc] initWithTitle: @"Machine"];
1659 [menu setAutoenablesItems: NO];
1660 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Pause" action: @selector(pauseQEMU:) keyEquivalent: @""] autorelease]];
1661 menuItem = [[[NSMenuItem alloc] initWithTitle: @"Resume" action: @selector(resumeQEMU:) keyEquivalent: @""] autorelease];
1662 [menu addItem: menuItem];
1663 [menuItem setEnabled: NO];
1664 [menu addItem: [NSMenuItem separatorItem]];
1665 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Reset" action: @selector(restartQEMU:) keyEquivalent: @""] autorelease]];
1666 [menu addItem: [[[NSMenuItem alloc] initWithTitle: @"Power Down" action: @selector(powerDownQEMU:) keyEquivalent: @""] autorelease]];
1667 menuItem = [[[NSMenuItem alloc] initWithTitle: @"Machine" action:nil keyEquivalent:@""] autorelease];
1668 [menuItem setSubmenu:menu];
1669 [[NSApp mainMenu] addItem:menuItem];
1672 menu = [[NSMenu alloc] initWithTitle:@"View"];
1673 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Enter Fullscreen" action:@selector(doToggleFullScreen:) keyEquivalent:@"f"] autorelease]]; // Fullscreen
1674 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Zoom To Fit" action:@selector(zoomToFit:) keyEquivalent:@""] autorelease]];
1675 menuItem = [[[NSMenuItem alloc] initWithTitle:@"View" action:nil keyEquivalent:@""] autorelease];
1676 [menuItem setSubmenu:menu];
1677 [[NSApp mainMenu] addItem:menuItem];
1680 menu = [[NSMenu alloc] initWithTitle:@"Speed"];
1682 // Add the rest of the Speed menu items
1683 int p, percentage, throttle_pct;
1684 for (p = 10; p >= 0; p--)
1686 percentage = p * 10 > 1 ? p * 10 : 1; // prevent a 0% menu item
1688 menuItem = [[[NSMenuItem alloc]
1689 initWithTitle: [NSString stringWithFormat: @"%d%%", percentage] action:@selector(adjustSpeed:) keyEquivalent:@""] autorelease];
1691 if (percentage == 100) {
1692 [menuItem setState: NSControlStateValueOn];
1695 /* Calculate the throttle percentage */
1696 throttle_pct = -1 * percentage + 100;
1698 [menuItem setTag: throttle_pct];
1699 [menu addItem: menuItem];
1701 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Speed" action:nil keyEquivalent:@""] autorelease];
1702 [menuItem setSubmenu:menu];
1703 [[NSApp mainMenu] addItem:menuItem];
1706 menu = [[NSMenu alloc] initWithTitle:@"Window"];
1707 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"Minimize" action:@selector(performMiniaturize:) keyEquivalent:@"m"] autorelease]]; // Miniaturize
1708 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""] autorelease];
1709 [menuItem setSubmenu:menu];
1710 [[NSApp mainMenu] addItem:menuItem];
1711 [NSApp setWindowsMenu:menu];
1714 menu = [[NSMenu alloc] initWithTitle:@"Help"];
1715 [menu addItem: [[[NSMenuItem alloc] initWithTitle:@"QEMU Documentation" action:@selector(showQEMUDoc:) keyEquivalent:@"?"] autorelease]]; // QEMU Help
1716 menuItem = [[[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""] autorelease];
1717 [menuItem setSubmenu:menu];
1718 [[NSApp mainMenu] addItem:menuItem];
1721 /* Returns a name for a given console */
1722 static NSString * getConsoleName(QemuConsole * console)
1724 g_autofree char *label = qemu_console_get_label(console);
1726 return [NSString stringWithUTF8String:label];
1729 /* Add an entry to the View menu for each console */
1730 static void add_console_menu_entries(void)
1733 NSMenuItem *menuItem;
1736 menu = [[[NSApp mainMenu] itemWithTitle:@"View"] submenu];
1738 [menu addItem:[NSMenuItem separatorItem]];
1740 while (qemu_console_lookup_by_index(index) != NULL) {
1741 menuItem = [[[NSMenuItem alloc] initWithTitle: getConsoleName(qemu_console_lookup_by_index(index))
1742 action: @selector(displayConsole:) keyEquivalent: @""] autorelease];
1743 [menuItem setTag: index];
1744 [menu addItem: menuItem];
1749 /* Make menu items for all removable devices.
1750 * Each device is given an 'Eject' and 'Change' menu item.
1752 static void addRemovableDevicesMenuItems(void)
1755 NSMenuItem *menuItem;
1756 BlockInfoList *currentDevice, *pointerToFree;
1757 NSString *deviceName;
1759 currentDevice = qmp_query_block(NULL);
1760 pointerToFree = currentDevice;
1762 menu = [[[NSApp mainMenu] itemWithTitle:@"Machine"] submenu];
1764 // Add a separator between related groups of menu items
1765 [menu addItem:[NSMenuItem separatorItem]];
1767 // Set the attributes to the "Removable Media" menu item
1768 NSString *titleString = @"Removable Media";
1769 NSMutableAttributedString *attString=[[NSMutableAttributedString alloc] initWithString:titleString];
1770 NSColor *newColor = [NSColor blackColor];
1771 NSFontManager *fontManager = [NSFontManager sharedFontManager];
1772 NSFont *font = [fontManager fontWithFamily:@"Helvetica"
1773 traits:NSBoldFontMask|NSItalicFontMask
1776 [attString addAttribute:NSFontAttributeName value:font range:NSMakeRange(0, [titleString length])];
1777 [attString addAttribute:NSForegroundColorAttributeName value:newColor range:NSMakeRange(0, [titleString length])];
1778 [attString addAttribute:NSUnderlineStyleAttributeName value:[NSNumber numberWithInt: 1] range:NSMakeRange(0, [titleString length])];
1780 // Add the "Removable Media" menu item
1781 menuItem = [NSMenuItem new];
1782 [menuItem setAttributedTitle: attString];
1783 [menuItem setEnabled: NO];
1784 [menu addItem: menuItem];
1786 /* Loop through all the block devices in the emulator */
1787 while (currentDevice) {
1788 deviceName = [[NSString stringWithFormat: @"%s", currentDevice->value->device] retain];
1790 if(currentDevice->value->removable) {
1791 menuItem = [[NSMenuItem alloc] initWithTitle: [NSString stringWithFormat: @"Change %s...", currentDevice->value->device]
1792 action: @selector(changeDeviceMedia:)
1793 keyEquivalent: @""];
1794 [menu addItem: menuItem];
1795 [menuItem setRepresentedObject: deviceName];
1796 [menuItem autorelease];
1798 menuItem = [[NSMenuItem alloc] initWithTitle: [NSString stringWithFormat: @"Eject %s", currentDevice->value->device]
1799 action: @selector(ejectDeviceMedia:)
1800 keyEquivalent: @""];
1801 [menu addItem: menuItem];
1802 [menuItem setRepresentedObject: deviceName];
1803 [menuItem autorelease];
1805 currentDevice = currentDevice->next;
1807 qapi_free_BlockInfoList(pointerToFree);
1810 @interface QemuCocoaPasteboardTypeOwner : NSObject<NSPasteboardTypeOwner>
1813 @implementation QemuCocoaPasteboardTypeOwner
1815 - (void)pasteboard:(NSPasteboard *)sender provideDataForType:(NSPasteboardType)type
1817 if (type != NSPasteboardTypeString) {
1821 with_iothread_lock(^{
1822 QemuClipboardInfo *info = qemu_clipboard_info_ref(cbinfo);
1823 qemu_event_reset(&cbevent);
1824 qemu_clipboard_request(info, QEMU_CLIPBOARD_TYPE_TEXT);
1826 while (info == cbinfo &&
1827 info->types[QEMU_CLIPBOARD_TYPE_TEXT].available &&
1828 info->types[QEMU_CLIPBOARD_TYPE_TEXT].data == NULL) {
1829 qemu_mutex_unlock_iothread();
1830 qemu_event_wait(&cbevent);
1831 qemu_mutex_lock_iothread();
1834 if (info == cbinfo) {
1835 NSData *data = [[NSData alloc] initWithBytes:info->types[QEMU_CLIPBOARD_TYPE_TEXT].data
1836 length:info->types[QEMU_CLIPBOARD_TYPE_TEXT].size];
1837 [sender setData:data forType:NSPasteboardTypeString];
1841 qemu_clipboard_info_unref(info);
1847 static QemuCocoaPasteboardTypeOwner *cbowner;
1849 static void cocoa_clipboard_notify(Notifier *notifier, void *data);
1850 static void cocoa_clipboard_request(QemuClipboardInfo *info,
1851 QemuClipboardType type);
1853 static QemuClipboardPeer cbpeer = {
1855 .notifier = { .notify = cocoa_clipboard_notify },
1856 .request = cocoa_clipboard_request
1859 static void cocoa_clipboard_update_info(QemuClipboardInfo *info)
1861 if (info->owner == &cbpeer || info->selection != QEMU_CLIPBOARD_SELECTION_CLIPBOARD) {
1865 if (info != cbinfo) {
1866 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
1867 qemu_clipboard_info_unref(cbinfo);
1868 cbinfo = qemu_clipboard_info_ref(info);
1869 cbchangecount = [[NSPasteboard generalPasteboard] declareTypes:@[NSPasteboardTypeString] owner:cbowner];
1873 qemu_event_set(&cbevent);
1876 static void cocoa_clipboard_notify(Notifier *notifier, void *data)
1878 QemuClipboardNotify *notify = data;
1880 switch (notify->type) {
1881 case QEMU_CLIPBOARD_UPDATE_INFO:
1882 cocoa_clipboard_update_info(notify->info);
1884 case QEMU_CLIPBOARD_RESET_SERIAL:
1890 static void cocoa_clipboard_request(QemuClipboardInfo *info,
1891 QemuClipboardType type)
1893 NSAutoreleasePool *pool;
1897 case QEMU_CLIPBOARD_TYPE_TEXT:
1898 pool = [[NSAutoreleasePool alloc] init];
1899 text = [[NSPasteboard generalPasteboard] dataForType:NSPasteboardTypeString];
1901 qemu_clipboard_set_data(&cbpeer, info, type,
1902 [text length], [text bytes], true);
1912 * The startup process for the OSX/Cocoa UI is complicated, because
1913 * OSX insists that the UI runs on the initial main thread, and so we
1914 * need to start a second thread which runs the qemu_default_main():
1916 * in cocoa_display_init():
1917 * assign cocoa_main to qemu_main
1918 * create application, menus, etc
1920 * create qemu-main thread
1921 * enter OSX run loop
1924 static void *call_qemu_main(void *opaque)
1928 COCOA_DEBUG("Second thread: calling qemu_default_main()\n");
1929 qemu_mutex_lock_iothread();
1930 status = qemu_default_main();
1931 qemu_mutex_unlock_iothread();
1932 COCOA_DEBUG("Second thread: qemu_default_main() returned, exiting\n");
1937 static int cocoa_main(void)
1941 COCOA_DEBUG("Entered %s()\n", __func__);
1943 qemu_mutex_unlock_iothread();
1944 qemu_thread_create(&thread, "qemu_main", call_qemu_main,
1945 NULL, QEMU_THREAD_DETACHED);
1947 // Start the main event loop
1948 COCOA_DEBUG("Main thread: entering OSX run loop\n");
1950 COCOA_DEBUG("Main thread: left OSX run loop, which should never happen\n");
1958 static void cocoa_update(DisplayChangeListener *dcl,
1959 int x, int y, int w, int h)
1961 COCOA_DEBUG("qemu_cocoa: cocoa_update\n");
1963 dispatch_async(dispatch_get_main_queue(), ^{
1965 if ([cocoaView cdx] == 1.0) {
1966 rect = NSMakeRect(x, [cocoaView gscreen].height - y - h, w, h);
1969 x * [cocoaView cdx],
1970 ([cocoaView gscreen].height - y - h) * [cocoaView cdy],
1971 w * [cocoaView cdx],
1972 h * [cocoaView cdy]);
1974 [cocoaView setNeedsDisplayInRect:rect];
1978 static void cocoa_switch(DisplayChangeListener *dcl,
1979 DisplaySurface *surface)
1981 pixman_image_t *image = surface->image;
1983 COCOA_DEBUG("qemu_cocoa: cocoa_switch\n");
1985 // The DisplaySurface will be freed as soon as this callback returns.
1986 // We take a reference to the underlying pixman image here so it does
1987 // not disappear from under our feet; the switchSurface method will
1988 // deref the old image when it is done with it.
1989 pixman_image_ref(image);
1991 dispatch_async(dispatch_get_main_queue(), ^{
1992 [cocoaView updateUIInfo];
1993 [cocoaView switchSurface:image];
1997 static void cocoa_refresh(DisplayChangeListener *dcl)
1999 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
2001 COCOA_DEBUG("qemu_cocoa: cocoa_refresh\n");
2002 graphic_hw_update(NULL);
2004 if (qemu_input_is_absolute()) {
2005 dispatch_async(dispatch_get_main_queue(), ^{
2006 if (![cocoaView isAbsoluteEnabled]) {
2007 if ([cocoaView isMouseGrabbed]) {
2008 [cocoaView ungrabMouse];
2011 [cocoaView setAbsoluteEnabled:YES];
2015 if (cbchangecount != [[NSPasteboard generalPasteboard] changeCount]) {
2016 qemu_clipboard_info_unref(cbinfo);
2017 cbinfo = qemu_clipboard_info_new(&cbpeer, QEMU_CLIPBOARD_SELECTION_CLIPBOARD);
2018 if ([[NSPasteboard generalPasteboard] availableTypeFromArray:@[NSPasteboardTypeString]]) {
2019 cbinfo->types[QEMU_CLIPBOARD_TYPE_TEXT].available = true;
2021 qemu_clipboard_update(cbinfo);
2022 cbchangecount = [[NSPasteboard generalPasteboard] changeCount];
2023 qemu_event_set(&cbevent);
2029 static void cocoa_display_init(DisplayState *ds, DisplayOptions *opts)
2031 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
2033 COCOA_DEBUG("qemu_cocoa: cocoa_display_init\n");
2035 qemu_main = cocoa_main;
2037 // Pull this console process up to being a fully-fledged graphical
2038 // app with a menubar and Dock icon
2039 ProcessSerialNumber psn = { 0, kCurrentProcess };
2040 TransformProcessType(&psn, kProcessTransformToForegroundApplication);
2042 [QemuApplication sharedApplication];
2044 create_initial_menus();
2047 * Create the menu entries which depend on QEMU state (for consoles
2048 * and removeable devices). These make calls back into QEMU functions,
2049 * which is OK because at this point we know that the second thread
2050 * holds the iothread lock and is synchronously waiting for us to
2053 add_console_menu_entries();
2054 addRemovableDevicesMenuItems();
2056 // Create an Application controller
2057 QemuCocoaAppController *controller = [[QemuCocoaAppController alloc] init];
2058 [NSApp setDelegate:controller];
2060 /* if fullscreen mode is to be used */
2061 if (opts->has_full_screen && opts->full_screen) {
2062 [NSApp activateIgnoringOtherApps: YES];
2063 [controller toggleFullScreen: nil];
2065 if (opts->u.cocoa.has_full_grab && opts->u.cocoa.full_grab) {
2066 [controller setFullGrab: nil];
2069 if (opts->has_show_cursor && opts->show_cursor) {
2072 if (opts->u.cocoa.has_swap_opt_cmd) {
2073 swap_opt_cmd = opts->u.cocoa.swap_opt_cmd;
2076 if (opts->u.cocoa.has_left_command_key && !opts->u.cocoa.left_command_key) {
2077 left_command_key_enabled = 0;
2080 // register vga output callbacks
2081 register_displaychangelistener(&dcl);
2083 qemu_event_init(&cbevent, false);
2084 cbowner = [[QemuCocoaPasteboardTypeOwner alloc] init];
2085 qemu_clipboard_peer_register(&cbpeer);
2090 static QemuDisplay qemu_display_cocoa = {
2091 .type = DISPLAY_TYPE_COCOA,
2092 .init = cocoa_display_init,
2095 static void register_cocoa(void)
2097 qemu_display_register(&qemu_display_cocoa);
2100 type_init(register_cocoa);