| blob | 5a21946183e93bd4a1f2d1889003cd1ce87af8c1 |
1 ;;; easy-mmode.el --- easy definition for major and minor modes
3 ;; Copyright (C) 1997, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4 ;; 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Georges Brun-Cottan <Georges.Brun-Cottan@inria.fr>
7 ;; 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/>.
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 function defines the associated control variable MODE, keymap MODE-map,
90 and toggle command MODE.
92 DOC is the documentation for the mode toggle command.
93 Optional INIT-VALUE is the initial value of the mode's variable.
94 Optional LIGHTER is displayed in the modeline when the mode is on.
95 Optional KEYMAP is the default (defvar) keymap bound to the mode keymap.
96 If it is a list, it is passed to `easy-mmode-define-keymap'
97 in order to build a valid keymap. It's generally better to use
98 a separate MODE-map variable than to use this argument.
99 The above three arguments can be skipped if keyword arguments are
100 used (see below).
102 BODY contains code to execute each time the mode is activated or deactivated.
103 It is executed after toggling the mode,
104 and before running the hook variable `MODE-hook'.
105 Before the actual body code, you can write keyword arguments (alternating
106 keywords and values). These following keyword arguments are supported (other
107 keywords will be passed to `defcustom' if the minor mode is global):
108 :group GROUP Custom group name to use in all generated `defcustom' forms.
110 Don't use this default group name unless you have written a
111 `defgroup' to define that group properly.
112 :global GLOBAL If non-nil specifies that the minor mode is not meant to be
113 buffer-local, so don't make the variable MODE buffer-local.
114 By default, the mode is buffer-local.
115 :init-value VAL Same as the INIT-VALUE argument.
116 :lighter SPEC Same as the LIGHTER argument.
117 :keymap MAP Same as the KEYMAP argument.
118 :require SYM Same as in `defcustom'.
119 :variable PLACE The location (as can be used with `setf') to use instead
120 of the variable MODE to store the state of the mode. PLACE
121 can also be of the form (GET . SET) where GET is an expression
122 that returns the current state and SET is a function that takes
123 a new state and sets it.
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.
203 ;; Define the variable to enable or disable the mode.
205 ;; If :variable is specified, then the var will be
206 ;; declared elsewhere.
216 See the command `%s' for a description of this minor mode."
218 Setting this variable directly does not take effect;
219 either customize it (see the info node `Easy Customization')
223 ,@set
224 ,@initialize
225 ,@group
226 ,@type
230 ;; The actual function.
234 Interactively, with no prefix argument, toggle the mode.
235 With universal prefix ARG turn mode on.
236 With zero or negative ARG turn mode off.
238 ;; Use `toggle' rather than (if ,mode 0 1) so that using
239 ;; repeat-command still does the toggling correctly.
246 ;; A nil argument also means ON now.
248 ,@body
249 ;; The on/off hooks are here for backward compatibility only.
255 ;; Avoid overwriting a message shown by the body,
256 ;; but do overwrite previous messages.
263 ;; Return the new setting.
266 ;; Autoloading a define-minor-mode autoloads everything
267 ;; up-to-here.
268 :autoload-end
270 ;; Define the minor-mode keymap.
286 nil
288 \f
289 ;;;
290 ;;; make global minor mode
291 ;;;
293 ;;;###autoload
295 ;;;###autoload
297 ;;;###autoload
299 "Make a global mode GLOBAL-MODE corresponding to buffer-local minor MODE.
300 TURN-ON is a function that will be called with no args in every buffer
301 and that should try to turn MODE on if applicable for that buffer.
302 KEYS is a list of CL-style keyword arguments. As the minor mode
303 defined by this function is always global, any :global keyword is
304 ignored. Other keywords have the same meaning as in `define-minor-mode',
305 which see. In particular, :group specifies the custom group.
306 The most useful keywords are those that are passed on to the
307 `defcustom'. It normally makes no sense to pass the :lighter
308 or :keymap keywords to `define-globalized-minor-mode', since these
309 are usually passed to the buffer-local version of the minor mode.
311 If MODE's set-up depends on the major mode in effect when it was
312 enabled, then disabling and reenabling MODE should make MODE work
313 correctly with the current major mode. This is important to
314 prevent problems with derived modes, that is, major modes that
315 call another major mode in their body."
329 keyw)
331 ;; Check keys.
340 ;; We might as well provide a best-guess default group.
348 ;; The actual global minor-mode
350 ;; Very short lines to avoid too long lines in the generated
351 ;; doc string.
353 With prefix ARG, turn %s on if and only if
354 ARG is positive.
355 %s is enabled in all buffers where
356 \`%s' would do it.
357 See `%s' for more information on %s."
358 pretty-name pretty-global-name pretty-name turn-on
359 mode pretty-name)
362 ;; Setup hook to handle future mode changes and new buffers.
375 ;; Go through existing buffers.
380 ;; Autoloading define-globalized-minor-mode autoloads everything
381 ;; up-to-here.
382 :autoload-end
384 ;; List of buffers left to process.
387 ;; The function that calls TURN-ON in each buffer.
408 ;; The function that catches kill-all-local-variables.
414 ;;;
415 ;;; easy-mmode-defmap
416 ;;;
423 m
429 m)))))))
431 ;;;###autoload
433 "Return a keymap built from bindings BS.
434 BS must be a list of (KEY . BINDING) where
435 KEY and BINDINGS are suitable for `define-key'.
436 Optional NAME is passed to `make-sparse-keymap'.
437 Optional map M can be used to modify an existing map.
438 ARGS is a list of additional keyword arguments.
440 Valid keywords and arguments are:
442 :name Name of the keymap; overrides NAME argument.
443 :dense Non-nil for a dense keymap.
444 :inherit Parent keymap.
445 :group Ignored.
446 :suppress Non-nil to call `suppress-keymap' on keymap,
447 'nodigits to suppress digits as prefix arguments."
479 m))
481 ;;;###autoload
483 "Define a constant M whose value is the result of `easy-mmode-define-keymap'.
484 The M, BS, and ARGS arguments are as per that function. DOC is
485 the constant's documentation."
490 \f
491 ;;;
492 ;;; easy-mmode-defsyntax
493 ;;;
506 st))
508 ;;;###autoload
510 "Define variable ST as a syntax-table.
511 CSS contains a list of syntax specifications of the form (CHAR . SYNTAX)."
517 \f
518 ;;;
519 ;;; easy-mmode-define-navigation
520 ;;;
524 "Define BASE-next and BASE-prev to navigate in the buffer.
525 RE determines the places the commands should move point to.
526 NAME should describe the entities matched by RE. It is used to build
527 the docstrings of the two functions.
528 BASE-next also tries to make sure that the whole entry is visible by
529 searching for its end (by calling ENDFUN if provided or by looking for
530 the next entry) and recentering if necessary.
531 ENDFUN should return the end position (with or without moving point).
532 NARROWFUN non-nil means to check for narrowing before moving, and if
533 found, do `widen' first and then call NARROWFUN with no args after moving.
534 BODY is executed after moving to the destination location."
545 ,body
587 ;; arch-tag: d48a5250-6961-4528-9cb0-3c9ea042a66a
588 ;;; easy-mmode.el ends here