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