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

3
;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4
;;   2001, 2002, 2003, 2004, 2005 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, 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
  "*Switches passed to `ls' for Dired.  MUST contain the `l' option.
54
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
`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
59
`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
  "*If non-nil, Dired tries to guess a default target directory.
157 158 159
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
(defcustom dired-mode-hook nil
185
  "Run at the very end of `dired-mode'."
186 187
  :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 204 205 206 207 208 209 210 211 212 213 214
(defcustom dired-dnd-protocol-alist
  '(("^file:///" . dired-dnd-handle-local-file)
    ("^file://"  . dired-dnd-handle-file)
    ("^file:"    . dired-dnd-handle-local-file))
  "The functions to call when a drop in `dired-mode' is made.
See `dnd-protocol-alist' for more information.  When nil, behave
as in other buffers."
  :type '(choice (repeat (cons (regexp) (function)))
		 (const :tag "Behave as in other buffers" nil))
  :version "22.1"
  :group 'dired)

215
;; Internal variables
216 217 218 219 220 221 222 223 224 225 226

(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.
227
This is what the do-commands look for, and what the mark-commands store.")
228 229 230 231

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

232
(defvar dired-shrink-to-fit t
233 234
;; I see no reason ever to make this nil -- rms.
;;  (> baud-rate search-slow-speed)
235 236 237 238
  "Non-nil means Dired shrinks the display buffer to fit the marked files.")

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

239 240
(defvar dired-file-version-alist)

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

(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 "^. ")
262 263 264 265
;; 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[^:]"))
266 267 268 269 270 271 272 273
(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]")
	     "\\|"))
274
(defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
275
(defvar dired-re-dot "^.* \\.\\.?/?$")
276

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

284 285 286 287 288
(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)

289
(defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
290 291 292 293 294 295
  "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
296
(defgroup dired-faces nil
297
  "Faces used by Dired."
Juri Linkov's avatar
Juri Linkov committed
298 299 300 301 302 303 304
  :group 'dired
  :group 'faces)

(defface dired-header
  '((t (:inherit font-lock-type-face)))
  "Face used for directory headers."
  :group 'dired-faces
305
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
306 307 308 309 310 311 312
(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
313
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
314 315 316 317 318 319 320
(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
321
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
322 323 324 325 326 327 328
(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
329
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
330 331 332 333 334 335 336
(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
337
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
338 339 340 341 342 343 344
(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
345
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
346 347 348 349 350 351 352
(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
353
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
354 355 356 357
(defvar dired-symlink-face 'dired-symlink
  "Face name used for symbolic links.")

(defface dired-ignored
358
  '((t (:inherit shadow)))
Juri Linkov's avatar
Juri Linkov committed
359 360
  "Face used for files suffixed with `completion-ignored-extensions'."
  :group 'dired-faces
361
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
362 363 364
(defvar dired-ignored-face 'dired-ignored
  "Face name used for files suffixed with `completion-ignored-extensions'.")

365 366 367 368
(defvar dired-font-lock-keywords
  (list
   ;;
   ;; Directory headers.
Juri Linkov's avatar
Juri Linkov committed
369 370 371 372
   (list dired-subdir-regexp '(1 dired-header-face))
   ;;
   ;; Dired marks.
   (list dired-re-mark '(0 dired-mark-face))
373 374 375 376 377 378
   ;;
   ;; 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
379 380 381 382 383 384 385
   ;; 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)))
386 387 388 389 390 391 392 393
   ;; 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
394 395
;;;	 '(1 dired-warning-face)
;;;	 '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
396 397 398 399 400
   ;; 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
401
		 "[-d]....\\(w\\)....")	; group writable
Juri Linkov's avatar
Juri Linkov committed
402
	 '(1 dired-warning-face))
403
   (list (concat dired-re-maybe-mark dired-re-inode-size
404
		 "[-d].......\\(w\\).")	; world writable
Juri Linkov's avatar
Juri Linkov committed
405
	 '(1 dired-warning-face))
406 407 408
   ;;
   ;; Subdirectories.
   (list dired-re-dir
Juri Linkov's avatar
Juri Linkov committed
409
	 '(".+" (dired-move-to-filename) nil (0 dired-directory-face)))
410 411
   ;;
   ;; Symbolic links.
Juanma Barranquero's avatar
Juanma Barranquero committed
412
   (list dired-re-sym
Juri Linkov's avatar
Juri Linkov committed
413
	 '(".+" (dired-move-to-filename) nil (0 dired-symlink-face)))
414 415 416
   ;;
   ;; Files suffixed with `completion-ignored-extensions'.
   '(eval .
417 418 419
     ;; 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) "\\|#\\)$")
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
	   '(".+" (dired-move-to-filename) nil (0 dired-ignored-face))))
   ;;
   ;; Files suffixed with `completion-ignored-extensions'
   ;; plus a character put in by -F.
   '(eval .
     (list (concat "\\(" (regexp-opt completion-ignored-extensions)
		   "\\|#\\)[*=|]$")
	   '(".+" (progn
		    (end-of-line)
		    ;; If the last character is not part of the filename,
		    ;; move back to the start of the filename
		    ;; so it can be fontified.
		    ;; Otherwise, leave point at the end of the line;
		    ;; that way, nothing is fontified.
		    (unless (get-text-property (1- (point)) 'mouse-face)
		      (dired-move-to-filename)))
	     nil (0 dired-ignored-face))))
)
438
  "Additional expressions to highlight in Dired mode.")
