X-Git-Url: https://git.hcoop.net/bpt/emacs.git/blobdiff_plain/5bc6ddff00c50acf546530ef0e08a27140614d27..ab422c4d6899b1442cb6954c1829c1fb656b006c:/lisp/mb-depth.el diff --git a/lisp/mb-depth.el b/lisp/mb-depth.el index d85380ea64..cf20c6b118 100644 --- a/lisp/mb-depth.el +++ b/lisp/mb-depth.el @@ -1,16 +1,16 @@ ;;; mb-depth.el --- Indicate minibuffer-depth in prompt ;; -;; Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc. +;; Copyright (C) 2006-2013 Free Software Foundation, Inc. ;; ;; Author: Miles Bader ;; Keywords: convenience ;; This file is part of GNU Emacs. -;; GNU Emacs is free software; you can redistribute it and/or modify +;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by -;; the Free Software Foundation; either version 3, or (at your option) -;; any later version. +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -18,13 +18,11 @@ ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs; see the file COPYING. If not, write to the -;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, -;; Boston, MA 02110-1301, USA. +;; along with GNU Emacs. If not, see . ;;; 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 @@ -32,7 +30,7 @@ ;;; 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.") @@ -40,39 +38,40 @@ 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