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.
56 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
57 some of the `ls' switches are not supported; see the doc string of
58 `insert-directory' on ls-lisp.el for more details."
62 ; Don't use absolute paths as /bin should be in any PATH and people
63 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
64 ; usually not in PATH.
67 (defvar dired-chown-program
68 (if (memq system-type
'(hpux dgux usg-unix-v irix linux gnu
/linux
))
70 (if (file-exists-p "/usr/sbin/chown")
73 "Name of chown command (usually `chown' or `/etc/chown').")
75 (defvar dired-use-ls-dired
(not (not (string-match "gnu" system-configuration
)))
76 "Non-nil means Dired should use `ls --dired'.")
78 (defvar dired-chmod-program
"chmod"
79 "Name of chmod command (usually `chmod').")
82 (defcustom dired-ls-F-marks-symlinks nil
83 "*Informs dired about how `ls -lF' marks symbolic links.
84 Set this to t if `ls' (or whatever program is specified by
85 `insert-directory-program') with `-lF' marks the symbolic link
86 itself with a trailing @ (usually the case under Ultrix).
88 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
89 nil (the default), if it gives `bar@ -> foo', set it to t.
91 Dired checks if there is really a @ appended. Thus, if you have a
92 marking `ls' program on one host and a non-marking on another host, and
93 don't care about symbolic links which really end in a @, you can
94 always set this variable to t."
99 (defcustom dired-trivial-filenames
"^\\.\\.?$\\|^#"
100 "*Regexp of files to skip when finding first file of a directory.
101 A value of nil means move to the subdir line.
102 A value of t means move to first file."
103 :type
'(choice (const :tag
"Move to subdir" nil
)
104 (const :tag
"Move to first" t
)
109 (defcustom dired-keep-marker-rename t
110 ;; Use t as default so that moved files "take their markers with them".
111 "*Controls marking of renamed files.
112 If t, files keep their previous marks when they are renamed.
113 If a character, renamed files (whether previously marked or not)
114 are afterward marked with that character."
115 :type
'(choice (const :tag
"Keep" t
)
116 (character :tag
"Mark"))
120 (defcustom dired-keep-marker-copy ?C
121 "*Controls marking of copied files.
122 If t, copied files are marked if and as the corresponding original files were.
123 If a character, copied files are unconditionally marked with that character."
124 :type
'(choice (const :tag
"Keep" t
)
125 (character :tag
"Mark"))
129 (defcustom dired-keep-marker-hardlink ?H
130 "*Controls marking of newly made hard links.
131 If t, they are marked if and as the files linked to were marked.
132 If a character, new links are unconditionally marked with that character."
133 :type
'(choice (const :tag
"Keep" t
)
134 (character :tag
"Mark"))
138 (defcustom dired-keep-marker-symlink ?Y
139 "*Controls marking of newly made symbolic links.
140 If t, they are marked if and as the files linked to were marked.
141 If a character, new links are unconditionally marked with that character."
142 :type
'(choice (const :tag
"Keep" t
)
143 (character :tag
"Mark"))
147 (defcustom dired-dwim-target nil
148 "*If non-nil, dired tries to guess a default target directory.
149 This means: if there is a dired buffer displayed in the next window,
150 use its current subdir, instead of the current subdir of this dired buffer.
152 The target is used in the prompt for file copy, rename etc."
157 (defcustom dired-copy-preserve-time t
158 "*If non-nil, Dired preserves the last-modified time in a file copy.
159 \(This works on only some systems.)"
163 ; These variables were deleted and the replacements are on files.el.
164 ; We leave aliases behind for back-compatibility.
165 (defvaralias 'dired-free-space-program
'directory-free-space-program
)
166 (defvaralias 'dired-free-space-args
'directory-free-space-args
)
170 (defcustom dired-load-hook nil
171 "Run after loading dired.
172 You can customize key bindings or load extensions with this."
176 (defcustom dired-mode-hook nil
177 "Run at the very end of dired-mode."
181 (defcustom dired-before-readin-hook nil
182 "This hook is run before a dired buffer is read in (created or reverted)."
186 (defcustom dired-after-readin-hook nil
187 "Hook run after each time a file or directory is read by Dired.
188 After each listing of a file or directory, this hook is run
189 with the buffer narrowed to the listing."
192 ;; Note this can't simply be run inside function `dired-ls' as the hook
193 ;; functions probably depend on the dired-subdir-alist to be OK.
195 ;; Internal variables
197 (defvar dired-marker-char ?
* ; the answer is 42
198 ;; so that you can write things like
199 ;; (let ((dired-marker-char ?X))
200 ;; ;; great code using X markers ...
202 ;; For example, commands operating on two sets of files, A and B.
203 ;; Or marking files with digits 0-9. This could implicate
204 ;; concentric sets or an order for the marked files.
205 ;; The code depends on dynamic scoping on the marker char.
206 "In Dired, the current mark character.
207 This is what the `do' commands look for and what the `mark' commands store.")
209 (defvar dired-del-marker ?D
210 "Character used to flag files for deletion.")
212 (defvar dired-shrink-to-fit
214 ;; I see no reason ever to make this nil -- rms.
215 ;; (> baud-rate search-slow-speed)
216 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
218 (defvar dired-flagging-regexp nil
);; Last regexp used to flag files.
220 (defvar dired-file-version-alist
)
222 (defvar dired-directory nil
223 "The directory name or wildcard spec that this Dired directory lists.
224 Local to each dired buffer. May be a list, in which case the car is the
225 directory name and the cdr is the list of files to mention.
226 The directory name must be absolute, but need not be fully expanded.")
228 (defvar dired-actual-switches nil
229 "The value of `dired-listing-switches' used to make this buffer's text.")
231 (defvar dired-re-inode-size
"[0-9 \t]*"
232 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
234 ;; These regexps must be tested at beginning-of-line, but are also
235 ;; used to search for next matches, so neither omitting "^" nor
236 ;; replacing "^" by "\n" (to make it slightly faster) will work.
238 (defvar dired-re-mark
"^[^ \n]")
239 ;; "Regexp matching a marked line.
240 ;; Important: the match ends just after the marker."
241 (defvar dired-re-maybe-mark
"^. ")
242 ;; The [^:] part after "d" and "l" is to avoid confusion with the
243 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
244 (defvar dired-re-dir
(concat dired-re-maybe-mark dired-re-inode-size
"d[^:]"))
245 (defvar dired-re-sym
(concat dired-re-maybe-mark dired-re-inode-size
"l[^:]"))
246 (defvar dired-re-exe
;; match ls permission string of an executable file
249 (concat dired-re-maybe-mark dired-re-inode-size x
)))
250 '("-[-r][-w][xs][-r][-w].[-r][-w]."
251 "-[-r][-w].[-r][-w][xs][-r][-w]."
252 "-[-r][-w].[-r][-w].[-r][-w][xst]")
254 (defvar dired-re-perms
"[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
255 (defvar dired-re-dot
"^.* \\.\\.?$")
257 ;; The subdirectory names in this list are expanded.
258 (defvar dired-subdir-alist nil
259 "Association list of subdirectories and their buffer positions.
260 Each subdirectory has an element: (DIRNAME . STARTMARKER).
261 The order of elements is the reverse of the order in the buffer.
262 In simple cases, this list contains one element.")
264 (defvar dired-subdir-regexp
"^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
265 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
266 Subexpression 1 is the subdirectory proper, no trailing colon.
267 The match starts at the beginning of the line and ends after the end
268 of the line (\\n or \\r).
269 Subexpression 2 must end right before the \\n or \\r.")
271 (defvar dired-font-lock-keywords
274 ;; Directory headers.
275 (list dired-subdir-regexp
'(1 font-lock-type-face
))
277 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
278 ;; file name itself. We search for Dired defined regexps, and then use the
279 ;; Dired defined function `dired-move-to-filename' before searching for the
280 ;; simple regexp ".+". It is that regexp which matches the file name.
284 '(0 font-lock-constant-face
)
285 '(".+" (dired-move-to-filename) nil
(0 font-lock-warning-face
)))
286 ;; People who are paranoid about security would consider this more
287 ;; important than other things such as whether it is a directory.
288 ;; But we don't want to encourage paranoia, so our default
289 ;; should be what's most useful for non-paranoids. -- rms.
291 ;;; ;; Files that are group or world writable.
292 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
293 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
294 ;;; '(1 font-lock-comment-face)
295 ;;; '(".+" (dired-move-to-filename) nil (0 font-lock-comment-face)))
299 '(".+" (dired-move-to-filename) nil
(0 font-lock-function-name-face
)))
303 '(".+" (dired-move-to-filename) nil
(0 font-lock-keyword-face
)))
305 ;; Files suffixed with `completion-ignored-extensions'.
307 ;; It is quicker to first find just an extension, then go back to the
308 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
309 (list (concat "\\(" (regexp-opt completion-ignored-extensions
) "\\|#\\)$")
310 '(".+" (dired-move-to-filename) nil
(0 font-lock-string-face
)))))
311 "Additional expressions to highlight in Dired mode.")
313 ;;; Macros must be defined before they are used, for the byte compiler.
315 ;; Mark all files for which CONDITION evals to non-nil.
316 ;; CONDITION is evaluated on each line, with point at beginning of line.
317 ;; MSG is a noun phrase for the type of files being marked.
318 ;; It should end with a noun that can be pluralized by adding `s'.
319 ;; Return value is the number of files marked, or nil if none were marked.
320 (defmacro dired-mark-if
(predicate msg
)
321 `(let (buffer-read-only count
)
324 (if ,msg
(message "Marking %ss..." ,msg
))
325 (goto-char (point-min))
330 (insert dired-marker-char
)
331 (setq count
(1+ count
))))
333 (if ,msg
(message "%s %s%s %s%s."
336 (dired-plural-s count
)
337 (if (eq dired-marker-char ?
\040) "un" "")
338 (if (eq dired-marker-char dired-del-marker
)
339 "flagged" "marked"))))
340 (and (> count
0) count
)))
342 (defmacro dired-map-over-marks
(body arg
&optional show-progress
)
343 "Eval BODY with point on each marked line. Return a list of BODY's results.
344 If no marked file could be found, execute BODY on the current line.
345 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
346 files instead of the marked files.
347 In that case point is dragged along. This is so that commands on
348 the next ARG (instead of the marked) files can be chained easily.
349 If ARG is otherwise non-nil, use current file instead.
350 If optional third arg SHOW-PROGRESS evaluates to non-nil,
351 redisplay the dired buffer after each file is processed.
352 No guarantee is made about the position on the marked line.
353 BODY must ensure this itself if it depends on this.
354 Search starts at the beginning of the buffer, thus the car of the list
355 corresponds to the line nearest to the buffer's bottom. This
356 is also true for (positive and negative) integer values of ARG.
357 BODY should not be too long as it is expanded four times."
359 ;;Warning: BODY must not add new lines before point - this may cause an
361 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
363 (let (buffer-read-only case-fold-search found results
)
366 (progn ;; no save-excursion, want to move point.
367 (dired-repeat-over-lines
370 (if ,show-progress
(sit-for 0))
371 (setq results
(cons ,body results
)))))
375 ;; non-nil, non-integer ARG means use current file:
377 (let ((regexp (dired-marker-regexp)) next-position
)
379 (goto-char (point-min))
380 ;; remember position of next marked file before BODY
381 ;; can insert lines before the just found file,
382 ;; confusing us by finding the same marked file again
384 (setq next-position
(and (re-search-forward regexp nil t
)
386 found
(not (null next-position
)))
388 (goto-char next-position
)
389 (if ,show-progress
(sit-for 0))
390 (setq results
(cons ,body results
))
391 ;; move after last match
392 (goto-char next-position
)
394 (set-marker next-position nil
)
395 (setq next-position
(and (re-search-forward regexp nil t
)
400 ;; save-excursion loses, again
401 (dired-move-to-filename)))
403 (defun dired-get-marked-files (&optional localp arg filter
)
404 "Return the marked files' names as list of strings.
405 The list is in the same order as the buffer, that is, the car is the
407 Values returned are normally absolute file names.
408 Optional arg LOCALP as in `dired-get-filename'.
409 Optional second argument ARG specifies files near point
410 instead of marked files. If ARG is an integer, use the next ARG files.
411 If ARG is otherwise non-nil, use file. Usually ARG comes from
412 the command's prefix arg.
413 Optional third argument FILTER, if non-nil, is a function to select
414 some of the files--those for which (funcall FILTER FILENAME) is non-nil."
417 (dired-map-over-marks (dired-get-filename localp
) arg
)))
420 (nreverse all-of-them
)
421 (dolist (file all-of-them
)
422 (if (funcall filter file
)
428 (defun dired-read-dir-and-switches (str)
429 ;; For use in interactive.
431 (if current-prefix-arg
432 (read-string "Dired listing switches: "
433 dired-listing-switches
))
434 (read-file-name (format "Dired %s(directory): " str
)
435 nil default-directory nil
))))
437 ;;;###autoload (define-key ctl-x-map "d" 'dired)
439 (defun dired (dirname &optional switches
)
440 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
441 Optional second argument SWITCHES specifies the `ls' options used.
442 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
443 Dired displays a list of files in DIRNAME (which may also have
444 shell wildcards appended to select certain files). If DIRNAME is a cons,
445 its first element is taken as the directory name and the rest as an explicit
446 list of files to make directory entries for.
448 You can move around in it with the usual commands.
449 You can flag files for deletion with \\[dired-flag-file-deletion] and then
450 delete them by typing \\[dired-do-flagged-delete].
451 Type \\[describe-mode] after entering dired for more info.
453 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
454 ;; Cannot use (interactive "D") because of wildcards.
455 (interactive (dired-read-dir-and-switches ""))
456 (switch-to-buffer (dired-noselect dirname switches
)))
458 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
460 (defun dired-other-window (dirname &optional switches
)
461 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
462 (interactive (dired-read-dir-and-switches "in other window "))
463 (switch-to-buffer-other-window (dired-noselect dirname switches
)))
465 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
467 (defun dired-other-frame (dirname &optional switches
)
468 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
469 (interactive (dired-read-dir-and-switches "in other frame "))
470 (switch-to-buffer-other-frame (dired-noselect dirname switches
)))
473 (defun dired-noselect (dir-or-list &optional switches
)
474 "Like `dired' but returns the dired buffer as value, does not select it."
475 (or dir-or-list
(setq dir-or-list default-directory
))
476 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
478 (let (dirname initially-was-dirname
)
479 (if (consp dir-or-list
)
480 (setq dirname
(car dir-or-list
))
481 (setq dirname dir-or-list
))
482 (setq initially-was-dirname
483 (string= (file-name-as-directory dirname
) dirname
))
484 (setq dirname
(abbreviate-file-name
485 (expand-file-name (directory-file-name dirname
))))
486 (if find-file-visit-truename
487 (setq dirname
(file-truename dirname
)))
488 ;; If the argument was syntactically a directory name not a file name,
489 ;; or if it happens to name a file that is a directory,
490 ;; convert it syntactically to a directory name.
491 ;; The reason for checking initially-was-dirname
492 ;; and not just file-directory-p
493 ;; is that file-directory-p is slow over ftp.
494 (if (or initially-was-dirname
(file-directory-p dirname
))
495 (setq dirname
(file-name-as-directory dirname
)))
496 (if (consp dir-or-list
)
497 (setq dir-or-list
(cons dirname
(cdr dir-or-list
)))
498 (setq dir-or-list dirname
))
499 (dired-internal-noselect dir-or-list switches
)))
501 ;; Separate function from dired-noselect for the sake of dired-vms.el.
502 (defun dired-internal-noselect (dir-or-list &optional switches mode
)
503 ;; If there is an existing dired buffer for DIRNAME, just leave
504 ;; buffer as it is (don't even call dired-revert).
505 ;; This saves time especially for deep trees or with ange-ftp.
506 ;; The user can type `g'easily, and it is more consistent with find-file.
507 ;; But if SWITCHES are given they are probably different from the
508 ;; buffer's old value, so call dired-sort-other, which does
509 ;; revert the buffer.
510 ;; A pity we can't possibly do "Directory has changed - refresh? "
511 ;; like find-file does.
512 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
516 ;; note that buffer already is in dired-mode, if found
518 (old-buf (current-buffer)))
519 (if (consp dir-or-list
)
520 (setq dirname
(car dir-or-list
))
521 (setq dirname dir-or-list
))
522 ;; Look for an existing buffer.
523 (setq buffer
(dired-find-buffer-nocreate dirname mode
)
524 new-buffer-p
(null buffer
))
526 (let ((default-major-mode 'fundamental-mode
))
527 ;; We don't want default-major-mode to run hooks and set auto-fill
528 ;; or whatever, now that dired-mode does not
529 ;; kill-all-local-variables any longer.
530 (setq buffer
(create-file-buffer (directory-file-name dirname
)))))
532 (if (not new-buffer-p
) ; existing buffer ...
533 (cond (switches ; ... but new switches
534 ;; file list may have changed
535 (setq dired-directory dir-or-list
)
536 ;; this calls dired-revert
537 (dired-sort-other switches
))
538 ;; If directory has changed on disk, offer to revert.
539 ((if (let ((attributes (file-attributes dirname
))
540 (modtime (visited-file-modtime)))
542 (not (eq (car attributes
) t
))
543 (and (= (car (nth 5 attributes
)) (car modtime
))
544 (= (nth 1 (nth 5 attributes
)) (cdr modtime
)))))
547 (substitute-command-keys
548 "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
550 (setq default-directory
551 ;; We can do this unconditionally
552 ;; because dired-noselect ensures that the name
553 ;; is passed in directory name syntax
554 ;; if it was the name of a directory at all.
555 (file-name-directory dirname
))
556 (or switches
(setq switches dired-listing-switches
))
557 (if mode
(funcall mode
)
558 (dired-mode dir-or-list switches
))
559 ;; default-directory and dired-actual-switches are set now
560 ;; (buffer-local), so we can call dired-readin:
563 (progn (dired-readin)
565 ;; dired-readin can fail if parent directories are inaccessible.
566 ;; Don't leave an empty buffer around in that case.
567 (if failed
(kill-buffer buffer
))))
568 (goto-char (point-min))
569 (dired-initial-position dirname
))
573 (defvar dired-buffers nil
574 ;; Enlarged by dired-advertise
575 ;; Queried by function dired-buffers-for-dir. When this detects a
576 ;; killed buffer, it is removed from this list.
577 "Alist of expanded directories and their associated dired buffers.")
579 (defun dired-find-buffer-nocreate (dirname &optional mode
)
580 ;; This differs from dired-buffers-for-dir in that it does not consider
581 ;; subdirs of default-directory and searches for the first match only.
582 ;; Also, the major mode must be MODE.
583 (setq dirname
(expand-file-name dirname
))
584 (let (found (blist dired-buffers
)) ; was (buffer-list)
585 (or mode
(setq mode
'dired-mode
))
587 (if (null (buffer-name (cdr (car blist
))))
588 (setq blist
(cdr blist
))
590 (set-buffer (cdr (car blist
)))
591 (if (and (eq major-mode mode
)
594 (if (consp dired-directory
)
595 (car dired-directory
)
597 (setq found
(cdr (car blist
))
599 (setq blist
(cdr blist
))))))
603 ;; Read in a new dired buffer
605 ;; dired-readin differs from dired-insert-subdir in that it accepts
606 ;; wildcards, erases the buffer, and builds the subdir-alist anew
607 ;; (including making it buffer-local and clearing it first).
608 (defun dired-readin ()
609 ;; default-directory and dired-actual-switches must be buffer-local
610 ;; and initialized by now.
612 (if (consp dired-directory
)
613 (setq dirname
(car dired-directory
))
614 (setq dirname dired-directory
))
615 (setq dirname
(expand-file-name dirname
))
617 ;; This hook which may want to modify dired-actual-switches
618 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
619 ;; where ls won't understand -Al switches.
620 (run-hooks 'dired-before-readin-hook
)
621 (message "Reading directory %s..." dirname
)
622 (if (consp buffer-undo-list
)
623 (setq buffer-undo-list nil
))
624 (let (buffer-read-only
625 ;; Don't make undo entries for readin.
626 (buffer-undo-list t
))
629 (dired-readin-insert))
630 (message "Reading directory %s...done" dirname
)
631 (goto-char (point-min))
632 ;; Must first make alist buffer local and set it to nil because
633 ;; dired-build-subdir-alist will call dired-clear-alist first
634 (set (make-local-variable 'dired-subdir-alist
) nil
)
635 (dired-build-subdir-alist)
636 (let ((attributes (file-attributes dirname
)))
637 (if (eq (car attributes
) t
)
638 (set-visited-file-modtime (nth 5 attributes
))))
639 (set-buffer-modified-p nil
)
640 ;; No need to narrow since the whole buffer contains just
641 ;; dired-readin's output, nothing else. The hook can
642 ;; successfully use dired functions (e.g. dired-get-filename)
643 ;; as the subdir-alist has been built in dired-readin.
644 (run-hooks 'dired-after-readin-hook
))))
646 ;; Subroutines of dired-readin
648 (defun dired-readin-insert ()
649 ;; Insert listing for the specified dir (and maybe file list)
650 ;; already in dired-directory, assuming a clean buffer.
652 (if (consp dired-directory
)
653 (setq dir
(car dired-directory
)
654 file-list
(cdr dired-directory
))
655 (setq dir dired-directory
657 (setq dir
(expand-file-name dir
))
658 (if (and (equal "" (file-name-nondirectory dir
))
660 ;; If we are reading a whole single directory...
661 (dired-insert-directory dir dired-actual-switches nil nil t
)
662 (if (not (file-readable-p
663 (directory-file-name (file-name-directory dir
))))
664 (error "Directory %s inaccessible or nonexistent" dir
)
665 ;; Else treat it as a wildcard spec
666 ;; unless we have an explicit list of files.
667 (dired-insert-directory dir dired-actual-switches
668 file-list
(not file-list
) t
)))))
670 (defun dired-insert-directory (dir switches
&optional file-list wildcard hdr
)
671 "Insert a directory listing of DIR, Dired style.
672 Use SWITCHES to make the listings.
673 If FILE-LIST is non-nil, list only those files.
674 Otherwise, if WILDCARD is non-nil, expand wildcards;
675 in that case, DIR should be a file name that uses wildcards.
676 In other cases, DIR should be a directory name or a directory filename.
677 If HDR is non-nil, insert a header line with the directory name."
678 (let ((opoint (point))
679 (process-environment (copy-sequence process-environment
))
681 (if (or dired-use-ls-dired
(file-remote-p dir
))
682 (setq switches
(concat "--dired " switches
)))
683 ;; We used to specify the C locale here, to force English month names;
684 ;; but this should not be necessary any more,
685 ;; with the new value of dired-move-to-filename-regexp.
687 (dolist (f file-list
)
688 (insert-directory f switches nil nil
))
689 (insert-directory dir switches wildcard
(not wildcard
)))
690 ;; Quote certain characters, unless ls quoted them for us.
691 (if (not (string-match "b" dired-actual-switches
))
693 (setq end
(point-marker))
695 (while (search-forward "\\" end t
)
696 (replace-match (apply #'propertize
698 (text-properties-at (match-beginning 0)))
701 (while (search-forward "\^m" end t
)
702 (replace-match (apply #'propertize
704 (text-properties-at (match-beginning 0)))
706 (set-marker end nil
)))
707 (dired-insert-set-properties opoint
(point))
708 ;; If we used --dired and it worked, the lines are already indented.
709 ;; Otherwise, indent them.
710 (unless (save-excursion
713 (let ((indent-tabs-mode nil
))
714 (indent-rigidly opoint
(point) 2)))
715 ;; Insert text at the beginning to standardize things.
718 (if (and (or hdr wildcard
) (not (looking-at "^ /.*:$")))
719 ;; Note that dired-build-subdir-alist will replace the name
720 ;; by its expansion, so it does not matter whether what we insert
721 ;; here is fully expanded, but it should be absolute.
722 (insert " " (directory-file-name (file-name-directory dir
)) ":\n"))
724 ;; Insert "wildcard" line where "total" line would be for a full dir.
725 (insert " wildcard " (file-name-nondirectory dir
) "\n")))))
727 ;; Make the file names highlight when the mouse is on them.
728 (defun dired-insert-set-properties (beg end
)
731 (while (< (point) end
)
733 (if (dired-move-to-filename)
737 (dired-move-to-end-of-filename)
739 '(mouse-face highlight
740 help-echo
"mouse-2: visit this file in other window")))
744 ;; Reverting a dired buffer
746 (defun dired-revert (&optional arg noconfirm
)
747 ;; Reread the dired buffer. Must also be called after
748 ;; dired-actual-switches have changed.
749 ;; Should not fail even on completely garbaged buffers.
750 ;; Preserves old cursor, marks/flags, hidden-p.
751 (widen) ; just in case user narrowed
752 (let ((opoint (point))
753 (ofile (dired-get-filename nil t
))
754 (mark-alist nil
) ; save marked files
755 (hidden-subdirs (dired-remember-hidden))
756 (old-subdir-alist (cdr (reverse dired-subdir-alist
))) ; except pwd
757 (case-fold-search nil
) ; we check for upper case ls flags
759 (goto-char (point-min))
760 (setq mark-alist
;; only after dired-remember-hidden since this unhides:
761 (dired-remember-marks (point-min) (point-max)))
762 ;; treat top level dir extra (it may contain wildcards)
764 (if (consp dired-directory
) (car dired-directory
) dired-directory
))
766 (let ((dired-after-readin-hook nil
))
767 ;; don't run that hook for each subdir...
768 (dired-insert-old-subdirs old-subdir-alist
))
769 (dired-mark-remembered mark-alist
) ; mark files that were marked
770 ;; ... run the hook for the whole buffer, and only after markers
771 ;; have been reinserted (else omitting in dired-x would omit marked files)
772 (run-hooks 'dired-after-readin-hook
) ; no need to narrow
773 (or (and ofile
(dired-goto-file ofile
)) ; move cursor to where it
774 (goto-char opoint
)) ; was before
775 (dired-move-to-filename)
776 (save-excursion ; hide subdirs that were hidden
777 (mapcar (function (lambda (dir)
778 (if (dired-goto-subdir dir
)
779 (dired-hide-subdir 1))))
781 ;; outside of the let scope
782 ;;; Might as well not override the user if the user changed this.
783 ;;; (setq buffer-read-only t)
786 ;; Subroutines of dired-revert
787 ;; Some of these are also used when inserting subdirs.
789 (defun dired-remember-marks (beg end
)
790 ;; Return alist of files and their marks, from BEG to END.
791 (if selective-display
; must unhide to make this work.
792 (let (buffer-read-only)
793 (subst-char-in-region beg end ?
\r ?
\n)))
797 (while (re-search-forward dired-re-mark end t
)
798 (if (setq fil
(dired-get-filename nil t
))
799 (setq chr
(preceding-char)
800 alist
(cons (cons fil chr
) alist
)))))
803 ;; Mark all files remembered in ALIST.
804 ;; Each element of ALIST looks like (FILE . MARKERCHAR).
805 (defun dired-mark-remembered (alist)
808 (setq elt
(car alist
)
812 (if (dired-goto-file fil
)
818 ;; Return a list of names of subdirs currently hidden.
819 (defun dired-remember-hidden ()
820 (let ((l dired-subdir-alist
) dir pos result
)
822 (setq dir
(car (car l
))
826 (skip-chars-forward "^\r\n")
827 (if (eq (following-char) ?
\r)
828 (setq result
(cons dir result
))))
831 ;; Try to insert all subdirs that were displayed before,
832 ;; according to the former subdir alist OLD-SUBDIR-ALIST.
833 (defun dired-insert-old-subdirs (old-subdir-alist)
834 (or (string-match "R" dired-actual-switches
)
836 (while old-subdir-alist
837 (setq elt
(car old-subdir-alist
)
838 old-subdir-alist
(cdr old-subdir-alist
)
843 (dired-insert-subdir dir
))
846 ;; Remove directory DIR from any directory cache.
847 (defun dired-uncache (dir)
848 (let ((handler (find-file-name-handler dir
'dired-uncache
)))
850 (funcall handler
'dired-uncache dir
))))
852 ;; dired mode key bindings and initialization
854 (defvar dired-mode-map nil
"Local keymap for dired-mode buffers.")
857 ;; This looks ugly when substitute-command-keys uses C-d instead d:
858 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
860 (let ((map (make-keymap)))
861 (suppress-keymap map
)
862 (define-key map
[mouse-2
] 'dired-mouse-find-file-other-window
)
863 ;; Commands to mark or flag certain categories of files
864 (define-key map
"#" 'dired-flag-auto-save-files
)
865 (define-key map
"." 'dired-clean-directory
)
866 (define-key map
"~" 'dired-flag-backup-files
)
867 (define-key map
"&" 'dired-flag-garbage-files
)
868 ;; Upper case keys (except !) for operating on the marked files
869 (define-key map
"A" 'dired-do-search
)
870 (define-key map
"C" 'dired-do-copy
)
871 (define-key map
"B" 'dired-do-byte-compile
)
872 (define-key map
"D" 'dired-do-delete
)
873 (define-key map
"G" 'dired-do-chgrp
)
874 (define-key map
"H" 'dired-do-hardlink
)
875 (define-key map
"L" 'dired-do-load
)
876 (define-key map
"M" 'dired-do-chmod
)
877 (define-key map
"O" 'dired-do-chown
)
878 (define-key map
"P" 'dired-do-print
)
879 (define-key map
"Q" 'dired-do-query-replace-regexp
)
880 (define-key map
"R" 'dired-do-rename
)
881 (define-key map
"S" 'dired-do-symlink
)
882 (define-key map
"X" 'dired-do-shell-command
)
883 (define-key map
"Z" 'dired-do-compress
)
884 (define-key map
"!" 'dired-do-shell-command
)
885 ;; Comparison commands
886 (define-key map
"=" 'dired-diff
)
887 (define-key map
"\M-=" 'dired-backup-diff
)
888 ;; Tree Dired commands
889 (define-key map
"\M-\C-?" 'dired-unmark-all-files
)
890 (define-key map
"\M-\C-d" 'dired-tree-down
)
891 (define-key map
"\M-\C-u" 'dired-tree-up
)
892 (define-key map
"\M-\C-n" 'dired-next-subdir
)
893 (define-key map
"\M-\C-p" 'dired-prev-subdir
)
894 ;; move to marked files
895 (define-key map
"\M-{" 'dired-prev-marked-file
)
896 (define-key map
"\M-}" 'dired-next-marked-file
)
897 ;; Make all regexp commands share a `%' prefix:
898 ;; We used to get to the submap via a symbol dired-regexp-prefix,
899 ;; but that seems to serve little purpose, and copy-keymap
900 ;; does a better job without it.
901 (define-key map
"%" nil
)
902 (define-key map
"%u" 'dired-upcase
)
903 (define-key map
"%l" 'dired-downcase
)
904 (define-key map
"%d" 'dired-flag-files-regexp
)
905 (define-key map
"%g" 'dired-mark-files-containing-regexp
)
906 (define-key map
"%m" 'dired-mark-files-regexp
)
907 (define-key map
"%r" 'dired-do-rename-regexp
)
908 (define-key map
"%C" 'dired-do-copy-regexp
)
909 (define-key map
"%H" 'dired-do-hardlink-regexp
)
910 (define-key map
"%R" 'dired-do-rename-regexp
)
911 (define-key map
"%S" 'dired-do-symlink-regexp
)
912 ;; Commands for marking and unmarking.
913 (define-key map
"*" nil
)
914 (define-key map
"**" 'dired-mark-executables
)
915 (define-key map
"*/" 'dired-mark-directories
)
916 (define-key map
"*@" 'dired-mark-symlinks
)
917 (define-key map
"*%" 'dired-mark-files-regexp
)
918 (define-key map
"*c" 'dired-change-marks
)
919 (define-key map
"*s" 'dired-mark-subdir-files
)
920 (define-key map
"*m" 'dired-mark
)
921 (define-key map
"*u" 'dired-unmark
)
922 (define-key map
"*?" 'dired-unmark-all-files
)
923 (define-key map
"*!" 'dired-unmark-all-marks
)
924 (define-key map
"*\177" 'dired-unmark-backward
)
925 (define-key map
"*\C-n" 'dired-next-marked-file
)
926 (define-key map
"*\C-p" 'dired-prev-marked-file
)
927 (define-key map
"*t" 'dired-toggle-marks
)
928 ;; Lower keys for commands not operating on all the marked files
929 (define-key map
"a" 'dired-find-alternate-file
)
930 (define-key map
"d" 'dired-flag-file-deletion
)
931 (define-key map
"e" 'dired-find-file
)
932 (define-key map
"f" 'dired-find-file
)
933 (define-key map
"\C-m" 'dired-advertised-find-file
)
934 (define-key map
"g" 'revert-buffer
)
935 (define-key map
"h" 'describe-mode
)
936 (define-key map
"i" 'dired-maybe-insert-subdir
)
937 (define-key map
"k" 'dired-do-kill-lines
)
938 (define-key map
"l" 'dired-do-redisplay
)
939 (define-key map
"m" 'dired-mark
)
940 (define-key map
"n" 'dired-next-line
)
941 (define-key map
"o" 'dired-find-file-other-window
)
942 (define-key map
"\C-o" 'dired-display-file
)
943 (define-key map
"p" 'dired-previous-line
)
944 (define-key map
"q" 'quit-window
)
945 (define-key map
"s" 'dired-sort-toggle-or-edit
)
946 (define-key map
"t" 'dired-toggle-marks
)
947 (define-key map
"u" 'dired-unmark
)
948 (define-key map
"v" 'dired-view-file
)
949 (define-key map
"w" 'dired-copy-filename-as-kill
)
950 (define-key map
"x" 'dired-do-flagged-delete
)
951 (define-key map
"y" 'dired-show-file-type
)
952 (define-key map
"+" 'dired-create-directory
)
954 (define-key map
"<" 'dired-prev-dirline
)
955 (define-key map
">" 'dired-next-dirline
)
956 (define-key map
"^" 'dired-up-directory
)
957 (define-key map
" " 'dired-next-line
)
958 (define-key map
"\C-n" 'dired-next-line
)
959 (define-key map
"\C-p" 'dired-previous-line
)
960 (define-key map
[down] 'dired-next-line)
961 (define-key map [up] 'dired-previous-line)
963 (define-key map "$" 'dired-hide-subdir)
964 (define-key map "\M-$" 'dired-hide-all)
966 (define-key map "?" 'dired-summary)
967 (define-key map "\177" 'dired-unmark-backward)
968 (define-key map "\C-_" 'dired-undo)
969 (define-key map "\C-xu" 'dired-undo)
971 ;; Make menu bar items.
973 ;; No need to fo this, now that top-level items are fewer.
975 ;; Get rid of the Edit menu bar item to save space.
976 ;(define-key map [menu-bar edit] 'undefined)
978 (define-key map [menu-bar subdir]
979 (cons "Subdir" (make-sparse-keymap "Subdir")))
981 (define-key map [menu-bar subdir hide-all]
982 '(menu-item "Hide All" dired-hide-all
983 :help "Hide all subdirectories, leave only header lines"))
984 (define-key map [menu-bar subdir hide-subdir]
985 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
986 :help "Hide or unhide current directory listing"))
987 (define-key map [menu-bar subdir tree-down]
988 '(menu-item "Tree Down" dired-tree-down
989 :help "Go to first subdirectory header down the tree"))
990 (define-key map [menu-bar subdir tree-up]
991 '(menu-item "Tree Up" dired-tree-up
992 :help "Go to first subdirectory header up the tree"))
993 (define-key map [menu-bar subdir up]
994 '(menu-item "Up Directory" dired-up-directory
995 :help "Edit the parent directory"))
996 (define-key map [menu-bar subdir prev-subdir]
997 '(menu-item "Prev Subdir" dired-prev-subdir
998 :help "Go to previous subdirectory header line"))
999 (define-key map [menu-bar subdir next-subdir]
1000 '(menu-item "Next Subdir" dired-next-subdir
1001 :help "Go to next subdirectory header line"))
1002 (define-key map [menu-bar subdir prev-dirline]
1003 '(menu-item "Prev Dirline" dired-prev-dirline
1004 :help "Move to next directory-file line"))
1005 (define-key map [menu-bar subdir next-dirline]
1006 '(menu-item "Next Dirline" dired-next-dirline
1007 :help "Move to previous directory-file line"))
1008 (define-key map [menu-bar subdir insert]
1009 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1010 :help "Insert contents of subdirectory"))
1012 (define-key map [menu-bar immediate]
1013 (cons "Immediate" (make-sparse-keymap "Immediate")))
1015 (define-key map [menu-bar immediate revert-buffer]
1016 '(menu-item "Refresh" revert-buffer
1017 :help "Update contents of shown directories"))
1019 (define-key map [menu-bar immediate dashes]
1022 (define-key map [menu-bar immediate backup-diff]
1023 '(menu-item "Compare with Backup" dired-backup-diff
1024 :help "Diff file at cursor with its latest backup"))
1025 (define-key map [menu-bar immediate diff]
1026 '(menu-item "Diff..." dired-diff
1027 :help "Compare file at cursor with another file"))
1028 (define-key map [menu-bar immediate view]
1029 '(menu-item "View This File" dired-view-file
1030 :help "Examine file at cursor in read-only mode"))
1031 (define-key map [menu-bar immediate display]
1032 '(menu-item "Display in Other Window" dired-display-file
1033 :help "Display file at cursor in other window"))
1034 (define-key map [menu-bar immediate find-file-other-window]
1035 '(menu-item "Find in Other Window" dired-find-file-other-window
1036 :help "Edit file at cursor in other window"))
1037 (define-key map [menu-bar immediate find-file]
1038 '(menu-item "Find This File" dired-find-file
1039 :help "Edit file at cursor"))
1040 (define-key map [menu-bar immediate create-directory]
1041 '(menu-item "Create Directory..." dired-create-directory))
1043 (define-key map [menu-bar regexp]
1044 (cons "Regexp" (make-sparse-keymap "Regexp")))
1046 (define-key map [menu-bar regexp downcase]
1047 '(menu-item "Downcase" dired-downcase
1048 ;; When running on plain MS-DOS, there's only one
1049 ;; letter-case for file names.
1050 :enable (or (not (fboundp 'msdos-long-file-names))
1051 (msdos-long-file-names))
1052 :help "Rename marked files to lower-case name"))
1053 (define-key map [menu-bar regexp upcase]
1054 '(menu-item "Upcase" dired-upcase
1055 :enable (or (not (fboundp 'msdos-long-file-names))
1056 (msdos-long-file-names))
1057 :help "Rename marked files to upper-case name"))
1058 (define-key map [menu-bar regexp hardlink]
1059 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1060 :help "Make hard links for files matching regexp"))
1061 (define-key map [menu-bar regexp symlink]
1062 '(menu-item "Symlink..." dired-do-symlink-regexp
1063 :visible (fboundp 'make-symbolic-link)
1064 :help "Make symbolic links for files matching regexp"))
1065 (define-key map [menu-bar regexp rename]
1066 '(menu-item "Rename..." dired-do-rename-regexp
1067 :help "Rename marked files matching regexp"))
1068 (define-key map [menu-bar regexp copy]
1069 '(menu-item "Copy..." dired-do-copy-regexp
1070 :help "Copy marked files matching regexp"))
1071 (define-key map [menu-bar regexp flag]
1072 '(menu-item "Flag..." dired-flag-files-regexp
1073 :help "Flag files matching regexp for deletion"))
1074 (define-key map [menu-bar regexp mark]
1075 '(menu-item "Mark..." dired-mark-files-regexp
1076 :help "Mark files matching regexp for future operations"))
1077 (define-key map [menu-bar regexp mark-cont]
1078 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1079 :help "Mark files whose contents matches regexp"))
1081 (define-key map [menu-bar mark]
1082 (cons "Mark" (make-sparse-keymap "Mark")))
1084 (define-key map [menu-bar mark prev]
1085 '(menu-item "Previous Marked" dired-prev-marked-file
1086 :help "Move to previous marked file"))
1087 (define-key map [menu-bar mark next]
1088 '(menu-item "Next Marked" dired-next-marked-file
1089 :help "Move to next marked file"))
1090 (define-key map [menu-bar mark marks]
1091 '(menu-item "Change Marks..." dired-change-marks
1092 :help "Replace marker with another character"))
1093 (define-key map [menu-bar mark unmark-all]
1094 '(menu-item "Unmark All" dired-unmark-all-marks))
1095 (define-key map [menu-bar mark symlinks]
1096 '(menu-item "Mark Symlinks" dired-mark-symlinks
1097 :visible (fboundp 'make-symbolic-link)
1098 :help "Mark all symbolic links"))
1099 (define-key map [menu-bar mark directories]
1100 '(menu-item "Mark Directories" dired-mark-directories
1101 :help "Mark all directories except `.' and `..'"))
1102 (define-key map [menu-bar mark directory]
1103 '(menu-item "Mark Old Backups" dired-clean-directory
1104 :help "Flag old numbered backups for deletion"))
1105 (define-key map [menu-bar mark executables]
1106 '(menu-item "Mark Executables" dired-mark-executables
1107 :help "Mark all executable files"))
1108 (define-key map [menu-bar mark garbage-files]
1109 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1110 :help "Flag unneeded files for deletion"))
1111 (define-key map [menu-bar mark backup-files]
1112 '(menu-item "Flag Backup Files" dired-flag-backup-files
1113 :help "Flag all backup files for deletion"))
1114 (define-key map [menu-bar mark auto-save-files]
1115 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1116 :help "Flag auto-save files for deletion"))
1117 (define-key map [menu-bar mark deletion]
1118 '(menu-item "Flag" dired-flag-file-deletion
1119 :help "Flag current line's file for deletion"))
1120 (define-key map [menu-bar mark unmark]
1121 '(menu-item "Unmark" dired-unmark
1122 :help "Unmark or unflag current line's file"))
1123 (define-key map [menu-bar mark mark]
1124 '(menu-item "Mark" dired-mark
1125 :help "Mark current line's file for future operations"))
1126 (define-key map [menu-bar mark toggle-marks]
1127 '(menu-item "Toggle Marks" dired-toggle-marks
1128 :help "Mark unmarked files, unmark marked ones"))
1130 (define-key map [menu-bar operate]
1131 (cons "Operate" (make-sparse-keymap "Operate")))
1133 (define-key map [menu-bar operate query-replace]
1134 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1135 :help "Replace regexp in marked files"))
1136 (define-key map [menu-bar operate search]
1137 '(menu-item "Search Files..." dired-do-search
1138 :help "Search marked files for regexp"))
1139 (define-key map [menu-bar operate chown]
1140 '(menu-item "Change Owner..." dired-do-chown
1141 :visible (not (memq system-type '(ms-dos windows-nt)))
1142 :help "Change the owner of marked files"))
1143 (define-key map [menu-bar operate chgrp]
1144 '(menu-item "Change Group..." dired-do-chgrp
1145 :visible (not (memq system-type '(ms-dos windows-nt)))
1146 :help "Change the group of marked files"))
1147 (define-key map [menu-bar operate chmod]
1148 '(menu-item "Change Mode..." dired-do-chmod
1149 :help "Change mode (attributes) of marked files"))
1150 (define-key map [menu-bar operate load]
1151 '(menu-item "Load" dired-do-load
1152 :help "Load marked Emacs Lisp files"))
1153 (define-key map [menu-bar operate compile]
1154 '(menu-item "Byte-compile" dired-do-byte-compile
1155 :help "Byte-compile marked Emacs Lisp files"))
1156 (define-key map [menu-bar operate compress]
1157 '(menu-item "Compress" dired-do-compress
1158 :help "Compress/uncompress marked files"))
1159 (define-key map [menu-bar operate print]
1160 '(menu-item "Print..." dired-do-print
1161 :help "Ask for print command and print marked files"))
1162 (define-key map [menu-bar operate hardlink]
1163 '(menu-item "Hardlink to..." dired-do-hardlink
1164 :help "Make hard links for current or marked files"))
1165 (define-key map [menu-bar operate symlink]
1166 '(menu-item "Symlink to..." dired-do-symlink
1167 :visible (fboundp 'make-symbolic-link)
1168 :help "Make symbolic links for current or marked files"))
1169 (define-key map [menu-bar operate command]
1170 '(menu-item "Shell Command..." dired-do-shell-command
1171 :help "Run a shell command on each of marked files"))
1172 (define-key map [menu-bar operate delete]
1173 '(menu-item "Delete" dired-do-delete
1174 :help "Delete current file or all marked files"))
1175 (define-key map [menu-bar operate rename]
1176 '(menu-item "Rename to..." dired-do-rename
1177 :help "Rename current file or move marked files"))
1178 (define-key map [menu-bar operate copy]
1179 '(menu-item "Copy to..." dired-do-copy
1180 :help "Copy current file or all marked files"))
1182 (setq dired-mode-map map)))
1184 ;; Dired mode is suitable only for specially formatted data.
1185 (put 'dired-mode 'mode-class 'special)
1187 (defun dired-mode (&optional dirname switches)
1189 Mode for \"editing\" directory listings.
1190 In Dired, you are \"editing\" a list of the files in a directory and
1191 \(optionally) its subdirectories, in the format of `ls -lR'.
1192 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1193 \"Editing\" means that you can run shell commands on files, visit,
1194 compress, load or byte-compile them, change their file attributes
1195 and insert subdirectories into the same buffer. You can \"mark\"
1196 files for later commands or \"flag\" them for deletion, either file
1197 by file or all files matching certain criteria.
1198 You can move using the usual cursor motion commands.\\<dired-mode-map>
1199 Letters no longer insert themselves. Digits are prefix arguments.
1200 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1201 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1202 Most commands operate on the marked files and use the current file
1203 if no files are marked. Use a numeric prefix argument to operate on
1204 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1205 to operate on the current file only. Prefix arguments override marks.
1206 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1207 to see why something went wrong.
1208 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1209 Type \\[dired-unmark-backward] to back up one line and unflag.
1210 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1211 Type \\[dired-advertised-find-file] to Find the current line's file
1212 (or dired it in another buffer, if it is a directory).
1213 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1214 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1215 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1216 Type \\[dired-do-copy] to Copy files.
1217 Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
1218 Type \\[revert-buffer] to read all currently expanded directories again.
1219 This retains all marks and hides subdirs again that were hidden before.
1220 SPC and DEL can be used to move down and up by lines.
1222 If dired ever gets confused, you can either type \\[revert-buffer] \
1224 directories again, type \\[dired-do-redisplay] \
1225 to relist a single or the marked files or a
1226 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1227 again for the directory tree.
1229 Customization variables (rename this buffer and type \\[describe-variable] on each line
1232 dired-listing-switches
1233 dired-trivial-filenames
1237 dired-keep-marker-rename
1238 dired-keep-marker-copy
1239 dired-keep-marker-hardlink
1240 dired-keep-marker-symlink
1242 Hooks (use \\[describe-variable] to see their documentation):
1244 dired-before-readin-hook
1245 dired-after-readin-hook
1251 ;; Not to be called interactively (e.g. dired-directory will be set
1252 ;; to default-directory, which is wrong with wildcards).
1253 (kill-all-local-variables)
1254 (use-local-map dired-mode-map)
1255 (dired-advertise) ; default-directory is already set
1256 (setq major-mode 'dired-mode
1258 ;; case-fold-search nil
1260 selective-display t ; for subdirectory hiding
1261 mode-line-buffer-identification
1262 (propertized-buffer-identification "%17b"))
1263 (set (make-local-variable 'revert-buffer-function)
1264 (function dired-revert))
1265 (set (make-local-variable 'page-delimiter)
1267 (set (make-local-variable 'dired-directory)
1268 (or dirname default-directory))
1269 ;; list-buffers uses this to display the dir being edited in this buffer.
1270 (set (make-local-variable 'list-buffers-directory)
1271 (expand-file-name dired-directory))
1272 (set (make-local-variable 'dired-actual-switches)
1273 (or switches dired-listing-switches))
1274 (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
1275 (dired-sort-other dired-actual-switches t)
1276 (run-hooks 'dired-mode-hook))
1278 ;; Idiosyncratic dired commands that don't deal with marks.
1280 (defun dired-summary ()
1281 "Summarize basic Dired commands and show recent Dired errors."
1284 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1286 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1288 (defun dired-undo ()
1289 "Undo in a dired buffer.
1290 This doesn't recover lost files, it just undoes changes in the buffer itself.
1291 You can use it to recover marks, killed lines or subdirs.
1292 In the latter case, you have to do \\[dired-build-subdir-alist] to
1293 parse the buffer again."
1295 (let (buffer-read-only)
1297 (message "Change in Dired buffer undone.
1298 Actual changes in files cannot be undone by Emacs.")))
1300 (defun dired-next-line (arg)
1301 "Move down lines then position at filename.
1302 Optional prefix ARG says how many lines to move; default is one line."
1305 (dired-move-to-filename))
1307 (defun dired-previous-line (arg)
1308 "Move up lines then position at filename.
1309 Optional prefix ARG says how many lines to move; default is one line."
1312 (dired-move-to-filename))
1314 (defun dired-next-dirline (arg &optional opoint)
1315 "Goto ARG'th next directory file line."
1317 (or opoint (setq opoint (point)))
1319 (re-search-forward dired-re-dir nil t arg)
1321 (re-search-backward dired-re-dir nil t (- arg)))
1322 (dired-move-to-filename) ; user may type `i' or `f'
1324 (error "No more subdirectories")))
1326 (defun dired-prev-dirline (arg)
1327 "Goto ARG'th previous directory file line."
1329 (dired-next-dirline (- arg)))
1331 (defun dired-up-directory (&optional other-window)
1332 "Run Dired on parent directory of current directory.
1333 Find the parent directory either in this buffer or another buffer.
1334 Creates a buffer if necessary."
1336 (let* ((dir (dired-current-directory))
1337 (up (file-name-directory (directory-file-name dir))))
1338 (or (dired-goto-file (directory-file-name dir))
1339 ;; Only try dired-goto-subdir if buffer has more than one dir.
1340 (and (cdr dired-subdir-alist)
1341 (dired-goto-subdir up))
1344 (dired-other-window up)
1346 (dired-goto-file dir)))))
1348 (defun dired-get-file-for-visit ()
1349 "Get the current line's file name, with an error if file does not exist."
1351 (let ((file-name (file-name-sans-versions (dired-get-filename) t)))
1352 (if (file-exists-p file-name)
1354 (if (file-symlink-p file-name)
1355 (error "File is a symlink to a nonexistent target")
1356 (error "File no longer exists; type `g' to update Dired buffer")))))
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 (find-file (dired-get-file-for-visit)))
1365 (defun dired-find-alternate-file ()
1366 "In Dired, visit this file or directory instead of the dired buffer."
1368 (set-buffer-modified-p nil)
1369 (find-alternate-file (dired-get-file-for-visit)))
1370 ;; Don't override the setting from .emacs.
1371 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1373 (defun dired-mouse-find-file-other-window (event)
1374 "In Dired, visit the file or directory name you click on."
1376 (let (window pos file)
1378 (setq window (posn-window (event-end event))
1379 pos (posn-point (event-end event)))
1380 (if (not (windowp window))
1381 (error "No file chosen"))
1382 (set-buffer (window-buffer window))
1384 (setq file (dired-get-file-for-visit)))
1385 (select-window window)
1386 (find-file-other-window (file-name-sans-versions file t))))
1388 (defcustom dired-view-command-alist
1389 '(("[.]ps\\'" . "gv -spartan -color -watch")
1390 ("[.]pdf\\'" . "xpdf")
1391 ("[.]dvi\\'" . "xdvi -sidemargin 0.5 -topmargin 1"))
1392 "Alist specifying how to view special types of files.
1393 Each element has the form (REGEXP . SHELL-COMMAND).
1394 When the file name matches REGEXP, `dired-view-file'
1395 invokes SHELL-COMMAND to view the file, putting the file name
1396 at the end of the command."
1398 :type '(alist :key-type regexp :value-type string)
1401 (defun dired-view-file ()
1402 "In Dired, examine a file in view mode, returning to dired when done.
1403 When file is a directory, show it in this buffer if it is inserted.
1404 Some kinds of files are displayed using external viewer programs;
1405 see `dired-view-command-alist'. Otherwise, display it in another buffer."
1407 (let ((file (dired-get-file-for-visit)))
1408 (if (file-directory-p file)
1409 (or (and (cdr dired-subdir-alist)
1410 (dired-goto-subdir file))
1413 ;; Look for some other way to view a certain file.
1414 (dolist (elt dired-view-command-alist)
1415 (if (string-match (car elt) file)
1416 (setq cmd (cdr elt))))
1418 (dired-run-shell-command (concat cmd " "
1419 (shell-quote-argument file)))
1420 (view-file file))))))
1422 (defun dired-find-file-other-window ()
1423 "In Dired, visit this file or directory in another window."
1425 (find-file-other-window (dired-get-file-for-visit)))
1427 (defun dired-display-file ()
1428 "In Dired, display this file or directory in another window."
1430 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1432 ;;; Functions for extracting and manipulating file names in Dired buffers.
1434 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1435 "In Dired, return name of file mentioned on this line.
1436 Value returned normally includes the directory name.
1437 Optional arg LOCALP with value `no-dir' means don't include directory
1438 name in result. A value of `verbatim' means to return the name exactly as
1439 it occurs in the buffer, and a value of t means construct name relative to
1440 `default-directory', which still may contain slashes if in a subdirectory.
1441 Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1442 this line, otherwise an error occurs."
1443 (let (case-fold-search file p1 p2 already-absolute)
1445 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1446 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1447 ;; nil if no file on this line, but no-error-if-not-filep is t:
1448 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1450 ;; Get rid of the mouse-face property that file names have.
1451 (set-text-properties 0 (length file) nil file)
1452 ;; Unquote names quoted by ls or by dired-insert-directory.
1453 ;; Using read to unquote is much faster than substituting
1454 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1458 ;; Some ls -b don't escape quotes, argh!
1459 ;; This is not needed for GNU ls, though.
1460 (or (dired-string-replace-match
1461 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
1464 (and file (file-name-absolute-p file)
1465 ;; A relative file name can start with ~.
1466 ;; Don't treat it as absolute in this context.
1467 (not (eq (aref file 0) ?~))
1468 (setq already-absolute t))
1469 (and file buffer-file-coding-system
1470 (not file-name-coding-system)
1471 (not default-file-name-coding-system)
1472 (setq file (encode-coding-string file buffer-file-coding-system)))
1476 ((eq localp 'verbatim)
1478 ((and (eq localp 'no-dir) already-absolute)
1479 (file-name-nondirectory file))
1481 (let ((handler (find-file-name-handler file nil)))
1482 ;; check for safe-magic property so that we won't
1483 ;; put /: for names that don't really need them.
1484 ;; For instance, .gz files when auto-compression-mode is on.
1485 (if (and handler (not (get handler 'safe-magic)))
1488 ((eq localp 'no-dir)
1490 ((equal (dired-current-directory) "/")
1491 (setq file (concat (dired-current-directory localp) file))
1492 (let ((handler (find-file-name-handler file nil)))
1493 ;; check for safe-magic property so that we won't
1494 ;; put /: for names that don't really need them.
1495 ;; For instance, .gz files when auto-compression-mode is on.
1496 (if (and handler (not (get handler 'safe-magic)))
1500 (concat (dired-current-directory localp) file)))))
1502 (defun dired-string-replace-match (regexp string newtext
1503 &optional literal global)
1504 "Replace first match of REGEXP in STRING with NEWTEXT.
1505 If it does not match, nil is returned instead of the new string.
1506 Optional arg LITERAL means to take NEWTEXT literally.
1507 Optional arg GLOBAL means to replace all matches."
1509 (let ((start 0) ret)
1510 (while (string-match regexp string start)
1511 (let ((from-end (- (length string) (match-end 0))))
1512 (setq ret (setq string (replace-match newtext t literal string)))
1513 (setq start (- (length string) from-end))))
1515 (if (not (string-match regexp string 0))
1517 (replace-match newtext t literal string))))
1519 (defun dired-make-absolute (file &optional dir)
1520 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1521 ;; We can't always use expand-file-name as this would get rid of `.'
1522 ;; or expand in / instead default-directory if DIR=="".
1523 ;; This should be good enough for ange-ftp, but might easily be
1524 ;; redefined (for VMS?).
1525 ;; It should be reasonably fast, though, as it is called in
1526 ;; dired-get-filename.
1527 (concat (or dir default-directory) file))
1529 (defun dired-make-relative (file &optional dir ignore)
1530 "Convert FILE (an absolute file name) to a name relative to DIR.
1531 If this is impossible, return FILE unchanged.
1532 DIR must be a directory name, not a file name."
1533 (or dir (setq dir default-directory))
1534 ;; This case comes into play if default-directory is set to
1536 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1537 (setq dir (expand-file-name dir)))
1538 (if (string-match (concat "^" (regexp-quote dir)) file)
1539 (substring file (match-end 0))
1541 ;;; (error "%s: not in directory tree growing at %s" file dir))
1544 ;;; Functions for finding the file name in a dired buffer line.
1546 (defvar dired-move-to-filename-regexp
1547 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
1548 ;; In some locales, month abbreviations are as short as 2 letters,
1549 ;; and they can be followed by ".".
1550 (month (concat l l "+\\.?"))
1552 (yyyy "[0-9][0-9][0-9][0-9]")
1554 (HH:MM "[ 0-2][0-9]:[0-5][0-9]")
1555 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
1556 (zone "[-+][0-2][0-9][0-5][0-9]")
1557 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
1558 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
1559 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
1560 "\\|" yyyy "-" iso-mm-dd "\\)"))
1561 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
1563 "\\(" HH:MM "\\|" yyyy "\\)"))
1564 (western-comma (concat month s "+" dd "," s "+" yyyy))
1565 ;; Japanese MS-Windows ls-lisp has one-digit months, and
1566 ;; omits the Kanji characters after month and day-of-month.
1569 (concat mm l "?" s dd l "?" s "+"
1570 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
1571 ;; The "[0-9]" below requires the previous column to end in a digit.
1572 ;; This avoids recognizing `1 may 1997' as a date in the line:
1573 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
1574 ;; The "[kMGTPEZY]?" below supports "ls -alh" output.
1575 ;; The ".*" below finds the last match if there are multiple matches.
1576 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
1577 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1578 (concat ".*[0-9][kMGTPEZY]?" s
1579 "\\(" western "\\|" western-comma "\\|" japanese "\\|" iso "\\)"
1581 "Regular expression to match up to the file name in a directory listing.
1582 The default value is designed to recognize dates and times
1583 regardless of the language.")
1585 (defvar dired-permission-flags-regexp
1586 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1587 "Regular expression to match the permission flags in `ls -l'.")
1589 ;; Move to first char of filename on this line.
1590 ;; Returns position (point) or nil if no filename on this line."
1591 (defun dired-move-to-filename (&optional raise-error eol)
1592 ;; This is the UNIX version.
1593 (or eol (setq eol (line-end-position)))
1595 ;; First try assuming `ls --dired' was used.
1596 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1598 ((and change (< change eol))
1600 ((re-search-forward dired-move-to-filename-regexp eol t)
1601 (goto-char (match-end 0)))
1602 ((re-search-forward dired-permission-flags-regexp eol t)
1603 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1604 (funcall (if raise-error 'error 'message)
1605 "Unrecognized line! Check dired-move-to-filename-regexp"))
1607 (error "No file on this line")))))
1609 (defun dired-move-to-end-of-filename (&optional no-error)
1610 ;; Assumes point is at beginning of filename,
1611 ;; thus the rwx bit re-search-backward below will succeed in *this*
1612 ;; line if at all. So, it should be called only after
1613 ;; (dired-move-to-filename t).
1614 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1615 ;; This is the UNIX version.
1616 (if (get-text-property (point) 'dired-filename)
1617 (goto-char (next-single-property-change (point) 'dired-filename))
1618 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1619 ;; case-fold-search is nil now, so we can test for capital F:
1620 (setq used-F (string-match "F" dired-actual-switches)
1622 eol (save-excursion (end-of-line) (point))
1623 hidden (and selective-display
1624 (save-excursion (search-forward "\r" eol t))))
1627 (save-excursion ;; Find out what kind of file this is:
1628 ;; Restrict perm bits to be non-blank,
1629 ;; otherwise this matches one char to early (looking backward):
1630 ;; "l---------" (some systems make symlinks that way)
1631 ;; "----------" (plain file with zero perms)
1632 (if (re-search-backward
1633 dired-permission-flags-regexp nil t)
1634 (setq file-type (char-after (match-beginning 1))
1635 symlink (eq file-type ?l)
1636 ;; Only with -F we need to know whether it's an executable
1640 "[xst]" ;; execute bit set anywhere?
1642 (buffer-substring (match-beginning 2)
1644 (buffer-substring (match-beginning 3)
1646 (buffer-substring (match-beginning 4)
1648 (or no-error (error "No file on this line"))))
1649 ;; Move point to end of name:
1651 (if (search-forward " ->" eol t)
1655 dired-ls-F-marks-symlinks
1656 (eq (preceding-char) ?@) ;; did ls really mark the link?
1657 (forward-char -1))))
1658 (goto-char eol) ;; else not a symbolic link
1659 ;; ls -lF marks dirs, sockets and executables with exactly one
1660 ;; trailing character. (Executable bits on symlinks ain't mean
1661 ;; a thing, even to ls, but we know it's not a symlink.)
1663 (or (memq file-type '(?d ?s))
1665 (forward-char -1))))
1667 (not (eq opoint (point)))
1669 (substitute-command-keys
1670 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1671 "No file on this line")))
1672 (if (eq opoint (point))
1677 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1679 (defun dired-copy-filename-as-kill (&optional arg)
1680 "Copy names of marked (or next ARG) files into the kill ring.
1681 The names are separated by a space.
1682 With a zero prefix arg, use the complete pathname of each marked file.
1683 With \\[universal-argument], use the relative pathname of each marked file.
1685 If on a subdir headerline, use subdirname instead; prefix arg is ignored
1688 You can then feed the file name(s) to other commands with \\[yank]."
1691 (or (dired-get-subdir)
1692 (mapconcat (function identity)
1694 (cond ((zerop (prefix-numeric-value arg))
1695 (dired-get-marked-files))
1697 (dired-get-marked-files 'no-dir arg))
1699 (dired-get-marked-files t)))
1700 (dired-get-marked-files 'no-dir))
1702 (if (eq last-command 'kill-region)
1703 (kill-append string nil)
1705 (message "%s" string)))
1708 ;; Keeping Dired buffers in sync with the filesystem and with each other
1710 (defun dired-buffers-for-dir (dir &optional file)
1711 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1712 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1714 ;; The list is in reverse order of buffer creation, most recent last.
1715 ;; As a side effect, killed dired buffers for DIR are removed from
1717 (setq dir (file-name-as-directory dir))
1718 (let ((alist dired-buffers) result elt buf pattern)
1720 (setq elt (car alist)
1722 (if (buffer-name buf)
1723 (if (dired-in-this-tree dir (car elt))
1724 (with-current-buffer buf
1725 (and (assoc dir dired-subdir-alist)
1728 (file-name-nondirectory dired-directory)))
1729 (or (= 0 (length wildcards))
1730 (string-match (dired-glob-regexp wildcards)
1732 (setq result (cons buf result)))))
1733 ;; else buffer is killed - clean up:
1734 (setq dired-buffers (delq elt dired-buffers)))
1735 (setq alist (cdr alist)))
1738 (defun dired-glob-regexp (pattern)
1739 "Convert glob-pattern PATTERN to a regular expression."
1740 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1742 (while (string-match "[[?*]" pattern matched-in-pattern)
1743 (let ((op-end (match-end 0))
1744 (next-op (aref pattern (match-beginning 0))))
1745 (setq regexp (concat regexp
1747 (substring pattern matched-in-pattern
1748 (match-beginning 0)))))
1749 (cond ((= next-op ??)
1750 (setq regexp (concat regexp "."))
1751 (setq matched-in-pattern op-end))
1753 ;; Fails to handle ^ yet ????
1754 (let* ((set-start (match-beginning 0))
1756 (if (= (aref pattern (1+ set-start)) ?^)
1759 (set-end (string-match "]" pattern set-cont))
1760 (set (substring pattern set-start (1+ set-end))))
1761 (setq regexp (concat regexp set))
1762 (setq matched-in-pattern (1+ set-end))))
1764 (setq regexp (concat regexp ".*"))
1765 (setq matched-in-pattern op-end)))))
1769 (substring pattern matched-in-pattern))
1774 (defun dired-advertise ()
1775 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1776 ;; With wildcards we actually advertise too much.
1777 (let ((expanded-default (expand-file-name default-directory)))
1778 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1779 t ; we have already advertised ourselves
1781 (cons (cons expanded-default (current-buffer))
1784 (defun dired-unadvertise (dir)
1785 ;; Remove DIR from the buffer alist in variable dired-buffers.
1786 ;; This has the effect of removing any buffer whose main directory is DIR.
1787 ;; It does not affect buffers in which DIR is a subdir.
1788 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1790 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
1794 ;;; utility functions
1796 (defun dired-in-this-tree (file dir)
1797 ;;"Is FILE part of the directory tree starting at DIR?"
1798 (let (case-fold-search)
1799 (string-match (concat "^" (regexp-quote dir)) file)))
1801 (defun dired-normalize-subdir (dir)
1802 ;; Prepend default-directory to DIR if relative path name.
1803 ;; dired-get-filename must be able to make a valid filename from a
1804 ;; file and its directory DIR.
1805 (file-name-as-directory
1806 (if (file-name-absolute-p dir)
1808 (expand-file-name dir default-directory))))
1810 (defun dired-get-subdir ()
1811 ;;"Return the subdir name on this line, or nil if not on a headerline."
1812 ;; Look up in the alist whether this is a headerline.
1814 (let ((cur-dir (dired-current-directory)))
1815 (beginning-of-line) ; alist stores b-o-l positions
1816 (and (zerop (- (point)
1817 (dired-get-subdir-min (assoc cur-dir
1818 dired-subdir-alist))))
1821 ;(defun dired-get-subdir-min (elt)
1823 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1824 (defalias 'dired-get-subdir-min 'cdr)
1826 (defun dired-get-subdir-max (elt)
1828 (goto-char (dired-get-subdir-min elt))
1829 (dired-subdir-max)))
1831 (defun dired-clear-alist ()
1832 (while dired-subdir-alist
1833 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1834 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1836 (defun dired-subdir-index (dir)
1837 ;; Return an index into alist for use with nth
1838 ;; for the sake of subdir moving commands.
1839 (let (found (index 0) (alist dired-subdir-alist))
1841 (if (string= dir (car (car alist)))
1842 (setq alist nil found t)
1843 (setq alist (cdr alist) index (1+ index))))
1844 (if found index nil)))
1846 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1847 "Go to next subdirectory, regardless of level."
1848 ;; Use 0 arg to go to this directory's header line.
1849 ;; NO-SKIP prevents moving to end of header line, returning whatever
1850 ;; position was found in dired-subdir-alist.
1852 (let ((this-dir (dired-current-directory))
1854 ;; nth with negative arg does not return nil but the first element
1855 (setq index (- (dired-subdir-index this-dir) arg))
1856 (setq pos (if (>= index 0)
1857 (dired-get-subdir-min (nth index dired-subdir-alist))))
1861 (or no-skip (skip-chars-forward "^\n\r"))
1863 (if no-error-if-not-found
1864 nil ; return nil if not found
1865 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1867 (defun dired-build-subdir-alist (&optional switches)
1868 "Build `dired-subdir-alist' by parsing the buffer.
1869 Returns the new value of the alist.
1870 If optional arg SWITCHES is non-nil, use its value
1871 instead of `dired-actual-switches'."
1876 (buffer-read-only nil)
1877 (switches (or switches dired-actual-switches))
1879 (R-ftp-base-dir-regex
1880 ;; Used to expand subdirectory names correctly in recursive
1881 ;; ange-ftp listings.
1882 (and (string-match "R" switches)
1883 (string-match "\\`/.*:\\(/.*\\)" default-directory)
1884 (concat "\\`" (match-string 1 default-directory)))))
1885 (goto-char (point-min))
1886 (setq dired-subdir-alist nil)
1887 (while (and (re-search-forward dired-subdir-regexp nil t)
1888 ;; Avoid taking a file name ending in a colon
1889 ;; as a subdir name.
1890 (not (save-excursion
1891 (goto-char (match-beginning 0))
1894 (save-match-data (looking-at dired-re-perms)))))
1896 (goto-char (match-beginning 1))
1898 (buffer-substring-no-properties (point) (match-end 1))
1901 (if (and R-ftp-base-dir-regex
1902 (not (string= new-dir-name default-directory))
1903 (string-match R-ftp-base-dir-regex new-dir-name))
1904 (concat default-directory
1905 (substring new-dir-name (match-end 0)))
1906 (expand-file-name new-dir-name))))
1907 (delete-region (point) (match-end 1))
1908 (insert new-dir-name))
1909 (setq count (1+ count))
1910 (dired-alist-add-1 new-dir-name
1911 ;; Place a sub directory boundary between lines.
1913 (goto-char (match-beginning 0))
1917 (message "Buffer includes %d directories" count))
1918 ;; We don't need to sort it because it is in buffer order per
1919 ;; constructionem. Return new alist:
1920 dired-subdir-alist)))
1922 (defun dired-alist-add-1 (dir new-marker)
1923 ;; Add new DIR at NEW-MARKER. Don't sort.
1924 (setq dired-subdir-alist
1925 (cons (cons (dired-normalize-subdir dir) new-marker)
1926 dired-subdir-alist)))
1928 (defun dired-goto-next-nontrivial-file ()
1929 ;; Position point on first nontrivial file after point.
1930 (dired-goto-next-file);; so there is a file to compare with
1931 (if (stringp dired-trivial-filenames)
1932 (while (and (not (eobp))
1933 (string-match dired-trivial-filenames
1934 (file-name-nondirectory
1935 (or (dired-get-filename nil t) ""))))
1937 (dired-move-to-filename))))
1939 (defun dired-goto-next-file ()
1940 (let ((max (1- (dired-subdir-max))))
1941 (while (and (not (dired-move-to-filename)) (< (point) max))
1944 (defun dired-goto-file (file)
1945 "Go to file line of FILE in this dired buffer."
1946 ;; Return value of point on success, else nil.
1947 ;; FILE must be an absolute pathname.
1948 ;; Loses if FILE contains control chars like "\007" for which ls
1949 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1950 ;; it in the buffer.
1952 (prog1 ; let push-mark display its message
1953 (list (expand-file-name
1954 (read-file-name "Goto file: "
1955 (dired-current-directory))))
1957 (setq file (directory-file-name file)) ; does no harm if no directory
1958 (let (found case-fold-search dir)
1959 (setq dir (or (file-name-directory file)
1960 (error "File name `%s' is not absolute" file)))
1962 ;; The hair here is to get the result of dired-goto-subdir
1963 ;; without really calling it if we don't have any subdirs.
1964 (if (if (string= dir (expand-file-name default-directory))
1965 (goto-char (point-min))
1966 (and (cdr dired-subdir-alist)
1967 (dired-goto-subdir dir)))
1968 (let ((base (file-name-nondirectory file))
1970 (boundary (dired-subdir-max)))
1972 (replace-regexp-in-string "\^m" "\\^m" base nil t))
1974 (replace-regexp-in-string "\\\\" "\\\\" search-string nil t))
1975 (while (and (not found)
1976 ;; filenames are preceded by SPC, this makes
1977 ;; the search faster (e.g. for the filename "-"!).
1978 (search-forward (concat " " search-string)
1980 ;; Match could have BASE just as initial substring or
1981 ;; or in permission bits or date or
1982 ;; not be a proper filename at all:
1983 (if (equal base (dired-get-filename 'no-dir t))
1984 ;; Must move to filename since an (actually
1985 ;; correct) match could have been elsewhere on the
1986 ;; ;; line (e.g. "-" would match somewhere in the
1987 ;; permission bits).
1988 (setq found (dired-move-to-filename))
1989 ;; If this isn't the right line, move forward to avoid
1990 ;; trying this line again.
1991 (forward-line 1))))))
1993 ;; return value of point (i.e., FOUND):
1994 (goto-char found))))
1996 (defun dired-initial-position (dirname)
1997 ;; Where point should go in a new listing of DIRNAME.
1998 ;; Point assumed at beginning of new subdir line.
1999 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2001 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2003 ;; These are hooks which make tree dired work.
2004 ;; They are in this file because other parts of dired need to call them.
2005 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2007 ;; This function is called for each retrieved filename.
2008 ;; It could stand to be faster, though it's mostly function call
2009 ;; overhead. Avoiding the function call seems to save about 10% in
2010 ;; dired-get-filename. Make it a defsubst?
2011 (defun dired-current-directory (&optional localp)
2012 "Return the name of the subdirectory to which this line belongs.
2013 This returns a string with trailing slash, like `default-directory'.
2014 Optional argument means return a file name relative to `default-directory'."
2015 (let ((here (point))
2016 (alist (or dired-subdir-alist
2017 ;; probably because called in a non-dired buffer
2018 (error "No subdir-alist in %s" (current-buffer))))
2021 (setq elt (car alist)
2023 ;; use `<=' (not `<') as subdir line is part of subdir
2024 alist (if (<= (dired-get-subdir-min elt) here)
2028 (dired-make-relative dir default-directory)
2031 ;; Subdirs start at the beginning of their header lines and end just
2032 ;; before the beginning of the next header line (or end of buffer).
2034 (defun dired-subdir-max ()
2036 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2042 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
2043 "*Decide whether recursive deletes are allowed.
2044 nil means no recursive deletes.
2045 `always' means delete recursively without asking. This is DANGEROUS!
2046 `top' means ask for each directory at top level, but delete its subdirectories
2048 Anything else means ask for each directory."
2049 :type '(choice :tag "Delete non-empty directories"
2050 (const :tag "Yes" always)
2051 (const :tag "No--only delete empty directories" nil)
2052 (const :tag "Confirm for each directory" t)
2053 (const :tag "Confirm for each top directory only" top))
2056 ;; Match anything but `.' and `..'.
2057 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2059 ;; Delete file, possibly delete a directory and all its files.
2060 ;; This function is usefull outside of dired. One could change it's name
2061 ;; to e.g. recursive-delete-file and put it somewhere else.
2062 (defun dired-delete-file (file &optional recursive) "\
2063 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2064 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2066 `always', delete recursively without asking.
2067 `top', ask for each directory at top level.
2068 Anything else, ask for each sub-directory."
2070 ;; This test is equivalent to
2071 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2072 ;; but more efficient
2073 (if (not (eq t (car (file-attributes file))))
2075 (when (and recursive
2077 (directory-files file t dired-re-no-dot)) ; Not empty.
2078 (or (eq recursive 'always)
2079 (yes-or-no-p (format "Recursive delete of %s "
2080 (dired-make-relative file)))))
2081 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2082 (while files ; Recursively delete (possibly asking).
2083 (dired-delete-file (car files) recursive)
2084 (setq files (cdr files))))
2085 (delete-directory file))))
2087 (defun dired-do-flagged-delete (&optional nomessage)
2088 "In Dired, delete the files flagged for deletion.
2089 If NOMESSAGE is non-nil, we don't display any message
2090 if there are no flagged files."
2092 (let* ((dired-marker-char dired-del-marker)
2093 (regexp (dired-marker-regexp))
2095 (if (save-excursion (goto-char (point-min))
2096 (re-search-forward regexp nil t))
2097 (dired-internal-do-deletions
2098 ;; this can't move point since ARG is nil
2099 (dired-map-over-marks (cons (dired-get-filename) (point))
2103 (message "(No deletions requested)")))))
2105 (defun dired-do-delete (&optional arg)
2106 "Delete all marked (or next ARG) files."
2107 ;; This is more consistent with the file marking feature than
2108 ;; dired-do-flagged-delete.
2110 (dired-internal-do-deletions
2111 ;; this may move point if ARG is an integer
2112 (dired-map-over-marks (cons (dired-get-filename) (point))
2116 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2118 (defun dired-internal-do-deletions (l arg)
2119 ;; L is an alist of files to delete, with their buffer positions.
2120 ;; ARG is the prefix arg.
2121 ;; Filenames are absolute (VMS needs this for logical search paths).
2122 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2123 ;; That way as changes are made in the buffer they do not shift the
2124 ;; lines still to be changed, so the (point) values in L stay valid.
2125 ;; Also, for subdirs in natural order, a subdir's files are deleted
2126 ;; before the subdir itself - the other way around would not work.
2127 (let ((files (mapcar (function car) l))
2130 ;; canonicalize file list for pop up
2131 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2132 (if (dired-mark-pop-up
2133 " *Deletions*" 'delete files dired-deletion-confirmer
2134 (format "Delete %s " (dired-mark-prompt arg files)))
2136 (let (failures);; files better be in reverse order for this loop!
2138 (goto-char (cdr (car l)))
2139 (let (buffer-read-only)
2141 (let ((fn (car (car l))))
2142 (dired-delete-file fn dired-recursive-deletes)
2143 ;; if we get here, removing worked
2144 (setq succ (1+ succ))
2145 (message "%s of %s deletions" succ count)
2146 (dired-fun-in-all-buffers
2147 (file-name-directory fn) (file-name-nondirectory fn)
2148 (function dired-delete-entry) fn))
2149 (error;; catch errors from failed deletions
2150 (dired-log "%s\n" err)
2151 (setq failures (cons (car (car l)) failures)))))
2154 (message "%d deletion%s done" count (dired-plural-s count))
2156 (format "%d of %d deletion%s failed"
2157 (length failures) count
2158 (dired-plural-s count))
2160 (message "(No deletions performed)")))
2161 (dired-move-to-filename))
2163 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2164 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2165 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2166 ;; (FILE does not include a directory component.)
2167 ;; FILE may be nil, in which case ignore it.
2168 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2170 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2172 (with-current-buffer buf
2173 (if (apply fun args)
2174 (setq success-list (cons (buffer-name buf) success-list)))))
2177 ;; Delete the entry for FILE from
2178 (defun dired-delete-entry (file)
2180 (and (dired-goto-file file)
2181 (let (buffer-read-only)
2182 (delete-region (progn (beginning-of-line) (point))
2183 (save-excursion (forward-line 1) (point))))))
2184 (dired-clean-up-after-deletion file))
2186 ;; This is a separate function for the sake of dired-x.el.
2187 (defun dired-clean-up-after-deletion (fn)
2188 ;; Clean up after a deleted file or directory FN.
2189 (save-excursion (and (cdr dired-subdir-alist)
2190 (dired-goto-subdir fn)
2191 (dired-kill-subdir))))
2195 (defun dired-marker-regexp ()
2196 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2198 (defun dired-plural-s (count)
2199 (if (= 1 count) "" "s"))
2201 (defun dired-mark-prompt (arg files)
2202 ;; Return a string for use in a prompt, either the current file
2203 ;; name, or the marker and a count of marked files.
2204 (let ((count (length files)))
2207 ;; more than 1 file:
2210 ;; Perhaps this is nicer, but it also takes more screen space:
2211 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2213 (format "[next %d files]" arg)
2214 (format "%c [%d files]" dired-marker-char count)))))
2216 (defun dired-pop-to-buffer (buf)
2217 ;; Pop up buffer BUF.
2218 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2219 (if (not dired-shrink-to-fit)
2220 (pop-to-buffer (get-buffer-create buf))
2221 ;; let window shrink to fit:
2222 (let ((window (selected-window))
2224 (cond ;; if split-height-threshold is enabled, use the largest window
2225 ((and (> (window-height (setq w2 (get-largest-window)))
2226 split-height-threshold)
2227 (= (frame-width) (window-width w2)))
2229 ;; if the least-recently-used window is big enough, use it
2230 ((and (> (window-height (setq w2 (get-lru-window)))
2231 (* 2 window-min-height))
2232 (= (frame-width) (window-width w2)))
2236 (goto-char (point-max))
2237 (skip-chars-backward "\n\r\t ")
2238 (setq target-lines (count-lines (point-min) (point)))
2239 ;; Don't forget to count the last line.
2241 (setq target-lines (1+ target-lines))))
2242 (if (<= (window-height window) (* 2 window-min-height))
2243 ;; At this point, every window on the frame is too small to split.
2244 (setq w2 (display-buffer buf))
2245 (setq w2 (split-window window
2246 (max window-min-height
2247 (- (window-height window)
2248 (1+ (max window-min-height target-lines)))))))
2249 (set-window-buffer w2 buf)
2250 (if (< (1- (window-height w2)) target-lines)
2253 (enlarge-window (- target-lines (1- (window-height w2))))))
2254 (set-window-start w2 1)
2257 (defvar dired-no-confirm nil
2258 "A list of symbols for commands dired should not confirm.
2259 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2260 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink' and
2263 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2264 "Return FUNCTION's result on ARGS after showing which files are marked.
2265 Displays the file names in a buffer named BUFNAME;
2266 nil gives \" *Marked Files*\".
2267 This uses function `dired-pop-to-buffer' to do that.
2269 FUNCTION should not manipulate files, just read input
2270 (an argument or confirmation).
2271 The window is not shown if there is just one file or
2272 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2273 FILES is the list of marked files."
2274 (or bufname (setq bufname " *Marked Files*"))
2275 (if (or (eq dired-no-confirm t)
2276 (memq op-symbol dired-no-confirm)
2277 (= (length files) 1))
2278 (apply function args)
2279 (with-current-buffer (get-buffer-create bufname)
2281 (dired-format-columns-of-files files)
2282 (remove-text-properties (point-min) (point-max)
2283 '(mouse-face nil help-echo nil)))
2284 (save-window-excursion
2285 (dired-pop-to-buffer bufname)
2286 (apply function args))))
2288 (defun dired-format-columns-of-files (files)
2289 ;; Files should be in forward order for this loop.
2290 ;; i.e., (car files) = first file in buffer.
2291 ;; Returns the number of lines used.
2292 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2293 (width (- (window-width (selected-window)) 2))
2294 (columns (max 1 (/ width maxlen)))
2295 (nfiles (length files))
2296 (rows (+ (/ nfiles columns)
2297 (if (zerop (% nfiles columns)) 0 1)))
2300 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2301 (make-list (- (* columns rows) nfiles) "")))
2302 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2304 (while (< i columns)
2305 (indent-to (* i maxlen))
2306 (insert (car files))
2307 (setq files (nthcdr rows files)
2315 ;; Commands to mark or flag file(s) at or near current line.
2317 (defun dired-repeat-over-lines (arg function)
2318 ;; This version skips non-file lines.
2319 (let ((pos (make-marker)))
2321 (while (and (> arg 0) (not (eobp)))
2324 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2327 (move-marker pos (1+ (point))))
2328 (save-excursion (funcall function))
2329 ;; Advance to the next line--actually, to the line that *was* next.
2330 ;; (If FUNCTION inserted some new lines in between, skip them.)
2332 (while (and (< arg 0) (not (bobp)))
2335 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2337 (save-excursion (funcall function)))
2338 (move-marker pos nil)
2339 (dired-move-to-filename)))
2341 (defun dired-between-files ()
2342 ;; Point must be at beginning of line
2343 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
2344 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
2345 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard\\|^. used\\|^. find")
2346 (and (looking-at dired-subdir-regexp)
2347 (save-excursion (not (dired-move-to-filename))))))
2349 (defun dired-next-marked-file (arg &optional wrap opoint)
2350 "Move to the next marked file, wrapping around the end of the buffer."
2351 (interactive "p\np")
2352 (or opoint (setq opoint (point)));; return to where interactively started
2354 (re-search-forward dired-re-mark nil t arg)
2356 (re-search-backward dired-re-mark nil t (- arg)))
2357 (dired-move-to-filename)
2361 (error "No next marked file"))
2362 (message "(Wraparound for next marked file)")
2363 (goto-char (if (> arg 0) (point-min) (point-max)))
2364 (dired-next-marked-file arg nil opoint))))
2366 (defun dired-prev-marked-file (arg &optional wrap)
2367 "Move to the previous marked file, wrapping around the end of the buffer."
2368 (interactive "p\np")
2369 (dired-next-marked-file (- arg) wrap))
2371 (defun dired-file-marker (file)
2372 ;; Return FILE's marker, or nil if unmarked.
2374 (and (dired-goto-file file)
2377 (if (not (equal ?\040 (following-char)))
2378 (following-char))))))
2380 (defun dired-mark-files-in-region (start end)
2381 (let (buffer-read-only)
2383 (error "start > end"))
2384 (goto-char start) ; assumed at beginning of line
2385 (while (< (point) end)
2386 ;; Skip subdir line and following garbage like the `total' line:
2387 (while (and (< (point) end) (dired-between-files))
2389 (if (and (not (looking-at dired-re-dot))
2390 (dired-get-filename nil t))
2393 (insert dired-marker-char)))
2396 (defun dired-mark (arg)
2397 "Mark the current (or next ARG) files.
2398 If on a subdir headerline, mark all its files except `.' and `..'.
2400 Use \\[dired-unmark-all-files] to remove all marks
2401 and \\[dired-unmark] on a subdir to remove the marks in
2404 (if (dired-get-subdir)
2405 (save-excursion (dired-mark-subdir-files))
2406 (let (buffer-read-only)
2407 (dired-repeat-over-lines
2408 (prefix-numeric-value arg)
2409 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2411 (defun dired-unmark (arg)
2412 "Unmark the current (or next ARG) files.
2413 If looking at a subdir, unmark all its files except `.' and `..'."
2415 (let ((dired-marker-char ?\040))
2418 (defun dired-flag-file-deletion (arg)
2419 "In Dired, flag the current line's file for deletion.
2420 With prefix arg, repeat over several lines.
2422 If on a subdir headerline, mark all its files except `.' and `..'."
2424 (let ((dired-marker-char dired-del-marker))
2427 (defun dired-unmark-backward (arg)
2428 "In Dired, move up lines and remove deletion flag there.
2429 Optional prefix ARG says how many lines to unflag; default is one line."
2431 (dired-unmark (- arg)))
2433 (defun dired-toggle-marks ()
2434 "Toggle marks: marked files become unmarked, and vice versa.
2435 Files marked with other flags (such as `D') are not affected.
2436 `.' and `..' are never toggled.
2437 As always, hidden subdirs are not affected."
2440 (goto-char (point-min))
2441 (let (buffer-read-only)
2443 (or (dired-between-files)
2444 (looking-at dired-re-dot)
2445 ;; use subst instead of insdel because it does not move
2446 ;; the gap and thus should be faster and because
2447 ;; other characters are left alone automatically
2448 (apply 'subst-char-in-region
2449 (point) (1+ (point))
2450 (if (eq ?\040 (following-char)) ; SPC
2451 (list ?\040 dired-marker-char)
2452 (list dired-marker-char ?\040))))
2453 (forward-line 1)))))
2455 ;;; Commands to mark or flag files based on their characteristics or names.
2457 (defvar dired-regexp-history nil
2458 "History list of regular expressions used in Dired commands.")
2460 (defun dired-read-regexp (prompt)
2461 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2463 (defun dired-mark-files-regexp (regexp &optional marker-char)
2464 "Mark all files matching REGEXP for use in later commands.
2465 A prefix argument means to unmark them instead.
2466 `.' and `..' are never marked.
2468 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2469 object files--just `.o' will mark more than you might think."
2471 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2472 " files (regexp): "))
2473 (if current-prefix-arg ?\040)))
2474 (let ((dired-marker-char (or marker-char dired-marker-char)))
2476 (and (not (looking-at dired-re-dot))
2477 (not (eolp)) ; empty line
2478 (let ((fn (dired-get-filename nil t)))
2479 (and fn (string-match regexp (file-name-nondirectory fn)))))
2482 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2483 "Mark all files with contents containing REGEXP for use in later commands.
2484 A prefix argument means to unmark them instead.
2485 `.' and `..' are never marked."
2487 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2488 " files containing (regexp): "))
2489 (if current-prefix-arg ?\040)))
2490 (let ((dired-marker-char (or marker-char dired-marker-char)))
2492 (and (not (looking-at dired-re-dot))
2493 (not (eolp)) ; empty line
2494 (let ((fn (dired-get-filename nil t)))
2495 (when (and fn (file-readable-p fn)
2496 (not (file-directory-p fn)))
2497 (let ((prebuf (get-file-buffer fn)))
2498 (message "Checking %s" fn)
2499 ;; For now we do it inside emacs
2500 ;; Grep might be better if there are a lot of files
2502 (with-current-buffer prebuf
2504 (goto-char (point-min))
2505 (re-search-forward regexp nil t)))
2507 (insert-file-contents fn)
2508 (goto-char (point-min))
2509 (re-search-forward regexp nil t))))
2513 (defun dired-flag-files-regexp (regexp)
2514 "In Dired, flag all files containing the specified REGEXP for deletion.
2515 The match is against the non-directory part of the filename. Use `^'
2516 and `$' to anchor matches. Exclude subdirs by hiding them.
2517 `.' and `..' are never flagged."
2518 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2519 (dired-mark-files-regexp regexp dired-del-marker))
2521 (defun dired-mark-symlinks (unflag-p)
2522 "Mark all symbolic links.
2523 With prefix argument, unflag all those files."
2525 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2526 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2528 (defun dired-mark-directories (unflag-p)
2529 "Mark all directory file lines except `.' and `..'.
2530 With prefix argument, unflag all those files."
2532 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2533 (dired-mark-if (and (looking-at dired-re-dir)
2534 (not (looking-at dired-re-dot)))
2537 (defun dired-mark-executables (unflag-p)
2538 "Mark all executable files.
2539 With prefix argument, unflag all those files."
2541 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2542 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2544 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2545 ;; files for which PREDICATE returns non-nil.
2547 (defun dired-flag-auto-save-files (&optional unflag-p)
2548 "Flag for deletion files whose names suggest they are auto save files.
2549 A prefix argument says to unflag those files instead."
2551 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2553 ;; It is less than general to check for # here,
2554 ;; but it's the only way this runs fast enough.
2555 (and (save-excursion (end-of-line)
2557 (eq (preceding-char) ?#)
2558 ;; Handle executables in case of -F option.
2559 ;; We need not worry about the other kinds
2560 ;; of markings that -F makes, since they won't
2561 ;; appear on real auto-save files.
2562 (if (eq (preceding-char) ?*)
2565 (eq (preceding-char) ?#)))))
2566 (not (looking-at dired-re-dir))
2567 (let ((fn (dired-get-filename t t)))
2568 (if fn (auto-save-file-name-p
2569 (file-name-nondirectory fn)))))
2572 (defvar dired-garbage-files-regexp
2573 "\\.log$\\|\\.toc$\\|\\.dvi$\\|\\.bak$\\|\\.orig$\\|\\.rej$"
2574 "*Regular expression to match \"garbage\" files for `dired-flag-garbage-files'.")
2576 (defun dired-flag-garbage-files ()
2577 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2579 (dired-flag-files-regexp dired-garbage-files-regexp))
2581 (defun dired-flag-backup-files (&optional unflag-p)
2582 "Flag all backup files (names ending with `~') for deletion.
2583 With prefix argument, unflag these files."
2585 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2587 ;; Don't call backup-file-name-p unless the last character looks like
2588 ;; it might be the end of a backup file name. This isn't very general,
2589 ;; but it's the only way this runs fast enough.
2590 (and (save-excursion (end-of-line)
2591 ;; Handle executables in case of -F option.
2592 ;; We need not worry about the other kinds
2593 ;; of markings that -F makes, since they won't
2594 ;; appear on real backup files.
2595 (if (eq (preceding-char) ?*)
2597 (eq (preceding-char) ?~))
2598 (not (looking-at dired-re-dir))
2599 (let ((fn (dired-get-filename t t)))
2600 (if fn (backup-file-name-p fn))))
2603 (defun dired-change-marks (&optional old new)
2604 "Change all OLD marks to NEW marks.
2605 OLD and NEW are both characters used to mark files."
2607 (let* ((cursor-in-echo-area t)
2608 (old (progn (message "Change (old mark): ") (read-char)))
2609 (new (progn (message "Change %c marks to (new mark): " old)
2612 (if (or (eq old ?\r) (eq new ?\r))
2614 (let ((string (format "\n%c" old))
2617 (goto-char (point-min))
2618 (while (search-forward string nil t)
2621 (dired-get-filename 'no-dir t))
2623 (subst-char-in-region (match-beginning 0)
2624 (match-end 0) old new)))))))
2626 (defun dired-unmark-all-marks ()
2627 "Remove all marks from all files in the Dired buffer."
2629 (dired-unmark-all-files ?\r))
2631 (defun dired-unmark-all-files (mark &optional arg)
2632 "Remove a specific mark (or any mark) from every file.
2633 After this command, type the mark character to remove,
2634 or type RET to remove all marks.
2635 With prefix arg, query for each marked file.
2636 Type \\[help-command] at that time for help."
2637 (interactive "cRemove marks (RET means all): \nP")
2640 buffer-read-only case-fold-search query
2641 (string (format "\n%c" mark))
2643 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2644 `!' to unmark all remaining files with no more questions."))
2645 (goto-char (point-min))
2646 (while (if (eq mark ?\r)
2647 (re-search-forward dired-re-mark nil t)
2648 (search-forward string nil t))
2650 (dired-query 'query "Unmark file `%s'? "
2651 (dired-get-filename t)))
2652 (progn (subst-char-in-region (1- (point)) (point)
2653 (preceding-char) ?\ )
2654 (setq count (1+ count)))))
2655 (message (if (= count 1) "1 mark removed"
2659 ;; Logging failures operating on files, and showing the results.
2661 (defvar dired-log-buffer "*Dired log*")
2664 "Pop up a buffer with error log output from Dired.
2665 A group of errors from a single command ends with a formfeed.
2666 Thus, use \\[backward-page] to find the beginning of a group of errors."
2668 (if (get-buffer dired-log-buffer)
2669 (let ((owindow (selected-window))
2670 (window (display-buffer (get-buffer dired-log-buffer))))
2673 (select-window window)
2674 (goto-char (point-max))
2678 (select-window owindow)))))
2680 (defun dired-log (log &rest args)
2681 ;; Log a message or the contents of a buffer.
2682 ;; If LOG is a string and there are more args, it is formatted with
2683 ;; those ARGS. Usually the LOG string ends with a \n.
2684 ;; End each bunch of errors with (dired-log t):
2685 ;; this inserts the current time and buffer at the start of the page,
2686 ;; and \f (formfeed) at the end.
2687 (let ((obuf (current-buffer)))
2688 (with-current-buffer (get-buffer-create dired-log-buffer)
2689 (goto-char (point-max))
2690 (let ((inhibit-read-only t))
2691 (cond ((stringp log)
2693 (apply (function format) log args)
2696 (insert-buffer log))
2701 (insert (current-time-string)
2702 "\tBuffer `" (buffer-name obuf) "'\n")
2703 (goto-char (point-max))
2704 (insert "\f\n")))))))
2706 (defun dired-log-summary (string failures)
2707 (if (= (length failures) 1)
2709 (with-current-buffer dired-log-buffer
2710 (goto-char (point-max))
2712 (if (eolp) (forward-line 1))
2713 (buffer-substring (point) (point-max))))
2714 (message (if failures "%s--type ? for details (%s)"
2715 "%s--type ? for details")
2717 ;; Log a summary describing a bunch of errors.
2718 (dired-log (concat "\n" string "\n"))
2723 ;; Most ls can only sort by name or by date (with -t), nothing else.
2724 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2725 ;; So anything that does not contain these is sort "by name".
2727 (defvar dired-ls-sorting-switches "SXU"
2728 "String of `ls' switches (single letters) except `t' that influence sorting.")
2730 (defvar dired-sort-by-date-regexp
2731 (concat "^-[^" dired-ls-sorting-switches
2732 "]*t[^" dired-ls-sorting-switches "]*$")
2733 "Regexp recognized by dired to set `by date' mode.")
2735 (defvar dired-sort-by-name-regexp
2736 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2737 "Regexp recognized by dired to set `by name' mode.")
2739 (defvar dired-sort-inhibit nil
2740 "Non-nil means the Dired sort command is disabled.
2741 The idea is to set this buffer-locally in special Dired buffers.")
2743 (defun dired-sort-set-modeline ()
2744 ;; Set modeline display according to dired-actual-switches.
2745 ;; Modeline display of "by name" or "by date" guarantees the user a
2746 ;; match with the corresponding regexps. Non-matching switches are
2749 (let (case-fold-search)
2750 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2752 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2755 (concat "Dired " dired-actual-switches)))))
2756 (force-mode-line-update))
2758 (defun dired-sort-toggle-or-edit (&optional arg)
2759 "Toggle between sort by date/name and refresh the dired buffer.
2760 With a prefix argument you can edit the current listing switches instead."
2762 (when dired-sort-inhibit
2763 (error "Cannot sort this Dired buffer"))
2766 (read-string "ls switches (must contain -l): " dired-actual-switches))
2767 (dired-sort-toggle)))
2769 (defun dired-sort-toggle ()
2770 ;; Toggle between sort by date/name. Reverts the buffer.
2771 (setq dired-actual-switches
2772 (let (case-fold-search)
2773 (if (string-match " " dired-actual-switches)
2774 ;; New toggle scheme: add/remove a trailing " -t"
2775 (if (string-match " -t\\'" dired-actual-switches)
2776 (substring dired-actual-switches 0 (match-beginning 0))
2777 (concat dired-actual-switches " -t"))
2778 ;; old toggle scheme: look for some 't' switch and add/remove it
2781 (dired-replace-in-string (concat "[-lt"
2782 dired-ls-sorting-switches "]")
2784 dired-actual-switches)
2785 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2786 dired-actual-switches)
2789 (dired-sort-set-modeline)
2792 ;; Some user code loads dired especially for this.
2793 ;; Don't do that--use replace-regexp-in-string instead.
2794 (defun dired-replace-in-string (regexp newtext string)
2795 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2796 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2797 (let ((result "") (start 0) mb me)
2798 (while (string-match regexp string start)
2799 (setq mb (match-beginning 0)
2801 result (concat result (substring string start mb) newtext)
2803 (concat result (substring string start))))
2805 (defun dired-sort-other (switches &optional no-revert)
2806 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2807 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2808 ;; minor mode accordingly, others appear literally in the mode line.
2809 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2810 (dired-sort-R-check switches)
2811 (setq dired-actual-switches switches)
2812 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
2813 (or no-revert (revert-buffer)))
2815 (make-variable-buffer-local
2816 (defvar dired-subdir-alist-pre-R nil
2817 "Value of `dired-subdir-alist' before -R switch added."))
2819 (defun dired-sort-R-check (switches)
2820 "Additional processing of -R in ls option string SWITCHES.
2821 Saves `dired-subdir-alist' when R is set and restores saved value
2822 minus any directories explicitly deleted when R is cleared.
2823 To be called first in body of `dired-sort-other', etc."
2825 ((and (string-match "R" switches)
2826 (not (string-match "R" dired-actual-switches)))
2827 ;; Adding -R to ls switches -- save `dired-subdir-alist':
2828 (setq dired-subdir-alist-pre-R dired-subdir-alist))
2829 ((and (string-match "R" dired-actual-switches)
2830 (not (string-match "R" switches)))
2831 ;; Deleting -R from ls switches -- revert to pre-R subdirs
2832 ;; that are still present:
2833 (setq dired-subdir-alist
2834 (if dired-subdir-alist-pre-R
2836 (while dired-subdir-alist-pre-R
2837 (if (assoc (caar dired-subdir-alist-pre-R)
2839 ;; subdir still present...
2841 (cons (car dired-subdir-alist-pre-R)
2843 (setq dired-subdir-alist-pre-R
2844 (cdr dired-subdir-alist-pre-R)))
2846 ;; No pre-R subdir alist, so revert to main directory
2848 (list (car (reverse dired-subdir-alist))))))))
2850 ;; To make this file smaller, the less common commands
2851 ;; go in a separate file. But autoload them here
2852 ;; to make the separation invisible.
2854 (autoload 'dired-diff "dired-aux"
2855 "Compare file at point with file FILE using `diff'.
2856 FILE defaults to the file at the mark. (That's the mark set by
2857 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
2858 The prompted-for file is the first file given to `diff'."
2861 (autoload 'dired-backup-diff "dired-aux"
2862 "Diff this file with its backup file or vice versa.
2863 Uses the latest backup, if there are several numerical backups.
2864 If this file is a backup, diff it with its original.
2865 The backup file is the first file given to `diff'."
2868 (autoload 'dired-clean-directory "dired-aux"
2869 "Flag numerical backups for deletion.
2870 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2871 Positive prefix arg KEEP overrides `dired-kept-versions';
2872 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2874 To clear the flags on these files, you can use \\[dired-flag-backup-files]
2875 with a prefix argument."
2878 (autoload 'dired-do-chmod "dired-aux"
2879 "Change the mode of the marked (or next ARG) files.
2880 This calls chmod, thus symbolic modes like `g+w' are allowed."
2883 (autoload 'dired-do-chgrp "dired-aux"
2884 "Change the group of the marked (or next ARG) files."
2887 (autoload 'dired-do-chown "dired-aux"
2888 "Change the owner of the marked (or next ARG) files."
2891 (autoload 'dired-do-print "dired-aux"
2892 "Print the marked (or next ARG) files.
2893 Uses the shell command coming from variables `lpr-command' and
2894 `lpr-switches' as default."
2897 (autoload 'dired-do-shell-command "dired-aux"
2898 "Run a shell command COMMAND on the marked files.
2899 If no files are marked or a specific numeric prefix arg is given,
2900 the next ARG files are used. Just \\[universal-argument] means the current file.
2901 The prompt mentions the file(s) or the marker, as appropriate.
2903 If there is a `*' in COMMAND, surrounded by whitespace, this runs
2904 COMMAND just once with the entire file list substituted there.
2906 If there is no `*', but there is a `?' in COMMAND, surrounded by
2907 whitespace, this runs COMMAND on each file individually with the
2908 file name substituted for `?'.
2910 Otherwise, this runs COMMAND on each file individually with the
2911 file name added at the end of COMMAND (separated by a space).
2913 `*' and `?' when not surrounded by whitespace have no special
2914 significance for `dired-do-shell-command', and are passed through
2915 normally to the shell, but you must confirm first. To pass `*' by
2916 itself to the shell as a wildcard, type `*\"\"'.
2918 If COMMAND produces output, it goes to a separate buffer.
2920 This feature does not try to redisplay Dired buffers afterward, as
2921 there's no telling what files COMMAND may have changed.
2922 Type \\[dired-do-redisplay] to redisplay the marked files.
2924 When COMMAND runs, its working directory is the top-level directory of
2925 the Dired buffer, so output files usually are created there instead of
2928 In a noninteractive call (from Lisp code), you must specify
2929 the list of file names explicitly with the FILE-LIST argument."
2932 (autoload 'dired-do-kill-lines "dired-aux"
2933 "Kill all marked lines (not the files).
2934 With a prefix arg, kill all lines not marked or flagged."
2937 (autoload 'dired-do-compress "dired-aux"
2938 "Compress or uncompress marked (or next ARG) files."
2941 (autoload 'dired-do-byte-compile "dired-aux"
2942 "Byte compile marked (or next ARG) Emacs Lisp files."
2945 (autoload 'dired-do-load "dired-aux"
2946 "Load the marked (or next ARG) Emacs Lisp files."
2949 (autoload 'dired-do-redisplay "dired-aux"
2950 "Redisplay all marked (or next ARG) files.
2951 If on a subdir line, redisplay that subdirectory. In that case,
2952 a prefix arg lets you edit the `ls' switches used for the new listing."
2955 (autoload 'dired-create-directory "dired-aux"
2956 "Create a directory called DIRECTORY."
2959 (autoload 'dired-do-copy "dired-aux"
2960 "Copy all marked (or next ARG) files, or copy the current file.
2961 Thus, a zero prefix argument copies nothing. But it toggles the
2962 variable `dired-copy-preserve-time' (which see)."
2965 (autoload 'dired-do-symlink "dired-aux"
2966 "Make symbolic links to current file or all marked (or next ARG) files.
2967 When operating on just the current file, you specify the new name.
2968 When operating on multiple or marked files, you specify a directory
2969 and new symbolic links are made in that directory
2970 with the same names that the files currently have."
2973 (autoload 'dired-do-hardlink "dired-aux"
2974 "Add names (hard links) current file or all marked (or next ARG) files.
2975 When operating on just the current file, you specify the new name.
2976 When operating on multiple or marked files, you specify a directory
2977 and new hard links are made in that directory
2978 with the same names that the files currently have."
2981 (autoload 'dired-do-rename "dired-aux"
2982 "Rename current file or all marked (or next ARG) files.
2983 When renaming just the current file, you specify the new name.
2984 When renaming multiple or marked files, you specify a directory."
2987 (autoload 'dired-do-rename-regexp "dired-aux"
2988 "Rename marked files containing REGEXP to NEWNAME.
2989 As each match is found, the user must type a character saying
2990 what to do with it. For directions, type \\[help-command] at that time.
2991 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2992 REGEXP defaults to the last regexp used.
2993 With a zero prefix arg, renaming by regexp affects the complete
2994 pathname - usually only the non-directory part of file names is used
2998 (autoload 'dired-do-copy-regexp "dired-aux"
2999 "Copy all marked files containing REGEXP to NEWNAME.
3000 See function `dired-do-rename-regexp' for more info."
3003 (autoload 'dired-do-hardlink-regexp "dired-aux"
3004 "Hardlink all marked files containing REGEXP to NEWNAME.
3005 See function `dired-do-rename-regexp' for more info."
3008 (autoload 'dired-do-symlink-regexp "dired-aux"
3009 "Symlink all marked files containing REGEXP to NEWNAME.
3010 See function `dired-do-rename-regexp' for more info."
3013 (autoload 'dired-upcase "dired-aux"
3014 "Rename all marked (or next ARG) files to upper case."
3017 (autoload 'dired-downcase "dired-aux"
3018 "Rename all marked (or next ARG) files to lower case."
3021 (autoload 'dired-maybe-insert-subdir "dired-aux"
3022 "Insert this subdirectory into the same dired buffer.
3023 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
3024 else inserts it at its natural place (as `ls -lR' would have done).
3025 With a prefix arg, you may edit the ls switches used for this listing.
3026 You can add `R' to the switches to expand the whole tree starting at
3028 This function takes some pains to conform to `ls -lR' output."
3031 (autoload 'dired-next-subdir "dired-aux"
3032 "Go to next subdirectory, regardless of level."
3035 (autoload 'dired-prev-subdir "dired-aux"
3036 "Go to previous subdirectory, regardless of level.
3037 When called interactively and not on a subdir line, go to this subdir's line."
3040 (autoload 'dired-goto-subdir "dired-aux"
3041 "Go to end of header line of DIR in this dired buffer.
3042 Return value of point on success, otherwise return nil.
3043 The next char is either \\n, or \\r if DIR is hidden."
3046 (autoload 'dired-mark-subdir-files "dired-aux"
3047 "Mark all files except `.' and `..'."
3050 (autoload 'dired-kill-subdir "dired-aux"
3051 "Remove all lines of current subdirectory.
3052 Lower levels are unaffected."
3055 (autoload 'dired-tree-up "dired-aux"
3056 "Go up ARG levels in the dired tree."
3059 (autoload 'dired-tree-down "dired-aux"
3060 "Go down in the dired tree."
3063 (autoload 'dired-hide-subdir "dired-aux"
3064 "Hide or unhide the current subdirectory and move to next directory.
3065 Optional prefix arg is a repeat factor.
3066 Use \\[dired-hide-all] to (un)hide all directories."
3069 (autoload 'dired-hide-all "dired-aux"
3070 "Hide all subdirectories, leaving only their header lines.
3071 If there is already something hidden, make everything visible again.
3072 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
3075 (autoload 'dired-show-file-type "dired-aux"
3076 "Print the type of FILE, according to the `file' command.
3077 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
3078 true then the type of the file linked to by FILE is printed instead."
3081 (autoload 'dired-run-shell-command "dired-aux")
3083 (autoload 'dired-query "dired-aux")
3085 (if (eq system-type 'vax-vms)
3090 (run-hooks 'dired-load-hook) ; for your customizations
3092 ;;; dired.el ends here