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