annotate lisp/mb-depth.el @ 112148:01442958b949

* texinfo.tex: Update to version 2010-12-23.17 from gnulib, which in turn is copied from ftp://tug.org/tex/.
author Paul Eggert <eggert@cs.ucla.edu>
date Fri, 07 Jan 2011 11:49:15 -0800
parents 1d1d5d9bd884
children 376148b31b5e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
1 ;;; mb-depth.el --- Indicate minibuffer-depth in prompt
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
2 ;;
106815
1d1d5d9bd884 Add 2010 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
3 ;; Copyright (C) 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
4 ;;
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
5 ;; Author: Miles Bader <miles@gnu.org>
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
6 ;; Keywords: convenience
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
7
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
9
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87665
diff changeset
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87665
diff changeset
12 ;; the Free Software Foundation, either version 3 of the License, or
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87665
diff changeset
13 ;; (at your option) any later version.
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
14
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
18 ;; GNU General Public License for more details.
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
19
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87665
diff changeset
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
22
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
23 ;;; Commentary:
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
24 ;;
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
25 ;; Defines the minor mode `minibuffer-depth-indicate-mode'.
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
26 ;;
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
27 ;; When active, any recursive use of the minibuffer will show
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
28 ;; the recursion depth in the minibuffer prompt. This is only
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
29 ;; useful if `enable-recursive-minibuffers' is non-nil.
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
30
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
31 ;;; Code:
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
32
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
33 (defvar minibuffer-depth-indicator-function nil
85085
20e6cbaf918a (minibuf-depth-indicator-function): New variable.
Juanma Barranquero <lekktu@gmail.com>
parents: 82160
diff changeset
34 "If non-nil, function to set up the minibuffer depth indicator.
20e6cbaf918a (minibuf-depth-indicator-function): New variable.
Juanma Barranquero <lekktu@gmail.com>
parents: 82160
diff changeset
35 It is called with one argument, the minibuffer depth,
20e6cbaf918a (minibuf-depth-indicator-function): New variable.
Juanma Barranquero <lekktu@gmail.com>
parents: 82160
diff changeset
36 and must return a string.")
20e6cbaf918a (minibuf-depth-indicator-function): New variable.
Juanma Barranquero <lekktu@gmail.com>
parents: 82160
diff changeset
37
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
38 ;; An overlay covering the prompt. This is a buffer-local variable in
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
39 ;; each affected minibuffer.
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
40 ;;
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
41 (defvar minibuffer-depth-overlay)
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
42 (make-variable-buffer-local 'minibuffer-depth-overlay)
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
43
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
44 ;; This function goes on minibuffer-setup-hook
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
45 (defun minibuffer-depth-setup ()
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
46 "Set up a minibuffer for `minibuffer-depth-indicate-mode'.
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
47 The prompt should already have been inserted."
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
48 (when (> (minibuffer-depth) 1)
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
49 (setq minibuffer-depth-overlay (make-overlay (point-min) (1+ (point-min))))
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
50 (overlay-put minibuffer-depth-overlay 'before-string
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
51 (if minibuffer-depth-indicator-function
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
52 (funcall minibuffer-depth-indicator-function (minibuffer-depth))
85085
20e6cbaf918a (minibuf-depth-indicator-function): New variable.
Juanma Barranquero <lekktu@gmail.com>
parents: 82160
diff changeset
53 (propertize (format "[%d]" (minibuffer-depth)) 'face 'highlight)))
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
54 (overlay-put minibuffer-depth-overlay 'evaporate t)))
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
55
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
56 ;;;###autoload
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
57 (define-minor-mode minibuffer-depth-indicate-mode
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
58 "Toggle Minibuffer Depth Indication mode.
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
59 When active, any recursive use of the minibuffer will show
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
60 the recursion depth in the minibuffer prompt. This is only
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
61 useful if `enable-recursive-minibuffers' is non-nil.
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
62
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
63 With prefix argument ARG, turn on if positive, otherwise off.
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
64 Returns non-nil if the new state is enabled."
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
65 :global t
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
66 :group 'minibuffer
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
67 (if minibuffer-depth-indicate-mode
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
68 ;; Enable the mode
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
69 (add-hook 'minibuffer-setup-hook 'minibuffer-depth-setup)
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
70 ;; Disable the mode
97157
5e1a3afd2217 Unify all names under one common name prefix
Juri Linkov <juri@jurta.org>
parents: 94678
diff changeset
71 (remove-hook 'minibuffer-setup-hook 'minibuffer-depth-setup)))
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
72
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
73 (provide 'mb-depth)
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
74
81452
56a3f23e0e74 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 81441
diff changeset
75 ;; arch-tag: 50224089-5bf5-46f8-803d-18f018c5eacf
81441
cf1f1c774776 New file.
Kim F. Storm <storm@cua.dk>
parents:
diff changeset
76 ;;; mb-depth.el ends here