(set-visited-file-name): New arg ALONG-WITH-FILE.
[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) ".~"))
270 (bv-length (length base-versions))
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).
595 (or (memq op-symbol dired-no-confirm)
2de735de
RS
596 (let ((files (dired-get-marked-files t arg))
597 (string (if (eq op-symbol 'compress) "Compress or uncompress"
598 (capitalize (symbol-name op-symbol)))))
dd87891b 599 (dired-mark-pop-up nil op-symbol files (function y-or-n-p)
2de735de 600 (concat string " "
dd87891b
RS
601 (dired-mark-prompt arg files) "? ")))))
602
603(defun dired-map-over-marks-check (fun arg op-symbol &optional show-progress)
604; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
605; and display failures.
606
607; FUN takes zero args. It returns non-nil (the offending object, e.g.
608; the short form of the filename) for a failure and probably logs a
609; detailed error explanation using function `dired-log'.
610
611; OP-SYMBOL is a symbol describing the operation performed (e.g.
612; `compress'). It is used with `dired-mark-pop-up' to prompt the user
613; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
614; `Failed to compress 1 of 2 files - type W to see why ("foo")')
615
616; SHOW-PROGRESS if non-nil means redisplay dired after each file."
617 (if (dired-mark-confirm op-symbol arg)
618 (let* ((total-list;; all of FUN's return values
619 (dired-map-over-marks (funcall fun) arg show-progress))
620 (total (length total-list))
621 (failures (delq nil total-list))
2de735de
RS
622 (count (length failures))
623 (string (if (eq op-symbol 'compress) "Compress or uncompress"
624 (capitalize (symbol-name op-symbol)))))
dd87891b
RS
625 (if (not failures)
626 (message "%s: %d file%s."
2de735de 627 string total (dired-plural-s total))
dd87891b
RS
628 ;; end this bunch of errors:
629 (dired-log-summary
630 (format "Failed to %s %d of %d file%s"
2de735de 631 (downcase string) count total (dired-plural-s total))
dd87891b
RS
632 failures)))))
633
634(defvar dired-query-alist
635 '((?\y . y) (?\040 . y) ; `y' or SPC means accept once
636 (?n . n) (?\177 . n) ; `n' or DEL skips once
637 (?! . yes) ; `!' accepts rest
638 (?q. no) (?\e . no) ; `q' or ESC skips rest
639 ;; None of these keys quit - use C-g for that.
640 ))
641
642(defun dired-query (qs-var qs-prompt &rest qs-args)
643 ;; Query user and return nil or t.
644 ;; Store answer in symbol VAR (which must initially be bound to nil).
645 ;; Format PROMPT with ARGS.
c3aef019 646 ;; Binding variable help-form will help the user who types the help key.
dd87891b
RS
647 (let* ((char (symbol-value qs-var))
648 (action (cdr (assoc char dired-query-alist))))
649 (cond ((eq 'yes action)
650 t) ; accept, and don't ask again
651 ((eq 'no action)
652 nil) ; skip, and don't ask again
653 (t;; no lasting effects from last time we asked - ask now
654 (let ((qprompt (concat qs-prompt
655 (if help-form
656 (format " [Type yn!q or %s] "
657 (key-description
658 (char-to-string help-char)))
659 " [Type y, n, q or !] ")))
660 result elt)
661 ;; Actually it looks nicer without cursor-in-echo-area - you can
662 ;; look at the dired buffer instead of at the prompt to decide.
663 (apply 'message qprompt qs-args)
664 (setq char (set qs-var (read-char)))
665 (while (not (setq elt (assoc char dired-query-alist)))
666 (message "Invalid char - type %c for help." help-char)
667 (ding)
668 (sit-for 1)
669 (apply 'message qprompt qs-args)
670 (setq char (set qs-var (read-char))))
671 (memq (cdr elt) '(t y yes)))))))
672\f
673;;;###autoload
674(defun dired-do-compress (&optional arg)
675 "Compress or uncompress marked (or next ARG) files."
676 (interactive "P")
677 (dired-map-over-marks-check (function dired-compress) arg 'compress t))
678
679;; Commands for Emacs Lisp files - load and byte compile
680
681(defun dired-byte-compile ()
682 ;; Return nil for success, offending file name else.
683 (let* ((filename (dired-get-filename))
123ec94d 684 elc-file buffer-read-only failure)
dd87891b
RS
685 (condition-case err
686 (save-excursion (byte-compile-file filename))
687 (error
688 (setq failure err)))
123ec94d 689 (setq elc-file (byte-compile-dest-file filename))
d5b876ef
RS
690 (or (file-exists-p elc-file)
691 (setq failure t))
dd87891b
RS
692 (if failure
693 (progn
694 (dired-log "Byte compile error for %s:\n%s\n" filename failure)
695 (dired-make-relative filename))
696 (dired-remove-file elc-file)
697 (forward-line) ; insert .elc after its .el file
698 (dired-add-file elc-file)
699 nil)))
700
701;;;###autoload
702(defun dired-do-byte-compile (&optional arg)
703 "Byte compile marked (or next ARG) Emacs Lisp files."
704 (interactive "P")
705 (dired-map-over-marks-check (function dired-byte-compile) arg 'byte-compile t))
706
707(defun dired-load ()
708 ;; Return nil for success, offending file name else.
709 (let ((file (dired-get-filename)) failure)
710 (condition-case err
711 (load file nil nil t)
712 (error (setq failure err)))
713 (if (not failure)
714 nil
715 (dired-log "Load error for %s:\n%s\n" file failure)
716 (dired-make-relative file))))
717
718;;;###autoload
719(defun dired-do-load (&optional arg)
720 "Load the marked (or next ARG) Emacs Lisp files."
721 (interactive "P")
722 (dired-map-over-marks-check (function dired-load) arg 'load t))
723
724;;;###autoload
725(defun dired-do-redisplay (&optional arg test-for-subdir)
726 "Redisplay all marked (or next ARG) files.
727If on a subdir line, redisplay that subdirectory. In that case,
728a prefix arg lets you edit the `ls' switches used for the new listing."
729 ;; Moves point if the next ARG files are redisplayed.
730 (interactive "P\np")
731 (if (and test-for-subdir (dired-get-subdir))
732 (dired-insert-subdir
733 (dired-get-subdir)
734 (if arg (read-string "Switches for listing: " dired-actual-switches)))
735 (message "Redisplaying...")
736 ;; message much faster than making dired-map-over-marks show progress
00aa3651
RS
737 (dired-uncache
738 (if (consp dired-directory) (car dired-directory) dired-directory))
dd87891b
RS
739 (dired-map-over-marks (let ((fname (dired-get-filename)))
740 (message "Redisplaying... %s" fname)
741 (dired-update-file-line fname))
742 arg)
743 (dired-move-to-filename)
744 (message "Redisplaying...done")))
745\f
746(defun dired-update-file-line (file)
747 ;; Delete the current line, and insert an entry for FILE.
748 ;; If FILE is nil, then just delete the current line.
749 ;; Keeps any marks that may be present in column one (doing this
750 ;; here is faster than with dired-add-entry's optional arg).
751 ;; Does not update other dired buffers. Use dired-relist-entry for that.
752 (beginning-of-line)
6482fcac
RS
753 (let ((char (following-char)) (opoint (point))
754 (buffer-read-only))
dd87891b
RS
755 (delete-region (point) (progn (forward-line 1) (point)))
756 (if file
757 (progn
758 (dired-add-entry file)
759 ;; Replace space by old marker without moving point.
760 ;; Faster than goto+insdel inside a save-excursion?
761 (subst-char-in-region opoint (1+ opoint) ?\040 char))))
762 (dired-move-to-filename))
763
764(defun dired-fun-in-all-buffers (directory fun &rest args)
765 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
766 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
9df38cef 767 (let ((buf-list (dired-buffers-for-dir (expand-file-name directory)))
dd87891b
RS
768 (obuf (current-buffer))
769 buf success-list)
770 (while buf-list
771 (setq buf (car buf-list)
772 buf-list (cdr buf-list))
773 (unwind-protect
774 (progn
775 (set-buffer buf)
776 (if (apply fun args)
777 (setq success-list (cons (buffer-name buf) success-list))))
778 (set-buffer obuf)))
779 success-list))
780
d443f37c 781;;;###autoload
dd87891b
RS
782(defun dired-add-file (filename &optional marker-char)
783 (dired-fun-in-all-buffers
784 (file-name-directory filename)
785 (function dired-add-entry) filename marker-char))
786
787(defun dired-add-entry (filename &optional marker-char)
788 ;; Add a new entry for FILENAME, optionally marking it
789 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
790 ;; Note that this adds the entry `out of order' if files sorted by
791 ;; time, etc.
792 ;; At least this version inserts in the right subdirectory (if present).
793 ;; And it skips "." or ".." (see `dired-trivial-filenames').
794 ;; Hidden subdirs are exposed if a file is added there.
795 (setq filename (directory-file-name filename))
796 ;; Entry is always for files, even if they happen to also be directories
797 (let ((opoint (point))
798 (cur-dir (dired-current-directory))
cb79b372 799 (orig-file-name filename)
dd87891b
RS
800 (directory (file-name-directory filename))
801 reason)
802 (setq filename (file-name-nondirectory filename)
803 reason
804 (catch 'not-found
805 (if (string= directory cur-dir)
806 (progn
807 (skip-chars-forward "^\r\n")
808 (if (eq (following-char) ?\r)
809 (dired-unhide-subdir))
810 ;; We are already where we should be, except when
811 ;; point is before the subdir line or its total line.
812 (let ((p (dired-after-subdir-garbage cur-dir)))
813 (if (< (point) p)
814 (goto-char p))))
815 ;; else try to find correct place to insert
816 (if (dired-goto-subdir directory)
817 (progn;; unhide if necessary
818 (if (looking-at "\r");; point is at end of subdir line
819 (dired-unhide-subdir))
820 ;; found - skip subdir and `total' line
821 ;; and uninteresting files like . and ..
822 ;; This better not moves into the next subdir!
823 (dired-goto-next-nontrivial-file))
824 ;; not found
825 (throw 'not-found "Subdir not found")))
225feba2 826 (let (buffer-read-only opoint)
dd87891b 827 (beginning-of-line)
225feba2 828 (setq opoint (point))
dd87891b 829 (dired-add-entry-do-indentation marker-char)
225feba2 830 ;; don't expand `.'. Show just the file name within directory.
60e4eb54
RS
831 (let ((default-directory directory))
832 (insert-directory filename
833 (concat dired-actual-switches "d")))
cb79b372
RS
834 ;; Compensate for a bug in ange-ftp.
835 ;; It inserts the file's absolute name, rather than
836 ;; the relative one. That may be hard to fix since it
837 ;; is probably controlled by something in ftp.
838 (goto-char opoint)
839 (let ((inserted-name (dired-get-filename 'no-dir)))
840 (if (file-name-directory inserted-name)
841 (progn
842 (end-of-line)
843 (delete-char (- (length inserted-name)))
844 (insert filename)
845 (forward-char 1))
846 (forward-line 1)))
847 ;; Give each line a text property recording info about it.
60e4eb54 848 (dired-insert-set-properties opoint (point))
dd87891b 849 (forward-line -1)
dd87891b
RS
850 (if dired-after-readin-hook;; the subdir-alist is not affected...
851 (save-excursion;; ...so we can run it right now:
852 (save-restriction
853 (beginning-of-line)
854 (narrow-to-region (point) (save-excursion
855 (forward-line 1) (point)))
856 (run-hooks 'dired-after-readin-hook))))
857 (dired-move-to-filename))
858 ;; return nil if all went well
859 nil))
860 (if reason ; don't move away on failure
861 (goto-char opoint))
eb8c3be9 862 (not reason))) ; return t on success, nil else
dd87891b
RS
863
864;; This is a separate function for the sake of nested dired format.
865(defun dired-add-entry-do-indentation (marker-char)
866 ;; two spaces or a marker plus a space:
867 (insert (if marker-char
868 (if (integerp marker-char) marker-char dired-marker-char)
869 ?\040)
870 ?\040))
871
872(defun dired-after-subdir-garbage (dir)
873 ;; Return pos of first file line of DIR, skipping header and total
874 ;; or wildcard lines.
875 ;; Important: never moves into the next subdir.
876 ;; DIR is assumed to be unhidden.
877 ;; Will probably be redefined for VMS etc.
878 (save-excursion
879 (or (dired-goto-subdir dir) (error "This cannot happen"))
880 (forward-line 1)
881 (while (and (not (eolp)) ; don't cross subdir boundary
882 (not (dired-move-to-filename)))
883 (forward-line 1))
884 (point)))
885
d443f37c 886;;;###autoload
dd87891b
RS
887(defun dired-remove-file (file)
888 (dired-fun-in-all-buffers
889 (file-name-directory file) (function dired-remove-entry) file))
890
891(defun dired-remove-entry (file)
892 (save-excursion
893 (and (dired-goto-file file)
894 (let (buffer-read-only)
895 (delete-region (progn (beginning-of-line) (point))
896 (save-excursion (forward-line 1) (point)))))))
897
d443f37c 898;;;###autoload
dd87891b
RS
899(defun dired-relist-file (file)
900 (dired-fun-in-all-buffers (file-name-directory file)
901 (function dired-relist-entry) file))
902
903(defun dired-relist-entry (file)
904 ;; Relist the line for FILE, or just add it if it did not exist.
905 ;; FILE must be an absolute pathname.
906 (let (buffer-read-only marker)
907 ;; If cursor is already on FILE's line delete-region will cause
908 ;; save-excursion to fail because of floating makers,
909 ;; moving point to beginning of line. Sigh.
910 (save-excursion
911 (and (dired-goto-file file)
912 (delete-region (progn (beginning-of-line)
913 (setq marker (following-char))
914 (point))
915 (save-excursion (forward-line 1) (point))))
916 (setq file (directory-file-name file))
917 (dired-add-entry file (if (eq ?\040 marker) nil marker)))))
918\f
919;;; Copy, move/rename, making hard and symbolic links
920
921(defvar dired-backup-overwrite nil
922 "*Non-nil if Dired should ask about making backups before overwriting files.
923Special value `always' suppresses confirmation.")
924
6482fcac
RS
925(defvar dired-overwrite-confirmed)
926
dd87891b
RS
927(defun dired-handle-overwrite (to)
928 ;; Save old version of a to be overwritten file TO.
6482fcac 929 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
dd87891b 930 ;; from dired-create-files.
d63a6ae0
RS
931 (let (backup)
932 (if (and dired-backup-overwrite
933 dired-overwrite-confirmed
934 (setq backup (car (find-backup-file-name to)))
935 (or (eq 'always dired-backup-overwrite)
936 (dired-query 'overwrite-backup-query
937 (format "Make backup for existing file `%s'? " to))))
938 (progn
939 (rename-file to backup 0) ; confirm overwrite of old backup
940 (dired-relist-entry backup)))))
dd87891b 941
d443f37c 942;;;###autoload
dd87891b
RS
943(defun dired-copy-file (from to ok-flag)
944 (dired-handle-overwrite to)
945 (copy-file from to ok-flag dired-copy-preserve-time))
946
d443f37c 947;;;###autoload
dd87891b
RS
948(defun dired-rename-file (from to ok-flag)
949 (dired-handle-overwrite to)
950 (rename-file from to ok-flag) ; error is caught in -create-files
951 ;; Silently rename the visited file of any buffer visiting this file.
952 (and (get-file-buffer from)
953 (save-excursion
954 (set-buffer (get-file-buffer from))
955 (let ((modflag (buffer-modified-p)))
956 (set-visited-file-name to)
957 (set-buffer-modified-p modflag))))
958 (dired-remove-file from)
959 ;; See if it's an inserted subdir, and rename that, too.
960 (dired-rename-subdir from to))
961
962(defun dired-rename-subdir (from-dir to-dir)
963 (setq from-dir (file-name-as-directory from-dir)
964 to-dir (file-name-as-directory to-dir))
965 (dired-fun-in-all-buffers from-dir
966 (function dired-rename-subdir-1) from-dir to-dir)
967 ;; Update visited file name of all affected buffers
9df38cef
RS
968 (let ((expanded-from-dir (expand-file-name from-dir))
969 (blist (buffer-list)))
dd87891b
RS
970 (while blist
971 (save-excursion
9df38cef 972 (set-buffer (car blist))
dd87891b 973 (if (and buffer-file-name
9df38cef 974 (dired-in-this-tree buffer-file-name expanded-from-dir))
dd87891b
RS
975 (let ((modflag (buffer-modified-p))
976 (to-file (dired-replace-in-string
977 (concat "^" (regexp-quote from-dir))
978 to-dir
979 buffer-file-name)))
980 (set-visited-file-name to-file)
981 (set-buffer-modified-p modflag))))
982 (setq blist (cdr blist)))))
983
984(defun dired-rename-subdir-1 (dir to)
985 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
986 ;; one of its subdirectories is expanded in this buffer.
9df38cef
RS
987 (let ((expanded-dir (expand-file-name dir))
988 (alist dired-subdir-alist)
dd87891b
RS
989 (elt nil))
990 (while alist
991 (setq elt (car alist)
992 alist (cdr alist))
9df38cef 993 (if (dired-in-this-tree (car elt) expanded-dir)
dd87891b
RS
994 ;; ELT's subdir is affected by the rename
995 (dired-rename-subdir-2 elt dir to)))
996 (if (equal dir default-directory)
997 ;; if top level directory was renamed, lots of things have to be
998 ;; updated:
999 (progn
1000 (dired-unadvertise dir) ; we no longer dired DIR...
1001 (setq default-directory to
1002 dired-directory (expand-file-name;; this is correct
1003 ;; with and without wildcards
1004 (file-name-nondirectory dired-directory)
1005 to))
1006 (let ((new-name (file-name-nondirectory
1007 (directory-file-name dired-directory))))
1008 ;; try to rename buffer, but just leave old name if new
1009 ;; name would already exist (don't try appending "<%d>")
1010 (or (get-buffer new-name)
1011 (rename-buffer new-name)))
1012 ;; ... we dired TO now:
1013 (dired-advertise)))))
1014
1015(defun dired-rename-subdir-2 (elt dir to)
1016 ;; Update the headerline and dired-subdir-alist element of directory
1017 ;; described by alist-element ELT to reflect the moving of DIR to TO.
1018 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
1019 (save-excursion
1020 (let ((regexp (regexp-quote (directory-file-name dir)))
1021 (newtext (directory-file-name to))
1022 buffer-read-only)
1023 (goto-char (dired-get-subdir-min elt))
1024 ;; Update subdir headerline in buffer
1025 (if (not (looking-at dired-subdir-regexp))
1026 (error "%s not found where expected - dired-subdir-alist broken?"
1027 dir)
1028 (goto-char (match-beginning 1))
1029 (if (re-search-forward regexp (match-end 1) t)
1030 (replace-match newtext t t)
1031 (error "Expected to find `%s' in headerline of %s" dir (car elt))))
1032 ;; Update buffer-local dired-subdir-alist
1033 (setcar elt
1034 (dired-normalize-subdir
1035 (dired-replace-in-string regexp newtext (car elt)))))))
1036\f
dd87891b
RS
1037;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1038(defun dired-create-files (file-creator operation fn-list name-constructor
1039 &optional marker-char)
1040
1041;; Create a new file for each from a list of existing files. The user
1042;; is queried, dired buffers are updated, and at the end a success or
1043;; failure message is displayed
1044
1045;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1046
1047;; It is called for each file and must create newfile, the entry of
1048;; which will be added. The user will be queried if the file already
1049;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1050;; rename), it is FILE-CREATOR's responsibility to update dired
a7acbbe4 1051;; buffers. FILE-CREATOR must abort by signaling a file-error if it
dd87891b
RS
1052;; could not create newfile. The error is caught and logged.
1053
1054;; OPERATION (a capitalized string, e.g. `Copy') describes the
1055;; operation performed. It is used for error logging.
1056
1057;; FN-LIST is the list of files to copy (full absolute pathnames).
1058
1059;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1060;; skip. If it skips files for other reasons than a direct user
1061;; query, it is supposed to tell why (using dired-log).
1062
1063;; Optional MARKER-CHAR is a character with which to mark every
1064;; newfile's entry, or t to use the current marker character if the
1065;; oldfile was marked.
1066
1067 (let (failures skipped (success-count 0) (total (length fn-list)))
1068 (let (to overwrite-query
1069 overwrite-backup-query) ; for dired-handle-overwrite
1070 (mapcar
1071 (function
1072 (lambda (from)
1073 (setq to (funcall name-constructor from))
1074 (if (equal to from)
1075 (progn
1076 (setq to nil)
1077 (dired-log "Cannot %s to same file: %s\n"
1078 (downcase operation) from)))
1079 (if (not to)
1080 (setq skipped (cons (dired-make-relative from) skipped))
1081 (let* ((overwrite (file-exists-p to))
6482fcac 1082 (dired-overwrite-confirmed ; for dired-handle-overwrite
dd87891b
RS
1083 (and overwrite
1084 (let ((help-form '(format "\
1085Type SPC or `y' to overwrite file `%s',
1086DEL or `n' to skip to next,
1087ESC or `q' to not overwrite any of the remaining files,
1088`!' to overwrite all remaining files with no more questions." to)))
1089 (dired-query 'overwrite-query
1090 "Overwrite `%s'?" to))))
1091 ;; must determine if FROM is marked before file-creator
1092 ;; gets a chance to delete it (in case of a move).
1093 (actual-marker-char
1094 (cond ((integerp marker-char) marker-char)
1095 (marker-char (dired-file-marker from)) ; slow
1096 (t nil))))
1097 (condition-case err
1098 (progn
6482fcac 1099 (funcall file-creator from to dired-overwrite-confirmed)
dd87891b
RS
1100 (if overwrite
1101 ;; If we get here, file-creator hasn't been aborted
1102 ;; and the old entry (if any) has to be deleted
1103 ;; before adding the new entry.
1104 (dired-remove-file to))
1105 (setq success-count (1+ success-count))
1106 (message "%s: %d of %d" operation success-count total)
1107 (dired-add-file to actual-marker-char))
1108 (file-error ; FILE-CREATOR aborted
1109 (progn
1110 (setq failures (cons (dired-make-relative from) failures))
1111 (dired-log "%s `%s' to `%s' failed:\n%s\n"
1112 operation from to err))))))))
1113 fn-list))
1114 (cond
1115 (failures
1116 (dired-log-summary
1117 (format "%s failed for %d of %d file%s"
1118 operation (length failures) total
1119 (dired-plural-s total))
1120 failures))
1121 (skipped
1122 (dired-log-summary
1123 (format "%s: %d of %d file%s skipped"
1124 operation (length skipped) total
1125 (dired-plural-s total))
1126 skipped))
1127 (t
1128 (message "%s: %s file%s"
1129 operation success-count (dired-plural-s success-count)))))
1130 (dired-move-to-filename))
1131\f
1132(defun dired-do-create-files (op-symbol file-creator operation arg
1133 &optional marker-char op1
1134 how-to)
1135 ;; Create a new file for each marked file.
1136 ;; Prompts user for target, which is a directory in which to create
1137 ;; the new files. Target may be a plain file if only one marked
1138 ;; file exists.
1139 ;; OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
eb8c3be9 1140 ;; will determine whether pop-ups are appropriate for this OP-SYMBOL.
dd87891b
RS
1141 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1142 ;; ARG as in dired-get-marked-files.
1143 ;; Optional arg OP1 is an alternate form for OPERATION if there is
1144 ;; only one file.
1145 ;; Optional arg MARKER-CHAR as in dired-create-files.
1146 ;; Optional arg HOW-TO determines how to treat target:
1147 ;; If HOW-TO is not given (or nil), and target is a directory, the
1148 ;; file(s) are created inside the target directory. If target
1149 ;; is not a directory, there must be exactly one marked file,
1150 ;; else error.
1151 ;; If HOW-TO is t, then target is not modified. There must be
1152 ;; exactly one marked file, else error.
1153 ;; Else HOW-TO is assumed to be a function of one argument, target,
1154 ;; that looks at target and returns a value for the into-dir
1155 ;; variable. The function dired-into-dir-with-symlinks is provided
1156 ;; for the case (common when creating symlinks) that symbolic
1157 ;; links to directories are not to be considered as directories
1158 ;; (as file-directory-p would if HOW-TO had been nil).
1159 (or op1 (setq op1 operation))
1160 (let* ((fn-list (dired-get-marked-files nil arg))
1161 (fn-count (length fn-list))
1162 (target (expand-file-name
1163 (dired-mark-read-file-name
1164 (concat (if (= 1 fn-count) op1 operation) " %s to: ")
1165 (dired-dwim-target-directory)
1166 op-symbol arg (mapcar (function dired-make-relative) fn-list))))
1167 (into-dir (cond ((null how-to) (file-directory-p target))
1168 ((eq how-to t) nil)
1169 (t (funcall how-to target)))))
1170 (if (and (> fn-count 1)
1171 (not into-dir))
1172 (error "Marked %s: target must be a directory: %s" operation target))
1173 ;; rename-file bombs when moving directories unless we do this:
1174 (or into-dir (setq target (directory-file-name target)))
1175 (dired-create-files
1176 file-creator operation fn-list
1177 (if into-dir ; target is a directory
1178 ;; This function uses fluid vars into-dir and target when called
1179 ;; inside dired-create-files:
1180 (function (lambda (from)
1181 (expand-file-name (file-name-nondirectory from) target)))
1182 (function (lambda (from) target)))
1183 marker-char)))
1184
1185;; Read arguments for a marked-files command that wants a file name,
1186;; perhaps popping up the list of marked files.
1187;; ARG is the prefix arg and indicates whether the files came from
1188;; marks (ARG=nil) or a repeat factor (integerp ARG).
1189;; If the current file was used, the list has but one element and ARG
1190;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1191
1192(defun dired-mark-read-file-name (prompt dir op-symbol arg files)
1193 (dired-mark-pop-up
1194 nil op-symbol files
1195 (function read-file-name)
1196 (format prompt (dired-mark-prompt arg files)) dir))
1197
1198(defun dired-dwim-target-directory ()
1199 ;; Try to guess which target directory the user may want.
1200 ;; If there is a dired buffer displayed in the next window, use
1201 ;; its current subdir, else use current subdir of this dired buffer.
1202 (let ((this-dir (and (eq major-mode 'dired-mode)
1203 (dired-current-directory))))
1204 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1205 (if dired-dwim-target
1206 (let* ((other-buf (window-buffer (next-window)))
1207 (other-dir (save-excursion
1208 (set-buffer other-buf)
1209 (and (eq major-mode 'dired-mode)
1210 (dired-current-directory)))))
1211 (or other-dir this-dir))
1212 this-dir)))
1213\f
1214;;;###autoload
1215(defun dired-create-directory (directory)
1216 "Create a directory called DIRECTORY."
1217 (interactive
1218 (list (read-file-name "Create directory: " (dired-current-directory))))
1219 (let ((expanded (directory-file-name (expand-file-name directory))))
1220 (make-directory expanded)
1221 (dired-add-file expanded)
1222 (dired-move-to-filename)))
1223
1224(defun dired-into-dir-with-symlinks (target)
1225 (and (file-directory-p target)
1226 (not (file-symlink-p target))))
1227;; This may not always be what you want, especially if target is your
1228;; home directory and it happens to be a symbolic link, as is often the
1229;; case with NFS and automounters. Or if you want to make symlinks
1230;; into directories that themselves are only symlinks, also quite
1231;; common.
1232
1233;; So we don't use this function as value for HOW-TO in
1234;; dired-do-symlink, which has the minor disadvantage of
1235;; making links *into* a symlinked-dir, when you really wanted to
1236;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1237;; just have to remove that symlink by hand before making your marked
1238;; symlinks.
1239
1240;;;###autoload
1241(defun dired-do-copy (&optional arg)
1242 "Copy all marked (or next ARG) files, or copy the current file.
1243This normally preserves the last-modified date when copying.
1244When operating on just the current file, you specify the new name.
b5458fc2
RS
1245When operating on multiple or marked files, you specify a directory,
1246and new copies of these files are made in that directory
dd87891b
RS
1247with the same names that the files currently have."
1248 (interactive "P")
1249 (dired-do-create-files 'copy (function dired-copy-file)
1250 (if dired-copy-preserve-time "Copy [-p]" "Copy")
1251 arg dired-keep-marker-copy))
1252
1253;;;###autoload
1254(defun dired-do-symlink (&optional arg)
1255 "Make symbolic links to current file or all marked (or next ARG) files.
1256When operating on just the current file, you specify the new name.
1257When operating on multiple or marked files, you specify a directory
1258and new symbolic links are made in that directory
1259with the same names that the files currently have."
1260 (interactive "P")
1261 (dired-do-create-files 'symlink (function make-symbolic-link)
1262 "Symlink" arg dired-keep-marker-symlink))
1263
1264;;;###autoload
1265(defun dired-do-hardlink (&optional arg)
1266 "Add names (hard links) current file or all marked (or next ARG) files.
1267When operating on just the current file, you specify the new name.
1268When operating on multiple or marked files, you specify a directory
1269and new hard links are made in that directory
1270with the same names that the files currently have."
1271 (interactive "P")
1272 (dired-do-create-files 'hardlink (function add-name-to-file)
1273 "Hardlink" arg dired-keep-marker-hardlink))
1274
1275;;;###autoload
1276(defun dired-do-rename (&optional arg)
1277 "Rename current file or all marked (or next ARG) files.
1278When renaming just the current file, you specify the new name.
1279When renaming multiple or marked files, you specify a directory."
1280 (interactive "P")
1281 (dired-do-create-files 'move (function dired-rename-file)
1282 "Move" arg dired-keep-marker-rename "Rename"))
1283;;;###end dired-cp.el
1284\f
1285;;; 5K
1286;;;###begin dired-re.el
1287(defun dired-do-create-files-regexp
1288 (file-creator operation arg regexp newname &optional whole-path marker-char)
1289 ;; Create a new file for each marked file using regexps.
1290 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1291 ;; ARG as in dired-get-marked-files.
1292 ;; Matches each marked file against REGEXP and constructs the new
1293 ;; filename from NEWNAME (like in function replace-match).
1294 ;; Optional arg WHOLE-PATH means match/replace the whole pathname
1295 ;; instead of only the non-directory part of the file.
1296 ;; Optional arg MARKER-CHAR as in dired-create-files.
1297 (let* ((fn-list (dired-get-marked-files nil arg))
1298 (fn-count (length fn-list))
1299 (operation-prompt (concat operation " `%s' to `%s'?"))
1300 (rename-regexp-help-form (format "\
1301Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1302`!' to %s all remaining matches with no more questions."
1303 (downcase operation)
1304 (downcase operation)))
1305 (regexp-name-constructor
1306 ;; Function to construct new filename using REGEXP and NEWNAME:
1307 (if whole-path ; easy (but rare) case
1308 (function
1309 (lambda (from)
1310 (let ((to (dired-string-replace-match regexp from newname))
1311 ;; must bind help-form directly around call to
1312 ;; dired-query
1313 (help-form rename-regexp-help-form))
1314 (if to
1315 (and (dired-query 'rename-regexp-query
1316 operation-prompt
1317 from
1318 to)
1319 to)
1320 (dired-log "%s: %s did not match regexp %s\n"
1321 operation from regexp)))))
1322 ;; not whole-path, replace non-directory part only
1323 (function
1324 (lambda (from)
1325 (let* ((new (dired-string-replace-match
1326 regexp (file-name-nondirectory from) newname))
1327 (to (and new ; nil means there was no match
1328 (expand-file-name new
1329 (file-name-directory from))))
1330 (help-form rename-regexp-help-form))
1331 (if to
1332 (and (dired-query 'rename-regexp-query
1333 operation-prompt
1334 (dired-make-relative from)
1335 (dired-make-relative to))
1336 to)
1337 (dired-log "%s: %s did not match regexp %s\n"
1338 operation (file-name-nondirectory from) regexp)))))))
1339 rename-regexp-query)
1340 (dired-create-files
1341 file-creator operation fn-list regexp-name-constructor marker-char)))
1342
1343(defun dired-mark-read-regexp (operation)
1344 ;; Prompt user about performing OPERATION.
1345 ;; Read and return list of: regexp newname arg whole-path.
1346 (let* ((whole-path
1347 (equal 0 (prefix-numeric-value current-prefix-arg)))
1348 (arg
1349 (if whole-path nil current-prefix-arg))
1350 (regexp
1351 (dired-read-regexp
22faf171 1352 (concat (if whole-path "Path " "") operation " from (regexp): ")))
dd87891b
RS
1353 (newname
1354 (read-string
1355 (concat (if whole-path "Path " "") operation " " regexp " to: "))))
1356 (list regexp newname arg whole-path)))
1357
1358;;;###autoload
1359(defun dired-do-rename-regexp (regexp newname &optional arg whole-path)
1360 "Rename marked files containing REGEXP to NEWNAME.
1361As each match is found, the user must type a character saying
1362 what to do with it. For directions, type \\[help-command] at that time.
1363NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
1364REGEXP defaults to the last regexp used.
1365With a zero prefix arg, renaming by regexp affects the complete
1366 pathname - usually only the non-directory part of file names is used
1367 and changed."
1368 (interactive (dired-mark-read-regexp "Rename"))
1369 (dired-do-create-files-regexp
1370 (function dired-rename-file)
1371 "Rename" arg regexp newname whole-path dired-keep-marker-rename))
1372
1373;;;###autoload
1374(defun dired-do-copy-regexp (regexp newname &optional arg whole-path)
1375 "Copy all marked files containing REGEXP to NEWNAME.
1376See function `dired-rename-regexp' for more info."
1377 (interactive (dired-mark-read-regexp "Copy"))
1378 (dired-do-create-files-regexp
1379 (function dired-copy-file)
1380 (if dired-copy-preserve-time "Copy [-p]" "Copy")
1381 arg regexp newname whole-path dired-keep-marker-copy))
1382
1383;;;###autoload
1384(defun dired-do-hardlink-regexp (regexp newname &optional arg whole-path)
1385 "Hardlink all marked files containing REGEXP to NEWNAME.
1386See function `dired-rename-regexp' for more info."
1387 (interactive (dired-mark-read-regexp "HardLink"))
1388 (dired-do-create-files-regexp
1389 (function add-name-to-file)
1390 "HardLink" arg regexp newname whole-path dired-keep-marker-hardlink))
1391
1392;;;###autoload
1393(defun dired-do-symlink-regexp (regexp newname &optional arg whole-path)
1394 "Symlink all marked files containing REGEXP to NEWNAME.
1395See function `dired-rename-regexp' for more info."
1396 (interactive (dired-mark-read-regexp "SymLink"))
1397 (dired-do-create-files-regexp
1398 (function make-symbolic-link)
1399 "SymLink" arg regexp newname whole-path dired-keep-marker-symlink))
1400
1401(defun dired-create-files-non-directory
1402 (file-creator basename-constructor operation arg)
1403 ;; Perform FILE-CREATOR on the non-directory part of marked files
1404 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1405 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1406 (let (rename-non-directory-query)
1407 (dired-create-files
1408 file-creator
1409 operation
1410 (dired-get-marked-files nil arg)
1411 (function
1412 (lambda (from)
1413 (let ((to (concat (file-name-directory from)
1414 (funcall basename-constructor
1415 (file-name-nondirectory from)))))
1416 (and (let ((help-form (format "\
1417Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1418`!' to %s all remaining matches with no more questions."
1419 (downcase operation)
1420 (downcase operation))))
1421 (dired-query 'rename-non-directory-query
1422 (concat operation " `%s' to `%s'")
1423 (dired-make-relative from)
1424 (dired-make-relative to)))
1425 to))))
1426 dired-keep-marker-rename)))
1427
1428(defun dired-rename-non-directory (basename-constructor operation arg)
1429 (dired-create-files-non-directory
1430 (function dired-rename-file)
1431 basename-constructor operation arg))
1432
1433;;;###autoload
1434(defun dired-upcase (&optional arg)
1435 "Rename all marked (or next ARG) files to upper case."
1436 (interactive "P")
1437 (dired-rename-non-directory (function upcase) "Rename upcase" arg))
1438
1439;;;###autoload
1440(defun dired-downcase (&optional arg)
1441 "Rename all marked (or next ARG) files to lower case."
1442 (interactive "P")
1443 (dired-rename-non-directory (function downcase) "Rename downcase" arg))
1444
1445;;;###end dired-re.el
1446\f
1447;;; 13K
1448;;;###begin dired-ins.el
1449
1450;;;###autoload
1451(defun dired-maybe-insert-subdir (dirname &optional
1452 switches no-error-if-not-dir-p)
1453 "Insert this subdirectory into the same dired buffer.
1454If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
1455 else inserts it at its natural place (as `ls -lR' would have done).
1456With a prefix arg, you may edit the ls switches used for this listing.
1457 You can add `R' to the switches to expand the whole tree starting at
1458 this subdirectory.
1459This function takes some pains to conform to `ls -lR' output."
1460 (interactive
1461 (list (dired-get-filename)
1462 (if current-prefix-arg
1463 (read-string "Switches for listing: " dired-actual-switches))))
1464 (let ((opoint (point)))
1465 ;; We don't need a marker for opoint as the subdir is always
1466 ;; inserted *after* opoint.
1467 (setq dirname (file-name-as-directory dirname))
1468 (or (and (not switches)
1469 (dired-goto-subdir dirname))
1470 (dired-insert-subdir dirname switches no-error-if-not-dir-p))
1471 ;; Push mark so that it's easy to find back. Do this after the
1472 ;; insert message so that the user sees the `Mark set' message.
1473 (push-mark opoint)))
1474
1475(defun dired-insert-subdir (dirname &optional switches no-error-if-not-dir-p)
1476 "Insert this subdirectory into the same dired buffer.
1477If it is already present, overwrites previous entry,
1478 else inserts it at its natural place (as `ls -lR' would have done).
1479With a prefix arg, you may edit the `ls' switches used for this listing.
1480 You can add `R' to the switches to expand the whole tree starting at
1481 this subdirectory.
1482This function takes some pains to conform to `ls -lR' output."
1483 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1484 ;; Prospero where dired-ls does the right thing, but
1485 ;; file-directory-p has not been redefined.
1486 (interactive
1487 (list (dired-get-filename)
1488 (if current-prefix-arg
1489 (read-string "Switches for listing: " dired-actual-switches))))
1490 (setq dirname (file-name-as-directory (expand-file-name dirname)))
1491 (dired-insert-subdir-validate dirname switches)
1492 (or no-error-if-not-dir-p
1493 (file-directory-p dirname)
1494 (error "Attempt to insert a non-directory: %s" dirname))
1495 (let ((elt (assoc dirname dired-subdir-alist))
1496 switches-have-R mark-alist case-fold-search buffer-read-only)
1497 ;; case-fold-search is nil now, so we can test for capital `R':
1498 (if (setq switches-have-R (and switches (string-match "R" switches)))
1499 ;; avoid duplicated subdirs
1500 (setq mark-alist (dired-kill-tree dirname t)))
1501 (if elt
1502 ;; If subdir is already present, remove it and remember its marks
1503 (setq mark-alist (nconc (dired-insert-subdir-del elt) mark-alist))
1504 (dired-insert-subdir-newpos dirname)) ; else compute new position
1505 (dired-insert-subdir-doupdate
1506 dirname elt (dired-insert-subdir-doinsert dirname switches))
1507 (if switches-have-R (dired-build-subdir-alist))
1508 (dired-initial-position dirname)
1509 (save-excursion (dired-mark-remembered mark-alist))))
1510
1511;; This is a separate function for dired-vms.
1512(defun dired-insert-subdir-validate (dirname &optional switches)
1513 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1514 ;; Signal an error if invalid (e.g. user typed `i' on `..').
d443f37c 1515 (or (dired-in-this-tree dirname (expand-file-name default-directory))
dd87891b
RS
1516 (error "%s: not in this directory tree" dirname))
1517 (if switches
1518 (let (case-fold-search)
1519 (mapcar
1520 (function
1521 (lambda (x)
1522 (or (eq (null (string-match x switches))
1523 (null (string-match x dired-actual-switches)))
1524 (error "Can't have dirs with and without -%s switches together"
1525 x))))
1526 ;; all switches that make a difference to dired-get-filename:
1527 '("F" "b")))))
1528
1529(defun dired-alist-add (dir new-marker)
1530 ;; Add new DIR at NEW-MARKER. Sort alist.
1531 (dired-alist-add-1 dir new-marker)
1532 (dired-alist-sort))
1533
1534(defun dired-alist-sort ()
1535 ;; Keep the alist sorted on buffer position.
1536 (setq dired-subdir-alist
1537 (sort dired-subdir-alist
1538 (function (lambda (elt1 elt2)
1539 (> (dired-get-subdir-min elt1)
1540 (dired-get-subdir-min elt2)))))))
1541
1542(defun dired-kill-tree (dirname &optional remember-marks)
1543 ;;"Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1544 ;; With optional arg REMEMBER-MARKS, return an alist of marked files."
1545 (interactive "DKill tree below directory: ")
9df38cef 1546 (setq dirname (expand-file-name dirname))
dd87891b
RS
1547 (let ((s-alist dired-subdir-alist) dir m-alist)
1548 (while s-alist
1549 (setq dir (car (car s-alist))
1550 s-alist (cdr s-alist))
1551 (if (and (not (string-equal dir dirname))
1552 (dired-in-this-tree dir dirname)
1553 (dired-goto-subdir dir))
1554 (setq m-alist (nconc (dired-kill-subdir remember-marks) m-alist))))
1555 m-alist))
1556
1557(defun dired-insert-subdir-newpos (new-dir)
1558 ;; Find pos for new subdir, according to tree order.
1559 ;;(goto-char (point-max))
1560 (let ((alist dired-subdir-alist) elt dir pos new-pos)
1561 (while alist
1562 (setq elt (car alist)
1563 alist (cdr alist)
1564 dir (car elt)
1565 pos (dired-get-subdir-min elt))
1566 (if (dired-tree-lessp dir new-dir)
1567 ;; Insert NEW-DIR after DIR
1568 (setq new-pos (dired-get-subdir-max elt)
1569 alist nil)))
1570 (goto-char new-pos))
1571 ;; want a separating newline between subdirs
1572 (or (eobp)
1573 (forward-line -1))
1574 (insert "\n")
1575 (point))
1576
1577(defun dired-insert-subdir-del (element)
1578 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1579 ;; Move to that buffer position. Return a mark-alist.
1580 (let ((begin-marker (dired-get-subdir-min element)))
1581 (goto-char begin-marker)
1582 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1583 (goto-char (dired-subdir-max))
1584 (or (eobp);; want a separating newline _between_ subdirs:
1585 (forward-char -1))
1586 (prog1
1587 (dired-remember-marks begin-marker (point))
1588 (delete-region begin-marker (point)))))
1589
1590(defun dired-insert-subdir-doinsert (dirname switches)
1591 ;; Insert ls output after point and put point on the correct
1592 ;; position for the subdir alist.
1593 ;; Return the boundary of the inserted text (as list of BEG and END).
1594 (let ((begin (point)) end)
1595 (message "Reading directory %s..." dirname)
1596 (let ((dired-actual-switches
1597 (or switches
1598 (dired-replace-in-string "R" "" dired-actual-switches))))
1599 (if (equal dirname (car (car (reverse dired-subdir-alist))))
1600 ;; top level directory may contain wildcards:
1601 (dired-readin-insert dired-directory)
60e4eb54
RS
1602 (let ((opoint (point)))
1603 (insert-directory dirname dired-actual-switches nil t)
1604 (dired-insert-set-properties opoint (point)))))
dd87891b
RS
1605 (message "Reading directory %s...done" dirname)
1606 (setq end (point-marker))
1607 (indent-rigidly begin end 2)
1608 ;; call dired-insert-headerline afterwards, as under VMS dired-ls
1609 ;; does insert the headerline itself and the insert function just
1610 ;; moves point.
1611 ;; Need a marker for END as this inserts text.
1612 (goto-char begin)
1613 (dired-insert-headerline dirname)
1614 ;; point is now like in dired-build-subdir-alist
1615 (prog1
1616 (list begin (marker-position end))
1617 (set-marker end nil))))
1618
1619(defun dired-insert-subdir-doupdate (dirname elt beg-end)
1620 ;; Point is at the correct subdir alist position for ELT,
1621 ;; BEG-END is the subdir-region (as list of begin and end).
1622 (if elt ; subdir was already present
1623 ;; update its position (should actually be unchanged)
1624 (set-marker (dired-get-subdir-min elt) (point-marker))
1625 (dired-alist-add dirname (point-marker)))
1626 ;; The hook may depend on the subdir-alist containing the just
1627 ;; inserted subdir, so run it after dired-alist-add:
1628 (if dired-after-readin-hook
1629 (save-excursion
1630 (let ((begin (nth 0 beg-end))
1631 (end (nth 1 beg-end)))
1632 (goto-char begin)
1633 (save-restriction
1634 (narrow-to-region begin end)
1635 ;; hook may add or delete lines, but the subdir boundary
1636 ;; marker floats
1637 (run-hooks 'dired-after-readin-hook))))))
1638
1639(defun dired-tree-lessp (dir1 dir2)
1640 ;; Lexicographic order on pathname components, like `ls -lR':
1641 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1642 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1643 ;; or DIR1 and DIR2 are in the same parentdir and their last
1644 ;; components are string-lessp.
1645 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1646 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1647 ;; if dired-actual-switches contained `t'.
1648 (setq dir1 (file-name-as-directory dir1)
1649 dir2 (file-name-as-directory dir2))
1650 (let ((components-1 (dired-split "/" dir1))
1651 (components-2 (dired-split "/" dir2)))
1652 (while (and components-1
1653 components-2
1654 (equal (car components-1) (car components-2)))
1655 (setq components-1 (cdr components-1)
1656 components-2 (cdr components-2)))
1657 (let ((c1 (car components-1))
1658 (c2 (car components-2)))
1659
1660 (cond ((and c1 c2)
1661 (string-lessp c1 c2))
1662 ((and (null c1) (null c2))
1663 nil) ; they are equal, not lessp
1664 ((null c1) ; c2 is a subdir of c1: c1<c2
1665 t)
1666 ((null c2) ; c1 is a subdir of c2: c1>c2
1667 nil)
1668 (t (error "This can't happen"))))))
1669
1670;; There should be a builtin split function - inverse to mapconcat.
1671(defun dired-split (pat str &optional limit)
1672 "Splitting on regexp PAT, turn string STR into a list of substrings.
1673Optional third arg LIMIT (>= 1) is a limit to the length of the
1674resulting list.
1675Thus, if SEP is a regexp that only matches itself,
1676
1677 (mapconcat 'identity (dired-split SEP STRING) SEP)
1678
1679is always equal to STRING."
1680 (let* ((start (string-match pat str))
1681 (result (list (substring str 0 start)))
1682 (count 1)
1683 (end (if start (match-end 0))))
1684 (if end ; else nothing left
1685 (while (and (or (not (integerp limit))
1686 (< count limit))
1687 (string-match pat str end))
1688 (setq start (match-beginning 0)
1689 count (1+ count)
1690 result (cons (substring str end start) result)
1691 end (match-end 0)
1692 start end)
1693 ))
1694 (if (and (or (not (integerp limit))
1695 (< count limit))
1696 end) ; else nothing left
1697 (setq result
1698 (cons (substring str end) result)))
1699 (nreverse result)))
1700\f
1701;;; moving by subdirectories
1702
dd87891b
RS
1703;;;###autoload
1704(defun dired-prev-subdir (arg &optional no-error-if-not-found no-skip)
1705 "Go to previous subdirectory, regardless of level.
1706When called interactively and not on a subdir line, go to this subdir's line."
1707 ;;(interactive "p")
1708 (interactive
1709 (list (if current-prefix-arg
1710 (prefix-numeric-value current-prefix-arg)
1711 ;; if on subdir start already, don't stay there!
1712 (if (dired-get-subdir) 1 0))))
1713 (dired-next-subdir (- arg) no-error-if-not-found no-skip))
1714
1715(defun dired-subdir-min ()
1716 (save-excursion
1717 (if (not (dired-prev-subdir 0 t t))
1718 (error "Not in a subdir!")
1719 (point))))
1720
1721;;;###autoload
1722(defun dired-goto-subdir (dir)
1723 "Go to end of header line of DIR in this dired buffer.
1724Return value of point on success, otherwise return nil.
1725The next char is either \\n, or \\r if DIR is hidden."
1726 (interactive
1727 (prog1 ; let push-mark display its message
1728 (list (expand-file-name
1729 (completing-read "Goto in situ directory: " ; prompt
1730 dired-subdir-alist ; table
1731 nil ; predicate
1732 t ; require-match
1733 (dired-current-directory))))
1734 (push-mark)))
1735 (setq dir (file-name-as-directory dir))
1736 (let ((elt (assoc dir dired-subdir-alist)))
1737 (and elt
1738 (goto-char (dired-get-subdir-min elt))
1739 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1740 ;; at either \r or \n after this function succeeds.
1741 (progn (skip-chars-forward "^\r\n")
1742 (point)))))
1743\f
1744;;;###autoload
1745(defun dired-mark-subdir-files ()
1746 "Mark all files except `.' and `..'."
96149b57 1747 (interactive)
dd87891b
RS
1748 (let ((p-min (dired-subdir-min)))
1749 (dired-mark-files-in-region p-min (dired-subdir-max))))
1750
1751;;;###autoload
1752(defun dired-kill-subdir (&optional remember-marks)
1753 "Remove all lines of current subdirectory.
1754Lower levels are unaffected."
1755 ;; With optional REMEMBER-MARKS, return a mark-alist.
1756 (interactive)
1757 (let ((beg (dired-subdir-min))
1758 (end (dired-subdir-max))
1759 buffer-read-only cur-dir)
1760 (setq cur-dir (dired-current-directory))
1761 (if (equal cur-dir default-directory)
1762 (error "Attempt to kill top level directory"))
1763 (prog1
1764 (if remember-marks (dired-remember-marks beg end))
1765 (delete-region beg end)
1766 (if (eobp) ; don't leave final blank line
1767 (delete-char -1))
1768 (dired-unsubdir cur-dir))))
1769
1770(defun dired-unsubdir (dir)
1771 ;; Remove DIR from the alist
1772 (setq dired-subdir-alist
1773 (delq (assoc dir dired-subdir-alist) dired-subdir-alist)))
1774
1775;;;###autoload
1776(defun dired-tree-up (arg)
1777 "Go up ARG levels in the dired tree."
1778 (interactive "p")
1779 (let ((dir (dired-current-directory)))
1780 (while (>= arg 1)
1781 (setq arg (1- arg)
1782 dir (file-name-directory (directory-file-name dir))))
1783 ;;(setq dir (expand-file-name dir))
1784 (or (dired-goto-subdir dir)
1785 (error "Cannot go up to %s - not in this tree." dir))))
1786
1787;;;###autoload
1788(defun dired-tree-down ()
1789 "Go down in the dired tree."
1790 (interactive)
1791 (let ((dir (dired-current-directory)) ; has slash
1792 pos case-fold-search) ; filenames are case sensitive
1793 (let ((rest (reverse dired-subdir-alist)) elt)
1794 (while rest
1795 (setq elt (car rest)
1796 rest (cdr rest))
1797 (if (dired-in-this-tree (directory-file-name (car elt)) dir)
1798 (setq rest nil
1799 pos (dired-goto-subdir (car elt))))))
1800 (if pos
1801 (goto-char pos)
1802 (error "At the bottom"))))
1803\f
1804;;; hiding
1805
1806(defun dired-unhide-subdir ()
1807 (let (buffer-read-only)
1808 (subst-char-in-region (dired-subdir-min) (dired-subdir-max) ?\r ?\n)))
1809
1810(defun dired-hide-check ()
1811 (or selective-display
1812 (error "selective-display must be t for subdir hiding to work!")))
1813
1814(defun dired-subdir-hidden-p (dir)
1815 (and selective-display
1816 (save-excursion
1817 (dired-goto-subdir dir)
1818 (looking-at "\r"))))
1819
1820;;;###autoload
1821(defun dired-hide-subdir (arg)
1822 "Hide or unhide the current subdirectory and move to next directory.
1823Optional prefix arg is a repeat factor.
1824Use \\[dired-hide-all] to (un)hide all directories."
1825 (interactive "p")
1826 (dired-hide-check)
1827 (while (>= (setq arg (1- arg)) 0)
1828 (let* ((cur-dir (dired-current-directory))
1829 (hidden-p (dired-subdir-hidden-p cur-dir))
1830 (elt (assoc cur-dir dired-subdir-alist))
1831 (end-pos (1- (dired-get-subdir-max elt)))
1832 buffer-read-only)
1833 ;; keep header line visible, hide rest
1834 (goto-char (dired-get-subdir-min elt))
1835 (skip-chars-forward "^\n\r")
1836 (if hidden-p
1837 (subst-char-in-region (point) end-pos ?\r ?\n)
1838 (subst-char-in-region (point) end-pos ?\n ?\r)))
1839 (dired-next-subdir 1 t)))
1840
1841;;;###autoload
1842(defun dired-hide-all (arg)
1843 "Hide all subdirectories, leaving only their header lines.
1844If there is already something hidden, make everything visible again.
1845Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
1846 (interactive "P")
1847 (dired-hide-check)
1848 (let (buffer-read-only)
1849 (if (save-excursion
1850 (goto-char (point-min))
1851 (search-forward "\r" nil t))
1852 ;; unhide - bombs on \r in filenames
1853 (subst-char-in-region (point-min) (point-max) ?\r ?\n)
1854 ;; hide
1855 (let ((pos (point-max)) ; pos of end of last directory
1856 (alist dired-subdir-alist))
1857 (while alist ; while there are dirs before pos
1858 (subst-char-in-region (dired-get-subdir-min (car alist)) ; pos of prev dir
1859 (save-excursion
1860 (goto-char pos) ; current dir
1861 ;; we're somewhere on current dir's line
1862 (forward-line -1)
1863 (point))
1864 ?\n ?\r)
1865 (setq pos (dired-get-subdir-min (car alist))) ; prev dir gets current dir
1866 (setq alist (cdr alist)))))))
1867
1868;;;###end dired-ins.el
2f14b48d 1869
2297e912
RM
1870\f
1871;; Functions for searching in tags style among marked files.
1872
1873;;;###autoload
5c0b696b 1874(defun dired-do-search (regexp)
2297e912
RM
1875 "Search through all marked files for a match for REGEXP.
1876Stops when a match is found.
1877To continue searching for next match, use command \\[tags-loop-continue]."
1878 (interactive "sSearch marked files (regexp): ")
1879 (tags-search regexp '(dired-get-marked-files)))
1880
1881;;;###autoload
5c0b696b
RS
1882(defun dired-do-query-replace (from to &optional delimited)
1883 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2297e912 1884Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
5c0b696b 1885If you exit (\\[keyboard-quit] or ESC), you can resume the query replace
2297e912
RM
1886with the command \\[tags-loop-continue]."
1887 (interactive
1888 "sQuery replace in marked files (regexp): \nsQuery replace %s by: \nP")
1889 (tags-query-replace from to delimited '(dired-get-marked-files)))
1890\f
1891
80ec9ac5
RS
1892(provide 'dired-aux)
1893
e5167999 1894;;; dired-aux.el ends here