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