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