;;; mb-depth.el --- Indicate minibuffer-depth in prompt
;;
-;; Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 2006-2014 Free Software Foundation, Inc.
;;
;; Author: Miles Bader <miles@gnu.org>
;; Keywords: convenience
;;; Commentary:
;;
-;; Defines the minor mode `minibuffer-indicate-depth-mode'.
+;; Defines the minor mode `minibuffer-depth-indicate-mode'.
;;
;; When active, any recursive use of the minibuffer will show
;; the recursion depth in the minibuffer prompt. This is only
;;; Code:
-(defvar minibuf-depth-indicator-function nil
+(defvar minibuffer-depth-indicator-function nil
"If non-nil, function to set up the minibuffer depth indicator.
It is called with one argument, the minibuffer depth,
and must return a string.")
;; An overlay covering the prompt. This is a buffer-local variable in
;; each affected minibuffer.
;;
-(defvar minibuf-depth-overlay)
-(make-variable-buffer-local 'minibuf-depth-overlay)
+(defvar minibuffer-depth-overlay)
+(make-variable-buffer-local 'minibuffer-depth-overlay)
;; This function goes on minibuffer-setup-hook
-(defun minibuf-depth-setup-minibuffer ()
- "Set up a minibuffer for `minibuffer-indicate-depth-mode'.
+(defun minibuffer-depth-setup ()
+ "Set up a minibuffer for `minibuffer-depth-indicate-mode'.
The prompt should already have been inserted."
(when (> (minibuffer-depth) 1)
- (setq minibuf-depth-overlay (make-overlay (point-min) (1+ (point-min))))
- (overlay-put minibuf-depth-overlay 'before-string
- (if minibuf-depth-indicator-function
- (funcall minibuf-depth-indicator-function (minibuffer-depth))
+ (setq minibuffer-depth-overlay (make-overlay (point-min) (1+ (point-min))))
+ (overlay-put minibuffer-depth-overlay 'before-string
+ (if minibuffer-depth-indicator-function
+ (funcall minibuffer-depth-indicator-function (minibuffer-depth))
(propertize (format "[%d]" (minibuffer-depth)) 'face 'highlight)))
- (overlay-put minibuf-depth-overlay 'evaporate t)))
+ (overlay-put minibuffer-depth-overlay 'evaporate t)))
;;;###autoload
-(define-minor-mode minibuffer-indicate-depth-mode
- "Toggle Minibuffer Indicate Depth mode.
-When active, any recursive use of the minibuffer will show
-the recursion depth in the minibuffer prompt. This is only
-useful if `enable-recursive-minibuffers' is non-nil.
+(define-minor-mode minibuffer-depth-indicate-mode
+ "Toggle Minibuffer Depth Indication mode.
+With a prefix argument ARG, enable Minibuffer Depth Indication
+mode if ARG is positive, and disable it otherwise. If called
+from Lisp, enable the mode if ARG is omitted or nil.
-With prefix argument ARG, turn on if positive, otherwise off.
-Returns non-nil if the new state is enabled."
+Minibuffer Depth Indication mode is a global minor mode. When
+enabled, any recursive use of the minibuffer will show the
+recursion depth in the minibuffer prompt. This is only useful if
+`enable-recursive-minibuffers' is non-nil."
:global t
:group 'minibuffer
- (if minibuffer-indicate-depth-mode
+ (if minibuffer-depth-indicate-mode
;; Enable the mode
- (add-hook 'minibuffer-setup-hook 'minibuf-depth-setup-minibuffer)
+ (add-hook 'minibuffer-setup-hook 'minibuffer-depth-setup)
;; Disable the mode
- (remove-hook 'minibuffer-setup-hook 'minibuf-depth-setup-minibuffer)))
+ (remove-hook 'minibuffer-setup-hook 'minibuffer-depth-setup)))
(provide 'mb-depth)
-;; arch-tag: 50224089-5bf5-46f8-803d-18f018c5eacf
;;; mb-depth.el ends here