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