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