1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985-1986, 1992, 1994, 1998, 2000-2016 Free Software
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: emacs-devel@gnu.org
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/>.
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
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.
39 ;; We need macros in dired.el to compile properly,
40 ;; and we call subroutines in it too.
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.")
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]\\|$\\)")
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
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'."
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
94 (and (if (and oldf
(file-readable-p oldf
)) 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))
105 (target-dir (if default
107 (file-name-directory default
)
108 (dired-current-directory))
109 (dired-dwim-target-directory)))
110 (defaults (dired-dwim-target-defaults (list current
) target-dir
)))
112 (minibuffer-with-setup-hook
114 (set (make-local-variable 'minibuffer-default-add-function
) nil
)
115 (setq minibuffer-default defaults
))
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
)
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
))))
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'."
145 (if current-prefix-arg
146 (list (read-string "Options for diff: "
147 (if (stringp diff-switches
)
149 (mapconcat 'identity diff-switches
" "))))
151 (diff-backup (dired-get-filename) switches
))
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."
181 (let* ((target-dir (dired-dwim-target-directory))
182 (defaults (dired-dwim-target-defaults nil target-dir
)))
183 (minibuffer-with-setup-hook
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
201 (dired-file-set-difference
202 file-alist1 file-alist2
206 (dired-file-set-difference
207 file-alist2 file-alist1
209 (dired-fun-in-all-buffers
213 (member (dired-get-filename nil t
) file-list1
) nil
)))
214 (dired-fun-in-all-buffers
218 (member (dired-get-filename nil t
) file-list2
) nil
)))
219 (message "Marked in dir1: %s files, in dir2: %s files"
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
))
234 (dolist (file1 list1
)
235 (unless (let ((list list2
))
237 (let* ((file2 (car list
))
238 (fa1 (car (cddr file1
)))
239 (fa2 (car (cddr file2
))))
241 (not (equal (car file1
) (car file2
)))
245 (size1 .
,(nth 7 fa1
))
246 (size2 .
,(nth 7 fa2
))
248 .
,(float-time (nth 5 fa1
)))
250 .
,(float-time (nth 5 fa2
)))
252 (setq list
(cdr list
)))
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))."
262 (let ((full-file-name (expand-file-name file-name dir
)))
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
)
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
)
293 (new-attribute (dired-mark-read-string prompt nil op-symbol
295 (cond ((eq op-symbol
'chown
)
297 ((eq op-symbol
'chgrp
)
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
))
310 (dired-bunch-files 10000
311 (function dired-check-process
)
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
)
324 (dired-do-redisplay arg
);; moves point if ARG is an integer
327 (format "%s: error" operation
)
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."
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
))))
343 (and (stringp modestr
)
344 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr
)
345 (replace-regexp-in-string
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
))
355 (cond ((or (equal modes
"")
356 ;; Use `eq' instead of `equal'
357 ;; to detect empty input (bug#12399).
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))))
368 (if num-modes num-modes
369 (file-modes-symbolic-to-number modes
(file-modes file
)))))
370 (dired-do-redisplay arg
)))
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."
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
))
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."
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
))
393 (defun dired-do-touch (&optional arg
)
394 "Change the timestamp of the marked (or next ARG) files.
396 Type M-n to pull the file attributes of the file at point
397 into the minibuffer."
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
)
410 ;; Accumulate files as long as they fit in MAX chars,
411 ;; then process the ones accumulated so far.
413 (let* ((thisfile (car files
))
414 (thislength (+ (length thisfile
) 3))
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
))
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
)
430 ;; Do (setq pending (cons thisfile pending))
431 ;; but reuse the cons that was in `files'.
432 (setcdr files pending
)
434 (setq pending-length
(+ thislength pending-length
))
436 (setq pending
(nreverse pending
))
438 (nconc (apply function
(append args pending
))
440 ;; Now the original list FILES has been put back as it was.
441 (nconc past pending
))))
443 (defvar lpr-printer-switch
)
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."
452 (let* ((file-list (dired-get-marked-files t arg
))
454 (if (and (stringp printer-name
)
455 (string< "" printer-name
))
456 (cons (concat lpr-printer-switch printer-name
)
459 (command (dired-mark-read-string
463 (if (stringp lpr-switches
)
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
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
)
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."
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
))
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
)
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.
540 (let (file buffer-read-only
)
541 (goto-char (point-min))
544 (and (not (looking-at-p dired-re-dir
))
546 (setq file
(dired-get-filename nil t
)) ; nil on non-file
548 (funcall fun file
))))
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
566 (file-name-directory fn
)))
567 (versions (mapcar 'backup-extract-version possibilities
)))
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
))
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)
584 (insert dired-del-marker
)))))
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."
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
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
))))
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*'."
640 (let ((files (dired-get-marked-files t current-prefix-arg
)))
642 ;; Want to give feedback whether this file or marked files are used:
643 (dired-read-shell-command "& on %s: " current-prefix-arg files
)
646 (unless (string-match-p "&[ \t]*\\'" command
)
647 (setq command
(concat command
" &")))
648 (dired-do-shell-command command arg file-list
))
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.
701 (let ((files (dired-get-marked-files t current-prefix-arg
)))
703 ;; Want to give feedback whether this file or marked files are used:
704 (dired-read-shell-command "! on %s: " current-prefix-arg 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"))
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? ")))
724 (- 10000 (length command
))
725 (function (lambda (&rest files
)
726 (dired-run-shell-command
727 (dired-shell-stuff-it command files t arg
))))
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))
754 (sequentially (string-match "[ \t]*;[ \t]*\\'" command
))
755 (command (if sequentially
756 (substring command
0 (match-beginning 0))
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
768 (cmd-sep (if (and (not w32-shell
) (not parallel-in-background
))
772 (if (or (string-match-p dired-star-subst-regexp command
)
773 (string-match-p dired-quark-subst-regexp command
))
775 (let ((retval (concat cmd-prefix command
)))
777 "\\(^\\|[ \t]\\)\\([*?]\\)\\([ \t]\\|$\\)" retval
)
778 (setq retval
(replace-match x t t retval
2)))
780 (lambda (x) (concat cmd-prefix command dired-mark-separator x
)))))
784 (mapconcat stuff-it
(mapcar 'shell-quote-argument file-list
)
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
)
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.
807 (defun dired-run-shell-command (command)
809 (find-file-name-handler (directory-file-name default-directory
)
811 (if handler
(apply handler
'shell-command
(list command
))
812 (shell-command command
)))
813 ;; Return nil for sake of nconc in dired-bunch-files.
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
)
827 ;; Get a clean buffer for error output:
828 (setq err-buffer
(get-buffer-create " *dired-check-process output*"))
829 (set-buffer err-buffer
)
831 (setq default-directory dir
; caller's default-directory
832 err
(not (eq 0 (apply 'process-file program nil t nil arguments
))))
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
)
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
)
850 (let* ((default-directory dir
)
859 (pop-to-buffer out-buffer
))
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.)"
869 (setq arg
(prefix-numeric-value arg
))
870 (let (buffer-read-only file
)
872 (setq file
(dired-get-filename nil t
))
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)))
884 (dired-move-to-filename)))
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.
901 (if (dired-get-subdir)
903 (dired-kill-line arg
))
905 (goto-char (point-min))
906 (let (buffer-read-only
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))))
915 (message (or fmt
"Killed %d line%s.") count
(dired-plural-s count
)))
918 ;;;###end dired-cmd.el
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
)))
930 (let ((start (point)))
931 ;; Remove any preexisting entry for the name NEW-FILE.
932 (ignore-errors (dired-remove-entry new-file
))
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
))
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 ("\\.gz\\'" "" "gunzip")
946 ("\\.tgz\\'" ".tar" "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
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.")
991 (defun dired-do-compress-to ()
992 "Compress selected files and directories to an archive.
993 You are prompted for the archive name.
994 The archiving command is chosen based on the archive name extension and
995 `dired-compress-files-alist'."
997 (let* ((in-files (dired-get-marked-files))
998 (out-file (read-file-name "Compress to: "))
1001 (string-match (car x
) out-file
))
1002 dired-compress-files-alist
)))
1005 "No compression rule found for %s, see `dired-compress-files-alist'"
1007 ((and (file-exists-p out-file
)
1009 (format "%s exists, overwrite?"
1010 (abbreviate-file-name out-file
)))))
1011 (message "Compression aborted"))
1014 (dired-shell-command
1015 (replace-regexp-in-string
1017 (replace-regexp-in-string
1018 "%i" (mapconcat #'file-name-nondirectory in-files
" ")
1020 (message "Compressed %d file(s) to %s"
1022 (file-name-nondirectory out-file
)))))))
1025 (defun dired-compress-file (file)
1026 "Compress or uncompress FILE.
1027 Return the name of the compressed or uncompressed file.
1028 Return nil if no change in files."
1029 (let ((handler (find-file-name-handler file
'dired-compress-file
))
1031 (suffixes dired-compress-file-suffixes
)
1033 ;; See if any suffix rule matches this file name.
1035 (let (case-fold-search)
1036 (if (string-match (car (car suffixes
)) file
)
1037 (setq suffix
(car suffixes
) suffixes nil
))
1038 (setq suffixes
(cdr suffixes
))))
1039 ;; If so, compute desired new name.
1041 (setq newname
(concat (substring file
0 (match-beginning 0))
1044 (funcall handler
'dired-compress-file file
))
1045 ((file-symlink-p file
)
1047 ((and suffix
(setq command
(nth 2 suffix
)))
1048 (if (string-match "%[io]" command
)
1049 (prog1 (setq newname
(file-name-as-directory newname
))
1050 (dired-shell-command
1051 (replace-regexp-in-string
1053 (replace-regexp-in-string
1056 ;; We found an uncompression rule.
1058 (dired-check-process
1059 (concat "Uncompressing " file
)
1064 ;; We don't recognize the file as compressed, so compress it.
1065 ;; Try gzip; if we don't have that, use compress.
1067 (if (file-directory-p file
)
1069 (setq suffix
(cdr (assoc ":" dired-compress-file-suffixes
)))
1071 (let ((out-name (concat file
(car suffix
)))
1072 (default-directory (file-name-directory file
)))
1073 (dired-shell-command
1074 (replace-regexp-in-string
1076 (replace-regexp-in-string
1077 "%i" (file-name-nondirectory file
)
1080 (let ((out-name (concat file
".gz")))
1081 (and (or (not (file-exists-p out-name
))
1083 (format "File %s already exists. Really compress? "
1086 (dired-check-process (concat "Compressing " file
)
1088 (or (file-exists-p out-name
)
1089 (setq out-name
(concat file
".z")))
1090 ;; Rename the compressed file to NEWNAME
1091 ;; if it hasn't got that name already.
1092 (if (and newname
(not (equal newname out-name
)))
1094 (rename-file out-name newname t
)
1098 (if (not (dired-check-process (concat "Compressing " file
)
1099 "compress" "-f" file
))
1100 ;; Don't use NEWNAME with `compress'.
1101 (concat file
".Z"))))))))
1103 (defun dired-mark-confirm (op-symbol arg
)
1104 ;; Request confirmation from the user that the operation described
1105 ;; by OP-SYMBOL is to be performed on the marked files.
1106 ;; Confirmation consists in a y-or-n question with a file list
1107 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
1108 ;; The files used are determined by ARG (as in dired-get-marked-files).
1109 (or (eq dired-no-confirm t
)
1110 (memq op-symbol dired-no-confirm
)
1111 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
1112 ;; is marked pops up a window. That will help the user see
1113 ;; it isn't the current line file.
1114 (let ((files (dired-get-marked-files t arg nil t
))
1115 (string (if (eq op-symbol
'compress
) "Compress or uncompress"
1116 (capitalize (symbol-name op-symbol
)))))
1117 (dired-mark-pop-up nil op-symbol files
(function y-or-n-p
)
1119 (dired-mark-prompt arg files
) "? ")))))
1121 (defun dired-map-over-marks-check (fun arg op-symbol
&optional show-progress
)
1122 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
1123 ; and display failures.
1125 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
1126 ; the short form of the filename) for a failure and probably logs a
1127 ; detailed error explanation using function `dired-log'.
1129 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
1130 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
1131 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
1132 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
1134 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
1135 (if (dired-mark-confirm op-symbol arg
)
1136 (let* ((total-list;; all of FUN's return values
1137 (dired-map-over-marks (funcall fun
) arg show-progress
))
1138 (total (length total-list
))
1139 (failures (delq nil total-list
))
1140 (count (length failures
))
1141 (string (if (eq op-symbol
'compress
) "Compress or uncompress"
1142 (capitalize (symbol-name op-symbol
)))))
1144 (message "%s: %d file%s."
1145 string total
(dired-plural-s total
))
1146 ;; end this bunch of errors:
1148 (format "Failed to %s %d of %d file%s"
1149 (downcase string
) count total
(dired-plural-s total
))
1153 (defun dired-query (sym prompt
&rest args
)
1154 "Format PROMPT with ARGS, query user, and store the result in SYM.
1155 The return value is either nil or t.
1157 The user may type y or SPC to accept once; n or DEL to skip once;
1158 ! to accept this and subsequent queries; or q or ESC to decline
1159 this and subsequent queries.
1161 If SYM is already bound to a non-nil value, this function may
1162 return automatically without querying the user. If SYM is !,
1163 return t; if SYM is q or ESC, return nil."
1164 (let* ((char (symbol-value sym
))
1165 (char-choices '(?y ?\s ?n ?
\177 ?
! ?q ?\e
)))
1167 t
) ; accept, and don't ask again
1168 ((memq char
'(?q ?\e
))
1169 nil
) ; skip, and don't ask again
1170 (t ; no previous answer - ask now
1172 (concat (apply #'format-message prompt args
)
1174 (format " [Type yn!q or %s] "
1175 (key-description (vector help-char
)))
1176 " [Type y, n, q or !] ")))
1177 (set sym
(setq char
(read-char-choice prompt char-choices
)))
1178 (if (memq char
'(?y ?\s ?
!)) t
)))))
1182 (defun dired-do-compress (&optional arg
)
1183 "Compress or uncompress marked (or next ARG) files."
1185 (dired-map-over-marks-check (function dired-compress
) arg
'compress t
))
1187 ;; Commands for Emacs Lisp files - load and byte compile
1189 (defun dired-byte-compile ()
1190 ;; Return nil for success, offending file name else.
1191 (let* ((filename (dired-get-filename))
1192 elc-file buffer-read-only failure
)
1194 (save-excursion (byte-compile-file filename
))
1196 (setq failure err
)))
1197 (setq elc-file
(byte-compile-dest-file filename
))
1198 (or (file-exists-p elc-file
)
1202 (dired-log "Byte compile error for %s:\n%s\n" filename failure
)
1203 (dired-make-relative filename
))
1204 (dired-remove-file elc-file
)
1205 (forward-line) ; insert .elc after its .el file
1206 (dired-add-file elc-file
)
1210 (defun dired-do-byte-compile (&optional arg
)
1211 "Byte compile marked (or next ARG) Emacs Lisp files."
1213 (dired-map-over-marks-check (function dired-byte-compile
) arg
'byte-compile t
))
1215 (defun dired-load ()
1216 ;; Return nil for success, offending file name else.
1217 (let ((file (dired-get-filename)) failure
)
1219 (load file nil nil t
)
1220 (error (setq failure err
)))
1223 (dired-log "Load error for %s:\n%s\n" file failure
)
1224 (dired-make-relative file
))))
1227 (defun dired-do-load (&optional arg
)
1228 "Load the marked (or next ARG) Emacs Lisp files."
1230 (dired-map-over-marks-check (function dired-load
) arg
'load t
))
1233 (defun dired-do-redisplay (&optional arg test-for-subdir
)
1234 "Redisplay all marked (or next ARG) files.
1235 If on a subdir line, redisplay that subdirectory. In that case,
1236 a prefix arg lets you edit the `ls' switches used for the new listing.
1238 Dired remembers switches specified with a prefix arg, so that reverting
1239 the buffer will not reset them. However, using `dired-undo' to re-insert
1240 or delete subdirectories can bypass this machinery. Hence, you sometimes
1241 may have to reset some subdirectory switches after a `dired-undo'.
1242 You can reset all subdirectory switches to the default using
1243 \\<dired-mode-map>\\[dired-reset-subdir-switches].
1244 See Info node `(emacs)Subdir switches' for more details."
1245 ;; Moves point if the next ARG files are redisplayed.
1246 (interactive "P\np")
1247 (if (and test-for-subdir
(dired-get-subdir))
1248 (let* ((dir (dired-get-subdir))
1249 (switches (cdr (assoc-string dir dired-switches-alist
))))
1250 (dired-insert-subdir
1253 (read-string "Switches for listing: "
1255 dired-subdir-switches
1256 dired-actual-switches
)))))
1257 (message "Redisplaying...")
1258 ;; message much faster than making dired-map-over-marks show progress
1260 (if (consp dired-directory
) (car dired-directory
) dired-directory
))
1261 (dired-map-over-marks (let ((fname (dired-get-filename))
1262 ;; Postpone readin hook till we map
1263 ;; over all marked files (Bug#6810).
1264 (dired-after-readin-hook nil
))
1265 (message "Redisplaying... %s" fname
)
1266 (dired-update-file-line fname
))
1268 (run-hooks 'dired-after-readin-hook
)
1269 (dired-move-to-filename)
1270 (message "Redisplaying...done")))
1272 (defun dired-reset-subdir-switches ()
1273 "Set `dired-switches-alist' to nil and revert dired buffer."
1275 (setq dired-switches-alist nil
)
1278 (defun dired-update-file-line (file)
1279 ;; Delete the current line, and insert an entry for FILE.
1280 ;; If FILE is nil, then just delete the current line.
1281 ;; Keeps any marks that may be present in column one (doing this
1282 ;; here is faster than with dired-add-entry's optional arg).
1283 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1284 (let* ((opoint (line-beginning-position))
1285 (char (char-after opoint
))
1287 (delete-region opoint
(progn (forward-line 1) (point)))
1290 (dired-add-entry file nil t
)
1291 ;; Replace space by old marker without moving point.
1292 ;; Faster than goto+insdel inside a save-excursion?
1294 (subst-char-in-region opoint
(1+ opoint
) ?
\040 char
)))))
1295 (dired-move-to-filename))
1298 (defun dired-add-file (filename &optional marker-char
)
1299 (dired-fun-in-all-buffers
1300 (file-name-directory filename
) (file-name-nondirectory filename
)
1301 (function dired-add-entry
) filename marker-char
))
1303 (defvar dired-omit-mode
)
1304 (declare-function dired-omit-regexp
"dired-x" ())
1305 (defvar dired-omit-localp
)
1307 (defun dired-add-entry (filename &optional marker-char relative
)
1308 "Add a new dired entry for FILENAME.
1309 Optionally mark it with MARKER-CHAR (a character, else uses
1310 `dired-marker-char'). Note that this adds the entry `out of order'
1311 if files are sorted by time, etc.
1312 Skips files that match `dired-trivial-filenames'.
1313 Exposes hidden subdirectories if a file is added there.
1315 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1316 files matching `dired-omit-regexp'."
1317 (if (or (not (featurep 'dired-x
))
1318 (not dired-omit-mode
)
1319 ;; Avoid calling ls for files that are going to be omitted anyway.
1320 (let ((omit-re (dired-omit-regexp)))
1321 (or (string= omit-re
"")
1322 (not (string-match-p omit-re
1324 ((eq 'no-dir dired-omit-localp
)
1326 ((eq t dired-omit-localp
)
1327 (dired-make-relative filename
))
1329 (dired-make-absolute
1331 (file-name-directory filename
)))))))))
1334 (setq filename
(directory-file-name filename
))
1335 ;; Entry is always for files, even if they happen to also be directories
1336 (let* ((opoint (point))
1337 (cur-dir (dired-current-directory))
1338 (directory (if relative cur-dir
(file-name-directory filename
)))
1342 (file-relative-name filename directory
)
1343 (file-name-nondirectory filename
))
1346 (if (string= directory cur-dir
)
1348 (skip-chars-forward "^\r\n")
1349 (if (eq (following-char) ?
\r)
1350 (dired-unhide-subdir))
1351 ;; We are already where we should be, except when
1352 ;; point is before the subdir line or its total line.
1353 (let ((p (dired-after-subdir-garbage cur-dir
)))
1356 ;; else try to find correct place to insert
1357 (if (dired-goto-subdir directory
)
1358 (progn ;; unhide if necessary
1359 (if (looking-at-p "\r")
1360 ;; Point is at end of subdir line.
1361 (dired-unhide-subdir))
1362 ;; found - skip subdir and `total' line
1363 ;; and uninteresting files like . and ..
1364 ;; This better not move into the next subdir!
1365 (dired-goto-next-nontrivial-file))
1367 (throw 'not-found
"Subdir not found")))
1368 (let (buffer-read-only opoint
)
1370 (setq opoint
(point))
1371 ;; Don't expand `.'.
1372 ;; Show just the file name within directory.
1373 (let ((default-directory directory
))
1374 (dired-insert-directory
1376 (concat dired-actual-switches
" -d")
1379 ;; Put in desired marker char.
1381 (let ((dired-marker-char
1382 (if (integerp marker-char
) marker-char
1383 dired-marker-char
)))
1385 ;; Compensate for a bug in ange-ftp.
1386 ;; It inserts the file's absolute name, rather than
1387 ;; the relative one. That may be hard to fix since it
1388 ;; is probably controlled by something in ftp.
1390 (let ((inserted-name (dired-get-filename 'verbatim
)))
1391 (if (file-name-directory inserted-name
)
1394 (forward-char (- (length inserted-name
)))
1395 (setq props
(text-properties-at (point)))
1396 (delete-char (length inserted-name
))
1399 (set-text-properties pt
(point) props
))
1403 (if dired-after-readin-hook
1404 ;; The subdir-alist is not affected...
1405 (save-excursion ; ...so we can run it right now:
1408 (narrow-to-region (point)
1409 (line-beginning-position 2))
1410 (run-hooks 'dired-after-readin-hook
))))
1411 (dired-move-to-filename))
1412 ;; return nil if all went well
1414 (if reason
; don't move away on failure
1416 (not reason
))) ; return t on success, nil else
1417 ;; Don't do it (dired-omit-mode).
1418 ;; Return t for success (perhaps we should return file-exists-p).
1421 (defun dired-after-subdir-garbage (dir)
1422 ;; Return pos of first file line of DIR, skipping header and total
1423 ;; or wildcard lines.
1424 ;; Important: never moves into the next subdir.
1425 ;; DIR is assumed to be unhidden.
1427 (or (dired-goto-subdir dir
) (error "This cannot happen"))
1429 (while (and (not (eolp)) ; don't cross subdir boundary
1430 (not (dired-move-to-filename)))
1435 (defun dired-remove-file (file)
1436 (dired-fun-in-all-buffers
1437 (file-name-directory file
) (file-name-nondirectory file
)
1438 (function dired-remove-entry
) file
))
1440 (defun dired-remove-entry (file)
1442 (and (dired-goto-file file
)
1443 (let (buffer-read-only)
1444 (delete-region (progn (beginning-of-line) (point))
1445 (line-beginning-position 2))))))
1448 (defun dired-relist-file (file)
1449 "Create or update the line for FILE in all Dired buffers it would belong in."
1450 (dired-fun-in-all-buffers (file-name-directory file
)
1451 (file-name-nondirectory file
)
1452 (function dired-relist-entry
) file
))
1454 (defun dired-relist-entry (file)
1455 ;; Relist the line for FILE, or just add it if it did not exist.
1456 ;; FILE must be an absolute file name.
1457 (let (buffer-read-only marker
)
1458 ;; If cursor is already on FILE's line delete-region will cause
1459 ;; save-excursion to fail because of floating makers,
1460 ;; moving point to beginning of line. Sigh.
1462 (and (dired-goto-file file
)
1463 (delete-region (progn (beginning-of-line)
1464 (setq marker
(following-char))
1466 (line-beginning-position 2)))
1467 (setq file
(directory-file-name file
))
1468 (dired-add-entry file
(if (eq ?
\040 marker
) nil marker
)))))
1470 ;;; Copy, move/rename, making hard and symbolic links
1472 (defcustom dired-backup-overwrite nil
1473 "Non-nil if Dired should ask about making backups before overwriting files.
1474 Special value `always' suppresses confirmation."
1475 :type
'(choice (const :tag
"off" nil
)
1476 (const :tag
"suppress" always
)
1477 (other :tag
"ask" t
))
1480 ;; This is a fluid var used in dired-handle-overwrite. It should be
1481 ;; let-bound whenever dired-copy-file etc are called. See
1482 ;; dired-create-files for an example.
1483 (defvar dired-overwrite-confirmed
)
1485 (defun dired-handle-overwrite (to)
1486 ;; Save old version of file TO that is to be overwritten.
1487 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1488 ;; from dired-create-files.
1490 (when (and dired-backup-overwrite
1491 dired-overwrite-confirmed
1492 (setq backup
(car (find-backup-file-name to
)))
1493 (or (eq 'always dired-backup-overwrite
)
1494 (dired-query 'overwrite-backup-query
1495 "Make backup for existing file `%s'? "
1497 (rename-file to backup
0) ; confirm overwrite of old backup
1498 (dired-relist-entry backup
))))
1501 (defun dired-copy-file (from to ok-flag
)
1502 (dired-handle-overwrite to
)
1503 (dired-copy-file-recursive from to ok-flag dired-copy-preserve-time t
1504 dired-recursive-copies
))
1506 (declare-function make-symbolic-link
"fileio.c")
1508 (defun dired-copy-file-recursive (from to ok-flag
&optional
1509 preserve-time top recursive
)
1510 (when (and (eq t
(car (file-attributes from
)))
1511 (file-in-directory-p to from
))
1512 (error "Cannot copy `%s' into its subdirectory `%s'" from to
))
1513 (let ((attrs (file-attributes from
)))
1516 (or (eq recursive
'always
)
1517 (yes-or-no-p (format "Recursive copies of %s? " from
))))
1518 (copy-directory from to preserve-time
)
1519 (or top
(dired-handle-overwrite to
))
1521 (if (stringp (car attrs
))
1523 (make-symbolic-link (car attrs
) to ok-flag
)
1524 (copy-file from to ok-flag preserve-time
))
1526 (push (dired-make-relative from
)
1527 dired-create-files-failures
)
1528 (dired-log "Can't set date on %s:\n%s\n" from err
))))))
1531 (defun dired-rename-file (file newname ok-if-already-exists
)
1532 (dired-handle-overwrite newname
)
1533 (rename-file file newname ok-if-already-exists
) ; error is caught in -create-files
1534 ;; Silently rename the visited file of any buffer visiting this file.
1535 (and (get-file-buffer file
)
1536 (with-current-buffer (get-file-buffer file
)
1537 (set-visited-file-name newname nil t
)))
1538 (dired-remove-file file
)
1539 ;; See if it's an inserted subdir, and rename that, too.
1540 (dired-rename-subdir file newname
))
1542 (defun dired-rename-subdir (from-dir to-dir
)
1543 (setq from-dir
(file-name-as-directory from-dir
)
1544 to-dir
(file-name-as-directory to-dir
))
1545 (dired-fun-in-all-buffers from-dir nil
1546 (function dired-rename-subdir-1
) from-dir to-dir
)
1547 ;; Update visited file name of all affected buffers
1548 (let ((expanded-from-dir (expand-file-name from-dir
))
1549 (blist (buffer-list)))
1551 (with-current-buffer (car blist
)
1552 (if (and buffer-file-name
1553 (dired-in-this-tree buffer-file-name expanded-from-dir
))
1554 (let ((modflag (buffer-modified-p))
1555 (to-file (dired-replace-in-string
1556 (concat "^" (regexp-quote from-dir
))
1559 (set-visited-file-name to-file
)
1560 (set-buffer-modified-p modflag
))))
1561 (setq blist
(cdr blist
)))))
1563 (defun dired-rename-subdir-1 (dir to
)
1564 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1565 ;; one of its subdirectories is expanded in this buffer.
1566 (let ((expanded-dir (expand-file-name dir
))
1567 (alist dired-subdir-alist
)
1570 (setq elt
(car alist
)
1572 (if (dired-in-this-tree (car elt
) expanded-dir
)
1573 ;; ELT's subdir is affected by the rename
1574 (dired-rename-subdir-2 elt dir to
)))
1575 (if (equal dir default-directory
)
1576 ;; if top level directory was renamed, lots of things have to be
1579 (dired-unadvertise dir
) ; we no longer dired DIR...
1580 (setq default-directory to
1581 dired-directory
(expand-file-name;; this is correct
1582 ;; with and without wildcards
1583 (file-name-nondirectory dired-directory
)
1585 (let ((new-name (file-name-nondirectory
1586 (directory-file-name dired-directory
))))
1587 ;; try to rename buffer, but just leave old name if new
1588 ;; name would already exist (don't try appending "<%d>")
1589 (or (get-buffer new-name
)
1590 (rename-buffer new-name
)))
1591 ;; ... we dired TO now:
1592 (dired-advertise)))))
1594 (defun dired-rename-subdir-2 (elt dir to
)
1595 ;; Update the headerline and dired-subdir-alist element, as well as
1596 ;; dired-switches-alist element, of directory described by
1597 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1598 ;; describes either DIR itself or a subdir of DIR.
1600 (let ((regexp (regexp-quote (directory-file-name dir
)))
1601 (newtext (directory-file-name to
))
1603 (goto-char (dired-get-subdir-min elt
))
1604 ;; Update subdir headerline in buffer
1605 (if (not (looking-at dired-subdir-regexp
))
1606 (error "%s not found where expected - dired-subdir-alist broken?"
1608 (goto-char (match-beginning 1))
1609 (if (re-search-forward regexp
(match-end 1) t
)
1610 (replace-match newtext t t
)
1611 (error "Expected to find `%s' in headerline of %s" dir
(car elt
))))
1612 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1613 (let ((cons (assoc-string (car elt
) dired-switches-alist
))
1614 (cur-dir (dired-normalize-subdir
1615 (dired-replace-in-string regexp newtext
(car elt
)))))
1616 (setcar elt cur-dir
)
1617 (when cons
(setcar cons cur-dir
))))))
1619 ;; Bound in dired-create-files
1620 (defvar overwrite-query
)
1621 (defvar overwrite-backup-query
)
1623 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1624 (defun dired-create-files (file-creator operation fn-list name-constructor
1625 &optional marker-char
)
1626 "Create one or more new files from a list of existing files FN-LIST.
1627 This function also handles querying the user, updating Dired
1628 buffers, and displaying a success or failure message.
1630 FILE-CREATOR should be a function. It is called once for each
1631 file in FN-LIST, and must create a new file, querying the user
1632 and updating Dired buffers as necessary. It should accept three
1633 arguments: the old file name, the new name, and an argument
1634 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1636 OPERATION should be a capitalized string describing the operation
1637 performed (e.g. `Copy'). It is used for error logging.
1639 FN-LIST is the list of files to copy (full absolute file names).
1641 NAME-CONSTRUCTOR should be a function accepting a single
1642 argument, the name of an old file, and returning either the
1643 corresponding new file name or nil to skip.
1645 If optional argument MARKER-CHAR is non-nil, mark each
1646 newly-created file's Dired entry with the character MARKER-CHAR,
1647 or with the current marker character if MARKER-CHAR is t."
1648 (let (dired-create-files-failures failures
1649 skipped
(success-count 0) (total (length fn-list
)))
1650 (let (to overwrite-query
1651 overwrite-backup-query
) ; for dired-handle-overwrite
1652 (dolist (from fn-list
)
1653 (setq to
(funcall name-constructor from
))
1657 (dired-log "Cannot %s to same file: %s\n"
1658 (downcase operation
) from
)))
1660 (setq skipped
(cons (dired-make-relative from
) skipped
))
1661 (let* ((overwrite (file-exists-p to
))
1662 (dired-overwrite-confirmed ; for dired-handle-overwrite
1664 (let ((help-form '(format-message "\
1665 Type SPC or `y' to overwrite file `%s',
1666 DEL or `n' to skip to next,
1667 ESC or `q' to not overwrite any of the remaining files,
1668 `!' to overwrite all remaining files with no more questions." to
)))
1669 (dired-query 'overwrite-query
1670 "Overwrite `%s'?" to
))))
1671 ;; must determine if FROM is marked before file-creator
1672 ;; gets a chance to delete it (in case of a move).
1674 (cond ((integerp marker-char
) marker-char
)
1675 (marker-char (dired-file-marker from
)) ; slow
1677 ;; Handle the `dired-copy-file' file-creator specially
1678 ;; When copying a directory to another directory or
1679 ;; possibly to itself or one of its subdirectories.
1680 ;; e.g "~/foo/" => "~/test/"
1681 ;; or "~/foo/" =>"~/foo/"
1682 ;; or "~/foo/ => ~/foo/bar/")
1683 ;; In this case the 'name-constructor' have set the destination
1684 ;; TO to "~/test/foo" because the old emacs23 behavior
1685 ;; of `copy-directory' was to not create the subdirectory
1686 ;; and instead copy the contents.
1687 ;; With the new behavior of `copy-directory'
1688 ;; (similar to the `cp' shell command) we don't
1689 ;; need such a construction of the target directory,
1690 ;; so modify the destination TO to "~/test/" instead of "~/test/foo/".
1691 (let ((destname (file-name-directory to
)))
1692 (when (and (file-directory-p from
)
1693 (file-directory-p to
)
1694 (eq file-creator
'dired-copy-file
))
1696 ;; If DESTNAME is a subdirectory of FROM, not a symlink,
1697 ;; and the method in use is copying, signal an error.
1698 (and (eq t
(car (file-attributes destname
)))
1699 (eq file-creator
'dired-copy-file
)
1700 (file-in-directory-p destname from
)
1701 (error "Cannot copy `%s' into its subdirectory `%s'"
1705 (funcall file-creator from to dired-overwrite-confirmed
)
1707 ;; If we get here, file-creator hasn't been aborted
1708 ;; and the old entry (if any) has to be deleted
1709 ;; before adding the new entry.
1710 (dired-remove-file to
))
1711 (setq success-count
(1+ success-count
))
1712 (message "%s: %d of %d" operation success-count total
)
1713 (dired-add-file to actual-marker-char
))
1714 (file-error ; FILE-CREATOR aborted
1716 (push (dired-make-relative from
)
1718 (dired-log "%s `%s' to `%s' failed:\n%s\n"
1719 operation from to err
))))))))
1721 (dired-create-files-failures
1722 (setq failures
(nconc failures dired-create-files-failures
))
1724 (format "%s failed for %d file%s in %d requests"
1725 operation
(length failures
)
1726 (dired-plural-s (length failures
))
1731 (format "%s failed for %d of %d file%s"
1732 operation
(length failures
)
1733 total
(dired-plural-s total
))
1737 (format "%s: %d of %d file%s skipped"
1738 operation
(length skipped
) total
1739 (dired-plural-s total
))
1742 (message "%s: %s file%s"
1743 operation success-count
(dired-plural-s success-count
)))))
1744 (dired-move-to-filename))
1746 (defun dired-do-create-files (op-symbol file-creator operation arg
1747 &optional marker-char op1
1749 "Create a new file for each marked file.
1750 Prompt user for a target directory in which to create the new
1751 files. The target may also be a non-directory file, if only
1752 one file is marked. The initial suggestion for target is the
1753 Dired buffer's current directory (or, if `dired-dwim-target' is
1754 non-nil, the current directory of a neighboring Dired window).
1755 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1756 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1757 FILE-CREATOR and OPERATION as in `dired-create-files'.
1758 ARG as in `dired-get-marked-files'.
1759 Optional arg MARKER-CHAR as in `dired-create-files'.
1760 Optional arg OP1 is an alternate form for OPERATION if there is
1762 Optional arg HOW-TO determines how to treat the target.
1763 If HOW-TO is nil, use `file-directory-p' to determine if the
1764 target is a directory. If so, the marked file(s) are created
1765 inside that directory. Otherwise, the target is a plain file;
1766 an error is raised unless there is exactly one marked file.
1767 If HOW-TO is t, target is always treated as a plain file.
1768 Otherwise, HOW-TO should be a function of one argument, TARGET.
1769 If its return value is nil, TARGET is regarded as a plain file.
1770 If it return value is a list, TARGET is a generalized
1771 directory (e.g. some sort of archive). The first element of
1772 this list must be a function with at least four arguments:
1773 operation - as OPERATION above.
1774 rfn-list - list of the relative names for the marked files.
1775 fn-list - list of the absolute names for the marked files.
1776 target - the name of the target itself.
1777 The rest of into-dir are optional arguments.
1778 For any other return value, TARGET is treated as a directory."
1779 (or op1
(setq op1 operation
))
1780 (let* ((fn-list (dired-get-marked-files nil arg
))
1781 (rfn-list (mapcar (function dired-make-relative
) fn-list
))
1782 (dired-one-file ; fluid variable inside dired-create-files
1783 (and (consp fn-list
) (null (cdr fn-list
)) (car fn-list
)))
1784 (target-dir (dired-dwim-target-directory))
1785 (default (and dired-one-file
1786 (expand-file-name (file-name-nondirectory (car fn-list
))
1788 (defaults (dired-dwim-target-defaults fn-list target-dir
))
1789 (target (expand-file-name ; fluid variable inside dired-create-files
1790 (minibuffer-with-setup-hook
1792 (set (make-local-variable 'minibuffer-default-add-function
) nil
)
1793 (setq minibuffer-default defaults
))
1794 (dired-mark-read-file-name
1795 (concat (if dired-one-file op1 operation
) " %s to: ")
1796 target-dir op-symbol arg rfn-list default
))))
1797 (into-dir (cond ((null how-to
)
1798 ;; Allow DOS/Windows users to change the letter
1799 ;; case of a directory. If we don't test these
1800 ;; conditions up front, file-directory-p below
1801 ;; will return t because the filesystem is
1802 ;; case-insensitive, and Emacs will try to move
1803 ;; foo -> foo/foo, which fails.
1804 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
1805 (eq op-symbol
'move
)
1808 (expand-file-name (car fn-list
)))
1810 (expand-file-name target
)))
1812 (file-name-nondirectory (car fn-list
))
1813 (file-name-nondirectory target
))))
1815 (file-directory-p target
)))
1817 (t (funcall how-to target
)))))
1818 (if (and (consp into-dir
) (functionp (car into-dir
)))
1819 (apply (car into-dir
) operation rfn-list fn-list target
(cdr into-dir
))
1820 (if (not (or dired-one-file into-dir
))
1821 (error "Marked %s: target must be a directory: %s" operation target
))
1822 ;; rename-file bombs when moving directories unless we do this:
1823 (or into-dir
(setq target
(directory-file-name target
)))
1825 file-creator operation fn-list
1826 (if into-dir
; target is a directory
1827 ;; This function uses fluid variable target when called
1828 ;; inside dired-create-files:
1831 (expand-file-name (file-name-nondirectory from
) target
)))
1832 (function (lambda (_from) target
)))
1835 ;; Read arguments for a marked-files command that wants a file name,
1836 ;; perhaps popping up the list of marked files.
1837 ;; ARG is the prefix arg and indicates whether the files came from
1838 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1839 ;; If the current file was used, the list has but one element and ARG
1840 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1841 ;; DEFAULT is the default value to return if the user just hits RET;
1842 ;; if it is omitted or nil, then the name of the directory is used.
1844 (defun dired-mark-read-file-name (prompt dir op-symbol arg files
1848 (function read-file-name
)
1849 (format prompt
(dired-mark-prompt arg files
)) dir default
))
1851 (defun dired-dwim-target-directory ()
1852 ;; Try to guess which target directory the user may want.
1853 ;; If there is a dired buffer displayed in one of the next windows,
1854 ;; use its current subdir, else use current subdir of this dired buffer.
1855 (let ((this-dir (and (eq major-mode
'dired-mode
)
1856 (dired-current-directory))))
1857 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1858 (if dired-dwim-target
1859 (let* ((other-win (get-window-with-predicate
1861 (with-current-buffer (window-buffer window
)
1862 (eq major-mode
'dired-mode
)))))
1863 (other-dir (and other-win
1864 (with-current-buffer (window-buffer other-win
)
1865 (and (eq major-mode
'dired-mode
)
1866 (dired-current-directory))))))
1867 (or other-dir this-dir
))
1870 (defun dired-dwim-target-defaults (fn-list target-dir
)
1871 ;; Return a list of default values for file-reading functions in Dired.
1872 ;; This list may contain directories from Dired buffers in other windows.
1873 ;; `fn-list' is a list of file names used to build a list of defaults.
1874 ;; When nil or more than one element, a list of defaults will
1875 ;; contain only directory names. `target-dir' is a directory name
1876 ;; to exclude from the returned list, for the case when this
1877 ;; directory name is already presented in initial input.
1878 ;; For Dired operations that support `dired-dwim-target',
1879 ;; the argument `target-dir' should have the value returned
1880 ;; from `dired-dwim-target-directory'.
1881 (let ((dired-one-file
1882 (and (consp fn-list
) (null (cdr fn-list
)) (car fn-list
)))
1883 (current-dir (and (eq major-mode
'dired-mode
)
1884 (dired-current-directory)))
1886 ;; Get a list of directories of visible buffers in dired-mode.
1887 (walk-windows (lambda (w)
1888 (with-current-buffer (window-buffer w
)
1889 (and (eq major-mode
'dired-mode
)
1890 (push (dired-current-directory) dired-dirs
)))))
1891 ;; Force the current dir to be the first in the list.
1893 (delete-dups (delq nil
(cons current-dir
(nreverse dired-dirs
)))))
1894 ;; Remove the target dir (if specified) or the current dir from
1895 ;; default values, because it should be already in initial input.
1896 (setq dired-dirs
(delete (or target-dir current-dir
) dired-dirs
))
1897 ;; Return a list of default values.
1899 ;; For one file operation, provide a list that contains
1900 ;; other directories, other directories with the appended filename
1901 ;; and the current directory with the appended filename, e.g.
1903 ;; 2. /TARGET-DIR/FILENAME
1904 ;; 3. /CURRENT-DIR/FILENAME
1906 (mapcar (lambda (dir)
1908 (file-name-nondirectory (car fn-list
)) dir
))
1909 (reverse dired-dirs
))
1910 (list (expand-file-name
1911 (file-name-nondirectory (car fn-list
))
1912 (or target-dir current-dir
))))
1913 ;; For multi-file operation, return only a list of other directories.
1918 (defun dired-create-directory (directory)
1919 "Create a directory called DIRECTORY.
1920 If DIRECTORY already exists, signal an error."
1922 (list (read-file-name "Create directory: " (dired-current-directory))))
1923 (let* ((expanded (directory-file-name (expand-file-name directory
)))
1925 (if (file-exists-p expanded
)
1926 (error "Cannot create directory %s: file exists" expanded
))
1927 ;; Find the topmost nonexistent parent dir (variable `new')
1928 (while (and try
(not (file-exists-p try
)) (not (equal new try
)))
1930 try
(directory-file-name (file-name-directory try
))))
1931 (make-directory expanded t
)
1933 (dired-add-file new
)
1934 (dired-move-to-filename))))
1936 (defun dired-into-dir-with-symlinks (target)
1937 (and (file-directory-p target
)
1938 (not (file-symlink-p target
))))
1939 ;; This may not always be what you want, especially if target is your
1940 ;; home directory and it happens to be a symbolic link, as is often the
1941 ;; case with NFS and automounters. Or if you want to make symlinks
1942 ;; into directories that themselves are only symlinks, also quite
1945 ;; So we don't use this function as value for HOW-TO in
1946 ;; dired-do-symlink, which has the minor disadvantage of
1947 ;; making links *into* a symlinked-dir, when you really wanted to
1948 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1949 ;; just have to remove that symlink by hand before making your marked
1952 (defvar dired-copy-how-to-fn nil
1953 "Either nil or a function used by `dired-do-copy' to determine target.
1954 See HOW-TO argument for `dired-do-create-files'.")
1957 (defun dired-do-copy (&optional arg
)
1958 "Copy all marked (or next ARG) files, or copy the current file.
1959 When operating on just the current file, prompt for the new name.
1961 When operating on multiple or marked files, prompt for a target
1962 directory, and make the new copies in that directory, with the
1963 same names as the original files. The initial suggestion for the
1964 target directory is the Dired buffer's current directory (or, if
1965 `dired-dwim-target' is non-nil, the current directory of a
1966 neighboring Dired window).
1968 If `dired-copy-preserve-time' is non-nil, this command preserves
1969 the modification time of each old file in the copy, similar to
1970 the \"-p\" option for the \"cp\" shell command.
1972 This command copies symbolic links by creating new ones, similar
1973 to the \"-d\" option for the \"cp\" shell command."
1975 (let ((dired-recursive-copies dired-recursive-copies
))
1976 (dired-do-create-files 'copy
(function dired-copy-file
)
1978 arg dired-keep-marker-copy
1979 nil dired-copy-how-to-fn
)))
1982 (defun dired-do-symlink (&optional arg
)
1983 "Make symbolic links to current file or all marked (or next ARG) files.
1984 When operating on just the current file, you specify the new name.
1985 When operating on multiple or marked files, you specify a directory
1986 and new symbolic links are made in that directory
1987 with the same names that the files currently have. The default
1988 suggested for the target directory depends on the value of
1989 `dired-dwim-target', which see.
1991 For relative symlinks, use \\[dired-do-relsymlink]."
1993 (dired-do-create-files 'symlink
(function make-symbolic-link
)
1994 "Symlink" arg dired-keep-marker-symlink
))
1997 (defun dired-do-hardlink (&optional arg
)
1998 "Add names (hard links) current file or all marked (or next ARG) files.
1999 When operating on just the current file, you specify the new name.
2000 When operating on multiple or marked files, you specify a directory
2001 and new hard links are made in that directory
2002 with the same names that the files currently have. The default
2003 suggested for the target directory depends on the value of
2004 `dired-dwim-target', which see."
2006 (dired-do-create-files 'hardlink
(function dired-hardlink
)
2007 "Hardlink" arg dired-keep-marker-hardlink
))
2009 (defun dired-hardlink (file newname
&optional ok-if-already-exists
)
2010 (dired-handle-overwrite newname
)
2011 ;; error is caught in -create-files
2012 (add-name-to-file file newname ok-if-already-exists
)
2013 ;; Update the link count
2014 (dired-relist-file file
))
2017 (defun dired-do-rename (&optional arg
)
2018 "Rename current file or all marked (or next ARG) files.
2019 When renaming just the current file, you specify the new name.
2020 When renaming multiple or marked files, you specify a directory.
2021 This command also renames any buffers that are visiting the files.
2022 The default suggested for the target directory depends on the value
2023 of `dired-dwim-target', which see."
2025 (dired-do-create-files 'move
(function dired-rename-file
)
2026 "Move" arg dired-keep-marker-rename
"Rename"))
2027 ;;;###end dired-cp.el
2030 ;;;###begin dired-re.el
2031 (defvar rename-regexp-query
)
2033 (defun dired-do-create-files-regexp
2034 (file-creator operation arg regexp newname
&optional whole-name marker-char
)
2035 ;; Create a new file for each marked file using regexps.
2036 ;; FILE-CREATOR and OPERATION as in dired-create-files.
2037 ;; ARG as in dired-get-marked-files.
2038 ;; Matches each marked file against REGEXP and constructs the new
2039 ;; filename from NEWNAME (like in function replace-match).
2040 ;; Optional arg WHOLE-NAME means match/replace the whole file name
2041 ;; instead of only the non-directory part of the file.
2042 ;; Optional arg MARKER-CHAR as in dired-create-files.
2043 (let* ((fn-list (dired-get-marked-files nil arg
))
2044 (operation-prompt (concat operation
" `%s' to `%s'?"))
2045 (rename-regexp-help-form (format-message "\
2046 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
2047 `!' to %s all remaining matches with no more questions."
2048 (downcase operation
)
2049 (downcase operation
)))
2050 (regexp-name-constructor
2051 ;; Function to construct new filename using REGEXP and NEWNAME:
2052 (if whole-name
; easy (but rare) case
2055 (let ((to (dired-string-replace-match regexp from newname
))
2056 ;; must bind help-form directly around call to
2058 (help-form rename-regexp-help-form
))
2060 (and (dired-query 'rename-regexp-query
2065 (dired-log "%s: %s did not match regexp %s\n"
2066 operation from regexp
)))))
2067 ;; not whole-name, replace non-directory part only
2070 (let* ((new (dired-string-replace-match
2071 regexp
(file-name-nondirectory from
) newname
))
2072 (to (and new
; nil means there was no match
2073 (expand-file-name new
2074 (file-name-directory from
))))
2075 (help-form rename-regexp-help-form
))
2077 (and (dired-query 'rename-regexp-query
2079 (dired-make-relative from
)
2080 (dired-make-relative to
))
2082 (dired-log "%s: %s did not match regexp %s\n"
2083 operation
(file-name-nondirectory from
) regexp
)))))))
2084 rename-regexp-query
)
2086 file-creator operation fn-list regexp-name-constructor marker-char
)))
2088 (defun dired-mark-read-regexp (operation)
2089 ;; Prompt user about performing OPERATION.
2090 ;; Read and return list of: regexp newname arg whole-name.
2092 (equal 0 (prefix-numeric-value current-prefix-arg
)))
2094 (if whole-name nil current-prefix-arg
))
2097 (concat (if whole-name
"Abs. " "") operation
" from (regexp): ")
2098 nil
'dired-regexp-history
))
2101 (concat (if whole-name
"Abs. " "") operation
" " regexp
" to: "))))
2102 (list regexp newname arg whole-name
)))
2105 (defun dired-do-rename-regexp (regexp newname
&optional arg whole-name
)
2106 "Rename selected files whose names match REGEXP to NEWNAME.
2108 With non-zero prefix argument ARG, the command operates on the next ARG
2109 files. Otherwise, it operates on all the marked files, or the current
2110 file if none are marked.
2112 As each match is found, the user must type a character saying
2113 what to do with it. For directions, type \\[help-command] at that time.
2114 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2115 REGEXP defaults to the last regexp used.
2117 With a zero prefix arg, renaming by regexp affects the absolute file name.
2118 Normally, only the non-directory part of the file name is used and changed."
2119 (interactive (dired-mark-read-regexp "Rename"))
2120 (dired-do-create-files-regexp
2121 (function dired-rename-file
)
2122 "Rename" arg regexp newname whole-name dired-keep-marker-rename
))
2125 (defun dired-do-copy-regexp (regexp newname
&optional arg whole-name
)
2126 "Copy selected files whose names match REGEXP to NEWNAME.
2127 See function `dired-do-rename-regexp' for more info."
2128 (interactive (dired-mark-read-regexp "Copy"))
2129 (let ((dired-recursive-copies nil
)) ; No recursive copies.
2130 (dired-do-create-files-regexp
2131 (function dired-copy-file
)
2132 (if dired-copy-preserve-time
"Copy [-p]" "Copy")
2133 arg regexp newname whole-name dired-keep-marker-copy
)))
2136 (defun dired-do-hardlink-regexp (regexp newname
&optional arg whole-name
)
2137 "Hardlink selected files whose names match REGEXP to NEWNAME.
2138 See function `dired-do-rename-regexp' for more info."
2139 (interactive (dired-mark-read-regexp "HardLink"))
2140 (dired-do-create-files-regexp
2141 (function add-name-to-file
)
2142 "HardLink" arg regexp newname whole-name dired-keep-marker-hardlink
))
2145 (defun dired-do-symlink-regexp (regexp newname
&optional arg whole-name
)
2146 "Symlink selected files whose names match REGEXP to NEWNAME.
2147 See function `dired-do-rename-regexp' for more info."
2148 (interactive (dired-mark-read-regexp "SymLink"))
2149 (dired-do-create-files-regexp
2150 (function make-symbolic-link
)
2151 "SymLink" arg regexp newname whole-name dired-keep-marker-symlink
))
2153 (defvar rename-non-directory-query
)
2155 (defun dired-create-files-non-directory
2156 (file-creator basename-constructor operation arg
)
2157 ;; Perform FILE-CREATOR on the non-directory part of marked files
2158 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
2159 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
2160 (let (rename-non-directory-query)
2164 (dired-get-marked-files nil arg
)
2167 (let ((to (concat (file-name-directory from
)
2168 (funcall basename-constructor
2169 (file-name-nondirectory from
)))))
2170 (and (let ((help-form (format-message "\
2171 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
2172 `!' to %s all remaining matches with no more questions."
2173 (downcase operation
)
2174 (downcase operation
))))
2175 (dired-query 'rename-non-directory-query
2176 (concat operation
" `%s' to `%s'")
2177 (dired-make-relative from
)
2178 (dired-make-relative to
)))
2180 dired-keep-marker-rename
)))
2182 (defun dired-rename-non-directory (basename-constructor operation arg
)
2183 (dired-create-files-non-directory
2184 (function dired-rename-file
)
2185 basename-constructor operation arg
))
2188 (defun dired-upcase (&optional arg
)
2189 "Rename all marked (or next ARG) files to upper case."
2191 (dired-rename-non-directory (function upcase
) "Rename upcase" arg
))
2194 (defun dired-downcase (&optional arg
)
2195 "Rename all marked (or next ARG) files to lower case."
2197 (dired-rename-non-directory (function downcase
) "Rename downcase" arg
))
2199 ;;;###end dired-re.el
2202 ;;;###begin dired-ins.el
2205 (defun dired-maybe-insert-subdir (dirname &optional
2206 switches no-error-if-not-dir-p
)
2207 "Insert this subdirectory into the same dired buffer.
2208 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2209 else inserts it at its natural place (as `ls -lR' would have done).
2210 With a prefix arg, you may edit the ls switches used for this listing.
2211 You can add `R' to the switches to expand the whole tree starting at
2213 This function takes some pains to conform to `ls -lR' output.
2215 Dired remembers switches specified with a prefix arg, so that reverting
2216 the buffer will not reset them. However, using `dired-undo' to re-insert
2217 or delete subdirectories can bypass this machinery. Hence, you sometimes
2218 may have to reset some subdirectory switches after a `dired-undo'.
2219 You can reset all subdirectory switches to the default using
2220 \\<dired-mode-map>\\[dired-reset-subdir-switches].
2221 See Info node `(emacs)Subdir switches' for more details."
2223 (list (dired-get-filename)
2224 (if current-prefix-arg
2225 (read-string "Switches for listing: "
2226 (or dired-subdir-switches dired-actual-switches
)))))
2227 (let ((opoint (point)))
2228 ;; We don't need a marker for opoint as the subdir is always
2229 ;; inserted *after* opoint.
2230 (setq dirname
(file-name-as-directory dirname
))
2231 (or (and (not switches
)
2232 (when (dired-goto-subdir dirname
)
2233 (unless (dired-subdir-hidden-p dirname
)
2234 (dired-initial-position dirname
))
2236 (dired-insert-subdir dirname switches no-error-if-not-dir-p
))
2237 ;; Push mark so that it's easy to find back. Do this after the
2238 ;; insert message so that the user sees the `Mark set' message.
2239 (push-mark opoint
)))
2242 (defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p
)
2243 "Insert this subdirectory into the same Dired buffer.
2244 If it is already present, overwrite the previous entry;
2245 otherwise, insert it at its natural place (as `ls -lR' would
2247 With a prefix arg, you may edit the `ls' switches used for this listing.
2248 You can add `R' to the switches to expand the whole tree starting at
2250 This function takes some pains to conform to `ls -lR' output."
2251 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
2252 ;; Prospero where dired-ls does the right thing, but
2253 ;; file-directory-p has not been redefined.
2255 (list (dired-get-filename)
2256 (if current-prefix-arg
2257 (read-string "Switches for listing: "
2258 (or dired-subdir-switches dired-actual-switches
)))))
2259 (setq dirname
(file-name-as-directory (expand-file-name dirname
)))
2260 (or no-error-if-not-dir-p
2261 (file-directory-p dirname
)
2262 (error "Attempt to insert a non-directory: %s" dirname
))
2263 (let ((elt (assoc dirname dired-subdir-alist
))
2264 (cons (assoc-string dirname dired-switches-alist
))
2265 (modflag (buffer-modified-p))
2266 (old-switches switches
)
2267 switches-have-R mark-alist case-fold-search buffer-read-only
)
2268 (and (not switches
) cons
(setq switches
(cdr cons
)))
2269 (dired-insert-subdir-validate dirname switches
)
2270 ;; case-fold-search is nil now, so we can test for capital `R':
2271 (if (setq switches-have-R
(and switches
(string-match-p "R" switches
)))
2272 ;; avoid duplicated subdirs
2273 (setq mark-alist
(dired-kill-tree dirname t
)))
2275 ;; If subdir is already present, remove it and remember its marks
2276 (setq mark-alist
(nconc (dired-insert-subdir-del elt
) mark-alist
))
2277 (dired-insert-subdir-newpos dirname
)) ; else compute new position
2278 (dired-insert-subdir-doupdate
2279 dirname elt
(dired-insert-subdir-doinsert dirname switches
))
2282 (setcdr cons switches
)
2283 (push (cons dirname switches
) dired-switches-alist
)))
2284 (when switches-have-R
2285 (dired-build-subdir-alist switches
)
2286 (setq switches
(dired-replace-in-string "R" "" switches
))
2287 (dolist (cur-ass dired-subdir-alist
)
2288 (let ((cur-dir (car cur-ass
)))
2289 (and (dired-in-this-tree cur-dir dirname
)
2290 (let ((cur-cons (assoc-string cur-dir dired-switches-alist
)))
2292 (setcdr cur-cons switches
)
2293 (push (cons cur-dir switches
) dired-switches-alist
)))))))
2294 (dired-initial-position dirname
)
2295 (save-excursion (dired-mark-remembered mark-alist
))
2296 (restore-buffer-modified-p modflag
)))
2298 (defun dired-insert-subdir-validate (dirname &optional switches
)
2299 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2300 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2301 (or (dired-in-this-tree dirname
(expand-file-name default-directory
))
2302 (error "%s: not in this directory tree" dirname
))
2303 (let ((real-switches (or switches dired-subdir-switches
)))
2305 (let (case-fold-search)
2309 (or (eq (null (string-match-p x real-switches
))
2310 (null (string-match-p x dired-actual-switches
)))
2312 "Can't have dirs with and without -%s switches together" x
))))
2313 ;; all switches that make a difference to dired-get-filename:
2316 (defun dired-alist-add (dir new-marker
)
2317 ;; Add new DIR at NEW-MARKER. Sort alist.
2318 (dired-alist-add-1 dir new-marker
)
2321 (defun dired-alist-sort ()
2322 ;; Keep the alist sorted on buffer position.
2323 (setq dired-subdir-alist
2324 (sort dired-subdir-alist
2325 (function (lambda (elt1 elt2
)
2326 (> (dired-get-subdir-min elt1
)
2327 (dired-get-subdir-min elt2
)))))))
2329 (defun dired-kill-tree (dirname &optional remember-marks kill-root
)
2330 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2331 Interactively, you can kill DIRNAME as well by using a prefix argument.
2332 In interactive use, the command prompts for DIRNAME.
2334 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2335 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2336 (interactive "DKill tree below directory: \ni\nP")
2337 (setq dirname
(file-name-as-directory (expand-file-name dirname
)))
2338 (let ((s-alist dired-subdir-alist
) dir m-alist
)
2340 (setq dir
(car (car s-alist
))
2341 s-alist
(cdr s-alist
))
2342 (and (or kill-root
(not (string-equal dir dirname
)))
2343 (dired-in-this-tree dir dirname
)
2344 (dired-goto-subdir dir
)
2345 (setq m-alist
(nconc (dired-kill-subdir remember-marks
) m-alist
))))
2348 (defun dired-insert-subdir-newpos (new-dir)
2349 ;; Find pos for new subdir, according to tree order.
2350 ;;(goto-char (point-max))
2351 (let ((alist dired-subdir-alist
) elt dir new-pos
)
2353 (setq elt
(car alist
)
2356 (if (dired-tree-lessp dir new-dir
)
2357 ;; Insert NEW-DIR after DIR
2358 (setq new-pos
(dired-get-subdir-max elt
)
2360 (goto-char new-pos
))
2361 ;; want a separating newline between subdirs
2367 (defun dired-insert-subdir-del (element)
2368 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2369 ;; Move to that buffer position. Return a mark-alist.
2370 (let ((begin-marker (dired-get-subdir-min element
)))
2371 (goto-char begin-marker
)
2372 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2373 (goto-char (dired-subdir-max))
2374 (or (eobp);; want a separating newline _between_ subdirs:
2377 (dired-remember-marks begin-marker
(point))
2378 (delete-region begin-marker
(point)))))
2380 (defun dired-insert-subdir-doinsert (dirname switches
)
2381 ;; Insert ls output after point.
2382 ;; Return the boundary of the inserted text (as list of BEG and END).
2384 (let ((begin (point)))
2385 (let ((dired-actual-switches
2387 dired-subdir-switches
2388 (dired-replace-in-string "R" "" dired-actual-switches
))))
2389 (if (equal dirname
(car (car (last dired-subdir-alist
))))
2390 ;; If doing the top level directory of the buffer,
2391 ;; redo it as specified in dired-directory.
2392 (dired-readin-insert)
2393 (dired-insert-directory dirname dired-actual-switches nil nil t
)))
2394 (list begin
(point)))))
2396 (defun dired-insert-subdir-doupdate (dirname elt beg-end
)
2397 ;; Point is at the correct subdir alist position for ELT,
2398 ;; BEG-END is the subdir-region (as list of begin and end).
2399 (if elt
; subdir was already present
2400 ;; update its position (should actually be unchanged)
2401 (set-marker (dired-get-subdir-min elt
) (point-marker))
2402 (dired-alist-add dirname
(point-marker)))
2403 ;; The hook may depend on the subdir-alist containing the just
2404 ;; inserted subdir, so run it after dired-alist-add:
2405 (if dired-after-readin-hook
2407 (let ((begin (nth 0 beg-end
))
2408 (end (nth 1 beg-end
)))
2411 (narrow-to-region begin end
)
2412 ;; hook may add or delete lines, but the subdir boundary
2414 (run-hooks 'dired-after-readin-hook
))))))
2416 (defun dired-tree-lessp (dir1 dir2
)
2417 ;; Lexicographic order on file name components, like `ls -lR':
2418 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2419 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2420 ;; or DIR1 and DIR2 are in the same parentdir and their last
2421 ;; components are string-lessp.
2422 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2423 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2424 ;; if dired-actual-switches contained t.
2425 (setq dir1
(file-name-as-directory dir1
)
2426 dir2
(file-name-as-directory dir2
))
2427 (let ((components-1 (dired-split "/" dir1
))
2428 (components-2 (dired-split "/" dir2
)))
2429 (while (and components-1
2431 (equal (car components-1
) (car components-2
)))
2432 (setq components-1
(cdr components-1
)
2433 components-2
(cdr components-2
)))
2434 (let ((c1 (car components-1
))
2435 (c2 (car components-2
)))
2438 (string-lessp c1 c2
))
2439 ((and (null c1
) (null c2
))
2440 nil
) ; they are equal, not lessp
2441 ((null c1
) ; c2 is a subdir of c1: c1<c2
2443 ((null c2
) ; c1 is a subdir of c2: c1>c2
2445 (t (error "This can't happen"))))))
2447 ;; There should be a builtin split function - inverse to mapconcat.
2448 (defun dired-split (pat str
&optional limit
)
2449 "Splitting on regexp PAT, turn string STR into a list of substrings.
2450 Optional third arg LIMIT (>= 1) is a limit to the length of the
2452 Thus, if SEP is a regexp that only matches itself,
2454 (mapconcat 'identity (dired-split SEP STRING) SEP)
2456 is always equal to STRING."
2457 (let* ((start (string-match pat str
))
2458 (result (list (substring str
0 start
)))
2460 (end (if start
(match-end 0))))
2461 (if end
; else nothing left
2462 (while (and (or (not (integerp limit
))
2464 (string-match pat str end
))
2465 (setq start
(match-beginning 0)
2467 result
(cons (substring str end start
) result
)
2471 (if (and (or (not (integerp limit
))
2473 end
) ; else nothing left
2475 (cons (substring str end
) result
)))
2478 ;;; moving by subdirectories
2481 (defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip
)
2482 "Go to previous subdirectory, regardless of level.
2483 When called interactively and not on a subdir line, go to this subdir's line."
2486 (list (if current-prefix-arg
2487 (prefix-numeric-value current-prefix-arg
)
2488 ;; if on subdir start already, don't stay there!
2489 (if (dired-get-subdir) 1 0))))
2490 (dired-next-subdir (- arg
) no-error-if-not-found no-skip
))
2492 (defun dired-subdir-min ()
2494 (if (not (dired-prev-subdir 0 t t
))
2495 (error "Not in a subdir!")
2499 (defun dired-goto-subdir (dir)
2500 "Go to end of header line of DIR in this dired buffer.
2501 Return value of point on success, otherwise return nil.
2502 The next char is either \\n, or \\r if DIR is hidden."
2504 (prog1 ; let push-mark display its message
2505 (list (expand-file-name
2506 (completing-read "Goto in situ directory: " ; prompt
2507 dired-subdir-alist
; table
2510 (dired-current-directory))))
2512 (setq dir
(file-name-as-directory dir
))
2513 (let ((elt (assoc dir dired-subdir-alist
)))
2515 (goto-char (dired-get-subdir-min elt
))
2516 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2517 ;; at either \r or \n after this function succeeds.
2518 (progn (skip-chars-forward "^\r\n")
2522 (defun dired-mark-subdir-files ()
2523 "Mark all files except `.' and `..' in current subdirectory.
2524 If the Dired buffer shows multiple directories, this command
2525 marks the files listed in the subdirectory that point is in."
2527 (let ((p-min (dired-subdir-min)))
2528 (dired-mark-files-in-region p-min
(dired-subdir-max))))
2531 (defun dired-kill-subdir (&optional remember-marks
)
2532 "Remove all lines of current subdirectory.
2533 Lower levels are unaffected."
2534 ;; With optional REMEMBER-MARKS, return a mark-alist.
2536 (let* ((beg (dired-subdir-min))
2537 (end (dired-subdir-max))
2538 (modflag (buffer-modified-p))
2539 (cur-dir (dired-current-directory))
2540 (cons (assoc-string cur-dir dired-switches-alist
))
2542 (when (equal cur-dir
(expand-file-name default-directory
))
2543 (error "Attempt to kill top level directory"))
2545 (if remember-marks
(dired-remember-marks beg end
))
2546 (delete-region beg end
)
2547 (if (eobp) ; don't leave final blank line
2549 (dired-unsubdir cur-dir
)
2551 (setq dired-switches-alist
(delete cons dired-switches-alist
)))
2552 (restore-buffer-modified-p modflag
))))
2554 (defun dired-unsubdir (dir)
2555 ;; Remove DIR from the alist
2556 (setq dired-subdir-alist
2557 (delq (assoc dir dired-subdir-alist
) dired-subdir-alist
)))
2560 (defun dired-tree-up (arg)
2561 "Go up ARG levels in the dired tree."
2563 (let ((dir (dired-current-directory)))
2566 dir
(file-name-directory (directory-file-name dir
))))
2567 ;;(setq dir (expand-file-name dir))
2568 (or (dired-goto-subdir dir
)
2569 (error "Cannot go up to %s - not in this tree" dir
))))
2572 (defun dired-tree-down ()
2573 "Go down in the dired tree."
2575 (let ((dir (dired-current-directory)) ; has slash
2576 pos case-fold-search
) ; filenames are case sensitive
2577 (let ((rest (reverse dired-subdir-alist
)) elt
)
2579 (setq elt
(car rest
)
2581 (if (dired-in-this-tree (directory-file-name (car elt
)) dir
)
2583 pos
(dired-goto-subdir (car elt
))))))
2586 (error "At the bottom"))))
2590 (defun dired-unhide-subdir ()
2591 (let (buffer-read-only)
2592 (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?
\r ?
\n)))
2594 (defun dired-hide-check ()
2595 (or selective-display
2596 (error "selective-display must be t for subdir hiding to work!")))
2598 (defun dired-subdir-hidden-p (dir)
2599 (and selective-display
2601 (dired-goto-subdir dir
)
2602 (looking-at-p "\r"))))
2605 (defun dired-hide-subdir (arg)
2606 "Hide or unhide the current subdirectory and move to next directory.
2607 Optional prefix arg is a repeat factor.
2608 Use \\[dired-hide-all] to (un)hide all directories."
2611 (let ((modflag (buffer-modified-p)))
2612 (while (>= (setq arg
(1- arg
)) 0)
2613 (let* ((cur-dir (dired-current-directory))
2614 (hidden-p (dired-subdir-hidden-p cur-dir
))
2615 (elt (assoc cur-dir dired-subdir-alist
))
2616 (end-pos (1- (dired-get-subdir-max elt
)))
2618 ;; keep header line visible, hide rest
2619 (goto-char (dired-get-subdir-min elt
))
2620 (skip-chars-forward "^\n\r")
2622 (subst-char-in-region (point) end-pos ?
\r ?
\n)
2623 (subst-char-in-region (point) end-pos ?
\n ?
\r)))
2624 (dired-next-subdir 1 t
))
2625 (restore-buffer-modified-p modflag
)))
2628 (defun dired-hide-all (&optional ignored
)
2629 "Hide all subdirectories, leaving only their header lines.
2630 If there is already something hidden, make everything visible again.
2631 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2634 (let ((modflag (buffer-modified-p))
2637 (goto-char (point-min))
2638 (search-forward "\r" nil t
))
2639 ;; unhide - bombs on \r in filenames
2640 (subst-char-in-region (point-min) (point-max) ?
\r ?
\n)
2642 (let ((pos (point-max)) ; pos of end of last directory
2643 (alist dired-subdir-alist
))
2644 (while alist
; while there are dirs before pos
2645 (subst-char-in-region (dired-get-subdir-min (car alist
)) ; pos of prev dir
2647 (goto-char pos
) ; current dir
2648 ;; we're somewhere on current dir's line
2652 (setq pos
(dired-get-subdir-min (car alist
))) ; prev dir gets current dir
2653 (setq alist
(cdr alist
)))))
2654 (restore-buffer-modified-p modflag
)))
2656 ;;;###end dired-ins.el
2659 ;; Search only in file names in the Dired buffer.
2661 (defcustom dired-isearch-filenames nil
2662 "Non-nil to Isearch in file names only.
2663 If t, Isearch in Dired always matches only file names.
2664 If `dwim', Isearch matches file names when initial point position is on
2665 a file name. Otherwise, it searches the whole buffer without restrictions."
2666 :type
'(choice (const :tag
"No restrictions" nil
)
2667 (const :tag
"When point is on a file name initially, search file names" dwim
)
2668 (const :tag
"Always search in file names" t
))
2672 (define-minor-mode dired-isearch-filenames-mode
2673 "Toggle file names searching on or off.
2674 When on, Isearch skips matches outside file names using the predicate
2675 `dired-isearch-filter-filenames' that matches only at file names.
2676 When off, it uses the original predicate."
2678 (if dired-isearch-filenames-mode
2679 (add-function :before-while
(local 'isearch-filter-predicate
)
2680 #'dired-isearch-filter-filenames
2681 '((isearch-message-prefix .
"filename ")))
2682 (remove-function (local 'isearch-filter-predicate
)
2683 #'dired-isearch-filter-filenames
))
2685 (setq isearch-success t isearch-adjusted t
)
2689 (defun dired-isearch-filenames-setup ()
2690 "Set up isearch to search in Dired file names.
2691 Intended to be added to `isearch-mode-hook'."
2692 (when (or (eq dired-isearch-filenames t
)
2693 (and (eq dired-isearch-filenames
'dwim
)
2694 (get-text-property (point) 'dired-filename
)))
2695 (define-key isearch-mode-map
"\M-sff" 'dired-isearch-filenames-mode
)
2696 (dired-isearch-filenames-mode 1)
2697 (add-hook 'isearch-mode-end-hook
'dired-isearch-filenames-end nil t
)))
2699 (defun dired-isearch-filenames-end ()
2700 "Clean up the Dired file name search after terminating isearch."
2701 (define-key isearch-mode-map
"\M-sff" nil
)
2702 (dired-isearch-filenames-mode -
1)
2703 (remove-hook 'isearch-mode-end-hook
'dired-isearch-filenames-end t
))
2705 (defun dired-isearch-filter-filenames (beg end
)
2706 "Test whether the current search hit is a file name.
2707 Return non-nil if the text from BEG to END is part of a file
2708 name (has the text property `dired-filename')."
2709 (text-property-not-all (min beg end
) (max beg end
)
2710 'dired-filename nil
))
2713 (defun dired-isearch-filenames ()
2714 "Search for a string using Isearch only in file names in the Dired buffer."
2716 (let ((dired-isearch-filenames t
))
2717 (isearch-forward nil t
)))
2720 (defun dired-isearch-filenames-regexp ()
2721 "Search for a regexp using Isearch only in file names in the Dired buffer."
2723 (let ((dired-isearch-filenames t
))
2724 (isearch-forward-regexp nil t
)))
2727 ;; Functions for searching in tags style among marked files.
2730 (defun dired-do-isearch ()
2731 "Search for a string through all marked files using Isearch."
2733 (multi-isearch-files
2734 (dired-get-marked-files nil nil
'dired-nondirectory-p
)))
2737 (defun dired-do-isearch-regexp ()
2738 "Search for a regexp through all marked files using Isearch."
2740 (multi-isearch-files-regexp
2741 (dired-get-marked-files nil nil
'dired-nondirectory-p
)))
2744 (defun dired-do-search (regexp)
2745 "Search through all marked files for a match for REGEXP.
2746 Stops when a match is found.
2747 To continue searching for next match, use command \\[tags-loop-continue]."
2748 (interactive "sSearch marked files (regexp): ")
2749 (tags-search regexp
'(dired-get-marked-files nil nil
'dired-nondirectory-p
)))
2752 (defun dired-do-query-replace-regexp (from to
&optional delimited
)
2753 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2754 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2755 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
2756 with the command \\[tags-loop-continue]."
2759 (query-replace-read-args
2760 "Query replace regexp in marked files" t t
)))
2761 (list (nth 0 common
) (nth 1 common
) (nth 2 common
))))
2762 (dolist (file (dired-get-marked-files nil nil
'dired-nondirectory-p
))
2763 (let ((buffer (get-file-buffer file
)))
2764 (if (and buffer
(with-current-buffer buffer
2766 (error "File `%s' is visited read-only" file
))))
2767 (tags-query-replace from to delimited
2768 '(dired-get-marked-files nil nil
'dired-nondirectory-p
)))
2770 (declare-function xref--show-xrefs
"xref")
2771 (declare-function xref-query-replace-in-results
"xref")
2774 (defun dired-do-find-regexp (regexp)
2775 "Find all matches for REGEXP in all marked files.
2776 For any marked directory, all of its files are searched recursively.
2777 However, files matching `grep-find-ignored-files' and subdirectories
2778 matching `grep-find-ignored-directories' are skipped in the marked
2781 REGEXP should use constructs supported by your local `grep' command."
2782 (interactive "sSearch marked files (regexp): ")
2784 (defvar grep-find-ignored-files
)
2785 (defvar grep-find-ignored-directories
)
2786 (let* ((files (dired-get-marked-files))
2787 (ignores (nconc (mapcar
2788 (lambda (s) (concat s
"/"))
2789 grep-find-ignored-directories
)
2790 grep-find-ignored-files
))
2793 (xref-collect-matches regexp
"*" file
2794 (and (file-directory-p file
)
2798 (user-error "No matches for: %s" regexp
))
2799 (xref--show-xrefs xrefs nil t
)))
2802 (defun dired-do-find-regexp-and-replace (from to
)
2803 "Replace matches of FROM with TO, in all marked files.
2804 For any marked directory, matches in all of its files are replaced,
2805 recursively. However, files matching `grep-find-ignored-files'
2806 and subdirectories matching `grep-find-ignored-directories' are skipped
2807 in the marked directories.
2809 REGEXP should use constructs supported by your local `grep' command."
2812 (query-replace-read-args
2813 "Query replace regexp in marked files" t t
)))
2814 (list (nth 0 common
) (nth 1 common
))))
2815 (with-current-buffer (dired-do-find-regexp from
)
2816 (xref-query-replace-in-results from to
)))
2818 (defun dired-nondirectory-p (file)
2819 (not (file-directory-p file
)))
2822 (defun dired-show-file-type (file &optional deref-symlinks
)
2823 "Print the type of FILE, according to the `file' command.
2824 If you give a prefix to this command, and FILE is a symbolic
2825 link, then the type of the file linked to by FILE is printed
2827 (interactive (list (dired-get-filename t
) current-prefix-arg
))
2828 (let (process-file-side-effects)
2831 (process-file "file" nil t t
"-L" "--" file
)
2832 (process-file "file" nil t t
"--" file
))
2834 (backward-delete-char 1))
2835 (message "%s" (buffer-string)))))
2837 (provide 'dired-aux
)
2840 ;; byte-compile-dynamic: t
2841 ;; generated-autoload-file: "dired-loaddefs.el"
2844 ;;; dired-aux.el ends here