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