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