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