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)
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 the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;; The parts of dired mode not normally used. This is a space-saving hack
27 ;; to avoid having to load a large mode when all that's wanted are a few
30 ;; Rewritten in 1990/1991 to add tree features, file marking and
31 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
32 ;; Finished up by rms in 1992.
36 ;; We need macros in dired.el to compile properly.
37 (eval-when-compile (require 'dired
))
40 ;;;###begin dired-cmd.el
41 ;; Diffing and compressing
44 (defun dired-diff (file &optional switches
)
45 "Compare file at point with file FILE using `diff'.
46 FILE defaults to the file at the mark.
47 The prompted-for file is the first file given to `diff'.
48 With prefix arg, prompt for second argument SWITCHES,
49 which is options for `diff'."
51 (let ((default (if (mark t
)
52 (save-excursion (goto-char (mark t
))
53 (dired-get-filename t t
)))))
55 (list (read-file-name (format "Diff %s with: %s"
56 (dired-get-filename t
)
58 (concat "(default " default
") ")
60 (dired-current-directory) default t
)
61 (if current-prefix-arg
62 (read-string "Options for diff: "
63 (if (stringp diff-switches
)
65 (mapconcat 'identity diff-switches
" ")))))))
66 (diff file
(dired-get-filename t
) switches
))
69 (defun dired-backup-diff (&optional switches
)
70 "Diff this file with its backup file or vice versa.
71 Uses the latest backup, if there are several numerical backups.
72 If this file is a backup, diff it with its original.
73 The backup file is the first file given to `diff'.
74 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
76 (if current-prefix-arg
77 (list (read-string "Options for diff: "
78 (if (stringp diff-switches
)
80 (mapconcat 'identity diff-switches
" "))))
82 (diff-backup (dired-get-filename) switches
))
84 (defun dired-do-chxxx (attribute-name program op-symbol arg
)
85 ;; Change file attributes (mode, group, owner) of marked files and
86 ;; refresh their file lines.
87 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
88 ;; PROGRAM is the program used to change the attribute.
89 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
90 ;; ARG describes which files to use, as in dired-get-marked-files.
91 (let* ((files (dired-get-marked-files t arg
))
93 (dired-mark-read-string
94 (concat "Change " attribute-name
" of %s to: ")
95 nil op-symbol arg files
))
96 (operation (concat program
" " new-attribute
))
99 (dired-bunch-files 10000
100 (function dired-check-process
)
101 (list operation program new-attribute
)
103 (dired-do-redisplay arg
);; moves point if ARG is an integer
106 (format "%s: error" operation
)
110 (defun dired-do-chmod (&optional arg
)
111 "Change the mode of the marked (or next ARG) files.
112 This calls chmod, thus symbolic modes like `g+w' are allowed."
114 (dired-do-chxxx "Mode" dired-chmod-program
'chmod arg
))
117 (defun dired-do-chgrp (&optional arg
)
118 "Change the group of the marked (or next ARG) files."
120 (if (memq system-type
'(ms-dos windows-nt
))
121 (error "chgrp not supported on this system."))
122 (dired-do-chxxx "Group" "chgrp" 'chgrp arg
))
125 (defun dired-do-chown (&optional arg
)
126 "Change the owner of the marked (or next ARG) files."
128 (if (memq system-type
'(ms-dos windows-nt
))
129 (error "chown not supported on this system."))
130 (dired-do-chxxx "Owner" dired-chown-program
'chown arg
))
132 ;; Process all the files in FILES in batches of a convenient size,
133 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
134 ;; Batches are chosen to need less than MAX chars for the file names,
135 ;; allowing 3 extra characters of separator per file name.
136 (defun dired-bunch-files (max function args files
)
140 ;; Accumulate files as long as they fit in MAX chars,
141 ;; then process the ones accumulated so far.
143 (let* ((thisfile (car files
))
144 (thislength (+ (length thisfile
) 3))
146 ;; If we have at least 1 pending file
147 ;; and this file won't fit in the length limit, process now.
148 (if (and pending
(> (+ thislength pending-length
) max
))
150 (nconc (apply function
(append args pending
))
154 ;; Do (setq pending (cons thisfile pending))
155 ;; but reuse the cons that was in `files'.
156 (setcdr files pending
)
158 (setq pending-length
(+ thislength pending-length
))
160 (nconc (apply function
(append args pending
))
164 (defun dired-do-print (&optional arg
)
165 "Print the marked (or next ARG) files.
166 Uses the shell command coming from variables `lpr-command' and
167 `lpr-switches' as default."
169 (let* ((file-list (dired-get-marked-files t arg
))
170 (command (dired-mark-read-string
174 (if (stringp lpr-switches
)
178 'print arg file-list
)))
179 (dired-run-shell-command (dired-shell-stuff-it command file-list nil
))))
181 ;; Read arguments for a marked-files command that wants a string
182 ;; that is not a file name,
183 ;; perhaps popping up the list of marked files.
184 ;; ARG is the prefix arg and indicates whether the files came from
185 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
186 ;; If the current file was used, the list has but one element and ARG
187 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
189 (defun dired-mark-read-string (prompt initial op-symbol arg files
)
190 ;; PROMPT for a string, with INITIAL input.
191 ;; Other args are used to give user feedback and pop-up:
192 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
195 (function read-string
)
196 (format prompt
(dired-mark-prompt arg files
)) initial
))
198 ;;; Cleaning a directory: flagging some backups for deletion.
200 (defvar dired-file-version-alist
)
202 (defun dired-clean-directory (keep)
203 "Flag numerical backups for deletion.
204 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
205 Positive prefix arg KEEP overrides `dired-kept-versions';
206 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
208 To clear the flags on these files, you can use \\[dired-flag-backup-files]
209 with a prefix argument."
211 (setq keep
(if keep
(prefix-numeric-value keep
) dired-kept-versions
))
212 (let ((early-retention (if (< keep
0) (- keep
) kept-old-versions
))
213 (late-retention (if (<= keep
0) dired-kept-versions keep
))
214 (dired-file-version-alist ()))
215 (message "Cleaning numerical backups (keeping %d late, %d old)..."
216 late-retention early-retention
)
217 ;; Look at each file.
218 ;; If the file has numeric backup versions,
219 ;; put on dired-file-version-alist an element of the form
220 ;; (FILENAME . VERSION-NUMBER-LIST)
221 (dired-map-dired-file-lines (function dired-collect-file-versions
))
222 ;; Sort each VERSION-NUMBER-LIST,
223 ;; and remove the versions not to be deleted.
224 (let ((fval dired-file-version-alist
))
226 (let* ((sorted-v-list (cons 'q
(sort (cdr (car fval
)) '<)))
227 (v-count (length sorted-v-list
)))
228 (if (> v-count
(+ early-retention late-retention
))
229 (rplacd (nthcdr early-retention sorted-v-list
)
230 (nthcdr (- v-count late-retention
)
233 (cdr sorted-v-list
)))
234 (setq fval
(cdr fval
))))
235 ;; Look at each file. If it is a numeric backup file,
236 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
237 (dired-map-dired-file-lines (function dired-trample-file-versions
))
238 (message "Cleaning numerical backups...done")))
240 ;;; Subroutines of dired-clean-directory.
242 (defun dired-map-dired-file-lines (fun)
243 ;; Perform FUN with point at the end of each non-directory line.
244 ;; FUN takes one argument, the filename (complete pathname).
246 (let (file buffer-read-only
)
247 (goto-char (point-min))
250 (and (not (looking-at dired-re-dir
))
252 (setq file
(dired-get-filename nil t
)) ; nil on non-file
254 (funcall fun file
))))
257 (defun dired-collect-file-versions (fn)
258 (let ((fn (file-name-sans-versions fn
)))
259 ;; Only do work if this file is not already in the alist.
260 (if (assoc fn dired-file-version-alist
)
262 ;; If it looks like file FN has versions, return a list of the versions.
263 ;;That is a list of strings which are file names.
264 ;;The caller may want to flag some of these files for deletion.
265 (let* ((base-versions
266 (concat (file-name-nondirectory fn
) ".~"))
267 (bv-length (length base-versions
))
268 (possibilities (file-name-all-completions
270 (file-name-directory fn
)))
271 (versions (mapcar 'backup-extract-version possibilities
)))
273 (setq dired-file-version-alist
274 (cons (cons fn versions
)
275 dired-file-version-alist
)))))))
277 (defun dired-trample-file-versions (fn)
278 (let* ((start-vn (string-match "\\.~[0-9]+~$" fn
))
281 (setq base-version-list
; there was a base version to which
282 (assoc (substring fn
0 start-vn
) ; this looks like a
283 dired-file-version-alist
)) ; subversion
284 (not (memq (string-to-int (substring fn
(+ 2 start-vn
)))
285 base-version-list
)) ; this one doesn't make the cut
286 (progn (beginning-of-line)
288 (insert dired-del-marker
)))))
291 ;;>>> install (move this function into simple.el)
292 (defun dired-shell-quote (filename)
293 "Quote a file name for inferior shell (see variable `shell-file-name')."
294 ;; Quote everything except POSIX filename characters.
295 ;; This should be safe enough even for really weird shells.
296 (let ((result "") (start 0) end
)
297 (while (string-match "[^-0-9a-zA-Z_./]" filename start
)
298 (setq end
(match-beginning 0)
299 result
(concat result
(substring filename start end
)
300 "\\" (substring filename end
(1+ end
)))
302 (concat result
(substring filename start
))))
304 (defun dired-read-shell-command (prompt arg files
)
305 ;; "Read a dired shell command prompting with PROMPT (using read-string).
306 ;;ARG is the prefix arg and may be used to indicate in the prompt which
307 ;; files are affected.
308 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
311 (function read-string
)
312 (format prompt
(dired-mark-prompt arg files
))
313 nil
'shell-command-history
))
315 ;; The in-background argument is only needed in Emacs 18 where
316 ;; shell-command doesn't understand an appended ampersand `&'.
318 (defun dired-do-shell-command (command &optional arg
)
319 "Run a shell command COMMAND on the marked files.
320 If no files are marked or a specific numeric prefix arg is given,
321 the next ARG files are used. Just \\[universal-argument] means the current file.
322 The prompt mentions the file(s) or the marker, as appropriate.
324 If there is output, it goes to a separate buffer.
326 Normally the command is run on each file individually.
327 However, if there is a `*' in the command then it is run
328 just once with the entire file list substituted there.
330 No automatic redisplay of dired buffers is attempted, as there's no
331 telling what files the command may have changed. Type
332 \\[dired-do-redisplay] to redisplay the marked files.
334 The shell command has the top level directory as working directory, so
335 output files usually are created there instead of in a subdir."
336 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
337 ;;actual work and can be redefined for customization.
339 ;; Want to give feedback whether this file or marked files are used:
340 (dired-read-shell-command (concat "! on "
343 (dired-get-marked-files
344 t current-prefix-arg
))
346 (let* ((on-each (not (string-match "\\*" command
)))
347 (file-list (dired-get-marked-files t arg
)))
350 (- 10000 (length command
))
351 (function (lambda (&rest files
)
352 (dired-run-shell-command
353 (dired-shell-stuff-it command files t arg
))))
356 ;; execute the shell command
357 (dired-run-shell-command
358 (dired-shell-stuff-it command file-list nil arg
)))))
360 ;; Might use {,} for bash or csh:
361 (defvar dired-mark-prefix
""
362 "Prepended to marked files in dired shell commands.")
363 (defvar dired-mark-postfix
""
364 "Appended to marked files in dired shell commands.")
365 (defvar dired-mark-separator
" "
366 "Separates marked files in dired shell commands.")
368 (defun dired-shell-stuff-it (command file-list on-each
&optional raw-arg
)
369 ;; "Make up a shell command line from COMMAND and FILE-LIST.
370 ;; If ON-EACH is t, COMMAND should be applied to each file, else
371 ;; simply concat all files and apply COMMAND to this.
372 ;; FILE-LIST's elements will be quoted for the shell."
373 ;; Might be redefined for smarter things and could then use RAW-ARG
374 ;; (coming from interactive P and currently ignored) to decide what to do.
375 ;; Smart would be a way to access basename or extension of file names.
376 ;; See dired-trns.el for an approach to this.
377 ;; Bug: There is no way to quote a *
378 ;; On the other hand, you can never accidentally get a * into your cmd.
380 (if (string-match "\\*" command
)
381 (function (lambda (x)
382 (dired-replace-in-string "\\*" x command
)))
383 (function (lambda (x) (concat command
" " x
))))))
385 (mapconcat stuff-it
(mapcar 'dired-shell-quote file-list
) ";")
386 (let ((fns (mapconcat 'dired-shell-quote
387 file-list dired-mark-separator
)))
388 (if (> (length file-list
) 1)
389 (setq fns
(concat dired-mark-prefix fns dired-mark-postfix
)))
390 (funcall stuff-it fns
)))))
392 ;; This is an extra function so that it can be redefined by ange-ftp.
393 (defun dired-run-shell-command (command)
394 (shell-command command
)
395 ;; Return nil for sake of nconc in dired-bunch-files.
398 ;; In Emacs 19 this will return program's exit status.
399 ;; This is a separate function so that ange-ftp can redefine it.
400 (defun dired-call-process (program discard
&rest arguments
)
401 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
402 ;Remaining arguments are strings passed as command arguments to PROGRAM."
403 ;; Look for a handler for default-directory in case it is a remote file name.
405 (find-file-name-handler (directory-file-name default-directory
)
406 'dired-call-process
)))
407 (if handler
(apply handler
'dired-call-process
408 program discard arguments
)
409 (apply 'call-process program nil
(not discard
) nil arguments
))))
411 (defun dired-check-process (msg program
&rest arguments
)
412 ; "Display MSG while running PROGRAM, and check for output.
413 ;Remaining arguments are strings passed as command arguments to PROGRAM.
414 ; On error, insert output
415 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
416 ; Caller can cons up a list of failed args.
417 ;Else returns nil for success."
418 (let (err-buffer err
(dir default-directory
))
419 (message "%s..." msg
)
421 ;; Get a clean buffer for error output:
422 (setq err-buffer
(get-buffer-create " *dired-check-process output*"))
423 (set-buffer err-buffer
)
425 (setq default-directory dir
; caller's default-directory
427 (apply (function dired-call-process
) program nil arguments
)))
430 (dired-log (concat program
" " (prin1-to-string arguments
) "\n"))
431 (dired-log err-buffer
)
432 (or arguments program t
))
433 (kill-buffer err-buffer
)
434 (message "%s...done" msg
)
437 ;; Commands that delete or redisplay part of the dired buffer.
439 (defun dired-kill-line (&optional arg
)
441 (setq arg
(prefix-numeric-value arg
))
442 (let (buffer-read-only file
)
444 (setq file
(dired-get-filename nil t
))
446 (error "Can only kill file lines.")
447 (save-excursion (and file
448 (dired-goto-subdir file
)
449 (dired-kill-subdir)))
450 (delete-region (progn (beginning-of-line) (point))
451 (progn (forward-line 1) (point)))
456 (dired-move-to-filename)))
459 (defun dired-do-kill-lines (&optional arg fmt
)
460 "Kill all marked lines (not the files).
461 With a prefix argument, kill that many lines starting with the current line.
462 \(A negative argument kills lines before the current line.)
463 To kill an entire subdirectory, go to its directory header line
464 and use this command with a prefix argument (the value does not matter)."
465 ;; Returns count of killed lines. FMT="" suppresses message.
468 (if (dired-get-subdir)
470 (dired-kill-line arg
))
472 (goto-char (point-min))
473 (let (buffer-read-only (count 0))
474 (if (not arg
) ; kill marked lines
475 (let ((regexp (dired-marker-regexp)))
476 (while (and (not (eobp))
477 (re-search-forward regexp nil t
))
478 (setq count
(1+ count
))
479 (delete-region (progn (beginning-of-line) (point))
480 (progn (forward-line 1) (point)))))
481 ;; else kill unmarked lines
483 (if (or (dired-between-files)
484 (not (looking-at "^ ")))
486 (setq count
(1+ count
))
487 (delete-region (point) (save-excursion
491 (message (or fmt
"Killed %d line%s.") count
(dired-plural-s count
)))
494 ;;;###end dired-cmd.el
497 ;;;###begin dired-cp.el
499 (defun dired-compress ()
500 ;; Compress or uncompress the current file.
501 ;; Return nil for success, offending filename else.
502 (let* (buffer-read-only
503 (from-file (dired-get-filename))
504 (new-file (dired-compress-file from-file
)))
506 (let ((start (point)))
507 ;; Remove any preexisting entry for the name NEW-FILE.
509 (dired-remove-entry new-file
)
512 ;; Now replace the current line with an entry for NEW-FILE.
513 (dired-update-file-line new-file
) nil
)
514 (dired-log (concat "Failed to compress" from-file
))
518 (defun dired-compress-file (file)
519 ;; Compress or uncompress FILE.
520 ;; Return the name of the compressed or uncompressed file.
521 ;; Return nil if no change in files.
522 (let ((handler (find-file-name-handler file
'dired-compress-file
)))
524 (funcall handler
'dired-compress-file file
))
525 ((file-symlink-p file
)
527 ((let (case-fold-search)
528 (string-match "\\.Z$" file
))
529 (if (not (dired-check-process (concat "Uncompressing " file
)
531 (substring file
0 -
2)))
532 ((let (case-fold-search)
533 (string-match "\\.gz$" file
))
534 (if (not (dired-check-process (concat "Uncompressing " file
)
536 (substring file
0 -
3)))
537 ;; For .z, try gunzip. It might be an old gzip file,
538 ;; or it might be from compact? pack? (which?) but gunzip handles
540 ((let (case-fold-search)
541 (string-match "\\.z$" file
))
542 (if (not (dired-check-process (concat "Uncompressing " file
)
544 (substring file
0 -
2)))
546 ;;; Try gzip; if we don't have that, use compress.
548 (if (not (dired-check-process (concat "Compressing " file
)
550 (cond ((file-exists-p (concat file
".gz"))
552 (t (concat file
".z"))))
554 (if (not (dired-check-process (concat "Compressing " file
)
555 "compress" "-f" file
))
556 (concat file
".Z"))))))))
558 (defun dired-mark-confirm (op-symbol arg
)
559 ;; Request confirmation from the user that the operation described
560 ;; by OP-SYMBOL is to be performed on the marked files.
561 ;; Confirmation consists in a y-or-n question with a file list
562 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
563 ;; The files used are determined by ARG (as in dired-get-marked-files).
564 (or (memq op-symbol dired-no-confirm
)
565 (let ((files (dired-get-marked-files t arg
))
566 (string (if (eq op-symbol
'compress
) "Compress or uncompress"
567 (capitalize (symbol-name op-symbol
)))))
568 (dired-mark-pop-up nil op-symbol files
(function y-or-n-p
)
570 (dired-mark-prompt arg files
) "? ")))))
572 (defun dired-map-over-marks-check (fun arg op-symbol
&optional show-progress
)
573 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
574 ; and display failures.
576 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
577 ; the short form of the filename) for a failure and probably logs a
578 ; detailed error explanation using function `dired-log'.
580 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
581 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
582 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
583 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
585 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
586 (if (dired-mark-confirm op-symbol arg
)
587 (let* ((total-list;; all of FUN's return values
588 (dired-map-over-marks (funcall fun
) arg show-progress
))
589 (total (length total-list
))
590 (failures (delq nil total-list
))
591 (count (length failures
))
592 (string (if (eq op-symbol
'compress
) "Compress or uncompress"
593 (capitalize (symbol-name op-symbol
)))))
595 (message "%s: %d file%s."
596 string total
(dired-plural-s total
))
597 ;; end this bunch of errors:
599 (format "Failed to %s %d of %d file%s"
600 (downcase string
) count total
(dired-plural-s total
))
603 (defvar dired-query-alist
604 '((?\y . y
) (?
\040 . y
) ; `y' or SPC means accept once
605 (?n . n
) (?
\177 . n
) ; `n' or DEL skips once
606 (?
! . yes
) ; `!' accepts rest
607 (?q. no
) (?\e . no
) ; `q' or ESC skips rest
608 ;; None of these keys quit - use C-g for that.
611 (defun dired-query (qs-var qs-prompt
&rest qs-args
)
612 ;; Query user and return nil or t.
613 ;; Store answer in symbol VAR (which must initially be bound to nil).
614 ;; Format PROMPT with ARGS.
615 ;; Binding variable help-form will help the user who types the help key.
616 (let* ((char (symbol-value qs-var
))
617 (action (cdr (assoc char dired-query-alist
))))
618 (cond ((eq 'yes action
)
619 t
) ; accept, and don't ask again
621 nil
) ; skip, and don't ask again
622 (t;; no lasting effects from last time we asked - ask now
623 (let ((qprompt (concat qs-prompt
625 (format " [Type yn!q or %s] "
627 (char-to-string help-char
)))
628 " [Type y, n, q or !] ")))
630 ;; Actually it looks nicer without cursor-in-echo-area - you can
631 ;; look at the dired buffer instead of at the prompt to decide.
632 (apply 'message qprompt qs-args
)
633 (setq char
(set qs-var
(read-char)))
634 (while (not (setq elt
(assoc char dired-query-alist
)))
635 (message "Invalid char - type %c for help." help-char
)
638 (apply 'message qprompt qs-args
)
639 (setq char
(set qs-var
(read-char))))
640 (memq (cdr elt
) '(t y yes
)))))))
643 (defun dired-do-compress (&optional arg
)
644 "Compress or uncompress marked (or next ARG) files."
646 (dired-map-over-marks-check (function dired-compress
) arg
'compress t
))
648 ;; Commands for Emacs Lisp files - load and byte compile
650 (defun dired-byte-compile ()
651 ;; Return nil for success, offending file name else.
652 (let* ((filename (dired-get-filename))
653 elc-file buffer-read-only failure
)
655 (save-excursion (byte-compile-file filename
))
658 (setq elc-file
(byte-compile-dest-file filename
))
659 (or (file-exists-p elc-file
)
663 (dired-log "Byte compile error for %s:\n%s\n" filename failure
)
664 (dired-make-relative filename
))
665 (dired-remove-file elc-file
)
666 (forward-line) ; insert .elc after its .el file
667 (dired-add-file elc-file
)
671 (defun dired-do-byte-compile (&optional arg
)
672 "Byte compile marked (or next ARG) Emacs Lisp files."
674 (dired-map-over-marks-check (function dired-byte-compile
) arg
'byte-compile t
))
677 ;; Return nil for success, offending file name else.
678 (let ((file (dired-get-filename)) failure
)
680 (load file nil nil t
)
681 (error (setq failure err
)))
684 (dired-log "Load error for %s:\n%s\n" file failure
)
685 (dired-make-relative file
))))
688 (defun dired-do-load (&optional arg
)
689 "Load the marked (or next ARG) Emacs Lisp files."
691 (dired-map-over-marks-check (function dired-load
) arg
'load t
))
694 (defun dired-do-redisplay (&optional arg test-for-subdir
)
695 "Redisplay all marked (or next ARG) files.
696 If on a subdir line, redisplay that subdirectory. In that case,
697 a prefix arg lets you edit the `ls' switches used for the new listing."
698 ;; Moves point if the next ARG files are redisplayed.
700 (if (and test-for-subdir
(dired-get-subdir))
703 (if arg
(read-string "Switches for listing: " dired-actual-switches
)))
704 (message "Redisplaying...")
705 ;; message much faster than making dired-map-over-marks show progress
707 (if (consp dired-directory
) (car dired-directory
) dired-directory
))
708 (dired-map-over-marks (let ((fname (dired-get-filename)))
709 (message "Redisplaying... %s" fname
)
710 (dired-update-file-line fname
))
712 (dired-move-to-filename)
713 (message "Redisplaying...done")))
715 (defun dired-update-file-line (file)
716 ;; Delete the current line, and insert an entry for FILE.
717 ;; If FILE is nil, then just delete the current line.
718 ;; Keeps any marks that may be present in column one (doing this
719 ;; here is faster than with dired-add-entry's optional arg).
720 ;; Does not update other dired buffers. Use dired-relist-entry for that.
722 (let ((char (following-char)) (opoint (point))
724 (delete-region (point) (progn (forward-line 1) (point)))
727 (dired-add-entry file
)
728 ;; Replace space by old marker without moving point.
729 ;; Faster than goto+insdel inside a save-excursion?
730 (subst-char-in-region opoint
(1+ opoint
) ?
\040 char
))))
731 (dired-move-to-filename))
733 (defun dired-fun-in-all-buffers (directory fun
&rest args
)
734 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
735 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
736 (let ((buf-list (dired-buffers-for-dir (expand-file-name directory
)))
737 (obuf (current-buffer))
740 (setq buf
(car buf-list
)
741 buf-list
(cdr buf-list
))
746 (setq success-list
(cons (buffer-name buf
) success-list
))))
751 (defun dired-add-file (filename &optional marker-char
)
752 (dired-fun-in-all-buffers
753 (file-name-directory filename
)
754 (function dired-add-entry
) filename marker-char
))
756 (defun dired-add-entry (filename &optional marker-char
)
757 ;; Add a new entry for FILENAME, optionally marking it
758 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
759 ;; Note that this adds the entry `out of order' if files sorted by
761 ;; At least this version inserts in the right subdirectory (if present).
762 ;; And it skips "." or ".." (see `dired-trivial-filenames').
763 ;; Hidden subdirs are exposed if a file is added there.
764 (setq filename
(directory-file-name filename
))
765 ;; Entry is always for files, even if they happen to also be directories
766 (let ((opoint (point))
767 (cur-dir (dired-current-directory))
768 (orig-file-name filename
)
769 (directory (file-name-directory filename
))
771 (setq filename
(file-name-nondirectory filename
)
774 (if (string= directory cur-dir
)
776 (skip-chars-forward "^\r\n")
777 (if (eq (following-char) ?
\r)
778 (dired-unhide-subdir))
779 ;; We are already where we should be, except when
780 ;; point is before the subdir line or its total line.
781 (let ((p (dired-after-subdir-garbage cur-dir
)))
784 ;; else try to find correct place to insert
785 (if (dired-goto-subdir directory
)
786 (progn;; unhide if necessary
787 (if (looking-at "\r");; point is at end of subdir line
788 (dired-unhide-subdir))
789 ;; found - skip subdir and `total' line
790 ;; and uninteresting files like . and ..
791 ;; This better not moves into the next subdir!
792 (dired-goto-next-nontrivial-file))
794 (throw 'not-found
"Subdir not found")))
795 (let (buffer-read-only opoint
)
797 (setq opoint
(point))
798 (dired-add-entry-do-indentation marker-char
)
799 ;; don't expand `.'. Show just the file name within directory.
800 (let ((default-directory directory
))
801 (insert-directory filename
802 (concat dired-actual-switches
"d")))
803 ;; Compensate for a bug in ange-ftp.
804 ;; It inserts the file's absolute name, rather than
805 ;; the relative one. That may be hard to fix since it
806 ;; is probably controlled by something in ftp.
808 (let ((inserted-name (dired-get-filename 'no-dir
)))
809 (if (file-name-directory inserted-name
)
812 (delete-char (- (length inserted-name
)))
816 ;; Give each line a text property recording info about it.
817 (dired-insert-set-properties opoint
(point))
819 (if dired-after-readin-hook
;; the subdir-alist is not affected...
820 (save-excursion;; ...so we can run it right now:
823 (narrow-to-region (point) (save-excursion
824 (forward-line 1) (point)))
825 (run-hooks 'dired-after-readin-hook
))))
826 (dired-move-to-filename))
827 ;; return nil if all went well
829 (if reason
; don't move away on failure
831 (not reason
))) ; return t on success, nil else
833 ;; This is a separate function for the sake of nested dired format.
834 (defun dired-add-entry-do-indentation (marker-char)
835 ;; two spaces or a marker plus a space:
836 (insert (if marker-char
837 (if (integerp marker-char
) marker-char dired-marker-char
)
841 (defun dired-after-subdir-garbage (dir)
842 ;; Return pos of first file line of DIR, skipping header and total
843 ;; or wildcard lines.
844 ;; Important: never moves into the next subdir.
845 ;; DIR is assumed to be unhidden.
846 ;; Will probably be redefined for VMS etc.
848 (or (dired-goto-subdir dir
) (error "This cannot happen"))
850 (while (and (not (eolp)) ; don't cross subdir boundary
851 (not (dired-move-to-filename)))
856 (defun dired-remove-file (file)
857 (dired-fun-in-all-buffers
858 (file-name-directory file
) (function dired-remove-entry
) file
))
860 (defun dired-remove-entry (file)
862 (and (dired-goto-file file
)
863 (let (buffer-read-only)
864 (delete-region (progn (beginning-of-line) (point))
865 (save-excursion (forward-line 1) (point)))))))
868 (defun dired-relist-file (file)
869 (dired-fun-in-all-buffers (file-name-directory file
)
870 (function dired-relist-entry
) file
))
872 (defun dired-relist-entry (file)
873 ;; Relist the line for FILE, or just add it if it did not exist.
874 ;; FILE must be an absolute pathname.
875 (let (buffer-read-only marker
)
876 ;; If cursor is already on FILE's line delete-region will cause
877 ;; save-excursion to fail because of floating makers,
878 ;; moving point to beginning of line. Sigh.
880 (and (dired-goto-file file
)
881 (delete-region (progn (beginning-of-line)
882 (setq marker
(following-char))
884 (save-excursion (forward-line 1) (point))))
885 (setq file
(directory-file-name file
))
886 (dired-add-entry file
(if (eq ?
\040 marker
) nil marker
)))))
888 ;;; Copy, move/rename, making hard and symbolic links
890 (defvar dired-backup-overwrite nil
891 "*Non-nil if Dired should ask about making backups before overwriting files.
892 Special value `always' suppresses confirmation.")
894 (defvar dired-overwrite-confirmed
)
896 (defun dired-handle-overwrite (to)
897 ;; Save old version of a to be overwritten file TO.
898 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
899 ;; from dired-create-files.
900 (if (and dired-backup-overwrite
901 dired-overwrite-confirmed
902 (or (eq 'always dired-backup-overwrite
)
903 (dired-query 'overwrite-backup-query
904 (format "Make backup for existing file `%s'? " to
))))
905 (let ((backup (car (find-backup-file-name to
))))
906 (rename-file to backup
0) ; confirm overwrite of old backup
907 (dired-relist-entry backup
))))
910 (defun dired-copy-file (from to ok-flag
)
911 (dired-handle-overwrite to
)
912 (copy-file from to ok-flag dired-copy-preserve-time
))
915 (defun dired-rename-file (from to ok-flag
)
916 (dired-handle-overwrite to
)
917 (rename-file from to ok-flag
) ; error is caught in -create-files
918 ;; Silently rename the visited file of any buffer visiting this file.
919 (and (get-file-buffer from
)
921 (set-buffer (get-file-buffer from
))
922 (let ((modflag (buffer-modified-p)))
923 (set-visited-file-name to
)
924 (set-buffer-modified-p modflag
))))
925 (dired-remove-file from
)
926 ;; See if it's an inserted subdir, and rename that, too.
927 (dired-rename-subdir from to
))
929 (defun dired-rename-subdir (from-dir to-dir
)
930 (setq from-dir
(file-name-as-directory from-dir
)
931 to-dir
(file-name-as-directory to-dir
))
932 (dired-fun-in-all-buffers from-dir
933 (function dired-rename-subdir-1
) from-dir to-dir
)
934 ;; Update visited file name of all affected buffers
935 (let ((expanded-from-dir (expand-file-name from-dir
))
936 (blist (buffer-list)))
939 (set-buffer (car blist
))
940 (if (and buffer-file-name
941 (dired-in-this-tree buffer-file-name expanded-from-dir
))
942 (let ((modflag (buffer-modified-p))
943 (to-file (dired-replace-in-string
944 (concat "^" (regexp-quote from-dir
))
947 (set-visited-file-name to-file
)
948 (set-buffer-modified-p modflag
))))
949 (setq blist
(cdr blist
)))))
951 (defun dired-rename-subdir-1 (dir to
)
952 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
953 ;; one of its subdirectories is expanded in this buffer.
954 (let ((expanded-dir (expand-file-name dir
))
955 (alist dired-subdir-alist
)
958 (setq elt
(car alist
)
960 (if (dired-in-this-tree (car elt
) expanded-dir
)
961 ;; ELT's subdir is affected by the rename
962 (dired-rename-subdir-2 elt dir to
)))
963 (if (equal dir default-directory
)
964 ;; if top level directory was renamed, lots of things have to be
967 (dired-unadvertise dir
) ; we no longer dired DIR...
968 (setq default-directory to
969 dired-directory
(expand-file-name;; this is correct
970 ;; with and without wildcards
971 (file-name-nondirectory dired-directory
)
973 (let ((new-name (file-name-nondirectory
974 (directory-file-name dired-directory
))))
975 ;; try to rename buffer, but just leave old name if new
976 ;; name would already exist (don't try appending "<%d>")
977 (or (get-buffer new-name
)
978 (rename-buffer new-name
)))
979 ;; ... we dired TO now:
980 (dired-advertise)))))
982 (defun dired-rename-subdir-2 (elt dir to
)
983 ;; Update the headerline and dired-subdir-alist element of directory
984 ;; described by alist-element ELT to reflect the moving of DIR to TO.
985 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
987 (let ((regexp (regexp-quote (directory-file-name dir
)))
988 (newtext (directory-file-name to
))
990 (goto-char (dired-get-subdir-min elt
))
991 ;; Update subdir headerline in buffer
992 (if (not (looking-at dired-subdir-regexp
))
993 (error "%s not found where expected - dired-subdir-alist broken?"
995 (goto-char (match-beginning 1))
996 (if (re-search-forward regexp
(match-end 1) t
)
997 (replace-match newtext t t
)
998 (error "Expected to find `%s' in headerline of %s" dir
(car elt
))))
999 ;; Update buffer-local dired-subdir-alist
1001 (dired-normalize-subdir
1002 (dired-replace-in-string regexp newtext
(car elt
)))))))
1004 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1005 (defun dired-create-files (file-creator operation fn-list name-constructor
1006 &optional marker-char
)
1008 ;; Create a new file for each from a list of existing files. The user
1009 ;; is queried, dired buffers are updated, and at the end a success or
1010 ;; failure message is displayed
1012 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1014 ;; It is called for each file and must create newfile, the entry of
1015 ;; which will be added. The user will be queried if the file already
1016 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1017 ;; rename), it is FILE-CREATOR's responsibility to update dired
1018 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1019 ;; could not create newfile. The error is caught and logged.
1021 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1022 ;; operation performed. It is used for error logging.
1024 ;; FN-LIST is the list of files to copy (full absolute pathnames).
1026 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1027 ;; skip. If it skips files for other reasons than a direct user
1028 ;; query, it is supposed to tell why (using dired-log).
1030 ;; Optional MARKER-CHAR is a character with which to mark every
1031 ;; newfile's entry, or t to use the current marker character if the
1032 ;; oldfile was marked.
1034 (let (failures skipped
(success-count 0) (total (length fn-list
)))
1035 (let (to overwrite-query
1036 overwrite-backup-query
) ; for dired-handle-overwrite
1040 (setq to
(funcall name-constructor from
))
1044 (dired-log "Cannot %s to same file: %s\n"
1045 (downcase operation
) from
)))
1047 (setq skipped
(cons (dired-make-relative from
) skipped
))
1048 (let* ((overwrite (file-exists-p to
))
1049 (dired-overwrite-confirmed ; for dired-handle-overwrite
1051 (let ((help-form '(format "\
1052 Type SPC or `y' to overwrite file `%s',
1053 DEL or `n' to skip to next,
1054 ESC or `q' to not overwrite any of the remaining files,
1055 `!' to overwrite all remaining files with no more questions." to
)))
1056 (dired-query 'overwrite-query
1057 "Overwrite `%s'?" to
))))
1058 ;; must determine if FROM is marked before file-creator
1059 ;; gets a chance to delete it (in case of a move).
1061 (cond ((integerp marker-char
) marker-char
)
1062 (marker-char (dired-file-marker from
)) ; slow
1066 (funcall file-creator from to dired-overwrite-confirmed
)
1068 ;; If we get here, file-creator hasn't been aborted
1069 ;; and the old entry (if any) has to be deleted
1070 ;; before adding the new entry.
1071 (dired-remove-file to
))
1072 (setq success-count
(1+ success-count
))
1073 (message "%s: %d of %d" operation success-count total
)
1074 (dired-add-file to actual-marker-char
))
1075 (file-error ; FILE-CREATOR aborted
1077 (setq failures
(cons (dired-make-relative from
) failures
))
1078 (dired-log "%s `%s' to `%s' failed:\n%s\n"
1079 operation from to err
))))))))
1084 (format "%s failed for %d of %d file%s"
1085 operation
(length failures
) total
1086 (dired-plural-s total
))
1090 (format "%s: %d of %d file%s skipped"
1091 operation
(length skipped
) total
1092 (dired-plural-s total
))
1095 (message "%s: %s file%s"
1096 operation success-count
(dired-plural-s success-count
)))))
1097 (dired-move-to-filename))
1099 (defun dired-do-create-files (op-symbol file-creator operation arg
1100 &optional marker-char op1
1102 ;; Create a new file for each marked file.
1103 ;; Prompts user for target, which is a directory in which to create
1104 ;; the new files. Target may be a plain file if only one marked
1106 ;; OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1107 ;; will determine whether pop-ups are appropriate for this OP-SYMBOL.
1108 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1109 ;; ARG as in dired-get-marked-files.
1110 ;; Optional arg OP1 is an alternate form for OPERATION if there is
1112 ;; Optional arg MARKER-CHAR as in dired-create-files.
1113 ;; Optional arg HOW-TO determines how to treat target:
1114 ;; If HOW-TO is not given (or nil), and target is a directory, the
1115 ;; file(s) are created inside the target directory. If target
1116 ;; is not a directory, there must be exactly one marked file,
1118 ;; If HOW-TO is t, then target is not modified. There must be
1119 ;; exactly one marked file, else error.
1120 ;; Else HOW-TO is assumed to be a function of one argument, target,
1121 ;; that looks at target and returns a value for the into-dir
1122 ;; variable. The function dired-into-dir-with-symlinks is provided
1123 ;; for the case (common when creating symlinks) that symbolic
1124 ;; links to directories are not to be considered as directories
1125 ;; (as file-directory-p would if HOW-TO had been nil).
1126 (or op1
(setq op1 operation
))
1127 (let* ((fn-list (dired-get-marked-files nil arg
))
1128 (fn-count (length fn-list
))
1129 (target (expand-file-name
1130 (dired-mark-read-file-name
1131 (concat (if (= 1 fn-count
) op1 operation
) " %s to: ")
1132 (dired-dwim-target-directory)
1133 op-symbol arg
(mapcar (function dired-make-relative
) fn-list
))))
1134 (into-dir (cond ((null how-to
) (file-directory-p target
))
1136 (t (funcall how-to target
)))))
1137 (if (and (> fn-count
1)
1139 (error "Marked %s: target must be a directory: %s" operation target
))
1140 ;; rename-file bombs when moving directories unless we do this:
1141 (or into-dir
(setq target
(directory-file-name target
)))
1143 file-creator operation fn-list
1144 (if into-dir
; target is a directory
1145 ;; This function uses fluid vars into-dir and target when called
1146 ;; inside dired-create-files:
1147 (function (lambda (from)
1148 (expand-file-name (file-name-nondirectory from
) target
)))
1149 (function (lambda (from) target
)))
1152 ;; Read arguments for a marked-files command that wants a file name,
1153 ;; perhaps popping up the list of marked files.
1154 ;; ARG is the prefix arg and indicates whether the files came from
1155 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1156 ;; If the current file was used, the list has but one element and ARG
1157 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1159 (defun dired-mark-read-file-name (prompt dir op-symbol arg files
)
1162 (function read-file-name
)
1163 (format prompt
(dired-mark-prompt arg files
)) dir
))
1165 (defun dired-dwim-target-directory ()
1166 ;; Try to guess which target directory the user may want.
1167 ;; If there is a dired buffer displayed in the next window, use
1168 ;; its current subdir, else use current subdir of this dired buffer.
1169 (let ((this-dir (and (eq major-mode
'dired-mode
)
1170 (dired-current-directory))))
1171 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1172 (if dired-dwim-target
1173 (let* ((other-buf (window-buffer (next-window)))
1174 (other-dir (save-excursion
1175 (set-buffer other-buf
)
1176 (and (eq major-mode
'dired-mode
)
1177 (dired-current-directory)))))
1178 (or other-dir this-dir
))
1182 (defun dired-create-directory (directory)
1183 "Create a directory called DIRECTORY."
1185 (list (read-file-name "Create directory: " (dired-current-directory))))
1186 (let ((expanded (directory-file-name (expand-file-name directory
))))
1187 (make-directory expanded
)
1188 (dired-add-file expanded
)
1189 (dired-move-to-filename)))
1191 (defun dired-into-dir-with-symlinks (target)
1192 (and (file-directory-p target
)
1193 (not (file-symlink-p target
))))
1194 ;; This may not always be what you want, especially if target is your
1195 ;; home directory and it happens to be a symbolic link, as is often the
1196 ;; case with NFS and automounters. Or if you want to make symlinks
1197 ;; into directories that themselves are only symlinks, also quite
1200 ;; So we don't use this function as value for HOW-TO in
1201 ;; dired-do-symlink, which has the minor disadvantage of
1202 ;; making links *into* a symlinked-dir, when you really wanted to
1203 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1204 ;; just have to remove that symlink by hand before making your marked
1208 (defun dired-do-copy (&optional arg
)
1209 "Copy all marked (or next ARG) files, or copy the current file.
1210 This normally preserves the last-modified date when copying.
1211 When operating on just the current file, you specify the new name.
1212 When operating on multiple or marked files, you specify a directory,
1213 and new copies of these files are made in that directory
1214 with the same names that the files currently have."
1216 (dired-do-create-files 'copy
(function dired-copy-file
)
1217 (if dired-copy-preserve-time
"Copy [-p]" "Copy")
1218 arg dired-keep-marker-copy
))
1221 (defun dired-do-symlink (&optional arg
)
1222 "Make symbolic links to current file or all marked (or next ARG) files.
1223 When operating on just the current file, you specify the new name.
1224 When operating on multiple or marked files, you specify a directory
1225 and new symbolic links are made in that directory
1226 with the same names that the files currently have."
1228 (dired-do-create-files 'symlink
(function make-symbolic-link
)
1229 "Symlink" arg dired-keep-marker-symlink
))
1232 (defun dired-do-hardlink (&optional arg
)
1233 "Add names (hard links) current file or all marked (or next ARG) files.
1234 When operating on just the current file, you specify the new name.
1235 When operating on multiple or marked files, you specify a directory
1236 and new hard links are made in that directory
1237 with the same names that the files currently have."
1239 (dired-do-create-files 'hardlink
(function add-name-to-file
)
1240 "Hardlink" arg dired-keep-marker-hardlink
))
1243 (defun dired-do-rename (&optional arg
)
1244 "Rename current file or all marked (or next ARG) files.
1245 When renaming just the current file, you specify the new name.
1246 When renaming multiple or marked files, you specify a directory."
1248 (dired-do-create-files 'move
(function dired-rename-file
)
1249 "Move" arg dired-keep-marker-rename
"Rename"))
1250 ;;;###end dired-cp.el
1253 ;;;###begin dired-re.el
1254 (defun dired-do-create-files-regexp
1255 (file-creator operation arg regexp newname
&optional whole-path marker-char
)
1256 ;; Create a new file for each marked file using regexps.
1257 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1258 ;; ARG as in dired-get-marked-files.
1259 ;; Matches each marked file against REGEXP and constructs the new
1260 ;; filename from NEWNAME (like in function replace-match).
1261 ;; Optional arg WHOLE-PATH means match/replace the whole pathname
1262 ;; instead of only the non-directory part of the file.
1263 ;; Optional arg MARKER-CHAR as in dired-create-files.
1264 (let* ((fn-list (dired-get-marked-files nil arg
))
1265 (fn-count (length fn-list
))
1266 (operation-prompt (concat operation
" `%s' to `%s'?"))
1267 (rename-regexp-help-form (format "\
1268 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1269 `!' to %s all remaining matches with no more questions."
1270 (downcase operation
)
1271 (downcase operation
)))
1272 (regexp-name-constructor
1273 ;; Function to construct new filename using REGEXP and NEWNAME:
1274 (if whole-path
; easy (but rare) case
1277 (let ((to (dired-string-replace-match regexp from newname
))
1278 ;; must bind help-form directly around call to
1280 (help-form rename-regexp-help-form
))
1282 (and (dired-query 'rename-regexp-query
1287 (dired-log "%s: %s did not match regexp %s\n"
1288 operation from regexp
)))))
1289 ;; not whole-path, replace non-directory part only
1292 (let* ((new (dired-string-replace-match
1293 regexp
(file-name-nondirectory from
) newname
))
1294 (to (and new
; nil means there was no match
1295 (expand-file-name new
1296 (file-name-directory from
))))
1297 (help-form rename-regexp-help-form
))
1299 (and (dired-query 'rename-regexp-query
1301 (dired-make-relative from
)
1302 (dired-make-relative to
))
1304 (dired-log "%s: %s did not match regexp %s\n"
1305 operation
(file-name-nondirectory from
) regexp
)))))))
1306 rename-regexp-query
)
1308 file-creator operation fn-list regexp-name-constructor marker-char
)))
1310 (defun dired-mark-read-regexp (operation)
1311 ;; Prompt user about performing OPERATION.
1312 ;; Read and return list of: regexp newname arg whole-path.
1314 (equal 0 (prefix-numeric-value current-prefix-arg
)))
1316 (if whole-path nil current-prefix-arg
))
1319 (concat (if whole-path
"Path " "") operation
" from (regexp): ")))
1322 (concat (if whole-path
"Path " "") operation
" " regexp
" to: "))))
1323 (list regexp newname arg whole-path
)))
1326 (defun dired-do-rename-regexp (regexp newname
&optional arg whole-path
)
1327 "Rename marked files containing REGEXP to NEWNAME.
1328 As each match is found, the user must type a character saying
1329 what to do with it. For directions, type \\[help-command] at that time.
1330 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
1331 REGEXP defaults to the last regexp used.
1332 With a zero prefix arg, renaming by regexp affects the complete
1333 pathname - usually only the non-directory part of file names is used
1335 (interactive (dired-mark-read-regexp "Rename"))
1336 (dired-do-create-files-regexp
1337 (function dired-rename-file
)
1338 "Rename" arg regexp newname whole-path dired-keep-marker-rename
))
1341 (defun dired-do-copy-regexp (regexp newname
&optional arg whole-path
)
1342 "Copy all marked files containing REGEXP to NEWNAME.
1343 See function `dired-rename-regexp' for more info."
1344 (interactive (dired-mark-read-regexp "Copy"))
1345 (dired-do-create-files-regexp
1346 (function dired-copy-file
)
1347 (if dired-copy-preserve-time
"Copy [-p]" "Copy")
1348 arg regexp newname whole-path dired-keep-marker-copy
))
1351 (defun dired-do-hardlink-regexp (regexp newname
&optional arg whole-path
)
1352 "Hardlink all marked files containing REGEXP to NEWNAME.
1353 See function `dired-rename-regexp' for more info."
1354 (interactive (dired-mark-read-regexp "HardLink"))
1355 (dired-do-create-files-regexp
1356 (function add-name-to-file
)
1357 "HardLink" arg regexp newname whole-path dired-keep-marker-hardlink
))
1360 (defun dired-do-symlink-regexp (regexp newname
&optional arg whole-path
)
1361 "Symlink all marked files containing REGEXP to NEWNAME.
1362 See function `dired-rename-regexp' for more info."
1363 (interactive (dired-mark-read-regexp "SymLink"))
1364 (dired-do-create-files-regexp
1365 (function make-symbolic-link
)
1366 "SymLink" arg regexp newname whole-path dired-keep-marker-symlink
))
1368 (defun dired-create-files-non-directory
1369 (file-creator basename-constructor operation arg
)
1370 ;; Perform FILE-CREATOR on the non-directory part of marked files
1371 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1372 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1373 (let (rename-non-directory-query)
1377 (dired-get-marked-files nil arg
)
1380 (let ((to (concat (file-name-directory from
)
1381 (funcall basename-constructor
1382 (file-name-nondirectory from
)))))
1383 (and (let ((help-form (format "\
1384 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1385 `!' to %s all remaining matches with no more questions."
1386 (downcase operation
)
1387 (downcase operation
))))
1388 (dired-query 'rename-non-directory-query
1389 (concat operation
" `%s' to `%s'")
1390 (dired-make-relative from
)
1391 (dired-make-relative to
)))
1393 dired-keep-marker-rename
)))
1395 (defun dired-rename-non-directory (basename-constructor operation arg
)
1396 (dired-create-files-non-directory
1397 (function dired-rename-file
)
1398 basename-constructor operation arg
))
1401 (defun dired-upcase (&optional arg
)
1402 "Rename all marked (or next ARG) files to upper case."
1404 (dired-rename-non-directory (function upcase
) "Rename upcase" arg
))
1407 (defun dired-downcase (&optional arg
)
1408 "Rename all marked (or next ARG) files to lower case."
1410 (dired-rename-non-directory (function downcase
) "Rename downcase" arg
))
1412 ;;;###end dired-re.el
1415 ;;;###begin dired-ins.el
1418 (defun dired-maybe-insert-subdir (dirname &optional
1419 switches no-error-if-not-dir-p
)
1420 "Insert this subdirectory into the same dired buffer.
1421 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
1422 else inserts it at its natural place (as `ls -lR' would have done).
1423 With a prefix arg, you may edit the ls switches used for this listing.
1424 You can add `R' to the switches to expand the whole tree starting at
1426 This function takes some pains to conform to `ls -lR' output."
1428 (list (dired-get-filename)
1429 (if current-prefix-arg
1430 (read-string "Switches for listing: " dired-actual-switches
))))
1431 (let ((opoint (point)))
1432 ;; We don't need a marker for opoint as the subdir is always
1433 ;; inserted *after* opoint.
1434 (setq dirname
(file-name-as-directory dirname
))
1435 (or (and (not switches
)
1436 (dired-goto-subdir dirname
))
1437 (dired-insert-subdir dirname switches no-error-if-not-dir-p
))
1438 ;; Push mark so that it's easy to find back. Do this after the
1439 ;; insert message so that the user sees the `Mark set' message.
1440 (push-mark opoint
)))
1442 (defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p
)
1443 "Insert this subdirectory into the same dired buffer.
1444 If it is already present, overwrites previous entry,
1445 else inserts it at its natural place (as `ls -lR' would have done).
1446 With a prefix arg, you may edit the `ls' switches used for this listing.
1447 You can add `R' to the switches to expand the whole tree starting at
1449 This function takes some pains to conform to `ls -lR' output."
1450 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1451 ;; Prospero where dired-ls does the right thing, but
1452 ;; file-directory-p has not been redefined.
1454 (list (dired-get-filename)
1455 (if current-prefix-arg
1456 (read-string "Switches for listing: " dired-actual-switches
))))
1457 (setq dirname
(file-name-as-directory (expand-file-name dirname
)))
1458 (dired-insert-subdir-validate dirname switches
)
1459 (or no-error-if-not-dir-p
1460 (file-directory-p dirname
)
1461 (error "Attempt to insert a non-directory: %s" dirname
))
1462 (let ((elt (assoc dirname dired-subdir-alist
))
1463 switches-have-R mark-alist case-fold-search buffer-read-only
)
1464 ;; case-fold-search is nil now, so we can test for capital `R':
1465 (if (setq switches-have-R
(and switches
(string-match "R" switches
)))
1466 ;; avoid duplicated subdirs
1467 (setq mark-alist
(dired-kill-tree dirname t
)))
1469 ;; If subdir is already present, remove it and remember its marks
1470 (setq mark-alist
(nconc (dired-insert-subdir-del elt
) mark-alist
))
1471 (dired-insert-subdir-newpos dirname
)) ; else compute new position
1472 (dired-insert-subdir-doupdate
1473 dirname elt
(dired-insert-subdir-doinsert dirname switches
))
1474 (if switches-have-R
(dired-build-subdir-alist))
1475 (dired-initial-position dirname
)
1476 (save-excursion (dired-mark-remembered mark-alist
))))
1478 ;; This is a separate function for dired-vms.
1479 (defun dired-insert-subdir-validate (dirname &optional switches
)
1480 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1481 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1482 (or (dired-in-this-tree dirname
(expand-file-name default-directory
))
1483 (error "%s: not in this directory tree" dirname
))
1485 (let (case-fold-search)
1489 (or (eq (null (string-match x switches
))
1490 (null (string-match x dired-actual-switches
)))
1491 (error "Can't have dirs with and without -%s switches together"
1493 ;; all switches that make a difference to dired-get-filename:
1496 (defun dired-alist-add (dir new-marker
)
1497 ;; Add new DIR at NEW-MARKER. Sort alist.
1498 (dired-alist-add-1 dir new-marker
)
1501 (defun dired-alist-sort ()
1502 ;; Keep the alist sorted on buffer position.
1503 (setq dired-subdir-alist
1504 (sort dired-subdir-alist
1505 (function (lambda (elt1 elt2
)
1506 (> (dired-get-subdir-min elt1
)
1507 (dired-get-subdir-min elt2
)))))))
1509 (defun dired-kill-tree (dirname &optional remember-marks
)
1510 ;;"Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1511 ;; With optional arg REMEMBER-MARKS, return an alist of marked files."
1512 (interactive "DKill tree below directory: ")
1513 (setq dirname
(expand-file-name dirname
))
1514 (let ((s-alist dired-subdir-alist
) dir m-alist
)
1516 (setq dir
(car (car s-alist
))
1517 s-alist
(cdr s-alist
))
1518 (if (and (not (string-equal dir dirname
))
1519 (dired-in-this-tree dir dirname
)
1520 (dired-goto-subdir dir
))
1521 (setq m-alist
(nconc (dired-kill-subdir remember-marks
) m-alist
))))
1524 (defun dired-insert-subdir-newpos (new-dir)
1525 ;; Find pos for new subdir, according to tree order.
1526 ;;(goto-char (point-max))
1527 (let ((alist dired-subdir-alist
) elt dir pos new-pos
)
1529 (setq elt
(car alist
)
1532 pos
(dired-get-subdir-min elt
))
1533 (if (dired-tree-lessp dir new-dir
)
1534 ;; Insert NEW-DIR after DIR
1535 (setq new-pos
(dired-get-subdir-max elt
)
1537 (goto-char new-pos
))
1538 ;; want a separating newline between subdirs
1544 (defun dired-insert-subdir-del (element)
1545 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1546 ;; Move to that buffer position. Return a mark-alist.
1547 (let ((begin-marker (dired-get-subdir-min element
)))
1548 (goto-char begin-marker
)
1549 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1550 (goto-char (dired-subdir-max))
1551 (or (eobp);; want a separating newline _between_ subdirs:
1554 (dired-remember-marks begin-marker
(point))
1555 (delete-region begin-marker
(point)))))
1557 (defun dired-insert-subdir-doinsert (dirname switches
)
1558 ;; Insert ls output after point and put point on the correct
1559 ;; position for the subdir alist.
1560 ;; Return the boundary of the inserted text (as list of BEG and END).
1561 (let ((begin (point)) end
)
1562 (message "Reading directory %s..." dirname
)
1563 (let ((dired-actual-switches
1565 (dired-replace-in-string "R" "" dired-actual-switches
))))
1566 (if (equal dirname
(car (car (reverse dired-subdir-alist
))))
1567 ;; top level directory may contain wildcards:
1568 (dired-readin-insert dired-directory
)
1569 (let ((opoint (point)))
1570 (insert-directory dirname dired-actual-switches nil t
)
1571 (dired-insert-set-properties opoint
(point)))))
1572 (message "Reading directory %s...done" dirname
)
1573 (setq end
(point-marker))
1574 (indent-rigidly begin end
2)
1575 ;; call dired-insert-headerline afterwards, as under VMS dired-ls
1576 ;; does insert the headerline itself and the insert function just
1578 ;; Need a marker for END as this inserts text.
1580 (dired-insert-headerline dirname
)
1581 ;; point is now like in dired-build-subdir-alist
1583 (list begin
(marker-position end
))
1584 (set-marker end nil
))))
1586 (defun dired-insert-subdir-doupdate (dirname elt beg-end
)
1587 ;; Point is at the correct subdir alist position for ELT,
1588 ;; BEG-END is the subdir-region (as list of begin and end).
1589 (if elt
; subdir was already present
1590 ;; update its position (should actually be unchanged)
1591 (set-marker (dired-get-subdir-min elt
) (point-marker))
1592 (dired-alist-add dirname
(point-marker)))
1593 ;; The hook may depend on the subdir-alist containing the just
1594 ;; inserted subdir, so run it after dired-alist-add:
1595 (if dired-after-readin-hook
1597 (let ((begin (nth 0 beg-end
))
1598 (end (nth 1 beg-end
)))
1601 (narrow-to-region begin end
)
1602 ;; hook may add or delete lines, but the subdir boundary
1604 (run-hooks 'dired-after-readin-hook
))))))
1606 (defun dired-tree-lessp (dir1 dir2
)
1607 ;; Lexicographic order on pathname components, like `ls -lR':
1608 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1609 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1610 ;; or DIR1 and DIR2 are in the same parentdir and their last
1611 ;; components are string-lessp.
1612 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1613 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1614 ;; if dired-actual-switches contained `t'.
1615 (setq dir1
(file-name-as-directory dir1
)
1616 dir2
(file-name-as-directory dir2
))
1617 (let ((components-1 (dired-split "/" dir1
))
1618 (components-2 (dired-split "/" dir2
)))
1619 (while (and components-1
1621 (equal (car components-1
) (car components-2
)))
1622 (setq components-1
(cdr components-1
)
1623 components-2
(cdr components-2
)))
1624 (let ((c1 (car components-1
))
1625 (c2 (car components-2
)))
1628 (string-lessp c1 c2
))
1629 ((and (null c1
) (null c2
))
1630 nil
) ; they are equal, not lessp
1631 ((null c1
) ; c2 is a subdir of c1: c1<c2
1633 ((null c2
) ; c1 is a subdir of c2: c1>c2
1635 (t (error "This can't happen"))))))
1637 ;; There should be a builtin split function - inverse to mapconcat.
1638 (defun dired-split (pat str
&optional limit
)
1639 "Splitting on regexp PAT, turn string STR into a list of substrings.
1640 Optional third arg LIMIT (>= 1) is a limit to the length of the
1642 Thus, if SEP is a regexp that only matches itself,
1644 (mapconcat 'identity (dired-split SEP STRING) SEP)
1646 is always equal to STRING."
1647 (let* ((start (string-match pat str
))
1648 (result (list (substring str
0 start
)))
1650 (end (if start
(match-end 0))))
1651 (if end
; else nothing left
1652 (while (and (or (not (integerp limit
))
1654 (string-match pat str end
))
1655 (setq start
(match-beginning 0)
1657 result
(cons (substring str end start
) result
)
1661 (if (and (or (not (integerp limit
))
1663 end
) ; else nothing left
1665 (cons (substring str end
) result
)))
1668 ;;; moving by subdirectories
1671 (defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip
)
1672 "Go to previous subdirectory, regardless of level.
1673 When called interactively and not on a subdir line, go to this subdir's line."
1676 (list (if current-prefix-arg
1677 (prefix-numeric-value current-prefix-arg
)
1678 ;; if on subdir start already, don't stay there!
1679 (if (dired-get-subdir) 1 0))))
1680 (dired-next-subdir (- arg
) no-error-if-not-found no-skip
))
1682 (defun dired-subdir-min ()
1684 (if (not (dired-prev-subdir 0 t t
))
1685 (error "Not in a subdir!")
1689 (defun dired-goto-subdir (dir)
1690 "Go to end of header line of DIR in this dired buffer.
1691 Return value of point on success, otherwise return nil.
1692 The next char is either \\n, or \\r if DIR is hidden."
1694 (prog1 ; let push-mark display its message
1695 (list (expand-file-name
1696 (completing-read "Goto in situ directory: " ; prompt
1697 dired-subdir-alist
; table
1700 (dired-current-directory))))
1702 (setq dir
(file-name-as-directory dir
))
1703 (let ((elt (assoc dir dired-subdir-alist
)))
1705 (goto-char (dired-get-subdir-min elt
))
1706 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1707 ;; at either \r or \n after this function succeeds.
1708 (progn (skip-chars-forward "^\r\n")
1712 (defun dired-mark-subdir-files ()
1713 "Mark all files except `.' and `..'."
1715 (let ((p-min (dired-subdir-min)))
1716 (dired-mark-files-in-region p-min
(dired-subdir-max))))
1719 (defun dired-kill-subdir (&optional remember-marks
)
1720 "Remove all lines of current subdirectory.
1721 Lower levels are unaffected."
1722 ;; With optional REMEMBER-MARKS, return a mark-alist.
1724 (let ((beg (dired-subdir-min))
1725 (end (dired-subdir-max))
1726 buffer-read-only cur-dir
)
1727 (setq cur-dir
(dired-current-directory))
1728 (if (equal cur-dir default-directory
)
1729 (error "Attempt to kill top level directory"))
1731 (if remember-marks
(dired-remember-marks beg end
))
1732 (delete-region beg end
)
1733 (if (eobp) ; don't leave final blank line
1735 (dired-unsubdir cur-dir
))))
1737 (defun dired-unsubdir (dir)
1738 ;; Remove DIR from the alist
1739 (setq dired-subdir-alist
1740 (delq (assoc dir dired-subdir-alist
) dired-subdir-alist
)))
1743 (defun dired-tree-up (arg)
1744 "Go up ARG levels in the dired tree."
1746 (let ((dir (dired-current-directory)))
1749 dir
(file-name-directory (directory-file-name dir
))))
1750 ;;(setq dir (expand-file-name dir))
1751 (or (dired-goto-subdir dir
)
1752 (error "Cannot go up to %s - not in this tree." dir
))))
1755 (defun dired-tree-down ()
1756 "Go down in the dired tree."
1758 (let ((dir (dired-current-directory)) ; has slash
1759 pos case-fold-search
) ; filenames are case sensitive
1760 (let ((rest (reverse dired-subdir-alist
)) elt
)
1762 (setq elt
(car rest
)
1764 (if (dired-in-this-tree (directory-file-name (car elt
)) dir
)
1766 pos
(dired-goto-subdir (car elt
))))))
1769 (error "At the bottom"))))
1773 (defun dired-unhide-subdir ()
1774 (let (buffer-read-only)
1775 (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?
\r ?
\n)))
1777 (defun dired-hide-check ()
1778 (or selective-display
1779 (error "selective-display must be t for subdir hiding to work!")))
1781 (defun dired-subdir-hidden-p (dir)
1782 (and selective-display
1784 (dired-goto-subdir dir
)
1785 (looking-at "\r"))))
1788 (defun dired-hide-subdir (arg)
1789 "Hide or unhide the current subdirectory and move to next directory.
1790 Optional prefix arg is a repeat factor.
1791 Use \\[dired-hide-all] to (un)hide all directories."
1794 (while (>= (setq arg
(1- arg
)) 0)
1795 (let* ((cur-dir (dired-current-directory))
1796 (hidden-p (dired-subdir-hidden-p cur-dir
))
1797 (elt (assoc cur-dir dired-subdir-alist
))
1798 (end-pos (1- (dired-get-subdir-max elt
)))
1800 ;; keep header line visible, hide rest
1801 (goto-char (dired-get-subdir-min elt
))
1802 (skip-chars-forward "^\n\r")
1804 (subst-char-in-region (point) end-pos ?
\r ?
\n)
1805 (subst-char-in-region (point) end-pos ?
\n ?
\r)))
1806 (dired-next-subdir 1 t
)))
1809 (defun dired-hide-all (arg)
1810 "Hide all subdirectories, leaving only their header lines.
1811 If there is already something hidden, make everything visible again.
1812 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
1815 (let (buffer-read-only)
1817 (goto-char (point-min))
1818 (search-forward "\r" nil t
))
1819 ;; unhide - bombs on \r in filenames
1820 (subst-char-in-region (point-min) (point-max) ?
\r ?
\n)
1822 (let ((pos (point-max)) ; pos of end of last directory
1823 (alist dired-subdir-alist
))
1824 (while alist
; while there are dirs before pos
1825 (subst-char-in-region (dired-get-subdir-min (car alist
)) ; pos of prev dir
1827 (goto-char pos
) ; current dir
1828 ;; we're somewhere on current dir's line
1832 (setq pos
(dired-get-subdir-min (car alist
))) ; prev dir gets current dir
1833 (setq alist
(cdr alist
)))))))
1835 ;;;###end dired-ins.el
1838 ;; Functions for searching in tags style among marked files.
1841 (defun dired-do-search (regexp)
1842 "Search through all marked files for a match for REGEXP.
1843 Stops when a match is found.
1844 To continue searching for next match, use command \\[tags-loop-continue]."
1845 (interactive "sSearch marked files (regexp): ")
1846 (tags-search regexp
'(dired-get-marked-files)))
1849 (defun dired-do-query-replace (from to
&optional delimited
)
1850 "Do `query-replace-regexp' of FROM with TO, on all marked files.
1851 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
1852 If you exit (\\[keyboard-quit] or ESC), you can resume the query replace
1853 with the command \\[tags-loop-continue]."
1855 "sQuery replace in marked files (regexp): \nsQuery replace %s by: \nP")
1856 (tags-query-replace from to delimited
'(dired-get-marked-files)))
1859 (provide 'dired-aux
)
1861 ;;; dired-aux.el ends here