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