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