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