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