| blob | a19e2df3069516f89dd7a69846d79fbf87653e6f |
1 ;;; easy-mmode.el --- easy definition for major and minor modes
3 ;; Copyright (C) 1997, 2000, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008 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, or (at your option)
16 ;; 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; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; Minor modes are useful and common. This package makes defining a
31 ;; minor mode easy, by focusing on the writing of the minor mode
32 ;; functionalities themselves. Moreover, this package enforces a
33 ;; conventional naming of user interface primitives, making things
34 ;; natural for the minor-mode end-users.
36 ;; For each mode, easy-mmode defines the following:
37 ;; <mode> : The minor mode predicate. A buffer-local variable.
38 ;; <mode>-map : The keymap possibly associated to <mode>.
39 ;; see `define-minor-mode' documentation
40 ;;
41 ;; eval
42 ;; (pp (macroexpand '(define-minor-mode <your-mode> <doc>)))
43 ;; to check the result before using it.
45 ;; The order in which minor modes are installed is important. Keymap
46 ;; lookup proceeds down minor-mode-map-alist, and the order there
47 ;; tends to be the reverse of the order in which the modes were
48 ;; installed. Perhaps there should be a feature to let you specify
49 ;; orderings.
51 ;; Additionally to `define-minor-mode', the package provides convenient
52 ;; ways to define keymaps, and other helper functions for major and minor modes.
54 ;;; Code:
59 "Turn the symbol MODE into a string intended for the user.
60 If provided, LIGHTER will be used to help choose capitalization by,
61 replacing its case-insensitive matches with the literal string in LIGHTER."
63 ;; Produce "Foo-Bar minor mode" from foo-bar-minor-mode.
65 ;; If the original mode name included "-minor" (some
66 ;; of them don't, e.g. auto-revert-mode), then
67 ;; replace it with " minor".
69 ;; "foo-bar-minor" -> "Foo-Bar-Minor"
71 ;; "foo-bar-minor-mode" -> "foo-bar-minor"
75 ;; Strip leading and trailing whitespace from LIGHTER.
77 lighter))
78 ;; Replace any (case-insensitive) matches for LIGHTER in NAME
79 ;; with a literal LIGHTER. E.g., if NAME is "Iimage mode" and
80 ;; LIGHTER is " iImag", then this will produce "iImage mode".
81 ;; (LIGHTER normally comes from the mode-line string passed to
82 ;; define-minor-mode, and normally includes at least one leading
83 ;; space.)
86 ;;;###autoload
88 ;;;###autoload
90 "Define a new minor mode MODE.
91 This function defines the associated control variable MODE, keymap MODE-map,
92 and toggle command MODE.
94 DOC is the documentation for the mode toggle command.
95 Optional INIT-VALUE is the initial value of the mode's variable.
96 Optional LIGHTER is displayed in the modeline when the mode is on.
97 Optional KEYMAP is the default (defvar) keymap bound to the mode keymap.
98 If it is a list, it is passed to `easy-mmode-define-keymap'
99 in order to build a valid keymap. It's generally better to use
100 a separate MODE-map variable than to use this argument.
101 The above three arguments can be skipped if keyword arguments are
102 used (see below).
104 BODY contains code to execute each time the mode is activated or deactivated.
105 It is executed after toggling the mode,
106 and before running the hook variable `MODE-hook'.
107 Before the actual body code, you can write keyword arguments (alternating
108 keywords and values). These following keyword arguments are supported (other
109 keywords will be passed to `defcustom' if the minor mode is global):
110 :group GROUP Custom group name to use in all generated `defcustom' forms.
112 Don't use this default group name unless you have written a
113 `defgroup' to define that group properly.
114 :global GLOBAL If non-nil specifies that the minor mode is not meant to be
115 buffer-local, so don't make the variable MODE buffer-local.
116 By default, the mode is buffer-local.
117 :init-value VAL Same as the INIT-VALUE argument.
118 :lighter SPEC Same as the LIGHTER argument.
119 :keymap MAP Same as the KEYMAP argument.
120 :require SYM Same as in `defcustom'.
122 For example, you could write
125 ...BODY CODE...)"
131 def-body)))
133 ;; Allow skipping the first three args.
137 init-value nil lighter nil keymap nil))
156 keyw keymap-sym)
158 ;; Check keys.
183 ;; We might as well provide a best-guess default group.
191 ;; Define the variable to enable or disable the mode.
200 See the command `%s' for a description of this minor mode."
202 Setting this variable directly does not take effect;
203 either customize it (see the info node `Easy Customization')
207 ,@set
208 ,@initialize
209 ,@group
210 ,@type
214 ;; The actual function.
218 Interactively, with no prefix argument, toggle the mode.
219 With universal prefix ARG turn mode on.
220 With zero or negative ARG turn mode off.
222 ;; Use `toggle' rather than (if ,mode 0 1) so that using
223 ;; repeat-command still does the toggling correctly.
233 "Toggling %s off; better pass an explicit argument."
235 nil))))
236 ,@body
237 ;; The on/off hooks are here for backward compatibility only.
242 ;; Avoid overwriting a message shown by the body,
243 ;; but do overwrite previous messages.
250 ;; Return the new setting.
253 ;; Autoloading a define-minor-mode autoloads everything
254 ;; up-to-here.
255 :autoload-end
257 ;; Define the minor-mode keymap.
270 \f
271 ;;;
272 ;;; make global minor mode
273 ;;;
275 ;;;###autoload
277 ;;;###autoload
279 ;;;###autoload
281 "Make a global mode GLOBAL-MODE corresponding to buffer-local minor MODE.
282 TURN-ON is a function that will be called with no args in every buffer
283 and that should try to turn MODE on if applicable for that buffer.
284 KEYS is a list of CL-style keyword arguments. As the minor mode
285 defined by this function is always global, any :global keyword is
286 ignored. Other keywords have the same meaning as in `define-minor-mode',
287 which see. In particular, :group specifies the custom group.
288 The most useful keywords are those that are passed on to the
289 `defcustom'. It normally makes no sense to pass the :lighter
290 or :keymap keywords to `define-globalized-minor-mode', since these
291 are usually passed to the buffer-local version of the minor mode.
293 If MODE's set-up depends on the major mode in effect when it was
294 enabled, then disabling and reenabling MODE should make MODE work
295 correctly with the current major mode. This is important to
296 prevent problems with derived modes, that is, major modes that
297 call another major mode in their body."
311 keyw)
313 ;; Check keys.
322 ;; We might as well provide a best-guess default group.
330 ;; The actual global minor-mode
333 With prefix ARG, turn %s on if and only if ARG is positive.
334 %s is enabled in all buffers where `%s' would do it.
335 See `%s' for more information on %s."
336 pretty-name pretty-global-name pretty-name turn-on
337 mode pretty-name)
340 ;; Setup hook to handle future mode changes and new buffers.
351 ;; Go through existing buffers.
356 ;; Autoloading define-globalized-minor-mode autoloads everything
357 ;; up-to-here.
358 :autoload-end
360 ;; List of buffers left to process.
363 ;; The function that calls TURN-ON in each buffer.
383 ;; The function that catches kill-all-local-variables.
389 ;;;
390 ;;; easy-mmode-defmap
391 ;;;
397 m
403 m))))))
405 ;;;###autoload
407 "Return a keymap built from bindings BS.
408 BS must be a list of (KEY . BINDING) where
409 KEY and BINDINGS are suitable for `define-key'.
410 Optional NAME is passed to `make-sparse-keymap'.
411 Optional map M can be used to modify an existing map.
412 ARGS is a list of additional keyword arguments."
441 m))
443 ;;;###autoload
449 \f
450 ;;;
451 ;;; easy-mmode-defsyntax
452 ;;;
465 st))
467 ;;;###autoload
469 "Define variable ST as a syntax-table.
470 CSS contains a list of syntax specifications of the form (CHAR . SYNTAX)."
476 \f
477 ;;;
478 ;;; easy-mmode-define-navigation
479 ;;;
482 "Define BASE-next and BASE-prev to navigate in the buffer.
483 RE determines the places the commands should move point to.
484 NAME should describe the entities matched by RE. It is used to build
485 the docstrings of the two functions.
486 BASE-next also tries to make sure that the whole entry is visible by
487 searching for its end (by calling ENDFUN if provided or by looking for
488 the next entry) and recentering if necessary.
489 ENDFUN should return the end position (with or without moving point).
490 NARROWFUN non-nil means to check for narrowing before moving, and if
491 found, do `widen' first and then call NARROWFUN with no args after moving."
513 ,check-narrow-maybe
535 ,check-narrow-maybe
544 ;; arch-tag: d48a5250-6961-4528-9cb0-3c9ea042a66a
545 ;;; easy-mmode.el ends here