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