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