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