(DONTCOMPILE): Add various term files.
[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.
e95b0c08 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.")
e95b0c08 306
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
e95b0c08 409
492d2437
RS
410;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
411;; other special applications.
e95b0c08 412
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 ...
e95b0c08 517 (cond (switches ; ... but new switches
6cfd24f9 518 ;; file list may have changed
e95b0c08 519 (if (consp dir-or-list)
6cfd24f9
AS
520 (setq dired-directory dir-or-list))
521 ;; this calls dired-revert
e95b0c08 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
e95b0c08 589
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)
738 (put-text-property (point)
739 (save-excursion
740 (dired-move-to-end-of-filename)
741 (point))
742 'mouse-face 'highlight))
743 (error nil))
cb88a3db
RS
744 (forward-line 1))))
745
492d2437
RS
746(defun dired-insert-headerline (dir);; also used by dired-insert-subdir
747 ;; Insert DIR's headerline with no trailing slash, exactly like ls
748 ;; would, and put cursor where dired-build-subdir-alist puts subdir
749 ;; boundaries.
750 (save-excursion (insert " " (directory-file-name dir) ":\n")))
751
e95b0c08 752
492d2437
RS
753;; Reverting a dired buffer
754
84fc2cfa 755(defun dired-revert (&optional arg noconfirm)
492d2437
RS
756 ;; Reread the dired buffer. Must also be called after
757 ;; dired-actual-switches have changed.
758 ;; Should not fail even on completely garbaged buffers.
759 ;; Preserves old cursor, marks/flags, hidden-p.
760 (widen) ; just in case user narrowed
84fc2cfa 761 (let ((opoint (point))
492d2437
RS
762 (ofile (dired-get-filename nil t))
763 (mark-alist nil) ; save marked files
764 (hidden-subdirs (dired-remember-hidden))
765 (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
766 (case-fold-search nil) ; we check for upper case ls flags
767 buffer-read-only)
768 (goto-char (point-min))
769 (setq mark-alist;; only after dired-remember-hidden since this unhides:
770 (dired-remember-marks (point-min) (point-max)))
771 ;; treat top level dir extra (it may contain wildcards)
8d23c16b
ER
772 (dired-uncache
773 (if (consp dired-directory) (car dired-directory) dired-directory))
84fc2cfa 774 (dired-readin dired-directory (current-buffer))
492d2437
RS
775 (let ((dired-after-readin-hook nil))
776 ;; don't run that hook for each subdir...
777 (dired-insert-old-subdirs old-subdir-alist))
778 (dired-mark-remembered mark-alist) ; mark files that were marked
779 ;; ... run the hook for the whole buffer, and only after markers
780 ;; have been reinserted (else omitting in dired-x would omit marked files)
781 (run-hooks 'dired-after-readin-hook) ; no need to narrow
782 (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
783 (goto-char opoint)) ; was before
84fc2cfa 784 (dired-move-to-filename)
492d2437
RS
785 (save-excursion ; hide subdirs that were hidden
786 (mapcar (function (lambda (dir)
787 (if (dired-goto-subdir dir)
788 (dired-hide-subdir 1))))
789 hidden-subdirs)))
790 ;; outside of the let scope
791;;; Might as well not override the user if the user changed this.
792;;; (setq buffer-read-only t)
793 )
794
795;; Subroutines of dired-revert
796;; Some of these are also used when inserting subdirs.
797
798(defun dired-remember-marks (beg end)
799 ;; Return alist of files and their marks, from BEG to END.
800 (if selective-display ; must unhide to make this work.
801 (let (buffer-read-only)
802 (subst-char-in-region beg end ?\r ?\n)))
803 (let (fil chr alist)
804 (save-excursion
805 (goto-char beg)
806 (while (re-search-forward dired-re-mark end t)
807 (if (setq fil (dired-get-filename nil t))
808 (setq chr (preceding-char)
809 alist (cons (cons fil chr) alist)))))
810 alist))
811
812;; Mark all files remembered in ALIST.
813;; Each element of ALIST looks like (FILE . MARKERCHAR).
814(defun dired-mark-remembered (alist)
815 (let (elt fil chr)
816 (while alist
817 (setq elt (car alist)
818 alist (cdr alist)
819 fil (car elt)
820 chr (cdr elt))
821 (if (dired-goto-file fil)
822 (save-excursion
823 (beginning-of-line)
824 (delete-char 1)
825 (insert chr))))))
826
827;; Return a list of names of subdirs currently hidden.
828(defun dired-remember-hidden ()
829 (let ((l dired-subdir-alist) dir pos result)
830 (while l
831 (setq dir (car (car l))
832 pos (cdr (car l))
833 l (cdr l))
834 (goto-char pos)
835 (skip-chars-forward "^\r\n")
52041219 836 (if (eq (following-char) ?\r)
492d2437
RS
837 (setq result (cons dir result))))
838 result))
839
840;; Try to insert all subdirs that were displayed before,
841;; according to the former subdir alist OLD-SUBDIR-ALIST.
842(defun dired-insert-old-subdirs (old-subdir-alist)
843 (or (string-match "R" dired-actual-switches)
844 (let (elt dir)
845 (while old-subdir-alist
846 (setq elt (car old-subdir-alist)
847 old-subdir-alist (cdr old-subdir-alist)
848 dir (car elt))
849 (condition-case ()
715984d3
RS
850 (progn
851 (dired-uncache dir)
852 (dired-insert-subdir dir))
492d2437 853 (error nil))))))
715984d3
RS
854
855;; Remove directory DIR from any directory cache.
856(defun dired-uncache (dir)
6eaebaa2 857 (let ((handler (find-file-name-handler dir 'dired-uncache)))
715984d3
RS
858 (if handler
859 (funcall handler 'dired-uncache dir))))
e95b0c08 860
492d2437 861;; dired mode key bindings and initialization
84fc2cfa
ER
862
863(defvar dired-mode-map nil "Local keymap for dired-mode buffers.")
864(if dired-mode-map
865 nil
492d2437
RS
866 ;; This looks ugly when substitute-command-keys uses C-d instead d:
867 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
868
3e1fb00f
RS
869 (let ((map (make-keymap)))
870 (suppress-keymap map)
871 (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
872 ;; Commands to mark or flag certain categories of files
873 (define-key map "#" 'dired-flag-auto-save-files)
3e1fb00f 874 (define-key map "." 'dired-clean-directory)
3e1fb00f 875 (define-key map "~" 'dired-flag-backup-files)
84d3f6e8 876 (define-key map "&" 'dired-flag-garbage-files)
3e1fb00f
RS
877 ;; Upper case keys (except !) for operating on the marked files
878 (define-key map "A" 'dired-do-search)
879 (define-key map "C" 'dired-do-copy)
880 (define-key map "B" 'dired-do-byte-compile)
881 (define-key map "D" 'dired-do-delete)
882 (define-key map "G" 'dired-do-chgrp)
883 (define-key map "H" 'dired-do-hardlink)
884 (define-key map "L" 'dired-do-load)
885 (define-key map "M" 'dired-do-chmod)
886 (define-key map "O" 'dired-do-chown)
887 (define-key map "P" 'dired-do-print)
ee93b692 888 (define-key map "Q" 'dired-do-query-replace-regexp)
3e1fb00f
RS
889 (define-key map "R" 'dired-do-rename)
890 (define-key map "S" 'dired-do-symlink)
891 (define-key map "X" 'dired-do-shell-command)
892 (define-key map "Z" 'dired-do-compress)
893 (define-key map "!" 'dired-do-shell-command)
894 ;; Comparison commands
895 (define-key map "=" 'dired-diff)
896 (define-key map "\M-=" 'dired-backup-diff)
897 ;; Tree Dired commands
898 (define-key map "\M-\C-?" 'dired-unmark-all-files)
899 (define-key map "\M-\C-d" 'dired-tree-down)
900 (define-key map "\M-\C-u" 'dired-tree-up)
901 (define-key map "\M-\C-n" 'dired-next-subdir)
902 (define-key map "\M-\C-p" 'dired-prev-subdir)
903 ;; move to marked files
904 (define-key map "\M-{" 'dired-prev-marked-file)
905 (define-key map "\M-}" 'dired-next-marked-file)
906 ;; Make all regexp commands share a `%' prefix:
907 ;; We used to get to the submap via a symbol dired-regexp-prefix,
908 ;; but that seems to serve little purpose, and copy-keymap
909 ;; does a better job without it.
910 (define-key map "%" nil)
911 (define-key map "%u" 'dired-upcase)
912 (define-key map "%l" 'dired-downcase)
913 (define-key map "%d" 'dired-flag-files-regexp)
e9b8e22d 914 (define-key map "%g" 'dired-mark-files-containing-regexp)
3e1fb00f
RS
915 (define-key map "%m" 'dired-mark-files-regexp)
916 (define-key map "%r" 'dired-do-rename-regexp)
917 (define-key map "%C" 'dired-do-copy-regexp)
918 (define-key map "%H" 'dired-do-hardlink-regexp)
919 (define-key map "%R" 'dired-do-rename-regexp)
920 (define-key map "%S" 'dired-do-symlink-regexp)
4a3ca6ed
RS
921 ;; Commands for marking and unmarking.
922 (define-key map "*" nil)
923 (define-key map "**" 'dired-mark-executables)
924 (define-key map "*/" 'dired-mark-directories)
925 (define-key map "*@" 'dired-mark-symlinks)
926 (define-key map "*%" 'dired-mark-files-regexp)
927 (define-key map "*c" 'dired-change-marks)
0609c998 928 (define-key map "*s" 'dired-mark-subdir-files)
4a3ca6ed
RS
929 (define-key map "*m" 'dired-mark)
930 (define-key map "*u" 'dired-unmark)
931 (define-key map "*?" 'dired-unmark-all-files)
534a6edf 932 (define-key map "*!" 'dired-unmark-all-marks)
4a3ca6ed
RS
933 (define-key map "*\177" 'dired-unmark-backward)
934 (define-key map "*\C-n" 'dired-next-marked-file)
935 (define-key map "*\C-p" 'dired-prev-marked-file)
48c93229 936 (define-key map "*t" 'dired-do-toggle)
3e1fb00f 937 ;; Lower keys for commands not operating on all the marked files
c5753a5d 938 (define-key map "a" 'dired-find-alternate-file)
3e1fb00f
RS
939 (define-key map "d" 'dired-flag-file-deletion)
940 (define-key map "e" 'dired-find-file)
941 (define-key map "f" 'dired-find-file)
f01fd03b 942 (define-key map "w" 'dired-show-file-type)
3e1fb00f
RS
943 (define-key map "\C-m" 'dired-advertised-find-file)
944 (define-key map "g" 'revert-buffer)
945 (define-key map "h" 'describe-mode)
946 (define-key map "i" 'dired-maybe-insert-subdir)
947 (define-key map "k" 'dired-do-kill-lines)
948 (define-key map "l" 'dired-do-redisplay)
949 (define-key map "m" 'dired-mark)
950 (define-key map "n" 'dired-next-line)
951 (define-key map "o" 'dired-find-file-other-window)
952 (define-key map "\C-o" 'dired-display-file)
953 (define-key map "p" 'dired-previous-line)
da8a8438 954 (define-key map "q" 'quit-window)
3e1fb00f 955 (define-key map "s" 'dired-sort-toggle-or-edit)
e5f0841e 956 (define-key map "t" 'dired-do-toggle)
3e1fb00f
RS
957 (define-key map "u" 'dired-unmark)
958 (define-key map "v" 'dired-view-file)
959 (define-key map "x" 'dired-do-flagged-delete)
960 (define-key map "+" 'dired-create-directory)
961 ;; moving
962 (define-key map "<" 'dired-prev-dirline)
963 (define-key map ">" 'dired-next-dirline)
964 (define-key map "^" 'dired-up-directory)
965 (define-key map " " 'dired-next-line)
966 (define-key map "\C-n" 'dired-next-line)
967 (define-key map "\C-p" 'dired-previous-line)
968 (define-key map [down] 'dired-next-line)
969 (define-key map [up] 'dired-previous-line)
970 ;; hiding
971 (define-key map "$" 'dired-hide-subdir)
972 (define-key map "\M-$" 'dired-hide-all)
973 ;; misc
974 (define-key map "?" 'dired-summary)
975 (define-key map "\177" 'dired-unmark-backward)
976 (define-key map "\C-_" 'dired-undo)
977 (define-key map "\C-xu" 'dired-undo)
978
979 ;; Make menu bar items.
980
d066de8e
EZ
981 ;; No need to fo this, now that top-level items are fewer.
982 ;;;;
3e1fb00f 983 ;; Get rid of the Edit menu bar item to save space.
d066de8e 984 ;(define-key map [menu-bar edit] 'undefined)
3e1fb00f
RS
985
986 (define-key map [menu-bar subdir]
987 (cons "Subdir" (make-sparse-keymap "Subdir")))
988
989 (define-key map [menu-bar subdir hide-all]
d066de8e
EZ
990 '(menu-item "Hide All" dired-hide-all
991 :help "Hide all subdirectories, leave only header lines"))
3e1fb00f 992 (define-key map [menu-bar subdir hide-subdir]
d066de8e
EZ
993 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
994 :help "Hide or unhide current directory listing"))
3e1fb00f 995 (define-key map [menu-bar subdir tree-down]
d066de8e
EZ
996 '(menu-item "Tree Down" dired-tree-down
997 :help "Go to first subdirectory header down the tree"))
3e1fb00f 998 (define-key map [menu-bar subdir tree-up]
d066de8e
EZ
999 '(menu-item "Tree Up" dired-tree-up
1000 :help "Go to first subdirectory header up the tree"))
3e1fb00f 1001 (define-key map [menu-bar subdir up]
d066de8e
EZ
1002 '(menu-item "Up Directory" dired-up-directory
1003 :help "Edit the parent directory"))
3e1fb00f 1004 (define-key map [menu-bar subdir prev-subdir]
d066de8e
EZ
1005 '(menu-item "Prev Subdir" dired-prev-subdir
1006 :help "Go to previous subdirectory header line"))
3e1fb00f 1007 (define-key map [menu-bar subdir next-subdir]
d066de8e
EZ
1008 '(menu-item "Next Subdir" dired-next-subdir
1009 :help "Go to next subdirectory header line"))
3e1fb00f 1010 (define-key map [menu-bar subdir prev-dirline]
d066de8e
EZ
1011 '(menu-item "Prev Dirline" dired-prev-dirline
1012 :help "Move to next directory-file line"))
3e1fb00f 1013 (define-key map [menu-bar subdir next-dirline]
d066de8e
EZ
1014 '(menu-item "Next Dirline" dired-next-dirline
1015 :help "Move to previous directory-file line"))
3e1fb00f 1016 (define-key map [menu-bar subdir insert]
d066de8e
EZ
1017 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1018 :help "Insert contents of subdirectory"))
3e1fb00f
RS
1019
1020 (define-key map [menu-bar immediate]
1021 (cons "Immediate" (make-sparse-keymap "Immediate")))
1022
a3285795 1023 (define-key map [menu-bar immediate revert-buffer]
d066de8e
EZ
1024 '(menu-item "Refresh" revert-buffer
1025 :help "Update contents of shown directories"))
a3285795
RS
1026
1027 (define-key map [menu-bar immediate dashes]
1028 '("--"))
1029
3e1fb00f 1030 (define-key map [menu-bar immediate backup-diff]
d066de8e
EZ
1031 '(menu-item "Compare with Backup" dired-backup-diff
1032 :help "Diff file at cursor with its latest backup"))
3e1fb00f 1033 (define-key map [menu-bar immediate diff]
d066de8e
EZ
1034 '(menu-item "Diff..." dired-diff
1035 :help "Compare file at cursor with another file"))
3e1fb00f 1036 (define-key map [menu-bar immediate view]
d066de8e
EZ
1037 '(menu-item "View This File" dired-view-file
1038 :help "Examine file at cursor in read-only mode"))
3e1fb00f 1039 (define-key map [menu-bar immediate display]
d066de8e
EZ
1040 '(menu-item "Display in Other Window" dired-display-file
1041 :help "Display file at cursor in other window"))
3e1fb00f 1042 (define-key map [menu-bar immediate find-file-other-window]
d066de8e
EZ
1043 '(menu-item "Find in Other Window" dired-find-file-other-window
1044 :help "Edit file at cursor in other window"))
3e1fb00f 1045 (define-key map [menu-bar immediate find-file]
d066de8e
EZ
1046 '(menu-item "Find This File" dired-find-file
1047 :help "Edit file at cursor"))
3e1fb00f 1048 (define-key map [menu-bar immediate create-directory]
d066de8e 1049 '(menu-item "Create Directory..." dired-create-directory))
3e1fb00f
RS
1050
1051 (define-key map [menu-bar regexp]
1052 (cons "Regexp" (make-sparse-keymap "Regexp")))
1053
1054 (define-key map [menu-bar regexp downcase]
d066de8e
EZ
1055 '(menu-item "Downcase" dired-downcase
1056 ;; When running on plain MS-DOS, there's only one
1057 ;; letter-case for file names.
1058 :enable (or (not (fboundp 'msdos-long-file-names))
1059 (msdos-long-file-names))
1060 :help "Rename marked files to lower-case name"))
3e1fb00f 1061 (define-key map [menu-bar regexp upcase]
d066de8e
EZ
1062 '(menu-item "Upcase" dired-upcase
1063 :enable (or (not (fboundp 'msdos-long-file-names))
1064 (msdos-long-file-names))
1065 :help "Rename marked files to upper-case name"))
3e1fb00f 1066 (define-key map [menu-bar regexp hardlink]
d066de8e
EZ
1067 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1068 :help "Make hard links for files matching regexp"))
3e1fb00f 1069 (define-key map [menu-bar regexp symlink]
d066de8e
EZ
1070 '(menu-item "Symlink..." dired-do-symlink-regexp
1071 :visible (fboundp 'make-symbolic-link)
1072 :help "Make symbolic links for files matching regexp"))
3e1fb00f 1073 (define-key map [menu-bar regexp rename]
d066de8e
EZ
1074 '(menu-item "Rename..." dired-do-rename-regexp
1075 :help "Rename marked files matching regexp"))
3e1fb00f 1076 (define-key map [menu-bar regexp copy]
d066de8e
EZ
1077 '(menu-item "Copy..." dired-do-copy-regexp
1078 :help "Copy marked files matching regexp"))
3e1fb00f 1079 (define-key map [menu-bar regexp flag]
d066de8e
EZ
1080 '(menu-item "Flag..." dired-flag-files-regexp
1081 :help "Flag files matching regexp for deletion"))
3e1fb00f 1082 (define-key map [menu-bar regexp mark]
d066de8e
EZ
1083 '(menu-item "Mark..." dired-mark-files-regexp
1084 :help "Mark files matching regexp for future operations"))
aa924deb 1085 (define-key map [menu-bar regexp mark-cont]
d066de8e
EZ
1086 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1087 :help "Mark files whose contents matches regexp"))
3e1fb00f
RS
1088
1089 (define-key map [menu-bar mark]
1090 (cons "Mark" (make-sparse-keymap "Mark")))
1091
1092 (define-key map [menu-bar mark prev]
d066de8e
EZ
1093 '(menu-item "Previous Marked" dired-prev-marked-file
1094 :help "Move to previous marked file"))
3e1fb00f 1095 (define-key map [menu-bar mark next]
d066de8e
EZ
1096 '(menu-item "Next Marked" dired-next-marked-file
1097 :help "Move to next marked file"))
3e1fb00f 1098 (define-key map [menu-bar mark marks]
d066de8e
EZ
1099 '(menu-item "Change Marks..." dired-change-marks
1100 :help "Replace marker with another character"))
3e1fb00f 1101 (define-key map [menu-bar mark unmark-all]
d066de8e 1102 '(menu-item "Unmark All" dired-unmark-all-marks))
3e1fb00f 1103 (define-key map [menu-bar mark symlinks]
d066de8e
EZ
1104 '(menu-item "Mark Symlinks" dired-mark-symlinks
1105 :visible (fboundp 'make-symbolic-link)
1106 :help "Mark all symbolic links"))
3e1fb00f 1107 (define-key map [menu-bar mark directories]
d066de8e
EZ
1108 '(menu-item "Mark Directories" dired-mark-directories
1109 :help "Mark all directories except `.' and `..'"))
3e1fb00f 1110 (define-key map [menu-bar mark directory]
d066de8e
EZ
1111 '(menu-item "Mark Old Backups" dired-clean-directory
1112 :help "Flag old numbered backups for deletion"))
3e1fb00f 1113 (define-key map [menu-bar mark executables]
d066de8e
EZ
1114 '(menu-item "Mark Executables" dired-mark-executables
1115 :help "Mark all executable files"))
84d3f6e8 1116 (define-key map [menu-bar mark garbage-files]
d066de8e
EZ
1117 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1118 :help "Flag unneeded files for deletion"))
3e1fb00f 1119 (define-key map [menu-bar mark backup-files]
d066de8e
EZ
1120 '(menu-item "Flag Backup Files" dired-flag-backup-files
1121 :help "Flag all backup files for deletion"))
3e1fb00f 1122 (define-key map [menu-bar mark auto-save-files]
d066de8e
EZ
1123 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1124 :help "Flag auto-save files for deletion"))
3e1fb00f 1125 (define-key map [menu-bar mark deletion]
d066de8e
EZ
1126 '(menu-item "Flag" dired-flag-file-deletion
1127 :help "Flag current line's file for deletion"))
3e1fb00f 1128 (define-key map [menu-bar mark unmark]
d066de8e
EZ
1129 '(menu-item "Unmark" dired-unmark
1130 :help "Unmark or unflag current line's file"))
3e1fb00f 1131 (define-key map [menu-bar mark mark]
d066de8e
EZ
1132 '(menu-item "Mark" dired-mark
1133 :help "Mark current line's file for future operations"))
e5f0841e 1134 (define-key map [menu-bar mark toggle-marks]
d066de8e
EZ
1135 '(menu-item "Toggle Marks" dired-do-toggle
1136 :help "Mark unmarked files, unmark marked ones"))
3e1fb00f
RS
1137
1138 (define-key map [menu-bar operate]
1139 (cons "Operate" (make-sparse-keymap "Operate")))
1140
1141 (define-key map [menu-bar operate query-replace]
ee93b692 1142 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
d066de8e 1143 :help "Replace regexp in marked files"))
3e1fb00f 1144 (define-key map [menu-bar operate search]
d066de8e
EZ
1145 '(menu-item "Search Files..." dired-do-search
1146 :help "Search marked files for regexp"))
3e1fb00f 1147 (define-key map [menu-bar operate chown]
d066de8e
EZ
1148 '(menu-item "Change Owner..." dired-do-chown
1149 :visible (not (memq system-type '(ms-dos windows-nt)))
1150 :help "Change the owner of marked files"))
3e1fb00f 1151 (define-key map [menu-bar operate chgrp]
d066de8e
EZ
1152 '(menu-item "Change Group..." dired-do-chgrp
1153 :visible (not (memq system-type '(ms-dos windows-nt)))
1154 :help "Change the group of marked files"))
3e1fb00f 1155 (define-key map [menu-bar operate chmod]
d066de8e
EZ
1156 '(menu-item "Change Mode..." dired-do-chmod
1157 :help "Change mode (attributes) of marked files"))
3e1fb00f 1158 (define-key map [menu-bar operate load]
d066de8e
EZ
1159 '(menu-item "Load" dired-do-load
1160 :help "Load marked Emacs Lisp files"))
3e1fb00f 1161 (define-key map [menu-bar operate compile]
d066de8e
EZ
1162 '(menu-item "Byte-compile" dired-do-byte-compile
1163 :help "Byte-compile marked Emacs Lisp files"))
3e1fb00f 1164 (define-key map [menu-bar operate compress]
d066de8e
EZ
1165 '(menu-item "Compress" dired-do-compress
1166 :help "Compress/uncompress marked files"))
3e1fb00f 1167 (define-key map [menu-bar operate print]
d066de8e
EZ
1168 '(menu-item "Print..." dired-do-print
1169 :help "Ask for print command and print marked files"))
3e1fb00f 1170 (define-key map [menu-bar operate hardlink]
d066de8e
EZ
1171 '(menu-item "Hardlink to..." dired-do-hardlink
1172 :help "Make hard links for current or marked files"))
3e1fb00f 1173 (define-key map [menu-bar operate symlink]
d066de8e
EZ
1174 '(menu-item "Symlink to..." dired-do-symlink
1175 :visible (fboundp 'make-symbolic-link)
1176 :help "Make symbolic links for current or marked files"))
3e1fb00f 1177 (define-key map [menu-bar operate command]
d066de8e
EZ
1178 '(menu-item "Shell Command..." dired-do-shell-command
1179 :help "Run a shell command on each of marked files"))
3e1fb00f 1180 (define-key map [menu-bar operate delete]
d066de8e
EZ
1181 '(menu-item "Delete" dired-do-delete
1182 :help "Delete current file or all marked files"))
3e1fb00f 1183 (define-key map [menu-bar operate rename]
d066de8e
EZ
1184 '(menu-item "Rename to..." dired-do-rename
1185 :help "Rename current file or move marked files"))
3e1fb00f 1186 (define-key map [menu-bar operate copy]
d066de8e
EZ
1187 '(menu-item "Copy to..." dired-do-copy
1188 :help "Copy current file or all marked files"))
3e1fb00f
RS
1189
1190 (setq dired-mode-map map)))
e95b0c08 1191
84fc2cfa
ER
1192;; Dired mode is suitable only for specially formatted data.
1193(put 'dired-mode 'mode-class 'special)
1194
492d2437
RS
1195(defun dired-mode (&optional dirname switches)
1196 "\
1197Mode for \"editing\" directory listings.
1198In dired, you are \"editing\" a list of the files in a directory and
1199 \(optionally) its subdirectories, in the format of `ls -lR'.
1200 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1201\"Editing\" means that you can run shell commands on files, visit,
1202 compress, load or byte-compile them, change their file attributes
1203 and insert subdirectories into the same buffer. You can \"mark\"
1204 files for later commands or \"flag\" them for deletion, either file
1205 by file or all files matching certain criteria.
1206You can move using the usual cursor motion commands.\\<dired-mode-map>
1207Letters no longer insert themselves. Digits are prefix arguments.
1208Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1209Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1210 Most commands operate on the marked files and use the current file
1211 if no files are marked. Use a numeric prefix argument to operate on
1212 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1213 to operate on the current file only. Prefix arguments override marks.
1214 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1215 to see why something went wrong.
1216Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1217Type \\[dired-unmark-backward] to back up one line and unflag.
1218Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1219Type \\[dired-advertised-find-file] to Find the current line's file
1220 (or dired it in another buffer, if it is a directory).
1221Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1222Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1223Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1224Type \\[dired-do-copy] to Copy files.
1225Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
1226Type \\[revert-buffer] to read all currently expanded directories again.
1227 This retains all marks and hides subdirs again that were hidden before.
1228SPC and DEL can be used to move down and up by lines.
1229
1230If dired ever gets confused, you can either type \\[revert-buffer] \
1231to read the
1232directories again, type \\[dired-do-redisplay] \
1233to relist a single or the marked files or a
1234subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1235again for the directory tree.
1236
1237Customization variables (rename this buffer and type \\[describe-variable] on each line
1238for more info):
1239
1240 dired-listing-switches
1241 dired-trivial-filenames
1242 dired-shrink-to-fit
1243 dired-marker-char
1244 dired-del-marker
1245 dired-keep-marker-rename
1246 dired-keep-marker-copy
1247 dired-keep-marker-hardlink
1248 dired-keep-marker-symlink
1249
1250Hooks (use \\[describe-variable] to see their documentation):
1251
1252 dired-before-readin-hook
1253 dired-after-readin-hook
1254 dired-mode-hook
1255 dired-load-hook
1256
1257Keybindings:
84fc2cfa 1258\\{dired-mode-map}"
492d2437
RS
1259 ;; Not to be called interactively (e.g. dired-directory will be set
1260 ;; to default-directory, which is wrong with wildcards).
84fc2cfa 1261 (kill-all-local-variables)
84fc2cfa 1262 (use-local-map dired-mode-map)
492d2437
RS
1263 (dired-advertise) ; default-directory is already set
1264 (setq major-mode 'dired-mode
1265 mode-name "Dired"
3222085e 1266;; case-fold-search nil
492d2437
RS
1267 buffer-read-only t
1268 selective-display t ; for subdirectory hiding
0acdf642
GM
1269 mode-line-buffer-identification
1270 (propertized-buffer-identification "%17b"))
492d2437
RS
1271 (set (make-local-variable 'revert-buffer-function)
1272 (function dired-revert))
1273 (set (make-local-variable 'page-delimiter)
1274 "\n\n")
1275 (set (make-local-variable 'dired-directory)
1276 (or dirname default-directory))
1277 ;; list-buffers uses this to display the dir being edited in this buffer.
1278 (set (make-local-variable 'list-buffers-directory)
474ac5bb 1279 (expand-file-name dired-directory))
492d2437
RS
1280 (set (make-local-variable 'dired-actual-switches)
1281 (or switches dired-listing-switches))
4481ae96 1282 (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
492d2437 1283 (dired-sort-other dired-actual-switches t)
84fc2cfa 1284 (run-hooks 'dired-mode-hook))
e95b0c08 1285
eb8c3be9 1286;; Idiosyncratic dired commands that don't deal with marks.
84fc2cfa 1287
84fc2cfa 1288(defun dired-summary ()
492d2437 1289 "Summarize basic Dired commands and show recent Dired errors."
84fc2cfa 1290 (interactive)
492d2437 1291 (dired-why)
84fc2cfa
ER
1292 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1293 (message
50f74744 1294 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
84fc2cfa 1295
492d2437
RS
1296(defun dired-undo ()
1297 "Undo in a dired buffer.
1298This doesn't recover lost files, it just undoes changes in the buffer itself.
1299You can use it to recover marks, killed lines or subdirs.
1300In the latter case, you have to do \\[dired-build-subdir-alist] to
1301parse the buffer again."
1302 (interactive)
1303 (let (buffer-read-only)
1304 (undo)))
84fc2cfa
ER
1305
1306(defun dired-next-line (arg)
1307 "Move down lines then position at filename.
1308Optional prefix ARG says how many lines to move; default is one line."
1309 (interactive "p")
1310 (next-line arg)
1311 (dired-move-to-filename))
1312
1313(defun dired-previous-line (arg)
1314 "Move up lines then position at filename.
1315Optional prefix ARG says how many lines to move; default is one line."
1316 (interactive "p")
1317 (previous-line arg)
1318 (dired-move-to-filename))
1319
492d2437
RS
1320(defun dired-next-dirline (arg &optional opoint)
1321 "Goto ARG'th next directory file line."
1322 (interactive "p")
1323 (or opoint (setq opoint (point)))
1324 (if (if (> arg 0)
1325 (re-search-forward dired-re-dir nil t arg)
1326 (beginning-of-line)
1327 (re-search-backward dired-re-dir nil t (- arg)))
1328 (dired-move-to-filename) ; user may type `i' or `f'
1329 (goto-char opoint)
1330 (error "No more subdirectories")))
1331
1332(defun dired-prev-dirline (arg)
1333 "Goto ARG'th previous directory file line."
1334 (interactive "p")
1335 (dired-next-dirline (- arg)))
1336
ac1ce341 1337(defun dired-up-directory (&optional other-window)
492d2437
RS
1338 "Run dired on parent directory of current directory.
1339Find the parent directory either in this buffer or another buffer.
1340Creates a buffer if necessary."
ac1ce341 1341 (interactive "P")
492d2437
RS
1342 (let* ((dir (dired-current-directory))
1343 (up (file-name-directory (directory-file-name dir))))
1344 (or (dired-goto-file (directory-file-name dir))
7b2469ae
RS
1345 ;; Only try dired-goto-subdir if buffer has more than one dir.
1346 (and (cdr dired-subdir-alist)
492d2437
RS
1347 (dired-goto-subdir up))
1348 (progn
ac1ce341
EN
1349 (if other-window
1350 (dired-other-window up)
1351 (dired up))
492d2437 1352 (dired-goto-file dir)))))
84fc2cfa 1353
dbcb9389
RS
1354;; Force `f' rather than `e' in the mode doc:
1355(defalias 'dired-advertised-find-file 'dired-find-file)
53fd9d05 1356(defun dired-find-file ()
84fc2cfa 1357 "In dired, visit the file or directory named on this line."
53fd9d05 1358 (interactive)
c439687b
RS
1359 (let ((file-name (file-name-sans-versions (dired-get-filename) t)))
1360 (if (file-exists-p file-name)
53fd9d05 1361 (find-file file-name)
55642aa4
RS
1362 (if (file-symlink-p file-name)
1363 (error "File is a symlink to a nonexistent target")
1364 (error "File no longer exists; type `g' to update Dired buffer")))))
84fc2cfa 1365
c5753a5d
GM
1366(defun dired-find-alternate-file ()
1367 "In dired, visit this file or directory instead of the dired buffer."
1368 (interactive)
1369 (set-buffer-modified-p nil)
1370 (find-alternate-file (dired-get-filename)))
1371
dbcb9389
RS
1372(defun dired-mouse-find-file-other-window (event)
1373 "In dired, visit the file or directory name you click on."
1374 (interactive "e")
1375 (let (file)
1376 (save-excursion
1377 (set-buffer (window-buffer (posn-window (event-end event))))
1378 (save-excursion
1379 (goto-char (posn-point (event-end event)))
1380 (setq file (dired-get-filename))))
1381 (select-window (posn-window (event-end event)))
1382 (find-file-other-window (file-name-sans-versions file t))))
1383
84fc2cfa 1384(defun dired-view-file ()
492d2437
RS
1385 "In dired, examine a file in view mode, returning to dired when done.
1386When file is a directory, show it in this buffer if it is inserted;
1387otherwise, display it in another buffer."
84fc2cfa
ER
1388 (interactive)
1389 (if (file-directory-p (dired-get-filename))
7b2469ae
RS
1390 (or (and (cdr dired-subdir-alist)
1391 (dired-goto-subdir (dired-get-filename)))
492d2437 1392 (dired (dired-get-filename)))
715984d3 1393 (view-file (dired-get-filename))))
84fc2cfa
ER
1394
1395(defun dired-find-file-other-window ()
1396 "In dired, visit this file or directory in another window."
1397 (interactive)
c3554e95 1398 (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
ab67260b
RS
1399
1400(defun dired-display-file ()
1401 "In dired, display this file or directory in another window."
1402 (interactive)
c3554e95
RS
1403 (let ((file (file-name-sans-versions (dired-get-filename) t)))
1404 (display-buffer (find-file-noselect file))))
e95b0c08 1405
492d2437 1406;;; Functions for extracting and manipulating file names in dired buffers.
84fc2cfa
ER
1407
1408(defun dired-get-filename (&optional localp no-error-if-not-filep)
1409 "In dired, return name of file mentioned on this line.
1410Value returned normally includes the directory name.
492d2437 1411Optional arg LOCALP with value `no-dir' means don't include directory
2d795c92
MB
1412 name in result. A value of `verbatim' means to return the name exactly as
1413 it occurs in the buffer, and a value of t means construct name relative to
492d2437
RS
1414 `default-directory', which still may contain slashes if in a subdirectory.
1415Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1416 this line, otherwise an error occurs."
a5e0e1a8 1417 (let (case-fold-search file p1 p2 already-absolute)
84fc2cfa 1418 (save-excursion
492d2437
RS
1419 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1420 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1421 ;; nil if no file on this line, but no-error-if-not-filep is t:
9888aa65
RS
1422 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1423 (progn
1424 ;; Get rid of the mouse-face property that file names have.
1425 (set-text-properties 0 (length file) nil file)
1426 ;; Unquote names quoted by ls or by dired-insert-directory.
1427 ;; Using read to unquote is much faster than substituting
1428 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1429 (setq file
1430 (read
1431 (concat "\""
1432 ;; some ls -b don't escape quotes, argh!
1433 ;; This is not needed for GNU ls, though.
1434 (or (dired-string-replace-match
bc07e5cb 1435 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
9888aa65
RS
1436 file)
1437 "\"")))))
f6e2cbe3 1438 (and file (file-name-absolute-p file)
a5e0e1a8 1439 (setq already-absolute t))
be417b22 1440 (and file buffer-file-coding-system
05dd46c2 1441 (not file-name-coding-system)
0457b5e4 1442 (not default-file-name-coding-system)
be417b22 1443 (setq file (encode-coding-string file buffer-file-coding-system)))
a5e0e1a8 1444 (cond
2d795c92
MB
1445 ((eq localp 'verbatim)
1446 file)
a5e0e1a8
EZ
1447 ((and (eq localp 'no-dir) already-absolute)
1448 (file-name-nondirectory file))
1449 ((or already-absolute (eq localp 'no-dir))
1450 file)
1451 (t
1452 (and file (concat (dired-current-directory localp) file))))))
492d2437 1453
437fe5ae
RS
1454(defun dired-string-replace-match (regexp string newtext
1455 &optional literal global)
1456 "Replace first match of REGEXP in STRING with NEWTEXT.
1457If it does not match, nil is returned instead of the new string.
1458Optional arg LITERAL means to take NEWTEXT literally.
1459Optional arg GLOBAL means to replace all matches."
1460 (if global
b976e099 1461 (let ((start 0) ret)
856321e2
RS
1462 (while (string-match regexp string start)
1463 (let ((from-end (- (length string) (match-end 0))))
b976e099 1464 (setq ret (setq string (replace-match newtext t literal string)))
856321e2 1465 (setq start (- (length string) from-end))))
b976e099 1466 ret)
437fe5ae
RS
1467 (if (not (string-match regexp string 0))
1468 nil
856321e2 1469 (replace-match newtext t literal string))))
437fe5ae 1470
492d2437
RS
1471(defun dired-make-absolute (file &optional dir)
1472 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1473 ;; We can't always use expand-file-name as this would get rid of `.'
1474 ;; or expand in / instead default-directory if DIR=="".
1475 ;; This should be good enough for ange-ftp, but might easily be
1476 ;; redefined (for VMS?).
1477 ;; It should be reasonably fast, though, as it is called in
1478 ;; dired-get-filename.
1479 (concat (or dir default-directory) file))
1480
827dc60d
RS
1481(defun dired-make-relative (file &optional dir ignore)
1482 "Convert FILE (an absolute file name) to a name relative to DIR.
1483If this is impossible, return FILE unchanged.
1484DIR must be a directory name, not a file name."
492d2437 1485 (or dir (setq dir default-directory))
7425bbff
RS
1486 ;; This case comes into play if default-directory is set to
1487 ;; use ~.
1488 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1489 (setq dir (expand-file-name dir)))
492d2437
RS
1490 (if (string-match (concat "^" (regexp-quote dir)) file)
1491 (substring file (match-end 0))
827dc60d
RS
1492;;; (or no-error
1493;;; (error "%s: not in directory tree growing at %s" file dir))
1494 file))
e95b0c08 1495
492d2437
RS
1496;;; Functions for finding the file name in a dired buffer line.
1497
c4a7b2a4 1498(defvar dired-move-to-filename-regexp
2708e59e 1499 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
6a5c00da
PE
1500 ;; In some locales, month abbreviations are as short as 2 letters,
1501 ;; and they can be padded on the right with spaces.
cbcb6160
GM
1502 ;; weiand: changed: month ends potentially with . or , or .,
1503;;old (month (concat l l "+ *"))
1504 (month (concat l l "+[.]?,? *"))
e95b0c08 1505 ;; Recognize any non-ASCII character.
33165c24 1506 ;; The purpose is to match a Kanji character.
2708e59e
RS
1507 (k "[^\0-\177]")
1508 ;; (k "[^\x00-\x7f\x80-\xff]")
32184bdb
PE
1509 (s " ")
1510 (yyyy "[0-9][0-9][0-9][0-9]")
1511 (mm "[ 0-1][0-9]")
cbcb6160
GM
1512;;old (dd "[ 0-3][0-9]")
1513 (dd "[ 0-3][0-9][.]?")
32184bdb 1514 (HH:MM "[ 0-2][0-9]:[0-5][0-9]")
33165c24 1515 (western (concat "\\(" month s dd "\\|" dd s month "\\)"
cbcb6160
GM
1516 ;; weiand: changed: year potentially unaligned
1517;;old s "\\(" HH:MM "\\|" s yyyy "\\|" yyyy s "\\)"))
e95b0c08 1518 s "\\(" HH:MM
b20e965e
GM
1519 "\\|" yyyy s s "?"
1520 "\\|" s "?" yyyy
1521 "\\)"))
501be301 1522 (japanese
5c010e59 1523 (concat mm k s dd k "?" s "+" "\\(" HH:MM "\\|" yyyy k "?" "\\)")))
42afed7c 1524 ;; The "[0-9]" below requires the previous column to end in a digit.
6a5c00da
PE
1525 ;; This avoids recognizing `1 may 1997' as a date in the line:
1526 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
42afed7c
GM
1527 ;; The ".*" below finds the last match if there are multiple matches.
1528 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
02882bbc
RS
1529 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1530 (concat ".*[0-9]" s "\\(" western "\\|" japanese "\\)" s))
6a5c00da 1531 "Regular expression to match up to the file name in a directory listing.
1f97e2fc
PE
1532The default value is designed to recognize dates and times
1533regardless of the language.")
9eabb7d5 1534
23e217f6
RS
1535(defvar dired-permission-flags-regexp
1536 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1537 "Regular expression to match the permission flags in `ls -l'.")
1538
492d2437
RS
1539;; Move to first char of filename on this line.
1540;; Returns position (point) or nil if no filename on this line."
1541(defun dired-move-to-filename (&optional raise-error eol)
1542 ;; This is the UNIX version.
1543 (or eol (setq eol (progn (end-of-line) (point))))
1544 (beginning-of-line)
d90490d8
RS
1545 (if (re-search-forward dired-move-to-filename-regexp eol t)
1546 (goto-char (match-end 0))
1547 (if raise-error
1548 (error "No file on this line"))))
492d2437
RS
1549
1550(defun dired-move-to-end-of-filename (&optional no-error)
1551 ;; Assumes point is at beginning of filename,
1552 ;; thus the rwx bit re-search-backward below will succeed in *this*
1553 ;; line if at all. So, it should be called only after
1554 ;; (dired-move-to-filename t).
1555 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1556 ;; This is the UNIX version.
1557 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1558 ;; case-fold-search is nil now, so we can test for capital F:
1559 (setq used-F (string-match "F" dired-actual-switches)
1560 opoint (point)
1561 eol (save-excursion (end-of-line) (point))
1562 hidden (and selective-display
1563 (save-excursion (search-forward "\r" eol t))))
1564 (if hidden
1565 nil
1566 (save-excursion;; Find out what kind of file this is:
1567 ;; Restrict perm bits to be non-blank,
1568 ;; otherwise this matches one char to early (looking backward):
1569 ;; "l---------" (some systems make symlinks that way)
1570 ;; "----------" (plain file with zero perms)
1571 (if (re-search-backward
23e217f6 1572 dired-permission-flags-regexp nil t)
492d2437
RS
1573 (setq file-type (char-after (match-beginning 1))
1574 symlink (eq file-type ?l)
1575 ;; Only with -F we need to know whether it's an executable
1576 executable (and
1577 used-F
1578 (string-match
1579 "[xst]";; execute bit set anywhere?
1580 (concat
1581 (buffer-substring (match-beginning 2)
1582 (match-end 2))
1583 (buffer-substring (match-beginning 3)
1584 (match-end 3))
1585 (buffer-substring (match-beginning 4)
1586 (match-end 4))))))
1587 (or no-error (error "No file on this line"))))
1588 ;; Move point to end of name:
1589 (if symlink
1590 (if (search-forward " ->" eol t)
1591 (progn
1592 (forward-char -3)
1593 (and used-F
1594 dired-ls-F-marks-symlinks
1595 (eq (preceding-char) ?@);; did ls really mark the link?
1596 (forward-char -1))))
1597 (goto-char eol);; else not a symbolic link
1598 ;; ls -lF marks dirs, sockets and executables with exactly one
1599 ;; trailing character. (Executable bits on symlinks ain't mean
1600 ;; a thing, even to ls, but we know it's not a symlink.)
1601 (and used-F
1602 (or (memq file-type '(?d ?s))
1603 executable)
1604 (forward-char -1))))
1605 (or no-error
1606 (not (eq opoint (point)))
1607 (error (if hidden
1608 (substitute-command-keys
1609 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1610 "No file on this line")))
1611 (if (eq opoint (point))
1612 nil
1613 (point))))
1614
e95b0c08 1615
492d2437
RS
1616;; Keeping Dired buffers in sync with the filesystem and with each other
1617
ef746164 1618(defun dired-buffers-for-dir (dir &optional file)
492d2437 1619;; Return a list of buffers that dired DIR (top level or in-situ subdir).
ef746164
RS
1620;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1621;; matches FILE.
492d2437
RS
1622;; The list is in reverse order of buffer creation, most recent last.
1623;; As a side effect, killed dired buffers for DIR are removed from
1624;; dired-buffers.
1625 (setq dir (file-name-as-directory dir))
ef746164 1626 (let ((alist dired-buffers) result elt buf pattern)
492d2437 1627 (while alist
38819778
RS
1628 (setq elt (car alist)
1629 buf (cdr elt))
1630 (if (buffer-name buf)
1631 (if (dired-in-this-tree dir (car elt))
ef746164
RS
1632 (with-current-buffer buf
1633 (and (assoc dir dired-subdir-alist)
1634 (or (null file)
1635 (let ((wildcards
1636 (file-name-nondirectory dired-directory)))
1637 (or (= 0 (length wildcards))
1638 (string-match (dired-glob-regexp wildcards)
1639 file))))
1640 (setq result (cons buf result)))))
38819778
RS
1641 ;; else buffer is killed - clean up:
1642 (setq dired-buffers (delq elt dired-buffers)))
492d2437
RS
1643 (setq alist (cdr alist)))
1644 result))
1645
ef746164
RS
1646(defun dired-glob-regexp (pattern)
1647 "Convert glob-pattern PATTERN to a regular expression."
1648 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1649 regexp)
1650 (while (string-match "[[?*]" pattern matched-in-pattern)
1651 (let ((op-end (match-end 0))
1652 (next-op (aref pattern (match-beginning 0))))
1653 (setq regexp (concat regexp
1654 (regexp-quote
1655 (substring pattern matched-in-pattern
1656 (match-beginning 0)))))
1657 (cond ((= next-op ??)
1658 (setq regexp (concat regexp "."))
1659 (setq matched-in-pattern op-end))
1660 ((= next-op ?\[)
1661 ;; Fails to handle ^ yet ????
1662 (let* ((set-start (match-beginning 0))
1663 (set-cont
1664 (if (= (aref pattern (1+ set-start)) ?^)
1665 (+ 3 set-start)
1666 (+ 2 set-start)))
1667 (set-end (string-match "]" pattern set-cont))
1668 (set (substring pattern set-start (1+ set-end))))
1669 (setq regexp (concat regexp set))
1670 (setq matched-in-pattern (1+ set-end))))
1671 ((= next-op ?*)
1672 (setq regexp (concat regexp ".*"))
1673 (setq matched-in-pattern op-end)))))
1674 (concat "\\`"
1675 regexp
1676 (regexp-quote
1677 (substring pattern matched-in-pattern))
1678 "\\'")))
1679
e95b0c08 1680
ef746164 1681
492d2437
RS
1682(defun dired-advertise ()
1683 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1684 ;; With wildcards we actually advertise too much.
38819778
RS
1685 (let ((expanded-default (expand-file-name default-directory)))
1686 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1687 t ; we have already advertised ourselves
1688 (setq dired-buffers
1689 (cons (cons expanded-default (current-buffer))
1690 dired-buffers)))))
492d2437
RS
1691
1692(defun dired-unadvertise (dir)
1693 ;; Remove DIR from the buffer alist in variable dired-buffers.
1694 ;; This has the effect of removing any buffer whose main directory is DIR.
1695 ;; It does not affect buffers in which DIR is a subdir.
1696 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1697 (setq dired-buffers
38819778 1698 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
e95b0c08 1699
492d2437
RS
1700;; Tree Dired
1701
1702;;; utility functions
1703
1704(defun dired-in-this-tree (file dir)
1705 ;;"Is FILE part of the directory tree starting at DIR?"
1706 (let (case-fold-search)
38819778 1707 (string-match (concat "^" (regexp-quote dir)) file)))
492d2437
RS
1708
1709(defun dired-normalize-subdir (dir)
1710 ;; Prepend default-directory to DIR if relative path name.
1711 ;; dired-get-filename must be able to make a valid filename from a
1712 ;; file and its directory DIR.
1713 (file-name-as-directory
1714 (if (file-name-absolute-p dir)
1715 dir
1716 (expand-file-name dir default-directory))))
1717
1718(defun dired-get-subdir ()
1719 ;;"Return the subdir name on this line, or nil if not on a headerline."
1720 ;; Look up in the alist whether this is a headerline.
1721 (save-excursion
1722 (let ((cur-dir (dired-current-directory)))
1723 (beginning-of-line) ; alist stores b-o-l positions
1724 (and (zerop (- (point)
1725 (dired-get-subdir-min (assoc cur-dir
1726 dired-subdir-alist))))
1727 cur-dir))))
1728
1729;(defun dired-get-subdir-min (elt)
1730; (cdr elt))
1731;; can't use macro, must be redefinable for other alist format in dired-nstd.
62f61df0 1732(defalias 'dired-get-subdir-min 'cdr)
492d2437
RS
1733
1734(defun dired-get-subdir-max (elt)
84fc2cfa 1735 (save-excursion
492d2437
RS
1736 (goto-char (dired-get-subdir-min elt))
1737 (dired-subdir-max)))
1738
1739(defun dired-clear-alist ()
1740 (while dired-subdir-alist
1741 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1742 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1743
c9d59fc2
RS
1744(defun dired-subdir-index (dir)
1745 ;; Return an index into alist for use with nth
1746 ;; for the sake of subdir moving commands.
1747 (let (found (index 0) (alist dired-subdir-alist))
1748 (while alist
1749 (if (string= dir (car (car alist)))
1750 (setq alist nil found t)
1751 (setq alist (cdr alist) index (1+ index))))
1752 (if found index nil)))
1753
1754(defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1755 "Go to next subdirectory, regardless of level."
1756 ;; Use 0 arg to go to this directory's header line.
1757 ;; NO-SKIP prevents moving to end of header line, returning whatever
1758 ;; position was found in dired-subdir-alist.
1759 (interactive "p")
1760 (let ((this-dir (dired-current-directory))
1761 pos index)
1762 ;; nth with negative arg does not return nil but the first element
1763 (setq index (- (dired-subdir-index this-dir) arg))
1764 (setq pos (if (>= index 0)
1765 (dired-get-subdir-min (nth index dired-subdir-alist))))
1766 (if pos
1767 (progn
1768 (goto-char pos)
1769 (or no-skip (skip-chars-forward "^\n\r"))
1770 (point))
1771 (if no-error-if-not-found
1772 nil ; return nil if not found
1773 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1774
492d2437
RS
1775(defun dired-build-subdir-alist ()
1776 "Build `dired-subdir-alist' by parsing the buffer.
1777Returns the new value of the alist."
1778 (interactive)
1779 (dired-clear-alist)
1780 (save-excursion
3222085e
BF
1781 (let ((count 0)
1782 (buffer-read-only nil)
b4c01776
GM
1783 new-dir-name
1784 (R-ftp-base-dir-regex
1785 ;; Used to expand subdirectory names correctly in recursive
1786 ;; ange-ftp listings.
1787 (and (string-match "R" dired-actual-switches)
1788 (string-match "\\`/.*:\\(/.*\\)" default-directory)
1789 (concat "\\`" (match-string 1 default-directory)))))
84fc2cfa 1790 (goto-char (point-min))
492d2437 1791 (setq dired-subdir-alist nil)
acf310c9
RS
1792 (while (and (re-search-forward dired-subdir-regexp nil t)
1793 ;; Avoid taking a file name ending in a colon
1794 ;; as a subdir name.
1795 (not (save-excursion
1796 (goto-char (match-beginning 0))
1797 (beginning-of-line)
1798 (forward-char 2)
46680faf 1799 (save-match-data (looking-at dired-re-perms)))))
3222085e
BF
1800 (save-excursion
1801 (goto-char (match-beginning 1))
1802 (setq new-dir-name
b4c01776
GM
1803 (buffer-substring-no-properties (point) (match-end 1))
1804 new-dir-name
1805 (save-match-data
1806 (if (and R-ftp-base-dir-regex
1807 (not (string= new-dir-name default-directory))
1808 (string-match R-ftp-base-dir-regex new-dir-name))
1809 (concat default-directory
1810 (substring new-dir-name (match-end 0)))
1811 (expand-file-name new-dir-name))))
3222085e
BF
1812 (delete-region (point) (match-end 1))
1813 (insert new-dir-name))
492d2437 1814 (setq count (1+ count))
3222085e
BF
1815 (dired-alist-add-1 new-dir-name
1816 ;; Place a sub directory boundary between lines.
1817 (save-excursion
1818 (goto-char (match-beginning 0))
1819 (beginning-of-line)
1820 (point-marker))))
c9d59fc2
RS
1821 (if (> count 1)
1822 (message "Buffer includes %d directories" count))
492d2437
RS
1823 ;; We don't need to sort it because it is in buffer order per
1824 ;; constructionem. Return new alist:
1825 dired-subdir-alist)))
1826
1827(defun dired-alist-add-1 (dir new-marker)
1828 ;; Add new DIR at NEW-MARKER. Don't sort.
1829 (setq dired-subdir-alist
1830 (cons (cons (dired-normalize-subdir dir) new-marker)
1831 dired-subdir-alist)))
1832
1833(defun dired-goto-next-nontrivial-file ()
1834 ;; Position point on first nontrivial file after point.
1835 (dired-goto-next-file);; so there is a file to compare with
1836 (if (stringp dired-trivial-filenames)
1837 (while (and (not (eobp))
1838 (string-match dired-trivial-filenames
1839 (file-name-nondirectory
1840 (or (dired-get-filename nil t) ""))))
1841 (forward-line 1)
1842 (dired-move-to-filename))))
1843
1844(defun dired-goto-next-file ()
1845 (let ((max (1- (dired-subdir-max))))
1846 (while (and (not (dired-move-to-filename)) (< (point) max))
1847 (forward-line 1))))
1848
1849(defun dired-goto-file (file)
1850 "Go to file line of FILE in this dired buffer."
1851 ;; Return value of point on success, else nil.
1852 ;; FILE must be an absolute pathname.
1853 ;; Loses if FILE contains control chars like "\007" for which ls
1854 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1855 ;; it in the buffer.
1856 (interactive
1857 (prog1 ; let push-mark display its message
1858 (list (expand-file-name
1859 (read-file-name "Goto file: "
1860 (dired-current-directory))))
1861 (push-mark)))
1862 (setq file (directory-file-name file)) ; does no harm if no directory
1863 (let (found case-fold-search dir)
1864 (setq dir (or (file-name-directory file)
1865 (error "Need absolute pathname for %s" file)))
1866 (save-excursion
1867 ;; The hair here is to get the result of dired-goto-subdir
1868 ;; without really calling it if we don't have any subdirs.
233993a3 1869 (if (if (string= dir (expand-file-name default-directory))
492d2437 1870 (goto-char (point-min))
7b2469ae 1871 (and (cdr dired-subdir-alist)
492d2437
RS
1872 (dired-goto-subdir dir)))
1873 (let ((base (file-name-nondirectory file))
1874 (boundary (dired-subdir-max)))
1875 (while (and (not found)
1876 ;; filenames are preceded by SPC, this makes
1877 ;; the search faster (e.g. for the filename "-"!).
1878 (search-forward (concat " " base) boundary 'move))
1879 ;; Match could have BASE just as initial substring or
1880 ;; or in permission bits or date or
1881 ;; not be a proper filename at all:
1882 (if (equal base (dired-get-filename 'no-dir t))
1883 ;; Must move to filename since an (actually
1884 ;; correct) match could have been elsewhere on the
1885 ;; ;; line (e.g. "-" would match somewhere in the
1886 ;; permission bits).
55e86af6
RS
1887 (setq found (dired-move-to-filename))
1888 ;; If this isn't the right line, move forward to avoid
1889 ;; trying this line again.
1890 (forward-line 1))))))
492d2437
RS
1891 (and found
1892 ;; return value of point (i.e., FOUND):
1893 (goto-char found))))
1894
1895(defun dired-initial-position (dirname)
1896 ;; Where point should go in a new listing of DIRNAME.
1897 ;; Point assumed at beginning of new subdir line.
1898 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1899 (end-of-line)
1900 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
e95b0c08 1901
492d2437
RS
1902;; These are hooks which make tree dired work.
1903;; They are in this file because other parts of dired need to call them.
1904;; But they don't call the rest of tree dired unless there are subdirs loaded.
1905
1906;; This function is called for each retrieved filename.
1907;; It could stand to be faster, though it's mostly function call
1908;; overhead. Avoiding the function call seems to save about 10% in
1909;; dired-get-filename. Make it a defsubst?
1910(defun dired-current-directory (&optional localp)
1911 "Return the name of the subdirectory to which this line belongs.
1912This returns a string with trailing slash, like `default-directory'.
1913Optional argument means return a file name relative to `default-directory'."
1914 (let ((here (point))
1915 (alist (or dired-subdir-alist
1916 ;; probably because called in a non-dired buffer
1917 (error "No subdir-alist in %s" (current-buffer))))
1918 elt dir)
1919 (while alist
1920 (setq elt (car alist)
1921 dir (car elt)
1922 ;; use `<=' (not `<') as subdir line is part of subdir
1923 alist (if (<= (dired-get-subdir-min elt) here)
1924 nil ; found
1925 (cdr alist))))
1926 (if localp
1927 (dired-make-relative dir default-directory)
1928 dir)))
1929
1930;; Subdirs start at the beginning of their header lines and end just
1931;; before the beginning of the next header line (or end of buffer).
1932
1933(defun dired-subdir-max ()
1934 (save-excursion
7b2469ae 1935 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
492d2437
RS
1936 (point-max)
1937 (point))))
e95b0c08 1938
492d2437
RS
1939;; Deleting files
1940
f0628026
RS
1941(defcustom dired-recursive-deletes nil ; Default only delete empty directories.
1942 "*Decide whether recursive deletes are allowed.
1943Nil means no recursive deletes.
1944`always' means delete recursively without asking. This is DANGEROUS!
1945`top' means ask for each directory at top level, but delete its subdirectories
1946without asking.
1947Anything else means ask for each directory."
1948 :type '(choice :tag "Delete not empty directory"
1949 (const :tag "No. Only empty directories" nil)
1950 (const :tag "Ask for each directory" t)
1951 (const :tag "Ask for each top directory only" top))
1952 :group 'dired)
1953
e95b0c08 1954;; Match anything but `.' and `..'.
f0628026
RS
1955(defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
1956
1957;; Delete file, possibly delete a directory and all its files.
1958;; This function is usefull outside of dired. One could change it's name
1959;; to e.g. recursive-delete-file and put it somewhere else.
1960(defun dired-delete-file (file &optional recursive) "\
1961Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
1962RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
1963Nil, do not delete.
1964`always', delete recursively without asking.
1965`top', ask for each directory at top level.
1966Anything else, ask for each sub-directory."
1967 (let (files)
1968 ;; This test is equivalent to
1969 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1970 ;; but more efficient
1971 (if (not (eq t (car (file-attributes file))))
1972 (delete-file file)
1973 (when (and recursive
1974 (setq files
1975 (directory-files file t dired-re-no-dot)) ; Not empty.
1976 (or (eq recursive 'always)
1977 (yes-or-no-p (format "Recursive delete of %s "
1978 (dired-make-relative file)))))
1979 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
1980 (while files ; Recursively delete (possibly asking).
1981 (dired-delete-file (car files) recursive)
1982 (setq files (cdr files))))
1983 (delete-directory file))))
1984
7da0e9b4
RS
1985(defun dired-do-flagged-delete (&optional nomessage)
1986 "In dired, delete the files flagged for deletion.
1987If NOMESSAGE is non-nil, we don't display any message
1988if there are no flagged files."
492d2437
RS
1989 (interactive)
1990 (let* ((dired-marker-char dired-del-marker)
1991 (regexp (dired-marker-regexp))
1992 case-fold-search)
1993 (if (save-excursion (goto-char (point-min))
1994 (re-search-forward regexp nil t))
1995 (dired-internal-do-deletions
1996 ;; this can't move point since ARG is nil
1997 (dired-map-over-marks (cons (dired-get-filename) (point))
1998 nil)
1999 nil)
7da0e9b4
RS
2000 (or nomessage
2001 (message "(No deletions requested)")))))
492d2437
RS
2002
2003(defun dired-do-delete (&optional arg)
2004 "Delete all marked (or next ARG) files."
2005 ;; This is more consistent with the file marking feature than
2006 ;; dired-do-flagged-delete.
2007 (interactive "P")
2008 (dired-internal-do-deletions
2009 ;; this may move point if ARG is an integer
2010 (dired-map-over-marks (cons (dired-get-filename) (point))
2011 arg)
2012 arg))
2013
2014(defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2015
2016(defun dired-internal-do-deletions (l arg)
2017 ;; L is an alist of files to delete, with their buffer positions.
2018 ;; ARG is the prefix arg.
2019 ;; Filenames are absolute (VMS needs this for logical search paths).
2020 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2021 ;; That way as changes are made in the buffer they do not shift the
2022 ;; lines still to be changed, so the (point) values in L stay valid.
2023 ;; Also, for subdirs in natural order, a subdir's files are deleted
2024 ;; before the subdir itself - the other way around would not work.
2025 (let ((files (mapcar (function car) l))
2026 (count (length l))
2027 (succ 0))
2028 ;; canonicalize file list for pop up
2029 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2030 (if (dired-mark-pop-up
2031 " *Deletions*" 'delete files dired-deletion-confirmer
2032 (format "Delete %s " (dired-mark-prompt arg files)))
84fc2cfa 2033 (save-excursion
492d2437
RS
2034 (let (failures);; files better be in reverse order for this loop!
2035 (while l
2036 (goto-char (cdr (car l)))
2037 (let (buffer-read-only)
2038 (condition-case err
2039 (let ((fn (car (car l))))
f0628026 2040 (dired-delete-file fn dired-recursive-deletes)
492d2437
RS
2041 ;; if we get here, removing worked
2042 (setq succ (1+ succ))
2043 (message "%s of %s deletions" succ count)
2044 (delete-region (progn (beginning-of-line) (point))
2045 (progn (forward-line 1) (point)))
2046 (dired-clean-up-after-deletion fn))
2047 (error;; catch errors from failed deletions
2048 (dired-log "%s\n" err)
2049 (setq failures (cons (car (car l)) failures)))))
2050 (setq l (cdr l)))
2051 (if (not failures)
2052 (message "%d deletion%s done" count (dired-plural-s count))
2053 (dired-log-summary
2054 (format "%d of %d deletion%s failed"
2055 (length failures) count
2056 (dired-plural-s count))
2057 failures))))
2058 (message "(No deletions performed)")))
2059 (dired-move-to-filename))
2060
2061;; This is a separate function for the sake of dired-x.el.
2062(defun dired-clean-up-after-deletion (fn)
2063 ;; Clean up after a deleted file or directory FN.
7b2469ae
RS
2064 (save-excursion (and (cdr dired-subdir-alist)
2065 (dired-goto-subdir fn)
492d2437 2066 (dired-kill-subdir))))
e95b0c08 2067
492d2437
RS
2068;; Confirmation
2069
2070(defun dired-marker-regexp ()
2071 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2072
2073(defun dired-plural-s (count)
2074 (if (= 1 count) "" "s"))
2075
2076(defun dired-mark-prompt (arg files)
2077 ;; Return a string for use in a prompt, either the current file
2078 ;; name, or the marker and a count of marked files.
2079 (let ((count (length files)))
2080 (if (= count 1)
2081 (car files)
2082 ;; more than 1 file:
2083 (if (integerp arg)
2084 ;; abs(arg) = count
2085 ;; Perhaps this is nicer, but it also takes more screen space:
2086 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2087 ;; count)
2088 (format "[next %d files]" arg)
2089 (format "%c [%d files]" dired-marker-char count)))))
2090
2091(defun dired-pop-to-buffer (buf)
2092 ;; Pop up buffer BUF.
2093 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2094 (if (not dired-shrink-to-fit)
2095 (pop-to-buffer (get-buffer-create buf))
2096 ;; let window shrink to fit:
2097 (let ((window (selected-window))
2098 target-lines w2)
2099 (cond ;; if split-window-threshold is enabled, use the largest window
2100 ((and (> (window-height (setq w2 (get-largest-window)))
2101 split-height-threshold)
f98955ea 2102 (= (frame-width) (window-width w2)))
492d2437
RS
2103 (setq window w2))
2104 ;; if the least-recently-used window is big enough, use it
2105 ((and (> (window-height (setq w2 (get-lru-window)))
2106 (* 2 window-min-height))
f98955ea 2107 (= (frame-width) (window-width w2)))
492d2437
RS
2108 (setq window w2)))
2109 (save-excursion
2110 (set-buffer buf)
2111 (goto-char (point-max))
2112 (skip-chars-backward "\n\r\t ")
63ea14a5
RS
2113 (setq target-lines (count-lines (point-min) (point)))
2114 ;; Don't forget to count the last line.
2115 (if (not (bolp))
2116 (setq target-lines (1+ target-lines))))
492d2437 2117 (if (<= (window-height window) (* 2 window-min-height))
f98955ea 2118 ;; At this point, every window on the frame is too small to split.
492d2437
RS
2119 (setq w2 (display-buffer buf))
2120 (setq w2 (split-window window
2121 (max window-min-height
2122 (- (window-height window)
2123 (1+ (max window-min-height target-lines)))))))
2124 (set-window-buffer w2 buf)
2125 (if (< (1- (window-height w2)) target-lines)
2126 (progn
2127 (select-window w2)
2128 (enlarge-window (- target-lines (1- (window-height w2))))))
2129 (set-window-start w2 1)
2130 )))
2131
2132(defvar dired-no-confirm nil
0347d069
SM
2133 "A list of symbols for commands dired should not confirm.
2134Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2135`copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink' and
2136`uncompress'.")
492d2437
RS
2137
2138(defun dired-mark-pop-up (bufname op-symbol files function &rest args)
89101e46
SM
2139 "Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
2140Return FUNCTION's result on ARGS after popping up a window (in a buffer
2141named BUFNAME, nil gives \" *Marked Files*\") showing the marked
2142files. Uses function `dired-pop-to-buffer' to do that.
2143 FUNCTION should not manipulate files.
2144 It should only read input (an argument or confirmation).
2145The window is not shown if there is just one file or
2146 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2147FILES is the list of marked files."
492d2437 2148 (or bufname (setq bufname " *Marked Files*"))
0347d069
SM
2149 (if (or (eq dired-no-confirm t)
2150 (memq op-symbol dired-no-confirm)
492d2437
RS
2151 (= (length files) 1))
2152 (apply function args)
89101e46 2153 (with-current-buffer (get-buffer-create bufname)
492d2437 2154 (erase-buffer)
a07e7c4a
RS
2155 (dired-format-columns-of-files files)
2156 (remove-text-properties (point-min) (point-max) '(mouse-face)))
492d2437
RS
2157 (save-window-excursion
2158 (dired-pop-to-buffer bufname)
2159 (apply function args))))
2160
2161(defun dired-format-columns-of-files (files)
2162 ;; Files should be in forward order for this loop.
2163 ;; i.e., (car files) = first file in buffer.
2164 ;; Returns the number of lines used.
2165 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2166 (width (- (window-width (selected-window)) 2))
2167 (columns (max 1 (/ width maxlen)))
2168 (nfiles (length files))
2169 (rows (+ (/ nfiles columns)
2170 (if (zerop (% nfiles columns)) 0 1)))
2171 (i 0)
2172 (j 0))
2173 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2174 (make-list (- (* columns rows) nfiles) "")))
2175 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2176 (while (< j rows)
2177 (while (< i columns)
2178 (indent-to (* i maxlen))
2179 (insert (car files))
2180 (setq files (nthcdr rows files)
2181 i (1+ i)))
2182 (insert "\n")
2183 (setq i 0
2184 j (1+ j)
2185 files (cdr files)))
2186 rows))
e95b0c08 2187
492d2437
RS
2188;; Commands to mark or flag file(s) at or near current line.
2189
2190(defun dired-repeat-over-lines (arg function)
2191 ;; This version skips non-file lines.
cfe89c4f 2192 (let ((pos (make-marker)))
492d2437 2193 (beginning-of-line)
cfe89c4f
RS
2194 (while (and (> arg 0) (not (eobp)))
2195 (setq arg (1- arg))
2196 (beginning-of-line)
2197 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2198 (save-excursion
2199 (forward-line 1)
2200 (move-marker pos (1+ (point))))
2201 (save-excursion (funcall function))
2202 ;; Advance to the next line--actually, to the line that *was* next.
2203 ;; (If FUNCTION inserted some new lines in between, skip them.)
2204 (goto-char pos))
2205 (while (and (< arg 0) (not (bobp)))
2206 (setq arg (1+ arg))
2207 (forward-line -1)
2208 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2209 (beginning-of-line)
2210 (save-excursion (funcall function)))
2211 (move-marker pos nil)
2212 (dired-move-to-filename)))
492d2437
RS
2213
2214(defun dired-between-files ()
2215 ;; Point must be at beginning of line
2216 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
2217 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
7b01b08c 2218 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard\\|^. used\\|^. find")
a8004e4b
RS
2219 (and (looking-at dired-subdir-regexp)
2220 (save-excursion (not (dired-move-to-filename))))))
492d2437
RS
2221
2222(defun dired-next-marked-file (arg &optional wrap opoint)
2223 "Move to the next marked file, wrapping around the end of the buffer."
2224 (interactive "p\np")
2225 (or opoint (setq opoint (point)));; return to where interactively started
2226 (if (if (> arg 0)
2227 (re-search-forward dired-re-mark nil t arg)
2228 (beginning-of-line)
2229 (re-search-backward dired-re-mark nil t (- arg)))
2230 (dired-move-to-filename)
2231 (if (null wrap)
2232 (progn
2233 (goto-char opoint)
2234 (error "No next marked file"))
2235 (message "(Wraparound for next marked file)")
2236 (goto-char (if (> arg 0) (point-min) (point-max)))
2237 (dired-next-marked-file arg nil opoint))))
2238
2239(defun dired-prev-marked-file (arg &optional wrap)
2240 "Move to the previous marked file, wrapping around the end of the buffer."
2241 (interactive "p\np")
2242 (dired-next-marked-file (- arg) wrap))
2243
2244(defun dired-file-marker (file)
2245 ;; Return FILE's marker, or nil if unmarked.
2246 (save-excursion
2247 (and (dired-goto-file file)
2248 (progn
2249 (beginning-of-line)
2250 (if (not (equal ?\040 (following-char)))
2251 (following-char))))))
2252
2253(defun dired-mark-files-in-region (start end)
2254 (let (buffer-read-only)
2255 (if (> start end)
2256 (error "start > end"))
2257 (goto-char start) ; assumed at beginning of line
2258 (while (< (point) end)
2259 ;; Skip subdir line and following garbage like the `total' line:
2260 (while (and (< (point) end) (dired-between-files))
2261 (forward-line 1))
2262 (if (and (not (looking-at dired-re-dot))
2263 (dired-get-filename nil t))
2264 (progn
2265 (delete-char 1)
2266 (insert dired-marker-char)))
2267 (forward-line 1))))
2268
2269(defun dired-mark (arg)
2270 "Mark the current (or next ARG) files.
2271If on a subdir headerline, mark all its files except `.' and `..'.
2272
2273Use \\[dired-unmark-all-files] to remove all marks
2274and \\[dired-unmark] on a subdir to remove the marks in
2275this subdir."
2276 (interactive "P")
277568f2 2277 (if (dired-get-subdir)
492d2437
RS
2278 (save-excursion (dired-mark-subdir-files))
2279 (let (buffer-read-only)
2280 (dired-repeat-over-lines
52041219 2281 (prefix-numeric-value arg)
492d2437
RS
2282 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2283
2284(defun dired-unmark (arg)
2285 "Unmark the current (or next ARG) files.
2286If looking at a subdir, unmark all its files except `.' and `..'."
2287 (interactive "P")
2288 (let ((dired-marker-char ?\040))
2289 (dired-mark arg)))
2290
2291(defun dired-flag-file-deletion (arg)
2292 "In dired, flag the current line's file for deletion.
2293With prefix arg, repeat over several lines.
2294
2295If on a subdir headerline, mark all its files except `.' and `..'."
2296 (interactive "P")
2297 (let ((dired-marker-char dired-del-marker))
2298 (dired-mark arg)))
2299
2300(defun dired-unmark-backward (arg)
2301 "In dired, move up lines and remove deletion flag there.
2302Optional prefix ARG says how many lines to unflag; default is one line."
2303 (interactive "p")
2304 (dired-unmark (- arg)))
e5f0841e
KH
2305
2306(defun dired-do-toggle ()
2307 "Toggle marks.
2308That is, currently marked files become unmarked and vice versa.
2309Files marked with other flags (such as `D') are not affected.
2310`.' and `..' are never toggled.
2311As always, hidden subdirs are not affected."
2312 (interactive)
2313 (save-excursion
2314 (goto-char (point-min))
2315 (let (buffer-read-only)
2316 (while (not (eobp))
2317 (or (dired-between-files)
2318 (looking-at dired-re-dot)
2319 ;; use subst instead of insdel because it does not move
2320 ;; the gap and thus should be faster and because
2321 ;; other characters are left alone automatically
2322 (apply 'subst-char-in-region
2323 (point) (1+ (point))
2324 (if (eq ?\040 (following-char)) ; SPC
2325 (list ?\040 dired-marker-char)
2326 (list dired-marker-char ?\040))))
2327 (forward-line 1)))))
e95b0c08 2328
492d2437
RS
2329;;; Commands to mark or flag files based on their characteristics or names.
2330
d2cadc4b
RS
2331(defvar dired-regexp-history nil
2332 "History list of regular expressions used in Dired commands.")
2333
2334(defun dired-read-regexp (prompt)
2335 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
492d2437
RS
2336
2337(defun dired-mark-files-regexp (regexp &optional marker-char)
2338 "Mark all files matching REGEXP for use in later commands.
2339A prefix argument means to unmark them instead.
2340`.' and `..' are never marked.
2341
2342REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2343object files--just `.o' will mark more than you might think."
2344 (interactive
2345 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2346 " files (regexp): "))
2347 (if current-prefix-arg ?\040)))
2348 (let ((dired-marker-char (or marker-char dired-marker-char)))
2349 (dired-mark-if
2350 (and (not (looking-at dired-re-dot))
2351 (not (eolp)) ; empty line
2352 (let ((fn (dired-get-filename nil t)))
2353 (and fn (string-match regexp (file-name-nondirectory fn)))))
2354 "matching file")))
2355
e9b8e22d
RS
2356(defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2357 "Mark all files with contents containing REGEXP for use in later commands.
2358A prefix argument means to unmark them instead.
2359`.' and `..' are never marked."
2360 (interactive
2361 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2362 " files containing (regexp): "))
2363 (if current-prefix-arg ?\040)))
2364 (let ((dired-marker-char (or marker-char dired-marker-char)))
2365 (dired-mark-if
2366 (and (not (looking-at dired-re-dot))
2367 (not (eolp)) ; empty line
2368 (let ((fn (dired-get-filename nil t)))
05a40373
KH
2369 (when (and fn (file-readable-p fn)
2370 (not (file-directory-p fn)))
2371 (let ((prebuf (get-file-buffer fn)))
2372 (message "Checking %s" fn)
2373 ;; For now we do it inside emacs
2374 ;; Grep might be better if there are a lot of files
2375 (if prebuf
2376 (with-current-buffer prebuf
2377 (save-excursion
2378 (goto-char (point-min))
2379 (re-search-forward regexp nil t)))
2380 (with-temp-buffer
2381 (insert-file-contents fn)
2382 (goto-char (point-min))
2383 (re-search-forward regexp nil t))))
0b2bb4d0 2384 )))
e9b8e22d
RS
2385 "matching file")))
2386
492d2437
RS
2387(defun dired-flag-files-regexp (regexp)
2388 "In dired, flag all files containing the specified REGEXP for deletion.
2389The match is against the non-directory part of the filename. Use `^'
2390 and `$' to anchor matches. Exclude subdirs by hiding them.
2391`.' and `..' are never flagged."
2392 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2393 (dired-mark-files-regexp regexp dired-del-marker))
2394
2395(defun dired-mark-symlinks (unflag-p)
2396 "Mark all symbolic links.
2397With prefix argument, unflag all those files."
2398 (interactive "P")
2399 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2400 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2401
2402(defun dired-mark-directories (unflag-p)
2403 "Mark all directory file lines except `.' and `..'.
2404With prefix argument, unflag all those files."
2405 (interactive "P")
2406 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2407 (dired-mark-if (and (looking-at dired-re-dir)
2408 (not (looking-at dired-re-dot)))
2409 "directory file")))
2410
2411(defun dired-mark-executables (unflag-p)
2412 "Mark all executable files.
2413With prefix argument, unflag all those files."
2414 (interactive "P")
2415 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2416 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2417
2418;; dired-x.el has a dired-mark-sexp interactive command: mark
2419;; files for which PREDICATE returns non-nil.
2420
2421(defun dired-flag-auto-save-files (&optional unflag-p)
84fc2cfa
ER
2422 "Flag for deletion files whose names suggest they are auto save files.
2423A prefix argument says to unflag those files instead."
2424 (interactive "P")
492d2437
RS
2425 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2426 (dired-mark-if
2a838614 2427 ;; It is less than general to check for # here,
a91526b9
RS
2428 ;; but it's the only way this runs fast enough.
2429 (and (save-excursion (end-of-line)
536ae2dd
RS
2430 (or
2431 (eq (preceding-char) ?#)
2432 ;; Handle executables in case of -F option.
2433 ;; We need not worry about the other kinds
2434 ;; of markings that -F makes, since they won't
2435 ;; appear on real auto-save files.
2436 (if (eq (preceding-char) ?*)
2437 (progn
2438 (forward-char -1)
2439 (eq (preceding-char) ?#)))))
a91526b9
RS
2440 (not (looking-at dired-re-dir))
2441 (let ((fn (dired-get-filename t t)))
2442 (if fn (auto-save-file-name-p
2443 (file-name-nondirectory fn)))))
2444 "auto save file")))
492d2437 2445
84d3f6e8 2446(defvar dired-garbage-files-regexp
e95b0c08 2447 "\\.log$\\|\\.toc$\\|\\.dvi$\\|\\.bak$\\|\\.orig$\\|\\.rej$"
84d3f6e8
RS
2448 "*Regular expression to match \"garbage\" files for `dired-flag-garbage-files'.")
2449
2450(defun dired-flag-garbage-files ()
84d3f6e8 2451 "Flag for deletion all files that match `dired-garbage-files-regexp'."
f656ec48 2452 (interactive)
84d3f6e8
RS
2453 (dired-flag-files-regexp dired-garbage-files-regexp))
2454
492d2437
RS
2455(defun dired-flag-backup-files (&optional unflag-p)
2456 "Flag all backup files (names ending with `~') for deletion.
2457With prefix argument, unflag these files."
2458 (interactive "P")
fdee13ec 2459 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
492d2437 2460 (dired-mark-if
f13101e9
KH
2461 ;; Don't call backup-file-name-p unless the last character looks like
2462 ;; it might be the end of a backup file name. This isn't very general,
a91526b9
RS
2463 ;; but it's the only way this runs fast enough.
2464 (and (save-excursion (end-of-line)
f13101e9
KH
2465 ;; Handle executables in case of -F option.
2466 ;; We need not worry about the other kinds
2467 ;; of markings that -F makes, since they won't
2468 ;; appear on real backup files.
2469 (if (eq (preceding-char) ?*)
2470 (forward-char -1))
fdee13ec 2471 (eq (preceding-char) ?~))
a91526b9 2472 (not (looking-at dired-re-dir))
492d2437
RS
2473 (let ((fn (dired-get-filename t t)))
2474 (if fn (backup-file-name-p fn))))
2475 "backup file")))
2476
6482fcac
RS
2477(defun dired-change-marks (&optional old new)
2478 "Change all OLD marks to NEW marks.
2479OLD and NEW are both characters used to mark files."
2480 (interactive
2481 (let* ((cursor-in-echo-area t)
2482 (old (progn (message "Change (old mark): ") (read-char)))
2483 (new (progn (message "Change %c marks to (new mark): " old)
2484 (read-char))))
2485 (list old new)))
e4e02841
RS
2486 (if (or (eq old ?\r) (eq new ?\r))
2487 (ding)
2488 (let ((string (format "\n%c" old))
2489 (buffer-read-only))
2490 (save-excursion
2491 (goto-char (point-min))
2492 (while (search-forward string nil t)
a15a76f7
RS
2493 (if (if (= old ?\ )
2494 (save-match-data
2495 (dired-get-filename 'no-dir t))
2496 t)
2497 (subst-char-in-region (match-beginning 0)
2498 (match-end 0) old new)))))))
6482fcac 2499
534a6edf 2500(defun dired-unmark-all-marks ()
b1ecd9c6
RS
2501 "Remove all marks from all files in the Dired buffer."
2502 (interactive)
2503 (dired-unmark-all-files ?\r))
2504
8b87a301 2505(defun dired-unmark-all-files (mark &optional arg)
b602ba2f 2506 "Remove a specific mark (or any mark) from every file.
e95b0c08 2507After this command, type the mark character to remove,
b602ba2f 2508or type RET to remove all marks.
3585916f 2509With prefix arg, query for each marked file.
492d2437 2510Type \\[help-command] at that time for help."
b602ba2f
RS
2511 (interactive "cRemove marks (RET means all): \nP")
2512 (save-excursion
2513 (let* ((count 0)
2514 buffer-read-only case-fold-search query
2515 (string (format "\n%c" mark))
2516 (help-form "\
8b87a301
RS
2517Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2518`!' to unmark all remaining files with no more questions."))
b602ba2f
RS
2519 (goto-char (point-min))
2520 (while (if (eq mark ?\r)
2521 (re-search-forward dired-re-mark nil t)
2522 (search-forward string nil t))
2523 (if (or (not arg)
2524 (dired-query 'query "Unmark file `%s'? "
2525 (dired-get-filename t)))
2526 (progn (subst-char-in-region (1- (point)) (point)
2527 (preceding-char) ?\ )
2528 (setq count (1+ count)))))
2529 (message (if (= count 1) "1 mark removed"
2530 "%d marks removed")
2531 count))))
e95b0c08 2532
492d2437 2533;; Logging failures operating on files, and showing the results.
84fc2cfa 2534
492d2437 2535(defvar dired-log-buffer "*Dired log*")
84fc2cfa 2536
492d2437
RS
2537(defun dired-why ()
2538 "Pop up a buffer with error log output from Dired.
2539A group of errors from a single command ends with a formfeed.
2540Thus, use \\[backward-page] to find the beginning of a group of errors."
2541 (interactive)
2542 (if (get-buffer dired-log-buffer)
2543 (let ((owindow (selected-window))
2544 (window (display-buffer (get-buffer dired-log-buffer))))
2545 (unwind-protect
6482fcac 2546 (progn
492d2437
RS
2547 (select-window window)
2548 (goto-char (point-max))
2549 (recenter -1))
2550 (select-window owindow)))))
2551
2552(defun dired-log (log &rest args)
2553 ;; Log a message or the contents of a buffer.
2554 ;; If LOG is a string and there are more args, it is formatted with
2555 ;; those ARGS. Usually the LOG string ends with a \n.
2556 ;; End each bunch of errors with (dired-log t): this inserts
2557 ;; current time and buffer, and a \f (formfeed).
2558 (let ((obuf (current-buffer)))
2559 (unwind-protect ; want to move point
2560 (progn
2561 (set-buffer (get-buffer-create dired-log-buffer))
2562 (goto-char (point-max))
2563 (let (buffer-read-only)
2564 (cond ((stringp log)
2565 (insert (if args
2566 (apply (function format) log args)
2567 log)))
2568 ((bufferp log)
2569 (insert-buffer log))
2570 ((eq t log)
2571 (insert "\n\t" (current-time-string)
2572 "\tBuffer `" (buffer-name obuf) "'\n\f\n")))))
2573 (set-buffer obuf))))
2574
2575(defun dired-log-summary (string failures)
2576 (message (if failures "%s--type ? for details (%s)"
2577 "%s--type ? for details")
2578 string failures)
2579 ;; Log a summary describing a bunch of errors.
2580 (dired-log (concat "\n" string))
2581 (dired-log t))
e95b0c08 2582
492d2437
RS
2583;;; Sorting
2584
2585;; Most ls can only sort by name or by date (with -t), nothing else.
2586;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2587;; So anything that does not contain these is sort "by name".
2588
2589(defvar dired-ls-sorting-switches "SXU"
2590 "String of `ls' switches (single letters) except `t' that influence sorting.")
2591
2592(defvar dired-sort-by-date-regexp
2593 (concat "^-[^" dired-ls-sorting-switches
2594 "]*t[^" dired-ls-sorting-switches "]*$")
2595 "Regexp recognized by dired to set `by date' mode.")
2596
2597(defvar dired-sort-by-name-regexp
2598 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2599 "Regexp recognized by dired to set `by name' mode.")
2600
492d2437
RS
2601(defun dired-sort-set-modeline ()
2602 ;; Set modeline display according to dired-actual-switches.
2603 ;; Modeline display of "by name" or "by date" guarantees the user a
2604 ;; match with the corresponding regexps. Non-matching switches are
2605 ;; shown literally.
1d673d85 2606 (setq mode-name
492d2437
RS
2607 (let (case-fold-search)
2608 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
1d673d85 2609 "Dired by name")
492d2437 2610 ((string-match dired-sort-by-date-regexp dired-actual-switches)
1d673d85 2611 "Dired by date")
492d2437 2612 (t
1d673d85 2613 (concat "Dired " dired-actual-switches)))))
45d8d39f 2614 (force-mode-line-update))
492d2437
RS
2615
2616(defun dired-sort-toggle-or-edit (&optional arg)
2617 "Toggle between sort by date/name and refresh the dired buffer.
2618With a prefix argument you can edit the current listing switches instead."
84fc2cfa 2619 (interactive "P")
492d2437
RS
2620 (if arg
2621 (dired-sort-other
2622 (read-string "ls switches (must contain -l): " dired-actual-switches))
2623 (dired-sort-toggle)))
2624
2625(defun dired-sort-toggle ()
2626 ;; Toggle between sort by date/name. Reverts the buffer.
2627 (setq dired-actual-switches
2628 (let (case-fold-search)
7820b28f
RS
2629 (if (string-match " " dired-actual-switches)
2630 ;; New toggle scheme: add/remove a trailing " -t"
2631 (if (string-match " -t\\'" dired-actual-switches)
e95b0c08 2632 (replace-regexp-in-string " -t\\'" "" dired-actual-switches)
7820b28f
RS
2633 (concat dired-actual-switches " -t"))
2634 ;; old toggle scheme: look for some 't' switch and add/remove it
2635 (concat
2636 "-l"
e95b0c08
SS
2637 (replace-regexp-in-string (concat "[-lt"
2638 dired-ls-sorting-switches "]")
2639 ""
2640 dired-actual-switches)
7820b28f
RS
2641 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2642 dired-actual-switches)
2643 ""
2644 "t")))))
492d2437
RS
2645 (dired-sort-set-modeline)
2646 (revert-buffer))
2647
492d2437
RS
2648(defun dired-sort-other (switches &optional no-revert)
2649 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2650 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2651 ;; minor mode accordingly, others appear literally in the mode line.
2652 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
e17dba1f 2653 (dired-sort-R-check switches)
492d2437 2654 (setq dired-actual-switches switches)
6cfd24f9 2655 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
492d2437 2656 (or no-revert (revert-buffer)))
e17dba1f
GM
2657
2658(make-variable-buffer-local
2659 (defvar dired-subdir-alist-pre-R nil
2660 "Value of `dired-subdir-alist' before -R switch added."))
2661
2662(defun dired-sort-R-check (switches)
2663 "Additional processing of -R in ls option string SWITCHES.
2664Saves `dired-subdir-alist' when R is set and restores saved value
2665minus any directories explicitly deleted when R is cleared.
2666To be called first in body of `dired-sort-other', etc."
2667 (cond
2668 ((and (string-match "R" switches)
2669 (not (string-match "R" dired-actual-switches)))
2670 ;; Adding -R to ls switches -- save `dired-subdir-alist':
2671 (setq dired-subdir-alist-pre-R dired-subdir-alist))
2672 ((and (string-match "R" dired-actual-switches)
2673 (not (string-match "R" switches)))
2674 ;; Deleting -R from ls switches -- revert to pre-R subdirs
2675 ;; that are still present:
2676 (setq dired-subdir-alist
2677 (if dired-subdir-alist-pre-R
2678 (let (subdirs)
2679 (while dired-subdir-alist-pre-R
2680 (if (assoc (caar dired-subdir-alist-pre-R)
2681 dired-subdir-alist)
2682 ;; subdir still present...
2683 (setq subdirs
2684 (cons (car dired-subdir-alist-pre-R)
2685 subdirs)))
2686 (setq dired-subdir-alist-pre-R
2687 (cdr dired-subdir-alist-pre-R)))
2688 (reverse subdirs))
2689 ;; No pre-R subdir alist, so revert to main directory
2690 ;; listing:
2691 (list (car (reverse dired-subdir-alist))))))))
e95b0c08 2692
492d2437
RS
2693;; To make this file smaller, the less common commands
2694;; go in a separate file. But autoload them here
2695;; to make the separation invisible.
2696
2697(autoload 'dired-diff "dired-aux"
2698 "Compare file at point with file FILE using `diff'.
2699FILE defaults to the file at the mark.
ab67260b 2700The prompted-for file is the first file given to `diff'."
492d2437
RS
2701 t)
2702
2703(autoload 'dired-backup-diff "dired-aux"
2704 "Diff this file with its backup file or vice versa.
2705Uses the latest backup, if there are several numerical backups.
2706If this file is a backup, diff it with its original.
ab67260b 2707The backup file is the first file given to `diff'."
492d2437
RS
2708 t)
2709
2d051399
RS
2710(autoload 'dired-clean-directory "dired-aux"
2711 "Flag numerical backups for deletion.
2712Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2713Positive prefix arg KEEP overrides `dired-kept-versions';
2714Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2715
2716To clear the flags on these files, you can use \\[dired-flag-backup-files]
2717with a prefix argument."
2718 t)
2719
492d2437
RS
2720(autoload 'dired-do-chmod "dired-aux"
2721 "Change the mode of the marked (or next ARG) files.
2722This calls chmod, thus symbolic modes like `g+w' are allowed."
2723 t)
2724
2725(autoload 'dired-do-chgrp "dired-aux"
2726 "Change the group of the marked (or next ARG) files."
2727 t)
2728
2729(autoload 'dired-do-chown "dired-aux"
2730 "Change the owner of the marked (or next ARG) files."
2731 t)
2732
2733(autoload 'dired-do-print "dired-aux"
2734 "Print the marked (or next ARG) files.
2735Uses the shell command coming from variables `lpr-command' and
2736`lpr-switches' as default."
2737 t)
2738
2739(autoload 'dired-do-shell-command "dired-aux"
6482fcac
RS
2740 "Run a shell command COMMAND on the marked files.
2741If no files are marked or a specific numeric prefix arg is given,
2742the next ARG files are used. Just \\[universal-argument] means the current file.
2743The prompt mentions the file(s) or the marker, as appropriate.
2744
492d2437 2745If there is output, it goes to a separate buffer.
6482fcac 2746
492d2437
RS
2747Normally the command is run on each file individually.
2748However, if there is a `*' in the command then it is run
2749just once with the entire file list substituted there.
2750
6482fcac
RS
2751No automatic redisplay of dired buffers is attempted, as there's no
2752telling what files the command may have changed. Type
2753\\[dired-do-redisplay] to redisplay the marked files.
492d2437
RS
2754
2755The shell command has the top level directory as working directory, so
2756output files usually are created there instead of in a subdir."
2757 t)
2758
492d2437
RS
2759(autoload 'dired-do-kill-lines "dired-aux"
2760 "Kill all marked lines (not the files).
2761With a prefix arg, kill all lines not marked or flagged."
2762 t)
2763
2764(autoload 'dired-do-compress "dired-aux"
2765 "Compress or uncompress marked (or next ARG) files."
2766 t)
2767
2768(autoload 'dired-do-byte-compile "dired-aux"
2769 "Byte compile marked (or next ARG) Emacs Lisp files."
2770 t)
2771
2772(autoload 'dired-do-load "dired-aux"
2773 "Load the marked (or next ARG) Emacs Lisp files."
2774 t)
2775
2776(autoload 'dired-do-redisplay "dired-aux"
2777 "Redisplay all marked (or next ARG) files.
2778If on a subdir line, redisplay that subdirectory. In that case,
2779a prefix arg lets you edit the `ls' switches used for the new listing."
2780 t)
2781
492d2437 2782(autoload 'dired-create-directory "dired-aux"
84fc2cfa 2783 "Create a directory called DIRECTORY."
492d2437 2784 t)
84fc2cfa 2785
492d2437
RS
2786(autoload 'dired-do-copy "dired-aux"
2787 "Copy all marked (or next ARG) files, or copy the current file.
2788Thus, a zero prefix argument copies nothing. But it toggles the
2789variable `dired-copy-preserve-time' (which see)."
2790 t)
2791
2792(autoload 'dired-do-symlink "dired-aux"
2793 "Make symbolic links to current file or all marked (or next ARG) files.
2794When operating on just the current file, you specify the new name.
2795When operating on multiple or marked files, you specify a directory
2796and new symbolic links are made in that directory
2797with the same names that the files currently have."
2798 t)
2799
2800(autoload 'dired-do-hardlink "dired-aux"
2801 "Add names (hard links) current file or all marked (or next ARG) files.
2802When operating on just the current file, you specify the new name.
2803When operating on multiple or marked files, you specify a directory
2804and new hard links are made in that directory
2805with the same names that the files currently have."
2806 t)
2807
2808(autoload 'dired-do-rename "dired-aux"
2809 "Rename current file or all marked (or next ARG) files.
2810When renaming just the current file, you specify the new name.
2811When renaming multiple or marked files, you specify a directory."
2812 t)
2813
2814(autoload 'dired-do-rename-regexp "dired-aux"
2815 "Rename marked files containing REGEXP to NEWNAME.
2816As each match is found, the user must type a character saying
2817 what to do with it. For directions, type \\[help-command] at that time.
2818NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2819REGEXP defaults to the last regexp used.
2820With a zero prefix arg, renaming by regexp affects the complete
2821 pathname - usually only the non-directory part of file names is used
2822 and changed."
2823 t)
2824
2825(autoload 'dired-do-copy-regexp "dired-aux"
2826 "Copy all marked files containing REGEXP to NEWNAME.
99c364e4 2827See function `dired-do-rename-regexp' for more info."
492d2437
RS
2828 t)
2829
2830(autoload 'dired-do-hardlink-regexp "dired-aux"
2831 "Hardlink all marked files containing REGEXP to NEWNAME.
99c364e4 2832See function `dired-do-rename-regexp' for more info."
492d2437
RS
2833 t)
2834
2835(autoload 'dired-do-symlink-regexp "dired-aux"
2836 "Symlink all marked files containing REGEXP to NEWNAME.
99c364e4 2837See function `dired-do-rename-regexp' for more info."
492d2437
RS
2838 t)
2839
2840(autoload 'dired-upcase "dired-aux"
2841 "Rename all marked (or next ARG) files to upper case."
2842 t)
2843
2844(autoload 'dired-downcase "dired-aux"
2845 "Rename all marked (or next ARG) files to lower case."
2846 t)
2847
2848(autoload 'dired-maybe-insert-subdir "dired-aux"
2849 "Insert this subdirectory into the same dired buffer.
2850If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2851 else inserts it at its natural place (as `ls -lR' would have done).
2852With a prefix arg, you may edit the ls switches used for this listing.
2853 You can add `R' to the switches to expand the whole tree starting at
2854 this subdirectory.
2855This function takes some pains to conform to `ls -lR' output."
2856 t)
2857
2858(autoload 'dired-next-subdir "dired-aux"
2859 "Go to next subdirectory, regardless of level."
2860 t)
2861
2862(autoload 'dired-prev-subdir "dired-aux"
2863 "Go to previous subdirectory, regardless of level.
2864When called interactively and not on a subdir line, go to this subdir's line."
2865 t)
2866
2867(autoload 'dired-goto-subdir "dired-aux"
2868 "Go to end of header line of DIR in this dired buffer.
2869Return value of point on success, otherwise return nil.
2870The next char is either \\n, or \\r if DIR is hidden."
2871 t)
2872
2873(autoload 'dired-mark-subdir-files "dired-aux"
2874 "Mark all files except `.' and `..'."
2875 t)
2876
2877(autoload 'dired-kill-subdir "dired-aux"
2878 "Remove all lines of current subdirectory.
2879Lower levels are unaffected."
2880 t)
2881
2882(autoload 'dired-tree-up "dired-aux"
2883 "Go up ARG levels in the dired tree."
2884 t)
2885
2886(autoload 'dired-tree-down "dired-aux"
2887 "Go down in the dired tree."
2888 t)
2889
2890(autoload 'dired-hide-subdir "dired-aux"
2891 "Hide or unhide the current subdirectory and move to next directory.
2892Optional prefix arg is a repeat factor.
2893Use \\[dired-hide-all] to (un)hide all directories."
2894 t)
2895
2896(autoload 'dired-hide-all "dired-aux"
2897 "Hide all subdirectories, leaving only their header lines.
2898If there is already something hidden, make everything visible again.
2899Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2900 t)
f01fd03b
MB
2901
2902(autoload 'dired-show-file-type "dired-aux"
2903 "Print the type of FILE, according to the `file' command.
2904If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
e95b0c08 2905true then the type of the file linked to by FILE is printed instead."
f01fd03b 2906 t)
e95b0c08 2907
492d2437
RS
2908(if (eq system-type 'vax-vms)
2909 (load "dired-vms"))
84fc2cfa 2910
52041219
RS
2911(provide 'dired)
2912
57e15005
BF
2913(run-hooks 'dired-load-hook) ; for your customizations
2914
52041219 2915;;; dired.el ends here