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