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