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