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