1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; The parts of dired mode not normally used. This is a space-saving hack
30 ;; to avoid having to load a large mode when all that's wanted are a few
33 ;; Rewritten in 1990/1991 to add tree features, file marking and
34 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
35 ;; Finished up by rms in 1992.
39 ;; We need macros in dired.el to compile properly.
40 (eval-when-compile (require 'dired
))
43 ;;;###begin dired-cmd.el
44 ;; Diffing and compressing
46 (defconst dired-star-subst-regexp
"\\(^\\|[ \t]\\)\\*\\([ \t]\\|$\\)")
47 (defconst dired-quark-subst-regexp
"\\(^\\|[ \t]\\)\\?\\([ \t]\\|$\\)")
50 (defun dired-diff (file &optional switches
)
51 "Compare file at point with file FILE using `diff'.
52 FILE defaults to the file at the mark. (That's the mark set by
53 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
54 The prompted-for file is the first file given to `diff'.
55 With prefix arg, prompt for second argument SWITCHES,
56 which is options for `diff'."
58 (let ((default (if (mark t
)
59 (save-excursion (goto-char (mark t
))
60 (dired-get-filename t t
)))))
62 (list (read-file-name (format "Diff %s with: %s"
63 (dired-get-filename t
)
65 (concat "(default " default
") ")
68 (dired-current-directory)
69 (dired-dwim-target-directory))
71 (if current-prefix-arg
72 (read-string "Options for diff: "
73 (if (stringp diff-switches
)
75 (mapconcat 'identity diff-switches
" ")))))))
76 (diff file
(dired-get-filename t
) switches
))
79 (defun dired-backup-diff (&optional switches
)
80 "Diff this file with its backup file or vice versa.
81 Uses the latest backup, if there are several numerical backups.
82 If this file is a backup, diff it with its original.
83 The backup file is the first file given to `diff'.
84 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
86 (if current-prefix-arg
87 (list (read-string "Options for diff: "
88 (if (stringp diff-switches
)
90 (mapconcat 'identity diff-switches
" "))))
92 (diff-backup (dired-get-filename) switches
))
94 (defun dired-compare-directories (dir2 predicate
)
95 "Mark files with different file attributes in two dired buffers.
96 Compare file attributes of files in the current directory
97 with file attributes in directory DIR2 using PREDICATE on pairs of files
98 with the same name. Mark files for which PREDICATE returns non-nil.
99 Mark files with different names if PREDICATE is nil (or interactively
100 when the user enters empty input at the predicate prompt).
102 PREDICATE is a Lisp expression that can refer to the following variables:
104 size1, size2 - file size in bytes
105 mtime1, mtime2 - last modification time in seconds, as a float
106 fa1, fa2 - list of file attributes
107 returned by function `file-attributes'
109 where 1 refers to attribute of file in the current dired buffer
110 and 2 to attribute of file in second dired buffer.
112 Examples of PREDICATE:
114 (> mtime1 mtime2) - mark newer files
115 (not (= size1 size2)) - mark files with different sizes
116 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
117 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
118 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
120 (list (read-file-name (format "Compare %s with: "
121 (dired-current-directory))
122 (dired-dwim-target-directory))
123 (read-from-minibuffer "Mark if (lisp expr or RET): " nil nil t nil
"nil")))
124 (let* ((dir1 (dired-current-directory))
125 (file-alist1 (dired-files-attributes dir1
))
126 (file-alist2 (dired-files-attributes dir2
))
129 (dired-file-set-difference
130 file-alist1 file-alist2
134 (dired-file-set-difference
135 file-alist2 file-alist1
137 (dired-fun-in-all-buffers
141 (member (dired-get-filename nil t
) file-list1
) nil
)))
142 (dired-fun-in-all-buffers
146 (member (dired-get-filename nil t
) file-list2
) nil
)))
147 (message "Marked in dir1: %s files, in dir2: %s files"
149 (length file-list2
))))
151 (defun dired-file-set-difference (list1 list2 predicate
)
152 "Combine LIST1 and LIST2 using a set-difference operation.
153 The result list contains all file items that appear in LIST1 but not LIST2.
154 This is a non-destructive function; it makes a copy of the data if necessary
155 to avoid corrupting the original LIST1 and LIST2.
156 PREDICATE (see `dired-compare-directories') is an additional match
157 condition. Two file items are considered to match if they are equal
158 *and* PREDICATE evaluates to t."
159 (if (or (null list1
) (null list2
))
162 (dolist (file1 list1
)
163 (unless (let ((list list2
))
165 (not (let* ((file2 (car list
))
170 (mtime1 (float-time (nth 5 fa1
)))
171 (mtime2 (float-time (nth 5 fa2
))))
173 (equal (car file1
) (car file2
))
174 (not (eval predicate
))))))
175 (setq list
(cdr list
)))
177 (setq res
(cons file1 res
))))
180 (defun dired-files-attributes (dir)
181 "Return a list of all file names and attributes from DIR.
182 List has a form of (file-name full-file-name (attribute-list))"
185 (let ((full-file-name (expand-file-name file-name dir
)))
188 (file-attributes full-file-name
))))
189 (directory-files dir
)))
192 (defun dired-touch-initial (files)
193 "Create initial input value for `touch' command."
196 (let ((current (nth 5 (file-attributes (car files
)))))
197 (if (and initial
(not (equal initial current
)))
198 (setq initial
(current-time) files nil
)
199 (setq initial current
))
200 (setq files
(cdr files
))))
201 (format-time-string "%Y%m%d%H%M.%S" initial
)))
203 (defun dired-do-chxxx (attribute-name program op-symbol arg
)
204 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
205 ;; refresh their file lines.
206 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
207 ;; PROGRAM is the program used to change the attribute.
208 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
209 ;; ARG describes which files to use, as in dired-get-marked-files.
210 (let* ((files (dired-get-marked-files t arg
))
212 (dired-mark-read-string
213 (concat "Change " attribute-name
" of %s to: ")
214 (if (eq op-symbol
'touch
) (dired-touch-initial files
))
215 op-symbol arg files
))
216 (operation (concat program
" " new-attribute
))
219 (dired-bunch-files 10000
220 (function dired-check-process
)
222 (list operation program
)
223 (if (eq op-symbol
'touch
)
226 (if (string-match "gnu" system-configuration
)
229 (dired-do-redisplay arg
);; moves point if ARG is an integer
232 (format "%s: error" operation
)
236 (defun dired-do-chmod (&optional arg
)
237 "Change the mode of the marked (or next ARG) files.
238 This calls chmod, thus symbolic modes like `g+w' are allowed."
240 (dired-do-chxxx "Mode" dired-chmod-program
'chmod arg
))
243 (defun dired-do-chgrp (&optional arg
)
244 "Change the group of the marked (or next ARG) files."
246 (if (memq system-type
'(ms-dos windows-nt
))
247 (error "chgrp not supported on this system"))
248 (dired-do-chxxx "Group" "chgrp" 'chgrp arg
))
251 (defun dired-do-chown (&optional arg
)
252 "Change the owner of the marked (or next ARG) files."
254 (if (memq system-type
'(ms-dos windows-nt
))
255 (error "chown not supported on this system"))
256 (dired-do-chxxx "Owner" dired-chown-program
'chown arg
))
258 (defun dired-do-touch (&optional arg
)
259 "Change the timestamp of the marked (or next ARG) files.
262 (dired-do-chxxx "Timestamp" dired-touch-program
'touch arg
))
264 ;; Process all the files in FILES in batches of a convenient size,
265 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
266 ;; Batches are chosen to need less than MAX chars for the file names,
267 ;; allowing 3 extra characters of separator per file name.
268 (defun dired-bunch-files (max function args files
)
273 ;; Accumulate files as long as they fit in MAX chars,
274 ;; then process the ones accumulated so far.
276 (let* ((thisfile (car files
))
277 (thislength (+ (length thisfile
) 3))
279 ;; If we have at least 1 pending file
280 ;; and this file won't fit in the length limit, process now.
281 (if (and pending
(> (+ thislength pending-length
) max
))
282 (setq pending
(nreverse pending
)
283 ;; The elements of PENDING are now in forward order.
284 ;; Do the operation and record failures.
285 failures
(nconc (apply function
(append args pending
))
287 ;; Transfer the elemens of PENDING onto PAST
288 ;; and clear it out. Now PAST contains the first N files
289 ;; specified (for some N), and FILES contains the rest.
290 past
(nconc past pending
)
293 ;; Do (setq pending (cons thisfile pending))
294 ;; but reuse the cons that was in `files'.
295 (setcdr files pending
)
297 (setq pending-length
(+ thislength pending-length
))
299 (setq pending
(nreverse pending
))
301 (nconc (apply function
(append args pending
))
303 ;; Now the original list FILES has been put back as it was.
304 (nconc past pending
))))
307 (defun dired-do-print (&optional arg
)
308 "Print the marked (or next ARG) files.
309 Uses the shell command coming from variables `lpr-command' and
310 `lpr-switches' as default."
312 (let* ((file-list (dired-get-marked-files t arg
))
313 (command (dired-mark-read-string
317 (if (stringp lpr-switches
)
321 'print arg file-list
)))
322 (dired-run-shell-command (dired-shell-stuff-it command file-list nil
))))
324 ;; Read arguments for a marked-files command that wants a string
325 ;; that is not a file name,
326 ;; perhaps popping up the list of marked files.
327 ;; ARG is the prefix arg and indicates whether the files came from
328 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
329 ;; If the current file was used, the list has but one element and ARG
330 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
332 (defun dired-mark-read-string (prompt initial op-symbol arg files
)
333 ;; PROMPT for a string, with INITIAL input.
334 ;; Other args are used to give user feedback and pop-up:
335 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
338 (function read-string
)
339 (format prompt
(dired-mark-prompt arg files
)) initial
))
341 ;;; Cleaning a directory: flagging some backups for deletion.
343 (defvar dired-file-version-alist
)
345 (defun dired-clean-directory (keep)
346 "Flag numerical backups for deletion.
347 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
348 Positive prefix arg KEEP overrides `dired-kept-versions';
349 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
351 To clear the flags on these files, you can use \\[dired-flag-backup-files]
352 with a prefix argument."
354 (setq keep
(if keep
(prefix-numeric-value keep
) dired-kept-versions
))
355 (let ((early-retention (if (< keep
0) (- keep
) kept-old-versions
))
356 (late-retention (if (<= keep
0) dired-kept-versions keep
))
357 (dired-file-version-alist ()))
358 (message "Cleaning numerical backups (keeping %d late, %d old)..."
359 late-retention early-retention
)
360 ;; Look at each file.
361 ;; If the file has numeric backup versions,
362 ;; put on dired-file-version-alist an element of the form
363 ;; (FILENAME . VERSION-NUMBER-LIST)
364 (dired-map-dired-file-lines (function dired-collect-file-versions
))
365 ;; Sort each VERSION-NUMBER-LIST,
366 ;; and remove the versions not to be deleted.
367 (let ((fval dired-file-version-alist
))
369 (let* ((sorted-v-list (cons 'q
(sort (cdr (car fval
)) '<)))
370 (v-count (length sorted-v-list
)))
371 (if (> v-count
(+ early-retention late-retention
))
372 (rplacd (nthcdr early-retention sorted-v-list
)
373 (nthcdr (- v-count late-retention
)
376 (cdr sorted-v-list
)))
377 (setq fval
(cdr fval
))))
378 ;; Look at each file. If it is a numeric backup file,
379 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
380 (dired-map-dired-file-lines (function dired-trample-file-versions
))
381 (message "Cleaning numerical backups...done")))
383 ;;; Subroutines of dired-clean-directory.
385 (defun dired-map-dired-file-lines (fun)
386 ;; Perform FUN with point at the end of each non-directory line.
387 ;; FUN takes one argument, the absolute filename.
389 (let (file buffer-read-only
)
390 (goto-char (point-min))
393 (and (not (looking-at dired-re-dir
))
395 (setq file
(dired-get-filename nil t
)) ; nil on non-file
397 (funcall fun file
))))
400 (defun dired-collect-file-versions (fn)
401 (let ((fn (file-name-sans-versions fn
)))
402 ;; Only do work if this file is not already in the alist.
403 (if (assoc fn dired-file-version-alist
)
405 ;; If it looks like file FN has versions, return a list of the versions.
406 ;;That is a list of strings which are file names.
407 ;;The caller may want to flag some of these files for deletion.
408 (let* ((base-versions
409 (concat (file-name-nondirectory fn
) ".~"))
410 (backup-extract-version-start (length base-versions
))
411 (possibilities (file-name-all-completions
413 (file-name-directory fn
)))
414 (versions (mapcar 'backup-extract-version possibilities
)))
416 (setq dired-file-version-alist
417 (cons (cons fn versions
)
418 dired-file-version-alist
)))))))
420 (defun dired-trample-file-versions (fn)
421 (let* ((start-vn (string-match "\\.~[0-9]+~$" fn
))
424 (setq base-version-list
; there was a base version to which
425 (assoc (substring fn
0 start-vn
) ; this looks like a
426 dired-file-version-alist
)) ; subversion
427 (not (memq (string-to-int (substring fn
(+ 2 start-vn
)))
428 base-version-list
)) ; this one doesn't make the cut
429 (progn (beginning-of-line)
431 (insert dired-del-marker
)))))
435 (defun dired-read-shell-command (prompt arg files
)
436 ;; "Read a dired shell command prompting with PROMPT (using read-string).
437 ;;ARG is the prefix arg and may be used to indicate in the prompt which
438 ;; files are affected.
439 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
442 (function read-string
)
443 (format prompt
(dired-mark-prompt arg files
))
444 nil
'shell-command-history
))
446 ;; The in-background argument is only needed in Emacs 18 where
447 ;; shell-command doesn't understand an appended ampersand `&'.
449 (defun dired-do-shell-command (command &optional arg file-list
)
450 "Run a shell command COMMAND on the marked files.
451 If no files are marked or a specific numeric prefix arg is given,
452 the next ARG files are used. Just \\[universal-argument] means the current file.
453 The prompt mentions the file(s) or the marker, as appropriate.
455 If there is a `*' in COMMAND, surrounded by whitespace, this runs
456 COMMAND just once with the entire file list substituted there.
458 If there is no `*', but there is a `?' in COMMAND, surrounded by
459 whitespace, this runs COMMAND on each file individually with the
460 file name substituted for `?'.
462 Otherwise, this runs COMMAND on each file individually with the
463 file name added at the end of COMMAND (separated by a space).
465 `*' and `?' when not surrounded by whitespace have no special
466 significance for `dired-do-shell-command', and are passed through
467 normally to the shell, but you must confirm first. To pass `*' by
468 itself to the shell as a wildcard, type `*\"\"'.
470 If COMMAND produces output, it goes to a separate buffer.
472 This feature does not try to redisplay Dired buffers afterward, as
473 there's no telling what files COMMAND may have changed.
474 Type \\[dired-do-redisplay] to redisplay the marked files.
476 When COMMAND runs, its working directory is the top-level directory of
477 the Dired buffer, so output files usually are created there instead of
480 In a noninteractive call (from Lisp code), you must specify
481 the list of file names explicitly with the FILE-LIST argument."
482 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
483 ;;actual work and can be redefined for customization.
485 (let ((files (dired-get-marked-files t current-prefix-arg
)))
487 ;; Want to give feedback whether this file or marked files are used:
488 (dired-read-shell-command (concat "! on "
494 (let* ((on-each (not (string-match dired-star-subst-regexp command
)))
495 (subst (not (string-match dired-quark-subst-regexp command
)))
496 (star (not (string-match "\\*" command
)))
497 (qmark (not (string-match "\\?" command
))))
498 ;; Get confirmation for wildcards that may have been meant
499 ;; to control substitution of a file name or the file name list.
500 (if (cond ((not (or on-each subst
))
501 (error "You can not combine `*' and `?' substitution marks"))
502 ((and star
(not on-each
))
503 (y-or-n-p "Confirm--do you mean to use `*' as a wildcard? "))
504 ((and qmark
(not subst
))
505 (y-or-n-p "Confirm--do you mean to use `?' as a wildcard? "))
509 (- 10000 (length command
))
510 (function (lambda (&rest files
)
511 (dired-run-shell-command
512 (dired-shell-stuff-it command files t arg
))))
515 ;; execute the shell command
516 (dired-run-shell-command
517 (dired-shell-stuff-it command file-list nil arg
))))))
519 ;; Might use {,} for bash or csh:
520 (defvar dired-mark-prefix
""
521 "Prepended to marked files in dired shell commands.")
522 (defvar dired-mark-postfix
""
523 "Appended to marked files in dired shell commands.")
524 (defvar dired-mark-separator
" "
525 "Separates marked files in dired shell commands.")
527 (defun dired-shell-stuff-it (command file-list on-each
&optional raw-arg
)
528 ;; "Make up a shell command line from COMMAND and FILE-LIST.
529 ;; If ON-EACH is t, COMMAND should be applied to each file, else
530 ;; simply concat all files and apply COMMAND to this.
531 ;; FILE-LIST's elements will be quoted for the shell."
532 ;; Might be redefined for smarter things and could then use RAW-ARG
533 ;; (coming from interactive P and currently ignored) to decide what to do.
534 ;; Smart would be a way to access basename or extension of file names.
536 (if (or (string-match dired-star-subst-regexp command
)
537 (string-match dired-quark-subst-regexp command
))
539 (let ((retval command
))
541 "\\(^\\|[ \t]\\)\\([*?]\\)\\([ \t]\\|$\\)" retval
)
542 (setq retval
(replace-match x t t retval
2)))
544 (lambda (x) (concat command dired-mark-separator x
)))))
546 (mapconcat stuff-it
(mapcar 'shell-quote-argument file-list
) ";")
547 (let ((files (mapconcat 'shell-quote-argument
548 file-list dired-mark-separator
)))
549 (if (> (length file-list
) 1)
550 (setq files
(concat dired-mark-prefix files dired-mark-postfix
)))
551 (funcall stuff-it files
)))))
553 ;; This is an extra function so that it can be redefined by ange-ftp.
554 (defun dired-run-shell-command (command)
556 (find-file-name-handler (directory-file-name default-directory
)
558 (if handler
(apply handler
'shell-command
(list command
))
559 (shell-command command
)))
560 ;; Return nil for sake of nconc in dired-bunch-files.
563 ;; In Emacs 19 this will return program's exit status.
564 ;; This is a separate function so that ange-ftp can redefine it.
565 (defun dired-call-process (program discard
&rest arguments
)
566 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
567 ;Remaining arguments are strings passed as command arguments to PROGRAM."
568 ;; Look for a handler for default-directory in case it is a remote file name.
570 (find-file-name-handler (directory-file-name default-directory
)
571 'dired-call-process
)))
572 (if handler
(apply handler
'dired-call-process
573 program discard arguments
)
574 (apply 'call-process program nil
(not discard
) nil arguments
))))
576 (defun dired-check-process (msg program
&rest arguments
)
577 ; "Display MSG while running PROGRAM, and check for output.
578 ;Remaining arguments are strings passed as command arguments to PROGRAM.
579 ; On error, insert output
580 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
581 ; Caller can cons up a list of failed args.
582 ;Else returns nil for success."
583 (let (err-buffer err
(dir default-directory
))
584 (message "%s..." msg
)
586 ;; Get a clean buffer for error output:
587 (setq err-buffer
(get-buffer-create " *dired-check-process output*"))
588 (set-buffer err-buffer
)
590 (setq default-directory dir
; caller's default-directory
592 (apply (function dired-call-process
) program nil arguments
))))
595 (dired-log (concat program
" " (prin1-to-string arguments
) "\n"))
596 (dired-log err-buffer
)
597 (or arguments program t
))
598 (kill-buffer err-buffer
)
599 (message "%s...done" msg
)
602 ;; Commands that delete or redisplay part of the dired buffer.
604 (defun dired-kill-line (&optional arg
)
606 (setq arg
(prefix-numeric-value arg
))
607 (let (buffer-read-only file
)
609 (setq file
(dired-get-filename nil t
))
611 (error "Can only kill file lines")
612 (save-excursion (and file
613 (dired-goto-subdir file
)
614 (dired-kill-subdir)))
615 (delete-region (progn (beginning-of-line) (point))
616 (progn (forward-line 1) (point)))
621 (dired-move-to-filename)))
624 (defun dired-do-kill-lines (&optional arg fmt
)
625 "Kill all marked lines (not the files).
626 With a prefix argument, kill that many lines starting with the current line.
627 \(A negative argument kills lines before the current line.)
628 To kill an entire subdirectory, go to its directory header line
629 and use this command with a prefix argument (the value does not matter)."
630 ;; Returns count of killed lines. FMT="" suppresses message.
633 (if (dired-get-subdir)
635 (dired-kill-line arg
))
637 (goto-char (point-min))
638 (let (buffer-read-only (count 0))
639 (if (not arg
) ; kill marked lines
640 (let ((regexp (dired-marker-regexp)))
641 (while (and (not (eobp))
642 (re-search-forward regexp nil t
))
643 (setq count
(1+ count
))
644 (delete-region (progn (beginning-of-line) (point))
645 (progn (forward-line 1) (point)))))
646 ;; else kill unmarked lines
648 (if (or (dired-between-files)
649 (not (looking-at "^ ")))
651 (setq count
(1+ count
))
652 (delete-region (point) (save-excursion
656 (message (or fmt
"Killed %d line%s.") count
(dired-plural-s count
)))
659 ;;;###end dired-cmd.el
662 ;;;###begin dired-cp.el
664 (defun dired-compress ()
665 ;; Compress or uncompress the current file.
666 ;; Return nil for success, offending filename else.
667 (let* (buffer-read-only
668 (from-file (dired-get-filename))
669 (new-file (dired-compress-file from-file
)))
671 (let ((start (point)))
672 ;; Remove any preexisting entry for the name NEW-FILE.
674 (dired-remove-entry new-file
)
677 ;; Now replace the current line with an entry for NEW-FILE.
678 (dired-update-file-line new-file
) nil
)
679 (dired-log (concat "Failed to compress" from-file
))
682 (defvar dired-compress-file-suffixes
683 '(("\\.gz\\'" "" "gunzip")
684 ("\\.tgz\\'" ".tar" "gunzip")
685 ("\\.Z\\'" "" "uncompress")
686 ;; For .z, try gunzip. It might be an old gzip file,
687 ;; or it might be from compact? pack? (which?) but gunzip handles both.
688 ("\\.z\\'" "" "gunzip")
689 ("\\.dz\\'" "" "dictunzip")
690 ("\\.tbz\\'" ".tar" "bunzip2")
691 ("\\.bz2\\'" "" "bunzip2")
692 ;; This item controls naming for compression.
693 ("\\.tar\\'" ".tgz" nil
))
694 "Control changes in file name suffixes for compression and uncompression.
695 Each element specifies one transformation rule, and has the form:
696 (REGEXP NEW-SUFFIX PROGRAM)
697 The rule applies when the old file name matches REGEXP.
698 The new file name is computed by deleting the part that matches REGEXP
699 (as well as anything after that), then adding NEW-SUFFIX in its place.
700 If PROGRAM is non-nil, the rule is an uncompression rule,
701 and uncompression is done by running PROGRAM.
702 Otherwise, the rule is a compression rule, and compression is done with gzip.")
705 (defun dired-compress-file (file)
706 ;; Compress or uncompress FILE.
707 ;; Return the name of the compressed or uncompressed file.
708 ;; Return nil if no change in files.
709 (let ((handler (find-file-name-handler file
'dired-compress-file
))
711 (suffixes dired-compress-file-suffixes
))
712 ;; See if any suffix rule matches this file name.
714 (let (case-fold-search)
715 (if (string-match (car (car suffixes
)) file
)
716 (setq suffix
(car suffixes
) suffixes nil
))
717 (setq suffixes
(cdr suffixes
))))
718 ;; If so, compute desired new name.
720 (setq newname
(concat (substring file
0 (match-beginning 0))
723 (funcall handler
'dired-compress-file file
))
724 ((file-symlink-p file
)
726 ((and suffix
(nth 2 suffix
))
727 ;; We found an uncompression rule.
728 (if (not (dired-check-process (concat "Uncompressing " file
)
729 (nth 2 suffix
) file
))
732 ;;; We don't recognize the file as compressed, so compress it.
733 ;;; Try gzip; if we don't have that, use compress.
735 (if (not (dired-check-process (concat "Compressing " file
)
738 (if (file-exists-p (concat file
".gz"))
740 (concat file
".z"))))
741 ;; Rename the compressed file to NEWNAME
742 ;; if it hasn't got that name already.
743 (if (and newname
(not (equal newname out-name
)))
745 (rename-file out-name newname t
)
749 (if (not (dired-check-process (concat "Compressing " file
)
750 "compress" "-f" file
))
751 ;; Don't use NEWNAME with `compress'.
752 (concat file
".Z"))))))))
754 (defun dired-mark-confirm (op-symbol arg
)
755 ;; Request confirmation from the user that the operation described
756 ;; by OP-SYMBOL is to be performed on the marked files.
757 ;; Confirmation consists in a y-or-n question with a file list
758 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
759 ;; The files used are determined by ARG (as in dired-get-marked-files).
760 (or (eq dired-no-confirm t
)
761 (memq op-symbol dired-no-confirm
)
762 (let ((files (dired-get-marked-files t arg
))
763 (string (if (eq op-symbol
'compress
) "Compress or uncompress"
764 (capitalize (symbol-name op-symbol
)))))
765 (dired-mark-pop-up nil op-symbol files
(function y-or-n-p
)
767 (dired-mark-prompt arg files
) "? ")))))
769 (defun dired-map-over-marks-check (fun arg op-symbol
&optional show-progress
)
770 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
771 ; and display failures.
773 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
774 ; the short form of the filename) for a failure and probably logs a
775 ; detailed error explanation using function `dired-log'.
777 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
778 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
779 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
780 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
782 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
783 (if (dired-mark-confirm op-symbol arg
)
784 (let* ((total-list;; all of FUN's return values
785 (dired-map-over-marks (funcall fun
) arg show-progress
))
786 (total (length total-list
))
787 (failures (delq nil total-list
))
788 (count (length failures
))
789 (string (if (eq op-symbol
'compress
) "Compress or uncompress"
790 (capitalize (symbol-name op-symbol
)))))
792 (message "%s: %d file%s."
793 string total
(dired-plural-s total
))
794 ;; end this bunch of errors:
796 (format "Failed to %s %d of %d file%s"
797 (downcase string
) count total
(dired-plural-s total
))
800 (defvar dired-query-alist
801 '((?\y . y
) (?
\040 . y
) ; `y' or SPC means accept once
802 (?n . n
) (?
\177 . n
) ; `n' or DEL skips once
803 (?
! . yes
) ; `!' accepts rest
804 (?q . no
) (?\e . no
) ; `q' or ESC skips rest
805 ;; None of these keys quit - use C-g for that.
808 (defun dired-query (qs-var qs-prompt
&rest qs-args
)
809 ;; Query user and return nil or t.
810 ;; Store answer in symbol VAR (which must initially be bound to nil).
811 ;; Format PROMPT with ARGS.
812 ;; Binding variable help-form will help the user who types the help key.
813 (let* ((char (symbol-value qs-var
))
814 (action (cdr (assoc char dired-query-alist
))))
815 (cond ((eq 'yes action
)
816 t
) ; accept, and don't ask again
818 nil
) ; skip, and don't ask again
819 (t;; no lasting effects from last time we asked - ask now
820 (let ((qprompt (concat qs-prompt
822 (format " [Type yn!q or %s] "
824 (char-to-string help-char
)))
825 " [Type y, n, q or !] ")))
827 ;; Actually it looks nicer without cursor-in-echo-area - you can
828 ;; look at the dired buffer instead of at the prompt to decide.
829 (apply 'message qprompt qs-args
)
830 (setq char
(set qs-var
(read-char)))
831 (while (not (setq elt
(assoc char dired-query-alist
)))
832 (message "Invalid char - type %c for help." help-char
)
835 (apply 'message qprompt qs-args
)
836 (setq char
(set qs-var
(read-char))))
837 (memq (cdr elt
) '(t y yes
)))))))
840 (defun dired-do-compress (&optional arg
)
841 "Compress or uncompress marked (or next ARG) files."
843 (dired-map-over-marks-check (function dired-compress
) arg
'compress t
))
845 ;; Commands for Emacs Lisp files - load and byte compile
847 (defun dired-byte-compile ()
848 ;; Return nil for success, offending file name else.
849 (let* ((filename (dired-get-filename))
850 elc-file buffer-read-only failure
)
852 (save-excursion (byte-compile-file filename
))
855 (setq elc-file
(byte-compile-dest-file filename
))
856 (or (file-exists-p elc-file
)
860 (dired-log "Byte compile error for %s:\n%s\n" filename failure
)
861 (dired-make-relative filename
))
862 (dired-remove-file elc-file
)
863 (forward-line) ; insert .elc after its .el file
864 (dired-add-file elc-file
)
868 (defun dired-do-byte-compile (&optional arg
)
869 "Byte compile marked (or next ARG) Emacs Lisp files."
871 (dired-map-over-marks-check (function dired-byte-compile
) arg
'byte-compile t
))
874 ;; Return nil for success, offending file name else.
875 (let ((file (dired-get-filename)) failure
)
877 (load file nil nil t
)
878 (error (setq failure err
)))
881 (dired-log "Load error for %s:\n%s\n" file failure
)
882 (dired-make-relative file
))))
885 (defun dired-do-load (&optional arg
)
886 "Load the marked (or next ARG) Emacs Lisp files."
888 (dired-map-over-marks-check (function dired-load
) arg
'load t
))
891 (defun dired-do-redisplay (&optional arg test-for-subdir
)
892 "Redisplay all marked (or next ARG) files.
893 If on a subdir line, redisplay that subdirectory. In that case,
894 a prefix arg lets you edit the `ls' switches used for the new listing."
895 ;; Moves point if the next ARG files are redisplayed.
897 (if (and test-for-subdir
(dired-get-subdir))
898 (let* ((dir (dired-get-subdir))
899 (switches (cdr (assoc-string dir dired-switches-alist
))))
903 (read-string "Switches for listing: "
905 dired-subdir-switches
906 dired-actual-switches
)))))
907 (message "Redisplaying...")
908 ;; message much faster than making dired-map-over-marks show progress
910 (if (consp dired-directory
) (car dired-directory
) dired-directory
))
911 (dired-map-over-marks (let ((fname (dired-get-filename)))
912 (message "Redisplaying... %s" fname
)
913 (dired-update-file-line fname
))
915 (dired-move-to-filename)
916 (message "Redisplaying...done")))
918 (defun dired-update-file-line (file)
919 ;; Delete the current line, and insert an entry for FILE.
920 ;; If FILE is nil, then just delete the current line.
921 ;; Keeps any marks that may be present in column one (doing this
922 ;; here is faster than with dired-add-entry's optional arg).
923 ;; Does not update other dired buffers. Use dired-relist-entry for that.
925 (let ((char (following-char)) (opoint (point))
927 (delete-region (point) (progn (forward-line 1) (point)))
930 (dired-add-entry file nil t
)
931 ;; Replace space by old marker without moving point.
932 ;; Faster than goto+insdel inside a save-excursion?
933 (subst-char-in-region opoint
(1+ opoint
) ?
\040 char
))))
934 (dired-move-to-filename))
937 (defun dired-add-file (filename &optional marker-char
)
938 (dired-fun-in-all-buffers
939 (file-name-directory filename
) (file-name-nondirectory filename
)
940 (function dired-add-entry
) filename marker-char
))
942 (defun dired-add-entry (filename &optional marker-char relative
)
943 ;; Add a new entry for FILENAME, optionally marking it
944 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
945 ;; Note that this adds the entry `out of order' if files sorted by
947 ;; At least this version inserts in the right subdirectory (if present).
948 ;; And it skips "." or ".." (see `dired-trivial-filenames').
949 ;; Hidden subdirs are exposed if a file is added there.
950 (setq filename
(directory-file-name filename
))
951 ;; Entry is always for files, even if they happen to also be directories
952 (let* ((opoint (point))
953 (cur-dir (dired-current-directory))
954 (orig-file-name filename
)
955 (directory (if relative cur-dir
(file-name-directory filename
)))
959 (file-relative-name filename directory
)
960 (file-name-nondirectory filename
))
963 (if (string= directory cur-dir
)
965 (skip-chars-forward "^\r\n")
966 (if (eq (following-char) ?
\r)
967 (dired-unhide-subdir))
968 ;; We are already where we should be, except when
969 ;; point is before the subdir line or its total line.
970 (let ((p (dired-after-subdir-garbage cur-dir
)))
973 ;; else try to find correct place to insert
974 (if (dired-goto-subdir directory
)
975 (progn ;; unhide if necessary
976 (if (looking-at "\r") ;; point is at end of subdir line
977 (dired-unhide-subdir))
978 ;; found - skip subdir and `total' line
979 ;; and uninteresting files like . and ..
980 ;; This better not moves into the next subdir!
981 (dired-goto-next-nontrivial-file))
983 (throw 'not-found
"Subdir not found")))
984 (let (buffer-read-only opoint
)
986 (setq opoint
(point))
987 ;; Don't expand `.'. Show just the file name within directory.
988 (let ((default-directory directory
))
989 (dired-insert-directory directory
990 (concat dired-actual-switches
"d")
993 ;; Put in desired marker char.
995 (let ((dired-marker-char
996 (if (integerp marker-char
) marker-char dired-marker-char
)))
998 ;; Compensate for a bug in ange-ftp.
999 ;; It inserts the file's absolute name, rather than
1000 ;; the relative one. That may be hard to fix since it
1001 ;; is probably controlled by something in ftp.
1003 (let ((inserted-name (dired-get-filename 'verbatim
)))
1004 (if (file-name-directory inserted-name
)
1007 (forward-char (- (length inserted-name
)))
1008 (setq props
(text-properties-at (point)))
1009 (delete-char (length inserted-name
))
1012 (set-text-properties pt
(point) props
))
1016 (if dired-after-readin-hook
;; the subdir-alist is not affected...
1017 (save-excursion ;; ...so we can run it right now:
1020 (narrow-to-region (point) (save-excursion
1021 (forward-line 1) (point)))
1022 (run-hooks 'dired-after-readin-hook
))))
1023 (dired-move-to-filename))
1024 ;; return nil if all went well
1026 (if reason
; don't move away on failure
1028 (not reason
))) ; return t on success, nil else
1030 (defun dired-after-subdir-garbage (dir)
1031 ;; Return pos of first file line of DIR, skipping header and total
1032 ;; or wildcard lines.
1033 ;; Important: never moves into the next subdir.
1034 ;; DIR is assumed to be unhidden.
1035 ;; Will probably be redefined for VMS etc.
1037 (or (dired-goto-subdir dir
) (error "This cannot happen"))
1039 (while (and (not (eolp)) ; don't cross subdir boundary
1040 (not (dired-move-to-filename)))
1045 (defun dired-remove-file (file)
1046 (dired-fun-in-all-buffers
1047 (file-name-directory file
) (file-name-nondirectory file
)
1048 (function dired-remove-entry
) file
))
1050 (defun dired-remove-entry (file)
1052 (and (dired-goto-file file
)
1053 (let (buffer-read-only)
1054 (delete-region (progn (beginning-of-line) (point))
1055 (save-excursion (forward-line 1) (point)))))))
1058 (defun dired-relist-file (file)
1059 "Create or update the line for FILE in all Dired buffers it would belong in."
1060 (dired-fun-in-all-buffers (file-name-directory file
)
1061 (file-name-nondirectory file
)
1062 (function dired-relist-entry
) file
))
1064 (defun dired-relist-entry (file)
1065 ;; Relist the line for FILE, or just add it if it did not exist.
1066 ;; FILE must be an absolute file name.
1067 (let (buffer-read-only marker
)
1068 ;; If cursor is already on FILE's line delete-region will cause
1069 ;; save-excursion to fail because of floating makers,
1070 ;; moving point to beginning of line. Sigh.
1072 (and (dired-goto-file file
)
1073 (delete-region (progn (beginning-of-line)
1074 (setq marker
(following-char))
1076 (save-excursion (forward-line 1) (point))))
1077 (setq file
(directory-file-name file
))
1078 (dired-add-entry file
(if (eq ?
\040 marker
) nil marker
)))))
1080 ;;; Copy, move/rename, making hard and symbolic links
1082 (defcustom dired-recursive-copies nil
1083 "*Decide whether recursive copies are allowed.
1084 nil means no recursive copies.
1085 `always' means copy recursively without asking.
1086 `top' means ask for each directory at top level.
1087 Anything else means ask for each directory."
1088 :type
'(choice :tag
"Copy directories"
1089 (const :tag
"No recursive copies" nil
)
1090 (const :tag
"Ask for each directory" t
)
1091 (const :tag
"Ask for each top directory only" top
)
1092 (const :tag
"Copy directories without asking" always
))
1095 (defcustom dired-backup-overwrite nil
1096 "*Non-nil if Dired should ask about making backups before overwriting files.
1097 Special value `always' suppresses confirmation."
1098 :type
'(choice (const :tag
"off" nil
)
1099 (const :tag
"suppress" always
)
1100 (other :tag
"ask" t
))
1103 (defvar dired-overwrite-confirmed
)
1105 (defun dired-handle-overwrite (to)
1106 ;; Save old version of file TO that is to be overwritten.
1107 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1108 ;; from dired-create-files.
1110 (if (and dired-backup-overwrite
1111 dired-overwrite-confirmed
1112 (setq backup
(car (find-backup-file-name to
)))
1113 (or (eq 'always dired-backup-overwrite
)
1114 (dired-query 'overwrite-backup-query
1115 (format "Make backup for existing file `%s'? "
1118 (rename-file to backup
0) ; confirm overwrite of old backup
1119 (dired-relist-entry backup
)))))
1122 (defun dired-copy-file (from to ok-flag
)
1123 (dired-handle-overwrite to
)
1125 (dired-copy-file-recursive from to ok-flag dired-copy-preserve-time t
1126 dired-recursive-copies
)
1127 (file-date-error (message "Can't set date")
1130 (defun dired-copy-file-recursive (from to ok-flag
&optional
1131 preserve-time top recursive
)
1133 (eq t
(car (file-attributes from
))) ; A directory, no symbolic link.
1134 (or (eq recursive
'always
)
1135 (yes-or-no-p (format "Recursive copies of %s " from
))))
1136 (let ((files (directory-files from nil dired-re-no-dot
)))
1137 (if (eq recursive
'top
) (setq recursive
'always
)) ; Don't ask any more.
1138 (if (file-exists-p to
)
1139 (or top
(dired-handle-overwrite to
))
1140 (make-directory to
))
1142 (dired-copy-file-recursive
1143 (expand-file-name (car files
) from
)
1144 (expand-file-name (car files
) to
)
1145 ok-flag preserve-time nil recursive
)
1146 (setq files
(cdr files
))))
1147 (or top
(dired-handle-overwrite to
)) ; Just a file.
1148 (copy-file from to ok-flag dired-copy-preserve-time
)))
1151 (defun dired-rename-file (file newname ok-if-already-exists
)
1152 (dired-handle-overwrite newname
)
1153 (rename-file file newname ok-if-already-exists
) ; error is caught in -create-files
1154 ;; Silently rename the visited file of any buffer visiting this file.
1155 (and (get-file-buffer file
)
1156 (with-current-buffer (get-file-buffer file
)
1157 (set-visited-file-name newname nil t
)))
1158 (dired-remove-file file
)
1159 ;; See if it's an inserted subdir, and rename that, too.
1160 (dired-rename-subdir file newname
))
1162 (defun dired-rename-subdir (from-dir to-dir
)
1163 (setq from-dir
(file-name-as-directory from-dir
)
1164 to-dir
(file-name-as-directory to-dir
))
1165 (dired-fun-in-all-buffers from-dir nil
1166 (function dired-rename-subdir-1
) from-dir to-dir
)
1167 ;; Update visited file name of all affected buffers
1168 (let ((expanded-from-dir (expand-file-name from-dir
))
1169 (blist (buffer-list)))
1172 (set-buffer (car blist
))
1173 (if (and buffer-file-name
1174 (dired-in-this-tree buffer-file-name expanded-from-dir
))
1175 (let ((modflag (buffer-modified-p))
1176 (to-file (dired-replace-in-string
1177 (concat "^" (regexp-quote from-dir
))
1180 (set-visited-file-name to-file
)
1181 (set-buffer-modified-p modflag
))))
1182 (setq blist
(cdr blist
)))))
1184 (defun dired-rename-subdir-1 (dir to
)
1185 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1186 ;; one of its subdirectories is expanded in this buffer.
1187 (let ((expanded-dir (expand-file-name dir
))
1188 (alist dired-subdir-alist
)
1191 (setq elt
(car alist
)
1193 (if (dired-in-this-tree (car elt
) expanded-dir
)
1194 ;; ELT's subdir is affected by the rename
1195 (dired-rename-subdir-2 elt dir to
)))
1196 (if (equal dir default-directory
)
1197 ;; if top level directory was renamed, lots of things have to be
1200 (dired-unadvertise dir
) ; we no longer dired DIR...
1201 (setq default-directory to
1202 dired-directory
(expand-file-name;; this is correct
1203 ;; with and without wildcards
1204 (file-name-nondirectory dired-directory
)
1206 (let ((new-name (file-name-nondirectory
1207 (directory-file-name dired-directory
))))
1208 ;; try to rename buffer, but just leave old name if new
1209 ;; name would already exist (don't try appending "<%d>")
1210 (or (get-buffer new-name
)
1211 (rename-buffer new-name
)))
1212 ;; ... we dired TO now:
1213 (dired-advertise)))))
1215 (defun dired-rename-subdir-2 (elt dir to
)
1216 ;; Update the headerline and dired-subdir-alist element, as well as
1217 ;; dired-switches-alist element, of directory described by
1218 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1219 ;; describes either DIR itself or a subdir of DIR.
1221 (let ((regexp (regexp-quote (directory-file-name dir
)))
1222 (newtext (directory-file-name to
))
1224 (goto-char (dired-get-subdir-min elt
))
1225 ;; Update subdir headerline in buffer
1226 (if (not (looking-at dired-subdir-regexp
))
1227 (error "%s not found where expected - dired-subdir-alist broken?"
1229 (goto-char (match-beginning 1))
1230 (if (re-search-forward regexp
(match-end 1) t
)
1231 (replace-match newtext t t
)
1232 (error "Expected to find `%s' in headerline of %s" dir
(car elt
))))
1233 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1234 (let ((cons (assoc-string (car elt
) dired-switches-alist
))
1235 (cur-dir (dired-normalize-subdir
1236 (dired-replace-in-string regexp newtext
(car elt
)))))
1237 (setcar elt cur-dir
)
1238 (when cons
(setcar cons cur-dir
))))))
1240 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1241 (defun dired-create-files (file-creator operation fn-list name-constructor
1242 &optional marker-char
)
1244 ;; Create a new file for each from a list of existing files. The user
1245 ;; is queried, dired buffers are updated, and at the end a success or
1246 ;; failure message is displayed
1248 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1250 ;; It is called for each file and must create newfile, the entry of
1251 ;; which will be added. The user will be queried if the file already
1252 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1253 ;; rename), it is FILE-CREATOR's responsibility to update dired
1254 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1255 ;; could not create newfile. The error is caught and logged.
1257 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1258 ;; operation performed. It is used for error logging.
1260 ;; FN-LIST is the list of files to copy (full absolute file names).
1262 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1263 ;; skip. If it skips files for other reasons than a direct user
1264 ;; query, it is supposed to tell why (using dired-log).
1266 ;; Optional MARKER-CHAR is a character with which to mark every
1267 ;; newfile's entry, or t to use the current marker character if the
1268 ;; oldfile was marked.
1270 (let (failures skipped
(success-count 0) (total (length fn-list
)))
1271 (let (to overwrite-query
1272 overwrite-backup-query
) ; for dired-handle-overwrite
1276 (setq to
(funcall name-constructor from
))
1280 (dired-log "Cannot %s to same file: %s\n"
1281 (downcase operation
) from
)))
1283 (setq skipped
(cons (dired-make-relative from
) skipped
))
1284 (let* ((overwrite (file-exists-p to
))
1285 (dired-overwrite-confirmed ; for dired-handle-overwrite
1287 (let ((help-form '(format "\
1288 Type SPC or `y' to overwrite file `%s',
1289 DEL or `n' to skip to next,
1290 ESC or `q' to not overwrite any of the remaining files,
1291 `!' to overwrite all remaining files with no more questions." to
)))
1292 (dired-query 'overwrite-query
1293 "Overwrite `%s'?" to
))))
1294 ;; must determine if FROM is marked before file-creator
1295 ;; gets a chance to delete it (in case of a move).
1297 (cond ((integerp marker-char
) marker-char
)
1298 (marker-char (dired-file-marker from
)) ; slow
1302 (funcall file-creator from to dired-overwrite-confirmed
)
1304 ;; If we get here, file-creator hasn't been aborted
1305 ;; and the old entry (if any) has to be deleted
1306 ;; before adding the new entry.
1307 (dired-remove-file to
))
1308 (setq success-count
(1+ success-count
))
1309 (message "%s: %d of %d" operation success-count total
)
1310 (dired-add-file to actual-marker-char
))
1311 (file-error ; FILE-CREATOR aborted
1313 (setq failures
(cons (dired-make-relative from
) failures
))
1314 (dired-log "%s `%s' to `%s' failed:\n%s\n"
1315 operation from to err
))))))))
1320 (format "%s failed for %d of %d file%s"
1321 operation
(length failures
) total
1322 (dired-plural-s total
))
1326 (format "%s: %d of %d file%s skipped"
1327 operation
(length skipped
) total
1328 (dired-plural-s total
))
1331 (message "%s: %s file%s"
1332 operation success-count
(dired-plural-s success-count
)))))
1333 (dired-move-to-filename))
1335 (defun dired-do-create-files (op-symbol file-creator operation arg
1336 &optional marker-char op1
1338 "Create a new file for each marked file.
1339 Prompts user for target, which is a directory in which to create
1340 the new files. Target may be a plain file if only one marked
1341 file exists. The way the default for the target directory is
1342 computed depends on the value of `dired-dwim-target-directory'.
1343 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1344 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1345 FILE-CREATOR and OPERATION as in `dired-create-files'.
1346 ARG as in `dired-get-marked-files'.
1347 Optional arg MARKER-CHAR as in `dired-create-files'.
1348 Optional arg OP1 is an alternate form for OPERATION if there is
1350 Optional arg HOW-TO is used to set the value of the into-dir variable
1351 which determines how to treat target.
1352 If into-dir is set to nil then target is not regarded as a directory,
1353 there must be exactly one marked file, else error.
1354 Else if into-dir is set to a list, then target is a generalized
1355 directory (e.g. some sort of archive). The first element of into-dir
1356 must be a function with at least four arguments:
1357 operation as OPERATION above.
1358 rfn-list a list of the relative names for the marked files.
1359 fn-list a list of the absolute names for the marked files.
1361 The rest of into-dir are optional arguments.
1362 Else into-dir is not a list. Target is a directory.
1363 The marked file(s) are created inside the target directory.
1365 If HOW-TO is not given (or nil), then into-dir is set to true if
1366 target is a directory and otherwise to nil.
1367 Else if HOW-TO is t, then into-dir is set to nil.
1368 Else HOW-TO is assumed to be a function of one argument, target,
1369 that looks at target and returns a value for the into-dir
1370 variable. The function `dired-into-dir-with-symlinks' is provided
1371 for the case (common when creating symlinks) that symbolic
1372 links to directories are not to be considered as directories
1373 (as `file-directory-p' would if HOW-TO had been nil)."
1374 (or op1
(setq op1 operation
))
1375 (let* ((fn-list (dired-get-marked-files nil arg
))
1376 (rfn-list (mapcar (function dired-make-relative
) fn-list
))
1377 (dired-one-file ; fluid variable inside dired-create-files
1378 (and (consp fn-list
) (null (cdr fn-list
)) (car fn-list
)))
1379 (target-dir (dired-dwim-target-directory))
1380 (default (and dired-one-file
1381 (expand-file-name (file-name-nondirectory (car fn-list
))
1383 (target (expand-file-name ; fluid variable inside dired-create-files
1384 (dired-mark-read-file-name
1385 (concat (if dired-one-file op1 operation
) " %s to: ")
1386 target-dir op-symbol arg rfn-list default
)))
1387 (into-dir (cond ((null how-to
)
1388 ;; Allow DOS/Windows users to change the letter
1389 ;; case of a directory. If we don't test these
1390 ;; conditions up front, file-directory-p below
1391 ;; will return t because the filesystem is
1392 ;; case-insensitive, and Emacs will try to move
1393 ;; foo -> foo/foo, which fails.
1394 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
1395 (eq op-symbol
'move
)
1398 (expand-file-name (car fn-list
)))
1400 (expand-file-name target
)))
1402 (file-name-nondirectory (car fn-list
))
1403 (file-name-nondirectory target
))))
1405 (file-directory-p target
)))
1407 (t (funcall how-to target
)))))
1408 (if (and (consp into-dir
) (functionp (car into-dir
)))
1409 (apply (car into-dir
) operation rfn-list fn-list target
(cdr into-dir
))
1410 (if (not (or dired-one-file into-dir
))
1411 (error "Marked %s: target must be a directory: %s" operation target
))
1412 ;; rename-file bombs when moving directories unless we do this:
1413 (or into-dir
(setq target
(directory-file-name target
)))
1415 file-creator operation fn-list
1416 (if into-dir
; target is a directory
1417 ;; This function uses fluid variable target when called
1418 ;; inside dired-create-files:
1421 (expand-file-name (file-name-nondirectory from
) target
)))
1422 (function (lambda (from) target
)))
1425 ;; Read arguments for a marked-files command that wants a file name,
1426 ;; perhaps popping up the list of marked files.
1427 ;; ARG is the prefix arg and indicates whether the files came from
1428 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1429 ;; If the current file was used, the list has but one element and ARG
1430 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1431 ;; DEFAULT is the default value to return if the user just hits RET;
1432 ;; if it is omitted or nil, then the name of the directory is used.
1434 (defun dired-mark-read-file-name (prompt dir op-symbol arg files
1438 (function read-file-name
)
1439 (format prompt
(dired-mark-prompt arg files
)) dir default
))
1441 (defun dired-dwim-target-directory ()
1442 ;; Try to guess which target directory the user may want.
1443 ;; If there is a dired buffer displayed in the next window, use
1444 ;; its current subdir, else use current subdir of this dired buffer.
1445 (let ((this-dir (and (eq major-mode
'dired-mode
)
1446 (dired-current-directory))))
1447 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1448 (if dired-dwim-target
1449 (let* ((other-buf (window-buffer (next-window)))
1450 (other-dir (save-excursion
1451 (set-buffer other-buf
)
1452 (and (eq major-mode
'dired-mode
)
1453 (dired-current-directory)))))
1454 (or other-dir this-dir
))
1458 (defun dired-create-directory (directory)
1459 "Create a directory called DIRECTORY."
1461 (list (read-file-name "Create directory: " (dired-current-directory))))
1462 (let ((expanded (directory-file-name (expand-file-name directory
))))
1463 (make-directory expanded
)
1464 (dired-add-file expanded
)
1465 (dired-move-to-filename)))
1467 (defun dired-into-dir-with-symlinks (target)
1468 (and (file-directory-p target
)
1469 (not (file-symlink-p target
))))
1470 ;; This may not always be what you want, especially if target is your
1471 ;; home directory and it happens to be a symbolic link, as is often the
1472 ;; case with NFS and automounters. Or if you want to make symlinks
1473 ;; into directories that themselves are only symlinks, also quite
1476 ;; So we don't use this function as value for HOW-TO in
1477 ;; dired-do-symlink, which has the minor disadvantage of
1478 ;; making links *into* a symlinked-dir, when you really wanted to
1479 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1480 ;; just have to remove that symlink by hand before making your marked
1483 (defvar dired-copy-how-to-fn nil
1484 "nil or a function used by `dired-do-copy' to determine target.
1485 See HOW-TO argument for `dired-do-create-files'.")
1488 (defun dired-do-copy (&optional arg
)
1489 "Copy all marked (or next ARG) files, or copy the current file.
1490 This normally preserves the last-modified date when copying.
1491 When operating on just the current file, you specify the new name.
1492 When operating on multiple or marked files, you specify a directory,
1493 and new copies of these files are made in that directory
1494 with the same names that the files currently have. The default
1495 suggested for the target directory depends on the value of
1496 `dired-dwim-target', which see."
1498 (let ((dired-recursive-copies dired-recursive-copies
))
1499 (dired-do-create-files 'copy
(function dired-copy-file
)
1500 (if dired-copy-preserve-time
"Copy [-p]" "Copy")
1501 arg dired-keep-marker-copy
1502 nil dired-copy-how-to-fn
)))
1505 (defun dired-do-symlink (&optional arg
)
1506 "Make symbolic links to current file or all marked (or next ARG) files.
1507 When operating on just the current file, you specify the new name.
1508 When operating on multiple or marked files, you specify a directory
1509 and new symbolic links are made in that directory
1510 with the same names that the files currently have. The default
1511 suggested for the target directory depends on the value of
1512 `dired-dwim-target', which see."
1514 (dired-do-create-files 'symlink
(function make-symbolic-link
)
1515 "Symlink" arg dired-keep-marker-symlink
))
1518 (defun dired-do-hardlink (&optional arg
)
1519 "Add names (hard links) current file or all marked (or next ARG) files.
1520 When operating on just the current file, you specify the new name.
1521 When operating on multiple or marked files, you specify a directory
1522 and new hard links are made in that directory
1523 with the same names that the files currently have. The default
1524 suggested for the target directory depends on the value of
1525 `dired-dwim-target', which see."
1527 (dired-do-create-files 'hardlink
(function dired-hardlink
)
1528 "Hardlink" arg dired-keep-marker-hardlink
))
1530 (defun dired-hardlink (file newname
&optional ok-if-already-exists
)
1531 (dired-handle-overwrite newname
)
1532 ;; error is caught in -create-files
1533 (add-name-to-file file newname ok-if-already-exists
)
1534 ;; Update the link count
1535 (dired-relist-file file
))
1538 (defun dired-do-rename (&optional arg
)
1539 "Rename current file or all marked (or next ARG) files.
1540 When renaming just the current file, you specify the new name.
1541 When renaming multiple or marked files, you specify a directory.
1542 This command also renames any buffers that are visiting the files.
1543 The default suggested for the target directory depends on the value
1544 of `dired-dwim-target', which see."
1546 (dired-do-create-files 'move
(function dired-rename-file
)
1547 "Move" arg dired-keep-marker-rename
"Rename"))
1548 ;;;###end dired-cp.el
1551 ;;;###begin dired-re.el
1552 (defun dired-do-create-files-regexp
1553 (file-creator operation arg regexp newname
&optional whole-name marker-char
)
1554 ;; Create a new file for each marked file using regexps.
1555 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1556 ;; ARG as in dired-get-marked-files.
1557 ;; Matches each marked file against REGEXP and constructs the new
1558 ;; filename from NEWNAME (like in function replace-match).
1559 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1560 ;; instead of only the non-directory part of the file.
1561 ;; Optional arg MARKER-CHAR as in dired-create-files.
1562 (let* ((fn-list (dired-get-marked-files nil arg
))
1563 (fn-count (length fn-list
))
1564 (operation-prompt (concat operation
" `%s' to `%s'?"))
1565 (rename-regexp-help-form (format "\
1566 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1567 `!' to %s all remaining matches with no more questions."
1568 (downcase operation
)
1569 (downcase operation
)))
1570 (regexp-name-constructor
1571 ;; Function to construct new filename using REGEXP and NEWNAME:
1572 (if whole-name
; easy (but rare) case
1575 (let ((to (dired-string-replace-match regexp from newname
))
1576 ;; must bind help-form directly around call to
1578 (help-form rename-regexp-help-form
))
1580 (and (dired-query 'rename-regexp-query
1585 (dired-log "%s: %s did not match regexp %s\n"
1586 operation from regexp
)))))
1587 ;; not whole-name, replace non-directory part only
1590 (let* ((new (dired-string-replace-match
1591 regexp
(file-name-nondirectory from
) newname
))
1592 (to (and new
; nil means there was no match
1593 (expand-file-name new
1594 (file-name-directory from
))))
1595 (help-form rename-regexp-help-form
))
1597 (and (dired-query 'rename-regexp-query
1599 (dired-make-relative from
)
1600 (dired-make-relative to
))
1602 (dired-log "%s: %s did not match regexp %s\n"
1603 operation
(file-name-nondirectory from
) regexp
)))))))
1604 rename-regexp-query
)
1606 file-creator operation fn-list regexp-name-constructor marker-char
)))
1608 (defun dired-mark-read-regexp (operation)
1609 ;; Prompt user about performing OPERATION.
1610 ;; Read and return list of: regexp newname arg whole-name.
1612 (equal 0 (prefix-numeric-value current-prefix-arg
)))
1614 (if whole-name nil current-prefix-arg
))
1617 (concat (if whole-name
"Abs. " "") operation
" from (regexp): ")))
1620 (concat (if whole-name
"Abs. " "") operation
" " regexp
" to: "))))
1621 (list regexp newname arg whole-name
)))
1624 (defun dired-do-rename-regexp (regexp newname
&optional arg whole-name
)
1625 "Rename selected files whose names match REGEXP to NEWNAME.
1627 With non-zero prefix argument ARG, the command operates on the next ARG
1628 files. Otherwise, it operates on all the marked files, or the current
1629 file if none are marked.
1631 As each match is found, the user must type a character saying
1632 what to do with it. For directions, type \\[help-command] at that time.
1633 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
1634 REGEXP defaults to the last regexp used.
1636 With a zero prefix arg, renaming by regexp affects the absolute file name.
1637 Normally, only the non-directory part of the file name is used and changed."
1638 (interactive (dired-mark-read-regexp "Rename"))
1639 (dired-do-create-files-regexp
1640 (function dired-rename-file
)
1641 "Rename" arg regexp newname whole-name dired-keep-marker-rename
))
1644 (defun dired-do-copy-regexp (regexp newname
&optional arg whole-name
)
1645 "Copy selected files whose names match REGEXP to NEWNAME.
1646 See function `dired-do-rename-regexp' for more info."
1647 (interactive (dired-mark-read-regexp "Copy"))
1648 (let ((dired-recursive-copies nil
)) ; No recursive copies.
1649 (dired-do-create-files-regexp
1650 (function dired-copy-file
)
1651 (if dired-copy-preserve-time
"Copy [-p]" "Copy")
1652 arg regexp newname whole-name dired-keep-marker-copy
)))
1655 (defun dired-do-hardlink-regexp (regexp newname
&optional arg whole-name
)
1656 "Hardlink selected files whose names match REGEXP to NEWNAME.
1657 See function `dired-do-rename-regexp' for more info."
1658 (interactive (dired-mark-read-regexp "HardLink"))
1659 (dired-do-create-files-regexp
1660 (function add-name-to-file
)
1661 "HardLink" arg regexp newname whole-name dired-keep-marker-hardlink
))
1664 (defun dired-do-symlink-regexp (regexp newname
&optional arg whole-name
)
1665 "Symlink selected files whose names match REGEXP to NEWNAME.
1666 See function `dired-do-rename-regexp' for more info."
1667 (interactive (dired-mark-read-regexp "SymLink"))
1668 (dired-do-create-files-regexp
1669 (function make-symbolic-link
)
1670 "SymLink" arg regexp newname whole-name dired-keep-marker-symlink
))
1672 (defun dired-create-files-non-directory
1673 (file-creator basename-constructor operation arg
)
1674 ;; Perform FILE-CREATOR on the non-directory part of marked files
1675 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1676 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1677 (let (rename-non-directory-query)
1681 (dired-get-marked-files nil arg
)
1684 (let ((to (concat (file-name-directory from
)
1685 (funcall basename-constructor
1686 (file-name-nondirectory from
)))))
1687 (and (let ((help-form (format "\
1688 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1689 `!' to %s all remaining matches with no more questions."
1690 (downcase operation
)
1691 (downcase operation
))))
1692 (dired-query 'rename-non-directory-query
1693 (concat operation
" `%s' to `%s'")
1694 (dired-make-relative from
)
1695 (dired-make-relative to
)))
1697 dired-keep-marker-rename
)))
1699 (defun dired-rename-non-directory (basename-constructor operation arg
)
1700 (dired-create-files-non-directory
1701 (function dired-rename-file
)
1702 basename-constructor operation arg
))
1705 (defun dired-upcase (&optional arg
)
1706 "Rename all marked (or next ARG) files to upper case."
1708 (dired-rename-non-directory (function upcase
) "Rename upcase" arg
))
1711 (defun dired-downcase (&optional arg
)
1712 "Rename all marked (or next ARG) files to lower case."
1714 (dired-rename-non-directory (function downcase
) "Rename downcase" arg
))
1716 ;;;###end dired-re.el
1719 ;;;###begin dired-ins.el
1722 (defun dired-maybe-insert-subdir (dirname &optional
1723 switches no-error-if-not-dir-p
)
1724 "Insert this subdirectory into the same dired buffer.
1725 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
1726 else inserts it at its natural place (as `ls -lR' would have done).
1727 With a prefix arg, you may edit the ls switches used for this listing.
1728 You can add `R' to the switches to expand the whole tree starting at
1730 This function takes some pains to conform to `ls -lR' output."
1732 (list (dired-get-filename)
1733 (if current-prefix-arg
1734 (read-string "Switches for listing: "
1735 (or dired-subdir-switches dired-actual-switches
)))))
1736 (let ((opoint (point)))
1737 ;; We don't need a marker for opoint as the subdir is always
1738 ;; inserted *after* opoint.
1739 (setq dirname
(file-name-as-directory dirname
))
1740 (or (and (not switches
)
1741 (dired-goto-subdir dirname
))
1742 (dired-insert-subdir dirname switches no-error-if-not-dir-p
))
1743 ;; Push mark so that it's easy to find back. Do this after the
1744 ;; insert message so that the user sees the `Mark set' message.
1745 (push-mark opoint
)))
1748 (defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p
)
1749 "Insert this subdirectory into the same dired buffer.
1750 If it is already present, overwrites previous entry,
1751 else inserts it at its natural place (as `ls -lR' would have done).
1752 With a prefix arg, you may edit the `ls' switches used for this listing.
1753 You can add `R' to the switches to expand the whole tree starting at
1755 This function takes some pains to conform to `ls -lR' output."
1756 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1757 ;; Prospero where dired-ls does the right thing, but
1758 ;; file-directory-p has not been redefined.
1760 (list (dired-get-filename)
1761 (if current-prefix-arg
1762 (read-string "Switches for listing: "
1763 (or dired-subdir-switches dired-actual-switches
)))))
1764 (setq dirname
(file-name-as-directory (expand-file-name dirname
)))
1765 (or no-error-if-not-dir-p
1766 (file-directory-p dirname
)
1767 (error "Attempt to insert a non-directory: %s" dirname
))
1768 (let ((elt (assoc dirname dired-subdir-alist
))
1769 (cons (assoc-string dirname dired-switches-alist
))
1770 (modflag (buffer-modified-p))
1771 (old-switches switches
)
1772 switches-have-R mark-alist case-fold-search buffer-read-only
)
1773 (and (not switches
) cons
(setq switches
(cdr cons
)))
1774 (dired-insert-subdir-validate dirname switches
)
1775 ;; case-fold-search is nil now, so we can test for capital `R':
1776 (if (setq switches-have-R
(and switches
(string-match "R" switches
)))
1777 ;; avoid duplicated subdirs
1778 (setq mark-alist
(dired-kill-tree dirname t
)))
1780 ;; If subdir is already present, remove it and remember its marks
1781 (setq mark-alist
(nconc (dired-insert-subdir-del elt
) mark-alist
))
1782 (dired-insert-subdir-newpos dirname
)) ; else compute new position
1783 (dired-insert-subdir-doupdate
1784 dirname elt
(dired-insert-subdir-doinsert dirname switches
))
1787 (setcdr cons switches
)
1788 (push (cons dirname switches
) dired-switches-alist
)))
1789 (when switches-have-R
1790 (dired-build-subdir-alist switches
)
1791 (dolist (cur-ass dired-subdir-alist
)
1792 (let ((cur-dir (car cur-ass
)))
1793 (and (dired-in-this-tree cur-dir dirname
)
1794 (not (string= cur-dir dirname
))
1795 (let ((cur-cons (assoc-string cur-dir dired-switches-alist
)))
1797 (setcdr cur-cons switches
)
1798 (push (cons cur-dir switches
) dired-switches-alist
)))))))
1799 (dired-initial-position dirname
)
1800 (save-excursion (dired-mark-remembered mark-alist
))
1801 (restore-buffer-modified-p modflag
)))
1803 ;; This is a separate function for dired-vms.
1804 (defun dired-insert-subdir-validate (dirname &optional switches
)
1805 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1806 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1807 (or (dired-in-this-tree dirname
(expand-file-name default-directory
))
1808 (error "%s: not in this directory tree" dirname
))
1809 (let ((real-switches (or switches dired-subdir-switches
)))
1811 (let (case-fold-search)
1815 (or (eq (null (string-match x real-switches
))
1816 (null (string-match x dired-actual-switches
)))
1818 "Can't have dirs with and without -%s switches together" x
))))
1819 ;; all switches that make a difference to dired-get-filename:
1822 (defun dired-alist-add (dir new-marker
)
1823 ;; Add new DIR at NEW-MARKER. Sort alist.
1824 (dired-alist-add-1 dir new-marker
)
1827 (defun dired-alist-sort ()
1828 ;; Keep the alist sorted on buffer position.
1829 (setq dired-subdir-alist
1830 (sort dired-subdir-alist
1831 (function (lambda (elt1 elt2
)
1832 (> (dired-get-subdir-min elt1
)
1833 (dired-get-subdir-min elt2
)))))))
1835 (defun dired-kill-tree (dirname &optional remember-marks
)
1836 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1837 With optional arg REMEMBER-MARKS, return an alist of marked files."
1838 (interactive "DKill tree below directory: ")
1839 (setq dirname
(expand-file-name dirname
))
1840 (let ((s-alist dired-subdir-alist
) dir m-alist
)
1842 (setq dir
(car (car s-alist
))
1843 s-alist
(cdr s-alist
))
1844 (if (and (not (string-equal dir dirname
))
1845 (dired-in-this-tree dir dirname
)
1846 (dired-goto-subdir dir
))
1847 (setq m-alist
(nconc (dired-kill-subdir remember-marks
) m-alist
))))
1850 (defun dired-insert-subdir-newpos (new-dir)
1851 ;; Find pos for new subdir, according to tree order.
1852 ;;(goto-char (point-max))
1853 (let ((alist dired-subdir-alist
) elt dir pos new-pos
)
1855 (setq elt
(car alist
)
1858 pos
(dired-get-subdir-min elt
))
1859 (if (dired-tree-lessp dir new-dir
)
1860 ;; Insert NEW-DIR after DIR
1861 (setq new-pos
(dired-get-subdir-max elt
)
1863 (goto-char new-pos
))
1864 ;; want a separating newline between subdirs
1870 (defun dired-insert-subdir-del (element)
1871 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1872 ;; Move to that buffer position. Return a mark-alist.
1873 (let ((begin-marker (dired-get-subdir-min element
)))
1874 (goto-char begin-marker
)
1875 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1876 (goto-char (dired-subdir-max))
1877 (or (eobp);; want a separating newline _between_ subdirs:
1880 (dired-remember-marks begin-marker
(point))
1881 (delete-region begin-marker
(point)))))
1883 (defun dired-insert-subdir-doinsert (dirname switches
)
1884 ;; Insert ls output after point.
1885 ;; Return the boundary of the inserted text (as list of BEG and END).
1887 (let ((begin (point)))
1888 (let ((dired-actual-switches
1890 dired-subdir-switches
1891 (dired-replace-in-string "R" "" dired-actual-switches
))))
1892 (if (equal dirname
(car (car (last dired-subdir-alist
))))
1893 ;; If doing the top level directory of the buffer,
1894 ;; redo it as specified in dired-directory.
1895 (dired-readin-insert)
1896 (dired-insert-directory dirname dired-actual-switches nil nil t
)))
1897 (list begin
(point)))))
1899 (defun dired-insert-subdir-doupdate (dirname elt beg-end
)
1900 ;; Point is at the correct subdir alist position for ELT,
1901 ;; BEG-END is the subdir-region (as list of begin and end).
1902 (if elt
; subdir was already present
1903 ;; update its position (should actually be unchanged)
1904 (set-marker (dired-get-subdir-min elt
) (point-marker))
1905 (dired-alist-add dirname
(point-marker)))
1906 ;; The hook may depend on the subdir-alist containing the just
1907 ;; inserted subdir, so run it after dired-alist-add:
1908 (if dired-after-readin-hook
1910 (let ((begin (nth 0 beg-end
))
1911 (end (nth 1 beg-end
)))
1914 (narrow-to-region begin end
)
1915 ;; hook may add or delete lines, but the subdir boundary
1917 (run-hooks 'dired-after-readin-hook
))))))
1919 (defun dired-tree-lessp (dir1 dir2
)
1920 ;; Lexicographic order on file name components, like `ls -lR':
1921 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1922 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1923 ;; or DIR1 and DIR2 are in the same parentdir and their last
1924 ;; components are string-lessp.
1925 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1926 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1927 ;; if dired-actual-switches contained `t'.
1928 (setq dir1
(file-name-as-directory dir1
)
1929 dir2
(file-name-as-directory dir2
))
1930 (let ((components-1 (dired-split "/" dir1
))
1931 (components-2 (dired-split "/" dir2
)))
1932 (while (and components-1
1934 (equal (car components-1
) (car components-2
)))
1935 (setq components-1
(cdr components-1
)
1936 components-2
(cdr components-2
)))
1937 (let ((c1 (car components-1
))
1938 (c2 (car components-2
)))
1941 (string-lessp c1 c2
))
1942 ((and (null c1
) (null c2
))
1943 nil
) ; they are equal, not lessp
1944 ((null c1
) ; c2 is a subdir of c1: c1<c2
1946 ((null c2
) ; c1 is a subdir of c2: c1>c2
1948 (t (error "This can't happen"))))))
1950 ;; There should be a builtin split function - inverse to mapconcat.
1951 (defun dired-split (pat str
&optional limit
)
1952 "Splitting on regexp PAT, turn string STR into a list of substrings.
1953 Optional third arg LIMIT (>= 1) is a limit to the length of the
1955 Thus, if SEP is a regexp that only matches itself,
1957 (mapconcat 'identity (dired-split SEP STRING) SEP)
1959 is always equal to STRING."
1960 (let* ((start (string-match pat str
))
1961 (result (list (substring str
0 start
)))
1963 (end (if start
(match-end 0))))
1964 (if end
; else nothing left
1965 (while (and (or (not (integerp limit
))
1967 (string-match pat str end
))
1968 (setq start
(match-beginning 0)
1970 result
(cons (substring str end start
) result
)
1974 (if (and (or (not (integerp limit
))
1976 end
) ; else nothing left
1978 (cons (substring str end
) result
)))
1981 ;;; moving by subdirectories
1984 (defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip
)
1985 "Go to previous subdirectory, regardless of level.
1986 When called interactively and not on a subdir line, go to this subdir's line."
1989 (list (if current-prefix-arg
1990 (prefix-numeric-value current-prefix-arg
)
1991 ;; if on subdir start already, don't stay there!
1992 (if (dired-get-subdir) 1 0))))
1993 (dired-next-subdir (- arg
) no-error-if-not-found no-skip
))
1995 (defun dired-subdir-min ()
1997 (if (not (dired-prev-subdir 0 t t
))
1998 (error "Not in a subdir!")
2002 (defun dired-goto-subdir (dir)
2003 "Go to end of header line of DIR in this dired buffer.
2004 Return value of point on success, otherwise return nil.
2005 The next char is either \\n, or \\r if DIR is hidden."
2007 (prog1 ; let push-mark display its message
2008 (list (expand-file-name
2009 (completing-read "Goto in situ directory: " ; prompt
2010 dired-subdir-alist
; table
2013 (dired-current-directory))))
2015 (setq dir
(file-name-as-directory dir
))
2016 (let ((elt (assoc dir dired-subdir-alist
)))
2018 (goto-char (dired-get-subdir-min elt
))
2019 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2020 ;; at either \r or \n after this function succeeds.
2021 (progn (skip-chars-forward "^\r\n")
2025 (defun dired-mark-subdir-files ()
2026 "Mark all files except `.' and `..' in current subdirectory.
2027 If the Dired buffer shows multiple directories, this command
2028 marks the files listed in the subdirectory that point is in."
2030 (let ((p-min (dired-subdir-min)))
2031 (dired-mark-files-in-region p-min
(dired-subdir-max))))
2034 (defun dired-kill-subdir (&optional remember-marks
)
2035 "Remove all lines of current subdirectory.
2036 Lower levels are unaffected."
2037 ;; With optional REMEMBER-MARKS, return a mark-alist.
2039 (let* ((beg (dired-subdir-min))
2040 (end (dired-subdir-max))
2041 (modflag (buffer-modified-p))
2042 (cur-dir (dired-current-directory))
2043 (cons (assoc-string cur-dir dired-switches-alist
))
2045 (if (equal cur-dir default-directory
)
2046 (error "Attempt to kill top level directory"))
2048 (if remember-marks
(dired-remember-marks beg end
))
2049 (delete-region beg end
)
2050 (if (eobp) ; don't leave final blank line
2052 (dired-unsubdir cur-dir
)
2054 (setq dired-switches-alist
(delete cons dired-switches-alist
)))
2055 (restore-buffer-modified-p modflag
))))
2057 (defun dired-unsubdir (dir)
2058 ;; Remove DIR from the alist
2059 (setq dired-subdir-alist
2060 (delq (assoc dir dired-subdir-alist
) dired-subdir-alist
)))
2063 (defun dired-tree-up (arg)
2064 "Go up ARG levels in the dired tree."
2066 (let ((dir (dired-current-directory)))
2069 dir
(file-name-directory (directory-file-name dir
))))
2070 ;;(setq dir (expand-file-name dir))
2071 (or (dired-goto-subdir dir
)
2072 (error "Cannot go up to %s - not in this tree" dir
))))
2075 (defun dired-tree-down ()
2076 "Go down in the dired tree."
2078 (let ((dir (dired-current-directory)) ; has slash
2079 pos case-fold-search
) ; filenames are case sensitive
2080 (let ((rest (reverse dired-subdir-alist
)) elt
)
2082 (setq elt
(car rest
)
2084 (if (dired-in-this-tree (directory-file-name (car elt
)) dir
)
2086 pos
(dired-goto-subdir (car elt
))))))
2089 (error "At the bottom"))))
2093 (defun dired-unhide-subdir ()
2094 (let (buffer-read-only)
2095 (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?
\r ?
\n)))
2097 (defun dired-hide-check ()
2098 (or selective-display
2099 (error "selective-display must be t for subdir hiding to work!")))
2101 (defun dired-subdir-hidden-p (dir)
2102 (and selective-display
2104 (dired-goto-subdir dir
)
2105 (looking-at "\r"))))
2108 (defun dired-hide-subdir (arg)
2109 "Hide or unhide the current subdirectory and move to next directory.
2110 Optional prefix arg is a repeat factor.
2111 Use \\[dired-hide-all] to (un)hide all directories."
2114 (let ((modflag (buffer-modified-p)))
2115 (while (>= (setq arg
(1- arg
)) 0)
2116 (let* ((cur-dir (dired-current-directory))
2117 (hidden-p (dired-subdir-hidden-p cur-dir
))
2118 (elt (assoc cur-dir dired-subdir-alist
))
2119 (end-pos (1- (dired-get-subdir-max elt
)))
2121 ;; keep header line visible, hide rest
2122 (goto-char (dired-get-subdir-min elt
))
2123 (skip-chars-forward "^\n\r")
2125 (subst-char-in-region (point) end-pos ?
\r ?
\n)
2126 (subst-char-in-region (point) end-pos ?
\n ?
\r)))
2127 (dired-next-subdir 1 t
))
2128 (restore-buffer-modified-p modflag
)))
2131 (defun dired-hide-all (arg)
2132 "Hide all subdirectories, leaving only their header lines.
2133 If there is already something hidden, make everything visible again.
2134 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2137 (let ((modflag (buffer-modified-p))
2140 (goto-char (point-min))
2141 (search-forward "\r" nil t
))
2142 ;; unhide - bombs on \r in filenames
2143 (subst-char-in-region (point-min) (point-max) ?
\r ?
\n)
2145 (let ((pos (point-max)) ; pos of end of last directory
2146 (alist dired-subdir-alist
))
2147 (while alist
; while there are dirs before pos
2148 (subst-char-in-region (dired-get-subdir-min (car alist
)) ; pos of prev dir
2150 (goto-char pos
) ; current dir
2151 ;; we're somewhere on current dir's line
2155 (setq pos
(dired-get-subdir-min (car alist
))) ; prev dir gets current dir
2156 (setq alist
(cdr alist
)))))
2157 (restore-buffer-modified-p modflag
)))
2159 ;;;###end dired-ins.el
2162 ;; Functions for searching in tags style among marked files.
2165 (defun dired-do-search (regexp)
2166 "Search through all marked files for a match for REGEXP.
2167 Stops when a match is found.
2168 To continue searching for next match, use command \\[tags-loop-continue]."
2169 (interactive "sSearch marked files (regexp): ")
2170 (tags-search regexp
'(dired-get-marked-files nil nil
'dired-nondirectory-p
)))
2173 (defun dired-do-query-replace-regexp (from to
&optional delimited
)
2174 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2175 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2176 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
2177 with the command \\[tags-loop-continue]."
2179 "sQuery replace in marked files (regexp): \nsQuery replace %s by: \nP")
2180 (dolist (file (dired-get-marked-files nil nil
'dired-nondirectory-p
))
2181 (let ((buffer (get-file-buffer file
)))
2182 (if (and buffer
(with-current-buffer buffer
2184 (error "File `%s' is visited read-only" file
))))
2185 (tags-query-replace from to delimited
2186 '(dired-get-marked-files nil nil
'dired-nondirectory-p
)))
2188 (defun dired-nondirectory-p (file)
2189 (not (file-directory-p file
)))
2192 (defun dired-show-file-type (file &optional deref-symlinks
)
2193 "Print the type of FILE, according to the `file' command.
2194 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2195 true then the type of the file linked to by FILE is printed instead."
2196 (interactive (list (dired-get-filename t
) current-prefix-arg
))
2199 (call-process "file" nil t t
"-L" "--" file
)
2200 (call-process "file" nil t t
"--" file
))
2202 (backward-delete-char 1))
2203 (message "%s" (buffer-string))))
2205 (provide 'dired-aux
)
2207 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2208 ;;; dired-aux.el ends here