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