Initial revision
[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)
6492483f
RS
601 ;; We used to specify the C locale here, to force English month names;
602 ;; but this should not be necessary any more,
603 ;; with the new value of dired-move-to-filename-regexp.
cb88a3db 604 (if (consp dir-or-list)
bc9c99bc
RS
605 ;; In this case, use the file names in the cdr
606 ;; exactly as originally given to dired-noselect.
607 (mapcar
608 (function (lambda (x) (insert-directory x switches wildcard full-p)))
609 (cdr dir-or-list))
610 ;; Expand the file name here because it may have been abbreviated
611 ;; in dired-noselect.
f150bd2b 612 (insert-directory (expand-file-name dir-or-list) switches wildcard full-p))
9888aa65 613 ;; Quote certain characters, unless ls quoted them for us.
ad632492
SM
614 (if (not (string-match "b" dired-actual-switches))
615 (save-excursion
616 (setq end (point-marker))
617 (goto-char opoint)
618 (while (search-forward "\\" end t)
619 (replace-match "\\\\" nil t))
620 (goto-char opoint)
621 (while (search-forward "\^m" end t)
622 (replace-match "\\015" nil t))
623 (set-marker end nil)))
cb88a3db 624 (dired-insert-set-properties opoint (point)))
8d23c16b 625 (setq dired-directory dir-or-list))
492d2437 626
9888aa65 627;; Make the file names highlight when the mouse is on them.
cb88a3db
RS
628(defun dired-insert-set-properties (beg end)
629 (save-excursion
630 (goto-char beg)
631 (while (< (point) end)
7da0e9b4
RS
632 (condition-case nil
633 (if (dired-move-to-filename)
634 (put-text-property (point)
635 (save-excursion
636 (dired-move-to-end-of-filename)
637 (point))
638 'mouse-face 'highlight))
639 (error nil))
cb88a3db
RS
640 (forward-line 1))))
641
492d2437
RS
642(defun dired-insert-headerline (dir);; also used by dired-insert-subdir
643 ;; Insert DIR's headerline with no trailing slash, exactly like ls
644 ;; would, and put cursor where dired-build-subdir-alist puts subdir
645 ;; boundaries.
646 (save-excursion (insert " " (directory-file-name dir) ":\n")))
647
648\f
649;; Reverting a dired buffer
650
84fc2cfa 651(defun dired-revert (&optional arg noconfirm)
492d2437
RS
652 ;; Reread the dired buffer. Must also be called after
653 ;; dired-actual-switches have changed.
654 ;; Should not fail even on completely garbaged buffers.
655 ;; Preserves old cursor, marks/flags, hidden-p.
656 (widen) ; just in case user narrowed
84fc2cfa 657 (let ((opoint (point))
492d2437
RS
658 (ofile (dired-get-filename nil t))
659 (mark-alist nil) ; save marked files
660 (hidden-subdirs (dired-remember-hidden))
661 (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
662 (case-fold-search nil) ; we check for upper case ls flags
663 buffer-read-only)
664 (goto-char (point-min))
665 (setq mark-alist;; only after dired-remember-hidden since this unhides:
666 (dired-remember-marks (point-min) (point-max)))
667 ;; treat top level dir extra (it may contain wildcards)
8d23c16b
ER
668 (dired-uncache
669 (if (consp dired-directory) (car dired-directory) dired-directory))
84fc2cfa 670 (dired-readin dired-directory (current-buffer))
492d2437
RS
671 (let ((dired-after-readin-hook nil))
672 ;; don't run that hook for each subdir...
673 (dired-insert-old-subdirs old-subdir-alist))
674 (dired-mark-remembered mark-alist) ; mark files that were marked
675 ;; ... run the hook for the whole buffer, and only after markers
676 ;; have been reinserted (else omitting in dired-x would omit marked files)
677 (run-hooks 'dired-after-readin-hook) ; no need to narrow
678 (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
679 (goto-char opoint)) ; was before
84fc2cfa 680 (dired-move-to-filename)
492d2437
RS
681 (save-excursion ; hide subdirs that were hidden
682 (mapcar (function (lambda (dir)
683 (if (dired-goto-subdir dir)
684 (dired-hide-subdir 1))))
685 hidden-subdirs)))
686 ;; outside of the let scope
687;;; Might as well not override the user if the user changed this.
688;;; (setq buffer-read-only t)
689 )
690
691;; Subroutines of dired-revert
692;; Some of these are also used when inserting subdirs.
693
694(defun dired-remember-marks (beg end)
695 ;; Return alist of files and their marks, from BEG to END.
696 (if selective-display ; must unhide to make this work.
697 (let (buffer-read-only)
698 (subst-char-in-region beg end ?\r ?\n)))
699 (let (fil chr alist)
700 (save-excursion
701 (goto-char beg)
702 (while (re-search-forward dired-re-mark end t)
703 (if (setq fil (dired-get-filename nil t))
704 (setq chr (preceding-char)
705 alist (cons (cons fil chr) alist)))))
706 alist))
707
708;; Mark all files remembered in ALIST.
709;; Each element of ALIST looks like (FILE . MARKERCHAR).
710(defun dired-mark-remembered (alist)
711 (let (elt fil chr)
712 (while alist
713 (setq elt (car alist)
714 alist (cdr alist)
715 fil (car elt)
716 chr (cdr elt))
717 (if (dired-goto-file fil)
718 (save-excursion
719 (beginning-of-line)
720 (delete-char 1)
721 (insert chr))))))
722
723;; Return a list of names of subdirs currently hidden.
724(defun dired-remember-hidden ()
725 (let ((l dired-subdir-alist) dir pos result)
726 (while l
727 (setq dir (car (car l))
728 pos (cdr (car l))
729 l (cdr l))
730 (goto-char pos)
731 (skip-chars-forward "^\r\n")
52041219 732 (if (eq (following-char) ?\r)
492d2437
RS
733 (setq result (cons dir result))))
734 result))
735
736;; Try to insert all subdirs that were displayed before,
737;; according to the former subdir alist OLD-SUBDIR-ALIST.
738(defun dired-insert-old-subdirs (old-subdir-alist)
739 (or (string-match "R" dired-actual-switches)
740 (let (elt dir)
741 (while old-subdir-alist
742 (setq elt (car old-subdir-alist)
743 old-subdir-alist (cdr old-subdir-alist)
744 dir (car elt))
745 (condition-case ()
715984d3
RS
746 (progn
747 (dired-uncache dir)
748 (dired-insert-subdir dir))
492d2437 749 (error nil))))))
715984d3
RS
750
751;; Remove directory DIR from any directory cache.
752(defun dired-uncache (dir)
6eaebaa2 753 (let ((handler (find-file-name-handler dir 'dired-uncache)))
715984d3
RS
754 (if handler
755 (funcall handler 'dired-uncache dir))))
492d2437
RS
756\f
757;; dired mode key bindings and initialization
84fc2cfa
ER
758
759(defvar dired-mode-map nil "Local keymap for dired-mode buffers.")
760(if dired-mode-map
761 nil
492d2437
RS
762 ;; This looks ugly when substitute-command-keys uses C-d instead d:
763 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
764
3e1fb00f
RS
765 (let ((map (make-keymap)))
766 (suppress-keymap map)
767 (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
768 ;; Commands to mark or flag certain categories of files
769 (define-key map "#" 'dired-flag-auto-save-files)
3e1fb00f 770 (define-key map "." 'dired-clean-directory)
3e1fb00f
RS
771 (define-key map "~" 'dired-flag-backup-files)
772 ;; Upper case keys (except !) for operating on the marked files
773 (define-key map "A" 'dired-do-search)
774 (define-key map "C" 'dired-do-copy)
775 (define-key map "B" 'dired-do-byte-compile)
776 (define-key map "D" 'dired-do-delete)
777 (define-key map "G" 'dired-do-chgrp)
778 (define-key map "H" 'dired-do-hardlink)
779 (define-key map "L" 'dired-do-load)
780 (define-key map "M" 'dired-do-chmod)
781 (define-key map "O" 'dired-do-chown)
782 (define-key map "P" 'dired-do-print)
783 (define-key map "Q" 'dired-do-query-replace)
784 (define-key map "R" 'dired-do-rename)
785 (define-key map "S" 'dired-do-symlink)
786 (define-key map "X" 'dired-do-shell-command)
787 (define-key map "Z" 'dired-do-compress)
788 (define-key map "!" 'dired-do-shell-command)
789 ;; Comparison commands
790 (define-key map "=" 'dired-diff)
791 (define-key map "\M-=" 'dired-backup-diff)
792 ;; Tree Dired commands
793 (define-key map "\M-\C-?" 'dired-unmark-all-files)
794 (define-key map "\M-\C-d" 'dired-tree-down)
795 (define-key map "\M-\C-u" 'dired-tree-up)
796 (define-key map "\M-\C-n" 'dired-next-subdir)
797 (define-key map "\M-\C-p" 'dired-prev-subdir)
798 ;; move to marked files
799 (define-key map "\M-{" 'dired-prev-marked-file)
800 (define-key map "\M-}" 'dired-next-marked-file)
801 ;; Make all regexp commands share a `%' prefix:
802 ;; We used to get to the submap via a symbol dired-regexp-prefix,
803 ;; but that seems to serve little purpose, and copy-keymap
804 ;; does a better job without it.
805 (define-key map "%" nil)
806 (define-key map "%u" 'dired-upcase)
807 (define-key map "%l" 'dired-downcase)
808 (define-key map "%d" 'dired-flag-files-regexp)
809 (define-key map "%m" 'dired-mark-files-regexp)
810 (define-key map "%r" 'dired-do-rename-regexp)
811 (define-key map "%C" 'dired-do-copy-regexp)
812 (define-key map "%H" 'dired-do-hardlink-regexp)
813 (define-key map "%R" 'dired-do-rename-regexp)
814 (define-key map "%S" 'dired-do-symlink-regexp)
4a3ca6ed
RS
815 ;; Commands for marking and unmarking.
816 (define-key map "*" nil)
817 (define-key map "**" 'dired-mark-executables)
818 (define-key map "*/" 'dired-mark-directories)
819 (define-key map "*@" 'dired-mark-symlinks)
820 (define-key map "*%" 'dired-mark-files-regexp)
821 (define-key map "*c" 'dired-change-marks)
0609c998 822 (define-key map "*s" 'dired-mark-subdir-files)
4a3ca6ed
RS
823 (define-key map "*m" 'dired-mark)
824 (define-key map "*u" 'dired-unmark)
825 (define-key map "*?" 'dired-unmark-all-files)
03059963 826 (define-key map "*!" 'dired-unmark-all-files-no-query)
4a3ca6ed
RS
827 (define-key map "*\177" 'dired-unmark-backward)
828 (define-key map "*\C-n" 'dired-next-marked-file)
829 (define-key map "*\C-p" 'dired-prev-marked-file)
3e1fb00f 830 ;; Lower keys for commands not operating on all the marked files
3e1fb00f
RS
831 (define-key map "d" 'dired-flag-file-deletion)
832 (define-key map "e" 'dired-find-file)
833 (define-key map "f" 'dired-find-file)
834 (define-key map "\C-m" 'dired-advertised-find-file)
835 (define-key map "g" 'revert-buffer)
836 (define-key map "h" 'describe-mode)
837 (define-key map "i" 'dired-maybe-insert-subdir)
838 (define-key map "k" 'dired-do-kill-lines)
839 (define-key map "l" 'dired-do-redisplay)
840 (define-key map "m" 'dired-mark)
841 (define-key map "n" 'dired-next-line)
842 (define-key map "o" 'dired-find-file-other-window)
843 (define-key map "\C-o" 'dired-display-file)
844 (define-key map "p" 'dired-previous-line)
845 (define-key map "q" 'dired-quit)
846 (define-key map "s" 'dired-sort-toggle-or-edit)
847 (define-key map "u" 'dired-unmark)
848 (define-key map "v" 'dired-view-file)
849 (define-key map "x" 'dired-do-flagged-delete)
850 (define-key map "+" 'dired-create-directory)
851 ;; moving
852 (define-key map "<" 'dired-prev-dirline)
853 (define-key map ">" 'dired-next-dirline)
854 (define-key map "^" 'dired-up-directory)
855 (define-key map " " 'dired-next-line)
856 (define-key map "\C-n" 'dired-next-line)
857 (define-key map "\C-p" 'dired-previous-line)
858 (define-key map [down] 'dired-next-line)
859 (define-key map [up] 'dired-previous-line)
860 ;; hiding
861 (define-key map "$" 'dired-hide-subdir)
862 (define-key map "\M-$" 'dired-hide-all)
863 ;; misc
864 (define-key map "?" 'dired-summary)
865 (define-key map "\177" 'dired-unmark-backward)
866 (define-key map "\C-_" 'dired-undo)
867 (define-key map "\C-xu" 'dired-undo)
868
869 ;; Make menu bar items.
870
871 ;; Get rid of the Edit menu bar item to save space.
872 (define-key map [menu-bar edit] 'undefined)
873
874 (define-key map [menu-bar subdir]
875 (cons "Subdir" (make-sparse-keymap "Subdir")))
876
877 (define-key map [menu-bar subdir hide-all]
878 '("Hide All" . dired-hide-all))
879 (define-key map [menu-bar subdir hide-subdir]
880 '("Hide Subdir" . dired-hide-subdir))
881 (define-key map [menu-bar subdir tree-down]
882 '("Tree Down" . dired-tree-down))
883 (define-key map [menu-bar subdir tree-up]
884 '("Tree Up" . dired-tree-up))
885 (define-key map [menu-bar subdir up]
886 '("Up Directory" . dired-up-directory))
887 (define-key map [menu-bar subdir prev-subdir]
888 '("Prev Subdir" . dired-prev-subdir))
889 (define-key map [menu-bar subdir next-subdir]
890 '("Next Subdir" . dired-next-subdir))
891 (define-key map [menu-bar subdir prev-dirline]
892 '("Prev Dirline" . dired-prev-dirline))
893 (define-key map [menu-bar subdir next-dirline]
894 '("Next Dirline" . dired-next-dirline))
895 (define-key map [menu-bar subdir insert]
896 '("Insert This Subdir" . dired-maybe-insert-subdir))
897
898 (define-key map [menu-bar immediate]
899 (cons "Immediate" (make-sparse-keymap "Immediate")))
900
a3285795
RS
901 (define-key map [menu-bar immediate revert-buffer]
902 '("Update Buffer" . revert-buffer))
903
904 (define-key map [menu-bar immediate dashes]
905 '("--"))
906
3e1fb00f
RS
907 (define-key map [menu-bar immediate backup-diff]
908 '("Compare with Backup" . dired-backup-diff))
909 (define-key map [menu-bar immediate diff]
910 '("Diff" . dired-diff))
911 (define-key map [menu-bar immediate view]
912 '("View This File" . dired-view-file))
913 (define-key map [menu-bar immediate display]
914 '("Display in Other Window" . dired-display-file))
915 (define-key map [menu-bar immediate find-file-other-window]
916 '("Find in Other Window" . dired-find-file-other-window))
917 (define-key map [menu-bar immediate find-file]
918 '("Find This File" . dired-find-file))
919 (define-key map [menu-bar immediate create-directory]
920 '("Create Directory..." . dired-create-directory))
921
922 (define-key map [menu-bar regexp]
923 (cons "Regexp" (make-sparse-keymap "Regexp")))
924
925 (define-key map [menu-bar regexp downcase]
926 '("Downcase" . dired-downcase))
927 (define-key map [menu-bar regexp upcase]
928 '("Upcase" . dired-upcase))
929 (define-key map [menu-bar regexp hardlink]
930 '("Hardlink..." . dired-do-hardlink-regexp))
931 (define-key map [menu-bar regexp symlink]
932 '("Symlink..." . dired-do-symlink-regexp))
933 (define-key map [menu-bar regexp rename]
934 '("Rename..." . dired-do-rename-regexp))
935 (define-key map [menu-bar regexp copy]
936 '("Copy..." . dired-do-copy-regexp))
937 (define-key map [menu-bar regexp flag]
938 '("Flag..." . dired-flag-files-regexp))
939 (define-key map [menu-bar regexp mark]
940 '("Mark..." . dired-mark-files-regexp))
941
942 (define-key map [menu-bar mark]
943 (cons "Mark" (make-sparse-keymap "Mark")))
944
945 (define-key map [menu-bar mark prev]
946 '("Previous Marked" . dired-prev-marked-file))
947 (define-key map [menu-bar mark next]
948 '("Next Marked" . dired-next-marked-file))
949 (define-key map [menu-bar mark marks]
950 '("Change Marks..." . dired-change-marks))
951 (define-key map [menu-bar mark unmark-all]
952 '("Unmark All" . dired-unmark-all-files-no-query))
953 (define-key map [menu-bar mark symlinks]
954 '("Mark Symlinks" . dired-mark-symlinks))
955 (define-key map [menu-bar mark directories]
956 '("Mark Directories" . dired-mark-directories))
957 (define-key map [menu-bar mark directory]
958 '("Mark Old Backups" . dired-clean-directory))
959 (define-key map [menu-bar mark executables]
960 '("Mark Executables" . dired-mark-executables))
961 (define-key map [menu-bar mark backup-files]
962 '("Flag Backup Files" . dired-flag-backup-files))
963 (define-key map [menu-bar mark auto-save-files]
964 '("Flag Auto-save Files" . dired-flag-auto-save-files))
965 (define-key map [menu-bar mark deletion]
966 '("Flag" . dired-flag-file-deletion))
967 (define-key map [menu-bar mark unmark]
968 '("Unmark" . dired-unmark))
969 (define-key map [menu-bar mark mark]
970 '("Mark" . dired-mark))
971
972 (define-key map [menu-bar operate]
973 (cons "Operate" (make-sparse-keymap "Operate")))
974
975 (define-key map [menu-bar operate query-replace]
976 '("Query Replace in Files..." . dired-do-query-replace))
977 (define-key map [menu-bar operate search]
978 '("Search Files..." . dired-do-search))
979 (define-key map [menu-bar operate chown]
980 '("Change Owner..." . dired-do-chown))
981 (define-key map [menu-bar operate chgrp]
982 '("Change Group..." . dired-do-chgrp))
983 (define-key map [menu-bar operate chmod]
984 '("Change Mode..." . dired-do-chmod))
985 (define-key map [menu-bar operate load]
986 '("Load" . dired-do-load))
987 (define-key map [menu-bar operate compile]
988 '("Byte-compile" . dired-do-byte-compile))
989 (define-key map [menu-bar operate compress]
990 '("Compress" . dired-do-compress))
991 (define-key map [menu-bar operate print]
992 '("Print" . dired-do-print))
993 (define-key map [menu-bar operate hardlink]
994 '("Hardlink to..." . dired-do-hardlink))
995 (define-key map [menu-bar operate symlink]
996 '("Symlink to..." . dired-do-symlink))
997 (define-key map [menu-bar operate command]
998 '("Shell Command..." . dired-do-shell-command))
999 (define-key map [menu-bar operate delete]
1000 '("Delete" . dired-do-delete))
1001 (define-key map [menu-bar operate rename]
1002 '("Rename to..." . dired-do-rename))
1003 (define-key map [menu-bar operate copy]
1004 '("Copy to..." . dired-do-copy))
1005
1006 (setq dired-mode-map map)))
fc53efda 1007\f
84fc2cfa
ER
1008;; Dired mode is suitable only for specially formatted data.
1009(put 'dired-mode 'mode-class 'special)
1010
492d2437
RS
1011(defun dired-mode (&optional dirname switches)
1012 "\
1013Mode for \"editing\" directory listings.
1014In dired, you are \"editing\" a list of the files in a directory and
1015 \(optionally) its subdirectories, in the format of `ls -lR'.
1016 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1017\"Editing\" means that you can run shell commands on files, visit,
1018 compress, load or byte-compile them, change their file attributes
1019 and insert subdirectories into the same buffer. You can \"mark\"
1020 files for later commands or \"flag\" them for deletion, either file
1021 by file or all files matching certain criteria.
1022You can move using the usual cursor motion commands.\\<dired-mode-map>
1023Letters no longer insert themselves. Digits are prefix arguments.
1024Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1025Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1026 Most commands operate on the marked files and use the current file
1027 if no files are marked. Use a numeric prefix argument to operate on
1028 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1029 to operate on the current file only. Prefix arguments override marks.
1030 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1031 to see why something went wrong.
1032Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1033Type \\[dired-unmark-backward] to back up one line and unflag.
1034Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1035Type \\[dired-advertised-find-file] to Find the current line's file
1036 (or dired it in another buffer, if it is a directory).
1037Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1038Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1039Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1040Type \\[dired-do-copy] to Copy files.
1041Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
1042Type \\[revert-buffer] to read all currently expanded directories again.
1043 This retains all marks and hides subdirs again that were hidden before.
1044SPC and DEL can be used to move down and up by lines.
1045
1046If dired ever gets confused, you can either type \\[revert-buffer] \
1047to read the
1048directories again, type \\[dired-do-redisplay] \
1049to relist a single or the marked files or a
1050subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1051again for the directory tree.
1052
1053Customization variables (rename this buffer and type \\[describe-variable] on each line
1054for more info):
1055
1056 dired-listing-switches
1057 dired-trivial-filenames
1058 dired-shrink-to-fit
1059 dired-marker-char
1060 dired-del-marker
1061 dired-keep-marker-rename
1062 dired-keep-marker-copy
1063 dired-keep-marker-hardlink
1064 dired-keep-marker-symlink
1065
1066Hooks (use \\[describe-variable] to see their documentation):
1067
1068 dired-before-readin-hook
1069 dired-after-readin-hook
1070 dired-mode-hook
1071 dired-load-hook
1072
1073Keybindings:
84fc2cfa 1074\\{dired-mode-map}"
492d2437
RS
1075 ;; Not to be called interactively (e.g. dired-directory will be set
1076 ;; to default-directory, which is wrong with wildcards).
84fc2cfa 1077 (kill-all-local-variables)
84fc2cfa 1078 (use-local-map dired-mode-map)
492d2437
RS
1079 (dired-advertise) ; default-directory is already set
1080 (setq major-mode 'dired-mode
1081 mode-name "Dired"
3222085e 1082;; case-fold-search nil
492d2437
RS
1083 buffer-read-only t
1084 selective-display t ; for subdirectory hiding
1085 mode-line-buffer-identification '("Dired: %17b"))
1086 (set (make-local-variable 'revert-buffer-function)
1087 (function dired-revert))
1088 (set (make-local-variable 'page-delimiter)
1089 "\n\n")
1090 (set (make-local-variable 'dired-directory)
1091 (or dirname default-directory))
1092 ;; list-buffers uses this to display the dir being edited in this buffer.
1093 (set (make-local-variable 'list-buffers-directory)
474ac5bb 1094 (expand-file-name dired-directory))
492d2437
RS
1095 (set (make-local-variable 'dired-actual-switches)
1096 (or switches dired-listing-switches))
4481ae96 1097 (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
492d2437 1098 (dired-sort-other dired-actual-switches t)
84fc2cfa
ER
1099 (run-hooks 'dired-mode-hook))
1100\f
eb8c3be9 1101;; Idiosyncratic dired commands that don't deal with marks.
84fc2cfa 1102
492d2437
RS
1103(defun dired-quit ()
1104 "Bury the current dired buffer."
1105 (interactive)
1106 (bury-buffer))
84fc2cfa
ER
1107
1108(defun dired-summary ()
492d2437 1109 "Summarize basic Dired commands and show recent Dired errors."
84fc2cfa 1110 (interactive)
492d2437 1111 (dired-why)
84fc2cfa
ER
1112 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1113 (message
50f74744 1114 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
84fc2cfa 1115
492d2437
RS
1116(defun dired-undo ()
1117 "Undo in a dired buffer.
1118This doesn't recover lost files, it just undoes changes in the buffer itself.
1119You can use it to recover marks, killed lines or subdirs.
1120In the latter case, you have to do \\[dired-build-subdir-alist] to
1121parse the buffer again."
1122 (interactive)
1123 (let (buffer-read-only)
1124 (undo)))
84fc2cfa
ER
1125
1126(defun dired-next-line (arg)
1127 "Move down lines then position at filename.
1128Optional prefix ARG says how many lines to move; default is one line."
1129 (interactive "p")
1130 (next-line arg)
1131 (dired-move-to-filename))
1132
1133(defun dired-previous-line (arg)
1134 "Move up lines then position at filename.
1135Optional prefix ARG says how many lines to move; default is one line."
1136 (interactive "p")
1137 (previous-line arg)
1138 (dired-move-to-filename))
1139
492d2437
RS
1140(defun dired-next-dirline (arg &optional opoint)
1141 "Goto ARG'th next directory file line."
1142 (interactive "p")
1143 (or opoint (setq opoint (point)))
1144 (if (if (> arg 0)
1145 (re-search-forward dired-re-dir nil t arg)
1146 (beginning-of-line)
1147 (re-search-backward dired-re-dir nil t (- arg)))
1148 (dired-move-to-filename) ; user may type `i' or `f'
1149 (goto-char opoint)
1150 (error "No more subdirectories")))
1151
1152(defun dired-prev-dirline (arg)
1153 "Goto ARG'th previous directory file line."
1154 (interactive "p")
1155 (dired-next-dirline (- arg)))
1156
ac1ce341 1157(defun dired-up-directory (&optional other-window)
492d2437
RS
1158 "Run dired on parent directory of current directory.
1159Find the parent directory either in this buffer or another buffer.
1160Creates a buffer if necessary."
ac1ce341 1161 (interactive "P")
492d2437
RS
1162 (let* ((dir (dired-current-directory))
1163 (up (file-name-directory (directory-file-name dir))))
1164 (or (dired-goto-file (directory-file-name dir))
7b2469ae
RS
1165 ;; Only try dired-goto-subdir if buffer has more than one dir.
1166 (and (cdr dired-subdir-alist)
492d2437
RS
1167 (dired-goto-subdir up))
1168 (progn
ac1ce341
EN
1169 (if other-window
1170 (dired-other-window up)
1171 (dired up))
492d2437 1172 (dired-goto-file dir)))))
84fc2cfa 1173
dbcb9389
RS
1174;; Force `f' rather than `e' in the mode doc:
1175(defalias 'dired-advertised-find-file 'dired-find-file)
84fc2cfa
ER
1176(defun dired-find-file ()
1177 "In dired, visit the file or directory named on this line."
1178 (interactive)
c439687b
RS
1179 (let ((file-name (file-name-sans-versions (dired-get-filename) t)))
1180 (if (file-exists-p file-name)
1181 (find-file file-name)
1182 (error "File no longer exists; type `g' to update Dired buffer"))))
84fc2cfa 1183
dbcb9389
RS
1184(defun dired-mouse-find-file-other-window (event)
1185 "In dired, visit the file or directory name you click on."
1186 (interactive "e")
1187 (let (file)
1188 (save-excursion
1189 (set-buffer (window-buffer (posn-window (event-end event))))
1190 (save-excursion
1191 (goto-char (posn-point (event-end event)))
1192 (setq file (dired-get-filename))))
1193 (select-window (posn-window (event-end event)))
1194 (find-file-other-window (file-name-sans-versions file t))))
1195
84fc2cfa 1196(defun dired-view-file ()
492d2437
RS
1197 "In dired, examine a file in view mode, returning to dired when done.
1198When file is a directory, show it in this buffer if it is inserted;
1199otherwise, display it in another buffer."
84fc2cfa
ER
1200 (interactive)
1201 (if (file-directory-p (dired-get-filename))
7b2469ae
RS
1202 (or (and (cdr dired-subdir-alist)
1203 (dired-goto-subdir (dired-get-filename)))
492d2437 1204 (dired (dired-get-filename)))
715984d3 1205 (view-file (dired-get-filename))))
84fc2cfa
ER
1206
1207(defun dired-find-file-other-window ()
1208 "In dired, visit this file or directory in another window."
1209 (interactive)
c3554e95 1210 (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
ab67260b
RS
1211
1212(defun dired-display-file ()
1213 "In dired, display this file or directory in another window."
1214 (interactive)
c3554e95
RS
1215 (let ((file (file-name-sans-versions (dired-get-filename) t)))
1216 (display-buffer (find-file-noselect file))))
492d2437
RS
1217\f
1218;;; Functions for extracting and manipulating file names in dired buffers.
84fc2cfa
ER
1219
1220(defun dired-get-filename (&optional localp no-error-if-not-filep)
1221 "In dired, return name of file mentioned on this line.
1222Value returned normally includes the directory name.
492d2437
RS
1223Optional arg LOCALP with value `no-dir' means don't include directory
1224 name in result. A value of t means construct name relative to
1225 `default-directory', which still may contain slashes if in a subdirectory.
1226Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1227 this line, otherwise an error occurs."
1228 (let (case-fold-search file p1 p2)
84fc2cfa 1229 (save-excursion
492d2437
RS
1230 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1231 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1232 ;; nil if no file on this line, but no-error-if-not-filep is t:
9888aa65
RS
1233 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1234 (progn
1235 ;; Get rid of the mouse-face property that file names have.
1236 (set-text-properties 0 (length file) nil file)
1237 ;; Unquote names quoted by ls or by dired-insert-directory.
1238 ;; Using read to unquote is much faster than substituting
1239 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1240 (setq file
1241 (read
1242 (concat "\""
1243 ;; some ls -b don't escape quotes, argh!
1244 ;; This is not needed for GNU ls, though.
1245 (or (dired-string-replace-match
bc07e5cb 1246 "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
9888aa65
RS
1247 file)
1248 "\"")))))
492d2437
RS
1249 (if (eq localp 'no-dir)
1250 file
1251 (and file (concat (dired-current-directory localp) file)))))
1252
437fe5ae
RS
1253(defun dired-string-replace-match (regexp string newtext
1254 &optional literal global)
1255 "Replace first match of REGEXP in STRING with NEWTEXT.
1256If it does not match, nil is returned instead of the new string.
1257Optional arg LITERAL means to take NEWTEXT literally.
1258Optional arg GLOBAL means to replace all matches."
1259 (if global
856321e2
RS
1260 (let ((start 0))
1261 (while (string-match regexp string start)
1262 (let ((from-end (- (length string) (match-end 0))))
1263 (setq string (replace-match newtext t literal string))
1264 (setq start (- (length string) from-end))))
1265 string)
437fe5ae
RS
1266 (if (not (string-match regexp string 0))
1267 nil
856321e2 1268 (replace-match newtext t literal string))))
437fe5ae 1269
492d2437
RS
1270(defun dired-make-absolute (file &optional dir)
1271 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1272 ;; We can't always use expand-file-name as this would get rid of `.'
1273 ;; or expand in / instead default-directory if DIR=="".
1274 ;; This should be good enough for ange-ftp, but might easily be
1275 ;; redefined (for VMS?).
1276 ;; It should be reasonably fast, though, as it is called in
1277 ;; dired-get-filename.
1278 (concat (or dir default-directory) file))
1279
1280(defun dired-make-relative (file &optional dir no-error)
23e217f6 1281 ;;"Convert FILE (an absolute file name) to a name relative to DIR.
492d2437
RS
1282 ;; Else error (unless NO-ERROR is non-nil, then FILE is returned unchanged)
1283 ;;DIR defaults to default-directory."
1284 ;; DIR must be file-name-as-directory, as with all directory args in
52041219 1285 ;; Emacs Lisp code.
492d2437 1286 (or dir (setq dir default-directory))
7425bbff
RS
1287 ;; This case comes into play if default-directory is set to
1288 ;; use ~.
1289 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1290 (setq dir (expand-file-name dir)))
492d2437
RS
1291 (if (string-match (concat "^" (regexp-quote dir)) file)
1292 (substring file (match-end 0))
1293 (if no-error
1294 file
1295 (error "%s: not in directory tree growing at %s" file dir))))
1296\f
1297;;; Functions for finding the file name in a dired buffer line.
1298
c4a7b2a4 1299(defvar dired-move-to-filename-regexp
f3636ea7
RS
1300 " [A-Za-z\xa0-\xff][A-Za-z\xa0-\xff][A-Za-z\xa0-\xff] [0-3 ][0-9]\
1301 [ 0-9][0-9][:0-9][0-9][ 0-9] "
1302 "Regular expression to match a month abbreviation followed date/time.")
9eabb7d5 1303
23e217f6
RS
1304(defvar dired-permission-flags-regexp
1305 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1306 "Regular expression to match the permission flags in `ls -l'.")
1307
492d2437
RS
1308;; Move to first char of filename on this line.
1309;; Returns position (point) or nil if no filename on this line."
1310(defun dired-move-to-filename (&optional raise-error eol)
1311 ;; This is the UNIX version.
1312 (or eol (setq eol (progn (end-of-line) (point))))
1313 (beginning-of-line)
d90490d8
RS
1314 (if (re-search-forward dired-move-to-filename-regexp eol t)
1315 (goto-char (match-end 0))
1316 (if raise-error
1317 (error "No file on this line"))))
492d2437
RS
1318
1319(defun dired-move-to-end-of-filename (&optional no-error)
1320 ;; Assumes point is at beginning of filename,
1321 ;; thus the rwx bit re-search-backward below will succeed in *this*
1322 ;; line if at all. So, it should be called only after
1323 ;; (dired-move-to-filename t).
1324 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1325 ;; This is the UNIX version.
1326 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1327 ;; case-fold-search is nil now, so we can test for capital F:
1328 (setq used-F (string-match "F" dired-actual-switches)
1329 opoint (point)
1330 eol (save-excursion (end-of-line) (point))
1331 hidden (and selective-display
1332 (save-excursion (search-forward "\r" eol t))))
1333 (if hidden
1334 nil
1335 (save-excursion;; Find out what kind of file this is:
1336 ;; Restrict perm bits to be non-blank,
1337 ;; otherwise this matches one char to early (looking backward):
1338 ;; "l---------" (some systems make symlinks that way)
1339 ;; "----------" (plain file with zero perms)
1340 (if (re-search-backward
23e217f6 1341 dired-permission-flags-regexp nil t)
492d2437
RS
1342 (setq file-type (char-after (match-beginning 1))
1343 symlink (eq file-type ?l)
1344 ;; Only with -F we need to know whether it's an executable
1345 executable (and
1346 used-F
1347 (string-match
1348 "[xst]";; execute bit set anywhere?
1349 (concat
1350 (buffer-substring (match-beginning 2)
1351 (match-end 2))
1352 (buffer-substring (match-beginning 3)
1353 (match-end 3))
1354 (buffer-substring (match-beginning 4)
1355 (match-end 4))))))
1356 (or no-error (error "No file on this line"))))
1357 ;; Move point to end of name:
1358 (if symlink
1359 (if (search-forward " ->" eol t)
1360 (progn
1361 (forward-char -3)
1362 (and used-F
1363 dired-ls-F-marks-symlinks
1364 (eq (preceding-char) ?@);; did ls really mark the link?
1365 (forward-char -1))))
1366 (goto-char eol);; else not a symbolic link
1367 ;; ls -lF marks dirs, sockets and executables with exactly one
1368 ;; trailing character. (Executable bits on symlinks ain't mean
1369 ;; a thing, even to ls, but we know it's not a symlink.)
1370 (and used-F
1371 (or (memq file-type '(?d ?s))
1372 executable)
1373 (forward-char -1))))
1374 (or no-error
1375 (not (eq opoint (point)))
1376 (error (if hidden
1377 (substitute-command-keys
1378 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1379 "No file on this line")))
1380 (if (eq opoint (point))
1381 nil
1382 (point))))
1383
1384\f
1385;; Keeping Dired buffers in sync with the filesystem and with each other
1386
1387(defvar dired-buffers nil
1388 ;; Enlarged by dired-advertise
1389 ;; Queried by function dired-buffers-for-dir. When this detects a
1390 ;; killed buffer, it is removed from this list.
38819778 1391 "Alist of expanded directories and their associated dired buffers.")
492d2437
RS
1392
1393(defun dired-buffers-for-dir (dir)
1394;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1395;; The list is in reverse order of buffer creation, most recent last.
1396;; As a side effect, killed dired buffers for DIR are removed from
1397;; dired-buffers.
1398 (setq dir (file-name-as-directory dir))
38819778 1399 (let ((alist dired-buffers) result elt buf)
492d2437 1400 (while alist
38819778
RS
1401 (setq elt (car alist)
1402 buf (cdr elt))
1403 (if (buffer-name buf)
1404 (if (dired-in-this-tree dir (car elt))
1405 (if (assoc dir (save-excursion
1406 (set-buffer buf)
1407 dired-subdir-alist))
1408 (setq result (cons buf result))))
1409 ;; else buffer is killed - clean up:
1410 (setq dired-buffers (delq elt dired-buffers)))
492d2437
RS
1411 (setq alist (cdr alist)))
1412 result))
1413
1414(defun dired-advertise ()
1415 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1416 ;; With wildcards we actually advertise too much.
38819778
RS
1417 (let ((expanded-default (expand-file-name default-directory)))
1418 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1419 t ; we have already advertised ourselves
1420 (setq dired-buffers
1421 (cons (cons expanded-default (current-buffer))
1422 dired-buffers)))))
492d2437
RS
1423
1424(defun dired-unadvertise (dir)
1425 ;; Remove DIR from the buffer alist in variable dired-buffers.
1426 ;; This has the effect of removing any buffer whose main directory is DIR.
1427 ;; It does not affect buffers in which DIR is a subdir.
1428 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1429 (setq dired-buffers
38819778 1430 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
492d2437
RS
1431\f
1432;; Tree Dired
1433
1434;;; utility functions
1435
1436(defun dired-in-this-tree (file dir)
1437 ;;"Is FILE part of the directory tree starting at DIR?"
1438 (let (case-fold-search)
38819778 1439 (string-match (concat "^" (regexp-quote dir)) file)))
492d2437
RS
1440
1441(defun dired-normalize-subdir (dir)
1442 ;; Prepend default-directory to DIR if relative path name.
1443 ;; dired-get-filename must be able to make a valid filename from a
1444 ;; file and its directory DIR.
1445 (file-name-as-directory
1446 (if (file-name-absolute-p dir)
1447 dir
1448 (expand-file-name dir default-directory))))
1449
1450(defun dired-get-subdir ()
1451 ;;"Return the subdir name on this line, or nil if not on a headerline."
1452 ;; Look up in the alist whether this is a headerline.
1453 (save-excursion
1454 (let ((cur-dir (dired-current-directory)))
1455 (beginning-of-line) ; alist stores b-o-l positions
1456 (and (zerop (- (point)
1457 (dired-get-subdir-min (assoc cur-dir
1458 dired-subdir-alist))))
1459 cur-dir))))
1460
1461;(defun dired-get-subdir-min (elt)
1462; (cdr elt))
1463;; can't use macro, must be redefinable for other alist format in dired-nstd.
62f61df0 1464(defalias 'dired-get-subdir-min 'cdr)
492d2437
RS
1465
1466(defun dired-get-subdir-max (elt)
84fc2cfa 1467 (save-excursion
492d2437
RS
1468 (goto-char (dired-get-subdir-min elt))
1469 (dired-subdir-max)))
1470
1471(defun dired-clear-alist ()
1472 (while dired-subdir-alist
1473 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1474 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1475
c9d59fc2
RS
1476(defun dired-subdir-index (dir)
1477 ;; Return an index into alist for use with nth
1478 ;; for the sake of subdir moving commands.
1479 (let (found (index 0) (alist dired-subdir-alist))
1480 (while alist
1481 (if (string= dir (car (car alist)))
1482 (setq alist nil found t)
1483 (setq alist (cdr alist) index (1+ index))))
1484 (if found index nil)))
1485
1486(defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1487 "Go to next subdirectory, regardless of level."
1488 ;; Use 0 arg to go to this directory's header line.
1489 ;; NO-SKIP prevents moving to end of header line, returning whatever
1490 ;; position was found in dired-subdir-alist.
1491 (interactive "p")
1492 (let ((this-dir (dired-current-directory))
1493 pos index)
1494 ;; nth with negative arg does not return nil but the first element
1495 (setq index (- (dired-subdir-index this-dir) arg))
1496 (setq pos (if (>= index 0)
1497 (dired-get-subdir-min (nth index dired-subdir-alist))))
1498 (if pos
1499 (progn
1500 (goto-char pos)
1501 (or no-skip (skip-chars-forward "^\n\r"))
1502 (point))
1503 (if no-error-if-not-found
1504 nil ; return nil if not found
1505 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1506
492d2437
RS
1507(defun dired-build-subdir-alist ()
1508 "Build `dired-subdir-alist' by parsing the buffer.
1509Returns the new value of the alist."
1510 (interactive)
1511 (dired-clear-alist)
1512 (save-excursion
3222085e
BF
1513 (let ((count 0)
1514 (buffer-read-only nil)
1515 new-dir-name)
84fc2cfa 1516 (goto-char (point-min))
492d2437 1517 (setq dired-subdir-alist nil)
acf310c9
RS
1518 (while (and (re-search-forward dired-subdir-regexp nil t)
1519 ;; Avoid taking a file name ending in a colon
1520 ;; as a subdir name.
1521 (not (save-excursion
1522 (goto-char (match-beginning 0))
1523 (beginning-of-line)
1524 (forward-char 2)
46680faf 1525 (save-match-data (looking-at dired-re-perms)))))
3222085e
BF
1526 (save-excursion
1527 (goto-char (match-beginning 1))
1528 (setq new-dir-name
1529 (expand-file-name (buffer-substring (point) (match-end 1))))
1530 (delete-region (point) (match-end 1))
1531 (insert new-dir-name))
492d2437 1532 (setq count (1+ count))
3222085e
BF
1533 (dired-alist-add-1 new-dir-name
1534 ;; Place a sub directory boundary between lines.
1535 (save-excursion
1536 (goto-char (match-beginning 0))
1537 (beginning-of-line)
1538 (point-marker))))
c9d59fc2
RS
1539 (if (> count 1)
1540 (message "Buffer includes %d directories" count))
492d2437
RS
1541 ;; We don't need to sort it because it is in buffer order per
1542 ;; constructionem. Return new alist:
1543 dired-subdir-alist)))
1544
1545(defun dired-alist-add-1 (dir new-marker)
1546 ;; Add new DIR at NEW-MARKER. Don't sort.
1547 (setq dired-subdir-alist
1548 (cons (cons (dired-normalize-subdir dir) new-marker)
1549 dired-subdir-alist)))
1550
1551(defun dired-goto-next-nontrivial-file ()
1552 ;; Position point on first nontrivial file after point.
1553 (dired-goto-next-file);; so there is a file to compare with
1554 (if (stringp dired-trivial-filenames)
1555 (while (and (not (eobp))
1556 (string-match dired-trivial-filenames
1557 (file-name-nondirectory
1558 (or (dired-get-filename nil t) ""))))
1559 (forward-line 1)
1560 (dired-move-to-filename))))
1561
1562(defun dired-goto-next-file ()
1563 (let ((max (1- (dired-subdir-max))))
1564 (while (and (not (dired-move-to-filename)) (< (point) max))
1565 (forward-line 1))))
1566
1567(defun dired-goto-file (file)
1568 "Go to file line of FILE in this dired buffer."
1569 ;; Return value of point on success, else nil.
1570 ;; FILE must be an absolute pathname.
1571 ;; Loses if FILE contains control chars like "\007" for which ls
1572 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1573 ;; it in the buffer.
1574 (interactive
1575 (prog1 ; let push-mark display its message
1576 (list (expand-file-name
1577 (read-file-name "Goto file: "
1578 (dired-current-directory))))
1579 (push-mark)))
1580 (setq file (directory-file-name file)) ; does no harm if no directory
1581 (let (found case-fold-search dir)
1582 (setq dir (or (file-name-directory file)
1583 (error "Need absolute pathname for %s" file)))
1584 (save-excursion
1585 ;; The hair here is to get the result of dired-goto-subdir
1586 ;; without really calling it if we don't have any subdirs.
233993a3 1587 (if (if (string= dir (expand-file-name default-directory))
492d2437 1588 (goto-char (point-min))
7b2469ae 1589 (and (cdr dired-subdir-alist)
492d2437
RS
1590 (dired-goto-subdir dir)))
1591 (let ((base (file-name-nondirectory file))
1592 (boundary (dired-subdir-max)))
1593 (while (and (not found)
1594 ;; filenames are preceded by SPC, this makes
1595 ;; the search faster (e.g. for the filename "-"!).
1596 (search-forward (concat " " base) boundary 'move))
1597 ;; Match could have BASE just as initial substring or
1598 ;; or in permission bits or date or
1599 ;; not be a proper filename at all:
1600 (if (equal base (dired-get-filename 'no-dir t))
1601 ;; Must move to filename since an (actually
1602 ;; correct) match could have been elsewhere on the
1603 ;; ;; line (e.g. "-" would match somewhere in the
1604 ;; permission bits).
55e86af6
RS
1605 (setq found (dired-move-to-filename))
1606 ;; If this isn't the right line, move forward to avoid
1607 ;; trying this line again.
1608 (forward-line 1))))))
492d2437
RS
1609 (and found
1610 ;; return value of point (i.e., FOUND):
1611 (goto-char found))))
1612
1613(defun dired-initial-position (dirname)
1614 ;; Where point should go in a new listing of DIRNAME.
1615 ;; Point assumed at beginning of new subdir line.
1616 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1617 (end-of-line)
1618 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1619\f
1620;; These are hooks which make tree dired work.
1621;; They are in this file because other parts of dired need to call them.
1622;; But they don't call the rest of tree dired unless there are subdirs loaded.
1623
1624;; This function is called for each retrieved filename.
1625;; It could stand to be faster, though it's mostly function call
1626;; overhead. Avoiding the function call seems to save about 10% in
1627;; dired-get-filename. Make it a defsubst?
1628(defun dired-current-directory (&optional localp)
1629 "Return the name of the subdirectory to which this line belongs.
1630This returns a string with trailing slash, like `default-directory'.
1631Optional argument means return a file name relative to `default-directory'."
1632 (let ((here (point))
1633 (alist (or dired-subdir-alist
1634 ;; probably because called in a non-dired buffer
1635 (error "No subdir-alist in %s" (current-buffer))))
1636 elt dir)
1637 (while alist
1638 (setq elt (car alist)
1639 dir (car elt)
1640 ;; use `<=' (not `<') as subdir line is part of subdir
1641 alist (if (<= (dired-get-subdir-min elt) here)
1642 nil ; found
1643 (cdr alist))))
1644 (if localp
1645 (dired-make-relative dir default-directory)
1646 dir)))
1647
1648;; Subdirs start at the beginning of their header lines and end just
1649;; before the beginning of the next header line (or end of buffer).
1650
1651(defun dired-subdir-max ()
1652 (save-excursion
7b2469ae 1653 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
492d2437
RS
1654 (point-max)
1655 (point))))
1656\f
1657;; Deleting files
1658
7da0e9b4
RS
1659(defun dired-do-flagged-delete (&optional nomessage)
1660 "In dired, delete the files flagged for deletion.
1661If NOMESSAGE is non-nil, we don't display any message
1662if there are no flagged files."
492d2437
RS
1663 (interactive)
1664 (let* ((dired-marker-char dired-del-marker)
1665 (regexp (dired-marker-regexp))
1666 case-fold-search)
1667 (if (save-excursion (goto-char (point-min))
1668 (re-search-forward regexp nil t))
1669 (dired-internal-do-deletions
1670 ;; this can't move point since ARG is nil
1671 (dired-map-over-marks (cons (dired-get-filename) (point))
1672 nil)
1673 nil)
7da0e9b4
RS
1674 (or nomessage
1675 (message "(No deletions requested)")))))
492d2437
RS
1676
1677(defun dired-do-delete (&optional arg)
1678 "Delete all marked (or next ARG) files."
1679 ;; This is more consistent with the file marking feature than
1680 ;; dired-do-flagged-delete.
1681 (interactive "P")
1682 (dired-internal-do-deletions
1683 ;; this may move point if ARG is an integer
1684 (dired-map-over-marks (cons (dired-get-filename) (point))
1685 arg)
1686 arg))
1687
1688(defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
1689
1690(defun dired-internal-do-deletions (l arg)
1691 ;; L is an alist of files to delete, with their buffer positions.
1692 ;; ARG is the prefix arg.
1693 ;; Filenames are absolute (VMS needs this for logical search paths).
1694 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
1695 ;; That way as changes are made in the buffer they do not shift the
1696 ;; lines still to be changed, so the (point) values in L stay valid.
1697 ;; Also, for subdirs in natural order, a subdir's files are deleted
1698 ;; before the subdir itself - the other way around would not work.
1699 (let ((files (mapcar (function car) l))
1700 (count (length l))
1701 (succ 0))
1702 ;; canonicalize file list for pop up
1703 (setq files (nreverse (mapcar (function dired-make-relative) files)))
1704 (if (dired-mark-pop-up
1705 " *Deletions*" 'delete files dired-deletion-confirmer
1706 (format "Delete %s " (dired-mark-prompt arg files)))
84fc2cfa 1707 (save-excursion
492d2437
RS
1708 (let (failures);; files better be in reverse order for this loop!
1709 (while l
1710 (goto-char (cdr (car l)))
1711 (let (buffer-read-only)
1712 (condition-case err
1713 (let ((fn (car (car l))))
1714 ;; This test is equivalent to
1715 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1716 ;; but more efficient
1717 (if (eq t (car (file-attributes fn)))
ab67260b 1718 (delete-directory fn)
492d2437
RS
1719 (delete-file fn))
1720 ;; if we get here, removing worked
1721 (setq succ (1+ succ))
1722 (message "%s of %s deletions" succ count)
1723 (delete-region (progn (beginning-of-line) (point))
1724 (progn (forward-line 1) (point)))
1725 (dired-clean-up-after-deletion fn))
1726 (error;; catch errors from failed deletions
1727 (dired-log "%s\n" err)
1728 (setq failures (cons (car (car l)) failures)))))
1729 (setq l (cdr l)))
1730 (if (not failures)
1731 (message "%d deletion%s done" count (dired-plural-s count))
1732 (dired-log-summary
1733 (format "%d of %d deletion%s failed"
1734 (length failures) count
1735 (dired-plural-s count))
1736 failures))))
1737 (message "(No deletions performed)")))
1738 (dired-move-to-filename))
1739
1740;; This is a separate function for the sake of dired-x.el.
1741(defun dired-clean-up-after-deletion (fn)
1742 ;; Clean up after a deleted file or directory FN.
7b2469ae
RS
1743 (save-excursion (and (cdr dired-subdir-alist)
1744 (dired-goto-subdir fn)
492d2437
RS
1745 (dired-kill-subdir))))
1746\f
1747;; Confirmation
1748
1749(defun dired-marker-regexp ()
1750 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
1751
1752(defun dired-plural-s (count)
1753 (if (= 1 count) "" "s"))
1754
1755(defun dired-mark-prompt (arg files)
1756 ;; Return a string for use in a prompt, either the current file
1757 ;; name, or the marker and a count of marked files.
1758 (let ((count (length files)))
1759 (if (= count 1)
1760 (car files)
1761 ;; more than 1 file:
1762 (if (integerp arg)
1763 ;; abs(arg) = count
1764 ;; Perhaps this is nicer, but it also takes more screen space:
1765 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
1766 ;; count)
1767 (format "[next %d files]" arg)
1768 (format "%c [%d files]" dired-marker-char count)))))
1769
1770(defun dired-pop-to-buffer (buf)
1771 ;; Pop up buffer BUF.
1772 ;; If dired-shrink-to-fit is t, make its window fit its contents.
1773 (if (not dired-shrink-to-fit)
1774 (pop-to-buffer (get-buffer-create buf))
1775 ;; let window shrink to fit:
1776 (let ((window (selected-window))
1777 target-lines w2)
1778 (cond ;; if split-window-threshold is enabled, use the largest window
1779 ((and (> (window-height (setq w2 (get-largest-window)))
1780 split-height-threshold)
f98955ea 1781 (= (frame-width) (window-width w2)))
492d2437
RS
1782 (setq window w2))
1783 ;; if the least-recently-used window is big enough, use it
1784 ((and (> (window-height (setq w2 (get-lru-window)))
1785 (* 2 window-min-height))
f98955ea 1786 (= (frame-width) (window-width w2)))
492d2437
RS
1787 (setq window w2)))
1788 (save-excursion
1789 (set-buffer buf)
1790 (goto-char (point-max))
1791 (skip-chars-backward "\n\r\t ")
63ea14a5
RS
1792 (setq target-lines (count-lines (point-min) (point)))
1793 ;; Don't forget to count the last line.
1794 (if (not (bolp))
1795 (setq target-lines (1+ target-lines))))
492d2437 1796 (if (<= (window-height window) (* 2 window-min-height))
f98955ea 1797 ;; At this point, every window on the frame is too small to split.
492d2437
RS
1798 (setq w2 (display-buffer buf))
1799 (setq w2 (split-window window
1800 (max window-min-height
1801 (- (window-height window)
1802 (1+ (max window-min-height target-lines)))))))
1803 (set-window-buffer w2 buf)
1804 (if (< (1- (window-height w2)) target-lines)
1805 (progn
1806 (select-window w2)
1807 (enlarge-window (- target-lines (1- (window-height w2))))))
1808 (set-window-start w2 1)
1809 )))
1810
1811(defvar dired-no-confirm nil
1812;; "If non-nil, list of symbols for commands dired should not confirm.
1813;;It can be a sublist of
1814;;
1815;; '(byte-compile chgrp chmod chown compress copy delete hardlink load
1816;; move print shell symlink uncompress)"
1817 )
1818
1819(defun dired-mark-pop-up (bufname op-symbol files function &rest args)
1820 ;;"Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
1821 ;;Return FUNCTION's result on ARGS after popping up a window (in a buffer
1822 ;;named BUFNAME, nil gives \" *Marked Files*\") showing the marked
1823 ;;files. Uses function `dired-pop-to-buffer' to do that.
1824 ;; FUNCTION should not manipulate files.
1825 ;; It should only read input (an argument or confirmation).
1826 ;;The window is not shown if there is just one file or
1827 ;; OP-SYMBOL is a member of the list in `dired-no-confirm'.
1828 ;;FILES is the list of marked files."
1829 (or bufname (setq bufname " *Marked Files*"))
1830 (if (or (memq op-symbol dired-no-confirm)
1831 (= (length files) 1))
1832 (apply function args)
1833 (save-excursion
1834 (set-buffer (get-buffer-create bufname))
1835 (erase-buffer)
a07e7c4a
RS
1836 (dired-format-columns-of-files files)
1837 (remove-text-properties (point-min) (point-max) '(mouse-face)))
492d2437
RS
1838 (save-window-excursion
1839 (dired-pop-to-buffer bufname)
1840 (apply function args))))
1841
1842(defun dired-format-columns-of-files (files)
1843 ;; Files should be in forward order for this loop.
1844 ;; i.e., (car files) = first file in buffer.
1845 ;; Returns the number of lines used.
1846 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
1847 (width (- (window-width (selected-window)) 2))
1848 (columns (max 1 (/ width maxlen)))
1849 (nfiles (length files))
1850 (rows (+ (/ nfiles columns)
1851 (if (zerop (% nfiles columns)) 0 1)))
1852 (i 0)
1853 (j 0))
1854 (setq files (nconc (copy-sequence files) ; fill up with empty fns
1855 (make-list (- (* columns rows) nfiles) "")))
1856 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
1857 (while (< j rows)
1858 (while (< i columns)
1859 (indent-to (* i maxlen))
1860 (insert (car files))
1861 (setq files (nthcdr rows files)
1862 i (1+ i)))
1863 (insert "\n")
1864 (setq i 0
1865 j (1+ j)
1866 files (cdr files)))
1867 rows))
1868\f
1869;; Commands to mark or flag file(s) at or near current line.
1870
1871(defun dired-repeat-over-lines (arg function)
1872 ;; This version skips non-file lines.
cfe89c4f 1873 (let ((pos (make-marker)))
492d2437 1874 (beginning-of-line)
cfe89c4f
RS
1875 (while (and (> arg 0) (not (eobp)))
1876 (setq arg (1- arg))
1877 (beginning-of-line)
1878 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
1879 (save-excursion
1880 (forward-line 1)
1881 (move-marker pos (1+ (point))))
1882 (save-excursion (funcall function))
1883 ;; Advance to the next line--actually, to the line that *was* next.
1884 ;; (If FUNCTION inserted some new lines in between, skip them.)
1885 (goto-char pos))
1886 (while (and (< arg 0) (not (bobp)))
1887 (setq arg (1+ arg))
1888 (forward-line -1)
1889 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
1890 (beginning-of-line)
1891 (save-excursion (funcall function)))
1892 (move-marker pos nil)
1893 (dired-move-to-filename)))
492d2437
RS
1894
1895(defun dired-between-files ()
1896 ;; Point must be at beginning of line
1897 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
1898 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
1899 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard")
a8004e4b
RS
1900 (and (looking-at dired-subdir-regexp)
1901 (save-excursion (not (dired-move-to-filename))))))
492d2437
RS
1902
1903(defun dired-next-marked-file (arg &optional wrap opoint)
1904 "Move to the next marked file, wrapping around the end of the buffer."
1905 (interactive "p\np")
1906 (or opoint (setq opoint (point)));; return to where interactively started
1907 (if (if (> arg 0)
1908 (re-search-forward dired-re-mark nil t arg)
1909 (beginning-of-line)
1910 (re-search-backward dired-re-mark nil t (- arg)))
1911 (dired-move-to-filename)
1912 (if (null wrap)
1913 (progn
1914 (goto-char opoint)
1915 (error "No next marked file"))
1916 (message "(Wraparound for next marked file)")
1917 (goto-char (if (> arg 0) (point-min) (point-max)))
1918 (dired-next-marked-file arg nil opoint))))
1919
1920(defun dired-prev-marked-file (arg &optional wrap)
1921 "Move to the previous marked file, wrapping around the end of the buffer."
1922 (interactive "p\np")
1923 (dired-next-marked-file (- arg) wrap))
1924
1925(defun dired-file-marker (file)
1926 ;; Return FILE's marker, or nil if unmarked.
1927 (save-excursion
1928 (and (dired-goto-file file)
1929 (progn
1930 (beginning-of-line)
1931 (if (not (equal ?\040 (following-char)))
1932 (following-char))))))
1933
1934(defun dired-mark-files-in-region (start end)
1935 (let (buffer-read-only)
1936 (if (> start end)
1937 (error "start > end"))
1938 (goto-char start) ; assumed at beginning of line
1939 (while (< (point) end)
1940 ;; Skip subdir line and following garbage like the `total' line:
1941 (while (and (< (point) end) (dired-between-files))
1942 (forward-line 1))
1943 (if (and (not (looking-at dired-re-dot))
1944 (dired-get-filename nil t))
1945 (progn
1946 (delete-char 1)
1947 (insert dired-marker-char)))
1948 (forward-line 1))))
1949
1950(defun dired-mark (arg)
1951 "Mark the current (or next ARG) files.
1952If on a subdir headerline, mark all its files except `.' and `..'.
1953
1954Use \\[dired-unmark-all-files] to remove all marks
1955and \\[dired-unmark] on a subdir to remove the marks in
1956this subdir."
1957 (interactive "P")
277568f2 1958 (if (dired-get-subdir)
492d2437
RS
1959 (save-excursion (dired-mark-subdir-files))
1960 (let (buffer-read-only)
1961 (dired-repeat-over-lines
52041219 1962 (prefix-numeric-value arg)
492d2437
RS
1963 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
1964
1965(defun dired-unmark (arg)
1966 "Unmark the current (or next ARG) files.
1967If looking at a subdir, unmark all its files except `.' and `..'."
1968 (interactive "P")
1969 (let ((dired-marker-char ?\040))
1970 (dired-mark arg)))
1971
1972(defun dired-flag-file-deletion (arg)
1973 "In dired, flag the current line's file for deletion.
1974With prefix arg, repeat over several lines.
1975
1976If on a subdir headerline, mark all its files except `.' and `..'."
1977 (interactive "P")
1978 (let ((dired-marker-char dired-del-marker))
1979 (dired-mark arg)))
1980
1981(defun dired-unmark-backward (arg)
1982 "In dired, move up lines and remove deletion flag there.
1983Optional prefix ARG says how many lines to unflag; default is one line."
1984 (interactive "p")
1985 (dired-unmark (- arg)))
84fc2cfa 1986\f
492d2437
RS
1987;;; Commands to mark or flag files based on their characteristics or names.
1988
d2cadc4b
RS
1989(defvar dired-regexp-history nil
1990 "History list of regular expressions used in Dired commands.")
1991
1992(defun dired-read-regexp (prompt)
1993 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
492d2437
RS
1994
1995(defun dired-mark-files-regexp (regexp &optional marker-char)
1996 "Mark all files matching REGEXP for use in later commands.
1997A prefix argument means to unmark them instead.
1998`.' and `..' are never marked.
1999
2000REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
2001object files--just `.o' will mark more than you might think."
2002 (interactive
2003 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2004 " files (regexp): "))
2005 (if current-prefix-arg ?\040)))
2006 (let ((dired-marker-char (or marker-char dired-marker-char)))
2007 (dired-mark-if
2008 (and (not (looking-at dired-re-dot))
2009 (not (eolp)) ; empty line
2010 (let ((fn (dired-get-filename nil t)))
2011 (and fn (string-match regexp (file-name-nondirectory fn)))))
2012 "matching file")))
2013
2014(defun dired-flag-files-regexp (regexp)
2015 "In dired, flag all files containing the specified REGEXP for deletion.
2016The match is against the non-directory part of the filename. Use `^'
2017 and `$' to anchor matches. Exclude subdirs by hiding them.
2018`.' and `..' are never flagged."
2019 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2020 (dired-mark-files-regexp regexp dired-del-marker))
2021
2022(defun dired-mark-symlinks (unflag-p)
2023 "Mark all symbolic links.
2024With prefix argument, unflag all those files."
2025 (interactive "P")
2026 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2027 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2028
2029(defun dired-mark-directories (unflag-p)
2030 "Mark all directory file lines except `.' and `..'.
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 (and (looking-at dired-re-dir)
2035 (not (looking-at dired-re-dot)))
2036 "directory file")))
2037
2038(defun dired-mark-executables (unflag-p)
2039 "Mark all executable files.
2040With prefix argument, unflag all those files."
2041 (interactive "P")
2042 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2043 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2044
2045;; dired-x.el has a dired-mark-sexp interactive command: mark
2046;; files for which PREDICATE returns non-nil.
2047
2048(defun dired-flag-auto-save-files (&optional unflag-p)
84fc2cfa
ER
2049 "Flag for deletion files whose names suggest they are auto save files.
2050A prefix argument says to unflag those files instead."
2051 (interactive "P")
492d2437
RS
2052 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2053 (dired-mark-if
2a838614 2054 ;; It is less than general to check for # here,
a91526b9
RS
2055 ;; but it's the only way this runs fast enough.
2056 (and (save-excursion (end-of-line)
536ae2dd
RS
2057 (or
2058 (eq (preceding-char) ?#)
2059 ;; Handle executables in case of -F option.
2060 ;; We need not worry about the other kinds
2061 ;; of markings that -F makes, since they won't
2062 ;; appear on real auto-save files.
2063 (if (eq (preceding-char) ?*)
2064 (progn
2065 (forward-char -1)
2066 (eq (preceding-char) ?#)))))
a91526b9
RS
2067 (not (looking-at dired-re-dir))
2068 (let ((fn (dired-get-filename t t)))
2069 (if fn (auto-save-file-name-p
2070 (file-name-nondirectory fn)))))
2071 "auto save file")))
492d2437
RS
2072
2073(defun dired-flag-backup-files (&optional unflag-p)
2074 "Flag all backup files (names ending with `~') for deletion.
2075With prefix argument, unflag these files."
2076 (interactive "P")
fdee13ec 2077 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
492d2437 2078 (dired-mark-if
f13101e9
KH
2079 ;; Don't call backup-file-name-p unless the last character looks like
2080 ;; it might be the end of a backup file name. This isn't very general,
a91526b9
RS
2081 ;; but it's the only way this runs fast enough.
2082 (and (save-excursion (end-of-line)
f13101e9
KH
2083 ;; Handle executables in case of -F option.
2084 ;; We need not worry about the other kinds
2085 ;; of markings that -F makes, since they won't
2086 ;; appear on real backup files.
2087 (if (eq (preceding-char) ?*)
2088 (forward-char -1))
fdee13ec 2089 (eq (preceding-char) ?~))
a91526b9 2090 (not (looking-at dired-re-dir))
492d2437
RS
2091 (let ((fn (dired-get-filename t t)))
2092 (if fn (backup-file-name-p fn))))
2093 "backup file")))
2094
6482fcac
RS
2095(defun dired-change-marks (&optional old new)
2096 "Change all OLD marks to NEW marks.
2097OLD and NEW are both characters used to mark files."
2098 (interactive
2099 (let* ((cursor-in-echo-area t)
2100 (old (progn (message "Change (old mark): ") (read-char)))
2101 (new (progn (message "Change %c marks to (new mark): " old)
2102 (read-char))))
2103 (list old new)))
e4e02841
RS
2104 (if (or (eq old ?\r) (eq new ?\r))
2105 (ding)
2106 (let ((string (format "\n%c" old))
2107 (buffer-read-only))
2108 (save-excursion
2109 (goto-char (point-min))
2110 (while (search-forward string nil t)
a15a76f7
RS
2111 (if (if (= old ?\ )
2112 (save-match-data
2113 (dired-get-filename 'no-dir t))
2114 t)
2115 (subst-char-in-region (match-beginning 0)
2116 (match-end 0) old new)))))))
6482fcac 2117
b1ecd9c6
RS
2118(defun dired-unmark-all-files-no-query ()
2119 "Remove all marks from all files in the Dired buffer."
2120 (interactive)
2121 (dired-unmark-all-files ?\r))
2122
8b87a301 2123(defun dired-unmark-all-files (mark &optional arg)
b602ba2f
RS
2124 "Remove a specific mark (or any mark) from every file.
2125After this command, type the mark character to remove,
2126or type RET to remove all marks.
3585916f 2127With prefix arg, query for each marked file.
492d2437 2128Type \\[help-command] at that time for help."
b602ba2f
RS
2129 (interactive "cRemove marks (RET means all): \nP")
2130 (save-excursion
2131 (let* ((count 0)
2132 buffer-read-only case-fold-search query
2133 (string (format "\n%c" mark))
2134 (help-form "\
8b87a301
RS
2135Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2136`!' to unmark all remaining files with no more questions."))
b602ba2f
RS
2137 (goto-char (point-min))
2138 (while (if (eq mark ?\r)
2139 (re-search-forward dired-re-mark nil t)
2140 (search-forward string nil t))
2141 (if (or (not arg)
2142 (dired-query 'query "Unmark file `%s'? "
2143 (dired-get-filename t)))
2144 (progn (subst-char-in-region (1- (point)) (point)
2145 (preceding-char) ?\ )
2146 (setq count (1+ count)))))
2147 (message (if (= count 1) "1 mark removed"
2148 "%d marks removed")
2149 count))))
492d2437 2150\f
492d2437 2151;; Logging failures operating on files, and showing the results.
84fc2cfa 2152
492d2437 2153(defvar dired-log-buffer "*Dired log*")
84fc2cfa 2154
492d2437
RS
2155(defun dired-why ()
2156 "Pop up a buffer with error log output from Dired.
2157A group of errors from a single command ends with a formfeed.
2158Thus, use \\[backward-page] to find the beginning of a group of errors."
2159 (interactive)
2160 (if (get-buffer dired-log-buffer)
2161 (let ((owindow (selected-window))
2162 (window (display-buffer (get-buffer dired-log-buffer))))
2163 (unwind-protect
6482fcac 2164 (progn
492d2437
RS
2165 (select-window window)
2166 (goto-char (point-max))
2167 (recenter -1))
2168 (select-window owindow)))))
2169
2170(defun dired-log (log &rest args)
2171 ;; Log a message or the contents of a buffer.
2172 ;; If LOG is a string and there are more args, it is formatted with
2173 ;; those ARGS. Usually the LOG string ends with a \n.
2174 ;; End each bunch of errors with (dired-log t): this inserts
2175 ;; current time and buffer, and a \f (formfeed).
2176 (let ((obuf (current-buffer)))
2177 (unwind-protect ; want to move point
2178 (progn
2179 (set-buffer (get-buffer-create dired-log-buffer))
2180 (goto-char (point-max))
2181 (let (buffer-read-only)
2182 (cond ((stringp log)
2183 (insert (if args
2184 (apply (function format) log args)
2185 log)))
2186 ((bufferp log)
2187 (insert-buffer log))
2188 ((eq t log)
2189 (insert "\n\t" (current-time-string)
2190 "\tBuffer `" (buffer-name obuf) "'\n\f\n")))))
2191 (set-buffer obuf))))
2192
2193(defun dired-log-summary (string failures)
2194 (message (if failures "%s--type ? for details (%s)"
2195 "%s--type ? for details")
2196 string failures)
2197 ;; Log a summary describing a bunch of errors.
2198 (dired-log (concat "\n" string))
2199 (dired-log t))
2200\f
2201;;; Sorting
2202
2203;; Most ls can only sort by name or by date (with -t), nothing else.
2204;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2205;; So anything that does not contain these is sort "by name".
2206
2207(defvar dired-ls-sorting-switches "SXU"
2208 "String of `ls' switches (single letters) except `t' that influence sorting.")
2209
2210(defvar dired-sort-by-date-regexp
2211 (concat "^-[^" dired-ls-sorting-switches
2212 "]*t[^" dired-ls-sorting-switches "]*$")
2213 "Regexp recognized by dired to set `by date' mode.")
2214
2215(defvar dired-sort-by-name-regexp
2216 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2217 "Regexp recognized by dired to set `by name' mode.")
2218
492d2437
RS
2219(defun dired-sort-set-modeline ()
2220 ;; Set modeline display according to dired-actual-switches.
2221 ;; Modeline display of "by name" or "by date" guarantees the user a
2222 ;; match with the corresponding regexps. Non-matching switches are
2223 ;; shown literally.
1d673d85 2224 (setq mode-name
492d2437
RS
2225 (let (case-fold-search)
2226 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
1d673d85 2227 "Dired by name")
492d2437 2228 ((string-match dired-sort-by-date-regexp dired-actual-switches)
1d673d85 2229 "Dired by date")
492d2437 2230 (t
1d673d85 2231 (concat "Dired " dired-actual-switches)))))
45d8d39f 2232 (force-mode-line-update))
492d2437
RS
2233
2234(defun dired-sort-toggle-or-edit (&optional arg)
2235 "Toggle between sort by date/name and refresh the dired buffer.
2236With a prefix argument you can edit the current listing switches instead."
84fc2cfa 2237 (interactive "P")
492d2437
RS
2238 (if arg
2239 (dired-sort-other
2240 (read-string "ls switches (must contain -l): " dired-actual-switches))
2241 (dired-sort-toggle)))
2242
2243(defun dired-sort-toggle ()
2244 ;; Toggle between sort by date/name. Reverts the buffer.
2245 (setq dired-actual-switches
2246 (let (case-fold-search)
2247 (concat
2248 "-l"
26add1bf 2249 (dired-replace-in-string (concat "[-lt"
492d2437
RS
2250 dired-ls-sorting-switches "]")
2251 ""
2252 dired-actual-switches)
2253 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2254 dired-actual-switches)
2255 ""
2256 "t"))))
2257 (dired-sort-set-modeline)
2258 (revert-buffer))
2259
2260(defun dired-replace-in-string (regexp newtext string)
2261 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2262 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2263 (let ((result "") (start 0) mb me)
2264 (while (string-match regexp string start)
2265 (setq mb (match-beginning 0)
2266 me (match-end 0)
2267 result (concat result (substring string start mb) newtext)
2268 start me))
2269 (concat result (substring string start))))
2270
2271(defun dired-sort-other (switches &optional no-revert)
2272 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2273 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2274 ;; minor mode accordingly, others appear literally in the mode line.
2275 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2276 (setq dired-actual-switches switches)
6cfd24f9 2277 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
492d2437 2278 (or no-revert (revert-buffer)))
84fc2cfa 2279\f
492d2437
RS
2280;; To make this file smaller, the less common commands
2281;; go in a separate file. But autoload them here
2282;; to make the separation invisible.
2283
2284(autoload 'dired-diff "dired-aux"
2285 "Compare file at point with file FILE using `diff'.
2286FILE defaults to the file at the mark.
ab67260b 2287The prompted-for file is the first file given to `diff'."
492d2437
RS
2288 t)
2289
2290(autoload 'dired-backup-diff "dired-aux"
2291 "Diff this file with its backup file or vice versa.
2292Uses the latest backup, if there are several numerical backups.
2293If this file is a backup, diff it with its original.
ab67260b 2294The backup file is the first file given to `diff'."
492d2437
RS
2295 t)
2296
2d051399
RS
2297(autoload 'dired-clean-directory "dired-aux"
2298 "Flag numerical backups for deletion.
2299Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2300Positive prefix arg KEEP overrides `dired-kept-versions';
2301Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2302
2303To clear the flags on these files, you can use \\[dired-flag-backup-files]
2304with a prefix argument."
2305 t)
2306
492d2437
RS
2307(autoload 'dired-do-chmod "dired-aux"
2308 "Change the mode of the marked (or next ARG) files.
2309This calls chmod, thus symbolic modes like `g+w' are allowed."
2310 t)
2311
2312(autoload 'dired-do-chgrp "dired-aux"
2313 "Change the group of the marked (or next ARG) files."
2314 t)
2315
2316(autoload 'dired-do-chown "dired-aux"
2317 "Change the owner of the marked (or next ARG) files."
2318 t)
2319
2320(autoload 'dired-do-print "dired-aux"
2321 "Print the marked (or next ARG) files.
2322Uses the shell command coming from variables `lpr-command' and
2323`lpr-switches' as default."
2324 t)
2325
2326(autoload 'dired-do-shell-command "dired-aux"
6482fcac
RS
2327 "Run a shell command COMMAND on the marked files.
2328If no files are marked or a specific numeric prefix arg is given,
2329the next ARG files are used. Just \\[universal-argument] means the current file.
2330The prompt mentions the file(s) or the marker, as appropriate.
2331
492d2437 2332If there is output, it goes to a separate buffer.
6482fcac 2333
492d2437
RS
2334Normally the command is run on each file individually.
2335However, if there is a `*' in the command then it is run
2336just once with the entire file list substituted there.
2337
6482fcac
RS
2338No automatic redisplay of dired buffers is attempted, as there's no
2339telling what files the command may have changed. Type
2340\\[dired-do-redisplay] to redisplay the marked files.
492d2437
RS
2341
2342The shell command has the top level directory as working directory, so
2343output files usually are created there instead of in a subdir."
2344 t)
2345
492d2437
RS
2346(autoload 'dired-do-kill-lines "dired-aux"
2347 "Kill all marked lines (not the files).
2348With a prefix arg, kill all lines not marked or flagged."
2349 t)
2350
2351(autoload 'dired-do-compress "dired-aux"
2352 "Compress or uncompress marked (or next ARG) files."
2353 t)
2354
2355(autoload 'dired-do-byte-compile "dired-aux"
2356 "Byte compile marked (or next ARG) Emacs Lisp files."
2357 t)
2358
2359(autoload 'dired-do-load "dired-aux"
2360 "Load the marked (or next ARG) Emacs Lisp files."
2361 t)
2362
2363(autoload 'dired-do-redisplay "dired-aux"
2364 "Redisplay all marked (or next ARG) files.
2365If on a subdir line, redisplay that subdirectory. In that case,
2366a prefix arg lets you edit the `ls' switches used for the new listing."
2367 t)
2368
2369(autoload 'dired-string-replace-match "dired-aux"
2370 "Replace first match of REGEXP in STRING with NEWTEXT.
2371If it does not match, nil is returned instead of the new string.
2372Optional arg LITERAL means to take NEWTEXT literally.
2373Optional arg GLOBAL means to replace all matches."
2374 t)
2375
2376(autoload 'dired-create-directory "dired-aux"
84fc2cfa 2377 "Create a directory called DIRECTORY."
492d2437 2378 t)
84fc2cfa 2379
492d2437
RS
2380(autoload 'dired-do-copy "dired-aux"
2381 "Copy all marked (or next ARG) files, or copy the current file.
2382Thus, a zero prefix argument copies nothing. But it toggles the
2383variable `dired-copy-preserve-time' (which see)."
2384 t)
2385
2386(autoload 'dired-do-symlink "dired-aux"
2387 "Make symbolic links to current file or all marked (or next ARG) files.
2388When operating on just the current file, you specify the new name.
2389When operating on multiple or marked files, you specify a directory
2390and new symbolic links are made in that directory
2391with the same names that the files currently have."
2392 t)
2393
2394(autoload 'dired-do-hardlink "dired-aux"
2395 "Add names (hard links) current file or all marked (or next ARG) files.
2396When operating on just the current file, you specify the new name.
2397When operating on multiple or marked files, you specify a directory
2398and new hard links are made in that directory
2399with the same names that the files currently have."
2400 t)
2401
2402(autoload 'dired-do-rename "dired-aux"
2403 "Rename current file or all marked (or next ARG) files.
2404When renaming just the current file, you specify the new name.
2405When renaming multiple or marked files, you specify a directory."
2406 t)
2407
2408(autoload 'dired-do-rename-regexp "dired-aux"
2409 "Rename marked files containing REGEXP to NEWNAME.
2410As each match is found, the user must type a character saying
2411 what to do with it. For directions, type \\[help-command] at that time.
2412NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2413REGEXP defaults to the last regexp used.
2414With a zero prefix arg, renaming by regexp affects the complete
2415 pathname - usually only the non-directory part of file names is used
2416 and changed."
2417 t)
2418
2419(autoload 'dired-do-copy-regexp "dired-aux"
2420 "Copy all marked files containing REGEXP to NEWNAME.
2421See function `dired-rename-regexp' for more info."
2422 t)
2423
2424(autoload 'dired-do-hardlink-regexp "dired-aux"
2425 "Hardlink all marked files containing REGEXP to NEWNAME.
2426See function `dired-rename-regexp' for more info."
2427 t)
2428
2429(autoload 'dired-do-symlink-regexp "dired-aux"
2430 "Symlink all marked files containing REGEXP to NEWNAME.
2431See function `dired-rename-regexp' for more info."
2432 t)
2433
2434(autoload 'dired-upcase "dired-aux"
2435 "Rename all marked (or next ARG) files to upper case."
2436 t)
2437
2438(autoload 'dired-downcase "dired-aux"
2439 "Rename all marked (or next ARG) files to lower case."
2440 t)
2441
2442(autoload 'dired-maybe-insert-subdir "dired-aux"
2443 "Insert this subdirectory into the same dired buffer.
2444If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2445 else inserts it at its natural place (as `ls -lR' would have done).
2446With a prefix arg, you may edit the ls switches used for this listing.
2447 You can add `R' to the switches to expand the whole tree starting at
2448 this subdirectory.
2449This function takes some pains to conform to `ls -lR' output."
2450 t)
2451
2452(autoload 'dired-next-subdir "dired-aux"
2453 "Go to next subdirectory, regardless of level."
2454 t)
2455
2456(autoload 'dired-prev-subdir "dired-aux"
2457 "Go to previous subdirectory, regardless of level.
2458When called interactively and not on a subdir line, go to this subdir's line."
2459 t)
2460
2461(autoload 'dired-goto-subdir "dired-aux"
2462 "Go to end of header line of DIR in this dired buffer.
2463Return value of point on success, otherwise return nil.
2464The next char is either \\n, or \\r if DIR is hidden."
2465 t)
2466
2467(autoload 'dired-mark-subdir-files "dired-aux"
2468 "Mark all files except `.' and `..'."
2469 t)
2470
2471(autoload 'dired-kill-subdir "dired-aux"
2472 "Remove all lines of current subdirectory.
2473Lower levels are unaffected."
2474 t)
2475
2476(autoload 'dired-tree-up "dired-aux"
2477 "Go up ARG levels in the dired tree."
2478 t)
2479
2480(autoload 'dired-tree-down "dired-aux"
2481 "Go down in the dired tree."
2482 t)
2483
2484(autoload 'dired-hide-subdir "dired-aux"
2485 "Hide or unhide the current subdirectory and move to next directory.
2486Optional prefix arg is a repeat factor.
2487Use \\[dired-hide-all] to (un)hide all directories."
2488 t)
2489
2490(autoload 'dired-hide-all "dired-aux"
2491 "Hide all subdirectories, leaving only their header lines.
2492If there is already something hidden, make everything visible again.
2493Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2494 t)
84fc2cfa 2495\f
492d2437
RS
2496(if (eq system-type 'vax-vms)
2497 (load "dired-vms"))
84fc2cfa 2498
52041219
RS
2499(provide 'dired)
2500
57e15005
BF
2501(run-hooks 'dired-load-hook) ; for your customizations
2502
52041219 2503;;; dired.el ends here