Skip to content

Commit

Permalink
writeDarwinBundle: use binary wrapper
Browse files Browse the repository at this point in the history
Previously `writeDarwinBundle` used a handcrafted shell wrapper, however
this causes issues on Apple Silicon Macs as script-only application
bundles are always run under Rosetta[0][1].

Replacing the handcrafted shell wrapper with a binary wrapper allows
apps to run natively instead of requiring Rosetta. However, this means
we can no longer use `$1` and `$@`.

After checking nearly every current usage of `desktopToDarwinBundle`,
there were no apps that used `%[fFuU]` before the last argument, meaning
removing them naively is good enough for the current apps.

[0]: https://developer.apple.com/documentation/apple-silicon/building-a-universal-macos-binary
[1]: https://stackoverflow.com/a/68208374
  • Loading branch information
Enzime committed Aug 21, 2023
1 parent 55d5ebb commit 66884a4
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 13 deletions.
30 changes: 19 additions & 11 deletions pkgs/build-support/make-darwin-bundle/write-darwin-bundle.nix
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{ writeScriptBin, lib, ... }:
{ writeScriptBin, lib, makeBinaryWrapper }:

let
pListText = lib.generators.toPlist { } {
Expand All @@ -17,23 +17,31 @@ in writeScriptBin "write-darwin-bundle" ''
readonly prefix=$1
readonly name=$2
readonly exec=$3
# TODO: support executables with spaces in their names
readonly execName=''${3%% *} # Before the first space
[[ $3 =~ " " ]] && readonly execArgs=''${3#* } # Everything after the first space
readonly icon=$4.icns
readonly squircle=''${5:-1}
readonly plist=$prefix/Applications/$name.app/Contents/Info.plist
readonly binary=$prefix/bin/$execName
readonly bundleExecutable=$prefix/Applications/$name.app/Contents/MacOS/$name
cat > "$plist" <<EOF
${pListText}
EOF
if [[ $squircle == 0 || $squircle == "false" ]]; then
sed '/CFBundleIconFiles/,\|</array>|d' -i "$plist"
fi
if [[ $squircle == 0 || $squircle == "false" ]]; then
sed '/CFBundleIconFiles/,\|</array>|d' -i "$plist"
fi
cat > "$prefix/Applications/$name.app/Contents/MacOS/$name" <<EOF
#!/bin/bash
exec $prefix/bin/$exec
EOF
chmod +x "$prefix/Applications/$name.app/Contents/MacOS/$name"
if [[ -n "$execArgs" ]]; then
(
source ${makeBinaryWrapper}/nix-support/setup-hook
# WORKAROUND: makeBinaryWrapper fails when -u is set
set +u
makeBinaryWrapper "$binary" "$bundleExecutable" --add-flags "$execArgs"
)
else
ln -s "$binary" "$bundleExecutable"
fi
''
4 changes: 2 additions & 2 deletions pkgs/build-support/setup-hooks/desktop-to-darwin-bundle.sh
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,8 @@ processExecFieldCodes() {
local -r execNoKC="${execNoK/\%c/$(getDesktopParam "${file}" "Name")}"
local -r icon=$(getDesktopParam "${file}" "Icon")
local -r execNoKCI="${execNoKC/\%i/${icon:+--icon }${icon}}"
local -r execNoKCIfu="${execNoKCI/\%[fu]/\$1}"
local -r exec="${execNoKCIfu/\%[FU]/\$@}"
local -r execNoKCIfu="${execNoKCI/ \%[fu]/}"
local -r exec="${execNoKCIfu/ \%[FU]/}"
if [[ "$exec" != "$execRaw" ]]; then
echo 1>&2 "desktopToDarwinBundle: Application bundles do not understand desktop entry field codes. Changed '$execRaw' to '$exec'."
fi
Expand Down

0 comments on commit 66884a4

Please sign in to comment.