Merge branch 'master' into comment-cache
[emacs.git] / lisp / dired-aux.el
blobcaa3b45705b513450be1d25c41a2a26ee3b6f6c8
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985-1986, 1992, 1994, 1998, 2000-2017 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: files
9 ;; Package: emacs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; The parts of dired mode not normally used. This is a space-saving hack
29 ;; to avoid having to load a large mode when all that's wanted are a few
30 ;; functions.
32 ;; Rewritten in 1990/1991 to add tree features, file marking and
33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34 ;; Finished up by rms in 1992.
36 ;;; Code:
38 (require 'cl-lib)
39 ;; We need macros in dired.el to compile properly,
40 ;; and we call subroutines in it too.
41 (require 'dired)
43 (defvar dired-create-files-failures nil
44 "Variable where `dired-create-files' records failing file names.
45 Functions that operate recursively can store additional names
46 into this list; they also should call `dired-log' to log the errors.")
48 ;;; 15K
49 ;;;###begin dired-cmd.el
50 ;; Diffing and compressing
52 (defconst dired-star-subst-regexp "\\(^\\|[ \t]\\)\\*\\([ \t]\\|$\\)")
53 (defconst dired-quark-subst-regexp "\\(^\\|[ \t]\\)\\?\\([ \t]\\|$\\)")
55 ;;;###autoload
56 (defun dired-diff (file &optional switches)
57 "Compare file at point with FILE using `diff'.
58 If called interactively, prompt for FILE.
59 If the mark is active in Transient Mark mode, use the file at the mark
60 as the default for FILE. (That's the mark set by \\[set-mark-command],
61 not by Dired's \\[dired-mark] command.)
62 If the file at point has a backup file, use that as the default FILE.
63 If the file at point is a backup file, use its original, if that exists
64 and can be found. Note that customizations of `backup-directory-alist'
65 and `make-backup-file-name-function' change where this function searches
66 for the backup file, and affect its ability to find the original of a
67 backup file.
69 FILE is the first argument given to the `diff' function. The file at
70 point is the second argument given to `diff'.
72 With prefix arg, prompt for second argument SWITCHES, which is
73 the string of command switches used as the third argument of `diff'."
74 (interactive
75 (let* ((current (dired-get-filename t))
76 ;; Get the latest existing backup file or its original.
77 (oldf (if (backup-file-name-p current)
78 (file-name-sans-versions current)
79 (diff-latest-backup-file current)))
80 ;; Get the file at the mark.
81 (file-at-mark (if (and transient-mark-mode mark-active)
82 (save-excursion (goto-char (mark t))
83 (dired-get-filename t t))))
84 (separate-dir (and oldf
85 (not (equal (file-name-directory oldf)
86 (dired-current-directory)))))
87 (default-file (or file-at-mark
88 ;; If the file with which to compare
89 ;; doesn't exist, or we cannot intuit it,
90 ;; we forget that name and don't show it
91 ;; as the default, as an indication to the
92 ;; user that she should type the file
93 ;; name.
94 (and (if (and oldf (file-readable-p oldf)) oldf)
95 (if separate-dir
96 oldf
97 (file-name-nondirectory oldf)))))
98 ;; Use it as default if it's not the same as the current file,
99 ;; and the target dir is current or there is a default file.
100 (default (if (and (not (equal default-file current))
101 (or (equal (dired-dwim-target-directory)
102 (dired-current-directory))
103 default-file))
104 default-file))
105 (target-dir (if default
106 (if separate-dir
107 (file-name-directory default)
108 (dired-current-directory))
109 (dired-dwim-target-directory)))
110 (defaults (dired-dwim-target-defaults (list current) target-dir)))
111 (list
112 (minibuffer-with-setup-hook
113 (lambda ()
114 (set (make-local-variable 'minibuffer-default-add-function) nil)
115 (setq minibuffer-default defaults))
116 (read-file-name
117 (format "Diff %s with%s: " current
118 (if default (format " (default %s)" default) ""))
119 target-dir default t))
120 (if current-prefix-arg
121 (read-string "Options for diff: "
122 (if (stringp diff-switches)
123 diff-switches
124 (mapconcat 'identity diff-switches " ")))))))
125 (let ((current (dired-get-filename t)))
126 (when (or (equal (expand-file-name file)
127 (expand-file-name current))
128 (and (file-directory-p file)
129 (equal (expand-file-name current file)
130 (expand-file-name current))))
131 (error "Attempt to compare the file to itself"))
132 (if (and (backup-file-name-p current)
133 (equal file (file-name-sans-versions current)))
134 (diff current file switches)
135 (diff file current switches))))
137 ;;;###autoload
138 (defun dired-backup-diff (&optional switches)
139 "Diff this file with its backup file or vice versa.
140 Uses the latest backup, if there are several numerical backups.
141 If this file is a backup, diff it with its original.
142 The backup file is the first file given to `diff'.
143 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
144 (interactive
145 (if current-prefix-arg
146 (list (read-string "Options for diff: "
147 (if (stringp diff-switches)
148 diff-switches
149 (mapconcat 'identity diff-switches " "))))
150 nil))
151 (diff-backup (dired-get-filename) switches))
153 ;;;###autoload
154 (defun dired-compare-directories (dir2 predicate)
155 "Mark files with different file attributes in two dired buffers.
156 Compare file attributes of files in the current directory
157 with file attributes in directory DIR2 using PREDICATE on pairs of files
158 with the same name. Mark files for which PREDICATE returns non-nil.
159 Mark files with different names if PREDICATE is nil (or interactively
160 with empty input at the predicate prompt).
162 PREDICATE is a Lisp expression that can refer to the following variables:
164 size1, size2 - file size in bytes
165 mtime1, mtime2 - last modification time in seconds, as a float
166 fa1, fa2 - list of file attributes
167 returned by function `file-attributes'
169 where 1 refers to attribute of file in the current dired buffer
170 and 2 to attribute of file in second dired buffer.
172 Examples of PREDICATE:
174 (> mtime1 mtime2) - mark newer files
175 (not (= size1 size2)) - mark files with different sizes
176 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
177 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
178 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
179 (interactive
180 (list
181 (let* ((target-dir (dired-dwim-target-directory))
182 (defaults (dired-dwim-target-defaults nil target-dir)))
183 (minibuffer-with-setup-hook
184 (lambda ()
185 (set (make-local-variable 'minibuffer-default-add-function) nil)
186 (setq minibuffer-default defaults))
187 (read-directory-name (format "Compare %s with: "
188 (dired-current-directory))
189 target-dir target-dir t)))
190 (read-from-minibuffer "Mark if (lisp expr or RET): " nil nil t nil "nil")))
191 (let* ((dir1 (dired-current-directory))
192 (file-alist1 (dired-files-attributes dir1))
193 (file-alist2 (dired-files-attributes dir2))
194 file-list1 file-list2)
195 (setq file-alist1 (delq (assoc "." file-alist1) file-alist1))
196 (setq file-alist1 (delq (assoc ".." file-alist1) file-alist1))
197 (setq file-alist2 (delq (assoc "." file-alist2) file-alist2))
198 (setq file-alist2 (delq (assoc ".." file-alist2) file-alist2))
199 (setq file-list1 (mapcar
200 'cadr
201 (dired-file-set-difference
202 file-alist1 file-alist2
203 predicate))
204 file-list2 (mapcar
205 'cadr
206 (dired-file-set-difference
207 file-alist2 file-alist1
208 predicate)))
209 (dired-fun-in-all-buffers
210 dir1 nil
211 (lambda ()
212 (dired-mark-if
213 (member (dired-get-filename nil t) file-list1) nil)))
214 (dired-fun-in-all-buffers
215 dir2 nil
216 (lambda ()
217 (dired-mark-if
218 (member (dired-get-filename nil t) file-list2) nil)))
219 (message "Marked in dir1: %s files, in dir2: %s files"
220 (length file-list1)
221 (length file-list2))))
223 (defun dired-file-set-difference (list1 list2 predicate)
224 "Combine LIST1 and LIST2 using a set-difference operation.
225 The result list contains all file items that appear in LIST1 but not LIST2.
226 This is a non-destructive function; it makes a copy of the data if necessary
227 to avoid corrupting the original LIST1 and LIST2.
228 PREDICATE (see `dired-compare-directories') is an additional match
229 condition. Two file items are considered to match if they are equal
230 *and* PREDICATE evaluates to t."
231 (if (or (null list1) (null list2))
232 list1
233 (let (res)
234 (dolist (file1 list1)
235 (unless (let ((list list2))
236 (while (and list
237 (let* ((file2 (car list))
238 (fa1 (car (cddr file1)))
239 (fa2 (car (cddr file2))))
241 (not (equal (car file1) (car file2)))
242 (eval predicate
243 `((fa1 . ,fa1)
244 (fa2 . ,fa2)
245 (size1 . ,(nth 7 fa1))
246 (size2 . ,(nth 7 fa2))
247 (mtime1
248 . ,(float-time (nth 5 fa1)))
249 (mtime2
250 . ,(float-time (nth 5 fa2)))
251 )))))
252 (setq list (cdr list)))
253 list)
254 (push file1 res)))
255 (nreverse res))))
257 (defun dired-files-attributes (dir)
258 "Return a list of all file names and attributes from DIR.
259 List has a form of (file-name full-file-name (attribute-list))."
260 (mapcar
261 (lambda (file-name)
262 (let ((full-file-name (expand-file-name file-name dir)))
263 (list file-name
264 full-file-name
265 (file-attributes full-file-name))))
266 (directory-files dir)))
268 ;;; Change file attributes
270 (defun dired-do-chxxx (attribute-name program op-symbol arg)
271 ;; Change file attributes (group, owner, timestamp) of marked files and
272 ;; refresh their file lines.
273 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
274 ;; PROGRAM is the program used to change the attribute.
275 ;; OP-SYMBOL is the type of operation (for use in `dired-mark-pop-up').
276 ;; ARG describes which files to use, as in `dired-get-marked-files'.
277 (let* ((files (dired-get-marked-files t arg))
278 ;; The source of default file attributes is the file at point.
279 (default-file (dired-get-filename t t))
280 (default (when default-file
281 (cond ((eq op-symbol 'touch)
282 (format-time-string
283 "%Y%m%d%H%M.%S"
284 (nth 5 (file-attributes default-file))))
285 ((eq op-symbol 'chown)
286 (nth 2 (file-attributes default-file 'string)))
287 ((eq op-symbol 'chgrp)
288 (nth 3 (file-attributes default-file 'string))))))
289 (prompt (concat "Change " attribute-name " of %s to"
290 (if (eq op-symbol 'touch)
291 " (default now): "
292 ": ")))
293 (new-attribute (dired-mark-read-string prompt nil op-symbol
294 arg files default
295 (cond ((eq op-symbol 'chown)
296 (system-users))
297 ((eq op-symbol 'chgrp)
298 (system-groups)))))
299 (operation (concat program " " new-attribute))
300 ;; When file-name-coding-system is set to something different
301 ;; from locale-coding-system, leaving the encoding
302 ;; determination to call-process will do the wrong thing,
303 ;; because the arguments in this case are file names, not
304 ;; just some arbitrary text. (This must be bound last, to
305 ;; avoid adverse effects on any of the preceding forms.)
306 (coding-system-for-write (or file-name-coding-system
307 default-file-name-coding-system))
308 failures)
309 (setq failures
310 (dired-bunch-files 10000
311 (function dired-check-process)
312 (append
313 (list operation program)
314 (unless (or (string-equal new-attribute "")
315 ;; Use `eq' instead of `equal'
316 ;; to detect empty input (bug#12399).
317 (eq new-attribute default))
318 (if (eq op-symbol 'touch)
319 (list "-t" new-attribute)
320 (list new-attribute)))
321 (if (string-match-p "gnu" system-configuration)
322 '("--") nil))
323 files))
324 (dired-do-redisplay arg);; moves point if ARG is an integer
325 (if failures
326 (dired-log-summary
327 (format "%s: error" operation)
328 nil))))
330 ;;;###autoload
331 (defun dired-do-chmod (&optional arg)
332 "Change the mode of the marked (or next ARG) files.
333 Symbolic modes like `g+w' are allowed.
334 Type M-n to pull the file attributes of the file at point
335 into the minibuffer."
336 (interactive "P")
337 (let* ((files (dired-get-marked-files t arg))
338 ;; The source of default file attributes is the file at point.
339 (default-file (dired-get-filename t t))
340 (modestr (when default-file
341 (nth 8 (file-attributes default-file))))
342 (default
343 (and (stringp modestr)
344 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
345 (replace-regexp-in-string
346 "-" ""
347 (format "u=%s,g=%s,o=%s"
348 (match-string 1 modestr)
349 (match-string 2 modestr)
350 (match-string 3 modestr)))))
351 (modes (dired-mark-read-string
352 "Change mode of %s to: "
353 nil 'chmod arg files default))
354 num-modes)
355 (cond ((or (equal modes "")
356 ;; Use `eq' instead of `equal'
357 ;; to detect empty input (bug#12399).
358 (eq modes default))
359 ;; We used to treat empty input as DEFAULT, but that is not
360 ;; such a good idea (Bug#9361).
361 (error "No file mode specified"))
362 ((string-match-p "^[0-7]+" modes)
363 (setq num-modes (string-to-number modes 8))))
365 (dolist (file files)
366 (set-file-modes
367 file
368 (if num-modes num-modes
369 (file-modes-symbolic-to-number modes (file-modes file)))))
370 (dired-do-redisplay arg)))
372 ;;;###autoload
373 (defun dired-do-chgrp (&optional arg)
374 "Change the group of the marked (or next ARG) files.
375 Type M-n to pull the file attributes of the file at point
376 into the minibuffer."
377 (interactive "P")
378 (if (memq system-type '(ms-dos windows-nt))
379 (error "chgrp not supported on this system"))
380 (dired-do-chxxx "Group" "chgrp" 'chgrp arg))
382 ;;;###autoload
383 (defun dired-do-chown (&optional arg)
384 "Change the owner of the marked (or next ARG) files.
385 Type M-n to pull the file attributes of the file at point
386 into the minibuffer."
387 (interactive "P")
388 (if (memq system-type '(ms-dos windows-nt))
389 (error "chown not supported on this system"))
390 (dired-do-chxxx "Owner" dired-chown-program 'chown arg))
392 ;;;###autoload
393 (defun dired-do-touch (&optional arg)
394 "Change the timestamp of the marked (or next ARG) files.
395 This calls touch.
396 Type M-n to pull the file attributes of the file at point
397 into the minibuffer."
398 (interactive "P")
399 (dired-do-chxxx "Timestamp" dired-touch-program 'touch arg))
401 ;; Process all the files in FILES in batches of a convenient size,
402 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
403 ;; Batches are chosen to need less than MAX chars for the file names,
404 ;; allowing 3 extra characters of separator per file name.
405 (defun dired-bunch-files (max function args files)
406 (let (pending
407 past
408 (pending-length 0)
409 failures)
410 ;; Accumulate files as long as they fit in MAX chars,
411 ;; then process the ones accumulated so far.
412 (while files
413 (let* ((thisfile (car files))
414 (thislength (+ (length thisfile) 3))
415 (rest (cdr files)))
416 ;; If we have at least 1 pending file
417 ;; and this file won't fit in the length limit, process now.
418 (if (and pending (> (+ thislength pending-length) max))
419 (setq pending (nreverse pending)
420 ;; The elements of PENDING are now in forward order.
421 ;; Do the operation and record failures.
422 failures (nconc (apply function (append args pending))
423 failures)
424 ;; Transfer the elements of PENDING onto PAST
425 ;; and clear it out. Now PAST contains the first N files
426 ;; specified (for some N), and FILES contains the rest.
427 past (nconc past pending)
428 pending nil
429 pending-length 0))
430 ;; Do (setq pending (cons thisfile pending))
431 ;; but reuse the cons that was in `files'.
432 (setcdr files pending)
433 (setq pending files)
434 (setq pending-length (+ thislength pending-length))
435 (setq files rest)))
436 (setq pending (nreverse pending))
437 (prog1
438 (nconc (apply function (append args pending))
439 failures)
440 ;; Now the original list FILES has been put back as it was.
441 (nconc past pending))))
443 (defvar lpr-printer-switch)
445 ;;;###autoload
446 (defun dired-do-print (&optional arg)
447 "Print the marked (or next ARG) files.
448 Uses the shell command coming from variables `lpr-command' and
449 `lpr-switches' as default."
450 (interactive "P")
451 (require 'lpr)
452 (let* ((file-list (dired-get-marked-files t arg))
453 (lpr-switches
454 (if (and (stringp printer-name)
455 (string< "" printer-name))
456 (cons (concat lpr-printer-switch printer-name)
457 lpr-switches)
458 lpr-switches))
459 (command (dired-mark-read-string
460 "Print %s with: "
461 (mapconcat 'identity
462 (cons lpr-command
463 (if (stringp lpr-switches)
464 (list lpr-switches)
465 lpr-switches))
466 " ")
467 'print arg file-list)))
468 (dired-run-shell-command (dired-shell-stuff-it command file-list nil))))
470 (defun dired-mark-read-string (prompt initial op-symbol arg files
471 &optional default-value collection)
472 "Read args for a Dired marked-files command, prompting with PROMPT.
473 Return the user input (a string).
475 INITIAL, if non-nil, is the initial minibuffer input.
476 OP-SYMBOL is an operation symbol (see `dired-no-confirm').
477 ARG is normally the prefix argument for the calling command;
478 it is passed as the first argument to `dired-mark-prompt'.
479 FILES should be a list of marked files' names.
481 Optional arg DEFAULT-VALUE is a default value or list of default
482 values, passed as the seventh arg to `completing-read'.
484 Optional arg COLLECTION is a collection of possible completions,
485 passed as the second arg to `completing-read'."
486 (dired-mark-pop-up nil op-symbol files
487 'completing-read
488 (format prompt (dired-mark-prompt arg files))
489 collection nil nil initial nil default-value nil))
491 ;;; Cleaning a directory: flagging some backups for deletion.
493 (defvar dired-file-version-alist)
495 ;;;###autoload
496 (defun dired-clean-directory (keep)
497 "Flag numerical backups for deletion.
498 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
499 Positive prefix arg KEEP overrides `dired-kept-versions';
500 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
502 To clear the flags on these files, you can use \\[dired-flag-backup-files]
503 with a prefix argument."
504 (interactive "P")
505 (setq keep (if keep (prefix-numeric-value keep) dired-kept-versions))
506 (let ((early-retention (if (< keep 0) (- keep) kept-old-versions))
507 (late-retention (if (<= keep 0) dired-kept-versions keep))
508 (dired-file-version-alist ()))
509 (message "Cleaning numerical backups (keeping %d late, %d old)..."
510 late-retention early-retention)
511 ;; Look at each file.
512 ;; If the file has numeric backup versions,
513 ;; put on dired-file-version-alist an element of the form
514 ;; (FILENAME . VERSION-NUMBER-LIST)
515 (dired-map-dired-file-lines (function dired-collect-file-versions))
516 ;; Sort each VERSION-NUMBER-LIST,
517 ;; and remove the versions not to be deleted.
518 (let ((fval dired-file-version-alist))
519 (while fval
520 (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<)))
521 (v-count (length sorted-v-list)))
522 (if (> v-count (+ early-retention late-retention))
523 (rplacd (nthcdr early-retention sorted-v-list)
524 (nthcdr (- v-count late-retention)
525 sorted-v-list)))
526 (rplacd (car fval)
527 (cdr sorted-v-list)))
528 (setq fval (cdr fval))))
529 ;; Look at each file. If it is a numeric backup file,
530 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
531 (dired-map-dired-file-lines (function dired-trample-file-versions))
532 (message "Cleaning numerical backups...done")))
534 ;;; Subroutines of dired-clean-directory.
536 (defun dired-map-dired-file-lines (fun)
537 ;; Perform FUN with point at the end of each non-directory line.
538 ;; FUN takes one argument, the absolute filename.
539 (save-excursion
540 (let (file buffer-read-only)
541 (goto-char (point-min))
542 (while (not (eobp))
543 (save-excursion
544 (and (not (looking-at-p dired-re-dir))
545 (not (eolp))
546 (setq file (dired-get-filename nil t)) ; nil on non-file
547 (progn (end-of-line)
548 (funcall fun file))))
549 (forward-line 1)))))
551 (defvar backup-extract-version-start) ; used in backup-extract-version
553 (defun dired-collect-file-versions (fn)
554 (let ((fn (file-name-sans-versions fn)))
555 ;; Only do work if this file is not already in the alist.
556 (if (assoc fn dired-file-version-alist)
558 ;; If it looks like file FN has versions, return a list of the versions.
559 ;;That is a list of strings which are file names.
560 ;;The caller may want to flag some of these files for deletion.
561 (let* ((base-versions
562 (concat (file-name-nondirectory fn) ".~"))
563 (backup-extract-version-start (length base-versions))
564 (possibilities (file-name-all-completions
565 base-versions
566 (file-name-directory fn)))
567 (versions (mapcar 'backup-extract-version possibilities)))
568 (if versions
569 (setq dired-file-version-alist
570 (cons (cons fn versions)
571 dired-file-version-alist)))))))
573 (defun dired-trample-file-versions (fn)
574 (let* ((start-vn (string-match-p "\\.~[0-9]+~$" fn))
575 base-version-list)
576 (and start-vn
577 (setq base-version-list ; there was a base version to which
578 (assoc (substring fn 0 start-vn) ; this looks like a
579 dired-file-version-alist)) ; subversion
580 (not (memq (string-to-number (substring fn (+ 2 start-vn)))
581 base-version-list)) ; this one doesn't make the cut
582 (progn (beginning-of-line)
583 (delete-char 1)
584 (insert dired-del-marker)))))
586 ;;; Shell commands
588 (declare-function mailcap-file-default-commands "mailcap" (files))
590 (defun minibuffer-default-add-dired-shell-commands ()
591 "Return a list of all commands associated with current dired files.
592 This function is used to add all related commands retrieved by `mailcap'
593 to the end of the list of defaults just after the default value."
594 (interactive)
595 (let ((commands (and (boundp 'files) (require 'mailcap nil t)
596 (mailcap-file-default-commands files))))
597 (if (listp minibuffer-default)
598 (append minibuffer-default commands)
599 (cons minibuffer-default commands))))
601 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
602 (defun dired-read-shell-command (prompt arg files)
603 "Read a dired shell command.
604 PROMPT should be a format string with one \"%s\" format sequence,
605 which is replaced by the value returned by `dired-mark-prompt',
606 with ARG and FILES as its arguments. FILES should be a list of
607 file names. The result is used as the prompt.
609 This normally reads using `read-shell-command', but if the
610 `dired-x' package is loaded, use `dired-guess-shell-command' to
611 offer a smarter default choice of shell command."
612 (minibuffer-with-setup-hook
613 (lambda ()
614 (set (make-local-variable 'minibuffer-default-add-function)
615 'minibuffer-default-add-dired-shell-commands))
616 (setq prompt (format prompt (dired-mark-prompt arg files)))
617 (if (functionp 'dired-guess-shell-command)
618 (dired-mark-pop-up nil 'shell files
619 'dired-guess-shell-command prompt files)
620 (dired-mark-pop-up nil 'shell files
621 'read-shell-command prompt nil nil))))
623 ;;;###autoload
624 (defun dired-do-async-shell-command (command &optional arg file-list)
625 "Run a shell command COMMAND on the marked files asynchronously.
627 Like `dired-do-shell-command', but adds `&' at the end of COMMAND
628 to execute it asynchronously.
630 When operating on multiple files, asynchronous commands
631 are executed in the background on each file in parallel.
632 In shell syntax this means separating the individual commands
633 with `&'. However, when COMMAND ends in `;' or `;&' then commands
634 are executed in the background on each file sequentially waiting
635 for each command to terminate before running the next command.
636 In shell syntax this means separating the individual commands with `;'.
638 The output appears in the buffer `*Async Shell Command*'."
639 (interactive
640 (let ((files (dired-get-marked-files t current-prefix-arg)))
641 (list
642 ;; Want to give feedback whether this file or marked files are used:
643 (dired-read-shell-command "& on %s: " current-prefix-arg files)
644 current-prefix-arg
645 files)))
646 (unless (string-match-p "&[ \t]*\\'" command)
647 (setq command (concat command " &")))
648 (dired-do-shell-command command arg file-list))
650 ;;;###autoload
651 (defun dired-do-shell-command (command &optional arg file-list)
652 "Run a shell command COMMAND on the marked files.
653 If no files are marked or a numeric prefix arg is given,
654 the next ARG files are used. Just \\[universal-argument] means the current file.
655 The prompt mentions the file(s) or the marker, as appropriate.
657 If there is a `*' in COMMAND, surrounded by whitespace, this runs
658 COMMAND just once with the entire file list substituted there.
660 If there is no `*', but there is a `?' in COMMAND, surrounded by
661 whitespace, this runs COMMAND on each file individually with the
662 file name substituted for `?'.
664 Otherwise, this runs COMMAND on each file individually with the
665 file name added at the end of COMMAND (separated by a space).
667 `*' and `?' when not surrounded by whitespace have no special
668 significance for `dired-do-shell-command', and are passed through
669 normally to the shell, but you must confirm first.
671 If you want to use `*' as a shell wildcard with whitespace around
672 it, write `*\"\"' in place of just `*'. This is equivalent to just
673 `*' in the shell, but avoids Dired's special handling.
675 If COMMAND ends in `&', `;', or `;&', it is executed in the
676 background asynchronously, and the output appears in the buffer
677 `*Async Shell Command*'. When operating on multiple files and COMMAND
678 ends in `&', the shell command is executed on each file in parallel.
679 However, when COMMAND ends in `;' or `;&' then commands are executed
680 in the background on each file sequentially waiting for each command
681 to terminate before running the next command. You can also use
682 `dired-do-async-shell-command' that automatically adds `&'.
684 Otherwise, COMMAND is executed synchronously, and the output
685 appears in the buffer `*Shell Command Output*'.
687 This feature does not try to redisplay Dired buffers afterward, as
688 there's no telling what files COMMAND may have changed.
689 Type \\[dired-do-redisplay] to redisplay the marked files.
691 When COMMAND runs, its working directory is the top-level directory
692 of the Dired buffer, so output files usually are created there
693 instead of in a subdir.
695 In a noninteractive call (from Lisp code), you must specify
696 the list of file names explicitly with the FILE-LIST argument, which
697 can be produced by `dired-get-marked-files', for example."
698 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
699 ;;actual work and can be redefined for customization.
700 (interactive
701 (let ((files (dired-get-marked-files t current-prefix-arg)))
702 (list
703 ;; Want to give feedback whether this file or marked files are used:
704 (dired-read-shell-command "! on %s: " current-prefix-arg files)
705 current-prefix-arg
706 files)))
707 (let* ((on-each (not (string-match-p dired-star-subst-regexp command)))
708 (no-subst (not (string-match-p dired-quark-subst-regexp command)))
709 (star (string-match-p "\\*" command))
710 (qmark (string-match-p "\\?" command)))
711 ;; Get confirmation for wildcards that may have been meant
712 ;; to control substitution of a file name or the file name list.
713 (if (cond ((not (or on-each no-subst))
714 (error "You can not combine `*' and `?' substitution marks"))
715 ((and star on-each)
716 (y-or-n-p (format-message
717 "Confirm--do you mean to use `*' as a wildcard? ")))
718 ((and qmark no-subst)
719 (y-or-n-p (format-message
720 "Confirm--do you mean to use `?' as a wildcard? ")))
721 (t))
722 (if on-each
723 (dired-bunch-files
724 (- 10000 (length command))
725 (function (lambda (&rest files)
726 (dired-run-shell-command
727 (dired-shell-stuff-it command files t arg))))
729 file-list)
730 ;; execute the shell command
731 (dired-run-shell-command
732 (dired-shell-stuff-it command file-list nil arg))))))
734 ;; Might use {,} for bash or csh:
735 (defvar dired-mark-prefix ""
736 "Prepended to marked files in dired shell commands.")
737 (defvar dired-mark-postfix ""
738 "Appended to marked files in dired shell commands.")
739 (defvar dired-mark-separator " "
740 "Separates marked files in dired shell commands.")
742 (defun dired-shell-stuff-it (command file-list on-each &optional _raw-arg)
743 ;; "Make up a shell command line from COMMAND and FILE-LIST.
744 ;; If ON-EACH is t, COMMAND should be applied to each file, else
745 ;; simply concat all files and apply COMMAND to this.
746 ;; FILE-LIST's elements will be quoted for the shell."
747 ;; Might be redefined for smarter things and could then use RAW-ARG
748 ;; (coming from interactive P and currently ignored) to decide what to do.
749 ;; Smart would be a way to access basename or extension of file names.
750 (let* ((in-background (string-match "[ \t]*&[ \t]*\\'" command))
751 (command (if in-background
752 (substring command 0 (match-beginning 0))
753 command))
754 (sequentially (string-match "[ \t]*;[ \t]*\\'" command))
755 (command (if sequentially
756 (substring command 0 (match-beginning 0))
757 command))
758 (parallel-in-background
759 (and in-background (not sequentially) (not (eq system-type 'ms-dos))))
760 (w32-shell (and (fboundp 'w32-shell-dos-semantics)
761 (w32-shell-dos-semantics)))
762 ;; The way to run a command in background in Windows shells
763 ;; is to use the START command. The /B switch means not to
764 ;; create a new window for the command.
765 (cmd-prefix (if w32-shell "start /b " ""))
766 ;; Windows shells don't support chaining with ";", they use
767 ;; "&" instead.
768 (cmd-sep (if (and (not w32-shell) (not parallel-in-background))
770 "&"))
771 (stuff-it
772 (if (or (string-match-p dired-star-subst-regexp command)
773 (string-match-p dired-quark-subst-regexp command))
774 (lambda (x)
775 (let ((retval (concat cmd-prefix command)))
776 (while (string-match
777 "\\(^\\|[ \t]\\)\\([*?]\\)\\([ \t]\\|$\\)" retval)
778 (setq retval (replace-match x t t retval 2)))
779 retval))
780 (lambda (x) (concat cmd-prefix command dired-mark-separator x)))))
781 (concat
782 (cond (on-each
783 (format "%s%s"
784 (mapconcat stuff-it (mapcar 'shell-quote-argument file-list)
785 cmd-sep)
786 ;; POSIX shells running a list of commands in the background
787 ;; (LIST = cmd_1 & [cmd_2 & ... cmd_i & ... cmd_N &])
788 ;; return once cmd_N ends, i.e., the shell does not
789 ;; wait for cmd_i to finish before executing cmd_i+1.
790 ;; That means, running (shell-command LIST) may not show
791 ;; the output of all the commands (Bug#23206).
792 ;; Add 'wait' to force those POSIX shells to wait until
793 ;; all commands finish.
794 (or (and parallel-in-background (not w32-shell)
795 "&wait")
796 "")))
798 (let ((files (mapconcat 'shell-quote-argument
799 file-list dired-mark-separator)))
800 (when (cdr file-list)
801 (setq files (concat dired-mark-prefix files dired-mark-postfix)))
802 (funcall stuff-it files))))
803 (or (and in-background "&") ""))))
805 ;; This is an extra function so that it can be redefined by ange-ftp.
806 ;;;###autoload
807 (defun dired-run-shell-command (command)
808 (let ((handler
809 (find-file-name-handler (directory-file-name default-directory)
810 'shell-command)))
811 (if handler (apply handler 'shell-command (list command))
812 (shell-command command)))
813 ;; Return nil for sake of nconc in dired-bunch-files.
814 nil)
817 (defun dired-check-process (msg program &rest arguments)
818 "Display MSG while running PROGRAM, and check for output.
819 Remaining arguments are strings passed as command arguments to PROGRAM.
820 On error, insert output
821 in a log buffer and return the offending ARGUMENTS or PROGRAM.
822 Caller can cons up a list of failed args.
823 Else returns nil for success."
824 (let (err-buffer err (dir default-directory))
825 (message "%s..." msg)
826 (save-excursion
827 ;; Get a clean buffer for error output:
828 (setq err-buffer (get-buffer-create " *dired-check-process output*"))
829 (set-buffer err-buffer)
830 (erase-buffer)
831 (setq default-directory dir ; caller's default-directory
832 err (not (eq 0 (apply 'process-file program nil t nil arguments))))
833 (if err
834 (progn
835 (dired-log (concat program " " (prin1-to-string arguments) "\n"))
836 (dired-log err-buffer)
837 (or arguments program t))
838 (kill-buffer err-buffer)
839 (message "%s...done" msg)
840 nil))))
842 (defun dired-shell-command (cmd)
843 "Run CMD, and check for output.
844 On error, pop up the log buffer.
845 Return the result of `process-file' - zero for success."
846 (let ((out-buffer " *dired-check-process output*")
847 (dir default-directory))
848 (with-current-buffer (get-buffer-create out-buffer)
849 (erase-buffer)
850 (let* ((default-directory dir)
851 (res (process-file
852 shell-file-name
856 shell-command-switch
857 cmd)))
858 (unless (zerop res)
859 (pop-to-buffer out-buffer))
860 res))))
862 ;; Commands that delete or redisplay part of the dired buffer.
864 (defun dired-kill-line (&optional arg)
865 "Kill the current line (not the files).
866 With a prefix argument, kill that many lines starting with the current line.
867 \(A negative argument kills backward.)"
868 (interactive "P")
869 (setq arg (prefix-numeric-value arg))
870 (let (buffer-read-only file)
871 (while (/= 0 arg)
872 (setq file (dired-get-filename nil t))
873 (if (not file)
874 (error "Can only kill file lines")
875 (save-excursion (and file
876 (dired-goto-subdir file)
877 (dired-kill-subdir)))
878 (delete-region (line-beginning-position)
879 (progn (forward-line 1) (point)))
880 (if (> arg 0)
881 (setq arg (1- arg))
882 (setq arg (1+ arg))
883 (forward-line -1))))
884 (dired-move-to-filename)))
886 ;;;###autoload
887 (defun dired-do-kill-lines (&optional arg fmt)
888 "Kill all marked lines (not the files).
889 With a prefix argument, kill that many lines starting with the current line.
890 \(A negative argument kills backward.)
891 If you use this command with a prefix argument to kill the line
892 for a file that is a directory, which you have inserted in the
893 Dired buffer as a subdirectory, then it deletes that subdirectory
894 from the buffer as well.
895 To kill an entire subdirectory \(without killing its line in the
896 parent directory), go to its directory header line and use this
897 command with a prefix argument (the value does not matter)."
898 ;; Returns count of killed lines. FMT="" suppresses message.
899 (interactive "P")
900 (if arg
901 (if (dired-get-subdir)
902 (dired-kill-subdir)
903 (dired-kill-line arg))
904 (save-excursion
905 (goto-char (point-min))
906 (let (buffer-read-only
907 (count 0)
908 (regexp (dired-marker-regexp)))
909 (while (and (not (eobp))
910 (re-search-forward regexp nil t))
911 (setq count (1+ count))
912 (delete-region (line-beginning-position)
913 (progn (forward-line 1) (point))))
914 (or (equal "" fmt)
915 (message (or fmt "Killed %d line%s.") count (dired-plural-s count)))
916 count))))
918 ;;;###end dired-cmd.el
920 ;;; 30K
921 ;;;###begin dired-cp.el
923 (defun dired-compress ()
924 ;; Compress or uncompress the current file.
925 ;; Return nil for success, offending filename else.
926 (let* (buffer-read-only
927 (from-file (dired-get-filename))
928 (new-file (dired-compress-file from-file)))
929 (if new-file
930 (let ((start (point)))
931 ;; Remove any preexisting entry for the name NEW-FILE.
932 (ignore-errors (dired-remove-entry new-file))
933 (goto-char start)
934 ;; Now replace the current line with an entry for NEW-FILE.
935 (dired-update-file-line new-file) nil)
936 (dired-log (concat "Failed to compress" from-file))
937 from-file)))
939 (defvar dired-compress-file-suffixes
941 ;; "tar -zxf" isn't used because it's not available on the
942 ;; Solaris10 version of tar. Solaris10 becomes obsolete in 2021.
943 ;; Same thing on AIX 7.1.
944 ("\\.tar\\.gz\\'" "" "gzip -dc %i | tar -xv")
945 ("\\.tgz\\'" "" "gzip -dc %i | tar -xv")
946 ("\\.gz\\'" "" "gunzip")
947 ("\\.Z\\'" "" "uncompress")
948 ;; For .z, try gunzip. It might be an old gzip file,
949 ;; or it might be from compact? pack? (which?) but gunzip handles both.
950 ("\\.z\\'" "" "gunzip")
951 ("\\.dz\\'" "" "dictunzip")
952 ("\\.tbz\\'" ".tar" "bunzip2")
953 ("\\.bz2\\'" "" "bunzip2")
954 ("\\.xz\\'" "" "unxz")
955 ("\\.zip\\'" "" "unzip -o -d %o %i")
956 ("\\.7z\\'" "" "7z x -aoa -o%o %i")
957 ;; This item controls naming for compression.
958 ("\\.tar\\'" ".tgz" nil)
959 ;; This item controls the compression of directories
960 (":" ".tar.gz" "tar -c %i | gzip -c9 > %o"))
961 "Control changes in file name suffixes for compression and uncompression.
962 Each element specifies one transformation rule, and has the form:
963 (REGEXP NEW-SUFFIX PROGRAM)
964 The rule applies when the old file name matches REGEXP.
965 The new file name is computed by deleting the part that matches REGEXP
966 (as well as anything after that), then adding NEW-SUFFIX in its place.
967 If PROGRAM is non-nil, the rule is an uncompression rule,
968 and uncompression is done by running PROGRAM.
970 Within PROGRAM, %i denotes the input file, and %o denotes the
971 output file.
973 Otherwise, the rule is a compression rule, and compression is done with gzip.
974 ARGS are command switches passed to PROGRAM.")
976 (defvar dired-compress-files-alist
977 '(("\\.tar\\.gz\\'" . "tar -c %i | gzip -c9 > %o")
978 ("\\.tar\\.bz2\\'" . "tar -c %i | bzip2 -c9 > %o")
979 ("\\.tar\\.xz\\'" . "tar -c %i | xz -c9 > %o")
980 ("\\.zip\\'" . "zip %o -r --filesync %i"))
981 "Control the compression shell command for `dired-do-compress-to'.
983 Each element is (REGEXP . CMD), where REGEXP is the name of the
984 archive to which you want to compress, and CMD the the
985 corresponding command.
987 Within CMD, %i denotes the input file(s), and %o denotes the
988 output file. %i path(s) are relative, while %o is absolute.")
990 (declare-function format-spec "format-spec.el" (format specification))
992 ;;;###autoload
993 (defun dired-do-compress-to ()
994 "Compress selected files and directories to an archive.
995 Prompt for the archive file name.
996 Choose the archiving command based on the archive file-name extension
997 and `dired-compress-files-alist'."
998 (interactive)
999 (let* ((in-files (dired-get-marked-files))
1000 (out-file (expand-file-name (read-file-name "Compress to: ")))
1001 (rule (cl-find-if
1002 (lambda (x)
1003 (string-match (car x) out-file))
1004 dired-compress-files-alist)))
1005 (cond ((not rule)
1006 (error
1007 "No compression rule found for %s, see `dired-compress-files-alist'"
1008 out-file))
1009 ((and (file-exists-p out-file)
1010 (not (y-or-n-p
1011 (format "%s exists, overwrite?"
1012 (abbreviate-file-name out-file)))))
1013 (message "Compression aborted"))
1015 (when (zerop
1016 (dired-shell-command
1017 (format-spec (cdr rule)
1018 `((?\o . ,(shell-quote-argument out-file))
1019 (?\i . ,(mapconcat
1020 (lambda (file-desc)
1021 (shell-quote-argument (file-name-nondirectory
1022 file-desc)))
1023 in-files " "))))))
1024 (message "Compressed %d file(s) to %s"
1025 (length in-files)
1026 (file-name-nondirectory out-file)))))))
1028 ;;;###autoload
1029 (defun dired-compress-file (file)
1030 "Compress or uncompress FILE.
1031 Return the name of the compressed or uncompressed file.
1032 Return nil if no change in files."
1033 (let ((handler (find-file-name-handler file 'dired-compress-file))
1034 suffix newname
1035 (suffixes dired-compress-file-suffixes)
1036 command)
1037 ;; See if any suffix rule matches this file name.
1038 (while suffixes
1039 (let (case-fold-search)
1040 (if (string-match (car (car suffixes)) file)
1041 (setq suffix (car suffixes) suffixes nil))
1042 (setq suffixes (cdr suffixes))))
1043 ;; If so, compute desired new name.
1044 (if suffix
1045 (setq newname (concat (substring file 0 (match-beginning 0))
1046 (nth 1 suffix))))
1047 (cond (handler
1048 (funcall handler 'dired-compress-file file))
1049 ((file-symlink-p file)
1050 nil)
1051 ((and suffix (setq command (nth 2 suffix)))
1052 (if (string-match "%[io]" command)
1053 (prog1 (setq newname (file-name-as-directory newname))
1054 (dired-shell-command
1055 (replace-regexp-in-string
1056 "%o" (shell-quote-argument newname)
1057 (replace-regexp-in-string
1058 "%i" (shell-quote-argument file)
1059 command
1060 nil t)
1061 nil t)))
1062 ;; We found an uncompression rule.
1063 (when (not
1064 (dired-check-process
1065 (concat "Uncompressing " file)
1066 command
1067 file))
1068 newname)))
1070 ;; We don't recognize the file as compressed, so compress it.
1071 ;; Try gzip; if we don't have that, use compress.
1072 (condition-case nil
1073 (if (file-directory-p file)
1074 (progn
1075 (setq suffix (cdr (assoc ":" dired-compress-file-suffixes)))
1076 (when suffix
1077 (let ((out-name (concat file (car suffix)))
1078 (default-directory (file-name-directory file)))
1079 (dired-shell-command
1080 (replace-regexp-in-string
1081 "%o" (shell-quote-argument out-name)
1082 (replace-regexp-in-string
1083 "%i" (shell-quote-argument (file-name-nondirectory file))
1084 (cadr suffix)
1085 nil t)
1086 nil t))
1087 out-name)))
1088 (let ((out-name (concat file ".gz")))
1089 (and (or (not (file-exists-p out-name))
1090 (y-or-n-p
1091 (format "File %s already exists. Really compress? "
1092 out-name)))
1093 (not
1094 (dired-check-process (concat "Compressing " file)
1095 "gzip" "-f" file))
1096 (or (file-exists-p out-name)
1097 (setq out-name (concat file ".z")))
1098 ;; Rename the compressed file to NEWNAME
1099 ;; if it hasn't got that name already.
1100 (if (and newname (not (equal newname out-name)))
1101 (progn
1102 (rename-file out-name newname t)
1103 newname)
1104 out-name))))
1105 (file-error
1106 (if (not (dired-check-process (concat "Compressing " file)
1107 "compress" "-f" file))
1108 ;; Don't use NEWNAME with `compress'.
1109 (concat file ".Z"))))))))
1111 (defun dired-mark-confirm (op-symbol arg)
1112 ;; Request confirmation from the user that the operation described
1113 ;; by OP-SYMBOL is to be performed on the marked files.
1114 ;; Confirmation consists in a y-or-n question with a file list
1115 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
1116 ;; The files used are determined by ARG (as in dired-get-marked-files).
1117 (or (eq dired-no-confirm t)
1118 (memq op-symbol dired-no-confirm)
1119 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
1120 ;; is marked pops up a window. That will help the user see
1121 ;; it isn't the current line file.
1122 (let ((files (dired-get-marked-files t arg nil t))
1123 (string (if (eq op-symbol 'compress) "Compress or uncompress"
1124 (capitalize (symbol-name op-symbol)))))
1125 (dired-mark-pop-up nil op-symbol files (function y-or-n-p)
1126 (concat string " "
1127 (dired-mark-prompt arg files) "? ")))))
1129 (defun dired-map-over-marks-check (fun arg op-symbol &optional show-progress)
1130 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
1131 ; and display failures.
1133 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
1134 ; the short form of the filename) for a failure and probably logs a
1135 ; detailed error explanation using function `dired-log'.
1137 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
1138 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
1139 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
1140 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
1142 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
1143 (if (dired-mark-confirm op-symbol arg)
1144 (let* ((total-list;; all of FUN's return values
1145 (dired-map-over-marks (funcall fun) arg show-progress))
1146 (total (length total-list))
1147 (failures (delq nil total-list))
1148 (count (length failures))
1149 (string (if (eq op-symbol 'compress) "Compress or uncompress"
1150 (capitalize (symbol-name op-symbol)))))
1151 (if (not failures)
1152 (message "%s: %d file%s."
1153 string total (dired-plural-s total))
1154 ;; end this bunch of errors:
1155 (dired-log-summary
1156 (format "Failed to %s %d of %d file%s"
1157 (downcase string) count total (dired-plural-s total))
1158 failures)))))
1160 ;;;###autoload
1161 (defun dired-query (sym prompt &rest args)
1162 "Format PROMPT with ARGS, query user, and store the result in SYM.
1163 The return value is either nil or t.
1165 The user may type y or SPC to accept once; n or DEL to skip once;
1166 ! to accept this and subsequent queries; or q or ESC to decline
1167 this and subsequent queries.
1169 If SYM is already bound to a non-nil value, this function may
1170 return automatically without querying the user. If SYM is !,
1171 return t; if SYM is q or ESC, return nil."
1172 (let* ((char (symbol-value sym))
1173 (char-choices '(?y ?\s ?n ?\177 ?! ?q ?\e)))
1174 (cond ((eq char ?!)
1175 t) ; accept, and don't ask again
1176 ((memq char '(?q ?\e))
1177 nil) ; skip, and don't ask again
1178 (t ; no previous answer - ask now
1179 (setq prompt
1180 (concat (apply #'format-message prompt args)
1181 (if help-form
1182 (format " [Type yn!q or %s] "
1183 (key-description (vector help-char)))
1184 " [Type y, n, q or !] ")))
1185 (set sym (setq char (read-char-choice prompt char-choices)))
1186 (if (memq char '(?y ?\s ?!)) t)))))
1189 ;;;###autoload
1190 (defun dired-do-compress (&optional arg)
1191 "Compress or uncompress marked (or next ARG) files."
1192 (interactive "P")
1193 (dired-map-over-marks-check (function dired-compress) arg 'compress t))
1195 ;; Commands for Emacs Lisp files - load and byte compile
1197 (defun dired-byte-compile ()
1198 ;; Return nil for success, offending file name else.
1199 (let* ((filename (dired-get-filename))
1200 elc-file buffer-read-only failure)
1201 (condition-case err
1202 (save-excursion (byte-compile-file filename))
1203 (error
1204 (setq failure err)))
1205 (setq elc-file (byte-compile-dest-file filename))
1206 (or (file-exists-p elc-file)
1207 (setq failure t))
1208 (if failure
1209 (progn
1210 (dired-log "Byte compile error for %s:\n%s\n" filename failure)
1211 (dired-make-relative filename))
1212 (dired-remove-file elc-file)
1213 (forward-line) ; insert .elc after its .el file
1214 (dired-add-file elc-file)
1215 nil)))
1217 ;;;###autoload
1218 (defun dired-do-byte-compile (&optional arg)
1219 "Byte compile marked (or next ARG) Emacs Lisp files."
1220 (interactive "P")
1221 (dired-map-over-marks-check (function dired-byte-compile) arg 'byte-compile t))
1223 (defun dired-load ()
1224 ;; Return nil for success, offending file name else.
1225 (let ((file (dired-get-filename)) failure)
1226 (condition-case err
1227 (load file nil nil t)
1228 (error (setq failure err)))
1229 (if (not failure)
1231 (dired-log "Load error for %s:\n%s\n" file failure)
1232 (dired-make-relative file))))
1234 ;;;###autoload
1235 (defun dired-do-load (&optional arg)
1236 "Load the marked (or next ARG) Emacs Lisp files."
1237 (interactive "P")
1238 (dired-map-over-marks-check (function dired-load) arg 'load t))
1240 ;;;###autoload
1241 (defun dired-do-redisplay (&optional arg test-for-subdir)
1242 "Redisplay all marked (or next ARG) files.
1243 If on a subdir line, redisplay that subdirectory. In that case,
1244 a prefix arg lets you edit the `ls' switches used for the new listing.
1246 Dired remembers switches specified with a prefix arg, so that reverting
1247 the buffer will not reset them. However, using `dired-undo' to re-insert
1248 or delete subdirectories can bypass this machinery. Hence, you sometimes
1249 may have to reset some subdirectory switches after a `dired-undo'.
1250 You can reset all subdirectory switches to the default using
1251 \\<dired-mode-map>\\[dired-reset-subdir-switches].
1252 See Info node `(emacs)Subdir switches' for more details."
1253 ;; Moves point if the next ARG files are redisplayed.
1254 (interactive "P\np")
1255 (if (and test-for-subdir (dired-get-subdir))
1256 (let* ((dir (dired-get-subdir))
1257 (switches (cdr (assoc-string dir dired-switches-alist))))
1258 (dired-insert-subdir
1260 (when arg
1261 (read-string "Switches for listing: "
1262 (or switches
1263 dired-subdir-switches
1264 dired-actual-switches)))))
1265 (message "Redisplaying...")
1266 ;; message much faster than making dired-map-over-marks show progress
1267 (dired-uncache
1268 (if (consp dired-directory) (car dired-directory) dired-directory))
1269 (dired-map-over-marks (let ((fname (dired-get-filename))
1270 ;; Postpone readin hook till we map
1271 ;; over all marked files (Bug#6810).
1272 (dired-after-readin-hook nil))
1273 (message "Redisplaying... %s" fname)
1274 (dired-update-file-line fname))
1275 arg)
1276 (run-hooks 'dired-after-readin-hook)
1277 (dired-move-to-filename)
1278 (message "Redisplaying...done")))
1280 (defun dired-reset-subdir-switches ()
1281 "Set `dired-switches-alist' to nil and revert dired buffer."
1282 (interactive)
1283 (setq dired-switches-alist nil)
1284 (revert-buffer))
1286 (defun dired-update-file-line (file)
1287 ;; Delete the current line, and insert an entry for FILE.
1288 ;; If FILE is nil, then just delete the current line.
1289 ;; Keeps any marks that may be present in column one (doing this
1290 ;; here is faster than with dired-add-entry's optional arg).
1291 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1292 (let* ((opoint (line-beginning-position))
1293 (char (char-after opoint))
1294 (buffer-read-only))
1295 (delete-region opoint (progn (forward-line 1) (point)))
1296 (if file
1297 (progn
1298 (dired-add-entry file nil t)
1299 ;; Replace space by old marker without moving point.
1300 ;; Faster than goto+insdel inside a save-excursion?
1301 (when char
1302 (subst-char-in-region opoint (1+ opoint) ?\040 char)))))
1303 (dired-move-to-filename))
1305 ;;;###autoload
1306 (defun dired-add-file (filename &optional marker-char)
1307 (dired-fun-in-all-buffers
1308 (file-name-directory filename) (file-name-nondirectory filename)
1309 (function dired-add-entry) filename marker-char))
1311 (defvar dired-omit-mode)
1312 (declare-function dired-omit-regexp "dired-x" ())
1313 (defvar dired-omit-localp)
1315 (defun dired-add-entry (filename &optional marker-char relative)
1316 "Add a new dired entry for FILENAME.
1317 Optionally mark it with MARKER-CHAR (a character, else uses
1318 `dired-marker-char'). Note that this adds the entry `out of order'
1319 if files are sorted by time, etc.
1320 Skips files that match `dired-trivial-filenames'.
1321 Exposes hidden subdirectories if a file is added there.
1323 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1324 files matching `dired-omit-regexp'."
1325 (if (or (not (featurep 'dired-x))
1326 (not dired-omit-mode)
1327 ;; Avoid calling ls for files that are going to be omitted anyway.
1328 (let ((omit-re (dired-omit-regexp)))
1329 (or (string= omit-re "")
1330 (not (string-match-p omit-re
1331 (cond
1332 ((eq 'no-dir dired-omit-localp)
1333 filename)
1334 ((eq t dired-omit-localp)
1335 (dired-make-relative filename))
1337 (dired-make-absolute
1338 filename
1339 (file-name-directory filename)))))))))
1340 ;; Do it!
1341 (progn
1342 (setq filename (directory-file-name filename))
1343 ;; Entry is always for files, even if they happen to also be directories
1344 (let* ((opoint (point))
1345 (cur-dir (dired-current-directory))
1346 (directory (if relative cur-dir (file-name-directory filename)))
1347 reason)
1348 (setq filename
1349 (if relative
1350 (file-relative-name filename directory)
1351 (file-name-nondirectory filename))
1352 reason
1353 (catch 'not-found
1354 (if (string= directory cur-dir)
1355 (progn
1356 (skip-chars-forward "^\r\n")
1357 (if (eq (following-char) ?\r)
1358 (dired-unhide-subdir))
1359 ;; We are already where we should be, except when
1360 ;; point is before the subdir line or its total line.
1361 (let ((p (dired-after-subdir-garbage cur-dir)))
1362 (if (< (point) p)
1363 (goto-char p))))
1364 ;; else try to find correct place to insert
1365 (if (dired-goto-subdir directory)
1366 (progn ;; unhide if necessary
1367 (if (looking-at-p "\r")
1368 ;; Point is at end of subdir line.
1369 (dired-unhide-subdir))
1370 ;; found - skip subdir and `total' line
1371 ;; and uninteresting files like . and ..
1372 ;; This better not move into the next subdir!
1373 (dired-goto-next-nontrivial-file))
1374 ;; not found
1375 (throw 'not-found "Subdir not found")))
1376 (let (buffer-read-only opoint)
1377 (beginning-of-line)
1378 (setq opoint (point))
1379 ;; Don't expand `.'.
1380 ;; Show just the file name within directory.
1381 (let ((default-directory directory))
1382 (dired-insert-directory
1383 directory
1384 (concat dired-actual-switches " -d")
1385 (list filename)))
1386 (goto-char opoint)
1387 ;; Put in desired marker char.
1388 (when marker-char
1389 (let ((dired-marker-char
1390 (if (integerp marker-char) marker-char
1391 dired-marker-char)))
1392 (dired-mark nil)))
1393 ;; Compensate for a bug in ange-ftp.
1394 ;; It inserts the file's absolute name, rather than
1395 ;; the relative one. That may be hard to fix since it
1396 ;; is probably controlled by something in ftp.
1397 (goto-char opoint)
1398 (let ((inserted-name (dired-get-filename 'verbatim)))
1399 (if (file-name-directory inserted-name)
1400 (let (props)
1401 (end-of-line)
1402 (forward-char (- (length inserted-name)))
1403 (setq props (text-properties-at (point)))
1404 (delete-char (length inserted-name))
1405 (let ((pt (point)))
1406 (insert filename)
1407 (set-text-properties pt (point) props))
1408 (forward-char 1))
1409 (forward-line 1)))
1410 (forward-line -1)
1411 (if dired-after-readin-hook
1412 ;; The subdir-alist is not affected...
1413 (save-excursion ; ...so we can run it right now:
1414 (save-restriction
1415 (beginning-of-line)
1416 (narrow-to-region (point)
1417 (line-beginning-position 2))
1418 (run-hooks 'dired-after-readin-hook))))
1419 (dired-move-to-filename))
1420 ;; return nil if all went well
1421 nil))
1422 (if reason ; don't move away on failure
1423 (goto-char opoint))
1424 (not reason))) ; return t on success, nil else
1425 ;; Don't do it (dired-omit-mode).
1426 ;; Return t for success (perhaps we should return file-exists-p).
1429 (defun dired-after-subdir-garbage (dir)
1430 ;; Return pos of first file line of DIR, skipping header and total
1431 ;; or wildcard lines.
1432 ;; Important: never moves into the next subdir.
1433 ;; DIR is assumed to be unhidden.
1434 (save-excursion
1435 (or (dired-goto-subdir dir) (error "This cannot happen"))
1436 (forward-line 1)
1437 (while (and (not (eolp)) ; don't cross subdir boundary
1438 (not (dired-move-to-filename)))
1439 (forward-line 1))
1440 (point)))
1442 ;;;###autoload
1443 (defun dired-remove-file (file)
1444 (dired-fun-in-all-buffers
1445 (file-name-directory file) (file-name-nondirectory file)
1446 (function dired-remove-entry) file))
1448 (defun dired-remove-entry (file)
1449 (save-excursion
1450 (and (dired-goto-file file)
1451 (let (buffer-read-only)
1452 (delete-region (progn (beginning-of-line) (point))
1453 (line-beginning-position 2))))))
1455 ;;;###autoload
1456 (defun dired-relist-file (file)
1457 "Create or update the line for FILE in all Dired buffers it would belong in."
1458 (dired-fun-in-all-buffers (file-name-directory file)
1459 (file-name-nondirectory file)
1460 (function dired-relist-entry) file))
1462 (defun dired-relist-entry (file)
1463 ;; Relist the line for FILE, or just add it if it did not exist.
1464 ;; FILE must be an absolute file name.
1465 (let (buffer-read-only marker)
1466 ;; If cursor is already on FILE's line delete-region will cause
1467 ;; save-excursion to fail because of floating makers,
1468 ;; moving point to beginning of line. Sigh.
1469 (save-excursion
1470 (and (dired-goto-file file)
1471 (delete-region (progn (beginning-of-line)
1472 (setq marker (following-char))
1473 (point))
1474 (line-beginning-position 2)))
1475 (setq file (directory-file-name file))
1476 (dired-add-entry file (if (eq ?\040 marker) nil marker)))))
1478 ;;; Copy, move/rename, making hard and symbolic links
1480 (defcustom dired-backup-overwrite nil
1481 "Non-nil if Dired should ask about making backups before overwriting files.
1482 Special value `always' suppresses confirmation."
1483 :type '(choice (const :tag "off" nil)
1484 (const :tag "suppress" always)
1485 (other :tag "ask" t))
1486 :group 'dired)
1488 ;; This is a fluid var used in dired-handle-overwrite. It should be
1489 ;; let-bound whenever dired-copy-file etc are called. See
1490 ;; dired-create-files for an example.
1491 (defvar dired-overwrite-confirmed)
1493 (defun dired-handle-overwrite (to)
1494 ;; Save old version of file TO that is to be overwritten.
1495 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1496 ;; from dired-create-files.
1497 (let (backup)
1498 (when (and dired-backup-overwrite
1499 dired-overwrite-confirmed
1500 (setq backup (car (find-backup-file-name to)))
1501 (or (eq 'always dired-backup-overwrite)
1502 (dired-query 'overwrite-backup-query
1503 "Make backup for existing file `%s'? "
1504 to)))
1505 (rename-file to backup 0) ; confirm overwrite of old backup
1506 (dired-relist-entry backup))))
1508 ;;;###autoload
1509 (defun dired-copy-file (from to ok-flag)
1510 (dired-handle-overwrite to)
1511 (dired-copy-file-recursive from to ok-flag dired-copy-preserve-time t
1512 dired-recursive-copies))
1514 (declare-function make-symbolic-link "fileio.c")
1516 (defun dired-copy-file-recursive (from to ok-flag &optional
1517 preserve-time top recursive)
1518 (when (and (eq t (car (file-attributes from)))
1519 (file-in-directory-p to from))
1520 (error "Cannot copy `%s' into its subdirectory `%s'" from to))
1521 (let ((attrs (file-attributes from)))
1522 (if (and recursive
1523 (eq t (car attrs))
1524 (or (eq recursive 'always)
1525 (yes-or-no-p (format "Recursive copies of %s? " from))))
1526 (copy-directory from to preserve-time)
1527 (or top (dired-handle-overwrite to))
1528 (condition-case err
1529 (if (stringp (car attrs))
1530 ;; It is a symlink
1531 (make-symbolic-link (car attrs) to ok-flag)
1532 (copy-file from to ok-flag preserve-time))
1533 (file-date-error
1534 (push (dired-make-relative from)
1535 dired-create-files-failures)
1536 (dired-log "Can't set date on %s:\n%s\n" from err))))))
1538 ;;;###autoload
1539 (defun dired-rename-file (file newname ok-if-already-exists)
1540 (dired-handle-overwrite newname)
1541 (rename-file file newname ok-if-already-exists) ; error is caught in -create-files
1542 ;; Silently rename the visited file of any buffer visiting this file.
1543 (and (get-file-buffer file)
1544 (with-current-buffer (get-file-buffer file)
1545 (set-visited-file-name newname nil t)))
1546 (dired-remove-file file)
1547 ;; See if it's an inserted subdir, and rename that, too.
1548 (dired-rename-subdir file newname))
1550 (defun dired-rename-subdir (from-dir to-dir)
1551 (setq from-dir (file-name-as-directory from-dir)
1552 to-dir (file-name-as-directory to-dir))
1553 (dired-fun-in-all-buffers from-dir nil
1554 (function dired-rename-subdir-1) from-dir to-dir)
1555 ;; Update visited file name of all affected buffers
1556 (let ((expanded-from-dir (expand-file-name from-dir))
1557 (blist (buffer-list)))
1558 (while blist
1559 (with-current-buffer (car blist)
1560 (if (and buffer-file-name
1561 (dired-in-this-tree buffer-file-name expanded-from-dir))
1562 (let ((modflag (buffer-modified-p))
1563 (to-file (dired-replace-in-string
1564 (concat "^" (regexp-quote from-dir))
1565 to-dir
1566 buffer-file-name)))
1567 (set-visited-file-name to-file)
1568 (set-buffer-modified-p modflag))))
1569 (setq blist (cdr blist)))))
1571 (defun dired-rename-subdir-1 (dir to)
1572 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1573 ;; one of its subdirectories is expanded in this buffer.
1574 (let ((expanded-dir (expand-file-name dir))
1575 (alist dired-subdir-alist)
1576 (elt nil))
1577 (while alist
1578 (setq elt (car alist)
1579 alist (cdr alist))
1580 (if (dired-in-this-tree (car elt) expanded-dir)
1581 ;; ELT's subdir is affected by the rename
1582 (dired-rename-subdir-2 elt dir to)))
1583 (if (equal dir default-directory)
1584 ;; if top level directory was renamed, lots of things have to be
1585 ;; updated:
1586 (progn
1587 (dired-unadvertise dir) ; we no longer dired DIR...
1588 (setq default-directory to
1589 dired-directory (expand-file-name;; this is correct
1590 ;; with and without wildcards
1591 (file-name-nondirectory dired-directory)
1592 to))
1593 (let ((new-name (file-name-nondirectory
1594 (directory-file-name dired-directory))))
1595 ;; try to rename buffer, but just leave old name if new
1596 ;; name would already exist (don't try appending "<%d>")
1597 (or (get-buffer new-name)
1598 (rename-buffer new-name)))
1599 ;; ... we dired TO now:
1600 (dired-advertise)))))
1602 (defun dired-rename-subdir-2 (elt dir to)
1603 ;; Update the headerline and dired-subdir-alist element, as well as
1604 ;; dired-switches-alist element, of directory described by
1605 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1606 ;; describes either DIR itself or a subdir of DIR.
1607 (save-excursion
1608 (let ((regexp (regexp-quote (directory-file-name dir)))
1609 (newtext (directory-file-name to))
1610 buffer-read-only)
1611 (goto-char (dired-get-subdir-min elt))
1612 ;; Update subdir headerline in buffer
1613 (if (not (looking-at dired-subdir-regexp))
1614 (error "%s not found where expected - dired-subdir-alist broken?"
1615 dir)
1616 (goto-char (match-beginning 1))
1617 (if (re-search-forward regexp (match-end 1) t)
1618 (replace-match newtext t t)
1619 (error "Expected to find `%s' in headerline of %s" dir (car elt))))
1620 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1621 (let ((cons (assoc-string (car elt) dired-switches-alist))
1622 (cur-dir (dired-normalize-subdir
1623 (dired-replace-in-string regexp newtext (car elt)))))
1624 (setcar elt cur-dir)
1625 (when cons (setcar cons cur-dir))))))
1627 ;; Bound in dired-create-files
1628 (defvar overwrite-query)
1629 (defvar overwrite-backup-query)
1631 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1632 (defun dired-create-files (file-creator operation fn-list name-constructor
1633 &optional marker-char)
1634 "Create one or more new files from a list of existing files FN-LIST.
1635 This function also handles querying the user, updating Dired
1636 buffers, and displaying a success or failure message.
1638 FILE-CREATOR should be a function. It is called once for each
1639 file in FN-LIST, and must create a new file, querying the user
1640 and updating Dired buffers as necessary. It should accept three
1641 arguments: the old file name, the new name, and an argument
1642 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1644 OPERATION should be a capitalized string describing the operation
1645 performed (e.g. `Copy'). It is used for error logging.
1647 FN-LIST is the list of files to copy (full absolute file names).
1649 NAME-CONSTRUCTOR should be a function accepting a single
1650 argument, the name of an old file, and returning either the
1651 corresponding new file name or nil to skip.
1653 If optional argument MARKER-CHAR is non-nil, mark each
1654 newly-created file's Dired entry with the character MARKER-CHAR,
1655 or with the current marker character if MARKER-CHAR is t."
1656 (let (dired-create-files-failures failures
1657 skipped (success-count 0) (total (length fn-list)))
1658 (let (to overwrite-query
1659 overwrite-backup-query) ; for dired-handle-overwrite
1660 (dolist (from fn-list)
1661 (setq to (funcall name-constructor from))
1662 (if (equal to from)
1663 (progn
1664 (setq to nil)
1665 (dired-log "Cannot %s to same file: %s\n"
1666 (downcase operation) from)))
1667 (if (not to)
1668 (setq skipped (cons (dired-make-relative from) skipped))
1669 (let* ((overwrite (file-exists-p to))
1670 (dired-overwrite-confirmed ; for dired-handle-overwrite
1671 (and overwrite
1672 (let ((help-form '(format-message "\
1673 Type SPC or `y' to overwrite file `%s',
1674 DEL or `n' to skip to next,
1675 ESC or `q' to not overwrite any of the remaining files,
1676 `!' to overwrite all remaining files with no more questions." to)))
1677 (dired-query 'overwrite-query
1678 "Overwrite `%s'?" to))))
1679 ;; must determine if FROM is marked before file-creator
1680 ;; gets a chance to delete it (in case of a move).
1681 (actual-marker-char
1682 (cond ((integerp marker-char) marker-char)
1683 (marker-char (dired-file-marker from)) ; slow
1684 (t nil))))
1685 ;; Handle the `dired-copy-file' file-creator specially
1686 ;; When copying a directory to another directory or
1687 ;; possibly to itself or one of its subdirectories.
1688 ;; e.g "~/foo/" => "~/test/"
1689 ;; or "~/foo/" =>"~/foo/"
1690 ;; or "~/foo/ => ~/foo/bar/")
1691 ;; In this case the 'name-constructor' have set the destination
1692 ;; TO to "~/test/foo" because the old emacs23 behavior
1693 ;; of `copy-directory' was to not create the subdirectory
1694 ;; and instead copy the contents.
1695 ;; With the new behavior of `copy-directory'
1696 ;; (similar to the `cp' shell command) we don't
1697 ;; need such a construction of the target directory,
1698 ;; so modify the destination TO to "~/test/" instead of "~/test/foo/".
1699 (let ((destname (file-name-directory to)))
1700 (when (and (file-directory-p from)
1701 (file-directory-p to)
1702 (eq file-creator 'dired-copy-file))
1703 (setq to destname))
1704 ;; If DESTNAME is a subdirectory of FROM, not a symlink,
1705 ;; and the method in use is copying, signal an error.
1706 (and (eq t (car (file-attributes destname)))
1707 (eq file-creator 'dired-copy-file)
1708 (file-in-directory-p destname from)
1709 (error "Cannot copy `%s' into its subdirectory `%s'"
1710 from to)))
1711 (condition-case err
1712 (progn
1713 (funcall file-creator from to dired-overwrite-confirmed)
1714 (if overwrite
1715 ;; If we get here, file-creator hasn't been aborted
1716 ;; and the old entry (if any) has to be deleted
1717 ;; before adding the new entry.
1718 (dired-remove-file to))
1719 (setq success-count (1+ success-count))
1720 (message "%s: %d of %d" operation success-count total)
1721 (dired-add-file to actual-marker-char))
1722 (file-error ; FILE-CREATOR aborted
1723 (progn
1724 (push (dired-make-relative from)
1725 failures)
1726 (dired-log "%s `%s' to `%s' failed:\n%s\n"
1727 operation from to err))))))))
1728 (cond
1729 (dired-create-files-failures
1730 (setq failures (nconc failures dired-create-files-failures))
1731 (dired-log-summary
1732 (format "%s failed for %d file%s in %d requests"
1733 operation (length failures)
1734 (dired-plural-s (length failures))
1735 total)
1736 failures))
1737 (failures
1738 (dired-log-summary
1739 (format "%s failed for %d of %d file%s"
1740 operation (length failures)
1741 total (dired-plural-s total))
1742 failures))
1743 (skipped
1744 (dired-log-summary
1745 (format "%s: %d of %d file%s skipped"
1746 operation (length skipped) total
1747 (dired-plural-s total))
1748 skipped))
1750 (message "%s: %s file%s"
1751 operation success-count (dired-plural-s success-count)))))
1752 (dired-move-to-filename))
1754 (defun dired-do-create-files (op-symbol file-creator operation arg
1755 &optional marker-char op1
1756 how-to)
1757 "Create a new file for each marked file.
1758 Prompt user for a target directory in which to create the new
1759 files. The target may also be a non-directory file, if only
1760 one file is marked. The initial suggestion for target is the
1761 Dired buffer's current directory (or, if `dired-dwim-target' is
1762 non-nil, the current directory of a neighboring Dired window).
1763 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1764 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1765 FILE-CREATOR and OPERATION as in `dired-create-files'.
1766 ARG as in `dired-get-marked-files'.
1767 Optional arg MARKER-CHAR as in `dired-create-files'.
1768 Optional arg OP1 is an alternate form for OPERATION if there is
1769 only one file.
1770 Optional arg HOW-TO determines how to treat the target.
1771 If HOW-TO is nil, use `file-directory-p' to determine if the
1772 target is a directory. If so, the marked file(s) are created
1773 inside that directory. Otherwise, the target is a plain file;
1774 an error is raised unless there is exactly one marked file.
1775 If HOW-TO is t, target is always treated as a plain file.
1776 Otherwise, HOW-TO should be a function of one argument, TARGET.
1777 If its return value is nil, TARGET is regarded as a plain file.
1778 If it return value is a list, TARGET is a generalized
1779 directory (e.g. some sort of archive). The first element of
1780 this list must be a function with at least four arguments:
1781 operation - as OPERATION above.
1782 rfn-list - list of the relative names for the marked files.
1783 fn-list - list of the absolute names for the marked files.
1784 target - the name of the target itself.
1785 The rest of into-dir are optional arguments.
1786 For any other return value, TARGET is treated as a directory."
1787 (or op1 (setq op1 operation))
1788 (let* ((fn-list (dired-get-marked-files nil arg))
1789 (rfn-list (mapcar (function dired-make-relative) fn-list))
1790 (dired-one-file ; fluid variable inside dired-create-files
1791 (and (consp fn-list) (null (cdr fn-list)) (car fn-list)))
1792 (target-dir (dired-dwim-target-directory))
1793 (default (and dired-one-file
1794 (expand-file-name (file-name-nondirectory (car fn-list))
1795 target-dir)))
1796 (defaults (dired-dwim-target-defaults fn-list target-dir))
1797 (target (expand-file-name ; fluid variable inside dired-create-files
1798 (minibuffer-with-setup-hook
1799 (lambda ()
1800 (set (make-local-variable 'minibuffer-default-add-function) nil)
1801 (setq minibuffer-default defaults))
1802 (dired-mark-read-file-name
1803 (concat (if dired-one-file op1 operation) " %s to: ")
1804 target-dir op-symbol arg rfn-list default))))
1805 (into-dir (cond ((null how-to)
1806 ;; Allow users to change the letter case of
1807 ;; a directory on a case-insensitive
1808 ;; filesystem. If we don't test these
1809 ;; conditions up front, file-directory-p
1810 ;; below will return t on a case-insensitive
1811 ;; filesystem, and Emacs will try to move
1812 ;; foo -> foo/foo, which fails.
1813 (if (and (file-name-case-insensitive-p (car fn-list))
1814 (eq op-symbol 'move)
1815 dired-one-file
1816 (string= (downcase
1817 (expand-file-name (car fn-list)))
1818 (downcase
1819 (expand-file-name target)))
1820 (not (string=
1821 (file-name-nondirectory (car fn-list))
1822 (file-name-nondirectory target))))
1824 (file-directory-p target)))
1825 ((eq how-to t) nil)
1826 (t (funcall how-to target)))))
1827 (if (and (consp into-dir) (functionp (car into-dir)))
1828 (apply (car into-dir) operation rfn-list fn-list target (cdr into-dir))
1829 (if (not (or dired-one-file into-dir))
1830 (error "Marked %s: target must be a directory: %s" operation target))
1831 ;; rename-file bombs when moving directories unless we do this:
1832 (or into-dir (setq target (directory-file-name target)))
1833 (dired-create-files
1834 file-creator operation fn-list
1835 (if into-dir ; target is a directory
1836 ;; This function uses fluid variable target when called
1837 ;; inside dired-create-files:
1838 (function
1839 (lambda (from)
1840 (expand-file-name (file-name-nondirectory from) target)))
1841 (function (lambda (_from) target)))
1842 marker-char))))
1844 ;; Read arguments for a marked-files command that wants a file name,
1845 ;; perhaps popping up the list of marked files.
1846 ;; ARG is the prefix arg and indicates whether the files came from
1847 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1848 ;; If the current file was used, the list has but one element and ARG
1849 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1850 ;; DEFAULT is the default value to return if the user just hits RET;
1851 ;; if it is omitted or nil, then the name of the directory is used.
1853 (defun dired-mark-read-file-name (prompt dir op-symbol arg files
1854 &optional default)
1855 (dired-mark-pop-up
1856 nil op-symbol files
1857 (function read-file-name)
1858 (format prompt (dired-mark-prompt arg files)) dir default))
1860 (defun dired-dwim-target-directory ()
1861 ;; Try to guess which target directory the user may want.
1862 ;; If there is a dired buffer displayed in one of the next windows,
1863 ;; use its current subdir, else use current subdir of this dired buffer.
1864 (let ((this-dir (and (eq major-mode 'dired-mode)
1865 (dired-current-directory))))
1866 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1867 (if dired-dwim-target
1868 (let* ((other-win (get-window-with-predicate
1869 (lambda (window)
1870 (with-current-buffer (window-buffer window)
1871 (eq major-mode 'dired-mode)))))
1872 (other-dir (and other-win
1873 (with-current-buffer (window-buffer other-win)
1874 (and (eq major-mode 'dired-mode)
1875 (dired-current-directory))))))
1876 (or other-dir this-dir))
1877 this-dir)))
1879 (defun dired-dwim-target-defaults (fn-list target-dir)
1880 ;; Return a list of default values for file-reading functions in Dired.
1881 ;; This list may contain directories from Dired buffers in other windows.
1882 ;; `fn-list' is a list of file names used to build a list of defaults.
1883 ;; When nil or more than one element, a list of defaults will
1884 ;; contain only directory names. `target-dir' is a directory name
1885 ;; to exclude from the returned list, for the case when this
1886 ;; directory name is already presented in initial input.
1887 ;; For Dired operations that support `dired-dwim-target',
1888 ;; the argument `target-dir' should have the value returned
1889 ;; from `dired-dwim-target-directory'.
1890 (let ((dired-one-file
1891 (and (consp fn-list) (null (cdr fn-list)) (car fn-list)))
1892 (current-dir (and (eq major-mode 'dired-mode)
1893 (dired-current-directory)))
1894 dired-dirs)
1895 ;; Get a list of directories of visible buffers in dired-mode.
1896 (walk-windows (lambda (w)
1897 (with-current-buffer (window-buffer w)
1898 (and (eq major-mode 'dired-mode)
1899 (push (dired-current-directory) dired-dirs)))))
1900 ;; Force the current dir to be the first in the list.
1901 (setq dired-dirs
1902 (delete-dups (delq nil (cons current-dir (nreverse dired-dirs)))))
1903 ;; Remove the target dir (if specified) or the current dir from
1904 ;; default values, because it should be already in initial input.
1905 (setq dired-dirs (delete (or target-dir current-dir) dired-dirs))
1906 ;; Return a list of default values.
1907 (if dired-one-file
1908 ;; For one file operation, provide a list that contains
1909 ;; other directories, other directories with the appended filename
1910 ;; and the current directory with the appended filename, e.g.
1911 ;; 1. /TARGET-DIR/
1912 ;; 2. /TARGET-DIR/FILENAME
1913 ;; 3. /CURRENT-DIR/FILENAME
1914 (append dired-dirs
1915 (mapcar (lambda (dir)
1916 (expand-file-name
1917 (file-name-nondirectory (car fn-list)) dir))
1918 (reverse dired-dirs))
1919 (list (expand-file-name
1920 (file-name-nondirectory (car fn-list))
1921 (or target-dir current-dir))))
1922 ;; For multi-file operation, return only a list of other directories.
1923 dired-dirs)))
1926 ;;;###autoload
1927 (defun dired-create-directory (directory)
1928 "Create a directory called DIRECTORY.
1929 If DIRECTORY already exists, signal an error."
1930 (interactive
1931 (list (read-file-name "Create directory: " (dired-current-directory))))
1932 (let* ((expanded (directory-file-name (expand-file-name directory)))
1933 (try expanded) new)
1934 (if (file-exists-p expanded)
1935 (error "Cannot create directory %s: file exists" expanded))
1936 ;; Find the topmost nonexistent parent dir (variable `new')
1937 (while (and try (not (file-exists-p try)) (not (equal new try)))
1938 (setq new try
1939 try (directory-file-name (file-name-directory try))))
1940 (make-directory expanded t)
1941 (when new
1942 (dired-add-file new)
1943 (dired-move-to-filename))))
1945 (defun dired-into-dir-with-symlinks (target)
1946 (and (file-directory-p target)
1947 (not (file-symlink-p target))))
1948 ;; This may not always be what you want, especially if target is your
1949 ;; home directory and it happens to be a symbolic link, as is often the
1950 ;; case with NFS and automounters. Or if you want to make symlinks
1951 ;; into directories that themselves are only symlinks, also quite
1952 ;; common.
1954 ;; So we don't use this function as value for HOW-TO in
1955 ;; dired-do-symlink, which has the minor disadvantage of
1956 ;; making links *into* a symlinked-dir, when you really wanted to
1957 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1958 ;; just have to remove that symlink by hand before making your marked
1959 ;; symlinks.
1961 (defvar dired-copy-how-to-fn nil
1962 "Either nil or a function used by `dired-do-copy' to determine target.
1963 See HOW-TO argument for `dired-do-create-files'.")
1965 ;;;###autoload
1966 (defun dired-do-copy (&optional arg)
1967 "Copy all marked (or next ARG) files, or copy the current file.
1968 When operating on just the current file, prompt for the new name.
1970 When operating on multiple or marked files, prompt for a target
1971 directory, and make the new copies in that directory, with the
1972 same names as the original files. The initial suggestion for the
1973 target directory is the Dired buffer's current directory (or, if
1974 `dired-dwim-target' is non-nil, the current directory of a
1975 neighboring Dired window).
1977 If `dired-copy-preserve-time' is non-nil, this command preserves
1978 the modification time of each old file in the copy, similar to
1979 the \"-p\" option for the \"cp\" shell command.
1981 This command copies symbolic links by creating new ones, similar
1982 to the \"-d\" option for the \"cp\" shell command."
1983 (interactive "P")
1984 (let ((dired-recursive-copies dired-recursive-copies))
1985 (dired-do-create-files 'copy (function dired-copy-file)
1986 "Copy"
1987 arg dired-keep-marker-copy
1988 nil dired-copy-how-to-fn)))
1990 ;;;###autoload
1991 (defun dired-do-symlink (&optional arg)
1992 "Make symbolic links to current file or all marked (or next ARG) files.
1993 When operating on just the current file, you specify the new name.
1994 When operating on multiple or marked files, you specify a directory
1995 and new symbolic links are made in that directory
1996 with the same names that the files currently have. The default
1997 suggested for the target directory depends on the value of
1998 `dired-dwim-target', which see.
2000 For relative symlinks, use \\[dired-do-relsymlink]."
2001 (interactive "P")
2002 (dired-do-create-files 'symlink (function make-symbolic-link)
2003 "Symlink" arg dired-keep-marker-symlink))
2005 ;;;###autoload
2006 (defun dired-do-hardlink (&optional arg)
2007 "Add names (hard links) current file or all marked (or next ARG) files.
2008 When operating on just the current file, you specify the new name.
2009 When operating on multiple or marked files, you specify a directory
2010 and new hard links are made in that directory
2011 with the same names that the files currently have. The default
2012 suggested for the target directory depends on the value of
2013 `dired-dwim-target', which see."
2014 (interactive "P")
2015 (dired-do-create-files 'hardlink (function dired-hardlink)
2016 "Hardlink" arg dired-keep-marker-hardlink))
2018 (defun dired-hardlink (file newname &optional ok-if-already-exists)
2019 (dired-handle-overwrite newname)
2020 ;; error is caught in -create-files
2021 (add-name-to-file file newname ok-if-already-exists)
2022 ;; Update the link count
2023 (dired-relist-file file))
2025 ;;;###autoload
2026 (defun dired-do-rename (&optional arg)
2027 "Rename current file or all marked (or next ARG) files.
2028 When renaming just the current file, you specify the new name.
2029 When renaming multiple or marked files, you specify a directory.
2030 This command also renames any buffers that are visiting the files.
2031 The default suggested for the target directory depends on the value
2032 of `dired-dwim-target', which see."
2033 (interactive "P")
2034 (dired-do-create-files 'move (function dired-rename-file)
2035 "Move" arg dired-keep-marker-rename "Rename"))
2036 ;;;###end dired-cp.el
2038 ;;; 5K
2039 ;;;###begin dired-re.el
2040 (defvar rename-regexp-query)
2042 (defun dired-do-create-files-regexp
2043 (file-creator operation arg regexp newname &optional whole-name marker-char)
2044 ;; Create a new file for each marked file using regexps.
2045 ;; FILE-CREATOR and OPERATION as in dired-create-files.
2046 ;; ARG as in dired-get-marked-files.
2047 ;; Matches each marked file against REGEXP and constructs the new
2048 ;; filename from NEWNAME (like in function replace-match).
2049 ;; Optional arg WHOLE-NAME means match/replace the whole file name
2050 ;; instead of only the non-directory part of the file.
2051 ;; Optional arg MARKER-CHAR as in dired-create-files.
2052 (let* ((fn-list (dired-get-marked-files nil arg))
2053 (operation-prompt (concat operation " `%s' to `%s'?"))
2054 (rename-regexp-help-form (format-message "\
2055 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
2056 `!' to %s all remaining matches with no more questions."
2057 (downcase operation)
2058 (downcase operation)))
2059 (regexp-name-constructor
2060 ;; Function to construct new filename using REGEXP and NEWNAME:
2061 (if whole-name ; easy (but rare) case
2062 (function
2063 (lambda (from)
2064 (let ((to (dired-string-replace-match regexp from newname))
2065 ;; must bind help-form directly around call to
2066 ;; dired-query
2067 (help-form rename-regexp-help-form))
2068 (if to
2069 (and (dired-query 'rename-regexp-query
2070 operation-prompt
2071 from
2074 (dired-log "%s: %s did not match regexp %s\n"
2075 operation from regexp)))))
2076 ;; not whole-name, replace non-directory part only
2077 (function
2078 (lambda (from)
2079 (let* ((new (dired-string-replace-match
2080 regexp (file-name-nondirectory from) newname))
2081 (to (and new ; nil means there was no match
2082 (expand-file-name new
2083 (file-name-directory from))))
2084 (help-form rename-regexp-help-form))
2085 (if to
2086 (and (dired-query 'rename-regexp-query
2087 operation-prompt
2088 (dired-make-relative from)
2089 (dired-make-relative to))
2091 (dired-log "%s: %s did not match regexp %s\n"
2092 operation (file-name-nondirectory from) regexp)))))))
2093 rename-regexp-query)
2094 (dired-create-files
2095 file-creator operation fn-list regexp-name-constructor marker-char)))
2097 (defun dired-mark-read-regexp (operation)
2098 ;; Prompt user about performing OPERATION.
2099 ;; Read and return list of: regexp newname arg whole-name.
2100 (let* ((whole-name
2101 (equal 0 (prefix-numeric-value current-prefix-arg)))
2102 (arg
2103 (if whole-name nil current-prefix-arg))
2104 (regexp
2105 (read-regexp
2106 (concat (if whole-name "Abs. " "") operation " from (regexp): ")
2107 nil 'dired-regexp-history))
2108 (newname
2109 (read-string
2110 (concat (if whole-name "Abs. " "") operation " " regexp " to: "))))
2111 (list regexp newname arg whole-name)))
2113 ;;;###autoload
2114 (defun dired-do-rename-regexp (regexp newname &optional arg whole-name)
2115 "Rename selected files whose names match REGEXP to NEWNAME.
2117 With non-zero prefix argument ARG, the command operates on the next ARG
2118 files. Otherwise, it operates on all the marked files, or the current
2119 file if none are marked.
2121 As each match is found, the user must type a character saying
2122 what to do with it. For directions, type \\[help-command] at that time.
2123 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2124 REGEXP defaults to the last regexp used.
2126 With a zero prefix arg, renaming by regexp affects the absolute file name.
2127 Normally, only the non-directory part of the file name is used and changed."
2128 (interactive (dired-mark-read-regexp "Rename"))
2129 (dired-do-create-files-regexp
2130 (function dired-rename-file)
2131 "Rename" arg regexp newname whole-name dired-keep-marker-rename))
2133 ;;;###autoload
2134 (defun dired-do-copy-regexp (regexp newname &optional arg whole-name)
2135 "Copy selected files whose names match REGEXP to NEWNAME.
2136 See function `dired-do-rename-regexp' for more info."
2137 (interactive (dired-mark-read-regexp "Copy"))
2138 (let ((dired-recursive-copies nil)) ; No recursive copies.
2139 (dired-do-create-files-regexp
2140 (function dired-copy-file)
2141 (if dired-copy-preserve-time "Copy [-p]" "Copy")
2142 arg regexp newname whole-name dired-keep-marker-copy)))
2144 ;;;###autoload
2145 (defun dired-do-hardlink-regexp (regexp newname &optional arg whole-name)
2146 "Hardlink selected files whose names match REGEXP to NEWNAME.
2147 See function `dired-do-rename-regexp' for more info."
2148 (interactive (dired-mark-read-regexp "HardLink"))
2149 (dired-do-create-files-regexp
2150 (function add-name-to-file)
2151 "HardLink" arg regexp newname whole-name dired-keep-marker-hardlink))
2153 ;;;###autoload
2154 (defun dired-do-symlink-regexp (regexp newname &optional arg whole-name)
2155 "Symlink selected files whose names match REGEXP to NEWNAME.
2156 See function `dired-do-rename-regexp' for more info."
2157 (interactive (dired-mark-read-regexp "SymLink"))
2158 (dired-do-create-files-regexp
2159 (function make-symbolic-link)
2160 "SymLink" arg regexp newname whole-name dired-keep-marker-symlink))
2162 (defvar rename-non-directory-query)
2164 (defun dired-create-files-non-directory
2165 (file-creator basename-constructor operation arg)
2166 ;; Perform FILE-CREATOR on the non-directory part of marked files
2167 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
2168 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
2169 (let (rename-non-directory-query)
2170 (dired-create-files
2171 file-creator
2172 operation
2173 (dired-get-marked-files nil arg)
2174 (function
2175 (lambda (from)
2176 (let ((to (concat (file-name-directory from)
2177 (funcall basename-constructor
2178 (file-name-nondirectory from)))))
2179 (and (let ((help-form (format-message "\
2180 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
2181 `!' to %s all remaining matches with no more questions."
2182 (downcase operation)
2183 (downcase operation))))
2184 (dired-query 'rename-non-directory-query
2185 (concat operation " `%s' to `%s'")
2186 (dired-make-relative from)
2187 (dired-make-relative to)))
2188 to))))
2189 dired-keep-marker-rename)))
2191 (defun dired-rename-non-directory (basename-constructor operation arg)
2192 (dired-create-files-non-directory
2193 (function dired-rename-file)
2194 basename-constructor operation arg))
2196 ;;;###autoload
2197 (defun dired-upcase (&optional arg)
2198 "Rename all marked (or next ARG) files to upper case."
2199 (interactive "P")
2200 (dired-rename-non-directory (function upcase) "Rename upcase" arg))
2202 ;;;###autoload
2203 (defun dired-downcase (&optional arg)
2204 "Rename all marked (or next ARG) files to lower case."
2205 (interactive "P")
2206 (dired-rename-non-directory (function downcase) "Rename downcase" arg))
2208 ;;;###end dired-re.el
2210 ;;; 13K
2211 ;;;###begin dired-ins.el
2213 ;;;###autoload
2214 (defun dired-maybe-insert-subdir (dirname &optional
2215 switches no-error-if-not-dir-p)
2216 "Insert this subdirectory into the same dired buffer.
2217 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2218 else inserts it at its natural place (as `ls -lR' would have done).
2219 With a prefix arg, you may edit the ls switches used for this listing.
2220 You can add `R' to the switches to expand the whole tree starting at
2221 this subdirectory.
2222 This function takes some pains to conform to `ls -lR' output.
2224 Dired remembers switches specified with a prefix arg, so that reverting
2225 the buffer will not reset them. However, using `dired-undo' to re-insert
2226 or delete subdirectories can bypass this machinery. Hence, you sometimes
2227 may have to reset some subdirectory switches after a `dired-undo'.
2228 You can reset all subdirectory switches to the default using
2229 \\<dired-mode-map>\\[dired-reset-subdir-switches].
2230 See Info node `(emacs)Subdir switches' for more details."
2231 (interactive
2232 (list (dired-get-filename)
2233 (if current-prefix-arg
2234 (read-string "Switches for listing: "
2235 (or dired-subdir-switches dired-actual-switches)))))
2236 (let ((opoint (point)))
2237 ;; We don't need a marker for opoint as the subdir is always
2238 ;; inserted *after* opoint.
2239 (setq dirname (file-name-as-directory dirname))
2240 (or (and (not switches)
2241 (when (dired-goto-subdir dirname)
2242 (unless (dired-subdir-hidden-p dirname)
2243 (dired-initial-position dirname))
2245 (dired-insert-subdir dirname switches no-error-if-not-dir-p))
2246 ;; Push mark so that it's easy to find back. Do this after the
2247 ;; insert message so that the user sees the `Mark set' message.
2248 (push-mark opoint)))
2250 ;;;###autoload
2251 (defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p)
2252 "Insert this subdirectory into the same Dired buffer.
2253 If it is already present, overwrite the previous entry;
2254 otherwise, insert it at its natural place (as `ls -lR' would
2255 have done).
2256 With a prefix arg, you may edit the `ls' switches used for this listing.
2257 You can add `R' to the switches to expand the whole tree starting at
2258 this subdirectory.
2259 This function takes some pains to conform to `ls -lR' output."
2260 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
2261 ;; Prospero where dired-ls does the right thing, but
2262 ;; file-directory-p has not been redefined.
2263 (interactive
2264 (list (dired-get-filename)
2265 (if current-prefix-arg
2266 (read-string "Switches for listing: "
2267 (or dired-subdir-switches dired-actual-switches)))))
2268 (setq dirname (file-name-as-directory (expand-file-name dirname)))
2269 (or no-error-if-not-dir-p
2270 (file-directory-p dirname)
2271 (error "Attempt to insert a non-directory: %s" dirname))
2272 (let ((elt (assoc dirname dired-subdir-alist))
2273 (cons (assoc-string dirname dired-switches-alist))
2274 (modflag (buffer-modified-p))
2275 (old-switches switches)
2276 switches-have-R mark-alist case-fold-search buffer-read-only)
2277 (and (not switches) cons (setq switches (cdr cons)))
2278 (dired-insert-subdir-validate dirname switches)
2279 ;; case-fold-search is nil now, so we can test for capital `R':
2280 (if (setq switches-have-R (and switches (string-match-p "R" switches)))
2281 ;; avoid duplicated subdirs
2282 (setq mark-alist (dired-kill-tree dirname t)))
2283 (if elt
2284 ;; If subdir is already present, remove it and remember its marks
2285 (setq mark-alist (nconc (dired-insert-subdir-del elt) mark-alist))
2286 (dired-insert-subdir-newpos dirname)) ; else compute new position
2287 (dired-insert-subdir-doupdate
2288 dirname elt (dired-insert-subdir-doinsert dirname switches))
2289 (when old-switches
2290 (if cons
2291 (setcdr cons switches)
2292 (push (cons dirname switches) dired-switches-alist)))
2293 (when switches-have-R
2294 (dired-build-subdir-alist switches)
2295 (setq switches (dired-replace-in-string "R" "" switches))
2296 (dolist (cur-ass dired-subdir-alist)
2297 (let ((cur-dir (car cur-ass)))
2298 (and (dired-in-this-tree cur-dir dirname)
2299 (let ((cur-cons (assoc-string cur-dir dired-switches-alist)))
2300 (if cur-cons
2301 (setcdr cur-cons switches)
2302 (push (cons cur-dir switches) dired-switches-alist)))))))
2303 (dired-initial-position dirname)
2304 (save-excursion (dired-mark-remembered mark-alist))
2305 (restore-buffer-modified-p modflag)))
2307 (defun dired-insert-subdir-validate (dirname &optional switches)
2308 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2309 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2310 (or (dired-in-this-tree dirname (expand-file-name default-directory))
2311 (error "%s: not in this directory tree" dirname))
2312 (let ((real-switches (or switches dired-subdir-switches)))
2313 (when real-switches
2314 (let (case-fold-search)
2315 (mapcar
2316 (function
2317 (lambda (x)
2318 (or (eq (null (string-match-p x real-switches))
2319 (null (string-match-p x dired-actual-switches)))
2320 (error
2321 "Can't have dirs with and without -%s switches together" x))))
2322 ;; all switches that make a difference to dired-get-filename:
2323 '("F" "b"))))))
2325 (defun dired-alist-add (dir new-marker)
2326 ;; Add new DIR at NEW-MARKER. Sort alist.
2327 (dired-alist-add-1 dir new-marker)
2328 (dired-alist-sort))
2330 (defun dired-alist-sort ()
2331 ;; Keep the alist sorted on buffer position.
2332 (setq dired-subdir-alist
2333 (sort dired-subdir-alist
2334 (function (lambda (elt1 elt2)
2335 (> (dired-get-subdir-min elt1)
2336 (dired-get-subdir-min elt2)))))))
2338 (defun dired-kill-tree (dirname &optional remember-marks kill-root)
2339 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2340 Interactively, you can kill DIRNAME as well by using a prefix argument.
2341 In interactive use, the command prompts for DIRNAME.
2343 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2344 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2345 (interactive "DKill tree below directory: \ni\nP")
2346 (setq dirname (file-name-as-directory (expand-file-name dirname)))
2347 (let ((s-alist dired-subdir-alist) dir m-alist)
2348 (while s-alist
2349 (setq dir (car (car s-alist))
2350 s-alist (cdr s-alist))
2351 (and (or kill-root (not (string-equal dir dirname)))
2352 (dired-in-this-tree dir dirname)
2353 (dired-goto-subdir dir)
2354 (setq m-alist (nconc (dired-kill-subdir remember-marks) m-alist))))
2355 m-alist))
2357 (defun dired-insert-subdir-newpos (new-dir)
2358 ;; Find pos for new subdir, according to tree order.
2359 ;;(goto-char (point-max))
2360 (let ((alist dired-subdir-alist) elt dir new-pos)
2361 (while alist
2362 (setq elt (car alist)
2363 alist (cdr alist)
2364 dir (car elt))
2365 (if (dired-tree-lessp dir new-dir)
2366 ;; Insert NEW-DIR after DIR
2367 (setq new-pos (dired-get-subdir-max elt)
2368 alist nil)))
2369 (goto-char new-pos))
2370 ;; want a separating newline between subdirs
2371 (or (eobp)
2372 (forward-line -1))
2373 (insert "\n")
2374 (point))
2376 (defun dired-insert-subdir-del (element)
2377 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2378 ;; Move to that buffer position. Return a mark-alist.
2379 (let ((begin-marker (dired-get-subdir-min element)))
2380 (goto-char begin-marker)
2381 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2382 (goto-char (dired-subdir-max))
2383 (or (eobp);; want a separating newline _between_ subdirs:
2384 (forward-char -1))
2385 (prog1
2386 (dired-remember-marks begin-marker (point))
2387 (delete-region begin-marker (point)))))
2389 (defun dired-insert-subdir-doinsert (dirname switches)
2390 ;; Insert ls output after point.
2391 ;; Return the boundary of the inserted text (as list of BEG and END).
2392 (save-excursion
2393 (let ((begin (point)))
2394 (let ((dired-actual-switches
2395 (or switches
2396 dired-subdir-switches
2397 (dired-replace-in-string "R" "" dired-actual-switches))))
2398 (if (equal dirname (car (car (last dired-subdir-alist))))
2399 ;; If doing the top level directory of the buffer,
2400 ;; redo it as specified in dired-directory.
2401 (dired-readin-insert)
2402 (dired-insert-directory dirname dired-actual-switches nil nil t)))
2403 (list begin (point)))))
2405 (defun dired-insert-subdir-doupdate (dirname elt beg-end)
2406 ;; Point is at the correct subdir alist position for ELT,
2407 ;; BEG-END is the subdir-region (as list of begin and end).
2408 (if elt ; subdir was already present
2409 ;; update its position (should actually be unchanged)
2410 (set-marker (dired-get-subdir-min elt) (point-marker))
2411 (dired-alist-add dirname (point-marker)))
2412 ;; The hook may depend on the subdir-alist containing the just
2413 ;; inserted subdir, so run it after dired-alist-add:
2414 (if dired-after-readin-hook
2415 (save-excursion
2416 (let ((begin (nth 0 beg-end))
2417 (end (nth 1 beg-end)))
2418 (goto-char begin)
2419 (save-restriction
2420 (narrow-to-region begin end)
2421 ;; hook may add or delete lines, but the subdir boundary
2422 ;; marker floats
2423 (run-hooks 'dired-after-readin-hook))))))
2425 (defun dired-tree-lessp (dir1 dir2)
2426 ;; Lexicographic order on file name components, like `ls -lR':
2427 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2428 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2429 ;; or DIR1 and DIR2 are in the same parentdir and their last
2430 ;; components are string-lessp.
2431 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2432 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2433 ;; if dired-actual-switches contained t.
2434 (setq dir1 (file-name-as-directory dir1)
2435 dir2 (file-name-as-directory dir2))
2436 (let ((components-1 (dired-split "/" dir1))
2437 (components-2 (dired-split "/" dir2)))
2438 (while (and components-1
2439 components-2
2440 (equal (car components-1) (car components-2)))
2441 (setq components-1 (cdr components-1)
2442 components-2 (cdr components-2)))
2443 (let ((c1 (car components-1))
2444 (c2 (car components-2)))
2446 (cond ((and c1 c2)
2447 (string-lessp c1 c2))
2448 ((and (null c1) (null c2))
2449 nil) ; they are equal, not lessp
2450 ((null c1) ; c2 is a subdir of c1: c1<c2
2452 ((null c2) ; c1 is a subdir of c2: c1>c2
2453 nil)
2454 (t (error "This can't happen"))))))
2456 ;; There should be a builtin split function - inverse to mapconcat.
2457 (defun dired-split (pat str &optional limit)
2458 "Splitting on regexp PAT, turn string STR into a list of substrings.
2459 Optional third arg LIMIT (>= 1) is a limit to the length of the
2460 resulting list.
2461 Thus, if SEP is a regexp that only matches itself,
2463 (mapconcat 'identity (dired-split SEP STRING) SEP)
2465 is always equal to STRING."
2466 (let* ((start (string-match pat str))
2467 (result (list (substring str 0 start)))
2468 (count 1)
2469 (end (if start (match-end 0))))
2470 (if end ; else nothing left
2471 (while (and (or (not (integerp limit))
2472 (< count limit))
2473 (string-match pat str end))
2474 (setq start (match-beginning 0)
2475 count (1+ count)
2476 result (cons (substring str end start) result)
2477 end (match-end 0)
2478 start end)
2480 (if (and (or (not (integerp limit))
2481 (< count limit))
2482 end) ; else nothing left
2483 (setq result
2484 (cons (substring str end) result)))
2485 (nreverse result)))
2487 ;;; moving by subdirectories
2489 ;;;###autoload
2490 (defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip)
2491 "Go to previous subdirectory, regardless of level.
2492 When called interactively and not on a subdir line, go to this subdir's line."
2493 ;;(interactive "p")
2494 (interactive
2495 (list (if current-prefix-arg
2496 (prefix-numeric-value current-prefix-arg)
2497 ;; if on subdir start already, don't stay there!
2498 (if (dired-get-subdir) 1 0))))
2499 (dired-next-subdir (- arg) no-error-if-not-found no-skip))
2501 (defun dired-subdir-min ()
2502 (save-excursion
2503 (if (not (dired-prev-subdir 0 t t))
2504 (error "Not in a subdir!")
2505 (point))))
2507 ;;;###autoload
2508 (defun dired-goto-subdir (dir)
2509 "Go to end of header line of DIR in this dired buffer.
2510 Return value of point on success, otherwise return nil.
2511 The next char is either \\n, or \\r if DIR is hidden."
2512 (interactive
2513 (prog1 ; let push-mark display its message
2514 (list (expand-file-name
2515 (completing-read "Goto in situ directory: " ; prompt
2516 dired-subdir-alist ; table
2517 nil ; predicate
2518 t ; require-match
2519 (dired-current-directory))))
2520 (push-mark)))
2521 (setq dir (file-name-as-directory dir))
2522 (let ((elt (assoc dir dired-subdir-alist)))
2523 (and elt
2524 (goto-char (dired-get-subdir-min elt))
2525 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2526 ;; at either \r or \n after this function succeeds.
2527 (progn (skip-chars-forward "^\r\n")
2528 (point)))))
2530 ;;;###autoload
2531 (defun dired-mark-subdir-files ()
2532 "Mark all files except `.' and `..' in current subdirectory.
2533 If the Dired buffer shows multiple directories, this command
2534 marks the files listed in the subdirectory that point is in."
2535 (interactive)
2536 (let ((p-min (dired-subdir-min)))
2537 (dired-mark-files-in-region p-min (dired-subdir-max))))
2539 ;;;###autoload
2540 (defun dired-kill-subdir (&optional remember-marks)
2541 "Remove all lines of current subdirectory.
2542 Lower levels are unaffected."
2543 ;; With optional REMEMBER-MARKS, return a mark-alist.
2544 (interactive)
2545 (let* ((beg (dired-subdir-min))
2546 (end (dired-subdir-max))
2547 (modflag (buffer-modified-p))
2548 (cur-dir (dired-current-directory))
2549 (cons (assoc-string cur-dir dired-switches-alist))
2550 buffer-read-only)
2551 (when (equal cur-dir (expand-file-name default-directory))
2552 (error "Attempt to kill top level directory"))
2553 (prog1
2554 (if remember-marks (dired-remember-marks beg end))
2555 (delete-region beg end)
2556 (if (eobp) ; don't leave final blank line
2557 (delete-char -1))
2558 (dired-unsubdir cur-dir)
2559 (when cons
2560 (setq dired-switches-alist (delete cons dired-switches-alist)))
2561 (restore-buffer-modified-p modflag))))
2563 (defun dired-unsubdir (dir)
2564 ;; Remove DIR from the alist
2565 (setq dired-subdir-alist
2566 (delq (assoc dir dired-subdir-alist) dired-subdir-alist)))
2568 ;;;###autoload
2569 (defun dired-tree-up (arg)
2570 "Go up ARG levels in the dired tree."
2571 (interactive "p")
2572 (let ((dir (dired-current-directory)))
2573 (while (>= arg 1)
2574 (setq arg (1- arg)
2575 dir (file-name-directory (directory-file-name dir))))
2576 ;;(setq dir (expand-file-name dir))
2577 (or (dired-goto-subdir dir)
2578 (error "Cannot go up to %s - not in this tree" dir))))
2580 ;;;###autoload
2581 (defun dired-tree-down ()
2582 "Go down in the dired tree."
2583 (interactive)
2584 (let ((dir (dired-current-directory)) ; has slash
2585 pos case-fold-search) ; filenames are case sensitive
2586 (let ((rest (reverse dired-subdir-alist)) elt)
2587 (while rest
2588 (setq elt (car rest)
2589 rest (cdr rest))
2590 (if (dired-in-this-tree (directory-file-name (car elt)) dir)
2591 (setq rest nil
2592 pos (dired-goto-subdir (car elt))))))
2593 (if pos
2594 (goto-char pos)
2595 (error "At the bottom"))))
2597 ;;; hiding
2599 (defun dired-unhide-subdir ()
2600 (let (buffer-read-only)
2601 (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?\r ?\n)))
2603 (defun dired-hide-check ()
2604 (or selective-display
2605 (error "selective-display must be t for subdir hiding to work!")))
2607 (defun dired-subdir-hidden-p (dir)
2608 (and selective-display
2609 (save-excursion
2610 (dired-goto-subdir dir)
2611 (looking-at-p "\r"))))
2613 ;;;###autoload
2614 (defun dired-hide-subdir (arg)
2615 "Hide or unhide the current subdirectory and move to next directory.
2616 Optional prefix arg is a repeat factor.
2617 Use \\[dired-hide-all] to (un)hide all directories."
2618 (interactive "p")
2619 (dired-hide-check)
2620 (let ((modflag (buffer-modified-p)))
2621 (while (>= (setq arg (1- arg)) 0)
2622 (let* ((cur-dir (dired-current-directory))
2623 (hidden-p (dired-subdir-hidden-p cur-dir))
2624 (elt (assoc cur-dir dired-subdir-alist))
2625 (end-pos (1- (dired-get-subdir-max elt)))
2626 buffer-read-only)
2627 ;; keep header line visible, hide rest
2628 (goto-char (dired-get-subdir-min elt))
2629 (skip-chars-forward "^\n\r")
2630 (if hidden-p
2631 (subst-char-in-region (point) end-pos ?\r ?\n)
2632 (subst-char-in-region (point) end-pos ?\n ?\r)))
2633 (dired-next-subdir 1 t))
2634 (restore-buffer-modified-p modflag)))
2636 ;;;###autoload
2637 (defun dired-hide-all (&optional ignored)
2638 "Hide all subdirectories, leaving only their header lines.
2639 If there is already something hidden, make everything visible again.
2640 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2641 (interactive "P")
2642 (dired-hide-check)
2643 (let ((modflag (buffer-modified-p))
2644 buffer-read-only)
2645 (if (save-excursion
2646 (goto-char (point-min))
2647 (search-forward "\r" nil t))
2648 ;; unhide - bombs on \r in filenames
2649 (subst-char-in-region (point-min) (point-max) ?\r ?\n)
2650 ;; hide
2651 (let ((pos (point-max)) ; pos of end of last directory
2652 (alist dired-subdir-alist))
2653 (while alist ; while there are dirs before pos
2654 (subst-char-in-region (dired-get-subdir-min (car alist)) ; pos of prev dir
2655 (save-excursion
2656 (goto-char pos) ; current dir
2657 ;; we're somewhere on current dir's line
2658 (forward-line -1)
2659 (point))
2660 ?\n ?\r)
2661 (setq pos (dired-get-subdir-min (car alist))) ; prev dir gets current dir
2662 (setq alist (cdr alist)))))
2663 (restore-buffer-modified-p modflag)))
2665 ;;;###end dired-ins.el
2668 ;; Search only in file names in the Dired buffer.
2670 (defcustom dired-isearch-filenames nil
2671 "Non-nil to Isearch in file names only.
2672 If t, Isearch in Dired always matches only file names.
2673 If `dwim', Isearch matches file names when initial point position is on
2674 a file name. Otherwise, it searches the whole buffer without restrictions."
2675 :type '(choice (const :tag "No restrictions" nil)
2676 (const :tag "When point is on a file name initially, search file names" dwim)
2677 (const :tag "Always search in file names" t))
2678 :group 'dired
2679 :version "23.1")
2681 (define-minor-mode dired-isearch-filenames-mode
2682 "Toggle file names searching on or off.
2683 When on, Isearch skips matches outside file names using the predicate
2684 `dired-isearch-filter-filenames' that matches only at file names.
2685 When off, it uses the original predicate."
2686 nil nil nil
2687 (if dired-isearch-filenames-mode
2688 (add-function :before-while (local 'isearch-filter-predicate)
2689 #'dired-isearch-filter-filenames
2690 '((isearch-message-prefix . "filename ")))
2691 (remove-function (local 'isearch-filter-predicate)
2692 #'dired-isearch-filter-filenames))
2693 (when isearch-mode
2694 (setq isearch-success t isearch-adjusted t)
2695 (isearch-update)))
2697 ;;;###autoload
2698 (defun dired-isearch-filenames-setup ()
2699 "Set up isearch to search in Dired file names.
2700 Intended to be added to `isearch-mode-hook'."
2701 (when (or (eq dired-isearch-filenames t)
2702 (and (eq dired-isearch-filenames 'dwim)
2703 (get-text-property (point) 'dired-filename)))
2704 (define-key isearch-mode-map "\M-sff" 'dired-isearch-filenames-mode)
2705 (dired-isearch-filenames-mode 1)
2706 (add-hook 'isearch-mode-end-hook 'dired-isearch-filenames-end nil t)))
2708 (defun dired-isearch-filenames-end ()
2709 "Clean up the Dired file name search after terminating isearch."
2710 (define-key isearch-mode-map "\M-sff" nil)
2711 (dired-isearch-filenames-mode -1)
2712 (remove-hook 'isearch-mode-end-hook 'dired-isearch-filenames-end t))
2714 (defun dired-isearch-filter-filenames (beg end)
2715 "Test whether the current search hit is a file name.
2716 Return non-nil if the text from BEG to END is part of a file
2717 name (has the text property `dired-filename')."
2718 (text-property-not-all (min beg end) (max beg end)
2719 'dired-filename nil))
2721 ;;;###autoload
2722 (defun dired-isearch-filenames ()
2723 "Search for a string using Isearch only in file names in the Dired buffer."
2724 (interactive)
2725 (let ((dired-isearch-filenames t))
2726 (isearch-forward nil t)))
2728 ;;;###autoload
2729 (defun dired-isearch-filenames-regexp ()
2730 "Search for a regexp using Isearch only in file names in the Dired buffer."
2731 (interactive)
2732 (let ((dired-isearch-filenames t))
2733 (isearch-forward-regexp nil t)))
2736 ;; Functions for searching in tags style among marked files.
2738 ;;;###autoload
2739 (defun dired-do-isearch ()
2740 "Search for a string through all marked files using Isearch."
2741 (interactive)
2742 (multi-isearch-files
2743 (dired-get-marked-files nil nil 'dired-nondirectory-p)))
2745 ;;;###autoload
2746 (defun dired-do-isearch-regexp ()
2747 "Search for a regexp through all marked files using Isearch."
2748 (interactive)
2749 (multi-isearch-files-regexp
2750 (dired-get-marked-files nil nil 'dired-nondirectory-p)))
2752 ;;;###autoload
2753 (defun dired-do-search (regexp)
2754 "Search through all marked files for a match for REGEXP.
2755 Stops when a match is found.
2756 To continue searching for next match, use command \\[tags-loop-continue]."
2757 (interactive "sSearch marked files (regexp): ")
2758 (tags-search regexp '(dired-get-marked-files nil nil 'dired-nondirectory-p)))
2760 ;;;###autoload
2761 (defun dired-do-query-replace-regexp (from to &optional delimited)
2762 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2763 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2764 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
2765 with the command \\[tags-loop-continue]."
2766 (interactive
2767 (let ((common
2768 (query-replace-read-args
2769 "Query replace regexp in marked files" t t)))
2770 (list (nth 0 common) (nth 1 common) (nth 2 common))))
2771 (dolist (file (dired-get-marked-files nil nil 'dired-nondirectory-p))
2772 (let ((buffer (get-file-buffer file)))
2773 (if (and buffer (with-current-buffer buffer
2774 buffer-read-only))
2775 (error "File `%s' is visited read-only" file))))
2776 (tags-query-replace from to delimited
2777 '(dired-get-marked-files nil nil 'dired-nondirectory-p)))
2779 (declare-function xref--show-xrefs "xref")
2780 (declare-function xref-query-replace-in-results "xref")
2782 ;;;###autoload
2783 (defun dired-do-find-regexp (regexp)
2784 "Find all matches for REGEXP in all marked files.
2785 For any marked directory, all of its files are searched recursively.
2786 However, files matching `grep-find-ignored-files' and subdirectories
2787 matching `grep-find-ignored-directories' are skipped in the marked
2788 directories.
2790 REGEXP should use constructs supported by your local `grep' command."
2791 (interactive "sSearch marked files (regexp): ")
2792 (require 'grep)
2793 (defvar grep-find-ignored-files)
2794 (defvar grep-find-ignored-directories)
2795 (let* ((files (dired-get-marked-files))
2796 (ignores (nconc (mapcar
2797 (lambda (s) (concat s "/"))
2798 grep-find-ignored-directories)
2799 grep-find-ignored-files))
2800 (xrefs (mapcan
2801 (lambda (file)
2802 (xref-collect-matches regexp "*" file
2803 (and (file-directory-p file)
2804 ignores)))
2805 files)))
2806 (unless xrefs
2807 (user-error "No matches for: %s" regexp))
2808 (xref--show-xrefs xrefs nil t)))
2810 ;;;###autoload
2811 (defun dired-do-find-regexp-and-replace (from to)
2812 "Replace matches of FROM with TO, in all marked files.
2813 For any marked directory, matches in all of its files are replaced,
2814 recursively. However, files matching `grep-find-ignored-files'
2815 and subdirectories matching `grep-find-ignored-directories' are skipped
2816 in the marked directories.
2818 REGEXP should use constructs supported by your local `grep' command."
2819 (interactive
2820 (let ((common
2821 (query-replace-read-args
2822 "Query replace regexp in marked files" t t)))
2823 (list (nth 0 common) (nth 1 common))))
2824 (with-current-buffer (dired-do-find-regexp from)
2825 (xref-query-replace-in-results from to)))
2827 (defun dired-nondirectory-p (file)
2828 (not (file-directory-p file)))
2830 ;;;###autoload
2831 (defun dired-show-file-type (file &optional deref-symlinks)
2832 "Print the type of FILE, according to the `file' command.
2833 If you give a prefix to this command, and FILE is a symbolic
2834 link, then the type of the file linked to by FILE is printed
2835 instead."
2836 (interactive (list (dired-get-filename t) current-prefix-arg))
2837 (let (process-file-side-effects)
2838 (with-temp-buffer
2839 (if deref-symlinks
2840 (process-file "file" nil t t "-L" "--" file)
2841 (process-file "file" nil t t "--" file))
2842 (when (bolp)
2843 (backward-delete-char 1))
2844 (message "%s" (buffer-string)))))
2846 (provide 'dired-aux)
2848 ;; Local Variables:
2849 ;; byte-compile-dynamic: t
2850 ;; generated-autoload-file: "dired-loaddefs.el"
2851 ;; End:
2853 ;;; dired-aux.el ends here