439 440

(defvar dnd-protocol-alist)
Dave Love's avatar
Dave Love committed
441

442 443 444
;;; Macros must be defined before they are used, for the byte compiler.

(defmacro dired-mark-if (predicate msg)
445 446 447 448 449
  "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."
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
  `(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)))
470

471 472
(defmacro dired-map-over-marks (body arg &optional show-progress
				     distinguish-one-marked)
473 474 475 476 477 478 479 480 481 482 483 484 485 486
  "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.
487 488 489 490
BODY should not be too long as it is expanded four times.

If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
return (t FILENAME) instead of (FILENAME)."
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
  ;;
  ;;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)
528
		 (setq next-position (and (re-search-forward regexp nil t)
529
					  (point-marker)))))
530 531
	     (if (and ,distinguish-one-marked (= (length results) 1))
		 (setq results (cons t results)))
532 533 534 535 536
	     (if found
		 results
	       (list ,body)))))
     ;; save-excursion loses, again
     (dired-move-to-filename)))
537

538
(defun dired-get-marked-files (&optional localp arg filter distinguish-one-marked)
539 540 541
  "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.
542
Values returned are normally absolute file names.
543
Optional arg LOCALP as in `dired-get-filename'.
544 545 546 547 548
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
549 550 551 552 553 554 555 556 557 558 559
  some of the files--those for which (funcall FILTER FILENAME) is non-nil.

If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
return (t FILENAME) instead of (FILENAME).
Don't use that together with FILTER."
  (let* ((all-of-them
	  (save-excursion
	    (dired-map-over-marks
	     (dired-get-filename localp)
	     arg nil distinguish-one-marked)))
	 result)
560
    (if (not filter)
561 562 563
	(if (and distinguish-one-marked (eq (car all-of-them) t))
	    all-of-them
	  (nreverse all-of-them))
564 565 566 567
      (dolist (file all-of-them)
	(if (funcall filter file)
	    (push file result)))
      result)))
Dave Love's avatar
Dave Love committed
568

569 570 571 572 573 574 575 576
;; 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))
577 578 579 580 581 582 583 584
	    ;; 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
585

