(reftex-isearch-switch-to-next-file): Remove un-needed local `orig-list'.
[bpt/emacs.git] / lisp / dired.el
CommitLineData
c8472948 1;;; dired.el --- directory-browsing commands
52041219 2
87ae59e3 3;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
409cc4a3 4;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
ab67260b 5
b36b40ae
RS
6;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
7;; Maintainer: FSF
565132a3 8;; Keywords: files
84fc2cfa
ER
9
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
b4aa6026 14;; the Free Software Foundation; either version 3, or (at your option)
84fc2cfa
ER
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
b578f267 23;; along with GNU Emacs; see the file COPYING. If not, write to the
086add15
LK
24;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25;; Boston, MA 02110-1301, USA.
84fc2cfa 26
52041219
RS
27;;; Commentary:
28
e41b2db1
ER
29;; This is a major mode for directory browsing and editing. It is
30;; documented in the Emacs manual.
31
492d2437
RS
32;; Rewritten in 1990/1991 to add tree features, file marking and
33;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34;; Finished up by rms in 1992.
35
52041219 36;;; Code:
492d2437 37
492d2437
RS
38;;; Customizable variables
39
286c247d
RS
40(defgroup dired nil
41 "Directory editing."
d7aed37c 42 :link '(custom-manual "(emacs)Dired")
ca66efd1 43 :group 'files)
286c247d
RS
44
45(defgroup dired-mark nil
68d2f12f 46 "Handling marks in Dired."
286c247d
RS
47 :prefix "dired-"
48 :group 'dired)
49
50
84fc2cfa 51;;;###autoload
286c247d 52(defcustom dired-listing-switches "-al"
ee680b2b 53 "*Switches passed to `ls' for Dired. MUST contain the `l' option.
492d2437 54May contain all other options that don't contradict `-l';
b36b40ae 55may contain even `F', `b', `i' and `s'. See also the variable
48404d5a
EZ
56`dired-ls-F-marks-symlinks' concerning the `F' switch.
57On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
58some of the `ls' switches are not supported; see the doc string of
a6d231bb 59`insert-directory' in `ls-lisp.el' for more details."
286c247d
RS
60 :type 'string
61 :group 'dired)
84fc2cfa 62
5553077c
LT
63(defvar dired-subdir-switches nil
64 "If non-nil, switches passed to `ls' for inserting subdirectories.
65If nil, `dired-listing-switches' is used.")
66
470fa6d1 67; Don't use absolute file names as /bin should be in any PATH and people
492d2437
RS
68; may prefer /usr/local/gnu/bin or whatever. However, chown is
69; usually not in PATH.
70
71;;;###autoload
84fc2cfa 72(defvar dired-chown-program
f3041af1 73 (if (memq system-type '(hpux usg-unix-v irix linux gnu/linux cygwin))
6702f50d
RS
74 "chown"
75 (if (file-exists-p "/usr/sbin/chown")
76 "/usr/sbin/chown"
77 "/etc/chown"))
eb8c3be9 78 "Name of chown command (usually `chown' or `/etc/chown').")
492d2437 79
0b7bc76f
RS
80(defvar dired-use-ls-dired (not (not (string-match "gnu" system-configuration)))
81 "Non-nil means Dired should use `ls --dired'.")
82
912aace8
GV
83(defvar dired-chmod-program "chmod"
84 "Name of chmod command (usually `chmod').")
723ddb1f 85
57654b8c
JL
86(defvar dired-touch-program "touch"
87 "Name of touch command (usually `touch').")
88
492d2437 89;;;###autoload
286c247d 90(defcustom dired-ls-F-marks-symlinks nil
ee680b2b 91 "*Informs Dired about how `ls -lF' marks symbolic links.
fc83abf7
RS
92Set this to t if `ls' (or whatever program is specified by
93`insert-directory-program') with `-lF' marks the symbolic link
492d2437 94itself with a trailing @ (usually the case under Ultrix).
84fc2cfa 95
492d2437
RS
96Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
97nil (the default), if it gives `bar@ -> foo', set it to t.
98
99Dired checks if there is really a @ appended. Thus, if you have a
100marking `ls' program on one host and a non-marking on another host, and
101don't care about symbolic links which really end in a @, you can
286c247d
RS
102always set this variable to t."
103 :type 'boolean
104 :group 'dired-mark)
492d2437
RS
105
106;;;###autoload
286c247d 107(defcustom dired-trivial-filenames "^\\.\\.?$\\|^#"
492d2437
RS
108 "*Regexp of files to skip when finding first file of a directory.
109A value of nil means move to the subdir line.
286c247d
RS
110A value of t means move to first file."
111 :type '(choice (const :tag "Move to subdir" nil)
112 (const :tag "Move to first" t)
113 regexp)
114 :group 'dired)
492d2437
RS
115
116;;;###autoload
286c247d 117(defcustom dired-keep-marker-rename t
492d2437
RS
118 ;; Use t as default so that moved files "take their markers with them".
119 "*Controls marking of renamed files.
120If t, files keep their previous marks when they are renamed.
121If a character, renamed files (whether previously marked or not)
286c247d
RS
122are afterward marked with that character."
123 :type '(choice (const :tag "Keep" t)
124 (character :tag "Mark"))
125 :group 'dired-mark)
492d2437
RS
126
127;;;###autoload
286c247d 128(defcustom dired-keep-marker-copy ?C
492d2437
RS
129 "*Controls marking of copied files.
130If t, copied files are marked if and as the corresponding original files were.
286c247d
RS
131If a character, copied files are unconditionally marked with that character."
132 :type '(choice (const :tag "Keep" t)
133 (character :tag "Mark"))
134 :group 'dired-mark)
492d2437
RS
135
136;;;###autoload
286c247d 137(defcustom dired-keep-marker-hardlink ?H
492d2437
RS
138 "*Controls marking of newly made hard links.
139If t, they are marked if and as the files linked to were marked.
286c247d
RS
140If a character, new links are unconditionally marked with that character."
141 :type '(choice (const :tag "Keep" t)
142 (character :tag "Mark"))
143 :group 'dired-mark)
492d2437
RS
144
145;;;###autoload
286c247d 146(defcustom dired-keep-marker-symlink ?Y
492d2437
RS
147 "*Controls marking of newly made symbolic links.
148If t, they are marked if and as the files linked to were marked.
286c247d
RS
149If a character, new links are unconditionally marked with that character."
150 :type '(choice (const :tag "Keep" t)
151 (character :tag "Mark"))
152 :group 'dired-mark)
492d2437
RS
153
154;;;###autoload
286c247d 155(defcustom dired-dwim-target nil
ee680b2b 156 "*If non-nil, Dired tries to guess a default target directory.
492d2437
RS
157This means: if there is a dired buffer displayed in the next window,
158use its current subdir, instead of the current subdir of this dired buffer.
159
286c247d
RS
160The target is used in the prompt for file copy, rename etc."
161 :type 'boolean
162 :group 'dired)
492d2437
RS
163
164;;;###autoload
286c247d 165(defcustom dired-copy-preserve-time t
492d2437 166 "*If non-nil, Dired preserves the last-modified time in a file copy.
286c247d
RS
167\(This works on only some systems.)"
168 :type 'boolean
169 :group 'dired)
492d2437 170
05b855f5
EZ
171; These variables were deleted and the replacements are on files.el.
172; We leave aliases behind for back-compatibility.
173(defvaralias 'dired-free-space-program 'directory-free-space-program)
174(defvaralias 'dired-free-space-args 'directory-free-space-args)
175
492d2437
RS
176;;; Hook variables
177
c2792945 178(defcustom dired-load-hook nil
ee680b2b 179 "Run after loading Dired.
c2792945
EZ
180You can customize key bindings or load extensions with this."
181 :group 'dired
182 :type 'hook)
492d2437 183
c2792945 184(defcustom dired-mode-hook nil
ee680b2b 185 "Run at the very end of `dired-mode'."
c2792945
EZ
186 :group 'dired
187 :type 'hook)
492d2437 188
c2792945
EZ
189(defcustom dired-before-readin-hook nil
190 "This hook is run before a dired buffer is read in (created or reverted)."
191 :group 'dired
192 :type 'hook)
492d2437 193
c2792945 194(defcustom dired-after-readin-hook nil
492d2437
RS
195 "Hook run after each time a file or directory is read by Dired.
196After each listing of a file or directory, this hook is run
c2792945
EZ
197with the buffer narrowed to the listing."
198 :group 'dired
199 :type 'hook)
492d2437
RS
200;; Note this can't simply be run inside function `dired-ls' as the hook
201;; functions probably depend on the dired-subdir-alist to be OK.
202
1ed8284d
RS
203(defcustom dired-dnd-protocol-alist
204 '(("^file:///" . dired-dnd-handle-local-file)
205 ("^file://" . dired-dnd-handle-file)
206 ("^file:" . dired-dnd-handle-local-file))
207 "The functions to call when a drop in `dired-mode' is made.
208See `dnd-protocol-alist' for more information. When nil, behave
3db7bf54 209as in other buffers. Changing this option is effective only for
f7a8a965 210new dired buffers."
1ed8284d
RS
211 :type '(choice (repeat (cons (regexp) (function)))
212 (const :tag "Behave as in other buffers" nil))
213 :version "22.1"
214 :group 'dired)
215
2b2059d8 216;; Internal variables
492d2437
RS
217
218(defvar dired-marker-char ?* ; the answer is 42
219 ;; so that you can write things like
220 ;; (let ((dired-marker-char ?X))
221 ;; ;; great code using X markers ...
222 ;; )
223 ;; For example, commands operating on two sets of files, A and B.
224 ;; Or marking files with digits 0-9. This could implicate
225 ;; concentric sets or an order for the marked files.
226 ;; The code depends on dynamic scoping on the marker char.
227 "In Dired, the current mark character.
884b7f9d 228This is what the do-commands look for, and what the mark-commands store.")
492d2437
RS
229
230(defvar dired-del-marker ?D
231 "Character used to flag files for deletion.")
232
ee680b2b 233(defvar dired-shrink-to-fit t
ab67260b
RS
234;; I see no reason ever to make this nil -- rms.
235;; (> baud-rate search-slow-speed)
492d2437
RS
236 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
237
238(defvar dired-flagging-regexp nil);; Last regexp used to flag files.
239
ab67260b
RS
240(defvar dired-file-version-alist)
241
e956c609 242;;;###autoload
492d2437 243(defvar dired-directory nil
ee680b2b 244 "The directory name or wildcard spec that this dired directory lists.
8d23c16b 245Local to each dired buffer. May be a list, in which case the car is the
0b7bc76f
RS
246directory name and the cdr is the list of files to mention.
247The directory name must be absolute, but need not be fully expanded.")
492d2437
RS
248
249(defvar dired-actual-switches nil
250 "The value of `dired-listing-switches' used to make this buffer's text.")
251
252(defvar dired-re-inode-size "[0-9 \t]*"
253 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
254
255;; These regexps must be tested at beginning-of-line, but are also
256;; used to search for next matches, so neither omitting "^" nor
257;; replacing "^" by "\n" (to make it slightly faster) will work.
258
259(defvar dired-re-mark "^[^ \n]")
260;; "Regexp matching a marked line.
261;; Important: the match ends just after the marker."
262(defvar dired-re-maybe-mark "^. ")
312a9e03
EZ
263;; The [^:] part after "d" and "l" is to avoid confusion with the
264;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
265(defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d[^:]"))
266(defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l[^:]"))
492d2437
RS
267(defvar dired-re-exe;; match ls permission string of an executable file
268 (mapconcat (function
269 (lambda (x)
270 (concat dired-re-maybe-mark dired-re-inode-size x)))
271 '("-[-r][-w][xs][-r][-w].[-r][-w]."
272 "-[-r][-w].[-r][-w][xs][-r][-w]."
273 "-[-r][-w].[-r][-w].[-r][-w][xst]")
274 "\\|"))
e6cecd2b 275(defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
147e214c 276(defvar dired-re-dot "^.* \\.\\.?/?$")
492d2437 277
5553077c 278;; The subdirectory names in the next two lists are expanded.
492d2437
RS
279(defvar dired-subdir-alist nil
280 "Association list of subdirectories and their buffer positions.
281Each subdirectory has an element: (DIRNAME . STARTMARKER).
7b2469ae
RS
282The order of elements is the reverse of the order in the buffer.
283In simple cases, this list contains one element.")
492d2437 284
5553077c
LT
285(defvar dired-switches-alist nil
286 "Keeps track of which switches to use for inserted subdirectories.
287This is an alist of the form (SUBDIR . SWITCHES).")
288(make-variable-buffer-local 'dired-switches-alist)
289
5afea280
RS
290(defvaralias 'dired-move-to-filename-regexp
291 'directory-listing-before-filename-regexp)
292
cdf156a9 293(defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
492d2437
RS
294 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
295Subexpression 1 is the subdirectory proper, no trailing colon.
296The match starts at the beginning of the line and ends after the end
297of the line (\\n or \\r).
298Subexpression 2 must end right before the \\n or \\r.")
299
0b0e6651 300(defgroup dired-faces nil
ee680b2b 301 "Faces used by Dired."
0b0e6651
JL
302 :group 'dired
303 :group 'faces)
304
305(defface dired-header
306 '((t (:inherit font-lock-type-face)))
307 "Face used for directory headers."
308 :group 'dired-faces
bf247b6e 309 :version "22.1")
0b0e6651
JL
310(defvar dired-header-face 'dired-header
311 "Face name used for directory headers.")
312
313(defface dired-mark
314 '((t (:inherit font-lock-constant-face)))
315 "Face used for dired marks."
316 :group 'dired-faces
bf247b6e 317 :version "22.1")
0b0e6651
JL
318(defvar dired-mark-face 'dired-mark
319 "Face name used for dired marks.")
320
321(defface dired-marked
322 '((t (:inherit font-lock-warning-face)))
323 "Face used for marked files."
324 :group 'dired-faces
bf247b6e 325 :version "22.1")
0b0e6651
JL
326(defvar dired-marked-face 'dired-marked
327 "Face name used for marked files.")
328
329(defface dired-flagged
330 '((t (:inherit font-lock-warning-face)))
331 "Face used for flagged files."
332 :group 'dired-faces
bf247b6e 333 :version "22.1")
0b0e6651
JL
334(defvar dired-flagged-face 'dired-flagged
335 "Face name used for flagged files.")
336
337(defface dired-warning
0f0c86fc
MR
338 ;; Inherit from font-lock-warning-face since with min-colors 8
339 ;; font-lock-comment-face is not colored any more.
340 '((t (:inherit font-lock-warning-face)))
0b0e6651
JL
341 "Face used to highlight a part of a buffer that needs user attention."
342 :group 'dired-faces
bf247b6e 343 :version "22.1")
0b0e6651
JL
344(defvar dired-warning-face 'dired-warning
345 "Face name used for a part of a buffer that needs user attention.")
346
0199e765 347(defface dired-perm-write
38838c80 348 '((((type w32 pc)) :inherit default) ;; These default to rw-rw-rw.
e1dab605
JL
349 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
350 ;; font-lock-comment-face is not colored any more.
0199e765 351 (t (:inherit font-lock-comment-delimiter-face)))
38838c80
EZ
352 "Face used to highlight permissions of group- and world-writable files."
353 :group 'dired-faces
354 :version "22.2")
0199e765 355(defvar dired-perm-write-face 'dired-perm-write
38838c80
EZ
356 "Face name used for permissions of group- and world-writable files.")
357
0b0e6651
JL
358(defface dired-directory
359 '((t (:inherit font-lock-function-name-face)))
360 "Face used for subdirectories."
361 :group 'dired-faces
bf247b6e 362 :version "22.1")
0b0e6651
JL
363(defvar dired-directory-face 'dired-directory
364 "Face name used for subdirectories.")
365
366(defface dired-symlink
367 '((t (:inherit font-lock-keyword-face)))
368 "Face used for symbolic links."
369 :group 'dired-faces
bf247b6e 370 :version "22.1")
0b0e6651
JL
371(defvar dired-symlink-face 'dired-symlink
372 "Face name used for symbolic links.")
373
374(defface dired-ignored
cf78a467 375 '((t (:inherit shadow)))
0b0e6651
JL
376 "Face used for files suffixed with `completion-ignored-extensions'."
377 :group 'dired-faces
bf247b6e 378 :version "22.1")
0b0e6651
JL
379(defvar dired-ignored-face 'dired-ignored
380 "Face name used for files suffixed with `completion-ignored-extensions'.")
381
2439570d
SM
382(defvar dired-font-lock-keywords
383 (list
384 ;;
385 ;; Directory headers.
0b0e6651
JL
386 (list dired-subdir-regexp '(1 dired-header-face))
387 ;;
388 ;; Dired marks.
389 (list dired-re-mark '(0 dired-mark-face))
2439570d
SM
390 ;;
391 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
392 ;; file name itself. We search for Dired defined regexps, and then use the
393 ;; Dired defined function `dired-move-to-filename' before searching for the
394 ;; simple regexp ".+". It is that regexp which matches the file name.
395 ;;
0b0e6651
JL
396 ;; Marked files.
397 (list (concat "^[" (char-to-string dired-marker-char) "]")
398 '(".+" (dired-move-to-filename) nil (0 dired-marked-face)))
399 ;;
400 ;; Flagged files.
401 (list (concat "^[" (char-to-string dired-del-marker) "]")
402 '(".+" (dired-move-to-filename) nil (0 dired-flagged-face)))
4fdf389a
RS
403 ;; People who are paranoid about security would consider this more
404 ;; important than other things such as whether it is a directory.
405 ;; But we don't want to encourage paranoia, so our default
406 ;; should be what's most useful for non-paranoids. -- rms.
407;;; ;;
408;;; ;; Files that are group or world writable.
409;;; (list (concat dired-re-maybe-mark dired-re-inode-size
410;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
0b0e6651
JL
411;;; '(1 dired-warning-face)
412;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
d7aed37c
SM
413 ;; However, we don't need to highlight the file name, only the
414 ;; permissions, to win generally. -- fx.
415 ;; Fixme: we could also put text properties on the permission
416 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
417 (list (concat dired-re-maybe-mark dired-re-inode-size
f16bcc9a 418 "[-d]....\\(w\\)....") ; group writable
0199e765 419 '(1 dired-perm-write-face))
d7aed37c 420 (list (concat dired-re-maybe-mark dired-re-inode-size
f16bcc9a 421 "[-d].......\\(w\\).") ; world writable
0199e765 422 '(1 dired-perm-write-face))
2439570d
SM
423 ;;
424 ;; Subdirectories.
425 (list dired-re-dir
0b0e6651 426 '(".+" (dired-move-to-filename) nil (0 dired-directory-face)))
2439570d
SM
427 ;;
428 ;; Symbolic links.
c60ee5e7 429 (list dired-re-sym
0b0e6651 430 '(".+" (dired-move-to-filename) nil (0 dired-symlink-face)))
2439570d
SM
431 ;;
432 ;; Files suffixed with `completion-ignored-extensions'.
433 '(eval .
2b2059d8
SM
434 ;; It is quicker to first find just an extension, then go back to the
435 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
436 (list (concat "\\(" (regexp-opt completion-ignored-extensions) "\\|#\\)$")
2225a196
RS
437 '(".+" (dired-move-to-filename) nil (0 dired-ignored-face))))
438 ;;
439 ;; Files suffixed with `completion-ignored-extensions'
440 ;; plus a character put in by -F.
441 '(eval .
442 (list (concat "\\(" (regexp-opt completion-ignored-extensions)
443 "\\|#\\)[*=|]$")
444 '(".+" (progn
445 (end-of-line)
446 ;; If the last character is not part of the filename,
447 ;; move back to the start of the filename
448 ;; so it can be fontified.
449 ;; Otherwise, leave point at the end of the line;
450 ;; that way, nothing is fontified.
451 (unless (get-text-property (1- (point)) 'mouse-face)
452 (dired-move-to-filename)))
453 nil (0 dired-ignored-face))))
454)
2439570d 455 "Additional expressions to highlight in Dired mode.")
65536d1d
RS
456
457(defvar dnd-protocol-alist)
83fadedf 458\f
492d2437
RS
459;;; Macros must be defined before they are used, for the byte compiler.
460
492d2437 461(defmacro dired-mark-if (predicate msg)
d7aed37c
SM
462 "Mark all files for which PREDICATE evals to non-nil.
463PREDICATE is evaluated on each line, with point at beginning of line.
464MSG is a noun phrase for the type of files being marked.
465It should end with a noun that can be pluralized by adding `s'.
466Return value is the number of files marked, or nil if none were marked."
8a946354
SS
467 `(let (buffer-read-only count)
468 (save-excursion
469 (setq count 0)
470 (if ,msg (message "Marking %ss..." ,msg))
471 (goto-char (point-min))
472 (while (not (eobp))
473 (if ,predicate
474 (progn
475 (delete-char 1)
476 (insert dired-marker-char)
477 (setq count (1+ count))))
478 (forward-line 1))
479 (if ,msg (message "%s %s%s %s%s."
480 count
481 ,msg
482 (dired-plural-s count)
483 (if (eq dired-marker-char ?\040) "un" "")
484 (if (eq dired-marker-char dired-del-marker)
485 "flagged" "marked"))))
486 (and (> count 0) count)))
492d2437 487
09b092ad
RS
488(defmacro dired-map-over-marks (body arg &optional show-progress
489 distinguish-one-marked)
91947235
SM
490 "Eval BODY with point on each marked line. Return a list of BODY's results.
491If no marked file could be found, execute BODY on the current line.
492 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
493 files instead of the marked files.
494 In that case point is dragged along. This is so that commands on
495 the next ARG (instead of the marked) files can be chained easily.
496 If ARG is otherwise non-nil, use current file instead.
497If optional third arg SHOW-PROGRESS evaluates to non-nil,
498 redisplay the dired buffer after each file is processed.
499No guarantee is made about the position on the marked line.
500 BODY must ensure this itself if it depends on this.
501Search starts at the beginning of the buffer, thus the car of the list
502 corresponds to the line nearest to the buffer's bottom. This
503 is also true for (positive and negative) integer values of ARG.
09b092ad
RS
504BODY should not be too long as it is expanded four times.
505
506If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
507return (t FILENAME) instead of (FILENAME)."
91947235
SM
508 ;;
509 ;;Warning: BODY must not add new lines before point - this may cause an
510 ;;endless loop.
511 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
512 `(prog1
513 (let (buffer-read-only case-fold-search found results)
514 (if ,arg
515 (if (integerp ,arg)
516 (progn ;; no save-excursion, want to move point.
517 (dired-repeat-over-lines
518 ,arg
519 (function (lambda ()
520 (if ,show-progress (sit-for 0))
521 (setq results (cons ,body results)))))
522 (if (< ,arg 0)
523 (nreverse results)
524 results))
525 ;; non-nil, non-integer ARG means use current file:
526 (list ,body))
527 (let ((regexp (dired-marker-regexp)) next-position)
528 (save-excursion
529 (goto-char (point-min))
530 ;; remember position of next marked file before BODY
531 ;; can insert lines before the just found file,
532 ;; confusing us by finding the same marked file again
533 ;; and again and...
534 (setq next-position (and (re-search-forward regexp nil t)
535 (point-marker))
536 found (not (null next-position)))
537 (while next-position
538 (goto-char next-position)
539 (if ,show-progress (sit-for 0))
540 (setq results (cons ,body results))
541 ;; move after last match
542 (goto-char next-position)
543 (forward-line 1)
544 (set-marker next-position nil)
492d2437 545 (setq next-position (and (re-search-forward regexp nil t)
91947235 546 (point-marker)))))
09b092ad
RS
547 (if (and ,distinguish-one-marked (= (length results) 1))
548 (setq results (cons t results)))
91947235
SM
549 (if found
550 results
551 (list ,body)))))
552 ;; save-excursion loses, again
553 (dired-move-to-filename)))
492d2437 554
09b092ad 555(defun dired-get-marked-files (&optional localp arg filter distinguish-one-marked)
492d2437
RS
556 "Return the marked files' names as list of strings.
557The list is in the same order as the buffer, that is, the car is the
558 first marked file.
1312bfc6 559Values returned are normally absolute file names.
492d2437 560Optional arg LOCALP as in `dired-get-filename'.
1312bfc6
RS
561Optional second argument ARG specifies files near point
562 instead of marked files. If ARG is an integer, use the next ARG files.
563 If ARG is otherwise non-nil, use file. Usually ARG comes from
564 the command's prefix arg.
565Optional third argument FILTER, if non-nil, is a function to select
09b092ad
RS
566 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
567
568If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
569return (t FILENAME) instead of (FILENAME).
570Don't use that together with FILTER."
571 (let* ((all-of-them
572 (save-excursion
573 (dired-map-over-marks
574 (dired-get-filename localp)
575 arg nil distinguish-one-marked)))
576 result)
1312bfc6 577 (if (not filter)
09b092ad
RS
578 (if (and distinguish-one-marked (eq (car all-of-them) t))
579 all-of-them
580 (nreverse all-of-them))
1312bfc6
RS
581 (dolist (file all-of-them)
582 (if (funcall filter file)
583 (push file result)))
584 result)))
83fadedf 585\f
492d2437
RS
586;; The dired command
587
588(defun dired-read-dir-and-switches (str)
589 ;; For use in interactive.
590 (reverse (list
591 (if current-prefix-arg
592 (read-string "Dired listing switches: "
593 dired-listing-switches))
8d9e2a49
JD
594 ;; If a dialog is about to be used, call read-directory-name so
595 ;; the dialog code knows we want directories. Some dialogs can
596 ;; only select directories or files when popped up, not both.
da5a7abb
SM
597 (let ((default (and buffer-file-name
598 (abbreviate-file-name buffer-file-name))))
599 (minibuffer-with-setup-hook
600 (lambda () (setq minibuffer-default default))
8d9e2a49 601 (read-directory-name (format "Dired %s(directory): " str)
da5a7abb 602 nil default-directory nil))))))
84fc2cfa 603
492d2437 604;;;###autoload (define-key ctl-x-map "d" 'dired)
84fc2cfa 605;;;###autoload
492d2437 606(defun dired (dirname &optional switches)
84fc2cfa 607 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
492d2437
RS
608Optional second argument SWITCHES specifies the `ls' options used.
609\(Interactively, use a prefix argument to be able to specify SWITCHES.)
610Dired displays a list of files in DIRNAME (which may also have
8d23c16b 611shell wildcards appended to select certain files). If DIRNAME is a cons,
1015daba 612its first element is taken as the directory name and the rest as an explicit
8d23c16b 613list of files to make directory entries for.
52041219 614\\<dired-mode-map>\
492d2437 615You can move around in it with the usual commands.
8d23c16b
ER
616You can flag files for deletion with \\[dired-flag-file-deletion] and then
617delete them by typing \\[dired-do-flagged-delete].
ee680b2b 618Type \\[describe-mode] after entering Dired for more info.
84fc2cfa 619
492d2437
RS
620If DIRNAME is already in a dired buffer, that buffer is used without refresh."
621 ;; Cannot use (interactive "D") because of wildcards.
622 (interactive (dired-read-dir-and-switches ""))
623 (switch-to-buffer (dired-noselect dirname switches)))
624
625;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
84fc2cfa 626;;;###autoload
492d2437 627(defun dired-other-window (dirname &optional switches)
84fc2cfa 628 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
492d2437
RS
629 (interactive (dired-read-dir-and-switches "in other window "))
630 (switch-to-buffer-other-window (dired-noselect dirname switches)))
84fc2cfa 631
ec03e49c
RS
632;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
633;;;###autoload
634(defun dired-other-frame (dirname &optional switches)
635 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
636 (interactive (dired-read-dir-and-switches "in other frame "))
637 (switch-to-buffer-other-frame (dired-noselect dirname switches)))
638
84fc2cfa 639;;;###autoload
8d23c16b 640(defun dired-noselect (dir-or-list &optional switches)
84fc2cfa 641 "Like `dired' but returns the dired buffer as value, does not select it."
8d23c16b 642 (or dir-or-list (setq dir-or-list default-directory))
492d2437
RS
643 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
644 ;; some shells make:
54df7d9a 645 (let (dirname initially-was-dirname)
8d23c16b
ER
646 (if (consp dir-or-list)
647 (setq dirname (car dir-or-list))
648 (setq dirname dir-or-list))
54df7d9a
RS
649 (setq initially-was-dirname
650 (string= (file-name-as-directory dirname) dirname))
370b6149
RS
651 (setq dirname (abbreviate-file-name
652 (expand-file-name (directory-file-name dirname))))
cb2e51f8
RS
653 (if find-file-visit-truename
654 (setq dirname (file-truename dirname)))
54df7d9a
RS
655 ;; If the argument was syntactically a directory name not a file name,
656 ;; or if it happens to name a file that is a directory,
657 ;; convert it syntactically to a directory name.
658 ;; The reason for checking initially-was-dirname
659 ;; and not just file-directory-p
660 ;; is that file-directory-p is slow over ftp.
661 (if (or initially-was-dirname (file-directory-p dirname))
662 (setq dirname (file-name-as-directory dirname)))
8d23c16b
ER
663 (if (consp dir-or-list)
664 (setq dir-or-list (cons dirname (cdr dir-or-list)))
665 (setq dir-or-list dirname))
666 (dired-internal-noselect dir-or-list switches)))
492d2437 667
573e4d2d
LT
668;; The following is an internal dired function. It returns non-nil if
669;; the directory visited by the current dired buffer has changed on
670;; disk. DIRNAME should be the directory name of that directory.
671(defun dired-directory-changed-p (dirname)
672 (not (let ((attributes (file-attributes dirname))
e09cd94f
LT
673 (modtime (visited-file-modtime)))
674 (or (eq modtime 0)
675 (not (eq (car attributes) t))
ca02a726 676 (equal (nth 5 attributes) modtime)))))
573e4d2d
LT
677
678(defun dired-buffer-stale-p (&optional noconfirm)
679 "Return non-nil if current dired buffer needs updating.
680If NOCONFIRM is non-nil, then this function always returns nil
681for a remote directory. This feature is used by Auto Revert Mode."
682 (let ((dirname
683 (if (consp dired-directory) (car dired-directory) dired-directory)))
684 (and (stringp dirname)
685 (not (when noconfirm (file-remote-p dirname)))
686 (file-readable-p dirname)
687 (dired-directory-changed-p dirname))))
688
492d2437 689;; Separate function from dired-noselect for the sake of dired-vms.el.
6a4cd605 690(defun dired-internal-noselect (dir-or-list &optional switches mode)
492d2437
RS
691 ;; If there is an existing dired buffer for DIRNAME, just leave
692 ;; buffer as it is (don't even call dired-revert).
693 ;; This saves time especially for deep trees or with ange-ftp.
573e4d2d 694 ;; The user can type `g' easily, and it is more consistent with find-file.
492d2437
RS
695 ;; But if SWITCHES are given they are probably different from the
696 ;; buffer's old value, so call dired-sort-other, which does
697 ;; revert the buffer.
698 ;; A pity we can't possibly do "Directory has changed - refresh? "
699 ;; like find-file does.
6a4cd605
RS
700 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
701 ;; see there.
0b7bc76f
RS
702 (let* (dirname
703 buffer
492d2437 704 ;; note that buffer already is in dired-mode, if found
0b7bc76f 705 new-buffer-p
492d2437 706 (old-buf (current-buffer)))
0b7bc76f
RS
707 (if (consp dir-or-list)
708 (setq dirname (car dir-or-list))
709 (setq dirname dir-or-list))
710 ;; Look for an existing buffer.
711 (setq buffer (dired-find-buffer-nocreate dirname mode)
712 new-buffer-p (null buffer))
492d2437
RS
713 (or buffer
714 (let ((default-major-mode 'fundamental-mode))
715 ;; We don't want default-major-mode to run hooks and set auto-fill
716 ;; or whatever, now that dired-mode does not
717 ;; kill-all-local-variables any longer.
718 (setq buffer (create-file-buffer (directory-file-name dirname)))))
719 (set-buffer buffer)
573e4d2d
LT
720 (if (not new-buffer-p) ; existing buffer ...
721 (cond (switches ; ... but new switches
6cfd24f9 722 ;; file list may have changed
0b7bc76f 723 (setq dired-directory dir-or-list)
6cfd24f9 724 ;; this calls dired-revert
c60ee5e7 725 (dired-sort-other switches))
6cfd24f9 726 ;; If directory has changed on disk, offer to revert.
573e4d2d 727 ((when (dired-directory-changed-p dirname)
952e8cb5 728 (message "%s"
212b2266
KH
729 (substitute-command-keys
730 "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
492d2437 731 ;; Else a new buffer
847aabce 732 (setq default-directory
e3cd4b53
RS
733 ;; We can do this unconditionally
734 ;; because dired-noselect ensures that the name
735 ;; is passed in directory name syntax
736 ;; if it was the name of a directory at all.
737 (file-name-directory dirname))
492d2437 738 (or switches (setq switches dired-listing-switches))
6e5d9ec5 739 (if mode (funcall mode)
0b7bc76f 740 (dired-mode dir-or-list switches))
492d2437
RS
741 ;; default-directory and dired-actual-switches are set now
742 ;; (buffer-local), so we can call dired-readin:
743 (let ((failed t))
744 (unwind-protect
0b7bc76f 745 (progn (dired-readin)
492d2437
RS
746 (setq failed nil))
747 ;; dired-readin can fail if parent directories are inaccessible.
748 ;; Don't leave an empty buffer around in that case.
749 (if failed (kill-buffer buffer))))
492d2437
RS
750 (goto-char (point-min))
751 (dired-initial-position dirname))
752 (set-buffer old-buf)
84fc2cfa
ER
753 buffer))
754
c5753a5d
GM
755(defvar dired-buffers nil
756 ;; Enlarged by dired-advertise
757 ;; Queried by function dired-buffers-for-dir. When this detects a
758 ;; killed buffer, it is removed from this list.
759 "Alist of expanded directories and their associated dired buffers.")
760
6a4cd605
RS
761(defun dired-find-buffer-nocreate (dirname &optional mode)
762 ;; This differs from dired-buffers-for-dir in that it does not consider
763 ;; subdirs of default-directory and searches for the first match only.
764 ;; Also, the major mode must be MODE.
0b7bc76f 765 (setq dirname (expand-file-name dirname))
f5b06a95 766 (let (found (blist dired-buffers)) ; was (buffer-list)
6a4cd605 767 (or mode (setq mode 'dired-mode))
492d2437 768 (while blist
6103c44e
KH
769 (if (null (buffer-name (cdr (car blist))))
770 (setq blist (cdr blist))
771 (save-excursion
772 (set-buffer (cdr (car blist)))
6a4cd605 773 (if (and (eq major-mode mode)
59759f1f 774 dired-directory ;; nil during find-alternate-file
0b7bc76f
RS
775 (equal dirname
776 (expand-file-name
777 (if (consp dired-directory)
778 (car dired-directory)
779 dired-directory))))
6103c44e
KH
780 (setq found (cdr (car blist))
781 blist nil)
782 (setq blist (cdr blist))))))
492d2437
RS
783 found))
784
83fadedf 785\f
492d2437
RS
786;; Read in a new dired buffer
787
0b7bc76f 788(defun dired-readin ()
d7aed37c 789 "Read in a new dired buffer.
87ae59e3 790Differs from `dired-insert-subdir' in that it accepts
d7aed37c
SM
791wildcards, erases the buffer, and builds the subdir-alist anew
792\(including making it buffer-local and clearing it first)."
793
492d2437
RS
794 ;; default-directory and dired-actual-switches must be buffer-local
795 ;; and initialized by now.
0b7bc76f
RS
796 (let (dirname)
797 (if (consp dired-directory)
798 (setq dirname (car dired-directory))
799 (setq dirname dired-directory))
8d23c16b 800 (setq dirname (expand-file-name dirname))
8d23c16b 801 (save-excursion
0b7bc76f
RS
802 ;; This hook which may want to modify dired-actual-switches
803 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
804 ;; where ls won't understand -Al switches.
805 (run-hooks 'dired-before-readin-hook)
0b7bc76f
RS
806 (if (consp buffer-undo-list)
807 (setq buffer-undo-list nil))
1419c7fc
RS
808 (make-local-variable 'file-name-coding-system)
809 (setq file-name-coding-system
810 (or coding-system-for-read file-name-coding-system))
0b7bc76f
RS
811 (let (buffer-read-only
812 ;; Don't make undo entries for readin.
813 (buffer-undo-list t))
8d23c16b
ER
814 (widen)
815 (erase-buffer)
0b7bc76f 816 (dired-readin-insert))
0b7bc76f 817 (goto-char (point-min))
8d23c16b
ER
818 ;; Must first make alist buffer local and set it to nil because
819 ;; dired-build-subdir-alist will call dired-clear-alist first
820 (set (make-local-variable 'dired-subdir-alist) nil)
8197b8bf 821 (dired-build-subdir-alist)
fa562dd5
RS
822 (let ((attributes (file-attributes dirname)))
823 (if (eq (car attributes) t)
824 (set-visited-file-modtime (nth 5 attributes))))
0b7bc76f
RS
825 (set-buffer-modified-p nil)
826 ;; No need to narrow since the whole buffer contains just
827 ;; dired-readin's output, nothing else. The hook can
828 ;; successfully use dired functions (e.g. dired-get-filename)
829 ;; as the subdir-alist has been built in dired-readin.
830 (run-hooks 'dired-after-readin-hook))))
492d2437
RS
831
832;; Subroutines of dired-readin
833
0b7bc76f
RS
834(defun dired-readin-insert ()
835 ;; Insert listing for the specified dir (and maybe file list)
836 ;; already in dired-directory, assuming a clean buffer.
837 (let (dir file-list)
838 (if (consp dired-directory)
839 (setq dir (car dired-directory)
840 file-list (cdr dired-directory))
841 (setq dir dired-directory
842 file-list nil))
34cd7b3c 843 (setq dir (expand-file-name dir))
0b7bc76f
RS
844 (if (and (equal "" (file-name-nondirectory dir))
845 (not file-list))
cf39fa9b 846 ;; If we are reading a whole single directory...
0b7bc76f 847 (dired-insert-directory dir dired-actual-switches nil nil t)
8d23c16b 848 (if (not (file-readable-p
0b7bc76f
RS
849 (directory-file-name (file-name-directory dir))))
850 (error "Directory %s inaccessible or nonexistent" dir)
851 ;; Else treat it as a wildcard spec
852 ;; unless we have an explicit list of files.
853 (dired-insert-directory dir dired-actual-switches
854 file-list (not file-list) t)))))
855
a12c6dca
SM
856(defun dired-align-file (beg end)
857 "Align the fields of a file to the ones of surrounding lines.
858BEG..END is the line where the file info is located."
859 ;; Some versions of ls try to adjust the size of each field so as to just
860 ;; hold the largest element ("largest" in the current invocation, of
861 ;; course). So when a single line is output, the size of each field is
862 ;; just big enough for that one output. Thus when dired refreshes one
863 ;; line, the alignment if this line w.r.t the rest is messed up because
864 ;; the fields of that one line will generally be smaller.
865 ;;
9bc260cf
MA
866 ;; To work around this problem, we here add spaces to try and
867 ;; re-align the fields as needed. Since this is purely aesthetic,
868 ;; it is of utmost importance that it doesn't mess up anything like
869 ;; `dired-move-to-filename'. To this end, we limit ourselves to
870 ;; adding spaces only, and to only add them at places where there
871 ;; was already at least one space. This way, as long as
872 ;; `directory-listing-before-filename-regexp' always matches spaces
873 ;; with "*" or "+", we know we haven't made anything worse. There
874 ;; is one spot where the exact number of spaces is important, which
875 ;; is just before the actual filename, so we refrain from adding
876 ;; spaces there (and within the filename as well, of course).
a12c6dca
SM
877 (save-excursion
878 (let (file file-col other other-col)
879 ;; Check the there is indeed a file, and that there is anoter adjacent
880 ;; file with which to align, and that additional spaces are needed to
881 ;; align the filenames.
882 (when (and (setq file (progn (goto-char beg)
883 (dired-move-to-filename nil end)))
884 (setq file-col (current-column))
885 (setq other
886 (or (and (goto-char beg)
887 (zerop (forward-line -1))
888 (dired-move-to-filename))
889 (and (goto-char beg)
890 (zerop (forward-line 1))
891 (dired-move-to-filename))))
892 (setq other-col (current-column))
893 (/= file other)
894 ;; Make sure there is some work left to do.
895 (> other-col file-col))
896 ;; If we've only looked at the line above, check to see if the line
897 ;; below exists as well and if so, align with the shorter one.
898 (when (and (< other file)
899 (goto-char beg)
900 (zerop (forward-line 1))
901 (dired-move-to-filename))
902 (let ((alt-col (current-column)))
903 (when (< alt-col other-col)
904 (setq other-col alt-col)
905 (setq other (point)))))
906 ;; Keep positions uptodate when we insert stuff.
907 (if (> other file) (setq other (copy-marker other)))
908 (setq file (copy-marker file))
909 ;; Main loop.
910 (goto-char beg)
87ae59e3 911 (skip-chars-forward " ") ;Skip to the first field.
a12c6dca 912 (while (and (> other-col file-col)
a12c6dca
SM
913 ;; Don't touch anything just before (and after) the
914 ;; beginning of the filename.
915 (> file (point)))
916 ;; We're now just in front of a field, with a space behind us.
917 (let* ((curcol (current-column))
918 ;; Nums are right-aligned.
919 (num-align (looking-at "[0-9]"))
920 ;; Let's look at the other line, in the same column: we
921 ;; should be either near the end of the previous field, or
922 ;; in the space between that field and the next.
923 ;; [ Of course, it's also possible that we're already within
924 ;; the next field or even past it, but that's unlikely since
925 ;; other-col > file-col. ]
926 ;; Let's find the distance to the alignment-point (either
927 ;; the beginning or the end of the next field, depending on
928 ;; whether this field is left or right aligned).
929 (align-pt-offset
930 (save-excursion
931 (goto-char other)
932 (move-to-column curcol)
933 (when (looking-at
934 (concat
ee680b2b 935 (if (eq (char-before) ?\s) " *" "[^ ]* *")
a12c6dca
SM
936 (if num-align "[0-9][^ ]*")))
937 (- (match-end 0) (match-beginning 0)))))
938 ;; Now, the number of spaces to insert is align-pt-offset
939 ;; minus the distance to the equivalent point on the
940 ;; current line.
941 (spaces
942 (if (not num-align)
943 align-pt-offset
944 (and align-pt-offset
945 (save-excursion
946 (skip-chars-forward "^ ")
947 (- align-pt-offset (- (current-column) curcol)))))))
948 (when (and spaces (> spaces 0))
949 (setq file-col (+ spaces file-col))
950 (if (> file-col other-col)
951 (setq spaces (- spaces (- file-col other-col))))
952 (insert-char ?\s spaces)
953 ;; Let's just make really sure we did not mess up.
954 (unless (save-excursion
87ae59e3 955 (eq (dired-move-to-filename) (marker-position file)))
a12c6dca 956 ;; Damn! We messed up: let's revert the change.
87ae59e3
SM
957 (delete-char (- spaces)))))
958 ;; Now skip to next field.
959 (skip-chars-forward "^ ") (skip-chars-forward " "))
a12c6dca 960 (set-marker file nil)))))
87ae59e3 961
a12c6dca 962
0b7bc76f
RS
963(defun dired-insert-directory (dir switches &optional file-list wildcard hdr)
964 "Insert a directory listing of DIR, Dired style.
965Use SWITCHES to make the listings.
966If FILE-LIST is non-nil, list only those files.
967Otherwise, if WILDCARD is non-nil, expand wildcards;
968 in that case, DIR should be a file name that uses wildcards.
969In other cases, DIR should be a directory name or a directory filename.
970If HDR is non-nil, insert a header line with the directory name."
9888aa65 971 (let ((opoint (point))
02b5d79c 972 (process-environment (copy-sequence process-environment))
9888aa65 973 end)
1fc85dae 974 (if (or dired-use-ls-dired (file-remote-p dir))
0b7bc76f 975 (setq switches (concat "--dired " switches)))
6492483f
RS
976 ;; We used to specify the C locale here, to force English month names;
977 ;; but this should not be necessary any more,
9bc260cf 978 ;; with the new value of `directory-listing-before-filename-regexp'.
0b7bc76f
RS
979 (if file-list
980 (dolist (f file-list)
a12c6dca
SM
981 (let ((beg (point)))
982 (insert-directory f switches nil nil)
983 ;; Re-align fields, if necessary.
984 (dired-align-file beg (point))))
0b7bc76f 985 (insert-directory dir switches wildcard (not wildcard)))
9888aa65 986 ;; Quote certain characters, unless ls quoted them for us.
ad632492
SM
987 (if (not (string-match "b" dired-actual-switches))
988 (save-excursion
989 (setq end (point-marker))
990 (goto-char opoint)
991 (while (search-forward "\\" end t)
2bb27597
AS
992 (replace-match (apply #'propertize
993 "\\\\"
994 (text-properties-at (match-beginning 0)))
995 nil t))
ad632492
SM
996 (goto-char opoint)
997 (while (search-forward "\^m" end t)
2bb27597
AS
998 (replace-match (apply #'propertize
999 "\\015"
1000 (text-properties-at (match-beginning 0)))
1001 nil t))
ad632492 1002 (set-marker end nil)))
0b7bc76f
RS
1003 (dired-insert-set-properties opoint (point))
1004 ;; If we used --dired and it worked, the lines are already indented.
1005 ;; Otherwise, indent them.
1006 (unless (save-excursion
1ba6c0f2 1007 (goto-char opoint)
0b7bc76f
RS
1008 (looking-at " "))
1009 (let ((indent-tabs-mode nil))
1010 (indent-rigidly opoint (point) 2)))
1011 ;; Insert text at the beginning to standardize things.
1012 (save-excursion
1013 (goto-char opoint)
1014 (if (and (or hdr wildcard) (not (looking-at "^ /.*:$")))
1015 ;; Note that dired-build-subdir-alist will replace the name
1016 ;; by its expansion, so it does not matter whether what we insert
1017 ;; here is fully expanded, but it should be absolute.
1018 (insert " " (directory-file-name (file-name-directory dir)) ":\n"))
1019 (when wildcard
1020 ;; Insert "wildcard" line where "total" line would be for a full dir.
1021 (insert " wildcard " (file-name-nondirectory dir) "\n")))))
492d2437 1022
cb88a3db 1023(defun dired-insert-set-properties (beg end)
d7aed37c 1024 "Make the file names highlight when the mouse is on them."
cb88a3db
RS
1025 (save-excursion
1026 (goto-char beg)
1027 (while (< (point) end)
7da0e9b4
RS
1028 (condition-case nil
1029 (if (dired-move-to-filename)
ac2d0299
EZ
1030 (add-text-properties
1031 (point)
1032 (save-excursion
1033 (dired-move-to-end-of-filename)
1034 (point))
1b85bd12 1035 '(mouse-face highlight
ac2d0299 1036 help-echo "mouse-2: visit this file in other window")))
7da0e9b4 1037 (error nil))
cb88a3db 1038 (forward-line 1))))
83fadedf 1039\f
492d2437
RS
1040;; Reverting a dired buffer
1041
84fc2cfa 1042(defun dired-revert (&optional arg noconfirm)
d7aed37c 1043 "Reread the dired buffer.
ee680b2b 1044Must also be called after `dired-actual-switches' have changed.
d7aed37c
SM
1045Should not fail even on completely garbaged buffers.
1046Preserves old cursor, marks/flags, hidden-p."
492d2437 1047 (widen) ; just in case user narrowed
7805cdbd
LT
1048 (let ((modflag (buffer-modified-p))
1049 (opoint (point))
492d2437
RS
1050 (ofile (dired-get-filename nil t))
1051 (mark-alist nil) ; save marked files
1052 (hidden-subdirs (dired-remember-hidden))
1053 (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
1054 (case-fold-search nil) ; we check for upper case ls flags
1055 buffer-read-only)
1056 (goto-char (point-min))
1057 (setq mark-alist;; only after dired-remember-hidden since this unhides:
1058 (dired-remember-marks (point-min) (point-max)))
1059 ;; treat top level dir extra (it may contain wildcards)
8d23c16b
ER
1060 (dired-uncache
1061 (if (consp dired-directory) (car dired-directory) dired-directory))
6a80f50e 1062 ;; Run dired-after-readin-hook just once, below.
492d2437 1063 (let ((dired-after-readin-hook nil))
6a80f50e 1064 (dired-readin)
492d2437
RS
1065 (dired-insert-old-subdirs old-subdir-alist))
1066 (dired-mark-remembered mark-alist) ; mark files that were marked
1067 ;; ... run the hook for the whole buffer, and only after markers
1068 ;; have been reinserted (else omitting in dired-x would omit marked files)
1069 (run-hooks 'dired-after-readin-hook) ; no need to narrow
1070 (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
1071 (goto-char opoint)) ; was before
84fc2cfa 1072 (dired-move-to-filename)
492d2437 1073 (save-excursion ; hide subdirs that were hidden
d7aed37c
SM
1074 (dolist (dir hidden-subdirs)
1075 (if (dired-goto-subdir dir)
7805cdbd
LT
1076 (dired-hide-subdir 1))))
1077 (unless modflag (restore-buffer-modified-p nil)))
492d2437 1078 ;; outside of the let scope
7805cdbd 1079;;; Might as well not override the user if the user changed this.
492d2437
RS
1080;;; (setq buffer-read-only t)
1081 )
1082
1083;; Subroutines of dired-revert
1084;; Some of these are also used when inserting subdirs.
1085
1086(defun dired-remember-marks (beg end)
d7aed37c 1087 "Return alist of files and their marks, from BEG to END."
492d2437
RS
1088 (if selective-display ; must unhide to make this work.
1089 (let (buffer-read-only)
1090 (subst-char-in-region beg end ?\r ?\n)))
1091 (let (fil chr alist)
1092 (save-excursion
1093 (goto-char beg)
1094 (while (re-search-forward dired-re-mark end t)
1095 (if (setq fil (dired-get-filename nil t))
1096 (setq chr (preceding-char)
1097 alist (cons (cons fil chr) alist)))))
1098 alist))
1099
492d2437 1100(defun dired-mark-remembered (alist)
d7aed37c
SM
1101 "Mark all files remembered in ALIST.
1102Each element of ALIST looks like (FILE . MARKERCHAR)."
492d2437
RS
1103 (let (elt fil chr)
1104 (while alist
1105 (setq elt (car alist)
1106 alist (cdr alist)
1107 fil (car elt)
1108 chr (cdr elt))
1109 (if (dired-goto-file fil)
1110 (save-excursion
1111 (beginning-of-line)
1112 (delete-char 1)
1113 (insert chr))))))
1114
492d2437 1115(defun dired-remember-hidden ()
d7aed37c 1116 "Return a list of names of subdirs currently hidden."
492d2437
RS
1117 (let ((l dired-subdir-alist) dir pos result)
1118 (while l
1119 (setq dir (car (car l))
1120 pos (cdr (car l))
1121 l (cdr l))
1122 (goto-char pos)
1123 (skip-chars-forward "^\r\n")
52041219 1124 (if (eq (following-char) ?\r)
492d2437
RS
1125 (setq result (cons dir result))))
1126 result))
1127
492d2437 1128(defun dired-insert-old-subdirs (old-subdir-alist)
d7aed37c
SM
1129 "Try to insert all subdirs that were displayed before.
1130Do so according to the former subdir alist OLD-SUBDIR-ALIST."
492d2437
RS
1131 (or (string-match "R" dired-actual-switches)
1132 (let (elt dir)
1133 (while old-subdir-alist
1134 (setq elt (car old-subdir-alist)
1135 old-subdir-alist (cdr old-subdir-alist)
1136 dir (car elt))
1137 (condition-case ()
715984d3
RS
1138 (progn
1139 (dired-uncache dir)
f817c0fb 1140 (dired-insert-subdir dir))
492d2437 1141 (error nil))))))
715984d3 1142
715984d3 1143(defun dired-uncache (dir)
d7aed37c 1144 "Remove directory DIR from any directory cache."
6eaebaa2 1145 (let ((handler (find-file-name-handler dir 'dired-uncache)))
715984d3
RS
1146 (if handler
1147 (funcall handler 'dired-uncache dir))))
83fadedf 1148\f
492d2437 1149;; dired mode key bindings and initialization
84fc2cfa 1150
d7aed37c 1151(defvar dired-mode-map
492d2437
RS
1152 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1153 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
3e1fb00f
RS
1154 (let ((map (make-keymap)))
1155 (suppress-keymap map)
1156 (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
bb87fbc3 1157 (define-key map [follow-link] 'mouse-face)
3e1fb00f
RS
1158 ;; Commands to mark or flag certain categories of files
1159 (define-key map "#" 'dired-flag-auto-save-files)
3e1fb00f 1160 (define-key map "." 'dired-clean-directory)
3e1fb00f 1161 (define-key map "~" 'dired-flag-backup-files)
84d3f6e8 1162 (define-key map "&" 'dired-flag-garbage-files)
3e1fb00f
RS
1163 ;; Upper case keys (except !) for operating on the marked files
1164 (define-key map "A" 'dired-do-search)
1165 (define-key map "C" 'dired-do-copy)
1166 (define-key map "B" 'dired-do-byte-compile)
1167 (define-key map "D" 'dired-do-delete)
1168 (define-key map "G" 'dired-do-chgrp)
1169 (define-key map "H" 'dired-do-hardlink)
1170 (define-key map "L" 'dired-do-load)
1171 (define-key map "M" 'dired-do-chmod)
1172 (define-key map "O" 'dired-do-chown)
1173 (define-key map "P" 'dired-do-print)
ee93b692 1174 (define-key map "Q" 'dired-do-query-replace-regexp)
3e1fb00f
RS
1175 (define-key map "R" 'dired-do-rename)
1176 (define-key map "S" 'dired-do-symlink)
57654b8c 1177 (define-key map "T" 'dired-do-touch)
3e1fb00f
RS
1178 (define-key map "X" 'dired-do-shell-command)
1179 (define-key map "Z" 'dired-do-compress)
1180 (define-key map "!" 'dired-do-shell-command)
1181 ;; Comparison commands
1182 (define-key map "=" 'dired-diff)
1183 (define-key map "\M-=" 'dired-backup-diff)
1184 ;; Tree Dired commands
1185 (define-key map "\M-\C-?" 'dired-unmark-all-files)
1186 (define-key map "\M-\C-d" 'dired-tree-down)
1187 (define-key map "\M-\C-u" 'dired-tree-up)
1188 (define-key map "\M-\C-n" 'dired-next-subdir)
1189 (define-key map "\M-\C-p" 'dired-prev-subdir)
1190 ;; move to marked files
1191 (define-key map "\M-{" 'dired-prev-marked-file)
1192 (define-key map "\M-}" 'dired-next-marked-file)
1193 ;; Make all regexp commands share a `%' prefix:
1194 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1195 ;; but that seems to serve little purpose, and copy-keymap
1196 ;; does a better job without it.
1197 (define-key map "%" nil)
1198 (define-key map "%u" 'dired-upcase)
1199 (define-key map "%l" 'dired-downcase)
1200 (define-key map "%d" 'dired-flag-files-regexp)
e9b8e22d 1201 (define-key map "%g" 'dired-mark-files-containing-regexp)
3e1fb00f
RS
1202 (define-key map "%m" 'dired-mark-files-regexp)
1203 (define-key map "%r" 'dired-do-rename-regexp)
1204 (define-key map "%C" 'dired-do-copy-regexp)
1205 (define-key map "%H" 'dired-do-hardlink-regexp)
1206 (define-key map "%R" 'dired-do-rename-regexp)
1207 (define-key map "%S" 'dired-do-symlink-regexp)
4a3ca6ed
RS
1208 ;; Commands for marking and unmarking.
1209 (define-key map "*" nil)
1210 (define-key map "**" 'dired-mark-executables)
1211 (define-key map "*/" 'dired-mark-directories)
1212 (define-key map "*@" 'dired-mark-symlinks)
1213 (define-key map "*%" 'dired-mark-files-regexp)
1214 (define-key map "*c" 'dired-change-marks)
0609c998 1215 (define-key map "*s" 'dired-mark-subdir-files)
4a3ca6ed
RS
1216 (define-key map "*m" 'dired-mark)
1217 (define-key map "*u" 'dired-unmark)
1218 (define-key map "*?" 'dired-unmark-all-files)
534a6edf 1219 (define-key map "*!" 'dired-unmark-all-marks)
d7aed37c 1220 (define-key map "U" 'dired-unmark-all-marks)
4a3ca6ed
RS
1221 (define-key map "*\177" 'dired-unmark-backward)
1222 (define-key map "*\C-n" 'dired-next-marked-file)
1223 (define-key map "*\C-p" 'dired-prev-marked-file)
d588eb90 1224 (define-key map "*t" 'dired-toggle-marks)
3e1fb00f 1225 ;; Lower keys for commands not operating on all the marked files
c5753a5d 1226 (define-key map "a" 'dired-find-alternate-file)
3e1fb00f
RS
1227 (define-key map "d" 'dired-flag-file-deletion)
1228 (define-key map "e" 'dired-find-file)
1229 (define-key map "f" 'dired-find-file)
1230 (define-key map "\C-m" 'dired-advertised-find-file)
1231 (define-key map "g" 'revert-buffer)
1232 (define-key map "h" 'describe-mode)
1233 (define-key map "i" 'dired-maybe-insert-subdir)
e19d2d64 1234 (define-key map "j" 'dired-goto-file)
3e1fb00f
RS
1235 (define-key map "k" 'dired-do-kill-lines)
1236 (define-key map "l" 'dired-do-redisplay)
1237 (define-key map "m" 'dired-mark)
1238 (define-key map "n" 'dired-next-line)
1239 (define-key map "o" 'dired-find-file-other-window)
1240 (define-key map "\C-o" 'dired-display-file)
1241 (define-key map "p" 'dired-previous-line)
da8a8438 1242 (define-key map "q" 'quit-window)
3e1fb00f 1243 (define-key map "s" 'dired-sort-toggle-or-edit)
d588eb90 1244 (define-key map "t" 'dired-toggle-marks)
3e1fb00f
RS
1245 (define-key map "u" 'dired-unmark)
1246 (define-key map "v" 'dired-view-file)
a3f4a3ef 1247 (define-key map "w" 'dired-copy-filename-as-kill)
3e1fb00f 1248 (define-key map "x" 'dired-do-flagged-delete)
d1e99fa5 1249 (define-key map "y" 'dired-show-file-type)
3e1fb00f
RS
1250 (define-key map "+" 'dired-create-directory)
1251 ;; moving
1252 (define-key map "<" 'dired-prev-dirline)
1253 (define-key map ">" 'dired-next-dirline)
1254 (define-key map "^" 'dired-up-directory)
1255 (define-key map " " 'dired-next-line)
1256 (define-key map "\C-n" 'dired-next-line)
1257 (define-key map "\C-p" 'dired-previous-line)
1258 (define-key map [down] 'dired-next-line)
1259 (define-key map [up] 'dired-previous-line)
1260 ;; hiding
1261 (define-key map "$" 'dired-hide-subdir)
1262 (define-key map "\M-$" 'dired-hide-all)
1263 ;; misc
40aa8257 1264 (define-key map "\C-x\C-q" 'dired-toggle-read-only)
3e1fb00f
RS
1265 (define-key map "?" 'dired-summary)
1266 (define-key map "\177" 'dired-unmark-backward)
5e5a3412
RS
1267 (define-key map [remap undo] 'dired-undo)
1268 (define-key map [remap advertised-undo] 'dired-undo)
aa1a7612
CY
1269 ;; thumbnail manipulation (image-dired)
1270 (define-key map "\C-td" 'image-dired-display-thumbs)
1271 (define-key map "\C-tt" 'image-dired-tag-files)
1272 (define-key map "\C-tr" 'image-dired-delete-tag)
1273 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1274 (define-key map "\C-ti" 'image-dired-dired-display-image)
1275 (define-key map "\C-tx" 'image-dired-dired-display-external)
1276 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1277 (define-key map "\C-t." 'image-dired-display-thumb)
1278 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1279 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1280 (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1281 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
3e1fb00f
RS
1282
1283 ;; Make menu bar items.
1284
d066de8e
EZ
1285 ;; No need to fo this, now that top-level items are fewer.
1286 ;;;;
3e1fb00f 1287 ;; Get rid of the Edit menu bar item to save space.
d066de8e 1288 ;(define-key map [menu-bar edit] 'undefined)
3e1fb00f
RS
1289
1290 (define-key map [menu-bar subdir]
1291 (cons "Subdir" (make-sparse-keymap "Subdir")))
1292
1293 (define-key map [menu-bar subdir hide-all]
d066de8e
EZ
1294 '(menu-item "Hide All" dired-hide-all
1295 :help "Hide all subdirectories, leave only header lines"))
3e1fb00f 1296 (define-key map [menu-bar subdir hide-subdir]
d066de8e
EZ
1297 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1298 :help "Hide or unhide current directory listing"))
3e1fb00f 1299 (define-key map [menu-bar subdir tree-down]
d066de8e
EZ
1300 '(menu-item "Tree Down" dired-tree-down
1301 :help "Go to first subdirectory header down the tree"))
3e1fb00f 1302 (define-key map [menu-bar subdir tree-up]
d066de8e
EZ
1303 '(menu-item "Tree Up" dired-tree-up
1304 :help "Go to first subdirectory header up the tree"))
3e1fb00f 1305 (define-key map [menu-bar subdir up]
d066de8e
EZ
1306 '(menu-item "Up Directory" dired-up-directory
1307 :help "Edit the parent directory"))
3e1fb00f 1308 (define-key map [menu-bar subdir prev-subdir]
d066de8e
EZ
1309 '(menu-item "Prev Subdir" dired-prev-subdir
1310 :help "Go to previous subdirectory header line"))
3e1fb00f 1311 (define-key map [menu-bar subdir next-subdir]
d066de8e
EZ
1312 '(menu-item "Next Subdir" dired-next-subdir
1313 :help "Go to next subdirectory header line"))
3e1fb00f 1314 (define-key map [menu-bar subdir prev-dirline]
d066de8e
EZ
1315 '(menu-item "Prev Dirline" dired-prev-dirline
1316 :help "Move to next directory-file line"))
3e1fb00f 1317 (define-key map [menu-bar subdir next-dirline]
d066de8e
EZ
1318 '(menu-item "Next Dirline" dired-next-dirline
1319 :help "Move to previous directory-file line"))
3e1fb00f 1320 (define-key map [menu-bar subdir insert]
d066de8e
EZ
1321 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1322 :help "Insert contents of subdirectory"))
3e1fb00f
RS
1323
1324 (define-key map [menu-bar immediate]
1325 (cons "Immediate" (make-sparse-keymap "Immediate")))
1326
635abd82 1327 (define-key map
aa1a7612
CY
1328 [menu-bar immediate image-dired-dired-display-external]
1329 '(menu-item "Display Image Externally" image-dired-dired-display-external
bc4dbed5 1330 :help "Display image in external viewer"))
635abd82 1331 (define-key map
aa1a7612
CY
1332 [menu-bar immediate image-dired-dired-display-image]
1333 '(menu-item "Display Image" image-dired-dired-display-image
bc4dbed5 1334 :help "Display sized image in a separate window"))
36938994 1335
836788c9
MD
1336 (define-key map [menu-bar immediate dashes-4]
1337 '("--"))
1338
1339 (define-key map [menu-bar immediate revert-buffer]
1340 '(menu-item "Refresh" revert-buffer
1341 :help "Update contents of shown directories"))
1342
1343 (define-key map [menu-bar immediate dashes]
1344 '("--"))
635abd82 1345
0e2aaf98 1346 (define-key map [menu-bar immediate compare-directories]
27af5d58 1347 '(menu-item "Compare Directories..." dired-compare-directories
0e2aaf98 1348 :help "Mark files with different attributes in two dired buffers"))
3e1fb00f 1349 (define-key map [menu-bar immediate backup-diff]
d066de8e
EZ
1350 '(menu-item "Compare with Backup" dired-backup-diff
1351 :help "Diff file at cursor with its latest backup"))
3e1fb00f 1352 (define-key map [menu-bar immediate diff]
d066de8e
EZ
1353 '(menu-item "Diff..." dired-diff
1354 :help "Compare file at cursor with another file"))
3e1fb00f 1355 (define-key map [menu-bar immediate view]
d066de8e
EZ
1356 '(menu-item "View This File" dired-view-file
1357 :help "Examine file at cursor in read-only mode"))
3e1fb00f 1358 (define-key map [menu-bar immediate display]
d066de8e
EZ
1359 '(menu-item "Display in Other Window" dired-display-file
1360 :help "Display file at cursor in other window"))
3e1fb00f 1361 (define-key map [menu-bar immediate find-file-other-window]
d066de8e
EZ
1362 '(menu-item "Find in Other Window" dired-find-file-other-window
1363 :help "Edit file at cursor in other window"))
3e1fb00f 1364 (define-key map [menu-bar immediate find-file]
d066de8e
EZ
1365 '(menu-item "Find This File" dired-find-file
1366 :help "Edit file at cursor"))
3e1fb00f 1367 (define-key map [menu-bar immediate create-directory]
d066de8e 1368 '(menu-item "Create Directory..." dired-create-directory))
2ecab840 1369 (define-key map [menu-bar immediate wdired-mode]
40aa8257
JL
1370 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1371 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
3e1fb00f
RS
1372
1373 (define-key map [menu-bar regexp]
1374 (cons "Regexp" (make-sparse-keymap "Regexp")))
1375
836788c9 1376 (define-key map
aa1a7612
CY
1377 [menu-bar regexp image-dired-mark-tagged-files]
1378 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
098bab71
JB
1379 :help "Mark files whose image tags matches regexp"))
1380
836788c9 1381 (define-key map [menu-bar regexp dashes-1]
098bab71 1382 '("--"))
836788c9 1383
3e1fb00f 1384 (define-key map [menu-bar regexp downcase]
d066de8e
EZ
1385 '(menu-item "Downcase" dired-downcase
1386 ;; When running on plain MS-DOS, there's only one
1387 ;; letter-case for file names.
1388 :enable (or (not (fboundp 'msdos-long-file-names))
1389 (msdos-long-file-names))
1390 :help "Rename marked files to lower-case name"))
3e1fb00f 1391 (define-key map [menu-bar regexp upcase]
d066de8e
EZ
1392 '(menu-item "Upcase" dired-upcase
1393 :enable (or (not (fboundp 'msdos-long-file-names))
1394 (msdos-long-file-names))
1395 :help "Rename marked files to upper-case name"))
3e1fb00f 1396 (define-key map [menu-bar regexp hardlink]
d066de8e
EZ
1397 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1398 :help "Make hard links for files matching regexp"))
3e1fb00f 1399 (define-key map [menu-bar regexp symlink]
d066de8e
EZ
1400 '(menu-item "Symlink..." dired-do-symlink-regexp
1401 :visible (fboundp 'make-symbolic-link)
1402 :help "Make symbolic links for files matching regexp"))
3e1fb00f 1403 (define-key map [menu-bar regexp rename]
d066de8e
EZ
1404 '(menu-item "Rename..." dired-do-rename-regexp
1405 :help "Rename marked files matching regexp"))
3e1fb00f 1406 (define-key map [menu-bar regexp copy]
d066de8e
EZ
1407 '(menu-item "Copy..." dired-do-copy-regexp
1408 :help "Copy marked files matching regexp"))
3e1fb00f 1409 (define-key map [menu-bar regexp flag]
d066de8e
EZ
1410 '(menu-item "Flag..." dired-flag-files-regexp
1411 :help "Flag files matching regexp for deletion"))
3e1fb00f 1412 (define-key map [menu-bar regexp mark]
d066de8e
EZ
1413 '(menu-item "Mark..." dired-mark-files-regexp
1414 :help "Mark files matching regexp for future operations"))
aa924deb 1415 (define-key map [menu-bar regexp mark-cont]
d066de8e
EZ
1416 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1417 :help "Mark files whose contents matches regexp"))
3e1fb00f
RS
1418
1419 (define-key map [menu-bar mark]
1420 (cons "Mark" (make-sparse-keymap "Mark")))
1421
1422 (define-key map [menu-bar mark prev]
d066de8e
EZ
1423 '(menu-item "Previous Marked" dired-prev-marked-file
1424 :help "Move to previous marked file"))
3e1fb00f 1425 (define-key map [menu-bar mark next]
d066de8e
EZ
1426 '(menu-item "Next Marked" dired-next-marked-file
1427 :help "Move to next marked file"))
3e1fb00f 1428 (define-key map [menu-bar mark marks]
d066de8e
EZ
1429 '(menu-item "Change Marks..." dired-change-marks
1430 :help "Replace marker with another character"))
3e1fb00f 1431 (define-key map [menu-bar mark unmark-all]
d066de8e 1432 '(menu-item "Unmark All" dired-unmark-all-marks))
3e1fb00f 1433 (define-key map [menu-bar mark symlinks]
d066de8e
EZ
1434 '(menu-item "Mark Symlinks" dired-mark-symlinks
1435 :visible (fboundp 'make-symbolic-link)
1436 :help "Mark all symbolic links"))
3e1fb00f 1437 (define-key map [menu-bar mark directories]
d066de8e
EZ
1438 '(menu-item "Mark Directories" dired-mark-directories
1439 :help "Mark all directories except `.' and `..'"))
3e1fb00f 1440 (define-key map [menu-bar mark directory]
d066de8e
EZ
1441 '(menu-item "Mark Old Backups" dired-clean-directory
1442 :help "Flag old numbered backups for deletion"))
3e1fb00f 1443 (define-key map [menu-bar mark executables]
d066de8e
EZ
1444 '(menu-item "Mark Executables" dired-mark-executables
1445 :help "Mark all executable files"))
84d3f6e8 1446 (define-key map [menu-bar mark garbage-files]
d066de8e
EZ
1447 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1448 :help "Flag unneeded files for deletion"))
3e1fb00f 1449 (define-key map [menu-bar mark backup-files]
d066de8e
EZ
1450 '(menu-item "Flag Backup Files" dired-flag-backup-files
1451 :help "Flag all backup files for deletion"))
3e1fb00f 1452 (define-key map [menu-bar mark auto-save-files]
d066de8e
EZ
1453 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1454 :help "Flag auto-save files for deletion"))
3e1fb00f 1455 (define-key map [menu-bar mark deletion]
d066de8e
EZ
1456 '(menu-item "Flag" dired-flag-file-deletion
1457 :help "Flag current line's file for deletion"))
3e1fb00f 1458 (define-key map [menu-bar mark unmark]
d066de8e
EZ
1459 '(menu-item "Unmark" dired-unmark
1460 :help "Unmark or unflag current line's file"))
3e1fb00f 1461 (define-key map [menu-bar mark mark]
d066de8e
EZ
1462 '(menu-item "Mark" dired-mark
1463 :help "Mark current line's file for future operations"))
e5f0841e 1464 (define-key map [menu-bar mark toggle-marks]
d588eb90 1465 '(menu-item "Toggle Marks" dired-toggle-marks
d066de8e 1466 :help "Mark unmarked files, unmark marked ones"))
3e1fb00f
RS
1467
1468 (define-key map [menu-bar operate]
1469 (cons "Operate" (make-sparse-keymap "Operate")))
1470
836788c9 1471 (define-key map
aa1a7612
CY
1472 [menu-bar operate image-dired-delete-tag]
1473 '(menu-item "Delete Image Tag..." image-dired-delete-tag
b305952d 1474 :help "Delete image tag from current or marked files"))
836788c9 1475 (define-key map
aa1a7612
CY
1476 [menu-bar operate image-dired-tag-files]
1477 '(menu-item "Add Image Tags..." image-dired-tag-files
836788c9
MD
1478 :help "Add image tags to current or marked files"))
1479 (define-key map
aa1a7612
CY
1480 [menu-bar operate image-dired-dired-comment-files]
1481 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
836788c9
MD
1482 :help "Add image comment to current or marked files"))
1483 (define-key map
aa1a7612
CY
1484 [menu-bar operate image-dired-display-thumbs]
1485 '(menu-item "Display Image-Dired" image-dired-display-thumbs
1486 :help "Display image-dired for current or marked image files"))
098bab71 1487
836788c9 1488 (define-key map [menu-bar operate dashes-3]
098bab71 1489 '("--"))
836788c9 1490
3e1fb00f 1491 (define-key map [menu-bar operate query-replace]
ee93b692 1492 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
d066de8e 1493 :help "Replace regexp in marked files"))
3e1fb00f 1494 (define-key map [menu-bar operate search]
d066de8e
EZ
1495 '(menu-item "Search Files..." dired-do-search
1496 :help "Search marked files for regexp"))
3e1fb00f 1497 (define-key map [menu-bar operate chown]
d066de8e
EZ
1498 '(menu-item "Change Owner..." dired-do-chown
1499 :visible (not (memq system-type '(ms-dos windows-nt)))
1500 :help "Change the owner of marked files"))
3e1fb00f 1501 (define-key map [menu-bar operate chgrp]
d066de8e
EZ
1502 '(menu-item "Change Group..." dired-do-chgrp
1503 :visible (not (memq system-type '(ms-dos windows-nt)))
1504 :help "Change the group of marked files"))
3e1fb00f 1505 (define-key map [menu-bar operate chmod]
d066de8e
EZ
1506 '(menu-item "Change Mode..." dired-do-chmod
1507 :help "Change mode (attributes) of marked files"))
57654b8c
JL
1508 (define-key map [menu-bar operate touch]
1509 '(menu-item "Change Timestamp..." dired-do-touch
1510 :help "Change timestamp of marked files"))
3e1fb00f 1511 (define-key map [menu-bar operate load]
d066de8e
EZ
1512 '(menu-item "Load" dired-do-load
1513 :help "Load marked Emacs Lisp files"))
3e1fb00f 1514 (define-key map [menu-bar operate compile]
d066de8e
EZ
1515 '(menu-item "Byte-compile" dired-do-byte-compile
1516 :help "Byte-compile marked Emacs Lisp files"))
3e1fb00f 1517 (define-key map [menu-bar operate compress]
d066de8e
EZ
1518 '(menu-item "Compress" dired-do-compress
1519 :help "Compress/uncompress marked files"))
3e1fb00f 1520 (define-key map [menu-bar operate print]
d066de8e
EZ
1521 '(menu-item "Print..." dired-do-print
1522 :help "Ask for print command and print marked files"))
3e1fb00f 1523 (define-key map [menu-bar operate hardlink]
d066de8e
EZ
1524 '(menu-item "Hardlink to..." dired-do-hardlink
1525 :help "Make hard links for current or marked files"))
3e1fb00f 1526 (define-key map [menu-bar operate symlink]
d066de8e
EZ
1527 '(menu-item "Symlink to..." dired-do-symlink
1528 :visible (fboundp 'make-symbolic-link)
1529 :help "Make symbolic links for current or marked files"))
3e1fb00f 1530 (define-key map [menu-bar operate command]
d066de8e
EZ
1531 '(menu-item "Shell Command..." dired-do-shell-command
1532 :help "Run a shell command on each of marked files"))
3e1fb00f 1533 (define-key map [menu-bar operate delete]
d066de8e
EZ
1534 '(menu-item "Delete" dired-do-delete
1535 :help "Delete current file or all marked files"))
3e1fb00f 1536 (define-key map [menu-bar operate rename]
d066de8e
EZ
1537 '(menu-item "Rename to..." dired-do-rename
1538 :help "Rename current file or move marked files"))
3e1fb00f 1539 (define-key map [menu-bar operate copy]
d066de8e
EZ
1540 '(menu-item "Copy to..." dired-do-copy
1541 :help "Copy current file or all marked files"))
3e1fb00f 1542
d7aed37c
SM
1543 map)
1544 "Local keymap for `dired-mode' buffers.")
83fadedf 1545\f
84fc2cfa
ER
1546;; Dired mode is suitable only for specially formatted data.
1547(put 'dired-mode 'mode-class 'special)
1548
a515788d
LH
1549;; Autoload cookie needed by desktop.el
1550;;;###autoload
492d2437
RS
1551(defun dired-mode (&optional dirname switches)
1552 "\
1553Mode for \"editing\" directory listings.
68d2f12f 1554In Dired, you are \"editing\" a list of the files in a directory and
492d2437
RS
1555 \(optionally) its subdirectories, in the format of `ls -lR'.
1556 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1557\"Editing\" means that you can run shell commands on files, visit,
1558 compress, load or byte-compile them, change their file attributes
1559 and insert subdirectories into the same buffer. You can \"mark\"
1560 files for later commands or \"flag\" them for deletion, either file
1561 by file or all files matching certain criteria.
1562You can move using the usual cursor motion commands.\\<dired-mode-map>
1563Letters no longer insert themselves. Digits are prefix arguments.
1564Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1565Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1566 Most commands operate on the marked files and use the current file
1567 if no files are marked. Use a numeric prefix argument to operate on
1568 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1569 to operate on the current file only. Prefix arguments override marks.
1570 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1571 to see why something went wrong.
1572Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1573Type \\[dired-unmark-backward] to back up one line and unflag.
1574Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1575Type \\[dired-advertised-find-file] to Find the current line's file
1576 (or dired it in another buffer, if it is a directory).
1577Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1578Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1579Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1580Type \\[dired-do-copy] to Copy files.
ee680b2b
JB
1581Type \\[dired-sort-toggle-or-edit] to toggle Sorting by name/date or change the `ls' switches.
1582Type \\[revert-buffer] to read all currently expanded directories aGain.
492d2437
RS
1583 This retains all marks and hides subdirs again that were hidden before.
1584SPC and DEL can be used to move down and up by lines.
1585
ee680b2b 1586If Dired ever gets confused, you can either type \\[revert-buffer] \
492d2437
RS
1587to read the
1588directories again, type \\[dired-do-redisplay] \
1589to relist a single or the marked files or a
1590subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1591again for the directory tree.
1592
1593Customization variables (rename this buffer and type \\[describe-variable] on each line
1594for more info):
1595
87ae59e3
SM
1596 `dired-listing-switches'
1597 `dired-trivial-filenames'
1598 `dired-shrink-to-fit'
1599 `dired-marker-char'
1600 `dired-del-marker'
1601 `dired-keep-marker-rename'
1602 `dired-keep-marker-copy'
1603 `dired-keep-marker-hardlink'
1604 `dired-keep-marker-symlink'
492d2437
RS
1605
1606Hooks (use \\[describe-variable] to see their documentation):
1607
87ae59e3
SM
1608 `dired-before-readin-hook'
1609 `dired-after-readin-hook'
1610 `dired-mode-hook'
1611 `dired-load-hook'
492d2437
RS
1612
1613Keybindings:
84fc2cfa 1614\\{dired-mode-map}"
492d2437
RS
1615 ;; Not to be called interactively (e.g. dired-directory will be set
1616 ;; to default-directory, which is wrong with wildcards).
84fc2cfa 1617 (kill-all-local-variables)
84fc2cfa 1618 (use-local-map dired-mode-map)
492d2437
RS
1619 (dired-advertise) ; default-directory is already set
1620 (setq major-mode 'dired-mode
1621 mode-name "Dired"
87ae59e3 1622 ;; case-fold-search nil
492d2437
RS
1623 buffer-read-only t
1624 selective-display t ; for subdirectory hiding
0acdf642
GM
1625 mode-line-buffer-identification
1626 (propertized-buffer-identification "%17b"))
492d2437
RS
1627 (set (make-local-variable 'revert-buffer-function)
1628 (function dired-revert))
573e4d2d
LT
1629 (set (make-local-variable 'buffer-stale-function)
1630 (function dired-buffer-stale-p))
492d2437
RS
1631 (set (make-local-variable 'page-delimiter)
1632 "\n\n")
1633 (set (make-local-variable 'dired-directory)
1634 (or dirname default-directory))
1635 ;; list-buffers uses this to display the dir being edited in this buffer.
1636 (set (make-local-variable 'list-buffers-directory)
86e6e4b3
RS
1637 (expand-file-name (if (listp dired-directory)
1638 (car dired-directory)
1639 dired-directory)))
492d2437
RS
1640 (set (make-local-variable 'dired-actual-switches)
1641 (or switches dired-listing-switches))
d7aed37c
SM
1642 (set (make-local-variable 'font-lock-defaults)
1643 '(dired-font-lock-keywords t nil nil beginning-of-line))
cb5f1f67 1644 (set (make-local-variable 'desktop-save-buffer)
31b4c848 1645 'dired-desktop-buffer-misc-data)
5553077c 1646 (setq dired-switches-alist nil)
492d2437 1647 (dired-sort-other dired-actual-switches t)
361eee8f 1648 (when (featurep 'dnd)
6ae53dc1
RS
1649 (set (make-local-variable 'dnd-protocol-alist)
1650 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1ed8284d 1651 (run-mode-hooks 'dired-mode-hook))
83fadedf 1652\f
eb8c3be9 1653;; Idiosyncratic dired commands that don't deal with marks.
84fc2cfa 1654
84fc2cfa 1655(defun dired-summary ()
ee680b2b 1656 "Summarize basic Dired commands and show recent dired errors."
84fc2cfa 1657 (interactive)
492d2437 1658 (dired-why)
84fc2cfa
ER
1659 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1660 (message
50f74744 1661 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
84fc2cfa 1662
492d2437
RS
1663(defun dired-undo ()
1664 "Undo in a dired buffer.
1665This doesn't recover lost files, it just undoes changes in the buffer itself.
487327a9 1666You can use it to recover marks, killed lines or subdirs."
492d2437
RS
1667 (interactive)
1668 (let (buffer-read-only)
487327a9
LT
1669 (undo))
1670 (dired-build-subdir-alist)
ee680b2b 1671 (message "Change in dired buffer undone.
487327a9 1672Actual changes in files cannot be undone by Emacs."))
84fc2cfa 1673
40aa8257
JL
1674(defun dired-toggle-read-only ()
1675 "Edit dired buffer with Wdired, or set it read-only.
1676Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1677supported by Wdired (the major mode of the dired buffer is `dired-mode').
1678Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1679 (interactive)
1680 (if (eq major-mode 'dired-mode)
1681 (wdired-change-to-wdired-mode)
1682 (toggle-read-only)))
1683
84fc2cfa
ER
1684(defun dired-next-line (arg)
1685 "Move down lines then position at filename.
1686Optional prefix ARG says how many lines to move; default is one line."
1687 (interactive "p")
e82a724f 1688 (forward-line arg)
84fc2cfa
ER
1689 (dired-move-to-filename))
1690
1691(defun dired-previous-line (arg)
1692 "Move up lines then position at filename.
1693Optional prefix ARG says how many lines to move; default is one line."
1694 (interactive "p")
e82a724f 1695 (forward-line (- arg))
84fc2cfa
ER
1696 (dired-move-to-filename))
1697
492d2437
RS
1698(defun dired-next-dirline (arg &optional opoint)
1699 "Goto ARG'th next directory file line."
1700 (interactive "p")
1701 (or opoint (setq opoint (point)))
1702 (if (if (> arg 0)
1703 (re-search-forward dired-re-dir nil t arg)
1704 (beginning-of-line)
1705 (re-search-backward dired-re-dir nil t (- arg)))
1706 (dired-move-to-filename) ; user may type `i' or `f'
1707 (goto-char opoint)
1708 (error "No more subdirectories")))
1709
1710(defun dired-prev-dirline (arg)
1711 "Goto ARG'th previous directory file line."
1712 (interactive "p")
1713 (dired-next-dirline (- arg)))
1714
ac1ce341 1715(defun dired-up-directory (&optional other-window)
68d2f12f 1716 "Run Dired on parent directory of current directory.
492d2437
RS
1717Find the parent directory either in this buffer or another buffer.
1718Creates a buffer if necessary."
ac1ce341 1719 (interactive "P")
492d2437
RS
1720 (let* ((dir (dired-current-directory))
1721 (up (file-name-directory (directory-file-name dir))))
1722 (or (dired-goto-file (directory-file-name dir))
7b2469ae
RS
1723 ;; Only try dired-goto-subdir if buffer has more than one dir.
1724 (and (cdr dired-subdir-alist)
492d2437
RS
1725 (dired-goto-subdir up))
1726 (progn
ac1ce341
EN
1727 (if other-window
1728 (dired-other-window up)
1729 (dired up))
492d2437 1730 (dired-goto-file dir)))))
84fc2cfa 1731
68d2f12f
RS
1732(defun dired-get-file-for-visit ()
1733 "Get the current line's file name, with an error if file does not exist."
53fd9d05 1734 (interactive)
e9407052
RS
1735 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1736 (let ((raw (dired-get-filename nil t))
1737 file-name)
1738 (if (null raw)
1739 (error "No file on this line"))
1740 (setq file-name (file-name-sans-versions raw t))
c439687b 1741 (if (file-exists-p file-name)
68d2f12f 1742 file-name
55642aa4
RS
1743 (if (file-symlink-p file-name)
1744 (error "File is a symlink to a nonexistent target")
ee680b2b 1745 (error "File no longer exists; type `g' to update dired buffer")))))
84fc2cfa 1746
68d2f12f
RS
1747;; Force `f' rather than `e' in the mode doc:
1748(defalias 'dired-advertised-find-file 'dired-find-file)
1749(defun dired-find-file ()
1750 "In Dired, visit the file or directory named on this line."
1751 (interactive)
1d5ad120 1752 ;; Bind `find-file-run-dired' so that the command works on directories
59d18288
RS
1753 ;; too, independent of the user's setting.
1754 (let ((find-file-run-dired t))
1755 (find-file (dired-get-file-for-visit))))
68d2f12f 1756
c5753a5d 1757(defun dired-find-alternate-file ()
68d2f12f 1758 "In Dired, visit this file or directory instead of the dired buffer."
c5753a5d
GM
1759 (interactive)
1760 (set-buffer-modified-p nil)
68d2f12f 1761 (find-alternate-file (dired-get-file-for-visit)))
336cd99d 1762;; Don't override the setting from .emacs.
c21993d0 1763;;;###autoload (put 'dired-find-alternate-file 'disabled t)
c5753a5d 1764
dbcb9389 1765(defun dired-mouse-find-file-other-window (event)
68d2f12f 1766 "In Dired, visit the file or directory name you click on."
dbcb9389 1767 (interactive "e")
2aaa7f0a 1768 (let (window pos file)
dbcb9389 1769 (save-excursion
2aaa7f0a
RS
1770 (setq window (posn-window (event-end event))
1771 pos (posn-point (event-end event)))
1772 (if (not (windowp window))
1773 (error "No file chosen"))
1774 (set-buffer (window-buffer window))
1775 (goto-char pos)
1776 (setq file (dired-get-file-for-visit)))
55a87770
RS
1777 (if (file-directory-p file)
1778 (or (and (cdr dired-subdir-alist)
1779 (dired-goto-subdir file))
1780 (progn
1781 (select-window window)
1782 (dired-other-window file)))
3f68d7c8
RS
1783 (select-window window)
1784 (find-file-other-window (file-name-sans-versions file t)))))
b70ebe37 1785
84fc2cfa 1786(defun dired-view-file ()
ee680b2b 1787 "In Dired, examine a file in view mode, returning to Dired when done.
b70ebe37 1788When file is a directory, show it in this buffer if it is inserted.
3f68d7c8 1789Otherwise, display it in another buffer."
84fc2cfa 1790 (interactive)
68d2f12f
RS
1791 (let ((file (dired-get-file-for-visit)))
1792 (if (file-directory-p file)
1793 (or (and (cdr dired-subdir-alist)
1794 (dired-goto-subdir file))
1795 (dired file))
3f68d7c8 1796 (view-file file))))
84fc2cfa
ER
1797
1798(defun dired-find-file-other-window ()
68d2f12f 1799 "In Dired, visit this file or directory in another window."
84fc2cfa 1800 (interactive)
68d2f12f 1801 (find-file-other-window (dired-get-file-for-visit)))
ab67260b
RS
1802
1803(defun dired-display-file ()
68d2f12f 1804 "In Dired, display this file or directory in another window."
ab67260b 1805 (interactive)
68d2f12f 1806 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
83fadedf 1807\f
68d2f12f 1808;;; Functions for extracting and manipulating file names in Dired buffers.
84fc2cfa
ER
1809
1810(defun dired-get-filename (&optional localp no-error-if-not-filep)
68d2f12f 1811 "In Dired, return name of file mentioned on this line.
84fc2cfa 1812Value returned normally includes the directory name.
492d2437 1813Optional arg LOCALP with value `no-dir' means don't include directory
147e214c
LT
1814name in result. A value of `verbatim' means to return the name exactly as
1815it occurs in the buffer, and a value of t means construct name relative to
1816`default-directory', which still may contain slashes if in a subdirectory.
1817Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1818regular filenames and return nil if no filename on this line.
1819Otherwise, an error occurs in these cases."
a5e0e1a8 1820 (let (case-fold-search file p1 p2 already-absolute)
84fc2cfa 1821 (save-excursion
492d2437
RS
1822 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1823 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1824 ;; nil if no file on this line, but no-error-if-not-filep is t:
9888aa65
RS
1825 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1826 (progn
1827 ;; Get rid of the mouse-face property that file names have.
1828 (set-text-properties 0 (length file) nil file)
1829 ;; Unquote names quoted by ls or by dired-insert-directory.
1830 ;; Using read to unquote is much faster than substituting
1831 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1832 (setq file
1833 (read
1834 (concat "\""
2b2059d8 1835 ;; Some ls -b don't escape quotes, argh!
9888aa65
RS
1836 ;; This is not needed for GNU ls, though.
1837 (or (dired-string-replace-match
bc07e5cb 1838 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
9888aa65 1839 file)
038b5501
KH
1840 "\"")))
1841 ;; The above `read' will return a unibyte string if FILE
1842 ;; contains eight-bit-control/graphic characters.
1843 (if (and enable-multibyte-characters
1844 (not (multibyte-string-p file)))
1845 (setq file (string-to-multibyte file)))))
f6e2cbe3 1846 (and file (file-name-absolute-p file)
7994d91a
RS
1847 ;; A relative file name can start with ~.
1848 ;; Don't treat it as absolute in this context.
1849 (not (eq (aref file 0) ?~))
a5e0e1a8 1850 (setq already-absolute t))
a5e0e1a8 1851 (cond
b95ddab3
RS
1852 ((null file)
1853 nil)
1d5ad120
JB
1854 ((eq localp 'verbatim)
1855 file)
e9407052 1856 ((and (not no-error-if-not-filep)
5709c1a0 1857 (member file '("." "..")))
e9407052 1858 (error "Cannot operate on `.' or `..'"))
a5e0e1a8
EZ
1859 ((and (eq localp 'no-dir) already-absolute)
1860 (file-name-nondirectory file))
b95ddab3 1861 (already-absolute
ca66efd1
RS
1862 (let ((handler (find-file-name-handler file nil)))
1863 ;; check for safe-magic property so that we won't
1864 ;; put /: for names that don't really need them.
0b7bc76f 1865 ;; For instance, .gz files when auto-compression-mode is on.
ca66efd1
RS
1866 (if (and handler (not (get handler 'safe-magic)))
1867 (concat "/:" file)
1868 file)))
b95ddab3 1869 ((eq localp 'no-dir)
a5e0e1a8 1870 file)
b95ddab3
RS
1871 ((equal (dired-current-directory) "/")
1872 (setq file (concat (dired-current-directory localp) file))
ca66efd1
RS
1873 (let ((handler (find-file-name-handler file nil)))
1874 ;; check for safe-magic property so that we won't
1875 ;; put /: for names that don't really need them.
1876 ;; For instance, .gz files when auto-compression-mode is on.
1877 (if (and handler (not (get handler 'safe-magic)))
1878 (concat "/:" file)
1879 file)))
a5e0e1a8 1880 (t
b95ddab3 1881 (concat (dired-current-directory localp) file)))))
492d2437 1882
437fe5ae 1883(defun dired-string-replace-match (regexp string newtext
1d5ad120 1884 &optional literal global)
437fe5ae
RS
1885 "Replace first match of REGEXP in STRING with NEWTEXT.
1886If it does not match, nil is returned instead of the new string.
1887Optional arg LITERAL means to take NEWTEXT literally.
1888Optional arg GLOBAL means to replace all matches."
1889 (if global
b976e099 1890 (let ((start 0) ret)
856321e2
RS
1891 (while (string-match regexp string start)
1892 (let ((from-end (- (length string) (match-end 0))))
b976e099 1893 (setq ret (setq string (replace-match newtext t literal string)))
856321e2 1894 (setq start (- (length string) from-end))))
b976e099 1895 ret)
437fe5ae
RS
1896 (if (not (string-match regexp string 0))
1897 nil
856321e2 1898 (replace-match newtext t literal string))))
437fe5ae 1899
492d2437 1900(defun dired-make-absolute (file &optional dir)
470fa6d1 1901 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
492d2437
RS
1902 ;; We can't always use expand-file-name as this would get rid of `.'
1903 ;; or expand in / instead default-directory if DIR=="".
1904 ;; This should be good enough for ange-ftp, but might easily be
1905 ;; redefined (for VMS?).
1906 ;; It should be reasonably fast, though, as it is called in
1907 ;; dired-get-filename.
1908 (concat (or dir default-directory) file))
1909
827dc60d
RS
1910(defun dired-make-relative (file &optional dir ignore)
1911 "Convert FILE (an absolute file name) to a name relative to DIR.
1912If this is impossible, return FILE unchanged.
1913DIR must be a directory name, not a file name."
492d2437 1914 (or dir (setq dir default-directory))
7425bbff
RS
1915 ;; This case comes into play if default-directory is set to
1916 ;; use ~.
1917 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1918 (setq dir (expand-file-name dir)))
492d2437
RS
1919 (if (string-match (concat "^" (regexp-quote dir)) file)
1920 (substring file (match-end 0))
7805cdbd 1921;;; (or no-error
827dc60d
RS
1922;;; (error "%s: not in directory tree growing at %s" file dir))
1923 file))
83fadedf 1924\f
492d2437
RS
1925;;; Functions for finding the file name in a dired buffer line.
1926
23e217f6
RS
1927(defvar dired-permission-flags-regexp
1928 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1929 "Regular expression to match the permission flags in `ls -l'.")
1930
492d2437
RS
1931;; Move to first char of filename on this line.
1932;; Returns position (point) or nil if no filename on this line."
1933(defun dired-move-to-filename (&optional raise-error eol)
a12c6dca
SM
1934 "Move to the beginning of the filename on the current line.
1935Return the position of the beginning of the filename, or nil if none found."
492d2437 1936 ;; This is the UNIX version.
2b2059d8 1937 (or eol (setq eol (line-end-position)))
492d2437 1938 (beginning-of-line)
0b7bc76f 1939 ;; First try assuming `ls --dired' was used.
2b2059d8
SM
1940 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1941 (cond
1942 ((and change (< change eol))
1943 (goto-char change))
9bc260cf 1944 ((re-search-forward directory-listing-before-filename-regexp eol t)
2b2059d8
SM
1945 (goto-char (match-end 0)))
1946 ((re-search-forward dired-permission-flags-regexp eol t)
1947 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1f3b4d04 1948 (if raise-error
9bc260cf 1949 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
1f3b4d04
SM
1950 (beginning-of-line)
1951 nil)
2b2059d8
SM
1952 (raise-error
1953 (error "No file on this line")))))
492d2437
RS
1954
1955(defun dired-move-to-end-of-filename (&optional no-error)
1956 ;; Assumes point is at beginning of filename,
1957 ;; thus the rwx bit re-search-backward below will succeed in *this*
1958 ;; line if at all. So, it should be called only after
1959 ;; (dired-move-to-filename t).
1960 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1961 ;; This is the UNIX version.
0b7bc76f
RS
1962 (if (get-text-property (point) 'dired-filename)
1963 (goto-char (next-single-property-change (point) 'dired-filename))
1964 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1965 ;; case-fold-search is nil now, so we can test for capital F:
1966 (setq used-F (string-match "F" dired-actual-switches)
1967 opoint (point)
1968 eol (save-excursion (end-of-line) (point))
1969 hidden (and selective-display
1970 (save-excursion (search-forward "\r" eol t))))
1971 (if hidden
1972 nil
1973 (save-excursion ;; Find out what kind of file this is:
1974 ;; Restrict perm bits to be non-blank,
1975 ;; otherwise this matches one char to early (looking backward):
1976 ;; "l---------" (some systems make symlinks that way)
1977 ;; "----------" (plain file with zero perms)
1978 (if (re-search-backward
1979 dired-permission-flags-regexp nil t)
1980 (setq file-type (char-after (match-beginning 1))
1981 symlink (eq file-type ?l)
1982 ;; Only with -F we need to know whether it's an executable
1983 executable (and
1984 used-F
1985 (string-match
1986 "[xst]" ;; execute bit set anywhere?
1987 (concat
ff3d76aa
SM
1988 (match-string 2)
1989 (match-string 3)
1990 (match-string 4)))))
0b7bc76f
RS
1991 (or no-error (error "No file on this line"))))
1992 ;; Move point to end of name:
1993 (if symlink
a12c6dca 1994 (if (search-forward " -> " eol t)
0b7bc76f 1995 (progn
a12c6dca 1996 (forward-char -4)
0b7bc76f
RS
1997 (and used-F
1998 dired-ls-F-marks-symlinks
1999 (eq (preceding-char) ?@) ;; did ls really mark the link?
2000 (forward-char -1))))
2001 (goto-char eol) ;; else not a symbolic link
dd52fff6
TTN
2002 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2003 ;; one trailing character. (Executable bits on symlinks ain't mean
0b7bc76f
RS
2004 ;; a thing, even to ls, but we know it's not a symlink.)
2005 (and used-F
dd52fff6 2006 (or (memq file-type '(?d ?s ?p))
0b7bc76f
RS
2007 executable)
2008 (forward-char -1))))
2009 (or no-error
2010 (not (eq opoint (point)))
8c16bd8c 2011 (error "%s" (if hidden
0b7bc76f
RS
2012 (substitute-command-keys
2013 "File line is hidden, type \\[dired-hide-subdir] to unhide")
2014 "No file on this line")))
2015 (if (eq opoint (point))
2016 nil
2017 (point)))))
492d2437 2018
83fadedf 2019\f
a3f4a3ef
RS
2020;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2021
2022(defun dired-copy-filename-as-kill (&optional arg)
2023 "Copy names of marked (or next ARG) files into the kill ring.
2024The names are separated by a space.
470fa6d1 2025With a zero prefix arg, use the absolute file name of each marked file.
ee680b2b 2026With \\[universal-argument], use the file name relative to the dired buffer's
afda9919 2027`default-directory'. (This still may contain slashes if in a subdirectory.)
a3f4a3ef 2028
afda9919
LT
2029If on a subdir headerline, use absolute subdirname instead;
2030prefix arg and marked files are ignored in this case.
a3f4a3ef
RS
2031
2032You can then feed the file name(s) to other commands with \\[yank]."
2033 (interactive "P")
2034 (let ((string
2035 (or (dired-get-subdir)
2036 (mapconcat (function identity)
2037 (if arg
2038 (cond ((zerop (prefix-numeric-value arg))
2039 (dired-get-marked-files))
afda9919
LT
2040 ((consp arg)
2041 (dired-get-marked-files t))
2042 (t
2043 (dired-get-marked-files
2044 'no-dir (prefix-numeric-value arg))))
a3f4a3ef
RS
2045 (dired-get-marked-files 'no-dir))
2046 " "))))
4de547e4
RS
2047 (if (eq last-command 'kill-region)
2048 (kill-append string nil)
2049 (kill-new string))
a3f4a3ef
RS
2050 (message "%s" string)))
2051
2052\f
492d2437
RS
2053;; Keeping Dired buffers in sync with the filesystem and with each other
2054
ef746164 2055(defun dired-buffers-for-dir (dir &optional file)
492d2437 2056;; Return a list of buffers that dired DIR (top level or in-situ subdir).
ef746164
RS
2057;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2058;; matches FILE.
492d2437
RS
2059;; The list is in reverse order of buffer creation, most recent last.
2060;; As a side effect, killed dired buffers for DIR are removed from
2061;; dired-buffers.
2062 (setq dir (file-name-as-directory dir))
a12c6dca 2063 (let ((alist dired-buffers) result elt buf)
492d2437 2064 (while alist
38819778
RS
2065 (setq elt (car alist)
2066 buf (cdr elt))
2067 (if (buffer-name buf)
2068 (if (dired-in-this-tree dir (car elt))
ef746164
RS
2069 (with-current-buffer buf
2070 (and (assoc dir dired-subdir-alist)
2071 (or (null file)
2072 (let ((wildcards
2073 (file-name-nondirectory dired-directory)))
2074 (or (= 0 (length wildcards))
2075 (string-match (dired-glob-regexp wildcards)
2076 file))))
2077 (setq result (cons buf result)))))
38819778
RS
2078 ;; else buffer is killed - clean up:
2079 (setq dired-buffers (delq elt dired-buffers)))
492d2437
RS
2080 (setq alist (cdr alist)))
2081 result))
2082
ef746164
RS
2083(defun dired-glob-regexp (pattern)
2084 "Convert glob-pattern PATTERN to a regular expression."
2085 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2086 regexp)
2087 (while (string-match "[[?*]" pattern matched-in-pattern)
2088 (let ((op-end (match-end 0))
2089 (next-op (aref pattern (match-beginning 0))))
2090 (setq regexp (concat regexp
2091 (regexp-quote
2092 (substring pattern matched-in-pattern
2093 (match-beginning 0)))))
2094 (cond ((= next-op ??)
2095 (setq regexp (concat regexp "."))
2096 (setq matched-in-pattern op-end))
2097 ((= next-op ?\[)
2098 ;; Fails to handle ^ yet ????
2099 (let* ((set-start (match-beginning 0))
2100 (set-cont
2101 (if (= (aref pattern (1+ set-start)) ?^)
2102 (+ 3 set-start)
2103 (+ 2 set-start)))
2104 (set-end (string-match "]" pattern set-cont))
2105 (set (substring pattern set-start (1+ set-end))))
2106 (setq regexp (concat regexp set))
2107 (setq matched-in-pattern (1+ set-end))))
2108 ((= next-op ?*)
2109 (setq regexp (concat regexp ".*"))
2110 (setq matched-in-pattern op-end)))))
2111 (concat "\\`"
2112 regexp
2113 (regexp-quote
2114 (substring pattern matched-in-pattern))
2115 "\\'")))
2116
c60ee5e7 2117
ef746164 2118
492d2437
RS
2119(defun dired-advertise ()
2120 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2121 ;; With wildcards we actually advertise too much.
38819778
RS
2122 (let ((expanded-default (expand-file-name default-directory)))
2123 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2124 t ; we have already advertised ourselves
2125 (setq dired-buffers
2126 (cons (cons expanded-default (current-buffer))
2127 dired-buffers)))))
492d2437
RS
2128
2129(defun dired-unadvertise (dir)
2130 ;; Remove DIR from the buffer alist in variable dired-buffers.
2131 ;; This has the effect of removing any buffer whose main directory is DIR.
2132 ;; It does not affect buffers in which DIR is a subdir.
2133 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2134 (setq dired-buffers
38819778 2135 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
83fadedf 2136\f
492d2437
RS
2137;; Tree Dired
2138
2139;;; utility functions
2140
2141(defun dired-in-this-tree (file dir)
2142 ;;"Is FILE part of the directory tree starting at DIR?"
2143 (let (case-fold-search)
38819778 2144 (string-match (concat "^" (regexp-quote dir)) file)))
492d2437
RS
2145
2146(defun dired-normalize-subdir (dir)
470fa6d1
KS
2147 ;; Prepend default-directory to DIR if relative file name.
2148 ;; dired-get-filename must be able to make a valid file name from a
492d2437
RS
2149 ;; file and its directory DIR.
2150 (file-name-as-directory
2151 (if (file-name-absolute-p dir)
2152 dir
2153 (expand-file-name dir default-directory))))
2154
2155(defun dired-get-subdir ()
2156 ;;"Return the subdir name on this line, or nil if not on a headerline."
2157 ;; Look up in the alist whether this is a headerline.
2158 (save-excursion
2159 (let ((cur-dir (dired-current-directory)))
2160 (beginning-of-line) ; alist stores b-o-l positions
2161 (and (zerop (- (point)
2162 (dired-get-subdir-min (assoc cur-dir
2163 dired-subdir-alist))))
2164 cur-dir))))
2165
2166;(defun dired-get-subdir-min (elt)
2167; (cdr elt))
2168;; can't use macro, must be redefinable for other alist format in dired-nstd.
62f61df0 2169(defalias 'dired-get-subdir-min 'cdr)
492d2437
RS
2170
2171(defun dired-get-subdir-max (elt)
84fc2cfa 2172 (save-excursion
492d2437
RS
2173 (goto-char (dired-get-subdir-min elt))
2174 (dired-subdir-max)))
2175
2176(defun dired-clear-alist ()
2177 (while dired-subdir-alist
2178 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2179 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2180
c9d59fc2
RS
2181(defun dired-subdir-index (dir)
2182 ;; Return an index into alist for use with nth
2183 ;; for the sake of subdir moving commands.
2184 (let (found (index 0) (alist dired-subdir-alist))
2185 (while alist
2186 (if (string= dir (car (car alist)))
2187 (setq alist nil found t)
2188 (setq alist (cdr alist) index (1+ index))))
2189 (if found index nil)))
2190
2191(defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2192 "Go to next subdirectory, regardless of level."
2193 ;; Use 0 arg to go to this directory's header line.
2194 ;; NO-SKIP prevents moving to end of header line, returning whatever
2195 ;; position was found in dired-subdir-alist.
2196 (interactive "p")
2197 (let ((this-dir (dired-current-directory))
2198 pos index)
2199 ;; nth with negative arg does not return nil but the first element
2200 (setq index (- (dired-subdir-index this-dir) arg))
2201 (setq pos (if (>= index 0)
2202 (dired-get-subdir-min (nth index dired-subdir-alist))))
2203 (if pos
2204 (progn
2205 (goto-char pos)
2206 (or no-skip (skip-chars-forward "^\n\r"))
2207 (point))
2208 (if no-error-if-not-found
2209 nil ; return nil if not found
2210 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2211
3c13627a 2212(defun dired-build-subdir-alist (&optional switches)
492d2437 2213 "Build `dired-subdir-alist' by parsing the buffer.
3c13627a
EZ
2214Returns the new value of the alist.
2215If optional arg SWITCHES is non-nil, use its value
2216instead of `dired-actual-switches'."
492d2437
RS
2217 (interactive)
2218 (dired-clear-alist)
2219 (save-excursion
3c13627a
EZ
2220 (let* ((count 0)
2221 (buffer-read-only nil)
784a48b2 2222 (buffer-undo-list t)
3c13627a
EZ
2223 (switches (or switches dired-actual-switches))
2224 new-dir-name
2225 (R-ftp-base-dir-regex
2226 ;; Used to expand subdirectory names correctly in recursive
2227 ;; ange-ftp listings.
2228 (and (string-match "R" switches)
2229 (string-match "\\`/.*:\\(/.*\\)" default-directory)
2230 (concat "\\`" (match-string 1 default-directory)))))
84fc2cfa 2231 (goto-char (point-min))
492d2437 2232 (setq dired-subdir-alist nil)
a3d76960
RS
2233 (while (re-search-forward dired-subdir-regexp nil t)
2234 ;; Avoid taking a file name ending in a colon
2235 ;; as a subdir name.
2236 (unless (save-excursion
2237 (goto-char (match-beginning 0))
2238 (beginning-of-line)
2239 (forward-char 2)
2240 (save-match-data (looking-at dired-re-perms)))
2241 (save-excursion
2242 (goto-char (match-beginning 1))
2243 (setq new-dir-name
2244 (buffer-substring-no-properties (point) (match-end 1))
2245 new-dir-name
2246 (save-match-data
2247 (if (and R-ftp-base-dir-regex
2248 (not (string= new-dir-name default-directory))
2249 (string-match R-ftp-base-dir-regex new-dir-name))
2250 (concat default-directory
2251 (substring new-dir-name (match-end 0)))
2252 (expand-file-name new-dir-name))))
2253 (delete-region (point) (match-end 1))
7de3f9a4
RS
2254 (insert new-dir-name))
2255 (setq count (1+ count))
2256 (dired-alist-add-1 new-dir-name
2257 ;; Place a sub directory boundary between lines.
2258 (save-excursion
2259 (goto-char (match-beginning 0))
2260 (beginning-of-line)
2261 (point-marker)))))
5553077c 2262 (if (and (> count 1) (interactive-p))
a3d76960
RS
2263 (message "Buffer includes %d directories" count)))
2264 ;; We don't need to sort it because it is in buffer order per
2265 ;; constructionem. Return new alist:
2266 dired-subdir-alist))
492d2437
RS
2267
2268(defun dired-alist-add-1 (dir new-marker)
2269 ;; Add new DIR at NEW-MARKER. Don't sort.
2270 (setq dired-subdir-alist
2271 (cons (cons (dired-normalize-subdir dir) new-marker)
2272 dired-subdir-alist)))
2273
2274(defun dired-goto-next-nontrivial-file ()
2275 ;; Position point on first nontrivial file after point.
2276 (dired-goto-next-file);; so there is a file to compare with
2277 (if (stringp dired-trivial-filenames)
2278 (while (and (not (eobp))
2279 (string-match dired-trivial-filenames
2280 (file-name-nondirectory
2281 (or (dired-get-filename nil t) ""))))
2282 (forward-line 1)
2283 (dired-move-to-filename))))
2284
2285(defun dired-goto-next-file ()
2286 (let ((max (1- (dired-subdir-max))))
2287 (while (and (not (dired-move-to-filename)) (< (point) max))
2288 (forward-line 1))))
2289
2290(defun dired-goto-file (file)
e19d2d64 2291 "Go to line describing file FILE in this dired buffer."
492d2437 2292 ;; Return value of point on success, else nil.
470fa6d1 2293 ;; FILE must be an absolute file name.
492d2437
RS
2294 ;; Loses if FILE contains control chars like "\007" for which ls
2295 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2296 ;; it in the buffer.
2297 (interactive
2298 (prog1 ; let push-mark display its message
2299 (list (expand-file-name
2300 (read-file-name "Goto file: "
2301 (dired-current-directory))))
2302 (push-mark)))
2303 (setq file (directory-file-name file)) ; does no harm if no directory
2304 (let (found case-fold-search dir)
2305 (setq dir (or (file-name-directory file)
f808da9e 2306 (error "File name `%s' is not absolute" file)))
492d2437
RS
2307 (save-excursion
2308 ;; The hair here is to get the result of dired-goto-subdir
2309 ;; without really calling it if we don't have any subdirs.
233993a3 2310 (if (if (string= dir (expand-file-name default-directory))
492d2437 2311 (goto-char (point-min))
7b2469ae 2312 (and (cdr dired-subdir-alist)
492d2437
RS
2313 (dired-goto-subdir dir)))
2314 (let ((base (file-name-nondirectory file))
f808da9e 2315 search-string
492d2437 2316 (boundary (dired-subdir-max)))
f808da9e
RS
2317 (setq search-string
2318 (replace-regexp-in-string "\^m" "\\^m" base nil t))
2319 (setq search-string
2320 (replace-regexp-in-string "\\\\" "\\\\" search-string nil t))
492d2437
RS
2321 (while (and (not found)
2322 ;; filenames are preceded by SPC, this makes
2323 ;; the search faster (e.g. for the filename "-"!).
f808da9e
RS
2324 (search-forward (concat " " search-string)
2325 boundary 'move))
492d2437
RS
2326 ;; Match could have BASE just as initial substring or
2327 ;; or in permission bits or date or
2328 ;; not be a proper filename at all:
2329 (if (equal base (dired-get-filename 'no-dir t))
2330 ;; Must move to filename since an (actually
2331 ;; correct) match could have been elsewhere on the
2332 ;; ;; line (e.g. "-" would match somewhere in the
2333 ;; permission bits).
55e86af6
RS
2334 (setq found (dired-move-to-filename))
2335 ;; If this isn't the right line, move forward to avoid
2336 ;; trying this line again.
2337 (forward-line 1))))))
492d2437
RS
2338 (and found
2339 ;; return value of point (i.e., FOUND):
2340 (goto-char found))))
2341
2342(defun dired-initial-position (dirname)
2343 ;; Where point should go in a new listing of DIRNAME.
2344 ;; Point assumed at beginning of new subdir line.
2345 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2346 (end-of-line)
2347 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
83fadedf 2348\f
492d2437
RS
2349;; These are hooks which make tree dired work.
2350;; They are in this file because other parts of dired need to call them.
2351;; But they don't call the rest of tree dired unless there are subdirs loaded.
2352
2353;; This function is called for each retrieved filename.
2354;; It could stand to be faster, though it's mostly function call
2355;; overhead. Avoiding the function call seems to save about 10% in
2356;; dired-get-filename. Make it a defsubst?
2357(defun dired-current-directory (&optional localp)
2358 "Return the name of the subdirectory to which this line belongs.
2359This returns a string with trailing slash, like `default-directory'.
2360Optional argument means return a file name relative to `default-directory'."
2361 (let ((here (point))
2362 (alist (or dired-subdir-alist
2363 ;; probably because called in a non-dired buffer
2364 (error "No subdir-alist in %s" (current-buffer))))
2365 elt dir)
2366 (while alist
2367 (setq elt (car alist)
2368 dir (car elt)
2369 ;; use `<=' (not `<') as subdir line is part of subdir
2370 alist (if (<= (dired-get-subdir-min elt) here)
2371 nil ; found
2372 (cdr alist))))
2373 (if localp
2374 (dired-make-relative dir default-directory)
2375 dir)))
2376
2377;; Subdirs start at the beginning of their header lines and end just
2378;; before the beginning of the next header line (or end of buffer).
2379
2380(defun dired-subdir-max ()
2381 (save-excursion
7b2469ae 2382 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
492d2437
RS
2383 (point-max)
2384 (point))))
83fadedf 2385\f
492d2437
RS
2386;; Deleting files
2387
40aa8257 2388(defcustom dired-recursive-deletes 'top
f0628026 2389 "*Decide whether recursive deletes are allowed.
098bab71 2390A value of nil means no recursive deletes.
f0628026
RS
2391`always' means delete recursively without asking. This is DANGEROUS!
2392`top' means ask for each directory at top level, but delete its subdirectories
2393without asking.
2394Anything else means ask for each directory."
53ade5c7
RS
2395 :type '(choice :tag "Delete non-empty directories"
2396 (const :tag "Yes" always)
2397 (const :tag "No--only delete empty directories" nil)
2398 (const :tag "Confirm for each directory" t)
2399 (const :tag "Confirm for each top directory only" top))
f0628026
RS
2400 :group 'dired)
2401
c60ee5e7 2402;; Match anything but `.' and `..'.
f0628026
RS
2403(defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2404
2405;; Delete file, possibly delete a directory and all its files.
2406;; This function is usefull outside of dired. One could change it's name
2407;; to e.g. recursive-delete-file and put it somewhere else.
2408(defun dired-delete-file (file &optional recursive) "\
2409Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2410RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
ee680b2b 2411nil, do not delete.
f0628026
RS
2412`always', delete recursively without asking.
2413`top', ask for each directory at top level.
2414Anything else, ask for each sub-directory."
2415 (let (files)
2416 ;; This test is equivalent to
2417 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2418 ;; but more efficient
2419 (if (not (eq t (car (file-attributes file))))
2420 (delete-file file)
2421 (when (and recursive
2422 (setq files
2423 (directory-files file t dired-re-no-dot)) ; Not empty.
2424 (or (eq recursive 'always)
ce5a3ac0 2425 (yes-or-no-p (format "Recursive delete of %s? "
f0628026
RS
2426 (dired-make-relative file)))))
2427 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2428 (while files ; Recursively delete (possibly asking).
2429 (dired-delete-file (car files) recursive)
2430 (setq files (cdr files))))
2431 (delete-directory file))))
2432
7da0e9b4 2433(defun dired-do-flagged-delete (&optional nomessage)
68d2f12f 2434 "In Dired, delete the files flagged for deletion.
7da0e9b4 2435If NOMESSAGE is non-nil, we don't display any message
bce1acc3 2436if there are no flagged files.
40aa8257
JL
2437`dired-recursive-deletes' controls whether deletion of
2438non-empty directories is allowed."
492d2437
RS
2439 (interactive)
2440 (let* ((dired-marker-char dired-del-marker)
2441 (regexp (dired-marker-regexp))
2442 case-fold-search)
2443 (if (save-excursion (goto-char (point-min))
2444 (re-search-forward regexp nil t))
2445 (dired-internal-do-deletions
2446 ;; this can't move point since ARG is nil
2447 (dired-map-over-marks (cons (dired-get-filename) (point))
2448 nil)
2449 nil)
7da0e9b4
RS
2450 (or nomessage
2451 (message "(No deletions requested)")))))
492d2437
RS
2452
2453(defun dired-do-delete (&optional arg)
bce1acc3 2454 "Delete all marked (or next ARG) files.
40aa8257
JL
2455`dired-recursive-deletes' controls whether deletion of
2456non-empty directories is allowed."
492d2437
RS
2457 ;; This is more consistent with the file marking feature than
2458 ;; dired-do-flagged-delete.
2459 (interactive "P")
2460 (dired-internal-do-deletions
2461 ;; this may move point if ARG is an integer
2462 (dired-map-over-marks (cons (dired-get-filename) (point))
2463 arg)
2464 arg))
2465
2466(defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2467
2468(defun dired-internal-do-deletions (l arg)
2469 ;; L is an alist of files to delete, with their buffer positions.
2470 ;; ARG is the prefix arg.
2471 ;; Filenames are absolute (VMS needs this for logical search paths).
2472 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2473 ;; That way as changes are made in the buffer they do not shift the
2474 ;; lines still to be changed, so the (point) values in L stay valid.
2475 ;; Also, for subdirs in natural order, a subdir's files are deleted
2476 ;; before the subdir itself - the other way around would not work.
2477 (let ((files (mapcar (function car) l))
2478 (count (length l))
2479 (succ 0))
2480 ;; canonicalize file list for pop up
2481 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2482 (if (dired-mark-pop-up
2483 " *Deletions*" 'delete files dired-deletion-confirmer
2484 (format "Delete %s " (dired-mark-prompt arg files)))
84fc2cfa 2485 (save-excursion
492d2437
RS
2486 (let (failures);; files better be in reverse order for this loop!
2487 (while l
2488 (goto-char (cdr (car l)))
2489 (let (buffer-read-only)
2490 (condition-case err
2491 (let ((fn (car (car l))))
f0628026 2492 (dired-delete-file fn dired-recursive-deletes)
492d2437
RS
2493 ;; if we get here, removing worked
2494 (setq succ (1+ succ))
2495 (message "%s of %s deletions" succ count)
bf989169
RS
2496 (dired-fun-in-all-buffers
2497 (file-name-directory fn) (file-name-nondirectory fn)
2498 (function dired-delete-entry) fn))
492d2437
RS
2499 (error;; catch errors from failed deletions
2500 (dired-log "%s\n" err)
2501 (setq failures (cons (car (car l)) failures)))))
2502 (setq l (cdr l)))
2503 (if (not failures)
2504 (message "%d deletion%s done" count (dired-plural-s count))
2505 (dired-log-summary
2506 (format "%d of %d deletion%s failed"
2507 (length failures) count
2508 (dired-plural-s count))
2509 failures))))
2510 (message "(No deletions performed)")))
2511 (dired-move-to-filename))
2512
bf989169
RS
2513(defun dired-fun-in-all-buffers (directory file fun &rest args)
2514 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2515 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2516 ;; (FILE does not include a directory component.)
2517 ;; FILE may be nil, in which case ignore it.
2518 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2519 (let (success-list)
2520 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2521 file))
2522 (with-current-buffer buf
2523 (if (apply fun args)
2524 (setq success-list (cons (buffer-name buf) success-list)))))
2525 success-list))
2526
c60ee5e7 2527;; Delete the entry for FILE from
bf989169
RS
2528(defun dired-delete-entry (file)
2529 (save-excursion
2530 (and (dired-goto-file file)
2531 (let (buffer-read-only)
2532 (delete-region (progn (beginning-of-line) (point))
2533 (save-excursion (forward-line 1) (point))))))
2534 (dired-clean-up-after-deletion file))
2535
492d2437
RS
2536;; This is a separate function for the sake of dired-x.el.
2537(defun dired-clean-up-after-deletion (fn)
2538 ;; Clean up after a deleted file or directory FN.
7b2469ae
RS
2539 (save-excursion (and (cdr dired-subdir-alist)
2540 (dired-goto-subdir fn)
492d2437 2541 (dired-kill-subdir))))
83fadedf 2542\f
492d2437
RS
2543;; Confirmation
2544
2545(defun dired-marker-regexp ()
2546 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2547
2548(defun dired-plural-s (count)
2549 (if (= 1 count) "" "s"))
2550
2551(defun dired-mark-prompt (arg files)
bb5527ce
SM
2552 "Return a string for use in a prompt, either the current file
2553name, or the marker and a count of marked files."
2554 ;; distinguish-one-marked can cause the first element to be just t.
2555 (if (eq (car files) t) (setq files (cdr files)))
492d2437
RS
2556 (let ((count (length files)))
2557 (if (= count 1)
2558 (car files)
2559 ;; more than 1 file:
2560 (if (integerp arg)
2561 ;; abs(arg) = count
2562 ;; Perhaps this is nicer, but it also takes more screen space:
2563 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2564 ;; count)
2565 (format "[next %d files]" arg)
2566 (format "%c [%d files]" dired-marker-char count)))))
2567
2568(defun dired-pop-to-buffer (buf)
2569 ;; Pop up buffer BUF.
2570 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2571 (if (not dired-shrink-to-fit)
2572 (pop-to-buffer (get-buffer-create buf))
2573 ;; let window shrink to fit:
2574 (let ((window (selected-window))
2575 target-lines w2)
54f03575 2576 (cond ;; if split-height-threshold is enabled, use the largest window
492d2437
RS
2577 ((and (> (window-height (setq w2 (get-largest-window)))
2578 split-height-threshold)
70ad3da9 2579 (window-full-width-p w2))
492d2437
RS
2580 (setq window w2))
2581 ;; if the least-recently-used window is big enough, use it
2582 ((and (> (window-height (setq w2 (get-lru-window)))
2583 (* 2 window-min-height))
70ad3da9 2584 (window-full-width-p w2))
492d2437
RS
2585 (setq window w2)))
2586 (save-excursion
2587 (set-buffer buf)
2588 (goto-char (point-max))
2589 (skip-chars-backward "\n\r\t ")
63ea14a5
RS
2590 (setq target-lines (count-lines (point-min) (point)))
2591 ;; Don't forget to count the last line.
2592 (if (not (bolp))
2593 (setq target-lines (1+ target-lines))))
492d2437 2594 (if (<= (window-height window) (* 2 window-min-height))
f98955ea 2595 ;; At this point, every window on the frame is too small to split.
492d2437
RS
2596 (setq w2 (display-buffer buf))
2597 (setq w2 (split-window window
2598 (max window-min-height
2599 (- (window-height window)
2600 (1+ (max window-min-height target-lines)))))))
2601 (set-window-buffer w2 buf)
2602 (if (< (1- (window-height w2)) target-lines)
2603 (progn
2604 (select-window w2)
2605 (enlarge-window (- target-lines (1- (window-height w2))))))
2606 (set-window-start w2 1)
2607 )))
2608
5afea280 2609(defcustom dired-no-confirm nil
ee680b2b 2610 "A list of symbols for commands Dired should not confirm.
0347d069 2611Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
57654b8c 2612`copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
5afea280
RS
2613`touch' and `uncompress'."
2614 :group 'dired
75461997
LT
2615 :type '(set (const byte-compile) (const chgrp)
2616 (const chmod) (const chown) (const compress)
2617 (const copy) (const delete) (const hardlink)
2618 (const load) (const move) (const print)
2619 (const shell) (const symlink) (const touch)
2620 (const uncompress)))
492d2437
RS
2621
2622(defun dired-mark-pop-up (bufname op-symbol files function &rest args)
8421685f
RS
2623 "Return FUNCTION's result on ARGS after showing which files are marked.
2624Displays the file names in a buffer named BUFNAME;
2625 nil gives \" *Marked Files*\".
2626This uses function `dired-pop-to-buffer' to do that.
2627
2628FUNCTION should not manipulate files, just read input
2629 (an argument or confirmation).
89101e46
SM
2630The window is not shown if there is just one file or
2631 OP-SYMBOL is a member of the list in `dired-no-confirm'.
09b092ad
RS
2632FILES is the list of marked files. It can also be (t FILENAME)
2633in the case of one marked file, to distinguish that from using
2634just the current file."
492d2437 2635 (or bufname (setq bufname " *Marked Files*"))
0347d069
SM
2636 (if (or (eq dired-no-confirm t)
2637 (memq op-symbol dired-no-confirm)
09b092ad 2638 ;; If FILES defaulted to the current line's file.
492d2437
RS
2639 (= (length files) 1))
2640 (apply function args)
89101e46 2641 (with-current-buffer (get-buffer-create bufname)
492d2437 2642 (erase-buffer)
09b092ad
RS
2643 ;; Handle (t FILE) just like (FILE), here.
2644 ;; That value is used (only in some cases), to mean
2645 ;; just one file that was marked, rather than the current line file.
2646 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
1a0b9ae6
EZ
2647 (remove-text-properties (point-min) (point-max)
2648 '(mouse-face nil help-echo nil)))
492d2437
RS
2649 (save-window-excursion
2650 (dired-pop-to-buffer bufname)
2651 (apply function args))))
2652
2653(defun dired-format-columns-of-files (files)
2654 ;; Files should be in forward order for this loop.
2655 ;; i.e., (car files) = first file in buffer.
2656 ;; Returns the number of lines used.
2657 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2658 (width (- (window-width (selected-window)) 2))
2659 (columns (max 1 (/ width maxlen)))
2660 (nfiles (length files))
2661 (rows (+ (/ nfiles columns)
2662 (if (zerop (% nfiles columns)) 0 1)))
2663 (i 0)
2664 (j 0))
2665 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2666 (make-list (- (* columns rows) nfiles) "")))
2667 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2668 (while (< j rows)
2669 (while (< i columns)
2670 (indent-to (* i maxlen))
2671 (insert (car files))
2672 (setq files (nthcdr rows files)
2673 i (1+ i)))
2674 (insert "\n")
2675 (setq i 0
2676 j (1+ j)
2677 files (cdr files)))
2678 rows))
83fadedf 2679\f
492d2437
RS
2680;; Commands to mark or flag file(s) at or near current line.
2681
2682(defun dired-repeat-over-lines (arg function)
2683 ;; This version skips non-file lines.
cfe89c4f 2684 (let ((pos (make-marker)))
492d2437 2685 (beginning-of-line)
cfe89c4f
RS
2686 (while (and (> arg 0) (not (eobp)))
2687 (setq arg (1- arg))
2688 (beginning-of-line)
2689 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2690 (save-excursion
2691 (forward-line 1)
2692 (move-marker pos (1+ (point))))
2693 (save-excursion (funcall function))
2694 ;; Advance to the next line--actually, to the line that *was* next.
2695 ;; (If FUNCTION inserted some new lines in between, skip them.)
2696 (goto-char pos))
2697 (while (and (< arg 0) (not (bobp)))
2698 (setq arg (1+ arg))
2699 (forward-line -1)
2700 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2701 (beginning-of-line)
2702 (save-excursion (funcall function)))
2703 (move-marker pos nil)
2704 (dired-move-to-filename)))
492d2437
RS
2705
2706(defun dired-between-files ()
8a372755
MB
2707 ;; This used to be a regexp match of the `total ...' line output by
2708 ;; ls, which is slightly faster, but that is not very robust; notably,
2709 ;; it fails for non-english locales.
2710 (save-excursion (not (dired-move-to-filename))))
492d2437
RS
2711
2712(defun dired-next-marked-file (arg &optional wrap opoint)
2713 "Move to the next marked file, wrapping around the end of the buffer."
2714 (interactive "p\np")
2715 (or opoint (setq opoint (point)));; return to where interactively started
2716 (if (if (> arg 0)
2717 (re-search-forward dired-re-mark nil t arg)
2718 (beginning-of-line)
2719 (re-search-backward dired-re-mark nil t (- arg)))
2720 (dired-move-to-filename)
2721 (if (null wrap)
2722 (progn
2723 (goto-char opoint)
2724 (error "No next marked file"))
2725 (message "(Wraparound for next marked file)")
2726 (goto-char (if (> arg 0) (point-min) (point-max)))
2727 (dired-next-marked-file arg nil opoint))))
2728
2729(defun dired-prev-marked-file (arg &optional wrap)
2730 "Move to the previous marked file, wrapping around the end of the buffer."
2731 (interactive "p\np")
2732 (dired-next-marked-file (- arg) wrap))
2733
2734(defun dired-file-marker (file)
2735 ;; Return FILE's marker, or nil if unmarked.
2736 (save-excursion
2737 (and (dired-goto-file file)
2738 (progn
2739 (beginning-of-line)
2740 (if (not (equal ?\040 (following-char)))
2741 (following-char))))))
2742
2743(defun dired-mark-files-in-region (start end)
2744 (let (buffer-read-only)
2745 (if (> start end)
2746 (error "start > end"))
2747 (goto-char start) ; assumed at beginning of line
2748 (while (< (point) end)
2749 ;; Skip subdir line and following garbage like the `total' line:
2750 (while (and (< (point) end) (dired-between-files))
2751 (forward-line 1))
2752 (if (and (not (looking-at dired-re-dot))
2753 (dired-get-filename nil t))
2754 (progn
2755 (delete-char 1)
2756 (insert dired-marker-char)))
2757 (forward-line 1))))
2758
2759(defun dired-mark (arg)
2760 "Mark the current (or next ARG) files.
2761If on a subdir headerline, mark all its files except `.' and `..'.
2762
2763Use \\[dired-unmark-all-files] to remove all marks
2764and \\[dired-unmark] on a subdir to remove the marks in
2765this subdir."
2766 (interactive "P")
277568f2 2767 (if (dired-get-subdir)
492d2437
RS
2768 (save-excursion (dired-mark-subdir-files))
2769 (let (buffer-read-only)
2770 (dired-repeat-over-lines
52041219 2771 (prefix-numeric-value arg)
492d2437
RS
2772 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2773
2774(defun dired-unmark (arg)
2775 "Unmark the current (or next ARG) files.
2776If looking at a subdir, unmark all its files except `.' and `..'."
2777 (interactive "P")
2778 (let ((dired-marker-char ?\040))
2779 (dired-mark arg)))
2780
2781(defun dired-flag-file-deletion (arg)
68d2f12f 2782 "In Dired, flag the current line's file for deletion.
492d2437
RS
2783With prefix arg, repeat over several lines.
2784
2785If on a subdir headerline, mark all its files except `.' and `..'."
2786 (interactive "P")
2787 (let ((dired-marker-char dired-del-marker))
2788 (dired-mark arg)))
2789
2790(defun dired-unmark-backward (arg)
68d2f12f 2791 "In Dired, move up lines and remove deletion flag there.
492d2437
RS
2792Optional prefix ARG says how many lines to unflag; default is one line."
2793 (interactive "p")
2794 (dired-unmark (- arg)))
e5f0841e 2795
d588eb90
RS
2796(defun dired-toggle-marks ()
2797 "Toggle marks: marked files become unmarked, and vice versa.
e5f0841e
KH
2798Files marked with other flags (such as `D') are not affected.
2799`.' and `..' are never toggled.
2800As always, hidden subdirs are not affected."
2801 (interactive)
2802 (save-excursion
2803 (goto-char (point-min))
2804 (let (buffer-read-only)
2805 (while (not (eobp))
2806 (or (dired-between-files)
2807 (looking-at dired-re-dot)
2808 ;; use subst instead of insdel because it does not move
2809 ;; the gap and thus should be faster and because
2810 ;; other characters are left alone automatically
2811 (apply 'subst-char-in-region
2812 (point) (1+ (point))
2813 (if (eq ?\040 (following-char)) ; SPC
2814 (list ?\040 dired-marker-char)
2815 (list dired-marker-char ?\040))))
2816 (forward-line 1)))))
83fadedf 2817\f
492d2437
RS
2818;;; Commands to mark or flag files based on their characteristics or names.
2819
d2cadc4b
RS
2820(defvar dired-regexp-history nil
2821 "History list of regular expressions used in Dired commands.")
2822
2823(defun dired-read-regexp (prompt)
2824 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
492d2437
RS
2825
2826(defun dired-mark-files-regexp (regexp &optional marker-char)
2827 "Mark all files matching REGEXP for use in later commands.
2828A prefix argument means to unmark them instead.
2829`.' and `..' are never marked.
2830
2831REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2832object files--just `.o' will mark more than you might think."
2833 (interactive
2834 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2835 " files (regexp): "))
2836 (if current-prefix-arg ?\040)))
2837 (let ((dired-marker-char (or marker-char dired-marker-char)))
2838 (dired-mark-if
2839 (and (not (looking-at dired-re-dot))
2840 (not (eolp)) ; empty line
2841 (let ((fn (dired-get-filename nil t)))
2842 (and fn (string-match regexp (file-name-nondirectory fn)))))
2843 "matching file")))
2844
e9b8e22d
RS
2845(defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2846 "Mark all files with contents containing REGEXP for use in later commands.
2847A prefix argument means to unmark them instead.
2848`.' and `..' are never marked."
2849 (interactive
2850 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2851 " files containing (regexp): "))
2852 (if current-prefix-arg ?\040)))
2853 (let ((dired-marker-char (or marker-char dired-marker-char)))
2854 (dired-mark-if
2855 (and (not (looking-at dired-re-dot))
2856 (not (eolp)) ; empty line
2857 (let ((fn (dired-get-filename nil t)))
05a40373
KH
2858 (when (and fn (file-readable-p fn)
2859 (not (file-directory-p fn)))
2860 (let ((prebuf (get-file-buffer fn)))
2861 (message "Checking %s" fn)
2862 ;; For now we do it inside emacs
2863 ;; Grep might be better if there are a lot of files
2864 (if prebuf
2865 (with-current-buffer prebuf
2866 (save-excursion
2867 (goto-char (point-min))
2868 (re-search-forward regexp nil t)))
2869 (with-temp-buffer
2870 (insert-file-contents fn)
2871 (goto-char (point-min))
2872 (re-search-forward regexp nil t))))
0b2bb4d0 2873 )))
e9b8e22d
RS
2874 "matching file")))
2875
492d2437 2876(defun dired-flag-files-regexp (regexp)
68d2f12f 2877 "In Dired, flag all files containing the specified REGEXP for deletion.
492d2437
RS
2878The match is against the non-directory part of the filename. Use `^'
2879 and `$' to anchor matches. Exclude subdirs by hiding them.
2880`.' and `..' are never flagged."
2881 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2882 (dired-mark-files-regexp regexp dired-del-marker))
2883
2884(defun dired-mark-symlinks (unflag-p)
2885 "Mark all symbolic links.
2886With prefix argument, unflag all those files."
2887 (interactive "P")
2888 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2889 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2890
2891(defun dired-mark-directories (unflag-p)
2892 "Mark all directory file lines except `.' and `..'.
2893With prefix argument, unflag all those files."
2894 (interactive "P")
2895 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2896 (dired-mark-if (and (looking-at dired-re-dir)
2897 (not (looking-at dired-re-dot)))
2898 "directory file")))
2899
2900(defun dired-mark-executables (unflag-p)
2901 "Mark all executable files.
2902With prefix argument, unflag all those files."
2903 (interactive "P")
2904 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2905 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2906
2907;; dired-x.el has a dired-mark-sexp interactive command: mark
2908;; files for which PREDICATE returns non-nil.
2909
2910(defun dired-flag-auto-save-files (&optional unflag-p)
84fc2cfa
ER
2911 "Flag for deletion files whose names suggest they are auto save files.
2912A prefix argument says to unflag those files instead."
2913 (interactive "P")
492d2437
RS
2914 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2915 (dired-mark-if
2a838614 2916 ;; It is less than general to check for # here,
a91526b9
RS
2917 ;; but it's the only way this runs fast enough.
2918 (and (save-excursion (end-of-line)
536ae2dd
RS
2919 (or
2920 (eq (preceding-char) ?#)
2921 ;; Handle executables in case of -F option.
2922 ;; We need not worry about the other kinds
2923 ;; of markings that -F makes, since they won't
2924 ;; appear on real auto-save files.
2925 (if (eq (preceding-char) ?*)
2926 (progn
2927 (forward-char -1)
2928 (eq (preceding-char) ?#)))))
a91526b9
RS
2929 (not (looking-at dired-re-dir))
2930 (let ((fn (dired-get-filename t t)))
2931 (if fn (auto-save-file-name-p
2932 (file-name-nondirectory fn)))))
2933 "auto save file")))
492d2437 2934
d7aed37c 2935(defcustom dired-garbage-files-regexp
6736ab5a 2936 ;; `log' here is dubious, since it's typically used for useful log
d7aed37c 2937 ;; files, not just TeX stuff. -- fx
d4aeef3b
KG
2938 (concat (regexp-opt
2939 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
c60ee5e7 2940 "\\'")
d7aed37c
SM
2941 "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
2942 :type 'regexp
2943 :group 'dired)
84d3f6e8
RS
2944
2945(defun dired-flag-garbage-files ()
84d3f6e8 2946 "Flag for deletion all files that match `dired-garbage-files-regexp'."
f656ec48 2947 (interactive)
84d3f6e8
RS
2948 (dired-flag-files-regexp dired-garbage-files-regexp))
2949
492d2437
RS
2950(defun dired-flag-backup-files (&optional unflag-p)
2951 "Flag all backup files (names ending with `~') for deletion.
2952With prefix argument, unflag these files."
2953 (interactive "P")
ee680b2b 2954 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
492d2437 2955 (dired-mark-if
f13101e9
KH
2956 ;; Don't call backup-file-name-p unless the last character looks like
2957 ;; it might be the end of a backup file name. This isn't very general,
a91526b9
RS
2958 ;; but it's the only way this runs fast enough.
2959 (and (save-excursion (end-of-line)
f13101e9
KH
2960 ;; Handle executables in case of -F option.
2961 ;; We need not worry about the other kinds
2962 ;; of markings that -F makes, since they won't
2963 ;; appear on real backup files.
2964 (if (eq (preceding-char) ?*)
2965 (forward-char -1))
fdee13ec 2966 (eq (preceding-char) ?~))
a91526b9 2967 (not (looking-at dired-re-dir))
492d2437
RS
2968 (let ((fn (dired-get-filename t t)))
2969 (if fn (backup-file-name-p fn))))
2970 "backup file")))
2971
6482fcac
RS
2972(defun dired-change-marks (&optional old new)
2973 "Change all OLD marks to NEW marks.
2974OLD and NEW are both characters used to mark files."
2975 (interactive
2976 (let* ((cursor-in-echo-area t)
2977 (old (progn (message "Change (old mark): ") (read-char)))
2978 (new (progn (message "Change %c marks to (new mark): " old)
2979 (read-char))))
2980 (list old new)))
e4e02841
RS
2981 (if (or (eq old ?\r) (eq new ?\r))
2982 (ding)
2983 (let ((string (format "\n%c" old))
2984 (buffer-read-only))
2985 (save-excursion
2986 (goto-char (point-min))
2987 (while (search-forward string nil t)
ee680b2b 2988 (if (if (= old ?\s)
a15a76f7
RS
2989 (save-match-data
2990 (dired-get-filename 'no-dir t))
2991 t)
2992 (subst-char-in-region (match-beginning 0)
2993 (match-end 0) old new)))))))
6482fcac 2994
534a6edf 2995(defun dired-unmark-all-marks ()
ee680b2b 2996 "Remove all marks from all files in the dired buffer."
b1ecd9c6
RS
2997 (interactive)
2998 (dired-unmark-all-files ?\r))
2999
8b87a301 3000(defun dired-unmark-all-files (mark &optional arg)
b602ba2f 3001 "Remove a specific mark (or any mark) from every file.
c60ee5e7 3002After this command, type the mark character to remove,
b602ba2f 3003or type RET to remove all marks.
3585916f 3004With prefix arg, query for each marked file.
492d2437 3005Type \\[help-command] at that time for help."
b602ba2f
RS
3006 (interactive "cRemove marks (RET means all): \nP")
3007 (save-excursion
3008 (let* ((count 0)
3009 buffer-read-only case-fold-search query
3010 (string (format "\n%c" mark))
3011 (help-form "\
8b87a301
RS
3012Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3013`!' to unmark all remaining files with no more questions."))
b602ba2f
RS
3014 (goto-char (point-min))
3015 (while (if (eq mark ?\r)
3016 (re-search-forward dired-re-mark nil t)
3017 (search-forward string nil t))
3018 (if (or (not arg)
e9407052
RS
3019 (let ((file (dired-get-filename t t)))
3020 (and file
3021 (dired-query 'query "Unmark file `%s'? "
3022 file))))
b602ba2f 3023 (progn (subst-char-in-region (1- (point)) (point)
ee680b2b 3024 (preceding-char) ?\s)
b602ba2f
RS
3025 (setq count (1+ count)))))
3026 (message (if (= count 1) "1 mark removed"
3027 "%d marks removed")
3028 count))))
83fadedf 3029\f
492d2437 3030;; Logging failures operating on files, and showing the results.
84fc2cfa 3031
492d2437 3032(defvar dired-log-buffer "*Dired log*")
84fc2cfa 3033
492d2437
RS
3034(defun dired-why ()
3035 "Pop up a buffer with error log output from Dired.
3036A group of errors from a single command ends with a formfeed.
3037Thus, use \\[backward-page] to find the beginning of a group of errors."
3038 (interactive)
3039 (if (get-buffer dired-log-buffer)
3040 (let ((owindow (selected-window))
3041 (window (display-buffer (get-buffer dired-log-buffer))))
3042 (unwind-protect
6482fcac 3043 (progn
492d2437
RS
3044 (select-window window)
3045 (goto-char (point-max))
0b7bc76f
RS
3046 (forward-line -1)
3047 (backward-page 1)
3048 (recenter 0))
492d2437
RS
3049 (select-window owindow)))))
3050
3051(defun dired-log (log &rest args)
3052 ;; Log a message or the contents of a buffer.
3053 ;; If LOG is a string and there are more args, it is formatted with
3054 ;; those ARGS. Usually the LOG string ends with a \n.
c60ee5e7 3055 ;; End each bunch of errors with (dired-log t):
0b7bc76f
RS
3056 ;; this inserts the current time and buffer at the start of the page,
3057 ;; and \f (formfeed) at the end.
492d2437 3058 (let ((obuf (current-buffer)))
0b7bc76f
RS
3059 (with-current-buffer (get-buffer-create dired-log-buffer)
3060 (goto-char (point-max))
3061 (let ((inhibit-read-only t))
3062 (cond ((stringp log)
3063 (insert (if args
3064 (apply (function format) log args)
3065 log)))
3066 ((bufferp log)
88cb5d3c 3067 (insert-buffer-substring log))
0b7bc76f
RS
3068 ((eq t log)
3069 (backward-page 1)
3070 (unless (bolp)
3071 (insert "\n"))
3072 (insert (current-time-string)
3073 "\tBuffer `" (buffer-name obuf) "'\n")
3074 (goto-char (point-max))
3075 (insert "\f\n")))))))
492d2437
RS
3076
3077(defun dired-log-summary (string failures)
ddcfebf1
RS
3078 "State a summary of a command's failures, in echo area and log buffer.
3079STRING is an overall summary of the failures.
3080FAILURES is a list of file names that we failed to operate on,
3081or nil if file names are not applicable."
0b7bc76f
RS
3082 (if (= (length failures) 1)
3083 (message "%s"
3084 (with-current-buffer dired-log-buffer
3085 (goto-char (point-max))
3086 (backward-page 1)
3087 (if (eolp) (forward-line 1))
3088 (buffer-substring (point) (point-max))))
3089 (message (if failures "%s--type ? for details (%s)"
3090 "%s--type ? for details")
3091 string failures))
492d2437 3092 ;; Log a summary describing a bunch of errors.
0b7bc76f 3093 (dired-log (concat "\n" string "\n"))
492d2437 3094 (dired-log t))
83fadedf 3095\f
492d2437
RS
3096;;; Sorting
3097
3098;; Most ls can only sort by name or by date (with -t), nothing else.
3099;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3100;; So anything that does not contain these is sort "by name".
3101
3102(defvar dired-ls-sorting-switches "SXU"
87ae59e3 3103 "String of `ls' switches \(single letters\) except \"t\" that influence sorting.
cfc8b264
EZ
3104
3105This indicates to Dired which option switches to watch out for because they
3106will change the sorting order behavior of `ls'.
3107
3108To change the default sorting order \(e.g. add a `-v' option\), see the
3109variable `dired-listing-switches'. To temporarily override the listing
3110format, use `\\[universal-argument] \\[dired]'.")
492d2437
RS
3111
3112(defvar dired-sort-by-date-regexp
3113 (concat "^-[^" dired-ls-sorting-switches
3114 "]*t[^" dired-ls-sorting-switches "]*$")
ee680b2b 3115 "Regexp recognized by Dired to set `by date' mode.")
492d2437
RS
3116
3117(defvar dired-sort-by-name-regexp
3118 (concat "^-[^t" dired-ls-sorting-switches "]+$")
ee680b2b 3119 "Regexp recognized by Dired to set `by name' mode.")
492d2437 3120
23fc67ea
RS
3121(defvar dired-sort-inhibit nil
3122 "Non-nil means the Dired sort command is disabled.
ee680b2b 3123The idea is to set this buffer-locally in special dired buffers.")
23fc67ea 3124
492d2437
RS
3125(defun dired-sort-set-modeline ()
3126 ;; Set modeline display according to dired-actual-switches.
3127 ;; Modeline display of "by name" or "by date" guarantees the user a
3128 ;; match with the corresponding regexps. Non-matching switches are
3129 ;; shown literally.
5641671f
NR
3130 (when (eq major-mode 'dired-mode)
3131 (setq mode-name
3132 (let (case-fold-search)
098bab71 3133 (cond ((string-match
5641671f
NR
3134 dired-sort-by-name-regexp dired-actual-switches)
3135 "Dired by name")
3136 ((string-match
3137 dired-sort-by-date-regexp dired-actual-switches)
3138 "Dired by date")
3139 (t
3140 (concat "Dired " dired-actual-switches)))))
3141 (force-mode-line-update)))
492d2437
RS
3142
3143(defun dired-sort-toggle-or-edit (&optional arg)
3144 "Toggle between sort by date/name and refresh the dired buffer.
3145With a prefix argument you can edit the current listing switches instead."
84fc2cfa 3146 (interactive "P")
23fc67ea 3147 (when dired-sort-inhibit
ee680b2b 3148 (error "Cannot sort this dired buffer"))
492d2437
RS
3149 (if arg
3150 (dired-sort-other
3151 (read-string "ls switches (must contain -l): " dired-actual-switches))
3152 (dired-sort-toggle)))
3153
3154(defun dired-sort-toggle ()
3155 ;; Toggle between sort by date/name. Reverts the buffer.
3156 (setq dired-actual-switches
3157 (let (case-fold-search)
7820b28f
RS
3158 (if (string-match " " dired-actual-switches)
3159 ;; New toggle scheme: add/remove a trailing " -t"
3160 (if (string-match " -t\\'" dired-actual-switches)
2b2059d8 3161 (substring dired-actual-switches 0 (match-beginning 0))
7820b28f
RS
3162 (concat dired-actual-switches " -t"))
3163 ;; old toggle scheme: look for some 't' switch and add/remove it
3164 (concat
3165 "-l"
83fadedf
DL
3166 (dired-replace-in-string (concat "[-lt"
3167 dired-ls-sorting-switches "]")
3168 ""
3169 dired-actual-switches)
7820b28f
RS
3170 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3171 dired-actual-switches)
3172 ""
3173 "t")))))
492d2437
RS
3174 (dired-sort-set-modeline)
3175 (revert-buffer))
3176
83fadedf 3177;; Some user code loads dired especially for this.
879fa8d0 3178;; Don't do that--use replace-regexp-in-string instead.
83fadedf
DL
3179(defun dired-replace-in-string (regexp newtext string)
3180 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3181 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3182 (let ((result "") (start 0) mb me)
3183 (while (string-match regexp string start)
3184 (setq mb (match-beginning 0)
3185 me (match-end 0)
3186 result (concat result (substring string start mb) newtext)
3187 start me))
3188 (concat result (substring string start))))
3189
492d2437 3190(defun dired-sort-other (switches &optional no-revert)
ee680b2b 3191 "Specify new `ls' SWITCHES for current dired buffer.
ff3d76aa
SM
3192Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3193set the minor mode accordingly, others appear literally in the mode line.
3194With optional second arg NO-REVERT, don't refresh the listing afterwards."
e17dba1f 3195 (dired-sort-R-check switches)
492d2437 3196 (setq dired-actual-switches switches)
5641671f 3197 (dired-sort-set-modeline)
492d2437 3198 (or no-revert (revert-buffer)))
e17dba1f 3199
5afea280
RS
3200(defvar dired-subdir-alist-pre-R nil
3201 "Value of `dired-subdir-alist' before -R switch added.")
75461997 3202(make-variable-buffer-local 'dired-subdir-alist-pre-R)
e17dba1f
GM
3203
3204(defun dired-sort-R-check (switches)
3205 "Additional processing of -R in ls option string SWITCHES.
3206Saves `dired-subdir-alist' when R is set and restores saved value
3207minus any directories explicitly deleted when R is cleared.
3208To be called first in body of `dired-sort-other', etc."
3209 (cond
3210 ((and (string-match "R" switches)
3211 (not (string-match "R" dired-actual-switches)))
3212 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3213 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3214 ((and (string-match "R" dired-actual-switches)
3215 (not (string-match "R" switches)))
3216 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3217 ;; that are still present:
3218 (setq dired-subdir-alist
3219 (if dired-subdir-alist-pre-R
3220 (let (subdirs)
3221 (while dired-subdir-alist-pre-R
3222 (if (assoc (caar dired-subdir-alist-pre-R)
3223 dired-subdir-alist)
3224 ;; subdir still present...
3225 (setq subdirs
3226 (cons (car dired-subdir-alist-pre-R)
3227 subdirs)))
3228 (setq dired-subdir-alist-pre-R
3229 (cdr dired-subdir-alist-pre-R)))
3230 (reverse subdirs))
3231 ;; No pre-R subdir alist, so revert to main directory
3232 ;; listing:
3233 (list (car (reverse dired-subdir-alist))))))))
83fadedf 3234\f
133aad74
JD
3235
3236;;;; Drag and drop support
3237
773933d3 3238(defcustom dired-recursive-copies 'top
fe02ba07 3239 "*Decide whether recursive copies are allowed.
098bab71 3240A value of nil means no recursive copies.
fe02ba07
RS
3241`always' means copy recursively without asking.
3242`top' means ask for each directory at top level.
3243Anything else means ask for each directory."
3244 :type '(choice :tag "Copy directories"
3245 (const :tag "No recursive copies" nil)
3246 (const :tag "Ask for each directory" t)
3247 (const :tag "Ask for each top directory only" top)
3248 (const :tag "Copy directories without asking" always))
3249 :group 'dired)
3250
133aad74 3251(defun dired-dnd-popup-notice ()
fcaed7ce 3252 (message-box
3b1b11e9 3253 "Dired recursive copies are currently disabled.\nSee the variable `dired-recursive-copies'."))
133aad74
JD
3254
3255
3256(defun dired-dnd-do-ask-action (uri)
3257 ;; No need to get actions and descriptions from the source,
3258 ;; we only have three actions anyway.
5553077c 3259 (let ((action (x-popup-menu
133aad74
JD
3260 t
3261 (list "What action?"
3262 (cons ""
3263 '(("Copy here" . copy)
3264 ("Move here" . move)
3265 ("Link here" . link)
3266 "--"
3267 ("Cancel" . nil)))))))
3268 (if action
3269 (dired-dnd-handle-local-file uri action)
3270 nil)))
3271
5c4fa70f 3272(declare-function dired-relist-entry "dired-aux" (file))
f36d1cdc 3273(declare-function make-symbolic-link "fileio.c")
5c4fa70f 3274
133aad74
JD
3275(defun dired-dnd-handle-local-file (uri action)
3276 "Copy, move or link a file to the dired directory.
3277URI is the file to handle, ACTION is one of copy, move, link or ask.
3278Ask means pop up a menu for the user to select one of copy, move or link."
3279 (require 'dired-aux)
361eee8f 3280 (let* ((from (dnd-get-local-file-name uri t))
93ab4de3
CY
3281 (to (when from
3282 (concat (dired-current-directory)
3283 (file-name-nondirectory from)))))
61bfceb6 3284 (when from
93ab4de3 3285 (cond ((eq action 'ask)
61bfceb6 3286 (dired-dnd-do-ask-action uri))
93ab4de3
CY
3287 ;; If copying a directory and dired-recursive-copies is
3288 ;; nil, dired-copy-file fails. Pop up a notice.
3289 ((and (memq action '(copy private))
3290 (file-directory-p from)
3291 (not dired-recursive-copies))
3292 (dired-dnd-popup-notice))
3293 ((memq action '(copy private move link))
3294 (let ((overwrite (and (file-exists-p to)
3295 (y-or-n-p
3296 (format "Overwrite existing file `%s'? " to))))
3297 ;; Binding dired-overwrite-confirmed to nil makes
3298 ;; dired-handle-overwrite a no-op. We instead use
3299 ;; y-or-n-p, which pops a graphical menu.
3300 dired-overwrite-confirmed backup-file)
3301 (when (and overwrite
3302 ;; d-b-o is defined in dired-aux.
3303 (boundp 'dired-backup-overwrite)
3304 dired-backup-overwrite
3305 (setq backup-file
3306 (car (find-backup-file-name to)))
3307 (or (eq dired-backup-overwrite 'always)
3308 (y-or-n-p
3309 (format
3310 "Make backup for existing file `%s'? " to))))
3311 (rename-file to backup-file 0)
3312 (dired-relist-entry backup-file))
3313 (cond ((memq action '(copy private))
3314 (dired-copy-file from to overwrite))
3315 ((eq action 'move)
3316 (dired-rename-file from to overwrite))
3317 ((eq action 'link)
3318 (make-symbolic-link from to overwrite)))
3319 (dired-relist-entry to)
3320 action))))))
133aad74
JD
3321
3322(defun dired-dnd-handle-file (uri action)
3323 "Copy, move or link a file to the dired directory if it is a local file.
3324URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3325ACTION is one of copy, move, link or ask.
3326Ask means pop up a menu for the user to select one of copy, move or link."
361eee8f 3327 (let ((local-file (dnd-get-local-file-uri uri)))
133aad74
JD
3328 (if local-file (dired-dnd-handle-local-file local-file action)
3329 nil)))
31b4c848
LH
3330\f
3331
3332;;;; Desktop support
3333
3334(eval-when-compile (require 'desktop))
3335
3336(defun dired-desktop-buffer-misc-data (desktop-dirname)
3337 "Auxiliary information to be saved in desktop file."
3338 (cons
3339 ;; Value of `dired-directory'.
3340 (if (consp dired-directory)
3341 ;; Directory name followed by list of files.
3342 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3343 (cdr dired-directory))
9d9ee410 3344 ;; Directory name, optionally with shell wildcard.
31b4c848
LH
3345 (desktop-file-name dired-directory desktop-dirname))
3346 ;; Subdirectories in `dired-subdir-alist'.
3347 (cdr
3348 (nreverse
3349 (mapcar
3350 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3351 dired-subdir-alist)))))
133aad74 3352
31b4c848
LH
3353(defun dired-restore-desktop-buffer (desktop-buffer-file-name
3354 desktop-buffer-name
3355 desktop-buffer-misc)
3356 "Restore a dired buffer specified in a desktop file."
3357 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
9d9ee410 3358 ;; This value is a directory name, optionally with shell wildcard or
31b4c848
LH
3359 ;; a directory name followed by list of files.
3360 (let* ((dired-dir (car desktop-buffer-misc))
3361 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3362 (if (file-directory-p (file-name-directory dir))
3363 (progn
3364 (dired dired-dir)
3365 ;; The following elements of `desktop-buffer-misc' are the keys
3366 ;; from `dired-subdir-alist'.
6ba03ad9 3367 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
31b4c848
LH
3368 (current-buffer))
3369 (message "Desktop: Directory %s no longer exists." dir)
3370 (when desktop-missing-file-warning (sit-for 1))
3371 nil)))
133aad74 3372
9e7357b0
AS
3373(add-to-list 'desktop-buffer-mode-handlers
3374 '(dired-mode . dired-restore-desktop-buffer))
a515788d 3375
133aad74 3376\f
492d2437
RS
3377(if (eq system-type 'vax-vms)
3378 (load "dired-vms"))
84fc2cfa 3379
52041219
RS
3380(provide 'dired)
3381
57e15005
BF
3382(run-hooks 'dired-load-hook) ; for your customizations
3383
87ae59e3 3384;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
52041219 3385;;; dired.el ends here