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