Update x-popup-menu declaration.
[emacs.git] / lisp / dired.el
blob57c5c8954b4cabb83c23792fdfd2661285602028
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 ;; Free Software Foundation, Inc.
7 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
8 ;; Maintainer: FSF
9 ;; Keywords: files
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This is a major mode for directory browsing and editing. It is
29 ;; documented in the Emacs manual.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
37 (eval-when-compile (require 'cl))
39 ;;; Customizable variables
41 (defgroup dired nil
42 "Directory editing."
43 :link '(custom-manual "(emacs)Dired")
44 :group 'files)
46 (defgroup dired-mark nil
47 "Handling marks in Dired."
48 :prefix "dired-"
49 :group 'dired)
52 ;;;###autoload
53 (defcustom dired-listing-switches "-al"
54 "Switches passed to `ls' for Dired. MUST contain the `l' option.
55 May contain all other options that don't contradict `-l';
56 may contain even `F', `b', `i' and `s'. See also the variable
57 `dired-ls-F-marks-symlinks' concerning the `F' switch.
58 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
59 some of the `ls' switches are not supported; see the doc string of
60 `insert-directory' in `ls-lisp.el' for more details."
61 :type 'string
62 :group 'dired)
64 (defvar dired-subdir-switches nil
65 "If non-nil, switches passed to `ls' for inserting subdirectories.
66 If nil, `dired-listing-switches' is used.")
68 ; Don't use absolute file names as /bin should be in any PATH and people
69 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
70 ; usually not in PATH.
72 ;;;###autoload
73 (defvar dired-chown-program
74 (if (memq system-type '(hpux usg-unix-v irix linux gnu/linux cygwin))
75 "chown"
76 (if (file-exists-p "/usr/sbin/chown")
77 "/usr/sbin/chown"
78 "/etc/chown"))
79 "Name of chown command (usually `chown' or `/etc/chown').")
81 (defvar dired-use-ls-dired (not (not (string-match "gnu" system-configuration)))
82 "Non-nil means Dired should use `ls --dired'.")
84 (defvar dired-chmod-program "chmod"
85 "Name of chmod command (usually `chmod').")
87 (defvar dired-touch-program "touch"
88 "Name of touch command (usually `touch').")
90 (defcustom dired-ls-F-marks-symlinks nil
91 "Informs Dired about how `ls -lF' marks symbolic links.
92 Set this to t if `ls' (or whatever program is specified by
93 `insert-directory-program') with `-lF' marks the symbolic link
94 itself with a trailing @ (usually the case under Ultrix).
96 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
97 nil (the default), if it gives `bar@ -> foo', set it to t.
99 Dired checks if there is really a @ appended. Thus, if you have a
100 marking `ls' program on one host and a non-marking on another host, and
101 don't care about symbolic links which really end in a @, you can
102 always set this variable to t."
103 :type 'boolean
104 :group 'dired-mark)
106 ;;;###autoload
107 (defcustom dired-trivial-filenames "^\\.\\.?$\\|^#"
108 "Regexp of files to skip when finding first file of a directory.
109 A value of nil means move to the subdir line.
110 A 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)
116 (defcustom dired-keep-marker-rename t
117 ;; Use t as default so that moved files "take their markers with them".
118 "Controls marking of renamed files.
119 If t, files keep their previous marks when they are renamed.
120 If a character, renamed files (whether previously marked or not)
121 are afterward marked with that character."
122 :type '(choice (const :tag "Keep" t)
123 (character :tag "Mark"))
124 :group 'dired-mark)
126 (defcustom dired-keep-marker-copy ?C
127 "Controls marking of copied files.
128 If t, copied files are marked if and as the corresponding original files were.
129 If a character, copied files are unconditionally marked with that character."
130 :type '(choice (const :tag "Keep" t)
131 (character :tag "Mark"))
132 :group 'dired-mark)
134 (defcustom dired-keep-marker-hardlink ?H
135 "Controls marking of newly made hard links.
136 If t, they are marked if and as the files linked to were marked.
137 If a character, new links are unconditionally marked with that character."
138 :type '(choice (const :tag "Keep" t)
139 (character :tag "Mark"))
140 :group 'dired-mark)
142 (defcustom dired-keep-marker-symlink ?Y
143 "Controls marking of newly made symbolic links.
144 If t, they are marked if and as the files linked to were marked.
145 If a character, new links are unconditionally marked with that character."
146 :type '(choice (const :tag "Keep" t)
147 (character :tag "Mark"))
148 :group 'dired-mark)
150 (defcustom dired-dwim-target nil
151 "If non-nil, Dired tries to guess a default target directory.
152 This means: if there is a dired buffer displayed in the next window,
153 use its current subdir, instead of the current subdir of this dired buffer.
155 The target is used in the prompt for file copy, rename etc."
156 :type 'boolean
157 :group 'dired)
159 (defcustom dired-copy-preserve-time t
160 "If non-nil, Dired preserves the last-modified time in a file copy.
161 \(This works on only some systems.)"
162 :type 'boolean
163 :group 'dired)
165 ; These variables were deleted and the replacements are on files.el.
166 ; We leave aliases behind for back-compatibility.
167 (defvaralias 'dired-free-space-program 'directory-free-space-program)
168 (defvaralias 'dired-free-space-args 'directory-free-space-args)
170 ;;; Hook variables
172 (defcustom dired-load-hook nil
173 "Run after loading Dired.
174 You can customize key bindings or load extensions with this."
175 :group 'dired
176 :type 'hook)
178 (defcustom dired-mode-hook nil
179 "Run at the very end of `dired-mode'."
180 :group 'dired
181 :type 'hook)
183 (defcustom dired-before-readin-hook nil
184 "This hook is run before a dired buffer is read in (created or reverted)."
185 :group 'dired
186 :type 'hook)
188 (defcustom dired-after-readin-hook nil
189 "Hook run after each time a file or directory is read by Dired.
190 After each listing of a file or directory, this hook is run
191 with the buffer narrowed to the listing."
192 :group 'dired
193 :type 'hook)
194 ;; Note this can't simply be run inside function `dired-ls' as the hook
195 ;; functions probably depend on the dired-subdir-alist to be OK.
197 (defcustom dired-dnd-protocol-alist
198 '(("^file:///" . dired-dnd-handle-local-file)
199 ("^file://" . dired-dnd-handle-file)
200 ("^file:" . dired-dnd-handle-local-file))
201 "The functions to call when a drop in `dired-mode' is made.
202 See `dnd-protocol-alist' for more information. When nil, behave
203 as in other buffers. Changing this option is effective only for
204 new dired buffers."
205 :type '(choice (repeat (cons (regexp) (function)))
206 (const :tag "Behave as in other buffers" nil))
207 :version "22.1"
208 :group 'dired)
210 ;; Internal variables
212 (defvar dired-marker-char ?* ; the answer is 42
213 ;; so that you can write things like
214 ;; (let ((dired-marker-char ?X))
215 ;; ;; great code using X markers ...
216 ;; )
217 ;; For example, commands operating on two sets of files, A and B.
218 ;; Or marking files with digits 0-9. This could implicate
219 ;; concentric sets or an order for the marked files.
220 ;; The code depends on dynamic scoping on the marker char.
221 "In Dired, the current mark character.
222 This is what the do-commands look for, and what the mark-commands store.")
224 (defvar dired-del-marker ?D
225 "Character used to flag files for deletion.")
227 (defvar dired-shrink-to-fit t
228 ;; I see no reason ever to make this nil -- rms.
229 ;; (> baud-rate search-slow-speed)
230 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
232 (defvar dired-flagging-regexp nil);; Last regexp used to flag files.
234 (defvar dired-file-version-alist)
236 ;;;###autoload
237 (defvar dired-directory nil
238 "The directory name or wildcard spec that this dired directory lists.
239 Local to each dired buffer. May be a list, in which case the car is the
240 directory name and the cdr is the list of files to mention.
241 The directory name must be absolute, but need not be fully expanded.")
243 (defvar dired-actual-switches nil
244 "The value of `dired-listing-switches' used to make this buffer's text.")
246 (defvar dired-re-inode-size "[0-9 \t]*"
247 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
249 ;; These regexps must be tested at beginning-of-line, but are also
250 ;; used to search for next matches, so neither omitting "^" nor
251 ;; replacing "^" by "\n" (to make it slightly faster) will work.
253 (defvar dired-re-mark "^[^ \n]")
254 ;; "Regexp matching a marked line.
255 ;; Important: the match ends just after the marker."
256 (defvar dired-re-maybe-mark "^. ")
257 ;; The [^:] part after "d" and "l" is to avoid confusion with the
258 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
259 (defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d[^:]"))
260 (defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l[^:]"))
261 (defvar dired-re-exe;; match ls permission string of an executable file
262 (mapconcat (function
263 (lambda (x)
264 (concat dired-re-maybe-mark dired-re-inode-size x)))
265 '("-[-r][-w][xs][-r][-w].[-r][-w]."
266 "-[-r][-w].[-r][-w][xs][-r][-w]."
267 "-[-r][-w].[-r][-w].[-r][-w][xst]")
268 "\\|"))
269 (defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
270 (defvar dired-re-dot "^.* \\.\\.?/?$")
272 ;; The subdirectory names in the next two lists are expanded.
273 (defvar dired-subdir-alist nil
274 "Association list of subdirectories and their buffer positions.
275 Each subdirectory has an element: (DIRNAME . STARTMARKER).
276 The order of elements is the reverse of the order in the buffer.
277 In simple cases, this list contains one element.")
279 (defvar dired-switches-alist nil
280 "Keeps track of which switches to use for inserted subdirectories.
281 This is an alist of the form (SUBDIR . SWITCHES).")
282 (make-variable-buffer-local 'dired-switches-alist)
284 (defvaralias 'dired-move-to-filename-regexp
285 'directory-listing-before-filename-regexp)
287 (defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
288 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
289 Subexpression 1 is the subdirectory proper, no trailing colon.
290 The match starts at the beginning of the line and ends after the end
291 of the line (\\n or \\r).
292 Subexpression 2 must end right before the \\n or \\r.")
294 (defgroup dired-faces nil
295 "Faces used by Dired."
296 :group 'dired
297 :group 'faces)
299 (defface dired-header
300 '((t (:inherit font-lock-type-face)))
301 "Face used for directory headers."
302 :group 'dired-faces
303 :version "22.1")
304 (defvar dired-header-face 'dired-header
305 "Face name used for directory headers.")
307 (defface dired-mark
308 '((t (:inherit font-lock-constant-face)))
309 "Face used for dired marks."
310 :group 'dired-faces
311 :version "22.1")
312 (defvar dired-mark-face 'dired-mark
313 "Face name used for dired marks.")
315 (defface dired-marked
316 '((t (:inherit font-lock-warning-face)))
317 "Face used for marked files."
318 :group 'dired-faces
319 :version "22.1")
320 (defvar dired-marked-face 'dired-marked
321 "Face name used for marked files.")
323 (defface dired-flagged
324 '((t (:inherit font-lock-warning-face)))
325 "Face used for flagged files."
326 :group 'dired-faces
327 :version "22.1")
328 (defvar dired-flagged-face 'dired-flagged
329 "Face name used for flagged files.")
331 (defface dired-warning
332 ;; Inherit from font-lock-warning-face since with min-colors 8
333 ;; font-lock-comment-face is not colored any more.
334 '((t (:inherit font-lock-warning-face)))
335 "Face used to highlight a part of a buffer that needs user attention."
336 :group 'dired-faces
337 :version "22.1")
338 (defvar dired-warning-face 'dired-warning
339 "Face name used for a part of a buffer that needs user attention.")
341 (defface dired-perm-write
342 '((((type w32 pc)) :inherit default) ;; These default to rw-rw-rw.
343 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
344 ;; font-lock-comment-face is not colored any more.
345 (t (:inherit font-lock-comment-delimiter-face)))
346 "Face used to highlight permissions of group- and world-writable files."
347 :group 'dired-faces
348 :version "22.2")
349 (defvar dired-perm-write-face 'dired-perm-write
350 "Face name used for permissions of group- and world-writable files.")
352 (defface dired-directory
353 '((t (:inherit font-lock-function-name-face)))
354 "Face used for subdirectories."
355 :group 'dired-faces
356 :version "22.1")
357 (defvar dired-directory-face 'dired-directory
358 "Face name used for subdirectories.")
360 (defface dired-symlink
361 '((t (:inherit font-lock-keyword-face)))
362 "Face used for symbolic links."
363 :group 'dired-faces
364 :version "22.1")
365 (defvar dired-symlink-face 'dired-symlink
366 "Face name used for symbolic links.")
368 (defface dired-ignored
369 '((t (:inherit shadow)))
370 "Face used for files suffixed with `completion-ignored-extensions'."
371 :group 'dired-faces
372 :version "22.1")
373 (defvar dired-ignored-face 'dired-ignored
374 "Face name used for files suffixed with `completion-ignored-extensions'.")
376 (defvar dired-font-lock-keywords
377 (list
379 ;; Dired marks.
380 (list dired-re-mark '(0 dired-mark-face))
382 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
383 ;; file name itself. We search for Dired defined regexps, and then use the
384 ;; Dired defined function `dired-move-to-filename' before searching for the
385 ;; simple regexp ".+". It is that regexp which matches the file name.
387 ;; Marked files.
388 (list (concat "^[" (char-to-string dired-marker-char) "]")
389 '(".+" (dired-move-to-filename) nil (0 dired-marked-face)))
391 ;; Flagged files.
392 (list (concat "^[" (char-to-string dired-del-marker) "]")
393 '(".+" (dired-move-to-filename) nil (0 dired-flagged-face)))
394 ;; People who are paranoid about security would consider this more
395 ;; important than other things such as whether it is a directory.
396 ;; But we don't want to encourage paranoia, so our default
397 ;; should be what's most useful for non-paranoids. -- rms.
398 ;;; ;;
399 ;;; ;; Files that are group or world writable.
400 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
401 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
402 ;;; '(1 dired-warning-face)
403 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
404 ;; However, we don't need to highlight the file name, only the
405 ;; permissions, to win generally. -- fx.
406 ;; Fixme: we could also put text properties on the permission
407 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
408 (list (concat dired-re-maybe-mark dired-re-inode-size
409 "[-d]....\\(w\\)....") ; group writable
410 '(1 dired-perm-write-face))
411 (list (concat dired-re-maybe-mark dired-re-inode-size
412 "[-d].......\\(w\\).") ; world writable
413 '(1 dired-perm-write-face))
415 ;; Subdirectories.
416 (list dired-re-dir
417 '(".+" (dired-move-to-filename) nil (0 dired-directory-face)))
419 ;; Symbolic links.
420 (list dired-re-sym
421 '(".+" (dired-move-to-filename) nil (0 dired-symlink-face)))
423 ;; Files suffixed with `completion-ignored-extensions'.
424 '(eval .
425 ;; It is quicker to first find just an extension, then go back to the
426 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
427 (list (concat "\\(" (regexp-opt completion-ignored-extensions) "\\|#\\)$")
428 '(".+" (dired-move-to-filename) nil (0 dired-ignored-face))))
430 ;; Files suffixed with `completion-ignored-extensions'
431 ;; plus a character put in by -F.
432 '(eval .
433 (list (concat "\\(" (regexp-opt completion-ignored-extensions)
434 "\\|#\\)[*=|]$")
435 '(".+" (progn
436 (end-of-line)
437 ;; If the last character is not part of the filename,
438 ;; move back to the start of the filename
439 ;; so it can be fontified.
440 ;; Otherwise, leave point at the end of the line;
441 ;; that way, nothing is fontified.
442 (unless (get-text-property (1- (point)) 'mouse-face)
443 (dired-move-to-filename)))
444 nil (0 dired-ignored-face))))
446 ;; Explicitly put the default face on file names ending in a colon to
447 ;; avoid fontifying them as directory header.
448 (list (concat dired-re-maybe-mark dired-re-inode-size dired-re-perms ".*:$")
449 '(".+" (dired-move-to-filename) nil (0 'default)))
451 ;; Directory headers.
452 (list dired-subdir-regexp '(1 dired-header-face))
454 "Additional expressions to highlight in Dired mode.")
456 (defvar dnd-protocol-alist)
458 ;;; Macros must be defined before they are used, for the byte compiler.
460 (defmacro dired-mark-if (predicate msg)
461 "Mark all files for which PREDICATE evals to non-nil.
462 PREDICATE is evaluated on each line, with point at beginning of line.
463 MSG is a noun phrase for the type of files being marked.
464 It should end with a noun that can be pluralized by adding `s'.
465 Return value is the number of files marked, or nil if none were marked."
466 `(let ((inhibit-read-only t) count)
467 (save-excursion
468 (setq count 0)
469 (if ,msg (message "Marking %ss..." ,msg))
470 (goto-char (point-min))
471 (while (not (eobp))
472 (if ,predicate
473 (progn
474 (delete-char 1)
475 (insert dired-marker-char)
476 (setq count (1+ count))))
477 (forward-line 1))
478 (if ,msg (message "%s %s%s %s%s."
479 count
480 ,msg
481 (dired-plural-s count)
482 (if (eq dired-marker-char ?\040) "un" "")
483 (if (eq dired-marker-char dired-del-marker)
484 "flagged" "marked"))))
485 (and (> count 0) count)))
487 (defmacro dired-map-over-marks (body arg &optional show-progress
488 distinguish-one-marked)
489 "Eval BODY with point on each marked line. Return a list of BODY's results.
490 If no marked file could be found, execute BODY on the current line.
491 ARG, if non-nil, specifies the files to use instead of the marked files.
492 If ARG is an integer, use the next ARG (or previous -ARG, if
493 ARG<0) files. In that case, point is dragged along. This is
494 so that commands on the next ARG (instead of the marked) files
495 can be chained easily.
496 For any other non-nil value of ARG, use the current file.
497 If optional third arg SHOW-PROGRESS evaluates to non-nil,
498 redisplay the dired buffer after each file is processed.
499 No guarantee is made about the position on the marked line.
500 BODY must ensure this itself if it depends on this.
501 Search starts at the beginning of the buffer, thus the car of the list
502 corresponds to the line nearest to the buffer's bottom. This
503 is also true for (positive and negative) integer values of ARG.
504 BODY should not be too long as it is expanded four times.
506 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
507 return (t FILENAME) instead of (FILENAME)."
509 ;;Warning: BODY must not add new lines before point - this may cause an
510 ;;endless loop.
511 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
512 `(prog1
513 (let ((inhibit-read-only t) case-fold-search found results)
514 (if ,arg
515 (if (integerp ,arg)
516 (progn ;; no save-excursion, want to move point.
517 (dired-repeat-over-lines
518 ,arg
519 (function (lambda ()
520 (if ,show-progress (sit-for 0))
521 (setq results (cons ,body results)))))
522 (if (< ,arg 0)
523 (nreverse results)
524 results))
525 ;; non-nil, non-integer ARG means use current file:
526 (list ,body))
527 (let ((regexp (dired-marker-regexp)) next-position)
528 (save-excursion
529 (goto-char (point-min))
530 ;; remember position of next marked file before BODY
531 ;; can insert lines before the just found file,
532 ;; confusing us by finding the same marked file again
533 ;; and again and...
534 (setq next-position (and (re-search-forward regexp nil t)
535 (point-marker))
536 found (not (null next-position)))
537 (while next-position
538 (goto-char next-position)
539 (if ,show-progress (sit-for 0))
540 (setq results (cons ,body results))
541 ;; move after last match
542 (goto-char next-position)
543 (forward-line 1)
544 (set-marker next-position nil)
545 (setq next-position (and (re-search-forward regexp nil t)
546 (point-marker)))))
547 (if (and ,distinguish-one-marked (= (length results) 1))
548 (setq results (cons t results)))
549 (if found
550 results
551 (list ,body)))))
552 ;; save-excursion loses, again
553 (dired-move-to-filename)))
555 (defun dired-get-marked-files (&optional localp arg filter distinguish-one-marked)
556 "Return the marked files' names as list of strings.
557 The list is in the same order as the buffer, that is, the car is the
558 first marked file.
559 Values returned are normally absolute file names.
560 Optional arg LOCALP as in `dired-get-filename'.
561 Optional second argument ARG, if non-nil, specifies files near
562 point instead of marked files. It usually comes from the prefix
563 argument.
564 If ARG is an integer, use the next ARG files.
565 Any other non-nil value means to use the current file instead.
566 Optional third argument FILTER, if non-nil, is a function to select
567 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
569 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
570 return (t FILENAME) instead of (FILENAME).
571 Don't use that together with FILTER."
572 (let* ((all-of-them
573 (save-excursion
574 (dired-map-over-marks
575 (dired-get-filename localp)
576 arg nil distinguish-one-marked)))
577 result)
578 (if (not filter)
579 (if (and distinguish-one-marked (eq (car all-of-them) t))
580 all-of-them
581 (nreverse all-of-them))
582 (dolist (file all-of-them)
583 (if (funcall filter file)
584 (push file result)))
585 result)))
587 ;; The dired command
589 (defun dired-read-dir-and-switches (str)
590 ;; For use in interactive.
591 (reverse (list
592 (if current-prefix-arg
593 (read-string "Dired listing switches: "
594 dired-listing-switches))
595 ;; If a dialog is about to be used, call read-directory-name so
596 ;; the dialog code knows we want directories. Some dialogs can
597 ;; only select directories or files when popped up, not both.
598 (if (next-read-file-uses-dialog-p)
599 (read-directory-name (format "Dired %s(directory): " str)
600 nil default-directory nil)
601 (let ((default (and buffer-file-name
602 (abbreviate-file-name buffer-file-name))))
603 (minibuffer-with-setup-hook
604 (lambda () (setq minibuffer-default default))
605 (read-file-name (format "Dired %s(directory): " str)
606 nil default-directory nil)))))))
608 ;; We want to switch to a more sophisticated version of
609 ;; dired-read-dir-and-switches like the following, if there is a way
610 ;; to make it more intuitive. See bug#1285.
612 ;; (defun dired-read-dir-and-switches (str)
613 ;; ;; For use in interactive.
614 ;; (reverse
615 ;; (list
616 ;; (if current-prefix-arg
617 ;; (read-string "Dired listing switches: "
618 ;; dired-listing-switches))
619 ;; ;; If a dialog is about to be used, call read-directory-name so
620 ;; ;; the dialog code knows we want directories. Some dialogs can
621 ;; ;; only select directories or files when popped up, not both.
622 ;; (if (next-read-file-uses-dialog-p)
623 ;; (read-directory-name (format "Dired %s(directory): " str)
624 ;; nil default-directory nil)
625 ;; (let ((cie ()))
626 ;; (dolist (ext completion-ignored-extensions)
627 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
628 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
629 ;; (lexical-let* ((default (and buffer-file-name
630 ;; (abbreviate-file-name buffer-file-name)))
631 ;; (cie cie)
632 ;; (completion-table
633 ;; ;; We need a mix of read-file-name and
634 ;; ;; read-directory-name so that completion to directories
635 ;; ;; is preferred, but if the user wants to enter a global
636 ;; ;; pattern, he can still use completion on filenames to
637 ;; ;; help him write the pattern.
638 ;; ;; Essentially, we want to use
639 ;; ;; (completion-table-with-predicate
640 ;; ;; 'read-file-name-internal 'file-directory-p nil)
641 ;; ;; but that doesn't work because read-file-name-internal
642 ;; ;; does not obey its `predicate' argument.
643 ;; (completion-table-in-turn
644 ;; (lambda (str pred action)
645 ;; (let ((read-file-name-predicate
646 ;; (lambda (f)
647 ;; (and (not (member f '("./" "../")))
648 ;; ;; Hack! Faster than file-directory-p!
649 ;; (eq (aref f (1- (length f))) ?/)
650 ;; (not (string-match cie f))))))
651 ;; (complete-with-action
652 ;; action 'read-file-name-internal str nil)))
653 ;; 'read-file-name-internal)))
654 ;; (minibuffer-with-setup-hook
655 ;; (lambda ()
656 ;; (setq minibuffer-default default)
657 ;; (setq minibuffer-completion-table completion-table))
658 ;; (read-file-name (format "Dired %s(directory): " str)
659 ;; nil default-directory nil))))))))
661 ;;;###autoload (define-key ctl-x-map "d" 'dired)
662 ;;;###autoload
663 (defun dired (dirname &optional switches)
664 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
665 Optional second argument SWITCHES specifies the `ls' options used.
666 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
667 Dired displays a list of files in DIRNAME (which may also have
668 shell wildcards appended to select certain files). If DIRNAME is a cons,
669 its first element is taken as the directory name and the rest as an explicit
670 list of files to make directory entries for.
671 \\<dired-mode-map>\
672 You can move around in it with the usual commands.
673 You can flag files for deletion with \\[dired-flag-file-deletion] and then
674 delete them by typing \\[dired-do-flagged-delete].
675 Type \\[describe-mode] after entering Dired for more info.
677 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
678 ;; Cannot use (interactive "D") because of wildcards.
679 (interactive (dired-read-dir-and-switches ""))
680 (switch-to-buffer (dired-noselect dirname switches)))
682 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
683 ;;;###autoload
684 (defun dired-other-window (dirname &optional switches)
685 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
686 (interactive (dired-read-dir-and-switches "in other window "))
687 (switch-to-buffer-other-window (dired-noselect dirname switches)))
689 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
690 ;;;###autoload
691 (defun dired-other-frame (dirname &optional switches)
692 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
693 (interactive (dired-read-dir-and-switches "in other frame "))
694 (switch-to-buffer-other-frame (dired-noselect dirname switches)))
696 ;;;###autoload
697 (defun dired-noselect (dir-or-list &optional switches)
698 "Like `dired' but returns the dired buffer as value, does not select it."
699 (or dir-or-list (setq dir-or-list default-directory))
700 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
701 ;; some shells make:
702 (let (dirname initially-was-dirname)
703 (if (consp dir-or-list)
704 (setq dirname (car dir-or-list))
705 (setq dirname dir-or-list))
706 (setq initially-was-dirname
707 (string= (file-name-as-directory dirname) dirname))
708 (setq dirname (abbreviate-file-name
709 (expand-file-name (directory-file-name dirname))))
710 (if find-file-visit-truename
711 (setq dirname (file-truename dirname)))
712 ;; If the argument was syntactically a directory name not a file name,
713 ;; or if it happens to name a file that is a directory,
714 ;; convert it syntactically to a directory name.
715 ;; The reason for checking initially-was-dirname
716 ;; and not just file-directory-p
717 ;; is that file-directory-p is slow over ftp.
718 (if (or initially-was-dirname (file-directory-p dirname))
719 (setq dirname (file-name-as-directory dirname)))
720 (if (consp dir-or-list)
721 (setq dir-or-list (cons dirname (cdr dir-or-list)))
722 (setq dir-or-list dirname))
723 (dired-internal-noselect dir-or-list switches)))
725 ;; The following is an internal dired function. It returns non-nil if
726 ;; the directory visited by the current dired buffer has changed on
727 ;; disk. DIRNAME should be the directory name of that directory.
728 (defun dired-directory-changed-p (dirname)
729 (not (let ((attributes (file-attributes dirname))
730 (modtime (visited-file-modtime)))
731 (or (eq modtime 0)
732 (not (eq (car attributes) t))
733 (equal (nth 5 attributes) modtime)))))
735 (defun dired-buffer-stale-p (&optional noconfirm)
736 "Return non-nil if current dired buffer needs updating.
737 If NOCONFIRM is non-nil, then this function always returns nil
738 for a remote directory. This feature is used by Auto Revert Mode."
739 (let ((dirname
740 (if (consp dired-directory) (car dired-directory) dired-directory)))
741 (and (stringp dirname)
742 (not (when noconfirm (file-remote-p dirname)))
743 (file-readable-p dirname)
744 ;; Do not auto-revert when the dired buffer can be currently
745 ;; written by the user as in `wdired-mode'.
746 buffer-read-only
747 (dired-directory-changed-p dirname))))
749 (defun dired-internal-noselect (dir-or-list &optional switches mode)
750 ;; If there is an existing dired buffer for DIRNAME, just leave
751 ;; buffer as it is (don't even call dired-revert).
752 ;; This saves time especially for deep trees or with ange-ftp.
753 ;; The user can type `g' easily, and it is more consistent with find-file.
754 ;; But if SWITCHES are given they are probably different from the
755 ;; buffer's old value, so call dired-sort-other, which does
756 ;; revert the buffer.
757 ;; A pity we can't possibly do "Directory has changed - refresh? "
758 ;; like find-file does.
759 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
760 ;; see there.
761 (let* ((old-buf (current-buffer))
762 (dirname (if (consp dir-or-list) (car dir-or-list) dir-or-list))
763 ;; Look for an existing buffer.
764 (buffer (dired-find-buffer-nocreate dirname mode))
765 ;; Note that buffer already is in dired-mode, if found.
766 (new-buffer-p (null buffer)))
767 (or buffer
768 (setq buffer (create-file-buffer (directory-file-name dirname))))
769 (set-buffer buffer)
770 (if (not new-buffer-p) ; existing buffer ...
771 (cond (switches ; ... but new switches
772 ;; file list may have changed
773 (setq dired-directory dir-or-list)
774 ;; this calls dired-revert
775 (dired-sort-other switches))
776 ;; If directory has changed on disk, offer to revert.
777 ((when (dired-directory-changed-p dirname)
778 (message "%s"
779 (substitute-command-keys
780 "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
781 ;; Else a new buffer
782 (setq default-directory
783 ;; We can do this unconditionally
784 ;; because dired-noselect ensures that the name
785 ;; is passed in directory name syntax
786 ;; if it was the name of a directory at all.
787 (file-name-directory dirname))
788 (or switches (setq switches dired-listing-switches))
789 (if mode (funcall mode)
790 (dired-mode dir-or-list switches))
791 ;; default-directory and dired-actual-switches are set now
792 ;; (buffer-local), so we can call dired-readin:
793 (let ((failed t))
794 (unwind-protect
795 (progn (dired-readin)
796 (setq failed nil))
797 ;; dired-readin can fail if parent directories are inaccessible.
798 ;; Don't leave an empty buffer around in that case.
799 (if failed (kill-buffer buffer))))
800 (goto-char (point-min))
801 (dired-initial-position dirname))
802 (set-buffer old-buf)
803 buffer))
805 (defvar dired-buffers nil
806 ;; Enlarged by dired-advertise
807 ;; Queried by function dired-buffers-for-dir. When this detects a
808 ;; killed buffer, it is removed from this list.
809 "Alist of expanded directories and their associated dired buffers.")
811 (defun dired-find-buffer-nocreate (dirname &optional mode)
812 ;; This differs from dired-buffers-for-dir in that it does not consider
813 ;; subdirs of default-directory and searches for the first match only.
814 ;; Also, the major mode must be MODE.
815 (setq dirname (expand-file-name dirname))
816 (let (found (blist dired-buffers)) ; was (buffer-list)
817 (or mode (setq mode 'dired-mode))
818 (while blist
819 (if (null (buffer-name (cdr (car blist))))
820 (setq blist (cdr blist))
821 (save-excursion
822 (set-buffer (cdr (car blist)))
823 (if (and (eq major-mode mode)
824 dired-directory ;; nil during find-alternate-file
825 (equal dirname
826 (expand-file-name
827 (if (consp dired-directory)
828 (car dired-directory)
829 dired-directory))))
830 (setq found (cdr (car blist))
831 blist nil)
832 (setq blist (cdr blist))))))
833 found))
836 ;; Read in a new dired buffer
838 (defun dired-readin ()
839 "Read in a new dired buffer.
840 Differs from `dired-insert-subdir' in that it accepts
841 wildcards, erases the buffer, and builds the subdir-alist anew
842 \(including making it buffer-local and clearing it first)."
844 ;; default-directory and dired-actual-switches must be buffer-local
845 ;; and initialized by now.
846 (let (dirname
847 ;; This makes readin much much faster.
848 ;; In particular, it prevents the font lock hook from running
849 ;; until the directory is all read in.
850 (inhibit-modification-hooks t))
851 (if (consp dired-directory)
852 (setq dirname (car dired-directory))
853 (setq dirname dired-directory))
854 (setq dirname (expand-file-name dirname))
855 (save-excursion
856 ;; This hook which may want to modify dired-actual-switches
857 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
858 ;; where ls won't understand -Al switches.
859 (run-hooks 'dired-before-readin-hook)
860 (if (consp buffer-undo-list)
861 (setq buffer-undo-list nil))
862 (make-local-variable 'file-name-coding-system)
863 (setq file-name-coding-system
864 (or coding-system-for-read file-name-coding-system))
865 (let ((inhibit-read-only t)
866 ;; Don't make undo entries for readin.
867 (buffer-undo-list t))
868 (widen)
869 (erase-buffer)
870 (dired-readin-insert))
871 (goto-char (point-min))
872 ;; Must first make alist buffer local and set it to nil because
873 ;; dired-build-subdir-alist will call dired-clear-alist first
874 (set (make-local-variable 'dired-subdir-alist) nil)
875 (dired-build-subdir-alist)
876 (let ((attributes (file-attributes dirname)))
877 (if (eq (car attributes) t)
878 (set-visited-file-modtime (nth 5 attributes))))
879 (set-buffer-modified-p nil)
880 ;; No need to narrow since the whole buffer contains just
881 ;; dired-readin's output, nothing else. The hook can
882 ;; successfully use dired functions (e.g. dired-get-filename)
883 ;; as the subdir-alist has been built in dired-readin.
884 (run-hooks 'dired-after-readin-hook))))
886 ;; Subroutines of dired-readin
888 (defun dired-readin-insert ()
889 ;; Insert listing for the specified dir (and maybe file list)
890 ;; already in dired-directory, assuming a clean buffer.
891 (let (dir file-list)
892 (if (consp dired-directory)
893 (setq dir (car dired-directory)
894 file-list (cdr dired-directory))
895 (setq dir dired-directory
896 file-list nil))
897 (setq dir (expand-file-name dir))
898 (if (and (equal "" (file-name-nondirectory dir))
899 (not file-list))
900 ;; If we are reading a whole single directory...
901 (dired-insert-directory dir dired-actual-switches nil nil t)
902 (if (not (file-readable-p
903 (directory-file-name (file-name-directory dir))))
904 (error "Directory %s inaccessible or nonexistent" dir)
905 ;; Else treat it as a wildcard spec
906 ;; unless we have an explicit list of files.
907 (dired-insert-directory dir dired-actual-switches
908 file-list (not file-list) t)))))
910 (defun dired-align-file (beg end)
911 "Align the fields of a file to the ones of surrounding lines.
912 BEG..END is the line where the file info is located."
913 ;; Some versions of ls try to adjust the size of each field so as to just
914 ;; hold the largest element ("largest" in the current invocation, of
915 ;; course). So when a single line is output, the size of each field is
916 ;; just big enough for that one output. Thus when dired refreshes one
917 ;; line, the alignment if this line w.r.t the rest is messed up because
918 ;; the fields of that one line will generally be smaller.
920 ;; To work around this problem, we here add spaces to try and
921 ;; re-align the fields as needed. Since this is purely aesthetic,
922 ;; it is of utmost importance that it doesn't mess up anything like
923 ;; `dired-move-to-filename'. To this end, we limit ourselves to
924 ;; adding spaces only, and to only add them at places where there
925 ;; was already at least one space. This way, as long as
926 ;; `directory-listing-before-filename-regexp' always matches spaces
927 ;; with "*" or "+", we know we haven't made anything worse. There
928 ;; is one spot where the exact number of spaces is important, which
929 ;; is just before the actual filename, so we refrain from adding
930 ;; spaces there (and within the filename as well, of course).
931 (save-excursion
932 (let (file file-col other other-col)
933 ;; Check that there is indeed a file, and that there is anoter adjacent
934 ;; file with which to align, and that additional spaces are needed to
935 ;; align the filenames.
936 (when (and (setq file (progn (goto-char beg)
937 (dired-move-to-filename nil end)))
938 (setq file-col (current-column))
939 (setq other
940 (or (and (goto-char beg)
941 (zerop (forward-line -1))
942 (dired-move-to-filename))
943 (and (goto-char beg)
944 (zerop (forward-line 1))
945 (dired-move-to-filename))))
946 (setq other-col (current-column))
947 (/= file other)
948 ;; Make sure there is some work left to do.
949 (> other-col file-col))
950 ;; If we've only looked at the line above, check to see if the line
951 ;; below exists as well and if so, align with the shorter one.
952 (when (and (< other file)
953 (goto-char beg)
954 (zerop (forward-line 1))
955 (dired-move-to-filename))
956 (let ((alt-col (current-column)))
957 (when (< alt-col other-col)
958 (setq other-col alt-col)
959 (setq other (point)))))
960 ;; Keep positions uptodate when we insert stuff.
961 (if (> other file) (setq other (copy-marker other)))
962 (setq file (copy-marker file))
963 ;; Main loop.
964 (goto-char beg)
965 (skip-chars-forward " ") ;Skip to the first field.
966 (while (and (> other-col file-col)
967 ;; Don't touch anything just before (and after) the
968 ;; beginning of the filename.
969 (> file (point)))
970 ;; We're now just in front of a field, with a space behind us.
971 (let* ((curcol (current-column))
972 ;; Nums are right-aligned.
973 (num-align (looking-at "[0-9]"))
974 ;; Let's look at the other line, in the same column: we
975 ;; should be either near the end of the previous field, or
976 ;; in the space between that field and the next.
977 ;; [ Of course, it's also possible that we're already within
978 ;; the next field or even past it, but that's unlikely since
979 ;; other-col > file-col. ]
980 ;; Let's find the distance to the alignment-point (either
981 ;; the beginning or the end of the next field, depending on
982 ;; whether this field is left or right aligned).
983 (align-pt-offset
984 (save-excursion
985 (goto-char other)
986 (move-to-column curcol)
987 (when (looking-at
988 (concat
989 (if (eq (char-before) ?\s) " *" "[^ ]* *")
990 (if num-align "[0-9][^ ]*")))
991 (- (match-end 0) (match-beginning 0)))))
992 ;; Now, the number of spaces to insert is align-pt-offset
993 ;; minus the distance to the equivalent point on the
994 ;; current line.
995 (spaces
996 (if (not num-align)
997 align-pt-offset
998 (and align-pt-offset
999 (save-excursion
1000 (skip-chars-forward "^ ")
1001 (- align-pt-offset (- (current-column) curcol)))))))
1002 (when (and spaces (> spaces 0))
1003 (setq file-col (+ spaces file-col))
1004 (if (> file-col other-col)
1005 (setq spaces (- spaces (- file-col other-col))))
1006 (insert-char ?\s spaces)
1007 ;; Let's just make really sure we did not mess up.
1008 (unless (save-excursion
1009 (eq (dired-move-to-filename) (marker-position file)))
1010 ;; Damn! We messed up: let's revert the change.
1011 (delete-char (- spaces)))))
1012 ;; Now skip to next field.
1013 (skip-chars-forward "^ ") (skip-chars-forward " "))
1014 (set-marker file nil)))))
1017 (defun dired-insert-directory (dir switches &optional file-list wildcard hdr)
1018 "Insert a directory listing of DIR, Dired style.
1019 Use SWITCHES to make the listings.
1020 If FILE-LIST is non-nil, list only those files.
1021 Otherwise, if WILDCARD is non-nil, expand wildcards;
1022 in that case, DIR should be a file name that uses wildcards.
1023 In other cases, DIR should be a directory name or a directory filename.
1024 If HDR is non-nil, insert a header line with the directory name."
1025 (let ((opoint (point))
1026 (process-environment (copy-sequence process-environment))
1027 end)
1028 (if (or dired-use-ls-dired (file-remote-p dir))
1029 (setq switches (concat "--dired " switches)))
1030 ;; We used to specify the C locale here, to force English month names;
1031 ;; but this should not be necessary any more,
1032 ;; with the new value of `directory-listing-before-filename-regexp'.
1033 (if file-list
1034 (dolist (f file-list)
1035 (let ((beg (point)))
1036 (insert-directory f switches nil nil)
1037 ;; Re-align fields, if necessary.
1038 (dired-align-file beg (point))))
1039 (insert-directory dir switches wildcard (not wildcard)))
1040 ;; Quote certain characters, unless ls quoted them for us.
1041 (if (not (string-match "b" dired-actual-switches))
1042 (save-excursion
1043 (setq end (point-marker))
1044 (goto-char opoint)
1045 (while (search-forward "\\" end t)
1046 (replace-match (apply #'propertize
1047 "\\\\"
1048 (text-properties-at (match-beginning 0)))
1049 nil t))
1050 (goto-char opoint)
1051 (while (search-forward "\^m" end t)
1052 (replace-match (apply #'propertize
1053 "\\015"
1054 (text-properties-at (match-beginning 0)))
1055 nil t))
1056 (set-marker end nil)))
1057 (dired-insert-set-properties opoint (point))
1058 ;; If we used --dired and it worked, the lines are already indented.
1059 ;; Otherwise, indent them.
1060 (unless (save-excursion
1061 (goto-char opoint)
1062 (looking-at " "))
1063 (let ((indent-tabs-mode nil))
1064 (indent-rigidly opoint (point) 2)))
1065 ;; Insert text at the beginning to standardize things.
1066 (save-excursion
1067 (goto-char opoint)
1068 (if (and (or hdr wildcard)
1069 (not (and (looking-at "^ \\(.*\\):$")
1070 (file-name-absolute-p (match-string 1)))))
1071 ;; Note that dired-build-subdir-alist will replace the name
1072 ;; by its expansion, so it does not matter whether what we insert
1073 ;; here is fully expanded, but it should be absolute.
1074 (insert " " (directory-file-name (file-name-directory dir)) ":\n"))
1075 (when wildcard
1076 ;; Insert "wildcard" line where "total" line would be for a full dir.
1077 (insert " wildcard " (file-name-nondirectory dir) "\n")))))
1079 (defun dired-insert-set-properties (beg end)
1080 "Make the file names highlight when the mouse is on them."
1081 (save-excursion
1082 (goto-char beg)
1083 (while (< (point) end)
1084 (condition-case nil
1085 (if (dired-move-to-filename)
1086 (add-text-properties
1087 (point)
1088 (save-excursion
1089 (dired-move-to-end-of-filename)
1090 (point))
1091 '(mouse-face highlight
1092 dired-filename t
1093 help-echo "mouse-2: visit this file in other window")))
1094 (error nil))
1095 (forward-line 1))))
1097 ;; Reverting a dired buffer
1099 (defun dired-revert (&optional arg noconfirm)
1100 "Reread the dired buffer.
1101 Must also be called after `dired-actual-switches' have changed.
1102 Should not fail even on completely garbaged buffers.
1103 Preserves old cursor, marks/flags, hidden-p."
1104 (widen) ; just in case user narrowed
1105 (let ((modflag (buffer-modified-p))
1106 (opoint (point))
1107 (ofile (dired-get-filename nil t))
1108 (mark-alist nil) ; save marked files
1109 (hidden-subdirs (dired-remember-hidden))
1110 (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
1111 (case-fold-search nil) ; we check for upper case ls flags
1112 (inhibit-read-only t))
1113 (goto-char (point-min))
1114 (setq mark-alist;; only after dired-remember-hidden since this unhides:
1115 (dired-remember-marks (point-min) (point-max)))
1116 ;; treat top level dir extra (it may contain wildcards)
1117 (dired-uncache
1118 (if (consp dired-directory) (car dired-directory) dired-directory))
1119 ;; Run dired-after-readin-hook just once, below.
1120 (let ((dired-after-readin-hook nil))
1121 (dired-readin)
1122 (dired-insert-old-subdirs old-subdir-alist))
1123 (dired-mark-remembered mark-alist) ; mark files that were marked
1124 ;; ... run the hook for the whole buffer, and only after markers
1125 ;; have been reinserted (else omitting in dired-x would omit marked files)
1126 (run-hooks 'dired-after-readin-hook) ; no need to narrow
1127 (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
1128 (goto-char opoint)) ; was before
1129 (dired-move-to-filename)
1130 (save-excursion ; hide subdirs that were hidden
1131 (dolist (dir hidden-subdirs)
1132 (if (dired-goto-subdir dir)
1133 (dired-hide-subdir 1))))
1134 (unless modflag (restore-buffer-modified-p nil)))
1135 ;; outside of the let scope
1136 ;;; Might as well not override the user if the user changed this.
1137 ;;; (setq buffer-read-only t)
1140 ;; Subroutines of dired-revert
1141 ;; Some of these are also used when inserting subdirs.
1143 (defun dired-remember-marks (beg end)
1144 "Return alist of files and their marks, from BEG to END."
1145 (if selective-display ; must unhide to make this work.
1146 (let ((inhibit-read-only t))
1147 (subst-char-in-region beg end ?\r ?\n)))
1148 (let (fil chr alist)
1149 (save-excursion
1150 (goto-char beg)
1151 (while (re-search-forward dired-re-mark end t)
1152 (if (setq fil (dired-get-filename nil t))
1153 (setq chr (preceding-char)
1154 alist (cons (cons fil chr) alist)))))
1155 alist))
1157 (defun dired-mark-remembered (alist)
1158 "Mark all files remembered in ALIST.
1159 Each element of ALIST looks like (FILE . MARKERCHAR)."
1160 (let (elt fil chr)
1161 (while alist
1162 (setq elt (car alist)
1163 alist (cdr alist)
1164 fil (car elt)
1165 chr (cdr elt))
1166 (if (dired-goto-file fil)
1167 (save-excursion
1168 (beginning-of-line)
1169 (delete-char 1)
1170 (insert chr))))))
1172 (defun dired-remember-hidden ()
1173 "Return a list of names of subdirs currently hidden."
1174 (let ((l dired-subdir-alist) dir pos result)
1175 (while l
1176 (setq dir (car (car l))
1177 pos (cdr (car l))
1178 l (cdr l))
1179 (goto-char pos)
1180 (skip-chars-forward "^\r\n")
1181 (if (eq (following-char) ?\r)
1182 (setq result (cons dir result))))
1183 result))
1185 (defun dired-insert-old-subdirs (old-subdir-alist)
1186 "Try to insert all subdirs that were displayed before.
1187 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1188 (or (string-match "R" dired-actual-switches)
1189 (let (elt dir)
1190 (while old-subdir-alist
1191 (setq elt (car old-subdir-alist)
1192 old-subdir-alist (cdr old-subdir-alist)
1193 dir (car elt))
1194 (condition-case ()
1195 (progn
1196 (dired-uncache dir)
1197 (dired-insert-subdir dir))
1198 (error nil))))))
1200 (defun dired-uncache (dir)
1201 "Remove directory DIR from any directory cache."
1202 (let ((handler (find-file-name-handler dir 'dired-uncache)))
1203 (if handler
1204 (funcall handler 'dired-uncache dir))))
1206 ;; dired mode key bindings and initialization
1208 (defvar dired-mode-map
1209 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1210 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1211 (let ((map (make-keymap)))
1212 (suppress-keymap map)
1213 (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
1214 (define-key map [follow-link] 'mouse-face)
1215 ;; Commands to mark or flag certain categories of files
1216 (define-key map "#" 'dired-flag-auto-save-files)
1217 (define-key map "." 'dired-clean-directory)
1218 (define-key map "~" 'dired-flag-backup-files)
1219 ;; Upper case keys (except !) for operating on the marked files
1220 (define-key map "A" 'dired-do-search)
1221 (define-key map "C" 'dired-do-copy)
1222 (define-key map "B" 'dired-do-byte-compile)
1223 (define-key map "D" 'dired-do-delete)
1224 (define-key map "G" 'dired-do-chgrp)
1225 (define-key map "H" 'dired-do-hardlink)
1226 (define-key map "L" 'dired-do-load)
1227 (define-key map "M" 'dired-do-chmod)
1228 (define-key map "O" 'dired-do-chown)
1229 (define-key map "P" 'dired-do-print)
1230 (define-key map "Q" 'dired-do-query-replace-regexp)
1231 (define-key map "R" 'dired-do-rename)
1232 (define-key map "S" 'dired-do-symlink)
1233 (define-key map "T" 'dired-do-touch)
1234 (define-key map "X" 'dired-do-shell-command)
1235 (define-key map "Z" 'dired-do-compress)
1236 (define-key map "!" 'dired-do-shell-command)
1237 (define-key map "&" 'dired-do-async-shell-command)
1238 ;; Comparison commands
1239 (define-key map "=" 'dired-diff)
1240 (define-key map "\M-=" 'dired-backup-diff)
1241 ;; Tree Dired commands
1242 (define-key map "\M-\C-?" 'dired-unmark-all-files)
1243 (define-key map "\M-\C-d" 'dired-tree-down)
1244 (define-key map "\M-\C-u" 'dired-tree-up)
1245 (define-key map "\M-\C-n" 'dired-next-subdir)
1246 (define-key map "\M-\C-p" 'dired-prev-subdir)
1247 ;; move to marked files
1248 (define-key map "\M-{" 'dired-prev-marked-file)
1249 (define-key map "\M-}" 'dired-next-marked-file)
1250 ;; Make all regexp commands share a `%' prefix:
1251 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1252 ;; but that seems to serve little purpose, and copy-keymap
1253 ;; does a better job without it.
1254 (define-key map "%" nil)
1255 (define-key map "%u" 'dired-upcase)
1256 (define-key map "%l" 'dired-downcase)
1257 (define-key map "%d" 'dired-flag-files-regexp)
1258 (define-key map "%g" 'dired-mark-files-containing-regexp)
1259 (define-key map "%m" 'dired-mark-files-regexp)
1260 (define-key map "%r" 'dired-do-rename-regexp)
1261 (define-key map "%C" 'dired-do-copy-regexp)
1262 (define-key map "%H" 'dired-do-hardlink-regexp)
1263 (define-key map "%R" 'dired-do-rename-regexp)
1264 (define-key map "%S" 'dired-do-symlink-regexp)
1265 (define-key map "%&" 'dired-flag-garbage-files)
1266 ;; Commands for marking and unmarking.
1267 (define-key map "*" nil)
1268 (define-key map "**" 'dired-mark-executables)
1269 (define-key map "*/" 'dired-mark-directories)
1270 (define-key map "*@" 'dired-mark-symlinks)
1271 (define-key map "*%" 'dired-mark-files-regexp)
1272 (define-key map "*c" 'dired-change-marks)
1273 (define-key map "*s" 'dired-mark-subdir-files)
1274 (define-key map "*m" 'dired-mark)
1275 (define-key map "*u" 'dired-unmark)
1276 (define-key map "*?" 'dired-unmark-all-files)
1277 (define-key map "*!" 'dired-unmark-all-marks)
1278 (define-key map "U" 'dired-unmark-all-marks)
1279 (define-key map "*\177" 'dired-unmark-backward)
1280 (define-key map "*\C-n" 'dired-next-marked-file)
1281 (define-key map "*\C-p" 'dired-prev-marked-file)
1282 (define-key map "*t" 'dired-toggle-marks)
1283 ;; Lower keys for commands not operating on all the marked files
1284 (define-key map "a" 'dired-find-alternate-file)
1285 (define-key map "d" 'dired-flag-file-deletion)
1286 (define-key map "e" 'dired-find-file)
1287 (define-key map "f" 'dired-find-file)
1288 (define-key map "\C-m" 'dired-find-file)
1289 (put 'dired-find-file :advertised-binding "\C-m")
1290 (define-key map "g" 'revert-buffer)
1291 (define-key map "h" 'describe-mode)
1292 (define-key map "i" 'dired-maybe-insert-subdir)
1293 (define-key map "j" 'dired-goto-file)
1294 (define-key map "k" 'dired-do-kill-lines)
1295 (define-key map "l" 'dired-do-redisplay)
1296 (define-key map "m" 'dired-mark)
1297 (define-key map "n" 'dired-next-line)
1298 (define-key map "o" 'dired-find-file-other-window)
1299 (define-key map "\C-o" 'dired-display-file)
1300 (define-key map "p" 'dired-previous-line)
1301 (define-key map "q" 'quit-window)
1302 (define-key map "s" 'dired-sort-toggle-or-edit)
1303 (define-key map "t" 'dired-toggle-marks)
1304 (define-key map "u" 'dired-unmark)
1305 (define-key map "v" 'dired-view-file)
1306 (define-key map "w" 'dired-copy-filename-as-kill)
1307 (define-key map "x" 'dired-do-flagged-delete)
1308 (define-key map "y" 'dired-show-file-type)
1309 (define-key map "+" 'dired-create-directory)
1310 ;; moving
1311 (define-key map "<" 'dired-prev-dirline)
1312 (define-key map ">" 'dired-next-dirline)
1313 (define-key map "^" 'dired-up-directory)
1314 (define-key map " " 'dired-next-line)
1315 (define-key map "\C-n" 'dired-next-line)
1316 (define-key map "\C-p" 'dired-previous-line)
1317 (define-key map [down] 'dired-next-line)
1318 (define-key map [up] 'dired-previous-line)
1319 ;; hiding
1320 (define-key map "$" 'dired-hide-subdir)
1321 (define-key map "\M-$" 'dired-hide-all)
1322 ;; isearch
1323 (define-key map (kbd "M-s a C-s") 'dired-do-isearch)
1324 (define-key map (kbd "M-s a M-C-s") 'dired-do-isearch-regexp)
1325 (define-key map (kbd "M-s f C-s") 'dired-isearch-filenames)
1326 (define-key map (kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp)
1327 ;; misc
1328 (define-key map "\C-x\C-q" 'dired-toggle-read-only)
1329 (define-key map "?" 'dired-summary)
1330 (define-key map "\177" 'dired-unmark-backward)
1331 (define-key map [remap undo] 'dired-undo)
1332 (define-key map [remap advertised-undo] 'dired-undo)
1333 ;; thumbnail manipulation (image-dired)
1334 (define-key map "\C-td" 'image-dired-display-thumbs)
1335 (define-key map "\C-tt" 'image-dired-tag-files)
1336 (define-key map "\C-tr" 'image-dired-delete-tag)
1337 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1338 (define-key map "\C-ti" 'image-dired-dired-display-image)
1339 (define-key map "\C-tx" 'image-dired-dired-display-external)
1340 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1341 (define-key map "\C-t." 'image-dired-display-thumb)
1342 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1343 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1344 (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1345 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1346 ;; encryption and decryption (epa-dired)
1347 (define-key map ":d" 'epa-dired-do-decrypt)
1348 (define-key map ":v" 'epa-dired-do-verify)
1349 (define-key map ":s" 'epa-dired-do-sign)
1350 (define-key map ":e" 'epa-dired-do-encrypt)
1352 ;; Make menu bar items.
1354 ;; No need to fo this, now that top-level items are fewer.
1355 ;;;;
1356 ;; Get rid of the Edit menu bar item to save space.
1357 ;(define-key map [menu-bar edit] 'undefined)
1359 (define-key map [menu-bar subdir]
1360 (cons "Subdir" (make-sparse-keymap "Subdir")))
1362 (define-key map [menu-bar subdir hide-all]
1363 '(menu-item "Hide All" dired-hide-all
1364 :help "Hide all subdirectories, leave only header lines"))
1365 (define-key map [menu-bar subdir hide-subdir]
1366 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1367 :help "Hide or unhide current directory listing"))
1368 (define-key map [menu-bar subdir tree-down]
1369 '(menu-item "Tree Down" dired-tree-down
1370 :help "Go to first subdirectory header down the tree"))
1371 (define-key map [menu-bar subdir tree-up]
1372 '(menu-item "Tree Up" dired-tree-up
1373 :help "Go to first subdirectory header up the tree"))
1374 (define-key map [menu-bar subdir up]
1375 '(menu-item "Up Directory" dired-up-directory
1376 :help "Edit the parent directory"))
1377 (define-key map [menu-bar subdir prev-subdir]
1378 '(menu-item "Prev Subdir" dired-prev-subdir
1379 :help "Go to previous subdirectory header line"))
1380 (define-key map [menu-bar subdir next-subdir]
1381 '(menu-item "Next Subdir" dired-next-subdir
1382 :help "Go to next subdirectory header line"))
1383 (define-key map [menu-bar subdir prev-dirline]
1384 '(menu-item "Prev Dirline" dired-prev-dirline
1385 :help "Move to next directory-file line"))
1386 (define-key map [menu-bar subdir next-dirline]
1387 '(menu-item "Next Dirline" dired-next-dirline
1388 :help "Move to previous directory-file line"))
1389 (define-key map [menu-bar subdir insert]
1390 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1391 :help "Insert contents of subdirectory"
1392 :enable (let ((f (dired-get-filename nil t)))
1393 (and f (file-directory-p f)))))
1394 (define-key map [menu-bar immediate]
1395 (cons "Immediate" (make-sparse-keymap "Immediate")))
1397 (define-key map
1398 [menu-bar immediate epa-dired-do-decrypt]
1399 '(menu-item "Decrypt" epa-dired-do-decrypt
1400 :help "Decrypt file at cursor"))
1402 (define-key map
1403 [menu-bar immediate epa-dired-do-verify]
1404 '(menu-item "Verify" epa-dired-do-verify
1405 :help "Verify digital signature of file at cursor"))
1407 (define-key map
1408 [menu-bar immediate epa-dired-do-sign]
1409 '(menu-item "Sign" epa-dired-do-sign
1410 :help "Create digital signature of file at cursor"))
1412 (define-key map
1413 [menu-bar immediate epa-dired-do-encrypt]
1414 '(menu-item "Encrypt" epa-dired-do-encrypt
1415 :help "Encrypt file at cursor"))
1417 (define-key map [menu-bar immediate dashes-4]
1418 '("--"))
1420 (define-key map
1421 [menu-bar immediate image-dired-dired-display-external]
1422 '(menu-item "Display Image Externally" image-dired-dired-display-external
1423 :help "Display image in external viewer"))
1424 (define-key map
1425 [menu-bar immediate image-dired-dired-display-image]
1426 '(menu-item "Display Image" image-dired-dired-display-image
1427 :help "Display sized image in a separate window"))
1429 (define-key map [menu-bar immediate dashes-4]
1430 '("--"))
1432 (define-key map [menu-bar immediate revert-buffer]
1433 '(menu-item "Refresh" revert-buffer
1434 :help "Update contents of shown directories"))
1436 (define-key map [menu-bar immediate dashes]
1437 '("--"))
1439 (define-key map [menu-bar immediate isearch-filenames-regexp]
1440 '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1441 :help "Incrementally search for regexp in file names only"))
1442 (define-key map [menu-bar immediate isearch-filenames]
1443 '(menu-item "Isearch in File Names..." dired-isearch-filenames
1444 :help "Incrementally search for string in file names only."))
1445 (define-key map [menu-bar immediate compare-directories]
1446 '(menu-item "Compare Directories..." dired-compare-directories
1447 :help "Mark files with different attributes in two dired buffers"))
1448 (define-key map [menu-bar immediate backup-diff]
1449 '(menu-item "Compare with Backup" dired-backup-diff
1450 :help "Diff file at cursor with its latest backup"))
1451 (define-key map [menu-bar immediate diff]
1452 '(menu-item "Diff..." dired-diff
1453 :help "Compare file at cursor with another file"))
1454 (define-key map [menu-bar immediate view]
1455 '(menu-item "View This File" dired-view-file
1456 :help "Examine file at cursor in read-only mode"))
1457 (define-key map [menu-bar immediate display]
1458 '(menu-item "Display in Other Window" dired-display-file
1459 :help "Display file at cursor in other window"))
1460 (define-key map [menu-bar immediate find-file-other-window]
1461 '(menu-item "Find in Other Window" dired-find-file-other-window
1462 :help "Edit file at cursor in other window"))
1463 (define-key map [menu-bar immediate find-file]
1464 '(menu-item "Find This File" dired-find-file
1465 :help "Edit file at cursor"))
1466 (define-key map [menu-bar immediate create-directory]
1467 '(menu-item "Create Directory..." dired-create-directory
1468 :help "Create a directory"))
1469 (define-key map [menu-bar immediate wdired-mode]
1470 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1471 :help "Put a dired buffer in a mode in which filenames are editable"
1472 :keys "C-x C-q"
1473 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1475 (define-key map [menu-bar regexp]
1476 (cons "Regexp" (make-sparse-keymap "Regexp")))
1478 (define-key map
1479 [menu-bar regexp image-dired-mark-tagged-files]
1480 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1481 :help "Mark files whose image tags matches regexp"))
1483 (define-key map [menu-bar regexp dashes-1]
1484 '("--"))
1486 (define-key map [menu-bar regexp downcase]
1487 '(menu-item "Downcase" dired-downcase
1488 ;; When running on plain MS-DOS, there's only one
1489 ;; letter-case for file names.
1490 :enable (or (not (fboundp 'msdos-long-file-names))
1491 (msdos-long-file-names))
1492 :help "Rename marked files to lower-case name"))
1493 (define-key map [menu-bar regexp upcase]
1494 '(menu-item "Upcase" dired-upcase
1495 :enable (or (not (fboundp 'msdos-long-file-names))
1496 (msdos-long-file-names))
1497 :help "Rename marked files to upper-case name"))
1498 (define-key map [menu-bar regexp hardlink]
1499 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1500 :help "Make hard links for files matching regexp"))
1501 (define-key map [menu-bar regexp symlink]
1502 '(menu-item "Symlink..." dired-do-symlink-regexp
1503 :visible (fboundp 'make-symbolic-link)
1504 :help "Make symbolic links for files matching regexp"))
1505 (define-key map [menu-bar regexp rename]
1506 '(menu-item "Rename..." dired-do-rename-regexp
1507 :help "Rename marked files matching regexp"))
1508 (define-key map [menu-bar regexp copy]
1509 '(menu-item "Copy..." dired-do-copy-regexp
1510 :help "Copy marked files matching regexp"))
1511 (define-key map [menu-bar regexp flag]
1512 '(menu-item "Flag..." dired-flag-files-regexp
1513 :help "Flag files matching regexp for deletion"))
1514 (define-key map [menu-bar regexp mark]
1515 '(menu-item "Mark..." dired-mark-files-regexp
1516 :help "Mark files matching regexp for future operations"))
1517 (define-key map [menu-bar regexp mark-cont]
1518 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1519 :help "Mark files whose contents matches regexp"))
1521 (define-key map [menu-bar mark]
1522 (cons "Mark" (make-sparse-keymap "Mark")))
1524 (define-key map [menu-bar mark prev]
1525 '(menu-item "Previous Marked" dired-prev-marked-file
1526 :help "Move to previous marked file"))
1527 (define-key map [menu-bar mark next]
1528 '(menu-item "Next Marked" dired-next-marked-file
1529 :help "Move to next marked file"))
1530 (define-key map [menu-bar mark marks]
1531 '(menu-item "Change Marks..." dired-change-marks
1532 :help "Replace marker with another character"))
1533 (define-key map [menu-bar mark unmark-all]
1534 '(menu-item "Unmark All" dired-unmark-all-marks))
1535 (define-key map [menu-bar mark symlinks]
1536 '(menu-item "Mark Symlinks" dired-mark-symlinks
1537 :visible (fboundp 'make-symbolic-link)
1538 :help "Mark all symbolic links"))
1539 (define-key map [menu-bar mark directories]
1540 '(menu-item "Mark Directories" dired-mark-directories
1541 :help "Mark all directories except `.' and `..'"))
1542 (define-key map [menu-bar mark directory]
1543 '(menu-item "Mark Old Backups" dired-clean-directory
1544 :help "Flag old numbered backups for deletion"))
1545 (define-key map [menu-bar mark executables]
1546 '(menu-item "Mark Executables" dired-mark-executables
1547 :help "Mark all executable files"))
1548 (define-key map [menu-bar mark garbage-files]
1549 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1550 :help "Flag unneeded files for deletion"))
1551 (define-key map [menu-bar mark backup-files]
1552 '(menu-item "Flag Backup Files" dired-flag-backup-files
1553 :help "Flag all backup files for deletion"))
1554 (define-key map [menu-bar mark auto-save-files]
1555 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1556 :help "Flag auto-save files for deletion"))
1557 (define-key map [menu-bar mark deletion]
1558 '(menu-item "Flag" dired-flag-file-deletion
1559 :help "Flag current line's file for deletion"))
1560 (define-key map [menu-bar mark unmark]
1561 '(menu-item "Unmark" dired-unmark
1562 :help "Unmark or unflag current line's file"))
1563 (define-key map [menu-bar mark mark]
1564 '(menu-item "Mark" dired-mark
1565 :help "Mark current line's file for future operations"))
1566 (define-key map [menu-bar mark toggle-marks]
1567 '(menu-item "Toggle Marks" dired-toggle-marks
1568 :help "Mark unmarked files, unmark marked ones"))
1570 (define-key map [menu-bar operate]
1571 (cons "Operate" (make-sparse-keymap "Operate")))
1573 (define-key map
1574 [menu-bar operate image-dired-delete-tag]
1575 '(menu-item "Delete Image Tag..." image-dired-delete-tag
1576 :help "Delete image tag from current or marked files"))
1577 (define-key map
1578 [menu-bar operate image-dired-tag-files]
1579 '(menu-item "Add Image Tags..." image-dired-tag-files
1580 :help "Add image tags to current or marked files"))
1581 (define-key map
1582 [menu-bar operate image-dired-dired-comment-files]
1583 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1584 :help "Add image comment to current or marked files"))
1585 (define-key map
1586 [menu-bar operate image-dired-display-thumbs]
1587 '(menu-item "Display image thumbnails" image-dired-display-thumbs
1588 :help "Display image thumbnails for current or marked image files"))
1590 (define-key map [menu-bar operate dashes-3]
1591 '("--"))
1593 (define-key map [menu-bar operate query-replace]
1594 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1595 :help "Replace regexp in marked files"))
1596 (define-key map [menu-bar operate search]
1597 '(menu-item "Search Files..." dired-do-search
1598 :help "Search marked files for regexp"))
1599 (define-key map [menu-bar operate isearch-regexp]
1600 '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1601 :help "Incrementally search marked files for regexp"))
1602 (define-key map [menu-bar operate isearch]
1603 '(menu-item "Isearch Files..." dired-do-isearch
1604 :help "Incrementally search marked files for string"))
1605 (define-key map [menu-bar operate chown]
1606 '(menu-item "Change Owner..." dired-do-chown
1607 :visible (not (memq system-type '(ms-dos windows-nt)))
1608 :help "Change the owner of marked files"))
1609 (define-key map [menu-bar operate chgrp]
1610 '(menu-item "Change Group..." dired-do-chgrp
1611 :visible (not (memq system-type '(ms-dos windows-nt)))
1612 :help "Change the group of marked files"))
1613 (define-key map [menu-bar operate chmod]
1614 '(menu-item "Change Mode..." dired-do-chmod
1615 :help "Change mode (attributes) of marked files"))
1616 (define-key map [menu-bar operate touch]
1617 '(menu-item "Change Timestamp..." dired-do-touch
1618 :help "Change timestamp of marked files"))
1619 (define-key map [menu-bar operate load]
1620 '(menu-item "Load" dired-do-load
1621 :help "Load marked Emacs Lisp files"))
1622 (define-key map [menu-bar operate compile]
1623 '(menu-item "Byte-compile" dired-do-byte-compile
1624 :help "Byte-compile marked Emacs Lisp files"))
1625 (define-key map [menu-bar operate compress]
1626 '(menu-item "Compress" dired-do-compress
1627 :help "Compress/uncompress marked files"))
1628 (define-key map [menu-bar operate print]
1629 '(menu-item "Print..." dired-do-print
1630 :help "Ask for print command and print marked files"))
1631 (define-key map [menu-bar operate hardlink]
1632 '(menu-item "Hardlink to..." dired-do-hardlink
1633 :help "Make hard links for current or marked files"))
1634 (define-key map [menu-bar operate symlink]
1635 '(menu-item "Symlink to..." dired-do-symlink
1636 :visible (fboundp 'make-symbolic-link)
1637 :help "Make symbolic links for current or marked files"))
1638 (define-key map [menu-bar operate async-command]
1639 '(menu-item "Asynchronous Shell Command..." dired-do-async-shell-command
1640 :help "Run a shell command asynchronously on current or marked files"))
1641 (define-key map [menu-bar operate command]
1642 '(menu-item "Shell Command..." dired-do-shell-command
1643 :help "Run a shell command on current or marked files"))
1644 (define-key map [menu-bar operate delete]
1645 '(menu-item "Delete" dired-do-delete
1646 :help "Delete current file or all marked files"))
1647 (define-key map [menu-bar operate rename]
1648 '(menu-item "Rename to..." dired-do-rename
1649 :help "Rename current file or move marked files"))
1650 (define-key map [menu-bar operate copy]
1651 '(menu-item "Copy to..." dired-do-copy
1652 :help "Copy current file or all marked files"))
1654 map)
1655 "Local keymap for `dired-mode' buffers.")
1657 ;; Dired mode is suitable only for specially formatted data.
1658 (put 'dired-mode 'mode-class 'special)
1660 ;; Autoload cookie needed by desktop.el
1661 ;;;###autoload
1662 (defun dired-mode (&optional dirname switches)
1664 Mode for \"editing\" directory listings.
1665 In Dired, you are \"editing\" a list of the files in a directory and
1666 \(optionally) its subdirectories, in the format of `ls -lR'.
1667 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1668 \"Editing\" means that you can run shell commands on files, visit,
1669 compress, load or byte-compile them, change their file attributes
1670 and insert subdirectories into the same buffer. You can \"mark\"
1671 files for later commands or \"flag\" them for deletion, either file
1672 by file or all files matching certain criteria.
1673 You can move using the usual cursor motion commands.\\<dired-mode-map>
1674 Letters no longer insert themselves. Digits are prefix arguments.
1675 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1676 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1677 Most commands operate on the marked files and use the current file
1678 if no files are marked. Use a numeric prefix argument to operate on
1679 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1680 to operate on the current file only. Prefix arguments override marks.
1681 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1682 to see why something went wrong.
1683 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1684 Type \\[dired-unmark-backward] to back up one line and unflag.
1685 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1686 Type \\[dired-find-file] to Find the current line's file
1687 (or dired it in another buffer, if it is a directory).
1688 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1689 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1690 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1691 Type \\[dired-do-copy] to Copy files.
1692 Type \\[dired-sort-toggle-or-edit] to toggle Sorting by name/date or change the `ls' switches.
1693 Type \\[revert-buffer] to read all currently expanded directories aGain.
1694 This retains all marks and hides subdirs again that were hidden before.
1695 SPC and DEL can be used to move down and up by lines.
1697 If Dired ever gets confused, you can either type \\[revert-buffer] \
1698 to read the
1699 directories again, type \\[dired-do-redisplay] \
1700 to relist a single or the marked files or a
1701 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1702 again for the directory tree.
1704 Customization variables (rename this buffer and type \\[describe-variable] on each line
1705 for more info):
1707 `dired-listing-switches'
1708 `dired-trivial-filenames'
1709 `dired-shrink-to-fit'
1710 `dired-marker-char'
1711 `dired-del-marker'
1712 `dired-keep-marker-rename'
1713 `dired-keep-marker-copy'
1714 `dired-keep-marker-hardlink'
1715 `dired-keep-marker-symlink'
1717 Hooks (use \\[describe-variable] to see their documentation):
1719 `dired-before-readin-hook'
1720 `dired-after-readin-hook'
1721 `dired-mode-hook'
1722 `dired-load-hook'
1724 Keybindings:
1725 \\{dired-mode-map}"
1726 ;; Not to be called interactively (e.g. dired-directory will be set
1727 ;; to default-directory, which is wrong with wildcards).
1728 (kill-all-local-variables)
1729 (use-local-map dired-mode-map)
1730 (dired-advertise) ; default-directory is already set
1731 (setq major-mode 'dired-mode
1732 mode-name "Dired"
1733 ;; case-fold-search nil
1734 buffer-read-only t
1735 selective-display t ; for subdirectory hiding
1736 mode-line-buffer-identification
1737 (propertized-buffer-identification "%17b"))
1738 (set (make-local-variable 'revert-buffer-function)
1739 (function dired-revert))
1740 (set (make-local-variable 'buffer-stale-function)
1741 (function dired-buffer-stale-p))
1742 (set (make-local-variable 'page-delimiter)
1743 "\n\n")
1744 (set (make-local-variable 'dired-directory)
1745 (or dirname default-directory))
1746 ;; list-buffers uses this to display the dir being edited in this buffer.
1747 (setq list-buffers-directory
1748 (expand-file-name (if (listp dired-directory)
1749 (car dired-directory)
1750 dired-directory)))
1751 (set (make-local-variable 'dired-actual-switches)
1752 (or switches dired-listing-switches))
1753 (set (make-local-variable 'font-lock-defaults)
1754 '(dired-font-lock-keywords t nil nil beginning-of-line))
1755 (set (make-local-variable 'desktop-save-buffer)
1756 'dired-desktop-buffer-misc-data)
1757 (setq dired-switches-alist nil)
1758 (dired-sort-other dired-actual-switches t)
1759 (when (featurep 'dnd)
1760 (set (make-local-variable 'dnd-protocol-alist)
1761 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1762 (add-hook 'isearch-mode-hook 'dired-isearch-filenames-setup nil t)
1763 (run-mode-hooks 'dired-mode-hook))
1765 ;; Idiosyncratic dired commands that don't deal with marks.
1767 (defun dired-summary ()
1768 "Summarize basic Dired commands and show recent dired errors."
1769 (interactive)
1770 (dired-why)
1771 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1772 (message
1773 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1775 (defun dired-undo ()
1776 "Undo in a dired buffer.
1777 This doesn't recover lost files, it just undoes changes in the buffer itself.
1778 You can use it to recover marks, killed lines or subdirs."
1779 (interactive)
1780 (let ((inhibit-read-only t))
1781 (undo))
1782 (dired-build-subdir-alist)
1783 (message "Change in dired buffer undone.
1784 Actual changes in files cannot be undone by Emacs."))
1786 (defun dired-toggle-read-only ()
1787 "Edit dired buffer with Wdired, or set it read-only.
1788 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1789 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1790 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1791 (interactive)
1792 (if (eq major-mode 'dired-mode)
1793 (wdired-change-to-wdired-mode)
1794 (toggle-read-only)))
1796 (defun dired-next-line (arg)
1797 "Move down lines then position at filename.
1798 Optional prefix ARG says how many lines to move; default is one line."
1799 (interactive "p")
1800 (forward-line arg)
1801 (dired-move-to-filename))
1803 (defun dired-previous-line (arg)
1804 "Move up lines then position at filename.
1805 Optional prefix ARG says how many lines to move; default is one line."
1806 (interactive "p")
1807 (forward-line (- arg))
1808 (dired-move-to-filename))
1810 (defun dired-next-dirline (arg &optional opoint)
1811 "Goto ARG'th next directory file line."
1812 (interactive "p")
1813 (or opoint (setq opoint (point)))
1814 (if (if (> arg 0)
1815 (re-search-forward dired-re-dir nil t arg)
1816 (beginning-of-line)
1817 (re-search-backward dired-re-dir nil t (- arg)))
1818 (dired-move-to-filename) ; user may type `i' or `f'
1819 (goto-char opoint)
1820 (error "No more subdirectories")))
1822 (defun dired-prev-dirline (arg)
1823 "Goto ARG'th previous directory file line."
1824 (interactive "p")
1825 (dired-next-dirline (- arg)))
1827 (defun dired-up-directory (&optional other-window)
1828 "Run Dired on parent directory of current directory.
1829 Find the parent directory either in this buffer or another buffer.
1830 Creates a buffer if necessary."
1831 (interactive "P")
1832 (let* ((dir (dired-current-directory))
1833 (up (file-name-directory (directory-file-name dir))))
1834 (or (dired-goto-file (directory-file-name dir))
1835 ;; Only try dired-goto-subdir if buffer has more than one dir.
1836 (and (cdr dired-subdir-alist)
1837 (dired-goto-subdir up))
1838 (progn
1839 (if other-window
1840 (dired-other-window up)
1841 (dired up))
1842 (dired-goto-file dir)))))
1844 (defun dired-get-file-for-visit ()
1845 "Get the current line's file name, with an error if file does not exist."
1846 (interactive)
1847 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1848 (let ((raw (dired-get-filename nil t))
1849 file-name)
1850 (if (null raw)
1851 (error "No file on this line"))
1852 (setq file-name (file-name-sans-versions raw t))
1853 (if (file-exists-p file-name)
1854 file-name
1855 (if (file-symlink-p file-name)
1856 (error "File is a symlink to a nonexistent target")
1857 (error "File no longer exists; type `g' to update dired buffer")))))
1859 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1860 (define-obsolete-function-alias 'dired-advertised-find-file 'dired-find-file "23.2")
1861 (defun dired-find-file ()
1862 "In Dired, visit the file or directory named on this line."
1863 (interactive)
1864 ;; Bind `find-file-run-dired' so that the command works on directories
1865 ;; too, independent of the user's setting.
1866 (let ((find-file-run-dired t))
1867 (find-file (dired-get-file-for-visit))))
1869 (defun dired-find-alternate-file ()
1870 "In Dired, visit this file or directory instead of the dired buffer."
1871 (interactive)
1872 (set-buffer-modified-p nil)
1873 (find-alternate-file (dired-get-file-for-visit)))
1874 ;; Don't override the setting from .emacs.
1875 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1877 (defun dired-mouse-find-file-other-window (event)
1878 "In Dired, visit the file or directory name you click on."
1879 (interactive "e")
1880 (let (window pos file)
1881 (save-excursion
1882 (setq window (posn-window (event-end event))
1883 pos (posn-point (event-end event)))
1884 (if (not (windowp window))
1885 (error "No file chosen"))
1886 (set-buffer (window-buffer window))
1887 (goto-char pos)
1888 (setq file (dired-get-file-for-visit)))
1889 (if (file-directory-p file)
1890 (or (and (cdr dired-subdir-alist)
1891 (dired-goto-subdir file))
1892 (progn
1893 (select-window window)
1894 (dired-other-window file)))
1895 (select-window window)
1896 (find-file-other-window (file-name-sans-versions file t)))))
1898 (defun dired-view-file ()
1899 "In Dired, examine a file in view mode, returning to Dired when done.
1900 When file is a directory, show it in this buffer if it is inserted.
1901 Otherwise, display it in another buffer."
1902 (interactive)
1903 (let ((file (dired-get-file-for-visit)))
1904 (if (file-directory-p file)
1905 (or (and (cdr dired-subdir-alist)
1906 (dired-goto-subdir file))
1907 (dired file))
1908 (view-file file))))
1910 (defun dired-find-file-other-window ()
1911 "In Dired, visit this file or directory in another window."
1912 (interactive)
1913 (find-file-other-window (dired-get-file-for-visit)))
1915 (defun dired-display-file ()
1916 "In Dired, display this file or directory in another window."
1917 (interactive)
1918 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1920 ;;; Functions for extracting and manipulating file names in Dired buffers.
1922 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1923 "In Dired, return name of file mentioned on this line.
1924 Value returned normally includes the directory name.
1925 Optional arg LOCALP with value `no-dir' means don't include directory
1926 name in result. A value of `verbatim' means to return the name exactly as
1927 it occurs in the buffer, and a value of t means construct name relative to
1928 `default-directory', which still may contain slashes if in a subdirectory.
1929 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1930 regular filenames and return nil if no filename on this line.
1931 Otherwise, an error occurs in these cases."
1932 (let (case-fold-search file p1 p2 already-absolute)
1933 (save-excursion
1934 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1935 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1936 ;; nil if no file on this line, but no-error-if-not-filep is t:
1937 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1938 (progn
1939 ;; Get rid of the mouse-face property that file names have.
1940 (set-text-properties 0 (length file) nil file)
1941 ;; Unquote names quoted by ls or by dired-insert-directory.
1942 ;; This code was written using `read' to unquote, because
1943 ;; it's faster than substituting \007 (4 chars) -> ^G (1
1944 ;; char) etc. in a lisp loop. Unfortunately, this decision
1945 ;; has necessitated hacks such as dealing with filenames
1946 ;; with quotation marks in their names.
1947 (while (string-match "\\(?:[^\\]\\|\\`\\)\\(\"\\)" file)
1948 (setq file (replace-match "\\\"" nil t file 1)))
1949 (setq file (read (concat "\"" file "\"")))
1950 ;; The above `read' will return a unibyte string if FILE
1951 ;; contains eight-bit-control/graphic characters.
1952 (if (and enable-multibyte-characters
1953 (not (multibyte-string-p file)))
1954 (setq file (string-to-multibyte file)))))
1955 (and file (file-name-absolute-p file)
1956 ;; A relative file name can start with ~.
1957 ;; Don't treat it as absolute in this context.
1958 (not (eq (aref file 0) ?~))
1959 (setq already-absolute t))
1960 (cond
1961 ((null file)
1962 nil)
1963 ((eq localp 'verbatim)
1964 file)
1965 ((and (not no-error-if-not-filep)
1966 (member file '("." "..")))
1967 (error "Cannot operate on `.' or `..'"))
1968 ((and (eq localp 'no-dir) already-absolute)
1969 (file-name-nondirectory file))
1970 (already-absolute
1971 (let ((handler (find-file-name-handler file nil)))
1972 ;; check for safe-magic property so that we won't
1973 ;; put /: for names that don't really need them.
1974 ;; For instance, .gz files when auto-compression-mode is on.
1975 (if (and handler (not (get handler 'safe-magic)))
1976 (concat "/:" file)
1977 file)))
1978 ((eq localp 'no-dir)
1979 file)
1980 ((equal (dired-current-directory) "/")
1981 (setq file (concat (dired-current-directory localp) file))
1982 (let ((handler (find-file-name-handler file nil)))
1983 ;; check for safe-magic property so that we won't
1984 ;; put /: for names that don't really need them.
1985 ;; For instance, .gz files when auto-compression-mode is on.
1986 (if (and handler (not (get handler 'safe-magic)))
1987 (concat "/:" file)
1988 file)))
1990 (concat (dired-current-directory localp) file)))))
1992 (defun dired-string-replace-match (regexp string newtext
1993 &optional literal global)
1994 "Replace first match of REGEXP in STRING with NEWTEXT.
1995 If it does not match, nil is returned instead of the new string.
1996 Optional arg LITERAL means to take NEWTEXT literally.
1997 Optional arg GLOBAL means to replace all matches."
1998 (if global
1999 (let ((start 0) ret)
2000 (while (string-match regexp string start)
2001 (let ((from-end (- (length string) (match-end 0))))
2002 (setq ret (setq string (replace-match newtext t literal string)))
2003 (setq start (- (length string) from-end))))
2004 ret)
2005 (if (not (string-match regexp string 0))
2007 (replace-match newtext t literal string))))
2009 (defun dired-make-absolute (file &optional dir)
2010 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2011 ;; We can't always use expand-file-name as this would get rid of `.'
2012 ;; or expand in / instead default-directory if DIR=="".
2013 ;; This should be good enough for ange-ftp.
2014 ;; It should be reasonably fast, though, as it is called in
2015 ;; dired-get-filename.
2016 (concat (or dir default-directory) file))
2018 (defun dired-make-relative (file &optional dir ignore)
2019 "Convert FILE (an absolute file name) to a name relative to DIR.
2020 If this is impossible, return FILE unchanged.
2021 DIR must be a directory name, not a file name."
2022 (or dir (setq dir default-directory))
2023 ;; This case comes into play if default-directory is set to
2024 ;; use ~.
2025 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
2026 (setq dir (expand-file-name dir)))
2027 (if (string-match (concat "^" (regexp-quote dir)) file)
2028 (substring file (match-end 0))
2029 ;;; (or no-error
2030 ;;; (error "%s: not in directory tree growing at %s" file dir))
2031 file))
2033 ;;; Functions for finding the file name in a dired buffer line.
2035 (defvar dired-permission-flags-regexp
2036 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
2037 "Regular expression to match the permission flags in `ls -l'.")
2039 ;; Move to first char of filename on this line.
2040 ;; Returns position (point) or nil if no filename on this line."
2041 (defun dired-move-to-filename (&optional raise-error eol)
2042 "Move to the beginning of the filename on the current line.
2043 Return the position of the beginning of the filename, or nil if none found."
2044 ;; This is the UNIX version.
2045 (or eol (setq eol (line-end-position)))
2046 (beginning-of-line)
2047 ;; First try assuming `ls --dired' was used.
2048 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2049 (cond
2050 ((and change (< change eol))
2051 (goto-char change))
2052 ((re-search-forward directory-listing-before-filename-regexp eol t)
2053 (goto-char (match-end 0)))
2054 ((re-search-forward dired-permission-flags-regexp eol t)
2055 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2056 (if raise-error
2057 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
2058 (beginning-of-line)
2059 nil)
2060 (raise-error
2061 (error "No file on this line")))))
2063 (defun dired-move-to-end-of-filename (&optional no-error)
2064 ;; Assumes point is at beginning of filename,
2065 ;; thus the rwx bit re-search-backward below will succeed in *this*
2066 ;; line if at all. So, it should be called only after
2067 ;; (dired-move-to-filename t).
2068 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2069 ;; This is the UNIX version.
2070 (if (get-text-property (point) 'dired-filename)
2071 (goto-char (next-single-property-change (point) 'dired-filename))
2072 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2073 ;; case-fold-search is nil now, so we can test for capital F:
2074 (setq used-F (string-match "F" dired-actual-switches)
2075 opoint (point)
2076 eol (save-excursion (end-of-line) (point))
2077 hidden (and selective-display
2078 (save-excursion (search-forward "\r" eol t))))
2079 (if hidden
2081 (save-excursion ;; Find out what kind of file this is:
2082 ;; Restrict perm bits to be non-blank,
2083 ;; otherwise this matches one char to early (looking backward):
2084 ;; "l---------" (some systems make symlinks that way)
2085 ;; "----------" (plain file with zero perms)
2086 (if (re-search-backward
2087 dired-permission-flags-regexp nil t)
2088 (setq file-type (char-after (match-beginning 1))
2089 symlink (eq file-type ?l)
2090 ;; Only with -F we need to know whether it's an executable
2091 executable (and
2092 used-F
2093 (string-match
2094 "[xst]" ;; execute bit set anywhere?
2095 (concat
2096 (match-string 2)
2097 (match-string 3)
2098 (match-string 4)))))
2099 (or no-error (error "No file on this line"))))
2100 ;; Move point to end of name:
2101 (if symlink
2102 (if (search-forward " -> " eol t)
2103 (progn
2104 (forward-char -4)
2105 (and used-F
2106 dired-ls-F-marks-symlinks
2107 (eq (preceding-char) ?@) ;; did ls really mark the link?
2108 (forward-char -1))))
2109 (goto-char eol) ;; else not a symbolic link
2110 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2111 ;; one trailing character. (Executable bits on symlinks ain't mean
2112 ;; a thing, even to ls, but we know it's not a symlink.)
2113 (and used-F
2114 (or (memq file-type '(?d ?s ?p))
2115 executable)
2116 (forward-char -1))))
2117 (or no-error
2118 (not (eq opoint (point)))
2119 (error "%s" (if hidden
2120 (substitute-command-keys
2121 "File line is hidden, type \\[dired-hide-subdir] to unhide")
2122 "No file on this line")))
2123 (if (eq opoint (point))
2125 (point)))))
2128 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2130 (defun dired-copy-filename-as-kill (&optional arg)
2131 "Copy names of marked (or next ARG) files into the kill ring.
2132 The names are separated by a space.
2133 With a zero prefix arg, use the absolute file name of each marked file.
2134 With \\[universal-argument], use the file name relative to the dired buffer's
2135 `default-directory'. (This still may contain slashes if in a subdirectory.)
2137 If on a subdir headerline, use absolute subdirname instead;
2138 prefix arg and marked files are ignored in this case.
2140 You can then feed the file name(s) to other commands with \\[yank]."
2141 (interactive "P")
2142 (let ((string
2143 (or (dired-get-subdir)
2144 (mapconcat (function identity)
2145 (if arg
2146 (cond ((zerop (prefix-numeric-value arg))
2147 (dired-get-marked-files))
2148 ((consp arg)
2149 (dired-get-marked-files t))
2151 (dired-get-marked-files
2152 'no-dir (prefix-numeric-value arg))))
2153 (dired-get-marked-files 'no-dir))
2154 " "))))
2155 (if (eq last-command 'kill-region)
2156 (kill-append string nil)
2157 (kill-new string))
2158 (message "%s" string)))
2161 ;; Keeping Dired buffers in sync with the filesystem and with each other
2163 (defun dired-buffers-for-dir (dir &optional file)
2164 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2165 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2166 ;; matches FILE.
2167 ;; The list is in reverse order of buffer creation, most recent last.
2168 ;; As a side effect, killed dired buffers for DIR are removed from
2169 ;; dired-buffers.
2170 (setq dir (file-name-as-directory dir))
2171 (let ((alist dired-buffers) result elt buf)
2172 (while alist
2173 (setq elt (car alist)
2174 buf (cdr elt))
2175 (if (buffer-name buf)
2176 (if (dired-in-this-tree dir (car elt))
2177 (with-current-buffer buf
2178 (and (assoc dir dired-subdir-alist)
2179 (or (null file)
2180 (let ((wildcards
2181 (file-name-nondirectory dired-directory)))
2182 (or (= 0 (length wildcards))
2183 (string-match (dired-glob-regexp wildcards)
2184 file))))
2185 (setq result (cons buf result)))))
2186 ;; else buffer is killed - clean up:
2187 (setq dired-buffers (delq elt dired-buffers)))
2188 (setq alist (cdr alist)))
2189 result))
2191 (defun dired-glob-regexp (pattern)
2192 "Convert glob-pattern PATTERN to a regular expression."
2193 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2194 regexp)
2195 (while (string-match "[[?*]" pattern matched-in-pattern)
2196 (let ((op-end (match-end 0))
2197 (next-op (aref pattern (match-beginning 0))))
2198 (setq regexp (concat regexp
2199 (regexp-quote
2200 (substring pattern matched-in-pattern
2201 (match-beginning 0)))))
2202 (cond ((= next-op ??)
2203 (setq regexp (concat regexp "."))
2204 (setq matched-in-pattern op-end))
2205 ((= next-op ?\[)
2206 ;; Fails to handle ^ yet ????
2207 (let* ((set-start (match-beginning 0))
2208 (set-cont
2209 (if (= (aref pattern (1+ set-start)) ?^)
2210 (+ 3 set-start)
2211 (+ 2 set-start)))
2212 (set-end (string-match "]" pattern set-cont))
2213 (set (substring pattern set-start (1+ set-end))))
2214 (setq regexp (concat regexp set))
2215 (setq matched-in-pattern (1+ set-end))))
2216 ((= next-op ?*)
2217 (setq regexp (concat regexp ".*"))
2218 (setq matched-in-pattern op-end)))))
2219 (concat "\\`"
2220 regexp
2221 (regexp-quote
2222 (substring pattern matched-in-pattern))
2223 "\\'")))
2227 (defun dired-advertise ()
2228 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2229 ;; With wildcards we actually advertise too much.
2230 (let ((expanded-default (expand-file-name default-directory)))
2231 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2232 t ; we have already advertised ourselves
2233 (setq dired-buffers
2234 (cons (cons expanded-default (current-buffer))
2235 dired-buffers)))))
2237 (defun dired-unadvertise (dir)
2238 ;; Remove DIR from the buffer alist in variable dired-buffers.
2239 ;; This has the effect of removing any buffer whose main directory is DIR.
2240 ;; It does not affect buffers in which DIR is a subdir.
2241 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2242 (setq dired-buffers
2243 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2245 ;; Tree Dired
2247 ;;; utility functions
2249 (defun dired-in-this-tree (file dir)
2250 ;;"Is FILE part of the directory tree starting at DIR?"
2251 (let (case-fold-search)
2252 (string-match (concat "^" (regexp-quote dir)) file)))
2254 (defun dired-normalize-subdir (dir)
2255 ;; Prepend default-directory to DIR if relative file name.
2256 ;; dired-get-filename must be able to make a valid file name from a
2257 ;; file and its directory DIR.
2258 (file-name-as-directory
2259 (if (file-name-absolute-p dir)
2261 (expand-file-name dir default-directory))))
2263 (defun dired-get-subdir ()
2264 ;;"Return the subdir name on this line, or nil if not on a headerline."
2265 ;; Look up in the alist whether this is a headerline.
2266 (save-excursion
2267 (let ((cur-dir (dired-current-directory)))
2268 (beginning-of-line) ; alist stores b-o-l positions
2269 (and (zerop (- (point)
2270 (dired-get-subdir-min (assoc cur-dir
2271 dired-subdir-alist))))
2272 cur-dir))))
2274 ;(defun dired-get-subdir-min (elt)
2275 ; (cdr elt))
2276 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2277 (defalias 'dired-get-subdir-min 'cdr)
2279 (defun dired-get-subdir-max (elt)
2280 (save-excursion
2281 (goto-char (dired-get-subdir-min elt))
2282 (dired-subdir-max)))
2284 (defun dired-clear-alist ()
2285 (while dired-subdir-alist
2286 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2287 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2289 (defun dired-subdir-index (dir)
2290 ;; Return an index into alist for use with nth
2291 ;; for the sake of subdir moving commands.
2292 (let (found (index 0) (alist dired-subdir-alist))
2293 (while alist
2294 (if (string= dir (car (car alist)))
2295 (setq alist nil found t)
2296 (setq alist (cdr alist) index (1+ index))))
2297 (if found index nil)))
2299 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2300 "Go to next subdirectory, regardless of level."
2301 ;; Use 0 arg to go to this directory's header line.
2302 ;; NO-SKIP prevents moving to end of header line, returning whatever
2303 ;; position was found in dired-subdir-alist.
2304 (interactive "p")
2305 (let ((this-dir (dired-current-directory))
2306 pos index)
2307 ;; nth with negative arg does not return nil but the first element
2308 (setq index (- (dired-subdir-index this-dir) arg))
2309 (setq pos (if (>= index 0)
2310 (dired-get-subdir-min (nth index dired-subdir-alist))))
2311 (if pos
2312 (progn
2313 (goto-char pos)
2314 (or no-skip (skip-chars-forward "^\n\r"))
2315 (point))
2316 (if no-error-if-not-found
2317 nil ; return nil if not found
2318 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2320 (defun dired-build-subdir-alist (&optional switches)
2321 "Build `dired-subdir-alist' by parsing the buffer.
2322 Returns the new value of the alist.
2323 If optional arg SWITCHES is non-nil, use its value
2324 instead of `dired-actual-switches'."
2325 (interactive)
2326 (dired-clear-alist)
2327 (save-excursion
2328 (let* ((count 0)
2329 (inhibit-read-only t)
2330 (buffer-undo-list t)
2331 (switches (or switches dired-actual-switches))
2332 new-dir-name
2333 (R-ftp-base-dir-regex
2334 ;; Used to expand subdirectory names correctly in recursive
2335 ;; ange-ftp listings.
2336 (and (string-match "R" switches)
2337 (string-match "\\`/.*:\\(/.*\\)" default-directory)
2338 (concat "\\`" (match-string 1 default-directory)))))
2339 (goto-char (point-min))
2340 (setq dired-subdir-alist nil)
2341 (while (re-search-forward dired-subdir-regexp nil t)
2342 ;; Avoid taking a file name ending in a colon
2343 ;; as a subdir name.
2344 (unless (save-excursion
2345 (goto-char (match-beginning 0))
2346 (beginning-of-line)
2347 (forward-char 2)
2348 (save-match-data (looking-at dired-re-perms)))
2349 (save-excursion
2350 (goto-char (match-beginning 1))
2351 (setq new-dir-name
2352 (buffer-substring-no-properties (point) (match-end 1))
2353 new-dir-name
2354 (save-match-data
2355 (if (and R-ftp-base-dir-regex
2356 (not (string= new-dir-name default-directory))
2357 (string-match R-ftp-base-dir-regex new-dir-name))
2358 (concat default-directory
2359 (substring new-dir-name (match-end 0)))
2360 (expand-file-name new-dir-name))))
2361 (delete-region (point) (match-end 1))
2362 (insert new-dir-name))
2363 (setq count (1+ count))
2364 (dired-alist-add-1 new-dir-name
2365 ;; Place a sub directory boundary between lines.
2366 (save-excursion
2367 (goto-char (match-beginning 0))
2368 (beginning-of-line)
2369 (point-marker)))))
2370 (if (and (> count 1) (called-interactively-p 'interactive))
2371 (message "Buffer includes %d directories" count)))
2372 ;; We don't need to sort it because it is in buffer order per
2373 ;; constructionem. Return new alist:
2374 dired-subdir-alist))
2376 (defun dired-alist-add-1 (dir new-marker)
2377 ;; Add new DIR at NEW-MARKER. Don't sort.
2378 (setq dired-subdir-alist
2379 (cons (cons (dired-normalize-subdir dir) new-marker)
2380 dired-subdir-alist)))
2382 (defun dired-goto-next-nontrivial-file ()
2383 ;; Position point on first nontrivial file after point.
2384 (dired-goto-next-file);; so there is a file to compare with
2385 (if (stringp dired-trivial-filenames)
2386 (while (and (not (eobp))
2387 (string-match dired-trivial-filenames
2388 (file-name-nondirectory
2389 (or (dired-get-filename nil t) ""))))
2390 (forward-line 1)
2391 (dired-move-to-filename))))
2393 (defun dired-goto-next-file ()
2394 (let ((max (1- (dired-subdir-max))))
2395 (while (and (not (dired-move-to-filename)) (< (point) max))
2396 (forward-line 1))))
2398 (defun dired-goto-file (file)
2399 "Go to line describing file FILE in this dired buffer."
2400 ;; Return value of point on success, else nil.
2401 ;; FILE must be an absolute file name.
2402 ;; Loses if FILE contains control chars like "\007" for which ls
2403 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2404 ;; it in the buffer.
2405 (interactive
2406 (prog1 ; let push-mark display its message
2407 (list (expand-file-name
2408 (read-file-name "Goto file: "
2409 (dired-current-directory))))
2410 (push-mark)))
2411 (setq file (directory-file-name file)) ; does no harm if no directory
2412 (let (found case-fold-search dir)
2413 (setq dir (or (file-name-directory file)
2414 (error "File name `%s' is not absolute" file)))
2415 (save-excursion
2416 ;; The hair here is to get the result of dired-goto-subdir
2417 ;; without really calling it if we don't have any subdirs.
2418 (if (if (string= dir (expand-file-name default-directory))
2419 (goto-char (point-min))
2420 (and (cdr dired-subdir-alist)
2421 (dired-goto-subdir dir)))
2422 (let ((base (file-name-nondirectory file))
2423 search-string
2424 (boundary (dired-subdir-max)))
2425 (setq search-string
2426 (replace-regexp-in-string "\^m" "\\^m" base nil t))
2427 (setq search-string
2428 (replace-regexp-in-string "\\\\" "\\\\" search-string nil t))
2429 (while (and (not found)
2430 ;; filenames are preceded by SPC, this makes
2431 ;; the search faster (e.g. for the filename "-"!).
2432 (search-forward (concat " " search-string)
2433 boundary 'move))
2434 ;; Match could have BASE just as initial substring or
2435 ;; or in permission bits or date or
2436 ;; not be a proper filename at all:
2437 (if (equal base (dired-get-filename 'no-dir t))
2438 ;; Must move to filename since an (actually
2439 ;; correct) match could have been elsewhere on the
2440 ;; ;; line (e.g. "-" would match somewhere in the
2441 ;; permission bits).
2442 (setq found (dired-move-to-filename))
2443 ;; If this isn't the right line, move forward to avoid
2444 ;; trying this line again.
2445 (forward-line 1))))))
2446 (and found
2447 ;; return value of point (i.e., FOUND):
2448 (goto-char found))))
2450 (defun dired-initial-position (dirname)
2451 ;; Where point should go in a new listing of DIRNAME.
2452 ;; Point assumed at beginning of new subdir line.
2453 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2454 (end-of-line)
2455 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2457 ;; These are hooks which make tree dired work.
2458 ;; They are in this file because other parts of dired need to call them.
2459 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2461 ;; This function is called for each retrieved filename.
2462 ;; It could stand to be faster, though it's mostly function call
2463 ;; overhead. Avoiding the function call seems to save about 10% in
2464 ;; dired-get-filename. Make it a defsubst?
2465 (defun dired-current-directory (&optional localp)
2466 "Return the name of the subdirectory to which this line belongs.
2467 This returns a string with trailing slash, like `default-directory'.
2468 Optional argument means return a file name relative to `default-directory'."
2469 (let ((here (point))
2470 (alist (or dired-subdir-alist
2471 ;; probably because called in a non-dired buffer
2472 (error "No subdir-alist in %s" (current-buffer))))
2473 elt dir)
2474 (while alist
2475 (setq elt (car alist)
2476 dir (car elt)
2477 ;; use `<=' (not `<') as subdir line is part of subdir
2478 alist (if (<= (dired-get-subdir-min elt) here)
2479 nil ; found
2480 (cdr alist))))
2481 (if localp
2482 (dired-make-relative dir default-directory)
2483 dir)))
2485 ;; Subdirs start at the beginning of their header lines and end just
2486 ;; before the beginning of the next header line (or end of buffer).
2488 (defun dired-subdir-max ()
2489 (save-excursion
2490 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2491 (point-max)
2492 (point))))
2494 ;; Deleting files
2496 (defcustom dired-recursive-deletes 'top
2497 "Decide whether recursive deletes are allowed.
2498 A value of nil means no recursive deletes.
2499 `always' means delete recursively without asking. This is DANGEROUS!
2500 `top' means ask for each directory at top level, but delete its subdirectories
2501 without asking.
2502 Anything else means ask for each directory."
2503 :type '(choice :tag "Delete non-empty directories"
2504 (const :tag "Yes" always)
2505 (const :tag "No--only delete empty directories" nil)
2506 (const :tag "Confirm for each directory" t)
2507 (const :tag "Confirm for each top directory only" top))
2508 :group 'dired)
2510 ;; Match anything but `.' and `..'.
2511 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2513 ;; Delete file, possibly delete a directory and all its files.
2514 ;; This function is usefull outside of dired. One could change it's name
2515 ;; to e.g. recursive-delete-file and put it somewhere else.
2516 (defun dired-delete-file (file &optional recursive) "\
2517 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2518 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2519 nil, do not delete.
2520 `always', delete recursively without asking.
2521 `top', ask for each directory at top level.
2522 Anything else, ask for each sub-directory."
2523 ;; This test is equivalent to
2524 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2525 ;; but more efficient
2526 (if (not (eq t (car (file-attributes file))))
2527 (delete-file file)
2528 (if (and recursive
2529 (directory-files file t dired-re-no-dot) ; Not empty.
2530 (or (eq recursive 'always)
2531 (yes-or-no-p (format "Recursive delete of %s? "
2532 (dired-make-relative file)))))
2533 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2534 (setq recursive nil))
2535 (delete-directory file recursive)))
2537 (defun dired-do-flagged-delete (&optional nomessage)
2538 "In Dired, delete the files flagged for deletion.
2539 If NOMESSAGE is non-nil, we don't display any message
2540 if there are no flagged files.
2541 `dired-recursive-deletes' controls whether deletion of
2542 non-empty directories is allowed."
2543 (interactive)
2544 (let* ((dired-marker-char dired-del-marker)
2545 (regexp (dired-marker-regexp))
2546 case-fold-search)
2547 (if (save-excursion (goto-char (point-min))
2548 (re-search-forward regexp nil t))
2549 (dired-internal-do-deletions
2550 ;; this can't move point since ARG is nil
2551 (dired-map-over-marks (cons (dired-get-filename) (point))
2552 nil)
2553 nil)
2554 (or nomessage
2555 (message "(No deletions requested)")))))
2557 (defun dired-do-delete (&optional arg)
2558 "Delete all marked (or next ARG) files.
2559 `dired-recursive-deletes' controls whether deletion of
2560 non-empty directories is allowed."
2561 ;; This is more consistent with the file marking feature than
2562 ;; dired-do-flagged-delete.
2563 (interactive "P")
2564 (dired-internal-do-deletions
2565 ;; this may move point if ARG is an integer
2566 (dired-map-over-marks (cons (dired-get-filename) (point))
2567 arg)
2568 arg))
2570 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2572 (defun dired-internal-do-deletions (l arg)
2573 ;; L is an alist of files to delete, with their buffer positions.
2574 ;; ARG is the prefix arg.
2575 ;; Filenames are absolute.
2576 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2577 ;; That way as changes are made in the buffer they do not shift the
2578 ;; lines still to be changed, so the (point) values in L stay valid.
2579 ;; Also, for subdirs in natural order, a subdir's files are deleted
2580 ;; before the subdir itself - the other way around would not work.
2581 (let ((files (mapcar (function car) l))
2582 (count (length l))
2583 (succ 0))
2584 ;; canonicalize file list for pop up
2585 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2586 (if (dired-mark-pop-up
2587 " *Deletions*" 'delete files dired-deletion-confirmer
2588 (format "Delete %s " (dired-mark-prompt arg files)))
2589 (save-excursion
2590 (let (failures);; files better be in reverse order for this loop!
2591 (while l
2592 (goto-char (cdr (car l)))
2593 (let ((inhibit-read-only t))
2594 (condition-case err
2595 (let ((fn (car (car l))))
2596 (dired-delete-file fn dired-recursive-deletes)
2597 ;; if we get here, removing worked
2598 (setq succ (1+ succ))
2599 (message "%s of %s deletions" succ count)
2600 (dired-fun-in-all-buffers
2601 (file-name-directory fn) (file-name-nondirectory fn)
2602 (function dired-delete-entry) fn))
2603 (error;; catch errors from failed deletions
2604 (dired-log "%s\n" err)
2605 (setq failures (cons (car (car l)) failures)))))
2606 (setq l (cdr l)))
2607 (if (not failures)
2608 (message "%d deletion%s done" count (dired-plural-s count))
2609 (dired-log-summary
2610 (format "%d of %d deletion%s failed"
2611 (length failures) count
2612 (dired-plural-s count))
2613 failures))))
2614 (message "(No deletions performed)")))
2615 (dired-move-to-filename))
2617 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2618 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2619 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2620 ;; (FILE does not include a directory component.)
2621 ;; FILE may be nil, in which case ignore it.
2622 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2623 (let (success-list)
2624 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2625 file))
2626 (with-current-buffer buf
2627 (if (apply fun args)
2628 (setq success-list (cons (buffer-name buf) success-list)))))
2629 success-list))
2631 ;; Delete the entry for FILE from
2632 (defun dired-delete-entry (file)
2633 (save-excursion
2634 (and (dired-goto-file file)
2635 (let ((inhibit-read-only t))
2636 (delete-region (progn (beginning-of-line) (point))
2637 (save-excursion (forward-line 1) (point))))))
2638 (dired-clean-up-after-deletion file))
2640 ;; This is a separate function for the sake of dired-x.el.
2641 (defun dired-clean-up-after-deletion (fn)
2642 ;; Clean up after a deleted file or directory FN.
2643 (save-excursion (and (cdr dired-subdir-alist)
2644 (dired-goto-subdir fn)
2645 (dired-kill-subdir))))
2647 ;; Confirmation
2649 (defun dired-marker-regexp ()
2650 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2652 (defun dired-plural-s (count)
2653 (if (= 1 count) "" "s"))
2655 (defun dired-mark-prompt (arg files)
2656 "Return a string for use in a prompt, either the current file
2657 name, or the marker and a count of marked files."
2658 ;; distinguish-one-marked can cause the first element to be just t.
2659 (if (eq (car files) t) (setq files (cdr files)))
2660 (let ((count (length files)))
2661 (if (= count 1)
2662 (car files)
2663 ;; more than 1 file:
2664 (if (integerp arg)
2665 ;; abs(arg) = count
2666 ;; Perhaps this is nicer, but it also takes more screen space:
2667 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2668 ;; count)
2669 (format "[next %d files]" arg)
2670 (format "%c [%d files]" dired-marker-char count)))))
2672 (defun dired-pop-to-buffer (buf)
2673 "Pop up buffer BUF in a way suitable for Dired."
2674 (let ((split-window-preferred-function
2675 (lambda (window)
2676 (or (and (let ((split-height-threshold 0))
2677 (window-splittable-p (selected-window)))
2678 ;; Try to split the selected window vertically if
2679 ;; that's possible. (Bug#1806)
2680 (split-window-vertically))
2681 ;; Otherwise, try to split WINDOW sensibly.
2682 (split-window-sensibly window)))))
2683 (pop-to-buffer (get-buffer-create buf)))
2684 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2685 (when dired-shrink-to-fit
2686 ;; Try to not delete window when we want to display less than
2687 ;; `window-min-height' lines.
2688 (fit-window-to-buffer (get-buffer-window buf) nil 1)))
2690 (defcustom dired-no-confirm nil
2691 "A list of symbols for commands Dired should not confirm.
2692 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2693 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2694 `touch' and `uncompress'."
2695 :group 'dired
2696 :type '(set (const byte-compile) (const chgrp)
2697 (const chmod) (const chown) (const compress)
2698 (const copy) (const delete) (const hardlink)
2699 (const load) (const move) (const print)
2700 (const shell) (const symlink) (const touch)
2701 (const uncompress)))
2703 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2704 "Return FUNCTION's result on ARGS after showing which files are marked.
2705 Displays the file names in a buffer named BUFNAME;
2706 nil gives \" *Marked Files*\".
2707 This uses function `dired-pop-to-buffer' to do that.
2709 FUNCTION should not manipulate files, just read input
2710 (an argument or confirmation).
2711 The window is not shown if there is just one file or
2712 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2713 FILES is the list of marked files. It can also be (t FILENAME)
2714 in the case of one marked file, to distinguish that from using
2715 just the current file."
2716 (or bufname (setq bufname " *Marked Files*"))
2717 (if (or (eq dired-no-confirm t)
2718 (memq op-symbol dired-no-confirm)
2719 ;; If FILES defaulted to the current line's file.
2720 (= (length files) 1))
2721 (apply function args)
2722 (with-current-buffer (get-buffer-create bufname)
2723 (erase-buffer)
2724 ;; Handle (t FILE) just like (FILE), here.
2725 ;; That value is used (only in some cases), to mean
2726 ;; just one file that was marked, rather than the current line file.
2727 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2728 (remove-text-properties (point-min) (point-max)
2729 '(mouse-face nil help-echo nil)))
2730 (save-window-excursion
2731 (dired-pop-to-buffer bufname)
2732 (apply function args))))
2734 (defun dired-format-columns-of-files (files)
2735 (let ((beg (point)))
2736 (completion--insert-strings files)
2737 (put-text-property beg (point) 'mouse-face nil)))
2739 ;; Commands to mark or flag file(s) at or near current line.
2741 (defun dired-repeat-over-lines (arg function)
2742 ;; This version skips non-file lines.
2743 (let ((pos (make-marker)))
2744 (beginning-of-line)
2745 (while (and (> arg 0) (not (eobp)))
2746 (setq arg (1- arg))
2747 (beginning-of-line)
2748 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2749 (save-excursion
2750 (forward-line 1)
2751 (move-marker pos (1+ (point))))
2752 (save-excursion (funcall function))
2753 ;; Advance to the next line--actually, to the line that *was* next.
2754 ;; (If FUNCTION inserted some new lines in between, skip them.)
2755 (goto-char pos))
2756 (while (and (< arg 0) (not (bobp)))
2757 (setq arg (1+ arg))
2758 (forward-line -1)
2759 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2760 (beginning-of-line)
2761 (save-excursion (funcall function)))
2762 (move-marker pos nil)
2763 (dired-move-to-filename)))
2765 (defun dired-between-files ()
2766 ;; This used to be a regexp match of the `total ...' line output by
2767 ;; ls, which is slightly faster, but that is not very robust; notably,
2768 ;; it fails for non-english locales.
2769 (save-excursion (not (dired-move-to-filename))))
2771 (defun dired-next-marked-file (arg &optional wrap opoint)
2772 "Move to the next marked file, wrapping around the end of the buffer."
2773 (interactive "p\np")
2774 (or opoint (setq opoint (point)));; return to where interactively started
2775 (if (if (> arg 0)
2776 (re-search-forward dired-re-mark nil t arg)
2777 (beginning-of-line)
2778 (re-search-backward dired-re-mark nil t (- arg)))
2779 (dired-move-to-filename)
2780 (if (null wrap)
2781 (progn
2782 (goto-char opoint)
2783 (error "No next marked file"))
2784 (message "(Wraparound for next marked file)")
2785 (goto-char (if (> arg 0) (point-min) (point-max)))
2786 (dired-next-marked-file arg nil opoint))))
2788 (defun dired-prev-marked-file (arg &optional wrap)
2789 "Move to the previous marked file, wrapping around the end of the buffer."
2790 (interactive "p\np")
2791 (dired-next-marked-file (- arg) wrap))
2793 (defun dired-file-marker (file)
2794 ;; Return FILE's marker, or nil if unmarked.
2795 (save-excursion
2796 (and (dired-goto-file file)
2797 (progn
2798 (beginning-of-line)
2799 (if (not (equal ?\040 (following-char)))
2800 (following-char))))))
2802 (defun dired-mark-files-in-region (start end)
2803 (let ((inhibit-read-only t))
2804 (if (> start end)
2805 (error "start > end"))
2806 (goto-char start) ; assumed at beginning of line
2807 (while (< (point) end)
2808 ;; Skip subdir line and following garbage like the `total' line:
2809 (while (and (< (point) end) (dired-between-files))
2810 (forward-line 1))
2811 (if (and (not (looking-at dired-re-dot))
2812 (dired-get-filename nil t))
2813 (progn
2814 (delete-char 1)
2815 (insert dired-marker-char)))
2816 (forward-line 1))))
2818 (defun dired-mark (arg)
2819 "Mark the current (or next ARG) files.
2820 If on a subdir headerline, mark all its files except `.' and `..'.
2822 Use \\[dired-unmark-all-files] to remove all marks
2823 and \\[dired-unmark] on a subdir to remove the marks in
2824 this subdir."
2825 (interactive "P")
2826 (if (dired-get-subdir)
2827 (save-excursion (dired-mark-subdir-files))
2828 (let ((inhibit-read-only t))
2829 (dired-repeat-over-lines
2830 (prefix-numeric-value arg)
2831 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2833 (defun dired-unmark (arg)
2834 "Unmark the current (or next ARG) files.
2835 If looking at a subdir, unmark all its files except `.' and `..'."
2836 (interactive "P")
2837 (let ((dired-marker-char ?\040))
2838 (dired-mark arg)))
2840 (defun dired-flag-file-deletion (arg)
2841 "In Dired, flag the current line's file for deletion.
2842 With prefix arg, repeat over several lines.
2844 If on a subdir headerline, mark all its files except `.' and `..'."
2845 (interactive "P")
2846 (let ((dired-marker-char dired-del-marker))
2847 (dired-mark arg)))
2849 (defun dired-unmark-backward (arg)
2850 "In Dired, move up lines and remove deletion flag there.
2851 Optional prefix ARG says how many lines to unflag; default is one line."
2852 (interactive "p")
2853 (dired-unmark (- arg)))
2855 (defun dired-toggle-marks ()
2856 "Toggle marks: marked files become unmarked, and vice versa.
2857 Files marked with other flags (such as `D') are not affected.
2858 `.' and `..' are never toggled.
2859 As always, hidden subdirs are not affected."
2860 (interactive)
2861 (save-excursion
2862 (goto-char (point-min))
2863 (let ((inhibit-read-only t))
2864 (while (not (eobp))
2865 (or (dired-between-files)
2866 (looking-at dired-re-dot)
2867 ;; use subst instead of insdel because it does not move
2868 ;; the gap and thus should be faster and because
2869 ;; other characters are left alone automatically
2870 (apply 'subst-char-in-region
2871 (point) (1+ (point))
2872 (if (eq ?\040 (following-char)) ; SPC
2873 (list ?\040 dired-marker-char)
2874 (list dired-marker-char ?\040))))
2875 (forward-line 1)))))
2877 ;;; Commands to mark or flag files based on their characteristics or names.
2879 (defvar dired-regexp-history nil
2880 "History list of regular expressions used in Dired commands.")
2882 (defun dired-read-regexp (prompt)
2883 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2885 (defun dired-mark-files-regexp (regexp &optional marker-char)
2886 "Mark all files matching REGEXP for use in later commands.
2887 A prefix argument means to unmark them instead.
2888 `.' and `..' are never marked.
2890 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2891 object files--just `.o' will mark more than you might think."
2892 (interactive
2893 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2894 " files (regexp): "))
2895 (if current-prefix-arg ?\040)))
2896 (let ((dired-marker-char (or marker-char dired-marker-char)))
2897 (dired-mark-if
2898 (and (not (looking-at dired-re-dot))
2899 (not (eolp)) ; empty line
2900 (let ((fn (dired-get-filename nil t)))
2901 (and fn (string-match regexp (file-name-nondirectory fn)))))
2902 "matching file")))
2904 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2905 "Mark all files with contents containing REGEXP for use in later commands.
2906 A prefix argument means to unmark them instead.
2907 `.' and `..' are never marked."
2908 (interactive
2909 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2910 " files containing (regexp): "))
2911 (if current-prefix-arg ?\040)))
2912 (let ((dired-marker-char (or marker-char dired-marker-char)))
2913 (dired-mark-if
2914 (and (not (looking-at dired-re-dot))
2915 (not (eolp)) ; empty line
2916 (let ((fn (dired-get-filename nil t)))
2917 (when (and fn (file-readable-p fn)
2918 (not (file-directory-p fn)))
2919 (let ((prebuf (get-file-buffer fn)))
2920 (message "Checking %s" fn)
2921 ;; For now we do it inside emacs
2922 ;; Grep might be better if there are a lot of files
2923 (if prebuf
2924 (with-current-buffer prebuf
2925 (save-excursion
2926 (goto-char (point-min))
2927 (re-search-forward regexp nil t)))
2928 (with-temp-buffer
2929 (insert-file-contents fn)
2930 (goto-char (point-min))
2931 (re-search-forward regexp nil t))))
2933 "matching file")))
2935 (defun dired-flag-files-regexp (regexp)
2936 "In Dired, flag all files containing the specified REGEXP for deletion.
2937 The match is against the non-directory part of the filename. Use `^'
2938 and `$' to anchor matches. Exclude subdirs by hiding them.
2939 `.' and `..' are never flagged."
2940 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2941 (dired-mark-files-regexp regexp dired-del-marker))
2943 (defun dired-mark-symlinks (unflag-p)
2944 "Mark all symbolic links.
2945 With prefix argument, unflag all those files."
2946 (interactive "P")
2947 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2948 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2950 (defun dired-mark-directories (unflag-p)
2951 "Mark all directory file lines except `.' and `..'.
2952 With prefix argument, unflag all those files."
2953 (interactive "P")
2954 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2955 (dired-mark-if (and (looking-at dired-re-dir)
2956 (not (looking-at dired-re-dot)))
2957 "directory file")))
2959 (defun dired-mark-executables (unflag-p)
2960 "Mark all executable files.
2961 With prefix argument, unflag all those files."
2962 (interactive "P")
2963 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2964 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2966 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2967 ;; files for which PREDICATE returns non-nil.
2969 (defun dired-flag-auto-save-files (&optional unflag-p)
2970 "Flag for deletion files whose names suggest they are auto save files.
2971 A prefix argument says to unflag those files instead."
2972 (interactive "P")
2973 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2974 (dired-mark-if
2975 ;; It is less than general to check for # here,
2976 ;; but it's the only way this runs fast enough.
2977 (and (save-excursion (end-of-line)
2979 (eq (preceding-char) ?#)
2980 ;; Handle executables in case of -F option.
2981 ;; We need not worry about the other kinds
2982 ;; of markings that -F makes, since they won't
2983 ;; appear on real auto-save files.
2984 (if (eq (preceding-char) ?*)
2985 (progn
2986 (forward-char -1)
2987 (eq (preceding-char) ?#)))))
2988 (not (looking-at dired-re-dir))
2989 (let ((fn (dired-get-filename t t)))
2990 (if fn (auto-save-file-name-p
2991 (file-name-nondirectory fn)))))
2992 "auto save file")))
2994 (defcustom dired-garbage-files-regexp
2995 ;; `log' here is dubious, since it's typically used for useful log
2996 ;; files, not just TeX stuff. -- fx
2997 (concat (regexp-opt
2998 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2999 "\\'")
3000 "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
3001 :type 'regexp
3002 :group 'dired)
3004 (defun dired-flag-garbage-files ()
3005 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3006 (interactive)
3007 (dired-flag-files-regexp dired-garbage-files-regexp))
3009 (defun dired-flag-backup-files (&optional unflag-p)
3010 "Flag all backup files (names ending with `~') for deletion.
3011 With prefix argument, unflag these files."
3012 (interactive "P")
3013 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
3014 (dired-mark-if
3015 ;; Don't call backup-file-name-p unless the last character looks like
3016 ;; it might be the end of a backup file name. This isn't very general,
3017 ;; but it's the only way this runs fast enough.
3018 (and (save-excursion (end-of-line)
3019 ;; Handle executables in case of -F option.
3020 ;; We need not worry about the other kinds
3021 ;; of markings that -F makes, since they won't
3022 ;; appear on real backup files.
3023 (if (eq (preceding-char) ?*)
3024 (forward-char -1))
3025 (eq (preceding-char) ?~))
3026 (not (looking-at dired-re-dir))
3027 (let ((fn (dired-get-filename t t)))
3028 (if fn (backup-file-name-p fn))))
3029 "backup file")))
3031 (defun dired-change-marks (&optional old new)
3032 "Change all OLD marks to NEW marks.
3033 OLD and NEW are both characters used to mark files."
3034 (interactive
3035 (let* ((cursor-in-echo-area t)
3036 (old (progn (message "Change (old mark): ") (read-char)))
3037 (new (progn (message "Change %c marks to (new mark): " old)
3038 (read-char))))
3039 (list old new)))
3040 (if (or (eq old ?\r) (eq new ?\r))
3041 (ding)
3042 (let ((string (format "\n%c" old))
3043 (inhibit-read-only t))
3044 (save-excursion
3045 (goto-char (point-min))
3046 (while (search-forward string nil t)
3047 (if (if (= old ?\s)
3048 (save-match-data
3049 (dired-get-filename 'no-dir t))
3051 (subst-char-in-region (match-beginning 0)
3052 (match-end 0) old new)))))))
3054 (defun dired-unmark-all-marks ()
3055 "Remove all marks from all files in the dired buffer."
3056 (interactive)
3057 (dired-unmark-all-files ?\r))
3059 (defun dired-unmark-all-files (mark &optional arg)
3060 "Remove a specific mark (or any mark) from every file.
3061 After this command, type the mark character to remove,
3062 or type RET to remove all marks.
3063 With prefix arg, query for each marked file.
3064 Type \\[help-command] at that time for help."
3065 (interactive "cRemove marks (RET means all): \nP")
3066 (save-excursion
3067 (let* ((count 0)
3068 (inhibit-read-only t) case-fold-search query
3069 (string (format "\n%c" mark))
3070 (help-form "\
3071 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3072 `!' to unmark all remaining files with no more questions."))
3073 (goto-char (point-min))
3074 (while (if (eq mark ?\r)
3075 (re-search-forward dired-re-mark nil t)
3076 (search-forward string nil t))
3077 (if (or (not arg)
3078 (let ((file (dired-get-filename t t)))
3079 (and file
3080 (dired-query 'query "Unmark file `%s'? "
3081 file))))
3082 (progn (subst-char-in-region (1- (point)) (point)
3083 (preceding-char) ?\s)
3084 (setq count (1+ count)))))
3085 (message (if (= count 1) "1 mark removed"
3086 "%d marks removed")
3087 count))))
3089 ;; Logging failures operating on files, and showing the results.
3091 (defvar dired-log-buffer "*Dired log*")
3093 (defun dired-why ()
3094 "Pop up a buffer with error log output from Dired.
3095 A group of errors from a single command ends with a formfeed.
3096 Thus, use \\[backward-page] to find the beginning of a group of errors."
3097 (interactive)
3098 (if (get-buffer dired-log-buffer)
3099 (let ((owindow (selected-window))
3100 (window (display-buffer (get-buffer dired-log-buffer))))
3101 (unwind-protect
3102 (progn
3103 (select-window window)
3104 (goto-char (point-max))
3105 (forward-line -1)
3106 (backward-page 1)
3107 (recenter 0))
3108 (select-window owindow)))))
3110 (defun dired-log (log &rest args)
3111 ;; Log a message or the contents of a buffer.
3112 ;; If LOG is a string and there are more args, it is formatted with
3113 ;; those ARGS. Usually the LOG string ends with a \n.
3114 ;; End each bunch of errors with (dired-log t):
3115 ;; this inserts the current time and buffer at the start of the page,
3116 ;; and \f (formfeed) at the end.
3117 (let ((obuf (current-buffer)))
3118 (with-current-buffer (get-buffer-create dired-log-buffer)
3119 (goto-char (point-max))
3120 (let ((inhibit-read-only t))
3121 (cond ((stringp log)
3122 (insert (if args
3123 (apply (function format) log args)
3124 log)))
3125 ((bufferp log)
3126 (insert-buffer-substring log))
3127 ((eq t log)
3128 (backward-page 1)
3129 (unless (bolp)
3130 (insert "\n"))
3131 (insert (current-time-string)
3132 "\tBuffer `" (buffer-name obuf) "'\n")
3133 (goto-char (point-max))
3134 (insert "\f\n")))))))
3136 (defun dired-log-summary (string failures)
3137 "State a summary of a command's failures, in echo area and log buffer.
3138 STRING is an overall summary of the failures.
3139 FAILURES is a list of file names that we failed to operate on,
3140 or nil if file names are not applicable."
3141 (if (= (length failures) 1)
3142 (message "%s"
3143 (with-current-buffer dired-log-buffer
3144 (goto-char (point-max))
3145 (backward-page 1)
3146 (if (eolp) (forward-line 1))
3147 (buffer-substring (point) (point-max))))
3148 (message (if failures "%s--type ? for details (%s)"
3149 "%s--type ? for details")
3150 string failures))
3151 ;; Log a summary describing a bunch of errors.
3152 (dired-log (concat "\n" string "\n"))
3153 (dired-log t))
3155 ;;; Sorting
3157 ;; Most ls can only sort by name or by date (with -t), nothing else.
3158 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3159 ;; So anything that does not contain these is sort "by name".
3161 (defvar dired-ls-sorting-switches "SXU"
3162 "String of `ls' switches \(single letters\) except \"t\" that influence sorting.
3164 This indicates to Dired which option switches to watch out for because they
3165 will change the sorting order behavior of `ls'.
3167 To change the default sorting order \(e.g. add a `-v' option\), see the
3168 variable `dired-listing-switches'. To temporarily override the listing
3169 format, use `\\[universal-argument] \\[dired]'.")
3171 (defvar dired-sort-by-date-regexp
3172 (concat "^-[^" dired-ls-sorting-switches
3173 "]*t[^" dired-ls-sorting-switches "]*$")
3174 "Regexp recognized by Dired to set `by date' mode.")
3176 (defvar dired-sort-by-name-regexp
3177 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3178 "Regexp recognized by Dired to set `by name' mode.")
3180 (defvar dired-sort-inhibit nil
3181 "Non-nil means the Dired sort command is disabled.
3182 The idea is to set this buffer-locally in special dired buffers.")
3184 (defun dired-sort-set-modeline ()
3185 ;; Set modeline display according to dired-actual-switches.
3186 ;; Modeline display of "by name" or "by date" guarantees the user a
3187 ;; match with the corresponding regexps. Non-matching switches are
3188 ;; shown literally.
3189 (when (eq major-mode 'dired-mode)
3190 (setq mode-name
3191 (let (case-fold-search)
3192 (cond ((string-match
3193 dired-sort-by-name-regexp dired-actual-switches)
3194 "Dired by name")
3195 ((string-match
3196 dired-sort-by-date-regexp dired-actual-switches)
3197 "Dired by date")
3199 (concat "Dired " dired-actual-switches)))))
3200 (force-mode-line-update)))
3202 (defun dired-sort-toggle-or-edit (&optional arg)
3203 "Toggle between sort by date/name and refresh the dired buffer.
3204 With a prefix argument you can edit the current listing switches instead."
3205 (interactive "P")
3206 (when dired-sort-inhibit
3207 (error "Cannot sort this dired buffer"))
3208 (if arg
3209 (dired-sort-other
3210 (read-string "ls switches (must contain -l): " dired-actual-switches))
3211 (dired-sort-toggle)))
3213 (defun dired-sort-toggle ()
3214 ;; Toggle between sort by date/name. Reverts the buffer.
3215 (setq dired-actual-switches
3216 (let (case-fold-search)
3217 (if (string-match " " dired-actual-switches)
3218 ;; New toggle scheme: add/remove a trailing " -t"
3219 (if (string-match " -t\\'" dired-actual-switches)
3220 (substring dired-actual-switches 0 (match-beginning 0))
3221 (concat dired-actual-switches " -t"))
3222 ;; old toggle scheme: look for some 't' switch and add/remove it
3223 (concat
3224 "-l"
3225 (dired-replace-in-string (concat "[-lt"
3226 dired-ls-sorting-switches "]")
3228 dired-actual-switches)
3229 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3230 dired-actual-switches)
3232 "t")))))
3233 (dired-sort-set-modeline)
3234 (revert-buffer))
3236 ;; Some user code loads dired especially for this.
3237 ;; Don't do that--use replace-regexp-in-string instead.
3238 (defun dired-replace-in-string (regexp newtext string)
3239 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3240 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3241 (let ((result "") (start 0) mb me)
3242 (while (string-match regexp string start)
3243 (setq mb (match-beginning 0)
3244 me (match-end 0)
3245 result (concat result (substring string start mb) newtext)
3246 start me))
3247 (concat result (substring string start))))
3249 (defun dired-sort-other (switches &optional no-revert)
3250 "Specify new `ls' SWITCHES for current dired buffer.
3251 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3252 set the minor mode accordingly, others appear literally in the mode line.
3253 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3254 (dired-sort-R-check switches)
3255 (setq dired-actual-switches switches)
3256 (dired-sort-set-modeline)
3257 (or no-revert (revert-buffer)))
3259 (defvar dired-subdir-alist-pre-R nil
3260 "Value of `dired-subdir-alist' before -R switch added.")
3261 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3263 (defun dired-sort-R-check (switches)
3264 "Additional processing of -R in ls option string SWITCHES.
3265 Saves `dired-subdir-alist' when R is set and restores saved value
3266 minus any directories explicitly deleted when R is cleared.
3267 To be called first in body of `dired-sort-other', etc."
3268 (cond
3269 ((and (string-match "R" switches)
3270 (not (string-match "R" dired-actual-switches)))
3271 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3272 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3273 ((and (string-match "R" dired-actual-switches)
3274 (not (string-match "R" switches)))
3275 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3276 ;; that are still present:
3277 (setq dired-subdir-alist
3278 (if dired-subdir-alist-pre-R
3279 (let (subdirs)
3280 (while dired-subdir-alist-pre-R
3281 (if (assoc (caar dired-subdir-alist-pre-R)
3282 dired-subdir-alist)
3283 ;; subdir still present...
3284 (setq subdirs
3285 (cons (car dired-subdir-alist-pre-R)
3286 subdirs)))
3287 (setq dired-subdir-alist-pre-R
3288 (cdr dired-subdir-alist-pre-R)))
3289 (reverse subdirs))
3290 ;; No pre-R subdir alist, so revert to main directory
3291 ;; listing:
3292 (list (car (reverse dired-subdir-alist))))))))
3295 ;;;; Drag and drop support
3297 (defcustom dired-recursive-copies 'top
3298 "Decide whether recursive copies are allowed.
3299 A value of nil means no recursive copies.
3300 `always' means copy recursively without asking.
3301 `top' means ask for each directory at top level.
3302 Anything else means ask for each directory."
3303 :type '(choice :tag "Copy directories"
3304 (const :tag "No recursive copies" nil)
3305 (const :tag "Ask for each directory" t)
3306 (const :tag "Ask for each top directory only" top)
3307 (const :tag "Copy directories without asking" always))
3308 :group 'dired)
3310 (defun dired-dnd-popup-notice ()
3311 (message-box
3312 "Dired recursive copies are currently disabled.\nSee the variable `dired-recursive-copies'."))
3314 (declare-function x-popup-menu "menu.c" (position menu))
3316 (defun dired-dnd-do-ask-action (uri)
3317 ;; No need to get actions and descriptions from the source,
3318 ;; we only have three actions anyway.
3319 (let ((action (x-popup-menu
3321 (list "What action?"
3322 (cons ""
3323 '(("Copy here" . copy)
3324 ("Move here" . move)
3325 ("Link here" . link)
3326 "--"
3327 ("Cancel" . nil)))))))
3328 (if action
3329 (dired-dnd-handle-local-file uri action)
3330 nil)))
3332 (declare-function dired-relist-entry "dired-aux" (file))
3333 (declare-function make-symbolic-link "fileio.c")
3335 ;; Only used when (featurep 'dnd).
3336 (declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3337 (declare-function dnd-get-local-file-uri "dnd" (uri))
3339 (defun dired-dnd-handle-local-file (uri action)
3340 "Copy, move or link a file to the dired directory.
3341 URI is the file to handle, ACTION is one of copy, move, link or ask.
3342 Ask means pop up a menu for the user to select one of copy, move or link."
3343 (require 'dired-aux)
3344 (let* ((from (dnd-get-local-file-name uri t))
3345 (to (when from
3346 (concat (dired-current-directory)
3347 (file-name-nondirectory from)))))
3348 (when from
3349 (cond ((eq action 'ask)
3350 (dired-dnd-do-ask-action uri))
3351 ;; If copying a directory and dired-recursive-copies is
3352 ;; nil, dired-copy-file fails. Pop up a notice.
3353 ((and (memq action '(copy private))
3354 (file-directory-p from)
3355 (not dired-recursive-copies))
3356 (dired-dnd-popup-notice))
3357 ((memq action '(copy private move link))
3358 (let ((overwrite (and (file-exists-p to)
3359 (y-or-n-p
3360 (format "Overwrite existing file `%s'? " to))))
3361 ;; Binding dired-overwrite-confirmed to nil makes
3362 ;; dired-handle-overwrite a no-op. We instead use
3363 ;; y-or-n-p, which pops a graphical menu.
3364 dired-overwrite-confirmed backup-file)
3365 (when (and overwrite
3366 ;; d-b-o is defined in dired-aux.
3367 (boundp 'dired-backup-overwrite)
3368 dired-backup-overwrite
3369 (setq backup-file
3370 (car (find-backup-file-name to)))
3371 (or (eq dired-backup-overwrite 'always)
3372 (y-or-n-p
3373 (format
3374 "Make backup for existing file `%s'? " to))))
3375 (rename-file to backup-file 0)
3376 (dired-relist-entry backup-file))
3377 (cond ((memq action '(copy private))
3378 (dired-copy-file from to overwrite))
3379 ((eq action 'move)
3380 (dired-rename-file from to overwrite))
3381 ((eq action 'link)
3382 (make-symbolic-link from to overwrite)))
3383 (dired-relist-entry to)
3384 action))))))
3386 (defun dired-dnd-handle-file (uri action)
3387 "Copy, move or link a file to the dired directory if it is a local file.
3388 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3389 ACTION is one of copy, move, link or ask.
3390 Ask means pop up a menu for the user to select one of copy, move or link."
3391 (let ((local-file (dnd-get-local-file-uri uri)))
3392 (if local-file (dired-dnd-handle-local-file local-file action)
3393 nil)))
3396 ;;;; Desktop support
3398 (eval-when-compile (require 'desktop))
3400 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3401 "Auxiliary information to be saved in desktop file."
3402 (cons
3403 ;; Value of `dired-directory'.
3404 (if (consp dired-directory)
3405 ;; Directory name followed by list of files.
3406 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3407 (cdr dired-directory))
3408 ;; Directory name, optionally with shell wildcard.
3409 (desktop-file-name dired-directory desktop-dirname))
3410 ;; Subdirectories in `dired-subdir-alist'.
3411 (cdr
3412 (nreverse
3413 (mapcar
3414 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3415 dired-subdir-alist)))))
3417 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3418 desktop-buffer-name
3419 desktop-buffer-misc)
3420 "Restore a dired buffer specified in a desktop file."
3421 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3422 ;; This value is a directory name, optionally with shell wildcard or
3423 ;; a directory name followed by list of files.
3424 (let* ((dired-dir (car desktop-buffer-misc))
3425 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3426 (if (file-directory-p (file-name-directory dir))
3427 (progn
3428 (dired dired-dir)
3429 ;; The following elements of `desktop-buffer-misc' are the keys
3430 ;; from `dired-subdir-alist'.
3431 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3432 (current-buffer))
3433 (message "Desktop: Directory %s no longer exists." dir)
3434 (when desktop-missing-file-warning (sit-for 1))
3435 nil)))
3437 (add-to-list 'desktop-buffer-mode-handlers
3438 '(dired-mode . dired-restore-desktop-buffer))
3441 ;;; Start of automatically extracted autoloads.
3443 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3444 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3445 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3446 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3447 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3448 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3449 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3450 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3451 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3452 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3453 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3454 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3455 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3456 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3457 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3458 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "e207e02ac395d10ee4a09e208081a0ce")
3459 ;;; Generated autoloads from dired-aux.el
3461 (autoload 'dired-diff "dired-aux" "\
3462 Compare file at point with file FILE using `diff'.
3463 FILE defaults to the file at the mark. (That's the mark set by
3464 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
3465 The prompted-for file is the first file given to `diff'.
3466 With prefix arg, prompt for second argument SWITCHES,
3467 which is options for `diff'.
3469 \(fn FILE &optional SWITCHES)" t nil)
3471 (autoload 'dired-backup-diff "dired-aux" "\
3472 Diff this file with its backup file or vice versa.
3473 Uses the latest backup, if there are several numerical backups.
3474 If this file is a backup, diff it with its original.
3475 The backup file is the first file given to `diff'.
3476 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3478 \(fn &optional SWITCHES)" t nil)
3480 (autoload 'dired-compare-directories "dired-aux" "\
3481 Mark files with different file attributes in two dired buffers.
3482 Compare file attributes of files in the current directory
3483 with file attributes in directory DIR2 using PREDICATE on pairs of files
3484 with the same name. Mark files for which PREDICATE returns non-nil.
3485 Mark files with different names if PREDICATE is nil (or interactively
3486 with empty input at the predicate prompt).
3488 PREDICATE is a Lisp expression that can refer to the following variables:
3490 size1, size2 - file size in bytes
3491 mtime1, mtime2 - last modification time in seconds, as a float
3492 fa1, fa2 - list of file attributes
3493 returned by function `file-attributes'
3495 where 1 refers to attribute of file in the current dired buffer
3496 and 2 to attribute of file in second dired buffer.
3498 Examples of PREDICATE:
3500 (> mtime1 mtime2) - mark newer files
3501 (not (= size1 size2)) - mark files with different sizes
3502 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3503 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3504 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3506 \(fn DIR2 PREDICATE)" t nil)
3508 (autoload 'dired-do-chmod "dired-aux" "\
3509 Change the mode of the marked (or next ARG) files.
3510 Symbolic modes like `g+w' are allowed.
3512 \(fn &optional ARG)" t nil)
3514 (autoload 'dired-do-chgrp "dired-aux" "\
3515 Change the group of the marked (or next ARG) files.
3517 \(fn &optional ARG)" t nil)
3519 (autoload 'dired-do-chown "dired-aux" "\
3520 Change the owner of the marked (or next ARG) files.
3522 \(fn &optional ARG)" t nil)
3524 (autoload 'dired-do-touch "dired-aux" "\
3525 Change the timestamp of the marked (or next ARG) files.
3526 This calls touch.
3528 \(fn &optional ARG)" t nil)
3530 (autoload 'dired-do-print "dired-aux" "\
3531 Print the marked (or next ARG) files.
3532 Uses the shell command coming from variables `lpr-command' and
3533 `lpr-switches' as default.
3535 \(fn &optional ARG)" t nil)
3537 (autoload 'dired-clean-directory "dired-aux" "\
3538 Flag numerical backups for deletion.
3539 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3540 Positive prefix arg KEEP overrides `dired-kept-versions';
3541 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3543 To clear the flags on these files, you can use \\[dired-flag-backup-files]
3544 with a prefix argument.
3546 \(fn KEEP)" t nil)
3548 (autoload 'dired-do-async-shell-command "dired-aux" "\
3549 Run a shell command COMMAND on the marked files asynchronously.
3551 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3552 adds `* &' surrounded by whitespace and executes the command asynchronously.
3553 The output appears in the buffer `*Async Shell Command*'.
3555 \(fn COMMAND &optional ARG FILE-LIST)" t nil)
3557 (autoload 'dired-do-shell-command "dired-aux" "\
3558 Run a shell command COMMAND on the marked files.
3559 If no files are marked or a specific numeric prefix arg is given,
3560 the next ARG files are used. Just \\[universal-argument] means the current file.
3561 The prompt mentions the file(s) or the marker, as appropriate.
3563 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3564 COMMAND just once with the entire file list substituted there.
3566 If there is no `*', but there is a `?' in COMMAND, surrounded by
3567 whitespace, this runs COMMAND on each file individually with the
3568 file name substituted for `?'.
3570 Otherwise, this runs COMMAND on each file individually with the
3571 file name added at the end of COMMAND (separated by a space).
3573 `*' and `?' when not surrounded by whitespace have no special
3574 significance for `dired-do-shell-command', and are passed through
3575 normally to the shell, but you must confirm first. To pass `*' by
3576 itself to the shell as a wildcard, type `*\"\"'.
3578 If COMMAND produces output, it goes to a separate buffer.
3580 This feature does not try to redisplay Dired buffers afterward, as
3581 there's no telling what files COMMAND may have changed.
3582 Type \\[dired-do-redisplay] to redisplay the marked files.
3584 When COMMAND runs, its working directory is the top-level directory
3585 of the Dired buffer, so output files usually are created there
3586 instead of in a subdir.
3588 In a noninteractive call (from Lisp code), you must specify
3589 the list of file names explicitly with the FILE-LIST argument, which
3590 can be produced by `dired-get-marked-files', for example.
3592 \(fn COMMAND &optional ARG FILE-LIST)" t nil)
3594 (autoload 'dired-run-shell-command "dired-aux" "\
3595 Not documented
3597 \(fn COMMAND)" nil nil)
3599 (autoload 'dired-do-kill-lines "dired-aux" "\
3600 Kill all marked lines (not the files).
3601 With a prefix argument, kill that many lines starting with the current line.
3602 \(A negative argument kills backward.)
3603 If you use this command with a prefix argument to kill the line
3604 for a file that is a directory, which you have inserted in the
3605 Dired buffer as a subdirectory, then it deletes that subdirectory
3606 from the buffer as well.
3607 To kill an entire subdirectory (without killing its line in the
3608 parent directory), go to its directory header line and use this
3609 command with a prefix argument (the value does not matter).
3611 \(fn &optional ARG FMT)" t nil)
3613 (autoload 'dired-compress-file "dired-aux" "\
3614 Not documented
3616 \(fn FILE)" nil nil)
3618 (autoload 'dired-query "dired-aux" "\
3619 Query user and return nil or t.
3620 Store answer in symbol VAR (which must initially be bound to nil).
3621 Format PROMPT with ARGS.
3622 Binding variable `help-form' will help the user who types the help key.
3624 \(fn QS-VAR QS-PROMPT &rest QS-ARGS)" nil nil)
3626 (autoload 'dired-do-compress "dired-aux" "\
3627 Compress or uncompress marked (or next ARG) files.
3629 \(fn &optional ARG)" t nil)
3631 (autoload 'dired-do-byte-compile "dired-aux" "\
3632 Byte compile marked (or next ARG) Emacs Lisp files.
3634 \(fn &optional ARG)" t nil)
3636 (autoload 'dired-do-load "dired-aux" "\
3637 Load the marked (or next ARG) Emacs Lisp files.
3639 \(fn &optional ARG)" t nil)
3641 (autoload 'dired-do-redisplay "dired-aux" "\
3642 Redisplay all marked (or next ARG) files.
3643 If on a subdir line, redisplay that subdirectory. In that case,
3644 a prefix arg lets you edit the `ls' switches used for the new listing.
3646 Dired remembers switches specified with a prefix arg, so that reverting
3647 the buffer will not reset them. However, using `dired-undo' to re-insert
3648 or delete subdirectories can bypass this machinery. Hence, you sometimes
3649 may have to reset some subdirectory switches after a `dired-undo'.
3650 You can reset all subdirectory switches to the default using
3651 \\<dired-mode-map>\\[dired-reset-subdir-switches].
3652 See Info node `(emacs)Subdir switches' for more details.
3654 \(fn &optional ARG TEST-FOR-SUBDIR)" t nil)
3656 (autoload 'dired-add-file "dired-aux" "\
3657 Not documented
3659 \(fn FILENAME &optional MARKER-CHAR)" nil nil)
3661 (autoload 'dired-remove-file "dired-aux" "\
3662 Not documented
3664 \(fn FILE)" nil nil)
3666 (autoload 'dired-relist-file "dired-aux" "\
3667 Create or update the line for FILE in all Dired buffers it would belong in.
3669 \(fn FILE)" nil nil)
3671 (autoload 'dired-copy-file "dired-aux" "\
3672 Not documented
3674 \(fn FROM TO OK-FLAG)" nil nil)
3676 (autoload 'dired-rename-file "dired-aux" "\
3677 Not documented
3679 \(fn FILE NEWNAME OK-IF-ALREADY-EXISTS)" nil nil)
3681 (autoload 'dired-create-directory "dired-aux" "\
3682 Create a directory called DIRECTORY.
3684 \(fn DIRECTORY)" t nil)
3686 (autoload 'dired-do-copy "dired-aux" "\
3687 Copy all marked (or next ARG) files, or copy the current file.
3688 This normally preserves the last-modified date when copying.
3689 When operating on just the current file, you specify the new name.
3690 When operating on multiple or marked files, you specify a directory,
3691 and new copies of these files are made in that directory
3692 with the same names that the files currently have. The default
3693 suggested for the target directory depends on the value of
3694 `dired-dwim-target', which see.
3696 This command copies symbolic links by creating new ones,
3697 like `cp -d'.
3699 \(fn &optional ARG)" t nil)
3701 (autoload 'dired-do-symlink "dired-aux" "\
3702 Make symbolic links to current file or all marked (or next ARG) files.
3703 When operating on just the current file, you specify the new name.
3704 When operating on multiple or marked files, you specify a directory
3705 and new symbolic links are made in that directory
3706 with the same names that the files currently have. The default
3707 suggested for the target directory depends on the value of
3708 `dired-dwim-target', which see.
3710 For relative symlinks, use \\[dired-do-relsymlink].
3712 \(fn &optional ARG)" t nil)
3714 (autoload 'dired-do-hardlink "dired-aux" "\
3715 Add names (hard links) current file or all marked (or next ARG) files.
3716 When operating on just the current file, you specify the new name.
3717 When operating on multiple or marked files, you specify a directory
3718 and new hard links are made in that directory
3719 with the same names that the files currently have. The default
3720 suggested for the target directory depends on the value of
3721 `dired-dwim-target', which see.
3723 \(fn &optional ARG)" t nil)
3725 (autoload 'dired-do-rename "dired-aux" "\
3726 Rename current file or all marked (or next ARG) files.
3727 When renaming just the current file, you specify the new name.
3728 When renaming multiple or marked files, you specify a directory.
3729 This command also renames any buffers that are visiting the files.
3730 The default suggested for the target directory depends on the value
3731 of `dired-dwim-target', which see.
3733 \(fn &optional ARG)" t nil)
3735 (autoload 'dired-do-rename-regexp "dired-aux" "\
3736 Rename selected files whose names match REGEXP to NEWNAME.
3738 With non-zero prefix argument ARG, the command operates on the next ARG
3739 files. Otherwise, it operates on all the marked files, or the current
3740 file if none are marked.
3742 As each match is found, the user must type a character saying
3743 what to do with it. For directions, type \\[help-command] at that time.
3744 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
3745 REGEXP defaults to the last regexp used.
3747 With a zero prefix arg, renaming by regexp affects the absolute file name.
3748 Normally, only the non-directory part of the file name is used and changed.
3750 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3752 (autoload 'dired-do-copy-regexp "dired-aux" "\
3753 Copy selected files whose names match REGEXP to NEWNAME.
3754 See function `dired-do-rename-regexp' for more info.
3756 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3758 (autoload 'dired-do-hardlink-regexp "dired-aux" "\
3759 Hardlink selected files whose names match REGEXP to NEWNAME.
3760 See function `dired-do-rename-regexp' for more info.
3762 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3764 (autoload 'dired-do-symlink-regexp "dired-aux" "\
3765 Symlink selected files whose names match REGEXP to NEWNAME.
3766 See function `dired-do-rename-regexp' for more info.
3768 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3770 (autoload 'dired-upcase "dired-aux" "\
3771 Rename all marked (or next ARG) files to upper case.
3773 \(fn &optional ARG)" t nil)
3775 (autoload 'dired-downcase "dired-aux" "\
3776 Rename all marked (or next ARG) files to lower case.
3778 \(fn &optional ARG)" t nil)
3780 (autoload 'dired-maybe-insert-subdir "dired-aux" "\
3781 Insert this subdirectory into the same dired buffer.
3782 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
3783 else inserts it at its natural place (as `ls -lR' would have done).
3784 With a prefix arg, you may edit the ls switches used for this listing.
3785 You can add `R' to the switches to expand the whole tree starting at
3786 this subdirectory.
3787 This function takes some pains to conform to `ls -lR' output.
3789 Dired remembers switches specified with a prefix arg, so that reverting
3790 the buffer will not reset them. However, using `dired-undo' to re-insert
3791 or delete subdirectories can bypass this machinery. Hence, you sometimes
3792 may have to reset some subdirectory switches after a `dired-undo'.
3793 You can reset all subdirectory switches to the default using
3794 \\<dired-mode-map>\\[dired-reset-subdir-switches].
3795 See Info node `(emacs)Subdir switches' for more details.
3797 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
3799 (autoload 'dired-insert-subdir "dired-aux" "\
3800 Insert this subdirectory into the same dired buffer.
3801 If it is already present, overwrites previous entry,
3802 else inserts it at its natural place (as `ls -lR' would have done).
3803 With a prefix arg, you may edit the `ls' switches used for this listing.
3804 You can add `R' to the switches to expand the whole tree starting at
3805 this subdirectory.
3806 This function takes some pains to conform to `ls -lR' output.
3808 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
3810 (autoload 'dired-prev-subdir "dired-aux" "\
3811 Go to previous subdirectory, regardless of level.
3812 When called interactively and not on a subdir line, go to this subdir's line.
3814 \(fn ARG &optional NO-ERROR-IF-NOT-FOUND NO-SKIP)" t nil)
3816 (autoload 'dired-goto-subdir "dired-aux" "\
3817 Go to end of header line of DIR in this dired buffer.
3818 Return value of point on success, otherwise return nil.
3819 The next char is either \\n, or \\r if DIR is hidden.
3821 \(fn DIR)" t nil)
3823 (autoload 'dired-mark-subdir-files "dired-aux" "\
3824 Mark all files except `.' and `..' in current subdirectory.
3825 If the Dired buffer shows multiple directories, this command
3826 marks the files listed in the subdirectory that point is in.
3828 \(fn)" t nil)
3830 (autoload 'dired-kill-subdir "dired-aux" "\
3831 Remove all lines of current subdirectory.
3832 Lower levels are unaffected.
3834 \(fn &optional REMEMBER-MARKS)" t nil)
3836 (autoload 'dired-tree-up "dired-aux" "\
3837 Go up ARG levels in the dired tree.
3839 \(fn ARG)" t nil)
3841 (autoload 'dired-tree-down "dired-aux" "\
3842 Go down in the dired tree.
3844 \(fn)" t nil)
3846 (autoload 'dired-hide-subdir "dired-aux" "\
3847 Hide or unhide the current subdirectory and move to next directory.
3848 Optional prefix arg is a repeat factor.
3849 Use \\[dired-hide-all] to (un)hide all directories.
3851 \(fn ARG)" t nil)
3853 (autoload 'dired-hide-all "dired-aux" "\
3854 Hide all subdirectories, leaving only their header lines.
3855 If there is already something hidden, make everything visible again.
3856 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory.
3858 \(fn ARG)" t nil)
3860 (autoload 'dired-isearch-filenames-setup "dired-aux" "\
3861 Set up isearch to search in Dired file names.
3862 Intended to be added to `isearch-mode-hook'.
3864 \(fn)" nil nil)
3866 (autoload 'dired-isearch-filenames "dired-aux" "\
3867 Search for a string using Isearch only in file names in the Dired buffer.
3869 \(fn)" t nil)
3871 (autoload 'dired-isearch-filenames-regexp "dired-aux" "\
3872 Search for a regexp using Isearch only in file names in the Dired buffer.
3874 \(fn)" t nil)
3876 (autoload 'dired-do-isearch "dired-aux" "\
3877 Search for a string through all marked files using Isearch.
3879 \(fn)" t nil)
3881 (autoload 'dired-do-isearch-regexp "dired-aux" "\
3882 Search for a regexp through all marked files using Isearch.
3884 \(fn)" t nil)
3886 (autoload 'dired-do-search "dired-aux" "\
3887 Search through all marked files for a match for REGEXP.
3888 Stops when a match is found.
3889 To continue searching for next match, use command \\[tags-loop-continue].
3891 \(fn REGEXP)" t nil)
3893 (autoload 'dired-do-query-replace-regexp "dired-aux" "\
3894 Do `query-replace-regexp' of FROM with TO, on all marked files.
3895 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
3896 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
3897 with the command \\[tags-loop-continue].
3899 \(fn FROM TO &optional DELIMITED)" t nil)
3901 (autoload 'dired-show-file-type "dired-aux" "\
3902 Print the type of FILE, according to the `file' command.
3903 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
3904 true then the type of the file linked to by FILE is printed instead.
3906 \(fn FILE &optional DEREF-SYMLINKS)" t nil)
3908 ;;;***
3910 ;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
3911 ;;;;;; "7c58535b489f23d5503ef8219c7d1282")
3912 ;;; Generated autoloads from dired-x.el
3914 (autoload 'dired-jump "dired-x" "\
3915 Jump to dired buffer corresponding to current buffer.
3916 If in a file, dired the current directory and move to file's line.
3917 If in Dired already, pop up a level and goto old directory's line.
3918 In case the proper dired file line cannot be found, refresh the dired
3919 buffer and try again.
3921 \(fn &optional OTHER-WINDOW)" t nil)
3923 (autoload 'dired-do-relsymlink "dired-x" "\
3924 Relative symlink all marked (or next ARG) files into a directory.
3925 Otherwise make a relative symbolic link to the current file.
3926 This creates relative symbolic links like
3928 foo -> ../bar/foo
3930 not absolute ones like
3932 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
3934 For absolute symlinks, use \\[dired-do-symlink].
3936 \(fn &optional ARG)" t nil)
3938 ;;;***
3940 ;;; End of automatically extracted autoloads.
3942 (provide 'dired)
3944 (run-hooks 'dired-load-hook) ; for your customizations
3946 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3947 ;;; dired.el ends here