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,
   4 ;;   2005, 2006, 2007, 2008 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, or (at your option)
  16 ;; 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; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  26 ;; Boston, MA 02110-1301, USA.
  27
  28 ;;; Commentary:
  29
  30 ;; This is Sebastian Kremer's excellent dired-x.el (Dired Extra), version
  31 ;; 1.191, hacked up for GNU Emacs.  Redundant or conflicting material has
  32 ;; been removed or renamed in order to work properly with dired of GNU
  33 ;; Emacs.  All suggestions or comments are most welcomed.
  34
  35 ;;
  36 ;; Please, PLEASE, *PLEASE* see the info pages.
  37 ;;
  38
  39 ;; BUGS: Type M-x dired-x-submit-report and a report will be generated.
  40
  41 ;; INSTALLATION: In your ~/.emacs,
  42 ;;
  43 ;; (add-hook 'dired-load-hook
  44 ;;           (function (lambda ()
  45 ;;                       (load "dired-x")
  46 ;;                       ;; Set global variables here.  For example:
  47 ;;                       ;; (setq dired-guess-shell-gnutar "gtar")
  48 ;;                       )))
  49 ;; (add-hook 'dired-mode-hook
  50 ;;           (function (lambda ()
  51 ;;                       ;; Set buffer-local variables here.  For example:
  52 ;;                       ;; (dired-omit-mode 1)
  53 ;;                       )))
  54 ;;
  55 ;; At load time dired-x.el will install itself, redefine some functions, and
  56 ;; bind some dired keys.  *Please* see the info pages for more details.
  57
  58 ;; *Please* see the info pages for more details.
  59
  60 ;; User defined variables:
  61 ;;
  62 ;;      dired-bind-vm
  63 ;;      dired-vm-read-only-folders
  64 ;;      dired-bind-jump
  65 ;;      dired-bind-info
  66 ;;      dired-bind-man
  67 ;;      dired-x-hands-off-my-keys
  68 ;;      dired-find-subdir
  69 ;;      dired-enable-local-variables
  70 ;;      dired-local-variables-file
  71 ;;      dired-guess-shell-gnutar
  72 ;;      dired-guess-shell-gzip-quiet
  73 ;;      dired-guess-shell-znew-switches
  74 ;;      dired-guess-shell-alist-user
  75 ;;      dired-clean-up-buffers-too
  76 ;;      dired-omit-mode
  77 ;;      dired-omit-files
  78 ;;      dired-omit-extensions
  79 ;;      dired-omit-size-limit
  80 ;;
  81 ;; To find out more about these variables, load this file, put your cursor at
  82 ;; the end of any of the variable names, and hit C-h v [RET].  *Please* see
  83 ;; the info pages for more details.
  84
  85 ;; When loaded this code redefines the following functions of GNU Emacs
  86 ;;
  87 ;;   Function                         Found in this file of GNU Emacs
  88 ;;   --------                         -------------------------------
  89 ;;   dired-clean-up-after-deletion    ../lisp/dired.el
  90 ;;   dired-find-buffer-nocreate       ../lisp/dired.el
  91 ;;   dired-initial-position           ../lisp/dired.el
  92 ;;
  93 ;;   dired-add-entry                  ../lisp/dired-aux.el
  94 ;;   dired-read-shell-command         ../lisp/dired-aux.el
  95
  96 \f
  97 ;;; Code:
  98
  99 ;; LOAD.
 100
 101 ;; This is a no-op if dired-x is being loaded via `dired-load-hook'.  It is
 102 ;; here in case the user has autoloaded dired-x via the dired-jump key binding
 103 ;; (instead of autoloading to dired as is suggested in the info-pages).
 104
 105 (require 'dired)
 106
 107 ;; We will redefine some functions and also need some macros so we need to
 108 ;; load dired stuff of GNU Emacs.
 109
 110 (require 'dired-aux)
 111
 112 (defvar vm-folder-directory)
 113 (eval-when-compile (require 'man))
 114
 115 ;;; User-defined variables.
 116
 117 (defgroup dired-x nil
 118   "Extended directory editing (dired-x)."
 119   :group 'dired)
 120
 121 (defgroup dired-keys nil
 122   "Dired keys customizations."
 123   :prefix "dired-"
 124   :group 'dired-x)
 125
 126 (defcustom dired-bind-vm nil
 127   "*Non-nil means \"V\" runs `dired-vm', otherwise \"V\" runs `dired-rmail'.
 128 Also, RMAIL files contain -*- rmail -*- at the top so \"f\",
 129 `dired-advertised-find-file', will run rmail."
 130   :type 'boolean
 131   :group 'dired-keys)
 132
 133 (defcustom dired-bind-jump t
 134   "*Non-nil means bind `dired-jump' to C-x C-j, otherwise do not."
 135   :type 'boolean
 136   :group 'dired-keys)
 137
 138 (defcustom dired-bind-man t
 139   "*Non-nil means bind `dired-man' to \"N\" in dired-mode, otherwise do not."
 140   :type 'boolean
 141   :group 'dired-keys)
 142
 143 (defcustom dired-bind-info t
 144   "*Non-nil means bind `dired-info' to \"I\" in dired-mode, otherwise do not."
 145   :type 'boolean
 146   :group 'dired-keys)
 147
 148 (defcustom dired-vm-read-only-folders nil
 149   "*If non-nil, \\[dired-vm] will visit all folders read-only.
 150 If neither nil nor t, e.g. the symbol `if-file-read-only', only
 151 files not writable by you are visited read-only.
 152
 153 Read-only folders only work in VM 5, not in VM 4."
 154   :type '(choice (const :tag "off" nil)
 155                  (const :tag "on" t)
 156                  (other :tag "non-writable only" if-file-read-only))
 157   :group 'dired-x)
 158
 159 (define-minor-mode dired-omit-mode
 160   "Toggle Dired-Omit mode.
 161 With numeric ARG, enable Dired-Omit mode if ARG is positive, disable
 162 otherwise.  Enabling and disabling is buffer-local.
 163 If enabled, \"uninteresting\" files are not listed.
 164 Uninteresting files are those whose filenames match regexp `dired-omit-files',
 165 plus those ending with extensions in `dired-omit-extensions'."
 166   :group 'dired-x
 167   (if dired-omit-mode
 168       ;; This will mention how many lines were omitted:
 169       (let ((dired-omit-size-limit nil)) (dired-omit-expunge))
 170     (revert-buffer)))
 171
 172 ;; For backward compatibility
 173 (defvaralias 'dired-omit-files-p 'dired-omit-mode)
 174 (make-obsolete-variable 'dired-omit-files-p 'dired-omit-mode)
 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 (cmd &optional insert)
 843   "Like function `shell-command', but in the current Virtual Dired directory."
 844   (interactive (list (read-from-minibuffer "Shell command: "
 845                                            nil nil nil 'shell-command-history)
 846                      current-prefix-arg))
 847   (let ((default-directory (dired-default-directory)))
 848     (shell-command cmd insert)))
 849
 850 \f
 851 ;;; LOCAL VARIABLES FOR DIRED BUFFERS.
 852
 853 ;;; Brief Description:
 854 ;;;
 855 ;;; * `dired-extra-startup' is part of the `dired-mode-hook'.
 856 ;;;
 857 ;;; * `dired-extra-startup' calls `dired-hack-local-variables'
 858 ;;;
 859 ;;; * `dired-hack-local-variables' checks the value of
 860 ;;;   `dired-local-variables-file'
 861 ;;;
 862 ;;; * Check if `dired-local-variables-file' is a non-nil string and is a
 863 ;;;   filename found in the directory of the Dired Buffer being created.
 864 ;;;
 865 ;;; * If `dired-local-variables-file' satisfies the above, then temporarily
 866 ;;;   include it in the Dired Buffer at the bottom.
 867 ;;;
 868 ;;; * Set `enable-local-variables' temporarily to the user variable
 869 ;;;   `dired-enable-local-variables' and run `hack-local-variables' on the
 870 ;;;   Dired Buffer.
 871
 872 (defvar dired-local-variables-file (convert-standard-filename ".dired")
 873   "Filename, as string, containing local dired buffer variables to be hacked.
 874 If this file found in current directory, then it will be inserted into dired
 875 buffer and `hack-local-variables' will be run.  See Info node
 876 `(emacs)File Variables' for more information on local variables.
 877 See also `dired-enable-local-variables'.")
 878
 879 (defun dired-hack-local-variables ()
 880   "Evaluate local variables in `dired-local-variables-file' for dired buffer."
 881   (if (and dired-local-variables-file
 882            (stringp dired-local-variables-file)
 883            (file-exists-p dired-local-variables-file))
 884       (let ((opoint (point-max))
 885             buffer-read-only
 886             ;; In case user has `enable-local-variables' set to nil we
 887             ;; override it locally with dired's variable.
 888             (enable-local-variables dired-enable-local-variables))
 889         ;; Insert 'em.
 890         (save-excursion
 891           (goto-char opoint)
 892           (insert "\^L\n")
 893           (insert-file-contents dired-local-variables-file))
 894         ;; Hack 'em.
 895         (let ((buffer-file-name dired-local-variables-file))
 896           (hack-local-variables))
 897         ;; Make sure that the modeline shows the proper information.
 898         (dired-sort-set-modeline)
 899         ;; Delete this stuff: `eobp' is used to find last subdir by dired.el.
 900         (delete-region opoint (point-max)))))
 901
 902 (defun dired-omit-here-always ()
 903   "Create `dired-local-variables-file' for omitting and reverts directory.
 904 Sets `dired-omit-mode' to t in a local variables file that is readable by
 905 dired."
 906   (interactive)
 907   (if (file-exists-p dired-local-variables-file)
 908       (message "File `./%s' already exists." dired-local-variables-file)
 909
 910     ;; Create `dired-local-variables-file'.
 911     (save-excursion
 912       (set-buffer (get-buffer-create " *dot-dired*"))
 913       (erase-buffer)
 914       (insert "Local Variables:\ndired-omit-mode: t\nEnd:\n")
 915       (write-file dired-local-variables-file)
 916       (kill-buffer (current-buffer)))
 917
 918     ;; Run extra-hooks and revert directory.
 919     (dired-extra-startup)
 920     (dired-revert)))
 921
 922 \f
 923 ;;; GUESS SHELL COMMAND.
 924
 925 ;;; Brief Description:
 926 ;;;
 927 ;;; `dired-do-shell-command' is bound to `!' by dired.el.
 928 ;;;
 929 ;;; * Redefine `dired-do-shell-command' so it calls
 930 ;;;   `dired-guess-shell-command'.
 931 ;;;
 932 ;;; * `dired-guess-shell-command' calls `dired-guess-default' with list of
 933 ;;;    marked files.
 934 ;;;
 935 ;;; * Parse `dired-guess-shell-alist-user' and
 936 ;;;   `dired-guess-shell-alist-default' (in that order) for the first REGEXP
 937 ;;;   that matches the first file in the file list.
 938 ;;;
 939 ;;; * If the REGEXP matches all the entries of the file list then evaluate
 940 ;;;   COMMAND, which is either a string or a Lisp expression returning a
 941 ;;;   string.  COMMAND may be a list of commands.
 942 ;;;
 943 ;;; * Return this command to `dired-guess-shell-command' which prompts user
 944 ;;;   with it.  The list of commands is put into the list of default values.
 945 ;;;   If a command is used successfully then it is stored permanently in
 946 ;;;   `dired-shell-command-history'.
 947
 948 ;;; Guess what shell command to apply to a file.
 949 (defvar dired-shell-command-history nil
 950   "History list for commands that read dired-shell commands.")
 951
 952 ;;; Default list of shell commands.
 953
 954 ;;; NOTE: Use `gunzip -c' instead of `zcat' on `.gz' files.  Some do not
 955 ;;; install GNU zip's version of zcat.
 956
 957 (defvar dired-guess-shell-alist-default
 958   (list
 959    (list "\\.tar$"
 960          '(if dired-guess-shell-gnutar
 961               (concat dired-guess-shell-gnutar " xvf")
 962             "tar xvf")
 963          ;; Extract files into a separate subdirectory
 964          '(if dired-guess-shell-gnutar
 965               (concat "mkdir " (file-name-sans-extension file)
 966                       "; " dired-guess-shell-gnutar " -C "
 967                       (file-name-sans-extension file) " -xvf")
 968             (concat "mkdir " (file-name-sans-extension file)
 969                     "; tar -C " (file-name-sans-extension file) " -xvf"))
 970          ;; List archive contents.
 971          '(if dired-guess-shell-gnutar
 972               (concat dired-guess-shell-gnutar " tvf")
 973             "tar tvf"))
 974
 975    ;; REGEXPS for compressed archives must come before the .Z rule to
 976    ;; be recognized:
 977    (list "\\.tar\\.Z$"
 978          ;; Untar it.
 979          '(if dired-guess-shell-gnutar
 980               (concat dired-guess-shell-gnutar " zxvf")
 981             (concat "zcat * | tar xvf -"))
 982          ;; Optional conversion to gzip format.
 983          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
 984                   " " dired-guess-shell-znew-switches))
 985
 986    ;; gzip'ed archives
 987    (list "\\.t\\(ar\\.\\)?gz$"
 988          '(if dired-guess-shell-gnutar
 989               (concat dired-guess-shell-gnutar " zxvf")
 990             (concat "gunzip -qc * | tar xvf -"))
 991          ;; Extract files into a separate subdirectory
 992          '(if dired-guess-shell-gnutar
 993               (concat "mkdir " (file-name-sans-extension file)
 994                       "; " dired-guess-shell-gnutar " -C "
 995                       (file-name-sans-extension file) " -zxvf")
 996             (concat "mkdir " (file-name-sans-extension file)
 997                     "; gunzip -qc * | tar -C "
 998                     (file-name-sans-extension file) " -xvf -"))
 999          ;; Optional decompression.
1000          '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q" ""))
1001          ;; List archive contents.
1002          '(if dired-guess-shell-gnutar
1003               (concat dired-guess-shell-gnutar " ztvf")
1004             (concat "gunzip -qc * | tar tvf -")))
1005
1006    ;; bzip2'ed archives
1007    (list "\\.t\\(ar\\.bz2\\|bz\\)$"
1008          "bunzip2 -c * | tar xvf -"
1009          ;; Extract files into a separate subdirectory
1010          '(concat "mkdir " (file-name-sans-extension file)
1011                   "; bunzip2 -c * | tar -C "
1012                   (file-name-sans-extension file) " -xvf -")
1013          ;; Optional decompression.
1014          "bunzip2")
1015
1016    '("\\.shar\\.Z$" "zcat * | unshar")
1017    '("\\.shar\\.g?z$" "gunzip -qc * | unshar")
1018
1019    '("\\.e?ps$" "ghostview" "xloadimage" "lpr")
1020    (list "\\.e?ps\\.g?z$" "gunzip -qc * | ghostview -"
1021          ;; Optional decompression.
1022          '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1023    (list "\\.e?ps\\.Z$" "zcat * | ghostview -"
1024          ;; Optional conversion to gzip format.
1025          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1026                   " " dired-guess-shell-znew-switches))
1027
1028    '("\\.patch$" "cat * | patch")
1029    (list "\\.patch\\.g?z$" "gunzip -qc * | patch"
1030          ;; Optional decompression.
1031          '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1032    (list "\\.patch\\.Z$" "zcat * | patch"
1033          ;; Optional conversion to gzip format.
1034          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1035                   " " dired-guess-shell-znew-switches))
1036
1037    ;; The following four extensions are useful with dired-man ("N" key)
1038    (list "\\.\\(?:[0-9]\\|man\\)$" '(progn (require 'man)
1039                                            (if (Man-support-local-filenames)
1040                                                "man -l"
1041                                              "cat * | tbl | nroff -man -h")))
1042    (list "\\.\\(?:[0-9]\\|man\\)\\.g?z$" '(progn (require 'man)
1043                                                  (if (Man-support-local-filenames)
1044                                                      "man -l"
1045                                                    "gunzip -qc * | tbl | nroff -man -h"))
1046          ;; Optional decompression.
1047          '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1048    (list "\\.[0-9]\\.Z$" '(progn (require 'man)
1049                                  (if (Man-support-local-filenames)
1050                                      "man -l"
1051                                    "zcat * | tbl | nroff -man -h"))
1052          ;; Optional conversion to gzip format.
1053          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1054                   " " dired-guess-shell-znew-switches))
1055    '("\\.pod$" "perldoc" "pod2man * | nroff -man")
1056
1057    '("\\.dvi$" "xdvi" "dvips")          ; preview and printing
1058    '("\\.au$" "play")                   ; play Sun audiofiles
1059    '("\\.mpe?g$\\|\\.avi$" "xine -p")
1060    '("\\.wav$" "play")
1061    '("\\.uu$" "uudecode")               ; for uudecoded files
1062    '("\\.hqx$" "mcvert")
1063    '("\\.sh$" "sh")                     ; execute shell scripts
1064    '("\\.xbm$" "bitmap")                ; view X11 bitmaps
1065    '("\\.gp$" "gnuplot")
1066    '("\\.p[bgpn]m$" "xloadimage")
1067    '("\\.gif$" "xloadimage")            ; view gif pictures
1068    '("\\.tif$" "xloadimage")
1069    '("\\.png$" "display")               ; xloadimage 4.1 doesn't grok PNG
1070    '("\\.jpe?g$" "xloadimage")
1071    '("\\.fig$" "xfig")                  ; edit fig pictures
1072    '("\\.out$" "xgraph")                ; for plotting purposes.
1073    '("\\.tex$" "latex" "tex")
1074    '("\\.texi\\(nfo\\)?$" "makeinfo" "texi2dvi")
1075    '("\\.pdf$" "xpdf")
1076    '("\\.doc$" "antiword" "strings")
1077    '("\\.rpm$" "rpm -qilp" "rpm -ivh")
1078    '("\\.dia$" "dia")
1079    '("\\.mgp$" "mgp")
1080
1081    ;; Some other popular archivers.
1082    (list "\\.zip$" "unzip" "unzip -l"
1083          ;; Extract files into a separate subdirectory
1084          '(concat "unzip" (if dired-guess-shell-gzip-quiet " -q")
1085                   " -d " (file-name-sans-extension file)))
1086    '("\\.zoo$" "zoo x//")
1087    '("\\.lzh$" "lharc x")
1088    '("\\.arc$" "arc x")
1089    '("\\.shar$" "unshar")
1090
1091    ;; Compression.
1092    (list "\\.g?z$" '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1093    (list "\\.dz$" "dictunzip")
1094    (list "\\.bz2$" "bunzip2")
1095    (list "\\.Z$" "uncompress"
1096          ;; Optional conversion to gzip format.
1097          '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1098                   " " dired-guess-shell-znew-switches))
1099
1100    '("\\.sign?$" "gpg --verify"))
1101
1102   "Default alist used for shell command guessing.
1103 See `dired-guess-shell-alist-user'.")
1104
1105 (defcustom dired-guess-shell-alist-user nil
1106   "User-defined alist of rules for suggested commands.
1107 These rules take precedence over the predefined rules in the variable
1108 `dired-guess-shell-alist-default' (to which they are prepended).
1109
1110 Each element of this list looks like
1111
1112     \(REGEXP COMMAND...\)
1113
1114 where each COMMAND can either be a string or a Lisp expression that evaluates
1115 to a string.  If several COMMANDs are given, the first one will be the default
1116 and the rest will be added temporarily to the history and can be retrieved
1117 with \\[previous-history-element] (M-p) .
1118
1119 You can set this variable in your ~/.emacs.  For example, to add rules for
1120 `.foo' and `.bar' files, write
1121
1122  \(setq dired-guess-shell-alist-user
1123        (list (list \"\\\\.foo\\\\'\" \"FOO-COMMAND\");; fixed rule
1124               ;; possibly more rules ...
1125               (list \"\\\\.bar\\\'\";; rule with condition test
1126                     '(if condition
1127                           \"BAR-COMMAND-1\"
1128                         \"BAR-COMMAND-2\")))\)"
1129   :group 'dired-x
1130   :type '(alist :key-type regexp :value-type (repeat sexp)))
1131
1132 (defcustom dired-guess-shell-case-fold-search t
1133   "If non-nil, `dired-guess-shell-alist-default' and
1134 `dired-guess-shell-alist-user' are matched case-insensitively."
1135   :group 'dired-x
1136   :type 'boolean)
1137
1138 (defun dired-guess-default (files)
1139   "Guess a shell commands for FILES.  Return command or list of commands.
1140 See `dired-guess-shell-alist-user'."
1141
1142   (let* ((case-fold-search dired-guess-shell-case-fold-search)
1143          ;; Prepend the user's alist to the default alist.
1144          (alist (append dired-guess-shell-alist-user
1145                         dired-guess-shell-alist-default))
1146          (file (car files))
1147          (flist (cdr files))
1148          elt regexp cmds)
1149
1150     ;; Find the first match in the alist for first file in FILES.
1151     (while alist
1152       (setq elt (car alist)
1153             regexp (car elt)
1154             alist (cdr alist))
1155       (if (string-match regexp file)
1156           (setq cmds (cdr elt)
1157                 alist nil)))
1158
1159     ;; If more than one file, see if all of FILES match regular expression.
1160     (while (and flist
1161                 (string-match regexp (car flist)))
1162       (setq flist (cdr flist)))
1163
1164     ;; If flist is still non-nil, then do not guess since this means that not
1165     ;; all the files in FILES were matched by the regexp.
1166     (setq cmds (and (not flist) cmds))
1167
1168     ;; Return commands or nil if flist is still non-nil.
1169     ;; Evaluate the commands in order that any logical testing will be done.
1170     (cond ((not (cdr cmds))
1171            (eval (car cmds))) ; single command
1172           (t
1173            (mapcar (function eval) cmds)))))
1174
1175 (defun dired-guess-shell-command (prompt files)
1176   "Ask user with PROMPT for a shell command, guessing a default from FILES."
1177   (let ((default (dired-guess-default files))
1178         default-list val)
1179     (if (null default)
1180         ;; Nothing to guess
1181         (read-from-minibuffer prompt nil nil nil 'dired-shell-command-history)
1182       (if (listp default)
1183           ;; More than one guess
1184           (setq default-list default
1185                 default (car default)
1186                 prompt (concat
1187                         prompt
1188                         (format "{%d guesses} " (length default-list))))
1189         ;; Just one guess
1190         (setq default-list (list default)))
1191       ;; Put the first guess in the prompt but not in the initial value.
1192       (setq prompt (concat prompt (format "[%s] " default)))
1193       ;; All guesses can be retrieved with M-n
1194       (setq val (read-from-minibuffer prompt nil nil nil
1195                                       'dired-shell-command-history
1196                                       default-list))
1197       ;; If we got a return, then return default.
1198       (if (equal val "") default val))))
1199
1200 ;;; REDEFINE.
1201 ;;; Redefine dired-aux.el's version:
1202 (defun dired-read-shell-command (prompt arg files)
1203   "Read a dired shell command prompting with PROMPT (using read-string).
1204 ARG is the prefix arg and may be used to indicate in the prompt which
1205   files are affected.
1206 This is an extra function so that you can redefine it."
1207   (dired-mark-pop-up
1208    nil 'shell files
1209    'dired-guess-shell-command
1210    (format prompt (dired-mark-prompt arg files)) ; PROMPT
1211    files))                                       ; FILES
1212
1213 \f
1214 ;;; RELATIVE SYMBOLIC LINKS.
1215
1216 (declare-function make-symbolic-link "fileio.c")
1217
1218 (defvar dired-keep-marker-relsymlink ?S
1219   "See variable `dired-keep-marker-move'.")
1220
1221 (defun dired-make-relative-symlink (file1 file2 &optional ok-if-already-exists)
1222   "Make a symbolic link (pointing to FILE1) in FILE2.
1223 The link is relative (if possible), for example
1224
1225     \"/vol/tex/bin/foo\" \"/vol/local/bin/foo\"
1226
1227 results in
1228
1229     \"../../tex/bin/foo\" \"/vol/local/bin/foo\""
1230   (interactive "FRelSymLink: \nFRelSymLink %s: \np")
1231   (let (name1 name2 len1 len2 (index 0) sub)
1232     (setq file1 (expand-file-name file1)
1233           file2 (expand-file-name file2)
1234           len1 (length file1)
1235           len2 (length file2))
1236     ;; Find common initial file name components:
1237     (let (next)
1238       (while (and (setq next (string-match "/" file1 index))
1239                   (setq next (1+ next))
1240                   (< next (min len1 len2))
1241                   ;; For the comparison, both substrings must end in
1242                   ;; `/', so NEXT is *one plus* the result of the
1243                   ;; string-match.
1244                   ;; E.g., consider the case of linking "/tmp/a/abc"
1245                   ;; to "/tmp/abc" erroneously giving "/tmp/a" instead
1246                   ;; of "/tmp/" as common initial component
1247                   (string-equal (substring file1 0 next)
1248                                 (substring file2 0 next)))
1249         (setq index next))
1250       (setq name2 file2
1251             sub (substring file1 0 index)
1252             name1 (substring file1 index)))
1253     (if (string-equal sub "/")
1254         ;; No common initial file name found
1255         (setq name1 file1)
1256       ;; Else they have a common parent directory
1257       (let ((tem (substring file2 index))
1258             (start 0)
1259             (count 0))
1260         ;; Count number of slashes we must compensate for ...
1261         (while (setq start (string-match "/" tem start))
1262           (setq count (1+ count)
1263                 start (1+ start)))
1264         ;; ... and prepend a "../" for each slash found:
1265         (while (> count 0)
1266           (setq count (1- count)
1267                 name1 (concat "../" name1)))))
1268     (make-symbolic-link
1269      (directory-file-name name1)        ; must not link to foo/
1270                                         ; (trailing slash!)
1271      name2 ok-if-already-exists)))
1272
1273 ;;;###autoload
1274 (defun dired-do-relsymlink (&optional arg)
1275    "Relative symlink all marked (or next ARG) files into a directory.
1276 Otherwise make a relative symbolic link to the current file.
1277 This creates relative symbolic links like
1278
1279     foo -> ../bar/foo
1280
1281 not absolute ones like
1282
1283     foo -> /ugly/file/name/that/may/change/any/day/bar/foo
1284
1285 For absolute symlinks, use \\[dired-do-symlink]."
1286   (interactive "P")
1287   (dired-do-create-files 'relsymlink (function dired-make-relative-symlink)
1288                            "RelSymLink" arg dired-keep-marker-relsymlink))
1289
1290 (defun dired-do-relsymlink-regexp (regexp newname &optional arg whole-name)
1291   "RelSymlink all marked files containing REGEXP to NEWNAME.
1292 See functions `dired-do-rename-regexp' and `dired-do-relsymlink'
1293 for more info."
1294   (interactive (dired-mark-read-regexp "RelSymLink"))
1295   (dired-do-create-files-regexp
1296    (function dired-make-relative-symlink)
1297    "RelSymLink" arg regexp newname whole-name dired-keep-marker-relsymlink))
1298
1299 \f
1300 ;;; VISIT ALL MARKED FILES SIMULTANEOUSLY.
1301
1302 ;;; Brief Description:
1303 ;;;
1304 ;;; `dired-do-find-marked-files' is bound to `F' by dired-x.el.
1305 ;;;
1306 ;;; * Use `dired-get-marked-files' to collect the marked files in the current
1307 ;;;   Dired Buffer into a list of filenames `FILE-LIST'.
1308 ;;;
1309 ;;; * Pass FILE-LIST to `dired-simultaneous-find-file' all with
1310 ;;;   `dired-do-find-marked-files''s prefix argument NOSELECT.
1311 ;;;
1312 ;;; * `dired-simultaneous-find-file' runs through FILE-LIST decrementing the
1313 ;;;   list each time.
1314 ;;;
1315 ;;; * If NOSELECT is non-nil then just run `find-file-noselect'  on each
1316 ;;;   element of FILE-LIST.
1317 ;;;
1318 ;;; * If NOSELECT is nil then calculate the `size' of the window for each file
1319 ;;;   by dividing the `window-height' by length of FILE-LIST.  Thus, `size' is
1320 ;;;   cognizant of the window-configuration.
1321 ;;;
1322 ;;; * If `size' is too small abort, otherwise run `find-file' on each element
1323 ;;;   of FILE-LIST giving each a window of height `size'.
1324
1325 (defun dired-do-find-marked-files (&optional noselect)
1326   "Find all marked files displaying all of them simultaneously.
1327 With optional NOSELECT just find files but do not select them.
1328
1329 The current window is split across all files marked, as evenly as possible.
1330 Remaining lines go to bottom-most window.  The number of files that can be
1331 displayed this way is restricted by the height of the current window and
1332 `window-min-height'.
1333
1334 To keep dired buffer displayed, type \\[split-window-vertically] first.
1335 To display just marked files, type \\[delete-other-windows] first."
1336
1337   (interactive "P")
1338   (dired-simultaneous-find-file (dired-get-marked-files) noselect))
1339
1340 (defun dired-simultaneous-find-file (file-list noselect)
1341
1342   "Visit all files in FILE-LIST and display them simultaneously.
1343 The current window is split across all files in FILE-LIST, as evenly as
1344 possible.  Remaining lines go to the bottom-most window.  The number of
1345 files that can be displayed this way is restricted by the height of the
1346 current window and the variable `window-min-height'.  With non-nil
1347 NOSELECT the files are merely found but not selected."
1348
1349   ;; We don't make this function interactive because it is usually too clumsy
1350   ;; to specify FILE-LIST interactively unless via dired.
1351
1352   (let (size)
1353
1354     (if noselect
1355         ;; Do not select the buffer.
1356         (find-file-noselect (car file-list))
1357
1358       ;; We will have to select the buffer.  Calculate and check window size.
1359       (setq size (/ (window-height) (length file-list)))
1360       (or (<= window-min-height size)
1361           (error "Too many files to visit simultaneously.  Try C-u prefix"))
1362       (find-file (car file-list)))
1363
1364     ;; Decrement.
1365     (setq file-list (cdr file-list))
1366
1367     (while file-list
1368
1369       (if noselect
1370           ;; Do not select the buffer.
1371           (find-file-noselect (car file-list))
1372
1373         ;; Vertically split off a window of desired size.  Upper window will
1374         ;; have SIZE lines.  Select lower (larger) window.  We split it again.
1375         (select-window (split-window nil size))
1376         (find-file (car file-list)))
1377
1378       ;; Decrement.
1379       (setq file-list (cdr file-list)))))
1380
1381 \f
1382 ;;; MISCELLANEOUS COMMANDS.
1383
1384 ;;; Run man on files.
1385
1386 (defun dired-man ()
1387   "Run man on this file.  Display old buffer if buffer name matches filename.
1388 Uses `man.el' of \\[manual-entry] fame."
1389   (interactive)
1390   (require 'man)
1391   (let* ((file (dired-get-filename))
1392          (manual-program (replace-regexp-in-string "\\*" "%s"
1393                           (dired-guess-shell-command
1394                            "Man command: " (list file)))))
1395     (Man-getpage-in-background file)))
1396
1397 ;;; Run Info on files.
1398
1399 (defun dired-info ()
1400   "Run info on this file."
1401   (interactive)
1402   (info (dired-get-filename)))
1403
1404 ;;; Run mail on mail folders.
1405
1406 ;; Avoid compiler warning.
1407 (eval-when-compile
1408   (when (not (fboundp 'vm-visit-folder))
1409     (defun vm-visit-folder (file &optional arg)
1410       nil)))
1411
1412 (defun dired-vm (&optional read-only)
1413   "Run VM on this file.
1414 With prefix arg, visit folder read-only (this requires at least VM 5).
1415 See also variable `dired-vm-read-only-folders'."
1416   (interactive "P")
1417   (let ((dir (dired-current-directory))
1418         (fil (dired-get-filename)))
1419     ;; take care to supply 2nd arg only if requested - may still run VM 4!
1420     (cond (read-only (vm-visit-folder fil t))
1421           ((eq t dired-vm-read-only-folders) (vm-visit-folder fil t))
1422           ((null dired-vm-read-only-folders) (vm-visit-folder fil))
1423           (t (vm-visit-folder fil (not (file-writable-p fil)))))
1424     ;; so that pressing `v' inside VM does prompt within current directory:
1425     (set (make-local-variable 'vm-folder-directory) dir)))
1426
1427 (defun dired-rmail ()
1428   "Run RMAIL on this file."
1429   (interactive)
1430   (rmail (dired-get-filename)))
1431
1432 (defun dired-do-run-mail ()
1433   "If `dired-bind-vm' is t, then function `dired-vm', otherwise `dired-rmail'."
1434   (interactive)
1435   (if dired-bind-vm
1436       ;; Read mail folder using vm.
1437       (dired-vm)
1438     ;; Read mail folder using rmail.
1439     (dired-rmail)))
1440
1441 \f
1442 ;;; MISCELLANEOUS INTERNAL FUNCTIONS.
1443
1444 (declare-function dired-old-find-buffer-nocreate "dired-x")
1445
1446 (or (fboundp 'dired-old-find-buffer-nocreate)
1447     (fset 'dired-old-find-buffer-nocreate
1448           (symbol-function 'dired-find-buffer-nocreate)))
1449
1450 ;;; REDEFINE.
1451 ;;; Redefines dired.el's version of `dired-find-buffer-nocreate'
1452 (defun dired-find-buffer-nocreate (dirname &optional mode)
1453   (if (and dired-find-subdir
1454            ;; don't try to find a wildcard as a subdirectory
1455            (string-equal dirname (file-name-directory dirname)))
1456       (let* ((cur-buf (current-buffer))
1457              (buffers (nreverse
1458                        (dired-buffers-for-dir (expand-file-name dirname))))
1459              (cur-buf-matches (and (memq cur-buf buffers)
1460                                    ;; wildcards must match, too:
1461                                    (equal dired-directory dirname))))
1462         ;; We don't want to switch to the same buffer---
1463         (setq buffers (delq cur-buf buffers));;need setq with delq
1464         (or (car (sort buffers (function dired-buffer-more-recently-used-p)))
1465             ;; ---unless it's the only possibility:
1466             (and cur-buf-matches cur-buf)))
1467     (dired-old-find-buffer-nocreate dirname mode)))
1468
1469 ;; This should be a builtin
1470 (defun dired-buffer-more-recently-used-p (buffer1 buffer2)
1471   "Return t if BUFFER1 is more recently used than BUFFER2."
1472   (if (equal buffer1 buffer2)
1473       nil
1474     (let ((more-recent nil)
1475           (list (buffer-list)))
1476       (while (and list
1477                   (not (setq more-recent (equal buffer1 (car list))))
1478                   (not (equal buffer2 (car list))))
1479         (setq list (cdr list)))
1480       more-recent)))
1481
1482 ;;; Same thing as `dired-buffers-for-dir' of dired.el? - lrd 11/23/93
1483 ;;; (defun dired-buffers-for-dir-exact (dir)
1484 ;;; ;; Return a list of buffers that dired DIR (a directory or wildcard)
1485 ;;; ;; at top level, or as subdirectory.
1486 ;;; ;; Top level matches must match the wildcard part too, if any.
1487 ;;; ;; The list is in reverse order of buffer creation, most recent last.
1488 ;;; ;; As a side effect, killed dired buffers for DIR are removed from
1489 ;;; ;; dired-buffers.
1490 ;;;   (let ((alist dired-buffers) result elt)
1491 ;;;     (while alist
1492 ;;;       (setq elt (car alist)
1493 ;;;             alist (cdr alist))
1494 ;;;       (let ((buf (cdr elt)))
1495 ;;;         (if (buffer-name buf)
1496 ;;;             ;; Top level must match exactly against dired-directory in
1497 ;;;             ;; case one of them is a wildcard.
1498 ;;;             (if (or (equal dir (save-excursion (set-buffer buf)
1499 ;;;                                                dired-directory))
1500 ;;;                     (assoc dir (save-excursion (set-buffer buf)
1501 ;;;                                                dired-subdir-alist)))
1502 ;;;                 (setq result (cons buf result)))
1503 ;;;           ;; else buffer is killed - clean up:
1504 ;;;           (setq dired-buffers (delq elt dired-buffers)))))
1505 ;;;     result))
1506
1507 ;;; REDEFINE.
1508 ;;; Redefines dired.el's version of `dired-initial-position'
1509 (defun dired-initial-position (dirname)
1510   "Where point should go in a new listing of DIRNAME.
1511 Point assumed at beginning of new subdir line.
1512 You may redefine this function as you wish, e.g. like in `dired-x.el'."
1513   (end-of-line)
1514   (if dired-find-subdir (dired-goto-subdir dirname)) ; new
1515   (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1516
1517 \f
1518 ;; Does anyone use this? - lrd 6/29/93.
1519 ;; Apparently people do use it. - lrd 12/22/97.
1520 (defun dired-mark-sexp (predicate &optional unflag-p)
1521   "Mark files for which PREDICATE returns non-nil.
1522 With a prefix arg, unflag those files instead.
1523
1524 PREDICATE is a lisp expression that can refer to the following symbols:
1525
1526     inode  [integer] the inode of the file (only for ls -i output)
1527     s      [integer] the size of the file for ls -s output
1528                      (usually in blocks or, with -k, in KByte)
1529     mode   [string]  file permission bits, e.g. \"-rw-r--r--\"
1530     nlink  [integer] number of links to file
1531     uid    [string]  owner
1532     gid    [string]  group  (If the gid is not displayed by ls,
1533                      this will still be set (to the same as uid))
1534     size   [integer] file size in bytes
1535     time   [string]  the time that ls displays, e.g. \"Feb 12 14:17\"
1536     name   [string]  the name of the file
1537     sym    [string]  if file is a symbolic link, the linked-to name, else \"\"
1538
1539 For example, use
1540
1541         (equal 0 size)
1542
1543 to mark all zero length files."
1544   ;; Using sym="" instead of nil avoids the trap of
1545   ;; (string-match "foo" sym) into which a user would soon fall.
1546   ;; Give `equal' instead of `=' in the example, as this works on
1547   ;; integers and strings.
1548   (interactive "xMark if (lisp expr): \nP")
1549   (message "%s" predicate)
1550   (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char))
1551         inode s mode nlink uid gid size time name sym)
1552     (dired-mark-if
1553      (save-excursion
1554        (and
1555         ;; Sets vars
1556         ;;                inode s mode nlink uid gid size time name sym
1557
1558         ;; according to current file line.  Returns t for success, nil if
1559         ;; there is no file line.  Upon success, all variables are set, either
1560         ;; to nil or the appropriate value, so they need not be initialized.
1561         ;; Moves point within the current line.
1562         (if (dired-move-to-filename)
1563             (let (pos
1564                   (mode-len 10) ; length of mode string
1565                   ;; like in dired.el, but with subexpressions \1=inode, \2=s:
1566                   (dired-re-inode-size "\\s *\\([0-9]*\\)\\s *\\([0-9]*\\) ?"))
1567               (beginning-of-line)
1568               (forward-char 2)
1569               (if (looking-at dired-re-inode-size)
1570                   (progn
1571                     (goto-char (match-end 0))
1572                     (setq inode (string-to-number (buffer-substring (match-beginning 1)
1573                                                                     (match-end 1)))
1574                           s (string-to-number (buffer-substring (match-beginning 2)
1575                                                                 (match-end 2)))))
1576                 (setq inode nil
1577                       s nil))
1578               (setq mode (buffer-substring (point) (+ mode-len (point))))
1579               (forward-char mode-len)
1580               (setq nlink (read (current-buffer)))
1581               ;; Karsten Wenger <kw@cis.uni-muenchen.de> fixed uid.
1582               (setq uid (buffer-substring (+ (point) 1)
1583                                           (progn (forward-word 1) (point))))
1584               (re-search-forward directory-listing-before-filename-regexp)
1585               (goto-char (match-beginning 1))
1586               (forward-char -1)
1587               (setq size (string-to-number (buffer-substring (save-excursion
1588                                                                (backward-word 1)
1589                                                                (setq pos (point)))
1590                                                              (point))))
1591               (goto-char pos)
1592               (backward-word 1)
1593               ;; if no gid is displayed, gid will be set to uid
1594               ;; but user will then not reference it anyway in PREDICATE.
1595               (setq gid (buffer-substring (save-excursion
1596                                             (forward-word 1) (point))
1597                                           (point))
1598                     time (buffer-substring (match-beginning 1)
1599                                            (1- (dired-move-to-filename)))
1600                     name (buffer-substring (point)
1601                                            (or
1602                                             (dired-move-to-end-of-filename t)
1603                                             (point)))
1604                     sym  (progn
1605                            (if (looking-at " -> ")
1606                                (buffer-substring
1607                                 (progn (forward-char 4) (point))
1608                                 (progn (end-of-line) (point)))
1609                              "")))
1610               t)
1611           nil)
1612                       (eval predicate)))
1613      (format "'%s file" predicate))))
1614
1615 \f
1616 ;;; FIND FILE AT POINT.
1617
1618 (defvar dired-x-hands-off-my-keys t
1619   "*Non-nil means don't bind `dired-x-find-file' over `find-file' on keyboard.
1620 Similarly for `dired-x-find-file-other-window' over `find-file-other-window'.
1621 If you change this variable after `dired-x.el' is loaded then do
1622 \\[dired-x-bind-find-file].")
1623
1624 ;;; Bind `dired-x-find-file{-other-window}' over wherever
1625 ;;; `find-file{-other-window}' is bound?
1626 (defun dired-x-bind-find-file ()
1627   "Bind `dired-x-find-file' in place of `find-file' \(or reverse\).
1628 Similarly for `dired-x-find-file-other-window' and `find-file-other-window'.
1629 Binding direction based on `dired-x-hands-off-my-keys'.
1630 This function is part of `after-init-hook'."
1631   (interactive)
1632   (if (interactive-p)
1633       (setq dired-x-hands-off-my-keys
1634             (not (y-or-n-p "Bind dired-x-find-file over find-file? "))))
1635   (cond ((not dired-x-hands-off-my-keys)
1636          (substitute-key-definition 'find-file
1637                                     'dired-x-find-file
1638                                     (current-global-map))
1639          (substitute-key-definition 'find-file-other-window
1640                                     'dired-x-find-file-other-window
1641                                     (current-global-map)))
1642         (t
1643          (substitute-key-definition 'dired-x-find-file
1644                                     'find-file
1645                                     (current-global-map))
1646          (substitute-key-definition 'dired-x-find-file-other-window
1647                                     'find-file-other-window
1648                                     (current-global-map))))
1649   ;; Clear mini-buffer.
1650   (message nil))
1651
1652 ;;; Now call it so binding is correct and put on `after-init-hook' in case
1653 ;;; user changes binding.
1654 (dired-x-bind-find-file)
1655 (add-hook 'after-init-hook 'dired-x-bind-find-file)
1656
1657 (defun dired-x-find-file (filename)
1658   "Edit file FILENAME.
1659 May create a new window, or reuse an existing one.
1660 See the function `display-buffer'.
1661
1662 Identical to `find-file' except when called interactively, with a prefix arg
1663 \(e.g., \\[universal-argument]\), in which case it guesses filename near point.
1664 Useful for editing file mentioned in buffer you are viewing,
1665 or to test if that file exists.  Use minibuffer after snatching filename."
1666   (interactive (list (read-filename-at-point "Find file: ")))
1667   (find-file (expand-file-name filename)))
1668
1669 (defun dired-x-find-file-other-window (filename)
1670   "Edit file FILENAME, in another window.
1671 May create a new window, or reuse an existing one.
1672 See the function `display-buffer'.
1673
1674 Identical to `find-file-other-window' except when called interactively, with a
1675 prefix arg \(e.g., \\[universal-argument]\), in which case it guesses filename near point.
1676 Useful for editing file mentioned in buffer you are viewing,
1677 or to test if that file exists.  Use minibuffer after snatching filename."
1678   (interactive (list (read-filename-at-point "Find file: ")))
1679   (find-file-other-window (expand-file-name filename)))
1680
1681 ;;; Internal functions.
1682
1683 ;; Fixme: This should probably use `thing-at-point'.  -- fx
1684 (defun dired-filename-at-point ()
1685   "Get the filename closest to point, but do not change position.
1686 Has a preference for looking backward when not directly on a symbol.  Not
1687 perfect - point must be in middle of or end of filename."
1688
1689   (let ((filename-chars "-.[:alnum:]_/:$+@")
1690         start end filename prefix)
1691
1692     (save-excursion
1693       ;; First see if just past a filename.
1694       (if (not (eobp))
1695           (if (looking-at "[] \t\n[{}()]") ; whitespace or some parens
1696               (progn
1697                 (skip-chars-backward " \n\t\r({[]})")
1698                 (if (not (bobp))
1699                     (backward-char 1)))))
1700
1701       (if (string-match (concat "[" filename-chars "]")
1702                         (char-to-string (following-char)))
1703           (progn
1704             (if (re-search-backward (concat "[^" filename-chars "]") nil t)
1705                 (forward-char)
1706               (goto-char (point-min)))
1707             (setq start (point))
1708             (setq prefix
1709                   (and (string-match
1710                         "^\\w+@"
1711                         (buffer-substring start (line-beginning-position)))
1712                        "/"))
1713             (goto-char start)
1714             (if (string-match "[/~]" (char-to-string (preceding-char)))
1715                 (setq start (1- start)))
1716             (re-search-forward (concat "\\=[" filename-chars "]*") nil t))
1717
1718         (error "No file found around point!"))
1719
1720       ;; Return string.
1721       (expand-file-name (concat prefix (buffer-substring start (point)))))))
1722
1723 (defun read-filename-at-point (prompt)
1724   "Return filename prompting with PROMPT with completion.
1725 If `current-prefix-arg' is non-nil, uses name at point as guess."
1726   (if current-prefix-arg
1727       (let ((guess (dired-filename-at-point)))
1728         (read-file-name prompt
1729                         (file-name-directory guess)
1730                         guess
1731                         nil (file-name-nondirectory guess)))
1732     (read-file-name prompt default-directory)))
1733 \f
1734 ;;; BUG REPORTS
1735
1736 ;; Fixme: get rid of this later.
1737
1738 ;;; This section is provided for reports.  It uses Barry A. Warsaw's
1739 ;;; reporter.el which is bundled with GNU Emacs v19.
1740
1741 (defconst dired-x-help-address "bug-gnu-emacs@gnu.org"
1742   "Address(es) accepting submission of reports on dired-x.el.")
1743
1744 (defconst dired-x-variable-list
1745   (list
1746    'dired-bind-vm
1747    'dired-vm-read-only-folders
1748    'dired-bind-jump
1749    'dired-bind-info
1750    'dired-bind-man
1751    'dired-find-subdir
1752    'dired-enable-local-variables
1753    'dired-local-variables-file
1754    'dired-guess-shell-gnutar
1755    'dired-guess-shell-gzip-quiet
1756    'dired-guess-shell-znew-switches
1757    'dired-guess-shell-alist-user
1758    'dired-clean-up-buffers-too
1759    'dired-omit-mode
1760    'dired-omit-files
1761    'dired-omit-extensions
1762    )
1763   "List of variables to be appended to reports sent by `dired-x-submit-report'.")
1764
1765 (defun dired-x-submit-report ()
1766   "Submit via `reporter.el' a bug report on program.
1767 Send report on `dired-x-file' version `dired-x-version,' to
1768 `dired-x-maintainer' at address `dired-x-help-address' listing
1769 variables `dired-x-variable-list' in the message."
1770   (interactive)
1771
1772   (reporter-submit-bug-report
1773    dired-x-help-address                 ; address
1774    "dired-x"                            ; pkgname
1775    dired-x-variable-list                ; varlist
1776    nil nil                              ; pre-/post-hooks
1777    ""))
1778
1779 \f
1780 ;; As Barry Warsaw would say: "This might be useful..."
1781 (provide 'dired-x)
1782
1783 ;; arch-tag: 71a43ba2-7a00-4793-a028-0613dd7765ae
1784 ;;; dired-x.el ends here