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