| blob | 46dc1f162baa180934f898e55a67dbd721fb93ec |
1 ;;; easy-mmode.el --- easy definition for major and minor modes
3 ;; Copyright (C) 1997, 2000-2011 Free Software Foundation, Inc.
5 ;; Author: Georges Brun-Cottan <Georges.Brun-Cottan@inria.fr>
6 ;; Maintainer: Stefan Monnier <monnier@gnu.org>
7 ;; Package: emacs
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/>.
26 ;;; Commentary:
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
38 ;;
39 ;; eval
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
47 ;; orderings.
49 ;; Additionally to `define-minor-mode', the package provides convenient
50 ;; ways to define keymaps, and other helper functions for major and minor modes.
52 ;;; Code:
57 "Turn the symbol MODE into a string intended for the user.
58 If provided, LIGHTER will be used to help choose capitalization by,
59 replacing its case-insensitive matches with the literal string in LIGHTER."
61 ;; Produce "Foo-Bar minor mode" from foo-bar-minor-mode.
63 ;; If the original mode name included "-minor" (some
64 ;; of them don't, e.g. auto-revert-mode), then
65 ;; replace it with " minor".
67 ;; "foo-bar-minor" -> "Foo-Bar-Minor"
69 ;; "foo-bar-minor-mode" -> "foo-bar-minor"
73 ;; Strip leading and trailing whitespace from LIGHTER.
75 lighter))
76 ;; Replace any (case-insensitive) matches for LIGHTER in NAME
77 ;; with a literal LIGHTER. E.g., if NAME is "Iimage mode" and
78 ;; LIGHTER is " iImag", then this will produce "iImage mode".
79 ;; (LIGHTER normally comes from the mode-line string passed to
80 ;; define-minor-mode, and normally includes at least one leading
81 ;; space.)
84 ;;;###autoload
86 ;;;###autoload
88 "Define a new minor mode MODE.
89 This defines the control variable MODE and the toggle command MODE.
90 DOC is the documentation for the mode toggle command.
92 Optional INIT-VALUE is the initial value of the mode's variable.
93 Optional LIGHTER is displayed in the modeline when the mode is on.
94 Optional KEYMAP is the default keymap bound to the mode keymap.
95 If non-nil, it should be a variable name (whose value is a keymap),
96 or an expression that returns either a keymap or a list of
97 arguments for `easy-mmode-define-keymap'. If KEYMAP is not a symbol,
98 this also defines the variable MODE-map.
100 BODY contains code to execute each time the mode is enabled or disabled.
101 It is executed after toggling the mode, and before running MODE-hook.
102 Before the actual body code, you can write keyword arguments, i.e.
103 alternating keywords and values. These following special keywords
104 are supported (other keywords are passed to `defcustom' if the minor
105 mode is global):
107 :group GROUP Custom group name to use in all generated `defcustom' forms.
109 Don't use this default group name unless you have written a
110 `defgroup' to define that group properly.
111 :global GLOBAL If non-nil specifies that the minor mode is not meant to be
112 buffer-local, so don't make the variable MODE buffer-local.
113 By default, the mode is buffer-local.
114 :init-value VAL Same as the INIT-VALUE argument.
115 :lighter SPEC Same as the LIGHTER argument.
116 :keymap MAP Same as the KEYMAP argument.
117 :require SYM Same as in `defcustom'.
118 :variable PLACE The location (as can be used with `setf') to use instead
119 of the variable MODE to store the state of the mode. PLACE
120 can also be of the form (GET . SET) where GET is an expression
121 that returns the current state and SET is a function that takes
122 a new state and sets it. If you specify a :variable, this
123 function assumes it is defined elsewhere.
125 For example, you could write
128 ...BODY CODE...)"
134 def-body)))
136 ;; Allow skipping the first three args.
140 init-value nil lighter nil keymap nil))
162 keyw keymap-sym)
164 ;; Check keys.
180 ;; PLACE is not of the form (GET . SET).
195 ;; We might as well provide a best-guess default group.
200 ;; TODO? Mark booleans as safe if booleanp? Eg abbrev-mode.
204 ;; Define the variable to enable or disable the mode.
206 ;; If :variable is specified, then the var will be
207 ;; declared elsewhere.
217 See the command `%s' for a description of this minor mode."
219 Setting this variable directly does not take effect;
220 either customize it (see the info node `Easy Customization')
224 ,@set
225 ,@initialize
226 ,@group
227 ,@type
231 ;; The actual function.
235 Interactively, with no prefix argument, toggle the mode.
236 With universal prefix ARG turn mode on.
237 With zero or negative ARG turn mode off.
239 ;; Use `toggle' rather than (if ,mode 0 1) so that using
240 ;; repeat-command still does the toggling correctly.
247 ;; A nil argument also means ON now.
249 ,@body
250 ;; The on/off hooks are here for backward compatibility only.
256 ;; Avoid overwriting a message shown by the body,
257 ;; but do overwrite previous messages.
264 ;; Return the new setting.
267 ;; Autoloading a define-minor-mode autoloads everything
268 ;; up-to-here.
269 :autoload-end
271 ;; Define the minor-mode keymap.
287 nil
289 \f
290 ;;;
291 ;;; make global minor mode
292 ;;;
294 ;;;###autoload
296 ;;;###autoload
298 ;;;###autoload
300 "Make a global mode GLOBAL-MODE corresponding to buffer-local minor MODE.
301 TURN-ON is a function that will be called with no args in every buffer
302 and that should try to turn MODE on if applicable for that buffer.
303 KEYS is a list of CL-style keyword arguments. As the minor mode
304 defined by this function is always global, any :global keyword is
305 ignored. Other keywords have the same meaning as in `define-minor-mode',
306 which see. In particular, :group specifies the custom group.
307 The most useful keywords are those that are passed on to the
308 `defcustom'. It normally makes no sense to pass the :lighter
309 or :keymap keywords to `define-globalized-minor-mode', since these
310 are usually passed to the buffer-local version of the minor mode.
312 If MODE's set-up depends on the major mode in effect when it was
313 enabled, then disabling and reenabling MODE should make MODE work
314 correctly with the current major mode. This is important to
315 prevent problems with derived modes, that is, major modes that
316 call another major mode in their body."
330 keyw)
332 ;; Check keys.
341 ;; We might as well provide a best-guess default group.
349 ;; The actual global minor-mode
351 ;; Very short lines to avoid too long lines in the generated
352 ;; doc string.
354 With prefix ARG, turn %s on if and only if
355 ARG is positive.
356 %s is enabled in all buffers where
357 \`%s' would do it.
358 See `%s' for more information on %s."
359 pretty-name pretty-global-name pretty-name turn-on
360 mode pretty-name)
363 ;; Setup hook to handle future mode changes and new buffers.
376 ;; Go through existing buffers.
381 ;; Autoloading define-globalized-minor-mode autoloads everything
382 ;; up-to-here.
383 :autoload-end
385 ;; List of buffers left to process.
388 ;; The function that calls TURN-ON in each buffer.
409 ;; The function that catches kill-all-local-variables.
415 ;;;
416 ;;; easy-mmode-defmap
417 ;;;
424 m
430 m)))))))
432 ;;;###autoload
434 "Return a keymap built from bindings BS.
435 BS must be a list of (KEY . BINDING) where
436 KEY and BINDINGS are suitable for `define-key'.
437 Optional NAME is passed to `make-sparse-keymap'.
438 Optional map M can be used to modify an existing map.
439 ARGS is a list of additional keyword arguments.
441 Valid keywords and arguments are:
443 :name Name of the keymap; overrides NAME argument.
444 :dense Non-nil for a dense keymap.
445 :inherit Parent keymap.
446 :group Ignored.
447 :suppress Non-nil to call `suppress-keymap' on keymap,
448 'nodigits to suppress digits as prefix arguments."
480 m))
482 ;;;###autoload
484 "Define a constant M whose value is the result of `easy-mmode-define-keymap'.
485 The M, BS, and ARGS arguments are as per that function. DOC is
486 the constant's documentation."
491 \f
492 ;;;
493 ;;; easy-mmode-defsyntax
494 ;;;
507 st))
509 ;;;###autoload
511 "Define variable ST as a syntax-table.
512 CSS contains a list of syntax specifications of the form (CHAR . SYNTAX)."
518 \f
519 ;;;
520 ;;; easy-mmode-define-navigation
521 ;;;
525 "Define BASE-next and BASE-prev to navigate in the buffer.
526 RE determines the places the commands should move point to.
527 NAME should describe the entities matched by RE. It is used to build
528 the docstrings of the two functions.
529 BASE-next also tries to make sure that the whole entry is visible by
530 searching for its end (by calling ENDFUN if provided or by looking for
531 the next entry) and recentering if necessary.
532 ENDFUN should return the end position (with or without moving point).
533 NARROWFUN non-nil means to check for narrowing before moving, and if
534 found, do `widen' first and then call NARROWFUN with no args after moving.
535 BODY is executed after moving to the destination location."
546 ,body
588 ;;; easy-mmode.el ends here