(dired-noselect): Avoid calling file-directory-p
[emacs.git] / lisp / dired.el
blob3792af9727adc4a267c7bca9d43b39ca647fc793
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
5 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
6 ;; Maintainer: FSF
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)
13 ;; any later version.
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 the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; This is a major mode for directory browsing and editing. It is
28 ;; documented in the Emacs manual.
30 ;; Rewritten in 1990/1991 to add tree features, file marking and
31 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
32 ;; Finished up by rms in 1992.
34 ;;; Code:
36 ;;; Customizable variables
38 ;;;###autoload
39 (defvar dired-listing-switches "-al"
40 "*Switches passed to `ls' for dired. MUST contain the `l' option.
41 May contain all other options that don't contradict `-l';
42 may contain even `F', `b', `i' and `s'. See also the variable
43 `dired-ls-F-marks-symlinks' concerning the `F' switch.")
45 ; Don't use absolute paths as /bin should be in any PATH and people
46 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
47 ; usually not in PATH.
49 ;;;###autoload
50 (defvar dired-chown-program
51 (if (memq system-type '(hpux dgux usg-unix-v irix linux gnu/linux))
52 "chown"
53 (if (file-exists-p "/usr/sbin/chown")
54 "/usr/sbin/chown"
55 "/etc/chown"))
56 "Name of chown command (usually `chown' or `/etc/chown').")
58 (defvar dired-chmod-program
59 (if (eq system-type 'windows-nt)
60 "chmode" "chmod")
61 "Name of chmod command (usually `chmod' or `chmode').")
63 ;;;###autoload
64 (defvar dired-ls-F-marks-symlinks nil
65 "*Informs dired about how `ls -lF' marks symbolic links.
66 Set this to t if `ls' (or whatever program is specified by
67 `insert-directory-program') with `-lF' marks the symbolic link
68 itself with a trailing @ (usually the case under Ultrix).
70 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
71 nil (the default), if it gives `bar@ -> foo', set it to t.
73 Dired checks if there is really a @ appended. Thus, if you have a
74 marking `ls' program on one host and a non-marking on another host, and
75 don't care about symbolic links which really end in a @, you can
76 always set this variable to t.")
78 ;;;###autoload
79 (defvar dired-trivial-filenames "^\\.\\.?$\\|^#"
80 "*Regexp of files to skip when finding first file of a directory.
81 A value of nil means move to the subdir line.
82 A value of t means move to first file.")
84 ;;;###autoload
85 (defvar dired-keep-marker-rename t
86 ;; Use t as default so that moved files "take their markers with them".
87 "*Controls marking of renamed files.
88 If t, files keep their previous marks when they are renamed.
89 If a character, renamed files (whether previously marked or not)
90 are afterward marked with that character.")
92 ;;;###autoload
93 (defvar dired-keep-marker-copy ?C
94 "*Controls marking of copied files.
95 If t, copied files are marked if and as the corresponding original files were.
96 If a character, copied files are unconditionally marked with that character.")
98 ;;;###autoload
99 (defvar dired-keep-marker-hardlink ?H
100 "*Controls marking of newly made hard links.
101 If t, they are marked if and as the files linked to were marked.
102 If a character, new links are unconditionally marked with that character.")
104 ;;;###autoload
105 (defvar dired-keep-marker-symlink ?Y
106 "*Controls marking of newly made symbolic links.
107 If t, they are marked if and as the files linked to were marked.
108 If a character, new links are unconditionally marked with that character.")
110 ;;;###autoload
111 (defvar dired-dwim-target nil
112 "*If non-nil, dired tries to guess a default target directory.
113 This means: if there is a dired buffer displayed in the next window,
114 use its current subdir, instead of the current subdir of this dired buffer.
116 The target is used in the prompt for file copy, rename etc.")
118 ;;;###autoload
119 (defvar dired-copy-preserve-time t
120 "*If non-nil, Dired preserves the last-modified time in a file copy.
121 \(This works on only some systems.)")
123 ;;; Hook variables
125 (defvar dired-load-hook nil
126 "Run after loading dired.
127 You can customize key bindings or load extensions with this.")
129 (defvar dired-mode-hook nil
130 "Run at the very end of dired-mode.")
132 (defvar dired-before-readin-hook nil
133 "This hook is run before a dired buffer is read in (created or reverted).")
135 (defvar dired-after-readin-hook nil
136 "Hook run after each time a file or directory is read by Dired.
137 After each listing of a file or directory, this hook is run
138 with the buffer narrowed to the listing.")
139 ;; Note this can't simply be run inside function `dired-ls' as the hook
140 ;; functions probably depend on the dired-subdir-alist to be OK.
142 ;;; Internal variables
144 (defvar dired-marker-char ?* ; the answer is 42
145 ;; so that you can write things like
146 ;; (let ((dired-marker-char ?X))
147 ;; ;; great code using X markers ...
148 ;; )
149 ;; For example, commands operating on two sets of files, A and B.
150 ;; Or marking files with digits 0-9. This could implicate
151 ;; concentric sets or an order for the marked files.
152 ;; The code depends on dynamic scoping on the marker char.
153 "In Dired, the current mark character.
154 This is what the `do' commands look for and what the `mark' commands store.")
156 (defvar dired-del-marker ?D
157 "Character used to flag files for deletion.")
159 (defvar dired-shrink-to-fit
161 ;; I see no reason ever to make this nil -- rms.
162 ;; (> baud-rate search-slow-speed)
163 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
165 (defvar dired-flagging-regexp nil);; Last regexp used to flag files.
167 (defvar dired-file-version-alist)
169 (defvar dired-directory nil
170 "The directory name or shell wildcard that was used as argument to `ls'.
171 Local to each dired buffer. May be a list, in which case the car is the
172 directory name and the cdr is the actual files to list.")
174 (defvar dired-actual-switches nil
175 "The value of `dired-listing-switches' used to make this buffer's text.")
177 (defvar dired-re-inode-size "[0-9 \t]*"
178 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
180 ;; These regexps must be tested at beginning-of-line, but are also
181 ;; used to search for next matches, so neither omitting "^" nor
182 ;; replacing "^" by "\n" (to make it slightly faster) will work.
184 (defvar dired-re-mark "^[^ \n]")
185 ;; "Regexp matching a marked line.
186 ;; Important: the match ends just after the marker."
187 (defvar dired-re-maybe-mark "^. ")
188 (defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d"))
189 (defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l"))
190 (defvar dired-re-exe;; match ls permission string of an executable file
191 (mapconcat (function
192 (lambda (x)
193 (concat dired-re-maybe-mark dired-re-inode-size x)))
194 '("-[-r][-w][xs][-r][-w].[-r][-w]."
195 "-[-r][-w].[-r][-w][xs][-r][-w]."
196 "-[-r][-w].[-r][-w].[-r][-w][xst]")
197 "\\|"))
198 (defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
199 (defvar dired-re-dot "^.* \\.\\.?$")
201 ;; The subdirectory names in this list are expanded.
202 (defvar dired-subdir-alist nil
203 "Association list of subdirectories and their buffer positions.
204 Each subdirectory has an element: (DIRNAME . STARTMARKER).
205 The order of elements is the reverse of the order in the buffer.
206 In simple cases, this list contains one element.")
208 (defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
209 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
210 Subexpression 1 is the subdirectory proper, no trailing colon.
211 The match starts at the beginning of the line and ends after the end
212 of the line (\\n or \\r).
213 Subexpression 2 must end right before the \\n or \\r.")
215 (defvar dired-font-lock-keywords
216 (list
218 ;; Directory headers.
219 (list dired-subdir-regexp '(1 font-lock-type-face))
221 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
222 ;; file name itself. We search for Dired defined regexps, and then use the
223 ;; Dired defined function `dired-move-to-filename' before searching for the
224 ;; simple regexp ".+". It is that regexp which matches the file name.
226 ;; Dired marks.
227 (list dired-re-mark
228 '(0 font-lock-reference-face)
229 '(".+" (dired-move-to-filename) nil (0 font-lock-warning-face)))
231 ;; Files that are group or world writable.
232 (list (concat dired-re-maybe-mark dired-re-inode-size
233 "\\([-d]\\(....w....\\|.......w.\\)\\)")
234 '(1 font-lock-comment-face)
235 '(".+" (dired-move-to-filename) nil (0 font-lock-comment-face)))
237 ;; Subdirectories.
238 (list dired-re-dir
239 '(".+" (dired-move-to-filename) nil (0 font-lock-function-name-face)))
241 ;; Symbolic links.
242 (list dired-re-sym
243 '(".+" (dired-move-to-filename) nil (0 font-lock-keyword-face)))
245 ;; Files suffixed with `completion-ignored-extensions'.
246 '(eval .
247 (let ((extensions (mapcar 'regexp-quote completion-ignored-extensions)))
248 ;; It is quicker to first find just an extension, then go back to the
249 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
250 (list (concat "\\(" (mapconcat 'identity extensions "\\|") "\\|#\\)$")
251 '(".+" (dired-move-to-filename) nil (0 font-lock-string-face))))))
252 "Additional expressions to highlight in Dired mode.")
254 ;;; Macros must be defined before they are used, for the byte compiler.
256 ;; Mark all files for which CONDITION evals to non-nil.
257 ;; CONDITION is evaluated on each line, with point at beginning of line.
258 ;; MSG is a noun phrase for the type of files being marked.
259 ;; It should end with a noun that can be pluralized by adding `s'.
260 ;; Return value is the number of files marked, or nil if none were marked.
261 (defmacro dired-mark-if (predicate msg)
262 (` (let (buffer-read-only count)
263 (save-excursion
264 (setq count 0)
265 (if (, msg) (message "Marking %ss..." (, msg)))
266 (goto-char (point-min))
267 (while (not (eobp))
268 (if (, predicate)
269 (progn
270 (delete-char 1)
271 (insert dired-marker-char)
272 (setq count (1+ count))))
273 (forward-line 1))
274 (if (, msg) (message "%s %s%s %s%s."
275 count
276 (, msg)
277 (dired-plural-s count)
278 (if (eq dired-marker-char ?\040) "un" "")
279 (if (eq dired-marker-char dired-del-marker)
280 "flagged" "marked"))))
281 (and (> count 0) count))))
283 (defmacro dired-map-over-marks (body arg &optional show-progress)
284 ;; "Macro: Perform BODY with point somewhere on each marked line
285 ;;and return a list of BODY's results.
286 ;;If no marked file could be found, execute BODY on the current line.
287 ;; If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
288 ;; files instead of the marked files.
289 ;; In that case point is dragged along. This is so that commands on
290 ;; the next ARG (instead of the marked) files can be chained easily.
291 ;; If ARG is otherwise non-nil, use current file instead.
292 ;;If optional third arg SHOW-PROGRESS evaluates to non-nil,
293 ;; redisplay the dired buffer after each file is processed.
294 ;;No guarantee is made about the position on the marked line.
295 ;; BODY must ensure this itself if it depends on this.
296 ;;Search starts at the beginning of the buffer, thus the car of the list
297 ;; corresponds to the line nearest to the buffer's bottom. This
298 ;; is also true for (positive and negative) integer values of ARG.
299 ;;BODY should not be too long as it is expanded four times."
301 ;;Warning: BODY must not add new lines before point - this may cause an
302 ;;endless loop.
303 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
304 (` (prog1
305 (let (buffer-read-only case-fold-search found results)
306 (if (, arg)
307 (if (integerp (, arg))
308 (progn;; no save-excursion, want to move point.
309 (dired-repeat-over-lines
310 (, arg)
311 (function (lambda ()
312 (if (, show-progress) (sit-for 0))
313 (setq results (cons (, body) results)))))
314 (if (< (, arg) 0)
315 (nreverse results)
316 results))
317 ;; non-nil, non-integer ARG means use current file:
318 (list (, body)))
319 (let ((regexp (dired-marker-regexp)) next-position)
320 (save-excursion
321 (goto-char (point-min))
322 ;; remember position of next marked file before BODY
323 ;; can insert lines before the just found file,
324 ;; confusing us by finding the same marked file again
325 ;; and again and...
326 (setq next-position (and (re-search-forward regexp nil t)
327 (point-marker))
328 found (not (null next-position)))
329 (while next-position
330 (goto-char next-position)
331 (if (, show-progress) (sit-for 0))
332 (setq results (cons (, body) results))
333 ;; move after last match
334 (goto-char next-position)
335 (forward-line 1)
336 (set-marker next-position nil)
337 (setq next-position (and (re-search-forward regexp nil t)
338 (point-marker)))))
339 (if found
340 results
341 (list (, body))))))
342 ;; save-excursion loses, again
343 (dired-move-to-filename))))
345 (defun dired-get-marked-files (&optional localp arg)
346 "Return the marked files' names as list of strings.
347 The list is in the same order as the buffer, that is, the car is the
348 first marked file.
349 Values returned are normally absolute pathnames.
350 Optional arg LOCALP as in `dired-get-filename'.
351 Optional second argument ARG forces to use other files. If ARG is an
352 integer, use the next ARG files. If ARG is otherwise non-nil, use
353 current file. Usually ARG comes from the current prefix arg."
354 (save-excursion
355 (nreverse (dired-map-over-marks (dired-get-filename localp) arg))))
358 ;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
359 ;; other special applications.
361 ;; The dired command
363 (defun dired-read-dir-and-switches (str)
364 ;; For use in interactive.
365 (reverse (list
366 (if current-prefix-arg
367 (read-string "Dired listing switches: "
368 dired-listing-switches))
369 (read-file-name (format "Dired %s(directory): " str)
370 nil default-directory nil))))
372 ;;;###autoload (define-key ctl-x-map "d" 'dired)
373 ;;;###autoload
374 (defun dired (dirname &optional switches)
375 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
376 Optional second argument SWITCHES specifies the `ls' options used.
377 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
378 Dired displays a list of files in DIRNAME (which may also have
379 shell wildcards appended to select certain files). If DIRNAME is a cons,
380 its first element is taken as the directory name and the rest as an explicit
381 list of files to make directory entries for.
382 \\<dired-mode-map>\
383 You can move around in it with the usual commands.
384 You can flag files for deletion with \\[dired-flag-file-deletion] and then
385 delete them by typing \\[dired-do-flagged-delete].
386 Type \\[describe-mode] after entering dired for more info.
388 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
389 ;; Cannot use (interactive "D") because of wildcards.
390 (interactive (dired-read-dir-and-switches ""))
391 (switch-to-buffer (dired-noselect dirname switches)))
393 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
394 ;;;###autoload
395 (defun dired-other-window (dirname &optional switches)
396 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
397 (interactive (dired-read-dir-and-switches "in other window "))
398 (switch-to-buffer-other-window (dired-noselect dirname switches)))
400 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
401 ;;;###autoload
402 (defun dired-other-frame (dirname &optional switches)
403 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
404 (interactive (dired-read-dir-and-switches "in other frame "))
405 (switch-to-buffer-other-frame (dired-noselect dirname switches)))
407 ;;;###autoload
408 (defun dired-noselect (dir-or-list &optional switches)
409 "Like `dired' but returns the dired buffer as value, does not select it."
410 (or dir-or-list (setq dir-or-list default-directory))
411 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
412 ;; some shells make:
413 (let (dirname initially-was-dirname)
414 (if (consp dir-or-list)
415 (setq dirname (car dir-or-list))
416 (setq dirname dir-or-list))
417 (setq initially-was-dirname
418 (string= (file-name-as-directory dirname) dirname))
419 (setq dirname (abbreviate-file-name
420 (expand-file-name (directory-file-name dirname))))
421 (if find-file-visit-truename
422 (setq dirname (file-truename dirname)))
423 ;; If the argument was syntactically a directory name not a file name,
424 ;; or if it happens to name a file that is a directory,
425 ;; convert it syntactically to a directory name.
426 ;; The reason for checking initially-was-dirname
427 ;; and not just file-directory-p
428 ;; is that file-directory-p is slow over ftp.
429 (if (or initially-was-dirname (file-directory-p dirname))
430 (setq dirname (file-name-as-directory dirname)))
431 (if (consp dir-or-list)
432 (setq dir-or-list (cons dirname (cdr dir-or-list)))
433 (setq dir-or-list dirname))
434 (dired-internal-noselect dir-or-list switches)))
436 ;; Separate function from dired-noselect for the sake of dired-vms.el.
437 (defun dired-internal-noselect (dir-or-list &optional switches mode)
438 ;; If there is an existing dired buffer for DIRNAME, just leave
439 ;; buffer as it is (don't even call dired-revert).
440 ;; This saves time especially for deep trees or with ange-ftp.
441 ;; The user can type `g'easily, and it is more consistent with find-file.
442 ;; But if SWITCHES are given they are probably different from the
443 ;; buffer's old value, so call dired-sort-other, which does
444 ;; revert the buffer.
445 ;; A pity we can't possibly do "Directory has changed - refresh? "
446 ;; like find-file does.
447 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
448 ;; see there.
449 (let* ((dirname (if (consp dir-or-list) (car dir-or-list) dir-or-list))
450 ;; The following line used to use dir-or-list.
451 ;; That never found an existing buffer, in the case
452 ;; where it is a list.
453 (buffer (dired-find-buffer-nocreate dirname mode))
454 ;; note that buffer already is in dired-mode, if found
455 (new-buffer-p (not buffer))
456 (old-buf (current-buffer)))
457 (or buffer
458 (let ((default-major-mode 'fundamental-mode))
459 ;; We don't want default-major-mode to run hooks and set auto-fill
460 ;; or whatever, now that dired-mode does not
461 ;; kill-all-local-variables any longer.
462 (setq buffer (create-file-buffer (directory-file-name dirname)))))
463 (set-buffer buffer)
464 (if (not new-buffer-p) ; existing buffer ...
465 (cond (switches ; ... but new switches
466 ;; file list may have changed
467 (if (consp dir-or-list)
468 (setq dired-directory dir-or-list))
469 ;; this calls dired-revert
470 (dired-sort-other switches))
471 ;; If directory has changed on disk, offer to revert.
472 ((if (let ((attributes (file-attributes dirname))
473 (modtime (visited-file-modtime)))
474 (or (eq modtime 0)
475 (not (eq (car attributes) t))
476 (and (= (car (nth 5 attributes)) (car modtime))
477 (= (nth 1 (nth 5 attributes)) (cdr modtime)))))
479 (message "%s"
480 (substitute-command-keys
481 "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
482 ;; Else a new buffer
483 (setq default-directory
484 (if (file-directory-p dirname)
485 dirname
486 (file-name-directory dirname)))
487 (or switches (setq switches dired-listing-switches))
488 (dired-mode dirname switches)
489 (if mode (funcall mode))
490 ;; default-directory and dired-actual-switches are set now
491 ;; (buffer-local), so we can call dired-readin:
492 (let ((failed t))
493 (unwind-protect
494 (progn (dired-readin dir-or-list buffer)
495 (setq failed nil))
496 ;; dired-readin can fail if parent directories are inaccessible.
497 ;; Don't leave an empty buffer around in that case.
498 (if failed (kill-buffer buffer))))
499 ;; No need to narrow since the whole buffer contains just
500 ;; dired-readin's output, nothing else. The hook can
501 ;; successfully use dired functions (e.g. dired-get-filename)
502 ;; as the subdir-alist has been built in dired-readin.
503 (run-hooks 'dired-after-readin-hook)
504 (goto-char (point-min))
505 (dired-initial-position dirname))
506 (set-buffer old-buf)
507 buffer))
509 (defun dired-find-buffer-nocreate (dirname &optional mode)
510 ;; This differs from dired-buffers-for-dir in that it does not consider
511 ;; subdirs of default-directory and searches for the first match only.
512 ;; Also, the major mode must be MODE.
513 (let (found (blist dired-buffers)) ; was (buffer-list)
514 (or mode (setq mode 'dired-mode))
515 (while blist
516 (if (null (buffer-name (cdr (car blist))))
517 (setq blist (cdr blist))
518 (save-excursion
519 (set-buffer (cdr (car blist)))
520 (if (and (eq major-mode mode)
521 (if (consp dired-directory)
522 (equal (car dired-directory) dirname)
523 (equal dired-directory dirname)))
524 (setq found (cdr (car blist))
525 blist nil)
526 (setq blist (cdr blist))))))
527 found))
530 ;; Read in a new dired buffer
532 ;; dired-readin differs from dired-insert-subdir in that it accepts
533 ;; wildcards, erases the buffer, and builds the subdir-alist anew
534 ;; (including making it buffer-local and clearing it first).
535 (defun dired-readin (dir-or-list buffer)
536 ;; default-directory and dired-actual-switches must be buffer-local
537 ;; and initialized by now.
538 ;; Thus we can test (equal default-directory dirname) instead of
539 ;; (file-directory-p dirname) and save a filesystem transaction.
540 ;; Also, we can run this hook which may want to modify the switches
541 ;; based on default-directory, e.g. with ange-ftp to a SysV host
542 ;; where ls won't understand -Al switches.
543 (let (dirname)
544 (if (consp dir-or-list)
545 (setq dirname (car dir-or-list))
546 (setq dirname dir-or-list))
547 (setq dirname (expand-file-name dirname))
548 (if (consp dir-or-list)
549 (setq dir-or-list (cons dirname (cdr dir-or-list))))
550 (run-hooks 'dired-before-readin-hook)
551 (save-excursion
552 (message "Reading directory %s..." dirname)
553 (set-buffer buffer)
554 (let (buffer-read-only (failed t))
555 (widen)
556 (erase-buffer)
557 (dired-readin-insert dir-or-list)
558 (indent-rigidly (point-min) (point-max) 2)
559 ;; We need this to make the root dir have a header line as all
560 ;; other subdirs have:
561 (goto-char (point-min))
562 (dired-insert-headerline default-directory)
563 ;; can't run dired-after-readin-hook here, it may depend on the subdir
564 ;; alist to be OK.
566 (message "Reading directory %s...done" dirname)
567 ;; Must first make alist buffer local and set it to nil because
568 ;; dired-build-subdir-alist will call dired-clear-alist first
569 (set (make-local-variable 'dired-subdir-alist) nil)
570 (dired-build-subdir-alist)
571 (let ((attributes (file-attributes dirname)))
572 (if (eq (car attributes) t)
573 (set-visited-file-modtime (nth 5 attributes))))
574 (set-buffer-modified-p nil))))
576 ;; Subroutines of dired-readin
578 (defun dired-readin-insert (dir-or-list)
579 ;; Just insert listing for the passed-in directory or
580 ;; directory-and-file list, assuming a clean buffer.
581 (let (dirname)
582 (if (consp dir-or-list)
583 (setq dirname (car dir-or-list))
584 (setq dirname dir-or-list))
585 ;; Expand before comparing in case one or both have been abbreviated.
586 (if (and (equal (expand-file-name default-directory)
587 (expand-file-name dirname))
588 (not (consp dir-or-list)))
589 ;; If we are reading a whole single directory...
590 (dired-insert-directory dir-or-list dired-actual-switches nil t)
591 (if (not (file-readable-p
592 (directory-file-name (file-name-directory dirname))))
593 (error "Directory %s inaccessible or nonexistent" dirname)
594 ;; Else assume it contains wildcards,
595 ;; unless it is an explicit list of files.
596 (dired-insert-directory dir-or-list dired-actual-switches
597 (not (listp dir-or-list)))
598 (save-excursion ;; insert wildcard instead of total line:
599 (goto-char (point-min))
600 (insert "wildcard " (file-name-nondirectory dirname) "\n"))))))
602 (defun dired-insert-directory (dir-or-list switches &optional wildcard full-p)
603 ;; Do the right thing whether dir-or-list is atomic or not. If it is,
604 ;; inset all files listed in the cdr (the car is the passed-in directory
605 ;; list).
606 (let ((opoint (point))
607 (process-environment (copy-sequence process-environment))
608 end)
609 ;; We used to specify the C locale here, to force English month names;
610 ;; but this should not be necessary any more,
611 ;; with the new value of dired-move-to-filename-regexp.
612 (if (consp dir-or-list)
613 ;; In this case, use the file names in the cdr
614 ;; exactly as originally given to dired-noselect.
615 (mapcar
616 (function (lambda (x) (insert-directory x switches wildcard full-p)))
617 (cdr dir-or-list))
618 ;; Expand the file name here because it may have been abbreviated
619 ;; in dired-noselect.
620 (insert-directory (expand-file-name dir-or-list) switches wildcard full-p))
621 ;; Quote certain characters, unless ls quoted them for us.
622 (if (not (string-match "b" dired-actual-switches))
623 (save-excursion
624 (setq end (point-marker))
625 (goto-char opoint)
626 (while (search-forward "\\" end t)
627 (replace-match "\\\\" nil t))
628 (goto-char opoint)
629 (while (search-forward "\^m" end t)
630 (replace-match "\\015" nil t))
631 (set-marker end nil)))
632 (dired-insert-set-properties opoint (point)))
633 (setq dired-directory dir-or-list))
635 ;; Make the file names highlight when the mouse is on them.
636 (defun dired-insert-set-properties (beg end)
637 (save-excursion
638 (goto-char beg)
639 (while (< (point) end)
640 (condition-case nil
641 (if (dired-move-to-filename)
642 (put-text-property (point)
643 (save-excursion
644 (dired-move-to-end-of-filename)
645 (point))
646 'mouse-face 'highlight))
647 (error nil))
648 (forward-line 1))))
650 (defun dired-insert-headerline (dir);; also used by dired-insert-subdir
651 ;; Insert DIR's headerline with no trailing slash, exactly like ls
652 ;; would, and put cursor where dired-build-subdir-alist puts subdir
653 ;; boundaries.
654 (save-excursion (insert " " (directory-file-name dir) ":\n")))
657 ;; Reverting a dired buffer
659 (defun dired-revert (&optional arg noconfirm)
660 ;; Reread the dired buffer. Must also be called after
661 ;; dired-actual-switches have changed.
662 ;; Should not fail even on completely garbaged buffers.
663 ;; Preserves old cursor, marks/flags, hidden-p.
664 (widen) ; just in case user narrowed
665 (let ((opoint (point))
666 (ofile (dired-get-filename nil t))
667 (mark-alist nil) ; save marked files
668 (hidden-subdirs (dired-remember-hidden))
669 (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
670 (case-fold-search nil) ; we check for upper case ls flags
671 buffer-read-only)
672 (goto-char (point-min))
673 (setq mark-alist;; only after dired-remember-hidden since this unhides:
674 (dired-remember-marks (point-min) (point-max)))
675 ;; treat top level dir extra (it may contain wildcards)
676 (dired-uncache
677 (if (consp dired-directory) (car dired-directory) dired-directory))
678 (dired-readin dired-directory (current-buffer))
679 (let ((dired-after-readin-hook nil))
680 ;; don't run that hook for each subdir...
681 (dired-insert-old-subdirs old-subdir-alist))
682 (dired-mark-remembered mark-alist) ; mark files that were marked
683 ;; ... run the hook for the whole buffer, and only after markers
684 ;; have been reinserted (else omitting in dired-x would omit marked files)
685 (run-hooks 'dired-after-readin-hook) ; no need to narrow
686 (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
687 (goto-char opoint)) ; was before
688 (dired-move-to-filename)
689 (save-excursion ; hide subdirs that were hidden
690 (mapcar (function (lambda (dir)
691 (if (dired-goto-subdir dir)
692 (dired-hide-subdir 1))))
693 hidden-subdirs)))
694 ;; outside of the let scope
695 ;;; Might as well not override the user if the user changed this.
696 ;;; (setq buffer-read-only t)
699 ;; Subroutines of dired-revert
700 ;; Some of these are also used when inserting subdirs.
702 (defun dired-remember-marks (beg end)
703 ;; Return alist of files and their marks, from BEG to END.
704 (if selective-display ; must unhide to make this work.
705 (let (buffer-read-only)
706 (subst-char-in-region beg end ?\r ?\n)))
707 (let (fil chr alist)
708 (save-excursion
709 (goto-char beg)
710 (while (re-search-forward dired-re-mark end t)
711 (if (setq fil (dired-get-filename nil t))
712 (setq chr (preceding-char)
713 alist (cons (cons fil chr) alist)))))
714 alist))
716 ;; Mark all files remembered in ALIST.
717 ;; Each element of ALIST looks like (FILE . MARKERCHAR).
718 (defun dired-mark-remembered (alist)
719 (let (elt fil chr)
720 (while alist
721 (setq elt (car alist)
722 alist (cdr alist)
723 fil (car elt)
724 chr (cdr elt))
725 (if (dired-goto-file fil)
726 (save-excursion
727 (beginning-of-line)
728 (delete-char 1)
729 (insert chr))))))
731 ;; Return a list of names of subdirs currently hidden.
732 (defun dired-remember-hidden ()
733 (let ((l dired-subdir-alist) dir pos result)
734 (while l
735 (setq dir (car (car l))
736 pos (cdr (car l))
737 l (cdr l))
738 (goto-char pos)
739 (skip-chars-forward "^\r\n")
740 (if (eq (following-char) ?\r)
741 (setq result (cons dir result))))
742 result))
744 ;; Try to insert all subdirs that were displayed before,
745 ;; according to the former subdir alist OLD-SUBDIR-ALIST.
746 (defun dired-insert-old-subdirs (old-subdir-alist)
747 (or (string-match "R" dired-actual-switches)
748 (let (elt dir)
749 (while old-subdir-alist
750 (setq elt (car old-subdir-alist)
751 old-subdir-alist (cdr old-subdir-alist)
752 dir (car elt))
753 (condition-case ()
754 (progn
755 (dired-uncache dir)
756 (dired-insert-subdir dir))
757 (error nil))))))
759 ;; Remove directory DIR from any directory cache.
760 (defun dired-uncache (dir)
761 (let ((handler (find-file-name-handler dir 'dired-uncache)))
762 (if handler
763 (funcall handler 'dired-uncache dir))))
765 ;; dired mode key bindings and initialization
767 (defvar dired-mode-map nil "Local keymap for dired-mode buffers.")
768 (if dired-mode-map
770 ;; This looks ugly when substitute-command-keys uses C-d instead d:
771 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
773 (let ((map (make-keymap)))
774 (suppress-keymap map)
775 (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
776 ;; Commands to mark or flag certain categories of files
777 (define-key map "#" 'dired-flag-auto-save-files)
778 (define-key map "." 'dired-clean-directory)
779 (define-key map "~" 'dired-flag-backup-files)
780 (define-key map "&" 'dired-flag-garbage-files)
781 ;; Upper case keys (except !) for operating on the marked files
782 (define-key map "A" 'dired-do-search)
783 (define-key map "C" 'dired-do-copy)
784 (define-key map "B" 'dired-do-byte-compile)
785 (define-key map "D" 'dired-do-delete)
786 (define-key map "G" 'dired-do-chgrp)
787 (define-key map "H" 'dired-do-hardlink)
788 (define-key map "L" 'dired-do-load)
789 (define-key map "M" 'dired-do-chmod)
790 (define-key map "O" 'dired-do-chown)
791 (define-key map "P" 'dired-do-print)
792 (define-key map "Q" 'dired-do-query-replace)
793 (define-key map "R" 'dired-do-rename)
794 (define-key map "S" 'dired-do-symlink)
795 (define-key map "X" 'dired-do-shell-command)
796 (define-key map "Z" 'dired-do-compress)
797 (define-key map "!" 'dired-do-shell-command)
798 ;; Comparison commands
799 (define-key map "=" 'dired-diff)
800 (define-key map "\M-=" 'dired-backup-diff)
801 ;; Tree Dired commands
802 (define-key map "\M-\C-?" 'dired-unmark-all-files)
803 (define-key map "\M-\C-d" 'dired-tree-down)
804 (define-key map "\M-\C-u" 'dired-tree-up)
805 (define-key map "\M-\C-n" 'dired-next-subdir)
806 (define-key map "\M-\C-p" 'dired-prev-subdir)
807 ;; move to marked files
808 (define-key map "\M-{" 'dired-prev-marked-file)
809 (define-key map "\M-}" 'dired-next-marked-file)
810 ;; Make all regexp commands share a `%' prefix:
811 ;; We used to get to the submap via a symbol dired-regexp-prefix,
812 ;; but that seems to serve little purpose, and copy-keymap
813 ;; does a better job without it.
814 (define-key map "%" nil)
815 (define-key map "%u" 'dired-upcase)
816 (define-key map "%l" 'dired-downcase)
817 (define-key map "%d" 'dired-flag-files-regexp)
818 (define-key map "%m" 'dired-mark-files-regexp)
819 (define-key map "%r" 'dired-do-rename-regexp)
820 (define-key map "%C" 'dired-do-copy-regexp)
821 (define-key map "%H" 'dired-do-hardlink-regexp)
822 (define-key map "%R" 'dired-do-rename-regexp)
823 (define-key map "%S" 'dired-do-symlink-regexp)
824 ;; Commands for marking and unmarking.
825 (define-key map "*" nil)
826 (define-key map "**" 'dired-mark-executables)
827 (define-key map "*/" 'dired-mark-directories)
828 (define-key map "*@" 'dired-mark-symlinks)
829 (define-key map "*%" 'dired-mark-files-regexp)
830 (define-key map "*c" 'dired-change-marks)
831 (define-key map "*s" 'dired-mark-subdir-files)
832 (define-key map "*m" 'dired-mark)
833 (define-key map "*u" 'dired-unmark)
834 (define-key map "*?" 'dired-unmark-all-files)
835 (define-key map "*!" 'dired-unmark-all-files-no-query)
836 (define-key map "*\177" 'dired-unmark-backward)
837 (define-key map "*\C-n" 'dired-next-marked-file)
838 (define-key map "*\C-p" 'dired-prev-marked-file)
839 ;; Lower keys for commands not operating on all the marked files
840 (define-key map "d" 'dired-flag-file-deletion)
841 (define-key map "e" 'dired-find-file)
842 (define-key map "f" 'dired-find-file)
843 (define-key map "\C-m" 'dired-advertised-find-file)
844 (define-key map "g" 'revert-buffer)
845 (define-key map "h" 'describe-mode)
846 (define-key map "i" 'dired-maybe-insert-subdir)
847 (define-key map "k" 'dired-do-kill-lines)
848 (define-key map "l" 'dired-do-redisplay)
849 (define-key map "m" 'dired-mark)
850 (define-key map "n" 'dired-next-line)
851 (define-key map "o" 'dired-find-file-other-window)
852 (define-key map "\C-o" 'dired-display-file)
853 (define-key map "p" 'dired-previous-line)
854 (define-key map "q" 'dired-quit)
855 (define-key map "s" 'dired-sort-toggle-or-edit)
856 (define-key map "u" 'dired-unmark)
857 (define-key map "v" 'dired-view-file)
858 (define-key map "x" 'dired-do-flagged-delete)
859 (define-key map "+" 'dired-create-directory)
860 ;; moving
861 (define-key map "<" 'dired-prev-dirline)
862 (define-key map ">" 'dired-next-dirline)
863 (define-key map "^" 'dired-up-directory)
864 (define-key map " " 'dired-next-line)
865 (define-key map "\C-n" 'dired-next-line)
866 (define-key map "\C-p" 'dired-previous-line)
867 (define-key map [down] 'dired-next-line)
868 (define-key map [up] 'dired-previous-line)
869 ;; hiding
870 (define-key map "$" 'dired-hide-subdir)
871 (define-key map "\M-$" 'dired-hide-all)
872 ;; misc
873 (define-key map "?" 'dired-summary)
874 (define-key map "\177" 'dired-unmark-backward)
875 (define-key map "\C-_" 'dired-undo)
876 (define-key map "\C-xu" 'dired-undo)
878 ;; Make menu bar items.
880 ;; Get rid of the Edit menu bar item to save space.
881 (define-key map [menu-bar edit] 'undefined)
883 (define-key map [menu-bar subdir]
884 (cons "Subdir" (make-sparse-keymap "Subdir")))
886 (define-key map [menu-bar subdir hide-all]
887 '("Hide All" . dired-hide-all))
888 (define-key map [menu-bar subdir hide-subdir]
889 '("Hide Subdir" . dired-hide-subdir))
890 (define-key map [menu-bar subdir tree-down]
891 '("Tree Down" . dired-tree-down))
892 (define-key map [menu-bar subdir tree-up]
893 '("Tree Up" . dired-tree-up))
894 (define-key map [menu-bar subdir up]
895 '("Up Directory" . dired-up-directory))
896 (define-key map [menu-bar subdir prev-subdir]
897 '("Prev Subdir" . dired-prev-subdir))
898 (define-key map [menu-bar subdir next-subdir]
899 '("Next Subdir" . dired-next-subdir))
900 (define-key map [menu-bar subdir prev-dirline]
901 '("Prev Dirline" . dired-prev-dirline))
902 (define-key map [menu-bar subdir next-dirline]
903 '("Next Dirline" . dired-next-dirline))
904 (define-key map [menu-bar subdir insert]
905 '("Insert This Subdir" . dired-maybe-insert-subdir))
907 (define-key map [menu-bar immediate]
908 (cons "Immediate" (make-sparse-keymap "Immediate")))
910 (define-key map [menu-bar immediate revert-buffer]
911 '("Update Buffer" . revert-buffer))
913 (define-key map [menu-bar immediate dashes]
914 '("--"))
916 (define-key map [menu-bar immediate backup-diff]
917 '("Compare with Backup" . dired-backup-diff))
918 (define-key map [menu-bar immediate diff]
919 '("Diff" . dired-diff))
920 (define-key map [menu-bar immediate view]
921 '("View This File" . dired-view-file))
922 (define-key map [menu-bar immediate display]
923 '("Display in Other Window" . dired-display-file))
924 (define-key map [menu-bar immediate find-file-other-window]
925 '("Find in Other Window" . dired-find-file-other-window))
926 (define-key map [menu-bar immediate find-file]
927 '("Find This File" . dired-find-file))
928 (define-key map [menu-bar immediate create-directory]
929 '("Create Directory..." . dired-create-directory))
931 (define-key map [menu-bar regexp]
932 (cons "Regexp" (make-sparse-keymap "Regexp")))
934 (define-key map [menu-bar regexp downcase]
935 '("Downcase" . dired-downcase))
936 (define-key map [menu-bar regexp upcase]
937 '("Upcase" . dired-upcase))
938 (define-key map [menu-bar regexp hardlink]
939 '("Hardlink..." . dired-do-hardlink-regexp))
940 (define-key map [menu-bar regexp symlink]
941 '("Symlink..." . dired-do-symlink-regexp))
942 (define-key map [menu-bar regexp rename]
943 '("Rename..." . dired-do-rename-regexp))
944 (define-key map [menu-bar regexp copy]
945 '("Copy..." . dired-do-copy-regexp))
946 (define-key map [menu-bar regexp flag]
947 '("Flag..." . dired-flag-files-regexp))
948 (define-key map [menu-bar regexp mark]
949 '("Mark..." . dired-mark-files-regexp))
951 (define-key map [menu-bar mark]
952 (cons "Mark" (make-sparse-keymap "Mark")))
954 (define-key map [menu-bar mark prev]
955 '("Previous Marked" . dired-prev-marked-file))
956 (define-key map [menu-bar mark next]
957 '("Next Marked" . dired-next-marked-file))
958 (define-key map [menu-bar mark marks]
959 '("Change Marks..." . dired-change-marks))
960 (define-key map [menu-bar mark unmark-all]
961 '("Unmark All" . dired-unmark-all-files-no-query))
962 (define-key map [menu-bar mark symlinks]
963 '("Mark Symlinks" . dired-mark-symlinks))
964 (define-key map [menu-bar mark directories]
965 '("Mark Directories" . dired-mark-directories))
966 (define-key map [menu-bar mark directory]
967 '("Mark Old Backups" . dired-clean-directory))
968 (define-key map [menu-bar mark executables]
969 '("Mark Executables" . dired-mark-executables))
970 (define-key map [menu-bar mark garbage-files]
971 '("Flag Garbage Files" . dired-flag-garbage-files))
972 (define-key map [menu-bar mark backup-files]
973 '("Flag Backup Files" . dired-flag-backup-files))
974 (define-key map [menu-bar mark auto-save-files]
975 '("Flag Auto-save Files" . dired-flag-auto-save-files))
976 (define-key map [menu-bar mark deletion]
977 '("Flag" . dired-flag-file-deletion))
978 (define-key map [menu-bar mark unmark]
979 '("Unmark" . dired-unmark))
980 (define-key map [menu-bar mark mark]
981 '("Mark" . dired-mark))
983 (define-key map [menu-bar operate]
984 (cons "Operate" (make-sparse-keymap "Operate")))
986 (define-key map [menu-bar operate query-replace]
987 '("Query Replace in Files..." . dired-do-query-replace))
988 (define-key map [menu-bar operate search]
989 '("Search Files..." . dired-do-search))
990 (define-key map [menu-bar operate chown]
991 '("Change Owner..." . dired-do-chown))
992 (define-key map [menu-bar operate chgrp]
993 '("Change Group..." . dired-do-chgrp))
994 (define-key map [menu-bar operate chmod]
995 '("Change Mode..." . dired-do-chmod))
996 (define-key map [menu-bar operate load]
997 '("Load" . dired-do-load))
998 (define-key map [menu-bar operate compile]
999 '("Byte-compile" . dired-do-byte-compile))
1000 (define-key map [menu-bar operate compress]
1001 '("Compress" . dired-do-compress))
1002 (define-key map [menu-bar operate print]
1003 '("Print" . dired-do-print))
1004 (define-key map [menu-bar operate hardlink]
1005 '("Hardlink to..." . dired-do-hardlink))
1006 (define-key map [menu-bar operate symlink]
1007 '("Symlink to..." . dired-do-symlink))
1008 (define-key map [menu-bar operate command]
1009 '("Shell Command..." . dired-do-shell-command))
1010 (define-key map [menu-bar operate delete]
1011 '("Delete" . dired-do-delete))
1012 (define-key map [menu-bar operate rename]
1013 '("Rename to..." . dired-do-rename))
1014 (define-key map [menu-bar operate copy]
1015 '("Copy to..." . dired-do-copy))
1017 (setq dired-mode-map map)))
1019 ;; Dired mode is suitable only for specially formatted data.
1020 (put 'dired-mode 'mode-class 'special)
1022 (defun dired-mode (&optional dirname switches)
1024 Mode for \"editing\" directory listings.
1025 In dired, you are \"editing\" a list of the files in a directory and
1026 \(optionally) its subdirectories, in the format of `ls -lR'.
1027 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1028 \"Editing\" means that you can run shell commands on files, visit,
1029 compress, load or byte-compile them, change their file attributes
1030 and insert subdirectories into the same buffer. You can \"mark\"
1031 files for later commands or \"flag\" them for deletion, either file
1032 by file or all files matching certain criteria.
1033 You can move using the usual cursor motion commands.\\<dired-mode-map>
1034 Letters no longer insert themselves. Digits are prefix arguments.
1035 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1036 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1037 Most commands operate on the marked files and use the current file
1038 if no files are marked. Use a numeric prefix argument to operate on
1039 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1040 to operate on the current file only. Prefix arguments override marks.
1041 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1042 to see why something went wrong.
1043 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1044 Type \\[dired-unmark-backward] to back up one line and unflag.
1045 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1046 Type \\[dired-advertised-find-file] to Find the current line's file
1047 (or dired it in another buffer, if it is a directory).
1048 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1049 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1050 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1051 Type \\[dired-do-copy] to Copy files.
1052 Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
1053 Type \\[revert-buffer] to read all currently expanded directories again.
1054 This retains all marks and hides subdirs again that were hidden before.
1055 SPC and DEL can be used to move down and up by lines.
1057 If dired ever gets confused, you can either type \\[revert-buffer] \
1058 to read the
1059 directories again, type \\[dired-do-redisplay] \
1060 to relist a single or the marked files or a
1061 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1062 again for the directory tree.
1064 Customization variables (rename this buffer and type \\[describe-variable] on each line
1065 for more info):
1067 dired-listing-switches
1068 dired-trivial-filenames
1069 dired-shrink-to-fit
1070 dired-marker-char
1071 dired-del-marker
1072 dired-keep-marker-rename
1073 dired-keep-marker-copy
1074 dired-keep-marker-hardlink
1075 dired-keep-marker-symlink
1077 Hooks (use \\[describe-variable] to see their documentation):
1079 dired-before-readin-hook
1080 dired-after-readin-hook
1081 dired-mode-hook
1082 dired-load-hook
1084 Keybindings:
1085 \\{dired-mode-map}"
1086 ;; Not to be called interactively (e.g. dired-directory will be set
1087 ;; to default-directory, which is wrong with wildcards).
1088 (kill-all-local-variables)
1089 (use-local-map dired-mode-map)
1090 (dired-advertise) ; default-directory is already set
1091 (setq major-mode 'dired-mode
1092 mode-name "Dired"
1093 ;; case-fold-search nil
1094 buffer-read-only t
1095 selective-display t ; for subdirectory hiding
1096 mode-line-buffer-identification '("Dired: %17b"))
1097 (set (make-local-variable 'revert-buffer-function)
1098 (function dired-revert))
1099 (set (make-local-variable 'page-delimiter)
1100 "\n\n")
1101 (set (make-local-variable 'dired-directory)
1102 (or dirname default-directory))
1103 ;; list-buffers uses this to display the dir being edited in this buffer.
1104 (set (make-local-variable 'list-buffers-directory)
1105 (expand-file-name dired-directory))
1106 (set (make-local-variable 'dired-actual-switches)
1107 (or switches dired-listing-switches))
1108 (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
1109 (dired-sort-other dired-actual-switches t)
1110 (run-hooks 'dired-mode-hook))
1112 ;; Idiosyncratic dired commands that don't deal with marks.
1114 (defun dired-quit ()
1115 "Bury the current dired buffer."
1116 (interactive)
1117 (bury-buffer))
1119 (defun dired-summary ()
1120 "Summarize basic Dired commands and show recent Dired errors."
1121 (interactive)
1122 (dired-why)
1123 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1124 (message
1125 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1127 (defun dired-undo ()
1128 "Undo in a dired buffer.
1129 This doesn't recover lost files, it just undoes changes in the buffer itself.
1130 You can use it to recover marks, killed lines or subdirs.
1131 In the latter case, you have to do \\[dired-build-subdir-alist] to
1132 parse the buffer again."
1133 (interactive)
1134 (let (buffer-read-only)
1135 (undo)))
1137 (defun dired-next-line (arg)
1138 "Move down lines then position at filename.
1139 Optional prefix ARG says how many lines to move; default is one line."
1140 (interactive "p")
1141 (next-line arg)
1142 (dired-move-to-filename))
1144 (defun dired-previous-line (arg)
1145 "Move up lines then position at filename.
1146 Optional prefix ARG says how many lines to move; default is one line."
1147 (interactive "p")
1148 (previous-line arg)
1149 (dired-move-to-filename))
1151 (defun dired-next-dirline (arg &optional opoint)
1152 "Goto ARG'th next directory file line."
1153 (interactive "p")
1154 (or opoint (setq opoint (point)))
1155 (if (if (> arg 0)
1156 (re-search-forward dired-re-dir nil t arg)
1157 (beginning-of-line)
1158 (re-search-backward dired-re-dir nil t (- arg)))
1159 (dired-move-to-filename) ; user may type `i' or `f'
1160 (goto-char opoint)
1161 (error "No more subdirectories")))
1163 (defun dired-prev-dirline (arg)
1164 "Goto ARG'th previous directory file line."
1165 (interactive "p")
1166 (dired-next-dirline (- arg)))
1168 (defun dired-up-directory (&optional other-window)
1169 "Run dired on parent directory of current directory.
1170 Find the parent directory either in this buffer or another buffer.
1171 Creates a buffer if necessary."
1172 (interactive "P")
1173 (let* ((dir (dired-current-directory))
1174 (up (file-name-directory (directory-file-name dir))))
1175 (or (dired-goto-file (directory-file-name dir))
1176 ;; Only try dired-goto-subdir if buffer has more than one dir.
1177 (and (cdr dired-subdir-alist)
1178 (dired-goto-subdir up))
1179 (progn
1180 (if other-window
1181 (dired-other-window up)
1182 (dired up))
1183 (dired-goto-file dir)))))
1185 ;; Force `f' rather than `e' in the mode doc:
1186 (defalias 'dired-advertised-find-file 'dired-find-file)
1187 (defun dired-find-file (&optional coding-system)
1188 "In dired, visit the file or directory named on this line."
1189 (interactive "ZCoding-system: ")
1190 (let ((file-name (file-name-sans-versions (dired-get-filename) t)))
1191 (if (file-exists-p file-name)
1192 (find-file file-name coding-system)
1193 (error "File no longer exists; type `g' to update Dired buffer"))))
1195 (defun dired-mouse-find-file-other-window (event)
1196 "In dired, visit the file or directory name you click on."
1197 (interactive "e")
1198 (let (file)
1199 (save-excursion
1200 (set-buffer (window-buffer (posn-window (event-end event))))
1201 (save-excursion
1202 (goto-char (posn-point (event-end event)))
1203 (setq file (dired-get-filename))))
1204 (select-window (posn-window (event-end event)))
1205 (find-file-other-window (file-name-sans-versions file t))))
1207 (defun dired-view-file ()
1208 "In dired, examine a file in view mode, returning to dired when done.
1209 When file is a directory, show it in this buffer if it is inserted;
1210 otherwise, display it in another buffer."
1211 (interactive)
1212 (if (file-directory-p (dired-get-filename))
1213 (or (and (cdr dired-subdir-alist)
1214 (dired-goto-subdir (dired-get-filename)))
1215 (dired (dired-get-filename)))
1216 (view-file (dired-get-filename))))
1218 (defun dired-find-file-other-window ()
1219 "In dired, visit this file or directory in another window."
1220 (interactive)
1221 (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
1223 (defun dired-display-file ()
1224 "In dired, display this file or directory in another window."
1225 (interactive)
1226 (let ((file (file-name-sans-versions (dired-get-filename) t)))
1227 (display-buffer (find-file-noselect file))))
1229 ;;; Functions for extracting and manipulating file names in dired buffers.
1231 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1232 "In dired, return name of file mentioned on this line.
1233 Value returned normally includes the directory name.
1234 Optional arg LOCALP with value `no-dir' means don't include directory
1235 name in result. A value of t means construct name relative to
1236 `default-directory', which still may contain slashes if in a subdirectory.
1237 Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1238 this line, otherwise an error occurs."
1239 (let (case-fold-search file p1 p2)
1240 (save-excursion
1241 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1242 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1243 ;; nil if no file on this line, but no-error-if-not-filep is t:
1244 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1245 (progn
1246 ;; Get rid of the mouse-face property that file names have.
1247 (set-text-properties 0 (length file) nil file)
1248 ;; Unquote names quoted by ls or by dired-insert-directory.
1249 ;; Using read to unquote is much faster than substituting
1250 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1251 (setq file
1252 (read
1253 (concat "\""
1254 ;; some ls -b don't escape quotes, argh!
1255 ;; This is not needed for GNU ls, though.
1256 (or (dired-string-replace-match
1257 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
1258 file)
1259 "\"")))))
1260 (if (eq localp 'no-dir)
1261 file
1262 (and file (concat (dired-current-directory localp) file)))))
1264 (defun dired-string-replace-match (regexp string newtext
1265 &optional literal global)
1266 "Replace first match of REGEXP in STRING with NEWTEXT.
1267 If it does not match, nil is returned instead of the new string.
1268 Optional arg LITERAL means to take NEWTEXT literally.
1269 Optional arg GLOBAL means to replace all matches."
1270 (if global
1271 (let ((start 0))
1272 (while (string-match regexp string start)
1273 (let ((from-end (- (length string) (match-end 0))))
1274 (setq string (replace-match newtext t literal string))
1275 (setq start (- (length string) from-end))))
1276 string)
1277 (if (not (string-match regexp string 0))
1279 (replace-match newtext t literal string))))
1281 (defun dired-make-absolute (file &optional dir)
1282 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1283 ;; We can't always use expand-file-name as this would get rid of `.'
1284 ;; or expand in / instead default-directory if DIR=="".
1285 ;; This should be good enough for ange-ftp, but might easily be
1286 ;; redefined (for VMS?).
1287 ;; It should be reasonably fast, though, as it is called in
1288 ;; dired-get-filename.
1289 (concat (or dir default-directory) file))
1291 (defun dired-make-relative (file &optional dir ignore)
1292 "Convert FILE (an absolute file name) to a name relative to DIR.
1293 If this is impossible, return FILE unchanged.
1294 DIR must be a directory name, not a file name."
1295 (or dir (setq dir default-directory))
1296 ;; This case comes into play if default-directory is set to
1297 ;; use ~.
1298 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1299 (setq dir (expand-file-name dir)))
1300 (if (string-match (concat "^" (regexp-quote dir)) file)
1301 (substring file (match-end 0))
1302 ;;; (or no-error
1303 ;;; (error "%s: not in directory tree growing at %s" file dir))
1304 file))
1306 ;;; Functions for finding the file name in a dired buffer line.
1308 (defvar dired-move-to-filename-regexp
1309 " [A-Za-z\xa0-\xff][A-Za-z\xa0-\xff][A-Za-z\xa0-\xff] [0-3 ][0-9]\
1310 [ 0-9][0-9][:0-9][0-9][ 0-9] "
1311 "Regular expression to match a month abbreviation followed date/time.")
1313 (defvar dired-permission-flags-regexp
1314 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1315 "Regular expression to match the permission flags in `ls -l'.")
1317 ;; Move to first char of filename on this line.
1318 ;; Returns position (point) or nil if no filename on this line."
1319 (defun dired-move-to-filename (&optional raise-error eol)
1320 ;; This is the UNIX version.
1321 (or eol (setq eol (progn (end-of-line) (point))))
1322 (beginning-of-line)
1323 (if (re-search-forward dired-move-to-filename-regexp eol t)
1324 (goto-char (match-end 0))
1325 (if raise-error
1326 (error "No file on this line"))))
1328 (defun dired-move-to-end-of-filename (&optional no-error)
1329 ;; Assumes point is at beginning of filename,
1330 ;; thus the rwx bit re-search-backward below will succeed in *this*
1331 ;; line if at all. So, it should be called only after
1332 ;; (dired-move-to-filename t).
1333 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1334 ;; This is the UNIX version.
1335 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1336 ;; case-fold-search is nil now, so we can test for capital F:
1337 (setq used-F (string-match "F" dired-actual-switches)
1338 opoint (point)
1339 eol (save-excursion (end-of-line) (point))
1340 hidden (and selective-display
1341 (save-excursion (search-forward "\r" eol t))))
1342 (if hidden
1344 (save-excursion;; Find out what kind of file this is:
1345 ;; Restrict perm bits to be non-blank,
1346 ;; otherwise this matches one char to early (looking backward):
1347 ;; "l---------" (some systems make symlinks that way)
1348 ;; "----------" (plain file with zero perms)
1349 (if (re-search-backward
1350 dired-permission-flags-regexp nil t)
1351 (setq file-type (char-after (match-beginning 1))
1352 symlink (eq file-type ?l)
1353 ;; Only with -F we need to know whether it's an executable
1354 executable (and
1355 used-F
1356 (string-match
1357 "[xst]";; execute bit set anywhere?
1358 (concat
1359 (buffer-substring (match-beginning 2)
1360 (match-end 2))
1361 (buffer-substring (match-beginning 3)
1362 (match-end 3))
1363 (buffer-substring (match-beginning 4)
1364 (match-end 4))))))
1365 (or no-error (error "No file on this line"))))
1366 ;; Move point to end of name:
1367 (if symlink
1368 (if (search-forward " ->" eol t)
1369 (progn
1370 (forward-char -3)
1371 (and used-F
1372 dired-ls-F-marks-symlinks
1373 (eq (preceding-char) ?@);; did ls really mark the link?
1374 (forward-char -1))))
1375 (goto-char eol);; else not a symbolic link
1376 ;; ls -lF marks dirs, sockets and executables with exactly one
1377 ;; trailing character. (Executable bits on symlinks ain't mean
1378 ;; a thing, even to ls, but we know it's not a symlink.)
1379 (and used-F
1380 (or (memq file-type '(?d ?s))
1381 executable)
1382 (forward-char -1))))
1383 (or no-error
1384 (not (eq opoint (point)))
1385 (error (if hidden
1386 (substitute-command-keys
1387 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1388 "No file on this line")))
1389 (if (eq opoint (point))
1391 (point))))
1394 ;; Keeping Dired buffers in sync with the filesystem and with each other
1396 (defvar dired-buffers nil
1397 ;; Enlarged by dired-advertise
1398 ;; Queried by function dired-buffers-for-dir. When this detects a
1399 ;; killed buffer, it is removed from this list.
1400 "Alist of expanded directories and their associated dired buffers.")
1402 (defun dired-buffers-for-dir (dir &optional file)
1403 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1404 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1405 ;; matches FILE.
1406 ;; The list is in reverse order of buffer creation, most recent last.
1407 ;; As a side effect, killed dired buffers for DIR are removed from
1408 ;; dired-buffers.
1409 (setq dir (file-name-as-directory dir))
1410 (let ((alist dired-buffers) result elt buf pattern)
1411 (while alist
1412 (setq elt (car alist)
1413 buf (cdr elt))
1414 (if (buffer-name buf)
1415 (if (dired-in-this-tree dir (car elt))
1416 (with-current-buffer buf
1417 (and (assoc dir dired-subdir-alist)
1418 (or (null file)
1419 (let ((wildcards
1420 (file-name-nondirectory dired-directory)))
1421 (or (= 0 (length wildcards))
1422 (string-match (dired-glob-regexp wildcards)
1423 file))))
1424 (setq result (cons buf result)))))
1425 ;; else buffer is killed - clean up:
1426 (setq dired-buffers (delq elt dired-buffers)))
1427 (setq alist (cdr alist)))
1428 result))
1430 (defun dired-glob-regexp (pattern)
1431 "Convert glob-pattern PATTERN to a regular expression."
1432 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1433 regexp)
1434 (while (string-match "[[?*]" pattern matched-in-pattern)
1435 (let ((op-end (match-end 0))
1436 (next-op (aref pattern (match-beginning 0))))
1437 (setq regexp (concat regexp
1438 (regexp-quote
1439 (substring pattern matched-in-pattern
1440 (match-beginning 0)))))
1441 (cond ((= next-op ??)
1442 (setq regexp (concat regexp "."))
1443 (setq matched-in-pattern op-end))
1444 ((= next-op ?\[)
1445 ;; Fails to handle ^ yet ????
1446 (let* ((set-start (match-beginning 0))
1447 (set-cont
1448 (if (= (aref pattern (1+ set-start)) ?^)
1449 (+ 3 set-start)
1450 (+ 2 set-start)))
1451 (set-end (string-match "]" pattern set-cont))
1452 (set (substring pattern set-start (1+ set-end))))
1453 (setq regexp (concat regexp set))
1454 (setq matched-in-pattern (1+ set-end))))
1455 ((= next-op ?*)
1456 (setq regexp (concat regexp ".*"))
1457 (setq matched-in-pattern op-end)))))
1458 (concat "\\`"
1459 regexp
1460 (regexp-quote
1461 (substring pattern matched-in-pattern))
1462 "\\'")))
1466 (defun dired-advertise ()
1467 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1468 ;; With wildcards we actually advertise too much.
1469 (let ((expanded-default (expand-file-name default-directory)))
1470 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1471 t ; we have already advertised ourselves
1472 (setq dired-buffers
1473 (cons (cons expanded-default (current-buffer))
1474 dired-buffers)))))
1476 (defun dired-unadvertise (dir)
1477 ;; Remove DIR from the buffer alist in variable dired-buffers.
1478 ;; This has the effect of removing any buffer whose main directory is DIR.
1479 ;; It does not affect buffers in which DIR is a subdir.
1480 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1481 (setq dired-buffers
1482 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
1484 ;; Tree Dired
1486 ;;; utility functions
1488 (defun dired-in-this-tree (file dir)
1489 ;;"Is FILE part of the directory tree starting at DIR?"
1490 (let (case-fold-search)
1491 (string-match (concat "^" (regexp-quote dir)) file)))
1493 (defun dired-normalize-subdir (dir)
1494 ;; Prepend default-directory to DIR if relative path name.
1495 ;; dired-get-filename must be able to make a valid filename from a
1496 ;; file and its directory DIR.
1497 (file-name-as-directory
1498 (if (file-name-absolute-p dir)
1500 (expand-file-name dir default-directory))))
1502 (defun dired-get-subdir ()
1503 ;;"Return the subdir name on this line, or nil if not on a headerline."
1504 ;; Look up in the alist whether this is a headerline.
1505 (save-excursion
1506 (let ((cur-dir (dired-current-directory)))
1507 (beginning-of-line) ; alist stores b-o-l positions
1508 (and (zerop (- (point)
1509 (dired-get-subdir-min (assoc cur-dir
1510 dired-subdir-alist))))
1511 cur-dir))))
1513 ;(defun dired-get-subdir-min (elt)
1514 ; (cdr elt))
1515 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1516 (defalias 'dired-get-subdir-min 'cdr)
1518 (defun dired-get-subdir-max (elt)
1519 (save-excursion
1520 (goto-char (dired-get-subdir-min elt))
1521 (dired-subdir-max)))
1523 (defun dired-clear-alist ()
1524 (while dired-subdir-alist
1525 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1526 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1528 (defun dired-subdir-index (dir)
1529 ;; Return an index into alist for use with nth
1530 ;; for the sake of subdir moving commands.
1531 (let (found (index 0) (alist dired-subdir-alist))
1532 (while alist
1533 (if (string= dir (car (car alist)))
1534 (setq alist nil found t)
1535 (setq alist (cdr alist) index (1+ index))))
1536 (if found index nil)))
1538 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1539 "Go to next subdirectory, regardless of level."
1540 ;; Use 0 arg to go to this directory's header line.
1541 ;; NO-SKIP prevents moving to end of header line, returning whatever
1542 ;; position was found in dired-subdir-alist.
1543 (interactive "p")
1544 (let ((this-dir (dired-current-directory))
1545 pos index)
1546 ;; nth with negative arg does not return nil but the first element
1547 (setq index (- (dired-subdir-index this-dir) arg))
1548 (setq pos (if (>= index 0)
1549 (dired-get-subdir-min (nth index dired-subdir-alist))))
1550 (if pos
1551 (progn
1552 (goto-char pos)
1553 (or no-skip (skip-chars-forward "^\n\r"))
1554 (point))
1555 (if no-error-if-not-found
1556 nil ; return nil if not found
1557 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1559 (defun dired-build-subdir-alist ()
1560 "Build `dired-subdir-alist' by parsing the buffer.
1561 Returns the new value of the alist."
1562 (interactive)
1563 (dired-clear-alist)
1564 (save-excursion
1565 (let ((count 0)
1566 (buffer-read-only nil)
1567 new-dir-name)
1568 (goto-char (point-min))
1569 (setq dired-subdir-alist nil)
1570 (while (and (re-search-forward dired-subdir-regexp nil t)
1571 ;; Avoid taking a file name ending in a colon
1572 ;; as a subdir name.
1573 (not (save-excursion
1574 (goto-char (match-beginning 0))
1575 (beginning-of-line)
1576 (forward-char 2)
1577 (save-match-data (looking-at dired-re-perms)))))
1578 (save-excursion
1579 (goto-char (match-beginning 1))
1580 (setq new-dir-name
1581 (expand-file-name (buffer-substring (point) (match-end 1))))
1582 (delete-region (point) (match-end 1))
1583 (insert new-dir-name))
1584 (setq count (1+ count))
1585 (dired-alist-add-1 new-dir-name
1586 ;; Place a sub directory boundary between lines.
1587 (save-excursion
1588 (goto-char (match-beginning 0))
1589 (beginning-of-line)
1590 (point-marker))))
1591 (if (> count 1)
1592 (message "Buffer includes %d directories" count))
1593 ;; We don't need to sort it because it is in buffer order per
1594 ;; constructionem. Return new alist:
1595 dired-subdir-alist)))
1597 (defun dired-alist-add-1 (dir new-marker)
1598 ;; Add new DIR at NEW-MARKER. Don't sort.
1599 (setq dired-subdir-alist
1600 (cons (cons (dired-normalize-subdir dir) new-marker)
1601 dired-subdir-alist)))
1603 (defun dired-goto-next-nontrivial-file ()
1604 ;; Position point on first nontrivial file after point.
1605 (dired-goto-next-file);; so there is a file to compare with
1606 (if (stringp dired-trivial-filenames)
1607 (while (and (not (eobp))
1608 (string-match dired-trivial-filenames
1609 (file-name-nondirectory
1610 (or (dired-get-filename nil t) ""))))
1611 (forward-line 1)
1612 (dired-move-to-filename))))
1614 (defun dired-goto-next-file ()
1615 (let ((max (1- (dired-subdir-max))))
1616 (while (and (not (dired-move-to-filename)) (< (point) max))
1617 (forward-line 1))))
1619 (defun dired-goto-file (file)
1620 "Go to file line of FILE in this dired buffer."
1621 ;; Return value of point on success, else nil.
1622 ;; FILE must be an absolute pathname.
1623 ;; Loses if FILE contains control chars like "\007" for which ls
1624 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1625 ;; it in the buffer.
1626 (interactive
1627 (prog1 ; let push-mark display its message
1628 (list (expand-file-name
1629 (read-file-name "Goto file: "
1630 (dired-current-directory))))
1631 (push-mark)))
1632 (setq file (directory-file-name file)) ; does no harm if no directory
1633 (let (found case-fold-search dir)
1634 (setq dir (or (file-name-directory file)
1635 (error "Need absolute pathname for %s" file)))
1636 (save-excursion
1637 ;; The hair here is to get the result of dired-goto-subdir
1638 ;; without really calling it if we don't have any subdirs.
1639 (if (if (string= dir (expand-file-name default-directory))
1640 (goto-char (point-min))
1641 (and (cdr dired-subdir-alist)
1642 (dired-goto-subdir dir)))
1643 (let ((base (file-name-nondirectory file))
1644 (boundary (dired-subdir-max)))
1645 (while (and (not found)
1646 ;; filenames are preceded by SPC, this makes
1647 ;; the search faster (e.g. for the filename "-"!).
1648 (search-forward (concat " " base) boundary 'move))
1649 ;; Match could have BASE just as initial substring or
1650 ;; or in permission bits or date or
1651 ;; not be a proper filename at all:
1652 (if (equal base (dired-get-filename 'no-dir t))
1653 ;; Must move to filename since an (actually
1654 ;; correct) match could have been elsewhere on the
1655 ;; ;; line (e.g. "-" would match somewhere in the
1656 ;; permission bits).
1657 (setq found (dired-move-to-filename))
1658 ;; If this isn't the right line, move forward to avoid
1659 ;; trying this line again.
1660 (forward-line 1))))))
1661 (and found
1662 ;; return value of point (i.e., FOUND):
1663 (goto-char found))))
1665 (defun dired-initial-position (dirname)
1666 ;; Where point should go in a new listing of DIRNAME.
1667 ;; Point assumed at beginning of new subdir line.
1668 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1669 (end-of-line)
1670 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1672 ;; These are hooks which make tree dired work.
1673 ;; They are in this file because other parts of dired need to call them.
1674 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
1676 ;; This function is called for each retrieved filename.
1677 ;; It could stand to be faster, though it's mostly function call
1678 ;; overhead. Avoiding the function call seems to save about 10% in
1679 ;; dired-get-filename. Make it a defsubst?
1680 (defun dired-current-directory (&optional localp)
1681 "Return the name of the subdirectory to which this line belongs.
1682 This returns a string with trailing slash, like `default-directory'.
1683 Optional argument means return a file name relative to `default-directory'."
1684 (let ((here (point))
1685 (alist (or dired-subdir-alist
1686 ;; probably because called in a non-dired buffer
1687 (error "No subdir-alist in %s" (current-buffer))))
1688 elt dir)
1689 (while alist
1690 (setq elt (car alist)
1691 dir (car elt)
1692 ;; use `<=' (not `<') as subdir line is part of subdir
1693 alist (if (<= (dired-get-subdir-min elt) here)
1694 nil ; found
1695 (cdr alist))))
1696 (if localp
1697 (dired-make-relative dir default-directory)
1698 dir)))
1700 ;; Subdirs start at the beginning of their header lines and end just
1701 ;; before the beginning of the next header line (or end of buffer).
1703 (defun dired-subdir-max ()
1704 (save-excursion
1705 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
1706 (point-max)
1707 (point))))
1709 ;; Deleting files
1711 (defun dired-do-flagged-delete (&optional nomessage)
1712 "In dired, delete the files flagged for deletion.
1713 If NOMESSAGE is non-nil, we don't display any message
1714 if there are no flagged files."
1715 (interactive)
1716 (let* ((dired-marker-char dired-del-marker)
1717 (regexp (dired-marker-regexp))
1718 case-fold-search)
1719 (if (save-excursion (goto-char (point-min))
1720 (re-search-forward regexp nil t))
1721 (dired-internal-do-deletions
1722 ;; this can't move point since ARG is nil
1723 (dired-map-over-marks (cons (dired-get-filename) (point))
1724 nil)
1725 nil)
1726 (or nomessage
1727 (message "(No deletions requested)")))))
1729 (defun dired-do-delete (&optional arg)
1730 "Delete all marked (or next ARG) files."
1731 ;; This is more consistent with the file marking feature than
1732 ;; dired-do-flagged-delete.
1733 (interactive "P")
1734 (dired-internal-do-deletions
1735 ;; this may move point if ARG is an integer
1736 (dired-map-over-marks (cons (dired-get-filename) (point))
1737 arg)
1738 arg))
1740 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
1742 (defun dired-internal-do-deletions (l arg)
1743 ;; L is an alist of files to delete, with their buffer positions.
1744 ;; ARG is the prefix arg.
1745 ;; Filenames are absolute (VMS needs this for logical search paths).
1746 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
1747 ;; That way as changes are made in the buffer they do not shift the
1748 ;; lines still to be changed, so the (point) values in L stay valid.
1749 ;; Also, for subdirs in natural order, a subdir's files are deleted
1750 ;; before the subdir itself - the other way around would not work.
1751 (let ((files (mapcar (function car) l))
1752 (count (length l))
1753 (succ 0))
1754 ;; canonicalize file list for pop up
1755 (setq files (nreverse (mapcar (function dired-make-relative) files)))
1756 (if (dired-mark-pop-up
1757 " *Deletions*" 'delete files dired-deletion-confirmer
1758 (format "Delete %s " (dired-mark-prompt arg files)))
1759 (save-excursion
1760 (let (failures);; files better be in reverse order for this loop!
1761 (while l
1762 (goto-char (cdr (car l)))
1763 (let (buffer-read-only)
1764 (condition-case err
1765 (let ((fn (car (car l))))
1766 ;; This test is equivalent to
1767 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1768 ;; but more efficient
1769 (if (eq t (car (file-attributes fn)))
1770 (delete-directory fn)
1771 (delete-file fn))
1772 ;; if we get here, removing worked
1773 (setq succ (1+ succ))
1774 (message "%s of %s deletions" succ count)
1775 (delete-region (progn (beginning-of-line) (point))
1776 (progn (forward-line 1) (point)))
1777 (dired-clean-up-after-deletion fn))
1778 (error;; catch errors from failed deletions
1779 (dired-log "%s\n" err)
1780 (setq failures (cons (car (car l)) failures)))))
1781 (setq l (cdr l)))
1782 (if (not failures)
1783 (message "%d deletion%s done" count (dired-plural-s count))
1784 (dired-log-summary
1785 (format "%d of %d deletion%s failed"
1786 (length failures) count
1787 (dired-plural-s count))
1788 failures))))
1789 (message "(No deletions performed)")))
1790 (dired-move-to-filename))
1792 ;; This is a separate function for the sake of dired-x.el.
1793 (defun dired-clean-up-after-deletion (fn)
1794 ;; Clean up after a deleted file or directory FN.
1795 (save-excursion (and (cdr dired-subdir-alist)
1796 (dired-goto-subdir fn)
1797 (dired-kill-subdir))))
1799 ;; Confirmation
1801 (defun dired-marker-regexp ()
1802 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
1804 (defun dired-plural-s (count)
1805 (if (= 1 count) "" "s"))
1807 (defun dired-mark-prompt (arg files)
1808 ;; Return a string for use in a prompt, either the current file
1809 ;; name, or the marker and a count of marked files.
1810 (let ((count (length files)))
1811 (if (= count 1)
1812 (car files)
1813 ;; more than 1 file:
1814 (if (integerp arg)
1815 ;; abs(arg) = count
1816 ;; Perhaps this is nicer, but it also takes more screen space:
1817 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
1818 ;; count)
1819 (format "[next %d files]" arg)
1820 (format "%c [%d files]" dired-marker-char count)))))
1822 (defun dired-pop-to-buffer (buf)
1823 ;; Pop up buffer BUF.
1824 ;; If dired-shrink-to-fit is t, make its window fit its contents.
1825 (if (not dired-shrink-to-fit)
1826 (pop-to-buffer (get-buffer-create buf))
1827 ;; let window shrink to fit:
1828 (let ((window (selected-window))
1829 target-lines w2)
1830 (cond ;; if split-window-threshold is enabled, use the largest window
1831 ((and (> (window-height (setq w2 (get-largest-window)))
1832 split-height-threshold)
1833 (= (frame-width) (window-width w2)))
1834 (setq window w2))
1835 ;; if the least-recently-used window is big enough, use it
1836 ((and (> (window-height (setq w2 (get-lru-window)))
1837 (* 2 window-min-height))
1838 (= (frame-width) (window-width w2)))
1839 (setq window w2)))
1840 (save-excursion
1841 (set-buffer buf)
1842 (goto-char (point-max))
1843 (skip-chars-backward "\n\r\t ")
1844 (setq target-lines (count-lines (point-min) (point)))
1845 ;; Don't forget to count the last line.
1846 (if (not (bolp))
1847 (setq target-lines (1+ target-lines))))
1848 (if (<= (window-height window) (* 2 window-min-height))
1849 ;; At this point, every window on the frame is too small to split.
1850 (setq w2 (display-buffer buf))
1851 (setq w2 (split-window window
1852 (max window-min-height
1853 (- (window-height window)
1854 (1+ (max window-min-height target-lines)))))))
1855 (set-window-buffer w2 buf)
1856 (if (< (1- (window-height w2)) target-lines)
1857 (progn
1858 (select-window w2)
1859 (enlarge-window (- target-lines (1- (window-height w2))))))
1860 (set-window-start w2 1)
1863 (defvar dired-no-confirm nil
1864 "A list of symbols for commands dired should not confirm.
1865 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
1866 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink' and
1867 `uncompress'.")
1869 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
1870 ;;"Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
1871 ;;Return FUNCTION's result on ARGS after popping up a window (in a buffer
1872 ;;named BUFNAME, nil gives \" *Marked Files*\") showing the marked
1873 ;;files. Uses function `dired-pop-to-buffer' to do that.
1874 ;; FUNCTION should not manipulate files.
1875 ;; It should only read input (an argument or confirmation).
1876 ;;The window is not shown if there is just one file or
1877 ;; OP-SYMBOL is a member of the list in `dired-no-confirm'.
1878 ;;FILES is the list of marked files."
1879 (or bufname (setq bufname " *Marked Files*"))
1880 (if (or (eq dired-no-confirm t)
1881 (memq op-symbol dired-no-confirm)
1882 (= (length files) 1))
1883 (apply function args)
1884 (save-excursion
1885 (set-buffer (get-buffer-create bufname))
1886 (erase-buffer)
1887 (dired-format-columns-of-files files)
1888 (remove-text-properties (point-min) (point-max) '(mouse-face)))
1889 (save-window-excursion
1890 (dired-pop-to-buffer bufname)
1891 (apply function args))))
1893 (defun dired-format-columns-of-files (files)
1894 ;; Files should be in forward order for this loop.
1895 ;; i.e., (car files) = first file in buffer.
1896 ;; Returns the number of lines used.
1897 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
1898 (width (- (window-width (selected-window)) 2))
1899 (columns (max 1 (/ width maxlen)))
1900 (nfiles (length files))
1901 (rows (+ (/ nfiles columns)
1902 (if (zerop (% nfiles columns)) 0 1)))
1903 (i 0)
1904 (j 0))
1905 (setq files (nconc (copy-sequence files) ; fill up with empty fns
1906 (make-list (- (* columns rows) nfiles) "")))
1907 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
1908 (while (< j rows)
1909 (while (< i columns)
1910 (indent-to (* i maxlen))
1911 (insert (car files))
1912 (setq files (nthcdr rows files)
1913 i (1+ i)))
1914 (insert "\n")
1915 (setq i 0
1916 j (1+ j)
1917 files (cdr files)))
1918 rows))
1920 ;; Commands to mark or flag file(s) at or near current line.
1922 (defun dired-repeat-over-lines (arg function)
1923 ;; This version skips non-file lines.
1924 (let ((pos (make-marker)))
1925 (beginning-of-line)
1926 (while (and (> arg 0) (not (eobp)))
1927 (setq arg (1- arg))
1928 (beginning-of-line)
1929 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
1930 (save-excursion
1931 (forward-line 1)
1932 (move-marker pos (1+ (point))))
1933 (save-excursion (funcall function))
1934 ;; Advance to the next line--actually, to the line that *was* next.
1935 ;; (If FUNCTION inserted some new lines in between, skip them.)
1936 (goto-char pos))
1937 (while (and (< arg 0) (not (bobp)))
1938 (setq arg (1+ arg))
1939 (forward-line -1)
1940 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
1941 (beginning-of-line)
1942 (save-excursion (funcall function)))
1943 (move-marker pos nil)
1944 (dired-move-to-filename)))
1946 (defun dired-between-files ()
1947 ;; Point must be at beginning of line
1948 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
1949 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
1950 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard")
1951 (and (looking-at dired-subdir-regexp)
1952 (save-excursion (not (dired-move-to-filename))))))
1954 (defun dired-next-marked-file (arg &optional wrap opoint)
1955 "Move to the next marked file, wrapping around the end of the buffer."
1956 (interactive "p\np")
1957 (or opoint (setq opoint (point)));; return to where interactively started
1958 (if (if (> arg 0)
1959 (re-search-forward dired-re-mark nil t arg)
1960 (beginning-of-line)
1961 (re-search-backward dired-re-mark nil t (- arg)))
1962 (dired-move-to-filename)
1963 (if (null wrap)
1964 (progn
1965 (goto-char opoint)
1966 (error "No next marked file"))
1967 (message "(Wraparound for next marked file)")
1968 (goto-char (if (> arg 0) (point-min) (point-max)))
1969 (dired-next-marked-file arg nil opoint))))
1971 (defun dired-prev-marked-file (arg &optional wrap)
1972 "Move to the previous marked file, wrapping around the end of the buffer."
1973 (interactive "p\np")
1974 (dired-next-marked-file (- arg) wrap))
1976 (defun dired-file-marker (file)
1977 ;; Return FILE's marker, or nil if unmarked.
1978 (save-excursion
1979 (and (dired-goto-file file)
1980 (progn
1981 (beginning-of-line)
1982 (if (not (equal ?\040 (following-char)))
1983 (following-char))))))
1985 (defun dired-mark-files-in-region (start end)
1986 (let (buffer-read-only)
1987 (if (> start end)
1988 (error "start > end"))
1989 (goto-char start) ; assumed at beginning of line
1990 (while (< (point) end)
1991 ;; Skip subdir line and following garbage like the `total' line:
1992 (while (and (< (point) end) (dired-between-files))
1993 (forward-line 1))
1994 (if (and (not (looking-at dired-re-dot))
1995 (dired-get-filename nil t))
1996 (progn
1997 (delete-char 1)
1998 (insert dired-marker-char)))
1999 (forward-line 1))))
2001 (defun dired-mark (arg)
2002 "Mark the current (or next ARG) files.
2003 If on a subdir headerline, mark all its files except `.' and `..'.
2005 Use \\[dired-unmark-all-files] to remove all marks
2006 and \\[dired-unmark] on a subdir to remove the marks in
2007 this subdir."
2008 (interactive "P")
2009 (if (dired-get-subdir)
2010 (save-excursion (dired-mark-subdir-files))
2011 (let (buffer-read-only)
2012 (dired-repeat-over-lines
2013 (prefix-numeric-value arg)
2014 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2016 (defun dired-unmark (arg)
2017 "Unmark the current (or next ARG) files.
2018 If looking at a subdir, unmark all its files except `.' and `..'."
2019 (interactive "P")
2020 (let ((dired-marker-char ?\040))
2021 (dired-mark arg)))
2023 (defun dired-flag-file-deletion (arg)
2024 "In dired, flag the current line's file for deletion.
2025 With prefix arg, repeat over several lines.
2027 If on a subdir headerline, mark all its files except `.' and `..'."
2028 (interactive "P")
2029 (let ((dired-marker-char dired-del-marker))
2030 (dired-mark arg)))
2032 (defun dired-unmark-backward (arg)
2033 "In dired, move up lines and remove deletion flag there.
2034 Optional prefix ARG says how many lines to unflag; default is one line."
2035 (interactive "p")
2036 (dired-unmark (- arg)))
2038 ;;; Commands to mark or flag files based on their characteristics or names.
2040 (defvar dired-regexp-history nil
2041 "History list of regular expressions used in Dired commands.")
2043 (defun dired-read-regexp (prompt)
2044 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2046 (defun dired-mark-files-regexp (regexp &optional marker-char)
2047 "Mark all files matching REGEXP for use in later commands.
2048 A prefix argument means to unmark them instead.
2049 `.' and `..' are never marked.
2051 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2052 object files--just `.o' will mark more than you might think."
2053 (interactive
2054 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2055 " files (regexp): "))
2056 (if current-prefix-arg ?\040)))
2057 (let ((dired-marker-char (or marker-char dired-marker-char)))
2058 (dired-mark-if
2059 (and (not (looking-at dired-re-dot))
2060 (not (eolp)) ; empty line
2061 (let ((fn (dired-get-filename nil t)))
2062 (and fn (string-match regexp (file-name-nondirectory fn)))))
2063 "matching file")))
2065 (defun dired-flag-files-regexp (regexp)
2066 "In dired, flag all files containing the specified REGEXP for deletion.
2067 The match is against the non-directory part of the filename. Use `^'
2068 and `$' to anchor matches. Exclude subdirs by hiding them.
2069 `.' and `..' are never flagged."
2070 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2071 (dired-mark-files-regexp regexp dired-del-marker))
2073 (defun dired-mark-symlinks (unflag-p)
2074 "Mark all symbolic links.
2075 With prefix argument, unflag all those files."
2076 (interactive "P")
2077 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2078 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2080 (defun dired-mark-directories (unflag-p)
2081 "Mark all directory file lines except `.' and `..'.
2082 With prefix argument, unflag all those files."
2083 (interactive "P")
2084 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2085 (dired-mark-if (and (looking-at dired-re-dir)
2086 (not (looking-at dired-re-dot)))
2087 "directory file")))
2089 (defun dired-mark-executables (unflag-p)
2090 "Mark all executable files.
2091 With prefix argument, unflag all those files."
2092 (interactive "P")
2093 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2094 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2096 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2097 ;; files for which PREDICATE returns non-nil.
2099 (defun dired-flag-auto-save-files (&optional unflag-p)
2100 "Flag for deletion files whose names suggest they are auto save files.
2101 A prefix argument says to unflag those files instead."
2102 (interactive "P")
2103 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2104 (dired-mark-if
2105 ;; It is less than general to check for # here,
2106 ;; but it's the only way this runs fast enough.
2107 (and (save-excursion (end-of-line)
2109 (eq (preceding-char) ?#)
2110 ;; Handle executables in case of -F option.
2111 ;; We need not worry about the other kinds
2112 ;; of markings that -F makes, since they won't
2113 ;; appear on real auto-save files.
2114 (if (eq (preceding-char) ?*)
2115 (progn
2116 (forward-char -1)
2117 (eq (preceding-char) ?#)))))
2118 (not (looking-at dired-re-dir))
2119 (let ((fn (dired-get-filename t t)))
2120 (if fn (auto-save-file-name-p
2121 (file-name-nondirectory fn)))))
2122 "auto save file")))
2124 (defvar dired-garbage-files-regexp
2125 "\\.log$\\|\\.toc$\\|.dvi$|\\.bak$\\|\\.orig$\\|\\.rej$"
2126 "*Regular expression to match \"garbage\" files for `dired-flag-garbage-files'.")
2128 (defun dired-flag-garbage-files ()
2129 (interactive)
2130 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2131 (dired-flag-files-regexp dired-garbage-files-regexp))
2133 (defun dired-flag-backup-files (&optional unflag-p)
2134 "Flag all backup files (names ending with `~') for deletion.
2135 With prefix argument, unflag these files."
2136 (interactive "P")
2137 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2138 (dired-mark-if
2139 ;; Don't call backup-file-name-p unless the last character looks like
2140 ;; it might be the end of a backup file name. This isn't very general,
2141 ;; but it's the only way this runs fast enough.
2142 (and (save-excursion (end-of-line)
2143 ;; Handle executables in case of -F option.
2144 ;; We need not worry about the other kinds
2145 ;; of markings that -F makes, since they won't
2146 ;; appear on real backup files.
2147 (if (eq (preceding-char) ?*)
2148 (forward-char -1))
2149 (eq (preceding-char) ?~))
2150 (not (looking-at dired-re-dir))
2151 (let ((fn (dired-get-filename t t)))
2152 (if fn (backup-file-name-p fn))))
2153 "backup file")))
2155 (defun dired-change-marks (&optional old new)
2156 "Change all OLD marks to NEW marks.
2157 OLD and NEW are both characters used to mark files."
2158 (interactive
2159 (let* ((cursor-in-echo-area t)
2160 (old (progn (message "Change (old mark): ") (read-char)))
2161 (new (progn (message "Change %c marks to (new mark): " old)
2162 (read-char))))
2163 (list old new)))
2164 (if (or (eq old ?\r) (eq new ?\r))
2165 (ding)
2166 (let ((string (format "\n%c" old))
2167 (buffer-read-only))
2168 (save-excursion
2169 (goto-char (point-min))
2170 (while (search-forward string nil t)
2171 (if (if (= old ?\ )
2172 (save-match-data
2173 (dired-get-filename 'no-dir t))
2175 (subst-char-in-region (match-beginning 0)
2176 (match-end 0) old new)))))))
2178 (defun dired-unmark-all-files-no-query ()
2179 "Remove all marks from all files in the Dired buffer."
2180 (interactive)
2181 (dired-unmark-all-files ?\r))
2183 (defun dired-unmark-all-files (mark &optional arg)
2184 "Remove a specific mark (or any mark) from every file.
2185 After this command, type the mark character to remove,
2186 or type RET to remove all marks.
2187 With prefix arg, query for each marked file.
2188 Type \\[help-command] at that time for help."
2189 (interactive "cRemove marks (RET means all): \nP")
2190 (save-excursion
2191 (let* ((count 0)
2192 buffer-read-only case-fold-search query
2193 (string (format "\n%c" mark))
2194 (help-form "\
2195 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2196 `!' to unmark all remaining files with no more questions."))
2197 (goto-char (point-min))
2198 (while (if (eq mark ?\r)
2199 (re-search-forward dired-re-mark nil t)
2200 (search-forward string nil t))
2201 (if (or (not arg)
2202 (dired-query 'query "Unmark file `%s'? "
2203 (dired-get-filename t)))
2204 (progn (subst-char-in-region (1- (point)) (point)
2205 (preceding-char) ?\ )
2206 (setq count (1+ count)))))
2207 (message (if (= count 1) "1 mark removed"
2208 "%d marks removed")
2209 count))))
2211 ;; Logging failures operating on files, and showing the results.
2213 (defvar dired-log-buffer "*Dired log*")
2215 (defun dired-why ()
2216 "Pop up a buffer with error log output from Dired.
2217 A group of errors from a single command ends with a formfeed.
2218 Thus, use \\[backward-page] to find the beginning of a group of errors."
2219 (interactive)
2220 (if (get-buffer dired-log-buffer)
2221 (let ((owindow (selected-window))
2222 (window (display-buffer (get-buffer dired-log-buffer))))
2223 (unwind-protect
2224 (progn
2225 (select-window window)
2226 (goto-char (point-max))
2227 (recenter -1))
2228 (select-window owindow)))))
2230 (defun dired-log (log &rest args)
2231 ;; Log a message or the contents of a buffer.
2232 ;; If LOG is a string and there are more args, it is formatted with
2233 ;; those ARGS. Usually the LOG string ends with a \n.
2234 ;; End each bunch of errors with (dired-log t): this inserts
2235 ;; current time and buffer, and a \f (formfeed).
2236 (let ((obuf (current-buffer)))
2237 (unwind-protect ; want to move point
2238 (progn
2239 (set-buffer (get-buffer-create dired-log-buffer))
2240 (goto-char (point-max))
2241 (let (buffer-read-only)
2242 (cond ((stringp log)
2243 (insert (if args
2244 (apply (function format) log args)
2245 log)))
2246 ((bufferp log)
2247 (insert-buffer log))
2248 ((eq t log)
2249 (insert "\n\t" (current-time-string)
2250 "\tBuffer `" (buffer-name obuf) "'\n\f\n")))))
2251 (set-buffer obuf))))
2253 (defun dired-log-summary (string failures)
2254 (message (if failures "%s--type ? for details (%s)"
2255 "%s--type ? for details")
2256 string failures)
2257 ;; Log a summary describing a bunch of errors.
2258 (dired-log (concat "\n" string))
2259 (dired-log t))
2261 ;;; Sorting
2263 ;; Most ls can only sort by name or by date (with -t), nothing else.
2264 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2265 ;; So anything that does not contain these is sort "by name".
2267 (defvar dired-ls-sorting-switches "SXU"
2268 "String of `ls' switches (single letters) except `t' that influence sorting.")
2270 (defvar dired-sort-by-date-regexp
2271 (concat "^-[^" dired-ls-sorting-switches
2272 "]*t[^" dired-ls-sorting-switches "]*$")
2273 "Regexp recognized by dired to set `by date' mode.")
2275 (defvar dired-sort-by-name-regexp
2276 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2277 "Regexp recognized by dired to set `by name' mode.")
2279 (defun dired-sort-set-modeline ()
2280 ;; Set modeline display according to dired-actual-switches.
2281 ;; Modeline display of "by name" or "by date" guarantees the user a
2282 ;; match with the corresponding regexps. Non-matching switches are
2283 ;; shown literally.
2284 (setq mode-name
2285 (let (case-fold-search)
2286 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2287 "Dired by name")
2288 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2289 "Dired by date")
2291 (concat "Dired " dired-actual-switches)))))
2292 (force-mode-line-update))
2294 (defun dired-sort-toggle-or-edit (&optional arg)
2295 "Toggle between sort by date/name and refresh the dired buffer.
2296 With a prefix argument you can edit the current listing switches instead."
2297 (interactive "P")
2298 (if arg
2299 (dired-sort-other
2300 (read-string "ls switches (must contain -l): " dired-actual-switches))
2301 (dired-sort-toggle)))
2303 (defun dired-sort-toggle ()
2304 ;; Toggle between sort by date/name. Reverts the buffer.
2305 (setq dired-actual-switches
2306 (let (case-fold-search)
2307 (concat
2308 "-l"
2309 (dired-replace-in-string (concat "[-lt"
2310 dired-ls-sorting-switches "]")
2312 dired-actual-switches)
2313 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2314 dired-actual-switches)
2316 "t"))))
2317 (dired-sort-set-modeline)
2318 (revert-buffer))
2320 (defun dired-replace-in-string (regexp newtext string)
2321 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2322 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2323 (let ((result "") (start 0) mb me)
2324 (while (string-match regexp string start)
2325 (setq mb (match-beginning 0)
2326 me (match-end 0)
2327 result (concat result (substring string start mb) newtext)
2328 start me))
2329 (concat result (substring string start))))
2331 (defun dired-sort-other (switches &optional no-revert)
2332 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2333 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2334 ;; minor mode accordingly, others appear literally in the mode line.
2335 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2336 (setq dired-actual-switches switches)
2337 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
2338 (or no-revert (revert-buffer)))
2340 ;; To make this file smaller, the less common commands
2341 ;; go in a separate file. But autoload them here
2342 ;; to make the separation invisible.
2344 (autoload 'dired-diff "dired-aux"
2345 "Compare file at point with file FILE using `diff'.
2346 FILE defaults to the file at the mark.
2347 The prompted-for file is the first file given to `diff'."
2350 (autoload 'dired-backup-diff "dired-aux"
2351 "Diff this file with its backup file or vice versa.
2352 Uses the latest backup, if there are several numerical backups.
2353 If this file is a backup, diff it with its original.
2354 The backup file is the first file given to `diff'."
2357 (autoload 'dired-clean-directory "dired-aux"
2358 "Flag numerical backups for deletion.
2359 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2360 Positive prefix arg KEEP overrides `dired-kept-versions';
2361 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2363 To clear the flags on these files, you can use \\[dired-flag-backup-files]
2364 with a prefix argument."
2367 (autoload 'dired-do-chmod "dired-aux"
2368 "Change the mode of the marked (or next ARG) files.
2369 This calls chmod, thus symbolic modes like `g+w' are allowed."
2372 (autoload 'dired-do-chgrp "dired-aux"
2373 "Change the group of the marked (or next ARG) files."
2376 (autoload 'dired-do-chown "dired-aux"
2377 "Change the owner of the marked (or next ARG) files."
2380 (autoload 'dired-do-print "dired-aux"
2381 "Print the marked (or next ARG) files.
2382 Uses the shell command coming from variables `lpr-command' and
2383 `lpr-switches' as default."
2386 (autoload 'dired-do-shell-command "dired-aux"
2387 "Run a shell command COMMAND on the marked files.
2388 If no files are marked or a specific numeric prefix arg is given,
2389 the next ARG files are used. Just \\[universal-argument] means the current file.
2390 The prompt mentions the file(s) or the marker, as appropriate.
2392 If there is output, it goes to a separate buffer.
2394 Normally the command is run on each file individually.
2395 However, if there is a `*' in the command then it is run
2396 just once with the entire file list substituted there.
2398 No automatic redisplay of dired buffers is attempted, as there's no
2399 telling what files the command may have changed. Type
2400 \\[dired-do-redisplay] to redisplay the marked files.
2402 The shell command has the top level directory as working directory, so
2403 output files usually are created there instead of in a subdir."
2406 (autoload 'dired-do-kill-lines "dired-aux"
2407 "Kill all marked lines (not the files).
2408 With a prefix arg, kill all lines not marked or flagged."
2411 (autoload 'dired-do-compress "dired-aux"
2412 "Compress or uncompress marked (or next ARG) files."
2415 (autoload 'dired-do-byte-compile "dired-aux"
2416 "Byte compile marked (or next ARG) Emacs Lisp files."
2419 (autoload 'dired-do-load "dired-aux"
2420 "Load the marked (or next ARG) Emacs Lisp files."
2423 (autoload 'dired-do-redisplay "dired-aux"
2424 "Redisplay all marked (or next ARG) files.
2425 If on a subdir line, redisplay that subdirectory. In that case,
2426 a prefix arg lets you edit the `ls' switches used for the new listing."
2429 (autoload 'dired-create-directory "dired-aux"
2430 "Create a directory called DIRECTORY."
2433 (autoload 'dired-do-copy "dired-aux"
2434 "Copy all marked (or next ARG) files, or copy the current file.
2435 Thus, a zero prefix argument copies nothing. But it toggles the
2436 variable `dired-copy-preserve-time' (which see)."
2439 (autoload 'dired-do-symlink "dired-aux"
2440 "Make symbolic links to current file or all marked (or next ARG) files.
2441 When operating on just the current file, you specify the new name.
2442 When operating on multiple or marked files, you specify a directory
2443 and new symbolic links are made in that directory
2444 with the same names that the files currently have."
2447 (autoload 'dired-do-hardlink "dired-aux"
2448 "Add names (hard links) current file or all marked (or next ARG) files.
2449 When operating on just the current file, you specify the new name.
2450 When operating on multiple or marked files, you specify a directory
2451 and new hard links are made in that directory
2452 with the same names that the files currently have."
2455 (autoload 'dired-do-rename "dired-aux"
2456 "Rename current file or all marked (or next ARG) files.
2457 When renaming just the current file, you specify the new name.
2458 When renaming multiple or marked files, you specify a directory."
2461 (autoload 'dired-do-rename-regexp "dired-aux"
2462 "Rename marked files containing REGEXP to NEWNAME.
2463 As each match is found, the user must type a character saying
2464 what to do with it. For directions, type \\[help-command] at that time.
2465 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2466 REGEXP defaults to the last regexp used.
2467 With a zero prefix arg, renaming by regexp affects the complete
2468 pathname - usually only the non-directory part of file names is used
2469 and changed."
2472 (autoload 'dired-do-copy-regexp "dired-aux"
2473 "Copy all marked files containing REGEXP to NEWNAME.
2474 See function `dired-rename-regexp' for more info."
2477 (autoload 'dired-do-hardlink-regexp "dired-aux"
2478 "Hardlink all marked files containing REGEXP to NEWNAME.
2479 See function `dired-rename-regexp' for more info."
2482 (autoload 'dired-do-symlink-regexp "dired-aux"
2483 "Symlink all marked files containing REGEXP to NEWNAME.
2484 See function `dired-rename-regexp' for more info."
2487 (autoload 'dired-upcase "dired-aux"
2488 "Rename all marked (or next ARG) files to upper case."
2491 (autoload 'dired-downcase "dired-aux"
2492 "Rename all marked (or next ARG) files to lower case."
2495 (autoload 'dired-maybe-insert-subdir "dired-aux"
2496 "Insert this subdirectory into the same dired buffer.
2497 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2498 else inserts it at its natural place (as `ls -lR' would have done).
2499 With a prefix arg, you may edit the ls switches used for this listing.
2500 You can add `R' to the switches to expand the whole tree starting at
2501 this subdirectory.
2502 This function takes some pains to conform to `ls -lR' output."
2505 (autoload 'dired-next-subdir "dired-aux"
2506 "Go to next subdirectory, regardless of level."
2509 (autoload 'dired-prev-subdir "dired-aux"
2510 "Go to previous subdirectory, regardless of level.
2511 When called interactively and not on a subdir line, go to this subdir's line."
2514 (autoload 'dired-goto-subdir "dired-aux"
2515 "Go to end of header line of DIR in this dired buffer.
2516 Return value of point on success, otherwise return nil.
2517 The next char is either \\n, or \\r if DIR is hidden."
2520 (autoload 'dired-mark-subdir-files "dired-aux"
2521 "Mark all files except `.' and `..'."
2524 (autoload 'dired-kill-subdir "dired-aux"
2525 "Remove all lines of current subdirectory.
2526 Lower levels are unaffected."
2529 (autoload 'dired-tree-up "dired-aux"
2530 "Go up ARG levels in the dired tree."
2533 (autoload 'dired-tree-down "dired-aux"
2534 "Go down in the dired tree."
2537 (autoload 'dired-hide-subdir "dired-aux"
2538 "Hide or unhide the current subdirectory and move to next directory.
2539 Optional prefix arg is a repeat factor.
2540 Use \\[dired-hide-all] to (un)hide all directories."
2543 (autoload 'dired-hide-all "dired-aux"
2544 "Hide all subdirectories, leaving only their header lines.
2545 If there is already something hidden, make everything visible again.
2546 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2549 (if (eq system-type 'vax-vms)
2550 (load "dired-vms"))
2552 (provide 'dired)
2554 (run-hooks 'dired-load-hook) ; for your customizations
2556 ;;; dired.el ends here