Setup syntaxes for more parentheses Unicode characters.
[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)
133aad74
JD
1295 (run-hooks 'dired-mode-hook)
1296 (when (featurep 'x-dnd)
1297 (make-variable-buffer-local 'x-dnd-test-function)
1298 (make-variable-buffer-local 'x-dnd-protocol-alist)
1299 (setq x-dnd-test-function 'dired-dnd-test-function)
1300 (setq x-dnd-protocol-alist
1301 (append '(("^file:///" . dired-dnd-handle-local-file)
1302 ("^file://" . dired-dnd-handle-file)
1303 ("^file:" . dired-dnd-handle-local-file))
1304 x-dnd-protocol-alist))))
83fadedf 1305\f
eb8c3be9 1306;; Idiosyncratic dired commands that don't deal with marks.
84fc2cfa 1307
84fc2cfa 1308(defun dired-summary ()
492d2437 1309 "Summarize basic Dired commands and show recent Dired errors."
84fc2cfa 1310 (interactive)
492d2437 1311 (dired-why)
84fc2cfa
ER
1312 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1313 (message
50f74744 1314 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
84fc2cfa 1315
492d2437
RS
1316(defun dired-undo ()
1317 "Undo in a dired buffer.
1318This doesn't recover lost files, it just undoes changes in the buffer itself.
1319You can use it to recover marks, killed lines or subdirs.
1320In the latter case, you have to do \\[dired-build-subdir-alist] to
1321parse the buffer again."
1322 (interactive)
1323 (let (buffer-read-only)
16a2f75a
RS
1324 (undo)
1325 (message "Change in Dired buffer undone.
1326Actual changes in files cannot be undone by Emacs.")))
84fc2cfa
ER
1327
1328(defun dired-next-line (arg)
1329 "Move down lines then position at filename.
1330Optional prefix ARG says how many lines to move; default is one line."
1331 (interactive "p")
1332 (next-line arg)
1333 (dired-move-to-filename))
1334
1335(defun dired-previous-line (arg)
1336 "Move up lines then position at filename.
1337Optional prefix ARG says how many lines to move; default is one line."
1338 (interactive "p")
1339 (previous-line arg)
1340 (dired-move-to-filename))
1341
492d2437
RS
1342(defun dired-next-dirline (arg &optional opoint)
1343 "Goto ARG'th next directory file line."
1344 (interactive "p")
1345 (or opoint (setq opoint (point)))
1346 (if (if (> arg 0)
1347 (re-search-forward dired-re-dir nil t arg)
1348 (beginning-of-line)
1349 (re-search-backward dired-re-dir nil t (- arg)))
1350 (dired-move-to-filename) ; user may type `i' or `f'
1351 (goto-char opoint)
1352 (error "No more subdirectories")))
1353
1354(defun dired-prev-dirline (arg)
1355 "Goto ARG'th previous directory file line."
1356 (interactive "p")
1357 (dired-next-dirline (- arg)))
1358
ac1ce341 1359(defun dired-up-directory (&optional other-window)
68d2f12f 1360 "Run Dired on parent directory of current directory.
492d2437
RS
1361Find the parent directory either in this buffer or another buffer.
1362Creates a buffer if necessary."
ac1ce341 1363 (interactive "P")
492d2437
RS
1364 (let* ((dir (dired-current-directory))
1365 (up (file-name-directory (directory-file-name dir))))
1366 (or (dired-goto-file (directory-file-name dir))
7b2469ae
RS
1367 ;; Only try dired-goto-subdir if buffer has more than one dir.
1368 (and (cdr dired-subdir-alist)
492d2437
RS
1369 (dired-goto-subdir up))
1370 (progn
ac1ce341
EN
1371 (if other-window
1372 (dired-other-window up)
1373 (dired up))
492d2437 1374 (dired-goto-file dir)))))
84fc2cfa 1375
68d2f12f
RS
1376(defun dired-get-file-for-visit ()
1377 "Get the current line's file name, with an error if file does not exist."
53fd9d05 1378 (interactive)
e9407052
RS
1379 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1380 (let ((raw (dired-get-filename nil t))
1381 file-name)
1382 (if (null raw)
1383 (error "No file on this line"))
1384 (setq file-name (file-name-sans-versions raw t))
c439687b 1385 (if (file-exists-p file-name)
68d2f12f 1386 file-name
55642aa4
RS
1387 (if (file-symlink-p file-name)
1388 (error "File is a symlink to a nonexistent target")
1389 (error "File no longer exists; type `g' to update Dired buffer")))))
84fc2cfa 1390
68d2f12f
RS
1391;; Force `f' rather than `e' in the mode doc:
1392(defalias 'dired-advertised-find-file 'dired-find-file)
1393(defun dired-find-file ()
1394 "In Dired, visit the file or directory named on this line."
1395 (interactive)
1d5ad120 1396 ;; Bind `find-file-run-dired' so that the command works on directories
59d18288
RS
1397 ;; too, independent of the user's setting.
1398 (let ((find-file-run-dired t))
1399 (find-file (dired-get-file-for-visit))))
68d2f12f 1400
c5753a5d 1401(defun dired-find-alternate-file ()
68d2f12f 1402 "In Dired, visit this file or directory instead of the dired buffer."
c5753a5d
GM
1403 (interactive)
1404 (set-buffer-modified-p nil)
68d2f12f 1405 (find-alternate-file (dired-get-file-for-visit)))
336cd99d 1406;; Don't override the setting from .emacs.
c21993d0 1407;;;###autoload (put 'dired-find-alternate-file 'disabled t)
c5753a5d 1408
dbcb9389 1409(defun dired-mouse-find-file-other-window (event)
68d2f12f 1410 "In Dired, visit the file or directory name you click on."
dbcb9389 1411 (interactive "e")
2aaa7f0a 1412 (let (window pos file)
dbcb9389 1413 (save-excursion
2aaa7f0a
RS
1414 (setq window (posn-window (event-end event))
1415 pos (posn-point (event-end event)))
1416 (if (not (windowp window))
1417 (error "No file chosen"))
1418 (set-buffer (window-buffer window))
1419 (goto-char pos)
1420 (setq file (dired-get-file-for-visit)))
55a87770
RS
1421 (if (file-directory-p file)
1422 (or (and (cdr dired-subdir-alist)
1423 (dired-goto-subdir file))
1424 (progn
1425 (select-window window)
1426 (dired-other-window file)))
1427 (let (cmd)
1428 ;; Look for some other way to view a certain file.
1429 (dolist (elt dired-view-command-alist)
1430 (if (string-match (car elt) file)
1431 (setq cmd (cdr elt))))
1432 (if cmd
1433 (call-process shell-file-name nil 0 nil
1434 "-c"
1435 (concat (format cmd (shell-quote-argument file))
1436 " &"))
1437 (select-window window)
1438 (find-file-other-window (file-name-sans-versions file t)))))))
b70ebe37 1439
84fc2cfa 1440(defun dired-view-file ()
68d2f12f 1441 "In Dired, examine a file in view mode, returning to dired when done.
b70ebe37
RS
1442When file is a directory, show it in this buffer if it is inserted.
1443Some kinds of files are displayed using external viewer programs;
1444see `dired-view-command-alist'. Otherwise, display it in another buffer."
84fc2cfa 1445 (interactive)
68d2f12f
RS
1446 (let ((file (dired-get-file-for-visit)))
1447 (if (file-directory-p file)
1448 (or (and (cdr dired-subdir-alist)
1449 (dired-goto-subdir file))
1450 (dired file))
b70ebe37
RS
1451 (let (cmd)
1452 ;; Look for some other way to view a certain file.
1453 (dolist (elt dired-view-command-alist)
1454 (if (string-match (car elt) file)
1455 (setq cmd (cdr elt))))
1456 (if cmd
90c1e36a
RS
1457 (call-process shell-file-name nil 0 nil
1458 "-c"
55a87770 1459 (concat (format cmd (shell-quote-argument file))
90c1e36a 1460 " &"))
b70ebe37 1461 (view-file file))))))
84fc2cfa
ER
1462
1463(defun dired-find-file-other-window ()
68d2f12f 1464 "In Dired, visit this file or directory in another window."
84fc2cfa 1465 (interactive)
68d2f12f 1466 (find-file-other-window (dired-get-file-for-visit)))
ab67260b
RS
1467
1468(defun dired-display-file ()
68d2f12f 1469 "In Dired, display this file or directory in another window."
ab67260b 1470 (interactive)
68d2f12f 1471 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
83fadedf 1472\f
68d2f12f 1473;;; Functions for extracting and manipulating file names in Dired buffers.
84fc2cfa
ER
1474
1475(defun dired-get-filename (&optional localp no-error-if-not-filep)
68d2f12f 1476 "In Dired, return name of file mentioned on this line.
84fc2cfa 1477Value returned normally includes the directory name.
492d2437 1478Optional arg LOCALP with value `no-dir' means don't include directory
147e214c
LT
1479name in result. A value of `verbatim' means to return the name exactly as
1480it occurs in the buffer, and a value of t means construct name relative to
1481`default-directory', which still may contain slashes if in a subdirectory.
1482Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1483regular filenames and return nil if no filename on this line.
1484Otherwise, an error occurs in these cases."
a5e0e1a8 1485 (let (case-fold-search file p1 p2 already-absolute)
84fc2cfa 1486 (save-excursion
492d2437
RS
1487 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1488 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1489 ;; nil if no file on this line, but no-error-if-not-filep is t:
9888aa65
RS
1490 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1491 (progn
1492 ;; Get rid of the mouse-face property that file names have.
1493 (set-text-properties 0 (length file) nil file)
1494 ;; Unquote names quoted by ls or by dired-insert-directory.
1495 ;; Using read to unquote is much faster than substituting
1496 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1497 (setq file
1498 (read
1499 (concat "\""
2b2059d8 1500 ;; Some ls -b don't escape quotes, argh!
9888aa65
RS
1501 ;; This is not needed for GNU ls, though.
1502 (or (dired-string-replace-match
bc07e5cb 1503 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
9888aa65 1504 file)
038b5501
KH
1505 "\"")))
1506 ;; The above `read' will return a unibyte string if FILE
1507 ;; contains eight-bit-control/graphic characters.
1508 (if (and enable-multibyte-characters
1509 (not (multibyte-string-p file)))
1510 (setq file (string-to-multibyte file)))))
f6e2cbe3 1511 (and file (file-name-absolute-p file)
7994d91a
RS
1512 ;; A relative file name can start with ~.
1513 ;; Don't treat it as absolute in this context.
1514 (not (eq (aref file 0) ?~))
a5e0e1a8 1515 (setq already-absolute t))
a5e0e1a8 1516 (cond
b95ddab3
RS
1517 ((null file)
1518 nil)
1d5ad120
JB
1519 ((eq localp 'verbatim)
1520 file)
e9407052 1521 ((and (not no-error-if-not-filep)
147e214c
LT
1522 (save-excursion
1523 (beginning-of-line)
1524 (looking-at dired-re-dot)))
e9407052 1525 (error "Cannot operate on `.' or `..'"))
a5e0e1a8
EZ
1526 ((and (eq localp 'no-dir) already-absolute)
1527 (file-name-nondirectory file))
b95ddab3 1528 (already-absolute
ca66efd1
RS
1529 (let ((handler (find-file-name-handler file nil)))
1530 ;; check for safe-magic property so that we won't
1531 ;; put /: for names that don't really need them.
0b7bc76f 1532 ;; For instance, .gz files when auto-compression-mode is on.
ca66efd1
RS
1533 (if (and handler (not (get handler 'safe-magic)))
1534 (concat "/:" file)
1535 file)))
b95ddab3 1536 ((eq localp 'no-dir)
a5e0e1a8 1537 file)
b95ddab3
RS
1538 ((equal (dired-current-directory) "/")
1539 (setq file (concat (dired-current-directory localp) file))
ca66efd1
RS
1540 (let ((handler (find-file-name-handler file nil)))
1541 ;; check for safe-magic property so that we won't
1542 ;; put /: for names that don't really need them.
1543 ;; For instance, .gz files when auto-compression-mode is on.
1544 (if (and handler (not (get handler 'safe-magic)))
1545 (concat "/:" file)
1546 file)))
a5e0e1a8 1547 (t
b95ddab3 1548 (concat (dired-current-directory localp) file)))))
492d2437 1549
437fe5ae 1550(defun dired-string-replace-match (regexp string newtext
1d5ad120 1551 &optional literal global)
437fe5ae
RS
1552 "Replace first match of REGEXP in STRING with NEWTEXT.
1553If it does not match, nil is returned instead of the new string.
1554Optional arg LITERAL means to take NEWTEXT literally.
1555Optional arg GLOBAL means to replace all matches."
1556 (if global
b976e099 1557 (let ((start 0) ret)
856321e2
RS
1558 (while (string-match regexp string start)
1559 (let ((from-end (- (length string) (match-end 0))))
b976e099 1560 (setq ret (setq string (replace-match newtext t literal string)))
856321e2 1561 (setq start (- (length string) from-end))))
b976e099 1562 ret)
437fe5ae
RS
1563 (if (not (string-match regexp string 0))
1564 nil
856321e2 1565 (replace-match newtext t literal string))))
437fe5ae 1566
492d2437 1567(defun dired-make-absolute (file &optional dir)
470fa6d1 1568 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
492d2437
RS
1569 ;; We can't always use expand-file-name as this would get rid of `.'
1570 ;; or expand in / instead default-directory if DIR=="".
1571 ;; This should be good enough for ange-ftp, but might easily be
1572 ;; redefined (for VMS?).
1573 ;; It should be reasonably fast, though, as it is called in
1574 ;; dired-get-filename.
1575 (concat (or dir default-directory) file))
1576
827dc60d
RS
1577(defun dired-make-relative (file &optional dir ignore)
1578 "Convert FILE (an absolute file name) to a name relative to DIR.
1579If this is impossible, return FILE unchanged.
1580DIR must be a directory name, not a file name."
492d2437 1581 (or dir (setq dir default-directory))
7425bbff
RS
1582 ;; This case comes into play if default-directory is set to
1583 ;; use ~.
1584 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1585 (setq dir (expand-file-name dir)))
492d2437
RS
1586 (if (string-match (concat "^" (regexp-quote dir)) file)
1587 (substring file (match-end 0))
827dc60d
RS
1588;;; (or no-error
1589;;; (error "%s: not in directory tree growing at %s" file dir))
1590 file))
83fadedf 1591\f
492d2437
RS
1592;;; Functions for finding the file name in a dired buffer line.
1593
c4a7b2a4 1594(defvar dired-move-to-filename-regexp
2708e59e 1595 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
60389964 1596 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
6a5c00da 1597 ;; In some locales, month abbreviations are as short as 2 letters,
b4bbe888 1598 ;; and they can be followed by ".".
60389964
RS
1599 ;; In Breton, a month name can include a quote character.
1600 (month (concat l-or-quote l-or-quote "+\\.?"))
32184bdb
PE
1601 (s " ")
1602 (yyyy "[0-9][0-9][0-9][0-9]")
b4bbe888 1603 (dd "[ 0-3][0-9]")
32184bdb 1604 (HH:MM "[ 0-2][0-9]:[0-5][0-9]")
32df8b47
EZ
1605 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
1606 (zone "[-+][0-2][0-9][0-5][0-9]")
1607 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
1608 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
1609 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
b4bbe888
PE
1610 "\\|" yyyy "-" iso-mm-dd "\\)"))
1611 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
1612 s "+"
1613 "\\(" HH:MM "\\|" yyyy "\\)"))
1614 (western-comma (concat month s "+" dd "," s "+" yyyy))
1615 ;; Japanese MS-Windows ls-lisp has one-digit months, and
1616 ;; omits the Kanji characters after month and day-of-month.
1617 (mm "[ 0-1]?[0-9]")
501be301 1618 (japanese
b4bbe888
PE
1619 (concat mm l "?" s dd l "?" s "+"
1620 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
42afed7c 1621 ;; The "[0-9]" below requires the previous column to end in a digit.
6a5c00da
PE
1622 ;; This avoids recognizing `1 may 1997' as a date in the line:
1623 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
0952583c 1624 ;; The "[kKMGTPEZY]?" below supports "ls -alh" output.
42afed7c
GM
1625 ;; The ".*" below finds the last match if there are multiple matches.
1626 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
02882bbc 1627 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
0952583c 1628 (concat ".*[0-9][kKMGTPEZY]?" s
b4bbe888
PE
1629 "\\(" western "\\|" western-comma "\\|" japanese "\\|" iso "\\)"
1630 s "+"))
6a5c00da 1631 "Regular expression to match up to the file name in a directory listing.
1f97e2fc
PE
1632The default value is designed to recognize dates and times
1633regardless of the language.")
9eabb7d5 1634
23e217f6
RS
1635(defvar dired-permission-flags-regexp
1636 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1637 "Regular expression to match the permission flags in `ls -l'.")
1638
492d2437
RS
1639;; Move to first char of filename on this line.
1640;; Returns position (point) or nil if no filename on this line."
1641(defun dired-move-to-filename (&optional raise-error eol)
1642 ;; This is the UNIX version.
2b2059d8 1643 (or eol (setq eol (line-end-position)))
492d2437 1644 (beginning-of-line)
0b7bc76f 1645 ;; First try assuming `ls --dired' was used.
2b2059d8
SM
1646 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1647 (cond
1648 ((and change (< change eol))
1649 (goto-char change))
1650 ((re-search-forward dired-move-to-filename-regexp eol t)
1651 (goto-char (match-end 0)))
1652 ((re-search-forward dired-permission-flags-regexp eol t)
1653 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1654 (funcall (if raise-error 'error 'message)
1655 "Unrecognized line! Check dired-move-to-filename-regexp"))
1656 (raise-error
1657 (error "No file on this line")))))
492d2437
RS
1658
1659(defun dired-move-to-end-of-filename (&optional no-error)
1660 ;; Assumes point is at beginning of filename,
1661 ;; thus the rwx bit re-search-backward below will succeed in *this*
1662 ;; line if at all. So, it should be called only after
1663 ;; (dired-move-to-filename t).
1664 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1665 ;; This is the UNIX version.
0b7bc76f
RS
1666 (if (get-text-property (point) 'dired-filename)
1667 (goto-char (next-single-property-change (point) 'dired-filename))
1668 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1669 ;; case-fold-search is nil now, so we can test for capital F:
1670 (setq used-F (string-match "F" dired-actual-switches)
1671 opoint (point)
1672 eol (save-excursion (end-of-line) (point))
1673 hidden (and selective-display
1674 (save-excursion (search-forward "\r" eol t))))
1675 (if hidden
1676 nil
1677 (save-excursion ;; Find out what kind of file this is:
1678 ;; Restrict perm bits to be non-blank,
1679 ;; otherwise this matches one char to early (looking backward):
1680 ;; "l---------" (some systems make symlinks that way)
1681 ;; "----------" (plain file with zero perms)
1682 (if (re-search-backward
1683 dired-permission-flags-regexp nil t)
1684 (setq file-type (char-after (match-beginning 1))
1685 symlink (eq file-type ?l)
1686 ;; Only with -F we need to know whether it's an executable
1687 executable (and
1688 used-F
1689 (string-match
1690 "[xst]" ;; execute bit set anywhere?
1691 (concat
1692 (buffer-substring (match-beginning 2)
1693 (match-end 2))
1694 (buffer-substring (match-beginning 3)
1695 (match-end 3))
1696 (buffer-substring (match-beginning 4)
1697 (match-end 4))))))
1698 (or no-error (error "No file on this line"))))
1699 ;; Move point to end of name:
1700 (if symlink
1701 (if (search-forward " ->" eol t)
1702 (progn
1703 (forward-char -3)
1704 (and used-F
1705 dired-ls-F-marks-symlinks
1706 (eq (preceding-char) ?@) ;; did ls really mark the link?
1707 (forward-char -1))))
1708 (goto-char eol) ;; else not a symbolic link
1709 ;; ls -lF marks dirs, sockets and executables with exactly one
1710 ;; trailing character. (Executable bits on symlinks ain't mean
1711 ;; a thing, even to ls, but we know it's not a symlink.)
1712 (and used-F
1713 (or (memq file-type '(?d ?s))
1714 executable)
1715 (forward-char -1))))
1716 (or no-error
1717 (not (eq opoint (point)))
1718 (error (if hidden
1719 (substitute-command-keys
1720 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1721 "No file on this line")))
1722 (if (eq opoint (point))
1723 nil
1724 (point)))))
492d2437 1725
83fadedf 1726\f
a3f4a3ef
RS
1727;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1728
1729(defun dired-copy-filename-as-kill (&optional arg)
1730 "Copy names of marked (or next ARG) files into the kill ring.
1731The names are separated by a space.
470fa6d1
KS
1732With a zero prefix arg, use the absolute file name of each marked file.
1733With \\[universal-argument], use the file name sans directory of each marked file.
a3f4a3ef
RS
1734
1735If on a subdir headerline, use subdirname instead; prefix arg is ignored
1736in this case.
1737
1738You can then feed the file name(s) to other commands with \\[yank]."
1739 (interactive "P")
1740 (let ((string
1741 (or (dired-get-subdir)
1742 (mapconcat (function identity)
1743 (if arg
1744 (cond ((zerop (prefix-numeric-value arg))
1745 (dired-get-marked-files))
1746 ((integerp arg)
1747 (dired-get-marked-files 'no-dir arg))
1748 (t ; else a raw arg
1749 (dired-get-marked-files t)))
1750 (dired-get-marked-files 'no-dir))
1751 " "))))
4de547e4
RS
1752 (if (eq last-command 'kill-region)
1753 (kill-append string nil)
1754 (kill-new string))
a3f4a3ef
RS
1755 (message "%s" string)))
1756
1757\f
492d2437
RS
1758;; Keeping Dired buffers in sync with the filesystem and with each other
1759
ef746164 1760(defun dired-buffers-for-dir (dir &optional file)
492d2437 1761;; Return a list of buffers that dired DIR (top level or in-situ subdir).
ef746164
RS
1762;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1763;; matches FILE.
492d2437
RS
1764;; The list is in reverse order of buffer creation, most recent last.
1765;; As a side effect, killed dired buffers for DIR are removed from
1766;; dired-buffers.
1767 (setq dir (file-name-as-directory dir))
ef746164 1768 (let ((alist dired-buffers) result elt buf pattern)
492d2437 1769 (while alist
38819778
RS
1770 (setq elt (car alist)
1771 buf (cdr elt))
1772 (if (buffer-name buf)
1773 (if (dired-in-this-tree dir (car elt))
ef746164
RS
1774 (with-current-buffer buf
1775 (and (assoc dir dired-subdir-alist)
1776 (or (null file)
1777 (let ((wildcards
1778 (file-name-nondirectory dired-directory)))
1779 (or (= 0 (length wildcards))
1780 (string-match (dired-glob-regexp wildcards)
1781 file))))
1782 (setq result (cons buf result)))))
38819778
RS
1783 ;; else buffer is killed - clean up:
1784 (setq dired-buffers (delq elt dired-buffers)))
492d2437
RS
1785 (setq alist (cdr alist)))
1786 result))
1787
ef746164
RS
1788(defun dired-glob-regexp (pattern)
1789 "Convert glob-pattern PATTERN to a regular expression."
1790 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1791 regexp)
1792 (while (string-match "[[?*]" pattern matched-in-pattern)
1793 (let ((op-end (match-end 0))
1794 (next-op (aref pattern (match-beginning 0))))
1795 (setq regexp (concat regexp
1796 (regexp-quote
1797 (substring pattern matched-in-pattern
1798 (match-beginning 0)))))
1799 (cond ((= next-op ??)
1800 (setq regexp (concat regexp "."))
1801 (setq matched-in-pattern op-end))
1802 ((= next-op ?\[)
1803 ;; Fails to handle ^ yet ????
1804 (let* ((set-start (match-beginning 0))
1805 (set-cont
1806 (if (= (aref pattern (1+ set-start)) ?^)
1807 (+ 3 set-start)
1808 (+ 2 set-start)))
1809 (set-end (string-match "]" pattern set-cont))
1810 (set (substring pattern set-start (1+ set-end))))
1811 (setq regexp (concat regexp set))
1812 (setq matched-in-pattern (1+ set-end))))
1813 ((= next-op ?*)
1814 (setq regexp (concat regexp ".*"))
1815 (setq matched-in-pattern op-end)))))
1816 (concat "\\`"
1817 regexp
1818 (regexp-quote
1819 (substring pattern matched-in-pattern))
1820 "\\'")))
1821
c60ee5e7 1822
ef746164 1823
492d2437
RS
1824(defun dired-advertise ()
1825 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1826 ;; With wildcards we actually advertise too much.
38819778
RS
1827 (let ((expanded-default (expand-file-name default-directory)))
1828 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1829 t ; we have already advertised ourselves
1830 (setq dired-buffers
1831 (cons (cons expanded-default (current-buffer))
1832 dired-buffers)))))
492d2437
RS
1833
1834(defun dired-unadvertise (dir)
1835 ;; Remove DIR from the buffer alist in variable dired-buffers.
1836 ;; This has the effect of removing any buffer whose main directory is DIR.
1837 ;; It does not affect buffers in which DIR is a subdir.
1838 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1839 (setq dired-buffers
38819778 1840 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
83fadedf 1841\f
492d2437
RS
1842;; Tree Dired
1843
1844;;; utility functions
1845
1846(defun dired-in-this-tree (file dir)
1847 ;;"Is FILE part of the directory tree starting at DIR?"
1848 (let (case-fold-search)
38819778 1849 (string-match (concat "^" (regexp-quote dir)) file)))
492d2437
RS
1850
1851(defun dired-normalize-subdir (dir)
470fa6d1
KS
1852 ;; Prepend default-directory to DIR if relative file name.
1853 ;; dired-get-filename must be able to make a valid file name from a
492d2437
RS
1854 ;; file and its directory DIR.
1855 (file-name-as-directory
1856 (if (file-name-absolute-p dir)
1857 dir
1858 (expand-file-name dir default-directory))))
1859
1860(defun dired-get-subdir ()
1861 ;;"Return the subdir name on this line, or nil if not on a headerline."
1862 ;; Look up in the alist whether this is a headerline.
1863 (save-excursion
1864 (let ((cur-dir (dired-current-directory)))
1865 (beginning-of-line) ; alist stores b-o-l positions
1866 (and (zerop (- (point)
1867 (dired-get-subdir-min (assoc cur-dir
1868 dired-subdir-alist))))
1869 cur-dir))))
1870
1871;(defun dired-get-subdir-min (elt)
1872; (cdr elt))
1873;; can't use macro, must be redefinable for other alist format in dired-nstd.
62f61df0 1874(defalias 'dired-get-subdir-min 'cdr)
492d2437
RS
1875
1876(defun dired-get-subdir-max (elt)
84fc2cfa 1877 (save-excursion
492d2437
RS
1878 (goto-char (dired-get-subdir-min elt))
1879 (dired-subdir-max)))
1880
1881(defun dired-clear-alist ()
1882 (while dired-subdir-alist
1883 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1884 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1885
c9d59fc2
RS
1886(defun dired-subdir-index (dir)
1887 ;; Return an index into alist for use with nth
1888 ;; for the sake of subdir moving commands.
1889 (let (found (index 0) (alist dired-subdir-alist))
1890 (while alist
1891 (if (string= dir (car (car alist)))
1892 (setq alist nil found t)
1893 (setq alist (cdr alist) index (1+ index))))
1894 (if found index nil)))
1895
1896(defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1897 "Go to next subdirectory, regardless of level."
1898 ;; Use 0 arg to go to this directory's header line.
1899 ;; NO-SKIP prevents moving to end of header line, returning whatever
1900 ;; position was found in dired-subdir-alist.
1901 (interactive "p")
1902 (let ((this-dir (dired-current-directory))
1903 pos index)
1904 ;; nth with negative arg does not return nil but the first element
1905 (setq index (- (dired-subdir-index this-dir) arg))
1906 (setq pos (if (>= index 0)
1907 (dired-get-subdir-min (nth index dired-subdir-alist))))
1908 (if pos
1909 (progn
1910 (goto-char pos)
1911 (or no-skip (skip-chars-forward "^\n\r"))
1912 (point))
1913 (if no-error-if-not-found
1914 nil ; return nil if not found
1915 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1916
3c13627a 1917(defun dired-build-subdir-alist (&optional switches)
492d2437 1918 "Build `dired-subdir-alist' by parsing the buffer.
3c13627a
EZ
1919Returns the new value of the alist.
1920If optional arg SWITCHES is non-nil, use its value
1921instead of `dired-actual-switches'."
492d2437
RS
1922 (interactive)
1923 (dired-clear-alist)
1924 (save-excursion
3c13627a
EZ
1925 (let* ((count 0)
1926 (buffer-read-only nil)
1927 (switches (or switches dired-actual-switches))
1928 new-dir-name
1929 (R-ftp-base-dir-regex
1930 ;; Used to expand subdirectory names correctly in recursive
1931 ;; ange-ftp listings.
1932 (and (string-match "R" switches)
1933 (string-match "\\`/.*:\\(/.*\\)" default-directory)
1934 (concat "\\`" (match-string 1 default-directory)))))
84fc2cfa 1935 (goto-char (point-min))
492d2437 1936 (setq dired-subdir-alist nil)
acf310c9
RS
1937 (while (and (re-search-forward dired-subdir-regexp nil t)
1938 ;; Avoid taking a file name ending in a colon
1939 ;; as a subdir name.
1940 (not (save-excursion
1941 (goto-char (match-beginning 0))
1942 (beginning-of-line)
1943 (forward-char 2)
46680faf 1944 (save-match-data (looking-at dired-re-perms)))))
3222085e
BF
1945 (save-excursion
1946 (goto-char (match-beginning 1))
1947 (setq new-dir-name
b4c01776
GM
1948 (buffer-substring-no-properties (point) (match-end 1))
1949 new-dir-name
1950 (save-match-data
1951 (if (and R-ftp-base-dir-regex
1952 (not (string= new-dir-name default-directory))
1953 (string-match R-ftp-base-dir-regex new-dir-name))
1954 (concat default-directory
1955 (substring new-dir-name (match-end 0)))
1956 (expand-file-name new-dir-name))))
3222085e
BF
1957 (delete-region (point) (match-end 1))
1958 (insert new-dir-name))
492d2437 1959 (setq count (1+ count))
3222085e
BF
1960 (dired-alist-add-1 new-dir-name
1961 ;; Place a sub directory boundary between lines.
1962 (save-excursion
1963 (goto-char (match-beginning 0))
1964 (beginning-of-line)
1965 (point-marker))))
c9d59fc2
RS
1966 (if (> count 1)
1967 (message "Buffer includes %d directories" count))
492d2437
RS
1968 ;; We don't need to sort it because it is in buffer order per
1969 ;; constructionem. Return new alist:
1970 dired-subdir-alist)))
1971
1972(defun dired-alist-add-1 (dir new-marker)
1973 ;; Add new DIR at NEW-MARKER. Don't sort.
1974 (setq dired-subdir-alist
1975 (cons (cons (dired-normalize-subdir dir) new-marker)
1976 dired-subdir-alist)))
1977
1978(defun dired-goto-next-nontrivial-file ()
1979 ;; Position point on first nontrivial file after point.
1980 (dired-goto-next-file);; so there is a file to compare with
1981 (if (stringp dired-trivial-filenames)
1982 (while (and (not (eobp))
1983 (string-match dired-trivial-filenames
1984 (file-name-nondirectory
1985 (or (dired-get-filename nil t) ""))))
1986 (forward-line 1)
1987 (dired-move-to-filename))))
1988
1989(defun dired-goto-next-file ()
1990 (let ((max (1- (dired-subdir-max))))
1991 (while (and (not (dired-move-to-filename)) (< (point) max))
1992 (forward-line 1))))
1993
1994(defun dired-goto-file (file)
1995 "Go to file line of FILE in this dired buffer."
1996 ;; Return value of point on success, else nil.
470fa6d1 1997 ;; FILE must be an absolute file name.
492d2437
RS
1998 ;; Loses if FILE contains control chars like "\007" for which ls
1999 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2000 ;; it in the buffer.
2001 (interactive
2002 (prog1 ; let push-mark display its message
2003 (list (expand-file-name
2004 (read-file-name "Goto file: "
2005 (dired-current-directory))))
2006 (push-mark)))
2007 (setq file (directory-file-name file)) ; does no harm if no directory
2008 (let (found case-fold-search dir)
2009 (setq dir (or (file-name-directory file)
f808da9e 2010 (error "File name `%s' is not absolute" file)))
492d2437
RS
2011 (save-excursion
2012 ;; The hair here is to get the result of dired-goto-subdir
2013 ;; without really calling it if we don't have any subdirs.
233993a3 2014 (if (if (string= dir (expand-file-name default-directory))
492d2437 2015 (goto-char (point-min))
7b2469ae 2016 (and (cdr dired-subdir-alist)
492d2437
RS
2017 (dired-goto-subdir dir)))
2018 (let ((base (file-name-nondirectory file))
f808da9e 2019 search-string
492d2437 2020 (boundary (dired-subdir-max)))
f808da9e
RS
2021 (setq search-string
2022 (replace-regexp-in-string "\^m" "\\^m" base nil t))
2023 (setq search-string
2024 (replace-regexp-in-string "\\\\" "\\\\" search-string nil t))
492d2437
RS
2025 (while (and (not found)
2026 ;; filenames are preceded by SPC, this makes
2027 ;; the search faster (e.g. for the filename "-"!).
f808da9e
RS
2028 (search-forward (concat " " search-string)
2029 boundary 'move))
492d2437
RS
2030 ;; Match could have BASE just as initial substring or
2031 ;; or in permission bits or date or
2032 ;; not be a proper filename at all:
2033 (if (equal base (dired-get-filename 'no-dir t))
2034 ;; Must move to filename since an (actually
2035 ;; correct) match could have been elsewhere on the
2036 ;; ;; line (e.g. "-" would match somewhere in the
2037 ;; permission bits).
55e86af6
RS
2038 (setq found (dired-move-to-filename))
2039 ;; If this isn't the right line, move forward to avoid
2040 ;; trying this line again.
2041 (forward-line 1))))))
492d2437
RS
2042 (and found
2043 ;; return value of point (i.e., FOUND):
2044 (goto-char found))))
2045
2046(defun dired-initial-position (dirname)
2047 ;; Where point should go in a new listing of DIRNAME.
2048 ;; Point assumed at beginning of new subdir line.
2049 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2050 (end-of-line)
2051 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
83fadedf 2052\f
492d2437
RS
2053;; These are hooks which make tree dired work.
2054;; They are in this file because other parts of dired need to call them.
2055;; But they don't call the rest of tree dired unless there are subdirs loaded.
2056
2057;; This function is called for each retrieved filename.
2058;; It could stand to be faster, though it's mostly function call
2059;; overhead. Avoiding the function call seems to save about 10% in
2060;; dired-get-filename. Make it a defsubst?
2061(defun dired-current-directory (&optional localp)
2062 "Return the name of the subdirectory to which this line belongs.
2063This returns a string with trailing slash, like `default-directory'.
2064Optional argument means return a file name relative to `default-directory'."
2065 (let ((here (point))
2066 (alist (or dired-subdir-alist
2067 ;; probably because called in a non-dired buffer
2068 (error "No subdir-alist in %s" (current-buffer))))
2069 elt dir)
2070 (while alist
2071 (setq elt (car alist)
2072 dir (car elt)
2073 ;; use `<=' (not `<') as subdir line is part of subdir
2074 alist (if (<= (dired-get-subdir-min elt) here)
2075 nil ; found
2076 (cdr alist))))
2077 (if localp
2078 (dired-make-relative dir default-directory)
2079 dir)))
2080
2081;; Subdirs start at the beginning of their header lines and end just
2082;; before the beginning of the next header line (or end of buffer).
2083
2084(defun dired-subdir-max ()
2085 (save-excursion
7b2469ae 2086 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
492d2437
RS
2087 (point-max)
2088 (point))))
83fadedf 2089\f
492d2437
RS
2090;; Deleting files
2091
f0628026
RS
2092(defcustom dired-recursive-deletes nil ; Default only delete empty directories.
2093 "*Decide whether recursive deletes are allowed.
f0529b5b 2094nil means no recursive deletes.
f0628026
RS
2095`always' means delete recursively without asking. This is DANGEROUS!
2096`top' means ask for each directory at top level, but delete its subdirectories
2097without asking.
2098Anything else means ask for each directory."
53ade5c7
RS
2099 :type '(choice :tag "Delete non-empty directories"
2100 (const :tag "Yes" always)
2101 (const :tag "No--only delete empty directories" nil)
2102 (const :tag "Confirm for each directory" t)
2103 (const :tag "Confirm for each top directory only" top))
f0628026
RS
2104 :group 'dired)
2105
c60ee5e7 2106;; Match anything but `.' and `..'.
f0628026
RS
2107(defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2108
2109;; Delete file, possibly delete a directory and all its files.
2110;; This function is usefull outside of dired. One could change it's name
2111;; to e.g. recursive-delete-file and put it somewhere else.
2112(defun dired-delete-file (file &optional recursive) "\
2113Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2114RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2115Nil, do not delete.
2116`always', delete recursively without asking.
2117`top', ask for each directory at top level.
2118Anything else, ask for each sub-directory."
2119 (let (files)
2120 ;; This test is equivalent to
2121 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2122 ;; but more efficient
2123 (if (not (eq t (car (file-attributes file))))
2124 (delete-file file)
2125 (when (and recursive
2126 (setq files
2127 (directory-files file t dired-re-no-dot)) ; Not empty.
2128 (or (eq recursive 'always)
2129 (yes-or-no-p (format "Recursive delete of %s "
2130 (dired-make-relative file)))))
2131 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2132 (while files ; Recursively delete (possibly asking).
2133 (dired-delete-file (car files) recursive)
2134 (setq files (cdr files))))
2135 (delete-directory file))))
2136
7da0e9b4 2137(defun dired-do-flagged-delete (&optional nomessage)
68d2f12f 2138 "In Dired, delete the files flagged for deletion.
7da0e9b4
RS
2139If NOMESSAGE is non-nil, we don't display any message
2140if there are no flagged files."
492d2437
RS
2141 (interactive)
2142 (let* ((dired-marker-char dired-del-marker)
2143 (regexp (dired-marker-regexp))
2144 case-fold-search)
2145 (if (save-excursion (goto-char (point-min))
2146 (re-search-forward regexp nil t))
2147 (dired-internal-do-deletions
2148 ;; this can't move point since ARG is nil
2149 (dired-map-over-marks (cons (dired-get-filename) (point))
2150 nil)
2151 nil)
7da0e9b4
RS
2152 (or nomessage
2153 (message "(No deletions requested)")))))
492d2437
RS
2154
2155(defun dired-do-delete (&optional arg)
2156 "Delete all marked (or next ARG) files."
2157 ;; This is more consistent with the file marking feature than
2158 ;; dired-do-flagged-delete.
2159 (interactive "P")
2160 (dired-internal-do-deletions
2161 ;; this may move point if ARG is an integer
2162 (dired-map-over-marks (cons (dired-get-filename) (point))
2163 arg)
2164 arg))
2165
2166(defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2167
2168(defun dired-internal-do-deletions (l arg)
2169 ;; L is an alist of files to delete, with their buffer positions.
2170 ;; ARG is the prefix arg.
2171 ;; Filenames are absolute (VMS needs this for logical search paths).
2172 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2173 ;; That way as changes are made in the buffer they do not shift the
2174 ;; lines still to be changed, so the (point) values in L stay valid.
2175 ;; Also, for subdirs in natural order, a subdir's files are deleted
2176 ;; before the subdir itself - the other way around would not work.
2177 (let ((files (mapcar (function car) l))
2178 (count (length l))
2179 (succ 0))
2180 ;; canonicalize file list for pop up
2181 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2182 (if (dired-mark-pop-up
2183 " *Deletions*" 'delete files dired-deletion-confirmer
2184 (format "Delete %s " (dired-mark-prompt arg files)))
84fc2cfa 2185 (save-excursion
492d2437
RS
2186 (let (failures);; files better be in reverse order for this loop!
2187 (while l
2188 (goto-char (cdr (car l)))
2189 (let (buffer-read-only)
2190 (condition-case err
2191 (let ((fn (car (car l))))
f0628026 2192 (dired-delete-file fn dired-recursive-deletes)
492d2437
RS
2193 ;; if we get here, removing worked
2194 (setq succ (1+ succ))
2195 (message "%s of %s deletions" succ count)
bf989169
RS
2196 (dired-fun-in-all-buffers
2197 (file-name-directory fn) (file-name-nondirectory fn)
2198 (function dired-delete-entry) fn))
492d2437
RS
2199 (error;; catch errors from failed deletions
2200 (dired-log "%s\n" err)
2201 (setq failures (cons (car (car l)) failures)))))
2202 (setq l (cdr l)))
2203 (if (not failures)
2204 (message "%d deletion%s done" count (dired-plural-s count))
2205 (dired-log-summary
2206 (format "%d of %d deletion%s failed"
2207 (length failures) count
2208 (dired-plural-s count))
2209 failures))))
2210 (message "(No deletions performed)")))
2211 (dired-move-to-filename))
2212
bf989169
RS
2213(defun dired-fun-in-all-buffers (directory file fun &rest args)
2214 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2215 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2216 ;; (FILE does not include a directory component.)
2217 ;; FILE may be nil, in which case ignore it.
2218 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2219 (let (success-list)
2220 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2221 file))
2222 (with-current-buffer buf
2223 (if (apply fun args)
2224 (setq success-list (cons (buffer-name buf) success-list)))))
2225 success-list))
2226
c60ee5e7 2227;; Delete the entry for FILE from
bf989169
RS
2228(defun dired-delete-entry (file)
2229 (save-excursion
2230 (and (dired-goto-file file)
2231 (let (buffer-read-only)
2232 (delete-region (progn (beginning-of-line) (point))
2233 (save-excursion (forward-line 1) (point))))))
2234 (dired-clean-up-after-deletion file))
2235
492d2437
RS
2236;; This is a separate function for the sake of dired-x.el.
2237(defun dired-clean-up-after-deletion (fn)
2238 ;; Clean up after a deleted file or directory FN.
7b2469ae
RS
2239 (save-excursion (and (cdr dired-subdir-alist)
2240 (dired-goto-subdir fn)
492d2437 2241 (dired-kill-subdir))))
83fadedf 2242\f
492d2437
RS
2243;; Confirmation
2244
2245(defun dired-marker-regexp ()
2246 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2247
2248(defun dired-plural-s (count)
2249 (if (= 1 count) "" "s"))
2250
2251(defun dired-mark-prompt (arg files)
2252 ;; Return a string for use in a prompt, either the current file
2253 ;; name, or the marker and a count of marked files.
2254 (let ((count (length files)))
2255 (if (= count 1)
2256 (car files)
2257 ;; more than 1 file:
2258 (if (integerp arg)
2259 ;; abs(arg) = count
2260 ;; Perhaps this is nicer, but it also takes more screen space:
2261 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2262 ;; count)
2263 (format "[next %d files]" arg)
2264 (format "%c [%d files]" dired-marker-char count)))))
2265
2266(defun dired-pop-to-buffer (buf)
2267 ;; Pop up buffer BUF.
2268 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2269 (if (not dired-shrink-to-fit)
2270 (pop-to-buffer (get-buffer-create buf))
2271 ;; let window shrink to fit:
2272 (let ((window (selected-window))
2273 target-lines w2)
54f03575 2274 (cond ;; if split-height-threshold is enabled, use the largest window
492d2437
RS
2275 ((and (> (window-height (setq w2 (get-largest-window)))
2276 split-height-threshold)
f98955ea 2277 (= (frame-width) (window-width w2)))
492d2437
RS
2278 (setq window w2))
2279 ;; if the least-recently-used window is big enough, use it
2280 ((and (> (window-height (setq w2 (get-lru-window)))
2281 (* 2 window-min-height))
f98955ea 2282 (= (frame-width) (window-width w2)))
492d2437
RS
2283 (setq window w2)))
2284 (save-excursion
2285 (set-buffer buf)
2286 (goto-char (point-max))
2287 (skip-chars-backward "\n\r\t ")
63ea14a5
RS
2288 (setq target-lines (count-lines (point-min) (point)))
2289 ;; Don't forget to count the last line.
2290 (if (not (bolp))
2291 (setq target-lines (1+ target-lines))))
492d2437 2292 (if (<= (window-height window) (* 2 window-min-height))
f98955ea 2293 ;; At this point, every window on the frame is too small to split.
492d2437
RS
2294 (setq w2 (display-buffer buf))
2295 (setq w2 (split-window window
2296 (max window-min-height
2297 (- (window-height window)
2298 (1+ (max window-min-height target-lines)))))))
2299 (set-window-buffer w2 buf)
2300 (if (< (1- (window-height w2)) target-lines)
2301 (progn
2302 (select-window w2)
2303 (enlarge-window (- target-lines (1- (window-height w2))))))
2304 (set-window-start w2 1)
2305 )))
2306
2307(defvar dired-no-confirm nil
0347d069
SM
2308 "A list of symbols for commands dired should not confirm.
2309Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2310`copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink' and
2311`uncompress'.")
492d2437
RS
2312
2313(defun dired-mark-pop-up (bufname op-symbol files function &rest args)
8421685f
RS
2314 "Return FUNCTION's result on ARGS after showing which files are marked.
2315Displays the file names in a buffer named BUFNAME;
2316 nil gives \" *Marked Files*\".
2317This uses function `dired-pop-to-buffer' to do that.
2318
2319FUNCTION should not manipulate files, just read input
2320 (an argument or confirmation).
89101e46
SM
2321The window is not shown if there is just one file or
2322 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2323FILES is the list of marked files."
492d2437 2324 (or bufname (setq bufname " *Marked Files*"))
0347d069
SM
2325 (if (or (eq dired-no-confirm t)
2326 (memq op-symbol dired-no-confirm)
492d2437
RS
2327 (= (length files) 1))
2328 (apply function args)
89101e46 2329 (with-current-buffer (get-buffer-create bufname)
492d2437 2330 (erase-buffer)
a07e7c4a 2331 (dired-format-columns-of-files files)
1a0b9ae6
EZ
2332 (remove-text-properties (point-min) (point-max)
2333 '(mouse-face nil help-echo nil)))
492d2437
RS
2334 (save-window-excursion
2335 (dired-pop-to-buffer bufname)
2336 (apply function args))))
2337
2338(defun dired-format-columns-of-files (files)
2339 ;; Files should be in forward order for this loop.
2340 ;; i.e., (car files) = first file in buffer.
2341 ;; Returns the number of lines used.
2342 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2343 (width (- (window-width (selected-window)) 2))
2344 (columns (max 1 (/ width maxlen)))
2345 (nfiles (length files))
2346 (rows (+ (/ nfiles columns)
2347 (if (zerop (% nfiles columns)) 0 1)))
2348 (i 0)
2349 (j 0))
2350 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2351 (make-list (- (* columns rows) nfiles) "")))
2352 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2353 (while (< j rows)
2354 (while (< i columns)
2355 (indent-to (* i maxlen))
2356 (insert (car files))
2357 (setq files (nthcdr rows files)
2358 i (1+ i)))
2359 (insert "\n")
2360 (setq i 0
2361 j (1+ j)
2362 files (cdr files)))
2363 rows))
83fadedf 2364\f
492d2437
RS
2365;; Commands to mark or flag file(s) at or near current line.
2366
2367(defun dired-repeat-over-lines (arg function)
2368 ;; This version skips non-file lines.
cfe89c4f 2369 (let ((pos (make-marker)))
492d2437 2370 (beginning-of-line)
cfe89c4f
RS
2371 (while (and (> arg 0) (not (eobp)))
2372 (setq arg (1- arg))
2373 (beginning-of-line)
2374 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2375 (save-excursion
2376 (forward-line 1)
2377 (move-marker pos (1+ (point))))
2378 (save-excursion (funcall function))
2379 ;; Advance to the next line--actually, to the line that *was* next.
2380 ;; (If FUNCTION inserted some new lines in between, skip them.)
2381 (goto-char pos))
2382 (while (and (< arg 0) (not (bobp)))
2383 (setq arg (1+ arg))
2384 (forward-line -1)
2385 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2386 (beginning-of-line)
2387 (save-excursion (funcall function)))
2388 (move-marker pos nil)
2389 (dired-move-to-filename)))
492d2437
RS
2390
2391(defun dired-between-files ()
8a372755
MB
2392 ;; This used to be a regexp match of the `total ...' line output by
2393 ;; ls, which is slightly faster, but that is not very robust; notably,
2394 ;; it fails for non-english locales.
2395 (save-excursion (not (dired-move-to-filename))))
492d2437
RS
2396
2397(defun dired-next-marked-file (arg &optional wrap opoint)
2398 "Move to the next marked file, wrapping around the end of the buffer."
2399 (interactive "p\np")
2400 (or opoint (setq opoint (point)));; return to where interactively started
2401 (if (if (> arg 0)
2402 (re-search-forward dired-re-mark nil t arg)
2403 (beginning-of-line)
2404 (re-search-backward dired-re-mark nil t (- arg)))
2405 (dired-move-to-filename)
2406 (if (null wrap)
2407 (progn
2408 (goto-char opoint)
2409 (error "No next marked file"))
2410 (message "(Wraparound for next marked file)")
2411 (goto-char (if (> arg 0) (point-min) (point-max)))
2412 (dired-next-marked-file arg nil opoint))))
2413
2414(defun dired-prev-marked-file (arg &optional wrap)
2415 "Move to the previous marked file, wrapping around the end of the buffer."
2416 (interactive "p\np")
2417 (dired-next-marked-file (- arg) wrap))
2418
2419(defun dired-file-marker (file)
2420 ;; Return FILE's marker, or nil if unmarked.
2421 (save-excursion
2422 (and (dired-goto-file file)
2423 (progn
2424 (beginning-of-line)
2425 (if (not (equal ?\040 (following-char)))
2426 (following-char))))))
2427
2428(defun dired-mark-files-in-region (start end)
2429 (let (buffer-read-only)
2430 (if (> start end)
2431 (error "start > end"))
2432 (goto-char start) ; assumed at beginning of line
2433 (while (< (point) end)
2434 ;; Skip subdir line and following garbage like the `total' line:
2435 (while (and (< (point) end) (dired-between-files))
2436 (forward-line 1))
2437 (if (and (not (looking-at dired-re-dot))
2438 (dired-get-filename nil t))
2439 (progn
2440 (delete-char 1)
2441 (insert dired-marker-char)))
2442 (forward-line 1))))
2443
2444(defun dired-mark (arg)
2445 "Mark the current (or next ARG) files.
2446If on a subdir headerline, mark all its files except `.' and `..'.
2447
2448Use \\[dired-unmark-all-files] to remove all marks
2449and \\[dired-unmark] on a subdir to remove the marks in
2450this subdir."
2451 (interactive "P")
277568f2 2452 (if (dired-get-subdir)
492d2437
RS
2453 (save-excursion (dired-mark-subdir-files))
2454 (let (buffer-read-only)
2455 (dired-repeat-over-lines
52041219 2456 (prefix-numeric-value arg)
492d2437
RS
2457 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2458
2459(defun dired-unmark (arg)
2460 "Unmark the current (or next ARG) files.
2461If looking at a subdir, unmark all its files except `.' and `..'."
2462 (interactive "P")
2463 (let ((dired-marker-char ?\040))
2464 (dired-mark arg)))
2465
2466(defun dired-flag-file-deletion (arg)
68d2f12f 2467 "In Dired, flag the current line's file for deletion.
492d2437
RS
2468With prefix arg, repeat over several lines.
2469
2470If on a subdir headerline, mark all its files except `.' and `..'."
2471 (interactive "P")
2472 (let ((dired-marker-char dired-del-marker))
2473 (dired-mark arg)))
2474
2475(defun dired-unmark-backward (arg)
68d2f12f 2476 "In Dired, move up lines and remove deletion flag there.
492d2437
RS
2477Optional prefix ARG says how many lines to unflag; default is one line."
2478 (interactive "p")
2479 (dired-unmark (- arg)))
e5f0841e 2480
d588eb90
RS
2481(defun dired-toggle-marks ()
2482 "Toggle marks: marked files become unmarked, and vice versa.
e5f0841e
KH
2483Files marked with other flags (such as `D') are not affected.
2484`.' and `..' are never toggled.
2485As always, hidden subdirs are not affected."
2486 (interactive)
2487 (save-excursion
2488 (goto-char (point-min))
2489 (let (buffer-read-only)
2490 (while (not (eobp))
2491 (or (dired-between-files)
2492 (looking-at dired-re-dot)
2493 ;; use subst instead of insdel because it does not move
2494 ;; the gap and thus should be faster and because
2495 ;; other characters are left alone automatically
2496 (apply 'subst-char-in-region
2497 (point) (1+ (point))
2498 (if (eq ?\040 (following-char)) ; SPC
2499 (list ?\040 dired-marker-char)
2500 (list dired-marker-char ?\040))))
2501 (forward-line 1)))))
83fadedf 2502\f
492d2437
RS
2503;;; Commands to mark or flag files based on their characteristics or names.
2504
d2cadc4b
RS
2505(defvar dired-regexp-history nil
2506 "History list of regular expressions used in Dired commands.")
2507
2508(defun dired-read-regexp (prompt)
2509 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
492d2437
RS
2510
2511(defun dired-mark-files-regexp (regexp &optional marker-char)
2512 "Mark all files matching REGEXP for use in later commands.
2513A prefix argument means to unmark them instead.
2514`.' and `..' are never marked.
2515
2516REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2517object files--just `.o' will mark more than you might think."
2518 (interactive
2519 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2520 " files (regexp): "))
2521 (if current-prefix-arg ?\040)))
2522 (let ((dired-marker-char (or marker-char dired-marker-char)))
2523 (dired-mark-if
2524 (and (not (looking-at dired-re-dot))
2525 (not (eolp)) ; empty line
2526 (let ((fn (dired-get-filename nil t)))
2527 (and fn (string-match regexp (file-name-nondirectory fn)))))
2528 "matching file")))
2529
e9b8e22d
RS
2530(defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2531 "Mark all files with contents containing REGEXP for use in later commands.
2532A prefix argument means to unmark them instead.
2533`.' and `..' are never marked."
2534 (interactive
2535 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2536 " files containing (regexp): "))
2537 (if current-prefix-arg ?\040)))
2538 (let ((dired-marker-char (or marker-char dired-marker-char)))
2539 (dired-mark-if
2540 (and (not (looking-at dired-re-dot))
2541 (not (eolp)) ; empty line
2542 (let ((fn (dired-get-filename nil t)))
05a40373
KH
2543 (when (and fn (file-readable-p fn)
2544 (not (file-directory-p fn)))
2545 (let ((prebuf (get-file-buffer fn)))
2546 (message "Checking %s" fn)
2547 ;; For now we do it inside emacs
2548 ;; Grep might be better if there are a lot of files
2549 (if prebuf
2550 (with-current-buffer prebuf
2551 (save-excursion
2552 (goto-char (point-min))
2553 (re-search-forward regexp nil t)))
2554 (with-temp-buffer
2555 (insert-file-contents fn)
2556 (goto-char (point-min))
2557 (re-search-forward regexp nil t))))
0b2bb4d0 2558 )))
e9b8e22d
RS
2559 "matching file")))
2560
492d2437 2561(defun dired-flag-files-regexp (regexp)
68d2f12f 2562 "In Dired, flag all files containing the specified REGEXP for deletion.
492d2437
RS
2563The match is against the non-directory part of the filename. Use `^'
2564 and `$' to anchor matches. Exclude subdirs by hiding them.
2565`.' and `..' are never flagged."
2566 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2567 (dired-mark-files-regexp regexp dired-del-marker))
2568
2569(defun dired-mark-symlinks (unflag-p)
2570 "Mark all symbolic links.
2571With prefix argument, unflag all those files."
2572 (interactive "P")
2573 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2574 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2575
2576(defun dired-mark-directories (unflag-p)
2577 "Mark all directory file lines except `.' and `..'.
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 (and (looking-at dired-re-dir)
2582 (not (looking-at dired-re-dot)))
2583 "directory file")))
2584
2585(defun dired-mark-executables (unflag-p)
2586 "Mark all executable files.
2587With prefix argument, unflag all those files."
2588 (interactive "P")
2589 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2590 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2591
2592;; dired-x.el has a dired-mark-sexp interactive command: mark
2593;; files for which PREDICATE returns non-nil.
2594
2595(defun dired-flag-auto-save-files (&optional unflag-p)
84fc2cfa
ER
2596 "Flag for deletion files whose names suggest they are auto save files.
2597A prefix argument says to unflag those files instead."
2598 (interactive "P")
492d2437
RS
2599 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2600 (dired-mark-if
2a838614 2601 ;; It is less than general to check for # here,
a91526b9
RS
2602 ;; but it's the only way this runs fast enough.
2603 (and (save-excursion (end-of-line)
536ae2dd
RS
2604 (or
2605 (eq (preceding-char) ?#)
2606 ;; Handle executables in case of -F option.
2607 ;; We need not worry about the other kinds
2608 ;; of markings that -F makes, since they won't
2609 ;; appear on real auto-save files.
2610 (if (eq (preceding-char) ?*)
2611 (progn
2612 (forward-char -1)
2613 (eq (preceding-char) ?#)))))
a91526b9
RS
2614 (not (looking-at dired-re-dir))
2615 (let ((fn (dired-get-filename t t)))
2616 (if fn (auto-save-file-name-p
2617 (file-name-nondirectory fn)))))
2618 "auto save file")))
492d2437 2619
84d3f6e8 2620(defvar dired-garbage-files-regexp
d4aeef3b
KG
2621 (concat (regexp-opt
2622 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
c60ee5e7 2623 "\\'")
84d3f6e8
RS
2624 "*Regular expression to match \"garbage\" files for `dired-flag-garbage-files'.")
2625
2626(defun dired-flag-garbage-files ()
84d3f6e8 2627 "Flag for deletion all files that match `dired-garbage-files-regexp'."
f656ec48 2628 (interactive)
84d3f6e8
RS
2629 (dired-flag-files-regexp dired-garbage-files-regexp))
2630
492d2437
RS
2631(defun dired-flag-backup-files (&optional unflag-p)
2632 "Flag all backup files (names ending with `~') for deletion.
2633With prefix argument, unflag these files."
2634 (interactive "P")
fdee13ec 2635 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
492d2437 2636 (dired-mark-if
f13101e9
KH
2637 ;; Don't call backup-file-name-p unless the last character looks like
2638 ;; it might be the end of a backup file name. This isn't very general,
a91526b9
RS
2639 ;; but it's the only way this runs fast enough.
2640 (and (save-excursion (end-of-line)
f13101e9
KH
2641 ;; Handle executables in case of -F option.
2642 ;; We need not worry about the other kinds
2643 ;; of markings that -F makes, since they won't
2644 ;; appear on real backup files.
2645 (if (eq (preceding-char) ?*)
2646 (forward-char -1))
fdee13ec 2647 (eq (preceding-char) ?~))
a91526b9 2648 (not (looking-at dired-re-dir))
492d2437
RS
2649 (let ((fn (dired-get-filename t t)))
2650 (if fn (backup-file-name-p fn))))
2651 "backup file")))
2652
6482fcac
RS
2653(defun dired-change-marks (&optional old new)
2654 "Change all OLD marks to NEW marks.
2655OLD and NEW are both characters used to mark files."
2656 (interactive
2657 (let* ((cursor-in-echo-area t)
2658 (old (progn (message "Change (old mark): ") (read-char)))
2659 (new (progn (message "Change %c marks to (new mark): " old)
2660 (read-char))))
2661 (list old new)))
e4e02841
RS
2662 (if (or (eq old ?\r) (eq new ?\r))
2663 (ding)
2664 (let ((string (format "\n%c" old))
2665 (buffer-read-only))
2666 (save-excursion
2667 (goto-char (point-min))
2668 (while (search-forward string nil t)
a15a76f7
RS
2669 (if (if (= old ?\ )
2670 (save-match-data
2671 (dired-get-filename 'no-dir t))
2672 t)
2673 (subst-char-in-region (match-beginning 0)
2674 (match-end 0) old new)))))))
6482fcac 2675
534a6edf 2676(defun dired-unmark-all-marks ()
b1ecd9c6
RS
2677 "Remove all marks from all files in the Dired buffer."
2678 (interactive)
2679 (dired-unmark-all-files ?\r))
2680
8b87a301 2681(defun dired-unmark-all-files (mark &optional arg)
b602ba2f 2682 "Remove a specific mark (or any mark) from every file.
c60ee5e7 2683After this command, type the mark character to remove,
b602ba2f 2684or type RET to remove all marks.
3585916f 2685With prefix arg, query for each marked file.
492d2437 2686Type \\[help-command] at that time for help."
b602ba2f
RS
2687 (interactive "cRemove marks (RET means all): \nP")
2688 (save-excursion
2689 (let* ((count 0)
2690 buffer-read-only case-fold-search query
2691 (string (format "\n%c" mark))
2692 (help-form "\
8b87a301
RS
2693Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2694`!' to unmark all remaining files with no more questions."))
b602ba2f
RS
2695 (goto-char (point-min))
2696 (while (if (eq mark ?\r)
2697 (re-search-forward dired-re-mark nil t)
2698 (search-forward string nil t))
2699 (if (or (not arg)
e9407052
RS
2700 (let ((file (dired-get-filename t t)))
2701 (and file
2702 (dired-query 'query "Unmark file `%s'? "
2703 file))))
b602ba2f
RS
2704 (progn (subst-char-in-region (1- (point)) (point)
2705 (preceding-char) ?\ )
2706 (setq count (1+ count)))))
2707 (message (if (= count 1) "1 mark removed"
2708 "%d marks removed")
2709 count))))
83fadedf 2710\f
492d2437 2711;; Logging failures operating on files, and showing the results.
84fc2cfa 2712
492d2437 2713(defvar dired-log-buffer "*Dired log*")
84fc2cfa 2714
492d2437
RS
2715(defun dired-why ()
2716 "Pop up a buffer with error log output from Dired.
2717A group of errors from a single command ends with a formfeed.
2718Thus, use \\[backward-page] to find the beginning of a group of errors."
2719 (interactive)
2720 (if (get-buffer dired-log-buffer)
2721 (let ((owindow (selected-window))
2722 (window (display-buffer (get-buffer dired-log-buffer))))
2723 (unwind-protect
6482fcac 2724 (progn
492d2437
RS
2725 (select-window window)
2726 (goto-char (point-max))
0b7bc76f
RS
2727 (forward-line -1)
2728 (backward-page 1)
2729 (recenter 0))
492d2437
RS
2730 (select-window owindow)))))
2731
2732(defun dired-log (log &rest args)
2733 ;; Log a message or the contents of a buffer.
2734 ;; If LOG is a string and there are more args, it is formatted with
2735 ;; those ARGS. Usually the LOG string ends with a \n.
c60ee5e7 2736 ;; End each bunch of errors with (dired-log t):
0b7bc76f
RS
2737 ;; this inserts the current time and buffer at the start of the page,
2738 ;; and \f (formfeed) at the end.
492d2437 2739 (let ((obuf (current-buffer)))
0b7bc76f
RS
2740 (with-current-buffer (get-buffer-create dired-log-buffer)
2741 (goto-char (point-max))
2742 (let ((inhibit-read-only t))
2743 (cond ((stringp log)
2744 (insert (if args
2745 (apply (function format) log args)
2746 log)))
2747 ((bufferp log)
2748 (insert-buffer log))
2749 ((eq t log)
2750 (backward-page 1)
2751 (unless (bolp)
2752 (insert "\n"))
2753 (insert (current-time-string)
2754 "\tBuffer `" (buffer-name obuf) "'\n")
2755 (goto-char (point-max))
2756 (insert "\f\n")))))))
492d2437
RS
2757
2758(defun dired-log-summary (string failures)
0b7bc76f
RS
2759 (if (= (length failures) 1)
2760 (message "%s"
2761 (with-current-buffer dired-log-buffer
2762 (goto-char (point-max))
2763 (backward-page 1)
2764 (if (eolp) (forward-line 1))
2765 (buffer-substring (point) (point-max))))
2766 (message (if failures "%s--type ? for details (%s)"
2767 "%s--type ? for details")
2768 string failures))
492d2437 2769 ;; Log a summary describing a bunch of errors.
0b7bc76f 2770 (dired-log (concat "\n" string "\n"))
492d2437 2771 (dired-log t))
83fadedf 2772\f
492d2437
RS
2773;;; Sorting
2774
2775;; Most ls can only sort by name or by date (with -t), nothing else.
2776;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2777;; So anything that does not contain these is sort "by name".
2778
2779(defvar dired-ls-sorting-switches "SXU"
cfc8b264
EZ
2780 "String of `ls' switches \(single letters\) except `t' that influence sorting.
2781
2782This indicates to Dired which option switches to watch out for because they
2783will change the sorting order behavior of `ls'.
2784
2785To change the default sorting order \(e.g. add a `-v' option\), see the
2786variable `dired-listing-switches'. To temporarily override the listing
2787format, use `\\[universal-argument] \\[dired]'.")
492d2437
RS
2788
2789(defvar dired-sort-by-date-regexp
2790 (concat "^-[^" dired-ls-sorting-switches
2791 "]*t[^" dired-ls-sorting-switches "]*$")
2792 "Regexp recognized by dired to set `by date' mode.")
2793
2794(defvar dired-sort-by-name-regexp
2795 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2796 "Regexp recognized by dired to set `by name' mode.")
2797
23fc67ea
RS
2798(defvar dired-sort-inhibit nil
2799 "Non-nil means the Dired sort command is disabled.
2800The idea is to set this buffer-locally in special Dired buffers.")
2801
492d2437
RS
2802(defun dired-sort-set-modeline ()
2803 ;; Set modeline display according to dired-actual-switches.
2804 ;; Modeline display of "by name" or "by date" guarantees the user a
2805 ;; match with the corresponding regexps. Non-matching switches are
2806 ;; shown literally.
1d673d85 2807 (setq mode-name
492d2437
RS
2808 (let (case-fold-search)
2809 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
1d673d85 2810 "Dired by name")
492d2437 2811 ((string-match dired-sort-by-date-regexp dired-actual-switches)
1d673d85 2812 "Dired by date")
492d2437 2813 (t
1d673d85 2814 (concat "Dired " dired-actual-switches)))))
45d8d39f 2815 (force-mode-line-update))
492d2437
RS
2816
2817(defun dired-sort-toggle-or-edit (&optional arg)
2818 "Toggle between sort by date/name and refresh the dired buffer.
2819With a prefix argument you can edit the current listing switches instead."
84fc2cfa 2820 (interactive "P")
23fc67ea
RS
2821 (when dired-sort-inhibit
2822 (error "Cannot sort this Dired buffer"))
492d2437
RS
2823 (if arg
2824 (dired-sort-other
2825 (read-string "ls switches (must contain -l): " dired-actual-switches))
2826 (dired-sort-toggle)))
2827
2828(defun dired-sort-toggle ()
2829 ;; Toggle between sort by date/name. Reverts the buffer.
2830 (setq dired-actual-switches
2831 (let (case-fold-search)
7820b28f
RS
2832 (if (string-match " " dired-actual-switches)
2833 ;; New toggle scheme: add/remove a trailing " -t"
2834 (if (string-match " -t\\'" dired-actual-switches)
2b2059d8 2835 (substring dired-actual-switches 0 (match-beginning 0))
7820b28f
RS
2836 (concat dired-actual-switches " -t"))
2837 ;; old toggle scheme: look for some 't' switch and add/remove it
2838 (concat
2839 "-l"
83fadedf
DL
2840 (dired-replace-in-string (concat "[-lt"
2841 dired-ls-sorting-switches "]")
2842 ""
2843 dired-actual-switches)
7820b28f
RS
2844 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2845 dired-actual-switches)
2846 ""
2847 "t")))))
492d2437
RS
2848 (dired-sort-set-modeline)
2849 (revert-buffer))
2850
83fadedf 2851;; Some user code loads dired especially for this.
879fa8d0 2852;; Don't do that--use replace-regexp-in-string instead.
83fadedf
DL
2853(defun dired-replace-in-string (regexp newtext string)
2854 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2855 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2856 (let ((result "") (start 0) mb me)
2857 (while (string-match regexp string start)
2858 (setq mb (match-beginning 0)
2859 me (match-end 0)
2860 result (concat result (substring string start mb) newtext)
2861 start me))
2862 (concat result (substring string start))))
2863
492d2437
RS
2864(defun dired-sort-other (switches &optional no-revert)
2865 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2866 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2867 ;; minor mode accordingly, others appear literally in the mode line.
2868 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
e17dba1f 2869 (dired-sort-R-check switches)
492d2437 2870 (setq dired-actual-switches switches)
6cfd24f9 2871 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
492d2437 2872 (or no-revert (revert-buffer)))
e17dba1f
GM
2873
2874(make-variable-buffer-local
2875 (defvar dired-subdir-alist-pre-R nil
2876 "Value of `dired-subdir-alist' before -R switch added."))
2877
2878(defun dired-sort-R-check (switches)
2879 "Additional processing of -R in ls option string SWITCHES.
2880Saves `dired-subdir-alist' when R is set and restores saved value
2881minus any directories explicitly deleted when R is cleared.
2882To be called first in body of `dired-sort-other', etc."
2883 (cond
2884 ((and (string-match "R" switches)
2885 (not (string-match "R" dired-actual-switches)))
2886 ;; Adding -R to ls switches -- save `dired-subdir-alist':
2887 (setq dired-subdir-alist-pre-R dired-subdir-alist))
2888 ((and (string-match "R" dired-actual-switches)
2889 (not (string-match "R" switches)))
2890 ;; Deleting -R from ls switches -- revert to pre-R subdirs
2891 ;; that are still present:
2892 (setq dired-subdir-alist
2893 (if dired-subdir-alist-pre-R
2894 (let (subdirs)
2895 (while dired-subdir-alist-pre-R
2896 (if (assoc (caar dired-subdir-alist-pre-R)
2897 dired-subdir-alist)
2898 ;; subdir still present...
2899 (setq subdirs
2900 (cons (car dired-subdir-alist-pre-R)
2901 subdirs)))
2902 (setq dired-subdir-alist-pre-R
2903 (cdr dired-subdir-alist-pre-R)))
2904 (reverse subdirs))
2905 ;; No pre-R subdir alist, so revert to main directory
2906 ;; listing:
2907 (list (car (reverse dired-subdir-alist))))))))
83fadedf 2908\f
492d2437
RS
2909;; To make this file smaller, the less common commands
2910;; go in a separate file. But autoload them here
2911;; to make the separation invisible.
2912
2913(autoload 'dired-diff "dired-aux"
2914 "Compare file at point with file FILE using `diff'.
a1af8dcf
EZ
2915FILE defaults to the file at the mark. (That's the mark set by
2916\\[set-mark-command], not by Dired's \\[dired-mark] command.)
ab67260b 2917The prompted-for file is the first file given to `diff'."
492d2437
RS
2918 t)
2919
2920(autoload 'dired-backup-diff "dired-aux"
2921 "Diff this file with its backup file or vice versa.
2922Uses the latest backup, if there are several numerical backups.
2923If this file is a backup, diff it with its original.
ab67260b 2924The backup file is the first file given to `diff'."
492d2437
RS
2925 t)
2926
2d051399
RS
2927(autoload 'dired-clean-directory "dired-aux"
2928 "Flag numerical backups for deletion.
2929Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2930Positive prefix arg KEEP overrides `dired-kept-versions';
2931Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2932
2933To clear the flags on these files, you can use \\[dired-flag-backup-files]
2934with a prefix argument."
2935 t)
2936
492d2437
RS
2937(autoload 'dired-do-chmod "dired-aux"
2938 "Change the mode of the marked (or next ARG) files.
2939This calls chmod, thus symbolic modes like `g+w' are allowed."
2940 t)
2941
2942(autoload 'dired-do-chgrp "dired-aux"
2943 "Change the group of the marked (or next ARG) files."
2944 t)
2945
2946(autoload 'dired-do-chown "dired-aux"
2947 "Change the owner of the marked (or next ARG) files."
2948 t)
2949
2950(autoload 'dired-do-print "dired-aux"
2951 "Print the marked (or next ARG) files.
2952Uses the shell command coming from variables `lpr-command' and
2953`lpr-switches' as default."
2954 t)
2955
2956(autoload 'dired-do-shell-command "dired-aux"
6482fcac
RS
2957 "Run a shell command COMMAND on the marked files.
2958If no files are marked or a specific numeric prefix arg is given,
2959the next ARG files are used. Just \\[universal-argument] means the current file.
2960The prompt mentions the file(s) or the marker, as appropriate.
2961
8462b390
RS
2962If there is a `*' in COMMAND, surrounded by whitespace, this runs
2963COMMAND just once with the entire file list substituted there.
6482fcac 2964
8462b390
RS
2965If there is no `*', but there is a `?' in COMMAND, surrounded by
2966whitespace, this runs COMMAND on each file individually with the
2967file name substituted for `?'.
492d2437 2968
8462b390
RS
2969Otherwise, this runs COMMAND on each file individually with the
2970file name added at the end of COMMAND (separated by a space).
492d2437 2971
8462b390
RS
2972`*' and `?' when not surrounded by whitespace have no special
2973significance for `dired-do-shell-command', and are passed through
2974normally to the shell, but you must confirm first. To pass `*' by
2975itself to the shell as a wildcard, type `*\"\"'.
2976
2977If COMMAND produces output, it goes to a separate buffer.
2978
2979This feature does not try to redisplay Dired buffers afterward, as
2980there's no telling what files COMMAND may have changed.
2981Type \\[dired-do-redisplay] to redisplay the marked files.
2982
2983When COMMAND runs, its working directory is the top-level directory of
2984the Dired buffer, so output files usually are created there instead of
2985in a subdir.
2986
2987In a noninteractive call (from Lisp code), you must specify
2988the list of file names explicitly with the FILE-LIST argument."
492d2437
RS
2989 t)
2990
492d2437
RS
2991(autoload 'dired-do-kill-lines "dired-aux"
2992 "Kill all marked lines (not the files).
2993With a prefix arg, kill all lines not marked or flagged."
2994 t)
2995
2996(autoload 'dired-do-compress "dired-aux"
2997 "Compress or uncompress marked (or next ARG) files."
2998 t)
2999
3000(autoload 'dired-do-byte-compile "dired-aux"
3001 "Byte compile marked (or next ARG) Emacs Lisp files."
3002 t)
3003
3004(autoload 'dired-do-load "dired-aux"
3005 "Load the marked (or next ARG) Emacs Lisp files."
3006 t)
3007
3008(autoload 'dired-do-redisplay "dired-aux"
3009 "Redisplay all marked (or next ARG) files.
3010If on a subdir line, redisplay that subdirectory. In that case,
3011a prefix arg lets you edit the `ls' switches used for the new listing."
3012 t)
3013
492d2437 3014(autoload 'dired-create-directory "dired-aux"
84fc2cfa 3015 "Create a directory called DIRECTORY."
492d2437 3016 t)
84fc2cfa 3017
492d2437
RS
3018(autoload 'dired-do-copy "dired-aux"
3019 "Copy all marked (or next ARG) files, or copy the current file.
3020Thus, a zero prefix argument copies nothing. But it toggles the
3021variable `dired-copy-preserve-time' (which see)."
3022 t)
3023
3024(autoload 'dired-do-symlink "dired-aux"
3025 "Make symbolic links to current file or all marked (or next ARG) files.
3026When operating on just the current file, you specify the new name.
3027When operating on multiple or marked files, you specify a directory
3028and new symbolic links are made in that directory
3029with the same names that the files currently have."
3030 t)
3031
3032(autoload 'dired-do-hardlink "dired-aux"
3033 "Add names (hard links) current file or all marked (or next ARG) files.
3034When operating on just the current file, you specify the new name.
3035When operating on multiple or marked files, you specify a directory
3036and new hard links are made in that directory
3037with the same names that the files currently have."
3038 t)
3039
3040(autoload 'dired-do-rename "dired-aux"
3041 "Rename current file or all marked (or next ARG) files.
3042When renaming just the current file, you specify the new name.
3043When renaming multiple or marked files, you specify a directory."
3044 t)
3045
3046(autoload 'dired-do-rename-regexp "dired-aux"
3047 "Rename marked files containing REGEXP to NEWNAME.
3048As each match is found, the user must type a character saying
3049 what to do with it. For directions, type \\[help-command] at that time.
3050NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
3051REGEXP defaults to the last regexp used.
470fa6d1
KS
3052With a zero prefix arg, renaming by regexp affects the full file name;
3053usually only the non-directory part of file names is used and changed."
492d2437
RS
3054 t)
3055
3056(autoload 'dired-do-copy-regexp "dired-aux"
3057 "Copy all marked files containing REGEXP to NEWNAME.
99c364e4 3058See function `dired-do-rename-regexp' for more info."
492d2437
RS
3059 t)
3060
3061(autoload 'dired-do-hardlink-regexp "dired-aux"
3062 "Hardlink all marked files containing REGEXP to NEWNAME.
99c364e4 3063See function `dired-do-rename-regexp' for more info."
492d2437
RS
3064 t)
3065
3066(autoload 'dired-do-symlink-regexp "dired-aux"
3067 "Symlink all marked files containing REGEXP to NEWNAME.
99c364e4 3068See function `dired-do-rename-regexp' for more info."
492d2437
RS
3069 t)
3070
3071(autoload 'dired-upcase "dired-aux"
3072 "Rename all marked (or next ARG) files to upper case."
3073 t)
3074
3075(autoload 'dired-downcase "dired-aux"
3076 "Rename all marked (or next ARG) files to lower case."
3077 t)
3078
3079(autoload 'dired-maybe-insert-subdir "dired-aux"
3080 "Insert this subdirectory into the same dired buffer.
3081If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
3082 else inserts it at its natural place (as `ls -lR' would have done).
3083With a prefix arg, you may edit the ls switches used for this listing.
3084 You can add `R' to the switches to expand the whole tree starting at
3085 this subdirectory.
3086This function takes some pains to conform to `ls -lR' output."
3087 t)
3088
3089(autoload 'dired-next-subdir "dired-aux"
3090 "Go to next subdirectory, regardless of level."
3091 t)
3092
3093(autoload 'dired-prev-subdir "dired-aux"
3094 "Go to previous subdirectory, regardless of level.
3095When called interactively and not on a subdir line, go to this subdir's line."
3096 t)
3097
3098(autoload 'dired-goto-subdir "dired-aux"
3099 "Go to end of header line of DIR in this dired buffer.
3100Return value of point on success, otherwise return nil.
3101The next char is either \\n, or \\r if DIR is hidden."
3102 t)
3103
3104(autoload 'dired-mark-subdir-files "dired-aux"
3105 "Mark all files except `.' and `..'."
3106 t)
3107
3108(autoload 'dired-kill-subdir "dired-aux"
3109 "Remove all lines of current subdirectory.
3110Lower levels are unaffected."
3111 t)
3112
3113(autoload 'dired-tree-up "dired-aux"
3114 "Go up ARG levels in the dired tree."
3115 t)
3116
3117(autoload 'dired-tree-down "dired-aux"
3118 "Go down in the dired tree."
3119 t)
3120
3121(autoload 'dired-hide-subdir "dired-aux"
3122 "Hide or unhide the current subdirectory and move to next directory.
3123Optional prefix arg is a repeat factor.
3124Use \\[dired-hide-all] to (un)hide all directories."
3125 t)
3126
3127(autoload 'dired-hide-all "dired-aux"
3128 "Hide all subdirectories, leaving only their header lines.
3129If there is already something hidden, make everything visible again.
3130Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
3131 t)
f01fd03b
MB
3132
3133(autoload 'dired-show-file-type "dired-aux"
3134 "Print the type of FILE, according to the `file' command.
3135If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
c60ee5e7 3136true then the type of the file linked to by FILE is printed instead."
f01fd03b 3137 t)
b70ebe37
RS
3138
3139(autoload 'dired-run-shell-command "dired-aux")
2aaa7f0a
RS
3140
3141(autoload 'dired-query "dired-aux")
83fadedf 3142\f
133aad74
JD
3143
3144;;;; Drag and drop support
3145
3146(defun dired-dnd-test-function (window action types)
3147 "The test function for drag and drop into dired buffers.
3148WINDOW is where the mouse is when this function is called. It may be a frame
3149if the mouse is over the menu bar, scroll bar or tool bar.
3150ACTION is the suggested action from the source, and TYPES are the
3151types the drop data can have. This function only accepts drops with
3152types in `x-dnd-known-types'. It returns the action suggested by the source."
3153 (let ((type (x-dnd-choose-type types)))
3154 (if type
3155 (cons action type)
3156 nil)))
3157
3158(defun dired-dnd-popup-notice ()
3159 (x-popup-dialog
3160 t
3161 '("Recursive copies not enabled.\nSee variable dired-recursive-copies."
3162 ("Ok" . nil))))
3163
3164
3165(defun dired-dnd-do-ask-action (uri)
3166 ;; No need to get actions and descriptions from the source,
3167 ;; we only have three actions anyway.
3168 (let ((action (x-popup-menu
3169 t
3170 (list "What action?"
3171 (cons ""
3172 '(("Copy here" . copy)
3173 ("Move here" . move)
3174 ("Link here" . link)
3175 "--"
3176 ("Cancel" . nil)))))))
3177 (if action
3178 (dired-dnd-handle-local-file uri action)
3179 nil)))
3180
3181(defun dired-dnd-handle-local-file (uri action)
3182 "Copy, move or link a file to the dired directory.
3183URI is the file to handle, ACTION is one of copy, move, link or ask.
3184Ask means pop up a menu for the user to select one of copy, move or link."
3185 (require 'dired-aux)
3186 (let* ((from (x-dnd-get-local-file-name uri t))
3187 (to (if from (concat (dired-current-directory)
3188 (file-name-nondirectory from))
3189 nil)))
3190 (if from
3191 (cond ((or (eq action 'copy)
3192 (eq action 'private)) ; Treat private as copy.
3193
3194 ;; If copying a directory and dired-recursive-copies is nil,
3195 ;; dired-copy-file silently fails. Pop up a notice.
3196 (if (and (file-directory-p from)
3197 (not dired-recursive-copies))
3198 (dired-dnd-popup-notice)
3199 (progn
3200 (dired-copy-file from to 1)
3201 (dired-relist-entry to)
3202 action)))
3203
3204 ((eq action 'move)
3205 (dired-rename-file from to 1)
3206 (dired-relist-entry to)
3207 action)
3208
3209 ((eq action 'link)
3210 (make-symbolic-link from to 1)
3211 (dired-relist-entry to)
3212 action)
3213
3214 ((eq action 'ask)
3215 (dired-dnd-do-ask-action uri))
3216
3217 (t nil)))))
3218
3219(defun dired-dnd-handle-file (uri action)
3220 "Copy, move or link a file to the dired directory if it is a local file.
3221URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3222ACTION is one of copy, move, link or ask.
3223Ask means pop up a menu for the user to select one of copy, move or link."
3224 (let ((local-file (x-dnd-get-local-file-uri uri)))
3225 (if local-file (dired-dnd-handle-local-file local-file action)
3226 nil)))
3227
3228
3229\f
492d2437
RS
3230(if (eq system-type 'vax-vms)
3231 (load "dired-vms"))
84fc2cfa 3232
52041219
RS
3233(provide 'dired)
3234
57e15005
BF
3235(run-hooks 'dired-load-hook) ; for your customizations
3236
ab5796a9 3237;;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
52041219 3238;;; dired.el ends here