1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993 Free Software Foundation, Inc.
5 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;; This is a major mode for directory browsing and editing. It is
27 ;; documented in the Emacs manual.
29 ;; Rewritten in 1990/1991 to add tree features, file marking and
30 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
31 ;; Finished up by rms in 1992.
35 ;;; Customizable variables
38 (defvar dired-listing-switches
"-al"
39 "*Switches passed to `ls' for dired. MUST contain the `l' option.
40 May contain all other options that don't contradict `-l';
41 may contain even `F', `b', `i' and `s'.")
43 ; Don't use absolute paths as /bin should be in any PATH and people
44 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
45 ; usually not in PATH.
48 (defvar dired-chown-program
49 (if (memq system-type
'(hpux dgux usg-unix-v irix
))
51 "Name of chown command (usually `chown' or `/etc/chown').")
54 (defvar dired-ls-F-marks-symlinks nil
55 "*Informs dired about how `ls -lF' marks symbolic links.
56 Set this to t if `insert-directory-program' with `-lF' marks the symbolic link
57 itself with a trailing @ (usually the case under Ultrix).
59 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
60 nil (the default), if it gives `bar@ -> foo', set it to t.
62 Dired checks if there is really a @ appended. Thus, if you have a
63 marking `ls' program on one host and a non-marking on another host, and
64 don't care about symbolic links which really end in a @, you can
65 always set this variable to t.")
68 (defvar dired-trivial-filenames
"^\\.\\.?$\\|^#"
69 "*Regexp of files to skip when finding first file of a directory.
70 A value of nil means move to the subdir line.
71 A value of t means move to first file.")
74 (defvar dired-keep-marker-rename t
75 ;; Use t as default so that moved files "take their markers with them".
76 "*Controls marking of renamed files.
77 If t, files keep their previous marks when they are renamed.
78 If a character, renamed files (whether previously marked or not)
79 are afterward marked with that character.")
82 (defvar dired-keep-marker-copy ?C
83 "*Controls marking of copied files.
84 If t, copied files are marked if and as the corresponding original files were.
85 If a character, copied files are unconditionally marked with that character.")
88 (defvar dired-keep-marker-hardlink ?H
89 "*Controls marking of newly made hard links.
90 If t, they are marked if and as the files linked to were marked.
91 If a character, new links are unconditionally marked with that character.")
94 (defvar dired-keep-marker-symlink ?Y
95 "*Controls marking of newly made symbolic links.
96 If t, they are marked if and as the files linked to were marked.
97 If a character, new links are unconditionally marked with that character.")
100 (defvar dired-dwim-target nil
101 "*If non-nil, dired tries to guess a default target directory.
102 This means: if there is a dired buffer displayed in the next window,
103 use its current subdir, instead of the current subdir of this dired buffer.
105 The target is used in the prompt for file copy, rename etc.")
108 (defvar dired-copy-preserve-time t
109 "*If non-nil, Dired preserves the last-modified time in a file copy.
110 \(This works on only some systems.)")
114 (defvar dired-load-hook nil
115 "Run after loading dired.
116 You can customize key bindings or load extensions with this.")
118 (defvar dired-mode-hook nil
119 "Run at the very end of dired-mode.")
121 (defvar dired-before-readin-hook nil
122 "This hook is run before a dired buffer is read in (created or reverted).")
124 (defvar dired-after-readin-hook nil
125 "Hook run after each time a file or directory is read by Dired.
126 After each listing of a file or directory, this hook is run
127 with the buffer narrowed to the listing.")
128 ;; Note this can't simply be run inside function `dired-ls' as the hook
129 ;; functions probably depend on the dired-subdir-alist to be OK.
131 ;;; Internal variables
133 (defvar dired-marker-char ?
* ; the answer is 42
134 ;; so that you can write things like
135 ;; (let ((dired-marker-char ?X))
136 ;; ;; great code using X markers ...
138 ;; For example, commands operating on two sets of files, A and B.
139 ;; Or marking files with digits 0-9. This could implicate
140 ;; concentric sets or an order for the marked files.
141 ;; The code depends on dynamic scoping on the marker char.
142 "In Dired, the current mark character.
143 This is what the `do' commands look for and what the `mark' commands store.")
145 (defvar dired-del-marker ?D
146 "Character used to flag files for deletion.")
148 (defvar dired-shrink-to-fit
150 ;; I see no reason ever to make this nil -- rms.
151 ;; (> baud-rate search-slow-speed)
152 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
154 (defvar dired-flagging-regexp nil
);; Last regexp used to flag files.
156 (defvar dired-file-version-alist
)
158 (defvar dired-directory nil
159 "The directory name or shell wildcard that was used as argument to `ls'.
160 Local to each dired buffer. May be a list, in which case the car is the
161 directory name and the cdr is the actual files to list.")
163 (defvar dired-actual-switches nil
164 "The value of `dired-listing-switches' used to make this buffer's text.")
166 (defvar dired-re-inode-size
"[0-9 \t]*"
167 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
169 ;; These regexps must be tested at beginning-of-line, but are also
170 ;; used to search for next matches, so neither omitting "^" nor
171 ;; replacing "^" by "\n" (to make it slightly faster) will work.
173 (defvar dired-re-mark
"^[^ \n]")
174 ;; "Regexp matching a marked line.
175 ;; Important: the match ends just after the marker."
176 (defvar dired-re-maybe-mark
"^. ")
177 (defvar dired-re-dir
(concat dired-re-maybe-mark dired-re-inode-size
"d"))
178 (defvar dired-re-sym
(concat dired-re-maybe-mark dired-re-inode-size
"l"))
179 (defvar dired-re-exe
;; match ls permission string of an executable file
182 (concat dired-re-maybe-mark dired-re-inode-size x
)))
183 '("-[-r][-w][xs][-r][-w].[-r][-w]."
184 "-[-r][-w].[-r][-w][xs][-r][-w]."
185 "-[-r][-w].[-r][-w].[-r][-w][xst]")
187 (defvar dired-re-dot
"^.* \\.\\.?$")
189 (defvar dired-subdir-alist nil
190 "Association list of subdirectories and their buffer positions.
191 Each subdirectory has an element: (DIRNAME . STARTMARKER).
192 The order of elements is the reverse of the order in the buffer.
193 In simple cases, this list contains one element.")
195 (defvar dired-subdir-regexp
"^. \\([^ \n\r]+\\)\\(:\\)[\n\r]"
196 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
197 Subexpression 1 is the subdirectory proper, no trailing colon.
198 The match starts at the beginning of the line and ends after the end
199 of the line (\\n or \\r).
200 Subexpression 2 must end right before the \\n or \\r.")
203 ;;; Macros must be defined before they are used, for the byte compiler.
205 ;; Mark all files for which CONDITION evals to non-nil.
206 ;; CONDITION is evaluated on each line, with point at beginning of line.
207 ;; MSG is a noun phrase for the type of files being marked.
208 ;; It should end with a noun that can be pluralized by adding `s'.
209 ;; Return value is the number of files marked, or nil if none were marked.
210 (defmacro dired-mark-if
(predicate msg
)
211 (` (let (buffer-read-only count
)
214 (if (, msg
) (message "Marking %ss..." (, msg
)))
215 (goto-char (point-min))
220 (insert dired-marker-char
)
221 (setq count
(1+ count
))))
223 (if (, msg
) (message "%s %s%s %s%s."
226 (dired-plural-s count
)
227 (if (eq dired-marker-char ?
\040) "un" "")
228 (if (eq dired-marker-char dired-del-marker
)
229 "flagged" "marked"))))
230 (and (> count
0) count
))))
232 (defmacro dired-map-over-marks
(body arg
&optional show-progress
)
233 ;; "Macro: Perform BODY with point somewhere on each marked line
234 ;;and return a list of BODY's results.
235 ;;If no marked file could be found, execute BODY on the current line.
236 ;; If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
237 ;; files instead of the marked files.
238 ;; In that case point is dragged along. This is so that commands on
239 ;; the next ARG (instead of the marked) files can be chained easily.
240 ;; If ARG is otherwise non-nil, use current file instead.
241 ;;If optional third arg SHOW-PROGRESS evaluates to non-nil,
242 ;; redisplay the dired buffer after each file is processed.
243 ;;No guarantee is made about the position on the marked line.
244 ;; BODY must ensure this itself if it depends on this.
245 ;;Search starts at the beginning of the buffer, thus the car of the list
246 ;; corresponds to the line nearest to the buffer's bottom. This
247 ;; is also true for (positive and negative) integer values of ARG.
248 ;;BODY should not be too long as it is expanded four times."
250 ;;Warning: BODY must not add new lines before point - this may cause an
252 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
254 (let (buffer-read-only case-fold-search found results
)
256 (if (integerp (, arg
))
257 (progn;; no save-excursion, want to move point.
258 (dired-repeat-over-lines
261 (if (, show-progress
) (sit-for 0))
262 (setq results
(cons (, body
) results
)))))
266 ;; non-nil, non-integer ARG means use current file:
268 (let ((regexp (dired-marker-regexp)) next-position
)
270 (goto-char (point-min))
271 ;; remember position of next marked file before BODY
272 ;; can insert lines before the just found file,
273 ;; confusing us by finding the same marked file again
275 (setq next-position
(and (re-search-forward regexp nil t
)
277 found
(not (null next-position
)))
279 (goto-char next-position
)
280 (if (, show-progress
) (sit-for 0))
281 (setq results
(cons (, body
) results
))
282 ;; move after last match
283 (goto-char next-position
)
285 (set-marker next-position nil
)
286 (setq next-position
(and (re-search-forward regexp nil t
)
291 ;; save-excursion loses, again
292 (dired-move-to-filename))))
294 (defun dired-get-marked-files (&optional localp arg
)
295 "Return the marked files' names as list of strings.
296 The list is in the same order as the buffer, that is, the car is the
298 Values returned are normally absolute pathnames.
299 Optional arg LOCALP as in `dired-get-filename'.
300 Optional second argument ARG forces to use other files. If ARG is an
301 integer, use the next ARG files. If ARG is otherwise non-nil, use
302 current file. Usually ARG comes from the current prefix arg."
304 (nreverse (dired-map-over-marks (dired-get-filename localp
) arg
))))
307 ;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
308 ;; other special applications.
312 (defun dired-read-dir-and-switches (str)
313 ;; For use in interactive.
315 (if current-prefix-arg
316 (read-string "Dired listing switches: "
317 dired-listing-switches
))
318 (read-file-name (format "Dired %s(directory): " str
)
319 nil default-directory nil
))))
321 ;;;###autoload (define-key ctl-x-map "d" 'dired)
323 (defun dired (dirname &optional switches
)
324 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
325 Optional second argument SWITCHES specifies the `ls' options used.
326 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
327 Dired displays a list of files in DIRNAME (which may also have
328 shell wildcards appended to select certain files). If DIRNAME is a cons,
329 its first element is taken as the directory name and the resr as an explicit
330 list of files to make directory entries for.
332 You can move around in it with the usual commands.
333 You can flag files for deletion with \\[dired-flag-file-deletion] and then
334 delete them by typing \\[dired-do-flagged-delete].
335 Type \\[describe-mode] after entering dired for more info.
337 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
338 ;; Cannot use (interactive "D") because of wildcards.
339 (interactive (dired-read-dir-and-switches ""))
340 (switch-to-buffer (dired-noselect dirname switches
)))
342 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
344 (defun dired-other-window (dirname &optional switches
)
345 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
346 (interactive (dired-read-dir-and-switches "in other window "))
347 (switch-to-buffer-other-window (dired-noselect dirname switches
)))
349 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
351 (defun dired-other-frame (dirname &optional switches
)
352 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
353 (interactive (dired-read-dir-and-switches "in other frame "))
354 (switch-to-buffer-other-frame (dired-noselect dirname switches
)))
357 (defun dired-noselect (dir-or-list &optional switches
)
358 "Like `dired' but returns the dired buffer as value, does not select it."
359 (or dir-or-list
(setq dir-or-list default-directory
))
360 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
363 (if (consp dir-or-list
)
364 (setq dirname
(car dir-or-list
))
365 (setq dirname dir-or-list
))
366 (setq dirname
(expand-file-name (directory-file-name dirname
)))
367 (if (file-directory-p dirname
)
368 (setq dirname
(file-name-as-directory dirname
)))
369 (if (consp dir-or-list
)
370 (setq dir-or-list
(cons dirname
(cdr dir-or-list
)))
371 (setq dir-or-list dirname
))
372 (dired-internal-noselect dir-or-list switches
)))
374 ;; Separate function from dired-noselect for the sake of dired-vms.el.
375 (defun dired-internal-noselect (dir-or-list &optional switches
)
376 ;; If there is an existing dired buffer for DIRNAME, just leave
377 ;; buffer as it is (don't even call dired-revert).
378 ;; This saves time especially for deep trees or with ange-ftp.
379 ;; The user can type `g'easily, and it is more consistent with find-file.
380 ;; But if SWITCHES are given they are probably different from the
381 ;; buffer's old value, so call dired-sort-other, which does
382 ;; revert the buffer.
383 ;; A pity we can't possibly do "Directory has changed - refresh? "
384 ;; like find-file does.
385 (let* ((dirname (if (consp dir-or-list
) (car dir-or-list
) dir-or-list
))
386 (buffer (dired-find-buffer-nocreate dir-or-list
))
387 ;; note that buffer already is in dired-mode, if found
388 (new-buffer-p (not buffer
))
389 (old-buf (current-buffer)))
391 (let ((default-major-mode 'fundamental-mode
))
392 ;; We don't want default-major-mode to run hooks and set auto-fill
393 ;; or whatever, now that dired-mode does not
394 ;; kill-all-local-variables any longer.
395 (setq buffer
(create-file-buffer (directory-file-name dirname
)))))
397 (if (not new-buffer-p
) ; existing buffer ...
398 (if switches
; ... but new switches
399 (dired-sort-other switches
)) ; this calls dired-revert
401 (setq default-directory
402 (abbreviate-file-name
403 (if (file-directory-p dirname
)
405 (file-name-directory dirname
))))
406 (or switches
(setq switches dired-listing-switches
))
407 (dired-mode dirname switches
)
408 ;; default-directory and dired-actual-switches are set now
409 ;; (buffer-local), so we can call dired-readin:
412 (progn (dired-readin dir-or-list buffer
)
414 ;; dired-readin can fail if parent directories are inaccessible.
415 ;; Don't leave an empty buffer around in that case.
416 (if failed
(kill-buffer buffer
))))
417 ;; No need to narrow since the whole buffer contains just
418 ;; dired-readin's output, nothing else. The hook can
419 ;; successfully use dired functions (e.g. dired-get-filename)
420 ;; as the subdir-alist has been built in dired-readin.
421 (run-hooks 'dired-after-readin-hook
)
422 (goto-char (point-min))
423 (dired-initial-position dirname
))
427 ;; This differs from dired-buffers-for-dir in that it does not consider
428 ;; subdirs of default-directory and searches for the first match only
429 (defun dired-find-buffer-nocreate (dirname)
430 (let (found (blist (buffer-list)))
433 (set-buffer (car blist
))
434 (if (and (eq major-mode
'dired-mode
)
435 (equal dired-directory dirname
))
436 (setq found
(car blist
)
438 (setq blist
(cdr blist
)))))
442 ;; Read in a new dired buffer
444 ;; dired-readin differs from dired-insert-subdir in that it accepts
445 ;; wildcards, erases the buffer, and builds the subdir-alist anew
446 ;; (including making it buffer-local and clearing it first).
447 (defun dired-readin (dir-or-list buffer
)
448 ;; default-directory and dired-actual-switches must be buffer-local
449 ;; and initialized by now.
450 ;; Thus we can test (equal default-directory dirname) instead of
451 ;; (file-directory-p dirname) and save a filesystem transaction.
452 ;; Also, we can run this hook which may want to modify the switches
453 ;; based on default-directory, e.g. with ange-ftp to a SysV host
454 ;; where ls won't understand -Al switches.
456 (if (consp dir-or-list
)
457 (setq dirname
(car dir-or-list
))
458 (setq dirname dir-or-list
))
459 (setq dirname
(expand-file-name dirname
))
460 (if (consp dir-or-list
)
461 (setq dir-or-list
(cons dirname
(cdr dir-or-list
))))
462 (run-hooks 'dired-before-readin-hook
)
464 (message "Reading directory %s..." dirname
)
466 (let (buffer-read-only (failed t
))
469 (dired-readin-insert dir-or-list
)
470 (indent-rigidly (point-min) (point-max) 2)
471 ;; We need this to make the root dir have a header line as all
472 ;; other subdirs have:
473 (goto-char (point-min))
474 (dired-insert-headerline default-directory
)
475 ;; can't run dired-after-readin-hook here, it may depend on the subdir
478 (message "Reading directory %s...done" dirname
)
479 (set-buffer-modified-p nil
)
480 ;; Must first make alist buffer local and set it to nil because
481 ;; dired-build-subdir-alist will call dired-clear-alist first
482 (set (make-local-variable 'dired-subdir-alist
) nil
)
483 (dired-build-subdir-alist))))
485 ;; Subroutines of dired-readin
487 (defun dired-readin-insert (dir-or-list)
488 ;; Just insert listing for the passed-in directory or
489 ;; directory-and-file list, assuming a clean buffer.
491 (if (consp dir-or-list
)
492 (setq dirname
(car dir-or-list
))
493 (setq dirname dir-or-list
))
494 ;; Expand before comparing in case one or both have been abbreviated.
495 (if (and (equal (expand-file-name default-directory
)
496 (expand-file-name dirname
))
497 (not (consp dir-or-list
)))
498 ;; If we are reading a whole single directory...
499 (dired-insert-directory dir-or-list dired-actual-switches nil t
)
500 (if (not (file-readable-p
501 (directory-file-name (file-name-directory dirname
))))
502 (error "Directory %s inaccessible or nonexistent" dirname
)
503 ;; Else assume it contains wildcards,
504 ;; unless it is an explicit list of files.
505 (dired-insert-directory dir-or-list dired-actual-switches
506 (not (listp dir-or-list
)))
507 (save-excursion ;; insert wildcard instead of total line:
508 (goto-char (point-min))
509 (insert "wildcard " (file-name-nondirectory dirname
) "\n"))))))
511 (defun dired-insert-directory (dir-or-list switches
&optional wildcard full-p
)
512 ;; Do the right thing whether dir-or-list is atomic or not. If it is,
513 ;; inset all files listed in the cdr (the car is the passed-in directory
515 (if (consp dir-or-list
)
518 (function (lambda (x) (insert-directory x switches wildcard full-p
)))
520 (insert-directory dir-or-list switches wildcard full-p
))
521 (setq dired-directory dir-or-list
))
523 (defun dired-insert-headerline (dir);; also used by dired-insert-subdir
524 ;; Insert DIR's headerline with no trailing slash, exactly like ls
525 ;; would, and put cursor where dired-build-subdir-alist puts subdir
527 (save-excursion (insert " " (directory-file-name dir
) ":\n")))
530 ;; Reverting a dired buffer
532 (defun dired-revert (&optional arg noconfirm
)
533 ;; Reread the dired buffer. Must also be called after
534 ;; dired-actual-switches have changed.
535 ;; Should not fail even on completely garbaged buffers.
536 ;; Preserves old cursor, marks/flags, hidden-p.
537 (widen) ; just in case user narrowed
538 (let ((opoint (point))
539 (ofile (dired-get-filename nil t
))
540 (mark-alist nil
) ; save marked files
541 (hidden-subdirs (dired-remember-hidden))
542 (old-subdir-alist (cdr (reverse dired-subdir-alist
))) ; except pwd
543 (case-fold-search nil
) ; we check for upper case ls flags
545 (goto-char (point-min))
546 (setq mark-alist
;; only after dired-remember-hidden since this unhides:
547 (dired-remember-marks (point-min) (point-max)))
548 ;; treat top level dir extra (it may contain wildcards)
550 (if (consp dired-directory
) (car dired-directory
) dired-directory
))
551 (dired-readin dired-directory
(current-buffer))
552 (let ((dired-after-readin-hook nil
))
553 ;; don't run that hook for each subdir...
554 (dired-insert-old-subdirs old-subdir-alist
))
555 (dired-mark-remembered mark-alist
) ; mark files that were marked
556 ;; ... run the hook for the whole buffer, and only after markers
557 ;; have been reinserted (else omitting in dired-x would omit marked files)
558 (run-hooks 'dired-after-readin-hook
) ; no need to narrow
559 (or (and ofile
(dired-goto-file ofile
)) ; move cursor to where it
560 (goto-char opoint
)) ; was before
561 (dired-move-to-filename)
562 (save-excursion ; hide subdirs that were hidden
563 (mapcar (function (lambda (dir)
564 (if (dired-goto-subdir dir
)
565 (dired-hide-subdir 1))))
567 ;; outside of the let scope
568 ;;; Might as well not override the user if the user changed this.
569 ;;; (setq buffer-read-only t)
572 ;; Subroutines of dired-revert
573 ;; Some of these are also used when inserting subdirs.
575 (defun dired-remember-marks (beg end
)
576 ;; Return alist of files and their marks, from BEG to END.
577 (if selective-display
; must unhide to make this work.
578 (let (buffer-read-only)
579 (subst-char-in-region beg end ?
\r ?
\n)))
583 (while (re-search-forward dired-re-mark end t
)
584 (if (setq fil
(dired-get-filename nil t
))
585 (setq chr
(preceding-char)
586 alist
(cons (cons fil chr
) alist
)))))
589 ;; Mark all files remembered in ALIST.
590 ;; Each element of ALIST looks like (FILE . MARKERCHAR).
591 (defun dired-mark-remembered (alist)
594 (setq elt
(car alist
)
598 (if (dired-goto-file fil
)
604 ;; Return a list of names of subdirs currently hidden.
605 (defun dired-remember-hidden ()
606 (let ((l dired-subdir-alist
) dir pos result
)
608 (setq dir
(car (car l
))
612 (skip-chars-forward "^\r\n")
613 (if (eq (following-char) ?
\r)
614 (setq result
(cons dir result
))))
617 ;; Try to insert all subdirs that were displayed before,
618 ;; according to the former subdir alist OLD-SUBDIR-ALIST.
619 (defun dired-insert-old-subdirs (old-subdir-alist)
620 (or (string-match "R" dired-actual-switches
)
622 (while old-subdir-alist
623 (setq elt
(car old-subdir-alist
)
624 old-subdir-alist
(cdr old-subdir-alist
)
629 (dired-insert-subdir dir
))
632 ;; Remove directory DIR from any directory cache.
633 (defun dired-uncache (dir)
634 (let ((handler (find-file-name-handler dir
)))
636 (funcall handler
'dired-uncache dir
))))
638 ;; dired mode key bindings and initialization
640 (defvar dired-mode-map nil
"Local keymap for dired-mode buffers.")
643 ;; Force `f' rather than `e' in the mode doc:
644 (defalias 'dired-advertised-find-file
'dired-find-file
)
645 ;; This looks ugly when substitute-command-keys uses C-d instead d:
646 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
648 (setq dired-mode-map
(make-keymap))
649 (suppress-keymap dired-mode-map
)
650 ;; Commands to mark or flag certain categories of files
651 (define-key dired-mode-map
"#" 'dired-flag-auto-save-files
)
652 (define-key dired-mode-map
"*" 'dired-mark-executables
)
653 (define-key dired-mode-map
"." 'dired-clean-directory
)
654 (define-key dired-mode-map
"/" 'dired-mark-directories
)
655 (define-key dired-mode-map
"@" 'dired-mark-symlinks
)
656 (define-key dired-mode-map
"~" 'dired-flag-backup-files
)
657 ;; Upper case keys (except !) for operating on the marked files
658 (define-key dired-mode-map
"C" 'dired-do-copy
)
659 (define-key dired-mode-map
"B" 'dired-do-byte-compile
)
660 (define-key dired-mode-map
"D" 'dired-do-delete
)
661 (define-key dired-mode-map
"G" 'dired-do-chgrp
)
662 (define-key dired-mode-map
"H" 'dired-do-hardlink
)
663 (define-key dired-mode-map
"L" 'dired-do-load
)
664 (define-key dired-mode-map
"M" 'dired-do-chmod
)
665 (define-key dired-mode-map
"O" 'dired-do-chown
)
666 (define-key dired-mode-map
"P" 'dired-do-print
)
667 (define-key dired-mode-map
"R" 'dired-do-rename
)
668 (define-key dired-mode-map
"S" 'dired-do-symlink
)
669 (define-key dired-mode-map
"X" 'dired-do-shell-command
)
670 (define-key dired-mode-map
"Z" 'dired-do-compress
)
671 (define-key dired-mode-map
"!" 'dired-do-shell-command
)
672 ;; Comparison commands
673 (define-key dired-mode-map
"=" 'dired-diff
)
674 (define-key dired-mode-map
"\M-=" 'dired-backup-diff
)
675 ;; Tree Dired commands
676 (define-key dired-mode-map
"\M-\C-?" 'dired-unmark-all-files
)
677 (define-key dired-mode-map
"\M-\C-d" 'dired-tree-down
)
678 (define-key dired-mode-map
"\M-\C-u" 'dired-tree-up
)
679 (define-key dired-mode-map
"\M-\C-n" 'dired-next-subdir
)
680 (define-key dired-mode-map
"\M-\C-p" 'dired-prev-subdir
)
681 ;; move to marked files
682 (define-key dired-mode-map
"\M-{" 'dired-prev-marked-file
)
683 (define-key dired-mode-map
"\M-}" 'dired-next-marked-file
)
684 ;; Make all regexp commands share a `%' prefix:
685 (defalias 'dired-regexp-prefix
(make-sparse-keymap))
686 (define-key dired-mode-map
"%" 'dired-regexp-prefix
)
687 (define-key dired-mode-map
"%u" 'dired-upcase
)
688 (define-key dired-mode-map
"%l" 'dired-downcase
)
689 (define-key dired-mode-map
"%d" 'dired-flag-files-regexp
)
690 (define-key dired-mode-map
"%m" 'dired-mark-files-regexp
)
691 (define-key dired-mode-map
"%r" 'dired-do-rename-regexp
)
692 (define-key dired-mode-map
"%C" 'dired-do-copy-regexp
)
693 (define-key dired-mode-map
"%H" 'dired-do-hardlink-regexp
)
694 (define-key dired-mode-map
"%R" 'dired-do-rename-regexp
)
695 (define-key dired-mode-map
"%S" 'dired-do-symlink-regexp
)
696 ;; Lower keys for commands not operating on all the marked files
697 (define-key dired-mode-map
"c" 'dired-change-marks
)
698 (define-key dired-mode-map
"d" 'dired-flag-file-deletion
)
699 (define-key dired-mode-map
"e" 'dired-find-file
)
700 (define-key dired-mode-map
"f" 'dired-advertised-find-file
)
701 (define-key dired-mode-map
"g" 'revert-buffer
)
702 (define-key dired-mode-map
"h" 'describe-mode
)
703 (define-key dired-mode-map
"i" 'dired-maybe-insert-subdir
)
704 (define-key dired-mode-map
"k" 'dired-do-kill-lines
)
705 (define-key dired-mode-map
"l" 'dired-do-redisplay
)
706 (define-key dired-mode-map
"m" 'dired-mark
)
707 (define-key dired-mode-map
"n" 'dired-next-line
)
708 (define-key dired-mode-map
"o" 'dired-find-file-other-window
)
709 (define-key dired-mode-map
"\C-o" 'dired-display-file
)
710 (define-key dired-mode-map
"p" 'dired-previous-line
)
711 (define-key dired-mode-map
"q" 'dired-quit
)
712 (define-key dired-mode-map
"s" 'dired-sort-toggle-or-edit
)
713 (define-key dired-mode-map
"u" 'dired-unmark
)
714 (define-key dired-mode-map
"v" 'dired-view-file
)
715 (define-key dired-mode-map
"x" 'dired-do-flagged-delete
)
716 (define-key dired-mode-map
"+" 'dired-create-directory
)
718 (define-key dired-mode-map
"<" 'dired-prev-dirline
)
719 (define-key dired-mode-map
">" 'dired-next-dirline
)
720 (define-key dired-mode-map
"^" 'dired-up-directory
)
721 (define-key dired-mode-map
" " 'dired-next-line
)
722 (define-key dired-mode-map
"\C-n" 'dired-next-line
)
723 (define-key dired-mode-map
"\C-p" 'dired-previous-line
)
725 (define-key dired-mode-map
"$" 'dired-hide-subdir
)
726 (define-key dired-mode-map
"\M-$" 'dired-hide-all
)
728 (define-key dired-mode-map
"?" 'dired-summary
)
729 (define-key dired-mode-map
"\177" 'dired-unmark-backward
)
730 (define-key dired-mode-map
"\C-_" 'dired-undo
)
731 (define-key dired-mode-map
"\C-xu" 'dired-undo
)
734 ;; Make menu bar items.
736 ;; Get rid of the Edit menu bar item to save space.
737 (define-key dired-mode-map
[menu-bar edit
] 'undefined
)
739 (define-key dired-mode-map
[menu-bar subdir
]
740 (cons "Subdir" (make-sparse-keymap "Subdir")))
742 (define-key dired-mode-map
[menu-bar subdir hide-all
]
743 '("Hide All" . dired-hide-all
))
744 (define-key dired-mode-map
[menu-bar subdir hide-subdir
]
745 '("Hide Subdir" . dired-hide-subdir
))
746 (define-key dired-mode-map
[menu-bar subdir tree-down
]
747 '("Tree Down" . dired-tree-down
))
748 (define-key dired-mode-map
[menu-bar subdir tree-up
]
749 '("Tree Up" . dired-tree-up
))
750 (define-key dired-mode-map
[menu-bar subdir up
]
751 '("Up Directory" . dired-up-directory
))
752 (define-key dired-mode-map
[menu-bar subdir prev-subdir
]
753 '("Prev Subdir" . dired-prev-subdir
))
754 (define-key dired-mode-map
[menu-bar subdir next-subdir
]
755 '("Next Subdir" . dired-next-subdir
))
756 (define-key dired-mode-map
[menu-bar subdir prev-dirline
]
757 '("Prev Dirline" . dired-prev-dirline
))
758 (define-key dired-mode-map
[menu-bar subdir next-dirline
]
759 '("Next Dirline" . dired-next-dirline
))
760 (define-key dired-mode-map
[menu-bar subdir insert
]
761 '("Insert This Subdir" . dired-maybe-insert-subdir
))
763 (define-key dired-mode-map
[menu-bar immediate
]
764 (cons "Immediate" (make-sparse-keymap "Immediate")))
766 (define-key dired-mode-map
[menu-bar immediate backup-diff
]
767 '("Compare with Backup" . dired-backup-diff
))
768 (define-key dired-mode-map
[menu-bar immediate diff
]
769 '("Diff" . dired-diff
))
770 (define-key dired-mode-map
[menu-bar immediate view
]
771 '("View This File" . dired-view-file
))
772 (define-key dired-mode-map
[menu-bar immediate display
]
773 '("Display in Other Window" . dired-display-file
))
774 (define-key dired-mode-map
[menu-bar immediate find-file-other-window
]
775 '("Find in Other Window" . dired-find-file-other-window
))
776 (define-key dired-mode-map
[menu-bar immediate find-file
]
777 '("Find This File" . dired-find-file
))
778 (define-key dired-mode-map
[menu-bar immediate create-directory
]
779 '("Create Directory..." . dired-create-directory
))
781 (define-key dired-mode-map
[menu-bar regexp
]
782 (cons "Regexp" (make-sparse-keymap "Regexp")))
784 (define-key dired-mode-map
[menu-bar regexp downcase
]
785 '("Downcase" . dired-downcase
))
786 (define-key dired-mode-map
[menu-bar regexp upcase
]
787 '("Upcase" . dired-upcase
))
788 (define-key dired-mode-map
[menu-bar regexp hardlink
]
789 '("Hardlink..." . dired-do-hardlink-regexp
))
790 (define-key dired-mode-map
[menu-bar regexp symlink
]
791 '("Symlink..." . dired-do-symlink-regexp
))
792 (define-key dired-mode-map
[menu-bar regexp rename
]
793 '("Rename..." . dired-do-rename-regexp
))
794 (define-key dired-mode-map
[menu-bar regexp copy
]
795 '("Copy..." . dired-do-copy-regexp
))
796 (define-key dired-mode-map
[menu-bar regexp flag
]
797 '("Flag..." . dired-flag-files-regexp
))
798 (define-key dired-mode-map
[menu-bar regexp mark
]
799 '("Mark..." . dired-mark-files-regexp
))
801 (define-key dired-mode-map
[menu-bar mark
]
802 (cons "Mark" (make-sparse-keymap "Mark")))
804 (define-key dired-mode-map
[menu-bar mark prev
]
805 '("Previous Marked" . dired-prev-marked-file
))
806 (define-key dired-mode-map
[menu-bar mark next
]
807 '("Next Marked" . dired-next-marked-file
))
808 (define-key dired-mode-map
[menu-bar mark marks
]
809 '("Change Marks..." . dired-change-marks
))
810 (define-key dired-mode-map
[menu-bar mark unmark-all
]
811 '("Unmark All" . dired-unmark-all-files-no-query
))
812 (define-key dired-mode-map
[menu-bar mark symlinks
]
813 '("Mark Symlinks" . dired-mark-symlinks
))
814 (define-key dired-mode-map
[menu-bar mark directories
]
815 '("Mark Directories" . dired-mark-directories
))
816 (define-key dired-mode-map
[menu-bar mark directory
]
817 '("Mark Old Backups" . dired-clean-directory
))
818 (define-key dired-mode-map
[menu-bar mark executables
]
819 '("Mark Executables" . dired-mark-executables
))
820 (define-key dired-mode-map
[menu-bar mark backup-files
]
821 '("Flag Backup Files" . dired-flag-backup-files
))
822 (define-key dired-mode-map
[menu-bar mark auto-save-files
]
823 '("Flag Auto-save Files" . dired-flag-auto-save-files
))
824 (define-key dired-mode-map
[menu-bar mark deletion
]
825 '("Flag" . dired-flag-file-deletion
))
826 (define-key dired-mode-map
[menu-bar mark unmark
]
827 '("Unmark" . dired-unmark
))
828 (define-key dired-mode-map
[menu-bar mark mark
]
829 '("Mark" . dired-mark
))
831 (define-key dired-mode-map
[menu-bar operate
]
832 (cons "Operate" (make-sparse-keymap "Operate")))
834 (define-key dired-mode-map
[menu-bar operate chown
]
835 '("Change Owner..." . dired-do-chown
))
836 (define-key dired-mode-map
[menu-bar operate chgrp
]
837 '("Change Group..." . dired-do-chgrp
))
838 (define-key dired-mode-map
[menu-bar operate chmod
]
839 '("Change Mode..." . dired-do-chmod
))
840 (define-key dired-mode-map
[menu-bar operate load
]
841 '("Load" . dired-do-load
))
842 (define-key dired-mode-map
[menu-bar operate compile
]
843 '("Byte-compile" . dired-do-byte-compile
))
844 (define-key dired-mode-map
[menu-bar operate compress
]
845 '("Compress" . dired-do-compress
))
846 (define-key dired-mode-map
[menu-bar operate print
]
847 '("Print" . dired-do-print
))
848 (define-key dired-mode-map
[menu-bar operate hardlink
]
849 '("Hardlink to..." . dired-do-hardlink
))
850 (define-key dired-mode-map
[menu-bar operate symlink
]
851 '("Symlink to..." . dired-do-symlink
))
852 (define-key dired-mode-map
[menu-bar operate command
]
853 '("Shell Command..." . dired-do-shell-command
))
854 (define-key dired-mode-map
[menu-bar operate delete
]
855 '("Delete" . dired-do-delete
))
856 (define-key dired-mode-map
[menu-bar operate rename
]
857 '("Rename to..." . dired-do-rename
))
858 (define-key dired-mode-map
[menu-bar operate copy
]
859 '("Copy to..." . dired-do-copy
))
861 ;; Dired mode is suitable only for specially formatted data.
862 (put 'dired-mode
'mode-class
'special
)
864 (defun dired-mode (&optional dirname switches
)
866 Mode for \"editing\" directory listings.
867 In dired, you are \"editing\" a list of the files in a directory and
868 \(optionally) its subdirectories, in the format of `ls -lR'.
869 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
870 \"Editing\" means that you can run shell commands on files, visit,
871 compress, load or byte-compile them, change their file attributes
872 and insert subdirectories into the same buffer. You can \"mark\"
873 files for later commands or \"flag\" them for deletion, either file
874 by file or all files matching certain criteria.
875 You can move using the usual cursor motion commands.\\<dired-mode-map>
876 Letters no longer insert themselves. Digits are prefix arguments.
877 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
878 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
879 Most commands operate on the marked files and use the current file
880 if no files are marked. Use a numeric prefix argument to operate on
881 the next ARG (or previous -ARG if ARG<0) files, or just `1'
882 to operate on the current file only. Prefix arguments override marks.
883 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
884 to see why something went wrong.
885 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
886 Type \\[dired-unmark-backward] to back up one line and unflag.
887 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
888 Type \\[dired-advertised-find-file] to Find the current line's file
889 (or dired it in another buffer, if it is a directory).
890 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
891 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
892 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
893 Type \\[dired-do-copy] to Copy files.
894 Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
895 Type \\[revert-buffer] to read all currently expanded directories again.
896 This retains all marks and hides subdirs again that were hidden before.
897 SPC and DEL can be used to move down and up by lines.
899 If dired ever gets confused, you can either type \\[revert-buffer] \
901 directories again, type \\[dired-do-redisplay] \
902 to relist a single or the marked files or a
903 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
904 again for the directory tree.
906 Customization variables (rename this buffer and type \\[describe-variable] on each line
909 dired-listing-switches
910 dired-trivial-filenames
914 dired-keep-marker-rename
915 dired-keep-marker-copy
916 dired-keep-marker-hardlink
917 dired-keep-marker-symlink
919 Hooks (use \\[describe-variable] to see their documentation):
921 dired-before-readin-hook
922 dired-after-readin-hook
928 ;; Not to be called interactively (e.g. dired-directory will be set
929 ;; to default-directory, which is wrong with wildcards).
930 (kill-all-local-variables)
931 (use-local-map dired-mode-map
)
932 (dired-advertise) ; default-directory is already set
933 (setq major-mode
'dired-mode
935 ;; case-fold-search nil
937 selective-display t
; for subdirectory hiding
938 mode-line-buffer-identification
'("Dired: %17b"))
939 (set (make-local-variable 'revert-buffer-function
)
940 (function dired-revert
))
941 (set (make-local-variable 'page-delimiter
)
943 (set (make-local-variable 'dired-directory
)
944 (or dirname default-directory
))
945 ;; list-buffers uses this to display the dir being edited in this buffer.
946 (set (make-local-variable 'list-buffers-directory
)
948 (set (make-local-variable 'dired-actual-switches
)
949 (or switches dired-listing-switches
))
950 (dired-sort-other dired-actual-switches t
)
951 (run-hooks 'dired-mode-hook
))
953 ;; Idiosyncratic dired commands that don't deal with marks.
956 "Bury the current dired buffer."
960 (defun dired-summary ()
961 "Summarize basic Dired commands and show recent Dired errors."
964 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
966 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
969 "Undo in a dired buffer.
970 This doesn't recover lost files, it just undoes changes in the buffer itself.
971 You can use it to recover marks, killed lines or subdirs.
972 In the latter case, you have to do \\[dired-build-subdir-alist] to
973 parse the buffer again."
975 (let (buffer-read-only)
978 (defun dired-next-line (arg)
979 "Move down lines then position at filename.
980 Optional prefix ARG says how many lines to move; default is one line."
983 (dired-move-to-filename))
985 (defun dired-previous-line (arg)
986 "Move up lines then position at filename.
987 Optional prefix ARG says how many lines to move; default is one line."
990 (dired-move-to-filename))
992 (defun dired-next-dirline (arg &optional opoint
)
993 "Goto ARG'th next directory file line."
995 (or opoint
(setq opoint
(point)))
997 (re-search-forward dired-re-dir nil t arg
)
999 (re-search-backward dired-re-dir nil t
(- arg
)))
1000 (dired-move-to-filename) ; user may type `i' or `f'
1002 (error "No more subdirectories")))
1004 (defun dired-prev-dirline (arg)
1005 "Goto ARG'th previous directory file line."
1007 (dired-next-dirline (- arg
)))
1009 (defun dired-up-directory ()
1010 "Run dired on parent directory of current directory.
1011 Find the parent directory either in this buffer or another buffer.
1012 Creates a buffer if necessary."
1014 (let* ((dir (dired-current-directory))
1015 (up (file-name-directory (directory-file-name dir
))))
1016 (or (dired-goto-file (directory-file-name dir
))
1017 ;; Only try dired-goto-subdir if buffer has more than one dir.
1018 (and (cdr dired-subdir-alist
)
1019 (dired-goto-subdir up
))
1023 (dired-goto-file dir
)))))
1025 (defun dired-find-file ()
1026 "In dired, visit the file or directory named on this line."
1028 (find-file (file-name-sans-versions (dired-get-filename) t
)))
1030 (defun dired-view-file ()
1031 "In dired, examine a file in view mode, returning to dired when done.
1032 When file is a directory, show it in this buffer if it is inserted;
1033 otherwise, display it in another buffer."
1035 (if (file-directory-p (dired-get-filename))
1036 (or (and (cdr dired-subdir-alist
)
1037 (dired-goto-subdir (dired-get-filename)))
1038 (dired (dired-get-filename)))
1039 (view-file (dired-get-filename))))
1041 (defun dired-find-file-other-window ()
1042 "In dired, visit this file or directory in another window."
1044 (find-file-other-window (file-name-sans-versions (dired-get-filename) t
)))
1046 (defun dired-display-file ()
1047 "In dired, display this file or directory in another window."
1049 (let ((file (file-name-sans-versions (dired-get-filename) t
)))
1050 (display-buffer (find-file-noselect file
))))
1052 ;;; Functions for extracting and manipulating file names in dired buffers.
1054 (defun dired-get-filename (&optional localp no-error-if-not-filep
)
1055 "In dired, return name of file mentioned on this line.
1056 Value returned normally includes the directory name.
1057 Optional arg LOCALP with value `no-dir' means don't include directory
1058 name in result. A value of t means construct name relative to
1059 `default-directory', which still may contain slashes if in a subdirectory.
1060 Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1061 this line, otherwise an error occurs."
1062 (let (case-fold-search file p1 p2
)
1064 (if (setq p1
(dired-move-to-filename (not no-error-if-not-filep
)))
1065 (setq p2
(dired-move-to-end-of-filename no-error-if-not-filep
))))
1066 ;; nil if no file on this line, but no-error-if-not-filep is t:
1067 (if (setq file
(and p1 p2
(buffer-substring p1 p2
)))
1068 ;; Check if ls quoted the names, and unquote them.
1069 ;; Using read to unquote is much faster than substituting
1070 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1071 (cond ((string-match "b" dired-actual-switches
) ; System V ls
1072 ;; This case is about 20% slower than without -b.
1076 ;; some ls -b don't escape quotes, argh!
1077 ;; This is not needed for GNU ls, though.
1078 (or (dired-string-replace-match
1079 "\\([^\\]\\)\"" file
"\\1\\\\\"")
1082 ;; If you do this, update dired-insert-subdir-validate too
1083 ;; ((string-match "Q" dired-actual-switches) ; GNU ls
1084 ;; (setq file (read file)))
1086 (if (eq localp
'no-dir
)
1088 (and file
(concat (dired-current-directory localp
) file
)))))
1090 (defun dired-make-absolute (file &optional dir
)
1091 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1092 ;; We can't always use expand-file-name as this would get rid of `.'
1093 ;; or expand in / instead default-directory if DIR=="".
1094 ;; This should be good enough for ange-ftp, but might easily be
1095 ;; redefined (for VMS?).
1096 ;; It should be reasonably fast, though, as it is called in
1097 ;; dired-get-filename.
1098 (concat (or dir default-directory
) file
))
1100 (defun dired-make-relative (file &optional dir no-error
)
1101 ;;"Convert FILE (an absolute pathname) to a pathname relative to DIR.
1102 ;; Else error (unless NO-ERROR is non-nil, then FILE is returned unchanged)
1103 ;;DIR defaults to default-directory."
1104 ;; DIR must be file-name-as-directory, as with all directory args in
1106 (or dir
(setq dir default-directory
))
1107 ;; This case comes into play if default-directory is set to
1109 (if (and (> (length dir
) 0) (= (aref dir
0) ?~
))
1110 (setq dir
(expand-file-name dir
)))
1111 (if (string-match (concat "^" (regexp-quote dir
)) file
)
1112 (substring file
(match-end 0))
1115 (error "%s: not in directory tree growing at %s" file dir
))))
1117 ;;; Functions for finding the file name in a dired buffer line.
1119 (defvar dired-move-to-filename-regexp
1120 "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|Sep\\|Oct\\|Nov\\|Dec\\)[ ]+[0-9]+"
1121 "Regular expression to match a month abbreviation followed by a number.")
1123 ;; Move to first char of filename on this line.
1124 ;; Returns position (point) or nil if no filename on this line."
1125 (defun dired-move-to-filename (&optional raise-error eol
)
1126 ;; This is the UNIX version.
1127 (or eol
(setq eol
(progn (end-of-line) (point))))
1129 (if (re-search-forward
1130 dired-move-to-filename-regexp
1133 (skip-chars-forward " ") ; there is one SPC after day of month
1134 (skip-chars-forward "^ " eol
) ; move after time of day (or year)
1135 (skip-chars-forward " " eol
) ; there is space before the file name
1136 ;; Actually, if the year instead of clock time is displayed,
1137 ;; there are (only for some ls programs?) two spaces instead
1138 ;; of one before the name.
1139 ;; If we could depend on ls inserting exactly one SPC we
1140 ;; would not bomb on names _starting_ with SPC.
1143 (error "No file on this line")
1146 (defun dired-move-to-end-of-filename (&optional no-error
)
1147 ;; Assumes point is at beginning of filename,
1148 ;; thus the rwx bit re-search-backward below will succeed in *this*
1149 ;; line if at all. So, it should be called only after
1150 ;; (dired-move-to-filename t).
1151 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1152 ;; This is the UNIX version.
1153 (let (opoint file-type executable symlink hidden case-fold-search used-F eol
)
1154 ;; case-fold-search is nil now, so we can test for capital F:
1155 (setq used-F
(string-match "F" dired-actual-switches
)
1157 eol
(save-excursion (end-of-line) (point))
1158 hidden
(and selective-display
1159 (save-excursion (search-forward "\r" eol t
))))
1162 (save-excursion;; Find out what kind of file this is:
1163 ;; Restrict perm bits to be non-blank,
1164 ;; otherwise this matches one char to early (looking backward):
1165 ;; "l---------" (some systems make symlinks that way)
1166 ;; "----------" (plain file with zero perms)
1167 (if (re-search-backward
1168 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1170 (setq file-type
(char-after (match-beginning 1))
1171 symlink
(eq file-type ?l
)
1172 ;; Only with -F we need to know whether it's an executable
1176 "[xst]";; execute bit set anywhere?
1178 (buffer-substring (match-beginning 2)
1180 (buffer-substring (match-beginning 3)
1182 (buffer-substring (match-beginning 4)
1184 (or no-error
(error "No file on this line"))))
1185 ;; Move point to end of name:
1187 (if (search-forward " ->" eol t
)
1191 dired-ls-F-marks-symlinks
1192 (eq (preceding-char) ?
@);; did ls really mark the link?
1193 (forward-char -
1))))
1194 (goto-char eol
);; else not a symbolic link
1195 ;; ls -lF marks dirs, sockets and executables with exactly one
1196 ;; trailing character. (Executable bits on symlinks ain't mean
1197 ;; a thing, even to ls, but we know it's not a symlink.)
1199 (or (memq file-type
'(?d ?s
))
1201 (forward-char -
1))))
1203 (not (eq opoint
(point)))
1205 (substitute-command-keys
1206 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1207 "No file on this line")))
1208 (if (eq opoint
(point))
1213 ;; Keeping Dired buffers in sync with the filesystem and with each other
1215 (defvar dired-buffers nil
1216 ;; Enlarged by dired-advertise
1217 ;; Queried by function dired-buffers-for-dir. When this detects a
1218 ;; killed buffer, it is removed from this list.
1219 "Alist of directories and their associated dired buffers.")
1221 (defun dired-buffers-for-dir (dir)
1222 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1223 ;; The list is in reverse order of buffer creation, most recent last.
1224 ;; As a side effect, killed dired buffers for DIR are removed from
1226 (setq dir
(file-name-as-directory dir
))
1227 (let ((alist dired-buffers
) result elt
)
1229 (setq elt
(car alist
))
1230 (if (dired-in-this-tree dir
(car elt
))
1231 (let ((buf (cdr elt
)))
1232 (if (buffer-name buf
)
1233 (if (assoc dir
(save-excursion
1235 dired-subdir-alist
))
1236 (setq result
(cons buf result
)))
1237 ;; else buffer is killed - clean up:
1238 (setq dired-buffers
(delq elt dired-buffers
)))))
1239 (setq alist
(cdr alist
)))
1242 (defun dired-advertise ()
1243 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1244 ;; With wildcards we actually advertise too much.
1245 (if (memq (current-buffer) (dired-buffers-for-dir default-directory
))
1246 t
; we have already advertised ourselves
1248 (cons (cons default-directory
(current-buffer))
1251 (defun dired-unadvertise (dir)
1252 ;; Remove DIR from the buffer alist in variable dired-buffers.
1253 ;; This has the effect of removing any buffer whose main directory is DIR.
1254 ;; It does not affect buffers in which DIR is a subdir.
1255 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1257 (delq (assoc dir dired-buffers
) dired-buffers
)))
1261 ;;; utility functions
1263 (defun dired-in-this-tree (file dir
)
1264 ;;"Is FILE part of the directory tree starting at DIR?"
1265 (let (case-fold-search)
1266 (string-match (concat "^" (regexp-quote (expand-file-name dir
))) file
)))
1268 (defun dired-normalize-subdir (dir)
1269 ;; Prepend default-directory to DIR if relative path name.
1270 ;; dired-get-filename must be able to make a valid filename from a
1271 ;; file and its directory DIR.
1272 (file-name-as-directory
1273 (if (file-name-absolute-p dir
)
1275 (expand-file-name dir default-directory
))))
1277 (defun dired-get-subdir ()
1278 ;;"Return the subdir name on this line, or nil if not on a headerline."
1279 ;; Look up in the alist whether this is a headerline.
1281 (let ((cur-dir (dired-current-directory)))
1282 (beginning-of-line) ; alist stores b-o-l positions
1283 (and (zerop (- (point)
1284 (dired-get-subdir-min (assoc cur-dir
1285 dired-subdir-alist
))))
1288 ;(defun dired-get-subdir-min (elt)
1290 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1291 (defalias 'dired-get-subdir-min
'cdr
)
1293 (defun dired-get-subdir-max (elt)
1295 (goto-char (dired-get-subdir-min elt
))
1296 (dired-subdir-max)))
1298 (defun dired-clear-alist ()
1299 (while dired-subdir-alist
1300 (set-marker (dired-get-subdir-min (car dired-subdir-alist
)) nil
)
1301 (setq dired-subdir-alist
(cdr dired-subdir-alist
))))
1303 (defun dired-subdir-index (dir)
1304 ;; Return an index into alist for use with nth
1305 ;; for the sake of subdir moving commands.
1306 (let (found (index 0) (alist dired-subdir-alist
))
1308 (if (string= dir
(car (car alist
)))
1309 (setq alist nil found t
)
1310 (setq alist
(cdr alist
) index
(1+ index
))))
1311 (if found index nil
)))
1313 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip
)
1314 "Go to next subdirectory, regardless of level."
1315 ;; Use 0 arg to go to this directory's header line.
1316 ;; NO-SKIP prevents moving to end of header line, returning whatever
1317 ;; position was found in dired-subdir-alist.
1319 (let ((this-dir (dired-current-directory))
1321 ;; nth with negative arg does not return nil but the first element
1322 (setq index
(- (dired-subdir-index this-dir
) arg
))
1323 (setq pos
(if (>= index
0)
1324 (dired-get-subdir-min (nth index dired-subdir-alist
))))
1328 (or no-skip
(skip-chars-forward "^\n\r"))
1330 (if no-error-if-not-found
1331 nil
; return nil if not found
1332 (error "%s directory" (if (> arg
0) "Last" "First"))))))
1334 (defun dired-build-subdir-alist ()
1335 "Build `dired-subdir-alist' by parsing the buffer.
1336 Returns the new value of the alist."
1341 (buffer-read-only nil
)
1343 (goto-char (point-min))
1344 (setq dired-subdir-alist nil
)
1345 (while (re-search-forward dired-subdir-regexp nil t
)
1347 (goto-char (match-beginning 1))
1349 (expand-file-name (buffer-substring (point) (match-end 1))))
1350 (delete-region (point) (match-end 1))
1351 (insert new-dir-name
))
1352 (setq count
(1+ count
))
1353 (dired-alist-add-1 new-dir-name
1354 ;; Place a sub directory boundary between lines.
1356 (goto-char (match-beginning 0))
1360 (message "Buffer includes %d directories" count
))
1361 ;; We don't need to sort it because it is in buffer order per
1362 ;; constructionem. Return new alist:
1363 dired-subdir-alist
)))
1365 (defun dired-alist-add-1 (dir new-marker
)
1366 ;; Add new DIR at NEW-MARKER. Don't sort.
1367 (setq dired-subdir-alist
1368 (cons (cons (dired-normalize-subdir dir
) new-marker
)
1369 dired-subdir-alist
)))
1371 (defun dired-goto-next-nontrivial-file ()
1372 ;; Position point on first nontrivial file after point.
1373 (dired-goto-next-file);; so there is a file to compare with
1374 (if (stringp dired-trivial-filenames
)
1375 (while (and (not (eobp))
1376 (string-match dired-trivial-filenames
1377 (file-name-nondirectory
1378 (or (dired-get-filename nil t
) ""))))
1380 (dired-move-to-filename))))
1382 (defun dired-goto-next-file ()
1383 (let ((max (1- (dired-subdir-max))))
1384 (while (and (not (dired-move-to-filename)) (< (point) max
))
1387 (defun dired-goto-file (file)
1388 "Go to file line of FILE in this dired buffer."
1389 ;; Return value of point on success, else nil.
1390 ;; FILE must be an absolute pathname.
1391 ;; Loses if FILE contains control chars like "\007" for which ls
1392 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1393 ;; it in the buffer.
1395 (prog1 ; let push-mark display its message
1396 (list (expand-file-name
1397 (read-file-name "Goto file: "
1398 (dired-current-directory))))
1400 (setq file
(directory-file-name file
)) ; does no harm if no directory
1401 (let (found case-fold-search dir
)
1402 (setq dir
(or (file-name-directory file
)
1403 (error "Need absolute pathname for %s" file
)))
1405 ;; The hair here is to get the result of dired-goto-subdir
1406 ;; without really calling it if we don't have any subdirs.
1407 (if (if (string= dir
(expand-file-name default-directory
))
1408 (goto-char (point-min))
1409 (and (cdr dired-subdir-alist
)
1410 (dired-goto-subdir dir
)))
1411 (let ((base (file-name-nondirectory file
))
1412 (boundary (dired-subdir-max)))
1413 (while (and (not found
)
1414 ;; filenames are preceded by SPC, this makes
1415 ;; the search faster (e.g. for the filename "-"!).
1416 (search-forward (concat " " base
) boundary
'move
))
1417 ;; Match could have BASE just as initial substring or
1418 ;; or in permission bits or date or
1419 ;; not be a proper filename at all:
1420 (if (equal base
(dired-get-filename 'no-dir t
))
1421 ;; Must move to filename since an (actually
1422 ;; correct) match could have been elsewhere on the
1423 ;; ;; line (e.g. "-" would match somewhere in the
1424 ;; permission bits).
1425 (setq found
(dired-move-to-filename))
1426 ;; If this isn't the right line, move forward to avoid
1427 ;; trying this line again.
1428 (forward-line 1))))))
1430 ;; return value of point (i.e., FOUND):
1431 (goto-char found
))))
1433 (defun dired-initial-position (dirname)
1434 ;; Where point should go in a new listing of DIRNAME.
1435 ;; Point assumed at beginning of new subdir line.
1436 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1438 (if dired-trivial-filenames
(dired-goto-next-nontrivial-file)))
1440 ;; These are hooks which make tree dired work.
1441 ;; They are in this file because other parts of dired need to call them.
1442 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
1444 ;; This function is called for each retrieved filename.
1445 ;; It could stand to be faster, though it's mostly function call
1446 ;; overhead. Avoiding the function call seems to save about 10% in
1447 ;; dired-get-filename. Make it a defsubst?
1448 (defun dired-current-directory (&optional localp
)
1449 "Return the name of the subdirectory to which this line belongs.
1450 This returns a string with trailing slash, like `default-directory'.
1451 Optional argument means return a file name relative to `default-directory'."
1452 (let ((here (point))
1453 (alist (or dired-subdir-alist
1454 ;; probably because called in a non-dired buffer
1455 (error "No subdir-alist in %s" (current-buffer))))
1458 (setq elt
(car alist
)
1460 ;; use `<=' (not `<') as subdir line is part of subdir
1461 alist
(if (<= (dired-get-subdir-min elt
) here
)
1465 (dired-make-relative dir default-directory
)
1468 ;; Subdirs start at the beginning of their header lines and end just
1469 ;; before the beginning of the next header line (or end of buffer).
1471 (defun dired-subdir-max ()
1473 (if (or (null (cdr dired-subdir-alist
)) (not (dired-next-subdir 1 t t
)))
1479 (defun dired-do-flagged-delete ()
1480 "In dired, delete the files flagged for deletion."
1482 (let* ((dired-marker-char dired-del-marker
)
1483 (regexp (dired-marker-regexp))
1485 (if (save-excursion (goto-char (point-min))
1486 (re-search-forward regexp nil t
))
1487 (dired-internal-do-deletions
1488 ;; this can't move point since ARG is nil
1489 (dired-map-over-marks (cons (dired-get-filename) (point))
1492 (message "(No deletions requested)"))))
1494 (defun dired-do-delete (&optional arg
)
1495 "Delete all marked (or next ARG) files."
1496 ;; This is more consistent with the file marking feature than
1497 ;; dired-do-flagged-delete.
1499 (dired-internal-do-deletions
1500 ;; this may move point if ARG is an integer
1501 (dired-map-over-marks (cons (dired-get-filename) (point))
1505 (defvar dired-deletion-confirmer
'yes-or-no-p
) ; or y-or-n-p?
1507 (defun dired-internal-do-deletions (l arg
)
1508 ;; L is an alist of files to delete, with their buffer positions.
1509 ;; ARG is the prefix arg.
1510 ;; Filenames are absolute (VMS needs this for logical search paths).
1511 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
1512 ;; That way as changes are made in the buffer they do not shift the
1513 ;; lines still to be changed, so the (point) values in L stay valid.
1514 ;; Also, for subdirs in natural order, a subdir's files are deleted
1515 ;; before the subdir itself - the other way around would not work.
1516 (let ((files (mapcar (function car
) l
))
1519 ;; canonicalize file list for pop up
1520 (setq files
(nreverse (mapcar (function dired-make-relative
) files
)))
1521 (if (dired-mark-pop-up
1522 " *Deletions*" 'delete files dired-deletion-confirmer
1523 (format "Delete %s " (dired-mark-prompt arg files
)))
1525 (let (failures);; files better be in reverse order for this loop!
1527 (goto-char (cdr (car l
)))
1528 (let (buffer-read-only)
1530 (let ((fn (car (car l
))))
1531 ;; This test is equivalent to
1532 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1533 ;; but more efficient
1534 (if (eq t
(car (file-attributes fn
)))
1535 (delete-directory fn
)
1537 ;; if we get here, removing worked
1538 (setq succ
(1+ succ
))
1539 (message "%s of %s deletions" succ count
)
1540 (delete-region (progn (beginning-of-line) (point))
1541 (progn (forward-line 1) (point)))
1542 (dired-clean-up-after-deletion fn
))
1543 (error;; catch errors from failed deletions
1544 (dired-log "%s\n" err
)
1545 (setq failures
(cons (car (car l
)) failures
)))))
1548 (message "%d deletion%s done" count
(dired-plural-s count
))
1550 (format "%d of %d deletion%s failed"
1551 (length failures
) count
1552 (dired-plural-s count
))
1554 (message "(No deletions performed)")))
1555 (dired-move-to-filename))
1557 ;; This is a separate function for the sake of dired-x.el.
1558 (defun dired-clean-up-after-deletion (fn)
1559 ;; Clean up after a deleted file or directory FN.
1560 (save-excursion (and (cdr dired-subdir-alist
)
1561 (dired-goto-subdir fn
)
1562 (dired-kill-subdir))))
1566 (defun dired-marker-regexp ()
1567 (concat "^" (regexp-quote (char-to-string dired-marker-char
))))
1569 (defun dired-plural-s (count)
1570 (if (= 1 count
) "" "s"))
1572 (defun dired-mark-prompt (arg files
)
1573 ;; Return a string for use in a prompt, either the current file
1574 ;; name, or the marker and a count of marked files.
1575 (let ((count (length files
)))
1578 ;; more than 1 file:
1581 ;; Perhaps this is nicer, but it also takes more screen space:
1582 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
1584 (format "[next %d files]" arg
)
1585 (format "%c [%d files]" dired-marker-char count
)))))
1587 (defun dired-pop-to-buffer (buf)
1588 ;; Pop up buffer BUF.
1589 ;; If dired-shrink-to-fit is t, make its window fit its contents.
1590 (if (not dired-shrink-to-fit
)
1591 (pop-to-buffer (get-buffer-create buf
))
1592 ;; let window shrink to fit:
1593 (let ((window (selected-window))
1595 (cond ;; if split-window-threshold is enabled, use the largest window
1596 ((and (> (window-height (setq w2
(get-largest-window)))
1597 split-height-threshold
)
1598 (= (frame-width) (window-width w2
)))
1600 ;; if the least-recently-used window is big enough, use it
1601 ((and (> (window-height (setq w2
(get-lru-window)))
1602 (* 2 window-min-height
))
1603 (= (frame-width) (window-width w2
)))
1607 (goto-char (point-max))
1608 (skip-chars-backward "\n\r\t ")
1609 (setq target-lines
(count-lines (point-min) (point)))
1610 ;; Don't forget to count the last line.
1612 (setq target-lines
(1+ target-lines
))))
1613 (if (<= (window-height window
) (* 2 window-min-height
))
1614 ;; At this point, every window on the frame is too small to split.
1615 (setq w2
(display-buffer buf
))
1616 (setq w2
(split-window window
1617 (max window-min-height
1618 (- (window-height window
)
1619 (1+ (max window-min-height target-lines
)))))))
1620 (set-window-buffer w2 buf
)
1621 (if (< (1- (window-height w2
)) target-lines
)
1624 (enlarge-window (- target-lines
(1- (window-height w2
))))))
1625 (set-window-start w2
1)
1628 (defvar dired-no-confirm nil
1629 ;; "If non-nil, list of symbols for commands dired should not confirm.
1630 ;;It can be a sublist of
1632 ;; '(byte-compile chgrp chmod chown compress copy delete hardlink load
1633 ;; move print shell symlink uncompress)"
1636 (defun dired-mark-pop-up (bufname op-symbol files function
&rest args
)
1637 ;;"Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
1638 ;;Return FUNCTION's result on ARGS after popping up a window (in a buffer
1639 ;;named BUFNAME, nil gives \" *Marked Files*\") showing the marked
1640 ;;files. Uses function `dired-pop-to-buffer' to do that.
1641 ;; FUNCTION should not manipulate files.
1642 ;; It should only read input (an argument or confirmation).
1643 ;;The window is not shown if there is just one file or
1644 ;; OP-SYMBOL is a member of the list in `dired-no-confirm'.
1645 ;;FILES is the list of marked files."
1646 (or bufname
(setq bufname
" *Marked Files*"))
1647 (if (or (memq op-symbol dired-no-confirm
)
1648 (= (length files
) 1))
1649 (apply function args
)
1651 (set-buffer (get-buffer-create bufname
))
1653 (dired-format-columns-of-files files
))
1654 (save-window-excursion
1655 (dired-pop-to-buffer bufname
)
1656 (apply function args
))))
1658 (defun dired-format-columns-of-files (files)
1659 ;; Files should be in forward order for this loop.
1660 ;; i.e., (car files) = first file in buffer.
1661 ;; Returns the number of lines used.
1662 (let* ((maxlen (+ 2 (apply 'max
(mapcar 'length files
))))
1663 (width (- (window-width (selected-window)) 2))
1664 (columns (max 1 (/ width maxlen
)))
1665 (nfiles (length files
))
1666 (rows (+ (/ nfiles columns
)
1667 (if (zerop (% nfiles columns
)) 0 1)))
1670 (setq files
(nconc (copy-sequence files
) ; fill up with empty fns
1671 (make-list (- (* columns rows
) nfiles
) "")))
1672 (setcdr (nthcdr (1- (length files
)) files
) files
) ; make circular
1674 (while (< i columns
)
1675 (indent-to (* i maxlen
))
1676 (insert (car files
))
1677 (setq files
(nthcdr rows files
)
1685 ;; Commands to mark or flag file(s) at or near current line.
1687 (defun dired-repeat-over-lines (arg function
)
1688 ;; This version skips non-file lines.
1689 (let ((pos (make-marker)))
1691 (while (and (> arg
0) (not (eobp)))
1694 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
1697 (move-marker pos
(1+ (point))))
1698 (save-excursion (funcall function
))
1699 ;; Advance to the next line--actually, to the line that *was* next.
1700 ;; (If FUNCTION inserted some new lines in between, skip them.)
1702 (while (and (< arg
0) (not (bobp)))
1705 (while (and (not (bobp)) (dired-between-files)) (forward-line -
1))
1707 (save-excursion (funcall function
)))
1708 (move-marker pos nil
)
1709 (dired-move-to-filename)))
1711 (defun dired-between-files ()
1712 ;; Point must be at beginning of line
1713 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
1714 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
1715 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard")
1716 (looking-at dired-subdir-regexp
)))
1718 (defun dired-next-marked-file (arg &optional wrap opoint
)
1719 "Move to the next marked file, wrapping around the end of the buffer."
1720 (interactive "p\np")
1721 (or opoint
(setq opoint
(point)));; return to where interactively started
1723 (re-search-forward dired-re-mark nil t arg
)
1725 (re-search-backward dired-re-mark nil t
(- arg
)))
1726 (dired-move-to-filename)
1730 (error "No next marked file"))
1731 (message "(Wraparound for next marked file)")
1732 (goto-char (if (> arg
0) (point-min) (point-max)))
1733 (dired-next-marked-file arg nil opoint
))))
1735 (defun dired-prev-marked-file (arg &optional wrap
)
1736 "Move to the previous marked file, wrapping around the end of the buffer."
1737 (interactive "p\np")
1738 (dired-next-marked-file (- arg
) wrap
))
1740 (defun dired-file-marker (file)
1741 ;; Return FILE's marker, or nil if unmarked.
1743 (and (dired-goto-file file
)
1746 (if (not (equal ?
\040 (following-char)))
1747 (following-char))))))
1749 (defun dired-mark-files-in-region (start end
)
1750 (let (buffer-read-only)
1752 (error "start > end"))
1753 (goto-char start
) ; assumed at beginning of line
1754 (while (< (point) end
)
1755 ;; Skip subdir line and following garbage like the `total' line:
1756 (while (and (< (point) end
) (dired-between-files))
1758 (if (and (not (looking-at dired-re-dot
))
1759 (dired-get-filename nil t
))
1762 (insert dired-marker-char
)))
1765 (defun dired-mark (arg)
1766 "Mark the current (or next ARG) files.
1767 If on a subdir headerline, mark all its files except `.' and `..'.
1769 Use \\[dired-unmark-all-files] to remove all marks
1770 and \\[dired-unmark] on a subdir to remove the marks in
1773 (if (and (cdr dired-subdir-alist
) (dired-get-subdir))
1774 (save-excursion (dired-mark-subdir-files))
1775 (let (buffer-read-only)
1776 (dired-repeat-over-lines
1777 (prefix-numeric-value arg
)
1778 (function (lambda () (delete-char 1) (insert dired-marker-char
)))))))
1780 (defun dired-unmark (arg)
1781 "Unmark the current (or next ARG) files.
1782 If looking at a subdir, unmark all its files except `.' and `..'."
1784 (let ((dired-marker-char ?
\040))
1787 (defun dired-flag-file-deletion (arg)
1788 "In dired, flag the current line's file for deletion.
1789 With prefix arg, repeat over several lines.
1791 If on a subdir headerline, mark all its files except `.' and `..'."
1793 (let ((dired-marker-char dired-del-marker
))
1796 (defun dired-unmark-backward (arg)
1797 "In dired, move up lines and remove deletion flag there.
1798 Optional prefix ARG says how many lines to unflag; default is one line."
1800 (dired-unmark (- arg
)))
1802 ;;; Commands to mark or flag files based on their characteristics or names.
1804 (defvar dired-regexp-history nil
1805 "History list of regular expressions used in Dired commands.")
1807 (defun dired-read-regexp (prompt)
1808 (read-from-minibuffer prompt nil nil nil
'dired-regexp-history
))
1810 (defun dired-mark-files-regexp (regexp &optional marker-char
)
1811 "Mark all files matching REGEXP for use in later commands.
1812 A prefix argument means to unmark them instead.
1813 `.' and `..' are never marked.
1815 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
1816 object files--just `.o' will mark more than you might think."
1818 (list (dired-read-regexp (concat (if current-prefix-arg
"Unmark" "Mark")
1819 " files (regexp): "))
1820 (if current-prefix-arg ?
\040)))
1821 (let ((dired-marker-char (or marker-char dired-marker-char
)))
1823 (and (not (looking-at dired-re-dot
))
1824 (not (eolp)) ; empty line
1825 (let ((fn (dired-get-filename nil t
)))
1826 (and fn
(string-match regexp
(file-name-nondirectory fn
)))))
1829 (defun dired-flag-files-regexp (regexp)
1830 "In dired, flag all files containing the specified REGEXP for deletion.
1831 The match is against the non-directory part of the filename. Use `^'
1832 and `$' to anchor matches. Exclude subdirs by hiding them.
1833 `.' and `..' are never flagged."
1834 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
1835 (dired-mark-files-regexp regexp dired-del-marker
))
1837 (defun dired-mark-symlinks (unflag-p)
1838 "Mark all symbolic links.
1839 With prefix argument, unflag all those files."
1841 (let ((dired-marker-char (if unflag-p ?
\040 dired-marker-char
)))
1842 (dired-mark-if (looking-at dired-re-sym
) "symbolic link")))
1844 (defun dired-mark-directories (unflag-p)
1845 "Mark all directory file lines except `.' and `..'.
1846 With prefix argument, unflag all those files."
1848 (let ((dired-marker-char (if unflag-p ?
\040 dired-marker-char
)))
1849 (dired-mark-if (and (looking-at dired-re-dir
)
1850 (not (looking-at dired-re-dot
)))
1853 (defun dired-mark-executables (unflag-p)
1854 "Mark all executable files.
1855 With prefix argument, unflag all those files."
1857 (let ((dired-marker-char (if unflag-p ?
\040 dired-marker-char
)))
1858 (dired-mark-if (looking-at dired-re-exe
) "executable file")))
1860 ;; dired-x.el has a dired-mark-sexp interactive command: mark
1861 ;; files for which PREDICATE returns non-nil.
1863 (defun dired-flag-auto-save-files (&optional unflag-p
)
1864 "Flag for deletion files whose names suggest they are auto save files.
1865 A prefix argument says to unflag those files instead."
1867 (let ((dired-marker-char (if unflag-p ?
\040 dired-del-marker
)))
1869 ;; It is less than general to check for # here,
1870 ;; but it's the only way this runs fast enough.
1871 (and (save-excursion (end-of-line)
1873 (eq (preceding-char) ?
#)
1874 ;; Handle executables in case of -F option.
1875 ;; We need not worry about the other kinds
1876 ;; of markings that -F makes, since they won't
1877 ;; appear on real auto-save files.
1878 (if (eq (preceding-char) ?
*)
1881 (eq (preceding-char) ?
#)))))
1882 (not (looking-at dired-re-dir
))
1883 (let ((fn (dired-get-filename t t
)))
1884 (if fn
(auto-save-file-name-p
1885 (file-name-nondirectory fn
)))))
1888 (defun dired-flag-backup-files (&optional unflag-p
)
1889 "Flag all backup files (names ending with `~') for deletion.
1890 With prefix argument, unflag these files."
1892 (let ((dired-marker-char (if unflag-p ?
\040 dired-del-marker
)))
1894 ;; It is less than general to check for ~ here,
1895 ;; but it's the only way this runs fast enough.
1896 (and (save-excursion (end-of-line)
1898 (eq (preceding-char) ?~
)
1899 ;; Handle executables in case of -F option.
1900 ;; We need not worry about the other kinds
1901 ;; of markings that -F makes, since they won't
1902 ;; appear on real backup files.
1903 (if (eq (preceding-char) ?
*)
1906 (eq (preceding-char) ?~
)))))
1907 (not (looking-at dired-re-dir
))
1908 (let ((fn (dired-get-filename t t
)))
1909 (if fn
(backup-file-name-p fn
))))
1912 (defun dired-change-marks (&optional old new
)
1913 "Change all OLD marks to NEW marks.
1914 OLD and NEW are both characters used to mark files."
1916 (let* ((cursor-in-echo-area t
)
1917 (old (progn (message "Change (old mark): ") (read-char)))
1918 (new (progn (message "Change %c marks to (new mark): " old
)
1921 (if (or (eq old ?
\r) (eq new ?
\r))
1923 (let ((string (format "\n%c" old
))
1926 (goto-char (point-min))
1927 (while (search-forward string nil t
)
1928 (subst-char-in-region (match-beginning 0)
1929 (match-end 0) old new
))))))
1931 (defun dired-unmark-all-files-no-query ()
1932 "Remove all marks from all files in the Dired buffer."
1934 (dired-unmark-all-files ?
\r))
1936 (defun dired-unmark-all-files (mark &optional arg
)
1937 "Remove a specific mark (or any mark) from every file.
1938 After this command, type the mark character to remove,
1939 or type RET to remove all marks.
1940 With prefix arg, query for each marked file.
1941 Type \\[help-command] at that time for help."
1942 (interactive "cRemove marks (RET means all): \nP")
1945 buffer-read-only case-fold-search query
1946 (string (format "\n%c" mark
))
1948 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
1949 `!' to unmark all remaining files with no more questions."))
1950 (goto-char (point-min))
1951 (while (if (eq mark ?
\r)
1952 (re-search-forward dired-re-mark nil t
)
1953 (search-forward string nil t
))
1955 (dired-query 'query
"Unmark file `%s'? "
1956 (dired-get-filename t
)))
1957 (progn (subst-char-in-region (1- (point)) (point)
1958 (preceding-char) ?\
)
1959 (setq count
(1+ count
)))))
1960 (message (if (= count
1) "1 mark removed"
1964 ;; Logging failures operating on files, and showing the results.
1966 (defvar dired-log-buffer
"*Dired log*")
1969 "Pop up a buffer with error log output from Dired.
1970 A group of errors from a single command ends with a formfeed.
1971 Thus, use \\[backward-page] to find the beginning of a group of errors."
1973 (if (get-buffer dired-log-buffer
)
1974 (let ((owindow (selected-window))
1975 (window (display-buffer (get-buffer dired-log-buffer
))))
1978 (select-window window
)
1979 (goto-char (point-max))
1981 (select-window owindow
)))))
1983 (defun dired-log (log &rest args
)
1984 ;; Log a message or the contents of a buffer.
1985 ;; If LOG is a string and there are more args, it is formatted with
1986 ;; those ARGS. Usually the LOG string ends with a \n.
1987 ;; End each bunch of errors with (dired-log t): this inserts
1988 ;; current time and buffer, and a \f (formfeed).
1989 (let ((obuf (current-buffer)))
1990 (unwind-protect ; want to move point
1992 (set-buffer (get-buffer-create dired-log-buffer
))
1993 (goto-char (point-max))
1994 (let (buffer-read-only)
1995 (cond ((stringp log
)
1997 (apply (function format
) log args
)
2000 (insert-buffer log
))
2002 (insert "\n\t" (current-time-string)
2003 "\tBuffer `" (buffer-name obuf
) "'\n\f\n")))))
2004 (set-buffer obuf
))))
2006 (defun dired-log-summary (string failures
)
2007 (message (if failures
"%s--type ? for details (%s)"
2008 "%s--type ? for details")
2010 ;; Log a summary describing a bunch of errors.
2011 (dired-log (concat "\n" string
))
2016 ;; Most ls can only sort by name or by date (with -t), nothing else.
2017 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2018 ;; So anything that does not contain these is sort "by name".
2020 (defvar dired-ls-sorting-switches
"SXU"
2021 "String of `ls' switches (single letters) except `t' that influence sorting.")
2023 (defvar dired-sort-by-date-regexp
2024 (concat "^-[^" dired-ls-sorting-switches
2025 "]*t[^" dired-ls-sorting-switches
"]*$")
2026 "Regexp recognized by dired to set `by date' mode.")
2028 (defvar dired-sort-by-name-regexp
2029 (concat "^-[^t" dired-ls-sorting-switches
"]+$")
2030 "Regexp recognized by dired to set `by name' mode.")
2032 (defun dired-sort-set-modeline ()
2033 ;; Set modeline display according to dired-actual-switches.
2034 ;; Modeline display of "by name" or "by date" guarantees the user a
2035 ;; match with the corresponding regexps. Non-matching switches are
2038 (let (case-fold-search)
2039 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches
)
2041 ((string-match dired-sort-by-date-regexp dired-actual-switches
)
2044 (concat "Dired " dired-actual-switches
)))))
2045 ;; update mode line:
2046 (set-buffer-modified-p (buffer-modified-p)))
2048 (defun dired-sort-toggle-or-edit (&optional arg
)
2049 "Toggle between sort by date/name and refresh the dired buffer.
2050 With a prefix argument you can edit the current listing switches instead."
2054 (read-string "ls switches (must contain -l): " dired-actual-switches
))
2055 (dired-sort-toggle)))
2057 (defun dired-sort-toggle ()
2058 ;; Toggle between sort by date/name. Reverts the buffer.
2059 (setq dired-actual-switches
2060 (let (case-fold-search)
2063 (dired-replace-in-string (concat "[---lt"
2064 dired-ls-sorting-switches
"]")
2066 dired-actual-switches
)
2067 (if (string-match (concat "[t" dired-ls-sorting-switches
"]")
2068 dired-actual-switches
)
2071 (dired-sort-set-modeline)
2074 (defun dired-replace-in-string (regexp newtext string
)
2075 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2076 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2077 (let ((result "") (start 0) mb me
)
2078 (while (string-match regexp string start
)
2079 (setq mb
(match-beginning 0)
2081 result
(concat result
(substring string start mb
) newtext
)
2083 (concat result
(substring string start
))))
2085 (defun dired-sort-other (switches &optional no-revert
)
2086 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2087 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2088 ;; minor mode accordingly, others appear literally in the mode line.
2089 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2090 (setq dired-actual-switches switches
)
2091 (dired-sort-set-modeline)
2092 (or no-revert
(revert-buffer)))
2094 ;; To make this file smaller, the less common commands
2095 ;; go in a separate file. But autoload them here
2096 ;; to make the separation invisible.
2098 (autoload 'dired-diff
"dired-aux"
2099 "Compare file at point with file FILE using `diff'.
2100 FILE defaults to the file at the mark.
2101 The prompted-for file is the first file given to `diff'."
2104 (autoload 'dired-backup-diff
"dired-aux"
2105 "Diff this file with its backup file or vice versa.
2106 Uses the latest backup, if there are several numerical backups.
2107 If this file is a backup, diff it with its original.
2108 The backup file is the first file given to `diff'."
2111 (autoload 'dired-clean-directory
"dired-aux"
2112 "Flag numerical backups for deletion.
2113 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2114 Positive prefix arg KEEP overrides `dired-kept-versions';
2115 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2117 To clear the flags on these files, you can use \\[dired-flag-backup-files]
2118 with a prefix argument."
2121 (autoload 'dired-do-chmod
"dired-aux"
2122 "Change the mode of the marked (or next ARG) files.
2123 This calls chmod, thus symbolic modes like `g+w' are allowed."
2126 (autoload 'dired-do-chgrp
"dired-aux"
2127 "Change the group of the marked (or next ARG) files."
2130 (autoload 'dired-do-chown
"dired-aux"
2131 "Change the owner of the marked (or next ARG) files."
2134 (autoload 'dired-do-print
"dired-aux"
2135 "Print the marked (or next ARG) files.
2136 Uses the shell command coming from variables `lpr-command' and
2137 `lpr-switches' as default."
2140 (autoload 'dired-do-shell-command
"dired-aux"
2141 "Run a shell command COMMAND on the marked files.
2142 If no files are marked or a specific numeric prefix arg is given,
2143 the next ARG files are used. Just \\[universal-argument] means the current file.
2144 The prompt mentions the file(s) or the marker, as appropriate.
2146 If there is output, it goes to a separate buffer.
2148 Normally the command is run on each file individually.
2149 However, if there is a `*' in the command then it is run
2150 just once with the entire file list substituted there.
2152 No automatic redisplay of dired buffers is attempted, as there's no
2153 telling what files the command may have changed. Type
2154 \\[dired-do-redisplay] to redisplay the marked files.
2156 The shell command has the top level directory as working directory, so
2157 output files usually are created there instead of in a subdir."
2160 (autoload 'dired-do-kill-lines
"dired-aux"
2161 "Kill all marked lines (not the files).
2162 With a prefix arg, kill all lines not marked or flagged."
2165 (autoload 'dired-do-compress
"dired-aux"
2166 "Compress or uncompress marked (or next ARG) files."
2169 (autoload 'dired-do-byte-compile
"dired-aux"
2170 "Byte compile marked (or next ARG) Emacs Lisp files."
2173 (autoload 'dired-do-load
"dired-aux"
2174 "Load the marked (or next ARG) Emacs Lisp files."
2177 (autoload 'dired-do-redisplay
"dired-aux"
2178 "Redisplay all marked (or next ARG) files.
2179 If on a subdir line, redisplay that subdirectory. In that case,
2180 a prefix arg lets you edit the `ls' switches used for the new listing."
2183 (autoload 'dired-string-replace-match
"dired-aux"
2184 "Replace first match of REGEXP in STRING with NEWTEXT.
2185 If it does not match, nil is returned instead of the new string.
2186 Optional arg LITERAL means to take NEWTEXT literally.
2187 Optional arg GLOBAL means to replace all matches."
2190 (autoload 'dired-create-directory
"dired-aux"
2191 "Create a directory called DIRECTORY."
2194 (autoload 'dired-do-copy
"dired-aux"
2195 "Copy all marked (or next ARG) files, or copy the current file.
2196 Thus, a zero prefix argument copies nothing. But it toggles the
2197 variable `dired-copy-preserve-time' (which see)."
2200 (autoload 'dired-do-symlink
"dired-aux"
2201 "Make symbolic links to current file or all marked (or next ARG) files.
2202 When operating on just the current file, you specify the new name.
2203 When operating on multiple or marked files, you specify a directory
2204 and new symbolic links are made in that directory
2205 with the same names that the files currently have."
2208 (autoload 'dired-do-hardlink
"dired-aux"
2209 "Add names (hard links) current file or all marked (or next ARG) files.
2210 When operating on just the current file, you specify the new name.
2211 When operating on multiple or marked files, you specify a directory
2212 and new hard links are made in that directory
2213 with the same names that the files currently have."
2216 (autoload 'dired-do-rename
"dired-aux"
2217 "Rename current file or all marked (or next ARG) files.
2218 When renaming just the current file, you specify the new name.
2219 When renaming multiple or marked files, you specify a directory."
2222 (autoload 'dired-do-rename-regexp
"dired-aux"
2223 "Rename marked files containing REGEXP to NEWNAME.
2224 As each match is found, the user must type a character saying
2225 what to do with it. For directions, type \\[help-command] at that time.
2226 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2227 REGEXP defaults to the last regexp used.
2228 With a zero prefix arg, renaming by regexp affects the complete
2229 pathname - usually only the non-directory part of file names is used
2233 (autoload 'dired-do-copy-regexp
"dired-aux"
2234 "Copy all marked files containing REGEXP to NEWNAME.
2235 See function `dired-rename-regexp' for more info."
2238 (autoload 'dired-do-hardlink-regexp
"dired-aux"
2239 "Hardlink all marked files containing REGEXP to NEWNAME.
2240 See function `dired-rename-regexp' for more info."
2243 (autoload 'dired-do-symlink-regexp
"dired-aux"
2244 "Symlink all marked files containing REGEXP to NEWNAME.
2245 See function `dired-rename-regexp' for more info."
2248 (autoload 'dired-upcase
"dired-aux"
2249 "Rename all marked (or next ARG) files to upper case."
2252 (autoload 'dired-downcase
"dired-aux"
2253 "Rename all marked (or next ARG) files to lower case."
2256 (autoload 'dired-maybe-insert-subdir
"dired-aux"
2257 "Insert this subdirectory into the same dired buffer.
2258 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2259 else inserts it at its natural place (as `ls -lR' would have done).
2260 With a prefix arg, you may edit the ls switches used for this listing.
2261 You can add `R' to the switches to expand the whole tree starting at
2263 This function takes some pains to conform to `ls -lR' output."
2266 (autoload 'dired-next-subdir
"dired-aux"
2267 "Go to next subdirectory, regardless of level."
2270 (autoload 'dired-prev-subdir
"dired-aux"
2271 "Go to previous subdirectory, regardless of level.
2272 When called interactively and not on a subdir line, go to this subdir's line."
2275 (autoload 'dired-goto-subdir
"dired-aux"
2276 "Go to end of header line of DIR in this dired buffer.
2277 Return value of point on success, otherwise return nil.
2278 The next char is either \\n, or \\r if DIR is hidden."
2281 (autoload 'dired-mark-subdir-files
"dired-aux"
2282 "Mark all files except `.' and `..'."
2285 (autoload 'dired-kill-subdir
"dired-aux"
2286 "Remove all lines of current subdirectory.
2287 Lower levels are unaffected."
2290 (autoload 'dired-tree-up
"dired-aux"
2291 "Go up ARG levels in the dired tree."
2294 (autoload 'dired-tree-down
"dired-aux"
2295 "Go down in the dired tree."
2298 (autoload 'dired-hide-subdir
"dired-aux"
2299 "Hide or unhide the current subdirectory and move to next directory.
2300 Optional prefix arg is a repeat factor.
2301 Use \\[dired-hide-all] to (un)hide all directories."
2304 (autoload 'dired-hide-all
"dired-aux"
2305 "Hide all subdirectories, leaving only their header lines.
2306 If there is already something hidden, make everything visible again.
2307 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2310 (if (eq system-type
'vax-vms
)
2315 (run-hooks 'dired-load-hook
) ; for your customizations
2317 ;;; dired.el ends here