mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-12-24 10:38:38 +00:00
4f595e1504
Here is the ChangeLog of the standalone version of RefTeX without information about Makefiles and other auxiliary files. The differences to the Emacs repository are documented in the respective ChangeLog files. 2010-11-06 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-cite.el (reftex-create-bibtex-file): Make sure that entries with whitespace at various places are found. (reftex-extract-bib-entries-from-thebibliography): Remove superfluous backslash. 2010-10-16 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-cite.el (reftex-extract-bib-entries-from-thebibliography): Use `with-current-buffer'. 2010-09-14 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-cite.el (reftex-do-citation): Make it possible again to insert non-existent entries. 2010-01-30 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-base.el (reftex-syntax-table-for-bib, reftex-mode): Do not derive `reftex-syntax-table-for-bib' from `reftex-syntax-table' because parens have to retain their paren syntax in order for parsing of BibTeX entries like @book(...) to work. 2009-09-12 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-vars.el (reftex-label-alist): Doc fix. * lisp/reftex-toc.el (reftex-re-enlarge): Call `enlarge-window' only if there is something to do because in Emacs the horizontal version throws an error even if the parameter is 0. 2009-08-08 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-index.el: Suppress byte-compiler warnings. Move provide statement to end of file. * lisp/reftex-dcr.el: Suppress byte-compiler warnings. Move provide statement to end of file. * lisp/reftex-auc.el: Suppress byte-compiler warnings. * doc/reftex.texi (Imprint): Mention Wolfgang in list of contributors. * lisp/reftex-vars.el (reftex-plug-into-AUCTeX): Doc fix. 2009-07-05 Ralf Angeli <angeli@caeruleus.net> * doc/reftex.texi (Creating Citations): Give a hint about how to auto-revert the BibTeX database file when using external editors. * lisp/reftex-cite.el (reftex-do-citation): Save match data when asking for optional arguments. 2009-04-29 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-base.el (reftex-in-comment): Do not error out if `comment-start-skip' is not set. 2009-03-01 Wolfgang Mayer <wmayer7@gmail.com> * lisp/reftex-cite.el (reftex-all-used-citation-keys): Fix regexp to correctly extract all citations in the same line. 2008-12-29 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-vars.el (reftex-vref-is-default) (reftex-fref-is-default): Adapt doc string. (reftex-ref-style-default-list): New name for `reftex-ref-style-active-list'. Use :set instead of :repeat. (reftex-vref-is-default, reftex-fref-is-default): Adapt to new name. * lisp/reftex-base.el (reftex-tie-multifile-symbols): Add doc string. (reftex-tie-multifile-symbols): Initialize `reftex-ref-style-list'. (reftex-untie-multifile-symbols): Add doc string. (reftex-add-index-macros): Doc fix. (reftex-ref-style-activate, reftex-ref-style-toggle) (reftex-ref-style-list): New functions. (reftex-mode-menu): Use them. * lisp/reftex-sel.el (reftex-select-cycle-ref-style-internal): Use `reftex-ref-style-list' function. * lisp/reftex-ref.el (reftex-reference): Use `reftex-ref-style-list' function. * doc/reftex.texi (Referencing Labels): Simplify section about reference macro cycling. (Reference Styles, Options (Referencing Labels)): Adapt to changed implementation. 2008-12-18 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-base.el (reftex-in-comment): Deal correctly with escaped comment characters. 2008-11-30 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-vars.el (reftex-ref-style-alist): Change structure so that it is not possible to use multiple different package names within a style. (reftex-ref-style-active-list): Adapt to new structure of `reftex-ref-style-alist'. * lisp/reftex-sel.el (reftex-select-cycle-active-ref-styles): Remove. (reftex-select-cycle-ref-style-internal): Adapt to new structure of `reftex-ref-style-alist'. * lisp/reftex-ref.el: Adapt creation of `reftex-<package>-<macro>' functions to new structure of `reftex-ref-style-alist'. (reftex-reference): Adapt to new structure of `reftex-ref-style-alist'. * lisp/reftex-base.el (reftex-mode-menu): Adapt to new structure of `reftex-ref-style-alist'. * doc/reftex.texi (Options (Referencing Labels)): Adapt to new structure of `reftex-ref-style-alist'. 2008-10-16 Ralf Angeli <angeli@caeruleus.net> * doc/reftex.texi (Referencing Labels, Reference Styles): Document changes in the referencing functionality. 2008-10-15 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-vars.el (reftex-ref-style-alist): Remove the symbols for symbols for macro type distinction. Add characters for macro selection. (reftex-ref-macro-prompt): New variable. * lisp/reftex-sel.el (reftex-select-cycle-ref-style-internal): Remove code for testing macro type. (reftex-select-toggle-numref-pageref): Remove. (reftex-select-label-map): Remove binding for `reftex-select-toggle-numref-pageref'. * lisp/reftex-ref.el (reftex-reference): Prompt for a reference macro if `reftex-ref-macro-prompt' is non-nil. * lisp/reftex-base.el (reftex-select-with-char): Kill the RefTeX Select buffer when done. 2008-06-07 David Kastrup <dak@gnu.org> * lisp/reftex-base.el (reftex-remove-if): Improve performance. 2008-06-07 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-cite.el (reftex-get-string-refs): Use a regexp alternative for better performance. * doc/reftex.texi (Commands): Mention options for definition of header and footer in BibTeX files. (Options (Creating Citations)): Document `reftex-create-bibtex-header' and `reftex-create-bibtex-footer'. * lisp/reftex-cite.el (reftex-stringref-p): Remove. (reftex-get-string-refs): Do without `reftex-stringref-p' and use `reftex-remove-if' instead of the cl-based `remove-if'. (reftex-create-bibtex-file): Doc fix. * lisp/reftex-base.el (reftex-remove-if): New function. 2008-06-07 Wolfgang Mayer <wmayer7@gmail.com> * lisp/reftex-vars.el (reftex-create-bibtex-header) (reftex-create-bibtex-footer): New variables. * lisp/reftex-cite.el (reftex-parse-bibtex-entry): Accept additional optional argument `raw' and keep quotes or braces if it is non-nil. (reftex-stringref-p, reftex-get-string-refs): New functions. (reftex-create-bibtex-file): Include entries that are cross-referenced from cited entries. Include @String definitions in the resulting bib file. Add header and footer defined in `reftex-create-bibtex-header' and `reftex-create-bibtex-footer'. 2008-05-03 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-parse.el (reftex-parse-from-file): Move backward one char if a `\' was matched after a section macro. * lisp/reftex-global.el (reftex-isearch-switch-to-next-file): Use `reverse' instead of `nreverse' and `copy-list' in order to make the byte compiler happy. Get rid of unused `orig-flist' variable. * lisp/reftex-base.el (reftex-compile-variables): Revert last change. Match `\' after a section macro. (reftex-mapconcat-with-predicate): Remove. 2008-04-13 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-base.el (reftex-mapconcat-with-predicate): New function. (reftex-compile-variables): Use it. Treat environments and macros differently in the regexp for section matching. * lisp/reftex-parse.el (reftex-parse-from-file): Use beginning of match instead of end as bound. * lisp/reftex-sel.el (reftex-select-label-map): Changing binding of reference style toggling to "s" which is not already taken. * doc/reftex.texi (Reference Styles): Reflect change in key binding for toggling reference styles. Some minor changes. 2008-03-27 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-vars.el: Some whitespace, doc and checkdoc fixes. 2008-03-16 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-index.el (reftex-index-selection-or-word): Use `reftex-region-active-p'. (reftex-index-show-entry) (reftex-index-initialize-phrases-buffer) (reftex-index-phrases-apply-to-region): Sync with Emacs trunk. * lisp/reftex-dcr.el (reftex-start-itimer-once): Silence the byte compiler. * lisp/reftex-auc.el: Move `provide' call to bottom of file. * lisp/reftex-base.el: Require easymenu and define autoloads earlier to avoid compiler warnings. (reftex-region-active-p, reftex-select-with-char) (reftex-show-commentary): Sync with version in Emacs trunk. (reftex-make-overlay, reftex-overlay-put, reftex-move-overlay) (reftex-delete-overlay): Define in a way which hides the XEmacs symbols from the byte compiler. (reftex-info): Silence the byte compiler. Use `reftex.info' instead of `reftex' in order to get the correct file. 2008-03-07 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-cite.el (reftex-extract-bib-entries): Check if BibTeX file changed on disk and ask if it should be reread in case it did. 2008-03-02 Ralf Angeli <angeli@caeruleus.net> * doc/reftex.texi: Lots of small fixes. (Reference Styles): New section. (varioref (LaTeX package), fancyref (LaTeX package)): Remove. (Options (Referencing Labels)): Remove descriptions of deprecated variables `reftex-vref-is-default' and `reftex-fref-is-default'. Add descriptions for `reftex-ref-style-alist' and `reftex-ref-style-active-list'. (Referencing Labels): Update regarding reference styles. 2008-02-17 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-ref.el (reftex-format-special): Add third argument for refstyle possible to be passed, making the byte compiler happy. (reftex-reference): Pass refstyle to `reftex-format-special'. * lisp/reftex-vars.el (reftex-ref-style-active-list): Make creation of type compatible with Emacs 21. (reftex-format-ref-function): Mention third argument of special format function. * lisp/reftex-base.el (reftex-mode-menu): Make creation of Reference Style menu compatible with Emacs 21. * doc/reftex.texi: Fix some typos. 2008-01-27 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-vars.el (reftex-ref-style-active-list): Doc fix. * lisp/reftex-base.el (reftex-erase-all-selection-and-index-buffers) (reftex-access-parse-file): Use `mapc' instead of `mapcar' where return value is not used. * lisp/reftex-ref.el (reftex-offer-label-menu): Use `mapc' instead of `mapcar' where return value is not used. * lisp/reftex-sel.el (reftex-select-item, reftex-select-unmark): Use `mapc' instead of `mapcar' where return value is not used. * lisp/reftex-vars.el (reftex-ref-style-alist) (reftex-ref-style-active-list): New variables. (reftex-vref-is-default, reftex-fref-is-default): Adapt doc string to new implementation. Mark as obsolete. Add compatibility code for honoring the variable values in case they are set. * lisp/reftex-base.el (reftex-mode-menu): Reference styles are now computed from `reftex-ref-style-alist'. Fix typo. * lisp/reftex-ref.el (reftex-reference): Determine reference macro by looking at `reftex-ref-style-active-list' and `reftex-ref-style-alist'. Use only one special format function. (reftex-varioref-vref, reftex-fancyref-fref) (reftex-fancyref-Fref): Remove definitions. The functions are now generated from `reftex-ref-style-alist'. (reftex-format-vref, reftex-format-Fref, reftex-format-fref): Remove. (reftex-format-special): New function. * lisp/reftex-sel.el (reftex-select-toggle-varioref) (reftex-select-toggle-fancyref): Remove. (reftex-select-cycle-active-ref-styles) (reftex-select-cycle-ref-style-internal) (reftex-select-cycle-ref-style-forward) (reftex-select-cycle-ref-style-backward) (reftex-select-toggle-numref-pageref): New functions. (reftex-select-label-map): Use `v' and `V' for general cycling through reference styles. Add `p' for switching between number and page reference types. 2008-01-06 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-cite.el (reftex-pop-to-bibtex-entry) (reftex-extract-bib-entries-from-thebibliography): Match \bibitem entries with spaces or tabs in front of arguments. (reftex-insert-bib-matches): Use `mapc' instead of `mapcar' because return value is not used. 2008-01-05 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-toc.el (reftex-make-separate-toc-frame): Hide non-operational call to `focus-frame' in Emacs for the compilers's sake. 2008-01-03 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-dcr.el (reftex-mouse-view-crossref): Explain why point is set. * lisp/reftex-toc.el (reftex-toc-do-promote): Use `mapc' instead of `mapcar' because return value is not used. (reftex-toggle-auto-toc-recenter): Fix typo. * lisp/reftex-cite.el (reftex-do-citation): Use `mapc' instead of `mapcar' because return value is not used. 2007-10-10 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-vars.el (reftex-cite-format-builtin) (reftex-bibliography-commands): Add support for ConTeXt. * doc/reftex.texi (Citation Styles): Mention support for ConTeXt. 2007-08-23 Ralf Angeli <angeli@caeruleus.net> * doc/reftex.texi (Options (Defining Label Environments)): Fix typo. 2007-07-22 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-base.el (reftex-set-cite-format): Autoload. (reftex-access-parse-file): Create parse file in a way that does not interfere with recentf mode. (reftex-access-parse-file): Do not risk destroying an existing buffer. 2007-07-07 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-parse.el (reftex-nth-arg): Use `forward-comment' instead of `comment-forward'. The latter is not always available and the former is sufficient for LaTeX. (reftex-nth-arg): Revert last change since moving over whitespace and comments is done by `reftex-move-to-next-arg'. 2007-05-20 Ralf Angeli <angeli@caeruleus.net> * doc/reftex.texi (Citation Styles): Correct some mistakes. 2007-04-03 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-cite.el: Delete trailing whitespace. (reftex-pop-to-bibtex-entry, reftex-extract-bib-entries) (reftex-parse-bibtex-entry, reftex-create-bibtex-file): Match entries containing numbers and symbol constituents. 2007-03-28 Ralf Angeli <angeli@caeruleus.net> * doc/reftex.texi: Replace BibTeX by @BibTeX{} throughout the file. 2007-03-12 John Paul Wallington <jpw@pobox.com> * lisp/reftex-vars.el (reftex-format-ref-function) (reftex-format-cite-function): Fix custom type. 2007-03-10 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-base.el: Remove information in comment already in imprint or cluttering output of `finder-commentary'. Require reftex.el. * lisp/reftex.el: Remove. Now generated from reftex.el.in. * lisp/reftex-dcr.el: Remove version info in header. Add maintainer info. * lisp/reftex-global.el Remove version info in header. Add maintainer info. * lisp/reftex-index.el Remove version info in header. Add maintainer info. * lisp/reftex-parse.el Remove version info in header. Add maintainer info. * lisp/reftex-ref.el Remove version info in header. Add maintainer info. * lisp/reftex-sel.el Remove version info in header. Add maintainer info. * lisp/reftex-toc.el Remove version info in header. Add maintainer info. * lisp/reftex-vars.el Remove version info in header. Add maintainer info. 2007-03-08 Ralf Angeli <angeli@caeruleus.net> * doc/reftex.texi: Include macros.texi and version.texi. Change maintainer and version information. Express TeX, LaTeX, AUCTeX and RefTeX with macros. (Imprint): Change maintainer information. 2007-03-04 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex.el: Update. * lisp/reftex-base.el (reftex-show-commentary): Look in reftex-base.el. (reftex-report-bug): New function. * lisp/reftex.el: Move original content to reftex-base.el. Add new header and automatically generated autoloads. * lisp/reftex-base.el: New file. Insert original content of reftex.el. Remove autoload for `reftex-index-phrases-mode'. Delete trailing whitespace. 2007-02-26 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-index.el (reftex-index-visit-phrases-buffer): Set marker when visiting buffer. This allows for returning from the phrases file to the file one was just editing instead of the file where the last phrases was added from. 2007-02-25 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-index.el (reftex-index-phrases-syntax-table): New variable. Give ?\" punctuation syntax as it usually is not used as string quote in TeX-related modes and may occur unmatched. The change also prevents fontification of quoted content. (reftex-index-phrases-mode): Use it. * lisp/reftex-cite.el (reftex-parse-bibtex-entry): Match fields containing hyphens (besides word constituents). 2007-02-25 David Kastrup <dak@gnu.org> * lisp/reftex.el (reftex-uniquify, reftex-uniquify-by-car): Replace O(n^2) algorithms with O(n log n). Introduce optional argument SORT (not yet used). TODO: figure out callers that can specify SORT, in order to further speed this up. 2007-02-25 Ralf Angeli <angeli@caeruleus.net> * lisp/reftex-vars.el (reftex-cite-key-separator): New variable. * lisp/reftex-auc.el (reftex-arg-cite): Use `reftex-cite-key-separator'. * lisp/reftex-cite.el (reftex-do-citation) (reftex-figure-out-cite-format): Use `reftex-cite-key-separator'. * doc/reftex.texi (Options (Creating Citations)): Document `reftex-cite-key-separator'. * lisp/reftex-cite.el (reftex-do-citation): Return all keys, not just the first one. * lisp/reftex-auc.el (reftex-arg-cite): Correctly handle new value type returned by `reftex-citation'. 2007-02-24 Ralf Angeli <angeli@caeruleus.net> * doc/reftex.texi: Set correct filename for standalone distribution. 2007-02-07 Ralf Angeli <angeli@caeruleus.net> Create `reftex' module.
485 lines
19 KiB
EmacsLisp
485 lines
19 KiB
EmacsLisp
;;; reftex-dcr.el --- viewing cross references and citations with RefTeX
|
|
|
|
;; Copyright (C) 1997-2012 Free Software Foundation, Inc.
|
|
|
|
;; Author: Carsten Dominik <dominik@science.uva.nl>
|
|
;; Maintainer: auctex-devel@gnu.org
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;;; Code:
|
|
|
|
(eval-when-compile (require 'cl))
|
|
|
|
(declare-function bibtex-beginning-of-entry "bibtex" ())
|
|
|
|
(require 'reftex)
|
|
|
|
(defun reftex-view-crossref (&optional arg auto-how fail-quietly)
|
|
"View cross reference of macro at point. Point must be on the KEY
|
|
argument. When at a `\\ref' macro, show corresponding `\\label'
|
|
definition, also in external documents (`xr'). When on a label, show
|
|
a locations where KEY is referenced. Subsequent calls find additional
|
|
locations. When on a `\\cite', show the associated `\\bibitem' macro or
|
|
the BibTeX database entry. When on a `\\bibitem', show a `\\cite' macro
|
|
which uses this KEY. When on an `\\index', show other locations marked
|
|
by the same index entry.
|
|
To define additional cross referencing items, use the option
|
|
`reftex-view-crossref-extra'. See also `reftex-view-crossref-from-bibtex'.
|
|
With one or two C-u prefixes, enforce rescanning of the document.
|
|
With argument 2, select the window showing the cross reference.
|
|
AUTO-HOW is only for the automatic crossref display and is handed through
|
|
to the functions `reftex-view-cr-cite' and `reftex-view-cr-ref'."
|
|
|
|
(interactive "P")
|
|
;; See where we are.
|
|
(let* ((macro (car (reftex-what-macro-safe 1)))
|
|
(key (reftex-this-word "^{}%\n\r, \t"))
|
|
dw)
|
|
|
|
(if (or (null macro) (reftex-in-comment))
|
|
(or fail-quietly
|
|
(error "Not on a crossref macro argument"))
|
|
|
|
(setq reftex-call-back-to-this-buffer (current-buffer))
|
|
|
|
(cond
|
|
((string-match "\\`\\\\cite\\|cite\\*?\\'\\|bibentry" macro)
|
|
;; A citation macro: search for bibitems or BibTeX entries
|
|
(setq dw (reftex-view-cr-cite arg key auto-how)))
|
|
((string-match "\\`\\\\ref\\|ref\\(range\\)?\\*?\\'" macro)
|
|
;; A reference macro: search for labels
|
|
(setq dw (reftex-view-cr-ref arg key auto-how)))
|
|
(auto-how nil) ;; No further action for automatic display (speed)
|
|
((or (equal macro "\\label")
|
|
(member macro reftex-macros-with-labels))
|
|
;; A label macro: search for reference macros
|
|
(reftex-access-scan-info arg)
|
|
(setq dw (reftex-view-regexp-match
|
|
(format reftex-find-reference-format (regexp-quote key))
|
|
4 nil nil)))
|
|
((equal macro "\\bibitem")
|
|
;; A bibitem macro: search for citations
|
|
(reftex-access-scan-info arg)
|
|
(setq dw (reftex-view-regexp-match
|
|
(format reftex-find-citation-regexp-format (regexp-quote key))
|
|
4 nil nil)))
|
|
((member macro reftex-macros-with-index)
|
|
(reftex-access-scan-info arg)
|
|
(setq dw (reftex-view-regexp-match
|
|
(format reftex-find-index-entry-regexp-format
|
|
(regexp-quote key))
|
|
3 nil nil)))
|
|
(t
|
|
(reftex-access-scan-info arg)
|
|
(catch 'exit
|
|
(let ((list reftex-view-crossref-extra)
|
|
entry mre action group)
|
|
(while (setq entry (pop list))
|
|
(setq mre (car entry)
|
|
action (nth 1 entry)
|
|
group (nth 2 entry))
|
|
(when (string-match mre macro)
|
|
(setq dw (reftex-view-regexp-match
|
|
(format action key) group nil nil))
|
|
(throw 'exit t))))
|
|
(error "Not on a crossref macro argument"))))
|
|
(if (and (eq arg 2) (windowp dw)) (select-window dw)))))
|
|
|
|
(defun reftex-view-cr-cite (arg key how)
|
|
;; View crossreference of a ref cite. HOW can have the values
|
|
;; nil: Show in another window.
|
|
;; echo: Show one-line info in echo area.
|
|
;; tmp-window: Show in small window and arrange for window to disappear.
|
|
|
|
;; Ensure access to scanning info
|
|
(reftex-access-scan-info (or arg current-prefix-arg))
|
|
|
|
(if (eq how 'tmp-window)
|
|
;; Remember the window configuration
|
|
(put 'reftex-auto-view-crossref 'last-window-conf
|
|
(current-window-configuration)))
|
|
|
|
(let (files size item (pos (point)) (win (selected-window)) pop-win
|
|
(bibtype (reftex-bib-or-thebib)))
|
|
;; Find the citation mode and the file list
|
|
(cond
|
|
; ((assq 'bib (symbol-value reftex-docstruct-symbol))
|
|
((eq bibtype 'bib)
|
|
(setq item nil
|
|
files (reftex-get-bibfile-list)))
|
|
; ((assq 'thebib (symbol-value reftex-docstruct-symbol))
|
|
((eq bibtype 'thebib)
|
|
(setq item t
|
|
files (reftex-uniquify
|
|
(mapcar 'cdr
|
|
(reftex-all-assq
|
|
'thebib (symbol-value reftex-docstruct-symbol))))))
|
|
(reftex-default-bibliography
|
|
(setq item nil
|
|
files (reftex-default-bibliography)))
|
|
(how) ;; don't throw for special display
|
|
(t (error "Cannot display crossref")))
|
|
|
|
(if (eq how 'echo)
|
|
;; Display in Echo area
|
|
(reftex-echo-cite key files item)
|
|
;; Display in a window
|
|
(if (not (eq how 'tmp-window))
|
|
;; Normal display
|
|
(reftex-pop-to-bibtex-entry key files nil t item)
|
|
;; A temporary window
|
|
(condition-case nil
|
|
(reftex-pop-to-bibtex-entry key files nil t item)
|
|
(error (goto-char pos)
|
|
(message "cite: no such citation key %s" key)
|
|
(error "")))
|
|
;; Resize the window
|
|
(setq size (max 1 (count-lines (point)
|
|
(reftex-end-of-bib-entry item))))
|
|
(let ((window-min-height 2))
|
|
(shrink-window (1- (- (window-height) size)))
|
|
(recenter 0))
|
|
;; Arrange restoration
|
|
(add-hook 'pre-command-hook 'reftex-restore-window-conf))
|
|
|
|
;; Normal display in other window
|
|
(add-hook 'pre-command-hook 'reftex-highlight-shall-die)
|
|
(setq pop-win (selected-window))
|
|
(select-window win)
|
|
(goto-char pos)
|
|
(when (equal arg 2)
|
|
(select-window pop-win)))))
|
|
|
|
(defun reftex-view-cr-ref (arg label how)
|
|
;; View crossreference of a ref macro. HOW can have the values
|
|
;; nil: Show in another window.
|
|
;; echo: Show one-line info in echo area.
|
|
;; tmp-window: Show in small window and arrange for window to disappear.
|
|
|
|
;; Ensure access to scanning info
|
|
(reftex-access-scan-info (or arg current-prefix-arg))
|
|
|
|
(if (eq how 'tmp-window)
|
|
;; Remember the window configuration
|
|
(put 'reftex-auto-view-crossref 'last-window-conf
|
|
(current-window-configuration)))
|
|
|
|
(let* ((xr-data (assoc 'xr (symbol-value reftex-docstruct-symbol)))
|
|
(xr-re (nth 2 xr-data))
|
|
(entry (assoc label (symbol-value reftex-docstruct-symbol)))
|
|
(win (selected-window)) pop-win (pos (point)))
|
|
|
|
(if (and (not entry) (stringp label) xr-re (string-match xr-re label))
|
|
;; Label is defined in external document
|
|
(save-excursion
|
|
(save-match-data
|
|
(set-buffer
|
|
(or (reftex-get-file-buffer-force
|
|
(cdr (assoc (match-string 1 label) (nth 1
|
|
xr-data))))
|
|
(error "Problem with external label %s" label))))
|
|
(setq label (substring label (match-end 1)))
|
|
(reftex-access-scan-info)
|
|
(setq entry
|
|
(assoc label (symbol-value reftex-docstruct-symbol)))))
|
|
(if (eq how 'echo)
|
|
;; Display in echo area
|
|
(reftex-echo-ref label entry (symbol-value reftex-docstruct-symbol))
|
|
(let ((window-conf (current-window-configuration)))
|
|
(condition-case nil
|
|
(reftex-show-label-location entry t nil t t)
|
|
(error (set-window-configuration window-conf)
|
|
(message "ref: Label %s not found" label)
|
|
(error "ref: Label %s not found" label)))) ;; 2nd is line OK
|
|
(add-hook 'pre-command-hook 'reftex-highlight-shall-die)
|
|
|
|
(when (eq how 'tmp-window)
|
|
;; Resize window and arrange restoration
|
|
(shrink-window (1- (- (window-height) 9)))
|
|
(recenter '(4))
|
|
(add-hook 'pre-command-hook 'reftex-restore-window-conf))
|
|
(setq pop-win (selected-window))
|
|
(select-window win)
|
|
(goto-char pos)
|
|
(when (equal arg 2)
|
|
(select-window pop-win)))))
|
|
|
|
(defun reftex-mouse-view-crossref (ev)
|
|
"View cross reference of \\ref or \\cite macro where you click.
|
|
If the macro at point is a \\ref, show the corresponding label definition.
|
|
If it is a \\cite, show the BibTeX database entry.
|
|
If there is no such macro at point, search forward to find one.
|
|
With argument, actually select the window showing the cross reference."
|
|
(interactive "e")
|
|
;; Make sure the referencing macro stays visible in the original window.
|
|
(mouse-set-point ev)
|
|
(reftex-view-crossref current-prefix-arg))
|
|
|
|
(defun reftex-view-crossref-when-idle ()
|
|
;; Display info about crossref at point in echo area or a window.
|
|
;; This function was designed to work with an idle timer.
|
|
;; We try to get out of here as quickly as possible if the call is useless.
|
|
(and reftex-mode
|
|
;; Make sure message area is free if we need it.
|
|
(or (eq reftex-auto-view-crossref 'window) (not (current-message)))
|
|
;; Make sure we are not already displaying this one
|
|
(not (memq last-command '(reftex-view-crossref
|
|
reftex-mouse-view-crossref)))
|
|
;; Quick precheck if this might be a relevant spot
|
|
;; `reftex-view-crossref' will do a more thorough check.
|
|
(save-excursion
|
|
(search-backward "\\" nil t)
|
|
(looking-at "\\\\[a-zA-Z]*\\(cite\\|ref\\|bibentry\\)"))
|
|
|
|
(condition-case nil
|
|
(let ((current-prefix-arg nil))
|
|
(cond
|
|
((eq reftex-auto-view-crossref t)
|
|
(reftex-view-crossref -1 'echo 'quiet))
|
|
((eq reftex-auto-view-crossref 'window)
|
|
(reftex-view-crossref -1 'tmp-window 'quiet))
|
|
(t nil)))
|
|
(error nil))))
|
|
|
|
(defun reftex-restore-window-conf ()
|
|
(set-window-configuration (get 'reftex-auto-view-crossref 'last-window-conf))
|
|
(put 'reftex-auto-view-crossref 'last-window-conf nil)
|
|
(remove-hook 'pre-command-hook 'reftex-restore-window-conf))
|
|
|
|
(defun reftex-echo-ref (label entry docstruct)
|
|
;; Display crossref info in echo area.
|
|
(cond
|
|
((null docstruct)
|
|
(message "%s"
|
|
(substitute-command-keys (format reftex-no-info-message "ref"))))
|
|
((null entry)
|
|
(message "ref: unknown label: %s" label))
|
|
(t
|
|
(when (stringp (nth 2 entry))
|
|
(message "ref(%s): %s" (nth 1 entry) (nth 2 entry)))
|
|
(let ((buf (get-buffer " *Echo Area*")))
|
|
(when buf
|
|
(with-current-buffer buf
|
|
(run-hooks 'reftex-display-copied-context-hook)))))))
|
|
|
|
(defun reftex-echo-cite (key files item)
|
|
;; Display citation info in echo area.
|
|
(let* ((cache (assq 'bibview-cache (symbol-value reftex-docstruct-symbol)))
|
|
(cache-entry (assoc key (cdr cache)))
|
|
entry string buf (all-files files))
|
|
|
|
(if (and reftex-cache-cite-echo cache-entry)
|
|
;; We can just use the cache
|
|
(setq string (cdr cache-entry))
|
|
|
|
;; Need to look in the database
|
|
(unless reftex-revisit-to-echo
|
|
(setq files (reftex-visited-files files)))
|
|
|
|
(setq entry
|
|
(condition-case nil
|
|
(save-excursion
|
|
(reftex-pop-to-bibtex-entry key files nil nil item t))
|
|
(error
|
|
(if (and files (= (length all-files) (length files)))
|
|
(message "cite: no such database entry: %s" key)
|
|
(message "%s" (substitute-command-keys
|
|
(format reftex-no-info-message "cite"))))
|
|
nil)))
|
|
(when entry
|
|
(if item
|
|
(setq string (reftex-nicify-text entry))
|
|
(setq string (reftex-make-cite-echo-string
|
|
(reftex-parse-bibtex-entry entry)
|
|
reftex-docstruct-symbol)))))
|
|
(unless (or (null string) (equal string ""))
|
|
(message "cite: %s" string))
|
|
(when (setq buf (get-buffer " *Echo Area*"))
|
|
(with-current-buffer buf
|
|
(run-hooks 'reftex-display-copied-context-hook)))))
|
|
|
|
(defvar reftex-use-itimer-in-xemacs nil
|
|
"Non-nil means use the idle timers in XEmacs for crossref display.
|
|
Currently, idle timer restart is broken and we use the post-command-hook.")
|
|
|
|
(defun reftex-toggle-auto-view-crossref ()
|
|
"Toggle the automatic display of crossref information in the echo area.
|
|
When active, leaving point idle in the argument of a \\ref or \\cite macro
|
|
will display info in the echo area."
|
|
(interactive)
|
|
(if reftex-auto-view-crossref-timer
|
|
(progn
|
|
(if (featurep 'xemacs)
|
|
(if reftex-use-itimer-in-xemacs
|
|
(delete-itimer reftex-auto-view-crossref-timer)
|
|
(remove-hook 'post-command-hook 'reftex-start-itimer-once))
|
|
(cancel-timer reftex-auto-view-crossref-timer))
|
|
(setq reftex-auto-view-crossref-timer nil)
|
|
(message "Automatic display of crossref information was turned off"))
|
|
(setq reftex-auto-view-crossref-timer
|
|
(if (featurep 'xemacs)
|
|
(if reftex-use-itimer-in-xemacs
|
|
(start-itimer "RefTeX Idle Timer"
|
|
'reftex-view-crossref-when-idle
|
|
reftex-idle-time reftex-idle-time t)
|
|
(add-hook 'post-command-hook 'reftex-start-itimer-once)
|
|
t)
|
|
(run-with-idle-timer
|
|
reftex-idle-time t 'reftex-view-crossref-when-idle)))
|
|
(unless reftex-auto-view-crossref
|
|
(setq reftex-auto-view-crossref t))
|
|
(message "Automatic display of crossref information was turned on")))
|
|
|
|
(defun reftex-start-itimer-once ()
|
|
(and (featurep 'xemacs)
|
|
reftex-mode
|
|
(not (itimer-live-p reftex-auto-view-crossref-timer))
|
|
(setq reftex-auto-view-crossref-timer
|
|
(start-itimer "RefTeX Idle Timer"
|
|
'reftex-view-crossref-when-idle
|
|
reftex-idle-time nil t))))
|
|
|
|
(defun reftex-view-crossref-from-bibtex (&optional arg)
|
|
"View location in a LaTeX document which cites the BibTeX entry at point.
|
|
Since BibTeX files can be used by many LaTeX documents, this function
|
|
prompts upon first use for a buffer in RefTeX mode. To reset this
|
|
link to a document, call the function with a prefix arg.
|
|
Calling this function several times find successive citation locations."
|
|
(interactive "P")
|
|
(when arg
|
|
;; Break connection to reference buffer
|
|
(put 'reftex-bibtex-view-cite-locations :ref-buffer nil))
|
|
(let ((ref-buffer (get 'reftex-bibtex-view-cite-locations :ref-buffer)))
|
|
;; Establish connection to reference buffer
|
|
(unless ref-buffer
|
|
(setq ref-buffer
|
|
(save-current-buffer
|
|
(completing-read
|
|
"Reference buffer: "
|
|
(delq nil
|
|
(mapcar
|
|
(lambda (b)
|
|
(set-buffer b)
|
|
(if reftex-mode (list (buffer-name b)) nil))
|
|
(buffer-list)))
|
|
nil t)))
|
|
(put 'reftex-bibtex-view-cite-locations :ref-buffer ref-buffer))
|
|
;; Search for citations
|
|
(bibtex-beginning-of-entry)
|
|
(if (looking-at
|
|
"@[a-zA-Z]+[ \t\n\r]*[{(][ \t\n\r]*\\([^, \t\r\n}]+\\)")
|
|
(progn
|
|
(goto-char (match-beginning 1))
|
|
(reftex-view-regexp-match
|
|
(format reftex-find-citation-regexp-format
|
|
(regexp-quote (match-string 1)))
|
|
4 arg ref-buffer))
|
|
(error "Cannot find citation key in BibTeX entry"))))
|
|
|
|
(defun reftex-view-regexp-match (re &optional highlight-group new ref-buffer)
|
|
;; Search for RE in current document or in the document of REF-BUFFER.
|
|
;; Continue the search, if the same re was searched last.
|
|
;; Highlight the group HIGHLIGHT-GROUP of the match.
|
|
;; When NEW is non-nil, start a new search regardless.
|
|
;; Match point is displayed in another window.
|
|
;; Upon success, returns the window which displays the match.
|
|
|
|
;;; Decide if new search or continued search
|
|
(let* ((oldprop (get 'reftex-view-regexp-match :props))
|
|
(newprop (list (current-buffer) re))
|
|
(cont (and (not new) (equal oldprop newprop)))
|
|
(cnt (if cont (get 'reftex-view-regexp-match :cnt) 0))
|
|
(current-window (selected-window))
|
|
(window-conf (current-window-configuration))
|
|
match pop-window)
|
|
(switch-to-buffer-other-window (or ref-buffer (current-buffer)))
|
|
;; Search
|
|
(condition-case nil
|
|
(if cont
|
|
(setq match (reftex-global-search-continue))
|
|
(reftex-access-scan-info)
|
|
(setq match (reftex-global-search re (reftex-all-document-files))))
|
|
(error nil))
|
|
;; Evaluate the match.
|
|
(if match
|
|
(progn
|
|
(put 'reftex-view-regexp-match :props newprop)
|
|
(put 'reftex-view-regexp-match :cnt (incf cnt))
|
|
(reftex-highlight 0 (match-beginning highlight-group)
|
|
(match-end highlight-group))
|
|
(add-hook 'pre-command-hook 'reftex-highlight-shall-die)
|
|
(setq pop-window (selected-window)))
|
|
(put 'reftex-view-regexp-match :props nil)
|
|
(or cont (set-window-configuration window-conf)))
|
|
(select-window current-window)
|
|
(if match
|
|
(progn
|
|
(message "Match Nr. %s" cnt)
|
|
pop-window)
|
|
(if cont
|
|
(error "No further matches (total number of matches: %d)" cnt)
|
|
(error "No matches")))))
|
|
|
|
(defvar reftex-global-search-marker (make-marker))
|
|
(defun reftex-global-search (regexp file-list)
|
|
;; Start a search for REGEXP in all files of FILE-LIST
|
|
(put 'reftex-global-search :file-list file-list)
|
|
(put 'reftex-global-search :regexp regexp)
|
|
(move-marker reftex-global-search-marker nil)
|
|
(reftex-global-search-continue))
|
|
|
|
(defun reftex-global-search-continue ()
|
|
;; Continue a global search started with `reftex-global-search'
|
|
(unless (get 'reftex-global-search :file-list)
|
|
(error "No global search to continue"))
|
|
(let* ((file-list (get 'reftex-global-search :file-list))
|
|
(regexp (get 'reftex-global-search :regexp))
|
|
(buf (or (marker-buffer reftex-global-search-marker)
|
|
(reftex-get-file-buffer-force (car file-list))))
|
|
(pos (or (marker-position reftex-global-search-marker) 1))
|
|
file)
|
|
;; Take up starting position
|
|
(unless buf (error "No such buffer %s" buf))
|
|
(switch-to-buffer buf)
|
|
(widen)
|
|
(goto-char pos)
|
|
;; Search and switch file if necessary
|
|
(if (catch 'exit
|
|
(while t
|
|
(when (re-search-forward regexp nil t)
|
|
(move-marker reftex-global-search-marker (point))
|
|
(throw 'exit t))
|
|
;; No match - goto next file
|
|
(pop file-list)
|
|
(or file-list (throw 'exit nil))
|
|
(setq file (car file-list)
|
|
buf (reftex-get-file-buffer-force file))
|
|
(unless buf (error "Cannot access file %s" file))
|
|
(put 'reftex-global-search :file-list file-list)
|
|
(switch-to-buffer buf)
|
|
(widen)
|
|
(goto-char 1)))
|
|
t
|
|
(move-marker reftex-global-search-marker nil)
|
|
(error "All files processed"))))
|
|
|
|
(provide 'reftex-dcr)
|
|
|
|
;;; reftex-dcr.el ends here
|