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