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