From mboxrd@z Thu Jan 1 00:00:00 1970 From: Alex Kost Subject: [PATCH 1/2] emacs: Add development utils. Date: Tue, 22 Sep 2015 22:10:53 +0300 Message-ID: <87io72e0ci.fsf_-_@gmail.com> References: <1437814197-6321-1-git-send-email-alezost@gmail.com> <1437814197-6321-8-git-send-email-alezost@gmail.com> <87twrwu1ec.fsf@gnu.org> <877for2e9t.fsf_-_@gmail.com> <87fv368foo.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:43648) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZeSxs-0000Sa-Oz for guix-devel@gnu.org; Tue, 22 Sep 2015 15:10:58 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZeSxp-0007FH-F2 for guix-devel@gnu.org; Tue, 22 Sep 2015 15:10:56 -0400 In-Reply-To: <87fv368foo.fsf@gnu.org> ("Ludovic \=\?utf-8\?Q\?Court\=C3\=A8s\=22'\?\= \=\?utf-8\?Q\?s\?\= message of "Wed, 26 Aug 2015 13:14:31 +0200") List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org To: Ludovic =?utf-8?Q?Court=C3=A8s?= Cc: guix-devel@gnu.org --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Ludovic Court=C3=A8s (2015-08-26 14:14 +0300) wrote: > Alex Kost skribis: > >> Ludovic Court=C3=A8s (2015-08-18 17:17 +0300) wrote: >> [...] >>> Also, what about suggesting or even defining a key binding for this one? >>> It sounds very useful. >> >> There is an example of defining a key binding for a command in this >> section. As for the real defining, not sure if it is worth, but yeah, >> why not. We may define 'guix-minor-mode', for example, with >> guix-specific key bindings. But I don't know what bindings to use: >> 'geiser-mode' already binds many commands to [C-c =E2=80=A6]. Perhaps t= o put >> the additional keys in [C-c g =E2=80=A6]? > > Yes, =E2=80=98guix-minor-mode=E2=80=99 and C-c g both sound like good ide= as to me. Eventually I named it =E2=80=98guix-devel-mode=E2=80=99, and I made it enab= led by default (in "emacs/guix-init.el"), as it just provides some keys and won't do any harm. Is it OK? As for the keys, I put them in [C-c .] "group", because according to (info "(elisp) Key Binding Conventions"), [C-c ] bindings are reserved for users. Do you have other suggestions for the keys? --=-=-= Content-Type: text/x-patch; charset=utf-8 Content-Disposition: attachment; filename=0001-emacs-Add-development-utils.patch Content-Transfer-Encoding: quoted-printable >From 9e0541abe206e1e7409ea575acc824a26c2f62d5 Mon Sep 17 00:00:00 2001 From: Alex Kost Date: Fri, 24 Jul 2015 18:33:14 +0300 Subject: [PATCH 1/2] emacs: Add development utils. * emacs/guix-guile.el (guix-guile-current-module): New function. * emacs/guix-devel.el: New file. * emacs.am (ELFILES): Add it. * doc/emacs.texi (Emacs Development): New node. (Emacs Interface): Add it. * doc/contributing.texi (The Perfect Setup): Mention it. * doc/guix.texi (Top): Add it. * emacs/guix-init.el: Add 'guix-devel-activate-mode-maybe' to 'scheme-mode-hook'. --- doc/contributing.texi | 3 ++ doc/emacs.texi | 25 +++++++++++++- doc/guix.texi | 3 +- emacs.am | 1 + emacs/guix-devel.el | 96 +++++++++++++++++++++++++++++++++++++++++++++++= ++++ emacs/guix-guile.el | 13 +++++++ emacs/guix-init.el | 2 ++ 7 files changed, 141 insertions(+), 2 deletions(-) create mode 100644 emacs/guix-devel.el diff --git a/doc/contributing.texi b/doc/contributing.texi index ded5434..b2d097d 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. =20 +GNU Guix also comes with a minor mode that provides some additional +functionality for Scheme buffers (@pxref{Emacs Development}). + =20 @node Coding Style @section Coding Style diff --git a/doc/emacs.texi b/doc/emacs.texi index 6777346..d44d329 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 co= mmands. * Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}} fi= le names. * Build Log Mode: Emacs Build Log. Highlighting Guix build logs. -* Completions: Emacs Completions. Completing @command{guix} shell co= mmand. +* Completions: Emacs Completions. Completing @command{guix} shell command. +* Development: Emacs Development. Tools for Guix developers. @end menu =20 =20 @@ -637,3 +638,25 @@ something: @item @code{guix lint --checkers=3Dsynopsis,des}@key{TAB} =20 @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 3ca4cef..eec2821 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 co= mmands. * Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}} fi= le names. * Build Log Mode: Emacs Build Log. Highlighting Guix build logs. -* Completions: Emacs Completions. Completing @command{guix} shell co= mmand. +* Completions: Emacs Completions. Completing @command{guix} shell command. +* Development: Emacs Development. Tools for Guix developers. =20 Programming Interface =20 diff --git a/emacs.am b/emacs.am index 5d403b2..9f300bf 100644 --- a/emacs.am +++ b/emacs.am @@ -23,6 +23,7 @@ ELFILES =3D \ 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 0000000..ed82e33 --- /dev/null +++ b/emacs/guix-devel.el @@ -0,0 +1,96 @@ +;;; guix-devel.el --- Development tools -*- lexical-binding: t -*- + +;; Copyright =C2=A9 2015 Alex Kost + +;; 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 . + +;;; 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 cff9bd4..c21d27f 100644 --- a/emacs/guix-guile.el +++ b/emacs/guix-guile.el @@ -24,6 +24,19 @@ =20 ;;; Code: =20 +(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 3a727c7..96aa0c2 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)) =20 +(add-hook 'scheme-mode-hook 'guix-devel-activate-mode-maybe) + (provide 'guix-init) --=20 2.5.0 --=-=-=--