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