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