lisp/dired.el

   1 ;;; dired.el --- directory-browsing commands -*- lexical-binding: t -*-
   2
   3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2014
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
   7 ;; Maintainer: emacs-devel@gnu.org
   8 ;; Keywords: files
   9 ;; Package: emacs
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software: you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation, either version 3 of the License, or
  16 ;; (at your option) any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27
  28 ;; This is a major mode for directory browsing and editing.
  29 ;; It is documented in the Emacs manual.
  30
  31 ;; Rewritten in 1990/1991 to add tree features, file marking and
  32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
  33 ;; Finished up by rms in 1992.
  34
  35 ;;; Code:
  36
  37 (declare-function dired-buffer-more-recently-used-p
  38                   "dired-x" (buffer1 buffer2))
  39
  40 ;;; Customizable variables
  41
  42 (defgroup dired nil
  43   "Directory editing."
  44   :link '(custom-manual "(emacs)Dired")
  45   :group 'files)
  46
  47 (defgroup dired-mark nil
  48   "Handling marks in Dired."
  49   :prefix "dired-"
  50   :group 'dired)
  51
  52
  53 ;;;###autoload
  54 (defcustom dired-listing-switches (purecopy "-al")
  55   "Switches passed to `ls' for Dired.  MUST contain the `l' option.
  56 May contain all other options that don't contradict `-l';
  57 may contain even `F', `b', `i' and `s'.  See also the variable
  58 `dired-ls-F-marks-symlinks' concerning the `F' switch.
  59 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
  60 some of the `ls' switches are not supported; see the doc string of
  61 `insert-directory' in `ls-lisp.el' for more details."
  62   :type 'string
  63   :group 'dired)
  64
  65 (defcustom dired-subdir-switches nil
  66   "If non-nil, switches passed to `ls' for inserting subdirectories.
  67 If nil, `dired-listing-switches' is used."
  68    :group 'dired
  69    :type '(choice (const :tag "Use dired-listing-switches" nil)
  70                   (string :tag "Switches")))
  71
  72 (defcustom dired-chown-program
  73   (purecopy (cond ((executable-find "chown") "chown")
  74                   ((file-executable-p "/usr/sbin/chown") "/usr/sbin/chown")
  75                   ((file-executable-p "/etc/chown") "/etc/chown")
  76                   (t "chown")))
  77   "Name of chown command (usually `chown')."
  78   :group 'dired
  79   :type 'file)
  80
  81 (defcustom dired-use-ls-dired 'unspecified
  82   "Non-nil means Dired should pass the \"--dired\" option to \"ls\".
  83 The special value of `unspecified' means to check explicitly, and
  84 save the result in this variable.  This is performed the first
  85 time `dired-insert-directory' is called.
  86
  87 Note that if you set this option to nil, either through choice or
  88 because your \"ls\" program does not support \"--dired\", Dired
  89 will fail to parse some \"unusual\" file names, e.g. those with leading
  90 spaces.  You might want to install ls from GNU Coreutils, which does
  91 support this option.  Alternatively, you might want to use Emacs's
  92 own emulation of \"ls\", by using:
  93   (setq ls-lisp-use-insert-directory-program nil)
  94   (require 'ls-lisp)
  95 This is used by default on MS Windows, which does not have an \"ls\" program.
  96 Note that `ls-lisp' does not support as many options as GNU ls, though.
  97 For more details, see Info node `(emacs)ls in Lisp'."
  98   :group 'dired
  99   :type '(choice (const :tag "Check for --dired support" unspecified)
 100                  (const :tag "Do not use --dired" nil)
 101                  (other :tag "Use --dired" t)))
 102
 103 (defcustom dired-chmod-program "chmod"
 104   "Name of chmod command (usually `chmod')."
 105   :group 'dired
 106   :type 'file)
 107
 108 (defcustom dired-touch-program "touch"
 109   "Name of touch command (usually `touch')."
 110    :group 'dired
 111    :type 'file)
 112
 113 (defcustom dired-ls-F-marks-symlinks nil
 114   "Informs Dired about how `ls -lF' marks symbolic links.
 115 Set this to t if `ls' (or whatever program is specified by
 116 `insert-directory-program') with `-lF' marks the symbolic link
 117 itself with a trailing @ (usually the case under Ultrix).
 118
 119 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
 120 nil (the default), if it gives `bar@ -> foo', set it to t.
 121
 122 Dired checks if there is really a @ appended.  Thus, if you have a
 123 marking `ls' program on one host and a non-marking on another host, and
 124 don't care about symbolic links which really end in a @, you can
 125 always set this variable to t."
 126   :type 'boolean
 127   :group 'dired-mark)
 128
 129 (defcustom dired-trivial-filenames (purecopy "^\\.\\.?$\\|^#")
 130   "Regexp of files to skip when finding first file of a directory.
 131 A value of nil means move to the subdir line.
 132 A value of t means move to first file."
 133   :type '(choice (const :tag "Move to subdir" nil)
 134                  (const :tag "Move to first" t)
 135                  regexp)
 136   :group 'dired)
 137
 138 (defcustom dired-keep-marker-rename t
 139   ;; Use t as default so that moved files "take their markers with them".
 140   "Controls marking of renamed files.
 141 If t, files keep their previous marks when they are renamed.
 142 If a character, renamed files (whether previously marked or not)
 143 are afterward marked with that character.
 144 This option affects only files renamed by `dired-do-rename' and
 145 `dired-do-rename-regexp'.  See `wdired-keep-marker-rename'
 146 if you want to do the same for files renamed in WDired mode."
 147   :type '(choice (const :tag "Keep" t)
 148                  (character :tag "Mark" :value ?R))
 149   :group 'dired-mark)
 150
 151 (defcustom dired-keep-marker-copy ?C
 152   "Controls marking of copied files.
 153 If t, copied files are marked if and as the corresponding original files were.
 154 If a character, copied files are unconditionally marked with that character."
 155   :type '(choice (const :tag "Keep" t)
 156                  (character :tag "Mark"))
 157   :group 'dired-mark)
 158
 159 (defcustom dired-keep-marker-hardlink ?H
 160   "Controls marking of newly made hard links.
 161 If t, they are marked if and as the files linked to were marked.
 162 If a character, new links are unconditionally marked with that character."
 163   :type '(choice (const :tag "Keep" t)
 164                  (character :tag "Mark"))
 165   :group 'dired-mark)
 166
 167 (defcustom dired-keep-marker-symlink ?Y
 168   "Controls marking of newly made symbolic links.
 169 If t, they are marked if and as the files linked to were marked.
 170 If a character, new links are unconditionally marked with that character."
 171   :type '(choice (const :tag "Keep" t)
 172                  (character :tag "Mark"))
 173   :group 'dired-mark)
 174
 175 (defcustom dired-dwim-target nil
 176   "If non-nil, Dired tries to guess a default target directory.
 177 This means: if there is a Dired buffer displayed in the next
 178 window, use its current directory, instead of this Dired buffer's
 179 current directory.
 180
 181 The target is used in the prompt for file copy, rename etc."
 182   :type 'boolean
 183   :group 'dired)
 184
 185 (defcustom dired-copy-preserve-time t
 186   "If non-nil, Dired preserves the last-modified time in a file copy.
 187 \(This works on only some systems.)"
 188   :type 'boolean
 189   :group 'dired)
 190
 191 ; These variables were deleted and the replacements are on files.el.
 192 ; We leave aliases behind for back-compatibility.
 193 (defvaralias 'dired-free-space-program 'directory-free-space-program)
 194 (defvaralias 'dired-free-space-args 'directory-free-space-args)
 195
 196 ;;; Hook variables
 197
 198 (defcustom dired-load-hook nil
 199   "Run after loading Dired.
 200 You can customize key bindings or load extensions with this."
 201   :group 'dired
 202   :type 'hook)
 203
 204 (defcustom dired-mode-hook nil
 205   "Run at the very end of `dired-mode'."
 206   :group 'dired
 207   :type 'hook)
 208
 209 (defcustom dired-before-readin-hook nil
 210   "This hook is run before a Dired buffer is read in (created or reverted)."
 211   :group 'dired
 212   :type 'hook)
 213
 214 (defcustom dired-after-readin-hook nil
 215   "Hook run after each time a file or directory is read by Dired.
 216 After each listing of a file or directory, this hook is run
 217 with the buffer narrowed to the listing."
 218   :group 'dired
 219   :type 'hook)
 220 ;; Note this can't simply be run inside function `dired-ls' as the hook
 221 ;; functions probably depend on the dired-subdir-alist to be OK.
 222
 223 (defcustom dired-initial-position-hook nil
 224   "This hook is used to position the point.
 225 It is run by the function `dired-initial-position'."
 226   :group 'dired
 227   :type 'hook
 228   :version "24.4")
 229
 230 (defcustom dired-dnd-protocol-alist
 231   '(("^file:///" . dired-dnd-handle-local-file)
 232     ("^file://"  . dired-dnd-handle-file)
 233     ("^file:"    . dired-dnd-handle-local-file))
 234   "The functions to call when a drop in `dired-mode' is made.
 235 See `dnd-protocol-alist' for more information.  When nil, behave
 236 as in other buffers.  Changing this option is effective only for
 237 new Dired buffers."
 238   :type '(choice (repeat (cons (regexp) (function)))
 239                  (const :tag "Behave as in other buffers" nil))
 240   :version "22.1"
 241   :group 'dired)
 242
 243 (defcustom dired-hide-details-hide-symlink-targets t
 244   "Non-nil means `dired-hide-details-mode' hides symbolic link targets."
 245   :type 'boolean
 246   :version "24.4"
 247   :group 'dired)
 248
 249 (defcustom dired-hide-details-hide-information-lines t
 250   "Non-nil means `dired-hide-details-mode' hides all but header and file lines."
 251   :type 'boolean
 252   :version "24.4"
 253   :group 'dired)
 254
 255 ;; Internal variables
 256
 257 (defvar dired-marker-char ?*            ; the answer is 42
 258   ;; so that you can write things like
 259   ;; (let ((dired-marker-char ?X))
 260   ;;    ;; great code using X markers ...
 261   ;;    )
 262   ;; For example, commands operating on two sets of files, A and B.
 263   ;; Or marking files with digits 0-9.  This could implicate
 264   ;; concentric sets or an order for the marked files.
 265   ;; The code depends on dynamic scoping on the marker char.
 266   "In Dired, the current mark character.
 267 This is what the do-commands look for, and what the mark-commands store.")
 268
 269 (defvar dired-del-marker ?D
 270   "Character used to flag files for deletion.")
 271
 272 (defvar dired-shrink-to-fit t
 273 ;; I see no reason ever to make this nil -- rms.
 274 ;;  (> baud-rate search-slow-speed)
 275   "Non-nil means Dired shrinks the display buffer to fit the marked files.")
 276 (make-obsolete-variable 'dired-shrink-to-fit
 277                         "use the Customization interface to add a new rule
 278 to `display-buffer-alist' where condition regexp is \"^ \\*Marked Files\\*$\",
 279 action argument symbol is `window-height' and its value is nil." "24.3")
 280
 281 (defvar dired-file-version-alist)
 282
 283 ;;;###autoload
 284 (defvar dired-directory nil
 285   "The directory name or wildcard spec that this Dired directory lists.
 286 Local to each Dired buffer.  May be a list, in which case the car is the
 287 directory name and the cdr is the list of files to mention.
 288 The directory name must be absolute, but need not be fully expanded.")
 289
 290 ;; Beware of "-l;reboot" etc.  See bug#3230.
 291 (defun dired-safe-switches-p (switches)
 292   "Return non-nil if string SWITCHES does not look risky for Dired."
 293   (or (not switches)
 294       (and (stringp switches)
 295            (< (length switches) 100)    ; arbitrary
 296            (string-match-p "\\` *-[- [:alnum:]]+\\'" switches))))
 297
 298 (defvar dired-actual-switches nil
 299   "The value of `dired-listing-switches' used to make this buffer's text.")
 300
 301 (put 'dired-actual-switches 'safe-local-variable 'dired-safe-switches-p)
 302
 303 (defvar dired-re-inode-size "[0-9 \t]*"
 304   "Regexp for optional initial inode and file size as made by `ls -i -s'.")
 305
 306 ;; These regexps must be tested at beginning-of-line, but are also
 307 ;; used to search for next matches, so neither omitting "^" nor
 308 ;; replacing "^" by "\n" (to make it slightly faster) will work.
 309
 310 (defvar dired-re-mark "^[^ \n]")
 311 ;; "Regexp matching a marked line.
 312 ;; Important: the match ends just after the marker."
 313 (defvar dired-re-maybe-mark "^. ")
 314 ;; The [^:] part after "d" and "l" is to avoid confusion with the
 315 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
 316 (defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d[^:]"))
 317 (defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l[^:]"))
 318 (defvar dired-re-exe;; match ls permission string of an executable file
 319   (mapconcat (function
 320               (lambda (x)
 321                 (concat dired-re-maybe-mark dired-re-inode-size x)))
 322              '("-[-r][-w][xs][-r][-w].[-r][-w]."
 323                "-[-r][-w].[-r][-w][xs][-r][-w]."
 324                "-[-r][-w].[-r][-w].[-r][-w][xst]")
 325              "\\|"))
 326 (defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
 327 (defvar dired-re-dot "^.* \\.\\.?/?$")
 328
 329 ;; The subdirectory names in the next two lists are expanded.
 330 (defvar dired-subdir-alist nil
 331   "Association list of subdirectories and their buffer positions.
 332 Each subdirectory has an element: (DIRNAME . STARTMARKER).
 333 The order of elements is the reverse of the order in the buffer.
 334 In simple cases, this list contains one element.")
 335
 336 (defvar-local dired-switches-alist nil
 337   "Keeps track of which switches to use for inserted subdirectories.
 338 This is an alist of the form (SUBDIR . SWITCHES).")
 339
 340 (defvaralias 'dired-move-to-filename-regexp
 341   'directory-listing-before-filename-regexp)
 342
 343 (defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
 344   "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
 345 Subexpression 1 is the subdirectory proper, no trailing colon.
 346 The match starts at the beginning of the line and ends after the end
 347 of the line (\\n or \\r).
 348 Subexpression 2 must end right before the \\n or \\r.")
 349
 350 (defgroup dired-faces nil
 351   "Faces used by Dired."
 352   :group 'dired
 353   :group 'faces)
 354
 355 (defface dired-header
 356   '((t (:inherit font-lock-type-face)))
 357   "Face used for directory headers."
 358   :group 'dired-faces
 359   :version "22.1")
 360 (defvar dired-header-face 'dired-header
 361   "Face name used for directory headers.")
 362
 363 (defface dired-mark
 364   '((t (:inherit font-lock-constant-face)))
 365   "Face used for Dired marks."
 366   :group 'dired-faces
 367   :version "22.1")
 368 (defvar dired-mark-face 'dired-mark
 369   "Face name used for Dired marks.")
 370
 371 (defface dired-marked
 372   '((t (:inherit warning)))
 373   "Face used for marked files."
 374   :group 'dired-faces
 375   :version "22.1")
 376 (defvar dired-marked-face 'dired-marked
 377   "Face name used for marked files.")
 378
 379 (defface dired-flagged
 380   '((t (:inherit error)))
 381   "Face used for files flagged for deletion."
 382   :group 'dired-faces
 383   :version "22.1")
 384 (defvar dired-flagged-face 'dired-flagged
 385   "Face name used for files flagged for deletion.")
 386
 387 (defface dired-warning
 388   ;; Inherit from font-lock-warning-face since with min-colors 8
 389   ;; font-lock-comment-face is not colored any more.
 390   '((t (:inherit font-lock-warning-face)))
 391   "Face used to highlight a part of a buffer that needs user attention."
 392   :group 'dired-faces
 393   :version "22.1")
 394 (defvar dired-warning-face 'dired-warning
 395   "Face name used for a part of a buffer that needs user attention.")
 396
 397 (defface dired-perm-write
 398   '((((type w32 pc)) :inherit default)  ;; These default to rw-rw-rw.
 399     ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
 400     ;; font-lock-comment-face is not colored any more.
 401     (t (:inherit font-lock-comment-delimiter-face)))
 402   "Face used to highlight permissions of group- and world-writable files."
 403   :group 'dired-faces
 404   :version "22.2")
 405 (defvar dired-perm-write-face 'dired-perm-write
 406   "Face name used for permissions of group- and world-writable files.")
 407
 408 (defface dired-directory
 409   '((t (:inherit font-lock-function-name-face)))
 410   "Face used for subdirectories."
 411   :group 'dired-faces
 412   :version "22.1")
 413 (defvar dired-directory-face 'dired-directory
 414   "Face name used for subdirectories.")
 415
 416 (defface dired-symlink
 417   '((t (:inherit font-lock-keyword-face)))
 418   "Face used for symbolic links."
 419   :group 'dired-faces
 420   :version "22.1")
 421 (defvar dired-symlink-face 'dired-symlink
 422   "Face name used for symbolic links.")
 423
 424 (defface dired-ignored
 425   '((t (:inherit shadow)))
 426   "Face used for files suffixed with `completion-ignored-extensions'."
 427   :group 'dired-faces
 428   :version "22.1")
 429 (defvar dired-ignored-face 'dired-ignored
 430   "Face name used for files suffixed with `completion-ignored-extensions'.")
 431
 432 (defvar dired-font-lock-keywords
 433   (list
 434    ;;
 435    ;; Dired marks.
 436    (list dired-re-mark '(0 dired-mark-face))
 437    ;;
 438    ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
 439    ;; file name itself.  We search for Dired defined regexps, and then use the
 440    ;; Dired defined function `dired-move-to-filename' before searching for the
 441    ;; simple regexp ".+".  It is that regexp which matches the file name.
 442    ;;
 443    ;; Marked files.
 444    (list (concat "^[" (char-to-string dired-marker-char) "]")
 445          '(".+" (dired-move-to-filename) nil (0 dired-marked-face)))
 446    ;;
 447    ;; Flagged files.
 448    (list (concat "^[" (char-to-string dired-del-marker) "]")
 449          '(".+" (dired-move-to-filename) nil (0 dired-flagged-face)))
 450    ;; People who are paranoid about security would consider this more
 451    ;; important than other things such as whether it is a directory.
 452    ;; But we don't want to encourage paranoia, so our default
 453    ;; should be what's most useful for non-paranoids. -- rms.
 454 ;;;   ;;
 455 ;;;   ;; Files that are group or world writable.
 456 ;;;   (list (concat dired-re-maybe-mark dired-re-inode-size
 457 ;;;              "\\([-d]\\(....w....\\|.......w.\\)\\)")
 458 ;;;      '(1 dired-warning-face)
 459 ;;;      '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
 460    ;; However, we don't need to highlight the file name, only the
 461    ;; permissions, to win generally.  -- fx.
 462    ;; Fixme: we could also put text properties on the permission
 463    ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
 464    (list (concat dired-re-maybe-mark dired-re-inode-size
 465                  "[-d]....\\(w\\)....") ; group writable
 466          '(1 dired-perm-write-face))
 467    (list (concat dired-re-maybe-mark dired-re-inode-size
 468                  "[-d].......\\(w\\).") ; world writable
 469          '(1 dired-perm-write-face))
 470    ;;
 471    ;; Subdirectories.
 472    (list dired-re-dir
 473          '(".+" (dired-move-to-filename) nil (0 dired-directory-face)))
 474    ;;
 475    ;; Symbolic links.
 476    (list dired-re-sym
 477          '(".+" (dired-move-to-filename) nil (0 dired-symlink-face)))
 478    ;;
 479    ;; Files suffixed with `completion-ignored-extensions'.
 480    '(eval .
 481      ;; It is quicker to first find just an extension, then go back to the
 482      ;; start of that file name.  So we do this complex MATCH-ANCHORED form.
 483      (list (concat "\\(" (regexp-opt completion-ignored-extensions) "\\|#\\)$")
 484            '(".+" (dired-move-to-filename) nil (0 dired-ignored-face))))
 485    ;;
 486    ;; Files suffixed with `completion-ignored-extensions'
 487    ;; plus a character put in by -F.
 488    '(eval .
 489      (list (concat "\\(" (regexp-opt completion-ignored-extensions)
 490                    "\\|#\\)[*=|]$")
 491            '(".+" (progn
 492                     (end-of-line)
 493                     ;; If the last character is not part of the filename,
 494                     ;; move back to the start of the filename
 495                     ;; so it can be fontified.
 496                     ;; Otherwise, leave point at the end of the line;
 497                     ;; that way, nothing is fontified.
 498                     (unless (get-text-property (1- (point)) 'mouse-face)
 499                       (dired-move-to-filename)))
 500              nil (0 dired-ignored-face))))
 501    ;;
 502    ;; Explicitly put the default face on file names ending in a colon to
 503    ;; avoid fontifying them as directory header.
 504    (list (concat dired-re-maybe-mark dired-re-inode-size dired-re-perms ".*:$")
 505          '(".+" (dired-move-to-filename) nil (0 'default)))
 506    ;;
 507    ;; Directory headers.
 508    (list dired-subdir-regexp '(1 dired-header-face))
 509 )
 510   "Additional expressions to highlight in Dired mode.")
 511
 512 (defvar dnd-protocol-alist)
 513 \f
 514 ;;; Macros must be defined before they are used, for the byte compiler.
 515
 516 (defmacro dired-mark-if (predicate msg)
 517   "Mark all files for which PREDICATE evals to non-nil.
 518 PREDICATE is evaluated on each line, with point at beginning of line.
 519 MSG is a noun phrase for the type of files being marked.
 520 It should end with a noun that can be pluralized by adding `s'.
 521 Return value is the number of files marked, or nil if none were marked."
 522   `(let ((inhibit-read-only t) count)
 523     (save-excursion
 524       (setq count 0)
 525       (when ,msg
 526         (message "%s %ss%s..."
 527                  (cond ((eq dired-marker-char ?\040) "Unmarking")
 528                        ((eq dired-del-marker dired-marker-char)
 529                         "Flagging")
 530                        (t "Marking"))
 531                  ,msg
 532                  (if (eq dired-del-marker dired-marker-char)
 533                      " for deletion"
 534                    "")))
 535       (goto-char (point-min))
 536       (while (not (eobp))
 537         (if ,predicate
 538             (progn
 539               (delete-char 1)
 540               (insert dired-marker-char)
 541               (setq count (1+ count))))
 542         (forward-line 1))
 543       (if ,msg (message "%s %s%s %s%s."
 544                         count
 545                         ,msg
 546                         (dired-plural-s count)
 547                         (if (eq dired-marker-char ?\040) "un" "")
 548                         (if (eq dired-marker-char dired-del-marker)
 549                             "flagged" "marked"))))
 550     (and (> count 0) count)))
 551
 552 (defmacro dired-map-over-marks (body arg &optional show-progress
 553                                      distinguish-one-marked)
 554   "Eval BODY with point on each marked line.  Return a list of BODY's results.
 555 If no marked file could be found, execute BODY on the current
 556 line.  ARG, if non-nil, specifies the files to use instead of the
 557 marked files.
 558
 559 If ARG is an integer, use the next ARG (or previous -ARG, if
 560 ARG<0) files.  In that case, point is dragged along.  This is so
 561 that commands on the next ARG (instead of the marked) files can
 562 be chained easily.
 563 For any other non-nil value of ARG, use the current file.
 564
 565 If optional third arg SHOW-PROGRESS evaluates to non-nil,
 566 redisplay the dired buffer after each file is processed.
 567
 568 No guarantee is made about the position on the marked line.
 569 BODY must ensure this itself if it depends on this.
 570
 571 Search starts at the beginning of the buffer, thus the car of the
 572 list corresponds to the line nearest to the buffer's bottom.
 573 This is also true for (positive and negative) integer values of
 574 ARG.
 575
 576 BODY should not be too long as it is expanded four times.
 577
 578 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
 579 marked file, return (t FILENAME) instead of (FILENAME)."
 580   ;;
 581   ;;Warning: BODY must not add new lines before point - this may cause an
 582   ;;endless loop.
 583   ;;This warning should not apply any longer, sk  2-Sep-1991 14:10.
 584   `(prog1
 585        (let ((inhibit-read-only t) case-fold-search found results)
 586          (if ,arg
 587              (if (integerp ,arg)
 588                  (progn ;; no save-excursion, want to move point.
 589                    (dired-repeat-over-lines
 590                     ,arg
 591                     (function (lambda ()
 592                                 (if ,show-progress (sit-for 0))
 593                                 (setq results (cons ,body results)))))
 594                    (if (< ,arg 0)
 595                        (nreverse results)
 596                      results))
 597                ;; non-nil, non-integer ARG means use current file:
 598                (list ,body))
 599            (let ((regexp (dired-marker-regexp)) next-position)
 600              (save-excursion
 601                (goto-char (point-min))
 602                ;; remember position of next marked file before BODY
 603                ;; can insert lines before the just found file,
 604                ;; confusing us by finding the same marked file again
 605                ;; and again and...
 606                (setq next-position (and (re-search-forward regexp nil t)
 607                                         (point-marker))
 608                      found (not (null next-position)))
 609                (while next-position
 610                  (goto-char next-position)
 611                  (if ,show-progress (sit-for 0))
 612                  (setq results (cons ,body results))
 613                  ;; move after last match
 614                  (goto-char next-position)
 615                  (forward-line 1)
 616                  (set-marker next-position nil)
 617                  (setq next-position (and (re-search-forward regexp nil t)
 618                                           (point-marker)))))
 619              (if (and ,distinguish-one-marked (= (length results) 1))
 620                  (setq results (cons t results)))
 621              (if found
 622                  results
 623                (list ,body)))))
 624      ;; save-excursion loses, again
 625      (dired-move-to-filename)))
 626
 627 (defun dired-get-marked-files (&optional localp arg filter distinguish-one-marked)
 628   "Return the marked files' names as list of strings.
 629 The list is in the same order as the buffer, that is, the car is the
 630   first marked file.
 631 Values returned are normally absolute file names.
 632 Optional arg LOCALP as in `dired-get-filename'.
 633 Optional second argument ARG, if non-nil, specifies files near
 634  point instead of marked files.  It usually comes from the prefix
 635  argument.
 636   If ARG is an integer, use the next ARG files.
 637   If ARG is any other non-nil value, return the current file name.
 638   If no files are marked, and ARG is nil, also return the current file name.
 639 Optional third argument FILTER, if non-nil, is a function to select
 640   some of the files--those for which (funcall FILTER FILENAME) is non-nil.
 641
 642 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
 643 return (t FILENAME) instead of (FILENAME).
 644 Don't use that together with FILTER."
 645   (let ((all-of-them
 646          (save-excursion
 647            (delq nil (dired-map-over-marks
 648                       (dired-get-filename localp 'no-error-if-not-filep)
 649                       arg nil distinguish-one-marked))))
 650         result)
 651     (when (equal all-of-them '(t))
 652       (setq all-of-them nil))
 653     (if (not filter)
 654         (if (and distinguish-one-marked (eq (car all-of-them) t))
 655             all-of-them
 656           (nreverse all-of-them))
 657       (dolist (file all-of-them)
 658         (if (funcall filter file)
 659             (push file result)))
 660       result)))
 661 \f
 662 ;; The dired command
 663
 664 (defun dired-read-dir-and-switches (str)
 665   ;; For use in interactive.
 666   (reverse (list
 667             (if current-prefix-arg
 668                 (read-string "Dired listing switches: "
 669                              dired-listing-switches))
 670             ;; If a dialog is used, call `read-directory-name' so the
 671             ;; dialog code knows we want directories.  Some dialogs
 672             ;; can only select directories or files when popped up,
 673             ;; not both.  If no dialog is used, call `read-file-name'
 674             ;; because the user may want completion of file names for
 675             ;; use in a wildcard pattern.
 676             (if (next-read-file-uses-dialog-p)
 677                 (read-directory-name (format "Dired %s(directory): " str)
 678                                      nil default-directory nil)
 679               (read-file-name (format "Dired %s(directory): " str)
 680                               nil default-directory nil)))))
 681
 682 ;; We want to switch to a more sophisticated version of
 683 ;; dired-read-dir-and-switches like the following, if there is a way
 684 ;; to make it more intuitive.  See bug#1285.
 685
 686 ;; (defun dired-read-dir-and-switches (str)
 687 ;;   ;; For use in interactive.
 688 ;;   (reverse
 689 ;;    (list
 690 ;;     (if current-prefix-arg
 691 ;;         (read-string "Dired listing switches: "
 692 ;;                      dired-listing-switches))
 693 ;;     ;; If a dialog is about to be used, call read-directory-name so
 694 ;;     ;; the dialog code knows we want directories.  Some dialogs can
 695 ;;     ;; only select directories or files when popped up, not both.
 696 ;;     (if (next-read-file-uses-dialog-p)
 697 ;;         (read-directory-name (format "Dired %s(directory): " str)
 698 ;;                              nil default-directory nil)
 699 ;;       (let ((cie ()))
 700 ;;         (dolist (ext completion-ignored-extensions)
 701 ;;           (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
 702 ;;         (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
 703 ;;         (let* ((default (and buffer-file-name
 704 ;;                              (abbreviate-file-name buffer-file-name)))
 705 ;;                (cie cie)
 706 ;;                (completion-table
 707 ;;                 ;; We need a mix of read-file-name and
 708 ;;                 ;; read-directory-name so that completion to directories
 709 ;;                 ;; is preferred, but if the user wants to enter a global
 710 ;;                 ;; pattern, he can still use completion on filenames to
 711 ;;                 ;; help him write the pattern.
 712 ;;                 ;; Essentially, we want to use
 713 ;;                 ;; (completion-table-with-predicate
 714 ;;                 ;;  'read-file-name-internal 'file-directory-p nil)
 715 ;;                 ;; but that doesn't work because read-file-name-internal
 716 ;;                 ;; does not obey its `predicate' argument.
 717 ;;                 (completion-table-in-turn
 718 ;;                  (lambda (str pred action)
 719 ;;                    (let ((read-file-name-predicate
 720 ;;                           (lambda (f)
 721 ;;                             (and (not (member f '("./" "../")))
 722 ;;                                  ;; Hack! Faster than file-directory-p!
 723 ;;                                  (eq (aref f (1- (length f))) ?/)
 724 ;;                                  (not (string-match cie f))))))
 725 ;;                      (complete-with-action
 726 ;;                       action 'read-file-name-internal str nil)))
 727 ;;                  'read-file-name-internal)))
 728 ;;           (minibuffer-with-setup-hook
 729 ;;               (lambda ()
 730 ;;                 (setq minibuffer-default default)
 731 ;;                 (setq minibuffer-completion-table completion-table))
 732 ;;             (read-file-name (format "Dired %s(directory): " str)
 733 ;;                             nil default-directory nil))))))))
 734
 735 (defun dired-file-name-at-point ()
 736   "Try to get a file name at point in the current dired buffer.
 737 This hook is intended to be put in `file-name-at-point-functions'.
 738 Note that it returns an abbreviated name that can't be used
 739 as an argument to `dired-goto-file'."
 740   (let ((filename (dired-get-filename nil t)))
 741     (when filename
 742       (if (file-directory-p filename)
 743           (file-name-as-directory (abbreviate-file-name filename))
 744         (abbreviate-file-name filename)))))
 745
 746 ;;;###autoload (define-key ctl-x-map "d" 'dired)
 747 ;;;###autoload
 748 (defun dired (dirname &optional switches)
 749   "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
 750 Optional second argument SWITCHES specifies the `ls' options used.
 751 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
 752 Dired displays a list of files in DIRNAME (which may also have
 753 shell wildcards appended to select certain files).  If DIRNAME is a cons,
 754 its first element is taken as the directory name and the rest as an explicit
 755 list of files to make directory entries for.
 756 \\<dired-mode-map>\
 757 You can flag files for deletion with \\[dired-flag-file-deletion] and then
 758 delete them by typing \\[dired-do-flagged-delete].
 759 Type \\[describe-mode] after entering Dired for more info.
 760
 761 If DIRNAME is already in a Dired buffer, that buffer is used without refresh."
 762   ;; Cannot use (interactive "D") because of wildcards.
 763   (interactive (dired-read-dir-and-switches ""))
 764   (switch-to-buffer (dired-noselect dirname switches)))
 765
 766 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
 767 ;;;###autoload
 768 (defun dired-other-window (dirname &optional switches)
 769   "\"Edit\" directory DIRNAME.  Like `dired' but selects in another window."
 770   (interactive (dired-read-dir-and-switches "in other window "))
 771   (switch-to-buffer-other-window (dired-noselect dirname switches)))
 772
 773 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
 774 ;;;###autoload
 775 (defun dired-other-frame (dirname &optional switches)
 776   "\"Edit\" directory DIRNAME.  Like `dired' but makes a new frame."
 777   (interactive (dired-read-dir-and-switches "in other frame "))
 778   (switch-to-buffer-other-frame (dired-noselect dirname switches)))
 779
 780 ;;;###autoload
 781 (defun dired-noselect (dir-or-list &optional switches)
 782   "Like `dired' but returns the Dired buffer as value, does not select it."
 783   (or dir-or-list (setq dir-or-list default-directory))
 784   ;; This loses the distinction between "/foo/*/" and "/foo/*" that
 785   ;; some shells make:
 786   (let (dirname initially-was-dirname)
 787     (if (consp dir-or-list)
 788         (setq dirname (car dir-or-list))
 789       (setq dirname dir-or-list))
 790     (setq initially-was-dirname
 791           (string= (file-name-as-directory dirname) dirname))
 792     (setq dirname (abbreviate-file-name
 793                    (expand-file-name (directory-file-name dirname))))
 794     (if find-file-visit-truename
 795         (setq dirname (file-truename dirname)))
 796     ;; If the argument was syntactically  a directory name not a file name,
 797     ;; or if it happens to name a file that is a directory,
 798     ;; convert it syntactically to a directory name.
 799     ;; The reason for checking initially-was-dirname
 800     ;; and not just file-directory-p
 801     ;; is that file-directory-p is slow over ftp.
 802     (if (or initially-was-dirname (file-directory-p dirname))
 803         (setq dirname  (file-name-as-directory dirname)))
 804     (if (consp dir-or-list)
 805         (setq dir-or-list (cons dirname (cdr dir-or-list)))
 806       (setq dir-or-list dirname))
 807     (dired-internal-noselect dir-or-list switches)))
 808
 809 ;; The following is an internal dired function.  It returns non-nil if
 810 ;; the directory visited by the current dired buffer has changed on
 811 ;; disk.  DIRNAME should be the directory name of that directory.
 812 (defun dired-directory-changed-p (dirname)
 813   (not (let ((attributes (file-attributes dirname))
 814              (modtime (visited-file-modtime)))
 815          (or (eq modtime 0)
 816              (not (eq (car attributes) t))
 817              (equal (nth 5 attributes) modtime)))))
 818
 819 (defun dired-buffer-stale-p (&optional noconfirm)
 820   "Return non-nil if current Dired buffer needs updating.
 821 If NOCONFIRM is non-nil, then this function always returns nil
 822 for a remote directory.  This feature is used by Auto Revert mode."
 823   (let ((dirname
 824          (if (consp dired-directory) (car dired-directory) dired-directory)))
 825     (and (stringp dirname)
 826          (not (when noconfirm (file-remote-p dirname)))
 827          (file-readable-p dirname)
 828          ;; Do not auto-revert when the dired buffer can be currently
 829          ;; written by the user as in `wdired-mode'.
 830          buffer-read-only
 831          (dired-directory-changed-p dirname))))
 832
 833 (defcustom dired-auto-revert-buffer nil
 834   "Automatically revert Dired buffer on revisiting.
 835 If t, revisiting an existing Dired buffer automatically reverts it.
 836 If its value is a function, call this function with the directory
 837 name as single argument and revert the buffer if it returns non-nil.
 838 Otherwise, a message offering to revert the changed dired buffer
 839 is displayed.
 840 Note that this is not the same as `auto-revert-mode' that
 841 periodically reverts at specified time intervals."
 842   :type '(choice
 843           (const :tag "Don't revert" nil)
 844           (const :tag "Always revert visited Dired buffer" t)
 845           (const :tag "Revert changed Dired buffer" dired-directory-changed-p)
 846           (function :tag "Predicate function"))
 847   :group 'dired
 848   :version "23.2")
 849
 850 (defun dired-internal-noselect (dir-or-list &optional switches mode)
 851   ;; If there is an existing dired buffer for DIRNAME, just leave
 852   ;; buffer as it is (don't even call dired-revert).
 853   ;; This saves time especially for deep trees or with ange-ftp.
 854   ;; The user can type `g' easily, and it is more consistent with find-file.
 855   ;; But if SWITCHES are given they are probably different from the
 856   ;; buffer's old value, so call dired-sort-other, which does
 857   ;; revert the buffer.
 858   ;; A pity we can't possibly do "Directory has changed - refresh? "
 859   ;; like find-file does.
 860   ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
 861   ;; see there.
 862   (let* ((old-buf (current-buffer))
 863          (dirname (if (consp dir-or-list) (car dir-or-list) dir-or-list))
 864          ;; Look for an existing buffer.
 865          (buffer (dired-find-buffer-nocreate dirname mode))
 866          ;; Note that buffer already is in dired-mode, if found.
 867          (new-buffer-p (null buffer)))
 868     (or buffer
 869         (setq buffer (create-file-buffer (directory-file-name dirname))))
 870     (set-buffer buffer)
 871     (if (not new-buffer-p)              ; existing buffer ...
 872         (cond (switches                 ; ... but new switches
 873                ;; file list may have changed
 874                (setq dired-directory dir-or-list)
 875                ;; this calls dired-revert
 876                (dired-sort-other switches))
 877               ;; Always revert regardless of whether it has changed or not.
 878               ((eq dired-auto-revert-buffer t)
 879                (revert-buffer))
 880               ;; Revert when predicate function returns non-nil.
 881               ((functionp dired-auto-revert-buffer)
 882                (when (funcall dired-auto-revert-buffer dirname)
 883                  (revert-buffer)
 884                  (message "Changed directory automatically updated")))
 885               ;; If directory has changed on disk, offer to revert.
 886               ((when (dired-directory-changed-p dirname)
 887                  (message "%s"
 888                           (substitute-command-keys
 889                            "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
 890       ;; Else a new buffer
 891       (setq default-directory
 892             ;; We can do this unconditionally
 893             ;; because dired-noselect ensures that the name
 894             ;; is passed in directory name syntax
 895             ;; if it was the name of a directory at all.
 896             (file-name-directory dirname))
 897       (or switches (setq switches dired-listing-switches))
 898       (if mode (funcall mode)
 899         (dired-mode dir-or-list switches))
 900       ;; default-directory and dired-actual-switches are set now
 901       ;; (buffer-local), so we can call dired-readin:
 902       (let ((failed t))
 903         (unwind-protect
 904             (progn (dired-readin)
 905                    (setq failed nil))
 906           ;; dired-readin can fail if parent directories are inaccessible.
 907           ;; Don't leave an empty buffer around in that case.
 908           (if failed (kill-buffer buffer))))
 909       (goto-char (point-min))
 910       (dired-initial-position dirname))
 911     (set-buffer old-buf)
 912     buffer))
 913
 914 (defvar dired-buffers nil
 915   ;; Enlarged by dired-advertise
 916   ;; Queried by function dired-buffers-for-dir. When this detects a
 917   ;; killed buffer, it is removed from this list.
 918   "Alist of expanded directories and their associated Dired buffers.")
 919
 920 (defvar dired-find-subdir)
 921
 922 ;; FIXME add a doc-string, and document dired-x extensions.
 923 (defun dired-find-buffer-nocreate (dirname &optional mode)
 924   ;; This differs from dired-buffers-for-dir in that it does not consider
 925   ;; subdirs of default-directory and searches for the first match only.
 926   ;; Also, the major mode must be MODE.
 927   (if (and (featurep 'dired-x)
 928            dired-find-subdir
 929            ;; Don't try to find a wildcard as a subdirectory.
 930            (string-equal dirname (file-name-directory dirname)))
 931       (let* ((cur-buf (current-buffer))
 932              (buffers (nreverse
 933                        (dired-buffers-for-dir (expand-file-name dirname))))
 934              (cur-buf-matches (and (memq cur-buf buffers)
 935                                    ;; Wildcards must match, too:
 936                                    (equal dired-directory dirname))))
 937         ;; We don't want to switch to the same buffer---
 938         (setq buffers (delq cur-buf buffers))
 939         (or (car (sort buffers #'dired-buffer-more-recently-used-p))
 940             ;; ---unless it's the only possibility:
 941             (and cur-buf-matches cur-buf)))
 942     ;; No dired-x, or dired-find-subdir nil.
 943     (setq dirname (expand-file-name dirname))
 944     (let (found (blist dired-buffers))    ; was (buffer-list)
 945       (or mode (setq mode 'dired-mode))
 946       (while blist
 947         (if (null (buffer-name (cdr (car blist))))
 948             (setq blist (cdr blist))
 949           (with-current-buffer (cdr (car blist))
 950             (if (and (eq major-mode mode)
 951                      dired-directory  ;; nil during find-alternate-file
 952                      (equal dirname
 953                             (expand-file-name
 954                              (if (consp dired-directory)
 955                                  (car dired-directory)
 956                                dired-directory))))
 957                 (setq found (cdr (car blist))
 958                       blist nil)
 959               (setq blist (cdr blist))))))
 960       found)))
 961
 962 \f
 963 ;; Read in a new dired buffer
 964
 965 (defun dired-readin ()
 966   "Read in a new Dired buffer.
 967 Differs from `dired-insert-subdir' in that it accepts
 968 wildcards, erases the buffer, and builds the subdir-alist anew
 969 \(including making it buffer-local and clearing it first)."
 970
 971   ;; default-directory and dired-actual-switches must be buffer-local
 972   ;; and initialized by now.
 973   (let (dirname
 974         ;; This makes readin much much faster.
 975         ;; In particular, it prevents the font lock hook from running
 976         ;; until the directory is all read in.
 977         (inhibit-modification-hooks t))
 978     (if (consp dired-directory)
 979         (setq dirname (car dired-directory))
 980       (setq dirname dired-directory))
 981     (setq dirname (expand-file-name dirname))
 982     (save-excursion
 983       ;; This hook which may want to modify dired-actual-switches
 984       ;; based on dired-directory, e.g. with ange-ftp to a SysV host
 985       ;; where ls won't understand -Al switches.
 986       (run-hooks 'dired-before-readin-hook)
 987       (if (consp buffer-undo-list)
 988           (setq buffer-undo-list nil))
 989       (setq-local file-name-coding-system
 990                   (or coding-system-for-read file-name-coding-system))
 991       (let ((inhibit-read-only t)
 992             ;; Don't make undo entries for readin.
 993             (buffer-undo-list t))
 994         (widen)
 995         (erase-buffer)
 996         (dired-readin-insert))
 997       (goto-char (point-min))
 998       ;; Must first make alist buffer local and set it to nil because
 999       ;; dired-build-subdir-alist will call dired-clear-alist first
1000       (setq-local dired-subdir-alist nil)
1001       (dired-build-subdir-alist)
1002       (let ((attributes (file-attributes dirname)))
1003         (if (eq (car attributes) t)
1004             (set-visited-file-modtime (nth 5 attributes))))
1005       (set-buffer-modified-p nil)
1006       ;; No need to narrow since the whole buffer contains just
1007       ;; dired-readin's output, nothing else.  The hook can
1008       ;; successfully use dired functions (e.g. dired-get-filename)
1009       ;; as the subdir-alist has been built in dired-readin.
1010       (run-hooks 'dired-after-readin-hook))))
1011
1012 ;; Subroutines of dired-readin
1013
1014 (defun dired-readin-insert ()
1015   ;; Insert listing for the specified dir (and maybe file list)
1016   ;; already in dired-directory, assuming a clean buffer.
1017   (let (dir file-list)
1018     (if (consp dired-directory)
1019         (setq dir (car dired-directory)
1020               file-list (cdr dired-directory))
1021       (setq dir dired-directory
1022             file-list nil))
1023     (setq dir (expand-file-name dir))
1024     (if (and (equal "" (file-name-nondirectory dir))
1025              (not file-list))
1026         ;; If we are reading a whole single directory...
1027         (dired-insert-directory dir dired-actual-switches nil nil t)
1028       (if (not (file-readable-p
1029                 (directory-file-name (file-name-directory dir))))
1030           (error "Directory %s inaccessible or nonexistent" dir)
1031         ;; Else treat it as a wildcard spec
1032         ;; unless we have an explicit list of files.
1033         (dired-insert-directory dir dired-actual-switches
1034                                 file-list (not file-list) t)))))
1035
1036 (defun dired-align-file (beg end)
1037   "Align the fields of a file to the ones of surrounding lines.
1038 BEG..END is the line where the file info is located."
1039   ;; Some versions of ls try to adjust the size of each field so as to just
1040   ;; hold the largest element ("largest" in the current invocation, of
1041   ;; course).  So when a single line is output, the size of each field is
1042   ;; just big enough for that one output.  Thus when dired refreshes one
1043   ;; line, the alignment if this line w.r.t the rest is messed up because
1044   ;; the fields of that one line will generally be smaller.
1045   ;;
1046   ;; To work around this problem, we here add spaces to try and
1047   ;; re-align the fields as needed.  Since this is purely aesthetic,
1048   ;; it is of utmost importance that it doesn't mess up anything like
1049   ;; `dired-move-to-filename'.  To this end, we limit ourselves to
1050   ;; adding spaces only, and to only add them at places where there
1051   ;; was already at least one space.  This way, as long as
1052   ;; `directory-listing-before-filename-regexp' always matches spaces
1053   ;; with "*" or "+", we know we haven't made anything worse.  There
1054   ;; is one spot where the exact number of spaces is important, which
1055   ;; is just before the actual filename, so we refrain from adding
1056   ;; spaces there (and within the filename as well, of course).
1057   (save-excursion
1058     (let (file file-col other other-col)
1059       ;; Check that there is indeed a file, and that there is another adjacent
1060       ;; file with which to align, and that additional spaces are needed to
1061       ;; align the filenames.
1062       (when (and (setq file (progn (goto-char beg)
1063                                    (dired-move-to-filename nil end)))
1064                  (setq file-col (current-column))
1065                  (setq other
1066                        (or (and (goto-char beg)
1067                                 (zerop (forward-line -1))
1068                                 (dired-move-to-filename))
1069                            (and (goto-char beg)
1070                                 (zerop (forward-line 1))
1071                                 (dired-move-to-filename))))
1072                  (setq other-col (current-column))
1073                  (/= file other)
1074                  ;; Make sure there is some work left to do.
1075                  (> other-col file-col))
1076         ;; If we've only looked at the line above, check to see if the line
1077         ;; below exists as well and if so, align with the shorter one.
1078         (when (and (< other file)
1079                    (goto-char beg)
1080                    (zerop (forward-line 1))
1081                    (dired-move-to-filename))
1082           (let ((alt-col (current-column)))
1083             (when (< alt-col other-col)
1084               (setq other-col alt-col)
1085               (setq other (point)))))
1086         ;; Keep positions uptodate when we insert stuff.
1087         (if (> other file) (setq other (copy-marker other)))
1088         (setq file (copy-marker file))
1089         ;; Main loop.
1090         (goto-char beg)
1091         (skip-chars-forward " ")        ;Skip to the first field.
1092         (while (and (> other-col file-col)
1093                     ;; Don't touch anything just before (and after) the
1094                     ;; beginning of the filename.
1095                     (> file (point)))
1096           ;; We're now just in front of a field, with a space behind us.
1097           (let* ((curcol (current-column))
1098                  ;; Nums are right-aligned.
1099                  (num-align (looking-at-p "[0-9]"))
1100                  ;; Let's look at the other line, in the same column: we
1101                  ;; should be either near the end of the previous field, or
1102                  ;; in the space between that field and the next.
1103                  ;; [ Of course, it's also possible that we're already within
1104                  ;; the next field or even past it, but that's unlikely since
1105                  ;; other-col > file-col. ]
1106                  ;; Let's find the distance to the alignment-point (either
1107                  ;; the beginning or the end of the next field, depending on
1108                  ;; whether this field is left or right aligned).
1109                  (align-pt-offset
1110                   (save-excursion
1111                     (goto-char other)
1112                     (move-to-column curcol)
1113                     (when (looking-at
1114                            (concat
1115                             (if (eq (char-before) ?\s) " *" "[^ ]* *")
1116                             (if num-align "[0-9][^ ]*")))
1117                       (- (match-end 0) (match-beginning 0)))))
1118                  ;; Now, the number of spaces to insert is align-pt-offset
1119                  ;; minus the distance to the equivalent point on the
1120                  ;; current line.
1121                  (spaces
1122                   (if (not num-align)
1123                       align-pt-offset
1124                     (and align-pt-offset
1125                          (save-excursion
1126                            (skip-chars-forward "^ ")
1127                            (- align-pt-offset (- (current-column) curcol)))))))
1128             (when (and spaces (> spaces 0))
1129               (setq file-col (+ spaces file-col))
1130               (if (> file-col other-col)
1131                   (setq spaces (- spaces (- file-col other-col))))
1132               (insert-char ?\s spaces)
1133               ;; Let's just make really sure we did not mess up.
1134               (unless (save-excursion
1135                         (eq (dired-move-to-filename) (marker-position file)))
1136                 ;; Damn!  We messed up: let's revert the change.
1137                 (delete-char (- spaces)))))
1138           ;; Now skip to next field.
1139           (skip-chars-forward "^ ") (skip-chars-forward " "))
1140         (set-marker file nil)))))
1141
1142
1143 (defvar ls-lisp-use-insert-directory-program)
1144
1145 (defun dired-check-switches (switches short &optional long)
1146   "Return non-nil if the string SWITCHES matches LONG or SHORT format."
1147   (let (case-fold-search)
1148     (and (stringp switches)
1149          (string-match-p (concat "\\(\\`\\| \\)-[[:alnum:]]*" short
1150                                  (if long (concat "\\|--" long "\\>") ""))
1151                          switches))))
1152
1153 (defun dired-switches-escape-p (switches)
1154   "Return non-nil if the string SWITCHES contains -b or --escape."
1155   ;; Do not match things like "--block-size" that happen to contain "b".
1156   (dired-check-switches switches "b" "escape"))
1157
1158 (defun dired-switches-recursive-p (switches)
1159   "Return non-nil if the string SWITCHES contains -R or --recursive."
1160   (dired-check-switches switches "R" "recursive"))
1161
1162 (defun dired-insert-directory (dir switches &optional file-list wildcard hdr)
1163   "Insert a directory listing of DIR, Dired style.
1164 Use SWITCHES to make the listings.
1165 If FILE-LIST is non-nil, list only those files.
1166 Otherwise, if WILDCARD is non-nil, expand wildcards;
1167  in that case, DIR should be a file name that uses wildcards.
1168 In other cases, DIR should be a directory name or a directory filename.
1169 If HDR is non-nil, insert a header line with the directory name."
1170   (let ((opoint (point))
1171         (process-environment (copy-sequence process-environment))
1172         end)
1173     (if (and
1174          ;; Don't try to invoke `ls' if we are on DOS/Windows where
1175          ;; ls-lisp emulation is used, except if they want to use `ls'
1176          ;; as indicated by `ls-lisp-use-insert-directory-program'.
1177          (not (and (featurep 'ls-lisp)
1178                    (null ls-lisp-use-insert-directory-program)))
1179          (or (if (eq dired-use-ls-dired 'unspecified)
1180                  ;; Check whether "ls --dired" gives exit code 0, and
1181                  ;; save the answer in `dired-use-ls-dired'.
1182                  (or (setq dired-use-ls-dired
1183                            (eq 0 (call-process insert-directory-program
1184                                              nil nil nil "--dired")))
1185                      (progn
1186                        (message "ls does not support --dired; \
1187 see `dired-use-ls-dired' for more details.")
1188                        nil))
1189                dired-use-ls-dired)
1190              (file-remote-p dir)))
1191         (setq switches (concat "--dired " switches)))
1192     ;; We used to specify the C locale here, to force English month names;
1193     ;; but this should not be necessary any more,
1194     ;; with the new value of `directory-listing-before-filename-regexp'.
1195     (if file-list
1196         (dolist (f file-list)
1197           (let ((beg (point)))
1198             (insert-directory f switches nil nil)
1199             ;; Re-align fields, if necessary.
1200             (dired-align-file beg (point))))
1201       (insert-directory dir switches wildcard (not wildcard)))
1202     ;; Quote certain characters, unless ls quoted them for us.
1203     (if (not (dired-switches-escape-p dired-actual-switches))
1204         (save-excursion
1205           (setq end (point-marker))
1206           (goto-char opoint)
1207           (while (search-forward "\\" end t)
1208             (replace-match (apply #'propertize
1209                                   "\\\\"
1210                                   (text-properties-at (match-beginning 0)))
1211                            nil t))
1212           (goto-char opoint)
1213           (while (search-forward "\^m" end t)
1214             (replace-match (apply #'propertize
1215                                   "\\015"
1216                                   (text-properties-at (match-beginning 0)))
1217                            nil t))
1218           (set-marker end nil))
1219       ;; Replace any newlines in DIR with literal "\n"s, for the sake
1220       ;; of the header line.  To disambiguate a literal "\n" in the
1221       ;; actual dirname, we also replace "\" with "\\".
1222       ;; Personally, I think this should always be done, irrespective
1223       ;; of the value of dired-actual-switches, because:
1224       ;;  i) Dired simply does not work with an unescaped newline in
1225       ;;  the directory name used in the header (bug=10469#28), and
1226       ;;  ii) "\" is always replaced with "\\" in the listing, so doing
1227       ;;  it in the header as well makes things consistent.
1228       ;; But at present it is only done if "-b" is in ls-switches,
1229       ;; because newlines in dirnames are uncommon, and people may
1230       ;; have gotten used to seeing unescaped "\" in the headers.
1231       ;; Note: adjust dired-build-subdir-alist if you change this.
1232       (setq dir (replace-regexp-in-string "\\\\" "\\\\" dir nil t)
1233             dir (replace-regexp-in-string "\n" "\\n" dir nil t)))
1234     ;; If we used --dired and it worked, the lines are already indented.
1235     ;; Otherwise, indent them.
1236     (unless (save-excursion
1237               (goto-char opoint)
1238               (looking-at-p "  "))
1239       (let ((indent-tabs-mode nil))
1240         (indent-rigidly opoint (point) 2)))
1241     ;; Insert text at the beginning to standardize things.
1242     (let ((content-point opoint))
1243       (save-excursion
1244         (goto-char opoint)
1245         (when (and (or hdr wildcard)
1246                    (not (and (looking-at "^  \\(.*\\):$")
1247                              (file-name-absolute-p (match-string 1)))))
1248           ;; Note that dired-build-subdir-alist will replace the name
1249           ;; by its expansion, so it does not matter whether what we insert
1250           ;; here is fully expanded, but it should be absolute.
1251           (insert "  " (directory-file-name (file-name-directory dir)) ":\n")
1252           (setq content-point (point)))
1253         (when wildcard
1254           ;; Insert "wildcard" line where "total" line would be for a full dir.
1255           (insert "  wildcard " (file-name-nondirectory dir) "\n")))
1256       (dired-insert-set-properties content-point (point)))))
1257
1258 (defun dired-insert-set-properties (beg end)
1259   "Add various text properties to the lines in the region."
1260   (save-excursion
1261     (goto-char beg)
1262     (while (< (point) end)
1263       (ignore-errors
1264         (if (not (dired-move-to-filename))
1265             (unless (or (looking-at-p "^$")
1266                         (looking-at-p dired-subdir-regexp))
1267               (put-text-property (line-beginning-position)
1268                                  (1+ (line-end-position))
1269                                  'invisible 'dired-hide-details-information))
1270           (put-text-property (+ (line-beginning-position) 1) (1- (point))
1271                              'invisible 'dired-hide-details-detail)
1272           (add-text-properties
1273            (point)
1274            (progn
1275              (dired-move-to-end-of-filename)
1276              (point))
1277            '(mouse-face
1278              highlight
1279              dired-filename t
1280              help-echo "mouse-2: visit this file in other window"))
1281           (when (< (+ (point) 4) (line-end-position))
1282             (put-text-property (+ (point) 4) (line-end-position)
1283                                'invisible 'dired-hide-details-link))))
1284       (forward-line 1))))
1285 \f
1286 ;; Reverting a dired buffer
1287
1288 (defun dired-revert (&optional _arg _noconfirm)
1289   "Reread the Dired buffer.
1290 Must also be called after `dired-actual-switches' have changed.
1291 Should not fail even on completely garbaged buffers.
1292 Preserves old cursor, marks/flags, hidden-p.
1293
1294 Dired sets `revert-buffer-function' to this function.  The args
1295 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1296   (widen)                               ; just in case user narrowed
1297   (let ((modflag (buffer-modified-p))
1298         (positions (dired-save-positions))
1299         (mark-alist nil)                ; save marked files
1300         (hidden-subdirs (dired-remember-hidden))
1301         (old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
1302         (case-fold-search nil)          ; we check for upper case ls flags
1303         (inhibit-read-only t))
1304     (goto-char (point-min))
1305     (setq mark-alist;; only after dired-remember-hidden since this unhides:
1306           (dired-remember-marks (point-min) (point-max)))
1307     ;; treat top level dir extra (it may contain wildcards)
1308     (if (not (consp dired-directory))
1309         (dired-uncache dired-directory)
1310       (dired-uncache (car dired-directory))
1311       (dolist (dir (cdr dired-directory))
1312         (if (file-name-absolute-p dir)
1313             (dired-uncache dir))))
1314     ;; Run dired-after-readin-hook just once, below.
1315     (let ((dired-after-readin-hook nil))
1316       (dired-readin)
1317       (dired-insert-old-subdirs old-subdir-alist))
1318     (dired-mark-remembered mark-alist)  ; mark files that were marked
1319     ;; ... run the hook for the whole buffer, and only after markers
1320     ;; have been reinserted (else omitting in dired-x would omit marked files)
1321     (run-hooks 'dired-after-readin-hook)        ; no need to narrow
1322     (dired-restore-positions positions)
1323     (save-excursion                     ; hide subdirs that were hidden
1324       (dolist (dir hidden-subdirs)
1325         (if (dired-goto-subdir dir)
1326             (dired-hide-subdir 1))))
1327     (unless modflag (restore-buffer-modified-p nil)))
1328   ;; outside of the let scope
1329 ;;;  Might as well not override the user if the user changed this.
1330 ;;;  (setq buffer-read-only t)
1331   )
1332
1333 ;; Subroutines of dired-revert
1334 ;; Some of these are also used when inserting subdirs.
1335
1336 (defun dired-save-positions ()
1337   "Return current positions in the buffer and all windows with this directory.
1338 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1339
1340 BUFFER-POSITION is the point position in the current Dired buffer.
1341 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1342
1343 WINDOW-POSITIONS are current positions in all windows displaying
1344 this dired buffer.  The window positions have the form (WINDOW
1345 DIRED-FILENAME WINDOW-POINT)."
1346   (list
1347    (list (current-buffer) (dired-get-filename nil t) (point))
1348    (mapcar (lambda (w)
1349              (list w
1350                    (with-selected-window w
1351                      (dired-get-filename nil t))
1352                    (window-point w)))
1353            (get-buffer-window-list nil 0 t))))
1354
1355 (defun dired-restore-positions (positions)
1356   "Restore POSITIONS saved with `dired-save-positions'."
1357   (let* ((buf-file-pos (nth 0 positions))
1358          (buffer (nth 0 buf-file-pos)))
1359     (unless (and (nth 1 buf-file-pos)
1360                  (dired-goto-file (nth 1 buf-file-pos)))
1361       (goto-char (nth 2 buf-file-pos))
1362       (dired-move-to-filename))
1363     (dolist (win-file-pos (nth 1 positions))
1364       ;; Ensure that window still displays the original buffer.
1365       (when (eq (window-buffer (nth 0 win-file-pos)) buffer)
1366         (with-selected-window (nth 0 win-file-pos)
1367           (unless (and (nth 1 win-file-pos)
1368                        (dired-goto-file (nth 1 win-file-pos)))
1369             (goto-char (nth 2 win-file-pos))
1370             (dired-move-to-filename)))))))
1371
1372 (defun dired-remember-marks (beg end)
1373   "Return alist of files and their marks, from BEG to END."
1374   (if selective-display                 ; must unhide to make this work.
1375       (let ((inhibit-read-only t))
1376         (subst-char-in-region beg end ?\r ?\n)))
1377   (let (fil chr alist)
1378     (save-excursion
1379       (goto-char beg)
1380       (while (re-search-forward dired-re-mark end t)
1381         (if (setq fil (dired-get-filename nil t))
1382             (setq chr (preceding-char)
1383                   alist (cons (cons fil chr) alist)))))
1384     alist))
1385
1386 (defun dired-mark-remembered (alist)
1387   "Mark all files remembered in ALIST.
1388 Each element of ALIST looks like (FILE . MARKERCHAR)."
1389   (let (elt fil chr)
1390     (save-excursion
1391       (while alist
1392         (setq elt (car alist)
1393               alist (cdr alist)
1394               fil (car elt)
1395               chr (cdr elt))
1396         (when (dired-goto-file fil)
1397           (beginning-of-line)
1398           (delete-char 1)
1399           (insert chr))))))
1400
1401 (defun dired-remember-hidden ()
1402   "Return a list of names of subdirs currently hidden."
1403   (let ((l dired-subdir-alist) dir pos result)
1404     (while l
1405       (setq dir (car (car l))
1406             pos (cdr (car l))
1407             l (cdr l))
1408       (goto-char pos)
1409       (skip-chars-forward "^\r\n")
1410       (if (eq (following-char) ?\r)
1411           (setq result (cons dir result))))
1412     result))
1413
1414 (defun dired-insert-old-subdirs (old-subdir-alist)
1415   "Try to insert all subdirs that were displayed before.
1416 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1417   (or (dired-switches-recursive-p dired-actual-switches)
1418       (let (elt dir)
1419         (while old-subdir-alist
1420           (setq elt (car old-subdir-alist)
1421                 old-subdir-alist (cdr old-subdir-alist)
1422                 dir (car elt))
1423           (ignore-errors
1424             (dired-uncache dir)
1425             (dired-insert-subdir dir))))))
1426
1427 (defun dired-uncache (dir)
1428   "Remove directory DIR from any directory cache."
1429   (let ((handler (find-file-name-handler dir 'dired-uncache)))
1430     (if handler
1431         (funcall handler 'dired-uncache dir))))
1432 \f
1433 ;; dired mode key bindings and initialization
1434
1435 (defvar dired-mode-map
1436   ;; This looks ugly when substitute-command-keys uses C-d instead d:
1437   ;;  (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1438   (let ((map (make-keymap)))
1439     (set-keymap-parent map special-mode-map)
1440     (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
1441     (define-key map [follow-link] 'mouse-face)
1442     ;; Commands to mark or flag certain categories of files
1443     (define-key map "#" 'dired-flag-auto-save-files)
1444     (define-key map "." 'dired-clean-directory)
1445     (define-key map "~" 'dired-flag-backup-files)
1446     ;; Upper case keys (except !) for operating on the marked files
1447     (define-key map "A" 'dired-do-search)
1448     (define-key map "C" 'dired-do-copy)
1449     (define-key map "B" 'dired-do-byte-compile)
1450     (define-key map "D" 'dired-do-delete)
1451     (define-key map "G" 'dired-do-chgrp)
1452     (define-key map "H" 'dired-do-hardlink)
1453     (define-key map "L" 'dired-do-load)
1454     (define-key map "M" 'dired-do-chmod)
1455     (define-key map "O" 'dired-do-chown)
1456     (define-key map "P" 'dired-do-print)
1457     (define-key map "Q" 'dired-do-query-replace-regexp)
1458     (define-key map "R" 'dired-do-rename)
1459     (define-key map "S" 'dired-do-symlink)
1460     (define-key map "T" 'dired-do-touch)
1461     (define-key map "X" 'dired-do-shell-command)
1462     (define-key map "Z" 'dired-do-compress)
1463     (define-key map "!" 'dired-do-shell-command)
1464     (define-key map "&" 'dired-do-async-shell-command)
1465     ;; Comparison commands
1466     (define-key map "=" 'dired-diff)
1467     ;; Tree Dired commands
1468     (define-key map "\M-\C-?" 'dired-unmark-all-files)
1469     (define-key map "\M-\C-d" 'dired-tree-down)
1470     (define-key map "\M-\C-u" 'dired-tree-up)
1471     (define-key map "\M-\C-n" 'dired-next-subdir)
1472     (define-key map "\M-\C-p" 'dired-prev-subdir)
1473     ;; move to marked files
1474     (define-key map "\M-{" 'dired-prev-marked-file)
1475     (define-key map "\M-}" 'dired-next-marked-file)
1476     ;; Make all regexp commands share a `%' prefix:
1477     ;; We used to get to the submap via a symbol dired-regexp-prefix,
1478     ;; but that seems to serve little purpose, and copy-keymap
1479     ;; does a better job without it.
1480     (define-key map "%" nil)
1481     (define-key map "%u" 'dired-upcase)
1482     (define-key map "%l" 'dired-downcase)
1483     (define-key map "%d" 'dired-flag-files-regexp)
1484     (define-key map "%g" 'dired-mark-files-containing-regexp)
1485     (define-key map "%m" 'dired-mark-files-regexp)
1486     (define-key map "%r" 'dired-do-rename-regexp)
1487     (define-key map "%C" 'dired-do-copy-regexp)
1488     (define-key map "%H" 'dired-do-hardlink-regexp)
1489     (define-key map "%R" 'dired-do-rename-regexp)
1490     (define-key map "%S" 'dired-do-symlink-regexp)
1491     (define-key map "%&" 'dired-flag-garbage-files)
1492     ;; Commands for marking and unmarking.
1493     (define-key map "*" nil)
1494     (define-key map "**" 'dired-mark-executables)
1495     (define-key map "*/" 'dired-mark-directories)
1496     (define-key map "*@" 'dired-mark-symlinks)
1497     (define-key map "*%" 'dired-mark-files-regexp)
1498     (define-key map "*c" 'dired-change-marks)
1499     (define-key map "*s" 'dired-mark-subdir-files)
1500     (define-key map "*m" 'dired-mark)
1501     (define-key map "*u" 'dired-unmark)
1502     (define-key map "*?" 'dired-unmark-all-files)
1503     (define-key map "*!" 'dired-unmark-all-marks)
1504     (define-key map "U" 'dired-unmark-all-marks)
1505     (define-key map "*\177" 'dired-unmark-backward)
1506     (define-key map "*\C-n" 'dired-next-marked-file)
1507     (define-key map "*\C-p" 'dired-prev-marked-file)
1508     (define-key map "*t" 'dired-toggle-marks)
1509     ;; Lower keys for commands not operating on all the marked files
1510     (define-key map "a" 'dired-find-alternate-file)
1511     (define-key map "d" 'dired-flag-file-deletion)
1512     (define-key map "e" 'dired-find-file)
1513     (define-key map "f" 'dired-find-file)
1514     (define-key map "\C-m" 'dired-find-file)
1515     (put 'dired-find-file :advertised-binding "\C-m")
1516     (define-key map "g" 'revert-buffer)
1517     (define-key map "i" 'dired-maybe-insert-subdir)
1518     (define-key map "j" 'dired-goto-file)
1519     (define-key map "k" 'dired-do-kill-lines)
1520     (define-key map "l" 'dired-do-redisplay)
1521     (define-key map "m" 'dired-mark)
1522     (define-key map "n" 'dired-next-line)
1523     (define-key map "o" 'dired-find-file-other-window)
1524     (define-key map "\C-o" 'dired-display-file)
1525     (define-key map "p" 'dired-previous-line)
1526     (define-key map "s" 'dired-sort-toggle-or-edit)
1527     (define-key map "t" 'dired-toggle-marks)
1528     (define-key map "u" 'dired-unmark)
1529     (define-key map "v" 'dired-view-file)
1530     (define-key map "w" 'dired-copy-filename-as-kill)
1531     (define-key map "x" 'dired-do-flagged-delete)
1532     (define-key map "y" 'dired-show-file-type)
1533     (define-key map "+" 'dired-create-directory)
1534     ;; moving
1535     (define-key map "<" 'dired-prev-dirline)
1536     (define-key map ">" 'dired-next-dirline)
1537     (define-key map "^" 'dired-up-directory)
1538     (define-key map " "  'dired-next-line)
1539     (define-key map [remap next-line] 'dired-next-line)
1540     (define-key map [remap previous-line] 'dired-previous-line)
1541     ;; hiding
1542     (define-key map "$" 'dired-hide-subdir)
1543     (define-key map "\M-$" 'dired-hide-all)
1544     (define-key map "(" 'dired-hide-details-mode)
1545     ;; isearch
1546     (define-key map (kbd "M-s a C-s")   'dired-do-isearch)
1547     (define-key map (kbd "M-s a M-C-s") 'dired-do-isearch-regexp)
1548     (define-key map (kbd "M-s f C-s")   'dired-isearch-filenames)
1549     (define-key map (kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp)
1550     ;; misc
1551     (define-key map [remap read-only-mode] 'dired-toggle-read-only)
1552     ;; `toggle-read-only' is an obsolete alias for `read-only-mode'
1553     (define-key map [remap toggle-read-only] 'dired-toggle-read-only)
1554     (define-key map "?" 'dired-summary)
1555     (define-key map "\177" 'dired-unmark-backward)
1556     (define-key map [remap undo] 'dired-undo)
1557     (define-key map [remap advertised-undo] 'dired-undo)
1558     ;; thumbnail manipulation (image-dired)
1559     (define-key map "\C-td" 'image-dired-display-thumbs)
1560     (define-key map "\C-tt" 'image-dired-tag-files)
1561     (define-key map "\C-tr" 'image-dired-delete-tag)
1562     (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1563     (define-key map "\C-ti" 'image-dired-dired-display-image)
1564     (define-key map "\C-tx" 'image-dired-dired-display-external)
1565     (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1566     (define-key map "\C-t." 'image-dired-display-thumb)
1567     (define-key map "\C-tc" 'image-dired-dired-comment-files)
1568     (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1569     (define-key map "\C-t\C-t" 'image-dired-dired-toggle-marked-thumbs)
1570     (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1571     ;; encryption and decryption (epa-dired)
1572     (define-key map ":d" 'epa-dired-do-decrypt)
1573     (define-key map ":v" 'epa-dired-do-verify)
1574     (define-key map ":s" 'epa-dired-do-sign)
1575     (define-key map ":e" 'epa-dired-do-encrypt)
1576
1577     ;; Make menu bar items.
1578
1579     ;; No need to fo this, now that top-level items are fewer.
1580     ;;;;
1581     ;; Get rid of the Edit menu bar item to save space.
1582     ;(define-key map [menu-bar edit] 'undefined)
1583
1584     (define-key map [menu-bar subdir]
1585       (cons "Subdir" (make-sparse-keymap "Subdir")))
1586
1587     (define-key map [menu-bar subdir hide-all]
1588       '(menu-item "Hide All" dired-hide-all
1589                   :help "Hide all subdirectories, leave only header lines"))
1590     (define-key map [menu-bar subdir hide-subdir]
1591       '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1592                   :help "Hide or unhide current directory listing"))
1593     (define-key map [menu-bar subdir tree-down]
1594       '(menu-item "Tree Down" dired-tree-down
1595                   :help "Go to first subdirectory header down the tree"))
1596     (define-key map [menu-bar subdir tree-up]
1597       '(menu-item "Tree Up" dired-tree-up
1598                   :help "Go to first subdirectory header up the tree"))
1599     (define-key map [menu-bar subdir up]
1600       '(menu-item "Up Directory" dired-up-directory
1601                   :help "Edit the parent directory"))
1602     (define-key map [menu-bar subdir prev-subdir]
1603       '(menu-item "Prev Subdir" dired-prev-subdir
1604                   :help "Go to previous subdirectory header line"))
1605     (define-key map [menu-bar subdir next-subdir]
1606       '(menu-item "Next Subdir" dired-next-subdir
1607                   :help "Go to next subdirectory header line"))
1608     (define-key map [menu-bar subdir prev-dirline]
1609       '(menu-item "Prev Dirline" dired-prev-dirline
1610                   :help "Move to next directory-file line"))
1611     (define-key map [menu-bar subdir next-dirline]
1612       '(menu-item "Next Dirline" dired-next-dirline
1613                   :help "Move to previous directory-file line"))
1614     (define-key map [menu-bar subdir insert]
1615       '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1616                   :help "Insert contents of subdirectory"
1617                   :enable (let ((f (dired-get-filename nil t)))
1618                             (and f (file-directory-p f)))))
1619     (define-key map [menu-bar immediate]
1620       (cons "Immediate" (make-sparse-keymap "Immediate")))
1621
1622     (define-key map
1623       [menu-bar immediate image-dired-dired-display-external]
1624       '(menu-item "Display Image Externally" image-dired-dired-display-external
1625                   :help "Display image in external viewer"))
1626     (define-key map
1627       [menu-bar immediate image-dired-dired-display-image]
1628       '(menu-item "Display Image" image-dired-dired-display-image
1629                   :help "Display sized image in a separate window"))
1630     (define-key map
1631       [menu-bar immediate image-dired-dired-toggle-marked-thumbs]
1632       '(menu-item "Toggle Image Thumbnails in This Buffer" image-dired-dired-toggle-marked-thumbs
1633                   :help "Add or remove image thumbnails in front of marked file names"))
1634
1635     (define-key map [menu-bar immediate hide-details]
1636       '(menu-item "Hide Details" dired-hide-details-mode
1637                   :help "Hide details in buffer"
1638                   :button (:toggle . dired-hide-details-mode)))
1639     (define-key map [menu-bar immediate revert-buffer]
1640       '(menu-item "Refresh" revert-buffer
1641                   :help "Update contents of shown directories"))
1642
1643     (define-key map [menu-bar immediate dashes]
1644       '("--"))
1645
1646     (define-key map [menu-bar immediate isearch-filenames-regexp]
1647       '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1648                   :help "Incrementally search for regexp in file names only"))
1649     (define-key map [menu-bar immediate isearch-filenames]
1650       '(menu-item "Isearch in File Names..." dired-isearch-filenames
1651                   :help "Incrementally search for string in file names only."))
1652     (define-key map [menu-bar immediate compare-directories]
1653       '(menu-item "Compare Directories..." dired-compare-directories
1654                   :help "Mark files with different attributes in two Dired buffers"))
1655     (define-key map [menu-bar immediate backup-diff]
1656       '(menu-item "Compare with Backup" dired-backup-diff
1657                   :help "Diff file at cursor with its latest backup"))
1658     (define-key map [menu-bar immediate diff]
1659       '(menu-item "Diff..." dired-diff
1660                   :help "Compare file at cursor with another file"))
1661     (define-key map [menu-bar immediate view]
1662       '(menu-item "View This File" dired-view-file
1663                   :help "Examine file at cursor in read-only mode"))
1664     (define-key map [menu-bar immediate display]
1665       '(menu-item "Display in Other Window" dired-display-file
1666                   :help "Display file at cursor in other window"))
1667     (define-key map [menu-bar immediate find-file-other-window]
1668       '(menu-item "Find in Other Window" dired-find-file-other-window
1669                   :help "Edit file at cursor in other window"))
1670     (define-key map [menu-bar immediate find-file]
1671       '(menu-item "Find This File" dired-find-file
1672                   :help "Edit file at cursor"))
1673     (define-key map [menu-bar immediate create-directory]
1674       '(menu-item "Create Directory..." dired-create-directory
1675                   :help "Create a directory"))
1676     (define-key map [menu-bar immediate wdired-mode]
1677       '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1678                   :help "Put a Dired buffer in a mode in which filenames are editable"
1679                   :keys "C-x C-q"
1680                   :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1681
1682     (define-key map [menu-bar regexp]
1683       (cons "Regexp" (make-sparse-keymap "Regexp")))
1684
1685     (define-key map
1686       [menu-bar regexp image-dired-mark-tagged-files]
1687       '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1688                   :help "Mark files whose image tags matches regexp"))
1689
1690     (define-key map [menu-bar regexp dashes-1]
1691       '("--"))
1692
1693     (define-key map [menu-bar regexp downcase]
1694       '(menu-item "Downcase" dired-downcase
1695                   ;; When running on plain MS-DOS, there's only one
1696                   ;; letter-case for file names.
1697                   :enable (or (not (fboundp 'msdos-long-file-names))
1698                               (msdos-long-file-names))
1699                   :help "Rename marked files to lower-case name"))
1700     (define-key map [menu-bar regexp upcase]
1701       '(menu-item "Upcase" dired-upcase
1702                   :enable (or (not (fboundp 'msdos-long-file-names))
1703                               (msdos-long-file-names))
1704                   :help "Rename marked files to upper-case name"))
1705     (define-key map [menu-bar regexp hardlink]
1706       '(menu-item "Hardlink..." dired-do-hardlink-regexp
1707                   :help "Make hard links for files matching regexp"))
1708     (define-key map [menu-bar regexp symlink]
1709       '(menu-item "Symlink..." dired-do-symlink-regexp
1710                   :visible (fboundp 'make-symbolic-link)
1711                   :help "Make symbolic links for files matching regexp"))
1712     (define-key map [menu-bar regexp rename]
1713       '(menu-item "Rename..." dired-do-rename-regexp
1714                   :help "Rename marked files matching regexp"))
1715     (define-key map [menu-bar regexp copy]
1716       '(menu-item "Copy..." dired-do-copy-regexp
1717                   :help "Copy marked files matching regexp"))
1718     (define-key map [menu-bar regexp flag]
1719       '(menu-item "Flag..." dired-flag-files-regexp
1720                   :help "Flag files matching regexp for deletion"))
1721     (define-key map [menu-bar regexp mark]
1722       '(menu-item "Mark..." dired-mark-files-regexp
1723                   :help "Mark files matching regexp for future operations"))
1724     (define-key map [menu-bar regexp mark-cont]
1725       '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1726                   :help "Mark files whose contents matches regexp"))
1727
1728     (define-key map [menu-bar mark]
1729       (cons "Mark" (make-sparse-keymap "Mark")))
1730
1731     (define-key map [menu-bar mark prev]
1732       '(menu-item "Previous Marked" dired-prev-marked-file
1733                   :help "Move to previous marked file"))
1734     (define-key map [menu-bar mark next]
1735       '(menu-item "Next Marked" dired-next-marked-file
1736                   :help "Move to next marked file"))
1737     (define-key map [menu-bar mark marks]
1738       '(menu-item "Change Marks..." dired-change-marks
1739                   :help "Replace marker with another character"))
1740     (define-key map [menu-bar mark unmark-all]
1741       '(menu-item "Unmark All" dired-unmark-all-marks))
1742     (define-key map [menu-bar mark symlinks]
1743       '(menu-item "Mark Symlinks" dired-mark-symlinks
1744                   :visible (fboundp 'make-symbolic-link)
1745                   :help "Mark all symbolic links"))
1746     (define-key map [menu-bar mark directories]
1747       '(menu-item "Mark Directories" dired-mark-directories
1748                   :help "Mark all directories except `.' and `..'"))
1749     (define-key map [menu-bar mark directory]
1750       '(menu-item "Mark Old Backups" dired-clean-directory
1751                   :help "Flag old numbered backups for deletion"))
1752     (define-key map [menu-bar mark executables]
1753       '(menu-item "Mark Executables" dired-mark-executables
1754                   :help "Mark all executable files"))
1755     (define-key map [menu-bar mark garbage-files]
1756       '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1757                   :help "Flag unneeded files for deletion"))
1758     (define-key map [menu-bar mark backup-files]
1759       '(menu-item "Flag Backup Files" dired-flag-backup-files
1760                   :help "Flag all backup files for deletion"))
1761     (define-key map [menu-bar mark auto-save-files]
1762       '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1763                   :help "Flag auto-save files for deletion"))
1764     (define-key map [menu-bar mark deletion]
1765       '(menu-item "Flag" dired-flag-file-deletion
1766                   :help "Flag current line's file for deletion"))
1767     (define-key map [menu-bar mark unmark]
1768       '(menu-item "Unmark" dired-unmark
1769                   :help "Unmark or unflag current line's file"))
1770     (define-key map [menu-bar mark mark]
1771       '(menu-item "Mark" dired-mark
1772                   :help "Mark current line's file for future operations"))
1773     (define-key map [menu-bar mark toggle-marks]
1774       '(menu-item "Toggle Marks" dired-toggle-marks
1775                   :help "Mark unmarked files, unmark marked ones"))
1776
1777     (define-key map [menu-bar operate]
1778       (cons "Operate" (make-sparse-keymap "Operate")))
1779
1780     (define-key map
1781       [menu-bar operate image-dired-delete-tag]
1782       '(menu-item "Delete Image Tag..." image-dired-delete-tag
1783                   :help "Delete image tag from current or marked files"))
1784     (define-key map
1785       [menu-bar operate image-dired-tag-files]
1786       '(menu-item "Add Image Tags..." image-dired-tag-files
1787                   :help "Add image tags to current or marked files"))
1788     (define-key map
1789       [menu-bar operate image-dired-dired-comment-files]
1790       '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1791                   :help "Add image comment to current or marked files"))
1792     (define-key map
1793       [menu-bar operate image-dired-display-thumbs]
1794       '(menu-item "Display Image Thumbnails" image-dired-display-thumbs
1795                   :help "Display image thumbnails for current or marked image files"))
1796
1797     (define-key map [menu-bar operate dashes-4]
1798       '("--"))
1799
1800     (define-key map
1801       [menu-bar operate epa-dired-do-decrypt]
1802       '(menu-item "Decrypt..." epa-dired-do-decrypt
1803                   :help "Decrypt current or marked files"))
1804
1805     (define-key map
1806       [menu-bar operate epa-dired-do-verify]
1807       '(menu-item "Verify" epa-dired-do-verify
1808                   :help "Verify digital signature of current or marked files"))
1809
1810     (define-key map
1811       [menu-bar operate epa-dired-do-sign]
1812       '(menu-item "Sign..." epa-dired-do-sign
1813                   :help "Create digital signature of current or marked files"))
1814
1815     (define-key map
1816       [menu-bar operate epa-dired-do-encrypt]
1817       '(menu-item "Encrypt..." epa-dired-do-encrypt
1818                   :help "Encrypt current or marked files"))
1819
1820     (define-key map [menu-bar operate dashes-3]
1821       '("--"))
1822
1823     (define-key map [menu-bar operate query-replace]
1824       '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1825                   :help "Replace regexp in marked files"))
1826     (define-key map [menu-bar operate search]
1827       '(menu-item "Search Files..." dired-do-search
1828                   :help "Search marked files for regexp"))
1829     (define-key map [menu-bar operate isearch-regexp]
1830       '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1831                   :help "Incrementally search marked files for regexp"))
1832     (define-key map [menu-bar operate isearch]
1833       '(menu-item "Isearch Files..." dired-do-isearch
1834                   :help "Incrementally search marked files for string"))
1835     (define-key map [menu-bar operate chown]
1836       '(menu-item "Change Owner..." dired-do-chown
1837                   :visible (not (memq system-type '(ms-dos windows-nt)))
1838                   :help "Change the owner of marked files"))
1839     (define-key map [menu-bar operate chgrp]
1840       '(menu-item "Change Group..." dired-do-chgrp
1841                   :visible (not (memq system-type '(ms-dos windows-nt)))
1842                   :help "Change the group of marked files"))
1843     (define-key map [menu-bar operate chmod]
1844       '(menu-item "Change Mode..." dired-do-chmod
1845                   :help "Change mode (attributes) of marked files"))
1846     (define-key map [menu-bar operate touch]
1847       '(menu-item "Change Timestamp..." dired-do-touch
1848                   :help "Change timestamp of marked files"))
1849     (define-key map [menu-bar operate load]
1850       '(menu-item "Load" dired-do-load
1851                   :help "Load marked Emacs Lisp files"))
1852     (define-key map [menu-bar operate compile]
1853       '(menu-item "Byte-compile" dired-do-byte-compile
1854                   :help "Byte-compile marked Emacs Lisp files"))
1855     (define-key map [menu-bar operate compress]
1856       '(menu-item "Compress" dired-do-compress
1857                   :help "Compress/uncompress marked files"))
1858     (define-key map [menu-bar operate print]
1859       '(menu-item "Print..." dired-do-print
1860                   :help "Ask for print command and print marked files"))
1861     (define-key map [menu-bar operate hardlink]
1862       '(menu-item "Hardlink to..." dired-do-hardlink
1863                   :help "Make hard links for current or marked files"))
1864     (define-key map [menu-bar operate symlink]
1865       '(menu-item "Symlink to..." dired-do-symlink
1866                   :visible (fboundp 'make-symbolic-link)
1867                   :help "Make symbolic links for current or marked files"))
1868     (define-key map [menu-bar operate async-command]
1869       '(menu-item "Asynchronous Shell Command..." dired-do-async-shell-command
1870                   :help "Run a shell command asynchronously on current or marked files"))
1871     (define-key map [menu-bar operate command]
1872       '(menu-item "Shell Command..." dired-do-shell-command
1873                   :help "Run a shell command on current or marked files"))
1874     (define-key map [menu-bar operate delete]
1875       '(menu-item "Delete" dired-do-delete
1876                   :help "Delete current file or all marked files"))
1877     (define-key map [menu-bar operate rename]
1878       '(menu-item "Rename to..." dired-do-rename
1879                   :help "Rename current file or move marked files"))
1880     (define-key map [menu-bar operate copy]
1881       '(menu-item "Copy to..." dired-do-copy
1882                   :help "Copy current file or all marked files"))
1883
1884     map)
1885   "Local keymap for Dired mode buffers.")
1886 \f
1887 ;; Dired mode is suitable only for specially formatted data.
1888 (put 'dired-mode 'mode-class 'special)
1889
1890 ;; Autoload cookie needed by desktop.el
1891 ;;;###autoload
1892 (defun dired-mode (&optional dirname switches)
1893   "\
1894 Mode for \"editing\" directory listings.
1895 In Dired, you are \"editing\" a list of the files in a directory and
1896   (optionally) its subdirectories, in the format of `ls -lR'.
1897   Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1898 \"Editing\" means that you can run shell commands on files, visit,
1899   compress, load or byte-compile them, change their file attributes
1900   and insert subdirectories into the same buffer.  You can \"mark\"
1901   files for later commands or \"flag\" them for deletion, either file
1902   by file or all files matching certain criteria.
1903 You can move using the usual cursor motion commands.\\<dired-mode-map>
1904 The buffer is read-only.  Digits are prefix arguments.
1905 Type \\[dired-flag-file-deletion] to flag a file `D' for deletion.
1906 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1907   Most commands operate on the marked files and use the current file
1908   if no files are marked.  Use a numeric prefix argument to operate on
1909   the next ARG (or previous -ARG if ARG<0) files, or just `1'
1910   to operate on the current file only.  Prefix arguments override marks.
1911   Mark-using commands display a list of failures afterwards.  Type \\[dired-summary]
1912   to see why something went wrong.
1913 Type \\[dired-unmark] to Unmark a file or all files of an inserted subdirectory.
1914 Type \\[dired-unmark-backward] to back up one line and unmark or unflag.
1915 Type \\[dired-do-flagged-delete] to delete (eXpunge) the files flagged `D'.
1916 Type \\[dired-find-file] to Find the current line's file
1917   (or dired it in another buffer, if it is a directory).
1918 Type \\[dired-find-file-other-window] to find file or Dired directory in Other window.
1919 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1920 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1921 Type \\[dired-do-copy] to Copy files.
1922 Type \\[dired-sort-toggle-or-edit] to toggle Sorting by name/date or change the `ls' switches.
1923 Type \\[revert-buffer] to read all currently expanded directories aGain.
1924   This retains all marks and hides subdirs again that were hidden before.
1925 Use `SPC' and `DEL' to move down and up by lines.
1926
1927 If Dired ever gets confused, you can either type \\[revert-buffer] \
1928 to read the
1929 directories again, type \\[dired-do-redisplay] \
1930 to relist the file at point or the marked files or a
1931 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1932 again for the directory tree.
1933
1934 Customization variables (rename this buffer and type \\[describe-variable] on each line
1935 for more info):
1936
1937   `dired-listing-switches'
1938   `dired-trivial-filenames'
1939   `dired-marker-char'
1940   `dired-del-marker'
1941   `dired-keep-marker-rename'
1942   `dired-keep-marker-copy'
1943   `dired-keep-marker-hardlink'
1944   `dired-keep-marker-symlink'
1945
1946 Hooks (use \\[describe-variable] to see their documentation):
1947
1948   `dired-before-readin-hook'
1949   `dired-after-readin-hook'
1950   `dired-mode-hook'
1951   `dired-load-hook'
1952
1953 Keybindings:
1954 \\{dired-mode-map}"
1955   ;; Not to be called interactively (e.g. dired-directory will be set
1956   ;; to default-directory, which is wrong with wildcards).
1957   (kill-all-local-variables)
1958   (use-local-map dired-mode-map)
1959   (dired-advertise)                     ; default-directory is already set
1960   (setq major-mode 'dired-mode
1961         mode-name "Dired"
1962         ;; case-fold-search nil
1963         buffer-read-only t
1964         selective-display t             ; for subdirectory hiding
1965         mode-line-buffer-identification
1966         (propertized-buffer-identification "%17b"))
1967   ;; Ignore dired-hide-details-* value of invisible text property by default.
1968   (when (eq buffer-invisibility-spec t)
1969     (setq buffer-invisibility-spec (list t)))
1970   (setq-local revert-buffer-function (function dired-revert))
1971   (setq-local buffer-stale-function (function dired-buffer-stale-p))
1972   (setq-local page-delimiter "\n\n")
1973   (setq-local dired-directory (or dirname default-directory))
1974   ;; list-buffers uses this to display the dir being edited in this buffer.
1975   (setq list-buffers-directory
1976         (expand-file-name (if (listp dired-directory)
1977                               (car dired-directory)
1978                             dired-directory)))
1979   (setq-local dired-actual-switches (or switches dired-listing-switches))
1980   (setq-local font-lock-defaults
1981               '(dired-font-lock-keywords t nil nil beginning-of-line))
1982   (setq-local desktop-save-buffer 'dired-desktop-buffer-misc-data)
1983   (setq dired-switches-alist nil)
1984   (hack-dir-local-variables-non-file-buffer) ; before sorting
1985   (dired-sort-other dired-actual-switches t)
1986   (when (featurep 'dnd)
1987     (setq-local dnd-protocol-alist
1988                 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1989   (add-hook 'file-name-at-point-functions 'dired-file-name-at-point nil t)
1990   (add-hook 'isearch-mode-hook 'dired-isearch-filenames-setup nil t)
1991   (run-mode-hooks 'dired-mode-hook))
1992 \f
1993 ;; Idiosyncratic dired commands that don't deal with marks.
1994
1995 (defun dired-summary ()
1996   "Summarize basic Dired commands and show recent Dired errors."
1997   (interactive)
1998   (dired-why)
1999   ;>> this should check the key-bindings and use substitute-command-keys if non-standard
2000   (message
2001    "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
2002
2003 (defun dired-undo ()
2004   "Undo in a Dired buffer.
2005 This doesn't recover lost files, it just undoes changes in the buffer itself.
2006 You can use it to recover marks, killed lines or subdirs."
2007   (interactive)
2008   (let ((inhibit-read-only t))
2009     (undo))
2010   (dired-build-subdir-alist)
2011   (message "Change in Dired buffer undone.
2012 Actual changes in files cannot be undone by Emacs."))
2013
2014 (defun dired-toggle-read-only ()
2015   "Edit Dired buffer with Wdired, or make it read-only.
2016 If the current buffer can be edited with Wdired, (i.e. the major
2017 mode is `dired-mode'), call `wdired-change-to-wdired-mode'.
2018 Otherwise, call `toggle-read-only'."
2019   (interactive)
2020   (if (derived-mode-p 'dired-mode)
2021       (wdired-change-to-wdired-mode)
2022     (read-only-mode 'toggle)))
2023
2024 (defun dired-next-line (arg)
2025   "Move down lines then position at filename.
2026 Optional prefix ARG says how many lines to move; default is one line."
2027   (interactive "p")
2028   (let ((line-move-visual)
2029         (goal-column))
2030     (line-move arg t))
2031   ;; We never want to move point into an invisible line.
2032   (while (and (invisible-p (point))
2033               (not (if (and arg (< arg 0)) (bobp) (eobp))))
2034     (forward-char (if (and arg (< arg 0)) -1 1)))
2035   (dired-move-to-filename))
2036
2037 (defun dired-previous-line (arg)
2038   "Move up lines then position at filename.
2039 Optional prefix ARG says how many lines to move; default is one line."
2040   (interactive "p")
2041   (dired-next-line (- (or arg 1))))
2042
2043 (defun dired-next-dirline (arg &optional opoint)
2044   "Goto ARGth next directory file line."
2045   (interactive "p")
2046   (or opoint (setq opoint (point)))
2047   (if (if (> arg 0)
2048           (re-search-forward dired-re-dir nil t arg)
2049         (beginning-of-line)
2050         (re-search-backward dired-re-dir nil t (- arg)))
2051       (dired-move-to-filename)          ; user may type `i' or `f'
2052     (goto-char opoint)
2053     (error "No more subdirectories")))
2054
2055 (defun dired-prev-dirline (arg)
2056   "Goto ARGth previous directory file line."
2057   (interactive "p")
2058   (dired-next-dirline (- arg)))
2059
2060 (defun dired-up-directory (&optional other-window)
2061   "Run Dired on parent directory of current directory.
2062 Find the parent directory either in this buffer or another buffer.
2063 Creates a buffer if necessary.
2064 If OTHER-WINDOW (the optional prefix arg), display the parent
2065 directory in another window."
2066   (interactive "P")
2067   (let* ((dir (dired-current-directory))
2068          (up (file-name-directory (directory-file-name dir))))
2069     (or (dired-goto-file (directory-file-name dir))
2070         ;; Only try dired-goto-subdir if buffer has more than one dir.
2071         (and (cdr dired-subdir-alist)
2072              (dired-goto-subdir up))
2073         (progn
2074           (if other-window
2075               (dired-other-window up)
2076             (dired up))
2077           (dired-goto-file dir)))))
2078
2079 (defun dired-get-file-for-visit ()
2080   "Get the current line's file name, with an error if file does not exist."
2081   (interactive)
2082   ;; We pass t for second arg so that we don't get error for `.' and `..'.
2083   (let ((raw (dired-get-filename nil t))
2084         file-name)
2085     (if (null raw)
2086         (error "No file on this line"))
2087     (setq file-name (file-name-sans-versions raw t))
2088     (if (file-exists-p file-name)
2089         file-name
2090       (if (file-symlink-p file-name)
2091           (error "File is a symlink to a nonexistent target")
2092         (error "File no longer exists; type `g' to update Dired buffer")))))
2093
2094 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
2095 (define-obsolete-function-alias 'dired-advertised-find-file 'dired-find-file "23.2")
2096 (defun dired-find-file ()
2097   "In Dired, visit the file or directory named on this line."
2098   (interactive)
2099   ;; Bind `find-file-run-dired' so that the command works on directories
2100   ;; too, independent of the user's setting.
2101   (let ((find-file-run-dired t))
2102     (find-file (dired-get-file-for-visit))))
2103
2104 (defun dired-find-alternate-file ()
2105   "In Dired, visit this file or directory instead of the Dired buffer."
2106   (interactive)
2107   (set-buffer-modified-p nil)
2108   (find-alternate-file (dired-get-file-for-visit)))
2109 ;; Don't override the setting from .emacs.
2110 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2111
2112 (defun dired-mouse-find-file-other-window (event)
2113   "In Dired, visit the file or directory name you click on."
2114   (interactive "e")
2115   (let (window pos file)
2116     (save-excursion
2117       (setq window (posn-window (event-end event))
2118             pos (posn-point (event-end event)))
2119       (if (not (windowp window))
2120           (error "No file chosen"))
2121       (set-buffer (window-buffer window))
2122       (goto-char pos)
2123       (setq file (dired-get-file-for-visit)))
2124     (if (file-directory-p file)
2125         (or (and (cdr dired-subdir-alist)
2126                  (dired-goto-subdir file))
2127             (progn
2128               (select-window window)
2129               (dired-other-window file)))
2130       (select-window window)
2131       (find-file-other-window (file-name-sans-versions file t)))))
2132
2133 (defun dired-view-file ()
2134   "In Dired, examine a file in view mode, returning to Dired when done.
2135 When file is a directory, show it in this buffer if it is inserted.
2136 Otherwise, display it in another buffer."
2137   (interactive)
2138   (let ((file (dired-get-file-for-visit)))
2139     (if (file-directory-p file)
2140         (or (and (cdr dired-subdir-alist)
2141                  (dired-goto-subdir file))
2142             (dired file))
2143       (view-file file))))
2144
2145 (defun dired-find-file-other-window ()
2146   "In Dired, visit this file or directory in another window."
2147   (interactive)
2148   (find-file-other-window (dired-get-file-for-visit)))
2149
2150 (defun dired-display-file ()
2151   "In Dired, display this file or directory in another window."
2152   (interactive)
2153   (display-buffer (find-file-noselect (dired-get-file-for-visit))
2154                   t))
2155 \f
2156 ;;; Functions for extracting and manipulating file names in Dired buffers.
2157
2158 (defun dired-get-filename (&optional localp no-error-if-not-filep)
2159   "In Dired, return name of file mentioned on this line.
2160 Value returned normally includes the directory name.
2161 Optional arg LOCALP with value `no-dir' means don't include directory
2162 name in result.  A value of `verbatim' means to return the name exactly as
2163 it occurs in the buffer, and a value of t means construct name relative to
2164 `default-directory', which still may contain slashes if in a subdirectory.
2165 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2166 regular filenames and return nil if no filename on this line.
2167 Otherwise, an error occurs in these cases."
2168   (let (case-fold-search file p1 p2 already-absolute)
2169     (save-excursion
2170       (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
2171           (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
2172     ;; nil if no file on this line, but no-error-if-not-filep is t:
2173     (if (setq file (and p1 p2 (buffer-substring p1 p2)))
2174         (progn
2175           ;; Get rid of the mouse-face property that file names have.
2176           (set-text-properties 0 (length file) nil file)
2177           ;; Unquote names quoted by ls or by dired-insert-directory.
2178           ;; This code was written using `read' to unquote, because
2179           ;; it's faster than substituting \007 (4 chars) -> ^G (1
2180           ;; char) etc. in a lisp loop.  Unfortunately, this decision
2181           ;; has necessitated hacks such as dealing with filenames
2182           ;; with quotation marks in their names.
2183           (while (string-match "\\(?:[^\\]\\|\\`\\)\\(\"\\)" file)
2184             (setq file (replace-match "\\\"" nil t file 1)))
2185           ;; Unescape any spaces escaped by ls -b (bug#10469).
2186           ;; Other -b quotes, eg \t, \n, work transparently.
2187           (if (dired-switches-escape-p dired-actual-switches)
2188               (let ((start 0)
2189                     (rep "")
2190                     (shift -1))
2191                 (if (eq localp 'verbatim)
2192                     (setq rep "\\\\"
2193                           shift +1))
2194                 (while (string-match "\\(\\\\\\) " file start)
2195                   (setq file (replace-match rep nil t file 1)
2196                         start (+ shift (match-end 0))))))
2197           (when (eq system-type 'windows-nt)
2198             (save-match-data
2199               (let ((start 0))
2200                 (while (string-match "\\\\" file start)
2201                   (aset file (match-beginning 0) ?/)
2202                   (setq start (match-end 0))))))
2203
2204           ;; Hence we don't need to worry about converting `\\' back to `\'.
2205           (setq file (read (concat "\"" file "\"")))
2206           ;; The above `read' will return a unibyte string if FILE
2207           ;; contains eight-bit-control/graphic characters.
2208           (if (and enable-multibyte-characters
2209                    (not (multibyte-string-p file)))
2210               (setq file (string-to-multibyte file)))))
2211     (and file (file-name-absolute-p file)
2212          ;; A relative file name can start with ~.
2213          ;; Don't treat it as absolute in this context.
2214          (not (eq (aref file 0) ?~))
2215          (setq already-absolute t))
2216     (cond
2217      ((null file)
2218       nil)
2219      ((eq localp 'verbatim)
2220       file)
2221      ((and (not no-error-if-not-filep)
2222            (member file '("." "..")))
2223       (error "Cannot operate on `.' or `..'"))
2224      ((and (eq localp 'no-dir) already-absolute)
2225       (file-name-nondirectory file))
2226      (already-absolute
2227       (let ((handler (find-file-name-handler file nil)))
2228         ;; check for safe-magic property so that we won't
2229         ;; put /: for names that don't really need them.
2230         ;; For instance, .gz files when auto-compression-mode is on.
2231         (if (and handler (not (get handler 'safe-magic)))
2232             (concat "/:" file)
2233           file)))
2234      ((eq localp 'no-dir)
2235       file)
2236      ((equal (dired-current-directory) "/")
2237       (setq file (concat (dired-current-directory localp) file))
2238       (let ((handler (find-file-name-handler file nil)))
2239         ;; check for safe-magic property so that we won't
2240         ;; put /: for names that don't really need them.
2241         ;; For instance, .gz files when auto-compression-mode is on.
2242         (if (and handler (not (get handler 'safe-magic)))
2243             (concat "/:" file)
2244           file)))
2245      (t
2246       (concat (dired-current-directory localp) file)))))
2247
2248 (defun dired-string-replace-match (regexp string newtext
2249                                    &optional literal global)
2250   "Replace first match of REGEXP in STRING with NEWTEXT.
2251 If it does not match, nil is returned instead of the new string.
2252 Optional arg LITERAL means to take NEWTEXT literally.
2253 Optional arg GLOBAL means to replace all matches."
2254   (if global
2255       (let ((start 0) ret)
2256         (while (string-match regexp string start)
2257           (let ((from-end (- (length string) (match-end 0))))
2258             (setq ret (setq string (replace-match newtext t literal string)))
2259             (setq start (- (length string) from-end))))
2260           ret)
2261     (if (not (string-match regexp string 0))
2262         nil
2263       (replace-match newtext t literal string))))
2264
2265 (defun dired-make-absolute (file &optional dir)
2266   ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2267   ;; We can't always use expand-file-name as this would get rid of `.'
2268   ;; or expand in / instead default-directory if DIR=="".
2269   ;; This should be good enough for ange-ftp.
2270   ;; It should be reasonably fast, though, as it is called in
2271   ;; dired-get-filename.
2272   (concat (or dir default-directory) file))
2273
2274 (defun dired-make-relative (file &optional dir)
2275   "Convert FILE (an absolute file name) to a name relative to DIR.
2276 If DIR is omitted or nil, it defaults to `default-directory'.
2277 If FILE is not in the directory tree of DIR, return FILE
2278 unchanged."
2279   (or dir (setq dir default-directory))
2280   ;; This case comes into play if default-directory is set to
2281   ;; use ~.
2282   (if (and (> (length dir) 0) (= (aref dir 0) ?~))
2283       (setq dir (expand-file-name dir)))
2284   (if (string-match (concat "^" (regexp-quote dir)) file)
2285       (substring file (match-end 0))
2286     file))
2287 \f
2288 (define-minor-mode dired-hide-details-mode
2289   "Toggle visibility of detailed information in current Dired buffer.
2290 When this minor mode is enabled, details such as file ownership and
2291 permissions are hidden from view.
2292
2293 See options: `dired-hide-details-hide-symlink-targets' and
2294 `dired-hide-details-hide-information-lines'."
2295   :group 'dired
2296   (unless (derived-mode-p 'dired-mode)
2297     (error "Not a Dired buffer"))
2298   (dired-hide-details-update-invisibility-spec)
2299   (if dired-hide-details-mode
2300       (add-hook 'wdired-mode-hook
2301                 'dired-hide-details-update-invisibility-spec
2302                 nil
2303                 t)
2304     (remove-hook 'wdired-mode-hook
2305                  'dired-hide-details-update-invisibility-spec
2306                  t)))
2307
2308 (defun dired-hide-details-update-invisibility-spec ()
2309   (funcall (if dired-hide-details-mode
2310                'add-to-invisibility-spec
2311              'remove-from-invisibility-spec)
2312            'dired-hide-details-detail)
2313   (funcall (if (and dired-hide-details-mode
2314                     dired-hide-details-hide-information-lines)
2315                'add-to-invisibility-spec
2316              'remove-from-invisibility-spec)
2317            'dired-hide-details-information)
2318   (funcall (if (and dired-hide-details-mode
2319                     dired-hide-details-hide-symlink-targets
2320                     (not (derived-mode-p 'wdired-mode)))
2321                'add-to-invisibility-spec
2322              'remove-from-invisibility-spec)
2323            'dired-hide-details-link))
2324 \f
2325 ;;; Functions for finding the file name in a dired buffer line.
2326
2327 (defvar dired-permission-flags-regexp
2328   "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
2329   "Regular expression to match the permission flags in `ls -l'.")
2330
2331 ;; Move to first char of filename on this line.
2332 ;; Returns position (point) or nil if no filename on this line."
2333 (defun dired-move-to-filename (&optional raise-error eol)
2334   "Move to the beginning of the filename on the current line.
2335 Return the position of the beginning of the filename, or nil if none found."
2336   ;; This is the UNIX version.
2337   (or eol (setq eol (line-end-position)))
2338   (beginning-of-line)
2339   ;; First try assuming `ls --dired' was used.
2340   (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2341     (cond
2342      ((and change (< change eol))
2343       (goto-char change))
2344      ((re-search-forward directory-listing-before-filename-regexp eol t)
2345       (goto-char (match-end 0)))
2346      ((re-search-forward dired-permission-flags-regexp eol t)
2347       ;; Ha!  There *is* a file.  Our regexp-from-hell just failed to find it.
2348       (if raise-error
2349           (error "Unrecognized line!  Check directory-listing-before-filename-regexp"))
2350       (beginning-of-line)
2351       nil)
2352      (raise-error
2353       (error "No file on this line")))))
2354
2355 (defun dired-move-to-end-of-filename (&optional no-error)
2356   ;; Assumes point is at beginning of filename,
2357   ;; thus the rwx bit re-search-backward below will succeed in *this*
2358   ;; line if at all.  So, it should be called only after
2359   ;; (dired-move-to-filename t).
2360   ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2361   ;; This is the UNIX version.
2362   (if (get-text-property (point) 'dired-filename)
2363       (goto-char (next-single-property-change (point) 'dired-filename))
2364     (let (opoint file-type executable symlink hidden used-F eol)
2365       (setq used-F (dired-check-switches dired-actual-switches "F" "classify")
2366             opoint (point)
2367             eol (line-end-position)
2368             hidden (and selective-display
2369                         (save-excursion (search-forward "\r" eol t))))
2370       (if hidden
2371           nil
2372         (save-excursion ;; Find out what kind of file this is:
2373           ;; Restrict perm bits to be non-blank,
2374           ;; otherwise this matches one char to early (looking backward):
2375           ;; "l---------" (some systems make symlinks that way)
2376           ;; "----------" (plain file with zero perms)
2377           (if (re-search-backward
2378                dired-permission-flags-regexp nil t)
2379               (setq file-type (char-after (match-beginning 1))
2380                     symlink (eq file-type ?l)
2381                     ;; Only with -F we need to know whether it's an executable
2382                     executable (and
2383                                 used-F
2384                                 (string-match
2385                                  "[xst]" ;; execute bit set anywhere?
2386                                  (concat
2387                                   (match-string 2)
2388                                   (match-string 3)
2389                                   (match-string 4)))))
2390             (or no-error (error "No file on this line"))))
2391         ;; Move point to end of name:
2392         (if symlink
2393             (if (search-forward " -> " eol t)
2394                 (progn
2395                   (forward-char -4)
2396                   (and used-F
2397                        dired-ls-F-marks-symlinks
2398                        (eq (preceding-char) ?@) ;; did ls really mark the link?
2399                        (forward-char -1))))
2400           (goto-char eol) ;; else not a symbolic link
2401           ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2402           ;; one trailing character. (Executable bits on symlinks ain't mean
2403           ;; a thing, even to ls, but we know it's not a symlink.)
2404           (and used-F
2405                (or (memq file-type '(?d ?s ?p))
2406                    executable)
2407                (forward-char -1))))
2408       (or no-error
2409           (not (eq opoint (point)))
2410           (error "%s" (if hidden
2411                      (substitute-command-keys
2412                       "File line is hidden, type \\[dired-hide-subdir] to unhide")
2413                    "No file on this line")))
2414       (if (eq opoint (point))
2415           nil
2416         (point)))))
2417
2418 \f
2419 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2420
2421 (defun dired-copy-filename-as-kill (&optional arg)
2422   "Copy names of marked (or next ARG) files into the kill ring.
2423 The names are separated by a space.
2424 With a zero prefix arg, use the absolute file name of each marked file.
2425 With \\[universal-argument], use the file name relative to the Dired buffer's
2426 `default-directory'.  (This still may contain slashes if in a subdirectory.)
2427
2428 If on a subdir headerline, use absolute subdirname instead;
2429 prefix arg and marked files are ignored in this case.
2430
2431 You can then feed the file name(s) to other commands with \\[yank]."
2432   (interactive "P")
2433   (let ((string
2434          (or (dired-get-subdir)
2435              (mapconcat (function identity)
2436                         (if arg
2437                             (cond ((zerop (prefix-numeric-value arg))
2438                                    (dired-get-marked-files))
2439                                   ((consp arg)
2440                                    (dired-get-marked-files t))
2441                                   (t
2442                                    (dired-get-marked-files
2443                                     'no-dir (prefix-numeric-value arg))))
2444                           (dired-get-marked-files 'no-dir))
2445                         " "))))
2446     (if (eq last-command 'kill-region)
2447         (kill-append string nil)
2448       (kill-new string))
2449     (message "%s" string)))
2450
2451 \f
2452 ;; Keeping Dired buffers in sync with the filesystem and with each other
2453
2454 (defun dired-buffers-for-dir (dir &optional file)
2455 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2456 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2457 ;; matches FILE.
2458 ;; The list is in reverse order of buffer creation, most recent last.
2459 ;; As a side effect, killed dired buffers for DIR are removed from
2460 ;; dired-buffers.
2461   (setq dir (file-name-as-directory dir))
2462   (let (result buf)
2463     (dolist (elt dired-buffers)
2464       (setq buf (cdr elt))
2465       (cond
2466        ((null (buffer-name buf))
2467         ;; Buffer is killed - clean up:
2468         (setq dired-buffers (delq elt dired-buffers)))
2469        ((dired-in-this-tree dir (car elt))
2470         (with-current-buffer buf
2471           (and (assoc dir dired-subdir-alist)
2472                (or (null file)
2473                    (if (stringp dired-directory)
2474                        (let ((wildcards (file-name-nondirectory
2475                                          dired-directory)))
2476                          (or (zerop (length wildcards))
2477                              (string-match-p (dired-glob-regexp wildcards)
2478                                              file)))
2479                      (member (expand-file-name file dir)
2480                              (cdr dired-directory))))
2481                (setq result (cons buf result)))))))
2482     result))
2483
2484 (defun dired-glob-regexp (pattern)
2485   "Convert glob-pattern PATTERN to a regular expression."
2486   (let ((matched-in-pattern 0)  ;; How many chars of PATTERN we've handled.
2487         regexp)
2488     (while (string-match "[[?*]" pattern matched-in-pattern)
2489       (let ((op-end (match-end 0))
2490             (next-op (aref pattern (match-beginning 0))))
2491         (setq regexp (concat regexp
2492                              (regexp-quote
2493                               (substring pattern matched-in-pattern
2494                                          (match-beginning 0)))))
2495         (cond ((= next-op ??)
2496                (setq regexp (concat regexp "."))
2497                (setq matched-in-pattern op-end))
2498               ((= next-op ?\[)
2499                ;; Fails to handle ^ yet ????
2500                (let* ((set-start (match-beginning 0))
2501                       (set-cont
2502                        (if (= (aref pattern (1+ set-start)) ?^)
2503                            (+ 3 set-start)
2504                          (+ 2 set-start)))
2505                       (set-end (string-match-p "]" pattern set-cont))
2506                       (set (substring pattern set-start (1+ set-end))))
2507                  (setq regexp (concat regexp set))
2508                  (setq matched-in-pattern (1+ set-end))))
2509               ((= next-op ?*)
2510                (setq regexp (concat regexp ".*"))
2511                (setq matched-in-pattern op-end)))))
2512     (concat "\\`"
2513             regexp
2514             (regexp-quote
2515              (substring pattern matched-in-pattern))
2516             "\\'")))
2517
2518
2519
2520 (defun dired-advertise ()
2521   ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2522   ;; With wildcards we actually advertise too much.
2523   (let ((expanded-default (expand-file-name default-directory)))
2524     (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2525         t                               ; we have already advertised ourselves
2526       (setq dired-buffers
2527             (cons (cons expanded-default (current-buffer))
2528                   dired-buffers)))))
2529
2530 (defun dired-unadvertise (dir)
2531   ;; Remove DIR from the buffer alist in variable dired-buffers.
2532   ;; This has the effect of removing any buffer whose main directory is DIR.
2533   ;; It does not affect buffers in which DIR is a subdir.
2534   ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2535   (setq dired-buffers
2536         (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2537 \f
2538 ;; Tree Dired
2539
2540 ;;; utility functions
2541
2542 (defun dired-in-this-tree (file dir)
2543   ;;"Is FILE part of the directory tree starting at DIR?"
2544   (let (case-fold-search)
2545     (string-match-p (concat "^" (regexp-quote dir)) file)))
2546
2547 (defun dired-normalize-subdir (dir)
2548   ;; Prepend default-directory to DIR if relative file name.
2549   ;; dired-get-filename must be able to make a valid file name from a
2550   ;; file and its directory DIR.
2551   (file-name-as-directory
2552    (if (file-name-absolute-p dir)
2553        dir
2554      (expand-file-name dir default-directory))))
2555
2556 (defun dired-get-subdir ()
2557   ;;"Return the subdir name on this line, or nil if not on a headerline."
2558   ;; Look up in the alist whether this is a headerline.
2559   (save-excursion
2560     (let ((cur-dir (dired-current-directory)))
2561       (beginning-of-line)               ; alist stores b-o-l positions
2562       (and (zerop (- (point)
2563                      (dired-get-subdir-min (assoc cur-dir
2564                                                   dired-subdir-alist))))
2565            cur-dir))))
2566
2567 ;; can't use macro,  must be redefinable for other alist format in dired-nstd.
2568 (defalias 'dired-get-subdir-min 'cdr)
2569
2570 (defun dired-get-subdir-max (elt)
2571   (save-excursion
2572     (goto-char (dired-get-subdir-min elt))
2573     (dired-subdir-max)))
2574
2575 (defun dired-clear-alist ()
2576   (while dired-subdir-alist
2577     (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2578     (setq dired-subdir-alist (cdr dired-subdir-alist))))
2579
2580 (defun dired-subdir-index (dir)
2581   ;; Return an index into alist for use with nth
2582   ;; for the sake of subdir moving commands.
2583   (let (found (index 0) (alist dired-subdir-alist))
2584     (while alist
2585       (if (string= dir (car (car alist)))
2586           (setq alist nil found t)
2587         (setq alist (cdr alist) index (1+ index))))
2588     (if found index nil)))
2589
2590 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2591   "Go to next subdirectory, regardless of level."
2592   ;; Use 0 arg to go to this directory's header line.
2593   ;; NO-SKIP prevents moving to end of header line, returning whatever
2594   ;; position was found in dired-subdir-alist.
2595   (interactive "p")
2596   (let ((this-dir (dired-current-directory))
2597         pos index)
2598     ;; nth with negative arg does not return nil but the first element
2599     (setq index (- (dired-subdir-index this-dir) arg))
2600     (setq pos (if (>= index 0)
2601                   (dired-get-subdir-min (nth index dired-subdir-alist))))
2602     (if pos
2603         (progn
2604           (goto-char pos)
2605           (or no-skip (skip-chars-forward "^\n\r"))
2606           (point))
2607       (if no-error-if-not-found
2608           nil                           ; return nil if not found
2609         (error "%s directory" (if (> arg 0) "Last" "First"))))))
2610
2611 (defun dired-build-subdir-alist (&optional switches)
2612   "Build `dired-subdir-alist' by parsing the buffer.
2613 Returns the new value of the alist.
2614 If optional arg SWITCHES is non-nil, use its value
2615 instead of `dired-actual-switches'."
2616   (interactive)
2617   (dired-clear-alist)
2618   (save-excursion
2619     (let* ((count 0)
2620            (inhibit-read-only t)
2621            (buffer-undo-list t)
2622            (switches (or switches dired-actual-switches))
2623            new-dir-name
2624            (R-ftp-base-dir-regex
2625             ;; Used to expand subdirectory names correctly in recursive
2626             ;; ange-ftp listings.
2627             (and (dired-switches-recursive-p switches)
2628                  (string-match "\\`/.*:\\(/.*\\)" default-directory)
2629                  (concat "\\`" (match-string 1 default-directory)))))
2630       (goto-char (point-min))
2631       (setq dired-subdir-alist nil)
2632       (while (re-search-forward dired-subdir-regexp nil t)
2633         ;; Avoid taking a file name ending in a colon
2634         ;; as a subdir name.
2635         (unless (save-excursion
2636                   (goto-char (match-beginning 0))
2637                   (beginning-of-line)
2638                   (forward-char 2)
2639                   (looking-at-p dired-re-perms))
2640           (save-excursion
2641             (goto-char (match-beginning 1))
2642             (setq new-dir-name
2643                   (buffer-substring-no-properties (point) (match-end 1))
2644                   new-dir-name
2645                   (save-match-data
2646                     (if (and R-ftp-base-dir-regex
2647                              (not (string= new-dir-name default-directory))
2648                              (string-match R-ftp-base-dir-regex new-dir-name))
2649                         (concat default-directory
2650                                 (substring new-dir-name (match-end 0)))
2651                       (expand-file-name new-dir-name))))
2652             (delete-region (point) (match-end 1))
2653             (insert new-dir-name))
2654           (setq count (1+ count))
2655           ;; Undo any escaping of newlines and \ by dired-insert-directory.
2656           ;; Convert "n" preceded by odd number of \ to newline, and \\ to \.
2657           (when (and (dired-switches-escape-p switches)
2658                      (string-match-p "\\\\" new-dir-name))
2659             (let (temp res)
2660               (mapc (lambda (char)
2661                       (cond ((equal char ?\\)
2662                              (if temp
2663                                  (setq res (concat res "\\")
2664                                        temp nil)
2665                                (setq temp "\\")))
2666                             ((and temp (equal char ?n))
2667                              (setq res (concat res "\n")
2668                                    temp nil))
2669                             (t
2670                              (setq res (concat res temp (char-to-string char))
2671                                    temp nil))))
2672                     new-dir-name)
2673               (setq new-dir-name res)))
2674           (dired-alist-add-1 new-dir-name
2675            ;; Place a sub directory boundary between lines.
2676            (save-excursion
2677              (goto-char (match-beginning 0))
2678              (beginning-of-line)
2679              (point-marker)))))
2680       (if (and (> count 1) (called-interactively-p 'interactive))
2681           (message "Buffer includes %d directories" count)))
2682     ;; We don't need to sort it because it is in buffer order per
2683     ;; constructionem.  Return new alist:
2684     dired-subdir-alist))
2685
2686 (defun dired-alist-add-1 (dir new-marker)
2687   ;; Add new DIR at NEW-MARKER.  Don't sort.
2688   (setq dired-subdir-alist
2689         (cons (cons (dired-normalize-subdir dir) new-marker)
2690               dired-subdir-alist)))
2691
2692 (defun dired-goto-next-nontrivial-file ()
2693   ;; Position point on first nontrivial file after point.
2694   (dired-goto-next-file);; so there is a file to compare with
2695   (if (stringp dired-trivial-filenames)
2696       (while (and (not (eobp))
2697                   (string-match-p dired-trivial-filenames
2698                                   (file-name-nondirectory
2699                                    (or (dired-get-filename nil t) ""))))
2700         (forward-line 1)
2701         (dired-move-to-filename))))
2702
2703 (defun dired-goto-next-file ()
2704   (let ((max (1- (dired-subdir-max))))
2705     (while (and (not (dired-move-to-filename)) (< (point) max))
2706       (forward-line 1))))
2707
2708 (defun dired-goto-file (file)
2709   "Go to line describing file FILE in this Dired buffer."
2710   ;; Return value of point on success, else nil.
2711   ;; FILE must be an absolute file name.
2712   ;; Loses if FILE contains control chars like "\007" for which ls
2713   ;; either inserts "?" or "\\007" into the buffer, so we won't find
2714   ;; it in the buffer.
2715   (interactive
2716    (prog1                               ; let push-mark display its message
2717        (list (expand-file-name
2718               (read-file-name "Goto file: "
2719                               (dired-current-directory))))
2720      (push-mark)))
2721   (unless (file-name-absolute-p file)
2722     (error "File name `%s' is not absolute" file))
2723   (setq file (directory-file-name file)) ; does no harm if not a directory
2724   (let* ((case-fold-search nil)
2725          (dir (file-name-directory file))
2726          (found (or
2727                  ;; First, look for a listing under the absolute name.
2728                  (save-excursion
2729                    (goto-char (point-min))
2730                    (dired-goto-file-1 file file (point-max)))
2731                  ;; Otherwise, look for it as a relative name.  The
2732                  ;; hair is to get the result of `dired-goto-subdir'
2733                  ;; without calling it if we don't have any subdirs.
2734                  (save-excursion
2735                    (when (if (string= dir (expand-file-name default-directory))
2736                              (goto-char (point-min))
2737                            (and (cdr dired-subdir-alist)
2738                                 (dired-goto-subdir dir)))
2739                      (dired-goto-file-1 (file-name-nondirectory file)
2740                                         file
2741                                         (dired-subdir-max)))))))
2742     ;; Return buffer position, if found.
2743     (if found
2744         (goto-char found))))
2745
2746 (defun dired-goto-file-1 (file full-name limit)
2747   "Advance to the Dired listing labeled by FILE; return its position.
2748 Return nil if the listing is not found.  If FILE contains
2749 characters that would not appear in a Dired buffer, search using
2750 the quoted forms of those characters.
2751
2752 FULL-NAME specifies the actual file name the listing must have,
2753 as returned by `dired-get-filename'.  LIMIT is the search limit."
2754   (let (str)
2755     (setq str (replace-regexp-in-string "\^m" "\\^m"  file nil t))
2756     (setq str (replace-regexp-in-string "\\\\" "\\\\" str nil t))
2757     (and (dired-switches-escape-p dired-actual-switches)
2758          (string-match-p "[ \t\n]" str)
2759          ;; FIXME: to fix this for embedded control characters etc, we
2760          ;; should escape everything that `ls -b' does.
2761          (setq str (replace-regexp-in-string " " "\\ "  str nil t)
2762                str (replace-regexp-in-string "\t" "\\t" str nil t)
2763                str (replace-regexp-in-string "\n" "\\n" str nil t)))
2764     (let ((found nil)
2765           ;; filenames are preceded by SPC, this makes the search faster
2766           ;; (e.g. for the filename "-").
2767           (search-string (concat " " str)))
2768       (while (and (not found)
2769                   (search-forward search-string limit 'move))
2770         ;; Check that we are in the right place.  Match could have
2771         ;; BASE just as initial substring or in permission bits etc.
2772         (if (equal full-name (dired-get-filename nil t))
2773             (setq found (dired-move-to-filename))
2774           (forward-line 1)))
2775       found)))
2776
2777 (defvar dired-find-subdir)
2778
2779 ;; FIXME document whatever dired-x is doing.
2780 (defun dired-initial-position (dirname)
2781   "Where point should go in a new listing of DIRNAME.
2782 Point is assumed to be at the beginning of new subdir line.
2783 It runs the hook `dired-initial-position-hook'."
2784   (end-of-line)
2785   (and (featurep 'dired-x) dired-find-subdir
2786        (dired-goto-subdir dirname))
2787   (if dired-trivial-filenames (dired-goto-next-nontrivial-file))
2788   (run-hooks 'dired-initial-position-hook))
2789 \f
2790 ;; These are hooks which make tree dired work.
2791 ;; They are in this file because other parts of dired need to call them.
2792 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2793
2794 ;; This function is called for each retrieved filename.
2795 ;; It could stand to be faster, though it's mostly function call
2796 ;; overhead.  Avoiding the function call seems to save about 10% in
2797 ;; dired-get-filename.  Make it a defsubst?
2798 (defun dired-current-directory (&optional localp)
2799   "Return the name of the subdirectory to which this line belongs.
2800 This returns a string with trailing slash, like `default-directory'.
2801 Optional argument means return a file name relative to `default-directory'."
2802   (let ((here (point))
2803         (alist (or dired-subdir-alist
2804                    ;; probably because called in a non-dired buffer
2805                    (error "No subdir-alist in %s" (current-buffer))))
2806         elt dir)
2807     (while alist
2808       (setq elt (car alist)
2809             dir (car elt)
2810             ;; use `<=' (not `<') as subdir line is part of subdir
2811             alist (if (<= (dired-get-subdir-min elt) here)
2812                       nil               ; found
2813                     (cdr alist))))
2814     (if localp
2815         (dired-make-relative dir default-directory)
2816       dir)))
2817
2818 ;; Subdirs start at the beginning of their header lines and end just
2819 ;; before the beginning of the next header line (or end of buffer).
2820
2821 (defun dired-subdir-max ()
2822   (save-excursion
2823     (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2824         (point-max)
2825       (point))))
2826 \f
2827 ;; Deleting files
2828
2829 (defcustom dired-recursive-deletes 'top
2830   "Whether Dired deletes directories recursively.
2831 If nil, Dired will not delete non-empty directories.
2832 `always' means to delete non-empty directories recursively,
2833 without asking.  This is dangerous!
2834 `top' means to ask for each top-level directory specified by the
2835 Dired deletion command, and delete its subdirectories without
2836 asking.
2837 Any other value means to ask for each directory."
2838   :type '(choice :tag "Delete non-empty directories"
2839                  (const :tag "Yes" always)
2840                  (const :tag "No--only delete empty directories" nil)
2841                  (const :tag "Confirm for each directory" t)
2842                  (const :tag "Confirm for each top directory only" top))
2843   :group 'dired)
2844
2845 ;; Match anything but `.' and `..'.
2846 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2847
2848 ;; Delete file, possibly delete a directory and all its files.
2849 ;; This function is useful outside of dired.  One could change its name
2850 ;; to e.g. recursive-delete-file and put it somewhere else.
2851 (defun dired-delete-file (file &optional recursive trash) "\
2852 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2853 RECURSIVE determines what to do with a non-empty directory.  If RECURSIVE is:
2854 nil, do not delete.
2855 `always', delete recursively without asking.
2856 `top', ask for each directory at top level.
2857 Anything else, ask for each sub-directory."
2858   ;; This test is equivalent to
2859   ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2860   ;; but more efficient
2861   (if (not (eq t (car (file-attributes file))))
2862       (delete-file file trash)
2863     (if (and recursive
2864              (directory-files file t dired-re-no-dot) ; Not empty.
2865              (or (eq recursive 'always)
2866                  (yes-or-no-p (format "Recursively %s %s? "
2867                                       (if (and trash
2868                                                delete-by-moving-to-trash)
2869                                           "trash"
2870                                         "delete")
2871                                       (dired-make-relative file)))))
2872         (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2873       (setq recursive nil))
2874     (delete-directory file recursive trash)))
2875
2876 (defun dired-do-flagged-delete (&optional nomessage)
2877   "In Dired, delete the files flagged for deletion.
2878 If NOMESSAGE is non-nil, we don't display any message
2879 if there are no flagged files.
2880 `dired-recursive-deletes' controls whether deletion of
2881 non-empty directories is allowed."
2882   (interactive)
2883   (let* ((dired-marker-char dired-del-marker)
2884          (regexp (dired-marker-regexp))
2885          case-fold-search)
2886     (if (save-excursion (goto-char (point-min))
2887                         (re-search-forward regexp nil t))
2888         (dired-internal-do-deletions
2889          ;; this can't move point since ARG is nil
2890          (dired-map-over-marks (cons (dired-get-filename) (point))
2891                                nil)
2892          nil t)
2893       (or nomessage
2894           (message "(No deletions requested)")))))
2895
2896 (defun dired-do-delete (&optional arg)
2897   "Delete all marked (or next ARG) files.
2898 `dired-recursive-deletes' controls whether deletion of
2899 non-empty directories is allowed."
2900   ;; This is more consistent with the file marking feature than
2901   ;; dired-do-flagged-delete.
2902   (interactive "P")
2903   (dired-internal-do-deletions
2904    ;; this may move point if ARG is an integer
2905    (dired-map-over-marks (cons (dired-get-filename) (point))
2906                          arg)
2907    arg t))
2908
2909 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2910
2911 (defun dired-internal-do-deletions (l arg &optional trash)
2912   ;; L is an alist of files to delete, with their buffer positions.
2913   ;; ARG is the prefix arg.
2914   ;; Filenames are absolute.
2915   ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2916   ;; That way as changes are made in the buffer they do not shift the
2917   ;; lines still to be changed, so the (point) values in L stay valid.
2918   ;; Also, for subdirs in natural order, a subdir's files are deleted
2919   ;; before the subdir itself - the other way around would not work.
2920   (let* ((files (mapcar (function car) l))
2921          (count (length l))
2922          (succ 0)
2923          (trashing (and trash delete-by-moving-to-trash)))
2924     ;; canonicalize file list for pop up
2925     (setq files (nreverse (mapcar (function dired-make-relative) files)))
2926     (if (dired-mark-pop-up
2927          " *Deletions*" 'delete files dired-deletion-confirmer
2928          (format "%s %s "
2929                  (if trashing "Trash" "Delete")
2930                  (dired-mark-prompt arg files)))
2931         (save-excursion
2932           (let ((progress-reporter
2933                  (make-progress-reporter
2934                   (if trashing "Trashing..." "Deleting...")
2935                   succ count))
2936                 failures) ;; files better be in reverse order for this loop!
2937             (while l
2938               (goto-char (cdr (car l)))
2939               (let ((inhibit-read-only t))
2940                 (condition-case err
2941                     (let ((fn (car (car l))))
2942                       (dired-delete-file fn dired-recursive-deletes trash)
2943                       ;; if we get here, removing worked
2944                       (setq succ (1+ succ))
2945                       (progress-reporter-update progress-reporter succ)
2946                       (dired-fun-in-all-buffers
2947                        (file-name-directory fn) (file-name-nondirectory fn)
2948                        (function dired-delete-entry) fn))
2949                   (error ;; catch errors from failed deletions
2950                    (dired-log "%s\n" err)
2951                    (setq failures (cons (car (car l)) failures)))))
2952               (setq l (cdr l)))
2953             (if (not failures)
2954                 (progress-reporter-done progress-reporter)
2955               (dired-log-summary
2956                (format "%d of %d deletion%s failed"
2957                        (length failures) count
2958                        (dired-plural-s count))
2959                failures))))
2960       (message "(No deletions performed)")))
2961   (dired-move-to-filename))
2962
2963 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2964   ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2965   ;; If the buffer has a wildcard pattern, check that it matches FILE.
2966   ;; (FILE does not include a directory component.)
2967   ;; FILE may be nil, in which case ignore it.
2968   ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2969   (let (success-list)
2970     (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2971                                         file))
2972       (with-current-buffer buf
2973         (if (apply fun args)
2974             (setq success-list (cons (buffer-name buf) success-list)))))
2975     success-list))
2976
2977 ;; Delete the entry for FILE from
2978 (defun dired-delete-entry (file)
2979   (save-excursion
2980     (and (dired-goto-file file)
2981          (let ((inhibit-read-only t))
2982            (delete-region (progn (beginning-of-line) (point))
2983                           (save-excursion (forward-line 1) (point))))))
2984   (dired-clean-up-after-deletion file))
2985
2986 (defvar dired-clean-up-buffers-too)
2987
2988 (defun dired-clean-up-after-deletion (fn)
2989   "Clean up after a deleted file or directory FN.
2990 Removes any expanded subdirectory of deleted directory.
2991 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
2992 also offers to kill buffers visiting deleted files and directories."
2993   (save-excursion (and (cdr dired-subdir-alist)
2994                        (dired-goto-subdir fn)
2995                        (dired-kill-subdir)))
2996   ;; Offer to kill buffer of deleted file FN.
2997   (when (and (featurep 'dired-x) dired-clean-up-buffers-too)
2998     (let ((buf (get-file-buffer fn)))
2999       (and buf
3000            (funcall #'y-or-n-p
3001                     (format "Kill buffer of %s, too? "
3002                             (file-name-nondirectory fn)))
3003            (kill-buffer buf)))
3004     (let ((buf-list (dired-buffers-for-dir (expand-file-name fn))))
3005       (and buf-list
3006            (y-or-n-p (format "Kill Dired buffer%s of %s, too? "
3007                              (dired-plural-s (length buf-list))
3008                              (file-name-nondirectory fn)))
3009            (dolist (buf buf-list)
3010              (kill-buffer buf))))))
3011
3012 \f
3013 ;; Confirmation
3014
3015 (defun dired-marker-regexp ()
3016   (concat "^" (regexp-quote (char-to-string dired-marker-char))))
3017
3018 (defun dired-plural-s (count)
3019   (if (= 1 count) "" "s"))
3020
3021 (defun dired-mark-prompt (arg files)
3022   "Return a string suitable for use in a Dired prompt.
3023 ARG is normally the prefix argument for the calling command.
3024 FILES should be a list of file names.
3025
3026 The return value has a form like \"foo.txt\", \"[next 3 files]\",
3027 or \"* [3 files]\"."
3028   ;; distinguish-one-marked can cause the first element to be just t.
3029   (if (eq (car files) t) (setq files (cdr files)))
3030   (let ((count (length files)))
3031     (if (= count 1)
3032         (car files)
3033       ;; more than 1 file:
3034       (if (integerp arg)
3035           ;; abs(arg) = count
3036           ;; Perhaps this is nicer, but it also takes more screen space:
3037           ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
3038           ;;                        count)
3039           (format "[next %d files]" arg)
3040         (format "%c [%d files]" dired-marker-char count)))))
3041
3042 (defun dired-pop-to-buffer (buf)
3043   "Pop up buffer BUF in a way suitable for Dired."
3044   (declare (obsolete dired-mark-pop-up "24.3"))
3045   (let ((split-window-preferred-function
3046          (lambda (window)
3047            (or (and (let ((split-height-threshold 0))
3048                       (window-splittable-p (selected-window)))
3049                     ;; Try to split the selected window vertically if
3050                     ;; that's possible.  (Bug#1806)
3051                     (split-window-below))
3052                ;; Otherwise, try to split WINDOW sensibly.
3053                (split-window-sensibly window))))
3054         pop-up-frames)
3055     (pop-to-buffer (get-buffer-create buf)))
3056   ;; See Bug#12281.
3057   (set-window-start nil (point-min))
3058   ;; If dired-shrink-to-fit is t, make its window fit its contents.
3059   (when dired-shrink-to-fit
3060     ;; Try to not delete window when we want to display less than
3061     ;; `window-min-height' lines.
3062     (fit-window-to-buffer (get-buffer-window buf) nil 1)))
3063
3064 (defcustom dired-no-confirm nil
3065   "A list of symbols for commands Dired should not confirm, or t.
3066 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
3067 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
3068 `touch' and `uncompress'.
3069 If t, confirmation is never needed."
3070   :group 'dired
3071   :type '(choice (const :tag "Confirmation never needed" t)
3072                  (set (const byte-compile) (const chgrp)
3073                       (const chmod) (const chown) (const compress)
3074                       (const copy) (const delete) (const hardlink)
3075                       (const load) (const move) (const print)
3076                       (const shell) (const symlink) (const touch)
3077                       (const uncompress))))
3078
3079 (defun dired-mark-pop-up (buffer-or-name op-symbol files function &rest args)
3080   "Return FUNCTION's result on ARGS after showing which files are marked.
3081 Displays the file names in a window showing a buffer named
3082 BUFFER-OR-NAME; the default name being \" *Marked Files*\".  The
3083 window is not shown if there is just one file, `dired-no-confirm'
3084 is t, or OP-SYMBOL is a member of the list in `dired-no-confirm'.
3085
3086 By default, Dired shrinks the display buffer to fit the marked files.
3087 To disable this, use the Customization interface to add a new rule
3088 to `display-buffer-alist' where condition regexp is \"^ \\*Marked Files\\*$\",
3089 action argument symbol is `window-height' and its value is nil.
3090
3091 FILES is the list of marked files.  It can also be (t FILENAME)
3092 in the case of one marked file, to distinguish that from using
3093 just the current file.
3094
3095 FUNCTION should not manipulate files, just read input (an
3096 argument or confirmation)."
3097   (if (or (eq dired-no-confirm t)
3098           (memq op-symbol dired-no-confirm)
3099           ;; If FILES defaulted to the current line's file.
3100           (= (length files) 1))
3101       (apply function args)
3102     (let ((buffer (get-buffer-create (or buffer-or-name " *Marked Files*")))
3103           ;; Mark *Marked Files* window as softly-dedicated, to prevent
3104           ;; other buffers e.g. *Completions* from reusing it (bug#17554).
3105           (display-buffer-mark-dedicated 'soft))
3106       (with-current-buffer buffer
3107         (with-current-buffer-window
3108          buffer
3109          (cons 'display-buffer-below-selected
3110                '((window-height . fit-window-to-buffer)))
3111          #'(lambda (window _value)
3112              (with-selected-window window
3113                (unwind-protect
3114                    (apply function args)
3115                  (when (window-live-p window)
3116                    (quit-restore-window window 'kill)))))
3117          ;; Handle (t FILE) just like (FILE), here.  That value is
3118          ;; used (only in some cases), to mean just one file that was
3119          ;; marked, rather than the current line file.
3120          (dired-format-columns-of-files
3121           (if (eq (car files) t) (cdr files) files))
3122          (remove-text-properties (point-min) (point-max)
3123                                  '(mouse-face nil help-echo nil)))))))
3124
3125 (defun dired-format-columns-of-files (files)
3126   (let ((beg (point)))
3127     (completion--insert-strings files)
3128     (put-text-property beg (point) 'mouse-face nil)))
3129 \f
3130 ;; Commands to mark or flag file(s) at or near current line.
3131
3132 (defun dired-repeat-over-lines (arg function)
3133   ;; This version skips non-file lines.
3134   (let ((pos (make-marker)))
3135     (beginning-of-line)
3136     (while (and (> arg 0) (not (eobp)))
3137       (setq arg (1- arg))
3138       (beginning-of-line)
3139       (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
3140       (save-excursion
3141         (forward-line 1)
3142         (move-marker pos (1+ (point))))
3143       (save-excursion (funcall function))
3144       ;; Advance to the next line--actually, to the line that *was* next.
3145       ;; (If FUNCTION inserted some new lines in between, skip them.)
3146       (goto-char pos))
3147     (while (and (< arg 0) (not (bobp)))
3148       (setq arg (1+ arg))
3149       (forward-line -1)
3150       (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
3151       (beginning-of-line)
3152       (save-excursion (funcall function)))
3153     (move-marker pos nil)
3154     (dired-move-to-filename)))
3155
3156 (defun dired-between-files ()
3157   ;; This used to be a regexp match of the `total ...' line output by
3158   ;; ls, which is slightly faster, but that is not very robust; notably,
3159   ;; it fails for non-english locales.
3160   (save-excursion (not (dired-move-to-filename))))
3161
3162 (defun dired-next-marked-file (arg &optional wrap opoint)
3163   "Move to the next marked file.
3164 If WRAP is non-nil, wrap around to the beginning of the buffer if
3165 we reach the end."
3166   (interactive "p\np")
3167   (or opoint (setq opoint (point)));; return to where interactively started
3168   (if (if (> arg 0)
3169           (re-search-forward dired-re-mark nil t arg)
3170         (beginning-of-line)
3171         (re-search-backward dired-re-mark nil t (- arg)))
3172       (dired-move-to-filename)
3173     (if (null wrap)
3174         (progn
3175           (goto-char opoint)
3176           (error "No next marked file"))
3177       (message "(Wraparound for next marked file)")
3178       (goto-char (if (> arg 0) (point-min) (point-max)))
3179       (dired-next-marked-file arg nil opoint))))
3180
3181 (defun dired-prev-marked-file (arg &optional wrap)
3182   "Move to the previous marked file.
3183 If WRAP is non-nil, wrap around to the end of the buffer if we
3184 reach the beginning of the buffer."
3185   (interactive "p\np")
3186   (dired-next-marked-file (- arg) wrap))
3187
3188 (defun dired-file-marker (file)
3189   ;; Return FILE's marker, or nil if unmarked.
3190   (save-excursion
3191     (and (dired-goto-file file)
3192          (progn
3193            (beginning-of-line)
3194            (if (not (equal ?\040 (following-char)))
3195                (following-char))))))
3196
3197 (defun dired-mark-files-in-region (start end)
3198   (let ((inhibit-read-only t))
3199     (if (> start end)
3200         (error "start > end"))
3201     (goto-char start)                   ; assumed at beginning of line
3202     (while (< (point) end)
3203       ;; Skip subdir line and following garbage like the `total' line:
3204       (while (and (< (point) end) (dired-between-files))
3205         (forward-line 1))
3206       (if (and (not (looking-at-p dired-re-dot))
3207                (dired-get-filename nil t))
3208           (progn
3209             (delete-char 1)
3210             (insert dired-marker-char)))
3211       (forward-line 1))))
3212
3213 (defun dired-mark (arg &optional interactive)
3214   "Mark the file at point in the Dired buffer.
3215 If the region is active, mark all files in the region.
3216 Otherwise, with a prefix arg, mark files on the next ARG lines.
3217
3218 If on a subdir headerline, mark all its files except `.' and `..'.
3219
3220 Use \\[dired-unmark-all-files] to remove all marks
3221 and \\[dired-unmark] on a subdir to remove the marks in
3222 this subdir."
3223   (interactive (list current-prefix-arg t))
3224   (cond
3225    ;; Mark files in the active region.
3226    ((and interactive (use-region-p))
3227     (save-excursion
3228       (let ((beg (region-beginning))
3229             (end (region-end)))
3230         (dired-mark-files-in-region
3231          (progn (goto-char beg) (line-beginning-position))
3232          (progn (goto-char end) (line-beginning-position))))))
3233    ;; Mark subdir files from the subdir headerline.
3234    ((dired-get-subdir)
3235     (save-excursion (dired-mark-subdir-files)))
3236    ;; Mark the current (or next ARG) files.
3237    (t
3238     (let ((inhibit-read-only t))
3239       (dired-repeat-over-lines
3240        (prefix-numeric-value arg)
3241        (function (lambda () (delete-char 1) (insert dired-marker-char))))))))
3242
3243 (defun dired-unmark (arg &optional interactive)
3244   "Unmark the file at point in the Dired buffer.
3245 If the region is active, unmark all files in the region.
3246 Otherwise, with a prefix arg, unmark files on the next ARG lines.
3247
3248 If looking at a subdir, unmark all its files except `.' and `..'.
3249 If the region is active in Transient Mark mode, unmark all files
3250 in the active region."
3251   (interactive (list current-prefix-arg t))
3252   (let ((dired-marker-char ?\040))
3253     (dired-mark arg interactive)))
3254
3255 (defun dired-flag-file-deletion (arg &optional interactive)
3256   "In Dired, flag the current line's file for deletion.
3257 If the region is active, flag all files in the region.
3258 Otherwise, with a prefix arg, flag files on the next ARG lines.
3259
3260 If on a subdir headerline, flag all its files except `.' and `..'.
3261 If the region is active in Transient Mark mode, flag all files
3262 in the active region."
3263   (interactive (list current-prefix-arg t))
3264   (let ((dired-marker-char dired-del-marker))
3265     (dired-mark arg interactive)))
3266
3267 (defun dired-unmark-backward (arg)
3268   "In Dired, move up lines and remove marks or deletion flags there.
3269 Optional prefix ARG says how many lines to unmark/unflag; default
3270 is one line.
3271 If the region is active in Transient Mark mode, unmark all files
3272 in the active region."
3273   (interactive "p")
3274   (dired-unmark (- arg)))
3275
3276 (defun dired-toggle-marks ()
3277   "Toggle marks: marked files become unmarked, and vice versa.
3278 Files marked with other flags (such as `D') are not affected.
3279 `.' and `..' are never toggled.
3280 As always, hidden subdirs are not affected."
3281   (interactive)
3282   (save-excursion
3283     (goto-char (point-min))
3284     (let ((inhibit-read-only t))
3285       (while (not (eobp))
3286         (or (dired-between-files)
3287             (looking-at-p dired-re-dot)
3288             ;; use subst instead of insdel because it does not move
3289             ;; the gap and thus should be faster and because
3290             ;; other characters are left alone automatically
3291             (apply 'subst-char-in-region
3292                    (point) (1+ (point))
3293                    (if (eq ?\040 (following-char)) ; SPC
3294                        (list ?\040 dired-marker-char)
3295                      (list dired-marker-char ?\040))))
3296         (forward-line 1)))))
3297 \f
3298 ;;; Commands to mark or flag files based on their characteristics or names.
3299
3300 (defvar dired-regexp-history nil
3301   "History list of regular expressions used in Dired commands.")
3302
3303 (defun dired-read-regexp (prompt &optional default history)
3304   "Read a regexp using `read-regexp'."
3305   (declare (obsolete read-regexp "24.5"))
3306   (read-regexp prompt default (or history 'dired-regexp-history)))
3307
3308 (defun dired-mark-files-regexp (regexp &optional marker-char)
3309   "Mark all files matching REGEXP for use in later commands.
3310 A prefix argument means to unmark them instead.
3311 `.' and `..' are never marked.
3312
3313 REGEXP is an Emacs regexp, not a shell wildcard.  Thus, use `\\.o$' for
3314 object files--just `.o' will mark more than you might think."
3315   (interactive
3316    (list (read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
3317                               " files (regexp): ")
3318                       nil 'dired-regexp-history)
3319          (if current-prefix-arg ?\040)))
3320   (let ((dired-marker-char (or marker-char dired-marker-char)))
3321     (dired-mark-if
3322      (and (not (looking-at-p dired-re-dot))
3323           (not (eolp))                  ; empty line
3324           (let ((fn (dired-get-filename t t)))
3325             (and fn (string-match-p regexp fn))))
3326      "matching file")))
3327
3328 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
3329   "Mark all files with contents containing REGEXP for use in later commands.
3330 A prefix argument means to unmark them instead.
3331 `.' and `..' are never marked."
3332   (interactive
3333    (list (read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
3334                               " files containing (regexp): ")
3335                       nil 'dired-regexp-history)
3336          (if current-prefix-arg ?\040)))
3337   (let ((dired-marker-char (or marker-char dired-marker-char)))
3338     (dired-mark-if
3339      (and (not (looking-at-p dired-re-dot))
3340           (not (eolp))                  ; empty line
3341           (let ((fn (dired-get-filename nil t)))
3342             (when (and fn (file-readable-p fn)
3343                        (not (file-directory-p fn)))
3344               (let ((prebuf (get-file-buffer fn)))
3345                 (message "Checking %s" fn)
3346                 ;; For now we do it inside emacs
3347                 ;; Grep might be better if there are a lot of files
3348                 (if prebuf
3349                     (with-current-buffer prebuf
3350                       (save-excursion
3351                         (goto-char (point-min))
3352                         (re-search-forward regexp nil t)))
3353                   (with-temp-buffer
3354                     (insert-file-contents fn)
3355                     (goto-char (point-min))
3356                     (re-search-forward regexp nil t))))
3357                       )))
3358      "matching file")))
3359
3360 (defun dired-flag-files-regexp (regexp)
3361   "In Dired, flag all files containing the specified REGEXP for deletion.
3362 The match is against the non-directory part of the filename.  Use `^'
3363   and `$' to anchor matches.  Exclude subdirs by hiding them.
3364 `.' and `..' are never flagged."
3365   (interactive (list (read-regexp "Flag for deletion (regexp): "
3366                                   nil 'dired-regexp-history)))
3367   (dired-mark-files-regexp regexp dired-del-marker))
3368
3369 (defun dired-mark-symlinks (unflag-p)
3370   "Mark all symbolic links.
3371 With prefix argument, unmark or unflag all those files."
3372   (interactive "P")
3373   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3374     (dired-mark-if (looking-at-p dired-re-sym) "symbolic link")))
3375
3376 (defun dired-mark-directories (unflag-p)
3377   "Mark all directory file lines except `.' and `..'.
3378 With prefix argument, unmark or unflag all those files."
3379   (interactive "P")
3380   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3381     (dired-mark-if (and (looking-at-p dired-re-dir)
3382                         (not (looking-at-p dired-re-dot)))
3383                    "directory file")))
3384
3385 (defun dired-mark-executables (unflag-p)
3386   "Mark all executable files.
3387 With prefix argument, unmark or unflag all those files."
3388   (interactive "P")
3389   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3390     (dired-mark-if (looking-at-p dired-re-exe) "executable file")))
3391
3392 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3393 ;; files for which PREDICATE returns non-nil.
3394
3395 (defun dired-flag-auto-save-files (&optional unflag-p)
3396   "Flag for deletion files whose names suggest they are auto save files.
3397 A prefix argument says to unmark or unflag those files instead."
3398   (interactive "P")
3399   (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
3400     (dired-mark-if
3401      ;; It is less than general to check for # here,
3402      ;; but it's the only way this runs fast enough.
3403      (and (save-excursion (end-of-line)
3404                           (or
3405                            (eq (preceding-char) ?#)
3406                            ;; Handle executables in case of -F option.
3407                            ;; We need not worry about the other kinds
3408                            ;; of markings that -F makes, since they won't
3409                            ;; appear on real auto-save files.
3410                            (if (eq (preceding-char) ?*)
3411                                (progn
3412                                  (forward-char -1)
3413                                  (eq (preceding-char) ?#)))))
3414           (not (looking-at-p dired-re-dir))
3415           (let ((fn (dired-get-filename t t)))
3416             (if fn (auto-save-file-name-p
3417                     (file-name-nondirectory fn)))))
3418      "auto save file")))
3419
3420 (defcustom dired-garbage-files-regexp
3421   ;; `log' here is dubious, since it's typically used for useful log
3422   ;; files, not just TeX stuff.  -- fx
3423   (concat (regexp-opt
3424            '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
3425           "\\'")
3426   "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
3427   :type 'regexp
3428   :group 'dired)
3429
3430 (defun dired-flag-garbage-files ()
3431   "Flag for deletion all files that match `dired-garbage-files-regexp'."
3432   (interactive)
3433   (dired-flag-files-regexp dired-garbage-files-regexp))
3434
3435 (defun dired-flag-backup-files (&optional unflag-p)
3436   "Flag all backup files (names ending with `~') for deletion.
3437 With prefix argument, unmark or unflag these files."
3438   (interactive "P")
3439   (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
3440     (dired-mark-if
3441      ;; Don't call backup-file-name-p unless the last character looks like
3442      ;; it might be the end of a backup file name.  This isn't very general,
3443      ;; but it's the only way this runs fast enough.
3444      (and (save-excursion (end-of-line)
3445                           ;; Handle executables in case of -F option.
3446                           ;; We need not worry about the other kinds
3447                           ;; of markings that -F makes, since they won't
3448                           ;; appear on real backup files.
3449                           (if (eq (preceding-char) ?*)
3450                               (forward-char -1))
3451                           (eq (preceding-char) ?~))
3452           (not (looking-at-p dired-re-dir))
3453           (let ((fn (dired-get-filename t t)))
3454             (if fn (backup-file-name-p fn))))
3455      "backup file")))
3456
3457 (defun dired-change-marks (&optional old new)
3458   "Change all OLD marks to NEW marks.
3459 OLD and NEW are both characters used to mark files."
3460   (interactive
3461    (let* ((cursor-in-echo-area t)
3462           (old (progn (message "Change (old mark): ") (read-char)))
3463           (new (progn (message  "Change %c marks to (new mark): " old)
3464                       (read-char))))
3465      (list old new)))
3466   (if (or (eq old ?\r) (eq new ?\r))
3467       (ding)
3468     (let ((string (format "\n%c" old))
3469           (inhibit-read-only t))
3470       (save-excursion
3471         (goto-char (point-min))
3472         (while (search-forward string nil t)
3473           (if (if (= old ?\s)
3474                   (save-match-data
3475                     (dired-get-filename 'no-dir t))
3476                 t)
3477               (subst-char-in-region (match-beginning 0)
3478                                     (match-end 0) old new)))))))
3479
3480 (defun dired-unmark-all-marks ()
3481   "Remove all marks from all files in the Dired buffer."
3482   (interactive)
3483   (dired-unmark-all-files ?\r))
3484
3485 (defun dired-unmark-all-files (mark &optional arg)
3486   "Remove a specific mark (or any mark) from every file.
3487 After this command, type the mark character to remove,
3488 or type RET to remove all marks.
3489 With prefix arg, query for each marked file.
3490 Type \\[help-command] at that time for help."
3491   (interactive "cRemove marks (RET means all): \nP")
3492   (save-excursion
3493     (let* ((count 0)
3494            (inhibit-read-only t) case-fold-search
3495            (string (format "\n%c" mark))
3496            (help-form "\
3497 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3498 `!' to unmark all remaining files with no more questions."))
3499       (goto-char (point-min))
3500       (while (if (eq mark ?\r)
3501                  (re-search-forward dired-re-mark nil t)
3502                (search-forward string nil t))
3503         (if (or (not arg)
3504                 (let ((file (dired-get-filename t t)))
3505                   (and file
3506                        (dired-query 'query "Unmark file `%s'? "
3507                                     file))))
3508             (progn (subst-char-in-region (1- (point)) (point)
3509                                          (preceding-char) ?\s)
3510                    (setq count (1+ count)))))
3511       (message (if (= count 1) "1 mark removed"
3512                  "%d marks removed")
3513                count))))
3514 \f
3515 ;; Logging failures operating on files, and showing the results.
3516
3517 (defvar dired-log-buffer "*Dired log*")
3518
3519 (defun dired-why ()
3520   "Pop up a buffer with error log output from Dired.
3521 A group of errors from a single command ends with a formfeed.
3522 Thus, use \\[backward-page] to find the beginning of a group of errors."
3523   (interactive)
3524   (if (get-buffer dired-log-buffer)
3525       (let ((owindow (selected-window))
3526             (window (display-buffer (get-buffer dired-log-buffer))))
3527         (unwind-protect
3528             (progn
3529               (select-window window)
3530               (goto-char (point-max))
3531               (forward-line -1)
3532               (backward-page 1)
3533               (recenter 0))
3534           (select-window owindow)))))
3535
3536 (defun dired-log (log &rest args)
3537   ;; Log a message or the contents of a buffer.
3538   ;; If LOG is a string and there are more args, it is formatted with
3539   ;; those ARGS.  Usually the LOG string ends with a \n.
3540   ;; End each bunch of errors with (dired-log t):
3541   ;; this inserts the current time and buffer at the start of the page,
3542   ;; and \f (formfeed) at the end.
3543   (let ((obuf (current-buffer)))
3544     (with-current-buffer (get-buffer-create dired-log-buffer)
3545       (goto-char (point-max))
3546       (let ((inhibit-read-only t))
3547         (cond ((stringp log)
3548                (insert (if args
3549                            (apply (function format) log args)
3550                          log)))
3551               ((bufferp log)
3552                (insert-buffer-substring log))
3553               ((eq t log)
3554                (backward-page 1)
3555                (unless (bolp)
3556                  (insert "\n"))
3557                (insert (current-time-string)
3558                        "\tBuffer `" (buffer-name obuf) "'\n")
3559                (goto-char (point-max))
3560                (insert "\f\n")))))))
3561
3562 (defun dired-log-summary (string failures)
3563   "State a summary of a command's failures, in echo area and log buffer.
3564 STRING is an overall summary of the failures.
3565 FAILURES is a list of file names that we failed to operate on,
3566 or nil if file names are not applicable."
3567   (if (= (length failures) 1)
3568       (message "%s"
3569                (with-current-buffer dired-log-buffer
3570                  (goto-char (point-max))
3571                  (backward-page 1)
3572                  (if (eolp) (forward-line 1))
3573                  (buffer-substring (point) (point-max))))
3574     (message (if failures "%s--type ? for details (%s)"
3575                "%s--type ? for details")
3576              string failures))
3577   ;; Log a summary describing a bunch of errors.
3578   (dired-log (concat "\n" string "\n"))
3579   (dired-log t))
3580 \f
3581 ;;; Sorting
3582
3583 ;; Most ls can only sort by name or by date (with -t), nothing else.
3584 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3585 ;; So anything that does not contain these is sort "by name".
3586
3587 (defvar dired-ls-sorting-switches "SXU"
3588   "String of `ls' switches (single letters) except \"t\" that influence sorting.
3589
3590 This indicates to Dired which option switches to watch out for because they
3591 will change the sorting order behavior of `ls'.
3592
3593 To change the default sorting order (e.g. add a `-v' option), see the
3594 variable `dired-listing-switches'.  To temporarily override the listing
3595 format, use `\\[universal-argument] \\[dired]'.")
3596
3597 (defvar dired-sort-by-date-regexp
3598   (concat "\\(\\`\\| \\)-[^- ]*t"
3599           ;; `dired-ls-sorting-switches' after -t overrides -t.
3600           "[^ " dired-ls-sorting-switches "]*"
3601           "\\(\\(\\`\\| +\\)\\(--[^ ]+\\|-[^- t"
3602           dired-ls-sorting-switches "]+\\)\\)* *$")
3603   "Regexp recognized by Dired to set `by date' mode.")
3604
3605 (defvar dired-sort-by-name-regexp
3606   (concat "\\`\\(\\(\\`\\| +\\)\\(--[^ ]+\\|"
3607           "-[^- t" dired-ls-sorting-switches "]+\\)\\)* *$")
3608   "Regexp recognized by Dired to set `by name' mode.")
3609
3610 (defvar dired-sort-inhibit nil
3611   "Non-nil means the Dired sort command is disabled.
3612 The idea is to set this buffer-locally in special Dired buffers.")
3613
3614 (defun dired-sort-set-mode-line ()
3615   ;; Set mode line display according to dired-actual-switches.
3616   ;; Mode line display of "by name" or "by date" guarantees the user a
3617   ;; match with the corresponding regexps.  Non-matching switches are
3618   ;; shown literally.
3619   (when (eq major-mode 'dired-mode)
3620     (setq mode-name
3621           (let (case-fold-search)
3622             (cond ((string-match-p
3623                     dired-sort-by-name-regexp dired-actual-switches)
3624                    "Dired by name")
3625                   ((string-match-p
3626                     dired-sort-by-date-regexp dired-actual-switches)
3627                    "Dired by date")
3628                   (t
3629                    (concat "Dired " dired-actual-switches)))))
3630     (force-mode-line-update)))
3631
3632 (define-obsolete-function-alias 'dired-sort-set-modeline
3633   'dired-sort-set-mode-line "24.3")
3634
3635 (defun dired-sort-toggle-or-edit (&optional arg)
3636   "Toggle sorting by date, and refresh the Dired buffer.
3637 With a prefix argument, edit the current listing switches instead."
3638   (interactive "P")
3639   (when dired-sort-inhibit
3640     (error "Cannot sort this Dired buffer"))
3641   (if arg
3642       (dired-sort-other
3643        (read-string "ls switches (must contain -l): " dired-actual-switches))
3644     (dired-sort-toggle)))
3645
3646 (defun dired-sort-toggle ()
3647   ;; Toggle between sort by date/name.  Reverts the buffer.
3648   (let ((sorting-by-date (string-match-p dired-sort-by-date-regexp
3649                                          dired-actual-switches))
3650         ;; Regexp for finding (possibly embedded) -t switches.
3651         (switch-regexp "\\(\\`\\| \\)-\\([a-su-zA-Z]*\\)\\(t\\)\\([^ ]*\\)")
3652         case-fold-search)
3653     ;; Remove the -t switch.
3654     (while (string-match switch-regexp dired-actual-switches)
3655       (if (and (equal (match-string 2 dired-actual-switches) "")
3656                (equal (match-string 4 dired-actual-switches) ""))
3657           ;; Remove a stand-alone -t switch.
3658           (setq dired-actual-switches
3659                 (replace-match "" t t dired-actual-switches))
3660         ;; Remove a switch of the form -XtY for some X and Y.
3661         (setq dired-actual-switches
3662               (replace-match "" t t dired-actual-switches 3))))
3663
3664     ;; Now, if we weren't sorting by date before, add the -t switch.
3665     ;; Some simple-minded ls implementations (eg ftp servers) only
3666     ;; allow a single option string, so try not to add " -t" if possible.
3667     (unless sorting-by-date
3668       (setq dired-actual-switches
3669             (concat dired-actual-switches
3670                     (if (string-match-p "\\`-[[:alnum:]]+\\'"
3671                                         dired-actual-switches)
3672                         "t"
3673                       " -t")))))
3674   (dired-sort-set-mode-line)
3675   (revert-buffer))
3676
3677 ;; Some user code loads dired especially for this.
3678 ;; Don't do that--use replace-regexp-in-string instead.
3679 (defun dired-replace-in-string (regexp newtext string)
3680   ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3681   ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3682   (let ((result "") (start 0) mb me)
3683     (while (string-match regexp string start)
3684       (setq mb (match-beginning 0)
3685             me (match-end 0)
3686             result (concat result (substring string start mb) newtext)
3687             start me))
3688     (concat result (substring string start))))
3689
3690 (defun dired-sort-other (switches &optional no-revert)
3691   "Specify new `ls' SWITCHES for current Dired buffer.
3692 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3693 set the minor mode accordingly, others appear literally in the mode line.
3694 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3695   (dired-sort-R-check switches)
3696   (setq dired-actual-switches switches)
3697   (dired-sort-set-mode-line)
3698   (or no-revert (revert-buffer)))
3699
3700 (defvar-local dired-subdir-alist-pre-R nil
3701   "Value of `dired-subdir-alist' before -R switch added.")
3702
3703 (defun dired-sort-R-check (switches)
3704   "Additional processing of -R in ls option string SWITCHES.
3705 Saves `dired-subdir-alist' when R is set and restores saved value
3706 minus any directories explicitly deleted when R is cleared.
3707 To be called first in body of `dired-sort-other', etc."
3708   (cond
3709    ((and (dired-switches-recursive-p switches)
3710          (not (dired-switches-recursive-p dired-actual-switches)))
3711     ;; Adding -R to ls switches -- save `dired-subdir-alist':
3712     (setq dired-subdir-alist-pre-R dired-subdir-alist))
3713    ((and (dired-switches-recursive-p dired-actual-switches)
3714          (not (dired-switches-recursive-p switches)))
3715     ;; Deleting -R from ls switches -- revert to pre-R subdirs
3716     ;; that are still present:
3717     (setq dired-subdir-alist
3718           (if dired-subdir-alist-pre-R
3719               (let (subdirs)
3720                 (while dired-subdir-alist-pre-R
3721                   (if (assoc (caar dired-subdir-alist-pre-R)
3722                              dired-subdir-alist)
3723                       ;; subdir still present...
3724                       (setq subdirs
3725                             (cons (car dired-subdir-alist-pre-R)
3726                                   subdirs)))
3727                   (setq dired-subdir-alist-pre-R
3728                         (cdr dired-subdir-alist-pre-R)))
3729                 (reverse subdirs))
3730             ;; No pre-R subdir alist, so revert to main directory
3731             ;; listing:
3732             (list (car (reverse dired-subdir-alist))))))))
3733 \f
3734
3735 ;;;;  Drag and drop support
3736
3737 (defcustom dired-recursive-copies 'top
3738   "Whether Dired copies directories recursively.
3739 If nil, never copy recursively.
3740 `always' means to copy recursively without asking.
3741 `top' means to ask for each directory at top level.
3742 Any other value means to ask for each directory."
3743   :type '(choice :tag "Copy directories"
3744                  (const :tag "No recursive copies" nil)
3745                  (const :tag "Ask for each directory" t)
3746                  (const :tag "Ask for each top directory only" top)
3747                  (const :tag "Copy directories without asking" always))
3748   :group 'dired)
3749
3750 (defun dired-dnd-popup-notice ()
3751   (message-box
3752    "Dired recursive copies are currently disabled.\nSee the variable `dired-recursive-copies'."))
3753
3754 (declare-function x-popup-menu "menu.c" (position menu))
3755
3756 (defun dired-dnd-do-ask-action (uri)
3757   ;; No need to get actions and descriptions from the source,
3758   ;; we only have three actions anyway.
3759   (let ((action (x-popup-menu
3760                  t
3761                  (list "What action?"
3762                        (cons ""
3763                              '(("Copy here" . copy)
3764                                ("Move here" . move)
3765                                ("Link here" . link)
3766                                "--"
3767                                ("Cancel" . nil)))))))
3768     (if action
3769         (dired-dnd-handle-local-file uri action)
3770       nil)))
3771
3772 (declare-function dired-relist-entry "dired-aux" (file))
3773 (declare-function make-symbolic-link "fileio.c")
3774
3775 ;; Only used when (featurep 'dnd).
3776 (declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3777 (declare-function dnd-get-local-file-uri "dnd" (uri))
3778
3779 (defvar dired-overwrite-confirmed)      ;Defined in dired-aux.
3780
3781 (defun dired-dnd-handle-local-file (uri action)
3782   "Copy, move or link a file to the Dired directory.
3783 URI is the file to handle, ACTION is one of copy, move, link or ask.
3784 Ask means pop up a menu for the user to select one of copy, move or link."
3785   (require 'dired-aux)
3786   (let* ((from (dnd-get-local-file-name uri t))
3787          (to (when from
3788                (concat (dired-current-directory)
3789                        (file-name-nondirectory from)))))
3790     (when from
3791       (cond ((eq action 'ask)
3792              (dired-dnd-do-ask-action uri))
3793             ;; If copying a directory and dired-recursive-copies is
3794             ;; nil, dired-copy-file fails.  Pop up a notice.
3795             ((and (memq action '(copy private))
3796                   (file-directory-p from)
3797                   (not dired-recursive-copies))
3798              (dired-dnd-popup-notice))
3799             ((memq action '(copy private move link))
3800              (let ((overwrite (and (file-exists-p to)
3801                                    (y-or-n-p
3802                                     (format "Overwrite existing file `%s'? " to))))
3803                    ;; Binding dired-overwrite-confirmed to nil makes
3804                    ;; dired-handle-overwrite a no-op.  We instead use
3805                    ;; y-or-n-p, which pops a graphical menu.
3806                    dired-overwrite-confirmed backup-file)
3807                (when (and overwrite
3808                           ;; d-b-o is defined in dired-aux.
3809                           (boundp 'dired-backup-overwrite)
3810                           dired-backup-overwrite
3811                           (setq backup-file
3812                                 (car (find-backup-file-name to)))
3813                           (or (eq dired-backup-overwrite 'always)
3814                               (y-or-n-p
3815                                (format
3816                                 "Make backup for existing file `%s'? " to))))
3817                  (rename-file to backup-file 0)
3818                  (dired-relist-entry backup-file))
3819                (cond ((memq action '(copy private))
3820                       (dired-copy-file from to overwrite))
3821                      ((eq action 'move)
3822                       (dired-rename-file from to overwrite))
3823                      ((eq action 'link)
3824                       (make-symbolic-link from to overwrite)))
3825                (dired-relist-entry to)
3826                action))))))
3827
3828 (defun dired-dnd-handle-file (uri action)
3829   "Copy, move or link a file to the Dired directory if it is a local file.
3830 URI is the file to handle.  If the hostname in the URI isn't local, do nothing.
3831 ACTION is one of copy, move, link or ask.
3832 Ask means pop up a menu for the user to select one of copy, move or link."
3833   (let ((local-file (dnd-get-local-file-uri uri)))
3834     (if local-file (dired-dnd-handle-local-file local-file action)
3835       nil)))
3836 \f
3837
3838 ;;;;  Desktop support
3839
3840 (eval-when-compile (require 'desktop))
3841 (declare-function desktop-file-name "desktop" (filename dirname))
3842
3843 (defun dired-desktop-buffer-misc-data (dirname)
3844   "Auxiliary information to be saved in desktop file."
3845   (cons
3846    ;; Value of `dired-directory'.
3847    (if (consp dired-directory)
3848        ;; Directory name followed by list of files.
3849        (cons (desktop-file-name (car dired-directory) dirname)
3850              (cdr dired-directory))
3851      ;; Directory name, optionally with shell wildcard.
3852      (desktop-file-name dired-directory dirname))
3853    ;; Subdirectories in `dired-subdir-alist'.
3854    (cdr
3855      (nreverse
3856        (mapcar
3857          (function (lambda (f) (desktop-file-name (car f) dirname)))
3858          dired-subdir-alist)))))
3859
3860 (defun dired-restore-desktop-buffer (_file-name
3861                                      _buffer-name
3862                                      misc-data)
3863   "Restore a Dired buffer specified in a desktop file."
3864   ;; First element of `misc-data' is the value of `dired-directory'.
3865   ;; This value is a directory name, optionally with shell wildcard or
3866   ;; a directory name followed by list of files.
3867   (let* ((dired-dir (car misc-data))
3868          (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3869     (if (file-directory-p (file-name-directory dir))
3870         (with-demoted-errors "Desktop: Problem restoring directory: %S"
3871           (dired dired-dir)
3872           ;; The following elements of `misc-data' are the keys
3873           ;; from `dired-subdir-alist'.
3874           (mapc 'dired-maybe-insert-subdir (cdr misc-data))
3875           (current-buffer))
3876       (message "Desktop: Directory %s no longer exists." dir)
3877       (when desktop-missing-file-warning (sit-for 1))
3878       nil)))
3879
3880 (add-to-list 'desktop-buffer-mode-handlers
3881              '(dired-mode . dired-restore-desktop-buffer))
3882
3883 \f
3884 ;;; Start of automatically extracted autoloads.
3885 \f
3886 ;;;### (autoloads nil "dired-aux" "dired-aux.el" "1448837b5f3e2b9ad63f723361f1e32e")
3887 ;;; Generated autoloads from dired-aux.el
3888
3889 (autoload 'dired-diff "dired-aux" "\
3890 Compare file at point with file FILE using `diff'.
3891 If called interactively, prompt for FILE.  If the file at point
3892 has a backup file, use that as the default.  If the file at point
3893 is a backup file, use its original.  If the mark is active
3894 in Transient Mark mode, use the file at the mark as the default.
3895 \(That's the mark set by \\[set-mark-command], not by Dired's
3896 \\[dired-mark] command.)
3897
3898 FILE is the first file given to `diff'.  The file at point
3899 is the second file given to `diff'.
3900
3901 With prefix arg, prompt for second argument SWITCHES, which is
3902 the string of command switches for the third argument of `diff'.
3903
3904 \(fn FILE &optional SWITCHES)" t nil)
3905
3906 (autoload 'dired-backup-diff "dired-aux" "\
3907 Diff this file with its backup file or vice versa.
3908 Uses the latest backup, if there are several numerical backups.
3909 If this file is a backup, diff it with its original.
3910 The backup file is the first file given to `diff'.
3911 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3912
3913 \(fn &optional SWITCHES)" t nil)
3914
3915 (autoload 'dired-compare-directories "dired-aux" "\
3916 Mark files with different file attributes in two dired buffers.
3917 Compare file attributes of files in the current directory
3918 with file attributes in directory DIR2 using PREDICATE on pairs of files
3919 with the same name.  Mark files for which PREDICATE returns non-nil.
3920 Mark files with different names if PREDICATE is nil (or interactively
3921 with empty input at the predicate prompt).
3922
3923 PREDICATE is a Lisp expression that can refer to the following variables:
3924
3925     size1, size2   - file size in bytes
3926     mtime1, mtime2 - last modification time in seconds, as a float
3927     fa1, fa2       - list of file attributes
3928                      returned by function `file-attributes'
3929
3930     where 1 refers to attribute of file in the current dired buffer
3931     and 2 to attribute of file in second dired buffer.
3932
3933 Examples of PREDICATE:
3934
3935     (> mtime1 mtime2) - mark newer files
3936     (not (= size1 size2)) - mark files with different sizes
3937     (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3938     (not (and (= (nth 2 fa1) (nth 2 fa2))   - mark files with different UID
3939               (= (nth 3 fa1) (nth 3 fa2))))   and GID.
3940
3941 \(fn DIR2 PREDICATE)" t nil)
3942
3943 (autoload 'dired-do-chmod "dired-aux" "\
3944 Change the mode of the marked (or next ARG) files.
3945 Symbolic modes like `g+w' are allowed.
3946 Type M-n to pull the file attributes of the file at point
3947 into the minibuffer.
3948
3949 \(fn &optional ARG)" t nil)
3950
3951 (autoload 'dired-do-chgrp "dired-aux" "\
3952 Change the group of the marked (or next ARG) files.
3953 Type M-n to pull the file attributes of the file at point
3954 into the minibuffer.
3955
3956 \(fn &optional ARG)" t nil)
3957
3958 (autoload 'dired-do-chown "dired-aux" "\
3959 Change the owner of the marked (or next ARG) files.
3960 Type M-n to pull the file attributes of the file at point
3961 into the minibuffer.
3962
3963 \(fn &optional ARG)" t nil)
3964
3965 (autoload 'dired-do-touch "dired-aux" "\
3966 Change the timestamp of the marked (or next ARG) files.
3967 This calls touch.
3968 Type M-n to pull the file attributes of the file at point
3969 into the minibuffer.
3970
3971 \(fn &optional ARG)" t nil)
3972
3973 (autoload 'dired-do-print "dired-aux" "\
3974 Print the marked (or next ARG) files.
3975 Uses the shell command coming from variables `lpr-command' and
3976 `lpr-switches' as default.
3977
3978 \(fn &optional ARG)" t nil)
3979
3980 (autoload 'dired-clean-directory "dired-aux" "\
3981 Flag numerical backups for deletion.
3982 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3983 Positive prefix arg KEEP overrides `dired-kept-versions';
3984 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3985
3986 To clear the flags on these files, you can use \\[dired-flag-backup-files]
3987 with a prefix argument.
3988
3989 \(fn KEEP)" t nil)
3990
3991 (autoload 'dired-do-async-shell-command "dired-aux" "\
3992 Run a shell command COMMAND on the marked files asynchronously.
3993
3994 Like `dired-do-shell-command', but adds `&' at the end of COMMAND
3995 to execute it asynchronously.
3996
3997 When operating on multiple files, asynchronous commands
3998 are executed in the background on each file in parallel.
3999 In shell syntax this means separating the individual commands
4000 with `&'.  However, when COMMAND ends in `;' or `;&' then commands
4001 are executed in the background on each file sequentially waiting
4002 for each command to terminate before running the next command.
4003 In shell syntax this means separating the individual commands with `;'.
4004
4005 The output appears in the buffer `*Async Shell Command*'.
4006
4007 \(fn COMMAND &optional ARG FILE-LIST)" t nil)
4008
4009 (autoload 'dired-do-shell-command "dired-aux" "\
4010 Run a shell command COMMAND on the marked files.
4011 If no files are marked or a numeric prefix arg is given,
4012 the next ARG files are used.  Just \\[universal-argument] means the current file.
4013 The prompt mentions the file(s) or the marker, as appropriate.
4014
4015 If there is a `*' in COMMAND, surrounded by whitespace, this runs
4016 COMMAND just once with the entire file list substituted there.
4017
4018 If there is no `*', but there is a `?' in COMMAND, surrounded by
4019 whitespace, this runs COMMAND on each file individually with the
4020 file name substituted for `?'.
4021
4022 Otherwise, this runs COMMAND on each file individually with the
4023 file name added at the end of COMMAND (separated by a space).
4024
4025 `*' and `?' when not surrounded by whitespace have no special
4026 significance for `dired-do-shell-command', and are passed through
4027 normally to the shell, but you must confirm first.
4028
4029 If you want to use `*' as a shell wildcard with whitespace around
4030 it, write `*\"\"' in place of just `*'.  This is equivalent to just
4031 `*' in the shell, but avoids Dired's special handling.
4032
4033 If COMMAND ends in `&', `;', or `;&', it is executed in the
4034 background asynchronously, and the output appears in the buffer
4035 `*Async Shell Command*'.  When operating on multiple files and COMMAND
4036 ends in `&', the shell command is executed on each file in parallel.
4037 However, when COMMAND ends in `;' or `;&' then commands are executed
4038 in the background on each file sequentially waiting for each command
4039 to terminate before running the next command.  You can also use
4040 `dired-do-async-shell-command' that automatically adds `&'.
4041
4042 Otherwise, COMMAND is executed synchronously, and the output
4043 appears in the buffer `*Shell Command Output*'.
4044
4045 This feature does not try to redisplay Dired buffers afterward, as
4046 there's no telling what files COMMAND may have changed.
4047 Type \\[dired-do-redisplay] to redisplay the marked files.
4048
4049 When COMMAND runs, its working directory is the top-level directory
4050 of the Dired buffer, so output files usually are created there
4051 instead of in a subdir.
4052
4053 In a noninteractive call (from Lisp code), you must specify
4054 the list of file names explicitly with the FILE-LIST argument, which
4055 can be produced by `dired-get-marked-files', for example.
4056
4057 \(fn COMMAND &optional ARG FILE-LIST)" t nil)
4058
4059 (autoload 'dired-run-shell-command "dired-aux" "\
4060
4061
4062 \(fn COMMAND)" nil nil)
4063
4064 (autoload 'dired-do-kill-lines "dired-aux" "\
4065 Kill all marked lines (not the files).
4066 With a prefix argument, kill that many lines starting with the current line.
4067 \(A negative argument kills backward.)
4068 If you use this command with a prefix argument to kill the line
4069 for a file that is a directory, which you have inserted in the
4070 Dired buffer as a subdirectory, then it deletes that subdirectory
4071 from the buffer as well.
4072 To kill an entire subdirectory (without killing its line in the
4073 parent directory), go to its directory header line and use this
4074 command with a prefix argument (the value does not matter).
4075
4076 \(fn &optional ARG FMT)" t nil)
4077
4078 (autoload 'dired-compress-file "dired-aux" "\
4079
4080
4081 \(fn FILE)" nil nil)
4082
4083 (autoload 'dired-query "dired-aux" "\
4084 Format PROMPT with ARGS, query user, and store the result in SYM.
4085 The return value is either nil or t.
4086
4087 The user may type y or SPC to accept once; n or DEL to skip once;
4088 ! to accept this and subsequent queries; or q or ESC to decline
4089 this and subsequent queries.
4090
4091 If SYM is already bound to a non-nil value, this function may
4092 return automatically without querying the user.  If SYM is !,
4093 return t; if SYM is q or ESC, return nil.
4094
4095 \(fn SYM PROMPT &rest ARGS)" nil nil)
4096
4097 (autoload 'dired-do-compress "dired-aux" "\
4098 Compress or uncompress marked (or next ARG) files.
4099
4100 \(fn &optional ARG)" t nil)
4101
4102 (autoload 'dired-do-byte-compile "dired-aux" "\
4103 Byte compile marked (or next ARG) Emacs Lisp files.
4104
4105 \(fn &optional ARG)" t nil)
4106
4107 (autoload 'dired-do-load "dired-aux" "\
4108 Load the marked (or next ARG) Emacs Lisp files.
4109
4110 \(fn &optional ARG)" t nil)
4111
4112 (autoload 'dired-do-redisplay "dired-aux" "\
4113 Redisplay all marked (or next ARG) files.
4114 If on a subdir line, redisplay that subdirectory.  In that case,
4115 a prefix arg lets you edit the `ls' switches used for the new listing.
4116
4117 Dired remembers switches specified with a prefix arg, so that reverting
4118 the buffer will not reset them.  However, using `dired-undo' to re-insert
4119 or delete subdirectories can bypass this machinery.  Hence, you sometimes
4120 may have to reset some subdirectory switches after a `dired-undo'.
4121 You can reset all subdirectory switches to the default using
4122 \\<dired-mode-map>\\[dired-reset-subdir-switches].
4123 See Info node `(emacs)Subdir switches' for more details.
4124
4125 \(fn &optional ARG TEST-FOR-SUBDIR)" t nil)
4126
4127 (autoload 'dired-add-file "dired-aux" "\
4128
4129
4130 \(fn FILENAME &optional MARKER-CHAR)" nil nil)
4131
4132 (autoload 'dired-remove-file "dired-aux" "\
4133
4134
4135 \(fn FILE)" nil nil)
4136
4137 (autoload 'dired-relist-file "dired-aux" "\
4138 Create or update the line for FILE in all Dired buffers it would belong in.
4139
4140 \(fn FILE)" nil nil)
4141
4142 (autoload 'dired-copy-file "dired-aux" "\
4143
4144
4145 \(fn FROM TO OK-FLAG)" nil nil)
4146
4147 (autoload 'dired-rename-file "dired-aux" "\
4148
4149
4150 \(fn FILE NEWNAME OK-IF-ALREADY-EXISTS)" nil nil)
4151
4152 (autoload 'dired-create-directory "dired-aux" "\
4153 Create a directory called DIRECTORY.
4154 If DIRECTORY already exists, signal an error.
4155
4156 \(fn DIRECTORY)" t nil)
4157
4158 (autoload 'dired-do-copy "dired-aux" "\
4159 Copy all marked (or next ARG) files, or copy the current file.
4160 When operating on just the current file, prompt for the new name.
4161
4162 When operating on multiple or marked files, prompt for a target
4163 directory, and make the new copies in that directory, with the
4164 same names as the original files.  The initial suggestion for the
4165 target directory is the Dired buffer's current directory (or, if
4166 `dired-dwim-target' is non-nil, the current directory of a
4167 neighboring Dired window).
4168
4169 If `dired-copy-preserve-time' is non-nil, this command preserves
4170 the modification time of each old file in the copy, similar to
4171 the \"-p\" option for the \"cp\" shell command.
4172
4173 This command copies symbolic links by creating new ones, similar
4174 to the \"-d\" option for the \"cp\" shell command.
4175
4176 \(fn &optional ARG)" t nil)
4177
4178 (autoload 'dired-do-symlink "dired-aux" "\
4179 Make symbolic links to current file or all marked (or next ARG) files.
4180 When operating on just the current file, you specify the new name.
4181 When operating on multiple or marked files, you specify a directory
4182 and new symbolic links are made in that directory
4183 with the same names that the files currently have.  The default
4184 suggested for the target directory depends on the value of
4185 `dired-dwim-target', which see.
4186
4187 For relative symlinks, use \\[dired-do-relsymlink].
4188
4189 \(fn &optional ARG)" t nil)
4190
4191 (autoload 'dired-do-hardlink "dired-aux" "\
4192 Add names (hard links) current file or all marked (or next ARG) files.
4193 When operating on just the current file, you specify the new name.
4194 When operating on multiple or marked files, you specify a directory
4195 and new hard links are made in that directory
4196 with the same names that the files currently have.  The default
4197 suggested for the target directory depends on the value of
4198 `dired-dwim-target', which see.
4199
4200 \(fn &optional ARG)" t nil)
4201
4202 (autoload 'dired-do-rename "dired-aux" "\
4203 Rename current file or all marked (or next ARG) files.
4204 When renaming just the current file, you specify the new name.
4205 When renaming multiple or marked files, you specify a directory.
4206 This command also renames any buffers that are visiting the files.
4207 The default suggested for the target directory depends on the value
4208 of `dired-dwim-target', which see.
4209
4210 \(fn &optional ARG)" t nil)
4211
4212 (autoload 'dired-do-rename-regexp "dired-aux" "\
4213 Rename selected files whose names match REGEXP to NEWNAME.
4214
4215 With non-zero prefix argument ARG, the command operates on the next ARG
4216 files.  Otherwise, it operates on all the marked files, or the current
4217 file if none are marked.
4218
4219 As each match is found, the user must type a character saying
4220   what to do with it.  For directions, type \\[help-command] at that time.
4221 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
4222 REGEXP defaults to the last regexp used.
4223
4224 With a zero prefix arg, renaming by regexp affects the absolute file name.
4225 Normally, only the non-directory part of the file name is used and changed.
4226
4227 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
4228
4229 (autoload 'dired-do-copy-regexp "dired-aux" "\
4230 Copy selected files whose names match REGEXP to NEWNAME.
4231 See function `dired-do-rename-regexp' for more info.
4232
4233 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
4234
4235 (autoload 'dired-do-hardlink-regexp "dired-aux" "\
4236 Hardlink selected files whose names match REGEXP to NEWNAME.
4237 See function `dired-do-rename-regexp' for more info.
4238
4239 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
4240
4241 (autoload 'dired-do-symlink-regexp "dired-aux" "\
4242 Symlink selected files whose names match REGEXP to NEWNAME.
4243 See function `dired-do-rename-regexp' for more info.
4244
4245 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
4246
4247 (autoload 'dired-upcase "dired-aux" "\
4248 Rename all marked (or next ARG) files to upper case.
4249
4250 \(fn &optional ARG)" t nil)
4251
4252 (autoload 'dired-downcase "dired-aux" "\
4253 Rename all marked (or next ARG) files to lower case.
4254
4255 \(fn &optional ARG)" t nil)
4256
4257 (autoload 'dired-maybe-insert-subdir "dired-aux" "\
4258 Insert this subdirectory into the same dired buffer.
4259 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
4260   else inserts it at its natural place (as `ls -lR' would have done).
4261 With a prefix arg, you may edit the ls switches used for this listing.
4262   You can add `R' to the switches to expand the whole tree starting at
4263   this subdirectory.
4264 This function takes some pains to conform to `ls -lR' output.
4265
4266 Dired remembers switches specified with a prefix arg, so that reverting
4267 the buffer will not reset them.  However, using `dired-undo' to re-insert
4268 or delete subdirectories can bypass this machinery.  Hence, you sometimes
4269 may have to reset some subdirectory switches after a `dired-undo'.
4270 You can reset all subdirectory switches to the default using
4271 \\<dired-mode-map>\\[dired-reset-subdir-switches].
4272 See Info node `(emacs)Subdir switches' for more details.
4273
4274 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
4275
4276 (autoload 'dired-insert-subdir "dired-aux" "\
4277 Insert this subdirectory into the same Dired buffer.
4278 If it is already present, overwrite the previous entry;
4279   otherwise, insert it at its natural place (as `ls -lR' would
4280   have done).
4281 With a prefix arg, you may edit the `ls' switches used for this listing.
4282   You can add `R' to the switches to expand the whole tree starting at
4283   this subdirectory.
4284 This function takes some pains to conform to `ls -lR' output.
4285
4286 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
4287
4288 (autoload 'dired-prev-subdir "dired-aux" "\
4289 Go to previous subdirectory, regardless of level.
4290 When called interactively and not on a subdir line, go to this subdir's line.
4291
4292 \(fn ARG &optional NO-ERROR-IF-NOT-FOUND NO-SKIP)" t nil)
4293
4294 (autoload 'dired-goto-subdir "dired-aux" "\
4295 Go to end of header line of DIR in this dired buffer.
4296 Return value of point on success, otherwise return nil.
4297 The next char is either \\n, or \\r if DIR is hidden.
4298
4299 \(fn DIR)" t nil)
4300
4301 (autoload 'dired-mark-subdir-files "dired-aux" "\
4302 Mark all files except `.' and `..' in current subdirectory.
4303 If the Dired buffer shows multiple directories, this command
4304 marks the files listed in the subdirectory that point is in.
4305
4306 \(fn)" t nil)
4307
4308 (autoload 'dired-kill-subdir "dired-aux" "\
4309 Remove all lines of current subdirectory.
4310 Lower levels are unaffected.
4311
4312 \(fn &optional REMEMBER-MARKS)" t nil)
4313
4314 (autoload 'dired-tree-up "dired-aux" "\
4315 Go up ARG levels in the dired tree.
4316
4317 \(fn ARG)" t nil)
4318
4319 (autoload 'dired-tree-down "dired-aux" "\
4320 Go down in the dired tree.
4321
4322 \(fn)" t nil)
4323
4324 (autoload 'dired-hide-subdir "dired-aux" "\
4325 Hide or unhide the current subdirectory and move to next directory.
4326 Optional prefix arg is a repeat factor.
4327 Use \\[dired-hide-all] to (un)hide all directories.
4328
4329 \(fn ARG)" t nil)
4330
4331 (autoload 'dired-hide-all "dired-aux" "\
4332 Hide all subdirectories, leaving only their header lines.
4333 If there is already something hidden, make everything visible again.
4334 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory.
4335
4336 \(fn &optional IGNORED)" t nil)
4337
4338 (autoload 'dired-isearch-filenames-setup "dired-aux" "\
4339 Set up isearch to search in Dired file names.
4340 Intended to be added to `isearch-mode-hook'.
4341
4342 \(fn)" nil nil)
4343
4344 (autoload 'dired-isearch-filenames "dired-aux" "\
4345 Search for a string using Isearch only in file names in the Dired buffer.
4346
4347 \(fn)" t nil)
4348
4349 (autoload 'dired-isearch-filenames-regexp "dired-aux" "\
4350 Search for a regexp using Isearch only in file names in the Dired buffer.
4351
4352 \(fn)" t nil)
4353
4354 (autoload 'dired-do-isearch "dired-aux" "\
4355 Search for a string through all marked files using Isearch.
4356
4357 \(fn)" t nil)
4358
4359 (autoload 'dired-do-isearch-regexp "dired-aux" "\
4360 Search for a regexp through all marked files using Isearch.
4361
4362 \(fn)" t nil)
4363
4364 (autoload 'dired-do-search "dired-aux" "\
4365 Search through all marked files for a match for REGEXP.
4366 Stops when a match is found.
4367 To continue searching for next match, use command \\[tags-loop-continue].
4368
4369 \(fn REGEXP)" t nil)
4370
4371 (autoload 'dired-do-query-replace-regexp "dired-aux" "\
4372 Do `query-replace-regexp' of FROM with TO, on all marked files.
4373 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4374 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
4375 with the command \\[tags-loop-continue].
4376
4377 \(fn FROM TO &optional DELIMITED)" t nil)
4378
4379 (autoload 'dired-show-file-type "dired-aux" "\
4380 Print the type of FILE, according to the `file' command.
4381 If you give a prefix to this command, and FILE is a symbolic
4382 link, then the type of the file linked to by FILE is printed
4383 instead.
4384
4385 \(fn FILE &optional DEREF-SYMLINKS)" t nil)
4386
4387 ;;;***
4388 \f
4389 ;;;### (autoloads nil "dired-x" "dired-x.el" "994b5d9fc38059ab641ec271c728e56f")
4390 ;;; Generated autoloads from dired-x.el
4391
4392 (autoload 'dired-jump "dired-x" "\
4393 Jump to Dired buffer corresponding to current buffer.
4394 If in a file, Dired the current directory and move to file's line.
4395 If in Dired already, pop up a level and goto old directory's line.
4396 In case the proper Dired file line cannot be found, refresh the dired
4397 buffer and try again.
4398 When OTHER-WINDOW is non-nil, jump to Dired buffer in other window.
4399 Interactively with prefix argument, read FILE-NAME and
4400 move to its line in dired.
4401
4402 \(fn &optional OTHER-WINDOW FILE-NAME)" t nil)
4403
4404 (autoload 'dired-jump-other-window "dired-x" "\
4405 Like \\[dired-jump] (`dired-jump') but in other window.
4406
4407 \(fn &optional FILE-NAME)" t nil)
4408
4409 (autoload 'dired-do-relsymlink "dired-x" "\
4410 Relative symlink all marked (or next ARG) files into a directory.
4411 Otherwise make a relative symbolic link to the current file.
4412 This creates relative symbolic links like
4413
4414     foo -> ../bar/foo
4415
4416 not absolute ones like
4417
4418     foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4419
4420 For absolute symlinks, use \\[dired-do-symlink].
4421
4422 \(fn &optional ARG)" t nil)
4423
4424 ;;;***
4425 \f
4426 ;;; End of automatically extracted autoloads.
4427
4428 (provide 'dired)
4429
4430 (run-hooks 'dired-load-hook)            ; for your customizations
4431
4432 ;;; dired.el ends here