Merge pull request #3 from toothbrush/paul/bundle-guile-stdlib

Bundle Guile stdlib and ccache

Author: toothbrush

Spotiqueue.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 52;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -294,6 +294,7 @@
 			buildConfigurationList = DAE1F18C26534D670013704F /* Build configuration list for PBXNativeTarget "Spotiqueue" */;
 			buildPhases = (
 				DAE1F17A26534D660013704F /* Sources */,
+				DA67F756270728490002B96A /* Vendor in Guile stdlib */,
 				DAE1F17B26534D660013704F /* Frameworks */,
 				DAE1F17C26534D660013704F /* Resources */,
 				DAD7D73826775A6A00A5510E /* Embed Frameworks */,
@@ -384,6 +385,28 @@
 		};
 /* End PBXResourcesBuildPhase section */
 
+/* Begin PBXShellScriptBuildPhase section */
+		DA67F756270728490002B96A /* Vendor in Guile stdlib */ = {
+			isa = PBXShellScriptBuildPhase;
+			alwaysOutOfDate = 1;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputFileListPaths = (
+			);
+			inputPaths = (
+			);
+			name = "Vendor in Guile stdlib";
+			outputFileListPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "set -eux\n\nguile_stdlib_target=\"${CODESIGNING_FOLDER_PATH}/Contents/Resources/guile-stdlib\"\nguile_stdlib_source=\"/usr/local/Cellar/guile/3.0.7/share/guile/3.0\"\nguile_ccache_target=\"${CODESIGNING_FOLDER_PATH}/Contents/Resources/guile-ccache\"\nguile_ccache_source=\"/usr/local/Cellar/guile/3.0.7/lib/guile/3.0/ccache\"\n\n# Clean from previous invocations\nif [ -d \"$guile_ccache_target\" ] ; then\n    rm -rf \"$guile_ccache_target\"\nfi\n\nmkdir -p \"$guile_stdlib_target\"\nmkdir -p \"$guile_ccache_target\"\n\ncp -rv \"$guile_stdlib_source\"/* \"$guile_stdlib_target/\"\ncp -rv \"$guile_ccache_source\"/* \"$guile_ccache_target/\"\n";
+		};
+/* End PBXShellScriptBuildPhase section */
+
 /* Begin PBXSourcesBuildPhase section */
 		DAE1F17A26534D660013704F /* Sources */ = {
 			isa = PBXSourcesBuildPhase;
@@ -562,7 +585,7 @@
 				CODE_SIGN_IDENTITY = "Apple Development";
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
-				CURRENT_PROJECT_VERSION = 999;
+				CURRENT_PROJECT_VERSION = 1036;
 				DEVELOPMENT_TEAM = QG72S9L5L3;
 				ENABLE_HARDENED_RUNTIME = YES;
 				FRAMEWORK_SEARCH_PATHS = (
@@ -602,7 +625,7 @@
 				CODE_SIGN_IDENTITY = "Apple Development";
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
-				CURRENT_PROJECT_VERSION = 999;
+				CURRENT_PROJECT_VERSION = 1036;
 				DEVELOPMENT_TEAM = QG72S9L5L3;
 				ENABLE_HARDENED_RUNTIME = YES;
 				FRAMEWORK_SEARCH_PATHS = (

Spotiqueue/AppDelegate.swift

@@ -213,6 +213,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         } else {
             // Mind you, this will be nil if AppMover moves the executable away before we have had a chance to load the NIB.  Which is still a file...
             logger.critical("Something very weird - modal.window is nil!")
+            return
         }
         set_callback(player_update_hook(hook: position_ms: duration_ms:))
         NSEvent.addLocalMonitorForEvents(matching: [.keyDown /* , .systemDefined */ ], handler: self.localKeyShortcuts(event:))

Spotiqueue/Info.plist

@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.4.1</string>
+	<string>2.4.2</string>
 	<key>CFBundleURLTypes</key>
 	<array>
 		<dict>
@@ -32,7 +32,7 @@
 		</dict>
 	</array>
 	<key>CFBundleVersion</key>
-	<string>999</string>
+	<string>1036</string>
 	<key>LSApplicationCategoryType</key>
 	<string>public.app-category.music</string>
 	<key>LSMinimumSystemVersion</key>

Spotiqueue/main.m

@@ -15,25 +15,44 @@ static void register_functions (void* data)
 }
 
 int main(int argc, const char * argv[]) {
-    // I want my emojis to work! 😂
-    // The million-dollar question is why the ; locale: .. hint at the top of the file is ignored.
-    setenv("LANG", "en_US.UTF-8", 1);
-
-    // Hack: Assume Homebrew has installed Guile libs in the usual spot, so that it doesn't matter what version folks have installed (e.g. Catalina, Big Sur, 3.0.*).  Still requires folks to `brew install guile` before Spotiqueue can work, but mitigates the pain somewhat.
-    setenv("GUILE_LOAD_PATH", "/usr/local/share/guile/3.0", 1);
-
-    scm_init_guile();
-    // For this weird guy, see https://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Recognize-Coding and https://www.gnu.org/software/guile/manual/html_node/Locales.html
-    scm_setlocale(scm_from_int(LC_ALL), scm_from_utf8_string(""));
-    scm_c_define_module("spotiqueue internal", &register_functions, NULL);
-
     @autoreleasepool {
         NSBundle* mainBundle;
         // Get the main bundle for the app.
         mainBundle = [NSBundle mainBundle];
+        NSString* bundlePath = [mainBundle bundlePath];
+        NSString* guileLibPath = [bundlePath stringByAppendingString:@"/Contents/Resources/guile-stdlib"];
+        NSString* guileCcachePath = [bundlePath stringByAppendingString:@"/Contents/Resources/guile-ccache"];
+        NSString* spotiqueueLibPath = [bundlePath stringByAppendingString:@"/Contents/Resources"];
+
+        // I want my emojis to work! 😂
+        // The million-dollar question is why the ; locale: .. hint at the top of the file is ignored.
+        setenv("LANG", "en_US.UTF-8", 1);
+        setenv("GUILE_LOAD_PATH", [guileLibPath UTF8String], 1);
+        setenv("GUILE_LOAD_COMPILED_PATH", [guileCcachePath UTF8String], 1);
+
+        scm_init_guile();
+
+        /* This deserves some explanation.  We really don't want Spotiqueue to rely on users doing
+         * `brew install guile` -- that would exclude half the world that doesn't like terminals.  So,
+         * we vendor in the Guile stdlib.  However, that's not enough, because if my guile*.a file was
+         * compiled in a different location than someone else's Guile installation path (e.g. the
+         * Homebrew 3.0.7 vs 3.0.7_1 path issue) the built-in %load-path won't match up with theirs!
+         * Subsequently (yes, there's more) if i don't also bundle in the ccache (*.go files) then at
+         * startup Spotiqueue thinks its own stdlib is newer than the user's one and busily starts
+         * compiling.  No bueno.  So we package up both the stdlib source & compiled files, and
+         * manually tweak the search paths so that we're sure that only those files will be used.  Not
+         * great, but it seems to work, and best of all, folks won't need to install Guile themselves
+         * if they don't want to.
+         */
+        scm_c_eval_string([[NSString stringWithFormat:@"(set! %%load-path '(\"%@\" \"%@\"))", guileLibPath, spotiqueueLibPath] UTF8String]);
+        scm_c_eval_string([[NSString stringWithFormat:@"(set! %%load-compiled-path '(\"%@\"))", guileCcachePath] UTF8String]);
+
+        // For this weird guy, see https://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Recognize-Coding and https://www.gnu.org/software/guile/manual/html_node/Locales.html
+        scm_setlocale(scm_from_int(LC_ALL), scm_from_utf8_string(""));
+        scm_c_define_module("spotiqueue internal", &register_functions, NULL);
+
         // Note that there are DRAGONS here.  We use a separate "Copy Files" Xcode build phase to put Scheme files into a "spotiqueue" subfolder inside the App bundle's Resources folder.  We do this so that the module names match up.  However, there doesn't seem to be an obvious way to get a direct pointer to the Resources folder, so we use this hack.
-        // Subsequently we need to add a (add-to-load-path ..) in init.scm, but i'll continue the story there.
-        scm_c_primitive_load([[mainBundle pathForResource:@"spotiqueue/init" ofType:@"scm"] UTF8String]);
+        scm_c_primitive_load_path("spotiqueue/init");
     }
 
     return NSApplicationMain(argc, argv);

guile/spotiqueue/init.scm

@@ -5,18 +5,11 @@
 ;;; This file is read by Spotiqueue as soon as it starts up.  It exposes some helpers and hooks for
 ;;; users.
 
-;; Dragons, continued: we grab our file location, but go up one level before adding to load-path.
-;; The reason for this is that we want to call this module (spotiqueue init), so it has to live in a
-;; spotiqueue folder with its siblings.
-
 (format #t "%load-path = ~s\n" %load-path)
 
-(add-to-load-path (canonicalize-path (string-append (dirname (current-filename)) file-name-separator-string "..")))
-
-;; TODO find out a way we can make this module sensibly loadable from `guile' in the shell without
-;; having Spotiqueue running...  Is that even useful?
-
-;; If i want to use this module naming scheme i should have the source files in a folder called `spotiqueue'.  Grr, there are already so many of those i'll just nest them in guile/spotiqueue i guess.
+;; If i want to use this module naming scheme i should have the source files in a folder called
+;; `spotiqueue'.  Grr, there are already so many of those i'll just nest the Scheme files in
+;; guile/spotiqueue i guess.  The Copy Files phase in Xcode can sort that out.
 
 (define-module (spotiqueue init)
   #:use-module (ice-9 format)