lisp/dired-x.el

   1 ;;; dired-x.el --- extra Dired functionality
   2
   3 ;; Copyright (C) 1993-1994, 1997, 2001-2011 Free Software Foundation, Inc.
   4
   5 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
   6 ;;      Lawrence R. Dodd <dodd@roebling.poly.edu>
   7 ;; Maintainer: Romain Francoise <rfrancoise@gnu.org>
   8 ;; Keywords: dired extensions 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 Sebastian Kremer's excellent dired-x.el (Dired Extra), version
  29 ;; 1.191, hacked up for GNU Emacs.  Redundant or conflicting material has
  30 ;; been removed or renamed in order to work properly with dired of GNU
  31 ;; Emacs.  All suggestions or comments are most welcomed.
  32
  33 ;;
  34 ;; Please, PLEASE, *PLEASE* see the info pages.
  35 ;;
  36
  37 ;; BUGS: Type M-x dired-x-submit-report and a report will be generated.
  38
  39 ;; INSTALLATION: In your ~/.emacs,
  40 ;;
  41 ;; (add-hook 'dired-load-hook
  42 ;;           (function (lambda ()
  43 ;;                       (load "dired-x")
  44 ;;                       ;; Set global variables here.  For example:
  45 ;;                       ;; (setq dired-guess-shell-gnutar "gtar")
  46 ;;                       )))
  47 ;; (add-hook 'dired-mode-hook
  48 ;;           (function (lambda ()
  49 ;;                       ;; Set buffer-local variables here.  For example:
  50 ;;                       ;; (dired-omit-mode 1)
  51 ;;                       )))
  52 ;;
  53 ;; At load time dired-x.el will install itself, redefine some functions, and
  54 ;; bind some dired keys.  *Please* see the info pages for more details.
  55
  56 ;; *Please* see the info pages for more details.
  57
  58 ;; User defined variables:
  59 ;;
  60 ;;      dired-bind-vm
  61 ;;      dired-vm-read-only-folders
  62 ;;      dired-bind-jump
  63 ;;      dired-bind-info
  64 ;;      dired-bind-man
  65 ;;      dired-x-hands-off-my-keys
  66 ;;      dired-find-subdir
  67 ;;      dired-enable-local-variables
  68 ;;      dired-local-variables-file
  69 ;;      dired-guess-shell-gnutar
  70 ;;      dired-guess-shell-gzip-quiet
  71 ;;      dired-guess-shell-znew-switches
  72 ;;      dired-guess-shell-alist-user
  73 ;;      dired-clean-up-buffers-too
  74 ;;      dired-omit-mode
  75 ;;      dired-omit-files
  76 ;;      dired-omit-extensions
  77 ;;      dired-omit-size-limit
  78 ;;
  79 ;; To find out more about these variables, load this file, put your cursor at
  80 ;; the end of any of the variable names, and hit C-h v [RET].  *Please* see
  81 ;; the info pages for more details.
  82
  83 ;; When loaded this code redefines the following functions of GNU Emacs
  84 ;;
  85 ;;   Function                         Found in this file of GNU Emacs
  86 ;;   --------                         -------------------------------
  87 ;;   dired-clean-up-after-deletion    ../lisp/dired.el
  88 ;;   dired-find-buffer-nocreate       ../lisp/dired.el
  89 ;;   dired-initial-position           ../lisp/dired.el
  90 ;;
  91 ;;   dired-add-entry                  ../lisp/dired-aux.el
  92 ;;   dired-read-shell-command         ../lisp/dired-aux.el
  93
  94 \f
  95 ;;; Code:
  96
  97 ;; LOAD.
  98
  99 ;; This is a no-op if dired-x is being loaded via `dired-load-hook'.  It is
 100 ;; here in case the user has autoloaded dired-x via the dired-jump key binding
 101 ;; (instead of autoloading to dired as is suggested in the info-pages).
 102
 103 (require 'dired)
 104
 105 ;; We will redefine some functions and also need some macros so we need to
 106 ;; load dired stuff of GNU Emacs.
 107
 108 (require 'dired-aux)
 109
 110 (defvar vm-folder-directory)
 111 (eval-when-compile (require 'man))
 112
 113 ;;; User-defined variables.
 114
 115 (defgroup dired-x nil
 116   "Extended directory editing (dired-x)."
 117   :group 'dired)
 118
 119 (defgroup dired-keys nil
 120   "Dired keys customizations."
 121   :prefix "dired-"
 122   :group 'dired-x)
 123
 124 (defcustom dired-bind-vm nil
 125   "Non-nil means \"V\" runs `dired-vm', otherwise \"V\" runs `dired-rmail'.
 126
 127 RMAIL files in the old Babyl format (used before before Emacs 23.1)
 128 contain \"-*- rmail -*-\" at the top, so `dired-find-file'
 129 will run `rmail' on these files.  New RMAIL files use the standard
 130 mbox format, and so cannot be distinguished in this way."
 131   :type 'boolean
 132   :group 'dired-keys)
 133
 134 (defcustom dired-bind-jump t
 135   "Non-nil means bind `dired-jump' to C-x C-j, otherwise do not."
 136   :type 'boolean
 137   :group 'dired-keys)
 138
 139 (defcustom dired-bind-man t
 140   "Non-nil means bind `dired-man' to \"N\" in dired-mode, otherwise do not."
 141   :type 'boolean
 142   :group 'dired-keys)
 143
 144 (defcustom dired-bind-info t
 145   "Non-nil means bind `dired-info' to \"I\" in dired-mode, otherwise do not."
 146   :type 'boolean
 147   :group 'dired-keys)
 148
 149 (defcustom dired-vm-read-only-folders nil
 150   "If non-nil, \\[dired-vm] will visit all folders read-only.
 151 If neither nil nor t, e.g. the symbol `if-file-read-only', only
 152 files not writable by you are visited read-only.
 153
 154 Read-only folders only work in VM 5, not in VM 4."
 155   :type '(choice (const :tag "off" nil)
 156                  (const :tag "on" t)
 157                  (other :tag "non-writable only" if-file-read-only))
 158   :group 'dired-x)
 159
 160 (define-minor-mode dired-omit-mode
 161   "Toggle Dired-Omit mode.
 162 With numeric ARG, enable Dired-Omit mode if ARG is positive, disable
 163 otherwise.  Enabling and disabling is buffer-local.
 164 If enabled, \"uninteresting\" files are not listed.
 165 Uninteresting files are those whose filenames match regexp `dired-omit-files',
 166 plus those ending with extensions in `dired-omit-extensions'.
 167
 168 To enable omitting in every Dired buffer, you can put in your ~/.emacs
 169
 170   (add-hook 'dired-mode-hook (lambda () (dired-omit-mode 1)))
 171
 172 See Info node `(dired-x) Omitting Variables' for more information."
 173   :group 'dired-x
 174   (if dired-omit-mode
 175       ;; This will mention how many lines were omitted:
 176       (let ((dired-omit-size-limit nil)) (dired-omit-expunge))
 177     (revert-buffer)))
 178
 179 ;; For backward compatibility
 180 (define-obsolete-variable-alias 'dired-omit-files-p 'dired-omit-mode "22.1")
 181
 182 (defcustom dired-omit-files "^\\.?#\\|^\\.$\\|^\\.\\.$"
 183   "Filenames matching this regexp will not be displayed.
 184 This only has effect when `dired-omit-mode' is t.  See interactive function
 185 `dired-omit-mode' \(\\[dired-omit-mode]\) and variable
 186 `dired-omit-extensions'.  The default is to omit  `.', `..', auto-save
 187 files and lock files."
 188   :type 'regexp
 189   :group 'dired-x)
 190
 191 (defcustom dired-omit-verbose t
 192   "When non-nil, show messages when omitting files.
 193 When nil, don't show messages."
 194   :type 'boolean
 195   :group 'dired-x)
 196
 197 (defcustom dired-find-subdir nil           ; t is pretty near to DWIM...
 198   "If non-nil, Dired always finds a directory in a buffer of its own.
 199 If nil, Dired finds the directory as a subdirectory in some other buffer
 200 if it is present as one.
 201
 202 If there are several dired buffers for a directory, the most recently
 203 used is chosen.
 204
 205 Dired avoids switching to the current buffer, so that if you have
 206 a normal and a wildcard buffer for the same directory, \\[dired] will
 207 toggle between those two."
 208   :type 'boolean
 209   :group 'dired-x)
 210
 211 (defcustom dired-omit-size-limit 30000
 212   "Maximum size for the \"omitting\" feature.
 213 If nil, there is no maximum size."
 214   :type '(choice (const :tag "no maximum" nil) integer)
 215   :group 'dired-x)
 216
 217 (defcustom dired-enable-local-variables t
 218   "Control use of local-variables lists in Dired.
 219 The value can be t, nil or something else.
 220 A value of t means local-variables lists are obeyed;
 221 nil means they are ignored; anything else means query.
 222
 223 This temporarily overrides the value of `enable-local-variables' when
 224 listing a directory.  See also `dired-local-variables-file'."
 225   :type 'boolean
 226   :group 'dired-x)
 227
 228 (defcustom dired-guess-shell-gnutar (when (or (eq system-type 'gnu)
 229                                               (eq system-type 'gnu/linux))
 230                                       "tar")
 231   "If non-nil, name of GNU tar executable.
 232 \(E.g., \"tar\" or \"gtar\").  The `z' switch will be used with it for
 233 compressed or gzip'ed tar files.  If you don't have GNU tar, set this
 234 to nil: a pipe using `zcat' or `gunzip -c' will be used."
 235   :type '(choice (const :tag "Not GNU tar" nil)
 236                  (string :tag "Command name"))
 237   :group 'dired-x)
 238
 239 (defcustom dired-guess-shell-gzip-quiet t
 240   "Non-nil says pass -q to gzip overriding verbose GZIP environment."
 241   :type 'boolean
 242   :group 'dired-x)
 243
 244 (defcustom dired-guess-shell-znew-switches nil
 245   "If non-nil, then string of switches passed to `znew', example: \"-K\"."
 246   :type '(choice (const :tag "None" nil)
 247                  (string :tag "Switches"))
 248   :group 'dired-x)
 249
 250 (defcustom dired-clean-up-buffers-too t
 251   "Non-nil means offer to kill buffers visiting files and dirs deleted in Dired."
 252   :type 'boolean
 253   :group 'dired-x)
 254
 255 ;;; KEY BINDINGS.
 256
 257 (define-key dired-mode-map "\M-o" 'dired-omit-mode)
 258 (define-key dired-mode-map "*O" 'dired-mark-omitted)
 259 (define-key dired-mode-map "\M-(" 'dired-mark-sexp)
 260 (define-key dired-mode-map "*(" 'dired-mark-sexp)
 261 (define-key dired-mode-map "*." 'dired-mark-extension)
 262 (define-key dired-mode-map "\M-!" 'dired-smart-shell-command)
 263 (define-key dired-mode-map "w" 'dired-copy-filename-as-kill)
 264 (define-key dired-mode-map "\M-G" 'dired-goto-subdir)
 265 (define-key dired-mode-map "F" 'dired-do-find-marked-files)
 266 (define-key dired-mode-map "Y"  'dired-do-relsymlink)
 267 (define-key dired-mode-map "%Y" 'dired-do-relsymlink-regexp)
 268 (define-key dired-mode-map "V" 'dired-do-run-mail)
 269
 270 (if dired-bind-man
 271     (define-key dired-mode-map "N" 'dired-man))
 272
 273 (if dired-bind-info
 274     (define-key dired-mode-map "I" 'dired-info))
 275
 276 ;;; MENU BINDINGS
 277
 278 (let ((menu-bar (lookup-key dired-mode-map [menu-bar])))
 279   (let ((menu (lookup-key menu-bar [operate])))
 280     (define-key-after
 281       menu
 282       [find-files]
 283       '(menu-item
 284         "Find files"
 285         dired-do-find-marked-files
 286         :help "Find current or marked files")
 287       'delete)
 288     (define-key-after
 289       menu
 290       [relsymlink]
 291       '(menu-item
 292         "Relative symlink to..."
 293         dired-do-relsymlink
 294         :visible (fboundp 'make-symbolic-link)
 295         :help "Make relative symbolic links for current or marked files")
 296       'symlink))
 297   (let ((menu (lookup-key menu-bar [mark])))
 298     (define-key-after
 299       menu
 300       [flag-extension]
 301       '(menu-item
 302         "Flag extension..."
 303         dired-flag-extension
 304         :help "Flag files with a certain extension for deletion")
 305       'garbage-files)
 306     (define-key-after
 307       menu
 308       [mark-extension]
 309       '(menu-item
 310         "Mark extension..."
 311         dired-mark-extension
 312         :help "Mark files with a certain extension")
 313       'symlinks)
 314     (define-key-after
 315       menu
 316       [mark-omitted]
 317       '(menu-item
 318         "Mark omitted"
 319         dired-mark-omitted
 320         :help "Mark files matching `dired-omit-files' and `dired-omit-extensions'")
 321       'mark-extension))
 322   (let ((menu (lookup-key menu-bar [regexp])))
 323     (define-key-after
 324       menu
 325       [relsymlink-regexp]
 326       '(menu-item
 327         "Relative symlink..."
 328         dired-do-relsymlink-regexp
 329         :visible (fboundp 'make-symbolic-link)
 330         :help "Make relative symbolic links for files matching regexp")
 331       'symlink))
 332   (let ((menu (lookup-key menu-bar [immediate])))
 333     (define-key-after
 334       menu
 335       [omit-mode]
 336       '(menu-item
 337         "Omit mode" dired-omit-mode
 338         :button (:toggle . dired-omit-mode)
 339         :help "Enable or disable omitting \"uninteresting\" files")
 340       'dashes)))
 341
 342 ;;; GLOBAL BINDING.
 343 (if dired-bind-jump
 344     (progn
 345       (define-key global-map "\C-x\C-j" 'dired-jump)
 346       (define-key global-map "\C-x4\C-j" 'dired-jump-other-window)))
 347
 348 \f
 349 ;; Install into appropriate hooks.
 350
 351 (add-hook 'dired-mode-hook 'dired-extra-startup)
 352 (add-hook 'dired-after-readin-hook 'dired-omit-expunge)
 353
 354 (defun dired-extra-startup ()
 355   "Automatically put on `dired-mode-hook' to get extra Dired features:
 356 \\<dired-mode-map>
 357   \\[dired-do-run-mail]\t-- run mail on folder (see `dired-bind-vm')
 358   \\[dired-info]\t-- run info on file
 359   \\[dired-man]\t-- run man on file
 360   \\[dired-do-find-marked-files]\t-- visit all marked files simultaneously
 361   \\[dired-omit-mode]\t-- toggle omitting of files
 362   \\[dired-mark-sexp]\t-- mark by Lisp expression
 363   \\[dired-copy-filename-as-kill]\t-- copy the file or subdir names into the kill ring;
 364   \t   you can feed it to other commands using \\[yank]
 365
 366 For more features, see variables
 367
 368   `dired-bind-vm'
 369   `dired-bind-jump'
 370   `dired-bind-info'
 371   `dired-bind-man'
 372   `dired-vm-read-only-folders'
 373   `dired-omit-mode'
 374   `dired-omit-files'
 375   `dired-omit-extensions'
 376   `dired-omit-size-limit'
 377   `dired-find-subdir'
 378   `dired-enable-local-variables'
 379   `dired-local-variables-file'
 380   `dired-guess-shell-gnutar'
 381   `dired-guess-shell-gzip-quiet'
 382   `dired-guess-shell-znew-switches'
 383   `dired-guess-shell-alist-user'
 384   `dired-clean-up-buffers-too'
 385
 386 See also functions
 387
 388   `dired-flag-extension'
 389   `dired-virtual'
 390   `dired-jump'
 391   `dired-man'
 392   `dired-vm'
 393   `dired-rmail'
 394   `dired-info'
 395   `dired-do-find-marked-files'"
 396   (interactive)
 397
 398   ;; These must be done in each new dired buffer.
 399   (dired-hack-local-variables)
 400   (dired-omit-startup))
 401
 402 \f
 403 ;;; BUFFER CLEANING.
 404
 405 ;; REDEFINE.
 406 (defun dired-clean-up-after-deletion (fn)
 407   "Clean up after a deleted file or directory FN.
 408 Remove expanded subdir of deleted dir, if any."
 409   (save-excursion (and (cdr dired-subdir-alist)
 410                        (dired-goto-subdir fn)
 411                        (dired-kill-subdir)))
 412
 413   ;; Offer to kill buffer of deleted file FN.
 414   (if dired-clean-up-buffers-too
 415       (progn
 416         (let ((buf (get-file-buffer fn)))
 417           (and buf
 418                (funcall (function y-or-n-p)
 419                         (format "Kill buffer of %s, too? "
 420                                 (file-name-nondirectory fn)))
 421                (save-excursion ; you never know where kill-buffer leaves you
 422                  (kill-buffer buf))))
 423         (let ((buf-list (dired-buffers-for-dir (expand-file-name fn)))
 424               (buf nil))
 425           (and buf-list
 426                (y-or-n-p (format "Kill dired buffer%s of %s, too? "
 427                                  (dired-plural-s (length buf-list))
 428                                  (file-name-nondirectory fn)))
 429                (while buf-list
 430                  (save-excursion (kill-buffer (car buf-list)))
 431                  (setq buf-list (cdr buf-list)))))))
 432   ;; Anything else?
 433   )
 434
 435 \f
 436 ;;; EXTENSION MARKING FUNCTIONS.
 437
 438 ;; Mark files with some extension.
 439 (defun dired-mark-extension (extension &optional marker-char)
 440   "Mark all files with a certain EXTENSION for use in later commands.
 441 A `.' is *not* automatically prepended to the string entered."
 442   ;; EXTENSION may also be a list of extensions instead of a single one.
 443   ;; Optional MARKER-CHAR is marker to use.
 444   (interactive "sMarking extension: \nP")
 445   (or (listp extension)
 446       (setq extension (list extension)))
 447   (dired-mark-files-regexp
 448    (concat ".";; don't match names with nothing but an extension
 449            "\\("
 450            (mapconcat 'regexp-quote extension "\\|")
 451            "\\)$")
 452    marker-char))
 453
 454 (defun dired-flag-extension (extension)
 455   "In dired, flag all files with a certain EXTENSION for deletion.
 456 A `.' is *not* automatically prepended to the string entered."
 457   (interactive "sFlagging extension: ")
 458   (dired-mark-extension extension dired-del-marker))
 459
 460 ;; Define some unpopular file extensions.  Used for cleaning and omitting.
 461
 462 (defvar dired-patch-unclean-extensions
 463   '(".rej" ".orig")
 464   "List of extensions of dispensable files created by the `patch' program.")
 465
 466 (defvar dired-tex-unclean-extensions
 467   '(".toc" ".log" ".aux");; these are already in completion-ignored-extensions
 468   "List of extensions of dispensable files created by TeX.")
 469
 470 (defvar dired-latex-unclean-extensions
 471   '(".idx" ".lof" ".lot" ".glo")
 472   "List of extensions of dispensable files created by LaTeX.")
 473
 474 (defvar dired-bibtex-unclean-extensions
 475   '(".blg" ".bbl")
 476   "List of extensions of dispensable files created by BibTeX.")
 477
 478 (defvar dired-texinfo-unclean-extensions
 479   '(".cp" ".cps" ".fn" ".fns" ".ky" ".kys" ".pg" ".pgs"
 480     ".tp" ".tps" ".vr" ".vrs")
 481   "List of extensions of dispensable files created by texinfo.")
 482
 483 (defun dired-clean-patch ()
 484   "Flag dispensable files created by patch for deletion.
 485 See variable `dired-patch-unclean-extensions'."
 486   (interactive)
 487   (dired-flag-extension dired-patch-unclean-extensions))
 488
 489 (defun dired-clean-tex ()
 490   "Flag dispensable files created by [La]TeX etc. for deletion.
 491 See variables `dired-tex-unclean-extensions',
 492 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions' and
 493 `dired-texinfo-unclean-extensions'."
 494   (interactive)
 495   (dired-flag-extension (append dired-texinfo-unclean-extensions
 496                                 dired-latex-unclean-extensions
 497                                 dired-bibtex-unclean-extensions
 498                                 dired-tex-unclean-extensions)))
 499
 500 (defun dired-very-clean-tex ()
 501   "Flag dispensable files created by [La]TeX *and* \".dvi\" for deletion.
 502 See variables `dired-texinfo-unclean-extensions',
 503 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions' and
 504 `dired-texinfo-unclean-extensions'."
 505   (interactive)
 506   (dired-flag-extension (append dired-texinfo-unclean-extensions
 507                                 dired-latex-unclean-extensions
 508                                 dired-bibtex-unclean-extensions
 509                                 dired-tex-unclean-extensions
 510                                 (list ".dvi"))))
 511 \f
 512 ;;; JUMP.
 513
 514 ;;;###autoload
 515 (defun dired-jump (&optional other-window file-name)
 516   "Jump to dired buffer corresponding to current buffer.
 517 If in a file, dired the current directory and move to file's line.
 518 If in Dired already, pop up a level and goto old directory's line.
 519 In case the proper dired file line cannot be found, refresh the dired
 520 buffer and try again.
 521 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
 522 Interactively with prefix argument, read FILE-NAME and
 523 move to its line in dired."
 524   (interactive
 525    (list nil (and current-prefix-arg
 526                   (read-file-name "Jump to dired file: "))))
 527   (let* ((file (or file-name buffer-file-name))
 528          (dir (if file (file-name-directory file) default-directory)))
 529     (if (and (eq major-mode 'dired-mode) (null file-name))
 530         (progn
 531           (setq dir (dired-current-directory))
 532           (dired-up-directory other-window)
 533           (or (dired-goto-file dir)
 534               ;; refresh and try again
 535               (progn
 536                 (dired-insert-subdir (file-name-directory dir))
 537                 (dired-goto-file dir))))
 538       (if other-window
 539           (dired-other-window dir)
 540         (dired dir))
 541       (if file
 542           (or (dired-goto-file file)
 543               ;; refresh and try again
 544               (progn
 545                 (dired-insert-subdir (file-name-directory file))
 546                 (dired-goto-file file))
 547               ;; Toggle omitting, if it is on, and try again.
 548               (if dired-omit-mode
 549                   (progn
 550                     (dired-omit-mode)
 551                     (dired-goto-file file))))))))
 552
 553 (defun dired-jump-other-window (&optional file-name)
 554   "Like \\[dired-jump] (`dired-jump') but in other window."
 555   (interactive
 556    (list (and current-prefix-arg
 557               (read-file-name "Jump to dired file: "))))
 558   (dired-jump t file-name))
 559 \f
 560 ;;; OMITTING.
 561
 562 ;; Enhanced omitting of lines from directory listings.
 563 ;; Marked files are never omitted.
 564
 565 ;; should probably get rid of this and always use 'no-dir.
 566 ;; sk 28-Aug-1991 09:37
 567 (defvar dired-omit-localp 'no-dir
 568   "The LOCALP argument `dired-omit-expunge' passes to `dired-get-filename'.
 569 If it is `no-dir', omitting is much faster, but you can only match
 570 against the non-directory part of the file name.  Set it to nil if you
 571 need to match the entire file name.")
 572
 573 ;; \017=^O for Omit - other packages can chose other control characters.
 574 (defvar dired-omit-marker-char ?\017
 575   "Temporary marker used by Dired-Omit.
 576 Should never be used as marker by the user or other packages.")
 577
 578 (defun dired-omit-startup ()
 579   (or (assq 'dired-omit-mode minor-mode-alist)
 580       (setq minor-mode-alist
 581             (append '((dired-omit-mode
 582                        (:eval (if (eq major-mode 'dired-mode)
 583                                   " Omit" ""))))
 584                     minor-mode-alist))))
 585
 586 (defun dired-mark-omitted ()
 587   "Mark files matching `dired-omit-files' and `dired-omit-extensions'."
 588   (interactive)
 589   (let ((dired-omit-mode nil)) (revert-buffer)) ;; Show omitted files
 590   (dired-mark-unmarked-files (dired-omit-regexp) nil nil dired-omit-localp))
 591
 592 (defvar dired-omit-extensions
 593   (append completion-ignored-extensions
 594           dired-latex-unclean-extensions
 595           dired-bibtex-unclean-extensions
 596           dired-texinfo-unclean-extensions)
 597   "If non-nil, a list of extensions \(strings\) to omit from Dired listings.
 598 Defaults to elements of `completion-ignored-extensions',
 599 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions', and
 600 `dired-texinfo-unclean-extensions'.
 601
 602 See interactive function `dired-omit-mode' \(\\[dired-omit-mode]\) and
 603 variables `dired-omit-mode' and `dired-omit-files'.")
 604
 605 (defun dired-omit-expunge (&optional regexp)
 606   "Erases all unmarked files matching REGEXP.
 607 Does nothing if global variable `dired-omit-mode' is nil, or if called
 608   non-interactively and buffer is bigger than `dired-omit-size-limit'.
 609 If REGEXP is nil or not specified, uses `dired-omit-files', and also omits
 610   filenames ending in `dired-omit-extensions'.
 611 If REGEXP is the empty string, this function is a no-op.
 612
 613 This functions works by temporarily binding `dired-marker-char' to
 614 `dired-omit-marker-char' and calling `dired-do-kill-lines'."
 615   (interactive "sOmit files (regexp): ")
 616   (if (and dired-omit-mode
 617            (or (called-interactively-p 'interactive)
 618                (not dired-omit-size-limit)
 619                (< (buffer-size) dired-omit-size-limit)
 620                (progn
 621                  (when dired-omit-verbose
 622                    (message "Not omitting: directory larger than %d characters."
 623                             dired-omit-size-limit))
 624                  (setq dired-omit-mode nil)
 625                  nil)))
 626       (let ((omit-re (or regexp (dired-omit-regexp)))
 627             (old-modified-p (buffer-modified-p))
 628             count)
 629         (or (string= omit-re "")
 630             (let ((dired-marker-char dired-omit-marker-char))
 631               (when dired-omit-verbose (message "Omitting..."))
 632               (if (dired-mark-unmarked-files omit-re nil nil dired-omit-localp)
 633                   (progn
 634                     (setq count (dired-do-kill-lines
 635                                  nil
 636                                  (if dired-omit-verbose "Omitted %d line%s." "")))
 637                     (force-mode-line-update))
 638                 (when dired-omit-verbose (message "(Nothing to omit)")))))
 639         ;; Try to preserve modified state of buffer.  So `%*' doesn't appear
 640         ;; in mode-line of omitted buffers.
 641         (set-buffer-modified-p (and old-modified-p
 642                                     (save-excursion
 643                                       (goto-char (point-min))
 644                                       (re-search-forward dired-re-mark nil t))))
 645         count)))
 646
 647 (defun dired-omit-regexp ()
 648   (concat (if dired-omit-files (concat "\\(" dired-omit-files "\\)") "")
 649           (if (and dired-omit-files dired-omit-extensions) "\\|" "")
 650           (if dired-omit-extensions
 651               (concat ".";; a non-extension part should exist
 652                       "\\("
 653                       (mapconcat 'regexp-quote dired-omit-extensions "\\|")
 654                       "\\)$")
 655             "")))
 656
 657 ;; Returns t if any work was done, nil otherwise.
 658 (defun dired-mark-unmarked-files (regexp msg &optional unflag-p localp)
 659   "Mark unmarked files matching REGEXP, displaying MSG.
 660 REGEXP is matched against the entire file name.
 661 Does not re-mark files which already have a mark.
 662 With prefix argument, unflag all those files.
 663 Optional fourth argument LOCALP is as in `dired-get-filename'."
 664   (interactive "P")
 665   (let ((dired-marker-char (if unflag-p ?\s dired-marker-char)))
 666     (dired-mark-if
 667      (and
 668       ;; not already marked
 669       (looking-at " ")
 670       ;; uninteresting
 671       (let ((fn (dired-get-filename localp t)))
 672         (and fn (string-match regexp fn))))
 673      msg)))
 674
 675 ;; Compiler does not get fset.
 676 (declare-function dired-omit-old-add-entry "dired-x")
 677
 678 ;; REDEFINE.
 679 ;; Redefine dired-aux.el's version of `dired-add-entry'
 680 ;; Save old defun if not already done:
 681 (or (fboundp 'dired-omit-old-add-entry)
 682     (fset 'dired-omit-old-add-entry (symbol-function 'dired-add-entry)))
 683
 684 ;; REDEFINE.
 685 (defun dired-omit-new-add-entry (filename &optional marker-char relative)
 686   ;; This redefines dired-aux.el's dired-add-entry to avoid calling ls for
 687   ;; files that are going to be omitted anyway.
 688   (if dired-omit-mode
 689       ;; perhaps return t without calling ls
 690       (let ((omit-re (dired-omit-regexp)))
 691         (if (or (string= omit-re "")
 692                 (not
 693                  (string-match omit-re
 694                                (cond
 695                                 ((eq 'no-dir dired-omit-localp)
 696                                  filename)
 697                                 ((eq t dired-omit-localp)
 698                                  (dired-make-relative filename))
 699                                 (t
 700                                  (dired-make-absolute
 701                                   filename
 702                                   (file-name-directory filename)))))))
 703             ;; if it didn't match, go ahead and add the entry
 704             (dired-omit-old-add-entry filename marker-char relative)
 705           ;; dired-add-entry returns t for success, perhaps we should
 706           ;; return file-exists-p
 707           t))
 708     ;; omitting is not turned on at all
 709     (dired-omit-old-add-entry filename marker-char relative)))
 710
 711 ;; Redefine it.
 712 (fset 'dired-add-entry 'dired-omit-new-add-entry)
 713
 714 \f
 715 ;;; VIRTUAL DIRED MODE.
 716
 717 ;; For browsing `ls -lR' listings in a dired-like fashion.
 718
 719 (defalias 'virtual-dired 'dired-virtual)
 720 (defun dired-virtual (dirname &optional switches)
 721   "Put this buffer into Virtual Dired mode.
 722
 723 In Virtual Dired mode, all commands that do not actually consult the
 724 filesystem will work.
 725
 726 This is useful if you want to peruse and move around in an ls -lR
 727 output file, for example one you got from an ftp server.  With
 728 ange-ftp, you can even dired a directory containing an ls-lR file,
 729 visit that file and turn on virtual dired mode.  But don't try to save
 730 this file, as dired-virtual indents the listing and thus changes the
 731 buffer.
 732
 733 If you have save a Dired buffer in a file you can use \\[dired-virtual] to
 734 resume it in a later session.
 735
 736 Type \\<dired-mode-map>\\[revert-buffer] \
 737 in the Virtual Dired buffer and answer `y' to convert
 738 the virtual to a real dired buffer again.  You don't have to do this, though:
 739 you can relist single subdirs using \\[dired-do-redisplay]."
 740
 741   ;; DIRNAME is the top level directory of the buffer.  It will become
 742   ;; its `default-directory'.  If nil, the old value of
 743   ;; default-directory is used.
 744
 745   ;; Optional SWITCHES are the ls switches to use.
 746
 747   ;; Shell wildcards will be used if there already is a `wildcard'
 748   ;; line in the buffer (thus it is a saved Dired buffer), but there
 749   ;; is no other way to get wildcards.  Insert a `wildcard' line by
 750   ;; hand if you want them.
 751
 752   (interactive
 753    (list (read-string "Virtual Dired directory: " (dired-virtual-guess-dir))))
 754   (goto-char (point-min))
 755   (or (looking-at "  ")
 756       ;; if not already indented, do it now:
 757       (indent-region (point-min) (point-max) 2))
 758   (or dirname (setq dirname default-directory))
 759   (setq dirname (expand-file-name (file-name-as-directory dirname)))
 760   (setq default-directory dirname)      ; contains no wildcards
 761   (let ((wildcard (save-excursion
 762                     (goto-char (point-min))
 763                     (forward-line 1)
 764                     (and (looking-at "^  wildcard ")
 765                          (buffer-substring (match-end 0)
 766                                            (progn (end-of-line) (point)))))))
 767   (if wildcard
 768         (setq dirname (expand-file-name wildcard default-directory))))
 769   ;; If raw ls listing (not a saved old dired buffer), give it a
 770   ;; decent subdir headerline:
 771   (goto-char (point-min))
 772   (or (looking-at dired-subdir-regexp)
 773       (insert "  "
 774               (directory-file-name (file-name-directory default-directory))
 775               ":\n"))
 776   (dired-mode dirname (or switches dired-listing-switches))
 777   (setq mode-name "Virtual Dired"
 778         revert-buffer-function 'dired-virtual-revert)
 779   (set (make-local-variable 'dired-subdir-alist) nil)
 780   (dired-build-subdir-alist)
 781   (goto-char (point-min))
 782   (dired-initial-position dirname))
 783
 784 (defun dired-virtual-guess-dir ()
 785   "Guess and return appropriate working directory of this buffer.
 786 The buffer is assumed to be in Dired or ls -lR format.  The guess is
 787 based upon buffer contents.  If nothing could be guessed, returns
 788 nil."
 789
 790   (let ((regexp "^\\(  \\)?\\([^ \n\r]*\\)\\(:\\)[\n\r]")
 791         (subexpr 2))
 792     (goto-char (point-min))
 793     (cond ((looking-at regexp)
 794            ;; If a saved dired buffer, look to which dir and
 795            ;; perhaps wildcard it belongs:
 796            (let ((dir (buffer-substring (match-beginning subexpr)
 797                                         (match-end subexpr))))
 798              (file-name-as-directory dir)))
 799           ;; Else no match for headerline found.  It's a raw ls listing.
 800           ;; In raw ls listings the directory does not have a headerline
 801           ;; try parent of first subdir, if any
 802           ((re-search-forward regexp nil t)
 803            (file-name-directory
 804             (directory-file-name
 805              (file-name-as-directory
 806               (buffer-substring (match-beginning subexpr)
 807                                 (match-end subexpr))))))
 808           (t                            ; if all else fails
 809            nil))))
 810
 811
 812 (defun dired-virtual-revert (&optional arg noconfirm)
 813   (if (not
 814        (y-or-n-p "Cannot revert a Virtual Dired buffer - switch to Real Dired mode? "))
 815       (error "Cannot revert a Virtual Dired buffer")
 816     (setq mode-name "Dired"
 817           revert-buffer-function 'dired-revert)
 818     (revert-buffer)))
 819
 820 ;; A zero-arg version of dired-virtual.
 821 (defun dired-virtual-mode ()
 822   "Put current buffer into Virtual Dired mode (see `dired-virtual').
 823 Useful on `magic-mode-alist' with the regexp
 824
 825   \"^  \\\\(/[^ /]+\\\\)+/?:$\"
 826
 827 to put saved dired buffers automatically into Virtual Dired mode.
 828
 829 Also useful for `auto-mode-alist' like this:
 830
 831   (add-to-list 'auto-mode-alist
 832                '(\"[^/]\\\\.dired\\\\'\" . dired-virtual-mode))"
 833   (interactive)
 834   (dired-virtual (dired-virtual-guess-dir)))
 835
 836 \f
 837 ;;; SMART SHELL.
 838
 839 ;; An Emacs buffer can have but one working directory, stored in the
 840 ;; buffer-local variable `default-directory'.  A Dired buffer may have
 841 ;; several subdirectories inserted, but still has but one working directory:
 842 ;; that of the top level Dired directory in that buffer.  For some commands
 843 ;; it is appropriate that they use the current Dired directory instead of
 844 ;; `default-directory', e.g., `find-file' and `compile'.  This is a general
 845 ;; mechanism is provided for special handling of the working directory in
 846 ;; special major modes.
 847
 848 ;; It's easier to add to this alist than redefine function
 849 ;; default-directory while keeping the old information.
 850 (defconst default-directory-alist
 851   '((dired-mode . (if (fboundp 'dired-current-directory)
 852                       (dired-current-directory)
 853                     default-directory)))
 854   "Alist of major modes and their opinion on `default-directory'.
 855 This is given as a Lisp expression to evaluate.  A resulting value of
 856 nil is ignored in favor of `default-directory'.")
 857
 858 (defun dired-default-directory ()
 859   "Usage like variable `default-directory'.
 860 Knows about the special cases in variable `default-directory-alist'."
 861   (or (eval (cdr (assq major-mode default-directory-alist)))
 862       default-directory))
 863
 864 (defun dired-smart-shell-command (command &optional output-buffer error-buffer)
 865   "Like function `shell-command', but in the current Virtual Dired directory."
 866   (interactive
 867    (list
 868     (read-shell-command "Shell command: " nil nil
 869                         (cond
 870                          (buffer-file-name (file-relative-name buffer-file-name))
 871                          ((eq major-mode 'dired-mode) (dired-get-filename t t))))
 872     current-prefix-arg
 873     shell-command-default-error-buffer))
 874   (let ((default-directory (dired-default-directory)))
 875     (shell-command command output-buffer error-buffer)))
 876
 877 \f
 878 ;;; LOCAL VARIABLES FOR DIRED BUFFERS.
 879
 880 ;; Brief Description:
 881 ;;;
 882 ;; * `dired-extra-startup' is part of the `dired-mode-hook'.
 883 ;;;
 884 ;; * `dired-extra-startup' calls `dired-hack-local-variables'
 885 ;;;
 886 ;; * `dired-hack-local-variables' checks the value of
 887 ;;;   `dired-local-variables-file'
 888 ;;;
 889 ;; * Check if `dired-local-variables-file' is a non-nil string and is a
 890 ;;;   filename found in the directory of the Dired Buffer being created.
 891 ;;;
 892 ;; * If `dired-local-variables-file' satisfies the above, then temporarily
 893 ;;;   include it in the Dired Buffer at the bottom.
 894 ;;;
 895 ;; * Set `enable-local-variables' temporarily to the user variable
 896 ;;;   `dired-enable-local-variables' and run `hack-local-variables' on the
 897 ;;;   Dired Buffer.
 898
 899 (defvar dired-local-variables-file (convert-standard-filename ".dired")
 900   "Filename, as string, containing local dired buffer variables to be hacked.
 901 If this file found in current directory, then it will be inserted into dired
 902 buffer and `hack-local-variables' will be run.  See Info node
 903 `(emacs)File Variables' for more information on local variables.
 904 See also `dired-enable-local-variables'.")
 905
 906 (defun dired-hack-local-variables ()
 907   "Evaluate local variables in `dired-local-variables-file' for dired buffer."
 908   (if (and dired-local-variables-file
 909            (stringp dired-local-variables-file)
 910            (file-exists-p dired-local-variables-file))
 911       (let ((opoint (point-max))
 912             buffer-read-only
 913             ;; In case user has `enable-local-variables' set to nil we
 914             ;; override it locally with dired's variable.
 915             (enable-local-variables dired-enable-local-variables))
 916         ;; Insert 'em.
 917         (save-excursion
 918           (goto-char opoint)
 919           (insert "\^L\n")
 920           (insert-file-contents dired-local-variables-file))
 921         ;; Hack 'em.
 922         (let ((buffer-file-name dired-local-variables-file))
 923           (hack-local-variables))
 924         ;; Make sure that the modeline shows the proper information.
 925         (dired-sort-set-modeline)
 926         ;; Delete this stuff: `eobp' is used to find last subdir by dired.el.
 927         (delete-region opoint (point-max)))))
 928
 929 (defun dired-omit-here-always ()
 930   "Create `dired-local-variables-file' for omitting and reverts directory.
 931 Sets `dired-omit-mode' to t in a local variables file that is readable by
 932 dired."
 933   (interactive)
 934   (if (file-exists-p dired-local-variables-file)
 935       (message "File `./%s' already exists." dired-local-variables-file)
 936
 937     ;; Create `dired-local-variables-file'.
 938     (with-current-buffer (get-buffer-create " *dot-dired*")
 939       (erase-buffer)
 940       (insert "Local Variables:\ndired-omit-mode: t\nEnd:\n")
 941       (write-file dired-local-variables-file)
 942       (kill-buffer (current-buffer)))
 943
 944     ;; Run extra-hooks and revert directory.
 945     (dired-extra-startup)
 946     (dired-revert)))
 947
 948 \f
 949 ;;; GUESS SHELL COMMAND.
 950
 951 ;; Brief Description:
 952 ;;;
 953 ;; `dired-do-shell-command' is bound to `!' by dired.el.
 954 ;;;
 955 ;; * Redefine `dired-read-shell-command' so it calls
 956 ;;;   `dired-guess-shell-command'.
 957 ;;;
 958 ;; * `dired-guess-shell-command' calls `dired-guess-default' with list of
 959 ;;;    marked files.
 960 ;;;
 961 ;; * Parse `dired-guess-shell-alist-user' and
 962 ;;;   `dired-guess-shell-alist-default' (in that order) for the first REGEXP
 963 ;;;   that matches the first file in the file list.
 964 ;;;
 965 ;; * If the REGEXP matches all the entries of the file list then evaluate
 966 ;;;   COMMAND, which is either a string or a Lisp expression returning a
 967 ;;;   string.  COMMAND may be a list of commands.
 968 ;;;
 969 ;; * Return this command to `dired-guess-shell-command' which prompts user
 970 ;;;   with it.  The list of commands is put into the list of default values.
 971 ;;;   If a command is used successfully then it is stored permanently in
 972 ;;;   `dired-shell-command-history'.
 973
 974 ;; Guess what shell command to apply to a file.
 975 (defvar dired-shell-command-history nil
 976   "History list for commands that read dired-shell commands.")
 977
 978 ;; Default list of shell commands.
 979
 980 ;; NOTE: Use `gunzip -c' instead of `zcat' on `.gz' files.  Some do not
 981 ;; install GNU zip's version of zcat.
 982
 983 (defvar dired-guess-shell-alist-default
 984   (list
 985    (list "\\.tar$"
 986          '(if dired-guess-shell-gnutar
 987               (concat dired-guess-shell-gnutar " xvf")
 988             "tar xvf")
 989          ;; Extract files into a separate subdirectory
 990          '(if dired-guess-shell-gnutar
 991               (concat "mkdir " (file-name-sans-extension file)
 992                       "; " dired-guess-shell-gnutar " -C "
 993                       (file-name-sans-extension file) " -xvf")
 994             (concat "mkdir " (file-name-sans-extension file)
 995                     "; tar -C " (file-name-sans-extension file) " -xvf"))
 996          ;; List archive contents.
 997          '(if dired-guess-shell-gnutar
 998               (concat dired-guess-shell-gnutar " tvf")
 999             "tar tvf"))
1000
1001    ;; REGEXPS for compressed archives must come before the .Z rule to
1002    ;; be recognized:
1003    (list "\\.tar\\.Z$"
1004          ;; Untar it.
1005          '(if dired-guess-shell-gnutar
1006               (concat dired-guess-shell-gnutar " zxvf")
1007             (concat "zcat * | tar xvf -"))
1008          ;; Optional conversion to gzip format.
1009          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1010                   " " dired-guess-shell-znew-switches))
1011
1012    ;; gzip'ed archives
1013    (list "\\.t\\(ar\\.\\)?gz$"
1014          '(if dired-guess-shell-gnutar
1015               (concat dired-guess-shell-gnutar " zxvf")
1016             (concat "gunzip -qc * | tar xvf -"))
1017          ;; Extract files into a separate subdirectory
1018          '(if dired-guess-shell-gnutar
1019               (concat "mkdir " (file-name-sans-extension file)
1020                       "; " dired-guess-shell-gnutar " -C "
1021                       (file-name-sans-extension file) " -zxvf")
1022             (concat "mkdir " (file-name-sans-extension file)
1023                     "; gunzip -qc * | tar -C "
1024                     (file-name-sans-extension file) " -xvf -"))
1025          ;; Optional decompression.
1026          '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q" ""))
1027          ;; List archive contents.
1028          '(if dired-guess-shell-gnutar
1029               (concat dired-guess-shell-gnutar " ztvf")
1030             (concat "gunzip -qc * | tar tvf -")))
1031
1032    ;; bzip2'ed archives
1033    (list "\\.t\\(ar\\.bz2\\|bz\\)$"
1034          "bunzip2 -c * | tar xvf -"
1035          ;; Extract files into a separate subdirectory
1036          '(concat "mkdir " (file-name-sans-extension file)
1037                   "; bunzip2 -c * | tar -C "
1038                   (file-name-sans-extension file) " -xvf -")
1039          ;; Optional decompression.
1040          "bunzip2")
1041
1042    ;; xz'ed archives
1043    (list "\\.t\\(ar\\.\\)?xz$"
1044          "unxz -c * | tar xvf -"
1045          ;; Extract files into a separate subdirectory
1046          '(concat "mkdir " (file-name-sans-extension file)
1047                   "; unxz -c * | tar -C "
1048                   (file-name-sans-extension file) " -xvf -")
1049          ;; Optional decompression.
1050          "unxz")
1051
1052    '("\\.shar\\.Z$" "zcat * | unshar")
1053    '("\\.shar\\.g?z$" "gunzip -qc * | unshar")
1054
1055    '("\\.e?ps$" "ghostview" "xloadimage" "lpr")
1056    (list "\\.e?ps\\.g?z$" "gunzip -qc * | ghostview -"
1057          ;; Optional decompression.
1058          '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1059    (list "\\.e?ps\\.Z$" "zcat * | ghostview -"
1060          ;; Optional conversion to gzip format.
1061          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1062                   " " dired-guess-shell-znew-switches))
1063
1064    '("\\.patch$" "cat * | patch")
1065    (list "\\.patch\\.g?z$" "gunzip -qc * | patch"
1066          ;; Optional decompression.
1067          '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1068    (list "\\.patch\\.Z$" "zcat * | patch"
1069          ;; Optional conversion to gzip format.
1070          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1071                   " " dired-guess-shell-znew-switches))
1072
1073    ;; The following four extensions are useful with dired-man ("N" key)
1074    (list "\\.\\(?:[0-9]\\|man\\)$" '(progn (require 'man)
1075                                            (if (Man-support-local-filenames)
1076                                                "man -l"
1077                                              "cat * | tbl | nroff -man -h")))
1078    (list "\\.\\(?:[0-9]\\|man\\)\\.g?z$" '(progn (require 'man)
1079                                                  (if (Man-support-local-filenames)
1080                                                      "man -l"
1081                                                    "gunzip -qc * | tbl | nroff -man -h"))
1082          ;; Optional decompression.
1083          '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1084    (list "\\.[0-9]\\.Z$" '(progn (require 'man)
1085                                  (if (Man-support-local-filenames)
1086                                      "man -l"
1087                                    "zcat * | tbl | nroff -man -h"))
1088          ;; Optional conversion to gzip format.
1089          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1090                   " " dired-guess-shell-znew-switches))
1091    '("\\.pod$" "perldoc" "pod2man * | nroff -man")
1092
1093    '("\\.dvi$" "xdvi" "dvips")          ; preview and printing
1094    '("\\.au$" "play")                   ; play Sun audiofiles
1095    '("\\.mpe?g$\\|\\.avi$" "xine -p")
1096    '("\\.ogg$" "ogg123")
1097    '("\\.mp3$" "mpg123")
1098    '("\\.wav$" "play")
1099    '("\\.uu$" "uudecode")               ; for uudecoded files
1100    '("\\.hqx$" "mcvert")
1101    '("\\.sh$" "sh")                     ; execute shell scripts
1102    '("\\.xbm$" "bitmap")                ; view X11 bitmaps
1103    '("\\.gp$" "gnuplot")
1104    '("\\.p[bgpn]m$" "xloadimage")
1105    '("\\.gif$" "xloadimage")            ; view gif pictures
1106    '("\\.tif$" "xloadimage")
1107    '("\\.png$" "display")               ; xloadimage 4.1 doesn't grok PNG
1108    '("\\.jpe?g$" "xloadimage")
1109    '("\\.fig$" "xfig")                  ; edit fig pictures
1110    '("\\.out$" "xgraph")                ; for plotting purposes.
1111    '("\\.tex$" "latex" "tex")
1112    '("\\.texi\\(nfo\\)?$" "makeinfo" "texi2dvi")
1113    '("\\.pdf$" "xpdf")
1114    '("\\.doc$" "antiword" "strings")
1115    '("\\.rpm$" "rpm -qilp" "rpm -ivh")
1116    '("\\.dia$" "dia")
1117    '("\\.mgp$" "mgp")
1118
1119    ;; Some other popular archivers.
1120    (list "\\.zip$" "unzip" "unzip -l"
1121          ;; Extract files into a separate subdirectory
1122          '(concat "unzip" (if dired-guess-shell-gzip-quiet " -q")
1123                   " -d " (file-name-sans-extension file)))
1124    '("\\.zoo$" "zoo x//")
1125    '("\\.lzh$" "lharc x")
1126    '("\\.arc$" "arc x")
1127    '("\\.shar$" "unshar")
1128
1129    ;; Compression.
1130    (list "\\.g?z$" '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1131    (list "\\.dz$" "dictunzip")
1132    (list "\\.bz2$" "bunzip2")
1133    (list "\\.xz$" "unxz")
1134    (list "\\.Z$" "uncompress"
1135          ;; Optional conversion to gzip format.
1136          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1137                   " " dired-guess-shell-znew-switches))
1138
1139    '("\\.sign?$" "gpg --verify"))
1140
1141   "Default alist used for shell command guessing.
1142 See `dired-guess-shell-alist-user'.")
1143
1144 (defcustom dired-guess-shell-alist-user nil
1145   "User-defined alist of rules for suggested commands.
1146 These rules take precedence over the predefined rules in the variable
1147 `dired-guess-shell-alist-default' (to which they are prepended).
1148
1149 Each element of this list looks like
1150
1151     \(REGEXP COMMAND...\)
1152
1153 where each COMMAND can either be a string or a Lisp expression that evaluates
1154 to a string.  If several COMMANDs are given, the first one will be the default
1155 and the rest will be added temporarily to the history and can be retrieved
1156 with \\[previous-history-element] (M-p) .
1157
1158 The variable `dired-guess-shell-case-fold-search' controls whether
1159 REGEXP is matched case-sensitively.
1160
1161 You can set this variable in your ~/.emacs.  For example, to add rules for
1162 `.foo' and `.bar' files, write
1163
1164  \(setq dired-guess-shell-alist-user
1165        (list (list \"\\\\.foo\\\\'\" \"FOO-COMMAND\");; fixed rule
1166               ;; possibly more rules ...
1167               (list \"\\\\.bar\\\\'\";; rule with condition test
1168                     '(if condition
1169                           \"BAR-COMMAND-1\"
1170                         \"BAR-COMMAND-2\")))\)"
1171   :group 'dired-x
1172   :type '(alist :key-type regexp :value-type (repeat sexp)))
1173
1174 (defcustom dired-guess-shell-case-fold-search t
1175   "If non-nil, `dired-guess-shell-alist-default' and
1176 `dired-guess-shell-alist-user' are matched case-insensitively."
1177   :group 'dired-x
1178   :type 'boolean)
1179
1180 (defun dired-guess-default (files)
1181   "Guess a shell commands for FILES.  Return command or list of commands.
1182 See `dired-guess-shell-alist-user'."
1183
1184   (let* ((case-fold-search dired-guess-shell-case-fold-search)
1185          ;; Prepend the user's alist to the default alist.
1186          (alist (append dired-guess-shell-alist-user
1187                         dired-guess-shell-alist-default))
1188          (file (car files))
1189          (flist (cdr files))
1190          elt regexp cmds)
1191
1192     ;; Find the first match in the alist for first file in FILES.
1193     (while alist
1194       (setq elt (car alist)
1195             regexp (car elt)
1196             alist (cdr alist))
1197       (if (string-match regexp file)
1198           (setq cmds (cdr elt)
1199                 alist nil)))
1200
1201     ;; If more than one file, see if all of FILES match regular expression.
1202     (while (and flist
1203                 (string-match regexp (car flist)))
1204       (setq flist (cdr flist)))
1205
1206     ;; If flist is still non-nil, then do not guess since this means that not
1207     ;; all the files in FILES were matched by the regexp.
1208     (setq cmds (and (not flist) cmds))
1209
1210     ;; Return commands or nil if flist is still non-nil.
1211     ;; Evaluate the commands in order that any logical testing will be done.
1212     (cond ((not (cdr cmds))
1213            (eval (car cmds))) ; single command
1214           (t
1215            (mapcar (function eval) cmds)))))
1216
1217 (defun dired-guess-shell-command (prompt files)
1218   "Ask user with PROMPT for a shell command, guessing a default from FILES."
1219   (let ((default (dired-guess-default files))
1220         default-list val)
1221     (if (null default)
1222         ;; Nothing to guess
1223         (read-shell-command prompt nil 'dired-shell-command-history)
1224       (if (listp default)
1225           ;; More than one guess
1226           (setq default-list default
1227                 default (car default)
1228                 prompt (concat
1229                         prompt
1230                         (format "{%d guesses} " (length default-list))))
1231         ;; Just one guess
1232         (setq default-list (list default)))
1233       ;; Put the first guess in the prompt but not in the initial value.
1234       (setq prompt (concat prompt (format "[%s] " default)))
1235       ;; All guesses can be retrieved with M-n
1236       (setq val (read-shell-command prompt nil
1237                                     'dired-shell-command-history
1238                                     default-list))
1239       ;; If we got a return, then return default.
1240       (if (equal val "") default val))))
1241
1242 ;; REDEFINE.
1243 ;; Redefine dired-aux.el's version:
1244 (defun dired-read-shell-command (prompt arg files)
1245   "Read a dired shell command prompting with PROMPT (using `read-shell-command').
1246 ARG is the prefix arg and may be used to indicate in the prompt which
1247 FILES are affected.
1248 This is an extra function so that you can redefine it."
1249   (minibuffer-with-setup-hook
1250       (lambda ()
1251         (set (make-local-variable 'minibuffer-default-add-function)
1252              'minibuffer-default-add-dired-shell-commands))
1253     (dired-mark-pop-up
1254      nil 'shell files
1255      'dired-guess-shell-command
1256      (format prompt (dired-mark-prompt arg files)) ; PROMPT
1257      files)))                                      ; FILES
1258
1259 \f
1260 ;;; RELATIVE SYMBOLIC LINKS.
1261
1262 (declare-function make-symbolic-link "fileio.c")
1263
1264 (defvar dired-keep-marker-relsymlink ?S
1265   "See variable `dired-keep-marker-move'.")
1266
1267 (defun dired-make-relative-symlink (file1 file2 &optional ok-if-already-exists)
1268   "Make a symbolic link (pointing to FILE1) in FILE2.
1269 The link is relative (if possible), for example
1270
1271     \"/vol/tex/bin/foo\" \"/vol/local/bin/foo\"
1272
1273 results in
1274
1275     \"../../tex/bin/foo\" \"/vol/local/bin/foo\""
1276   (interactive "FRelSymLink: \nFRelSymLink %s: \np")
1277   (let (name1 name2 len1 len2 (index 0) sub)
1278     (setq file1 (expand-file-name file1)
1279           file2 (expand-file-name file2)
1280           len1 (length file1)
1281           len2 (length file2))
1282     ;; Find common initial file name components:
1283     (let (next)
1284       (while (and (setq next (string-match "/" file1 index))
1285                   (setq next (1+ next))
1286                   (< next (min len1 len2))
1287                   ;; For the comparison, both substrings must end in
1288                   ;; `/', so NEXT is *one plus* the result of the
1289                   ;; string-match.
1290                   ;; E.g., consider the case of linking "/tmp/a/abc"
1291                   ;; to "/tmp/abc" erroneously giving "/tmp/a" instead
1292                   ;; of "/tmp/" as common initial component
1293                   (string-equal (substring file1 0 next)
1294                                 (substring file2 0 next)))
1295         (setq index next))
1296       (setq name2 file2
1297             sub (substring file1 0 index)
1298             name1 (substring file1 index)))
1299     (if (string-equal sub "/")
1300         ;; No common initial file name found
1301         (setq name1 file1)
1302       ;; Else they have a common parent directory
1303       (let ((tem (substring file2 index))
1304             (start 0)
1305             (count 0))
1306         ;; Count number of slashes we must compensate for ...
1307         (while (setq start (string-match "/" tem start))
1308           (setq count (1+ count)
1309                 start (1+ start)))
1310         ;; ... and prepend a "../" for each slash found:
1311         (while (> count 0)
1312           (setq count (1- count)
1313                 name1 (concat "../" name1)))))
1314     (make-symbolic-link
1315      (directory-file-name name1)        ; must not link to foo/
1316                                         ; (trailing slash!)
1317      name2 ok-if-already-exists)))
1318
1319 ;;;###autoload
1320 (defun dired-do-relsymlink (&optional arg)
1321    "Relative symlink all marked (or next ARG) files into a directory.
1322 Otherwise make a relative symbolic link to the current file.
1323 This creates relative symbolic links like
1324
1325     foo -> ../bar/foo
1326
1327 not absolute ones like
1328
1329     foo -> /ugly/file/name/that/may/change/any/day/bar/foo
1330
1331 For absolute symlinks, use \\[dired-do-symlink]."
1332   (interactive "P")
1333   (dired-do-create-files 'relsymlink (function dired-make-relative-symlink)
1334                            "RelSymLink" arg dired-keep-marker-relsymlink))
1335
1336 (defun dired-do-relsymlink-regexp (regexp newname &optional arg whole-name)
1337   "RelSymlink all marked files containing REGEXP to NEWNAME.
1338 See functions `dired-do-rename-regexp' and `dired-do-relsymlink'
1339 for more info."
1340   (interactive (dired-mark-read-regexp "RelSymLink"))
1341   (dired-do-create-files-regexp
1342    (function dired-make-relative-symlink)
1343    "RelSymLink" arg regexp newname whole-name dired-keep-marker-relsymlink))
1344
1345 \f
1346 ;;; VISIT ALL MARKED FILES SIMULTANEOUSLY.
1347
1348 ;; Brief Description:
1349 ;;;
1350 ;; `dired-do-find-marked-files' is bound to `F' by dired-x.el.
1351 ;;;
1352 ;; * Use `dired-get-marked-files' to collect the marked files in the current
1353 ;;;   Dired Buffer into a list of filenames `FILE-LIST'.
1354 ;;;
1355 ;; * Pass FILE-LIST to `dired-simultaneous-find-file' all with
1356 ;;;   `dired-do-find-marked-files''s prefix argument NOSELECT.
1357 ;;;
1358 ;; * `dired-simultaneous-find-file' runs through FILE-LIST decrementing the
1359 ;;;   list each time.
1360 ;;;
1361 ;; * If NOSELECT is non-nil then just run `find-file-noselect' on each
1362 ;;;   element of FILE-LIST.
1363 ;;;
1364 ;; * If NOSELECT is nil then calculate the `size' of the window for each file
1365 ;;;   by dividing the `window-height' by length of FILE-LIST.  Thus, `size' is
1366 ;;;   cognizant of the window-configuration.
1367 ;;;
1368 ;; * If `size' is too small abort, otherwise run `find-file' on each element
1369 ;;;   of FILE-LIST giving each a window of height `size'.
1370
1371 (defun dired-do-find-marked-files (&optional noselect)
1372   "Find all marked files displaying all of them simultaneously.
1373 With optional NOSELECT just find files but do not select them.
1374
1375 The current window is split across all files marked, as evenly as possible.
1376 Remaining lines go to bottom-most window.  The number of files that can be
1377 displayed this way is restricted by the height of the current window and
1378 `window-min-height'.
1379
1380 To keep dired buffer displayed, type \\[split-window-vertically] first.
1381 To display just marked files, type \\[delete-other-windows] first."
1382
1383   (interactive "P")
1384   (dired-simultaneous-find-file (dired-get-marked-files) noselect))
1385
1386 (defun dired-simultaneous-find-file (file-list noselect)
1387
1388   "Visit all files in FILE-LIST and display them simultaneously.
1389 The current window is split across all files in FILE-LIST, as evenly as
1390 possible.  Remaining lines go to the bottom-most window.  The number of
1391 files that can be displayed this way is restricted by the height of the
1392 current window and the variable `window-min-height'.  With non-nil
1393 NOSELECT the files are merely found but not selected."
1394
1395   ;; We don't make this function interactive because it is usually too clumsy
1396   ;; to specify FILE-LIST interactively unless via dired.
1397
1398   (let (size)
1399
1400     (if noselect
1401         ;; Do not select the buffer.
1402         (find-file-noselect (car file-list))
1403
1404       ;; We will have to select the buffer.  Calculate and check window size.
1405       (setq size (/ (window-height) (length file-list)))
1406       (or (<= window-min-height size)
1407           (error "Too many files to visit simultaneously.  Try C-u prefix"))
1408       (find-file (car file-list)))
1409
1410     ;; Decrement.
1411     (setq file-list (cdr file-list))
1412
1413     (while file-list
1414
1415       (if noselect
1416           ;; Do not select the buffer.
1417           (find-file-noselect (car file-list))
1418
1419         ;; Vertically split off a window of desired size.  Upper window will
1420         ;; have SIZE lines.  Select lower (larger) window.  We split it again.
1421         (select-window (split-window nil size))
1422         (find-file (car file-list)))
1423
1424       ;; Decrement.
1425       (setq file-list (cdr file-list)))))
1426
1427 \f
1428 ;;; MISCELLANEOUS COMMANDS.
1429
1430 ;; Run man on files.
1431
1432 (defun dired-man ()
1433   "Run man on this file.  Display old buffer if buffer name matches filename.
1434 Uses `man.el' of \\[manual-entry] fame."
1435   (interactive)
1436   (require 'man)
1437   (let* ((file (dired-get-filename))
1438          (manual-program (replace-regexp-in-string "\\*" "%s"
1439                           (dired-guess-shell-command
1440                            "Man command: " (list file)))))
1441     (Man-getpage-in-background file)))
1442
1443 ;; Run Info on files.
1444
1445 (defun dired-info ()
1446   "Run info on this file."
1447   (interactive)
1448   (info (dired-get-filename)))
1449
1450 ;; Run mail on mail folders.
1451
1452 ;; Avoid compiler warning.
1453 (eval-when-compile
1454   (when (not (fboundp 'vm-visit-folder))
1455     (defun vm-visit-folder (file &optional arg)
1456       nil)))
1457
1458 (defun dired-vm (&optional read-only)
1459   "Run VM on this file.
1460 With prefix arg, visit folder read-only (this requires at least VM 5).
1461 See also variable `dired-vm-read-only-folders'."
1462   (interactive "P")
1463   (let ((dir (dired-current-directory))
1464         (fil (dired-get-filename)))
1465     ;; take care to supply 2nd arg only if requested - may still run VM 4!
1466     (cond (read-only (vm-visit-folder fil t))
1467           ((eq t dired-vm-read-only-folders) (vm-visit-folder fil t))
1468           ((null dired-vm-read-only-folders) (vm-visit-folder fil))
1469           (t (vm-visit-folder fil (not (file-writable-p fil)))))
1470     ;; so that pressing `v' inside VM does prompt within current directory:
1471     (set (make-local-variable 'vm-folder-directory) dir)))
1472
1473 (defun dired-rmail ()
1474   "Run RMAIL on this file."
1475   (interactive)
1476   (rmail (dired-get-filename)))
1477
1478 (defun dired-do-run-mail ()
1479   "If `dired-bind-vm' is t, then function `dired-vm', otherwise `dired-rmail'."
1480   (interactive)
1481   (if dired-bind-vm
1482       ;; Read mail folder using vm.
1483       (dired-vm)
1484     ;; Read mail folder using rmail.
1485     (dired-rmail)))
1486
1487 \f
1488 ;;; MISCELLANEOUS INTERNAL FUNCTIONS.
1489
1490 (declare-function dired-old-find-buffer-nocreate "dired-x")
1491
1492 (or (fboundp 'dired-old-find-buffer-nocreate)
1493     (fset 'dired-old-find-buffer-nocreate
1494           (symbol-function 'dired-find-buffer-nocreate)))
1495
1496 ;; REDEFINE.
1497 ;; Redefines dired.el's version of `dired-find-buffer-nocreate'
1498 (defun dired-find-buffer-nocreate (dirname &optional mode)
1499   (if (and dired-find-subdir
1500            ;; don't try to find a wildcard as a subdirectory
1501            (string-equal dirname (file-name-directory dirname)))
1502       (let* ((cur-buf (current-buffer))
1503              (buffers (nreverse
1504                        (dired-buffers-for-dir (expand-file-name dirname))))
1505              (cur-buf-matches (and (memq cur-buf buffers)
1506                                    ;; wildcards must match, too:
1507                                    (equal dired-directory dirname))))
1508         ;; We don't want to switch to the same buffer---
1509         (setq buffers (delq cur-buf buffers));;need setq with delq
1510         (or (car (sort buffers (function dired-buffer-more-recently-used-p)))
1511             ;; ---unless it's the only possibility:
1512             (and cur-buf-matches cur-buf)))
1513     (dired-old-find-buffer-nocreate dirname mode)))
1514
1515 ;; This should be a builtin
1516 (defun dired-buffer-more-recently-used-p (buffer1 buffer2)
1517   "Return t if BUFFER1 is more recently used than BUFFER2."
1518   (if (equal buffer1 buffer2)
1519       nil
1520     (let ((more-recent nil)
1521           (list (buffer-list)))
1522       (while (and list
1523                   (not (setq more-recent (equal buffer1 (car list))))
1524                   (not (equal buffer2 (car list))))
1525         (setq list (cdr list)))
1526       more-recent)))
1527
1528 ;; Same thing as `dired-buffers-for-dir' of dired.el? - lrd 11/23/93
1529 ;; (defun dired-buffers-for-dir-exact (dir)
1530 ;; ;; Return a list of buffers that dired DIR (a directory or wildcard)
1531 ;; ;; at top level, or as subdirectory.
1532 ;; ;; Top level matches must match the wildcard part too, if any.
1533 ;; ;; The list is in reverse order of buffer creation, most recent last.
1534 ;; ;; As a side effect, killed dired buffers for DIR are removed from
1535 ;; ;; dired-buffers.
1536 ;;   (let ((alist dired-buffers) result elt)
1537 ;;     (while alist
1538 ;;       (setq elt (car alist)
1539 ;;             alist (cdr alist))
1540 ;;       (let ((buf (cdr elt)))
1541 ;;         (if (buffer-name buf)
1542 ;;             ;; Top level must match exactly against dired-directory in
1543 ;;             ;; case one of them is a wildcard.
1544 ;;             (if (or (equal dir (with-current-buffer buf dired-directory))
1545 ;;                     (assoc dir (with-current-buffer buf dired-subdir-alist)))
1546 ;;                 (setq result (cons buf result)))
1547 ;;           ;; else buffer is killed - clean up:
1548 ;;           (setq dired-buffers (delq elt dired-buffers)))))
1549 ;;     result))
1550
1551 ;; REDEFINE.
1552 ;; Redefines dired.el's version of `dired-initial-position'
1553 (defun dired-initial-position (dirname)
1554   "Where point should go in a new listing of DIRNAME.
1555 Point assumed at beginning of new subdir line.
1556 You may redefine this function as you wish, e.g. like in `dired-x.el'."
1557   (end-of-line)
1558   (if dired-find-subdir (dired-goto-subdir dirname)) ; new
1559   (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1560
1561 \f
1562 ;; Does anyone use this? - lrd 6/29/93.
1563 ;; Apparently people do use it. - lrd 12/22/97.
1564 (defun dired-mark-sexp (predicate &optional unflag-p)
1565   "Mark files for which PREDICATE returns non-nil.
1566 With a prefix arg, unflag those files instead.
1567
1568 PREDICATE is a lisp expression that can refer to the following symbols:
1569
1570     inode  [integer] the inode of the file (only for ls -i output)
1571     s      [integer] the size of the file for ls -s output
1572                      (usually in blocks or, with -k, in KByte)
1573     mode   [string]  file permission bits, e.g. \"-rw-r--r--\"
1574     nlink  [integer] number of links to file
1575     uid    [string]  owner
1576     gid    [string]  group  (If the gid is not displayed by ls,
1577                      this will still be set (to the same as uid))
1578     size   [integer] file size in bytes
1579     time   [string]  the time that ls displays, e.g. \"Feb 12 14:17\"
1580     name   [string]  the name of the file
1581     sym    [string]  if file is a symbolic link, the linked-to name, else \"\"
1582
1583 For example, use
1584
1585         (equal 0 size)
1586
1587 to mark all zero length files."
1588   ;; Using sym="" instead of nil avoids the trap of
1589   ;; (string-match "foo" sym) into which a user would soon fall.
1590   ;; Give `equal' instead of `=' in the example, as this works on
1591   ;; integers and strings.
1592   (interactive "xMark if (lisp expr): \nP")
1593   (message "%s" predicate)
1594   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char))
1595         inode s mode nlink uid gid size time name sym)
1596     (dired-mark-if
1597      (save-excursion
1598        (and
1599         ;; Sets vars
1600         ;;                inode s mode nlink uid gid size time name sym
1601
1602         ;; according to current file line.  Returns t for success, nil if
1603         ;; there is no file line.  Upon success, all variables are set, either
1604         ;; to nil or the appropriate value, so they need not be initialized.
1605         ;; Moves point within the current line.
1606         (if (dired-move-to-filename)
1607             (let (pos
1608                   (mode-len 10) ; length of mode string
1609                   ;; like in dired.el, but with subexpressions \1=inode, \2=s:
1610                   (dired-re-inode-size "\\s *\\([0-9]*\\)\\s *\\([0-9]*\\) ?"))
1611               (beginning-of-line)
1612               (forward-char 2)
1613               (if (looking-at dired-re-inode-size)
1614                   (progn
1615                     (goto-char (match-end 0))
1616                     (setq inode (string-to-number (buffer-substring (match-beginning 1)
1617                                                                     (match-end 1)))
1618                           s (string-to-number (buffer-substring (match-beginning 2)
1619                                                                 (match-end 2)))))
1620                 (setq inode nil
1621                       s nil))
1622               (setq mode (buffer-substring (point) (+ mode-len (point))))
1623               (forward-char mode-len)
1624               (setq nlink (read (current-buffer)))
1625               ;; Karsten Wenger <kw@cis.uni-muenchen.de> fixed uid.
1626               (setq uid (buffer-substring (+ (point) 1)
1627                                           (progn (forward-word 1) (point))))
1628               (re-search-forward directory-listing-before-filename-regexp)
1629               (goto-char (match-beginning 1))
1630               (forward-char -1)
1631               (setq size (string-to-number (buffer-substring (save-excursion
1632                                                                (backward-word 1)
1633                                                                (setq pos (point)))
1634                                                              (point))))
1635               (goto-char pos)
1636               (backward-word 1)
1637               ;; if no gid is displayed, gid will be set to uid
1638               ;; but user will then not reference it anyway in PREDICATE.
1639               (setq gid (buffer-substring (save-excursion
1640                                             (forward-word 1) (point))
1641                                           (point))
1642                     time (buffer-substring (match-beginning 1)
1643                                            (1- (dired-move-to-filename)))
1644                     name (buffer-substring (point)
1645                                            (or
1646                                             (dired-move-to-end-of-filename t)
1647                                             (point)))
1648                     sym  (progn
1649                            (if (looking-at " -> ")
1650                                (buffer-substring
1651                                 (progn (forward-char 4) (point))
1652                                 (progn (end-of-line) (point)))
1653                              "")))
1654               t)
1655           nil)
1656                       (eval predicate)))
1657      (format "'%s file" predicate))))
1658
1659 \f
1660 ;;; FIND FILE AT POINT.
1661
1662 (defvar dired-x-hands-off-my-keys t
1663   "*Non-nil means don't bind `dired-x-find-file' over `find-file' on keyboard.
1664 Similarly for `dired-x-find-file-other-window' over `find-file-other-window'.
1665 If you change this variable after `dired-x.el' is loaded then do
1666 \\[dired-x-bind-find-file].")
1667
1668 ;; Bind `dired-x-find-file{-other-window}' over wherever
1669 ;; `find-file{-other-window}' is bound?
1670 (defun dired-x-bind-find-file ()
1671   "Bind `dired-x-find-file' in place of `find-file' \(or reverse\).
1672 Similarly for `dired-x-find-file-other-window' and `find-file-other-window'.
1673 Binding direction based on `dired-x-hands-off-my-keys'.
1674 This function is part of `after-init-hook'."
1675   (interactive)
1676   (if (called-interactively-p 'interactive)
1677       (setq dired-x-hands-off-my-keys
1678             (not (y-or-n-p "Bind dired-x-find-file over find-file? "))))
1679   (cond ((not dired-x-hands-off-my-keys)
1680          (substitute-key-definition 'find-file
1681                                     'dired-x-find-file
1682                                     (current-global-map))
1683          (substitute-key-definition 'find-file-other-window
1684                                     'dired-x-find-file-other-window
1685                                     (current-global-map)))
1686         (t
1687          (substitute-key-definition 'dired-x-find-file
1688                                     'find-file
1689                                     (current-global-map))
1690          (substitute-key-definition 'dired-x-find-file-other-window
1691                                     'find-file-other-window
1692                                     (current-global-map))))
1693   ;; Clear mini-buffer.
1694   (message nil))
1695
1696 ;; Now call it so binding is correct and put on `after-init-hook' in case
1697 ;; user changes binding.
1698 (dired-x-bind-find-file)
1699 (add-hook 'after-init-hook 'dired-x-bind-find-file)
1700
1701 (defun dired-x-find-file (filename)
1702   "Edit file FILENAME.
1703 May create a new window, or reuse an existing one.
1704 See the function `display-buffer'.
1705
1706 Identical to `find-file' except when called interactively, with a prefix arg
1707 \(e.g., \\[universal-argument]\), in which case it guesses filename near point.
1708 Useful for editing file mentioned in buffer you are viewing,
1709 or to test if that file exists.  Use minibuffer after snatching filename."
1710   (interactive (list (read-filename-at-point "Find file: ")))
1711   (find-file (expand-file-name filename)))
1712
1713 (defun dired-x-find-file-other-window (filename)
1714   "Edit file FILENAME, in another window.
1715 May create a new window, or reuse an existing one.
1716 See the function `display-buffer'.
1717
1718 Identical to `find-file-other-window' except when called interactively, with
1719 a prefix arg \(e.g., \\[universal-argument]\), in which case it guesses filename near point.
1720 Useful for editing file mentioned in buffer you are viewing,
1721 or to test if that file exists.  Use minibuffer after snatching filename."
1722   (interactive (list (read-filename-at-point "Find file: ")))
1723   (find-file-other-window (expand-file-name filename)))
1724
1725 ;;; Internal functions.
1726
1727 ;; Fixme: This should probably use `thing-at-point'.  -- fx
1728 (defun dired-filename-at-point ()
1729   "Get the filename closest to point, but do not change position.
1730 Has a preference for looking backward when not directly on a symbol.
1731 Not perfect - point must be in middle of or end of filename."
1732
1733   (let ((filename-chars "-.[:alnum:]_/:$+@")
1734         start end filename prefix)
1735
1736     (save-excursion
1737       ;; First see if just past a filename.
1738       (if (not (eobp))
1739           (if (looking-at "[] \t\n[{}()]") ; whitespace or some parens
1740               (progn
1741                 (skip-chars-backward " \n\t\r({[]})")
1742                 (if (not (bobp))
1743                     (backward-char 1)))))
1744
1745       (if (string-match (concat "[" filename-chars "]")
1746                         (char-to-string (following-char)))
1747           (progn
1748             (if (re-search-backward (concat "[^" filename-chars "]") nil t)
1749                 (forward-char)
1750               (goto-char (point-min)))
1751             (setq start (point))
1752             (setq prefix
1753                   (and (string-match
1754                         "^\\w+@"
1755                         (buffer-substring start (line-beginning-position)))
1756                        "/"))
1757             (goto-char start)
1758             (if (string-match "[/~]" (char-to-string (preceding-char)))
1759                 (setq start (1- start)))
1760             (re-search-forward (concat "\\=[" filename-chars "]*") nil t))
1761
1762         (error "No file found around point!"))
1763
1764       ;; Return string.
1765       (expand-file-name (concat prefix (buffer-substring start (point)))))))
1766
1767 (defun read-filename-at-point (prompt)
1768   "Return filename prompting with PROMPT with completion.
1769 If `current-prefix-arg' is non-nil, uses name at point as guess."
1770   (if current-prefix-arg
1771       (let ((guess (dired-filename-at-point)))
1772         (read-file-name prompt
1773                         (file-name-directory guess)
1774                         guess
1775                         nil (file-name-nondirectory guess)))
1776     (read-file-name prompt default-directory)))
1777 \f
1778 ;;; BUG REPORTS
1779
1780 ;; Fixme: get rid of this later.
1781
1782 ;; This section is provided for reports.  It uses Barry A. Warsaw's
1783 ;; reporter.el which is bundled with GNU Emacs v19.
1784
1785 (defconst dired-x-help-address "bug-gnu-emacs@gnu.org"
1786   "Address(es) accepting submission of reports on dired-x.el.")
1787
1788 (defconst dired-x-variable-list
1789   (list
1790    'dired-bind-vm
1791    'dired-vm-read-only-folders
1792    'dired-bind-jump
1793    'dired-bind-info
1794    'dired-bind-man
1795    'dired-find-subdir
1796    'dired-enable-local-variables
1797    'dired-local-variables-file
1798    'dired-guess-shell-gnutar
1799    'dired-guess-shell-gzip-quiet
1800    'dired-guess-shell-znew-switches
1801    'dired-guess-shell-alist-user
1802    'dired-clean-up-buffers-too
1803    'dired-omit-mode
1804    'dired-omit-files
1805    'dired-omit-extensions
1806    )
1807   "List of variables to be appended to reports sent by `dired-x-submit-report'.")
1808
1809 (defun dired-x-submit-report ()
1810   "Submit via `reporter.el' a bug report on program.
1811 Send report on `dired-x-file' version `dired-x-version', to
1812 `dired-x-maintainer' at address `dired-x-help-address' listing
1813 variables `dired-x-variable-list' in the message."
1814   (interactive)
1815
1816   (reporter-submit-bug-report
1817    dired-x-help-address                 ; address
1818    "dired-x"                            ; pkgname
1819    dired-x-variable-list                ; varlist
1820    nil nil                              ; pre-/post-hooks
1821    ""))
1822
1823 \f
1824 ;; As Barry Warsaw would say: "This might be useful..."
1825 (provide 'dired-x)
1826
1827 ;; Local Variables:
1828 ;; byte-compile-dynamic: t
1829 ;; generated-autoload-file: "dired.el"
1830 ;; End:
1831
1832 ;;; dired-x.el ends here