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