@abide/abide 0.58.0 → 0.100.0

package/src/lib/bundle/native/abideMenu.mm

@@ -1,422 +0,0 @@
-// abide's native macOS shim, compiled into the same dylib as the vendored
-// webview header. The upstream webview library creates a bare NSWindow with no
-// application menu bar, so a non-bundled webview app has no Quit item and the
-// standard Edit shortcuts (Cmd-C/V/X/A/Z) never reach the WKWebView. This
-// installs the conventional menu so the window behaves like a normal Mac app,
-// the built-in File menu (Start / Disconnect), and the bundle's custom menus
-// whose items emit events into the page.
-#import <Cocoa/Cocoa.h>
-#import <WebKit/WebKit.h>
-#import <objc/runtime.h>
-#include <cstdlib>
-#include <cstring>
-
-// webview C entry points, also in this dylib — used to drive the live window.
-extern "C" int webview_navigate(void *w, const char *url);
-extern "C" int webview_eval(void *w, const char *js);
-// Marshals a callback onto the UI thread; the only safe way to touch the window
-// from another thread (the launcher runs its control server off the main thread).
-extern "C" int webview_dispatch(void *w, void (*fn)(void *w, void *arg), void *arg);
-// Returns a backend-native handle for the webview; with kind
-// WEBVIEW_NATIVE_HANDLE_KIND_BROWSER_CONTROLLER (2) that's the WKWebView.
-extern "C" void *webview_get_native_handle(void *w, int kind);
-
-// Exported despite -fvisibility=hidden so abide's FFI layer can resolve it.
-#define ABIDE_EXPORT __attribute__((visibility("default")))
-
-/*
-Process-wide connection flag the menu validation reads. The launcher owns every
-connection transition and flips this via abide_set_connected, so the Server menu
-items enable/disable correctly: menu validation runs each time a menu opens, so
-just storing the bool is enough — no explicit revalidation needed.
-*/
-static int g_abide_connected = 0;
-
-// Roles for the built-in Server menu items, parsed from each item's `role` field.
-// `none` is any non-Server navigate item (always enabled).
-typedef enum {
-    AbideRoleNone = 0,
-    AbideRoleStart,
-    AbideRoleDisconnect,
-} AbideRole;
-
-// Sets the connection flag the Server menu's validateMenuItem: reads.
-extern "C" ABIDE_EXPORT void abide_set_connected(int connected) {
-    g_abide_connected = connected;
-}
-
-// Runs on the UI thread via webview_dispatch: navigate, then free the copy made
-// below (the original buffer is long gone — the dispatch is asynchronous).
-static void abideDispatchNavigate(void *w, void *arg) {
-    char *url = (char *)arg;
-    webview_navigate(w, url);
-    free(url);
-}
-
-/*
-Navigate the live window to `url` from any thread. The launcher's control server
-runs off the main thread, so it can't call webview_navigate (a Cocoa/UI call)
-directly; this hops onto the UI thread via webview_dispatch. The URL is copied
-synchronously here because the dispatch runs later, after the caller's buffer is
-gone — abideDispatchNavigate frees the copy once it has navigated.
-*/
-extern "C" ABIDE_EXPORT void abide_request_navigate(void *w, const char *url) {
-    webview_dispatch(w, abideDispatchNavigate, strdup(url));
-}
-
-// Maps a JSON `role` string to its enum; unknown/absent → none.
-static AbideRole roleFromString(NSString *role) {
-    if ([role isEqualToString:@"start"]) {
-        return AbideRoleStart;
-    }
-    if ([role isEqualToString:@"disconnect"]) {
-        return AbideRoleDisconnect;
-    }
-    return AbideRoleNone;
-}
-
-// Builds a JS string literal for `value`, safely escaped via NSJSONSerialization.
-static NSString *jsString(NSString *value) {
-    NSData *json = [NSJSONSerialization dataWithJSONObject:value
-                                                  options:NSJSONWritingFragmentsAllowed
-                                                    error:nil];
-    return [[NSString alloc] initWithData:json encoding:NSUTF8StringEncoding];
-}
-
-/*
-Action target for a menu item. Owns the webview handle so a click can drive the
-live window: a `navigate` item repoints the window at a URL (the Server menu's
-Start/Disconnect, gated by `role`), a `emit` item dispatches a abide:menu
-event into the page. Lives for the whole process (NSMenuItem does not retain its
-target), matching the never-released menu objects below.
-*/
-@interface AbideMenuAction : NSObject {
-@public
-    void *webviewHandle;
-    NSString *navigateUrl;  // target URL for a navigate item; nil otherwise
-    NSString *emitName;     // event name for an emit item; nil otherwise
-    AbideRole role;         // gating role for a Server navigate item; none otherwise
-}
-- (void)navigateTo:(id)sender;
-- (void)emit:(id)sender;
-- (BOOL)validateMenuItem:(NSMenuItem *)item;
-@end
-
-@implementation AbideMenuAction
-// Points the live webview at this item's URL (already on the UI thread here).
-- (void)navigateTo:(id)sender {
-    if (navigateUrl != nil) {
-        webview_navigate(webviewHandle, [navigateUrl UTF8String]);
-    }
-}
-
-// Dispatches a abide:menu CustomEvent (detail `{ name }`) into the page, so the
-// app's own code handles it — including computing args for a parameterised call.
-- (void)emit:(id)sender {
-    NSString *js = [NSString
-        stringWithFormat:
-            @"window.dispatchEvent(new CustomEvent('abide:menu',{detail:{name:%@}}))",
-            jsString(emitName)];
-    webview_eval(webviewHandle, [js UTF8String]);
-}
-
-/*
-Drives the enabled state per connection. Server navigate items follow the truth
-table — Start only when disconnected, Disconnect only when connected — emit items
-only fire into a loaded page (so connected), and plain navigate items (role none)
-are always enabled.
-*/
-- (BOOL)validateMenuItem:(NSMenuItem *)item {
-    if (navigateUrl != nil) {
-        switch (role) {
-            case AbideRoleStart:
-                return g_abide_connected == 0;
-            case AbideRoleDisconnect:
-                return g_abide_connected != 0;
-            default:
-                return YES;
-        }
-    }
-    if (emitName != nil) {
-        return g_abide_connected != 0;
-    }
-    return YES;
-}
-@end
-
-// Builds one bundle submenu from its JSON description and items, or nil when
-// the description is malformed. Each item is a separator, a `navigate` item
-// (optionally roled), or an `emit` item.
-static NSMenu *buildBundleMenu(NSDictionary *menuDef, void *webview_handle) {
-    if (![menuDef isKindOfClass:[NSDictionary class]]) {
-        return nil;
-    }
-    NSMenu *menu = [[NSMenu alloc] initWithTitle:menuDef[@"label"] ?: @""];
-    for (NSDictionary *item in menuDef[@"items"]) {
-        if ([item[@"separator"] boolValue]) {
-            [menu addItem:[NSMenuItem separatorItem]];
-            continue;
-        }
-        NSString *navigate = item[@"navigate"];
-        NSString *emitName = item[@"emit"];
-        AbideMenuAction *target = [[AbideMenuAction alloc] init];
-        target->webviewHandle = webview_handle;
-        SEL action;
-        if ([navigate isKindOfClass:[NSString class]]) {
-            target->navigateUrl = [navigate copy];
-            target->role = roleFromString(item[@"role"]);
-            action = @selector(navigateTo:);
-        } else if ([emitName isKindOfClass:[NSString class]]) {
-            target->emitName = [emitName copy];
-            action = @selector(emit:);
-        } else {
-            continue;
-        }
-        NSMenuItem *menuItem = [menu addItemWithTitle:(item[@"label"] ?: @"")
-                                               action:action
-                                        keyEquivalent:(item[@"shortcut"] ?: @"")];
-        [menuItem setTarget:target];
-    }
-    return menu;
-}
-
-/*
-Builds and installs the macOS main menu on the shared application: App, File (the
-launcher's built-in Start/Disconnect), Edit, the bundle's custom menus, and
-Window.
-
-Safe to call after webview_create — which has already created the
-NSApplication — and must run before webview_run so the menu is present when the
-run loop starts. `webview_handle` is the value returned by webview_create,
-captured so the menu can drive it. `config_json` is a JSON object
-`{ "appName": string, "fileMenu"?: { label, items }, "menu"?: [{ label, items }] }`,
-where each item is `{ separator: true }`, `{ label, shortcut?, navigate, role? }`,
-or `{ label, shortcut?, emit }`; pass NULL for the standard menus only.
-
-Compiled without ARC (matching the webview header's manual memory model): the
-menu objects and action targets intentionally live for the whole process, so
-the +1 alloc counts are never released.
-*/
-extern "C" ABIDE_EXPORT void abide_install_app_menu(void *webview_handle,
-                                                    const char *config_json) {
-    @autoreleasepool {
-        NSDictionary *config = nil;
-        if (config_json) {
-            NSData *data = [[NSString stringWithUTF8String:config_json]
-                dataUsingEncoding:NSUTF8StringEncoding];
-            id parsed = [NSJSONSerialization JSONObjectWithData:data options:0 error:nil];
-            if ([parsed isKindOfClass:[NSDictionary class]]) {
-                config = parsed;
-            }
-        }
-        NSApplication *app = [NSApplication sharedApplication];
-        NSString *appName = config[@"appName"] ?: @"App";
-
-        NSMenu *mainMenu = [[NSMenu alloc] init];
-
-        // Application menu — the bold first menu. Its title is ignored by macOS
-        // (the process/bundle name wins), but its items are what users reach.
-        NSMenuItem *appMenuItem = [[NSMenuItem alloc] init];
-        [mainMenu addItem:appMenuItem];
-        NSMenu *appMenu = [[NSMenu alloc] init];
-        [appMenuItem setSubmenu:appMenu];
-
-        [appMenu addItemWithTitle:[@"About " stringByAppendingString:appName]
-                           action:@selector(orderFrontStandardAboutPanel:)
-                    keyEquivalent:@""];
-        [appMenu addItem:[NSMenuItem separatorItem]];
-        [appMenu addItemWithTitle:[@"Hide " stringByAppendingString:appName]
-                           action:@selector(hide:)
-                    keyEquivalent:@"h"];
-        NSMenuItem *hideOthers = [appMenu addItemWithTitle:@"Hide Others"
-                                                    action:@selector(hideOtherApplications:)
-                                             keyEquivalent:@"h"];
-        [hideOthers setKeyEquivalentModifierMask:(NSEventModifierFlagCommand |
-                                                  NSEventModifierFlagOption)];
-        [appMenu addItemWithTitle:@"Show All"
-                           action:@selector(unhideAllApplications:)
-                    keyEquivalent:@""];
-        [appMenu addItem:[NSMenuItem separatorItem]];
-        [appMenu addItemWithTitle:[@"Quit " stringByAppendingString:appName]
-                           action:@selector(terminate:)
-                    keyEquivalent:@"q"];
-
-        // File menu — the launcher's Start/Disconnect, in the conventional
-        // slot right after the App menu and before Edit. Built from the same item
-        // shape as the custom menus, so `role` gating applies.
-        NSMenu *fileMenu = buildBundleMenu(config[@"fileMenu"], webview_handle);
-        if (fileMenu) {
-            NSMenuItem *fileMenuItem = [[NSMenuItem alloc] init];
-            [mainMenu addItem:fileMenuItem];
-            [fileMenuItem setSubmenu:fileMenu];
-        }
-
-        // Edit menu — the actions resolve against the first responder, which is
-        // the WKWebView, so Cmd-Z/X/C/V/A operate on the page's text fields.
-        NSMenuItem *editMenuItem = [[NSMenuItem alloc] init];
-        [mainMenu addItem:editMenuItem];
-        NSMenu *editMenu = [[NSMenu alloc] initWithTitle:@"Edit"];
-        [editMenuItem setSubmenu:editMenu];
-        [editMenu addItemWithTitle:@"Undo" action:@selector(undo:) keyEquivalent:@"z"];
-        NSMenuItem *redo = [editMenu addItemWithTitle:@"Redo"
-                                               action:@selector(redo:)
-                                        keyEquivalent:@"z"];
-        [redo setKeyEquivalentModifierMask:(NSEventModifierFlagCommand |
-                                            NSEventModifierFlagShift)];
-        [editMenu addItem:[NSMenuItem separatorItem]];
-        [editMenu addItemWithTitle:@"Cut" action:@selector(cut:) keyEquivalent:@"x"];
-        [editMenu addItemWithTitle:@"Copy" action:@selector(copy:) keyEquivalent:@"c"];
-        [editMenu addItemWithTitle:@"Paste" action:@selector(paste:) keyEquivalent:@"v"];
-        [editMenu addItemWithTitle:@"Select All"
-                            action:@selector(selectAll:)
-                     keyEquivalent:@"a"];
-
-        // Bundle's menus, inserted between Edit and Window — the launcher passes
-        // its built-in Server menu first, followed by the app's custom menus.
-        for (NSDictionary *menuDef in config[@"menu"]) {
-            NSMenu *bundleMenu = buildBundleMenu(menuDef, webview_handle);
-            if (bundleMenu) {
-                NSMenuItem *bundleMenuItem = [[NSMenuItem alloc] init];
-                [mainMenu addItem:bundleMenuItem];
-                [bundleMenuItem setSubmenu:bundleMenu];
-            }
-        }
-
-        // Window menu — Minimize/Zoom/Close, registered so macOS tracks the
-        // app's windows in it automatically.
-        NSMenuItem *windowMenuItem = [[NSMenuItem alloc] init];
-        [mainMenu addItem:windowMenuItem];
-        NSMenu *windowMenu = [[NSMenu alloc] initWithTitle:@"Window"];
-        [windowMenuItem setSubmenu:windowMenu];
-        [windowMenu addItemWithTitle:@"Minimize"
-                              action:@selector(performMiniaturize:)
-                       keyEquivalent:@"m"];
-        [windowMenu addItemWithTitle:@"Zoom" action:@selector(performZoom:) keyEquivalent:@""];
-        [windowMenu addItem:[NSMenuItem separatorItem]];
-        [windowMenu addItemWithTitle:@"Close"
-                              action:@selector(performClose:)
-                       keyEquivalent:@"w"];
-        [app setWindowsMenu:windowMenu];
-
-        [app setMainMenu:mainMenu];
-    }
-}
-
-// WEBVIEW_NATIVE_HANDLE_KIND_BROWSER_CONTROLLER — the WKWebView pointer.
-static const int kAbideBrowserController = 2;
-
-// Associated-object key under which each WKDownload stashes its chosen
-// destination URL, so downloadDidFinish: can reveal the saved file in Finder.
-static const char kAbideDownloadDestKey = 0;
-
-/*
-Navigation + download delegate for the bundle's WKWebView. The upstream webview
-sets no navigation delegate, so WKWebView silently drops `<a download>` clicks,
-blob:/data: downloads, and attachment responses — leaving every abide bundle app
-unable to save a file. This routes those to a real download saved into the user's
-Downloads folder and reveals it in Finder, while passing every ordinary
-navigation straight through (the app's own page loads must not be hijacked).
-A process-lifetime singleton, never released (MRC), matching the menu objects
-above; WKWebView holds its navigationDelegate weakly, so the strong global is
-what keeps it alive.
-*/
-API_AVAILABLE(macos(11.3))
-@interface AbideDownloadDelegate : NSObject <WKNavigationDelegate, WKDownloadDelegate>
-@end
-
-@implementation AbideDownloadDelegate
-
-// A link with a `download` attribute (e.g. URL.createObjectURL + a.download)
-// sets shouldPerformDownload; turn only those into downloads and allow the rest
-// — notably the app's own navigations, which must load normally.
-- (void)webView:(WKWebView *)webView
-    decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction
-                    decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler {
-    if (navigationAction.shouldPerformDownload) {
-        decisionHandler(WKNavigationActionPolicyDownload);
-    } else {
-        decisionHandler(WKNavigationActionPolicyAllow);
-    }
-}
-
-// A response the webview can't render (or that the server marks as an
-// attachment) becomes a download too, mirroring how a browser behaves.
-- (void)webView:(WKWebView *)webView
-    decidePolicyForNavigationResponse:(WKNavigationResponse *)navigationResponse
-                      decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler {
-    if (navigationResponse.canShowMIMEType) {
-        decisionHandler(WKNavigationResponsePolicyAllow);
-    } else {
-        decisionHandler(WKNavigationResponsePolicyDownload);
-    }
-}
-
-- (void)webView:(WKWebView *)webView
-     navigationAction:(WKNavigationAction *)navigationAction
-    didBecomeDownload:(WKDownload *)download {
-    download.delegate = self;
-}
-
-- (void)webView:(WKWebView *)webView
-    navigationResponse:(WKNavigationResponse *)navigationResponse
-     didBecomeDownload:(WKDownload *)download {
-    download.delegate = self;
-}
-
-// Save under ~/Downloads using the browser-suggested name, de-duplicating with a
-// " (n)" suffix so a repeat export never silently clobbers the previous file.
-- (void)download:(WKDownload *)download
-    decideDestinationUsingResponse:(NSURLResponse *)response
-                 suggestedFilename:(NSString *)suggestedFilename
-                 completionHandler:(void (^)(NSURL *))completionHandler {
-    NSFileManager *fm = [NSFileManager defaultManager];
-    NSURL *dir =
-        [[fm URLsForDirectory:NSDownloadsDirectory inDomains:NSUserDomainMask] firstObject];
-    if (dir == nil) {
-        dir = [NSURL fileURLWithPath:NSHomeDirectory()];
-    }
-    NSString *name = suggestedFilename.length ? suggestedFilename : @"download";
-    NSURL *dest = [dir URLByAppendingPathComponent:name];
-    NSString *base = [name stringByDeletingPathExtension];
-    NSString *ext = [name pathExtension];
-    for (int i = 1; [fm fileExistsAtPath:dest.path]; i++) {
-        NSString *candidate =
-            ext.length ? [NSString stringWithFormat:@"%@ (%d).%@", base, i, ext]
-                       : [NSString stringWithFormat:@"%@ (%d)", base, i];
-        dest = [dir URLByAppendingPathComponent:candidate];
-    }
-    objc_setAssociatedObject(download, &kAbideDownloadDestKey, dest,
-                             OBJC_ASSOCIATION_RETAIN_NONATOMIC);
-    completionHandler(dest);
-}
-
-- (void)downloadDidFinish:(WKDownload *)download {
-    NSURL *dest = objc_getAssociatedObject(download, &kAbideDownloadDestKey);
-    if (dest != nil) {
-        [[NSWorkspace sharedWorkspace] activateFileViewerSelectingURLs:@[ dest ]];
-    }
-}
-
-@end
-
-/*
-Attaches the download delegate to the bundle's WKWebView. Safe to call after
-webview_create and must run before the first navigation. A no-op on macOS
-versions before 11.3 (no WKDownload API) — there downloads stay unsupported, as
-they were. The delegate is a strong process-lifetime singleton because WKWebView
-holds its navigationDelegate weakly.
-*/
-extern "C" ABIDE_EXPORT void abide_install_downloads(void *webview_handle) {
-    if (@available(macOS 11.3, *)) {
-        WKWebView *webView =
-            (WKWebView *)webview_get_native_handle(webview_handle, kAbideBrowserController);
-        if (webView == nil) {
-            return;
-        }
-        static AbideDownloadDelegate *delegate = nil;
-        if (delegate == nil) {
-            delegate = [[AbideDownloadDelegate alloc] init];
-        }
-        webView.navigationDelegate = delegate;
-    }
-}