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