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