(server-done-hook): New hook.
[bpt/emacs.git] / lisp / dired.el
CommitLineData
c8472948 1;;; dired.el --- directory-browsing commands
52041219 2
d733c5ec 3;; Copyright (C) 1985, 1986, 1992, 1993, 1994 Free Software Foundation, Inc.
ab67260b 4
b36b40ae
RS
5;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
6;; Maintainer: FSF
84fc2cfa
ER
7
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
52041219 12;; the Free Software Foundation; either version 2, or (at your option)
84fc2cfa
ER
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
21;; along with GNU Emacs; see the file COPYING. If not, write to
22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23
52041219
RS
24;;; Commentary:
25
e41b2db1
ER
26;; This is a major mode for directory browsing and editing. It is
27;; documented in the Emacs manual.
28
492d2437
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
52041219 33;;; Code:
492d2437 34
492d2437
RS
35;;; Customizable variables
36
84fc2cfa 37;;;###autoload
492d2437
RS
38(defvar dired-listing-switches "-al"
39 "*Switches passed to `ls' for dired. MUST contain the `l' option.
40May contain all other options that don't contradict `-l';
b36b40ae
RS
41may contain even `F', `b', `i' and `s'. See also the variable
42`dired-ls-F-marks-symlinks' concerning the `F' switch.")
84fc2cfa 43
492d2437
RS
44; Don't use absolute paths as /bin should be in any PATH and people
45; may prefer /usr/local/gnu/bin or whatever. However, chown is
46; usually not in PATH.
47
48;;;###autoload
84fc2cfa 49(defvar dired-chown-program
d43e0b16 50 (if (memq system-type '(hpux dgux usg-unix-v irix linux))
194ff7c1 51 "chown" "/etc/chown")
eb8c3be9 52 "Name of chown command (usually `chown' or `/etc/chown').")
492d2437 53
492d2437
RS
54;;;###autoload
55(defvar dired-ls-F-marks-symlinks nil
56 "*Informs dired about how `ls -lF' marks symbolic links.
c3554e95 57Set this to t if `insert-directory-program' with `-lF' marks the symbolic link
492d2437 58itself with a trailing @ (usually the case under Ultrix).
84fc2cfa 59
492d2437
RS
60Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
61nil (the default), if it gives `bar@ -> foo', set it to t.
62
63Dired checks if there is really a @ appended. Thus, if you have a
64marking `ls' program on one host and a non-marking on another host, and
65don't care about symbolic links which really end in a @, you can
66always set this variable to t.")
67
68;;;###autoload
69(defvar dired-trivial-filenames "^\\.\\.?$\\|^#"
70 "*Regexp of files to skip when finding first file of a directory.
71A value of nil means move to the subdir line.
72A value of t means move to first file.")
73
74;;;###autoload
75(defvar dired-keep-marker-rename t
76 ;; Use t as default so that moved files "take their markers with them".
77 "*Controls marking of renamed files.
78If t, files keep their previous marks when they are renamed.
79If a character, renamed files (whether previously marked or not)
80are afterward marked with that character.")
81
82;;;###autoload
83(defvar dired-keep-marker-copy ?C
84 "*Controls marking of copied files.
85If t, copied files are marked if and as the corresponding original files were.
86If a character, copied files are unconditionally marked with that character.")
87
88;;;###autoload
89(defvar dired-keep-marker-hardlink ?H
90 "*Controls marking of newly made hard links.
91If t, they are marked if and as the files linked to were marked.
92If a character, new links are unconditionally marked with that character.")
93
94;;;###autoload
95(defvar dired-keep-marker-symlink ?Y
96 "*Controls marking of newly made symbolic links.
97If t, they are marked if and as the files linked to were marked.
98If a character, new links are unconditionally marked with that character.")
99
100;;;###autoload
101(defvar dired-dwim-target nil
102 "*If non-nil, dired tries to guess a default target directory.
103This means: if there is a dired buffer displayed in the next window,
104use its current subdir, instead of the current subdir of this dired buffer.
105
106The target is used in the prompt for file copy, rename etc.")
107
108;;;###autoload
109(defvar dired-copy-preserve-time t
110 "*If non-nil, Dired preserves the last-modified time in a file copy.
111\(This works on only some systems.)")
112
113;;; Hook variables
114
115(defvar dired-load-hook nil
116 "Run after loading dired.
117You can customize key bindings or load extensions with this.")
118
119(defvar dired-mode-hook nil
120 "Run at the very end of dired-mode.")
121
122(defvar dired-before-readin-hook nil
123 "This hook is run before a dired buffer is read in (created or reverted).")
124
125(defvar dired-after-readin-hook nil
126 "Hook run after each time a file or directory is read by Dired.
127After each listing of a file or directory, this hook is run
128with the buffer narrowed to the listing.")
129;; Note this can't simply be run inside function `dired-ls' as the hook
130;; functions probably depend on the dired-subdir-alist to be OK.
131
132;;; Internal variables
133
134(defvar dired-marker-char ?* ; the answer is 42
135 ;; so that you can write things like
136 ;; (let ((dired-marker-char ?X))
137 ;; ;; great code using X markers ...
138 ;; )
139 ;; For example, commands operating on two sets of files, A and B.
140 ;; Or marking files with digits 0-9. This could implicate
141 ;; concentric sets or an order for the marked files.
142 ;; The code depends on dynamic scoping on the marker char.
143 "In Dired, the current mark character.
144This is what the `do' commands look for and what the `mark' commands store.")
145
146(defvar dired-del-marker ?D
147 "Character used to flag files for deletion.")
148
149(defvar dired-shrink-to-fit
ab67260b
RS
150 t
151;; I see no reason ever to make this nil -- rms.
152;; (> baud-rate search-slow-speed)
492d2437
RS
153 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
154
155(defvar dired-flagging-regexp nil);; Last regexp used to flag files.
156
ab67260b
RS
157(defvar dired-file-version-alist)
158
492d2437
RS
159(defvar dired-directory nil
160 "The directory name or shell wildcard that was used as argument to `ls'.
8d23c16b
ER
161Local to each dired buffer. May be a list, in which case the car is the
162directory name and the cdr is the actual files to list.")
492d2437
RS
163
164(defvar dired-actual-switches nil
165 "The value of `dired-listing-switches' used to make this buffer's text.")
166
167(defvar dired-re-inode-size "[0-9 \t]*"
168 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
169
170;; These regexps must be tested at beginning-of-line, but are also
171;; used to search for next matches, so neither omitting "^" nor
172;; replacing "^" by "\n" (to make it slightly faster) will work.
173
174(defvar dired-re-mark "^[^ \n]")
175;; "Regexp matching a marked line.
176;; Important: the match ends just after the marker."
177(defvar dired-re-maybe-mark "^. ")
178(defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d"))
179(defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l"))
180(defvar dired-re-exe;; match ls permission string of an executable file
181 (mapconcat (function
182 (lambda (x)
183 (concat dired-re-maybe-mark dired-re-inode-size x)))
184 '("-[-r][-w][xs][-r][-w].[-r][-w]."
185 "-[-r][-w].[-r][-w][xs][-r][-w]."
186 "-[-r][-w].[-r][-w].[-r][-w][xst]")
187 "\\|"))
188(defvar dired-re-dot "^.* \\.\\.?$")
189
190(defvar dired-subdir-alist nil
191 "Association list of subdirectories and their buffer positions.
192Each subdirectory has an element: (DIRNAME . STARTMARKER).
7b2469ae
RS
193The order of elements is the reverse of the order in the buffer.
194In simple cases, this list contains one element.")
492d2437 195
cdf156a9 196(defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
492d2437
RS
197 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
198Subexpression 1 is the subdirectory proper, no trailing colon.
199The match starts at the beginning of the line and ends after the end
200of the line (\\n or \\r).
201Subexpression 2 must end right before the \\n or \\r.")
202
203\f
204;;; Macros must be defined before they are used, for the byte compiler.
205
206;; Mark all files for which CONDITION evals to non-nil.
207;; CONDITION is evaluated on each line, with point at beginning of line.
208;; MSG is a noun phrase for the type of files being marked.
209;; It should end with a noun that can be pluralized by adding `s'.
210;; Return value is the number of files marked, or nil if none were marked.
211(defmacro dired-mark-if (predicate msg)
212 (` (let (buffer-read-only count)
213 (save-excursion
214 (setq count 0)
215 (if (, msg) (message "Marking %ss..." (, msg)))
216 (goto-char (point-min))
217 (while (not (eobp))
218 (if (, predicate)
219 (progn
220 (delete-char 1)
221 (insert dired-marker-char)
222 (setq count (1+ count))))
223 (forward-line 1))
224 (if (, msg) (message "%s %s%s %s%s."
225 count
226 (, msg)
227 (dired-plural-s count)
228 (if (eq dired-marker-char ?\040) "un" "")
229 (if (eq dired-marker-char dired-del-marker)
230 "flagged" "marked"))))
231 (and (> count 0) count))))
232
233(defmacro dired-map-over-marks (body arg &optional show-progress)
234;; "Macro: Perform BODY with point somewhere on each marked line
235;;and return a list of BODY's results.
236;;If no marked file could be found, execute BODY on the current line.
237;; If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
238;; files instead of the marked files.
239;; In that case point is dragged along. This is so that commands on
240;; the next ARG (instead of the marked) files can be chained easily.
241;; If ARG is otherwise non-nil, use current file instead.
242;;If optional third arg SHOW-PROGRESS evaluates to non-nil,
243;; redisplay the dired buffer after each file is processed.
244;;No guarantee is made about the position on the marked line.
245;; BODY must ensure this itself if it depends on this.
246;;Search starts at the beginning of the buffer, thus the car of the list
247;; corresponds to the line nearest to the buffer's bottom. This
248;; is also true for (positive and negative) integer values of ARG.
249;;BODY should not be too long as it is expanded four times."
250;;
251;;Warning: BODY must not add new lines before point - this may cause an
252;;endless loop.
253;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
254 (` (prog1
255 (let (buffer-read-only case-fold-search found results)
256 (if (, arg)
257 (if (integerp (, arg))
258 (progn;; no save-excursion, want to move point.
259 (dired-repeat-over-lines
260 (, arg)
261 (function (lambda ()
262 (if (, show-progress) (sit-for 0))
263 (setq results (cons (, body) results)))))
264 (if (< (, arg) 0)
265 (nreverse results)
266 results))
267 ;; non-nil, non-integer ARG means use current file:
268 (list (, body)))
269 (let ((regexp (dired-marker-regexp)) next-position)
270 (save-excursion
271 (goto-char (point-min))
272 ;; remember position of next marked file before BODY
273 ;; can insert lines before the just found file,
274 ;; confusing us by finding the same marked file again
275 ;; and again and...
276 (setq next-position (and (re-search-forward regexp nil t)
277 (point-marker))
278 found (not (null next-position)))
279 (while next-position
280 (goto-char next-position)
281 (if (, show-progress) (sit-for 0))
282 (setq results (cons (, body) results))
283 ;; move after last match
284 (goto-char next-position)
285 (forward-line 1)
286 (set-marker next-position nil)
287 (setq next-position (and (re-search-forward regexp nil t)
288 (point-marker)))))
289 (if found
290 results
291 (list (, body))))))
292 ;; save-excursion loses, again
293 (dired-move-to-filename))))
294
295(defun dired-get-marked-files (&optional localp arg)
296 "Return the marked files' names as list of strings.
297The list is in the same order as the buffer, that is, the car is the
298 first marked file.
299Values returned are normally absolute pathnames.
300Optional arg LOCALP as in `dired-get-filename'.
301Optional second argument ARG forces to use other files. If ARG is an
302 integer, use the next ARG files. If ARG is otherwise non-nil, use
303 current file. Usually ARG comes from the current prefix arg."
84fc2cfa 304 (save-excursion
492d2437 305 (nreverse (dired-map-over-marks (dired-get-filename localp) arg))))
84fc2cfa 306
492d2437
RS
307\f
308;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
309;; other special applications.
492d2437
RS
310\f
311;; The dired command
312
313(defun dired-read-dir-and-switches (str)
314 ;; For use in interactive.
315 (reverse (list
316 (if current-prefix-arg
317 (read-string "Dired listing switches: "
318 dired-listing-switches))
319 (read-file-name (format "Dired %s(directory): " str)
320 nil default-directory nil))))
84fc2cfa 321
492d2437 322;;;###autoload (define-key ctl-x-map "d" 'dired)
84fc2cfa 323;;;###autoload
492d2437 324(defun dired (dirname &optional switches)
84fc2cfa 325 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
492d2437
RS
326Optional second argument SWITCHES specifies the `ls' options used.
327\(Interactively, use a prefix argument to be able to specify SWITCHES.)
328Dired displays a list of files in DIRNAME (which may also have
8d23c16b
ER
329shell wildcards appended to select certain files). If DIRNAME is a cons,
330its first element is taken as the directory name and the resr as an explicit
331list of files to make directory entries for.
52041219 332\\<dired-mode-map>\
492d2437 333You can move around in it with the usual commands.
8d23c16b
ER
334You can flag files for deletion with \\[dired-flag-file-deletion] and then
335delete them by typing \\[dired-do-flagged-delete].
492d2437 336Type \\[describe-mode] after entering dired for more info.
84fc2cfa 337
492d2437
RS
338If DIRNAME is already in a dired buffer, that buffer is used without refresh."
339 ;; Cannot use (interactive "D") because of wildcards.
340 (interactive (dired-read-dir-and-switches ""))
341 (switch-to-buffer (dired-noselect dirname switches)))
342
343;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
84fc2cfa 344;;;###autoload
492d2437 345(defun dired-other-window (dirname &optional switches)
84fc2cfa 346 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
492d2437
RS
347 (interactive (dired-read-dir-and-switches "in other window "))
348 (switch-to-buffer-other-window (dired-noselect dirname switches)))
84fc2cfa 349
ec03e49c
RS
350;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
351;;;###autoload
352(defun dired-other-frame (dirname &optional switches)
353 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
354 (interactive (dired-read-dir-and-switches "in other frame "))
355 (switch-to-buffer-other-frame (dired-noselect dirname switches)))
356
84fc2cfa 357;;;###autoload
8d23c16b 358(defun dired-noselect (dir-or-list &optional switches)
84fc2cfa 359 "Like `dired' but returns the dired buffer as value, does not select it."
8d23c16b 360 (or dir-or-list (setq dir-or-list default-directory))
492d2437
RS
361 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
362 ;; some shells make:
8d23c16b
ER
363 (let (dirname)
364 (if (consp dir-or-list)
365 (setq dirname (car dir-or-list))
366 (setq dirname dir-or-list))
367 (setq dirname (expand-file-name (directory-file-name dirname)))
368 (if (file-directory-p dirname)
369 (setq dirname (file-name-as-directory dirname)))
370 (if (consp dir-or-list)
371 (setq dir-or-list (cons dirname (cdr dir-or-list)))
372 (setq dir-or-list dirname))
373 (dired-internal-noselect dir-or-list switches)))
492d2437
RS
374
375;; Separate function from dired-noselect for the sake of dired-vms.el.
8d23c16b 376(defun dired-internal-noselect (dir-or-list &optional switches)
492d2437
RS
377 ;; If there is an existing dired buffer for DIRNAME, just leave
378 ;; buffer as it is (don't even call dired-revert).
379 ;; This saves time especially for deep trees or with ange-ftp.
380 ;; The user can type `g'easily, and it is more consistent with find-file.
381 ;; But if SWITCHES are given they are probably different from the
382 ;; buffer's old value, so call dired-sort-other, which does
383 ;; revert the buffer.
384 ;; A pity we can't possibly do "Directory has changed - refresh? "
385 ;; like find-file does.
8d23c16b
ER
386 (let* ((dirname (if (consp dir-or-list) (car dir-or-list) dir-or-list))
387 (buffer (dired-find-buffer-nocreate dir-or-list))
492d2437
RS
388 ;; note that buffer already is in dired-mode, if found
389 (new-buffer-p (not buffer))
390 (old-buf (current-buffer)))
391 (or buffer
392 (let ((default-major-mode 'fundamental-mode))
393 ;; We don't want default-major-mode to run hooks and set auto-fill
394 ;; or whatever, now that dired-mode does not
395 ;; kill-all-local-variables any longer.
396 (setq buffer (create-file-buffer (directory-file-name dirname)))))
397 (set-buffer buffer)
398 (if (not new-buffer-p) ; existing buffer ...
399 (if switches ; ... but new switches
400 (dired-sort-other switches)) ; this calls dired-revert
401 ;; Else a new buffer
847aabce
RS
402 (setq default-directory
403 (abbreviate-file-name
404 (if (file-directory-p dirname)
405 dirname
406 (file-name-directory dirname))))
492d2437
RS
407 (or switches (setq switches dired-listing-switches))
408 (dired-mode dirname switches)
409 ;; default-directory and dired-actual-switches are set now
410 ;; (buffer-local), so we can call dired-readin:
411 (let ((failed t))
412 (unwind-protect
8d23c16b 413 (progn (dired-readin dir-or-list buffer)
492d2437
RS
414 (setq failed nil))
415 ;; dired-readin can fail if parent directories are inaccessible.
416 ;; Don't leave an empty buffer around in that case.
417 (if failed (kill-buffer buffer))))
418 ;; No need to narrow since the whole buffer contains just
419 ;; dired-readin's output, nothing else. The hook can
420 ;; successfully use dired functions (e.g. dired-get-filename)
421 ;; as the subdir-alist has been built in dired-readin.
422 (run-hooks 'dired-after-readin-hook)
423 (goto-char (point-min))
424 (dired-initial-position dirname))
425 (set-buffer old-buf)
84fc2cfa
ER
426 buffer))
427
492d2437
RS
428;; This differs from dired-buffers-for-dir in that it does not consider
429;; subdirs of default-directory and searches for the first match only
430(defun dired-find-buffer-nocreate (dirname)
431 (let (found (blist (buffer-list)))
432 (while blist
433 (save-excursion
434 (set-buffer (car blist))
435 (if (and (eq major-mode 'dired-mode)
436 (equal dired-directory dirname))
437 (setq found (car blist)
438 blist nil)
439 (setq blist (cdr blist)))))
440 found))
441
442\f
443;; Read in a new dired buffer
444
445;; dired-readin differs from dired-insert-subdir in that it accepts
446;; wildcards, erases the buffer, and builds the subdir-alist anew
447;; (including making it buffer-local and clearing it first).
8d23c16b 448(defun dired-readin (dir-or-list buffer)
492d2437
RS
449 ;; default-directory and dired-actual-switches must be buffer-local
450 ;; and initialized by now.
451 ;; Thus we can test (equal default-directory dirname) instead of
452 ;; (file-directory-p dirname) and save a filesystem transaction.
453 ;; Also, we can run this hook which may want to modify the switches
454 ;; based on default-directory, e.g. with ange-ftp to a SysV host
455 ;; where ls won't understand -Al switches.
8d23c16b
ER
456 (let (dirname)
457 (if (consp dir-or-list)
458 (setq dirname (car dir-or-list))
459 (setq dirname dir-or-list))
460 (setq dirname (expand-file-name dirname))
461 (if (consp dir-or-list)
462 (setq dir-or-list (cons dirname (cdr dir-or-list))))
463 (run-hooks 'dired-before-readin-hook)
464 (save-excursion
465 (message "Reading directory %s..." dirname)
466 (set-buffer buffer)
467 (let (buffer-read-only (failed t))
468 (widen)
469 (erase-buffer)
470 (dired-readin-insert dir-or-list)
471 (indent-rigidly (point-min) (point-max) 2)
472 ;; We need this to make the root dir have a header line as all
473 ;; other subdirs have:
474 (goto-char (point-min))
475 (dired-insert-headerline default-directory)
476 ;; can't run dired-after-readin-hook here, it may depend on the subdir
477 ;; alist to be OK.
478 )
479 (message "Reading directory %s...done" dirname)
480 (set-buffer-modified-p nil)
481 ;; Must first make alist buffer local and set it to nil because
482 ;; dired-build-subdir-alist will call dired-clear-alist first
483 (set (make-local-variable 'dired-subdir-alist) nil)
484 (dired-build-subdir-alist))))
492d2437
RS
485
486;; Subroutines of dired-readin
487
8d23c16b
ER
488(defun dired-readin-insert (dir-or-list)
489 ;; Just insert listing for the passed-in directory or
490 ;; directory-and-file list, assuming a clean buffer.
491 (let (dirname)
492 (if (consp dir-or-list)
493 (setq dirname (car dir-or-list))
494 (setq dirname dir-or-list))
f45da5d1
RS
495 ;; Expand before comparing in case one or both have been abbreviated.
496 (if (and (equal (expand-file-name default-directory)
497 (expand-file-name dirname))
cf39fa9b
RS
498 (not (consp dir-or-list)))
499 ;; If we are reading a whole single directory...
8d23c16b
ER
500 (dired-insert-directory dir-or-list dired-actual-switches nil t)
501 (if (not (file-readable-p
502 (directory-file-name (file-name-directory dirname))))
503 (error "Directory %s inaccessible or nonexistent" dirname)
cf39fa9b
RS
504 ;; Else assume it contains wildcards,
505 ;; unless it is an explicit list of files.
506 (dired-insert-directory dir-or-list dired-actual-switches
507 (not (listp dir-or-list)))
8d23c16b
ER
508 (save-excursion ;; insert wildcard instead of total line:
509 (goto-char (point-min))
510 (insert "wildcard " (file-name-nondirectory dirname) "\n"))))))
511
512(defun dired-insert-directory (dir-or-list switches &optional wildcard full-p)
513 ;; Do the right thing whether dir-or-list is atomic or not. If it is,
514 ;; inset all files listed in the cdr (the car is the passed-in directory
f726257e 515 ;; list).
cb88a3db
RS
516 (let ((opoint (point)))
517 (if (consp dir-or-list)
518 (progn
519 (mapcar
520 (function (lambda (x) (insert-directory x switches wildcard full-p)))
521 (cdr dir-or-list)))
522 (insert-directory dir-or-list switches wildcard full-p))
523 (dired-insert-set-properties opoint (point)))
8d23c16b 524 (setq dired-directory dir-or-list))
492d2437 525
cb88a3db
RS
526(defun dired-insert-set-properties (beg end)
527 (save-excursion
528 (goto-char beg)
529 (while (< (point) end)
530 (if (dired-move-to-filename)
531 (put-text-property (point)
532 (save-excursion
533 (dired-move-to-end-of-filename)
534 (point))
535 'mouse-face 'highlight))
536 (forward-line 1))))
537
492d2437
RS
538(defun dired-insert-headerline (dir);; also used by dired-insert-subdir
539 ;; Insert DIR's headerline with no trailing slash, exactly like ls
540 ;; would, and put cursor where dired-build-subdir-alist puts subdir
541 ;; boundaries.
542 (save-excursion (insert " " (directory-file-name dir) ":\n")))
543
544\f
545;; Reverting a dired buffer
546
84fc2cfa 547(defun dired-revert (&optional arg noconfirm)
492d2437
RS
548 ;; Reread the dired buffer. Must also be called after
549 ;; dired-actual-switches have changed.
550 ;; Should not fail even on completely garbaged buffers.
551 ;; Preserves old cursor, marks/flags, hidden-p.
552 (widen) ; just in case user narrowed
84fc2cfa 553 (let ((opoint (point))
492d2437
RS
554 (ofile (dired-get-filename nil t))
555 (mark-alist nil) ; save marked files
556 (hidden-subdirs (dired-remember-hidden))
557 (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
558 (case-fold-search nil) ; we check for upper case ls flags
559 buffer-read-only)
560 (goto-char (point-min))
561 (setq mark-alist;; only after dired-remember-hidden since this unhides:
562 (dired-remember-marks (point-min) (point-max)))
563 ;; treat top level dir extra (it may contain wildcards)
8d23c16b
ER
564 (dired-uncache
565 (if (consp dired-directory) (car dired-directory) dired-directory))
84fc2cfa 566 (dired-readin dired-directory (current-buffer))
492d2437
RS
567 (let ((dired-after-readin-hook nil))
568 ;; don't run that hook for each subdir...
569 (dired-insert-old-subdirs old-subdir-alist))
570 (dired-mark-remembered mark-alist) ; mark files that were marked
571 ;; ... run the hook for the whole buffer, and only after markers
572 ;; have been reinserted (else omitting in dired-x would omit marked files)
573 (run-hooks 'dired-after-readin-hook) ; no need to narrow
574 (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
575 (goto-char opoint)) ; was before
84fc2cfa 576 (dired-move-to-filename)
492d2437
RS
577 (save-excursion ; hide subdirs that were hidden
578 (mapcar (function (lambda (dir)
579 (if (dired-goto-subdir dir)
580 (dired-hide-subdir 1))))
581 hidden-subdirs)))
582 ;; outside of the let scope
583;;; Might as well not override the user if the user changed this.
584;;; (setq buffer-read-only t)
585 )
586
587;; Subroutines of dired-revert
588;; Some of these are also used when inserting subdirs.
589
590(defun dired-remember-marks (beg end)
591 ;; Return alist of files and their marks, from BEG to END.
592 (if selective-display ; must unhide to make this work.
593 (let (buffer-read-only)
594 (subst-char-in-region beg end ?\r ?\n)))
595 (let (fil chr alist)
596 (save-excursion
597 (goto-char beg)
598 (while (re-search-forward dired-re-mark end t)
599 (if (setq fil (dired-get-filename nil t))
600 (setq chr (preceding-char)
601 alist (cons (cons fil chr) alist)))))
602 alist))
603
604;; Mark all files remembered in ALIST.
605;; Each element of ALIST looks like (FILE . MARKERCHAR).
606(defun dired-mark-remembered (alist)
607 (let (elt fil chr)
608 (while alist
609 (setq elt (car alist)
610 alist (cdr alist)
611 fil (car elt)
612 chr (cdr elt))
613 (if (dired-goto-file fil)
614 (save-excursion
615 (beginning-of-line)
616 (delete-char 1)
617 (insert chr))))))
618
619;; Return a list of names of subdirs currently hidden.
620(defun dired-remember-hidden ()
621 (let ((l dired-subdir-alist) dir pos result)
622 (while l
623 (setq dir (car (car l))
624 pos (cdr (car l))
625 l (cdr l))
626 (goto-char pos)
627 (skip-chars-forward "^\r\n")
52041219 628 (if (eq (following-char) ?\r)
492d2437
RS
629 (setq result (cons dir result))))
630 result))
631
632;; Try to insert all subdirs that were displayed before,
633;; according to the former subdir alist OLD-SUBDIR-ALIST.
634(defun dired-insert-old-subdirs (old-subdir-alist)
635 (or (string-match "R" dired-actual-switches)
636 (let (elt dir)
637 (while old-subdir-alist
638 (setq elt (car old-subdir-alist)
639 old-subdir-alist (cdr old-subdir-alist)
640 dir (car elt))
641 (condition-case ()
715984d3
RS
642 (progn
643 (dired-uncache dir)
644 (dired-insert-subdir dir))
492d2437 645 (error nil))))))
715984d3
RS
646
647;; Remove directory DIR from any directory cache.
648(defun dired-uncache (dir)
6eaebaa2 649 (let ((handler (find-file-name-handler dir 'dired-uncache)))
715984d3
RS
650 (if handler
651 (funcall handler 'dired-uncache dir))))
492d2437
RS
652\f
653;; dired mode key bindings and initialization
84fc2cfa
ER
654
655(defvar dired-mode-map nil "Local keymap for dired-mode buffers.")
656(if dired-mode-map
657 nil
492d2437
RS
658 ;; This looks ugly when substitute-command-keys uses C-d instead d:
659 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
660
84fc2cfa
ER
661 (setq dired-mode-map (make-keymap))
662 (suppress-keymap dired-mode-map)
dbcb9389 663 (define-key dired-mode-map [mouse-2] 'dired-mouse-find-file-other-window)
492d2437 664 ;; Commands to mark or flag certain categories of files
84fc2cfa 665 (define-key dired-mode-map "#" 'dired-flag-auto-save-files)
492d2437 666 (define-key dired-mode-map "*" 'dired-mark-executables)
84fc2cfa 667 (define-key dired-mode-map "." 'dired-clean-directory)
492d2437
RS
668 (define-key dired-mode-map "/" 'dired-mark-directories)
669 (define-key dired-mode-map "@" 'dired-mark-symlinks)
670 (define-key dired-mode-map "~" 'dired-flag-backup-files)
6482fcac 671 ;; Upper case keys (except !) for operating on the marked files
492d2437
RS
672 (define-key dired-mode-map "C" 'dired-do-copy)
673 (define-key dired-mode-map "B" 'dired-do-byte-compile)
674 (define-key dired-mode-map "D" 'dired-do-delete)
675 (define-key dired-mode-map "G" 'dired-do-chgrp)
676 (define-key dired-mode-map "H" 'dired-do-hardlink)
677 (define-key dired-mode-map "L" 'dired-do-load)
678 (define-key dired-mode-map "M" 'dired-do-chmod)
679 (define-key dired-mode-map "O" 'dired-do-chown)
680 (define-key dired-mode-map "P" 'dired-do-print)
681 (define-key dired-mode-map "R" 'dired-do-rename)
682 (define-key dired-mode-map "S" 'dired-do-symlink)
683 (define-key dired-mode-map "X" 'dired-do-shell-command)
684 (define-key dired-mode-map "Z" 'dired-do-compress)
685 (define-key dired-mode-map "!" 'dired-do-shell-command)
686 ;; Comparison commands
687 (define-key dired-mode-map "=" 'dired-diff)
688 (define-key dired-mode-map "\M-=" 'dired-backup-diff)
689 ;; Tree Dired commands
690 (define-key dired-mode-map "\M-\C-?" 'dired-unmark-all-files)
691 (define-key dired-mode-map "\M-\C-d" 'dired-tree-down)
692 (define-key dired-mode-map "\M-\C-u" 'dired-tree-up)
693 (define-key dired-mode-map "\M-\C-n" 'dired-next-subdir)
694 (define-key dired-mode-map "\M-\C-p" 'dired-prev-subdir)
695 ;; move to marked files
696 (define-key dired-mode-map "\M-{" 'dired-prev-marked-file)
697 (define-key dired-mode-map "\M-}" 'dired-next-marked-file)
492d2437 698 ;; Make all regexp commands share a `%' prefix:
767151e1
RS
699 ;; We used to get to the submap via a symbol dired-regexp-prefix,
700 ;; but that seems to serve little purpose, and copy-keymap
701 ;; does a better job without it.
702 (define-key dired-mode-map "%" nil)
492d2437
RS
703 (define-key dired-mode-map "%u" 'dired-upcase)
704 (define-key dired-mode-map "%l" 'dired-downcase)
705 (define-key dired-mode-map "%d" 'dired-flag-files-regexp)
706 (define-key dired-mode-map "%m" 'dired-mark-files-regexp)
707 (define-key dired-mode-map "%r" 'dired-do-rename-regexp)
708 (define-key dired-mode-map "%C" 'dired-do-copy-regexp)
709 (define-key dired-mode-map "%H" 'dired-do-hardlink-regexp)
710 (define-key dired-mode-map "%R" 'dired-do-rename-regexp)
711 (define-key dired-mode-map "%S" 'dired-do-symlink-regexp)
712 ;; Lower keys for commands not operating on all the marked files
6482fcac 713 (define-key dired-mode-map "c" 'dired-change-marks)
492d2437
RS
714 (define-key dired-mode-map "d" 'dired-flag-file-deletion)
715 (define-key dired-mode-map "e" 'dired-find-file)
716 (define-key dired-mode-map "f" 'dired-advertised-find-file)
717 (define-key dired-mode-map "g" 'revert-buffer)
84fc2cfa 718 (define-key dired-mode-map "h" 'describe-mode)
492d2437 719 (define-key dired-mode-map "i" 'dired-maybe-insert-subdir)
6482fcac 720 (define-key dired-mode-map "k" 'dired-do-kill-lines)
492d2437
RS
721 (define-key dired-mode-map "l" 'dired-do-redisplay)
722 (define-key dired-mode-map "m" 'dired-mark)
723 (define-key dired-mode-map "n" 'dired-next-line)
724 (define-key dired-mode-map "o" 'dired-find-file-other-window)
ab67260b 725 (define-key dired-mode-map "\C-o" 'dired-display-file)
492d2437
RS
726 (define-key dired-mode-map "p" 'dired-previous-line)
727 (define-key dired-mode-map "q" 'dired-quit)
728 (define-key dired-mode-map "s" 'dired-sort-toggle-or-edit)
729 (define-key dired-mode-map "u" 'dired-unmark)
730 (define-key dired-mode-map "v" 'dired-view-file)
731 (define-key dired-mode-map "x" 'dired-do-flagged-delete)
732 (define-key dired-mode-map "+" 'dired-create-directory)
733 ;; moving
734 (define-key dired-mode-map "<" 'dired-prev-dirline)
735 (define-key dired-mode-map ">" 'dired-next-dirline)
736 (define-key dired-mode-map "^" 'dired-up-directory)
84fc2cfa
ER
737 (define-key dired-mode-map " " 'dired-next-line)
738 (define-key dired-mode-map "\C-n" 'dired-next-line)
739 (define-key dired-mode-map "\C-p" 'dired-previous-line)
492d2437
RS
740 ;; hiding
741 (define-key dired-mode-map "$" 'dired-hide-subdir)
742 (define-key dired-mode-map "\M-$" 'dired-hide-all)
743 ;; misc
744 (define-key dired-mode-map "?" 'dired-summary)
745 (define-key dired-mode-map "\177" 'dired-unmark-backward)
746 (define-key dired-mode-map "\C-_" 'dired-undo)
747 (define-key dired-mode-map "\C-xu" 'dired-undo)
748 )
492d2437 749\f
fc53efda
RS
750;; Make menu bar items.
751
752;; Get rid of the Edit menu bar item to save space.
753(define-key dired-mode-map [menu-bar edit] 'undefined)
754
755(define-key dired-mode-map [menu-bar subdir]
756 (cons "Subdir" (make-sparse-keymap "Subdir")))
757
758(define-key dired-mode-map [menu-bar subdir hide-all]
759 '("Hide All" . dired-hide-all))
760(define-key dired-mode-map [menu-bar subdir hide-subdir]
761 '("Hide Subdir" . dired-hide-subdir))
762(define-key dired-mode-map [menu-bar subdir tree-down]
763 '("Tree Down" . dired-tree-down))
764(define-key dired-mode-map [menu-bar subdir tree-up]
765 '("Tree Up" . dired-tree-up))
766(define-key dired-mode-map [menu-bar subdir up]
767 '("Up Directory" . dired-up-directory))
768(define-key dired-mode-map [menu-bar subdir prev-subdir]
769 '("Prev Subdir" . dired-prev-subdir))
770(define-key dired-mode-map [menu-bar subdir next-subdir]
771 '("Next Subdir" . dired-next-subdir))
772(define-key dired-mode-map [menu-bar subdir prev-dirline]
773 '("Prev Dirline" . dired-prev-dirline))
774(define-key dired-mode-map [menu-bar subdir next-dirline]
775 '("Next Dirline" . dired-next-dirline))
776(define-key dired-mode-map [menu-bar subdir insert]
777 '("Insert This Subdir" . dired-maybe-insert-subdir))
778
779(define-key dired-mode-map [menu-bar immediate]
780 (cons "Immediate" (make-sparse-keymap "Immediate")))
781
782(define-key dired-mode-map [menu-bar immediate backup-diff]
783 '("Compare with Backup" . dired-backup-diff))
784(define-key dired-mode-map [menu-bar immediate diff]
785 '("Diff" . dired-diff))
786(define-key dired-mode-map [menu-bar immediate view]
787 '("View This File" . dired-view-file))
788(define-key dired-mode-map [menu-bar immediate display]
789 '("Display in Other Window" . dired-display-file))
790(define-key dired-mode-map [menu-bar immediate find-file-other-window]
791 '("Find in Other Window" . dired-find-file-other-window))
792(define-key dired-mode-map [menu-bar immediate find-file]
793 '("Find This File" . dired-find-file))
794(define-key dired-mode-map [menu-bar immediate create-directory]
795 '("Create Directory..." . dired-create-directory))
796
797(define-key dired-mode-map [menu-bar regexp]
798 (cons "Regexp" (make-sparse-keymap "Regexp")))
799
800(define-key dired-mode-map [menu-bar regexp downcase]
801 '("Downcase" . dired-downcase))
802(define-key dired-mode-map [menu-bar regexp upcase]
803 '("Upcase" . dired-upcase))
804(define-key dired-mode-map [menu-bar regexp hardlink]
805 '("Hardlink..." . dired-do-hardlink-regexp))
806(define-key dired-mode-map [menu-bar regexp symlink]
807 '("Symlink..." . dired-do-symlink-regexp))
808(define-key dired-mode-map [menu-bar regexp rename]
809 '("Rename..." . dired-do-rename-regexp))
810(define-key dired-mode-map [menu-bar regexp copy]
811 '("Copy..." . dired-do-copy-regexp))
812(define-key dired-mode-map [menu-bar regexp flag]
813 '("Flag..." . dired-flag-files-regexp))
814(define-key dired-mode-map [menu-bar regexp mark]
815 '("Mark..." . dired-mark-files-regexp))
816
817(define-key dired-mode-map [menu-bar mark]
818 (cons "Mark" (make-sparse-keymap "Mark")))
819
820(define-key dired-mode-map [menu-bar mark prev]
821 '("Previous Marked" . dired-prev-marked-file))
822(define-key dired-mode-map [menu-bar mark next]
823 '("Next Marked" . dired-next-marked-file))
824(define-key dired-mode-map [menu-bar mark marks]
825 '("Change Marks..." . dired-change-marks))
b1ecd9c6
RS
826(define-key dired-mode-map [menu-bar mark unmark-all]
827 '("Unmark All" . dired-unmark-all-files-no-query))
fc53efda
RS
828(define-key dired-mode-map [menu-bar mark symlinks]
829 '("Mark Symlinks" . dired-mark-symlinks))
830(define-key dired-mode-map [menu-bar mark directories]
831 '("Mark Directories" . dired-mark-directories))
832(define-key dired-mode-map [menu-bar mark directory]
833 '("Mark Old Backups" . dired-clean-directory))
834(define-key dired-mode-map [menu-bar mark executables]
835 '("Mark Executables" . dired-mark-executables))
b1ecd9c6 836(define-key dired-mode-map [menu-bar mark backup-files]
fc53efda 837 '("Flag Backup Files" . dired-flag-backup-files))
b1ecd9c6 838(define-key dired-mode-map [menu-bar mark auto-save-files]
fc53efda
RS
839 '("Flag Auto-save Files" . dired-flag-auto-save-files))
840(define-key dired-mode-map [menu-bar mark deletion]
841 '("Flag" . dired-flag-file-deletion))
842(define-key dired-mode-map [menu-bar mark unmark]
843 '("Unmark" . dired-unmark))
844(define-key dired-mode-map [menu-bar mark mark]
845 '("Mark" . dired-mark))
846
847(define-key dired-mode-map [menu-bar operate]
848 (cons "Operate" (make-sparse-keymap "Operate")))
849
850(define-key dired-mode-map [menu-bar operate chown]
851 '("Change Owner..." . dired-do-chown))
852(define-key dired-mode-map [menu-bar operate chgrp]
853 '("Change Group..." . dired-do-chgrp))
854(define-key dired-mode-map [menu-bar operate chmod]
855 '("Change Mode..." . dired-do-chmod))
856(define-key dired-mode-map [menu-bar operate load]
857 '("Load" . dired-do-load))
858(define-key dired-mode-map [menu-bar operate compile]
859 '("Byte-compile" . dired-do-byte-compile))
860(define-key dired-mode-map [menu-bar operate compress]
861 '("Compress" . dired-do-compress))
862(define-key dired-mode-map [menu-bar operate print]
863 '("Print" . dired-do-print))
864(define-key dired-mode-map [menu-bar operate hardlink]
865 '("Hardlink to..." . dired-do-hardlink))
866(define-key dired-mode-map [menu-bar operate symlink]
867 '("Symlink to..." . dired-do-symlink))
868(define-key dired-mode-map [menu-bar operate command]
869 '("Shell Command..." . dired-do-shell-command))
870(define-key dired-mode-map [menu-bar operate delete]
871 '("Delete" . dired-do-delete))
872(define-key dired-mode-map [menu-bar operate rename]
873 '("Rename to..." . dired-do-rename))
874(define-key dired-mode-map [menu-bar operate copy]
875 '("Copy to..." . dired-do-copy))
876\f
84fc2cfa
ER
877;; Dired mode is suitable only for specially formatted data.
878(put 'dired-mode 'mode-class 'special)
879
492d2437
RS
880(defun dired-mode (&optional dirname switches)
881 "\
882Mode for \"editing\" directory listings.
883In dired, you are \"editing\" a list of the files in a directory and
884 \(optionally) its subdirectories, in the format of `ls -lR'.
885 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
886\"Editing\" means that you can run shell commands on files, visit,
887 compress, load or byte-compile them, change their file attributes
888 and insert subdirectories into the same buffer. You can \"mark\"
889 files for later commands or \"flag\" them for deletion, either file
890 by file or all files matching certain criteria.
891You can move using the usual cursor motion commands.\\<dired-mode-map>
892Letters no longer insert themselves. Digits are prefix arguments.
893Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
894Type \\[dired-mark] to Mark a file or subdirectory for later commands.
895 Most commands operate on the marked files and use the current file
896 if no files are marked. Use a numeric prefix argument to operate on
897 the next ARG (or previous -ARG if ARG<0) files, or just `1'
898 to operate on the current file only. Prefix arguments override marks.
899 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
900 to see why something went wrong.
901Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
902Type \\[dired-unmark-backward] to back up one line and unflag.
903Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
904Type \\[dired-advertised-find-file] to Find the current line's file
905 (or dired it in another buffer, if it is a directory).
906Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
907Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
908Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
909Type \\[dired-do-copy] to Copy files.
910Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
911Type \\[revert-buffer] to read all currently expanded directories again.
912 This retains all marks and hides subdirs again that were hidden before.
913SPC and DEL can be used to move down and up by lines.
914
915If dired ever gets confused, you can either type \\[revert-buffer] \
916to read the
917directories again, type \\[dired-do-redisplay] \
918to relist a single or the marked files or a
919subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
920again for the directory tree.
921
922Customization variables (rename this buffer and type \\[describe-variable] on each line
923for more info):
924
925 dired-listing-switches
926 dired-trivial-filenames
927 dired-shrink-to-fit
928 dired-marker-char
929 dired-del-marker
930 dired-keep-marker-rename
931 dired-keep-marker-copy
932 dired-keep-marker-hardlink
933 dired-keep-marker-symlink
934
935Hooks (use \\[describe-variable] to see their documentation):
936
937 dired-before-readin-hook
938 dired-after-readin-hook
939 dired-mode-hook
940 dired-load-hook
941
942Keybindings:
84fc2cfa 943\\{dired-mode-map}"
492d2437
RS
944 ;; Not to be called interactively (e.g. dired-directory will be set
945 ;; to default-directory, which is wrong with wildcards).
84fc2cfa 946 (kill-all-local-variables)
84fc2cfa 947 (use-local-map dired-mode-map)
492d2437
RS
948 (dired-advertise) ; default-directory is already set
949 (setq major-mode 'dired-mode
950 mode-name "Dired"
3222085e 951;; case-fold-search nil
492d2437
RS
952 buffer-read-only t
953 selective-display t ; for subdirectory hiding
954 mode-line-buffer-identification '("Dired: %17b"))
955 (set (make-local-variable 'revert-buffer-function)
956 (function dired-revert))
957 (set (make-local-variable 'page-delimiter)
958 "\n\n")
959 (set (make-local-variable 'dired-directory)
960 (or dirname default-directory))
961 ;; list-buffers uses this to display the dir being edited in this buffer.
962 (set (make-local-variable 'list-buffers-directory)
963 dired-directory)
964 (set (make-local-variable 'dired-actual-switches)
965 (or switches dired-listing-switches))
492d2437 966 (dired-sort-other dired-actual-switches t)
84fc2cfa
ER
967 (run-hooks 'dired-mode-hook))
968\f
eb8c3be9 969;; Idiosyncratic dired commands that don't deal with marks.
84fc2cfa 970
492d2437
RS
971(defun dired-quit ()
972 "Bury the current dired buffer."
973 (interactive)
974 (bury-buffer))
84fc2cfa
ER
975
976(defun dired-summary ()
492d2437 977 "Summarize basic Dired commands and show recent Dired errors."
84fc2cfa 978 (interactive)
492d2437 979 (dired-why)
84fc2cfa
ER
980 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
981 (message
50f74744 982 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
84fc2cfa 983
492d2437
RS
984(defun dired-undo ()
985 "Undo in a dired buffer.
986This doesn't recover lost files, it just undoes changes in the buffer itself.
987You can use it to recover marks, killed lines or subdirs.
988In the latter case, you have to do \\[dired-build-subdir-alist] to
989parse the buffer again."
990 (interactive)
991 (let (buffer-read-only)
992 (undo)))
84fc2cfa
ER
993
994(defun dired-next-line (arg)
995 "Move down lines then position at filename.
996Optional prefix ARG says how many lines to move; default is one line."
997 (interactive "p")
998 (next-line arg)
999 (dired-move-to-filename))
1000
1001(defun dired-previous-line (arg)
1002 "Move up lines then position at filename.
1003Optional prefix ARG says how many lines to move; default is one line."
1004 (interactive "p")
1005 (previous-line arg)
1006 (dired-move-to-filename))
1007
492d2437
RS
1008(defun dired-next-dirline (arg &optional opoint)
1009 "Goto ARG'th next directory file line."
1010 (interactive "p")
1011 (or opoint (setq opoint (point)))
1012 (if (if (> arg 0)
1013 (re-search-forward dired-re-dir nil t arg)
1014 (beginning-of-line)
1015 (re-search-backward dired-re-dir nil t (- arg)))
1016 (dired-move-to-filename) ; user may type `i' or `f'
1017 (goto-char opoint)
1018 (error "No more subdirectories")))
1019
1020(defun dired-prev-dirline (arg)
1021 "Goto ARG'th previous directory file line."
1022 (interactive "p")
1023 (dired-next-dirline (- arg)))
1024
84fc2cfa 1025(defun dired-up-directory ()
492d2437
RS
1026 "Run dired on parent directory of current directory.
1027Find the parent directory either in this buffer or another buffer.
1028Creates a buffer if necessary."
84fc2cfa 1029 (interactive)
492d2437
RS
1030 (let* ((dir (dired-current-directory))
1031 (up (file-name-directory (directory-file-name dir))))
1032 (or (dired-goto-file (directory-file-name dir))
7b2469ae
RS
1033 ;; Only try dired-goto-subdir if buffer has more than one dir.
1034 (and (cdr dired-subdir-alist)
492d2437
RS
1035 (dired-goto-subdir up))
1036 (progn
8d23c16b
ER
1037 (dired
1038up)
492d2437 1039 (dired-goto-file dir)))))
84fc2cfa 1040
dbcb9389
RS
1041;; Force `f' rather than `e' in the mode doc:
1042(defalias 'dired-advertised-find-file 'dired-find-file)
84fc2cfa
ER
1043(defun dired-find-file ()
1044 "In dired, visit the file or directory named on this line."
1045 (interactive)
c3554e95 1046 (find-file (file-name-sans-versions (dired-get-filename) t)))
84fc2cfa 1047
dbcb9389
RS
1048(defun dired-mouse-find-file-other-window (event)
1049 "In dired, visit the file or directory name you click on."
1050 (interactive "e")
1051 (let (file)
1052 (save-excursion
1053 (set-buffer (window-buffer (posn-window (event-end event))))
1054 (save-excursion
1055 (goto-char (posn-point (event-end event)))
1056 (setq file (dired-get-filename))))
1057 (select-window (posn-window (event-end event)))
1058 (find-file-other-window (file-name-sans-versions file t))))
1059
84fc2cfa 1060(defun dired-view-file ()
492d2437
RS
1061 "In dired, examine a file in view mode, returning to dired when done.
1062When file is a directory, show it in this buffer if it is inserted;
1063otherwise, display it in another buffer."
84fc2cfa
ER
1064 (interactive)
1065 (if (file-directory-p (dired-get-filename))
7b2469ae
RS
1066 (or (and (cdr dired-subdir-alist)
1067 (dired-goto-subdir (dired-get-filename)))
492d2437 1068 (dired (dired-get-filename)))
715984d3 1069 (view-file (dired-get-filename))))
84fc2cfa
ER
1070
1071(defun dired-find-file-other-window ()
1072 "In dired, visit this file or directory in another window."
1073 (interactive)
c3554e95 1074 (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
ab67260b
RS
1075
1076(defun dired-display-file ()
1077 "In dired, display this file or directory in another window."
1078 (interactive)
c3554e95
RS
1079 (let ((file (file-name-sans-versions (dired-get-filename) t)))
1080 (display-buffer (find-file-noselect file))))
492d2437
RS
1081\f
1082;;; Functions for extracting and manipulating file names in dired buffers.
84fc2cfa
ER
1083
1084(defun dired-get-filename (&optional localp no-error-if-not-filep)
1085 "In dired, return name of file mentioned on this line.
1086Value returned normally includes the directory name.
492d2437
RS
1087Optional arg LOCALP with value `no-dir' means don't include directory
1088 name in result. A value of t means construct name relative to
1089 `default-directory', which still may contain slashes if in a subdirectory.
1090Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1091 this line, otherwise an error occurs."
1092 (let (case-fold-search file p1 p2)
84fc2cfa 1093 (save-excursion
492d2437
RS
1094 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1095 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1096 ;; nil if no file on this line, but no-error-if-not-filep is t:
1097 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1098 ;; Check if ls quoted the names, and unquote them.
1099 ;; Using read to unquote is much faster than substituting
1100 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1101 (cond ((string-match "b" dired-actual-switches) ; System V ls
1102 ;; This case is about 20% slower than without -b.
1103 (setq file
1104 (read
1105 (concat "\""
1106 ;; some ls -b don't escape quotes, argh!
1107 ;; This is not needed for GNU ls, though.
1108 (or (dired-string-replace-match
1109 "\\([^\\]\\)\"" file "\\1\\\\\"")
1110 file)
1111 "\""))))
1112 ;; If you do this, update dired-insert-subdir-validate too
1113 ;; ((string-match "Q" dired-actual-switches) ; GNU ls
1114 ;; (setq file (read file)))
1115 ))
1116 (if (eq localp 'no-dir)
1117 file
1118 (and file (concat (dired-current-directory localp) file)))))
1119
1120(defun dired-make-absolute (file &optional dir)
1121 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1122 ;; We can't always use expand-file-name as this would get rid of `.'
1123 ;; or expand in / instead default-directory if DIR=="".
1124 ;; This should be good enough for ange-ftp, but might easily be
1125 ;; redefined (for VMS?).
1126 ;; It should be reasonably fast, though, as it is called in
1127 ;; dired-get-filename.
1128 (concat (or dir default-directory) file))
1129
1130(defun dired-make-relative (file &optional dir no-error)
1131 ;;"Convert FILE (an absolute pathname) to a pathname relative to DIR.
1132 ;; Else error (unless NO-ERROR is non-nil, then FILE is returned unchanged)
1133 ;;DIR defaults to default-directory."
1134 ;; DIR must be file-name-as-directory, as with all directory args in
52041219 1135 ;; Emacs Lisp code.
492d2437 1136 (or dir (setq dir default-directory))
7425bbff
RS
1137 ;; This case comes into play if default-directory is set to
1138 ;; use ~.
1139 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1140 (setq dir (expand-file-name dir)))
492d2437
RS
1141 (if (string-match (concat "^" (regexp-quote dir)) file)
1142 (substring file (match-end 0))
1143 (if no-error
1144 file
1145 (error "%s: not in directory tree growing at %s" file dir))))
1146\f
1147;;; Functions for finding the file name in a dired buffer line.
1148
c4a7b2a4 1149(defvar dired-move-to-filename-regexp
d90490d8 1150 "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|Sep\\|Oct\\|Nov\\|Dec\\)[ ]+[0-9]+ [ 0-9][0-9][:0-9][0-9][ 0-9] "
c4a7b2a4
RS
1151 "Regular expression to match a month abbreviation followed by a number.")
1152
492d2437
RS
1153;; Move to first char of filename on this line.
1154;; Returns position (point) or nil if no filename on this line."
1155(defun dired-move-to-filename (&optional raise-error eol)
1156 ;; This is the UNIX version.
1157 (or eol (setq eol (progn (end-of-line) (point))))
1158 (beginning-of-line)
d90490d8
RS
1159 (if (re-search-forward dired-move-to-filename-regexp eol t)
1160 (goto-char (match-end 0))
1161 (if raise-error
1162 (error "No file on this line"))))
492d2437
RS
1163
1164(defun dired-move-to-end-of-filename (&optional no-error)
1165 ;; Assumes point is at beginning of filename,
1166 ;; thus the rwx bit re-search-backward below will succeed in *this*
1167 ;; line if at all. So, it should be called only after
1168 ;; (dired-move-to-filename t).
1169 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1170 ;; This is the UNIX version.
1171 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1172 ;; case-fold-search is nil now, so we can test for capital F:
1173 (setq used-F (string-match "F" dired-actual-switches)
1174 opoint (point)
1175 eol (save-excursion (end-of-line) (point))
1176 hidden (and selective-display
1177 (save-excursion (search-forward "\r" eol t))))
1178 (if hidden
1179 nil
1180 (save-excursion;; Find out what kind of file this is:
1181 ;; Restrict perm bits to be non-blank,
1182 ;; otherwise this matches one char to early (looking backward):
1183 ;; "l---------" (some systems make symlinks that way)
1184 ;; "----------" (plain file with zero perms)
1185 (if (re-search-backward
1186 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1187 nil t)
1188 (setq file-type (char-after (match-beginning 1))
1189 symlink (eq file-type ?l)
1190 ;; Only with -F we need to know whether it's an executable
1191 executable (and
1192 used-F
1193 (string-match
1194 "[xst]";; execute bit set anywhere?
1195 (concat
1196 (buffer-substring (match-beginning 2)
1197 (match-end 2))
1198 (buffer-substring (match-beginning 3)
1199 (match-end 3))
1200 (buffer-substring (match-beginning 4)
1201 (match-end 4))))))
1202 (or no-error (error "No file on this line"))))
1203 ;; Move point to end of name:
1204 (if symlink
1205 (if (search-forward " ->" eol t)
1206 (progn
1207 (forward-char -3)
1208 (and used-F
1209 dired-ls-F-marks-symlinks
1210 (eq (preceding-char) ?@);; did ls really mark the link?
1211 (forward-char -1))))
1212 (goto-char eol);; else not a symbolic link
1213 ;; ls -lF marks dirs, sockets and executables with exactly one
1214 ;; trailing character. (Executable bits on symlinks ain't mean
1215 ;; a thing, even to ls, but we know it's not a symlink.)
1216 (and used-F
1217 (or (memq file-type '(?d ?s))
1218 executable)
1219 (forward-char -1))))
1220 (or no-error
1221 (not (eq opoint (point)))
1222 (error (if hidden
1223 (substitute-command-keys
1224 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1225 "No file on this line")))
1226 (if (eq opoint (point))
1227 nil
1228 (point))))
1229
1230\f
1231;; Keeping Dired buffers in sync with the filesystem and with each other
1232
1233(defvar dired-buffers nil
1234 ;; Enlarged by dired-advertise
1235 ;; Queried by function dired-buffers-for-dir. When this detects a
1236 ;; killed buffer, it is removed from this list.
1237 "Alist of directories and their associated dired buffers.")
1238
1239(defun dired-buffers-for-dir (dir)
1240;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1241;; The list is in reverse order of buffer creation, most recent last.
1242;; As a side effect, killed dired buffers for DIR are removed from
1243;; dired-buffers.
1244 (setq dir (file-name-as-directory dir))
1245 (let ((alist dired-buffers) result elt)
1246 (while alist
1247 (setq elt (car alist))
1248 (if (dired-in-this-tree dir (car elt))
1249 (let ((buf (cdr elt)))
1250 (if (buffer-name buf)
1251 (if (assoc dir (save-excursion
1252 (set-buffer buf)
1253 dired-subdir-alist))
1254 (setq result (cons buf result)))
1255 ;; else buffer is killed - clean up:
1256 (setq dired-buffers (delq elt dired-buffers)))))
1257 (setq alist (cdr alist)))
1258 result))
1259
1260(defun dired-advertise ()
1261 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1262 ;; With wildcards we actually advertise too much.
1263 (if (memq (current-buffer) (dired-buffers-for-dir default-directory))
1264 t ; we have already advertised ourselves
1265 (setq dired-buffers
1266 (cons (cons default-directory (current-buffer))
1267 dired-buffers))))
1268
1269(defun dired-unadvertise (dir)
1270 ;; Remove DIR from the buffer alist in variable dired-buffers.
1271 ;; This has the effect of removing any buffer whose main directory is DIR.
1272 ;; It does not affect buffers in which DIR is a subdir.
1273 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1274 (setq dired-buffers
1275 (delq (assoc dir dired-buffers) dired-buffers)))
1276\f
1277;; Tree Dired
1278
1279;;; utility functions
1280
1281(defun dired-in-this-tree (file dir)
1282 ;;"Is FILE part of the directory tree starting at DIR?"
1283 (let (case-fold-search)
233993a3 1284 (string-match (concat "^" (regexp-quote (expand-file-name dir))) file)))
492d2437
RS
1285
1286(defun dired-normalize-subdir (dir)
1287 ;; Prepend default-directory to DIR if relative path name.
1288 ;; dired-get-filename must be able to make a valid filename from a
1289 ;; file and its directory DIR.
1290 (file-name-as-directory
1291 (if (file-name-absolute-p dir)
1292 dir
1293 (expand-file-name dir default-directory))))
1294
1295(defun dired-get-subdir ()
1296 ;;"Return the subdir name on this line, or nil if not on a headerline."
1297 ;; Look up in the alist whether this is a headerline.
1298 (save-excursion
1299 (let ((cur-dir (dired-current-directory)))
1300 (beginning-of-line) ; alist stores b-o-l positions
1301 (and (zerop (- (point)
1302 (dired-get-subdir-min (assoc cur-dir
1303 dired-subdir-alist))))
1304 cur-dir))))
1305
1306;(defun dired-get-subdir-min (elt)
1307; (cdr elt))
1308;; can't use macro, must be redefinable for other alist format in dired-nstd.
62f61df0 1309(defalias 'dired-get-subdir-min 'cdr)
492d2437
RS
1310
1311(defun dired-get-subdir-max (elt)
84fc2cfa 1312 (save-excursion
492d2437
RS
1313 (goto-char (dired-get-subdir-min elt))
1314 (dired-subdir-max)))
1315
1316(defun dired-clear-alist ()
1317 (while dired-subdir-alist
1318 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1319 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1320
c9d59fc2
RS
1321(defun dired-subdir-index (dir)
1322 ;; Return an index into alist for use with nth
1323 ;; for the sake of subdir moving commands.
1324 (let (found (index 0) (alist dired-subdir-alist))
1325 (while alist
1326 (if (string= dir (car (car alist)))
1327 (setq alist nil found t)
1328 (setq alist (cdr alist) index (1+ index))))
1329 (if found index nil)))
1330
1331(defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1332 "Go to next subdirectory, regardless of level."
1333 ;; Use 0 arg to go to this directory's header line.
1334 ;; NO-SKIP prevents moving to end of header line, returning whatever
1335 ;; position was found in dired-subdir-alist.
1336 (interactive "p")
1337 (let ((this-dir (dired-current-directory))
1338 pos index)
1339 ;; nth with negative arg does not return nil but the first element
1340 (setq index (- (dired-subdir-index this-dir) arg))
1341 (setq pos (if (>= index 0)
1342 (dired-get-subdir-min (nth index dired-subdir-alist))))
1343 (if pos
1344 (progn
1345 (goto-char pos)
1346 (or no-skip (skip-chars-forward "^\n\r"))
1347 (point))
1348 (if no-error-if-not-found
1349 nil ; return nil if not found
1350 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1351
492d2437
RS
1352(defun dired-build-subdir-alist ()
1353 "Build `dired-subdir-alist' by parsing the buffer.
1354Returns the new value of the alist."
1355 (interactive)
1356 (dired-clear-alist)
1357 (save-excursion
3222085e
BF
1358 (let ((count 0)
1359 (buffer-read-only nil)
1360 new-dir-name)
84fc2cfa 1361 (goto-char (point-min))
492d2437
RS
1362 (setq dired-subdir-alist nil)
1363 (while (re-search-forward dired-subdir-regexp nil t)
3222085e
BF
1364 (save-excursion
1365 (goto-char (match-beginning 1))
1366 (setq new-dir-name
1367 (expand-file-name (buffer-substring (point) (match-end 1))))
1368 (delete-region (point) (match-end 1))
1369 (insert new-dir-name))
492d2437 1370 (setq count (1+ count))
3222085e
BF
1371 (dired-alist-add-1 new-dir-name
1372 ;; Place a sub directory boundary between lines.
1373 (save-excursion
1374 (goto-char (match-beginning 0))
1375 (beginning-of-line)
1376 (point-marker))))
c9d59fc2
RS
1377 (if (> count 1)
1378 (message "Buffer includes %d directories" count))
492d2437
RS
1379 ;; We don't need to sort it because it is in buffer order per
1380 ;; constructionem. Return new alist:
1381 dired-subdir-alist)))
1382
1383(defun dired-alist-add-1 (dir new-marker)
1384 ;; Add new DIR at NEW-MARKER. Don't sort.
1385 (setq dired-subdir-alist
1386 (cons (cons (dired-normalize-subdir dir) new-marker)
1387 dired-subdir-alist)))
1388
1389(defun dired-goto-next-nontrivial-file ()
1390 ;; Position point on first nontrivial file after point.
1391 (dired-goto-next-file);; so there is a file to compare with
1392 (if (stringp dired-trivial-filenames)
1393 (while (and (not (eobp))
1394 (string-match dired-trivial-filenames
1395 (file-name-nondirectory
1396 (or (dired-get-filename nil t) ""))))
1397 (forward-line 1)
1398 (dired-move-to-filename))))
1399
1400(defun dired-goto-next-file ()
1401 (let ((max (1- (dired-subdir-max))))
1402 (while (and (not (dired-move-to-filename)) (< (point) max))
1403 (forward-line 1))))
1404
1405(defun dired-goto-file (file)
1406 "Go to file line of FILE in this dired buffer."
1407 ;; Return value of point on success, else nil.
1408 ;; FILE must be an absolute pathname.
1409 ;; Loses if FILE contains control chars like "\007" for which ls
1410 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1411 ;; it in the buffer.
1412 (interactive
1413 (prog1 ; let push-mark display its message
1414 (list (expand-file-name
1415 (read-file-name "Goto file: "
1416 (dired-current-directory))))
1417 (push-mark)))
1418 (setq file (directory-file-name file)) ; does no harm if no directory
1419 (let (found case-fold-search dir)
1420 (setq dir (or (file-name-directory file)
1421 (error "Need absolute pathname for %s" file)))
1422 (save-excursion
1423 ;; The hair here is to get the result of dired-goto-subdir
1424 ;; without really calling it if we don't have any subdirs.
233993a3 1425 (if (if (string= dir (expand-file-name default-directory))
492d2437 1426 (goto-char (point-min))
7b2469ae 1427 (and (cdr dired-subdir-alist)
492d2437
RS
1428 (dired-goto-subdir dir)))
1429 (let ((base (file-name-nondirectory file))
1430 (boundary (dired-subdir-max)))
1431 (while (and (not found)
1432 ;; filenames are preceded by SPC, this makes
1433 ;; the search faster (e.g. for the filename "-"!).
1434 (search-forward (concat " " base) boundary 'move))
1435 ;; Match could have BASE just as initial substring or
1436 ;; or in permission bits or date or
1437 ;; not be a proper filename at all:
1438 (if (equal base (dired-get-filename 'no-dir t))
1439 ;; Must move to filename since an (actually
1440 ;; correct) match could have been elsewhere on the
1441 ;; ;; line (e.g. "-" would match somewhere in the
1442 ;; permission bits).
55e86af6
RS
1443 (setq found (dired-move-to-filename))
1444 ;; If this isn't the right line, move forward to avoid
1445 ;; trying this line again.
1446 (forward-line 1))))))
492d2437
RS
1447 (and found
1448 ;; return value of point (i.e., FOUND):
1449 (goto-char found))))
1450
1451(defun dired-initial-position (dirname)
1452 ;; Where point should go in a new listing of DIRNAME.
1453 ;; Point assumed at beginning of new subdir line.
1454 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1455 (end-of-line)
1456 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1457\f
1458;; These are hooks which make tree dired work.
1459;; They are in this file because other parts of dired need to call them.
1460;; But they don't call the rest of tree dired unless there are subdirs loaded.
1461
1462;; This function is called for each retrieved filename.
1463;; It could stand to be faster, though it's mostly function call
1464;; overhead. Avoiding the function call seems to save about 10% in
1465;; dired-get-filename. Make it a defsubst?
1466(defun dired-current-directory (&optional localp)
1467 "Return the name of the subdirectory to which this line belongs.
1468This returns a string with trailing slash, like `default-directory'.
1469Optional argument means return a file name relative to `default-directory'."
1470 (let ((here (point))
1471 (alist (or dired-subdir-alist
1472 ;; probably because called in a non-dired buffer
1473 (error "No subdir-alist in %s" (current-buffer))))
1474 elt dir)
1475 (while alist
1476 (setq elt (car alist)
1477 dir (car elt)
1478 ;; use `<=' (not `<') as subdir line is part of subdir
1479 alist (if (<= (dired-get-subdir-min elt) here)
1480 nil ; found
1481 (cdr alist))))
1482 (if localp
1483 (dired-make-relative dir default-directory)
1484 dir)))
1485
1486;; Subdirs start at the beginning of their header lines and end just
1487;; before the beginning of the next header line (or end of buffer).
1488
1489(defun dired-subdir-max ()
1490 (save-excursion
7b2469ae 1491 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
492d2437
RS
1492 (point-max)
1493 (point))))
1494\f
1495;; Deleting files
1496
1497(defun dired-do-flagged-delete ()
1498 "In dired, delete the files flagged for deletion."
1499 (interactive)
1500 (let* ((dired-marker-char dired-del-marker)
1501 (regexp (dired-marker-regexp))
1502 case-fold-search)
1503 (if (save-excursion (goto-char (point-min))
1504 (re-search-forward regexp nil t))
1505 (dired-internal-do-deletions
1506 ;; this can't move point since ARG is nil
1507 (dired-map-over-marks (cons (dired-get-filename) (point))
1508 nil)
1509 nil)
1510 (message "(No deletions requested)"))))
1511
1512(defun dired-do-delete (&optional arg)
1513 "Delete all marked (or next ARG) files."
1514 ;; This is more consistent with the file marking feature than
1515 ;; dired-do-flagged-delete.
1516 (interactive "P")
1517 (dired-internal-do-deletions
1518 ;; this may move point if ARG is an integer
1519 (dired-map-over-marks (cons (dired-get-filename) (point))
1520 arg)
1521 arg))
1522
1523(defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
1524
1525(defun dired-internal-do-deletions (l arg)
1526 ;; L is an alist of files to delete, with their buffer positions.
1527 ;; ARG is the prefix arg.
1528 ;; Filenames are absolute (VMS needs this for logical search paths).
1529 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
1530 ;; That way as changes are made in the buffer they do not shift the
1531 ;; lines still to be changed, so the (point) values in L stay valid.
1532 ;; Also, for subdirs in natural order, a subdir's files are deleted
1533 ;; before the subdir itself - the other way around would not work.
1534 (let ((files (mapcar (function car) l))
1535 (count (length l))
1536 (succ 0))
1537 ;; canonicalize file list for pop up
1538 (setq files (nreverse (mapcar (function dired-make-relative) files)))
1539 (if (dired-mark-pop-up
1540 " *Deletions*" 'delete files dired-deletion-confirmer
1541 (format "Delete %s " (dired-mark-prompt arg files)))
84fc2cfa 1542 (save-excursion
492d2437
RS
1543 (let (failures);; files better be in reverse order for this loop!
1544 (while l
1545 (goto-char (cdr (car l)))
1546 (let (buffer-read-only)
1547 (condition-case err
1548 (let ((fn (car (car l))))
1549 ;; This test is equivalent to
1550 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1551 ;; but more efficient
1552 (if (eq t (car (file-attributes fn)))
ab67260b 1553 (delete-directory fn)
492d2437
RS
1554 (delete-file fn))
1555 ;; if we get here, removing worked
1556 (setq succ (1+ succ))
1557 (message "%s of %s deletions" succ count)
1558 (delete-region (progn (beginning-of-line) (point))
1559 (progn (forward-line 1) (point)))
1560 (dired-clean-up-after-deletion fn))
1561 (error;; catch errors from failed deletions
1562 (dired-log "%s\n" err)
1563 (setq failures (cons (car (car l)) failures)))))
1564 (setq l (cdr l)))
1565 (if (not failures)
1566 (message "%d deletion%s done" count (dired-plural-s count))
1567 (dired-log-summary
1568 (format "%d of %d deletion%s failed"
1569 (length failures) count
1570 (dired-plural-s count))
1571 failures))))
1572 (message "(No deletions performed)")))
1573 (dired-move-to-filename))
1574
1575;; This is a separate function for the sake of dired-x.el.
1576(defun dired-clean-up-after-deletion (fn)
1577 ;; Clean up after a deleted file or directory FN.
7b2469ae
RS
1578 (save-excursion (and (cdr dired-subdir-alist)
1579 (dired-goto-subdir fn)
492d2437
RS
1580 (dired-kill-subdir))))
1581\f
1582;; Confirmation
1583
1584(defun dired-marker-regexp ()
1585 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
1586
1587(defun dired-plural-s (count)
1588 (if (= 1 count) "" "s"))
1589
1590(defun dired-mark-prompt (arg files)
1591 ;; Return a string for use in a prompt, either the current file
1592 ;; name, or the marker and a count of marked files.
1593 (let ((count (length files)))
1594 (if (= count 1)
1595 (car files)
1596 ;; more than 1 file:
1597 (if (integerp arg)
1598 ;; abs(arg) = count
1599 ;; Perhaps this is nicer, but it also takes more screen space:
1600 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
1601 ;; count)
1602 (format "[next %d files]" arg)
1603 (format "%c [%d files]" dired-marker-char count)))))
1604
1605(defun dired-pop-to-buffer (buf)
1606 ;; Pop up buffer BUF.
1607 ;; If dired-shrink-to-fit is t, make its window fit its contents.
1608 (if (not dired-shrink-to-fit)
1609 (pop-to-buffer (get-buffer-create buf))
1610 ;; let window shrink to fit:
1611 (let ((window (selected-window))
1612 target-lines w2)
1613 (cond ;; if split-window-threshold is enabled, use the largest window
1614 ((and (> (window-height (setq w2 (get-largest-window)))
1615 split-height-threshold)
f98955ea 1616 (= (frame-width) (window-width w2)))
492d2437
RS
1617 (setq window w2))
1618 ;; if the least-recently-used window is big enough, use it
1619 ((and (> (window-height (setq w2 (get-lru-window)))
1620 (* 2 window-min-height))
f98955ea 1621 (= (frame-width) (window-width w2)))
492d2437
RS
1622 (setq window w2)))
1623 (save-excursion
1624 (set-buffer buf)
1625 (goto-char (point-max))
1626 (skip-chars-backward "\n\r\t ")
63ea14a5
RS
1627 (setq target-lines (count-lines (point-min) (point)))
1628 ;; Don't forget to count the last line.
1629 (if (not (bolp))
1630 (setq target-lines (1+ target-lines))))
492d2437 1631 (if (<= (window-height window) (* 2 window-min-height))
f98955ea 1632 ;; At this point, every window on the frame is too small to split.
492d2437
RS
1633 (setq w2 (display-buffer buf))
1634 (setq w2 (split-window window
1635 (max window-min-height
1636 (- (window-height window)
1637 (1+ (max window-min-height target-lines)))))))
1638 (set-window-buffer w2 buf)
1639 (if (< (1- (window-height w2)) target-lines)
1640 (progn
1641 (select-window w2)
1642 (enlarge-window (- target-lines (1- (window-height w2))))))
1643 (set-window-start w2 1)
1644 )))
1645
1646(defvar dired-no-confirm nil
1647;; "If non-nil, list of symbols for commands dired should not confirm.
1648;;It can be a sublist of
1649;;
1650;; '(byte-compile chgrp chmod chown compress copy delete hardlink load
1651;; move print shell symlink uncompress)"
1652 )
1653
1654(defun dired-mark-pop-up (bufname op-symbol files function &rest args)
1655 ;;"Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
1656 ;;Return FUNCTION's result on ARGS after popping up a window (in a buffer
1657 ;;named BUFNAME, nil gives \" *Marked Files*\") showing the marked
1658 ;;files. Uses function `dired-pop-to-buffer' to do that.
1659 ;; FUNCTION should not manipulate files.
1660 ;; It should only read input (an argument or confirmation).
1661 ;;The window is not shown if there is just one file or
1662 ;; OP-SYMBOL is a member of the list in `dired-no-confirm'.
1663 ;;FILES is the list of marked files."
1664 (or bufname (setq bufname " *Marked Files*"))
1665 (if (or (memq op-symbol dired-no-confirm)
1666 (= (length files) 1))
1667 (apply function args)
1668 (save-excursion
1669 (set-buffer (get-buffer-create bufname))
1670 (erase-buffer)
1671 (dired-format-columns-of-files files))
1672 (save-window-excursion
1673 (dired-pop-to-buffer bufname)
1674 (apply function args))))
1675
1676(defun dired-format-columns-of-files (files)
1677 ;; Files should be in forward order for this loop.
1678 ;; i.e., (car files) = first file in buffer.
1679 ;; Returns the number of lines used.
1680 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
1681 (width (- (window-width (selected-window)) 2))
1682 (columns (max 1 (/ width maxlen)))
1683 (nfiles (length files))
1684 (rows (+ (/ nfiles columns)
1685 (if (zerop (% nfiles columns)) 0 1)))
1686 (i 0)
1687 (j 0))
1688 (setq files (nconc (copy-sequence files) ; fill up with empty fns
1689 (make-list (- (* columns rows) nfiles) "")))
1690 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
1691 (while (< j rows)
1692 (while (< i columns)
1693 (indent-to (* i maxlen))
1694 (insert (car files))
1695 (setq files (nthcdr rows files)
1696 i (1+ i)))
1697 (insert "\n")
1698 (setq i 0
1699 j (1+ j)
1700 files (cdr files)))
1701 rows))
1702\f
1703;; Commands to mark or flag file(s) at or near current line.
1704
1705(defun dired-repeat-over-lines (arg function)
1706 ;; This version skips non-file lines.
cfe89c4f 1707 (let ((pos (make-marker)))
492d2437 1708 (beginning-of-line)
cfe89c4f
RS
1709 (while (and (> arg 0) (not (eobp)))
1710 (setq arg (1- arg))
1711 (beginning-of-line)
1712 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
1713 (save-excursion
1714 (forward-line 1)
1715 (move-marker pos (1+ (point))))
1716 (save-excursion (funcall function))
1717 ;; Advance to the next line--actually, to the line that *was* next.
1718 ;; (If FUNCTION inserted some new lines in between, skip them.)
1719 (goto-char pos))
1720 (while (and (< arg 0) (not (bobp)))
1721 (setq arg (1+ arg))
1722 (forward-line -1)
1723 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
1724 (beginning-of-line)
1725 (save-excursion (funcall function)))
1726 (move-marker pos nil)
1727 (dired-move-to-filename)))
492d2437
RS
1728
1729(defun dired-between-files ()
1730 ;; Point must be at beginning of line
1731 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
1732 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
1733 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard")
1734 (looking-at dired-subdir-regexp)))
1735
1736(defun dired-next-marked-file (arg &optional wrap opoint)
1737 "Move to the next marked file, wrapping around the end of the buffer."
1738 (interactive "p\np")
1739 (or opoint (setq opoint (point)));; return to where interactively started
1740 (if (if (> arg 0)
1741 (re-search-forward dired-re-mark nil t arg)
1742 (beginning-of-line)
1743 (re-search-backward dired-re-mark nil t (- arg)))
1744 (dired-move-to-filename)
1745 (if (null wrap)
1746 (progn
1747 (goto-char opoint)
1748 (error "No next marked file"))
1749 (message "(Wraparound for next marked file)")
1750 (goto-char (if (> arg 0) (point-min) (point-max)))
1751 (dired-next-marked-file arg nil opoint))))
1752
1753(defun dired-prev-marked-file (arg &optional wrap)
1754 "Move to the previous marked file, wrapping around the end of the buffer."
1755 (interactive "p\np")
1756 (dired-next-marked-file (- arg) wrap))
1757
1758(defun dired-file-marker (file)
1759 ;; Return FILE's marker, or nil if unmarked.
1760 (save-excursion
1761 (and (dired-goto-file file)
1762 (progn
1763 (beginning-of-line)
1764 (if (not (equal ?\040 (following-char)))
1765 (following-char))))))
1766
1767(defun dired-mark-files-in-region (start end)
1768 (let (buffer-read-only)
1769 (if (> start end)
1770 (error "start > end"))
1771 (goto-char start) ; assumed at beginning of line
1772 (while (< (point) end)
1773 ;; Skip subdir line and following garbage like the `total' line:
1774 (while (and (< (point) end) (dired-between-files))
1775 (forward-line 1))
1776 (if (and (not (looking-at dired-re-dot))
1777 (dired-get-filename nil t))
1778 (progn
1779 (delete-char 1)
1780 (insert dired-marker-char)))
1781 (forward-line 1))))
1782
1783(defun dired-mark (arg)
1784 "Mark the current (or next ARG) files.
1785If on a subdir headerline, mark all its files except `.' and `..'.
1786
1787Use \\[dired-unmark-all-files] to remove all marks
1788and \\[dired-unmark] on a subdir to remove the marks in
1789this subdir."
1790 (interactive "P")
7b2469ae 1791 (if (and (cdr dired-subdir-alist) (dired-get-subdir))
492d2437
RS
1792 (save-excursion (dired-mark-subdir-files))
1793 (let (buffer-read-only)
1794 (dired-repeat-over-lines
52041219 1795 (prefix-numeric-value arg)
492d2437
RS
1796 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
1797
1798(defun dired-unmark (arg)
1799 "Unmark the current (or next ARG) files.
1800If looking at a subdir, unmark all its files except `.' and `..'."
1801 (interactive "P")
1802 (let ((dired-marker-char ?\040))
1803 (dired-mark arg)))
1804
1805(defun dired-flag-file-deletion (arg)
1806 "In dired, flag the current line's file for deletion.
1807With prefix arg, repeat over several lines.
1808
1809If on a subdir headerline, mark all its files except `.' and `..'."
1810 (interactive "P")
1811 (let ((dired-marker-char dired-del-marker))
1812 (dired-mark arg)))
1813
1814(defun dired-unmark-backward (arg)
1815 "In dired, move up lines and remove deletion flag there.
1816Optional prefix ARG says how many lines to unflag; default is one line."
1817 (interactive "p")
1818 (dired-unmark (- arg)))
84fc2cfa 1819\f
492d2437
RS
1820;;; Commands to mark or flag files based on their characteristics or names.
1821
d2cadc4b
RS
1822(defvar dired-regexp-history nil
1823 "History list of regular expressions used in Dired commands.")
1824
1825(defun dired-read-regexp (prompt)
1826 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
492d2437
RS
1827
1828(defun dired-mark-files-regexp (regexp &optional marker-char)
1829 "Mark all files matching REGEXP for use in later commands.
1830A prefix argument means to unmark them instead.
1831`.' and `..' are never marked.
1832
1833REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
1834object files--just `.o' will mark more than you might think."
1835 (interactive
1836 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
1837 " files (regexp): "))
1838 (if current-prefix-arg ?\040)))
1839 (let ((dired-marker-char (or marker-char dired-marker-char)))
1840 (dired-mark-if
1841 (and (not (looking-at dired-re-dot))
1842 (not (eolp)) ; empty line
1843 (let ((fn (dired-get-filename nil t)))
1844 (and fn (string-match regexp (file-name-nondirectory fn)))))
1845 "matching file")))
1846
1847(defun dired-flag-files-regexp (regexp)
1848 "In dired, flag all files containing the specified REGEXP for deletion.
1849The match is against the non-directory part of the filename. Use `^'
1850 and `$' to anchor matches. Exclude subdirs by hiding them.
1851`.' and `..' are never flagged."
1852 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
1853 (dired-mark-files-regexp regexp dired-del-marker))
1854
1855(defun dired-mark-symlinks (unflag-p)
1856 "Mark all symbolic links.
1857With prefix argument, unflag all those files."
1858 (interactive "P")
1859 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
1860 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
1861
1862(defun dired-mark-directories (unflag-p)
1863 "Mark all directory file lines except `.' and `..'.
1864With prefix argument, unflag all those files."
1865 (interactive "P")
1866 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
1867 (dired-mark-if (and (looking-at dired-re-dir)
1868 (not (looking-at dired-re-dot)))
1869 "directory file")))
1870
1871(defun dired-mark-executables (unflag-p)
1872 "Mark all executable files.
1873With prefix argument, unflag all those files."
1874 (interactive "P")
1875 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
1876 (dired-mark-if (looking-at dired-re-exe) "executable file")))
1877
1878;; dired-x.el has a dired-mark-sexp interactive command: mark
1879;; files for which PREDICATE returns non-nil.
1880
1881(defun dired-flag-auto-save-files (&optional unflag-p)
84fc2cfa
ER
1882 "Flag for deletion files whose names suggest they are auto save files.
1883A prefix argument says to unflag those files instead."
1884 (interactive "P")
492d2437
RS
1885 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
1886 (dired-mark-if
2a838614 1887 ;; It is less than general to check for # here,
a91526b9
RS
1888 ;; but it's the only way this runs fast enough.
1889 (and (save-excursion (end-of-line)
536ae2dd
RS
1890 (or
1891 (eq (preceding-char) ?#)
1892 ;; Handle executables in case of -F option.
1893 ;; We need not worry about the other kinds
1894 ;; of markings that -F makes, since they won't
1895 ;; appear on real auto-save files.
1896 (if (eq (preceding-char) ?*)
1897 (progn
1898 (forward-char -1)
1899 (eq (preceding-char) ?#)))))
a91526b9
RS
1900 (not (looking-at dired-re-dir))
1901 (let ((fn (dired-get-filename t t)))
1902 (if fn (auto-save-file-name-p
1903 (file-name-nondirectory fn)))))
1904 "auto save file")))
492d2437
RS
1905
1906(defun dired-flag-backup-files (&optional unflag-p)
1907 "Flag all backup files (names ending with `~') for deletion.
1908With prefix argument, unflag these files."
1909 (interactive "P")
1910 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
1911 (dired-mark-if
a91526b9
RS
1912 ;; It is less than general to check for ~ here,
1913 ;; but it's the only way this runs fast enough.
1914 (and (save-excursion (end-of-line)
536ae2dd
RS
1915 (or
1916 (eq (preceding-char) ?~)
1917 ;; Handle executables in case of -F option.
1918 ;; We need not worry about the other kinds
1919 ;; of markings that -F makes, since they won't
1920 ;; appear on real backup files.
1921 (if (eq (preceding-char) ?*)
1922 (progn
1923 (forward-char -1)
1924 (eq (preceding-char) ?~)))))
a91526b9 1925 (not (looking-at dired-re-dir))
492d2437
RS
1926 (let ((fn (dired-get-filename t t)))
1927 (if fn (backup-file-name-p fn))))
1928 "backup file")))
1929
6482fcac
RS
1930(defun dired-change-marks (&optional old new)
1931 "Change all OLD marks to NEW marks.
1932OLD and NEW are both characters used to mark files."
1933 (interactive
1934 (let* ((cursor-in-echo-area t)
1935 (old (progn (message "Change (old mark): ") (read-char)))
1936 (new (progn (message "Change %c marks to (new mark): " old)
1937 (read-char))))
1938 (list old new)))
e4e02841
RS
1939 (if (or (eq old ?\r) (eq new ?\r))
1940 (ding)
1941 (let ((string (format "\n%c" old))
1942 (buffer-read-only))
1943 (save-excursion
1944 (goto-char (point-min))
1945 (while (search-forward string nil t)
1946 (subst-char-in-region (match-beginning 0)
1947 (match-end 0) old new))))))
6482fcac 1948
b1ecd9c6
RS
1949(defun dired-unmark-all-files-no-query ()
1950 "Remove all marks from all files in the Dired buffer."
1951 (interactive)
1952 (dired-unmark-all-files ?\r))
1953
8b87a301 1954(defun dired-unmark-all-files (mark &optional arg)
b602ba2f
RS
1955 "Remove a specific mark (or any mark) from every file.
1956After this command, type the mark character to remove,
1957or type RET to remove all marks.
3585916f 1958With prefix arg, query for each marked file.
492d2437 1959Type \\[help-command] at that time for help."
b602ba2f
RS
1960 (interactive "cRemove marks (RET means all): \nP")
1961 (save-excursion
1962 (let* ((count 0)
1963 buffer-read-only case-fold-search query
1964 (string (format "\n%c" mark))
1965 (help-form "\
8b87a301
RS
1966Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
1967`!' to unmark all remaining files with no more questions."))
b602ba2f
RS
1968 (goto-char (point-min))
1969 (while (if (eq mark ?\r)
1970 (re-search-forward dired-re-mark nil t)
1971 (search-forward string nil t))
1972 (if (or (not arg)
1973 (dired-query 'query "Unmark file `%s'? "
1974 (dired-get-filename t)))
1975 (progn (subst-char-in-region (1- (point)) (point)
1976 (preceding-char) ?\ )
1977 (setq count (1+ count)))))
1978 (message (if (= count 1) "1 mark removed"
1979 "%d marks removed")
1980 count))))
492d2437 1981\f
492d2437 1982;; Logging failures operating on files, and showing the results.
84fc2cfa 1983
492d2437 1984(defvar dired-log-buffer "*Dired log*")
84fc2cfa 1985
492d2437
RS
1986(defun dired-why ()
1987 "Pop up a buffer with error log output from Dired.
1988A group of errors from a single command ends with a formfeed.
1989Thus, use \\[backward-page] to find the beginning of a group of errors."
1990 (interactive)
1991 (if (get-buffer dired-log-buffer)
1992 (let ((owindow (selected-window))
1993 (window (display-buffer (get-buffer dired-log-buffer))))
1994 (unwind-protect
6482fcac 1995 (progn
492d2437
RS
1996 (select-window window)
1997 (goto-char (point-max))
1998 (recenter -1))
1999 (select-window owindow)))))
2000
2001(defun dired-log (log &rest args)
2002 ;; Log a message or the contents of a buffer.
2003 ;; If LOG is a string and there are more args, it is formatted with
2004 ;; those ARGS. Usually the LOG string ends with a \n.
2005 ;; End each bunch of errors with (dired-log t): this inserts
2006 ;; current time and buffer, and a \f (formfeed).
2007 (let ((obuf (current-buffer)))
2008 (unwind-protect ; want to move point
2009 (progn
2010 (set-buffer (get-buffer-create dired-log-buffer))
2011 (goto-char (point-max))
2012 (let (buffer-read-only)
2013 (cond ((stringp log)
2014 (insert (if args
2015 (apply (function format) log args)
2016 log)))
2017 ((bufferp log)
2018 (insert-buffer log))
2019 ((eq t log)
2020 (insert "\n\t" (current-time-string)
2021 "\tBuffer `" (buffer-name obuf) "'\n\f\n")))))
2022 (set-buffer obuf))))
2023
2024(defun dired-log-summary (string failures)
2025 (message (if failures "%s--type ? for details (%s)"
2026 "%s--type ? for details")
2027 string failures)
2028 ;; Log a summary describing a bunch of errors.
2029 (dired-log (concat "\n" string))
2030 (dired-log t))
2031\f
2032;;; Sorting
2033
2034;; Most ls can only sort by name or by date (with -t), nothing else.
2035;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2036;; So anything that does not contain these is sort "by name".
2037
2038(defvar dired-ls-sorting-switches "SXU"
2039 "String of `ls' switches (single letters) except `t' that influence sorting.")
2040
2041(defvar dired-sort-by-date-regexp
2042 (concat "^-[^" dired-ls-sorting-switches
2043 "]*t[^" dired-ls-sorting-switches "]*$")
2044 "Regexp recognized by dired to set `by date' mode.")
2045
2046(defvar dired-sort-by-name-regexp
2047 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2048 "Regexp recognized by dired to set `by name' mode.")
2049
492d2437
RS
2050(defun dired-sort-set-modeline ()
2051 ;; Set modeline display according to dired-actual-switches.
2052 ;; Modeline display of "by name" or "by date" guarantees the user a
2053 ;; match with the corresponding regexps. Non-matching switches are
2054 ;; shown literally.
1d673d85 2055 (setq mode-name
492d2437
RS
2056 (let (case-fold-search)
2057 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
1d673d85 2058 "Dired by name")
492d2437 2059 ((string-match dired-sort-by-date-regexp dired-actual-switches)
1d673d85 2060 "Dired by date")
492d2437 2061 (t
1d673d85 2062 (concat "Dired " dired-actual-switches)))))
492d2437
RS
2063 ;; update mode line:
2064 (set-buffer-modified-p (buffer-modified-p)))
2065
2066(defun dired-sort-toggle-or-edit (&optional arg)
2067 "Toggle between sort by date/name and refresh the dired buffer.
2068With a prefix argument you can edit the current listing switches instead."
84fc2cfa 2069 (interactive "P")
492d2437
RS
2070 (if arg
2071 (dired-sort-other
2072 (read-string "ls switches (must contain -l): " dired-actual-switches))
2073 (dired-sort-toggle)))
2074
2075(defun dired-sort-toggle ()
2076 ;; Toggle between sort by date/name. Reverts the buffer.
2077 (setq dired-actual-switches
2078 (let (case-fold-search)
2079 (concat
2080 "-l"
26add1bf 2081 (dired-replace-in-string (concat "[-lt"
492d2437
RS
2082 dired-ls-sorting-switches "]")
2083 ""
2084 dired-actual-switches)
2085 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2086 dired-actual-switches)
2087 ""
2088 "t"))))
2089 (dired-sort-set-modeline)
2090 (revert-buffer))
2091
2092(defun dired-replace-in-string (regexp newtext string)
2093 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2094 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2095 (let ((result "") (start 0) mb me)
2096 (while (string-match regexp string start)
2097 (setq mb (match-beginning 0)
2098 me (match-end 0)
2099 result (concat result (substring string start mb) newtext)
2100 start me))
2101 (concat result (substring string start))))
2102
2103(defun dired-sort-other (switches &optional no-revert)
2104 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2105 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2106 ;; minor mode accordingly, others appear literally in the mode line.
2107 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2108 (setq dired-actual-switches switches)
2109 (dired-sort-set-modeline)
2110 (or no-revert (revert-buffer)))
84fc2cfa 2111\f
492d2437
RS
2112;; To make this file smaller, the less common commands
2113;; go in a separate file. But autoload them here
2114;; to make the separation invisible.
2115
2116(autoload 'dired-diff "dired-aux"
2117 "Compare file at point with file FILE using `diff'.
2118FILE defaults to the file at the mark.
ab67260b 2119The prompted-for file is the first file given to `diff'."
492d2437
RS
2120 t)
2121
2122(autoload 'dired-backup-diff "dired-aux"
2123 "Diff this file with its backup file or vice versa.
2124Uses the latest backup, if there are several numerical backups.
2125If this file is a backup, diff it with its original.
ab67260b 2126The backup file is the first file given to `diff'."
492d2437
RS
2127 t)
2128
2d051399
RS
2129(autoload 'dired-clean-directory "dired-aux"
2130 "Flag numerical backups for deletion.
2131Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2132Positive prefix arg KEEP overrides `dired-kept-versions';
2133Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2134
2135To clear the flags on these files, you can use \\[dired-flag-backup-files]
2136with a prefix argument."
2137 t)
2138
492d2437
RS
2139(autoload 'dired-do-chmod "dired-aux"
2140 "Change the mode of the marked (or next ARG) files.
2141This calls chmod, thus symbolic modes like `g+w' are allowed."
2142 t)
2143
2144(autoload 'dired-do-chgrp "dired-aux"
2145 "Change the group of the marked (or next ARG) files."
2146 t)
2147
2148(autoload 'dired-do-chown "dired-aux"
2149 "Change the owner of the marked (or next ARG) files."
2150 t)
2151
2152(autoload 'dired-do-print "dired-aux"
2153 "Print the marked (or next ARG) files.
2154Uses the shell command coming from variables `lpr-command' and
2155`lpr-switches' as default."
2156 t)
2157
2158(autoload 'dired-do-shell-command "dired-aux"
6482fcac
RS
2159 "Run a shell command COMMAND on the marked files.
2160If no files are marked or a specific numeric prefix arg is given,
2161the next ARG files are used. Just \\[universal-argument] means the current file.
2162The prompt mentions the file(s) or the marker, as appropriate.
2163
492d2437 2164If there is output, it goes to a separate buffer.
6482fcac 2165
492d2437
RS
2166Normally the command is run on each file individually.
2167However, if there is a `*' in the command then it is run
2168just once with the entire file list substituted there.
2169
6482fcac
RS
2170No automatic redisplay of dired buffers is attempted, as there's no
2171telling what files the command may have changed. Type
2172\\[dired-do-redisplay] to redisplay the marked files.
492d2437
RS
2173
2174The shell command has the top level directory as working directory, so
2175output files usually are created there instead of in a subdir."
2176 t)
2177
492d2437
RS
2178(autoload 'dired-do-kill-lines "dired-aux"
2179 "Kill all marked lines (not the files).
2180With a prefix arg, kill all lines not marked or flagged."
2181 t)
2182
2183(autoload 'dired-do-compress "dired-aux"
2184 "Compress or uncompress marked (or next ARG) files."
2185 t)
2186
2187(autoload 'dired-do-byte-compile "dired-aux"
2188 "Byte compile marked (or next ARG) Emacs Lisp files."
2189 t)
2190
2191(autoload 'dired-do-load "dired-aux"
2192 "Load the marked (or next ARG) Emacs Lisp files."
2193 t)
2194
2195(autoload 'dired-do-redisplay "dired-aux"
2196 "Redisplay all marked (or next ARG) files.
2197If on a subdir line, redisplay that subdirectory. In that case,
2198a prefix arg lets you edit the `ls' switches used for the new listing."
2199 t)
2200
2201(autoload 'dired-string-replace-match "dired-aux"
2202 "Replace first match of REGEXP in STRING with NEWTEXT.
2203If it does not match, nil is returned instead of the new string.
2204Optional arg LITERAL means to take NEWTEXT literally.
2205Optional arg GLOBAL means to replace all matches."
2206 t)
2207
2208(autoload 'dired-create-directory "dired-aux"
84fc2cfa 2209 "Create a directory called DIRECTORY."
492d2437 2210 t)
84fc2cfa 2211
492d2437
RS
2212(autoload 'dired-do-copy "dired-aux"
2213 "Copy all marked (or next ARG) files, or copy the current file.
2214Thus, a zero prefix argument copies nothing. But it toggles the
2215variable `dired-copy-preserve-time' (which see)."
2216 t)
2217
2218(autoload 'dired-do-symlink "dired-aux"
2219 "Make symbolic links to current file or all marked (or next ARG) files.
2220When operating on just the current file, you specify the new name.
2221When operating on multiple or marked files, you specify a directory
2222and new symbolic links are made in that directory
2223with the same names that the files currently have."
2224 t)
2225
2226(autoload 'dired-do-hardlink "dired-aux"
2227 "Add names (hard links) current file or all marked (or next ARG) files.
2228When operating on just the current file, you specify the new name.
2229When operating on multiple or marked files, you specify a directory
2230and new hard links are made in that directory
2231with the same names that the files currently have."
2232 t)
2233
2234(autoload 'dired-do-rename "dired-aux"
2235 "Rename current file or all marked (or next ARG) files.
2236When renaming just the current file, you specify the new name.
2237When renaming multiple or marked files, you specify a directory."
2238 t)
2239
2240(autoload 'dired-do-rename-regexp "dired-aux"
2241 "Rename marked files containing REGEXP to NEWNAME.
2242As each match is found, the user must type a character saying
2243 what to do with it. For directions, type \\[help-command] at that time.
2244NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2245REGEXP defaults to the last regexp used.
2246With a zero prefix arg, renaming by regexp affects the complete
2247 pathname - usually only the non-directory part of file names is used
2248 and changed."
2249 t)
2250
2251(autoload 'dired-do-copy-regexp "dired-aux"
2252 "Copy all marked files containing REGEXP to NEWNAME.
2253See function `dired-rename-regexp' for more info."
2254 t)
2255
2256(autoload 'dired-do-hardlink-regexp "dired-aux"
2257 "Hardlink all marked files containing REGEXP to NEWNAME.
2258See function `dired-rename-regexp' for more info."
2259 t)
2260
2261(autoload 'dired-do-symlink-regexp "dired-aux"
2262 "Symlink all marked files containing REGEXP to NEWNAME.
2263See function `dired-rename-regexp' for more info."
2264 t)
2265
2266(autoload 'dired-upcase "dired-aux"
2267 "Rename all marked (or next ARG) files to upper case."
2268 t)
2269
2270(autoload 'dired-downcase "dired-aux"
2271 "Rename all marked (or next ARG) files to lower case."
2272 t)
2273
2274(autoload 'dired-maybe-insert-subdir "dired-aux"
2275 "Insert this subdirectory into the same dired buffer.
2276If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2277 else inserts it at its natural place (as `ls -lR' would have done).
2278With a prefix arg, you may edit the ls switches used for this listing.
2279 You can add `R' to the switches to expand the whole tree starting at
2280 this subdirectory.
2281This function takes some pains to conform to `ls -lR' output."
2282 t)
2283
2284(autoload 'dired-next-subdir "dired-aux"
2285 "Go to next subdirectory, regardless of level."
2286 t)
2287
2288(autoload 'dired-prev-subdir "dired-aux"
2289 "Go to previous subdirectory, regardless of level.
2290When called interactively and not on a subdir line, go to this subdir's line."
2291 t)
2292
2293(autoload 'dired-goto-subdir "dired-aux"
2294 "Go to end of header line of DIR in this dired buffer.
2295Return value of point on success, otherwise return nil.
2296The next char is either \\n, or \\r if DIR is hidden."
2297 t)
2298
2299(autoload 'dired-mark-subdir-files "dired-aux"
2300 "Mark all files except `.' and `..'."
2301 t)
2302
2303(autoload 'dired-kill-subdir "dired-aux"
2304 "Remove all lines of current subdirectory.
2305Lower levels are unaffected."
2306 t)
2307
2308(autoload 'dired-tree-up "dired-aux"
2309 "Go up ARG levels in the dired tree."
2310 t)
2311
2312(autoload 'dired-tree-down "dired-aux"
2313 "Go down in the dired tree."
2314 t)
2315
2316(autoload 'dired-hide-subdir "dired-aux"
2317 "Hide or unhide the current subdirectory and move to next directory.
2318Optional prefix arg is a repeat factor.
2319Use \\[dired-hide-all] to (un)hide all directories."
2320 t)
2321
2322(autoload 'dired-hide-all "dired-aux"
2323 "Hide all subdirectories, leaving only their header lines.
2324If there is already something hidden, make everything visible again.
2325Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2326 t)
84fc2cfa 2327\f
492d2437
RS
2328(if (eq system-type 'vax-vms)
2329 (load "dired-vms"))
84fc2cfa 2330
52041219
RS
2331(provide 'dired)
2332
57e15005
BF
2333(run-hooks 'dired-load-hook) ; for your customizations
2334
52041219 2335;;; dired.el ends here