]> code.delx.au - gnu-emacs/blob - lisp/dired-aux.el
(dired-insert-subdir-doinsert): Check that the
[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 ("\\.bz2\\'" "" "bunzip2")
522 ;; This item controls naming for compression.
523 ("\\.tar\\'" ".tgz" nil))
524 "Control changes in file name suffixes for compression and uncompression.
525 Each element specifies one transformation rule, and has the form:
526 (REGEXP NEW-SUFFIX PROGRAM)
527 The rule applies when the old file name matches REGEXP.
528 The new file name is computed by deleting the part that matches REGEXP
529 (as well as anything after that), then adding NEW-SUFFIX in its place.
530 If PROGRAM is non-nil, the rule is an uncompression rule,
531 and uncompression is done by running PROGRAM.
532 Otherwise, the rule is a compression rule, and compression is done with gzip.")
533
534 ;;;###autoload
535 (defun dired-compress-file (file)
536 ;; Compress or uncompress FILE.
537 ;; Return the name of the compressed or uncompressed file.
538 ;; Return nil if no change in files.
539 (let ((handler (find-file-name-handler file 'dired-compress-file))
540 suffix newname
541 (suffixes dired-compress-file-suffixes))
542 ;; See if any suffix rule matches this file name.
543 (while suffixes
544 (let (case-fold-search)
545 (if (string-match (car (car suffixes)) file)
546 (setq suffix (car suffixes) suffixes nil))
547 (setq suffixes (cdr suffixes))))
548 ;; If so, compute desired new name.
549 (if suffix
550 (setq newname (concat (substring file 0 (match-beginning 0))
551 (nth 1 suffix))))
552 (cond (handler
553 (funcall handler 'dired-compress-file file))
554 ((file-symlink-p file)
555 nil)
556 ((and suffix (nth 2 suffix))
557 ;; We found an uncompression rule.
558 (if (not (dired-check-process (concat "Uncompressing " file)
559 (nth 2 suffix) file))
560 newname))
561 (t
562 ;;; We don't recognize the file as compressed, so compress it.
563 ;;; Try gzip; if we don't have that, use compress.
564 (condition-case nil
565 (if (not (dired-check-process (concat "Compressing " file)
566 "gzip" "-f" file))
567 (let ((out-name
568 (if (file-exists-p (concat file ".gz"))
569 (concat file ".gz")
570 (concat file ".z"))))
571 ;; Rename the compressed file to NEWNAME
572 ;; if it hasn't got that name already.
573 (if (and newname (not (equal newname out-name)))
574 (progn
575 (rename-file out-name newname t)
576 newname)
577 out-name)))
578 (file-error
579 (if (not (dired-check-process (concat "Compressing " file)
580 "compress" "-f" file))
581 ;; Don't use NEWNAME with `compress'.
582 (concat file ".Z"))))))))
583 \f
584 (defun dired-mark-confirm (op-symbol arg)
585 ;; Request confirmation from the user that the operation described
586 ;; by OP-SYMBOL is to be performed on the marked files.
587 ;; Confirmation consists in a y-or-n question with a file list
588 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
589 ;; The files used are determined by ARG (as in dired-get-marked-files).
590 (or (eq dired-no-confirm t)
591 (memq op-symbol dired-no-confirm)
592 (let ((files (dired-get-marked-files t arg))
593 (string (if (eq op-symbol 'compress) "Compress or uncompress"
594 (capitalize (symbol-name op-symbol)))))
595 (dired-mark-pop-up nil op-symbol files (function y-or-n-p)
596 (concat string " "
597 (dired-mark-prompt arg files) "? ")))))
598
599 (defun dired-map-over-marks-check (fun arg op-symbol &optional show-progress)
600 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
601 ; and display failures.
602
603 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
604 ; the short form of the filename) for a failure and probably logs a
605 ; detailed error explanation using function `dired-log'.
606
607 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
608 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
609 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
610 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
611
612 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
613 (if (dired-mark-confirm op-symbol arg)
614 (let* ((total-list;; all of FUN's return values
615 (dired-map-over-marks (funcall fun) arg show-progress))
616 (total (length total-list))
617 (failures (delq nil total-list))
618 (count (length failures))
619 (string (if (eq op-symbol 'compress) "Compress or uncompress"
620 (capitalize (symbol-name op-symbol)))))
621 (if (not failures)
622 (message "%s: %d file%s."
623 string total (dired-plural-s total))
624 ;; end this bunch of errors:
625 (dired-log-summary
626 (format "Failed to %s %d of %d file%s"
627 (downcase string) count total (dired-plural-s total))
628 failures)))))
629
630 (defvar dired-query-alist
631 '((?\y . y) (?\040 . y) ; `y' or SPC means accept once
632 (?n . n) (?\177 . n) ; `n' or DEL skips once
633 (?! . yes) ; `!' accepts rest
634 (?q. no) (?\e . no) ; `q' or ESC skips rest
635 ;; None of these keys quit - use C-g for that.
636 ))
637
638 (defun dired-query (qs-var qs-prompt &rest qs-args)
639 ;; Query user and return nil or t.
640 ;; Store answer in symbol VAR (which must initially be bound to nil).
641 ;; Format PROMPT with ARGS.
642 ;; Binding variable help-form will help the user who types the help key.
643 (let* ((char (symbol-value qs-var))
644 (action (cdr (assoc char dired-query-alist))))
645 (cond ((eq 'yes action)
646 t) ; accept, and don't ask again
647 ((eq 'no action)
648 nil) ; skip, and don't ask again
649 (t;; no lasting effects from last time we asked - ask now
650 (let ((qprompt (concat qs-prompt
651 (if help-form
652 (format " [Type yn!q or %s] "
653 (key-description
654 (char-to-string help-char)))
655 " [Type y, n, q or !] ")))
656 result elt)
657 ;; Actually it looks nicer without cursor-in-echo-area - you can
658 ;; look at the dired buffer instead of at the prompt to decide.
659 (apply 'message qprompt qs-args)
660 (setq char (set qs-var (read-char)))
661 (while (not (setq elt (assoc char dired-query-alist)))
662 (message "Invalid char - type %c for help." help-char)
663 (ding)
664 (sit-for 1)
665 (apply 'message qprompt qs-args)
666 (setq char (set qs-var (read-char))))
667 (memq (cdr elt) '(t y yes)))))))
668 \f
669 ;;;###autoload
670 (defun dired-do-compress (&optional arg)
671 "Compress or uncompress marked (or next ARG) files."
672 (interactive "P")
673 (dired-map-over-marks-check (function dired-compress) arg 'compress t))
674
675 ;; Commands for Emacs Lisp files - load and byte compile
676
677 (defun dired-byte-compile ()
678 ;; Return nil for success, offending file name else.
679 (let* ((filename (dired-get-filename))
680 elc-file buffer-read-only failure)
681 (condition-case err
682 (save-excursion (byte-compile-file filename))
683 (error
684 (setq failure err)))
685 (setq elc-file (byte-compile-dest-file filename))
686 (or (file-exists-p elc-file)
687 (setq failure t))
688 (if failure
689 (progn
690 (dired-log "Byte compile error for %s:\n%s\n" filename failure)
691 (dired-make-relative filename))
692 (dired-remove-file elc-file)
693 (forward-line) ; insert .elc after its .el file
694 (dired-add-file elc-file)
695 nil)))
696
697 ;;;###autoload
698 (defun dired-do-byte-compile (&optional arg)
699 "Byte compile marked (or next ARG) Emacs Lisp files."
700 (interactive "P")
701 (dired-map-over-marks-check (function dired-byte-compile) arg 'byte-compile t))
702
703 (defun dired-load ()
704 ;; Return nil for success, offending file name else.
705 (let ((file (dired-get-filename)) failure)
706 (condition-case err
707 (load file nil nil t)
708 (error (setq failure err)))
709 (if (not failure)
710 nil
711 (dired-log "Load error for %s:\n%s\n" file failure)
712 (dired-make-relative file))))
713
714 ;;;###autoload
715 (defun dired-do-load (&optional arg)
716 "Load the marked (or next ARG) Emacs Lisp files."
717 (interactive "P")
718 (dired-map-over-marks-check (function dired-load) arg 'load t))
719
720 ;;;###autoload
721 (defun dired-do-redisplay (&optional arg test-for-subdir)
722 "Redisplay all marked (or next ARG) files.
723 If on a subdir line, redisplay that subdirectory. In that case,
724 a prefix arg lets you edit the `ls' switches used for the new listing."
725 ;; Moves point if the next ARG files are redisplayed.
726 (interactive "P\np")
727 (if (and test-for-subdir (dired-get-subdir))
728 (dired-insert-subdir
729 (dired-get-subdir)
730 (if arg (read-string "Switches for listing: " dired-actual-switches)))
731 (message "Redisplaying...")
732 ;; message much faster than making dired-map-over-marks show progress
733 (dired-uncache
734 (if (consp dired-directory) (car dired-directory) dired-directory))
735 (dired-map-over-marks (let ((fname (dired-get-filename)))
736 (message "Redisplaying... %s" fname)
737 (dired-update-file-line fname))
738 arg)
739 (dired-move-to-filename)
740 (message "Redisplaying...done")))
741 \f
742 (defun dired-update-file-line (file)
743 ;; Delete the current line, and insert an entry for FILE.
744 ;; If FILE is nil, then just delete the current line.
745 ;; Keeps any marks that may be present in column one (doing this
746 ;; here is faster than with dired-add-entry's optional arg).
747 ;; Does not update other dired buffers. Use dired-relist-entry for that.
748 (beginning-of-line)
749 (let ((char (following-char)) (opoint (point))
750 (buffer-read-only))
751 (delete-region (point) (progn (forward-line 1) (point)))
752 (if file
753 (progn
754 (dired-add-entry file nil t)
755 ;; Replace space by old marker without moving point.
756 ;; Faster than goto+insdel inside a save-excursion?
757 (subst-char-in-region opoint (1+ opoint) ?\040 char))))
758 (dired-move-to-filename))
759
760 (defun dired-fun-in-all-buffers (directory file fun &rest args)
761 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
762 ;; If the buffer has a wildcard pattern, check that it matches FILE.
763 ;; (FILE does not include a directory component.)
764 ;; FILE may be nil, in which case ignore it.
765 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
766 (let ((buf-list (dired-buffers-for-dir (expand-file-name directory)
767 file))
768 (obuf (current-buffer))
769 buf success-list)
770 (while buf-list
771 (setq buf (car buf-list)
772 buf-list (cdr buf-list))
773 (unwind-protect
774 (progn
775 (set-buffer buf)
776 (if (apply fun args)
777 (setq success-list (cons (buffer-name buf) success-list))))
778 (set-buffer obuf)))
779 success-list))
780
781 ;;;###autoload
782 (defun dired-add-file (filename &optional marker-char)
783 (dired-fun-in-all-buffers
784 (file-name-directory filename) (file-name-nondirectory filename)
785 (function dired-add-entry) filename marker-char))
786
787 (defun dired-add-entry (filename &optional marker-char relative)
788 ;; Add a new entry for FILENAME, optionally marking it
789 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
790 ;; Note that this adds the entry `out of order' if files sorted by
791 ;; time, etc.
792 ;; At least this version inserts in the right subdirectory (if present).
793 ;; And it skips "." or ".." (see `dired-trivial-filenames').
794 ;; Hidden subdirs are exposed if a file is added there.
795 (setq filename (directory-file-name filename))
796 ;; Entry is always for files, even if they happen to also be directories
797 (let* ((opoint (point))
798 (cur-dir (dired-current-directory))
799 (orig-file-name filename)
800 (directory (if relative cur-dir (file-name-directory filename)))
801 reason)
802 (setq filename
803 (if relative
804 (file-relative-name filename directory)
805 (file-name-nondirectory filename))
806 reason
807 (catch 'not-found
808 (if (string= directory cur-dir)
809 (progn
810 (skip-chars-forward "^\r\n")
811 (if (eq (following-char) ?\r)
812 (dired-unhide-subdir))
813 ;; We are already where we should be, except when
814 ;; point is before the subdir line or its total line.
815 (let ((p (dired-after-subdir-garbage cur-dir)))
816 (if (< (point) p)
817 (goto-char p))))
818 ;; else try to find correct place to insert
819 (if (dired-goto-subdir directory)
820 (progn;; unhide if necessary
821 (if (looking-at "\r");; point is at end of subdir line
822 (dired-unhide-subdir))
823 ;; found - skip subdir and `total' line
824 ;; and uninteresting files like . and ..
825 ;; This better not moves into the next subdir!
826 (dired-goto-next-nontrivial-file))
827 ;; not found
828 (throw 'not-found "Subdir not found")))
829 (let (buffer-read-only opoint)
830 (beginning-of-line)
831 (setq opoint (point))
832 (dired-add-entry-do-indentation marker-char)
833 ;; don't expand `.'. Show just the file name within directory.
834 (let ((default-directory directory))
835 (insert-directory filename
836 (concat dired-actual-switches "d")))
837 ;; Compensate for a bug in ange-ftp.
838 ;; It inserts the file's absolute name, rather than
839 ;; the relative one. That may be hard to fix since it
840 ;; is probably controlled by something in ftp.
841 (goto-char opoint)
842 (let ((inserted-name (dired-get-filename 'no-dir)))
843 (if (file-name-directory inserted-name)
844 (progn
845 (end-of-line)
846 (delete-char (- (length inserted-name)))
847 (insert filename)
848 (forward-char 1))
849 (forward-line 1)))
850 ;; Give each line a text property recording info about it.
851 (dired-insert-set-properties opoint (point))
852 (forward-line -1)
853 (if dired-after-readin-hook;; the subdir-alist is not affected...
854 (save-excursion;; ...so we can run it right now:
855 (save-restriction
856 (beginning-of-line)
857 (narrow-to-region (point) (save-excursion
858 (forward-line 1) (point)))
859 (run-hooks 'dired-after-readin-hook))))
860 (dired-move-to-filename))
861 ;; return nil if all went well
862 nil))
863 (if reason ; don't move away on failure
864 (goto-char opoint))
865 (not reason))) ; return t on success, nil else
866
867 ;; This is a separate function for the sake of nested dired format.
868 (defun dired-add-entry-do-indentation (marker-char)
869 ;; two spaces or a marker plus a space:
870 (insert (if marker-char
871 (if (integerp marker-char) marker-char dired-marker-char)
872 ?\040)
873 ?\040))
874
875 (defun dired-after-subdir-garbage (dir)
876 ;; Return pos of first file line of DIR, skipping header and total
877 ;; or wildcard lines.
878 ;; Important: never moves into the next subdir.
879 ;; DIR is assumed to be unhidden.
880 ;; Will probably be redefined for VMS etc.
881 (save-excursion
882 (or (dired-goto-subdir dir) (error "This cannot happen"))
883 (forward-line 1)
884 (while (and (not (eolp)) ; don't cross subdir boundary
885 (not (dired-move-to-filename)))
886 (forward-line 1))
887 (point)))
888
889 ;;;###autoload
890 (defun dired-remove-file (file)
891 (dired-fun-in-all-buffers
892 (file-name-directory file) (file-name-nondirectory file)
893 (function dired-remove-entry) file))
894
895 (defun dired-remove-entry (file)
896 (save-excursion
897 (and (dired-goto-file file)
898 (let (buffer-read-only)
899 (delete-region (progn (beginning-of-line) (point))
900 (save-excursion (forward-line 1) (point)))))))
901
902 ;;;###autoload
903 (defun dired-relist-file (file)
904 (dired-fun-in-all-buffers (file-name-directory file)
905 (file-name-nondirectory file)
906 (function dired-relist-entry) file))
907
908 (defun dired-relist-entry (file)
909 ;; Relist the line for FILE, or just add it if it did not exist.
910 ;; FILE must be an absolute file name.
911 (let (buffer-read-only marker)
912 ;; If cursor is already on FILE's line delete-region will cause
913 ;; save-excursion to fail because of floating makers,
914 ;; moving point to beginning of line. Sigh.
915 (save-excursion
916 (and (dired-goto-file file)
917 (delete-region (progn (beginning-of-line)
918 (setq marker (following-char))
919 (point))
920 (save-excursion (forward-line 1) (point))))
921 (setq file (directory-file-name file))
922 (dired-add-entry file (if (eq ?\040 marker) nil marker)))))
923 \f
924 ;;; Copy, move/rename, making hard and symbolic links
925
926 (defcustom dired-backup-overwrite nil
927 "*Non-nil if Dired should ask about making backups before overwriting files.
928 Special value `always' suppresses confirmation."
929 :type '(choice (const :tag "off" nil)
930 (const :tag "suppress" always)
931 (other :tag "ask" t))
932 :group 'dired)
933
934 (defvar dired-overwrite-confirmed)
935
936 (defun dired-handle-overwrite (to)
937 ;; Save old version of a to be overwritten file TO.
938 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
939 ;; from dired-create-files.
940 (let (backup)
941 (if (and dired-backup-overwrite
942 dired-overwrite-confirmed
943 (setq backup (car (find-backup-file-name to)))
944 (or (eq 'always dired-backup-overwrite)
945 (dired-query 'overwrite-backup-query
946 (format "Make backup for existing file `%s'? " to))))
947 (progn
948 (rename-file to backup 0) ; confirm overwrite of old backup
949 (dired-relist-entry backup)))))
950
951 ;;;###autoload
952 (defun dired-copy-file (from to ok-flag)
953 (dired-handle-overwrite to)
954 (condition-case ()
955 (copy-file from to ok-flag dired-copy-preserve-time)
956 (file-date-error (message "Can't set date")
957 (sit-for 1))))
958
959 ;;;###autoload
960 (defun dired-rename-file (from to ok-flag)
961 (dired-handle-overwrite to)
962 (rename-file from to ok-flag) ; error is caught in -create-files
963 ;; Silently rename the visited file of any buffer visiting this file.
964 (and (get-file-buffer from)
965 (with-current-buffer (get-file-buffer from)
966 (set-visited-file-name to nil t)))
967 (dired-remove-file from)
968 ;; See if it's an inserted subdir, and rename that, too.
969 (dired-rename-subdir from to))
970
971 (defun dired-rename-subdir (from-dir to-dir)
972 (setq from-dir (file-name-as-directory from-dir)
973 to-dir (file-name-as-directory to-dir))
974 (dired-fun-in-all-buffers from-dir nil
975 (function dired-rename-subdir-1) from-dir to-dir)
976 ;; Update visited file name of all affected buffers
977 (let ((expanded-from-dir (expand-file-name from-dir))
978 (blist (buffer-list)))
979 (while blist
980 (save-excursion
981 (set-buffer (car blist))
982 (if (and buffer-file-name
983 (dired-in-this-tree buffer-file-name expanded-from-dir))
984 (let ((modflag (buffer-modified-p))
985 (to-file (dired-replace-in-string
986 (concat "^" (regexp-quote from-dir))
987 to-dir
988 buffer-file-name)))
989 (set-visited-file-name to-file)
990 (set-buffer-modified-p modflag))))
991 (setq blist (cdr blist)))))
992
993 (defun dired-rename-subdir-1 (dir to)
994 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
995 ;; one of its subdirectories is expanded in this buffer.
996 (let ((expanded-dir (expand-file-name dir))
997 (alist dired-subdir-alist)
998 (elt nil))
999 (while alist
1000 (setq elt (car alist)
1001 alist (cdr alist))
1002 (if (dired-in-this-tree (car elt) expanded-dir)
1003 ;; ELT's subdir is affected by the rename
1004 (dired-rename-subdir-2 elt dir to)))
1005 (if (equal dir default-directory)
1006 ;; if top level directory was renamed, lots of things have to be
1007 ;; updated:
1008 (progn
1009 (dired-unadvertise dir) ; we no longer dired DIR...
1010 (setq default-directory to
1011 dired-directory (expand-file-name;; this is correct
1012 ;; with and without wildcards
1013 (file-name-nondirectory dired-directory)
1014 to))
1015 (let ((new-name (file-name-nondirectory
1016 (directory-file-name dired-directory))))
1017 ;; try to rename buffer, but just leave old name if new
1018 ;; name would already exist (don't try appending "<%d>")
1019 (or (get-buffer new-name)
1020 (rename-buffer new-name)))
1021 ;; ... we dired TO now:
1022 (dired-advertise)))))
1023
1024 (defun dired-rename-subdir-2 (elt dir to)
1025 ;; Update the headerline and dired-subdir-alist element of directory
1026 ;; described by alist-element ELT to reflect the moving of DIR to TO.
1027 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
1028 (save-excursion
1029 (let ((regexp (regexp-quote (directory-file-name dir)))
1030 (newtext (directory-file-name to))
1031 buffer-read-only)
1032 (goto-char (dired-get-subdir-min elt))
1033 ;; Update subdir headerline in buffer
1034 (if (not (looking-at dired-subdir-regexp))
1035 (error "%s not found where expected - dired-subdir-alist broken?"
1036 dir)
1037 (goto-char (match-beginning 1))
1038 (if (re-search-forward regexp (match-end 1) t)
1039 (replace-match newtext t t)
1040 (error "Expected to find `%s' in headerline of %s" dir (car elt))))
1041 ;; Update buffer-local dired-subdir-alist
1042 (setcar elt
1043 (dired-normalize-subdir
1044 (dired-replace-in-string regexp newtext (car elt)))))))
1045 \f
1046 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1047 (defun dired-create-files (file-creator operation fn-list name-constructor
1048 &optional marker-char)
1049
1050 ;; Create a new file for each from a list of existing files. The user
1051 ;; is queried, dired buffers are updated, and at the end a success or
1052 ;; failure message is displayed
1053
1054 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1055
1056 ;; It is called for each file and must create newfile, the entry of
1057 ;; which will be added. The user will be queried if the file already
1058 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1059 ;; rename), it is FILE-CREATOR's responsibility to update dired
1060 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1061 ;; could not create newfile. The error is caught and logged.
1062
1063 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1064 ;; operation performed. It is used for error logging.
1065
1066 ;; FN-LIST is the list of files to copy (full absolute file names).
1067
1068 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1069 ;; skip. If it skips files for other reasons than a direct user
1070 ;; query, it is supposed to tell why (using dired-log).
1071
1072 ;; Optional MARKER-CHAR is a character with which to mark every
1073 ;; newfile's entry, or t to use the current marker character if the
1074 ;; oldfile was marked.
1075
1076 (let (failures skipped (success-count 0) (total (length fn-list)))
1077 (let (to overwrite-query
1078 overwrite-backup-query) ; for dired-handle-overwrite
1079 (mapcar
1080 (function
1081 (lambda (from)
1082 (setq to (funcall name-constructor from))
1083 (if (equal to from)
1084 (progn
1085 (setq to nil)
1086 (dired-log "Cannot %s to same file: %s\n"
1087 (downcase operation) from)))
1088 (if (not to)
1089 (setq skipped (cons (dired-make-relative from) skipped))
1090 (let* ((overwrite (file-exists-p to))
1091 (dired-overwrite-confirmed ; for dired-handle-overwrite
1092 (and overwrite
1093 (let ((help-form '(format "\
1094 Type SPC or `y' to overwrite file `%s',
1095 DEL or `n' to skip to next,
1096 ESC or `q' to not overwrite any of the remaining files,
1097 `!' to overwrite all remaining files with no more questions." to)))
1098 (dired-query 'overwrite-query
1099 "Overwrite `%s'?" to))))
1100 ;; must determine if FROM is marked before file-creator
1101 ;; gets a chance to delete it (in case of a move).
1102 (actual-marker-char
1103 (cond ((integerp marker-char) marker-char)
1104 (marker-char (dired-file-marker from)) ; slow
1105 (t nil))))
1106 (condition-case err
1107 (progn
1108 (funcall file-creator from to dired-overwrite-confirmed)
1109 (if overwrite
1110 ;; If we get here, file-creator hasn't been aborted
1111 ;; and the old entry (if any) has to be deleted
1112 ;; before adding the new entry.
1113 (dired-remove-file to))
1114 (setq success-count (1+ success-count))
1115 (message "%s: %d of %d" operation success-count total)
1116 (dired-add-file to actual-marker-char))
1117 (file-error ; FILE-CREATOR aborted
1118 (progn
1119 (setq failures (cons (dired-make-relative from) failures))
1120 (dired-log "%s `%s' to `%s' failed:\n%s\n"
1121 operation from to err))))))))
1122 fn-list))
1123 (cond
1124 (failures
1125 (dired-log-summary
1126 (format "%s failed for %d of %d file%s"
1127 operation (length failures) total
1128 (dired-plural-s total))
1129 failures))
1130 (skipped
1131 (dired-log-summary
1132 (format "%s: %d of %d file%s skipped"
1133 operation (length skipped) total
1134 (dired-plural-s total))
1135 skipped))
1136 (t
1137 (message "%s: %s file%s"
1138 operation success-count (dired-plural-s success-count)))))
1139 (dired-move-to-filename))
1140 \f
1141 (defun dired-do-create-files (op-symbol file-creator operation arg
1142 &optional marker-char op1
1143 how-to)
1144 ;; Create a new file for each marked file.
1145 ;; Prompts user for target, which is a directory in which to create
1146 ;; the new files. Target may be a plain file if only one marked
1147 ;; file exists.
1148 ;; OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1149 ;; will determine whether pop-ups are appropriate for this OP-SYMBOL.
1150 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1151 ;; ARG as in dired-get-marked-files.
1152 ;; Optional arg OP1 is an alternate form for OPERATION if there is
1153 ;; only one file.
1154 ;; Optional arg MARKER-CHAR as in dired-create-files.
1155 ;; Optional arg HOW-TO determines how to treat target:
1156 ;; If HOW-TO is not given (or nil), and target is a directory, the
1157 ;; file(s) are created inside the target directory. If target
1158 ;; is not a directory, there must be exactly one marked file,
1159 ;; else error.
1160 ;; If HOW-TO is t, then target is not modified. There must be
1161 ;; exactly one marked file, else error.
1162 ;; Else HOW-TO is assumed to be a function of one argument, target,
1163 ;; that looks at target and returns a value for the into-dir
1164 ;; variable. The function dired-into-dir-with-symlinks is provided
1165 ;; for the case (common when creating symlinks) that symbolic
1166 ;; links to directories are not to be considered as directories
1167 ;; (as file-directory-p would if HOW-TO had been nil).
1168 (or op1 (setq op1 operation))
1169 (let* ((fn-list (dired-get-marked-files nil arg))
1170 (fn-count (length fn-list))
1171 (target (expand-file-name
1172 (dired-mark-read-file-name
1173 (concat (if (= 1 fn-count) op1 operation) " %s to: ")
1174 (dired-dwim-target-directory)
1175 op-symbol arg (mapcar (function dired-make-relative) fn-list))))
1176 (into-dir (cond ((null how-to) (file-directory-p target))
1177 ((eq how-to t) nil)
1178 (t (funcall how-to target)))))
1179 (if (and (> fn-count 1)
1180 (not into-dir))
1181 (error "Marked %s: target must be a directory: %s" operation target))
1182 ;; rename-file bombs when moving directories unless we do this:
1183 (or into-dir (setq target (directory-file-name target)))
1184 (dired-create-files
1185 file-creator operation fn-list
1186 (if into-dir ; target is a directory
1187 ;; This function uses fluid vars into-dir and target when called
1188 ;; inside dired-create-files:
1189 (function (lambda (from)
1190 (expand-file-name (file-name-nondirectory from) target)))
1191 (function (lambda (from) target)))
1192 marker-char)))
1193
1194 ;; Read arguments for a marked-files command that wants a file name,
1195 ;; perhaps popping up the list of marked files.
1196 ;; ARG is the prefix arg and indicates whether the files came from
1197 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1198 ;; If the current file was used, the list has but one element and ARG
1199 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1200
1201 (defun dired-mark-read-file-name (prompt dir op-symbol arg files)
1202 (dired-mark-pop-up
1203 nil op-symbol files
1204 (function read-file-name)
1205 (format prompt (dired-mark-prompt arg files)) dir))
1206
1207 (defun dired-dwim-target-directory ()
1208 ;; Try to guess which target directory the user may want.
1209 ;; If there is a dired buffer displayed in the next window, use
1210 ;; its current subdir, else use current subdir of this dired buffer.
1211 (let ((this-dir (and (eq major-mode 'dired-mode)
1212 (dired-current-directory))))
1213 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1214 (if dired-dwim-target
1215 (let* ((other-buf (window-buffer (next-window)))
1216 (other-dir (save-excursion
1217 (set-buffer other-buf)
1218 (and (eq major-mode 'dired-mode)
1219 (dired-current-directory)))))
1220 (or other-dir this-dir))
1221 this-dir)))
1222 \f
1223 ;;;###autoload
1224 (defun dired-create-directory (directory)
1225 "Create a directory called DIRECTORY."
1226 (interactive
1227 (list (read-file-name "Create directory: " (dired-current-directory))))
1228 (let ((expanded (directory-file-name (expand-file-name directory))))
1229 (make-directory expanded)
1230 (dired-add-file expanded)
1231 (dired-move-to-filename)))
1232
1233 (defun dired-into-dir-with-symlinks (target)
1234 (and (file-directory-p target)
1235 (not (file-symlink-p target))))
1236 ;; This may not always be what you want, especially if target is your
1237 ;; home directory and it happens to be a symbolic link, as is often the
1238 ;; case with NFS and automounters. Or if you want to make symlinks
1239 ;; into directories that themselves are only symlinks, also quite
1240 ;; common.
1241
1242 ;; So we don't use this function as value for HOW-TO in
1243 ;; dired-do-symlink, which has the minor disadvantage of
1244 ;; making links *into* a symlinked-dir, when you really wanted to
1245 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1246 ;; just have to remove that symlink by hand before making your marked
1247 ;; symlinks.
1248
1249 ;;;###autoload
1250 (defun dired-do-copy (&optional arg)
1251 "Copy all marked (or next ARG) files, or copy the current file.
1252 This normally preserves the last-modified date when copying.
1253 When operating on just the current file, you specify the new name.
1254 When operating on multiple or marked files, you specify a directory,
1255 and new copies of these files are made in that directory
1256 with the same names that the files currently have."
1257 (interactive "P")
1258 (dired-do-create-files 'copy (function dired-copy-file)
1259 (if dired-copy-preserve-time "Copy [-p]" "Copy")
1260 arg dired-keep-marker-copy))
1261
1262 ;;;###autoload
1263 (defun dired-do-symlink (&optional arg)
1264 "Make symbolic links to current file or all marked (or next ARG) files.
1265 When operating on just the current file, you specify the new name.
1266 When operating on multiple or marked files, you specify a directory
1267 and new symbolic links are made in that directory
1268 with the same names that the files currently have."
1269 (interactive "P")
1270 (dired-do-create-files 'symlink (function make-symbolic-link)
1271 "Symlink" arg dired-keep-marker-symlink))
1272
1273 ;;;###autoload
1274 (defun dired-do-hardlink (&optional arg)
1275 "Add names (hard links) current file or all marked (or next ARG) files.
1276 When operating on just the current file, you specify the new name.
1277 When operating on multiple or marked files, you specify a directory
1278 and new hard links are made in that directory
1279 with the same names that the files currently have."
1280 (interactive "P")
1281 (dired-do-create-files 'hardlink (function add-name-to-file)
1282 "Hardlink" arg dired-keep-marker-hardlink))
1283
1284 ;;;###autoload
1285 (defun dired-do-rename (&optional arg)
1286 "Rename current file or all marked (or next ARG) files.
1287 When renaming just the current file, you specify the new name.
1288 When renaming multiple or marked files, you specify a directory."
1289 (interactive "P")
1290 (dired-do-create-files 'move (function dired-rename-file)
1291 "Move" arg dired-keep-marker-rename "Rename"))
1292 ;;;###end dired-cp.el
1293 \f
1294 ;;; 5K
1295 ;;;###begin dired-re.el
1296 (defun dired-do-create-files-regexp
1297 (file-creator operation arg regexp newname &optional whole-path marker-char)
1298 ;; Create a new file for each marked file using regexps.
1299 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1300 ;; ARG as in dired-get-marked-files.
1301 ;; Matches each marked file against REGEXP and constructs the new
1302 ;; filename from NEWNAME (like in function replace-match).
1303 ;; Optional arg WHOLE-PATH means match/replace the whole file name
1304 ;; instead of only the non-directory part of the file.
1305 ;; Optional arg MARKER-CHAR as in dired-create-files.
1306 (let* ((fn-list (dired-get-marked-files nil arg))
1307 (fn-count (length fn-list))
1308 (operation-prompt (concat operation " `%s' to `%s'?"))
1309 (rename-regexp-help-form (format "\
1310 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1311 `!' to %s all remaining matches with no more questions."
1312 (downcase operation)
1313 (downcase operation)))
1314 (regexp-name-constructor
1315 ;; Function to construct new filename using REGEXP and NEWNAME:
1316 (if whole-path ; easy (but rare) case
1317 (function
1318 (lambda (from)
1319 (let ((to (dired-string-replace-match regexp from newname))
1320 ;; must bind help-form directly around call to
1321 ;; dired-query
1322 (help-form rename-regexp-help-form))
1323 (if to
1324 (and (dired-query 'rename-regexp-query
1325 operation-prompt
1326 from
1327 to)
1328 to)
1329 (dired-log "%s: %s did not match regexp %s\n"
1330 operation from regexp)))))
1331 ;; not whole-path, replace non-directory part only
1332 (function
1333 (lambda (from)
1334 (let* ((new (dired-string-replace-match
1335 regexp (file-name-nondirectory from) newname))
1336 (to (and new ; nil means there was no match
1337 (expand-file-name new
1338 (file-name-directory from))))
1339 (help-form rename-regexp-help-form))
1340 (if to
1341 (and (dired-query 'rename-regexp-query
1342 operation-prompt
1343 (dired-make-relative from)
1344 (dired-make-relative to))
1345 to)
1346 (dired-log "%s: %s did not match regexp %s\n"
1347 operation (file-name-nondirectory from) regexp)))))))
1348 rename-regexp-query)
1349 (dired-create-files
1350 file-creator operation fn-list regexp-name-constructor marker-char)))
1351
1352 (defun dired-mark-read-regexp (operation)
1353 ;; Prompt user about performing OPERATION.
1354 ;; Read and return list of: regexp newname arg whole-path.
1355 (let* ((whole-path
1356 (equal 0 (prefix-numeric-value current-prefix-arg)))
1357 (arg
1358 (if whole-path nil current-prefix-arg))
1359 (regexp
1360 (dired-read-regexp
1361 (concat (if whole-path "Path " "") operation " from (regexp): ")))
1362 (newname
1363 (read-string
1364 (concat (if whole-path "Path " "") operation " " regexp " to: "))))
1365 (list regexp newname arg whole-path)))
1366
1367 ;;;###autoload
1368 (defun dired-do-rename-regexp (regexp newname &optional arg whole-path)
1369 "Rename marked files containing REGEXP to NEWNAME.
1370 As each match is found, the user must type a character saying
1371 what to do with it. For directions, type \\[help-command] at that time.
1372 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
1373 REGEXP defaults to the last regexp used.
1374
1375 With a zero prefix arg, renaming by regexp affects the absolute file name.
1376 Normally, only the non-directory part of the file name is used and changed."
1377 (interactive (dired-mark-read-regexp "Rename"))
1378 (dired-do-create-files-regexp
1379 (function dired-rename-file)
1380 "Rename" arg regexp newname whole-path dired-keep-marker-rename))
1381
1382 ;;;###autoload
1383 (defun dired-do-copy-regexp (regexp newname &optional arg whole-path)
1384 "Copy all marked files containing REGEXP to NEWNAME.
1385 See function `dired-do-rename-regexp' for more info."
1386 (interactive (dired-mark-read-regexp "Copy"))
1387 (dired-do-create-files-regexp
1388 (function dired-copy-file)
1389 (if dired-copy-preserve-time "Copy [-p]" "Copy")
1390 arg regexp newname whole-path dired-keep-marker-copy))
1391
1392 ;;;###autoload
1393 (defun dired-do-hardlink-regexp (regexp newname &optional arg whole-path)
1394 "Hardlink all marked files containing REGEXP to NEWNAME.
1395 See function `dired-do-rename-regexp' for more info."
1396 (interactive (dired-mark-read-regexp "HardLink"))
1397 (dired-do-create-files-regexp
1398 (function add-name-to-file)
1399 "HardLink" arg regexp newname whole-path dired-keep-marker-hardlink))
1400
1401 ;;;###autoload
1402 (defun dired-do-symlink-regexp (regexp newname &optional arg whole-path)
1403 "Symlink all marked files containing REGEXP to NEWNAME.
1404 See function `dired-do-rename-regexp' for more info."
1405 (interactive (dired-mark-read-regexp "SymLink"))
1406 (dired-do-create-files-regexp
1407 (function make-symbolic-link)
1408 "SymLink" arg regexp newname whole-path dired-keep-marker-symlink))
1409
1410 (defun dired-create-files-non-directory
1411 (file-creator basename-constructor operation arg)
1412 ;; Perform FILE-CREATOR on the non-directory part of marked files
1413 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1414 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1415 (let (rename-non-directory-query)
1416 (dired-create-files
1417 file-creator
1418 operation
1419 (dired-get-marked-files nil arg)
1420 (function
1421 (lambda (from)
1422 (let ((to (concat (file-name-directory from)
1423 (funcall basename-constructor
1424 (file-name-nondirectory from)))))
1425 (and (let ((help-form (format "\
1426 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1427 `!' to %s all remaining matches with no more questions."
1428 (downcase operation)
1429 (downcase operation))))
1430 (dired-query 'rename-non-directory-query
1431 (concat operation " `%s' to `%s'")
1432 (dired-make-relative from)
1433 (dired-make-relative to)))
1434 to))))
1435 dired-keep-marker-rename)))
1436
1437 (defun dired-rename-non-directory (basename-constructor operation arg)
1438 (dired-create-files-non-directory
1439 (function dired-rename-file)
1440 basename-constructor operation arg))
1441
1442 ;;;###autoload
1443 (defun dired-upcase (&optional arg)
1444 "Rename all marked (or next ARG) files to upper case."
1445 (interactive "P")
1446 (dired-rename-non-directory (function upcase) "Rename upcase" arg))
1447
1448 ;;;###autoload
1449 (defun dired-downcase (&optional arg)
1450 "Rename all marked (or next ARG) files to lower case."
1451 (interactive "P")
1452 (dired-rename-non-directory (function downcase) "Rename downcase" arg))
1453
1454 ;;;###end dired-re.el
1455 \f
1456 ;;; 13K
1457 ;;;###begin dired-ins.el
1458
1459 ;;;###autoload
1460 (defun dired-maybe-insert-subdir (dirname &optional
1461 switches no-error-if-not-dir-p)
1462 "Insert this subdirectory into the same dired buffer.
1463 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
1464 else inserts it at its natural place (as `ls -lR' would have done).
1465 With a prefix arg, you may edit the ls switches used for this listing.
1466 You can add `R' to the switches to expand the whole tree starting at
1467 this subdirectory.
1468 This function takes some pains to conform to `ls -lR' output."
1469 (interactive
1470 (list (dired-get-filename)
1471 (if current-prefix-arg
1472 (read-string "Switches for listing: " dired-actual-switches))))
1473 (let ((opoint (point)))
1474 ;; We don't need a marker for opoint as the subdir is always
1475 ;; inserted *after* opoint.
1476 (setq dirname (file-name-as-directory dirname))
1477 (or (and (not switches)
1478 (dired-goto-subdir dirname))
1479 (dired-insert-subdir dirname switches no-error-if-not-dir-p))
1480 ;; Push mark so that it's easy to find back. Do this after the
1481 ;; insert message so that the user sees the `Mark set' message.
1482 (push-mark opoint)))
1483
1484 (defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p)
1485 "Insert this subdirectory into the same dired buffer.
1486 If it is already present, overwrites previous entry,
1487 else inserts it at its natural place (as `ls -lR' would have done).
1488 With a prefix arg, you may edit the `ls' switches used for this listing.
1489 You can add `R' to the switches to expand the whole tree starting at
1490 this subdirectory.
1491 This function takes some pains to conform to `ls -lR' output."
1492 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1493 ;; Prospero where dired-ls does the right thing, but
1494 ;; file-directory-p has not been redefined.
1495 (interactive
1496 (list (dired-get-filename)
1497 (if current-prefix-arg
1498 (read-string "Switches for listing: " dired-actual-switches))))
1499 (setq dirname (file-name-as-directory (expand-file-name dirname)))
1500 (dired-insert-subdir-validate dirname switches)
1501 (or no-error-if-not-dir-p
1502 (file-directory-p dirname)
1503 (error "Attempt to insert a non-directory: %s" dirname))
1504 (let ((elt (assoc dirname dired-subdir-alist))
1505 switches-have-R mark-alist case-fold-search buffer-read-only)
1506 ;; case-fold-search is nil now, so we can test for capital `R':
1507 (if (setq switches-have-R (and switches (string-match "R" switches)))
1508 ;; avoid duplicated subdirs
1509 (setq mark-alist (dired-kill-tree dirname t)))
1510 (if elt
1511 ;; If subdir is already present, remove it and remember its marks
1512 (setq mark-alist (nconc (dired-insert-subdir-del elt) mark-alist))
1513 (dired-insert-subdir-newpos dirname)) ; else compute new position
1514 (dired-insert-subdir-doupdate
1515 dirname elt (dired-insert-subdir-doinsert dirname switches))
1516 (if switches-have-R (dired-build-subdir-alist))
1517 (dired-initial-position dirname)
1518 (save-excursion (dired-mark-remembered mark-alist))))
1519
1520 ;; This is a separate function for dired-vms.
1521 (defun dired-insert-subdir-validate (dirname &optional switches)
1522 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1523 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1524 (or (dired-in-this-tree dirname (expand-file-name default-directory))
1525 (error "%s: not in this directory tree" dirname))
1526 (if switches
1527 (let (case-fold-search)
1528 (mapcar
1529 (function
1530 (lambda (x)
1531 (or (eq (null (string-match x switches))
1532 (null (string-match x dired-actual-switches)))
1533 (error "Can't have dirs with and without -%s switches together"
1534 x))))
1535 ;; all switches that make a difference to dired-get-filename:
1536 '("F" "b")))))
1537
1538 (defun dired-alist-add (dir new-marker)
1539 ;; Add new DIR at NEW-MARKER. Sort alist.
1540 (dired-alist-add-1 dir new-marker)
1541 (dired-alist-sort))
1542
1543 (defun dired-alist-sort ()
1544 ;; Keep the alist sorted on buffer position.
1545 (setq dired-subdir-alist
1546 (sort dired-subdir-alist
1547 (function (lambda (elt1 elt2)
1548 (> (dired-get-subdir-min elt1)
1549 (dired-get-subdir-min elt2)))))))
1550
1551 (defun dired-kill-tree (dirname &optional remember-marks)
1552 ;;"Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1553 ;; With optional arg REMEMBER-MARKS, return an alist of marked files."
1554 (interactive "DKill tree below directory: ")
1555 (setq dirname (expand-file-name dirname))
1556 (let ((s-alist dired-subdir-alist) dir m-alist)
1557 (while s-alist
1558 (setq dir (car (car s-alist))
1559 s-alist (cdr s-alist))
1560 (if (and (not (string-equal dir dirname))
1561 (dired-in-this-tree dir dirname)
1562 (dired-goto-subdir dir))
1563 (setq m-alist (nconc (dired-kill-subdir remember-marks) m-alist))))
1564 m-alist))
1565
1566 (defun dired-insert-subdir-newpos (new-dir)
1567 ;; Find pos for new subdir, according to tree order.
1568 ;;(goto-char (point-max))
1569 (let ((alist dired-subdir-alist) elt dir pos new-pos)
1570 (while alist
1571 (setq elt (car alist)
1572 alist (cdr alist)
1573 dir (car elt)
1574 pos (dired-get-subdir-min elt))
1575 (if (dired-tree-lessp dir new-dir)
1576 ;; Insert NEW-DIR after DIR
1577 (setq new-pos (dired-get-subdir-max elt)
1578 alist nil)))
1579 (goto-char new-pos))
1580 ;; want a separating newline between subdirs
1581 (or (eobp)
1582 (forward-line -1))
1583 (insert "\n")
1584 (point))
1585
1586 (defun dired-insert-subdir-del (element)
1587 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1588 ;; Move to that buffer position. Return a mark-alist.
1589 (let ((begin-marker (dired-get-subdir-min element)))
1590 (goto-char begin-marker)
1591 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1592 (goto-char (dired-subdir-max))
1593 (or (eobp);; want a separating newline _between_ subdirs:
1594 (forward-char -1))
1595 (prog1
1596 (dired-remember-marks begin-marker (point))
1597 (delete-region begin-marker (point)))))
1598
1599 (defun dired-insert-subdir-doinsert (dirname switches)
1600 ;; Insert ls output after point and put point on the correct
1601 ;; position for the subdir alist.
1602 ;; Return the boundary of the inserted text (as list of BEG and END).
1603 (let ((begin (point)) end)
1604 (message "Reading directory %s..." dirname)
1605 (let ((dired-actual-switches
1606 (or switches
1607 (dired-replace-in-string "R" "" dired-actual-switches))))
1608 (if (equal dirname (car (car (reverse dired-subdir-alist))))
1609 ;; top level directory may contain wildcards:
1610 (dired-readin-insert dired-directory)
1611 (let ((opoint (point)))
1612 (insert-directory dirname dired-actual-switches nil t)
1613 (dired-insert-set-properties opoint (point)))))
1614 (message "Reading directory %s...done" dirname)
1615 (setq end (point-marker))
1616 (indent-rigidly begin end 2)
1617 ;; call dired-insert-headerline afterwards, as under VMS dired-ls
1618 ;; does insert the headerline itself and the insert function just
1619 ;; moves point.
1620 ;; Need a marker for END as this inserts text.
1621 (goto-char begin)
1622 (if (not (looking-at "^ /.*:$"))
1623 (dired-insert-headerline dirname))
1624 ;; point is now like in dired-build-subdir-alist
1625 (prog1
1626 (list begin (marker-position end))
1627 (set-marker end nil))))
1628
1629 (defun dired-insert-subdir-doupdate (dirname elt beg-end)
1630 ;; Point is at the correct subdir alist position for ELT,
1631 ;; BEG-END is the subdir-region (as list of begin and end).
1632 (if elt ; subdir was already present
1633 ;; update its position (should actually be unchanged)
1634 (set-marker (dired-get-subdir-min elt) (point-marker))
1635 (dired-alist-add dirname (point-marker)))
1636 ;; The hook may depend on the subdir-alist containing the just
1637 ;; inserted subdir, so run it after dired-alist-add:
1638 (if dired-after-readin-hook
1639 (save-excursion
1640 (let ((begin (nth 0 beg-end))
1641 (end (nth 1 beg-end)))
1642 (goto-char begin)
1643 (save-restriction
1644 (narrow-to-region begin end)
1645 ;; hook may add or delete lines, but the subdir boundary
1646 ;; marker floats
1647 (run-hooks 'dired-after-readin-hook))))))
1648
1649 (defun dired-tree-lessp (dir1 dir2)
1650 ;; Lexicographic order on file name components, like `ls -lR':
1651 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1652 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1653 ;; or DIR1 and DIR2 are in the same parentdir and their last
1654 ;; components are string-lessp.
1655 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1656 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1657 ;; if dired-actual-switches contained `t'.
1658 (setq dir1 (file-name-as-directory dir1)
1659 dir2 (file-name-as-directory dir2))
1660 (let ((components-1 (dired-split "/" dir1))
1661 (components-2 (dired-split "/" dir2)))
1662 (while (and components-1
1663 components-2
1664 (equal (car components-1) (car components-2)))
1665 (setq components-1 (cdr components-1)
1666 components-2 (cdr components-2)))
1667 (let ((c1 (car components-1))
1668 (c2 (car components-2)))
1669
1670 (cond ((and c1 c2)
1671 (string-lessp c1 c2))
1672 ((and (null c1) (null c2))
1673 nil) ; they are equal, not lessp
1674 ((null c1) ; c2 is a subdir of c1: c1<c2
1675 t)
1676 ((null c2) ; c1 is a subdir of c2: c1>c2
1677 nil)
1678 (t (error "This can't happen"))))))
1679
1680 ;; There should be a builtin split function - inverse to mapconcat.
1681 (defun dired-split (pat str &optional limit)
1682 "Splitting on regexp PAT, turn string STR into a list of substrings.
1683 Optional third arg LIMIT (>= 1) is a limit to the length of the
1684 resulting list.
1685 Thus, if SEP is a regexp that only matches itself,
1686
1687 (mapconcat 'identity (dired-split SEP STRING) SEP)
1688
1689 is always equal to STRING."
1690 (let* ((start (string-match pat str))
1691 (result (list (substring str 0 start)))
1692 (count 1)
1693 (end (if start (match-end 0))))
1694 (if end ; else nothing left
1695 (while (and (or (not (integerp limit))
1696 (< count limit))
1697 (string-match pat str end))
1698 (setq start (match-beginning 0)
1699 count (1+ count)
1700 result (cons (substring str end start) result)
1701 end (match-end 0)
1702 start end)
1703 ))
1704 (if (and (or (not (integerp limit))
1705 (< count limit))
1706 end) ; else nothing left
1707 (setq result
1708 (cons (substring str end) result)))
1709 (nreverse result)))
1710 \f
1711 ;;; moving by subdirectories
1712
1713 ;;;###autoload
1714 (defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip)
1715 "Go to previous subdirectory, regardless of level.
1716 When called interactively and not on a subdir line, go to this subdir's line."
1717 ;;(interactive "p")
1718 (interactive
1719 (list (if current-prefix-arg
1720 (prefix-numeric-value current-prefix-arg)
1721 ;; if on subdir start already, don't stay there!
1722 (if (dired-get-subdir) 1 0))))
1723 (dired-next-subdir (- arg) no-error-if-not-found no-skip))
1724
1725 (defun dired-subdir-min ()
1726 (save-excursion
1727 (if (not (dired-prev-subdir 0 t t))
1728 (error "Not in a subdir!")
1729 (point))))
1730
1731 ;;;###autoload
1732 (defun dired-goto-subdir (dir)
1733 "Go to end of header line of DIR in this dired buffer.
1734 Return value of point on success, otherwise return nil.
1735 The next char is either \\n, or \\r if DIR is hidden."
1736 (interactive
1737 (prog1 ; let push-mark display its message
1738 (list (expand-file-name
1739 (completing-read "Goto in situ directory: " ; prompt
1740 dired-subdir-alist ; table
1741 nil ; predicate
1742 t ; require-match
1743 (dired-current-directory))))
1744 (push-mark)))
1745 (setq dir (file-name-as-directory dir))
1746 (let ((elt (assoc dir dired-subdir-alist)))
1747 (and elt
1748 (goto-char (dired-get-subdir-min elt))
1749 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1750 ;; at either \r or \n after this function succeeds.
1751 (progn (skip-chars-forward "^\r\n")
1752 (point)))))
1753 \f
1754 ;;;###autoload
1755 (defun dired-mark-subdir-files ()
1756 "Mark all files except `.' and `..' in current subdirectory.
1757 If the Dired buffer shows multiple directories, this command
1758 marks the files listed in the subdirectory that point is in."
1759 (interactive)
1760 (let ((p-min (dired-subdir-min)))
1761 (dired-mark-files-in-region p-min (dired-subdir-max))))
1762
1763 ;;;###autoload
1764 (defun dired-kill-subdir (&optional remember-marks)
1765 "Remove all lines of current subdirectory.
1766 Lower levels are unaffected."
1767 ;; With optional REMEMBER-MARKS, return a mark-alist.
1768 (interactive)
1769 (let ((beg (dired-subdir-min))
1770 (end (dired-subdir-max))
1771 buffer-read-only cur-dir)
1772 (setq cur-dir (dired-current-directory))
1773 (if (equal cur-dir default-directory)
1774 (error "Attempt to kill top level directory"))
1775 (prog1
1776 (if remember-marks (dired-remember-marks beg end))
1777 (delete-region beg end)
1778 (if (eobp) ; don't leave final blank line
1779 (delete-char -1))
1780 (dired-unsubdir cur-dir))))
1781
1782 (defun dired-unsubdir (dir)
1783 ;; Remove DIR from the alist
1784 (setq dired-subdir-alist
1785 (delq (assoc dir dired-subdir-alist) dired-subdir-alist)))
1786
1787 ;;;###autoload
1788 (defun dired-tree-up (arg)
1789 "Go up ARG levels in the dired tree."
1790 (interactive "p")
1791 (let ((dir (dired-current-directory)))
1792 (while (>= arg 1)
1793 (setq arg (1- arg)
1794 dir (file-name-directory (directory-file-name dir))))
1795 ;;(setq dir (expand-file-name dir))
1796 (or (dired-goto-subdir dir)
1797 (error "Cannot go up to %s - not in this tree." dir))))
1798
1799 ;;;###autoload
1800 (defun dired-tree-down ()
1801 "Go down in the dired tree."
1802 (interactive)
1803 (let ((dir (dired-current-directory)) ; has slash
1804 pos case-fold-search) ; filenames are case sensitive
1805 (let ((rest (reverse dired-subdir-alist)) elt)
1806 (while rest
1807 (setq elt (car rest)
1808 rest (cdr rest))
1809 (if (dired-in-this-tree (directory-file-name (car elt)) dir)
1810 (setq rest nil
1811 pos (dired-goto-subdir (car elt))))))
1812 (if pos
1813 (goto-char pos)
1814 (error "At the bottom"))))
1815 \f
1816 ;;; hiding
1817
1818 (defun dired-unhide-subdir ()
1819 (let (buffer-read-only)
1820 (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?\r ?\n)))
1821
1822 (defun dired-hide-check ()
1823 (or selective-display
1824 (error "selective-display must be t for subdir hiding to work!")))
1825
1826 (defun dired-subdir-hidden-p (dir)
1827 (and selective-display
1828 (save-excursion
1829 (dired-goto-subdir dir)
1830 (looking-at "\r"))))
1831
1832 ;;;###autoload
1833 (defun dired-hide-subdir (arg)
1834 "Hide or unhide the current subdirectory and move to next directory.
1835 Optional prefix arg is a repeat factor.
1836 Use \\[dired-hide-all] to (un)hide all directories."
1837 (interactive "p")
1838 (dired-hide-check)
1839 (while (>= (setq arg (1- arg)) 0)
1840 (let* ((cur-dir (dired-current-directory))
1841 (hidden-p (dired-subdir-hidden-p cur-dir))
1842 (elt (assoc cur-dir dired-subdir-alist))
1843 (end-pos (1- (dired-get-subdir-max elt)))
1844 buffer-read-only)
1845 ;; keep header line visible, hide rest
1846 (goto-char (dired-get-subdir-min elt))
1847 (skip-chars-forward "^\n\r")
1848 (if hidden-p
1849 (subst-char-in-region (point) end-pos ?\r ?\n)
1850 (subst-char-in-region (point) end-pos ?\n ?\r)))
1851 (dired-next-subdir 1 t)))
1852
1853 ;;;###autoload
1854 (defun dired-hide-all (arg)
1855 "Hide all subdirectories, leaving only their header lines.
1856 If there is already something hidden, make everything visible again.
1857 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
1858 (interactive "P")
1859 (dired-hide-check)
1860 (let (buffer-read-only)
1861 (if (save-excursion
1862 (goto-char (point-min))
1863 (search-forward "\r" nil t))
1864 ;; unhide - bombs on \r in filenames
1865 (subst-char-in-region (point-min) (point-max) ?\r ?\n)
1866 ;; hide
1867 (let ((pos (point-max)) ; pos of end of last directory
1868 (alist dired-subdir-alist))
1869 (while alist ; while there are dirs before pos
1870 (subst-char-in-region (dired-get-subdir-min (car alist)) ; pos of prev dir
1871 (save-excursion
1872 (goto-char pos) ; current dir
1873 ;; we're somewhere on current dir's line
1874 (forward-line -1)
1875 (point))
1876 ?\n ?\r)
1877 (setq pos (dired-get-subdir-min (car alist))) ; prev dir gets current dir
1878 (setq alist (cdr alist)))))))
1879
1880 ;;;###end dired-ins.el
1881
1882 \f
1883 ;; Functions for searching in tags style among marked files.
1884
1885 ;;;###autoload
1886 (defun dired-do-search (regexp)
1887 "Search through all marked files for a match for REGEXP.
1888 Stops when a match is found.
1889 To continue searching for next match, use command \\[tags-loop-continue]."
1890 (interactive "sSearch marked files (regexp): ")
1891 (tags-search regexp '(dired-get-marked-files)))
1892
1893 ;;;###autoload
1894 (defun dired-do-query-replace (from to &optional delimited)
1895 "Do `query-replace-regexp' of FROM with TO, on all marked files.
1896 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
1897 If you exit (\\[keyboard-quit] or ESC), you can resume the query replace
1898 with the command \\[tags-loop-continue]."
1899 (interactive
1900 "sQuery replace in marked files (regexp): \nsQuery replace %s by: \nP")
1901 (tags-query-replace from to delimited '(dired-get-marked-files)))
1902 \f
1903
1904 (provide 'dired-aux)
1905
1906 ;;; dired-aux.el ends here