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-chmod-program
"chmod"
76 "Name of chmod command (usually `chmod').")
79 (defcustom dired-ls-F-marks-symlinks nil
80 "*Informs dired about how `ls -lF' marks symbolic links.
81 Set this to t if `ls' (or whatever program is specified by
82 `insert-directory-program') with `-lF' marks the symbolic link
83 itself with a trailing @ (usually the case under Ultrix).
85 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
86 nil (the default), if it gives `bar@ -> foo', set it to t.
88 Dired checks if there is really a @ appended. Thus, if you have a
89 marking `ls' program on one host and a non-marking on another host, and
90 don't care about symbolic links which really end in a @, you can
91 always set this variable to t."
96 (defcustom dired-trivial-filenames
"^\\.\\.?$\\|^#"
97 "*Regexp of files to skip when finding first file of a directory.
98 A value of nil means move to the subdir line.
99 A value of t means move to first file."
100 :type
'(choice (const :tag
"Move to subdir" nil
)
101 (const :tag
"Move to first" t
)
106 (defcustom dired-keep-marker-rename t
107 ;; Use t as default so that moved files "take their markers with them".
108 "*Controls marking of renamed files.
109 If t, files keep their previous marks when they are renamed.
110 If a character, renamed files (whether previously marked or not)
111 are afterward marked with that character."
112 :type
'(choice (const :tag
"Keep" t
)
113 (character :tag
"Mark"))
117 (defcustom dired-keep-marker-copy ?C
118 "*Controls marking of copied files.
119 If t, copied files are marked if and as the corresponding original files were.
120 If a character, copied files are unconditionally marked with that character."
121 :type
'(choice (const :tag
"Keep" t
)
122 (character :tag
"Mark"))
126 (defcustom dired-keep-marker-hardlink ?H
127 "*Controls marking of newly made hard links.
128 If t, they are marked if and as the files linked to were marked.
129 If a character, new links are unconditionally marked with that character."
130 :type
'(choice (const :tag
"Keep" t
)
131 (character :tag
"Mark"))
135 (defcustom dired-keep-marker-symlink ?Y
136 "*Controls marking of newly made symbolic links.
137 If t, they are marked if and as the files linked to were marked.
138 If a character, new links are unconditionally marked with that character."
139 :type
'(choice (const :tag
"Keep" t
)
140 (character :tag
"Mark"))
144 (defcustom dired-dwim-target nil
145 "*If non-nil, dired tries to guess a default target directory.
146 This means: if there is a dired buffer displayed in the next window,
147 use its current subdir, instead of the current subdir of this dired buffer.
149 The target is used in the prompt for file copy, rename etc."
154 (defcustom dired-copy-preserve-time t
155 "*If non-nil, Dired preserves the last-modified time in a file copy.
156 \(This works on only some systems.)"
160 ; These variables were deleted and the replacements are on files.el.
161 ; We leave aliases behind for back-compatibility.
162 (defvaralias 'dired-free-space-program
'directory-free-space-program
)
163 (defvaralias 'dired-free-space-args
'directory-free-space-args
)
167 (defcustom dired-load-hook nil
168 "Run after loading dired.
169 You can customize key bindings or load extensions with this."
173 (defcustom dired-mode-hook nil
174 "Run at the very end of dired-mode."
178 (defcustom dired-before-readin-hook nil
179 "This hook is run before a dired buffer is read in (created or reverted)."
183 (defcustom dired-after-readin-hook nil
184 "Hook run after each time a file or directory is read by Dired.
185 After each listing of a file or directory, this hook is run
186 with the buffer narrowed to the listing."
189 ;; Note this can't simply be run inside function `dired-ls' as the hook
190 ;; functions probably depend on the dired-subdir-alist to be OK.
192 ;;; Internal variables
194 (defvar dired-marker-char ?
* ; the answer is 42
195 ;; so that you can write things like
196 ;; (let ((dired-marker-char ?X))
197 ;; ;; great code using X markers ...
199 ;; For example, commands operating on two sets of files, A and B.
200 ;; Or marking files with digits 0-9. This could implicate
201 ;; concentric sets or an order for the marked files.
202 ;; The code depends on dynamic scoping on the marker char.
203 "In Dired, the current mark character.
204 This is what the `do' commands look for and what the `mark' commands store.")
206 (defvar dired-del-marker ?D
207 "Character used to flag files for deletion.")
209 (defvar dired-shrink-to-fit
211 ;; I see no reason ever to make this nil -- rms.
212 ;; (> baud-rate search-slow-speed)
213 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
215 (defvar dired-flagging-regexp nil
);; Last regexp used to flag files.
217 (defvar dired-file-version-alist
)
219 (defvar dired-directory nil
220 "The directory name or shell wildcard that was used as argument to `ls'.
221 Local to each dired buffer. May be a list, in which case the car is the
222 directory name and the cdr is the actual files to list.")
224 (defvar dired-actual-switches nil
225 "The value of `dired-listing-switches' used to make this buffer's text.")
227 (defvar dired-re-inode-size
"[0-9 \t]*"
228 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
230 ;; These regexps must be tested at beginning-of-line, but are also
231 ;; used to search for next matches, so neither omitting "^" nor
232 ;; replacing "^" by "\n" (to make it slightly faster) will work.
234 (defvar dired-re-mark
"^[^ \n]")
235 ;; "Regexp matching a marked line.
236 ;; Important: the match ends just after the marker."
237 (defvar dired-re-maybe-mark
"^. ")
238 ;; The [^:] part after "d" and "l" is to avoid confusion with the
239 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
240 (defvar dired-re-dir
(concat dired-re-maybe-mark dired-re-inode-size
"d[^:]"))
241 (defvar dired-re-sym
(concat dired-re-maybe-mark dired-re-inode-size
"l[^:]"))
242 (defvar dired-re-exe
;; match ls permission string of an executable file
245 (concat dired-re-maybe-mark dired-re-inode-size x
)))
246 '("-[-r][-w][xs][-r][-w].[-r][-w]."
247 "-[-r][-w].[-r][-w][xs][-r][-w]."
248 "-[-r][-w].[-r][-w].[-r][-w][xst]")
250 (defvar dired-re-perms
"[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
251 (defvar dired-re-dot
"^.* \\.\\.?$")
253 ;; The subdirectory names in this list are expanded.
254 (defvar dired-subdir-alist nil
255 "Association list of subdirectories and their buffer positions.
256 Each subdirectory has an element: (DIRNAME . STARTMARKER).
257 The order of elements is the reverse of the order in the buffer.
258 In simple cases, this list contains one element.")
260 (defvar dired-subdir-regexp
"^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
261 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
262 Subexpression 1 is the subdirectory proper, no trailing colon.
263 The match starts at the beginning of the line and ends after the end
264 of the line (\\n or \\r).
265 Subexpression 2 must end right before the \\n or \\r.")
267 (defvar dired-font-lock-keywords
270 ;; Directory headers.
271 (list dired-subdir-regexp
'(1 font-lock-type-face
))
273 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
274 ;; file name itself. We search for Dired defined regexps, and then use the
275 ;; Dired defined function `dired-move-to-filename' before searching for the
276 ;; simple regexp ".+". It is that regexp which matches the file name.
280 '(0 font-lock-constant-face
)
281 '(".+" (dired-move-to-filename) nil
(0 font-lock-warning-face
)))
282 ;; People who are paranoid about security would consider this more
283 ;; important than other things such as whether it is a directory.
284 ;; But we don't want to encourage paranoia, so our default
285 ;; should be what's most useful for non-paranoids. -- rms.
287 ;;; ;; Files that are group or world writable.
288 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
289 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
290 ;;; '(1 font-lock-comment-face)
291 ;;; '(".+" (dired-move-to-filename) nil (0 font-lock-comment-face)))
295 '(".+" (dired-move-to-filename) nil
(0 font-lock-function-name-face
)))
299 '(".+" (dired-move-to-filename) nil
(0 font-lock-keyword-face
)))
301 ;; Files suffixed with `completion-ignored-extensions'.
303 (let ((extensions (mapcar 'regexp-quote completion-ignored-extensions
)))
304 ;; It is quicker to first find just an extension, then go back to the
305 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
306 (list (concat "\\(" (mapconcat 'identity extensions
"\\|") "\\|#\\)$")
307 '(".+" (dired-move-to-filename) nil
(0 font-lock-string-face
))))))
308 "Additional expressions to highlight in Dired mode.")
310 ;;; Macros must be defined before they are used, for the byte compiler.
312 ;; Mark all files for which CONDITION evals to non-nil.
313 ;; CONDITION is evaluated on each line, with point at beginning of line.
314 ;; MSG is a noun phrase for the type of files being marked.
315 ;; It should end with a noun that can be pluralized by adding `s'.
316 ;; Return value is the number of files marked, or nil if none were marked.
317 (defmacro dired-mark-if
(predicate msg
)
318 `(let (buffer-read-only count
)
321 (if ,msg
(message "Marking %ss..." ,msg
))
322 (goto-char (point-min))
327 (insert dired-marker-char
)
328 (setq count
(1+ count
))))
330 (if ,msg
(message "%s %s%s %s%s."
333 (dired-plural-s count
)
334 (if (eq dired-marker-char ?
\040) "un" "")
335 (if (eq dired-marker-char dired-del-marker
)
336 "flagged" "marked"))))
337 (and (> count
0) count
)))
339 (defmacro dired-map-over-marks
(body arg
&optional show-progress
)
340 "Eval BODY with point on each marked line. Return a list of BODY's results.
341 If no marked file could be found, execute BODY on the current line.
342 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
343 files instead of the marked files.
344 In that case point is dragged along. This is so that commands on
345 the next ARG (instead of the marked) files can be chained easily.
346 If ARG is otherwise non-nil, use current file instead.
347 If optional third arg SHOW-PROGRESS evaluates to non-nil,
348 redisplay the dired buffer after each file is processed.
349 No guarantee is made about the position on the marked line.
350 BODY must ensure this itself if it depends on this.
351 Search starts at the beginning of the buffer, thus the car of the list
352 corresponds to the line nearest to the buffer's bottom. This
353 is also true for (positive and negative) integer values of ARG.
354 BODY should not be too long as it is expanded four times."
356 ;;Warning: BODY must not add new lines before point - this may cause an
358 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
360 (let (buffer-read-only case-fold-search found results
)
363 (progn ;; no save-excursion, want to move point.
364 (dired-repeat-over-lines
367 (if ,show-progress
(sit-for 0))
368 (setq results
(cons ,body results
)))))
372 ;; non-nil, non-integer ARG means use current file:
374 (let ((regexp (dired-marker-regexp)) next-position
)
376 (goto-char (point-min))
377 ;; remember position of next marked file before BODY
378 ;; can insert lines before the just found file,
379 ;; confusing us by finding the same marked file again
381 (setq next-position
(and (re-search-forward regexp nil t
)
383 found
(not (null next-position
)))
385 (goto-char next-position
)
386 (if ,show-progress
(sit-for 0))
387 (setq results
(cons ,body results
))
388 ;; move after last match
389 (goto-char next-position
)
391 (set-marker next-position nil
)
392 (setq next-position
(and (re-search-forward regexp nil t
)
397 ;; save-excursion loses, again
398 (dired-move-to-filename)))
400 (defun dired-get-marked-files (&optional localp arg
)
401 "Return the marked files' names as list of strings.
402 The list is in the same order as the buffer, that is, the car is the
404 Values returned are normally absolute pathnames.
405 Optional arg LOCALP as in `dired-get-filename'.
406 Optional second argument ARG forces to use other files. If ARG is an
407 integer, use the next ARG files. If ARG is otherwise non-nil, use
408 current file. Usually ARG comes from the current prefix arg."
410 (nreverse (dired-map-over-marks (dired-get-filename localp
) arg
))))
413 ;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
414 ;; other special applications.
418 (defun dired-read-dir-and-switches (str)
419 ;; For use in interactive.
421 (if current-prefix-arg
422 (read-string "Dired listing switches: "
423 dired-listing-switches
))
424 (read-file-name (format "Dired %s(directory): " str
)
425 nil default-directory nil
))))
427 ;;;###autoload (define-key ctl-x-map "d" 'dired)
429 (defun dired (dirname &optional switches
)
430 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
431 Optional second argument SWITCHES specifies the `ls' options used.
432 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
433 Dired displays a list of files in DIRNAME (which may also have
434 shell wildcards appended to select certain files). If DIRNAME is a cons,
435 its first element is taken as the directory name and the rest as an explicit
436 list of files to make directory entries for.
438 You can move around in it with the usual commands.
439 You can flag files for deletion with \\[dired-flag-file-deletion] and then
440 delete them by typing \\[dired-do-flagged-delete].
441 Type \\[describe-mode] after entering dired for more info.
443 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
444 ;; Cannot use (interactive "D") because of wildcards.
445 (interactive (dired-read-dir-and-switches ""))
446 (switch-to-buffer (dired-noselect dirname switches
)))
448 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
450 (defun dired-other-window (dirname &optional switches
)
451 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
452 (interactive (dired-read-dir-and-switches "in other window "))
453 (switch-to-buffer-other-window (dired-noselect dirname switches
)))
455 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
457 (defun dired-other-frame (dirname &optional switches
)
458 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
459 (interactive (dired-read-dir-and-switches "in other frame "))
460 (switch-to-buffer-other-frame (dired-noselect dirname switches
)))
463 (defun dired-noselect (dir-or-list &optional switches
)
464 "Like `dired' but returns the dired buffer as value, does not select it."
465 (or dir-or-list
(setq dir-or-list default-directory
))
466 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
468 (let (dirname initially-was-dirname
)
469 (if (consp dir-or-list
)
470 (setq dirname
(car dir-or-list
))
471 (setq dirname dir-or-list
))
472 (setq initially-was-dirname
473 (string= (file-name-as-directory dirname
) dirname
))
474 (setq dirname
(abbreviate-file-name
475 (expand-file-name (directory-file-name dirname
))))
476 (if find-file-visit-truename
477 (setq dirname
(file-truename dirname
)))
478 ;; If the argument was syntactically a directory name not a file name,
479 ;; or if it happens to name a file that is a directory,
480 ;; convert it syntactically to a directory name.
481 ;; The reason for checking initially-was-dirname
482 ;; and not just file-directory-p
483 ;; is that file-directory-p is slow over ftp.
484 (if (or initially-was-dirname
(file-directory-p dirname
))
485 (setq dirname
(file-name-as-directory dirname
)))
486 (if (consp dir-or-list
)
487 (setq dir-or-list
(cons dirname
(cdr dir-or-list
)))
488 (setq dir-or-list dirname
))
489 (dired-internal-noselect dir-or-list switches
)))
491 ;; Separate function from dired-noselect for the sake of dired-vms.el.
492 (defun dired-internal-noselect (dir-or-list &optional switches mode
)
493 ;; If there is an existing dired buffer for DIRNAME, just leave
494 ;; buffer as it is (don't even call dired-revert).
495 ;; This saves time especially for deep trees or with ange-ftp.
496 ;; The user can type `g'easily, and it is more consistent with find-file.
497 ;; But if SWITCHES are given they are probably different from the
498 ;; buffer's old value, so call dired-sort-other, which does
499 ;; revert the buffer.
500 ;; A pity we can't possibly do "Directory has changed - refresh? "
501 ;; like find-file does.
502 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
504 (let* ((dirname (if (consp dir-or-list
) (car dir-or-list
) dir-or-list
))
505 ;; The following line used to use dir-or-list.
506 ;; That never found an existing buffer, in the case
507 ;; where it is a list.
508 (buffer (dired-find-buffer-nocreate dirname mode
))
509 ;; note that buffer already is in dired-mode, if found
510 (new-buffer-p (not buffer
))
511 (old-buf (current-buffer)))
513 (let ((default-major-mode 'fundamental-mode
))
514 ;; We don't want default-major-mode to run hooks and set auto-fill
515 ;; or whatever, now that dired-mode does not
516 ;; kill-all-local-variables any longer.
517 (setq buffer
(create-file-buffer (directory-file-name dirname
)))))
519 (if (not new-buffer-p
) ; existing buffer ...
520 (cond (switches ; ... but new switches
521 ;; file list may have changed
522 (if (consp dir-or-list
)
523 (setq dired-directory dir-or-list
))
524 ;; this calls dired-revert
525 (dired-sort-other switches
))
526 ;; If directory has changed on disk, offer to revert.
527 ((if (let ((attributes (file-attributes dirname
))
528 (modtime (visited-file-modtime)))
530 (not (eq (car attributes
) t
))
531 (and (= (car (nth 5 attributes
)) (car modtime
))
532 (= (nth 1 (nth 5 attributes
)) (cdr modtime
)))))
535 (substitute-command-keys
536 "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
538 (setq default-directory
539 ;; We can do this unconditionally
540 ;; because dired-noselect ensures that the name
541 ;; is passed in directory name syntax
542 ;; if it was the name of a directory at all.
543 (file-name-directory dirname
))
544 (or switches
(setq switches dired-listing-switches
))
545 (if mode
(funcall mode
)
546 (dired-mode dirname switches
))
547 ;; default-directory and dired-actual-switches are set now
548 ;; (buffer-local), so we can call dired-readin:
551 (progn (dired-readin dir-or-list buffer
)
553 ;; dired-readin can fail if parent directories are inaccessible.
554 ;; Don't leave an empty buffer around in that case.
555 (if failed
(kill-buffer buffer
))))
556 ;; No need to narrow since the whole buffer contains just
557 ;; dired-readin's output, nothing else. The hook can
558 ;; successfully use dired functions (e.g. dired-get-filename)
559 ;; as the subdir-alist has been built in dired-readin.
560 (run-hooks 'dired-after-readin-hook
)
561 (goto-char (point-min))
562 (dired-initial-position dirname
))
566 (defvar dired-buffers nil
567 ;; Enlarged by dired-advertise
568 ;; Queried by function dired-buffers-for-dir. When this detects a
569 ;; killed buffer, it is removed from this list.
570 "Alist of expanded directories and their associated dired buffers.")
572 (defun dired-find-buffer-nocreate (dirname &optional mode
)
573 ;; This differs from dired-buffers-for-dir in that it does not consider
574 ;; subdirs of default-directory and searches for the first match only.
575 ;; Also, the major mode must be MODE.
576 (let (found (blist dired-buffers
)) ; was (buffer-list)
577 (or mode
(setq mode
'dired-mode
))
579 (if (null (buffer-name (cdr (car blist
))))
580 (setq blist
(cdr blist
))
582 (set-buffer (cdr (car blist
)))
583 (if (and (eq major-mode mode
)
584 (if (consp dired-directory
)
585 (equal (car dired-directory
) dirname
)
586 (equal dired-directory dirname
)))
587 (setq found
(cdr (car blist
))
589 (setq blist
(cdr blist
))))))
593 ;; Read in a new dired buffer
595 ;; dired-readin differs from dired-insert-subdir in that it accepts
596 ;; wildcards, erases the buffer, and builds the subdir-alist anew
597 ;; (including making it buffer-local and clearing it first).
598 (defun dired-readin (dir-or-list buffer
)
599 ;; default-directory and dired-actual-switches must be buffer-local
600 ;; and initialized by now.
601 ;; Thus we can test (equal default-directory dirname) instead of
602 ;; (file-directory-p dirname) and save a filesystem transaction.
603 ;; Also, we can run this hook which may want to modify the switches
604 ;; based on default-directory, e.g. with ange-ftp to a SysV host
605 ;; where ls won't understand -Al switches.
607 (indent-tabs-mode nil
))
608 (if (consp dir-or-list
)
609 (setq dirname
(car dir-or-list
))
610 (setq dirname dir-or-list
))
611 (setq dirname
(expand-file-name dirname
))
612 (if (consp dir-or-list
)
613 (setq dir-or-list
(cons dirname
(cdr dir-or-list
))))
614 (run-hooks 'dired-before-readin-hook
)
616 (message "Reading directory %s..." dirname
)
618 (let (buffer-read-only (failed t
))
621 (dired-readin-insert dir-or-list
)
622 (indent-rigidly (point-min) (point-max) 2)
623 ;; We need this to make the root dir have a header line as all
624 ;; other subdirs have:
625 (goto-char (point-min))
626 (if (not (looking-at "^ /.*:$"))
627 (dired-insert-headerline default-directory
))
628 ;; can't run dired-after-readin-hook here, it may depend on the subdir
631 (message "Reading directory %s...done" dirname
)
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
))))
641 ;; Subroutines of dired-readin
643 (defun dired-readin-insert (dir-or-list)
644 ;; Just insert listing for the passed-in directory or
645 ;; directory-and-file list, assuming a clean buffer.
647 (if (consp dir-or-list
)
648 (setq dirname
(car dir-or-list
))
649 (setq dirname dir-or-list
))
650 ;; Expand before comparing in case one or both have been abbreviated.
651 (if (and (equal (expand-file-name default-directory
)
652 (expand-file-name dirname
))
653 (not (consp dir-or-list
)))
654 ;; If we are reading a whole single directory...
655 (dired-insert-directory dir-or-list dired-actual-switches nil t
)
656 (if (not (file-readable-p
657 (directory-file-name (file-name-directory dirname
))))
658 (error "Directory %s inaccessible or nonexistent" dirname
)
659 ;; Else assume it contains wildcards,
660 ;; unless it is an explicit list of files.
661 (dired-insert-directory dir-or-list dired-actual-switches
662 (not (listp dir-or-list
)))
663 (or (consp dir-or-list
)
664 (save-excursion ;; insert wildcard instead of total line:
665 (goto-char (point-min))
666 (insert "wildcard " (file-name-nondirectory dirname
) "\n")))))))
668 (defun dired-insert-directory (dir-or-list switches
&optional wildcard full-p
)
669 ;; Do the right thing whether dir-or-list is atomic or not. If it is,
670 ;; inset all files listed in the cdr (the car is the passed-in directory
672 (let ((opoint (point))
673 (process-environment (copy-sequence process-environment
))
675 ;; We used to specify the C locale here, to force English month names;
676 ;; but this should not be necessary any more,
677 ;; with the new value of dired-move-to-filename-regexp.
678 (if (consp dir-or-list
)
679 ;; In this case, use the file names in the cdr
680 ;; exactly as originally given to dired-noselect.
682 (function (lambda (x) (insert-directory x switches wildcard full-p
)))
684 ;; Expand the file name here because it may have been abbreviated
685 ;; in dired-noselect.
686 (insert-directory (expand-file-name dir-or-list
) switches wildcard full-p
))
687 ;; Quote certain characters, unless ls quoted them for us.
688 (if (not (string-match "b" dired-actual-switches
))
690 (setq end
(point-marker))
692 (while (search-forward "\\" end t
)
693 (replace-match "\\\\" nil t
))
695 (while (search-forward "\^m" end t
)
696 (replace-match "\\015" nil t
))
697 (set-marker end nil
)))
698 (dired-insert-set-properties opoint
(point)))
699 (setq dired-directory dir-or-list
))
701 ;; Make the file names highlight when the mouse is on them.
702 (defun dired-insert-set-properties (beg end
)
705 (while (< (point) end
)
707 (if (dired-move-to-filename)
711 (dired-move-to-end-of-filename)
713 '(mouse-face highlight
714 help-echo
"mouse-2: visit this file in other window")))
718 (defun dired-insert-headerline (dir);; also used by dired-insert-subdir
719 ;; Insert DIR's headerline with no trailing slash, exactly like ls
720 ;; would, and put cursor where dired-build-subdir-alist puts subdir
722 (save-excursion (insert " " (directory-file-name dir
) ":\n")))
725 ;; Reverting a dired buffer
727 (defun dired-revert (&optional arg noconfirm
)
728 ;; Reread the dired buffer. Must also be called after
729 ;; dired-actual-switches have changed.
730 ;; Should not fail even on completely garbaged buffers.
731 ;; Preserves old cursor, marks/flags, hidden-p.
732 (widen) ; just in case user narrowed
733 (let ((opoint (point))
734 (ofile (dired-get-filename nil t
))
735 (mark-alist nil
) ; save marked files
736 (hidden-subdirs (dired-remember-hidden))
737 (old-subdir-alist (cdr (reverse dired-subdir-alist
))) ; except pwd
738 (case-fold-search nil
) ; we check for upper case ls flags
740 (goto-char (point-min))
741 (setq mark-alist
;; only after dired-remember-hidden since this unhides:
742 (dired-remember-marks (point-min) (point-max)))
743 ;; treat top level dir extra (it may contain wildcards)
745 (if (consp dired-directory
) (car dired-directory
) dired-directory
))
746 (dired-readin dired-directory
(current-buffer))
747 (let ((dired-after-readin-hook nil
))
748 ;; don't run that hook for each subdir...
749 (dired-insert-old-subdirs old-subdir-alist
))
750 (dired-mark-remembered mark-alist
) ; mark files that were marked
751 ;; ... run the hook for the whole buffer, and only after markers
752 ;; have been reinserted (else omitting in dired-x would omit marked files)
753 (run-hooks 'dired-after-readin-hook
) ; no need to narrow
754 (or (and ofile
(dired-goto-file ofile
)) ; move cursor to where it
755 (goto-char opoint
)) ; was before
756 (dired-move-to-filename)
757 (save-excursion ; hide subdirs that were hidden
758 (mapcar (function (lambda (dir)
759 (if (dired-goto-subdir dir
)
760 (dired-hide-subdir 1))))
762 ;; outside of the let scope
763 ;;; Might as well not override the user if the user changed this.
764 ;;; (setq buffer-read-only t)
767 ;; Subroutines of dired-revert
768 ;; Some of these are also used when inserting subdirs.
770 (defun dired-remember-marks (beg end
)
771 ;; Return alist of files and their marks, from BEG to END.
772 (if selective-display
; must unhide to make this work.
773 (let (buffer-read-only)
774 (subst-char-in-region beg end ?
\r ?
\n)))
778 (while (re-search-forward dired-re-mark end t
)
779 (if (setq fil
(dired-get-filename nil t
))
780 (setq chr
(preceding-char)
781 alist
(cons (cons fil chr
) alist
)))))
784 ;; Mark all files remembered in ALIST.
785 ;; Each element of ALIST looks like (FILE . MARKERCHAR).
786 (defun dired-mark-remembered (alist)
789 (setq elt
(car alist
)
793 (if (dired-goto-file fil
)
799 ;; Return a list of names of subdirs currently hidden.
800 (defun dired-remember-hidden ()
801 (let ((l dired-subdir-alist
) dir pos result
)
803 (setq dir
(car (car l
))
807 (skip-chars-forward "^\r\n")
808 (if (eq (following-char) ?
\r)
809 (setq result
(cons dir result
))))
812 ;; Try to insert all subdirs that were displayed before,
813 ;; according to the former subdir alist OLD-SUBDIR-ALIST.
814 (defun dired-insert-old-subdirs (old-subdir-alist)
815 (or (string-match "R" dired-actual-switches
)
817 (while old-subdir-alist
818 (setq elt
(car old-subdir-alist
)
819 old-subdir-alist
(cdr old-subdir-alist
)
824 (dired-insert-subdir dir
))
827 ;; Remove directory DIR from any directory cache.
828 (defun dired-uncache (dir)
829 (let ((handler (find-file-name-handler dir
'dired-uncache
)))
831 (funcall handler
'dired-uncache dir
))))
833 ;; dired mode key bindings and initialization
835 (defvar dired-mode-map nil
"Local keymap for dired-mode buffers.")
838 ;; This looks ugly when substitute-command-keys uses C-d instead d:
839 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
841 (let ((map (make-keymap)))
842 (suppress-keymap map
)
843 (define-key map
[mouse-2
] 'dired-mouse-find-file-other-window
)
844 ;; Commands to mark or flag certain categories of files
845 (define-key map
"#" 'dired-flag-auto-save-files
)
846 (define-key map
"." 'dired-clean-directory
)
847 (define-key map
"~" 'dired-flag-backup-files
)
848 (define-key map
"&" 'dired-flag-garbage-files
)
849 ;; Upper case keys (except !) for operating on the marked files
850 (define-key map
"A" 'dired-do-search
)
851 (define-key map
"C" 'dired-do-copy
)
852 (define-key map
"B" 'dired-do-byte-compile
)
853 (define-key map
"D" 'dired-do-delete
)
854 (define-key map
"G" 'dired-do-chgrp
)
855 (define-key map
"H" 'dired-do-hardlink
)
856 (define-key map
"L" 'dired-do-load
)
857 (define-key map
"M" 'dired-do-chmod
)
858 (define-key map
"O" 'dired-do-chown
)
859 (define-key map
"P" 'dired-do-print
)
860 (define-key map
"Q" 'dired-do-query-replace-regexp
)
861 (define-key map
"R" 'dired-do-rename
)
862 (define-key map
"S" 'dired-do-symlink
)
863 (define-key map
"X" 'dired-do-shell-command
)
864 (define-key map
"Z" 'dired-do-compress
)
865 (define-key map
"!" 'dired-do-shell-command
)
866 ;; Comparison commands
867 (define-key map
"=" 'dired-diff
)
868 (define-key map
"\M-=" 'dired-backup-diff
)
869 ;; Tree Dired commands
870 (define-key map
"\M-\C-?" 'dired-unmark-all-files
)
871 (define-key map
"\M-\C-d" 'dired-tree-down
)
872 (define-key map
"\M-\C-u" 'dired-tree-up
)
873 (define-key map
"\M-\C-n" 'dired-next-subdir
)
874 (define-key map
"\M-\C-p" 'dired-prev-subdir
)
875 ;; move to marked files
876 (define-key map
"\M-{" 'dired-prev-marked-file
)
877 (define-key map
"\M-}" 'dired-next-marked-file
)
878 ;; Make all regexp commands share a `%' prefix:
879 ;; We used to get to the submap via a symbol dired-regexp-prefix,
880 ;; but that seems to serve little purpose, and copy-keymap
881 ;; does a better job without it.
882 (define-key map
"%" nil
)
883 (define-key map
"%u" 'dired-upcase
)
884 (define-key map
"%l" 'dired-downcase
)
885 (define-key map
"%d" 'dired-flag-files-regexp
)
886 (define-key map
"%g" 'dired-mark-files-containing-regexp
)
887 (define-key map
"%m" 'dired-mark-files-regexp
)
888 (define-key map
"%r" 'dired-do-rename-regexp
)
889 (define-key map
"%C" 'dired-do-copy-regexp
)
890 (define-key map
"%H" 'dired-do-hardlink-regexp
)
891 (define-key map
"%R" 'dired-do-rename-regexp
)
892 (define-key map
"%S" 'dired-do-symlink-regexp
)
893 ;; Commands for marking and unmarking.
894 (define-key map
"*" nil
)
895 (define-key map
"**" 'dired-mark-executables
)
896 (define-key map
"*/" 'dired-mark-directories
)
897 (define-key map
"*@" 'dired-mark-symlinks
)
898 (define-key map
"*%" 'dired-mark-files-regexp
)
899 (define-key map
"*c" 'dired-change-marks
)
900 (define-key map
"*s" 'dired-mark-subdir-files
)
901 (define-key map
"*m" 'dired-mark
)
902 (define-key map
"*u" 'dired-unmark
)
903 (define-key map
"*?" 'dired-unmark-all-files
)
904 (define-key map
"*!" 'dired-unmark-all-marks
)
905 (define-key map
"*\177" 'dired-unmark-backward
)
906 (define-key map
"*\C-n" 'dired-next-marked-file
)
907 (define-key map
"*\C-p" 'dired-prev-marked-file
)
908 (define-key map
"*t" 'dired-do-toggle
)
909 ;; Lower keys for commands not operating on all the marked files
910 (define-key map
"a" 'dired-find-alternate-file
)
911 (define-key map
"d" 'dired-flag-file-deletion
)
912 (define-key map
"e" 'dired-find-file
)
913 (define-key map
"f" 'dired-find-file
)
914 (define-key map
"\C-m" 'dired-advertised-find-file
)
915 (define-key map
"g" 'revert-buffer
)
916 (define-key map
"h" 'describe-mode
)
917 (define-key map
"i" 'dired-maybe-insert-subdir
)
918 (define-key map
"k" 'dired-do-kill-lines
)
919 (define-key map
"l" 'dired-do-redisplay
)
920 (define-key map
"m" 'dired-mark
)
921 (define-key map
"n" 'dired-next-line
)
922 (define-key map
"o" 'dired-find-file-other-window
)
923 (define-key map
"\C-o" 'dired-display-file
)
924 (define-key map
"p" 'dired-previous-line
)
925 (define-key map
"q" 'quit-window
)
926 (define-key map
"s" 'dired-sort-toggle-or-edit
)
927 (define-key map
"t" 'dired-do-toggle
)
928 (define-key map
"u" 'dired-unmark
)
929 (define-key map
"v" 'dired-view-file
)
930 (define-key map
"w" 'dired-copy-filename-as-kill
)
931 (define-key map
"x" 'dired-do-flagged-delete
)
932 (define-key map
"y" 'dired-show-file-type
)
933 (define-key map
"+" 'dired-create-directory
)
935 (define-key map
"<" 'dired-prev-dirline
)
936 (define-key map
">" 'dired-next-dirline
)
937 (define-key map
"^" 'dired-up-directory
)
938 (define-key map
" " 'dired-next-line
)
939 (define-key map
"\C-n" 'dired-next-line
)
940 (define-key map
"\C-p" 'dired-previous-line
)
941 (define-key map
[down] 'dired-next-line)
942 (define-key map [up] 'dired-previous-line)
944 (define-key map "$" 'dired-hide-subdir)
945 (define-key map "\M-$" 'dired-hide-all)
947 (define-key map "?" 'dired-summary)
948 (define-key map "\177" 'dired-unmark-backward)
949 (define-key map "\C-_" 'dired-undo)
950 (define-key map "\C-xu" 'dired-undo)
952 ;; Make menu bar items.
954 ;; No need to fo this, now that top-level items are fewer.
956 ;; Get rid of the Edit menu bar item to save space.
957 ;(define-key map [menu-bar edit] 'undefined)
959 (define-key map [menu-bar subdir]
960 (cons "Subdir" (make-sparse-keymap "Subdir")))
962 (define-key map [menu-bar subdir hide-all]
963 '(menu-item "Hide All" dired-hide-all
964 :help "Hide all subdirectories, leave only header lines"))
965 (define-key map [menu-bar subdir hide-subdir]
966 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
967 :help "Hide or unhide current directory listing"))
968 (define-key map [menu-bar subdir tree-down]
969 '(menu-item "Tree Down" dired-tree-down
970 :help "Go to first subdirectory header down the tree"))
971 (define-key map [menu-bar subdir tree-up]
972 '(menu-item "Tree Up" dired-tree-up
973 :help "Go to first subdirectory header up the tree"))
974 (define-key map [menu-bar subdir up]
975 '(menu-item "Up Directory" dired-up-directory
976 :help "Edit the parent directory"))
977 (define-key map [menu-bar subdir prev-subdir]
978 '(menu-item "Prev Subdir" dired-prev-subdir
979 :help "Go to previous subdirectory header line"))
980 (define-key map [menu-bar subdir next-subdir]
981 '(menu-item "Next Subdir" dired-next-subdir
982 :help "Go to next subdirectory header line"))
983 (define-key map [menu-bar subdir prev-dirline]
984 '(menu-item "Prev Dirline" dired-prev-dirline
985 :help "Move to next directory-file line"))
986 (define-key map [menu-bar subdir next-dirline]
987 '(menu-item "Next Dirline" dired-next-dirline
988 :help "Move to previous directory-file line"))
989 (define-key map [menu-bar subdir insert]
990 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
991 :help "Insert contents of subdirectory"))
993 (define-key map [menu-bar immediate]
994 (cons "Immediate" (make-sparse-keymap "Immediate")))
996 (define-key map [menu-bar immediate revert-buffer]
997 '(menu-item "Refresh" revert-buffer
998 :help "Update contents of shown directories"))
1000 (define-key map [menu-bar immediate dashes]
1003 (define-key map [menu-bar immediate backup-diff]
1004 '(menu-item "Compare with Backup" dired-backup-diff
1005 :help "Diff file at cursor with its latest backup"))
1006 (define-key map [menu-bar immediate diff]
1007 '(menu-item "Diff..." dired-diff
1008 :help "Compare file at cursor with another file"))
1009 (define-key map [menu-bar immediate view]
1010 '(menu-item "View This File" dired-view-file
1011 :help "Examine file at cursor in read-only mode"))
1012 (define-key map [menu-bar immediate display]
1013 '(menu-item "Display in Other Window" dired-display-file
1014 :help "Display file at cursor in other window"))
1015 (define-key map [menu-bar immediate find-file-other-window]
1016 '(menu-item "Find in Other Window" dired-find-file-other-window
1017 :help "Edit file at cursor in other window"))
1018 (define-key map [menu-bar immediate find-file]
1019 '(menu-item "Find This File" dired-find-file
1020 :help "Edit file at cursor"))
1021 (define-key map [menu-bar immediate create-directory]
1022 '(menu-item "Create Directory..." dired-create-directory))
1024 (define-key map [menu-bar regexp]
1025 (cons "Regexp" (make-sparse-keymap "Regexp")))
1027 (define-key map [menu-bar regexp downcase]
1028 '(menu-item "Downcase" dired-downcase
1029 ;; When running on plain MS-DOS, there's only one
1030 ;; letter-case for file names.
1031 :enable (or (not (fboundp 'msdos-long-file-names))
1032 (msdos-long-file-names))
1033 :help "Rename marked files to lower-case name"))
1034 (define-key map [menu-bar regexp upcase]
1035 '(menu-item "Upcase" dired-upcase
1036 :enable (or (not (fboundp 'msdos-long-file-names))
1037 (msdos-long-file-names))
1038 :help "Rename marked files to upper-case name"))
1039 (define-key map [menu-bar regexp hardlink]
1040 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1041 :help "Make hard links for files matching regexp"))
1042 (define-key map [menu-bar regexp symlink]
1043 '(menu-item "Symlink..." dired-do-symlink-regexp
1044 :visible (fboundp 'make-symbolic-link)
1045 :help "Make symbolic links for files matching regexp"))
1046 (define-key map [menu-bar regexp rename]
1047 '(menu-item "Rename..." dired-do-rename-regexp
1048 :help "Rename marked files matching regexp"))
1049 (define-key map [menu-bar regexp copy]
1050 '(menu-item "Copy..." dired-do-copy-regexp
1051 :help "Copy marked files matching regexp"))
1052 (define-key map [menu-bar regexp flag]
1053 '(menu-item "Flag..." dired-flag-files-regexp
1054 :help "Flag files matching regexp for deletion"))
1055 (define-key map [menu-bar regexp mark]
1056 '(menu-item "Mark..." dired-mark-files-regexp
1057 :help "Mark files matching regexp for future operations"))
1058 (define-key map [menu-bar regexp mark-cont]
1059 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1060 :help "Mark files whose contents matches regexp"))
1062 (define-key map [menu-bar mark]
1063 (cons "Mark" (make-sparse-keymap "Mark")))
1065 (define-key map [menu-bar mark prev]
1066 '(menu-item "Previous Marked" dired-prev-marked-file
1067 :help "Move to previous marked file"))
1068 (define-key map [menu-bar mark next]
1069 '(menu-item "Next Marked" dired-next-marked-file
1070 :help "Move to next marked file"))
1071 (define-key map [menu-bar mark marks]
1072 '(menu-item "Change Marks..." dired-change-marks
1073 :help "Replace marker with another character"))
1074 (define-key map [menu-bar mark unmark-all]
1075 '(menu-item "Unmark All" dired-unmark-all-marks))
1076 (define-key map [menu-bar mark symlinks]
1077 '(menu-item "Mark Symlinks" dired-mark-symlinks
1078 :visible (fboundp 'make-symbolic-link)
1079 :help "Mark all symbolic links"))
1080 (define-key map [menu-bar mark directories]
1081 '(menu-item "Mark Directories" dired-mark-directories
1082 :help "Mark all directories except `.' and `..'"))
1083 (define-key map [menu-bar mark directory]
1084 '(menu-item "Mark Old Backups" dired-clean-directory
1085 :help "Flag old numbered backups for deletion"))
1086 (define-key map [menu-bar mark executables]
1087 '(menu-item "Mark Executables" dired-mark-executables
1088 :help "Mark all executable files"))
1089 (define-key map [menu-bar mark garbage-files]
1090 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1091 :help "Flag unneeded files for deletion"))
1092 (define-key map [menu-bar mark backup-files]
1093 '(menu-item "Flag Backup Files" dired-flag-backup-files
1094 :help "Flag all backup files for deletion"))
1095 (define-key map [menu-bar mark auto-save-files]
1096 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1097 :help "Flag auto-save files for deletion"))
1098 (define-key map [menu-bar mark deletion]
1099 '(menu-item "Flag" dired-flag-file-deletion
1100 :help "Flag current line's file for deletion"))
1101 (define-key map [menu-bar mark unmark]
1102 '(menu-item "Unmark" dired-unmark
1103 :help "Unmark or unflag current line's file"))
1104 (define-key map [menu-bar mark mark]
1105 '(menu-item "Mark" dired-mark
1106 :help "Mark current line's file for future operations"))
1107 (define-key map [menu-bar mark toggle-marks]
1108 '(menu-item "Toggle Marks" dired-do-toggle
1109 :help "Mark unmarked files, unmark marked ones"))
1111 (define-key map [menu-bar operate]
1112 (cons "Operate" (make-sparse-keymap "Operate")))
1114 (define-key map [menu-bar operate query-replace]
1115 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1116 :help "Replace regexp in marked files"))
1117 (define-key map [menu-bar operate search]
1118 '(menu-item "Search Files..." dired-do-search
1119 :help "Search marked files for regexp"))
1120 (define-key map [menu-bar operate chown]
1121 '(menu-item "Change Owner..." dired-do-chown
1122 :visible (not (memq system-type '(ms-dos windows-nt)))
1123 :help "Change the owner of marked files"))
1124 (define-key map [menu-bar operate chgrp]
1125 '(menu-item "Change Group..." dired-do-chgrp
1126 :visible (not (memq system-type '(ms-dos windows-nt)))
1127 :help "Change the group of marked files"))
1128 (define-key map [menu-bar operate chmod]
1129 '(menu-item "Change Mode..." dired-do-chmod
1130 :help "Change mode (attributes) of marked files"))
1131 (define-key map [menu-bar operate load]
1132 '(menu-item "Load" dired-do-load
1133 :help "Load marked Emacs Lisp files"))
1134 (define-key map [menu-bar operate compile]
1135 '(menu-item "Byte-compile" dired-do-byte-compile
1136 :help "Byte-compile marked Emacs Lisp files"))
1137 (define-key map [menu-bar operate compress]
1138 '(menu-item "Compress" dired-do-compress
1139 :help "Compress/uncompress marked files"))
1140 (define-key map [menu-bar operate print]
1141 '(menu-item "Print..." dired-do-print
1142 :help "Ask for print command and print marked files"))
1143 (define-key map [menu-bar operate hardlink]
1144 '(menu-item "Hardlink to..." dired-do-hardlink
1145 :help "Make hard links for current or marked files"))
1146 (define-key map [menu-bar operate symlink]
1147 '(menu-item "Symlink to..." dired-do-symlink
1148 :visible (fboundp 'make-symbolic-link)
1149 :help "Make symbolic links for current or marked files"))
1150 (define-key map [menu-bar operate command]
1151 '(menu-item "Shell Command..." dired-do-shell-command
1152 :help "Run a shell command on each of marked files"))
1153 (define-key map [menu-bar operate delete]
1154 '(menu-item "Delete" dired-do-delete
1155 :help "Delete current file or all marked files"))
1156 (define-key map [menu-bar operate rename]
1157 '(menu-item "Rename to..." dired-do-rename
1158 :help "Rename current file or move marked files"))
1159 (define-key map [menu-bar operate copy]
1160 '(menu-item "Copy to..." dired-do-copy
1161 :help "Copy current file or all marked files"))
1163 (setq dired-mode-map map)))
1165 ;; Dired mode is suitable only for specially formatted data.
1166 (put 'dired-mode 'mode-class 'special)
1168 (defun dired-mode (&optional dirname switches)
1170 Mode for \"editing\" directory listings.
1171 In Dired, you are \"editing\" a list of the files in a directory and
1172 \(optionally) its subdirectories, in the format of `ls -lR'.
1173 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1174 \"Editing\" means that you can run shell commands on files, visit,
1175 compress, load or byte-compile them, change their file attributes
1176 and insert subdirectories into the same buffer. You can \"mark\"
1177 files for later commands or \"flag\" them for deletion, either file
1178 by file or all files matching certain criteria.
1179 You can move using the usual cursor motion commands.\\<dired-mode-map>
1180 Letters no longer insert themselves. Digits are prefix arguments.
1181 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1182 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1183 Most commands operate on the marked files and use the current file
1184 if no files are marked. Use a numeric prefix argument to operate on
1185 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1186 to operate on the current file only. Prefix arguments override marks.
1187 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1188 to see why something went wrong.
1189 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1190 Type \\[dired-unmark-backward] to back up one line and unflag.
1191 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1192 Type \\[dired-advertised-find-file] to Find the current line's file
1193 (or dired it in another buffer, if it is a directory).
1194 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1195 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1196 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1197 Type \\[dired-do-copy] to Copy files.
1198 Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
1199 Type \\[revert-buffer] to read all currently expanded directories again.
1200 This retains all marks and hides subdirs again that were hidden before.
1201 SPC and DEL can be used to move down and up by lines.
1203 If dired ever gets confused, you can either type \\[revert-buffer] \
1205 directories again, type \\[dired-do-redisplay] \
1206 to relist a single or the marked files or a
1207 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1208 again for the directory tree.
1210 Customization variables (rename this buffer and type \\[describe-variable] on each line
1213 dired-listing-switches
1214 dired-trivial-filenames
1218 dired-keep-marker-rename
1219 dired-keep-marker-copy
1220 dired-keep-marker-hardlink
1221 dired-keep-marker-symlink
1223 Hooks (use \\[describe-variable] to see their documentation):
1225 dired-before-readin-hook
1226 dired-after-readin-hook
1232 ;; Not to be called interactively (e.g. dired-directory will be set
1233 ;; to default-directory, which is wrong with wildcards).
1234 (kill-all-local-variables)
1235 (use-local-map dired-mode-map)
1236 (dired-advertise) ; default-directory is already set
1237 (setq major-mode 'dired-mode
1239 ;; case-fold-search nil
1241 selective-display t ; for subdirectory hiding
1242 mode-line-buffer-identification
1243 (propertized-buffer-identification "%17b"))
1244 (set (make-local-variable 'revert-buffer-function)
1245 (function dired-revert))
1246 (set (make-local-variable 'page-delimiter)
1248 (set (make-local-variable 'dired-directory)
1249 (or dirname default-directory))
1250 ;; list-buffers uses this to display the dir being edited in this buffer.
1251 (set (make-local-variable 'list-buffers-directory)
1252 (expand-file-name dired-directory))
1253 (set (make-local-variable 'dired-actual-switches)
1254 (or switches dired-listing-switches))
1255 (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
1256 (dired-sort-other dired-actual-switches t)
1257 (run-hooks 'dired-mode-hook))
1259 ;; Idiosyncratic dired commands that don't deal with marks.
1261 (defun dired-summary ()
1262 "Summarize basic Dired commands and show recent Dired errors."
1265 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1267 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1269 (defun dired-undo ()
1270 "Undo in a dired buffer.
1271 This doesn't recover lost files, it just undoes changes in the buffer itself.
1272 You can use it to recover marks, killed lines or subdirs.
1273 In the latter case, you have to do \\[dired-build-subdir-alist] to
1274 parse the buffer again."
1276 (let (buffer-read-only)
1278 (message "Change in Dired buffer undone.
1279 Actual changes in files cannot be undone by Emacs.")))
1281 (defun dired-next-line (arg)
1282 "Move down lines then position at filename.
1283 Optional prefix ARG says how many lines to move; default is one line."
1286 (dired-move-to-filename))
1288 (defun dired-previous-line (arg)
1289 "Move up lines then position at filename.
1290 Optional prefix ARG says how many lines to move; default is one line."
1293 (dired-move-to-filename))
1295 (defun dired-next-dirline (arg &optional opoint)
1296 "Goto ARG'th next directory file line."
1298 (or opoint (setq opoint (point)))
1300 (re-search-forward dired-re-dir nil t arg)
1302 (re-search-backward dired-re-dir nil t (- arg)))
1303 (dired-move-to-filename) ; user may type `i' or `f'
1305 (error "No more subdirectories")))
1307 (defun dired-prev-dirline (arg)
1308 "Goto ARG'th previous directory file line."
1310 (dired-next-dirline (- arg)))
1312 (defun dired-up-directory (&optional other-window)
1313 "Run Dired on parent directory of current directory.
1314 Find the parent directory either in this buffer or another buffer.
1315 Creates a buffer if necessary."
1317 (let* ((dir (dired-current-directory))
1318 (up (file-name-directory (directory-file-name dir))))
1319 (or (dired-goto-file (directory-file-name dir))
1320 ;; Only try dired-goto-subdir if buffer has more than one dir.
1321 (and (cdr dired-subdir-alist)
1322 (dired-goto-subdir up))
1325 (dired-other-window up)
1327 (dired-goto-file dir)))))
1329 (defun dired-get-file-for-visit ()
1330 "Get the current line's file name, with an error if file does not exist."
1332 (let ((file-name (file-name-sans-versions (dired-get-filename) t)))
1333 (if (file-exists-p file-name)
1335 (if (file-symlink-p file-name)
1336 (error "File is a symlink to a nonexistent target")
1337 (error "File no longer exists; type `g' to update Dired buffer")))))
1339 ;; Force `f' rather than `e' in the mode doc:
1340 (defalias 'dired-advertised-find-file 'dired-find-file)
1341 (defun dired-find-file ()
1342 "In Dired, visit the file or directory named on this line."
1344 (find-file (dired-get-file-for-visit)))
1346 (defun dired-find-alternate-file ()
1347 "In Dired, visit this file or directory instead of the dired buffer."
1349 (set-buffer-modified-p nil)
1350 (find-alternate-file (dired-get-file-for-visit)))
1352 (defun dired-mouse-find-file-other-window (event)
1353 "In Dired, visit the file or directory name you click on."
1357 (set-buffer (window-buffer (posn-window (event-end event))))
1359 (goto-char (posn-point (event-end event)))
1360 (setq file (dired-get-file-for-visit))))
1361 (select-window (posn-window (event-end event)))
1362 (find-file-other-window (file-name-sans-versions file t))))
1364 (defun dired-view-file ()
1365 "In Dired, examine a file in view mode, returning to dired when done.
1366 When file is a directory, show it in this buffer if it is inserted;
1367 otherwise, display it in another buffer."
1369 (let ((file (dired-get-file-for-visit)))
1370 (if (file-directory-p file)
1371 (or (and (cdr dired-subdir-alist)
1372 (dired-goto-subdir file))
1376 (defun dired-find-file-other-window ()
1377 "In Dired, visit this file or directory in another window."
1379 (find-file-other-window (dired-get-file-for-visit)))
1381 (defun dired-display-file ()
1382 "In Dired, display this file or directory in another window."
1384 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1386 ;;; Functions for extracting and manipulating file names in Dired buffers.
1388 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1389 "In Dired, return name of file mentioned on this line.
1390 Value returned normally includes the directory name.
1391 Optional arg LOCALP with value `no-dir' means don't include directory
1392 name in result. A value of `verbatim' means to return the name exactly as
1393 it occurs in the buffer, and a value of t means construct name relative to
1394 `default-directory', which still may contain slashes if in a subdirectory.
1395 Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1396 this line, otherwise an error occurs."
1397 (let (case-fold-search file p1 p2 already-absolute)
1399 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1400 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1401 ;; nil if no file on this line, but no-error-if-not-filep is t:
1402 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1404 ;; Get rid of the mouse-face property that file names have.
1405 (set-text-properties 0 (length file) nil file)
1406 ;; Unquote names quoted by ls or by dired-insert-directory.
1407 ;; Using read to unquote is much faster than substituting
1408 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1412 ;; some ls -b don't escape quotes, argh!
1413 ;; This is not needed for GNU ls, though.
1414 (or (dired-string-replace-match
1415 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
1418 (and file (file-name-absolute-p file)
1419 ;; A relative file name can start with ~.
1420 ;; Don't treat it as absolute in this context.
1421 (not (eq (aref file 0) ?~))
1422 (setq already-absolute t))
1423 (and file buffer-file-coding-system
1424 (not file-name-coding-system)
1425 (not default-file-name-coding-system)
1426 (setq file (encode-coding-string file buffer-file-coding-system)))
1430 ((eq localp 'verbatim)
1432 ((and (eq localp 'no-dir) already-absolute)
1433 (file-name-nondirectory file))
1435 (if (find-file-name-handler file nil)
1438 ((eq localp 'no-dir)
1440 ((equal (dired-current-directory) "/")
1441 (setq file (concat (dired-current-directory localp) file))
1442 (if (find-file-name-handler file nil)
1446 (concat (dired-current-directory localp) file)))))
1448 (defun dired-string-replace-match (regexp string newtext
1449 &optional literal global)
1450 "Replace first match of REGEXP in STRING with NEWTEXT.
1451 If it does not match, nil is returned instead of the new string.
1452 Optional arg LITERAL means to take NEWTEXT literally.
1453 Optional arg GLOBAL means to replace all matches."
1455 (let ((start 0) ret)
1456 (while (string-match regexp string start)
1457 (let ((from-end (- (length string) (match-end 0))))
1458 (setq ret (setq string (replace-match newtext t literal string)))
1459 (setq start (- (length string) from-end))))
1461 (if (not (string-match regexp string 0))
1463 (replace-match newtext t literal string))))
1465 (defun dired-make-absolute (file &optional dir)
1466 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1467 ;; We can't always use expand-file-name as this would get rid of `.'
1468 ;; or expand in / instead default-directory if DIR=="".
1469 ;; This should be good enough for ange-ftp, but might easily be
1470 ;; redefined (for VMS?).
1471 ;; It should be reasonably fast, though, as it is called in
1472 ;; dired-get-filename.
1473 (concat (or dir default-directory) file))
1475 (defun dired-make-relative (file &optional dir ignore)
1476 "Convert FILE (an absolute file name) to a name relative to DIR.
1477 If this is impossible, return FILE unchanged.
1478 DIR must be a directory name, not a file name."
1479 (or dir (setq dir default-directory))
1480 ;; This case comes into play if default-directory is set to
1482 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1483 (setq dir (expand-file-name dir)))
1484 (if (string-match (concat "^" (regexp-quote dir)) file)
1485 (substring file (match-end 0))
1487 ;;; (error "%s: not in directory tree growing at %s" file dir))
1490 ;;; Functions for finding the file name in a dired buffer line.
1492 (defvar dired-move-to-filename-regexp
1493 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
1494 ;; In some locales, month abbreviations are as short as 2 letters,
1495 ;; and they can be followed by ".".
1496 (month (concat l l "+\\.?"))
1498 (yyyy "[0-9][0-9][0-9][0-9]")
1500 (HH:MM "[ 0-2][0-9]:[0-5][0-9]")
1501 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
1502 (zone "[-+][0-2][0-9][0-5][0-9]")
1503 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
1504 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
1505 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
1506 "\\|" yyyy "-" iso-mm-dd "\\)"))
1507 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
1509 "\\(" HH:MM "\\|" yyyy "\\)"))
1510 (western-comma (concat month s "+" dd "," s "+" yyyy))
1511 ;; Japanese MS-Windows ls-lisp has one-digit months, and
1512 ;; omits the Kanji characters after month and day-of-month.
1515 (concat mm l "?" s dd l "?" s "+"
1516 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
1517 ;; The "[0-9]" below requires the previous column to end in a digit.
1518 ;; This avoids recognizing `1 may 1997' as a date in the line:
1519 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
1520 ;; The "[kMGTPEZY]?" below supports "ls -alh" output.
1521 ;; The ".*" below finds the last match if there are multiple matches.
1522 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
1523 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1524 (concat ".*[0-9][kMGTPEZY]?" s
1525 "\\(" western "\\|" western-comma "\\|" japanese "\\|" iso "\\)"
1527 "Regular expression to match up to the file name in a directory listing.
1528 The default value is designed to recognize dates and times
1529 regardless of the language.")
1531 (defvar dired-permission-flags-regexp
1532 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1533 "Regular expression to match the permission flags in `ls -l'.")
1535 ;; Move to first char of filename on this line.
1536 ;; Returns position (point) or nil if no filename on this line."
1537 (defun dired-move-to-filename (&optional raise-error eol)
1538 ;; This is the UNIX version.
1539 (or eol (setq eol (progn (end-of-line) (point))))
1541 (if (re-search-forward dired-move-to-filename-regexp eol t)
1542 (goto-char (match-end 0))
1544 (error "No file on this line"))))
1546 (defun dired-move-to-end-of-filename (&optional no-error)
1547 ;; Assumes point is at beginning of filename,
1548 ;; thus the rwx bit re-search-backward below will succeed in *this*
1549 ;; line if at all. So, it should be called only after
1550 ;; (dired-move-to-filename t).
1551 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1552 ;; This is the UNIX version.
1553 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1554 ;; case-fold-search is nil now, so we can test for capital F:
1555 (setq used-F (string-match "F" dired-actual-switches)
1557 eol (save-excursion (end-of-line) (point))
1558 hidden (and selective-display
1559 (save-excursion (search-forward "\r" eol t))))
1562 (save-excursion;; Find out what kind of file this is:
1563 ;; Restrict perm bits to be non-blank,
1564 ;; otherwise this matches one char to early (looking backward):
1565 ;; "l---------" (some systems make symlinks that way)
1566 ;; "----------" (plain file with zero perms)
1567 (if (re-search-backward
1568 dired-permission-flags-regexp nil t)
1569 (setq file-type (char-after (match-beginning 1))
1570 symlink (eq file-type ?l)
1571 ;; Only with -F we need to know whether it's an executable
1575 "[xst]";; execute bit set anywhere?
1577 (buffer-substring (match-beginning 2)
1579 (buffer-substring (match-beginning 3)
1581 (buffer-substring (match-beginning 4)
1583 (or no-error (error "No file on this line"))))
1584 ;; Move point to end of name:
1586 (if (search-forward " ->" eol t)
1590 dired-ls-F-marks-symlinks
1591 (eq (preceding-char) ?@);; did ls really mark the link?
1592 (forward-char -1))))
1593 (goto-char eol);; else not a symbolic link
1594 ;; ls -lF marks dirs, sockets and executables with exactly one
1595 ;; trailing character. (Executable bits on symlinks ain't mean
1596 ;; a thing, even to ls, but we know it's not a symlink.)
1598 (or (memq file-type '(?d ?s))
1600 (forward-char -1))))
1602 (not (eq opoint (point)))
1604 (substitute-command-keys
1605 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1606 "No file on this line")))
1607 (if (eq opoint (point))
1612 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1614 (defun dired-copy-filename-as-kill (&optional arg)
1615 "Copy names of marked (or next ARG) files into the kill ring.
1616 The names are separated by a space.
1617 With a zero prefix arg, use the complete pathname of each marked file.
1618 With \\[universal-argument], use the relative pathname of each marked file.
1620 If on a subdir headerline, use subdirname instead; prefix arg is ignored
1623 You can then feed the file name(s) to other commands with \\[yank]."
1626 (or (dired-get-subdir)
1627 (mapconcat (function identity)
1629 (cond ((zerop (prefix-numeric-value arg))
1630 (dired-get-marked-files))
1632 (dired-get-marked-files 'no-dir arg))
1634 (dired-get-marked-files t)))
1635 (dired-get-marked-files 'no-dir))
1637 (if (eq last-command 'kill-region)
1638 (kill-append string nil)
1640 (message "%s" string)))
1643 ;; Keeping Dired buffers in sync with the filesystem and with each other
1645 (defun dired-buffers-for-dir (dir &optional file)
1646 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1647 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1649 ;; The list is in reverse order of buffer creation, most recent last.
1650 ;; As a side effect, killed dired buffers for DIR are removed from
1652 (setq dir (file-name-as-directory dir))
1653 (let ((alist dired-buffers) result elt buf pattern)
1655 (setq elt (car alist)
1657 (if (buffer-name buf)
1658 (if (dired-in-this-tree dir (car elt))
1659 (with-current-buffer buf
1660 (and (assoc dir dired-subdir-alist)
1663 (file-name-nondirectory dired-directory)))
1664 (or (= 0 (length wildcards))
1665 (string-match (dired-glob-regexp wildcards)
1667 (setq result (cons buf result)))))
1668 ;; else buffer is killed - clean up:
1669 (setq dired-buffers (delq elt dired-buffers)))
1670 (setq alist (cdr alist)))
1673 (defun dired-glob-regexp (pattern)
1674 "Convert glob-pattern PATTERN to a regular expression."
1675 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1677 (while (string-match "[[?*]" pattern matched-in-pattern)
1678 (let ((op-end (match-end 0))
1679 (next-op (aref pattern (match-beginning 0))))
1680 (setq regexp (concat regexp
1682 (substring pattern matched-in-pattern
1683 (match-beginning 0)))))
1684 (cond ((= next-op ??)
1685 (setq regexp (concat regexp "."))
1686 (setq matched-in-pattern op-end))
1688 ;; Fails to handle ^ yet ????
1689 (let* ((set-start (match-beginning 0))
1691 (if (= (aref pattern (1+ set-start)) ?^)
1694 (set-end (string-match "]" pattern set-cont))
1695 (set (substring pattern set-start (1+ set-end))))
1696 (setq regexp (concat regexp set))
1697 (setq matched-in-pattern (1+ set-end))))
1699 (setq regexp (concat regexp ".*"))
1700 (setq matched-in-pattern op-end)))))
1704 (substring pattern matched-in-pattern))
1709 (defun dired-advertise ()
1710 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1711 ;; With wildcards we actually advertise too much.
1712 (let ((expanded-default (expand-file-name default-directory)))
1713 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1714 t ; we have already advertised ourselves
1716 (cons (cons expanded-default (current-buffer))
1719 (defun dired-unadvertise (dir)
1720 ;; Remove DIR from the buffer alist in variable dired-buffers.
1721 ;; This has the effect of removing any buffer whose main directory is DIR.
1722 ;; It does not affect buffers in which DIR is a subdir.
1723 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1725 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
1729 ;;; utility functions
1731 (defun dired-in-this-tree (file dir)
1732 ;;"Is FILE part of the directory tree starting at DIR?"
1733 (let (case-fold-search)
1734 (string-match (concat "^" (regexp-quote dir)) file)))
1736 (defun dired-normalize-subdir (dir)
1737 ;; Prepend default-directory to DIR if relative path name.
1738 ;; dired-get-filename must be able to make a valid filename from a
1739 ;; file and its directory DIR.
1740 (file-name-as-directory
1741 (if (file-name-absolute-p dir)
1743 (expand-file-name dir default-directory))))
1745 (defun dired-get-subdir ()
1746 ;;"Return the subdir name on this line, or nil if not on a headerline."
1747 ;; Look up in the alist whether this is a headerline.
1749 (let ((cur-dir (dired-current-directory)))
1750 (beginning-of-line) ; alist stores b-o-l positions
1751 (and (zerop (- (point)
1752 (dired-get-subdir-min (assoc cur-dir
1753 dired-subdir-alist))))
1756 ;(defun dired-get-subdir-min (elt)
1758 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1759 (defalias 'dired-get-subdir-min 'cdr)
1761 (defun dired-get-subdir-max (elt)
1763 (goto-char (dired-get-subdir-min elt))
1764 (dired-subdir-max)))
1766 (defun dired-clear-alist ()
1767 (while dired-subdir-alist
1768 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1769 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1771 (defun dired-subdir-index (dir)
1772 ;; Return an index into alist for use with nth
1773 ;; for the sake of subdir moving commands.
1774 (let (found (index 0) (alist dired-subdir-alist))
1776 (if (string= dir (car (car alist)))
1777 (setq alist nil found t)
1778 (setq alist (cdr alist) index (1+ index))))
1779 (if found index nil)))
1781 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1782 "Go to next subdirectory, regardless of level."
1783 ;; Use 0 arg to go to this directory's header line.
1784 ;; NO-SKIP prevents moving to end of header line, returning whatever
1785 ;; position was found in dired-subdir-alist.
1787 (let ((this-dir (dired-current-directory))
1789 ;; nth with negative arg does not return nil but the first element
1790 (setq index (- (dired-subdir-index this-dir) arg))
1791 (setq pos (if (>= index 0)
1792 (dired-get-subdir-min (nth index dired-subdir-alist))))
1796 (or no-skip (skip-chars-forward "^\n\r"))
1798 (if no-error-if-not-found
1799 nil ; return nil if not found
1800 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1802 (defun dired-build-subdir-alist (&optional switches)
1803 "Build `dired-subdir-alist' by parsing the buffer.
1804 Returns the new value of the alist.
1805 If optional arg SWITCHES is non-nil, use its value
1806 instead of `dired-actual-switches'."
1811 (buffer-read-only nil)
1812 (switches (or switches dired-actual-switches))
1814 (R-ftp-base-dir-regex
1815 ;; Used to expand subdirectory names correctly in recursive
1816 ;; ange-ftp listings.
1817 (and (string-match "R" switches)
1818 (string-match "\\`/.*:\\(/.*\\)" default-directory)
1819 (concat "\\`" (match-string 1 default-directory)))))
1820 (goto-char (point-min))
1821 (setq dired-subdir-alist nil)
1822 (while (and (re-search-forward dired-subdir-regexp nil t)
1823 ;; Avoid taking a file name ending in a colon
1824 ;; as a subdir name.
1825 (not (save-excursion
1826 (goto-char (match-beginning 0))
1829 (save-match-data (looking-at dired-re-perms)))))
1831 (goto-char (match-beginning 1))
1833 (buffer-substring-no-properties (point) (match-end 1))
1836 (if (and R-ftp-base-dir-regex
1837 (not (string= new-dir-name default-directory))
1838 (string-match R-ftp-base-dir-regex new-dir-name))
1839 (concat default-directory
1840 (substring new-dir-name (match-end 0)))
1841 (expand-file-name new-dir-name))))
1842 (delete-region (point) (match-end 1))
1843 (insert new-dir-name))
1844 (setq count (1+ count))
1845 (dired-alist-add-1 new-dir-name
1846 ;; Place a sub directory boundary between lines.
1848 (goto-char (match-beginning 0))
1852 (message "Buffer includes %d directories" count))
1853 ;; We don't need to sort it because it is in buffer order per
1854 ;; constructionem. Return new alist:
1855 dired-subdir-alist)))
1857 (defun dired-alist-add-1 (dir new-marker)
1858 ;; Add new DIR at NEW-MARKER. Don't sort.
1859 (setq dired-subdir-alist
1860 (cons (cons (dired-normalize-subdir dir) new-marker)
1861 dired-subdir-alist)))
1863 (defun dired-goto-next-nontrivial-file ()
1864 ;; Position point on first nontrivial file after point.
1865 (dired-goto-next-file);; so there is a file to compare with
1866 (if (stringp dired-trivial-filenames)
1867 (while (and (not (eobp))
1868 (string-match dired-trivial-filenames
1869 (file-name-nondirectory
1870 (or (dired-get-filename nil t) ""))))
1872 (dired-move-to-filename))))
1874 (defun dired-goto-next-file ()
1875 (let ((max (1- (dired-subdir-max))))
1876 (while (and (not (dired-move-to-filename)) (< (point) max))
1879 (defun dired-goto-file (file)
1880 "Go to file line of FILE in this dired buffer."
1881 ;; Return value of point on success, else nil.
1882 ;; FILE must be an absolute pathname.
1883 ;; Loses if FILE contains control chars like "\007" for which ls
1884 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1885 ;; it in the buffer.
1887 (prog1 ; let push-mark display its message
1888 (list (expand-file-name
1889 (read-file-name "Goto file: "
1890 (dired-current-directory))))
1892 (setq file (directory-file-name file)) ; does no harm if no directory
1893 (let (found case-fold-search dir)
1894 (setq dir (or (file-name-directory file)
1895 (error "Need absolute pathname for %s" file)))
1897 ;; The hair here is to get the result of dired-goto-subdir
1898 ;; without really calling it if we don't have any subdirs.
1899 (if (if (string= dir (expand-file-name default-directory))
1900 (goto-char (point-min))
1901 (and (cdr dired-subdir-alist)
1902 (dired-goto-subdir dir)))
1903 (let ((base (file-name-nondirectory file))
1904 (boundary (dired-subdir-max)))
1905 (while (and (not found)
1906 ;; filenames are preceded by SPC, this makes
1907 ;; the search faster (e.g. for the filename "-"!).
1908 (search-forward (concat " " base) boundary 'move))
1909 ;; Match could have BASE just as initial substring or
1910 ;; or in permission bits or date or
1911 ;; not be a proper filename at all:
1912 (if (equal base (dired-get-filename 'no-dir t))
1913 ;; Must move to filename since an (actually
1914 ;; correct) match could have been elsewhere on the
1915 ;; ;; line (e.g. "-" would match somewhere in the
1916 ;; permission bits).
1917 (setq found (dired-move-to-filename))
1918 ;; If this isn't the right line, move forward to avoid
1919 ;; trying this line again.
1920 (forward-line 1))))))
1922 ;; return value of point (i.e., FOUND):
1923 (goto-char found))))
1925 (defun dired-initial-position (dirname)
1926 ;; Where point should go in a new listing of DIRNAME.
1927 ;; Point assumed at beginning of new subdir line.
1928 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1930 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1932 ;; These are hooks which make tree dired work.
1933 ;; They are in this file because other parts of dired need to call them.
1934 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
1936 ;; This function is called for each retrieved filename.
1937 ;; It could stand to be faster, though it's mostly function call
1938 ;; overhead. Avoiding the function call seems to save about 10% in
1939 ;; dired-get-filename. Make it a defsubst?
1940 (defun dired-current-directory (&optional localp)
1941 "Return the name of the subdirectory to which this line belongs.
1942 This returns a string with trailing slash, like `default-directory'.
1943 Optional argument means return a file name relative to `default-directory'."
1944 (let ((here (point))
1945 (alist (or dired-subdir-alist
1946 ;; probably because called in a non-dired buffer
1947 (error "No subdir-alist in %s" (current-buffer))))
1950 (setq elt (car alist)
1952 ;; use `<=' (not `<') as subdir line is part of subdir
1953 alist (if (<= (dired-get-subdir-min elt) here)
1957 (dired-make-relative dir default-directory)
1960 ;; Subdirs start at the beginning of their header lines and end just
1961 ;; before the beginning of the next header line (or end of buffer).
1963 (defun dired-subdir-max ()
1965 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
1971 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
1972 "*Decide whether recursive deletes are allowed.
1973 nil means no recursive deletes.
1974 `always' means delete recursively without asking. This is DANGEROUS!
1975 `top' means ask for each directory at top level, but delete its subdirectories
1977 Anything else means ask for each directory."
1978 :type '(choice :tag "Delete not empty directory"
1979 (const :tag "No. Only empty directories" nil)
1980 (const :tag "Ask for each directory" t)
1981 (const :tag "Ask for each top directory only" top))
1984 ;; Match anything but `.' and `..'.
1985 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
1987 ;; Delete file, possibly delete a directory and all its files.
1988 ;; This function is usefull outside of dired. One could change it's name
1989 ;; to e.g. recursive-delete-file and put it somewhere else.
1990 (defun dired-delete-file (file &optional recursive) "\
1991 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
1992 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
1994 `always', delete recursively without asking.
1995 `top', ask for each directory at top level.
1996 Anything else, ask for each sub-directory."
1998 ;; This test is equivalent to
1999 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2000 ;; but more efficient
2001 (if (not (eq t (car (file-attributes file))))
2003 (when (and recursive
2005 (directory-files file t dired-re-no-dot)) ; Not empty.
2006 (or (eq recursive 'always)
2007 (yes-or-no-p (format "Recursive delete of %s "
2008 (dired-make-relative file)))))
2009 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2010 (while files ; Recursively delete (possibly asking).
2011 (dired-delete-file (car files) recursive)
2012 (setq files (cdr files))))
2013 (delete-directory file))))
2015 (defun dired-do-flagged-delete (&optional nomessage)
2016 "In Dired, delete the files flagged for deletion.
2017 If NOMESSAGE is non-nil, we don't display any message
2018 if there are no flagged files."
2020 (let* ((dired-marker-char dired-del-marker)
2021 (regexp (dired-marker-regexp))
2023 (if (save-excursion (goto-char (point-min))
2024 (re-search-forward regexp nil t))
2025 (dired-internal-do-deletions
2026 ;; this can't move point since ARG is nil
2027 (dired-map-over-marks (cons (dired-get-filename) (point))
2031 (message "(No deletions requested)")))))
2033 (defun dired-do-delete (&optional arg)
2034 "Delete all marked (or next ARG) files."
2035 ;; This is more consistent with the file marking feature than
2036 ;; dired-do-flagged-delete.
2038 (dired-internal-do-deletions
2039 ;; this may move point if ARG is an integer
2040 (dired-map-over-marks (cons (dired-get-filename) (point))
2044 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2046 (defun dired-internal-do-deletions (l arg)
2047 ;; L is an alist of files to delete, with their buffer positions.
2048 ;; ARG is the prefix arg.
2049 ;; Filenames are absolute (VMS needs this for logical search paths).
2050 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2051 ;; That way as changes are made in the buffer they do not shift the
2052 ;; lines still to be changed, so the (point) values in L stay valid.
2053 ;; Also, for subdirs in natural order, a subdir's files are deleted
2054 ;; before the subdir itself - the other way around would not work.
2055 (let ((files (mapcar (function car) l))
2058 ;; canonicalize file list for pop up
2059 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2060 (if (dired-mark-pop-up
2061 " *Deletions*" 'delete files dired-deletion-confirmer
2062 (format "Delete %s " (dired-mark-prompt arg files)))
2064 (let (failures);; files better be in reverse order for this loop!
2066 (goto-char (cdr (car l)))
2067 (let (buffer-read-only)
2069 (let ((fn (car (car l))))
2070 (dired-delete-file fn dired-recursive-deletes)
2071 ;; if we get here, removing worked
2072 (setq succ (1+ succ))
2073 (message "%s of %s deletions" succ count)
2074 (delete-region (progn (beginning-of-line) (point))
2075 (progn (forward-line 1) (point)))
2076 (dired-clean-up-after-deletion fn))
2077 (error;; catch errors from failed deletions
2078 (dired-log "%s\n" err)
2079 (setq failures (cons (car (car l)) failures)))))
2082 (message "%d deletion%s done" count (dired-plural-s count))
2084 (format "%d of %d deletion%s failed"
2085 (length failures) count
2086 (dired-plural-s count))
2088 (message "(No deletions performed)")))
2089 (dired-move-to-filename))
2091 ;; This is a separate function for the sake of dired-x.el.
2092 (defun dired-clean-up-after-deletion (fn)
2093 ;; Clean up after a deleted file or directory FN.
2094 (save-excursion (and (cdr dired-subdir-alist)
2095 (dired-goto-subdir fn)
2096 (dired-kill-subdir))))
2100 (defun dired-marker-regexp ()
2101 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2103 (defun dired-plural-s (count)
2104 (if (= 1 count) "" "s"))
2106 (defun dired-mark-prompt (arg files)
2107 ;; Return a string for use in a prompt, either the current file
2108 ;; name, or the marker and a count of marked files.
2109 (let ((count (length files)))
2112 ;; more than 1 file:
2115 ;; Perhaps this is nicer, but it also takes more screen space:
2116 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2118 (format "[next %d files]" arg)
2119 (format "%c [%d files]" dired-marker-char count)))))
2121 (defun dired-pop-to-buffer (buf)
2122 ;; Pop up buffer BUF.
2123 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2124 (if (not dired-shrink-to-fit)
2125 (pop-to-buffer (get-buffer-create buf))
2126 ;; let window shrink to fit:
2127 (let ((window (selected-window))
2129 (cond ;; if split-window-threshold is enabled, use the largest window
2130 ((and (> (window-height (setq w2 (get-largest-window)))
2131 split-height-threshold)
2132 (= (frame-width) (window-width w2)))
2134 ;; if the least-recently-used window is big enough, use it
2135 ((and (> (window-height (setq w2 (get-lru-window)))
2136 (* 2 window-min-height))
2137 (= (frame-width) (window-width w2)))
2141 (goto-char (point-max))
2142 (skip-chars-backward "\n\r\t ")
2143 (setq target-lines (count-lines (point-min) (point)))
2144 ;; Don't forget to count the last line.
2146 (setq target-lines (1+ target-lines))))
2147 (if (<= (window-height window) (* 2 window-min-height))
2148 ;; At this point, every window on the frame is too small to split.
2149 (setq w2 (display-buffer buf))
2150 (setq w2 (split-window window
2151 (max window-min-height
2152 (- (window-height window)
2153 (1+ (max window-min-height target-lines)))))))
2154 (set-window-buffer w2 buf)
2155 (if (< (1- (window-height w2)) target-lines)
2158 (enlarge-window (- target-lines (1- (window-height w2))))))
2159 (set-window-start w2 1)
2162 (defvar dired-no-confirm nil
2163 "A list of symbols for commands dired should not confirm.
2164 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2165 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink' and
2168 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2169 "Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
2170 Return FUNCTION's result on ARGS after popping up a window (in a buffer
2171 named BUFNAME, nil gives \" *Marked Files*\") showing the marked
2172 files. Uses function `dired-pop-to-buffer' to do that.
2173 FUNCTION should not manipulate files.
2174 It should only read input (an argument or confirmation).
2175 The window is not shown if there is just one file or
2176 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2177 FILES is the list of marked files."
2178 (or bufname (setq bufname " *Marked Files*"))
2179 (if (or (eq dired-no-confirm t)
2180 (memq op-symbol dired-no-confirm)
2181 (= (length files) 1))
2182 (apply function args)
2183 (with-current-buffer (get-buffer-create bufname)
2185 (dired-format-columns-of-files files)
2186 (remove-text-properties (point-min) (point-max)
2187 '(mouse-face nil help-echo nil)))
2188 (save-window-excursion
2189 (dired-pop-to-buffer bufname)
2190 (apply function args))))
2192 (defun dired-format-columns-of-files (files)
2193 ;; Files should be in forward order for this loop.
2194 ;; i.e., (car files) = first file in buffer.
2195 ;; Returns the number of lines used.
2196 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2197 (width (- (window-width (selected-window)) 2))
2198 (columns (max 1 (/ width maxlen)))
2199 (nfiles (length files))
2200 (rows (+ (/ nfiles columns)
2201 (if (zerop (% nfiles columns)) 0 1)))
2204 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2205 (make-list (- (* columns rows) nfiles) "")))
2206 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2208 (while (< i columns)
2209 (indent-to (* i maxlen))
2210 (insert (car files))
2211 (setq files (nthcdr rows files)
2219 ;; Commands to mark or flag file(s) at or near current line.
2221 (defun dired-repeat-over-lines (arg function)
2222 ;; This version skips non-file lines.
2223 (let ((pos (make-marker)))
2225 (while (and (> arg 0) (not (eobp)))
2228 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2231 (move-marker pos (1+ (point))))
2232 (save-excursion (funcall function))
2233 ;; Advance to the next line--actually, to the line that *was* next.
2234 ;; (If FUNCTION inserted some new lines in between, skip them.)
2236 (while (and (< arg 0) (not (bobp)))
2239 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2241 (save-excursion (funcall function)))
2242 (move-marker pos nil)
2243 (dired-move-to-filename)))
2245 (defun dired-between-files ()
2246 ;; Point must be at beginning of line
2247 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
2248 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
2249 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard\\|^. used\\|^. find")
2250 (and (looking-at dired-subdir-regexp)
2251 (save-excursion (not (dired-move-to-filename))))))
2253 (defun dired-next-marked-file (arg &optional wrap opoint)
2254 "Move to the next marked file, wrapping around the end of the buffer."
2255 (interactive "p\np")
2256 (or opoint (setq opoint (point)));; return to where interactively started
2258 (re-search-forward dired-re-mark nil t arg)
2260 (re-search-backward dired-re-mark nil t (- arg)))
2261 (dired-move-to-filename)
2265 (error "No next marked file"))
2266 (message "(Wraparound for next marked file)")
2267 (goto-char (if (> arg 0) (point-min) (point-max)))
2268 (dired-next-marked-file arg nil opoint))))
2270 (defun dired-prev-marked-file (arg &optional wrap)
2271 "Move to the previous marked file, wrapping around the end of the buffer."
2272 (interactive "p\np")
2273 (dired-next-marked-file (- arg) wrap))
2275 (defun dired-file-marker (file)
2276 ;; Return FILE's marker, or nil if unmarked.
2278 (and (dired-goto-file file)
2281 (if (not (equal ?\040 (following-char)))
2282 (following-char))))))
2284 (defun dired-mark-files-in-region (start end)
2285 (let (buffer-read-only)
2287 (error "start > end"))
2288 (goto-char start) ; assumed at beginning of line
2289 (while (< (point) end)
2290 ;; Skip subdir line and following garbage like the `total' line:
2291 (while (and (< (point) end) (dired-between-files))
2293 (if (and (not (looking-at dired-re-dot))
2294 (dired-get-filename nil t))
2297 (insert dired-marker-char)))
2300 (defun dired-mark (arg)
2301 "Mark the current (or next ARG) files.
2302 If on a subdir headerline, mark all its files except `.' and `..'.
2304 Use \\[dired-unmark-all-files] to remove all marks
2305 and \\[dired-unmark] on a subdir to remove the marks in
2308 (if (dired-get-subdir)
2309 (save-excursion (dired-mark-subdir-files))
2310 (let (buffer-read-only)
2311 (dired-repeat-over-lines
2312 (prefix-numeric-value arg)
2313 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2315 (defun dired-unmark (arg)
2316 "Unmark the current (or next ARG) files.
2317 If looking at a subdir, unmark all its files except `.' and `..'."
2319 (let ((dired-marker-char ?\040))
2322 (defun dired-flag-file-deletion (arg)
2323 "In Dired, flag the current line's file for deletion.
2324 With prefix arg, repeat over several lines.
2326 If on a subdir headerline, mark all its files except `.' and `..'."
2328 (let ((dired-marker-char dired-del-marker))
2331 (defun dired-unmark-backward (arg)
2332 "In Dired, move up lines and remove deletion flag there.
2333 Optional prefix ARG says how many lines to unflag; default is one line."
2335 (dired-unmark (- arg)))
2337 (defun dired-do-toggle ()
2339 That is, currently marked files become unmarked and vice versa.
2340 Files marked with other flags (such as `D') are not affected.
2341 `.' and `..' are never toggled.
2342 As always, hidden subdirs are not affected."
2345 (goto-char (point-min))
2346 (let (buffer-read-only)
2348 (or (dired-between-files)
2349 (looking-at dired-re-dot)
2350 ;; use subst instead of insdel because it does not move
2351 ;; the gap and thus should be faster and because
2352 ;; other characters are left alone automatically
2353 (apply 'subst-char-in-region
2354 (point) (1+ (point))
2355 (if (eq ?\040 (following-char)) ; SPC
2356 (list ?\040 dired-marker-char)
2357 (list dired-marker-char ?\040))))
2358 (forward-line 1)))))
2360 ;;; Commands to mark or flag files based on their characteristics or names.
2362 (defvar dired-regexp-history nil
2363 "History list of regular expressions used in Dired commands.")
2365 (defun dired-read-regexp (prompt)
2366 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2368 (defun dired-mark-files-regexp (regexp &optional marker-char)
2369 "Mark all files matching REGEXP for use in later commands.
2370 A prefix argument means to unmark them instead.
2371 `.' and `..' are never marked.
2373 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2374 object files--just `.o' will mark more than you might think."
2376 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2377 " files (regexp): "))
2378 (if current-prefix-arg ?\040)))
2379 (let ((dired-marker-char (or marker-char dired-marker-char)))
2381 (and (not (looking-at dired-re-dot))
2382 (not (eolp)) ; empty line
2383 (let ((fn (dired-get-filename nil t)))
2384 (and fn (string-match regexp (file-name-nondirectory fn)))))
2387 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2388 "Mark all files with contents containing REGEXP for use in later commands.
2389 A prefix argument means to unmark them instead.
2390 `.' and `..' are never marked."
2392 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2393 " files containing (regexp): "))
2394 (if current-prefix-arg ?\040)))
2395 (let ((dired-marker-char (or marker-char dired-marker-char)))
2397 (and (not (looking-at dired-re-dot))
2398 (not (eolp)) ; empty line
2399 (let ((fn (dired-get-filename nil t)))
2400 (when (and fn (file-readable-p fn)
2401 (not (file-directory-p fn)))
2402 (let ((prebuf (get-file-buffer fn)))
2403 (message "Checking %s" fn)
2404 ;; For now we do it inside emacs
2405 ;; Grep might be better if there are a lot of files
2407 (with-current-buffer prebuf
2409 (goto-char (point-min))
2410 (re-search-forward regexp nil t)))
2412 (insert-file-contents fn)
2413 (goto-char (point-min))
2414 (re-search-forward regexp nil t))))
2418 (defun dired-flag-files-regexp (regexp)
2419 "In Dired, flag all files containing the specified REGEXP for deletion.
2420 The match is against the non-directory part of the filename. Use `^'
2421 and `$' to anchor matches. Exclude subdirs by hiding them.
2422 `.' and `..' are never flagged."
2423 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2424 (dired-mark-files-regexp regexp dired-del-marker))
2426 (defun dired-mark-symlinks (unflag-p)
2427 "Mark all symbolic links.
2428 With prefix argument, unflag all those files."
2430 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2431 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2433 (defun dired-mark-directories (unflag-p)
2434 "Mark all directory file lines except `.' and `..'.
2435 With prefix argument, unflag all those files."
2437 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2438 (dired-mark-if (and (looking-at dired-re-dir)
2439 (not (looking-at dired-re-dot)))
2442 (defun dired-mark-executables (unflag-p)
2443 "Mark all executable files.
2444 With prefix argument, unflag all those files."
2446 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2447 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2449 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2450 ;; files for which PREDICATE returns non-nil.
2452 (defun dired-flag-auto-save-files (&optional unflag-p)
2453 "Flag for deletion files whose names suggest they are auto save files.
2454 A prefix argument says to unflag those files instead."
2456 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2458 ;; It is less than general to check for # here,
2459 ;; but it's the only way this runs fast enough.
2460 (and (save-excursion (end-of-line)
2462 (eq (preceding-char) ?#)
2463 ;; Handle executables in case of -F option.
2464 ;; We need not worry about the other kinds
2465 ;; of markings that -F makes, since they won't
2466 ;; appear on real auto-save files.
2467 (if (eq (preceding-char) ?*)
2470 (eq (preceding-char) ?#)))))
2471 (not (looking-at dired-re-dir))
2472 (let ((fn (dired-get-filename t t)))
2473 (if fn (auto-save-file-name-p
2474 (file-name-nondirectory fn)))))
2477 (defvar dired-garbage-files-regexp
2478 "\\.log$\\|\\.toc$\\|\\.dvi$\\|\\.bak$\\|\\.orig$\\|\\.rej$"
2479 "*Regular expression to match \"garbage\" files for `dired-flag-garbage-files'.")
2481 (defun dired-flag-garbage-files ()
2482 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2484 (dired-flag-files-regexp dired-garbage-files-regexp))
2486 (defun dired-flag-backup-files (&optional unflag-p)
2487 "Flag all backup files (names ending with `~') for deletion.
2488 With prefix argument, unflag these files."
2490 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2492 ;; Don't call backup-file-name-p unless the last character looks like
2493 ;; it might be the end of a backup file name. This isn't very general,
2494 ;; but it's the only way this runs fast enough.
2495 (and (save-excursion (end-of-line)
2496 ;; Handle executables in case of -F option.
2497 ;; We need not worry about the other kinds
2498 ;; of markings that -F makes, since they won't
2499 ;; appear on real backup files.
2500 (if (eq (preceding-char) ?*)
2502 (eq (preceding-char) ?~))
2503 (not (looking-at dired-re-dir))
2504 (let ((fn (dired-get-filename t t)))
2505 (if fn (backup-file-name-p fn))))
2508 (defun dired-change-marks (&optional old new)
2509 "Change all OLD marks to NEW marks.
2510 OLD and NEW are both characters used to mark files."
2512 (let* ((cursor-in-echo-area t)
2513 (old (progn (message "Change (old mark): ") (read-char)))
2514 (new (progn (message "Change %c marks to (new mark): " old)
2517 (if (or (eq old ?\r) (eq new ?\r))
2519 (let ((string (format "\n%c" old))
2522 (goto-char (point-min))
2523 (while (search-forward string nil t)
2526 (dired-get-filename 'no-dir t))
2528 (subst-char-in-region (match-beginning 0)
2529 (match-end 0) old new)))))))
2531 (defun dired-unmark-all-marks ()
2532 "Remove all marks from all files in the Dired buffer."
2534 (dired-unmark-all-files ?\r))
2536 (defun dired-unmark-all-files (mark &optional arg)
2537 "Remove a specific mark (or any mark) from every file.
2538 After this command, type the mark character to remove,
2539 or type RET to remove all marks.
2540 With prefix arg, query for each marked file.
2541 Type \\[help-command] at that time for help."
2542 (interactive "cRemove marks (RET means all): \nP")
2545 buffer-read-only case-fold-search query
2546 (string (format "\n%c" mark))
2548 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2549 `!' to unmark all remaining files with no more questions."))
2550 (goto-char (point-min))
2551 (while (if (eq mark ?\r)
2552 (re-search-forward dired-re-mark nil t)
2553 (search-forward string nil t))
2555 (dired-query 'query "Unmark file `%s'? "
2556 (dired-get-filename t)))
2557 (progn (subst-char-in-region (1- (point)) (point)
2558 (preceding-char) ?\ )
2559 (setq count (1+ count)))))
2560 (message (if (= count 1) "1 mark removed"
2564 ;; Logging failures operating on files, and showing the results.
2566 (defvar dired-log-buffer "*Dired log*")
2569 "Pop up a buffer with error log output from Dired.
2570 A group of errors from a single command ends with a formfeed.
2571 Thus, use \\[backward-page] to find the beginning of a group of errors."
2573 (if (get-buffer dired-log-buffer)
2574 (let ((owindow (selected-window))
2575 (window (display-buffer (get-buffer dired-log-buffer))))
2578 (select-window window)
2579 (goto-char (point-max))
2581 (select-window owindow)))))
2583 (defun dired-log (log &rest args)
2584 ;; Log a message or the contents of a buffer.
2585 ;; If LOG is a string and there are more args, it is formatted with
2586 ;; those ARGS. Usually the LOG string ends with a \n.
2587 ;; End each bunch of errors with (dired-log t): this inserts
2588 ;; current time and buffer, and a \f (formfeed).
2589 (let ((obuf (current-buffer)))
2590 (unwind-protect ; want to move point
2592 (set-buffer (get-buffer-create dired-log-buffer))
2593 (goto-char (point-max))
2594 (let (buffer-read-only)
2595 (cond ((stringp log)
2597 (apply (function format) log args)
2600 (insert-buffer log))
2602 (insert "\n\t" (current-time-string)
2603 "\tBuffer `" (buffer-name obuf) "'\n\f\n")))))
2604 (set-buffer obuf))))
2606 (defun dired-log-summary (string failures)
2607 (message (if failures "%s--type ? for details (%s)"
2608 "%s--type ? for details")
2610 ;; Log a summary describing a bunch of errors.
2611 (dired-log (concat "\n" string))
2616 ;; Most ls can only sort by name or by date (with -t), nothing else.
2617 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2618 ;; So anything that does not contain these is sort "by name".
2620 (defvar dired-ls-sorting-switches "SXU"
2621 "String of `ls' switches (single letters) except `t' that influence sorting.")
2623 (defvar dired-sort-by-date-regexp
2624 (concat "^-[^" dired-ls-sorting-switches
2625 "]*t[^" dired-ls-sorting-switches "]*$")
2626 "Regexp recognized by dired to set `by date' mode.")
2628 (defvar dired-sort-by-name-regexp
2629 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2630 "Regexp recognized by dired to set `by name' mode.")
2632 (defun dired-sort-set-modeline ()
2633 ;; Set modeline display according to dired-actual-switches.
2634 ;; Modeline display of "by name" or "by date" guarantees the user a
2635 ;; match with the corresponding regexps. Non-matching switches are
2638 (let (case-fold-search)
2639 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2641 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2644 (concat "Dired " dired-actual-switches)))))
2645 (force-mode-line-update))
2647 (defun dired-sort-toggle-or-edit (&optional arg)
2648 "Toggle between sort by date/name and refresh the dired buffer.
2649 With a prefix argument you can edit the current listing switches instead."
2653 (read-string "ls switches (must contain -l): " dired-actual-switches))
2654 (dired-sort-toggle)))
2656 (defun dired-sort-toggle ()
2657 ;; Toggle between sort by date/name. Reverts the buffer.
2658 (setq dired-actual-switches
2659 (let (case-fold-search)
2660 (if (string-match " " dired-actual-switches)
2661 ;; New toggle scheme: add/remove a trailing " -t"
2662 (if (string-match " -t\\'" dired-actual-switches)
2663 (dired-replace-in-string " -t\\'" "" dired-actual-switches)
2664 (concat dired-actual-switches " -t"))
2665 ;; old toggle scheme: look for some 't' switch and add/remove it
2668 (dired-replace-in-string (concat "[-lt"
2669 dired-ls-sorting-switches "]")
2671 dired-actual-switches)
2672 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2673 dired-actual-switches)
2676 (dired-sort-set-modeline)
2679 ;; Some user code loads dired especially for this.
2680 ;; Don't do that--use replace-regexp-in-string instead.
2681 (defun dired-replace-in-string (regexp newtext string)
2682 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2683 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2684 (let ((result "") (start 0) mb me)
2685 (while (string-match regexp string start)
2686 (setq mb (match-beginning 0)
2688 result (concat result (substring string start mb) newtext)
2690 (concat result (substring string start))))
2692 (defun dired-sort-other (switches &optional no-revert)
2693 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2694 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2695 ;; minor mode accordingly, others appear literally in the mode line.
2696 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2697 (dired-sort-R-check switches)
2698 (setq dired-actual-switches switches)
2699 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
2700 (or no-revert (revert-buffer)))
2702 (make-variable-buffer-local
2703 (defvar dired-subdir-alist-pre-R nil
2704 "Value of `dired-subdir-alist' before -R switch added."))
2706 (defun dired-sort-R-check (switches)
2707 "Additional processing of -R in ls option string SWITCHES.
2708 Saves `dired-subdir-alist' when R is set and restores saved value
2709 minus any directories explicitly deleted when R is cleared.
2710 To be called first in body of `dired-sort-other', etc."
2712 ((and (string-match "R" switches)
2713 (not (string-match "R" dired-actual-switches)))
2714 ;; Adding -R to ls switches -- save `dired-subdir-alist':
2715 (setq dired-subdir-alist-pre-R dired-subdir-alist))
2716 ((and (string-match "R" dired-actual-switches)
2717 (not (string-match "R" switches)))
2718 ;; Deleting -R from ls switches -- revert to pre-R subdirs
2719 ;; that are still present:
2720 (setq dired-subdir-alist
2721 (if dired-subdir-alist-pre-R
2723 (while dired-subdir-alist-pre-R
2724 (if (assoc (caar dired-subdir-alist-pre-R)
2726 ;; subdir still present...
2728 (cons (car dired-subdir-alist-pre-R)
2730 (setq dired-subdir-alist-pre-R
2731 (cdr dired-subdir-alist-pre-R)))
2733 ;; No pre-R subdir alist, so revert to main directory
2735 (list (car (reverse dired-subdir-alist))))))))
2737 ;; To make this file smaller, the less common commands
2738 ;; go in a separate file. But autoload them here
2739 ;; to make the separation invisible.
2741 (autoload 'dired-diff "dired-aux"
2742 "Compare file at point with file FILE using `diff'.
2743 FILE defaults to the file at the mark. (That's the mark set by
2744 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
2745 The prompted-for file is the first file given to `diff'."
2748 (autoload 'dired-backup-diff "dired-aux"
2749 "Diff this file with its backup file or vice versa.
2750 Uses the latest backup, if there are several numerical backups.
2751 If this file is a backup, diff it with its original.
2752 The backup file is the first file given to `diff'."
2755 (autoload 'dired-clean-directory "dired-aux"
2756 "Flag numerical backups for deletion.
2757 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2758 Positive prefix arg KEEP overrides `dired-kept-versions';
2759 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2761 To clear the flags on these files, you can use \\[dired-flag-backup-files]
2762 with a prefix argument."
2765 (autoload 'dired-do-chmod "dired-aux"
2766 "Change the mode of the marked (or next ARG) files.
2767 This calls chmod, thus symbolic modes like `g+w' are allowed."
2770 (autoload 'dired-do-chgrp "dired-aux"
2771 "Change the group of the marked (or next ARG) files."
2774 (autoload 'dired-do-chown "dired-aux"
2775 "Change the owner of the marked (or next ARG) files."
2778 (autoload 'dired-do-print "dired-aux"
2779 "Print the marked (or next ARG) files.
2780 Uses the shell command coming from variables `lpr-command' and
2781 `lpr-switches' as default."
2784 (autoload 'dired-do-shell-command "dired-aux"
2785 "Run a shell command COMMAND on the marked files.
2786 If no files are marked or a specific numeric prefix arg is given,
2787 the next ARG files are used. Just \\[universal-argument] means the current file.
2788 The prompt mentions the file(s) or the marker, as appropriate.
2790 If there is output, it goes to a separate buffer.
2792 Normally the command is run on each file individually.
2793 However, if there is a `*' in the command then it is run
2794 just once with the entire file list substituted there.
2796 No automatic redisplay of dired buffers is attempted, as there's no
2797 telling what files the command may have changed. Type
2798 \\[dired-do-redisplay] to redisplay the marked files.
2800 The shell command has the top level directory as working directory, so
2801 output files usually are created there instead of in a subdir."
2804 (autoload 'dired-do-kill-lines "dired-aux"
2805 "Kill all marked lines (not the files).
2806 With a prefix arg, kill all lines not marked or flagged."
2809 (autoload 'dired-do-compress "dired-aux"
2810 "Compress or uncompress marked (or next ARG) files."
2813 (autoload 'dired-do-byte-compile "dired-aux"
2814 "Byte compile marked (or next ARG) Emacs Lisp files."
2817 (autoload 'dired-do-load "dired-aux"
2818 "Load the marked (or next ARG) Emacs Lisp files."
2821 (autoload 'dired-do-redisplay "dired-aux"
2822 "Redisplay all marked (or next ARG) files.
2823 If on a subdir line, redisplay that subdirectory. In that case,
2824 a prefix arg lets you edit the `ls' switches used for the new listing."
2827 (autoload 'dired-create-directory "dired-aux"
2828 "Create a directory called DIRECTORY."
2831 (autoload 'dired-do-copy "dired-aux"
2832 "Copy all marked (or next ARG) files, or copy the current file.
2833 Thus, a zero prefix argument copies nothing. But it toggles the
2834 variable `dired-copy-preserve-time' (which see)."
2837 (autoload 'dired-do-symlink "dired-aux"
2838 "Make symbolic links to current file or all marked (or next ARG) files.
2839 When operating on just the current file, you specify the new name.
2840 When operating on multiple or marked files, you specify a directory
2841 and new symbolic links are made in that directory
2842 with the same names that the files currently have."
2845 (autoload 'dired-do-hardlink "dired-aux"
2846 "Add names (hard links) current file or all marked (or next ARG) files.
2847 When operating on just the current file, you specify the new name.
2848 When operating on multiple or marked files, you specify a directory
2849 and new hard links are made in that directory
2850 with the same names that the files currently have."
2853 (autoload 'dired-do-rename "dired-aux"
2854 "Rename current file or all marked (or next ARG) files.
2855 When renaming just the current file, you specify the new name.
2856 When renaming multiple or marked files, you specify a directory."
2859 (autoload 'dired-do-rename-regexp "dired-aux"
2860 "Rename marked files containing REGEXP to NEWNAME.
2861 As each match is found, the user must type a character saying
2862 what to do with it. For directions, type \\[help-command] at that time.
2863 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2864 REGEXP defaults to the last regexp used.
2865 With a zero prefix arg, renaming by regexp affects the complete
2866 pathname - usually only the non-directory part of file names is used
2870 (autoload 'dired-do-copy-regexp "dired-aux"
2871 "Copy all marked files containing REGEXP to NEWNAME.
2872 See function `dired-do-rename-regexp' for more info."
2875 (autoload 'dired-do-hardlink-regexp "dired-aux"
2876 "Hardlink all marked files containing REGEXP to NEWNAME.
2877 See function `dired-do-rename-regexp' for more info."
2880 (autoload 'dired-do-symlink-regexp "dired-aux"
2881 "Symlink all marked files containing REGEXP to NEWNAME.
2882 See function `dired-do-rename-regexp' for more info."
2885 (autoload 'dired-upcase "dired-aux"
2886 "Rename all marked (or next ARG) files to upper case."
2889 (autoload 'dired-downcase "dired-aux"
2890 "Rename all marked (or next ARG) files to lower case."
2893 (autoload 'dired-maybe-insert-subdir "dired-aux"
2894 "Insert this subdirectory into the same dired buffer.
2895 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2896 else inserts it at its natural place (as `ls -lR' would have done).
2897 With a prefix arg, you may edit the ls switches used for this listing.
2898 You can add `R' to the switches to expand the whole tree starting at
2900 This function takes some pains to conform to `ls -lR' output."
2903 (autoload 'dired-next-subdir "dired-aux"
2904 "Go to next subdirectory, regardless of level."
2907 (autoload 'dired-prev-subdir "dired-aux"
2908 "Go to previous subdirectory, regardless of level.
2909 When called interactively and not on a subdir line, go to this subdir's line."
2912 (autoload 'dired-goto-subdir "dired-aux"
2913 "Go to end of header line of DIR in this dired buffer.
2914 Return value of point on success, otherwise return nil.
2915 The next char is either \\n, or \\r if DIR is hidden."
2918 (autoload 'dired-mark-subdir-files "dired-aux"
2919 "Mark all files except `.' and `..'."
2922 (autoload 'dired-kill-subdir "dired-aux"
2923 "Remove all lines of current subdirectory.
2924 Lower levels are unaffected."
2927 (autoload 'dired-tree-up "dired-aux"
2928 "Go up ARG levels in the dired tree."
2931 (autoload 'dired-tree-down "dired-aux"
2932 "Go down in the dired tree."
2935 (autoload 'dired-hide-subdir "dired-aux"
2936 "Hide or unhide the current subdirectory and move to next directory.
2937 Optional prefix arg is a repeat factor.
2938 Use \\[dired-hide-all] to (un)hide all directories."
2941 (autoload 'dired-hide-all "dired-aux"
2942 "Hide all subdirectories, leaving only their header lines.
2943 If there is already something hidden, make everything visible again.
2944 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2947 (autoload 'dired-show-file-type "dired-aux"
2948 "Print the type of FILE, according to the `file' command.
2949 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2950 true then the type of the file linked to by FILE is printed instead."
2953 (if (eq system-type 'vax-vms)
2958 (run-hooks 'dired-load-hook) ; for your customizations
2960 ;;; dired.el ends here