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