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