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