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