dired.el 92.2 KB
Newer Older
1
;;; dired.el --- directory-browsing commands
2

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1985, 1986, 1992, 1993, 1994 Free Software Foundation, Inc.
4

5 6
;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
7 8 9 10 11

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
12
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
13 14 15 16 17 18 19 20 21 22 23
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

24 25
;;; Commentary:

26 27 28
;; This is a major mode for directory browsing and editing.  It is
;; documented in the Emacs manual.

29 30 31 32
;; Rewritten in 1990/1991 to add tree features, file marking and
;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
;; Finished up by rms in 1992.

33
;;; Code:
34 35 36

;;; Customizable variables

Eric S. Raymond's avatar
Eric S. Raymond committed
37
;;;###autoload
38 39 40
(defvar dired-listing-switches "-al"
  "*Switches passed to `ls' for dired.  MUST contain the `l' option.
May contain all other options that don't contradict `-l';
41 42
may contain even `F', `b', `i' and `s'.  See also the variable
`dired-ls-F-marks-symlinks' concerning the `F' switch.")
Eric S. Raymond's avatar
Eric S. Raymond committed
43

44 45 46 47 48
; Don't use absolute paths as /bin should be in any PATH and people
; may prefer /usr/local/gnu/bin or whatever.  However, chown is
; usually not in PATH.

;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
49
(defvar dired-chown-program
50
  (if (memq system-type '(hpux dgux usg-unix-v irix linux))
51
      "chown" "/etc/chown")
52
  "Name of chown command (usually `chown' or `/etc/chown').")
53

Karl Heuer's avatar
Karl Heuer committed
54 55 56 57 58
(defvar dired-chmod-program
  (if (eq system-type 'windows-nt)
      "chmode" "chmod")
  "Name of chmod command (usually `chmod' or `chmode').")

59 60 61
;;;###autoload
(defvar dired-ls-F-marks-symlinks nil
  "*Informs dired about how `ls -lF' marks symbolic links.
62
Set this to t if `insert-directory-program' with `-lF' marks the symbolic link
63
itself with a trailing @ (usually the case under Ultrix).
Eric S. Raymond's avatar
Eric S. Raymond committed
64

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
nil (the default), if it gives `bar@ -> foo', set it to t.

Dired checks if there is really a @ appended.  Thus, if you have a
marking `ls' program on one host and a non-marking on another host, and
don't care about symbolic links which really end in a @, you can
always set this variable to t.")

;;;###autoload
(defvar dired-trivial-filenames "^\\.\\.?$\\|^#"
  "*Regexp of files to skip when finding first file of a directory.
A value of nil means move to the subdir line.
A value of t means move to first file.")

;;;###autoload
(defvar dired-keep-marker-rename t
  ;; Use t as default so that moved files "take their markers with them".
  "*Controls marking of renamed files.
If t, files keep their previous marks when they are renamed.
If a character, renamed files (whether previously marked or not)
are afterward marked with that character.")

;;;###autoload
(defvar dired-keep-marker-copy ?C
  "*Controls marking of copied files.
If t, copied files are marked if and as the corresponding original files were.
If a character, copied files are unconditionally marked with that character.")

;;;###autoload
(defvar dired-keep-marker-hardlink ?H
  "*Controls marking of newly made hard links.
If t, they are marked if and as the files linked to were marked.
If a character, new links are unconditionally marked with that character.")

;;;###autoload
(defvar dired-keep-marker-symlink ?Y
  "*Controls marking of newly made symbolic links.
If t, they are marked if and as the files linked to were marked.
If a character, new links are unconditionally marked with that character.")

;;;###autoload
(defvar dired-dwim-target nil
  "*If non-nil, dired tries to guess a default target directory.
This means: if there is a dired buffer displayed in the next window,
use its current subdir, instead of the current subdir of this dired buffer.

The target is used in the prompt for file copy, rename etc.")

;;;###autoload
(defvar dired-copy-preserve-time t
  "*If non-nil, Dired preserves the last-modified time in a file copy.
\(This works on only some systems.)")

118 119
(defvar dired-font-lock-keywords
  '(;; Put directory headers in italics.
120
    ("^  \\(/.+\\)" 1 font-lock-type-face)
121 122 123
    ;; Put symlinks in bold italics.
    ("\\([^ ]+\\) -> [^ ]+$" . font-lock-function-name-face)
    ;; Put marks in bold.
124
    ("^[^ ]" . font-lock-reference-face)
125 126 127 128
    ;; Put files that are subdirectories in bold.
    ("^..d.* \\([^ ]+\\)$" 1 font-lock-keyword-face))
  "Additional expressions to highlight in Dired mode.")

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
;;; Hook variables

(defvar dired-load-hook nil
  "Run after loading dired.
You can customize key bindings or load extensions with this.")

(defvar dired-mode-hook nil
  "Run at the very end of dired-mode.")

(defvar dired-before-readin-hook nil
  "This hook is run before a dired buffer is read in (created or reverted).")

(defvar dired-after-readin-hook nil
  "Hook run after each time a file or directory is read by Dired.
After each listing of a file or directory, this hook is run
with the buffer narrowed to the listing.")
;; Note this can't simply be run inside function `dired-ls' as the hook
;; functions probably depend on the dired-subdir-alist to be OK.

;;; Internal variables

(defvar dired-marker-char ?*		; the answer is 42
  ;; so that you can write things like
  ;; (let ((dired-marker-char ?X))
  ;;    ;; great code using X markers ...
  ;;    )
  ;; For example, commands operating on two sets of files, A and B.
  ;; Or marking files with digits 0-9.  This could implicate
  ;; concentric sets or an order for the marked files.
  ;; The code depends on dynamic scoping on the marker char.
  "In Dired, the current mark character.
This is what the `do' commands look for and what the `mark' commands store.")

(defvar dired-del-marker ?D
  "Character used to flag files for deletion.")

(defvar dired-shrink-to-fit
166 167 168
  t
;; I see no reason ever to make this nil -- rms.
;;  (> baud-rate search-slow-speed)
169 170 171 172
  "Non-nil means Dired shrinks the display buffer to fit the marked files.")

(defvar dired-flagging-regexp nil);; Last regexp used to flag files.

173 174
(defvar dired-file-version-alist)

175 176
(defvar dired-directory nil
  "The directory name or shell wildcard that was used as argument to `ls'.
177 178
Local to each dired buffer.  May be a list, in which case the car is the
directory name and the cdr is the actual files to list.")
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

(defvar dired-actual-switches nil
  "The value of `dired-listing-switches' used to make this buffer's text.")

(defvar dired-re-inode-size "[0-9 \t]*"
  "Regexp for optional initial inode and file size as made by `ls -i -s'.")

;; These regexps must be tested at beginning-of-line, but are also
;; used to search for next matches, so neither omitting "^" nor
;; replacing "^" by "\n" (to make it slightly faster) will work.

(defvar dired-re-mark "^[^ \n]")
;; "Regexp matching a marked line.
;; Important: the match ends just after the marker."
(defvar dired-re-maybe-mark "^. ")
(defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d"))
(defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l"))
(defvar dired-re-exe;; match ls permission string of an executable file
  (mapconcat (function
	      (lambda (x)
		(concat dired-re-maybe-mark dired-re-inode-size x)))
	     '("-[-r][-w][xs][-r][-w].[-r][-w]."
	       "-[-r][-w].[-r][-w][xs][-r][-w]."
	       "-[-r][-w].[-r][-w].[-r][-w][xst]")
	     "\\|"))
204
(defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
205 206
(defvar dired-re-dot "^.* \\.\\.?$")

207
;; The subdirectory names in this list are expanded.
208 209 210
(defvar dired-subdir-alist nil
  "Association list of subdirectories and their buffer positions.
Each subdirectory has an element: (DIRNAME . STARTMARKER).
Richard M. Stallman's avatar
Richard M. Stallman committed
211 212
The order of elements is the reverse of the order in the buffer.
In simple cases, this list contains one element.")
213

214
(defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
  "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
Subexpression 1 is the subdirectory proper, no trailing colon.
The match starts at the beginning of the line and ends after the end
of the line (\\n or \\r).
Subexpression 2 must end right before the \\n or \\r.")


;;; Macros must be defined before they are used, for the byte compiler.

;; Mark all files for which CONDITION evals to non-nil.
;; CONDITION is evaluated on each line, with point at beginning of line.
;; MSG is a noun phrase for the type of files being marked.
;; It should end with a noun that can be pluralized by adding `s'.
;; Return value is the number of files marked, or nil if none were marked.
(defmacro dired-mark-if (predicate msg)
  (` (let (buffer-read-only count)
       (save-excursion
	 (setq count 0)
	 (if (, msg) (message "Marking %ss..." (, msg)))
	 (goto-char (point-min))
	 (while (not (eobp))
	   (if (, predicate)
	       (progn
		 (delete-char 1)
		 (insert dired-marker-char)
		 (setq count (1+ count))))
	   (forward-line 1))
	 (if (, msg) (message "%s %s%s %s%s."
			  count
			  (, msg)
			  (dired-plural-s count)
			  (if (eq dired-marker-char ?\040) "un" "")
			  (if (eq dired-marker-char dired-del-marker)
			      "flagged" "marked"))))
       (and (> count 0) count))))

(defmacro dired-map-over-marks (body arg &optional show-progress)
;;  "Macro: Perform BODY with point somewhere on each marked line
;;and return a list of BODY's results.
;;If no marked file could be found, execute BODY on the current line.
;;  If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
;;  files instead of the marked files.
;;  In that case point is dragged along.  This is so that commands on
;;  the next ARG (instead of the marked) files can be chained easily.
;;  If ARG is otherwise non-nil, use current file instead.
;;If optional third arg SHOW-PROGRESS evaluates to non-nil,
;;   redisplay the dired buffer after each file is processed.
;;No guarantee is made about the position on the marked line.
;;  BODY must ensure this itself if it depends on this.
;;Search starts at the beginning of the buffer, thus the car of the list
;;  corresponds to the line nearest to the buffer's bottom.  This
;;  is also true for (positive and negative) integer values of ARG.
;;BODY should not be too long as it is expanded four times."
;;
;;Warning: BODY must not add new lines before point - this may cause an
;;endless loop.
;;This warning should not apply any longer, sk  2-Sep-1991 14:10.
  (` (prog1
	 (let (buffer-read-only case-fold-search found results)
	   (if (, arg)
	       (if (integerp (, arg))
		   (progn;; no save-excursion, want to move point.
		     (dired-repeat-over-lines
		      (, arg)
		      (function (lambda ()
				  (if (, show-progress) (sit-for 0))
				  (setq results (cons (, body) results)))))
		     (if (< (, arg) 0)
			 (nreverse results)
		       results))
		 ;; non-nil, non-integer ARG means use current file:
		 (list (, body)))
	     (let ((regexp (dired-marker-regexp)) next-position)
	       (save-excursion
		 (goto-char (point-min))
		 ;; remember position of next marked file before BODY
		 ;; can insert lines before the just found file,
		 ;; confusing us by finding the same marked file again
		 ;; and again and...
		 (setq next-position (and (re-search-forward regexp nil t)
					  (point-marker))
		       found (not (null next-position)))
		 (while next-position
		   (goto-char next-position)
		   (if (, show-progress) (sit-for 0))
		   (setq results (cons (, body) results))
		   ;; move after last match
		   (goto-char next-position)
		   (forward-line 1)
		   (set-marker next-position nil)
		   (setq next-position (and (re-search-forward regexp nil t)
					    (point-marker)))))
	       (if found
		   results
		 (list (, body))))))
       ;; save-excursion loses, again
       (dired-move-to-filename))))

(defun dired-get-marked-files (&optional localp arg)
  "Return the marked files' names as list of strings.
The list is in the same order as the buffer, that is, the car is the
  first marked file.
Values returned are normally absolute pathnames.
Optional arg LOCALP as in `dired-get-filename'.
Optional second argument ARG forces to use other files.  If ARG is an
  integer, use the next ARG files.  If ARG is otherwise non-nil, use
  current file.  Usually ARG comes from the current prefix arg."
Eric S. Raymond's avatar
Eric S. Raymond committed
322
  (save-excursion
323
    (nreverse (dired-map-over-marks (dired-get-filename localp) arg))))
Eric S. Raymond's avatar
Eric S. Raymond committed
324

325 326 327 328 329 330 331 332 333 334 335 336 337 338

;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
;; other special applications.

;; The dired command

(defun dired-read-dir-and-switches (str)
  ;; For use in interactive.
  (reverse (list
	    (if current-prefix-arg
		(read-string "Dired listing switches: "
			     dired-listing-switches))
	    (read-file-name (format "Dired %s(directory): " str)
			    nil default-directory nil))))
Eric S. Raymond's avatar
Eric S. Raymond committed
339

340
;;;###autoload (define-key ctl-x-map "d" 'dired)
Eric S. Raymond's avatar
Eric S. Raymond committed
341
;;;###autoload
342
(defun dired (dirname &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
343
  "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
344 345 346
Optional second argument SWITCHES specifies the `ls' options used.
\(Interactively, use a prefix argument to be able to specify SWITCHES.)
Dired displays a list of files in DIRNAME (which may also have
347 348 349
shell wildcards appended to select certain files).  If DIRNAME is a cons,
its first element is taken as the directory name and the resr as an explicit
list of files to make directory entries for.
350
\\<dired-mode-map>\
351
You can move around in it with the usual commands.
352 353
You can flag files for deletion with \\[dired-flag-file-deletion] and then
delete them by typing \\[dired-do-flagged-delete].
354
Type \\[describe-mode] after entering dired for more info.
Eric S. Raymond's avatar
Eric S. Raymond committed
355

356 357 358 359 360 361
If DIRNAME is already in a dired buffer, that buffer is used without refresh."
  ;; Cannot use (interactive "D") because of wildcards.
  (interactive (dired-read-dir-and-switches ""))
  (switch-to-buffer (dired-noselect dirname switches)))

;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
362
;;;###autoload
363
(defun dired-other-window (dirname &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
364
  "\"Edit\" directory DIRNAME.  Like `dired' but selects in another window."
365 366
  (interactive (dired-read-dir-and-switches "in other window "))
  (switch-to-buffer-other-window (dired-noselect dirname switches)))
Eric S. Raymond's avatar
Eric S. Raymond committed
367

368 369 370 371 372 373 374
;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
;;;###autoload
(defun dired-other-frame (dirname &optional switches)
  "\"Edit\" directory DIRNAME.  Like `dired' but makes a new frame."
  (interactive (dired-read-dir-and-switches "in other frame "))
  (switch-to-buffer-other-frame (dired-noselect dirname switches)))

Eric S. Raymond's avatar
Eric S. Raymond committed
375
;;;###autoload
376
(defun dired-noselect (dir-or-list &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
377
  "Like `dired' but returns the dired buffer as value, does not select it."
378
  (or dir-or-list (setq dir-or-list default-directory))
379 380
  ;; This loses the distinction between "/foo/*/" and "/foo/*" that
  ;; some shells make:
381 382 383 384
  (let (dirname)
    (if (consp dir-or-list)
	(setq dirname (car dir-or-list))
      (setq dirname dir-or-list))
385 386
    (setq dirname (abbreviate-file-name
		   (expand-file-name (directory-file-name dirname))))
387 388 389 390 391 392
    (if (file-directory-p dirname)
	(setq dirname (file-name-as-directory dirname)))
    (if (consp dir-or-list)
	(setq dir-or-list (cons dirname (cdr dir-or-list)))
      (setq dir-or-list dirname))
    (dired-internal-noselect dir-or-list switches)))
393 394

;; Separate function from dired-noselect for the sake of dired-vms.el.
395
(defun dired-internal-noselect (dir-or-list &optional switches)
396 397 398 399 400 401 402 403 404
  ;; If there is an existing dired buffer for DIRNAME, just leave
  ;; buffer as it is (don't even call dired-revert).
  ;; This saves time especially for deep trees or with ange-ftp.
  ;; The user can type `g'easily, and it is more consistent with find-file.
  ;; But if SWITCHES are given they are probably different from the
  ;; buffer's old value, so call dired-sort-other, which does
  ;; revert the buffer.
  ;; A pity we can't possibly do "Directory has changed - refresh? "
  ;; like find-file does.
405 406
  (let* ((dirname (if (consp dir-or-list) (car dir-or-list) dir-or-list))
	 (buffer (dired-find-buffer-nocreate dir-or-list))
407 408 409 410 411 412 413 414 415 416 417 418
	 ;; note that buffer already is in dired-mode, if found
	 (new-buffer-p (not buffer))
	 (old-buf (current-buffer)))
    (or buffer
	(let ((default-major-mode 'fundamental-mode))
	  ;; We don't want default-major-mode to run hooks and set auto-fill
	  ;; or whatever, now that dired-mode does not
	  ;; kill-all-local-variables any longer.
	  (setq buffer (create-file-buffer (directory-file-name dirname)))))
    (set-buffer buffer)
    (if (not new-buffer-p)		; existing buffer ...
	(if switches			; ... but new switches
419 420 421 422
	    (dired-sort-other switches)	; this calls dired-revert
	  ;; If directory has changed on disk, offer to revert.
	  (if (let ((attributes (file-attributes dirname))
		    (modtime (visited-file-modtime)))
423 424
		(or (eq modtime 0)
		    (not (eq (car attributes) t))
425 426 427
		    (and (= (car (nth 5 attributes)) (car modtime))
			 (= (nth 1 (nth 5 attributes)) (cdr modtime)))))
	      nil
428 429 430
	    (message
	     (substitute-command-keys
	      "Directory has changed on disk; type \\[revert-buffer] to update Dired"))))
431
      ;; Else a new buffer
432
      (setq default-directory
433 434 435
	    (if (file-directory-p dirname)
		dirname
	      (file-name-directory dirname)))
436 437 438 439 440 441
      (or switches (setq switches dired-listing-switches))
      (dired-mode dirname switches)
      ;; default-directory and dired-actual-switches are set now
      ;; (buffer-local), so we can call dired-readin:
      (let ((failed t))
	(unwind-protect
442
	    (progn (dired-readin dir-or-list buffer)
443 444 445 446 447 448 449 450 451 452 453 454
		   (setq failed nil))
	  ;; dired-readin can fail if parent directories are inaccessible.
	  ;; Don't leave an empty buffer around in that case.
	  (if failed (kill-buffer buffer))))
      ;; No need to narrow since the whole buffer contains just
      ;; dired-readin's output, nothing else.  The hook can
      ;; successfully use dired functions (e.g. dired-get-filename)
      ;; as the subdir-alist has been built in dired-readin.
      (run-hooks 'dired-after-readin-hook)
      (goto-char (point-min))
      (dired-initial-position dirname))
    (set-buffer old-buf)
Eric S. Raymond's avatar
Eric S. Raymond committed
455 456
    buffer))

457 458 459
;; This differs from dired-buffers-for-dir in that it does not consider
;; subdirs of default-directory and searches for the first match only
(defun dired-find-buffer-nocreate (dirname)
460
  (let (found (blist dired-buffers))    ; was (buffer-list)
461
    (while blist
462 463 464 465 466 467 468 469 470
      (if (null (buffer-name (cdr (car blist))))
	  (setq blist (cdr blist))
	(save-excursion
	  (set-buffer (cdr (car blist)))
	  (if (and (eq major-mode 'dired-mode)
		   (equal dired-directory dirname))
	      (setq found (cdr (car blist))
		    blist nil)
	    (setq blist (cdr blist))))))
471 472 473 474 475 476 477 478
    found))


;; Read in a new dired buffer

;; dired-readin differs from dired-insert-subdir in that it accepts
;; wildcards, erases the buffer, and builds the subdir-alist anew
;; (including making it buffer-local and clearing it first).
479
(defun dired-readin (dir-or-list buffer)
480 481 482 483 484 485 486
  ;; default-directory and dired-actual-switches must be buffer-local
  ;; and initialized by now.
  ;; Thus we can test (equal default-directory dirname) instead of
  ;; (file-directory-p dirname) and save a filesystem transaction.
  ;; Also, we can run this hook which may want to modify the switches
  ;; based on default-directory, e.g. with ange-ftp to a SysV host
  ;; where ls won't understand -Al switches.
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
  (let (dirname)
    (if (consp dir-or-list)
	(setq dirname (car dir-or-list))
      (setq dirname dir-or-list))
    (setq dirname (expand-file-name dirname))
    (if (consp dir-or-list)
	(setq dir-or-list (cons dirname (cdr dir-or-list))))
    (run-hooks 'dired-before-readin-hook)
    (save-excursion
      (message "Reading directory %s..." dirname)
      (set-buffer buffer)
      (let (buffer-read-only (failed t))
	(widen)
	(erase-buffer)
	(dired-readin-insert dir-or-list)
	(indent-rigidly (point-min) (point-max) 2)
	;; We need this to make the root dir have a header line as all
	;; other subdirs have:
	(goto-char (point-min))
	(dired-insert-headerline default-directory)
	;; can't run dired-after-readin-hook here, it may depend on the subdir
	;; alist to be OK.
	)
      (message "Reading directory %s...done" dirname)
      ;; Must first make alist buffer local and set it to nil because
      ;; dired-build-subdir-alist will call dired-clear-alist first
      (set (make-local-variable 'dired-subdir-alist) nil)
514
      (dired-build-subdir-alist)
515 516 517
      (let ((attributes (file-attributes dirname)))
	(if (eq (car attributes) t)
	    (set-visited-file-modtime (nth 5 attributes))))
518
      (set-buffer-modified-p nil))))
519 520 521

;; Subroutines of dired-readin

522 523 524 525 526 527 528
(defun dired-readin-insert (dir-or-list)
  ;; Just insert listing for the passed-in directory or
  ;; directory-and-file list, assuming a clean buffer.
  (let (dirname)
    (if (consp dir-or-list)
	(setq dirname (car dir-or-list))
      (setq dirname dir-or-list))
529 530 531
    ;; Expand before comparing in case one or both have been abbreviated.
    (if (and (equal (expand-file-name default-directory)
		    (expand-file-name dirname))
532 533
	     (not (consp dir-or-list)))
	;; If we are reading a whole single directory...
534 535 536 537
	(dired-insert-directory dir-or-list dired-actual-switches nil t)
      (if (not (file-readable-p
		(directory-file-name (file-name-directory dirname))))
	  (error "Directory %s inaccessible or nonexistent" dirname)
538 539 540 541
	;; Else assume it contains wildcards,
	;; unless it is an explicit list of files.
	(dired-insert-directory dir-or-list dired-actual-switches
				(not (listp dir-or-list)))
542 543 544 545 546 547 548
	(save-excursion		;; insert wildcard instead of total line:
	  (goto-char (point-min))
	  (insert "wildcard " (file-name-nondirectory dirname) "\n"))))))

(defun dired-insert-directory (dir-or-list switches &optional wildcard full-p)
  ;; Do the right thing whether dir-or-list is atomic or not.  If it is,
  ;; inset all files listed in the cdr (the car is the passed-in directory
549
  ;; list).
550 551
  (let ((opoint (point))
	end)
552
    (if (consp dir-or-list)
553 554 555 556 557 558 559
	;; In this case, use the file names in the cdr
	;; exactly as originally given to dired-noselect.
	(mapcar
	 (function (lambda (x) (insert-directory x switches wildcard full-p)))
	 (cdr dir-or-list))
      ;; Expand the file name here because it may have been abbreviated
      ;; in dired-noselect.
560
      (insert-directory (expand-file-name dir-or-list) switches wildcard full-p))
561
    ;; Quote certain characters, unless ls quoted them for us.
562 563 564 565 566 567 568 569 570 571
    (if (not (string-match "b" dired-actual-switches))
	(save-excursion
	  (setq end (point-marker))
	  (goto-char opoint)
	  (while (search-forward "\\" end t)
	    (replace-match "\\\\" nil t))
	  (goto-char opoint)
	  (while (search-forward "\^m" end t)
	    (replace-match "\\015" nil t))
	  (set-marker end nil)))
572
    (dired-insert-set-properties opoint (point)))
573
  (setq dired-directory dir-or-list))
574

575
;; Make the file names highlight when the mouse is on them.
576 577 578 579 580 581 582 583 584 585 586 587
(defun dired-insert-set-properties (beg end)
  (save-excursion
    (goto-char beg)
    (while (< (point) end)
      (if (dired-move-to-filename)
	  (put-text-property (point)
			     (save-excursion
			       (dired-move-to-end-of-filename)
			       (point))
			     'mouse-face 'highlight))
      (forward-line 1))))

588 589 590 591 592 593 594 595 596
(defun dired-insert-headerline (dir);; also used by dired-insert-subdir
  ;; Insert DIR's headerline with no trailing slash, exactly like ls
  ;; would, and put cursor where dired-build-subdir-alist puts subdir
  ;; boundaries.
  (save-excursion (insert "  " (directory-file-name dir) ":\n")))


;; Reverting a dired buffer

Eric S. Raymond's avatar
Eric S. Raymond committed
597
(defun dired-revert (&optional arg noconfirm)
598 599 600 601 602
  ;; Reread the dired buffer.  Must also be called after
  ;; dired-actual-switches have changed.
  ;; Should not fail even on completely garbaged buffers.
  ;; Preserves old cursor, marks/flags, hidden-p.
  (widen)				; just in case user narrowed
Eric S. Raymond's avatar
Eric S. Raymond committed
603
  (let ((opoint (point))
604 605 606 607 608 609 610 611 612 613
	(ofile (dired-get-filename nil t))
	(mark-alist nil)		; save marked files
	(hidden-subdirs (dired-remember-hidden))
	(old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
	(case-fold-search nil)		; we check for upper case ls flags
	buffer-read-only)
    (goto-char (point-min))
    (setq mark-alist;; only after dired-remember-hidden since this unhides:
	  (dired-remember-marks (point-min) (point-max)))
    ;; treat top level dir extra (it may contain wildcards)
614 615
    (dired-uncache
     (if (consp dired-directory) (car dired-directory) dired-directory))
Eric S. Raymond's avatar
Eric S. Raymond committed
616
    (dired-readin dired-directory (current-buffer))
617 618 619 620 621 622 623 624 625
    (let ((dired-after-readin-hook nil))
      ;; don't run that hook for each subdir...
      (dired-insert-old-subdirs old-subdir-alist))
    (dired-mark-remembered mark-alist)	; mark files that were marked
    ;; ... run the hook for the whole buffer, and only after markers
    ;; have been reinserted (else omitting in dired-x would omit marked files)
    (run-hooks 'dired-after-readin-hook)	; no need to narrow
    (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
	(goto-char opoint))		; was before
Eric S. Raymond's avatar
Eric S. Raymond committed
626
    (dired-move-to-filename)
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
    (save-excursion			; hide subdirs that were hidden
      (mapcar (function (lambda (dir)
			  (if (dired-goto-subdir dir)
			      (dired-hide-subdir 1))))
	      hidden-subdirs)))
  ;; outside of the let scope
;;; Might as well not override the user if the user changed this.
;;;  (setq buffer-read-only t)
  )

;; Subroutines of dired-revert
;; Some of these are also used when inserting subdirs.

(defun dired-remember-marks (beg end)
  ;; Return alist of files and their marks, from BEG to END.
  (if selective-display			; must unhide to make this work.
      (let (buffer-read-only)
	(subst-char-in-region beg end ?\r ?\n)))
  (let (fil chr alist)
    (save-excursion
      (goto-char beg)
      (while (re-search-forward dired-re-mark end t)
	(if (setq fil (dired-get-filename nil t))
	    (setq chr (preceding-char)
		  alist (cons (cons fil chr) alist)))))
    alist))

;; Mark all files remembered in ALIST.
;; Each element of ALIST looks like (FILE . MARKERCHAR).
(defun dired-mark-remembered (alist)
  (let (elt fil chr)
    (while alist
      (setq elt (car alist)
	    alist (cdr alist)
	    fil (car elt)
	    chr (cdr elt))
      (if (dired-goto-file fil)
	  (save-excursion
	    (beginning-of-line)
	    (delete-char 1)
	    (insert chr))))))

;; Return a list of names of subdirs currently hidden.
(defun dired-remember-hidden ()
  (let ((l dired-subdir-alist) dir pos result)
    (while l
      (setq dir (car (car l))
	    pos (cdr (car l))
	    l (cdr l))
      (goto-char pos)
      (skip-chars-forward "^\r\n")
678
      (if (eq (following-char) ?\r)
679 680 681 682 683 684 685 686 687 688 689 690 691
	  (setq result (cons dir result))))
    result))

;; Try to insert all subdirs that were displayed before,
;; according to the former subdir alist OLD-SUBDIR-ALIST.
(defun dired-insert-old-subdirs (old-subdir-alist)
  (or (string-match "R" dired-actual-switches)
      (let (elt dir)
	(while old-subdir-alist
	  (setq elt (car old-subdir-alist)
		old-subdir-alist (cdr old-subdir-alist)
		dir (car elt))
	  (condition-case ()
692 693 694
	      (progn
		(dired-uncache dir)
		(dired-insert-subdir dir))
695
	    (error nil))))))
696 697 698

;; Remove directory DIR from any directory cache.
(defun dired-uncache (dir)
699
  (let ((handler (find-file-name-handler dir 'dired-uncache)))
700 701
    (if handler
	(funcall handler 'dired-uncache dir))))
702 703

;; dired mode key bindings and initialization
Eric S. Raymond's avatar
Eric S. Raymond committed
704 705 706 707

(defvar dired-mode-map nil "Local keymap for dired-mode buffers.")
(if dired-mode-map
    nil
708 709 710
  ;; This looks ugly when substitute-command-keys uses C-d instead d:
  ;;  (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)

Eric S. Raymond's avatar
Eric S. Raymond committed
711 712
  (setq dired-mode-map (make-keymap))
  (suppress-keymap dired-mode-map)
713
  (define-key dired-mode-map [mouse-2] 'dired-mouse-find-file-other-window)
714
  ;; Commands to mark or flag certain categories of files
Eric S. Raymond's avatar
Eric S. Raymond committed
715
  (define-key dired-mode-map "#" 'dired-flag-auto-save-files)
716
  (define-key dired-mode-map "*" 'dired-mark-executables)
Eric S. Raymond's avatar
Eric S. Raymond committed
717
  (define-key dired-mode-map "." 'dired-clean-directory)
718 719 720
  (define-key dired-mode-map "/" 'dired-mark-directories)
  (define-key dired-mode-map "@" 'dired-mark-symlinks)
  (define-key dired-mode-map "~" 'dired-flag-backup-files)
721
  ;; Upper case keys (except !) for operating on the marked files
722
  (define-key dired-mode-map "A" 'dired-do-search)
723 724 725 726 727 728 729 730 731
  (define-key dired-mode-map "C" 'dired-do-copy)
  (define-key dired-mode-map "B" 'dired-do-byte-compile)
  (define-key dired-mode-map "D" 'dired-do-delete)
  (define-key dired-mode-map "G" 'dired-do-chgrp)
  (define-key dired-mode-map "H" 'dired-do-hardlink)
  (define-key dired-mode-map "L" 'dired-do-load)
  (define-key dired-mode-map "M" 'dired-do-chmod)
  (define-key dired-mode-map "O" 'dired-do-chown)
  (define-key dired-mode-map "P" 'dired-do-print)
732
  (define-key dired-mode-map "Q" 'dired-do-query-replace)
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
  (define-key dired-mode-map "R" 'dired-do-rename)
  (define-key dired-mode-map "S" 'dired-do-symlink)
  (define-key dired-mode-map "X" 'dired-do-shell-command)
  (define-key dired-mode-map "Z" 'dired-do-compress)
  (define-key dired-mode-map "!" 'dired-do-shell-command)
  ;; Comparison commands
  (define-key dired-mode-map "=" 'dired-diff)
  (define-key dired-mode-map "\M-=" 'dired-backup-diff)
  ;; Tree Dired commands
  (define-key dired-mode-map "\M-\C-?" 'dired-unmark-all-files)
  (define-key dired-mode-map "\M-\C-d" 'dired-tree-down)
  (define-key dired-mode-map "\M-\C-u" 'dired-tree-up)
  (define-key dired-mode-map "\M-\C-n" 'dired-next-subdir)
  (define-key dired-mode-map "\M-\C-p" 'dired-prev-subdir)
  ;; move to marked files
  (define-key dired-mode-map "\M-{" 'dired-prev-marked-file)
  (define-key dired-mode-map "\M-}" 'dired-next-marked-file)
  ;; Make all regexp commands share a `%' prefix:
751 752 753 754
  ;; We used to get to the submap via a symbol dired-regexp-prefix,
  ;; but that seems to serve little purpose, and copy-keymap
  ;; does a better job without it.
  (define-key dired-mode-map "%" nil)
755 756 757 758 759 760 761 762 763 764
  (define-key dired-mode-map "%u" 'dired-upcase)
  (define-key dired-mode-map "%l" 'dired-downcase)
  (define-key dired-mode-map "%d" 'dired-flag-files-regexp)
  (define-key dired-mode-map "%m" 'dired-mark-files-regexp)
  (define-key dired-mode-map "%r" 'dired-do-rename-regexp)
  (define-key dired-mode-map "%C" 'dired-do-copy-regexp)
  (define-key dired-mode-map "%H" 'dired-do-hardlink-regexp)
  (define-key dired-mode-map "%R" 'dired-do-rename-regexp)
  (define-key dired-mode-map "%S" 'dired-do-symlink-regexp)
  ;; Lower keys for commands not operating on all the marked files
765
  (define-key dired-mode-map "c" 'dired-change-marks)
766 767
  (define-key dired-mode-map "d" 'dired-flag-file-deletion)
  (define-key dired-mode-map "e" 'dired-find-file)
768 769
  (define-key dired-mode-map "f" 'dired-find-file)
  (define-key dired-mode-map "\C-m" 'dired-advertised-find-file)
770
  (define-key dired-mode-map "g" 'revert-buffer)
Eric S. Raymond's avatar
Eric S. Raymond committed
771
  (define-key dired-mode-map "h" 'describe-mode)
772
  (define-key dired-mode-map "i" 'dired-maybe-insert-subdir)
773
  (define-key dired-mode-map "k" 'dired-do-kill-lines)
774 775 776 777
  (define-key dired-mode-map "l" 'dired-do-redisplay)
  (define-key dired-mode-map "m" 'dired-mark)
  (define-key dired-mode-map "n" 'dired-next-line)
  (define-key dired-mode-map "o" 'dired-find-file-other-window)
778
  (define-key dired-mode-map "\C-o" 'dired-display-file)
779 780 781 782 783 784 785 786 787 788 789
  (define-key dired-mode-map "p" 'dired-previous-line)
  (define-key dired-mode-map "q" 'dired-quit)
  (define-key dired-mode-map "s" 'dired-sort-toggle-or-edit)
  (define-key dired-mode-map "u" 'dired-unmark)
  (define-key dired-mode-map "v" 'dired-view-file)
  (define-key dired-mode-map "x" 'dired-do-flagged-delete)
  (define-key dired-mode-map "+" 'dired-create-directory)
  ;; moving
  (define-key dired-mode-map "<" 'dired-prev-dirline)
  (define-key dired-mode-map ">" 'dired-next-dirline)
  (define-key dired-mode-map "^" 'dired-up-directory)
Eric S. Raymond's avatar
Eric S. Raymond committed
790 791 792
  (define-key dired-mode-map " "  'dired-next-line)
  (define-key dired-mode-map "\C-n" 'dired-next-line)
  (define-key dired-mode-map "\C-p" 'dired-previous-line)
793 794
  (define-key dired-mode-map [down] 'dired-next-line)
  (define-key dired-mode-map [up] 'dired-previous-line)
795 796 797 798 799 800 801 802 803 804
  ;; hiding
  (define-key dired-mode-map "$" 'dired-hide-subdir)
  (define-key dired-mode-map "\M-$" 'dired-hide-all)
  ;; misc
  (define-key dired-mode-map "?" 'dired-summary)
  (define-key dired-mode-map "\177" 'dired-unmark-backward)
  (define-key dired-mode-map "\C-_" 'dired-undo)
  (define-key dired-mode-map "\C-xu" 'dired-undo)
  )

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
;; Make menu bar items.

;; Get rid of the Edit menu bar item to save space.
(define-key dired-mode-map [menu-bar edit] 'undefined)

(define-key dired-mode-map [menu-bar subdir]
  (cons "Subdir" (make-sparse-keymap "Subdir")))

(define-key dired-mode-map [menu-bar subdir hide-all]
  '("Hide All" . dired-hide-all))
(define-key dired-mode-map [menu-bar subdir hide-subdir]
  '("Hide Subdir" . dired-hide-subdir))
(define-key dired-mode-map [menu-bar subdir tree-down]
  '("Tree Down" . dired-tree-down))
(define-key dired-mode-map [menu-bar subdir tree-up]
  '("Tree Up" . dired-tree-up))
(define-key dired-mode-map [menu-bar subdir up]
  '("Up Directory" . dired-up-directory))
(define-key dired-mode-map [menu-bar subdir prev-subdir]
  '("Prev Subdir" . dired-prev-subdir))
(define-key dired-mode-map [menu-bar subdir next-subdir]
  '("Next Subdir" . dired-next-subdir))
(define-key dired-mode-map [menu-bar subdir prev-dirline]
  '("Prev Dirline" . dired-prev-dirline))
(define-key dired-mode-map [menu-bar subdir next-dirline]
  '("Next Dirline" . dired-next-dirline))
(define-key dired-mode-map [menu-bar subdir insert]
  '("Insert This Subdir" . dired-maybe-insert-subdir))

(define-key dired-mode-map [menu-bar immediate]
  (cons "Immediate" (make-sparse-keymap "Immediate")))

(define-key dired-mode-map [menu-bar immediate backup-diff]
  '("Compare with Backup" . dired-backup-diff))
(define-key dired-mode-map [menu-bar immediate diff]
  '("Diff" . dired-diff))
(define-key dired-mode-map [menu-bar immediate view]
  '("View This File" . dired-view-file))
(define-key dired-mode-map [menu-bar immediate display]
  '("Display in Other Window" . dired-display-file))
(define-key dired-mode-map [menu-bar immediate find-file-other-window]
  '("Find in Other Window" . dired-find-file-other-window))
(define-key dired-mode-map [menu-bar immediate find-file]
  '("Find This File" . dired-find-file))
(define-key dired-mode-map [menu-bar immediate create-directory]
  '("Create Directory..." . dired-create-directory))

(define-key dired-mode-map [menu-bar regexp]
  (cons "Regexp" (make-sparse-keymap "Regexp")))

(define-key dired-mode-map [menu-bar regexp downcase]
  '("Downcase" . dired-downcase))
(define-key dired-mode-map [menu-bar regexp upcase]
  '("Upcase" . dired-upcase))
(define-key dired-mode-map [menu-bar regexp hardlink]
  '("Hardlink..." . dired-do-hardlink-regexp))
(define-key dired-mode-map [menu-bar regexp symlink]
  '("Symlink..." . dired-do-symlink-regexp))
(define-key dired-mode-map [menu-bar regexp rename]
  '("Rename..." . dired-do-rename-regexp))
(define-key dired-mode-map [menu-bar regexp copy]
  '("Copy..." . dired-do-copy-regexp))
(define-key dired-mode-map [menu-bar regexp flag]
  '("Flag..." . dired-flag-files-regexp))
(define-key dired-mode-map [menu-bar regexp mark]
  '("Mark..." . dired-mark-files-regexp))

(define-key dired-mode-map [menu-bar mark]
  (cons "Mark" (make-sparse-keymap "Mark")))

(define-key dired-mode-map [menu-bar mark prev]
  '("Previous Marked" . dired-prev-marked-file))
(define-key dired-mode-map [menu-bar mark next]
  '("Next Marked" . dired-next-marked-file))
(define-key dired-mode-map [menu-bar mark marks]
  '("Change Marks..." . dired-change-marks))
881 882
(define-key dired-mode-map [menu-bar mark unmark-all]
  '("Unmark All" . dired-unmark-all-files-no-query))
883 884 885 886 887 888 889 890
(define-key dired-mode-map [menu-bar mark symlinks]
  '("Mark Symlinks" . dired-mark-symlinks))
(define-key dired-mode-map [menu-bar mark directories]
  '("Mark Directories" . dired-mark-directories))
(define-key dired-mode-map [menu-bar mark directory]
  '("Mark Old Backups" . dired-clean-directory))
(define-key dired-mode-map [menu-bar mark executables]
  '("Mark Executables" . dired-mark-executables))
891
(define-key dired-mode-map [menu-bar mark backup-files]
892
  '("Flag Backup Files" . dired-flag-backup-files))
893
(define-key dired-mode-map [menu-bar mark auto-save-files]
894 895 896 897 898 899 900 901 902 903 904
  '("Flag Auto-save Files" . dired-flag-auto-save-files))
(define-key dired-mode-map [menu-bar mark deletion]
  '("Flag" . dired-flag-file-deletion))
(define-key dired-mode-map [menu-bar mark unmark]
  '("Unmark" . dired-unmark))
(define-key dired-mode-map [menu-bar mark mark]
  '("Mark" . dired-mark))

(define-key dired-mode-map [menu-bar operate]
  (cons "Operate" (make-sparse-keymap "Operate")))

905 906 907 908
(define-key dired-mode-map [menu-bar operate query-replace]
  '("Query Replace in Files..." . dired-do-query-replace))
(define-key dired-mode-map [menu-bar operate search]
  '("Search Files..." . dired-do-search))
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
(define-key dired-mode-map [menu-bar operate chown]
  '("Change Owner..." . dired-do-chown))
(define-key dired-mode-map [menu-bar operate chgrp]
  '("Change Group..." . dired-do-chgrp))
(define-key dired-mode-map [menu-bar operate chmod]
  '("Change Mode..." . dired-do-chmod))
(define-key dired-mode-map [menu-bar operate load]
  '("Load" . dired-do-load))
(define-key dired-mode-map [menu-bar operate compile]
  '("Byte-compile" . dired-do-byte-compile))
(define-key dired-mode-map [menu-bar operate compress]
  '("Compress" . dired-do-compress))
(define-key dired-mode-map [menu-bar operate print]
  '("Print" . dired-do-print))
(define-key dired-mode-map [menu-bar operate hardlink]
  '("Hardlink to..." . dired-do-hardlink))
(define-key dired-mode-map [menu-bar operate symlink]
  '("Symlink to..." . dired-do-symlink))
(define-key dired-mode-map [menu-bar operate command]
  '("Shell Command..." . dired-do-shell-command))
(define-key dired-mode-map [menu-bar operate delete]
  '("Delete" . dired-do-delete))
(define-key dired-mode-map [menu-bar operate rename]
  '("Rename to..." . dired-do-rename))
(define-key dired-mode-map [menu-bar operate copy]
  '("Copy to..." . dired-do-copy))

Eric S. Raymond's avatar
Eric S. Raymond committed
936 937 938
;; Dired mode is suitable only for specially formatted data.
(put 'dired-mode 'mode-class 'special)

939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
(defun dired-mode (&optional dirname switches)
  "\
Mode for \"editing\" directory listings.
In dired, you are \"editing\" a list of the files in a directory and
  \(optionally) its subdirectories, in the format of `ls -lR'.
  Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
\"Editing\" means that you can run shell commands on files, visit,
  compress, load or byte-compile them, change their file attributes
  and insert subdirectories into the same buffer.  You can \"mark\"
  files for later commands or \"flag\" them for deletion, either file
  by file or all files matching certain criteria.
You can move using the usual cursor motion commands.\\<dired-mode-map>
Letters no longer insert themselves.  Digits are prefix arguments.
Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
Type \\[dired-mark] to Mark a file or subdirectory for later commands.
  Most commands operate on the marked files and use the current file
  if no files are marked.  Use a numeric prefix argument to operate on
  the next ARG (or previous -ARG if ARG<0) files, or just `1'
  to operate on the current file only.  Prefix arguments override marks.
  Mark-using commands display a list of failures afterwards.  Type \\[dired-summary]
  to see why something went wrong.
Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
Type \\[dired-unmark-backward] to back up one line and unflag.
Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
Type \\[dired-advertised-find-file] to Find the current line's file
  (or dired it in another buffer, if it is a directory).
Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
Type \\[dired-do-copy] to Copy files.
Type \\[dired-sort-toggle-or-edit] to toggle sorting by name/date or change the `ls' switches.
Type \\[revert-buffer] to read all currently expanded directories again.
  This retains all marks and hides subdirs again that were hidden before.
SPC and DEL can be used to move down and up by lines.

If dired ever gets confused, you can either type \\[revert-buffer] \
to read the
directories again, type \\[dired-do-redisplay] \
to relist a single or the marked files or a
subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
again for the directory tree.

Customization variables (rename this buffer and type \\[describe-variable] on each line
for more info):

  dired-listing-switches
  dired-trivial-filenames
  dired-shrink-to-fit
  dired-marker-char
  dired-del-marker
  dired-keep-marker-rename
  dired-keep-marker-copy
  dired-keep-marker-hardlink
  dired-keep-marker-symlink

Hooks (use \\[describe-variable] to see their documentation):

  dired-before-readin-hook
  dired-after-readin-hook
  dired-mode-hook
  dired-load-hook

Keybindings:
Eric S. Raymond's avatar
Eric S. Raymond committed
1002
\\{dired-mode-map}"
1003 1004
  ;; Not to be called interactively (e.g. dired-directory will be set
  ;; to default-directory, which is wrong with wildcards).
Eric S. Raymond's avatar
Eric S. Raymond committed
1005 1006
  (kill-all-local-variables)
  (use-local-map dired-mode-map)
1007 1008 1009
  (dired-advertise)			; default-directory is already set
  (setq major-mode 'dired-mode
	mode-name "Dired"
1010
;;	case-fold-search nil
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
	buffer-read-only t
	selective-display t		; for subdirectory hiding
	mode-line-buffer-identification '("Dired: %17b"))
  (set (make-local-variable 'revert-buffer-function)
       (function dired-revert))
  (set (make-local-variable 'page-delimiter)
       "\n\n")
  (set (make-local-variable 'dired-directory)
       (or dirname default-directory))
  ;; list-buffers uses this to display the dir being edited in this buffer.
  (set (make-local-variable 'list-buffers-directory)
1022
       (expand-file-name dired-directory))
1023 1024
  (set (make-local-variable 'dired-actual-switches)
       (or switches dired-listing-switches))
1025
  (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
1026
  (dired-sort-other dired-actual-switches t)
Eric S. Raymond's avatar
Eric S. Raymond committed
1027 1028
  (run-hooks 'dired-mode-hook))

1029
;; Idiosyncratic dired commands that don't deal with marks.
Eric S. Raymond's avatar
Eric S. Raymond committed
1030

1031 1032 1033 1034
(defun dired-quit ()
  "Bury the current dired buffer."
  (interactive)
  (bury-buffer))
Eric S. Raymond's avatar
Eric S. Raymond committed
1035 1036

(defun dired-summary ()
1037
  "Summarize basic Dired commands and show recent Dired errors."
Eric S. Raymond's avatar
Eric S. Raymond committed
1038
  (interactive)
1039
  (dired-why)
Eric S. Raymond's avatar
Eric S. Raymond committed
1040 1041
  ;>> this should check the key-bindings and use substitute-command-keys if non-standard
  (message
1042
   "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
Eric S. Raymond's avatar
Eric S. Raymond committed
1043

1044 1045 1046 1047 1048 1049 1050 1051 1052
(defun dired-undo ()
  "Undo in a dired buffer.
This doesn't recover lost files, it just undoes changes in the buffer itself.
You can use it to recover marks, killed lines or subdirs.
In the latter case, you have to do \\[dired-build-subdir-alist] to
parse the buffer again."
  (interactive)
  (let (buffer-read-only)
    (undo)))
Eric S. Raymond's avatar
Eric S. Raymond committed
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067

(defun dired-next-line (arg)
  "Move down lines then position at filename.
Optional prefix ARG says how many lines to move; default is one line."
  (interactive "p")
  (next-line arg)
  (dired-move-to-filename))

(defun dired-previous-line (arg)
  "Move up lines then position at filename.
Optional prefix ARG says how many lines to move; default is one line."
  (interactive "p")
  (previous-line arg)
  (dired-move-to-filename))

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
(defun dired-next-dirline (arg &optional opoint)
  "Goto ARG'th next directory file line."
  (interactive "p")
  (or opoint (setq opoint (point)))
  (if (if (> arg 0)
	  (re-search-forward dired-re-dir nil t arg)
	(beginning-of-line)
	(re-search-backward dired-re-dir nil t (- arg)))
      (dired-move-to-filename)		; user may type `i' or `f'
    (goto-char opoint)
    (error "No more subdirectories")))

(defun dired-prev-dirline (arg)
  "Goto ARG'th previous directory file line."
  (interactive "p")
  (dired-next-dirline (- arg)))

Eric S. Raymond's avatar
Eric S. Raymond committed
1085
(defun dired-up-directory ()
1086 1087 1088
  "Run dired on parent directory of current directory.
Find the parent directory either in this buffer or another buffer.
Creates a buffer if necessary."
Eric S. Raymond's avatar
Eric S. Raymond committed
1089
  (interactive)
1090 1091 1092
  (let* ((dir (dired-current-directory))
	 (up (file-name-directory (directory-file-name dir))))
    (or (dired-goto-file (directory-file-name dir))
Richard M. Stallman's avatar
Richard M. Stallman committed
1093 1094
	;; Only try dired-goto-subdir if buffer has more than one dir.
	(and (cdr dired-subdir-alist)
1095 1096
	     (dired-goto-subdir up))
	(progn
1097 1098
	  (dired 
up)
1099
	  (dired-goto-file dir)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
1100

1101 1102
;; Force `f' rather than `e' in the mode doc:
(defalias 'dired-advertised-find-file 'dired-find-file)
Eric S. Raymond's avatar
Eric S. Raymond committed
1103 1104 1105
(defun dired-find-file ()
  "In dired, visit the file or directory named on this line."
  (interactive)
1106
  (find-file (file-name-sans-versions (dired-get-filename) t)))
Eric S. Raymond's avatar
Eric S. Raymond committed
1107

1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
(defun dired-mouse-find-file-other-window (event)
  "In dired, visit the file or directory name you click on."
  (interactive "e")
  (let (file)
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
	(setq file (dired-get-filename))))
    (select-window (posn-window (event-end event)))
    (find-file-other-window (file-name-sans-versions file t))))

Eric S. Raymond's avatar
Eric S. Raymond committed
1120
(defun dired-view-file ()
1121 1122 1123
  "In dired, examine a file in view mode, returning to dired when done.
When file is a directory, show it in this buffer if it is inserted;
otherwise, display it in another buffer."
Eric S. Raymond's avatar
Eric S. Raymond committed
1124 1125
  (interactive)
  (if (file-directory-p (dired-get-filename))
Richard M. Stallman's avatar
Richard M. Stallman committed
1126 1127
      (or (and (cdr dired-subdir-alist)
	       (dired-goto-subdir (dired-get-filename)))
1128
	  (dired (dired-get-filename)))
1129
    (view-file (dired-get-filename))))
Eric S. Raymond's avatar
Eric S. Raymond committed
1130 1131 1132 1133

(defun dired-find-file-other-window ()
  "In dired, visit this file or directory in another window."
  (interactive)
1134
  (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
1135 1136 1137 1138

(defun dired-display-file ()
  "In dired, display this file or directory in another window."
  (interactive)
1139 1140
  (let ((file (file-name-sans-versions (dired-get-filename) t)))
    (display-buffer (find-file-noselect file))))
1141 1142

;;; Functions for extracting and manipulating file names in dired buffers.
Eric S. Raymond's avatar
Eric S. Raymond committed
1143 1144 1145 1146

(defun dired-get-filename (&optional localp no-error-if-not-filep)
  "In dired, return name of file mentioned on this line.
Value returned normally includes the directory name.
1147 1148 1149 1150 1151 1152
Optional arg LOCALP with value `no-dir' means don't include directory
  name in result.  A value of t means construct name relative to
  `default-directory', which still may contain slashes if in a subdirectory.
Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
  this line, otherwise an error occurs."
  (let (case-fold-search file p1 p2)
Eric S. Raymond's avatar
Eric S. Raymond committed
1153
    (save-excursion
1154 1155 1156
      (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
	  (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
    ;; nil if no file on this line, but no-error-if-not-filep is t:
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
    (if (setq file (and p1 p2 (buffer-substring p1 p2)))
	(progn
	  ;; Get rid of the mouse-face property that file names have.
	  (set-text-properties 0 (length file) nil file)
	  ;; Unquote names quoted by ls or by dired-insert-directory.
	  ;; Using read to unquote is much faster than substituting
	  ;; \007 (4 chars) -> ^G  (1 char) etc. in a lisp loop.
	  (setq file
		(read
		 (concat "\""
			 ;; some ls -b don't escape quotes, argh!
			 ;; This is not needed for GNU ls, though.
			 (or (dired-string-replace-match
			      "\\([^\\]\\)\"" file "\\1\\\\\"")
			     file)
			 "\"")))))
1173 1174 1175 1176
    (if (eq localp 'no-dir)
	file
      (and file (concat (dired-current-directory localp) file)))))

1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
;; Cloning replace-match to work on strings instead of in buffer:
;; The FIXEDCASE parameter of replace-match is not implemented.
(defun dired-string-replace-match (regexp string newtext
					  &optional literal global)
  "Replace first match of REGEXP in STRING with NEWTEXT.
If it does not match, nil is returned instead of the new string.
Optional arg LITERAL means to take NEWTEXT literally.
Optional arg GLOBAL means to replace all matches."
  (if global
        (let ((result "") (start 0) mb me)
	  (while (string-match regexp string start)
	    (setq mb (match-beginning 0)
		  me (match-end 0)
		  result (concat result
				 (substring string start mb)
				 (if literal
				     newtext
				   (dired-expand-newtext string newtext)))
		  start me))
	  (if mb			; matched at least once
	      (concat result (substring string start))
	    nil))
    ;; not GLOBAL
    (if (not (string-match regexp string 0))
	nil
      (concat (substring string 0 (match-beginning 0))
	      (if literal newtext (dired-expand-newtext string newtext))
	      (substring string (match-end 0))))))

1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
(defun dired-make-absolute (file &optional dir)
  ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
  ;; We can't always use expand-file-name as this would get rid of `.'
  ;; or expand in / instead default-directory if DIR=="".
  ;; This should be good enough for ange-ftp, but might easily be
  ;; redefined (for VMS?).
  ;; It should be reasonably fast, though, as it is called in
  ;; dired-get-filename.
  (concat (or dir default-directory) file))

(defun dired-make-relative (file &optional dir no-error)
  ;;"Convert FILE (an absolute pathname) to a pathname relative to DIR.
  ;; Else error (unless NO-ERROR is non-nil, then FILE is returned unchanged)
  ;;DIR defaults to default-directory."
  ;; DIR must be file-name-as-directory, as with all directory args in
1221
  ;; Emacs Lisp code.
1222
  (or dir (setq dir default-directory))
1223 1224 1225 1226
  ;; This case comes into play if default-directory is set to
  ;; use ~.
  (if (and (> (length dir) 0) (= (aref dir 0) ?~))
      (setq dir (expand-file-name dir)))
1227 1228 1229 1230 1231 1232 1233 1234
  (if (string-match (concat "^" (regexp-quote dir)) file)
      (substring file (match-end 0))
    (if no-error
	file
      (error "%s: not in directory tree growing at %s" file dir))))

;;; Functions for finding the file name in a dired buffer line.

1235
(defvar dired-move-to-filename-regexp
1236
  "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|Sep\\|Oct\\|Nov\\|Dec\\)[ ]+[0-9]+ [ 0-9][0-9][:0-9][0-9][ 0-9] "
1237 1238
  "Regular expression to match a month abbreviation followed by a number.")

1239 1240 1241 1242 1243 1244
;; Move to first char of filename on this line.
;; Returns position (point) or nil if no filename on this line."
(defun dired-move-to-filename (&optional raise-error eol)
  ;; This is the UNIX version.
  (or eol (setq eol (progn (end-of-line) (point))))
  (beginning-of-line)
1245 1246 1247 1248
  (if (re-search-forward dired-move-to-filename-regexp eol t)
      (goto-char (match-end 0))
    (if raise-error
	(error "No file on this line"))))
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322

(defun dired-move-to-end-of-filename (&optional no-error)
  ;; Assumes point is at beginning of filename,
  ;; thus the rwx bit re-search-backward below will succeed in *this*
  ;; line if at all.  So, it should be called only after
  ;; (dired-move-to-filename t).
  ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
  ;; This is the UNIX version.
  (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
    ;; case-fold-search is nil now, so we can test for capital F:
    (setq used-F (string-match "F" dired-actual-switches)
	  opoint (point)
          eol (save-excursion (end-of-line) (point))
	  hidden (and selective-display
		      (save-excursion (search-forward "\r" eol t))))
    (if hidden
	nil
      (save-excursion;; Find out what kind of file this is:
	;; Restrict perm bits to be non-blank,
	;; otherwise this matches one char to early (looking backward):
	;; "l---------" (some systems make symlinks that way)
	;; "----------" (plain file with zero perms)
	(if (re-search-backward
	     "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
	     nil t)
	    (setq file-type (char-after (match-beginning 1))
		  symlink (eq file-type ?l)
		  ;; Only with -F we need to know whether it's an executable
		  executable (and
			      used-F
			      (string-match
			       "[xst]";; execute bit set anywhere?
			       (concat
				(buffer-substring (match-beginning 2)
						  (match-end 2))
				(buffer-substring (match-beginning 3)
						  (match-end 3))
				(buffer-substring (match-beginning 4)
						  (match-end 4))))))
	  (or no-error (</