]> code.delx.au - gnu-emacs/blob - lisp/dired.el
(dired-mode-map): Changed menu items for tumme as per
[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 "h" 'describe-mode)
1216 (define-key map "i" 'dired-maybe-insert-subdir)
1217 (define-key map "j" 'dired-goto-file)
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 tumme]
1316 (cons "Thumbnail Images" (make-sparse-keymap "tumme")))
1317
1318 (define-key map
1319 [menu-bar immediate tumme tumme-display-thumbs]
1320 '(menu-item "Display Thumbnails"
1321 tumme-display-thumbs))
1322 (define-key map
1323 [menu-bar immediate tumme tumme-tag-files]
1324 '(menu-item "Add Image Tag.."
1325 tumme-tag-files))
1326 (define-key map
1327 [menu-bar immediate tumme tumme-tag-remove]
1328 '(menu-item "Remove Image Tag..."
1329 tumme-tag-remove))
1330 (define-key map
1331 [menu-bar immediate tumme tumme-dired-display-image]
1332 '(menu-item "Display Image"
1333 tumme-dired-display-image))
1334 (define-key map
1335 [menu-bar immediate tumme tumme-dired-display-external]
1336 '(menu-item "Display Image Externally"
1337 tumme-dired-display-external))
1338 (define-key map
1339 [menu-bar immediate tumme tumme-dired-comment-files]
1340 '(menu-item "Add Comment"
1341 tumme-dired-comment-files))
1342 (define-key map
1343 [menu-bar immediate tumme tumme-mark-tagged-files]
1344 '(menu-item "Mark From Image Tag..."
1345 tumme-mark-tagged-files))
1346
1347 (define-key map [menu-bar immediate compare-directories]
1348 '(menu-item "Compare directories..." dired-compare-directories
1349 :help "Mark files with different attributes in two dired buffers"))
1350 (define-key map [menu-bar immediate backup-diff]
1351 '(menu-item "Compare with Backup" dired-backup-diff
1352 :help "Diff file at cursor with its latest backup"))
1353 (define-key map [menu-bar immediate diff]
1354 '(menu-item "Diff..." dired-diff
1355 :help "Compare file at cursor with another file"))
1356 (define-key map [menu-bar immediate view]
1357 '(menu-item "View This File" dired-view-file
1358 :help "Examine file at cursor in read-only mode"))
1359 (define-key map [menu-bar immediate display]
1360 '(menu-item "Display in Other Window" dired-display-file
1361 :help "Display file at cursor in other window"))
1362 (define-key map [menu-bar immediate find-file-other-window]
1363 '(menu-item "Find in Other Window" dired-find-file-other-window
1364 :help "Edit file at cursor in other window"))
1365 (define-key map [menu-bar immediate find-file]
1366 '(menu-item "Find This File" dired-find-file
1367 :help "Edit file at cursor"))
1368 (define-key map [menu-bar immediate create-directory]
1369 '(menu-item "Create Directory..." dired-create-directory))
1370 (define-key map [menu-bar immediate wdired-mode]
1371 '(menu-item "Edit File Names" wdired-change-to-wdired-mode))
1372
1373 (define-key map [menu-bar regexp]
1374 (cons "Regexp" (make-sparse-keymap "Regexp")))
1375
1376 (define-key map [menu-bar regexp downcase]
1377 '(menu-item "Downcase" dired-downcase
1378 ;; When running on plain MS-DOS, there's only one
1379 ;; letter-case for file names.
1380 :enable (or (not (fboundp 'msdos-long-file-names))
1381 (msdos-long-file-names))
1382 :help "Rename marked files to lower-case name"))
1383 (define-key map [menu-bar regexp upcase]
1384 '(menu-item "Upcase" dired-upcase
1385 :enable (or (not (fboundp 'msdos-long-file-names))
1386 (msdos-long-file-names))
1387 :help "Rename marked files to upper-case name"))
1388 (define-key map [menu-bar regexp hardlink]
1389 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1390 :help "Make hard links for files matching regexp"))
1391 (define-key map [menu-bar regexp symlink]
1392 '(menu-item "Symlink..." dired-do-symlink-regexp
1393 :visible (fboundp 'make-symbolic-link)
1394 :help "Make symbolic links for files matching regexp"))
1395 (define-key map [menu-bar regexp rename]
1396 '(menu-item "Rename..." dired-do-rename-regexp
1397 :help "Rename marked files matching regexp"))
1398 (define-key map [menu-bar regexp copy]
1399 '(menu-item "Copy..." dired-do-copy-regexp
1400 :help "Copy marked files matching regexp"))
1401 (define-key map [menu-bar regexp flag]
1402 '(menu-item "Flag..." dired-flag-files-regexp
1403 :help "Flag files matching regexp for deletion"))
1404 (define-key map [menu-bar regexp mark]
1405 '(menu-item "Mark..." dired-mark-files-regexp
1406 :help "Mark files matching regexp for future operations"))
1407 (define-key map [menu-bar regexp mark-cont]
1408 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1409 :help "Mark files whose contents matches regexp"))
1410
1411 (define-key map [menu-bar mark]
1412 (cons "Mark" (make-sparse-keymap "Mark")))
1413
1414 (define-key map [menu-bar mark prev]
1415 '(menu-item "Previous Marked" dired-prev-marked-file
1416 :help "Move to previous marked file"))
1417 (define-key map [menu-bar mark next]
1418 '(menu-item "Next Marked" dired-next-marked-file
1419 :help "Move to next marked file"))
1420 (define-key map [menu-bar mark marks]
1421 '(menu-item "Change Marks..." dired-change-marks
1422 :help "Replace marker with another character"))
1423 (define-key map [menu-bar mark unmark-all]
1424 '(menu-item "Unmark All" dired-unmark-all-marks))
1425 (define-key map [menu-bar mark symlinks]
1426 '(menu-item "Mark Symlinks" dired-mark-symlinks
1427 :visible (fboundp 'make-symbolic-link)
1428 :help "Mark all symbolic links"))
1429 (define-key map [menu-bar mark directories]
1430 '(menu-item "Mark Directories" dired-mark-directories
1431 :help "Mark all directories except `.' and `..'"))
1432 (define-key map [menu-bar mark directory]
1433 '(menu-item "Mark Old Backups" dired-clean-directory
1434 :help "Flag old numbered backups for deletion"))
1435 (define-key map [menu-bar mark executables]
1436 '(menu-item "Mark Executables" dired-mark-executables
1437 :help "Mark all executable files"))
1438 (define-key map [menu-bar mark garbage-files]
1439 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1440 :help "Flag unneeded files for deletion"))
1441 (define-key map [menu-bar mark backup-files]
1442 '(menu-item "Flag Backup Files" dired-flag-backup-files
1443 :help "Flag all backup files for deletion"))
1444 (define-key map [menu-bar mark auto-save-files]
1445 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1446 :help "Flag auto-save files for deletion"))
1447 (define-key map [menu-bar mark deletion]
1448 '(menu-item "Flag" dired-flag-file-deletion
1449 :help "Flag current line's file for deletion"))
1450 (define-key map [menu-bar mark unmark]
1451 '(menu-item "Unmark" dired-unmark
1452 :help "Unmark or unflag current line's file"))
1453 (define-key map [menu-bar mark mark]
1454 '(menu-item "Mark" dired-mark
1455 :help "Mark current line's file for future operations"))
1456 (define-key map [menu-bar mark toggle-marks]
1457 '(menu-item "Toggle Marks" dired-toggle-marks
1458 :help "Mark unmarked files, unmark marked ones"))
1459
1460 (define-key map [menu-bar operate]
1461 (cons "Operate" (make-sparse-keymap "Operate")))
1462
1463 (define-key map [menu-bar operate query-replace]
1464 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1465 :help "Replace regexp in marked files"))
1466 (define-key map [menu-bar operate search]
1467 '(menu-item "Search Files..." dired-do-search
1468 :help "Search marked files for regexp"))
1469 (define-key map [menu-bar operate chown]
1470 '(menu-item "Change Owner..." dired-do-chown
1471 :visible (not (memq system-type '(ms-dos windows-nt)))
1472 :help "Change the owner of marked files"))
1473 (define-key map [menu-bar operate chgrp]
1474 '(menu-item "Change Group..." dired-do-chgrp
1475 :visible (not (memq system-type '(ms-dos windows-nt)))
1476 :help "Change the group of marked files"))
1477 (define-key map [menu-bar operate chmod]
1478 '(menu-item "Change Mode..." dired-do-chmod
1479 :help "Change mode (attributes) of marked files"))
1480 (define-key map [menu-bar operate touch]
1481 '(menu-item "Change Timestamp..." dired-do-touch
1482 :help "Change timestamp of marked files"))
1483 (define-key map [menu-bar operate load]
1484 '(menu-item "Load" dired-do-load
1485 :help "Load marked Emacs Lisp files"))
1486 (define-key map [menu-bar operate compile]
1487 '(menu-item "Byte-compile" dired-do-byte-compile
1488 :help "Byte-compile marked Emacs Lisp files"))
1489 (define-key map [menu-bar operate compress]
1490 '(menu-item "Compress" dired-do-compress
1491 :help "Compress/uncompress marked files"))
1492 (define-key map [menu-bar operate print]
1493 '(menu-item "Print..." dired-do-print
1494 :help "Ask for print command and print marked files"))
1495 (define-key map [menu-bar operate hardlink]
1496 '(menu-item "Hardlink to..." dired-do-hardlink
1497 :help "Make hard links for current or marked files"))
1498 (define-key map [menu-bar operate symlink]
1499 '(menu-item "Symlink to..." dired-do-symlink
1500 :visible (fboundp 'make-symbolic-link)
1501 :help "Make symbolic links for current or marked files"))
1502 (define-key map [menu-bar operate command]
1503 '(menu-item "Shell Command..." dired-do-shell-command
1504 :help "Run a shell command on each of marked files"))
1505 (define-key map [menu-bar operate delete]
1506 '(menu-item "Delete" dired-do-delete
1507 :help "Delete current file or all marked files"))
1508 (define-key map [menu-bar operate rename]
1509 '(menu-item "Rename to..." dired-do-rename
1510 :help "Rename current file or move marked files"))
1511 (define-key map [menu-bar operate copy]
1512 '(menu-item "Copy to..." dired-do-copy
1513 :help "Copy current file or all marked files"))
1514
1515 map)
1516 "Local keymap for `dired-mode' buffers.")
1517 \f
1518 ;; Dired mode is suitable only for specially formatted data.
1519 (put 'dired-mode 'mode-class 'special)
1520
1521 ;; Autoload cookie needed by desktop.el
1522 ;;;###autoload
1523 (defun dired-mode (&optional dirname switches)
1524 "\
1525 Mode for \"editing\" directory listings.
1526 In Dired, you are \"editing\" a list of the files in a directory and
1527 \(optionally) its subdirectories, in the format of `ls -lR'.
1528 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1529 \"Editing\" means that you can run shell commands on files, visit,
1530 compress, load or byte-compile them, change their file attributes
1531 and insert subdirectories into the same buffer. You can \"mark\"
1532 files for later commands or \"flag\" them for deletion, either file
1533 by file or all files matching certain criteria.
1534 You can move using the usual cursor motion commands.\\<dired-mode-map>
1535 Letters no longer insert themselves. Digits are prefix arguments.
1536 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1537 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1538 Most commands operate on the marked files and use the current file
1539 if no files are marked. Use a numeric prefix argument to operate on
1540 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1541 to operate on the current file only. Prefix arguments override marks.
1542 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1543 to see why something went wrong.
1544 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1545 Type \\[dired-unmark-backward] to back up one line and unflag.
1546 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1547 Type \\[dired-advertised-find-file] to Find the current line's file
1548 (or dired it in another buffer, if it is a directory).
1549 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1550 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1551 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1552 Type \\[dired-do-copy] to Copy files.
1553 Type \\[dired-sort-toggle-or-edit] to toggle Sorting by name/date or change the `ls' switches.
1554 Type \\[revert-buffer] to read all currently expanded directories aGain.
1555 This retains all marks and hides subdirs again that were hidden before.
1556 SPC and DEL can be used to move down and up by lines.
1557
1558 If Dired ever gets confused, you can either type \\[revert-buffer] \
1559 to read the
1560 directories again, type \\[dired-do-redisplay] \
1561 to relist a single or the marked files or a
1562 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1563 again for the directory tree.
1564
1565 Customization variables (rename this buffer and type \\[describe-variable] on each line
1566 for more info):
1567
1568 `dired-listing-switches'
1569 `dired-trivial-filenames'
1570 `dired-shrink-to-fit'
1571 `dired-marker-char'
1572 `dired-del-marker'
1573 `dired-keep-marker-rename'
1574 `dired-keep-marker-copy'
1575 `dired-keep-marker-hardlink'
1576 `dired-keep-marker-symlink'
1577
1578 Hooks (use \\[describe-variable] to see their documentation):
1579
1580 `dired-before-readin-hook'
1581 `dired-after-readin-hook'
1582 `dired-mode-hook'
1583 `dired-load-hook'
1584
1585 Keybindings:
1586 \\{dired-mode-map}"
1587 ;; Not to be called interactively (e.g. dired-directory will be set
1588 ;; to default-directory, which is wrong with wildcards).
1589 (kill-all-local-variables)
1590 (use-local-map dired-mode-map)
1591 (dired-advertise) ; default-directory is already set
1592 (setq major-mode 'dired-mode
1593 mode-name "Dired"
1594 ;; case-fold-search nil
1595 buffer-read-only t
1596 selective-display t ; for subdirectory hiding
1597 mode-line-buffer-identification
1598 (propertized-buffer-identification "%17b"))
1599 (set (make-local-variable 'revert-buffer-function)
1600 (function dired-revert))
1601 (set (make-local-variable 'buffer-stale-function)
1602 (function dired-buffer-stale-p))
1603 (set (make-local-variable 'page-delimiter)
1604 "\n\n")
1605 (set (make-local-variable 'dired-directory)
1606 (or dirname default-directory))
1607 ;; list-buffers uses this to display the dir being edited in this buffer.
1608 (set (make-local-variable 'list-buffers-directory)
1609 (expand-file-name (if (listp dired-directory)
1610 (car dired-directory)
1611 dired-directory)))
1612 (set (make-local-variable 'dired-actual-switches)
1613 (or switches dired-listing-switches))
1614 (set (make-local-variable 'font-lock-defaults)
1615 '(dired-font-lock-keywords t nil nil beginning-of-line))
1616 (set (make-local-variable 'desktop-save-buffer)
1617 'dired-desktop-buffer-misc-data)
1618 (setq dired-switches-alist nil)
1619 (dired-sort-other dired-actual-switches t)
1620 (when (featurep 'dnd)
1621 (set (make-local-variable 'dnd-protocol-alist)
1622 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1623 (run-mode-hooks 'dired-mode-hook))
1624 \f
1625 ;; Idiosyncratic dired commands that don't deal with marks.
1626
1627 (defun dired-summary ()
1628 "Summarize basic Dired commands and show recent dired errors."
1629 (interactive)
1630 (dired-why)
1631 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1632 (message
1633 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1634
1635 (defun dired-undo ()
1636 "Undo in a dired buffer.
1637 This doesn't recover lost files, it just undoes changes in the buffer itself.
1638 You can use it to recover marks, killed lines or subdirs."
1639 (interactive)
1640 (let (buffer-read-only)
1641 (undo))
1642 (dired-build-subdir-alist)
1643 (message "Change in dired buffer undone.
1644 Actual changes in files cannot be undone by Emacs."))
1645
1646 (defun dired-next-line (arg)
1647 "Move down lines then position at filename.
1648 Optional prefix ARG says how many lines to move; default is one line."
1649 (interactive "p")
1650 (next-line arg)
1651 (dired-move-to-filename))
1652
1653 (defun dired-previous-line (arg)
1654 "Move up lines then position at filename.
1655 Optional prefix ARG says how many lines to move; default is one line."
1656 (interactive "p")
1657 (previous-line arg)
1658 (dired-move-to-filename))
1659
1660 (defun dired-next-dirline (arg &optional opoint)
1661 "Goto ARG'th next directory file line."
1662 (interactive "p")
1663 (or opoint (setq opoint (point)))
1664 (if (if (> arg 0)
1665 (re-search-forward dired-re-dir nil t arg)
1666 (beginning-of-line)
1667 (re-search-backward dired-re-dir nil t (- arg)))
1668 (dired-move-to-filename) ; user may type `i' or `f'
1669 (goto-char opoint)
1670 (error "No more subdirectories")))
1671
1672 (defun dired-prev-dirline (arg)
1673 "Goto ARG'th previous directory file line."
1674 (interactive "p")
1675 (dired-next-dirline (- arg)))
1676
1677 (defun dired-up-directory (&optional other-window)
1678 "Run Dired on parent directory of current directory.
1679 Find the parent directory either in this buffer or another buffer.
1680 Creates a buffer if necessary."
1681 (interactive "P")
1682 (let* ((dir (dired-current-directory))
1683 (up (file-name-directory (directory-file-name dir))))
1684 (or (dired-goto-file (directory-file-name dir))
1685 ;; Only try dired-goto-subdir if buffer has more than one dir.
1686 (and (cdr dired-subdir-alist)
1687 (dired-goto-subdir up))
1688 (progn
1689 (if other-window
1690 (dired-other-window up)
1691 (dired up))
1692 (dired-goto-file dir)))))
1693
1694 (defun dired-get-file-for-visit ()
1695 "Get the current line's file name, with an error if file does not exist."
1696 (interactive)
1697 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1698 (let ((raw (dired-get-filename nil t))
1699 file-name)
1700 (if (null raw)
1701 (error "No file on this line"))
1702 (setq file-name (file-name-sans-versions raw t))
1703 (if (file-exists-p file-name)
1704 file-name
1705 (if (file-symlink-p file-name)
1706 (error "File is a symlink to a nonexistent target")
1707 (error "File no longer exists; type `g' to update dired buffer")))))
1708
1709 ;; Force `f' rather than `e' in the mode doc:
1710 (defalias 'dired-advertised-find-file 'dired-find-file)
1711 (defun dired-find-file ()
1712 "In Dired, visit the file or directory named on this line."
1713 (interactive)
1714 ;; Bind `find-file-run-dired' so that the command works on directories
1715 ;; too, independent of the user's setting.
1716 (let ((find-file-run-dired t))
1717 (find-file (dired-get-file-for-visit))))
1718
1719 (defun dired-find-alternate-file ()
1720 "In Dired, visit this file or directory instead of the dired buffer."
1721 (interactive)
1722 (set-buffer-modified-p nil)
1723 (find-alternate-file (dired-get-file-for-visit)))
1724 ;; Don't override the setting from .emacs.
1725 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1726
1727 (defun dired-mouse-find-file-other-window (event)
1728 "In Dired, visit the file or directory name you click on."
1729 (interactive "e")
1730 (let (window pos file)
1731 (save-excursion
1732 (setq window (posn-window (event-end event))
1733 pos (posn-point (event-end event)))
1734 (if (not (windowp window))
1735 (error "No file chosen"))
1736 (set-buffer (window-buffer window))
1737 (goto-char pos)
1738 (setq file (dired-get-file-for-visit)))
1739 (if (file-directory-p file)
1740 (or (and (cdr dired-subdir-alist)
1741 (dired-goto-subdir file))
1742 (progn
1743 (select-window window)
1744 (dired-other-window file)))
1745 (select-window window)
1746 (find-file-other-window (file-name-sans-versions file t)))))
1747
1748 (defun dired-view-file ()
1749 "In Dired, examine a file in view mode, returning to Dired when done.
1750 When file is a directory, show it in this buffer if it is inserted.
1751 Otherwise, display it in another buffer."
1752 (interactive)
1753 (let ((file (dired-get-file-for-visit)))
1754 (if (file-directory-p file)
1755 (or (and (cdr dired-subdir-alist)
1756 (dired-goto-subdir file))
1757 (dired file))
1758 (view-file file))))
1759
1760 (defun dired-find-file-other-window ()
1761 "In Dired, visit this file or directory in another window."
1762 (interactive)
1763 (find-file-other-window (dired-get-file-for-visit)))
1764
1765 (defun dired-display-file ()
1766 "In Dired, display this file or directory in another window."
1767 (interactive)
1768 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1769 \f
1770 ;;; Functions for extracting and manipulating file names in Dired buffers.
1771
1772 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1773 "In Dired, return name of file mentioned on this line.
1774 Value returned normally includes the directory name.
1775 Optional arg LOCALP with value `no-dir' means don't include directory
1776 name in result. A value of `verbatim' means to return the name exactly as
1777 it occurs in the buffer, and a value of t means construct name relative to
1778 `default-directory', which still may contain slashes if in a subdirectory.
1779 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1780 regular filenames and return nil if no filename on this line.
1781 Otherwise, an error occurs in these cases."
1782 (let (case-fold-search file p1 p2 already-absolute)
1783 (save-excursion
1784 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1785 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1786 ;; nil if no file on this line, but no-error-if-not-filep is t:
1787 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1788 (progn
1789 ;; Get rid of the mouse-face property that file names have.
1790 (set-text-properties 0 (length file) nil file)
1791 ;; Unquote names quoted by ls or by dired-insert-directory.
1792 ;; Using read to unquote is much faster than substituting
1793 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1794 (setq file
1795 (read
1796 (concat "\""
1797 ;; Some ls -b don't escape quotes, argh!
1798 ;; This is not needed for GNU ls, though.
1799 (or (dired-string-replace-match
1800 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
1801 file)
1802 "\"")))
1803 ;; The above `read' will return a unibyte string if FILE
1804 ;; contains eight-bit-control/graphic characters.
1805 (if (and enable-multibyte-characters
1806 (not (multibyte-string-p file)))
1807 (setq file (string-to-multibyte file)))))
1808 (and file (file-name-absolute-p file)
1809 ;; A relative file name can start with ~.
1810 ;; Don't treat it as absolute in this context.
1811 (not (eq (aref file 0) ?~))
1812 (setq already-absolute t))
1813 (cond
1814 ((null file)
1815 nil)
1816 ((eq localp 'verbatim)
1817 file)
1818 ((and (not no-error-if-not-filep)
1819 (member file '("." "..")))
1820 (error "Cannot operate on `.' or `..'"))
1821 ((and (eq localp 'no-dir) already-absolute)
1822 (file-name-nondirectory file))
1823 (already-absolute
1824 (let ((handler (find-file-name-handler file nil)))
1825 ;; check for safe-magic property so that we won't
1826 ;; put /: for names that don't really need them.
1827 ;; For instance, .gz files when auto-compression-mode is on.
1828 (if (and handler (not (get handler 'safe-magic)))
1829 (concat "/:" file)
1830 file)))
1831 ((eq localp 'no-dir)
1832 file)
1833 ((equal (dired-current-directory) "/")
1834 (setq file (concat (dired-current-directory localp) file))
1835 (let ((handler (find-file-name-handler file nil)))
1836 ;; check for safe-magic property so that we won't
1837 ;; put /: for names that don't really need them.
1838 ;; For instance, .gz files when auto-compression-mode is on.
1839 (if (and handler (not (get handler 'safe-magic)))
1840 (concat "/:" file)
1841 file)))
1842 (t
1843 (concat (dired-current-directory localp) file)))))
1844
1845 (defun dired-string-replace-match (regexp string newtext
1846 &optional literal global)
1847 "Replace first match of REGEXP in STRING with NEWTEXT.
1848 If it does not match, nil is returned instead of the new string.
1849 Optional arg LITERAL means to take NEWTEXT literally.
1850 Optional arg GLOBAL means to replace all matches."
1851 (if global
1852 (let ((start 0) ret)
1853 (while (string-match regexp string start)
1854 (let ((from-end (- (length string) (match-end 0))))
1855 (setq ret (setq string (replace-match newtext t literal string)))
1856 (setq start (- (length string) from-end))))
1857 ret)
1858 (if (not (string-match regexp string 0))
1859 nil
1860 (replace-match newtext t literal string))))
1861
1862 (defun dired-make-absolute (file &optional dir)
1863 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1864 ;; We can't always use expand-file-name as this would get rid of `.'
1865 ;; or expand in / instead default-directory if DIR=="".
1866 ;; This should be good enough for ange-ftp, but might easily be
1867 ;; redefined (for VMS?).
1868 ;; It should be reasonably fast, though, as it is called in
1869 ;; dired-get-filename.
1870 (concat (or dir default-directory) file))
1871
1872 (defun dired-make-relative (file &optional dir ignore)
1873 "Convert FILE (an absolute file name) to a name relative to DIR.
1874 If this is impossible, return FILE unchanged.
1875 DIR must be a directory name, not a file name."
1876 (or dir (setq dir default-directory))
1877 ;; This case comes into play if default-directory is set to
1878 ;; use ~.
1879 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1880 (setq dir (expand-file-name dir)))
1881 (if (string-match (concat "^" (regexp-quote dir)) file)
1882 (substring file (match-end 0))
1883 ;;; (or no-error
1884 ;;; (error "%s: not in directory tree growing at %s" file dir))
1885 file))
1886 \f
1887 ;;; Functions for finding the file name in a dired buffer line.
1888
1889 (defvar dired-permission-flags-regexp
1890 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1891 "Regular expression to match the permission flags in `ls -l'.")
1892
1893 ;; Move to first char of filename on this line.
1894 ;; Returns position (point) or nil if no filename on this line."
1895 (defun dired-move-to-filename (&optional raise-error eol)
1896 "Move to the beginning of the filename on the current line.
1897 Return the position of the beginning of the filename, or nil if none found."
1898 ;; This is the UNIX version.
1899 (or eol (setq eol (line-end-position)))
1900 (beginning-of-line)
1901 ;; First try assuming `ls --dired' was used.
1902 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1903 (cond
1904 ((and change (< change eol))
1905 (goto-char change))
1906 ((re-search-forward directory-listing-before-filename-regexp eol t)
1907 (goto-char (match-end 0)))
1908 ((re-search-forward dired-permission-flags-regexp eol t)
1909 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1910 (if raise-error
1911 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
1912 (beginning-of-line)
1913 nil)
1914 (raise-error
1915 (error "No file on this line")))))
1916
1917 (defun dired-move-to-end-of-filename (&optional no-error)
1918 ;; Assumes point is at beginning of filename,
1919 ;; thus the rwx bit re-search-backward below will succeed in *this*
1920 ;; line if at all. So, it should be called only after
1921 ;; (dired-move-to-filename t).
1922 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1923 ;; This is the UNIX version.
1924 (if (get-text-property (point) 'dired-filename)
1925 (goto-char (next-single-property-change (point) 'dired-filename))
1926 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1927 ;; case-fold-search is nil now, so we can test for capital F:
1928 (setq used-F (string-match "F" dired-actual-switches)
1929 opoint (point)
1930 eol (save-excursion (end-of-line) (point))
1931 hidden (and selective-display
1932 (save-excursion (search-forward "\r" eol t))))
1933 (if hidden
1934 nil
1935 (save-excursion ;; Find out what kind of file this is:
1936 ;; Restrict perm bits to be non-blank,
1937 ;; otherwise this matches one char to early (looking backward):
1938 ;; "l---------" (some systems make symlinks that way)
1939 ;; "----------" (plain file with zero perms)
1940 (if (re-search-backward
1941 dired-permission-flags-regexp nil t)
1942 (setq file-type (char-after (match-beginning 1))
1943 symlink (eq file-type ?l)
1944 ;; Only with -F we need to know whether it's an executable
1945 executable (and
1946 used-F
1947 (string-match
1948 "[xst]" ;; execute bit set anywhere?
1949 (concat
1950 (match-string 2)
1951 (match-string 3)
1952 (match-string 4)))))
1953 (or no-error (error "No file on this line"))))
1954 ;; Move point to end of name:
1955 (if symlink
1956 (if (search-forward " -> " eol t)
1957 (progn
1958 (forward-char -4)
1959 (and used-F
1960 dired-ls-F-marks-symlinks
1961 (eq (preceding-char) ?@) ;; did ls really mark the link?
1962 (forward-char -1))))
1963 (goto-char eol) ;; else not a symbolic link
1964 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
1965 ;; one trailing character. (Executable bits on symlinks ain't mean
1966 ;; a thing, even to ls, but we know it's not a symlink.)
1967 (and used-F
1968 (or (memq file-type '(?d ?s ?p))
1969 executable)
1970 (forward-char -1))))
1971 (or no-error
1972 (not (eq opoint (point)))
1973 (error (if hidden
1974 (substitute-command-keys
1975 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1976 "No file on this line")))
1977 (if (eq opoint (point))
1978 nil
1979 (point)))))
1980
1981 \f
1982 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1983
1984 (defun dired-copy-filename-as-kill (&optional arg)
1985 "Copy names of marked (or next ARG) files into the kill ring.
1986 The names are separated by a space.
1987 With a zero prefix arg, use the absolute file name of each marked file.
1988 With \\[universal-argument], use the file name relative to the dired buffer's
1989 `default-directory'. (This still may contain slashes if in a subdirectory.)
1990
1991 If on a subdir headerline, use absolute subdirname instead;
1992 prefix arg and marked files are ignored in this case.
1993
1994 You can then feed the file name(s) to other commands with \\[yank]."
1995 (interactive "P")
1996 (let ((string
1997 (or (dired-get-subdir)
1998 (mapconcat (function identity)
1999 (if arg
2000 (cond ((zerop (prefix-numeric-value arg))
2001 (dired-get-marked-files))
2002 ((consp arg)
2003 (dired-get-marked-files t))
2004 (t
2005 (dired-get-marked-files
2006 'no-dir (prefix-numeric-value arg))))
2007 (dired-get-marked-files 'no-dir))
2008 " "))))
2009 (if (eq last-command 'kill-region)
2010 (kill-append string nil)
2011 (kill-new string))
2012 (message "%s" string)))
2013
2014 \f
2015 ;; Keeping Dired buffers in sync with the filesystem and with each other
2016
2017 (defun dired-buffers-for-dir (dir &optional file)
2018 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2019 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2020 ;; matches FILE.
2021 ;; The list is in reverse order of buffer creation, most recent last.
2022 ;; As a side effect, killed dired buffers for DIR are removed from
2023 ;; dired-buffers.
2024 (setq dir (file-name-as-directory dir))
2025 (let ((alist dired-buffers) result elt buf)
2026 (while alist
2027 (setq elt (car alist)
2028 buf (cdr elt))
2029 (if (buffer-name buf)
2030 (if (dired-in-this-tree dir (car elt))
2031 (with-current-buffer buf
2032 (and (assoc dir dired-subdir-alist)
2033 (or (null file)
2034 (let ((wildcards
2035 (file-name-nondirectory dired-directory)))
2036 (or (= 0 (length wildcards))
2037 (string-match (dired-glob-regexp wildcards)
2038 file))))
2039 (setq result (cons buf result)))))
2040 ;; else buffer is killed - clean up:
2041 (setq dired-buffers (delq elt dired-buffers)))
2042 (setq alist (cdr alist)))
2043 result))
2044
2045 (defun dired-glob-regexp (pattern)
2046 "Convert glob-pattern PATTERN to a regular expression."
2047 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2048 regexp)
2049 (while (string-match "[[?*]" pattern matched-in-pattern)
2050 (let ((op-end (match-end 0))
2051 (next-op (aref pattern (match-beginning 0))))
2052 (setq regexp (concat regexp
2053 (regexp-quote
2054 (substring pattern matched-in-pattern
2055 (match-beginning 0)))))
2056 (cond ((= next-op ??)
2057 (setq regexp (concat regexp "."))
2058 (setq matched-in-pattern op-end))
2059 ((= next-op ?\[)
2060 ;; Fails to handle ^ yet ????
2061 (let* ((set-start (match-beginning 0))
2062 (set-cont
2063 (if (= (aref pattern (1+ set-start)) ?^)
2064 (+ 3 set-start)
2065 (+ 2 set-start)))
2066 (set-end (string-match "]" pattern set-cont))
2067 (set (substring pattern set-start (1+ set-end))))
2068 (setq regexp (concat regexp set))
2069 (setq matched-in-pattern (1+ set-end))))
2070 ((= next-op ?*)
2071 (setq regexp (concat regexp ".*"))
2072 (setq matched-in-pattern op-end)))))
2073 (concat "\\`"
2074 regexp
2075 (regexp-quote
2076 (substring pattern matched-in-pattern))
2077 "\\'")))
2078
2079
2080
2081 (defun dired-advertise ()
2082 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2083 ;; With wildcards we actually advertise too much.
2084 (let ((expanded-default (expand-file-name default-directory)))
2085 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2086 t ; we have already advertised ourselves
2087 (setq dired-buffers
2088 (cons (cons expanded-default (current-buffer))
2089 dired-buffers)))))
2090
2091 (defun dired-unadvertise (dir)
2092 ;; Remove DIR from the buffer alist in variable dired-buffers.
2093 ;; This has the effect of removing any buffer whose main directory is DIR.
2094 ;; It does not affect buffers in which DIR is a subdir.
2095 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2096 (setq dired-buffers
2097 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2098 \f
2099 ;; Tree Dired
2100
2101 ;;; utility functions
2102
2103 (defun dired-in-this-tree (file dir)
2104 ;;"Is FILE part of the directory tree starting at DIR?"
2105 (let (case-fold-search)
2106 (string-match (concat "^" (regexp-quote dir)) file)))
2107
2108 (defun dired-normalize-subdir (dir)
2109 ;; Prepend default-directory to DIR if relative file name.
2110 ;; dired-get-filename must be able to make a valid file name from a
2111 ;; file and its directory DIR.
2112 (file-name-as-directory
2113 (if (file-name-absolute-p dir)
2114 dir
2115 (expand-file-name dir default-directory))))
2116
2117 (defun dired-get-subdir ()
2118 ;;"Return the subdir name on this line, or nil if not on a headerline."
2119 ;; Look up in the alist whether this is a headerline.
2120 (save-excursion
2121 (let ((cur-dir (dired-current-directory)))
2122 (beginning-of-line) ; alist stores b-o-l positions
2123 (and (zerop (- (point)
2124 (dired-get-subdir-min (assoc cur-dir
2125 dired-subdir-alist))))
2126 cur-dir))))
2127
2128 ;(defun dired-get-subdir-min (elt)
2129 ; (cdr elt))
2130 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2131 (defalias 'dired-get-subdir-min 'cdr)
2132
2133 (defun dired-get-subdir-max (elt)
2134 (save-excursion
2135 (goto-char (dired-get-subdir-min elt))
2136 (dired-subdir-max)))
2137
2138 (defun dired-clear-alist ()
2139 (while dired-subdir-alist
2140 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2141 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2142
2143 (defun dired-subdir-index (dir)
2144 ;; Return an index into alist for use with nth
2145 ;; for the sake of subdir moving commands.
2146 (let (found (index 0) (alist dired-subdir-alist))
2147 (while alist
2148 (if (string= dir (car (car alist)))
2149 (setq alist nil found t)
2150 (setq alist (cdr alist) index (1+ index))))
2151 (if found index nil)))
2152
2153 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2154 "Go to next subdirectory, regardless of level."
2155 ;; Use 0 arg to go to this directory's header line.
2156 ;; NO-SKIP prevents moving to end of header line, returning whatever
2157 ;; position was found in dired-subdir-alist.
2158 (interactive "p")
2159 (let ((this-dir (dired-current-directory))
2160 pos index)
2161 ;; nth with negative arg does not return nil but the first element
2162 (setq index (- (dired-subdir-index this-dir) arg))
2163 (setq pos (if (>= index 0)
2164 (dired-get-subdir-min (nth index dired-subdir-alist))))
2165 (if pos
2166 (progn
2167 (goto-char pos)
2168 (or no-skip (skip-chars-forward "^\n\r"))
2169 (point))
2170 (if no-error-if-not-found
2171 nil ; return nil if not found
2172 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2173
2174 (defun dired-build-subdir-alist (&optional switches)
2175 "Build `dired-subdir-alist' by parsing the buffer.
2176 Returns the new value of the alist.
2177 If optional arg SWITCHES is non-nil, use its value
2178 instead of `dired-actual-switches'."
2179 (interactive)
2180 (dired-clear-alist)
2181 (save-excursion
2182 (let* ((count 0)
2183 (buffer-read-only nil)
2184 (buffer-undo-list t)
2185 (switches (or switches dired-actual-switches))
2186 new-dir-name
2187 (R-ftp-base-dir-regex
2188 ;; Used to expand subdirectory names correctly in recursive
2189 ;; ange-ftp listings.
2190 (and (string-match "R" switches)
2191 (string-match "\\`/.*:\\(/.*\\)" default-directory)
2192 (concat "\\`" (match-string 1 default-directory)))))
2193 (goto-char (point-min))
2194 (setq dired-subdir-alist nil)
2195 (while (and (re-search-forward dired-subdir-regexp nil t)
2196 ;; Avoid taking a file name ending in a colon
2197 ;; as a subdir name.
2198 (not (save-excursion
2199 (goto-char (match-beginning 0))
2200 (beginning-of-line)
2201 (forward-char 2)
2202 (save-match-data (looking-at dired-re-perms)))))
2203 (save-excursion
2204 (goto-char (match-beginning 1))
2205 (setq new-dir-name
2206 (buffer-substring-no-properties (point) (match-end 1))
2207 new-dir-name
2208 (save-match-data
2209 (if (and R-ftp-base-dir-regex
2210 (not (string= new-dir-name default-directory))
2211 (string-match R-ftp-base-dir-regex new-dir-name))
2212 (concat default-directory
2213 (substring new-dir-name (match-end 0)))
2214 (expand-file-name new-dir-name))))
2215 (delete-region (point) (match-end 1))
2216 (insert new-dir-name))
2217 (setq count (1+ count))
2218 (dired-alist-add-1 new-dir-name
2219 ;; Place a sub directory boundary between lines.
2220 (save-excursion
2221 (goto-char (match-beginning 0))
2222 (beginning-of-line)
2223 (point-marker))))
2224 (if (and (> count 1) (interactive-p))
2225 (message "Buffer includes %d directories" count))
2226 ;; We don't need to sort it because it is in buffer order per
2227 ;; constructionem. Return new alist:
2228 dired-subdir-alist)))
2229
2230 (defun dired-alist-add-1 (dir new-marker)
2231 ;; Add new DIR at NEW-MARKER. Don't sort.
2232 (setq dired-subdir-alist
2233 (cons (cons (dired-normalize-subdir dir) new-marker)
2234 dired-subdir-alist)))
2235
2236 (defun dired-goto-next-nontrivial-file ()
2237 ;; Position point on first nontrivial file after point.
2238 (dired-goto-next-file);; so there is a file to compare with
2239 (if (stringp dired-trivial-filenames)
2240 (while (and (not (eobp))
2241 (string-match dired-trivial-filenames
2242 (file-name-nondirectory
2243 (or (dired-get-filename nil t) ""))))
2244 (forward-line 1)
2245 (dired-move-to-filename))))
2246
2247 (defun dired-goto-next-file ()
2248 (let ((max (1- (dired-subdir-max))))
2249 (while (and (not (dired-move-to-filename)) (< (point) max))
2250 (forward-line 1))))
2251
2252 (defun dired-goto-file (file)
2253 "Go to line describing file FILE in this dired buffer."
2254 ;; Return value of point on success, else nil.
2255 ;; FILE must be an absolute file name.
2256 ;; Loses if FILE contains control chars like "\007" for which ls
2257 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2258 ;; it in the buffer.
2259 (interactive
2260 (prog1 ; let push-mark display its message
2261 (list (expand-file-name
2262 (read-file-name "Goto file: "
2263 (dired-current-directory))))
2264 (push-mark)))
2265 (setq file (directory-file-name file)) ; does no harm if no directory
2266 (let (found case-fold-search dir)
2267 (setq dir (or (file-name-directory file)
2268 (error "File name `%s' is not absolute" file)))
2269 (save-excursion
2270 ;; The hair here is to get the result of dired-goto-subdir
2271 ;; without really calling it if we don't have any subdirs.
2272 (if (if (string= dir (expand-file-name default-directory))
2273 (goto-char (point-min))
2274 (and (cdr dired-subdir-alist)
2275 (dired-goto-subdir dir)))
2276 (let ((base (file-name-nondirectory file))
2277 search-string
2278 (boundary (dired-subdir-max)))
2279 (setq search-string
2280 (replace-regexp-in-string "\^m" "\\^m" base nil t))
2281 (setq search-string
2282 (replace-regexp-in-string "\\\\" "\\\\" search-string nil t))
2283 (while (and (not found)
2284 ;; filenames are preceded by SPC, this makes
2285 ;; the search faster (e.g. for the filename "-"!).
2286 (search-forward (concat " " search-string)
2287 boundary 'move))
2288 ;; Match could have BASE just as initial substring or
2289 ;; or in permission bits or date or
2290 ;; not be a proper filename at all:
2291 (if (equal base (dired-get-filename 'no-dir t))
2292 ;; Must move to filename since an (actually
2293 ;; correct) match could have been elsewhere on the
2294 ;; ;; line (e.g. "-" would match somewhere in the
2295 ;; permission bits).
2296 (setq found (dired-move-to-filename))
2297 ;; If this isn't the right line, move forward to avoid
2298 ;; trying this line again.
2299 (forward-line 1))))))
2300 (and found
2301 ;; return value of point (i.e., FOUND):
2302 (goto-char found))))
2303
2304 (defun dired-initial-position (dirname)
2305 ;; Where point should go in a new listing of DIRNAME.
2306 ;; Point assumed at beginning of new subdir line.
2307 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2308 (end-of-line)
2309 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2310 \f
2311 ;; These are hooks which make tree dired work.
2312 ;; They are in this file because other parts of dired need to call them.
2313 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2314
2315 ;; This function is called for each retrieved filename.
2316 ;; It could stand to be faster, though it's mostly function call
2317 ;; overhead. Avoiding the function call seems to save about 10% in
2318 ;; dired-get-filename. Make it a defsubst?
2319 (defun dired-current-directory (&optional localp)
2320 "Return the name of the subdirectory to which this line belongs.
2321 This returns a string with trailing slash, like `default-directory'.
2322 Optional argument means return a file name relative to `default-directory'."
2323 (let ((here (point))
2324 (alist (or dired-subdir-alist
2325 ;; probably because called in a non-dired buffer
2326 (error "No subdir-alist in %s" (current-buffer))))
2327 elt dir)
2328 (while alist
2329 (setq elt (car alist)
2330 dir (car elt)
2331 ;; use `<=' (not `<') as subdir line is part of subdir
2332 alist (if (<= (dired-get-subdir-min elt) here)
2333 nil ; found
2334 (cdr alist))))
2335 (if localp
2336 (dired-make-relative dir default-directory)
2337 dir)))
2338
2339 ;; Subdirs start at the beginning of their header lines and end just
2340 ;; before the beginning of the next header line (or end of buffer).
2341
2342 (defun dired-subdir-max ()
2343 (save-excursion
2344 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2345 (point-max)
2346 (point))))
2347 \f
2348 ;; Deleting files
2349
2350 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
2351 "*Decide whether recursive deletes are allowed.
2352 nil means no recursive deletes.
2353 `always' means delete recursively without asking. This is DANGEROUS!
2354 `top' means ask for each directory at top level, but delete its subdirectories
2355 without asking.
2356 Anything else means ask for each directory."
2357 :type '(choice :tag "Delete non-empty directories"
2358 (const :tag "Yes" always)
2359 (const :tag "No--only delete empty directories" nil)
2360 (const :tag "Confirm for each directory" t)
2361 (const :tag "Confirm for each top directory only" top))
2362 :group 'dired)
2363
2364 ;; Match anything but `.' and `..'.
2365 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2366
2367 ;; Delete file, possibly delete a directory and all its files.
2368 ;; This function is usefull outside of dired. One could change it's name
2369 ;; to e.g. recursive-delete-file and put it somewhere else.
2370 (defun dired-delete-file (file &optional recursive) "\
2371 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2372 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2373 nil, do not delete.
2374 `always', delete recursively without asking.
2375 `top', ask for each directory at top level.
2376 Anything else, ask for each sub-directory."
2377 (let (files)
2378 ;; This test is equivalent to
2379 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2380 ;; but more efficient
2381 (if (not (eq t (car (file-attributes file))))
2382 (delete-file file)
2383 (when (and recursive
2384 (setq files
2385 (directory-files file t dired-re-no-dot)) ; Not empty.
2386 (or (eq recursive 'always)
2387 (yes-or-no-p (format "Recursive delete of %s? "
2388 (dired-make-relative file)))))
2389 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2390 (while files ; Recursively delete (possibly asking).
2391 (dired-delete-file (car files) recursive)
2392 (setq files (cdr files))))
2393 (delete-directory file))))
2394
2395 (defun dired-do-flagged-delete (&optional nomessage)
2396 "In Dired, delete the files flagged for deletion.
2397 If NOMESSAGE is non-nil, we don't display any message
2398 if there are no flagged files."
2399 (interactive)
2400 (let* ((dired-marker-char dired-del-marker)
2401 (regexp (dired-marker-regexp))
2402 case-fold-search)
2403 (if (save-excursion (goto-char (point-min))
2404 (re-search-forward regexp nil t))
2405 (dired-internal-do-deletions
2406 ;; this can't move point since ARG is nil
2407 (dired-map-over-marks (cons (dired-get-filename) (point))
2408 nil)
2409 nil)
2410 (or nomessage
2411 (message "(No deletions requested)")))))
2412
2413 (defun dired-do-delete (&optional arg)
2414 "Delete all marked (or next ARG) files."
2415 ;; This is more consistent with the file marking feature than
2416 ;; dired-do-flagged-delete.
2417 (interactive "P")
2418 (dired-internal-do-deletions
2419 ;; this may move point if ARG is an integer
2420 (dired-map-over-marks (cons (dired-get-filename) (point))
2421 arg)
2422 arg))
2423
2424 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2425
2426 (defun dired-internal-do-deletions (l arg)
2427 ;; L is an alist of files to delete, with their buffer positions.
2428 ;; ARG is the prefix arg.
2429 ;; Filenames are absolute (VMS needs this for logical search paths).
2430 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2431 ;; That way as changes are made in the buffer they do not shift the
2432 ;; lines still to be changed, so the (point) values in L stay valid.
2433 ;; Also, for subdirs in natural order, a subdir's files are deleted
2434 ;; before the subdir itself - the other way around would not work.
2435 (let ((files (mapcar (function car) l))
2436 (count (length l))
2437 (succ 0))
2438 ;; canonicalize file list for pop up
2439 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2440 (if (dired-mark-pop-up
2441 " *Deletions*" 'delete files dired-deletion-confirmer
2442 (format "Delete %s " (dired-mark-prompt arg files)))
2443 (save-excursion
2444 (let (failures);; files better be in reverse order for this loop!
2445 (while l
2446 (goto-char (cdr (car l)))
2447 (let (buffer-read-only)
2448 (condition-case err
2449 (let ((fn (car (car l))))
2450 (dired-delete-file fn dired-recursive-deletes)
2451 ;; if we get here, removing worked
2452 (setq succ (1+ succ))
2453 (message "%s of %s deletions" succ count)
2454 (dired-fun-in-all-buffers
2455 (file-name-directory fn) (file-name-nondirectory fn)
2456 (function dired-delete-entry) fn))
2457 (error;; catch errors from failed deletions
2458 (dired-log "%s\n" err)
2459 (setq failures (cons (car (car l)) failures)))))
2460 (setq l (cdr l)))
2461 (if (not failures)
2462 (message "%d deletion%s done" count (dired-plural-s count))
2463 (dired-log-summary
2464 (format "%d of %d deletion%s failed"
2465 (length failures) count
2466 (dired-plural-s count))
2467 failures))))
2468 (message "(No deletions performed)")))
2469 (dired-move-to-filename))
2470
2471 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2472 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2473 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2474 ;; (FILE does not include a directory component.)
2475 ;; FILE may be nil, in which case ignore it.
2476 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2477 (let (success-list)
2478 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2479 file))
2480 (with-current-buffer buf
2481 (if (apply fun args)
2482 (setq success-list (cons (buffer-name buf) success-list)))))
2483 success-list))
2484
2485 ;; Delete the entry for FILE from
2486 (defun dired-delete-entry (file)
2487 (save-excursion
2488 (and (dired-goto-file file)
2489 (let (buffer-read-only)
2490 (delete-region (progn (beginning-of-line) (point))
2491 (save-excursion (forward-line 1) (point))))))
2492 (dired-clean-up-after-deletion file))
2493
2494 ;; This is a separate function for the sake of dired-x.el.
2495 (defun dired-clean-up-after-deletion (fn)
2496 ;; Clean up after a deleted file or directory FN.
2497 (save-excursion (and (cdr dired-subdir-alist)
2498 (dired-goto-subdir fn)
2499 (dired-kill-subdir))))
2500 \f
2501 ;; Confirmation
2502
2503 (defun dired-marker-regexp ()
2504 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2505
2506 (defun dired-plural-s (count)
2507 (if (= 1 count) "" "s"))
2508
2509 (defun dired-mark-prompt (arg files)
2510 ;; Return a string for use in a prompt, either the current file
2511 ;; name, or the marker and a count of marked files.
2512 (let ((count (length files)))
2513 (if (= count 1)
2514 (car files)
2515 ;; more than 1 file:
2516 (if (integerp arg)
2517 ;; abs(arg) = count
2518 ;; Perhaps this is nicer, but it also takes more screen space:
2519 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2520 ;; count)
2521 (format "[next %d files]" arg)
2522 (format "%c [%d files]" dired-marker-char count)))))
2523
2524 (defun dired-pop-to-buffer (buf)
2525 ;; Pop up buffer BUF.
2526 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2527 (if (not dired-shrink-to-fit)
2528 (pop-to-buffer (get-buffer-create buf))
2529 ;; let window shrink to fit:
2530 (let ((window (selected-window))
2531 target-lines w2)
2532 (cond ;; if split-height-threshold is enabled, use the largest window
2533 ((and (> (window-height (setq w2 (get-largest-window)))
2534 split-height-threshold)
2535 (= (frame-width) (window-width w2)))
2536 (setq window w2))
2537 ;; if the least-recently-used window is big enough, use it
2538 ((and (> (window-height (setq w2 (get-lru-window)))
2539 (* 2 window-min-height))
2540 (= (frame-width) (window-width w2)))
2541 (setq window w2)))
2542 (save-excursion
2543 (set-buffer buf)
2544 (goto-char (point-max))
2545 (skip-chars-backward "\n\r\t ")
2546 (setq target-lines (count-lines (point-min) (point)))
2547 ;; Don't forget to count the last line.
2548 (if (not (bolp))
2549 (setq target-lines (1+ target-lines))))
2550 (if (<= (window-height window) (* 2 window-min-height))
2551 ;; At this point, every window on the frame is too small to split.
2552 (setq w2 (display-buffer buf))
2553 (setq w2 (split-window window
2554 (max window-min-height
2555 (- (window-height window)
2556 (1+ (max window-min-height target-lines)))))))
2557 (set-window-buffer w2 buf)
2558 (if (< (1- (window-height w2)) target-lines)
2559 (progn
2560 (select-window w2)
2561 (enlarge-window (- target-lines (1- (window-height w2))))))
2562 (set-window-start w2 1)
2563 )))
2564
2565 (defcustom dired-no-confirm nil
2566 "A list of symbols for commands Dired should not confirm.
2567 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2568 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2569 `touch' and `uncompress'."
2570 :group 'dired
2571 :type '(set (const byte-compile) (const chgrp)
2572 (const chmod) (const chown) (const compress)
2573 (const copy) (const delete) (const hardlink)
2574 (const load) (const move) (const print)
2575 (const shell) (const symlink) (const touch)
2576 (const uncompress)))
2577
2578 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2579 "Return FUNCTION's result on ARGS after showing which files are marked.
2580 Displays the file names in a buffer named BUFNAME;
2581 nil gives \" *Marked Files*\".
2582 This uses function `dired-pop-to-buffer' to do that.
2583
2584 FUNCTION should not manipulate files, just read input
2585 (an argument or confirmation).
2586 The window is not shown if there is just one file or
2587 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2588 FILES is the list of marked files. It can also be (t FILENAME)
2589 in the case of one marked file, to distinguish that from using
2590 just the current file."
2591 (or bufname (setq bufname " *Marked Files*"))
2592 (if (or (eq dired-no-confirm t)
2593 (memq op-symbol dired-no-confirm)
2594 ;; If FILES defaulted to the current line's file.
2595 (= (length files) 1))
2596 (apply function args)
2597 (with-current-buffer (get-buffer-create bufname)
2598 (erase-buffer)
2599 ;; Handle (t FILE) just like (FILE), here.
2600 ;; That value is used (only in some cases), to mean
2601 ;; just one file that was marked, rather than the current line file.
2602 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2603 (remove-text-properties (point-min) (point-max)
2604 '(mouse-face nil help-echo nil)))
2605 (save-window-excursion
2606 (dired-pop-to-buffer bufname)
2607 (apply function args))))
2608
2609 (defun dired-format-columns-of-files (files)
2610 ;; Files should be in forward order for this loop.
2611 ;; i.e., (car files) = first file in buffer.
2612 ;; Returns the number of lines used.
2613 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2614 (width (- (window-width (selected-window)) 2))
2615 (columns (max 1 (/ width maxlen)))
2616 (nfiles (length files))
2617 (rows (+ (/ nfiles columns)
2618 (if (zerop (% nfiles columns)) 0 1)))
2619 (i 0)
2620 (j 0))
2621 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2622 (make-list (- (* columns rows) nfiles) "")))
2623 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2624 (while (< j rows)
2625 (while (< i columns)
2626 (indent-to (* i maxlen))
2627 (insert (car files))
2628 (setq files (nthcdr rows files)
2629 i (1+ i)))
2630 (insert "\n")
2631 (setq i 0
2632 j (1+ j)
2633 files (cdr files)))
2634 rows))
2635 \f
2636 ;; Commands to mark or flag file(s) at or near current line.
2637
2638 (defun dired-repeat-over-lines (arg function)
2639 ;; This version skips non-file lines.
2640 (let ((pos (make-marker)))
2641 (beginning-of-line)
2642 (while (and (> arg 0) (not (eobp)))
2643 (setq arg (1- arg))
2644 (beginning-of-line)
2645 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2646 (save-excursion
2647 (forward-line 1)
2648 (move-marker pos (1+ (point))))
2649 (save-excursion (funcall function))
2650 ;; Advance to the next line--actually, to the line that *was* next.
2651 ;; (If FUNCTION inserted some new lines in between, skip them.)
2652 (goto-char pos))
2653 (while (and (< arg 0) (not (bobp)))
2654 (setq arg (1+ arg))
2655 (forward-line -1)
2656 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2657 (beginning-of-line)
2658 (save-excursion (funcall function)))
2659 (move-marker pos nil)
2660 (dired-move-to-filename)))
2661
2662 (defun dired-between-files ()
2663 ;; This used to be a regexp match of the `total ...' line output by
2664 ;; ls, which is slightly faster, but that is not very robust; notably,
2665 ;; it fails for non-english locales.
2666 (save-excursion (not (dired-move-to-filename))))
2667
2668 (defun dired-next-marked-file (arg &optional wrap opoint)
2669 "Move to the next marked file, wrapping around the end of the buffer."
2670 (interactive "p\np")
2671 (or opoint (setq opoint (point)));; return to where interactively started
2672 (if (if (> arg 0)
2673 (re-search-forward dired-re-mark nil t arg)
2674 (beginning-of-line)
2675 (re-search-backward dired-re-mark nil t (- arg)))
2676 (dired-move-to-filename)
2677 (if (null wrap)
2678 (progn
2679 (goto-char opoint)
2680 (error "No next marked file"))
2681 (message "(Wraparound for next marked file)")
2682 (goto-char (if (> arg 0) (point-min) (point-max)))
2683 (dired-next-marked-file arg nil opoint))))
2684
2685 (defun dired-prev-marked-file (arg &optional wrap)
2686 "Move to the previous marked file, wrapping around the end of the buffer."
2687 (interactive "p\np")
2688 (dired-next-marked-file (- arg) wrap))
2689
2690 (defun dired-file-marker (file)
2691 ;; Return FILE's marker, or nil if unmarked.
2692 (save-excursion
2693 (and (dired-goto-file file)
2694 (progn
2695 (beginning-of-line)
2696 (if (not (equal ?\040 (following-char)))
2697 (following-char))))))
2698
2699 (defun dired-mark-files-in-region (start end)
2700 (let (buffer-read-only)
2701 (if (> start end)
2702 (error "start > end"))
2703 (goto-char start) ; assumed at beginning of line
2704 (while (< (point) end)
2705 ;; Skip subdir line and following garbage like the `total' line:
2706 (while (and (< (point) end) (dired-between-files))
2707 (forward-line 1))
2708 (if (and (not (looking-at dired-re-dot))
2709 (dired-get-filename nil t))
2710 (progn
2711 (delete-char 1)
2712 (insert dired-marker-char)))
2713 (forward-line 1))))
2714
2715 (defun dired-mark (arg)
2716 "Mark the current (or next ARG) files.
2717 If on a subdir headerline, mark all its files except `.' and `..'.
2718
2719 Use \\[dired-unmark-all-files] to remove all marks
2720 and \\[dired-unmark] on a subdir to remove the marks in
2721 this subdir."
2722 (interactive "P")
2723 (if (dired-get-subdir)
2724 (save-excursion (dired-mark-subdir-files))
2725 (let (buffer-read-only)
2726 (dired-repeat-over-lines
2727 (prefix-numeric-value arg)
2728 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2729
2730 (defun dired-unmark (arg)
2731 "Unmark the current (or next ARG) files.
2732 If looking at a subdir, unmark all its files except `.' and `..'."
2733 (interactive "P")
2734 (let ((dired-marker-char ?\040))
2735 (dired-mark arg)))
2736
2737 (defun dired-flag-file-deletion (arg)
2738 "In Dired, flag the current line's file for deletion.
2739 With prefix arg, repeat over several lines.
2740
2741 If on a subdir headerline, mark all its files except `.' and `..'."
2742 (interactive "P")
2743 (let ((dired-marker-char dired-del-marker))
2744 (dired-mark arg)))
2745
2746 (defun dired-unmark-backward (arg)
2747 "In Dired, move up lines and remove deletion flag there.
2748 Optional prefix ARG says how many lines to unflag; default is one line."
2749 (interactive "p")
2750 (dired-unmark (- arg)))
2751
2752 (defun dired-toggle-marks ()
2753 "Toggle marks: marked files become unmarked, and vice versa.
2754 Files marked with other flags (such as `D') are not affected.
2755 `.' and `..' are never toggled.
2756 As always, hidden subdirs are not affected."
2757 (interactive)
2758 (save-excursion
2759 (goto-char (point-min))
2760 (let (buffer-read-only)
2761 (while (not (eobp))
2762 (or (dired-between-files)
2763 (looking-at dired-re-dot)
2764 ;; use subst instead of insdel because it does not move
2765 ;; the gap and thus should be faster and because
2766 ;; other characters are left alone automatically
2767 (apply 'subst-char-in-region
2768 (point) (1+ (point))
2769 (if (eq ?\040 (following-char)) ; SPC
2770 (list ?\040 dired-marker-char)
2771 (list dired-marker-char ?\040))))
2772 (forward-line 1)))))
2773 \f
2774 ;;; Commands to mark or flag files based on their characteristics or names.
2775
2776 (defvar dired-regexp-history nil
2777 "History list of regular expressions used in Dired commands.")
2778
2779 (defun dired-read-regexp (prompt)
2780 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2781
2782 (defun dired-mark-files-regexp (regexp &optional marker-char)
2783 "Mark all files matching REGEXP for use in later commands.
2784 A prefix argument means to unmark them instead.
2785 `.' and `..' are never marked.
2786
2787 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2788 object files--just `.o' will mark more than you might think."
2789 (interactive
2790 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2791 " files (regexp): "))
2792 (if current-prefix-arg ?\040)))
2793 (let ((dired-marker-char (or marker-char dired-marker-char)))
2794 (dired-mark-if
2795 (and (not (looking-at dired-re-dot))
2796 (not (eolp)) ; empty line
2797 (let ((fn (dired-get-filename nil t)))
2798 (and fn (string-match regexp (file-name-nondirectory fn)))))
2799 "matching file")))
2800
2801 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2802 "Mark all files with contents containing REGEXP for use in later commands.
2803 A prefix argument means to unmark them instead.
2804 `.' and `..' are never marked."
2805 (interactive
2806 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2807 " files containing (regexp): "))
2808 (if current-prefix-arg ?\040)))
2809 (let ((dired-marker-char (or marker-char dired-marker-char)))
2810 (dired-mark-if
2811 (and (not (looking-at dired-re-dot))
2812 (not (eolp)) ; empty line
2813 (let ((fn (dired-get-filename nil t)))
2814 (when (and fn (file-readable-p fn)
2815 (not (file-directory-p fn)))
2816 (let ((prebuf (get-file-buffer fn)))
2817 (message "Checking %s" fn)
2818 ;; For now we do it inside emacs
2819 ;; Grep might be better if there are a lot of files
2820 (if prebuf
2821 (with-current-buffer prebuf
2822 (save-excursion
2823 (goto-char (point-min))
2824 (re-search-forward regexp nil t)))
2825 (with-temp-buffer
2826 (insert-file-contents fn)
2827 (goto-char (point-min))
2828 (re-search-forward regexp nil t))))
2829 )))
2830 "matching file")))
2831
2832 (defun dired-flag-files-regexp (regexp)
2833 "In Dired, flag all files containing the specified REGEXP for deletion.
2834 The match is against the non-directory part of the filename. Use `^'
2835 and `$' to anchor matches. Exclude subdirs by hiding them.
2836 `.' and `..' are never flagged."
2837 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2838 (dired-mark-files-regexp regexp dired-del-marker))
2839
2840 (defun dired-mark-symlinks (unflag-p)
2841 "Mark all symbolic links.
2842 With prefix argument, unflag all those files."
2843 (interactive "P")
2844 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2845 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2846
2847 (defun dired-mark-directories (unflag-p)
2848 "Mark all directory file lines except `.' and `..'.
2849 With prefix argument, unflag all those files."
2850 (interactive "P")
2851 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2852 (dired-mark-if (and (looking-at dired-re-dir)
2853 (not (looking-at dired-re-dot)))
2854 "directory file")))
2855
2856 (defun dired-mark-executables (unflag-p)
2857 "Mark all executable files.
2858 With prefix argument, unflag all those files."
2859 (interactive "P")
2860 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2861 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2862
2863 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2864 ;; files for which PREDICATE returns non-nil.
2865
2866 (defun dired-flag-auto-save-files (&optional unflag-p)
2867 "Flag for deletion files whose names suggest they are auto save files.
2868 A prefix argument says to unflag those files instead."
2869 (interactive "P")
2870 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2871 (dired-mark-if
2872 ;; It is less than general to check for # here,
2873 ;; but it's the only way this runs fast enough.
2874 (and (save-excursion (end-of-line)
2875 (or
2876 (eq (preceding-char) ?#)
2877 ;; Handle executables in case of -F option.
2878 ;; We need not worry about the other kinds
2879 ;; of markings that -F makes, since they won't
2880 ;; appear on real auto-save files.
2881 (if (eq (preceding-char) ?*)
2882 (progn
2883 (forward-char -1)
2884 (eq (preceding-char) ?#)))))
2885 (not (looking-at dired-re-dir))
2886 (let ((fn (dired-get-filename t t)))
2887 (if fn (auto-save-file-name-p
2888 (file-name-nondirectory fn)))))
2889 "auto save file")))
2890
2891 (defcustom dired-garbage-files-regexp
2892 ;; `log' here is dubious, since it's typically used for useful log
2893 ;; files, not just TeX stuff. -- fx
2894 (concat (regexp-opt
2895 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2896 "\\'")
2897 "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
2898 :type 'regexp
2899 :group 'dired)
2900
2901 (defun dired-flag-garbage-files ()
2902 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2903 (interactive)
2904 (dired-flag-files-regexp dired-garbage-files-regexp))
2905
2906 (defun dired-flag-backup-files (&optional unflag-p)
2907 "Flag all backup files (names ending with `~') for deletion.
2908 With prefix argument, unflag these files."
2909 (interactive "P")
2910 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
2911 (dired-mark-if
2912 ;; Don't call backup-file-name-p unless the last character looks like
2913 ;; it might be the end of a backup file name. This isn't very general,
2914 ;; but it's the only way this runs fast enough.
2915 (and (save-excursion (end-of-line)
2916 ;; Handle executables in case of -F option.
2917 ;; We need not worry about the other kinds
2918 ;; of markings that -F makes, since they won't
2919 ;; appear on real backup files.
2920 (if (eq (preceding-char) ?*)
2921 (forward-char -1))
2922 (eq (preceding-char) ?~))
2923 (not (looking-at dired-re-dir))
2924 (let ((fn (dired-get-filename t t)))
2925 (if fn (backup-file-name-p fn))))
2926 "backup file")))
2927
2928 (defun dired-change-marks (&optional old new)
2929 "Change all OLD marks to NEW marks.
2930 OLD and NEW are both characters used to mark files."
2931 (interactive
2932 (let* ((cursor-in-echo-area t)
2933 (old (progn (message "Change (old mark): ") (read-char)))
2934 (new (progn (message "Change %c marks to (new mark): " old)
2935 (read-char))))
2936 (list old new)))
2937 (if (or (eq old ?\r) (eq new ?\r))
2938 (ding)
2939 (let ((string (format "\n%c" old))
2940 (buffer-read-only))
2941 (save-excursion
2942 (goto-char (point-min))
2943 (while (search-forward string nil t)
2944 (if (if (= old ?\s)
2945 (save-match-data
2946 (dired-get-filename 'no-dir t))
2947 t)
2948 (subst-char-in-region (match-beginning 0)
2949 (match-end 0) old new)))))))
2950
2951 (defun dired-unmark-all-marks ()
2952 "Remove all marks from all files in the dired buffer."
2953 (interactive)
2954 (dired-unmark-all-files ?\r))
2955
2956 (defun dired-unmark-all-files (mark &optional arg)
2957 "Remove a specific mark (or any mark) from every file.
2958 After this command, type the mark character to remove,
2959 or type RET to remove all marks.
2960 With prefix arg, query for each marked file.
2961 Type \\[help-command] at that time for help."
2962 (interactive "cRemove marks (RET means all): \nP")
2963 (save-excursion
2964 (let* ((count 0)
2965 buffer-read-only case-fold-search query
2966 (string (format "\n%c" mark))
2967 (help-form "\
2968 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2969 `!' to unmark all remaining files with no more questions."))
2970 (goto-char (point-min))
2971 (while (if (eq mark ?\r)
2972 (re-search-forward dired-re-mark nil t)
2973 (search-forward string nil t))
2974 (if (or (not arg)
2975 (let ((file (dired-get-filename t t)))
2976 (and file
2977 (dired-query 'query "Unmark file `%s'? "
2978 file))))
2979 (progn (subst-char-in-region (1- (point)) (point)
2980 (preceding-char) ?\s)
2981 (setq count (1+ count)))))
2982 (message (if (= count 1) "1 mark removed"
2983 "%d marks removed")
2984 count))))
2985 \f
2986 ;; Logging failures operating on files, and showing the results.
2987
2988 (defvar dired-log-buffer "*Dired log*")
2989
2990 (defun dired-why ()
2991 "Pop up a buffer with error log output from Dired.
2992 A group of errors from a single command ends with a formfeed.
2993 Thus, use \\[backward-page] to find the beginning of a group of errors."
2994 (interactive)
2995 (if (get-buffer dired-log-buffer)
2996 (let ((owindow (selected-window))
2997 (window (display-buffer (get-buffer dired-log-buffer))))
2998 (unwind-protect
2999 (progn
3000 (select-window window)
3001 (goto-char (point-max))
3002 (forward-line -1)
3003 (backward-page 1)
3004 (recenter 0))
3005 (select-window owindow)))))
3006
3007 (defun dired-log (log &rest args)
3008 ;; Log a message or the contents of a buffer.
3009 ;; If LOG is a string and there are more args, it is formatted with
3010 ;; those ARGS. Usually the LOG string ends with a \n.
3011 ;; End each bunch of errors with (dired-log t):
3012 ;; this inserts the current time and buffer at the start of the page,
3013 ;; and \f (formfeed) at the end.
3014 (let ((obuf (current-buffer)))
3015 (with-current-buffer (get-buffer-create dired-log-buffer)
3016 (goto-char (point-max))
3017 (let ((inhibit-read-only t))
3018 (cond ((stringp log)
3019 (insert (if args
3020 (apply (function format) log args)
3021 log)))
3022 ((bufferp log)
3023 (insert-buffer-substring log))
3024 ((eq t log)
3025 (backward-page 1)
3026 (unless (bolp)
3027 (insert "\n"))
3028 (insert (current-time-string)
3029 "\tBuffer `" (buffer-name obuf) "'\n")
3030 (goto-char (point-max))
3031 (insert "\f\n")))))))
3032
3033 (defun dired-log-summary (string failures)
3034 (if (= (length failures) 1)
3035 (message "%s"
3036 (with-current-buffer dired-log-buffer
3037 (goto-char (point-max))
3038 (backward-page 1)
3039 (if (eolp) (forward-line 1))
3040 (buffer-substring (point) (point-max))))
3041 (message (if failures "%s--type ? for details (%s)"
3042 "%s--type ? for details")
3043 string failures))
3044 ;; Log a summary describing a bunch of errors.
3045 (dired-log (concat "\n" string "\n"))
3046 (dired-log t))
3047 \f
3048 ;;; Sorting
3049
3050 ;; Most ls can only sort by name or by date (with -t), nothing else.
3051 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3052 ;; So anything that does not contain these is sort "by name".
3053
3054 (defvar dired-ls-sorting-switches "SXU"
3055 "String of `ls' switches \(single letters\) except \"t\" that influence sorting.
3056
3057 This indicates to Dired which option switches to watch out for because they
3058 will change the sorting order behavior of `ls'.
3059
3060 To change the default sorting order \(e.g. add a `-v' option\), see the
3061 variable `dired-listing-switches'. To temporarily override the listing
3062 format, use `\\[universal-argument] \\[dired]'.")
3063
3064 (defvar dired-sort-by-date-regexp
3065 (concat "^-[^" dired-ls-sorting-switches
3066 "]*t[^" dired-ls-sorting-switches "]*$")
3067 "Regexp recognized by Dired to set `by date' mode.")
3068
3069 (defvar dired-sort-by-name-regexp
3070 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3071 "Regexp recognized by Dired to set `by name' mode.")
3072
3073 (defvar dired-sort-inhibit nil
3074 "Non-nil means the Dired sort command is disabled.
3075 The idea is to set this buffer-locally in special dired buffers.")
3076
3077 (defun dired-sort-set-modeline ()
3078 ;; Set modeline display according to dired-actual-switches.
3079 ;; Modeline display of "by name" or "by date" guarantees the user a
3080 ;; match with the corresponding regexps. Non-matching switches are
3081 ;; shown literally.
3082 (setq mode-name
3083 (let (case-fold-search)
3084 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
3085 "Dired by name")
3086 ((string-match dired-sort-by-date-regexp dired-actual-switches)
3087 "Dired by date")
3088 (t
3089 (concat "Dired " dired-actual-switches)))))
3090 (force-mode-line-update))
3091
3092 (defun dired-sort-toggle-or-edit (&optional arg)
3093 "Toggle between sort by date/name and refresh the dired buffer.
3094 With a prefix argument you can edit the current listing switches instead."
3095 (interactive "P")
3096 (when dired-sort-inhibit
3097 (error "Cannot sort this dired buffer"))
3098 (if arg
3099 (dired-sort-other
3100 (read-string "ls switches (must contain -l): " dired-actual-switches))
3101 (dired-sort-toggle)))
3102
3103 (defun dired-sort-toggle ()
3104 ;; Toggle between sort by date/name. Reverts the buffer.
3105 (setq dired-actual-switches
3106 (let (case-fold-search)
3107 (if (string-match " " dired-actual-switches)
3108 ;; New toggle scheme: add/remove a trailing " -t"
3109 (if (string-match " -t\\'" dired-actual-switches)
3110 (substring dired-actual-switches 0 (match-beginning 0))
3111 (concat dired-actual-switches " -t"))
3112 ;; old toggle scheme: look for some 't' switch and add/remove it
3113 (concat
3114 "-l"
3115 (dired-replace-in-string (concat "[-lt"
3116 dired-ls-sorting-switches "]")
3117 ""
3118 dired-actual-switches)
3119 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3120 dired-actual-switches)
3121 ""
3122 "t")))))
3123 (dired-sort-set-modeline)
3124 (revert-buffer))
3125
3126 ;; Some user code loads dired especially for this.
3127 ;; Don't do that--use replace-regexp-in-string instead.
3128 (defun dired-replace-in-string (regexp newtext string)
3129 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3130 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3131 (let ((result "") (start 0) mb me)
3132 (while (string-match regexp string start)
3133 (setq mb (match-beginning 0)
3134 me (match-end 0)
3135 result (concat result (substring string start mb) newtext)
3136 start me))
3137 (concat result (substring string start))))
3138
3139 (defun dired-sort-other (switches &optional no-revert)
3140 "Specify new `ls' SWITCHES for current dired buffer.
3141 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3142 set the minor mode accordingly, others appear literally in the mode line.
3143 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3144 (dired-sort-R-check switches)
3145 (setq dired-actual-switches switches)
3146 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
3147 (or no-revert (revert-buffer)))
3148
3149 (defvar dired-subdir-alist-pre-R nil
3150 "Value of `dired-subdir-alist' before -R switch added.")
3151 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3152
3153 (defun dired-sort-R-check (switches)
3154 "Additional processing of -R in ls option string SWITCHES.
3155 Saves `dired-subdir-alist' when R is set and restores saved value
3156 minus any directories explicitly deleted when R is cleared.
3157 To be called first in body of `dired-sort-other', etc."
3158 (cond
3159 ((and (string-match "R" switches)
3160 (not (string-match "R" dired-actual-switches)))
3161 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3162 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3163 ((and (string-match "R" dired-actual-switches)
3164 (not (string-match "R" switches)))
3165 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3166 ;; that are still present:
3167 (setq dired-subdir-alist
3168 (if dired-subdir-alist-pre-R
3169 (let (subdirs)
3170 (while dired-subdir-alist-pre-R
3171 (if (assoc (caar dired-subdir-alist-pre-R)
3172 dired-subdir-alist)
3173 ;; subdir still present...
3174 (setq subdirs
3175 (cons (car dired-subdir-alist-pre-R)
3176 subdirs)))
3177 (setq dired-subdir-alist-pre-R
3178 (cdr dired-subdir-alist-pre-R)))
3179 (reverse subdirs))
3180 ;; No pre-R subdir alist, so revert to main directory
3181 ;; listing:
3182 (list (car (reverse dired-subdir-alist))))))))
3183 \f
3184
3185 ;;;; Drag and drop support
3186
3187 (defcustom dired-recursive-copies nil
3188 "*Decide whether recursive copies are allowed.
3189 nil means no recursive copies.
3190 `always' means copy recursively without asking.
3191 `top' means ask for each directory at top level.
3192 Anything else means ask for each directory."
3193 :type '(choice :tag "Copy directories"
3194 (const :tag "No recursive copies" nil)
3195 (const :tag "Ask for each directory" t)
3196 (const :tag "Ask for each top directory only" top)
3197 (const :tag "Copy directories without asking" always))
3198 :group 'dired)
3199
3200 (defun dired-dnd-popup-notice ()
3201 (message-box
3202 "Recursive copies not enabled.\nSee variable dired-recursive-copies."))
3203
3204
3205 (defun dired-dnd-do-ask-action (uri)
3206 ;; No need to get actions and descriptions from the source,
3207 ;; we only have three actions anyway.
3208 (let ((action (x-popup-menu
3209 t
3210 (list "What action?"
3211 (cons ""
3212 '(("Copy here" . copy)
3213 ("Move here" . move)
3214 ("Link here" . link)
3215 "--"
3216 ("Cancel" . nil)))))))
3217 (if action
3218 (dired-dnd-handle-local-file uri action)
3219 nil)))
3220
3221 (defun dired-dnd-handle-local-file (uri action)
3222 "Copy, move or link a file to the dired directory.
3223 URI is the file to handle, ACTION is one of copy, move, link or ask.
3224 Ask means pop up a menu for the user to select one of copy, move or link."
3225 (require 'dired-aux)
3226 (let* ((from (dnd-get-local-file-name uri t))
3227 (to (if from (concat (dired-current-directory)
3228 (file-name-nondirectory from))
3229 nil)))
3230 (if from
3231 (cond ((or (eq action 'copy)
3232 (eq action 'private)) ; Treat private as copy.
3233
3234 ;; If copying a directory and dired-recursive-copies is nil,
3235 ;; dired-copy-file silently fails. Pop up a notice.
3236 (if (and (file-directory-p from)
3237 (not dired-recursive-copies))
3238 (dired-dnd-popup-notice)
3239 (progn
3240 (dired-copy-file from to 1)
3241 (dired-relist-entry to)
3242 action)))
3243
3244 ((eq action 'move)
3245 (dired-rename-file from to 1)
3246 (dired-relist-entry to)
3247 action)
3248
3249 ((eq action 'link)
3250 (make-symbolic-link from to 1)
3251 (dired-relist-entry to)
3252 action)
3253
3254 ((eq action 'ask)
3255 (dired-dnd-do-ask-action uri))
3256
3257 (t nil)))))
3258
3259 (defun dired-dnd-handle-file (uri action)
3260 "Copy, move or link a file to the dired directory if it is a local file.
3261 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3262 ACTION is one of copy, move, link or ask.
3263 Ask means pop up a menu for the user to select one of copy, move or link."
3264 (let ((local-file (dnd-get-local-file-uri uri)))
3265 (if local-file (dired-dnd-handle-local-file local-file action)
3266 nil)))
3267 \f
3268
3269 ;;;; Desktop support
3270
3271 (eval-when-compile (require 'desktop))
3272
3273 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3274 "Auxiliary information to be saved in desktop file."
3275 (cons
3276 ;; Value of `dired-directory'.
3277 (if (consp dired-directory)
3278 ;; Directory name followed by list of files.
3279 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3280 (cdr dired-directory))
3281 ;; Directory name, optionally with shell wildcard.
3282 (desktop-file-name dired-directory desktop-dirname))
3283 ;; Subdirectories in `dired-subdir-alist'.
3284 (cdr
3285 (nreverse
3286 (mapcar
3287 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3288 dired-subdir-alist)))))
3289
3290 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3291 desktop-buffer-name
3292 desktop-buffer-misc)
3293 "Restore a dired buffer specified in a desktop file."
3294 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3295 ;; This value is a directory name, optionally with shell wildcard or
3296 ;; a directory name followed by list of files.
3297 (let* ((dired-dir (car desktop-buffer-misc))
3298 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3299 (if (file-directory-p (file-name-directory dir))
3300 (progn
3301 (dired dired-dir)
3302 ;; The following elements of `desktop-buffer-misc' are the keys
3303 ;; from `dired-subdir-alist'.
3304 (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3305 (current-buffer))
3306 (message "Desktop: Directory %s no longer exists." dir)
3307 (when desktop-missing-file-warning (sit-for 1))
3308 nil)))
3309
3310 (add-to-list 'desktop-buffer-mode-handlers
3311 '(dired-mode . dired-restore-desktop-buffer))
3312
3313 \f
3314 (if (eq system-type 'vax-vms)
3315 (load "dired-vms"))
3316
3317 (provide 'dired)
3318
3319 (run-hooks 'dired-load-hook) ; for your customizations
3320
3321 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3322 ;;; dired.el ends here