1 ;;; easy-mmode.el --- easy definition for major and minor modes
3 ;; Copyright (C) 1997,2000,01,02,03,2004 Free Software Foundation, Inc.
5 ;; Author: Georges Brun-Cottan <Georges.Brun-Cottan@inria.fr>
6 ;; Maintainer: Stefan Monnier <monnier@gnu.org>
8 ;; Keywords: extensions lisp
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; Minor modes are useful and common. This package makes defining a
30 ;; minor mode easy, by focusing on the writing of the minor mode
31 ;; functionalities themselves. Moreover, this package enforces a
32 ;; conventional naming of user interface primitives, making things
33 ;; natural for the minor-mode end-users.
35 ;; For each mode, easy-mmode defines the following:
36 ;; <mode> : The minor mode predicate. A buffer-local variable.
37 ;; <mode>-map : The keymap possibly associated to <mode>.
38 ;; <mode>-hook : The hook run at the end of the toggle function.
39 ;; see `define-minor-mode' documentation
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
51 ;; Additionally to `define-minor-mode', the package provides convenient
52 ;; ways to define keymaps, and other helper functions for major and minor modes.
56 (eval-when-compile (require 'cl
))
58 (defun easy-mmode-pretty-mode-name (mode &optional lighter
)
59 "Turn the symbol MODE into a string intended for the user.
60 If provided LIGHTER will be used to help choose capitalization."
61 (let* ((case-fold-search t
)
62 (name (concat (replace-regexp-in-string
64 (capitalize (replace-regexp-in-string
65 "-mode\\'" "" (symbol-name mode
))))
67 (if (not (stringp lighter
)) name
68 (setq lighter
(replace-regexp-in-string "\\`\\s-+\\|\\-s+\\'" "" lighter
))
69 (replace-regexp-in-string lighter lighter name t t
))))
72 (defalias 'easy-mmode-define-minor-mode
'define-minor-mode
)
74 (defmacro define-minor-mode
(mode doc
&optional init-value lighter keymap
&rest body
)
75 "Define a new minor mode MODE.
76 This function defines the associated control variable MODE, keymap MODE-map,
77 toggle command MODE, and hook MODE-hook.
79 DOC is the documentation for the mode toggle command.
80 Optional INIT-VALUE is the initial value of the mode's variable.
81 Optional LIGHTER is displayed in the modeline when the mode is on.
82 Optional KEYMAP is the default (defvar) keymap bound to the mode keymap.
83 If it is a list, it is passed to `easy-mmode-define-keymap'
84 in order to build a valid keymap. It's generally better to use
85 a separate MODE-map variable than to use this argument.
86 The above three arguments can be skipped if keyword arguments are
89 BODY contains code that will be executed each time the mode is (dis)activated.
90 It will be executed after any toggling but before running the hooks.
91 Before the actual body code, you can write
92 keyword arguments (alternating keywords and values).
93 These following keyword arguments are supported (other keywords
94 will be passed to `defcustom' if the minor mode is global):
95 :group GROUP Custom group name to use in all generated `defcustom' forms.
96 :global GLOBAL If non-nil specifies that the minor mode is not meant to be
97 buffer-local, so don't make the variable MODE buffer-local.
98 By default, the mode is buffer-local.
99 :init-value VAL Same as the INIT-VALUE argument.
100 :lighter SPEC Same as the LIGHTER argument.
101 :keymap MAP Same as the KEYMAP argument.
102 :require SYM Same as in `defcustom'.
104 For example, you could write
105 (define-minor-mode foo-mode \"If enabled, foo on you!\"
106 :lighter \" Foo\" :require 'foo :global t :group 'hassle :version \"27.5\"
108 (declare (debug (&define name stringp
109 [&optional
[¬ keywordp
] sexp
110 &optional
[¬ keywordp
] sexp
111 &optional
[¬ keywordp
] sexp
]
112 [&rest
[keywordp sexp
]]
115 ;; Allow skipping the first three args.
117 ((keywordp init-value
)
118 (setq body
(list* init-value lighter keymap body
)
119 init-value nil lighter nil keymap nil
))
121 (setq body
(list* lighter keymap body
) lighter nil keymap nil
))
122 ((keywordp keymap
) (push keymap body
) (setq keymap nil
)))
124 (let* ((mode-name (symbol-name mode
))
125 (pretty-name (easy-mmode-pretty-mode-name mode lighter
))
131 (hook (intern (concat mode-name
"-hook")))
132 (hook-on (intern (concat mode-name
"-on-hook")))
133 (hook-off (intern (concat mode-name
"-off-hook")))
137 (while (keywordp (setq keyw
(car body
)))
138 (setq body
(cdr body
))
140 (:init-value
(setq init-value
(pop body
)))
141 (:lighter
(setq lighter
(pop body
)))
142 (:global
(setq globalp
(pop body
)))
143 (:extra-args
(setq extra-args
(pop body
)))
144 (:group
(setq group
(nconc group
(list :group
(pop body
)))))
145 (:require
(setq require
(pop body
)))
146 (:keymap
(setq keymap
(pop body
)))
147 (t (push keyw extra-keywords
) (push (pop body
) extra-keywords
))))
149 (setq keymap-sym
(if (and keymap
(symbolp keymap
)) keymap
150 (intern (concat mode-name
"-map"))))
153 ;; We might as well provide a best-guess default group.
155 `(:group
',(or (custom-current-group)
156 (intern (replace-regexp-in-string
157 "-mode\\'" "" mode-name
))))))
160 ;; Define the variable to enable or disable the mode.
163 (defvar ,mode
,init-value
,(format "Non-nil if %s is enabled.
164 Use the command `%s' to change this variable." pretty-name mode
))
165 (make-variable-buffer-local ',mode
))
167 (let ((curfile (or (and (boundp 'byte-compile-current-file
)
168 byte-compile-current-file
)
170 `(defcustom ,mode
,init-value
171 ,(format "Non-nil if %s is enabled.
172 See the command `%s' for a description of this minor-mode.
173 Setting this variable directly does not take effect;
174 use either \\[customize] or the function `%s'."
175 pretty-name mode mode
)
176 :set
'custom-set-minor-mode
177 :initialize
'custom-initialize-default
181 ((not (and curfile require
)) nil
)
182 ((not (eq require t
)) `(:require
,require
))
184 ',(intern (file-name-nondirectory
185 (file-name-sans-extension curfile
))))))
186 ,@(nreverse extra-keywords
))))
188 ;; The actual function.
189 (defun ,mode
(&optional arg
,@extra-args
)
191 (format (concat "Toggle %s on or off.
192 Interactively, with no prefix argument, toggle the mode.
193 With universal prefix ARG turn mode on.
194 With zero or negative ARG turn mode off.
195 \\{%s}") pretty-name keymap-sym
))
196 ;; Use `toggle' rather than (if ,mode 0 1) so that using
197 ;; repeat-command still does the toggling correctly.
198 (interactive (list (or current-prefix-arg
'toggle
)))
201 ((eq arg
'toggle
) (not ,mode
))
202 (arg (> (prefix-numeric-value arg
) 0))
206 "Toggling %s off; better pass an explicit argument."
210 ;; The on/off hooks are here for backward compatibility only.
211 (run-hooks ',hook
(if ,mode
',hook-on
',hook-off
))
214 ,(if globalp
`(customize-mark-as-set ',mode
))
215 (unless (current-message)
216 (message ,(format "%s %%sabled" pretty-name
)
217 (if ,mode
"en" "dis")))))
218 (force-mode-line-update)
219 ;; Return the new setting.
222 ;; Autoloading an easy-mmode-define-minor-mode autoloads
223 ;; everything up-to-here.
226 ;; The toggle's hook.
228 ,(format "Hook run at the end of function `%s'." mode-name
)
232 ;; Define the minor-mode keymap.
233 ,(unless (symbolp keymap
) ;nil is also a symbol.
236 (cond ((keymapp m
) m
)
237 ((listp m
) (easy-mmode-define-keymap m
))
238 (t (error "Invalid keymap %S" ,keymap
))))
239 ,(format "Keymap for `%s'." mode-name
)))
241 (add-minor-mode ',mode
',lighter
242 ,(if keymap keymap-sym
243 `(if (boundp ',keymap-sym
)
244 (symbol-value ',keymap-sym
))))
246 ;; If the mode is global, call the function according to the default.
248 `(if (and load-file-name
(not (equal ,init-value
,mode
)))
249 (eval-after-load load-file-name
'(,mode
(if ,mode
1 -
1))))))))
252 ;;; make global minor mode
256 (defmacro easy-mmode-define-global-mode
(global-mode mode turn-on
258 "Make GLOBAL-MODE out of the buffer-local minor MODE.
259 TURN-ON is a function that will be called with no args in every buffer
260 and that should try to turn MODE on if applicable for that buffer.
261 KEYS is a list of CL-style keyword arguments:
262 :group to specify the custom group."
263 (let* ((global-mode-name (symbol-name global-mode
))
264 (pretty-name (easy-mmode-pretty-mode-name mode
))
265 (pretty-global-name (easy-mmode-pretty-mode-name global-mode
))
268 (buffers (intern (concat global-mode-name
"-buffers")))
269 (cmmh (intern (concat global-mode-name
"-cmmh"))))
272 (while (keywordp (car keys
))
274 (:extra-args
(setq extra-args
(pop keys
)))
275 (:group
(setq group
(nconc group
(list :group
(pop keys
)))))
276 (t (setq keys
(cdr keys
)))))
279 ;; We might as well provide a best-guess default group.
281 `(:group
',(or (custom-current-group)
282 (intern (replace-regexp-in-string
283 "-mode\\'" "" (symbol-name mode
)))))))
286 ;; The actual global minor-mode
287 (define-minor-mode ,global-mode
288 ,(format "Toggle %s in every buffer.
289 With prefix ARG, turn %s on if and only if ARG is positive.
290 %s is actually not turned on in every buffer but only in those
291 in which `%s' turns it on."
292 pretty-name pretty-global-name pretty-name turn-on
)
293 :global t
:extra-args
,extra-args
,@group
295 ;; Setup hook to handle future mode changes and new buffers.
298 (add-hook 'find-file-hook
',buffers
)
299 (add-hook 'change-major-mode-hook
',cmmh
))
300 (remove-hook 'find-file-hook
',buffers
)
301 (remove-hook 'change-major-mode-hook
',cmmh
))
303 ;; Go through existing buffers.
304 (dolist (buf (buffer-list))
305 (with-current-buffer buf
306 (if ,global-mode
(,turn-on
) (when ,mode
(,mode -
1))))))
308 ;; Autoloading easy-mmode-define-global-mode
309 ;; autoloads everything up-to-here.
312 ;; List of buffers left to process.
313 (defvar ,buffers nil
)
315 ;; The function that calls TURN-ON in each buffer.
317 (remove-hook 'post-command-hook
',buffers
)
319 (let ((buf (pop ,buffers
)))
320 (when (buffer-live-p buf
)
321 (with-current-buffer buf
(,turn-on
))))))
322 (put ',buffers
'definition-name
',global-mode
)
324 ;; The function that catches kill-all-local-variables.
326 (add-to-list ',buffers
(current-buffer))
327 (add-hook 'post-command-hook
',buffers
))
328 (put ',cmmh
'definition-name
',global-mode
))))
331 ;;; easy-mmode-defmap
334 (if (fboundp 'set-keymap-parents
)
335 (defalias 'easy-mmode-set-keymap-parents
'set-keymap-parents
)
336 (defun easy-mmode-set-keymap-parents (m parents
)
340 ((not (consp parents
)) parents
)
341 ((not (cdr parents
)) (car parents
))
342 (t (let ((m (copy-keymap (pop parents
))))
343 (easy-mmode-set-keymap-parents m parents
)
347 (defun easy-mmode-define-keymap (bs &optional name m args
)
348 "Return a keymap built from bindings BS.
349 BS must be a list of (KEY . BINDING) where
350 KEY and BINDINGS are suitable for `define-key'.
351 Optional NAME is passed to `make-sparse-keymap'.
352 Optional map M can be used to modify an existing map.
353 ARGS is a list of additional keyword arguments."
356 (let ((key (pop args
))
359 (:name
(setq name val
))
360 (:dense
(setq dense val
))
361 (:inherit
(setq inherit val
))
363 (t (message "Unknown argument %s in defmap" key
)))))
365 (setq bs
(append m bs
))
366 (setq m
(if dense
(make-keymap name
) (make-sparse-keymap name
))))
370 (dolist (key (if (consp keys
) keys
(list keys
)))
373 (substitute-key-definition key binding m global-map
))
375 (unless (keymapp (lookup-key m key
)) (define-key m key binding
)))
376 ((let ((o (lookup-key m key
)))
377 (or (null o
) (numberp o
) (eq o
'undefined
)))
378 (define-key m key binding
))))))
380 ((keymapp inherit
) (set-keymap-parent m inherit
))
381 ((consp inherit
) (easy-mmode-set-keymap-parents m inherit
)))
385 (defmacro easy-mmode-defmap
(m bs doc
&rest args
)
387 (easy-mmode-define-keymap ,bs nil
(if (boundp ',m
) ,m
) ,(cons 'list args
))
392 ;;; easy-mmode-defsyntax
395 (defun easy-mmode-define-syntax (css args
)
396 (let ((st (make-syntax-table (plist-get args
:copy
)))
397 (parent (plist-get args
:inherit
)))
399 (let ((char (car cs
))
402 (mapcar (lambda (c) (modify-syntax-entry c syntax st
)) char
)
403 (modify-syntax-entry char syntax st
))))
404 (if parent
(set-char-table-parent
405 st
(if (symbolp parent
) (symbol-value parent
) parent
)))
409 (defmacro easy-mmode-defsyntax
(st css doc
&rest args
)
410 "Define variable ST as a syntax-table.
411 CSS contains a list of syntax specifications of the form (CHAR . SYNTAX)."
413 (autoload 'easy-mmode-define-syntax
"easy-mmode")
414 (defconst ,st
(easy-mmode-define-syntax ,css
,(cons 'list args
)) ,doc
)))
419 ;;; easy-mmode-define-navigation
422 (defmacro easy-mmode-define-navigation
(base re
&optional name endfun narrowfun
)
423 "Define BASE-next and BASE-prev to navigate in the buffer.
424 RE determines the places the commands should move point to.
425 NAME should describe the entities matched by RE. It is used to build
426 the docstrings of the two functions.
427 BASE-next also tries to make sure that the whole entry is visible by
428 searching for its end (by calling ENDFUN if provided or by looking for
429 the next entry) and recentering if necessary.
430 ENDFUN should return the end position (with or without moving point).
431 NARROWFUN non-nil means to check for narrowing before moving, and if
432 found, do widen first and then call NARROWFUN with no args after moving."
433 (let* ((base-name (symbol-name base
))
434 (prev-sym (intern (concat base-name
"-prev")))
435 (next-sym (intern (concat base-name
"-next")))
439 (prog1 (or (< (- (point-max) (point-min)) (buffer-size)))
441 (re-narrow-maybe (when narrowfun
442 `(when was-narrowed
(,narrowfun
)))))
443 (unless name
(setq name base-name
))
445 (add-to-list 'debug-ignored-errors
446 ,(concat "^No \\(previous\\|next\\) " (regexp-quote name
)))
447 (defun ,next-sym
(&optional count
)
448 ,(format "Go to the next COUNT'th %s." name
)
450 (unless count
(setq count
1))
451 (if (< count
0) (,prev-sym
(- count
))
452 (if (looking-at ,re
) (setq count
(1+ count
)))
455 (if (not (re-search-forward ,re nil t count
))
457 (goto-char (or ,(if endfun
`(,endfun
)) (point-max)))
458 (error "No next %s" ,name
))
459 (goto-char (match-beginning 0))
460 (when (and (eq (current-buffer) (window-buffer (selected-window)))
462 (let ((endpt (or (save-excursion
463 ,(if endfun
`(,endfun
)
464 `(re-search-forward ,re nil t
2)))
466 (unless (pos-visible-in-window-p endpt nil t
)
469 (defun ,prev-sym
(&optional count
)
470 ,(format "Go to the previous COUNT'th %s" (or name base-name
))
472 (unless count
(setq count
1))
473 (if (< count
0) (,next-sym
(- count
))
476 (unless (re-search-backward ,re nil t count
)
477 (error "No previous %s" ,name
))
478 ,re-narrow-maybe
))))))
481 (provide 'easy-mmode
)
483 ;;; arch-tag: d48a5250-6961-4528-9cb0-3c9ea042a66a
484 ;;; easy-mmode.el ends here