1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2019 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2013 Andreas Enge <andreas@enge.fr>
4 ;;; Copyright © 2014 Taylan Ulrich Bayirli/Kammer <taylanbayirli@gmail.com>
5 ;;; Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020 Mark H Weaver <mhw@netris.org>
6 ;;; Copyright © 2014, 2015, 2016, 2017 Alex Kost <alezost@gmail.com>
7 ;;; Copyright © 2016, 2018 Arun Isaac <arunisaac@systemreboot.net>
8 ;;; Copyright © 2016 Federico Beffa <beffa@fbengineering.ch>
9 ;;; Copyright © 2016 David Thompson <dthompson2@worcester.edu>
10 ;;; Copyright © 2016 Nikita <nikita@n0.is>
11 ;;; Copyright © 2017 Marius Bakke <mbakke@fastmail.com>
12 ;;; Copyright © 2017, 2019, 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
13 ;;; Copyright © 2017 Alex Vong <alexvong1995@gmail.com>
14 ;;; Copyright © 2017, 2018 Ricardo Wurmus <rekado@elephly.net>
15 ;;; Copyright © 2017 Jan Nieuwenhuizen <janneke@gnu.org>
16 ;;; Copyright © 2018 Efraim Flashner <efraim@flashner.co.il>
17 ;;; Copyright © 2018 Mathieu Othacehe <m.othacehe@gmail.com>
18 ;;; Copyright © 2018, 2019 Tobias Geerinckx-Rice <me@tobias.gr>
19 ;;; Copyright © 2019 Jesse John Gildersleve <jessejohngildersleve@zohomail.eu>
20 ;;; Copyright © 2019 Valentin Ignatev <valentignatev@gmail.com>
21 ;;; Copyright © 2019 Leo Prikler <leo.prikler@student.tugraz.at>
22 ;;; Copyright © 2019 Amin Bandali <bandali@gnu.org>
23 ;;; Copyright © 2020 Jack Hill <jackhill@jackhill.us>
24 ;;; Copyright © 2020 Morgan Smith <Morgan.J.Smith@outlook.com>
26 ;;; This file is part of GNU Guix.
28 ;;; GNU Guix is free software; you can redistribute it and/or modify it
29 ;;; under the terms of the GNU General Public License as published by
30 ;;; the Free Software Foundation; either version 3 of the License, or (at
31 ;;; your option) any later version.
33 ;;; GNU Guix is distributed in the hope that it will be useful, but
34 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
35 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36 ;;; GNU General Public License for more details.
38 ;;; You should have received a copy of the GNU General Public License
39 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
41 (define-module (gnu packages emacs)
42 #:use-module ((guix licenses) #:prefix license:)
43 #:use-module (guix packages)
44 #:use-module (guix download)
45 #:use-module (guix git-download)
46 #:use-module (guix build-system gnu)
47 #:use-module (guix build-system glib-or-gtk)
48 #:use-module (gnu packages)
49 #:use-module (gnu packages acl)
50 #:use-module (gnu packages autotools)
51 #:use-module (gnu packages base)
52 #:use-module (gnu packages compression)
53 #:use-module (gnu packages fontutils)
54 #:use-module (gnu packages fribidi)
55 #:use-module (gnu packages gd)
56 #:use-module (gnu packages gettext)
57 #:use-module (gnu packages glib)
58 #:use-module (gnu packages gnome) ; for librsvg
59 #:use-module (gnu packages gtk)
60 #:use-module (gnu packages guile)
61 #:use-module (gnu packages image)
62 #:use-module (gnu packages linux) ; alsa-lib
63 #:use-module (gnu packages mail) ; for mailutils
64 #:use-module (gnu packages multiprecision)
65 #:use-module (gnu packages ncurses)
66 #:use-module (gnu packages pkg-config)
67 #:use-module (gnu packages texinfo)
68 #:use-module (gnu packages tls)
69 #:use-module (gnu packages web) ; for jansson
70 #:use-module (gnu packages webkit)
71 #:use-module (gnu packages xml)
72 #:use-module (gnu packages xorg)
73 #:use-module (guix utils)
74 #:use-module (srfi srfi-1))
82 (uri (string-append "mirror://gnu/emacs/emacs-"
86 "0h9f2wpmp6rb5rfwvqwv1ia1nw86h74p7hnz3vb3gjazj67i4k2a"))
87 (patches (search-patches "emacs-exec-path.patch"
88 "emacs-fix-scheme-indent-function.patch"
89 "emacs-ignore-empty-xim-styles.patch"
90 "emacs-source-date-epoch.patch"))
91 (modules '((guix build utils)))
93 '(with-directory-excursion "lisp"
94 ;; Delete the bundled byte-compiled elisp files and generated
97 (append (find-files "." "\\.elc$")
98 (find-files "." "loaddefs\\.el$")
99 (find-files "eshell" "^esh-groups\\.el$")))
101 ;; Make sure Tramp looks for binaries in the right places on
102 ;; remote Guix System machines, where 'getconf PATH' returns
104 (substitute* "net/tramp-sh.el"
105 ;; Patch the line after "(defcustom tramp-remote-path".
106 (("\\(tramp-default-remote-path")
107 (format #f "(tramp-default-remote-path ~s ~s ~s ~s "
108 "~/.guix-profile/bin" "~/.guix-profile/sbin"
109 "/run/current-system/profile/bin"
110 "/run/current-system/profile/sbin")))
112 ;; Make sure Man looks for C header files in the right
114 (substitute* "man.el"
115 (("\"/usr/local/include\"" line)
118 "\"~/.guix-profile/include\""
119 "\"/var/guix/profiles/system/profile/include\"")
122 (build-system glib-or-gtk-build-system)
124 `(#:tests? #f ; no check target
125 #:configure-flags (list "--with-modules"
127 "--disable-build-details")
129 (modify-phases %standard-phases
130 (add-after 'unpack 'patch-program-file-names
132 (substitute* '("src/callproc.c"
134 "lisp/htmlfontify.el"
135 "lisp/textmodes/artist.el"
136 "lisp/progmodes/sh-script.el")
138 (format #f "~s" (which "sh"))))
140 (add-before 'configure 'fix-/bin/pwd
142 ;; Use `pwd', not `/bin/pwd'.
143 (substitute* (find-files "." "^Makefile\\.in$")
147 (add-after 'install 'install-site-start
148 ;; Use 'guix-emacs' in "site-start.el", which is used autoload the
149 ;; Elisp packages found in EMACSLOADPATH.
150 (lambda* (#:key inputs outputs #:allow-other-keys)
151 (let* ((out (assoc-ref outputs "out"))
152 (lisp-dir (string-append out "/share/emacs/site-lisp"))
153 (emacs (string-append out "/bin/emacs")))
155 ;; This is duplicated from emacs-utils to prevent coupling.
156 (define* (emacs-byte-compile-directory dir)
158 (setq byte-compile-debug t)
159 (byte-recompile-directory
160 (file-name-as-directory ,dir) 0 1))))
161 (invoke emacs "--quick" "--batch"
162 (format #f "--eval=~s" expr))))
164 (copy-file (assoc-ref inputs "guix-emacs.el")
165 (string-append lisp-dir "/guix-emacs.el"))
166 (with-output-to-file (string-append lisp-dir "/site-start.el")
169 (string-append "(when (require 'guix-emacs nil t)\n"
170 " (guix-emacs-autoload-packages))\n"))))
171 ;; Remove the extraneous subdirs.el file, as it causes Emacs to
172 ;; add recursively all the the sub-directories of a profile's
173 ;; share/emacs/site-lisp union when added to EMACSLOADPATH,
174 ;; which leads to conflicts.
175 (delete-file (string-append lisp-dir "/subdirs.el"))
176 ;; Byte compile the site-start files.
177 (emacs-byte-compile-directory lisp-dir))
179 (add-after 'glib-or-gtk-wrap 'restore-emacs-pdmp
180 ;; restore the dump file that Emacs installs somewhere in
181 ;; libexec/ to its original state
182 (lambda* (#:key outputs target #:allow-other-keys)
183 (let* ((libexec (string-append (assoc-ref outputs "out")
185 ;; each of these find-files should return one file
186 (pdmp (find-files libexec "^emacs\\.pdmp$"))
187 (pdmp-real (find-files libexec
188 "^\\.emacs\\.pdmp-real$")))
189 (for-each (lambda (wrapper real)
190 (delete-file wrapper)
191 (rename-file real wrapper))
194 (add-after 'glib-or-gtk-wrap 'strip-double-wrap
195 (lambda* (#:key outputs #:allow-other-keys)
196 ;; Directly copy emacs-X.Y to emacs, so that it is not wrapped
197 ;; twice. This also fixes a minor issue, where WMs would not be
198 ;; able to track emacs back to emacs.desktop. The version is
199 ;; accessed using using THIS-PACKAGE so it "just works" for
200 ;; inherited Emacs packages of different versions.
201 (with-directory-excursion (assoc-ref outputs "out")
202 (copy-file (string-append
204 ,(let ((this-version (package-version this-package)))
205 (or (false-if-exception
206 (version-major+minor+point this-version))
207 (version-major+minor this-version))))
210 (add-before 'reset-gzip-timestamps 'make-compressed-files-writable
211 ;; The 'reset-gzip-timestamps phase will throw a permission error
212 ;; if gzip files aren't writable then. This phase is needed when
213 ;; building from a git checkout.
215 (for-each make-file-writable
216 (find-files %output ".*\\.t?gz$"))
222 ;; Avoid Emacs's limited movemail substitute that retrieves POP3 email
223 ;; only via insecure channels. This is not needed for (modern) IMAP.
224 ("mailutils" ,mailutils)
226 ;; TODO: Add the optional dependencies.
231 ("harfbuzz" ,harfbuzz)
235 ("libjpeg" ,libjpeg-turbo)
240 ;; When looking for libpng `configure' links with `-lpng -lz', so we
241 ;; must also provide zlib as an input.
250 ("alsa-lib" ,alsa-lib)
253 ;; multilingualization support
255 ("m17n-lib" ,m17n-lib)))
257 `(("guix-emacs.el" ,(search-auxiliary-file "emacs/guix-emacs.el"))
258 ("pkg-config" ,pkg-config)
259 ("texinfo" ,texinfo)))
262 (list (search-path-specification
263 (variable "EMACSLOADPATH")
264 ;; The versioned entry is for the Emacs' builtin libraries.
265 (files (list "share/emacs/site-lisp"
266 (string-append "share/emacs/" version "/lisp"))))
267 (search-path-specification
268 (variable "INFOPATH")
269 (files '("share/info")))))
271 (home-page "https://www.gnu.org/software/emacs/")
272 (synopsis "The extensible, customizable, self-documenting text editor")
274 "GNU Emacs is an extensible and highly customizable text editor. It is
275 based on an Emacs Lisp interpreter with extensions for text editing. Emacs
276 has been extended in essentially all areas of computing, giving rise to a
277 vast array of packages supporting, e.g., email, IRC and XMPP messaging,
278 spreadsheets, remote server editing, and much more. Emacs includes extensive
279 documentation on all aspects of the system, from basic editing to writing
280 large Lisp programs. It has full Unicode support for nearly all human
282 (license license:gpl3+)))
284 (define-public emacs-next
285 (let ((commit "2ea34662c20f71d35dd52a5ed996542c7386b9cb")
287 (package/inherit emacs
289 (version (git-version "28.0.50" revision commit))
292 (inherit (package-source emacs))
295 (url "https://git.savannah.gnu.org/git/emacs.git/")
297 (file-name (git-file-name name version))
300 "0igjm9kwiswn2dpiy2k9xikbdfc7njs07ry48fqz70anljj8y7y3"))))
302 `(("autoconf" ,autoconf)
303 ,@(package-native-inputs emacs)))
305 (list (search-path-specification
306 (variable "EMACSLOADPATH")
307 ;; The versioned entry is for the Emacs' builtin libraries.
308 (files (list "share/emacs/site-lisp"
309 (string-append "share/emacs/"
310 (version-major+minor+point version)
312 (search-path-specification
313 (variable "INFOPATH")
314 (files '("share/info"))))))))
316 (define-public emacs-next-pgtk
317 (let ((commit "d46a223d8595e8edb67c6361033625797503cacf")
319 (package/inherit emacs-next
320 (name "emacs-next-pgtk")
321 (version (git-version "28.0.50" revision commit))
326 (url "https://git.savannah.gnu.org/git/emacs.git/")
328 (file-name (git-file-name name version))
331 "1fhkgqsdpy3qkf8wyjvavnfyh8byxh0h80n0448rkg9k0lrkl4wf"))))
333 (substitute-keyword-arguments (package-arguments emacs-next)
334 ((#:configure-flags flags ''())
335 `(cons* "--with-pgtk" "--with-xwidgets" ,flags))))
337 `(("gsettings-desktop-schemas" ,gsettings-desktop-schemas)
338 ("glib-networking" ,glib-networking)))
340 `(("webkitgtk" ,webkitgtk)
341 ,@(package-inputs emacs-next)))
342 (home-page "https://github.com/masm11/emacs")
343 (synopsis "Emacs text editor with @code{pgtk} and @code{xwidgets} support")
344 (description "This is an unofficial Emacs fork build with a pure-GTK
345 graphical toolkit to work natively on Wayland. In addition to that, xwidgets
346 also enabled and works without glitches even on X server."))))
348 (define-public emacs-minimal
349 ;; This is the version that you should use as an input to packages that just
350 ;; need to byte-compile .el files.
351 (package/inherit emacs
352 (name "emacs-minimal")
353 (synopsis "The extensible text editor (used only for byte-compilation)")
354 (build-system gnu-build-system)
356 (substitute-keyword-arguments (package-arguments emacs)
357 ((#:configure-flags flags ''())
358 `(list "--with-gnutls=no" "--disable-build-details"))
360 `(modify-phases ,phases
361 (delete 'restore-emacs-pdmp)
362 (delete 'strip-double-wrap)))))
364 `(("guix-emacs.el" ,(search-auxiliary-file "emacs/guix-emacs.el"))
365 ("ncurses" ,ncurses)))
367 `(("pkg-config" ,pkg-config)))))
369 (define-public emacs-xwidgets
370 (package/inherit emacs
371 (name "emacs-xwidgets")
372 (synopsis "The extensible, customizable, self-documenting text
373 editor (with xwidgets support)")
374 (build-system gnu-build-system)
376 (substitute-keyword-arguments (package-arguments emacs)
377 ((#:configure-flags flags ''())
378 `(cons "--with-xwidgets" ,flags))
380 `(modify-phases ,phases
381 (delete 'restore-emacs-pdmp)
382 (delete 'strip-double-wrap)))))
384 `(("webkitgtk" ,webkitgtk)
385 ("libxcomposite" ,libxcomposite)
386 ,@(package-inputs emacs)))))
388 (define-public emacs-no-x
389 (package/inherit emacs
391 (synopsis "The extensible, customizable, self-documenting text
392 editor (console only)")
393 (build-system gnu-build-system)
394 (inputs (fold alist-delete
395 (package-inputs emacs)
396 '("libx11" "gtk+" "libxft" "libtiff" "giflib" "libjpeg"
397 "imagemagick" "libpng" "librsvg" "libxpm" "libice"
398 "libsm" "cairo" "pango" "harfbuzz"
400 ;; These depend on libx11, so remove them as well.
401 "libotf" "m17n-lib" "dbus")))
403 (substitute-keyword-arguments (package-arguments emacs)
404 ((#:configure-flags flags ''())
405 `(delete "--with-cairo" ,flags))
407 `(modify-phases ,phases
408 (delete 'restore-emacs-pdmp)
409 (delete 'strip-double-wrap)))))))
411 (define-public emacs-no-x-toolkit
412 (package/inherit emacs
413 (name "emacs-no-x-toolkit")
414 (synopsis "The extensible, customizable, self-documenting text
415 editor (without an X toolkit)" )
416 (build-system gnu-build-system)
417 (inputs (append `(("inotify-tools" ,inotify-tools))
418 (alist-delete "gtk+" (package-inputs emacs))))
420 (substitute-keyword-arguments (package-arguments emacs)
421 ((#:configure-flags flags ''())
422 `(cons "--with-x-toolkit=no" ,flags))
424 `(modify-phases ,phases
425 (delete 'restore-emacs-pdmp)
426 (delete 'strip-double-wrap)))))))
428 (define-public emacs-wide-int
429 (package/inherit emacs
430 (name "emacs-wide-int")
431 (synopsis "The extensible, customizable, self-documenting text
432 editor (with wide ints)" )
434 (substitute-keyword-arguments (package-arguments emacs)
435 ((#:configure-flags flags)
436 `(cons "--with-wide-int" ,flags))))))
438 (define-public guile-emacs
439 (let ((commit "41120e0f595b16387eebfbf731fff70481de1b4b")
441 (package/inherit emacs
443 (version (git-version "0.0.0" revision commit))
447 (url "https://git.hcoop.net/git/bpt/emacs.git")
449 (file-name (git-file-name name version))
450 (patches (search-patches "guile-emacs-fix-configure.patch"))
453 "0lvcvsz0f4mawj04db35p1dvkffdqkz8pkhc0jzh9j9x2i63kcz6"))))
455 `(("autoconf" ,autoconf)
456 ("automake" ,automake)
457 ("guile" ,guile-for-guile-emacs)
458 ,@(package-native-inputs emacs)))
460 (substitute-keyword-arguments `(;; Build fails if we allow parallel build.
462 ;; Tests aren't passing for now.
464 ,@(package-arguments emacs))
465 ((#:configure-flags flags ''())
466 `(delete "--with-cairo" ,flags))
468 `(modify-phases ,phases
469 (add-after 'unpack 'autogen
471 (invoke "sh" "autogen.sh")))
472 ;; Build sometimes fails: deps/dispnew.d: No such file or directory
473 (add-before 'build 'make-deps-dir
475 (invoke "mkdir" "-p" "src/deps")))
476 (delete 'restore-emacs-pdmp)
477 (delete 'strip-double-wrap))))))))
479 (define-public m17n-db
486 (uri (string-append "mirror://savannah/m17n/m17n-db-"
490 "0vfw7z9i2s9np6nmx1d4dlsywm044rkaqarn7akffmb6bf1j6zv5"))))
491 (build-system gnu-build-system)
493 `(("gettext" ,gettext-minimal)))
496 (list (string-append "--with-charmaps="
497 (assoc-ref %build-inputs "libc")
498 "/share/i18n/charmaps"))))
499 ;; With `guix lint' the home-page URI returns a small page saying
500 ;; that your browser does not handle frames. This triggers the "URI
501 ;; returns suspiciously small file" warning.
502 (home-page "https://www.nongnu.org/m17n/")
503 (synopsis "Multilingual text processing library (database)")
504 (description "The m17n library realizes multilingualization of
505 many aspects of applications. The m17n library represents
506 multilingual text as an object named M-text. M-text is a string with
507 attributes called text properties, and designed to substitute for
508 string in C. Text properties carry any information required to input,
509 display and edit the text.
511 This package contains the library database.")
512 (license license:lgpl2.1+)))
514 (define-public m17n-lib
521 (uri (string-append "mirror://savannah/m17n/m17n-lib-"
525 "0jp61y09xqj10mclpip48qlfhniw8gwy8b28cbzxy8hq8pkwmfkq"))))
526 (build-system gnu-build-system)
528 `(("fribidi" ,fribidi)
533 ("m17n-db" ,m17n-db)))
535 `(#:parallel-build? #f))
536 ;; With `guix lint' the home-page URI returns a small page saying
537 ;; that your browser does not handle frames. This triggers the "URI
538 ;; returns suspiciously small file" warning.
539 (home-page "https://www.nongnu.org/m17n/")
540 (synopsis "Multilingual text processing library (runtime)")
541 (description "The m17n library realizes multilingualization of
542 many aspects of applications. The m17n library represents
543 multilingual text as an object named M-text. M-text is a string with
544 attributes called text properties, and designed to substitute for
545 string in C. Text properties carry any information required to input,
546 display and edit the text.
548 This package contains the library runtime.")
549 (license license:lgpl2.1+)))