Created
February 22, 2025 00:42
-
-
Save alphapapa/6349017e67d1816dd639303655a64269 to your computer and use it in GitHub Desktop.
Guix Emacs package definition modified to native-compile external Elisp packages
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ;;; GNU Guix --- Functional package management for GNU | |
| ;;; Copyright © 2013-2017, 2019, 2021-2022 Ludovic Courtès <[email protected]> | |
| ;;; Copyright © 2013 Andreas Enge <[email protected]> | |
| ;;; Copyright © 2014 Taylan Ulrich Bayirli/Kammer <[email protected]> | |
| ;;; Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020 Mark H Weaver <[email protected]> | |
| ;;; Copyright © 2014, 2015, 2016, 2017 Alex Kost <[email protected]> | |
| ;;; Copyright © 2016, 2018 Arun Isaac <[email protected]> | |
| ;;; Copyright © 2016 Federico Beffa <[email protected]> | |
| ;;; Copyright © 2016 David Thompson <[email protected]> | |
| ;;; Copyright © 2016 Nikita <[email protected]> | |
| ;;; Copyright © 2017 Marius Bakke <[email protected]> | |
| ;;; Copyright © 2017, 2019, 2020, 2023, 2024 Maxim Cournoyer <[email protected]> | |
| ;;; Copyright © 2017 Alex Vong <[email protected]> | |
| ;;; Copyright © 2017, 2018 Ricardo Wurmus <[email protected]> | |
| ;;; Copyright © 2017, 2023 Janneke Nieuwenhuizen <[email protected]> | |
| ;;; Copyright © 2018, 2023 Efraim Flashner <[email protected]> | |
| ;;; Copyright © 2018 Mathieu Othacehe <[email protected]> | |
| ;;; Copyright © 2018, 2019, 2021 Tobias Geerinckx-Rice <[email protected]> | |
| ;;; Copyright © 2019 Jesse John Gildersleve <[email protected]> | |
| ;;; Copyright © 2019 Valentin Ignatev <[email protected]> | |
| ;;; Copyright © 2019, 2021 Liliana Marie Prikler <[email protected]> | |
| ;;; Copyright © 2019 Amin Bandali <[email protected]> | |
| ;;; Copyright © 2020 Jack Hill <[email protected]> | |
| ;;; Copyright © 2020 Morgan Smith <[email protected]> | |
| ;;; Copyright © 2022 Zhu Zihao <[email protected]> | |
| ;;; Copyright © 2023 Declan Tsien <[email protected]> | |
| ;;; Copyright © 2023 Zheng Junjie <[email protected]> | |
| ;;; | |
| ;;; This file is part of GNU Guix. | |
| ;;; | |
| ;;; GNU Guix is free software; you can redistribute it and/or modify it | |
| ;;; under the terms of the GNU General Public License as published by | |
| ;;; the Free Software Foundation; either version 3 of the License, or (at | |
| ;;; your option) any later version. | |
| ;;; | |
| ;;; GNU Guix is distributed in the hope that it will be useful, but | |
| ;;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
| ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| ;;; GNU General Public License for more details. | |
| ;;; | |
| ;;; You should have received a copy of the GNU General Public License | |
| ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. | |
| (define-module (gnu packages emacs) | |
| #:use-module ((guix licenses) #:prefix license:) | |
| #:use-module (guix packages) | |
| #:use-module (guix gexp) | |
| #:use-module (guix download) | |
| #:use-module (guix git-download) | |
| #:use-module (guix build-system) | |
| #:use-module (guix build-system gnu) | |
| #:use-module (guix build-system glib-or-gtk) | |
| #:use-module (gnu packages) | |
| #:use-module (gnu packages acl) | |
| #:use-module (gnu packages autotools) | |
| #:use-module (gnu packages base) | |
| #:use-module (gnu packages bash) | |
| #:use-module (gnu packages compression) | |
| #:use-module (gnu packages fontutils) | |
| #:use-module (gnu packages freedesktop) | |
| #:use-module (gnu packages fribidi) | |
| #:use-module (gnu packages gawk) | |
| #:use-module (gnu packages gcc) | |
| #:use-module (gnu packages gd) | |
| #:use-module (gnu packages gettext) | |
| #:use-module (gnu packages ghostscript) | |
| #:use-module (gnu packages glib) | |
| #:use-module (gnu packages gnome) ; for librsvg | |
| #:use-module (gnu packages gtk) | |
| #:use-module (gnu packages guile) | |
| #:use-module (gnu packages image) | |
| #:use-module (gnu packages lesstif) ; motif | |
| #:use-module (gnu packages linux) ; alsa-lib, gpm | |
| #:use-module (gnu packages mail) ; for mailutils | |
| #:use-module (gnu packages multiprecision) | |
| #:use-module (gnu packages ncurses) | |
| #:use-module (gnu packages pdf) | |
| #:use-module (gnu packages pkg-config) | |
| #:use-module (gnu packages selinux) | |
| #:use-module (gnu packages sqlite) | |
| #:use-module (gnu packages texinfo) | |
| #:use-module (gnu packages tls) | |
| #:use-module (gnu packages tree-sitter) | |
| #:use-module (gnu packages web) ; for jansson | |
| #:use-module (gnu packages webkit) | |
| #:use-module (gnu packages xml) | |
| #:use-module (gnu packages xorg) | |
| #:use-module (guix utils) | |
| #:use-module (ice-9 match) | |
| #:use-module (srfi srfi-1) | |
| #:export (emacs->emacs-next)) | |
| (define (%emacs-modules build-system) | |
| (let ((which (build-system-name build-system))) | |
| `((guix build ,(symbol-append which '-build-system)) | |
| (guix build utils) | |
| (srfi srfi-1) | |
| (ice-9 ftw)))) | |
| (define-public emacs-minimal-jit | |
| (package | |
| (name "emacs-minimal-jit") | |
| (version "29.3") | |
| (source (origin | |
| (method url-fetch) | |
| (uri (string-append "mirror://gnu/emacs/emacs-" | |
| version ".tar.xz")) | |
| (sha256 | |
| (base32 | |
| "1822swrk4ifmkd4h9l0h37zifcpa1w3sy3vsgyffsrp6mk9hak63")) | |
| (patches (search-patches ; "emacs-disable-jit-compilation.patch" | |
| "emacs-exec-path.patch" | |
| "emacs-fix-scheme-indent-function.patch" | |
| "emacs-native-comp-driver-options.patch" | |
| ; "emacs-native-comp-fix-filenames.patch" | |
| "emacs-pgtk-super-key-fix.patch")) | |
| (modules '((guix build utils))) | |
| (snippet | |
| '(with-directory-excursion "lisp" | |
| ;; Delete the bundled byte-compiled elisp files and generated | |
| ;; autoloads. | |
| (for-each delete-file | |
| (append (find-files "." "\\.elc$") | |
| (find-files "." "loaddefs\\.el$") | |
| (find-files "eshell" "^esh-groups\\.el$"))) | |
| ;; Make sure Tramp looks for binaries in the right places on | |
| ;; remote Guix System machines, where 'getconf PATH' returns | |
| ;; something bogus. | |
| (substitute* "net/tramp.el" | |
| ;; Patch the line after "(defcustom tramp-remote-path". | |
| (("\\(tramp-default-remote-path") | |
| (format #f "(tramp-default-remote-path ~s ~s ~s ~s " | |
| "~/.guix-profile/bin" "~/.guix-profile/sbin" | |
| "/run/current-system/profile/bin" | |
| "/run/current-system/profile/sbin"))) | |
| ;; Make sure Man looks for C header files in the right | |
| ;; places. | |
| (substitute* "man.el" | |
| (("\"/usr/local/include\"" line) | |
| (string-join | |
| (list line | |
| "\"~/.guix-profile/include\"" | |
| "\"/var/guix/profiles/system/profile/include\"") | |
| " "))))))) | |
| (build-system gnu-build-system) | |
| (arguments | |
| (list | |
| #:tests? #f ; no check target | |
| #:modules (%emacs-modules build-system) | |
| #:configure-flags #~(list "--with-gnutls=no" "--disable-build-details") | |
| #:phases | |
| #~(modify-phases %standard-phases | |
| (add-after 'unpack 'enable-elogind | |
| (lambda _ | |
| (substitute* "configure.ac" | |
| (("libsystemd") "libelogind")) | |
| (when (file-exists? "configure") | |
| (delete-file "configure")))) | |
| (add-after 'unpack 'patch-program-file-names | |
| (lambda* (#:key inputs #:allow-other-keys) | |
| ;; Substitute "sh" command. | |
| (substitute* '("src/callproc.c" | |
| "lisp/term.el" | |
| "lisp/htmlfontify.el" | |
| "lisp/mail/feedmail.el" | |
| "lisp/obsolete/pgg-pgp.el" | |
| "lisp/obsolete/pgg-pgp5.el" | |
| "lisp/obsolete/terminal.el" | |
| "lisp/org/ob-eval.el" | |
| "lisp/textmodes/artist.el" | |
| "lisp/progmodes/sh-script.el" | |
| "lisp/textmodes/artist.el" | |
| "lisp/htmlfontify.el" | |
| "lisp/term.el") | |
| (("\"/bin/sh\"") | |
| (format #f "~s" (search-input-file inputs "bin/sh")))) | |
| (substitute* '("lisp/gnus/mm-uu.el" | |
| "lisp/gnus/nnrss.el" | |
| "lisp/mail/blessmail.el") | |
| (("\"#!/bin/sh\\\n\"") | |
| (format #f "\"#!~a~%\"" (search-input-file inputs "bin/sh")))) | |
| (substitute* '("lisp/jka-compr.el" | |
| "lisp/man.el") | |
| (("\"sh\"") | |
| (format #f "~s" (search-input-file inputs "bin/sh")))) | |
| ;; Substitute "awk" command. | |
| (substitute* '("lisp/gnus/nnspool.el" | |
| "lisp/org/ob-awk.el" | |
| "lisp/man.el") | |
| (("\"awk\"") | |
| (format #f "~s" (search-input-file inputs "bin/awk")))) | |
| ;; Substitute "find" command. | |
| (substitute* '("lisp/gnus/gnus-search.el" | |
| "lisp/obsolete/nnir.el" | |
| "lisp/progmodes/executable.el" | |
| "lisp/progmodes/grep.el" | |
| "lisp/filecache.el" | |
| "lisp/ldefs-boot.el" | |
| "lisp/mpc.el") | |
| (("\"find\"") | |
| (format #f "~s" (search-input-file inputs "bin/find")))) | |
| ;; Substitute "sed" command. | |
| (substitute* "lisp/org/ob-sed.el" | |
| (("org-babel-sed-command \"sed\"") | |
| (format #f "org-babel-sed-command ~s" | |
| (search-input-file inputs "bin/sed")))) | |
| (substitute* "lisp/man.el" | |
| (("Man-sed-command \"sed\"") | |
| (format #f "Man-sed-command ~s" | |
| (search-input-file inputs "bin/sed")))) | |
| (substitute* "lisp/doc-view.el" | |
| (("\"(gs|dvipdf|ps2pdf|pdftotext)\"" all what) | |
| (let ((replacement (false-if-exception | |
| (search-input-file | |
| inputs | |
| (string-append "/bin/" what))))) | |
| (if replacement | |
| (string-append "\"" replacement "\"") | |
| all)))) | |
| ;; match ".gvfs-fuse-daemon-real" and ".gvfsd-fuse-real" | |
| ;; respectively when looking for GVFS processes. | |
| (substitute* "lisp/net/tramp-gvfs.el" | |
| (("\\(tramp-compat-process-running-p \"(.*)\"\\)" all process) | |
| (format #f "(or ~a (tramp-compat-process-running-p ~s))" | |
| all (string-append "." process "-real")))))) | |
| (add-before 'configure 'fix-/bin/pwd | |
| (lambda _ | |
| ;; Use `pwd', not `/bin/pwd'. | |
| (substitute* (find-files "." "^Makefile\\.in$") | |
| (("/bin/pwd") | |
| "pwd")))) | |
| (add-after 'install 'install-site-start | |
| ;; Use 'guix-emacs' in "site-start.el", which is used autoload the | |
| ;; Elisp packages found in EMACSLOADPATH. | |
| (lambda* (#:key inputs outputs #:allow-other-keys) | |
| (let* ((out (assoc-ref outputs "out")) | |
| (lisp-dir (string-append out "/share/emacs/site-lisp")) | |
| (emacs (string-append out "/bin/emacs"))) | |
| ;; This is duplicated from emacs-utils to prevent coupling. | |
| (define* (emacs-byte-compile-directory dir) | |
| (let ((expr `(progn | |
| (setq byte-compile-debug t) | |
| (byte-recompile-directory | |
| (file-name-as-directory ,dir) 0 1)))) | |
| (invoke emacs "--quick" "--batch" | |
| (format #f "--eval=~s" expr)))) | |
| (copy-file #$(local-file | |
| (search-auxiliary-file "emacs/guix-emacs.el")) | |
| (string-append lisp-dir "/guix-emacs.el")) | |
| (with-output-to-file (string-append lisp-dir "/site-start.el") | |
| (lambda () | |
| (display | |
| (string-append | |
| "(when (require 'guix-emacs nil t)\n" | |
| " (guix-emacs-autoload-packages 'no-reload)\n" | |
| " (advice-add 'package-load-all-descriptors" | |
| " :after #'guix-emacs-load-package-descriptors))")))) | |
| ;; Remove the extraneous subdirs.el file, as it causes Emacs to | |
| ;; add recursively all the the sub-directories of a profile's | |
| ;; share/emacs/site-lisp union when added to EMACSLOADPATH, | |
| ;; which leads to conflicts. | |
| (delete-file (string-append lisp-dir "/subdirs.el")) | |
| ;; Byte compile the site-start files. | |
| (emacs-byte-compile-directory lisp-dir)))) | |
| (add-after 'install 'wrap-emacs-paths | |
| (lambda* (#:key inputs outputs #:allow-other-keys) | |
| (let* ((out (assoc-ref outputs "out")) | |
| (lisp-dirs (find-files (string-append out "/share/emacs") | |
| "^lisp$" | |
| #:directories? #t))) | |
| (for-each | |
| (lambda (prog) | |
| (wrap-program prog | |
| ;; Some variants rely on uname being in PATH for Tramp. | |
| ;; Tramp paths can't be hardcoded, because they need to | |
| ;; be portable. | |
| `("PATH" suffix | |
| ,(map dirname | |
| (list (search-input-file inputs "/bin/gzip") | |
| ;; for coreutils | |
| (search-input-file inputs "/bin/yes")))) | |
| `("EMACSLOADPATH" suffix ,lisp-dirs))) | |
| (find-files (string-append out "/bin") | |
| ;; Matches versioned and unversioned emacs binaries. | |
| ;; We don't patch emacsclient, because it takes its | |
| ;; environment variables from emacs. | |
| ;; Likewise, we don't need to patch helper binaries | |
| ;; like etags, ctags or ebrowse. | |
| "^emacs(-[0-9]+(\\.[0-9]+)*)?$"))))) | |
| (add-after 'wrap-emacs-paths 'undo-double-wrap | |
| (lambda* (#:key outputs #:allow-other-keys) | |
| ;; Directly copy emacs-X.Y to emacs, so that it is not wrapped | |
| ;; twice. This also fixes a minor issue, where WMs would not be | |
| ;; able to track emacs back to emacs.desktop. | |
| (with-directory-excursion (assoc-ref outputs "out") | |
| (copy-file | |
| (car (find-files "bin" "^emacs-([0-9]+\\.)+[0-9]+$")) | |
| "bin/emacs"))))))) | |
| (inputs (list bash-minimal coreutils findutils gawk gzip ncurses sed)) | |
| (native-inputs (list autoconf pkg-config texinfo)) | |
| (home-page "https://www.gnu.org/software/emacs/") | |
| (synopsis "The extensible text editor (minimal build for byte-compilation)") | |
| (description | |
| "GNU Emacs is an extensible and highly customizable text editor. It is | |
| based on an Emacs Lisp interpreter with extensions for text editing. Emacs | |
| has been extended in essentially all areas of computing, giving rise to a | |
| vast array of packages supporting, e.g., email, IRC and XMPP messaging, | |
| spreadsheets, remote server editing, and much more. Emacs includes extensive | |
| documentation on all aspects of the system, from basic editing to writing | |
| large Lisp programs. It has full Unicode support for nearly all human | |
| languages.") | |
| (license license:gpl3+) | |
| (native-search-paths | |
| (list (search-path-specification | |
| (variable "EMACSLOADPATH") | |
| (files '("share/emacs/site-lisp"))) | |
| (search-path-specification | |
| (variable "EMACSNATIVELOADPATH") | |
| (files '("lib/emacs/native-site-lisp"))) | |
| (search-path-specification | |
| (variable "INFOPATH") | |
| (files '("share/info"))) | |
| ;; Most variants support tree-sitter, so let's include it here. | |
| (search-path-specification | |
| (variable "TREE_SITTER_GRAMMAR_PATH") | |
| (files '("lib/tree-sitter"))))) | |
| (properties `((upstream-name . "emacs"))))) | |
| (define-public emacs-no-x-jit | |
| (package/inherit emacs-minimal-jit | |
| (name "emacs-no-x-jit") | |
| (synopsis "The extensible, customizable, self-documenting text | |
| editor (console only)") | |
| (arguments | |
| (substitute-keyword-arguments (package-arguments emacs-minimal) | |
| ((#:configure-flags flags #~'()) | |
| #~(cons* "--with-modules" "--with-native-compilation=aot" | |
| (delete "--with-gnutls=no" #$flags))) | |
| ((#:phases phases) | |
| #~(modify-phases #$phases | |
| (add-after 'set-paths 'set-libgccjit-path | |
| (lambda* (#:key inputs #:allow-other-keys) | |
| (define (first-subdirectory/absolute directory) | |
| (let ((files (scandir | |
| directory | |
| (lambda (file) | |
| (and (not (member file '("." ".."))) | |
| (file-is-directory? (string-append | |
| directory "/" | |
| file))))))) | |
| (and (not (null? files)) | |
| (string-append directory "/" (car files))))) | |
| (let* ((libgccjit-libdir | |
| (first-subdirectory/absolute ;; version | |
| (first-subdirectory/absolute ;; host type | |
| (search-input-directory inputs "lib/gcc"))))) | |
| (setenv "LIBRARY_PATH" | |
| (string-append (getenv "LIBRARY_PATH") | |
| ":" libgccjit-libdir))))) | |
| (add-after 'unpack 'patch-compilation-driver | |
| (lambda _ | |
| (substitute* "lisp/emacs-lisp/comp.el" | |
| (("\\(defcustom native-comp-driver-options nil") | |
| (format | |
| #f "(defcustom native-comp-driver-options '(~@{~s~^ ~})" | |
| (string-append | |
| "-B" #$(this-package-input "binutils") "/bin/") | |
| (string-append | |
| "-B" #$(this-package-input "glibc") "/lib/") | |
| (string-append | |
| "-B" #$(this-package-input "libgccjit") "/lib/") | |
| (string-append | |
| "-B" #$(this-package-input "libgccjit") "/lib/gcc/")))))) | |
| (add-after 'build 'build-trampolines | |
| (lambda* (#:key make-flags #:allow-other-keys) | |
| (apply invoke "make" "trampolines" make-flags))) | |
| (add-after 'validate-runpath 'validate-comp-integrity | |
| (lambda* (#:key outputs #:allow-other-keys) | |
| #$(cond | |
| ((%current-target-system) | |
| #~(display "Cannot validate native-comp on cross builds.\n")) | |
| ((member (%current-system) '("armhf-linux" "i686-linux")) | |
| #~(display "Integrity test is broken on armhf.\n")) | |
| (else | |
| #~(invoke | |
| (string-append (assoc-ref outputs "out") "/bin/emacs") | |
| "--batch" | |
| "--load" | |
| #$(local-file | |
| (search-auxiliary-file "emacs/comp-integrity.el")) | |
| "-f" "ert-run-tests-batch-and-exit"))))))))) | |
| (inputs | |
| (modify-inputs (package-inputs emacs-minimal) | |
| (prepend gnutls | |
| ;; To "unshadow" ld-wrapper in native builds | |
| (make-ld-wrapper "ld-wrapper" #:binutils binutils) | |
| ;; For native compilation | |
| binutils | |
| (libc-for-target) | |
| libgccjit | |
| ;; Avoid Emacs's limited movemail substitute that retrieves POP3 | |
| ;; email only via insecure channels. | |
| ;; This is not needed for (modern) IMAP. | |
| mailutils | |
| acl | |
| alsa-lib | |
| elogind | |
| ghostscript | |
| gpm | |
| jansson | |
| lcms | |
| libice | |
| libselinux | |
| libsm | |
| libxml2 | |
| m17n-lib | |
| sqlite | |
| tree-sitter | |
| zlib))))) | |
| (define-public emacs-jit | |
| (package/inherit emacs-no-x-jit | |
| (name "emacs-jit") | |
| (synopsis "The extensible, customizable, self-documenting text editor") | |
| (build-system glib-or-gtk-build-system) | |
| (arguments | |
| (substitute-keyword-arguments (package-arguments emacs-no-x) | |
| ((#:modules _) (%emacs-modules build-system)) | |
| ((#:configure-flags flags #~'()) | |
| #~(cons* "--with-cairo" #$flags)) | |
| ((#:phases phases) | |
| #~(modify-phases #$phases | |
| ;; Note: due to the changed #:modules, %standard-phases in #$phases | |
| ;; refers to glib-or-gtk:%standard-phases, so we don't need to add | |
| ;; them ourselves. | |
| (add-after 'glib-or-gtk-wrap 'restore-emacs-pdmp | |
| ;; Restore the dump file that Emacs installs somewhere in | |
| ;; libexec/ to its original state. | |
| (lambda* (#:key outputs target #:allow-other-keys) | |
| (let* ((libexec (string-append (assoc-ref outputs "out") | |
| "/libexec")) | |
| ;; each of these ought to only match a single file, | |
| ;; but even if not (find-files) sorts by string<, | |
| ;; so the Nth element in one maps to the Nth element of | |
| ;; the other | |
| (pdmp (find-files libexec "\\.pdmp$")) | |
| (pdmp-real (find-files libexec "\\.pdmp-real$"))) | |
| (for-each rename-file pdmp-real pdmp)))))))) | |
| (inputs (modify-inputs (package-inputs emacs-no-x) | |
| (prepend | |
| cairo | |
| dbus | |
| gtk+ | |
| giflib | |
| harfbuzz | |
| libjpeg-turbo | |
| libotf | |
| libpng | |
| (librsvg-for-system) | |
| libtiff | |
| libx11 | |
| libxft | |
| libxpm | |
| pango | |
| poppler))))) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment