Commit 2e2a0075 authored by Stefan Monnier's avatar Stefan Monnier

(define-minor-mode): Add edebug spec.

Accept a :keymap argument, as you'd expect.
parent b02c53e6
;;; easy-mmode.el --- easy definition for major and minor modes
;; Copyright (C) 1997, 2000, 2001 Free Software Foundation, Inc.
;; Copyright (C) 1997, 2000, 2001, 2003 Free Software Foundation, Inc.
;; Author: Georges Brun-Cottan <>
;; Maintainer: Stefan Monnier <>
......@@ -98,12 +98,19 @@ BODY contains code that will be executed each time the mode is (dis)activated.
By default, the mode is buffer-local.
:init-value VAL Same as the INIT-VALUE argument.
:lighter SPEC Same as the LIGHTER argument.
:keymap MAP Same as the KEYMAP argument.
:require SYM Same as in `defcustom'.
For example, you could write
(define-minor-mode foo-mode \"If enabled, foo on you!\"
:lighter \" Foo\" :require 'foo :global t :group 'hassle :version \"27.5\"
...BODY CODE...)"
(declare (debug (&define name stringp
[&optional [&not keywordp] sexp
&optional [&not keywordp] sexp
&optional [&not keywordp] sexp]
[&rest [keywordp sexp]]
;; Allow skipping the first three args.
......@@ -121,12 +128,10 @@ For example, you could write
(extra-args nil)
(extra-keywords nil)
(require t)
(keymap-sym (if (and keymap (symbolp keymap)) keymap
(intern (concat mode-name "-map"))))
(hook (intern (concat mode-name "-hook")))
(hook-on (intern (concat mode-name "-on-hook")))
(hook-off (intern (concat mode-name "-off-hook")))
keyw keymap-sym)
;; Check keys.
(while (keywordp (setq keyw (car body)))
......@@ -138,8 +143,12 @@ For example, you could write
(:extra-args (setq extra-args (pop body)))
(:group (setq group (nconc group (list :group (pop body)))))
(:require (setq require (pop body)))
(:keymap (setq keymap (pop body)))
(t (push keyw extra-keywords) (push (pop body) extra-keywords))))
(setq keymap-sym (if (and keymap (symbolp keymap)) keymap
(intern (concat mode-name "-map"))))
(unless group
;; We might as well provide a best-guess default group.
(setq group
......@@ -204,11 +213,12 @@ With zero or negative ARG turn mode off.
,(if globalp `(customize-mark-as-set ',mode))
(unless (current-message)
(message ,(format "%s %%sabled" pretty-name)
(message ,(format "%s %%sabled" pretty-name)
(if ,mode "en" "dis")))))
;; Return the new setting.
;; Autoloading an easy-mmode-define-minor-mode autoloads
;; everything up-to-here.
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment