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