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