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