lisp/dired.el

   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, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
   7 ;; Maintainer: FSF
   8 ;; Keywords: files
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 3, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  25 ;; Boston, MA 02110-1301, USA.
  26
  27 ;;; Commentary:
  28
  29 ;; This is a major mode for directory browsing and editing.  It is
  30 ;; documented in the Emacs manual.
  31
  32 ;; Rewritten in 1990/1991 to add tree features, file marking and
  33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
  34 ;; Finished up by rms in 1992.
  35
  36 ;;; Code:
  37
  38 (eval-when-compile (require 'cl))
  39
  40 ;;; Customizable variables
  41
  42 (defgroup dired nil
  43   "Directory editing."
  44   :link '(custom-manual "(emacs)Dired")
  45   :group 'files)
  46
  47 (defgroup dired-mark nil
  48   "Handling marks in Dired."
  49   :prefix "dired-"
  50   :group 'dired)
  51
  52
  53 ;;;###autoload
  54 (defcustom dired-listing-switches "-al"
  55   "*Switches passed to `ls' for Dired.  MUST contain the `l' option.
  56 May contain all other options that don't contradict `-l';
  57 may contain even `F', `b', `i' and `s'.  See also the variable
  58 `dired-ls-F-marks-symlinks' concerning the `F' switch.
  59 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
  60 some of the `ls' switches are not supported; see the doc string of
  61 `insert-directory' in `ls-lisp.el' for more details."
  62   :type 'string
  63   :group 'dired)
  64
  65 (defvar dired-subdir-switches nil
  66   "If non-nil, switches passed to `ls' for inserting subdirectories.
  67 If nil, `dired-listing-switches' is used.")
  68
  69 ; Don't use absolute file names as /bin should be in any PATH and people
  70 ; may prefer /usr/local/gnu/bin or whatever.  However, chown is
  71 ; usually not in PATH.
  72
  73 ;;;###autoload
  74 (defvar dired-chown-program
  75   (if (memq system-type '(hpux usg-unix-v irix linux gnu/linux cygwin))
  76       "chown"
  77     (if (file-exists-p "/usr/sbin/chown")
  78         "/usr/sbin/chown"
  79       "/etc/chown"))
  80   "Name of chown command (usually `chown' or `/etc/chown').")
  81
  82 (defvar dired-use-ls-dired (not (not (string-match "gnu" system-configuration)))
  83   "Non-nil means Dired should use `ls --dired'.")
  84
  85 (defvar dired-chmod-program "chmod"
  86   "Name of chmod command (usually `chmod').")
  87
  88 (defvar dired-touch-program "touch"
  89   "Name of touch command (usually `touch').")
  90
  91 ;;;###autoload
  92 (defcustom dired-ls-F-marks-symlinks nil
  93   "*Informs Dired about how `ls -lF' marks symbolic links.
  94 Set this to t if `ls' (or whatever program is specified by
  95 `insert-directory-program') with `-lF' marks the symbolic link
  96 itself with a trailing @ (usually the case under Ultrix).
  97
  98 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
  99 nil (the default), if it gives `bar@ -> foo', set it to t.
 100
 101 Dired checks if there is really a @ appended.  Thus, if you have a
 102 marking `ls' program on one host and a non-marking on another host, and
 103 don't care about symbolic links which really end in a @, you can
 104 always set this variable to t."
 105   :type 'boolean
 106   :group 'dired-mark)
 107
 108 ;;;###autoload
 109 (defcustom dired-trivial-filenames "^\\.\\.?$\\|^#"
 110   "*Regexp of files to skip when finding first file of a directory.
 111 A value of nil means move to the subdir line.
 112 A value of t means move to first file."
 113   :type '(choice (const :tag "Move to subdir" nil)
 114                  (const :tag "Move to first" t)
 115                  regexp)
 116   :group 'dired)
 117
 118 ;;;###autoload
 119 (defcustom dired-keep-marker-rename t
 120   ;; Use t as default so that moved files "take their markers with them".
 121   "*Controls marking of renamed files.
 122 If t, files keep their previous marks when they are renamed.
 123 If a character, renamed files (whether previously marked or not)
 124 are afterward marked with that character."
 125   :type '(choice (const :tag "Keep" t)
 126                  (character :tag "Mark"))
 127   :group 'dired-mark)
 128
 129 ;;;###autoload
 130 (defcustom dired-keep-marker-copy ?C
 131   "*Controls marking of copied files.
 132 If t, copied files are marked if and as the corresponding original files were.
 133 If a character, copied files are unconditionally marked with that character."
 134   :type '(choice (const :tag "Keep" t)
 135                  (character :tag "Mark"))
 136   :group 'dired-mark)
 137
 138 ;;;###autoload
 139 (defcustom dired-keep-marker-hardlink ?H
 140   "*Controls marking of newly made hard links.
 141 If t, they are marked if and as the files linked to were marked.
 142 If a character, new links are unconditionally marked with that character."
 143   :type '(choice (const :tag "Keep" t)
 144                  (character :tag "Mark"))
 145   :group 'dired-mark)
 146
 147 ;;;###autoload
 148 (defcustom dired-keep-marker-symlink ?Y
 149   "*Controls marking of newly made symbolic links.
 150 If t, they are marked if and as the files linked to were marked.
 151 If a character, new links are unconditionally marked with that character."
 152   :type '(choice (const :tag "Keep" t)
 153                  (character :tag "Mark"))
 154   :group 'dired-mark)
 155
 156 ;;;###autoload
 157 (defcustom dired-dwim-target nil
 158   "*If non-nil, Dired tries to guess a default target directory.
 159 This means: if there is a dired buffer displayed in the next window,
 160 use its current subdir, instead of the current subdir of this dired buffer.
 161
 162 The target is used in the prompt for file copy, rename etc."
 163   :type 'boolean
 164   :group 'dired)
 165
 166 ;;;###autoload
 167 (defcustom dired-copy-preserve-time t
 168   "*If non-nil, Dired preserves the last-modified time in a file copy.
 169 \(This works on only some systems.)"
 170   :type 'boolean
 171   :group 'dired)
 172
 173 ; These variables were deleted and the replacements are on files.el.
 174 ; We leave aliases behind for back-compatibility.
 175 (defvaralias 'dired-free-space-program 'directory-free-space-program)
 176 (defvaralias 'dired-free-space-args 'directory-free-space-args)
 177
 178 ;;; Hook variables
 179
 180 (defcustom dired-load-hook nil
 181   "Run after loading Dired.
 182 You can customize key bindings or load extensions with this."
 183   :group 'dired
 184   :type 'hook)
 185
 186 (defcustom dired-mode-hook nil
 187   "Run at the very end of `dired-mode'."
 188   :group 'dired
 189   :type 'hook)
 190
 191 (defcustom dired-before-readin-hook nil
 192   "This hook is run before a dired buffer is read in (created or reverted)."
 193   :group 'dired
 194   :type 'hook)
 195
 196 (defcustom dired-after-readin-hook nil
 197   "Hook run after each time a file or directory is read by Dired.
 198 After each listing of a file or directory, this hook is run
 199 with the buffer narrowed to the listing."
 200   :group 'dired
 201   :type 'hook)
 202 ;; Note this can't simply be run inside function `dired-ls' as the hook
 203 ;; functions probably depend on the dired-subdir-alist to be OK.
 204
 205 (defcustom dired-dnd-protocol-alist
 206   '(("^file:///" . dired-dnd-handle-local-file)
 207     ("^file://"  . dired-dnd-handle-file)
 208     ("^file:"    . dired-dnd-handle-local-file))
 209   "The functions to call when a drop in `dired-mode' is made.
 210 See `dnd-protocol-alist' for more information.  When nil, behave
 211 as in other buffers.  Changing this option is effective only for
 212 new dired buffers."
 213   :type '(choice (repeat (cons (regexp) (function)))
 214                  (const :tag "Behave as in other buffers" nil))
 215   :version "22.1"
 216   :group 'dired)
 217
 218 ;; Internal variables
 219
 220 (defvar dired-marker-char ?*            ; the answer is 42
 221   ;; so that you can write things like
 222   ;; (let ((dired-marker-char ?X))
 223   ;;    ;; great code using X markers ...
 224   ;;    )
 225   ;; For example, commands operating on two sets of files, A and B.
 226   ;; Or marking files with digits 0-9.  This could implicate
 227   ;; concentric sets or an order for the marked files.
 228   ;; The code depends on dynamic scoping on the marker char.
 229   "In Dired, the current mark character.
 230 This is what the do-commands look for, and what the mark-commands store.")
 231
 232 (defvar dired-del-marker ?D
 233   "Character used to flag files for deletion.")
 234
 235 (defvar dired-shrink-to-fit t
 236 ;; I see no reason ever to make this nil -- rms.
 237 ;;  (> baud-rate search-slow-speed)
 238   "Non-nil means Dired shrinks the display buffer to fit the marked files.")
 239
 240 (defvar dired-flagging-regexp nil);; Last regexp used to flag files.
 241
 242 (defvar dired-file-version-alist)
 243
 244 ;;;###autoload
 245 (defvar dired-directory nil
 246   "The directory name or wildcard spec that this dired directory lists.
 247 Local to each dired buffer.  May be a list, in which case the car is the
 248 directory name and the cdr is the list of files to mention.
 249 The directory name must be absolute, but need not be fully expanded.")
 250
 251 (defvar dired-actual-switches nil
 252   "The value of `dired-listing-switches' used to make this buffer's text.")
 253
 254 (defvar dired-re-inode-size "[0-9 \t]*"
 255   "Regexp for optional initial inode and file size as made by `ls -i -s'.")
 256
 257 ;; These regexps must be tested at beginning-of-line, but are also
 258 ;; used to search for next matches, so neither omitting "^" nor
 259 ;; replacing "^" by "\n" (to make it slightly faster) will work.
 260
 261 (defvar dired-re-mark "^[^ \n]")
 262 ;; "Regexp matching a marked line.
 263 ;; Important: the match ends just after the marker."
 264 (defvar dired-re-maybe-mark "^. ")
 265 ;; The [^:] part after "d" and "l" is to avoid confusion with the
 266 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
 267 (defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d[^:]"))
 268 (defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l[^:]"))
 269 (defvar dired-re-exe;; match ls permission string of an executable file
 270   (mapconcat (function
 271               (lambda (x)
 272                 (concat dired-re-maybe-mark dired-re-inode-size x)))
 273              '("-[-r][-w][xs][-r][-w].[-r][-w]."
 274                "-[-r][-w].[-r][-w][xs][-r][-w]."
 275                "-[-r][-w].[-r][-w].[-r][-w][xst]")
 276              "\\|"))
 277 (defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
 278 (defvar dired-re-dot "^.* \\.\\.?/?$")
 279
 280 ;; The subdirectory names in the next two lists are expanded.
 281 (defvar dired-subdir-alist nil
 282   "Association list of subdirectories and their buffer positions.
 283 Each subdirectory has an element: (DIRNAME . STARTMARKER).
 284 The order of elements is the reverse of the order in the buffer.
 285 In simple cases, this list contains one element.")
 286
 287 (defvar dired-switches-alist nil
 288   "Keeps track of which switches to use for inserted subdirectories.
 289 This is an alist of the form (SUBDIR . SWITCHES).")
 290 (make-variable-buffer-local 'dired-switches-alist)
 291
 292 (defvaralias 'dired-move-to-filename-regexp
 293   'directory-listing-before-filename-regexp)
 294
 295 (defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
 296   "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
 297 Subexpression 1 is the subdirectory proper, no trailing colon.
 298 The match starts at the beginning of the line and ends after the end
 299 of the line (\\n or \\r).
 300 Subexpression 2 must end right before the \\n or \\r.")
 301
 302 (defgroup dired-faces nil
 303   "Faces used by Dired."
 304   :group 'dired
 305   :group 'faces)
 306
 307 (defface dired-header
 308   '((t (:inherit font-lock-type-face)))
 309   "Face used for directory headers."
 310   :group 'dired-faces
 311   :version "22.1")
 312 (defvar dired-header-face 'dired-header
 313   "Face name used for directory headers.")
 314
 315 (defface dired-mark
 316   '((t (:inherit font-lock-constant-face)))
 317   "Face used for dired marks."
 318   :group 'dired-faces
 319   :version "22.1")
 320 (defvar dired-mark-face 'dired-mark
 321   "Face name used for dired marks.")
 322
 323 (defface dired-marked
 324   '((t (:inherit font-lock-warning-face)))
 325   "Face used for marked files."
 326   :group 'dired-faces
 327   :version "22.1")
 328 (defvar dired-marked-face 'dired-marked
 329   "Face name used for marked files.")
 330
 331 (defface dired-flagged
 332   '((t (:inherit font-lock-warning-face)))
 333   "Face used for flagged files."
 334   :group 'dired-faces
 335   :version "22.1")
 336 (defvar dired-flagged-face 'dired-flagged
 337   "Face name used for flagged files.")
 338
 339 (defface dired-warning
 340   ;; Inherit from font-lock-warning-face since with min-colors 8
 341   ;; font-lock-comment-face is not colored any more.
 342   '((t (:inherit font-lock-warning-face)))
 343   "Face used to highlight a part of a buffer that needs user attention."
 344   :group 'dired-faces
 345   :version "22.1")
 346 (defvar dired-warning-face 'dired-warning
 347   "Face name used for a part of a buffer that needs user attention.")
 348
 349 (defface dired-perm-write
 350   '((((type w32 pc)) :inherit default)  ;; These default to rw-rw-rw.
 351     ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
 352     ;; font-lock-comment-face is not colored any more.
 353     (t (:inherit font-lock-comment-delimiter-face)))
 354   "Face used to highlight permissions of group- and world-writable files."
 355   :group 'dired-faces
 356   :version "22.2")
 357 (defvar dired-perm-write-face 'dired-perm-write
 358   "Face name used for permissions of group- and world-writable files.")
 359
 360 (defface dired-directory
 361   '((t (:inherit font-lock-function-name-face)))
 362   "Face used for subdirectories."
 363   :group 'dired-faces
 364   :version "22.1")
 365 (defvar dired-directory-face 'dired-directory
 366   "Face name used for subdirectories.")
 367
 368 (defface dired-symlink
 369   '((t (:inherit font-lock-keyword-face)))
 370   "Face used for symbolic links."
 371   :group 'dired-faces
 372   :version "22.1")
 373 (defvar dired-symlink-face 'dired-symlink
 374   "Face name used for symbolic links.")
 375
 376 (defface dired-ignored
 377   '((t (:inherit shadow)))
 378   "Face used for files suffixed with `completion-ignored-extensions'."
 379   :group 'dired-faces
 380   :version "22.1")
 381 (defvar dired-ignored-face 'dired-ignored
 382   "Face name used for files suffixed with `completion-ignored-extensions'.")
 383
 384 (defvar dired-font-lock-keywords
 385   (list
 386    ;;
 387    ;; Directory headers.
 388    (list dired-subdir-regexp '(1 dired-header-face))
 389    ;;
 390    ;; Dired marks.
 391    (list dired-re-mark '(0 dired-mark-face))
 392    ;;
 393    ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
 394    ;; file name itself.  We search for Dired defined regexps, and then use the
 395    ;; Dired defined function `dired-move-to-filename' before searching for the
 396    ;; simple regexp ".+".  It is that regexp which matches the file name.
 397    ;;
 398    ;; Marked files.
 399    (list (concat "^[" (char-to-string dired-marker-char) "]")
 400          '(".+" (dired-move-to-filename) nil (0 dired-marked-face)))
 401    ;;
 402    ;; Flagged files.
 403    (list (concat "^[" (char-to-string dired-del-marker) "]")
 404          '(".+" (dired-move-to-filename) nil (0 dired-flagged-face)))
 405    ;; People who are paranoid about security would consider this more
 406    ;; important than other things such as whether it is a directory.
 407    ;; But we don't want to encourage paranoia, so our default
 408    ;; should be what's most useful for non-paranoids. -- rms.
 409 ;;;   ;;
 410 ;;;   ;; Files that are group or world writable.
 411 ;;;   (list (concat dired-re-maybe-mark dired-re-inode-size
 412 ;;;              "\\([-d]\\(....w....\\|.......w.\\)\\)")
 413 ;;;      '(1 dired-warning-face)
 414 ;;;      '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
 415    ;; However, we don't need to highlight the file name, only the
 416    ;; permissions, to win generally.  -- fx.
 417    ;; Fixme: we could also put text properties on the permission
 418    ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
 419    (list (concat dired-re-maybe-mark dired-re-inode-size
 420                  "[-d]....\\(w\\)....") ; group writable
 421          '(1 dired-perm-write-face))
 422    (list (concat dired-re-maybe-mark dired-re-inode-size
 423                  "[-d].......\\(w\\).") ; world writable
 424          '(1 dired-perm-write-face))
 425    ;;
 426    ;; Subdirectories.
 427    (list dired-re-dir
 428          '(".+" (dired-move-to-filename) nil (0 dired-directory-face)))
 429    ;;
 430    ;; Symbolic links.
 431    (list dired-re-sym
 432          '(".+" (dired-move-to-filename) nil (0 dired-symlink-face)))
 433    ;;
 434    ;; Files suffixed with `completion-ignored-extensions'.
 435    '(eval .
 436      ;; It is quicker to first find just an extension, then go back to the
 437      ;; start of that file name.  So we do this complex MATCH-ANCHORED form.
 438      (list (concat "\\(" (regexp-opt completion-ignored-extensions) "\\|#\\)$")
 439            '(".+" (dired-move-to-filename) nil (0 dired-ignored-face))))
 440    ;;
 441    ;; Files suffixed with `completion-ignored-extensions'
 442    ;; plus a character put in by -F.
 443    '(eval .
 444      (list (concat "\\(" (regexp-opt completion-ignored-extensions)
 445                    "\\|#\\)[*=|]$")
 446            '(".+" (progn
 447                     (end-of-line)
 448                     ;; If the last character is not part of the filename,
 449                     ;; move back to the start of the filename
 450                     ;; so it can be fontified.
 451                     ;; Otherwise, leave point at the end of the line;
 452                     ;; that way, nothing is fontified.
 453                     (unless (get-text-property (1- (point)) 'mouse-face)
 454                       (dired-move-to-filename)))
 455              nil (0 dired-ignored-face))))
 456 )
 457   "Additional expressions to highlight in Dired mode.")
 458
 459 (defvar dnd-protocol-alist)
 460 \f
 461 ;;; Macros must be defined before they are used, for the byte compiler.
 462
 463 (defmacro dired-mark-if (predicate msg)
 464   "Mark all files for which PREDICATE evals to non-nil.
 465 PREDICATE is evaluated on each line, with point at beginning of line.
 466 MSG is a noun phrase for the type of files being marked.
 467 It should end with a noun that can be pluralized by adding `s'.
 468 Return value is the number of files marked, or nil if none were marked."
 469   `(let (buffer-read-only count)
 470     (save-excursion
 471       (setq count 0)
 472       (if ,msg (message "Marking %ss..." ,msg))
 473       (goto-char (point-min))
 474       (while (not (eobp))
 475         (if ,predicate
 476             (progn
 477               (delete-char 1)
 478               (insert dired-marker-char)
 479               (setq count (1+ count))))
 480         (forward-line 1))
 481       (if ,msg (message "%s %s%s %s%s."
 482                         count
 483                         ,msg
 484                         (dired-plural-s count)
 485                         (if (eq dired-marker-char ?\040) "un" "")
 486                         (if (eq dired-marker-char dired-del-marker)
 487                             "flagged" "marked"))))
 488     (and (> count 0) count)))
 489
 490 (defmacro dired-map-over-marks (body arg &optional show-progress
 491                                      distinguish-one-marked)
 492   "Eval BODY with point on each marked line.  Return a list of BODY's results.
 493 If no marked file could be found, execute BODY on the current line.
 494   If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
 495   files instead of the marked files.
 496   In that case point is dragged along.  This is so that commands on
 497   the next ARG (instead of the marked) files can be chained easily.
 498   If ARG is otherwise non-nil, use current file instead.
 499 If optional third arg SHOW-PROGRESS evaluates to non-nil,
 500   redisplay the dired buffer after each file is processed.
 501 No guarantee is made about the position on the marked line.
 502   BODY must ensure this itself if it depends on this.
 503 Search starts at the beginning of the buffer, thus the car of the list
 504   corresponds to the line nearest to the buffer's bottom.  This
 505   is also true for (positive and negative) integer values of ARG.
 506 BODY should not be too long as it is expanded four times.
 507
 508 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
 509 return (t FILENAME) instead of (FILENAME)."
 510   ;;
 511   ;;Warning: BODY must not add new lines before point - this may cause an
 512   ;;endless loop.
 513   ;;This warning should not apply any longer, sk  2-Sep-1991 14:10.
 514   `(prog1
 515        (let (buffer-read-only case-fold-search found results)
 516          (if ,arg
 517              (if (integerp ,arg)
 518                  (progn ;; no save-excursion, want to move point.
 519                    (dired-repeat-over-lines
 520                     ,arg
 521                     (function (lambda ()
 522                                 (if ,show-progress (sit-for 0))
 523                                 (setq results (cons ,body results)))))
 524                    (if (< ,arg 0)
 525                        (nreverse results)
 526                      results))
 527                ;; non-nil, non-integer ARG means use current file:
 528                (list ,body))
 529            (let ((regexp (dired-marker-regexp)) next-position)
 530              (save-excursion
 531                (goto-char (point-min))
 532                ;; remember position of next marked file before BODY
 533                ;; can insert lines before the just found file,
 534                ;; confusing us by finding the same marked file again
 535                ;; and again and...
 536                (setq next-position (and (re-search-forward regexp nil t)
 537                                         (point-marker))
 538                      found (not (null next-position)))
 539                (while next-position
 540                  (goto-char next-position)
 541                  (if ,show-progress (sit-for 0))
 542                  (setq results (cons ,body results))
 543                  ;; move after last match
 544                  (goto-char next-position)
 545                  (forward-line 1)
 546                  (set-marker next-position nil)
 547                  (setq next-position (and (re-search-forward regexp nil t)
 548                                           (point-marker)))))
 549              (if (and ,distinguish-one-marked (= (length results) 1))
 550                  (setq results (cons t results)))
 551              (if found
 552                  results
 553                (list ,body)))))
 554      ;; save-excursion loses, again
 555      (dired-move-to-filename)))
 556
 557 (defun dired-get-marked-files (&optional localp arg filter distinguish-one-marked)
 558   "Return the marked files' names as list of strings.
 559 The list is in the same order as the buffer, that is, the car is the
 560   first marked file.
 561 Values returned are normally absolute file names.
 562 Optional arg LOCALP as in `dired-get-filename'.
 563 Optional second argument ARG specifies files near point
 564  instead of marked files.  If ARG is an integer, use the next ARG files.
 565   If ARG is otherwise non-nil, use file.  Usually ARG comes from
 566   the command's prefix arg.
 567 Optional third argument FILTER, if non-nil, is a function to select
 568   some of the files--those for which (funcall FILTER FILENAME) is non-nil.
 569
 570 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
 571 return (t FILENAME) instead of (FILENAME).
 572 Don't use that together with FILTER."
 573   (let* ((all-of-them
 574           (save-excursion
 575             (dired-map-over-marks
 576              (dired-get-filename localp)
 577              arg nil distinguish-one-marked)))
 578          result)
 579     (if (not filter)
 580         (if (and distinguish-one-marked (eq (car all-of-them) t))
 581             all-of-them
 582           (nreverse all-of-them))
 583       (dolist (file all-of-them)
 584         (if (funcall filter file)
 585             (push file result)))
 586       result)))
 587 \f
 588 ;; The dired command
 589
 590 (defun dired-read-dir-and-switches (str)
 591   ;; For use in interactive.
 592   (reverse (list
 593             (if current-prefix-arg
 594                 (read-string "Dired listing switches: "
 595                              dired-listing-switches))
 596             ;; If a dialog is about to be used, call read-directory-name so
 597             ;; the dialog code knows we want directories.  Some dialogs can
 598             ;; only select directories or files when popped up, not both.
 599             (if (next-read-file-uses-dialog-p)
 600                 (read-directory-name (format "Dired %s(directory): " str)
 601                                      nil default-directory nil)
 602               (lexical-let ((default (and buffer-file-name
 603                                           (abbreviate-file-name buffer-file-name)))
 604                             (defdir default-directory))
 605                 (minibuffer-with-setup-hook
 606                     (lambda ()
 607                       (setq minibuffer-default default)
 608                       (setq default-directory defdir))
 609                   (completing-read
 610                    (format "Dired %s(directory): " str)
 611                    ;; We need a mix of read-file-name and read-directory-name
 612                    ;; so that completion to directories is preferred, but if
 613                    ;; the user wants to enter a global pattern, he can still
 614                    ;; use completion on filenames to help him write the pattern.
 615                    ;; Essentially, we want to use
 616                    ;; (completion-table-with-predicate
 617                    ;;  'read-file-name-internal 'file-directory-p nil)
 618                    ;; but that doesn't work because read-file-name-internal
 619                    ;; does not obey its `predicate' argument.
 620                    (completion-table-in-turn
 621                     (lambda (str pred action)
 622                       (let ((read-file-name-predicate 'file-directory-p))
 623                         (complete-with-action
 624                          action 'read-file-name-internal str nil)))
 625                     'read-file-name-internal)
 626                    nil nil (abbreviate-file-name defdir) 'file-name-history)))))))
 627
 628 ;;;###autoload (define-key ctl-x-map "d" 'dired)
 629 ;;;###autoload
 630 (defun dired (dirname &optional switches)
 631   "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
 632 Optional second argument SWITCHES specifies the `ls' options used.
 633 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
 634 Dired displays a list of files in DIRNAME (which may also have
 635 shell wildcards appended to select certain files).  If DIRNAME is a cons,
 636 its first element is taken as the directory name and the rest as an explicit
 637 list of files to make directory entries for.
 638 \\<dired-mode-map>\
 639 You can move around in it with the usual commands.
 640 You can flag files for deletion with \\[dired-flag-file-deletion] and then
 641 delete them by typing \\[dired-do-flagged-delete].
 642 Type \\[describe-mode] after entering Dired for more info.
 643
 644 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
 645   ;; Cannot use (interactive "D") because of wildcards.
 646   (interactive (dired-read-dir-and-switches ""))
 647   (switch-to-buffer (dired-noselect dirname switches)))
 648
 649 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
 650 ;;;###autoload
 651 (defun dired-other-window (dirname &optional switches)
 652   "\"Edit\" directory DIRNAME.  Like `dired' but selects in another window."
 653   (interactive (dired-read-dir-and-switches "in other window "))
 654   (switch-to-buffer-other-window (dired-noselect dirname switches)))
 655
 656 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
 657 ;;;###autoload
 658 (defun dired-other-frame (dirname &optional switches)
 659   "\"Edit\" directory DIRNAME.  Like `dired' but makes a new frame."
 660   (interactive (dired-read-dir-and-switches "in other frame "))
 661   (switch-to-buffer-other-frame (dired-noselect dirname switches)))
 662
 663 ;;;###autoload
 664 (defun dired-noselect (dir-or-list &optional switches)
 665   "Like `dired' but returns the dired buffer as value, does not select it."
 666   (or dir-or-list (setq dir-or-list default-directory))
 667   ;; This loses the distinction between "/foo/*/" and "/foo/*" that
 668   ;; some shells make:
 669   (let (dirname initially-was-dirname)
 670     (if (consp dir-or-list)
 671         (setq dirname (car dir-or-list))
 672       (setq dirname dir-or-list))
 673     (setq initially-was-dirname
 674           (string= (file-name-as-directory dirname) dirname))
 675     (setq dirname (abbreviate-file-name
 676                    (expand-file-name (directory-file-name dirname))))
 677     (if find-file-visit-truename
 678         (setq dirname (file-truename dirname)))
 679     ;; If the argument was syntactically  a directory name not a file name,
 680     ;; or if it happens to name a file that is a directory,
 681     ;; convert it syntactically to a directory name.
 682     ;; The reason for checking initially-was-dirname
 683     ;; and not just file-directory-p
 684     ;; is that file-directory-p is slow over ftp.
 685     (if (or initially-was-dirname (file-directory-p dirname))
 686         (setq dirname  (file-name-as-directory dirname)))
 687     (if (consp dir-or-list)
 688         (setq dir-or-list (cons dirname (cdr dir-or-list)))
 689       (setq dir-or-list dirname))
 690     (dired-internal-noselect dir-or-list switches)))
 691
 692 ;; The following is an internal dired function.  It returns non-nil if
 693 ;; the directory visited by the current dired buffer has changed on
 694 ;; disk.  DIRNAME should be the directory name of that directory.
 695 (defun dired-directory-changed-p (dirname)
 696   (not (let ((attributes (file-attributes dirname))
 697              (modtime (visited-file-modtime)))
 698          (or (eq modtime 0)
 699              (not (eq (car attributes) t))
 700              (equal (nth 5 attributes) modtime)))))
 701
 702 (defun dired-buffer-stale-p (&optional noconfirm)
 703   "Return non-nil if current dired buffer needs updating.
 704 If NOCONFIRM is non-nil, then this function always returns nil
 705 for a remote directory.  This feature is used by Auto Revert Mode."
 706   (let ((dirname
 707          (if (consp dired-directory) (car dired-directory) dired-directory)))
 708     (and (stringp dirname)
 709          (not (when noconfirm (file-remote-p dirname)))
 710          (file-readable-p dirname)
 711          (dired-directory-changed-p dirname))))
 712
 713 ;; Separate function from dired-noselect for the sake of dired-vms.el.
 714 (defun dired-internal-noselect (dir-or-list &optional switches mode)
 715   ;; If there is an existing dired buffer for DIRNAME, just leave
 716   ;; buffer as it is (don't even call dired-revert).
 717   ;; This saves time especially for deep trees or with ange-ftp.
 718   ;; The user can type `g' easily, and it is more consistent with find-file.
 719   ;; But if SWITCHES are given they are probably different from the
 720   ;; buffer's old value, so call dired-sort-other, which does
 721   ;; revert the buffer.
 722   ;; A pity we can't possibly do "Directory has changed - refresh? "
 723   ;; like find-file does.
 724   ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
 725   ;; see there.
 726   (let* (dirname
 727          buffer
 728          ;; note that buffer already is in dired-mode, if found
 729          new-buffer-p
 730          (old-buf (current-buffer)))
 731     (if (consp dir-or-list)
 732         (setq dirname (car dir-or-list))
 733       (setq dirname dir-or-list))
 734     ;; Look for an existing buffer.
 735     (setq buffer (dired-find-buffer-nocreate dirname mode)
 736           new-buffer-p (null buffer))
 737     (or buffer
 738         (let ((default-major-mode 'fundamental-mode))
 739           ;; We don't want default-major-mode to run hooks and set auto-fill
 740           ;; or whatever, now that dired-mode does not
 741           ;; kill-all-local-variables any longer.
 742           (setq buffer (create-file-buffer (directory-file-name dirname)))))
 743     (set-buffer buffer)
 744     (if (not new-buffer-p)              ; existing buffer ...
 745         (cond (switches                 ; ... but new switches
 746                ;; file list may have changed
 747                (setq dired-directory dir-or-list)
 748                ;; this calls dired-revert
 749                (dired-sort-other switches))
 750               ;; If directory has changed on disk, offer to revert.
 751               ((when (dired-directory-changed-p dirname)
 752                  (message "%s"
 753                           (substitute-command-keys
 754                            "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
 755       ;; Else a new buffer
 756       (setq default-directory
 757             ;; We can do this unconditionally
 758             ;; because dired-noselect ensures that the name
 759             ;; is passed in directory name syntax
 760             ;; if it was the name of a directory at all.
 761             (file-name-directory dirname))
 762       (or switches (setq switches dired-listing-switches))
 763       (if mode (funcall mode)
 764         (dired-mode dir-or-list switches))
 765       ;; default-directory and dired-actual-switches are set now
 766       ;; (buffer-local), so we can call dired-readin:
 767       (let ((failed t))
 768         (unwind-protect
 769             (progn (dired-readin)
 770                    (setq failed nil))
 771           ;; dired-readin can fail if parent directories are inaccessible.
 772           ;; Don't leave an empty buffer around in that case.
 773           (if failed (kill-buffer buffer))))
 774       (goto-char (point-min))
 775       (dired-initial-position dirname))
 776     (set-buffer old-buf)
 777     buffer))
 778
 779 (defvar dired-buffers nil
 780   ;; Enlarged by dired-advertise
 781   ;; Queried by function dired-buffers-for-dir. When this detects a
 782   ;; killed buffer, it is removed from this list.
 783   "Alist of expanded directories and their associated dired buffers.")
 784
 785 (defun dired-find-buffer-nocreate (dirname &optional mode)
 786   ;; This differs from dired-buffers-for-dir in that it does not consider
 787   ;; subdirs of default-directory and searches for the first match only.
 788   ;; Also, the major mode must be MODE.
 789   (setq dirname (expand-file-name dirname))
 790   (let (found (blist dired-buffers))    ; was (buffer-list)
 791     (or mode (setq mode 'dired-mode))
 792     (while blist
 793       (if (null (buffer-name (cdr (car blist))))
 794           (setq blist (cdr blist))
 795         (save-excursion
 796           (set-buffer (cdr (car blist)))
 797           (if (and (eq major-mode mode)
 798                    dired-directory  ;; nil during find-alternate-file
 799                    (equal dirname
 800                           (expand-file-name
 801                            (if (consp dired-directory)
 802                                (car dired-directory)
 803                              dired-directory))))
 804               (setq found (cdr (car blist))
 805                     blist nil)
 806             (setq blist (cdr blist))))))
 807     found))
 808
 809 \f
 810 ;; Read in a new dired buffer
 811
 812 (defun dired-readin ()
 813   "Read in a new dired buffer.
 814 Differs from `dired-insert-subdir' in that it accepts
 815 wildcards, erases the buffer, and builds the subdir-alist anew
 816 \(including making it buffer-local and clearing it first)."
 817
 818   ;; default-directory and dired-actual-switches must be buffer-local
 819   ;; and initialized by now.
 820   (let (dirname)
 821     (if (consp dired-directory)
 822         (setq dirname (car dired-directory))
 823       (setq dirname dired-directory))
 824     (setq dirname (expand-file-name dirname))
 825     (save-excursion
 826       ;; This hook which may want to modify dired-actual-switches
 827       ;; based on dired-directory, e.g. with ange-ftp to a SysV host
 828       ;; where ls won't understand -Al switches.
 829       (run-hooks 'dired-before-readin-hook)
 830       (if (consp buffer-undo-list)
 831           (setq buffer-undo-list nil))
 832       (make-local-variable 'file-name-coding-system)
 833       (setq file-name-coding-system
 834             (or coding-system-for-read file-name-coding-system))
 835       (let (buffer-read-only
 836             ;; Don't make undo entries for readin.
 837             (buffer-undo-list t))
 838         (widen)
 839         (erase-buffer)
 840         (dired-readin-insert))
 841       (goto-char (point-min))
 842       ;; Must first make alist buffer local and set it to nil because
 843       ;; dired-build-subdir-alist will call dired-clear-alist first
 844       (set (make-local-variable 'dired-subdir-alist) nil)
 845       (dired-build-subdir-alist)
 846       (let ((attributes (file-attributes dirname)))
 847         (if (eq (car attributes) t)
 848             (set-visited-file-modtime (nth 5 attributes))))
 849       (set-buffer-modified-p nil)
 850       ;; No need to narrow since the whole buffer contains just
 851       ;; dired-readin's output, nothing else.  The hook can
 852       ;; successfully use dired functions (e.g. dired-get-filename)
 853       ;; as the subdir-alist has been built in dired-readin.
 854       (run-hooks 'dired-after-readin-hook))))
 855
 856 ;; Subroutines of dired-readin
 857
 858 (defun dired-readin-insert ()
 859   ;; Insert listing for the specified dir (and maybe file list)
 860   ;; already in dired-directory, assuming a clean buffer.
 861   (let (dir file-list)
 862     (if (consp dired-directory)
 863         (setq dir (car dired-directory)
 864               file-list (cdr dired-directory))
 865       (setq dir dired-directory
 866             file-list nil))
 867     (setq dir (expand-file-name dir))
 868     (if (and (equal "" (file-name-nondirectory dir))
 869              (not file-list))
 870         ;; If we are reading a whole single directory...
 871         (dired-insert-directory dir dired-actual-switches nil nil t)
 872       (if (not (file-readable-p
 873                 (directory-file-name (file-name-directory dir))))
 874           (error "Directory %s inaccessible or nonexistent" dir)
 875         ;; Else treat it as a wildcard spec
 876         ;; unless we have an explicit list of files.
 877         (dired-insert-directory dir dired-actual-switches
 878                                 file-list (not file-list) t)))))
 879
 880 (defun dired-align-file (beg end)
 881   "Align the fields of a file to the ones of surrounding lines.
 882 BEG..END is the line where the file info is located."
 883   ;; Some versions of ls try to adjust the size of each field so as to just
 884   ;; hold the largest element ("largest" in the current invocation, of
 885   ;; course).  So when a single line is output, the size of each field is
 886   ;; just big enough for that one output.  Thus when dired refreshes one
 887   ;; line, the alignment if this line w.r.t the rest is messed up because
 888   ;; the fields of that one line will generally be smaller.
 889   ;;
 890   ;; To work around this problem, we here add spaces to try and
 891   ;; re-align the fields as needed.  Since this is purely aesthetic,
 892   ;; it is of utmost importance that it doesn't mess up anything like
 893   ;; `dired-move-to-filename'.  To this end, we limit ourselves to
 894   ;; adding spaces only, and to only add them at places where there
 895   ;; was already at least one space.  This way, as long as
 896   ;; `directory-listing-before-filename-regexp' always matches spaces
 897   ;; with "*" or "+", we know we haven't made anything worse.  There
 898   ;; is one spot where the exact number of spaces is important, which
 899   ;; is just before the actual filename, so we refrain from adding
 900   ;; spaces there (and within the filename as well, of course).
 901   (save-excursion
 902     (let (file file-col other other-col)
 903       ;; Check the there is indeed a file, and that there is anoter adjacent
 904       ;; file with which to align, and that additional spaces are needed to
 905       ;; align the filenames.
 906       (when (and (setq file (progn (goto-char beg)
 907                                    (dired-move-to-filename nil end)))
 908                  (setq file-col (current-column))
 909                  (setq other
 910                        (or (and (goto-char beg)
 911                                 (zerop (forward-line -1))
 912                                 (dired-move-to-filename))
 913                            (and (goto-char beg)
 914                                 (zerop (forward-line 1))
 915                                 (dired-move-to-filename))))
 916                  (setq other-col (current-column))
 917                  (/= file other)
 918                  ;; Make sure there is some work left to do.
 919                  (> other-col file-col))
 920         ;; If we've only looked at the line above, check to see if the line
 921         ;; below exists as well and if so, align with the shorter one.
 922         (when (and (< other file)
 923                    (goto-char beg)
 924                    (zerop (forward-line 1))
 925                    (dired-move-to-filename))
 926           (let ((alt-col (current-column)))
 927             (when (< alt-col other-col)
 928               (setq other-col alt-col)
 929               (setq other (point)))))
 930         ;; Keep positions uptodate when we insert stuff.
 931         (if (> other file) (setq other (copy-marker other)))
 932         (setq file (copy-marker file))
 933         ;; Main loop.
 934         (goto-char beg)
 935         (skip-chars-forward " ")        ;Skip to the first field.
 936         (while (and (> other-col file-col)
 937                     ;; Don't touch anything just before (and after) the
 938                     ;; beginning of the filename.
 939                     (> file (point)))
 940           ;; We're now just in front of a field, with a space behind us.
 941           (let* ((curcol (current-column))
 942                  ;; Nums are right-aligned.
 943                  (num-align (looking-at "[0-9]"))
 944                  ;; Let's look at the other line, in the same column: we
 945                  ;; should be either near the end of the previous field, or
 946                  ;; in the space between that field and the next.
 947                  ;; [ Of course, it's also possible that we're already within
 948                  ;; the next field or even past it, but that's unlikely since
 949                  ;; other-col > file-col. ]
 950                  ;; Let's find the distance to the alignment-point (either
 951                  ;; the beginning or the end of the next field, depending on
 952                  ;; whether this field is left or right aligned).
 953                  (align-pt-offset
 954                   (save-excursion
 955                     (goto-char other)
 956                     (move-to-column curcol)
 957                     (when (looking-at
 958                            (concat
 959                             (if (eq (char-before) ?\s) " *" "[^ ]* *")
 960                             (if num-align "[0-9][^ ]*")))
 961                       (- (match-end 0) (match-beginning 0)))))
 962                  ;; Now, the number of spaces to insert is align-pt-offset
 963                  ;; minus the distance to the equivalent point on the
 964                  ;; current line.
 965                  (spaces
 966                   (if (not num-align)
 967                       align-pt-offset
 968                     (and align-pt-offset
 969                          (save-excursion
 970                            (skip-chars-forward "^ ")
 971                            (- align-pt-offset (- (current-column) curcol)))))))
 972             (when (and spaces (> spaces 0))
 973               (setq file-col (+ spaces file-col))
 974               (if (> file-col other-col)
 975                   (setq spaces (- spaces (- file-col other-col))))
 976               (insert-char ?\s spaces)
 977               ;; Let's just make really sure we did not mess up.
 978               (unless (save-excursion
 979                         (eq (dired-move-to-filename) (marker-position file)))
 980                 ;; Damn!  We messed up: let's revert the change.
 981                 (delete-char (- spaces)))))
 982           ;; Now skip to next field.
 983           (skip-chars-forward "^ ") (skip-chars-forward " "))
 984         (set-marker file nil)))))
 985
 986
 987 (defun dired-insert-directory (dir switches &optional file-list wildcard hdr)
 988   "Insert a directory listing of DIR, Dired style.
 989 Use SWITCHES to make the listings.
 990 If FILE-LIST is non-nil, list only those files.
 991 Otherwise, if WILDCARD is non-nil, expand wildcards;
 992  in that case, DIR should be a file name that uses wildcards.
 993 In other cases, DIR should be a directory name or a directory filename.
 994 If HDR is non-nil, insert a header line with the directory name."
 995   (let ((opoint (point))
 996         (process-environment (copy-sequence process-environment))
 997         end)
 998     (if (or dired-use-ls-dired (file-remote-p dir))
 999         (setq switches (concat "--dired " switches)))
1000     ;; We used to specify the C locale here, to force English month names;
1001     ;; but this should not be necessary any more,
1002     ;; with the new value of `directory-listing-before-filename-regexp'.
1003     (if file-list
1004         (dolist (f file-list)
1005           (let ((beg (point)))
1006             (insert-directory f switches nil nil)
1007             ;; Re-align fields, if necessary.
1008             (dired-align-file beg (point))))
1009       (insert-directory dir switches wildcard (not wildcard)))
1010     ;; Quote certain characters, unless ls quoted them for us.
1011     (if (not (string-match "b" dired-actual-switches))
1012         (save-excursion
1013           (setq end (point-marker))
1014           (goto-char opoint)
1015           (while (search-forward "\\" end t)
1016             (replace-match (apply #'propertize
1017                                   "\\\\"
1018                                   (text-properties-at (match-beginning 0)))
1019                            nil t))
1020           (goto-char opoint)
1021           (while (search-forward "\^m" end t)
1022             (replace-match (apply #'propertize
1023                                   "\\015"
1024                                   (text-properties-at (match-beginning 0)))
1025                            nil t))
1026           (set-marker end nil)))
1027     (dired-insert-set-properties opoint (point))
1028     ;; If we used --dired and it worked, the lines are already indented.
1029     ;; Otherwise, indent them.
1030     (unless (save-excursion
1031               (goto-char opoint)
1032               (looking-at "  "))
1033       (let ((indent-tabs-mode nil))
1034         (indent-rigidly opoint (point) 2)))
1035     ;; Insert text at the beginning to standardize things.
1036     (save-excursion
1037       (goto-char opoint)
1038       (if (and (or hdr wildcard) (not (looking-at "^  /.*:$")))
1039           ;; Note that dired-build-subdir-alist will replace the name
1040           ;; by its expansion, so it does not matter whether what we insert
1041           ;; here is fully expanded, but it should be absolute.
1042           (insert "  " (directory-file-name (file-name-directory dir)) ":\n"))
1043       (when wildcard
1044         ;; Insert "wildcard" line where "total" line would be for a full dir.
1045         (insert "  wildcard " (file-name-nondirectory dir) "\n")))))
1046
1047 (defun dired-insert-set-properties (beg end)
1048   "Make the file names highlight when the mouse is on them."
1049   (save-excursion
1050     (goto-char beg)
1051     (while (< (point) end)
1052       (condition-case nil
1053           (if (dired-move-to-filename)
1054               (add-text-properties
1055                (point)
1056                (save-excursion
1057                  (dired-move-to-end-of-filename)
1058                  (point))
1059                '(mouse-face highlight
1060                  help-echo "mouse-2: visit this file in other window")))
1061         (error nil))
1062       (forward-line 1))))
1063 \f
1064 ;; Reverting a dired buffer
1065
1066 (defun dired-revert (&optional arg noconfirm)
1067   "Reread the dired buffer.
1068 Must also be called after `dired-actual-switches' have changed.
1069 Should not fail even on completely garbaged buffers.
1070 Preserves old cursor, marks/flags, hidden-p."
1071   (widen)                               ; just in case user narrowed
1072   (let ((modflag (buffer-modified-p))
1073         (opoint (point))
1074         (ofile (dired-get-filename nil t))
1075         (mark-alist nil)                ; save marked files
1076         (hidden-subdirs (dired-remember-hidden))
1077         (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
1078         (case-fold-search nil)          ; we check for upper case ls flags
1079         buffer-read-only)
1080     (goto-char (point-min))
1081     (setq mark-alist;; only after dired-remember-hidden since this unhides:
1082           (dired-remember-marks (point-min) (point-max)))
1083     ;; treat top level dir extra (it may contain wildcards)
1084     (dired-uncache
1085      (if (consp dired-directory) (car dired-directory) dired-directory))
1086     ;; Run dired-after-readin-hook just once, below.
1087     (let ((dired-after-readin-hook nil))
1088       (dired-readin)
1089       (dired-insert-old-subdirs old-subdir-alist))
1090     (dired-mark-remembered mark-alist)  ; mark files that were marked
1091     ;; ... run the hook for the whole buffer, and only after markers
1092     ;; have been reinserted (else omitting in dired-x would omit marked files)
1093     (run-hooks 'dired-after-readin-hook)        ; no need to narrow
1094     (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
1095         (goto-char opoint))             ; was before
1096     (dired-move-to-filename)
1097     (save-excursion                     ; hide subdirs that were hidden
1098       (dolist (dir hidden-subdirs)
1099         (if (dired-goto-subdir dir)
1100             (dired-hide-subdir 1))))
1101     (unless modflag (restore-buffer-modified-p nil)))
1102   ;; outside of the let scope
1103 ;;;  Might as well not override the user if the user changed this.
1104 ;;;  (setq buffer-read-only t)
1105   )
1106
1107 ;; Subroutines of dired-revert
1108 ;; Some of these are also used when inserting subdirs.
1109
1110 (defun dired-remember-marks (beg end)
1111   "Return alist of files and their marks, from BEG to END."
1112   (if selective-display                 ; must unhide to make this work.
1113       (let (buffer-read-only)
1114         (subst-char-in-region beg end ?\r ?\n)))
1115   (let (fil chr alist)
1116     (save-excursion
1117       (goto-char beg)
1118       (while (re-search-forward dired-re-mark end t)
1119         (if (setq fil (dired-get-filename nil t))
1120             (setq chr (preceding-char)
1121                   alist (cons (cons fil chr) alist)))))
1122     alist))
1123
1124 (defun dired-mark-remembered (alist)
1125   "Mark all files remembered in ALIST.
1126 Each element of ALIST looks like (FILE . MARKERCHAR)."
1127   (let (elt fil chr)
1128     (while alist
1129       (setq elt (car alist)
1130             alist (cdr alist)
1131             fil (car elt)
1132             chr (cdr elt))
1133       (if (dired-goto-file fil)
1134           (save-excursion
1135             (beginning-of-line)
1136             (delete-char 1)
1137             (insert chr))))))
1138
1139 (defun dired-remember-hidden ()
1140   "Return a list of names of subdirs currently hidden."
1141   (let ((l dired-subdir-alist) dir pos result)
1142     (while l
1143       (setq dir (car (car l))
1144             pos (cdr (car l))
1145             l (cdr l))
1146       (goto-char pos)
1147       (skip-chars-forward "^\r\n")
1148       (if (eq (following-char) ?\r)
1149           (setq result (cons dir result))))
1150     result))
1151
1152 (defun dired-insert-old-subdirs (old-subdir-alist)
1153   "Try to insert all subdirs that were displayed before.
1154 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1155   (or (string-match "R" dired-actual-switches)
1156       (let (elt dir)
1157         (while old-subdir-alist
1158           (setq elt (car old-subdir-alist)
1159                 old-subdir-alist (cdr old-subdir-alist)
1160                 dir (car elt))
1161           (condition-case ()
1162               (progn
1163                 (dired-uncache dir)
1164                 (dired-insert-subdir dir))
1165             (error nil))))))
1166
1167 (defun dired-uncache (dir)
1168   "Remove directory DIR from any directory cache."
1169   (let ((handler (find-file-name-handler dir 'dired-uncache)))
1170     (if handler
1171         (funcall handler 'dired-uncache dir))))
1172 \f
1173 ;; dired mode key bindings and initialization
1174
1175 (defvar dired-mode-map
1176   ;; This looks ugly when substitute-command-keys uses C-d instead d:
1177   ;;  (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1178   (let ((map (make-keymap)))
1179     (suppress-keymap map)
1180     (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
1181     (define-key map [follow-link] 'mouse-face)
1182     ;; Commands to mark or flag certain categories of files
1183     (define-key map "#" 'dired-flag-auto-save-files)
1184     (define-key map "." 'dired-clean-directory)
1185     (define-key map "~" 'dired-flag-backup-files)
1186     (define-key map "&" 'dired-flag-garbage-files)
1187     ;; Upper case keys (except !) for operating on the marked files
1188     (define-key map "A" 'dired-do-search)
1189     (define-key map "C" 'dired-do-copy)
1190     (define-key map "B" 'dired-do-byte-compile)
1191     (define-key map "D" 'dired-do-delete)
1192     (define-key map "G" 'dired-do-chgrp)
1193     (define-key map "H" 'dired-do-hardlink)
1194     (define-key map "L" 'dired-do-load)
1195     (define-key map "M" 'dired-do-chmod)
1196     (define-key map "O" 'dired-do-chown)
1197     (define-key map "P" 'dired-do-print)
1198     (define-key map "Q" 'dired-do-query-replace-regexp)
1199     (define-key map "R" 'dired-do-rename)
1200     (define-key map "S" 'dired-do-symlink)
1201     (define-key map "T" 'dired-do-touch)
1202     (define-key map "X" 'dired-do-shell-command)
1203     (define-key map "Z" 'dired-do-compress)
1204     (define-key map "!" 'dired-do-shell-command)
1205     ;; Comparison commands
1206     (define-key map "=" 'dired-diff)
1207     (define-key map "\M-=" 'dired-backup-diff)
1208     ;; Tree Dired commands
1209     (define-key map "\M-\C-?" 'dired-unmark-all-files)
1210     (define-key map "\M-\C-d" 'dired-tree-down)
1211     (define-key map "\M-\C-u" 'dired-tree-up)
1212     (define-key map "\M-\C-n" 'dired-next-subdir)
1213     (define-key map "\M-\C-p" 'dired-prev-subdir)
1214     ;; move to marked files
1215     (define-key map "\M-{" 'dired-prev-marked-file)
1216     (define-key map "\M-}" 'dired-next-marked-file)
1217     ;; Make all regexp commands share a `%' prefix:
1218     ;; We used to get to the submap via a symbol dired-regexp-prefix,
1219     ;; but that seems to serve little purpose, and copy-keymap
1220     ;; does a better job without it.
1221     (define-key map "%" nil)
1222     (define-key map "%u" 'dired-upcase)
1223     (define-key map "%l" 'dired-downcase)
1224     (define-key map "%d" 'dired-flag-files-regexp)
1225     (define-key map "%g" 'dired-mark-files-containing-regexp)
1226     (define-key map "%m" 'dired-mark-files-regexp)
1227     (define-key map "%r" 'dired-do-rename-regexp)
1228     (define-key map "%C" 'dired-do-copy-regexp)
1229     (define-key map "%H" 'dired-do-hardlink-regexp)
1230     (define-key map "%R" 'dired-do-rename-regexp)
1231     (define-key map "%S" 'dired-do-symlink-regexp)
1232     ;; Commands for marking and unmarking.
1233     (define-key map "*" nil)
1234     (define-key map "**" 'dired-mark-executables)
1235     (define-key map "*/" 'dired-mark-directories)
1236     (define-key map "*@" 'dired-mark-symlinks)
1237     (define-key map "*%" 'dired-mark-files-regexp)
1238     (define-key map "*c" 'dired-change-marks)
1239     (define-key map "*s" 'dired-mark-subdir-files)
1240     (define-key map "*m" 'dired-mark)
1241     (define-key map "*u" 'dired-unmark)
1242     (define-key map "*?" 'dired-unmark-all-files)
1243     (define-key map "*!" 'dired-unmark-all-marks)
1244     (define-key map "U" 'dired-unmark-all-marks)
1245     (define-key map "*\177" 'dired-unmark-backward)
1246     (define-key map "*\C-n" 'dired-next-marked-file)
1247     (define-key map "*\C-p" 'dired-prev-marked-file)
1248     (define-key map "*t" 'dired-toggle-marks)
1249     ;; Lower keys for commands not operating on all the marked files
1250     (define-key map "a" 'dired-find-alternate-file)
1251     (define-key map "d" 'dired-flag-file-deletion)
1252     (define-key map "e" 'dired-find-file)
1253     (define-key map "f" 'dired-find-file)
1254     (define-key map "\C-m" 'dired-advertised-find-file)
1255     (define-key map "g" 'revert-buffer)
1256     (define-key map "h" 'describe-mode)
1257     (define-key map "i" 'dired-maybe-insert-subdir)
1258     (define-key map "j" 'dired-goto-file)
1259     (define-key map "k" 'dired-do-kill-lines)
1260     (define-key map "l" 'dired-do-redisplay)
1261     (define-key map "m" 'dired-mark)
1262     (define-key map "n" 'dired-next-line)
1263     (define-key map "o" 'dired-find-file-other-window)
1264     (define-key map "\C-o" 'dired-display-file)
1265     (define-key map "p" 'dired-previous-line)
1266     (define-key map "q" 'quit-window)
1267     (define-key map "s" 'dired-sort-toggle-or-edit)
1268     (define-key map "t" 'dired-toggle-marks)
1269     (define-key map "u" 'dired-unmark)
1270     (define-key map "v" 'dired-view-file)
1271     (define-key map "w" 'dired-copy-filename-as-kill)
1272     (define-key map "x" 'dired-do-flagged-delete)
1273     (define-key map "y" 'dired-show-file-type)
1274     (define-key map "+" 'dired-create-directory)
1275     ;; moving
1276     (define-key map "<" 'dired-prev-dirline)
1277     (define-key map ">" 'dired-next-dirline)
1278     (define-key map "^" 'dired-up-directory)
1279     (define-key map " "  'dired-next-line)
1280     (define-key map "\C-n" 'dired-next-line)
1281     (define-key map "\C-p" 'dired-previous-line)
1282     (define-key map [down] 'dired-next-line)
1283     (define-key map [up] 'dired-previous-line)
1284     ;; hiding
1285     (define-key map "$" 'dired-hide-subdir)
1286     (define-key map "\M-$" 'dired-hide-all)
1287     ;; misc
1288     (define-key map "\C-x\C-q" 'dired-toggle-read-only)
1289     (define-key map "?" 'dired-summary)
1290     (define-key map "\177" 'dired-unmark-backward)
1291     (define-key map [remap undo] 'dired-undo)
1292     (define-key map [remap advertised-undo] 'dired-undo)
1293     ;; thumbnail manipulation (image-dired)
1294     (define-key map "\C-td" 'image-dired-display-thumbs)
1295     (define-key map "\C-tt" 'image-dired-tag-files)
1296     (define-key map "\C-tr" 'image-dired-delete-tag)
1297     (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1298     (define-key map "\C-ti" 'image-dired-dired-display-image)
1299     (define-key map "\C-tx" 'image-dired-dired-display-external)
1300     (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1301     (define-key map "\C-t." 'image-dired-display-thumb)
1302     (define-key map "\C-tc" 'image-dired-dired-comment-files)
1303     (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1304     (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1305     (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1306     ;; encryption and decryption (epa-dired)
1307     (define-key map ":d" 'epa-dired-do-decrypt)
1308     (define-key map ":v" 'epa-dired-do-verify)
1309     (define-key map ":s" 'epa-dired-do-sign)
1310     (define-key map ":e" 'epa-dired-do-encrypt)
1311
1312     ;; Make menu bar items.
1313
1314     ;; No need to fo this, now that top-level items are fewer.
1315     ;;;;
1316     ;; Get rid of the Edit menu bar item to save space.
1317     ;(define-key map [menu-bar edit] 'undefined)
1318
1319     (define-key map [menu-bar subdir]
1320       (cons "Subdir" (make-sparse-keymap "Subdir")))
1321
1322     (define-key map [menu-bar subdir hide-all]
1323       '(menu-item "Hide All" dired-hide-all
1324                   :help "Hide all subdirectories, leave only header lines"))
1325     (define-key map [menu-bar subdir hide-subdir]
1326       '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1327                   :help "Hide or unhide current directory listing"))
1328     (define-key map [menu-bar subdir tree-down]
1329       '(menu-item "Tree Down" dired-tree-down
1330                   :help "Go to first subdirectory header down the tree"))
1331     (define-key map [menu-bar subdir tree-up]
1332       '(menu-item "Tree Up" dired-tree-up
1333                   :help "Go to first subdirectory header up the tree"))
1334     (define-key map [menu-bar subdir up]
1335       '(menu-item "Up Directory" dired-up-directory
1336                   :help "Edit the parent directory"))
1337     (define-key map [menu-bar subdir prev-subdir]
1338       '(menu-item "Prev Subdir" dired-prev-subdir
1339                   :help "Go to previous subdirectory header line"))
1340     (define-key map [menu-bar subdir next-subdir]
1341       '(menu-item "Next Subdir" dired-next-subdir
1342                   :help "Go to next subdirectory header line"))
1343     (define-key map [menu-bar subdir prev-dirline]
1344       '(menu-item "Prev Dirline" dired-prev-dirline
1345                   :help "Move to next directory-file line"))
1346     (define-key map [menu-bar subdir next-dirline]
1347       '(menu-item "Next Dirline" dired-next-dirline
1348                   :help "Move to previous directory-file line"))
1349     (define-key map [menu-bar subdir insert]
1350       '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1351                   :help "Insert contents of subdirectory"))
1352
1353     (define-key map [menu-bar immediate]
1354       (cons "Immediate" (make-sparse-keymap "Immediate")))
1355
1356     (define-key map
1357       [menu-bar immediate epa-dired-do-decrypt]
1358       '(menu-item "Decrypt" epa-dired-do-decrypt
1359                   :help "Decrypt file at cursor"))
1360
1361     (define-key map
1362       [menu-bar immediate epa-dired-do-verify]
1363       '(menu-item "Verify" epa-dired-do-verify
1364                   :help "Verify digital signature of file at cursor"))
1365
1366     (define-key map
1367       [menu-bar immediate epa-dired-do-sign]
1368       '(menu-item "Sign" epa-dired-do-sign
1369                   :help "Create digital signature of file at cursor"))
1370
1371     (define-key map
1372       [menu-bar immediate epa-dired-do-encrypt]
1373       '(menu-item "Encrypt" epa-dired-do-encrypt
1374                   :help "Encrypt file at cursor"))
1375
1376     (define-key map [menu-bar immediate dashes-4]
1377       '("--"))
1378
1379     (define-key map
1380       [menu-bar immediate image-dired-dired-display-external]
1381       '(menu-item "Display Image Externally" image-dired-dired-display-external
1382                   :help "Display image in external viewer"))
1383     (define-key map
1384       [menu-bar immediate image-dired-dired-display-image]
1385       '(menu-item "Display Image" image-dired-dired-display-image
1386                   :help "Display sized image in a separate window"))
1387
1388     (define-key map [menu-bar immediate dashes-4]
1389       '("--"))
1390
1391     (define-key map [menu-bar immediate revert-buffer]
1392       '(menu-item "Refresh" revert-buffer
1393                   :help "Update contents of shown directories"))
1394
1395     (define-key map [menu-bar immediate dashes]
1396       '("--"))
1397
1398     (define-key map [menu-bar immediate compare-directories]
1399       '(menu-item "Compare Directories..." dired-compare-directories
1400                   :help "Mark files with different attributes in two dired buffers"))
1401     (define-key map [menu-bar immediate backup-diff]
1402       '(menu-item "Compare with Backup" dired-backup-diff
1403                   :help "Diff file at cursor with its latest backup"))
1404     (define-key map [menu-bar immediate diff]
1405       '(menu-item "Diff..." dired-diff
1406                   :help "Compare file at cursor with another file"))
1407     (define-key map [menu-bar immediate view]
1408       '(menu-item "View This File" dired-view-file
1409                   :help "Examine file at cursor in read-only mode"))
1410     (define-key map [menu-bar immediate display]
1411       '(menu-item "Display in Other Window" dired-display-file
1412                   :help "Display file at cursor in other window"))
1413     (define-key map [menu-bar immediate find-file-other-window]
1414       '(menu-item "Find in Other Window" dired-find-file-other-window
1415                   :help "Edit file at cursor in other window"))
1416     (define-key map [menu-bar immediate find-file]
1417       '(menu-item "Find This File" dired-find-file
1418                   :help "Edit file at cursor"))
1419     (define-key map [menu-bar immediate create-directory]
1420       '(menu-item "Create Directory..." dired-create-directory
1421                   :help "Create a directory"))
1422     (define-key map [menu-bar immediate wdired-mode]
1423       '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1424                   :help "Put a dired buffer in a mode in which filenames are editable"
1425                   :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1426
1427     (define-key map [menu-bar regexp]
1428       (cons "Regexp" (make-sparse-keymap "Regexp")))
1429
1430     (define-key map
1431       [menu-bar regexp image-dired-mark-tagged-files]
1432       '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1433                   :help "Mark files whose image tags matches regexp"))
1434
1435     (define-key map [menu-bar regexp dashes-1]
1436       '("--"))
1437
1438     (define-key map [menu-bar regexp downcase]
1439       '(menu-item "Downcase" dired-downcase
1440                   ;; When running on plain MS-DOS, there's only one
1441                   ;; letter-case for file names.
1442                   :enable (or (not (fboundp 'msdos-long-file-names))
1443                               (msdos-long-file-names))
1444                   :help "Rename marked files to lower-case name"))
1445     (define-key map [menu-bar regexp upcase]
1446       '(menu-item "Upcase" dired-upcase
1447                   :enable (or (not (fboundp 'msdos-long-file-names))
1448                               (msdos-long-file-names))
1449                   :help "Rename marked files to upper-case name"))
1450     (define-key map [menu-bar regexp hardlink]
1451       '(menu-item "Hardlink..." dired-do-hardlink-regexp
1452                   :help "Make hard links for files matching regexp"))
1453     (define-key map [menu-bar regexp symlink]
1454       '(menu-item "Symlink..." dired-do-symlink-regexp
1455                   :visible (fboundp 'make-symbolic-link)
1456                   :help "Make symbolic links for files matching regexp"))
1457     (define-key map [menu-bar regexp rename]
1458       '(menu-item "Rename..." dired-do-rename-regexp
1459                   :help "Rename marked files matching regexp"))
1460     (define-key map [menu-bar regexp copy]
1461       '(menu-item "Copy..." dired-do-copy-regexp
1462                   :help "Copy marked files matching regexp"))
1463     (define-key map [menu-bar regexp flag]
1464       '(menu-item "Flag..." dired-flag-files-regexp
1465                   :help "Flag files matching regexp for deletion"))
1466     (define-key map [menu-bar regexp mark]
1467       '(menu-item "Mark..." dired-mark-files-regexp
1468                   :help "Mark files matching regexp for future operations"))
1469     (define-key map [menu-bar regexp mark-cont]
1470       '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1471                   :help "Mark files whose contents matches regexp"))
1472
1473     (define-key map [menu-bar mark]
1474       (cons "Mark" (make-sparse-keymap "Mark")))
1475
1476     (define-key map [menu-bar mark prev]
1477       '(menu-item "Previous Marked" dired-prev-marked-file
1478                   :help "Move to previous marked file"))
1479     (define-key map [menu-bar mark next]
1480       '(menu-item "Next Marked" dired-next-marked-file
1481                   :help "Move to next marked file"))
1482     (define-key map [menu-bar mark marks]
1483       '(menu-item "Change Marks..." dired-change-marks
1484                   :help "Replace marker with another character"))
1485     (define-key map [menu-bar mark unmark-all]
1486       '(menu-item "Unmark All" dired-unmark-all-marks))
1487     (define-key map [menu-bar mark symlinks]
1488       '(menu-item "Mark Symlinks" dired-mark-symlinks
1489                   :visible (fboundp 'make-symbolic-link)
1490                   :help "Mark all symbolic links"))
1491     (define-key map [menu-bar mark directories]
1492       '(menu-item "Mark Directories" dired-mark-directories
1493                   :help "Mark all directories except `.' and `..'"))
1494     (define-key map [menu-bar mark directory]
1495       '(menu-item "Mark Old Backups" dired-clean-directory
1496                   :help "Flag old numbered backups for deletion"))
1497     (define-key map [menu-bar mark executables]
1498       '(menu-item "Mark Executables" dired-mark-executables
1499                   :help "Mark all executable files"))
1500     (define-key map [menu-bar mark garbage-files]
1501       '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1502                   :help "Flag unneeded files for deletion"))
1503     (define-key map [menu-bar mark backup-files]
1504       '(menu-item "Flag Backup Files" dired-flag-backup-files
1505                   :help "Flag all backup files for deletion"))
1506     (define-key map [menu-bar mark auto-save-files]
1507       '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1508                   :help "Flag auto-save files for deletion"))
1509     (define-key map [menu-bar mark deletion]
1510       '(menu-item "Flag" dired-flag-file-deletion
1511                   :help "Flag current line's file for deletion"))
1512     (define-key map [menu-bar mark unmark]
1513       '(menu-item "Unmark" dired-unmark
1514                   :help "Unmark or unflag current line's file"))
1515     (define-key map [menu-bar mark mark]
1516       '(menu-item "Mark" dired-mark
1517                   :help "Mark current line's file for future operations"))
1518     (define-key map [menu-bar mark toggle-marks]
1519       '(menu-item "Toggle Marks" dired-toggle-marks
1520                   :help "Mark unmarked files, unmark marked ones"))
1521
1522     (define-key map [menu-bar operate]
1523       (cons "Operate" (make-sparse-keymap "Operate")))
1524
1525     (define-key map
1526       [menu-bar operate image-dired-delete-tag]
1527       '(menu-item "Delete Image Tag..." image-dired-delete-tag
1528                   :help "Delete image tag from current or marked files"))
1529     (define-key map
1530       [menu-bar operate image-dired-tag-files]
1531       '(menu-item "Add Image Tags..." image-dired-tag-files
1532                   :help "Add image tags to current or marked files"))
1533     (define-key map
1534       [menu-bar operate image-dired-dired-comment-files]
1535       '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1536                   :help "Add image comment to current or marked files"))
1537     (define-key map
1538       [menu-bar operate image-dired-display-thumbs]
1539       '(menu-item "Display Image-Dired" image-dired-display-thumbs
1540                   :help "Display image-dired for current or marked image files"))
1541
1542     (define-key map [menu-bar operate dashes-3]
1543       '("--"))
1544
1545     (define-key map [menu-bar operate query-replace]
1546       '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1547                   :help "Replace regexp in marked files"))
1548     (define-key map [menu-bar operate search]
1549       '(menu-item "Search Files..." dired-do-search
1550                   :help "Search marked files for regexp"))
1551     (define-key map [menu-bar operate chown]
1552       '(menu-item "Change Owner..." dired-do-chown
1553                   :visible (not (memq system-type '(ms-dos windows-nt)))
1554                   :help "Change the owner of marked files"))
1555     (define-key map [menu-bar operate chgrp]
1556       '(menu-item "Change Group..." dired-do-chgrp
1557                   :visible (not (memq system-type '(ms-dos windows-nt)))
1558                   :help "Change the group of marked files"))
1559     (define-key map [menu-bar operate chmod]
1560       '(menu-item "Change Mode..." dired-do-chmod
1561                   :help "Change mode (attributes) of marked files"))
1562     (define-key map [menu-bar operate touch]
1563       '(menu-item "Change Timestamp..." dired-do-touch
1564                   :help "Change timestamp of marked files"))
1565     (define-key map [menu-bar operate load]
1566       '(menu-item "Load" dired-do-load
1567                   :help "Load marked Emacs Lisp files"))
1568     (define-key map [menu-bar operate compile]
1569       '(menu-item "Byte-compile" dired-do-byte-compile
1570                   :help "Byte-compile marked Emacs Lisp files"))
1571     (define-key map [menu-bar operate compress]
1572       '(menu-item "Compress" dired-do-compress
1573                   :help "Compress/uncompress marked files"))
1574     (define-key map [menu-bar operate print]
1575       '(menu-item "Print..." dired-do-print
1576                   :help "Ask for print command and print marked files"))
1577     (define-key map [menu-bar operate hardlink]
1578       '(menu-item "Hardlink to..." dired-do-hardlink
1579                   :help "Make hard links for current or marked files"))
1580     (define-key map [menu-bar operate symlink]
1581       '(menu-item "Symlink to..." dired-do-symlink
1582                   :visible (fboundp 'make-symbolic-link)
1583                   :help "Make symbolic links for current or marked files"))
1584     (define-key map [menu-bar operate command]
1585       '(menu-item "Shell Command..." dired-do-shell-command
1586                   :help "Run a shell command on each of marked files"))
1587     (define-key map [menu-bar operate delete]
1588       '(menu-item "Delete" dired-do-delete
1589                   :help "Delete current file or all marked files"))
1590     (define-key map [menu-bar operate rename]
1591       '(menu-item "Rename to..." dired-do-rename
1592                   :help "Rename current file or move marked files"))
1593     (define-key map [menu-bar operate copy]
1594       '(menu-item "Copy to..." dired-do-copy
1595                   :help "Copy current file or all marked files"))
1596
1597     map)
1598   "Local keymap for `dired-mode' buffers.")
1599 \f
1600 ;; Dired mode is suitable only for specially formatted data.
1601 (put 'dired-mode 'mode-class 'special)
1602
1603 ;; Autoload cookie needed by desktop.el
1604 ;;;###autoload
1605 (defun dired-mode (&optional dirname switches)
1606   "\
1607 Mode for \"editing\" directory listings.
1608 In Dired, you are \"editing\" a list of the files in a directory and
1609   \(optionally) its subdirectories, in the format of `ls -lR'.
1610   Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1611 \"Editing\" means that you can run shell commands on files, visit,
1612   compress, load or byte-compile them, change their file attributes
1613   and insert subdirectories into the same buffer.  You can \"mark\"
1614   files for later commands or \"flag\" them for deletion, either file
1615   by file or all files matching certain criteria.
1616 You can move using the usual cursor motion commands.\\<dired-mode-map>
1617 Letters no longer insert themselves.  Digits are prefix arguments.
1618 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1619 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1620   Most commands operate on the marked files and use the current file
1621   if no files are marked.  Use a numeric prefix argument to operate on
1622   the next ARG (or previous -ARG if ARG<0) files, or just `1'
1623   to operate on the current file only.  Prefix arguments override marks.
1624   Mark-using commands display a list of failures afterwards.  Type \\[dired-summary]
1625   to see why something went wrong.
1626 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1627 Type \\[dired-unmark-backward] to back up one line and unflag.
1628 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1629 Type \\[dired-advertised-find-file] to Find the current line's file
1630   (or dired it in another buffer, if it is a directory).
1631 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1632 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1633 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1634 Type \\[dired-do-copy] to Copy files.
1635 Type \\[dired-sort-toggle-or-edit] to toggle Sorting by name/date or change the `ls' switches.
1636 Type \\[revert-buffer] to read all currently expanded directories aGain.
1637   This retains all marks and hides subdirs again that were hidden before.
1638 SPC and DEL can be used to move down and up by lines.
1639
1640 If Dired ever gets confused, you can either type \\[revert-buffer] \
1641 to read the
1642 directories again, type \\[dired-do-redisplay] \
1643 to relist a single or the marked files or a
1644 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1645 again for the directory tree.
1646
1647 Customization variables (rename this buffer and type \\[describe-variable] on each line
1648 for more info):
1649
1650   `dired-listing-switches'
1651   `dired-trivial-filenames'
1652   `dired-shrink-to-fit'
1653   `dired-marker-char'
1654   `dired-del-marker'
1655   `dired-keep-marker-rename'
1656   `dired-keep-marker-copy'
1657   `dired-keep-marker-hardlink'
1658   `dired-keep-marker-symlink'
1659
1660 Hooks (use \\[describe-variable] to see their documentation):
1661
1662   `dired-before-readin-hook'
1663   `dired-after-readin-hook'
1664   `dired-mode-hook'
1665   `dired-load-hook'
1666
1667 Keybindings:
1668 \\{dired-mode-map}"
1669   ;; Not to be called interactively (e.g. dired-directory will be set
1670   ;; to default-directory, which is wrong with wildcards).
1671   (kill-all-local-variables)
1672   (use-local-map dired-mode-map)
1673   (dired-advertise)                     ; default-directory is already set
1674   (setq major-mode 'dired-mode
1675         mode-name "Dired"
1676         ;; case-fold-search nil
1677         buffer-read-only t
1678         selective-display t             ; for subdirectory hiding
1679         mode-line-buffer-identification
1680         (propertized-buffer-identification "%17b"))
1681   (set (make-local-variable 'revert-buffer-function)
1682        (function dired-revert))
1683   (set (make-local-variable 'buffer-stale-function)
1684        (function dired-buffer-stale-p))
1685   (set (make-local-variable 'page-delimiter)
1686        "\n\n")
1687   (set (make-local-variable 'dired-directory)
1688        (or dirname default-directory))
1689   ;; list-buffers uses this to display the dir being edited in this buffer.
1690   (set (make-local-variable 'list-buffers-directory)
1691        (expand-file-name (if (listp dired-directory)
1692                              (car dired-directory)
1693                            dired-directory)))
1694   (set (make-local-variable 'dired-actual-switches)
1695        (or switches dired-listing-switches))
1696   (set (make-local-variable 'font-lock-defaults)
1697        '(dired-font-lock-keywords t nil nil beginning-of-line))
1698   (set (make-local-variable 'desktop-save-buffer)
1699        'dired-desktop-buffer-misc-data)
1700   (setq dired-switches-alist nil)
1701   (dired-sort-other dired-actual-switches t)
1702   (when (featurep 'dnd)
1703     (set (make-local-variable 'dnd-protocol-alist)
1704          (append dired-dnd-protocol-alist dnd-protocol-alist)))
1705   (run-mode-hooks 'dired-mode-hook))
1706 \f
1707 ;; Idiosyncratic dired commands that don't deal with marks.
1708
1709 (defun dired-summary ()
1710   "Summarize basic Dired commands and show recent dired errors."
1711   (interactive)
1712   (dired-why)
1713   ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1714   (message
1715    "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1716
1717 (defun dired-undo ()
1718   "Undo in a dired buffer.
1719 This doesn't recover lost files, it just undoes changes in the buffer itself.
1720 You can use it to recover marks, killed lines or subdirs."
1721   (interactive)
1722   (let (buffer-read-only)
1723     (undo))
1724   (dired-build-subdir-alist)
1725   (message "Change in dired buffer undone.
1726 Actual changes in files cannot be undone by Emacs."))
1727
1728 (defun dired-toggle-read-only ()
1729   "Edit dired buffer with Wdired, or set it read-only.
1730 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1731 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1732 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1733   (interactive)
1734   (if (eq major-mode 'dired-mode)
1735       (wdired-change-to-wdired-mode)
1736     (toggle-read-only)))
1737
1738 (defun dired-next-line (arg)
1739   "Move down lines then position at filename.
1740 Optional prefix ARG says how many lines to move; default is one line."
1741   (interactive "p")
1742   (forward-line arg)
1743   (dired-move-to-filename))
1744
1745 (defun dired-previous-line (arg)
1746   "Move up lines then position at filename.
1747 Optional prefix ARG says how many lines to move; default is one line."
1748   (interactive "p")
1749   (forward-line (- arg))
1750   (dired-move-to-filename))
1751
1752 (defun dired-next-dirline (arg &optional opoint)
1753   "Goto ARG'th next directory file line."
1754   (interactive "p")
1755   (or opoint (setq opoint (point)))
1756   (if (if (> arg 0)
1757           (re-search-forward dired-re-dir nil t arg)
1758         (beginning-of-line)
1759         (re-search-backward dired-re-dir nil t (- arg)))
1760       (dired-move-to-filename)          ; user may type `i' or `f'
1761     (goto-char opoint)
1762     (error "No more subdirectories")))
1763
1764 (defun dired-prev-dirline (arg)
1765   "Goto ARG'th previous directory file line."
1766   (interactive "p")
1767   (dired-next-dirline (- arg)))
1768
1769 (defun dired-up-directory (&optional other-window)
1770   "Run Dired on parent directory of current directory.
1771 Find the parent directory either in this buffer or another buffer.
1772 Creates a buffer if necessary."
1773   (interactive "P")
1774   (let* ((dir (dired-current-directory))
1775          (up (file-name-directory (directory-file-name dir))))
1776     (or (dired-goto-file (directory-file-name dir))
1777         ;; Only try dired-goto-subdir if buffer has more than one dir.
1778         (and (cdr dired-subdir-alist)
1779              (dired-goto-subdir up))
1780         (progn
1781           (if other-window
1782               (dired-other-window up)
1783             (dired up))
1784           (dired-goto-file dir)))))
1785
1786 (defun dired-get-file-for-visit ()
1787   "Get the current line's file name, with an error if file does not exist."
1788   (interactive)
1789   ;; We pass t for second arg so that we don't get error for `.' and `..'.
1790   (let ((raw (dired-get-filename nil t))
1791         file-name)
1792     (if (null raw)
1793         (error "No file on this line"))
1794     (setq file-name (file-name-sans-versions raw t))
1795     (if (file-exists-p file-name)
1796         file-name
1797       (if (file-symlink-p file-name)
1798           (error "File is a symlink to a nonexistent target")
1799         (error "File no longer exists; type `g' to update dired buffer")))))
1800
1801 ;; Force `f' rather than `e' in the mode doc:
1802 (defalias 'dired-advertised-find-file 'dired-find-file)
1803 (defun dired-find-file ()
1804   "In Dired, visit the file or directory named on this line."
1805   (interactive)
1806   ;; Bind `find-file-run-dired' so that the command works on directories
1807   ;; too, independent of the user's setting.
1808   (let ((find-file-run-dired t))
1809     (find-file (dired-get-file-for-visit))))
1810
1811 (defun dired-find-alternate-file ()
1812   "In Dired, visit this file or directory instead of the dired buffer."
1813   (interactive)
1814   (set-buffer-modified-p nil)
1815   (find-alternate-file (dired-get-file-for-visit)))
1816 ;; Don't override the setting from .emacs.
1817 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1818
1819 (defun dired-mouse-find-file-other-window (event)
1820   "In Dired, visit the file or directory name you click on."
1821   (interactive "e")
1822   (let (window pos file)
1823     (save-excursion
1824       (setq window (posn-window (event-end event))
1825             pos (posn-point (event-end event)))
1826       (if (not (windowp window))
1827           (error "No file chosen"))
1828       (set-buffer (window-buffer window))
1829       (goto-char pos)
1830       (setq file (dired-get-file-for-visit)))
1831     (if (file-directory-p file)
1832         (or (and (cdr dired-subdir-alist)
1833                  (dired-goto-subdir file))
1834             (progn
1835               (select-window window)
1836               (dired-other-window file)))
1837       (select-window window)
1838       (find-file-other-window (file-name-sans-versions file t)))))
1839
1840 (defun dired-view-file ()
1841   "In Dired, examine a file in view mode, returning to Dired when done.
1842 When file is a directory, show it in this buffer if it is inserted.
1843 Otherwise, display it in another buffer."
1844   (interactive)
1845   (let ((file (dired-get-file-for-visit)))
1846     (if (file-directory-p file)
1847         (or (and (cdr dired-subdir-alist)
1848                  (dired-goto-subdir file))
1849             (dired file))
1850       (view-file file))))
1851
1852 (defun dired-find-file-other-window ()
1853   "In Dired, visit this file or directory in another window."
1854   (interactive)
1855   (find-file-other-window (dired-get-file-for-visit)))
1856
1857 (defun dired-display-file ()
1858   "In Dired, display this file or directory in another window."
1859   (interactive)
1860   (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1861 \f
1862 ;;; Functions for extracting and manipulating file names in Dired buffers.
1863
1864 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1865   "In Dired, return name of file mentioned on this line.
1866 Value returned normally includes the directory name.
1867 Optional arg LOCALP with value `no-dir' means don't include directory
1868 name in result.  A value of `verbatim' means to return the name exactly as
1869 it occurs in the buffer, and a value of t means construct name relative to
1870 `default-directory', which still may contain slashes if in a subdirectory.
1871 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1872 regular filenames and return nil if no filename on this line.
1873 Otherwise, an error occurs in these cases."
1874   (let (case-fold-search file p1 p2 already-absolute)
1875     (save-excursion
1876       (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1877           (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1878     ;; nil if no file on this line, but no-error-if-not-filep is t:
1879     (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1880         (progn
1881           ;; Get rid of the mouse-face property that file names have.
1882           (set-text-properties 0 (length file) nil file)
1883           ;; Unquote names quoted by ls or by dired-insert-directory.
1884           ;; Using read to unquote is much faster than substituting
1885           ;; \007 (4 chars) -> ^G  (1 char) etc. in a lisp loop.
1886           (setq file
1887                 (read
1888                  (concat "\""
1889                          ;; Some ls -b don't escape quotes, argh!
1890                          ;; This is not needed for GNU ls, though.
1891                          (or (dired-string-replace-match
1892                               "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
1893                              file)
1894                          "\"")))
1895           ;; The above `read' will return a unibyte string if FILE
1896           ;; contains eight-bit-control/graphic characters.
1897           (if (and enable-multibyte-characters
1898                    (not (multibyte-string-p file)))
1899               (setq file (string-to-multibyte file)))))
1900     (and file (file-name-absolute-p file)
1901          ;; A relative file name can start with ~.
1902          ;; Don't treat it as absolute in this context.
1903          (not (eq (aref file 0) ?~))
1904          (setq already-absolute t))
1905     (cond
1906      ((null file)
1907       nil)
1908      ((eq localp 'verbatim)
1909       file)
1910      ((and (not no-error-if-not-filep)
1911            (member file '("." "..")))
1912       (error "Cannot operate on `.' or `..'"))
1913      ((and (eq localp 'no-dir) already-absolute)
1914       (file-name-nondirectory file))
1915      (already-absolute
1916       (let ((handler (find-file-name-handler file nil)))
1917         ;; check for safe-magic property so that we won't
1918         ;; put /: for names that don't really need them.
1919         ;; For instance, .gz files when auto-compression-mode is on.
1920         (if (and handler (not (get handler 'safe-magic)))
1921             (concat "/:" file)
1922           file)))
1923      ((eq localp 'no-dir)
1924       file)
1925      ((equal (dired-current-directory) "/")
1926       (setq file (concat (dired-current-directory localp) file))
1927       (let ((handler (find-file-name-handler file nil)))
1928         ;; check for safe-magic property so that we won't
1929         ;; put /: for names that don't really need them.
1930         ;; For instance, .gz files when auto-compression-mode is on.
1931         (if (and handler (not (get handler 'safe-magic)))
1932             (concat "/:" file)
1933           file)))
1934      (t
1935       (concat (dired-current-directory localp) file)))))
1936
1937 (defun dired-string-replace-match (regexp string newtext
1938                                    &optional literal global)
1939   "Replace first match of REGEXP in STRING with NEWTEXT.
1940 If it does not match, nil is returned instead of the new string.
1941 Optional arg LITERAL means to take NEWTEXT literally.
1942 Optional arg GLOBAL means to replace all matches."
1943   (if global
1944       (let ((start 0) ret)
1945         (while (string-match regexp string start)
1946           (let ((from-end (- (length string) (match-end 0))))
1947             (setq ret (setq string (replace-match newtext t literal string)))
1948             (setq start (- (length string) from-end))))
1949           ret)
1950     (if (not (string-match regexp string 0))
1951         nil
1952       (replace-match newtext t literal string))))
1953
1954 (defun dired-make-absolute (file &optional dir)
1955   ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1956   ;; We can't always use expand-file-name as this would get rid of `.'
1957   ;; or expand in / instead default-directory if DIR=="".
1958   ;; This should be good enough for ange-ftp, but might easily be
1959   ;; redefined (for VMS?).
1960   ;; It should be reasonably fast, though, as it is called in
1961   ;; dired-get-filename.
1962   (concat (or dir default-directory) file))
1963
1964 (defun dired-make-relative (file &optional dir ignore)
1965   "Convert FILE (an absolute file name) to a name relative to DIR.
1966 If this is impossible, return FILE unchanged.
1967 DIR must be a directory name, not a file name."
1968   (or dir (setq dir default-directory))
1969   ;; This case comes into play if default-directory is set to
1970   ;; use ~.
1971   (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1972       (setq dir (expand-file-name dir)))
1973   (if (string-match (concat "^" (regexp-quote dir)) file)
1974       (substring file (match-end 0))
1975 ;;;  (or no-error
1976 ;;;     (error "%s: not in directory tree growing at %s" file dir))
1977     file))
1978 \f
1979 ;;; Functions for finding the file name in a dired buffer line.
1980
1981 (defvar dired-permission-flags-regexp
1982   "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
1983   "Regular expression to match the permission flags in `ls -l'.")
1984
1985 ;; Move to first char of filename on this line.
1986 ;; Returns position (point) or nil if no filename on this line."
1987 (defun dired-move-to-filename (&optional raise-error eol)
1988   "Move to the beginning of the filename on the current line.
1989 Return the position of the beginning of the filename, or nil if none found."
1990   ;; This is the UNIX version.
1991   (or eol (setq eol (line-end-position)))
1992   (beginning-of-line)
1993   ;; First try assuming `ls --dired' was used.
1994   (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1995     (cond
1996      ((and change (< change eol))
1997       (goto-char change))
1998      ((re-search-forward directory-listing-before-filename-regexp eol t)
1999       (goto-char (match-end 0)))
2000      ((re-search-forward dired-permission-flags-regexp eol t)
2001       ;; Ha!  There *is* a file.  Our regexp-from-hell just failed to find it.
2002       (if raise-error
2003           (error "Unrecognized line!  Check directory-listing-before-filename-regexp"))
2004       (beginning-of-line)
2005       nil)
2006      (raise-error
2007       (error "No file on this line")))))
2008
2009 (defun dired-move-to-end-of-filename (&optional no-error)
2010   ;; Assumes point is at beginning of filename,
2011   ;; thus the rwx bit re-search-backward below will succeed in *this*
2012   ;; line if at all.  So, it should be called only after
2013   ;; (dired-move-to-filename t).
2014   ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2015   ;; This is the UNIX version.
2016   (if (get-text-property (point) 'dired-filename)
2017       (goto-char (next-single-property-change (point) 'dired-filename))
2018     (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2019       ;; case-fold-search is nil now, so we can test for capital F:
2020       (setq used-F (string-match "F" dired-actual-switches)
2021             opoint (point)
2022             eol (save-excursion (end-of-line) (point))
2023             hidden (and selective-display
2024                         (save-excursion (search-forward "\r" eol t))))
2025       (if hidden
2026           nil
2027         (save-excursion ;; Find out what kind of file this is:
2028           ;; Restrict perm bits to be non-blank,
2029           ;; otherwise this matches one char to early (looking backward):
2030           ;; "l---------" (some systems make symlinks that way)
2031           ;; "----------" (plain file with zero perms)
2032           (if (re-search-backward
2033                dired-permission-flags-regexp nil t)
2034               (setq file-type (char-after (match-beginning 1))
2035                     symlink (eq file-type ?l)
2036                     ;; Only with -F we need to know whether it's an executable
2037                     executable (and
2038                                 used-F
2039                                 (string-match
2040                                  "[xst]" ;; execute bit set anywhere?
2041                                  (concat
2042                                   (match-string 2)
2043                                   (match-string 3)
2044                                   (match-string 4)))))
2045             (or no-error (error "No file on this line"))))
2046         ;; Move point to end of name:
2047         (if symlink
2048             (if (search-forward " -> " eol t)
2049                 (progn
2050                   (forward-char -4)
2051                   (and used-F
2052                        dired-ls-F-marks-symlinks
2053                        (eq (preceding-char) ?@) ;; did ls really mark the link?
2054                        (forward-char -1))))
2055           (goto-char eol) ;; else not a symbolic link
2056           ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2057           ;; one trailing character. (Executable bits on symlinks ain't mean
2058           ;; a thing, even to ls, but we know it's not a symlink.)
2059           (and used-F
2060                (or (memq file-type '(?d ?s ?p))
2061                    executable)
2062                (forward-char -1))))
2063       (or no-error
2064           (not (eq opoint (point)))
2065           (error "%s" (if hidden
2066                      (substitute-command-keys
2067                       "File line is hidden, type \\[dired-hide-subdir] to unhide")
2068                    "No file on this line")))
2069       (if (eq opoint (point))
2070           nil
2071         (point)))))
2072
2073 \f
2074 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2075
2076 (defun dired-copy-filename-as-kill (&optional arg)
2077   "Copy names of marked (or next ARG) files into the kill ring.
2078 The names are separated by a space.
2079 With a zero prefix arg, use the absolute file name of each marked file.
2080 With \\[universal-argument], use the file name relative to the dired buffer's
2081 `default-directory'.  (This still may contain slashes if in a subdirectory.)
2082
2083 If on a subdir headerline, use absolute subdirname instead;
2084 prefix arg and marked files are ignored in this case.
2085
2086 You can then feed the file name(s) to other commands with \\[yank]."
2087   (interactive "P")
2088   (let ((string
2089          (or (dired-get-subdir)
2090              (mapconcat (function identity)
2091                         (if arg
2092                             (cond ((zerop (prefix-numeric-value arg))
2093                                    (dired-get-marked-files))
2094                                   ((consp arg)
2095                                    (dired-get-marked-files t))
2096                                   (t
2097                                    (dired-get-marked-files
2098                                     'no-dir (prefix-numeric-value arg))))
2099                           (dired-get-marked-files 'no-dir))
2100                         " "))))
2101     (if (eq last-command 'kill-region)
2102         (kill-append string nil)
2103       (kill-new string))
2104     (message "%s" string)))
2105
2106 \f
2107 ;; Keeping Dired buffers in sync with the filesystem and with each other
2108
2109 (defun dired-buffers-for-dir (dir &optional file)
2110 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2111 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2112 ;; matches FILE.
2113 ;; The list is in reverse order of buffer creation, most recent last.
2114 ;; As a side effect, killed dired buffers for DIR are removed from
2115 ;; dired-buffers.
2116   (setq dir (file-name-as-directory dir))
2117   (let ((alist dired-buffers) result elt buf)
2118     (while alist
2119       (setq elt (car alist)
2120             buf (cdr elt))
2121       (if (buffer-name buf)
2122           (if (dired-in-this-tree dir (car elt))
2123               (with-current-buffer buf
2124                 (and (assoc dir dired-subdir-alist)
2125                      (or (null file)
2126                          (let ((wildcards
2127                                 (file-name-nondirectory dired-directory)))
2128                            (or (= 0 (length wildcards))
2129                                (string-match (dired-glob-regexp wildcards)
2130                                              file))))
2131                      (setq result (cons buf result)))))
2132         ;; else buffer is killed - clean up:
2133         (setq dired-buffers (delq elt dired-buffers)))
2134       (setq alist (cdr alist)))
2135     result))
2136
2137 (defun dired-glob-regexp (pattern)
2138   "Convert glob-pattern PATTERN to a regular expression."
2139   (let ((matched-in-pattern 0)  ;; How many chars of PATTERN we've handled.
2140         regexp)
2141     (while (string-match "[[?*]" pattern matched-in-pattern)
2142       (let ((op-end (match-end 0))
2143             (next-op (aref pattern (match-beginning 0))))
2144         (setq regexp (concat regexp
2145                              (regexp-quote
2146                               (substring pattern matched-in-pattern
2147                                          (match-beginning 0)))))
2148         (cond ((= next-op ??)
2149                (setq regexp (concat regexp "."))
2150                (setq matched-in-pattern op-end))
2151               ((= next-op ?\[)
2152                ;; Fails to handle ^ yet ????
2153                (let* ((set-start (match-beginning 0))
2154                       (set-cont
2155                        (if (= (aref pattern (1+ set-start)) ?^)
2156                            (+ 3 set-start)
2157                          (+ 2 set-start)))
2158                       (set-end (string-match "]" pattern set-cont))
2159                       (set (substring pattern set-start (1+ set-end))))
2160                  (setq regexp (concat regexp set))
2161                  (setq matched-in-pattern (1+ set-end))))
2162               ((= next-op ?*)
2163                (setq regexp (concat regexp ".*"))
2164                (setq matched-in-pattern op-end)))))
2165     (concat "\\`"
2166             regexp
2167             (regexp-quote
2168              (substring pattern matched-in-pattern))
2169             "\\'")))
2170
2171
2172
2173 (defun dired-advertise ()
2174   ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2175   ;; With wildcards we actually advertise too much.
2176   (let ((expanded-default (expand-file-name default-directory)))
2177     (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2178         t                               ; we have already advertised ourselves
2179       (setq dired-buffers
2180             (cons (cons expanded-default (current-buffer))
2181                   dired-buffers)))))
2182
2183 (defun dired-unadvertise (dir)
2184   ;; Remove DIR from the buffer alist in variable dired-buffers.
2185   ;; This has the effect of removing any buffer whose main directory is DIR.
2186   ;; It does not affect buffers in which DIR is a subdir.
2187   ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2188   (setq dired-buffers
2189         (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2190 \f
2191 ;; Tree Dired
2192
2193 ;;; utility functions
2194
2195 (defun dired-in-this-tree (file dir)
2196   ;;"Is FILE part of the directory tree starting at DIR?"
2197   (let (case-fold-search)
2198     (string-match (concat "^" (regexp-quote dir)) file)))
2199
2200 (defun dired-normalize-subdir (dir)
2201   ;; Prepend default-directory to DIR if relative file name.
2202   ;; dired-get-filename must be able to make a valid file name from a
2203   ;; file and its directory DIR.
2204   (file-name-as-directory
2205    (if (file-name-absolute-p dir)
2206        dir
2207      (expand-file-name dir default-directory))))
2208
2209 (defun dired-get-subdir ()
2210   ;;"Return the subdir name on this line, or nil if not on a headerline."
2211   ;; Look up in the alist whether this is a headerline.
2212   (save-excursion
2213     (let ((cur-dir (dired-current-directory)))
2214       (beginning-of-line)               ; alist stores b-o-l positions
2215       (and (zerop (- (point)
2216                      (dired-get-subdir-min (assoc cur-dir
2217                                                   dired-subdir-alist))))
2218            cur-dir))))
2219
2220 ;(defun dired-get-subdir-min (elt)
2221 ;  (cdr elt))
2222 ;; can't use macro,  must be redefinable for other alist format in dired-nstd.
2223 (defalias 'dired-get-subdir-min 'cdr)
2224
2225 (defun dired-get-subdir-max (elt)
2226   (save-excursion
2227     (goto-char (dired-get-subdir-min elt))
2228     (dired-subdir-max)))
2229
2230 (defun dired-clear-alist ()
2231   (while dired-subdir-alist
2232     (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2233     (setq dired-subdir-alist (cdr dired-subdir-alist))))
2234
2235 (defun dired-subdir-index (dir)
2236   ;; Return an index into alist for use with nth
2237   ;; for the sake of subdir moving commands.
2238   (let (found (index 0) (alist dired-subdir-alist))
2239     (while alist
2240       (if (string= dir (car (car alist)))
2241           (setq alist nil found t)
2242         (setq alist (cdr alist) index (1+ index))))
2243     (if found index nil)))
2244
2245 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2246   "Go to next subdirectory, regardless of level."
2247   ;; Use 0 arg to go to this directory's header line.
2248   ;; NO-SKIP prevents moving to end of header line, returning whatever
2249   ;; position was found in dired-subdir-alist.
2250   (interactive "p")
2251   (let ((this-dir (dired-current-directory))
2252         pos index)
2253     ;; nth with negative arg does not return nil but the first element
2254     (setq index (- (dired-subdir-index this-dir) arg))
2255     (setq pos (if (>= index 0)
2256                   (dired-get-subdir-min (nth index dired-subdir-alist))))
2257     (if pos
2258         (progn
2259           (goto-char pos)
2260           (or no-skip (skip-chars-forward "^\n\r"))
2261           (point))
2262       (if no-error-if-not-found
2263           nil                           ; return nil if not found
2264         (error "%s directory" (if (> arg 0) "Last" "First"))))))
2265
2266 (defun dired-build-subdir-alist (&optional switches)
2267   "Build `dired-subdir-alist' by parsing the buffer.
2268 Returns the new value of the alist.
2269 If optional arg SWITCHES is non-nil, use its value
2270 instead of `dired-actual-switches'."
2271   (interactive)
2272   (dired-clear-alist)
2273   (save-excursion
2274     (let* ((count 0)
2275            (buffer-read-only nil)
2276            (buffer-undo-list t)
2277            (switches (or switches dired-actual-switches))
2278            new-dir-name
2279            (R-ftp-base-dir-regex
2280             ;; Used to expand subdirectory names correctly in recursive
2281             ;; ange-ftp listings.
2282             (and (string-match "R" switches)
2283                  (string-match "\\`/.*:\\(/.*\\)" default-directory)
2284                  (concat "\\`" (match-string 1 default-directory)))))
2285       (goto-char (point-min))
2286       (setq dired-subdir-alist nil)
2287       (while (re-search-forward dired-subdir-regexp nil t)
2288         ;; Avoid taking a file name ending in a colon
2289         ;; as a subdir name.
2290         (unless (save-excursion
2291                   (goto-char (match-beginning 0))
2292                   (beginning-of-line)
2293                   (forward-char 2)
2294                   (save-match-data (looking-at dired-re-perms)))
2295           (save-excursion
2296             (goto-char (match-beginning 1))
2297             (setq new-dir-name
2298                   (buffer-substring-no-properties (point) (match-end 1))
2299                   new-dir-name
2300                   (save-match-data
2301                     (if (and R-ftp-base-dir-regex
2302                              (not (string= new-dir-name default-directory))
2303                              (string-match R-ftp-base-dir-regex new-dir-name))
2304                         (concat default-directory
2305                                 (substring new-dir-name (match-end 0)))
2306                       (expand-file-name new-dir-name))))
2307             (delete-region (point) (match-end 1))
2308             (insert new-dir-name))
2309           (setq count (1+ count))
2310           (dired-alist-add-1 new-dir-name
2311                              ;; Place a sub directory boundary between lines.
2312                              (save-excursion
2313                                (goto-char (match-beginning 0))
2314                                (beginning-of-line)
2315                                (point-marker)))))
2316       (if (and (> count 1) (interactive-p))
2317           (message "Buffer includes %d directories" count)))
2318     ;; We don't need to sort it because it is in buffer order per
2319     ;; constructionem.  Return new alist:
2320     dired-subdir-alist))
2321
2322 (defun dired-alist-add-1 (dir new-marker)
2323   ;; Add new DIR at NEW-MARKER.  Don't sort.
2324   (setq dired-subdir-alist
2325         (cons (cons (dired-normalize-subdir dir) new-marker)
2326               dired-subdir-alist)))
2327
2328 (defun dired-goto-next-nontrivial-file ()
2329   ;; Position point on first nontrivial file after point.
2330   (dired-goto-next-file);; so there is a file to compare with
2331   (if (stringp dired-trivial-filenames)
2332       (while (and (not (eobp))
2333                   (string-match dired-trivial-filenames
2334                                 (file-name-nondirectory
2335                                  (or (dired-get-filename nil t) ""))))
2336         (forward-line 1)
2337         (dired-move-to-filename))))
2338
2339 (defun dired-goto-next-file ()
2340   (let ((max (1- (dired-subdir-max))))
2341     (while (and (not (dired-move-to-filename)) (< (point) max))
2342       (forward-line 1))))
2343
2344 (defun dired-goto-file (file)
2345   "Go to line describing file FILE in this dired buffer."
2346   ;; Return value of point on success, else nil.
2347   ;; FILE must be an absolute file name.
2348   ;; Loses if FILE contains control chars like "\007" for which ls
2349   ;; either inserts "?" or "\\007" into the buffer, so we won't find
2350   ;; it in the buffer.
2351   (interactive
2352    (prog1                               ; let push-mark display its message
2353        (list (expand-file-name
2354               (read-file-name "Goto file: "
2355                               (dired-current-directory))))
2356      (push-mark)))
2357   (setq file (directory-file-name file)) ; does no harm if no directory
2358   (let (found case-fold-search dir)
2359     (setq dir (or (file-name-directory file)
2360                   (error "File name `%s' is not absolute" file)))
2361     (save-excursion
2362       ;; The hair here is to get the result of dired-goto-subdir
2363       ;; without really calling it if we don't have any subdirs.
2364       (if (if (string= dir (expand-file-name default-directory))
2365               (goto-char (point-min))
2366             (and (cdr dired-subdir-alist)
2367                  (dired-goto-subdir dir)))
2368           (let ((base (file-name-nondirectory file))
2369                 search-string
2370                 (boundary (dired-subdir-max)))
2371             (setq search-string
2372                   (replace-regexp-in-string "\^m" "\\^m" base nil t))
2373             (setq search-string
2374                   (replace-regexp-in-string "\\\\" "\\\\" search-string nil t))
2375             (while (and (not found)
2376                         ;; filenames are preceded by SPC, this makes
2377                         ;; the search faster (e.g. for the filename "-"!).
2378                         (search-forward (concat " " search-string)
2379                                         boundary 'move))
2380               ;; Match could have BASE just as initial substring or
2381               ;; or in permission bits or date or
2382               ;; not be a proper filename at all:
2383               (if (equal base (dired-get-filename 'no-dir t))
2384                     ;; Must move to filename since an (actually
2385                     ;; correct) match could have been elsewhere on the
2386                     ;; ;; line (e.g. "-" would match somewhere in the
2387                     ;; permission bits).
2388                   (setq found (dired-move-to-filename))
2389                 ;; If this isn't the right line, move forward to avoid
2390                 ;; trying this line again.
2391                 (forward-line 1))))))
2392     (and found
2393          ;; return value of point (i.e., FOUND):
2394          (goto-char found))))
2395
2396 (defun dired-initial-position (dirname)
2397   ;; Where point should go in a new listing of DIRNAME.
2398   ;; Point assumed at beginning of new subdir line.
2399   ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2400   (end-of-line)
2401   (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2402 \f
2403 ;; These are hooks which make tree dired work.
2404 ;; They are in this file because other parts of dired need to call them.
2405 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2406
2407 ;; This function is called for each retrieved filename.
2408 ;; It could stand to be faster, though it's mostly function call
2409 ;; overhead.  Avoiding the function call seems to save about 10% in
2410 ;; dired-get-filename.  Make it a defsubst?
2411 (defun dired-current-directory (&optional localp)
2412   "Return the name of the subdirectory to which this line belongs.
2413 This returns a string with trailing slash, like `default-directory'.
2414 Optional argument means return a file name relative to `default-directory'."
2415   (let ((here (point))
2416         (alist (or dired-subdir-alist
2417                    ;; probably because called in a non-dired buffer
2418                    (error "No subdir-alist in %s" (current-buffer))))
2419         elt dir)
2420     (while alist
2421       (setq elt (car alist)
2422             dir (car elt)
2423             ;; use `<=' (not `<') as subdir line is part of subdir
2424             alist (if (<= (dired-get-subdir-min elt) here)
2425                       nil               ; found
2426                     (cdr alist))))
2427     (if localp
2428         (dired-make-relative dir default-directory)
2429       dir)))
2430
2431 ;; Subdirs start at the beginning of their header lines and end just
2432 ;; before the beginning of the next header line (or end of buffer).
2433
2434 (defun dired-subdir-max ()
2435   (save-excursion
2436     (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2437         (point-max)
2438       (point))))
2439 \f
2440 ;; Deleting files
2441
2442 (defcustom dired-recursive-deletes 'top
2443   "*Decide whether recursive deletes are allowed.
2444 A value of nil means no recursive deletes.
2445 `always' means delete recursively without asking.  This is DANGEROUS!
2446 `top' means ask for each directory at top level, but delete its subdirectories
2447 without asking.
2448 Anything else means ask for each directory."
2449   :type '(choice :tag "Delete non-empty directories"
2450                  (const :tag "Yes" always)
2451                  (const :tag "No--only delete empty directories" nil)
2452                  (const :tag "Confirm for each directory" t)
2453                  (const :tag "Confirm for each top directory only" top))
2454   :group 'dired)
2455
2456 ;; Match anything but `.' and `..'.
2457 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2458
2459 ;; Delete file, possibly delete a directory and all its files.
2460 ;; This function is usefull outside of dired.  One could change it's name
2461 ;; to e.g. recursive-delete-file and put it somewhere else.
2462 (defun dired-delete-file (file &optional recursive) "\
2463 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2464 RECURSIVE determines what to do with a non-empty directory.  If RECURSIVE is:
2465 nil, do not delete.
2466 `always', delete recursively without asking.
2467 `top', ask for each directory at top level.
2468 Anything else, ask for each sub-directory."
2469   (let (files)
2470      ;; This test is equivalent to
2471      ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2472      ;; but more efficient
2473     (if (not (eq t (car (file-attributes file))))
2474         (delete-file file)
2475       (when (and recursive
2476                (setq files
2477                      (directory-files file t dired-re-no-dot)) ; Not empty.
2478                (or (eq recursive 'always)
2479                    (yes-or-no-p (format "Recursive delete of %s? "
2480                                         (dired-make-relative file)))))
2481         (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2482         (while files            ; Recursively delete (possibly asking).
2483             (dired-delete-file (car files) recursive)
2484             (setq files (cdr files))))
2485       (delete-directory file))))
2486
2487 (defun dired-do-flagged-delete (&optional nomessage)
2488   "In Dired, delete the files flagged for deletion.
2489 If NOMESSAGE is non-nil, we don't display any message
2490 if there are no flagged files.
2491 `dired-recursive-deletes' controls whether deletion of
2492 non-empty directories is allowed."
2493   (interactive)
2494   (let* ((dired-marker-char dired-del-marker)
2495          (regexp (dired-marker-regexp))
2496          case-fold-search)
2497     (if (save-excursion (goto-char (point-min))
2498                         (re-search-forward regexp nil t))
2499         (dired-internal-do-deletions
2500          ;; this can't move point since ARG is nil
2501          (dired-map-over-marks (cons (dired-get-filename) (point))
2502                                nil)
2503          nil)
2504       (or nomessage
2505           (message "(No deletions requested)")))))
2506
2507 (defun dired-do-delete (&optional arg)
2508   "Delete all marked (or next ARG) files.
2509 `dired-recursive-deletes' controls whether deletion of
2510 non-empty directories is allowed."
2511   ;; This is more consistent with the file marking feature than
2512   ;; dired-do-flagged-delete.
2513   (interactive "P")
2514   (dired-internal-do-deletions
2515    ;; this may move point if ARG is an integer
2516    (dired-map-over-marks (cons (dired-get-filename) (point))
2517                          arg)
2518    arg))
2519
2520 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2521
2522 (defun dired-internal-do-deletions (l arg)
2523   ;; L is an alist of files to delete, with their buffer positions.
2524   ;; ARG is the prefix arg.
2525   ;; Filenames are absolute (VMS needs this for logical search paths).
2526   ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2527   ;; That way as changes are made in the buffer they do not shift the
2528   ;; lines still to be changed, so the (point) values in L stay valid.
2529   ;; Also, for subdirs in natural order, a subdir's files are deleted
2530   ;; before the subdir itself - the other way around would not work.
2531   (let ((files (mapcar (function car) l))
2532         (count (length l))
2533         (succ 0))
2534     ;; canonicalize file list for pop up
2535     (setq files (nreverse (mapcar (function dired-make-relative) files)))
2536     (if (dired-mark-pop-up
2537          " *Deletions*" 'delete files dired-deletion-confirmer
2538          (format "Delete %s " (dired-mark-prompt arg files)))
2539         (save-excursion
2540           (let (failures);; files better be in reverse order for this loop!
2541             (while l
2542               (goto-char (cdr (car l)))
2543               (let (buffer-read-only)
2544                 (condition-case err
2545                     (let ((fn (car (car l))))
2546                       (dired-delete-file fn dired-recursive-deletes)
2547                       ;; if we get here, removing worked
2548                       (setq succ (1+ succ))
2549                       (message "%s of %s deletions" succ count)
2550                       (dired-fun-in-all-buffers
2551                        (file-name-directory fn) (file-name-nondirectory fn)
2552                        (function dired-delete-entry) fn))
2553                   (error;; catch errors from failed deletions
2554                    (dired-log "%s\n" err)
2555                    (setq failures (cons (car (car l)) failures)))))
2556               (setq l (cdr l)))
2557             (if (not failures)
2558                 (message "%d deletion%s done" count (dired-plural-s count))
2559               (dired-log-summary
2560                (format "%d of %d deletion%s failed"
2561                        (length failures) count
2562                        (dired-plural-s count))
2563                failures))))
2564       (message "(No deletions performed)")))
2565   (dired-move-to-filename))
2566
2567 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2568   ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2569   ;; If the buffer has a wildcard pattern, check that it matches FILE.
2570   ;; (FILE does not include a directory component.)
2571   ;; FILE may be nil, in which case ignore it.
2572   ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2573   (let (success-list)
2574     (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2575                                         file))
2576       (with-current-buffer buf
2577         (if (apply fun args)
2578             (setq success-list (cons (buffer-name buf) success-list)))))
2579     success-list))
2580
2581 ;; Delete the entry for FILE from
2582 (defun dired-delete-entry (file)
2583   (save-excursion
2584     (and (dired-goto-file file)
2585          (let (buffer-read-only)
2586            (delete-region (progn (beginning-of-line) (point))
2587                           (save-excursion (forward-line 1) (point))))))
2588   (dired-clean-up-after-deletion file))
2589
2590 ;; This is a separate function for the sake of dired-x.el.
2591 (defun dired-clean-up-after-deletion (fn)
2592   ;; Clean up after a deleted file or directory FN.
2593   (save-excursion (and (cdr dired-subdir-alist)
2594                        (dired-goto-subdir fn)
2595                        (dired-kill-subdir))))
2596 \f
2597 ;; Confirmation
2598
2599 (defun dired-marker-regexp ()
2600   (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2601
2602 (defun dired-plural-s (count)
2603   (if (= 1 count) "" "s"))
2604
2605 (defun dired-mark-prompt (arg files)
2606   "Return a string for use in a prompt, either the current file
2607 name, or the marker and a count of marked files."
2608   ;; distinguish-one-marked can cause the first element to be just t.
2609   (if (eq (car files) t) (setq files (cdr files)))
2610   (let ((count (length files)))
2611     (if (= count 1)
2612         (car files)
2613       ;; more than 1 file:
2614       (if (integerp arg)
2615           ;; abs(arg) = count
2616           ;; Perhaps this is nicer, but it also takes more screen space:
2617           ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2618           ;;                        count)
2619           (format "[next %d files]" arg)
2620         (format "%c [%d files]" dired-marker-char count)))))
2621
2622 (defun dired-pop-to-buffer (buf)
2623   ;; Pop up buffer BUF.
2624   ;; If dired-shrink-to-fit is t, make its window fit its contents.
2625   (if (not dired-shrink-to-fit)
2626       (pop-to-buffer (get-buffer-create buf))
2627     ;; let window shrink to fit:
2628     (let ((window (selected-window))
2629           target-lines w2)
2630       (cond ;; if split-height-threshold is enabled, use the largest window
2631             ((and (> (window-height (setq w2 (get-largest-window)))
2632                      split-height-threshold)
2633                   (window-full-width-p w2))
2634              (setq window w2))
2635             ;; if the least-recently-used window is big enough, use it
2636             ((and (> (window-height (setq w2 (get-lru-window)))
2637                      (* 2 window-min-height))
2638                   (window-full-width-p w2))
2639              (setq window w2)))
2640       (save-excursion
2641         (set-buffer buf)
2642         (goto-char (point-max))
2643         (skip-chars-backward "\n\r\t ")
2644         (setq target-lines (count-lines (point-min) (point)))
2645         ;; Don't forget to count the last line.
2646         (if (not (bolp))
2647             (setq target-lines (1+ target-lines))))
2648       (if (<= (window-height window) (* 2 window-min-height))
2649           ;; At this point, every window on the frame is too small to split.
2650           (setq w2 (display-buffer buf))
2651         (setq w2 (split-window window
2652                   (max window-min-height
2653                        (- (window-height window)
2654                           (1+ (max window-min-height target-lines)))))))
2655       (set-window-buffer w2 buf)
2656       (if (< (1- (window-height w2)) target-lines)
2657           (progn
2658             (select-window w2)
2659             (enlarge-window (- target-lines (1- (window-height w2))))))
2660       (set-window-start w2 1)
2661       )))
2662
2663 (defcustom dired-no-confirm nil
2664   "A list of symbols for commands Dired should not confirm.
2665 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2666 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2667 `touch' and `uncompress'."
2668   :group 'dired
2669   :type '(set (const byte-compile) (const chgrp)
2670               (const chmod) (const chown) (const compress)
2671               (const copy) (const delete) (const hardlink)
2672               (const load) (const move) (const print)
2673               (const shell) (const symlink) (const touch)
2674               (const uncompress)))
2675
2676 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2677   "Return FUNCTION's result on ARGS after showing which files are marked.
2678 Displays the file names in a buffer named BUFNAME;
2679  nil gives \" *Marked Files*\".
2680 This uses function `dired-pop-to-buffer' to do that.
2681
2682 FUNCTION should not manipulate files, just read input
2683  (an argument or confirmation).
2684 The window is not shown if there is just one file or
2685  OP-SYMBOL is a member of the list in `dired-no-confirm'.
2686 FILES is the list of marked files.  It can also be (t FILENAME)
2687 in the case of one marked file, to distinguish that from using
2688 just the current file."
2689   (or bufname (setq bufname  " *Marked Files*"))
2690   (if (or (eq dired-no-confirm t)
2691           (memq op-symbol dired-no-confirm)
2692           ;; If FILES defaulted to the current line's file.
2693           (= (length files) 1))
2694       (apply function args)
2695     (with-current-buffer (get-buffer-create bufname)
2696       (erase-buffer)
2697       ;; Handle (t FILE) just like (FILE), here.
2698       ;; That value is used (only in some cases), to mean
2699       ;; just one file that was marked, rather than the current line file.
2700       (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2701       (remove-text-properties (point-min) (point-max)
2702                               '(mouse-face nil help-echo nil)))
2703     (save-window-excursion
2704       (dired-pop-to-buffer bufname)
2705       (apply function args))))
2706
2707 (defun dired-format-columns-of-files (files)
2708   ;; Files should be in forward order for this loop.
2709   ;; i.e., (car files) = first file in buffer.
2710   ;; Returns the number of lines used.
2711   (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2712          (width (- (window-width (selected-window)) 2))
2713          (columns (max 1 (/ width maxlen)))
2714          (nfiles (length files))
2715          (rows (+ (/ nfiles columns)
2716                   (if (zerop (% nfiles columns)) 0 1)))
2717          (i 0)
2718          (j 0))
2719     (setq files (nconc (copy-sequence files) ; fill up with empty fns
2720                        (make-list (- (* columns rows) nfiles) "")))
2721     (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2722     (while (< j rows)
2723       (while (< i columns)
2724         (indent-to (* i maxlen))
2725         (insert (car files))
2726         (setq files (nthcdr rows files)
2727               i (1+ i)))
2728       (insert "\n")
2729       (setq i 0
2730             j (1+ j)
2731             files (cdr files)))
2732     rows))
2733 \f
2734 ;; Commands to mark or flag file(s) at or near current line.
2735
2736 (defun dired-repeat-over-lines (arg function)
2737   ;; This version skips non-file lines.
2738   (let ((pos (make-marker)))
2739     (beginning-of-line)
2740     (while (and (> arg 0) (not (eobp)))
2741       (setq arg (1- arg))
2742       (beginning-of-line)
2743       (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2744       (save-excursion
2745         (forward-line 1)
2746         (move-marker pos (1+ (point))))
2747       (save-excursion (funcall function))
2748       ;; Advance to the next line--actually, to the line that *was* next.
2749       ;; (If FUNCTION inserted some new lines in between, skip them.)
2750       (goto-char pos))
2751     (while (and (< arg 0) (not (bobp)))
2752       (setq arg (1+ arg))
2753       (forward-line -1)
2754       (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2755       (beginning-of-line)
2756       (save-excursion (funcall function)))
2757     (move-marker pos nil)
2758     (dired-move-to-filename)))
2759
2760 (defun dired-between-files ()
2761   ;; This used to be a regexp match of the `total ...' line output by
2762   ;; ls, which is slightly faster, but that is not very robust; notably,
2763   ;; it fails for non-english locales.
2764   (save-excursion (not (dired-move-to-filename))))
2765
2766 (defun dired-next-marked-file (arg &optional wrap opoint)
2767   "Move to the next marked file, wrapping around the end of the buffer."
2768   (interactive "p\np")
2769   (or opoint (setq opoint (point)));; return to where interactively started
2770   (if (if (> arg 0)
2771           (re-search-forward dired-re-mark nil t arg)
2772         (beginning-of-line)
2773         (re-search-backward dired-re-mark nil t (- arg)))
2774       (dired-move-to-filename)
2775     (if (null wrap)
2776         (progn
2777           (goto-char opoint)
2778           (error "No next marked file"))
2779       (message "(Wraparound for next marked file)")
2780       (goto-char (if (> arg 0) (point-min) (point-max)))
2781       (dired-next-marked-file arg nil opoint))))
2782
2783 (defun dired-prev-marked-file (arg &optional wrap)
2784   "Move to the previous marked file, wrapping around the end of the buffer."
2785   (interactive "p\np")
2786   (dired-next-marked-file (- arg) wrap))
2787
2788 (defun dired-file-marker (file)
2789   ;; Return FILE's marker, or nil if unmarked.
2790   (save-excursion
2791     (and (dired-goto-file file)
2792          (progn
2793            (beginning-of-line)
2794            (if (not (equal ?\040 (following-char)))
2795                (following-char))))))
2796
2797 (defun dired-mark-files-in-region (start end)
2798   (let (buffer-read-only)
2799     (if (> start end)
2800         (error "start > end"))
2801     (goto-char start)                   ; assumed at beginning of line
2802     (while (< (point) end)
2803       ;; Skip subdir line and following garbage like the `total' line:
2804       (while (and (< (point) end) (dired-between-files))
2805         (forward-line 1))
2806       (if (and (not (looking-at dired-re-dot))
2807                (dired-get-filename nil t))
2808           (progn
2809             (delete-char 1)
2810             (insert dired-marker-char)))
2811       (forward-line 1))))
2812
2813 (defun dired-mark (arg)
2814   "Mark the current (or next ARG) files.
2815 If on a subdir headerline, mark all its files except `.' and `..'.
2816
2817 Use \\[dired-unmark-all-files] to remove all marks
2818 and \\[dired-unmark] on a subdir to remove the marks in
2819 this subdir."
2820   (interactive "P")
2821   (if (dired-get-subdir)
2822       (save-excursion (dired-mark-subdir-files))
2823     (let (buffer-read-only)
2824       (dired-repeat-over-lines
2825        (prefix-numeric-value arg)
2826        (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2827
2828 (defun dired-unmark (arg)
2829   "Unmark the current (or next ARG) files.
2830 If looking at a subdir, unmark all its files except `.' and `..'."
2831   (interactive "P")
2832   (let ((dired-marker-char ?\040))
2833     (dired-mark arg)))
2834
2835 (defun dired-flag-file-deletion (arg)
2836   "In Dired, flag the current line's file for deletion.
2837 With prefix arg, repeat over several lines.
2838
2839 If on a subdir headerline, mark all its files except `.' and `..'."
2840   (interactive "P")
2841   (let ((dired-marker-char dired-del-marker))
2842     (dired-mark arg)))
2843
2844 (defun dired-unmark-backward (arg)
2845   "In Dired, move up lines and remove deletion flag there.
2846 Optional prefix ARG says how many lines to unflag; default is one line."
2847   (interactive "p")
2848   (dired-unmark (- arg)))
2849
2850 (defun dired-toggle-marks ()
2851   "Toggle marks: marked files become unmarked, and vice versa.
2852 Files marked with other flags (such as `D') are not affected.
2853 `.' and `..' are never toggled.
2854 As always, hidden subdirs are not affected."
2855   (interactive)
2856   (save-excursion
2857     (goto-char (point-min))
2858     (let (buffer-read-only)
2859       (while (not (eobp))
2860         (or (dired-between-files)
2861             (looking-at dired-re-dot)
2862             ;; use subst instead of insdel because it does not move
2863             ;; the gap and thus should be faster and because
2864             ;; other characters are left alone automatically
2865             (apply 'subst-char-in-region
2866                    (point) (1+ (point))
2867                    (if (eq ?\040 (following-char)) ; SPC
2868                        (list ?\040 dired-marker-char)
2869                      (list dired-marker-char ?\040))))
2870         (forward-line 1)))))
2871 \f
2872 ;;; Commands to mark or flag files based on their characteristics or names.
2873
2874 (defvar dired-regexp-history nil
2875   "History list of regular expressions used in Dired commands.")
2876
2877 (defun dired-read-regexp (prompt)
2878   (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2879
2880 (defun dired-mark-files-regexp (regexp &optional marker-char)
2881   "Mark all files matching REGEXP for use in later commands.
2882 A prefix argument means to unmark them instead.
2883 `.' and `..' are never marked.
2884
2885 REGEXP is an Emacs regexp, not a shell wildcard.  Thus, use `\\.o$' for
2886 object files--just `.o' will mark more than you might think."
2887   (interactive
2888    (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2889                                     " files (regexp): "))
2890          (if current-prefix-arg ?\040)))
2891   (let ((dired-marker-char (or marker-char dired-marker-char)))
2892     (dired-mark-if
2893      (and (not (looking-at dired-re-dot))
2894           (not (eolp))                  ; empty line
2895           (let ((fn (dired-get-filename nil t)))
2896             (and fn (string-match regexp (file-name-nondirectory fn)))))
2897      "matching file")))
2898
2899 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2900   "Mark all files with contents containing REGEXP for use in later commands.
2901 A prefix argument means to unmark them instead.
2902 `.' and `..' are never marked."
2903   (interactive
2904    (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2905                                     " files containing (regexp): "))
2906          (if current-prefix-arg ?\040)))
2907   (let ((dired-marker-char (or marker-char dired-marker-char)))
2908     (dired-mark-if
2909      (and (not (looking-at dired-re-dot))
2910           (not (eolp))                  ; empty line
2911           (let ((fn (dired-get-filename nil t)))
2912             (when (and fn (file-readable-p fn)
2913                        (not (file-directory-p fn)))
2914               (let ((prebuf (get-file-buffer fn)))
2915                 (message "Checking %s" fn)
2916                 ;; For now we do it inside emacs
2917                 ;; Grep might be better if there are a lot of files
2918                 (if prebuf
2919                     (with-current-buffer prebuf
2920                       (save-excursion
2921                         (goto-char (point-min))
2922                         (re-search-forward regexp nil t)))
2923                   (with-temp-buffer
2924                     (insert-file-contents fn)
2925                     (goto-char (point-min))
2926                     (re-search-forward regexp nil t))))
2927                       )))
2928      "matching file")))
2929
2930 (defun dired-flag-files-regexp (regexp)
2931   "In Dired, flag all files containing the specified REGEXP for deletion.
2932 The match is against the non-directory part of the filename.  Use `^'
2933   and `$' to anchor matches.  Exclude subdirs by hiding them.
2934 `.' and `..' are never flagged."
2935   (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2936   (dired-mark-files-regexp regexp dired-del-marker))
2937
2938 (defun dired-mark-symlinks (unflag-p)
2939   "Mark all symbolic links.
2940 With prefix argument, unflag all those files."
2941   (interactive "P")
2942   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2943     (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2944
2945 (defun dired-mark-directories (unflag-p)
2946   "Mark all directory file lines except `.' and `..'.
2947 With prefix argument, unflag all those files."
2948   (interactive "P")
2949   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2950     (dired-mark-if (and (looking-at dired-re-dir)
2951                         (not (looking-at dired-re-dot)))
2952                    "directory file")))
2953
2954 (defun dired-mark-executables (unflag-p)
2955   "Mark all executable files.
2956 With prefix argument, unflag all those files."
2957   (interactive "P")
2958   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
2959     (dired-mark-if (looking-at dired-re-exe) "executable file")))
2960
2961 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2962 ;; files for which PREDICATE returns non-nil.
2963
2964 (defun dired-flag-auto-save-files (&optional unflag-p)
2965   "Flag for deletion files whose names suggest they are auto save files.
2966 A prefix argument says to unflag those files instead."
2967   (interactive "P")
2968   (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
2969     (dired-mark-if
2970      ;; It is less than general to check for # here,
2971      ;; but it's the only way this runs fast enough.
2972      (and (save-excursion (end-of-line)
2973                           (or
2974                            (eq (preceding-char) ?#)
2975                            ;; Handle executables in case of -F option.
2976                            ;; We need not worry about the other kinds
2977                            ;; of markings that -F makes, since they won't
2978                            ;; appear on real auto-save files.
2979                            (if (eq (preceding-char) ?*)
2980                                (progn
2981                                  (forward-char -1)
2982                                  (eq (preceding-char) ?#)))))
2983           (not (looking-at dired-re-dir))
2984           (let ((fn (dired-get-filename t t)))
2985             (if fn (auto-save-file-name-p
2986                     (file-name-nondirectory fn)))))
2987      "auto save file")))
2988
2989 (defcustom dired-garbage-files-regexp
2990   ;; `log' here is dubious, since it's typically used for useful log
2991   ;; files, not just TeX stuff.  -- fx
2992   (concat (regexp-opt
2993            '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2994           "\\'")
2995   "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
2996   :type 'regexp
2997   :group 'dired)
2998
2999 (defun dired-flag-garbage-files ()
3000   "Flag for deletion all files that match `dired-garbage-files-regexp'."
3001   (interactive)
3002   (dired-flag-files-regexp dired-garbage-files-regexp))
3003
3004 (defun dired-flag-backup-files (&optional unflag-p)
3005   "Flag all backup files (names ending with `~') for deletion.
3006 With prefix argument, unflag these files."
3007   (interactive "P")
3008   (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
3009     (dired-mark-if
3010      ;; Don't call backup-file-name-p unless the last character looks like
3011      ;; it might be the end of a backup file name.  This isn't very general,
3012      ;; but it's the only way this runs fast enough.
3013      (and (save-excursion (end-of-line)
3014                           ;; Handle executables in case of -F option.
3015                           ;; We need not worry about the other kinds
3016                           ;; of markings that -F makes, since they won't
3017                           ;; appear on real backup files.
3018                           (if (eq (preceding-char) ?*)
3019                               (forward-char -1))
3020                           (eq (preceding-char) ?~))
3021           (not (looking-at dired-re-dir))
3022           (let ((fn (dired-get-filename t t)))
3023             (if fn (backup-file-name-p fn))))
3024      "backup file")))
3025
3026 (defun dired-change-marks (&optional old new)
3027   "Change all OLD marks to NEW marks.
3028 OLD and NEW are both characters used to mark files."
3029   (interactive
3030    (let* ((cursor-in-echo-area t)
3031           (old (progn (message "Change (old mark): ") (read-char)))
3032           (new (progn (message  "Change %c marks to (new mark): " old)
3033                       (read-char))))
3034      (list old new)))
3035   (if (or (eq old ?\r) (eq new ?\r))
3036       (ding)
3037     (let ((string (format "\n%c" old))
3038           (buffer-read-only))
3039       (save-excursion
3040         (goto-char (point-min))
3041         (while (search-forward string nil t)
3042           (if (if (= old ?\s)
3043                   (save-match-data
3044                     (dired-get-filename 'no-dir t))
3045                 t)
3046               (subst-char-in-region (match-beginning 0)
3047                                     (match-end 0) old new)))))))
3048
3049 (defun dired-unmark-all-marks ()
3050   "Remove all marks from all files in the dired buffer."
3051   (interactive)
3052   (dired-unmark-all-files ?\r))
3053
3054 (defun dired-unmark-all-files (mark &optional arg)
3055   "Remove a specific mark (or any mark) from every file.
3056 After this command, type the mark character to remove,
3057 or type RET to remove all marks.
3058 With prefix arg, query for each marked file.
3059 Type \\[help-command] at that time for help."
3060   (interactive "cRemove marks (RET means all): \nP")
3061   (save-excursion
3062     (let* ((count 0)
3063            buffer-read-only case-fold-search query
3064            (string (format "\n%c" mark))
3065            (help-form "\
3066 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3067 `!' to unmark all remaining files with no more questions."))
3068       (goto-char (point-min))
3069       (while (if (eq mark ?\r)
3070                  (re-search-forward dired-re-mark nil t)
3071                (search-forward string nil t))
3072         (if (or (not arg)
3073                 (let ((file (dired-get-filename t t)))
3074                   (and file
3075                        (dired-query 'query "Unmark file `%s'? "
3076                                     file))))
3077             (progn (subst-char-in-region (1- (point)) (point)
3078                                          (preceding-char) ?\s)
3079                    (setq count (1+ count)))))
3080       (message (if (= count 1) "1 mark removed"
3081                  "%d marks removed")
3082                count))))
3083 \f
3084 ;; Logging failures operating on files, and showing the results.
3085
3086 (defvar dired-log-buffer "*Dired log*")
3087
3088 (defun dired-why ()
3089   "Pop up a buffer with error log output from Dired.
3090 A group of errors from a single command ends with a formfeed.
3091 Thus, use \\[backward-page] to find the beginning of a group of errors."
3092   (interactive)
3093   (if (get-buffer dired-log-buffer)
3094       (let ((owindow (selected-window))
3095             (window (display-buffer (get-buffer dired-log-buffer))))
3096         (unwind-protect
3097             (progn
3098               (select-window window)
3099               (goto-char (point-max))
3100               (forward-line -1)
3101               (backward-page 1)
3102               (recenter 0))
3103           (select-window owindow)))))
3104
3105 (defun dired-log (log &rest args)
3106   ;; Log a message or the contents of a buffer.
3107   ;; If LOG is a string and there are more args, it is formatted with
3108   ;; those ARGS.  Usually the LOG string ends with a \n.
3109   ;; End each bunch of errors with (dired-log t):
3110   ;; this inserts the current time and buffer at the start of the page,
3111   ;; and \f (formfeed) at the end.
3112   (let ((obuf (current-buffer)))
3113     (with-current-buffer (get-buffer-create dired-log-buffer)
3114       (goto-char (point-max))
3115       (let ((inhibit-read-only t))
3116         (cond ((stringp log)
3117                (insert (if args
3118                            (apply (function format) log args)
3119                          log)))
3120               ((bufferp log)
3121                (insert-buffer-substring log))
3122               ((eq t log)
3123                (backward-page 1)
3124                (unless (bolp)
3125                  (insert "\n"))
3126                (insert (current-time-string)
3127                        "\tBuffer `" (buffer-name obuf) "'\n")
3128                (goto-char (point-max))
3129                (insert "\f\n")))))))
3130
3131 (defun dired-log-summary (string failures)
3132   "State a summary of a command's failures, in echo area and log buffer.
3133 STRING is an overall summary of the failures.
3134 FAILURES is a list of file names that we failed to operate on,
3135 or nil if file names are not applicable."
3136   (if (= (length failures) 1)
3137       (message "%s"
3138                (with-current-buffer dired-log-buffer
3139                  (goto-char (point-max))
3140                  (backward-page 1)
3141                  (if (eolp) (forward-line 1))
3142                  (buffer-substring (point) (point-max))))
3143     (message (if failures "%s--type ? for details (%s)"
3144                "%s--type ? for details")
3145              string failures))
3146   ;; Log a summary describing a bunch of errors.
3147   (dired-log (concat "\n" string "\n"))
3148   (dired-log t))
3149 \f
3150 ;;; Sorting
3151
3152 ;; Most ls can only sort by name or by date (with -t), nothing else.
3153 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3154 ;; So anything that does not contain these is sort "by name".
3155
3156 (defvar dired-ls-sorting-switches "SXU"
3157   "String of `ls' switches \(single letters\) except \"t\" that influence sorting.
3158
3159 This indicates to Dired which option switches to watch out for because they
3160 will change the sorting order behavior of `ls'.
3161
3162 To change the default sorting order \(e.g. add a `-v' option\), see the
3163 variable `dired-listing-switches'.  To temporarily override the listing
3164 format, use `\\[universal-argument] \\[dired]'.")
3165
3166 (defvar dired-sort-by-date-regexp
3167   (concat "^-[^" dired-ls-sorting-switches
3168           "]*t[^" dired-ls-sorting-switches "]*$")
3169   "Regexp recognized by Dired to set `by date' mode.")
3170
3171 (defvar dired-sort-by-name-regexp
3172   (concat "^-[^t" dired-ls-sorting-switches "]+$")
3173   "Regexp recognized by Dired to set `by name' mode.")
3174
3175 (defvar dired-sort-inhibit nil
3176   "Non-nil means the Dired sort command is disabled.
3177 The idea is to set this buffer-locally in special dired buffers.")
3178
3179 (defun dired-sort-set-modeline ()
3180   ;; Set modeline display according to dired-actual-switches.
3181   ;; Modeline display of "by name" or "by date" guarantees the user a
3182   ;; match with the corresponding regexps.  Non-matching switches are
3183   ;; shown literally.
3184   (when (eq major-mode 'dired-mode)
3185     (setq mode-name
3186           (let (case-fold-search)
3187             (cond ((string-match
3188                     dired-sort-by-name-regexp dired-actual-switches)
3189                    "Dired by name")
3190                   ((string-match
3191                     dired-sort-by-date-regexp dired-actual-switches)
3192                    "Dired by date")
3193                   (t
3194                    (concat "Dired " dired-actual-switches)))))
3195     (force-mode-line-update)))
3196
3197 (defun dired-sort-toggle-or-edit (&optional arg)
3198   "Toggle between sort by date/name and refresh the dired buffer.
3199 With a prefix argument you can edit the current listing switches instead."
3200   (interactive "P")
3201   (when dired-sort-inhibit
3202     (error "Cannot sort this dired buffer"))
3203   (if arg
3204       (dired-sort-other
3205        (read-string "ls switches (must contain -l): " dired-actual-switches))
3206     (dired-sort-toggle)))
3207
3208 (defun dired-sort-toggle ()
3209   ;; Toggle between sort by date/name.  Reverts the buffer.
3210   (setq dired-actual-switches
3211         (let (case-fold-search)
3212           (if (string-match " " dired-actual-switches)
3213               ;; New toggle scheme: add/remove a trailing " -t"
3214               (if (string-match " -t\\'" dired-actual-switches)
3215                   (substring dired-actual-switches 0 (match-beginning 0))
3216                 (concat dired-actual-switches " -t"))
3217             ;; old toggle scheme: look for some 't' switch and add/remove it
3218             (concat
3219              "-l"
3220              (dired-replace-in-string (concat "[-lt"
3221                                               dired-ls-sorting-switches "]")
3222                                       ""
3223                                       dired-actual-switches)
3224              (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3225                                dired-actual-switches)
3226                  ""
3227                "t")))))
3228   (dired-sort-set-modeline)
3229   (revert-buffer))
3230
3231 ;; Some user code loads dired especially for this.
3232 ;; Don't do that--use replace-regexp-in-string instead.
3233 (defun dired-replace-in-string (regexp newtext string)
3234   ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3235   ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3236   (let ((result "") (start 0) mb me)
3237     (while (string-match regexp string start)
3238       (setq mb (match-beginning 0)
3239             me (match-end 0)
3240             result (concat result (substring string start mb) newtext)
3241             start me))
3242     (concat result (substring string start))))
3243
3244 (defun dired-sort-other (switches &optional no-revert)
3245   "Specify new `ls' SWITCHES for current dired buffer.
3246 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3247 set the minor mode accordingly, others appear literally in the mode line.
3248 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3249   (dired-sort-R-check switches)
3250   (setq dired-actual-switches switches)
3251   (dired-sort-set-modeline)
3252   (or no-revert (revert-buffer)))
3253
3254 (defvar dired-subdir-alist-pre-R nil
3255   "Value of `dired-subdir-alist' before -R switch added.")
3256 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3257
3258 (defun dired-sort-R-check (switches)
3259   "Additional processing of -R in ls option string SWITCHES.
3260 Saves `dired-subdir-alist' when R is set and restores saved value
3261 minus any directories explicitly deleted when R is cleared.
3262 To be called first in body of `dired-sort-other', etc."
3263   (cond
3264    ((and (string-match "R" switches)
3265          (not (string-match "R" dired-actual-switches)))
3266     ;; Adding -R to ls switches -- save `dired-subdir-alist':
3267     (setq dired-subdir-alist-pre-R dired-subdir-alist))
3268    ((and (string-match "R" dired-actual-switches)
3269          (not (string-match "R" switches)))
3270     ;; Deleting -R from ls switches -- revert to pre-R subdirs
3271     ;; that are still present:
3272     (setq dired-subdir-alist
3273           (if dired-subdir-alist-pre-R
3274               (let (subdirs)
3275                 (while dired-subdir-alist-pre-R
3276                   (if (assoc (caar dired-subdir-alist-pre-R)
3277                              dired-subdir-alist)
3278                       ;; subdir still present...
3279                       (setq subdirs
3280                             (cons (car dired-subdir-alist-pre-R)
3281                                   subdirs)))
3282                   (setq dired-subdir-alist-pre-R
3283                         (cdr dired-subdir-alist-pre-R)))
3284                 (reverse subdirs))
3285             ;; No pre-R subdir alist, so revert to main directory
3286             ;; listing:
3287             (list (car (reverse dired-subdir-alist))))))))
3288 \f
3289
3290 ;;;;  Drag and drop support
3291
3292 (defcustom dired-recursive-copies 'top
3293   "*Decide whether recursive copies are allowed.
3294 A value of nil means no recursive copies.
3295 `always' means copy recursively without asking.
3296 `top' means ask for each directory at top level.
3297 Anything else means ask for each directory."
3298   :type '(choice :tag "Copy directories"
3299                  (const :tag "No recursive copies" nil)
3300                  (const :tag "Ask for each directory" t)
3301                  (const :tag "Ask for each top directory only" top)
3302                  (const :tag "Copy directories without asking" always))
3303   :group 'dired)
3304
3305 (defun dired-dnd-popup-notice ()
3306   (message-box
3307    "Dired recursive copies are currently disabled.\nSee the variable `dired-recursive-copies'."))
3308
3309
3310 (defun dired-dnd-do-ask-action (uri)
3311   ;; No need to get actions and descriptions from the source,
3312   ;; we only have three actions anyway.
3313   (let ((action (x-popup-menu
3314                  t
3315                  (list "What action?"
3316                        (cons ""
3317                              '(("Copy here" . copy)
3318                                ("Move here" . move)
3319                                ("Link here" . link)
3320                                "--"
3321                                ("Cancel" . nil)))))))
3322     (if action
3323         (dired-dnd-handle-local-file uri action)
3324       nil)))
3325
3326 (declare-function dired-relist-entry "dired-aux" (file))
3327 (declare-function make-symbolic-link "fileio.c")
3328
3329 (defun dired-dnd-handle-local-file (uri action)
3330   "Copy, move or link a file to the dired directory.
3331 URI is the file to handle, ACTION is one of copy, move, link or ask.
3332 Ask means pop up a menu for the user to select one of copy, move or link."
3333   (require 'dired-aux)
3334   (let* ((from (dnd-get-local-file-name uri t))
3335          (to (when from
3336                (concat (dired-current-directory)
3337                        (file-name-nondirectory from)))))
3338     (when from
3339       (cond ((eq action 'ask)
3340              (dired-dnd-do-ask-action uri))
3341             ;; If copying a directory and dired-recursive-copies is
3342             ;; nil, dired-copy-file fails.  Pop up a notice.
3343             ((and (memq action '(copy private))
3344                   (file-directory-p from)
3345                   (not dired-recursive-copies))
3346              (dired-dnd-popup-notice))
3347             ((memq action '(copy private move link))
3348              (let ((overwrite (and (file-exists-p to)
3349                                    (y-or-n-p
3350                                     (format "Overwrite existing file `%s'? " to))))
3351                    ;; Binding dired-overwrite-confirmed to nil makes
3352                    ;; dired-handle-overwrite a no-op.  We instead use
3353                    ;; y-or-n-p, which pops a graphical menu.
3354                    dired-overwrite-confirmed backup-file)
3355                (when (and overwrite
3356                           ;; d-b-o is defined in dired-aux.
3357                           (boundp 'dired-backup-overwrite)
3358                           dired-backup-overwrite
3359                           (setq backup-file
3360                                 (car (find-backup-file-name to)))
3361                           (or (eq dired-backup-overwrite 'always)
3362                               (y-or-n-p
3363                                (format
3364                                 "Make backup for existing file `%s'? " to))))
3365                  (rename-file to backup-file 0)
3366                  (dired-relist-entry backup-file))
3367                (cond ((memq action '(copy private))
3368                       (dired-copy-file from to overwrite))
3369                      ((eq action 'move)
3370                       (dired-rename-file from to overwrite))
3371                      ((eq action 'link)
3372                       (make-symbolic-link from to overwrite)))
3373                (dired-relist-entry to)
3374                action))))))
3375
3376 (defun dired-dnd-handle-file (uri action)
3377   "Copy, move or link a file to the dired directory if it is a local file.
3378 URI is the file to handle.  If the hostname in the URI isn't local, do nothing.
3379 ACTION is one of copy, move, link or ask.
3380 Ask means pop up a menu for the user to select one of copy, move or link."
3381   (let ((local-file (dnd-get-local-file-uri uri)))
3382     (if local-file (dired-dnd-handle-local-file local-file action)
3383       nil)))
3384 \f
3385
3386 ;;;;  Desktop support
3387
3388 (eval-when-compile (require 'desktop))
3389
3390 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3391   "Auxiliary information to be saved in desktop file."
3392   (cons
3393    ;; Value of `dired-directory'.
3394    (if (consp dired-directory)
3395        ;; Directory name followed by list of files.
3396        (cons (desktop-file-name (car dired-directory) desktop-dirname)
3397              (cdr dired-directory))
3398      ;; Directory name, optionally with shell wildcard.
3399      (desktop-file-name dired-directory desktop-dirname))
3400    ;; Subdirectories in `dired-subdir-alist'.
3401    (cdr
3402      (nreverse
3403        (mapcar
3404          (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3405          dired-subdir-alist)))))
3406
3407 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3408                                      desktop-buffer-name
3409                                      desktop-buffer-misc)
3410   "Restore a dired buffer specified in a desktop file."
3411   ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3412   ;; This value is a directory name, optionally with shell wildcard or
3413   ;; a directory name followed by list of files.
3414   (let* ((dired-dir (car desktop-buffer-misc))
3415          (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3416     (if (file-directory-p (file-name-directory dir))
3417         (progn
3418           (dired dired-dir)
3419           ;; The following elements of `desktop-buffer-misc' are the keys
3420           ;; from `dired-subdir-alist'.
3421           (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3422           (current-buffer))
3423       (message "Desktop: Directory %s no longer exists." dir)
3424       (when desktop-missing-file-warning (sit-for 1))
3425       nil)))
3426
3427 (add-to-list 'desktop-buffer-mode-handlers
3428              '(dired-mode . dired-restore-desktop-buffer))
3429
3430 \f
3431 (if (eq system-type 'vax-vms)
3432     (load "dired-vms"))
3433
3434 (provide 'dired)
3435
3436 (run-hooks 'dired-load-hook)            ; for your customizations
3437
3438 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3439 ;;; dired.el ends here