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