Commit | Line | Data |
---|---|---|
67832de1 KS |
1 | ;;; mb-depth.el --- Indicate minibuffer-depth in prompt |
2 | ;; | |
3 | ;; Copyright (C) 2006, 2007 Free Software Foundation, Inc. | |
4 | ;; | |
5 | ;; Author: Miles Bader <miles@gnu.org> | |
6 | ;; Keywords: convenience | |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | |
23 | ;; Boston, MA 02110-1301, USA. | |
24 | ||
25 | ;;; Commentary: | |
26 | ;; | |
27 | ;; Defines the minor mode `minibuffer-indicate-depth-mode'. | |
28 | ;; | |
29 | ;; When active, any recursive use of the minibuffer will show | |
30 | ;; the recursion depth in the minibuffer prompt. This is only | |
31 | ;; useful if `enable-recursive-minibuffers' is non-nil. | |
32 | ||
33 | ;;; Code: | |
34 | ||
35 | ;; An overlay covering the prompt. This is a buffer-local variable in | |
36 | ;; each affected minibuffer. | |
37 | ;; | |
38 | (defvar minibuf-depth-overlay) | |
39 | (make-variable-buffer-local 'minibuf-depth-overlay) | |
40 | ||
41 | ;; This function goes on minibuffer-setup-hook | |
42 | (defun minibuf-depth-setup-minibuffer () | |
43 | "Set up a minibuffer for `minibuffer-indicate-depth-mode'. | |
44 | The prompt should already have been inserted." | |
45 | (when (> (minibuffer-depth) 1) | |
46 | (setq minibuf-depth-overlay (make-overlay (point-min) (1+ (point-min)))) | |
47 | (overlay-put minibuf-depth-overlay 'before-string | |
48 | (propertize (format "[%d]" (minibuffer-depth)) | |
49 | 'face 'highlight)) | |
50 | (overlay-put minibuf-depth-overlay 'evaporate t))) | |
51 | ||
52 | ;;;###autoload | |
53 | (define-minor-mode minibuffer-indicate-depth-mode | |
54 | "Toggle Minibuffer Indicate Depth mode. | |
55 | When active, any recursive use of the minibuffer will show | |
56 | the recursion depth in the minibuffer prompt. This is only | |
57 | useful if `enable-recursive-minibuffers' is non-nil. | |
58 | ||
59 | With prefix argument ARG, turn on if positive, otherwise off. | |
60 | Returns non-nil if the new state is enabled." | |
61 | :global t | |
62 | :group 'minibuffer | |
63 | (if minibuffer-indicate-depth-mode | |
64 | ;; Enable the mode | |
65 | (add-hook 'minibuffer-setup-hook 'minibuf-depth-setup-minibuffer) | |
66 | ;; Disable the mode | |
67 | (remove-hook 'minibuffer-setup-hook 'minibuf-depth-setup-minibuffer))) | |
68 | ||
69 | (provide 'mb-depth) | |
70 | ||
71 | ;;; mb-depth.el ends here |