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