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