1 ;;; dired-aux.el --- all of dired except what people usually use
3 ;; Copyright (C) 1985, 1986, 1992 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
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
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
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.
35 ;; We need macros in dired.el to compile properly.
36 (eval-when-compile (require 'dired
))
39 ;;;###begin dired-cmd.el
40 ;; Diffing and compressing
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'."
48 (let ((default (if (mark)
49 (save-excursion (goto-char (mark))
50 (dired-get-filename t t
)))))
51 (list (read-file-name (format "Diff %s with: %s"
52 (dired-get-filename t
)
54 (concat "(default " default
") ")
56 (dired-current-directory) default t
)
57 (if (fboundp 'diff-read-switches
)
58 (diff-read-switches "Options for diff: ")))))
59 (if switches
; Emacs 19's diff has but two
60 (diff file
(dired-get-filename t
) switches
) ; args (yet ;-)
61 (diff file
(dired-get-filename t
))))
64 (defun dired-backup-diff (&optional switches
)
65 "Diff this file with its backup file or vice versa.
66 Uses the latest backup, if there are several numerical backups.
67 If this file is a backup, diff it with its original.
68 The backup file is the first file given to `diff'."
69 (interactive (list (if (fboundp 'diff-read-switches
)
70 (diff-read-switches "Diff with switches: "))))
72 (diff-backup (dired-get-filename) switches
)
73 (diff-backup (dired-get-filename))))
75 (defun dired-do-chxxx (attribute-name program op-symbol arg
)
76 ;; Change file attributes (mode, group, owner) of marked files and
77 ;; refresh their file lines.
78 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
79 ;; PROGRAM is the program used to change the attribute.
80 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
81 ;; ARG describes which files to use, as in dired-get-marked-files.
82 (let* ((files (dired-get-marked-files t arg
))
84 (dired-mark-read-string
85 (concat "Change " attribute-name
" of %s to: ")
86 nil op-symbol arg files
))
87 (operation (concat program
" " new-attribute
))
90 (dired-bunch-files 10000
91 (function dired-check-process
)
92 (list operation program new-attribute
)
94 (dired-do-redisplay arg
);; moves point if ARG is an integer
97 (format "%s: error" operation
)
101 (defun dired-do-chmod (&optional arg
)
102 "Change the mode of the marked (or next ARG) files.
103 This calls chmod, thus symbolic modes like `g+w' are allowed."
105 (dired-do-chxxx "Mode" "chmod" 'chmod arg
))
108 (defun dired-do-chgrp (&optional arg
)
109 "Change the group of the marked (or next ARG) files."
111 (dired-do-chxxx "Group" "chgrp" 'chgrp arg
))
114 (defun dired-do-chown (&optional arg
)
115 "Change the owner of the marked (or next ARG) files."
117 (dired-do-chxxx "Owner" dired-chown-program
'chown arg
))
119 ;; Process all the files in FILES in batches of a convenient size,
120 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
121 ;; Batches are chosen to need less than MAX chars for the file names,
122 ;; allowing 3 extra characters of separator per file name.
123 (defun dired-bunch-files (max function args files
)
127 ;; Accumulate files as long as they fit in MAX chars,
128 ;; then process the ones accumulated so far.
130 (let* ((thisfile (car files
))
131 (thislength (+ (length thisfile
) 3))
133 ;; If we have at least 1 pending file
134 ;; and this file won't fit in the length limit, process now.
135 (if (and pending
(> (+ thislength pending-length
) max
))
137 (nconc (apply function
(append args pending
))
141 ;; Do (setq pending (cons thisfile pending))
142 ;; but reuse the cons that was in `files'.
143 (setcdr files pending
)
145 (setq pending-length
(+ thislength pending-length
))
147 (nconc (apply function
(append args pending
))
151 (defun dired-do-print (&optional arg
)
152 "Print the marked (or next ARG) files.
153 Uses the shell command coming from variables `lpr-command' and
154 `lpr-switches' as default."
156 (let* ((file-list (dired-get-marked-files t arg
))
157 (command (dired-mark-read-string
159 (apply 'concat lpr-command
" " lpr-switches
)
160 'print arg file-list
)))
161 (dired-run-shell-command (dired-shell-stuff-it command file-list nil
))))
163 ;; Read arguments for a marked-files command that wants a string
164 ;; that is not a file name,
165 ;; perhaps popping up the list of marked files.
166 ;; ARG is the prefix arg and indicates whether the files came from
167 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
168 ;; If the current file was used, the list has but one element and ARG
169 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
171 (defun dired-mark-read-string (prompt initial op-symbol arg files
)
172 ;; PROMPT for a string, with INITIAL input.
173 ;; Other args are used to give user feedback and pop-up:
174 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
177 (function read-string
)
178 (format prompt
(dired-mark-prompt arg files
)) initial
))
180 ;;; Cleaning a directory: flagging some backups for deletion.
182 (defvar dired-file-version-alist
)
184 (defun dired-clean-directory (keep)
185 "Flag numerical backups for deletion.
186 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
187 Positive prefix arg KEEP overrides `dired-kept-versions';
188 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
190 To clear the flags on these files, you can use \\[dired-flag-backup-files]
191 with a prefix argument."
193 (setq keep
(if keep
(prefix-numeric-value keep
) dired-kept-versions
))
194 (let ((early-retention (if (< keep
0) (- keep
) kept-old-versions
))
195 (late-retention (if (<= keep
0) dired-kept-versions keep
))
196 (dired-file-version-alist ()))
197 (message "Cleaning numerical backups (keeping %d late, %d old)..."
198 late-retention early-retention
)
199 ;; Look at each file.
200 ;; If the file has numeric backup versions,
201 ;; put on dired-file-version-alist an element of the form
202 ;; (FILENAME . VERSION-NUMBER-LIST)
203 (dired-map-dired-file-lines (function dired-collect-file-versions
))
204 ;; Sort each VERSION-NUMBER-LIST,
205 ;; and remove the versions not to be deleted.
206 (let ((fval dired-file-version-alist
))
208 (let* ((sorted-v-list (cons 'q
(sort (cdr (car fval
)) '<)))
209 (v-count (length sorted-v-list
)))
210 (if (> v-count
(+ early-retention late-retention
))
211 (rplacd (nthcdr early-retention sorted-v-list
)
212 (nthcdr (- v-count late-retention
)
215 (cdr sorted-v-list
)))
216 (setq fval
(cdr fval
))))
217 ;; Look at each file. If it is a numeric backup file,
218 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
219 (dired-map-dired-file-lines (function dired-trample-file-versions
))
220 (message "Cleaning numerical backups...done")))
222 ;;; Subroutines of dired-clean-directory.
224 (defun dired-map-dired-file-lines (fun)
225 ;; Perform FUN with point at the end of each non-directory line.
226 ;; FUN takes one argument, the filename (complete pathname).
228 (let (file buffer-read-only
)
229 (goto-char (point-min))
232 (and (not (looking-at dired-re-dir
))
234 (setq file
(dired-get-filename nil t
)) ; nil on non-file
236 (funcall fun file
))))
239 (defun dired-collect-file-versions (fn)
240 ;; "If it looks like file FN has versions, return a list of the versions.
241 ;;That is a list of strings which are file names.
242 ;;The caller may want to flag some of these files for deletion."
243 (let* ((base-versions
244 (concat (file-name-nondirectory fn
) ".~"))
245 (bv-length (length base-versions
))
246 (possibilities (file-name-all-completions
248 (file-name-directory fn
)))
249 (versions (mapcar 'backup-extract-version possibilities
)))
251 (setq dired-file-version-alist
(cons (cons fn versions
)
252 dired-file-version-alist
)))))
254 (defun dired-trample-file-versions (fn)
255 (let* ((start-vn (string-match "\\.~[0-9]+~$" fn
))
258 (setq base-version-list
; there was a base version to which
259 (assoc (substring fn
0 start-vn
) ; this looks like a
260 dired-file-version-alist
)) ; subversion
261 (not (memq (string-to-int (substring fn
(+ 2 start-vn
)))
262 base-version-list
)) ; this one doesn't make the cut
263 (progn (beginning-of-line)
265 (insert dired-del-marker
)))))
268 ;;>>> install (move this function into simple.el)
269 (defun dired-shell-quote (filename)
270 "Quote a file name for inferior shell (see variable `shell-file-name')."
271 ;; Quote everything except POSIX filename characters.
272 ;; This should be safe enough even for really wierd shells.
273 (let ((result "") (start 0) end
)
274 (while (string-match "[^---0-9a-zA-Z_./]" filename start
)
275 (setq end
(match-beginning 0)
276 result
(concat result
(substring filename start end
)
277 "\\" (substring filename end
(1+ end
)))
279 (concat result
(substring filename start
))))
281 (defun dired-read-shell-command (prompt arg files
)
282 ;; "Read a dired shell command prompting with PROMPT (using read-string).
283 ;;ARG is the prefix arg and may be used to indicate in the prompt which
284 ;; files are affected.
285 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
288 (function read-string
)
289 (format prompt
(dired-mark-prompt arg files
))))
291 ;; The in-background argument is only needed in Emacs 18 where
292 ;; shell-command doesn't understand an appended ampersand `&'.
294 (defun dired-do-shell-command (command &optional arg
)
295 "Run a shell command COMMAND on the marked files.
296 If no files are marked or a specific numeric prefix arg is given,
297 the next ARG files are used. Just \\[universal-argument] means the current file.
298 The prompt mentions the file(s) or the marker, as appropriate.
300 If there is output, it goes to a separate buffer.
302 Normally the command is run on each file individually.
303 However, if there is a `*' in the command then it is run
304 just once with the entire file list substituted there.
306 No automatic redisplay of dired buffers is attempted, as there's no
307 telling what files the command may have changed. Type
308 \\[dired-do-redisplay] to redisplay the marked files.
310 The shell command has the top level directory as working directory, so
311 output files usually are created there instead of in a subdir."
312 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
313 ;;actual work and can be redefined for customization.
315 ;; Want to give feedback whether this file or marked files are used:
316 (dired-read-shell-command (concat "! on "
319 (dired-get-marked-files
320 t current-prefix-arg
))
322 (let* ((on-each (not (string-match "\\*" command
)))
323 (file-list (dired-get-marked-files t arg
)))
326 (- 10000 (length command
))
327 (function (lambda (&rest files
)
328 (dired-run-shell-command
329 (dired-shell-stuff-it command files t arg
))))
332 ;; execute the shell command
333 (dired-run-shell-command
334 (dired-shell-stuff-it command file-list nil arg
)))))
336 ;; Might use {,} for bash or csh:
337 (defvar dired-mark-prefix
""
338 "Prepended to marked files in dired shell commands.")
339 (defvar dired-mark-postfix
""
340 "Appended to marked files in dired shell commands.")
341 (defvar dired-mark-separator
" "
342 "Separates marked files in dired shell commands.")
344 (defun dired-shell-stuff-it (command file-list on-each
&optional raw-arg
)
345 ;; "Make up a shell command line from COMMAND and FILE-LIST.
346 ;; If ON-EACH is t, COMMAND should be applied to each file, else
347 ;; simply concat all files and apply COMMAND to this.
348 ;; FILE-LIST's elements will be quoted for the shell."
349 ;; Might be redefined for smarter things and could then use RAW-ARG
350 ;; (coming from interactive P and currently ignored) to decide what to do.
351 ;; Smart would be a way to access basename or extension of file names.
352 ;; See dired-trns.el for an approach to this.
353 ;; Bug: There is no way to quote a *
354 ;; On the other hand, you can never accidentally get a * into your cmd.
356 (if (string-match "\\*" command
)
357 (function (lambda (x)
358 (dired-replace-in-string "\\*" x command
)))
359 (function (lambda (x) (concat command
" " x
))))))
361 (mapconcat stuff-it
(mapcar 'dired-shell-quote file-list
) ";")
362 (let ((fns (mapconcat 'dired-shell-quote
363 file-list dired-mark-separator
)))
364 (if (> (length file-list
) 1)
365 (setq fns
(concat dired-mark-prefix fns dired-mark-postfix
)))
366 (funcall stuff-it fns
)))))
368 ;; This is an extra function so that it can be redefined by ange-ftp.
369 (defun dired-run-shell-command (command)
370 (shell-command command
)
371 ;; Return nil for sake of nconc in dired-bunch-files.
374 ;; In Emacs 19 this will return program's exit status.
375 ;; This is a separate function so that ange-ftp can redefine it.
376 (defun dired-call-process (program discard
&rest arguments
)
377 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
378 ;Remaining arguments are strings passed as command arguments to PROGRAM."
379 (apply 'call-process program nil
(not discard
) nil arguments
))
381 (defun dired-check-process (msg program
&rest arguments
)
382 ; "Display MSG while running PROGRAM, and check for output.
383 ;Remaining arguments are strings passed as command arguments to PROGRAM.
384 ; On error, insert output
385 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
386 ; Caller can cons up a list of failed args.
387 ;Else returns nil for success."
388 (let (err-buffer err
(dir default-directory
))
389 (message "%s..." msg
)
391 ;; Get a clean buffer for error output:
392 (setq err-buffer
(get-buffer-create " *dired-check-process output*"))
393 (set-buffer err-buffer
)
395 (setq default-directory dir
; caller's default-directory
397 (apply (function dired-call-process
) program nil arguments
)))
400 (dired-log (concat program
" " (prin1-to-string arguments
) "\n"))
401 (dired-log err-buffer
)
402 (or arguments program t
))
403 (kill-buffer err-buffer
)
404 (message "%s...done" msg
)
407 ;; Commands that delete or redisplay part of the dired buffer.
409 (defun dired-kill-line (&optional arg
)
411 (setq arg
(prefix-numeric-value arg
))
412 (let (buffer-read-only file
)
414 (setq file
(dired-get-filename nil t
))
416 (error "Can only kill file lines.")
417 (save-excursion (and file
418 (dired-goto-subdir file
)
419 (dired-kill-subdir)))
420 (delete-region (progn (beginning-of-line) (point))
421 (progn (forward-line 1) (point)))
426 (dired-move-to-filename)))
429 (defun dired-do-kill-lines (&optional arg fmt
)
430 "Kill all marked lines (not the files).
431 With a prefix argument, kill that many lines starting with the current line.
432 \(A negative argument kills lines before the current line.)
433 To kill an entire subdirectory, go to its directory header line
434 and use this command with a prefix argument (the value does not matter)."
435 ;; Returns count of killed lines. FMT="" suppresses message.
438 (if (dired-get-subdir)
440 (dired-kill-line arg
))
442 (goto-char (point-min))
443 (let (buffer-read-only (count 0))
444 (if (not arg
) ; kill marked lines
445 (let ((regexp (dired-marker-regexp)))
446 (while (and (not (eobp))
447 (re-search-forward regexp nil t
))
448 (setq count
(1+ count
))
449 (delete-region (progn (beginning-of-line) (point))
450 (progn (forward-line 1) (point)))))
451 ;; else kill unmarked lines
453 (if (or (dired-between-files)
454 (not (looking-at "^ ")))
456 (setq count
(1+ count
))
457 (delete-region (point) (save-excursion
461 (message (or fmt
"Killed %d line%s.") count
(dired-plural-s count
)))
464 ;;;###end dired-cmd.el
467 ;;;###begin dired-cp.el
469 (defun dired-compress ()
470 ;; Compress or uncompress the current file.
471 ;; Return nil for success, offending filename else.
472 (let* (buffer-read-only
473 (from-file (dired-get-filename))
474 (new-file (dired-compress-file from-file
)))
476 (progn (dired-update-file-line new-file
) nil
)
477 (dired-log (concat "Failed to compress" from-file
))
480 (defun dired-compress-file (file)
481 ;; Compress or uncompress FILE.
482 ;; Return the name of the compressed or uncompressed file.
483 ;; Rerurn nil if no change in files.
484 (let ((handler (find-file-name-handler file
)))
486 (funcall handler
'dired-compress-file file
))
487 ((file-symlink-p file
)
489 ((string-match "\\.Z$" file
)
490 (if (dired-check-process (concat "Uncompressing " file
)
492 (substring file
0 -
2)))
494 (if (dired-check-process (concat "Compressing " file
)
495 "compress" "-f" file
)
496 (concat name
".Z"))))))
498 (defun dired-mark-confirm (op-symbol arg
)
499 ;; Request confirmation from the user that the operation described
500 ;; by OP-SYMBOL is to be performed on the marked files.
501 ;; Confirmation consists in a y-or-n question with a file list
502 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
503 ;; The files used are determined by ARG (as in dired-get-marked-files).
504 (or (memq op-symbol dired-no-confirm
)
505 (let ((files (dired-get-marked-files t arg
))
506 (string (if (eq op-symbol
'compress
) "Compress or uncompress"
507 (capitalize (symbol-name op-symbol
)))))
508 (dired-mark-pop-up nil op-symbol files
(function y-or-n-p
)
510 (dired-mark-prompt arg files
) "? ")))))
512 (defun dired-map-over-marks-check (fun arg op-symbol
&optional show-progress
)
513 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
514 ; and display failures.
516 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
517 ; the short form of the filename) for a failure and probably logs a
518 ; detailed error explanation using function `dired-log'.
520 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
521 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
522 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
523 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
525 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
526 (if (dired-mark-confirm op-symbol arg
)
527 (let* ((total-list;; all of FUN's return values
528 (dired-map-over-marks (funcall fun
) arg show-progress
))
529 (total (length total-list
))
530 (failures (delq nil total-list
))
531 (count (length failures
))
532 (string (if (eq op-symbol
'compress
) "Compress or uncompress"
533 (capitalize (symbol-name op-symbol
)))))
535 (message "%s: %d file%s."
536 string total
(dired-plural-s total
))
537 ;; end this bunch of errors:
539 (format "Failed to %s %d of %d file%s"
540 (downcase string
) count total
(dired-plural-s total
))
543 (defvar dired-query-alist
544 '((?\y . y
) (?
\040 . y
) ; `y' or SPC means accept once
545 (?n . n
) (?
\177 . n
) ; `n' or DEL skips once
546 (?
! . yes
) ; `!' accepts rest
547 (?q. no
) (?\e . no
) ; `q' or ESC skips rest
548 ;; None of these keys quit - use C-g for that.
551 (defun dired-query (qs-var qs-prompt
&rest qs-args
)
552 ;; Query user and return nil or t.
553 ;; Store answer in symbol VAR (which must initially be bound to nil).
554 ;; Format PROMPT with ARGS.
555 ;; Binding variable help-form will help the user who types the help key.
556 (let* ((char (symbol-value qs-var
))
557 (action (cdr (assoc char dired-query-alist
))))
558 (cond ((eq 'yes action
)
559 t
) ; accept, and don't ask again
561 nil
) ; skip, and don't ask again
562 (t;; no lasting effects from last time we asked - ask now
563 (let ((qprompt (concat qs-prompt
565 (format " [Type yn!q or %s] "
567 (char-to-string help-char
)))
568 " [Type y, n, q or !] ")))
570 ;; Actually it looks nicer without cursor-in-echo-area - you can
571 ;; look at the dired buffer instead of at the prompt to decide.
572 (apply 'message qprompt qs-args
)
573 (setq char
(set qs-var
(read-char)))
574 (while (not (setq elt
(assoc char dired-query-alist
)))
575 (message "Invalid char - type %c for help." help-char
)
578 (apply 'message qprompt qs-args
)
579 (setq char
(set qs-var
(read-char))))
580 (memq (cdr elt
) '(t y yes
)))))))
583 (defun dired-do-compress (&optional arg
)
584 "Compress or uncompress marked (or next ARG) files."
586 (dired-map-over-marks-check (function dired-compress
) arg
'compress t
))
588 ;; Commands for Emacs Lisp files - load and byte compile
590 (defun dired-byte-compile ()
591 ;; Return nil for success, offending file name else.
592 (let* ((filename (dired-get-filename))
594 (if (eq system-type
'vax-vms
)
595 (concat (substring filename
0 (string-match ";" filename
)) "c")
596 (concat filename
"c")))
597 buffer-read-only failure
)
599 (save-excursion (byte-compile-file filename
))
604 (dired-log "Byte compile error for %s:\n%s\n" filename failure
)
605 (dired-make-relative filename
))
606 (dired-remove-file elc-file
)
607 (forward-line) ; insert .elc after its .el file
608 (dired-add-file elc-file
)
612 (defun dired-do-byte-compile (&optional arg
)
613 "Byte compile marked (or next ARG) Emacs Lisp files."
615 (dired-map-over-marks-check (function dired-byte-compile
) arg
'byte-compile t
))
618 ;; Return nil for success, offending file name else.
619 (let ((file (dired-get-filename)) failure
)
621 (load file nil nil t
)
622 (error (setq failure err
)))
625 (dired-log "Load error for %s:\n%s\n" file failure
)
626 (dired-make-relative file
))))
629 (defun dired-do-load (&optional arg
)
630 "Load the marked (or next ARG) Emacs Lisp files."
632 (dired-map-over-marks-check (function dired-load
) arg
'load t
))
635 (defun dired-do-redisplay (&optional arg test-for-subdir
)
636 "Redisplay all marked (or next ARG) files.
637 If on a subdir line, redisplay that subdirectory. In that case,
638 a prefix arg lets you edit the `ls' switches used for the new listing."
639 ;; Moves point if the next ARG files are redisplayed.
641 (if (and test-for-subdir
(dired-get-subdir))
644 (if arg
(read-string "Switches for listing: " dired-actual-switches
)))
645 (message "Redisplaying...")
646 ;; message much faster than making dired-map-over-marks show progress
647 (dired-map-over-marks (let ((fname (dired-get-filename)))
648 (message "Redisplaying... %s" fname
)
649 (dired-update-file-line fname
))
651 (dired-move-to-filename)
652 (message "Redisplaying...done")))
654 (defun dired-update-file-line (file)
655 ;; Delete the current line, and insert an entry for FILE.
656 ;; If FILE is nil, then just delete the current line.
657 ;; Keeps any marks that may be present in column one (doing this
658 ;; here is faster than with dired-add-entry's optional arg).
659 ;; Does not update other dired buffers. Use dired-relist-entry for that.
661 (let ((char (following-char)) (opoint (point))
663 (delete-region (point) (progn (forward-line 1) (point)))
666 (dired-add-entry file
)
667 ;; Replace space by old marker without moving point.
668 ;; Faster than goto+insdel inside a save-excursion?
669 (subst-char-in-region opoint
(1+ opoint
) ?
\040 char
))))
670 (dired-move-to-filename))
672 (defun dired-fun-in-all-buffers (directory fun
&rest args
)
673 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
674 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
675 (let ((buf-list (dired-buffers-for-dir directory
))
676 (obuf (current-buffer))
679 (setq buf
(car buf-list
)
680 buf-list
(cdr buf-list
))
685 (setq success-list
(cons (buffer-name buf
) success-list
))))
689 (defun dired-add-file (filename &optional marker-char
)
690 (dired-fun-in-all-buffers
691 (file-name-directory filename
)
692 (function dired-add-entry
) filename marker-char
))
694 (defun dired-add-entry (filename &optional marker-char
)
695 ;; Add a new entry for FILENAME, optionally marking it
696 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
697 ;; Note that this adds the entry `out of order' if files sorted by
699 ;; At least this version inserts in the right subdirectory (if present).
700 ;; And it skips "." or ".." (see `dired-trivial-filenames').
701 ;; Hidden subdirs are exposed if a file is added there.
702 (setq filename
(directory-file-name filename
))
703 ;; Entry is always for files, even if they happen to also be directories
704 (let ((opoint (point))
705 (cur-dir (dired-current-directory))
706 (directory (file-name-directory filename
))
708 (setq filename
(file-name-nondirectory filename
)
711 (if (string= directory cur-dir
)
713 (skip-chars-forward "^\r\n")
714 (if (eq (following-char) ?
\r)
715 (dired-unhide-subdir))
716 ;; We are already where we should be, except when
717 ;; point is before the subdir line or its total line.
718 (let ((p (dired-after-subdir-garbage cur-dir
)))
721 ;; else try to find correct place to insert
722 (if (dired-goto-subdir directory
)
723 (progn;; unhide if necessary
724 (if (looking-at "\r");; point is at end of subdir line
725 (dired-unhide-subdir))
726 ;; found - skip subdir and `total' line
727 ;; and uninteresting files like . and ..
728 ;; This better not moves into the next subdir!
729 (dired-goto-next-nontrivial-file))
731 (throw 'not-found
"Subdir not found")))
732 ;; found and point is at The Right Place:
733 (let (buffer-read-only)
735 (dired-add-entry-do-indentation marker-char
)
736 ;; don't expand `.' !
737 (insert-directory (dired-make-absolute filename directory
)
738 (concat dired-actual-switches
"d"))
740 ;; We want to have the non-directory part, only:
741 (let* ((beg (dired-move-to-filename t
)) ; error for strange output
742 (end (dired-move-to-end-of-filename)))
743 (setq filename
(buffer-substring beg end
))
744 (delete-region beg end
)
745 (insert (file-name-nondirectory filename
)))
746 (if dired-after-readin-hook
;; the subdir-alist is not affected...
747 (save-excursion;; ...so we can run it right now:
750 (narrow-to-region (point) (save-excursion
751 (forward-line 1) (point)))
752 (run-hooks 'dired-after-readin-hook
))))
753 (dired-move-to-filename))
754 ;; return nil if all went well
756 (if reason
; don't move away on failure
758 (not reason
))) ; return t on succes, nil else
760 ;; This is a separate function for the sake of nested dired format.
761 (defun dired-add-entry-do-indentation (marker-char)
762 ;; two spaces or a marker plus a space:
763 (insert (if marker-char
764 (if (integerp marker-char
) marker-char dired-marker-char
)
768 (defun dired-after-subdir-garbage (dir)
769 ;; Return pos of first file line of DIR, skipping header and total
770 ;; or wildcard lines.
771 ;; Important: never moves into the next subdir.
772 ;; DIR is assumed to be unhidden.
773 ;; Will probably be redefined for VMS etc.
775 (or (dired-goto-subdir dir
) (error "This cannot happen"))
777 (while (and (not (eolp)) ; don't cross subdir boundary
778 (not (dired-move-to-filename)))
782 (defun dired-remove-file (file)
783 (dired-fun-in-all-buffers
784 (file-name-directory file
) (function dired-remove-entry
) file
))
786 (defun dired-remove-entry (file)
788 (and (dired-goto-file file
)
789 (let (buffer-read-only)
790 (delete-region (progn (beginning-of-line) (point))
791 (save-excursion (forward-line 1) (point)))))))
793 (defun dired-relist-file (file)
794 (dired-fun-in-all-buffers (file-name-directory file
)
795 (function dired-relist-entry
) file
))
797 (defun dired-relist-entry (file)
798 ;; Relist the line for FILE, or just add it if it did not exist.
799 ;; FILE must be an absolute pathname.
800 (let (buffer-read-only marker
)
801 ;; If cursor is already on FILE's line delete-region will cause
802 ;; save-excursion to fail because of floating makers,
803 ;; moving point to beginning of line. Sigh.
805 (and (dired-goto-file file
)
806 (delete-region (progn (beginning-of-line)
807 (setq marker
(following-char))
809 (save-excursion (forward-line 1) (point))))
810 (setq file
(directory-file-name file
))
811 (dired-add-entry file
(if (eq ?
\040 marker
) nil marker
)))))
813 ;;; Copy, move/rename, making hard and symbolic links
815 (defvar dired-backup-overwrite nil
816 "*Non-nil if Dired should ask about making backups before overwriting files.
817 Special value `always' suppresses confirmation.")
819 (defvar dired-overwrite-confirmed
)
821 (defun dired-handle-overwrite (to)
822 ;; Save old version of a to be overwritten file TO.
823 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
824 ;; from dired-create-files.
825 (if (and dired-backup-overwrite
826 dired-overwrite-confirmed
827 (or (eq 'always dired-backup-overwrite
)
828 (dired-query 'overwrite-backup-query
829 (format "Make backup for existing file `%s'? " to
))))
830 (let ((backup (car (find-backup-file-name to
))))
831 (rename-file to backup
0) ; confirm overwrite of old backup
832 (dired-relist-entry backup
))))
834 (defun dired-copy-file (from to ok-flag
)
835 (dired-handle-overwrite to
)
836 (copy-file from to ok-flag dired-copy-preserve-time
))
838 (defun dired-rename-file (from to ok-flag
)
839 (dired-handle-overwrite to
)
840 (rename-file from to ok-flag
) ; error is caught in -create-files
841 ;; Silently rename the visited file of any buffer visiting this file.
842 (and (get-file-buffer from
)
844 (set-buffer (get-file-buffer from
))
845 (let ((modflag (buffer-modified-p)))
846 (set-visited-file-name to
)
847 (set-buffer-modified-p modflag
))))
848 (dired-remove-file from
)
849 ;; See if it's an inserted subdir, and rename that, too.
850 (dired-rename-subdir from to
))
852 (defun dired-rename-subdir (from-dir to-dir
)
853 (setq from-dir
(file-name-as-directory from-dir
)
854 to-dir
(file-name-as-directory to-dir
))
855 (dired-fun-in-all-buffers from-dir
856 (function dired-rename-subdir-1
) from-dir to-dir
)
857 ;; Update visited file name of all affected buffers
858 (let ((blist (buffer-list)))
861 (set-buffer (car blist
))
862 (if (and buffer-file-name
863 (dired-in-this-tree buffer-file-name from-dir
))
864 (let ((modflag (buffer-modified-p))
865 (to-file (dired-replace-in-string
866 (concat "^" (regexp-quote from-dir
))
869 (set-visited-file-name to-file
)
870 (set-buffer-modified-p modflag
))))
871 (setq blist
(cdr blist
)))))
873 (defun dired-rename-subdir-1 (dir to
)
874 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
875 ;; one of its subdirectories is expanded in this buffer.
876 (let ((alist dired-subdir-alist
)
879 (setq elt
(car alist
)
881 (if (dired-in-this-tree (car elt
) dir
)
882 ;; ELT's subdir is affected by the rename
883 (dired-rename-subdir-2 elt dir to
)))
884 (if (equal dir default-directory
)
885 ;; if top level directory was renamed, lots of things have to be
888 (dired-unadvertise dir
) ; we no longer dired DIR...
889 (setq default-directory to
890 dired-directory
(expand-file-name;; this is correct
891 ;; with and without wildcards
892 (file-name-nondirectory dired-directory
)
894 (let ((new-name (file-name-nondirectory
895 (directory-file-name dired-directory
))))
896 ;; try to rename buffer, but just leave old name if new
897 ;; name would already exist (don't try appending "<%d>")
898 (or (get-buffer new-name
)
899 (rename-buffer new-name
)))
900 ;; ... we dired TO now:
901 (dired-advertise)))))
903 (defun dired-rename-subdir-2 (elt dir to
)
904 ;; Update the headerline and dired-subdir-alist element of directory
905 ;; described by alist-element ELT to reflect the moving of DIR to TO.
906 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
908 (let ((regexp (regexp-quote (directory-file-name dir
)))
909 (newtext (directory-file-name to
))
911 (goto-char (dired-get-subdir-min elt
))
912 ;; Update subdir headerline in buffer
913 (if (not (looking-at dired-subdir-regexp
))
914 (error "%s not found where expected - dired-subdir-alist broken?"
916 (goto-char (match-beginning 1))
917 (if (re-search-forward regexp
(match-end 1) t
)
918 (replace-match newtext t t
)
919 (error "Expected to find `%s' in headerline of %s" dir
(car elt
))))
920 ;; Update buffer-local dired-subdir-alist
922 (dired-normalize-subdir
923 (dired-replace-in-string regexp newtext
(car elt
)))))))
925 ;; Cloning replace-match to work on strings instead of in buffer:
926 ;; The FIXEDCASE parameter of replace-match is not implemented.
928 (defun dired-string-replace-match (regexp string newtext
929 &optional literal global
)
930 "Replace first match of REGEXP in STRING with NEWTEXT.
931 If it does not match, nil is returned instead of the new string.
932 Optional arg LITERAL means to take NEWTEXT literally.
933 Optional arg GLOBAL means to replace all matches."
935 (let ((result "") (start 0) mb me
)
936 (while (string-match regexp string start
)
937 (setq mb
(match-beginning 0)
939 result
(concat result
940 (substring string start mb
)
943 (dired-expand-newtext string newtext
)))
945 (if mb
; matched at least once
946 (concat result
(substring string start
))
949 (if (not (string-match regexp string
0))
951 (concat (substring string
0 (match-beginning 0))
952 (if literal newtext
(dired-expand-newtext string newtext
))
953 (substring string
(match-end 0))))))
955 (defun dired-expand-newtext (string newtext
)
956 ;; Expand \& and \1..\9 (referring to STRING) in NEWTEXT, using match data.
957 ;; Note that in Emacs 18 match data are clipped to current buffer
958 ;; size...so the buffer should better not be smaller than STRING.
960 (len (length newtext
))
961 (expanded-newtext ""))
963 (setq expanded-newtext
964 (concat expanded-newtext
965 (let ((c (aref newtext pos
)))
967 (cond ((= ?\
& (setq c
969 (setq pos
(1+ pos
)))))
973 ((and (>= c ?
1) (<= c ?
9))
974 ;; return empty string if N'th
975 ;; sub-regexp did not match:
977 (if (match-beginning n
)
984 (char-to-string c
)))))
988 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
989 (defun dired-create-files (file-creator operation fn-list name-constructor
990 &optional marker-char
)
992 ;; Create a new file for each from a list of existing files. The user
993 ;; is queried, dired buffers are updated, and at the end a success or
994 ;; failure message is displayed
996 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
998 ;; It is called for each file and must create newfile, the entry of
999 ;; which will be added. The user will be queried if the file already
1000 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1001 ;; rename), it is FILE-CREATOR's responsibility to update dired
1002 ;; buffers. FILE-CREATOR must abort by signalling a file-error if it
1003 ;; could not create newfile. The error is caught and logged.
1005 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1006 ;; operation performed. It is used for error logging.
1008 ;; FN-LIST is the list of files to copy (full absolute pathnames).
1010 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1011 ;; skip. If it skips files for other reasons than a direct user
1012 ;; query, it is supposed to tell why (using dired-log).
1014 ;; Optional MARKER-CHAR is a character with which to mark every
1015 ;; newfile's entry, or t to use the current marker character if the
1016 ;; oldfile was marked.
1018 (let (failures skipped
(success-count 0) (total (length fn-list
)))
1019 (let (to overwrite-query
1020 overwrite-backup-query
) ; for dired-handle-overwrite
1024 (setq to
(funcall name-constructor from
))
1028 (dired-log "Cannot %s to same file: %s\n"
1029 (downcase operation
) from
)))
1031 (setq skipped
(cons (dired-make-relative from
) skipped
))
1032 (let* ((overwrite (file-exists-p to
))
1033 (dired-overwrite-confirmed ; for dired-handle-overwrite
1035 (let ((help-form '(format "\
1036 Type SPC or `y' to overwrite file `%s',
1037 DEL or `n' to skip to next,
1038 ESC or `q' to not overwrite any of the remaining files,
1039 `!' to overwrite all remaining files with no more questions." to
)))
1040 (dired-query 'overwrite-query
1041 "Overwrite `%s'?" to
))))
1042 ;; must determine if FROM is marked before file-creator
1043 ;; gets a chance to delete it (in case of a move).
1045 (cond ((integerp marker-char
) marker-char
)
1046 (marker-char (dired-file-marker from
)) ; slow
1050 (funcall file-creator from to dired-overwrite-confirmed
)
1052 ;; If we get here, file-creator hasn't been aborted
1053 ;; and the old entry (if any) has to be deleted
1054 ;; before adding the new entry.
1055 (dired-remove-file to
))
1056 (setq success-count
(1+ success-count
))
1057 (message "%s: %d of %d" operation success-count total
)
1058 (dired-add-file to actual-marker-char
))
1059 (file-error ; FILE-CREATOR aborted
1061 (setq failures
(cons (dired-make-relative from
) failures
))
1062 (dired-log "%s `%s' to `%s' failed:\n%s\n"
1063 operation from to err
))))))))
1068 (format "%s failed for %d of %d file%s"
1069 operation
(length failures
) total
1070 (dired-plural-s total
))
1074 (format "%s: %d of %d file%s skipped"
1075 operation
(length skipped
) total
1076 (dired-plural-s total
))
1079 (message "%s: %s file%s"
1080 operation success-count
(dired-plural-s success-count
)))))
1081 (dired-move-to-filename))
1083 (defun dired-do-create-files (op-symbol file-creator operation arg
1084 &optional marker-char op1
1086 ;; Create a new file for each marked file.
1087 ;; Prompts user for target, which is a directory in which to create
1088 ;; the new files. Target may be a plain file if only one marked
1090 ;; OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1091 ;; will determine wether pop-ups are appropriate for this OP-SYMBOL.
1092 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1093 ;; ARG as in dired-get-marked-files.
1094 ;; Optional arg OP1 is an alternate form for OPERATION if there is
1096 ;; Optional arg MARKER-CHAR as in dired-create-files.
1097 ;; Optional arg HOW-TO determines how to treat target:
1098 ;; If HOW-TO is not given (or nil), and target is a directory, the
1099 ;; file(s) are created inside the target directory. If target
1100 ;; is not a directory, there must be exactly one marked file,
1102 ;; If HOW-TO is t, then target is not modified. There must be
1103 ;; exactly one marked file, else error.
1104 ;; Else HOW-TO is assumed to be a function of one argument, target,
1105 ;; that looks at target and returns a value for the into-dir
1106 ;; variable. The function dired-into-dir-with-symlinks is provided
1107 ;; for the case (common when creating symlinks) that symbolic
1108 ;; links to directories are not to be considered as directories
1109 ;; (as file-directory-p would if HOW-TO had been nil).
1110 (or op1
(setq op1 operation
))
1111 (let* ((fn-list (dired-get-marked-files nil arg
))
1112 (fn-count (length fn-list
))
1113 (target (expand-file-name
1114 (dired-mark-read-file-name
1115 (concat (if (= 1 fn-count
) op1 operation
) " %s to: ")
1116 (dired-dwim-target-directory)
1117 op-symbol arg
(mapcar (function dired-make-relative
) fn-list
))))
1118 (into-dir (cond ((null how-to
) (file-directory-p target
))
1120 (t (funcall how-to target
)))))
1121 (if (and (> fn-count
1)
1123 (error "Marked %s: target must be a directory: %s" operation target
))
1124 ;; rename-file bombs when moving directories unless we do this:
1125 (or into-dir
(setq target
(directory-file-name target
)))
1127 file-creator operation fn-list
1128 (if into-dir
; target is a directory
1129 ;; This function uses fluid vars into-dir and target when called
1130 ;; inside dired-create-files:
1131 (function (lambda (from)
1132 (expand-file-name (file-name-nondirectory from
) target
)))
1133 (function (lambda (from) target
)))
1136 ;; Read arguments for a marked-files command that wants a file name,
1137 ;; perhaps popping up the list of marked files.
1138 ;; ARG is the prefix arg and indicates whether the files came from
1139 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1140 ;; If the current file was used, the list has but one element and ARG
1141 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1143 (defun dired-mark-read-file-name (prompt dir op-symbol arg files
)
1146 (function read-file-name
)
1147 (format prompt
(dired-mark-prompt arg files
)) dir
))
1149 (defun dired-dwim-target-directory ()
1150 ;; Try to guess which target directory the user may want.
1151 ;; If there is a dired buffer displayed in the next window, use
1152 ;; its current subdir, else use current subdir of this dired buffer.
1153 (let ((this-dir (and (eq major-mode
'dired-mode
)
1154 (dired-current-directory))))
1155 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1156 (if dired-dwim-target
1157 (let* ((other-buf (window-buffer (next-window)))
1158 (other-dir (save-excursion
1159 (set-buffer other-buf
)
1160 (and (eq major-mode
'dired-mode
)
1161 (dired-current-directory)))))
1162 (or other-dir this-dir
))
1166 (defun dired-create-directory (directory)
1167 "Create a directory called DIRECTORY."
1169 (list (read-file-name "Create directory: " (dired-current-directory))))
1170 (let ((expanded (directory-file-name (expand-file-name directory
))))
1171 (make-directory expanded
)
1172 (dired-add-file expanded
)
1173 (dired-move-to-filename)))
1175 (defun dired-into-dir-with-symlinks (target)
1176 (and (file-directory-p target
)
1177 (not (file-symlink-p target
))))
1178 ;; This may not always be what you want, especially if target is your
1179 ;; home directory and it happens to be a symbolic link, as is often the
1180 ;; case with NFS and automounters. Or if you want to make symlinks
1181 ;; into directories that themselves are only symlinks, also quite
1184 ;; So we don't use this function as value for HOW-TO in
1185 ;; dired-do-symlink, which has the minor disadvantage of
1186 ;; making links *into* a symlinked-dir, when you really wanted to
1187 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1188 ;; just have to remove that symlink by hand before making your marked
1192 (defun dired-do-copy (&optional arg
)
1193 "Copy all marked (or next ARG) files, or copy the current file.
1194 This normally preserves the last-modified date when copying.
1195 When operating on just the current file, you specify the new name.
1196 When operating on multiple or marked files, you specify a directory
1197 and new symbolic links are made in that directory
1198 with the same names that the files currently have."
1200 (dired-do-create-files 'copy
(function dired-copy-file
)
1201 (if dired-copy-preserve-time
"Copy [-p]" "Copy")
1202 arg dired-keep-marker-copy
))
1205 (defun dired-do-symlink (&optional arg
)
1206 "Make symbolic links to current file or all marked (or next ARG) files.
1207 When operating on just the current file, you specify the new name.
1208 When operating on multiple or marked files, you specify a directory
1209 and new symbolic links are made in that directory
1210 with the same names that the files currently have."
1212 (dired-do-create-files 'symlink
(function make-symbolic-link
)
1213 "Symlink" arg dired-keep-marker-symlink
))
1216 (defun dired-do-hardlink (&optional arg
)
1217 "Add names (hard links) current file or all marked (or next ARG) files.
1218 When operating on just the current file, you specify the new name.
1219 When operating on multiple or marked files, you specify a directory
1220 and new hard links are made in that directory
1221 with the same names that the files currently have."
1223 (dired-do-create-files 'hardlink
(function add-name-to-file
)
1224 "Hardlink" arg dired-keep-marker-hardlink
))
1227 (defun dired-do-rename (&optional arg
)
1228 "Rename current file or all marked (or next ARG) files.
1229 When renaming just the current file, you specify the new name.
1230 When renaming multiple or marked files, you specify a directory."
1232 (dired-do-create-files 'move
(function dired-rename-file
)
1233 "Move" arg dired-keep-marker-rename
"Rename"))
1234 ;;;###end dired-cp.el
1237 ;;;###begin dired-re.el
1238 (defun dired-do-create-files-regexp
1239 (file-creator operation arg regexp newname
&optional whole-path marker-char
)
1240 ;; Create a new file for each marked file using regexps.
1241 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1242 ;; ARG as in dired-get-marked-files.
1243 ;; Matches each marked file against REGEXP and constructs the new
1244 ;; filename from NEWNAME (like in function replace-match).
1245 ;; Optional arg WHOLE-PATH means match/replace the whole pathname
1246 ;; instead of only the non-directory part of the file.
1247 ;; Optional arg MARKER-CHAR as in dired-create-files.
1248 (let* ((fn-list (dired-get-marked-files nil arg
))
1249 (fn-count (length fn-list
))
1250 (operation-prompt (concat operation
" `%s' to `%s'?"))
1251 (rename-regexp-help-form (format "\
1252 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1253 `!' to %s all remaining matches with no more questions."
1254 (downcase operation
)
1255 (downcase operation
)))
1256 (regexp-name-constructor
1257 ;; Function to construct new filename using REGEXP and NEWNAME:
1258 (if whole-path
; easy (but rare) case
1261 (let ((to (dired-string-replace-match regexp from newname
))
1262 ;; must bind help-form directly around call to
1264 (help-form rename-regexp-help-form
))
1266 (and (dired-query 'rename-regexp-query
1271 (dired-log "%s: %s did not match regexp %s\n"
1272 operation from regexp
)))))
1273 ;; not whole-path, replace non-directory part only
1276 (let* ((new (dired-string-replace-match
1277 regexp
(file-name-nondirectory from
) newname
))
1278 (to (and new
; nil means there was no match
1279 (expand-file-name new
1280 (file-name-directory from
))))
1281 (help-form rename-regexp-help-form
))
1283 (and (dired-query 'rename-regexp-query
1285 (dired-make-relative from
)
1286 (dired-make-relative to
))
1288 (dired-log "%s: %s did not match regexp %s\n"
1289 operation
(file-name-nondirectory from
) regexp
)))))))
1290 rename-regexp-query
)
1292 file-creator operation fn-list regexp-name-constructor marker-char
)))
1294 (defun dired-mark-read-regexp (operation)
1295 ;; Prompt user about performing OPERATION.
1296 ;; Read and return list of: regexp newname arg whole-path.
1298 (equal 0 (prefix-numeric-value current-prefix-arg
)))
1300 (if whole-path nil current-prefix-arg
))
1303 (concat (if whole-path
"Path " "") operation
" from (regexp): ")))
1306 (concat (if whole-path
"Path " "") operation
" " regexp
" to: "))))
1307 (list regexp newname arg whole-path
)))
1310 (defun dired-do-rename-regexp (regexp newname
&optional arg whole-path
)
1311 "Rename marked files containing REGEXP to NEWNAME.
1312 As each match is found, the user must type a character saying
1313 what to do with it. For directions, type \\[help-command] at that time.
1314 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
1315 REGEXP defaults to the last regexp used.
1316 With a zero prefix arg, renaming by regexp affects the complete
1317 pathname - usually only the non-directory part of file names is used
1319 (interactive (dired-mark-read-regexp "Rename"))
1320 (dired-do-create-files-regexp
1321 (function dired-rename-file
)
1322 "Rename" arg regexp newname whole-path dired-keep-marker-rename
))
1325 (defun dired-do-copy-regexp (regexp newname
&optional arg whole-path
)
1326 "Copy all marked files containing REGEXP to NEWNAME.
1327 See function `dired-rename-regexp' for more info."
1328 (interactive (dired-mark-read-regexp "Copy"))
1329 (dired-do-create-files-regexp
1330 (function dired-copy-file
)
1331 (if dired-copy-preserve-time
"Copy [-p]" "Copy")
1332 arg regexp newname whole-path dired-keep-marker-copy
))
1335 (defun dired-do-hardlink-regexp (regexp newname
&optional arg whole-path
)
1336 "Hardlink all marked files containing REGEXP to NEWNAME.
1337 See function `dired-rename-regexp' for more info."
1338 (interactive (dired-mark-read-regexp "HardLink"))
1339 (dired-do-create-files-regexp
1340 (function add-name-to-file
)
1341 "HardLink" arg regexp newname whole-path dired-keep-marker-hardlink
))
1344 (defun dired-do-symlink-regexp (regexp newname
&optional arg whole-path
)
1345 "Symlink all marked files containing REGEXP to NEWNAME.
1346 See function `dired-rename-regexp' for more info."
1347 (interactive (dired-mark-read-regexp "SymLink"))
1348 (dired-do-create-files-regexp
1349 (function make-symbolic-link
)
1350 "SymLink" arg regexp newname whole-path dired-keep-marker-symlink
))
1352 (defun dired-create-files-non-directory
1353 (file-creator basename-constructor operation arg
)
1354 ;; Perform FILE-CREATOR on the non-directory part of marked files
1355 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1356 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1357 (let (rename-non-directory-query)
1361 (dired-get-marked-files nil arg
)
1364 (let ((to (concat (file-name-directory from
)
1365 (funcall basename-constructor
1366 (file-name-nondirectory from
)))))
1367 (and (let ((help-form (format "\
1368 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1369 `!' to %s all remaining matches with no more questions."
1370 (downcase operation
)
1371 (downcase operation
))))
1372 (dired-query 'rename-non-directory-query
1373 (concat operation
" `%s' to `%s'")
1374 (dired-make-relative from
)
1375 (dired-make-relative to
)))
1377 dired-keep-marker-rename
)))
1379 (defun dired-rename-non-directory (basename-constructor operation arg
)
1380 (dired-create-files-non-directory
1381 (function dired-rename-file
)
1382 basename-constructor operation arg
))
1385 (defun dired-upcase (&optional arg
)
1386 "Rename all marked (or next ARG) files to upper case."
1388 (dired-rename-non-directory (function upcase
) "Rename upcase" arg
))
1391 (defun dired-downcase (&optional arg
)
1392 "Rename all marked (or next ARG) files to lower case."
1394 (dired-rename-non-directory (function downcase
) "Rename downcase" arg
))
1396 ;;;###end dired-re.el
1399 ;;;###begin dired-ins.el
1402 (defun dired-maybe-insert-subdir (dirname &optional
1403 switches no-error-if-not-dir-p
)
1404 "Insert this subdirectory into the same dired buffer.
1405 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
1406 else inserts it at its natural place (as `ls -lR' would have done).
1407 With a prefix arg, you may edit the ls switches used for this listing.
1408 You can add `R' to the switches to expand the whole tree starting at
1410 This function takes some pains to conform to `ls -lR' output."
1412 (list (dired-get-filename)
1413 (if current-prefix-arg
1414 (read-string "Switches for listing: " dired-actual-switches
))))
1415 (let ((opoint (point)))
1416 ;; We don't need a marker for opoint as the subdir is always
1417 ;; inserted *after* opoint.
1418 (setq dirname
(file-name-as-directory dirname
))
1419 (or (and (not switches
)
1420 (dired-goto-subdir dirname
))
1421 (dired-insert-subdir dirname switches no-error-if-not-dir-p
))
1422 ;; Push mark so that it's easy to find back. Do this after the
1423 ;; insert message so that the user sees the `Mark set' message.
1424 (push-mark opoint
)))
1426 (defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p
)
1427 "Insert this subdirectory into the same dired buffer.
1428 If it is already present, overwrites previous entry,
1429 else inserts it at its natural place (as `ls -lR' would have done).
1430 With a prefix arg, you may edit the `ls' switches used for this listing.
1431 You can add `R' to the switches to expand the whole tree starting at
1433 This function takes some pains to conform to `ls -lR' output."
1434 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1435 ;; Prospero where dired-ls does the right thing, but
1436 ;; file-directory-p has not been redefined.
1438 (list (dired-get-filename)
1439 (if current-prefix-arg
1440 (read-string "Switches for listing: " dired-actual-switches
))))
1441 (setq dirname
(file-name-as-directory (expand-file-name dirname
)))
1442 (dired-insert-subdir-validate dirname switches
)
1443 (or no-error-if-not-dir-p
1444 (file-directory-p dirname
)
1445 (error "Attempt to insert a non-directory: %s" dirname
))
1446 (let ((elt (assoc dirname dired-subdir-alist
))
1447 switches-have-R mark-alist case-fold-search buffer-read-only
)
1448 ;; case-fold-search is nil now, so we can test for capital `R':
1449 (if (setq switches-have-R
(and switches
(string-match "R" switches
)))
1450 ;; avoid duplicated subdirs
1451 (setq mark-alist
(dired-kill-tree dirname t
)))
1453 ;; If subdir is already present, remove it and remember its marks
1454 (setq mark-alist
(nconc (dired-insert-subdir-del elt
) mark-alist
))
1455 (dired-insert-subdir-newpos dirname
)) ; else compute new position
1456 (dired-insert-subdir-doupdate
1457 dirname elt
(dired-insert-subdir-doinsert dirname switches
))
1458 (if switches-have-R
(dired-build-subdir-alist))
1459 (dired-initial-position dirname
)
1460 (save-excursion (dired-mark-remembered mark-alist
))))
1462 ;; This is a separate function for dired-vms.
1463 (defun dired-insert-subdir-validate (dirname &optional switches
)
1464 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1465 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1466 (or (dired-in-this-tree dirname default-directory
)
1467 (error "%s: not in this directory tree" dirname
))
1469 (let (case-fold-search)
1473 (or (eq (null (string-match x switches
))
1474 (null (string-match x dired-actual-switches
)))
1475 (error "Can't have dirs with and without -%s switches together"
1477 ;; all switches that make a difference to dired-get-filename:
1480 (defun dired-alist-add (dir new-marker
)
1481 ;; Add new DIR at NEW-MARKER. Sort alist.
1482 (dired-alist-add-1 dir new-marker
)
1485 (defun dired-alist-sort ()
1486 ;; Keep the alist sorted on buffer position.
1487 (setq dired-subdir-alist
1488 (sort dired-subdir-alist
1489 (function (lambda (elt1 elt2
)
1490 (> (dired-get-subdir-min elt1
)
1491 (dired-get-subdir-min elt2
)))))))
1493 (defun dired-kill-tree (dirname &optional remember-marks
)
1494 ;;"Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1495 ;; With optional arg REMEMBER-MARKS, return an alist of marked files."
1496 (interactive "DKill tree below directory: ")
1497 (let ((s-alist dired-subdir-alist
) dir m-alist
)
1499 (setq dir
(car (car s-alist
))
1500 s-alist
(cdr s-alist
))
1501 (if (and (not (string-equal dir dirname
))
1502 (dired-in-this-tree dir dirname
)
1503 (dired-goto-subdir dir
))
1504 (setq m-alist
(nconc (dired-kill-subdir remember-marks
) m-alist
))))
1507 (defun dired-insert-subdir-newpos (new-dir)
1508 ;; Find pos for new subdir, according to tree order.
1509 ;;(goto-char (point-max))
1510 (let ((alist dired-subdir-alist
) elt dir pos new-pos
)
1512 (setq elt
(car alist
)
1515 pos
(dired-get-subdir-min elt
))
1516 (if (dired-tree-lessp dir new-dir
)
1517 ;; Insert NEW-DIR after DIR
1518 (setq new-pos
(dired-get-subdir-max elt
)
1520 (goto-char new-pos
))
1521 ;; want a separating newline between subdirs
1527 (defun dired-insert-subdir-del (element)
1528 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1529 ;; Move to that buffer position. Return a mark-alist.
1530 (let ((begin-marker (dired-get-subdir-min element
)))
1531 (goto-char begin-marker
)
1532 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1533 (goto-char (dired-subdir-max))
1534 (or (eobp);; want a separating newline _between_ subdirs:
1537 (dired-remember-marks begin-marker
(point))
1538 (delete-region begin-marker
(point)))))
1540 (defun dired-insert-subdir-doinsert (dirname switches
)
1541 ;; Insert ls output after point and put point on the correct
1542 ;; position for the subdir alist.
1543 ;; Return the boundary of the inserted text (as list of BEG and END).
1544 (let ((begin (point)) end
)
1545 (message "Reading directory %s..." dirname
)
1546 (let ((dired-actual-switches
1548 (dired-replace-in-string "R" "" dired-actual-switches
))))
1549 (if (equal dirname
(car (car (reverse dired-subdir-alist
))))
1550 ;; top level directory may contain wildcards:
1551 (dired-readin-insert dired-directory
)
1552 (insert-directory dirname dired-actual-switches nil t
)))
1553 (message "Reading directory %s...done" dirname
)
1554 (setq end
(point-marker))
1555 (indent-rigidly begin end
2)
1556 ;; call dired-insert-headerline afterwards, as under VMS dired-ls
1557 ;; does insert the headerline itself and the insert function just
1559 ;; Need a marker for END as this inserts text.
1561 (dired-insert-headerline dirname
)
1562 ;; point is now like in dired-build-subdir-alist
1564 (list begin
(marker-position end
))
1565 (set-marker end nil
))))
1567 (defun dired-insert-subdir-doupdate (dirname elt beg-end
)
1568 ;; Point is at the correct subdir alist position for ELT,
1569 ;; BEG-END is the subdir-region (as list of begin and end).
1570 (if elt
; subdir was already present
1571 ;; update its position (should actually be unchanged)
1572 (set-marker (dired-get-subdir-min elt
) (point-marker))
1573 (dired-alist-add dirname
(point-marker)))
1574 ;; The hook may depend on the subdir-alist containing the just
1575 ;; inserted subdir, so run it after dired-alist-add:
1576 (if dired-after-readin-hook
1578 (let ((begin (nth 0 beg-end
))
1579 (end (nth 1 beg-end
)))
1582 (narrow-to-region begin end
)
1583 ;; hook may add or delete lines, but the subdir boundary
1585 (run-hooks 'dired-after-readin-hook
))))))
1587 (defun dired-tree-lessp (dir1 dir2
)
1588 ;; Lexicographic order on pathname components, like `ls -lR':
1589 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1590 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1591 ;; or DIR1 and DIR2 are in the same parentdir and their last
1592 ;; components are string-lessp.
1593 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1594 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1595 ;; if dired-actual-switches contained `t'.
1596 (setq dir1
(file-name-as-directory dir1
)
1597 dir2
(file-name-as-directory dir2
))
1598 (let ((components-1 (dired-split "/" dir1
))
1599 (components-2 (dired-split "/" dir2
)))
1600 (while (and components-1
1602 (equal (car components-1
) (car components-2
)))
1603 (setq components-1
(cdr components-1
)
1604 components-2
(cdr components-2
)))
1605 (let ((c1 (car components-1
))
1606 (c2 (car components-2
)))
1609 (string-lessp c1 c2
))
1610 ((and (null c1
) (null c2
))
1611 nil
) ; they are equal, not lessp
1612 ((null c1
) ; c2 is a subdir of c1: c1<c2
1614 ((null c2
) ; c1 is a subdir of c2: c1>c2
1616 (t (error "This can't happen"))))))
1618 ;; There should be a builtin split function - inverse to mapconcat.
1619 (defun dired-split (pat str
&optional limit
)
1620 "Splitting on regexp PAT, turn string STR into a list of substrings.
1621 Optional third arg LIMIT (>= 1) is a limit to the length of the
1623 Thus, if SEP is a regexp that only matches itself,
1625 (mapconcat 'identity (dired-split SEP STRING) SEP)
1627 is always equal to STRING."
1628 (let* ((start (string-match pat str
))
1629 (result (list (substring str
0 start
)))
1631 (end (if start
(match-end 0))))
1632 (if end
; else nothing left
1633 (while (and (or (not (integerp limit
))
1635 (string-match pat str end
))
1636 (setq start
(match-beginning 0)
1638 result
(cons (substring str end start
) result
)
1642 (if (and (or (not (integerp limit
))
1644 end
) ; else nothing left
1646 (cons (substring str end
) result
)))
1649 ;;; moving by subdirectories
1652 (defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip
)
1653 "Go to previous subdirectory, regardless of level.
1654 When called interactively and not on a subdir line, go to this subdir's line."
1657 (list (if current-prefix-arg
1658 (prefix-numeric-value current-prefix-arg
)
1659 ;; if on subdir start already, don't stay there!
1660 (if (dired-get-subdir) 1 0))))
1661 (dired-next-subdir (- arg
) no-error-if-not-found no-skip
))
1663 (defun dired-subdir-min ()
1665 (if (not (dired-prev-subdir 0 t t
))
1666 (error "Not in a subdir!")
1670 (defun dired-goto-subdir (dir)
1671 "Go to end of header line of DIR in this dired buffer.
1672 Return value of point on success, otherwise return nil.
1673 The next char is either \\n, or \\r if DIR is hidden."
1675 (prog1 ; let push-mark display its message
1676 (list (expand-file-name
1677 (completing-read "Goto in situ directory: " ; prompt
1678 dired-subdir-alist
; table
1681 (dired-current-directory))))
1683 (setq dir
(file-name-as-directory dir
))
1684 (let ((elt (assoc dir dired-subdir-alist
)))
1686 (goto-char (dired-get-subdir-min elt
))
1687 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1688 ;; at either \r or \n after this function succeeds.
1689 (progn (skip-chars-forward "^\r\n")
1693 (defun dired-mark-subdir-files ()
1694 "Mark all files except `.' and `..'."
1696 (let ((p-min (dired-subdir-min)))
1697 (dired-mark-files-in-region p-min
(dired-subdir-max))))
1700 (defun dired-kill-subdir (&optional remember-marks
)
1701 "Remove all lines of current subdirectory.
1702 Lower levels are unaffected."
1703 ;; With optional REMEMBER-MARKS, return a mark-alist.
1705 (let ((beg (dired-subdir-min))
1706 (end (dired-subdir-max))
1707 buffer-read-only cur-dir
)
1708 (setq cur-dir
(dired-current-directory))
1709 (if (equal cur-dir default-directory
)
1710 (error "Attempt to kill top level directory"))
1712 (if remember-marks
(dired-remember-marks beg end
))
1713 (delete-region beg end
)
1714 (if (eobp) ; don't leave final blank line
1716 (dired-unsubdir cur-dir
))))
1718 (defun dired-unsubdir (dir)
1719 ;; Remove DIR from the alist
1720 (setq dired-subdir-alist
1721 (delq (assoc dir dired-subdir-alist
) dired-subdir-alist
)))
1724 (defun dired-tree-up (arg)
1725 "Go up ARG levels in the dired tree."
1727 (let ((dir (dired-current-directory)))
1730 dir
(file-name-directory (directory-file-name dir
))))
1731 ;;(setq dir (expand-file-name dir))
1732 (or (dired-goto-subdir dir
)
1733 (error "Cannot go up to %s - not in this tree." dir
))))
1736 (defun dired-tree-down ()
1737 "Go down in the dired tree."
1739 (let ((dir (dired-current-directory)) ; has slash
1740 pos case-fold-search
) ; filenames are case sensitive
1741 (let ((rest (reverse dired-subdir-alist
)) elt
)
1743 (setq elt
(car rest
)
1745 (if (dired-in-this-tree (directory-file-name (car elt
)) dir
)
1747 pos
(dired-goto-subdir (car elt
))))))
1750 (error "At the bottom"))))
1754 (defun dired-unhide-subdir ()
1755 (let (buffer-read-only)
1756 (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?
\r ?
\n)))
1758 (defun dired-hide-check ()
1759 (or selective-display
1760 (error "selective-display must be t for subdir hiding to work!")))
1762 (defun dired-subdir-hidden-p (dir)
1763 (and selective-display
1765 (dired-goto-subdir dir
)
1766 (looking-at "\r"))))
1769 (defun dired-hide-subdir (arg)
1770 "Hide or unhide the current subdirectory and move to next directory.
1771 Optional prefix arg is a repeat factor.
1772 Use \\[dired-hide-all] to (un)hide all directories."
1775 (while (>= (setq arg
(1- arg
)) 0)
1776 (let* ((cur-dir (dired-current-directory))
1777 (hidden-p (dired-subdir-hidden-p cur-dir
))
1778 (elt (assoc cur-dir dired-subdir-alist
))
1779 (end-pos (1- (dired-get-subdir-max elt
)))
1781 ;; keep header line visible, hide rest
1782 (goto-char (dired-get-subdir-min elt
))
1783 (skip-chars-forward "^\n\r")
1785 (subst-char-in-region (point) end-pos ?
\r ?
\n)
1786 (subst-char-in-region (point) end-pos ?
\n ?
\r)))
1787 (dired-next-subdir 1 t
)))
1790 (defun dired-hide-all (arg)
1791 "Hide all subdirectories, leaving only their header lines.
1792 If there is already something hidden, make everything visible again.
1793 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
1796 (let (buffer-read-only)
1798 (goto-char (point-min))
1799 (search-forward "\r" nil t
))
1800 ;; unhide - bombs on \r in filenames
1801 (subst-char-in-region (point-min) (point-max) ?
\r ?
\n)
1803 (let ((pos (point-max)) ; pos of end of last directory
1804 (alist dired-subdir-alist
))
1805 (while alist
; while there are dirs before pos
1806 (subst-char-in-region (dired-get-subdir-min (car alist
)) ; pos of prev dir
1808 (goto-char pos
) ; current dir
1809 ;; we're somewhere on current dir's line
1813 (setq pos
(dired-get-subdir-min (car alist
))) ; prev dir gets current dir
1814 (setq alist
(cdr alist
)))))))
1816 ;;;###end dired-ins.el
1818 ;;; dired-aux.el ends here
HCoop / bpt / emacs.git / blob