586
;;;###autoload (define-key ctl-x-map "d" 'dired)
Eric S. Raymond's avatar
Eric S. Raymond committed
587
;;;###autoload
588
(defun dired (dirname &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
589
  "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
590 591 592
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
593
shell wildcards appended to select certain files).  If DIRNAME is a cons,
Richard M. Stallman's avatar
Richard M. Stallman committed
594
its first element is taken as the directory name and the rest as an explicit
595
list of files to make directory entries for.
596
\\<dired-mode-map>\
597
You can move around in it with the usual commands.
598 599
You can flag files for deletion with \\[dired-flag-file-deletion] and then
delete them by typing \\[dired-do-flagged-delete].
600
Type \\[describe-mode] after entering Dired for more info.
Eric S. Raymond's avatar
Eric S. Raymond committed
601

602 603 604 605 606 607
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
608
;;;###autoload
609
(defun dired-other-window (dirname &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
610
  "\"Edit\" directory DIRNAME.  Like `dired' but selects in another window."
611 612
  (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
613

614 615 616 617 618 619 620
;;;###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
621
;;;###autoload
622
(defun dired-noselect (dir-or-list &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
623
  "Like `dired' but returns the dired buffer as value, does not select it."
624
  (or dir-or-list (setq dir-or-list default-directory))
625 626
  ;; This loses the distinction between "/foo/*/" and "/foo/*" that
  ;; some shells make:
627
  (let (dirname initially-was-dirname)
628 629 630
    (if (consp dir-or-list)
	(setq dirname (car dir-or-list))
      (setq dirname dir-or-list))
631 632
    (setq initially-was-dirname
	  (string= (file-name-as-directory dirname) dirname))
633 634
    (setq dirname (abbreviate-file-name
		   (expand-file-name (directory-file-name dirname))))
635 636
    (if find-file-visit-truename
	(setq dirname (file-truename dirname)))
637 638 639 640 641 642 643 644
    ;; 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)))
645 646 647 648
    (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)))
649

650 651 652 653 654
;; 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))
655 656 657
	     (modtime (visited-file-modtime)))
	 (or (eq modtime 0)
	     (not (eq (car attributes) t))
658
	     (equal (nth 5 attributes) modtime)))))
659 660 661 662 663 664 665 666 667 668 669 670

(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))))

671
;; Separate function from dired-noselect for the sake of dired-vms.el.
672
(defun dired-internal-noselect (dir-or-list &optional switches mode)
673 674 675
  ;; 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.
676
  ;; The user can type `g' easily, and it is more consistent with find-file.
677 678 679 680 681
  ;; 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.
682 683
  ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
  ;; see there.
684 685
  (let* (dirname
	 buffer
686
	 ;; note that buffer already is in dired-mode, if found
687
	 new-buffer-p
688
	 (old-buf (current-buffer)))
689 690 691 692 693 694
    (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))
695 696 697 698 699 700 701
    (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)
702 703
    (if (not new-buffer-p)		; existing buffer ...
	(cond (switches			; ... but new switches
704
	       ;; file list may have changed
705
	       (setq dired-directory dir-or-list)
706
	       ;; this calls dired-revert
Juanma Barranquero's avatar
Juanma Barranquero committed
707
	       (dired-sort-other switches))
708
	      ;; If directory has changed on disk, offer to revert.
709
	      ((when (dired-directory-changed-p dirname)
710
		 (message "%s"
Karl Heuer's avatar
Karl Heuer committed
711 712
			  (substitute-command-keys
			   "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
713
      ;; Else a new buffer
714
      (setq default-directory
715 716 717 718 719
	    ;; 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))
720
      (or switches (setq switches dired-listing-switches))
721
      (if mode (funcall mode)
722
        (dired-mode dir-or-list switches))
723 724 725 726
      ;; default-directory and dired-actual-switches are set now
      ;; (buffer-local), so we can call dired-readin:
      (let ((failed t))
	(unwind-protect
727
	    (progn (dired-readin)
728 729 730 731 732 733 734
		   (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
735 736
    buffer))

737 738 739 740 741 742
(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.")

743 744 745 746
(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.
747
  (setq dirname (expand-file-name dirname))
748
  (let (found (blist dired-buffers))    ; was (buffer-list)
749
    (or mode (setq mode 'dired-mode))
750
    (while blist
751 752 753 754
      (if (null (buffer-name (cdr (car blist))))
	  (setq blist (cdr blist))
	(save-excursion
	  (set-buffer (cdr (car blist)))
755
	  (if (and (eq major-mode mode)
756
		   dired-directory  ;; nil during find-alternate-file
757 758 759 760 761
		   (equal dirname
			  (expand-file-name
			   (if (consp dired-directory)
			       (car dired-directory)
			     dired-directory))))
762 763 764
	      (setq found (cdr (car blist))
		    blist nil)
	    (setq blist (cdr blist))))))
765 766
    found))

Dave Love's avatar
Dave Love committed
767

768 769
;; Read in a new dired buffer

770
(defun dired-readin ()
771
  "Read in a new dired buffer.
772
Differs from `dired-insert-subdir' in that it accepts
773 774 775
wildcards, erases the buffer, and builds the subdir-alist anew
\(including making it buffer-local and clearing it first)."

776 777
  ;; default-directory and dired-actual-switches must be buffer-local
  ;; and initialized by now.
778 779 780 781
  (let (dirname)
    (if (consp dired-directory)
	(setq dirname (car dired-directory))
      (setq dirname dired-directory))
782 783
    (setq dirname (expand-file-name dirname))
    (save-excursion
784 785 786 787 788 789 790 791 792
      ;; 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))
793 794
	(widen)
	(erase-buffer)
795 796
	(dired-readin-insert))
      (goto-char (point-min))
