diff options
| -rw-r--r-- | doc/contributing.texi | 3 | ||||
| -rw-r--r-- | doc/emacs.texi | 25 | ||||
| -rw-r--r-- | doc/guix.texi | 3 | ||||
| -rw-r--r-- | emacs.am | 1 | ||||
| -rw-r--r-- | emacs/guix-devel.el | 96 | ||||
| -rw-r--r-- | emacs/guix-guile.el | 13 | ||||
| -rw-r--r-- | emacs/guix-init.el | 2 |
7 files changed, 141 insertions, 2 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index ded54348bc..b2d097dd62 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -121,6 +121,9 @@ facilities to directly operate on the syntax tree, such as raising an s-expression or wrapping it, swallowing or rejecting the following s-expression, etc. +GNU Guix also comes with a minor mode that provides some additional +functionality for Scheme buffers (@pxref{Emacs Development}). + @node Coding Style @section Coding Style diff --git a/doc/emacs.texi b/doc/emacs.texi index 67773466a4..d44d329c5c 100644 --- a/doc/emacs.texi +++ b/doc/emacs.texi @@ -12,7 +12,8 @@ Guix convenient and fun. * Popup Interface: Emacs Popup Interface. Magit-like interface for guix commands. * Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}} file names. * Build Log Mode: Emacs Build Log. Highlighting Guix build logs. -* Completions: Emacs Completions. Completing @command{guix} shell command. +* Completions: Emacs Completions. Completing @command{guix} shell command. +* Development: Emacs Development. Tools for Guix developers. @end menu @@ -637,3 +638,25 @@ something: @item @code{guix lint --checkers=synopsis,des}@key{TAB} @end itemize + + +@node Emacs Development +@section Development + +By default, when you open a Scheme file, @code{guix-devel-mode} will be +activated (if you don't want it, set @code{guix-devel-activate-mode} to +nil). This minor mode provides the following key bindings: + +@table @kbd + +@item C-c . k +Copy the name of the current Guile module into kill ring +(@code{guix-devel-copy-module-as-kill}). + +@item C-c . u +Use the current Guile module. Often after opening a Scheme file, you +want to use a module it defines, so you switch to the Geiser REPL and +write @code{,use (some module)} there. You may just use this command +instead (@code{guix-devel-use-module}). + +@end table diff --git a/doc/guix.texi b/doc/guix.texi index 3ca4cefa63..eec28218bb 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -113,7 +113,8 @@ Emacs Interface * Popup Interface: Emacs Popup Interface. Magit-like interface for guix commands. * Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}} file names. * Build Log Mode: Emacs Build Log. Highlighting Guix build logs. -* Completions: Emacs Completions. Completing @command{guix} shell command. +* Completions: Emacs Completions. Completing @command{guix} shell command. +* Development: Emacs Development. Tools for Guix developers. Programming Interface diff --git a/emacs.am b/emacs.am index 5d403b212f..9f300bfc07 100644 --- a/emacs.am +++ b/emacs.am @@ -23,6 +23,7 @@ ELFILES = \ emacs/guix-base.el \ emacs/guix-build-log.el \ emacs/guix-command.el \ + emacs/guix-devel.el \ emacs/guix-emacs.el \ emacs/guix-external.el \ emacs/guix-geiser.el \ diff --git a/emacs/guix-devel.el b/emacs/guix-devel.el new file mode 100644 index 0000000000..ed82e330de --- /dev/null +++ b/emacs/guix-devel.el @@ -0,0 +1,96 @@ +;;; guix-devel.el --- Development tools -*- lexical-binding: t -*- + +;; Copyright © 2015 Alex Kost <alezost@gmail.com> + +;; 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 this program. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;; This file provides commands useful for developing Guix (or even +;; arbitrary Guile code) with Geiser. + +;;; Code: + +(require 'guix-guile) +(require 'guix-geiser) +(require 'guix-utils) + +(defgroup guix-devel nil + "Settings for Guix development utils." + :group 'guix) + +(defcustom guix-devel-activate-mode t + "If non-nil, then `guix-devel-mode' is automatically activated +in Scheme buffers." + :type 'boolean + :group 'guix-devel) + +(defun guix-devel-use-modules (&rest modules) + "Use guile MODULES." + (apply #'guix-geiser-call "use-modules" modules)) + +(defun guix-devel-use-module (&optional module) + "Use guile MODULE in the current Geiser REPL. +MODULE is a string with the module name - e.g., \"(ice-9 match)\". +Interactively, use the module defined by the current scheme file." + (interactive (list (guix-guile-current-module))) + (guix-devel-use-modules module) + (message "Using %s module." module)) + +(defun guix-devel-copy-module-as-kill () + "Put the name of the current guile module into `kill-ring'." + (interactive) + (guix-copy-as-kill (guix-guile-current-module))) + +(defvar guix-devel-keys-map + (let ((map (make-sparse-keymap))) + (define-key map (kbd "k") 'guix-devel-copy-module-as-kill) + (define-key map (kbd "u") 'guix-devel-use-module) + map) + "Keymap with subkeys for `guix-devel-mode-map'.") + +(defvar guix-devel-mode-map + (let ((map (make-sparse-keymap))) + (define-key map (kbd "C-c .") guix-devel-keys-map) + map) + "Keymap for `guix-devel-mode'.") + +;;;###autoload +(define-minor-mode guix-devel-mode + "Minor mode for `scheme-mode' buffers. + +With a prefix argument ARG, enable the mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. + +When Guix Devel mode is enabled, it provides the following key +bindings: + +\\{guix-devel-mode-map}" + :init-value nil + :lighter " Guix" + :keymap guix-devel-mode-map) + +;;;###autoload +(defun guix-devel-activate-mode-maybe () + "Activate `guix-devel-mode' depending on +`guix-devel-activate-mode' variable." + (when guix-devel-activate-mode + (guix-devel-mode))) + +(provide 'guix-devel) + +;;; guix-devel.el ends here diff --git a/emacs/guix-guile.el b/emacs/guix-guile.el index cff9bd4e9b..c21d27fca2 100644 --- a/emacs/guix-guile.el +++ b/emacs/guix-guile.el @@ -24,6 +24,19 @@ ;;; Code: +(require 'geiser-guile) + +(defun guix-guile-current-module () + "Return a string with the current guile module. +Return nil, if current buffer does not define a module." + ;; Modified version of `geiser-guile--get-module'. + (save-excursion + (geiser-syntax--pop-to-top) + (when (or (re-search-backward geiser-guile--module-re nil t) + (looking-at geiser-guile--library-re) + (re-search-forward geiser-guile--module-re nil t)) + (match-string-no-properties 1)))) + (defun guix-guile-make-call-expression (proc &rest args) "Return \"(PROC ARGS ...)\" string. PROC and ARGS should be strings." diff --git a/emacs/guix-init.el b/emacs/guix-init.el index 3a727c7eb6..96aa0c2ffc 100644 --- a/emacs/guix-init.el +++ b/emacs/guix-init.el @@ -12,4 +12,6 @@ avoid loading autoloads of Emacs packages installed in (require 'guix-emacs) (guix-emacs-load-autoloads 'all)) +(add-hook 'scheme-mode-hook 'guix-devel-activate-mode-maybe) + (provide 'guix-init) |