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