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