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