lisp/dired-x.el

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