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