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