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