chore(release): 0.6.24

It seems homebrew bottle of GCC for macOS Monterey (12.0) have changed their
directory structure slightly, which caused an issue were we were trying
to rename a specific directory to the same name it already had.

This behavior is still required as it looks like GCC on macOS
Catalina (10.15), the GCC homebrew bottle still uses the old directory
structure.

CHANGELOG.md

@@ -2,6 +2,55 @@
 
 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.6.24](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.23...v0.6.24) (2021-11-24)
+
+
+### Bug Fixes
+
+* **embedding:** embedding GCC fails when paths do not require sanitizing ([8a467b0](https://github.com/jimeh/build-emacs-for-macos/commit/8a467b0d43140f6956d53c27e2319ae1b572868c))
+
+### [0.6.23](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.22...v0.6.23) (2021-11-10)
+
+
+### Bug Fixes
+
+* **build:** do not re-link eln files by default ([d338c13](https://github.com/jimeh/build-emacs-for-macos/commit/d338c136db8acc4378154cf66ed7db5462787602)), closes [#60](https://github.com/jimeh/build-emacs-for-macos/issues/60)
+
+### [0.6.22](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.21...v0.6.22) (2021-11-10)
+
+
+### Features
+
+* **patch:** add support for posix-spawn patch from emacs-plus ([4030ceb](https://github.com/jimeh/build-emacs-for-macos/commit/4030ceb9cab6749af3c28161ac97caec90a8aed0))
+
+### [0.6.21](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.20...v0.6.21) (2021-10-27)
+
+### [0.6.20](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.19...v0.6.20) (2021-10-23)
+
+
+### Bug Fixes
+
+* **notarization:** explicitly only copy *.c and *.h C source files ([591c39e](https://github.com/jimeh/build-emacs-for-macos/commit/591c39e629c9556adcf296cd5c15dd0b17c4d986))
+
+### [0.6.19](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.18...v0.6.19) (2021-10-23)
+
+
+### Bug Fixes
+
+* **patch:** resolve emacs-29 symlink patches to their real URL ([bcbd017](https://github.com/jimeh/build-emacs-for-macos/commit/bcbd01778d416b99205c51f348a543489889f66d))
+
+### [0.6.18](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.17...v0.6.18) (2021-10-23)
+
+
+### Features
+
+* **docs:** embed C source files and set source-directory accordingly ([67b8c5f](https://github.com/jimeh/build-emacs-for-macos/commit/67b8c5f3974e178e31519846d46af82d9770ad6e))
+
+
+### Bug Fixes
+
+* **patches:** correctly use emacs 28.x and 29.x patches ([4dad581](https://github.com/jimeh/build-emacs-for-macos/commit/4dad5812fa2b67adc7262a778829013995a904bc))
+
 ### [0.6.17](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.16...v0.6.17) (2021-10-10)
 
 

README.md

@@ -81,8 +81,10 @@ Options:
         --[no-]native-comp           Enable/disable native-comp (default: enabled if supported)
         --[no-]native-march          Enable/disable -march=native CFLAG(default: disabled)
         --[no-]native-full-aot       Enable/disable NATIVE_FULL_AOT / Ahead of Time compilation (default: disabled)
+        --[no-]relink-eln-files      Enable/disable re-linking shared libraries in bundled *.eln files (default: disabled)
         --[no-]rsvg                  Enable/disable SVG image support via librsvg (default: enabled)
         --no-titlebar                Apply no-titlebar patch (default: disabled)
+        --posix-spawn                Apply posix-spawn patch (default: disabled)
         --no-frame-refocus           Apply no-frame-refocus patch (default: disabled)
         --[no-]github-auth           Make authenticated GitHub API requests if GITHUB_TOKEN environment variable is set.(default: enabled)
         --work-dir DIR               Specify a working directory where tarballs, sources, and builds will be stored and worked with
@@ -90,7 +92,8 @@ Options:
         --build-name NAME            Override generated build name
         --dist-include x,y,z         List of extra files to copy from Emacs source into build folder/archive (default: COPYING)
         --[no-]archive               Enable/disable creating *.tbz archive (default: enabled)
-        --[no-]archive-keep          Enable/disable keeping source folder for archive (default: disabled)
+        --[no-]archive-keep-build-dir
+                                     Enable/disable keeping source folder for archive (default: disabled)
         --plan FILE                  Follow given plan file, instead of using given git ref/sha
 ```
 

build-emacs-for-macos

@@ -105,8 +105,9 @@ class Build
     build_dir, app = create_build_dir(app)
 
     handle_native_lisp(app)
-    add_cli_helper(app)
 
+    CLIHelperEmbedder.new(app).embed
+    CSourcesEmbedder.new(app, @source_dir).embed
     LibEmbedder.new(app, brew_dir, extra_libs, options[:relink_eln]).embed
     GccLibEmbedder.new(app, gcc_info).embed if options[:native_comp]
 
@@ -285,8 +286,6 @@ class Build
         verify_native_comp
         gcc_info.verify_libgccjit
 
-        apply_native_comp_env_setup_patch(source)
-
         ENV['CFLAGS'] = [
           "-I#{File.join(gcc_info.root_dir, 'include')}",
           "-I#{File.join(gcc_info.libgccjit_root_dir, 'include')}",
@@ -505,18 +504,6 @@ class Build
     end
   end
 
-  def add_cli_helper(app)
-    source = File.join(__dir__, 'helper', 'emacs-cli.bash')
-    target = File.join(app, 'Contents', 'MacOS', 'bin', 'emacs')
-    dir = File.dirname(target)
-
-    info "Adding \"emacs\" CLI helper to #{dir}"
-
-    FileUtils.mkdir_p(dir)
-    FileUtils.cp(source, target)
-    FileUtils.chmod('+w', target)
-  end
-
   def build_name
     return @build_name if @build_name
     return @build_name = options[:build_name] if options[:build_name]
@@ -618,21 +605,6 @@ class Build
     system(*args) || err("Exit code: #{$CHILD_STATUS.exitstatus}")
   end
 
-  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?
-
-    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')
-
-    File.write(patch_file, patch)
-    apply_patch({ file: patch_file }, source)
-  end
-
   def effective_version
     @effective_version ||= begin
       case ref
@@ -640,8 +612,10 @@ class Build
         'emacs-26'
       when /^emacs-27.*/
         'emacs-27'
-      else
+      when /^emacs-28.*/
         'emacs-28'
+      else
+        'emacs-29'
       end
     end
   end
@@ -649,14 +623,14 @@ class Build
   def patches(opts = {})
     p = []
 
-    if %w[emacs-26 emacs-27 emacs-28].include?(effective_version)
+    if %w[emacs-26 emacs-27 emacs-28 emacs-29].include?(effective_version)
       p << {
         url: 'https://github.com/d12frosted/homebrew-emacs-plus/raw/master/' \
              "patches/#{effective_version}/fix-window-role.patch"
       }
     end
 
-    if %w[emacs-27 emacs-28].include?(effective_version)
+    if %w[emacs-27 emacs-28 emacs-29].include?(effective_version)
       p << {
         url: 'https://github.com/d12frosted/homebrew-emacs-plus/raw/master/' \
              "patches/#{effective_version}/system-appearance.patch"
@@ -677,6 +651,15 @@ class Build
       end
     end
 
+    if %w[emacs-28 emacs-29].include?(effective_version)
+      if options[:posix_spawn]
+        p << {
+          url: 'https://github.com/d12frosted/homebrew-emacs-plus/raw/master/' \
+               "patches/#{effective_version}/posix-spawn.patch"
+        }
+      end
+    end
+
     if effective_version == 'emacs-27'
       p << {
         url: 'https://github.com/d12frosted/homebrew-emacs-plus/raw/master/' \
@@ -714,7 +697,14 @@ class Build
       info "Downloading patch: #{patch[:url]}"
       run_cmd('curl', '-L#', patch[:url], '-o', patch_file)
 
-      apply_patch({ file: patch_file }, target)
+      real_patch_url = detect_github_symlink_patch(patch[:url], patch_file)
+      if real_patch_url
+        FileUtils.rm(patch_file)
+        apply_patch({ url: real_patch_url }, target)
+      else
+        apply_patch({ file: patch_file }, target)
+      end
+
     elsif patch[:replace]
       err 'Patch replace input error' unless patch[:replace].size == 3
 
@@ -732,6 +722,30 @@ class Build
       f.close
     end
   end
+
+  # When downloading raw files from GitHub, if the target file is a symlink, it
+  # will return the actual target path of the symlink instead of the content of
+  # the target file. Hence we have to check if the patch file we have downloaded
+  # contains one and only one line, and if so, assume it's a symlink.
+  def detect_github_symlink_patch(original_url, patch_file)
+    lines = []
+
+    # read first two lines
+    File.open(patch_file) do |f|
+      lines << f.gets
+      lines << f.gets
+    end
+
+    # if the file contains more than one line of text, it's not a symlink.
+    return unless lines[1].nil?
+
+    symlink_target = lines[0].strip
+    # Assume patch file content is something along the lines of
+    # "../emacs-28/fix-window-role.patch", hence we resolve it relative to the
+    # original url.
+    info "patch is symlink to #{symlink_target}"
+    URI.join(original_url, symlink_target).to_s
+  end
 end
 
 class AbstractEmbedder
@@ -753,9 +767,71 @@ class AbstractEmbedder
     File.join(invocation_dir, 'Emacs')
   end
 
+  def bin_dir
+    File.join(invocation_dir, 'bin')
+  end
+
   def lib_dir
     File.join(invocation_dir, 'lib')
   end
+
+  def resources_dir
+    File.join(app, 'Contents', 'Resources')
+  end
+end
+
+class CLIHelperEmbedder < AbstractEmbedder
+  def embed
+    source = File.join(__dir__, 'helper', 'emacs-cli.bash')
+    target = File.join(bin_dir, 'emacs')
+    dir = File.dirname(target)
+
+    info "Adding \"emacs\" CLI helper to #{dir}"
+
+    FileUtils.mkdir_p(dir)
+    FileUtils.cp(source, target)
+    FileUtils.chmod('+w', target)
+  end
+end
+
+class CSourcesEmbedder < AbstractEmbedder
+  PATH_PATCH = <<~ELISP
+    ;; Allow Emacs to find bundled C sources.
+    (setq source-directory (expand-file-name ".."))
+  ELISP
+
+  attr_reader :source_dir
+
+  def initialize(app, source_dir)
+    super(app)
+
+    @source_dir = source_dir
+  end
+
+  def embed
+    info 'Embedding C source files into Emacs.app for documentation purposes'
+
+    src_dir = File.join(source_dir, 'src')
+    Dir[File.join(src_dir, '**', '*.{c,h}')].each do |f|
+      rel = f[src_dir.size + 1..-1]
+      target = File.join(resources_dir, 'src', rel)
+      FileUtils.mkdir_p(File.dirname(target))
+      FileUtils.cp(f, target)
+    end
+
+    return if File.exist?(site_start_el_file) &&
+              File.read(site_start_el_file).include?(PATH_PATCH)
+
+    File.open(site_start_el_file, 'a') do |f|
+      f.puts("\n#{PATH_PATCH}")
+    end
+  end
+
+  private
+
+  def site_start_el_file
+    @site_start_el_file ||= File.join(resources_dir, 'lisp', 'site-start.el')
+  end
 end
 
 class LibEmbedder < AbstractEmbedder
@@ -890,11 +966,48 @@ class GccLibEmbedder < AbstractEmbedder
     FileUtils.cp_r(source_dir, target_dir)
     FileUtils.rm(Dir[File.join(target_dir, '**', '.DS_Store')], force: true)
     FileUtils.chmod_R('u+w', target_dir)
-    FileUtils.mv(source_darwin_dir, target_darwin_dir)
+    if source_darwin_dir != target_darwin_dir
+      FileUtils.mv(source_darwin_dir, target_darwin_dir)
+    end
+
+    env_setup = ERB.new(NATIVE_COMP_ENV_VAR_TPL).result(gcc_info.get_binding)
+    return if File.exist?(site_start_el_file) &&
+              File.read(site_start_el_file).include?(env_setup)
+
+    File.open(site_start_el_file, 'a') do |f|
+      f.puts("\n#{env_setup}")
+    end
   end
 
   private
 
+  NATIVE_COMP_ENV_VAR_TPL = <<~ELISP
+    ;; Set LIBRARY_PATH to point at bundled GCC and Xcode Command Line Tools to
+    ;; ensure native-comp works.
+    (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
+                       "<%= app_bundle_relative_lib_dir %>"
+                       invocation-directory))
+             (darwin-dir (expand-file-name
+                          "<%= app_bundle_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 ":"))))
+  ELISP
+
   def embedded?
     Dir[File.join(target_dir, 'libgcc*')].any?
   end
@@ -918,6 +1031,10 @@ class GccLibEmbedder < AbstractEmbedder
   def relative_dir(path, root)
     Pathname.new(path).relative_path_from(Pathname.new(root)).to_s
   end
+
+  def site_start_el_file
+    @site_start_el_file ||= File.join(resources_dir, 'lisp', 'site-start.el')
+  end
 end
 
 class GccInfo
@@ -1038,7 +1155,7 @@ if __FILE__ == $PROGRAM_NAME
   cli_options = {
     work_dir: File.expand_path(__dir__),
     native_full_aot: false,
-    relink_eln: true,
+    relink_eln: false,
     native_march: false,
     parallel: Etc.nprocessors,
     rsvg: true,
@@ -1098,7 +1215,7 @@ if __FILE__ == $PROGRAM_NAME
 
       opts.on('--[no-]relink-eln-files',
               'Enable/disable re-linking shared libraries in bundled *.eln ' \
-              'files (default: enabled)') do |v|
+              'files (default: disabled)') do |v|
         cli_options[:relink_eln] = v
       end
 
@@ -1112,6 +1229,10 @@ if __FILE__ == $PROGRAM_NAME
         cli_options[:no_titlebar] = true
       end
 
+      opts.on('--posix-spawn', 'Apply posix-spawn patch (default: disabled)') do
+        cli_options[:posix_spawn] = true
+      end
+
       opts.on('--no-frame-refocus',
               'Apply no-frame-refocus patch (default: disabled)') do
         cli_options[:no_frame_refocus] = true

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

@@ -1,57 +0,0 @@
-diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el
-index 638d4b274c..2599211936 100644
---- a/lisp/emacs-lisp/comp.el
-+++ b/lisp/emacs-lisp/comp.el
-@@ -4224,6 +4224,52 @@ native-compile-async
-   (let ((load (not (not load))))
-     (native--compile-async files 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
-+                     "<%= app_bundle_relative_lib_dir %>"
-+                     invocation-directory))
-+           (darwin-dir (expand-file-name
-+                        "<%= app_bundle_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)
- 
- ;; LocalWords: limplified limplified limplification limplify Limple LIMPLE libgccjit elc eln

pkg/cli/cli.go

@@ -46,6 +46,7 @@ func New(version, commit, date string) *CLI {
 			Commands: []*cli2.Command{
 				planCmd(),
 				signCmd(),
+				signFilesCmd(),
 				notarizeCmd(),
 				packageCmd(),
 				releaseCmd(),

pkg/cli/sign.go

@@ -112,3 +112,49 @@ func signAction(c *cli2.Context, opts *Options) error {
 
 	return sign.Emacs(c.Context, app, signOpts)
 }
+
+func signFilesCmd() *cli2.Command {
+	signCmd := signCmd()
+
+	var flags []cli2.Flag
+	for _, f := range signCmd.Flags {
+		n := f.Names()
+		if len(n) > 0 && n[0] == "plan" {
+			continue
+		}
+
+		flags = append(flags, f)
+	}
+
+	return &cli2.Command{
+		Name:      "sign-files",
+		Usage:     "sign files with codesign",
+		ArgsUsage: "<file> [<file>...]",
+		Hidden:    true,
+		Flags:     flags,
+		Action:    actionWrapper(signFilesAction),
+	}
+}
+
+func signFilesAction(c *cli2.Context, opts *Options) error {
+	signOpts := &sign.Options{
+		Identity:    c.String("sign"),
+		Options:     c.StringSlice("options"),
+		Deep:        c.Bool("deep"),
+		Timestamp:   c.Bool("timestamp"),
+		Force:       c.Bool("force"),
+		Verbose:     c.Bool("verbose"),
+		CodeSignCmd: c.String("codesign"),
+	}
+
+	if v := c.StringSlice("entitlements"); len(v) > 0 {
+		e := sign.Entitlements(v)
+		signOpts.Entitlements = &e
+	}
+
+	if !opts.quiet {
+		signOpts.Output = os.Stdout
+	}
+
+	return sign.Files(c.Context, c.Args().Slice(), signOpts)
+}