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