797 798 799
      ;; 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)
800
      (dired-build-subdir-alist)
801 802 803
      (let ((attributes (file-attributes dirname)))
	(if (eq (car attributes) t)
	    (set-visited-file-modtime (nth 5 attributes))))
804 805 806 807 808 809
      (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))))
810 811 812

;; Subroutines of dired-readin

813 814 815 816 817 818 819 820 821
(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))
822
    (setq dir (expand-file-name dir))
823 824
    (if (and (equal "" (file-name-nondirectory dir))
	     (not file-list))
825
	;; If we are reading a whole single directory...
826
	(dired-insert-directory dir dired-actual-switches nil nil t)
827
      (if (not (file-readable-p
828 829 830 831 832 833 834
		(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)))))

835 836 837 838 839 840 841 842 843 844
(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.
  ;;
845 846 847 848 849 850 851 852 853 854 855
  ;; 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
  ;; `directory-listing-before-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).
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
  (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)
890
	(skip-chars-forward " ")	;Skip to the first field.
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
	(while (and (> other-col file-col)
		    ;; 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
914
			    (if (eq (char-before) ?\s) " *" "[^ ]* *")
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
			    (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
934
			(eq (dired-move-to-filename) (marker-position file)))
935
		;; Damn!  We messed up: let's revert the change.
936 937 938
		(delete-char (- spaces)))))
	  ;; Now skip to next field.
	  (skip-chars-forward "^ ") (skip-chars-forward " "))
939
	(set-marker file nil)))))
940

941

942 943 944 945 946 947 948 949
(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."
950
  (let ((opoint (point))
951
	(process-environment (copy-sequence process-environment))
952
	end)
953
    (if (or dired-use-ls-dired (file-remote-p dir))
954
	(setq switches (concat "--dired " switches)))
955 956
    ;; We used to specify the C locale here, to force English month names;
    ;; but this should not be necessary any more,
957
    ;; with the new value of `directory-listing-before-filename-regexp'.
958 959
    (if file-list
	(dolist (f file-list)
960 961 962 963
	  (let ((beg (point)))
	    (insert-directory f switches nil nil)
	    ;; Re-align fields, if necessary.
	    (dired-align-file beg (point))))
964
      (insert-directory dir switches wildcard (not wildcard)))
965
    ;; Quote certain characters, unless ls quoted them for us.
966 967 968 969 970
    (if (not (string-match "b" dired-actual-switches))
	(save-excursion
	  (setq end (point-marker))
	  (goto-char opoint)
	  (while (search-forward "\\" end t)
971 972 973 974
	    (replace-match (apply #'propertize
				  "\\\\"
				  (text-properties-at (match-beginning 0)))
			   nil t))
975 976
	  (goto-char opoint)
	  (while (search-forward "\^m" end t)
977 978 979 980
	    (replace-match (apply #'propertize
				  "\\015"
				  (text-properties-at (match-beginning 0)))
			   nil t))
981
	  (set-marker end nil)))
982 983 984 985
    (dired-insert-set-properties opoint (point))
    ;; If we used --dired and it worked, the lines are already indented.
    ;; Otherwise, indent them.
    (unless (save-excursion
986
	      (goto-char opoint)
987 988 989 990 991 992 993 994 995 996 997 998 999 1000
	      (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")))))
1001

1002
(defun dired-insert-set-properties (beg end)
1003
  "Make the file names highlight when the mouse is on them."
1004 1005 1006
  (save-excursion
    (goto-char beg)
    (while (< (point) end)
1007 1008
      (condition-case nil
	  (if (dired-move-to-filename)
1009 1010 1011 1012 1013
	      (add-text-properties
	       (point)
	       (save-excursion
		 (dired-move-to-end-of-filename)
		 (point))
1014
	       '(mouse-face highlight
1015
		 help-echo "mouse-2: visit this file in other window")))
1016
	(error nil))
1017
      (forward-line 1))))
Dave Love's avatar
Dave Love committed
1018

1019 1020
;; Reverting a dired buffer

Eric S. Raymond's avatar
Eric S. Raymond committed
1021
(defun dired-revert (&optional arg noconfirm)
1022
  "Reread the dired buffer.
1023
Must also be called after `dired-actual-switches' have changed.
1024 1025
Should not fail even on completely garbaged buffers.
Preserves old cursor, marks/flags, hidden-p."
1026
  (widen)				; just in case user narrowed
1027 1028
  (let ((modflag (buffer-modified-p))
	(opoint (point))
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
	(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)
1039 1040
    (dired-uncache
     (if (consp dired-directory) (car dired-directory) dired-directory))
1041
    (dired-readin)
1042 1043 1044 1045 1046 1047 1048 1049 1050
    (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
1051
    (dired-move-to-filename)
1052
    (save-excursion			; hide subdirs that were hidden
1053 1054
      (dolist (dir hidden-subdirs)
	(if (dired-goto-subdir dir)
1055 1056
	    (dired-hide-subdir 1))))
    (unless modflag (restore-buffer-modified-p nil)))
1057
  ;; outside of the let scope
1058
;;;  Might as well not override the user if the user changed this.
1059 1060 1061 1062 1063 1064 1065
;;;  (setq buffer-read-only t)
  )

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

(defun dired-remember-marks (beg end)
1066
  "Return alist of files and their marks, from BEG to END."
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
  (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)
1080 1081
  "Mark all files remembered in ALIST.
Each element of ALIST looks like (FILE . MARKERCHAR)."
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
  (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 ()
1095
  "Return a list of names of subdirs currently hidden."
1096 1097 1098 1099 1100 1101 1102
  (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")
1103
      (if (eq (following-char) ?\r)
1104 1105 1106 1107
	  (setq result (cons dir result))))
    result))

(defun dired-insert-old-subdirs (old-subdir-alist)
1108 1109
  "Try to insert all subdirs that were displayed before.
Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1110 1111 1112 1113 1114 1115 1116
  (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 ()
1117 1118
	      (progn
		(dired-uncache dir)
1119
		(dired-insert-subdir dir))
1120
	    (error nil))))))
1121 1122

(defun dired-uncache (dir)
1123
  "Remove directory DIR from any directory cache."
1124
  (let ((handler (find-file-name-handler dir 'dired-uncache)))
1125 1126
    (if handler
	(funcall handler 'dired-uncache dir))))
Dave Love's avatar
Dave Love committed
1127

1128
;; dired mode key bindings and initialization
Eric S. Raymond's avatar
Eric S. Raymond committed
1129

1130
(defvar dired-mode-map
1131 1132
  ;; This looks ugly when substitute-command-keys uses C-d instead d:
  ;;  (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)