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