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