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     (while alist
1335       (setq elt (car alist)
1336             alist (cdr alist)
1337             fil (car elt)
1338             chr (cdr elt))
1339       (if (dired-goto-file fil)
1340           (save-excursion
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     (define-key map "\M-=" 'dired-backup-diff)
1414     ;; Tree Dired commands
1415     (define-key map "\M-\C-?" 'dired-unmark-all-files)
1416     (define-key map "\M-\C-d" 'dired-tree-down)
1417     (define-key map "\M-\C-u" 'dired-tree-up)
1418     (define-key map "\M-\C-n" 'dired-next-subdir)
1419     (define-key map "\M-\C-p" 'dired-prev-subdir)
1420     ;; move to marked files
1421     (define-key map "\M-{" 'dired-prev-marked-file)
1422     (define-key map "\M-}" 'dired-next-marked-file)
1423     ;; Make all regexp commands share a `%' prefix:
1424     ;; We used to get to the submap via a symbol dired-regexp-prefix,
1425     ;; but that seems to serve little purpose, and copy-keymap
1426     ;; does a better job without it.
1427     (define-key map "%" nil)
1428     (define-key map "%u" 'dired-upcase)
1429     (define-key map "%l" 'dired-downcase)
1430     (define-key map "%d" 'dired-flag-files-regexp)
1431     (define-key map "%g" 'dired-mark-files-containing-regexp)
1432     (define-key map "%m" 'dired-mark-files-regexp)
1433     (define-key map "%r" 'dired-do-rename-regexp)
1434     (define-key map "%C" 'dired-do-copy-regexp)
1435     (define-key map "%H" 'dired-do-hardlink-regexp)
1436     (define-key map "%R" 'dired-do-rename-regexp)
1437     (define-key map "%S" 'dired-do-symlink-regexp)
1438     (define-key map "%&" 'dired-flag-garbage-files)
1439     ;; Commands for marking and unmarking.
1440     (define-key map "*" nil)
1441     (define-key map "**" 'dired-mark-executables)
1442     (define-key map "*/" 'dired-mark-directories)
1443     (define-key map "*@" 'dired-mark-symlinks)
1444     (define-key map "*%" 'dired-mark-files-regexp)
1445     (define-key map "*c" 'dired-change-marks)
1446     (define-key map "*s" 'dired-mark-subdir-files)
1447     (define-key map "*m" 'dired-mark)
1448     (define-key map "*u" 'dired-unmark)
1449     (define-key map "*?" 'dired-unmark-all-files)
1450     (define-key map "*!" 'dired-unmark-all-marks)
1451     (define-key map "U" 'dired-unmark-all-marks)
1452     (define-key map "*\177" 'dired-unmark-backward)
1453     (define-key map "*\C-n" 'dired-next-marked-file)
1454     (define-key map "*\C-p" 'dired-prev-marked-file)
1455     (define-key map "*t" 'dired-toggle-marks)
1456     ;; Lower keys for commands not operating on all the marked files
1457     (define-key map "a" 'dired-find-alternate-file)
1458     (define-key map "d" 'dired-flag-file-deletion)
1459     (define-key map "e" 'dired-find-file)
1460     (define-key map "f" 'dired-find-file)
1461     (define-key map "\C-m" 'dired-find-file)
1462     (put 'dired-find-file :advertised-binding "\C-m")
1463     (define-key map "g" 'revert-buffer)
1464     (define-key map "i" 'dired-maybe-insert-subdir)
1465     (define-key map "j" 'dired-goto-file)
1466     (define-key map "k" 'dired-do-kill-lines)
1467     (define-key map "l" 'dired-do-redisplay)
1468     (define-key map "m" 'dired-mark)
1469     (define-key map "n" 'dired-next-line)
1470     (define-key map "o" 'dired-find-file-other-window)
1471     (define-key map "\C-o" 'dired-display-file)
1472     (define-key map "p" 'dired-previous-line)
1473     (define-key map "s" 'dired-sort-toggle-or-edit)
1474     (define-key map "t" 'dired-toggle-marks)
1475     (define-key map "u" 'dired-unmark)
1476     (define-key map "v" 'dired-view-file)
1477     (define-key map "w" 'dired-copy-filename-as-kill)
1478     (define-key map "x" 'dired-do-flagged-delete)
1479     (define-key map "y" 'dired-show-file-type)
1480     (define-key map "+" 'dired-create-directory)
1481     ;; moving
1482     (define-key map "<" 'dired-prev-dirline)
1483     (define-key map ">" 'dired-next-dirline)
1484     (define-key map "^" 'dired-up-directory)
1485     (define-key map " "  'dired-next-line)
1486     (define-key map [remap next-line] 'dired-next-line)
1487     (define-key map [remap previous-line] 'dired-previous-line)
1488     ;; hiding
1489     (define-key map "$" 'dired-hide-subdir)
1490     (define-key map "\M-$" 'dired-hide-all)
1491     ;; isearch
1492     (define-key map (kbd "M-s a C-s")   'dired-do-isearch)
1493     (define-key map (kbd "M-s a M-C-s") 'dired-do-isearch-regexp)
1494     (define-key map (kbd "M-s f C-s")   'dired-isearch-filenames)
1495     (define-key map (kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp)
1496     ;; misc
1497     (define-key map [remap toggle-read-only] 'dired-toggle-read-only)
1498     (define-key map "?" 'dired-summary)
1499     (define-key map "\177" 'dired-unmark-backward)
1500     (define-key map [remap undo] 'dired-undo)
1501     (define-key map [remap advertised-undo] 'dired-undo)
1502     ;; thumbnail manipulation (image-dired)
1503     (define-key map "\C-td" 'image-dired-display-thumbs)
1504     (define-key map "\C-tt" 'image-dired-tag-files)
1505     (define-key map "\C-tr" 'image-dired-delete-tag)
1506     (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1507     (define-key map "\C-ti" 'image-dired-dired-display-image)
1508     (define-key map "\C-tx" 'image-dired-dired-display-external)
1509     (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1510     (define-key map "\C-t." 'image-dired-display-thumb)
1511     (define-key map "\C-tc" 'image-dired-dired-comment-files)
1512     (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1513     (define-key map "\C-t\C-t" 'image-dired-dired-toggle-marked-thumbs)
1514     (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1515     ;; encryption and decryption (epa-dired)
1516     (define-key map ":d" 'epa-dired-do-decrypt)
1517     (define-key map ":v" 'epa-dired-do-verify)
1518     (define-key map ":s" 'epa-dired-do-sign)
1519     (define-key map ":e" 'epa-dired-do-encrypt)
1520
1521     ;; Make menu bar items.
1522
1523     ;; No need to fo this, now that top-level items are fewer.
1524     ;;;;
1525     ;; Get rid of the Edit menu bar item to save space.
1526     ;(define-key map [menu-bar edit] 'undefined)
1527
1528     (define-key map [menu-bar subdir]
1529       (cons "Subdir" (make-sparse-keymap "Subdir")))
1530
1531     (define-key map [menu-bar subdir hide-all]
1532       '(menu-item "Hide All" dired-hide-all
1533                   :help "Hide all subdirectories, leave only header lines"))
1534     (define-key map [menu-bar subdir hide-subdir]
1535       '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1536                   :help "Hide or unhide current directory listing"))
1537     (define-key map [menu-bar subdir tree-down]
1538       '(menu-item "Tree Down" dired-tree-down
1539                   :help "Go to first subdirectory header down the tree"))
1540     (define-key map [menu-bar subdir tree-up]
1541       '(menu-item "Tree Up" dired-tree-up
1542                   :help "Go to first subdirectory header up the tree"))
1543     (define-key map [menu-bar subdir up]
1544       '(menu-item "Up Directory" dired-up-directory
1545                   :help "Edit the parent directory"))
1546     (define-key map [menu-bar subdir prev-subdir]
1547       '(menu-item "Prev Subdir" dired-prev-subdir
1548                   :help "Go to previous subdirectory header line"))
1549     (define-key map [menu-bar subdir next-subdir]
1550       '(menu-item "Next Subdir" dired-next-subdir
1551                   :help "Go to next subdirectory header line"))
1552     (define-key map [menu-bar subdir prev-dirline]
1553       '(menu-item "Prev Dirline" dired-prev-dirline
1554                   :help "Move to next directory-file line"))
1555     (define-key map [menu-bar subdir next-dirline]
1556       '(menu-item "Next Dirline" dired-next-dirline
1557                   :help "Move to previous directory-file line"))
1558     (define-key map [menu-bar subdir insert]
1559       '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1560                   :help "Insert contents of subdirectory"
1561                   :enable (let ((f (dired-get-filename nil t)))
1562                             (and f (file-directory-p f)))))
1563     (define-key map [menu-bar immediate]
1564       (cons "Immediate" (make-sparse-keymap "Immediate")))
1565
1566     (define-key map
1567       [menu-bar immediate image-dired-dired-display-external]
1568       '(menu-item "Display Image Externally" image-dired-dired-display-external
1569                   :help "Display image in external viewer"))
1570     (define-key map
1571       [menu-bar immediate image-dired-dired-display-image]
1572       '(menu-item "Display Image" image-dired-dired-display-image
1573                   :help "Display sized image in a separate window"))
1574     (define-key map
1575       [menu-bar immediate image-dired-dired-toggle-marked-thumbs]
1576       '(menu-item "Toggle Image Thumbnails in This Buffer" image-dired-dired-toggle-marked-thumbs
1577                   :help "Add or remove image thumbnails in front of marked file names"))
1578
1579     (define-key map [menu-bar immediate revert-buffer]
1580       '(menu-item "Refresh" revert-buffer
1581                   :help "Update contents of shown directories"))
1582
1583     (define-key map [menu-bar immediate dashes]
1584       '("--"))
1585
1586     (define-key map [menu-bar immediate isearch-filenames-regexp]
1587       '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1588                   :help "Incrementally search for regexp in file names only"))
1589     (define-key map [menu-bar immediate isearch-filenames]
1590       '(menu-item "Isearch in File Names..." dired-isearch-filenames
1591                   :help "Incrementally search for string in file names only."))
1592     (define-key map [menu-bar immediate compare-directories]
1593       '(menu-item "Compare Directories..." dired-compare-directories
1594                   :help "Mark files with different attributes in two dired buffers"))
1595     (define-key map [menu-bar immediate backup-diff]
1596       '(menu-item "Compare with Backup" dired-backup-diff
1597                   :help "Diff file at cursor with its latest backup"))
1598     (define-key map [menu-bar immediate diff]
1599       '(menu-item "Diff..." dired-diff
1600                   :help "Compare file at cursor with another file"))
1601     (define-key map [menu-bar immediate view]
1602       '(menu-item "View This File" dired-view-file
1603                   :help "Examine file at cursor in read-only mode"))
1604     (define-key map [menu-bar immediate display]
1605       '(menu-item "Display in Other Window" dired-display-file
1606                   :help "Display file at cursor in other window"))
1607     (define-key map [menu-bar immediate find-file-other-window]
1608       '(menu-item "Find in Other Window" dired-find-file-other-window
1609                   :help "Edit file at cursor in other window"))
1610     (define-key map [menu-bar immediate find-file]
1611       '(menu-item "Find This File" dired-find-file
1612                   :help "Edit file at cursor"))
1613     (define-key map [menu-bar immediate create-directory]
1614       '(menu-item "Create Directory..." dired-create-directory
1615                   :help "Create a directory"))
1616     (define-key map [menu-bar immediate wdired-mode]
1617       '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1618                   :help "Put a dired buffer in a mode in which filenames are editable"
1619                   :keys "C-x C-q"
1620                   :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1621
1622     (define-key map [menu-bar regexp]
1623       (cons "Regexp" (make-sparse-keymap "Regexp")))
1624
1625     (define-key map
1626       [menu-bar regexp image-dired-mark-tagged-files]
1627       '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1628                   :help "Mark files whose image tags matches regexp"))
1629
1630     (define-key map [menu-bar regexp dashes-1]
1631       '("--"))
1632
1633     (define-key map [menu-bar regexp downcase]
1634       '(menu-item "Downcase" dired-downcase
1635                   ;; When running on plain MS-DOS, there's only one
1636                   ;; letter-case for file names.
1637                   :enable (or (not (fboundp 'msdos-long-file-names))
1638                               (msdos-long-file-names))
1639                   :help "Rename marked files to lower-case name"))
1640     (define-key map [menu-bar regexp upcase]
1641       '(menu-item "Upcase" dired-upcase
1642                   :enable (or (not (fboundp 'msdos-long-file-names))
1643                               (msdos-long-file-names))
1644                   :help "Rename marked files to upper-case name"))
1645     (define-key map [menu-bar regexp hardlink]
1646       '(menu-item "Hardlink..." dired-do-hardlink-regexp
1647                   :help "Make hard links for files matching regexp"))
1648     (define-key map [menu-bar regexp symlink]
1649       '(menu-item "Symlink..." dired-do-symlink-regexp
1650                   :visible (fboundp 'make-symbolic-link)
1651                   :help "Make symbolic links for files matching regexp"))
1652     (define-key map [menu-bar regexp rename]
1653       '(menu-item "Rename..." dired-do-rename-regexp
1654                   :help "Rename marked files matching regexp"))
1655     (define-key map [menu-bar regexp copy]
1656       '(menu-item "Copy..." dired-do-copy-regexp
1657                   :help "Copy marked files matching regexp"))
1658     (define-key map [menu-bar regexp flag]
1659       '(menu-item "Flag..." dired-flag-files-regexp
1660                   :help "Flag files matching regexp for deletion"))
1661     (define-key map [menu-bar regexp mark]
1662       '(menu-item "Mark..." dired-mark-files-regexp
1663                   :help "Mark files matching regexp for future operations"))
1664     (define-key map [menu-bar regexp mark-cont]
1665       '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1666                   :help "Mark files whose contents matches regexp"))
1667
1668     (define-key map [menu-bar mark]
1669       (cons "Mark" (make-sparse-keymap "Mark")))
1670
1671     (define-key map [menu-bar mark prev]
1672       '(menu-item "Previous Marked" dired-prev-marked-file
1673                   :help "Move to previous marked file"))
1674     (define-key map [menu-bar mark next]
1675       '(menu-item "Next Marked" dired-next-marked-file
1676                   :help "Move to next marked file"))
1677     (define-key map [menu-bar mark marks]
1678       '(menu-item "Change Marks..." dired-change-marks
1679                   :help "Replace marker with another character"))
1680     (define-key map [menu-bar mark unmark-all]
1681       '(menu-item "Unmark All" dired-unmark-all-marks))
1682     (define-key map [menu-bar mark symlinks]
1683       '(menu-item "Mark Symlinks" dired-mark-symlinks
1684                   :visible (fboundp 'make-symbolic-link)
1685                   :help "Mark all symbolic links"))
1686     (define-key map [menu-bar mark directories]
1687       '(menu-item "Mark Directories" dired-mark-directories
1688                   :help "Mark all directories except `.' and `..'"))
1689     (define-key map [menu-bar mark directory]
1690       '(menu-item "Mark Old Backups" dired-clean-directory
1691                   :help "Flag old numbered backups for deletion"))
1692     (define-key map [menu-bar mark executables]
1693       '(menu-item "Mark Executables" dired-mark-executables
1694                   :help "Mark all executable files"))
1695     (define-key map [menu-bar mark garbage-files]
1696       '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1697                   :help "Flag unneeded files for deletion"))
1698     (define-key map [menu-bar mark backup-files]
1699       '(menu-item "Flag Backup Files" dired-flag-backup-files
1700                   :help "Flag all backup files for deletion"))
1701     (define-key map [menu-bar mark auto-save-files]
1702       '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1703                   :help "Flag auto-save files for deletion"))
1704     (define-key map [menu-bar mark deletion]
1705       '(menu-item "Flag" dired-flag-file-deletion
1706                   :help "Flag current line's file for deletion"))
1707     (define-key map [menu-bar mark unmark]
1708       '(menu-item "Unmark" dired-unmark
1709                   :help "Unmark or unflag current line's file"))
1710     (define-key map [menu-bar mark mark]
1711       '(menu-item "Mark" dired-mark
1712                   :help "Mark current line's file for future operations"))
1713     (define-key map [menu-bar mark toggle-marks]
1714       '(menu-item "Toggle Marks" dired-toggle-marks
1715                   :help "Mark unmarked files, unmark marked ones"))
1716
1717     (define-key map [menu-bar operate]
1718       (cons "Operate" (make-sparse-keymap "Operate")))
1719
1720     (define-key map
1721       [menu-bar operate image-dired-delete-tag]
1722       '(menu-item "Delete Image Tag..." image-dired-delete-tag
1723                   :help "Delete image tag from current or marked files"))
1724     (define-key map
1725       [menu-bar operate image-dired-tag-files]
1726       '(menu-item "Add Image Tags..." image-dired-tag-files
1727                   :help "Add image tags to current or marked files"))
1728     (define-key map
1729       [menu-bar operate image-dired-dired-comment-files]
1730       '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1731                   :help "Add image comment to current or marked files"))
1732     (define-key map
1733       [menu-bar operate image-dired-display-thumbs]
1734       '(menu-item "Display Image Thumbnails" image-dired-display-thumbs
1735                   :help "Display image thumbnails for current or marked image files"))
1736
1737     (define-key map [menu-bar operate dashes-4]
1738       '("--"))
1739
1740     (define-key map
1741       [menu-bar operate epa-dired-do-decrypt]
1742       '(menu-item "Decrypt" epa-dired-do-decrypt
1743                   :help "Decrypt file at cursor"))
1744
1745     (define-key map
1746       [menu-bar operate epa-dired-do-verify]
1747       '(menu-item "Verify" epa-dired-do-verify
1748                   :help "Verify digital signature of file at cursor"))
1749
1750     (define-key map
1751       [menu-bar operate epa-dired-do-sign]
1752       '(menu-item "Sign" epa-dired-do-sign
1753                   :help "Create digital signature of file at cursor"))
1754
1755     (define-key map
1756       [menu-bar operate epa-dired-do-encrypt]
1757       '(menu-item "Encrypt" epa-dired-do-encrypt
1758                   :help "Encrypt file at cursor"))
1759
1760     (define-key map [menu-bar operate dashes-3]
1761       '("--"))
1762
1763     (define-key map [menu-bar operate query-replace]
1764       '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1765                   :help "Replace regexp in marked files"))
1766     (define-key map [menu-bar operate search]
1767       '(menu-item "Search Files..." dired-do-search
1768                   :help "Search marked files for regexp"))
1769     (define-key map [menu-bar operate isearch-regexp]
1770       '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1771                   :help "Incrementally search marked files for regexp"))
1772     (define-key map [menu-bar operate isearch]
1773       '(menu-item "Isearch Files..." dired-do-isearch
1774                   :help "Incrementally search marked files for string"))
1775     (define-key map [menu-bar operate chown]
1776       '(menu-item "Change Owner..." dired-do-chown
1777                   :visible (not (memq system-type '(ms-dos windows-nt)))
1778                   :help "Change the owner of marked files"))
1779     (define-key map [menu-bar operate chgrp]
1780       '(menu-item "Change Group..." dired-do-chgrp
1781                   :visible (not (memq system-type '(ms-dos windows-nt)))
1782                   :help "Change the group of marked files"))
1783     (define-key map [menu-bar operate chmod]
1784       '(menu-item "Change Mode..." dired-do-chmod
1785                   :help "Change mode (attributes) of marked files"))
1786     (define-key map [menu-bar operate touch]
1787       '(menu-item "Change Timestamp..." dired-do-touch
1788                   :help "Change timestamp of marked files"))
1789     (define-key map [menu-bar operate load]
1790       '(menu-item "Load" dired-do-load
1791                   :help "Load marked Emacs Lisp files"))
1792     (define-key map [menu-bar operate compile]
1793       '(menu-item "Byte-compile" dired-do-byte-compile
1794                   :help "Byte-compile marked Emacs Lisp files"))
1795     (define-key map [menu-bar operate compress]
1796       '(menu-item "Compress" dired-do-compress
1797                   :help "Compress/uncompress marked files"))
1798     (define-key map [menu-bar operate print]
1799       '(menu-item "Print..." dired-do-print
1800                   :help "Ask for print command and print marked files"))
1801     (define-key map [menu-bar operate hardlink]
1802       '(menu-item "Hardlink to..." dired-do-hardlink
1803                   :help "Make hard links for current or marked files"))
1804     (define-key map [menu-bar operate symlink]
1805       '(menu-item "Symlink to..." dired-do-symlink
1806                   :visible (fboundp 'make-symbolic-link)
1807                   :help "Make symbolic links for current or marked files"))
1808     (define-key map [menu-bar operate async-command]
1809       '(menu-item "Asynchronous Shell Command..." dired-do-async-shell-command
1810                   :help "Run a shell command asynchronously on current or marked files"))
1811     (define-key map [menu-bar operate command]
1812       '(menu-item "Shell Command..." dired-do-shell-command
1813                   :help "Run a shell command on current or marked files"))
1814     (define-key map [menu-bar operate delete]
1815       '(menu-item "Delete" dired-do-delete
1816                   :help "Delete current file or all marked files"))
1817     (define-key map [menu-bar operate rename]
1818       '(menu-item "Rename to..." dired-do-rename
1819                   :help "Rename current file or move marked files"))
1820     (define-key map [menu-bar operate copy]
1821       '(menu-item "Copy to..." dired-do-copy
1822                   :help "Copy current file or all marked files"))
1823
1824     map)
1825   "Local keymap for `dired-mode' buffers.")
1826 \f
1827 ;; Dired mode is suitable only for specially formatted data.
1828 (put 'dired-mode 'mode-class 'special)
1829
1830 ;; Autoload cookie needed by desktop.el
1831 ;;;###autoload
1832 (defun dired-mode (&optional dirname switches)
1833   "\
1834 Mode for \"editing\" directory listings.
1835 In Dired, you are \"editing\" a list of the files in a directory and
1836   \(optionally) its subdirectories, in the format of `ls -lR'.
1837   Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1838 \"Editing\" means that you can run shell commands on files, visit,
1839   compress, load or byte-compile them, change their file attributes
1840   and insert subdirectories into the same buffer.  You can \"mark\"
1841   files for later commands or \"flag\" them for deletion, either file
1842   by file or all files matching certain criteria.
1843 You can move using the usual cursor motion commands.\\<dired-mode-map>
1844 The buffer is read-only.  Digits are prefix arguments.
1845 Type \\[dired-flag-file-deletion] to flag a file `D' for deletion.
1846 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1847   Most commands operate on the marked files and use the current file
1848   if no files are marked.  Use a numeric prefix argument to operate on
1849   the next ARG (or previous -ARG if ARG<0) files, or just `1'
1850   to operate on the current file only.  Prefix arguments override marks.
1851   Mark-using commands display a list of failures afterwards.  Type \\[dired-summary]
1852   to see why something went wrong.
1853 Type \\[dired-unmark] to Unmark a file or all files of an inserted subdirectory.
1854 Type \\[dired-unmark-backward] to back up one line and unmark or unflag.
1855 Type \\[dired-do-flagged-delete] to delete (eXecute) the files flagged `D'.
1856 Type \\[dired-find-file] to Find the current line's file
1857   (or dired it in another buffer, if it is a directory).
1858 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1859 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1860 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1861 Type \\[dired-do-copy] to Copy files.
1862 Type \\[dired-sort-toggle-or-edit] to toggle Sorting by name/date or change the `ls' switches.
1863 Type \\[revert-buffer] to read all currently expanded directories aGain.
1864   This retains all marks and hides subdirs again that were hidden before.
1865 Use `SPC' and `DEL' to move down and up by lines.
1866
1867 If Dired ever gets confused, you can either type \\[revert-buffer] \
1868 to read the
1869 directories again, type \\[dired-do-redisplay] \
1870 to relist the file at point or the marked files or a
1871 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1872 again for the directory tree.
1873
1874 Customization variables (rename this buffer and type \\[describe-variable] on each line
1875 for more info):
1876
1877   `dired-listing-switches'
1878   `dired-trivial-filenames'
1879   `dired-shrink-to-fit'
1880   `dired-marker-char'
1881   `dired-del-marker'
1882   `dired-keep-marker-rename'
1883   `dired-keep-marker-copy'
1884   `dired-keep-marker-hardlink'
1885   `dired-keep-marker-symlink'
1886
1887 Hooks (use \\[describe-variable] to see their documentation):
1888
1889   `dired-before-readin-hook'
1890   `dired-after-readin-hook'
1891   `dired-mode-hook'
1892   `dired-load-hook'
1893
1894 Keybindings:
1895 \\{dired-mode-map}"
1896   ;; Not to be called interactively (e.g. dired-directory will be set
1897   ;; to default-directory, which is wrong with wildcards).
1898   (kill-all-local-variables)
1899   (use-local-map dired-mode-map)
1900   (dired-advertise)                     ; default-directory is already set
1901   (setq major-mode 'dired-mode
1902         mode-name "Dired"
1903         ;; case-fold-search nil
1904         buffer-read-only t
1905         selective-display t             ; for subdirectory hiding
1906         mode-line-buffer-identification
1907         (propertized-buffer-identification "%17b"))
1908   (set (make-local-variable 'revert-buffer-function)
1909        (function dired-revert))
1910   (set (make-local-variable 'buffer-stale-function)
1911        (function dired-buffer-stale-p))
1912   (set (make-local-variable 'page-delimiter)
1913        "\n\n")
1914   (set (make-local-variable 'dired-directory)
1915        (or dirname default-directory))
1916   ;; list-buffers uses this to display the dir being edited in this buffer.
1917   (setq list-buffers-directory
1918         (expand-file-name (if (listp dired-directory)
1919                               (car dired-directory)
1920                             dired-directory)))
1921   (set (make-local-variable 'dired-actual-switches)
1922        (or switches dired-listing-switches))
1923   (set (make-local-variable 'font-lock-defaults)
1924        '(dired-font-lock-keywords t nil nil beginning-of-line))
1925   (set (make-local-variable 'desktop-save-buffer)
1926        'dired-desktop-buffer-misc-data)
1927   (setq dired-switches-alist nil)
1928   (hack-dir-local-variables-non-file-buffer) ; before sorting
1929   (dired-sort-other dired-actual-switches t)
1930   (when (featurep 'dnd)
1931     (set (make-local-variable 'dnd-protocol-alist)
1932          (append dired-dnd-protocol-alist dnd-protocol-alist)))
1933   (add-hook 'file-name-at-point-functions 'dired-file-name-at-point nil t)
1934   (add-hook 'isearch-mode-hook 'dired-isearch-filenames-setup nil t)
1935   (run-mode-hooks 'dired-mode-hook))
1936 \f
1937 ;; Idiosyncratic dired commands that don't deal with marks.
1938
1939 (defun dired-summary ()
1940   "Summarize basic Dired commands and show recent dired errors."
1941   (interactive)
1942   (dired-why)
1943   ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1944   (message
1945    "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1946
1947 (defun dired-undo ()
1948   "Undo in a dired buffer.
1949 This doesn't recover lost files, it just undoes changes in the buffer itself.
1950 You can use it to recover marks, killed lines or subdirs."
1951   (interactive)
1952   (let ((inhibit-read-only t))
1953     (undo))
1954   (dired-build-subdir-alist)
1955   (message "Change in dired buffer undone.
1956 Actual changes in files cannot be undone by Emacs."))
1957
1958 (defun dired-toggle-read-only ()
1959   "Edit Dired buffer with Wdired, or make it read-only.
1960 If the current buffer can be edited with Wdired, (i.e. the major
1961 mode is `dired-mode'), call `wdired-change-to-wdired-mode'.
1962 Otherwise, call `toggle-read-only'."
1963   (interactive)
1964   (if (derived-mode-p 'dired-mode)
1965       (wdired-change-to-wdired-mode)
1966     (call-interactively 'toggle-read-only)))
1967
1968 (defun dired-next-line (arg)
1969   "Move down lines then position at filename.
1970 Optional prefix ARG says how many lines to move; default is one line."
1971   (interactive "p")
1972   (forward-line arg)
1973   (dired-move-to-filename))
1974
1975 (defun dired-previous-line (arg)
1976   "Move up lines then position at filename.
1977 Optional prefix ARG says how many lines to move; default is one line."
1978   (interactive "p")
1979   (forward-line (- arg))
1980   (dired-move-to-filename))
1981
1982 (defun dired-next-dirline (arg &optional opoint)
1983   "Goto ARG'th next directory file line."
1984   (interactive "p")
1985   (or opoint (setq opoint (point)))
1986   (if (if (> arg 0)
1987           (re-search-forward dired-re-dir nil t arg)
1988         (beginning-of-line)
1989         (re-search-backward dired-re-dir nil t (- arg)))
1990       (dired-move-to-filename)          ; user may type `i' or `f'
1991     (goto-char opoint)
1992     (error "No more subdirectories")))
1993
1994 (defun dired-prev-dirline (arg)
1995   "Goto ARG'th previous directory file line."
1996   (interactive "p")
1997   (dired-next-dirline (- arg)))
1998
1999 (defun dired-up-directory (&optional other-window)
2000   "Run Dired on parent directory of current directory.
2001 Find the parent directory either in this buffer or another buffer.
2002 Creates a buffer if necessary."
2003   (interactive "P")
2004   (let* ((dir (dired-current-directory))
2005          (up (file-name-directory (directory-file-name dir))))
2006     (or (dired-goto-file (directory-file-name dir))
2007         ;; Only try dired-goto-subdir if buffer has more than one dir.
2008         (and (cdr dired-subdir-alist)
2009              (dired-goto-subdir up))
2010         (progn
2011           (if other-window
2012               (dired-other-window up)
2013             (dired up))
2014           (dired-goto-file dir)))))
2015
2016 (defun dired-get-file-for-visit ()
2017   "Get the current line's file name, with an error if file does not exist."
2018   (interactive)
2019   ;; We pass t for second arg so that we don't get error for `.' and `..'.
2020   (let ((raw (dired-get-filename nil t))
2021         file-name)
2022     (if (null raw)
2023         (error "No file on this line"))
2024     (setq file-name (file-name-sans-versions raw t))
2025     (if (file-exists-p file-name)
2026         file-name
2027       (if (file-symlink-p file-name)
2028           (error "File is a symlink to a nonexistent target")
2029         (error "File no longer exists; type `g' to update dired buffer")))))
2030
2031 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
2032 (define-obsolete-function-alias 'dired-advertised-find-file 'dired-find-file "23.2")
2033 (defun dired-find-file ()
2034   "In Dired, visit the file or directory named on this line."
2035   (interactive)
2036   ;; Bind `find-file-run-dired' so that the command works on directories
2037   ;; too, independent of the user's setting.
2038   (let ((find-file-run-dired t))
2039     (find-file (dired-get-file-for-visit))))
2040
2041 (defun dired-find-alternate-file ()
2042   "In Dired, visit this file or directory instead of the dired buffer."
2043   (interactive)
2044   (set-buffer-modified-p nil)
2045   (find-alternate-file (dired-get-file-for-visit)))
2046 ;; Don't override the setting from .emacs.
2047 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2048
2049 (defun dired-mouse-find-file-other-window (event)
2050   "In Dired, visit the file or directory name you click on."
2051   (interactive "e")
2052   (let (window pos file)
2053     (save-excursion
2054       (setq window (posn-window (event-end event))
2055             pos (posn-point (event-end event)))
2056       (if (not (windowp window))
2057           (error "No file chosen"))
2058       (set-buffer (window-buffer window))
2059       (goto-char pos)
2060       (setq file (dired-get-file-for-visit)))
2061     (if (file-directory-p file)
2062         (or (and (cdr dired-subdir-alist)
2063                  (dired-goto-subdir file))
2064             (progn
2065               (select-window window)
2066               (dired-other-window file)))
2067       (select-window window)
2068       (find-file-other-window (file-name-sans-versions file t)))))
2069
2070 (defun dired-view-file ()
2071   "In Dired, examine a file in view mode, returning to Dired when done.
2072 When file is a directory, show it in this buffer if it is inserted.
2073 Otherwise, display it in another buffer."
2074   (interactive)
2075   (let ((file (dired-get-file-for-visit)))
2076     (if (file-directory-p file)
2077         (or (and (cdr dired-subdir-alist)
2078                  (dired-goto-subdir file))
2079             (dired file))
2080       (view-file file))))
2081
2082 (defun dired-find-file-other-window ()
2083   "In Dired, visit this file or directory in another window."
2084   (interactive)
2085   (find-file-other-window (dired-get-file-for-visit)))
2086
2087 (defun dired-display-file ()
2088   "In Dired, display this file or directory in another window."
2089   (interactive)
2090   (display-buffer (find-file-noselect (dired-get-file-for-visit))))
2091 \f
2092 ;;; Functions for extracting and manipulating file names in Dired buffers.
2093
2094 (defun dired-get-filename (&optional localp no-error-if-not-filep)
2095   "In Dired, return name of file mentioned on this line.
2096 Value returned normally includes the directory name.
2097 Optional arg LOCALP with value `no-dir' means don't include directory
2098 name in result.  A value of `verbatim' means to return the name exactly as
2099 it occurs in the buffer, and a value of t means construct name relative to
2100 `default-directory', which still may contain slashes if in a subdirectory.
2101 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2102 regular filenames and return nil if no filename on this line.
2103 Otherwise, an error occurs in these cases."
2104   (let (case-fold-search file p1 p2 already-absolute)
2105     (save-excursion
2106       (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
2107           (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
2108     ;; nil if no file on this line, but no-error-if-not-filep is t:
2109     (if (setq file (and p1 p2 (buffer-substring p1 p2)))
2110         (progn
2111           ;; Get rid of the mouse-face property that file names have.
2112           (set-text-properties 0 (length file) nil file)
2113           ;; Unquote names quoted by ls or by dired-insert-directory.
2114           ;; This code was written using `read' to unquote, because
2115           ;; it's faster than substituting \007 (4 chars) -> ^G (1
2116           ;; char) etc. in a lisp loop.  Unfortunately, this decision
2117           ;; has necessitated hacks such as dealing with filenames
2118           ;; with quotation marks in their names.
2119           (while (string-match "\\(?:[^\\]\\|\\`\\)\\(\"\\)" file)
2120             (setq file (replace-match "\\\"" nil t file 1)))
2121           ;; Unescape any spaces escaped by ls -b (bug#10469).
2122           ;; Other -b quotes, eg \t, \n, work transparently.
2123           (if (dired-switches-escape-p dired-actual-switches)
2124               (let ((start 0)
2125                     (rep "")
2126                     (shift -1))
2127                 (if (eq localp 'verbatim)
2128                     (setq rep "\\\\"
2129                           shift +1))
2130                 (while (string-match "\\(\\\\\\) " file start)
2131                   (setq file (replace-match rep nil t file 1)
2132                         start (+ shift (match-end 0))))))
2133           (when (eq system-type 'windows-nt)
2134             (save-match-data
2135               (let ((start 0))
2136                 (while (string-match "\\\\" file start)
2137                   (aset file (match-beginning 0) ?/)
2138                   (setq start (match-end 0))))))
2139
2140           ;; Hence we don't need to worry about converting `\\' back to `\'.
2141           (setq file (read (concat "\"" file "\"")))
2142           ;; The above `read' will return a unibyte string if FILE
2143           ;; contains eight-bit-control/graphic characters.
2144           (if (and enable-multibyte-characters
2145                    (not (multibyte-string-p file)))
2146               (setq file (string-to-multibyte file)))))
2147     (and file (file-name-absolute-p file)
2148          ;; A relative file name can start with ~.
2149          ;; Don't treat it as absolute in this context.
2150          (not (eq (aref file 0) ?~))
2151          (setq already-absolute t))
2152     (cond
2153      ((null file)
2154       nil)
2155      ((eq localp 'verbatim)
2156       file)
2157      ((and (not no-error-if-not-filep)
2158            (member file '("." "..")))
2159       (error "Cannot operate on `.' or `..'"))
2160      ((and (eq localp 'no-dir) already-absolute)
2161       (file-name-nondirectory file))
2162      (already-absolute
2163       (let ((handler (find-file-name-handler file nil)))
2164         ;; check for safe-magic property so that we won't
2165         ;; put /: for names that don't really need them.
2166         ;; For instance, .gz files when auto-compression-mode is on.
2167         (if (and handler (not (get handler 'safe-magic)))
2168             (concat "/:" file)
2169           file)))
2170      ((eq localp 'no-dir)
2171       file)
2172      ((equal (dired-current-directory) "/")
2173       (setq file (concat (dired-current-directory localp) file))
2174       (let ((handler (find-file-name-handler file nil)))
2175         ;; check for safe-magic property so that we won't
2176         ;; put /: for names that don't really need them.
2177         ;; For instance, .gz files when auto-compression-mode is on.
2178         (if (and handler (not (get handler 'safe-magic)))
2179             (concat "/:" file)
2180           file)))
2181      (t
2182       (concat (dired-current-directory localp) file)))))
2183
2184 (defun dired-string-replace-match (regexp string newtext
2185                                    &optional literal global)
2186   "Replace first match of REGEXP in STRING with NEWTEXT.
2187 If it does not match, nil is returned instead of the new string.
2188 Optional arg LITERAL means to take NEWTEXT literally.
2189 Optional arg GLOBAL means to replace all matches."
2190   (if global
2191       (let ((start 0) ret)
2192         (while (string-match regexp string start)
2193           (let ((from-end (- (length string) (match-end 0))))
2194             (setq ret (setq string (replace-match newtext t literal string)))
2195             (setq start (- (length string) from-end))))
2196           ret)
2197     (if (not (string-match regexp string 0))
2198         nil
2199       (replace-match newtext t literal string))))
2200
2201 (defun dired-make-absolute (file &optional dir)
2202   ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2203   ;; We can't always use expand-file-name as this would get rid of `.'
2204   ;; or expand in / instead default-directory if DIR=="".
2205   ;; This should be good enough for ange-ftp.
2206   ;; It should be reasonably fast, though, as it is called in
2207   ;; dired-get-filename.
2208   (concat (or dir default-directory) file))
2209
2210 (defun dired-make-relative (file &optional dir)
2211   "Convert FILE (an absolute file name) to a name relative to DIR.
2212 If DIR is omitted or nil, it defaults to `default-directory'.
2213 If FILE is not in the directory tree of DIR, return FILE
2214 unchanged."
2215   (or dir (setq dir default-directory))
2216   ;; This case comes into play if default-directory is set to
2217   ;; use ~.
2218   (if (and (> (length dir) 0) (= (aref dir 0) ?~))
2219       (setq dir (expand-file-name dir)))
2220   (if (string-match (concat "^" (regexp-quote dir)) file)
2221       (substring file (match-end 0))
2222     file))
2223 \f
2224 ;;; Functions for finding the file name in a dired buffer line.
2225
2226 (defvar dired-permission-flags-regexp
2227   "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
2228   "Regular expression to match the permission flags in `ls -l'.")
2229
2230 ;; Move to first char of filename on this line.
2231 ;; Returns position (point) or nil if no filename on this line."
2232 (defun dired-move-to-filename (&optional raise-error eol)
2233   "Move to the beginning of the filename on the current line.
2234 Return the position of the beginning of the filename, or nil if none found."
2235   ;; This is the UNIX version.
2236   (or eol (setq eol (line-end-position)))
2237   (beginning-of-line)
2238   ;; First try assuming `ls --dired' was used.
2239   (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2240     (cond
2241      ((and change (< change eol))
2242       (goto-char change))
2243      ((re-search-forward directory-listing-before-filename-regexp eol t)
2244       (goto-char (match-end 0)))
2245      ((re-search-forward dired-permission-flags-regexp eol t)
2246       ;; Ha!  There *is* a file.  Our regexp-from-hell just failed to find it.
2247       (if raise-error
2248           (error "Unrecognized line!  Check directory-listing-before-filename-regexp"))
2249       (beginning-of-line)
2250       nil)
2251      (raise-error
2252       (error "No file on this line")))))
2253
2254 (defun dired-move-to-end-of-filename (&optional no-error)
2255   ;; Assumes point is at beginning of filename,
2256   ;; thus the rwx bit re-search-backward below will succeed in *this*
2257   ;; line if at all.  So, it should be called only after
2258   ;; (dired-move-to-filename t).
2259   ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2260   ;; This is the UNIX version.
2261   (if (get-text-property (point) 'dired-filename)
2262       (goto-char (next-single-property-change (point) 'dired-filename))
2263     (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2264       ;; case-fold-search is nil now, so we can test for capital F:
2265       (setq used-F (string-match "F" dired-actual-switches)
2266             opoint (point)
2267             eol (line-end-position)
2268             hidden (and selective-display
2269                         (save-excursion (search-forward "\r" eol t))))
2270       (if hidden
2271           nil
2272         (save-excursion ;; Find out what kind of file this is:
2273           ;; Restrict perm bits to be non-blank,
2274           ;; otherwise this matches one char to early (looking backward):
2275           ;; "l---------" (some systems make symlinks that way)
2276           ;; "----------" (plain file with zero perms)
2277           (if (re-search-backward
2278                dired-permission-flags-regexp nil t)
2279               (setq file-type (char-after (match-beginning 1))
2280                     symlink (eq file-type ?l)
2281                     ;; Only with -F we need to know whether it's an executable
2282                     executable (and
2283                                 used-F
2284                                 (string-match
2285                                  "[xst]" ;; execute bit set anywhere?
2286                                  (concat
2287                                   (match-string 2)
2288                                   (match-string 3)
2289                                   (match-string 4)))))
2290             (or no-error (error "No file on this line"))))
2291         ;; Move point to end of name:
2292         (if symlink
2293             (if (search-forward " -> " eol t)
2294                 (progn
2295                   (forward-char -4)
2296                   (and used-F
2297                        dired-ls-F-marks-symlinks
2298                        (eq (preceding-char) ?@) ;; did ls really mark the link?
2299                        (forward-char -1))))
2300           (goto-char eol) ;; else not a symbolic link
2301           ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2302           ;; one trailing character. (Executable bits on symlinks ain't mean
2303           ;; a thing, even to ls, but we know it's not a symlink.)
2304           (and used-F
2305                (or (memq file-type '(?d ?s ?p))
2306                    executable)
2307                (forward-char -1))))
2308       (or no-error
2309           (not (eq opoint (point)))
2310           (error "%s" (if hidden
2311                      (substitute-command-keys
2312                       "File line is hidden, type \\[dired-hide-subdir] to unhide")
2313                    "No file on this line")))
2314       (if (eq opoint (point))
2315           nil
2316         (point)))))
2317
2318 \f
2319 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2320
2321 (defun dired-copy-filename-as-kill (&optional arg)
2322   "Copy names of marked (or next ARG) files into the kill ring.
2323 The names are separated by a space.
2324 With a zero prefix arg, use the absolute file name of each marked file.
2325 With \\[universal-argument], use the file name relative to the dired buffer's
2326 `default-directory'.  (This still may contain slashes if in a subdirectory.)
2327
2328 If on a subdir headerline, use absolute subdirname instead;
2329 prefix arg and marked files are ignored in this case.
2330
2331 You can then feed the file name(s) to other commands with \\[yank]."
2332   (interactive "P")
2333   (let ((string
2334          (or (dired-get-subdir)
2335              (mapconcat (function identity)
2336                         (if arg
2337                             (cond ((zerop (prefix-numeric-value arg))
2338                                    (dired-get-marked-files))
2339                                   ((consp arg)
2340                                    (dired-get-marked-files t))
2341                                   (t
2342                                    (dired-get-marked-files
2343                                     'no-dir (prefix-numeric-value arg))))
2344                           (dired-get-marked-files 'no-dir))
2345                         " "))))
2346     (if (eq last-command 'kill-region)
2347         (kill-append string nil)
2348       (kill-new string))
2349     (message "%s" string)))
2350
2351 \f
2352 ;; Keeping Dired buffers in sync with the filesystem and with each other
2353
2354 (defun dired-buffers-for-dir (dir &optional file)
2355 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2356 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2357 ;; matches FILE.
2358 ;; The list is in reverse order of buffer creation, most recent last.
2359 ;; As a side effect, killed dired buffers for DIR are removed from
2360 ;; dired-buffers.
2361   (setq dir (file-name-as-directory dir))
2362   (let (result buf)
2363     (dolist (elt dired-buffers)
2364       (setq buf (cdr elt))
2365       (cond
2366        ((null (buffer-name buf))
2367         ;; Buffer is killed - clean up:
2368         (setq dired-buffers (delq elt dired-buffers)))
2369        ((dired-in-this-tree dir (car elt))
2370         (with-current-buffer buf
2371           (and (assoc dir dired-subdir-alist)
2372                (or (null file)
2373                    (if (stringp dired-directory)
2374                        (let ((wildcards (file-name-nondirectory
2375                                          dired-directory)))
2376                          (or (= 0 (length wildcards))
2377                              (string-match (dired-glob-regexp wildcards)
2378                                            file)))
2379                      (member (expand-file-name file dir)
2380                              (cdr dired-directory))))
2381                (setq result (cons buf result)))))))
2382     result))
2383
2384 (defun dired-glob-regexp (pattern)
2385   "Convert glob-pattern PATTERN to a regular expression."
2386   (let ((matched-in-pattern 0)  ;; How many chars of PATTERN we've handled.
2387         regexp)
2388     (while (string-match "[[?*]" pattern matched-in-pattern)
2389       (let ((op-end (match-end 0))
2390             (next-op (aref pattern (match-beginning 0))))
2391         (setq regexp (concat regexp
2392                              (regexp-quote
2393                               (substring pattern matched-in-pattern
2394                                          (match-beginning 0)))))
2395         (cond ((= next-op ??)
2396                (setq regexp (concat regexp "."))
2397                (setq matched-in-pattern op-end))
2398               ((= next-op ?\[)
2399                ;; Fails to handle ^ yet ????
2400                (let* ((set-start (match-beginning 0))
2401                       (set-cont
2402                        (if (= (aref pattern (1+ set-start)) ?^)
2403                            (+ 3 set-start)
2404                          (+ 2 set-start)))
2405                       (set-end (string-match "]" pattern set-cont))
2406                       (set (substring pattern set-start (1+ set-end))))
2407                  (setq regexp (concat regexp set))
2408                  (setq matched-in-pattern (1+ set-end))))
2409               ((= next-op ?*)
2410                (setq regexp (concat regexp ".*"))
2411                (setq matched-in-pattern op-end)))))
2412     (concat "\\`"
2413             regexp
2414             (regexp-quote
2415              (substring pattern matched-in-pattern))
2416             "\\'")))
2417
2418
2419
2420 (defun dired-advertise ()
2421   ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2422   ;; With wildcards we actually advertise too much.
2423   (let ((expanded-default (expand-file-name default-directory)))
2424     (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2425         t                               ; we have already advertised ourselves
2426       (setq dired-buffers
2427             (cons (cons expanded-default (current-buffer))
2428                   dired-buffers)))))
2429
2430 (defun dired-unadvertise (dir)
2431   ;; Remove DIR from the buffer alist in variable dired-buffers.
2432   ;; This has the effect of removing any buffer whose main directory is DIR.
2433   ;; It does not affect buffers in which DIR is a subdir.
2434   ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2435   (setq dired-buffers
2436         (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2437 \f
2438 ;; Tree Dired
2439
2440 ;;; utility functions
2441
2442 (defun dired-in-this-tree (file dir)
2443   ;;"Is FILE part of the directory tree starting at DIR?"
2444   (let (case-fold-search)
2445     (string-match (concat "^" (regexp-quote dir)) file)))
2446
2447 (defun dired-normalize-subdir (dir)
2448   ;; Prepend default-directory to DIR if relative file name.
2449   ;; dired-get-filename must be able to make a valid file name from a
2450   ;; file and its directory DIR.
2451   (file-name-as-directory
2452    (if (file-name-absolute-p dir)
2453        dir
2454      (expand-file-name dir default-directory))))
2455
2456 (defun dired-get-subdir ()
2457   ;;"Return the subdir name on this line, or nil if not on a headerline."
2458   ;; Look up in the alist whether this is a headerline.
2459   (save-excursion
2460     (let ((cur-dir (dired-current-directory)))
2461       (beginning-of-line)               ; alist stores b-o-l positions
2462       (and (zerop (- (point)
2463                      (dired-get-subdir-min (assoc cur-dir
2464                                                   dired-subdir-alist))))
2465            cur-dir))))
2466
2467 ;; can't use macro,  must be redefinable for other alist format in dired-nstd.
2468 (defalias 'dired-get-subdir-min 'cdr)
2469
2470 (defun dired-get-subdir-max (elt)
2471   (save-excursion
2472     (goto-char (dired-get-subdir-min elt))
2473     (dired-subdir-max)))
2474
2475 (defun dired-clear-alist ()
2476   (while dired-subdir-alist
2477     (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2478     (setq dired-subdir-alist (cdr dired-subdir-alist))))
2479
2480 (defun dired-subdir-index (dir)
2481   ;; Return an index into alist for use with nth
2482   ;; for the sake of subdir moving commands.
2483   (let (found (index 0) (alist dired-subdir-alist))
2484     (while alist
2485       (if (string= dir (car (car alist)))
2486           (setq alist nil found t)
2487         (setq alist (cdr alist) index (1+ index))))
2488     (if found index nil)))
2489
2490 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2491   "Go to next subdirectory, regardless of level."
2492   ;; Use 0 arg to go to this directory's header line.
2493   ;; NO-SKIP prevents moving to end of header line, returning whatever
2494   ;; position was found in dired-subdir-alist.
2495   (interactive "p")
2496   (let ((this-dir (dired-current-directory))
2497         pos index)
2498     ;; nth with negative arg does not return nil but the first element
2499     (setq index (- (dired-subdir-index this-dir) arg))
2500     (setq pos (if (>= index 0)
2501                   (dired-get-subdir-min (nth index dired-subdir-alist))))
2502     (if pos
2503         (progn
2504           (goto-char pos)
2505           (or no-skip (skip-chars-forward "^\n\r"))
2506           (point))
2507       (if no-error-if-not-found
2508           nil                           ; return nil if not found
2509         (error "%s directory" (if (> arg 0) "Last" "First"))))))
2510
2511 (defun dired-build-subdir-alist (&optional switches)
2512   "Build `dired-subdir-alist' by parsing the buffer.
2513 Returns the new value of the alist.
2514 If optional arg SWITCHES is non-nil, use its value
2515 instead of `dired-actual-switches'."
2516   (interactive)
2517   (dired-clear-alist)
2518   (save-excursion
2519     (let* ((count 0)
2520            (inhibit-read-only t)
2521            (buffer-undo-list t)
2522            (switches (or switches dired-actual-switches))
2523            new-dir-name
2524            (R-ftp-base-dir-regex
2525             ;; Used to expand subdirectory names correctly in recursive
2526             ;; ange-ftp listings.
2527             (and (string-match "R" switches)
2528                  (string-match "\\`/.*:\\(/.*\\)" default-directory)
2529                  (concat "\\`" (match-string 1 default-directory)))))
2530       (goto-char (point-min))
2531       (setq dired-subdir-alist nil)
2532       (while (re-search-forward dired-subdir-regexp nil t)
2533         ;; Avoid taking a file name ending in a colon
2534         ;; as a subdir name.
2535         (unless (save-excursion
2536                   (goto-char (match-beginning 0))
2537                   (beginning-of-line)
2538                   (forward-char 2)
2539                   (save-match-data (looking-at dired-re-perms)))
2540           (save-excursion
2541             (goto-char (match-beginning 1))
2542             (setq new-dir-name
2543                   (buffer-substring-no-properties (point) (match-end 1))
2544                   new-dir-name
2545                   (save-match-data
2546                     (if (and R-ftp-base-dir-regex
2547                              (not (string= new-dir-name default-directory))
2548                              (string-match R-ftp-base-dir-regex new-dir-name))
2549                         (concat default-directory
2550                                 (substring new-dir-name (match-end 0)))
2551                       (expand-file-name new-dir-name))))
2552             (delete-region (point) (match-end 1))
2553             (insert new-dir-name))
2554           (setq count (1+ count))
2555           ;; Undo any escaping of newlines and \ by dired-insert-directory.
2556           ;; Convert "n" preceded by odd number of \ to newline, and \\ to \.
2557           (when (and (dired-switches-escape-p switches)
2558                      (string-match-p "\\\\" new-dir-name))
2559             (let (temp res)
2560               (mapc (lambda (char)
2561                       (cond ((equal char ?\\)
2562                              (if temp
2563                                  (setq res (concat res "\\")
2564                                        temp nil)
2565                                (setq temp "\\")))
2566                             ((and temp (equal char ?n))
2567                              (setq res (concat res "\n")
2568                                    temp nil))
2569                             (t
2570                              (setq res (concat res temp (char-to-string char))
2571                                    temp nil))))
2572                     new-dir-name)
2573               (setq new-dir-name res)))
2574           (dired-alist-add-1 new-dir-name
2575            ;; Place a sub directory boundary between lines.
2576            (save-excursion
2577              (goto-char (match-beginning 0))
2578              (beginning-of-line)
2579              (point-marker)))))
2580       (if (and (> count 1) (called-interactively-p 'interactive))
2581           (message "Buffer includes %d directories" count)))
2582     ;; We don't need to sort it because it is in buffer order per
2583     ;; constructionem.  Return new alist:
2584     dired-subdir-alist))
2585
2586 (defun dired-alist-add-1 (dir new-marker)
2587   ;; Add new DIR at NEW-MARKER.  Don't sort.
2588   (setq dired-subdir-alist
2589         (cons (cons (dired-normalize-subdir dir) new-marker)
2590               dired-subdir-alist)))
2591
2592 (defun dired-goto-next-nontrivial-file ()
2593   ;; Position point on first nontrivial file after point.
2594   (dired-goto-next-file);; so there is a file to compare with
2595   (if (stringp dired-trivial-filenames)
2596       (while (and (not (eobp))
2597                   (string-match dired-trivial-filenames
2598                                 (file-name-nondirectory
2599                                  (or (dired-get-filename nil t) ""))))
2600         (forward-line 1)
2601         (dired-move-to-filename))))
2602
2603 (defun dired-goto-next-file ()
2604   (let ((max (1- (dired-subdir-max))))
2605     (while (and (not (dired-move-to-filename)) (< (point) max))
2606       (forward-line 1))))
2607
2608 (defun dired-goto-file (file)
2609   "Go to line describing file FILE in this dired buffer."
2610   ;; Return value of point on success, else nil.
2611   ;; FILE must be an absolute file name.
2612   ;; Loses if FILE contains control chars like "\007" for which ls
2613   ;; either inserts "?" or "\\007" into the buffer, so we won't find
2614   ;; it in the buffer.
2615   (interactive
2616    (prog1                               ; let push-mark display its message
2617        (list (expand-file-name
2618               (read-file-name "Goto file: "
2619                               (dired-current-directory))))
2620      (push-mark)))
2621   (unless (file-name-absolute-p file)
2622     (error "File name `%s' is not absolute" file))
2623   (setq file (directory-file-name file)) ; does no harm if not a directory
2624   (let* ((case-fold-search nil)
2625          (dir (file-name-directory file))
2626          (found (or
2627                  ;; First, look for a listing under the absolute name.
2628                  (save-excursion
2629                    (goto-char (point-min))
2630                    (dired-goto-file-1 file file (point-max)))
2631                  ;; Otherwise, look for it as a relative name.  The
2632                  ;; hair is to get the result of `dired-goto-subdir'
2633                  ;; without calling it if we don't have any subdirs.
2634                  (save-excursion
2635                    (when (if (string= dir (expand-file-name default-directory))
2636                              (goto-char (point-min))
2637                            (and (cdr dired-subdir-alist)
2638                                 (dired-goto-subdir dir)))
2639                      (dired-goto-file-1 (file-name-nondirectory file)
2640                                         file
2641                                         (dired-subdir-max)))))))
2642     ;; Return buffer position, if found.
2643     (if found
2644         (goto-char found))))
2645
2646 (defun dired-goto-file-1 (file full-name limit)
2647   "Advance to the Dired listing labeled by FILE; return its position.
2648 Return nil if the listing is not found.  If FILE contains
2649 characters that would not appear in a Dired buffer, search using
2650 the quoted forms of those characters.
2651
2652 FULL-NAME specifies the actual file name the listing must have,
2653 as returned by `dired-get-filename'.  LIMIT is the search limit."
2654   (let (str)
2655     (setq str (replace-regexp-in-string "\^m" "\\^m"  file nil t))
2656     (setq str (replace-regexp-in-string "\\\\" "\\\\" str nil t))
2657     (and (dired-switches-escape-p dired-actual-switches)
2658          (string-match "[ \t\n]" str)
2659          ;; FIXME: to fix this for embedded control characters etc, we
2660          ;; should escape everything that `ls -b' does.
2661          (setq str (replace-regexp-in-string " " "\\ "  str nil t)
2662                str (replace-regexp-in-string "\t" "\\t" str nil t)
2663                str (replace-regexp-in-string "\n" "\\n" str nil t)))
2664     (let ((found nil)
2665           ;; filenames are preceded by SPC, this makes the search faster
2666           ;; (e.g. for the filename "-").
2667           (search-string (concat " " str)))
2668       (while (and (not found)
2669                   (search-forward search-string limit 'move))
2670         ;; Check that we are in the right place.  Match could have
2671         ;; BASE just as initial substring or in permission bits etc.
2672         (if (equal full-name (dired-get-filename nil t))
2673             (setq found (dired-move-to-filename))
2674           (forward-line 1)))
2675       found)))
2676
2677 (defvar dired-find-subdir)
2678
2679 ;; FIXME document whatever dired-x is doing.
2680 (defun dired-initial-position (dirname)
2681   "Where point should go in a new listing of DIRNAME.
2682 Point assumed at beginning of new subdir line."
2683   (end-of-line)
2684   (and (featurep 'dired-x) dired-find-subdir
2685        (dired-goto-subdir dirname))
2686   (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2687 \f
2688 ;; These are hooks which make tree dired work.
2689 ;; They are in this file because other parts of dired need to call them.
2690 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2691
2692 ;; This function is called for each retrieved filename.
2693 ;; It could stand to be faster, though it's mostly function call
2694 ;; overhead.  Avoiding the function call seems to save about 10% in
2695 ;; dired-get-filename.  Make it a defsubst?
2696 (defun dired-current-directory (&optional localp)
2697   "Return the name of the subdirectory to which this line belongs.
2698 This returns a string with trailing slash, like `default-directory'.
2699 Optional argument means return a file name relative to `default-directory'."
2700   (let ((here (point))
2701         (alist (or dired-subdir-alist
2702                    ;; probably because called in a non-dired buffer
2703                    (error "No subdir-alist in %s" (current-buffer))))
2704         elt dir)
2705     (while alist
2706       (setq elt (car alist)
2707             dir (car elt)
2708             ;; use `<=' (not `<') as subdir line is part of subdir
2709             alist (if (<= (dired-get-subdir-min elt) here)
2710                       nil               ; found
2711                     (cdr alist))))
2712     (if localp
2713         (dired-make-relative dir default-directory)
2714       dir)))
2715
2716 ;; Subdirs start at the beginning of their header lines and end just
2717 ;; before the beginning of the next header line (or end of buffer).
2718
2719 (defun dired-subdir-max ()
2720   (save-excursion
2721     (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2722         (point-max)
2723       (point))))
2724 \f
2725 ;; Deleting files
2726
2727 (defcustom dired-recursive-deletes 'top
2728   "Whether Dired deletes directories recursively.
2729 If nil, Dired will not delete non-empty directories.
2730 `always' means to delete non-empty directories recursively,
2731 without asking.  This is dangerous!
2732 `top' means to ask for each top-level directory specified by the
2733 Dired deletion command, and delete its subdirectories without
2734 asking.
2735 Any other value means to ask for each directory."
2736   :type '(choice :tag "Delete non-empty directories"
2737                  (const :tag "Yes" always)
2738                  (const :tag "No--only delete empty directories" nil)
2739                  (const :tag "Confirm for each directory" t)
2740                  (const :tag "Confirm for each top directory only" top))
2741   :group 'dired)
2742
2743 ;; Match anything but `.' and `..'.
2744 (defvar dired-re-no-dot "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2745
2746 ;; Delete file, possibly delete a directory and all its files.
2747 ;; This function is useful outside of dired.  One could change its name
2748 ;; to e.g. recursive-delete-file and put it somewhere else.
2749 (defun dired-delete-file (file &optional recursive trash) "\
2750 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2751 RECURSIVE determines what to do with a non-empty directory.  If RECURSIVE is:
2752 nil, do not delete.
2753 `always', delete recursively without asking.
2754 `top', ask for each directory at top level.
2755 Anything else, ask for each sub-directory."
2756   ;; This test is equivalent to
2757   ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2758   ;; but more efficient
2759   (if (not (eq t (car (file-attributes file))))
2760       (delete-file file trash)
2761     (if (and recursive
2762              (directory-files file t dired-re-no-dot) ; Not empty.
2763              (or (eq recursive 'always)
2764                  (yes-or-no-p (format "Recursively %s %s? "
2765                                       (if (and trash
2766                                                delete-by-moving-to-trash)
2767                                           "trash"
2768                                         "delete")
2769                                       (dired-make-relative file)))))
2770         (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2771       (setq recursive nil))
2772     (delete-directory file recursive trash)))
2773
2774 (defun dired-do-flagged-delete (&optional nomessage)
2775   "In Dired, delete the files flagged for deletion.
2776 If NOMESSAGE is non-nil, we don't display any message
2777 if there are no flagged files.
2778 `dired-recursive-deletes' controls whether deletion of
2779 non-empty directories is allowed."
2780   (interactive)
2781   (let* ((dired-marker-char dired-del-marker)
2782          (regexp (dired-marker-regexp))
2783          case-fold-search)
2784     (if (save-excursion (goto-char (point-min))
2785                         (re-search-forward regexp nil t))
2786         (dired-internal-do-deletions
2787          ;; this can't move point since ARG is nil
2788          (dired-map-over-marks (cons (dired-get-filename) (point))
2789                                nil)
2790          nil t)
2791       (or nomessage
2792           (message "(No deletions requested)")))))
2793
2794 (defun dired-do-delete (&optional arg)
2795   "Delete all marked (or next ARG) files.
2796 `dired-recursive-deletes' controls whether deletion of
2797 non-empty directories is allowed."
2798   ;; This is more consistent with the file marking feature than
2799   ;; dired-do-flagged-delete.
2800   (interactive "P")
2801   (dired-internal-do-deletions
2802    ;; this may move point if ARG is an integer
2803    (dired-map-over-marks (cons (dired-get-filename) (point))
2804                          arg)
2805    arg t))
2806
2807 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2808
2809 (defun dired-internal-do-deletions (l arg &optional trash)
2810   ;; L is an alist of files to delete, with their buffer positions.
2811   ;; ARG is the prefix arg.
2812   ;; Filenames are absolute.
2813   ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2814   ;; That way as changes are made in the buffer they do not shift the
2815   ;; lines still to be changed, so the (point) values in L stay valid.
2816   ;; Also, for subdirs in natural order, a subdir's files are deleted
2817   ;; before the subdir itself - the other way around would not work.
2818   (let* ((files (mapcar (function car) l))
2819          (count (length l))
2820          (succ 0)
2821          (trashing (and trash delete-by-moving-to-trash))
2822          (progress-reporter
2823           (make-progress-reporter
2824            (if trashing "Trashing..." "Deleting...")
2825            succ count)))
2826     ;; canonicalize file list for pop up
2827     (setq files (nreverse (mapcar (function dired-make-relative) files)))
2828     (if (dired-mark-pop-up
2829          " *Deletions*" 'delete files dired-deletion-confirmer
2830          (format "%s %s "
2831                  (if trashing "Trash" "Delete")
2832                  (dired-mark-prompt arg files)))
2833         (save-excursion
2834           (let (failures);; files better be in reverse order for this loop!
2835             (while l
2836               (goto-char (cdr (car l)))
2837               (let ((inhibit-read-only t))
2838                 (condition-case err
2839                     (let ((fn (car (car l))))
2840                       (dired-delete-file fn dired-recursive-deletes trash)
2841                       ;; if we get here, removing worked
2842                       (setq succ (1+ succ))
2843                       (progress-reporter-update progress-reporter succ)
2844                       (dired-fun-in-all-buffers
2845                        (file-name-directory fn) (file-name-nondirectory fn)
2846                        (function dired-delete-entry) fn))
2847                   (error;; catch errors from failed deletions
2848                    (dired-log "%s\n" err)
2849                    (setq failures (cons (car (car l)) failures)))))
2850               (setq l (cdr l)))
2851             (if (not failures)
2852                 (progress-reporter-done progress-reporter)
2853               (dired-log-summary
2854                (format "%d of %d deletion%s failed"
2855                        (length failures) count
2856                        (dired-plural-s count))
2857                failures))))
2858       (message "(No deletions performed)")))
2859   (dired-move-to-filename))
2860
2861 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2862   ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2863   ;; If the buffer has a wildcard pattern, check that it matches FILE.
2864   ;; (FILE does not include a directory component.)
2865   ;; FILE may be nil, in which case ignore it.
2866   ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2867   (let (success-list)
2868     (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2869                                         file))
2870       (with-current-buffer buf
2871         (if (apply fun args)
2872             (setq success-list (cons (buffer-name buf) success-list)))))
2873     success-list))
2874
2875 ;; Delete the entry for FILE from
2876 (defun dired-delete-entry (file)
2877   (save-excursion
2878     (and (dired-goto-file file)
2879          (let ((inhibit-read-only t))
2880            (delete-region (progn (beginning-of-line) (point))
2881                           (save-excursion (forward-line 1) (point))))))
2882   (dired-clean-up-after-deletion file))
2883
2884 (defvar dired-clean-up-buffers-too)
2885
2886 (defun dired-clean-up-after-deletion (fn)
2887   "Clean up after a deleted file or directory FN.
2888 Removes any expanded subdirectory of deleted directory.
2889 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
2890 also offers to kill buffers visiting deleted files and directories."
2891   (save-excursion (and (cdr dired-subdir-alist)
2892                        (dired-goto-subdir fn)
2893                        (dired-kill-subdir)))
2894   ;; Offer to kill buffer of deleted file FN.
2895   (when (and (featurep 'dired-x) dired-clean-up-buffers-too)
2896     (let ((buf (get-file-buffer fn)))
2897       (and buf
2898            (funcall #'y-or-n-p
2899                     (format "Kill buffer of %s, too? "
2900                             (file-name-nondirectory fn)))
2901            (kill-buffer buf)))
2902     (let ((buf-list (dired-buffers-for-dir (expand-file-name fn))))
2903       (and buf-list
2904            (y-or-n-p (format "Kill dired buffer%s of %s, too? "
2905                              (dired-plural-s (length buf-list))
2906                              (file-name-nondirectory fn)))
2907            (dolist (buf buf-list)
2908              (kill-buffer buf))))))
2909
2910 \f
2911 ;; Confirmation
2912
2913 (defun dired-marker-regexp ()
2914   (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2915
2916 (defun dired-plural-s (count)
2917   (if (= 1 count) "" "s"))
2918
2919 (defun dired-mark-prompt (arg files)
2920   "Return a string suitable for use in a Dired prompt.
2921 ARG is normally the prefix argument for the calling command.
2922 FILES should be a list of file names.
2923
2924 The return value has a form like \"foo.txt\", \"[next 3 files]\",
2925 or \"* [3 files]\"."
2926   ;; distinguish-one-marked can cause the first element to be just t.
2927   (if (eq (car files) t) (setq files (cdr files)))
2928   (let ((count (length files)))
2929     (if (= count 1)
2930         (car files)
2931       ;; more than 1 file:
2932       (if (integerp arg)
2933           ;; abs(arg) = count
2934           ;; Perhaps this is nicer, but it also takes more screen space:
2935           ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2936           ;;                        count)
2937           (format "[next %d files]" arg)
2938         (format "%c [%d files]" dired-marker-char count)))))
2939
2940 (defun dired-pop-to-buffer (buf)
2941   "Pop up buffer BUF in a way suitable for Dired."
2942   (let ((split-window-preferred-function
2943          (lambda (window)
2944            (or (and (let ((split-height-threshold 0))
2945                       (window-splittable-p (selected-window)))
2946                     ;; Try to split the selected window vertically if
2947                     ;; that's possible.  (Bug#1806)
2948                     (split-window-below))
2949                ;; Otherwise, try to split WINDOW sensibly.
2950                (split-window-sensibly window))))
2951         pop-up-frames)
2952     (pop-to-buffer (get-buffer-create buf)))
2953   ;; If dired-shrink-to-fit is t, make its window fit its contents.
2954   (when dired-shrink-to-fit
2955     ;; Try to not delete window when we want to display less than
2956     ;; `window-min-height' lines.
2957     (fit-window-to-buffer (get-buffer-window buf) nil 1)))
2958
2959 (defcustom dired-no-confirm nil
2960   "A list of symbols for commands Dired should not confirm, or t.
2961 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2962 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2963 `touch' and `uncompress'.
2964 If t, confirmation is never needed."
2965   :group 'dired
2966   :type '(choice (const :tag "Confirmation never needed" t)
2967                  (set (const byte-compile) (const chgrp)
2968                       (const chmod) (const chown) (const compress)
2969                       (const copy) (const delete) (const hardlink)
2970                       (const load) (const move) (const print)
2971                       (const shell) (const symlink) (const touch)
2972                       (const uncompress))))
2973
2974 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2975   "Return FUNCTION's result on ARGS after showing which files are marked.
2976 Displays the file names in a buffer named BUFNAME;
2977  nil gives \" *Marked Files*\".
2978 This uses function `dired-pop-to-buffer' to do that.
2979
2980 FUNCTION should not manipulate files, just read input
2981  (an argument or confirmation).
2982 The window is not shown if there is just one file or
2983  OP-SYMBOL is a member of the list in `dired-no-confirm'.
2984 FILES is the list of marked files.  It can also be (t FILENAME)
2985 in the case of one marked file, to distinguish that from using
2986 just the current file."
2987   (or bufname (setq bufname  " *Marked Files*"))
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     (with-current-buffer (get-buffer-create bufname)
2994       (erase-buffer)
2995       ;; Handle (t FILE) just like (FILE), here.
2996       ;; That value is used (only in some cases), to mean
2997       ;; just one file that was marked, rather than the current line file.
2998       (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2999       (remove-text-properties (point-min) (point-max)
3000                               '(mouse-face nil help-echo nil)))
3001     (save-window-excursion
3002       (dired-pop-to-buffer bufname)
3003       (apply function args))))
3004
3005 (defun dired-format-columns-of-files (files)
3006   (let ((beg (point)))
3007     (completion--insert-strings files)
3008     (put-text-property beg (point) 'mouse-face nil)))
3009 \f
3010 ;; Commands to mark or flag file(s) at or near current line.
3011
3012 (defun dired-repeat-over-lines (arg function)
3013   ;; This version skips non-file lines.
3014   (let ((pos (make-marker)))
3015     (beginning-of-line)
3016     (while (and (> arg 0) (not (eobp)))
3017       (setq arg (1- arg))
3018       (beginning-of-line)
3019       (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
3020       (save-excursion
3021         (forward-line 1)
3022         (move-marker pos (1+ (point))))
3023       (save-excursion (funcall function))
3024       ;; Advance to the next line--actually, to the line that *was* next.
3025       ;; (If FUNCTION inserted some new lines in between, skip them.)
3026       (goto-char pos))
3027     (while (and (< arg 0) (not (bobp)))
3028       (setq arg (1+ arg))
3029       (forward-line -1)
3030       (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
3031       (beginning-of-line)
3032       (save-excursion (funcall function)))
3033     (move-marker pos nil)
3034     (dired-move-to-filename)))
3035
3036 (defun dired-between-files ()
3037   ;; This used to be a regexp match of the `total ...' line output by
3038   ;; ls, which is slightly faster, but that is not very robust; notably,
3039   ;; it fails for non-english locales.
3040   (save-excursion (not (dired-move-to-filename))))
3041
3042 (defun dired-next-marked-file (arg &optional wrap opoint)
3043   "Move to the next marked file, wrapping around the end of the buffer."
3044   (interactive "p\np")
3045   (or opoint (setq opoint (point)));; return to where interactively started
3046   (if (if (> arg 0)
3047           (re-search-forward dired-re-mark nil t arg)
3048         (beginning-of-line)
3049         (re-search-backward dired-re-mark nil t (- arg)))
3050       (dired-move-to-filename)
3051     (if (null wrap)
3052         (progn
3053           (goto-char opoint)
3054           (error "No next marked file"))
3055       (message "(Wraparound for next marked file)")
3056       (goto-char (if (> arg 0) (point-min) (point-max)))
3057       (dired-next-marked-file arg nil opoint))))
3058
3059 (defun dired-prev-marked-file (arg &optional wrap)
3060   "Move to the previous marked file, wrapping around the end of the buffer."
3061   (interactive "p\np")
3062   (dired-next-marked-file (- arg) wrap))
3063
3064 (defun dired-file-marker (file)
3065   ;; Return FILE's marker, or nil if unmarked.
3066   (save-excursion
3067     (and (dired-goto-file file)
3068          (progn
3069            (beginning-of-line)
3070            (if (not (equal ?\040 (following-char)))
3071                (following-char))))))
3072
3073 (defun dired-mark-files-in-region (start end)
3074   (let ((inhibit-read-only t))
3075     (if (> start end)
3076         (error "start > end"))
3077     (goto-char start)                   ; assumed at beginning of line
3078     (while (< (point) end)
3079       ;; Skip subdir line and following garbage like the `total' line:
3080       (while (and (< (point) end) (dired-between-files))
3081         (forward-line 1))
3082       (if (and (not (looking-at dired-re-dot))
3083                (dired-get-filename nil t))
3084           (progn
3085             (delete-char 1)
3086             (insert dired-marker-char)))
3087       (forward-line 1))))
3088
3089 (defun dired-mark (arg)
3090   "Mark the current (or next ARG) files.
3091 If on a subdir headerline, mark all its files except `.' and `..'.
3092
3093 Use \\[dired-unmark-all-files] to remove all marks
3094 and \\[dired-unmark] on a subdir to remove the marks in
3095 this subdir."
3096   (interactive "P")
3097   (if (dired-get-subdir)
3098       (save-excursion (dired-mark-subdir-files))
3099     (let ((inhibit-read-only t))
3100       (dired-repeat-over-lines
3101        (prefix-numeric-value arg)
3102        (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
3103
3104 (defun dired-unmark (arg)
3105   "Unmark the current (or next ARG) files.
3106 If looking at a subdir, unmark all its files except `.' and `..'."
3107   (interactive "P")
3108   (let ((dired-marker-char ?\040))
3109     (dired-mark arg)))
3110
3111 (defun dired-flag-file-deletion (arg)
3112   "In Dired, flag the current line's file for deletion.
3113 With prefix arg, repeat over several lines.
3114
3115 If on a subdir headerline, mark all its files except `.' and `..'."
3116   (interactive "P")
3117   (let ((dired-marker-char dired-del-marker))
3118     (dired-mark arg)))
3119
3120 (defun dired-unmark-backward (arg)
3121   "In Dired, move up lines and remove marks or deletion flags there.
3122 Optional prefix ARG says how many lines to unmark/unflag; default
3123 is one line."
3124   (interactive "p")
3125   (dired-unmark (- arg)))
3126
3127 (defun dired-toggle-marks ()
3128   "Toggle marks: marked files become unmarked, and vice versa.
3129 Files marked with other flags (such as `D') are not affected.
3130 `.' and `..' are never toggled.
3131 As always, hidden subdirs are not affected."
3132   (interactive)
3133   (save-excursion
3134     (goto-char (point-min))
3135     (let ((inhibit-read-only t))
3136       (while (not (eobp))
3137         (or (dired-between-files)
3138             (looking-at dired-re-dot)
3139             ;; use subst instead of insdel because it does not move
3140             ;; the gap and thus should be faster and because
3141             ;; other characters are left alone automatically
3142             (apply 'subst-char-in-region
3143                    (point) (1+ (point))
3144                    (if (eq ?\040 (following-char)) ; SPC
3145                        (list ?\040 dired-marker-char)
3146                      (list dired-marker-char ?\040))))
3147         (forward-line 1)))))
3148 \f
3149 ;;; Commands to mark or flag files based on their characteristics or names.
3150
3151 (defvar dired-regexp-history nil
3152   "History list of regular expressions used in Dired commands.")
3153
3154 (defun dired-read-regexp (prompt)
3155   (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
3156
3157 (defun dired-mark-files-regexp (regexp &optional marker-char)
3158   "Mark all files matching REGEXP for use in later commands.
3159 A prefix argument means to unmark them instead.
3160 `.' and `..' are never marked.
3161
3162 REGEXP is an Emacs regexp, not a shell wildcard.  Thus, use `\\.o$' for
3163 object files--just `.o' will mark more than you might think."
3164   (interactive
3165    (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
3166                                     " files (regexp): "))
3167          (if current-prefix-arg ?\040)))
3168   (let ((dired-marker-char (or marker-char dired-marker-char)))
3169     (dired-mark-if
3170      (and (not (looking-at dired-re-dot))
3171           (not (eolp))                  ; empty line
3172           (let ((fn (dired-get-filename t t)))
3173             (and fn (string-match regexp fn))))
3174      "matching file")))
3175
3176 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
3177   "Mark all files with contents containing REGEXP for use in later commands.
3178 A prefix argument means to unmark them instead.
3179 `.' and `..' are never marked."
3180   (interactive
3181    (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
3182                                     " files containing (regexp): "))
3183          (if current-prefix-arg ?\040)))
3184   (let ((dired-marker-char (or marker-char dired-marker-char)))
3185     (dired-mark-if
3186      (and (not (looking-at dired-re-dot))
3187           (not (eolp))                  ; empty line
3188           (let ((fn (dired-get-filename nil t)))
3189             (when (and fn (file-readable-p fn)
3190                        (not (file-directory-p fn)))
3191               (let ((prebuf (get-file-buffer fn)))
3192                 (message "Checking %s" fn)
3193                 ;; For now we do it inside emacs
3194                 ;; Grep might be better if there are a lot of files
3195                 (if prebuf
3196                     (with-current-buffer prebuf
3197                       (save-excursion
3198                         (goto-char (point-min))
3199                         (re-search-forward regexp nil t)))
3200                   (with-temp-buffer
3201                     (insert-file-contents fn)
3202                     (goto-char (point-min))
3203                     (re-search-forward regexp nil t))))
3204                       )))
3205      "matching file")))
3206
3207 (defun dired-flag-files-regexp (regexp)
3208   "In Dired, flag all files containing the specified REGEXP for deletion.
3209 The match is against the non-directory part of the filename.  Use `^'
3210   and `$' to anchor matches.  Exclude subdirs by hiding them.
3211 `.' and `..' are never flagged."
3212   (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
3213   (dired-mark-files-regexp regexp dired-del-marker))
3214
3215 (defun dired-mark-symlinks (unflag-p)
3216   "Mark all symbolic links.
3217 With prefix argument, unmark or unflag all those files."
3218   (interactive "P")
3219   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3220     (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
3221
3222 (defun dired-mark-directories (unflag-p)
3223   "Mark all directory file lines except `.' and `..'.
3224 With prefix argument, unmark or unflag all those files."
3225   (interactive "P")
3226   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3227     (dired-mark-if (and (looking-at dired-re-dir)
3228                         (not (looking-at dired-re-dot)))
3229                    "directory file")))
3230
3231 (defun dired-mark-executables (unflag-p)
3232   "Mark all executable files.
3233 With prefix argument, unmark or unflag all those files."
3234   (interactive "P")
3235   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char)))
3236     (dired-mark-if (looking-at dired-re-exe) "executable file")))
3237
3238 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3239 ;; files for which PREDICATE returns non-nil.
3240
3241 (defun dired-flag-auto-save-files (&optional unflag-p)
3242   "Flag for deletion files whose names suggest they are auto save files.
3243 A prefix argument says to unmark or unflag those files instead."
3244   (interactive "P")
3245   (let ((dired-marker-char (if unflag-p ?\040 dired-del-marker)))
3246     (dired-mark-if
3247      ;; It is less than general to check for # here,
3248      ;; but it's the only way this runs fast enough.
3249      (and (save-excursion (end-of-line)
3250                           (or
3251                            (eq (preceding-char) ?#)
3252                            ;; Handle executables in case of -F option.
3253                            ;; We need not worry about the other kinds
3254                            ;; of markings that -F makes, since they won't
3255                            ;; appear on real auto-save files.
3256                            (if (eq (preceding-char) ?*)
3257                                (progn
3258                                  (forward-char -1)
3259                                  (eq (preceding-char) ?#)))))
3260           (not (looking-at dired-re-dir))
3261           (let ((fn (dired-get-filename t t)))
3262             (if fn (auto-save-file-name-p
3263                     (file-name-nondirectory fn)))))
3264      "auto save file")))
3265
3266 (defcustom dired-garbage-files-regexp
3267   ;; `log' here is dubious, since it's typically used for useful log
3268   ;; files, not just TeX stuff.  -- fx
3269   (concat (regexp-opt
3270            '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
3271           "\\'")
3272   "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
3273   :type 'regexp
3274   :group 'dired)
3275
3276 (defun dired-flag-garbage-files ()
3277   "Flag for deletion all files that match `dired-garbage-files-regexp'."
3278   (interactive)
3279   (dired-flag-files-regexp dired-garbage-files-regexp))
3280
3281 (defun dired-flag-backup-files (&optional unflag-p)
3282   "Flag all backup files (names ending with `~') for deletion.
3283 With prefix argument, unmark or unflag these files."
3284   (interactive "P")
3285   (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
3286     (dired-mark-if
3287      ;; Don't call backup-file-name-p unless the last character looks like
3288      ;; it might be the end of a backup file name.  This isn't very general,
3289      ;; but it's the only way this runs fast enough.
3290      (and (save-excursion (end-of-line)
3291                           ;; Handle executables in case of -F option.
3292                           ;; We need not worry about the other kinds
3293                           ;; of markings that -F makes, since they won't
3294                           ;; appear on real backup files.
3295                           (if (eq (preceding-char) ?*)
3296                               (forward-char -1))
3297                           (eq (preceding-char) ?~))
3298           (not (looking-at dired-re-dir))
3299           (let ((fn (dired-get-filename t t)))
3300             (if fn (backup-file-name-p fn))))
3301      "backup file")))
3302
3303 (defun dired-change-marks (&optional old new)
3304   "Change all OLD marks to NEW marks.
3305 OLD and NEW are both characters used to mark files."
3306   (interactive
3307    (let* ((cursor-in-echo-area t)
3308           (old (progn (message "Change (old mark): ") (read-char)))
3309           (new (progn (message  "Change %c marks to (new mark): " old)
3310                       (read-char))))
3311      (list old new)))
3312   (if (or (eq old ?\r) (eq new ?\r))
3313       (ding)
3314     (let ((string (format "\n%c" old))
3315           (inhibit-read-only t))
3316       (save-excursion
3317         (goto-char (point-min))
3318         (while (search-forward string nil t)
3319           (if (if (= old ?\s)
3320                   (save-match-data
3321                     (dired-get-filename 'no-dir t))
3322                 t)
3323               (subst-char-in-region (match-beginning 0)
3324                                     (match-end 0) old new)))))))
3325
3326 (defun dired-unmark-all-marks ()
3327   "Remove all marks from all files in the dired buffer."
3328   (interactive)
3329   (dired-unmark-all-files ?\r))
3330
3331 (defun dired-unmark-all-files (mark &optional arg)
3332   "Remove a specific mark (or any mark) from every file.
3333 After this command, type the mark character to remove,
3334 or type RET to remove all marks.
3335 With prefix arg, query for each marked file.
3336 Type \\[help-command] at that time for help."
3337   (interactive "cRemove marks (RET means all): \nP")
3338   (save-excursion
3339     (let* ((count 0)
3340            (inhibit-read-only t) case-fold-search
3341            (string (format "\n%c" mark))
3342            (help-form "\
3343 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3344 `!' to unmark all remaining files with no more questions."))
3345       (goto-char (point-min))
3346       (while (if (eq mark ?\r)
3347                  (re-search-forward dired-re-mark nil t)
3348                (search-forward string nil t))
3349         (if (or (not arg)
3350                 (let ((file (dired-get-filename t t)))
3351                   (and file
3352                        (dired-query 'query "Unmark file `%s'? "
3353                                     file))))
3354             (progn (subst-char-in-region (1- (point)) (point)
3355                                          (preceding-char) ?\s)
3356                    (setq count (1+ count)))))
3357       (message (if (= count 1) "1 mark removed"
3358                  "%d marks removed")
3359                count))))
3360 \f
3361 ;; Logging failures operating on files, and showing the results.
3362
3363 (defvar dired-log-buffer "*Dired log*")
3364
3365 (defun dired-why ()
3366   "Pop up a buffer with error log output from Dired.
3367 A group of errors from a single command ends with a formfeed.
3368 Thus, use \\[backward-page] to find the beginning of a group of errors."
3369   (interactive)
3370   (if (get-buffer dired-log-buffer)
3371       (let ((owindow (selected-window))
3372             (window (display-buffer (get-buffer dired-log-buffer))))
3373         (unwind-protect
3374             (progn
3375               (select-window window)
3376               (goto-char (point-max))
3377               (forward-line -1)
3378               (backward-page 1)
3379               (recenter 0))
3380           (select-window owindow)))))
3381
3382 (defun dired-log (log &rest args)
3383   ;; Log a message or the contents of a buffer.
3384   ;; If LOG is a string and there are more args, it is formatted with
3385   ;; those ARGS.  Usually the LOG string ends with a \n.
3386   ;; End each bunch of errors with (dired-log t):
3387   ;; this inserts the current time and buffer at the start of the page,
3388   ;; and \f (formfeed) at the end.
3389   (let ((obuf (current-buffer)))
3390     (with-current-buffer (get-buffer-create dired-log-buffer)
3391       (goto-char (point-max))
3392       (let ((inhibit-read-only t))
3393         (cond ((stringp log)
3394                (insert (if args
3395                            (apply (function format) log args)
3396                          log)))
3397               ((bufferp log)
3398                (insert-buffer-substring log))
3399               ((eq t log)
3400                (backward-page 1)
3401                (unless (bolp)
3402                  (insert "\n"))
3403                (insert (current-time-string)
3404                        "\tBuffer `" (buffer-name obuf) "'\n")
3405                (goto-char (point-max))
3406                (insert "\f\n")))))))
3407
3408 (defun dired-log-summary (string failures)
3409   "State a summary of a command's failures, in echo area and log buffer.
3410 STRING is an overall summary of the failures.
3411 FAILURES is a list of file names that we failed to operate on,
3412 or nil if file names are not applicable."
3413   (if (= (length failures) 1)
3414       (message "%s"
3415                (with-current-buffer dired-log-buffer
3416                  (goto-char (point-max))
3417                  (backward-page 1)
3418                  (if (eolp) (forward-line 1))
3419                  (buffer-substring (point) (point-max))))
3420     (message (if failures "%s--type ? for details (%s)"
3421                "%s--type ? for details")
3422              string failures))
3423   ;; Log a summary describing a bunch of errors.
3424   (dired-log (concat "\n" string "\n"))
3425   (dired-log t))
3426 \f
3427 ;;; Sorting
3428
3429 ;; Most ls can only sort by name or by date (with -t), nothing else.
3430 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3431 ;; So anything that does not contain these is sort "by name".
3432
3433 (defvar dired-ls-sorting-switches "SXU"
3434   "String of `ls' switches \(single letters\) except \"t\" that influence sorting.
3435
3436 This indicates to Dired which option switches to watch out for because they
3437 will change the sorting order behavior of `ls'.
3438
3439 To change the default sorting order \(e.g. add a `-v' option\), see the
3440 variable `dired-listing-switches'.  To temporarily override the listing
3441 format, use `\\[universal-argument] \\[dired]'.")
3442
3443 (defvar dired-sort-by-date-regexp
3444   (concat "\\(\\`\\| \\)-[^- ]*t"
3445           ;; `dired-ls-sorting-switches' after -t overrides -t.
3446           "[^ " dired-ls-sorting-switches "]*"
3447           "\\(\\(\\`\\| +\\)\\(--[^ ]+\\|-[^- t"
3448           dired-ls-sorting-switches "]+\\)\\)* *$")
3449   "Regexp recognized by Dired to set `by date' mode.")
3450
3451 (defvar dired-sort-by-name-regexp
3452   (concat "\\`\\(\\(\\`\\| +\\)\\(--[^ ]+\\|"
3453           "-[^- t" dired-ls-sorting-switches "]+\\)\\)* *$")
3454   "Regexp recognized by Dired to set `by name' mode.")
3455
3456 (defvar dired-sort-inhibit nil
3457   "Non-nil means the Dired sort command is disabled.
3458 The idea is to set this buffer-locally in special dired buffers.")
3459
3460 (defun dired-sort-set-mode-line ()
3461   ;; Set mode line display according to dired-actual-switches.
3462   ;; Mode line display of "by name" or "by date" guarantees the user a
3463   ;; match with the corresponding regexps.  Non-matching switches are
3464   ;; shown literally.
3465   (when (eq major-mode 'dired-mode)
3466     (setq mode-name
3467           (let (case-fold-search)
3468             (cond ((string-match
3469                     dired-sort-by-name-regexp dired-actual-switches)
3470                    "Dired by name")
3471                   ((string-match
3472                     dired-sort-by-date-regexp dired-actual-switches)
3473                    "Dired by date")
3474                   (t
3475                    (concat "Dired " dired-actual-switches)))))
3476     (force-mode-line-update)))
3477
3478 (define-obsolete-function-alias 'dired-sort-set-modeline
3479   'dired-sort-set-mode-line "24.3")
3480
3481 (defun dired-sort-toggle-or-edit (&optional arg)
3482   "Toggle sorting by date, and refresh the Dired buffer.
3483 With a prefix argument, edit the current listing switches instead."
3484   (interactive "P")
3485   (when dired-sort-inhibit
3486     (error "Cannot sort this dired buffer"))
3487   (if arg
3488       (dired-sort-other
3489        (read-string "ls switches (must contain -l): " dired-actual-switches))
3490     (dired-sort-toggle)))
3491
3492 (defun dired-sort-toggle ()
3493   ;; Toggle between sort by date/name.  Reverts the buffer.
3494   (let ((sorting-by-date (string-match dired-sort-by-date-regexp
3495                                        dired-actual-switches))
3496         ;; Regexp for finding (possibly embedded) -t switches.
3497         (switch-regexp "\\(\\`\\| \\)-\\([a-su-zA-Z]*\\)\\(t\\)\\([^ ]*\\)")
3498         case-fold-search)
3499     ;; Remove the -t switch.
3500     (while (string-match switch-regexp dired-actual-switches)
3501       (if (and (equal (match-string 2 dired-actual-switches) "")
3502                (equal (match-string 4 dired-actual-switches) ""))
3503           ;; Remove a stand-alone -t switch.
3504           (setq dired-actual-switches
3505                 (replace-match "" t t dired-actual-switches))
3506         ;; Remove a switch of the form -XtY for some X and Y.
3507         (setq dired-actual-switches
3508               (replace-match "" t t dired-actual-switches 3))))
3509     ;; Now, if we weren't sorting by date before, add the -t switch.
3510     (unless sorting-by-date
3511       (setq dired-actual-switches (concat dired-actual-switches " -t"))))
3512   (dired-sort-set-mode-line)
3513   (revert-buffer))
3514
3515 ;; Some user code loads dired especially for this.
3516 ;; Don't do that--use replace-regexp-in-string instead.
3517 (defun dired-replace-in-string (regexp newtext string)
3518   ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3519   ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3520   (let ((result "") (start 0) mb me)
3521     (while (string-match regexp string start)
3522       (setq mb (match-beginning 0)
3523             me (match-end 0)
3524             result (concat result (substring string start mb) newtext)
3525             start me))
3526     (concat result (substring string start))))
3527
3528 (defun dired-sort-other (switches &optional no-revert)
3529   "Specify new `ls' SWITCHES for current dired buffer.
3530 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3531 set the minor mode accordingly, others appear literally in the mode line.
3532 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3533   (dired-sort-R-check switches)
3534   (setq dired-actual-switches switches)
3535   (dired-sort-set-mode-line)
3536   (or no-revert (revert-buffer)))
3537
3538 (defvar dired-subdir-alist-pre-R nil
3539   "Value of `dired-subdir-alist' before -R switch added.")
3540 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3541
3542 (defun dired-sort-R-check (switches)
3543   "Additional processing of -R in ls option string SWITCHES.
3544 Saves `dired-subdir-alist' when R is set and restores saved value
3545 minus any directories explicitly deleted when R is cleared.
3546 To be called first in body of `dired-sort-other', etc."
3547   (cond
3548    ((and (string-match "R" switches)
3549          (not (string-match "R" dired-actual-switches)))
3550     ;; Adding -R to ls switches -- save `dired-subdir-alist':
3551     (setq dired-subdir-alist-pre-R dired-subdir-alist))
3552    ((and (string-match "R" dired-actual-switches)
3553          (not (string-match "R" switches)))
3554     ;; Deleting -R from ls switches -- revert to pre-R subdirs
3555     ;; that are still present:
3556     (setq dired-subdir-alist
3557           (if dired-subdir-alist-pre-R
3558               (let (subdirs)
3559                 (while dired-subdir-alist-pre-R
3560                   (if (assoc (caar dired-subdir-alist-pre-R)
3561                              dired-subdir-alist)
3562                       ;; subdir still present...
3563                       (setq subdirs
3564                             (cons (car dired-subdir-alist-pre-R)
3565                                   subdirs)))
3566                   (setq dired-subdir-alist-pre-R
3567                         (cdr dired-subdir-alist-pre-R)))
3568                 (reverse subdirs))
3569             ;; No pre-R subdir alist, so revert to main directory
3570             ;; listing:
3571             (list (car (reverse dired-subdir-alist))))))))
3572 \f
3573
3574 ;;;;  Drag and drop support
3575
3576 (defcustom dired-recursive-copies 'top
3577   "Whether Dired copies directories recursively.
3578 If nil, never copy recursively.
3579 `always' means to copy recursively without asking.
3580 `top' means to ask for each directory at top level.
3581 Any other value means to ask for each directory."
3582   :type '(choice :tag "Copy directories"
3583                  (const :tag "No recursive copies" nil)
3584                  (const :tag "Ask for each directory" t)
3585                  (const :tag "Ask for each top directory only" top)
3586                  (const :tag "Copy directories without asking" always))
3587   :group 'dired)
3588
3589 (defun dired-dnd-popup-notice ()
3590   (message-box
3591    "Dired recursive copies are currently disabled.\nSee the variable `dired-recursive-copies'."))
3592
3593 (declare-function x-popup-menu "menu.c" (position menu))
3594
3595 (defun dired-dnd-do-ask-action (uri)
3596   ;; No need to get actions and descriptions from the source,
3597   ;; we only have three actions anyway.
3598   (let ((action (x-popup-menu
3599                  t
3600                  (list "What action?"
3601                        (cons ""
3602                              '(("Copy here" . copy)
3603                                ("Move here" . move)
3604                                ("Link here" . link)
3605                                "--"
3606                                ("Cancel" . nil)))))))
3607     (if action
3608         (dired-dnd-handle-local-file uri action)
3609       nil)))
3610
3611 (declare-function dired-relist-entry "dired-aux" (file))
3612 (declare-function make-symbolic-link "fileio.c")
3613
3614 ;; Only used when (featurep 'dnd).
3615 (declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3616 (declare-function dnd-get-local-file-uri "dnd" (uri))
3617
3618 (defvar dired-overwrite-confirmed)      ;Defined in dired-aux.
3619
3620 (defun dired-dnd-handle-local-file (uri action)
3621   "Copy, move or link a file to the dired directory.
3622 URI is the file to handle, ACTION is one of copy, move, link or ask.
3623 Ask means pop up a menu for the user to select one of copy, move or link."
3624   (require 'dired-aux)
3625   (let* ((from (dnd-get-local-file-name uri t))
3626          (to (when from
3627                (concat (dired-current-directory)
3628                        (file-name-nondirectory from)))))
3629     (when from
3630       (cond ((eq action 'ask)
3631              (dired-dnd-do-ask-action uri))
3632             ;; If copying a directory and dired-recursive-copies is
3633             ;; nil, dired-copy-file fails.  Pop up a notice.
3634             ((and (memq action '(copy private))
3635                   (file-directory-p from)
3636                   (not dired-recursive-copies))
3637              (dired-dnd-popup-notice))
3638             ((memq action '(copy private move link))
3639              (let ((overwrite (and (file-exists-p to)
3640                                    (y-or-n-p
3641                                     (format "Overwrite existing file `%s'? " to))))
3642                    ;; Binding dired-overwrite-confirmed to nil makes
3643                    ;; dired-handle-overwrite a no-op.  We instead use
3644                    ;; y-or-n-p, which pops a graphical menu.
3645                    dired-overwrite-confirmed backup-file)
3646                (when (and overwrite
3647                           ;; d-b-o is defined in dired-aux.
3648                           (boundp 'dired-backup-overwrite)
3649                           dired-backup-overwrite
3650                           (setq backup-file
3651                                 (car (find-backup-file-name to)))
3652                           (or (eq dired-backup-overwrite 'always)
3653                               (y-or-n-p
3654                                (format
3655                                 "Make backup for existing file `%s'? " to))))
3656                  (rename-file to backup-file 0)
3657                  (dired-relist-entry backup-file))
3658                (cond ((memq action '(copy private))
3659                       (dired-copy-file from to overwrite))
3660                      ((eq action 'move)
3661                       (dired-rename-file from to overwrite))
3662                      ((eq action 'link)
3663                       (make-symbolic-link from to overwrite)))
3664                (dired-relist-entry to)
3665                action))))))
3666
3667 (defun dired-dnd-handle-file (uri action)
3668   "Copy, move or link a file to the dired directory if it is a local file.
3669 URI is the file to handle.  If the hostname in the URI isn't local, do nothing.
3670 ACTION is one of copy, move, link or ask.
3671 Ask means pop up a menu for the user to select one of copy, move or link."
3672   (let ((local-file (dnd-get-local-file-uri uri)))
3673     (if local-file (dired-dnd-handle-local-file local-file action)
3674       nil)))
3675 \f
3676
3677 ;;;;  Desktop support
3678
3679 (eval-when-compile (require 'desktop))
3680
3681 (defun dired-desktop-buffer-misc-data (dirname)
3682   "Auxiliary information to be saved in desktop file."
3683   (cons
3684    ;; Value of `dired-directory'.
3685    (if (consp dired-directory)
3686        ;; Directory name followed by list of files.
3687        (cons (desktop-file-name (car dired-directory) dirname)
3688              (cdr dired-directory))
3689      ;; Directory name, optionally with shell wildcard.
3690      (desktop-file-name dired-directory dirname))
3691    ;; Subdirectories in `dired-subdir-alist'.
3692    (cdr
3693      (nreverse
3694        (mapcar
3695          (function (lambda (f) (desktop-file-name (car f) dirname)))
3696          dired-subdir-alist)))))
3697
3698 (defun dired-restore-desktop-buffer (_file-name
3699                                      _buffer-name
3700                                      misc-data)
3701   "Restore a dired buffer specified in a desktop file."
3702   ;; First element of `misc-data' is the value of `dired-directory'.
3703   ;; This value is a directory name, optionally with shell wildcard or
3704   ;; a directory name followed by list of files.
3705   (let* ((dired-dir (car misc-data))
3706          (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3707     (if (file-directory-p (file-name-directory dir))
3708         (progn
3709           (dired dired-dir)
3710           ;; The following elements of `misc-data' are the keys
3711           ;; from `dired-subdir-alist'.
3712           (mapc 'dired-maybe-insert-subdir (cdr misc-data))
3713           (current-buffer))
3714       (message "Desktop: Directory %s no longer exists." dir)
3715       (when desktop-missing-file-warning (sit-for 1))
3716       nil)))
3717
3718 (add-to-list 'desktop-buffer-mode-handlers
3719              '(dired-mode . dired-restore-desktop-buffer))
3720
3721 \f
3722 ;;; Start of automatically extracted autoloads.
3723 \f
3724 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3725 ;;;;;;  dired-do-search dired-do-isearch-regexp dired-do-isearch
3726 ;;;;;;  dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3727 ;;;;;;  dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3728 ;;;;;;  dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3729 ;;;;;;  dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3730 ;;;;;;  dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3731 ;;;;;;  dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3732 ;;;;;;  dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3733 ;;;;;;  dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3734 ;;;;;;  dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3735 ;;;;;;  dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3736 ;;;;;;  dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3737 ;;;;;;  dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3738 ;;;;;;  dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3739 ;;;;;;  dired-diff) "dired-aux" "dired-aux.el" "9499f79f5853da0aa93d26465c7bf3a1")
3740 ;;; Generated autoloads from dired-aux.el
3741
3742 (autoload 'dired-diff "dired-aux" "\
3743 Compare file at point with file FILE using `diff'.
3744 FILE defaults to the file at the mark.  (That's the mark set by
3745 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
3746 The prompted-for FILE is the first file given to `diff'.
3747 With prefix arg, prompt for second argument SWITCHES,
3748 which is the string of command switches for `diff'.
3749
3750 \(fn FILE &optional SWITCHES)" t nil)
3751
3752 (autoload 'dired-backup-diff "dired-aux" "\
3753 Diff this file with its backup file or vice versa.
3754 Uses the latest backup, if there are several numerical backups.
3755 If this file is a backup, diff it with its original.
3756 The backup file is the first file given to `diff'.
3757 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3758
3759 \(fn &optional SWITCHES)" t nil)
3760
3761 (autoload 'dired-compare-directories "dired-aux" "\
3762 Mark files with different file attributes in two dired buffers.
3763 Compare file attributes of files in the current directory
3764 with file attributes in directory DIR2 using PREDICATE on pairs of files
3765 with the same name.  Mark files for which PREDICATE returns non-nil.
3766 Mark files with different names if PREDICATE is nil (or interactively
3767 with empty input at the predicate prompt).
3768
3769 PREDICATE is a Lisp expression that can refer to the following variables:
3770
3771     size1, size2   - file size in bytes
3772     mtime1, mtime2 - last modification time in seconds, as a float
3773     fa1, fa2       - list of file attributes
3774                      returned by function `file-attributes'
3775
3776     where 1 refers to attribute of file in the current dired buffer
3777     and 2 to attribute of file in second dired buffer.
3778
3779 Examples of PREDICATE:
3780
3781     (> mtime1 mtime2) - mark newer files
3782     (not (= size1 size2)) - mark files with different sizes
3783     (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3784     (not (and (= (nth 2 fa1) (nth 2 fa2))   - mark files with different UID
3785               (= (nth 3 fa1) (nth 3 fa2))))   and GID.
3786
3787 \(fn DIR2 PREDICATE)" t nil)
3788
3789 (autoload 'dired-do-chmod "dired-aux" "\
3790 Change the mode of the marked (or next ARG) files.
3791 Symbolic modes like `g+w' are allowed.
3792
3793 \(fn &optional ARG)" t nil)
3794
3795 (autoload 'dired-do-chgrp "dired-aux" "\
3796 Change the group of the marked (or next ARG) files.
3797
3798 \(fn &optional ARG)" t nil)
3799
3800 (autoload 'dired-do-chown "dired-aux" "\
3801 Change the owner of the marked (or next ARG) files.
3802
3803 \(fn &optional ARG)" t nil)
3804
3805 (autoload 'dired-do-touch "dired-aux" "\
3806 Change the timestamp of the marked (or next ARG) files.
3807 This calls touch.
3808
3809 \(fn &optional ARG)" t nil)
3810
3811 (autoload 'dired-do-print "dired-aux" "\
3812 Print the marked (or next ARG) files.
3813 Uses the shell command coming from variables `lpr-command' and
3814 `lpr-switches' as default.
3815
3816 \(fn &optional ARG)" t nil)
3817
3818 (autoload 'dired-clean-directory "dired-aux" "\
3819 Flag numerical backups for deletion.
3820 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3821 Positive prefix arg KEEP overrides `dired-kept-versions';
3822 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3823
3824 To clear the flags on these files, you can use \\[dired-flag-backup-files]
3825 with a prefix argument.
3826
3827 \(fn KEEP)" t nil)
3828
3829 (autoload 'dired-do-async-shell-command "dired-aux" "\
3830 Run a shell command COMMAND on the marked files asynchronously.
3831
3832 Like `dired-do-shell-command', but adds `&' at the end of COMMAND
3833 to execute it asynchronously.
3834
3835 When operating on multiple files, asynchronous commands
3836 are executed in the background on each file in parallel.
3837 In shell syntax this means separating the individual commands
3838 with `&'.  However, when COMMAND ends in `;' or `;&' then commands
3839 are executed in the background on each file sequentially waiting
3840 for each command to terminate before running the next command.
3841 In shell syntax this means separating the individual commands with `;'.
3842
3843 The output appears in the buffer `*Async Shell Command*'.
3844
3845 \(fn COMMAND &optional ARG FILE-LIST)" t nil)
3846
3847 (autoload 'dired-do-shell-command "dired-aux" "\
3848 Run a shell command COMMAND on the marked files.
3849 If no files are marked or a numeric prefix arg is given,
3850 the next ARG files are used.  Just \\[universal-argument] means the current file.
3851 The prompt mentions the file(s) or the marker, as appropriate.
3852
3853 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3854 COMMAND just once with the entire file list substituted there.
3855
3856 If there is no `*', but there is a `?' in COMMAND, surrounded by
3857 whitespace, this runs COMMAND on each file individually with the
3858 file name substituted for `?'.
3859
3860 Otherwise, this runs COMMAND on each file individually with the
3861 file name added at the end of COMMAND (separated by a space).
3862
3863 `*' and `?' when not surrounded by whitespace have no special
3864 significance for `dired-do-shell-command', and are passed through
3865 normally to the shell, but you must confirm first.
3866
3867 If you want to use `*' as a shell wildcard with whitespace around
3868 it, write `*\"\"' in place of just `*'.  This is equivalent to just
3869 `*' in the shell, but avoids Dired's special handling.
3870
3871 If COMMAND ends in `&', `;', or `;&', it is executed in the
3872 background asynchronously, and the output appears in the buffer
3873 `*Async Shell Command*'.  When operating on multiple files and COMMAND
3874 ends in `&', the shell command is executed on each file in parallel.
3875 However, when COMMAND ends in `;' or `;&' then commands are executed
3876 in the background on each file sequentially waiting for each command
3877 to terminate before running the next command.  You can also use
3878 `dired-do-async-shell-command' that automatically adds `&'.
3879
3880 Otherwise, COMMAND is executed synchronously, and the output
3881 appears in the buffer `*Shell Command Output*'.
3882
3883 This feature does not try to redisplay Dired buffers afterward, as
3884 there's no telling what files COMMAND may have changed.
3885 Type \\[dired-do-redisplay] to redisplay the marked files.
3886
3887 When COMMAND runs, its working directory is the top-level directory
3888 of the Dired buffer, so output files usually are created there
3889 instead of in a subdir.
3890
3891 In a noninteractive call (from Lisp code), you must specify
3892 the list of file names explicitly with the FILE-LIST argument, which
3893 can be produced by `dired-get-marked-files', for example.
3894
3895 \(fn COMMAND &optional ARG FILE-LIST)" t nil)
3896
3897 (autoload 'dired-run-shell-command "dired-aux" "\
3898
3899
3900 \(fn COMMAND)" nil nil)
3901
3902 (autoload 'dired-do-kill-lines "dired-aux" "\
3903 Kill all marked lines (not the files).
3904 With a prefix argument, kill that many lines starting with the current line.
3905 \(A negative argument kills backward.)
3906 If you use this command with a prefix argument to kill the line
3907 for a file that is a directory, which you have inserted in the
3908 Dired buffer as a subdirectory, then it deletes that subdirectory
3909 from the buffer as well.
3910 To kill an entire subdirectory (without killing its line in the
3911 parent directory), go to its directory header line and use this
3912 command with a prefix argument (the value does not matter).
3913
3914 \(fn &optional ARG FMT)" t nil)
3915
3916 (autoload 'dired-compress-file "dired-aux" "\
3917
3918
3919 \(fn FILE)" nil nil)
3920
3921 (autoload 'dired-query "dired-aux" "\
3922 Format PROMPT with ARGS, query user, and store the result in SYM.
3923 The return value is either nil or t.
3924
3925 The user may type y or SPC to accept once; n or DEL to skip once;
3926 ! to accept this and subsequent queries; or q or ESC to decline
3927 this and subsequent queries.
3928
3929 If SYM is already bound to a non-nil value, this function may
3930 return automatically without querying the user.  If SYM is !,
3931 return t; if SYM is q or ESC, return nil.
3932
3933 \(fn SYM PROMPT &rest ARGS)" nil nil)
3934
3935 (autoload 'dired-do-compress "dired-aux" "\
3936 Compress or uncompress marked (or next ARG) files.
3937
3938 \(fn &optional ARG)" t nil)
3939
3940 (autoload 'dired-do-byte-compile "dired-aux" "\
3941 Byte compile marked (or next ARG) Emacs Lisp files.
3942
3943 \(fn &optional ARG)" t nil)
3944
3945 (autoload 'dired-do-load "dired-aux" "\
3946 Load the marked (or next ARG) Emacs Lisp files.
3947
3948 \(fn &optional ARG)" t nil)
3949
3950 (autoload 'dired-do-redisplay "dired-aux" "\
3951 Redisplay all marked (or next ARG) files.
3952 If on a subdir line, redisplay that subdirectory.  In that case,
3953 a prefix arg lets you edit the `ls' switches used for the new listing.
3954
3955 Dired remembers switches specified with a prefix arg, so that reverting
3956 the buffer will not reset them.  However, using `dired-undo' to re-insert
3957 or delete subdirectories can bypass this machinery.  Hence, you sometimes
3958 may have to reset some subdirectory switches after a `dired-undo'.
3959 You can reset all subdirectory switches to the default using
3960 \\<dired-mode-map>\\[dired-reset-subdir-switches].
3961 See Info node `(emacs)Subdir switches' for more details.
3962
3963 \(fn &optional ARG TEST-FOR-SUBDIR)" t nil)
3964
3965 (autoload 'dired-add-file "dired-aux" "\
3966
3967
3968 \(fn FILENAME &optional MARKER-CHAR)" nil nil)
3969
3970 (autoload 'dired-remove-file "dired-aux" "\
3971
3972
3973 \(fn FILE)" nil nil)
3974
3975 (autoload 'dired-relist-file "dired-aux" "\
3976 Create or update the line for FILE in all Dired buffers it would belong in.
3977
3978 \(fn FILE)" nil nil)
3979
3980 (autoload 'dired-copy-file "dired-aux" "\
3981
3982
3983 \(fn FROM TO OK-FLAG)" nil nil)
3984
3985 (autoload 'dired-rename-file "dired-aux" "\
3986
3987
3988 \(fn FILE NEWNAME OK-IF-ALREADY-EXISTS)" nil nil)
3989
3990 (autoload 'dired-create-directory "dired-aux" "\
3991 Create a directory called DIRECTORY.
3992 If DIRECTORY already exists, signal an error.
3993
3994 \(fn DIRECTORY)" t nil)
3995
3996 (autoload 'dired-do-copy "dired-aux" "\
3997 Copy all marked (or next ARG) files, or copy the current file.
3998 When operating on just the current file, prompt for the new name.
3999
4000 When operating on multiple or marked files, prompt for a target
4001 directory, and make the new copies in that directory, with the
4002 same names as the original files.  The initial suggestion for the
4003 target directory is the Dired buffer's current directory (or, if
4004 `dired-dwim-target' is non-nil, the current directory of a
4005 neighboring Dired window).
4006
4007 If `dired-copy-preserve-time' is non-nil, this command preserves
4008 the modification time of each old file in the copy, similar to
4009 the \"-p\" option for the \"cp\" shell command.
4010
4011 This command copies symbolic links by creating new ones, similar
4012 to the \"-d\" option for the \"cp\" shell command.
4013
4014 \(fn &optional ARG)" t nil)
4015
4016 (autoload 'dired-do-symlink "dired-aux" "\
4017 Make symbolic links to current file or all marked (or next ARG) files.
4018 When operating on just the current file, you specify the new name.
4019 When operating on multiple or marked files, you specify a directory
4020 and new symbolic links are made in that directory
4021 with the same names that the files currently have.  The default
4022 suggested for the target directory depends on the value of
4023 `dired-dwim-target', which see.
4024
4025 For relative symlinks, use \\[dired-do-relsymlink].
4026
4027 \(fn &optional ARG)" t nil)
4028
4029 (autoload 'dired-do-hardlink "dired-aux" "\
4030 Add names (hard links) current file or all marked (or next ARG) files.
4031 When operating on just the current file, you specify the new name.
4032 When operating on multiple or marked files, you specify a directory
4033 and new hard links are made in that directory
4034 with the same names that the files currently have.  The default
4035 suggested for the target directory depends on the value of
4036 `dired-dwim-target', which see.
4037
4038 \(fn &optional ARG)" t nil)
4039
4040 (autoload 'dired-do-rename "dired-aux" "\
4041 Rename current file or all marked (or next ARG) files.
4042 When renaming just the current file, you specify the new name.
4043 When renaming multiple or marked files, you specify a directory.
4044 This command also renames any buffers that are visiting the files.
4045 The default suggested for the target directory depends on the value
4046 of `dired-dwim-target', which see.
4047
4048 \(fn &optional ARG)" t nil)
4049
4050 (autoload 'dired-do-rename-regexp "dired-aux" "\
4051 Rename selected files whose names match REGEXP to NEWNAME.
4052
4053 With non-zero prefix argument ARG, the command operates on the next ARG
4054 files.  Otherwise, it operates on all the marked files, or the current
4055 file if none are marked.
4056
4057 As each match is found, the user must type a character saying
4058   what to do with it.  For directions, type \\[help-command] at that time.
4059 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
4060 REGEXP defaults to the last regexp used.
4061
4062 With a zero prefix arg, renaming by regexp affects the absolute file name.
4063 Normally, only the non-directory part of the file name is used and changed.
4064
4065 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
4066
4067 (autoload 'dired-do-copy-regexp "dired-aux" "\
4068 Copy selected files whose names match REGEXP to NEWNAME.
4069 See function `dired-do-rename-regexp' for more info.
4070
4071 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
4072
4073 (autoload 'dired-do-hardlink-regexp "dired-aux" "\
4074 Hardlink selected files whose names match REGEXP to NEWNAME.
4075 See function `dired-do-rename-regexp' for more info.
4076
4077 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
4078
4079 (autoload 'dired-do-symlink-regexp "dired-aux" "\
4080 Symlink selected files whose names match REGEXP to NEWNAME.
4081 See function `dired-do-rename-regexp' for more info.
4082
4083 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
4084
4085 (autoload 'dired-upcase "dired-aux" "\
4086 Rename all marked (or next ARG) files to upper case.
4087
4088 \(fn &optional ARG)" t nil)
4089
4090 (autoload 'dired-downcase "dired-aux" "\
4091 Rename all marked (or next ARG) files to lower case.
4092
4093 \(fn &optional ARG)" t nil)
4094
4095 (autoload 'dired-maybe-insert-subdir "dired-aux" "\
4096 Insert this subdirectory into the same dired buffer.
4097 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
4098   else inserts it at its natural place (as `ls -lR' would have done).
4099 With a prefix arg, you may edit the ls switches used for this listing.
4100   You can add `R' to the switches to expand the whole tree starting at
4101   this subdirectory.
4102 This function takes some pains to conform to `ls -lR' output.
4103
4104 Dired remembers switches specified with a prefix arg, so that reverting
4105 the buffer will not reset them.  However, using `dired-undo' to re-insert
4106 or delete subdirectories can bypass this machinery.  Hence, you sometimes
4107 may have to reset some subdirectory switches after a `dired-undo'.
4108 You can reset all subdirectory switches to the default using
4109 \\<dired-mode-map>\\[dired-reset-subdir-switches].
4110 See Info node `(emacs)Subdir switches' for more details.
4111
4112 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
4113
4114 (autoload 'dired-insert-subdir "dired-aux" "\
4115 Insert this subdirectory into the same Dired buffer.
4116 If it is already present, overwrite the previous entry;
4117   otherwise, insert it at its natural place (as `ls -lR' would
4118   have done).
4119 With a prefix arg, you may edit the `ls' switches used for this listing.
4120   You can add `R' to the switches to expand the whole tree starting at
4121   this subdirectory.
4122 This function takes some pains to conform to `ls -lR' output.
4123
4124 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
4125
4126 (autoload 'dired-prev-subdir "dired-aux" "\
4127 Go to previous subdirectory, regardless of level.
4128 When called interactively and not on a subdir line, go to this subdir's line.
4129
4130 \(fn ARG &optional NO-ERROR-IF-NOT-FOUND NO-SKIP)" t nil)
4131
4132 (autoload 'dired-goto-subdir "dired-aux" "\
4133 Go to end of header line of DIR in this dired buffer.
4134 Return value of point on success, otherwise return nil.
4135 The next char is either \\n, or \\r if DIR is hidden.
4136
4137 \(fn DIR)" t nil)
4138
4139 (autoload 'dired-mark-subdir-files "dired-aux" "\
4140 Mark all files except `.' and `..' in current subdirectory.
4141 If the Dired buffer shows multiple directories, this command
4142 marks the files listed in the subdirectory that point is in.
4143
4144 \(fn)" t nil)
4145
4146 (autoload 'dired-kill-subdir "dired-aux" "\
4147 Remove all lines of current subdirectory.
4148 Lower levels are unaffected.
4149
4150 \(fn &optional REMEMBER-MARKS)" t nil)
4151
4152 (autoload 'dired-tree-up "dired-aux" "\
4153 Go up ARG levels in the dired tree.
4154
4155 \(fn ARG)" t nil)
4156
4157 (autoload 'dired-tree-down "dired-aux" "\
4158 Go down in the dired tree.
4159
4160 \(fn)" t nil)
4161
4162 (autoload 'dired-hide-subdir "dired-aux" "\
4163 Hide or unhide the current subdirectory and move to next directory.
4164 Optional prefix arg is a repeat factor.
4165 Use \\[dired-hide-all] to (un)hide all directories.
4166
4167 \(fn ARG)" t nil)
4168
4169 (autoload 'dired-hide-all "dired-aux" "\
4170 Hide all subdirectories, leaving only their header lines.
4171 If there is already something hidden, make everything visible again.
4172 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory.
4173
4174 \(fn &optional IGNORED)" t nil)
4175
4176 (autoload 'dired-isearch-filenames-setup "dired-aux" "\
4177 Set up isearch to search in Dired file names.
4178 Intended to be added to `isearch-mode-hook'.
4179
4180 \(fn)" nil nil)
4181
4182 (autoload 'dired-isearch-filenames "dired-aux" "\
4183 Search for a string using Isearch only in file names in the Dired buffer.
4184
4185 \(fn)" t nil)
4186
4187 (autoload 'dired-isearch-filenames-regexp "dired-aux" "\
4188 Search for a regexp using Isearch only in file names in the Dired buffer.
4189
4190 \(fn)" t nil)
4191
4192 (autoload 'dired-do-isearch "dired-aux" "\
4193 Search for a string through all marked files using Isearch.
4194
4195 \(fn)" t nil)
4196
4197 (autoload 'dired-do-isearch-regexp "dired-aux" "\
4198 Search for a regexp through all marked files using Isearch.
4199
4200 \(fn)" t nil)
4201
4202 (autoload 'dired-do-search "dired-aux" "\
4203 Search through all marked files for a match for REGEXP.
4204 Stops when a match is found.
4205 To continue searching for next match, use command \\[tags-loop-continue].
4206
4207 \(fn REGEXP)" t nil)
4208
4209 (autoload 'dired-do-query-replace-regexp "dired-aux" "\
4210 Do `query-replace-regexp' of FROM with TO, on all marked files.
4211 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4212 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
4213 with the command \\[tags-loop-continue].
4214
4215 \(fn FROM TO &optional DELIMITED)" t nil)
4216
4217 (autoload 'dired-show-file-type "dired-aux" "\
4218 Print the type of FILE, according to the `file' command.
4219 If you give a prefix to this command, and FILE is a symbolic
4220 link, then the type of the file linked to by FILE is printed
4221 instead.
4222
4223 \(fn FILE &optional DEREF-SYMLINKS)" t nil)
4224
4225 ;;;***
4226 \f
4227 ;;;### (autoloads (dired-do-relsymlink dired-jump-other-window dired-jump)
4228 ;;;;;;  "dired-x" "dired-x.el" "d2461aa6efb8c1d7de8f245728ab448e")
4229 ;;; Generated autoloads from dired-x.el
4230
4231 (autoload 'dired-jump "dired-x" "\
4232 Jump to dired buffer corresponding to current buffer.
4233 If in a file, dired the current directory and move to file's line.
4234 If in Dired already, pop up a level and goto old directory's line.
4235 In case the proper dired file line cannot be found, refresh the dired
4236 buffer and try again.
4237 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4238 Interactively with prefix argument, read FILE-NAME and
4239 move to its line in dired.
4240
4241 \(fn &optional OTHER-WINDOW FILE-NAME)" t nil)
4242
4243 (autoload 'dired-jump-other-window "dired-x" "\
4244 Like \\[dired-jump] (`dired-jump') but in other window.
4245
4246 \(fn &optional FILE-NAME)" t nil)
4247
4248 (autoload 'dired-do-relsymlink "dired-x" "\
4249 Relative symlink all marked (or next ARG) files into a directory.
4250 Otherwise make a relative symbolic link to the current file.
4251 This creates relative symbolic links like
4252
4253     foo -> ../bar/foo
4254
4255 not absolute ones like
4256
4257     foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4258
4259 For absolute symlinks, use \\[dired-do-symlink].
4260
4261 \(fn &optional ARG)" t nil)
4262
4263 ;;;***
4264 \f
4265 ;;; End of automatically extracted autoloads.
4266
4267 (provide 'dired)
4268
4269 (run-hooks 'dired-load-hook)            ; for your customizations
4270
4271 ;;; dired.el ends here