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