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