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