| blob | 4da48805278a1146010d799f9bb9fcdd49ee5b6d |
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>
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:
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."
59 ;; Produce "Foo-Bar minor mode" from foo-bar-minor-mode.
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"
67 ;; "foo-bar-minor-mode" -> "foo-bar-minor"
71 ;; Strip leading and trailing whitespace from LIGHTER.
73 lighter))
74 ;; Replace any (case-insensitive) matches for LIGHTER in NAME
75 ;; with a literal LIGHTER. E.g., if NAME is "Iimage mode" and
76 ;; LIGHTER is " iImag", then this will produce "iImage mode".
77 ;; (LIGHTER normally comes from the mode-line string passed to
78 ;; define-minor-mode, and normally includes at least one leading
79 ;; space.)
82 ;;;###autoload
84 ;;;###autoload
86 "Define a new minor mode MODE.
87 This defines the toggle command MODE and (by default) a control variable
88 MODE (you can override this with the :variable keyword, see below).
89 DOC is the documentation for the mode toggle command.
91 The defined mode command takes one optional (prefix) argument.
92 Interactively with no prefix argument it toggles the mode.
93 With a prefix argument, it enables the mode if the argument is
94 positive and otherwise disables it. When called from Lisp, it
95 enables the mode if the argument is omitted or nil, and toggles
96 the mode if the argument is `toggle'. If DOC is nil this
97 function adds a basic doc-string stating these facts.
99 Optional INIT-VALUE is the initial value of the mode's variable.
100 Optional LIGHTER is displayed in the mode line when the mode is on.
101 Optional KEYMAP is the default keymap bound to the mode keymap.
102 If non-nil, it should be a variable name (whose value is a keymap),
103 or an expression that returns either a keymap or a list of
104 arguments for `easy-mmode-define-keymap'. If you supply a KEYMAP
105 argument that is not a symbol, this macro defines the variable
106 MODE-map and gives it the value that KEYMAP specifies.
108 BODY contains code to execute each time the mode is enabled or disabled.
109 It is executed after toggling the mode, and before running MODE-hook.
110 Before the actual body code, you can write keyword arguments, i.e.
111 alternating keywords and values. These following special keywords
112 are supported (other keywords are passed to `defcustom' if the minor
113 mode is global):
115 :group GROUP Custom group name to use in all generated `defcustom' forms.
117 Don't use this default group name unless you have written a
118 `defgroup' to define that group properly.
119 :global GLOBAL If non-nil specifies that the minor mode is not meant to be
120 buffer-local, so don't make the variable MODE buffer-local.
121 By default, the mode is buffer-local.
122 :init-value VAL Same as the INIT-VALUE argument.
123 Not used if you also specify :variable.
124 :lighter SPEC Same as the LIGHTER argument.
125 :keymap MAP Same as the KEYMAP argument.
126 :require SYM Same as in `defcustom'.
127 :variable PLACE The location to use instead of the variable MODE to store
128 the state of the mode. This can be simply a different
129 named variable, or more generally anything that can be used
130 with the CL macro `setf'. PLACE can also be of the form
131 \(GET . SET), where GET is an expression that returns the
132 current state, and SET is a function that takes one argument,
133 the new state, and sets it. If you specify a :variable,
134 this function does not define a MODE variable (nor any of
135 the terms used in :variable).
136 :after-hook A single lisp form which is evaluated after the mode hooks
137 have been run. It should not be quoted.
139 For example, you could write
142 ...BODY CODE...)"
149 def-body)))
151 ;; Allow skipping the first three args.
155 init-value nil lighter nil keymap nil))
178 keyw keymap-sym tmp)
180 ;; Check keys.
198 ;; PLACE is not of the form (GET . SET).
214 ;; We might as well provide a best-guess default group.
219 ;; TODO? Mark booleans as safe if booleanp? Eg abbrev-mode.
223 ;; Define the variable to enable or disable the mode.
225 ;; If :variable is specified, then the var will be
226 ;; declared elsewhere.
230 :autoload-end
237 See the command `%s' for a description of this minor mode."
239 Setting this variable directly does not take effect;
240 either customize it (see the info node `Easy Customization')
244 ,@set
245 ,@initialize
246 ,@group
247 ,@type
251 ;; The actual function.
255 With a prefix argument ARG, enable %s if ARG is
256 positive, and disable it otherwise. If called from Lisp, enable
257 the mode if ARG is omitted or nil, and toggle it if ARG is `toggle'.
259 ;; Use `toggle' rather than (if ,mode 0 1) so that using
260 ;; repeat-command still does the toggling correctly.
267 ;; A nil argument also means ON now.
269 ,@body
270 ;; The on/off hooks are here for backward compatibility only.
276 ;; Avoid overwriting a message shown by the body,
277 ;; but do overwrite previous messages.
285 ;; Return the new setting.
288 ;; Autoloading a define-minor-mode autoloads everything
289 ;; up-to-here.
290 :autoload-end
292 ;; Define the minor-mode keymap.
308 nil
310 \f
311 ;;;
312 ;;; make global minor mode
313 ;;;
315 ;;;###autoload
317 ;;;###autoload
319 ;;;###autoload
321 "Make a global mode GLOBAL-MODE corresponding to buffer-local minor MODE.
322 TURN-ON is a function that will be called with no args in every buffer
323 and that should try to turn MODE on if applicable for that buffer.
324 KEYS is a list of CL-style keyword arguments. As the minor mode
325 defined by this function is always global, any :global keyword is
326 ignored. Other keywords have the same meaning as in `define-minor-mode',
327 which see. In particular, :group specifies the custom group.
328 The most useful keywords are those that are passed on to the
329 `defcustom'. It normally makes no sense to pass the :lighter
330 or :keymap keywords to `define-globalized-minor-mode', since these
331 are usually passed to the buffer-local version of the minor mode.
333 If MODE's set-up depends on the major mode in effect when it was
334 enabled, then disabling and reenabling MODE should make MODE work
335 correctly with the current major mode. This is important to
336 prevent problems with derived modes, that is, major modes that
337 call another major mode in their body."
351 keyw)
353 ;; Check keys.
362 ;; We might as well provide a best-guess default group.
369 :autoload-end
372 ;; The actual global minor-mode
374 ;; Very short lines to avoid too long lines in the generated
375 ;; doc string.
377 With prefix ARG, enable %s if ARG is positive;
378 otherwise, disable it. If called from Lisp, enable the mode if
379 ARG is omitted or nil.
381 %s is enabled in all buffers where
382 \`%s' would do it.
383 See `%s' for more information on %s."
384 pretty-name pretty-global-name
385 pretty-name turn-on mode pretty-name)
388 ;; Setup hook to handle future mode changes and new buffers.
403 ;; Go through existing buffers.
408 ;; Autoloading define-globalized-minor-mode autoloads everything
409 ;; up-to-here.
410 :autoload-end
412 ;; List of buffers left to process.
415 ;; The function that calls TURN-ON in each buffer.
436 ;; The function that catches kill-all-local-variables.
442 ;;;
443 ;;; easy-mmode-defmap
444 ;;;
451 m
457 m)))))))
459 ;;;###autoload
461 "Return a keymap built from bindings BS.
462 BS must be a list of (KEY . BINDING) where
463 KEY and BINDINGS are suitable for `define-key'.
464 Optional NAME is passed to `make-sparse-keymap'.
465 Optional map M can be used to modify an existing map.
466 ARGS is a list of additional keyword arguments.
468 Valid keywords and arguments are:
470 :name Name of the keymap; overrides NAME argument.
471 :dense Non-nil for a dense keymap.
472 :inherit Parent keymap.
473 :group Ignored.
474 :suppress Non-nil to call `suppress-keymap' on keymap,
475 'nodigits to suppress digits as prefix arguments."
507 m))
509 ;;;###autoload
511 "Define a constant M whose value is the result of `easy-mmode-define-keymap'.
512 The M, BS, and ARGS arguments are as per that function. DOC is
513 the constant's documentation."
518 \f
519 ;;;
520 ;;; easy-mmode-defsyntax
521 ;;;
534 st))
536 ;;;###autoload
538 "Define variable ST as a syntax-table.
539 CSS contains a list of syntax specifications of the form (CHAR . SYNTAX)."
545 \f
546 ;;;
547 ;;; easy-mmode-define-navigation
548 ;;;
552 "Define BASE-next and BASE-prev to navigate in the buffer.
553 RE determines the places the commands should move point to.
554 NAME should describe the entities matched by RE. It is used to build
555 the docstrings of the two functions.
556 BASE-next also tries to make sure that the whole entry is visible by
557 searching for its end (by calling ENDFUN if provided or by looking for
558 the next entry) and recentering if necessary.
559 ENDFUN should return the end position (with or without moving point).
560 NARROWFUN non-nil means to check for narrowing before moving, and if
561 found, do `widen' first and then call NARROWFUN with no args after moving.
562 BODY is executed after moving to the destination location."
573 ,body
613 ;;; easy-mmode.el ends here