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