;;; rfn-eshadow.el --- Highlight `shadowed' part of read-file-name input text
;;
-;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007 Free Software Foundation, Inc.
+;; Copyright (C) 2000-2016 Free Software Foundation, Inc.
;;
;; Author: Miles Bader <miles@gnu.org>
;; Keywords: convenience minibuffer
+;; Package: emacs
;; 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 2, 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
;; 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 <http://www.gnu.org/licenses/>.
;;; Commentary:
;;
(sexp :tag "Value")))))
(defcustom file-name-shadow-properties
- '(face file-name-shadow field shadow)
+ ;; FIXME: should we purecopy this?
+'(face file-name-shadow field shadow)
"Properties given to the `shadowed' part of a filename in the minibuffer.
Only used when `file-name-shadow-mode' is active.
If Emacs is not running under a window system,
:version "22.1")
(defcustom file-name-shadow-tty-properties
- '(before-string "{" after-string "} " field shadow)
+ (purecopy '(before-string "{" after-string "} " field shadow))
"Properties given to the `shadowed' part of a filename in the minibuffer.
Only used when `file-name-shadow-mode' is active and Emacs
is not running under a window-system; if Emacs is running under a window
:group 'minibuffer
:version "22.1")
+(defvar rfn-eshadow-setup-minibuffer-hook nil
+ "Minibuffer setup functions from other packages.")
+
+(defvar rfn-eshadow-update-overlay-hook nil
+ "Customer overlay functions from other packages")
+
\f
;;; Internal variables
(overlay-put rfn-eshadow-overlay 'evaporate t)
;; Add our post-command hook, and make sure can remove it later.
(add-to-list 'rfn-eshadow-frobbed-minibufs (current-buffer))
- (add-hook 'post-command-hook #'rfn-eshadow-update-overlay nil t)))
+ (add-hook 'post-command-hook #'rfn-eshadow-update-overlay nil t)
+ ;; Run custom hook
+ (run-hooks 'rfn-eshadow-setup-minibuffer-hook)))
(defsubst rfn-eshadow-sifn-equal (goal pos)
(equal goal (condition-case nil
`file-name-shadow-mode'; the minibuffer should have already
been set up by `rfn-eshadow-setup-minibuffer'."
(condition-case nil
- (let ((goal (substitute-in-file-name (minibuffer-contents)))
- (mid (overlay-end rfn-eshadow-overlay))
- (start (minibuffer-prompt-end))
- (end (point-max)))
+ (let* ((non-essential t)
+ (goal (substitute-in-file-name (minibuffer-contents)))
+ (mid (overlay-end rfn-eshadow-overlay))
+ (start (minibuffer-prompt-end))
+ (end (point-max)))
(unless
;; Catch the common case where the shadow does not need to move.
(and mid
(if (rfn-eshadow-sifn-equal goal mid)
(setq start mid)
(setq end mid)))
- (move-overlay rfn-eshadow-overlay (minibuffer-prompt-end) start)))
+ (move-overlay rfn-eshadow-overlay (minibuffer-prompt-end) start))
+ ;; Run custom hook
+ (run-hooks 'rfn-eshadow-update-overlay-hook))
;; `substitute-in-file-name' can fail on partial input.
(error nil)))
\f
(define-minor-mode file-name-shadow-mode
- "Toggle File-Name Shadow mode.
-When active, any part of a filename being read in the minibuffer
-that would be ignored (because the result is passed through
+ "Toggle file-name shadowing in minibuffers (File-Name Shadow mode).
+With a prefix argument ARG, enable File-Name Shadow mode if ARG
+is positive, and disable it otherwise. If called from Lisp,
+enable the mode if ARG is omitted or nil.
+
+File-Name Shadow mode is a global minor mode. When enabled, any
+part of a filename being read in the minibuffer that would be
+ignored (because the result is passed through
`substitute-in-file-name') is given the properties in
-`file-name-shadow-properties', which can be used to make
-that portion dim, invisible, or otherwise less visually noticeable.
-
-With prefix argument ARG, turn on if positive, otherwise off.
-Returns non-nil if the new state is enabled."
+`file-name-shadow-properties', which can be used to make that
+portion dim, invisible, or otherwise less visually noticeable."
:global t
+ ;; We'd like to use custom-initialize-set here so the setup is done
+ ;; before dumping, but at the point where the defcustom is evaluated,
+ ;; the corresponding function isn't defined yet, so
+ ;; custom-initialize-set signals an error.
+ :initialize 'custom-initialize-delay
:init-value t
:group 'minibuffer
:version "22.1"
(provide 'rfn-eshadow)
-;; arch-tag: dcf70a52-0115-4ec2-b1e3-4f8d3541a888
;;; rfn-eshadow.el ends here