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