| blob | f22cc2c362d6f526b021c1e94b4a4419f8a20231 |
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, 2011 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 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 a keymap, or a list of arguments for `easy-mmode-define-keymap'.
97 If KEYMAP is a keymap or list, this also defines the variable MODE-map.
99 BODY contains code to execute each time the mode is enabled or disabled.
100 It is executed after toggling the mode, and before running MODE-hook.
101 Before the actual body code, you can write keyword arguments, i.e.
102 alternating keywords and values. These following special keywords
103 are supported (other keywords are passed to `defcustom' if the minor
104 mode is global):
106 :group GROUP Custom group name to use in all generated `defcustom' forms.
108 Don't use this default group name unless you have written a
109 `defgroup' to define that group properly.
110 :global GLOBAL If non-nil specifies that the minor mode is not meant to be
111 buffer-local, so don't make the variable MODE buffer-local.
112 By default, the mode is buffer-local.
113 :init-value VAL Same as the INIT-VALUE argument.
114 :lighter SPEC Same as the LIGHTER argument.
115 :keymap MAP Same as the KEYMAP argument.
116 :require SYM Same as in `defcustom'.
118 For example, you could write
121 ...BODY CODE...)"
127 def-body)))
129 ;; Allow skipping the first three args.
133 init-value nil lighter nil keymap nil))
152 keyw keymap-sym)
154 ;; Check keys.
179 ;; We might as well provide a best-guess default group.
187 ;; Define the variable to enable or disable the mode.
196 See the command `%s' for a description of this minor mode."
198 Setting this variable directly does not take effect;
199 either customize it (see the info node `Easy Customization')
203 ,@set
204 ,@initialize
205 ,@group
206 ,@type
210 ;; The actual function.
214 Interactively, with no prefix argument, toggle the mode.
215 With universal prefix ARG turn mode on.
216 With zero or negative ARG turn mode off.
218 ;; Use `toggle' rather than (if ,mode 0 1) so that using
219 ;; repeat-command still does the toggling correctly.
229 "Toggling %s off; better pass an explicit argument."
231 nil))))
232 ,@body
233 ;; The on/off hooks are here for backward compatibility only.
238 ;; Avoid overwriting a message shown by the body,
239 ;; but do overwrite previous messages.
246 ;; Return the new setting.
249 ;; Autoloading a define-minor-mode autoloads everything
250 ;; up-to-here.
251 :autoload-end
253 ;; Define the minor-mode keymap.
265 \f
266 ;;;
267 ;;; make global minor mode
268 ;;;
270 ;;;###autoload
272 ;;;###autoload
274 ;;;###autoload
276 "Make a global mode GLOBAL-MODE corresponding to buffer-local minor MODE.
277 TURN-ON is a function that will be called with no args in every buffer
278 and that should try to turn MODE on if applicable for that buffer.
279 KEYS is a list of CL-style keyword arguments. As the minor mode
280 defined by this function is always global, any :global keyword is
281 ignored. Other keywords have the same meaning as in `define-minor-mode',
282 which see. In particular, :group specifies the custom group.
283 The most useful keywords are those that are passed on to the
284 `defcustom'. It normally makes no sense to pass the :lighter
285 or :keymap keywords to `define-globalized-minor-mode', since these
286 are usually passed to the buffer-local version of the minor mode.
288 If MODE's set-up depends on the major mode in effect when it was
289 enabled, then disabling and reenabling MODE should make MODE work
290 correctly with the current major mode. This is important to
291 prevent problems with derived modes, that is, major modes that
292 call another major mode in their body."
306 keyw)
308 ;; Check keys.
317 ;; We might as well provide a best-guess default group.
325 ;; The actual global minor-mode
327 ;; Very short lines to avoid too long lines in the generated
328 ;; doc string.
330 With prefix ARG, turn %s on if and only if
331 ARG is positive.
332 %s is enabled in all buffers where
333 \`%s' would do it.
334 See `%s' for more information on %s."
335 pretty-name pretty-global-name pretty-name turn-on
336 mode pretty-name)
339 ;; Setup hook to handle future mode changes and new buffers.
350 ;; Go through existing buffers.
355 ;; Autoloading define-globalized-minor-mode autoloads everything
356 ;; up-to-here.
357 :autoload-end
359 ;; List of buffers left to process.
362 ;; The function that calls TURN-ON in each buffer.
382 ;; The function that catches kill-all-local-variables.
388 ;;;
389 ;;; easy-mmode-defmap
390 ;;;
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.
414 Valid keywords and arguments are:
416 :name Name of the keymap; overrides NAME argument.
417 :dense Non-nil for a dense keymap.
418 :inherit Parent keymap.
419 :group Ignored.
420 :suppress Non-nil to call `suppress-keymap' on keymap,
421 'nodigits to suppress digits as prefix arguments."
453 m))
455 ;;;###autoload
457 "Define a constant M whose value is the result of `easy-mmode-define-keymap'.
458 The M, BS, and ARGS arguments are as per that function. DOC is
459 the constant's documentation."
464 \f
465 ;;;
466 ;;; easy-mmode-defsyntax
467 ;;;
480 st))
482 ;;;###autoload
484 "Define variable ST as a syntax-table.
485 CSS contains a list of syntax specifications of the form (CHAR . SYNTAX)."
491 \f
492 ;;;
493 ;;; easy-mmode-define-navigation
494 ;;;
498 "Define BASE-next and BASE-prev to navigate in the buffer.
499 RE determines the places the commands should move point to.
500 NAME should describe the entities matched by RE. It is used to build
501 the docstrings of the two functions.
502 BASE-next also tries to make sure that the whole entry is visible by
503 searching for its end (by calling ENDFUN if provided or by looking for
504 the next entry) and recentering if necessary.
505 ENDFUN should return the end position (with or without moving point).
506 NARROWFUN non-nil means to check for narrowing before moving, and if
507 found, do `widen' first and then call NARROWFUN with no args after moving.
508 BODY is executed after moving to the destination location."
519 ,body
561 ;; arch-tag: d48a5250-6961-4528-9cb0-3c9ea042a66a
562 ;;; easy-mmode.el ends here