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