code.delx.au - gnu-emacs/blob - lisp/dired.el

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