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