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