1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006 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., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, 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))
42 (defvar dired-create-files-failures nil
43 "Variable where `dired-create-files' records failing file names.
44 Functions that operate recursively can store additional names
45 into this list; they also should call `dired-log' to log the errors.")
48 ;;;###begin dired-cmd.el
49 ;; Diffing and compressing
51 (defconst dired-star-subst-regexp "\\(^\\|[ \t]\\)\\*\\([ \t]\\|$\\)")
52 (defconst dired-quark-subst-regexp "\\(^\\|[ \t]\\)\\?\\([ \t]\\|$\\)")
55 (defun dired-diff (file &optional switches)
56 "Compare file at point with file FILE using `diff'.
57 FILE defaults to the file at the mark. (That's the mark set by
58 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
59 The prompted-for file is the first file given to `diff'.
60 With prefix arg, prompt for second argument SWITCHES,
61 which is options for `diff'."
63 (let ((current (dired-get-filename t))
65 (save-excursion (goto-char (mark t))
66 (dired-get-filename t t)))))
67 (if (or (equal default current)
68 (and (not (equal (dired-dwim-target-directory)
69 (dired-current-directory)))
73 (list (read-file-name (format "Diff %s with%s: "
76 (concat " (default " default ")")
79 (dired-current-directory)
80 (dired-dwim-target-directory))
82 (if current-prefix-arg
83 (read-string "Options for diff: "
84 (if (stringp diff-switches)
86 (mapconcat 'identity diff-switches " ")))))))
87 (diff file (dired-get-filename t) switches))
90 (defun dired-backup-diff (&optional switches)
91 "Diff this file with its backup file or vice versa.
92 Uses the latest backup, if there are several numerical backups.
93 If this file is a backup, diff it with its original.
94 The backup file is the first file given to `diff'.
95 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
97 (if current-prefix-arg
98 (list (read-string "Options for diff: "
99 (if (stringp diff-switches)
101 (mapconcat 'identity diff-switches " "))))
103 (diff-backup (dired-get-filename) switches))
106 (defun dired-compare-directories (dir2 predicate)
107 "Mark files with different file attributes in two dired buffers.
108 Compare file attributes of files in the current directory
109 with file attributes in directory DIR2 using PREDICATE on pairs of files
110 with the same name. Mark files for which PREDICATE returns non-nil.
111 Mark files with different names if PREDICATE is nil (or interactively
112 with empty input at the predicate prompt).
114 PREDICATE is a Lisp expression that can refer to the following variables:
116 size1, size2 - file size in bytes
117 mtime1, mtime2 - last modification time in seconds, as a float
118 fa1, fa2 - list of file attributes
119 returned by function `file-attributes'
121 where 1 refers to attribute of file in the current dired buffer
122 and 2 to attribute of file in second dired buffer.
124 Examples of PREDICATE:
126 (> mtime1 mtime2) - mark newer files
127 (not (= size1 size2)) - mark files with different sizes
128 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
129 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
130 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
132 (list (read-directory-name (format "Compare %s with: "
133 (dired-current-directory))
134 (dired-dwim-target-directory)
135 (dired-dwim-target-directory))
136 (read-from-minibuffer "Mark if (lisp expr or RET): " nil nil t nil "nil")))
137 (let* ((dir1 (dired-current-directory))
138 (file-alist1 (dired-files-attributes dir1))
139 (file-alist2 (dired-files-attributes dir2))
140 file-list1 file-list2)
141 (setq file-alist1 (delq (assoc "." file-alist1) file-alist1))
142 (setq file-alist1 (delq (assoc ".." file-alist1) file-alist1))
143 (setq file-alist2 (delq (assoc "." file-alist2) file-alist2))
144 (setq file-alist2 (delq (assoc ".." file-alist2) file-alist2))
145 (setq file-list1 (mapcar
147 (dired-file-set-difference
148 file-alist1 file-alist2
152 (dired-file-set-difference
153 file-alist2 file-alist1
155 (dired-fun-in-all-buffers
159 (member (dired-get-filename nil t) file-list1) nil)))
160 (dired-fun-in-all-buffers
164 (member (dired-get-filename nil t) file-list2) nil)))
165 (message "Marked in dir1: %s files, in dir2: %s files"
167 (length file-list2))))
169 (defun dired-file-set-difference (list1 list2 predicate)
170 "Combine LIST1 and LIST2 using a set-difference operation.
171 The result list contains all file items that appear in LIST1 but not LIST2.
172 This is a non-destructive function; it makes a copy of the data if necessary
173 to avoid corrupting the original LIST1 and LIST2.
174 PREDICATE (see `dired-compare-directories') is an additional match
175 condition. Two file items are considered to match if they are equal
176 *and* PREDICATE evaluates to t."
177 (if (or (null list1) (null list2))
180 (dolist (file1 list1)
181 (unless (let ((list list2))
183 (not (let* ((file2 (car list))
184 (fa1 (car (cddr file1)))
185 (fa2 (car (cddr file2)))
188 (mtime1 (float-time (nth 5 fa1)))
189 (mtime2 (float-time (nth 5 fa2))))
191 (equal (car file1) (car file2))
192 (not (eval predicate))))))
193 (setq list (cdr list)))
195 (setq res (cons file1 res))))
198 (defun dired-files-attributes (dir)
199 "Return a list of all file names and attributes from DIR.
200 List has a form of (file-name full-file-name (attribute-list))"
203 (let ((full-file-name (expand-file-name file-name dir)))
206 (file-attributes full-file-name))))
207 (directory-files dir)))
210 (defun dired-touch-initial (files)
211 "Create initial input value for `touch' command."
214 (let ((current (nth 5 (file-attributes (car files)))))
215 (if (and initial (not (equal initial current)))
216 (setq initial (current-time) files nil)
217 (setq initial current))
218 (setq files (cdr files))))
219 (format-time-string "%Y%m%d%H%M.%S" initial)))
221 (defun dired-do-chxxx (attribute-name program op-symbol arg)
222 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
223 ;; refresh their file lines.
224 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
225 ;; PROGRAM is the program used to change the attribute.
226 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
227 ;; ARG describes which files to use, as in dired-get-marked-files.
228 (let* ((files (dired-get-marked-files t arg))
230 (dired-mark-read-string
231 (concat "Change " attribute-name " of %s to: ")
232 (if (eq op-symbol 'touch) (dired-touch-initial files))
233 op-symbol arg files))
234 (operation (concat program " " new-attribute))
237 (dired-bunch-files 10000
238 (function dired-check-process)
240 (list operation program)
241 (if (eq op-symbol 'touch)
244 (if (string-match "gnu" system-configuration)
247 (dired-do-redisplay arg);; moves point if ARG is an integer
250 (format "%s: error" operation)
254 (defun dired-do-chmod (&optional arg)
255 "Change the mode of the marked (or next ARG) files.
256 This calls chmod, thus symbolic modes like `g+w' are allowed."
258 (dired-do-chxxx "Mode" dired-chmod-program 'chmod arg))
261 (defun dired-do-chgrp (&optional arg)
262 "Change the group of the marked (or next ARG) files."
264 (if (memq system-type '(ms-dos windows-nt))
265 (error "chgrp not supported on this system"))
266 (dired-do-chxxx "Group" "chgrp" 'chgrp arg))
269 (defun dired-do-chown (&optional arg)
270 "Change the owner of the marked (or next ARG) files."
272 (if (memq system-type '(ms-dos windows-nt))
273 (error "chown not supported on this system"))
274 (dired-do-chxxx "Owner" dired-chown-program 'chown arg))
277 (defun dired-do-touch (&optional arg)
278 "Change the timestamp of the marked (or next ARG) files.
281 (dired-do-chxxx "Timestamp" dired-touch-program 'touch arg))
283 ;; Process all the files in FILES in batches of a convenient size,
284 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
285 ;; Batches are chosen to need less than MAX chars for the file names,
286 ;; allowing 3 extra characters of separator per file name.
287 (defun dired-bunch-files (max function args files)
292 ;; Accumulate files as long as they fit in MAX chars,
293 ;; then process the ones accumulated so far.
295 (let* ((thisfile (car files))
296 (thislength (+ (length thisfile) 3))
298 ;; If we have at least 1 pending file
299 ;; and this file won't fit in the length limit, process now.
300 (if (and pending (> (+ thislength pending-length) max))
301 (setq pending (nreverse pending)
302 ;; The elements of PENDING are now in forward order.
303 ;; Do the operation and record failures.
304 failures (nconc (apply function (append args pending))
306 ;; Transfer the elemens of PENDING onto PAST
307 ;; and clear it out. Now PAST contains the first N files
308 ;; specified (for some N), and FILES contains the rest.
309 past (nconc past pending)
312 ;; Do (setq pending (cons thisfile pending))
313 ;; but reuse the cons that was in `files'.
314 (setcdr files pending)
316 (setq pending-length (+ thislength pending-length))
318 (setq pending (nreverse pending))
320 (nconc (apply function (append args pending))
322 ;; Now the original list FILES has been put back as it was.
323 (nconc past pending))))
326 (defun dired-do-print (&optional arg)
327 "Print the marked (or next ARG) files.
328 Uses the shell command coming from variables `lpr-command' and
329 `lpr-switches' as default."
331 (let* ((file-list (dired-get-marked-files t arg))
332 (command (dired-mark-read-string
336 (if (stringp lpr-switches)
340 'print arg file-list)))
341 (dired-run-shell-command (dired-shell-stuff-it command file-list nil))))
343 ;; Read arguments for a marked-files command that wants a string
344 ;; that is not a file name,
345 ;; perhaps popping up the list of marked files.
346 ;; ARG is the prefix arg and indicates whether the files came from
347 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
348 ;; If the current file was used, the list has but one element and ARG
349 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
351 (defun dired-mark-read-string (prompt initial op-symbol arg files)
352 ;; PROMPT for a string, with INITIAL input.
353 ;; Other args are used to give user feedback and pop-up:
354 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
357 (function read-string)
358 (format prompt (dired-mark-prompt arg files)) initial))
360 ;;; Cleaning a directory: flagging some backups for deletion.
362 (defvar dired-file-version-alist)
365 (defun dired-clean-directory (keep)
366 "Flag numerical backups for deletion.
367 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
368 Positive prefix arg KEEP overrides `dired-kept-versions';
369 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
371 To clear the flags on these files, you can use \\[dired-flag-backup-files]
372 with a prefix argument."
374 (setq keep (if keep (prefix-numeric-value keep) dired-kept-versions))
375 (let ((early-retention (if (< keep 0) (- keep) kept-old-versions))
376 (late-retention (if (<= keep 0) dired-kept-versions keep))
377 (dired-file-version-alist ()))
378 (message "Cleaning numerical backups (keeping %d late, %d old)..."
379 late-retention early-retention)
380 ;; Look at each file.
381 ;; If the file has numeric backup versions,
382 ;; put on dired-file-version-alist an element of the form
383 ;; (FILENAME . VERSION-NUMBER-LIST)
384 (dired-map-dired-file-lines (function dired-collect-file-versions))
385 ;; Sort each VERSION-NUMBER-LIST,
386 ;; and remove the versions not to be deleted.
387 (let ((fval dired-file-version-alist))
389 (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<)))
390 (v-count (length sorted-v-list)))
391 (if (> v-count (+ early-retention late-retention))
392 (rplacd (nthcdr early-retention sorted-v-list)
393 (nthcdr (- v-count late-retention)
396 (cdr sorted-v-list)))
397 (setq fval (cdr fval))))
398 ;; Look at each file. If it is a numeric backup file,
399 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
400 (dired-map-dired-file-lines (function dired-trample-file-versions))
401 (message "Cleaning numerical backups...done")))
403 ;;; Subroutines of dired-clean-directory.
405 (defun dired-map-dired-file-lines (fun)
406 ;; Perform FUN with point at the end of each non-directory line.
407 ;; FUN takes one argument, the absolute filename.
409 (let (file buffer-read-only)
410 (goto-char (point-min))
413 (and (not (looking-at dired-re-dir))
415 (setq file (dired-get-filename nil t)) ; nil on non-file
417 (funcall fun file))))
420 (defun dired-collect-file-versions (fn)
421 (let ((fn (file-name-sans-versions fn)))
422 ;; Only do work if this file is not already in the alist.
423 (if (assoc fn dired-file-version-alist)
425 ;; If it looks like file FN has versions, return a list of the versions.
426 ;;That is a list of strings which are file names.
427 ;;The caller may want to flag some of these files for deletion.
428 (let* ((base-versions
429 (concat (file-name-nondirectory fn) ".~"))
430 (backup-extract-version-start (length base-versions))
431 (possibilities (file-name-all-completions
433 (file-name-directory fn)))
434 (versions (mapcar 'backup-extract-version possibilities)))
436 (setq dired-file-version-alist
437 (cons (cons fn versions)
438 dired-file-version-alist)))))))
440 (defun dired-trample-file-versions (fn)
441 (let* ((start-vn (string-match "\\.~[0-9]+~$" fn))
444 (setq base-version-list ; there was a base version to which
445 (assoc (substring fn 0 start-vn) ; this looks like a
446 dired-file-version-alist)) ; subversion
447 (not (memq (string-to-number (substring fn (+ 2 start-vn)))
448 base-version-list)) ; this one doesn't make the cut
449 (progn (beginning-of-line)
451 (insert dired-del-marker)))))
455 (defun dired-read-shell-command (prompt arg files)
456 ;; "Read a dired shell command prompting with PROMPT (using read-string).
457 ;;ARG is the prefix arg and may be used to indicate in the prompt which
458 ;; files are affected.
459 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
462 (function read-string)
463 (format prompt (dired-mark-prompt arg files))
464 nil 'shell-command-history))
466 ;; The in-background argument is only needed in Emacs 18 where
467 ;; shell-command doesn't understand an appended ampersand `&'.
469 (defun dired-do-shell-command (command &optional arg file-list)
470 "Run a shell command COMMAND on the marked files.
471 If no files are marked or a specific numeric prefix arg is given,
472 the next ARG files are used. Just \\[universal-argument] means the current file.
473 The prompt mentions the file(s) or the marker, as appropriate.
475 If there is a `*' in COMMAND, surrounded by whitespace, this runs
476 COMMAND just once with the entire file list substituted there.
478 If there is no `*', but there is a `?' in COMMAND, surrounded by
479 whitespace, this runs COMMAND on each file individually with the
480 file name substituted for `?'.
482 Otherwise, this runs COMMAND on each file individually with the
483 file name added at the end of COMMAND (separated by a space).
485 `*' and `?' when not surrounded by whitespace have no special
486 significance for `dired-do-shell-command', and are passed through
487 normally to the shell, but you must confirm first. To pass `*' by
488 itself to the shell as a wildcard, type `*\"\"'.
490 If COMMAND produces output, it goes to a separate buffer.
492 This feature does not try to redisplay Dired buffers afterward, as
493 there's no telling what files COMMAND may have changed.
494 Type \\[dired-do-redisplay] to redisplay the marked files.
496 When COMMAND runs, its working directory is the top-level directory of
497 the Dired buffer, so output files usually are created there instead of
500 In a noninteractive call (from Lisp code), you must specify
501 the list of file names explicitly with the FILE-LIST argument, which
502 can be produced by `dired-get-marked-files', for example."
503 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
504 ;;actual work and can be redefined for customization.
506 (let ((files (dired-get-marked-files t current-prefix-arg)))
508 ;; Want to give feedback whether this file or marked files are used:
509 (dired-read-shell-command (concat "! on "
515 (let* ((on-each (not (string-match dired-star-subst-regexp command)))
516 (subst (not (string-match dired-quark-subst-regexp command)))
517 (star (not (string-match "\\*" command)))
518 (qmark (not (string-match "\\?" command))))
519 ;; Get confirmation for wildcards that may have been meant
520 ;; to control substitution of a file name or the file name list.
521 (if (cond ((not (or on-each subst))
522 (error "You can not combine `*' and `?' substitution marks"))
523 ((and star (not on-each))
524 (y-or-n-p "Confirm--do you mean to use `*' as a wildcard? "))
525 ((and qmark (not subst))
526 (y-or-n-p "Confirm--do you mean to use `?' as a wildcard? "))
530 (- 10000 (length command))
531 (function (lambda (&rest files)
532 (dired-run-shell-command
533 (dired-shell-stuff-it command files t arg))))
536 ;; execute the shell command
537 (dired-run-shell-command
538 (dired-shell-stuff-it command file-list nil arg))))))
540 ;; Might use {,} for bash or csh:
541 (defvar dired-mark-prefix ""
542 "Prepended to marked files in dired shell commands.")
543 (defvar dired-mark-postfix ""
544 "Appended to marked files in dired shell commands.")
545 (defvar dired-mark-separator " "
546 "Separates marked files in dired shell commands.")
548 (defun dired-shell-stuff-it (command file-list on-each &optional raw-arg)
549 ;; "Make up a shell command line from COMMAND and FILE-LIST.
550 ;; If ON-EACH is t, COMMAND should be applied to each file, else
551 ;; simply concat all files and apply COMMAND to this.
552 ;; FILE-LIST's elements will be quoted for the shell."
553 ;; Might be redefined for smarter things and could then use RAW-ARG
554 ;; (coming from interactive P and currently ignored) to decide what to do.
555 ;; Smart would be a way to access basename or extension of file names.
557 (if (or (string-match dired-star-subst-regexp command)
558 (string-match dired-quark-subst-regexp command))
560 (let ((retval command))
562 "\\(^\\|[ \t]\\)\\([*?]\\)\\([ \t]\\|$\\)" retval)
563 (setq retval (replace-match x t t retval 2)))
565 (lambda (x) (concat command dired-mark-separator x)))))
567 (mapconcat stuff-it (mapcar 'shell-quote-argument file-list) ";")
568 (let ((files (mapconcat 'shell-quote-argument
569 file-list dired-mark-separator)))
570 (if (> (length file-list) 1)
571 (setq files (concat dired-mark-prefix files dired-mark-postfix)))
572 (funcall stuff-it files)))))
574 ;; This is an extra function so that it can be redefined by ange-ftp.
576 (defun dired-run-shell-command (command)
578 (find-file-name-handler (directory-file-name default-directory)
580 (if handler (apply handler 'shell-command (list command))
581 (shell-command command)))
582 ;; Return nil for sake of nconc in dired-bunch-files.
585 ;; In Emacs 19 this will return program's exit status.
586 ;; This is a separate function so that ange-ftp can redefine it.
587 (defun dired-call-process (program discard &rest arguments)
588 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
589 ;Remaining arguments are strings passed as command arguments to PROGRAM."
590 ;; Look for a handler for default-directory in case it is a remote file name.
592 (find-file-name-handler (directory-file-name default-directory)
593 'dired-call-process)))
594 (if handler (apply handler 'dired-call-process
595 program discard arguments)
596 (apply 'call-process program nil (not discard) nil arguments))))
598 (defun dired-check-process (msg program &rest arguments)
599 ; "Display MSG while running PROGRAM, and check for output.
600 ;Remaining arguments are strings passed as command arguments to PROGRAM.
601 ; On error, insert output
602 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
603 ; Caller can cons up a list of failed args.
604 ;Else returns nil for success."
605 (let (err-buffer err (dir default-directory))
606 (message "%s..." msg)
608 ;; Get a clean buffer for error output:
609 (setq err-buffer (get-buffer-create " *dired-check-process output*"))
610 (set-buffer err-buffer)
612 (setq default-directory dir ; caller's default-directory
614 (apply (function dired-call-process) program nil arguments))))
617 (dired-log (concat program " " (prin1-to-string arguments) "\n"))
618 (dired-log err-buffer)
619 (or arguments program t))
620 (kill-buffer err-buffer)
621 (message "%s...done" msg)
624 ;; Commands that delete or redisplay part of the dired buffer.
626 (defun dired-kill-line (&optional arg)
628 (setq arg (prefix-numeric-value arg))
629 (let (buffer-read-only file)
631 (setq file (dired-get-filename nil t))
633 (error "Can only kill file lines")
634 (save-excursion (and file
635 (dired-goto-subdir file)
636 (dired-kill-subdir)))
637 (delete-region (progn (beginning-of-line) (point))
638 (progn (forward-line 1) (point)))
643 (dired-move-to-filename)))
646 (defun dired-do-kill-lines (&optional arg fmt)
647 "Kill all marked lines (not the files).
648 With a prefix argument, kill that many lines starting with the current line.
649 \(A negative argument kills backward.)
650 If you use this command with a prefix argument to kill the line
651 for a file that is a directory, which you have inserted in the
652 Dired buffer as a subdirectory, then it deletes that subdirectory
653 from the buffer as well.
654 To kill an entire subdirectory \(without killing its line in the
655 parent directory), go to its directory header line and use this
656 command with a prefix argument (the value does not matter)."
657 ;; Returns count of killed lines. FMT="" suppresses message.
660 (if (dired-get-subdir)
662 (dired-kill-line arg))
664 (goto-char (point-min))
665 (let (buffer-read-only
667 (regexp (dired-marker-regexp)))
668 (while (and (not (eobp))
669 (re-search-forward regexp nil t))
670 (setq count (1+ count))
671 (delete-region (progn (beginning-of-line) (point))
672 (progn (forward-line 1) (point))))
674 (message (or fmt "Killed %d line%s.") count (dired-plural-s count)))
677 ;;;###end dired-cmd.el
680 ;;;###begin dired-cp.el
682 (defun dired-compress ()
683 ;; Compress or uncompress the current file.
684 ;; Return nil for success, offending filename else.
685 (let* (buffer-read-only
686 (from-file (dired-get-filename))
687 (new-file (dired-compress-file from-file)))
689 (let ((start (point)))
690 ;; Remove any preexisting entry for the name NEW-FILE.
692 (dired-remove-entry new-file)
695 ;; Now replace the current line with an entry for NEW-FILE.
696 (dired-update-file-line new-file) nil)
697 (dired-log (concat "Failed to compress" from-file))
700 (defvar dired-compress-file-suffixes
701 '(("\\.gz\\'" "" "gunzip")
702 ("\\.tgz\\'" ".tar" "gunzip")
703 ("\\.Z\\'" "" "uncompress")
704 ;; For .z, try gunzip. It might be an old gzip file,
705 ;; or it might be from compact? pack? (which?) but gunzip handles both.
706 ("\\.z\\'" "" "gunzip")
707 ("\\.dz\\'" "" "dictunzip")
708 ("\\.tbz\\'" ".tar" "bunzip2")
709 ("\\.bz2\\'" "" "bunzip2")
710 ;; This item controls naming for compression.
711 ("\\.tar\\'" ".tgz" nil))
712 "Control changes in file name suffixes for compression and uncompression.
713 Each element specifies one transformation rule, and has the form:
714 (REGEXP NEW-SUFFIX PROGRAM)
715 The rule applies when the old file name matches REGEXP.
716 The new file name is computed by deleting the part that matches REGEXP
717 (as well as anything after that), then adding NEW-SUFFIX in its place.
718 If PROGRAM is non-nil, the rule is an uncompression rule,
719 and uncompression is done by running PROGRAM.
720 Otherwise, the rule is a compression rule, and compression is done with gzip.")
723 (defun dired-compress-file (file)
724 ;; Compress or uncompress FILE.
725 ;; Return the name of the compressed or uncompressed file.
726 ;; Return nil if no change in files.
727 (let ((handler (find-file-name-handler file 'dired-compress-file))
729 (suffixes dired-compress-file-suffixes))
730 ;; See if any suffix rule matches this file name.
732 (let (case-fold-search)
733 (if (string-match (car (car suffixes)) file)
734 (setq suffix (car suffixes) suffixes nil))
735 (setq suffixes (cdr suffixes))))
736 ;; If so, compute desired new name.
738 (setq newname (concat (substring file 0 (match-beginning 0))
741 (funcall handler 'dired-compress-file file))
742 ((file-symlink-p file)
744 ((and suffix (nth 2 suffix))
745 ;; We found an uncompression rule.
746 (if (not (dired-check-process (concat "Uncompressing " file)
747 (nth 2 suffix) file))
750 ;;; We don't recognize the file as compressed, so compress it.
751 ;;; Try gzip; if we don't have that, use compress.
753 (let ((out-name (concat file ".gz")))
754 (and (or (not (file-exists-p out-name))
756 (format "File %s already exists. Really compress? "
758 (not (dired-check-process (concat "Compressing " file)
760 (or (file-exists-p out-name)
761 (setq out-name (concat file ".z")))
762 ;; Rename the compressed file to NEWNAME
763 ;; if it hasn't got that name already.
764 (if (and newname (not (equal newname out-name)))
766 (rename-file out-name newname t)
770 (if (not (dired-check-process (concat "Compressing " file)
771 "compress" "-f" file))
772 ;; Don't use NEWNAME with `compress'.
773 (concat file ".Z"))))))))
775 (defun dired-mark-confirm (op-symbol arg)
776 ;; Request confirmation from the user that the operation described
777 ;; by OP-SYMBOL is to be performed on the marked files.
778 ;; Confirmation consists in a y-or-n question with a file list
779 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
780 ;; The files used are determined by ARG (as in dired-get-marked-files).
781 (or (eq dired-no-confirm t)
782 (memq op-symbol dired-no-confirm)
783 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
784 ;; is marked pops up a window. That will help the user see
785 ;; it isn't the current line file.
786 (let ((files (dired-get-marked-files t arg nil t))
787 (string (if (eq op-symbol 'compress) "Compress or uncompress"
788 (capitalize (symbol-name op-symbol)))))
789 (dired-mark-pop-up nil op-symbol files (function y-or-n-p)
791 (dired-mark-prompt arg files) "? ")))))
793 (defun dired-map-over-marks-check (fun arg op-symbol &optional show-progress)
794 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
795 ; and display failures.
797 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
798 ; the short form of the filename) for a failure and probably logs a
799 ; detailed error explanation using function `dired-log'.
801 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
802 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
803 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
804 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
806 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
807 (if (dired-mark-confirm op-symbol arg)
808 (let* ((total-list;; all of FUN's return values
809 (dired-map-over-marks (funcall fun) arg show-progress))
810 (total (length total-list))
811 (failures (delq nil total-list))
812 (count (length failures))
813 (string (if (eq op-symbol 'compress) "Compress or uncompress"
814 (capitalize (symbol-name op-symbol)))))
816 (message "%s: %d file%s."
817 string total (dired-plural-s total))
818 ;; end this bunch of errors:
820 (format "Failed to %s %d of %d file%s"
821 (downcase string) count total (dired-plural-s total))
824 (defvar dired-query-alist
825 '((?\y . y) (?\040 . y) ; `y' or SPC means accept once
826 (?n . n) (?\177 . n) ; `n' or DEL skips once
827 (?! . yes) ; `!' accepts rest
828 (?q . no) (?\e . no) ; `q' or ESC skips rest
829 ;; None of these keys quit - use C-g for that.
833 (defun dired-query (qs-var qs-prompt &rest qs-args)
834 ;; Query user and return nil or t.
835 ;; Store answer in symbol VAR (which must initially be bound to nil).
836 ;; Format PROMPT with ARGS.
837 ;; Binding variable help-form will help the user who types the help key.
838 (let* ((char (symbol-value qs-var))
839 (action (cdr (assoc char dired-query-alist))))
840 (cond ((eq 'yes action)
841 t) ; accept, and don't ask again
843 nil) ; skip, and don't ask again
844 (t;; no lasting effects from last time we asked - ask now
845 (let ((qprompt (concat qs-prompt
847 (format " [Type yn!q or %s] "
849 (char-to-string help-char)))
850 " [Type y, n, q or !] ")))
852 ;; Actually it looks nicer without cursor-in-echo-area - you can
853 ;; look at the dired buffer instead of at the prompt to decide.
854 (apply 'message qprompt qs-args)
855 (setq char (set qs-var (read-char)))
856 (while (not (setq elt (assoc char dired-query-alist)))
857 (message "Invalid char - type %c for help." help-char)
860 (apply 'message qprompt qs-args)
861 (setq char (set qs-var (read-char))))
862 ;; Display the question with the answer.
863 (message "%s" (concat (apply 'format qprompt qs-args)
864 (char-to-string char)))
865 (memq (cdr elt) '(t y yes)))))))
868 (defun dired-do-compress (&optional arg)
869 "Compress or uncompress marked (or next ARG) files."
871 (dired-map-over-marks-check (function dired-compress) arg 'compress t))
873 ;; Commands for Emacs Lisp files - load and byte compile
875 (defun dired-byte-compile ()
876 ;; Return nil for success, offending file name else.
877 (let* ((filename (dired-get-filename))
878 elc-file buffer-read-only failure)
880 (save-excursion (byte-compile-file filename))
883 (setq elc-file (byte-compile-dest-file filename))
884 (or (file-exists-p elc-file)
888 (dired-log "Byte compile error for %s:\n%s\n" filename failure)
889 (dired-make-relative filename))
890 (dired-remove-file elc-file)
891 (forward-line) ; insert .elc after its .el file
892 (dired-add-file elc-file)
896 (defun dired-do-byte-compile (&optional arg)
897 "Byte compile marked (or next ARG) Emacs Lisp files."
899 (dired-map-over-marks-check (function dired-byte-compile) arg 'byte-compile t))
902 ;; Return nil for success, offending file name else.
903 (let ((file (dired-get-filename)) failure)
905 (load file nil nil t)
906 (error (setq failure err)))
909 (dired-log "Load error for %s:\n%s\n" file failure)
910 (dired-make-relative file))))
913 (defun dired-do-load (&optional arg)
914 "Load the marked (or next ARG) Emacs Lisp files."
916 (dired-map-over-marks-check (function dired-load) arg 'load t))
919 (defun dired-do-redisplay (&optional arg test-for-subdir)
920 "Redisplay all marked (or next ARG) files.
921 If on a subdir line, redisplay that subdirectory. In that case,
922 a prefix arg lets you edit the `ls' switches used for the new listing.
924 Dired remembers switches specified with a prefix arg, so that reverting
925 the buffer will not reset them. However, using `dired-undo' to re-insert
926 or delete subdirectories can bypass this machinery. Hence, you sometimes
927 may have to reset some subdirectory switches after a `dired-undo'.
928 You can reset all subdirectory switches to the default using
929 \\<dired-mode-map>\\[dired-reset-subdir-switches].
930 See Info node `(emacs)Subdir switches' for more details."
931 ;; Moves point if the next ARG files are redisplayed.
933 (if (and test-for-subdir (dired-get-subdir))
934 (let* ((dir (dired-get-subdir))
935 (switches (cdr (assoc-string dir dired-switches-alist))))
939 (read-string "Switches for listing: "
941 dired-subdir-switches
942 dired-actual-switches)))))
943 (message "Redisplaying...")
944 ;; message much faster than making dired-map-over-marks show progress
946 (if (consp dired-directory) (car dired-directory) dired-directory))
947 (dired-map-over-marks (let ((fname (dired-get-filename)))
948 (message "Redisplaying... %s" fname)
949 (dired-update-file-line fname))
951 (dired-move-to-filename)
952 (message "Redisplaying...done")))
954 (defun dired-reset-subdir-switches ()
955 "Set `dired-switches-alist' to nil and revert dired buffer."
957 (setq dired-switches-alist nil)
960 (defun dired-update-file-line (file)
961 ;; Delete the current line, and insert an entry for FILE.
962 ;; If FILE is nil, then just delete the current line.
963 ;; Keeps any marks that may be present in column one (doing this
964 ;; here is faster than with dired-add-entry's optional arg).
965 ;; Does not update other dired buffers. Use dired-relist-entry for that.
967 (let ((char (following-char)) (opoint (point))
969 (delete-region (point) (progn (forward-line 1) (point)))
972 (dired-add-entry file nil t)
973 ;; Replace space by old marker without moving point.
974 ;; Faster than goto+insdel inside a save-excursion?
975 (subst-char-in-region opoint (1+ opoint) ?\040 char))))
976 (dired-move-to-filename))
979 (defun dired-add-file (filename &optional marker-char)
980 (dired-fun-in-all-buffers
981 (file-name-directory filename) (file-name-nondirectory filename)
982 (function dired-add-entry) filename marker-char))
984 (defun dired-add-entry (filename &optional marker-char relative)
985 ;; Add a new entry for FILENAME, optionally marking it
986 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
987 ;; Note that this adds the entry `out of order' if files sorted by
989 ;; At least this version inserts in the right subdirectory (if present).
990 ;; And it skips "." or ".." (see `dired-trivial-filenames').
991 ;; Hidden subdirs are exposed if a file is added there.
992 (setq filename (directory-file-name filename))
993 ;; Entry is always for files, even if they happen to also be directories
994 (let* ((opoint (point))
995 (cur-dir (dired-current-directory))
996 (orig-file-name filename)
997 (directory (if relative cur-dir (file-name-directory filename)))
1001 (file-relative-name filename directory)
1002 (file-name-nondirectory filename))
1005 (if (string= directory cur-dir)
1007 (skip-chars-forward "^\r\n")
1008 (if (eq (following-char) ?\r)
1009 (dired-unhide-subdir))
1010 ;; We are already where we should be, except when
1011 ;; point is before the subdir line or its total line.
1012 (let ((p (dired-after-subdir-garbage cur-dir)))
1015 ;; else try to find correct place to insert
1016 (if (dired-goto-subdir directory)
1017 (progn ;; unhide if necessary
1018 (if (looking-at "\r") ;; point is at end of subdir line
1019 (dired-unhide-subdir))
1020 ;; found - skip subdir and `total' line
1021 ;; and uninteresting files like . and ..
1022 ;; This better not moves into the next subdir!
1023 (dired-goto-next-nontrivial-file))
1025 (throw 'not-found "Subdir not found")))
1026 (let (buffer-read-only opoint)
1028 (setq opoint (point))
1029 ;; Don't expand `.'. Show just the file name within directory.
1030 (let ((default-directory directory))
1031 (dired-insert-directory directory
1032 (concat dired-actual-switches "d")
1035 ;; Put in desired marker char.
1037 (let ((dired-marker-char
1038 (if (integerp marker-char) marker-char dired-marker-char)))
1040 ;; Compensate for a bug in ange-ftp.
1041 ;; It inserts the file's absolute name, rather than
1042 ;; the relative one. That may be hard to fix since it
1043 ;; is probably controlled by something in ftp.
1045 (let ((inserted-name (dired-get-filename 'verbatim)))
1046 (if (file-name-directory inserted-name)
1049 (forward-char (- (length inserted-name)))
1050 (setq props (text-properties-at (point)))
1051 (delete-char (length inserted-name))
1054 (set-text-properties pt (point) props))
1058 (if dired-after-readin-hook ;; the subdir-alist is not affected...
1059 (save-excursion ;; ...so we can run it right now:
1062 (narrow-to-region (point) (save-excursion
1063 (forward-line 1) (point)))
1064 (run-hooks 'dired-after-readin-hook))))
1065 (dired-move-to-filename))
1066 ;; return nil if all went well
1068 (if reason ; don't move away on failure
1070 (not reason))) ; return t on success, nil else
1072 (defun dired-after-subdir-garbage (dir)
1073 ;; Return pos of first file line of DIR, skipping header and total
1074 ;; or wildcard lines.
1075 ;; Important: never moves into the next subdir.
1076 ;; DIR is assumed to be unhidden.
1077 ;; Will probably be redefined for VMS etc.
1079 (or (dired-goto-subdir dir) (error "This cannot happen"))
1081 (while (and (not (eolp)) ; don't cross subdir boundary
1082 (not (dired-move-to-filename)))
1087 (defun dired-remove-file (file)
1088 (dired-fun-in-all-buffers
1089 (file-name-directory file) (file-name-nondirectory file)
1090 (function dired-remove-entry) file))
1092 (defun dired-remove-entry (file)
1094 (and (dired-goto-file file)
1095 (let (buffer-read-only)
1096 (delete-region (progn (beginning-of-line) (point))
1097 (save-excursion (forward-line 1) (point)))))))
1100 (defun dired-relist-file (file)
1101 "Create or update the line for FILE in all Dired buffers it would belong in."
1102 (dired-fun-in-all-buffers (file-name-directory file)
1103 (file-name-nondirectory file)
1104 (function dired-relist-entry) file))
1106 (defun dired-relist-entry (file)
1107 ;; Relist the line for FILE, or just add it if it did not exist.
1108 ;; FILE must be an absolute file name.
1109 (let (buffer-read-only marker)
1110 ;; If cursor is already on FILE's line delete-region will cause
1111 ;; save-excursion to fail because of floating makers,
1112 ;; moving point to beginning of line. Sigh.
1114 (and (dired-goto-file file)
1115 (delete-region (progn (beginning-of-line)
1116 (setq marker (following-char))
1118 (save-excursion (forward-line 1) (point))))
1119 (setq file (directory-file-name file))
1120 (dired-add-entry file (if (eq ?\040 marker) nil marker)))))
1122 ;;; Copy, move/rename, making hard and symbolic links
1124 (defcustom dired-backup-overwrite nil
1125 "*Non-nil if Dired should ask about making backups before overwriting files.
1126 Special value `always' suppresses confirmation."
1127 :type '(choice (const :tag "off" nil)
1128 (const :tag "suppress" always)
1129 (other :tag "ask" t))
1132 (defvar dired-overwrite-confirmed)
1134 (defun dired-handle-overwrite (to)
1135 ;; Save old version of file TO that is to be overwritten.
1136 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1137 ;; from dired-create-files.
1139 (if (and dired-backup-overwrite
1140 dired-overwrite-confirmed
1141 (setq backup (car (find-backup-file-name to)))
1142 (or (eq 'always dired-backup-overwrite)
1143 (dired-query 'overwrite-backup-query
1144 "Make backup for existing file `%s'? "
1147 (rename-file to backup 0) ; confirm overwrite of old backup
1148 (dired-relist-entry backup)))))
1151 (defun dired-copy-file (from to ok-flag)
1152 (dired-handle-overwrite to)
1153 (dired-copy-file-recursive from to ok-flag dired-copy-preserve-time t
1154 dired-recursive-copies))
1156 (defun dired-copy-file-recursive (from to ok-flag &optional
1157 preserve-time top recursive)
1158 (let ((attrs (file-attributes from))
1162 (or (eq recursive 'always)
1163 (yes-or-no-p (format "Recursive copies of %s? " from))))
1164 ;; This is a directory.
1167 (directory-files from nil dired-re-no-dot)
1169 (push (dired-make-relative from)
1170 dired-create-files-failures)
1171 (dired-log "Copying error for %s:\n%s\n" from err)
1174 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask any more.
1176 (if (file-exists-p to)
1177 (or top (dired-handle-overwrite to))
1181 (push (dired-make-relative from)
1182 dired-create-files-failures)
1184 (dired-log "Copying error for %s:\n%s\n" from err)))))
1185 (dolist (file files)
1186 (let ((thisfrom (expand-file-name file from))
1187 (thisto (expand-file-name file to)))
1188 ;; Catch errors copying within a directory,
1189 ;; and report them through the dired log mechanism
1190 ;; just as our caller will do for the top level files.
1192 (dired-copy-file-recursive
1194 ok-flag preserve-time nil recursive)
1196 (push (dired-make-relative thisfrom)
1197 dired-create-files-failures)
1198 (dired-log "Copying error for %s:\n%s\n" thisfrom err))))))
1200 (or top (dired-handle-overwrite to))
1202 (if (stringp (car attrs))
1204 (make-symbolic-link (car attrs) to ok-flag)
1205 (copy-file from to ok-flag dired-copy-preserve-time))
1207 (push (dired-make-relative from)
1208 dired-create-files-failures)
1209 (dired-log "Can't set date on %s:\n%s\n" from err))))))
1212 (defun dired-rename-file (file newname ok-if-already-exists)
1213 (dired-handle-overwrite newname)
1214 (rename-file file newname ok-if-already-exists) ; error is caught in -create-files
1215 ;; Silently rename the visited file of any buffer visiting this file.
1216 (and (get-file-buffer file)
1217 (with-current-buffer (get-file-buffer file)
1218 (set-visited-file-name newname nil t)))
1219 (dired-remove-file file)
1220 ;; See if it's an inserted subdir, and rename that, too.
1221 (dired-rename-subdir file newname))
1223 (defun dired-rename-subdir (from-dir to-dir)
1224 (setq from-dir (file-name-as-directory from-dir)
1225 to-dir (file-name-as-directory to-dir))
1226 (dired-fun-in-all-buffers from-dir nil
1227 (function dired-rename-subdir-1) from-dir to-dir)
1228 ;; Update visited file name of all affected buffers
1229 (let ((expanded-from-dir (expand-file-name from-dir))
1230 (blist (buffer-list)))
1233 (set-buffer (car blist))
1234 (if (and buffer-file-name
1235 (dired-in-this-tree buffer-file-name expanded-from-dir))
1236 (let ((modflag (buffer-modified-p))
1237 (to-file (dired-replace-in-string
1238 (concat "^" (regexp-quote from-dir))
1241 (set-visited-file-name to-file)
1242 (set-buffer-modified-p modflag))))
1243 (setq blist (cdr blist)))))
1245 (defun dired-rename-subdir-1 (dir to)
1246 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1247 ;; one of its subdirectories is expanded in this buffer.
1248 (let ((expanded-dir (expand-file-name dir))
1249 (alist dired-subdir-alist)
1252 (setq elt (car alist)
1254 (if (dired-in-this-tree (car elt) expanded-dir)
1255 ;; ELT's subdir is affected by the rename
1256 (dired-rename-subdir-2 elt dir to)))
1257 (if (equal dir default-directory)
1258 ;; if top level directory was renamed, lots of things have to be
1261 (dired-unadvertise dir) ; we no longer dired DIR...
1262 (setq default-directory to
1263 dired-directory (expand-file-name;; this is correct
1264 ;; with and without wildcards
1265 (file-name-nondirectory dired-directory)
1267 (let ((new-name (file-name-nondirectory
1268 (directory-file-name dired-directory))))
1269 ;; try to rename buffer, but just leave old name if new
1270 ;; name would already exist (don't try appending "<%d>")
1271 (or (get-buffer new-name)
1272 (rename-buffer new-name)))
1273 ;; ... we dired TO now:
1274 (dired-advertise)))))
1276 (defun dired-rename-subdir-2 (elt dir to)
1277 ;; Update the headerline and dired-subdir-alist element, as well as
1278 ;; dired-switches-alist element, of directory described by
1279 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1280 ;; describes either DIR itself or a subdir of DIR.
1282 (let ((regexp (regexp-quote (directory-file-name dir)))
1283 (newtext (directory-file-name to))
1285 (goto-char (dired-get-subdir-min elt))
1286 ;; Update subdir headerline in buffer
1287 (if (not (looking-at dired-subdir-regexp))
1288 (error "%s not found where expected - dired-subdir-alist broken?"
1290 (goto-char (match-beginning 1))
1291 (if (re-search-forward regexp (match-end 1) t)
1292 (replace-match newtext t t)
1293 (error "Expected to find `%s' in headerline of %s" dir (car elt))))
1294 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1295 (let ((cons (assoc-string (car elt) dired-switches-alist))
1296 (cur-dir (dired-normalize-subdir
1297 (dired-replace-in-string regexp newtext (car elt)))))
1298 (setcar elt cur-dir)
1299 (when cons (setcar cons cur-dir))))))
1301 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1302 (defun dired-create-files (file-creator operation fn-list name-constructor
1303 &optional marker-char)
1305 ;; Create a new file for each from a list of existing files. The user
1306 ;; is queried, dired buffers are updated, and at the end a success or
1307 ;; failure message is displayed
1309 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1311 ;; It is called for each file and must create newfile, the entry of
1312 ;; which will be added. The user will be queried if the file already
1313 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1314 ;; rename), it is FILE-CREATOR's responsibility to update dired
1315 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1316 ;; could not create newfile. The error is caught and logged.
1318 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1319 ;; operation performed. It is used for error logging.
1321 ;; FN-LIST is the list of files to copy (full absolute file names).
1323 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1324 ;; skip. If it skips files for other reasons than a direct user
1325 ;; query, it is supposed to tell why (using dired-log).
1327 ;; Optional MARKER-CHAR is a character with which to mark every
1328 ;; newfile's entry, or t to use the current marker character if the
1329 ;; oldfile was marked.
1331 (let (dired-create-files-failures failures
1332 skipped (success-count 0) (total (length fn-list)))
1333 (let (to overwrite-query
1334 overwrite-backup-query) ; for dired-handle-overwrite
1338 (setq to (funcall name-constructor from))
1342 (dired-log "Cannot %s to same file: %s\n"
1343 (downcase operation) from)))
1345 (setq skipped (cons (dired-make-relative from) skipped))
1346 (let* ((overwrite (file-exists-p to))
1347 (dired-overwrite-confirmed ; for dired-handle-overwrite
1349 (let ((help-form '(format "\
1350 Type SPC or `y' to overwrite file `%s',
1351 DEL or `n' to skip to next,
1352 ESC or `q' to not overwrite any of the remaining files,
1353 `!' to overwrite all remaining files with no more questions." to)))
1354 (dired-query 'overwrite-query
1355 "Overwrite `%s'?" to))))
1356 ;; must determine if FROM is marked before file-creator
1357 ;; gets a chance to delete it (in case of a move).
1359 (cond ((integerp marker-char) marker-char)
1360 (marker-char (dired-file-marker from)) ; slow
1364 (funcall file-creator from to dired-overwrite-confirmed)
1366 ;; If we get here, file-creator hasn't been aborted
1367 ;; and the old entry (if any) has to be deleted
1368 ;; before adding the new entry.
1369 (dired-remove-file to))
1370 (setq success-count (1+ success-count))
1371 (message "%s: %d of %d" operation success-count total)
1372 (dired-add-file to actual-marker-char))
1373 (file-error ; FILE-CREATOR aborted
1375 (push (dired-make-relative from)
1377 (dired-log "%s `%s' to `%s' failed:\n%s\n"
1378 operation from to err))))))))
1381 (dired-create-files-failures
1382 (setq failures (nconc failures dired-create-files-failures))
1384 (format "%s failed for %d file%s in %d requests"
1385 operation (length failures)
1386 (dired-plural-s (length failures))
1391 (format "%s failed for %d of %d file%s"
1392 operation (length failures)
1393 total (dired-plural-s total))
1397 (format "%s: %d of %d file%s skipped"
1398 operation (length skipped) total
1399 (dired-plural-s total))
1402 (message "%s: %s file%s"
1403 operation success-count (dired-plural-s success-count)))))
1404 (dired-move-to-filename))
1406 (defun dired-do-create-files (op-symbol file-creator operation arg
1407 &optional marker-char op1
1409 "Create a new file for each marked file.
1410 Prompts user for target, which is a directory in which to create
1411 the new files. Target may be a plain file if only one marked
1412 file exists. The way the default for the target directory is
1413 computed depends on the value of `dired-dwim-target-directory'.
1414 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1415 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1416 FILE-CREATOR and OPERATION as in `dired-create-files'.
1417 ARG as in `dired-get-marked-files'.
1418 Optional arg MARKER-CHAR as in `dired-create-files'.
1419 Optional arg OP1 is an alternate form for OPERATION if there is
1421 Optional arg HOW-TO is used to set the value of the into-dir variable
1422 which determines how to treat target.
1423 If into-dir is set to nil then target is not regarded as a directory,
1424 there must be exactly one marked file, else error.
1425 Else if into-dir is set to a list, then target is a generalized
1426 directory (e.g. some sort of archive). The first element of into-dir
1427 must be a function with at least four arguments:
1428 operation as OPERATION above.
1429 rfn-list a list of the relative names for the marked files.
1430 fn-list a list of the absolute names for the marked files.
1432 The rest of into-dir are optional arguments.
1433 Else into-dir is not a list. Target is a directory.
1434 The marked file(s) are created inside the target directory.
1436 If HOW-TO is not given (or nil), then into-dir is set to true if
1437 target is a directory and otherwise to nil.
1438 Else if HOW-TO is t, then into-dir is set to nil.
1439 Else HOW-TO is assumed to be a function of one argument, target,
1440 that looks at target and returns a value for the into-dir
1441 variable. The function `dired-into-dir-with-symlinks' is provided
1442 for the case (common when creating symlinks) that symbolic
1443 links to directories are not to be considered as directories
1444 (as `file-directory-p' would if HOW-TO had been nil)."
1445 (or op1 (setq op1 operation))
1446 (let* ((fn-list (dired-get-marked-files nil arg))
1447 (rfn-list (mapcar (function dired-make-relative) fn-list))
1448 (dired-one-file ; fluid variable inside dired-create-files
1449 (and (consp fn-list) (null (cdr fn-list)) (car fn-list)))
1450 (target-dir (dired-dwim-target-directory))
1451 (default (and dired-one-file
1452 (expand-file-name (file-name-nondirectory (car fn-list))
1454 (target (expand-file-name ; fluid variable inside dired-create-files
1455 (dired-mark-read-file-name
1456 (concat (if dired-one-file op1 operation) " %s to: ")
1457 target-dir op-symbol arg rfn-list default)))
1458 (into-dir (cond ((null how-to)
1459 ;; Allow DOS/Windows users to change the letter
1460 ;; case of a directory. If we don't test these
1461 ;; conditions up front, file-directory-p below
1462 ;; will return t because the filesystem is
1463 ;; case-insensitive, and Emacs will try to move
1464 ;; foo -> foo/foo, which fails.
1465 (if (and (memq system-type '(ms-dos windows-nt cygwin))
1466 (eq op-symbol 'move)
1469 (expand-file-name (car fn-list)))
1471 (expand-file-name target)))
1473 (file-name-nondirectory (car fn-list))
1474 (file-name-nondirectory target))))
1476 (file-directory-p target)))
1478 (t (funcall how-to target)))))
1479 (if (and (consp into-dir) (functionp (car into-dir)))
1480 (apply (car into-dir) operation rfn-list fn-list target (cdr into-dir))
1481 (if (not (or dired-one-file into-dir))
1482 (error "Marked %s: target must be a directory: %s" operation target))
1483 ;; rename-file bombs when moving directories unless we do this:
1484 (or into-dir (setq target (directory-file-name target)))
1486 file-creator operation fn-list
1487 (if into-dir ; target is a directory
1488 ;; This function uses fluid variable target when called
1489 ;; inside dired-create-files:
1492 (expand-file-name (file-name-nondirectory from) target)))
1493 (function (lambda (from) target)))
1496 ;; Read arguments for a marked-files command that wants a file name,
1497 ;; perhaps popping up the list of marked files.
1498 ;; ARG is the prefix arg and indicates whether the files came from
1499 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1500 ;; If the current file was used, the list has but one element and ARG
1501 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1502 ;; DEFAULT is the default value to return if the user just hits RET;
1503 ;; if it is omitted or nil, then the name of the directory is used.
1505 (defun dired-mark-read-file-name (prompt dir op-symbol arg files
1509 (function read-file-name)
1510 (format prompt (dired-mark-prompt arg files)) dir default))
1512 (defun dired-dwim-target-directory ()
1513 ;; Try to guess which target directory the user may want.
1514 ;; If there is a dired buffer displayed in the next window, use
1515 ;; its current subdir, else use current subdir of this dired buffer.
1516 (let ((this-dir (and (eq major-mode 'dired-mode)
1517 (dired-current-directory))))
1518 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1519 (if dired-dwim-target
1520 (let* ((other-buf (window-buffer (next-window)))
1521 (other-dir (save-excursion
1522 (set-buffer other-buf)
1523 (and (eq major-mode 'dired-mode)
1524 (dired-current-directory)))))
1525 (or other-dir this-dir))
1529 (defun dired-create-directory (directory)
1530 "Create a directory called DIRECTORY."
1532 (list (read-file-name "Create directory: " (dired-current-directory))))
1533 (let ((expanded (directory-file-name (expand-file-name directory))))
1534 (make-directory expanded)
1535 (dired-add-file expanded)
1536 (dired-move-to-filename)))
1538 (defun dired-into-dir-with-symlinks (target)
1539 (and (file-directory-p target)
1540 (not (file-symlink-p target))))
1541 ;; This may not always be what you want, especially if target is your
1542 ;; home directory and it happens to be a symbolic link, as is often the
1543 ;; case with NFS and automounters. Or if you want to make symlinks
1544 ;; into directories that themselves are only symlinks, also quite
1547 ;; So we don't use this function as value for HOW-TO in
1548 ;; dired-do-symlink, which has the minor disadvantage of
1549 ;; making links *into* a symlinked-dir, when you really wanted to
1550 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1551 ;; just have to remove that symlink by hand before making your marked
1554 (defvar dired-copy-how-to-fn nil
1555 "nil or a function used by `dired-do-copy' to determine target.
1556 See HOW-TO argument for `dired-do-create-files'.")
1559 (defun dired-do-copy (&optional arg)
1560 "Copy all marked (or next ARG) files, or copy the current file.
1561 This normally preserves the last-modified date when copying.
1562 When operating on just the current file, you specify the new name.
1563 When operating on multiple or marked files, you specify a directory,
1564 and new copies of these files are made in that directory
1565 with the same names that the files currently have. The default
1566 suggested for the target directory depends on the value of
1567 `dired-dwim-target', which see.
1569 This command copies symbolic links by creating new ones,
1572 (let ((dired-recursive-copies dired-recursive-copies))
1573 (dired-do-create-files 'copy (function dired-copy-file)
1575 arg dired-keep-marker-copy
1576 nil dired-copy-how-to-fn)))
1579 (defun dired-do-symlink (&optional arg)
1580 "Make symbolic links to current file or all marked (or next ARG) files.
1581 When operating on just the current file, you specify the new name.
1582 When operating on multiple or marked files, you specify a directory
1583 and new symbolic links are made in that directory
1584 with the same names that the files currently have. The default
1585 suggested for the target directory depends on the value of
1586 `dired-dwim-target', which see."
1588 (dired-do-create-files 'symlink (function make-symbolic-link)
1589 "Symlink" arg dired-keep-marker-symlink))
1592 (defun dired-do-hardlink (&optional arg)
1593 "Add names (hard links) current file or all marked (or next ARG) files.
1594 When operating on just the current file, you specify the new name.
1595 When operating on multiple or marked files, you specify a directory
1596 and new hard links are made in that directory
1597 with the same names that the files currently have. The default
1598 suggested for the target directory depends on the value of
1599 `dired-dwim-target', which see."
1601 (dired-do-create-files 'hardlink (function dired-hardlink)
1602 "Hardlink" arg dired-keep-marker-hardlink))
1604 (defun dired-hardlink (file newname &optional ok-if-already-exists)
1605 (dired-handle-overwrite newname)
1606 ;; error is caught in -create-files
1607 (add-name-to-file file newname ok-if-already-exists)
1608 ;; Update the link count
1609 (dired-relist-file file))
1612 (defun dired-do-rename (&optional arg)
1613 "Rename current file or all marked (or next ARG) files.
1614 When renaming just the current file, you specify the new name.
1615 When renaming multiple or marked files, you specify a directory.
1616 This command also renames any buffers that are visiting the files.
1617 The default suggested for the target directory depends on the value
1618 of `dired-dwim-target', which see."
1620 (dired-do-create-files 'move (function dired-rename-file)
1621 "Move" arg dired-keep-marker-rename "Rename"))
1622 ;;;###end dired-cp.el
1625 ;;;###begin dired-re.el
1626 (defun dired-do-create-files-regexp
1627 (file-creator operation arg regexp newname &optional whole-name marker-char)
1628 ;; Create a new file for each marked file using regexps.
1629 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1630 ;; ARG as in dired-get-marked-files.
1631 ;; Matches each marked file against REGEXP and constructs the new
1632 ;; filename from NEWNAME (like in function replace-match).
1633 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1634 ;; instead of only the non-directory part of the file.
1635 ;; Optional arg MARKER-CHAR as in dired-create-files.
1636 (let* ((fn-list (dired-get-marked-files nil arg))
1637 (fn-count (length fn-list))
1638 (operation-prompt (concat operation " `%s' to `%s'?"))
1639 (rename-regexp-help-form (format "\
1640 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1641 `!' to %s all remaining matches with no more questions."
1642 (downcase operation)
1643 (downcase operation)))
1644 (regexp-name-constructor
1645 ;; Function to construct new filename using REGEXP and NEWNAME:
1646 (if whole-name ; easy (but rare) case
1649 (let ((to (dired-string-replace-match regexp from newname))
1650 ;; must bind help-form directly around call to
1652 (help-form rename-regexp-help-form))
1654 (and (dired-query 'rename-regexp-query
1659 (dired-log "%s: %s did not match regexp %s\n"
1660 operation from regexp)))))
1661 ;; not whole-name, replace non-directory part only
1664 (let* ((new (dired-string-replace-match
1665 regexp (file-name-nondirectory from) newname))
1666 (to (and new ; nil means there was no match
1667 (expand-file-name new
1668 (file-name-directory from))))
1669 (help-form rename-regexp-help-form))
1671 (and (dired-query 'rename-regexp-query
1673 (dired-make-relative from)
1674 (dired-make-relative to))
1676 (dired-log "%s: %s did not match regexp %s\n"
1677 operation (file-name-nondirectory from) regexp)))))))
1678 rename-regexp-query)
1680 file-creator operation fn-list regexp-name-constructor marker-char)))
1682 (defun dired-mark-read-regexp (operation)
1683 ;; Prompt user about performing OPERATION.
1684 ;; Read and return list of: regexp newname arg whole-name.
1686 (equal 0 (prefix-numeric-value current-prefix-arg)))
1688 (if whole-name nil current-prefix-arg))
1691 (concat (if whole-name "Abs. " "") operation " from (regexp): ")))
1694 (concat (if whole-name "Abs. " "") operation " " regexp " to: "))))
1695 (list regexp newname arg whole-name)))
1698 (defun dired-do-rename-regexp (regexp newname &optional arg whole-name)
1699 "Rename selected files whose names match REGEXP to NEWNAME.
1701 With non-zero prefix argument ARG, the command operates on the next ARG
1702 files. Otherwise, it operates on all the marked files, or the current
1703 file if none are marked.
1705 As each match is found, the user must type a character saying
1706 what to do with it. For directions, type \\[help-command] at that time.
1707 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
1708 REGEXP defaults to the last regexp used.
1710 With a zero prefix arg, renaming by regexp affects the absolute file name.
1711 Normally, only the non-directory part of the file name is used and changed."
1712 (interactive (dired-mark-read-regexp "Rename"))
1713 (dired-do-create-files-regexp
1714 (function dired-rename-file)
1715 "Rename" arg regexp newname whole-name dired-keep-marker-rename))
1718 (defun dired-do-copy-regexp (regexp newname &optional arg whole-name)
1719 "Copy selected files whose names match REGEXP to NEWNAME.
1720 See function `dired-do-rename-regexp' for more info."
1721 (interactive (dired-mark-read-regexp "Copy"))
1722 (let ((dired-recursive-copies nil)) ; No recursive copies.
1723 (dired-do-create-files-regexp
1724 (function dired-copy-file)
1725 (if dired-copy-preserve-time "Copy [-p]" "Copy")
1726 arg regexp newname whole-name dired-keep-marker-copy)))
1729 (defun dired-do-hardlink-regexp (regexp newname &optional arg whole-name)
1730 "Hardlink selected files whose names match REGEXP to NEWNAME.
1731 See function `dired-do-rename-regexp' for more info."
1732 (interactive (dired-mark-read-regexp "HardLink"))
1733 (dired-do-create-files-regexp
1734 (function add-name-to-file)
1735 "HardLink" arg regexp newname whole-name dired-keep-marker-hardlink))
1738 (defun dired-do-symlink-regexp (regexp newname &optional arg whole-name)
1739 "Symlink selected files whose names match REGEXP to NEWNAME.
1740 See function `dired-do-rename-regexp' for more info."
1741 (interactive (dired-mark-read-regexp "SymLink"))
1742 (dired-do-create-files-regexp
1743 (function make-symbolic-link)
1744 "SymLink" arg regexp newname whole-name dired-keep-marker-symlink))
1746 (defun dired-create-files-non-directory
1747 (file-creator basename-constructor operation arg)
1748 ;; Perform FILE-CREATOR on the non-directory part of marked files
1749 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1750 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1751 (let (rename-non-directory-query)
1755 (dired-get-marked-files nil arg)
1758 (let ((to (concat (file-name-directory from)
1759 (funcall basename-constructor
1760 (file-name-nondirectory from)))))
1761 (and (let ((help-form (format "\
1762 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1763 `!' to %s all remaining matches with no more questions."
1764 (downcase operation)
1765 (downcase operation))))
1766 (dired-query 'rename-non-directory-query
1767 (concat operation " `%s' to `%s'")
1768 (dired-make-relative from)
1769 (dired-make-relative to)))
1771 dired-keep-marker-rename)))
1773 (defun dired-rename-non-directory (basename-constructor operation arg)
1774 (dired-create-files-non-directory
1775 (function dired-rename-file)
1776 basename-constructor operation arg))
1779 (defun dired-upcase (&optional arg)
1780 "Rename all marked (or next ARG) files to upper case."
1782 (dired-rename-non-directory (function upcase) "Rename upcase" arg))
1785 (defun dired-downcase (&optional arg)
1786 "Rename all marked (or next ARG) files to lower case."
1788 (dired-rename-non-directory (function downcase) "Rename downcase" arg))
1790 ;;;###end dired-re.el
1793 ;;;###begin dired-ins.el
1796 (defun dired-maybe-insert-subdir (dirname &optional
1797 switches no-error-if-not-dir-p)
1798 "Insert this subdirectory into the same dired buffer.
1799 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
1800 else inserts it at its natural place (as `ls -lR' would have done).
1801 With a prefix arg, you may edit the ls switches used for this listing.
1802 You can add `R' to the switches to expand the whole tree starting at
1804 This function takes some pains to conform to `ls -lR' output.
1806 Dired remembers switches specified with a prefix arg, so that reverting
1807 the buffer will not reset them. However, using `dired-undo' to re-insert
1808 or delete subdirectories can bypass this machinery. Hence, you sometimes
1809 may have to reset some subdirectory switches after a `dired-undo'.
1810 You can reset all subdirectory switches to the default using
1811 \\<dired-mode-map>\\[dired-reset-subdir-switches].
1812 See Info node `(emacs)Subdir switches' for more details."
1814 (list (dired-get-filename)
1815 (if current-prefix-arg
1816 (read-string "Switches for listing: "
1817 (or dired-subdir-switches dired-actual-switches)))))
1818 (let ((opoint (point)))
1819 ;; We don't need a marker for opoint as the subdir is always
1820 ;; inserted *after* opoint.
1821 (setq dirname (file-name-as-directory dirname))
1822 (or (and (not switches)
1823 (dired-goto-subdir dirname))
1824 (dired-insert-subdir dirname switches no-error-if-not-dir-p))
1825 ;; Push mark so that it's easy to find back. Do this after the
1826 ;; insert message so that the user sees the `Mark set' message.
1827 (push-mark opoint)))
1830 (defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p)
1831 "Insert this subdirectory into the same dired buffer.
1832 If it is already present, overwrites previous entry,
1833 else inserts it at its natural place (as `ls -lR' would have done).
1834 With a prefix arg, you may edit the `ls' switches used for this listing.
1835 You can add `R' to the switches to expand the whole tree starting at
1837 This function takes some pains to conform to `ls -lR' output."
1838 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1839 ;; Prospero where dired-ls does the right thing, but
1840 ;; file-directory-p has not been redefined.
1842 (list (dired-get-filename)
1843 (if current-prefix-arg
1844 (read-string "Switches for listing: "
1845 (or dired-subdir-switches dired-actual-switches)))))
1846 (setq dirname (file-name-as-directory (expand-file-name dirname)))
1847 (or no-error-if-not-dir-p
1848 (file-directory-p dirname)
1849 (error "Attempt to insert a non-directory: %s" dirname))
1850 (let ((elt (assoc dirname dired-subdir-alist))
1851 (cons (assoc-string dirname dired-switches-alist))
1852 (modflag (buffer-modified-p))
1853 (old-switches switches)
1854 switches-have-R mark-alist case-fold-search buffer-read-only)
1855 (and (not switches) cons (setq switches (cdr cons)))
1856 (dired-insert-subdir-validate dirname switches)
1857 ;; case-fold-search is nil now, so we can test for capital `R':
1858 (if (setq switches-have-R (and switches (string-match "R" switches)))
1859 ;; avoid duplicated subdirs
1860 (setq mark-alist (dired-kill-tree dirname t)))
1862 ;; If subdir is already present, remove it and remember its marks
1863 (setq mark-alist (nconc (dired-insert-subdir-del elt) mark-alist))
1864 (dired-insert-subdir-newpos dirname)) ; else compute new position
1865 (dired-insert-subdir-doupdate
1866 dirname elt (dired-insert-subdir-doinsert dirname switches))
1869 (setcdr cons switches)
1870 (push (cons dirname switches) dired-switches-alist)))
1871 (when switches-have-R
1872 (dired-build-subdir-alist switches)
1873 (setq switches (dired-replace-in-string "R" "" switches))
1874 (dolist (cur-ass dired-subdir-alist)
1875 (let ((cur-dir (car cur-ass)))
1876 (and (dired-in-this-tree cur-dir dirname)
1877 (let ((cur-cons (assoc-string cur-dir dired-switches-alist)))
1879 (setcdr cur-cons switches)
1880 (push (cons cur-dir switches) dired-switches-alist)))))))
1881 (dired-initial-position dirname)
1882 (save-excursion (dired-mark-remembered mark-alist))
1883 (restore-buffer-modified-p modflag)))
1885 ;; This is a separate function for dired-vms.
1886 (defun dired-insert-subdir-validate (dirname &optional switches)
1887 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1888 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1889 (or (dired-in-this-tree dirname (expand-file-name default-directory))
1890 (error "%s: not in this directory tree" dirname))
1891 (let ((real-switches (or switches dired-subdir-switches)))
1893 (let (case-fold-search)
1897 (or (eq (null (string-match x real-switches))
1898 (null (string-match x dired-actual-switches)))
1900 "Can't have dirs with and without -%s switches together" x))))
1901 ;; all switches that make a difference to dired-get-filename:
1904 (defun dired-alist-add (dir new-marker)
1905 ;; Add new DIR at NEW-MARKER. Sort alist.
1906 (dired-alist-add-1 dir new-marker)
1909 (defun dired-alist-sort ()
1910 ;; Keep the alist sorted on buffer position.
1911 (setq dired-subdir-alist
1912 (sort dired-subdir-alist
1913 (function (lambda (elt1 elt2)
1914 (> (dired-get-subdir-min elt1)
1915 (dired-get-subdir-min elt2)))))))
1917 (defun dired-kill-tree (dirname &optional remember-marks kill-root)
1918 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1919 Interactively, you can kill DIRNAME as well by using a prefix argument.
1920 In interactive use, the command prompts for DIRNAME.
1922 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1923 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1924 (interactive "DKill tree below directory: \ni\nP")
1925 (setq dirname (file-name-as-directory (expand-file-name dirname)))
1926 (let ((s-alist dired-subdir-alist) dir m-alist)
1928 (setq dir (car (car s-alist))
1929 s-alist (cdr s-alist))
1930 (and (or kill-root (not (string-equal dir dirname)))
1931 (dired-in-this-tree dir dirname)
1932 (dired-goto-subdir dir)
1933 (setq m-alist (nconc (dired-kill-subdir remember-marks) m-alist))))
1936 (defun dired-insert-subdir-newpos (new-dir)
1937 ;; Find pos for new subdir, according to tree order.
1938 ;;(goto-char (point-max))
1939 (let ((alist dired-subdir-alist) elt dir pos new-pos)
1941 (setq elt (car alist)
1944 pos (dired-get-subdir-min elt))
1945 (if (dired-tree-lessp dir new-dir)
1946 ;; Insert NEW-DIR after DIR
1947 (setq new-pos (dired-get-subdir-max elt)
1949 (goto-char new-pos))
1950 ;; want a separating newline between subdirs
1956 (defun dired-insert-subdir-del (element)
1957 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1958 ;; Move to that buffer position. Return a mark-alist.
1959 (let ((begin-marker (dired-get-subdir-min element)))
1960 (goto-char begin-marker)
1961 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1962 (goto-char (dired-subdir-max))
1963 (or (eobp);; want a separating newline _between_ subdirs:
1966 (dired-remember-marks begin-marker (point))
1967 (delete-region begin-marker (point)))))
1969 (defun dired-insert-subdir-doinsert (dirname switches)
1970 ;; Insert ls output after point.
1971 ;; Return the boundary of the inserted text (as list of BEG and END).
1973 (let ((begin (point)))
1974 (let ((dired-actual-switches
1976 dired-subdir-switches
1977 (dired-replace-in-string "R" "" dired-actual-switches))))
1978 (if (equal dirname (car (car (last dired-subdir-alist))))
1979 ;; If doing the top level directory of the buffer,
1980 ;; redo it as specified in dired-directory.
1981 (dired-readin-insert)
1982 (dired-insert-directory dirname dired-actual-switches nil nil t)))
1983 (list begin (point)))))
1985 (defun dired-insert-subdir-doupdate (dirname elt beg-end)
1986 ;; Point is at the correct subdir alist position for ELT,
1987 ;; BEG-END is the subdir-region (as list of begin and end).
1988 (if elt ; subdir was already present
1989 ;; update its position (should actually be unchanged)
1990 (set-marker (dired-get-subdir-min elt) (point-marker))
1991 (dired-alist-add dirname (point-marker)))
1992 ;; The hook may depend on the subdir-alist containing the just
1993 ;; inserted subdir, so run it after dired-alist-add:
1994 (if dired-after-readin-hook
1996 (let ((begin (nth 0 beg-end))
1997 (end (nth 1 beg-end)))
2000 (narrow-to-region begin end)
2001 ;; hook may add or delete lines, but the subdir boundary
2003 (run-hooks 'dired-after-readin-hook))))))
2005 (defun dired-tree-lessp (dir1 dir2)
2006 ;; Lexicographic order on file name components, like `ls -lR':
2007 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
2008 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
2009 ;; or DIR1 and DIR2 are in the same parentdir and their last
2010 ;; components are string-lessp.
2011 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2012 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2013 ;; if dired-actual-switches contained `t'.
2014 (setq dir1 (file-name-as-directory dir1)
2015 dir2 (file-name-as-directory dir2))
2016 (let ((components-1 (dired-split "/" dir1))
2017 (components-2 (dired-split "/" dir2)))
2018 (while (and components-1
2020 (equal (car components-1) (car components-2)))
2021 (setq components-1 (cdr components-1)
2022 components-2 (cdr components-2)))
2023 (let ((c1 (car components-1))
2024 (c2 (car components-2)))
2027 (string-lessp c1 c2))
2028 ((and (null c1) (null c2))
2029 nil) ; they are equal, not lessp
2030 ((null c1) ; c2 is a subdir of c1: c1<c2
2032 ((null c2) ; c1 is a subdir of c2: c1>c2
2034 (t (error "This can't happen"))))))
2036 ;; There should be a builtin split function - inverse to mapconcat.
2037 (defun dired-split (pat str &optional limit)
2038 "Splitting on regexp PAT, turn string STR into a list of substrings.
2039 Optional third arg LIMIT (>= 1) is a limit to the length of the
2041 Thus, if SEP is a regexp that only matches itself,
2043 (mapconcat 'identity (dired-split SEP STRING) SEP)
2045 is always equal to STRING."
2046 (let* ((start (string-match pat str))
2047 (result (list (substring str 0 start)))
2049 (end (if start (match-end 0))))
2050 (if end ; else nothing left
2051 (while (and (or (not (integerp limit))
2053 (string-match pat str end))
2054 (setq start (match-beginning 0)
2056 result (cons (substring str end start) result)
2060 (if (and (or (not (integerp limit))
2062 end) ; else nothing left
2064 (cons (substring str end) result)))
2067 ;;; moving by subdirectories
2070 (defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip)
2071 "Go to previous subdirectory, regardless of level.
2072 When called interactively and not on a subdir line, go to this subdir's line."
2075 (list (if current-prefix-arg
2076 (prefix-numeric-value current-prefix-arg)
2077 ;; if on subdir start already, don't stay there!
2078 (if (dired-get-subdir) 1 0))))
2079 (dired-next-subdir (- arg) no-error-if-not-found no-skip))
2081 (defun dired-subdir-min ()
2083 (if (not (dired-prev-subdir 0 t t))
2084 (error "Not in a subdir!")
2088 (defun dired-goto-subdir (dir)
2089 "Go to end of header line of DIR in this dired buffer.
2090 Return value of point on success, otherwise return nil.
2091 The next char is either \\n, or \\r if DIR is hidden."
2093 (prog1 ; let push-mark display its message
2094 (list (expand-file-name
2095 (completing-read "Goto in situ directory: " ; prompt
2096 dired-subdir-alist ; table
2099 (dired-current-directory))))
2101 (setq dir (file-name-as-directory dir))
2102 (let ((elt (assoc dir dired-subdir-alist)))
2104 (goto-char (dired-get-subdir-min elt))
2105 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2106 ;; at either \r or \n after this function succeeds.
2107 (progn (skip-chars-forward "^\r\n")
2111 (defun dired-mark-subdir-files ()
2112 "Mark all files except `.' and `..' in current subdirectory.
2113 If the Dired buffer shows multiple directories, this command
2114 marks the files listed in the subdirectory that point is in."
2116 (let ((p-min (dired-subdir-min)))
2117 (dired-mark-files-in-region p-min (dired-subdir-max))))
2120 (defun dired-kill-subdir (&optional remember-marks)
2121 "Remove all lines of current subdirectory.
2122 Lower levels are unaffected."
2123 ;; With optional REMEMBER-MARKS, return a mark-alist.
2125 (let* ((beg (dired-subdir-min))
2126 (end (dired-subdir-max))
2127 (modflag (buffer-modified-p))
2128 (cur-dir (dired-current-directory))
2129 (cons (assoc-string cur-dir dired-switches-alist))
2131 (if (equal cur-dir default-directory)
2132 (error "Attempt to kill top level directory"))
2134 (if remember-marks (dired-remember-marks beg end))
2135 (delete-region beg end)
2136 (if (eobp) ; don't leave final blank line
2138 (dired-unsubdir cur-dir)
2140 (setq dired-switches-alist (delete cons dired-switches-alist)))
2141 (restore-buffer-modified-p modflag))))
2143 (defun dired-unsubdir (dir)
2144 ;; Remove DIR from the alist
2145 (setq dired-subdir-alist
2146 (delq (assoc dir dired-subdir-alist) dired-subdir-alist)))
2149 (defun dired-tree-up (arg)
2150 "Go up ARG levels in the dired tree."
2152 (let ((dir (dired-current-directory)))
2155 dir (file-name-directory (directory-file-name dir))))
2156 ;;(setq dir (expand-file-name dir))
2157 (or (dired-goto-subdir dir)
2158 (error "Cannot go up to %s - not in this tree" dir))))
2161 (defun dired-tree-down ()
2162 "Go down in the dired tree."
2164 (let ((dir (dired-current-directory)) ; has slash
2165 pos case-fold-search) ; filenames are case sensitive
2166 (let ((rest (reverse dired-subdir-alist)) elt)
2168 (setq elt (car rest)
2170 (if (dired-in-this-tree (directory-file-name (car elt)) dir)
2172 pos (dired-goto-subdir (car elt))))))
2175 (error "At the bottom"))))
2179 (defun dired-unhide-subdir ()
2180 (let (buffer-read-only)
2181 (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?\r ?\n)))
2183 (defun dired-hide-check ()
2184 (or selective-display
2185 (error "selective-display must be t for subdir hiding to work!")))
2187 (defun dired-subdir-hidden-p (dir)
2188 (and selective-display
2190 (dired-goto-subdir dir)
2191 (looking-at "\r"))))
2194 (defun dired-hide-subdir (arg)
2195 "Hide or unhide the current subdirectory and move to next directory.
2196 Optional prefix arg is a repeat factor.
2197 Use \\[dired-hide-all] to (un)hide all directories."
2200 (let ((modflag (buffer-modified-p)))
2201 (while (>= (setq arg (1- arg)) 0)
2202 (let* ((cur-dir (dired-current-directory))
2203 (hidden-p (dired-subdir-hidden-p cur-dir))
2204 (elt (assoc cur-dir dired-subdir-alist))
2205 (end-pos (1- (dired-get-subdir-max elt)))
2207 ;; keep header line visible, hide rest
2208 (goto-char (dired-get-subdir-min elt))
2209 (skip-chars-forward "^\n\r")
2211 (subst-char-in-region (point) end-pos ?\r ?\n)
2212 (subst-char-in-region (point) end-pos ?\n ?\r)))
2213 (dired-next-subdir 1 t))
2214 (restore-buffer-modified-p modflag)))
2217 (defun dired-hide-all (arg)
2218 "Hide all subdirectories, leaving only their header lines.
2219 If there is already something hidden, make everything visible again.
2220 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2223 (let ((modflag (buffer-modified-p))
2226 (goto-char (point-min))
2227 (search-forward "\r" nil t))
2228 ;; unhide - bombs on \r in filenames
2229 (subst-char-in-region (point-min) (point-max) ?\r ?\n)
2231 (let ((pos (point-max)) ; pos of end of last directory
2232 (alist dired-subdir-alist))
2233 (while alist ; while there are dirs before pos
2234 (subst-char-in-region (dired-get-subdir-min (car alist)) ; pos of prev dir
2236 (goto-char pos) ; current dir
2237 ;; we're somewhere on current dir's line
2241 (setq pos (dired-get-subdir-min (car alist))) ; prev dir gets current dir
2242 (setq alist (cdr alist)))))
2243 (restore-buffer-modified-p modflag)))
2245 ;;;###end dired-ins.el
2248 ;; Functions for searching in tags style among marked files.
2251 (defun dired-do-search (regexp)
2252 "Search through all marked files for a match for REGEXP.
2253 Stops when a match is found.
2254 To continue searching for next match, use command \\[tags-loop-continue]."
2255 (interactive "sSearch marked files (regexp): ")
2256 (tags-search regexp '(dired-get-marked-files nil nil 'dired-nondirectory-p)))
2259 (defun dired-do-query-replace-regexp (from to &optional delimited)
2260 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2261 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2262 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
2263 with the command \\[tags-loop-continue]."
2266 (query-replace-read-args
2267 "Query replace regexp in marked files" t t)))
2268 (list (nth 0 common) (nth 1 common) (nth 2 common))))
2269 (dolist (file (dired-get-marked-files nil nil 'dired-nondirectory-p))
2270 (let ((buffer (get-file-buffer file)))
2271 (if (and buffer (with-current-buffer buffer
2273 (error "File `%s' is visited read-only" file))))
2274 (tags-query-replace from to delimited
2275 '(dired-get-marked-files nil nil 'dired-nondirectory-p)))
2277 (defun dired-nondirectory-p (file)
2278 (not (file-directory-p file)))
2281 (defun dired-show-file-type (file &optional deref-symlinks)
2282 "Print the type of FILE, according to the `file' command.
2283 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2284 true then the type of the file linked to by FILE is printed instead."
2285 (interactive (list (dired-get-filename t) current-prefix-arg))
2288 (call-process "file" nil t t "-L" "--" file)
2289 (call-process "file" nil t t "--" file))
2291 (backward-delete-char 1))
2292 (message "%s" (buffer-string))))
2294 (provide 'dired-aux)
2296 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2297 ;;; dired-aux.el ends here