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