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