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