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