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