1 ;;; easy-mmode.el --- easy definition for major and minor modes
3 ;; Copyright (C) 1997, 2000-2012 Free Software Foundation, Inc.
5 ;; Author: Georges Brun-Cottan <Georges.Brun-Cottan@inria.fr>
6 ;; Maintainer: Stefan Monnier <monnier@gnu.org>
9 ;; Keywords: extensions lisp
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; Minor modes are useful and common. This package makes defining a
29 ;; minor mode easy, by focusing on the writing of the minor mode
30 ;; functionalities themselves. Moreover, this package enforces a
31 ;; conventional naming of user interface primitives, making things
32 ;; natural for the minor-mode end-users.
34 ;; For each mode, easy-mmode defines the following:
35 ;; <mode> : The minor mode predicate. A buffer-local variable.
36 ;; <mode>-map : The keymap possibly associated to <mode>.
37 ;; see `define-minor-mode' documentation
40 ;; (pp (macroexpand '(define-minor-mode <your-mode> <doc>)))
41 ;; to check the result before using it.
43 ;; The order in which minor modes are installed is important. Keymap
44 ;; lookup proceeds down minor-mode-map-alist, and the order there
45 ;; tends to be the reverse of the order in which the modes were
46 ;; installed. Perhaps there should be a feature to let you specify
49 ;; Additionally to `define-minor-mode', the package provides convenient
50 ;; ways to define keymaps, and other helper functions for major and minor modes.
54 (defun easy-mmode-pretty-mode-name (mode &optional lighter)
55 "Turn the symbol MODE into a string intended for the user.
56 If provided, LIGHTER will be used to help choose capitalization by,
57 replacing its case-insensitive matches with the literal string in LIGHTER."
58 (let* ((case-fold-search t)
59 ;; Produce "Foo-Bar minor mode" from foo-bar-minor-mode.
60 (name (concat (replace-regexp-in-string
61 ;; If the original mode name included "-minor" (some
62 ;; of them don't, e.g. auto-revert-mode), then
63 ;; replace it with " minor".
65 ;; "foo-bar-minor" -> "Foo-Bar-Minor"
66 (capitalize (replace-regexp-in-string
67 ;; "foo-bar-minor-mode" -> "foo-bar-minor"
68 "toggle-\\|-mode\\'" ""
71 (if (not (stringp lighter)) name
72 ;; Strip leading and trailing whitespace from LIGHTER.
73 (setq lighter (replace-regexp-in-string "\\`\\s-+\\|\\s-+\\'" ""
75 ;; Replace any (case-insensitive) matches for LIGHTER in NAME
76 ;; with a literal LIGHTER. E.g., if NAME is "Iimage mode" and
77 ;; LIGHTER is " iImag", then this will produce "iImage mode".
78 ;; (LIGHTER normally comes from the mode-line string passed to
79 ;; define-minor-mode, and normally includes at least one leading
81 (replace-regexp-in-string (regexp-quote lighter) lighter name t t))))
84 (defalias 'easy-mmode-define-minor-mode 'define-minor-mode)
86 (defmacro define-minor-mode (mode doc &optional init-value lighter keymap &rest body)
87 "Define a new minor mode MODE.
88 This defines the toggle command MODE and (by default) a control variable
89 MODE (you can override this with the :variable keyword, see below).
90 DOC is the documentation for the mode toggle command.
92 The defined mode command takes one optional (prefix) argument.
93 Interactively with no prefix argument it toggles the mode.
94 With a prefix argument, it enables the mode if the argument is
95 positive and otherwise disables it. When called from Lisp, it
96 enables the mode if the argument is omitted or nil, and toggles
97 the mode if the argument is `toggle'. If DOC is nil this
98 function adds a basic doc-string stating these facts.
100 Optional INIT-VALUE is the initial value of the mode's variable.
101 Optional LIGHTER is displayed in the mode line when the mode is on.
102 Optional KEYMAP is the default keymap bound to the mode keymap.
103 If non-nil, it should be a variable name (whose value is a keymap),
104 or an expression that returns either a keymap or a list of
105 arguments for `easy-mmode-define-keymap'. If you supply a KEYMAP
106 argument that is not a symbol, this macro defines the variable
107 MODE-map and gives it the value that KEYMAP specifies.
109 BODY contains code to execute each time the mode is enabled or disabled.
110 It is executed after toggling the mode, and before running MODE-hook.
111 Before the actual body code, you can write keyword arguments, i.e.
112 alternating keywords and values. These following special keywords
113 are supported (other keywords are passed to `defcustom' if the minor
116 :group GROUP Custom group name to use in all generated `defcustom' forms.
117 Defaults to MODE without the possible trailing \"-mode\".
118 Don't use this default group name unless you have written a
119 `defgroup' to define that group properly.
120 :global GLOBAL If non-nil specifies that the minor mode is not meant to be
121 buffer-local, so don't make the variable MODE buffer-local.
122 By default, the mode is buffer-local.
123 :init-value VAL Same as the INIT-VALUE argument.
124 Not used if you also specify :variable.
125 :lighter SPEC Same as the LIGHTER argument.
126 :keymap MAP Same as the KEYMAP argument.
127 :require SYM Same as in `defcustom'.
128 :variable PLACE The location to use instead of the variable MODE to store
129 the state of the mode. This can be simply a different
130 named variable, or more generally anything that can be used
131 with the CL macro `setf'. PLACE can also be of the form
132 \(GET . SET), where GET is an expression that returns the
133 current state, and SET is a function that takes one argument,
134 the new state, and sets it. If you specify a :variable,
135 this function does not define a MODE variable (nor any of
136 the terms used in :variable).
137 :after-hook A single lisp form which is evaluated after the mode hooks
138 have been run. It should not be quoted.
140 For example, you could write
141 (define-minor-mode foo-mode \"If enabled, foo on you!\"
142 :lighter \" Foo\" :require 'foo :global t :group 'hassle :version \"27.5\"
144 (declare (doc-string 2)
145 (debug (&define name stringp
146 [&optional [¬ keywordp] sexp
147 &optional [¬ keywordp] sexp
148 &optional [¬ keywordp] sexp]
149 [&rest [keywordp sexp]]
152 ;; Allow skipping the first three args.
154 ((keywordp init-value)
155 (setq body `(,init-value ,lighter ,keymap ,@body)
156 init-value nil lighter nil keymap nil))
158 (setq body `(,lighter ,keymap ,@body) lighter nil keymap nil))
159 ((keywordp keymap) (push keymap body) (setq keymap nil)))
161 (let* ((last-message (make-symbol "last-message"))
162 (mode-name (symbol-name mode))
163 (pretty-name (easy-mmode-pretty-mode-name mode lighter))
171 (variable nil) ;The PLACE where the state is stored.
172 (setter nil) ;The function (if any) to set the mode var.
173 (modefun mode) ;The minor mode function name we're defining.
176 (hook (intern (concat mode-name "-hook")))
177 (hook-on (intern (concat mode-name "-on-hook")))
178 (hook-off (intern (concat mode-name "-off-hook")))
182 (while (keywordp (setq keyw (car body)))
183 (setq body (cdr body))
185 (`:init-value (setq init-value (pop body)))
186 (`:lighter (setq lighter (purecopy (pop body))))
187 (`:global (setq globalp (pop body)))
188 (`:extra-args (setq extra-args (pop body)))
189 (`:set (setq set (list :set (pop body))))
190 (`:initialize (setq initialize (list :initialize (pop body))))
191 (`:group (setq group (nconc group (list :group (pop body)))))
192 (`:type (setq type (list :type (pop body))))
193 (`:require (setq require (pop body)))
194 (`:keymap (setq keymap (pop body)))
195 (`:variable (setq variable (pop body))
196 (if (not (and (setq tmp (cdr-safe variable))
199 ;; PLACE is not of the form (GET . SET).
201 (setq mode (car variable))
202 (setq setter (cdr variable))))
203 (`:after-hook (setq after-hook (pop body)))
204 (_ (push keyw extra-keywords) (push (pop body) extra-keywords))))
206 (setq keymap-sym (if (and keymap (symbolp keymap)) keymap
207 (intern (concat mode-name "-map"))))
209 (unless set (setq set '(:set 'custom-set-minor-mode)))
212 (setq initialize '(:initialize 'custom-initialize-default)))
215 ;; We might as well provide a best-guess default group.
217 `(:group ',(intern (replace-regexp-in-string
218 "-mode\\'" "" mode-name)))))
220 ;; TODO? Mark booleans as safe if booleanp? Eg abbrev-mode.
221 (unless type (setq type '(:type 'boolean)))
224 ;; Define the variable to enable or disable the mode.
226 ;; If :variable is specified, then the var will be
227 ;; declared elsewhere.
232 (defvar ,mode ,init-value ,(format "Non-nil if %s is enabled.
233 Use the command `%s' to change this variable." pretty-name mode))
234 (make-variable-buffer-local ',mode)))
236 (let ((base-doc-string
237 (concat "Non-nil if %s is enabled.
238 See the command `%s' for a description of this minor mode."
240 Setting this variable directly does not take effect;
241 either customize it (see the info node `Easy Customization')
242 or call the function `%s'."))))
243 `(defcustom ,mode ,init-value
244 ,(format base-doc-string pretty-name mode mode)
249 ,@(unless (eq require t) `(:require ,require))
250 ,@(nreverse extra-keywords)))))
252 ;; The actual function.
253 (defun ,modefun (&optional arg ,@extra-args)
255 (format (concat "Toggle %s on or off.
256 With a prefix argument ARG, enable %s if ARG is
257 positive, and disable it otherwise. If called from Lisp, enable
258 the mode if ARG is omitted or nil, and toggle it if ARG is `toggle'.
259 \\{%s}") pretty-name pretty-name keymap-sym))
260 ;; Use `toggle' rather than (if ,mode 0 1) so that using
261 ;; repeat-command still does the toggling correctly.
262 (interactive (list (or current-prefix-arg 'toggle)))
263 (let ((,last-message (current-message)))
264 (,@(if setter `(funcall #',setter)
265 (list (if (symbolp mode) 'setq 'setf) mode))
268 ;; A nil argument also means ON now.
269 (> (prefix-numeric-value arg) 0)))
271 ;; The on/off hooks are here for backward compatibility only.
272 (run-hooks ',hook (if ,mode ',hook-on ',hook-off))
273 (if (called-interactively-p 'any)
275 ,(if (and globalp (symbolp mode))
276 `(customize-mark-as-set ',mode))
277 ;; Avoid overwriting a message shown by the body,
278 ;; but do overwrite previous messages.
279 (unless (and (current-message)
280 (not (equal ,last-message
282 (message ,(format "%s %%sabled" pretty-name)
283 (if ,mode "en" "dis")))))
284 ,@(when after-hook `(,after-hook)))
285 (force-mode-line-update)
286 ;; Return the new setting.
289 ;; Autoloading a define-minor-mode autoloads everything
293 ;; Define the minor-mode keymap.
294 ,(unless (symbolp keymap) ;nil is also a symbol.
297 (cond ((keymapp m) m)
298 ((listp m) (easy-mmode-define-keymap m))
299 (t (error "Invalid keymap %S" m))))
300 ,(format "Keymap for `%s'." mode-name)))
302 ,(if (not (symbolp mode))
303 (if (or lighter keymap)
304 (error ":lighter and :keymap unsupported with mode expression %s" mode))
306 (add-minor-mode ',mode ',lighter
307 ,(if keymap keymap-sym
308 `(if (boundp ',keymap-sym) ,keymap-sym))
310 ,(unless (eq mode modefun) `',modefun)))))))
313 ;;; make global minor mode
317 (defalias 'easy-mmode-define-global-mode 'define-globalized-minor-mode)
319 (defalias 'define-global-minor-mode 'define-globalized-minor-mode)
321 (defmacro define-globalized-minor-mode (global-mode mode turn-on &rest keys)
322 "Make a global mode GLOBAL-MODE corresponding to buffer-local minor MODE.
323 TURN-ON is a function that will be called with no args in every buffer
324 and that should try to turn MODE on if applicable for that buffer.
325 KEYS is a list of CL-style keyword arguments. As the minor mode
326 defined by this function is always global, any :global keyword is
327 ignored. Other keywords have the same meaning as in `define-minor-mode',
328 which see. In particular, :group specifies the custom group.
329 The most useful keywords are those that are passed on to the
330 `defcustom'. It normally makes no sense to pass the :lighter
331 or :keymap keywords to `define-globalized-minor-mode', since these
332 are usually passed to the buffer-local version of the minor mode.
334 If MODE's set-up depends on the major mode in effect when it was
335 enabled, then disabling and reenabling MODE should make MODE work
336 correctly with the current major mode. This is important to
337 prevent problems with derived modes, that is, major modes that
338 call another major mode in their body."
339 (declare (doc-string 2))
340 (let* ((global-mode-name (symbol-name global-mode))
341 (pretty-name (easy-mmode-pretty-mode-name mode))
342 (pretty-global-name (easy-mmode-pretty-mode-name global-mode))
345 (MODE-buffers (intern (concat global-mode-name "-buffers")))
346 (MODE-enable-in-buffers
347 (intern (concat global-mode-name "-enable-in-buffers")))
349 (intern (concat global-mode-name "-check-buffers")))
350 (MODE-cmhh (intern (concat global-mode-name "-cmhh")))
351 (MODE-major-mode (intern (concat (symbol-name mode) "-major-mode")))
355 (while (keywordp (setq keyw (car keys)))
356 (setq keys (cdr keys))
358 (`:group (setq group (nconc group (list :group (pop keys)))))
359 (`:global (setq keys (cdr keys)))
360 (_ (push keyw extra-keywords) (push (pop keys) extra-keywords))))
363 ;; We might as well provide a best-guess default group.
365 `(:group ',(intern (replace-regexp-in-string
366 "-mode\\'" "" (symbol-name mode))))))
371 (defvar ,MODE-major-mode nil)
372 (make-variable-buffer-local ',MODE-major-mode))
373 ;; The actual global minor-mode
374 (define-minor-mode ,global-mode
375 ;; Very short lines to avoid too long lines in the generated
377 ,(format "Toggle %s in all buffers.
378 With prefix ARG, enable %s if ARG is positive;
379 otherwise, disable it. If called from Lisp, enable the mode if
380 ARG is omitted or nil.
382 %s is enabled in all buffers where
384 See `%s' for more information on %s."
385 pretty-name pretty-global-name
386 pretty-name turn-on mode pretty-name)
387 :global t ,@group ,@(nreverse extra-keywords)
389 ;; Setup hook to handle future mode changes and new buffers.
392 (add-hook 'after-change-major-mode-hook
393 ',MODE-enable-in-buffers)
394 (add-hook 'change-major-mode-after-body-hook
395 ',MODE-enable-in-buffers)
396 (add-hook 'find-file-hook ',MODE-check-buffers)
397 (add-hook 'change-major-mode-hook ',MODE-cmhh))
398 (remove-hook 'after-change-major-mode-hook ',MODE-enable-in-buffers)
399 (remove-hook 'change-major-mode-after-body-hook
400 ',MODE-enable-in-buffers)
401 (remove-hook 'find-file-hook ',MODE-check-buffers)
402 (remove-hook 'change-major-mode-hook ',MODE-cmhh))
404 ;; Go through existing buffers.
405 (dolist (buf (buffer-list))
406 (with-current-buffer buf
407 (if ,global-mode (,turn-on) (when ,mode (,mode -1))))))
409 ;; Autoloading define-globalized-minor-mode autoloads everything
413 ;; List of buffers left to process.
414 (defvar ,MODE-buffers nil)
416 ;; The function that calls TURN-ON in each buffer.
417 (defun ,MODE-enable-in-buffers ()
418 (dolist (buf ,MODE-buffers)
419 (when (buffer-live-p buf)
420 (with-current-buffer buf
421 (unless (eq ,MODE-major-mode major-mode)
426 (setq ,MODE-major-mode major-mode))
428 (setq ,MODE-major-mode major-mode)))))))
429 (put ',MODE-enable-in-buffers 'definition-name ',global-mode)
431 (defun ,MODE-check-buffers ()
432 (,MODE-enable-in-buffers)
433 (setq ,MODE-buffers nil)
434 (remove-hook 'post-command-hook ',MODE-check-buffers))
435 (put ',MODE-check-buffers 'definition-name ',global-mode)
437 ;; The function that catches kill-all-local-variables.
439 (add-to-list ',MODE-buffers (current-buffer))
440 (add-hook 'post-command-hook ',MODE-check-buffers))
441 (put ',MODE-cmhh 'definition-name ',global-mode))))
444 ;;; easy-mmode-defmap
448 (if (fboundp 'set-keymap-parents)
449 (defalias 'easy-mmode-set-keymap-parents 'set-keymap-parents)
450 (defun easy-mmode-set-keymap-parents (m parents)
454 ((not (consp parents)) parents)
455 ((not (cdr parents)) (car parents))
456 (t (let ((m (copy-keymap (pop parents))))
457 (easy-mmode-set-keymap-parents m parents)
461 (defun easy-mmode-define-keymap (bs &optional name m args)
462 "Return a keymap built from bindings BS.
463 BS must be a list of (KEY . BINDING) where
464 KEY and BINDINGS are suitable for `define-key'.
465 Optional NAME is passed to `make-sparse-keymap'.
466 Optional map M can be used to modify an existing map.
467 ARGS is a list of additional keyword arguments.
469 Valid keywords and arguments are:
471 :name Name of the keymap; overrides NAME argument.
472 :dense Non-nil for a dense keymap.
473 :inherit Parent keymap.
475 :suppress Non-nil to call `suppress-keymap' on keymap,
476 'nodigits to suppress digits as prefix arguments."
477 (let (inherit dense suppress)
479 (let ((key (pop args))
482 (`:name (setq name val))
483 (`:dense (setq dense val))
484 (`:inherit (setq inherit val))
485 (`:suppress (setq suppress val))
487 (_ (message "Unknown argument %s in defmap" key)))))
489 (setq bs (append m bs))
490 (setq m (if dense (make-keymap name) (make-sparse-keymap name))))
492 (suppress-keymap m (eq suppress 'nodigits)))
496 (dolist (key (if (consp keys) keys (list keys)))
499 (substitute-key-definition key binding m global-map))
501 (unless (keymapp (lookup-key m key)) (define-key m key binding)))
502 ((let ((o (lookup-key m key)))
503 (or (null o) (numberp o) (eq o 'undefined)))
504 (define-key m key binding))))))
506 ((keymapp inherit) (set-keymap-parent m inherit))
507 ((consp inherit) (easy-mmode-set-keymap-parents m inherit)))
511 (defmacro easy-mmode-defmap (m bs doc &rest args)
512 "Define a constant M whose value is the result of `easy-mmode-define-keymap'.
513 The M, BS, and ARGS arguments are as per that function. DOC is
514 the constant's documentation."
516 (easy-mmode-define-keymap ,bs nil (if (boundp ',m) ,m) ,(cons 'list args))
521 ;;; easy-mmode-defsyntax
524 (defun easy-mmode-define-syntax (css args)
525 (let ((st (make-syntax-table (plist-get args :copy)))
526 (parent (plist-get args :inherit)))
528 (let ((char (car cs))
531 (mapc (lambda (c) (modify-syntax-entry c syntax st)) char)
532 (modify-syntax-entry char syntax st))))
533 (if parent (set-char-table-parent
534 st (if (symbolp parent) (symbol-value parent) parent)))
538 (defmacro easy-mmode-defsyntax (st css doc &rest args)
539 "Define variable ST as a syntax-table.
540 CSS contains a list of syntax specifications of the form (CHAR . SYNTAX)."
542 (autoload 'easy-mmode-define-syntax "easy-mmode")
543 (defconst ,st (easy-mmode-define-syntax ,css ,(cons 'list args)) ,doc)))
548 ;;; easy-mmode-define-navigation
551 (defmacro easy-mmode-define-navigation (base re &optional name endfun narrowfun
553 "Define BASE-next and BASE-prev to navigate in the buffer.
554 RE determines the places the commands should move point to.
555 NAME should describe the entities matched by RE. It is used to build
556 the docstrings of the two functions.
557 BASE-next also tries to make sure that the whole entry is visible by
558 searching for its end (by calling ENDFUN if provided or by looking for
559 the next entry) and recentering if necessary.
560 ENDFUN should return the end position (with or without moving point).
561 NARROWFUN non-nil means to check for narrowing before moving, and if
562 found, do `widen' first and then call NARROWFUN with no args after moving.
563 BODY is executed after moving to the destination location."
564 (declare (indent 5) (debug (exp exp exp def-form def-form &rest def-body)))
565 (let* ((base-name (symbol-name base))
566 (prev-sym (intern (concat base-name "-prev")))
567 (next-sym (intern (concat base-name "-next")))
570 (if (null narrowfun) body
572 (prog1 (or (< (- (point-max) (point-min)) (buffer-size)))
575 (when was-narrowed (,narrowfun)))))))
576 (unless name (setq name base-name))
578 (defun ,next-sym (&optional count)
579 ,(format "Go to the next COUNT'th %s." name)
581 (unless count (setq count 1))
582 (if (< count 0) (,prev-sym (- count))
583 (if (looking-at ,re) (setq count (1+ count)))
584 ,(funcall when-narrowed
585 `(if (not (re-search-forward ,re nil t count))
587 (goto-char (or ,(if endfun `(,endfun)) (point-max)))
588 (user-error "No next %s" ,name))
589 (goto-char (match-beginning 0))
590 (when (and (eq (current-buffer) (window-buffer (selected-window)))
591 (called-interactively-p 'interactive))
592 (let ((endpt (or (save-excursion
593 ,(if endfun `(,endfun)
594 `(re-search-forward ,re nil t 2)))
596 (unless (pos-visible-in-window-p endpt nil t)
599 (put ',next-sym 'definition-name ',base)
600 (defun ,prev-sym (&optional count)
601 ,(format "Go to the previous COUNT'th %s" (or name base-name))
603 (unless count (setq count 1))
604 (if (< count 0) (,next-sym (- count))
605 ,(funcall when-narrowed
606 `(unless (re-search-backward ,re nil t count)
607 (user-error "No previous %s" ,name)))
609 (put ',prev-sym 'definition-name ',base))))
612 (provide 'easy-mmode)
614 ;;; easy-mmode.el ends here