gnu/packages/emacs.scm

   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 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 ng0 <ng0@n0.is>
  11 ;;; Copyright © 2017 Marius Bakke <mbakke@fastmail.com>
  12 ;;; Copyright © 2017, 2019 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 ;;;
  21 ;;; This file is part of GNU Guix.
  22 ;;;
  23 ;;; GNU Guix is free software; you can redistribute it and/or modify it
  24 ;;; under the terms of the GNU General Public License as published by
  25 ;;; the Free Software Foundation; either version 3 of the License, or (at
  26 ;;; your option) any later version.
  27 ;;;
  28 ;;; GNU Guix is distributed in the hope that it will be useful, but
  29 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
  30 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31 ;;; GNU General Public License for more details.
  32 ;;;
  33 ;;; You should have received a copy of the GNU General Public License
  34 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
  35
  36 (define-module (gnu packages emacs)
  37   #:use-module ((guix licenses) #:prefix license:)
  38   #:use-module (guix packages)
  39   #:use-module (guix download)
  40   #:use-module (guix git-download)
  41   #:use-module (guix build-system gnu)
  42   #:use-module (guix build-system glib-or-gtk)
  43   #:use-module (gnu packages)
  44   #:use-module (gnu packages acl)
  45   #:use-module (gnu packages autotools)
  46   #:use-module (gnu packages base)
  47   #:use-module (gnu packages compression)
  48   #:use-module (gnu packages fontutils)
  49   #:use-module (gnu packages fribidi)
  50   #:use-module (gnu packages gd)
  51   #:use-module (gnu packages gettext)
  52   #:use-module (gnu packages glib)
  53   #:use-module (gnu packages gnome)     ; for librsvg
  54   #:use-module (gnu packages gtk)
  55   #:use-module (gnu packages guile)
  56   #:use-module (gnu packages image)
  57   #:use-module (gnu packages imagemagick)
  58   #:use-module (gnu packages linux)     ; alsa-lib
  59   #:use-module (gnu packages mail)      ; for mailutils
  60   #:use-module (gnu packages ncurses)
  61   #:use-module (gnu packages pkg-config)
  62   #:use-module (gnu packages texinfo)
  63   #:use-module (gnu packages tls)
  64   #:use-module (gnu packages webkit)
  65   #:use-module (gnu packages xml)
  66   #:use-module (gnu packages xorg)
  67   #:use-module (guix utils)
  68   #:use-module (srfi srfi-1))
  69
  70 (define-public emacs
  71   (package
  72     (name "emacs")
  73     (version "26.3")
  74     (source (origin
  75              (method url-fetch)
  76              (uri (string-append "mirror://gnu/emacs/emacs-"
  77                                  version ".tar.xz"))
  78              (sha256
  79               (base32
  80                "119ldpk7sgn9jlpyngv5y4z3i7bb8q3xp4p0qqi7i5nq39syd42d"))
  81              (patches (search-patches "emacs-exec-path.patch"
  82                                       "emacs-fix-scheme-indent-function.patch"
  83                                       "emacs-source-date-epoch.patch"))
  84              (modules '((guix build utils)))
  85              (snippet
  86               ;; Delete the bundled byte-compiled elisp files and
  87               ;; generated autoloads.
  88               '(with-directory-excursion "lisp"
  89                  (for-each delete-file
  90                            (append (find-files "." "\\.elc$")
  91                                    (find-files "." "loaddefs\\.el$")
  92                                    ;; This is the only "autoloads" file that
  93                                    ;; does not have "*loaddefs.el" name.
  94                                    '("eshell/esh-groups.el")))
  95
  96                  ;; Make sure Tramp looks for binaries in the right places on
  97                  ;; remote Guix System machines, where 'getconf PATH' returns
  98                  ;; something bogus.
  99                  (substitute* "net/tramp-sh.el"
 100                    ;; Patch the line after "(defcustom tramp-remote-path".
 101                    (("\\(tramp-default-remote-path")
 102                     (format #f "(tramp-default-remote-path ~s ~s ~s ~s "
 103                             "~/.guix-profile/bin" "~/.guix-profile/sbin"
 104                             "/run/current-system/profile/bin"
 105                             "/run/current-system/profile/sbin")))
 106
 107                  ;; Make sure Man looks for C header files in the right
 108                  ;; places.
 109                  (substitute* "man.el"
 110                    (("\"/usr/local/include\"" line)
 111                     (string-join
 112                      (list line
 113                            "\"~/.guix-profile/include\""
 114                            "\"/var/guix/profiles/system/profile/include\"")
 115                      " ")))
 116                  #t))))
 117     (build-system glib-or-gtk-build-system)
 118     (arguments
 119      `(#:tests? #f                      ; no check target
 120        #:configure-flags (list "--with-modules"
 121                                "--disable-build-details")
 122        #:phases
 123        (modify-phases %standard-phases
 124          (add-before 'configure 'fix-/bin/pwd
 125            (lambda _
 126              ;; Use `pwd', not `/bin/pwd'.
 127              (substitute* (find-files "." "^Makefile\\.in$")
 128                (("/bin/pwd")
 129                 "pwd"))
 130              #t))
 131          (add-after 'install 'install-site-start
 132            ;; Use 'guix-emacs' in "site-start.el".  This way, Emacs packages
 133            ;; provided by Guix and installed in
 134            ;; ~/.guix-profile/share/emacs/site-lisp/guix.d/PACKAGE-VERSION are
 135            ;; automatically found.
 136            (lambda* (#:key inputs outputs #:allow-other-keys)
 137              (let* ((out      (assoc-ref outputs "out"))
 138                     (lisp-dir (string-append out "/share/emacs/site-lisp")))
 139                (copy-file (assoc-ref inputs "guix-emacs.el")
 140                           (string-append lisp-dir "/guix-emacs.el"))
 141                (with-output-to-file (string-append lisp-dir "/site-start.el")
 142                  (lambda ()
 143                    (display
 144                     (string-append "(when (require 'guix-emacs nil t)\n"
 145                                    "  (guix-emacs-autoload-packages))\n"))))
 146                #t))))))
 147     (inputs
 148      `(("gnutls" ,gnutls)
 149        ("ncurses" ,ncurses)
 150
 151        ;; Avoid Emacs's limited movemail substitute that retrieves POP3 email
 152        ;; only via insecure channels.  This is not needed for (modern) IMAP.
 153        ("mailutils" ,mailutils)
 154
 155        ;; TODO: Add the optional dependencies.
 156        ("libx11" ,libx11)
 157        ("gtk+" ,gtk+)
 158        ("libxft" ,libxft)
 159        ("libtiff" ,libtiff)
 160        ("giflib" ,giflib)
 161        ("libjpeg" ,libjpeg)
 162        ("imagemagick" ,imagemagick)
 163        ("acl" ,acl)
 164
 165        ;; When looking for libpng `configure' links with `-lpng -lz', so we
 166        ;; must also provide zlib as an input.
 167        ("libpng" ,libpng)
 168        ("zlib" ,zlib)
 169
 170        ("librsvg" ,librsvg)
 171        ("libxpm" ,libxpm)
 172        ("libxml2" ,libxml2)
 173        ("libice" ,libice)
 174        ("libsm" ,libsm)
 175        ("alsa-lib" ,alsa-lib)
 176        ("dbus" ,dbus)
 177
 178        ;; multilingualization support
 179        ("libotf" ,libotf)
 180        ("m17n-lib" ,m17n-lib)))
 181     (native-inputs
 182      `(("guix-emacs.el" ,(search-auxiliary-file "emacs/guix-emacs.el"))
 183        ("pkg-config" ,pkg-config)
 184        ("texinfo" ,texinfo)))
 185
 186     (native-search-paths
 187      (list (search-path-specification
 188             (variable "EMACSLOADPATH")
 189             ;; The versioned entry is for the Emacs' builtin libraries.
 190             (files (list (string-append "share/emacs/" version "/lisp")
 191                          "share/emacs/site-lisp")))
 192            (search-path-specification
 193             (variable "INFOPATH")
 194             (files '("share/info")))))
 195
 196     (home-page "https://www.gnu.org/software/emacs/")
 197     (synopsis "The extensible, customizable, self-documenting text editor")
 198     (description
 199      "GNU Emacs is an extensible and highly customizable text editor.  It is
 200 based on an Emacs Lisp interpreter with extensions for text editing.  Emacs
 201 has been extended in essentially all areas of computing, giving rise to a
 202 vast array of packages supporting, e.g., email, IRC and XMPP messaging,
 203 spreadsheets, remote server editing, and much more.  Emacs includes extensive
 204 documentation on all aspects of the system, from basic editing to writing
 205 large Lisp programs.  It has full Unicode support for nearly all human
 206 languages.")
 207     (license license:gpl3+)))
 208
 209 (define-public emacs-minimal
 210   ;; This is the version that you should use as an input to packages that just
 211   ;; need to byte-compile .el files.
 212   (package (inherit emacs)
 213     (name "emacs-minimal")
 214     (synopsis "The extensible text editor (used only for byte-compilation)")
 215     (build-system gnu-build-system)
 216     (arguments
 217      (substitute-keyword-arguments (package-arguments emacs)
 218        ((#:phases phases)
 219         `(modify-phases ,phases
 220            (delete 'install-site-start)))
 221        ((#:configure-flags flags ''())
 222         `(list "--with-gnutls=no" "--disable-build-details"))))
 223     (inputs
 224      `(("ncurses" ,ncurses)))
 225     (native-inputs
 226      `(("pkg-config" ,pkg-config)))))
 227
 228 (define-public emacs-xwidgets
 229   (package
 230     (inherit emacs)
 231     (name "emacs-xwidgets")
 232     (synopsis "The extensible, customizable, self-documenting text
 233 editor (with xwidgets support)")
 234     (build-system gnu-build-system)
 235     (arguments
 236      (substitute-keyword-arguments (package-arguments emacs)
 237        ((#:configure-flags flags ''())
 238         `(cons "--with-xwidgets" ,flags))))
 239     (inputs
 240      `(("webkitgtk" ,webkitgtk)
 241        ("libxcomposite" ,libxcomposite)
 242        ,@(package-inputs emacs)))))
 243
 244 (define-public emacs-no-x
 245   (package (inherit emacs)
 246     (name "emacs-no-x")
 247     (synopsis "The extensible, customizable, self-documenting text
 248 editor (console only)")
 249     (build-system gnu-build-system)
 250     (inputs (fold alist-delete
 251                   (package-inputs emacs)
 252                   '("libx11" "gtk+" "libxft" "libtiff" "giflib" "libjpeg"
 253                     "imagemagick" "libpng" "librsvg" "libxpm" "libice"
 254                     "libsm"
 255
 256                     ;; These depend on libx11, so remove them as well.
 257                     "libotf" "m17n-lib" "dbus")))))
 258
 259 (define-public emacs-no-x-toolkit
 260   (package (inherit emacs)
 261     (name "emacs-no-x-toolkit")
 262     (synopsis "The extensible, customizable, self-documenting text
 263 editor (without an X toolkit)" )
 264     (build-system gnu-build-system)
 265     (inputs (append `(("inotify-tools" ,inotify-tools))
 266                     (alist-delete "gtk+" (package-inputs emacs))))
 267     (arguments
 268      `(,@(substitute-keyword-arguments (package-arguments emacs)
 269            ((#:configure-flags cf)
 270             `(cons "--with-x-toolkit=no" ,cf)))))))
 271
 272 (define-public guile-emacs
 273   (let ((commit "41120e0f595b16387eebfbf731fff70481de1b4b")
 274         (revision "0"))
 275     (package (inherit emacs)
 276       (name "guile-emacs")
 277       (version (git-version "0.0.0" revision commit))
 278       (source (origin
 279                 (method git-fetch)
 280                 (uri (git-reference
 281                       (url "https://git.hcoop.net/git/bpt/emacs.git")
 282                       (commit commit)))
 283                 (file-name (git-file-name name version))
 284                 (patches (search-patches "guile-emacs-fix-configure.patch"))
 285                 (sha256
 286                  (base32
 287                   "0lvcvsz0f4mawj04db35p1dvkffdqkz8pkhc0jzh9j9x2i63kcz6"))))
 288       (native-inputs
 289        `(("autoconf" ,autoconf)
 290          ("automake" ,automake)
 291          ("guile" ,guile-for-guile-emacs)
 292          ,@(package-native-inputs emacs)))
 293       (arguments
 294        (substitute-keyword-arguments `(;; Build fails if we allow parallel build.
 295                                        #:parallel-build? #f
 296                                        ;; Tests aren't passing for now.
 297                                        #:tests? #f
 298                                        ,@(package-arguments emacs))
 299          ((#:phases phases)
 300           `(modify-phases ,phases
 301              (add-after 'unpack 'autogen
 302                (lambda _
 303                  (invoke "sh" "autogen.sh")))
 304              ;; Build sometimes fails: deps/dispnew.d: No such file or directory
 305              (add-before 'build 'make-deps-dir
 306                (lambda _
 307                  (invoke "mkdir" "-p" "src/deps"))))))))))
 308
 309 (define-public m17n-db
 310   (package
 311     (name "m17n-db")
 312     (version "1.8.0")
 313     (source
 314      (origin
 315        (method url-fetch)
 316        (uri (string-append "mirror://savannah/m17n/m17n-db-"
 317                            version ".tar.gz"))
 318        (sha256
 319         (base32
 320          "0vfw7z9i2s9np6nmx1d4dlsywm044rkaqarn7akffmb6bf1j6zv5"))))
 321     (build-system gnu-build-system)
 322     (inputs
 323      `(("gettext" ,gettext-minimal)))
 324     (arguments
 325      `(#:configure-flags
 326        (list (string-append "--with-charmaps="
 327                             (assoc-ref %build-inputs "libc")
 328                             "/share/i18n/charmaps"))))
 329     ;; With `guix lint' the home-page URI returns a small page saying
 330     ;; that your browser does not handle frames. This triggers the "URI
 331     ;; returns suspiciously small file" warning.
 332     (home-page "https://www.nongnu.org/m17n/")
 333     (synopsis "Multilingual text processing library (database)")
 334     (description "The m17n library realizes multilingualization of
 335 many aspects of applications.  The m17n library represents
 336 multilingual text as an object named M-text.  M-text is a string with
 337 attributes called text properties, and designed to substitute for
 338 string in C.  Text properties carry any information required to input,
 339 display and edit the text.
 340
 341 This package contains the library database.")
 342     (license license:lgpl2.1+)))
 343
 344 (define-public m17n-lib
 345   (package
 346     (name "m17n-lib")
 347     (version "1.8.0")
 348     (source
 349      (origin
 350        (method url-fetch)
 351        (uri (string-append "mirror://savannah/m17n/m17n-lib-"
 352                            version ".tar.gz"))
 353        (sha256
 354         (base32
 355          "0jp61y09xqj10mclpip48qlfhniw8gwy8b28cbzxy8hq8pkwmfkq"))))
 356     (build-system gnu-build-system)
 357     (inputs
 358      `(("fribidi" ,fribidi)
 359        ("gd" ,gd)
 360        ("libotf" ,libotf)
 361        ("libxft" ,libxft)
 362        ("libxml2" ,libxml2)
 363        ("m17n-db" ,m17n-db)))
 364     (arguments
 365      `(#:parallel-build? #f))
 366     ;; With `guix lint' the home-page URI returns a small page saying
 367     ;; that your browser does not handle frames. This triggers the "URI
 368     ;; returns suspiciously small file" warning.
 369     (home-page "https://www.nongnu.org/m17n/")
 370     (synopsis "Multilingual text processing library (runtime)")
 371     (description "The m17n library realizes multilingualization of
 372 many aspects of applications.  The m17n library represents
 373 multilingual text as an object named M-text.  M-text is a string with
 374 attributes called text properties, and designed to substitute for
 375 string in C.  Text properties carry any information required to input,
 376 display and edit the text.
 377
 378 This package contains the library runtime.")
 379     (license license:lgpl2.1+)))