add [compatability] osx_tell_dock_outside_bundle

Author: connorjclark

allegro5.cfg

@@ -238,3 +238,8 @@ max_page_size = 0
 # automatically, but may break old code that handled this eventuality.
 # Set this to false for such code.
 automatic_menu_display_resize = true
+
+# On OSX outside an app bundle, on system init allegro manually promotes the process
+# to a graphical application. This may be undesirable for console applications. Set
+# this to false to disable this behavior.
+osx_tell_dock_outside_bundle = true

include/allegro5/platform/aintosx.h

@@ -117,6 +117,7 @@ typedef struct HID_DEVICE_COLLECTION HID_DEVICE_COLLECTION;
 #endif
 
 int _al_osx_bootstrap_ok(void);
+void _al_osx_tell_dock(void);
 
 void _al_osx_keyboard_handler(int pressed, NSEvent *event, ALLEGRO_DISPLAY*);
 void _al_osx_keyboard_modifiers(unsigned int new_mods, ALLEGRO_DISPLAY*);

src/macosx/osxgl.m

@@ -1301,6 +1301,8 @@ static void init_new_vsync(ALLEGRO_DISPLAY_OSX_WIN *dpy)
       osx_run_fullscreen_display(dpy);
    });
    [pool drain];
+
+   _al_osx_tell_dock();
    return &dpy->parent;
 }
 #if 0
@@ -1696,6 +1698,7 @@ static void init_new_vsync(ALLEGRO_DISPLAY_OSX_WIN *dpy)
 
    [pool drain];
 
+   _al_osx_tell_dock();
    return display;
 }
 

src/macosx/system.m

@@ -53,12 +53,17 @@
 static _AL_VECTOR osx_display_modes;
 static ALLEGRO_SYSTEM osx_system;
 
-/* osx_tell_dock:
+/* _al_osx_tell_dock:
  *  Tell the dock about us; promote us from a console app to a graphical app
  *  with dock icon and menu
  */
-static void osx_tell_dock(void)
+void _al_osx_tell_dock(void)
 {
+   if (_al_osx_bundle != NULL) {
+      /* If in a bundle, the dock will recognise us automatically */
+      return;
+   }
+
    ProcessSerialNumber psn = { 0, kCurrentProcess };
    TransformProcessType(&psn, kProcessTransformToForegroundApplication);
    [[NSApplication sharedApplication] performSelectorOnMainThread: @selector(activateIgnoringOtherApps:)
@@ -112,9 +117,16 @@ int _al_osx_bootstrap_ok(void)
    osx_system.vt = _al_system_osx_driver();
    _al_vector_init(&osx_system.displays, sizeof(ALLEGRO_DISPLAY*));
 
-   if (_al_osx_bundle == NULL) {
+   // `_al_osx_tell_dock` is better done after creating a display. Support old behavior for compatability.
+   bool do_osx_tell_dock = true;
+   const char* osx_tell_dock_outside_bundle_value =
+      al_get_config_value(al_get_system_config(), "compatibility", "osx_tell_dock_outside_bundle");
+   if (osx_tell_dock_outside_bundle_value && strcmp(osx_tell_dock_outside_bundle_value, "false") == 0)
+      do_osx_tell_dock = false;
+
+   if (do_osx_tell_dock) {
        /* If in a bundle, the dock will recognise us automatically */
-       osx_tell_dock();
+       _al_osx_tell_dock();
    }
 
    /* Mark the beginning of time. */