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