| blob | b5b6566cf665745539b6a59cc2e454f563b64040 |
1 ;;; easy-mmode.el --- easy definition for major and minor modes
3 ;; Copyright (C) 1997, 2000-2014 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"
72 ;; Strip leading and trailing whitespace from LIGHTER.
74 lighter))
75 ;; Replace any (case-insensitive) matches for LIGHTER in NAME
76 ;; with a literal LIGHTER. E.g., if NAME is "Iimage mode" and
77 ;; LIGHTER is " iImag", then this will produce "iImage mode".
78 ;; (LIGHTER normally comes from the mode-line string passed to
79 ;; define-minor-mode, and normally includes at least one leading
80 ;; space.)
83 ;;;###autoload
85 ;;;###autoload
87 "Define a new minor mode MODE.
88 This defines the toggle command MODE and (by default) a control variable
89 MODE (you can override this with the :variable keyword, see below).
90 DOC is the documentation for the mode toggle command.
92 The defined mode command takes one optional (prefix) argument.
93 Interactively with no prefix argument, it toggles the mode.
94 A prefix argument enables the mode if the argument is positive,
95 and disables it otherwise.
97 When called from Lisp, the mode command toggles the mode if the
98 argument is `toggle', disables the mode if the argument is a
99 non-positive integer, and enables the mode otherwise (including
100 if the argument is omitted or nil or a positive integer).
102 If DOC is nil, give the mode command a basic doc-string
103 documenting what its argument does.
105 Optional INIT-VALUE is the initial value of the mode's variable.
106 Optional LIGHTER is displayed in the mode line when the mode is on.
107 Optional KEYMAP is the default keymap bound to the mode keymap.
108 If non-nil, it should be a variable name (whose value is a keymap),
109 or an expression that returns either a keymap or a list of
110 arguments for `easy-mmode-define-keymap'. If you supply a KEYMAP
111 argument that is not a symbol, this macro defines the variable
112 MODE-map and gives it the value that KEYMAP specifies.
114 BODY contains code to execute each time the mode is enabled or disabled.
115 It is executed after toggling the mode, and before running MODE-hook.
116 Before the actual body code, you can write keyword arguments, i.e.
117 alternating keywords and values. These following special keywords
118 are supported (other keywords are passed to `defcustom' if the minor
119 mode is global):
121 :group GROUP Custom group name to use in all generated `defcustom' forms.
123 Don't use this default group name unless you have written a
124 `defgroup' to define that group properly.
125 :global GLOBAL If non-nil specifies that the minor mode is not meant to be
126 buffer-local, so don't make the variable MODE buffer-local.
127 By default, the mode is buffer-local.
128 :init-value VAL Same as the INIT-VALUE argument.
129 Not used if you also specify :variable.
130 :lighter SPEC Same as the LIGHTER argument.
131 :keymap MAP Same as the KEYMAP argument.
132 :require SYM Same as in `defcustom'.
133 :variable PLACE The location to use instead of the variable MODE to store
134 the state of the mode. This can be simply a different
135 named variable, or a generalized variable.
136 PLACE can also be of the form \(GET . SET), where GET is
137 an expression that returns the current state, and SET is
138 a function that takes one argument, the new state, and
139 sets it. If you specify a :variable, this function does
140 not define a MODE variable (nor any of the terms used
141 in :variable).
143 :after-hook A single lisp form which is evaluated after the mode hooks
144 have been run. It should not be quoted.
146 For example, you could write
149 ...BODY CODE...)"
156 def-body)))
158 ;; Allow skipping the first three args.
162 init-value nil lighter nil keymap nil))
185 keyw keymap-sym tmp)
187 ;; Check keys.
205 ;; PLACE is not of the form (GET . SET).
221 ;; We might as well provide a best-guess default group.
226 ;; TODO? Mark booleans as safe if booleanp? Eg abbrev-mode.
230 ;; Define the variable to enable or disable the mode.
232 ;; If :variable is specified, then the var will be
233 ;; declared elsewhere.
237 :autoload-end
244 See the command `%s' for a description of this minor mode."
246 Setting this variable directly does not take effect;
247 either customize it (see the info node `Easy Customization')
251 ,@set
252 ,@initialize
253 ,@group
254 ,@type
258 ;; The actual function.
262 With a prefix argument ARG, enable %s if ARG is
263 positive, and disable it otherwise. If called from Lisp, enable
264 the mode if ARG is omitted or nil, and toggle it if ARG is `toggle'.
266 ;; Use `toggle' rather than (if ,mode 0 1) so that using
267 ;; repeat-command still does the toggling correctly.
274 ;; A nil argument also means ON now.
276 ,@body
277 ;; The on/off hooks are here for backward compatibility only.
283 ;; Avoid overwriting a message shown by the body,
284 ;; but do overwrite previous messages.
292 ;; Return the new setting.
295 ;; Autoloading a define-minor-mode autoloads everything
296 ;; up-to-here.
297 :autoload-end
301 No problems result if this variable is not bound.
302 `add-hook' automatically binds it. (This is true for all hook variables.)"
303 mode))
305 ;; Define the minor-mode keymap.
321 nil
323 \f
324 ;;;
325 ;;; make global minor mode
326 ;;;
328 ;;;###autoload
330 ;;;###autoload
332 ;;;###autoload
334 "Make a global mode GLOBAL-MODE corresponding to buffer-local minor MODE.
335 TURN-ON is a function that will be called with no args in every buffer
336 and that should try to turn MODE on if applicable for that buffer.
337 KEYS is a list of CL-style keyword arguments. As the minor mode
338 defined by this function is always global, any :global keyword is
339 ignored. Other keywords have the same meaning as in `define-minor-mode',
340 which see. In particular, :group specifies the custom group.
341 The most useful keywords are those that are passed on to the
342 `defcustom'. It normally makes no sense to pass the :lighter
343 or :keymap keywords to `define-globalized-minor-mode', since these
344 are usually passed to the buffer-local version of the minor mode.
346 If MODE's set-up depends on the major mode in effect when it was
347 enabled, then disabling and reenabling MODE should make MODE work
348 correctly with the current major mode. This is important to
349 prevent problems with derived modes, that is, major modes that
350 call another major mode in their body.
352 When a major mode is initialized, MODE is actually turned on just
353 after running the major mode's hook. However, MODE is not turned
354 on if the hook has explicitly disabled it."
371 keyw)
373 ;; Check keys.
382 ;; We might as well provide a best-guess default group.
389 :autoload-end
392 ;; The actual global minor-mode
394 ;; Very short lines to avoid too long lines in the generated
395 ;; doc string.
397 With prefix ARG, enable %s if ARG is positive;
398 otherwise, disable it. If called from Lisp, enable the mode if
399 ARG is omitted or nil.
401 %s is enabled in all buffers where
402 \`%s' would do it.
403 See `%s' for more information on %s."
404 pretty-name pretty-global-name
405 pretty-name turn-on mode pretty-name)
408 ;; Setup hook to handle future mode changes and new buffers.
419 ;; Go through existing buffers.
424 ;; Autoloading define-globalized-minor-mode autoloads everything
425 ;; up-to-here.
426 :autoload-end
428 ;; MODE-set-explicitly is set in MODE-set-explicitly and cleared by
429 ;; kill-all-local-variables.
435 ;; A function which checks whether MODE has been disabled in the major
436 ;; mode hook which has just been run.
439 ;; List of buffers left to process.
442 ;; The function that calls TURN-ON in each buffer.
463 ;; The function that catches kill-all-local-variables.
469 ;;;
470 ;;; easy-mmode-defmap
471 ;;;
477 ;;;###autoload
479 "Return a keymap built from bindings BS.
480 BS must be a list of (KEY . BINDING) where
481 KEY and BINDINGS are suitable for `define-key'.
482 Optional NAME is passed to `make-sparse-keymap'.
483 Optional map M can be used to modify an existing map.
484 ARGS is a list of additional keyword arguments.
486 Valid keywords and arguments are:
488 :name Name of the keymap; overrides NAME argument.
489 :dense Non-nil for a dense keymap.
490 :inherit Parent keymap.
491 :group Ignored.
492 :suppress Non-nil to call `suppress-keymap' on keymap,
493 'nodigits to suppress digits as prefix arguments."
525 m))
527 ;;;###autoload
529 "Define a constant M whose value is the result of `easy-mmode-define-keymap'.
530 The M, BS, and ARGS arguments are as per that function. DOC is
531 the constant's documentation."
536 \f
537 ;;;
538 ;;; easy-mmode-defsyntax
539 ;;;
552 st))
554 ;;;###autoload
556 "Define variable ST as a syntax-table.
557 CSS contains a list of syntax specifications of the form (CHAR . SYNTAX)."
563 \f
564 ;;;
565 ;;; easy-mmode-define-navigation
566 ;;;
570 "Define BASE-next and BASE-prev to navigate in the buffer.
571 RE determines the places the commands should move point to.
572 NAME should describe the entities matched by RE. It is used to build
573 the docstrings of the two functions.
574 BASE-next also tries to make sure that the whole entry is visible by
575 searching for its end (by calling ENDFUN if provided or by looking for
576 the next entry) and recentering if necessary.
577 ENDFUN should return the end position (with or without moving point).
578 NARROWFUN non-nil means to check for narrowing before moving, and if
579 found, do `widen' first and then call NARROWFUN with no args after moving.
580 BODY is executed after moving to the destination location."
591 ,body
631 ;;; easy-mmode.el ends here