gui_osx.c

Go to the documentation of this file.

/* Part of the Xemu project, please visit: https://github.com/lgblgblgb/xemu
   ~/xemu/gui/gui_osx.c: UI implementation for MacOS of Xemu's UI abstraction layer
   Copyright (C)2020 Hernán Di Pietro <hernan.di.pietro@gmail.com>
   Copyright (C)2016-2022 LGB (Gábor Lénárt) <lgblgblgb@gmail.com>
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
 
#include <objc/objc-runtime.h>
#include <CoreGraphics/CGBase.h>
#include <CoreGraphics/CGGeometry.h>
 
typedef CGPoint NSPoint;
 
static id auto_release_pool;
static id application;
 
static const unsigned long NSFileHandlingPanelOKButton = 1;
static const unsigned long NSFileHandlingPanelCancelButton = 0;
 
#ifndef GUI_HAS_POPUP
#define GUI_HAS_POPUP
#endif
 
// (!)
// New Apple SDKs objc_msgSend prototype changed to *force* callers
// to cast to proper types!. So this is ugly and verbose, but works.
 
static void _xemumacgui_menu_action_handler ( id self, SEL selector, id sender )
{
        id menu_obj =  ((id (*) (id, SEL)) objc_msgSend)(sender, sel_registerName("representedObject"));
        const struct menu_st* menu_item = (const struct menu_st*) ((id (*) (id, SEL)) objc_msgSend)(menu_obj, sel_registerName("pointerValue"));
        if (menu_item && ((menu_item->type & 0xFF) == XEMUGUI_MENUID_CALLABLE)) {
                DEBUGPRINT("GUI: menu point \"%s\" has been activated." NL,  menu_item->name);
                ((xemugui_callback_t)(menu_item->handler))(menu_item, NULL);
        } else {
                DEBUGPRINT("GUI: menu point is NOT activated in action handler! menu_item=%p menu_item->type=%d" NL, menu_item, menu_item ? menu_item->type : -1 );
        }
}
 
 
// TODO: separator line after menu item, checked/unchecked status for menu items
static id _xemumacgui_r_menu_builder ( const struct menu_st desc[], const char *parent_name )
{
        id menu_item, menu_state;
        id ui_menu = ((id (*) (Class, SEL)) objc_msgSend)(objc_getClass("NSMenu"), sel_registerName("new"));
        ((void (*) (id, SEL)) objc_msgSend)(ui_menu, sel_registerName("autorelease"));
        for (int a = 0; desc[a].name; a++) {
                int type = desc[a].type;
                // Some sanity checks:
                if (
                        ((type & 0xFF) != XEMUGUI_MENUID_SUBMENU && !desc[a].handler) ||
                        ((type & 0xFF) == XEMUGUI_MENUID_SUBMENU && (desc[a].handler  || !desc[a].user_data)) ||
                        !desc[a].name || (
                                (type & 0xFF) != XEMUGUI_MENUID_SUBMENU &&
                                (type & 0xFF) != XEMUGUI_MENUID_CALLABLE
                        )
                ) {
                        DEBUGPRINT("GUI: invalid menu entry found, skipping it (item #%d of menu \"%s\")" NL, a, parent_name);
                        continue;
                }
                // Queryback feature, markes entries are called on menu-build time to be able to modify themselves dynamically (ie, on/off options depending current state)
                if ((type & 0xFF) == XEMUGUI_MENUID_CALLABLE && (type & XEMUGUI_MENUFLAG_QUERYBACK)) {
                        DEBUGGUI("GUI: query-back for \"%s\"" NL, desc[a].name);
                        ((xemugui_callback_t)(desc[a].handler))(&desc[a], &type);
                }
                if ((type & XEMUGUI_MENUFLAG_HIDDEN))
                        continue;
                if (type & XEMUGUI_MENUFLAG_SEPARATOR) {
                        menu_item = ((id (*) (Class, SEL)) objc_msgSend)(objc_getClass("NSMenuItem"), sel_registerName("separatorItem"));
                } else {
                        menu_item = ((id (*) (Class, SEL)) objc_msgSend)(objc_getClass("NSMenuItem"), sel_registerName("alloc"));
                        ((void (*) (id, SEL)) objc_msgSend)(menu_item, sel_registerName("autorelease"));
                        id str_name = ((id (*) (Class, SEL, const char*)) objc_msgSend)(
                                objc_getClass("NSString"),
                                sel_registerName("stringWithUTF8String:"),
                                desc[a].name
                        );
                        id str_key =  ((id (*) (Class, SEL, const char*)) objc_msgSend)(
                                objc_getClass("NSString"),
                                sel_registerName("stringWithUTF8String:"),
                                ""
                        );
                        ((void (*) (id, SEL, id, SEL, id))objc_msgSend)(
                                menu_item,
                                sel_registerName("initWithTitle:action:keyEquivalent:"),
                                str_name,
                                sel_registerName("menuActionHandler"),
                                str_key
                        );
                        ((void (*) (id, SEL, BOOL)) objc_msgSend)(menu_item, sel_registerName("setEnabled:"), YES);
                        id menu_object = ((id (*) (Class, SEL, id)) objc_msgSend) (objc_getClass("NSValue"), sel_registerName("valueWithPointer:"),(id) &desc[a]);
                        ((void (*) (id, SEL, id))objc_msgSend)(menu_item, sel_registerName("setRepresentedObject:"), menu_object);
                }
                if (type & XEMUGUI_MENUFLAG_CHECKED) {
                        ((id (*) (id, SEL, int)) objc_msgSend)(menu_item, sel_registerName("setState:"), 1);
                }
                ((void (*) (id, SEL, id))objc_msgSend)(ui_menu, sel_registerName("addItem:"), menu_item);
                if ((type & 0xFF) == XEMUGUI_MENUID_SUBMENU) {
                        // submenus use the user_data as the submenu menu_st struct pointer!
                        id sub_menu = _xemumacgui_r_menu_builder(desc[a].user_data, desc[a].name);
                        ((void (*) (id, SEL, id, id))objc_msgSend)(ui_menu, sel_registerName("setSubmenu:forItem:"), sub_menu, menu_item);
                }
        }
        return ui_menu;
}
 
 
static int xemuosxgui_init ( void )
{
        DEBUGPRINT("GUI: macOS Cocoa initialization" NL);
        auto_release_pool = ((id (*) (Class, SEL)) objc_msgSend)(objc_getClass("NSAutoreleasePool"), sel_registerName("new"));
        application = ((id (*) (Class, SEL)) objc_msgSend)(objc_getClass("NSApplication"), sel_registerName("sharedApplication"));
        id app_delegate = ((id (*) (id, SEL)) objc_msgSend)(application, sel_registerName("delegate"));
        Class xemu_ui_delegate_class = ((Class (*) (id, SEL)) objc_msgSend)(app_delegate, sel_registerName("class"));
        class_addMethod(xemu_ui_delegate_class, sel_registerName("menuActionHandler"), (IMP)_xemumacgui_menu_action_handler, "v@:@");
        return 0;
}
 
 
static int xemuosxgui_popup ( const struct menu_st desc[] )
{
        // If the SDL window is not active, make this right-click to do application activation.
        if ( ! (((id(*)(id,SEL))objc_msgSend) (application, sel_registerName("mainWindow")))) {
                ((void(*)(id,SEL,BOOL))objc_msgSend) (application, sel_registerName("activateIgnoringOtherApps:"), YES);
                return 0;
        }
        id ui_menu = _xemumacgui_r_menu_builder(desc, XEMUGUI_MAINMENU_NAME);
        if (!ui_menu) {
                DEBUGPRINT("GUI: Error building menu" NL);
                return 1;
        }
        NSPoint mouse_location = ((NSPoint (*) (Class, SEL)) objc_msgSend)
                (objc_getClass("NSEvent"), sel_registerName("mouseLocation"));
        ((BOOL (*) (id, SEL, id, NSPoint, id)) objc_msgSend)
                (ui_menu, sel_registerName("popUpMenuPositioningItem:atLocation:inView:"), nil, mouse_location, nil);
        return 0;
}
 
static int xemuosxgui_file_selector ( int dialog_mode, const char *dialog_title, char *default_dir, char *selected, int path_max_size )
{
        char panel_type[12] = { 0 };
        char open_selector[10] = { 0 };
        switch ( dialog_mode & 3 ) {
                case XEMUGUI_FSEL_OPEN:
                        strncpy(panel_type, "NSOpenPanel", sizeof(panel_type));
                        strncpy(open_selector, "openPanel", sizeof(open_selector));
                        break;
                case XEMUGUI_FSEL_SAVE:
                        strncpy(panel_type, "NSSavePanel", sizeof(panel_type));
                        strncpy(open_selector, "savePanel", sizeof(open_selector));
                        break;
                default:
                        FATAL("Invalid mode for UI selector: %d", dialog_mode & 3);
                        return 1;
        }
        *selected = '\0';
        id file_panel = ((id (*) (Class, SEL)) objc_msgSend)(objc_getClass(panel_type), sel_registerName(open_selector));
        ((void (*) (id, SEL)) objc_msgSend)(file_panel, sel_registerName("autorelease"));
        id main_window = ((id (*) (id, SEL)) objc_msgSend)(application, sel_registerName("mainWindow"));
        if ((dialog_mode & 3) == XEMUGUI_FSEL_OPEN) {
                ((void (*) (id, SEL, BOOL)) objc_msgSend)(file_panel, sel_registerName("setCanChooseDirectories:"), NO);
                ((void (*) (id, SEL, BOOL)) objc_msgSend)(file_panel, sel_registerName("setAllowsMultipleSelection:"), NO);
        }
        id dialog_title_str = ((id (*) (Class, SEL, const char*)) objc_msgSend)
                (objc_getClass("NSString"), sel_registerName("stringWithUTF8String:"), dialog_title);
        ((void (*) (id, SEL, id)) objc_msgSend)(file_panel, sel_registerName("setMessage:"), dialog_title_str);
        if (default_dir) {
                id default_dir_str = ((id (*) (Class, SEL, const char*)) objc_msgSend)
                        (objc_getClass("NSString"), sel_registerName("stringWithUTF8String:"), default_dir);
                id dir_url = ((id (*) (Class, SEL, id)) objc_msgSend)(objc_getClass("NSURL"), sel_registerName("fileURLWithPath:"), default_dir_str);
                ((void (*) (id, SEL, id)) objc_msgSend) (file_panel, sel_registerName("directoryURL"), dir_url);
        }
        id panel_result = ((id (*) (id, SEL)) objc_msgSend)(file_panel, sel_registerName("runModal"));
        ((void (*) (id, SEL)) objc_msgSend)(main_window, sel_registerName("makeKeyWindow")); // Ensure focus returns to Xemu window.
        if ((unsigned long)panel_result == NSFileHandlingPanelOKButton) {
                DEBUGPRINT("GUI: macOS panel OK button pressed" NL);
                id filename_url;
                if ((dialog_mode & 3) == XEMUGUI_FSEL_OPEN) {
                        id url_array = ((id (*) (id, SEL)) objc_msgSend)(file_panel, sel_registerName("URLs"));
                        filename_url = ((id (*) (id, SEL, int)) objc_msgSend)(url_array, sel_registerName("objectAtIndex:"), 0);
                } else {
                        filename_url = ((id (*) (id, SEL)) objc_msgSend)(file_panel, sel_registerName("URL"));
                }
                const char* filename = (const char*)((id (*) (id, SEL)) objc_msgSend)(filename_url, sel_registerName("fileSystemRepresentation"));
                strcpy(selected, filename);
                store_dir_from_file_selection(default_dir, filename, dialog_mode);
                return 0;
        }
        return 1;
}
 
 
static const struct xemugui_descriptor_st xemuosxgui_descriptor = {
        .name           = "macos",
        .description    = "MacOS native API Xemu UI implementation",
        .init           = xemuosxgui_init,
        .shutdown       = NULL,
        .iteration      = NULL,
        .file_selector  = xemuosxgui_file_selector,
        .popup          = xemuosxgui_popup,
        .info           = NULL
};