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