Merge dired-x's dired-add-entry modifications into the main definition.
[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
bc35ff32
EZ
1055(defvar ls-lisp-use-insert-directory-program)
1056
0b7bc76f
RS
1057(defun dired-insert-directory (dir switches &optional file-list wildcard hdr)
1058 "Insert a directory listing of DIR, Dired style.
1059Use SWITCHES to make the listings.
1060If FILE-LIST is non-nil, list only those files.
1061Otherwise, if WILDCARD is non-nil, expand wildcards;
1062 in that case, DIR should be a file name that uses wildcards.
1063In other cases, DIR should be a directory name or a directory filename.
1064If HDR is non-nil, insert a header line with the directory name."
9888aa65 1065 (let ((opoint (point))
02b5d79c 1066 (process-environment (copy-sequence process-environment))
9888aa65 1067 end)
bc35ff32
EZ
1068 (if (and
1069 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1070 ;; ls-lisp emulation is used, except if they want to use `ls'
1071 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1072 (not (and (featurep 'ls-lisp)
1073 (null ls-lisp-use-insert-directory-program)))
1074 (or (if (eq dired-use-ls-dired 'unspecified)
1075 ;; Check whether "ls --dired" gives exit code 0, and
1076 ;; save the answer in `dired-use-ls-dired'.
1077 (setq dired-use-ls-dired
1078 (eq (call-process insert-directory-program nil nil nil "--dired")
1079 0))
1080 dired-use-ls-dired)
1081 (file-remote-p dir)))
0b7bc76f 1082 (setq switches (concat "--dired " switches)))
6492483f
RS
1083 ;; We used to specify the C locale here, to force English month names;
1084 ;; but this should not be necessary any more,
9bc260cf 1085 ;; with the new value of `directory-listing-before-filename-regexp'.
0b7bc76f
RS
1086 (if file-list
1087 (dolist (f file-list)
a12c6dca
SM
1088 (let ((beg (point)))
1089 (insert-directory f switches nil nil)
1090 ;; Re-align fields, if necessary.
1091 (dired-align-file beg (point))))
0b7bc76f 1092 (insert-directory dir switches wildcard (not wildcard)))
9888aa65 1093 ;; Quote certain characters, unless ls quoted them for us.
ad632492
SM
1094 (if (not (string-match "b" dired-actual-switches))
1095 (save-excursion
1096 (setq end (point-marker))
1097 (goto-char opoint)
1098 (while (search-forward "\\" end t)
2bb27597
AS
1099 (replace-match (apply #'propertize
1100 "\\\\"
1101 (text-properties-at (match-beginning 0)))
1102 nil t))
ad632492
SM
1103 (goto-char opoint)
1104 (while (search-forward "\^m" end t)
2bb27597
AS
1105 (replace-match (apply #'propertize
1106 "\\015"
1107 (text-properties-at (match-beginning 0)))
1108 nil t))
ad632492 1109 (set-marker end nil)))
0b7bc76f
RS
1110 (dired-insert-set-properties opoint (point))
1111 ;; If we used --dired and it worked, the lines are already indented.
1112 ;; Otherwise, indent them.
1113 (unless (save-excursion
1ba6c0f2 1114 (goto-char opoint)
0b7bc76f
RS
1115 (looking-at " "))
1116 (let ((indent-tabs-mode nil))
1117 (indent-rigidly opoint (point) 2)))
1118 ;; Insert text at the beginning to standardize things.
1119 (save-excursion
1120 (goto-char opoint)
a7f07c36
SM
1121 (if (and (or hdr wildcard)
1122 (not (and (looking-at "^ \\(.*\\):$")
1123 (file-name-absolute-p (match-string 1)))))
0b7bc76f
RS
1124 ;; Note that dired-build-subdir-alist will replace the name
1125 ;; by its expansion, so it does not matter whether what we insert
1126 ;; here is fully expanded, but it should be absolute.
1127 (insert " " (directory-file-name (file-name-directory dir)) ":\n"))
1128 (when wildcard
1129 ;; Insert "wildcard" line where "total" line would be for a full dir.
1130 (insert " wildcard " (file-name-nondirectory dir) "\n")))))
492d2437 1131
cb88a3db 1132(defun dired-insert-set-properties (beg end)
d7aed37c 1133 "Make the file names highlight when the mouse is on them."
cb88a3db
RS
1134 (save-excursion
1135 (goto-char beg)
1136 (while (< (point) end)
7da0e9b4
RS
1137 (condition-case nil
1138 (if (dired-move-to-filename)
ac2d0299
EZ
1139 (add-text-properties
1140 (point)
1141 (save-excursion
1142 (dired-move-to-end-of-filename)
1143 (point))
1b85bd12 1144 '(mouse-face highlight
eae2c85e 1145 dired-filename t
ac2d0299 1146 help-echo "mouse-2: visit this file in other window")))
7da0e9b4 1147 (error nil))
cb88a3db 1148 (forward-line 1))))
83fadedf 1149\f
492d2437
RS
1150;; Reverting a dired buffer
1151
84fc2cfa 1152(defun dired-revert (&optional arg noconfirm)
d7aed37c 1153 "Reread the dired buffer.
ee680b2b 1154Must also be called after `dired-actual-switches' have changed.
d7aed37c 1155Should not fail even on completely garbaged buffers.
b14f16ad
CY
1156Preserves old cursor, marks/flags, hidden-p.
1157
1158Dired sets `revert-buffer-function' to this function. The args
1159ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
492d2437 1160 (widen) ; just in case user narrowed
7805cdbd 1161 (let ((modflag (buffer-modified-p))
05404988 1162 (positions (dired-save-positions))
492d2437
RS
1163 (mark-alist nil) ; save marked files
1164 (hidden-subdirs (dired-remember-hidden))
1165 (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
1166 (case-fold-search nil) ; we check for upper case ls flags
f836b98e 1167 (inhibit-read-only t))
492d2437
RS
1168 (goto-char (point-min))
1169 (setq mark-alist;; only after dired-remember-hidden since this unhides:
1170 (dired-remember-marks (point-min) (point-max)))
1171 ;; treat top level dir extra (it may contain wildcards)
d5b3979c
MA
1172 (if (not (consp dired-directory))
1173 (dired-uncache dired-directory)
1174 (dired-uncache (car dired-directory))
1175 (dolist (dir (cdr dired-directory))
1176 (if (file-name-absolute-p dir)
1177 (dired-uncache dir))))
6a80f50e 1178 ;; Run dired-after-readin-hook just once, below.
492d2437 1179 (let ((dired-after-readin-hook nil))
6a80f50e 1180 (dired-readin)
492d2437
RS
1181 (dired-insert-old-subdirs old-subdir-alist))
1182 (dired-mark-remembered mark-alist) ; mark files that were marked
1183 ;; ... run the hook for the whole buffer, and only after markers
1184 ;; have been reinserted (else omitting in dired-x would omit marked files)
1185 (run-hooks 'dired-after-readin-hook) ; no need to narrow
05404988 1186 (dired-restore-positions positions)
492d2437 1187 (save-excursion ; hide subdirs that were hidden
d7aed37c
SM
1188 (dolist (dir hidden-subdirs)
1189 (if (dired-goto-subdir dir)
7805cdbd
LT
1190 (dired-hide-subdir 1))))
1191 (unless modflag (restore-buffer-modified-p nil)))
492d2437 1192 ;; outside of the let scope
7805cdbd 1193;;; Might as well not override the user if the user changed this.
492d2437
RS
1194;;; (setq buffer-read-only t)
1195 )
1196
1197;; Subroutines of dired-revert
1198;; Some of these are also used when inserting subdirs.
1199
05404988 1200(defun dired-save-positions ()
065543e7
JL
1201 "Return current positions in the buffer and all windows with this directory.
1202The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1203
1204BUFFER-POSITION is the point position in the current dired buffer.
53ad04fc 1205It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
065543e7
JL
1206
1207WINDOW-POSITIONS are current positions in all windows displaying
1208this dired buffer. The window positions have the form (WINDOW
1209DIRED-FILENAME WINDOW-POINT)."
1210 (list
1211 (list (current-buffer) (dired-get-filename nil t) (point))
1212 (mapcar (lambda (w)
1213 (list w
1214 (with-selected-window w
1215 (dired-get-filename nil t))
1216 (window-point w)))
1217 (get-buffer-window-list nil 0 t))))
05404988
SM
1218
1219(defun dired-restore-positions (positions)
1220 "Restore POSITIONS saved with `dired-save-positions'."
065543e7
JL
1221 (let* ((buf-file-pos (nth 0 positions))
1222 (buffer (nth 0 buf-file-pos)))
1223 (unless (and (nth 1 buf-file-pos)
1224 (dired-goto-file (nth 1 buf-file-pos)))
1225 (goto-char (nth 2 buf-file-pos))
1226 (dired-move-to-filename))
1227 (dolist (win-file-pos (nth 1 positions))
1228 ;; Ensure that window still displays the original buffer.
1229 (when (eq (window-buffer (nth 0 win-file-pos)) buffer)
1230 (with-selected-window (nth 0 win-file-pos)
1231 (unless (and (nth 1 win-file-pos)
1232 (dired-goto-file (nth 1 win-file-pos)))
1233 (goto-char (nth 2 win-file-pos))
1234 (dired-move-to-filename)))))))
05404988 1235
492d2437 1236(defun dired-remember-marks (beg end)
d7aed37c 1237 "Return alist of files and their marks, from BEG to END."
492d2437 1238 (if selective-display ; must unhide to make this work.
f836b98e 1239 (let ((inhibit-read-only t))
492d2437
RS
1240 (subst-char-in-region beg end ?\r ?\n)))
1241 (let (fil chr alist)
1242 (save-excursion
1243 (goto-char beg)
1244 (while (re-search-forward dired-re-mark end t)
1245 (if (setq fil (dired-get-filename nil t))
1246 (setq chr (preceding-char)
1247 alist (cons (cons fil chr) alist)))))
1248 alist))
1249
492d2437 1250(defun dired-mark-remembered (alist)
d7aed37c
SM
1251 "Mark all files remembered in ALIST.
1252Each element of ALIST looks like (FILE . MARKERCHAR)."
492d2437
RS
1253 (let (elt fil chr)
1254 (while alist
1255 (setq elt (car alist)
1256 alist (cdr alist)
1257 fil (car elt)
1258 chr (cdr elt))
1259 (if (dired-goto-file fil)
1260 (save-excursion
1261 (beginning-of-line)
1262 (delete-char 1)
1263 (insert chr))))))
1264
492d2437 1265(defun dired-remember-hidden ()
d7aed37c 1266 "Return a list of names of subdirs currently hidden."
492d2437
RS
1267 (let ((l dired-subdir-alist) dir pos result)
1268 (while l
1269 (setq dir (car (car l))
1270 pos (cdr (car l))
1271 l (cdr l))
1272 (goto-char pos)
1273 (skip-chars-forward "^\r\n")
52041219 1274 (if (eq (following-char) ?\r)
492d2437
RS
1275 (setq result (cons dir result))))
1276 result))
1277
492d2437 1278(defun dired-insert-old-subdirs (old-subdir-alist)
d7aed37c
SM
1279 "Try to insert all subdirs that were displayed before.
1280Do so according to the former subdir alist OLD-SUBDIR-ALIST."
492d2437
RS
1281 (or (string-match "R" dired-actual-switches)
1282 (let (elt dir)
1283 (while old-subdir-alist
1284 (setq elt (car old-subdir-alist)
1285 old-subdir-alist (cdr old-subdir-alist)
1286 dir (car elt))
1287 (condition-case ()
715984d3
RS
1288 (progn
1289 (dired-uncache dir)
f817c0fb 1290 (dired-insert-subdir dir))
492d2437 1291 (error nil))))))
715984d3 1292
715984d3 1293(defun dired-uncache (dir)
d7aed37c 1294 "Remove directory DIR from any directory cache."
6eaebaa2 1295 (let ((handler (find-file-name-handler dir 'dired-uncache)))
715984d3
RS
1296 (if handler
1297 (funcall handler 'dired-uncache dir))))
83fadedf 1298\f
492d2437 1299;; dired mode key bindings and initialization
84fc2cfa 1300
d7aed37c 1301(defvar dired-mode-map
492d2437
RS
1302 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1303 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
3e1fb00f 1304 (let ((map (make-keymap)))
abef340a 1305 (set-keymap-parent map special-mode-map)
3e1fb00f 1306 (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
bb87fbc3 1307 (define-key map [follow-link] 'mouse-face)
3e1fb00f
RS
1308 ;; Commands to mark or flag certain categories of files
1309 (define-key map "#" 'dired-flag-auto-save-files)
3e1fb00f 1310 (define-key map "." 'dired-clean-directory)
3e1fb00f
RS
1311 (define-key map "~" 'dired-flag-backup-files)
1312 ;; Upper case keys (except !) for operating on the marked files
1313 (define-key map "A" 'dired-do-search)
1314 (define-key map "C" 'dired-do-copy)
1315 (define-key map "B" 'dired-do-byte-compile)
1316 (define-key map "D" 'dired-do-delete)
1317 (define-key map "G" 'dired-do-chgrp)
1318 (define-key map "H" 'dired-do-hardlink)
1319 (define-key map "L" 'dired-do-load)
1320 (define-key map "M" 'dired-do-chmod)
1321 (define-key map "O" 'dired-do-chown)
1322 (define-key map "P" 'dired-do-print)
ee93b692 1323 (define-key map "Q" 'dired-do-query-replace-regexp)
3e1fb00f
RS
1324 (define-key map "R" 'dired-do-rename)
1325 (define-key map "S" 'dired-do-symlink)
57654b8c 1326 (define-key map "T" 'dired-do-touch)
3e1fb00f
RS
1327 (define-key map "X" 'dired-do-shell-command)
1328 (define-key map "Z" 'dired-do-compress)
1329 (define-key map "!" 'dired-do-shell-command)
48e740bf 1330 (define-key map "&" 'dired-do-async-shell-command)
3e1fb00f
RS
1331 ;; Comparison commands
1332 (define-key map "=" 'dired-diff)
1333 (define-key map "\M-=" 'dired-backup-diff)
1334 ;; Tree Dired commands
1335 (define-key map "\M-\C-?" 'dired-unmark-all-files)
1336 (define-key map "\M-\C-d" 'dired-tree-down)
1337 (define-key map "\M-\C-u" 'dired-tree-up)
1338 (define-key map "\M-\C-n" 'dired-next-subdir)
1339 (define-key map "\M-\C-p" 'dired-prev-subdir)
1340 ;; move to marked files
1341 (define-key map "\M-{" 'dired-prev-marked-file)
1342 (define-key map "\M-}" 'dired-next-marked-file)
1343 ;; Make all regexp commands share a `%' prefix:
1344 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1345 ;; but that seems to serve little purpose, and copy-keymap
1346 ;; does a better job without it.
1347 (define-key map "%" nil)
1348 (define-key map "%u" 'dired-upcase)
1349 (define-key map "%l" 'dired-downcase)
1350 (define-key map "%d" 'dired-flag-files-regexp)
e9b8e22d 1351 (define-key map "%g" 'dired-mark-files-containing-regexp)
3e1fb00f
RS
1352 (define-key map "%m" 'dired-mark-files-regexp)
1353 (define-key map "%r" 'dired-do-rename-regexp)
1354 (define-key map "%C" 'dired-do-copy-regexp)
1355 (define-key map "%H" 'dired-do-hardlink-regexp)
1356 (define-key map "%R" 'dired-do-rename-regexp)
1357 (define-key map "%S" 'dired-do-symlink-regexp)
48e740bf 1358 (define-key map "%&" 'dired-flag-garbage-files)
4a3ca6ed
RS
1359 ;; Commands for marking and unmarking.
1360 (define-key map "*" nil)
1361 (define-key map "**" 'dired-mark-executables)
1362 (define-key map "*/" 'dired-mark-directories)
1363 (define-key map "*@" 'dired-mark-symlinks)
1364 (define-key map "*%" 'dired-mark-files-regexp)
1365 (define-key map "*c" 'dired-change-marks)
0609c998 1366 (define-key map "*s" 'dired-mark-subdir-files)
4a3ca6ed
RS
1367 (define-key map "*m" 'dired-mark)
1368 (define-key map "*u" 'dired-unmark)
1369 (define-key map "*?" 'dired-unmark-all-files)
534a6edf 1370 (define-key map "*!" 'dired-unmark-all-marks)
d7aed37c 1371 (define-key map "U" 'dired-unmark-all-marks)
4a3ca6ed
RS
1372 (define-key map "*\177" 'dired-unmark-backward)
1373 (define-key map "*\C-n" 'dired-next-marked-file)
1374 (define-key map "*\C-p" 'dired-prev-marked-file)
d588eb90 1375 (define-key map "*t" 'dired-toggle-marks)
3e1fb00f 1376 ;; Lower keys for commands not operating on all the marked files
c5753a5d 1377 (define-key map "a" 'dired-find-alternate-file)
3e1fb00f
RS
1378 (define-key map "d" 'dired-flag-file-deletion)
1379 (define-key map "e" 'dired-find-file)
1380 (define-key map "f" 'dired-find-file)
8cb95edf
SM
1381 (define-key map "\C-m" 'dired-find-file)
1382 (put 'dired-find-file :advertised-binding "\C-m")
3e1fb00f 1383 (define-key map "g" 'revert-buffer)
3e1fb00f 1384 (define-key map "i" 'dired-maybe-insert-subdir)
e19d2d64 1385 (define-key map "j" 'dired-goto-file)
3e1fb00f
RS
1386 (define-key map "k" 'dired-do-kill-lines)
1387 (define-key map "l" 'dired-do-redisplay)
1388 (define-key map "m" 'dired-mark)
1389 (define-key map "n" 'dired-next-line)
1390 (define-key map "o" 'dired-find-file-other-window)
1391 (define-key map "\C-o" 'dired-display-file)
1392 (define-key map "p" 'dired-previous-line)
3e1fb00f 1393 (define-key map "s" 'dired-sort-toggle-or-edit)
d588eb90 1394 (define-key map "t" 'dired-toggle-marks)
3e1fb00f
RS
1395 (define-key map "u" 'dired-unmark)
1396 (define-key map "v" 'dired-view-file)
a3f4a3ef 1397 (define-key map "w" 'dired-copy-filename-as-kill)
3e1fb00f 1398 (define-key map "x" 'dired-do-flagged-delete)
d1e99fa5 1399 (define-key map "y" 'dired-show-file-type)
3e1fb00f
RS
1400 (define-key map "+" 'dired-create-directory)
1401 ;; moving
1402 (define-key map "<" 'dired-prev-dirline)
1403 (define-key map ">" 'dired-next-dirline)
1404 (define-key map "^" 'dired-up-directory)
1405 (define-key map " " 'dired-next-line)
aac818a8
TL
1406 (define-key map [remap next-line] 'dired-next-line)
1407 (define-key map [remap previous-line] 'dired-previous-line)
3e1fb00f
RS
1408 ;; hiding
1409 (define-key map "$" 'dired-hide-subdir)
1410 (define-key map "\M-$" 'dired-hide-all)
b89b46cf
JL
1411 ;; isearch
1412 (define-key map (kbd "M-s a C-s") 'dired-do-isearch)
1413 (define-key map (kbd "M-s a M-C-s") 'dired-do-isearch-regexp)
eae2c85e
JL
1414 (define-key map (kbd "M-s f C-s") 'dired-isearch-filenames)
1415 (define-key map (kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp)
3e1fb00f 1416 ;; misc
aac818a8 1417 (define-key map [remap toggle-read-only] 'dired-toggle-read-only)
3e1fb00f
RS
1418 (define-key map "?" 'dired-summary)
1419 (define-key map "\177" 'dired-unmark-backward)
5e5a3412
RS
1420 (define-key map [remap undo] 'dired-undo)
1421 (define-key map [remap advertised-undo] 'dired-undo)
aa1a7612
CY
1422 ;; thumbnail manipulation (image-dired)
1423 (define-key map "\C-td" 'image-dired-display-thumbs)
1424 (define-key map "\C-tt" 'image-dired-tag-files)
1425 (define-key map "\C-tr" 'image-dired-delete-tag)
1426 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1427 (define-key map "\C-ti" 'image-dired-dired-display-image)
1428 (define-key map "\C-tx" 'image-dired-dired-display-external)
1429 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1430 (define-key map "\C-t." 'image-dired-display-thumb)
1431 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1432 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
84fb0956 1433 (define-key map "\C-t\C-t" 'image-dired-dired-toggle-marked-thumbs)
aa1a7612 1434 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
bfeee9d1
DN
1435 ;; encryption and decryption (epa-dired)
1436 (define-key map ":d" 'epa-dired-do-decrypt)
1437 (define-key map ":v" 'epa-dired-do-verify)
1438 (define-key map ":s" 'epa-dired-do-sign)
1439 (define-key map ":e" 'epa-dired-do-encrypt)
3e1fb00f
RS
1440
1441 ;; Make menu bar items.
1442
d066de8e
EZ
1443 ;; No need to fo this, now that top-level items are fewer.
1444 ;;;;
3e1fb00f 1445 ;; Get rid of the Edit menu bar item to save space.
d066de8e 1446 ;(define-key map [menu-bar edit] 'undefined)
3e1fb00f
RS
1447
1448 (define-key map [menu-bar subdir]
1449 (cons "Subdir" (make-sparse-keymap "Subdir")))
1450
1451 (define-key map [menu-bar subdir hide-all]
d066de8e
EZ
1452 '(menu-item "Hide All" dired-hide-all
1453 :help "Hide all subdirectories, leave only header lines"))
3e1fb00f 1454 (define-key map [menu-bar subdir hide-subdir]
d066de8e
EZ
1455 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1456 :help "Hide or unhide current directory listing"))
3e1fb00f 1457 (define-key map [menu-bar subdir tree-down]
d066de8e
EZ
1458 '(menu-item "Tree Down" dired-tree-down
1459 :help "Go to first subdirectory header down the tree"))
3e1fb00f 1460 (define-key map [menu-bar subdir tree-up]
d066de8e
EZ
1461 '(menu-item "Tree Up" dired-tree-up
1462 :help "Go to first subdirectory header up the tree"))
3e1fb00f 1463 (define-key map [menu-bar subdir up]
d066de8e
EZ
1464 '(menu-item "Up Directory" dired-up-directory
1465 :help "Edit the parent directory"))
3e1fb00f 1466 (define-key map [menu-bar subdir prev-subdir]
d066de8e
EZ
1467 '(menu-item "Prev Subdir" dired-prev-subdir
1468 :help "Go to previous subdirectory header line"))
3e1fb00f 1469 (define-key map [menu-bar subdir next-subdir]
d066de8e
EZ
1470 '(menu-item "Next Subdir" dired-next-subdir
1471 :help "Go to next subdirectory header line"))
3e1fb00f 1472 (define-key map [menu-bar subdir prev-dirline]
d066de8e
EZ
1473 '(menu-item "Prev Dirline" dired-prev-dirline
1474 :help "Move to next directory-file line"))
3e1fb00f 1475 (define-key map [menu-bar subdir next-dirline]
d066de8e
EZ
1476 '(menu-item "Next Dirline" dired-next-dirline
1477 :help "Move to previous directory-file line"))
3e1fb00f 1478 (define-key map [menu-bar subdir insert]
d066de8e 1479 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
bedd8a58
CY
1480 :help "Insert contents of subdirectory"
1481 :enable (let ((f (dired-get-filename nil t)))
1482 (and f (file-directory-p f)))))
3e1fb00f
RS
1483 (define-key map [menu-bar immediate]
1484 (cons "Immediate" (make-sparse-keymap "Immediate")))
1485
635abd82 1486 (define-key map
aa1a7612
CY
1487 [menu-bar immediate image-dired-dired-display-external]
1488 '(menu-item "Display Image Externally" image-dired-dired-display-external
bc4dbed5 1489 :help "Display image in external viewer"))
635abd82 1490 (define-key map
aa1a7612
CY
1491 [menu-bar immediate image-dired-dired-display-image]
1492 '(menu-item "Display Image" image-dired-dired-display-image
bc4dbed5 1493 :help "Display sized image in a separate window"))
36938994 1494
836788c9
MD
1495 (define-key map [menu-bar immediate revert-buffer]
1496 '(menu-item "Refresh" revert-buffer
1497 :help "Update contents of shown directories"))
1498
1499 (define-key map [menu-bar immediate dashes]
1500 '("--"))
635abd82 1501
eae2c85e
JL
1502 (define-key map [menu-bar immediate isearch-filenames-regexp]
1503 '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1504 :help "Incrementally search for regexp in file names only"))
1505 (define-key map [menu-bar immediate isearch-filenames]
1506 '(menu-item "Isearch in File Names..." dired-isearch-filenames
1507 :help "Incrementally search for string in file names only."))
0e2aaf98 1508 (define-key map [menu-bar immediate compare-directories]
27af5d58 1509 '(menu-item "Compare Directories..." dired-compare-directories
0e2aaf98 1510 :help "Mark files with different attributes in two dired buffers"))
3e1fb00f 1511 (define-key map [menu-bar immediate backup-diff]
d066de8e
EZ
1512 '(menu-item "Compare with Backup" dired-backup-diff
1513 :help "Diff file at cursor with its latest backup"))
3e1fb00f 1514 (define-key map [menu-bar immediate diff]
d066de8e
EZ
1515 '(menu-item "Diff..." dired-diff
1516 :help "Compare file at cursor with another file"))
3e1fb00f 1517 (define-key map [menu-bar immediate view]
d066de8e
EZ
1518 '(menu-item "View This File" dired-view-file
1519 :help "Examine file at cursor in read-only mode"))
3e1fb00f 1520 (define-key map [menu-bar immediate display]
d066de8e
EZ
1521 '(menu-item "Display in Other Window" dired-display-file
1522 :help "Display file at cursor in other window"))
3e1fb00f 1523 (define-key map [menu-bar immediate find-file-other-window]
d066de8e
EZ
1524 '(menu-item "Find in Other Window" dired-find-file-other-window
1525 :help "Edit file at cursor in other window"))
3e1fb00f 1526 (define-key map [menu-bar immediate find-file]
d066de8e
EZ
1527 '(menu-item "Find This File" dired-find-file
1528 :help "Edit file at cursor"))
3e1fb00f 1529 (define-key map [menu-bar immediate create-directory]
4b33a64a
DN
1530 '(menu-item "Create Directory..." dired-create-directory
1531 :help "Create a directory"))
2ecab840 1532 (define-key map [menu-bar immediate wdired-mode]
40aa8257 1533 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
4b33a64a 1534 :help "Put a dired buffer in a mode in which filenames are editable"
89e87059 1535 :keys "C-x C-q"
40aa8257 1536 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
3e1fb00f
RS
1537
1538 (define-key map [menu-bar regexp]
1539 (cons "Regexp" (make-sparse-keymap "Regexp")))
1540
836788c9 1541 (define-key map
aa1a7612
CY
1542 [menu-bar regexp image-dired-mark-tagged-files]
1543 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
098bab71
JB
1544 :help "Mark files whose image tags matches regexp"))
1545
836788c9 1546 (define-key map [menu-bar regexp dashes-1]
098bab71 1547 '("--"))
836788c9 1548
3e1fb00f 1549 (define-key map [menu-bar regexp downcase]
d066de8e
EZ
1550 '(menu-item "Downcase" dired-downcase
1551 ;; When running on plain MS-DOS, there's only one
1552 ;; letter-case for file names.
1553 :enable (or (not (fboundp 'msdos-long-file-names))
1554 (msdos-long-file-names))
1555 :help "Rename marked files to lower-case name"))
3e1fb00f 1556 (define-key map [menu-bar regexp upcase]
d066de8e
EZ
1557 '(menu-item "Upcase" dired-upcase
1558 :enable (or (not (fboundp 'msdos-long-file-names))
1559 (msdos-long-file-names))
1560 :help "Rename marked files to upper-case name"))
3e1fb00f 1561 (define-key map [menu-bar regexp hardlink]
d066de8e
EZ
1562 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1563 :help "Make hard links for files matching regexp"))
3e1fb00f 1564 (define-key map [menu-bar regexp symlink]
d066de8e
EZ
1565 '(menu-item "Symlink..." dired-do-symlink-regexp
1566 :visible (fboundp 'make-symbolic-link)
1567 :help "Make symbolic links for files matching regexp"))
3e1fb00f 1568 (define-key map [menu-bar regexp rename]
d066de8e
EZ
1569 '(menu-item "Rename..." dired-do-rename-regexp
1570 :help "Rename marked files matching regexp"))
3e1fb00f 1571 (define-key map [menu-bar regexp copy]
d066de8e
EZ
1572 '(menu-item "Copy..." dired-do-copy-regexp
1573 :help "Copy marked files matching regexp"))
3e1fb00f 1574 (define-key map [menu-bar regexp flag]
d066de8e
EZ
1575 '(menu-item "Flag..." dired-flag-files-regexp
1576 :help "Flag files matching regexp for deletion"))
3e1fb00f 1577 (define-key map [menu-bar regexp mark]
d066de8e
EZ
1578 '(menu-item "Mark..." dired-mark-files-regexp
1579 :help "Mark files matching regexp for future operations"))
aa924deb 1580 (define-key map [menu-bar regexp mark-cont]
d066de8e
EZ
1581 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1582 :help "Mark files whose contents matches regexp"))
3e1fb00f
RS
1583
1584 (define-key map [menu-bar mark]
1585 (cons "Mark" (make-sparse-keymap "Mark")))
1586
1587 (define-key map [menu-bar mark prev]
d066de8e
EZ
1588 '(menu-item "Previous Marked" dired-prev-marked-file
1589 :help "Move to previous marked file"))
3e1fb00f 1590 (define-key map [menu-bar mark next]
d066de8e
EZ
1591 '(menu-item "Next Marked" dired-next-marked-file
1592 :help "Move to next marked file"))
3e1fb00f 1593 (define-key map [menu-bar mark marks]
d066de8e
EZ
1594 '(menu-item "Change Marks..." dired-change-marks
1595 :help "Replace marker with another character"))
3e1fb00f 1596 (define-key map [menu-bar mark unmark-all]
d066de8e 1597 '(menu-item "Unmark All" dired-unmark-all-marks))
3e1fb00f 1598 (define-key map [menu-bar mark symlinks]
d066de8e
EZ
1599 '(menu-item "Mark Symlinks" dired-mark-symlinks
1600 :visible (fboundp 'make-symbolic-link)
1601 :help "Mark all symbolic links"))
3e1fb00f 1602 (define-key map [menu-bar mark directories]
d066de8e
EZ
1603 '(menu-item "Mark Directories" dired-mark-directories
1604 :help "Mark all directories except `.' and `..'"))
3e1fb00f 1605 (define-key map [menu-bar mark directory]
d066de8e
EZ
1606 '(menu-item "Mark Old Backups" dired-clean-directory
1607 :help "Flag old numbered backups for deletion"))
3e1fb00f 1608 (define-key map [menu-bar mark executables]
d066de8e
EZ
1609 '(menu-item "Mark Executables" dired-mark-executables
1610 :help "Mark all executable files"))
84d3f6e8 1611 (define-key map [menu-bar mark garbage-files]
d066de8e
EZ
1612 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1613 :help "Flag unneeded files for deletion"))
3e1fb00f 1614 (define-key map [menu-bar mark backup-files]
d066de8e
EZ
1615 '(menu-item "Flag Backup Files" dired-flag-backup-files
1616 :help "Flag all backup files for deletion"))
3e1fb00f 1617 (define-key map [menu-bar mark auto-save-files]
d066de8e
EZ
1618 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1619 :help "Flag auto-save files for deletion"))
3e1fb00f 1620 (define-key map [menu-bar mark deletion]
d066de8e
EZ
1621 '(menu-item "Flag" dired-flag-file-deletion
1622 :help "Flag current line's file for deletion"))
3e1fb00f 1623 (define-key map [menu-bar mark unmark]
d066de8e
EZ
1624 '(menu-item "Unmark" dired-unmark
1625 :help "Unmark or unflag current line's file"))
3e1fb00f 1626 (define-key map [menu-bar mark mark]
d066de8e
EZ
1627 '(menu-item "Mark" dired-mark
1628 :help "Mark current line's file for future operations"))
e5f0841e 1629 (define-key map [menu-bar mark toggle-marks]
d588eb90 1630 '(menu-item "Toggle Marks" dired-toggle-marks
d066de8e 1631 :help "Mark unmarked files, unmark marked ones"))
3e1fb00f
RS
1632
1633 (define-key map [menu-bar operate]
1634 (cons "Operate" (make-sparse-keymap "Operate")))
1635
836788c9 1636 (define-key map
aa1a7612
CY
1637 [menu-bar operate image-dired-delete-tag]
1638 '(menu-item "Delete Image Tag..." image-dired-delete-tag
b305952d 1639 :help "Delete image tag from current or marked files"))
836788c9 1640 (define-key map
aa1a7612
CY
1641 [menu-bar operate image-dired-tag-files]
1642 '(menu-item "Add Image Tags..." image-dired-tag-files
836788c9
MD
1643 :help "Add image tags to current or marked files"))
1644 (define-key map
aa1a7612
CY
1645 [menu-bar operate image-dired-dired-comment-files]
1646 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
836788c9
MD
1647 :help "Add image comment to current or marked files"))
1648 (define-key map
aa1a7612 1649 [menu-bar operate image-dired-display-thumbs]
a41925a2
JL
1650 '(menu-item "Display image thumbnails" image-dired-display-thumbs
1651 :help "Display image thumbnails for current or marked image files"))
098bab71 1652
7cce3c91
CY
1653 (define-key map [menu-bar operate dashes-4]
1654 '("--"))
1655
1656 (define-key map
1657 [menu-bar operate epa-dired-do-decrypt]
1658 '(menu-item "Decrypt" epa-dired-do-decrypt
1659 :help "Decrypt file at cursor"))
1660
1661 (define-key map
1662 [menu-bar operate epa-dired-do-verify]
1663 '(menu-item "Verify" epa-dired-do-verify
1664 :help "Verify digital signature of file at cursor"))
1665
1666 (define-key map
1667 [menu-bar operate epa-dired-do-sign]
1668 '(menu-item "Sign" epa-dired-do-sign
1669 :help "Create digital signature of file at cursor"))
1670
1671 (define-key map
1672 [menu-bar operate epa-dired-do-encrypt]
1673 '(menu-item "Encrypt" epa-dired-do-encrypt
1674 :help "Encrypt file at cursor"))
1675
836788c9 1676 (define-key map [menu-bar operate dashes-3]
098bab71 1677 '("--"))
836788c9 1678
3e1fb00f 1679 (define-key map [menu-bar operate query-replace]
ee93b692 1680 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
d066de8e 1681 :help "Replace regexp in marked files"))
3e1fb00f 1682 (define-key map [menu-bar operate search]
d066de8e
EZ
1683 '(menu-item "Search Files..." dired-do-search
1684 :help "Search marked files for regexp"))
b89b46cf
JL
1685 (define-key map [menu-bar operate isearch-regexp]
1686 '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1687 :help "Incrementally search marked files for regexp"))
1688 (define-key map [menu-bar operate isearch]
1689 '(menu-item "Isearch Files..." dired-do-isearch
1690 :help "Incrementally search marked files for string"))
3e1fb00f 1691 (define-key map [menu-bar operate chown]
d066de8e
EZ
1692 '(menu-item "Change Owner..." dired-do-chown
1693 :visible (not (memq system-type '(ms-dos windows-nt)))
1694 :help "Change the owner of marked files"))
3e1fb00f 1695 (define-key map [menu-bar operate chgrp]
d066de8e
EZ
1696 '(menu-item "Change Group..." dired-do-chgrp
1697 :visible (not (memq system-type '(ms-dos windows-nt)))
1698 :help "Change the group of marked files"))
3e1fb00f 1699 (define-key map [menu-bar operate chmod]
d066de8e
EZ
1700 '(menu-item "Change Mode..." dired-do-chmod
1701 :help "Change mode (attributes) of marked files"))
57654b8c
JL
1702 (define-key map [menu-bar operate touch]
1703 '(menu-item "Change Timestamp..." dired-do-touch
1704 :help "Change timestamp of marked files"))
3e1fb00f 1705 (define-key map [menu-bar operate load]
d066de8e
EZ
1706 '(menu-item "Load" dired-do-load
1707 :help "Load marked Emacs Lisp files"))
3e1fb00f 1708 (define-key map [menu-bar operate compile]
d066de8e
EZ
1709 '(menu-item "Byte-compile" dired-do-byte-compile
1710 :help "Byte-compile marked Emacs Lisp files"))
3e1fb00f 1711 (define-key map [menu-bar operate compress]
d066de8e
EZ
1712 '(menu-item "Compress" dired-do-compress
1713 :help "Compress/uncompress marked files"))
3e1fb00f 1714 (define-key map [menu-bar operate print]
d066de8e
EZ
1715 '(menu-item "Print..." dired-do-print
1716 :help "Ask for print command and print marked files"))
3e1fb00f 1717 (define-key map [menu-bar operate hardlink]
d066de8e
EZ
1718 '(menu-item "Hardlink to..." dired-do-hardlink
1719 :help "Make hard links for current or marked files"))
3e1fb00f 1720 (define-key map [menu-bar operate symlink]
d066de8e
EZ
1721 '(menu-item "Symlink to..." dired-do-symlink
1722 :visible (fboundp 'make-symbolic-link)
1723 :help "Make symbolic links for current or marked files"))
077bf69b
GM
1724 (define-key map [menu-bar operate async-command]
1725 '(menu-item "Asynchronous Shell Command..." dired-do-async-shell-command
1726 :help "Run a shell command asynchronously on current or marked files"))
3e1fb00f 1727 (define-key map [menu-bar operate command]
d066de8e 1728 '(menu-item "Shell Command..." dired-do-shell-command
077bf69b 1729 :help "Run a shell command on current or marked files"))
3e1fb00f 1730 (define-key map [menu-bar operate delete]
d066de8e
EZ
1731 '(menu-item "Delete" dired-do-delete
1732 :help "Delete current file or all marked files"))
3e1fb00f 1733 (define-key map [menu-bar operate rename]
d066de8e
EZ
1734 '(menu-item "Rename to..." dired-do-rename
1735 :help "Rename current file or move marked files"))
3e1fb00f 1736 (define-key map [menu-bar operate copy]
d066de8e
EZ
1737 '(menu-item "Copy to..." dired-do-copy
1738 :help "Copy current file or all marked files"))
3e1fb00f 1739
d7aed37c
SM
1740 map)
1741 "Local keymap for `dired-mode' buffers.")
83fadedf 1742\f
84fc2cfa
ER
1743;; Dired mode is suitable only for specially formatted data.
1744(put 'dired-mode 'mode-class 'special)
1745
a515788d
LH
1746;; Autoload cookie needed by desktop.el
1747;;;###autoload
492d2437
RS
1748(defun dired-mode (&optional dirname switches)
1749 "\
1750Mode for \"editing\" directory listings.
68d2f12f 1751In Dired, you are \"editing\" a list of the files in a directory and
492d2437
RS
1752 \(optionally) its subdirectories, in the format of `ls -lR'.
1753 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1754\"Editing\" means that you can run shell commands on files, visit,
1755 compress, load or byte-compile them, change their file attributes
1756 and insert subdirectories into the same buffer. You can \"mark\"
1757 files for later commands or \"flag\" them for deletion, either file
1758 by file or all files matching certain criteria.
1759You can move using the usual cursor motion commands.\\<dired-mode-map>
1760Letters no longer insert themselves. Digits are prefix arguments.
1761Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1762Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1763 Most commands operate on the marked files and use the current file
1764 if no files are marked. Use a numeric prefix argument to operate on
1765 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1766 to operate on the current file only. Prefix arguments override marks.
1767 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1768 to see why something went wrong.
1769Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1770Type \\[dired-unmark-backward] to back up one line and unflag.
1771Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
8cb95edf 1772Type \\[dired-find-file] to Find the current line's file
492d2437
RS
1773 (or dired it in another buffer, if it is a directory).
1774Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1775Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1776Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1777Type \\[dired-do-copy] to Copy files.
ee680b2b
JB
1778Type \\[dired-sort-toggle-or-edit] to toggle Sorting by name/date or change the `ls' switches.
1779Type \\[revert-buffer] to read all currently expanded directories aGain.
492d2437
RS
1780 This retains all marks and hides subdirs again that were hidden before.
1781SPC and DEL can be used to move down and up by lines.
1782
ee680b2b 1783If Dired ever gets confused, you can either type \\[revert-buffer] \
492d2437
RS
1784to read the
1785directories again, type \\[dired-do-redisplay] \
1786to relist a single or the marked files or a
1787subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1788again for the directory tree.
1789
1790Customization variables (rename this buffer and type \\[describe-variable] on each line
1791for more info):
1792
87ae59e3
SM
1793 `dired-listing-switches'
1794 `dired-trivial-filenames'
1795 `dired-shrink-to-fit'
1796 `dired-marker-char'
1797 `dired-del-marker'
1798 `dired-keep-marker-rename'
1799 `dired-keep-marker-copy'
1800 `dired-keep-marker-hardlink'
1801 `dired-keep-marker-symlink'
492d2437
RS
1802
1803Hooks (use \\[describe-variable] to see their documentation):
1804
87ae59e3
SM
1805 `dired-before-readin-hook'
1806 `dired-after-readin-hook'
1807 `dired-mode-hook'
1808 `dired-load-hook'
492d2437
RS
1809
1810Keybindings:
84fc2cfa 1811\\{dired-mode-map}"
492d2437
RS
1812 ;; Not to be called interactively (e.g. dired-directory will be set
1813 ;; to default-directory, which is wrong with wildcards).
84fc2cfa 1814 (kill-all-local-variables)
84fc2cfa 1815 (use-local-map dired-mode-map)
492d2437
RS
1816 (dired-advertise) ; default-directory is already set
1817 (setq major-mode 'dired-mode
1818 mode-name "Dired"
87ae59e3 1819 ;; case-fold-search nil
492d2437
RS
1820 buffer-read-only t
1821 selective-display t ; for subdirectory hiding
0acdf642
GM
1822 mode-line-buffer-identification
1823 (propertized-buffer-identification "%17b"))
492d2437
RS
1824 (set (make-local-variable 'revert-buffer-function)
1825 (function dired-revert))
573e4d2d
LT
1826 (set (make-local-variable 'buffer-stale-function)
1827 (function dired-buffer-stale-p))
492d2437
RS
1828 (set (make-local-variable 'page-delimiter)
1829 "\n\n")
1830 (set (make-local-variable 'dired-directory)
1831 (or dirname default-directory))
1832 ;; list-buffers uses this to display the dir being edited in this buffer.
11ee8d90
JB
1833 (setq list-buffers-directory
1834 (expand-file-name (if (listp dired-directory)
1835 (car dired-directory)
1836 dired-directory)))
492d2437
RS
1837 (set (make-local-variable 'dired-actual-switches)
1838 (or switches dired-listing-switches))
d7aed37c
SM
1839 (set (make-local-variable 'font-lock-defaults)
1840 '(dired-font-lock-keywords t nil nil beginning-of-line))
cb5f1f67 1841 (set (make-local-variable 'desktop-save-buffer)
31b4c848 1842 'dired-desktop-buffer-misc-data)
5553077c 1843 (setq dired-switches-alist nil)
492d2437 1844 (dired-sort-other dired-actual-switches t)
361eee8f 1845 (when (featurep 'dnd)
6ae53dc1
RS
1846 (set (make-local-variable 'dnd-protocol-alist)
1847 (append dired-dnd-protocol-alist dnd-protocol-alist)))
7d371eac 1848 (add-hook 'file-name-at-point-functions 'dired-file-name-at-point nil t)
eae2c85e 1849 (add-hook 'isearch-mode-hook 'dired-isearch-filenames-setup nil t)
1ed8284d 1850 (run-mode-hooks 'dired-mode-hook))
83fadedf 1851\f
eb8c3be9 1852;; Idiosyncratic dired commands that don't deal with marks.
84fc2cfa 1853
84fc2cfa 1854(defun dired-summary ()
ee680b2b 1855 "Summarize basic Dired commands and show recent dired errors."
84fc2cfa 1856 (interactive)
492d2437 1857 (dired-why)
84fc2cfa
ER
1858 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1859 (message
50f74744 1860 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
84fc2cfa 1861
492d2437
RS
1862(defun dired-undo ()
1863 "Undo in a dired buffer.
1864This doesn't recover lost files, it just undoes changes in the buffer itself.
487327a9 1865You can use it to recover marks, killed lines or subdirs."
492d2437 1866 (interactive)
f836b98e 1867 (let ((inhibit-read-only t))
487327a9
LT
1868 (undo))
1869 (dired-build-subdir-alist)
ee680b2b 1870 (message "Change in dired buffer undone.
487327a9 1871Actual changes in files cannot be undone by Emacs."))
84fc2cfa 1872
40aa8257
JL
1873(defun dired-toggle-read-only ()
1874 "Edit dired buffer with Wdired, or set it read-only.
1875Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1876supported by Wdired (the major mode of the dired buffer is `dired-mode').
1877Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1878 (interactive)
1879 (if (eq major-mode 'dired-mode)
1880 (wdired-change-to-wdired-mode)
1881 (toggle-read-only)))
1882
84fc2cfa
ER
1883(defun dired-next-line (arg)
1884 "Move down lines then position at filename.
1885Optional prefix ARG says how many lines to move; default is one line."
1886 (interactive "p")
e82a724f 1887 (forward-line arg)
84fc2cfa
ER
1888 (dired-move-to-filename))
1889
1890(defun dired-previous-line (arg)
1891 "Move up lines then position at filename.
1892Optional prefix ARG says how many lines to move; default is one line."
1893 (interactive "p")
e82a724f 1894 (forward-line (- arg))
84fc2cfa
ER
1895 (dired-move-to-filename))
1896
492d2437
RS
1897(defun dired-next-dirline (arg &optional opoint)
1898 "Goto ARG'th next directory file line."
1899 (interactive "p")
1900 (or opoint (setq opoint (point)))
1901 (if (if (> arg 0)
1902 (re-search-forward dired-re-dir nil t arg)
1903 (beginning-of-line)
1904 (re-search-backward dired-re-dir nil t (- arg)))
1905 (dired-move-to-filename) ; user may type `i' or `f'
1906 (goto-char opoint)
1907 (error "No more subdirectories")))
1908
1909(defun dired-prev-dirline (arg)
1910 "Goto ARG'th previous directory file line."
1911 (interactive "p")
1912 (dired-next-dirline (- arg)))
1913
ac1ce341 1914(defun dired-up-directory (&optional other-window)
68d2f12f 1915 "Run Dired on parent directory of current directory.
492d2437
RS
1916Find the parent directory either in this buffer or another buffer.
1917Creates a buffer if necessary."
ac1ce341 1918 (interactive "P")
492d2437
RS
1919 (let* ((dir (dired-current-directory))
1920 (up (file-name-directory (directory-file-name dir))))
1921 (or (dired-goto-file (directory-file-name dir))
7b2469ae
RS
1922 ;; Only try dired-goto-subdir if buffer has more than one dir.
1923 (and (cdr dired-subdir-alist)
492d2437
RS
1924 (dired-goto-subdir up))
1925 (progn
ac1ce341
EN
1926 (if other-window
1927 (dired-other-window up)
1928 (dired up))
492d2437 1929 (dired-goto-file dir)))))
84fc2cfa 1930
68d2f12f
RS
1931(defun dired-get-file-for-visit ()
1932 "Get the current line's file name, with an error if file does not exist."
53fd9d05 1933 (interactive)
e9407052
RS
1934 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1935 (let ((raw (dired-get-filename nil t))
1936 file-name)
1937 (if (null raw)
1938 (error "No file on this line"))
1939 (setq file-name (file-name-sans-versions raw t))
c439687b 1940 (if (file-exists-p file-name)
68d2f12f 1941 file-name
55642aa4
RS
1942 (if (file-symlink-p file-name)
1943 (error "File is a symlink to a nonexistent target")
ee680b2b 1944 (error "File no longer exists; type `g' to update dired buffer")))))
84fc2cfa 1945
f143d380 1946;; Force C-m keybinding rather than `f' or `e' in the mode doc:
8cb95edf 1947(define-obsolete-function-alias 'dired-advertised-find-file 'dired-find-file "23.2")
68d2f12f
RS
1948(defun dired-find-file ()
1949 "In Dired, visit the file or directory named on this line."
1950 (interactive)
1d5ad120 1951 ;; Bind `find-file-run-dired' so that the command works on directories
59d18288
RS
1952 ;; too, independent of the user's setting.
1953 (let ((find-file-run-dired t))
1954 (find-file (dired-get-file-for-visit))))
68d2f12f 1955
c5753a5d 1956(defun dired-find-alternate-file ()
68d2f12f 1957 "In Dired, visit this file or directory instead of the dired buffer."
c5753a5d
GM
1958 (interactive)
1959 (set-buffer-modified-p nil)
68d2f12f 1960 (find-alternate-file (dired-get-file-for-visit)))
336cd99d 1961;; Don't override the setting from .emacs.
c21993d0 1962;;;###autoload (put 'dired-find-alternate-file 'disabled t)
c5753a5d 1963
dbcb9389 1964(defun dired-mouse-find-file-other-window (event)
68d2f12f 1965 "In Dired, visit the file or directory name you click on."
dbcb9389 1966 (interactive "e")
2aaa7f0a 1967 (let (window pos file)
dbcb9389 1968 (save-excursion
2aaa7f0a
RS
1969 (setq window (posn-window (event-end event))
1970 pos (posn-point (event-end event)))
1971 (if (not (windowp window))
1972 (error "No file chosen"))
1973 (set-buffer (window-buffer window))
1974 (goto-char pos)
1975 (setq file (dired-get-file-for-visit)))
55a87770
RS
1976 (if (file-directory-p file)
1977 (or (and (cdr dired-subdir-alist)
1978 (dired-goto-subdir file))
1979 (progn
1980 (select-window window)
1981 (dired-other-window file)))
3f68d7c8
RS
1982 (select-window window)
1983 (find-file-other-window (file-name-sans-versions file t)))))
b70ebe37 1984
84fc2cfa 1985(defun dired-view-file ()
ee680b2b 1986 "In Dired, examine a file in view mode, returning to Dired when done.
b70ebe37 1987When file is a directory, show it in this buffer if it is inserted.
3f68d7c8 1988Otherwise, display it in another buffer."
84fc2cfa 1989 (interactive)
68d2f12f
RS
1990 (let ((file (dired-get-file-for-visit)))
1991 (if (file-directory-p file)
1992 (or (and (cdr dired-subdir-alist)
1993 (dired-goto-subdir file))
1994 (dired file))
3f68d7c8 1995 (view-file file))))
84fc2cfa
ER
1996
1997(defun dired-find-file-other-window ()
68d2f12f 1998 "In Dired, visit this file or directory in another window."
84fc2cfa 1999 (interactive)
68d2f12f 2000 (find-file-other-window (dired-get-file-for-visit)))
ab67260b
RS
2001
2002(defun dired-display-file ()
68d2f12f 2003 "In Dired, display this file or directory in another window."
ab67260b 2004 (interactive)
68d2f12f 2005 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
83fadedf 2006\f
68d2f12f 2007;;; Functions for extracting and manipulating file names in Dired buffers.
84fc2cfa
ER
2008
2009(defun dired-get-filename (&optional localp no-error-if-not-filep)
68d2f12f 2010 "In Dired, return name of file mentioned on this line.
84fc2cfa 2011Value returned normally includes the directory name.
492d2437 2012Optional arg LOCALP with value `no-dir' means don't include directory
147e214c
LT
2013name in result. A value of `verbatim' means to return the name exactly as
2014it occurs in the buffer, and a value of t means construct name relative to
2015`default-directory', which still may contain slashes if in a subdirectory.
2016Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2017regular filenames and return nil if no filename on this line.
2018Otherwise, an error occurs in these cases."
a5e0e1a8 2019 (let (case-fold-search file p1 p2 already-absolute)
84fc2cfa 2020 (save-excursion
492d2437
RS
2021 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
2022 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
2023 ;; nil if no file on this line, but no-error-if-not-filep is t:
9888aa65
RS
2024 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
2025 (progn
2026 ;; Get rid of the mouse-face property that file names have.
2027 (set-text-properties 0 (length file) nil file)
2028 ;; Unquote names quoted by ls or by dired-insert-directory.
1be9bd1e
CY
2029 ;; This code was written using `read' to unquote, because
2030 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2031 ;; char) etc. in a lisp loop. Unfortunately, this decision
2032 ;; has necessitated hacks such as dealing with filenames
2033 ;; with quotation marks in their names.
2034 (while (string-match "\\(?:[^\\]\\|\\`\\)\\(\"\\)" file)
2035 (setq file (replace-match "\\\"" nil t file 1)))
abef340a 2036
d1882ac7
EW
2037 (when (eq system-type 'windows-nt)
2038 (save-match-data
2039 (let ((start 0))
2040 (while (string-match "\\\\" file start)
2041 (aset file (match-beginning 0) ?/)
2042 (setq start (match-end 0))))))
2043
1be9bd1e 2044 (setq file (read (concat "\"" file "\"")))
038b5501
KH
2045 ;; The above `read' will return a unibyte string if FILE
2046 ;; contains eight-bit-control/graphic characters.
2047 (if (and enable-multibyte-characters
2048 (not (multibyte-string-p file)))
2049 (setq file (string-to-multibyte file)))))
f6e2cbe3 2050 (and file (file-name-absolute-p file)
7994d91a
RS
2051 ;; A relative file name can start with ~.
2052 ;; Don't treat it as absolute in this context.
2053 (not (eq (aref file 0) ?~))
a5e0e1a8 2054 (setq already-absolute t))
a5e0e1a8 2055 (cond
b95ddab3
RS
2056 ((null file)
2057 nil)
1d5ad120
JB
2058 ((eq localp 'verbatim)
2059 file)
e9407052 2060 ((and (not no-error-if-not-filep)
5709c1a0 2061 (member file '("." "..")))
e9407052 2062 (error "Cannot operate on `.' or `..'"))
a5e0e1a8
EZ
2063 ((and (eq localp 'no-dir) already-absolute)
2064 (file-name-nondirectory file))
b95ddab3 2065 (already-absolute
ca66efd1
RS
2066 (let ((handler (find-file-name-handler file nil)))
2067 ;; check for safe-magic property so that we won't
2068 ;; put /: for names that don't really need them.
0b7bc76f 2069 ;; For instance, .gz files when auto-compression-mode is on.
ca66efd1
RS
2070 (if (and handler (not (get handler 'safe-magic)))
2071 (concat "/:" file)
2072 file)))
b95ddab3 2073 ((eq localp 'no-dir)
a5e0e1a8 2074 file)
b95ddab3
RS
2075 ((equal (dired-current-directory) "/")
2076 (setq file (concat (dired-current-directory localp) file))
ca66efd1
RS
2077 (let ((handler (find-file-name-handler file nil)))
2078 ;; check for safe-magic property so that we won't
2079 ;; put /: for names that don't really need them.
2080 ;; For instance, .gz files when auto-compression-mode is on.
2081 (if (and handler (not (get handler 'safe-magic)))
2082 (concat "/:" file)
2083 file)))
a5e0e1a8 2084 (t
b95ddab3 2085 (concat (dired-current-directory localp) file)))))
492d2437 2086
437fe5ae 2087(defun dired-string-replace-match (regexp string newtext
1d5ad120 2088 &optional literal global)
437fe5ae
RS
2089 "Replace first match of REGEXP in STRING with NEWTEXT.
2090If it does not match, nil is returned instead of the new string.
2091Optional arg LITERAL means to take NEWTEXT literally.
2092Optional arg GLOBAL means to replace all matches."
2093 (if global
b976e099 2094 (let ((start 0) ret)
856321e2
RS
2095 (while (string-match regexp string start)
2096 (let ((from-end (- (length string) (match-end 0))))
b976e099 2097 (setq ret (setq string (replace-match newtext t literal string)))
856321e2 2098 (setq start (- (length string) from-end))))
b976e099 2099 ret)
437fe5ae
RS
2100 (if (not (string-match regexp string 0))
2101 nil
856321e2 2102 (replace-match newtext t literal string))))
437fe5ae 2103
492d2437 2104(defun dired-make-absolute (file &optional dir)
470fa6d1 2105 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
492d2437
RS
2106 ;; We can't always use expand-file-name as this would get rid of `.'
2107 ;; or expand in / instead default-directory if DIR=="".
7c2fb837 2108 ;; This should be good enough for ange-ftp.
492d2437
RS
2109 ;; It should be reasonably fast, though, as it is called in
2110 ;; dired-get-filename.
2111 (concat (or dir default-directory) file))
2112
827dc60d
RS
2113(defun dired-make-relative (file &optional dir ignore)
2114 "Convert FILE (an absolute file name) to a name relative to DIR.
2115If this is impossible, return FILE unchanged.
2116DIR must be a directory name, not a file name."
492d2437 2117 (or dir (setq dir default-directory))
7425bbff
RS
2118 ;; This case comes into play if default-directory is set to
2119 ;; use ~.
2120 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
2121 (setq dir (expand-file-name dir)))
492d2437
RS
2122 (if (string-match (concat "^" (regexp-quote dir)) file)
2123 (substring file (match-end 0))
7805cdbd 2124;;; (or no-error
827dc60d
RS
2125;;; (error "%s: not in directory tree growing at %s" file dir))
2126 file))
83fadedf 2127\f
492d2437
RS
2128;;; Functions for finding the file name in a dired buffer line.
2129
23e217f6
RS
2130(defvar dired-permission-flags-regexp
2131 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
2132 "Regular expression to match the permission flags in `ls -l'.")
2133
492d2437
RS
2134;; Move to first char of filename on this line.
2135;; Returns position (point) or nil if no filename on this line."
2136(defun dired-move-to-filename (&optional raise-error eol)
a12c6dca
SM
2137 "Move to the beginning of the filename on the current line.
2138Return the position of the beginning of the filename, or nil if none found."
492d2437 2139 ;; This is the UNIX version.
2b2059d8 2140 (or eol (setq eol (line-end-position)))
492d2437 2141 (beginning-of-line)
0b7bc76f 2142 ;; First try assuming `ls --dired' was used.
2b2059d8
SM
2143 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2144 (cond
2145 ((and change (< change eol))
2146 (goto-char change))
9bc260cf 2147 ((re-search-forward directory-listing-before-filename-regexp eol t)
2b2059d8
SM
2148 (goto-char (match-end 0)))
2149 ((re-search-forward dired-permission-flags-regexp eol t)
2150 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1f3b4d04 2151 (if raise-error
9bc260cf 2152 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
1f3b4d04
SM
2153 (beginning-of-line)
2154 nil)
2b2059d8
SM
2155 (raise-error
2156 (error "No file on this line")))))
492d2437
RS
2157
2158(defun dired-move-to-end-of-filename (&optional no-error)
2159 ;; Assumes point is at beginning of filename,
2160 ;; thus the rwx bit re-search-backward below will succeed in *this*
2161 ;; line if at all. So, it should be called only after
2162 ;; (dired-move-to-filename t).
2163 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2164 ;; This is the UNIX version.
0b7bc76f
RS
2165 (if (get-text-property (point) 'dired-filename)
2166 (goto-char (next-single-property-change (point) 'dired-filename))
2167 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2168 ;; case-fold-search is nil now, so we can test for capital F:
2169 (setq used-F (string-match "F" dired-actual-switches)
2170 opoint (point)
5ed619e0 2171 eol (line-end-position)
0b7bc76f
RS
2172 hidden (and selective-display
2173 (save-excursion (search-forward "\r" eol t))))
2174 (if hidden
2175 nil
2176 (save-excursion ;; Find out what kind of file this is:
2177 ;; Restrict perm bits to be non-blank,
2178 ;; otherwise this matches one char to early (looking backward):
2179 ;; "l---------" (some systems make symlinks that way)
2180 ;; "----------" (plain file with zero perms)
2181 (if (re-search-backward
2182 dired-permission-flags-regexp nil t)
2183 (setq file-type (char-after (match-beginning 1))
2184 symlink (eq file-type ?l)
2185 ;; Only with -F we need to know whether it's an executable
2186 executable (and
2187 used-F
2188 (string-match
2189 "[xst]" ;; execute bit set anywhere?
2190 (concat
ff3d76aa
SM
2191 (match-string 2)
2192 (match-string 3)
2193 (match-string 4)))))
0b7bc76f
RS
2194 (or no-error (error "No file on this line"))))
2195 ;; Move point to end of name:
2196 (if symlink
a12c6dca 2197 (if (search-forward " -> " eol t)
0b7bc76f 2198 (progn
a12c6dca 2199 (forward-char -4)
0b7bc76f
RS
2200 (and used-F
2201 dired-ls-F-marks-symlinks
2202 (eq (preceding-char) ?@) ;; did ls really mark the link?
2203 (forward-char -1))))
2204 (goto-char eol) ;; else not a symbolic link
dd52fff6
TTN
2205 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2206 ;; one trailing character. (Executable bits on symlinks ain't mean
0b7bc76f
RS
2207 ;; a thing, even to ls, but we know it's not a symlink.)
2208 (and used-F
dd52fff6 2209 (or (memq file-type '(?d ?s ?p))
0b7bc76f
RS
2210 executable)
2211 (forward-char -1))))
2212 (or no-error
2213 (not (eq opoint (point)))
8c16bd8c 2214 (error "%s" (if hidden
0b7bc76f
RS
2215 (substitute-command-keys
2216 "File line is hidden, type \\[dired-hide-subdir] to unhide")
2217 "No file on this line")))
2218 (if (eq opoint (point))
2219 nil
2220 (point)))))
492d2437 2221
83fadedf 2222\f
a3f4a3ef
RS
2223;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2224
2225(defun dired-copy-filename-as-kill (&optional arg)
2226 "Copy names of marked (or next ARG) files into the kill ring.
2227The names are separated by a space.
470fa6d1 2228With a zero prefix arg, use the absolute file name of each marked file.
ee680b2b 2229With \\[universal-argument], use the file name relative to the dired buffer's
afda9919 2230`default-directory'. (This still may contain slashes if in a subdirectory.)
a3f4a3ef 2231
afda9919
LT
2232If on a subdir headerline, use absolute subdirname instead;
2233prefix arg and marked files are ignored in this case.
a3f4a3ef
RS
2234
2235You can then feed the file name(s) to other commands with \\[yank]."
2236 (interactive "P")
2237 (let ((string
2238 (or (dired-get-subdir)
2239 (mapconcat (function identity)
2240 (if arg
2241 (cond ((zerop (prefix-numeric-value arg))
2242 (dired-get-marked-files))
afda9919
LT
2243 ((consp arg)
2244 (dired-get-marked-files t))
2245 (t
2246 (dired-get-marked-files
2247 'no-dir (prefix-numeric-value arg))))
a3f4a3ef
RS
2248 (dired-get-marked-files 'no-dir))
2249 " "))))
4de547e4
RS
2250 (if (eq last-command 'kill-region)
2251 (kill-append string nil)
2252 (kill-new string))
a3f4a3ef
RS
2253 (message "%s" string)))
2254
2255\f
492d2437
RS
2256;; Keeping Dired buffers in sync with the filesystem and with each other
2257
ef746164 2258(defun dired-buffers-for-dir (dir &optional file)
dad7c716 2259;; Return a list of buffers for DIR (top level or in-situ subdir).
ef746164
RS
2260;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2261;; matches FILE.
492d2437
RS
2262;; The list is in reverse order of buffer creation, most recent last.
2263;; As a side effect, killed dired buffers for DIR are removed from
2264;; dired-buffers.
2265 (setq dir (file-name-as-directory dir))
dad7c716
CY
2266 (let (result buf)
2267 (dolist (elt dired-buffers)
2268 (setq buf (cdr elt))
2269 (cond
2270 ((null (buffer-name buf))
2271 ;; Buffer is killed - clean up:
38819778 2272 (setq dired-buffers (delq elt dired-buffers)))
dad7c716
CY
2273 ((dired-in-this-tree dir (car elt))
2274 (with-current-buffer buf
2275 (and (assoc dir dired-subdir-alist)
2276 (or (null file)
2277 (if (stringp dired-directory)
2278 (let ((wildcards (file-name-nondirectory
2279 dired-directory)))
2280 (or (= 0 (length wildcards))
2281 (string-match (dired-glob-regexp wildcards)
2282 file)))
2283 (member (expand-file-name file dir)
2284 (cdr dired-directory))))
2285 (setq result (cons buf result)))))))
492d2437
RS
2286 result))
2287
ef746164
RS
2288(defun dired-glob-regexp (pattern)
2289 "Convert glob-pattern PATTERN to a regular expression."
2290 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2291 regexp)
2292 (while (string-match "[[?*]" pattern matched-in-pattern)
2293 (let ((op-end (match-end 0))
2294 (next-op (aref pattern (match-beginning 0))))
2295 (setq regexp (concat regexp
2296 (regexp-quote
2297 (substring pattern matched-in-pattern
2298 (match-beginning 0)))))
2299 (cond ((= next-op ??)
2300 (setq regexp (concat regexp "."))
2301 (setq matched-in-pattern op-end))
2302 ((= next-op ?\[)
2303 ;; Fails to handle ^ yet ????
2304 (let* ((set-start (match-beginning 0))
2305 (set-cont
2306 (if (= (aref pattern (1+ set-start)) ?^)
2307 (+ 3 set-start)
2308 (+ 2 set-start)))
2309 (set-end (string-match "]" pattern set-cont))
2310 (set (substring pattern set-start (1+ set-end))))
2311 (setq regexp (concat regexp set))
2312 (setq matched-in-pattern (1+ set-end))))
2313 ((= next-op ?*)
2314 (setq regexp (concat regexp ".*"))
2315 (setq matched-in-pattern op-end)))))
2316 (concat "\\`"
2317 regexp
2318 (regexp-quote
2319 (substring pattern matched-in-pattern))
2320 "\\'")))
2321
c60ee5e7 2322
ef746164 2323
492d2437
RS
2324(defun dired-advertise ()
2325 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2326 ;; With wildcards we actually advertise too much.
38819778
RS
2327 (let ((expanded-default (expand-file-name default-directory)))
2328 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2329 t ; we have already advertised ourselves
2330 (setq dired-buffers
2331 (cons (cons expanded-default (current-buffer))
2332 dired-buffers)))))
492d2437
RS
2333
2334(defun dired-unadvertise (dir)
2335 ;; Remove DIR from the buffer alist in variable dired-buffers.
2336 ;; This has the effect of removing any buffer whose main directory is DIR.
2337 ;; It does not affect buffers in which DIR is a subdir.
2338 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2339 (setq dired-buffers
38819778 2340 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
83fadedf 2341\f
492d2437
RS
2342;; Tree Dired
2343
2344;;; utility functions
2345
2346(defun dired-in-this-tree (file dir)
2347 ;;"Is FILE part of the directory tree starting at DIR?"
2348 (let (case-fold-search)
38819778 2349 (string-match (concat "^" (regexp-quote dir)) file)))
492d2437
RS
2350
2351(defun dired-normalize-subdir (dir)
470fa6d1
KS
2352 ;; Prepend default-directory to DIR if relative file name.
2353 ;; dired-get-filename must be able to make a valid file name from a
492d2437
RS
2354 ;; file and its directory DIR.
2355 (file-name-as-directory
2356 (if (file-name-absolute-p dir)
2357 dir
2358 (expand-file-name dir default-directory))))
2359
2360(defun dired-get-subdir ()
2361 ;;"Return the subdir name on this line, or nil if not on a headerline."
2362 ;; Look up in the alist whether this is a headerline.
2363 (save-excursion
2364 (let ((cur-dir (dired-current-directory)))
2365 (beginning-of-line) ; alist stores b-o-l positions
2366 (and (zerop (- (point)
2367 (dired-get-subdir-min (assoc cur-dir
2368 dired-subdir-alist))))
2369 cur-dir))))
2370
2371;(defun dired-get-subdir-min (elt)
2372; (cdr elt))
2373;; can't use macro, must be redefinable for other alist format in dired-nstd.
62f61df0 2374(defalias 'dired-get-subdir-min 'cdr)
492d2437
RS
2375
2376(defun dired-get-subdir-max (elt)
84fc2cfa 2377 (save-excursion
492d2437
RS
2378 (goto-char (dired-get-subdir-min elt))
2379 (dired-subdir-max)))
2380
2381(defun dired-clear-alist ()
2382 (while dired-subdir-alist
2383 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2384 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2385
c9d59fc2
RS
2386(defun dired-subdir-index (dir)
2387 ;; Return an index into alist for use with nth
2388 ;; for the sake of subdir moving commands.
2389 (let (found (index 0) (alist dired-subdir-alist))
2390 (while alist
2391 (if (string= dir (car (car alist)))
2392 (setq alist nil found t)
2393 (setq alist (cdr alist) index (1+ index))))
2394 (if found index nil)))
2395
2396(defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2397 "Go to next subdirectory, regardless of level."
2398 ;; Use 0 arg to go to this directory's header line.
2399 ;; NO-SKIP prevents moving to end of header line, returning whatever
2400 ;; position was found in dired-subdir-alist.
2401 (interactive "p")
2402 (let ((this-dir (dired-current-directory))
2403 pos index)
2404 ;; nth with negative arg does not return nil but the first element
2405 (setq index (- (dired-subdir-index this-dir) arg))
2406 (setq pos (if (>= index 0)
2407 (dired-get-subdir-min (nth index dired-subdir-alist))))
2408 (if pos
2409 (progn
2410 (goto-char pos)
2411 (or no-skip (skip-chars-forward "^\n\r"))
2412 (point))
2413 (if no-error-if-not-found
2414 nil ; return nil if not found
2415 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2416
3c13627a 2417(defun dired-build-subdir-alist (&optional switches)
492d2437 2418 "Build `dired-subdir-alist' by parsing the buffer.
3c13627a
EZ
2419Returns the new value of the alist.
2420If optional arg SWITCHES is non-nil, use its value
2421instead of `dired-actual-switches'."
492d2437
RS
2422 (interactive)
2423 (dired-clear-alist)
2424 (save-excursion
3c13627a 2425 (let* ((count 0)
f836b98e 2426 (inhibit-read-only t)
784a48b2 2427 (buffer-undo-list t)
3c13627a
EZ
2428 (switches (or switches dired-actual-switches))
2429 new-dir-name
2430 (R-ftp-base-dir-regex
2431 ;; Used to expand subdirectory names correctly in recursive
2432 ;; ange-ftp listings.
2433 (and (string-match "R" switches)
2434 (string-match "\\`/.*:\\(/.*\\)" default-directory)
2435 (concat "\\`" (match-string 1 default-directory)))))
84fc2cfa 2436 (goto-char (point-min))
492d2437 2437 (setq dired-subdir-alist nil)
a3d76960
RS
2438 (while (re-search-forward dired-subdir-regexp nil t)
2439 ;; Avoid taking a file name ending in a colon
2440 ;; as a subdir name.
2441 (unless (save-excursion
2442 (goto-char (match-beginning 0))
2443 (beginning-of-line)
2444 (forward-char 2)
2445 (save-match-data (looking-at dired-re-perms)))
2446 (save-excursion
2447 (goto-char (match-beginning 1))
2448 (setq new-dir-name
2449 (buffer-substring-no-properties (point) (match-end 1))
2450 new-dir-name
2451 (save-match-data
2452 (if (and R-ftp-base-dir-regex
2453 (not (string= new-dir-name default-directory))
2454 (string-match R-ftp-base-dir-regex new-dir-name))
2455 (concat default-directory
2456 (substring new-dir-name (match-end 0)))
2457 (expand-file-name new-dir-name))))
2458 (delete-region (point) (match-end 1))
7de3f9a4
RS
2459 (insert new-dir-name))
2460 (setq count (1+ count))
2461 (dired-alist-add-1 new-dir-name
2462 ;; Place a sub directory boundary between lines.
2463 (save-excursion
2464 (goto-char (match-beginning 0))
2465 (beginning-of-line)
2466 (point-marker)))))
32226619 2467 (if (and (> count 1) (called-interactively-p 'interactive))
a3d76960
RS
2468 (message "Buffer includes %d directories" count)))
2469 ;; We don't need to sort it because it is in buffer order per
2470 ;; constructionem. Return new alist:
2471 dired-subdir-alist))
492d2437
RS
2472
2473(defun dired-alist-add-1 (dir new-marker)
2474 ;; Add new DIR at NEW-MARKER. Don't sort.
2475 (setq dired-subdir-alist
2476 (cons (cons (dired-normalize-subdir dir) new-marker)
2477 dired-subdir-alist)))
2478
2479(defun dired-goto-next-nontrivial-file ()
2480 ;; Position point on first nontrivial file after point.
2481 (dired-goto-next-file);; so there is a file to compare with
2482 (if (stringp dired-trivial-filenames)
2483 (while (and (not (eobp))
2484 (string-match dired-trivial-filenames
2485 (file-name-nondirectory
2486 (or (dired-get-filename nil t) ""))))
2487 (forward-line 1)
2488 (dired-move-to-filename))))
2489
2490(defun dired-goto-next-file ()
2491 (let ((max (1- (dired-subdir-max))))
2492 (while (and (not (dired-move-to-filename)) (< (point) max))
2493 (forward-line 1))))
2494
2495(defun dired-goto-file (file)
e19d2d64 2496 "Go to line describing file FILE in this dired buffer."
492d2437 2497 ;; Return value of point on success, else nil.
470fa6d1 2498 ;; FILE must be an absolute file name.
492d2437
RS
2499 ;; Loses if FILE contains control chars like "\007" for which ls
2500 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2501 ;; it in the buffer.
2502 (interactive
2503 (prog1 ; let push-mark display its message
2504 (list (expand-file-name
2505 (read-file-name "Goto file: "
2506 (dired-current-directory))))
2507 (push-mark)))
2508 (setq file (directory-file-name file)) ; does no harm if no directory
2509 (let (found case-fold-search dir)
2510 (setq dir (or (file-name-directory file)
f808da9e 2511 (error "File name `%s' is not absolute" file)))
492d2437
RS
2512 (save-excursion
2513 ;; The hair here is to get the result of dired-goto-subdir
2514 ;; without really calling it if we don't have any subdirs.
233993a3 2515 (if (if (string= dir (expand-file-name default-directory))
492d2437 2516 (goto-char (point-min))
7b2469ae 2517 (and (cdr dired-subdir-alist)
492d2437
RS
2518 (dired-goto-subdir dir)))
2519 (let ((base (file-name-nondirectory file))
f808da9e 2520 search-string
492d2437 2521 (boundary (dired-subdir-max)))
f808da9e
RS
2522 (setq search-string
2523 (replace-regexp-in-string "\^m" "\\^m" base nil t))
2524 (setq search-string
2525 (replace-regexp-in-string "\\\\" "\\\\" search-string nil t))
492d2437
RS
2526 (while (and (not found)
2527 ;; filenames are preceded by SPC, this makes
2528 ;; the search faster (e.g. for the filename "-"!).
f808da9e
RS
2529 (search-forward (concat " " search-string)
2530 boundary 'move))
492d2437
RS
2531 ;; Match could have BASE just as initial substring or
2532 ;; or in permission bits or date or
2533 ;; not be a proper filename at all:
2534 (if (equal base (dired-get-filename 'no-dir t))
2535 ;; Must move to filename since an (actually
2536 ;; correct) match could have been elsewhere on the
2537 ;; ;; line (e.g. "-" would match somewhere in the
2538 ;; permission bits).
55e86af6
RS
2539 (setq found (dired-move-to-filename))
2540 ;; If this isn't the right line, move forward to avoid
2541 ;; trying this line again.
2542 (forward-line 1))))))
492d2437
RS
2543 (and found
2544 ;; return value of point (i.e., FOUND):
2545 (goto-char found))))
2546
2547(defun dired-initial-position (dirname)
2548 ;; Where point should go in a new listing of DIRNAME.
2549 ;; Point assumed at beginning of new subdir line.
2550 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2551 (end-of-line)
2552 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
83fadedf 2553\f
492d2437
RS
2554;; These are hooks which make tree dired work.
2555;; They are in this file because other parts of dired need to call them.
2556;; But they don't call the rest of tree dired unless there are subdirs loaded.
2557
2558;; This function is called for each retrieved filename.
2559;; It could stand to be faster, though it's mostly function call
2560;; overhead. Avoiding the function call seems to save about 10% in
2561;; dired-get-filename. Make it a defsubst?
2562(defun dired-current-directory (&optional localp)
2563 "Return the name of the subdirectory to which this line belongs.
2564This returns a string with trailing slash, like `default-directory'.
2565Optional argument means return a file name relative to `default-directory'."
2566 (let ((here (point))
2567 (alist (or dired-subdir-alist
2568 ;; probably because called in a non-dired buffer
2569 (error "No subdir-alist in %s" (current-buffer))))
2570 elt dir)
2571 (while alist
2572 (setq elt (car alist)
2573 dir (car elt)
2574 ;; use `<=' (not `<') as subdir line is part of subdir
2575 alist (if (<= (dired-get-subdir-min elt) here)
2576 nil ; found
2577 (cdr alist))))
2578 (if localp
2579 (dired-make-relative dir default-directory)
2580 dir)))
2581
2582;; Subdirs start at the beginning of their header lines and end just
2583;; before the beginning of the next header line (or end of buffer).
2584
2585(defun dired-subdir-max ()
2586 (save-excursion
7b2469ae 2587 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
492d2437
RS
2588 (point-max)
2589 (point))))
83fadedf 2590\f
492d2437
RS
2591;; Deleting files
2592
40aa8257 2593(defcustom dired-recursive-deletes 'top
9201cc28 2594 "Decide whether recursive deletes are allowed.
098bab71 2595A value of nil means no recursive deletes.
f0628026
RS
2596`always' means delete recursively without asking. This is DANGEROUS!
2597`top' means ask for each directory at top level, but delete its subdirectories
2598without asking.
2599Anything else means ask for each directory."
53ade5c7
RS
2600 :type '(choice :tag "Delete non-empty directories"
2601 (const :tag "Yes" always)
2602 (const :tag "No--only delete empty directories" nil)
2603 (const :tag "Confirm for each directory" t)
2604 (const :tag "Confirm for each top directory only" top))
f0628026
RS
2605 :group 'dired)
2606
c60ee5e7 2607;; Match anything but `.' and `..'.
f0628026
RS
2608(defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2609
2610;; Delete file, possibly delete a directory and all its files.
2611;; This function is usefull outside of dired. One could change it's name
2612;; to e.g. recursive-delete-file and put it somewhere else.
f1a5d776 2613(defun dired-delete-file (file &optional recursive trash) "\
f0628026
RS
2614Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2615RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
ee680b2b 2616nil, do not delete.
f0628026
RS
2617`always', delete recursively without asking.
2618`top', ask for each directory at top level.
2619Anything else, ask for each sub-directory."
56808ea0
MA
2620 ;; This test is equivalent to
2621 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2622 ;; but more efficient
2623 (if (not (eq t (car (file-attributes file))))
f1a5d776 2624 (delete-file file trash)
56808ea0
MA
2625 (if (and recursive
2626 (directory-files file t dired-re-no-dot) ; Not empty.
2627 (or (eq recursive 'always)
f1a5d776
CY
2628 (yes-or-no-p (format "Recursively %s %s? "
2629 (if (and trash
2630 delete-by-moving-to-trash)
2631 "trash"
2632 "delete")
56808ea0 2633 (dired-make-relative file)))))
f0628026 2634 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
56808ea0 2635 (setq recursive nil))
f1a5d776 2636 (delete-directory file recursive trash)))
f0628026 2637
7da0e9b4 2638(defun dired-do-flagged-delete (&optional nomessage)
68d2f12f 2639 "In Dired, delete the files flagged for deletion.
7da0e9b4 2640If NOMESSAGE is non-nil, we don't display any message
bce1acc3 2641if there are no flagged files.
40aa8257
JL
2642`dired-recursive-deletes' controls whether deletion of
2643non-empty directories is allowed."
492d2437
RS
2644 (interactive)
2645 (let* ((dired-marker-char dired-del-marker)
2646 (regexp (dired-marker-regexp))
2647 case-fold-search)
2648 (if (save-excursion (goto-char (point-min))
2649 (re-search-forward regexp nil t))
2650 (dired-internal-do-deletions
2651 ;; this can't move point since ARG is nil
2652 (dired-map-over-marks (cons (dired-get-filename) (point))
2653 nil)
f1a5d776 2654 nil t)
7da0e9b4
RS
2655 (or nomessage
2656 (message "(No deletions requested)")))))
492d2437
RS
2657
2658(defun dired-do-delete (&optional arg)
bce1acc3 2659 "Delete all marked (or next ARG) files.
40aa8257
JL
2660`dired-recursive-deletes' controls whether deletion of
2661non-empty directories is allowed."
492d2437
RS
2662 ;; This is more consistent with the file marking feature than
2663 ;; dired-do-flagged-delete.
2664 (interactive "P")
2665 (dired-internal-do-deletions
2666 ;; this may move point if ARG is an integer
2667 (dired-map-over-marks (cons (dired-get-filename) (point))
2668 arg)
f1a5d776 2669 arg t))
492d2437
RS
2670
2671(defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2672
f1a5d776 2673(defun dired-internal-do-deletions (l arg &optional trash)
492d2437
RS
2674 ;; L is an alist of files to delete, with their buffer positions.
2675 ;; ARG is the prefix arg.
7c2fb837 2676 ;; Filenames are absolute.
492d2437
RS
2677 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2678 ;; That way as changes are made in the buffer they do not shift the
2679 ;; lines still to be changed, so the (point) values in L stay valid.
2680 ;; Also, for subdirs in natural order, a subdir's files are deleted
2681 ;; before the subdir itself - the other way around would not work.
f1a5d776
CY
2682 (let* ((files (mapcar (function car) l))
2683 (count (length l))
2684 (succ 0)
2685 (trashing (and trash delete-by-moving-to-trash))
2686 (progress-reporter
2687 (make-progress-reporter
2688 (if trashing "Trashing..." "Deleting...")
2689 succ count)))
492d2437
RS
2690 ;; canonicalize file list for pop up
2691 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2692 (if (dired-mark-pop-up
2693 " *Deletions*" 'delete files dired-deletion-confirmer
f1a5d776
CY
2694 (format "%s %s "
2695 (if trashing "Trash" "Delete")
2696 (dired-mark-prompt arg files)))
84fc2cfa 2697 (save-excursion
492d2437
RS
2698 (let (failures);; files better be in reverse order for this loop!
2699 (while l
2700 (goto-char (cdr (car l)))
f836b98e 2701 (let ((inhibit-read-only t))
492d2437
RS
2702 (condition-case err
2703 (let ((fn (car (car l))))
f1a5d776 2704 (dired-delete-file fn dired-recursive-deletes trash)
492d2437
RS
2705 ;; if we get here, removing worked
2706 (setq succ (1+ succ))
f1a5d776 2707 (progress-reporter-update progress-reporter succ)
bf989169
RS
2708 (dired-fun-in-all-buffers
2709 (file-name-directory fn) (file-name-nondirectory fn)
2710 (function dired-delete-entry) fn))
492d2437
RS
2711 (error;; catch errors from failed deletions
2712 (dired-log "%s\n" err)
2713 (setq failures (cons (car (car l)) failures)))))
2714 (setq l (cdr l)))
2715 (if (not failures)
f1a5d776 2716 (progress-reporter-done progress-reporter)
492d2437
RS
2717 (dired-log-summary
2718 (format "%d of %d deletion%s failed"
2719 (length failures) count
2720 (dired-plural-s count))
2721 failures))))
2722 (message "(No deletions performed)")))
2723 (dired-move-to-filename))
2724
bf989169
RS
2725(defun dired-fun-in-all-buffers (directory file fun &rest args)
2726 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2727 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2728 ;; (FILE does not include a directory component.)
2729 ;; FILE may be nil, in which case ignore it.
2730 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2731 (let (success-list)
2732 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2733 file))
2734 (with-current-buffer buf
2735 (if (apply fun args)
2736 (setq success-list (cons (buffer-name buf) success-list)))))
2737 success-list))
2738
c60ee5e7 2739;; Delete the entry for FILE from
bf989169
RS
2740(defun dired-delete-entry (file)
2741 (save-excursion
2742 (and (dired-goto-file file)
f836b98e 2743 (let ((inhibit-read-only t))
bf989169
RS
2744 (delete-region (progn (beginning-of-line) (point))
2745 (save-excursion (forward-line 1) (point))))))
2746 (dired-clean-up-after-deletion file))
2747
492d2437
RS
2748;; This is a separate function for the sake of dired-x.el.
2749(defun dired-clean-up-after-deletion (fn)
2750 ;; Clean up after a deleted file or directory FN.
7b2469ae
RS
2751 (save-excursion (and (cdr dired-subdir-alist)
2752 (dired-goto-subdir fn)
492d2437 2753 (dired-kill-subdir))))
83fadedf 2754\f
492d2437
RS
2755;; Confirmation
2756
2757(defun dired-marker-regexp ()
2758 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2759
2760(defun dired-plural-s (count)
2761 (if (= 1 count) "" "s"))
2762
2763(defun dired-mark-prompt (arg files)
bb5527ce
SM
2764 "Return a string for use in a prompt, either the current file
2765name, or the marker and a count of marked files."
2766 ;; distinguish-one-marked can cause the first element to be just t.
2767 (if (eq (car files) t) (setq files (cdr files)))
492d2437
RS
2768 (let ((count (length files)))
2769 (if (= count 1)
2770 (car files)
2771 ;; more than 1 file:
2772 (if (integerp arg)
2773 ;; abs(arg) = count
2774 ;; Perhaps this is nicer, but it also takes more screen space:
2775 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2776 ;; count)
2777 (format "[next %d files]" arg)
2778 (format "%c [%d files]" dired-marker-char count)))))
2779
2780(defun dired-pop-to-buffer (buf)
7f0995a1 2781 "Pop up buffer BUF in a way suitable for Dired."
19998f14
MR
2782 (let ((split-window-preferred-function
2783 (lambda (window)
b50e9ccf
MR
2784 (or (and (let ((split-height-threshold 0))
2785 (window-splittable-p (selected-window)))
19998f14
MR
2786 ;; Try to split the selected window vertically if
2787 ;; that's possible. (Bug#1806)
2788 (split-window-vertically))
2789 ;; Otherwise, try to split WINDOW sensibly.
6ed96c33
MR
2790 (split-window-sensibly window))))
2791 pop-up-frames)
7f0995a1 2792 (pop-to-buffer (get-buffer-create buf)))
492d2437 2793 ;; If dired-shrink-to-fit is t, make its window fit its contents.
d7e78187 2794 (when dired-shrink-to-fit
4d0e7fe3
MR
2795 ;; Try to not delete window when we want to display less than
2796 ;; `window-min-height' lines.
2797 (fit-window-to-buffer (get-buffer-window buf) nil 1)))
492d2437 2798
5afea280 2799(defcustom dired-no-confirm nil
9c0deccb 2800 "A list of symbols for commands Dired should not confirm, or t.
0347d069 2801Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
57654b8c 2802`copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
9c0deccb
JB
2803`touch' and `uncompress'.
2804If t, confirmation is never needed."
5afea280 2805 :group 'dired
9c0deccb
JB
2806 :type '(choice (const :tag "Confirmation never needed" t)
2807 (set (const byte-compile) (const chgrp)
2808 (const chmod) (const chown) (const compress)
2809 (const copy) (const delete) (const hardlink)
2810 (const load) (const move) (const print)
2811 (const shell) (const symlink) (const touch)
2812 (const uncompress))))
492d2437
RS
2813
2814(defun dired-mark-pop-up (bufname op-symbol files function &rest args)
8421685f
RS
2815 "Return FUNCTION's result on ARGS after showing which files are marked.
2816Displays the file names in a buffer named BUFNAME;
2817 nil gives \" *Marked Files*\".
2818This uses function `dired-pop-to-buffer' to do that.
2819
2820FUNCTION should not manipulate files, just read input
2821 (an argument or confirmation).
89101e46
SM
2822The window is not shown if there is just one file or
2823 OP-SYMBOL is a member of the list in `dired-no-confirm'.
09b092ad
RS
2824FILES is the list of marked files. It can also be (t FILENAME)
2825in the case of one marked file, to distinguish that from using
2826just the current file."
492d2437 2827 (or bufname (setq bufname " *Marked Files*"))
0347d069
SM
2828 (if (or (eq dired-no-confirm t)
2829 (memq op-symbol dired-no-confirm)
09b092ad 2830 ;; If FILES defaulted to the current line's file.
492d2437
RS
2831 (= (length files) 1))
2832 (apply function args)
89101e46 2833 (with-current-buffer (get-buffer-create bufname)
492d2437 2834 (erase-buffer)
09b092ad
RS
2835 ;; Handle (t FILE) just like (FILE), here.
2836 ;; That value is used (only in some cases), to mean
2837 ;; just one file that was marked, rather than the current line file.
2838 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
1a0b9ae6
EZ
2839 (remove-text-properties (point-min) (point-max)
2840 '(mouse-face nil help-echo nil)))
492d2437
RS
2841 (save-window-excursion
2842 (dired-pop-to-buffer bufname)
2843 (apply function args))))
2844
2845(defun dired-format-columns-of-files (files)
991ae4e4
SM
2846 (let ((beg (point)))
2847 (completion--insert-strings files)
2848 (put-text-property beg (point) 'mouse-face nil)))
83fadedf 2849\f
492d2437
RS
2850;; Commands to mark or flag file(s) at or near current line.
2851
2852(defun dired-repeat-over-lines (arg function)
2853 ;; This version skips non-file lines.
cfe89c4f 2854 (let ((pos (make-marker)))
492d2437 2855 (beginning-of-line)
cfe89c4f
RS
2856 (while (and (> arg 0) (not (eobp)))
2857 (setq arg (1- arg))
2858 (beginning-of-line)
2859 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2860 (save-excursion
2861 (forward-line 1)
2862 (move-marker pos (1+ (point))))
2863 (save-excursion (funcall function))
2864 ;; Advance to the next line--actually, to the line that *was* next.
2865 ;; (If FUNCTION inserted some new lines in between, skip them.)
2866 (goto-char pos))
2867 (while (and (< arg 0) (not (bobp)))
2868 (setq arg (1+ arg))
2869 (forward-line -1)
2870 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2871 (beginning-of-line)
2872 (save-excursion (funcall function)))
2873 (move-marker pos nil)
2874 (dired-move-to-filename)))
492d2437
RS
2875
2876(defun dired-between-files ()
8a372755
MB
2877 ;; This used to be a regexp match of the `total ...' line output by
2878 ;; ls, which is slightly faster, but that is not very robust; notably,
2879 ;; it fails for non-english locales.
2880 (save-excursion (not (dired-move-to-filename))))
492d2437
RS
2881
2882(defun dired-next-marked-file (arg &optional wrap opoint)
2883 "Move to the next marked file, wrapping around the end of the buffer."
2884 (interactive "p\np")
2885 (or opoint (setq opoint (point)));; return to where interactively started
2886 (if (if (> arg 0)
2887 (re-search-forward dired-re-mark nil t arg)
2888 (beginning-of-line)
2889 (re-search-backward dired-re-mark nil t (- arg)))
2890 (dired-move-to-filename)
2891 (if (null wrap)
2892 (progn
2893 (goto-char opoint)
2894 (error "No next marked file"))
2895 (message "(Wraparound for next marked file)")
2896 (goto-char (if (> arg 0) (point-min) (point-max)))
2897 (dired-next-marked-file arg nil opoint))))
2898
2899(defun dired-prev-marked-file (arg &optional wrap)
2900 "Move to the previous marked file, wrapping around the end of the buffer."
2901 (interactive "p\np")
2902 (dired-next-marked-file (- arg) wrap))
2903
2904(defun dired-file-marker (file)
2905 ;; Return FILE's marker, or nil if unmarked.
2906 (save-excursion
2907 (and (dired-goto-file file)
2908 (progn
2909 (beginning-of-line)
2910 (if (not (equal ?\040 (following-char)))
2911 (following-char))))))
2912
2913(defun dired-mark-files-in-region (start end)
f836b98e 2914 (let ((inhibit-read-only t))
492d2437
RS
2915 (if (> start end)
2916 (error "start > end"))
2917 (goto-char start) ; assumed at beginning of line
2918 (while (< (point) end)
2919 ;; Skip subdir line and following garbage like the `total' line:
2920 (while (and (< (point) end) (dired-between-files))
2921 (forward-line 1))
2922 (if (and (not (looking-at dired-re-dot))
2923 (dired-get-filename nil t))
2924 (progn
2925 (delete-char 1)
2926 (insert dired-marker-char)))
2927 (forward-line 1))))
2928
2929(defun dired-mark (arg)
2930 "Mark the current (or next ARG) files.
2931If on a subdir headerline, mark all its files except `.' and `..'.
2932
2933Use \\[dired-unmark-all-files] to remove all marks
2934and \\[dired-unmark] on a subdir to remove the marks in
2935this subdir."
2936 (interactive "P")
277568f2 2937 (if (dired-get-subdir)
492d2437 2938 (save-excursion (dired-mark-subdir-files))
f836b98e 2939 (let ((inhibit-read-only t))
492d2437 2940 (dired-repeat-over-lines
52041219 2941 (prefix-numeric-value arg)
492d2437
RS
2942 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2943
2944(defun dired-unmark (arg)
2945 "Unmark the current (or next ARG) files.
2946If looking at a subdir, unmark all its files except `.' and `..'."
2947 (interactive "P")
2948 (let ((dired-marker-char ?\040))
2949 (dired-mark arg)))
2950
2951(defun dired-flag-file-deletion (arg)
68d2f12f 2952 "In Dired, flag the current line's file for deletion.
492d2437
RS
2953With prefix arg, repeat over several lines.
2954
2955If on a subdir headerline, mark all its files except `.' and `..'."
2956 (interactive "P")
2957 (let ((dired-marker-char dired-del-marker))
2958 (dired-mark arg)))
2959
2960(defun dired-unmark-backward (arg)
68d2f12f 2961 "In Dired, move up lines and remove deletion flag there.
492d2437
RS
2962Optional prefix ARG says how many lines to unflag; default is one line."
2963 (interactive "p")
2964 (dired-unmark (- arg)))
e5f0841e 2965
d588eb90
RS
2966(defun dired-toggle-marks ()
2967 "Toggle marks: marked files become unmarked, and vice versa.
e5f0841e
KH
2968Files marked with other flags (such as `D') are not affected.
2969`.' and `..' are never toggled.
2970As always, hidden subdirs are not affected."
2971 (interactive)
2972 (save-excursion
2973 (goto-char (point-min))
f836b98e 2974 (let ((inhibit-read-only t))
e5f0841e
KH
2975 (while (not (eobp))
2976 (or (dired-between-files)
2977 (looking-at dired-re-dot)
2978 ;; use subst instead of insdel because it does not move
2979 ;; the gap and thus should be faster and because
2980 ;; other characters are left alone automatically
2981 (apply 'subst-char-in-region
2982 (point) (1+ (point))
2983 (if (eq ?\040 (following-char)) ; SPC
2984 (list ?\040 dired-marker-char)
2985 (list dired-marker-char ?\040))))
2986 (forward-line 1)))))
83fadedf 2987\f
492d2437
RS
2988;;; Commands to mark or flag files based on their characteristics or names.
2989
d2cadc4b
RS
2990(defvar dired-regexp-history nil
2991 "History list of regular expressions used in Dired commands.")
2992
2993(defun dired-read-regexp (prompt)
2994 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
492d2437
RS
2995
2996(defun dired-mark-files-regexp (regexp &optional marker-char)
2997 "Mark all files matching REGEXP for use in later commands.
2998A prefix argument means to unmark them instead.
2999`.' and `..' are never marked.
3000
3001REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
3002object files--just `.o' will mark more than you might think."
3003 (interactive
3004 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
3005 " files (regexp): "))
3006 (if current-prefix-arg ?\040)))
3007 (let ((dired-marker-char (or marker-char dired-marker-char)))
3008 (dired-mark-if
3009 (and (not (looking-at dired-re-dot))
3010 (not (eolp)) ; empty line
3011 (let ((fn (dired-get-filename nil t)))
3012 (and fn (string-match regexp (file-name-nondirectory fn)))))
3013 "matching file")))
3014
e9b8e22d
RS
3015(defun dired-mark-files-containing-regexp (regexp &optional marker-char)
3016 "Mark all files with contents containing REGEXP for use in later commands.
3017A prefix argument means to unmark them instead.
3018`.' and `..' are never marked."
3019 (interactive
3020 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
3021 " files containing (regexp): "))
3022 (if current-prefix-arg ?\040)))
3023 (let ((dired-marker-char (or marker-char dired-marker-char)))
3024 (dired-mark-if
3025 (and (not (looking-at dired-re-dot))
3026 (not (eolp)) ; empty line
3027 (let ((fn (dired-get-filename nil t)))
05a40373
KH
3028 (when (and fn (file-readable-p fn)
3029 (not (file-directory-p fn)))
3030 (let ((prebuf (get-file-buffer fn)))
3031 (message "Checking %s" fn)
3032 ;; For now we do it inside emacs
3033 ;; Grep might be better if there are a lot of files
3034 (if prebuf
3035 (with-current-buffer prebuf
3036 (save-excursion
3037 (goto-char (point-min))
3038 (re-search-forward regexp nil t)))
3039 (with-temp-buffer
3040 (insert-file-contents fn)
3041 (goto-char (point-min))
3042 (re-search-forward regexp nil t))))
0b2bb4d0 3043 )))
e9b8e22d
RS
3044 "matching file")))
3045
492d2437 3046(defun dired-flag-files-regexp (regexp)
68d2f12f 3047 "In Dired, flag all files containing the specified REGEXP for deletion.
492d2437
RS
3048The match is against the non-directory part of the filename. Use `^'
3049 and `$' to anchor matches. Exclude subdirs by hiding them.
3050`.' and `..' are never flagged."
3051 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
3052 (dired-mark-files-regexp regexp dired-del-marker))
3053
3054(defun dired-mark-symlinks (unflag-p)
3055 "Mark all symbolic links.
3056With prefix argument, unflag all those files."
3057 (interactive "P")
3058 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3059 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
3060
3061(defun dired-mark-directories (unflag-p)
3062 "Mark all directory file lines except `.' and `..'.
3063With prefix argument, unflag all those files."
3064 (interactive "P")
3065 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3066 (dired-mark-if (and (looking-at dired-re-dir)
3067 (not (looking-at dired-re-dot)))
3068 "directory file")))
3069
3070(defun dired-mark-executables (unflag-p)
3071 "Mark all executable files.
3072With prefix argument, unflag all those files."
3073 (interactive "P")
3074 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3075 (dired-mark-if (looking-at dired-re-exe) "executable file")))
3076
3077;; dired-x.el has a dired-mark-sexp interactive command: mark
3078;; files for which PREDICATE returns non-nil.
3079
3080(defun dired-flag-auto-save-files (&optional unflag-p)
84fc2cfa
ER
3081 "Flag for deletion files whose names suggest they are auto save files.
3082A prefix argument says to unflag those files instead."
3083 (interactive "P")
492d2437
RS
3084 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
3085 (dired-mark-if
2a838614 3086 ;; It is less than general to check for # here,
a91526b9
RS
3087 ;; but it's the only way this runs fast enough.
3088 (and (save-excursion (end-of-line)
536ae2dd
RS
3089 (or
3090 (eq (preceding-char) ?#)
3091 ;; Handle executables in case of -F option.
3092 ;; We need not worry about the other kinds
3093 ;; of markings that -F makes, since they won't
3094 ;; appear on real auto-save files.
3095 (if (eq (preceding-char) ?*)
3096 (progn
3097 (forward-char -1)
3098 (eq (preceding-char) ?#)))))
a91526b9
RS
3099 (not (looking-at dired-re-dir))
3100 (let ((fn (dired-get-filename t t)))
3101 (if fn (auto-save-file-name-p
3102 (file-name-nondirectory fn)))))
3103 "auto save file")))
492d2437 3104
d7aed37c 3105(defcustom dired-garbage-files-regexp
6736ab5a 3106 ;; `log' here is dubious, since it's typically used for useful log
d7aed37c 3107 ;; files, not just TeX stuff. -- fx
d4aeef3b
KG
3108 (concat (regexp-opt
3109 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
c60ee5e7 3110 "\\'")
d7aed37c
SM
3111 "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
3112 :type 'regexp
3113 :group 'dired)
84d3f6e8
RS
3114
3115(defun dired-flag-garbage-files ()
84d3f6e8 3116 "Flag for deletion all files that match `dired-garbage-files-regexp'."
f656ec48 3117 (interactive)
84d3f6e8
RS
3118 (dired-flag-files-regexp dired-garbage-files-regexp))
3119
492d2437
RS
3120(defun dired-flag-backup-files (&optional unflag-p)
3121 "Flag all backup files (names ending with `~') for deletion.
3122With prefix argument, unflag these files."
3123 (interactive "P")
ee680b2b 3124 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
492d2437 3125 (dired-mark-if
f13101e9
KH
3126 ;; Don't call backup-file-name-p unless the last character looks like
3127 ;; it might be the end of a backup file name. This isn't very general,
a91526b9
RS
3128 ;; but it's the only way this runs fast enough.
3129 (and (save-excursion (end-of-line)
f13101e9
KH
3130 ;; Handle executables in case of -F option.
3131 ;; We need not worry about the other kinds
3132 ;; of markings that -F makes, since they won't
3133 ;; appear on real backup files.
3134 (if (eq (preceding-char) ?*)
3135 (forward-char -1))
fdee13ec 3136 (eq (preceding-char) ?~))
a91526b9 3137 (not (looking-at dired-re-dir))
492d2437
RS
3138 (let ((fn (dired-get-filename t t)))
3139 (if fn (backup-file-name-p fn))))
3140 "backup file")))
3141
6482fcac
RS
3142(defun dired-change-marks (&optional old new)
3143 "Change all OLD marks to NEW marks.
3144OLD and NEW are both characters used to mark files."
3145 (interactive
3146 (let* ((cursor-in-echo-area t)
3147 (old (progn (message "Change (old mark): ") (read-char)))
3148 (new (progn (message "Change %c marks to (new mark): " old)
3149 (read-char))))
3150 (list old new)))
e4e02841
RS
3151 (if (or (eq old ?\r) (eq new ?\r))
3152 (ding)
3153 (let ((string (format "\n%c" old))
f836b98e 3154 (inhibit-read-only t))
e4e02841
RS
3155 (save-excursion
3156 (goto-char (point-min))
3157 (while (search-forward string nil t)
ee680b2b 3158 (if (if (= old ?\s)
a15a76f7
RS
3159 (save-match-data
3160 (dired-get-filename 'no-dir t))
3161 t)
3162 (subst-char-in-region (match-beginning 0)
3163 (match-end 0) old new)))))))
6482fcac 3164
534a6edf 3165(defun dired-unmark-all-marks ()
ee680b2b 3166 "Remove all marks from all files in the dired buffer."
b1ecd9c6
RS
3167 (interactive)
3168 (dired-unmark-all-files ?\r))
3169
8b87a301 3170(defun dired-unmark-all-files (mark &optional arg)
b602ba2f 3171 "Remove a specific mark (or any mark) from every file.
c60ee5e7 3172After this command, type the mark character to remove,
b602ba2f 3173or type RET to remove all marks.
3585916f 3174With prefix arg, query for each marked file.
492d2437 3175Type \\[help-command] at that time for help."
b602ba2f
RS
3176 (interactive "cRemove marks (RET means all): \nP")
3177 (save-excursion
3178 (let* ((count 0)
f836b98e 3179 (inhibit-read-only t) case-fold-search query
b602ba2f
RS
3180 (string (format "\n%c" mark))
3181 (help-form "\
8b87a301
RS
3182Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3183`!' to unmark all remaining files with no more questions."))
b602ba2f
RS
3184 (goto-char (point-min))
3185 (while (if (eq mark ?\r)
3186 (re-search-forward dired-re-mark nil t)
3187 (search-forward string nil t))
3188 (if (or (not arg)
e9407052
RS
3189 (let ((file (dired-get-filename t t)))
3190 (and file
3191 (dired-query 'query "Unmark file `%s'? "
3192 file))))
b602ba2f 3193 (progn (subst-char-in-region (1- (point)) (point)
ee680b2b 3194 (preceding-char) ?\s)
b602ba2f
RS
3195 (setq count (1+ count)))))
3196 (message (if (= count 1) "1 mark removed"
3197 "%d marks removed")
3198 count))))
83fadedf 3199\f
492d2437 3200;; Logging failures operating on files, and showing the results.
84fc2cfa 3201
492d2437 3202(defvar dired-log-buffer "*Dired log*")
84fc2cfa 3203
492d2437
RS
3204(defun dired-why ()
3205 "Pop up a buffer with error log output from Dired.
3206A group of errors from a single command ends with a formfeed.
3207Thus, use \\[backward-page] to find the beginning of a group of errors."
3208 (interactive)
3209 (if (get-buffer dired-log-buffer)
3210 (let ((owindow (selected-window))
3211 (window (display-buffer (get-buffer dired-log-buffer))))
3212 (unwind-protect
6482fcac 3213 (progn
492d2437
RS
3214 (select-window window)
3215 (goto-char (point-max))
0b7bc76f
RS
3216 (forward-line -1)
3217 (backward-page 1)
3218 (recenter 0))
492d2437
RS
3219 (select-window owindow)))))
3220
3221(defun dired-log (log &rest args)
3222 ;; Log a message or the contents of a buffer.
3223 ;; If LOG is a string and there are more args, it is formatted with
3224 ;; those ARGS. Usually the LOG string ends with a \n.
c60ee5e7 3225 ;; End each bunch of errors with (dired-log t):
0b7bc76f
RS
3226 ;; this inserts the current time and buffer at the start of the page,
3227 ;; and \f (formfeed) at the end.
492d2437 3228 (let ((obuf (current-buffer)))
0b7bc76f
RS
3229 (with-current-buffer (get-buffer-create dired-log-buffer)
3230 (goto-char (point-max))
3231 (let ((inhibit-read-only t))
3232 (cond ((stringp log)
3233 (insert (if args
3234 (apply (function format) log args)
3235 log)))
3236 ((bufferp log)
88cb5d3c 3237 (insert-buffer-substring log))
0b7bc76f
RS
3238 ((eq t log)
3239 (backward-page 1)
3240 (unless (bolp)
3241 (insert "\n"))
3242 (insert (current-time-string)
3243 "\tBuffer `" (buffer-name obuf) "'\n")
3244 (goto-char (point-max))
3245 (insert "\f\n")))))))
492d2437
RS
3246
3247(defun dired-log-summary (string failures)
ddcfebf1
RS
3248 "State a summary of a command's failures, in echo area and log buffer.
3249STRING is an overall summary of the failures.
3250FAILURES is a list of file names that we failed to operate on,
3251or nil if file names are not applicable."
0b7bc76f
RS
3252 (if (= (length failures) 1)
3253 (message "%s"
3254 (with-current-buffer dired-log-buffer
3255 (goto-char (point-max))
3256 (backward-page 1)
3257 (if (eolp) (forward-line 1))
3258 (buffer-substring (point) (point-max))))
3259 (message (if failures "%s--type ? for details (%s)"
3260 "%s--type ? for details")
3261 string failures))
492d2437 3262 ;; Log a summary describing a bunch of errors.
0b7bc76f 3263 (dired-log (concat "\n" string "\n"))
492d2437 3264 (dired-log t))
83fadedf 3265\f
492d2437
RS
3266;;; Sorting
3267
3268;; Most ls can only sort by name or by date (with -t), nothing else.
3269;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3270;; So anything that does not contain these is sort "by name".
3271
3272(defvar dired-ls-sorting-switches "SXU"
87ae59e3 3273 "String of `ls' switches \(single letters\) except \"t\" that influence sorting.
cfc8b264
EZ
3274
3275This indicates to Dired which option switches to watch out for because they
3276will change the sorting order behavior of `ls'.
3277
3278To change the default sorting order \(e.g. add a `-v' option\), see the
3279variable `dired-listing-switches'. To temporarily override the listing
3280format, use `\\[universal-argument] \\[dired]'.")
492d2437
RS
3281
3282(defvar dired-sort-by-date-regexp
8d76af4a
CY
3283 (concat "\\(\\`\\| \\)-[^- ]*t"
3284 ;; `dired-ls-sorting-switches' after -t overrides -t.
3285 "[^ " dired-ls-sorting-switches "]*"
3286 "\\(\\(\\`\\| +\\)\\(--[^ ]+\\|-[^- t"
3287 dired-ls-sorting-switches "]+\\)\\)* *$")
ee680b2b 3288 "Regexp recognized by Dired to set `by date' mode.")
492d2437
RS
3289
3290(defvar dired-sort-by-name-regexp
8d76af4a
CY
3291 (concat "\\`\\(\\(\\`\\| +\\)\\(--[^ ]+\\|"
3292 "-[^- t" dired-ls-sorting-switches "]+\\)\\)* *$")
ee680b2b 3293 "Regexp recognized by Dired to set `by name' mode.")
492d2437 3294
23fc67ea
RS
3295(defvar dired-sort-inhibit nil
3296 "Non-nil means the Dired sort command is disabled.
ee680b2b 3297The idea is to set this buffer-locally in special dired buffers.")
23fc67ea 3298
492d2437
RS
3299(defun dired-sort-set-modeline ()
3300 ;; Set modeline display according to dired-actual-switches.
3301 ;; Modeline display of "by name" or "by date" guarantees the user a
3302 ;; match with the corresponding regexps. Non-matching switches are
3303 ;; shown literally.
5641671f
NR
3304 (when (eq major-mode 'dired-mode)
3305 (setq mode-name
3306 (let (case-fold-search)
098bab71 3307 (cond ((string-match
5641671f
NR
3308 dired-sort-by-name-regexp dired-actual-switches)
3309 "Dired by name")
3310 ((string-match
3311 dired-sort-by-date-regexp dired-actual-switches)
3312 "Dired by date")
3313 (t
3314 (concat "Dired " dired-actual-switches)))))
3315 (force-mode-line-update)))
492d2437
RS
3316
3317(defun dired-sort-toggle-or-edit (&optional arg)
8d76af4a
CY
3318 "Toggle sorting by date, and refresh the Dired buffer.
3319With a prefix argument, edit the current listing switches instead."
84fc2cfa 3320 (interactive "P")
23fc67ea 3321 (when dired-sort-inhibit
ee680b2b 3322 (error "Cannot sort this dired buffer"))
492d2437
RS
3323 (if arg
3324 (dired-sort-other
3325 (read-string "ls switches (must contain -l): " dired-actual-switches))
3326 (dired-sort-toggle)))
3327
3328(defun dired-sort-toggle ()
3329 ;; Toggle between sort by date/name. Reverts the buffer.
8d76af4a
CY
3330 (let ((sorting-by-date (string-match dired-sort-by-date-regexp
3331 dired-actual-switches))
3332 ;; Regexp for finding (possibly embedded) -t switches.
3333 (switch-regexp "\\(\\`\\| \\)-\\([a-su-zA-Z]*\\)\\(t\\)\\([^ ]*\\)")
3334 case-fold-search)
3335 ;; Remove the -t switch.
3336 (while (string-match switch-regexp dired-actual-switches)
3337 (if (and (equal (match-string 2 dired-actual-switches) "")
3338 (equal (match-string 4 dired-actual-switches) ""))
3339 ;; Remove a stand-alone -t switch.
3340 (setq dired-actual-switches
3341 (replace-match "" t t dired-actual-switches))
3342 ;; Remove a switch of the form -XtY for some X and Y.
3343 (setq dired-actual-switches
3344 (replace-match "" t t dired-actual-switches 3))))
3345 ;; Now, if we weren't sorting by date before, add the -t switch.
3346 (unless sorting-by-date
3347 (setq dired-actual-switches (concat dired-actual-switches " -t"))))
492d2437
RS
3348 (dired-sort-set-modeline)
3349 (revert-buffer))
3350
83fadedf 3351;; Some user code loads dired especially for this.
879fa8d0 3352;; Don't do that--use replace-regexp-in-string instead.
83fadedf
DL
3353(defun dired-replace-in-string (regexp newtext string)
3354 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3355 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3356 (let ((result "") (start 0) mb me)
3357 (while (string-match regexp string start)
3358 (setq mb (match-beginning 0)
3359 me (match-end 0)
3360 result (concat result (substring string start mb) newtext)
3361 start me))
3362 (concat result (substring string start))))
3363
492d2437 3364(defun dired-sort-other (switches &optional no-revert)
ee680b2b 3365 "Specify new `ls' SWITCHES for current dired buffer.
ff3d76aa
SM
3366Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3367set the minor mode accordingly, others appear literally in the mode line.
3368With optional second arg NO-REVERT, don't refresh the listing afterwards."
e17dba1f 3369 (dired-sort-R-check switches)
492d2437 3370 (setq dired-actual-switches switches)
5641671f 3371 (dired-sort-set-modeline)
492d2437 3372 (or no-revert (revert-buffer)))
e17dba1f 3373
5afea280
RS
3374(defvar dired-subdir-alist-pre-R nil
3375 "Value of `dired-subdir-alist' before -R switch added.")
75461997 3376(make-variable-buffer-local 'dired-subdir-alist-pre-R)
e17dba1f
GM
3377
3378(defun dired-sort-R-check (switches)
3379 "Additional processing of -R in ls option string SWITCHES.
3380Saves `dired-subdir-alist' when R is set and restores saved value
3381minus any directories explicitly deleted when R is cleared.
3382To be called first in body of `dired-sort-other', etc."
3383 (cond
3384 ((and (string-match "R" switches)
3385 (not (string-match "R" dired-actual-switches)))
3386 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3387 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3388 ((and (string-match "R" dired-actual-switches)
3389 (not (string-match "R" switches)))
3390 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3391 ;; that are still present:
3392 (setq dired-subdir-alist
3393 (if dired-subdir-alist-pre-R
3394 (let (subdirs)
3395 (while dired-subdir-alist-pre-R
3396 (if (assoc (caar dired-subdir-alist-pre-R)
3397 dired-subdir-alist)
3398 ;; subdir still present...
3399 (setq subdirs
3400 (cons (car dired-subdir-alist-pre-R)
3401 subdirs)))
3402 (setq dired-subdir-alist-pre-R
3403 (cdr dired-subdir-alist-pre-R)))
3404 (reverse subdirs))
3405 ;; No pre-R subdir alist, so revert to main directory
3406 ;; listing:
3407 (list (car (reverse dired-subdir-alist))))))))
83fadedf 3408\f
133aad74
JD
3409
3410;;;; Drag and drop support
3411
773933d3 3412(defcustom dired-recursive-copies 'top
9201cc28 3413 "Decide whether recursive copies are allowed.
098bab71 3414A value of nil means no recursive copies.
fe02ba07
RS
3415`always' means copy recursively without asking.
3416`top' means ask for each directory at top level.
3417Anything else means ask for each directory."
3418 :type '(choice :tag "Copy directories"
3419 (const :tag "No recursive copies" nil)
3420 (const :tag "Ask for each directory" t)
3421 (const :tag "Ask for each top directory only" top)
3422 (const :tag "Copy directories without asking" always))
3423 :group 'dired)
3424
133aad74 3425(defun dired-dnd-popup-notice ()
fcaed7ce 3426 (message-box
3b1b11e9 3427 "Dired recursive copies are currently disabled.\nSee the variable `dired-recursive-copies'."))
133aad74 3428
e8a11b22 3429(declare-function x-popup-menu "menu.c" (position menu))
133aad74
JD
3430
3431(defun dired-dnd-do-ask-action (uri)
3432 ;; No need to get actions and descriptions from the source,
3433 ;; we only have three actions anyway.
5553077c 3434 (let ((action (x-popup-menu
133aad74
JD
3435 t
3436 (list "What action?"
3437 (cons ""
3438 '(("Copy here" . copy)
3439 ("Move here" . move)
3440 ("Link here" . link)
3441 "--"
3442 ("Cancel" . nil)))))))
3443 (if action
3444 (dired-dnd-handle-local-file uri action)
3445 nil)))
3446
5c4fa70f 3447(declare-function dired-relist-entry "dired-aux" (file))
f36d1cdc 3448(declare-function make-symbolic-link "fileio.c")
5c4fa70f 3449
aa360da1
GM
3450;; Only used when (featurep 'dnd).
3451(declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3452(declare-function dnd-get-local-file-uri "dnd" (uri))
3453
133aad74
JD
3454(defun dired-dnd-handle-local-file (uri action)
3455 "Copy, move or link a file to the dired directory.
3456URI is the file to handle, ACTION is one of copy, move, link or ask.
3457Ask means pop up a menu for the user to select one of copy, move or link."
3458 (require 'dired-aux)
361eee8f 3459 (let* ((from (dnd-get-local-file-name uri t))
93ab4de3
CY
3460 (to (when from
3461 (concat (dired-current-directory)
3462 (file-name-nondirectory from)))))
61bfceb6 3463 (when from
93ab4de3 3464 (cond ((eq action 'ask)
61bfceb6 3465 (dired-dnd-do-ask-action uri))
93ab4de3
CY
3466 ;; If copying a directory and dired-recursive-copies is
3467 ;; nil, dired-copy-file fails. Pop up a notice.
3468 ((and (memq action '(copy private))
3469 (file-directory-p from)
3470 (not dired-recursive-copies))
3471 (dired-dnd-popup-notice))
3472 ((memq action '(copy private move link))
3473 (let ((overwrite (and (file-exists-p to)
3474 (y-or-n-p
3475 (format "Overwrite existing file `%s'? " to))))
3476 ;; Binding dired-overwrite-confirmed to nil makes
3477 ;; dired-handle-overwrite a no-op. We instead use
3478 ;; y-or-n-p, which pops a graphical menu.
3479 dired-overwrite-confirmed backup-file)
3480 (when (and overwrite
3481 ;; d-b-o is defined in dired-aux.
3482 (boundp 'dired-backup-overwrite)
3483 dired-backup-overwrite
3484 (setq backup-file
3485 (car (find-backup-file-name to)))
3486 (or (eq dired-backup-overwrite 'always)
3487 (y-or-n-p
3488 (format
3489 "Make backup for existing file `%s'? " to))))
3490 (rename-file to backup-file 0)
3491 (dired-relist-entry backup-file))
3492 (cond ((memq action '(copy private))
3493 (dired-copy-file from to overwrite))
3494 ((eq action 'move)
3495 (dired-rename-file from to overwrite))
3496 ((eq action 'link)
3497 (make-symbolic-link from to overwrite)))
3498 (dired-relist-entry to)
3499 action))))))
133aad74
JD
3500
3501(defun dired-dnd-handle-file (uri action)
3502 "Copy, move or link a file to the dired directory if it is a local file.
3503URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3504ACTION is one of copy, move, link or ask.
3505Ask means pop up a menu for the user to select one of copy, move or link."
361eee8f 3506 (let ((local-file (dnd-get-local-file-uri uri)))
133aad74
JD
3507 (if local-file (dired-dnd-handle-local-file local-file action)
3508 nil)))
31b4c848
LH
3509\f
3510
3511;;;; Desktop support
3512
3513(eval-when-compile (require 'desktop))
3514
3515(defun dired-desktop-buffer-misc-data (desktop-dirname)
3516 "Auxiliary information to be saved in desktop file."
3517 (cons
3518 ;; Value of `dired-directory'.
3519 (if (consp dired-directory)
3520 ;; Directory name followed by list of files.
3521 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3522 (cdr dired-directory))
9d9ee410 3523 ;; Directory name, optionally with shell wildcard.
31b4c848
LH
3524 (desktop-file-name dired-directory desktop-dirname))
3525 ;; Subdirectories in `dired-subdir-alist'.
3526 (cdr
3527 (nreverse
3528 (mapcar
3529 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3530 dired-subdir-alist)))))
133aad74 3531
31b4c848
LH
3532(defun dired-restore-desktop-buffer (desktop-buffer-file-name
3533 desktop-buffer-name
3534 desktop-buffer-misc)
3535 "Restore a dired buffer specified in a desktop file."
3536 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
9d9ee410 3537 ;; This value is a directory name, optionally with shell wildcard or
31b4c848
LH
3538 ;; a directory name followed by list of files.
3539 (let* ((dired-dir (car desktop-buffer-misc))
3540 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3541 (if (file-directory-p (file-name-directory dir))
3542 (progn
3543 (dired dired-dir)
3544 ;; The following elements of `desktop-buffer-misc' are the keys
3545 ;; from `dired-subdir-alist'.
6ba03ad9 3546 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
31b4c848
LH
3547 (current-buffer))
3548 (message "Desktop: Directory %s no longer exists." dir)
3549 (when desktop-missing-file-warning (sit-for 1))
3550 nil)))
133aad74 3551
9e7357b0
AS
3552(add-to-list 'desktop-buffer-mode-handlers
3553 '(dired-mode . dired-restore-desktop-buffer))
a515788d 3554
133aad74 3555\f
7d72f6f1
GM
3556;;; Start of automatically extracted autoloads.
3557\f
3558;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3559;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3560;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3561;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3562;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3563;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3564;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3565;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3566;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3567;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3568;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3569;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3570;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3571;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3572;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
e730aabe 3573;;;;;; dired-diff) "dired-aux" "dired-aux.el" "e66465bcd1687d66cfb1202c9963d567")
7d72f6f1
GM
3574;;; Generated autoloads from dired-aux.el
3575
3576(autoload 'dired-diff "dired-aux" "\
3577Compare file at point with file FILE using `diff'.
3578FILE defaults to the file at the mark. (That's the mark set by
3579\\[set-mark-command], not by Dired's \\[dired-mark] command.)
3580The prompted-for file is the first file given to `diff'.
3581With prefix arg, prompt for second argument SWITCHES,
3582which is options for `diff'.
3583
3584\(fn FILE &optional SWITCHES)" t nil)
3585
3586(autoload 'dired-backup-diff "dired-aux" "\
3587Diff this file with its backup file or vice versa.
3588Uses the latest backup, if there are several numerical backups.
3589If this file is a backup, diff it with its original.
3590The backup file is the first file given to `diff'.
3591With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3592
3593\(fn &optional SWITCHES)" t nil)
3594
3595(autoload 'dired-compare-directories "dired-aux" "\
3596Mark files with different file attributes in two dired buffers.
3597Compare file attributes of files in the current directory
3598with file attributes in directory DIR2 using PREDICATE on pairs of files
3599with the same name. Mark files for which PREDICATE returns non-nil.
3600Mark files with different names if PREDICATE is nil (or interactively
3601with empty input at the predicate prompt).
3602
3603PREDICATE is a Lisp expression that can refer to the following variables:
3604
3605 size1, size2 - file size in bytes
3606 mtime1, mtime2 - last modification time in seconds, as a float
3607 fa1, fa2 - list of file attributes
3608 returned by function `file-attributes'
3609
3610 where 1 refers to attribute of file in the current dired buffer
3611 and 2 to attribute of file in second dired buffer.
3612
3613Examples of PREDICATE:
3614
3615 (> mtime1 mtime2) - mark newer files
3616 (not (= size1 size2)) - mark files with different sizes
3617 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3618 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3619 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3620
3621\(fn DIR2 PREDICATE)" t nil)
3622
3623(autoload 'dired-do-chmod "dired-aux" "\
3624Change the mode of the marked (or next ARG) files.
3625Symbolic modes like `g+w' are allowed.
3626
3627\(fn &optional ARG)" t nil)
3628
3629(autoload 'dired-do-chgrp "dired-aux" "\
3630Change the group of the marked (or next ARG) files.
3631
3632\(fn &optional ARG)" t nil)
3633
3634(autoload 'dired-do-chown "dired-aux" "\
3635Change the owner of the marked (or next ARG) files.
3636
3637\(fn &optional ARG)" t nil)
3638
3639(autoload 'dired-do-touch "dired-aux" "\
3640Change the timestamp of the marked (or next ARG) files.
3641This calls touch.
3642
3643\(fn &optional ARG)" t nil)
3644
3645(autoload 'dired-do-print "dired-aux" "\
3646Print the marked (or next ARG) files.
3647Uses the shell command coming from variables `lpr-command' and
3648`lpr-switches' as default.
3649
3650\(fn &optional ARG)" t nil)
3651
3652(autoload 'dired-clean-directory "dired-aux" "\
3653Flag numerical backups for deletion.
3654Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3655Positive prefix arg KEEP overrides `dired-kept-versions';
3656Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3657
3658To clear the flags on these files, you can use \\[dired-flag-backup-files]
3659with a prefix argument.
3660
3661\(fn KEEP)" t nil)
3662
3663(autoload 'dired-do-async-shell-command "dired-aux" "\
3664Run a shell command COMMAND on the marked files asynchronously.
3665
3666Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3667adds `* &' surrounded by whitespace and executes the command asynchronously.
3668The output appears in the buffer `*Async Shell Command*'.
3669
3670\(fn COMMAND &optional ARG FILE-LIST)" t nil)
3671
3672(autoload 'dired-do-shell-command "dired-aux" "\
3673Run a shell command COMMAND on the marked files.
3674If no files are marked or a specific numeric prefix arg is given,
3675the next ARG files are used. Just \\[universal-argument] means the current file.
3676The prompt mentions the file(s) or the marker, as appropriate.
3677
3678If there is a `*' in COMMAND, surrounded by whitespace, this runs
3679COMMAND just once with the entire file list substituted there.
3680
3681If there is no `*', but there is a `?' in COMMAND, surrounded by
3682whitespace, this runs COMMAND on each file individually with the
3683file name substituted for `?'.
3684
3685Otherwise, this runs COMMAND on each file individually with the
3686file name added at the end of COMMAND (separated by a space).
3687
3688`*' and `?' when not surrounded by whitespace have no special
3689significance for `dired-do-shell-command', and are passed through
3690normally to the shell, but you must confirm first. To pass `*' by
3691itself to the shell as a wildcard, type `*\"\"'.
3692
3693If COMMAND produces output, it goes to a separate buffer.
3694
3695This feature does not try to redisplay Dired buffers afterward, as
3696there's no telling what files COMMAND may have changed.
3697Type \\[dired-do-redisplay] to redisplay the marked files.
3698
5a0c3f56
JB
3699When COMMAND runs, its working directory is the top-level directory
3700of the Dired buffer, so output files usually are created there
3701instead of in a subdir.
7d72f6f1
GM
3702
3703In a noninteractive call (from Lisp code), you must specify
3704the list of file names explicitly with the FILE-LIST argument, which
3705can be produced by `dired-get-marked-files', for example.
3706
3707\(fn COMMAND &optional ARG FILE-LIST)" t nil)
3708
3709(autoload 'dired-run-shell-command "dired-aux" "\
3710Not documented
3711
3712\(fn COMMAND)" nil nil)
3713
3714(autoload 'dired-do-kill-lines "dired-aux" "\
3715Kill all marked lines (not the files).
3716With a prefix argument, kill that many lines starting with the current line.
3717\(A negative argument kills backward.)
3718If you use this command with a prefix argument to kill the line
3719for a file that is a directory, which you have inserted in the
3720Dired buffer as a subdirectory, then it deletes that subdirectory
3721from the buffer as well.
3722To kill an entire subdirectory (without killing its line in the
3723parent directory), go to its directory header line and use this
3724command with a prefix argument (the value does not matter).
3725
3726\(fn &optional ARG FMT)" t nil)
3727
3728(autoload 'dired-compress-file "dired-aux" "\
3729Not documented
3730
3731\(fn FILE)" nil nil)
3732
3733(autoload 'dired-query "dired-aux" "\
3ef01959
CY
3734Format PROMPT with ARGS, query user, and store the result in SYM.
3735The return value is either nil or t.
7d72f6f1 3736
3ef01959
CY
3737The user may type y or SPC to accept once; n or DEL to skip once;
3738! to accept this and subsequent queries; or q or ESC to decline
3739this and subsequent queries.
3740
3741If SYM is already bound to a non-nil value, this function may
3742return automatically without querying the user. If SYM is !,
3743return t; if SYM is q or ESC, return nil.
3744
3745\(fn SYM PROMPT &rest ARGS)" nil nil)
7d72f6f1
GM
3746
3747(autoload 'dired-do-compress "dired-aux" "\
3748Compress or uncompress marked (or next ARG) files.
3749
3750\(fn &optional ARG)" t nil)
3751
3752(autoload 'dired-do-byte-compile "dired-aux" "\
3753Byte compile marked (or next ARG) Emacs Lisp files.
3754
3755\(fn &optional ARG)" t nil)
3756
3757(autoload 'dired-do-load "dired-aux" "\
3758Load the marked (or next ARG) Emacs Lisp files.
3759
3760\(fn &optional ARG)" t nil)
3761
3762(autoload 'dired-do-redisplay "dired-aux" "\
3763Redisplay all marked (or next ARG) files.
3764If on a subdir line, redisplay that subdirectory. In that case,
3765a prefix arg lets you edit the `ls' switches used for the new listing.
3766
3767Dired remembers switches specified with a prefix arg, so that reverting
3768the buffer will not reset them. However, using `dired-undo' to re-insert
3769or delete subdirectories can bypass this machinery. Hence, you sometimes
3770may have to reset some subdirectory switches after a `dired-undo'.
3771You can reset all subdirectory switches to the default using
3772\\<dired-mode-map>\\[dired-reset-subdir-switches].
3773See Info node `(emacs)Subdir switches' for more details.
3774
3775\(fn &optional ARG TEST-FOR-SUBDIR)" t nil)
3776
3777(autoload 'dired-add-file "dired-aux" "\
3778Not documented
3779
3780\(fn FILENAME &optional MARKER-CHAR)" nil nil)
3781
3782(autoload 'dired-remove-file "dired-aux" "\
3783Not documented
3784
3785\(fn FILE)" nil nil)
3786
3787(autoload 'dired-relist-file "dired-aux" "\
3788Create or update the line for FILE in all Dired buffers it would belong in.
3789
3790\(fn FILE)" nil nil)
3791
3792(autoload 'dired-copy-file "dired-aux" "\
3793Not documented
3794
3795\(fn FROM TO OK-FLAG)" nil nil)
3796
3797(autoload 'dired-rename-file "dired-aux" "\
3798Not documented
3799
3800\(fn FILE NEWNAME OK-IF-ALREADY-EXISTS)" nil nil)
3801
3802(autoload 'dired-create-directory "dired-aux" "\
3803Create a directory called DIRECTORY.
3804
3805\(fn DIRECTORY)" t nil)
3806
3807(autoload 'dired-do-copy "dired-aux" "\
3808Copy all marked (or next ARG) files, or copy the current file.
3809This normally preserves the last-modified date when copying.
3810When operating on just the current file, you specify the new name.
3811When operating on multiple or marked files, you specify a directory,
3812and new copies of these files are made in that directory
3813with the same names that the files currently have. The default
3814suggested for the target directory depends on the value of
3815`dired-dwim-target', which see.
3816
3817This command copies symbolic links by creating new ones,
3818like `cp -d'.
3819
3820\(fn &optional ARG)" t nil)
3821
3822(autoload 'dired-do-symlink "dired-aux" "\
3823Make symbolic links to current file or all marked (or next ARG) files.
3824When operating on just the current file, you specify the new name.
3825When operating on multiple or marked files, you specify a directory
3826and new symbolic links are made in that directory
3827with the same names that the files currently have. The default
3828suggested for the target directory depends on the value of
3829`dired-dwim-target', which see.
3830
3831For relative symlinks, use \\[dired-do-relsymlink].
3832
3833\(fn &optional ARG)" t nil)
3834
3835(autoload 'dired-do-hardlink "dired-aux" "\
3836Add names (hard links) current file or all marked (or next ARG) files.
3837When operating on just the current file, you specify the new name.
3838When operating on multiple or marked files, you specify a directory
3839and new hard links are made in that directory
3840with the same names that the files currently have. The default
3841suggested for the target directory depends on the value of
3842`dired-dwim-target', which see.
3843
3844\(fn &optional ARG)" t nil)
3845
3846(autoload 'dired-do-rename "dired-aux" "\
3847Rename current file or all marked (or next ARG) files.
3848When renaming just the current file, you specify the new name.
3849When renaming multiple or marked files, you specify a directory.
3850This command also renames any buffers that are visiting the files.
3851The default suggested for the target directory depends on the value
3852of `dired-dwim-target', which see.
3853
3854\(fn &optional ARG)" t nil)
3855
3856(autoload 'dired-do-rename-regexp "dired-aux" "\
3857Rename selected files whose names match REGEXP to NEWNAME.
3858
3859With non-zero prefix argument ARG, the command operates on the next ARG
3860files. Otherwise, it operates on all the marked files, or the current
3861file if none are marked.
3862
3863As each match is found, the user must type a character saying
3864 what to do with it. For directions, type \\[help-command] at that time.
3865NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
3866REGEXP defaults to the last regexp used.
3867
3868With a zero prefix arg, renaming by regexp affects the absolute file name.
3869Normally, only the non-directory part of the file name is used and changed.
3870
3871\(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3872
3873(autoload 'dired-do-copy-regexp "dired-aux" "\
3874Copy 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-hardlink-regexp "dired-aux" "\
3880Hardlink 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-do-symlink-regexp "dired-aux" "\
3886Symlink selected files whose names match REGEXP to NEWNAME.
3887See function `dired-do-rename-regexp' for more info.
3888
3889\(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3890
3891(autoload 'dired-upcase "dired-aux" "\
3892Rename all marked (or next ARG) files to upper case.
3893
3894\(fn &optional ARG)" t nil)
3895
3896(autoload 'dired-downcase "dired-aux" "\
3897Rename all marked (or next ARG) files to lower case.
3898
3899\(fn &optional ARG)" t nil)
3900
3901(autoload 'dired-maybe-insert-subdir "dired-aux" "\
3902Insert this subdirectory into the same dired buffer.
3903If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
3904 else inserts it at its natural place (as `ls -lR' would have done).
3905With a prefix arg, you may edit the ls switches used for this listing.
3906 You can add `R' to the switches to expand the whole tree starting at
3907 this subdirectory.
3908This function takes some pains to conform to `ls -lR' output.
3909
3910Dired remembers switches specified with a prefix arg, so that reverting
3911the buffer will not reset them. However, using `dired-undo' to re-insert
3912or delete subdirectories can bypass this machinery. Hence, you sometimes
3913may have to reset some subdirectory switches after a `dired-undo'.
3914You can reset all subdirectory switches to the default using
3915\\<dired-mode-map>\\[dired-reset-subdir-switches].
3916See Info node `(emacs)Subdir switches' for more details.
3917
3918\(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
3919
3920(autoload 'dired-insert-subdir "dired-aux" "\
3921Insert this subdirectory into the same dired buffer.
3922If it is already present, overwrites previous entry,
3923 else inserts it at its natural place (as `ls -lR' would have done).
3924With a prefix arg, you may edit the `ls' switches used for this listing.
3925 You can add `R' to the switches to expand the whole tree starting at
3926 this subdirectory.
3927This function takes some pains to conform to `ls -lR' output.
3928
3929\(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
3930
3931(autoload 'dired-prev-subdir "dired-aux" "\
3932Go to previous subdirectory, regardless of level.
3933When called interactively and not on a subdir line, go to this subdir's line.
3934
3935\(fn ARG &optional NO-ERROR-IF-NOT-FOUND NO-SKIP)" t nil)
3936
3937(autoload 'dired-goto-subdir "dired-aux" "\
3938Go to end of header line of DIR in this dired buffer.
3939Return value of point on success, otherwise return nil.
3940The next char is either \\n, or \\r if DIR is hidden.
3941
3942\(fn DIR)" t nil)
3943
3944(autoload 'dired-mark-subdir-files "dired-aux" "\
3945Mark all files except `.' and `..' in current subdirectory.
3946If the Dired buffer shows multiple directories, this command
3947marks the files listed in the subdirectory that point is in.
3948
3949\(fn)" t nil)
3950
3951(autoload 'dired-kill-subdir "dired-aux" "\
3952Remove all lines of current subdirectory.
3953Lower levels are unaffected.
3954
3955\(fn &optional REMEMBER-MARKS)" t nil)
3956
3957(autoload 'dired-tree-up "dired-aux" "\
3958Go up ARG levels in the dired tree.
3959
3960\(fn ARG)" t nil)
3961
3962(autoload 'dired-tree-down "dired-aux" "\
3963Go down in the dired tree.
3964
3965\(fn)" t nil)
3966
3967(autoload 'dired-hide-subdir "dired-aux" "\
3968Hide or unhide the current subdirectory and move to next directory.
3969Optional prefix arg is a repeat factor.
3970Use \\[dired-hide-all] to (un)hide all directories.
3971
3972\(fn ARG)" t nil)
3973
3974(autoload 'dired-hide-all "dired-aux" "\
3975Hide all subdirectories, leaving only their header lines.
3976If there is already something hidden, make everything visible again.
3977Use \\[dired-hide-subdir] to (un)hide a particular subdirectory.
3978
8ae41cbc 3979\(fn &optional IGNORED)" t nil)
7d72f6f1
GM
3980
3981(autoload 'dired-isearch-filenames-setup "dired-aux" "\
3982Set up isearch to search in Dired file names.
3983Intended to be added to `isearch-mode-hook'.
3984
3985\(fn)" nil nil)
3986
3987(autoload 'dired-isearch-filenames "dired-aux" "\
3988Search for a string using Isearch only in file names in the Dired buffer.
3989
3990\(fn)" t nil)
3991
3992(autoload 'dired-isearch-filenames-regexp "dired-aux" "\
3993Search for a regexp using Isearch only in file names in the Dired buffer.
3994
3995\(fn)" t nil)
3996
3997(autoload 'dired-do-isearch "dired-aux" "\
3998Search for a string through all marked files using Isearch.
3999
4000\(fn)" t nil)
4001
4002(autoload 'dired-do-isearch-regexp "dired-aux" "\
4003Search for a regexp through all marked files using Isearch.
4004
4005\(fn)" t nil)
4006
4007(autoload 'dired-do-search "dired-aux" "\
4008Search through all marked files for a match for REGEXP.
4009Stops when a match is found.
4010To continue searching for next match, use command \\[tags-loop-continue].
4011
4012\(fn REGEXP)" t nil)
4013
4014(autoload 'dired-do-query-replace-regexp "dired-aux" "\
4015Do `query-replace-regexp' of FROM with TO, on all marked files.
4016Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4017If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
4018with the command \\[tags-loop-continue].
4019
4020\(fn FROM TO &optional DELIMITED)" t nil)
4021
4022(autoload 'dired-show-file-type "dired-aux" "\
4023Print the type of FILE, according to the `file' command.
4024If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
4025true then the type of the file linked to by FILE is printed instead.
4026
4027\(fn FILE &optional DEREF-SYMLINKS)" t nil)
4028
4029;;;***
4030\f
4031;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
2a095cec 4032;;;;;; "a2af6147cf06b53166d9e1a3bb200675")
7d72f6f1
GM
4033;;; Generated autoloads from dired-x.el
4034
4035(autoload 'dired-jump "dired-x" "\
4036Jump to dired buffer corresponding to current buffer.
4037If in a file, dired the current directory and move to file's line.
4038If in Dired already, pop up a level and goto old directory's line.
4039In case the proper dired file line cannot be found, refresh the dired
4040buffer and try again.
f5d6548a
JL
4041When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4042Interactively with prefix argument, read FILE-NAME and
4043move to its line in dired.
7d72f6f1 4044
f5d6548a 4045\(fn &optional OTHER-WINDOW FILE-NAME)" t nil)
7d72f6f1
GM
4046
4047(autoload 'dired-do-relsymlink "dired-x" "\
4048Relative symlink all marked (or next ARG) files into a directory.
4049Otherwise make a relative symbolic link to the current file.
4050This creates relative symbolic links like
4051
4052 foo -> ../bar/foo
4053
4054not absolute ones like
4055
4056 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4057
4058For absolute symlinks, use \\[dired-do-symlink].
4059
4060\(fn &optional ARG)" t nil)
4061
4062;;;***
4063\f
4064;;; End of automatically extracted autoloads.
4065
52041219
RS
4066(provide 'dired)
4067
57e15005
BF
4068(run-hooks 'dired-load-hook) ; for your customizations
4069
52041219 4070;;; dired.el ends here