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