1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997, 2000, 2001
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
44 (defgroup dired-mark nil
45 "Handling marks in dired."
51 (defcustom dired-listing-switches "-al"
52 "*Switches passed to `ls' for dired. MUST contain the `l' option.
53 May contain all other options that don't contradict `-l';
54 may contain even `F', `b', `i' and `s'. See also the variable
55 `dired-ls-F-marks-symlinks' concerning the `F' switch."
59 ; Don't use absolute paths as /bin should be in any PATH and people
60 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
61 ; usually not in PATH.
64 (defvar dired-chown-program
65 (if (memq system-type '(hpux dgux usg-unix-v irix linux gnu/linux))
67 (if (file-exists-p "/usr/sbin/chown")
70 "Name of chown command (usually `chown' or `/etc/chown').")
72 (defvar dired-chmod-program "chmod"
73 "Name of chmod command (usually `chmod').")
76 (defcustom dired-ls-F-marks-symlinks nil
77 "*Informs dired about how `ls -lF' marks symbolic links.
78 Set this to t if `ls' (or whatever program is specified by
79 `insert-directory-program') with `-lF' marks the symbolic link
80 itself with a trailing @ (usually the case under Ultrix).
82 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
83 nil (the default), if it gives `bar@ -> foo', set it to t.
85 Dired checks if there is really a @ appended. Thus, if you have a
86 marking `ls' program on one host and a non-marking on another host, and
87 don't care about symbolic links which really end in a @, you can
88 always set this variable to t."
93 (defcustom dired-trivial-filenames "^\\.\\.?$\\|^#"
94 "*Regexp of files to skip when finding first file of a directory.
95 A value of nil means move to the subdir line.
96 A value of t means move to first file."
97 :type '(choice (const :tag "Move to subdir" nil)
98 (const :tag "Move to first" t)
103 (defcustom dired-keep-marker-rename t
104 ;; Use t as default so that moved files "take their markers with them".
105 "*Controls marking of renamed files.
106 If t, files keep their previous marks when they are renamed.
107 If a character, renamed files (whether previously marked or not)
108 are afterward marked with that character."
109 :type '(choice (const :tag "Keep" t)
110 (character :tag "Mark"))
114 (defcustom dired-keep-marker-copy ?C
115 "*Controls marking of copied files.
116 If t, copied files are marked if and as the corresponding original files were.
117 If a character, copied files are unconditionally marked with that character."
118 :type '(choice (const :tag "Keep" t)
119 (character :tag "Mark"))
123 (defcustom dired-keep-marker-hardlink ?H
124 "*Controls marking of newly made hard links.
125 If t, they are marked if and as the files linked to were marked.
126 If a character, new links are unconditionally marked with that character."
127 :type '(choice (const :tag "Keep" t)
128 (character :tag "Mark"))
132 (defcustom dired-keep-marker-symlink ?Y
133 "*Controls marking of newly made symbolic links.
134 If t, they are marked if and as the files linked to were marked.
135 If a character, new links are unconditionally marked with that character."
136 :type '(choice (const :tag "Keep" t)
137 (character :tag "Mark"))
141 (defcustom dired-dwim-target nil
142 "*If non-nil, dired tries to guess a default target directory.
143 This means: if there is a dired buffer displayed in the next window,
144 use its current subdir, instead of the current subdir of this dired buffer.
146 The target is used in the prompt for file copy, rename etc."
151 (defcustom dired-copy-preserve-time t
152 "*If non-nil, Dired preserves the last-modified time in a file copy.
153 \(This works on only some systems.)"
157 (defcustom dired-free-space-program "df"
158 "*Program to get the amount of free space on a file system.
159 We assume the output has the format of `df'.
160 The value of this variable must be just a command name or file name;
161 if you want to specify options, use `dired-free-space-args'.
163 A value of nil disables this feature."
164 :type '(choice (string :tag "Program") (const :tag "None" nil))
167 (defcustom dired-free-space-args "-Pk"
168 "*Options to use when running `dired-free-space-program'."
174 (defvar dired-load-hook nil
175 "Run after loading dired.
176 You can customize key bindings or load extensions with this.")
178 (defvar dired-mode-hook nil
179 "Run at the very end of dired-mode.")
181 (defvar dired-before-readin-hook nil
182 "This hook is run before a dired buffer is read in (created or reverted).")
184 (defvar dired-after-readin-hook nil
185 "Hook run after each time a file or directory is read by Dired.
186 After each listing of a file or directory, this hook is run
187 with the buffer narrowed to the listing.")
188 ;; Note this can't simply be run inside function `dired-ls' as the hook
189 ;; functions probably depend on the dired-subdir-alist to be OK.
191 ;;; Internal variables
193 (defvar dired-marker-char ?* ; the answer is 42
194 ;; so that you can write things like
195 ;; (let ((dired-marker-char ?X))
196 ;; ;; great code using X markers ...
198 ;; For example, commands operating on two sets of files, A and B.
199 ;; Or marking files with digits 0-9. This could implicate
200 ;; concentric sets or an order for the marked files.
201 ;; The code depends on dynamic scoping on the marker char.
202 "In Dired, the current mark character.
203 This is what the `do' commands look for and what the `mark' commands store.")
205 (defvar dired-del-marker ?D
206 "Character used to flag files for deletion.")
208 (defvar dired-shrink-to-fit
210 ;; I see no reason ever to make this nil -- rms.
211 ;; (> baud-rate search-slow-speed)
212 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
214 (defvar dired-flagging-regexp nil);; Last regexp used to flag files.
216 (defvar dired-file-version-alist)
218 (defvar dired-directory nil
219 "The directory name or shell wildcard that was used as argument to `ls'.
220 Local to each dired buffer. May be a list, in which case the car is the
221 directory name and the cdr is the actual files to list.")
223 (defvar dired-actual-switches nil
224 "The value of `dired-listing-switches' used to make this buffer's text.")
226 (defvar dired-re-inode-size "[0-9 \t]*"
227 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
229 ;; These regexps must be tested at beginning-of-line, but are also
230 ;; used to search for next matches, so neither omitting "^" nor
231 ;; replacing "^" by "\n" (to make it slightly faster) will work.
233 (defvar dired-re-mark "^[^ \n]")
234 ;; "Regexp matching a marked line.
235 ;; Important: the match ends just after the marker."
236 (defvar dired-re-maybe-mark "^. ")
237 ;; The [^:] part after "d" and "l" is to avoid confusion with the
238 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
239 (defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d[^:]"))
240 (defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l[^:]"))
241 (defvar dired-re-exe;; match ls permission string of an executable file
244 (concat dired-re-maybe-mark dired-re-inode-size x)))
245 '("-[-r][-w][xs][-r][-w].[-r][-w]."
246 "-[-r][-w].[-r][-w][xs][-r][-w]."
247 "-[-r][-w].[-r][-w].[-r][-w][xst]")
249 (defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
250 (defvar dired-re-dot "^.* \\.\\.?$")
252 ;; The subdirectory names in this list are expanded.
253 (defvar dired-subdir-alist nil
254 "Association list of subdirectories and their buffer positions.
255 Each subdirectory has an element: (DIRNAME . STARTMARKER).
256 The order of elements is the reverse of the order in the buffer.
257 In simple cases, this list contains one element.")
259 (defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
260 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
261 Subexpression 1 is the subdirectory proper, no trailing colon.
262 The match starts at the beginning of the line and ends after the end
263 of the line (\\n or \\r).
264 Subexpression 2 must end right before the \\n or \\r.")
266 (defvar dired-font-lock-keywords
269 ;; Directory headers.
270 (list dired-subdir-regexp '(1 font-lock-type-face))
272 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
273 ;; file name itself. We search for Dired defined regexps, and then use the
274 ;; Dired defined function `dired-move-to-filename' before searching for the
275 ;; simple regexp ".+". It is that regexp which matches the file name.
279 '(0 font-lock-constant-face)
280 '(".+" (dired-move-to-filename) nil (0 font-lock-warning-face)))
281 ;; People who are paranoid about security would consider this more
282 ;; important than other things such as whether it is a directory.
283 ;; But we don't want to encourage paranoia, so our default
284 ;; should be what's most useful for non-paranoids. -- rms.
286 ;;; ;; Files that are group or world writable.
287 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
288 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
289 ;;; '(1 font-lock-comment-face)
290 ;;; '(".+" (dired-move-to-filename) nil (0 font-lock-comment-face)))
294 '(".+" (dired-move-to-filename) nil (0 font-lock-function-name-face)))
298 '(".+" (dired-move-to-filename) nil (0 font-lock-keyword-face)))
300 ;; Files suffixed with `completion-ignored-extensions'.
302 (let ((extensions (mapcar 'regexp-quote completion-ignored-extensions)))
303 ;; It is quicker to first find just an extension, then go back to the
304 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
305 (list (concat "\\(" (mapconcat 'identity extensions "\\|") "\\|#\\)$")
306 '(".+" (dired-move-to-filename) nil (0 font-lock-string-face))))))
307 "Additional expressions to highlight in Dired mode.")
309 ;;; Macros must be defined before they are used, for the byte compiler.
311 ;; Mark all files for which CONDITION evals to non-nil.
312 ;; CONDITION is evaluated on each line, with point at beginning of line.
313 ;; MSG is a noun phrase for the type of files being marked.
314 ;; It should end with a noun that can be pluralized by adding `s'.
315 ;; Return value is the number of files marked, or nil if none were marked.
316 (defmacro dired-mark-if (predicate msg)
317 (` (let (buffer-read-only count)
320 (if (, msg) (message "Marking %ss..." (, msg)))
321 (goto-char (point-min))
326 (insert dired-marker-char)
327 (setq count (1+ count))))
329 (if (, msg) (message "%s %s%s %s%s."
332 (dired-plural-s count)
333 (if (eq dired-marker-char ?\040) "un" "")
334 (if (eq dired-marker-char dired-del-marker)
335 "flagged" "marked"))))
336 (and (> count 0) count))))
338 (defmacro dired-map-over-marks (body arg &optional show-progress)
339 "Eval BODY with point on each marked line. Return a list of BODY's results.
340 If no marked file could be found, execute BODY on the current line.
341 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
342 files instead of the marked files.
343 In that case point is dragged along. This is so that commands on
344 the next ARG (instead of the marked) files can be chained easily.
345 If ARG is otherwise non-nil, use current file instead.
346 If optional third arg SHOW-PROGRESS evaluates to non-nil,
347 redisplay the dired buffer after each file is processed.
348 No guarantee is made about the position on the marked line.
349 BODY must ensure this itself if it depends on this.
350 Search starts at the beginning of the buffer, thus the car of the list
351 corresponds to the line nearest to the buffer's bottom. This
352 is also true for (positive and negative) integer values of ARG.
353 BODY should not be too long as it is expanded four times."
355 ;;Warning: BODY must not add new lines before point - this may cause an
357 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
359 (let (buffer-read-only case-fold-search found results)
362 (progn ;; no save-excursion, want to move point.
363 (dired-repeat-over-lines
366 (if ,show-progress (sit-for 0))
367 (setq results (cons ,body results)))))
371 ;; non-nil, non-integer ARG means use current file:
373 (let ((regexp (dired-marker-regexp)) next-position)
375 (goto-char (point-min))
376 ;; remember position of next marked file before BODY
377 ;; can insert lines before the just found file,
378 ;; confusing us by finding the same marked file again
380 (setq next-position (and (re-search-forward regexp nil t)
382 found (not (null next-position)))
384 (goto-char next-position)
385 (if ,show-progress (sit-for 0))
386 (setq results (cons ,body results))
387 ;; move after last match
388 (goto-char next-position)
390 (set-marker next-position nil)
391 (setq next-position (and (re-search-forward regexp nil t)
396 ;; save-excursion loses, again
397 (dired-move-to-filename)))
399 (defun dired-get-marked-files (&optional localp arg)
400 "Return the marked files' names as list of strings.
401 The list is in the same order as the buffer, that is, the car is the
403 Values returned are normally absolute pathnames.
404 Optional arg LOCALP as in `dired-get-filename'.
405 Optional second argument ARG forces to use other files. If ARG is an
406 integer, use the next ARG files. If ARG is otherwise non-nil, use
407 current file. Usually ARG comes from the current prefix arg."
409 (nreverse (dired-map-over-marks (dired-get-filename localp) arg))))
412 ;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
413 ;; other special applications.
417 (defun dired-read-dir-and-switches (str)
418 ;; For use in interactive.
420 (if current-prefix-arg
421 (read-string "Dired listing switches: "
422 dired-listing-switches))
423 (read-file-name (format "Dired %s(directory): " str)
424 nil default-directory nil))))
426 ;;;###autoload (define-key ctl-x-map "d" 'dired)
428 (defun dired (dirname &optional switches)
429 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
430 Optional second argument SWITCHES specifies the `ls' options used.
431 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
432 Dired displays a list of files in DIRNAME (which may also have
433 shell wildcards appended to select certain files). If DIRNAME is a cons,
434 its first element is taken as the directory name and the rest as an explicit
435 list of files to make directory entries for.
437 You can move around in it with the usual commands.
438 You can flag files for deletion with \\[dired-flag-file-deletion] and then
439 delete them by typing \\[dired-do-flagged-delete].
440 Type \\[describe-mode] after entering dired for more info.
442 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
443 ;; Cannot use (interactive "D") because of wildcards.
444 (interactive (dired-read-dir-and-switches ""))
445 (switch-to-buffer (dired-noselect dirname switches)))
447 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
449 (defun dired-other-window (dirname &optional switches)
450 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
451 (interactive (dired-read-dir-and-switches "in other window "))
452 (switch-to-buffer-other-window (dired-noselect dirname switches)))
454 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
456 (defun dired-other-frame (dirname &optional switches)
457 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
458 (interactive (dired-read-dir-and-switches "in other frame "))
459 (switch-to-buffer-other-frame (dired-noselect dirname switches)))
462 (defun dired-noselect (dir-or-list &optional switches)
463 "Like `dired' but returns the dired buffer as value, does not select it."
464 (or dir-or-list (setq dir-or-list default-directory))
465 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
467 (let (dirname initially-was-dirname)
468 (if (consp dir-or-list)
469 (setq dirname (car dir-or-list))
470 (setq dirname dir-or-list))
471 (setq initially-was-dirname
472 (string= (file-name-as-directory dirname) dirname))
473 (setq dirname (abbreviate-file-name
474 (expand-file-name (directory-file-name dirname))))
475 (if find-file-visit-truename
476 (setq dirname (file-truename dirname)))
477 ;; If the argument was syntactically a directory name not a file name,
478 ;; or if it happens to name a file that is a directory,
479 ;; convert it syntactically to a directory name.
480 ;; The reason for checking initially-was-dirname
481 ;; and not just file-directory-p
482 ;; is that file-directory-p is slow over ftp.
483 (if (or initially-was-dirname (file-directory-p dirname))
484 (setq dirname (file-name-as-directory dirname)))
485 (if (consp dir-or-list)
486 (setq dir-or-list (cons dirname (cdr dir-or-list)))
487 (setq dir-or-list dirname))
488 (dired-internal-noselect dir-or-list switches)))
490 ;; Separate function from dired-noselect for the sake of dired-vms.el.
491 (defun dired-internal-noselect (dir-or-list &optional switches mode)
492 ;; If there is an existing dired buffer for DIRNAME, just leave
493 ;; buffer as it is (don't even call dired-revert).
494 ;; This saves time especially for deep trees or with ange-ftp.
495 ;; The user can type `g'easily, and it is more consistent with find-file.
496 ;; But if SWITCHES are given they are probably different from the
497 ;; buffer's old value, so call dired-sort-other, which does
498 ;; revert the buffer.
499 ;; A pity we can't possibly do "Directory has changed - refresh? "
500 ;; like find-file does.
501 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
503 (let* ((dirname (if (consp dir-or-list) (car dir-or-list) dir-or-list))
504 ;; The following line used to use dir-or-list.
505 ;; That never found an existing buffer, in the case
506 ;; where it is a list.
507 (buffer (dired-find-buffer-nocreate dirname mode))
508 ;; note that buffer already is in dired-mode, if found
509 (new-buffer-p (not buffer))
510 (old-buf (current-buffer)))
512 (let ((default-major-mode 'fundamental-mode))
513 ;; We don't want default-major-mode to run hooks and set auto-fill
514 ;; or whatever, now that dired-mode does not
515 ;; kill-all-local-variables any longer.
516 (setq buffer (create-file-buffer (directory-file-name dirname)))))
518 (if (not new-buffer-p) ; existing buffer ...
519 (cond (switches ; ... but new switches
520 ;; file list may have changed
521 (if (consp dir-or-list)
522 (setq dired-directory dir-or-list))
523 ;; this calls dired-revert
524 (dired-sort-other switches))
525 ;; If directory has changed on disk, offer to revert.
526 ((if (let ((attributes (file-attributes dirname))
527 (modtime (visited-file-modtime)))
529 (not (eq (car attributes) t))
530 (and (= (car (nth 5 attributes)) (car modtime))
531 (= (nth 1 (nth 5 attributes)) (cdr modtime)))))
534 (substitute-command-keys
535 "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
537 (setq default-directory
538 ;; We can do this unconditionally
539 ;; because dired-noselect ensures that the name
540 ;; is passed in directory name syntax
541 ;; if it was the name of a directory at all.
542 (file-name-directory dirname))
543 (or switches (setq switches dired-listing-switches))
544 (if mode (funcall mode)
545 (dired-mode dirname switches))
546 ;; default-directory and dired-actual-switches are set now
547 ;; (buffer-local), so we can call dired-readin:
550 (progn (dired-readin dir-or-list buffer)
552 ;; dired-readin can fail if parent directories are inaccessible.
553 ;; Don't leave an empty buffer around in that case.
554 (if failed (kill-buffer buffer))))
555 ;; No need to narrow since the whole buffer contains just
556 ;; dired-readin's output, nothing else. The hook can
557 ;; successfully use dired functions (e.g. dired-get-filename)
558 ;; as the subdir-alist has been built in dired-readin.
559 (run-hooks 'dired-after-readin-hook)
560 (goto-char (point-min))
561 (dired-initial-position dirname))
565 (defvar dired-buffers nil
566 ;; Enlarged by dired-advertise
567 ;; Queried by function dired-buffers-for-dir. When this detects a
568 ;; killed buffer, it is removed from this list.
569 "Alist of expanded directories and their associated dired buffers.")
571 (defun dired-find-buffer-nocreate (dirname &optional mode)
572 ;; This differs from dired-buffers-for-dir in that it does not consider
573 ;; subdirs of default-directory and searches for the first match only.
574 ;; Also, the major mode must be MODE.
575 (let (found (blist dired-buffers)) ; was (buffer-list)
576 (or mode (setq mode 'dired-mode))
578 (if (null (buffer-name (cdr (car blist))))
579 (setq blist (cdr blist))
581 (set-buffer (cdr (car blist)))
582 (if (and (eq major-mode mode)
583 (if (consp dired-directory)
584 (equal (car dired-directory) dirname)
585 (equal dired-directory dirname)))
586 (setq found (cdr (car blist))
588 (setq blist (cdr blist))))))
592 ;; Read in a new dired buffer
594 ;; dired-readin differs from dired-insert-subdir in that it accepts
595 ;; wildcards, erases the buffer, and builds the subdir-alist anew
596 ;; (including making it buffer-local and clearing it first).
597 (defun dired-readin (dir-or-list buffer)
598 ;; default-directory and dired-actual-switches must be buffer-local
599 ;; and initialized by now.
600 ;; Thus we can test (equal default-directory dirname) instead of
601 ;; (file-directory-p dirname) and save a filesystem transaction.
602 ;; Also, we can run this hook which may want to modify the switches
603 ;; based on default-directory, e.g. with ange-ftp to a SysV host
604 ;; where ls won't understand -Al switches.
606 (indent-tabs-mode nil))
607 (if (consp dir-or-list)
608 (setq dirname (car dir-or-list))
609 (setq dirname dir-or-list))
610 (setq dirname (expand-file-name dirname))
611 (if (consp dir-or-list)
612 (setq dir-or-list (cons dirname (cdr dir-or-list))))
613 (run-hooks 'dired-before-readin-hook)
615 (message "Reading directory %s..." dirname)
617 (let (buffer-read-only (failed t))
620 (dired-readin-insert dir-or-list)
621 (indent-rigidly (point-min) (point-max) 2)
622 ;; We need this to make the root dir have a header line as all
623 ;; other subdirs have:
624 (goto-char (point-min))
625 (if (not (looking-at "^ /.*:$"))
626 (dired-insert-headerline default-directory))
627 ;; can't run dired-after-readin-hook here, it may depend on the subdir
630 (message "Reading directory %s...done" dirname)
631 ;; Must first make alist buffer local and set it to nil because
632 ;; dired-build-subdir-alist will call dired-clear-alist first
633 (set (make-local-variable 'dired-subdir-alist) nil)
634 (dired-build-subdir-alist)
635 (let ((attributes (file-attributes dirname)))
636 (if (eq (car attributes) t)
637 (set-visited-file-modtime (nth 5 attributes))))
638 (set-buffer-modified-p nil))))
640 ;; Subroutines of dired-readin
642 (defun dired-readin-insert (dir-or-list)
643 ;; Just insert listing for the passed-in directory or
644 ;; directory-and-file list, assuming a clean buffer.
646 (if (consp dir-or-list)
647 (setq dirname (car dir-or-list))
648 (setq dirname dir-or-list))
649 ;; Expand before comparing in case one or both have been abbreviated.
650 (if (and (equal (expand-file-name default-directory)
651 (expand-file-name dirname))
652 (not (consp dir-or-list)))
653 ;; If we are reading a whole single directory...
654 (dired-insert-directory dir-or-list dired-actual-switches nil t)
655 (if (not (file-readable-p
656 (directory-file-name (file-name-directory dirname))))
657 (error "Directory %s inaccessible or nonexistent" dirname)
658 ;; Else assume it contains wildcards,
659 ;; unless it is an explicit list of files.
660 (dired-insert-directory dir-or-list dired-actual-switches
661 (not (listp dir-or-list)))
662 (or (consp dir-or-list)
663 (save-excursion ;; insert wildcard instead of total line:
664 (goto-char (point-min))
665 (insert "wildcard " (file-name-nondirectory dirname) "\n")))))))
667 (defun dired-insert-directory (dir-or-list switches &optional wildcard full-p)
668 ;; Do the right thing whether dir-or-list is atomic or not. If it is,
669 ;; inset all files listed in the cdr (the car is the passed-in directory
671 (let ((opoint (point))
672 (process-environment (copy-sequence process-environment))
674 ;; We used to specify the C locale here, to force English month names;
675 ;; but this should not be necessary any more,
676 ;; with the new value of dired-move-to-filename-regexp.
677 (if (consp dir-or-list)
678 ;; In this case, use the file names in the cdr
679 ;; exactly as originally given to dired-noselect.
681 (function (lambda (x) (insert-directory x switches wildcard full-p)))
683 ;; Expand the file name here because it may have been abbreviated
684 ;; in dired-noselect.
685 (insert-directory (expand-file-name dir-or-list) switches wildcard full-p)
686 (when (and full-p dired-free-space-program)
688 (goto-char (point-min))
689 (when (re-search-forward "total [0-9]+$" nil t)
691 ;; Non-Posix systems don't always have dired-free-space-program,
692 ;; but might have an equivalent system call.
693 (if (fboundp 'file-system-info)
695 (fsinfo (file-system-info dir-or-list)))
698 (format "%.0f" (/ (nth 2 fsinfo) 1024)))
699 ;; file-system-info failed; delete " free ".
700 (delete-region (- beg 7) beg)))
703 (if (zerop (call-process dired-free-space-program nil t nil
704 dired-free-space-args
705 (expand-file-name dir-or-list)))
709 (skip-chars-forward "^ \t")
711 (skip-chars-forward " \t")
712 (delete-region beg (point))
714 (delete-region (point)
715 (progn (forward-line 1) (point))))
716 ;; The dired-free-space-program failed; delete its output
717 (delete-region (- beg 7) (point)))
718 (error (delete-region (- beg 7) (point))))))))))
719 ;; Quote certain characters, unless ls quoted them for us.
720 (if (not (string-match "b" dired-actual-switches))
722 (setq end (point-marker))
724 (while (search-forward "\\" end t)
725 (replace-match "\\\\" nil t))
727 (while (search-forward "\^m" end t)
728 (replace-match "\\015" nil t))
729 (set-marker end nil)))
730 (dired-insert-set-properties opoint (point)))
731 (setq dired-directory dir-or-list))
733 ;; Make the file names highlight when the mouse is on them.
734 (defun dired-insert-set-properties (beg end)
737 (while (< (point) end)
739 (if (dired-move-to-filename)
743 (dired-move-to-end-of-filename)
745 '(mouse-face highlight
746 help-echo "mouse-2: visit this file in other window")))
750 (defun dired-insert-headerline (dir);; also used by dired-insert-subdir
751 ;; Insert DIR's headerline with no trailing slash, exactly like ls
752 ;; would, and put cursor where dired-build-subdir-alist puts subdir
754 (save-excursion (insert " " (directory-file-name dir) ":\n")))
757 ;; Reverting a dired buffer
759 (defun dired-revert (&optional arg noconfirm)
760 ;; Reread the dired buffer. Must also be called after
761 ;; dired-actual-switches have changed.
762 ;; Should not fail even on completely garbaged buffers.
763 ;; Preserves old cursor, marks/flags, hidden-p.
764 (widen) ; just in case user narrowed
765 (let ((opoint (point))
766 (ofile (dired-get-filename nil t))
767 (mark-alist nil) ; save marked files
768 (hidden-subdirs (dired-remember-hidden))
769 (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
770 (case-fold-search nil) ; we check for upper case ls flags
772 (goto-char (point-min))
773 (setq mark-alist;; only after dired-remember-hidden since this unhides:
774 (dired-remember-marks (point-min) (point-max)))
775 ;; treat top level dir extra (it may contain wildcards)
777 (if (consp dired-directory) (car dired-directory) dired-directory))
778 (dired-readin dired-directory (current-buffer))
779 (let ((dired-after-readin-hook nil))
780 ;; don't run that hook for each subdir...
781 (dired-insert-old-subdirs old-subdir-alist))
782 (dired-mark-remembered mark-alist) ; mark files that were marked
783 ;; ... run the hook for the whole buffer, and only after markers
784 ;; have been reinserted (else omitting in dired-x would omit marked files)
785 (run-hooks 'dired-after-readin-hook) ; no need to narrow
786 (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
787 (goto-char opoint)) ; was before
788 (dired-move-to-filename)
789 (save-excursion ; hide subdirs that were hidden
790 (mapcar (function (lambda (dir)
791 (if (dired-goto-subdir dir)
792 (dired-hide-subdir 1))))
794 ;; outside of the let scope
795 ;;; Might as well not override the user if the user changed this.
796 ;;; (setq buffer-read-only t)
799 ;; Subroutines of dired-revert
800 ;; Some of these are also used when inserting subdirs.
802 (defun dired-remember-marks (beg end)
803 ;; Return alist of files and their marks, from BEG to END.
804 (if selective-display ; must unhide to make this work.
805 (let (buffer-read-only)
806 (subst-char-in-region beg end ?\r ?\n)))
810 (while (re-search-forward dired-re-mark end t)
811 (if (setq fil (dired-get-filename nil t))
812 (setq chr (preceding-char)
813 alist (cons (cons fil chr) alist)))))
816 ;; Mark all files remembered in ALIST.
817 ;; Each element of ALIST looks like (FILE . MARKERCHAR).
818 (defun dired-mark-remembered (alist)
821 (setq elt (car alist)
825 (if (dired-goto-file fil)
831 ;; Return a list of names of subdirs currently hidden.
832 (defun dired-remember-hidden ()
833 (let ((l dired-subdir-alist) dir pos result)
835 (setq dir (car (car l))
839 (skip-chars-forward "^\r\n")
840 (if (eq (following-char) ?\r)
841 (setq result (cons dir result))))
844 ;; Try to insert all subdirs that were displayed before,
845 ;; according to the former subdir alist OLD-SUBDIR-ALIST.
846 (defun dired-insert-old-subdirs (old-subdir-alist)
847 (or (string-match "R" dired-actual-switches)
849 (while old-subdir-alist
850 (setq elt (car old-subdir-alist)
851 old-subdir-alist (cdr old-subdir-alist)
856 (dired-insert-subdir dir))
859 ;; Remove directory DIR from any directory cache.
860 (defun dired-uncache (dir)
861 (let ((handler (find-file-name-handler dir 'dired-uncache)))
863 (funcall handler 'dired-uncache dir))))
865 ;; dired mode key bindings and initialization
867 (defvar dired-mode-map nil "Local keymap for dired-mode buffers.")
870 ;; This looks ugly when substitute-command-keys uses C-d instead d:
871 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
873 (let ((map (make-keymap)))
874 (suppress-keymap map)
875 (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
876 ;; Commands to mark or flag certain categories of files
877 (define-key map "#" 'dired-flag-auto-save-files)
878 (define-key map "." 'dired-clean-directory)
879 (define-key map "~" 'dired-flag-backup-files)
880 (define-key map "&" 'dired-flag-garbage-files)
881 ;; Upper case keys (except !) for operating on the marked files
882 (define-key map "A" 'dired-do-search)
883 (define-key map "C" 'dired-do-copy)
884 (define-key map "B" 'dired-do-byte-compile)
885 (define-key map "D" 'dired-do-delete)
886 (define-key map "G" 'dired-do-chgrp)
887 (define-key map "H" 'dired-do-hardlink)
888 (define-key map "L" 'dired-do-load)
889 (define-key map "M" 'dired-do-chmod)
890 (define-key map "O" 'dired-do-chown)
891 (define-key map "P" 'dired-do-print)
892 (define-key map "Q" 'dired-do-query-replace-regexp)
893 (define-key map "R" 'dired-do-rename)
894 (define-key map "S" 'dired-do-symlink)
895 (define-key map "X" 'dired-do-shell-command)
896 (define-key map "Z" 'dired-do-compress)
897 (define-key map "!" 'dired-do-shell-command)
898 ;; Comparison commands
899 (define-key map "=" 'dired-diff)
900 (define-key map "\M-=" 'dired-backup-diff)
901 ;; Tree Dired commands
902 (define-key map "\M-\C-?" 'dired-unmark-all-files)
903 (define-key map "\M-\C-d" 'dired-tree-down)
904 (define-key map "\M-\C-u" 'dired-tree-up)
905 (define-key map "\M-\C-n" 'dired-next-subdir)
906 (define-key map "\M-\C-p" 'dired-prev-subdir)
907 ;; move to marked files
908 (define-key map "\M-{" 'dired-prev-marked-file)
909 (define-key map "\M-}" 'dired-next-marked-file)
910 ;; Make all regexp commands share a `%' prefix:
911 ;; We used to get to the submap via a symbol dired-regexp-prefix,
912 ;; but that seems to serve little purpose, and copy-keymap
913 ;; does a better job without it.
914 (define-key map "%" nil)
915 (define-key map "%u" 'dired-upcase)
916 (define-key map "%l" 'dired-downcase)
917 (define-key map "%d" 'dired-flag-files-regexp)
918 (define-key map "%g" 'dired-mark-files-containing-regexp)
919 (define-key map "%m" 'dired-mark-files-regexp)
920 (define-key map "%r" 'dired-do-rename-regexp)
921 (define-key map "%C" 'dired-do-copy-regexp)
922 (define-key map "%H" 'dired-do-hardlink-regexp)
923 (define-key map "%R" 'dired-do-rename-regexp)
924 (define-key map "%S" 'dired-do-symlink-regexp)
925 ;; Commands for marking and unmarking.
926 (define-key map "*" nil)
927 (define-key map "**" 'dired-mark-executables)
928 (define-key map "*/" 'dired-mark-directories)
929 (define-key map "*@" 'dired-mark-symlinks)
930 (define-key map "*%" 'dired-mark-files-regexp)
931 (define-key map "*c" 'dired-change-marks)
932 (define-key map "*s" 'dired-mark-subdir-files)
933 (define-key map "*m" 'dired-mark)
934 (define-key map "*u" 'dired-unmark)
935 (define-key map "*?" 'dired-unmark-all-files)
936 (define-key map "*!" 'dired-unmark-all-marks)
937 (define-key map "*\177" 'dired-unmark-backward)
938 (define-key map "*\C-n" 'dired-next-marked-file)
939 (define-key map "*\C-p" 'dired-prev-marked-file)
940 (define-key map "*t" 'dired-do-toggle)
941 ;; Lower keys for commands not operating on all the marked files
942 (define-key map "a" 'dired-find-alternate-file)
943 (define-key map "d" 'dired-flag-file-deletion)
944 (define-key map "e" 'dired-find-file)
945 (define-key map "f" 'dired-find-file)
946 (define-key map "\C-m" 'dired-advertised-find-file)
947 (define-key map "g" 'revert-buffer)
948 (define-key map "h" 'describe-mode)
949 (define-key map "i" 'dired-maybe-insert-subdir)
950 (define-key map "k" 'dired-do-kill-lines)
951 (define-key map "l" 'dired-do-redisplay)
952 (define-key map "m" 'dired-mark)
953 (define-key map "n" 'dired-next-line)
954 (define-key map "o" 'dired-find-file-other-window)
955 (define-key map "\C-o" 'dired-display-file)
956 (define-key map "p" 'dired-previous-line)
957 (define-key map "q" 'quit-window)
958 (define-key map "s" 'dired-sort-toggle-or-edit)
959 (define-key map "t" 'dired-do-toggle)
960 (define-key map "u" 'dired-unmark)
961 (define-key map "v" 'dired-view-file)
962 (define-key map "x" 'dired-do-flagged-delete)
963 (define-key map "y" 'dired-show-file-type)
964 (define-key map "+" 'dired-create-directory)
966 (define-key map "<" 'dired-prev-dirline)
967 (define-key map ">" 'dired-next-dirline)
968 (define-key map "^" 'dired-up-directory)
969 (define-key map " " 'dired-next-line)
970 (define-key map "\C-n" 'dired-next-line)
971 (define-key map "\C-p" 'dired-previous-line)
972 (define-key map [down] 'dired-next-line)
973 (define-key map [up] 'dired-previous-line)
975 (define-key map "$" 'dired-hide-subdir)
976 (define-key map "\M-$" 'dired-hide-all)
978 (define-key map "?" 'dired-summary)
979 (define-key map "\177" 'dired-unmark-backward)
980 (define-key map "\C-_" 'dired-undo)
981 (define-key map "\C-xu" 'dired-undo)
983 ;; Make menu bar items.
985 ;; No need to fo this, now that top-level items are fewer.
987 ;; Get rid of the Edit menu bar item to save space.
988 ;(define-key map [menu-bar edit] 'undefined)
990 (define-key map [menu-bar subdir]
991 (cons "Subdir" (make-sparse-keymap "Subdir")))
993 (define-key map [menu-bar subdir hide-all]
994 '(menu-item "Hide All" dired-hide-all
995 :help "Hide all subdirectories, leave only header lines"))
996 (define-key map [menu-bar subdir hide-subdir]
997 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
998 :help "Hide or unhide current directory listing"))
999 (define-key map [menu-bar subdir tree-down]
1000 '(menu-item "Tree Down" dired-tree-down
1001 :help "Go to first subdirectory header down the tree"))
1002 (define-key map [menu-bar subdir tree-up]
1003 '(menu-item "Tree Up" dired-tree-up
1004 :help "Go to first subdirectory header up the tree"))
1005 (define-key map [menu-bar subdir up]
1006 '(menu-item "Up Directory" dired-up-directory
1007 :help "Edit the parent directory"))
1008 (define-key map [menu-bar subdir prev-subdir]
1009 '(menu-item "Prev Subdir" dired-prev-subdir
1010 :help "Go to previous subdirectory header line"))
1011 (define-key map [menu-bar subdir next-subdir]
1012 '(menu-item "Next Subdir" dired-next-subdir
1013 :help "Go to next subdirectory header line"))
1014 (define-key map [menu-bar subdir prev-dirline]
1015 '(menu-item "Prev Dirline" dired-prev-dirline
1016 :help "Move to next directory-file line"))
1017 (define-key map [menu-bar subdir next-dirline]
1018 '(menu-item "Next Dirline" dired-next-dirline
1019 :help "Move to previous directory-file line"))
1020 (define-key map [menu-bar subdir insert]
1021 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1022 :help "Insert contents of subdirectory"))
1024 (define-key map [menu-bar immediate]
1025 (cons "Immediate" (make-sparse-keymap "Immediate")))
1027 (define-key map [menu-bar immediate revert-buffer]
1028 '(menu-item "Refresh" revert-buffer
1029 :help "Update contents of shown directories"))
1031 (define-key map [menu-bar immediate dashes]
1034 (define-key map [menu-bar immediate backup-diff]
1035 '(menu-item "Compare with Backup" dired-backup-diff
1036 :help "Diff file at cursor with its latest backup"))
1037 (define-key map [menu-bar immediate diff]
1038 '(menu-item "Diff..." dired-diff
1039 :help "Compare file at cursor with another file"))
1040 (define-key map [menu-bar immediate view]
1041 '(menu-item "View This File" dired-view-file
1042 :help "Examine file at cursor in read-only mode"))
1043 (define-key map [menu-bar immediate display]
1044 '(menu-item "Display in Other Window" dired-display-file
1045 :help "Display file at cursor in other window"))
1046 (define-key map [menu-bar immediate find-file-other-window]
1047 '(menu-item "Find in Other Window" dired-find-file-other-window
1048 :help "Edit file at cursor in other window"))
1049 (define-key map [menu-bar immediate find-file]
1050 '(menu-item "Find This File" dired-find-file
1051 :help "Edit file at cursor"))
1052 (define-key map [menu-bar immediate create-directory]
1053 '(menu-item "Create Directory..." dired-create-directory))
1055 (define-key map [menu-bar regexp]
1056 (cons "Regexp" (make-sparse-keymap "Regexp")))
1058 (define-key map [menu-bar regexp downcase]
1059 '(menu-item "Downcase" dired-downcase
1060 ;; When running on plain MS-DOS, there's only one
1061 ;; letter-case for file names.
1062 :enable (or (not (fboundp 'msdos-long-file-names))
1063 (msdos-long-file-names))
1064 :help "Rename marked files to lower-case name"))
1065 (define-key map [menu-bar regexp upcase]
1066 '(menu-item "Upcase" dired-upcase
1067 :enable (or (not (fboundp 'msdos-long-file-names))
1068 (msdos-long-file-names))
1069 :help "Rename marked files to upper-case name"))
1070 (define-key map [menu-bar regexp hardlink]
1071 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1072 :help "Make hard links for files matching regexp"))
1073 (define-key map [menu-bar regexp symlink]
1074 '(menu-item "Symlink..." dired-do-symlink-regexp
1075 :visible (fboundp 'make-symbolic-link)
1076 :help "Make symbolic links for files matching regexp"))
1077 (define-key map [menu-bar regexp rename]
1078 '(menu-item "Rename..." dired-do-rename-regexp
1079 :help "Rename marked files matching regexp"))
1080 (define-key map [menu-bar regexp copy]
1081 '(menu-item "Copy..." dired-do-copy-regexp
1082 :help "Copy marked files matching regexp"))
1083 (define-key map [menu-bar regexp flag]
1084 '(menu-item "Flag..." dired-flag-files-regexp
1085 :help "Flag files matching regexp for deletion"))
1086 (define-key map [menu-bar regexp mark]
1087 '(menu-item "Mark..." dired-mark-files-regexp
1088 :help "Mark files matching regexp for future operations"))
1089 (define-key map [menu-bar regexp mark-cont]
1090 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1091 :help "Mark files whose contents matches regexp"))
1093 (define-key map [menu-bar mark]
1094 (cons "Mark" (make-sparse-keymap "Mark")))
1096 (define-key map [menu-bar mark prev]
1097 '(menu-item "Previous Marked" dired-prev-marked-file
1098 :help "Move to previous marked file"))
1099 (define-key map [menu-bar mark next]
1100 '(menu-item "Next Marked" dired-next-marked-file
1101 :help "Move to next marked file"))
1102 (define-key map [menu-bar mark marks]
1103 '(menu-item "Change Marks..." dired-change-marks
1104 :help "Replace marker with another character"))
1105 (define-key map [menu-bar mark unmark-all]
1106 '(menu-item "Unmark All" dired-unmark-all-marks))
1107 (define-key map [menu-bar mark symlinks]
1108 '(menu-item "Mark Symlinks" dired-mark-symlinks
1109 :visible (fboundp 'make-symbolic-link)
1110 :help "Mark all symbolic links"))
1111 (define-key map [menu-bar mark directories]
1112 '(menu-item "Mark Directories" dired-mark-directories
1113 :help "Mark all directories except `.' and `..'"))
1114 (define-key map [menu-bar mark directory]
1115 '(menu-item "Mark Old Backups" dired-clean-directory
1116 :help "Flag old numbered backups for deletion"))
1117 (define-key map [menu-bar mark executables]
1118 '(menu-item "Mark Executables" dired-mark-executables
1119 :help "Mark all executable files"))
1120 (define-key map [menu-bar mark garbage-files]
1121 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1122 :help "Flag unneeded files for deletion"))
1123 (define-key map [menu-bar mark backup-files]
1124 '(menu-item "Flag Backup Files" dired-flag-backup-files
1125 :help "Flag all backup files for deletion"))
1126 (define-key map [menu-bar mark auto-save-files]
1127 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1128 :help "Flag auto-save files for deletion"))
1129 (define-key map [menu-bar mark deletion]
1130 '(menu-item "Flag" dired-flag-file-deletion
1131 :help "Flag current line's file for deletion"))
1132 (define-key map [menu-bar mark unmark]
1133 '(menu-item "Unmark" dired-unmark
1134 :help "Unmark or unflag current line's file"))
1135 (define-key map [menu-bar mark mark]
1136 '(menu-item "Mark" dired-mark
1137 :help "Mark current line's file for future operations"))
1138 (define-key map [menu-bar mark toggle-marks]
1139 '(menu-item "Toggle Marks" dired-do-toggle
1140 :help "Mark unmarked files, unmark marked ones"))
1142 (define-key map [menu-bar operate]
1143 (cons "Operate" (make-sparse-keymap "Operate")))
1145 (define-key map [menu-bar operate query-replace]
1146 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1147 :help "Replace regexp in marked files"))
1148 (define-key map [menu-bar operate search]
1149 '(menu-item "Search Files..." dired-do-search
1150 :help "Search marked files for regexp"))
1151 (define-key map [menu-bar operate chown]
1152 '(menu-item "Change Owner..." dired-do-chown
1153 :visible (not (memq system-type '(ms-dos windows-nt)))
1154 :help "Change the owner of marked files"))
1155 (define-key map [menu-bar operate chgrp]
1156 '(menu-item "Change Group..." dired-do-chgrp
1157 :visible (not (memq system-type '(ms-dos windows-nt)))
1158 :help "Change the group of marked files"))
1159 (define-key map [menu-bar operate chmod]
1160 '(menu-item "Change Mode..." dired-do-chmod
1161 :help "Change mode (attributes) of marked files"))
1162 (define-key map [menu-bar operate load]
1163 '(menu-item "Load" dired-do-load
1164 :help "Load marked Emacs Lisp files"))
1165 (define-key map [menu-bar operate compile]
1166 '(menu-item "Byte-compile" dired-do-byte-compile
1167 :help "Byte-compile marked Emacs Lisp files"))
1168 (define-key map [menu-bar operate compress]
1169 '(menu-item "Compress" dired-do-compress
1170 :help "Compress/uncompress marked files"))
1171 (define-key map [menu-bar operate print]
1172 '(menu-item "Print..." dired-do-print
1173 :help "Ask for print command and print marked files"))
1174 (define-key map [menu-bar operate hardlink]
1175 '(menu-item "Hardlink to..." dired-do-hardlink
1176 :help "Make hard links for current or marked files"))
1177 (define-key map [menu-bar operate symlink]
1178 '(menu-item "Symlink to..." dired-do-symlink
1179 :visible (fboundp 'make-symbolic-link)
1180 :help "Make symbolic links for current or marked files"))
1181 (define-key map [menu-bar operate command]
1182 '(menu-item "Shell Command..." dired-do-shell-command
1183 :help "Run a shell command on each of marked files"))
1184 (define-key map [menu-bar operate delete]
1185 '(menu-item "Delete" dired-do-delete
1186 :help "Delete current file or all marked files"))
1187 (define-key map [menu-bar operate rename]
1188 '(menu-item "Rename to..." dired-do-rename
1189 :help "Rename current file or move marked files"))
1190 (define-key map [menu-bar operate copy]
1191 '(menu-item "Copy to..." dired-do-copy
1192 :help "Copy current file or all marked files"))
1194 (setq dired-mode-map map)))
1196 ;; Dired mode is suitable only for specially formatted data.
1197 (put 'dired-mode 'mode-class 'special)
1199 (defun dired-mode (&optional dirname switches)
1201 Mode for \"editing\" directory listings.
1202 In dired, you are \"editing\" a list of the files in a directory and
1203 \(optionally) its subdirectories, in the format of `ls -lR'.
1204 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1205 \"Editing\" means that you can run shell commands on files, visit,
1206 compress, load or byte-compile them, change their file attributes
1207 and insert subdirectories into the same buffer. You can \"mark\"
1208 files for later commands or \"flag\" them for deletion, either file
1209 by file or all files matching certain criteria.
1210 You can move using the usual cursor motion commands.\\<dired-mode-map>
1211 Letters no longer insert themselves. Digits are prefix arguments.
1212 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1213 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1214 Most commands operate on the marked files and use the current file
1215 if no files are marked. Use a numeric prefix argument to operate on
1216 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1217 to operate on the current file only. Prefix arguments override marks.
1218 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1219 to see why something went wrong.
1220 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1221 Type \\[dired-unmark-backward] to back up one line and unflag.
1222 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1223 Type \\[dired-advertised-find-file] to Find the current line's file
1224 (or dired it in another buffer, if it is a directory).
1225 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1226 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1227 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1228 Type \\[dired-do-copy] to Copy files.
1229 Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
1230 Type \\[revert-buffer] to read all currently expanded directories again.
1231 This retains all marks and hides subdirs again that were hidden before.
1232 SPC and DEL can be used to move down and up by lines.
1234 If dired ever gets confused, you can either type \\[revert-buffer] \
1236 directories again, type \\[dired-do-redisplay] \
1237 to relist a single or the marked files or a
1238 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1239 again for the directory tree.
1241 Customization variables (rename this buffer and type \\[describe-variable] on each line
1244 dired-listing-switches
1245 dired-trivial-filenames
1249 dired-keep-marker-rename
1250 dired-keep-marker-copy
1251 dired-keep-marker-hardlink
1252 dired-keep-marker-symlink
1254 Hooks (use \\[describe-variable] to see their documentation):
1256 dired-before-readin-hook
1257 dired-after-readin-hook
1263 ;; Not to be called interactively (e.g. dired-directory will be set
1264 ;; to default-directory, which is wrong with wildcards).
1265 (kill-all-local-variables)
1266 (use-local-map dired-mode-map)
1267 (dired-advertise) ; default-directory is already set
1268 (setq major-mode 'dired-mode
1270 ;; case-fold-search nil
1272 selective-display t ; for subdirectory hiding
1273 mode-line-buffer-identification
1274 (propertized-buffer-identification "%17b"))
1275 (set (make-local-variable 'revert-buffer-function)
1276 (function dired-revert))
1277 (set (make-local-variable 'page-delimiter)
1279 (set (make-local-variable 'dired-directory)
1280 (or dirname default-directory))
1281 ;; list-buffers uses this to display the dir being edited in this buffer.
1282 (set (make-local-variable 'list-buffers-directory)
1283 (expand-file-name dired-directory))
1284 (set (make-local-variable 'dired-actual-switches)
1285 (or switches dired-listing-switches))
1286 (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
1287 (dired-sort-other dired-actual-switches t)
1288 (run-hooks 'dired-mode-hook))
1290 ;; Idiosyncratic dired commands that don't deal with marks.
1292 (defun dired-summary ()
1293 "Summarize basic Dired commands and show recent Dired errors."
1296 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1298 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1300 (defun dired-undo ()
1301 "Undo in a dired buffer.
1302 This doesn't recover lost files, it just undoes changes in the buffer itself.
1303 You can use it to recover marks, killed lines or subdirs.
1304 In the latter case, you have to do \\[dired-build-subdir-alist] to
1305 parse the buffer again."
1307 (let (buffer-read-only)
1310 (defun dired-next-line (arg)
1311 "Move down lines then position at filename.
1312 Optional prefix ARG says how many lines to move; default is one line."
1315 (dired-move-to-filename))
1317 (defun dired-previous-line (arg)
1318 "Move up lines then position at filename.
1319 Optional prefix ARG says how many lines to move; default is one line."
1322 (dired-move-to-filename))
1324 (defun dired-next-dirline (arg &optional opoint)
1325 "Goto ARG'th next directory file line."
1327 (or opoint (setq opoint (point)))
1329 (re-search-forward dired-re-dir nil t arg)
1331 (re-search-backward dired-re-dir nil t (- arg)))
1332 (dired-move-to-filename) ; user may type `i' or `f'
1334 (error "No more subdirectories")))
1336 (defun dired-prev-dirline (arg)
1337 "Goto ARG'th previous directory file line."
1339 (dired-next-dirline (- arg)))
1341 (defun dired-up-directory (&optional other-window)
1342 "Run dired on parent directory of current directory.
1343 Find the parent directory either in this buffer or another buffer.
1344 Creates a buffer if necessary."
1346 (let* ((dir (dired-current-directory))
1347 (up (file-name-directory (directory-file-name dir))))
1348 (or (dired-goto-file (directory-file-name dir))
1349 ;; Only try dired-goto-subdir if buffer has more than one dir.
1350 (and (cdr dired-subdir-alist)
1351 (dired-goto-subdir up))
1354 (dired-other-window up)
1356 (dired-goto-file dir)))))
1358 ;; Force `f' rather than `e' in the mode doc:
1359 (defalias 'dired-advertised-find-file 'dired-find-file)
1360 (defun dired-find-file ()
1361 "In dired, visit the file or directory named on this line."
1363 (let ((file-name (file-name-sans-versions (dired-get-filename) t)))
1364 (if (file-exists-p file-name)
1365 (find-file file-name)
1366 (if (file-symlink-p file-name)
1367 (error "File is a symlink to a nonexistent target")
1368 (error "File no longer exists; type `g' to update Dired buffer")))))
1370 (defun dired-find-alternate-file ()
1371 "In dired, visit this file or directory instead of the dired buffer."
1373 (set-buffer-modified-p nil)
1374 (find-alternate-file (dired-get-filename)))
1376 (defun dired-mouse-find-file-other-window (event)
1377 "In dired, visit the file or directory name you click on."
1381 (set-buffer (window-buffer (posn-window (event-end event))))
1383 (goto-char (posn-point (event-end event)))
1384 (setq file (dired-get-filename))))
1385 (select-window (posn-window (event-end event)))
1386 (find-file-other-window (file-name-sans-versions file t))))
1388 (defun dired-view-file ()
1389 "In dired, examine a file in view mode, returning to dired when done.
1390 When file is a directory, show it in this buffer if it is inserted;
1391 otherwise, display it in another buffer."
1393 (if (file-directory-p (dired-get-filename))
1394 (or (and (cdr dired-subdir-alist)
1395 (dired-goto-subdir (dired-get-filename)))
1396 (dired (dired-get-filename)))
1397 (view-file (dired-get-filename))))
1399 (defun dired-find-file-other-window ()
1400 "In dired, visit this file or directory in another window."
1402 (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
1404 (defun dired-display-file ()
1405 "In dired, display this file or directory in another window."
1407 (let ((file (file-name-sans-versions (dired-get-filename) t)))
1408 (display-buffer (find-file-noselect file))))
1410 ;;; Functions for extracting and manipulating file names in dired buffers.
1412 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1413 "In dired, return name of file mentioned on this line.
1414 Value returned normally includes the directory name.
1415 Optional arg LOCALP with value `no-dir' means don't include directory
1416 name in result. A value of `verbatim' means to return the name exactly as
1417 it occurs in the buffer, and a value of t means construct name relative to
1418 `default-directory', which still may contain slashes if in a subdirectory.
1419 Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1420 this line, otherwise an error occurs."
1421 (let (case-fold-search file p1 p2 already-absolute)
1423 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1424 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1425 ;; nil if no file on this line, but no-error-if-not-filep is t:
1426 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1428 ;; Get rid of the mouse-face property that file names have.
1429 (set-text-properties 0 (length file) nil file)
1430 ;; Unquote names quoted by ls or by dired-insert-directory.
1431 ;; Using read to unquote is much faster than substituting
1432 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1436 ;; some ls -b don't escape quotes, argh!
1437 ;; This is not needed for GNU ls, though.
1438 (or (dired-string-replace-match
1439 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
1442 (and file (file-name-absolute-p file)
1443 ;; A relative file name can start with ~.
1444 ;; Don't treat it as absolute in this context.
1445 (not (eq (aref file 0) ?~))
1446 (setq already-absolute t))
1447 (and file buffer-file-coding-system
1448 (not file-name-coding-system)
1449 (not default-file-name-coding-system)
1450 (setq file (encode-coding-string file buffer-file-coding-system)))
1452 ((eq localp 'verbatim)
1454 ((and (eq localp 'no-dir) already-absolute)
1455 (file-name-nondirectory file))
1456 ((or already-absolute (eq localp 'no-dir))
1459 (and file (concat (dired-current-directory localp) file))))))
1461 (defun dired-string-replace-match (regexp string newtext
1462 &optional literal global)
1463 "Replace first match of REGEXP in STRING with NEWTEXT.
1464 If it does not match, nil is returned instead of the new string.
1465 Optional arg LITERAL means to take NEWTEXT literally.
1466 Optional arg GLOBAL means to replace all matches."
1468 (let ((start 0) ret)
1469 (while (string-match regexp string start)
1470 (let ((from-end (- (length string) (match-end 0))))
1471 (setq ret (setq string (replace-match newtext t literal string)))
1472 (setq start (- (length string) from-end))))
1474 (if (not (string-match regexp string 0))
1476 (replace-match newtext t literal string))))
1478 (defun dired-make-absolute (file &optional dir)
1479 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1480 ;; We can't always use expand-file-name as this would get rid of `.'
1481 ;; or expand in / instead default-directory if DIR=="".
1482 ;; This should be good enough for ange-ftp, but might easily be
1483 ;; redefined (for VMS?).
1484 ;; It should be reasonably fast, though, as it is called in
1485 ;; dired-get-filename.
1486 (concat (or dir default-directory) file))
1488 (defun dired-make-relative (file &optional dir ignore)
1489 "Convert FILE (an absolute file name) to a name relative to DIR.
1490 If this is impossible, return FILE unchanged.
1491 DIR must be a directory name, not a file name."
1492 (or dir (setq dir default-directory))
1493 ;; This case comes into play if default-directory is set to
1495 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1496 (setq dir (expand-file-name dir)))
1497 (if (string-match (concat "^" (regexp-quote dir)) file)
1498 (substring file (match-end 0))
1500 ;;; (error "%s: not in directory tree growing at %s" file dir))
1503 ;;; Functions for finding the file name in a dired buffer line.
1505 (defvar dired-move-to-filename-regexp
1506 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
1507 ;; In some locales, month abbreviations are as short as 2 letters,
1508 ;; and they can be padded on the right with spaces.
1509 ;; weiand: changed: month ends potentially with . or , or .,
1510 ;;old (month (concat l l "+ *"))
1511 (month (concat l l "+[.]?,? *"))
1512 ;; Recognize any non-ASCII character.
1513 ;; The purpose is to match a Kanji character.
1515 ;; (k "[^\x00-\x7f\x80-\xff]")
1517 (yyyy "[0-9][0-9][0-9][0-9]")
1519 ;;old (dd "[ 0-3][0-9]")
1520 (dd "[ 0-3][0-9][.]?")
1521 (HH:MM "[ 0-2][0-9]:[0-5][0-9]")
1522 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
1523 (zone "[-+][0-2][0-9][0-5][0-9]")
1524 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
1525 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
1526 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
1527 "\\|" yyyy "-" iso-mm-dd " ?\\)"))
1528 (western (concat "\\(" month s dd "\\|" dd s month "\\)"
1529 ;; weiand: changed: year potentially unaligned
1530 ;;old s "\\(" HH:MM "\\|" s yyyy "\\|" yyyy s "\\)"))
1536 (concat mm k "?" s dd k "?" s "+"
1537 "\\(" HH:MM "\\|" yyyy k "?" "\\)")))
1538 ;; The "[0-9]" below requires the previous column to end in a digit.
1539 ;; This avoids recognizing `1 may 1997' as a date in the line:
1540 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
1541 ;; The "[kMGTPEZY]?" below supports "ls -alh" output.
1542 ;; The ".*" below finds the last match if there are multiple matches.
1543 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
1544 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1545 (concat ".*[0-9][kMGTPEZY]?"
1546 s "\\(" western "\\|" japanese "\\|" iso "\\)" s))
1547 "Regular expression to match up to the file name in a directory listing.
1548 The default value is designed to recognize dates and times
1549 regardless of the language.")
1551 (defvar dired-permission-flags-regexp
1552 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1553 "Regular expression to match the permission flags in `ls -l'.")
1555 ;; Move to first char of filename on this line.
1556 ;; Returns position (point) or nil if no filename on this line."
1557 (defun dired-move-to-filename (&optional raise-error eol)
1558 ;; This is the UNIX version.
1559 (or eol (setq eol (progn (end-of-line) (point))))
1561 (if (re-search-forward dired-move-to-filename-regexp eol t)
1562 (goto-char (match-end 0))
1564 (error "No file on this line"))))
1566 (defun dired-move-to-end-of-filename (&optional no-error)
1567 ;; Assumes point is at beginning of filename,
1568 ;; thus the rwx bit re-search-backward below will succeed in *this*
1569 ;; line if at all. So, it should be called only after
1570 ;; (dired-move-to-filename t).
1571 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1572 ;; This is the UNIX version.
1573 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1574 ;; case-fold-search is nil now, so we can test for capital F:
1575 (setq used-F (string-match "F" dired-actual-switches)
1577 eol (save-excursion (end-of-line) (point))
1578 hidden (and selective-display
1579 (save-excursion (search-forward "\r" eol t))))
1582 (save-excursion;; Find out what kind of file this is:
1583 ;; Restrict perm bits to be non-blank,
1584 ;; otherwise this matches one char to early (looking backward):
1585 ;; "l---------" (some systems make symlinks that way)
1586 ;; "----------" (plain file with zero perms)
1587 (if (re-search-backward
1588 dired-permission-flags-regexp nil t)
1589 (setq file-type (char-after (match-beginning 1))
1590 symlink (eq file-type ?l)
1591 ;; Only with -F we need to know whether it's an executable
1595 "[xst]";; execute bit set anywhere?
1597 (buffer-substring (match-beginning 2)
1599 (buffer-substring (match-beginning 3)
1601 (buffer-substring (match-beginning 4)
1603 (or no-error (error "No file on this line"))))
1604 ;; Move point to end of name:
1606 (if (search-forward " ->" eol t)
1610 dired-ls-F-marks-symlinks
1611 (eq (preceding-char) ?@);; did ls really mark the link?
1612 (forward-char -1))))
1613 (goto-char eol);; else not a symbolic link
1614 ;; ls -lF marks dirs, sockets and executables with exactly one
1615 ;; trailing character. (Executable bits on symlinks ain't mean
1616 ;; a thing, even to ls, but we know it's not a symlink.)
1618 (or (memq file-type '(?d ?s))
1620 (forward-char -1))))
1622 (not (eq opoint (point)))
1624 (substitute-command-keys
1625 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1626 "No file on this line")))
1627 (if (eq opoint (point))
1632 ;; Keeping Dired buffers in sync with the filesystem and with each other
1634 (defun dired-buffers-for-dir (dir &optional file)
1635 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1636 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1638 ;; The list is in reverse order of buffer creation, most recent last.
1639 ;; As a side effect, killed dired buffers for DIR are removed from
1641 (setq dir (file-name-as-directory dir))
1642 (let ((alist dired-buffers) result elt buf pattern)
1644 (setq elt (car alist)
1646 (if (buffer-name buf)
1647 (if (dired-in-this-tree dir (car elt))
1648 (with-current-buffer buf
1649 (and (assoc dir dired-subdir-alist)
1652 (file-name-nondirectory dired-directory)))
1653 (or (= 0 (length wildcards))
1654 (string-match (dired-glob-regexp wildcards)
1656 (setq result (cons buf result)))))
1657 ;; else buffer is killed - clean up:
1658 (setq dired-buffers (delq elt dired-buffers)))
1659 (setq alist (cdr alist)))
1662 (defun dired-glob-regexp (pattern)
1663 "Convert glob-pattern PATTERN to a regular expression."
1664 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1666 (while (string-match "[[?*]" pattern matched-in-pattern)
1667 (let ((op-end (match-end 0))
1668 (next-op (aref pattern (match-beginning 0))))
1669 (setq regexp (concat regexp
1671 (substring pattern matched-in-pattern
1672 (match-beginning 0)))))
1673 (cond ((= next-op ??)
1674 (setq regexp (concat regexp "."))
1675 (setq matched-in-pattern op-end))
1677 ;; Fails to handle ^ yet ????
1678 (let* ((set-start (match-beginning 0))
1680 (if (= (aref pattern (1+ set-start)) ?^)
1683 (set-end (string-match "]" pattern set-cont))
1684 (set (substring pattern set-start (1+ set-end))))
1685 (setq regexp (concat regexp set))
1686 (setq matched-in-pattern (1+ set-end))))
1688 (setq regexp (concat regexp ".*"))
1689 (setq matched-in-pattern op-end)))))
1693 (substring pattern matched-in-pattern))
1698 (defun dired-advertise ()
1699 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1700 ;; With wildcards we actually advertise too much.
1701 (let ((expanded-default (expand-file-name default-directory)))
1702 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1703 t ; we have already advertised ourselves
1705 (cons (cons expanded-default (current-buffer))
1708 (defun dired-unadvertise (dir)
1709 ;; Remove DIR from the buffer alist in variable dired-buffers.
1710 ;; This has the effect of removing any buffer whose main directory is DIR.
1711 ;; It does not affect buffers in which DIR is a subdir.
1712 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1714 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
1718 ;;; utility functions
1720 (defun dired-in-this-tree (file dir)
1721 ;;"Is FILE part of the directory tree starting at DIR?"
1722 (let (case-fold-search)
1723 (string-match (concat "^" (regexp-quote dir)) file)))
1725 (defun dired-normalize-subdir (dir)
1726 ;; Prepend default-directory to DIR if relative path name.
1727 ;; dired-get-filename must be able to make a valid filename from a
1728 ;; file and its directory DIR.
1729 (file-name-as-directory
1730 (if (file-name-absolute-p dir)
1732 (expand-file-name dir default-directory))))
1734 (defun dired-get-subdir ()
1735 ;;"Return the subdir name on this line, or nil if not on a headerline."
1736 ;; Look up in the alist whether this is a headerline.
1738 (let ((cur-dir (dired-current-directory)))
1739 (beginning-of-line) ; alist stores b-o-l positions
1740 (and (zerop (- (point)
1741 (dired-get-subdir-min (assoc cur-dir
1742 dired-subdir-alist))))
1745 ;(defun dired-get-subdir-min (elt)
1747 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1748 (defalias 'dired-get-subdir-min 'cdr)
1750 (defun dired-get-subdir-max (elt)
1752 (goto-char (dired-get-subdir-min elt))
1753 (dired-subdir-max)))
1755 (defun dired-clear-alist ()
1756 (while dired-subdir-alist
1757 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1758 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1760 (defun dired-subdir-index (dir)
1761 ;; Return an index into alist for use with nth
1762 ;; for the sake of subdir moving commands.
1763 (let (found (index 0) (alist dired-subdir-alist))
1765 (if (string= dir (car (car alist)))
1766 (setq alist nil found t)
1767 (setq alist (cdr alist) index (1+ index))))
1768 (if found index nil)))
1770 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1771 "Go to next subdirectory, regardless of level."
1772 ;; Use 0 arg to go to this directory's header line.
1773 ;; NO-SKIP prevents moving to end of header line, returning whatever
1774 ;; position was found in dired-subdir-alist.
1776 (let ((this-dir (dired-current-directory))
1778 ;; nth with negative arg does not return nil but the first element
1779 (setq index (- (dired-subdir-index this-dir) arg))
1780 (setq pos (if (>= index 0)
1781 (dired-get-subdir-min (nth index dired-subdir-alist))))
1785 (or no-skip (skip-chars-forward "^\n\r"))
1787 (if no-error-if-not-found
1788 nil ; return nil if not found
1789 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1791 (defun dired-build-subdir-alist (&optional switches)
1792 "Build `dired-subdir-alist' by parsing the buffer.
1793 Returns the new value of the alist.
1794 If optional arg SWITCHES is non-nil, use its value
1795 instead of `dired-actual-switches'."
1800 (buffer-read-only nil)
1801 (switches (or switches dired-actual-switches))
1803 (R-ftp-base-dir-regex
1804 ;; Used to expand subdirectory names correctly in recursive
1805 ;; ange-ftp listings.
1806 (and (string-match "R" switches)
1807 (string-match "\\`/.*:\\(/.*\\)" default-directory)
1808 (concat "\\`" (match-string 1 default-directory)))))
1809 (goto-char (point-min))
1810 (setq dired-subdir-alist nil)
1811 (while (and (re-search-forward dired-subdir-regexp nil t)
1812 ;; Avoid taking a file name ending in a colon
1813 ;; as a subdir name.
1814 (not (save-excursion
1815 (goto-char (match-beginning 0))
1818 (save-match-data (looking-at dired-re-perms)))))
1820 (goto-char (match-beginning 1))
1822 (buffer-substring-no-properties (point) (match-end 1))
1825 (if (and R-ftp-base-dir-regex
1826 (not (string= new-dir-name default-directory))
1827 (string-match R-ftp-base-dir-regex new-dir-name))
1828 (concat default-directory
1829 (substring new-dir-name (match-end 0)))
1830 (expand-file-name new-dir-name))))
1831 (delete-region (point) (match-end 1))
1832 (insert new-dir-name))
1833 (setq count (1+ count))
1834 (dired-alist-add-1 new-dir-name
1835 ;; Place a sub directory boundary between lines.
1837 (goto-char (match-beginning 0))
1841 (message "Buffer includes %d directories" count))
1842 ;; We don't need to sort it because it is in buffer order per
1843 ;; constructionem. Return new alist:
1844 dired-subdir-alist)))
1846 (defun dired-alist-add-1 (dir new-marker)
1847 ;; Add new DIR at NEW-MARKER. Don't sort.
1848 (setq dired-subdir-alist
1849 (cons (cons (dired-normalize-subdir dir) new-marker)
1850 dired-subdir-alist)))
1852 (defun dired-goto-next-nontrivial-file ()
1853 ;; Position point on first nontrivial file after point.
1854 (dired-goto-next-file);; so there is a file to compare with
1855 (if (stringp dired-trivial-filenames)
1856 (while (and (not (eobp))
1857 (string-match dired-trivial-filenames
1858 (file-name-nondirectory
1859 (or (dired-get-filename nil t) ""))))
1861 (dired-move-to-filename))))
1863 (defun dired-goto-next-file ()
1864 (let ((max (1- (dired-subdir-max))))
1865 (while (and (not (dired-move-to-filename)) (< (point) max))
1868 (defun dired-goto-file (file)
1869 "Go to file line of FILE in this dired buffer."
1870 ;; Return value of point on success, else nil.
1871 ;; FILE must be an absolute pathname.
1872 ;; Loses if FILE contains control chars like "\007" for which ls
1873 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1874 ;; it in the buffer.
1876 (prog1 ; let push-mark display its message
1877 (list (expand-file-name
1878 (read-file-name "Goto file: "
1879 (dired-current-directory))))
1881 (setq file (directory-file-name file)) ; does no harm if no directory
1882 (let (found case-fold-search dir)
1883 (setq dir (or (file-name-directory file)
1884 (error "Need absolute pathname for %s" file)))
1886 ;; The hair here is to get the result of dired-goto-subdir
1887 ;; without really calling it if we don't have any subdirs.
1888 (if (if (string= dir (expand-file-name default-directory))
1889 (goto-char (point-min))
1890 (and (cdr dired-subdir-alist)
1891 (dired-goto-subdir dir)))
1892 (let ((base (file-name-nondirectory file))
1893 (boundary (dired-subdir-max)))
1894 (while (and (not found)
1895 ;; filenames are preceded by SPC, this makes
1896 ;; the search faster (e.g. for the filename "-"!).
1897 (search-forward (concat " " base) boundary 'move))
1898 ;; Match could have BASE just as initial substring or
1899 ;; or in permission bits or date or
1900 ;; not be a proper filename at all:
1901 (if (equal base (dired-get-filename 'no-dir t))
1902 ;; Must move to filename since an (actually
1903 ;; correct) match could have been elsewhere on the
1904 ;; ;; line (e.g. "-" would match somewhere in the
1905 ;; permission bits).
1906 (setq found (dired-move-to-filename))
1907 ;; If this isn't the right line, move forward to avoid
1908 ;; trying this line again.
1909 (forward-line 1))))))
1911 ;; return value of point (i.e., FOUND):
1912 (goto-char found))))
1914 (defun dired-initial-position (dirname)
1915 ;; Where point should go in a new listing of DIRNAME.
1916 ;; Point assumed at beginning of new subdir line.
1917 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1919 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1921 ;; These are hooks which make tree dired work.
1922 ;; They are in this file because other parts of dired need to call them.
1923 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
1925 ;; This function is called for each retrieved filename.
1926 ;; It could stand to be faster, though it's mostly function call
1927 ;; overhead. Avoiding the function call seems to save about 10% in
1928 ;; dired-get-filename. Make it a defsubst?
1929 (defun dired-current-directory (&optional localp)
1930 "Return the name of the subdirectory to which this line belongs.
1931 This returns a string with trailing slash, like `default-directory'.
1932 Optional argument means return a file name relative to `default-directory'."
1933 (let ((here (point))
1934 (alist (or dired-subdir-alist
1935 ;; probably because called in a non-dired buffer
1936 (error "No subdir-alist in %s" (current-buffer))))
1939 (setq elt (car alist)
1941 ;; use `<=' (not `<') as subdir line is part of subdir
1942 alist (if (<= (dired-get-subdir-min elt) here)
1946 (dired-make-relative dir default-directory)
1949 ;; Subdirs start at the beginning of their header lines and end just
1950 ;; before the beginning of the next header line (or end of buffer).
1952 (defun dired-subdir-max ()
1954 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
1960 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
1961 "*Decide whether recursive deletes are allowed.
1962 Nil means no recursive deletes.
1963 `always' means delete recursively without asking. This is DANGEROUS!
1964 `top' means ask for each directory at top level, but delete its subdirectories
1966 Anything else means ask for each directory."
1967 :type '(choice :tag "Delete not empty directory"
1968 (const :tag "No. Only empty directories" nil)
1969 (const :tag "Ask for each directory" t)
1970 (const :tag "Ask for each top directory only" top))
1973 ;; Match anything but `.' and `..'.
1974 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
1976 ;; Delete file, possibly delete a directory and all its files.
1977 ;; This function is usefull outside of dired. One could change it's name
1978 ;; to e.g. recursive-delete-file and put it somewhere else.
1979 (defun dired-delete-file (file &optional recursive) "\
1980 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
1981 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
1983 `always', delete recursively without asking.
1984 `top', ask for each directory at top level.
1985 Anything else, ask for each sub-directory."
1987 ;; This test is equivalent to
1988 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1989 ;; but more efficient
1990 (if (not (eq t (car (file-attributes file))))
1992 (when (and recursive
1994 (directory-files file t dired-re-no-dot)) ; Not empty.
1995 (or (eq recursive 'always)
1996 (yes-or-no-p (format "Recursive delete of %s "
1997 (dired-make-relative file)))))
1998 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
1999 (while files ; Recursively delete (possibly asking).
2000 (dired-delete-file (car files) recursive)
2001 (setq files (cdr files))))
2002 (delete-directory file))))
2004 (defun dired-do-flagged-delete (&optional nomessage)
2005 "In dired, delete the files flagged for deletion.
2006 If NOMESSAGE is non-nil, we don't display any message
2007 if there are no flagged files."
2009 (let* ((dired-marker-char dired-del-marker)
2010 (regexp (dired-marker-regexp))
2012 (if (save-excursion (goto-char (point-min))
2013 (re-search-forward regexp nil t))
2014 (dired-internal-do-deletions
2015 ;; this can't move point since ARG is nil
2016 (dired-map-over-marks (cons (dired-get-filename) (point))
2020 (message "(No deletions requested)")))))
2022 (defun dired-do-delete (&optional arg)
2023 "Delete all marked (or next ARG) files."
2024 ;; This is more consistent with the file marking feature than
2025 ;; dired-do-flagged-delete.
2027 (dired-internal-do-deletions
2028 ;; this may move point if ARG is an integer
2029 (dired-map-over-marks (cons (dired-get-filename) (point))
2033 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2035 (defun dired-internal-do-deletions (l arg)
2036 ;; L is an alist of files to delete, with their buffer positions.
2037 ;; ARG is the prefix arg.
2038 ;; Filenames are absolute (VMS needs this for logical search paths).
2039 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2040 ;; That way as changes are made in the buffer they do not shift the
2041 ;; lines still to be changed, so the (point) values in L stay valid.
2042 ;; Also, for subdirs in natural order, a subdir's files are deleted
2043 ;; before the subdir itself - the other way around would not work.
2044 (let ((files (mapcar (function car) l))
2047 ;; canonicalize file list for pop up
2048 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2049 (if (dired-mark-pop-up
2050 " *Deletions*" 'delete files dired-deletion-confirmer
2051 (format "Delete %s " (dired-mark-prompt arg files)))
2053 (let (failures);; files better be in reverse order for this loop!
2055 (goto-char (cdr (car l)))
2056 (let (buffer-read-only)
2058 (let ((fn (car (car l))))
2059 (dired-delete-file fn dired-recursive-deletes)
2060 ;; if we get here, removing worked
2061 (setq succ (1+ succ))
2062 (message "%s of %s deletions" succ count)
2063 (delete-region (progn (beginning-of-line) (point))
2064 (progn (forward-line 1) (point)))
2065 (dired-clean-up-after-deletion fn))
2066 (error;; catch errors from failed deletions
2067 (dired-log "%s\n" err)
2068 (setq failures (cons (car (car l)) failures)))))
2071 (message "%d deletion%s done" count (dired-plural-s count))
2073 (format "%d of %d deletion%s failed"
2074 (length failures) count
2075 (dired-plural-s count))
2077 (message "(No deletions performed)")))
2078 (dired-move-to-filename))
2080 ;; This is a separate function for the sake of dired-x.el.
2081 (defun dired-clean-up-after-deletion (fn)
2082 ;; Clean up after a deleted file or directory FN.
2083 (save-excursion (and (cdr dired-subdir-alist)
2084 (dired-goto-subdir fn)
2085 (dired-kill-subdir))))
2089 (defun dired-marker-regexp ()
2090 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2092 (defun dired-plural-s (count)
2093 (if (= 1 count) "" "s"))
2095 (defun dired-mark-prompt (arg files)
2096 ;; Return a string for use in a prompt, either the current file
2097 ;; name, or the marker and a count of marked files.
2098 (let ((count (length files)))
2101 ;; more than 1 file:
2104 ;; Perhaps this is nicer, but it also takes more screen space:
2105 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2107 (format "[next %d files]" arg)
2108 (format "%c [%d files]" dired-marker-char count)))))
2110 (defun dired-pop-to-buffer (buf)
2111 ;; Pop up buffer BUF.
2112 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2113 (if (not dired-shrink-to-fit)
2114 (pop-to-buffer (get-buffer-create buf))
2115 ;; let window shrink to fit:
2116 (let ((window (selected-window))
2118 (cond ;; if split-window-threshold is enabled, use the largest window
2119 ((and (> (window-height (setq w2 (get-largest-window)))
2120 split-height-threshold)
2121 (= (frame-width) (window-width w2)))
2123 ;; if the least-recently-used window is big enough, use it
2124 ((and (> (window-height (setq w2 (get-lru-window)))
2125 (* 2 window-min-height))
2126 (= (frame-width) (window-width w2)))
2130 (goto-char (point-max))
2131 (skip-chars-backward "\n\r\t ")
2132 (setq target-lines (count-lines (point-min) (point)))
2133 ;; Don't forget to count the last line.
2135 (setq target-lines (1+ target-lines))))
2136 (if (<= (window-height window) (* 2 window-min-height))
2137 ;; At this point, every window on the frame is too small to split.
2138 (setq w2 (display-buffer buf))
2139 (setq w2 (split-window window
2140 (max window-min-height
2141 (- (window-height window)
2142 (1+ (max window-min-height target-lines)))))))
2143 (set-window-buffer w2 buf)
2144 (if (< (1- (window-height w2)) target-lines)
2147 (enlarge-window (- target-lines (1- (window-height w2))))))
2148 (set-window-start w2 1)
2151 (defvar dired-no-confirm nil
2152 "A list of symbols for commands dired should not confirm.
2153 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2154 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink' and
2157 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2158 "Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
2159 Return FUNCTION's result on ARGS after popping up a window (in a buffer
2160 named BUFNAME, nil gives \" *Marked Files*\") showing the marked
2161 files. Uses function `dired-pop-to-buffer' to do that.
2162 FUNCTION should not manipulate files.
2163 It should only read input (an argument or confirmation).
2164 The window is not shown if there is just one file or
2165 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2166 FILES is the list of marked files."
2167 (or bufname (setq bufname " *Marked Files*"))
2168 (if (or (eq dired-no-confirm t)
2169 (memq op-symbol dired-no-confirm)
2170 (= (length files) 1))
2171 (apply function args)
2172 (with-current-buffer (get-buffer-create bufname)
2174 (dired-format-columns-of-files files)
2175 (remove-text-properties (point-min) (point-max)
2176 '(mouse-face nil help-echo nil)))
2177 (save-window-excursion
2178 (dired-pop-to-buffer bufname)
2179 (apply function args))))
2181 (defun dired-format-columns-of-files (files)
2182 ;; Files should be in forward order for this loop.
2183 ;; i.e., (car files) = first file in buffer.
2184 ;; Returns the number of lines used.
2185 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2186 (width (- (window-width (selected-window)) 2))
2187 (columns (max 1 (/ width maxlen)))
2188 (nfiles (length files))
2189 (rows (+ (/ nfiles columns)
2190 (if (zerop (% nfiles columns)) 0 1)))
2193 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2194 (make-list (- (* columns rows) nfiles) "")))
2195 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2197 (while (< i columns)
2198 (indent-to (* i maxlen))
2199 (insert (car files))
2200 (setq files (nthcdr rows files)
2208 ;; Commands to mark or flag file(s) at or near current line.
2210 (defun dired-repeat-over-lines (arg function)
2211 ;; This version skips non-file lines.
2212 (let ((pos (make-marker)))
2214 (while (and (> arg 0) (not (eobp)))
2217 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2220 (move-marker pos (1+ (point))))
2221 (save-excursion (funcall function))
2222 ;; Advance to the next line--actually, to the line that *was* next.
2223 ;; (If FUNCTION inserted some new lines in between, skip them.)
2225 (while (and (< arg 0) (not (bobp)))
2228 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2230 (save-excursion (funcall function)))
2231 (move-marker pos nil)
2232 (dired-move-to-filename)))
2234 (defun dired-between-files ()
2235 ;; Point must be at beginning of line
2236 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
2237 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
2238 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard\\|^. used\\|^. find")
2239 (and (looking-at dired-subdir-regexp)
2240 (save-excursion (not (dired-move-to-filename))))))
2242 (defun dired-next-marked-file (arg &optional wrap opoint)
2243 "Move to the next marked file, wrapping around the end of the buffer."
2244 (interactive "p\np")
2245 (or opoint (setq opoint (point)));; return to where interactively started
2247 (re-search-forward dired-re-mark nil t arg)
2249 (re-search-backward dired-re-mark nil t (- arg)))
2250 (dired-move-to-filename)
2254 (error "No next marked file"))
2255 (message "(Wraparound for next marked file)")
2256 (goto-char (if (> arg 0) (point-min) (point-max)))
2257 (dired-next-marked-file arg nil opoint))))
2259 (defun dired-prev-marked-file (arg &optional wrap)
2260 "Move to the previous marked file, wrapping around the end of the buffer."
2261 (interactive "p\np")
2262 (dired-next-marked-file (- arg) wrap))
2264 (defun dired-file-marker (file)
2265 ;; Return FILE's marker, or nil if unmarked.
2267 (and (dired-goto-file file)
2270 (if (not (equal ?\040 (following-char)))
2271 (following-char))))))
2273 (defun dired-mark-files-in-region (start end)
2274 (let (buffer-read-only)
2276 (error "start > end"))
2277 (goto-char start) ; assumed at beginning of line
2278 (while (< (point) end)
2279 ;; Skip subdir line and following garbage like the `total' line:
2280 (while (and (< (point) end) (dired-between-files))
2282 (if (and (not (looking-at dired-re-dot))
2283 (dired-get-filename nil t))
2286 (insert dired-marker-char)))
2289 (defun dired-mark (arg)
2290 "Mark the current (or next ARG) files.
2291 If on a subdir headerline, mark all its files except `.' and `..'.
2293 Use \\[dired-unmark-all-files] to remove all marks
2294 and \\[dired-unmark] on a subdir to remove the marks in
2297 (if (dired-get-subdir)
2298 (save-excursion (dired-mark-subdir-files))
2299 (let (buffer-read-only)
2300 (dired-repeat-over-lines
2301 (prefix-numeric-value arg)
2302 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2304 (defun dired-unmark (arg)
2305 "Unmark the current (or next ARG) files.
2306 If looking at a subdir, unmark all its files except `.' and `..'."
2308 (let ((dired-marker-char ?\040))
2311 (defun dired-flag-file-deletion (arg)
2312 "In dired, flag the current line's file for deletion.
2313 With prefix arg, repeat over several lines.
2315 If on a subdir headerline, mark all its files except `.' and `..'."
2317 (let ((dired-marker-char dired-del-marker))
2320 (defun dired-unmark-backward (arg)
2321 "In dired, move up lines and remove deletion flag there.
2322 Optional prefix ARG says how many lines to unflag; default is one line."
2324 (dired-unmark (- arg)))
2326 (defun dired-do-toggle ()
2328 That is, currently marked files become unmarked and vice versa.
2329 Files marked with other flags (such as `D') are not affected.
2330 `.' and `..' are never toggled.
2331 As always, hidden subdirs are not affected."
2334 (goto-char (point-min))
2335 (let (buffer-read-only)
2337 (or (dired-between-files)
2338 (looking-at dired-re-dot)
2339 ;; use subst instead of insdel because it does not move
2340 ;; the gap and thus should be faster and because
2341 ;; other characters are left alone automatically
2342 (apply 'subst-char-in-region
2343 (point) (1+ (point))
2344 (if (eq ?\040 (following-char)) ; SPC
2345 (list ?\040 dired-marker-char)
2346 (list dired-marker-char ?\040))))
2347 (forward-line 1)))))
2349 ;;; Commands to mark or flag files based on their characteristics or names.
2351 (defvar dired-regexp-history nil
2352 "History list of regular expressions used in Dired commands.")
2354 (defun dired-read-regexp (prompt)
2355 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2357 (defun dired-mark-files-regexp (regexp &optional marker-char)
2358 "Mark all files matching REGEXP for use in later commands.
2359 A prefix argument means to unmark them instead.
2360 `.' and `..' are never marked.
2362 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2363 object files--just `.o' will mark more than you might think."
2365 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2366 " files (regexp): "))
2367 (if current-prefix-arg ?\040)))
2368 (let ((dired-marker-char (or marker-char dired-marker-char)))
2370 (and (not (looking-at dired-re-dot))
2371 (not (eolp)) ; empty line
2372 (let ((fn (dired-get-filename nil t)))
2373 (and fn (string-match regexp (file-name-nondirectory fn)))))
2376 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2377 "Mark all files with contents containing REGEXP for use in later commands.
2378 A prefix argument means to unmark them instead.
2379 `.' and `..' are never marked."
2381 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2382 " files containing (regexp): "))
2383 (if current-prefix-arg ?\040)))
2384 (let ((dired-marker-char (or marker-char dired-marker-char)))
2386 (and (not (looking-at dired-re-dot))
2387 (not (eolp)) ; empty line
2388 (let ((fn (dired-get-filename nil t)))
2389 (when (and fn (file-readable-p fn)
2390 (not (file-directory-p fn)))
2391 (let ((prebuf (get-file-buffer fn)))
2392 (message "Checking %s" fn)
2393 ;; For now we do it inside emacs
2394 ;; Grep might be better if there are a lot of files
2396 (with-current-buffer prebuf
2398 (goto-char (point-min))
2399 (re-search-forward regexp nil t)))
2401 (insert-file-contents fn)
2402 (goto-char (point-min))
2403 (re-search-forward regexp nil t))))
2407 (defun dired-flag-files-regexp (regexp)
2408 "In dired, flag all files containing the specified REGEXP for deletion.
2409 The match is against the non-directory part of the filename. Use `^'
2410 and `$' to anchor matches. Exclude subdirs by hiding them.
2411 `.' and `..' are never flagged."
2412 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2413 (dired-mark-files-regexp regexp dired-del-marker))
2415 (defun dired-mark-symlinks (unflag-p)
2416 "Mark all symbolic links.
2417 With prefix argument, unflag all those files."
2419 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2420 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2422 (defun dired-mark-directories (unflag-p)
2423 "Mark all directory file lines except `.' and `..'.
2424 With prefix argument, unflag all those files."
2426 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2427 (dired-mark-if (and (looking-at dired-re-dir)
2428 (not (looking-at dired-re-dot)))
2431 (defun dired-mark-executables (unflag-p)
2432 "Mark all executable files.
2433 With prefix argument, unflag all those files."
2435 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2436 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2438 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2439 ;; files for which PREDICATE returns non-nil.
2441 (defun dired-flag-auto-save-files (&optional unflag-p)
2442 "Flag for deletion files whose names suggest they are auto save files.
2443 A prefix argument says to unflag those files instead."
2445 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2447 ;; It is less than general to check for # here,
2448 ;; but it's the only way this runs fast enough.
2449 (and (save-excursion (end-of-line)
2451 (eq (preceding-char) ?#)
2452 ;; Handle executables in case of -F option.
2453 ;; We need not worry about the other kinds
2454 ;; of markings that -F makes, since they won't
2455 ;; appear on real auto-save files.
2456 (if (eq (preceding-char) ?*)
2459 (eq (preceding-char) ?#)))))
2460 (not (looking-at dired-re-dir))
2461 (let ((fn (dired-get-filename t t)))
2462 (if fn (auto-save-file-name-p
2463 (file-name-nondirectory fn)))))
2466 (defvar dired-garbage-files-regexp
2467 "\\.log$\\|\\.toc$\\|\\.dvi$\\|\\.bak$\\|\\.orig$\\|\\.rej$"
2468 "*Regular expression to match \"garbage\" files for `dired-flag-garbage-files'.")
2470 (defun dired-flag-garbage-files ()
2471 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2473 (dired-flag-files-regexp dired-garbage-files-regexp))
2475 (defun dired-flag-backup-files (&optional unflag-p)
2476 "Flag all backup files (names ending with `~') for deletion.
2477 With prefix argument, unflag these files."
2479 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2481 ;; Don't call backup-file-name-p unless the last character looks like
2482 ;; it might be the end of a backup file name. This isn't very general,
2483 ;; but it's the only way this runs fast enough.
2484 (and (save-excursion (end-of-line)
2485 ;; Handle executables in case of -F option.
2486 ;; We need not worry about the other kinds
2487 ;; of markings that -F makes, since they won't
2488 ;; appear on real backup files.
2489 (if (eq (preceding-char) ?*)
2491 (eq (preceding-char) ?~))
2492 (not (looking-at dired-re-dir))
2493 (let ((fn (dired-get-filename t t)))
2494 (if fn (backup-file-name-p fn))))
2497 (defun dired-change-marks (&optional old new)
2498 "Change all OLD marks to NEW marks.
2499 OLD and NEW are both characters used to mark files."
2501 (let* ((cursor-in-echo-area t)
2502 (old (progn (message "Change (old mark): ") (read-char)))
2503 (new (progn (message "Change %c marks to (new mark): " old)
2506 (if (or (eq old ?\r) (eq new ?\r))
2508 (let ((string (format "\n%c" old))
2511 (goto-char (point-min))
2512 (while (search-forward string nil t)
2515 (dired-get-filename 'no-dir t))
2517 (subst-char-in-region (match-beginning 0)
2518 (match-end 0) old new)))))))
2520 (defun dired-unmark-all-marks ()
2521 "Remove all marks from all files in the Dired buffer."
2523 (dired-unmark-all-files ?\r))
2525 (defun dired-unmark-all-files (mark &optional arg)
2526 "Remove a specific mark (or any mark) from every file.
2527 After this command, type the mark character to remove,
2528 or type RET to remove all marks.
2529 With prefix arg, query for each marked file.
2530 Type \\[help-command] at that time for help."
2531 (interactive "cRemove marks (RET means all): \nP")
2534 buffer-read-only case-fold-search query
2535 (string (format "\n%c" mark))
2537 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2538 `!' to unmark all remaining files with no more questions."))
2539 (goto-char (point-min))
2540 (while (if (eq mark ?\r)
2541 (re-search-forward dired-re-mark nil t)
2542 (search-forward string nil t))
2544 (dired-query 'query "Unmark file `%s'? "
2545 (dired-get-filename t)))
2546 (progn (subst-char-in-region (1- (point)) (point)
2547 (preceding-char) ?\ )
2548 (setq count (1+ count)))))
2549 (message (if (= count 1) "1 mark removed"
2553 ;; Logging failures operating on files, and showing the results.
2555 (defvar dired-log-buffer "*Dired log*")
2558 "Pop up a buffer with error log output from Dired.
2559 A group of errors from a single command ends with a formfeed.
2560 Thus, use \\[backward-page] to find the beginning of a group of errors."
2562 (if (get-buffer dired-log-buffer)
2563 (let ((owindow (selected-window))
2564 (window (display-buffer (get-buffer dired-log-buffer))))
2567 (select-window window)
2568 (goto-char (point-max))
2570 (select-window owindow)))))
2572 (defun dired-log (log &rest args)
2573 ;; Log a message or the contents of a buffer.
2574 ;; If LOG is a string and there are more args, it is formatted with
2575 ;; those ARGS. Usually the LOG string ends with a \n.
2576 ;; End each bunch of errors with (dired-log t): this inserts
2577 ;; current time and buffer, and a \f (formfeed).
2578 (let ((obuf (current-buffer)))
2579 (unwind-protect ; want to move point
2581 (set-buffer (get-buffer-create dired-log-buffer))
2582 (goto-char (point-max))
2583 (let (buffer-read-only)
2584 (cond ((stringp log)
2586 (apply (function format) log args)
2589 (insert-buffer log))
2591 (insert "\n\t" (current-time-string)
2592 "\tBuffer `" (buffer-name obuf) "'\n\f\n")))))
2593 (set-buffer obuf))))
2595 (defun dired-log-summary (string failures)
2596 (message (if failures "%s--type ? for details (%s)"
2597 "%s--type ? for details")
2599 ;; Log a summary describing a bunch of errors.
2600 (dired-log (concat "\n" string))
2605 ;; Most ls can only sort by name or by date (with -t), nothing else.
2606 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2607 ;; So anything that does not contain these is sort "by name".
2609 (defvar dired-ls-sorting-switches "SXU"
2610 "String of `ls' switches (single letters) except `t' that influence sorting.")
2612 (defvar dired-sort-by-date-regexp
2613 (concat "^-[^" dired-ls-sorting-switches
2614 "]*t[^" dired-ls-sorting-switches "]*$")
2615 "Regexp recognized by dired to set `by date' mode.")
2617 (defvar dired-sort-by-name-regexp
2618 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2619 "Regexp recognized by dired to set `by name' mode.")
2621 (defun dired-sort-set-modeline ()
2622 ;; Set modeline display according to dired-actual-switches.
2623 ;; Modeline display of "by name" or "by date" guarantees the user a
2624 ;; match with the corresponding regexps. Non-matching switches are
2627 (let (case-fold-search)
2628 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2630 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2633 (concat "Dired " dired-actual-switches)))))
2634 (force-mode-line-update))
2636 (defun dired-sort-toggle-or-edit (&optional arg)
2637 "Toggle between sort by date/name and refresh the dired buffer.
2638 With a prefix argument you can edit the current listing switches instead."
2642 (read-string "ls switches (must contain -l): " dired-actual-switches))
2643 (dired-sort-toggle)))
2645 (defun dired-sort-toggle ()
2646 ;; Toggle between sort by date/name. Reverts the buffer.
2647 (setq dired-actual-switches
2648 (let (case-fold-search)
2649 (if (string-match " " dired-actual-switches)
2650 ;; New toggle scheme: add/remove a trailing " -t"
2651 (if (string-match " -t\\'" dired-actual-switches)
2652 (dired-replace-in-string " -t\\'" "" dired-actual-switches)
2653 (concat dired-actual-switches " -t"))
2654 ;; old toggle scheme: look for some 't' switch and add/remove it
2657 (dired-replace-in-string (concat "[-lt"
2658 dired-ls-sorting-switches "]")
2660 dired-actual-switches)
2661 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2662 dired-actual-switches)
2665 (dired-sort-set-modeline)
2668 ;; Some user code loads dired especially for this.
2669 (defun dired-replace-in-string (regexp newtext string)
2670 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2671 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2672 (let ((result "") (start 0) mb me)
2673 (while (string-match regexp string start)
2674 (setq mb (match-beginning 0)
2676 result (concat result (substring string start mb) newtext)
2678 (concat result (substring string start))))
2680 (defun dired-sort-other (switches &optional no-revert)
2681 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2682 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2683 ;; minor mode accordingly, others appear literally in the mode line.
2684 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2685 (dired-sort-R-check switches)
2686 (setq dired-actual-switches switches)
2687 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
2688 (or no-revert (revert-buffer)))
2690 (make-variable-buffer-local
2691 (defvar dired-subdir-alist-pre-R nil
2692 "Value of `dired-subdir-alist' before -R switch added."))
2694 (defun dired-sort-R-check (switches)
2695 "Additional processing of -R in ls option string SWITCHES.
2696 Saves `dired-subdir-alist' when R is set and restores saved value
2697 minus any directories explicitly deleted when R is cleared.
2698 To be called first in body of `dired-sort-other', etc."
2700 ((and (string-match "R" switches)
2701 (not (string-match "R" dired-actual-switches)))
2702 ;; Adding -R to ls switches -- save `dired-subdir-alist':
2703 (setq dired-subdir-alist-pre-R dired-subdir-alist))
2704 ((and (string-match "R" dired-actual-switches)
2705 (not (string-match "R" switches)))
2706 ;; Deleting -R from ls switches -- revert to pre-R subdirs
2707 ;; that are still present:
2708 (setq dired-subdir-alist
2709 (if dired-subdir-alist-pre-R
2711 (while dired-subdir-alist-pre-R
2712 (if (assoc (caar dired-subdir-alist-pre-R)
2714 ;; subdir still present...
2716 (cons (car dired-subdir-alist-pre-R)
2718 (setq dired-subdir-alist-pre-R
2719 (cdr dired-subdir-alist-pre-R)))
2721 ;; No pre-R subdir alist, so revert to main directory
2723 (list (car (reverse dired-subdir-alist))))))))
2725 ;; To make this file smaller, the less common commands
2726 ;; go in a separate file. But autoload them here
2727 ;; to make the separation invisible.
2729 (autoload 'dired-diff "dired-aux"
2730 "Compare file at point with file FILE using `diff'.
2731 FILE defaults to the file at the mark. (That's the mark set by
2732 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
2733 The prompted-for file is the first file given to `diff'."
2736 (autoload 'dired-backup-diff "dired-aux"
2737 "Diff this file with its backup file or vice versa.
2738 Uses the latest backup, if there are several numerical backups.
2739 If this file is a backup, diff it with its original.
2740 The backup file is the first file given to `diff'."
2743 (autoload 'dired-clean-directory "dired-aux"
2744 "Flag numerical backups for deletion.
2745 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2746 Positive prefix arg KEEP overrides `dired-kept-versions';
2747 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2749 To clear the flags on these files, you can use \\[dired-flag-backup-files]
2750 with a prefix argument."
2753 (autoload 'dired-do-chmod "dired-aux"
2754 "Change the mode of the marked (or next ARG) files.
2755 This calls chmod, thus symbolic modes like `g+w' are allowed."
2758 (autoload 'dired-do-chgrp "dired-aux"
2759 "Change the group of the marked (or next ARG) files."
2762 (autoload 'dired-do-chown "dired-aux"
2763 "Change the owner of the marked (or next ARG) files."
2766 (autoload 'dired-do-print "dired-aux"
2767 "Print the marked (or next ARG) files.
2768 Uses the shell command coming from variables `lpr-command' and
2769 `lpr-switches' as default."
2772 (autoload 'dired-do-shell-command "dired-aux"
2773 "Run a shell command COMMAND on the marked files.
2774 If no files are marked or a specific numeric prefix arg is given,
2775 the next ARG files are used. Just \\[universal-argument] means the current file.
2776 The prompt mentions the file(s) or the marker, as appropriate.
2778 If there is output, it goes to a separate buffer.
2780 Normally the command is run on each file individually.
2781 However, if there is a `*' in the command then it is run
2782 just once with the entire file list substituted there.
2784 No automatic redisplay of dired buffers is attempted, as there's no
2785 telling what files the command may have changed. Type
2786 \\[dired-do-redisplay] to redisplay the marked files.
2788 The shell command has the top level directory as working directory, so
2789 output files usually are created there instead of in a subdir."
2792 (autoload 'dired-do-kill-lines "dired-aux"
2793 "Kill all marked lines (not the files).
2794 With a prefix arg, kill all lines not marked or flagged."
2797 (autoload 'dired-do-compress "dired-aux"
2798 "Compress or uncompress marked (or next ARG) files."
2801 (autoload 'dired-do-byte-compile "dired-aux"
2802 "Byte compile marked (or next ARG) Emacs Lisp files."
2805 (autoload 'dired-do-load "dired-aux"
2806 "Load the marked (or next ARG) Emacs Lisp files."
2809 (autoload 'dired-do-redisplay "dired-aux"
2810 "Redisplay all marked (or next ARG) files.
2811 If on a subdir line, redisplay that subdirectory. In that case,
2812 a prefix arg lets you edit the `ls' switches used for the new listing."
2815 (autoload 'dired-create-directory "dired-aux"
2816 "Create a directory called DIRECTORY."
2819 (autoload 'dired-do-copy "dired-aux"
2820 "Copy all marked (or next ARG) files, or copy the current file.
2821 Thus, a zero prefix argument copies nothing. But it toggles the
2822 variable `dired-copy-preserve-time' (which see)."
2825 (autoload 'dired-do-symlink "dired-aux"
2826 "Make symbolic links to current file or all marked (or next ARG) files.
2827 When operating on just the current file, you specify the new name.
2828 When operating on multiple or marked files, you specify a directory
2829 and new symbolic links are made in that directory
2830 with the same names that the files currently have."
2833 (autoload 'dired-do-hardlink "dired-aux"
2834 "Add names (hard links) current file or all marked (or next ARG) files.
2835 When operating on just the current file, you specify the new name.
2836 When operating on multiple or marked files, you specify a directory
2837 and new hard links are made in that directory
2838 with the same names that the files currently have."
2841 (autoload 'dired-do-rename "dired-aux"
2842 "Rename current file or all marked (or next ARG) files.
2843 When renaming just the current file, you specify the new name.
2844 When renaming multiple or marked files, you specify a directory."
2847 (autoload 'dired-do-rename-regexp "dired-aux"
2848 "Rename marked files containing REGEXP to NEWNAME.
2849 As each match is found, the user must type a character saying
2850 what to do with it. For directions, type \\[help-command] at that time.
2851 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2852 REGEXP defaults to the last regexp used.
2853 With a zero prefix arg, renaming by regexp affects the complete
2854 pathname - usually only the non-directory part of file names is used
2858 (autoload 'dired-do-copy-regexp "dired-aux"
2859 "Copy all marked files containing REGEXP to NEWNAME.
2860 See function `dired-do-rename-regexp' for more info."
2863 (autoload 'dired-do-hardlink-regexp "dired-aux"
2864 "Hardlink all marked files containing REGEXP to NEWNAME.
2865 See function `dired-do-rename-regexp' for more info."
2868 (autoload 'dired-do-symlink-regexp "dired-aux"
2869 "Symlink all marked files containing REGEXP to NEWNAME.
2870 See function `dired-do-rename-regexp' for more info."
2873 (autoload 'dired-upcase "dired-aux"
2874 "Rename all marked (or next ARG) files to upper case."
2877 (autoload 'dired-downcase "dired-aux"
2878 "Rename all marked (or next ARG) files to lower case."
2881 (autoload 'dired-maybe-insert-subdir "dired-aux"
2882 "Insert this subdirectory into the same dired buffer.
2883 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2884 else inserts it at its natural place (as `ls -lR' would have done).
2885 With a prefix arg, you may edit the ls switches used for this listing.
2886 You can add `R' to the switches to expand the whole tree starting at
2888 This function takes some pains to conform to `ls -lR' output."
2891 (autoload 'dired-next-subdir "dired-aux"
2892 "Go to next subdirectory, regardless of level."
2895 (autoload 'dired-prev-subdir "dired-aux"
2896 "Go to previous subdirectory, regardless of level.
2897 When called interactively and not on a subdir line, go to this subdir's line."
2900 (autoload 'dired-goto-subdir "dired-aux"
2901 "Go to end of header line of DIR in this dired buffer.
2902 Return value of point on success, otherwise return nil.
2903 The next char is either \\n, or \\r if DIR is hidden."
2906 (autoload 'dired-mark-subdir-files "dired-aux"
2907 "Mark all files except `.' and `..'."
2910 (autoload 'dired-kill-subdir "dired-aux"
2911 "Remove all lines of current subdirectory.
2912 Lower levels are unaffected."
2915 (autoload 'dired-tree-up "dired-aux"
2916 "Go up ARG levels in the dired tree."
2919 (autoload 'dired-tree-down "dired-aux"
2920 "Go down in the dired tree."
2923 (autoload 'dired-hide-subdir "dired-aux"
2924 "Hide or unhide the current subdirectory and move to next directory.
2925 Optional prefix arg is a repeat factor.
2926 Use \\[dired-hide-all] to (un)hide all directories."
2929 (autoload 'dired-hide-all "dired-aux"
2930 "Hide all subdirectories, leaving only their header lines.
2931 If there is already something hidden, make everything visible again.
2932 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2935 (autoload 'dired-show-file-type "dired-aux"
2936 "Print the type of FILE, according to the `file' command.
2937 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2938 true then the type of the file linked to by FILE is printed instead."
2941 (if (eq system-type 'vax-vms)
2946 (run-hooks 'dired-load-hook) ; for your customizations
2948 ;;; dired.el ends here