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