lisp/dired-x.el

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