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

Juri Linkov's avatar
Juri Linkov committed
3
;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 2000, 01, 03, 2004
4
;;  Free Software Foundation, Inc.
5

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

;; 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
14
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
15 16 17 18 19 20 21 22
;; 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
Erik Naggum's avatar
Erik Naggum committed
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
26

27 28
;;; Commentary:

29 30 31
;; This is a major mode for directory browsing and editing.  It is
;; documented in the Emacs manual.

32 33 34 35
;; 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.

36
;;; Code:
37 38 39

;;; Customizable variables

40 41
(defgroup dired nil
  "Directory editing."
42
  :link '(custom-manual "(emacs)Dired")
43
  :group 'files)
44 45

(defgroup dired-mark nil
Richard M. Stallman's avatar
Richard M. Stallman committed
46
  "Handling marks in Dired."
47 48 49 50
  :prefix "dired-"
  :group 'dired)


Eric S. Raymond's avatar
Eric S. Raymond committed
51
;;;###autoload
52
(defcustom dired-listing-switches "-al"
53 54
  "*Switches passed to `ls' for dired.  MUST contain the `l' option.
May contain all other options that don't contradict `-l';
55
may contain even `F', `b', `i' and `s'.  See also the variable
56 57 58 59
`dired-ls-F-marks-symlinks' concerning the `F' switch.
On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
some of the `ls' switches are not supported; see the doc string of
`insert-directory' on ls-lisp.el for more details."
60 61
  :type 'string
  :group 'dired)
Eric S. Raymond's avatar
Eric S. Raymond committed
62

63 64 65 66
(defvar dired-subdir-switches nil
  "If non-nil, switches passed to `ls' for inserting subdirectories.
If nil, `dired-listing-switches' is used.")

Kim F. Storm's avatar
Kim F. Storm committed
67
; Don't use absolute file names as /bin should be in any PATH and people
68 69 70 71
; 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
72
(defvar dired-chown-program
Juanma Barranquero's avatar
Juanma Barranquero committed
73
  (if (memq system-type '(hpux dgux usg-unix-v irix linux gnu/linux cygwin))
74 75 76 77
      "chown"
    (if (file-exists-p "/usr/sbin/chown")
	"/usr/sbin/chown"
      "/etc/chown"))
78
  "Name of chown command (usually `chown' or `/etc/chown').")
79

80 81 82
(defvar dired-use-ls-dired (not (not (string-match "gnu" system-configuration)))
  "Non-nil means Dired should use `ls --dired'.")

83 84
(defvar dired-chmod-program "chmod"
  "Name of chmod command (usually `chmod').")
Karl Heuer's avatar
Karl Heuer committed
85

86 87 88
(defvar dired-touch-program "touch"
  "Name of touch command (usually `touch').")

89
;;;###autoload
90
(defcustom dired-ls-F-marks-symlinks nil
91
  "*Informs dired about how `ls -lF' marks symbolic links.
92 93
Set this to t if `ls' (or whatever program is specified by
`insert-directory-program') with `-lF' marks the symbolic link
94
itself with a trailing @ (usually the case under Ultrix).
Eric S. Raymond's avatar
Eric S. Raymond committed
95

96 97 98 99 100 101
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
102 103 104
always set this variable to t."
  :type 'boolean
  :group 'dired-mark)
105 106

;;;###autoload
107
(defcustom dired-trivial-filenames "^\\.\\.?$\\|^#"
108 109
  "*Regexp of files to skip when finding first file of a directory.
A value of nil means move to the subdir line.
110 111 112 113 114
A value of t means move to first file."
  :type '(choice (const :tag "Move to subdir" nil)
		 (const :tag "Move to first" t)
		 regexp)
  :group 'dired)
115 116

;;;###autoload
117
(defcustom dired-keep-marker-rename t
118 119 120 121
  ;; 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)
122 123 124 125
are afterward marked with that character."
  :type '(choice (const :tag "Keep" t)
		 (character :tag "Mark"))
  :group 'dired-mark)
126 127

;;;###autoload
128
(defcustom dired-keep-marker-copy ?C
129 130
  "*Controls marking of copied files.
If t, copied files are marked if and as the corresponding original files were.
131 132 133 134
If a character, copied files are unconditionally marked with that character."
  :type '(choice (const :tag "Keep" t)
		 (character :tag "Mark"))
  :group 'dired-mark)
135 136

;;;###autoload
137
(defcustom dired-keep-marker-hardlink ?H
138 139
  "*Controls marking of newly made hard links.
If t, they are marked if and as the files linked to were marked.
140 141 142 143
If a character, new links are unconditionally marked with that character."
  :type '(choice (const :tag "Keep" t)
		 (character :tag "Mark"))
  :group 'dired-mark)
144 145

;;;###autoload
146
(defcustom dired-keep-marker-symlink ?Y
147 148
  "*Controls marking of newly made symbolic links.
If t, they are marked if and as the files linked to were marked.
149 150 151 152
If a character, new links are unconditionally marked with that character."
  :type '(choice (const :tag "Keep" t)
		 (character :tag "Mark"))
  :group 'dired-mark)
153 154

;;;###autoload
155
(defcustom dired-dwim-target nil
156 157 158 159
  "*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.

160 161 162
The target is used in the prompt for file copy, rename etc."
  :type 'boolean
  :group 'dired)
163 164

;;;###autoload
165
(defcustom dired-copy-preserve-time t
166
  "*If non-nil, Dired preserves the last-modified time in a file copy.
167 168 169
\(This works on only some systems.)"
  :type 'boolean
  :group 'dired)
170

171 172 173 174 175
; These variables were deleted and the replacements are on files.el.
; We leave aliases behind for back-compatibility.
(defvaralias 'dired-free-space-program 'directory-free-space-program)
(defvaralias 'dired-free-space-args 'directory-free-space-args)

176 177
;;; Hook variables

178
(defcustom dired-load-hook nil
179
  "Run after loading dired.
180 181 182
You can customize key bindings or load extensions with this."
  :group 'dired
  :type 'hook)
183

184 185 186 187
(defcustom dired-mode-hook nil
  "Run at the very end of dired-mode."
  :group 'dired
  :type 'hook)
188

189 190 191 192
(defcustom dired-before-readin-hook nil
  "This hook is run before a dired buffer is read in (created or reverted)."
  :group 'dired
  :type 'hook)
193

194
(defcustom dired-after-readin-hook nil
195 196
  "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
197 198 199
with the buffer narrowed to the listing."
  :group 'dired
  :type 'hook)
200 201 202
;; 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.

203
;; Fixme: This should use mailcap.
204
(defcustom dired-view-command-alist
205 206 207 208 209
  '(("\\.\\(ps\\|ps_pages\\|eps\\)\\'" . "gv %s")
    ("\\.pdf\\'" . "xpdf %s")
    ;; ("\\.pod\\'" . "perldoc %s")
    ("\\.\\(jpe?g\\|gif\\|png\\)\\'" . "eog %s")
    ("\\.dvi\\'" . "xdvi %s"))
210 211 212 213 214 215 216 217 218
  "Alist specifying how to view special types of files.
Each element has the form (REGEXP . SHELL-COMMAND).
When the file name matches REGEXP, `dired-view-file'
invokes SHELL-COMMAND to view the file, processing it through `format'.
Use `%s' in SHELL-COMMAND to specify where to put the file name."
  :group 'dired
  :type '(alist :key-type regexp :value-type string)
  :version "21.4")

219
;; Internal variables
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236

(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
237 238 239
  t
;; I see no reason ever to make this nil -- rms.
;;  (> baud-rate search-slow-speed)
240 241 242 243
  "Non-nil means Dired shrinks the display buffer to fit the marked files.")

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

244 245
(defvar dired-file-version-alist)

246
;;;###autoload
247
(defvar dired-directory nil
248
  "The directory name or wildcard spec that this Dired directory lists.
249
Local to each dired buffer.  May be a list, in which case the car is the
250 251
directory name and the cdr is the list of files to mention.
The directory name must be absolute, but need not be fully expanded.")
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266

(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 "^. ")
267 268 269 270
;; The [^:] part after "d" and "l" is to avoid confusion with the
;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
(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[^:]"))
271 272 273 274 275 276 277 278
(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]")
	     "\\|"))
279
(defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
280
(defvar dired-re-dot "^.* \\.\\.?/?$")
281

282
;; The subdirectory names in the next two lists are expanded.
283 284 285
(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
286 287
The order of elements is the reverse of the order in the buffer.
In simple cases, this list contains one element.")
288

289 290 291 292 293
(defvar dired-switches-alist nil
  "Keeps track of which switches to use for inserted subdirectories.
This is an alist of the form (SUBDIR . SWITCHES).")
(make-variable-buffer-local 'dired-switches-alist)

294
(defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
295 296 297 298 299 300
  "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.")

Juri Linkov's avatar
Juri Linkov committed
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
(defgroup dired-faces nil
  "Faces used by dired."
  :group 'dired
  :group 'faces)

(defface dired-header
  '((t (:inherit font-lock-type-face)))
  "Face used for directory headers."
  :group 'dired-faces
  :version "21.4")
(defvar dired-header-face 'dired-header
  "Face name used for directory headers.")

(defface dired-mark
  '((t (:inherit font-lock-constant-face)))
  "Face used for dired marks."
  :group 'dired-faces
  :version "21.4")
(defvar dired-mark-face 'dired-mark
  "Face name used for dired marks.")

(defface dired-marked
  '((t (:inherit font-lock-warning-face)))
  "Face used for marked files."
  :group 'dired-faces
  :version "21.4")
(defvar dired-marked-face 'dired-marked
  "Face name used for marked files.")

(defface dired-flagged
  '((t (:inherit font-lock-warning-face)))
  "Face used for flagged files."
  :group 'dired-faces
  :version "21.4")
(defvar dired-flagged-face 'dired-flagged
  "Face name used for flagged files.")

(defface dired-warning
  '((t (:inherit font-lock-comment-face)))
  "Face used to highlight a part of a buffer that needs user attention."
  :group 'dired-faces
  :version "21.4")
(defvar dired-warning-face 'dired-warning
  "Face name used for a part of a buffer that needs user attention.")

(defface dired-directory
  '((t (:inherit font-lock-function-name-face)))
  "Face used for subdirectories."
  :group 'dired-faces
  :version "21.4")
(defvar dired-directory-face 'dired-directory
  "Face name used for subdirectories.")

(defface dired-symlink
  '((t (:inherit font-lock-keyword-face)))
  "Face used for symbolic links."
  :group 'dired-faces
  :version "21.4")
(defvar dired-symlink-face 'dired-symlink
  "Face name used for symbolic links.")

(defface dired-ignored
  '((t (:inherit font-lock-string-face)))
  "Face used for files suffixed with `completion-ignored-extensions'."
  :group 'dired-faces
  :version "21.4")
(defvar dired-ignored-face 'dired-ignored
  "Face name used for files suffixed with `completion-ignored-extensions'.")

370 371 372 373
(defvar dired-font-lock-keywords
  (list
   ;;
   ;; Directory headers.
Juri Linkov's avatar
Juri Linkov committed
374 375 376 377
   (list dired-subdir-regexp '(1 dired-header-face))
   ;;
   ;; Dired marks.
   (list dired-re-mark '(0 dired-mark-face))
378 379 380 381 382 383
   ;;
   ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
   ;; file name itself.  We search for Dired defined regexps, and then use the
   ;; Dired defined function `dired-move-to-filename' before searching for the
   ;; simple regexp ".+".  It is that regexp which matches the file name.
   ;;
Juri Linkov's avatar
Juri Linkov committed
384 385 386 387 388 389 390
   ;; Marked files.
   (list (concat "^[" (char-to-string dired-marker-char) "]")
         '(".+" (dired-move-to-filename) nil (0 dired-marked-face)))
   ;;
   ;; Flagged files.
   (list (concat "^[" (char-to-string dired-del-marker) "]")
         '(".+" (dired-move-to-filename) nil (0 dired-flagged-face)))
391 392 393 394 395 396 397 398
   ;; People who are paranoid about security would consider this more
   ;; important than other things such as whether it is a directory.
   ;; But we don't want to encourage paranoia, so our default
   ;; should be what's most useful for non-paranoids. -- rms.
;;;   ;;
;;;   ;; Files that are group or world writable.
;;;   (list (concat dired-re-maybe-mark dired-re-inode-size
;;;		 "\\([-d]\\(....w....\\|.......w.\\)\\)")
Juri Linkov's avatar
Juri Linkov committed
399 400
;;;	 '(1 dired-warning-face)
;;;	 '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
401 402 403 404 405
   ;; However, we don't need to highlight the file name, only the
   ;; permissions, to win generally.  -- fx.
   ;; Fixme: we could also put text properties on the permission
   ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
   (list (concat dired-re-maybe-mark dired-re-inode-size
406
		 "[-d]....\\(w\\)....")	; group writable
Juri Linkov's avatar
Juri Linkov committed
407
	 '(1 dired-warning-face))
408
   (list (concat dired-re-maybe-mark dired-re-inode-size
409
		 "[-d].......\\(w\\).")	; world writable
Juri Linkov's avatar
Juri Linkov committed
410
	 '(1 dired-warning-face))
411 412 413
   ;;
   ;; Subdirectories.
   (list dired-re-dir
Juri Linkov's avatar
Juri Linkov committed
414
	 '(".+" (dired-move-to-filename) nil (0 dired-directory-face)))
415 416
   ;;
   ;; Symbolic links.
Juanma Barranquero's avatar
Juanma Barranquero committed
417
   (list dired-re-sym
Juri Linkov's avatar
Juri Linkov committed
418
	 '(".+" (dired-move-to-filename) nil (0 dired-symlink-face)))
419 420 421
   ;;
   ;; Files suffixed with `completion-ignored-extensions'.
   '(eval .
422 423 424
     ;; It is quicker to first find just an extension, then go back to the
     ;; start of that file name.  So we do this complex MATCH-ANCHORED form.
     (list (concat "\\(" (regexp-opt completion-ignored-extensions) "\\|#\\)$")
Juri Linkov's avatar
Juri Linkov committed
425
	   '(".+" (dired-move-to-filename) nil (0 dired-ignored-face)))))
426
  "Additional expressions to highlight in Dired mode.")
Dave Love's avatar
Dave Love committed
427

428 429 430
;;; Macros must be defined before they are used, for the byte compiler.

(defmacro dired-mark-if (predicate msg)
431 432 433 434 435
  "Mark all files for which PREDICATE evals to non-nil.
PREDICATE 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."
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
  `(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)))
456 457

(defmacro dired-map-over-marks (body arg &optional show-progress)
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
  "Eval BODY with point on each marked line.  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)
510
		 (setq next-position (and (re-search-forward regexp nil t)
511 512 513 514 515 516
					  (point-marker)))))
	     (if found
		 results
	       (list ,body)))))
     ;; save-excursion loses, again
     (dired-move-to-filename)))
517

518
(defun dired-get-marked-files (&optional localp arg filter)
519 520 521
  "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.
522
Values returned are normally absolute file names.
523
Optional arg LOCALP as in `dired-get-filename'.
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
Optional second argument ARG specifies files near point
 instead of marked files.  If ARG is an integer, use the next ARG files.
  If ARG is otherwise non-nil, use file.  Usually ARG comes from
  the command's prefix arg.
Optional third argument FILTER, if non-nil, is a function to select
  some of the files--those for which (funcall FILTER FILENAME) is non-nil."
  (let ((all-of-them
	 (save-excursion
	   (dired-map-over-marks (dired-get-filename localp) arg)))
	result)
    (if (not filter)
	(nreverse all-of-them)
      (dolist (file all-of-them)
	(if (funcall filter file)
	    (push file result)))
      result)))
Dave Love's avatar
Dave Love committed
540

541 542 543 544 545 546 547 548
;; 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))
549 550 551 552 553 554 555 556
	    ;; If a dialog is about to be used, call read-directory-name so
	    ;; the dialog code knows we want directories.  Some dialogs can
	    ;; only select directories or files when popped up, not both.
	    (if (next-read-file-uses-dialog-p)
		(read-directory-name (format "Dired %s(directory): " str)
				     nil default-directory nil)
	      (read-file-name (format "Dired %s(directory): " str)
			      nil default-directory nil)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
557

558
;;;###autoload (define-key ctl-x-map "d" 'dired)
Eric S. Raymond's avatar
Eric S. Raymond committed
559
;;;###autoload
560
(defun dired (dirname &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
561
  "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
562 563 564
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
565
shell wildcards appended to select certain files).  If DIRNAME is a cons,
Richard M. Stallman's avatar
Richard M. Stallman committed
566
its first element is taken as the directory name and the rest as an explicit
567
list of files to make directory entries for.
568
\\<dired-mode-map>\
569
You can move around in it with the usual commands.
570 571
You can flag files for deletion with \\[dired-flag-file-deletion] and then
delete them by typing \\[dired-do-flagged-delete].
572
Type \\[describe-mode] after entering dired for more info.
Eric S. Raymond's avatar
Eric S. Raymond committed
573

574 575 576 577 578 579
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
580
;;;###autoload
581
(defun dired-other-window (dirname &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
582
  "\"Edit\" directory DIRNAME.  Like `dired' but selects in another window."
583 584
  (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
585

586 587 588 589 590 591 592
;;;###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
593
;;;###autoload
594
(defun dired-noselect (dir-or-list &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
595
  "Like `dired' but returns the dired buffer as value, does not select it."
596
  (or dir-or-list (setq dir-or-list default-directory))
597 598
  ;; This loses the distinction between "/foo/*/" and "/foo/*" that
  ;; some shells make:
599
  (let (dirname initially-was-dirname)
600 601 602
    (if (consp dir-or-list)
	(setq dirname (car dir-or-list))
      (setq dirname dir-or-list))
603 604
    (setq initially-was-dirname
	  (string= (file-name-as-directory dirname) dirname))
605 606
    (setq dirname (abbreviate-file-name
		   (expand-file-name (directory-file-name dirname))))
607 608
    (if find-file-visit-truename
	(setq dirname (file-truename dirname)))
609 610 611 612 613 614 615 616
    ;; If the argument was syntactically  a directory name not a file name,
    ;; or if it happens to name a file that is a directory,
    ;; convert it syntactically to a directory name.
    ;; The reason for checking initially-was-dirname
    ;; and not just file-directory-p
    ;; is that file-directory-p is slow over ftp.
    (if (or initially-was-dirname (file-directory-p dirname))
	(setq dirname  (file-name-as-directory dirname)))
617 618 619 620
    (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)))
621

622 623 624 625 626
;; The following is an internal dired function.  It returns non-nil if
;; the directory visited by the current dired buffer has changed on
;; disk.  DIRNAME should be the directory name of that directory.
(defun dired-directory-changed-p (dirname)
  (not (let ((attributes (file-attributes dirname))
627 628 629
	     (modtime (visited-file-modtime)))
	 (or (eq modtime 0)
	     (not (eq (car attributes) t))
630
	     (equal (nth 5 attributes) modtime)))))
631 632 633 634 635 636 637 638 639 640 641 642

(defun dired-buffer-stale-p (&optional noconfirm)
  "Return non-nil if current dired buffer needs updating.
If NOCONFIRM is non-nil, then this function always returns nil
for a remote directory.  This feature is used by Auto Revert Mode."
  (let ((dirname
	 (if (consp dired-directory) (car dired-directory) dired-directory)))
    (and (stringp dirname)
	 (not (when noconfirm (file-remote-p dirname)))
	 (file-readable-p dirname)
	 (dired-directory-changed-p dirname))))

643
;; Separate function from dired-noselect for the sake of dired-vms.el.
644
(defun dired-internal-noselect (dir-or-list &optional switches mode)
645 646 647
  ;; 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.
648
  ;; The user can type `g' easily, and it is more consistent with find-file.
649 650 651 652 653
  ;; 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.
654 655
  ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
  ;; see there.
656 657
  (let* (dirname
	 buffer
658
	 ;; note that buffer already is in dired-mode, if found
659
	 new-buffer-p
660
	 (old-buf (current-buffer)))
661 662 663 664 665 666
    (if (consp dir-or-list)
	(setq dirname (car dir-or-list))
      (setq dirname dir-or-list))
    ;; Look for an existing buffer.
    (setq buffer (dired-find-buffer-nocreate dirname mode)
	  new-buffer-p (null buffer))
667 668 669 670 671 672 673
    (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)
674 675
    (if (not new-buffer-p)		; existing buffer ...
	(cond (switches			; ... but new switches
676
	       ;; file list may have changed
677
	       (setq dired-directory dir-or-list)
678
	       ;; this calls dired-revert
Juanma Barranquero's avatar
Juanma Barranquero committed
679
	       (dired-sort-other switches))
680
	      ;; If directory has changed on disk, offer to revert.
681
	      ((when (dired-directory-changed-p dirname)
682
		 (message "%s"
Karl Heuer's avatar
Karl Heuer committed
683 684
			  (substitute-command-keys
			   "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
685
      ;; Else a new buffer
686
      (setq default-directory
687 688 689 690 691
	    ;; We can do this unconditionally
	    ;; because dired-noselect ensures that the name
	    ;; is passed in directory name syntax
	    ;; if it was the name of a directory at all.
	    (file-name-directory dirname))
692
      (or switches (setq switches dired-listing-switches))
693
      (if mode (funcall mode)
694
        (dired-mode dir-or-list switches))
695 696 697 698
      ;; default-directory and dired-actual-switches are set now
      ;; (buffer-local), so we can call dired-readin:
      (let ((failed t))
	(unwind-protect
699
	    (progn (dired-readin)
700 701 702 703 704 705 706
		   (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))))
      (goto-char (point-min))
      (dired-initial-position dirname))
    (set-buffer old-buf)
Eric S. Raymond's avatar
Eric S. Raymond committed
707 708
    buffer))

709 710 711 712 713 714
(defvar dired-buffers nil
  ;; Enlarged by dired-advertise
  ;; Queried by function dired-buffers-for-dir. When this detects a
  ;; killed buffer, it is removed from this list.
  "Alist of expanded directories and their associated dired buffers.")

715 716 717 718
(defun dired-find-buffer-nocreate (dirname &optional mode)
  ;; This differs from dired-buffers-for-dir in that it does not consider
  ;; subdirs of default-directory and searches for the first match only.
  ;; Also, the major mode must be MODE.
719
  (setq dirname (expand-file-name dirname))
720
  (let (found (blist dired-buffers))    ; was (buffer-list)
721
    (or mode (setq mode 'dired-mode))
722
    (while blist
723 724 725 726
      (if (null (buffer-name (cdr (car blist))))
	  (setq blist (cdr blist))
	(save-excursion
	  (set-buffer (cdr (car blist)))
727
	  (if (and (eq major-mode mode)
728
		   dired-directory  ;; nil during find-alternate-file
729 730 731 732 733
		   (equal dirname
			  (expand-file-name
			   (if (consp dired-directory)
			       (car dired-directory)
			     dired-directory))))
734 735 736
	      (setq found (cdr (car blist))
		    blist nil)
	    (setq blist (cdr blist))))))
737 738
    found))

Dave Love's avatar
Dave Love committed
739

740 741
;; Read in a new dired buffer

742
(defun dired-readin ()
743 744 745 746 747
  "Read in a new dired buffer.
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)."

748 749
  ;; default-directory and dired-actual-switches must be buffer-local
  ;; and initialized by now.
750 751 752 753
  (let (dirname)
    (if (consp dired-directory)
	(setq dirname (car dired-directory))
      (setq dirname dired-directory))
754 755
    (setq dirname (expand-file-name dirname))
    (save-excursion
756 757 758 759 760 761 762 763 764
      ;; This hook which may want to modify dired-actual-switches
      ;; based on dired-directory, e.g. with ange-ftp to a SysV host
      ;; where ls won't understand -Al switches.
      (run-hooks 'dired-before-readin-hook)
      (if (consp buffer-undo-list)
	  (setq buffer-undo-list nil))
      (let (buffer-read-only
	    ;; Don't make undo entries for readin.
	    (buffer-undo-list t))
765 766
	(widen)
	(erase-buffer)
767 768
	(dired-readin-insert))
      (goto-char (point-min))
769 770 771
      ;; 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)
772
      (dired-build-subdir-alist)
773 774 775
      (let ((attributes (file-attributes dirname)))
	(if (eq (car attributes) t)
	    (set-visited-file-modtime (nth 5 attributes))))
776 777 778 779 780 781
      (set-buffer-modified-p nil)
      ;; 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))))
782 783 784

;; Subroutines of dired-readin

785 786 787 788 789 790 791 792 793
(defun dired-readin-insert ()
  ;; Insert listing for the specified dir (and maybe file list)
  ;; already in dired-directory, assuming a clean buffer.
  (let (dir file-list)
    (if (consp dired-directory)
	(setq dir (car dired-directory)
	      file-list (cdr dired-directory))
      (setq dir dired-directory
	    file-list nil))
794
    (setq dir (expand-file-name dir))
795 796
    (if (and (equal "" (file-name-nondirectory dir))
	     (not file-list))
797
	;; If we are reading a whole single directory...
798
	(dired-insert-directory dir dired-actual-switches nil nil t)
799
      (if (not (file-readable-p
800 801 802 803 804 805 806
		(directory-file-name (file-name-directory dir))))
	  (error "Directory %s inaccessible or nonexistent" dir)
	;; Else treat it as a wildcard spec
	;; unless we have an explicit list of files.
	(dired-insert-directory dir dired-actual-switches
				file-list (not file-list) t)))))

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 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
(defun dired-align-file (beg end)
  "Align the fields of a file to the ones of surrounding lines.
BEG..END is the line where the file info is located."
  ;; Some versions of ls try to adjust the size of each field so as to just
  ;; hold the largest element ("largest" in the current invocation, of
  ;; course).  So when a single line is output, the size of each field is
  ;; just big enough for that one output.  Thus when dired refreshes one
  ;; line, the alignment if this line w.r.t the rest is messed up because
  ;; the fields of that one line will generally be smaller.
  ;;
  ;; To work around this problem, we here add spaces to try and re-align the
  ;; fields as needed.  Since this is purely aesthetic, it is of utmost
  ;; importance that it doesn't mess up anything like
  ;; `dired-move-to-filename'.  To this end, we limit ourselves to adding
  ;; spaces only, and to only add them at places where there was already at
  ;; least one space.  This way, as long as `dired-move-to-filename-regexp'
  ;; always matches spaces with "*" or "+", we know we haven't made anything
  ;; worse.  There is one spot where the exact number of spaces is
  ;; important, which is just before the actual filename, so we refrain from
  ;; adding spaces there (and within the filename as well, of course).
  (save-excursion
    (let (file file-col other other-col)
      ;; Check the there is indeed a file, and that there is anoter adjacent
      ;; file with which to align, and that additional spaces are needed to
      ;; align the filenames.
      (when (and (setq file (progn (goto-char beg)
				   (dired-move-to-filename nil end)))
		 (setq file-col (current-column))
		 (setq other
		       (or (and (goto-char beg)
				(zerop (forward-line -1))
				(dired-move-to-filename))
			   (and (goto-char beg)
				(zerop (forward-line 1))
				(dired-move-to-filename))))
		 (setq other-col (current-column))
		 (/= file other)
		 ;; Make sure there is some work left to do.
		 (> other-col file-col))
	;; If we've only looked at the line above, check to see if the line
	;; below exists as well and if so, align with the shorter one.
	(when (and (< other file)
		   (goto-char beg)
		   (zerop (forward-line 1))
		   (dired-move-to-filename))
	  (let ((alt-col (current-column)))
	    (when (< alt-col other-col)
	      (setq other-col alt-col)
	      (setq other (point)))))
	;; Keep positions uptodate when we insert stuff.
	(if (> other file) (setq other (copy-marker other)))
	(setq file (copy-marker file))
	;; Main loop.
	(goto-char beg)
	(while (and (> other-col file-col)
		    (skip-chars-forward "^ ")
		    ;; Skip the spaces, and make sure there's at least one.
		    (> (skip-chars-forward " ") 0)
		    ;; Don't touch anything just before (and after) the
		    ;; beginning of the filename.
		    (> file (point)))
	  ;; We're now just in front of a field, with a space behind us.
	  (let* ((curcol (current-column))
		 ;; Nums are right-aligned.
		 (num-align (looking-at "[0-9]"))
		 ;; Let's look at the other line, in the same column: we
		 ;; should be either near the end of the previous field, or
		 ;; in the space between that field and the next.
		 ;; [ Of course, it's also possible that we're already within
		 ;; the next field or even past it, but that's unlikely since
		 ;; other-col > file-col. ]
		 ;; Let's find the distance to the alignment-point (either
		 ;; the beginning or the end of the next field, depending on
		 ;; whether this field is left or right aligned).
		 (align-pt-offset
		  (save-excursion
		    (goto-char other)
		    (move-to-column curcol)
		    (when (looking-at
			   (concat
			    (if (eq (char-before) ?\ ) " *" "[^ ]* *")
			    (if num-align "[0-9][^ ]*")))
		      (- (match-end 0) (match-beginning 0)))))
		 ;; Now, the number of spaces to insert is align-pt-offset
		 ;; minus the distance to the equivalent point on the
		 ;; current line.
		 (spaces
		  (if (not num-align)
		      align-pt-offset
		    (and align-pt-offset
			 (save-excursion
			   (skip-chars-forward "^ ")
			   (- align-pt-offset (- (current-column) curcol)))))))
	    (when (and spaces (> spaces 0))
	      (setq file-col (+ spaces file-col))
	      (if (> file-col other-col)
		  (setq spaces (- spaces (- file-col other-col))))
	      (insert-char ?\s spaces)
	      ;; Let's just make really sure we did not mess up.
	      (unless (save-excursion
			(equal (dired-move-to-filename) (marker-position file)))
		;; Damn!  We messed up: let's revert the change.
		(delete-char (- spaces))))))
	(set-marker file nil)))))
			 

913 914 915 916 917 918 919 920
(defun dired-insert-directory (dir switches &optional file-list wildcard hdr)
  "Insert a directory listing of DIR, Dired style.
Use SWITCHES to make the listings.
If FILE-LIST is non-nil, list only those files.
Otherwise, if WILDCARD is non-nil, expand wildcards;
 in that case, DIR should be a file name that uses wildcards.
In other cases, DIR should be a directory name or a directory filename.
If HDR is non-nil, insert a header line with the directory name."
921
  (let ((opoint (point))
922
	(process-environment (copy-sequence process-environment))
923
	end)
924
    (if (or dired-use-ls-dired (file-remote-p dir))
925
	(setq switches (concat "--dired " switches)))
926 927 928
    ;; We used to specify the C locale here, to force English month names;
    ;; but this should not be necessary any more,
    ;; with the new value of dired-move-to-filename-regexp.
929 930
    (if file-list
	(dolist (f file-list)
931 932 933 934
	  (let ((beg (point)))
	    (insert-directory f switches nil nil)
	    ;; Re-align fields, if necessary.
	    (dired-align-file beg (point))))
935
      (insert-directory dir switches wildcard (not wildcard)))
936
    ;; Quote certain characters, unless ls quoted them for us.
937 938 939 940 941
    (if (not (string-match "b" dired-actual-switches))
	(save-excursion
	  (setq end (point-marker))
	  (goto-char opoint)
	  (while (search-forward "\\" end t)
942 943 944 945
	    (replace-match (apply #'propertize
				  "\\\\"
				  (text-properties-at (match-beginning 0)))
			   nil t))
946 947
	  (goto-char opoint)
	  (while (search-forward "\^m" end t)
948 949 950 951
	    (replace-match (apply #'propertize
				  "\\015"
				  (text-properties-at (match-beginning 0)))
			   nil t))
952
	  (set-marker end nil)))
953 954 955 956
    (dired-insert-set-properties opoint (point))
    ;; If we used --dired and it worked, the lines are already indented.
    ;; Otherwise, indent them.
    (unless (save-excursion
957
	      (goto-char opoint)
958 959 960 961 962 963 964 965 966 967 968 969 970 971
	      (looking-at "  "))
      (let ((indent-tabs-mode nil))
	(indent-rigidly opoint (point) 2)))
    ;; Insert text at the beginning to standardize things.
    (save-excursion
      (goto-char opoint)
      (if (and (or hdr wildcard) (not (looking-at "^  /.*:$")))
	  ;; Note that dired-build-subdir-alist will replace the name
	  ;; by its expansion, so it does not matter whether what we insert
	  ;; here is fully expanded, but it should be absolute.
	  (insert "  " (directory-file-name (file-name-directory dir)) ":\n"))
      (when wildcard
	;; Insert "wildcard" line where "total" line would be for a full dir.
	(insert "  wildcard " (file-name-nondirectory dir) "\n")))))
972

973
(defun dired-insert-set-properties (beg end)
974
  "Make the file names highlight when the mouse is on them."
975 976 977
  (save-excursion
    (goto-char beg)
    (while (< (point) end)
978 979
      (condition-case nil
	  (if (dired-move-to-filename)
980 981 982 983 984
	      (add-text-properties
	       (point)
	       (save-excursion
		 (dired-move-to-end-of-filename)
		 (point))
985
	       '(mouse-face highlight
986
		 help-echo "mouse-2: visit this file in other window")))
987
	(error nil))
988
      (forward-line 1))))
Dave Love's avatar
Dave Love committed
989

990 991
;; Reverting a dired buffer

Eric S. Raymond's avatar
Eric S. Raymond committed
992
(defun dired-revert (&optional arg noconfirm)
993 994 995 996
  "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."
997
  (widen)				; just in case user narrowed
998 999
  (let ((modflag (buffer-modified-p))
	(opoint (point))
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
	(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)
1010 1011
    (dired-uncache
     (if (consp dired-directory) (car dired-directory) dired-directory))
1012
    (dired-readin)
1013 1014 1015 1016 1017 1018 1019 1020 1021
    (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
1022
    (dired-move-to-filename)
1023
    (save-excursion			; hide subdirs that were hidden
1024 1025
      (dolist (dir hidden-subdirs)
	(if (dired-goto-subdir dir)
1026 1027
	    (dired-hide-subdir 1))))
    (unless modflag (restore-buffer-modified-p nil)))
1028
  ;; outside of the let scope
1029
;;;  Might as well not override the user if the user changed this.
1030 1031 1032 1033 1034 1035 1036
;;;  (setq buffer-read-only t)
  )

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

(defun dired-remember-marks (beg end)
1037
  "Return alist of files and their marks, from BEG to END."
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
  (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))

(defun dired-mark-remembered (alist)
1051 1052
  "Mark all files remembered in ALIST.
Each element of ALIST looks like (FILE . MARKERCHAR)."
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
  (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))))))

(defun dired-remember-hidden ()
1066
  "Return a list of names of subdirs currently hidden."
1067 1068 1069 1070 1071 1072 1073
  (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")
1074
      (if (eq (following-char) ?\r)
1075 1076 1077 1078
	  (setq result (cons dir result))))
    result))

(defun dired-insert-old-subdirs (old-subdir-alist)
1079 1080
  "Try to insert all subdirs that were displayed before.
Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1081 1082 1083 1084 1085 1086 1087
  (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 ()
1088 1089
	      (progn
		(dired-uncache dir)
1090
		(dired-insert-subdir dir))
1091
	    (error nil))))))
1092 1093

(defun dired-uncache (dir)
1094
  "Remove directory DIR from any directory cache."
1095
  (let ((handler (find-file-name-handler dir 'dired-uncache)))
1096 1097
    (if handler
	(funcall handler 'dired-uncache dir))))
Dave Love's avatar
Dave Love committed
1098

1099
;; dired mode key bindings and initialization
Eric S. Raymond's avatar
Eric S. Raymond committed
1100

1101
(defvar dired-mode-map
1102 1103
  ;; This looks ugly when substitute-command-keys uses C-d instead d:
  ;;  (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1104 1105 1106 1107 1108 1109 1110
  (let ((map (make-keymap)))
    (suppress-keymap map)
    (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
    ;; Commands to mark or flag certain categories of files
    (define-key map "#" 'dired-flag-auto-save-files)
    (define-key map "." 'dired-clean-directory)
    (define-key map "~" 'dired-flag-backup-files)
1111
    (define-key map "&" 'dired-flag-garbage-files)
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
    ;; Upper case keys (except !) for operating on the marked files
    (define-key map "A" 'dired-do-search)
    (define-key map "C" 'dired-do-copy)
    (define-key map "B" 'dired-do-byte-compile)
    (define-key map "D" 'dired-do-delete)
    (define-key map "G" 'dired-do-chgrp)
    (define-key map "H" 'dired-do-hardlink)
    (define-key map "L" 'dired-do-load)
    (define-key map "M" 'dired-do-chmod)
    (define-key map "O" 'dired-do-chown)
    (define-key map "P" 'dired-do-print)
1123
    (define-key map "Q" 'dired-do-query-replace-regexp)
1124 1125
    (define-key map "R" 'dired-do-rename)
    (define-key map "S" 'dired-do-symlink)
1126
    (define-key map "T" 'dired-do-touch)
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    (define-key map "X" 'dired-do-shell-command)
    (define-key map "Z" 'dired-do-compress)
    (define-key map "!" 'dired-do-shell-command)
    ;; Comparison commands
    (define-key map "=" 'dired-diff)
    (define-key map "\M-=" 'dired-backup-diff)
    ;; Tree Dired commands
    (define-key map "\M-\C-?" 'dired-unmark-all-files)
    (define-key map "\M-\C-d" 'dired-tree-down)
    (define-key map "\M-\C-u" 'dired-tree-up)
    (define-key map "\M-\C-n" 'dired-next-subdir)
    (define-key map "\M-\C-p" 'dired-prev-subdir)
    ;; move to marked files
    (define-key map "\M-{" 'dired-prev-marked-file)
    (define-key map "\M-}" 'dired-next-marked-file)
    ;; Make all regexp commands share a `%' prefix:
    ;; 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 map "%" nil)
    (define-key map "%u" 'dired-upcase)
    (define-key map "%l" 'dired-downcase)
    (define-key map "%d" 'dired-flag-files-regexp)
1150
    (define-key map "%g" 'dired-mark-files-containing-regexp)
1151 1152 1153 1154 1155 1156
    (define-key map "%m" 'dired-mark-files-regexp)
    (define-key map "%r" 'dired-do-rename-regexp)
    (define-key map "%C" 'dired-do-copy-regexp)
    (define-key map "%H" 'dired-do-hardlink-regexp)
    (define-key map "%R" 'dired-do-rename-regexp)
    (define-key map "%S" 'dired-do-symlink-regexp)
1157 1158 1159 1160 1161 1162 1163
    ;; Commands for marking and unmarking.
    (define-key map "*" nil)
    (define-key map "**" 'dired-mark-executables)
    (define-key map "*/" 'dired-mark-directories)
    (define-key map "*@" 'dired-mark-symlinks)
    (define-key map "*%" 'dired-mark-files-regexp)
    (define-key map "*c" 'dired-change-marks)
1164
    (define-key map "*s" 'dired-mark-subdir-files)
1165 1166 1167
    (define-key map "*m" 'dired-mark)
    (define-key map "*u" 'dired-unmark)
    (define-key map "*?" 'dired-unmark-all-files)
1168
    (define-key map "*!" 'dired-unmark-all-marks)
1169
    (define-key map "U" 'dired-unmark-all-marks)
1170 1171 1172
    (define-key map "*\177" 'dired-unmark-backward)
    (define-key map "*\C-n" 'dired-next-marked-file)
    (define-key map "*\C-p" 'dired-prev-marked-file)
1173
    (define-key map "*t" 'dired-toggle-marks)
1174
    ;; Lower keys for commands not operating on all the marked files
1175
    (define-key map "a" 'dired-find-alternate-file)
1176 1177 1178 1179 1180
    (define-key map "d" 'dired-flag-file-deletion)
    (define-key map "e" 'dired-find-file)
    (define-key map "f" 'dired-find-file)
    (define-key map "\C-m" 'dired-advertised-find-file)
    (define-key map "g" 'revert-buffer)
Luc Teirlinck's avatar
Luc Teirlinck committed
1181
    (define-key map "\M-g" 'dired-goto-file)
1182 1183 1184 1185 1186 1187 1188 1189 1190
    (define-key map "h" 'describe-mode)
    (define-key map "i" 'dired-maybe-insert-subdir)
    (define-key map "k" 'dired-do-kill-lines)
    (define-key map "l" 'dired-do-redisplay)
    (define-key map "m" 'dired-mark)
    (define-key map "n" 'dired-next-line)
    (define-key map "o" 'dired-find-file-other-window)
    (define-key map "\C-o" 'dired-display-file)
    (define-key map "p" 'dired-previous-line)
1191
    (define-key map "q" 'quit-window)
1192
    (define-key map "s" 'dired-sort-toggle-or-edit)
1193
    (define-key map "t" 'dired-toggle-marks)
1194 1195
    (define-key map "u" 'dired-unmark)
    (define-key map "v" 'dired-view-file)
1196
    (define-key map "w" 'dired-copy-filename-as-kill)
1197
    (define-key map "x" 'dired-do-flagged-delete)
1198
    (define-key map "y" 'dired-show-file-type)
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
    (define-key map "+" 'dired-create-directory)
    ;; moving
    (define-key map "<" 'dired-prev-dirline)
    (define-key map ">" 'dired-next-dirline)
    (define-key map "^" 'dired-up-directory)
    (define-key map " "  'dired-next-line)
    (define-key map "\C-n" 'dired-next-line)
    (define-key map "\C-p" 'dired-previous-line)
    (define-key map [down] 'dired-next-line)
    (define-key map [up] 'dired-previous-line)
    ;; hiding
    (define-key map "$" 'dired-hide-subdir)
    (define-key map "\M-$" 'dired-hide-all)
    ;; misc
    (define-key map "?" 'dired-summary)
    (define-key map "\177" 'dired-unmark-backward)
    (define-key map "\C-_" 'dired-undo)
    (define-key map "\C-xu" 'dired-undo)

    ;; Make menu bar items.

1220 1221
    ;; No need to fo this, now that top-level items are fewer.
    ;;;;