lisp/dired-x.el

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