1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
;;; rfn-eshadow.el --- Highlight `shadowed' part of read-file-name input text
;;
;; Copyright (C) 2000-2015 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
;; it under the terms of the GNU General Public License as published by
;; 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
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; Defines the mode `file-name-shadow-mode'.
;;
;; The `read-file-name' function passes its result through
;; `substitute-in-file-name', so any part of the string preceding
;; multiple slashes (or a drive indicator on MS-DOS/MS-Windows) is
;; ignored.
;;
;; If `file-name-shadow-mode' is active, any part of the
;; minibuffer text that would be ignored because of this is given the
;; properties in `file-name-shadow-properties', which may
;; be used to make the ignored text invisible, dim, etc.
;;
;;; Code:
;;; Customization
(defconst file-name-shadow-properties-custom-type
'(list
(checklist :inline t
(const :tag "Invisible"
:doc "Make shadowed part of filename invisible"
:format "%t%n%h"
:inline t
(invisible t intangible t))
(list :inline t
:format "%v"
:tag "Face"
:doc "Display shadowed part of filename using a different face"
(const :format "" face)
(face :value file-name-shadow))
(list :inline t
:format "%t: %v%h"
:tag "Brackets"
;; Note the 4 leading spaces in the doc string;
;; this is hack to get around the fact that the
;; newline after the second string widget comes
;; from the string widget, and doesn't indent
;; correctly. We could use a :size attribute to
;; make the second string widget not have a
;; terminating newline, but this makes it impossible
;; to enter trailing whitespace, and it's desirable
;; that it be possible.
:doc " Surround shadowed part of filename with brackets"
(const :format "" before-string)
(string :format "%v" :size 4 :value "{")
(const :format "" after-string)
;; see above about why the 2nd string doesn't use :size
(string :format " and: %v" :value "} "))
(list :inline t
:format "%t: %v%n%h"
:tag "String"
:doc "Display a string instead of the shadowed part of filename"
(const :format "" display)
(string :format "%v" :size 15 :value "<...ignored...>"))
(const :tag "Avoid"
:doc "Try to keep cursor out of shadowed part of filename"
:format "%t%n%h"
:inline t
(field shadow)))
(repeat :inline t
:tag "Other Properties"
(list :inline t
:format "%v"
(symbol :tag "Property")
(sexp :tag "Value")))))
(defcustom file-name-shadow-properties
;; 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,
`file-name-shadow-tty-properties' is used instead."
:type file-name-shadow-properties-custom-type
:group 'minibuffer
:version "22.1")
(defcustom file-name-shadow-tty-properties
(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
system, `file-name-shadow-properties' is used instead."
:type file-name-shadow-properties-custom-type
:group 'minibuffer
:version "22.1")
(defface file-name-shadow
'((t :inherit shadow))
"Face used by `file-name-shadow-mode' for the shadow."
: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")
;;; Internal variables
;; A list of minibuffers to which we've added a post-command-hook.
(defvar rfn-eshadow-frobbed-minibufs nil)
;; An overlay covering the shadowed part of the filename (local to the
;; minibuffer).
(defvar rfn-eshadow-overlay)
(make-variable-buffer-local 'rfn-eshadow-overlay)
;;; Hook functions
;; This function goes on minibuffer-setup-hook
(defun rfn-eshadow-setup-minibuffer ()
"Set up a minibuffer for `file-name-shadow-mode'.
The prompt and initial input should already have been inserted."
(when minibuffer-completing-file-name
(setq rfn-eshadow-overlay
(make-overlay (minibuffer-prompt-end) (minibuffer-prompt-end)))
;; Give rfn-eshadow-overlay the user's props.
(let ((props
(if window-system
file-name-shadow-properties
file-name-shadow-tty-properties)))
(while props
(overlay-put rfn-eshadow-overlay (pop props) (pop props))))
;; Turn on overlay evaporation so that we don't have to worry about
;; odd effects when the overlay sits empty at the beginning of the
;; minibuffer.
(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)
;; Run custom hook
(run-hooks 'rfn-eshadow-setup-minibuffer-hook)))
(defsubst rfn-eshadow-sifn-equal (goal pos)
(equal goal (condition-case nil
(substitute-in-file-name
(buffer-substring-no-properties pos (point-max)))
;; `substitute-in-file-name' can fail on partial input.
(error nil))))
;; post-command-hook to update overlay
(defun rfn-eshadow-update-overlay ()
"Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
This is intended to be used as a minibuffer `post-command-hook' for
`file-name-shadow-mode'; the minibuffer should have already
been set up by `rfn-eshadow-setup-minibuffer'."
(condition-case nil
(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
(or (eq mid end)
(not (rfn-eshadow-sifn-equal goal (1+ mid))))
(or (eq mid start)
(rfn-eshadow-sifn-equal goal mid)))
;; Binary search for the greatest position still equivalent to
;; the whole.
(while (or (< (1+ start) end)
(if (and (< (1+ end) (point-max))
(rfn-eshadow-sifn-equal goal (1+ end)))
;; (SIFN end) != goal, but (SIFN (1+end)) == goal,
;; We've reached a discontinuity: this can happen
;; e.g. if `end' point to "/:...".
(setq start (1+ end) end (point-max))))
(setq mid (/ (+ start end) 2))
(if (rfn-eshadow-sifn-equal goal mid)
(setq start mid)
(setq end mid)))
(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)))
(define-minor-mode file-name-shadow-mode
"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."
: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"
(if file-name-shadow-mode
;; Enable the mode
(add-hook 'minibuffer-setup-hook 'rfn-eshadow-setup-minibuffer)
;; Disable the mode
(remove-hook 'minibuffer-setup-hook 'rfn-eshadow-setup-minibuffer)
;; Remove our entry from any post-command-hook variable's it's still in
(dolist (minibuf rfn-eshadow-frobbed-minibufs)
(with-current-buffer minibuf
(remove-hook 'post-command-hook #'rfn-eshadow-update-overlay t)))
(setq rfn-eshadow-frobbed-minibufs nil)))
(provide 'rfn-eshadow)
;;; rfn-eshadow.el ends here
|
