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