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