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