chore(release): 0.4.6

Ensures paths are correctly joined and no double and/or missing slash
errors can occur.

.rubocop.yml

@@ -1,5 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 80
+
 Style/Documentation:
   Enabled: false
-
-Style/LineLength:
-  Max: 80

Brewfile

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+brew 'autoconf'
 brew 'coreutils'
 brew 'curl'
 brew 'expat'
+brew 'gcc'
 brew 'gmp'
 brew 'gnu-sed'
 brew 'gnutls'
 brew 'jansson'
 brew 'libffi'
+brew 'libgccjit'
 brew 'libiconv'
 brew 'librsvg'
 brew 'libtasn1'

CHANGELOG.md

@@ -2,6 +2,83 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.4.6](https://github.com/jimeh/build-emacs-for-macos/compare/0.4.5...0.4.6) (2021-02-15)
+
+
+### Bug Fixes
+
+* **native_comp:** improve env setup patch fixing potential issues ([dca023d](https://github.com/jimeh/build-emacs-for-macos/commit/dca023daecd8704f197cbc391380aa194bc47d62))
+
+### [0.4.5](https://github.com/jimeh/build-emacs-for-macos/compare/0.4.4...0.4.5) (2021-01-06)
+
+
+### Bug Fixes
+
+* **cli:** remove defunct --[no-]native-comp-macos-fixes option ([ab55f54](https://github.com/jimeh/build-emacs-for-macos/commit/ab55f5421c81dc629e487bf4b8bb402657cb1bc4))
+
+### [0.4.4](https://github.com/jimeh/build-emacs-for-macos/compare/0.4.3...0.4.4) (2021-01-02)
+
+
+### Bug Fixes
+
+* **deps:** add autoconf to Brewfile ([a47d3e0](https://github.com/jimeh/build-emacs-for-macos/commit/a47d3e0c6a8ea8161a3bad0eafdac2401cf53129))
+
+### [0.4.3](https://github.com/jimeh/build-emacs-for-macos/compare/0.4.2...0.4.3) (2020-12-28)
+
+
+### Bug Fixes
+
+* **big-sur:** add Xcode CLI tools lib directory to runtime LIBRARY_PATH ([946856e](https://github.com/jimeh/build-emacs-for-macos/commit/946856e9c242d4a6fb5f839d8cae0acfafecdfc6))
+* **big-sur:** added support for building on Big Sur ([2247158](https://github.com/jimeh/build-emacs-for-macos/commit/2247158051d0f59933569b6974b2b5269f13c79e))
+
+### [0.4.2](https://github.com/jimeh/build-emacs-for-macos/compare/0.4.1...0.4.2) (2020-12-09)
+
+
+### Bug Fixes
+
+* **cli:** avoid error if --git-sha is used without a branch/tag/sha argument ([884f160](https://github.com/jimeh/build-emacs-for-macos/commit/884f1607f6707ca187b1abfb0ce562757d872230)), closes [#21](https://github.com/jimeh/build-emacs-for-macos/issues/21)
+* **native_comp:** update env setup patch for recent changes to comp.el ([c7daa13](https://github.com/jimeh/build-emacs-for-macos/commit/c7daa1350bd69df172ce6484c54189d2cee8d97e))
+
+### [0.4.1](https://github.com/jimeh/build-emacs-for-macos/compare/0.4.0...0.4.1) (2020-10-29)
+
+
+### Features
+
+* **native_comp:** remove patch based on feature/native-comp-macos-fixes branch ([70bf6b0](https://github.com/jimeh/build-emacs-for-macos/commit/70bf6b05d584976632b2fd2947c0bf692f5b6421))
+
+## [0.4.0](https://github.com/jimeh/build-emacs-for-macos/compare/0.3.0...0.4.0) (2020-10-04)
+
+
+### ⚠ BREAKING CHANGES
+
+* **native_comp:** Standard Homewbrew `gcc` and `libgccjit` formula are now required for native-comp, instead of the custom patched gcc formula.
+
+### Features
+
+* **native_comp:** use new libgccjit Homebrew formula ([d8bbcb7](https://github.com/jimeh/build-emacs-for-macos/commit/d8bbcb72b33f6bde8678c9d37548217ffdf3d641))
+
+## [0.3.0](https://github.com/jimeh/build-emacs-for-macos/compare/0.2.0...0.3.0) (2020-09-22)
+
+
+### ⚠ BREAKING CHANGES
+
+* **native_comp:** `--[no-]launcher` option is deprecated, as launcher script is no longer used.
+
+### Features
+
+* **native_comp:** use elisp patch instead of launcher script to set LIBRARY_PATH ([111cb64](https://github.com/jimeh/build-emacs-for-macos/commit/111cb6499368d14853a5927d38a43fc5e2f759f4)), closes [#14](https://github.com/jimeh/build-emacs-for-macos/issues/14)
+
+## [0.2.0](https://github.com/jimeh/build-emacs-for-macos/compare/0.1.1...0.2.0) (2020-09-20)
+
+
+### ⚠ BREAKING CHANGES
+
+* **native_comp:** Deprecate `--[no-]native-fast-boot` option in favor of `--[no-]native-full-aot`
+
+### Features
+
+* **native_comp:** add support for NATIVE_FULL_AOT, replacing NATIVE_FAST_BOOT ([0ab94da](https://github.com/jimeh/build-emacs-for-macos/commit/0ab94da15309b04978982369bdfa17e03e9b6329))
+
 ### [0.1.1](https://github.com/jimeh/build-emacs-for-macos/compare/0.1.0...0.1.1) (2020-09-19)
 
 

Formula/gcc.rb.patch

@@ -1,21 +0,0 @@
-diff --git a/Formula/gcc.rb b/Formula/gcc.rb
-index 1bd636d496..03ad124218 100644
---- a/Formula/gcc.rb
-+++ b/Formula/gcc.rb
-@@ -53,7 +53,7 @@ class Gcc < Formula
-     #  - Ada, which requires a pre-existing GCC Ada compiler to bootstrap
-     #  - Go, currently not supported on macOS
-     #  - BRIG
--    languages = %w[c c++ objc obj-c++ fortran]
-+    languages = %w[c c++ objc obj-c++ fortran jit]
-
-     osmajor = `uname -r`.split(".").first
-     pkgversion = "Homebrew GCC #{pkg_version} #{build.used_options*" "}".strip
-@@ -73,6 +73,7 @@ class Gcc < Formula
-       --with-system-zlib
-       --with-pkgversion=#{pkgversion}
-       --with-bugurl=https://github.com/Homebrew/homebrew-core/issues
-+      --enable-host-shared
-     ]
-
-     # Xcode 10 dropped 32-bit support

Gemfile

@@ -5,4 +5,6 @@ source 'http://rubygems.org/'
 group :development do
   gem 'byebug'
   gem 'rubocop'
+  gem 'rubocop-daemon'
+  gem 'solargraph', '~> 0.39.17'
 end

Makefile

@@ -0,0 +1,9 @@
+.PHONY: new-version
+new-version:
+	$(if $(shell which npx),,\
+		$(error No npx found in PATH, please install NodeJS))
+	$(if $(shell which standard-version),,\
+		$(error No standard-version found in PATH, install with: \
+			npm install -g standard-version))
+
+	npx standard-version

README.md

@@ -18,7 +18,7 @@ Use this script at your own risk.
 
 ## Status
 
-As of writing (2020-08-19) it works for me on my machine. Your luck may vary.
+As of writing (2021-01-15) it works for me on my machine. Your luck may vary.
 
 I have successfully built:
 
@@ -29,8 +29,8 @@ I have successfully built:
 For reference, my machine is:
 
 - 13-inch MacBook Pro (2020), 10th-gen 2.3 GHz Quad-Core Intel Core i7 (4c/8t)
-- macOS 10.15.6 (19G2021)
-- Xcode 11.6
+- macOS Big Sur 11.1 (20C69)
+- Xcode 12.3 (12C33)
 
 ## Limitations
 
@@ -71,15 +71,14 @@ available here: https://github.com/emacs-mirror/emacs
 Options:
     -j, --parallel COUNT             Compile using COUNT parallel processes (detected: 8)
         --git-sha SHA                Override detected git SHA of specified branch allowing builds of old commits
-        --[no-]xwidgets              Enable/disable XWidgets (default: enabled)
+        --[no-]xwidgets              Enable/disable XWidgets (default: enabled if supported)
         --[no-]native-comp           Enable/disable native-comp (default: enabled if supported)
-        --[no-]native-fast-boot      Enable/disable NATIVE_FAST_BOOT (default: enabled if native-comp supported)
-        --[no-]native-comp-macos-fixes
-                                     Enable/disable fix based on feature/native-comp-macos-fixes branch (default: enabled if native-comp supported)
-        --[no-]launcher              Enable/disable embedded launcher script  (default: enabled if native-comp is enabled)
+        --[no-]native-full-aot       Enable/disable NATIVE_FULL_AOT / Ahead of Time compilation (default: disabled)
         --rsvg                       Enable SVG image support via librsvg, can yield a unstable build (default: disabled)
         --no-titlebar                Apply no-titlebar patch (default: disabled)
         --no-frame-refocus           Apply no-frame-refocus patch (default: disabled)
+        --[no-]native-fast-boot      DEPRECATED: use --[no-]native-full-aot instead
+        --[no-]launcher              DEPRECATED: Launcher script is no longer used.
 ```
 
 Resulting applications are saved to the `builds` directory in a bzip2 compressed
@@ -88,6 +87,9 @@ tarball.
 If you don't want the build process to eat all your CPU cores, pass in a `-j`
 value of how many CPU cores you want it to use.
 
+Re-building the same Git SHA again can yield weird results unless you first
+trash the corresponding directory from the `sources` directory.
+
 ### Examples
 
 To download a tarball of the `master` branch (Emacs 28.x as of writing) and
@@ -108,43 +110,50 @@ All sources as downloaded as tarballs from the
 to get a list of tags/branches available to install, simply check said
 repository.
 
+## Use Self-Contained Emacs.app as `emacs` CLI Tool
+
+As the application bundle is self-contained, the main executable needs to be run
+from within the application bundle. This means a simple symlink to
+`Emacs.app/Contents/MacOS/Emacs` will not work. Instead the best approach is to
+create a shell alias called `emacs` pointing to the right place.
+
+Personally I use something similar to this:
+
+```bash
+if [ -f "/Applications/Emacs.app/Contents/MacOS/Emacs" ]; then
+  export EMACS="/Applications/Emacs.app/Contents/MacOS/Emacs"
+  alias emacs="$EMACS -nw"
+fi
+
+if [ -f "/Applications/Emacs.app/Contents/MacOS/bin/emacsclient" ]; then
+  alias emacsclient="/Applications/Emacs.app/Contents/MacOS/bin/emacsclient"
+fi
+```
+
+Setting the `EMACS` variable to the binary path seems to be a good idea, as some
+tools seems to use it to figure out the path to Emacs' executable, including
+[doom-emacs](https://github.com/hlissner/doom-emacs)' `doom` CLI tool.
+
 ## Native-Comp
 
-To build a Emacs.app with native-comp support
+Building a Emacs.app with native-comp support
 ([gccemacs](https://akrl.sdf.org/gccemacs.html)) from the `feature/native-comp`
-branch, you will need to install a patched version of Homebrew's `gcc` formula
-that includes libgccjit.
+branch is now supported without much hassle thanks to the newly released
+`libgccjit` Homebrew formula.
 
-The patch itself is in `./Formula/gcc.rb.patch`, and comes from
-[this](https://gist.github.com/mikroskeem/0a5c909c1880408adf732ceba6d3f9ab#1-gcc-with-libgccjit-enabled)
-gist.
-
-You can install the patched formula by running the helper script:
-
-```
-./install-patched-gcc
-```
-
-The helper script will copy your local `gcc.rb` Forumla from Homebrew to
-`./Formula`, and apply the `./Formula/gcc.rb.patch` to it. After which it then
-proceed to install the patched gcc formula which includes libgccjit.
-
-As it requires installing and compiling GCC from source, it can take anywhere
-between 30-60 minutes or more depending on your machine.
-
-And finally to build a Emacs.app with native compilation enabled, run:
+To build a Emacs.app with native compilation enabled, simply run:
 
 ```
 ./build-emacs-for-macos feature/native-comp
 ```
 
-By default `NATIVE_FAST_BOOT` is enabled which ensures a fast build by native
+By default `NATIVE_FULL_AOT` is disabled which ensures a fast build by native
 compiling as few lisp source files as possible to build the app. Any remaining
 lisp files will be dynamically compiled in the background the first time you use
-them.
+them. To enable native full AoT, pass in the `--native-full-aot` option.
 
-On my machine it takes around 10-15 minutes to build Emacs.app with
-`NATIVE_FAST_BOOT` enabled. With it disabled it takes around 25 minutes.
+On my machine it takes around 10 minutes to build Emacs.app with
+`NATIVE_FULL_AOT` disabled. With it enabled it takes around 20-25 minutes.
 
 ### Configuration
 
@@ -159,24 +168,13 @@ By default natively compiled `*.eln` files will be cached in
 the first element of the `comp-eln-load-path` variable. The path string must end
 with a `/`.
 
-Also it seems somewhat common that some `*.eln` files are left behind with a
-zero-byte file size if Emacs is quit while async native compilation is in
-progress. Such empty files causes errors on startup, and needs to be deleted.
-
 Below is an example which stores all compiled `*.eln` files in `cache/eln-cache`
-within your Emacs configuration directory, and also deletes any `*.eln` files in
-said directory which have a file size of zero bytes:
+within your Emacs configuration directory:
 
 ```elisp
 (when (boundp 'comp-eln-load-path)
-  (let ((eln-cache-dir (expand-file-name "cache/eln-cache/" user-emacs-directory))
-        (find-exec (executable-find "find")))
-    (setcar comp-eln-load-path eln-cache-dir)
-    ;; Quitting emacs while native compilation in progress can leave zero byte
-    ;; sized *.eln files behind. Hence delete such files during startup.
-    (when find-exec
-      (call-process find-exec nil nil nil eln-cache-dir
-                    "-name" "*.eln" "-size" "0" "-delete"))))
+  (setcar comp-eln-load-path
+          (expand-file-name "cache/eln-cache/" user-emacs-directory)))
 ```
 
 ### Issues

build-emacs-for-macos

@@ -72,17 +72,18 @@ class Build
   DOWNLOAD_URL = 'https://github.com/emacs-mirror/emacs/tarball/%s'
   LATEST_URL = 'https://api.github.com/repos/emacs-mirror/emacs/commits/%s'
   NATIVE_COMP_REF_REGEXP = %r{^feature/native-comp}.freeze
-  LAUNCHER_TEMPLATE = './launcher.bash.erb'
 
   attr_reader :root_dir
   attr_reader :source_dir
   attr_reader :ref
   attr_reader :options
+  attr_reader :gcc_info
 
-  def initialize(root_dir, ref = 'master', options = {})
+  def initialize(root_dir, ref = nil, options = {})
     @root_dir = root_dir
     @ref = ref
     @options = options
+    @gcc_info = GccInfo.new
   end
 
   def build
@@ -96,16 +97,11 @@ class Build
     autogen
     detect_native_comp if options[:native_comp].nil?
 
-    if options[:native_comp] && options[:launcher].nil?
-      options[:launcher] = true
-    end
-
     app = compile_source(@source_dir)
     symlink_internals(app)
 
     LibEmbedder.new(app, brew_dir, extra_libs).embed
-    LibGccJitEmbedder.new(app, gcc_dir).embed if options[:native_comp]
-    LauncherEmbedder.new(app, LAUNCHER_TEMPLATE).embed if options[:launcher]
+    GccLibEmbedder.new(app, gcc_info).embed if options[:native_comp]
 
     archive_app(app)
   end
@@ -128,15 +124,11 @@ class Build
     @brew_dir ||= `brew --prefix`.chomp
   end
 
-  def gcc_dir
-    @gcc_dir ||= `brew --prefix gcc`.chomp
-  end
-
   def extra_libs
     @extra_libs ||= [
-      "#{brew_dir}/opt/expat/lib/libexpat.1.dylib",
-      "#{brew_dir}/opt/libiconv/lib/libiconv.2.dylib",
-      "#{brew_dir}/opt/zlib/lib/libz.1.dylib"
+      File.join(brew_dir, 'opt/expat/lib/libexpat.1.dylib'),
+      File.join(brew_dir, 'opt/libiconv/lib/libiconv.2.dylib'),
+      File.join(brew_dir, 'opt/zlib/lib/libz.1.dylib')
     ]
   end
 
@@ -145,7 +137,7 @@ class Build
 
     url = (DOWNLOAD_URL % sha)
     filename = "emacs-mirror-emacs-#{sha[0..6]}.tgz"
-    target   = File.join(tarballs_dir, filename)
+    target = File.join(tarballs_dir, filename)
 
     if File.exist?(target)
       info "#{filename} already exists locally, attempting to use."
@@ -208,20 +200,12 @@ class Build
     err 'This emacs source tree does not support native-comp'
   end
 
-  def verify_libgccjit
-    err 'gcc not installed' unless Dir.exist?(gcc_dir)
-
-    return if Dir["#{gcc_dir}/lib/**/libgccjit.so*"].any?
-
-    err "Detected GCC (#{gcc_dir}) does not have libgccjit. Ensure patched " \
-        'gcc brew formula has been installed via ./install-patched-gcc'
-  end
-
   def gcc_library_paths
-    @gcc_library_paths ||= Dir[
-      "#{gcc_dir}/lib/gcc/*",
-      "#{gcc_dir}/lib/gcc/*/gcc/*apple-darwin*/*"
-    ].sort_by { |p| [p.size, p] }
+    @gcc_library_paths ||= [
+      gcc_info.lib_dir,
+      gcc_info.darwin_lib_dir,
+      gcc_info.libgccjit_lib_dir
+    ]
   end
 
   def autogen
@@ -250,22 +234,20 @@ class Build
       if options[:native_comp]
         info 'Compiling with native-comp enabled'
         verify_native_comp
-        verify_libgccjit
+        gcc_info.verify_libgccjit
 
-        if options[:macos_fixes] && ref != 'feature/native-comp-macos-fixes'
-          apply_native_comp_macos_fixes
-        end
+        apply_native_comp_env_setup_patch(source)
 
-        ENV['NATIVE_FAST_BOOT'] = '1' if options[:native_fast_boot]
         ENV['CFLAGS'] = [
-          "-I#{gcc_dir}/include",
+          "-I#{File.join(gcc_info.root_dir, 'include')}",
           '-O2',
           '-march=native'
         ].compact.join(' ')
 
         ENV['LDFLAGS'] = [
           gcc_library_paths.map { |path| "-L#{path}" },
-          "-I#{gcc_dir}/include"
+          "-I#{File.join(gcc_info.root_dir, 'include')}",
+          "-I#{File.join(gcc_info.libgccjit_root_dir, 'include')}"
         ].flatten.compact.join(' ')
 
         ENV['LIBRARY_PATH'] = [
@@ -276,25 +258,31 @@ class Build
 
       ENV['CC'] = 'clang'
       ENV['PKG_CONFIG_PATH'] = [
-        "#{brew_dir}/lib/pkgconfig",
-        "#{brew_dir}/share/pkgconfig",
-        "#{brew_dir}/opt/expat/lib/pkgconfig",
-        "#{brew_dir}/opt/libxml2/lib/pkgconfig",
-        "#{brew_dir}/opt/ncurses/lib/pkgconfig",
-        "#{brew_dir}/opt/zlib/lib/pkgconfig",
-        "#{brew_dir}/Homebrew/Library/Homebrew/os/mac/pkgconfig/#{OS.version}",
+        File.join(brew_dir, 'lib/pkgconfig'),
+        File.join(brew_dir, 'share/pkgconfig'),
+        File.join(brew_dir, 'opt/expat/lib/pkgconfig'),
+        File.join(brew_dir, 'opt/libxml2/lib/pkgconfig'),
+        File.join(brew_dir, 'opt/ncurses/lib/pkgconfig'),
+        File.join(brew_dir, 'opt/zlib/lib/pkgconfig'),
+        File.join(brew_dir, 'Homebrew/Library/Homebrew/os/mac/pkgconfig',
+                  OS.version.to_s),
         ENV['PKG_CONFIG_PATH']
       ].compact.join(':')
 
       ENV['PATH'] = [
-        "#{brew_dir}/opt/make/libexec/gnubin",
-        "#{brew_dir}/opt/coreutils/libexec/gnubin",
-        "#{brew_dir}/opt/gnu-sed/libexec/gnubin",
-        "#{brew_dir}/bin",
-        "#{brew_dir}/opt/texinfo/bin",
+        File.join(brew_dir, 'opt/make/libexec/gnubin'),
+        File.join(brew_dir, 'opt/coreutils/libexec/gnubin'),
+        File.join(brew_dir, 'opt/gnu-sed/libexec/gnubin'),
+        File.join(brew_dir, 'bin'),
+        File.join(brew_dir, 'opt/texinfo/bin'),
         ENV['PATH']
       ].compact.join(':')
 
+      ENV['LIBRARY_PATH'] = [
+        ENV['LIBRARY_PATH'],
+        '/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib'
+      ].compact.join(':')
+
       configure_flags = [
         '--with-ns',
         '--with-modules',
@@ -321,6 +309,15 @@ class Build
       make_flags = []
       make_flags += ['-j', options[:parallel].to_s] if options[:parallel]
 
+      if options[:native_full_aot]
+        info 'Using NATIVE_FULL_AOT=1'
+        make_flags << 'NATIVE_FULL_AOT=1'
+        ENV.delete('NATIVE_FAST_BOOT')
+      else
+        ENV.delete('NATIVE_FULL_AOT')
+        ENV['NATIVE_FAST_BOOT'] = '1'
+      end
+
       if options[:native_comp]
         make_flags << "BYTE_COMPILE_EXTRA_FLAGS=--eval '(setq comp-speed 2)'"
       end
@@ -353,18 +350,18 @@ class Build
     FileUtils.mkdir_p(builds_dir)
 
     metadata = [
-      ref.gsub(/\W/, '-'),
+      meta[:ref]&.gsub(/\W/, '-'),
       meta[:date],
       meta[:sha][0..6],
       "macOS-#{OS.version}",
       OS.arch
-    ]
+    ].compact
 
     filename = "Emacs.app-[#{metadata.join('][')}].tbz"
-    target   = "#{builds_dir}/#{filename}"
+    target = "#{builds_dir}/#{filename}"
 
     app_base = File.basename(app)
-    app_dir  = File.dirname(app)
+    app_dir = File.dirname(app)
 
     if !File.exist?(target)
       info "Creating #{filename} archive in \"#{builds_dir}\"..."
@@ -399,11 +396,13 @@ class Build
     err "Failed to get commit info about: #{ref_sha}" if commit_json.nil?
 
     commit = JSON.parse(commit_json)
-
-    @meta = {
+    meta = {
       sha: commit['sha'],
       date: Date.parse(commit['commit']['committer']['date'])
     }
+    meta[:ref] = ref if ref && ref[0..6] != meta[:sha][0..6]
+
+    @meta = meta
   end
 
   def http_get(url)
@@ -418,35 +417,19 @@ class Build
     system(*args) || err("Exit code: #{$CHILD_STATUS.exitstatus}")
   end
 
-  def apply_native_comp_macos_fixes
-    filename = 'Makefile.in'
-    pattern = /^src: Makefile\n(.*BIN_DESTDIR.*)\nblessmail: Makefile src\n/m
-    content = File.read(filename).gsub(pattern) do
-      old_src_body = Regexp.last_match(1).strip
+  def apply_native_comp_env_setup_patch(source)
+    term = 'native-compile-setup-environment-variables'
+    file = 'lisp/emacs-lisp/comp.el'
+    return if `grep '#{term}' '#{file}'`.strip.size.positive?
 
-      # check if already patched
-      if old_src_body.include?('BIN_DESTDIR=\'${ns_appbindir}/\'')
-        return old_src_body
-      end
+    template = File.read(
+      File.join(__dir__, 'patches/native-comp-env-setup.diff.erb')
+    )
+    patch = ERB.new(template).result(gcc_info.get_binding)
+    patch_file = File.join(source, 'macos_patches/native-comp-env-setup.diff')
 
-      self_contained = old_src_body.gsub(
-        'BIN_DESTDIR=\'$(DESTDIR)${bindir}/\'',
-        'BIN_DESTDIR=\'${ns_appbindir}/\''
-      )
-
-      <<~REPLACEMENT
-        src: Makefile
-        ifeq (${ns_self_contained},no)
-        \t#{old_src_body}
-        else
-        \t#{self_contained}
-        endif
-
-        blessmail: Makefile src
-      REPLACEMENT
-    end
-
-    File.open(filename, 'w') { |f| f.write(content) }
+    File.write(patch_file, patch)
+    apply_patch({ file: patch_file }, source)
   end
 
   def effective_version
@@ -513,11 +496,14 @@ class Build
   def apply_patch(patch, target)
     err "\"#{target}\" does not exist." unless File.exist?(target)
 
-    if patch[:url]
+    if patch[:file]
+      info 'Applying patch...'
+      FileUtils.cd(target) { run_cmd('patch', '-f', '-p1', '-i', patch[:file]) }
+    elsif patch[:url]
       patch_dir = "#{target}/macos_patches"
       run_cmd('mkdir', '-p', patch_dir)
 
-      patch_file = "#{patch_dir}/patch-{num}.diff"
+      patch_file = File.join(patch_dir, 'patch-{num}.diff')
       num = 1
       while File.exist?(patch_file.gsub('{num}', num.to_s.rjust(3, '0')))
         num += 1
@@ -527,8 +513,7 @@ class Build
       info "Downloading patch: #{patch[:url]}"
       run_cmd('curl', '-L#', patch[:url], '-o', patch_file)
 
-      info 'Applying patch...'
-      FileUtils.cd(target) { run_cmd('patch', '-f', '-p1', '-i', patch_file) }
+      apply_patch({ file: patch_file }, target)
     elsif patch[:replace]
       err 'Patch replace input error' unless patch[:replace].size == 3
 
@@ -561,16 +546,16 @@ class AbstractEmbedder
 
   private
 
+  def invocation_dir
+    File.join(app, 'Contents/MacOS')
+  end
+
   def bin
-    "#{app}/Contents/MacOS/Emacs"
+    File.join(invocation_dir, 'Emacs')
   end
 
   def lib_dir
-    "#{app}/Contents/MacOS/#{lib_dir_name}"
-  end
-
-  def lib_dir_name
-    "lib-#{OS.arch}-#{OS.version.to_s.tr('.', '_')}"
+    File.join(invocation_dir, 'lib')
   end
 end
 
@@ -613,18 +598,18 @@ class LibEmbedder < AbstractEmbedder
       while_writable(exe) do
         if match[2] == exe_file
           system('install_name_tool', '-id',
-                 "@executable_path/#{rel_path}/#{match[2]}", exe)
+                 File.join('@executable_path', rel_path, match[2].to_s), exe)
         else
           system('install_name_tool', '-change', match[1],
-                 "@executable_path/#{rel_path}/#{match[2]}", exe)
+                 File.join('@executable_path', rel_path, match[2].to_s), exe)
         end
       end
 
-      next if match[2] == exe_file || File.exist?("#{lib_dir}/#{match[2]}")
+      next if match[2] == exe_file || File.exist?(File.join(lib_dir, match[2]))
 
       FileUtils.mkdir_p(lib_dir)
       FileUtils.cp(match[1], lib_dir)
-      copy_libs("#{lib_dir}/#{match[2]}", rel_path)
+      copy_libs(File.join(lib_dir, match[2].to_s), rel_path)
     end
   end
 
@@ -643,7 +628,7 @@ class LibEmbedder < AbstractEmbedder
 
       while_writable(target) do
         system('install_name_tool', '-id',
-               "@executable_path/#{rel_path}/#{lib_file}", target)
+               File.join('@executable_path', rel_path, lib_file), target)
       end
 
       copy_libs(target, rel_path)
@@ -667,7 +652,7 @@ class LibEmbedder < AbstractEmbedder
         while_writable(bin_path) do
           system(
             'install_name_tool', '-change', match[1],
-            "@executable_path/#{rel_path}/#{match[2]}",
+            File.join('@executable_path', rel_path, match[2].to_s),
             bin_path
           )
         end
@@ -683,12 +668,12 @@ class LibEmbedder < AbstractEmbedder
   end
 end
 
-class LibGccJitEmbedder < AbstractEmbedder
-  attr_reader :gcc_dir
+class GccLibEmbedder < AbstractEmbedder
+  attr_reader :gcc_info
 
-  def initialize(app, gcc_dir)
+  def initialize(app, gcc_info)
     super(app)
-    @gcc_dir = gcc_dir
+    @gcc_info = gcc_info
   end
 
   def embed
@@ -698,176 +683,199 @@ class LibGccJitEmbedder < AbstractEmbedder
     end
 
     info 'Embedding libgccjit into Emacs.app'
-    if gcc_version.empty?
-      err "No suitable GCC lib with libgccjit found in #{gcc_dir}"
+
+    if gcc_info.lib_dir.empty?
+      err "No suitable GCC lib dir found in #{gcc_info.root_dir}"
     end
 
     FileUtils.mkdir_p(File.dirname(target_dir))
     FileUtils.cp_r(source_dir, target_dir)
+    FileUtils.rm(Dir[File.join(target_dir, '**/.DS_Store')], force: true)
   end
 
   private
 
   def embedded?
-    Dir[File.join(target_dir, 'libgccjit.so*')].any?
+    Dir[File.join(target_dir, 'libgcc*')].any?
   end
 
   def target_dir
-    File.join(lib_dir, 'gcc', gcc_version)
-  end
-
-  def gcc_version
-    @gcc_version ||= Dir[File.join(gcc_dir, 'lib', 'gcc', '*', 'libgccjit.so*')]
-                     .map { |path| File.dirname(path) }
-                     .select { |path| path.match(%r{/\d+$}) }
-                     .uniq
-                     .map { |dir| File.basename(dir).to_i }
-                     .max
-                     .to_s
+    File.join(invocation_dir, gcc_info.relative_lib_dir)
   end
 
   def source_dir
-    @source_dir ||= File.join(gcc_dir, 'lib', 'gcc', gcc_version)
+    gcc_info.lib_dir
   end
 end
 
-class LauncherEmbedder < AbstractEmbedder
-  attr_reader :template
+class GccInfo
+  include Output
 
-  def initialize(app, template)
-    super(app)
-
-    @template = template
+  def root_dir
+    @root_dir ||= `brew --prefix gcc`.chomp
   end
 
-  def embed
-    if embedded?
-      info 'Launcher script already embedded in Emacs.app'
-      return
+  def major_version
+    @major_version ||= File.basename(lib_dir)
+  end
+
+  def lib_dir
+    @lib_dir ||= Dir[File.join(root_dir, 'lib/gcc/*/libgcc*')]
+                 .map { |path| File.dirname(path) }
+                 .select { |path| File.basename(path).match(/^\d+$/) }
+                 .max_by { |path| File.basename(path).to_i }
+  end
+
+  def relative_lib_dir
+    @relative_lib_dir ||= relative_dir(lib_dir, root_dir)
+  end
+
+  def darwin_lib_dir
+    @darwin_lib_dir ||= Dir[
+      File.join(lib_dir, 'gcc/*apple-darwin*/*')
+    ].max_by do |path|
+      [
+        File.basename(File.dirname(path)).match(/darwin(\d+)$/)[1].to_i,
+        File.basename(path).split('.').map(&:to_i)
+      ]
+    end
+  end
+
+  def relative_darwin_lib_dir
+    @relative_darwin_lib_dir ||= relative_dir(darwin_lib_dir, root_dir)
+  end
+
+  def libgccjit_root_dir
+    @libgccjit_root_dir ||= `brew --prefix libgccjit`.chomp
+  end
+
+  def libgccjit_major_version
+    @libgccjit_major_version ||= File.basename(libgccjit_lib_dir.to_s)
+  end
+
+  def libgccjit_lib_dir
+    @libgccjit_lib_dir ||= Dir[
+      File.join(libgccjit_root_dir, 'lib/gcc/*/libgccjit.so*')
+    ]
+                           .map { |path| File.dirname(path) }
+                           .select { |path| File.basename(path).match(/^\d+$/) }
+                           .max_by { |path| File.basename(path).to_i }
+  end
+
+  def verify_libgccjit
+    err 'gcc not installed' unless Dir.exist?(root_dir)
+    err 'libgccjit not installed' unless Dir.exist?(libgccjit_root_dir)
+
+    if libgccjit_lib_dir&.empty?
+      err "Detected libgccjit (#{libgccjit_root_dir}) does not have any " \
+          'libgccjit.so* files. Please try reinstalling libgccjit: ' \
+          'brew reinstall libgccjit'
     end
 
-    info 'Embedding launcher script into Emacs.app'
+    return if major_version == libgccjit_major_version
 
-    unless File.exist?("#{bin}#{bin_suffix}")
-      FileUtils.mv(bin, "#{bin}#{bin_suffix}")
-    end
+    err <<~TEXT
+      Detected GCC and libgccjit library paths do not belong to the same major
+      version of GCC. Detected paths:
+        - #{lib_dir}
+        - #{libgccjit_lib_dir}
+    TEXT
+  end
 
-    unless File.exist?("#{bin}#{bin_suffix}#{dump_ext}")
-      FileUtils.mv("#{bin}#{dump_ext}", "#{bin}#{bin_suffix}#{dump_ext}")
-    end
-
-    unless File.exist?(bin)
-      File.write(bin, launcher)
-      File.chmod(0o775, bin)
-    end
+  def get_binding
+    binding
   end
 
   private
 
-  def bin_suffix
-    '-bin'
-  end
+  def relative_dir(path, root)
+    root += '/' unless root[-1] == '/'
+    return if path[0..root.size - 1] != root
 
-  def dump_ext
-    '.pdmp'
-  end
-
-  def embedded?
-    File.exist?(bin) &&
-      File.exist?("#{bin}#{bin_suffix}") &&
-      File.exist?("#{bin}#{bin_suffix}#{dump_ext}")
-  end
-
-  def launcher
-    @launcher ||= ERB.new(File.read(template)).result(binding)
-  end
-
-  def library_paths
-    @library_paths ||= Dir[
-      "#{lib_dir}/gcc/*",
-      "#{lib_dir}/gcc/*/gcc/*apple-darwin*/*"
-    ].map do |p|
-      p.gsub(/^#{Regexp.escape(lib_dir + '/')}/, '')
-    end.sort_by { |p| [p.size, p] }
+    path[root.size..-1]
   end
 end
 
 if __FILE__ == $PROGRAM_NAME
   cli_options = {
-    macos_fixes: true,
-    native_fast_boot: true,
+    native_full_aot: false,
     parallel: Etc.nprocessors,
     rsvg: false,
     xwidgets: true
   }
 
-  OptionParser.new do |opts|
-    opts.banner = <<~DOC
-      Usage: ./build-emacs-for-macos [options] <branch/tag/sha>
-
-      Branch, tag, and SHA are from the emacs-mirror/emacs/emacs Github repo,
-      available here: https://github.com/emacs-mirror/emacs
-
-      Options:
-    DOC
-
-    opts.on('-j', '--parallel COUNT',
-            'Compile using COUNT parallel processes ' \
-            "(detected: #{cli_options[:parallel]})") do |v|
-      cli_options[:parallel] = v
-    end
-
-    opts.on('--git-sha SHA', 'Override detected git SHA of specified branch ' \
-                             'allowing builds of old commits') do |v|
-      cli_options[:git_sha] = v
-    end
-
-    opts.on('--[no-]xwidgets',
-            'Enable/disable XWidgets ' \
-            '(default: enabled)') do |v|
-      cli_options[:xwidgets] = v
-    end
-
-    opts.on('--[no-]native-comp',
-            'Enable/disable native-comp ' \
-            '(default: enabled if supported)') do |v|
-      cli_options[:native_comp] = v
-    end
-
-    opts.on('--[no-]native-fast-boot',
-            'Enable/disable NATIVE_FAST_BOOT ' \
-            '(default: enabled if native-comp supported)') do |v|
-      cli_options[:native_fast_boot] = v
-    end
-
-    opts.on('--[no-]native-comp-macos-fixes',
-            'Enable/disable fix based on feature/native-comp-macos-fixes ' \
-            'branch (default: enabled if native-comp supported)') do |v|
-      cli_options[:macos_fixes] = v
-    end
-
-    opts.on('--[no-]launcher',
-            'Enable/disable embedded launcher script  ' \
-            '(default: enabled if native-comp is enabled)') do |v|
-      cli_options[:launcher] = v
-    end
-
-    opts.on('--rsvg', 'Enable SVG image support via librsvg, ' \
-                      'can yield a unstable build (default: disabled)') do
-      cli_options[:rsvg] = true
-    end
-
-    opts.on('--no-titlebar', 'Apply no-titlebar patch (default: disabled)') do
-      cli_options[:no_titlebar] = true
-    end
-
-    opts.on('--no-frame-refocus',
-            'Apply no-frame-refocus patch (default: disabled)') do
-      cli_options[:no_frame_refocus] = true
-    end
-  end.parse!
-
   begin
+    OptionParser.new do |opts|
+      opts.banner = <<~DOC
+        Usage: ./build-emacs-for-macos [options] <branch/tag/sha>
+
+        Branch, tag, and SHA are from the emacs-mirror/emacs/emacs Github repo,
+        available here: https://github.com/emacs-mirror/emacs
+
+        Options:
+      DOC
+
+      opts.on('-j', '--parallel COUNT',
+              'Compile using COUNT parallel processes ' \
+              "(detected: #{cli_options[:parallel]})") do |v|
+        cli_options[:parallel] = v
+      end
+
+      opts.on('--git-sha SHA', 'Override detected git SHA of specified ' \
+                               'branch allowing builds of old commits') do |v|
+        cli_options[:git_sha] = v
+      end
+
+      opts.on('--[no-]xwidgets',
+              'Enable/disable XWidgets ' \
+              '(default: enabled if supported)') do |v|
+        cli_options[:xwidgets] = v
+      end
+
+      opts.on('--[no-]native-comp',
+              'Enable/disable native-comp ' \
+              '(default: enabled if supported)') do |v|
+        cli_options[:native_comp] = v
+      end
+
+      opts.on('--[no-]native-full-aot',
+              'Enable/disable NATIVE_FULL_AOT / Ahead of Time compilation ' \
+              '(default: disabled)') do |v|
+        cli_options[:native_full_aot] = v
+      end
+
+      opts.on('--rsvg', 'Enable SVG image support via librsvg, ' \
+                        'can yield a unstable build (default: disabled)') do
+        cli_options[:rsvg] = true
+      end
+
+      opts.on('--no-titlebar', 'Apply no-titlebar patch (default: disabled)') do
+        cli_options[:no_titlebar] = true
+      end
+
+      opts.on('--no-frame-refocus',
+              'Apply no-frame-refocus patch (default: disabled)') do
+        cli_options[:no_frame_refocus] = true
+      end
+
+      opts.on('--[no-]native-fast-boot',
+              'DEPRECATED: use --[no-]native-full-aot instead') do |v|
+        if v
+          raise Error, '--native-fast-boot option is deprecated, ' \
+                       'use --no-native-full-aot instead'
+        else
+          raise Error, '--no-native-fast-boot option is deprecated, ' \
+                       'use --native-full-aot instead'
+        end
+      end
+
+      opts.on('--[no-]launcher',
+              'DEPRECATED: Launcher script is no longer used.') do |_|
+        raise Error, '--[no-]launcher option is deprecated, launcher ' \
+                     'script is no longer used.'
+      end
+    end.parse!
+
     Build.new(File.expand_path(__dir__), ARGV.shift, cli_options).build
   rescue Error => e
     warn "ERROR: #{e.message}"

install-patched-gcc

@@ -1,27 +0,0 @@
-#! /usr/bin/env bash
-set -e
-
-brewdir="$(brew --prefix)"
-formula="${brewdir}/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/gcc.rb"
-
-if [ ! -f "$formula" ]; then
-  echo "ERROR: ${formula} does not exist." 1>&2
-  exit 1
-fi
-
-gnubins=(
-  "${brewdir}/opt/coreutils/libexec/gnubin"
-  "${brewdir}/opt/make/libexec/gnubin"
-  "${brewdir}/opt/gnu-sed/libexec/gnubin"
-)
-
-for gnubin in "${gnubins[@]}"; do
-  if [ -d "$gnubin" ]; then
-    export PATH="${gnubin}:$PATH"
-  fi
-done
-
-cp "$formula" ./Formula/
-
-patch -f -p1 -i ./Formula/gcc.rb.patch
-brew install ./Formula/gcc.rb --build-from-source --force

launcher.bash.erb

@@ -1,65 +0,0 @@
-#!/bin/bash
-# This launcher script is not part of Emacs proper. It is from the
-# build-emacs-for-macos project (https://github.com/jimeh/build-emacs-for-macos)
-# and helps facilitate proper startup of Emacs with environment varibales set as
-# needed.
-#
-# Licensed under CC0 1.0 Universal:
-# https://creativecommons.org/publicdomain/zero/1.0/
-#
-set -e
-
-resolve_link() {
-  local file="$1"
-
-  while [ -L "$file" ]; do
-    file="$(readlink "$file")"
-  done
-
-  echo "$file"
-}
-
-realname() {
-  local path="$1"
-  local resolved
-  local cwd
-
-  cwd="$(pwd)"
-  resolved="$(resolve_link "$path")"
-  cd "$(dirname "$resolved")"
-  echo "$(pwd)/$(basename "$resolved")"
-  cd "$cwd"
-}
-
-join() {
-  local IFS="$1"
-  local parts=()
-  shift
-
-  for arg in "$@"; do
-    if [ "$arg" != "" ]; then
-      parts+=("$arg")
-    fi
-  done
-
-  echo "${parts[*]}"
-}
-
-DIR="$(dirname "$(realname "$0")")"
-BIN="${DIR}/Emacs<%= bin_suffix %>"
-
-export PATH="${DIR}/bin:${DIR}/libexec:${PATH}"
-<% if library_paths.any? %>
-LIB_PATHS=(
-  '<%= library_paths.map { |p| p.gsub('\'', "\"'\"") }.join("'\n  '") %>'
-)
-for lib in "${LIB_PATHS[@]}"; do
-  if [ -d "${DIR}/<%= lib_dir_name %>/${lib}" ]; then
-    libs="$(join : "$libs" "${DIR}/<%= lib_dir_name %>/${lib}")"
-  fi
-done
-
-LIBRARY_PATH="$(join : "$libs" "$LIBRARY_PATH")"
-export LIBRARY_PATH
-<% end %>
-exec "$BIN" "$@"

patches/native-comp-env-setup.diff.erb

@@ -0,0 +1,57 @@
+diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el
+index 4036080976..2ff8dbd74c 100644
+--- a/lisp/emacs-lisp/comp.el
++++ b/lisp/emacs-lisp/comp.el
+@@ -4079,6 +4079,52 @@ of (commands) to run simultaneously."
+   (let ((load (not (not load))))
+     (native--compile-async paths recursively load selector)))
+ 
++;;;###autoload
++(defun native-compile-setup-environment-variables (&rest _args)
++  "Ensure LIBRARY_PATH is set correctly when libgccjit is bundled."
++  (when (and (eq system-type 'darwin)
++             (string-match-p "\.app\/Contents\/MacOS\/?$"
++                             invocation-directory))
++    (let* ((library-path-env (getenv "LIBRARY_PATH"))
++           (devtools-dir
++            "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib")
++           (gcc-dir (expand-file-name
++                     "<%= relative_lib_dir %>"
++                     invocation-directory))
++           (darwin-dir (expand-file-name
++                        "<%= relative_darwin_lib_dir %>"
++                        invocation-directory))
++           (lib-paths (list)))
++
++      (if library-path-env
++          (push library-path-env lib-paths))
++      (if (file-directory-p devtools-dir)
++          (push devtools-dir lib-paths))
++      (push darwin-dir lib-paths)
++      (push gcc-dir lib-paths)
++
++      (setenv "LIBRARY_PATH" (mapconcat 'identity lib-paths ":"))))
++
++  ;; Remove advice, as it only needs to run once.
++  (advice-remove 'native-compile
++                 'native-compile-setup-environment-variables)
++  (advice-remove 'comp--native-compile
++                 'native-compile-setup-environment-variables)
++  (advice-remove 'native-compile-async
++                 'native-compile-setup-environment-variables)
++  (advice-remove 'native--compile-async
++                 'native-compile-setup-environment-variables))
++
++;; Ensure environment setup runs before any native compilation.
++(advice-add 'native-compile :before
++            'native-compile-setup-environment-variables)
++(advice-add 'comp--native-compile :before
++            'native-compile-setup-environment-variables)
++(advice-add 'native-compile-async :before
++            'native-compile-setup-environment-variables)
++(advice-add 'native--compile-async :before
++            'native-compile-setup-environment-variables)
++
+ (provide 'comp)
+ 
+ ;;; comp.el ends here