code.delx.au - gnu-emacs/blob - lisp/textmodes/reftex-dcr.el

   1 ;;; reftex-dcr.el --- viewing cross references and citations with RefTeX
   2
   3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2002, 2003, 2004,
   4 ;;   2005 Free Software Foundation, Inc.
   5
   6 ;; Author: Carsten Dominik <dominik@science.uva.nl>
   7 ;; Version: 4.28
   8 ;;
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  25 ;; Boston, MA 02110-1301, USA.
  26
  27 ;;; Commentary:
  28
  29 ;;; Code:
  30
  31 (eval-when-compile (require 'cl))
  32 (provide 'reftex-dcr)
  33 (provide 'reftex-vcr)
  34 (require 'reftex)
  35 ;;;
  36
  37 (defun reftex-view-crossref (&optional arg auto-how)
  38   "View cross reference of macro at point.  Point must be on the KEY
  39 argument.  When at at `\\ref' macro, show corresponding `\\label'
  40 definition, also in external documents (`xr').  When on a label, show
  41 a locations where KEY is referenced.  Subsequent calls find additional
  42 locations.  When on a `\\cite', show the associated `\\bibitem' macro or
  43 the BibTeX database entry.  When on a `\\bibitem', show a `\\cite' macro
  44 which uses this KEY. When on an `\\index', show other locations marked
  45 by the same index entry.
  46 To define additional cross referencing items, use the option
  47 `reftex-view-crossref-extra'.  See also `reftex-view-crossref-from-bibtex'.
  48 With one or two C-u prefixes, enforce rescanning of the document.
  49 With argument 2, select the window showing the cross reference.
  50 AUTO-HOW is only for the automatic crossref display and is handed through
  51 to the functions `reftex-view-cr-cite' and `reftex-view-cr-ref'."
  52
  53   (interactive "P")
  54   ;; See where we are.
  55   (let* ((macro (car (reftex-what-macro-safe 1)))
  56          (key (reftex-this-word "^{}%\n\r, \t"))
  57          dw)
  58
  59     (if (or (null macro) (reftex-in-comment))
  60         (error "Not on a crossref macro argument"))
  61
  62     (setq reftex-call-back-to-this-buffer (current-buffer))
  63
  64     (cond
  65      ((string-match "\\`\\\\cite\\|cite\\*?\\'\\|bibentry" macro)
  66       ;; A citation macro: search for bibitems or BibTeX entries
  67       (setq dw (reftex-view-cr-cite arg key auto-how)))
  68      ((string-match "\\`\\\\ref\\|ref\\(range\\)?\\*?\\'" macro)
  69       ;; A reference macro: search for labels
  70       (setq dw (reftex-view-cr-ref arg key auto-how)))
  71      (auto-how nil)  ;; No further action for automatic display (speed)
  72      ((or (equal macro "\\label")
  73           (member macro reftex-macros-with-labels))
  74       ;; A label macro: search for reference macros
  75       (reftex-access-scan-info arg)
  76       (setq dw (reftex-view-regexp-match
  77                 (format reftex-find-reference-format (regexp-quote key))
  78                 4 nil nil)))
  79      ((equal macro "\\bibitem")
  80       ;; A bibitem macro: search for citations
  81       (reftex-access-scan-info arg)
  82       (setq dw (reftex-view-regexp-match
  83                 (format reftex-find-citation-regexp-format (regexp-quote key))
  84                 4 nil nil)))
  85      ((member macro reftex-macros-with-index)
  86       (reftex-access-scan-info arg)
  87       (setq dw (reftex-view-regexp-match
  88                 (format reftex-find-index-entry-regexp-format
  89                         (regexp-quote key))
  90                 3 nil nil)))
  91      (t
  92       (reftex-access-scan-info arg)
  93       (catch 'exit
  94         (let ((list reftex-view-crossref-extra)
  95               entry mre action group)
  96           (while (setq entry (pop list))
  97             (setq mre (car entry)
  98                   action (nth 1 entry)
  99                   group (nth 2 entry))
 100             (when (string-match mre macro)
 101               (setq dw (reftex-view-regexp-match
 102                         (format action key) group nil nil))
 103               (throw 'exit t))))
 104         (error "Not on a crossref macro argument"))))
 105     (if (and (eq arg 2) (windowp dw)) (select-window dw))))
 106
 107 (defun reftex-view-cr-cite (arg key how)
 108   ;; View crossreference of a ref cite.  HOW can have the values
 109   ;; nil:         Show in another window.
 110   ;; echo:        Show one-line info in echo area.
 111   ;; tmp-window:  Show in small window and arrange for window to disappear.
 112
 113   ;; Ensure access to scanning info
 114   (reftex-access-scan-info (or arg current-prefix-arg))
 115
 116   (if (eq how 'tmp-window)
 117       ;; Remember the window configuration
 118       (put 'reftex-auto-view-crossref 'last-window-conf
 119            (current-window-configuration)))
 120
 121   (let (files size item (pos (point)) (win (selected-window)) pop-win
 122               (bibtype (reftex-bib-or-thebib)))
 123     ;; Find the citation mode and the file list
 124     (cond
 125 ;     ((assq 'bib (symbol-value reftex-docstruct-symbol))
 126      ((eq bibtype 'bib)
 127       (setq item nil
 128             files (reftex-get-bibfile-list)))
 129 ;     ((assq 'thebib (symbol-value reftex-docstruct-symbol))
 130      ((eq bibtype 'thebib)
 131       (setq item t
 132             files (reftex-uniquify
 133                    (mapcar 'cdr
 134                            (reftex-all-assq
 135                             'thebib (symbol-value reftex-docstruct-symbol))))))
 136      (reftex-default-bibliography
 137       (setq item nil
 138             files (reftex-default-bibliography)))
 139      (how)  ;; don't throw for special display
 140      (t (error "Cannot display crossref")))
 141
 142     (if (eq how 'echo)
 143         ;; Display in Echo area
 144         (reftex-echo-cite key files item)
 145       ;; Display in a window
 146       (if (not (eq how 'tmp-window))
 147           ;; Normal display
 148           (reftex-pop-to-bibtex-entry key files nil t item)
 149         ;; A temporary window
 150         (condition-case nil
 151             (reftex-pop-to-bibtex-entry key files nil t item)
 152           (error (goto-char pos)
 153                  (message "cite: no such citation key %s" key)
 154                  (error "")))
 155         ;; Resize the window
 156         (setq size (max 1 (count-lines (point)
 157                                        (reftex-end-of-bib-entry item))))
 158         (let ((window-min-height 2))
 159           (shrink-window (1- (- (window-height) size)))
 160           (recenter 0))
 161         ;; Arrange restoration
 162         (add-hook 'pre-command-hook 'reftex-restore-window-conf))
 163
 164         ;; Normal display in other window
 165       (add-hook 'pre-command-hook 'reftex-highlight-shall-die)
 166       (setq pop-win (selected-window))
 167       (select-window win)
 168       (goto-char pos)
 169       (when (equal arg 2)
 170         (select-window pop-win)))))
 171
 172 (defun reftex-view-cr-ref (arg label how)
 173   ;; View crossreference of a ref macro.  HOW can have the values
 174   ;; nil:         Show in another window.
 175   ;; echo:        Show one-line info in echo area.
 176   ;; tmp-window:  Show in small window and arrange for window to disappear.
 177
 178   ;; Ensure access to scanning info
 179   (reftex-access-scan-info (or arg current-prefix-arg))
 180
 181   (if (eq how 'tmp-window)
 182       ;; Remember the window configuration
 183       (put 'reftex-auto-view-crossref 'last-window-conf
 184            (current-window-configuration)))
 185
 186   (let* ((xr-data (assoc 'xr (symbol-value reftex-docstruct-symbol)))
 187          (xr-re (nth 2 xr-data))
 188          (entry (assoc label (symbol-value reftex-docstruct-symbol)))
 189          (win (selected-window)) pop-win (pos (point)))
 190
 191     (if (and (not entry) (stringp label) xr-re (string-match xr-re label))
 192         ;; Label is defined in external document
 193         (save-excursion
 194           (save-match-data
 195             (set-buffer
 196              (or (reftex-get-file-buffer-force
 197                   (cdr (assoc (match-string 1 label) (nth 1
 198                                                           xr-data))))
 199                  (error "Problem with external label %s" label))))
 200           (setq label (substring label (match-end 1)))
 201           (reftex-access-scan-info)
 202           (setq entry
 203                 (assoc label (symbol-value reftex-docstruct-symbol)))))
 204     (if (eq how 'echo)
 205         ;; Display in echo area
 206         (reftex-echo-ref label entry (symbol-value reftex-docstruct-symbol))
 207       (let ((window-conf (current-window-configuration)))
 208         (condition-case nil
 209             (reftex-show-label-location entry t nil t t)
 210           (error (set-window-configuration window-conf)
 211                  (message "ref: Label %s not found" label)
 212                  (error "ref: Label %s not found" label)))) ;; 2nd is line OK
 213       (add-hook 'pre-command-hook 'reftex-highlight-shall-die)
 214
 215       (when (eq how 'tmp-window)
 216         ;; Resize window and arrange restauration
 217         (shrink-window (1- (- (window-height) 9)))
 218         (recenter '(4))
 219         (add-hook 'pre-command-hook 'reftex-restore-window-conf))
 220       (setq pop-win (selected-window))
 221       (select-window win)
 222       (goto-char pos)
 223       (when (equal arg 2)
 224         (select-window pop-win)))))
 225
 226 (defun reftex-mouse-view-crossref (ev)
 227   "View cross reference of \\ref or \\cite macro where you click.
 228 If the macro at point is a \\ref, show the corresponding label definition.
 229 If it is a \\cite, show the BibTeX database entry.
 230 If there is no such macro at point, search forward to find one.
 231 With argument, actually select the window showing the cross reference."
 232   (interactive "e")
 233   (mouse-set-point ev)
 234   (reftex-view-crossref current-prefix-arg))
 235
 236 (defun reftex-view-crossref-when-idle ()
 237   ;; Display info about crossref at point in echo area or a window.
 238   ;; This function was desigend to work with an idle timer.
 239   ;; We try to get out of here as quickly as possible if the call is useless.
 240   (and reftex-mode
 241        ;; Make sure message area is free if we need it.
 242        (or (eq reftex-auto-view-crossref 'window) (not (current-message)))
 243        ;; Make sure we are not already displaying this one
 244        (not (memq last-command '(reftex-view-crossref
 245                                  reftex-mouse-view-crossref)))
 246        ;; Quick precheck if this might be a relevant spot
 247        ;; FIXME: Can fail with backslash in comment
 248        (save-excursion
 249          (search-backward "\\" nil t)
 250          (looking-at "\\\\[a-zA-Z]*\\(cite\\|ref\\|bibentry\\)"))
 251
 252        (condition-case nil
 253            (let ((current-prefix-arg nil))
 254              (cond
 255               ((eq reftex-auto-view-crossref t)
 256                (reftex-view-crossref -1 'echo))
 257               ((eq reftex-auto-view-crossref 'window)
 258                (reftex-view-crossref -1 'tmp-window))
 259               (t nil)))
 260          (error nil))))
 261
 262 (defun reftex-restore-window-conf ()
 263   (set-window-configuration (get 'reftex-auto-view-crossref 'last-window-conf))
 264   (put 'reftex-auto-view-crossref 'last-window-conf nil)
 265   (remove-hook 'pre-command-hook 'reftex-restore-window-conf))
 266
 267 (defun reftex-echo-ref (label entry docstruct)
 268   ;; Display crossref info in echo area.
 269   (cond
 270    ((null docstruct)
 271     (message (substitute-command-keys (format reftex-no-info-message "ref"))))
 272    ((null entry)
 273     (message "ref: unknown label: %s" label))
 274    (t
 275     (when (stringp (nth 2 entry))
 276       (message "ref(%s): %s" (nth 1 entry) (nth 2 entry)))
 277     (let ((buf (get-buffer " *Echo Area*")))
 278       (when buf
 279         (save-excursion
 280           (set-buffer buf)
 281           (run-hooks 'reftex-display-copied-context-hook)))))))
 282
 283 (defun reftex-echo-cite (key files item)
 284   ;; Display citation info in echo area.
 285   (let* ((cache (assq 'bibview-cache (symbol-value reftex-docstruct-symbol)))
 286          (cache-entry (assoc key (cdr cache)))
 287          entry string buf (all-files files))
 288
 289     (if (and reftex-cache-cite-echo cache-entry)
 290         ;; We can just use the cache
 291         (setq string (cdr cache-entry))
 292
 293       ;; Need to look in the database
 294       (unless reftex-revisit-to-echo
 295         (setq files (reftex-visited-files files)))
 296
 297       (setq entry
 298             (condition-case nil
 299                 (save-excursion
 300                   (reftex-pop-to-bibtex-entry key files nil nil item t))
 301               (error
 302                (if (and files (= (length all-files) (length files)))
 303                    (message "cite: no such database entry: %s" key)
 304                  (message (substitute-command-keys
 305                            (format reftex-no-info-message "cite"))))
 306                nil)))
 307       (when entry
 308         (if item
 309             (setq string (reftex-nicify-text entry))
 310           (setq string (reftex-make-cite-echo-string
 311                         (reftex-parse-bibtex-entry entry)
 312                         reftex-docstruct-symbol)))))
 313     (unless (or (null string) (equal string ""))
 314       (message "cite: %s" string))
 315     (when (setq buf (get-buffer " *Echo Area*"))
 316       (save-excursion
 317         (set-buffer buf)
 318         (run-hooks 'reftex-display-copied-context-hook)))))
 319
 320 (defvar reftex-use-itimer-in-xemacs nil
 321   "*Non-nil means use the idle timers in XEmacs for crossref display.
 322 Currently, idle timer restart is broken and we use the post-command-hook.")
 323
 324 (defun reftex-toggle-auto-view-crossref ()
 325   "Toggle the automatic display of crossref information in the echo area.
 326 When active, leaving point idle in the argument of a \\ref or \\cite macro
 327 will display info in the echo area."
 328   (interactive)
 329   (if reftex-auto-view-crossref-timer
 330       (progn
 331         (if (featurep 'xemacs)
 332             (if reftex-use-itimer-in-xemacs
 333                 (delete-itimer reftex-auto-view-crossref-timer)
 334               (remove-hook 'post-command-hook 'reftex-start-itimer-once))
 335           (cancel-timer reftex-auto-view-crossref-timer))
 336         (setq reftex-auto-view-crossref-timer nil)
 337         (message "Automatic display of crossref information was turned off"))
 338     (setq reftex-auto-view-crossref-timer
 339           (if (featurep 'xemacs)
 340               (if reftex-use-itimer-in-xemacs
 341                   (start-itimer "RefTeX Idle Timer"
 342                                 'reftex-view-crossref-when-idle
 343                                 reftex-idle-time reftex-idle-time t)
 344                 (add-hook 'post-command-hook 'reftex-start-itimer-once)
 345                 t)
 346             (run-with-idle-timer
 347              reftex-idle-time t 'reftex-view-crossref-when-idle)))
 348     (unless reftex-auto-view-crossref
 349       (setq reftex-auto-view-crossref t))
 350     (message "Automatic display of crossref information was turned on")))
 351
 352 (defun reftex-start-itimer-once ()
 353    (and reftex-mode
 354         (not (itimer-live-p reftex-auto-view-crossref-timer))
 355         (setq reftex-auto-view-crossref-timer
 356               (start-itimer "RefTeX Idle Timer"
 357                             'reftex-view-crossref-when-idle
 358                             reftex-idle-time nil t))))
 359
 360 (defun reftex-view-crossref-from-bibtex (&optional arg)
 361   "View location in a LaTeX document which cites the BibTeX entry at point.
 362 Since BibTeX files can be used by many LaTeX documents, this function
 363 prompts upon first use for a buffer in RefTeX mode.  To reset this
 364 link to a document, call the function with with a prefix arg.
 365 Calling this function several times find successive citation locations."
 366   (interactive "P")
 367   (when arg
 368     ;; Break connection to reference buffer
 369     (put 'reftex-bibtex-view-cite-locations :ref-buffer nil))
 370   (let ((ref-buffer (get 'reftex-bibtex-view-cite-locations :ref-buffer)))
 371     ;; Establish connection to reference buffer
 372     (unless ref-buffer
 373       (setq ref-buffer
 374             (save-excursion
 375               (completing-read
 376                "Reference buffer: "
 377                (delq nil
 378                      (mapcar
 379                       (lambda (b)
 380                         (set-buffer b)
 381                         (if reftex-mode (list (buffer-name b)) nil))
 382                       (buffer-list)))
 383                nil t)))
 384       (put 'reftex-bibtex-view-cite-locations :ref-buffer ref-buffer))
 385     ;; Search for citations
 386     (bibtex-beginning-of-entry)
 387     (if (looking-at
 388          "@[a-zA-Z]+[ \t\n\r]*[{(][ \t\n\r]*\\([^, \t\r\n}]+\\)")
 389         (progn
 390           (goto-char (match-beginning 1))
 391           (reftex-view-regexp-match
 392            (format reftex-find-citation-regexp-format
 393                    (regexp-quote (match-string 1)))
 394            4 arg ref-buffer))
 395       (error "Cannot find citation key in BibTeX entry"))))
 396
 397 (defun reftex-view-regexp-match (re &optional highlight-group new ref-buffer)
 398   ;; Search for RE in current document or in the document of REF-BUFFER.
 399   ;; Continue the search, if the same re was searched last.
 400   ;; Highlight the group HIGHLIGHT-GROUP of the match.
 401   ;; When NEW is non-nil, start a new search regardless.
 402   ;; Match point is displayed in another window.
 403   ;; Upon success, returns the window which displays the match.
 404
 405   ;;; Decide if new search or continued search
 406   (let* ((oldprop (get 'reftex-view-regexp-match :props))
 407          (newprop (list (current-buffer) re))
 408          (cont (and (not new) (equal oldprop newprop)))
 409          (cnt (if cont (get 'reftex-view-regexp-match :cnt) 0))
 410          (current-window (selected-window))
 411          (window-conf (current-window-configuration))
 412          match pop-window)
 413     (switch-to-buffer-other-window (or ref-buffer (current-buffer)))
 414     ;; Search
 415     (condition-case nil
 416         (if cont
 417             (setq match (reftex-global-search-continue))
 418           (reftex-access-scan-info)
 419           (setq match (reftex-global-search re (reftex-all-document-files))))
 420       (error nil))
 421     ;; Evaluate the match.
 422     (if match
 423         (progn
 424           (put 'reftex-view-regexp-match :props newprop)
 425           (put 'reftex-view-regexp-match :cnt (incf cnt))
 426           (reftex-highlight 0 (match-beginning highlight-group)
 427                             (match-end highlight-group))
 428           (add-hook 'pre-command-hook 'reftex-highlight-shall-die)
 429           (setq pop-window (selected-window)))
 430       (put 'reftex-view-regexp-match :props nil)
 431       (or cont (set-window-configuration window-conf)))
 432     (select-window current-window)
 433     (if match
 434         (progn
 435           (message "Match Nr. %s" cnt)
 436           pop-window)
 437       (if cont
 438           (error "No further matches (total number of matches: %d)" cnt)
 439         (error "No matches")))))
 440
 441 (defvar reftex-global-search-marker (make-marker))
 442 (defun reftex-global-search (regexp file-list)
 443   ;; Start a search for REGEXP in all files of FILE-LIST
 444   (put 'reftex-global-search :file-list file-list)
 445   (put 'reftex-global-search :regexp regexp)
 446   (move-marker reftex-global-search-marker nil)
 447   (reftex-global-search-continue))
 448
 449 (defun reftex-global-search-continue ()
 450   ;; Continue a global search started with `reftex-global-search'
 451   (unless (get 'reftex-global-search :file-list)
 452     (error "No global search to continue"))
 453   (let* ((file-list (get 'reftex-global-search :file-list))
 454          (regexp (get 'reftex-global-search :regexp))
 455          (buf (or (marker-buffer reftex-global-search-marker)
 456                   (reftex-get-file-buffer-force (car file-list))))
 457          (pos (or (marker-position reftex-global-search-marker) 1))
 458          file)
 459     ;; Take up starting position
 460     (unless buf (error "No such buffer %s" buf))
 461     (switch-to-buffer buf)
 462     (widen)
 463     (goto-char pos)
 464     ;; Search and switch file if necessary
 465     (if (catch 'exit
 466           (while t
 467             (when (re-search-forward regexp nil t)
 468               (move-marker reftex-global-search-marker (point))
 469               (throw 'exit t))
 470             ;; No match - goto next file
 471             (pop file-list)
 472             (or file-list (throw 'exit nil))
 473             (setq file (car file-list)
 474                   buf (reftex-get-file-buffer-force file))
 475             (unless buf (error "Cannot access file %s" file))
 476             (put 'reftex-global-search :file-list file-list)
 477             (switch-to-buffer buf)
 478             (widen)
 479             (goto-char 1)))
 480         t
 481       (move-marker reftex-global-search-marker nil)
 482       (error "All files processed"))))
 483
 484 ;;; arch-tag: d2f52b56-744e-44ad-830d-1fc193b90eda
 485 ;;; reftex-dcr.el ends here