;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014, 2018 Mark H Weaver <mhw@netris.org>
;;; Copyright © 2014 Alex Kost <alezost@gmail.com>
;;; Copyright © 2018, 2020, 2022 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;; Copyright © 2019 Liliana Marie Prikler <liliana.prikler@gmail.com>
;;; Copyright © 2022 Fredrik Salomonsson <plattfot@posteo.net>
;;;
;;; 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 (guix build emacs-utils)
#:use-module (guix build utils)
#:use-module (ice-9 format)
#:use-module (ice-9 popen)
#:use-module (ice-9 rdelim)
#:use-module (srfi srfi-34)
#:use-module (srfi srfi-35)
#:export (%emacs
emacs-batch-eval
emacs-batch-edit-file
emacs-batch-disable-compilation
emacs-batch-script
emacs-batch-error?
emacs-batch-error-message
emacs-generate-autoloads
emacs-byte-compile-directory
emacs-compile-directory
emacs-header-parse
as-display
emacs-substitute-sexps
emacs-substitute-variables))
;;; Commentary:
;;;
;;; Tools to programmatically edit files using Emacs,
;;; e.g. to replace entire s-expressions in elisp files.
;;;
;;; Code:
(define %emacs
;; The `emacs' command.
(make-parameter "emacs"))
(define (expr->string expr)
"Converts EXPR, an expression, into a string."
(if (string? expr)
expr
(format #f "~s" expr)))
(define* (emacs-batch-eval expr #:key dynamic?)
"Run Emacs in batch mode, and execute the Elisp code EXPR. If DYNAMIC? is
true, evaluate using dynamic scoping."
(invoke (%emacs) "--quick" "--batch"
(format #f "--eval=(eval '~a ~:[t~;nil~])"
(expr->string expr) dynamic?)))
(define (emacs-batch-edit-file file expr)
"Load FILE in Emacs using batch mode, and execute the elisp code EXPR."
(invoke (%emacs) "--quick" "--batch"
(string-append "--visit=" file)
(string-append "--eval=" (expr->string expr))))
(define* (emacs-batch-disable-compilation file #:key native?)
"Disable byte compilation for FILE.
If NATIVE?, only disable native compilation."
(emacs-batch-edit-file file
`(progn
(add-file-local-variable ',(if native?
'no-native-compile
'no-byte-compile)
t)
(basic-save-buffer))))
(define-condition-type &emacs-batch-error &error
emacs-batch-error?
(message emacs-batch-error-message))
(define (emacs-batch-script expr)
"Execute the Elisp code EXPR in Emacs batch mode and return output."
(let* ((error-pipe (pipe))
(port (parameterize ((current-error-port (cdr error-pipe)))
(open-pipe*
OPEN_READ
(%emacs) "--quick" "--batch"
(string-append "--eval=" (expr->string expr)))))
(output (read-string port))
(status (close-pipe port)))
(close-port (cdr error-pipe))
(unless (zero? status)
(raise (condition (&emacs-batch-error
(message (read-string (car error-pipe)))))))
output))
(define (emacs-generate-autoloads name directory)
"Generate autoloads for Emacs package NAME placed in DIRECTORY."
(let* ((file (string-append directory "/" name "-autoloads.el"))
(expr `(let ((backup-inhibited t)
(generated-autoload-file ,file))
(cond
((require 'loaddefs-gen nil t)
;; Emacs >= 29
(loaddefs-generate ,directory ,file))
((fboundp 'make-directory-autoloads)
;; Emacs 28
(make-directory-autoloads ,directory ,file))
(t (update-directory-autoloads ,directory))))))
(emacs-batch-eval expr #:dynamic? #t)))
(define* (emacs-byte-compile-directory dir)
"Byte compile all files in DIR and its sub-directories."
(let ((expr `(progn
(setq byte-compile-debug t) ; for proper exit status
(byte-recompile-directory (file-name-as-directory ,dir) 0 1))))
(emacs-batch-eval expr)))
(define* (emacs-compile-directory dir)
"Compile all files in DIR to native code.
If native code is not supported, compile to bytecode instead."
(emacs-batch-eval
`(let ((byte-compile-debug t) ; for proper exit status
(byte+native-compile (native-comp-available-p))
(files (directory-files-recursively ,dir "\\.el$")))
(mapc
(lambda (file)
(let (byte-to-native-output-file
;; First entry is the eln-cache of the homeless shelter,
;; second entry is the install directory.
(eln-dir (and (native-comp-available-p)
(cadr native-comp-eln-load-path))))
(if byte+native-compile
(native-compile file
(comp-el-to-eln-filename file eln-dir))
(byte-compile-file file))
;; Sadly, we can't use pcase because quasiquote works different in
;; Emacs. See `batch-byte+native-compile' in comp.el for the
;; actual shape of byte-to-native-output-file.
(unless (null byte-to-native-output-file)
(rename-file (car byte-to-native-output-file)
(cdr byte-to-native-output-file)
t))))
files))
#:dynamic? #t))
(define (emacs-header-parse section file)
"Parse the header SECTION in FILE and return it as a string."
(emacs-batch-script
`(progn
(require 'lisp-mnt)
(find-file ,file)
(princ (lm-header ,section)))))
(define as-display ;syntactic keyword for 'emacs-substitute-sexps'
'(as display))
(define-syntax replacement-helper
(syntax-rules (as-display)
((_ (leading-regexp replacement (as-display)))
`(progn (goto-char (point-min))
(re-search-forward ,leading-regexp)
(kill-sexp)
(insert " ")
(insert ,(format #f "~a" replacement))))
((_ (leading-regexp replacement))
`(progn (goto-char (point-min))
(re-search-forward ,leading-regexp)
(kill-sexp)
(insert " ")
(insert ,(format #f "~s" replacement))))))
(define-syntax emacs-substitute-sexps
(syntax-rules ()
"Substitute the S-expression immediately following the first occurrence of
LEADING-REGEXP by the string returned by REPLACEMENT in FILE. For example:
(emacs-substitute-sexps \"w3m.el\"
(\"defcustom w3m-command\"
(string-append w3m \"/bin/w3m\"))
(\"defvar w3m-image-viewer\"
(string-append imagemagick \"/bin/display\")))
This replaces the default values of the `w3m-command' and `w3m-image-viewer'
variables declared in `w3m.el' with the results of the `string-append' calls
above. Note that LEADING-REGEXP uses Emacs regexp syntax.
Here is another example that uses the '(as-display)' subform to avoid having
the Elisp procedure symbol from being double quoted:
(emacs-substitute-sexps \"gnugo.el\"
(\"defvar gnugo-xpms\" \"#'gnugo-imgen-create-xpms\" (as-display))"
((_ file replacement-spec ...)
(emacs-batch-edit-file file
`(progn ,(replacement-helper replacement-spec)
...
(basic-save-buffer))))))
(define-syntax emacs-substitute-variables
(syntax-rules ()
"Substitute the default value of VARIABLE by the string returned by
REPLACEMENT in FILE. For example:
(emacs-substitute-variables \"w3m.el\"
(\"w3m-command\" (string-append w3m \"/bin/w3m\"))
(\"w3m-image-viewer\" (string-append imagemagick \"/bin/display\")))
This replaces the default values of the `w3m-command' and `w3m-image-viewer'
variables declared in `w3m.el' with the results of the `string-append' calls
above. Similarly to `emacs-substitute-sexps', the '(as-display)' subform can
be used to have the replacement formatted like `display' would, which can be
useful to avoid double quotes being added when the replacement is provided as
a string."
((_ file (variable replacement modifier ...) ...)
(emacs-substitute-sexps file
((string-append "(def[a-z]+[[:space:]\n]+" variable "\\_>")
replacement
modifier ...)
...))))
;;; emacs-utils.scm ends here