(insert-directory): Make sure default-directory is absolute.
[bpt/emacs.git] / lisp / dired.el
CommitLineData
c8472948 1;;; dired.el --- directory-browsing commands
52041219 2
37ef13a6 3;; Copyright (C) 1985, 1986, 1992, 1993 Free Software Foundation, Inc.
ab67260b 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")
eb8c3be9 51 "Name of chown command (usually `chown' or `/etc/chown').")
492d2437 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
fc53efda
RS
734;; Make menu bar items.
735
736;; Get rid of the Edit menu bar item to save space.
737(define-key dired-mode-map [menu-bar edit] 'undefined)
738
739(define-key dired-mode-map [menu-bar subdir]
740 (cons "Subdir" (make-sparse-keymap "Subdir")))
741
742(define-key dired-mode-map [menu-bar subdir hide-all]
743 '("Hide All" . dired-hide-all))
744(define-key dired-mode-map [menu-bar subdir hide-subdir]
745 '("Hide Subdir" . dired-hide-subdir))
746(define-key dired-mode-map [menu-bar subdir tree-down]
747 '("Tree Down" . dired-tree-down))
748(define-key dired-mode-map [menu-bar subdir tree-up]
749 '("Tree Up" . dired-tree-up))
750(define-key dired-mode-map [menu-bar subdir up]
751 '("Up Directory" . dired-up-directory))
752(define-key dired-mode-map [menu-bar subdir prev-subdir]
753 '("Prev Subdir" . dired-prev-subdir))
754(define-key dired-mode-map [menu-bar subdir next-subdir]
755 '("Next Subdir" . dired-next-subdir))
756(define-key dired-mode-map [menu-bar subdir prev-dirline]
757 '("Prev Dirline" . dired-prev-dirline))
758(define-key dired-mode-map [menu-bar subdir next-dirline]
759 '("Next Dirline" . dired-next-dirline))
760(define-key dired-mode-map [menu-bar subdir insert]
761 '("Insert This Subdir" . dired-maybe-insert-subdir))
762
763(define-key dired-mode-map [menu-bar immediate]
764 (cons "Immediate" (make-sparse-keymap "Immediate")))
765
766(define-key dired-mode-map [menu-bar immediate backup-diff]
767 '("Compare with Backup" . dired-backup-diff))
768(define-key dired-mode-map [menu-bar immediate diff]
769 '("Diff" . dired-diff))
770(define-key dired-mode-map [menu-bar immediate view]
771 '("View This File" . dired-view-file))
772(define-key dired-mode-map [menu-bar immediate display]
773 '("Display in Other Window" . dired-display-file))
774(define-key dired-mode-map [menu-bar immediate find-file-other-window]
775 '("Find in Other Window" . dired-find-file-other-window))
776(define-key dired-mode-map [menu-bar immediate find-file]
777 '("Find This File" . dired-find-file))
778(define-key dired-mode-map [menu-bar immediate create-directory]
779 '("Create Directory..." . dired-create-directory))
780
781(define-key dired-mode-map [menu-bar regexp]
782 (cons "Regexp" (make-sparse-keymap "Regexp")))
783
784(define-key dired-mode-map [menu-bar regexp downcase]
785 '("Downcase" . dired-downcase))
786(define-key dired-mode-map [menu-bar regexp upcase]
787 '("Upcase" . dired-upcase))
788(define-key dired-mode-map [menu-bar regexp hardlink]
789 '("Hardlink..." . dired-do-hardlink-regexp))
790(define-key dired-mode-map [menu-bar regexp symlink]
791 '("Symlink..." . dired-do-symlink-regexp))
792(define-key dired-mode-map [menu-bar regexp rename]
793 '("Rename..." . dired-do-rename-regexp))
794(define-key dired-mode-map [menu-bar regexp copy]
795 '("Copy..." . dired-do-copy-regexp))
796(define-key dired-mode-map [menu-bar regexp flag]
797 '("Flag..." . dired-flag-files-regexp))
798(define-key dired-mode-map [menu-bar regexp mark]
799 '("Mark..." . dired-mark-files-regexp))
800
801(define-key dired-mode-map [menu-bar mark]
802 (cons "Mark" (make-sparse-keymap "Mark")))
803
804(define-key dired-mode-map [menu-bar mark prev]
805 '("Previous Marked" . dired-prev-marked-file))
806(define-key dired-mode-map [menu-bar mark next]
807 '("Next Marked" . dired-next-marked-file))
808(define-key dired-mode-map [menu-bar mark marks]
809 '("Change Marks..." . dired-change-marks))
b1ecd9c6
RS
810(define-key dired-mode-map [menu-bar mark unmark-all]
811 '("Unmark All" . dired-unmark-all-files-no-query))
fc53efda
RS
812(define-key dired-mode-map [menu-bar mark symlinks]
813 '("Mark Symlinks" . dired-mark-symlinks))
814(define-key dired-mode-map [menu-bar mark directories]
815 '("Mark Directories" . dired-mark-directories))
816(define-key dired-mode-map [menu-bar mark directory]
817 '("Mark Old Backups" . dired-clean-directory))
818(define-key dired-mode-map [menu-bar mark executables]
819 '("Mark Executables" . dired-mark-executables))
b1ecd9c6 820(define-key dired-mode-map [menu-bar mark backup-files]
fc53efda 821 '("Flag Backup Files" . dired-flag-backup-files))
b1ecd9c6 822(define-key dired-mode-map [menu-bar mark auto-save-files]
fc53efda
RS
823 '("Flag Auto-save Files" . dired-flag-auto-save-files))
824(define-key dired-mode-map [menu-bar mark deletion]
825 '("Flag" . dired-flag-file-deletion))
826(define-key dired-mode-map [menu-bar mark unmark]
827 '("Unmark" . dired-unmark))
828(define-key dired-mode-map [menu-bar mark mark]
829 '("Mark" . dired-mark))
830
831(define-key dired-mode-map [menu-bar operate]
832 (cons "Operate" (make-sparse-keymap "Operate")))
833
834(define-key dired-mode-map [menu-bar operate chown]
835 '("Change Owner..." . dired-do-chown))
836(define-key dired-mode-map [menu-bar operate chgrp]
837 '("Change Group..." . dired-do-chgrp))
838(define-key dired-mode-map [menu-bar operate chmod]
839 '("Change Mode..." . dired-do-chmod))
840(define-key dired-mode-map [menu-bar operate load]
841 '("Load" . dired-do-load))
842(define-key dired-mode-map [menu-bar operate compile]
843 '("Byte-compile" . dired-do-byte-compile))
844(define-key dired-mode-map [menu-bar operate compress]
845 '("Compress" . dired-do-compress))
846(define-key dired-mode-map [menu-bar operate print]
847 '("Print" . dired-do-print))
848(define-key dired-mode-map [menu-bar operate hardlink]
849 '("Hardlink to..." . dired-do-hardlink))
850(define-key dired-mode-map [menu-bar operate symlink]
851 '("Symlink to..." . dired-do-symlink))
852(define-key dired-mode-map [menu-bar operate command]
853 '("Shell Command..." . dired-do-shell-command))
854(define-key dired-mode-map [menu-bar operate delete]
855 '("Delete" . dired-do-delete))
856(define-key dired-mode-map [menu-bar operate rename]
857 '("Rename to..." . dired-do-rename))
858(define-key dired-mode-map [menu-bar operate copy]
859 '("Copy to..." . dired-do-copy))
860\f
84fc2cfa
ER
861;; Dired mode is suitable only for specially formatted data.
862(put 'dired-mode 'mode-class 'special)
863
492d2437
RS
864(defun dired-mode (&optional dirname switches)
865 "\
866Mode for \"editing\" directory listings.
867In dired, you are \"editing\" a list of the files in a directory and
868 \(optionally) its subdirectories, in the format of `ls -lR'.
869 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
870\"Editing\" means that you can run shell commands on files, visit,
871 compress, load or byte-compile them, change their file attributes
872 and insert subdirectories into the same buffer. You can \"mark\"
873 files for later commands or \"flag\" them for deletion, either file
874 by file or all files matching certain criteria.
875You can move using the usual cursor motion commands.\\<dired-mode-map>
876Letters no longer insert themselves. Digits are prefix arguments.
877Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
878Type \\[dired-mark] to Mark a file or subdirectory for later commands.
879 Most commands operate on the marked files and use the current file
880 if no files are marked. Use a numeric prefix argument to operate on
881 the next ARG (or previous -ARG if ARG<0) files, or just `1'
882 to operate on the current file only. Prefix arguments override marks.
883 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
884 to see why something went wrong.
885Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
886Type \\[dired-unmark-backward] to back up one line and unflag.
887Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
888Type \\[dired-advertised-find-file] to Find the current line's file
889 (or dired it in another buffer, if it is a directory).
890Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
891Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
892Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
893Type \\[dired-do-copy] to Copy files.
894Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
895Type \\[revert-buffer] to read all currently expanded directories again.
896 This retains all marks and hides subdirs again that were hidden before.
897SPC and DEL can be used to move down and up by lines.
898
899If dired ever gets confused, you can either type \\[revert-buffer] \
900to read the
901directories again, type \\[dired-do-redisplay] \
902to relist a single or the marked files or a
903subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
904again for the directory tree.
905
906Customization variables (rename this buffer and type \\[describe-variable] on each line
907for more info):
908
909 dired-listing-switches
910 dired-trivial-filenames
911 dired-shrink-to-fit
912 dired-marker-char
913 dired-del-marker
914 dired-keep-marker-rename
915 dired-keep-marker-copy
916 dired-keep-marker-hardlink
917 dired-keep-marker-symlink
918
919Hooks (use \\[describe-variable] to see their documentation):
920
921 dired-before-readin-hook
922 dired-after-readin-hook
923 dired-mode-hook
924 dired-load-hook
925
926Keybindings:
84fc2cfa 927\\{dired-mode-map}"
492d2437
RS
928 ;; Not to be called interactively (e.g. dired-directory will be set
929 ;; to default-directory, which is wrong with wildcards).
84fc2cfa 930 (kill-all-local-variables)
84fc2cfa 931 (use-local-map dired-mode-map)
492d2437
RS
932 (dired-advertise) ; default-directory is already set
933 (setq major-mode 'dired-mode
934 mode-name "Dired"
935 case-fold-search nil
936 buffer-read-only t
937 selective-display t ; for subdirectory hiding
938 mode-line-buffer-identification '("Dired: %17b"))
939 (set (make-local-variable 'revert-buffer-function)
940 (function dired-revert))
941 (set (make-local-variable 'page-delimiter)
942 "\n\n")
943 (set (make-local-variable 'dired-directory)
944 (or dirname default-directory))
945 ;; list-buffers uses this to display the dir being edited in this buffer.
946 (set (make-local-variable 'list-buffers-directory)
947 dired-directory)
948 (set (make-local-variable 'dired-actual-switches)
949 (or switches dired-listing-switches))
950 (make-local-variable 'dired-sort-mode)
951 (dired-sort-other dired-actual-switches t)
84fc2cfa
ER
952 (run-hooks 'dired-mode-hook))
953\f
eb8c3be9 954;; Idiosyncratic dired commands that don't deal with marks.
84fc2cfa 955
492d2437
RS
956(defun dired-quit ()
957 "Bury the current dired buffer."
958 (interactive)
959 (bury-buffer))
84fc2cfa
ER
960
961(defun dired-summary ()
492d2437 962 "Summarize basic Dired commands and show recent Dired errors."
84fc2cfa 963 (interactive)
492d2437 964 (dired-why)
84fc2cfa
ER
965 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
966 (message
50f74744 967 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
84fc2cfa 968
492d2437
RS
969(defun dired-undo ()
970 "Undo in a dired buffer.
971This doesn't recover lost files, it just undoes changes in the buffer itself.
972You can use it to recover marks, killed lines or subdirs.
973In the latter case, you have to do \\[dired-build-subdir-alist] to
974parse the buffer again."
975 (interactive)
976 (let (buffer-read-only)
977 (undo)))
84fc2cfa
ER
978
979(defun dired-next-line (arg)
980 "Move down lines then position at filename.
981Optional prefix ARG says how many lines to move; default is one line."
982 (interactive "p")
983 (next-line arg)
984 (dired-move-to-filename))
985
986(defun dired-previous-line (arg)
987 "Move up lines then position at filename.
988Optional prefix ARG says how many lines to move; default is one line."
989 (interactive "p")
990 (previous-line arg)
991 (dired-move-to-filename))
992
492d2437
RS
993(defun dired-next-dirline (arg &optional opoint)
994 "Goto ARG'th next directory file line."
995 (interactive "p")
996 (or opoint (setq opoint (point)))
997 (if (if (> arg 0)
998 (re-search-forward dired-re-dir nil t arg)
999 (beginning-of-line)
1000 (re-search-backward dired-re-dir nil t (- arg)))
1001 (dired-move-to-filename) ; user may type `i' or `f'
1002 (goto-char opoint)
1003 (error "No more subdirectories")))
1004
1005(defun dired-prev-dirline (arg)
1006 "Goto ARG'th previous directory file line."
1007 (interactive "p")
1008 (dired-next-dirline (- arg)))
1009
84fc2cfa 1010(defun dired-up-directory ()
492d2437
RS
1011 "Run dired on parent directory of current directory.
1012Find the parent directory either in this buffer or another buffer.
1013Creates a buffer if necessary."
84fc2cfa 1014 (interactive)
492d2437
RS
1015 (let* ((dir (dired-current-directory))
1016 (up (file-name-directory (directory-file-name dir))))
1017 (or (dired-goto-file (directory-file-name dir))
7b2469ae
RS
1018 ;; Only try dired-goto-subdir if buffer has more than one dir.
1019 (and (cdr dired-subdir-alist)
492d2437
RS
1020 (dired-goto-subdir up))
1021 (progn
8d23c16b
ER
1022 (dired
1023up)
492d2437 1024 (dired-goto-file dir)))))
84fc2cfa
ER
1025
1026(defun dired-find-file ()
1027 "In dired, visit the file or directory named on this line."
1028 (interactive)
c3554e95 1029 (find-file (file-name-sans-versions (dired-get-filename) t)))
84fc2cfa
ER
1030
1031(defun dired-view-file ()
492d2437
RS
1032 "In dired, examine a file in view mode, returning to dired when done.
1033When file is a directory, show it in this buffer if it is inserted;
1034otherwise, display it in another buffer."
84fc2cfa
ER
1035 (interactive)
1036 (if (file-directory-p (dired-get-filename))
7b2469ae
RS
1037 (or (and (cdr dired-subdir-alist)
1038 (dired-goto-subdir (dired-get-filename)))
492d2437 1039 (dired (dired-get-filename)))
715984d3 1040 (view-file (dired-get-filename))))
84fc2cfa
ER
1041
1042(defun dired-find-file-other-window ()
1043 "In dired, visit this file or directory in another window."
1044 (interactive)
c3554e95 1045 (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
ab67260b
RS
1046
1047(defun dired-display-file ()
1048 "In dired, display this file or directory in another window."
1049 (interactive)
c3554e95
RS
1050 (let ((file (file-name-sans-versions (dired-get-filename) t)))
1051 (display-buffer (find-file-noselect file))))
492d2437
RS
1052\f
1053;;; Functions for extracting and manipulating file names in dired buffers.
84fc2cfa
ER
1054
1055(defun dired-get-filename (&optional localp no-error-if-not-filep)
1056 "In dired, return name of file mentioned on this line.
1057Value returned normally includes the directory name.
492d2437
RS
1058Optional arg LOCALP with value `no-dir' means don't include directory
1059 name in result. A value of t means construct name relative to
1060 `default-directory', which still may contain slashes if in a subdirectory.
1061Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1062 this line, otherwise an error occurs."
1063 (let (case-fold-search file p1 p2)
84fc2cfa 1064 (save-excursion
492d2437
RS
1065 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1066 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1067 ;; nil if no file on this line, but no-error-if-not-filep is t:
1068 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1069 ;; Check if ls quoted the names, and unquote them.
1070 ;; Using read to unquote is much faster than substituting
1071 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1072 (cond ((string-match "b" dired-actual-switches) ; System V ls
1073 ;; This case is about 20% slower than without -b.
1074 (setq file
1075 (read
1076 (concat "\""
1077 ;; some ls -b don't escape quotes, argh!
1078 ;; This is not needed for GNU ls, though.
1079 (or (dired-string-replace-match
1080 "\\([^\\]\\)\"" file "\\1\\\\\"")
1081 file)
1082 "\""))))
1083 ;; If you do this, update dired-insert-subdir-validate too
1084 ;; ((string-match "Q" dired-actual-switches) ; GNU ls
1085 ;; (setq file (read file)))
1086 ))
1087 (if (eq localp 'no-dir)
1088 file
1089 (and file (concat (dired-current-directory localp) file)))))
1090
1091(defun dired-make-absolute (file &optional dir)
1092 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1093 ;; We can't always use expand-file-name as this would get rid of `.'
1094 ;; or expand in / instead default-directory if DIR=="".
1095 ;; This should be good enough for ange-ftp, but might easily be
1096 ;; redefined (for VMS?).
1097 ;; It should be reasonably fast, though, as it is called in
1098 ;; dired-get-filename.
1099 (concat (or dir default-directory) file))
1100
1101(defun dired-make-relative (file &optional dir no-error)
1102 ;;"Convert FILE (an absolute pathname) to a pathname relative to DIR.
1103 ;; Else error (unless NO-ERROR is non-nil, then FILE is returned unchanged)
1104 ;;DIR defaults to default-directory."
1105 ;; DIR must be file-name-as-directory, as with all directory args in
52041219 1106 ;; Emacs Lisp code.
492d2437
RS
1107 (or dir (setq dir default-directory))
1108 (if (string-match (concat "^" (regexp-quote dir)) file)
1109 (substring file (match-end 0))
1110 (if no-error
1111 file
1112 (error "%s: not in directory tree growing at %s" file dir))))
1113\f
1114;;; Functions for finding the file name in a dired buffer line.
1115
1116;; Move to first char of filename on this line.
1117;; Returns position (point) or nil if no filename on this line."
1118(defun dired-move-to-filename (&optional raise-error eol)
1119 ;; This is the UNIX version.
1120 (or eol (setq eol (progn (end-of-line) (point))))
1121 (beginning-of-line)
1122 (if (re-search-forward
1123 "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|Sep\\|Oct\\|Nov\\|Dec\\)[ ]+[0-9]+"
1124 eol t)
1125 (progn
1126 (skip-chars-forward " ") ; there is one SPC after day of month
1127 (skip-chars-forward "^ " eol) ; move after time of day (or year)
1128 (skip-chars-forward " " eol) ; there is space before the file name
1129 ;; Actually, if the year instead of clock time is displayed,
1130 ;; there are (only for some ls programs?) two spaces instead
1131 ;; of one before the name.
1132 ;; If we could depend on ls inserting exactly one SPC we
1133 ;; would not bomb on names _starting_ with SPC.
1134 (point))
1135 (if raise-error
1136 (error "No file on this line")
1137 nil)))
1138
1139(defun dired-move-to-end-of-filename (&optional no-error)
1140 ;; Assumes point is at beginning of filename,
1141 ;; thus the rwx bit re-search-backward below will succeed in *this*
1142 ;; line if at all. So, it should be called only after
1143 ;; (dired-move-to-filename t).
1144 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1145 ;; This is the UNIX version.
1146 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1147 ;; case-fold-search is nil now, so we can test for capital F:
1148 (setq used-F (string-match "F" dired-actual-switches)
1149 opoint (point)
1150 eol (save-excursion (end-of-line) (point))
1151 hidden (and selective-display
1152 (save-excursion (search-forward "\r" eol t))))
1153 (if hidden
1154 nil
1155 (save-excursion;; Find out what kind of file this is:
1156 ;; Restrict perm bits to be non-blank,
1157 ;; otherwise this matches one char to early (looking backward):
1158 ;; "l---------" (some systems make symlinks that way)
1159 ;; "----------" (plain file with zero perms)
1160 (if (re-search-backward
1161 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1162 nil t)
1163 (setq file-type (char-after (match-beginning 1))
1164 symlink (eq file-type ?l)
1165 ;; Only with -F we need to know whether it's an executable
1166 executable (and
1167 used-F
1168 (string-match
1169 "[xst]";; execute bit set anywhere?
1170 (concat
1171 (buffer-substring (match-beginning 2)
1172 (match-end 2))
1173 (buffer-substring (match-beginning 3)
1174 (match-end 3))
1175 (buffer-substring (match-beginning 4)
1176 (match-end 4))))))
1177 (or no-error (error "No file on this line"))))
1178 ;; Move point to end of name:
1179 (if symlink
1180 (if (search-forward " ->" eol t)
1181 (progn
1182 (forward-char -3)
1183 (and used-F
1184 dired-ls-F-marks-symlinks
1185 (eq (preceding-char) ?@);; did ls really mark the link?
1186 (forward-char -1))))
1187 (goto-char eol);; else not a symbolic link
1188 ;; ls -lF marks dirs, sockets and executables with exactly one
1189 ;; trailing character. (Executable bits on symlinks ain't mean
1190 ;; a thing, even to ls, but we know it's not a symlink.)
1191 (and used-F
1192 (or (memq file-type '(?d ?s))
1193 executable)
1194 (forward-char -1))))
1195 (or no-error
1196 (not (eq opoint (point)))
1197 (error (if hidden
1198 (substitute-command-keys
1199 "File line is hidden, type \\[dired-hide-subdir] to unhide")
1200 "No file on this line")))
1201 (if (eq opoint (point))
1202 nil
1203 (point))))
1204
1205\f
1206;; Keeping Dired buffers in sync with the filesystem and with each other
1207
1208(defvar dired-buffers nil
1209 ;; Enlarged by dired-advertise
1210 ;; Queried by function dired-buffers-for-dir. When this detects a
1211 ;; killed buffer, it is removed from this list.
1212 "Alist of directories and their associated dired buffers.")
1213
1214(defun dired-buffers-for-dir (dir)
1215;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1216;; The list is in reverse order of buffer creation, most recent last.
1217;; As a side effect, killed dired buffers for DIR are removed from
1218;; dired-buffers.
1219 (setq dir (file-name-as-directory dir))
1220 (let ((alist dired-buffers) result elt)
1221 (while alist
1222 (setq elt (car alist))
1223 (if (dired-in-this-tree dir (car elt))
1224 (let ((buf (cdr elt)))
1225 (if (buffer-name buf)
1226 (if (assoc dir (save-excursion
1227 (set-buffer buf)
1228 dired-subdir-alist))
1229 (setq result (cons buf result)))
1230 ;; else buffer is killed - clean up:
1231 (setq dired-buffers (delq elt dired-buffers)))))
1232 (setq alist (cdr alist)))
1233 result))
1234
1235(defun dired-advertise ()
1236 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1237 ;; With wildcards we actually advertise too much.
1238 (if (memq (current-buffer) (dired-buffers-for-dir default-directory))
1239 t ; we have already advertised ourselves
1240 (setq dired-buffers
1241 (cons (cons default-directory (current-buffer))
1242 dired-buffers))))
1243
1244(defun dired-unadvertise (dir)
1245 ;; Remove DIR from the buffer alist in variable dired-buffers.
1246 ;; This has the effect of removing any buffer whose main directory is DIR.
1247 ;; It does not affect buffers in which DIR is a subdir.
1248 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1249 (setq dired-buffers
1250 (delq (assoc dir dired-buffers) dired-buffers)))
1251\f
1252;; Tree Dired
1253
1254;;; utility functions
1255
1256(defun dired-in-this-tree (file dir)
1257 ;;"Is FILE part of the directory tree starting at DIR?"
1258 (let (case-fold-search)
1259 (string-match (concat "^" (regexp-quote dir)) file)))
1260
1261(defun dired-normalize-subdir (dir)
1262 ;; Prepend default-directory to DIR if relative path name.
1263 ;; dired-get-filename must be able to make a valid filename from a
1264 ;; file and its directory DIR.
1265 (file-name-as-directory
1266 (if (file-name-absolute-p dir)
1267 dir
1268 (expand-file-name dir default-directory))))
1269
1270(defun dired-get-subdir ()
1271 ;;"Return the subdir name on this line, or nil if not on a headerline."
1272 ;; Look up in the alist whether this is a headerline.
1273 (save-excursion
1274 (let ((cur-dir (dired-current-directory)))
1275 (beginning-of-line) ; alist stores b-o-l positions
1276 (and (zerop (- (point)
1277 (dired-get-subdir-min (assoc cur-dir
1278 dired-subdir-alist))))
1279 cur-dir))))
1280
1281;(defun dired-get-subdir-min (elt)
1282; (cdr elt))
1283;; can't use macro, must be redefinable for other alist format in dired-nstd.
62f61df0 1284(defalias 'dired-get-subdir-min 'cdr)
492d2437
RS
1285
1286(defun dired-get-subdir-max (elt)
84fc2cfa 1287 (save-excursion
492d2437
RS
1288 (goto-char (dired-get-subdir-min elt))
1289 (dired-subdir-max)))
1290
1291(defun dired-clear-alist ()
1292 (while dired-subdir-alist
1293 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1294 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1295
c9d59fc2
RS
1296(defun dired-subdir-index (dir)
1297 ;; Return an index into alist for use with nth
1298 ;; for the sake of subdir moving commands.
1299 (let (found (index 0) (alist dired-subdir-alist))
1300 (while alist
1301 (if (string= dir (car (car alist)))
1302 (setq alist nil found t)
1303 (setq alist (cdr alist) index (1+ index))))
1304 (if found index nil)))
1305
1306(defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1307 "Go to next subdirectory, regardless of level."
1308 ;; Use 0 arg to go to this directory's header line.
1309 ;; NO-SKIP prevents moving to end of header line, returning whatever
1310 ;; position was found in dired-subdir-alist.
1311 (interactive "p")
1312 (let ((this-dir (dired-current-directory))
1313 pos index)
1314 ;; nth with negative arg does not return nil but the first element
1315 (setq index (- (dired-subdir-index this-dir) arg))
1316 (setq pos (if (>= index 0)
1317 (dired-get-subdir-min (nth index dired-subdir-alist))))
1318 (if pos
1319 (progn
1320 (goto-char pos)
1321 (or no-skip (skip-chars-forward "^\n\r"))
1322 (point))
1323 (if no-error-if-not-found
1324 nil ; return nil if not found
1325 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1326
492d2437
RS
1327(defun dired-build-subdir-alist ()
1328 "Build `dired-subdir-alist' by parsing the buffer.
1329Returns the new value of the alist."
1330 (interactive)
1331 (dired-clear-alist)
1332 (save-excursion
1333 (let ((count 0))
84fc2cfa 1334 (goto-char (point-min))
492d2437
RS
1335 (setq dired-subdir-alist nil)
1336 (while (re-search-forward dired-subdir-regexp nil t)
1337 (setq count (1+ count))
1338 (dired-alist-add-1 (buffer-substring (match-beginning 1)
1339 (match-end 1))
1340 ;; Put subdir boundary between lines:
1341 (save-excursion
1342 (goto-char (match-beginning 0))
1343 (beginning-of-line)
c9d59fc2
RS
1344 (point-marker))))
1345 (if (> count 1)
1346 (message "Buffer includes %d directories" count))
492d2437
RS
1347 ;; We don't need to sort it because it is in buffer order per
1348 ;; constructionem. Return new alist:
1349 dired-subdir-alist)))
1350
1351(defun dired-alist-add-1 (dir new-marker)
1352 ;; Add new DIR at NEW-MARKER. Don't sort.
1353 (setq dired-subdir-alist
1354 (cons (cons (dired-normalize-subdir dir) new-marker)
1355 dired-subdir-alist)))
1356
1357(defun dired-goto-next-nontrivial-file ()
1358 ;; Position point on first nontrivial file after point.
1359 (dired-goto-next-file);; so there is a file to compare with
1360 (if (stringp dired-trivial-filenames)
1361 (while (and (not (eobp))
1362 (string-match dired-trivial-filenames
1363 (file-name-nondirectory
1364 (or (dired-get-filename nil t) ""))))
1365 (forward-line 1)
1366 (dired-move-to-filename))))
1367
1368(defun dired-goto-next-file ()
1369 (let ((max (1- (dired-subdir-max))))
1370 (while (and (not (dired-move-to-filename)) (< (point) max))
1371 (forward-line 1))))
1372
1373(defun dired-goto-file (file)
1374 "Go to file line of FILE in this dired buffer."
1375 ;; Return value of point on success, else nil.
1376 ;; FILE must be an absolute pathname.
1377 ;; Loses if FILE contains control chars like "\007" for which ls
1378 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1379 ;; it in the buffer.
1380 (interactive
1381 (prog1 ; let push-mark display its message
1382 (list (expand-file-name
1383 (read-file-name "Goto file: "
1384 (dired-current-directory))))
1385 (push-mark)))
1386 (setq file (directory-file-name file)) ; does no harm if no directory
1387 (let (found case-fold-search dir)
1388 (setq dir (or (file-name-directory file)
1389 (error "Need absolute pathname for %s" file)))
1390 (save-excursion
1391 ;; The hair here is to get the result of dired-goto-subdir
1392 ;; without really calling it if we don't have any subdirs.
1393 (if (if (string= dir default-directory)
1394 (goto-char (point-min))
7b2469ae 1395 (and (cdr dired-subdir-alist)
492d2437
RS
1396 (dired-goto-subdir dir)))
1397 (let ((base (file-name-nondirectory file))
1398 (boundary (dired-subdir-max)))
1399 (while (and (not found)
1400 ;; filenames are preceded by SPC, this makes
1401 ;; the search faster (e.g. for the filename "-"!).
1402 (search-forward (concat " " base) boundary 'move))
1403 ;; Match could have BASE just as initial substring or
1404 ;; or in permission bits or date or
1405 ;; not be a proper filename at all:
1406 (if (equal base (dired-get-filename 'no-dir t))
1407 ;; Must move to filename since an (actually
1408 ;; correct) match could have been elsewhere on the
1409 ;; ;; line (e.g. "-" would match somewhere in the
1410 ;; permission bits).
1411 (setq found (dired-move-to-filename)))))))
1412 (and found
1413 ;; return value of point (i.e., FOUND):
1414 (goto-char found))))
1415
1416(defun dired-initial-position (dirname)
1417 ;; Where point should go in a new listing of DIRNAME.
1418 ;; Point assumed at beginning of new subdir line.
1419 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1420 (end-of-line)
1421 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1422\f
1423;; These are hooks which make tree dired work.
1424;; They are in this file because other parts of dired need to call them.
1425;; But they don't call the rest of tree dired unless there are subdirs loaded.
1426
1427;; This function is called for each retrieved filename.
1428;; It could stand to be faster, though it's mostly function call
1429;; overhead. Avoiding the function call seems to save about 10% in
1430;; dired-get-filename. Make it a defsubst?
1431(defun dired-current-directory (&optional localp)
1432 "Return the name of the subdirectory to which this line belongs.
1433This returns a string with trailing slash, like `default-directory'.
1434Optional argument means return a file name relative to `default-directory'."
1435 (let ((here (point))
1436 (alist (or dired-subdir-alist
1437 ;; probably because called in a non-dired buffer
1438 (error "No subdir-alist in %s" (current-buffer))))
1439 elt dir)
1440 (while alist
1441 (setq elt (car alist)
1442 dir (car elt)
1443 ;; use `<=' (not `<') as subdir line is part of subdir
1444 alist (if (<= (dired-get-subdir-min elt) here)
1445 nil ; found
1446 (cdr alist))))
1447 (if localp
1448 (dired-make-relative dir default-directory)
1449 dir)))
1450
1451;; Subdirs start at the beginning of their header lines and end just
1452;; before the beginning of the next header line (or end of buffer).
1453
1454(defun dired-subdir-max ()
1455 (save-excursion
7b2469ae 1456 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
492d2437
RS
1457 (point-max)
1458 (point))))
1459\f
1460;; Deleting files
1461
1462(defun dired-do-flagged-delete ()
1463 "In dired, delete the files flagged for deletion."
1464 (interactive)
1465 (let* ((dired-marker-char dired-del-marker)
1466 (regexp (dired-marker-regexp))
1467 case-fold-search)
1468 (if (save-excursion (goto-char (point-min))
1469 (re-search-forward regexp nil t))
1470 (dired-internal-do-deletions
1471 ;; this can't move point since ARG is nil
1472 (dired-map-over-marks (cons (dired-get-filename) (point))
1473 nil)
1474 nil)
1475 (message "(No deletions requested)"))))
1476
1477(defun dired-do-delete (&optional arg)
1478 "Delete all marked (or next ARG) files."
1479 ;; This is more consistent with the file marking feature than
1480 ;; dired-do-flagged-delete.
1481 (interactive "P")
1482 (dired-internal-do-deletions
1483 ;; this may move point if ARG is an integer
1484 (dired-map-over-marks (cons (dired-get-filename) (point))
1485 arg)
1486 arg))
1487
1488(defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
1489
1490(defun dired-internal-do-deletions (l arg)
1491 ;; L is an alist of files to delete, with their buffer positions.
1492 ;; ARG is the prefix arg.
1493 ;; Filenames are absolute (VMS needs this for logical search paths).
1494 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
1495 ;; That way as changes are made in the buffer they do not shift the
1496 ;; lines still to be changed, so the (point) values in L stay valid.
1497 ;; Also, for subdirs in natural order, a subdir's files are deleted
1498 ;; before the subdir itself - the other way around would not work.
1499 (let ((files (mapcar (function car) l))
1500 (count (length l))
1501 (succ 0))
1502 ;; canonicalize file list for pop up
1503 (setq files (nreverse (mapcar (function dired-make-relative) files)))
1504 (if (dired-mark-pop-up
1505 " *Deletions*" 'delete files dired-deletion-confirmer
1506 (format "Delete %s " (dired-mark-prompt arg files)))
84fc2cfa 1507 (save-excursion
492d2437
RS
1508 (let (failures);; files better be in reverse order for this loop!
1509 (while l
1510 (goto-char (cdr (car l)))
1511 (let (buffer-read-only)
1512 (condition-case err
1513 (let ((fn (car (car l))))
1514 ;; This test is equivalent to
1515 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1516 ;; but more efficient
1517 (if (eq t (car (file-attributes fn)))
ab67260b 1518 (delete-directory fn)
492d2437
RS
1519 (delete-file fn))
1520 ;; if we get here, removing worked
1521 (setq succ (1+ succ))
1522 (message "%s of %s deletions" succ count)
1523 (delete-region (progn (beginning-of-line) (point))
1524 (progn (forward-line 1) (point)))
1525 (dired-clean-up-after-deletion fn))
1526 (error;; catch errors from failed deletions
1527 (dired-log "%s\n" err)
1528 (setq failures (cons (car (car l)) failures)))))
1529 (setq l (cdr l)))
1530 (if (not failures)
1531 (message "%d deletion%s done" count (dired-plural-s count))
1532 (dired-log-summary
1533 (format "%d of %d deletion%s failed"
1534 (length failures) count
1535 (dired-plural-s count))
1536 failures))))
1537 (message "(No deletions performed)")))
1538 (dired-move-to-filename))
1539
1540;; This is a separate function for the sake of dired-x.el.
1541(defun dired-clean-up-after-deletion (fn)
1542 ;; Clean up after a deleted file or directory FN.
7b2469ae
RS
1543 (save-excursion (and (cdr dired-subdir-alist)
1544 (dired-goto-subdir fn)
492d2437
RS
1545 (dired-kill-subdir))))
1546\f
1547;; Confirmation
1548
1549(defun dired-marker-regexp ()
1550 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
1551
1552(defun dired-plural-s (count)
1553 (if (= 1 count) "" "s"))
1554
1555(defun dired-mark-prompt (arg files)
1556 ;; Return a string for use in a prompt, either the current file
1557 ;; name, or the marker and a count of marked files.
1558 (let ((count (length files)))
1559 (if (= count 1)
1560 (car files)
1561 ;; more than 1 file:
1562 (if (integerp arg)
1563 ;; abs(arg) = count
1564 ;; Perhaps this is nicer, but it also takes more screen space:
1565 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
1566 ;; count)
1567 (format "[next %d files]" arg)
1568 (format "%c [%d files]" dired-marker-char count)))))
1569
1570(defun dired-pop-to-buffer (buf)
1571 ;; Pop up buffer BUF.
1572 ;; If dired-shrink-to-fit is t, make its window fit its contents.
1573 (if (not dired-shrink-to-fit)
1574 (pop-to-buffer (get-buffer-create buf))
1575 ;; let window shrink to fit:
1576 (let ((window (selected-window))
1577 target-lines w2)
1578 (cond ;; if split-window-threshold is enabled, use the largest window
1579 ((and (> (window-height (setq w2 (get-largest-window)))
1580 split-height-threshold)
f98955ea 1581 (= (frame-width) (window-width w2)))
492d2437
RS
1582 (setq window w2))
1583 ;; if the least-recently-used window is big enough, use it
1584 ((and (> (window-height (setq w2 (get-lru-window)))
1585 (* 2 window-min-height))
f98955ea 1586 (= (frame-width) (window-width w2)))
492d2437
RS
1587 (setq window w2)))
1588 (save-excursion
1589 (set-buffer buf)
1590 (goto-char (point-max))
1591 (skip-chars-backward "\n\r\t ")
63ea14a5
RS
1592 (setq target-lines (count-lines (point-min) (point)))
1593 ;; Don't forget to count the last line.
1594 (if (not (bolp))
1595 (setq target-lines (1+ target-lines))))
492d2437 1596 (if (<= (window-height window) (* 2 window-min-height))
f98955ea 1597 ;; At this point, every window on the frame is too small to split.
492d2437
RS
1598 (setq w2 (display-buffer buf))
1599 (setq w2 (split-window window
1600 (max window-min-height
1601 (- (window-height window)
1602 (1+ (max window-min-height target-lines)))))))
1603 (set-window-buffer w2 buf)
1604 (if (< (1- (window-height w2)) target-lines)
1605 (progn
1606 (select-window w2)
1607 (enlarge-window (- target-lines (1- (window-height w2))))))
1608 (set-window-start w2 1)
1609 )))
1610
1611(defvar dired-no-confirm nil
1612;; "If non-nil, list of symbols for commands dired should not confirm.
1613;;It can be a sublist of
1614;;
1615;; '(byte-compile chgrp chmod chown compress copy delete hardlink load
1616;; move print shell symlink uncompress)"
1617 )
1618
1619(defun dired-mark-pop-up (bufname op-symbol files function &rest args)
1620 ;;"Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
1621 ;;Return FUNCTION's result on ARGS after popping up a window (in a buffer
1622 ;;named BUFNAME, nil gives \" *Marked Files*\") showing the marked
1623 ;;files. Uses function `dired-pop-to-buffer' to do that.
1624 ;; FUNCTION should not manipulate files.
1625 ;; It should only read input (an argument or confirmation).
1626 ;;The window is not shown if there is just one file or
1627 ;; OP-SYMBOL is a member of the list in `dired-no-confirm'.
1628 ;;FILES is the list of marked files."
1629 (or bufname (setq bufname " *Marked Files*"))
1630 (if (or (memq op-symbol dired-no-confirm)
1631 (= (length files) 1))
1632 (apply function args)
1633 (save-excursion
1634 (set-buffer (get-buffer-create bufname))
1635 (erase-buffer)
1636 (dired-format-columns-of-files files))
1637 (save-window-excursion
1638 (dired-pop-to-buffer bufname)
1639 (apply function args))))
1640
1641(defun dired-format-columns-of-files (files)
1642 ;; Files should be in forward order for this loop.
1643 ;; i.e., (car files) = first file in buffer.
1644 ;; Returns the number of lines used.
1645 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
1646 (width (- (window-width (selected-window)) 2))
1647 (columns (max 1 (/ width maxlen)))
1648 (nfiles (length files))
1649 (rows (+ (/ nfiles columns)
1650 (if (zerop (% nfiles columns)) 0 1)))
1651 (i 0)
1652 (j 0))
1653 (setq files (nconc (copy-sequence files) ; fill up with empty fns
1654 (make-list (- (* columns rows) nfiles) "")))
1655 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
1656 (while (< j rows)
1657 (while (< i columns)
1658 (indent-to (* i maxlen))
1659 (insert (car files))
1660 (setq files (nthcdr rows files)
1661 i (1+ i)))
1662 (insert "\n")
1663 (setq i 0
1664 j (1+ j)
1665 files (cdr files)))
1666 rows))
1667\f
1668;; Commands to mark or flag file(s) at or near current line.
1669
1670(defun dired-repeat-over-lines (arg function)
1671 ;; This version skips non-file lines.
cfe89c4f 1672 (let ((pos (make-marker)))
492d2437 1673 (beginning-of-line)
cfe89c4f
RS
1674 (while (and (> arg 0) (not (eobp)))
1675 (setq arg (1- arg))
1676 (beginning-of-line)
1677 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
1678 (save-excursion
1679 (forward-line 1)
1680 (move-marker pos (1+ (point))))
1681 (save-excursion (funcall function))
1682 ;; Advance to the next line--actually, to the line that *was* next.
1683 ;; (If FUNCTION inserted some new lines in between, skip them.)
1684 (goto-char pos))
1685 (while (and (< arg 0) (not (bobp)))
1686 (setq arg (1+ arg))
1687 (forward-line -1)
1688 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
1689 (beginning-of-line)
1690 (save-excursion (funcall function)))
1691 (move-marker pos nil)
1692 (dired-move-to-filename)))
492d2437
RS
1693
1694(defun dired-between-files ()
1695 ;; Point must be at beginning of line
1696 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
1697 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
1698 (or (looking-at "^$\\|^. *$\\|^. total\\|^. wildcard")
1699 (looking-at dired-subdir-regexp)))
1700
1701(defun dired-next-marked-file (arg &optional wrap opoint)
1702 "Move to the next marked file, wrapping around the end of the buffer."
1703 (interactive "p\np")
1704 (or opoint (setq opoint (point)));; return to where interactively started
1705 (if (if (> arg 0)
1706 (re-search-forward dired-re-mark nil t arg)
1707 (beginning-of-line)
1708 (re-search-backward dired-re-mark nil t (- arg)))
1709 (dired-move-to-filename)
1710 (if (null wrap)
1711 (progn
1712 (goto-char opoint)
1713 (error "No next marked file"))
1714 (message "(Wraparound for next marked file)")
1715 (goto-char (if (> arg 0) (point-min) (point-max)))
1716 (dired-next-marked-file arg nil opoint))))
1717
1718(defun dired-prev-marked-file (arg &optional wrap)
1719 "Move to the previous marked file, wrapping around the end of the buffer."
1720 (interactive "p\np")
1721 (dired-next-marked-file (- arg) wrap))
1722
1723(defun dired-file-marker (file)
1724 ;; Return FILE's marker, or nil if unmarked.
1725 (save-excursion
1726 (and (dired-goto-file file)
1727 (progn
1728 (beginning-of-line)
1729 (if (not (equal ?\040 (following-char)))
1730 (following-char))))))
1731
1732(defun dired-mark-files-in-region (start end)
1733 (let (buffer-read-only)
1734 (if (> start end)
1735 (error "start > end"))
1736 (goto-char start) ; assumed at beginning of line
1737 (while (< (point) end)
1738 ;; Skip subdir line and following garbage like the `total' line:
1739 (while (and (< (point) end) (dired-between-files))
1740 (forward-line 1))
1741 (if (and (not (looking-at dired-re-dot))
1742 (dired-get-filename nil t))
1743 (progn
1744 (delete-char 1)
1745 (insert dired-marker-char)))
1746 (forward-line 1))))
1747
1748(defun dired-mark (arg)
1749 "Mark the current (or next ARG) files.
1750If on a subdir headerline, mark all its files except `.' and `..'.
1751
1752Use \\[dired-unmark-all-files] to remove all marks
1753and \\[dired-unmark] on a subdir to remove the marks in
1754this subdir."
1755 (interactive "P")
7b2469ae 1756 (if (and (cdr dired-subdir-alist) (dired-get-subdir))
492d2437
RS
1757 (save-excursion (dired-mark-subdir-files))
1758 (let (buffer-read-only)
1759 (dired-repeat-over-lines
52041219 1760 (prefix-numeric-value arg)
492d2437
RS
1761 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
1762
1763(defun dired-unmark (arg)
1764 "Unmark the current (or next ARG) files.
1765If looking at a subdir, unmark all its files except `.' and `..'."
1766 (interactive "P")
1767 (let ((dired-marker-char ?\040))
1768 (dired-mark arg)))
1769
1770(defun dired-flag-file-deletion (arg)
1771 "In dired, flag the current line's file for deletion.
1772With prefix arg, repeat over several lines.
1773
1774If on a subdir headerline, mark all its files except `.' and `..'."
1775 (interactive "P")
1776 (let ((dired-marker-char dired-del-marker))
1777 (dired-mark arg)))
1778
1779(defun dired-unmark-backward (arg)
1780 "In dired, move up lines and remove deletion flag there.
1781Optional prefix ARG says how many lines to unflag; default is one line."
1782 (interactive "p")
1783 (dired-unmark (- arg)))
84fc2cfa 1784\f
492d2437
RS
1785;;; Commands to mark or flag files based on their characteristics or names.
1786
d2cadc4b
RS
1787(defvar dired-regexp-history nil
1788 "History list of regular expressions used in Dired commands.")
1789
1790(defun dired-read-regexp (prompt)
1791 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
492d2437
RS
1792
1793(defun dired-mark-files-regexp (regexp &optional marker-char)
1794 "Mark all files matching REGEXP for use in later commands.
1795A prefix argument means to unmark them instead.
1796`.' and `..' are never marked.
1797
1798REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
1799object files--just `.o' will mark more than you might think."
1800 (interactive
1801 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
1802 " files (regexp): "))
1803 (if current-prefix-arg ?\040)))
1804 (let ((dired-marker-char (or marker-char dired-marker-char)))
1805 (dired-mark-if
1806 (and (not (looking-at dired-re-dot))
1807 (not (eolp)) ; empty line
1808 (let ((fn (dired-get-filename nil t)))
1809 (and fn (string-match regexp (file-name-nondirectory fn)))))
1810 "matching file")))
1811
1812(defun dired-flag-files-regexp (regexp)
1813 "In dired, flag all files containing the specified REGEXP for deletion.
1814The match is against the non-directory part of the filename. Use `^'
1815 and `$' to anchor matches. Exclude subdirs by hiding them.
1816`.' and `..' are never flagged."
1817 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
1818 (dired-mark-files-regexp regexp dired-del-marker))
1819
1820(defun dired-mark-symlinks (unflag-p)
1821 "Mark all symbolic links.
1822With prefix argument, unflag all those files."
1823 (interactive "P")
1824 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
1825 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
1826
1827(defun dired-mark-directories (unflag-p)
1828 "Mark all directory file lines except `.' and `..'.
1829With prefix argument, unflag all those files."
1830 (interactive "P")
1831 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
1832 (dired-mark-if (and (looking-at dired-re-dir)
1833 (not (looking-at dired-re-dot)))
1834 "directory file")))
1835
1836(defun dired-mark-executables (unflag-p)
1837 "Mark all executable files.
1838With prefix argument, unflag all those files."
1839 (interactive "P")
1840 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
1841 (dired-mark-if (looking-at dired-re-exe) "executable file")))
1842
1843;; dired-x.el has a dired-mark-sexp interactive command: mark
1844;; files for which PREDICATE returns non-nil.
1845
1846(defun dired-flag-auto-save-files (&optional unflag-p)
84fc2cfa
ER
1847 "Flag for deletion files whose names suggest they are auto save files.
1848A prefix argument says to unflag those files instead."
1849 (interactive "P")
492d2437
RS
1850 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
1851 (dired-mark-if
2a838614 1852 ;; It is less than general to check for # here,
a91526b9
RS
1853 ;; but it's the only way this runs fast enough.
1854 (and (save-excursion (end-of-line)
536ae2dd
RS
1855 (or
1856 (eq (preceding-char) ?#)
1857 ;; Handle executables in case of -F option.
1858 ;; We need not worry about the other kinds
1859 ;; of markings that -F makes, since they won't
1860 ;; appear on real auto-save files.
1861 (if (eq (preceding-char) ?*)
1862 (progn
1863 (forward-char -1)
1864 (eq (preceding-char) ?#)))))
a91526b9
RS
1865 (not (looking-at dired-re-dir))
1866 (let ((fn (dired-get-filename t t)))
1867 (if fn (auto-save-file-name-p
1868 (file-name-nondirectory fn)))))
1869 "auto save file")))
492d2437
RS
1870
1871(defun dired-flag-backup-files (&optional unflag-p)
1872 "Flag all backup files (names ending with `~') for deletion.
1873With prefix argument, unflag these files."
1874 (interactive "P")
1875 (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
1876 (dired-mark-if
a91526b9
RS
1877 ;; It is less than general to check for ~ here,
1878 ;; but it's the only way this runs fast enough.
1879 (and (save-excursion (end-of-line)
536ae2dd
RS
1880 (or
1881 (eq (preceding-char) ?~)
1882 ;; Handle executables in case of -F option.
1883 ;; We need not worry about the other kinds
1884 ;; of markings that -F makes, since they won't
1885 ;; appear on real backup files.
1886 (if (eq (preceding-char) ?*)
1887 (progn
1888 (forward-char -1)
1889 (eq (preceding-char) ?~)))))
a91526b9 1890 (not (looking-at dired-re-dir))
492d2437
RS
1891 (let ((fn (dired-get-filename t t)))
1892 (if fn (backup-file-name-p fn))))
1893 "backup file")))
1894
6482fcac
RS
1895(defun dired-change-marks (&optional old new)
1896 "Change all OLD marks to NEW marks.
1897OLD and NEW are both characters used to mark files."
1898 (interactive
1899 (let* ((cursor-in-echo-area t)
1900 (old (progn (message "Change (old mark): ") (read-char)))
1901 (new (progn (message "Change %c marks to (new mark): " old)
1902 (read-char))))
1903 (list old new)))
e4e02841
RS
1904 (if (or (eq old ?\r) (eq new ?\r))
1905 (ding)
1906 (let ((string (format "\n%c" old))
1907 (buffer-read-only))
1908 (save-excursion
1909 (goto-char (point-min))
1910 (while (search-forward string nil t)
1911 (subst-char-in-region (match-beginning 0)
1912 (match-end 0) old new))))))
6482fcac 1913
b1ecd9c6
RS
1914(defun dired-unmark-all-files-no-query ()
1915 "Remove all marks from all files in the Dired buffer."
1916 (interactive)
1917 (dired-unmark-all-files ?\r))
1918
8b87a301 1919(defun dired-unmark-all-files (mark &optional arg)
b602ba2f
RS
1920 "Remove a specific mark (or any mark) from every file.
1921After this command, type the mark character to remove,
1922or type RET to remove all marks.
3585916f 1923With prefix arg, query for each marked file.
492d2437 1924Type \\[help-command] at that time for help."
b602ba2f
RS
1925 (interactive "cRemove marks (RET means all): \nP")
1926 (save-excursion
1927 (let* ((count 0)
1928 buffer-read-only case-fold-search query
1929 (string (format "\n%c" mark))
1930 (help-form "\
8b87a301
RS
1931Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
1932`!' to unmark all remaining files with no more questions."))
b602ba2f
RS
1933 (goto-char (point-min))
1934 (while (if (eq mark ?\r)
1935 (re-search-forward dired-re-mark nil t)
1936 (search-forward string nil t))
1937 (if (or (not arg)
1938 (dired-query 'query "Unmark file `%s'? "
1939 (dired-get-filename t)))
1940 (progn (subst-char-in-region (1- (point)) (point)
1941 (preceding-char) ?\ )
1942 (setq count (1+ count)))))
1943 (message (if (= count 1) "1 mark removed"
1944 "%d marks removed")
1945 count))))
492d2437 1946\f
492d2437 1947;; Logging failures operating on files, and showing the results.
84fc2cfa 1948
492d2437 1949(defvar dired-log-buffer "*Dired log*")
84fc2cfa 1950
492d2437
RS
1951(defun dired-why ()
1952 "Pop up a buffer with error log output from Dired.
1953A group of errors from a single command ends with a formfeed.
1954Thus, use \\[backward-page] to find the beginning of a group of errors."
1955 (interactive)
1956 (if (get-buffer dired-log-buffer)
1957 (let ((owindow (selected-window))
1958 (window (display-buffer (get-buffer dired-log-buffer))))
1959 (unwind-protect
6482fcac 1960 (progn
492d2437
RS
1961 (select-window window)
1962 (goto-char (point-max))
1963 (recenter -1))
1964 (select-window owindow)))))
1965
1966(defun dired-log (log &rest args)
1967 ;; Log a message or the contents of a buffer.
1968 ;; If LOG is a string and there are more args, it is formatted with
1969 ;; those ARGS. Usually the LOG string ends with a \n.
1970 ;; End each bunch of errors with (dired-log t): this inserts
1971 ;; current time and buffer, and a \f (formfeed).
1972 (let ((obuf (current-buffer)))
1973 (unwind-protect ; want to move point
1974 (progn
1975 (set-buffer (get-buffer-create dired-log-buffer))
1976 (goto-char (point-max))
1977 (let (buffer-read-only)
1978 (cond ((stringp log)
1979 (insert (if args
1980 (apply (function format) log args)
1981 log)))
1982 ((bufferp log)
1983 (insert-buffer log))
1984 ((eq t log)
1985 (insert "\n\t" (current-time-string)
1986 "\tBuffer `" (buffer-name obuf) "'\n\f\n")))))
1987 (set-buffer obuf))))
1988
1989(defun dired-log-summary (string failures)
1990 (message (if failures "%s--type ? for details (%s)"
1991 "%s--type ? for details")
1992 string failures)
1993 ;; Log a summary describing a bunch of errors.
1994 (dired-log (concat "\n" string))
1995 (dired-log t))
1996\f
1997;;; Sorting
1998
1999;; Most ls can only sort by name or by date (with -t), nothing else.
2000;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2001;; So anything that does not contain these is sort "by name".
2002
2003(defvar dired-ls-sorting-switches "SXU"
2004 "String of `ls' switches (single letters) except `t' that influence sorting.")
2005
2006(defvar dired-sort-by-date-regexp
2007 (concat "^-[^" dired-ls-sorting-switches
2008 "]*t[^" dired-ls-sorting-switches "]*$")
2009 "Regexp recognized by dired to set `by date' mode.")
2010
2011(defvar dired-sort-by-name-regexp
2012 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2013 "Regexp recognized by dired to set `by name' mode.")
2014
2015(defvar dired-sort-mode nil
2016 "Whether Dired sorts by name, date etc. (buffer-local).")
2017;; This is nil outside dired buffers so it can be used in the modeline
2018
2019(defun dired-sort-set-modeline ()
2020 ;; Set modeline display according to dired-actual-switches.
2021 ;; Modeline display of "by name" or "by date" guarantees the user a
2022 ;; match with the corresponding regexps. Non-matching switches are
2023 ;; shown literally.
2024 (setq dired-sort-mode
2025 (let (case-fold-search)
2026 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2027 " by name")
2028 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2029 " by date")
2030 (t
2031 (concat " " dired-actual-switches)))))
2032 ;; update mode line:
2033 (set-buffer-modified-p (buffer-modified-p)))
2034
2035(defun dired-sort-toggle-or-edit (&optional arg)
2036 "Toggle between sort by date/name and refresh the dired buffer.
2037With a prefix argument you can edit the current listing switches instead."
84fc2cfa 2038 (interactive "P")
492d2437
RS
2039 (if arg
2040 (dired-sort-other
2041 (read-string "ls switches (must contain -l): " dired-actual-switches))
2042 (dired-sort-toggle)))
2043
2044(defun dired-sort-toggle ()
2045 ;; Toggle between sort by date/name. Reverts the buffer.
2046 (setq dired-actual-switches
2047 (let (case-fold-search)
2048 (concat
2049 "-l"
2050 (dired-replace-in-string (concat "[---lt"
2051 dired-ls-sorting-switches "]")
2052 ""
2053 dired-actual-switches)
2054 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2055 dired-actual-switches)
2056 ""
2057 "t"))))
2058 (dired-sort-set-modeline)
2059 (revert-buffer))
2060
2061(defun dired-replace-in-string (regexp newtext string)
2062 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2063 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2064 (let ((result "") (start 0) mb me)
2065 (while (string-match regexp string start)
2066 (setq mb (match-beginning 0)
2067 me (match-end 0)
2068 result (concat result (substring string start mb) newtext)
2069 start me))
2070 (concat result (substring string start))))
2071
2072(defun dired-sort-other (switches &optional no-revert)
2073 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2074 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2075 ;; minor mode accordingly, others appear literally in the mode line.
2076 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2077 (setq dired-actual-switches switches)
2078 (dired-sort-set-modeline)
2079 (or no-revert (revert-buffer)))
84fc2cfa 2080\f
492d2437
RS
2081;; To make this file smaller, the less common commands
2082;; go in a separate file. But autoload them here
2083;; to make the separation invisible.
2084
2085(autoload 'dired-diff "dired-aux"
2086 "Compare file at point with file FILE using `diff'.
2087FILE defaults to the file at the mark.
ab67260b 2088The prompted-for file is the first file given to `diff'."
492d2437
RS
2089 t)
2090
2091(autoload 'dired-backup-diff "dired-aux"
2092 "Diff this file with its backup file or vice versa.
2093Uses the latest backup, if there are several numerical backups.
2094If this file is a backup, diff it with its original.
ab67260b 2095The backup file is the first file given to `diff'."
492d2437
RS
2096 t)
2097
2d051399
RS
2098(autoload 'dired-clean-directory "dired-aux"
2099 "Flag numerical backups for deletion.
2100Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2101Positive prefix arg KEEP overrides `dired-kept-versions';
2102Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2103
2104To clear the flags on these files, you can use \\[dired-flag-backup-files]
2105with a prefix argument."
2106 t)
2107
492d2437
RS
2108(autoload 'dired-do-chmod "dired-aux"
2109 "Change the mode of the marked (or next ARG) files.
2110This calls chmod, thus symbolic modes like `g+w' are allowed."
2111 t)
2112
2113(autoload 'dired-do-chgrp "dired-aux"
2114 "Change the group of the marked (or next ARG) files."
2115 t)
2116
2117(autoload 'dired-do-chown "dired-aux"
2118 "Change the owner of the marked (or next ARG) files."
2119 t)
2120
2121(autoload 'dired-do-print "dired-aux"
2122 "Print the marked (or next ARG) files.
2123Uses the shell command coming from variables `lpr-command' and
2124`lpr-switches' as default."
2125 t)
2126
2127(autoload 'dired-do-shell-command "dired-aux"
6482fcac
RS
2128 "Run a shell command COMMAND on the marked files.
2129If no files are marked or a specific numeric prefix arg is given,
2130the next ARG files are used. Just \\[universal-argument] means the current file.
2131The prompt mentions the file(s) or the marker, as appropriate.
2132
492d2437 2133If there is output, it goes to a separate buffer.
6482fcac 2134
492d2437
RS
2135Normally the command is run on each file individually.
2136However, if there is a `*' in the command then it is run
2137just once with the entire file list substituted there.
2138
6482fcac
RS
2139No automatic redisplay of dired buffers is attempted, as there's no
2140telling what files the command may have changed. Type
2141\\[dired-do-redisplay] to redisplay the marked files.
492d2437
RS
2142
2143The shell command has the top level directory as working directory, so
2144output files usually are created there instead of in a subdir."
2145 t)
2146
492d2437
RS
2147(autoload 'dired-do-kill-lines "dired-aux"
2148 "Kill all marked lines (not the files).
2149With a prefix arg, kill all lines not marked or flagged."
2150 t)
2151
2152(autoload 'dired-do-compress "dired-aux"
2153 "Compress or uncompress marked (or next ARG) files."
2154 t)
2155
2156(autoload 'dired-do-byte-compile "dired-aux"
2157 "Byte compile marked (or next ARG) Emacs Lisp files."
2158 t)
2159
2160(autoload 'dired-do-load "dired-aux"
2161 "Load the marked (or next ARG) Emacs Lisp files."
2162 t)
2163
2164(autoload 'dired-do-redisplay "dired-aux"
2165 "Redisplay all marked (or next ARG) files.
2166If on a subdir line, redisplay that subdirectory. In that case,
2167a prefix arg lets you edit the `ls' switches used for the new listing."
2168 t)
2169
2170(autoload 'dired-string-replace-match "dired-aux"
2171 "Replace first match of REGEXP in STRING with NEWTEXT.
2172If it does not match, nil is returned instead of the new string.
2173Optional arg LITERAL means to take NEWTEXT literally.
2174Optional arg GLOBAL means to replace all matches."
2175 t)
2176
2177(autoload 'dired-create-directory "dired-aux"
84fc2cfa 2178 "Create a directory called DIRECTORY."
492d2437 2179 t)
84fc2cfa 2180
492d2437
RS
2181(autoload 'dired-do-copy "dired-aux"
2182 "Copy all marked (or next ARG) files, or copy the current file.
2183Thus, a zero prefix argument copies nothing. But it toggles the
2184variable `dired-copy-preserve-time' (which see)."
2185 t)
2186
2187(autoload 'dired-do-symlink "dired-aux"
2188 "Make symbolic links to current file or all marked (or next ARG) files.
2189When operating on just the current file, you specify the new name.
2190When operating on multiple or marked files, you specify a directory
2191and new symbolic links are made in that directory
2192with the same names that the files currently have."
2193 t)
2194
2195(autoload 'dired-do-hardlink "dired-aux"
2196 "Add names (hard links) current file or all marked (or next ARG) files.
2197When operating on just the current file, you specify the new name.
2198When operating on multiple or marked files, you specify a directory
2199and new hard links are made in that directory
2200with the same names that the files currently have."
2201 t)
2202
2203(autoload 'dired-do-rename "dired-aux"
2204 "Rename current file or all marked (or next ARG) files.
2205When renaming just the current file, you specify the new name.
2206When renaming multiple or marked files, you specify a directory."
2207 t)
2208
2209(autoload 'dired-do-rename-regexp "dired-aux"
2210 "Rename marked files containing REGEXP to NEWNAME.
2211As each match is found, the user must type a character saying
2212 what to do with it. For directions, type \\[help-command] at that time.
2213NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
2214REGEXP defaults to the last regexp used.
2215With a zero prefix arg, renaming by regexp affects the complete
2216 pathname - usually only the non-directory part of file names is used
2217 and changed."
2218 t)
2219
2220(autoload 'dired-do-copy-regexp "dired-aux"
2221 "Copy all marked files containing REGEXP to NEWNAME.
2222See function `dired-rename-regexp' for more info."
2223 t)
2224
2225(autoload 'dired-do-hardlink-regexp "dired-aux"
2226 "Hardlink all marked files containing REGEXP to NEWNAME.
2227See function `dired-rename-regexp' for more info."
2228 t)
2229
2230(autoload 'dired-do-symlink-regexp "dired-aux"
2231 "Symlink all marked files containing REGEXP to NEWNAME.
2232See function `dired-rename-regexp' for more info."
2233 t)
2234
2235(autoload 'dired-upcase "dired-aux"
2236 "Rename all marked (or next ARG) files to upper case."
2237 t)
2238
2239(autoload 'dired-downcase "dired-aux"
2240 "Rename all marked (or next ARG) files to lower case."
2241 t)
2242
2243(autoload 'dired-maybe-insert-subdir "dired-aux"
2244 "Insert this subdirectory into the same dired buffer.
2245If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
2246 else inserts it at its natural place (as `ls -lR' would have done).
2247With a prefix arg, you may edit the ls switches used for this listing.
2248 You can add `R' to the switches to expand the whole tree starting at
2249 this subdirectory.
2250This function takes some pains to conform to `ls -lR' output."
2251 t)
2252
2253(autoload 'dired-next-subdir "dired-aux"
2254 "Go to next subdirectory, regardless of level."
2255 t)
2256
2257(autoload 'dired-prev-subdir "dired-aux"
2258 "Go to previous subdirectory, regardless of level.
2259When called interactively and not on a subdir line, go to this subdir's line."
2260 t)
2261
2262(autoload 'dired-goto-subdir "dired-aux"
2263 "Go to end of header line of DIR in this dired buffer.
2264Return value of point on success, otherwise return nil.
2265The next char is either \\n, or \\r if DIR is hidden."
2266 t)
2267
2268(autoload 'dired-mark-subdir-files "dired-aux"
2269 "Mark all files except `.' and `..'."
2270 t)
2271
2272(autoload 'dired-kill-subdir "dired-aux"
2273 "Remove all lines of current subdirectory.
2274Lower levels are unaffected."
2275 t)
2276
2277(autoload 'dired-tree-up "dired-aux"
2278 "Go up ARG levels in the dired tree."
2279 t)
2280
2281(autoload 'dired-tree-down "dired-aux"
2282 "Go down in the dired tree."
2283 t)
2284
2285(autoload 'dired-hide-subdir "dired-aux"
2286 "Hide or unhide the current subdirectory and move to next directory.
2287Optional prefix arg is a repeat factor.
2288Use \\[dired-hide-all] to (un)hide all directories."
2289 t)
2290
2291(autoload 'dired-hide-all "dired-aux"
2292 "Hide all subdirectories, leaving only their header lines.
2293If there is already something hidden, make everything visible again.
2294Use \\[dired-hide-subdir] to (un)hide a particular subdirectory."
2295 t)
84fc2cfa 2296\f
492d2437
RS
2297(if (eq system-type 'vax-vms)
2298 (load "dired-vms"))
84fc2cfa 2299
492d2437 2300(run-hooks 'dired-load-hook) ; for your customizations
84fc2cfa 2301
52041219
RS
2302(provide 'dired)
2303
2304;;; dired.el ends here