1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 2000, 01, 03, 2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
10 ;; This file is part of GNU Emacs.
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)
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; This is a major mode for directory browsing and editing. It is
30 ;; documented in the Emacs manual.
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.
38 ;;; Customizable variables
42 :link
'(custom-manual "(emacs)Dired")
45 (defgroup dired-mark nil
46 "Handling marks in Dired."
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."
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.")
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.
72 (defvar dired-chown-program
73 (if (memq system-type
'(hpux dgux usg-unix-v irix linux gnu
/linux cygwin
))
75 (if (file-exists-p "/usr/sbin/chown")
78 "Name of chown command (usually `chown' or `/etc/chown').")
80 (defvar dired-use-ls-dired
(not (not (string-match "gnu" system-configuration
)))
81 "Non-nil means Dired should use `ls --dired'.")
83 (defvar dired-chmod-program
"chmod"
84 "Name of chmod command (usually `chmod').")
86 (defvar dired-touch-program
"touch"
87 "Name of touch command (usually `touch').")
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).
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.
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."
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
)
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"))
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"))
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"))
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"))
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.
160 The target is used in the prompt for file copy, rename etc."
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.)"
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
)
178 (defcustom dired-load-hook nil
179 "Run after loading dired.
180 You can customize key bindings or load extensions with this."
184 (defcustom dired-mode-hook nil
185 "Run at the very end of dired-mode."
189 (defcustom dired-before-readin-hook nil
190 "This hook is run before a dired buffer is read in (created or reverted)."
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."
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.
203 ;; Fixme: This should use mailcap.
204 (defcustom dired-view-command-alist
205 '(("[.]\\(ps\\|ps_pages\\|eps\\)\\'" .
"gv -spartan -color -watch %s")
206 ("[.]pdf\\'" .
"xpdf %s")
207 ("[.]\\(jpe?g\\|gif\\|png\\)\\'" .
"eog %s")
208 ("[.]dvi\\'" .
"xdvi -sidemargin 0.5 -topmargin 1 %s"))
209 "Alist specifying how to view special types of files.
210 Each element has the form (REGEXP . SHELL-COMMAND).
211 When the file name matches REGEXP, `dired-view-file'
212 invokes SHELL-COMMAND to view the file, processing it through `format'.
213 Use `%s' in SHELL-COMMAND to specify where to put the file name."
215 :type
'(alist :key-type regexp
:value-type string
)
218 ;; Internal variables
220 (defvar dired-marker-char ?
* ; the answer is 42
221 ;; so that you can write things like
222 ;; (let ((dired-marker-char ?X))
223 ;; ;; great code using X markers ...
225 ;; For example, commands operating on two sets of files, A and B.
226 ;; Or marking files with digits 0-9. This could implicate
227 ;; concentric sets or an order for the marked files.
228 ;; The code depends on dynamic scoping on the marker char.
229 "In Dired, the current mark character.
230 This is what the `do' commands look for and what the `mark' commands store.")
232 (defvar dired-del-marker ?D
233 "Character used to flag files for deletion.")
235 (defvar dired-shrink-to-fit
237 ;; I see no reason ever to make this nil -- rms.
238 ;; (> baud-rate search-slow-speed)
239 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
241 (defvar dired-flagging-regexp nil
);; Last regexp used to flag files.
243 (defvar dired-file-version-alist
)
246 (defvar dired-directory nil
247 "The directory name or wildcard spec that this Dired directory lists.
248 Local to each dired buffer. May be a list, in which case the car is the
249 directory name and the cdr is the list of files to mention.
250 The directory name must be absolute, but need not be fully expanded.")
252 (defvar dired-actual-switches nil
253 "The value of `dired-listing-switches' used to make this buffer's text.")
255 (defvar dired-re-inode-size
"[0-9 \t]*"
256 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
258 ;; These regexps must be tested at beginning-of-line, but are also
259 ;; used to search for next matches, so neither omitting "^" nor
260 ;; replacing "^" by "\n" (to make it slightly faster) will work.
262 (defvar dired-re-mark
"^[^ \n]")
263 ;; "Regexp matching a marked line.
264 ;; Important: the match ends just after the marker."
265 (defvar dired-re-maybe-mark
"^. ")
266 ;; The [^:] part after "d" and "l" is to avoid confusion with the
267 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
268 (defvar dired-re-dir
(concat dired-re-maybe-mark dired-re-inode-size
"d[^:]"))
269 (defvar dired-re-sym
(concat dired-re-maybe-mark dired-re-inode-size
"l[^:]"))
270 (defvar dired-re-exe
;; match ls permission string of an executable file
273 (concat dired-re-maybe-mark dired-re-inode-size x
)))
274 '("-[-r][-w][xs][-r][-w].[-r][-w]."
275 "-[-r][-w].[-r][-w][xs][-r][-w]."
276 "-[-r][-w].[-r][-w].[-r][-w][xst]")
278 (defvar dired-re-perms
"[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
279 (defvar dired-re-dot
"^.* \\.\\.?/?$")
281 ;; The subdirectory names in the next two lists are expanded.
282 (defvar dired-subdir-alist nil
283 "Association list of subdirectories and their buffer positions.
284 Each subdirectory has an element: (DIRNAME . STARTMARKER).
285 The order of elements is the reverse of the order in the buffer.
286 In simple cases, this list contains one element.")
288 (defvar dired-switches-alist nil
289 "Keeps track of which switches to use for inserted subdirectories.
290 This is an alist of the form (SUBDIR . SWITCHES).")
291 (make-variable-buffer-local 'dired-switches-alist
)
293 (defvar dired-subdir-regexp
"^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
294 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
295 Subexpression 1 is the subdirectory proper, no trailing colon.
296 The match starts at the beginning of the line and ends after the end
297 of the line (\\n or \\r).
298 Subexpression 2 must end right before the \\n or \\r.")
300 (defgroup dired-faces nil
301 "Faces used by dired."
305 (defface dired-header
306 '((t (:inherit font-lock-type-face
)))
307 "Face used for directory headers."
310 (defvar dired-header-face
'dired-header
311 "Face name used for directory headers.")
314 '((t (:inherit font-lock-constant-face
)))
315 "Face used for dired marks."
318 (defvar dired-mark-face
'dired-mark
319 "Face name used for dired marks.")
321 (defface dired-marked
322 '((t (:inherit font-lock-warning-face
)))
323 "Face used for marked files."
326 (defvar dired-marked-face
'dired-marked
327 "Face name used for marked files.")
329 (defface dired-flagged
330 '((t (:inherit font-lock-warning-face
)))
331 "Face used for flagged files."
334 (defvar dired-flagged-face
'dired-flagged
335 "Face name used for flagged files.")
337 (defface dired-warning
338 '((t (:inherit font-lock-comment-face
)))
339 "Face used to highlight a part of a buffer that needs user attention."
342 (defvar dired-warning-face
'dired-warning
343 "Face name used for a part of a buffer that needs user attention.")
345 (defface dired-directory
346 '((t (:inherit font-lock-function-name-face
)))
347 "Face used for subdirectories."
350 (defvar dired-directory-face
'dired-directory
351 "Face name used for subdirectories.")
353 (defface dired-symlink
354 '((t (:inherit font-lock-keyword-face
)))
355 "Face used for symbolic links."
358 (defvar dired-symlink-face
'dired-symlink
359 "Face name used for symbolic links.")
361 (defface dired-ignored
362 '((t (:inherit font-lock-string-face
)))
363 "Face used for files suffixed with `completion-ignored-extensions'."
366 (defvar dired-ignored-face
'dired-ignored
367 "Face name used for files suffixed with `completion-ignored-extensions'.")
369 (defvar dired-font-lock-keywords
372 ;; Directory headers.
373 (list dired-subdir-regexp
'(1 dired-header-face
))
376 (list dired-re-mark
'(0 dired-mark-face
))
378 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
379 ;; file name itself. We search for Dired defined regexps, and then use the
380 ;; Dired defined function `dired-move-to-filename' before searching for the
381 ;; simple regexp ".+". It is that regexp which matches the file name.
384 (list (concat "^[" (char-to-string dired-marker-char
) "]")
385 '(".+" (dired-move-to-filename) nil
(0 dired-marked-face
)))
388 (list (concat "^[" (char-to-string dired-del-marker
) "]")
389 '(".+" (dired-move-to-filename) nil
(0 dired-flagged-face
)))
390 ;; People who are paranoid about security would consider this more
391 ;; important than other things such as whether it is a directory.
392 ;; But we don't want to encourage paranoia, so our default
393 ;; should be what's most useful for non-paranoids. -- rms.
395 ;;; ;; Files that are group or world writable.
396 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
397 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
398 ;;; '(1 dired-warning-face)
399 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
400 ;; However, we don't need to highlight the file name, only the
401 ;; permissions, to win generally. -- fx.
402 ;; Fixme: we could also put text properties on the permission
403 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
404 (list (concat dired-re-maybe-mark dired-re-inode-size
405 "[-d]....\\(w\\)....") ; group writable
406 '(1 dired-warning-face
))
407 (list (concat dired-re-maybe-mark dired-re-inode-size
408 "[-d].......\\(w\\).") ; world writable
409 '(1 dired-warning-face
))
413 '(".+" (dired-move-to-filename) nil
(0 dired-directory-face
)))
417 '(".+" (dired-move-to-filename) nil
(0 dired-symlink-face
)))
419 ;; Files suffixed with `completion-ignored-extensions'.
421 ;; It is quicker to first find just an extension, then go back to the
422 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
423 (list (concat "\\(" (regexp-opt completion-ignored-extensions
) "\\|#\\)$")
424 '(".+" (dired-move-to-filename) nil
(0 dired-ignored-face
)))))
425 "Additional expressions to highlight in Dired mode.")
427 ;;; Macros must be defined before they are used, for the byte compiler.
429 (defmacro dired-mark-if
(predicate msg
)
430 "Mark all files for which PREDICATE evals to non-nil.
431 PREDICATE is evaluated on each line, with point at beginning of line.
432 MSG is a noun phrase for the type of files being marked.
433 It should end with a noun that can be pluralized by adding `s'.
434 Return value is the number of files marked, or nil if none were marked."
435 `(let (buffer-read-only count
)
438 (if ,msg
(message "Marking %ss..." ,msg
))
439 (goto-char (point-min))
444 (insert dired-marker-char
)
445 (setq count
(1+ count
))))
447 (if ,msg
(message "%s %s%s %s%s."
450 (dired-plural-s count
)
451 (if (eq dired-marker-char ?
\040) "un" "")
452 (if (eq dired-marker-char dired-del-marker
)
453 "flagged" "marked"))))
454 (and (> count
0) count
)))
456 (defmacro dired-map-over-marks
(body arg
&optional show-progress
)
457 "Eval BODY with point on each marked line. Return a list of BODY's results.
458 If no marked file could be found, execute BODY on the current line.
459 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
460 files instead of the marked files.
461 In that case point is dragged along. This is so that commands on
462 the next ARG (instead of the marked) files can be chained easily.
463 If ARG is otherwise non-nil, use current file instead.
464 If optional third arg SHOW-PROGRESS evaluates to non-nil,
465 redisplay the dired buffer after each file is processed.
466 No guarantee is made about the position on the marked line.
467 BODY must ensure this itself if it depends on this.
468 Search starts at the beginning of the buffer, thus the car of the list
469 corresponds to the line nearest to the buffer's bottom. This
470 is also true for (positive and negative) integer values of ARG.
471 BODY should not be too long as it is expanded four times."
473 ;;Warning: BODY must not add new lines before point - this may cause an
475 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
477 (let (buffer-read-only case-fold-search found results
)
480 (progn ;; no save-excursion, want to move point.
481 (dired-repeat-over-lines
484 (if ,show-progress
(sit-for 0))
485 (setq results
(cons ,body results
)))))
489 ;; non-nil, non-integer ARG means use current file:
491 (let ((regexp (dired-marker-regexp)) next-position
)
493 (goto-char (point-min))
494 ;; remember position of next marked file before BODY
495 ;; can insert lines before the just found file,
496 ;; confusing us by finding the same marked file again
498 (setq next-position
(and (re-search-forward regexp nil t
)
500 found
(not (null next-position
)))
502 (goto-char next-position
)
503 (if ,show-progress
(sit-for 0))
504 (setq results
(cons ,body results
))
505 ;; move after last match
506 (goto-char next-position
)
508 (set-marker next-position nil
)
509 (setq next-position
(and (re-search-forward regexp nil t
)
514 ;; save-excursion loses, again
515 (dired-move-to-filename)))
517 (defun dired-get-marked-files (&optional localp arg filter
)
518 "Return the marked files' names as list of strings.
519 The list is in the same order as the buffer, that is, the car is the
521 Values returned are normally absolute file names.
522 Optional arg LOCALP as in `dired-get-filename'.
523 Optional second argument ARG specifies files near point
524 instead of marked files. If ARG is an integer, use the next ARG files.
525 If ARG is otherwise non-nil, use file. Usually ARG comes from
526 the command's prefix arg.
527 Optional third argument FILTER, if non-nil, is a function to select
528 some of the files--those for which (funcall FILTER FILENAME) is non-nil."
531 (dired-map-over-marks (dired-get-filename localp
) arg
)))
534 (nreverse all-of-them
)
535 (dolist (file all-of-them
)
536 (if (funcall filter file
)
542 (defun dired-read-dir-and-switches (str)
543 ;; For use in interactive.
545 (if current-prefix-arg
546 (read-string "Dired listing switches: "
547 dired-listing-switches
))
548 (read-file-name (format "Dired %s(directory): " str
)
549 nil default-directory nil
))))
551 ;;;###autoload (define-key ctl-x-map "d" 'dired)
553 (defun dired (dirname &optional switches
)
554 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
555 Optional second argument SWITCHES specifies the `ls' options used.
556 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
557 Dired displays a list of files in DIRNAME (which may also have
558 shell wildcards appended to select certain files). If DIRNAME is a cons,
559 its first element is taken as the directory name and the rest as an explicit
560 list of files to make directory entries for.
562 You can move around in it with the usual commands.
563 You can flag files for deletion with \\[dired-flag-file-deletion] and then
564 delete them by typing \\[dired-do-flagged-delete].
565 Type \\[describe-mode] after entering dired for more info.
567 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
568 ;; Cannot use (interactive "D") because of wildcards.
569 (interactive (dired-read-dir-and-switches ""))
570 (switch-to-buffer (dired-noselect dirname switches
)))
572 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
574 (defun dired-other-window (dirname &optional switches
)
575 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
576 (interactive (dired-read-dir-and-switches "in other window "))
577 (switch-to-buffer-other-window (dired-noselect dirname switches
)))
579 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
581 (defun dired-other-frame (dirname &optional switches
)
582 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
583 (interactive (dired-read-dir-and-switches "in other frame "))
584 (switch-to-buffer-other-frame (dired-noselect dirname switches
)))
587 (defun dired-noselect (dir-or-list &optional switches
)
588 "Like `dired' but returns the dired buffer as value, does not select it."
589 (or dir-or-list
(setq dir-or-list default-directory
))
590 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
592 (let (dirname initially-was-dirname
)
593 (if (consp dir-or-list
)
594 (setq dirname
(car dir-or-list
))
595 (setq dirname dir-or-list
))
596 (setq initially-was-dirname
597 (string= (file-name-as-directory dirname
) dirname
))
598 (setq dirname
(abbreviate-file-name
599 (expand-file-name (directory-file-name dirname
))))
600 (if find-file-visit-truename
601 (setq dirname
(file-truename dirname
)))
602 ;; If the argument was syntactically a directory name not a file name,
603 ;; or if it happens to name a file that is a directory,
604 ;; convert it syntactically to a directory name.
605 ;; The reason for checking initially-was-dirname
606 ;; and not just file-directory-p
607 ;; is that file-directory-p is slow over ftp.
608 (if (or initially-was-dirname
(file-directory-p dirname
))
609 (setq dirname
(file-name-as-directory dirname
)))
610 (if (consp dir-or-list
)
611 (setq dir-or-list
(cons dirname
(cdr dir-or-list
)))
612 (setq dir-or-list dirname
))
613 (dired-internal-noselect dir-or-list switches
)))
615 ;; The following is an internal dired function. It returns non-nil if
616 ;; the directory visited by the current dired buffer has changed on
617 ;; disk. DIRNAME should be the directory name of that directory.
618 (defun dired-directory-changed-p (dirname)
619 (not (let ((attributes (file-attributes dirname
))
620 (modtime (visited-file-modtime)))
622 (not (eq (car attributes
) t
))
623 (and (= (car (nth 5 attributes
)) (car modtime
))
624 (= (nth 1 (nth 5 attributes
)) (cdr modtime
)))))))
626 (defun dired-buffer-stale-p (&optional noconfirm
)
627 "Return non-nil if current dired buffer needs updating.
628 If NOCONFIRM is non-nil, then this function always returns nil
629 for a remote directory. This feature is used by Auto Revert Mode."
631 (if (consp dired-directory
) (car dired-directory
) dired-directory
)))
632 (and (stringp dirname
)
633 (not (when noconfirm
(file-remote-p dirname
)))
634 (file-readable-p dirname
)
635 (dired-directory-changed-p dirname
))))
637 ;; Separate function from dired-noselect for the sake of dired-vms.el.
638 (defun dired-internal-noselect (dir-or-list &optional switches mode
)
639 ;; If there is an existing dired buffer for DIRNAME, just leave
640 ;; buffer as it is (don't even call dired-revert).
641 ;; This saves time especially for deep trees or with ange-ftp.
642 ;; The user can type `g' easily, and it is more consistent with find-file.
643 ;; But if SWITCHES are given they are probably different from the
644 ;; buffer's old value, so call dired-sort-other, which does
645 ;; revert the buffer.
646 ;; A pity we can't possibly do "Directory has changed - refresh? "
647 ;; like find-file does.
648 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
652 ;; note that buffer already is in dired-mode, if found
654 (old-buf (current-buffer)))
655 (if (consp dir-or-list
)
656 (setq dirname
(car dir-or-list
))
657 (setq dirname dir-or-list
))
658 ;; Look for an existing buffer.
659 (setq buffer
(dired-find-buffer-nocreate dirname mode
)
660 new-buffer-p
(null buffer
))
662 (let ((default-major-mode 'fundamental-mode
))
663 ;; We don't want default-major-mode to run hooks and set auto-fill
664 ;; or whatever, now that dired-mode does not
665 ;; kill-all-local-variables any longer.
666 (setq buffer
(create-file-buffer (directory-file-name dirname
)))))
668 (if (not new-buffer-p
) ; existing buffer ...
669 (cond (switches ; ... but new switches
670 ;; file list may have changed
671 (setq dired-directory dir-or-list
)
672 ;; this calls dired-revert
673 (dired-sort-other switches
))
674 ;; If directory has changed on disk, offer to revert.
675 ((when (dired-directory-changed-p dirname
)
677 (substitute-command-keys
678 "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
680 (setq default-directory
681 ;; We can do this unconditionally
682 ;; because dired-noselect ensures that the name
683 ;; is passed in directory name syntax
684 ;; if it was the name of a directory at all.
685 (file-name-directory dirname
))
686 (or switches
(setq switches dired-listing-switches
))
687 (if mode
(funcall mode
)
688 (dired-mode dir-or-list switches
))
689 ;; default-directory and dired-actual-switches are set now
690 ;; (buffer-local), so we can call dired-readin:
693 (progn (dired-readin)
695 ;; dired-readin can fail if parent directories are inaccessible.
696 ;; Don't leave an empty buffer around in that case.
697 (if failed
(kill-buffer buffer
))))
698 (goto-char (point-min))
699 (dired-initial-position dirname
))
703 (defvar dired-buffers nil
704 ;; Enlarged by dired-advertise
705 ;; Queried by function dired-buffers-for-dir. When this detects a
706 ;; killed buffer, it is removed from this list.
707 "Alist of expanded directories and their associated dired buffers.")
709 (defun dired-find-buffer-nocreate (dirname &optional mode
)
710 ;; This differs from dired-buffers-for-dir in that it does not consider
711 ;; subdirs of default-directory and searches for the first match only.
712 ;; Also, the major mode must be MODE.
713 (setq dirname
(expand-file-name dirname
))
714 (let (found (blist dired-buffers
)) ; was (buffer-list)
715 (or mode
(setq mode
'dired-mode
))
717 (if (null (buffer-name (cdr (car blist
))))
718 (setq blist
(cdr blist
))
720 (set-buffer (cdr (car blist
)))
721 (if (and (eq major-mode mode
)
722 dired-directory
;; nil during find-alternate-file
725 (if (consp dired-directory
)
726 (car dired-directory
)
728 (setq found
(cdr (car blist
))
730 (setq blist
(cdr blist
))))))
734 ;; Read in a new dired buffer
736 (defun dired-readin ()
737 "Read in a new dired buffer.
738 Differs from dired-insert-subdir in that it accepts
739 wildcards, erases the buffer, and builds the subdir-alist anew
740 \(including making it buffer-local and clearing it first)."
742 ;; default-directory and dired-actual-switches must be buffer-local
743 ;; and initialized by now.
745 (if (consp dired-directory
)
746 (setq dirname
(car dired-directory
))
747 (setq dirname dired-directory
))
748 (setq dirname
(expand-file-name dirname
))
750 ;; This hook which may want to modify dired-actual-switches
751 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
752 ;; where ls won't understand -Al switches.
753 (run-hooks 'dired-before-readin-hook
)
754 (if (consp buffer-undo-list
)
755 (setq buffer-undo-list nil
))
756 (let (buffer-read-only
757 ;; Don't make undo entries for readin.
758 (buffer-undo-list t
))
761 (dired-readin-insert))
762 (goto-char (point-min))
763 ;; Must first make alist buffer local and set it to nil because
764 ;; dired-build-subdir-alist will call dired-clear-alist first
765 (set (make-local-variable 'dired-subdir-alist
) nil
)
766 (dired-build-subdir-alist)
767 (let ((attributes (file-attributes dirname
)))
768 (if (eq (car attributes
) t
)
769 (set-visited-file-modtime (nth 5 attributes
))))
770 (set-buffer-modified-p nil
)
771 ;; No need to narrow since the whole buffer contains just
772 ;; dired-readin's output, nothing else. The hook can
773 ;; successfully use dired functions (e.g. dired-get-filename)
774 ;; as the subdir-alist has been built in dired-readin.
775 (run-hooks 'dired-after-readin-hook
))))
777 ;; Subroutines of dired-readin
779 (defun dired-readin-insert ()
780 ;; Insert listing for the specified dir (and maybe file list)
781 ;; already in dired-directory, assuming a clean buffer.
783 (if (consp dired-directory
)
784 (setq dir
(car dired-directory
)
785 file-list
(cdr dired-directory
))
786 (setq dir dired-directory
788 (setq dir
(expand-file-name dir
))
789 (if (and (equal "" (file-name-nondirectory dir
))
791 ;; If we are reading a whole single directory...
792 (dired-insert-directory dir dired-actual-switches nil nil t
)
793 (if (not (file-readable-p
794 (directory-file-name (file-name-directory dir
))))
795 (error "Directory %s inaccessible or nonexistent" dir
)
796 ;; Else treat it as a wildcard spec
797 ;; unless we have an explicit list of files.
798 (dired-insert-directory dir dired-actual-switches
799 file-list
(not file-list
) t
)))))
801 (defun dired-insert-directory (dir switches
&optional file-list wildcard hdr
)
802 "Insert a directory listing of DIR, Dired style.
803 Use SWITCHES to make the listings.
804 If FILE-LIST is non-nil, list only those files.
805 Otherwise, if WILDCARD is non-nil, expand wildcards;
806 in that case, DIR should be a file name that uses wildcards.
807 In other cases, DIR should be a directory name or a directory filename.
808 If HDR is non-nil, insert a header line with the directory name."
809 (let ((opoint (point))
810 (process-environment (copy-sequence process-environment
))
812 (if (or dired-use-ls-dired
(file-remote-p dir
))
813 (setq switches
(concat "--dired " switches
)))
814 ;; We used to specify the C locale here, to force English month names;
815 ;; but this should not be necessary any more,
816 ;; with the new value of dired-move-to-filename-regexp.
818 (dolist (f file-list
)
819 (insert-directory f switches nil nil
))
820 (insert-directory dir switches wildcard
(not wildcard
)))
821 ;; Quote certain characters, unless ls quoted them for us.
822 (if (not (string-match "b" dired-actual-switches
))
824 (setq end
(point-marker))
826 (while (search-forward "\\" end t
)
827 (replace-match (apply #'propertize
829 (text-properties-at (match-beginning 0)))
832 (while (search-forward "\^m" end t
)
833 (replace-match (apply #'propertize
835 (text-properties-at (match-beginning 0)))
837 (set-marker end nil
)))
838 (dired-insert-set-properties opoint
(point))
839 ;; If we used --dired and it worked, the lines are already indented.
840 ;; Otherwise, indent them.
841 (unless (save-excursion
844 (let ((indent-tabs-mode nil
))
845 (indent-rigidly opoint
(point) 2)))
846 ;; Insert text at the beginning to standardize things.
849 (if (and (or hdr wildcard
) (not (looking-at "^ /.*:$")))
850 ;; Note that dired-build-subdir-alist will replace the name
851 ;; by its expansion, so it does not matter whether what we insert
852 ;; here is fully expanded, but it should be absolute.
853 (insert " " (directory-file-name (file-name-directory dir
)) ":\n"))
855 ;; Insert "wildcard" line where "total" line would be for a full dir.
856 (insert " wildcard " (file-name-nondirectory dir
) "\n")))))
858 (defun dired-insert-set-properties (beg end
)
859 "Make the file names highlight when the mouse is on them."
862 (while (< (point) end
)
864 (if (dired-move-to-filename)
868 (dired-move-to-end-of-filename)
870 '(mouse-face highlight
871 help-echo
"mouse-2: visit this file in other window")))
875 ;; Reverting a dired buffer
877 (defun dired-revert (&optional arg noconfirm
)
878 "Reread the dired buffer.
879 Must also be called after dired-actual-switches have changed.
880 Should not fail even on completely garbaged buffers.
881 Preserves old cursor, marks/flags, hidden-p."
882 (widen) ; just in case user narrowed
883 (let ((opoint (point))
884 (ofile (dired-get-filename nil t
))
885 (mark-alist nil
) ; save marked files
886 (hidden-subdirs (dired-remember-hidden))
887 (old-subdir-alist (cdr (reverse dired-subdir-alist
))) ; except pwd
888 (case-fold-search nil
) ; we check for upper case ls flags
890 (goto-char (point-min))
891 (setq mark-alist
;; only after dired-remember-hidden since this unhides:
892 (dired-remember-marks (point-min) (point-max)))
893 ;; treat top level dir extra (it may contain wildcards)
895 (if (consp dired-directory
) (car dired-directory
) dired-directory
))
897 (let ((dired-after-readin-hook nil
))
898 ;; don't run that hook for each subdir...
899 (dired-insert-old-subdirs old-subdir-alist
))
900 (dired-mark-remembered mark-alist
) ; mark files that were marked
901 ;; ... run the hook for the whole buffer, and only after markers
902 ;; have been reinserted (else omitting in dired-x would omit marked files)
903 (run-hooks 'dired-after-readin-hook
) ; no need to narrow
904 (or (and ofile
(dired-goto-file ofile
)) ; move cursor to where it
905 (goto-char opoint
)) ; was before
906 (dired-move-to-filename)
907 (save-excursion ; hide subdirs that were hidden
908 (dolist (dir hidden-subdirs
)
909 (if (dired-goto-subdir dir
)
910 (dired-hide-subdir 1)))))
911 ;; outside of the let scope
912 ;;; Might as well not override the user if the user changed this.
913 ;;; (setq buffer-read-only t)
916 ;; Subroutines of dired-revert
917 ;; Some of these are also used when inserting subdirs.
919 (defun dired-remember-marks (beg end
)
920 "Return alist of files and their marks, from BEG to END."
921 (if selective-display
; must unhide to make this work.
922 (let (buffer-read-only)
923 (subst-char-in-region beg end ?
\r ?
\n)))
927 (while (re-search-forward dired-re-mark end t
)
928 (if (setq fil
(dired-get-filename nil t
))
929 (setq chr
(preceding-char)
930 alist
(cons (cons fil chr
) alist
)))))
933 (defun dired-mark-remembered (alist)
934 "Mark all files remembered in ALIST.
935 Each element of ALIST looks like (FILE . MARKERCHAR)."
938 (setq elt
(car alist
)
942 (if (dired-goto-file fil
)
948 (defun dired-remember-hidden ()
949 "Return a list of names of subdirs currently hidden."
950 (let ((l dired-subdir-alist
) dir pos result
)
952 (setq dir
(car (car l
))
956 (skip-chars-forward "^\r\n")
957 (if (eq (following-char) ?
\r)
958 (setq result
(cons dir result
))))
961 (defun dired-insert-old-subdirs (old-subdir-alist)
962 "Try to insert all subdirs that were displayed before.
963 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
964 (or (string-match "R" dired-actual-switches
)
966 (while old-subdir-alist
967 (setq elt
(car old-subdir-alist
)
968 old-subdir-alist
(cdr old-subdir-alist
)
973 (dired-insert-subdir dir
)
974 (let ((switches (cdr (assoc-string dir dired-switches-alist
))))
976 (string-match "R" switches
)
977 (dolist (cur-ass (copy-sequence old-subdir-alist
))
978 (when (dired-in-this-tree (car cur-ass
) dir
)
979 (setq old-subdir-alist
980 (delete cur-ass old-subdir-alist
)))))))
983 (defun dired-uncache (dir)
984 "Remove directory DIR from any directory cache."
985 (let ((handler (find-file-name-handler dir
'dired-uncache
)))
987 (funcall handler
'dired-uncache dir
))))
989 ;; dired mode key bindings and initialization
991 (defvar dired-mode-map
992 ;; This looks ugly when substitute-command-keys uses C-d instead d:
993 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
994 (let ((map (make-keymap)))
995 (suppress-keymap map
)
996 (define-key map
[mouse-2
] 'dired-mouse-find-file-other-window
)
997 ;; Commands to mark or flag certain categories of files
998 (define-key map
"#" 'dired-flag-auto-save-files
)
999 (define-key map
"." 'dired-clean-directory
)
1000 (define-key map
"~" 'dired-flag-backup-files
)
1001 (define-key map
"&" 'dired-flag-garbage-files
)
1002 ;; Upper case keys (except !) for operating on the marked files
1003 (define-key map
"A" 'dired-do-search
)
1004 (define-key map
"C" 'dired-do-copy
)
1005 (define-key map
"B" 'dired-do-byte-compile
)
1006 (define-key map
"D" 'dired-do-delete
)
1007 (define-key map
"G" 'dired-do-chgrp
)
1008 (define-key map
"H" 'dired-do-hardlink
)
1009 (define-key map
"L" 'dired-do-load
)
1010 (define-key map
"M" 'dired-do-chmod
)
1011 (define-key map
"O" 'dired-do-chown
)
1012 (define-key map
"P" 'dired-do-print
)
1013 (define-key map
"Q" 'dired-do-query-replace-regexp
)
1014 (define-key map
"R" 'dired-do-rename
)
1015 (define-key map
"S" 'dired-do-symlink
)
1016 (define-key map
"T" 'dired-do-touch
)
1017 (define-key map
"X" 'dired-do-shell-command
)
1018 (define-key map
"Z" 'dired-do-compress
)
1019 (define-key map
"!" 'dired-do-shell-command
)
1020 ;; Comparison commands
1021 (define-key map
"=" 'dired-diff
)
1022 (define-key map
"\M-=" 'dired-backup-diff
)
1023 ;; Tree Dired commands
1024 (define-key map
"\M-\C-?" 'dired-unmark-all-files
)
1025 (define-key map
"\M-\C-d" 'dired-tree-down
)
1026 (define-key map
"\M-\C-u" 'dired-tree-up
)
1027 (define-key map
"\M-\C-n" 'dired-next-subdir
)
1028 (define-key map
"\M-\C-p" 'dired-prev-subdir
)
1029 ;; move to marked files
1030 (define-key map
"\M-{" 'dired-prev-marked-file
)
1031 (define-key map
"\M-}" 'dired-next-marked-file
)
1032 ;; Make all regexp commands share a `%' prefix:
1033 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1034 ;; but that seems to serve little purpose, and copy-keymap
1035 ;; does a better job without it.
1036 (define-key map
"%" nil
)
1037 (define-key map
"%u" 'dired-upcase
)
1038 (define-key map
"%l" 'dired-downcase
)
1039 (define-key map
"%d" 'dired-flag-files-regexp
)
1040 (define-key map
"%g" 'dired-mark-files-containing-regexp
)
1041 (define-key map
"%m" 'dired-mark-files-regexp
)
1042 (define-key map
"%r" 'dired-do-rename-regexp
)
1043 (define-key map
"%C" 'dired-do-copy-regexp
)
1044 (define-key map
"%H" 'dired-do-hardlink-regexp
)
1045 (define-key map
"%R" 'dired-do-rename-regexp
)
1046 (define-key map
"%S" 'dired-do-symlink-regexp
)
1047 ;; Commands for marking and unmarking.
1048 (define-key map
"*" nil
)
1049 (define-key map
"**" 'dired-mark-executables
)
1050 (define-key map
"*/" 'dired-mark-directories
)
1051 (define-key map
"*@" 'dired-mark-symlinks
)
1052 (define-key map
"*%" 'dired-mark-files-regexp
)
1053 (define-key map
"*c" 'dired-change-marks
)
1054 (define-key map
"*s" 'dired-mark-subdir-files
)
1055 (define-key map
"*m" 'dired-mark
)
1056 (define-key map
"*u" 'dired-unmark
)
1057 (define-key map
"*?" 'dired-unmark-all-files
)
1058 (define-key map
"*!" 'dired-unmark-all-marks
)
1059 (define-key map
"U" 'dired-unmark-all-marks
)
1060 (define-key map
"*\177" 'dired-unmark-backward
)
1061 (define-key map
"*\C-n" 'dired-next-marked-file
)
1062 (define-key map
"*\C-p" 'dired-prev-marked-file
)
1063 (define-key map
"*t" 'dired-toggle-marks
)
1064 ;; Lower keys for commands not operating on all the marked files
1065 (define-key map
"a" 'dired-find-alternate-file
)
1066 (define-key map
"d" 'dired-flag-file-deletion
)
1067 (define-key map
"e" 'dired-find-file
)
1068 (define-key map
"f" 'dired-find-file
)
1069 (define-key map
"\C-m" 'dired-advertised-find-file
)
1070 (define-key map
"g" 'revert-buffer
)
1071 (define-key map
"\M-g" 'dired-goto-file
)
1072 (define-key map
"h" 'describe-mode
)
1073 (define-key map
"i" 'dired-maybe-insert-subdir
)
1074 (define-key map
"k" 'dired-do-kill-lines
)
1075 (define-key map
"l" 'dired-do-redisplay
)
1076 (define-key map
"m" 'dired-mark
)
1077 (define-key map
"n" 'dired-next-line
)
1078 (define-key map
"o" 'dired-find-file-other-window
)
1079 (define-key map
"\C-o" 'dired-display-file
)
1080 (define-key map
"p" 'dired-previous-line
)
1081 (define-key map
"q" 'quit-window
)
1082 (define-key map
"s" 'dired-sort-toggle-or-edit
)
1083 (define-key map
"t" 'dired-toggle-marks
)
1084 (define-key map
"u" 'dired-unmark
)
1085 (define-key map
"v" 'dired-view-file
)
1086 (define-key map
"w" 'dired-copy-filename-as-kill
)
1087 (define-key map
"x" 'dired-do-flagged-delete
)
1088 (define-key map
"y" 'dired-show-file-type
)
1089 (define-key map
"+" 'dired-create-directory
)
1091 (define-key map
"<" 'dired-prev-dirline
)
1092 (define-key map
">" 'dired-next-dirline
)
1093 (define-key map
"^" 'dired-up-directory
)
1094 (define-key map
" " 'dired-next-line
)
1095 (define-key map
"\C-n" 'dired-next-line
)
1096 (define-key map
"\C-p" 'dired-previous-line
)
1097 (define-key map
[down] 'dired-next-line)
1098 (define-key map [up] 'dired-previous-line)
1100 (define-key map "$" 'dired-hide-subdir)
1101 (define-key map "\M-$" 'dired-hide-all)
1103 (define-key map "?" 'dired-summary)
1104 (define-key map "\177" 'dired-unmark-backward)
1105 (define-key map "\C-_" 'dired-undo)
1106 (define-key map "\C-xu" 'dired-undo)
1108 ;; Make menu bar items.
1110 ;; No need to fo this, now that top-level items are fewer.
1112 ;; Get rid of the Edit menu bar item to save space.
1113 ;(define-key map [menu-bar edit] 'undefined)
1115 (define-key map [menu-bar subdir]
1116 (cons "Subdir" (make-sparse-keymap "Subdir")))
1118 (define-key map [menu-bar subdir hide-all]
1119 '(menu-item "Hide All" dired-hide-all
1120 :help "Hide all subdirectories, leave only header lines"))
1121 (define-key map [menu-bar subdir hide-subdir]
1122 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1123 :help "Hide or unhide current directory listing"))
1124 (define-key map [menu-bar subdir tree-down]
1125 '(menu-item "Tree Down" dired-tree-down
1126 :help "Go to first subdirectory header down the tree"))
1127 (define-key map [menu-bar subdir tree-up]
1128 '(menu-item "Tree Up" dired-tree-up
1129 :help "Go to first subdirectory header up the tree"))
1130 (define-key map [menu-bar subdir up]
1131 '(menu-item "Up Directory" dired-up-directory
1132 :help "Edit the parent directory"))
1133 (define-key map [menu-bar subdir prev-subdir]
1134 '(menu-item "Prev Subdir" dired-prev-subdir
1135 :help "Go to previous subdirectory header line"))
1136 (define-key map [menu-bar subdir next-subdir]
1137 '(menu-item "Next Subdir" dired-next-subdir
1138 :help "Go to next subdirectory header line"))
1139 (define-key map [menu-bar subdir prev-dirline]
1140 '(menu-item "Prev Dirline" dired-prev-dirline
1141 :help "Move to next directory-file line"))
1142 (define-key map [menu-bar subdir next-dirline]
1143 '(menu-item "Next Dirline" dired-next-dirline
1144 :help "Move to previous directory-file line"))
1145 (define-key map [menu-bar subdir insert]
1146 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1147 :help "Insert contents of subdirectory"))
1149 (define-key map [menu-bar immediate]
1150 (cons "Immediate" (make-sparse-keymap "Immediate")))
1152 (define-key map [menu-bar immediate revert-buffer]
1153 '(menu-item "Refresh" revert-buffer
1154 :help "Update contents of shown directories"))
1156 (define-key map [menu-bar immediate dashes]
1159 (define-key map [menu-bar immediate backup-diff]
1160 '(menu-item "Compare with Backup" dired-backup-diff
1161 :help "Diff file at cursor with its latest backup"))
1162 (define-key map [menu-bar immediate diff]
1163 '(menu-item "Diff..." dired-diff
1164 :help "Compare file at cursor with another file"))
1165 (define-key map [menu-bar immediate view]
1166 '(menu-item "View This File" dired-view-file
1167 :help "Examine file at cursor in read-only mode"))
1168 (define-key map [menu-bar immediate display]
1169 '(menu-item "Display in Other Window" dired-display-file
1170 :help "Display file at cursor in other window"))
1171 (define-key map [menu-bar immediate find-file-other-window]
1172 '(menu-item "Find in Other Window" dired-find-file-other-window
1173 :help "Edit file at cursor in other window"))
1174 (define-key map [menu-bar immediate find-file]
1175 '(menu-item "Find This File" dired-find-file
1176 :help "Edit file at cursor"))
1177 (define-key map [menu-bar immediate create-directory]
1178 '(menu-item "Create Directory..." dired-create-directory))
1179 (define-key map [menu-bar immediate wdired-mode]
1180 '(menu-item "Edit File Names" wdired-change-to-wdired-mode))
1182 (define-key map [menu-bar regexp]
1183 (cons "Regexp" (make-sparse-keymap "Regexp")))
1185 (define-key map [menu-bar regexp downcase]
1186 '(menu-item "Downcase" dired-downcase
1187 ;; When running on plain MS-DOS, there's only one
1188 ;; letter-case for file names.
1189 :enable (or (not (fboundp 'msdos-long-file-names))
1190 (msdos-long-file-names))
1191 :help "Rename marked files to lower-case name"))
1192 (define-key map [menu-bar regexp upcase]
1193 '(menu-item "Upcase" dired-upcase
1194 :enable (or (not (fboundp 'msdos-long-file-names))
1195 (msdos-long-file-names))
1196 :help "Rename marked files to upper-case name"))
1197 (define-key map [menu-bar regexp hardlink]
1198 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1199 :help "Make hard links for files matching regexp"))
1200 (define-key map [menu-bar regexp symlink]
1201 '(menu-item "Symlink..." dired-do-symlink-regexp
1202 :visible (fboundp 'make-symbolic-link)
1203 :help "Make symbolic links for files matching regexp"))
1204 (define-key map [menu-bar regexp rename]
1205 '(menu-item "Rename..." dired-do-rename-regexp
1206 :help "Rename marked files matching regexp"))
1207 (define-key map [menu-bar regexp copy]
1208 '(menu-item "Copy..." dired-do-copy-regexp
1209 :help "Copy marked files matching regexp"))
1210 (define-key map [menu-bar regexp flag]
1211 '(menu-item "Flag..." dired-flag-files-regexp
1212 :help "Flag files matching regexp for deletion"))
1213 (define-key map [menu-bar regexp mark]
1214 '(menu-item "Mark..." dired-mark-files-regexp
1215 :help "Mark files matching regexp for future operations"))
1216 (define-key map [menu-bar regexp mark-cont]
1217 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1218 :help "Mark files whose contents matches regexp"))
1220 (define-key map [menu-bar mark]
1221 (cons "Mark" (make-sparse-keymap "Mark")))
1223 (define-key map [menu-bar mark prev]
1224 '(menu-item "Previous Marked" dired-prev-marked-file
1225 :help "Move to previous marked file"))
1226 (define-key map [menu-bar mark next]
1227 '(menu-item "Next Marked" dired-next-marked-file
1228 :help "Move to next marked file"))
1229 (define-key map [menu-bar mark marks]
1230 '(menu-item "Change Marks..." dired-change-marks
1231 :help "Replace marker with another character"))
1232 (define-key map [menu-bar mark unmark-all]
1233 '(menu-item "Unmark All" dired-unmark-all-marks))
1234 (define-key map [menu-bar mark symlinks]
1235 '(menu-item "Mark Symlinks" dired-mark-symlinks
1236 :visible (fboundp 'make-symbolic-link)
1237 :help "Mark all symbolic links"))
1238 (define-key map [menu-bar mark directories]
1239 '(menu-item "Mark Directories" dired-mark-directories
1240 :help "Mark all directories except `.' and `..'"))
1241 (define-key map [menu-bar mark directory]
1242 '(menu-item "Mark Old Backups" dired-clean-directory
1243 :help "Flag old numbered backups for deletion"))
1244 (define-key map [menu-bar mark executables]
1245 '(menu-item "Mark Executables" dired-mark-executables
1246 :help "Mark all executable files"))
1247 (define-key map [menu-bar mark garbage-files]
1248 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1249 :help "Flag unneeded files for deletion"))
1250 (define-key map [menu-bar mark backup-files]
1251 '(menu-item "Flag Backup Files" dired-flag-backup-files
1252 :help "Flag all backup files for deletion"))
1253 (define-key map [menu-bar mark auto-save-files]
1254 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1255 :help "Flag auto-save files for deletion"))
1256 (define-key map [menu-bar mark deletion]
1257 '(menu-item "Flag" dired-flag-file-deletion
1258 :help "Flag current line's file for deletion"))
1259 (define-key map [menu-bar mark unmark]
1260 '(menu-item "Unmark" dired-unmark
1261 :help "Unmark or unflag current line's file"))
1262 (define-key map [menu-bar mark mark]
1263 '(menu-item "Mark" dired-mark
1264 :help "Mark current line's file for future operations"))
1265 (define-key map [menu-bar mark toggle-marks]
1266 '(menu-item "Toggle Marks" dired-toggle-marks
1267 :help "Mark unmarked files, unmark marked ones"))
1269 (define-key map [menu-bar operate]
1270 (cons "Operate" (make-sparse-keymap "Operate")))
1272 (define-key map [menu-bar operate query-replace]
1273 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1274 :help "Replace regexp in marked files"))
1275 (define-key map [menu-bar operate search]
1276 '(menu-item "Search Files..." dired-do-search
1277 :help "Search marked files for regexp"))
1278 (define-key map [menu-bar operate chown]
1279 '(menu-item "Change Owner..." dired-do-chown
1280 :visible (not (memq system-type '(ms-dos windows-nt)))
1281 :help "Change the owner of marked files"))
1282 (define-key map [menu-bar operate chgrp]
1283 '(menu-item "Change Group..." dired-do-chgrp
1284 :visible (not (memq system-type '(ms-dos windows-nt)))
1285 :help "Change the group of marked files"))
1286 (define-key map [menu-bar operate chmod]
1287 '(menu-item "Change Mode..." dired-do-chmod
1288 :help "Change mode (attributes) of marked files"))
1289 (define-key map [menu-bar operate touch]
1290 '(menu-item "Change Timestamp..." dired-do-touch
1291 :help "Change timestamp of marked files"))
1292 (define-key map [menu-bar operate load]
1293 '(menu-item "Load" dired-do-load
1294 :help "Load marked Emacs Lisp files"))
1295 (define-key map [menu-bar operate compile]
1296 '(menu-item "Byte-compile" dired-do-byte-compile
1297 :help "Byte-compile marked Emacs Lisp files"))
1298 (define-key map [menu-bar operate compress]
1299 '(menu-item "Compress" dired-do-compress
1300 :help "Compress/uncompress marked files"))
1301 (define-key map [menu-bar operate print]
1302 '(menu-item "Print..." dired-do-print
1303 :help "Ask for print command and print marked files"))
1304 (define-key map [menu-bar operate hardlink]
1305 '(menu-item "Hardlink to..." dired-do-hardlink
1306 :help "Make hard links for current or marked files"))
1307 (define-key map [menu-bar operate symlink]
1308 '(menu-item "Symlink to..." dired-do-symlink
1309 :visible (fboundp 'make-symbolic-link)
1310 :help "Make symbolic links for current or marked files"))
1311 (define-key map [menu-bar operate command]
1312 '(menu-item "Shell Command..." dired-do-shell-command
1313 :help "Run a shell command on each of marked files"))
1314 (define-key map [menu-bar operate delete]
1315 '(menu-item "Delete" dired-do-delete
1316 :help "Delete current file or all marked files"))
1317 (define-key map [menu-bar operate rename]
1318 '(menu-item "Rename to..." dired-do-rename
1319 :help "Rename current file or move marked files"))
1320 (define-key map [menu-bar operate copy]
1321 '(menu-item "Copy to..." dired-do-copy
1322 :help "Copy current file or all marked files"))
1325 "Local keymap for `dired-mode' buffers.")
1327 ;; Dired mode is suitable only for specially formatted data.
1328 (put 'dired-mode 'mode-class 'special)
1330 (defun dired-mode (&optional dirname switches)
1332 Mode for \"editing\" directory listings.
1333 In Dired, you are \"editing\" a list of the files in a directory and
1334 \(optionally) its subdirectories, in the format of `ls -lR'.
1335 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1336 \"Editing\" means that you can run shell commands on files, visit,
1337 compress, load or byte-compile them, change their file attributes
1338 and insert subdirectories into the same buffer. You can \"mark\"
1339 files for later commands or \"flag\" them for deletion, either file
1340 by file or all files matching certain criteria.
1341 You can move using the usual cursor motion commands.\\<dired-mode-map>
1342 Letters no longer insert themselves. Digits are prefix arguments.
1343 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1344 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1345 Most commands operate on the marked files and use the current file
1346 if no files are marked. Use a numeric prefix argument to operate on
1347 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1348 to operate on the current file only. Prefix arguments override marks.
1349 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1350 to see why something went wrong.
1351 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1352 Type \\[dired-unmark-backward] to back up one line and unflag.
1353 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1354 Type \\[dired-advertised-find-file] to Find the current line's file
1355 (or dired it in another buffer, if it is a directory).
1356 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1357 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1358 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1359 Type \\[dired-do-copy] to Copy files.
1360 Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
1361 Type \\[revert-buffer] to read all currently expanded directories again.
1362 This retains all marks and hides subdirs again that were hidden before.
1363 SPC and DEL can be used to move down and up by lines.
1365 If dired ever gets confused, you can either type \\[revert-buffer] \
1367 directories again, type \\[dired-do-redisplay] \
1368 to relist a single or the marked files or a
1369 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1370 again for the directory tree.
1372 Customization variables (rename this buffer and type \\[describe-variable] on each line
1375 dired-listing-switches
1376 dired-trivial-filenames
1380 dired-keep-marker-rename
1381 dired-keep-marker-copy
1382 dired-keep-marker-hardlink
1383 dired-keep-marker-symlink
1385 Hooks (use \\[describe-variable] to see their documentation):
1387 dired-before-readin-hook
1388 dired-after-readin-hook
1394 ;; Not to be called interactively (e.g. dired-directory will be set
1395 ;; to default-directory, which is wrong with wildcards).
1396 (kill-all-local-variables)
1397 (use-local-map dired-mode-map)
1398 (dired-advertise) ; default-directory is already set
1399 (setq major-mode 'dired-mode
1401 ;; case-fold-search nil
1403 selective-display t ; for subdirectory hiding
1404 mode-line-buffer-identification
1405 (propertized-buffer-identification "%17b"))
1406 (set (make-local-variable 'revert-buffer-function)
1407 (function dired-revert))
1408 (set (make-local-variable 'buffer-stale-function)
1409 (function dired-buffer-stale-p))
1410 (set (make-local-variable 'page-delimiter)
1412 (set (make-local-variable 'dired-directory)
1413 (or dirname default-directory))
1414 ;; list-buffers uses this to display the dir being edited in this buffer.
1415 (set (make-local-variable 'list-buffers-directory)
1416 (expand-file-name (if (listp dired-directory)
1417 (car dired-directory)
1419 (set (make-local-variable 'dired-actual-switches)
1420 (or switches dired-listing-switches))
1421 (set (make-local-variable 'font-lock-defaults)
1422 '(dired-font-lock-keywords t nil nil beginning-of-line))
1423 (set (make-local-variable 'desktop-save-buffer)
1424 'dired-desktop-buffer-misc-data)
1425 (setq dired-switches-alist nil)
1426 (dired-sort-other dired-actual-switches t)
1427 (run-mode-hooks 'dired-mode-hook)
1428 (when (featurep 'x-dnd)
1429 (make-variable-buffer-local 'x-dnd-test-function)
1430 (make-variable-buffer-local 'x-dnd-protocol-alist)
1431 (setq x-dnd-test-function 'dired-dnd-test-function)
1432 (setq x-dnd-protocol-alist
1433 (append '(("^file:///" . dired-dnd-handle-local-file)
1434 ("^file://" . dired-dnd-handle-file)
1435 ("^file:" . dired-dnd-handle-local-file))
1436 x-dnd-protocol-alist))))
1438 ;; Idiosyncratic dired commands that don't deal with marks.
1440 (defun dired-summary ()
1441 "Summarize basic Dired commands and show recent Dired errors."
1444 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1446 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1448 (defun dired-undo ()
1449 "Undo in a dired buffer.
1450 This doesn't recover lost files, it just undoes changes in the buffer itself.
1451 You can use it to recover marks, killed lines or subdirs.
1452 In the latter case, you have to do \\[dired-build-subdir-alist] to
1453 parse the buffer again."
1455 (let (buffer-read-only)
1457 (message "Change in Dired buffer undone.
1458 Actual changes in files cannot be undone by Emacs.")))
1460 (defun dired-next-line (arg)
1461 "Move down lines then position at filename.
1462 Optional prefix ARG says how many lines to move; default is one line."
1465 (dired-move-to-filename))
1467 (defun dired-previous-line (arg)
1468 "Move up lines then position at filename.
1469 Optional prefix ARG says how many lines to move; default is one line."
1472 (dired-move-to-filename))
1474 (defun dired-next-dirline (arg &optional opoint)
1475 "Goto ARG'th next directory file line."
1477 (or opoint (setq opoint (point)))
1479 (re-search-forward dired-re-dir nil t arg)
1481 (re-search-backward dired-re-dir nil t (- arg)))
1482 (dired-move-to-filename) ; user may type `i' or `f'
1484 (error "No more subdirectories")))
1486 (defun dired-prev-dirline (arg)
1487 "Goto ARG'th previous directory file line."
1489 (dired-next-dirline (- arg)))
1491 (defun dired-up-directory (&optional other-window)
1492 "Run Dired on parent directory of current directory.
1493 Find the parent directory either in this buffer or another buffer.
1494 Creates a buffer if necessary."
1496 (let* ((dir (dired-current-directory))
1497 (up (file-name-directory (directory-file-name dir))))
1498 (or (dired-goto-file (directory-file-name dir))
1499 ;; Only try dired-goto-subdir if buffer has more than one dir.
1500 (and (cdr dired-subdir-alist)
1501 (dired-goto-subdir up))
1504 (dired-other-window up)
1506 (dired-goto-file dir)))))
1508 (defun dired-get-file-for-visit ()
1509 "Get the current line's file name, with an error if file does not exist."
1511 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1512 (let ((raw (dired-get-filename nil t))
1515 (error "No file on this line"))
1516 (setq file-name (file-name-sans-versions raw t))
1517 (if (file-exists-p file-name)
1519 (if (file-symlink-p file-name)
1520 (error "File is a symlink to a nonexistent target")
1521 (error "File no longer exists; type `g' to update Dired buffer")))))
1523 ;; Force `f' rather than `e' in the mode doc:
1524 (defalias 'dired-advertised-find-file 'dired-find-file)
1525 (defun dired-find-file ()
1526 "In Dired, visit the file or directory named on this line."
1528 ;; Bind `find-file-run-dired' so that the command works on directories
1529 ;; too, independent of the user's setting.
1530 (let ((find-file-run-dired t))
1531 (find-file (dired-get-file-for-visit))))
1533 (defun dired-find-alternate-file ()
1534 "In Dired, visit this file or directory instead of the dired buffer."
1536 (set-buffer-modified-p nil)
1537 (find-alternate-file (dired-get-file-for-visit)))
1538 ;; Don't override the setting from .emacs.
1539 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1541 (defun dired-mouse-find-file-other-window (event)
1542 "In Dired, visit the file or directory name you click on."
1544 (let (window pos file)
1546 (setq window (posn-window (event-end event))
1547 pos (posn-point (event-end event)))
1548 (if (not (windowp window))
1549 (error "No file chosen"))
1550 (set-buffer (window-buffer window))
1552 (setq file (dired-get-file-for-visit)))
1553 (if (file-directory-p file)
1554 (or (and (cdr dired-subdir-alist)
1555 (dired-goto-subdir file))
1557 (select-window window)
1558 (dired-other-window file)))
1560 ;; Look for some other way to view a certain file.
1561 (dolist (elt dired-view-command-alist)
1562 (if (string-match (car elt) file)
1563 (setq cmd (cdr elt))))
1565 (call-process shell-file-name nil 0 nil
1567 (concat (format cmd (shell-quote-argument file))
1569 (select-window window)
1570 (find-file-other-window (file-name-sans-versions file t)))))))
1572 (defun dired-view-file ()
1573 "In Dired, examine a file in view mode, returning to dired when done.
1574 When file is a directory, show it in this buffer if it is inserted.
1575 Some kinds of files are displayed using external viewer programs;
1576 see `dired-view-command-alist'. Otherwise, display it in another buffer."
1578 (let ((file (dired-get-file-for-visit)))
1579 (if (file-directory-p file)
1580 (or (and (cdr dired-subdir-alist)
1581 (dired-goto-subdir file))
1584 ;; Look for some other way to view a certain file.
1585 (dolist (elt dired-view-command-alist)
1586 (if (string-match (car elt) file)
1587 (setq cmd (cdr elt))))
1589 (call-process shell-file-name nil 0 nil
1591 (concat (format cmd (shell-quote-argument file))
1593 (view-file file))))))
1595 (defun dired-find-file-other-window ()
1596 "In Dired, visit this file or directory in another window."
1598 (find-file-other-window (dired-get-file-for-visit)))
1600 (defun dired-display-file ()
1601 "In Dired, display this file or directory in another window."
1603 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1605 ;;; Functions for extracting and manipulating file names in Dired buffers.
1607 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1608 "In Dired, return name of file mentioned on this line.
1609 Value returned normally includes the directory name.
1610 Optional arg LOCALP with value `no-dir' means don't include directory
1611 name in result. A value of `verbatim' means to return the name exactly as
1612 it occurs in the buffer, and a value of t means construct name relative to
1613 `default-directory', which still may contain slashes if in a subdirectory.
1614 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1615 regular filenames and return nil if no filename on this line.
1616 Otherwise, an error occurs in these cases."
1617 (let (case-fold-search file p1 p2 already-absolute)
1619 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1620 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1621 ;; nil if no file on this line, but no-error-if-not-filep is t:
1622 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1624 ;; Get rid of the mouse-face property that file names have.
1625 (set-text-properties 0 (length file) nil file)
1626 ;; Unquote names quoted by ls or by dired-insert-directory.
1627 ;; Using read to unquote is much faster than substituting
1628 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1632 ;; Some ls -b don't escape quotes, argh!
1633 ;; This is not needed for GNU ls, though.
1634 (or (dired-string-replace-match
1635 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
1638 ;; The above `read' will return a unibyte string if FILE
1639 ;; contains eight-bit-control/graphic characters.
1640 (if (and enable-multibyte-characters
1641 (not (multibyte-string-p file)))
1642 (setq file (string-to-multibyte file)))))
1643 (and file (file-name-absolute-p file)
1644 ;; A relative file name can start with ~.
1645 ;; Don't treat it as absolute in this context.
1646 (not (eq (aref file 0) ?~))
1647 (setq already-absolute t))
1651 ((eq localp 'verbatim)
1653 ((and (not no-error-if-not-filep)
1654 (member file '("." "..")))
1655 (error "Cannot operate on `.' or `..'"))
1656 ((and (eq localp 'no-dir) already-absolute)
1657 (file-name-nondirectory file))
1659 (let ((handler (find-file-name-handler file nil)))
1660 ;; check for safe-magic property so that we won't
1661 ;; put /: for names that don't really need them.
1662 ;; For instance, .gz files when auto-compression-mode is on.
1663 (if (and handler (not (get handler 'safe-magic)))
1666 ((eq localp 'no-dir)
1668 ((equal (dired-current-directory) "/")
1669 (setq file (concat (dired-current-directory localp) file))
1670 (let ((handler (find-file-name-handler file nil)))
1671 ;; check for safe-magic property so that we won't
1672 ;; put /: for names that don't really need them.
1673 ;; For instance, .gz files when auto-compression-mode is on.
1674 (if (and handler (not (get handler 'safe-magic)))
1678 (concat (dired-current-directory localp) file)))))
1680 (defun dired-string-replace-match (regexp string newtext
1681 &optional literal global)
1682 "Replace first match of REGEXP in STRING with NEWTEXT.
1683 If it does not match, nil is returned instead of the new string.
1684 Optional arg LITERAL means to take NEWTEXT literally.
1685 Optional arg GLOBAL means to replace all matches."
1687 (let ((start 0) ret)
1688 (while (string-match regexp string start)
1689 (let ((from-end (- (length string) (match-end 0))))
1690 (setq ret (setq string (replace-match newtext t literal string)))
1691 (setq start (- (length string) from-end))))
1693 (if (not (string-match regexp string 0))
1695 (replace-match newtext t literal string))))
1697 (defun dired-make-absolute (file &optional dir)
1698 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1699 ;; We can't always use expand-file-name as this would get rid of `.'
1700 ;; or expand in / instead default-directory if DIR=="".
1701 ;; This should be good enough for ange-ftp, but might easily be
1702 ;; redefined (for VMS?).
1703 ;; It should be reasonably fast, though, as it is called in
1704 ;; dired-get-filename.
1705 (concat (or dir default-directory) file))
1707 (defun dired-make-relative (file &optional dir ignore)
1708 "Convert FILE (an absolute file name) to a name relative to DIR.
1709 If this is impossible, return FILE unchanged.
1710 DIR must be a directory name, not a file name."
1711 (or dir (setq dir default-directory))
1712 ;; This case comes into play if default-directory is set to
1714 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1715 (setq dir (expand-file-name dir)))
1716 (if (string-match (concat "^" (regexp-quote dir)) file)
1717 (substring file (match-end 0))
1719 ;;; (error "%s: not in directory tree growing at %s" file dir))
1722 ;;; Functions for finding the file name in a dired buffer line.
1724 (defvar dired-move-to-filename-regexp
1725 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
1726 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
1727 ;; In some locales, month abbreviations are as short as 2 letters,
1728 ;; and they can be followed by ".".
1729 ;; In Breton, a month name can include a quote character.
1730 (month (concat l-or-quote l-or-quote "+\\.?"))
1732 (yyyy "[0-9][0-9][0-9][0-9]")
1734 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
1735 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
1736 (zone "[-+][0-2][0-9][0-5][0-9]")
1737 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
1738 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
1739 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
1740 "\\|" yyyy "-" iso-mm-dd "\\)"))
1741 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
1743 "\\(" HH:MM "\\|" yyyy "\\)"))
1744 (western-comma (concat month s "+" dd "," s "+" yyyy))
1745 ;; Japanese MS-Windows ls-lisp has one-digit months, and
1746 ;; omits the Kanji characters after month and day-of-month.
1749 (concat mm l "?" s dd l "?" s "+"
1750 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
1751 ;; The "[0-9]" below requires the previous column to end in a digit.
1752 ;; This avoids recognizing `1 may 1997' as a date in the line:
1753 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
1754 ;; The "[kKMGTPEZY]?" below supports "ls -alh" output.
1755 ;; The ".*" below finds the last match if there are multiple matches.
1756 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
1757 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1758 (concat ".*[0-9][kKMGTPEZY]?" s
1759 "\\(" western "\\|" western-comma "\\|" japanese "\\|" iso "\\)"
1761 "Regular expression to match up to the file name in a directory listing.
1762 The default value is designed to recognize dates and times
1763 regardless of the language.")
1765 (defvar dired-permission-flags-regexp
1766 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1767 "Regular expression to match the permission flags in `ls -l'.")
1769 ;; Move to first char of filename on this line.
1770 ;; Returns position (point) or nil if no filename on this line."
1771 (defun dired-move-to-filename (&optional raise-error eol)
1772 ;; This is the UNIX version.
1773 (or eol (setq eol (line-end-position)))
1775 ;; First try assuming `ls --dired' was used.
1776 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1778 ((and change (< change eol))
1780 ((re-search-forward dired-move-to-filename-regexp eol t)
1781 (goto-char (match-end 0)))
1782 ((re-search-forward dired-permission-flags-regexp eol t)
1783 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1784 (funcall (if raise-error 'error 'message)
1785 "Unrecognized line! Check dired-move-to-filename-regexp"))
1787 (error "No file on this line")))))
1789 (defun dired-move-to-end-of-filename (&optional no-error)
1790 ;; Assumes point is at beginning of filename,
1791 ;; thus the rwx bit re-search-backward below will succeed in *this*
1792 ;; line if at all. So, it should be called only after
1793 ;; (dired-move-to-filename t).
1794 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1795 ;; This is the UNIX version.
1796 (if (get-text-property (point) 'dired-filename)
1797 (goto-char (next-single-property-change (point) 'dired-filename))
1798 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1799 ;; case-fold-search is nil now, so we can test for capital F:
1800 (setq used-F (string-match "F" dired-actual-switches)
1802 eol (save-excursion (end-of-line) (point))
1803 hidden (and selective-display
1804 (save-excursion (search-forward "\r" eol t))))
1807 (save-excursion ;; Find out what kind of file this is:
1808 ;; Restrict perm bits to be non-blank,
1809 ;; otherwise this matches one char to early (looking backward):
1810 ;; "l---------" (some systems make symlinks that way)
1811 ;; "----------" (plain file with zero perms)
1812 (if (re-search-backward
1813 dired-permission-flags-regexp nil t)
1814 (setq file-type (char-after (match-beginning 1))
1815 symlink (eq file-type ?l)
1816 ;; Only with -F we need to know whether it's an executable
1820 "[xst]" ;; execute bit set anywhere?
1824 (match-string 4)))))
1825 (or no-error (error "No file on this line"))))
1826 ;; Move point to end of name:
1828 (if (search-forward " ->" eol t)
1832 dired-ls-F-marks-symlinks
1833 (eq (preceding-char) ?@) ;; did ls really mark the link?
1834 (forward-char -1))))
1835 (goto-char eol) ;; else not a symbolic link
1836 ;; ls -lF marks dirs, sockets and executables with exactly one
1837 ;; trailing character. (Executable bits on symlinks ain't mean
1838 ;; a thing, even to ls, but we know it's not a symlink.)
1840 (or (memq file-type '(?d ?s))
1842 (forward-char -1))))
1844 (not (eq opoint (point)))
1846 (substitute-command-keys
1847 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1848 "No file on this line")))
1849 (if (eq opoint (point))
1854 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1856 (defun dired-copy-filename-as-kill (&optional arg)
1857 "Copy names of marked (or next ARG) files into the kill ring.
1858 The names are separated by a space.
1859 With a zero prefix arg, use the absolute file name of each marked file.
1860 With \\[universal-argument], use the file name sans directory of each marked file.
1862 If on a subdir headerline, use subdirname instead; prefix arg is ignored
1865 You can then feed the file name(s) to other commands with \\[yank]."
1868 (or (dired-get-subdir)
1869 (mapconcat (function identity)
1871 (cond ((zerop (prefix-numeric-value arg))
1872 (dired-get-marked-files))
1874 (dired-get-marked-files 'no-dir arg))
1876 (dired-get-marked-files t)))
1877 (dired-get-marked-files 'no-dir))
1879 (if (eq last-command 'kill-region)
1880 (kill-append string nil)
1882 (message "%s" string)))
1885 ;; Keeping Dired buffers in sync with the filesystem and with each other
1887 (defun dired-buffers-for-dir (dir &optional file)
1888 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1889 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1891 ;; The list is in reverse order of buffer creation, most recent last.
1892 ;; As a side effect, killed dired buffers for DIR are removed from
1894 (setq dir (file-name-as-directory dir))
1895 (let ((alist dired-buffers) result elt buf pattern)
1897 (setq elt (car alist)
1899 (if (buffer-name buf)
1900 (if (dired-in-this-tree dir (car elt))
1901 (with-current-buffer buf
1902 (and (assoc dir dired-subdir-alist)
1905 (file-name-nondirectory dired-directory)))
1906 (or (= 0 (length wildcards))
1907 (string-match (dired-glob-regexp wildcards)
1909 (setq result (cons buf result)))))
1910 ;; else buffer is killed - clean up:
1911 (setq dired-buffers (delq elt dired-buffers)))
1912 (setq alist (cdr alist)))
1915 (defun dired-glob-regexp (pattern)
1916 "Convert glob-pattern PATTERN to a regular expression."
1917 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1919 (while (string-match "[[?*]" pattern matched-in-pattern)
1920 (let ((op-end (match-end 0))
1921 (next-op (aref pattern (match-beginning 0))))
1922 (setq regexp (concat regexp
1924 (substring pattern matched-in-pattern
1925 (match-beginning 0)))))
1926 (cond ((= next-op ??)
1927 (setq regexp (concat regexp "."))
1928 (setq matched-in-pattern op-end))
1930 ;; Fails to handle ^ yet ????
1931 (let* ((set-start (match-beginning 0))
1933 (if (= (aref pattern (1+ set-start)) ?^)
1936 (set-end (string-match "]" pattern set-cont))
1937 (set (substring pattern set-start (1+ set-end))))
1938 (setq regexp (concat regexp set))
1939 (setq matched-in-pattern (1+ set-end))))
1941 (setq regexp (concat regexp ".*"))
1942 (setq matched-in-pattern op-end)))))
1946 (substring pattern matched-in-pattern))
1951 (defun dired-advertise ()
1952 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1953 ;; With wildcards we actually advertise too much.
1954 (let ((expanded-default (expand-file-name default-directory)))
1955 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1956 t ; we have already advertised ourselves
1958 (cons (cons expanded-default (current-buffer))
1961 (defun dired-unadvertise (dir)
1962 ;; Remove DIR from the buffer alist in variable dired-buffers.
1963 ;; This has the effect of removing any buffer whose main directory is DIR.
1964 ;; It does not affect buffers in which DIR is a subdir.
1965 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1967 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
1971 ;;; utility functions
1973 (defun dired-in-this-tree (file dir)
1974 ;;"Is FILE part of the directory tree starting at DIR?"
1975 (let (case-fold-search)
1976 (string-match (concat "^" (regexp-quote dir)) file)))
1978 (defun dired-normalize-subdir (dir)
1979 ;; Prepend default-directory to DIR if relative file name.
1980 ;; dired-get-filename must be able to make a valid file name from a
1981 ;; file and its directory DIR.
1982 (file-name-as-directory
1983 (if (file-name-absolute-p dir)
1985 (expand-file-name dir default-directory))))
1987 (defun dired-get-subdir ()
1988 ;;"Return the subdir name on this line, or nil if not on a headerline."
1989 ;; Look up in the alist whether this is a headerline.
1991 (let ((cur-dir (dired-current-directory)))
1992 (beginning-of-line) ; alist stores b-o-l positions
1993 (and (zerop (- (point)
1994 (dired-get-subdir-min (assoc cur-dir
1995 dired-subdir-alist))))
1998 ;(defun dired-get-subdir-min (elt)
2000 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2001 (defalias 'dired-get-subdir-min 'cdr)
2003 (defun dired-get-subdir-max (elt)
2005 (goto-char (dired-get-subdir-min elt))
2006 (dired-subdir-max)))
2008 (defun dired-clear-alist ()
2009 (while dired-subdir-alist
2010 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2011 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2013 (defun dired-subdir-index (dir)
2014 ;; Return an index into alist for use with nth
2015 ;; for the sake of subdir moving commands.
2016 (let (found (index 0) (alist dired-subdir-alist))
2018 (if (string= dir (car (car alist)))
2019 (setq alist nil found t)
2020 (setq alist (cdr alist) index (1+ index))))
2021 (if found index nil)))
2023 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2024 "Go to next subdirectory, regardless of level."
2025 ;; Use 0 arg to go to this directory's header line.
2026 ;; NO-SKIP prevents moving to end of header line, returning whatever
2027 ;; position was found in dired-subdir-alist.
2029 (let ((this-dir (dired-current-directory))
2031 ;; nth with negative arg does not return nil but the first element
2032 (setq index (- (dired-subdir-index this-dir) arg))
2033 (setq pos (if (>= index 0)
2034 (dired-get-subdir-min (nth index dired-subdir-alist))))
2038 (or no-skip (skip-chars-forward "^\n\r"))
2040 (if no-error-if-not-found
2041 nil ; return nil if not found
2042 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2044 (defun dired-build-subdir-alist (&optional switches)
2045 "Build `dired-subdir-alist' by parsing the buffer.
2046 Returns the new value of the alist.
2047 If optional arg SWITCHES is non-nil, use its value
2048 instead of `dired-actual-switches'."
2053 (buffer-read-only nil)
2054 (switches (or switches dired-actual-switches))
2056 (R-ftp-base-dir-regex
2057 ;; Used to expand subdirectory names correctly in recursive
2058 ;; ange-ftp listings.
2059 (and (string-match "R" switches)
2060 (string-match "\\`/.*:\\(/.*\\)" default-directory)
2061 (concat "\\`" (match-string 1 default-directory)))))
2062 (goto-char (point-min))
2063 (setq dired-subdir-alist nil)
2064 (while (and (re-search-forward dired-subdir-regexp nil t)
2065 ;; Avoid taking a file name ending in a colon
2066 ;; as a subdir name.
2067 (not (save-excursion
2068 (goto-char (match-beginning 0))
2071 (save-match-data (looking-at dired-re-perms)))))
2073 (goto-char (match-beginning 1))
2075 (buffer-substring-no-properties (point) (match-end 1))
2078 (if (and R-ftp-base-dir-regex
2079 (not (string= new-dir-name default-directory))
2080 (string-match R-ftp-base-dir-regex new-dir-name))
2081 (concat default-directory
2082 (substring new-dir-name (match-end 0)))
2083 (expand-file-name new-dir-name))))
2084 (delete-region (point) (match-end 1))
2085 (insert new-dir-name))
2086 (setq count (1+ count))
2087 (dired-alist-add-1 new-dir-name
2088 ;; Place a sub directory boundary between lines.
2090 (goto-char (match-beginning 0))
2093 (if (and (> count 1) (interactive-p))
2094 (message "Buffer includes %d directories" count))
2095 ;; We don't need to sort it because it is in buffer order per
2096 ;; constructionem. Return new alist:
2097 dired-subdir-alist)))
2099 (defun dired-alist-add-1 (dir new-marker)
2100 ;; Add new DIR at NEW-MARKER. Don't sort.
2101 (setq dired-subdir-alist
2102 (cons (cons (dired-normalize-subdir dir) new-marker)
2103 dired-subdir-alist)))
2105 (defun dired-goto-next-nontrivial-file ()
2106 ;; Position point on first nontrivial file after point.
2107 (dired-goto-next-file);; so there is a file to compare with
2108 (if (stringp dired-trivial-filenames)
2109 (while (and (not (eobp))
2110 (string-match dired-trivial-filenames
2111 (file-name-nondirectory
2112 (or (dired-get-filename nil t) ""))))
2114 (dired-move-to-filename))))
2116 (defun dired-goto-next-file ()
2117 (let ((max (1- (dired-subdir-max))))
2118 (while (and (not (dired-move-to-filename)) (< (point) max))
2121 (defun dired-goto-file (file)
2122 "Go to file line of FILE in this dired buffer."
2123 ;; Return value of point on success, else nil.
2124 ;; FILE must be an absolute file name.
2125 ;; Loses if FILE contains control chars like "\007" for which ls
2126 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2127 ;; it in the buffer.
2129 (prog1 ; let push-mark display its message
2130 (list (expand-file-name
2131 (read-file-name "Goto file: "
2132 (dired-current-directory))))
2134 (setq file (directory-file-name file)) ; does no harm if no directory
2135 (let (found case-fold-search dir)
2136 (setq dir (or (file-name-directory file)
2137 (error "File name `%s' is not absolute" file)))
2139 ;; The hair here is to get the result of dired-goto-subdir
2140 ;; without really calling it if we don't have any subdirs.
2141 (if (if (string= dir (expand-file-name default-directory))
2142 (goto-char (point-min))
2143 (and (cdr dired-subdir-alist)
2144 (dired-goto-subdir dir)))
2145 (let ((base (file-name-nondirectory file))
2147 (boundary (dired-subdir-max)))
2149 (replace-regexp-in-string "\^m" "\\^m" base nil t))
2151 (replace-regexp-in-string "\\\\" "\\\\" search-string nil t))
2152 (while (and (not found)
2153 ;; filenames are preceded by SPC, this makes
2154 ;; the search faster (e.g. for the filename "-"!).
2155 (search-forward (concat " " search-string)
2157 ;; Match could have BASE just as initial substring or
2158 ;; or in permission bits or date or
2159 ;; not be a proper filename at all:
2160 (if (equal base (dired-get-filename 'no-dir t))
2161 ;; Must move to filename since an (actually
2162 ;; correct) match could have been elsewhere on the
2163 ;; ;; line (e.g. "-" would match somewhere in the
2164 ;; permission bits).
2165 (setq found (dired-move-to-filename))
2166 ;; If this isn't the right line, move forward to avoid
2167 ;; trying this line again.
2168 (forward-line 1))))))
2170 ;; return value of point (i.e., FOUND):
2171 (goto-char found))))
2173 (defun dired-initial-position (dirname)
2174 ;; Where point should go in a new listing of DIRNAME.
2175 ;; Point assumed at beginning of new subdir line.
2176 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2178 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2180 ;; These are hooks which make tree dired work.
2181 ;; They are in this file because other parts of dired need to call them.
2182 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2184 ;; This function is called for each retrieved filename.
2185 ;; It could stand to be faster, though it's mostly function call
2186 ;; overhead. Avoiding the function call seems to save about 10% in
2187 ;; dired-get-filename. Make it a defsubst?
2188 (defun dired-current-directory (&optional localp)
2189 "Return the name of the subdirectory to which this line belongs.
2190 This returns a string with trailing slash, like `default-directory'.
2191 Optional argument means return a file name relative to `default-directory'."
2192 (let ((here (point))
2193 (alist (or dired-subdir-alist
2194 ;; probably because called in a non-dired buffer
2195 (error "No subdir-alist in %s" (current-buffer))))
2198 (setq elt (car alist)
2200 ;; use `<=' (not `<') as subdir line is part of subdir
2201 alist (if (<= (dired-get-subdir-min elt) here)
2205 (dired-make-relative dir default-directory)
2208 ;; Subdirs start at the beginning of their header lines and end just
2209 ;; before the beginning of the next header line (or end of buffer).
2211 (defun dired-subdir-max ()
2213 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2219 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
2220 "*Decide whether recursive deletes are allowed.
2221 nil means no recursive deletes.
2222 `always' means delete recursively without asking. This is DANGEROUS!
2223 `top' means ask for each directory at top level, but delete its subdirectories
2225 Anything else means ask for each directory."
2226 :type '(choice :tag "Delete non-empty directories"
2227 (const :tag "Yes" always)
2228 (const :tag "No--only delete empty directories" nil)
2229 (const :tag "Confirm for each directory" t)
2230 (const :tag "Confirm for each top directory only" top))
2233 ;; Match anything but `.' and `..'.
2234 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2236 ;; Delete file, possibly delete a directory and all its files.
2237 ;; This function is usefull outside of dired. One could change it's name
2238 ;; to e.g. recursive-delete-file and put it somewhere else.
2239 (defun dired-delete-file (file &optional recursive) "\
2240 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2241 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2243 `always', delete recursively without asking.
2244 `top', ask for each directory at top level.
2245 Anything else, ask for each sub-directory."
2247 ;; This test is equivalent to
2248 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2249 ;; but more efficient
2250 (if (not (eq t (car (file-attributes file))))
2252 (when (and recursive
2254 (directory-files file t dired-re-no-dot)) ; Not empty.
2255 (or (eq recursive 'always)
2256 (yes-or-no-p (format "Recursive delete of %s "
2257 (dired-make-relative file)))))
2258 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2259 (while files ; Recursively delete (possibly asking).
2260 (dired-delete-file (car files) recursive)
2261 (setq files (cdr files))))
2262 (delete-directory file))))
2264 (defun dired-do-flagged-delete (&optional nomessage)
2265 "In Dired, delete the files flagged for deletion.
2266 If NOMESSAGE is non-nil, we don't display any message
2267 if there are no flagged files."
2269 (let* ((dired-marker-char dired-del-marker)
2270 (regexp (dired-marker-regexp))
2272 (if (save-excursion (goto-char (point-min))
2273 (re-search-forward regexp nil t))
2274 (dired-internal-do-deletions
2275 ;; this can't move point since ARG is nil
2276 (dired-map-over-marks (cons (dired-get-filename) (point))
2280 (message "(No deletions requested)")))))
2282 (defun dired-do-delete (&optional arg)
2283 "Delete all marked (or next ARG) files."
2284 ;; This is more consistent with the file marking feature than
2285 ;; dired-do-flagged-delete.
2287 (dired-internal-do-deletions
2288 ;; this may move point if ARG is an integer
2289 (dired-map-over-marks (cons (dired-get-filename) (point))
2293 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2295 (defun dired-internal-do-deletions (l arg)
2296 ;; L is an alist of files to delete, with their buffer positions.
2297 ;; ARG is the prefix arg.
2298 ;; Filenames are absolute (VMS needs this for logical search paths).
2299 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2300 ;; That way as changes are made in the buffer they do not shift the
2301 ;; lines still to be changed, so the (point) values in L stay valid.
2302 ;; Also, for subdirs in natural order, a subdir's files are deleted
2303 ;; before the subdir itself - the other way around would not work.
2304 (let ((files (mapcar (function car) l))
2307 ;; canonicalize file list for pop up
2308 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2309 (if (dired-mark-pop-up
2310 " *Deletions*" 'delete files dired-deletion-confirmer
2311 (format "Delete %s " (dired-mark-prompt arg files)))
2313 (let (failures);; files better be in reverse order for this loop!
2315 (goto-char (cdr (car l)))
2316 (let (buffer-read-only)
2318 (let ((fn (car (car l))))
2319 (dired-delete-file fn dired-recursive-deletes)
2320 ;; if we get here, removing worked
2321 (setq succ (1+ succ))
2322 (message "%s of %s deletions" succ count)
2323 (dired-fun-in-all-buffers
2324 (file-name-directory fn) (file-name-nondirectory fn)
2325 (function dired-delete-entry) fn))
2326 (error;; catch errors from failed deletions
2327 (dired-log "%s\n" err)
2328 (setq failures (cons (car (car l)) failures)))))
2331 (message "%d deletion%s done" count (dired-plural-s count))
2333 (format "%d of %d deletion%s failed"
2334 (length failures) count
2335 (dired-plural-s count))
2337 (message "(No deletions performed)")))
2338 (dired-move-to-filename))
2340 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2341 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2342 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2343 ;; (FILE does not include a directory component.)
2344 ;; FILE may be nil, in which case ignore it.
2345 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2347 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2349 (with-current-buffer buf
2350 (if (apply fun args)
2351 (setq success-list (cons (buffer-name buf) success-list)))))
2354 ;; Delete the entry for FILE from
2355 (defun dired-delete-entry (file)
2357 (and (dired-goto-file file)
2358 (let (buffer-read-only)
2359 (delete-region (progn (beginning-of-line) (point))
2360 (save-excursion (forward-line 1) (point))))))
2361 (dired-clean-up-after-deletion file))
2363 ;; This is a separate function for the sake of dired-x.el.
2364 (defun dired-clean-up-after-deletion (fn)
2365 ;; Clean up after a deleted file or directory FN.
2366 (save-excursion (and (cdr dired-subdir-alist)
2367 (dired-goto-subdir fn)
2368 (dired-kill-subdir))))
2372 (defun dired-marker-regexp ()
2373 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2375 (defun dired-plural-s (count)
2376 (if (= 1 count) "" "s"))
2378 (defun dired-mark-prompt (arg files)
2379 ;; Return a string for use in a prompt, either the current file
2380 ;; name, or the marker and a count of marked files.
2381 (let ((count (length files)))
2384 ;; more than 1 file:
2387 ;; Perhaps this is nicer, but it also takes more screen space:
2388 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2390 (format "[next %d files]" arg)
2391 (format "%c [%d files]" dired-marker-char count)))))
2393 (defun dired-pop-to-buffer (buf)
2394 ;; Pop up buffer BUF.
2395 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2396 (if (not dired-shrink-to-fit)
2397 (pop-to-buffer (get-buffer-create buf))
2398 ;; let window shrink to fit:
2399 (let ((window (selected-window))
2401 (cond ;; if split-height-threshold is enabled, use the largest window
2402 ((and (> (window-height (setq w2 (get-largest-window)))
2403 split-height-threshold)
2404 (= (frame-width) (window-width w2)))
2406 ;; if the least-recently-used window is big enough, use it
2407 ((and (> (window-height (setq w2 (get-lru-window)))
2408 (* 2 window-min-height))
2409 (= (frame-width) (window-width w2)))
2413 (goto-char (point-max))
2414 (skip-chars-backward "\n\r\t ")
2415 (setq target-lines (count-lines (point-min) (point)))
2416 ;; Don't forget to count the last line.
2418 (setq target-lines (1+ target-lines))))
2419 (if (<= (window-height window) (* 2 window-min-height))
2420 ;; At this point, every window on the frame is too small to split.
2421 (setq w2 (display-buffer buf))
2422 (setq w2 (split-window window
2423 (max window-min-height
2424 (- (window-height window)
2425 (1+ (max window-min-height target-lines)))))))
2426 (set-window-buffer w2 buf)
2427 (if (< (1- (window-height w2)) target-lines)
2430 (enlarge-window (- target-lines (1- (window-height w2))))))
2431 (set-window-start w2 1)
2434 (defvar dired-no-confirm nil
2435 "A list of symbols for commands dired should not confirm.
2436 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2437 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2438 `touch' and `uncompress'.")
2440 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2441 "Return FUNCTION's result on ARGS after showing which files are marked.
2442 Displays the file names in a buffer named BUFNAME;
2443 nil gives \" *Marked Files*\".
2444 This uses function `dired-pop-to-buffer' to do that.
2446 FUNCTION should not manipulate files, just read input
2447 (an argument or confirmation).
2448 The window is not shown if there is just one file or
2449 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2450 FILES is the list of marked files."
2451 (or bufname (setq bufname " *Marked Files*"))
2452 (if (or (eq dired-no-confirm t)
2453 (memq op-symbol dired-no-confirm)
2454 (= (length files) 1))
2455 (apply function args)
2456 (with-current-buffer (get-buffer-create bufname)
2458 (dired-format-columns-of-files files)
2459 (remove-text-properties (point-min) (point-max)
2460 '(mouse-face nil help-echo nil)))
2461 (save-window-excursion
2462 (dired-pop-to-buffer bufname)
2463 (apply function args))))
2465 (defun dired-format-columns-of-files (files)
2466 ;; Files should be in forward order for this loop.
2467 ;; i.e., (car files) = first file in buffer.
2468 ;; Returns the number of lines used.
2469 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2470 (width (- (window-width (selected-window)) 2))
2471 (columns (max 1 (/ width maxlen)))
2472 (nfiles (length files))
2473 (rows (+ (/ nfiles columns)
2474 (if (zerop (% nfiles columns)) 0 1)))
2477 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2478 (make-list (- (* columns rows) nfiles) "")))
2479 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2481 (while (< i columns)
2482 (indent-to (* i maxlen))
2483 (insert (car files))
2484 (setq files (nthcdr rows files)
2492 ;; Commands to mark or flag file(s) at or near current line.
2494 (defun dired-repeat-over-lines (arg function)
2495 ;; This version skips non-file lines.
2496 (let ((pos (make-marker)))
2498 (while (and (> arg 0) (not (eobp)))
2501 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2504 (move-marker pos (1+ (point))))
2505 (save-excursion (funcall function))
2506 ;; Advance to the next line--actually, to the line that *was* next.
2507 ;; (If FUNCTION inserted some new lines in between, skip them.)
2509 (while (and (< arg 0) (not (bobp)))
2512 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2514 (save-excursion (funcall function)))
2515 (move-marker pos nil)
2516 (dired-move-to-filename)))
2518 (defun dired-between-files ()
2519 ;; This used to be a regexp match of the `total ...' line output by
2520 ;; ls, which is slightly faster, but that is not very robust; notably,
2521 ;; it fails for non-english locales.
2522 (save-excursion (not (dired-move-to-filename))))
2524 (defun dired-next-marked-file (arg &optional wrap opoint)
2525 "Move to the next marked file, wrapping around the end of the buffer."
2526 (interactive "p\np")
2527 (or opoint (setq opoint (point)));; return to where interactively started
2529 (re-search-forward dired-re-mark nil t arg)
2531 (re-search-backward dired-re-mark nil t (- arg)))
2532 (dired-move-to-filename)
2536 (error "No next marked file"))
2537 (message "(Wraparound for next marked file)")
2538 (goto-char (if (> arg 0) (point-min) (point-max)))
2539 (dired-next-marked-file arg nil opoint))))
2541 (defun dired-prev-marked-file (arg &optional wrap)
2542 "Move to the previous marked file, wrapping around the end of the buffer."
2543 (interactive "p\np")
2544 (dired-next-marked-file (- arg) wrap))
2546 (defun dired-file-marker (file)
2547 ;; Return FILE's marker, or nil if unmarked.
2549 (and (dired-goto-file file)
2552 (if (not (equal ?\040 (following-char)))
2553 (following-char))))))
2555 (defun dired-mark-files-in-region (start end)
2556 (let (buffer-read-only)
2558 (error "start > end"))
2559 (goto-char start) ; assumed at beginning of line
2560 (while (< (point) end)
2561 ;; Skip subdir line and following garbage like the `total' line:
2562 (while (and (< (point) end) (dired-between-files))
2564 (if (and (not (looking-at dired-re-dot))
2565 (dired-get-filename nil t))
2568 (insert dired-marker-char)))
2571 (defun dired-mark (arg)
2572 "Mark the current (or next ARG) files.
2573 If on a subdir headerline, mark all its files except `.' and `..'.
2575 Use \\[dired-unmark-all-files] to remove all marks
2576 and \\[dired-unmark] on a subdir to remove the marks in
2579 (if (dired-get-subdir)
2580 (save-excursion (dired-mark-subdir-files))
2581 (let (buffer-read-only)
2582 (dired-repeat-over-lines
2583 (prefix-numeric-value arg)
2584 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2586 (defun dired-unmark (arg)
2587 "Unmark the current (or next ARG) files.
2588 If looking at a subdir, unmark all its files except `.' and `..'."
2590 (let ((dired-marker-char ?\040))
2593 (defun dired-flag-file-deletion (arg)
2594 "In Dired, flag the current line's file for deletion.
2595 With prefix arg, repeat over several lines.
2597 If on a subdir headerline, mark all its files except `.' and `..'."
2599 (let ((dired-marker-char dired-del-marker))
2602 (defun dired-unmark-backward (arg)
2603 "In Dired, move up lines and remove deletion flag there.
2604 Optional prefix ARG says how many lines to unflag; default is one line."
2606 (dired-unmark (- arg)))
2608 (defun dired-toggle-marks ()
2609 "Toggle marks: marked files become unmarked, and vice versa.
2610 Files marked with other flags (such as `D') are not affected.
2611 `.' and `..' are never toggled.
2612 As always, hidden subdirs are not affected."
2615 (goto-char (point-min))
2616 (let (buffer-read-only)
2618 (or (dired-between-files)
2619 (looking-at dired-re-dot)
2620 ;; use subst instead of insdel because it does not move
2621 ;; the gap and thus should be faster and because
2622 ;; other characters are left alone automatically
2623 (apply 'subst-char-in-region
2624 (point) (1+ (point))
2625 (if (eq ?\040 (following-char)) ; SPC
2626 (list ?\040 dired-marker-char)
2627 (list dired-marker-char ?\040))))
2628 (forward-line 1)))))
2630 ;;; Commands to mark or flag files based on their characteristics or names.
2632 (defvar dired-regexp-history nil
2633 "History list of regular expressions used in Dired commands.")
2635 (defun dired-read-regexp (prompt)
2636 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2638 (defun dired-mark-files-regexp (regexp &optional marker-char)
2639 "Mark all files matching REGEXP for use in later commands.
2640 A prefix argument means to unmark them instead.
2641 `.' and `..' are never marked.
2643 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2644 object files--just `.o' will mark more than you might think."
2646 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2647 " files (regexp): "))
2648 (if current-prefix-arg ?\040)))
2649 (let ((dired-marker-char (or marker-char dired-marker-char)))
2651 (and (not (looking-at dired-re-dot))
2652 (not (eolp)) ; empty line
2653 (let ((fn (dired-get-filename nil t)))
2654 (and fn (string-match regexp (file-name-nondirectory fn)))))
2657 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2658 "Mark all files with contents containing REGEXP for use in later commands.
2659 A prefix argument means to unmark them instead.
2660 `.' and `..' are never marked."
2662 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2663 " files containing (regexp): "))
2664 (if current-prefix-arg ?\040)))
2665 (let ((dired-marker-char (or marker-char dired-marker-char)))
2667 (and (not (looking-at dired-re-dot))
2668 (not (eolp)) ; empty line
2669 (let ((fn (dired-get-filename nil t)))
2670 (when (and fn (file-readable-p fn)
2671 (not (file-directory-p fn)))
2672 (let ((prebuf (get-file-buffer fn)))
2673 (message "Checking %s" fn)
2674 ;; For now we do it inside emacs
2675 ;; Grep might be better if there are a lot of files
2677 (with-current-buffer prebuf
2679 (goto-char (point-min))
2680 (re-search-forward regexp nil t)))
2682 (insert-file-contents fn)
2683 (goto-char (point-min))
2684 (re-search-forward regexp nil t))))
2688 (defun dired-flag-files-regexp (regexp)
2689 "In Dired, flag all files containing the specified REGEXP for deletion.
2690 The match is against the non-directory part of the filename. Use `^'
2691 and `$' to anchor matches. Exclude subdirs by hiding them.
2692 `.' and `..' are never flagged."
2693 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2694 (dired-mark-files-regexp regexp dired-del-marker))
2696 (defun dired-mark-symlinks (unflag-p)
2697 "Mark all symbolic links.
2698 With prefix argument, unflag all those files."
2700 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2701 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2703 (defun dired-mark-directories (unflag-p)
2704 "Mark all directory file lines except `.' and `..'.
2705 With prefix argument, unflag all those files."
2707 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2708 (dired-mark-if (and (looking-at dired-re-dir)
2709 (not (looking-at dired-re-dot)))
2712 (defun dired-mark-executables (unflag-p)
2713 "Mark all executable files.
2714 With prefix argument, unflag all those files."
2716 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2717 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2719 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2720 ;; files for which PREDICATE returns non-nil.
2722 (defun dired-flag-auto-save-files (&optional unflag-p)
2723 "Flag for deletion files whose names suggest they are auto save files.
2724 A prefix argument says to unflag those files instead."
2726 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2728 ;; It is less than general to check for # here,
2729 ;; but it's the only way this runs fast enough.
2730 (and (save-excursion (end-of-line)
2732 (eq (preceding-char) ?#)
2733 ;; Handle executables in case of -F option.
2734 ;; We need not worry about the other kinds
2735 ;; of markings that -F makes, since they won't
2736 ;; appear on real auto-save files.
2737 (if (eq (preceding-char) ?*)
2740 (eq (preceding-char) ?#)))))
2741 (not (looking-at dired-re-dir))
2742 (let ((fn (dired-get-filename t t)))
2743 (if fn (auto-save-file-name-p
2744 (file-name-nondirectory fn)))))
2747 (defcustom dired-garbage-files-regexp
2748 ;; `log' here is dubious, since it's typically used for useful log
2749 ;; files, not just TeX stuff. -- fx
2751 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2753 "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
2757 (defun dired-flag-garbage-files ()
2758 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2760 (dired-flag-files-regexp dired-garbage-files-regexp))
2762 (defun dired-flag-backup-files (&optional unflag-p)
2763 "Flag all backup files (names ending with `~') for deletion.
2764 With prefix argument, unflag these files."
2766 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2768 ;; Don't call backup-file-name-p unless the last character looks like
2769 ;; it might be the end of a backup file name. This isn't very general,
2770 ;; but it's the only way this runs fast enough.
2771 (and (save-excursion (end-of-line)
2772 ;; Handle executables in case of -F option.
2773 ;; We need not worry about the other kinds
2774 ;; of markings that -F makes, since they won't
2775 ;; appear on real backup files.
2776 (if (eq (preceding-char) ?*)
2778 (eq (preceding-char) ?~))
2779 (not (looking-at dired-re-dir))
2780 (let ((fn (dired-get-filename t t)))
2781 (if fn (backup-file-name-p fn))))
2784 (defun dired-change-marks (&optional old new)
2785 "Change all OLD marks to NEW marks.
2786 OLD and NEW are both characters used to mark files."
2788 (let* ((cursor-in-echo-area t)
2789 (old (progn (message "Change (old mark): ") (read-char)))
2790 (new (progn (message "Change %c marks to (new mark): " old)
2793 (if (or (eq old ?\r) (eq new ?\r))
2795 (let ((string (format "\n%c" old))
2798 (goto-char (point-min))
2799 (while (search-forward string nil t)
2802 (dired-get-filename 'no-dir t))
2804 (subst-char-in-region (match-beginning 0)
2805 (match-end 0) old new)))))))
2807 (defun dired-unmark-all-marks ()
2808 "Remove all marks from all files in the Dired buffer."
2810 (dired-unmark-all-files ?\r))
2812 (defun dired-unmark-all-files (mark &optional arg)
2813 "Remove a specific mark (or any mark) from every file.
2814 After this command, type the mark character to remove,
2815 or type RET to remove all marks.
2816 With prefix arg, query for each marked file.
2817 Type \\[help-command] at that time for help."
2818 (interactive "cRemove marks (RET means all): \nP")
2821 buffer-read-only case-fold-search query
2822 (string (format "\n%c" mark))
2824 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2825 `!' to unmark all remaining files with no more questions."))
2826 (goto-char (point-min))
2827 (while (if (eq mark ?\r)
2828 (re-search-forward dired-re-mark nil t)
2829 (search-forward string nil t))
2831 (let ((file (dired-get-filename t t)))
2833 (dired-query 'query "Unmark file `%s'? "
2835 (progn (subst-char-in-region (1- (point)) (point)
2836 (preceding-char) ?\ )
2837 (setq count (1+ count)))))
2838 (message (if (= count 1) "1 mark removed"
2842 ;; Logging failures operating on files, and showing the results.
2844 (defvar dired-log-buffer "*Dired log*")
2847 "Pop up a buffer with error log output from Dired.
2848 A group of errors from a single command ends with a formfeed.
2849 Thus, use \\[backward-page] to find the beginning of a group of errors."
2851 (if (get-buffer dired-log-buffer)
2852 (let ((owindow (selected-window))
2853 (window (display-buffer (get-buffer dired-log-buffer))))
2856 (select-window window)
2857 (goto-char (point-max))
2861 (select-window owindow)))))
2863 (defun dired-log (log &rest args)
2864 ;; Log a message or the contents of a buffer.
2865 ;; If LOG is a string and there are more args, it is formatted with
2866 ;; those ARGS. Usually the LOG string ends with a \n.
2867 ;; End each bunch of errors with (dired-log t):
2868 ;; this inserts the current time and buffer at the start of the page,
2869 ;; and \f (formfeed) at the end.
2870 (let ((obuf (current-buffer)))
2871 (with-current-buffer (get-buffer-create dired-log-buffer)
2872 (goto-char (point-max))
2873 (let ((inhibit-read-only t))
2874 (cond ((stringp log)
2876 (apply (function format) log args)
2879 (insert-buffer log))
2884 (insert (current-time-string)
2885 "\tBuffer `" (buffer-name obuf) "'\n")
2886 (goto-char (point-max))
2887 (insert "\f\n")))))))
2889 (defun dired-log-summary (string failures)
2890 (if (= (length failures) 1)
2892 (with-current-buffer dired-log-buffer
2893 (goto-char (point-max))
2895 (if (eolp) (forward-line 1))
2896 (buffer-substring (point) (point-max))))
2897 (message (if failures "%s--type ? for details (%s)"
2898 "%s--type ? for details")
2900 ;; Log a summary describing a bunch of errors.
2901 (dired-log (concat "\n" string "\n"))
2906 ;; Most ls can only sort by name or by date (with -t), nothing else.
2907 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2908 ;; So anything that does not contain these is sort "by name".
2910 (defvar dired-ls-sorting-switches "SXU"
2911 "String of `ls' switches \(single letters\) except `t' that influence sorting.
2913 This indicates to Dired which option switches to watch out for because they
2914 will change the sorting order behavior of `ls'.
2916 To change the default sorting order \(e.g. add a `-v' option\), see the
2917 variable `dired-listing-switches'. To temporarily override the listing
2918 format, use `\\[universal-argument] \\[dired]'.")
2920 (defvar dired-sort-by-date-regexp
2921 (concat "^-[^" dired-ls-sorting-switches
2922 "]*t[^" dired-ls-sorting-switches "]*$")
2923 "Regexp recognized by dired to set `by date' mode.")
2925 (defvar dired-sort-by-name-regexp
2926 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2927 "Regexp recognized by dired to set `by name' mode.")
2929 (defvar dired-sort-inhibit nil
2930 "Non-nil means the Dired sort command is disabled.
2931 The idea is to set this buffer-locally in special Dired buffers.")
2933 (defun dired-sort-set-modeline ()
2934 ;; Set modeline display according to dired-actual-switches.
2935 ;; Modeline display of "by name" or "by date" guarantees the user a
2936 ;; match with the corresponding regexps. Non-matching switches are
2939 (let (case-fold-search)
2940 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2942 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2945 (concat "Dired " dired-actual-switches)))))
2946 (force-mode-line-update))
2948 (defun dired-sort-toggle-or-edit (&optional arg)
2949 "Toggle between sort by date/name and refresh the dired buffer.
2950 With a prefix argument you can edit the current listing switches instead."
2952 (when dired-sort-inhibit
2953 (error "Cannot sort this Dired buffer"))
2956 (read-string "ls switches (must contain -l): " dired-actual-switches))
2957 (dired-sort-toggle)))
2959 (defun dired-sort-toggle ()
2960 ;; Toggle between sort by date/name. Reverts the buffer.
2961 (setq dired-actual-switches
2962 (let (case-fold-search)
2963 (if (string-match " " dired-actual-switches)
2964 ;; New toggle scheme: add/remove a trailing " -t"
2965 (if (string-match " -t\\'" dired-actual-switches)
2966 (substring dired-actual-switches 0 (match-beginning 0))
2967 (concat dired-actual-switches " -t"))
2968 ;; old toggle scheme: look for some 't' switch and add/remove it
2971 (dired-replace-in-string (concat "[-lt"
2972 dired-ls-sorting-switches "]")
2974 dired-actual-switches)
2975 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2976 dired-actual-switches)
2979 (dired-sort-set-modeline)
2982 ;; Some user code loads dired especially for this.
2983 ;; Don't do that--use replace-regexp-in-string instead.
2984 (defun dired-replace-in-string (regexp newtext string)
2985 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2986 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2987 (let ((result "") (start 0) mb me)
2988 (while (string-match regexp string start)
2989 (setq mb (match-beginning 0)
2991 result (concat result (substring string start mb) newtext)
2993 (concat result (substring string start))))
2995 (defun dired-sort-other (switches &optional no-revert)
2996 "Specify new ls SWITCHES for current dired buffer.
2997 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
2998 set the minor mode accordingly, others appear literally in the mode line.
2999 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3000 (dired-sort-R-check switches)
3001 (setq dired-actual-switches switches)
3002 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
3003 (or no-revert (revert-buffer)))
3005 (make-variable-buffer-local
3006 (defvar dired-subdir-alist-pre-R nil
3007 "Value of `dired-subdir-alist' before -R switch added."))
3009 (defun dired-sort-R-check (switches)
3010 "Additional processing of -R in ls option string SWITCHES.
3011 Saves `dired-subdir-alist' when R is set and restores saved value
3012 minus any directories explicitly deleted when R is cleared.
3013 To be called first in body of `dired-sort-other', etc."
3015 ((and (string-match "R" switches)
3016 (not (string-match "R" dired-actual-switches)))
3017 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3018 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3019 ((and (string-match "R" dired-actual-switches)
3020 (not (string-match "R" switches)))
3021 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3022 ;; that are still present:
3023 (setq dired-subdir-alist
3024 (if dired-subdir-alist-pre-R
3026 (while dired-subdir-alist-pre-R
3027 (if (assoc (caar dired-subdir-alist-pre-R)
3029 ;; subdir still present...
3031 (cons (car dired-subdir-alist-pre-R)
3033 (setq dired-subdir-alist-pre-R
3034 (cdr dired-subdir-alist-pre-R)))
3036 ;; No pre-R subdir alist, so revert to main directory
3038 (list (car (reverse dired-subdir-alist))))))))
3040 ;; To make this file smaller, the less common commands
3041 ;; go in a separate file. But autoload them here
3042 ;; to make the separation invisible.
3044 (autoload 'dired-diff "dired-aux"
3045 "Compare file at point with file FILE using `diff'.
3046 FILE defaults to the file at the mark. (That's the mark set by
3047 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
3048 The prompted-for file is the first file given to `diff'."
3051 (autoload 'dired-backup-diff "dired-aux"
3052 "Diff this file with its backup file or vice versa.
3053 Uses the latest backup, if there are several numerical backups.
3054 If this file is a backup, diff it with its original.
3055 The backup file is the first file given to `diff'."
3058 (autoload 'dired-clean-directory "dired-aux"
3059 "Flag numerical backups for deletion.
3060 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3061 Positive prefix arg KEEP overrides `dired-kept-versions';
3062 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3064 To clear the flags on these files, you can use \\[dired-flag-backup-files]
3065 with a prefix argument."
3068 (autoload 'dired-do-chmod "dired-aux"
3069 "Change the mode of the marked (or next ARG) files.
3070 This calls chmod, thus symbolic modes like `g+w' are allowed."
3073 (autoload 'dired-do-chgrp "dired-aux"
3074 "Change the group of the marked (or next ARG) files."
3077 (autoload 'dired-do-chown "dired-aux"
3078 "Change the owner of the marked (or next ARG) files."
3081 (autoload 'dired-do-touch "dired-aux"
3082 "Change the timestamp of the marked (or next ARG) files."
3085 (autoload 'dired-do-print "dired-aux"
3086 "Print the marked (or next ARG) files.
3087 Uses the shell command coming from variables `lpr-command' and
3088 `lpr-switches' as default."
3091 (autoload 'dired-do-shell-command "dired-aux"
3092 "Run a shell command COMMAND on the marked files.
3093 If no files are marked or a specific numeric prefix arg is given,
3094 the next ARG files are used. Just \\[universal-argument] means the current file.
3095 The prompt mentions the file(s) or the marker, as appropriate.
3097 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3098 COMMAND just once with the entire file list substituted there.
3100 If there is no `*', but there is a `?' in COMMAND, surrounded by
3101 whitespace, this runs COMMAND on each file individually with the
3102 file name substituted for `?'.
3104 Otherwise, this runs COMMAND on each file individually with the
3105 file name added at the end of COMMAND (separated by a space).
3107 `*' and `?' when not surrounded by whitespace have no special
3108 significance for `dired-do-shell-command', and are passed through
3109 normally to the shell, but you must confirm first. To pass `*' by
3110 itself to the shell as a wildcard, type `*\"\"'.
3112 If COMMAND produces output, it goes to a separate buffer.
3114 This feature does not try to redisplay Dired buffers afterward, as
3115 there's no telling what files COMMAND may have changed.
3116 Type \\[dired-do-redisplay] to redisplay the marked files.
3118 When COMMAND runs, its working directory is the top-level directory of
3119 the Dired buffer, so output files usually are created there instead of
3122 In a noninteractive call (from Lisp code), you must specify
3123 the list of file names explicitly with the FILE-LIST argument."
3126 (autoload 'dired-do-kill-lines "dired-aux"
3127 "Kill all marked lines (not the files).
3128 With a prefix arg, kill all lines not marked or flagged."
3131 (autoload 'dired-do-compress "dired-aux"
3132 "Compress or uncompress marked (or next ARG) files."
3135 (autoload 'dired-do-byte-compile "dired-aux"
3136 "Byte compile marked (or next ARG) Emacs Lisp files."
3139 (autoload 'dired-do-load "dired-aux"
3140 "Load the marked (or next ARG) Emacs Lisp files."
3143 (autoload 'dired-do-redisplay "dired-aux"
3144 "Redisplay all marked (or next ARG) files.
3145 If on a subdir line, redisplay that subdirectory. In that case,
3146 a prefix arg lets you edit the `ls' switches used for the new listing."
3149 (autoload 'dired-create-directory "dired-aux"
3150 "Create a directory called DIRECTORY."
3153 (autoload 'dired-do-copy "dired-aux"
3154 "Copy all marked (or next ARG) files, or copy the current file.
3155 Thus, a zero prefix argument copies nothing. But it toggles the
3156 variable `dired-copy-preserve-time' (which see)."
3159 (autoload 'dired-do-symlink "dired-aux"
3160 "Make symbolic links to current file or all marked (or next ARG) files.
3161 When operating on just the current file, you specify the new name.
3162 When operating on multiple or marked files, you specify a directory
3163 and new symbolic links are made in that directory
3164 with the same names that the files currently have."
3167 (autoload 'dired-do-hardlink "dired-aux"
3168 "Add names (hard links) current file or all marked (or next ARG) files.
3169 When operating on just the current file, you specify the new name.
3170 When operating on multiple or marked files, you specify a directory
3171 and new hard links are made in that directory
3172 with the same names that the files currently have."
3175 (autoload 'dired-do-rename "dired-aux"
3176 "Rename current file or all marked (or next ARG) files.
3177 When renaming just the current file, you specify the new name.
3178 When renaming multiple or marked files, you specify a directory."
3181 (autoload 'dired-do-rename-regexp "dired-aux"
3182 "Rename marked files containing REGEXP to NEWNAME.
3183 As each match is found, the user must type a character saying
3184 what to do with it. For directions, type \\[help-command] at that time.
3185 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
3186 REGEXP defaults to the last regexp used.
3187 With a zero prefix arg, renaming by regexp affects the full file name;
3188 usually only the non-directory part of file names is used and changed."
3191 (autoload 'dired-do-copy-regexp "dired-aux"
3192 "Copy all marked files containing REGEXP to NEWNAME.
3193 See function `dired-do-rename-regexp' for more info."
3196 (autoload 'dired-do-hardlink-regexp "dired-aux"
3197 "Hardlink all marked files containing REGEXP to NEWNAME.
3198 See function `dired-do-rename-regexp' for more info."
3201 (autoload 'dired-do-symlink-regexp "dired-aux"
3202 "Symlink all marked files containing REGEXP to NEWNAME.
3203 See function `dired-do-rename-regexp' for more info."
3206 (autoload 'dired-upcase "dired-aux"
3207 "Rename all marked (or next ARG) files to upper case."
3210 (autoload 'dired-downcase "dired-aux"
3211 "Rename all marked (or next ARG) files to lower case."
3214 (autoload 'dired-maybe-insert-subdir "dired-aux"
3215 "Insert this subdirectory into the same dired buffer.
3216 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
3217 else inserts it at its natural place (as `ls -lR' would have done).
3218 With a prefix arg, you may edit the ls switches used for this listing.
3219 You can add `R' to the switches to expand the whole tree starting at
3221 This function takes some pains to conform to `ls -lR' output."
3224 (autoload 'dired-next-subdir "dired-aux"
3225 "Go to next subdirectory, regardless of level."
3228 (autoload 'dired-prev-subdir "dired-aux"
3229 "Go to previous subdirectory, regardless of level.
3230 When called interactively and not on a subdir line, go to this subdir's line."
3233 (autoload 'dired-goto-subdir "dired-aux"
3234 "Go to end of header line of DIR in this dired buffer.
3235 Return value of point on success, otherwise return nil.
3236 The next char is either \\n, or \\r if DIR is hidden."
3239 (autoload 'dired-mark-subdir-files "dired-aux"
3240 "Mark all files except `.' and `..'."
3243 (autoload 'dired-kill-subdir "dired-aux"
3244 "Remove all lines of current subdirectory.
3245 Lower levels are unaffected."
3248 (autoload 'dired-tree-up "dired-aux"
3249 "Go up ARG levels in the dired tree."
3252 (autoload 'dired-tree-down "dired-aux"
3253 "Go down in the dired tree."
3256 (autoload 'dired-hide-subdir "dired-aux"
3257 "Hide or unhide the current subdirectory and move to next directory.
3258 Optional prefix arg is a repeat factor.
3259 Use \\[dired-hide-all] to (un)hide all directories."
3262 (autoload 'dired-hide-all "dired-aux"
3263 "Hide all subdirectories, leaving only their header lines.
3264 If there is already something hidden, make everything visible again.
3265 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
3268 (autoload 'dired-show-file-type "dired-aux"
3269 "Print the type of FILE, according to the `file' command.
3270 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
3271 true then the type of the file linked to by FILE is printed instead."
3274 (autoload 'dired-run-shell-command "dired-aux")
3276 (autoload 'dired-query "dired-aux")
3279 ;;;; Drag and drop support
3281 (defun dired-dnd-test-function (window action types)
3282 "The test function for drag and drop into dired buffers.
3283 WINDOW is where the mouse is when this function is called. It may be a frame
3284 if the mouse is over the menu bar, scroll bar or tool bar.
3285 ACTION is the suggested action from the source, and TYPES are the
3286 types the drop data can have. This function only accepts drops with
3287 types in `x-dnd-known-types'. It returns the action suggested by the source."
3288 (let ((type (x-dnd-choose-type types)))
3293 (defun dired-dnd-popup-notice ()
3296 '("Recursive copies not enabled.\nSee variable dired-recursive-copies."
3300 (defun dired-dnd-do-ask-action (uri)
3301 ;; No need to get actions and descriptions from the source,
3302 ;; we only have three actions anyway.
3303 (let ((action (x-popup-menu
3305 (list "What action?"
3307 '(("Copy here" . copy)
3308 ("Move here" . move)
3309 ("Link here" . link)
3311 ("Cancel" . nil)))))))
3313 (dired-dnd-handle-local-file uri action)
3316 (defun dired-dnd-handle-local-file (uri action)
3317 "Copy, move or link a file to the dired directory.
3318 URI is the file to handle, ACTION is one of copy, move, link or ask.
3319 Ask means pop up a menu for the user to select one of copy, move or link."
3320 (require 'dired-aux)
3321 (let* ((from (x-dnd-get-local-file-name uri t))
3322 (to (if from (concat (dired-current-directory)
3323 (file-name-nondirectory from))
3326 (cond ((or (eq action 'copy)
3327 (eq action 'private)) ; Treat private as copy.
3329 ;; If copying a directory and dired-recursive-copies is nil,
3330 ;; dired-copy-file silently fails. Pop up a notice.
3331 (if (and (file-directory-p from)
3332 (not dired-recursive-copies))
3333 (dired-dnd-popup-notice)
3335 (dired-copy-file from to 1)
3336 (dired-relist-entry to)
3340 (dired-rename-file from to 1)
3341 (dired-relist-entry to)
3345 (make-symbolic-link from to 1)
3346 (dired-relist-entry to)
3350 (dired-dnd-do-ask-action uri))
3354 (defun dired-dnd-handle-file (uri action)
3355 "Copy, move or link a file to the dired directory if it is a local file.
3356 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3357 ACTION is one of copy, move, link or ask.
3358 Ask means pop up a menu for the user to select one of copy, move or link."
3359 (let ((local-file (x-dnd-get-local-file-uri uri)))
3360 (if local-file (dired-dnd-handle-local-file local-file action)
3364 ;;;; Desktop support
3366 (eval-when-compile (require 'desktop))
3368 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3369 "Auxiliary information to be saved in desktop file."
3371 ;; Value of `dired-directory'.
3372 (if (consp dired-directory)
3373 ;; Directory name followed by list of files.
3374 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3375 (cdr dired-directory))
3376 ;; Directory name, optionally with with shell wildcard.
3377 (desktop-file-name dired-directory desktop-dirname))
3378 ;; Subdirectories in `dired-subdir-alist'.
3382 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3383 dired-subdir-alist)))))
3386 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3388 desktop-buffer-misc)
3389 "Restore a dired buffer specified in a desktop file."
3390 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3391 ;; This value is a directory name, optionally with with shell wildcard or
3392 ;; a directory name followed by list of files.
3393 (let* ((dired-dir (car desktop-buffer-misc))
3394 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3395 (if (file-directory-p (file-name-directory dir))
3398 ;; The following elements of `desktop-buffer-misc' are the keys
3399 ;; from `dired-subdir-alist'.
3400 (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3402 (message "Desktop: Directory %s no longer exists." dir)
3403 (when desktop-missing-file-warning (sit-for 1))
3407 (if (eq system-type 'vax-vms)
3412 (run-hooks 'dired-load-hook) ; for your customizations
3414 ;;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3415 ;;; dired.el ends here