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