-;; reftex.el --- Minor mode for doing \label{} \ref{} and \cite{} in LaTeX
-;; Copyright (c) 1997 Free Software Foundation, Inc.
+;;; reftex.el --- minor mode for doing \label, \ref, \cite, \index in LaTeX
+;; Copyright (c) 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
-;; Author: Carsten Dominik <dominik@strw.LeidenUniv.nl>
-;; Keywords: tex
+;; Author: Carsten Dominik <dominik@strw.LeidenUniv.nl>
+;; Version: 4.16
+;; Keywords: tex
;; This file is part of GNU Emacs.
;;---------------------------------------------------------------------------
;;
;;; Commentary:
+;;
+;; RefTeX is a minor mode with distinct support for \ref, \label, \cite,
+;; and \index commands in (multi-file) LaTeX documents.
+;; - A table of contents provides easy access to any part of a document.
+;; - Labels are created semi-automatically.
+;; - Definition context of labels is provided when creating a reference.
+;; - Citations are simplified with efficient database lookup.
+;; - Text phrases can be collected in a file, for later global indexing.
+;; - The index preview buffer helps to check and edit index entries.
;;
-;; RefTeX is a minor mode with distinct support for \ref{}, \label{} and
-;; \cite{} commands in (multi-file) LaTeX documents.
-;; Labels are created semi-automatically. Definition context of labels is
-;; provided when creating a reference. Citations are simplified with
-;; efficient database lookup.
-;;
-;; To turn RefTeX Minor Mode on and off in a particular buffer, use
-;; `M-x reftex-mode'.
-;;
-;; To turn on RefTeX Minor Mode for all LaTeX files, add one of the
-;; following lines to your .emacs file:
;;
-;; (add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; with AUCTeX LaTeX mode
-;; (add-hook 'latex-mode-hook 'turn-on-reftex) ; with Emacs latex mode
+;; INSTALLATION
+;; ------------
;;
-;; For key bindings, see further down in this documentation.
+;; - If this file is part of an X/Emacs distribution, it is installed.
+;; - For XEmacs 21.x, you need to install the RefTeX plug-in package
+;; available from the XEmacs distribution sites.
+;; - If you have downloaded this file from the maintainers webpage, follow
+;; the instructions in the INSTALL file of the distrubution.
;;
-;;---------------------------------------------------------------------------
+;; To turn RefTeX Mode on and off in a buffer, use `M-x reftex-mode'.
;;
-;; OVERVIEW
-;;
-;; 1. USING \label{} AND \ref{}. Labels and references are one of the
-;; strong points of LaTeX. But, in documents with hundreds of
-;; equations, figures, tables etc. it becomes quickly impossible to
-;; find good label names and to actually remember them. Then, also
-;; completion of labels in not enough. One actually needs to see the
-;; context of the label definition to find the right one.
-;;
-;; - RefTeX distinguishes labels for different environments. It
-;; always knows if a certain label references a figure, table
-;; etc. You can configure RefTeX to recognize any additional
-;; labeled environments you might have defined yourself.
+;; To turn on RefTeX Mode for all LaTeX files, add the following lines
+;; to your .emacs file:
;;
-;; - RefTeX defines automatically unique labels. Type `C-c ('
-;; (reftex-label) to insert a label at point. RefTeX will either
-;; - derive a label from context (default for section labels)
-;; - insert a simple label consisting of a prefix and a number
-;; (default for equations and enumerate items) or
-;; - prompt for a label string (figures and tables)
-;; Which labels are created how can be controlled with the variable
-;; reftex-insert-label-flags.
+;; (add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; AUCTeX LaTeX mode
+;; (add-hook 'latex-mode-hook 'turn-on-reftex) ; Emacs latex mode
;;
-;; - Referencing labels is a snap and I promise you'll love it.
-;; In order to make a reference, type `C-c )' (reftex-reference).
-;; This shows an outline of the documents with all labels of a
-;; certain type (figure, equation,...) and context of the label
-;; definition. Selecting one of the labels inserts a \ref{} macro
-;; into the original buffer. Online help during the selection is
-;; available with `?'.
-;;
-;; 2. CITATIONS. After typing `C-c [' (reftex-citation), RefTeX will
-;; let you specify a regexp to search in current BibTeX database files
-;; (as specified in the \bibliography command) and pull out a formatted
-;; list of matches for you to choose from. The list is *formatted* and
-;; thus much easier to read than the raw database entries. It can also
-;; be sorted. The text inserted into the buffer is by default just
-;; `\cite{KEY}', but can also contain author names and the year in a
-;; configurable way. See documentation of the variable
-;; reftex-cite-format.
-;;
-;; 3. TABLE OF CONTENTS. Typing `C-c =' (reftex-toc) will show
-;; a table of contents of the document. From that buffer, you can
-;; jump quickly to every part of your document. This is similar to
-;; imenu, only it works for entire multifile documents and uses the
-;; keyboard rather than the mouse. The initial version of this
-;; function was contributed by Stephen Eglen.
;;
-;; 4. MULTIFILE DOCUMENTS are supported in the same way as by AUCTeX.
-;; I.e. if a source file is not a full LaTeX document by itself,
-;; but included by another file, you may specify the name of
-;; the (top level) master file in a local variable section at the
-;; end of the source file, like so:
+;; DOCUMENTATION
+;; -------------
;;
-;; %%% Local Variables:
-;; %%% TeX-master: my_master.tex
-;; %%% End:
+;; See below for a short summary of how to use RefTeX.
;;
-;; This will only take effect when you load the file next time or when
-;; you reset RefTeX with M-x reftex-reset-mode.
+;; There is an extensive texinfo document describing RefTeX in detail.
+;; One way to view this documentation is `M-x reftex-info RET'.
;;
-;; RefTeX will also recognize the file variable tex-main-file. This
-;; variable is used by the Emacs TeX modes and works just like
-;; AUCTeX's TeX-master variable. See the documentation of your TeX/LaTeX
-;; modes.
+;; The documentation in various formats is also available at
;;
-;; RefTeX knows about all files related to a document via input and
-;; include. It provides functions to run regular expression searches and
-;; replaces over the entire document and to create a TAGS file.
+;; http://www.strw.leidenuniv.nl/~dominik/Tools/
;;
-;; 5. DOCUMENT PARSING. RefTeX needs to parse the document in order to find
-;; labels and other information. It will do it automatically once, when
-;; you start working with a document. If you need to enforce reparsing
-;; later, call any of the functions reftex-citation, reftex-label,
-;; reftex-reference, reftex-toc with a raw C-u prefix.
+;;---------------------------------------------------------------------------
;;
-;;-------------------------------------------------------------------------
+;; Introduction
+;; ************
;;
-;; CONFIGURATION
+;; RefTeX is a specialized package for support of labels, references,
+;; citations, and the index in LaTeX. RefTeX wraps itself round 4 LaTeX
+;; macros: `\label', `\ref', `\cite', and `\index'. Using these macros
+;; usually requires looking up different parts of the document and
+;; searching through BibTeX database files. RefTeX automates these
+;; time-consuming tasks almost entirely. It also provides functions to
+;; display the structure of a document and to move around in this
+;; structure quickly.
;;
-;; RefTeX contains many configurable options which change the way it works.
-;;
-;; Most importantly, RefTeX needs to be configured if you use labels to
-;; mark non-standard environments. RefTeX always understands LaTeX section
-;; commands and the following environments: figure, figure*,
-;; sidewaysfigure, table, table*, sidewaystable, equation, eqnarray,
-;; enumerate. For everythings else, it needs to be configured.
-;;
-;; A good way to configure RefTeX is with the custom.el package by Per
-;; Abrahamsen, shipped with Emacs 20 and XEmacs 19.15. To do this, just
-;; say `M-x reftex-customize'. This will not work with older versions
-;; of custom.el.
-;;
-;; Here is a complete list of the RefTeX configuration variables with
-;; their default settings. You could copy this list to your .emacs file
-;; and change whatever is necessary. Each variable has an extensive
-;; documentation string. Look it up for more information!
-;;
-;; ;; Configuration Variables and User Options for RefTeX ------------------
-;; ;; Support for \label{} and \ref{} --------------------------------------
-;; (setq reftex-label-alist nil)
-;; (setq reftex-default-label-alist-entries '(Sideways LaTeX))
-;; (setq reftex-use-text-after-label-as-context nil)
-;; ;; Label insertion
-;; (setq reftex-insert-label-flags '("s" "sft"))
-;; (setq reftex-derive-label-parameters '(3 20 t 1 "-"
-;; ("the" "on" "in" "off" "a" "for" "by" "of" "and" "is")))
-;; (setq reftex-label-illegal-re "[\000-\040\177-\377\\\\#$%&~^_{}]")
-;; (setq reftex-abbrev-parameters '(4 2 "^saeiou" "aeiou"))
-;; ;; Label referencing
-;; (setq reftex-label-menu-flags '(t t nil nil nil nil))
-;; (setq reftex-guess-label-type t)
-;; ;; BibteX citation configuration ----------------------------------------
-;; (setq reftex-bibpath-environment-variables '("BIBINPUTS" "TEXBIB"))
-;; (setq reftex-bibfile-ignore-list nil)
-;; (setq reftex-sort-bibtex-matches 'reverse-year)
-;; (setq reftex-cite-format 'reftex-cite-format-default)
-;; ;; Table of contents configuration --------------------------------------
-;; (setq reftex-toc-follow-mode nil)
-;; ;; Miscellaneous configurations -----------------------------------------
-;; (setq reftex-extra-bindings nil)
-;; (setq reftex-use-fonts t)
-;; (setq reftex-keep-temporary-buffers t)
-;; (setq reftex-auto-show-entry t)
-;;
-;; CONFIGURATION EXAMPLES:
-;; =======================
-;;
-;; Suppose you are working with AMS-LaTeX amsmath package (with its math
-;; environments like `align', `multiline' etc.). Here is how you would
-;; configure RefTeX to recognize these environments:
-;;
-;; (setq reftex-label-alist '(AMSTeX))
-;;
-;; This is very easy since RefTeX has builtin support for AMS-LaTeX.
-;; Suppose, however, you are also
-;;
-;; - using "\newtheorem" in LaTeX in order to define two new environments
-;; "Theorem" and "Axiom" like this:
-;;
-;; \newtheorem{axiom}{Axiom}
-;; \newtheorem{theorem}{Theorem}
-;;
-;; - making your figures not directly with the figure environment, but with
-;; a macro like
-;;
-;; \newcommand{\myfig}[4][tbp]{
-;; \begin{figure}[#1]
-;; \epsimp[#4]{#2}
-;; \caption{#3}
-;; \end{figure}}
-;;
-;; which would be called like
-;;
-;; \myfig{filename}{\label{fig:13} caption text}{1}
-;;
-;; Here is how to tell RefTeX to also recognize Theorem and Axiom as
-;; labeled environments, and that any labels defined inside the \myfig
-;; macro are figure labels:
-;;
-;; (setq reftex-label-alist
-;; '(AMSTeX
-;; ("axiom" ?a "ax:" "~\\ref{%s}" nil ("Axiom" "Ax."))
-;; ("theorem" ?h "thr:" "~\\ref{%s}" t ("Theorem" "Theor." "Th."))
-;; ("\\myfig" ?f "fig:" nil t)))
-;;
-;; The type indicator characters ?a and ?h are used for prompts when
-;; RefTeX queries for a label type. Note that "h" was chosen for "theorem"
-;; since "t" is already taken by "table". Note that also "s", "f", "e", "n"
-;; are taken by the standard environments.
-;; The automatic labels for Axioms and Theorems will look like "ax:23" or
-;; "thr:24".
-;; The "\ref{%s}" is a format string indicating how to insert references to
-;; these labels. The nil format in the \myfig entry means to use the same
-;; format as other figure labels.
-;; The next item indicates how to grab context of the label definition.
-;; - t means to get it from a default location (from the beginning of a \macro
-;; or after the \begin{} statement). t is *not* a good choice for eqnarray
-;; and similar environments.
-;; - nil means to use the text right after the label definition.
-;; - For more complex ways of getting context, see the docstring of
-;; reftex-label-alist.
-;; The strings at the end of each entry are used to guess the correct label
-;; type from the word before point when creating a reference. E.g. if you
-;; write: "as we have shown in Theorem" and then press `C-)', RefTeX will
-;; know that you are looking for a Theorem label and restrict the labels in
-;; the menu to only these labels without even asking.
-;; See also the documentation string of the variable reftex-label-alist.
-;;
-;; Depending on how you would like the label insertion and selection for the
-;; new environments to work, you might want to add the letters "a" and "h"
-;; to some of the flags in the following variables:
-;;
-;; reftex-insert-label-flags
-;; reftex-label-menu-flags
-;;
-;; The individual flags in these variables can be set to t or nil to enable or
-;; disable the feature for all label types. They may also contain a string of
-;; label type letters in order to turn on the feature for those types only.
-;;
-;; -----
-;; If you are writing in a language different from english you might want to
-;; add magic words for that language. Here is a German example:
-;;
-;; (setq reftex-label-alist
-;; '((nil ?s nil nil nil ("Kapitel" "Kap." "Abschnitt" "Teil"))
-;; (nil ?e nil nil nil ("Gleichung" "Gl."))
-;; (nil ?t nil nil nil ("Tabelle"))
-;; (nil ?f nil nil nil ("Figur" "Abbildung" "Abb."))
-;; (nil ?n nil nil nil ("Punkt"))))
-;;
-;; Using `nil' as first item in each entry makes sure that this entry does
-;; not replace the original entry for that label type.
-;;
-;; HOOKS
-;; -----
-;; Loading reftex.el runs the hook reftex-load-hook. Turning on reftex-mode
-;; runs reftex-mode-hook.
-;;
-;;-------------------------------------------------------------------------
-;;
-;; KEY BINDINGS
-;;
-;; All important functions of RefTeX can be reached from its menu which
-;; is installed in the menu bar as "Ref" menu. Only the more frequently used
-;; functions have key bindings.
-;;
-;; Here is the default set of keybindings from RefTeX.
-;;
-;; C-c = reftex-toc
-;; C-c ( reftex-label
-;; C-c ) reftex-reference
-;; C-c [ reftex-citation
-;; C-c & reftex-view-crossref
-;;
-;; I've used these bindings in order to avoid interfering with AUCTeX's
-;; settings. Personally, I also bind some functions in the C-c LETTER
-;; map for easier access:
-;;
-;; C-c t reftex-toc
-;; C-c l reftex-label
-;; C-c r reftex-reference
-;; C-c c reftex-citation
-;; C-c v reftex-view-crossref
-;; C-c s reftex-search-document
-;; C-c g reftex-grep-document
-;;
-;; If you want to copy those as well, set in your .emacs file:
+;; *Note Imprint::, for information about who to contact for help, bug
+;; reports or suggestions.
;;
-;; (setq reftex-extra-bindings t)
-;;
-;; It is possible to bind the function for viewing cross references to a
-;; mouse event. Something like the following in .emacs will do the trick:
-;;
-;; (add-hook 'reftex-load-hook
-;; '(lambda ()
-;; (define-key reftex-mode-map [(alt mouse-1)]
-;; 'reftex-mouse-view-crossref)))
+;; Environment
+;; ===========
+;;
+;; RefTeX needs to access all files which are part of a multifile
+;; document, and the BibTeX database files requested by the
+;; `\bibliography' command. To find these files, RefTeX will require a
+;; search path, i.e. a list of directories to check. Normally this list
+;; is stored in the environment variables `TEXINPUTS' and `BIBINPUTS'
+;; which are also used by RefTeX. However, on some systems these
+;; variables do not contain the full search path. If RefTeX does not work
+;; for you because it cannot find some files, read *Note Finding Files::.
+;;
+;; Entering RefTeX Mode
+;; ====================
+;;
+;; To turn RefTeX Mode on and off in a particular buffer, use `M-x
+;; reftex-mode'. To turn on RefTeX Mode for all LaTeX files, add the
+;; following lines to your `.emacs' file:
+;;
+;; (add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; with AUCTeX LaTeX mode
+;; (add-hook 'latex-mode-hook 'turn-on-reftex) ; with Emacs latex mode
+;;
+;; RefTeX in a Nutshell
+;; ====================
+;;
+;; 1. Table of Contents
+;; Typing `C-c =' (`reftex-toc') will show a table of contents of the
+;; document. This buffer can display sections, labels and index
+;; entries defined in the document. From the buffer, you can jump
+;; quickly to every part of your document. Press `?' to get help.
+;;
+;; 2. Labels and References
+;; RefTeX helps to create unique labels and to find the correct key
+;; for references quickly. It distinguishes labels for different
+;; environments, knows about all standard environments (and many
+;; others), and can be configured to recognize any additional labeled
+;; environments you have defined yourself (variable
+;; `reftex-label-alist').
+;;
+;; * Creating Labels
+;; Type `C-c (' (`reftex-label') to insert a label at point.
+;; RefTeX will either
+;; - derive a label from context (default for section labels)
+;; - prompt for a label string (default for figures and
+;; tables) or
+;; - insert a simple label made of a prefix and a number (all
+;; other environments)
+;;
+;; Which labels are created how is configurable with the variable
+;; `reftex-insert-label-flags'.
+;;
+;; * Referencing Labels
+;; To make a reference, type `C-c )' (`reftex-reference'). This
+;; shows an outline of the document with all labels of a certain
+;; type (figure, equation,...) and some label context.
+;; Selecting a label inserts a `\ref{LABEL}' macro into the
+;; original buffer.
+;;
+;; 3. Citations
+;; Typing `C-c [' (`reftex-citation') will let you specify a regular
+;; expression to search in current BibTeX database files (as
+;; specified in the `\bibliography' command) and pull out a list of
+;; matches for you to choose from. The list is _formatted_ and
+;; sorted. The selected article is referenced as `\cite{KEY}' (see
+;; the variable `reftex-cite-format' if you want to insert different
+;; macros).
+;;
+;; 4. Index Support
+;; RefTeX helps to enter index entries. It also compiles all entries
+;; into an alphabetically sorted `*Index*' buffer which you can use
+;; to check and edit the entries. RefTeX knows about the standard
+;; index macros and can be configured to recognize any additional
+;; macros you have defined (`reftex-index-macros'). Multiple indices
+;; are supported.
+;;
+;; * Creating Index Entries
+;; To index the current selection or the word at point, type
+;; `C-c /' (`reftex-index-selection-or-word'). The default macro
+;; `reftex-index-default-macro' will be used. For a more
+;; complex entry type `C-c <' (`reftex-index'), select any of
+;; the index macros and enter the arguments with completion.
+;;
+;; * The Index Phrases File (Delayed Indexing)
+;; Type `C-c \' (`reftex-index-phrase-selection-or-word') to add
+;; the current word or selection to a special _index phrase
+;; file_. RefTeX can later search the document for occurrences
+;; of these phrases and let you interactively index the matches.
+;;
+;; * Displaying and Editing the Index
+;; To display the compiled index in a special buffer, type `C-c
+;; >' (`reftex-display-index'). From that buffer you can check
+;; and edit all entries.
+;;
+;; 5. Viewing Cross-References
+;; When point is on the KEY argument of a cross-referencing macro
+;; (`\label', `\ref', `\cite', `\bibitem', `\index', and variations)
+;; or inside a BibTeX database entry, you can press `C-c &'
+;; (`reftex-view-crossref') to display corresponding locations in the
+;; document and associated BibTeX database files.
+;; When the enclosing macro is `\cite' or `\ref' and no other message
+;; occupies the echo area, information about the citation or label
+;; will automatically be displayed in the echo area.
+;;
+;; 6. Multifile Documents
+;; Multifile Documents are fully supported. The included files must
+;; have a file variable `TeX-master' or `tex-main-file' pointing to
+;; the master file. RefTeX provides cross-referencing information
+;; from all parts of the document, and across document borders
+;; (`xr.sty').
+;;
+;; 7. Document Parsing
+;; RefTeX needs to parse the document in order to find labels and
+;; other information. It does it automatically once and updates its
+;; list internally when `reftex-label' and `reftex-index' are used.
+;; To enforce reparsing, call any of the commands described above
+;; with a raw `C-u' prefix, or press the `r' key in the label
+;; selection buffer, the table of contents buffer, or the index
+;; buffer.
+;;
+;; 8. AUCTeX
+;; If your major LaTeX mode is AUCTeX, RefTeX can cooperate with it
+;; (see variable `reftex-plug-into-AUCTeX'). AUCTeX contains style
+;; files which trigger appropriate settings in RefTeX, so that for
+;; many of the popular LaTeX packages no additional customizations
+;; will be necessary.
+;;
+;; 9. Useful Settings
+;; To make RefTeX faster for large documents, try these:
+;; (setq reftex-enable-partial-scans t)
+;; (setq reftex-save-parse-info t)
+;; (setq reftex-use-multiple-selection-buffers t)
+;;
+;; To integrate with AUCTeX, use
+;; (setq reftex-plug-into-AUCTeX t)
+;;
+;; To make your own LaTeX macro definitions known to RefTeX,
+;; customize the variables
+;; `reftex-label-alist' (for label macros/environments)
+;; `reftex-section-levels' (for sectioning commands)
+;; `reftex-cite-format' (for `\cite'-like macros)
+;; `reftex-index-macros' (for `\index'-like macros)
+;; `reftex-index-default-macro' (to set the default macro)
+;; If you have a large number of macros defined, you may want to write
+;; an AUCTeX style file to support them with both AUCTeX and RefTeX.
+;;
+;; 10. Where Next?
+;; Go ahead and use RefTeX. Use its menus until you have picked up
+;; the key bindings. For an overview of what you can do in each of
+;; the different special buffers, press `?'. Read the manual if you
+;; get stuck, of if you are curious what else might be available.
+;; The first part of the manual explains in a tutorial way how to use
+;; and customize RefTeX. The second part is a command and variable
+;; reference.
;;
-;;-------------------------------------------------------------------------
-;;
-;; RELATED PACKAGES
-;;
-;; AUCTeX
-;; ------
-;; If you are writing any TeX or LaTeX documents with Emacs, you should
-;; have a look at AUCTeX, the definitive package to work with TeX and LaTeX.
-;; Information on AUCTeX can be found here:
-;;
-;; http://www.sunsite.auc.dk/auctex/
-;;
-;; AUCTeX version 9.7f and later can be configured to delegate label
-;; insertion to RefTeX. Do do that, say in your .emacs file
-;;
-;; (setq LaTeX-label-function 'reftex-label)
-;;
-;; RefTeX also provides functions which can replace TeX-arg-label and
-;; TeX-arg-cite in AUCTeX. These functions are compatible with the originals,
-;; but use RefTeX internals to create and select labels and citation keys.
-;; There are 3 functions: reftex-arg-label, reftex-arg-ref, reftex-arg-cite.
-;;
-;; AUCTeX can support RefTeX via style files. A style file may contain
-;; calls to reftex-add-to-label-alist which defines additions to
-;; reftex-label-alist. The argument taken by this function must have exactly
-;; the same format as reftex-label-alist. E.g. a good entry in a style file
-;; for the amsmath package would be
-;;
-;; (and (fboundp 'reftex-add-to-label-alist)
-;; (reftex-add-to-label-alist '(AMSTeX)))
-;;
-;; while a package defining a proposition environment with \newtheorem
-;; might use
-;;
-;; (and
-;; (fboundp 'reftex-add-to-label-alist)
-;; (reftex-add-to-label-alist
-;; '(("proposition" ?p "prop:" "~\\ref{%s}" t
-;; ("Proposition" "Prop.")))))
-;;
-;; Bib-cite.el
-;; -----------
-;; Once you have written a document with labels, refs and citations, it can be
-;; nice to read such a file like a hypertext document. RefTeX has some support
-;; for that (reftex-view-crossref, reftex-search-document). A more elegant
-;; interface with mouse support and links into Hyperbole is provided (among
-;; other things) by Peter S. Galbraith's bib-cite.el. There is some overlap in
-;; the functionalities of bib-cite and RefTeX. Bib-cite.el comes bundled with
-;; AUCTeX. You can also get the latest version from
-;;
-;; ftp://ftp.phys.ocean.dal.ca/users/rhogee/elisp/bib-cite.el
-;;
-;;-------------------------------------------------------------------------
-;;
-;; PERFORMANCE ISSUES
-;;
-;; 1. RefTeX will load other parts of a multifile document as well as BibTeX
-;; database files for lookup purposes. These buffers are kept, so that
-;; subsequent lookup in the same files is fast. For large documents and
-;; large BibTeX databases, this can use up a lot of memory. If you have
-;; more time than memory, try the following option, which will remove
-;; buffers created for lookup after use.
-;;
-;; (setq reftex-keep-temporary-buffers nil)
-;;
-;; 2. Parsing the document for labels and their context can be slow.
-;; Therefore, RefTeX does it just once automatically. Further parsing
-;; happens only on user request
-;; - with a raw C-u prefix arg to any of the functions reftex-label,
-;; reftex-reference, reftex-citation, reftex-toc.
-;; - with the `r' key from the label selection menu or the *toc* buffer.
-;;
-;; *** If you use reftex-label to create labels, the list will be updated
-;; *** internally, so that no extra parsing is required.
-;;
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;
-;; KNOWN BUGS
-;;
-;; o If you change reftex-label-alist in an editing session, you need to
-;; reset reftex with `M-x reftex-reset-mode' in order to make these
-;; changes effective. Changes introduced with the function
-;; reftex-add-to-label-alist as well as changes applied from the
-;; customization buffer automatically trigger a reset.
-;;
-;; o At times the short context shown by RefTeX may not be what you want.
-;; In particular, eqnarray environments can be difficult to
-;; parse. RefTeX's default behavior for eqnarrays is to scan backwards to
-;; either a double backslash or the beginning of the environment. If this
-;; gives unsatisfactory results, make it a habit to place the label
-;; *before* each equation
-;;
-;; \begin{eqnarray}
-;; \label{eq:1}
-;; E = \gamma m c^2 \\
-;; \label{eq:2}
-;; \gamma = \sqrt{1-v^2/c^2}
-;; \end{eqnarray}
-;;
-;; and turn off parsing for context in equation and eqnarray environments
-;; with
-;;
-;; (setq reftex-use-text-after-label-as-context "e").
-;;
-;; o RefTeX keeps only one global copy of the configuration variables.
-;; Also any additions from style files go into a global variable.
-;; Practically, this should not be a problem. Theoretically, it could
-;; give conflicts if two documents used environments with identical
-;; names, but different associated label types.
-;;
-;; o Input, include, bibliography and section statements have to be first
-;; on a line (except for white space) in order to be seen by reftex.
-;;
-;; o When the document is scanned, RefTeX creates a large buffer containing
-;; the entire document instead of scanning the individual files one by
-;; one. This is necessary since a file might not contain the context
-;; needed by RefTeX.
-;;
-;; o If you have two identical section headings in the same file,
-;; reftex-toc will only let you jump to the first one because it searches
-;; for the section heading from the beginning of the file. You can work
-;; around this by changing one of the section titles in a way LaTeX does
-;; not see, e.g. with extra white space. RefTeX will distinguish
-;; \section{Introduction} from \section{ Introduction}.
-;;
-;; o RefTeX sees also labels in regions commented out and will refuse to
-;; make duplicates of such a label. This is considered to be a feature.
-;;
-;; o When RefTeX tries to show a window full of context from inside a
-;; section hidden with outline-minor-mode, it will unhide that section.
-;; This change will not be reversed automatically.
-;;
-;;---------------------------------------------------------------------------
-;;
-;; TO DO
-;;
-;; I think I am pretty much done with this one...
-;;
;;---------------------------------------------------------------------------
;;
;; AUTHOR
+;; ======
;;
;; Carsten Dominik <dominik@strw.LeidenUniv.nl>
;;
;; with contributions from Stephen Eglen
;;
-;; The newest version of RefTeX can be found at
+;; RefTeX is bundled with Emacs and available as a plug-in package for
+;; XEmacs 21.x. If you need to install it yourself, you can find a
+;; distribution at
;;
;; http://www.strw.leidenuniv.nl/~dominik/Tools/
-;; ftp://strw.leidenuniv.nl/pub/dominik/
;;
;; THANKS TO:
;; ---------
-;; At least the following people have invested time to test and bug-fix
-;; reftex.el. Some have send patches for fixes or new features.
+;; Thanks to the people on the Net who have used RefTeX and helped
+;; developing it with their reports. In particular thanks to
;;
-;; Stephen Eglen <stephene@cogs.susx.ac.uk>
-;; F.E.Burstall <F.E.Burstall@maths.bath.ac.uk>
-;; Karl Eichwalder <ke@ke.Central.DE>
-;; Laurent Mugnier <mugnier@onera.fr>
-;; Rory Molinari <molinari@yunt.math.lsa.umich.edu>
-;; Soren Dayton <csdayton@cs.uchicago.edu>
-;; Daniel Polani <polani@Informatik.Uni-Mainz.DE>
-;; Allan Strand <astrand@trillium.NMSU.Edu>
+;; Fran Burstall, Alastair Burt, Soren Dayton, Stephen Eglen,
+;; Karl Eichwalder, Peter Galbraith, Dieter Kraft, Kai Grossjohann,
+;; Frank Harrell, Adrian Lanz, Rory Molinari, Stefan Monnier,
+;; Laurent Mugnier, Sudeep Kumar Palat, Daniel Polani, Robin Socha,
+;; Richard Stanton, Allan Strand, Jan Vroonhof, Christoph Wedler,
+;; Alan Williams.
;;
-;; The view crossref feature was inspired by the similar function in
-;; Peter S. Galbraith's bib-cite.el.
-;;
-;; Finally thanks to Uwe Bolick <bolick@physik.tu-berlin.de> who first
-;; got me (some years ago) into supporting LaTeX labels and references
-;; with an Editor (which was MicroEmacs at the time).
+;; Finally thanks to Uwe Bolick who first got me (some years ago) into
+;; supporting LaTeX labels and references with an editor (which was
+;; MicroEmacs at the time).
+;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;;;;;
\f
;;; Code:
-;; Stuff that needs to be there when we use defcustom
-;; --------------------------------------------------
+(eval-when-compile (require 'cl))
+;; Stuff that needs to be there when we use defcustom
(require 'custom)
(defvar reftex-tables-dirty t
(setq reftex-tables-dirty t)
(set symbol value)))
-;;; Begin of Configuration Section ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;; Configuration Variables and User Options for RefTeX ------------------
+;;; =========================================================================
+;;;
+;;; Configuration variables
-(defgroup reftex nil
- "LaTeX label and citation support."
- :tag "RefTeX"
- :link '(url-link :tag "Home Page" "http://strw.leidenuniv.nl/~dominik/Tools/")
- :prefix "reftex-"
- :group 'tex)
+(require 'reftex-vars)
-(defun reftex-customize ()
- "Call the customize function with reftex as argument."
- (interactive)
- (if (fboundp 'customize-group)
- (customize-group 'reftex)
- (customize 'reftex)))
-
-;; Support for \label{} and \ref{} --------------------------------------
-
-(defgroup reftex-label-support nil
- "Support for creation, insertion and referencing of labels in LaTeX"
- :group 'reftex)
-
-(defgroup reftex-defining-label-environments nil
- "Definition of environments and macros to do with label"
- :group 'reftex-label-support)
-
-
-(defcustom reftex-label-alist nil
- "AList with information on environments for \\label{}-\\ref{} use.
-See the definition of reftex-label-alist-builtin for examples. This variable
-should define additions and changes to the default. The only things you MUST
-NOT change is that '?s' is the type indicator for section labels and SPACE is
-for the 'any' label type. These are hard-coded at other places in the code.
-
-Changes to this variable after reftex.el has been loaded become only
-effective when RefTeX is reset with \\[reftex-reset-mode].
-
-Each list entry is a list describing an environment or macro carrying a
-label. The elements of each list entry are:
-
-0. Name of the environment (like \"table\") or macro (like \"\\\\myfig\").
- Special names: `section' for section labels, `any' to define a group
- which contains all labels.
- This may also be nil if this entry is only meant to change some settings
- associated with the type indicator character (see below).
-
-1. Type indicator character, like ?t.
- The type indicator is a single character used in prompts for
- label types. It must be a printable character. The same character
- may occur several times in this list, to cover cases in which different
- environments carry the same label type (like equation and eqnarray).
-
-2. Label prefix string, like \"tab:\".
- The prefix is a short string used as the start of a label. It may be the
- empty string.
-
-3. Format string for reference insert in buffer. Each %s will be replaced by
- the label (yes, several %s can be in there, so that you can set this to:
- \"\\ref{%s} on page~\\pageref{%s}\").
- When the format starts with ~, whitespace before point will be removed so
- that the reference cannot be separated from the word before it.
-
-4. Indication on how to find the short context.
- - If `nil', use the text following the \\label{...} macro.
- - If `t', use
- - text following the \\begin{...} statement of environments
- (not a good choice in in eqnarray or enumerate environments!)
- - the section heading for section labels.
- - the begin of the macro for macros.
- - If a string, use as regexp to search *backward* from the label. Context
- is then the text following the end of the match. E.g. putting this to
- \"\\\\\\\\caption{\" will use the beginning of the caption in a figure
- or table environment. \"\\\\\\\\begin{eqnarray}\\\\|\\\\\\\\\\\\\\\\\"
- works for eqnarrays.
- - If a function, call this function with the name of the environment/macro
- as argument. On call, point will be just after the \\label{} macro. The
- function is expected to return a suitable context string. It should
- throw an exception (error) when failing to find context.
- Consider the following example, which would return the 10 characters
- following the label as context:
-
- (defun my-context-function (env-or-mac)
- (if (> (point-max) (+ 10 (point)))
- (buffer-substring (point) (+ 10 (point)))
- (error \"Buffer too small\")))
-
- Setting the variable reftex-use-text-after-label-as-context to t overrides
- the setting here.
-
-5. List of magic words which identify a reference to be of this type. If the
- word before point is equal to one of these words when calling
- reftex-reference, the label list offered will be automatically restricted
- to labels of the correct type.
-
-If the type indicator characters of two or more entries are the same, RefTeX
-will use
- - the first non-nil format and prefix
- - the magic words of all involved entries.
-
-Any list entry may also be a symbol. If that has an association in
-reftex-label-alist-builtin, the cdr of that association is spliced into the
-list. See the AMSTeX configuration example in the comment section of
-reftex.el."
- :group 'reftex-defining-label-environments
- :set 'reftex-set-dirty
- :type '(list
- :convert-widget
- (lambda (widget)
- (let*
- ((args
- (list
- `(repeat
- :inline t
- (radio
- :value ("" ?a nil nil t nil)
- (choice
- :tag "Builtin"
- :value AMSTeX
- ,@(mapcar (function (lambda (x)
- (list 'const ':tag (nth 1 x) (car x))))
- reftex-label-alist-builtin))
- (list :tag "Detailed custom entry"
- (choice :tag "Environment or \\macro "
- (const :tag "Ignore, just use typekey" nil)
- (string ""))
- (character :tag "Typekey character " ?a)
- (choice :tag "Label prefix string "
- (const :tag "Copy from similar label type" nil)
- (string :tag "Specify here" "lab:"))
- (choice :tag "Label reference format"
- (const :tag "Copy from similar label type" nil)
- (string :tag "Specify here" "~\\ref{%s}"))
- (choice :tag "Grab context method "
- (const :tag "Default position" t)
- (const :tag "After label" nil)
- (regexp :tag "Regular expression" "")
- (symbol :tag "Function" my-context-function))
- (repeat :tag "List of Magic Words" (string))))))))
- (widget-put widget :args args)
- widget))))
-
-(defcustom reftex-default-label-alist-entries '(Sideways LaTeX)
- "Default label alist specifications. LaTeX should be the last entry.
-This list describes the default label environments RefTeX should always use in
-addition to the specifications in reftex-label-alist. It is probably a
-mistake to remove the LaTeX symbol from this list.
-
-Here are the current options:
-
-LaTeX The standard LaTeX environments
-Sideways The sidewaysfigure and sidewaystable environments
-AMSTeX The math environments in the AMS_LaTeX amsmath package
-AAS The deluxetable environment from the American Astronomical Society"
- :group 'reftex-defining-label-environments
- :set 'reftex-set-dirty
- :type '(list :indent 4
- :convert-widget
- (lambda (widget)
- (let* ((args
- (list
- `(checklist
- :inline t
- ,@(reverse
- (mapcar (lambda (x)
- (list 'const ':tag (nth 1 x) (car x)))
- reftex-label-alist-builtin))))))
- (widget-put widget :args args)
- widget))))
-
-(defcustom reftex-use-text-after-label-as-context nil
- "*t means, grab context from directly after the \\label{..} macro.
-This is the fastest method for obtaining context of the label definition, but
-requires discipline when placing labels. Setting this variable to t takes
-precedence over the individual settings in reftex-label-alist.
-This variable may be set to t, nil, or a string of label type letters
-indicating the label types for which it should be true."
- :group 'reftex-defining-label-environments
- :set 'reftex-set-dirty
- :type '(choice
- (const :tag "on" t) (const :tag "off" nil)
- (string :tag "Selected label types")))
-
-;; Label insertion
-
-(defgroup reftex-making-and-inserting-labels nil
- "Options on how to create new labels"
- :group 'reftex-label-support)
-
-(defcustom reftex-insert-label-flags '("s" "sft")
- "Flags governing label insertion. First flag DERIVE, second flag PROMPT.
-
-If DERIVE is t, RefTeX will try to derive a sensible label from context.
-A section label for example will be derived from the section heading.
-The conversion of the context to a legal label is governed by the
-specifications given in reftex-derive-label-parameters.
-If RefTeX fails to derive a label, it will prompt the user.
-
-If PROMPT is t, the user will be prompted for a label string. The prompt will
-already contain the prefix, and (if DERIVE is t) a default label derived from
-context. When PROMPT is nil, the default label will be inserted without
-query.
-
-So the combination of DERIVE and PROMPT controls label insertion. Here is a
-table describing all four possibilities:
-
-DERIVE PROMPT ACTION
--------------------------------------------------------------------------
- nil nil Insert simple label, like eq:22 or sec:13. No query.
- nil t Prompt for label
- t nil Derive a label from context and insert without query
- t t Derive a label from context and prompt for confirmation
-
-Each flag may be set to t, nil, or a string of label type letters
-indicating the label types for which it should be true.
-Thus, the combination may be set differently for each label type. The
-default settings \"s\" and \"sft\" mean: Derive section labels from headings
-(with confirmation). Prompt for figure and table labels. Use simple labels
-without confirmation for everything else."
- :group 'reftex-making-and-inserting-labels
- :type '(list (choice :tag "Derive label from context"
- (const :tag "always" t)
- (const :tag "never" nil)
- (string :tag "for selected label types" ""))
- (choice :tag "Prompt for label string "
- :entry-format " %b %v"
- (const :tag "always" t)
- (const :tag "never" nil)
- (string :tag "for selected label types" ""))))
-
-(defcustom reftex-derive-label-parameters '(3 20 t 1 "-" ; continue
- ("the" "on" "in" "off" "a" "for" "by" "of" "and" "is"))
- "Parameters for converting a string into a label.
-NWORDS Number of words to use.
-MAXCHAR Maximum number of characters in a label string.
-ILLEGAL nil: Throw away any words containing characters illegal in labels.
- t: Throw away only the illegal characters, not the whole word.
-ABBREV nil: Never abbreviate words.
- t: Always abbreviate words (see reftex-abbrev-parameters).
- not t and not nil: Abbreviate words if necessary to shorten
- label string below MAXCHAR.
-SEPARATOR String separating different words in the label
-IGNOREWORDS List of words which should not be part of labels"
- :group 'reftex-making-and-inserting-labels
- :type '(list (integer :tag "Number of words " 3)
- (integer :tag "Maximum label length " 20)
- (choice :tag "Illegal characters in words"
- (const :tag "throw away entire word" nil)
- (const :tag "throw away single chars" t))
- (choice :tag "Abbreviate words "
- (const :tag "never" nil)
- (const :tag "always" t)
- (const :tag "when label is too long" 1))
- (string :tag "Separator between words " "-")
- (repeat :tag "Ignore words"
- :entry-format " %i %d %v"
- (string :tag ""))))
-
-(defcustom reftex-label-illegal-re "[\000-\040\177-\377\\\\#$%&~^_{}]"
- "Regexp matching characters not legal in labels.
-For historic reasons, this character class comes *with* the [] brackets."
- :group 'reftex-making-and-inserting-labels
- :type '(regexp :tag "Character class"))
-
-(defcustom reftex-abbrev-parameters '(4 2 "^saeiou" "aeiou")
- "Parameters for abbreviation of words.
-MIN-CHARS minimum number of characters remaining after abbreviation
-MIN-KILL minimum number of characters to remove when abbreviating words
-BEFORE character class before abbrev point in word
-AFTER character class after abbrev point in word"
- :group 'reftex-making-and-inserting-labels
- :type '(list
- (integer :tag "Minimum chars per word" 4)
- (integer :tag "Shorten by at least " 2)
- (string :tag "cut before char class " "^saeiou")
- (string :tag "cut after char class " "aeiou")))
-
-
-;; Label referencing
-
-(defgroup reftex-referencing-labels nil
- "Options on how to reference labels"
- :group 'reftex-label-support)
-
-(defcustom reftex-label-menu-flags '(t t nil nil nil nil)
- "*List of flags governing the label menu makeup.
-The flags are:
-
-TABLE-OF-CONTENTS Show the labels embedded in a table of context.
-SECTION-NUMBERS Include section numbers (like 4.1.3) in table of contents.
-COUNTERS Show counters. This just numbers the labels in the menu.
-NO-CONTEXT Non-nil means do NOT show the short context.
-FOLLOW follow full context in other window.
-SHOW-COMMENTED Show labels from regions which are commented out. RefTeX
- sees these labels, but does not normally show them.
-
-Each of these flags can be set to t or nil, or to a string of type letters
-indicating the label types for which it should be true. These strings work
-like character classes in regular expressions. Thus, setting one of the
-flags to \"sf\" makes the flag true for section and figure labels, nil
-for everything else. Setting it to \"^ft\" makes it the other way round.
-
-Most options can also be switched from the label menu itself - so if you
-decide here to not have a table of contents in the label menu, you can still
-get one interactively during selection from the label menu."
- :group 'reftex-referencing-labels
- :type '(list
- (choice :tag "Embed in table of contents "
- (const :tag "on" t) (const :tag "off" nil)
- (string :tag "Selected label types"))
- (choice :tag "Show section numbers "
- (const :tag "on" t) (const :tag "off" nil))
- (choice :tag "Show individual counters "
- (const :tag "on" t) (const :tag "off" nil)
- (string :tag "Selected label types"))
- (choice :tag "Hide short context "
- (const :tag "on" t) (const :tag "off" nil)
- (string :tag "Selected label types"))
- (choice :tag "Follow context in other window"
- (const :tag "on" t) (const :tag "off" nil)
- (string :tag "Selected label types"))
- (choice :tag "Show commented labels "
- (const :tag "on" t) (const :tag "off" nil)
- (string :tag "Selected label types"))))
-
-
-(defcustom reftex-guess-label-type t
- "*Non-nil means, reftex-reference will try to guess the label type.
-To do that, RefTeX will look at the word before the cursor and compare it with
-the words given in reftex-label-alist. When it finds a match, RefTeX will
-immediately offer the correct label menu - otherwise it will prompt you for
-a label type. If you set this variable to nil, RefTeX will always prompt."
- :group 'reftex-referencing-labels
- :type '(boolean))
-
-;; BibteX citation configuration ----------------------------------------
-
-(defgroup reftex-citation-support nil
- "Support for referencing bibliographic data with BibTeX"
- :group 'reftex)
-
-(defcustom reftex-bibpath-environment-variables '("BIBINPUTS" "TEXBIB")
- "*List of env vars which might contain the path to BibTeX database files."
- :group 'reftex-citation-support
- :set 'reftex-set-dirty
- :type '(repeat (string :tag "Environment variable")))
-
-(defcustom reftex-bibfile-ignore-list nil
- "List of files in \\bibliography{..} RefTeX should *not* parse.
-The file names have to be in the exact same form as in the bibliography
-macro - i.e. without the .bib extension.
-Intended for files which contain only `@string' macro definitions and the
-like, which are ignored by RefTeX anyway."
- :group 'reftex-citation-support
- :set 'reftex-set-dirty
- :type '(repeat (string :tag "File name")))
-
-(defcustom reftex-sort-bibtex-matches 'reverse-year
- "*Sorting of the entries found in BibTeX databases by reftex-citation.
-Possible values:
-nil Do not sort entries.
-'author Sort entries by author name.
-'year Sort entries by increasing year.
-'reverse-year Sort entries by decreasing year."
- :group 'reftex-citation-support
- :type '(choice (const :tag "not" nil)
- (const :tag "by author" author)
- (const :tag "by year" year)
- (const :tag "by year, reversed" reverse-year)))
-
-(defcustom reftex-cite-format 'reftex-cite-format-default
- "Defines the format of citations to be inserted into the buffer.
-It can be a string, a list of strings, or an alist with characters as keys
-and a list of strings in the car. In the simplest case, this can just
-be the string \"\\cite{KEY}\", which is also the default. See the
-definition of the reftex-cite-format-XXXX constants for more complex
-examples.
- If reftex-cite-format is a string, it will be used as the format. In
-the format, AUTHOR will be replaced by the last name of the
-author, YEAR will be replaced by the year and KEY by the citation
-key. If AUTHOR is present several times, it will be replaced with
-successive author names.
-See the constant reftex-cite-format-default for an example.
- If reftex-cite-format is a list of strings, the string used will
-depend upon the number of authors of the article. No authors means,
-the first string will be used, 1 author means, the second string will
-be used etc. The last string in the list will be used for all articles
-with too many authors. See reftex-cite-format-1-author-simple for an
-example.
- If reftex-cite-format is a list of cons cells, the car of each cell
-needs to be a character. When a selected reference is accepted by
-pressing that key, the cdr of the associated list will be used as
-described above. See reftex-cite-format-2-authors for an example.
- In order to configure this variable, you can either set
-reftex-cite-format directly yourself or set it to the SYMBOL of one of
-the predefined constants. E.g.:
-(setq reftex-cite-format 'reftex-cite-format-2-authors)"
- :group 'reftex-citation-support
- :type
-'(choice
- (choice :tag "symbolic defaults"
- :value reftex-cite-format-default
- (const reftex-cite-format-default)
- (const reftex-cite-format-1-author-simple)
- (const reftex-cite-format-2-authors))
- (string :tag "format string" "\\cite{KEY}")
- (repeat :tag "list of strings"
- :value ("\cite{KEY}" "AUTHOR \cite{KEY}" "AUTHOR and AUTHOR \cite{KEY}")
- (string :tag "format string" ""))
- (repeat :tag "key-ed lists of strings"
- :value ((?\r . ("\cite{KEY}" "AUTHOR \cite{KEY}" "AUTHOR and AUTHOR \cite{KEY}")))
- (cons :tag "Enter a keyed list of format strings"
- (character :tag "Key character " ?\r)
- (repeat
- (string :tag "format string" ""))))))
-
-;; Table of contents configuration --------------------------------------
-
-(defgroup reftex-table-of-contents-browser nil
- "A multifile table of contents browser."
- :group 'reftex)
-
-(defcustom reftex-toc-follow-mode nil
- "Non-nil means, point in *toc* buffer will cause other window to follow.
-The other window will show the corresponding part of the document.
-This flag can be toggled from within the *toc* buffer with the `f' key."
- :group 'reftex-table-of-contents-browser
- :type '(boolean))
-
-;; Miscellaneous configurations -----------------------------------------
-
-(defgroup reftex-miscellaneous-configurations nil
- "Collection of further configurations"
- :group 'reftex)
-
-(defcustom reftex-extra-bindings nil
- "Non-nil means, make additional key bindings on startup.
-These extra bindings are located in the users C-c letter map."
- :group 'reftex-miscellaneous-configurations
- :type '(boolean))
-
-(defcustom reftex-use-fonts t
- "*Non-nil means, use fonts in label menu and on-the-fly help.
-Font-lock must be loaded as well to actually get fontified display."
- :group 'reftex-miscellaneous-configurations
- :type '(boolean))
-
-(defcustom reftex-keep-temporary-buffers t
- "*Non-nil means, keep any TeX and BibTeX files loaded for lookup.
-Nil means, kill it immediately after use unless it was already an existing
-buffer before the lookup happened. It is faster to keep the buffers, but can
-use a lot of memory, depending on the size of your database and document."
- :group 'reftex-miscellaneous-configurations
- :type '(boolean))
-
-(defcustom reftex-auto-show-entry t
- "*Non-nil means, showing context in another window may unhide a section.
-This is important when using outline-minor-mode. If the context to be shown
-is in a hidden section, RefTeX will issue a \"show-entry\" command in order
-to show it. This is not reversed when the label is selected - so the section
-remains shown after command completion."
- :group 'reftex-miscellaneous-configurations
- :type '(boolean))
-
-
-;;; End of Configuration Section ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-
-;;;===========================================================================
+
+;;; =========================================================================
;;;
;;; Define the formal stuff for a minor mode named RefTeX.
;;;
+(defconst reftex-version "RefTeX version 4.16"
+ "Version string for RefTeX.")
+
(defvar reftex-mode nil
- "Determines if RefTeX minor mode is active.")
+ "Determines if RefTeX mode is active.")
(make-variable-buffer-local 'reftex-mode)
(defvar reftex-mode-map (make-sparse-keymap)
- "Keymap for RefTeX minor mode.")
+ "Keymap for RefTeX mode.")
(defvar reftex-mode-menu nil)
+(defvar reftex-syntax-table nil)
+
+(defvar reftex-auto-view-crossref-timer nil
+ "The timer used for auto-view-crossref.")
;;;###autoload
(defun turn-on-reftex ()
- "Turn on RefTeX minor mode."
+ "Turn on RefTeX mode."
(reftex-mode t))
;;;###autoload
(defun reftex-mode (&optional arg)
- "Minor mode with distinct support for \\label{}, \\ref{} and \\cite{}
-in LaTeX documents.
+ "Minor mode with distinct support for \\label, \\ref and \\cite in LaTeX.
+
+\\<reftex-mode-map>A Table of Contents of the entire (multifile) document with browsing
+capabilities is available with `\\[reftex-toc]'.
Labels can be created with `\\[reftex-label]' and referenced with `\\[reftex-reference]'.
When referencing, you get a menu with all labels of a given type and
-context of the label definition. The selected label is inserted as a
-\\ref{} macro.
+context of the label definition. The selected label is inserted as a
+\\ref macro.
-Citations can be made with `\\[reftex-citation]' which will use a regular expression
+Citations can be made with `\\[reftex-citation]' which will use a regular expression
to pull out a *formatted* list of articles from your BibTeX
-database. The selected citation is inserted as a \\cite{} macro.
+database. The selected citation is inserted as a \\cite macro.
-A Table of Contents of the entire (multifile) document with browsing
-capabilities is available with `\\[reftex-toc]'.
+Index entries can be made with `\\[reftex-index-selection-or-word]' which indexes the word at point
+or the current selection. More general index entries are created with
+`\\[reftex-index]'. `\\[reftex-display-index]' displays the compiled index.
-Most command have help available on the fly. This help is accessed by
+Most command have help available on the fly. This help is accessed by
pressing `?' to any prompt mentioning this feature.
+Extensive documentation about RefTeX is available in Info format.
+You can view this information with `\\[reftex-info]'.
+
\\{reftex-mode-map}
-Under X, these functions will be available also in a menu on the menu bar.
+Under X, these and other functions will also be available as `Ref' menu
+on the menu bar.
------------------------------------------------------------------------------"
(setq reftex-mode (not (or (and (null arg) reftex-mode)
(<= (prefix-numeric-value arg) 0))))
- ; Add or remove the menu, and run the hook
(if reftex-mode
(progn
- (easy-menu-add reftex-mode-menu)
- (run-hooks 'reftex-mode-hook))
+ ;; Mode was turned on
+ (easy-menu-add reftex-mode-menu)
+ (and reftex-plug-into-AUCTeX
+ (reftex-plug-into-AUCTeX))
+ (unless (get 'reftex-auto-view-crossref 'initialized)
+ (and reftex-auto-view-crossref
+ (reftex-toggle-auto-view-crossref))
+ (put 'reftex-auto-view-crossref 'initialized t))
+ (unless reftex-syntax-table
+ (setq reftex-syntax-table (copy-syntax-table (syntax-table)))
+ (modify-syntax-entry ?\( "." reftex-syntax-table)
+ (modify-syntax-entry ?\) "." reftex-syntax-table))
+ (run-hooks 'reftex-mode-hook))
+ ;; Mode was turned off
(easy-menu-remove reftex-mode-menu)))
-
-(or (assoc 'reftex-mode minor-mode-alist)
- (setq minor-mode-alist
- (cons '(reftex-mode " Ref") minor-mode-alist)))
-(or (assoc 'reftex-mode minor-mode-map-alist)
- (setq minor-mode-map-alist
- (cons (cons 'reftex-mode reftex-mode-map)
- minor-mode-map-alist)))
+(if (fboundp 'add-minor-mode)
+ ;; Use it so that we get the extras
+ (progn
+ (put 'reftex-mode :included '(memq major-mode '(latex-mode tex-mode)))
+ (put 'reftex-mode :menu-tag "RefTeX Mode")
+ (add-minor-mode 'reftex-mode " Ref" reftex-mode-map))
+ ;; The standard way
+ (unless (assoc 'reftex-mode minor-mode-alist)
+ (push '(reftex-mode " Ref") minor-mode-alist))
+ (unless (assoc 'reftex-mode minor-mode-map-alist)
+ (push (cons 'reftex-mode reftex-mode-map) minor-mode-map-alist)))
+
+(defvar reftex-docstruct-symbol)
+(defun reftex-kill-buffer-hook ()
+ "Save RefTeX's parse file for this buffer if the information has changed."
+ ;; Save the parsing information if it was modified.
+ ;; This function should be installed in `kill-buffer-hook'.
+ ;; We are careful to make sure nothing goes wring in this function.
+ (when (and (boundp 'reftex-mode) reftex-mode
+ (boundp 'reftex-save-parse-info) reftex-save-parse-info
+ (boundp 'reftex-docstruct-symbol) reftex-docstruct-symbol
+ (symbol-value reftex-docstruct-symbol)
+ (get reftex-docstruct-symbol 'modified))
+ ;; Write the file.
+ (condition-case nil
+ (reftex-access-parse-file 'write)
+ (error nil))))
+(defun reftex-kill-emacs-hook ()
+ "Call `reftex-kill-buffer-hook' on all buffers."
+ ;; This function should be installed in `kill-emacs-hook'.
+ (save-excursion
+ (mapcar (lambda (buf)
+ (set-buffer buf)
+ (reftex-kill-buffer-hook))
+ (buffer-list))))
-;;; ===========================================================================
+;;; =========================================================================
;;;
-;;; Interfaces for other packages
-;;; -----------------------------
-;;;
-;;; AUCTeX
-;;; ------
-
-(defun reftex-arg-label (optional &optional prompt definition)
- "Use reftex-label to create a label and insert it with TeX-argument-insert.
-This function is intended for AUCTeX macro support."
- (let ((label (reftex-label nil t)))
- (if (and definition (not (string-equal "" label)))
- (LaTeX-add-labels label))
- (TeX-argument-insert label optional optional)))
-
-(defun reftex-arg-ref (optional &optional prompt definition)
- "Use reftex-reference to select a label, insert it with TeX-argument-insert.
-This function is intended for AUCTeX macro support."
- (let ((label (reftex-reference nil t)))
- (if (and definition (not (string-equal "" label)))
- (LaTeX-add-labels label))
- (TeX-argument-insert label optional optional)))
-
-(defun reftex-arg-cite (optional &optional prompt definition)
- "Use reftex-citation to select a key, insert it with TeX-argument-insert.
-This function is intended for AUCTeX macro support."
- (let ((key (reftex-citation nil t)))
- (TeX-argument-insert (or key "") optional optional)))
-
-(defvar reftex-label-alist-external-add-ons nil
- "List of label alist entries added with reftex-add-to-label-alist.")
-
-;;;###autoload
-(defun reftex-add-to-label-alist (entry-list)
- "Add label environment descriptions to reftex-label-alist-external-add-ons.
-The format of ENTRY-LIST is exactly like reftex-label-alist. See there
-for details.
-This function makes it possible to support RefTeX from AUCTeX style files.
-The entries in ENTRY-LIST will be processed after the user settings in
-reftex-label-alist, and before the defaults (specified in
-reftex-default-label-alist-entries). Any changes made to
-reftex-label-alist-external-add-ons will raise a flag to the effect that a
-mode reset is done on the next occasion."
- (let (entry)
- (while entry-list
- (setq entry (car entry-list)
- entry-list (cdr entry-list))
- (if (not (member entry reftex-label-alist-external-add-ons))
- (setq reftex-tables-dirty t
- reftex-label-alist-external-add-ons
- (cons entry reftex-label-alist-external-add-ons))))))
-
-;;; ===========================================================================
+;;; Silence warnings about variables in other packages.
+(eval-when-compile
+ (defvar TeX-master)
+ (defvar LaTeX-section-hook)
+ (defvar LaTeX-label-function)
+ (defvar tex-main-file)
+ (defvar outline-minor-mode)
+ (defvar font-lock-mode)
+ (defvar font-lock-fontify-region-function)
+ (defvar font-lock-syntactic-keywords))
+
+;;; =========================================================================
;;;
-;;; Multifile support
+;;; Multibuffer Variables
;;;
-;;; Technical notes: Multifile works as follows: We keep just one list
+;;; Technical notes: These work as follows: We keep just one list
;;; of labels for each master file - this can save a lot of memory.
-;;; reftex-master-index-list is an alist which connects the true file name
+;;; `reftex-master-index-list' is an alist which connects the true file name
;;; of each master file with the symbols holding the information on that
-;;; document. Each buffer has local variables which point to these symbols.
-
+;;; document. Each buffer has local variables which point to these symbols.
;; List of variables which handle the multifile stuff.
;; This list is used to tie, untie, and reset these symbols.
(defconst reftex-multifile-symbols
- '(reftex-label-numbers-symbol reftex-list-of-labels-symbol
- reftex-bibfile-list-symbol))
+ '(reftex-docstruct-symbol))
-;; Alist connecting master file names with the corresponding lisp symbols
+;; Alist connecting master file names with the corresponding lisp symbols.
(defvar reftex-master-index-list nil)
-;; Last index used for a master file
+;; Last index used for a master file.
(defvar reftex-multifile-index 0)
-;; Alist connecting a master file with all included files.
-;; This information is not yet used, just collected.
-(defvar reftex-master-include-list nil)
-
-;; Variable holding the symbol with current value of label postfix
-(defvar reftex-label-numbers-symbol nil )
-(make-variable-buffer-local 'reftex-label-numbers-symbol)
-
;; Variable holding the symbol with the label list of the document.
-;; Each element of the label list is again a list with the following elements:
-;; 0: One character label type indicator
-;; 1: Short context to put into label menu
-;; 2: The label
-;; 3: The name of the file where the label is defined
-(defvar reftex-list-of-labels-symbol nil)
-(make-variable-buffer-local 'reftex-list-of-labels-symbol)
-
-;; Variable holding the symbol with a list of library files for this document
-(defvar reftex-bibfile-list-symbol nil)
-(make-variable-buffer-local 'reftex-bibfile-list-symbol)
+(defvar reftex-docstruct-symbol nil)
+(make-variable-buffer-local 'reftex-docstruct-symbol)
(defun reftex-next-multifile-index ()
;; Return the next free index for multifile symbols.
- (setq reftex-multifile-index (1+ reftex-multifile-index)))
+ (incf reftex-multifile-index))
(defun reftex-tie-multifile-symbols ()
;; Tie the buffer-local symbols to globals connected with the master file.
(let* ((master (file-truename (reftex-TeX-master-file)))
(index (assoc master reftex-master-index-list))
(symlist reftex-multifile-symbols)
- (symbol nil)
- (symname nil)
- (newflag nil))
- ;; find the correct index
+ symbol symname newflag)
+ ;; Find the correct index.
(if index
;; symbols do exist
(setq index (cdr index))
- ;; get a new index and add info to the alist
+ ;; Get a new index and add info to the alist.
(setq index (reftex-next-multifile-index)
- reftex-master-index-list (cons
- (cons master index)
- reftex-master-index-list)
- newflag t))
+ newflag t)
+ (push (cons master index) reftex-master-index-list))
- ;; get/create symbols and tie them
+ ;; Get/create symbols and tie them.
(while symlist
(setq symbol (car symlist)
symlist (cdr symlist)
symname (symbol-name symbol))
(set symbol (intern (concat symname "-" (int-to-string index))))
- ;; initialize if new symbols
- (if newflag (set (symbol-value symbol) nil)))
+ (put (symbol-value symbol) :master-index index)
+ ;; Initialize if new symbols.
+ (when newflag
+ (set (symbol-value symbol) nil)
+ (put (symbol-value symbol) 'reftex-index-macros-style '(default))))
- ;; Return t if the symbols did already exist, nil when we've made them
+ ;; Return t if the symbols did already exist, nil when we've made them.
(not newflag)))
(defun reftex-untie-multifile-symbols ()
(defun reftex-TeX-master-file ()
;; Return the name of the master file associated with the current buffer.
;; When AUCTeX is loaded, we will use it's more sophisticated method.
- ;; We also support the default TeX and LaTeX modes
- ;; by checking for a variable tex-main-file.
-
+ ;; We also support the default TeX and LaTeX modes by checking for a
+ ;; variable tex-main-file.
(let
((master
(cond
- ((fboundp 'TeX-master-file) ; AUCTeX is loaded. Use its mechanism.
- (TeX-master-file t))
+ ((fboundp 'TeX-master-file) ; AUCTeX is loaded. Use its mechanism.
+ (condition-case nil
+ (TeX-master-file t)
+ (error (buffer-file-name))))
+ ((fboundp 'tex-main-file) (tex-main-file)) ; Emacs LaTeX mode
((boundp 'TeX-master) ; The variable is defined - lets use it.
(cond
((eq TeX-master t)
(setq TeX-master (read-file-name "Master file: "
nil nil t nil)))))
((boundp 'tex-main-file)
- ;; This is the variable from the default TeX modes
+ ;; This is the variable from the default TeX modes.
(cond
((stringp tex-main-file)
;; ok, this must be it
tex-main-file)
(t
- ;; In this case, the buffer is its own master
+ ;; In this case, the buffer is its own master.
(buffer-file-name))))
(t
- ;; Know nothing about master file. Assume this is a master file.
+ ;; Know nothing about master file. Assume this is a master file.
(buffer-file-name)))))
(cond
((null master)
- (error "Need a filename for this buffer. Please save it first."))
- ((or (file-exists-p master)
- (reftex-get-buffer-visiting master))
- ;; We either see the file, or have a buffer on it. OK.
- )
+ (error "Need a filename for this buffer, please save it first"))
((or (file-exists-p (concat master ".tex"))
(reftex-get-buffer-visiting (concat master ".tex")))
;; Ahh, an extra .tex was missing...
(setq master (concat master ".tex")))
+ ((or (file-exists-p master)
+ (reftex-get-buffer-visiting master))
+ ;; We either see the file, or have a buffer on it. OK.
+ )
(t
- ;; Something is wrong here. Throw an exception.
- (error "No such master file %s" master)))
+ ;; Use buffer file name.
+ (buffer-file-name)))
(expand-file-name master)))
-(defun reftex-make-master-buffer (master-file mode)
- "Make a master buffer which contains the MASTER-FILE and all includes.
-This is to prepare a buffer containing the entire document in correct
-sequence for parsing. Therefore it will even expand includes which are
-commented out.
-The function returns the number of input/include files not found."
-
- (interactive "fmaster file: ")
- (let ((not-found 0) file file-list tmp (font-lock-maximum-size 1))
- (switch-to-buffer "*reftex-master.tex*")
- (erase-buffer)
- (if (not (eq major-mode mode))
- (funcall mode))
- ;; first insert the master file
- (if (not (file-exists-p master-file))
- (error "No such master file: %s" master-file))
- (reftex-insert-buffer-or-file master-file)
- (subst-char-in-region (point-min) (point-max) ?\r ?\n t)
- (setq file-list (cons master-file file-list))
- (goto-char 1)
- ;; remember from which file these lines came
- (put-text-property (point-min) (point-max) 'file
- (expand-file-name master-file))
- ;; Now find recursively all include/input statements and expand them
- (while (re-search-forward
- "^[ \t]*\\\\\\(include\\|input\\){\\([^}\n]+\\)}" nil t)
- ;; Change default directory, so that relative fine names work correctly
- (setq file (reftex-no-props (match-string 2)))
- (save-match-data
- (cd (file-name-directory
- (get-text-property (match-beginning 0) 'file)))
- (if (not (string-match "\\.tex$" file))
- (setq file (concat file ".tex"))))
- (if (file-exists-p file)
- (progn
- (replace-match
- (format "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% START OF %s FILE: %s\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% END OF %s FILE: %s\n"
- (match-string 1) file
- (match-string 1) file))
- (beginning-of-line 0)
- (narrow-to-region (point) (point))
- ;; insert the file
- (reftex-insert-buffer-or-file file)
- (subst-char-in-region (point-min) (point-max) ?\r ?\n t)
- (setq file-list (cons (expand-file-name file) file-list))
- ;; remember from which file these lines came
- (put-text-property (point-min) (point-max)
- 'file (expand-file-name file))
- (goto-char (point-min))
- (widen))
- (message "Input/include file %s not found. Ignored. Continuing..."
- file)
- (setq not-found (1+ not-found))))
- (setq file-list (nreverse file-list))
- (while (setq tmp (assoc (car file-list) reftex-master-include-list))
- (setq reftex-master-include-list (delq tmp reftex-master-include-list)))
- (setq reftex-master-include-list (cons file-list reftex-master-include-list))
- not-found))
-
-(defun reftex-insert-buffer-or-file (file)
- "If there is a buffer associated with FILE, insert it - otherwise the FILE."
- (let ((buffer (reftex-get-buffer-visiting file)))
- (if buffer
- (let (beg end beg1 end1)
- (save-excursion
- ;; make sure we get the whole buffer
- (set-buffer buffer)
- (setq beg (point-min) end (point-max))
- (widen)
- (setq beg1 (point-min) end1 (point-max)))
- (insert-buffer-substring buffer beg1 end1)
- (save-excursion
- (set-buffer buffer)
- (narrow-to-region beg end)))
- (insert-file-contents file))))
-
-
-(defun reftex-parse-document (&optional buffer)
- "Rescan the document."
- (interactive)
- (save-window-excursion
- (save-excursion
- (if buffer
- (if (not (bufferp buffer))
- (error "No such buffer %s" (buffer-name buffer))
- (set-buffer buffer)))
- (reftex-access-scan-info t))))
-
-(defun reftex-access-scan-info (&optional rescan)
- ;; Access the scanning info. When the multifile symbols are not yet tied,
- ;; tie them. When they are have to be created, do a buffer scan to
- ;; fill them.
-
- ;; If RESCAN is non-nil, enforce document scanning
-
- (catch 'exit
- (let ((rescan (or (equal rescan t) (equal rescan '(4)))))
-
- ;; Reset the mode if we had changes from style hooks
- (and reftex-tables-dirty
- (reftex-reset-mode))
-
- (if (eq reftex-list-of-labels-symbol nil)
- ;; Symbols are not yet tied: Tie them and see if they are set
- (reftex-tie-multifile-symbols))
-
- (if (and (symbol-value reftex-list-of-labels-symbol)
- (not rescan))
- ;; Lists do already exist and we don't need to rescan.
- ;; Return from here.
- (throw 'exit t))
-
- ;; We need to rescan
- ;; =================
-
- (unwind-protect
- (save-window-excursion
- (save-excursion
-
- ;; do the scanning
-
- (let ((label-list-symbol reftex-list-of-labels-symbol)
- (label-numbers-symbol reftex-label-numbers-symbol)
- (bibfile-list-symbol reftex-bibfile-list-symbol))
-
- (message "Creating master buffer...")
- (reftex-make-master-buffer (reftex-TeX-master-file) major-mode)
-
- (message "Scanning document...")
-
- (reftex-scan-buffer-for-labels
- label-numbers-symbol label-list-symbol)
-
- (reftex-scan-buffer-for-bibliography-statement
- bibfile-list-symbol)
-
- (message "Scanning document... done"))))
-
- (if (get-buffer "*reftex-master.tex*")
- (kill-buffer "*reftex-master.tex*"))))))
-
-(defun reftex-create-tags-file ()
- "Create TAGS file by running `etags' on the current document.
-The TAGS file is also immediately visited with `visit-tags-table."
- (interactive)
- (reftex-access-scan-info current-prefix-arg)
- (let* ((master (reftex-TeX-master-file))
- (files (assoc master reftex-master-include-list))
- (cmd (format "etags %s" (mapconcat 'identity files " "))))
- (save-excursion
- (set-buffer (reftex-get-buffer-visiting master))
- (message "Running etags to create TAGS file...")
- (shell-command cmd)
- (visit-tags-table "TAGS"))))
-
-;; History of grep commands.
-(defvar reftex-grep-history nil)
-(defvar reftex-grep-command "grep -n "
- "Last grep command used in \\[reftex-grep-document]; default for next grep.")
-
-(defun reftex-grep-document (grep-cmd)
- "Run grep query through all files related to this document.
-With prefix arg, force to rescan document.
-This works also without an active TAGS table."
-
- (interactive
- (list (read-from-minibuffer "Run grep on document (like this): "
- reftex-grep-command nil nil
- 'reftex-grep-history)))
- (reftex-access-scan-info current-prefix-arg)
- (let* ((master (reftex-TeX-master-file))
- (default-directory (file-name-directory master))
- (re (format "\\`%s\\(.*\\)" (regexp-quote
- (expand-file-name default-directory))))
- (files (assoc master reftex-master-include-list))
- (cmd (format
- "%s %s" grep-cmd
- (mapconcat (function (lambda (x)
- (if (string-match re x)
- (match-string 1 x)
- x)))
- files " "))))
- (grep cmd)))
-
-(defun reftex-search-document (&optional regexp)
- "Regexp search through all files of the current TeX document.
-Starts always in the master file. Stops when a match is found.
-To continue searching for next match, use command \\[tags-loop-continue].
-This works also without an active TAGS table."
- (interactive)
- (let ((default (reftex-this-word)))
- (if (not regexp)
- (setq regexp (read-string (format "Search regexp in document [%s]: "
- default))))
- (if (string= regexp "") (setq regexp (regexp-quote default)))
-
- (reftex-access-scan-info current-prefix-arg)
- (tags-search regexp (list 'assoc (reftex-TeX-master-file)
- 'reftex-master-include-list))))
-
-(defun reftex-query-replace-document (&optional from to delimited)
- "Run a query-replace-regexp of FROM with TO over the entire TeX document.
-Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
-If you exit (\\[keyboard-quit] or ESC), you can resume the query replace
-with the command \\[tags-loop-continue].
-This works also without an active TAGS table."
- (interactive)
- (let ((default (reftex-this-word)))
- (if (not from)
- (progn
- (setq from (read-string (format "Replace regexp in document [%s]: "
- default)))
- (if (string= from "") (setq from (regexp-quote default)))))
- (if (not to)
- (setq to (read-string (format "Replace regexp %s with: " from))))
- (reftex-access-scan-info current-prefix-arg)
- (tags-query-replace from to (or delimited current-prefix-arg)
- (list 'assoc (reftex-TeX-master-file)
- 'reftex-master-include-list))))
-
-(defun reftex-change-label (&optional from to)
- "Query replace FROM with TO in all \\label{} and \\ref{} commands.
-Works on the entire multifile document.
-If you exit (\\[keyboard-quit] or ESC), you can resume the query replace
-with the command \\[tags-loop-continue].
-This works also without an active TAGS table."
- (interactive)
- (let ((default (reftex-this-word "-a-zA-Z0-9_*.:")))
- (if (not from)
- (setq from (read-string (format "Replace label globally [%s]: "
- default))))
- (if (string= from "") (setq from default))
- (if (not to)
- (setq to (read-string (format "Replace label %s with: "
- from))))
- (reftex-query-replace-document
- (concat "\\\\\\(label\\|[a-z]*ref\\){" (regexp-quote from) "}")
- (format "\\\\\\1{%s}" to))))
-
-(defun reftex-this-word (&optional class)
-;; grab the word around point
- (setq class (or class "-a-zA-Z0-9:_/.*;|"))
- (save-excursion
- (buffer-substring-no-properties
- (progn (skip-chars-backward class) (point))
- (progn (skip-chars-forward class) (point)))))
-
-;;; ===========================================================================
+(defun reftex-is-multi ()
+ ;; Tell if this is a multifile document. When not sure, say yes.
+ (let ((entry (assq 'is-multi (symbol-value reftex-docstruct-symbol))))
+ (if entry
+ (nth 1 entry)
+ t)))
+
+(defun reftex-set-cite-format (value)
+ "Set the document-local value of `reftex-cite-format'.
+When such a value exists, it overwrites the setting given with
+`reftex-cite-format'. See the documentation of `reftex-cite-format'
+for possible values. This function should be used from AUCTeX style files."
+ (unless reftex-docstruct-symbol
+ (reftex-tie-multifile-symbols))
+ (when (and reftex-docstruct-symbol
+ (symbolp reftex-docstruct-symbol))
+ (put reftex-docstruct-symbol 'reftex-cite-format value)))
+
+(defun reftex-get-cite-format ()
+ ;; Return the current citation format. Either the document-local value in
+ ;; reftex-cite-format-symbol, or the global value in reftex-cite-format.
+ (if (and reftex-docstruct-symbol
+ (symbolp reftex-docstruct-symbol)
+ (get reftex-docstruct-symbol 'reftex-cite-format))
+ (get reftex-docstruct-symbol 'reftex-cite-format)
+ reftex-cite-format))
+
+(defun reftex-add-index-macros (entry-list)
+ "Add index macro descriptions to `reftex-index-macros-style'.
+The format of ENTRY-LIST is exactly like `reftex-index-macros'. See there
+for details.
+This function makes it possible to support RefTeX from AUCTeX style files.
+The entries in ENTRY-LIST will be processed after the user settings in
+`reftex-index-entries', and before the defaults. Any changes made to
+`reftex-label-alist-style' will raise a flag to the effect that
+the label information is recompiled on next use."
+ (unless reftex-docstruct-symbol
+ (reftex-tie-multifile-symbols))
+ (when (and reftex-docstruct-symbol
+ (symbolp reftex-docstruct-symbol))
+ (let ((list (get reftex-docstruct-symbol 'reftex-index-macros-style))
+ entry changed)
+ (while entry-list
+ (setq entry (pop entry-list))
+ ;; When it is a symbol, remove all other symbols
+ (and (symbolp entry)
+ (not (memq entry list))
+ (setq list (reftex-remove-symbols-from-list list)))
+ ;; Add to list unless already member
+ (unless (member entry list)
+ (setq reftex-tables-dirty t
+ changed t)
+ (push entry list)))
+ (when changed
+ (put reftex-docstruct-symbol 'reftex-index-macros-style list)))))
+
+;;; =========================================================================
;;;
-;;; Functions to create and reference automatic labels
+;;; Functions to compile the tables, reset the mode etc.
-;; The following constants are derived from reftex-label-alist
+;; The following constants are derived from `reftex-label-alist'.
-;; Prompt used for label type querys directed to the user
+;; Prompt used for label type queries directed to the user.
(defconst reftex-type-query-prompt nil)
-;; Help string for label type querys
+;; Help string for label type queries.
(defconst reftex-type-query-help nil)
-;; Alist relating label type to reference format
+;; Alist relating label type to reference format.
(defconst reftex-typekey-to-format-alist nil)
-;; Alist relating label type to label affix
+;; Alist relating label type to label prefix.
(defconst reftex-typekey-to-prefix-alist nil)
-;; Alist relating environments or macros to label type and context regexp
+;; Alist relating environments or macros to label type and context regexp.
(defconst reftex-env-or-mac-alist nil)
-;; List of macros carrying a label
+;; List of special environment parser functions
+(defconst reftex-special-env-parsers nil)
+
+;; List of macros carrying a label.
(defconst reftex-label-mac-list nil)
-;; List of environments carrying a label
+;; List of environments carrying a label.
(defconst reftex-label-env-list nil)
-;; List of all typekey letters in use
+;; List of all typekey letters in use.
(defconst reftex-typekey-list nil)
-;; Alist relating magic words to a label type
+;; Alist relating magic words to a label type.
(defconst reftex-words-to-typekey-alist nil)
-;; The last list-of-labels entry used in a reference
+;; The last list-of-labels entry used in a reference.
(defvar reftex-last-used-reference (list nil nil nil nil))
-;; The regular expression used to abbreviate words
-(defconst reftex-abbrev-regexp
- (concat
- "^\\("
- (make-string (nth 0 reftex-abbrev-parameters) ?.)
- "[" (nth 2 reftex-abbrev-parameters) "]*"
- "\\)"
- "[" (nth 3 reftex-abbrev-parameters) "]"
- (make-string (1- (nth 1 reftex-abbrev-parameters)) ?.)))
-
-;; Global variables used for communication between functions
+;; Alist relating index macros to other info.
+(defconst reftex-key-to-index-macro-alist nil)
+;; Prompt for index macro queries
+(defconst reftex-query-index-macro-prompt nil)
+;; Help string for index macro queries
+(defconst reftex-query-index-macro-help nil)
+
+;; The message when follow-mode is suspended
+(defconst reftex-no-follow-message
+ "No follow-mode into unvisited file. Press SPC to visit it.")
+(defconst reftex-no-info-message
+ "%s: info not available, use `\\[reftex-view-crossref]' to get it.")
+
+;; Global variables used for communication between functions.
(defvar reftex-default-context-position nil)
(defvar reftex-location-start nil)
(defvar reftex-call-back-to-this-buffer nil)
+(defvar reftex-select-return-marker (make-marker))
+(defvar reftex-active-toc nil)
+(defvar reftex-tex-path nil)
+(defvar reftex-bib-path nil)
+(defvar reftex-select-marked nil)
+(defvar reftex-last-follow-point nil)
+(defvar reftex-latex-syntax-table nil)
+(defvar reftex-prefix nil)
+(defvar reftex-section-levels-all nil)
+(defvar reftex-buffers-with-changed-invisibility nil)
+(defvar reftex-callback-fwd t)
+(defvar reftex-last-toc-master nil
+ "Stores the name of the tex file that `reftex-toc' was last run on.")
+(defvar reftex-auto-view-crossref-timer nil
+ "The timer used for auto-view-crossref.")
+;; Marker for return point from recursive edit
+(defvar reftex-recursive-edit-marker (make-marker))
-;; List of buffers created temporarily for lookup, which should be killed
+;; List of buffers created temporarily for lookup, which should be killed.
(defvar reftex-buffers-to-kill nil)
-;; The regexp used to find section statements
-(defconst reftex-section-regexp "^[ ]*\\\\\\(part\\|chapter\\|section\\|subsection\\|subsubsection\\|paragraph\\|subparagraph\\|subsubparagraph\\)\\*?\\(\\[[^]]*\\]\\)?{")
-
-;; LaTeX section commands and level numbers
-(defconst reftex-section-levels
- '(
- ("part" . 0)
- ("chapter" . 1)
- ("section" . 2)
- ("subsection" . 3)
- ("subsubsection" . 4)
- ("paragraph" . 5)
- ("subparagraph" . 6)
- ("subsubparagraph" . 7)
- ))
-
-(defun reftex-label (&optional environment no-insert)
- "Insert a unique label. Return the label.
-If ENVIRONMENT is given, don't bother to find out yourself.
-If NO-INSERT is non-nil, do not insert label into buffer.
-With prefix arg, force to rescan document first.
-The label is also inserted into the label list.
-This function is controlled by the settings of reftex-insert-label-flags."
+;; Regexp to find anything.
+(defvar reftex-section-regexp nil)
+(defvar reftex-section-or-include-regexp nil)
+(defvar reftex-index-macro-regexp nil)
+(defvar reftex-index-level-re nil)
+(defvar reftex-index-key-end-re nil)
+(defvar reftex-find-index-entry-regexp-format nil)
+(defvar reftex-everything-regexp nil)
+(defvar reftex-everything-regexp-no-index nil)
+(defvar reftex-index-re nil)
+(defvar reftex-find-citation-regexp-format
+ "\\\\\\([a-zA-Z]*cite[*a-zA-Z]*\\*?\\|bibentry\\)\\(\\[[^]]*\\]\\|{[^}]*}\\)*{\\([^}]*,\\)?\\(%s\\)[},]")
+(defvar reftex-find-reference-format
+ "\\\\\\(ref[a-zA-Z]*\\|[a-zA-Z]*ref\\(range\\)?\\)\\*?\\(\\[[^]]*\\]\\|{[^}]*}\\)*{\\(%s\\)}")
+(defvar reftex-macros-with-labels nil)
+(defvar reftex-macros-with-index nil)
+(defvar reftex-index-macro-alist nil)
+(defvar reftex-find-label-regexp-format nil)
+(defvar reftex-find-label-regexp-format2 nil)
+
+(defvar reftex-memory nil
+ "Memorizes old variable values to indicate changes in these variables.")
+
+;; A list of all variables in the cache.
+;; The cache is used to save the compiled versions of some variables.
+(defconst reftex-cache-variables
+ '(reftex-memory ;; This MUST ALWAYS be the first!
+
+ ;; Outline
+ reftex-section-levels-all
+
+ ;; Labels
+ reftex-env-or-mac-alist
+ reftex-special-env-parsers
+ reftex-macros-with-labels
+ reftex-label-mac-list
+ reftex-label-env-list
+ reftex-typekey-list
+ reftex-typekey-to-format-alist
+ reftex-typekey-to-prefix-alist
+ reftex-words-to-typekey-alist
+ reftex-type-query-prompt
+ reftex-type-query-help
+
+ ;; Index
+ reftex-index-macro-alist
+ reftex-macros-with-index
+ reftex-query-index-macro-prompt
+ reftex-query-index-macro-help
+ reftex-key-to-index-macro-alist
+
+ ;; Regular expressions
+ reftex-section-regexp
+ reftex-section-or-include-regexp
+ reftex-index-re
+ reftex-everything-regexp
+ reftex-everything-regexp-no-index
+ reftex-find-label-regexp-format
+ reftex-find-label-regexp-format2
+ reftex-find-index-entry-regexp-format
+))
+
+(defun reftex-ensure-compiled-variables ()
+ ;; Recompile the label alist when necessary
+ (let* ((mem reftex-memory)
+ (cache (get reftex-docstruct-symbol 'reftex-cache))
+ (cmem (car cache))
+ (alist reftex-label-alist)
+ (levels (get reftex-docstruct-symbol 'reftex-section-levels))
+ (style (get reftex-docstruct-symbol 'reftex-label-alist-style))
+ (default reftex-default-label-alist-entries)
+ (index reftex-index-macros)
+ (istyle (get reftex-docstruct-symbol 'reftex-index-macros-style)))
+ (cond
+ (reftex-tables-dirty (reftex-compile-variables))
+ ((and (eq alist (nth 0 mem))
+ (eq levels (nth 1 mem))
+ (eq style (nth 2 mem))
+ (eq default (nth 3 mem))
+ (eq index (nth 4 mem))
+ (eq istyle (nth 5 mem)))) ;; everything is OK
+ ((and (eq alist (nth 0 cmem))
+ (eq levels (nth 1 cmem))
+ (eq style (nth 2 cmem))
+ (eq default (nth 2 cmem))
+ (eq index (nth 4 cmem))
+ (eq istyle (nth 5 cmem)))
+ ;; restore the cache
+ (message "Restoring cache")
+ (mapcar (lambda (sym) (set sym (pop cache))) reftex-cache-variables))
+ (t (reftex-compile-variables)))))
+(defun reftex-reset-mode ()
+ "Reset RefTeX Mode.
+This will re-compile the configuration information and remove all
+current scanning information and the parse file to enforce a rescan
+on next use."
(interactive)
- ;; Ensure access to scanning info and rescan buffer if prefix are is '(4)
- (reftex-access-scan-info current-prefix-arg)
+ ;; Reset the file search path variables
+ (loop for prop in '(status master-dir recursive-path rec-type) do
+ (put 'reftex-tex-path prop nil)
+ (put 'reftex-bib-path prop nil))
- ;; Find out what kind of environment this is and abort if necessary
- (if (or (not environment)
- (not (assoc environment reftex-env-or-mac-alist)))
- (setq environment (reftex-label-location)))
- (if (not environment)
- (error "Can't figure out what kind of label should be inserted"))
+ ;; Kill temporary buffers associated with RefTeX - just in case they
+ ;; were not cleaned up properly
+ (save-excursion
+ (let ((buffer-list '("*RefTeX Help*" "*RefTeX Select*"
+ "*Duplicate Labels*" "*toc*" " *RefTeX-scratch*"))
+ buf)
+ (while (setq buf (pop buffer-list))
+ (if (get-buffer buf)
+ (kill-buffer buf))))
+ (reftex-erase-all-selection-and-index-buffers))
- ;; Ok, go ahead
- (let (label num typekey prefix entry cell lab valid default force-prompt)
- (setq typekey (nth 1 (assoc environment
- reftex-env-or-mac-alist)))
- (setq prefix (or (cdr (assoc typekey reftex-typekey-to-prefix-alist))
- (concat typekey "-")))
+ ;; Make sure the current document will be rescanned soon.
+ (reftex-reset-scanning-information)
- ;; make a default label
- (cond
+ ;; Remove any parse info file
+ (reftex-access-parse-file 'kill)
- ((reftex-typekey-check typekey (nth 0 reftex-insert-label-flags))
- ;; derive a label from context
- (setq default (nth 2 (reftex-label-info " ")))
- ;; catch the cases where the is actually no context available
- (if (or (string-match "NO MATCH FOR CONTEXT REGEXP" default)
- (string-match "ILLEGAL VALUE OF PARSE" default)
- (string-match "SECTION HEADING NOT FOUND" default)
- (string-match "HOOK ERROR" default)
- (string-match "^[ \t]*$" default))
- (setq default prefix
- force-prompt t) ; need to prompt
- (setq default (concat prefix (reftex-string-to-label default)))
-
- ;; make it unique
- (setq label default)
- (setq num 1)
- (while (assoc label (symbol-value reftex-list-of-labels-symbol))
- (setq label (concat default "-" (setq num (1+ num)))))
- (setq default label)))
-
- ((reftex-typekey-check typekey (nth 1 reftex-insert-label-flags)) ; prompt
- ;; Minimal default: the user will be prompted
- (setq default prefix))
+ ;; Plug functions into AUCTeX if the user option says so.
+ (and reftex-plug-into-AUCTeX
+ (reftex-plug-into-AUCTeX))
- (t
- ;; make an automatic label
- (while (assoc
- (setq default (concat prefix (reftex-next-label-number typekey)))
- (symbol-value reftex-list-of-labels-symbol)))))
+ (reftex-compile-variables))
- ;; Should we ask the user?
- (if (or (reftex-typekey-check typekey
- (nth 1 reftex-insert-label-flags)) ; prompt
- force-prompt)
+(defun reftex-reset-scanning-information ()
+ "Reset the symbols containing information from buffer scanning.
+This enforces rescanning the buffer on next use."
+ (if (string= reftex-last-toc-master (reftex-TeX-master-file))
+ (reftex-erase-buffer "*toc*"))
+ (let ((symlist reftex-multifile-symbols)
+ symbol)
+ (while symlist
+ (setq symbol (car symlist)
+ symlist (cdr symlist))
+ (if (and (symbolp (symbol-value symbol))
+ (not (null (symbol-value symbol))))
+ (set (symbol-value symbol) nil)))))
- (while (not valid)
- ;; iterate until we get a legal label
+(defun reftex-erase-all-selection-and-index-buffers ()
+ ;; Remove all selection buffers associated with current document.
+ (mapcar
+ (lambda (type)
+ (reftex-erase-buffer (reftex-make-selection-buffer-name type)))
+ reftex-typekey-list)
+ ;; Kill all index buffers
+ (mapcar
+ (lambda (tag)
+ (reftex-kill-buffer (reftex-make-index-buffer-name tag)))
+ (cdr (assoc 'index-tags (symbol-value reftex-docstruct-symbol)))))
- (setq label (read-string "Label: " default))
+(defun reftex-compile-variables ()
+ ;; Compile the information in reftex-label-alist & Co.
- ;; Lets make sure that this is a legal label
- (cond
+ (message "Compiling label environment definitions...")
- ;; Test if label contains strange characters
- ((string-match reftex-label-illegal-re label)
- (message "Label \"%s\" contains illegal characters" label)
- (ding)
- (sit-for 2))
+ ;; Update AUCTeX style information
+ (when (and (featurep 'tex-site) (fboundp 'TeX-update-style))
+ (condition-case nil (TeX-update-style) (error nil)))
- ;; Look it up in the label list
- ((setq entry (assoc label
- (symbol-value reftex-list-of-labels-symbol)))
- (message "Label \"%s\" exists in file %s" label (nth 3 entry))
- (ding)
- (sit-for 2))
+ ;; Record that we have done this, and what we have used.
+ (setq reftex-tables-dirty nil)
+ (setq reftex-memory
+ (list reftex-label-alist
+ (get reftex-docstruct-symbol 'reftex-section-levels)
+ (get reftex-docstruct-symbol 'reftex-label-alist-style)
+ reftex-default-label-alist-entries
+ reftex-index-macros
+ (get reftex-docstruct-symbol 'reftex-index-macros-style)))
- ;; Label is ok
- (t
- (setq valid t))))
- (setq label default))
-
- ;; Insert the label
- (if (not no-insert)
- (insert "\\label{" label "}"))
-
- ;; Insert the label into the label list
- (if (symbol-value reftex-list-of-labels-symbol)
- (let ((cnt 0)
- (pos (point))
- (all (symbol-value reftex-list-of-labels-symbol))
- (look-for nil)
- (note nil)
- (text nil)
- (file (buffer-file-name)))
-
- ;; find the previous label in order to know where to insert new label
- ;; into label list
- (save-excursion
- (if (re-search-backward "\\\\label{\\([^}]+\\)}" nil 1 2)
- (setq look-for (reftex-no-props (match-string 1))))
- (if (or (re-search-forward
- "\\\\\\(include\\|input\\){[^}\n]+}" pos t)
- (re-search-forward reftex-section-regexp pos t)
- (null look-for))
- (setq note "POSITION UNCERTAIN. RESCAN TO FIX.")))
- (if (not look-for)
- (set reftex-list-of-labels-symbol
- (cons (list label typekey text file note)
- (symbol-value reftex-list-of-labels-symbol)))
- (while all
- (setq cell (car all)
- all (cdr all)
- cnt (1+ cnt)
- lab (nth 0 cell))
- (if (string= lab look-for)
- (progn
- (setcdr
- (nthcdr (1- cnt)
- (symbol-value reftex-list-of-labels-symbol))
- (cons (list label typekey text file note)
- (nthcdr
- cnt (symbol-value reftex-list-of-labels-symbol))))
- ;; to end the loop, set all to nil
- (setq all nil)))))))
- ;; return value of the function is the label
- label))
-
-(defun reftex-string-to-label (string)
- ;; Convert a string (a sentence) to a label.
- ;;
- ;; Uses reftex-derive-label-parameters and reftex-abbrev-parameters
- ;;
-
- (let* ((words0 (reftex-split "[- \t\n\r]+"
- (reftex-no-props string)))
- (ignore-words (nth 5 reftex-derive-label-parameters))
- words word)
+ ;; Compile information in reftex-label-alist
+ (let ((all (reftex-uniquify-by-car
+ (reftex-splice-symbols-into-list
+ (append reftex-label-alist
+ (get reftex-docstruct-symbol
+ 'reftex-label-alist-style)
+ reftex-default-label-alist-entries)
+ reftex-label-alist-builtin)
+ '(nil)))
+ (all-index (reftex-uniquify-by-car
+ (reftex-splice-symbols-into-list
+ (append reftex-index-macros
+ (get reftex-docstruct-symbol
+ 'reftex-index-macros-style)
+ '(default))
+ reftex-index-macros-builtin)))
+ entry env-or-mac typekeychar typekey prefix context word
+ fmt reffmt labelfmt wordlist qh-list macros-with-labels
+ nargs nlabel opt-args cell sum i
+ macro verify repeat nindex tag key toc-level toc-levels)
- ;; remove words from the ignore list or with funny characters
- (while words0
- (setq word (car words0) words0 (cdr words0))
- (cond
- ((member (downcase word) ignore-words))
- ((string-match reftex-label-illegal-re word)
- (if (nth 2 reftex-derive-label-parameters)
- (progn
- (while (string-match reftex-label-illegal-re word)
- (setq word (replace-match "" nil nil word)))
- (setq words (cons word words)))))
- (t
- (setq words (cons word words)))))
- (setq words (nreverse words))
+ (setq reftex-words-to-typekey-alist nil
+ reftex-typekey-list nil
+ reftex-typekey-to-format-alist nil
+ reftex-typekey-to-prefix-alist nil
+ reftex-env-or-mac-alist nil
+ reftex-label-env-list nil
+ reftex-label-mac-list nil)
+ (while all
+ (catch 'next-entry
+ (setq entry (car all)
+ env-or-mac (car entry)
+ entry (cdr entry)
+ all (cdr all))
+ (if (null env-or-mac)
+ (setq env-or-mac ""))
+ (if (stringp (car entry))
+ ;; This is before version 2.00 - convert entry to new format
+ ;; This is just to keep old users happy
+ (setq entry (cons (string-to-char (car entry))
+ (cons (concat (car entry) ":")
+ (cdr entry)))))
+ (setq typekeychar (nth 0 entry)
+ typekey (if typekeychar (char-to-string typekeychar) nil)
+ prefix (nth 1 entry)
+ fmt (nth 2 entry)
+ context (nth 3 entry)
+ wordlist (nth 4 entry)
+ toc-level (nth 5 entry))
+ (if (stringp wordlist)
+ ;; This is before version 2.04 - convert to new format
+ (setq wordlist (nthcdr 4 entry)))
+
+ (if (and (stringp fmt)
+ (string-match "@" fmt))
+ ;; Special syntax for specifying a label format
+ (setq fmt (split-string fmt "@+"))
+ (setq fmt (list "\\label{%s}" fmt)))
+ (setq labelfmt (car fmt)
+ reffmt (nth 1 fmt))
+ ;; Note a new typekey
+ (if typekey
+ (add-to-list 'reftex-typekey-list typekey))
+ (if (and typekey prefix
+ (not (assoc typekey reftex-typekey-to-prefix-alist)))
+ (add-to-list 'reftex-typekey-to-prefix-alist
+ (cons typekey prefix)))
+ ;; Check if this is a macro or environment
+ (cond
+ ((symbolp env-or-mac)
+ ;; A special parser function
+ (unless (fboundp env-or-mac)
+ (message "Warning: %s does not seem to be a valid function"
+ env-or-mac))
+ (setq nargs nil nlabel nil opt-args nil)
+ (add-to-list 'reftex-special-env-parsers env-or-mac)
+ (setq env-or-mac (symbol-name env-or-mac)))
+ ((string-match "\\`\\\\" env-or-mac)
+ ;; It's a macro
+ (let ((result (reftex-parse-args env-or-mac)))
+ (setq env-or-mac (or (first result) env-or-mac)
+ nargs (second result)
+ nlabel (third result)
+ opt-args (fourth result))
+ (if nlabel (add-to-list 'macros-with-labels env-or-mac)))
+ (if typekey (add-to-list 'reftex-label-mac-list env-or-mac)))
+ (t
+ ;; It's an environment
+ (setq nargs nil nlabel nil opt-args nil)
+ (cond ((string= env-or-mac "any"))
+ ((string= env-or-mac ""))
+ ((string= env-or-mac "section"))
+ (t
+ (add-to-list 'reftex-label-env-list env-or-mac)
+ (if toc-level
+ (let ((string (format "begin{%s}" env-or-mac)))
+ (or (assoc string toc-levels)
+ (push (cons string toc-level) toc-levels))))))))
+ ;; Translate some special context cases
+ (when (assq context reftex-default-context-regexps)
+ (setq context
+ (format
+ (cdr (assq context reftex-default-context-regexps))
+ (regexp-quote env-or-mac))))
+ ;; See if this is the first format for this typekey
+ (and reffmt
+ (not (assoc typekey reftex-typekey-to-format-alist))
+ (push (cons typekey reffmt) reftex-typekey-to-format-alist))
+ ;; See if this is the first definition for this env-or-mac
+ (and (not (string= env-or-mac "any"))
+ (not (string= env-or-mac ""))
+ (not (assoc env-or-mac reftex-env-or-mac-alist))
+ (push (list env-or-mac typekey context labelfmt
+ nargs nlabel opt-args)
+ reftex-env-or-mac-alist))
+ ;; Are the magic words regular expressions? Quote normal words.
+ (if (eq (car wordlist) 'regexp)
+ (setq wordlist (cdr wordlist))
+ (setq wordlist (mapcar 'regexp-quote wordlist)))
+ ;; Remember the first association of each word.
+ (while (stringp (setq word (pop wordlist)))
+ (or (assoc word reftex-words-to-typekey-alist)
+ (push (cons word typekey) reftex-words-to-typekey-alist)))
+ (cond
+ ((string= "" env-or-mac) nil)
+ ((setq cell (assoc typekey qh-list))
+ (push env-or-mac (cdr cell)))
+ (typekey
+ (push (list typekey env-or-mac) qh-list)))))
- ;; restrict number of words
- (if (> (length words) (nth 0 reftex-derive-label-parameters))
- (setcdr (nthcdr (1- (nth 0 reftex-derive-label-parameters)) words) nil))
+ (setq reftex-typekey-to-prefix-alist
+ (nreverse reftex-typekey-to-prefix-alist))
- ;; First, try to use all words
- (setq string (mapconcat '(lambda(w) w) words
- (nth 4 reftex-derive-label-parameters)))
+ ;; Prepare the typekey query prompt and help string.
+ (setq qh-list
+ (sort qh-list
+ (lambda (x1 x2)
+ (string< (downcase (car x1)) (downcase (car x2))))))
+ (setq reftex-type-query-prompt
+ (concat "Label type: ["
+ (mapconcat (lambda(x) (format "%s" (car x)))
+ qh-list "")
+ "]"))
+ ;; In the help string, we need to wrap lines...
+ (setq reftex-type-query-help
+ (concat
+ "SELECT A LABEL TYPE:\n--------------------\n"
+ (mapconcat
+ (lambda(x)
+ (setq sum 0)
+ (format " [%s] %s"
+ (car x)
+ (mapconcat (lambda(env)
+ (setq sum (+ sum (length env)))
+ (if (< sum 60)
+ env
+ (setq sum 0)
+ (concat "\n " env)))
+ (cdr x) " ")))
+ qh-list "\n")))
+
+ ;; Convert magic words to regular expressions. We make regular expressions
+ ;; which allow for some chars from the ref format to be in the buffer.
+ ;; These characters will be seen and removed.
+ (setq reftex-words-to-typekey-alist
+ (mapcar
+ (lambda (x)
+ (setq word (car x)
+ typekey (cdr x)
+ fmt (cdr (assoc typekey reftex-typekey-to-format-alist)))
+ (setq word (concat "\\W\\(" word "[ \t\n\r]*\\)\\("))
+ (setq i 0)
+ (while (and (< i 10) ; maximum number of format chars allowed
+ (< i (length fmt))
+ (not (member (aref fmt i) '(?%))))
+ (setq word (concat word "\\|" (regexp-quote
+ (substring fmt 0 (1+ i)))))
+ (incf i))
+ (cons (concat word "\\)\\=") typekey))
+ (nreverse reftex-words-to-typekey-alist)))
+
+ ;; Parse the index macros
+ (setq reftex-index-macro-alist nil
+ reftex-key-to-index-macro-alist nil
+ reftex-macros-with-index nil)
+ (while all-index
+ (setq entry (car all-index)
+ macro (car entry)
+ tag (nth 1 entry)
+ key (nth 2 entry)
+ prefix (or (nth 3 entry) "")
+ verify (nth 4 entry)
+ ;; For repeat, we need to be compatible with older code
+ ;; This information used to be given only for the default macro,
+ ;; but later we required to have it for *every* index macro
+ repeat (cond ((> (length entry) 5) (nth 5 entry))
+ ((and (eq key (car reftex-index-default-macro))
+ (> (length reftex-index-default-macro) 2))
+ ;; User has old setting - respect it
+ (nth 2 reftex-index-default-macro))
+ (t t))
+ all-index (cdr all-index))
+ (let ((result (reftex-parse-args macro)))
+ (setq macro (or (first result) macro)
+ nargs (second result)
+ nindex (third result)
+ opt-args (fourth result))
+ (unless (member macro reftex-macros-with-index)
+ ;; 0 1 2 3 4 5 6 7
+ (push (list macro tag prefix verify nargs nindex opt-args repeat)
+ reftex-index-macro-alist)
+ (or (assoc key reftex-key-to-index-macro-alist)
+ (push (list key macro) reftex-key-to-index-macro-alist))
+ (push macro reftex-macros-with-index))))
+ ;; Make the prompt and help string for index macros query
+ (setq reftex-key-to-index-macro-alist
+ (sort reftex-key-to-index-macro-alist
+ (lambda (a b) (< (downcase (car a)) (downcase (car b))))))
+ (setq reftex-query-index-macro-prompt
+ (concat "Index macro: ["
+ (mapconcat (lambda (x) (char-to-string (car x)))
+ reftex-key-to-index-macro-alist "")
+ "]"))
+ (setq i 0
+ reftex-query-index-macro-help
+ (concat
+ "SELECT A MACRO:\n---------------\n"
+ (mapconcat
+ (lambda(x)
+ (format "[%c] %-20.20s%s" (car x) (nth 1 x)
+ (if (= 0 (mod (incf i) 3)) "\n" "")))
+ reftex-key-to-index-macro-alist "")))
+
+ ;; Make the full list of section levels
+ (setq reftex-section-levels-all
+ (append toc-levels
+ (get reftex-docstruct-symbol 'reftex-section-levels)
+ reftex-section-levels))
+
+ ;; Calculate the regular expressions
+ (let* ((wbol "\\(\\`\\|[\n\r]\\)[ \t]*")
+ (label-re "\\\\label{\\([^}]*\\)}")
+ (include-re (concat wbol "\\\\\\(include\\|input\\)[{ \t]+\\([^} \t\n\r]+\\)"))
+ (section-re
+ (concat wbol "\\\\\\("
+ (mapconcat (lambda (x) (regexp-quote (car x)))
+ reftex-section-levels-all "\\|")
+ "\\)\\*?\\(\\[[^]]*\\]\\)?[[{ \t\r\n]"))
+ (appendix-re (concat wbol "\\(\\\\appendix\\)"))
+ (macro-re
+ (if macros-with-labels
+ (concat "\\("
+ (mapconcat 'regexp-quote macros-with-labels "\\|")
+ "\\)[[{]")
+ ""))
+ (index-re
+ (concat "\\("
+ (mapconcat 'regexp-quote reftex-macros-with-index "\\|")
+ "\\)[[{]"))
+ (find-index-re-format
+ (concat "\\("
+ (mapconcat 'regexp-quote reftex-macros-with-index "\\|")
+ "\\)\\([[{][^]}]*[]}]\\)*[[{]\\(%s\\)[]}]"))
+ (find-label-re-format
+ (concat "\\("
+ (mapconcat 'regexp-quote (append '("\\label")
+ macros-with-labels) "\\|")
+ "\\)\\([[{][^]}]*[]}]\\)*[[{]\\(%s\\)[]}]"))
+ (index-level-re
+ (regexp-quote (nth 0 reftex-index-special-chars)))
+ (index-key-end-re ;; ^]- not allowed
+ (concat "[^" (nth 3 reftex-index-special-chars) "]"
+ "[" (nth 1 reftex-index-special-chars)
+ (nth 2 reftex-index-special-chars) "]"))
+ )
+ (setq reftex-section-regexp section-re
+ reftex-section-or-include-regexp
+ (concat section-re "\\|" include-re)
+ reftex-everything-regexp
+ (concat label-re "\\|" section-re "\\|" include-re
+ "\\|" appendix-re
+ "\\|" index-re
+ (if macros-with-labels "\\|" "") macro-re)
+ reftex-everything-regexp-no-index
+ (concat label-re "\\|" section-re "\\|" include-re
+ "\\|" appendix-re
+ "\\|" "\\(\\\\6\\\\3\\\\1\\)" ; This is unlikely to match
+ (if macros-with-labels "\\|" "") macro-re)
+ reftex-index-re index-re
+ reftex-index-level-re index-level-re
+ reftex-index-key-end-re index-key-end-re
+ reftex-macros-with-labels macros-with-labels
+ reftex-find-index-entry-regexp-format find-index-re-format
+ reftex-find-label-regexp-format find-label-re-format
+ reftex-find-label-regexp-format2
+ "\\([]} \t\n\r]\\)\\([[{]\\)\\(%s\\)[]}]")
+ (message "Compiling label environment definitions...done")))
+ (put reftex-docstruct-symbol 'reftex-cache
+ (mapcar 'symbol-value reftex-cache-variables)))
+
+(defun reftex-parse-args (macro)
+ ;; Return a list of macro name, nargs, arg-nr which is label and a list of
+ ;; optional argument indices.
+ (if (string-match "[[{]\\*?[]}]" macro)
+ (progn
+ (let ((must-match (substring macro 0 (match-beginning 0)))
+ (args (substring macro (match-beginning 0)))
+ opt-list nlabel (cnt 0))
+ (while (string-match "\\`[[{]\\(\\*\\)?[]}]" args)
+ (incf cnt)
+ (when (eq ?\[ (string-to-char args))
+ (push cnt opt-list))
+ (when (and (match-end 1)
+ (not nlabel))
+ (setq nlabel cnt))
+ (setq args (substring args (match-end 0))))
+ (list must-match cnt nlabel opt-list)))
+ nil))
+
+;;; =========================================================================
+;;;
+;;; Accessing the parse information
- ;; Abbreviate words if enforced by user settings or string length
- (if (or (eq t (nth 3 reftex-derive-label-parameters))
- (and (nth 3 reftex-derive-label-parameters)
- (> (length string) (nth 1 reftex-derive-label-parameters))))
- (setq words
- (mapcar
- '(lambda (w) (if (string-match reftex-abbrev-regexp w)
- (match-string 1 w)
- w))
- words)
- string (mapconcat '(lambda(w) w) words
- (nth 4 reftex-derive-label-parameters))))
+(defun reftex-access-scan-info (&optional rescan file)
+ "Ensure access to the scanning info for the current file."
+ ;; When the multifile symbols are not yet tied,
+ ;; tie them. When they are empty or RESCAN is non-nil, scan the document.
+ ;; But, when RESCAN is -1, don't rescan even if docstruct is empty.
+ ;; When FILE is non-nil, parse only from that file.
- ;; Shorten if still to long
- (setq string
- (if (> (length string) (nth 1 reftex-derive-label-parameters))
- (substring string 0 (nth 1 reftex-derive-label-parameters))
- string))
+ ;; Make sure we have the symbols tied
+ (if (eq reftex-docstruct-symbol nil)
+ ;; Symbols are not yet tied: Tie them.
+ (reftex-tie-multifile-symbols))
- ;; Delete the final punctuation, if any
- (if (string-match "[^a-zA-Z0-9]+$" string)
- (setq string (replace-match "" nil nil string)))
- string))
+ (reftex-ensure-compiled-variables)
-(defun reftex-label-location (&optional bound)
- ;; Return the environment or macro which determines the label type at point.
- ;; If optional BOUND is an integer, limit backward searches to that point.
-
- (let* ((loc1 (reftex-what-macro reftex-label-mac-list bound))
- (loc2 (reftex-what-environment reftex-label-env-list bound))
- (p1 (or (cdr loc1) 0))
- (p2 (or (cdr loc2) 0)))
-
- (setq reftex-location-start (max p1 p2))
- (if (> p1 p2)
- (progn
- (setq reftex-default-context-position p1)
- (car loc1))
- (setq reftex-default-context-position
- (+ p2 8 (length (car loc2))))
- (or (car loc2) "section"))))
-
-
-(defun reftex-next-label-number (type)
- ;; Increment value of automatic labels in current buffer. Return new value.
-
- ;; Ensure access to scanning info
- (reftex-access-scan-info)
-
- (let ((n (cdr (assoc type (symbol-value reftex-label-numbers-symbol)))))
- (if (not (integerp n))
- ;; oops - type not known - make one here
- (progn
- (set reftex-label-numbers-symbol
- (cons (cons type 0)
- (symbol-value reftex-label-numbers-symbol)))
- (setq n 0)))
- (setq n (1+ n))
- (setcdr (assoc type (symbol-value reftex-label-numbers-symbol)) n)
- n))
-
-;; Help string for the reference label menu
-(defconst reftex-reference-label-help
- " AVAILABLE KEYS IN REFERENCE LABEL MENU
- ======================================
- n / p Go to next/previous label (Cursor motion works as well)
- r / s Rescan document for labels / Switch label type
- t / # Toggle table of contents / Toggle counter mode
- c Toggle display of short context
- SPACE Show full context for current label in other window
- f Toggle follow mode: other window will follow context
- a / q Use last referenced label / Quit without accepting label
- ? / C-r Display this help message / Recursive Edit into other window
- RETURN Accept current label")
-
-(defun reftex-reference (&optional type no-insert)
- "Make a LaTeX reference. Look only for labels of a certain TYPE.
-With prefix arg, force to rescan buffer for labels. This should only be
-necessary if you have recently entered labels yourself without using
-reftex-label. Rescanning of the buffer can also be requested from the
-label selection menu.
-The function returns the selected label or nil.
-If NO-INSERT is non-nil, do not insert \\ref{} command, just return label.
-When called with 2 C-u prefix args, disable magic word recognition."
+ (when (or (null (symbol-value reftex-docstruct-symbol))
+ (member rescan '(t 1 (4) (16))))
+ ;; The docstruct will change: Remove selection buffers.
+ (save-excursion
+ (reftex-erase-buffer "*toc*")
+ (reftex-erase-all-selection-and-index-buffers)))
- (interactive)
+ (if (and (null (symbol-value reftex-docstruct-symbol))
+ (not (member rescan '(t 1 (4) (16))))
+ reftex-save-parse-info)
+ ;; Try to read the stuff from a file
+ (reftex-access-parse-file 'read))
- ;; check for active recursive edits
- (reftex-check-recursive-edit)
-
- ;; Ensure access to scanning info and rescan buffer if prefix are is '(4)
- (reftex-access-scan-info current-prefix-arg)
-
- (if (not type)
- ;; guess type from context
- (if (and reftex-guess-label-type
- (not (= 16 (prefix-numeric-value current-prefix-arg)))
- (setq type (assoc (downcase (reftex-word-before-point))
- reftex-words-to-typekey-alist)))
- (setq type (cdr type))
- (setq type (reftex-query-label-type))))
-
- (let (label pair
- (form (or (cdr (assoc type reftex-typekey-to-format-alist))
- "\\ref{%s}")))
-
- ;; Have the user select a label
- (setq pair (reftex-offer-label-menu type))
- (setq label (car pair))
-
- (if (and label
- (not no-insert))
- (progn
- ;; do we need to remove spaces?
- (if (string= "~" (substring form 0 1))
- (while (or (= (preceding-char) ?\ )
- (= (preceding-char) ?\C-i))
- (backward-delete-char 1)))
- ;; ok, insert the reference
- (insert (format form label label))
- (message ""))
- (message "Quit"))
- ;; return the label
- label))
-
-(defun reftex-goto-label (&optional arg)
- "Go to a LaTeX label. With prefix ARG: go to label in another window."
- (interactive "P")
- (let (type label file pair)
- (if (not type)
- (setq type (reftex-query-label-type)))
-
- (setq pair (reftex-offer-label-menu type)
- label (car pair)
- file (cdr pair))
- (if (and label file (file-exists-p file))
- (progn
- (if arg
- (find-file-other-window file)
- (find-file file))
- (goto-char (point-min))
- (if (not (search-forward (concat "\\label{" label "}") nil t))
- (error "No such label found: %s" label)
- (reftex-highlight 0 (match-beginning 0) (match-end 0))
- (add-hook 'pre-command-hook 'reftex-highlight-shall-die)))
- (message "Quit")
+ (cond
+ ((equal rescan -1)) ;; We are not allowed to scan.
+ ((not (symbol-value reftex-docstruct-symbol))
+ ;; Scan the whole document
+ (reftex-do-parse 1 file))
+ ((member rescan '(t 1 (4) (16)))
+ ;; Scan whatever was required by the caller.
+ (reftex-do-parse rescan file))))
+
+(defun reftex-scanning-info-available-p ()
+ "Is the scanning info about the current document available?"
+ (unless reftex-docstruct-symbol
+ (reftex-tie-multifile-symbols))
+ (and (symbolp reftex-docstruct-symbol)
+ (symbol-value reftex-docstruct-symbol)
+ t))
+
+(defun reftex-silence-toc-markers (list n)
+ ;; Set all toc markers in the first N entries in list to nil
+ (while (and list (> (decf n) -1))
+ (and (eq (car (car list)) 'toc)
+ (markerp (nth 4 (car list)))
+ (set-marker (nth 4 (car list)) nil))
+ (pop list)))
+
+(defun reftex-access-parse-file (action)
+ "Perform ACTION on the parse file (the .rel file).
+Valid actions are: readable, restore, read, kill, write."
+ (let* ((list (symbol-value reftex-docstruct-symbol))
+ (docstruct-symbol reftex-docstruct-symbol)
+ (master (reftex-TeX-master-file))
+ (enable-local-variables nil)
+ (file (if (string-match "\\.[a-zA-Z]+\\'" master)
+ (concat (substring master 0 (match-beginning 0))
+ reftex-parse-file-extension)
+ (concat master reftex-parse-file-extension))))
+ (cond
+ ((eq action 'readable)
+ (file-readable-p file))
+ ((eq action 'restore)
+ (put reftex-docstruct-symbol 'modified nil)
+ (if (eq reftex-docstruct-symbol nil)
+ ;; Symbols are not yet tied: Tie them.
+ (reftex-tie-multifile-symbols))
+ (if (file-exists-p file)
+ ;; load the file and return t for success
+ (condition-case nil
+ (progn (load-file file) t)
+ (error (set reftex-docstruct-symbol nil)
+ (error "Error while loading file %s" file)))
+ ;; Throw an exception if the file does not exist
+ (error "No restore file %s" file)))
+ ((eq action 'read)
+ (put reftex-docstruct-symbol 'modified nil)
+ (if (file-exists-p file)
+ ;; load the file and return t for success
+ (condition-case nil
+ (progn
+ (load-file file)
+ (reftex-check-parse-consistency)
+ t)
+ (error (message "Error while restoring file %s" file)
+ (set reftex-docstruct-symbol nil)
+ nil))
+ ;; return nil for failure, but no exception
+ nil))
+ ((eq action 'kill)
+ ;; Remove the file
+ (when (and (file-exists-p file) (file-writable-p file))
+ (message "Unlinking file %s" file)
+ (delete-file file)))
+ (t
+ (put docstruct-symbol 'modified nil)
+ (save-excursion
+ (if (file-writable-p file)
+ (progn
+ (message "Writing parse file %s" (abbreviate-file-name file))
+ (find-file file)
+ (erase-buffer)
+ (insert (format ";; RefTeX parse info file\n"))
+ (insert (format ";; File: %s\n" master))
+ (insert (format ";; User: %s (%s)\n\n"
+ (user-login-name) (user-full-name)))
+ (insert "(set reftex-docstruct-symbol '(\n\n")
+ (let ((standard-output (current-buffer)))
+ (mapcar
+ (lambda (x)
+ (cond ((eq (car x) 'toc)
+ ;; A toc entry. Do not save the marker.
+ ;; Save the markers position at position 8
+ (print (list 'toc "toc" (nth 2 x) (nth 3 x)
+ nil (nth 5 x) (nth 6 x) (nth 7 x)
+ (or (and (markerp (nth 4 x))
+ (marker-position (nth 4 x)))
+ (nth 8 x)))))
+ ((and (not (eq t reftex-support-index))
+ (eq (car x) 'index))
+ ;; Don't save index entries
+ )
+ (t (print x))))
+ list))
+ (insert "))\n\n")
+ (save-buffer 0)
+ (kill-buffer (current-buffer)))
+ (error "Cannot write to file %s" file)))
+ t))))
+
+(defun reftex-check-parse-consistency ()
+ ;; Check if parse file is consistent, throw an error if not.
+
+ ;; Check if the master is the same: when moving a document, this will see it.
+ (let* ((real-master (reftex-TeX-master-file))
+ (parsed-master
+ (nth 1 (assq 'bof (symbol-value reftex-docstruct-symbol)))))
+ (unless (string= (file-truename real-master) (file-truename parsed-master))
+ (message "Master file name in load file is different: %s versus %s"
+ parsed-master real-master)
+ (error "Master file name error")))
+
+ ;; Check for the existence of all document files
+;;; (let* ((all (symbol-value reftex-docstruct-symbol)))
+;;; (while all
+;;; (when (and (eq (car (car all)) 'bof)
+;;; (not (file-regular-p (nth 1 (car all)))))
+;;; (message "File %s in saved parse info not avalable" (cdr (car all)))
+;;; (error "File not found"))
+;;; (setq all (cdr all))))
+ )
+
+(defun reftex-select-external-document (xr-alist xr-index)
+ ;; Return index of an external document.
+ (let* ((len (length xr-alist)) (highest (1- (+ ?0 len)))
+ (prompt (format "[%c-%c] Select TAB: Read prefix with completion"
+ ?0 highest))
+ key prefix)
+ (cond
+ ((= len 1)
+ (message "No external documents available")
+ (ding) (sit-for 1) 0)
+ ((= len 2)
+ (- 1 xr-index))
+ (t
+ (save-excursion
+ (let* ((length (apply 'max (mapcar
+ (lambda(x) (length (car x))) xr-alist)))
+ (fmt (format " [%%c] %%-%ds %%s\n" length))
+ (n (1- ?0)))
+ (setq key
+ (reftex-select-with-char
+ prompt
+ (concat
+ "SELECT EXTERNAL DOCUMENT\n------------------------\n"
+ (mapconcat
+ (lambda (x)
+ (format fmt (incf n) (or (car x) "")
+ (abbreviate-file-name (cdr x))))
+ xr-alist ""))
+ nil t))
+ (cond
+ ((and (>= key ?0) (<= key highest)) (- key ?0))
+ ((= key ?\C-i)
+ (setq prefix (completing-read "Prefix: " xr-alist nil t))
+ (- len (length (memq (assoc prefix xr-alist) xr-alist))))
+ (t (error "Illegal document selection [%c]" key)))))))))
+
+;;; =========================================================================
+;;;
+;;; Finding files
+
+(defun reftex-locate-file (file type master-dir &optional die)
+ "Find FILE of type TYPE in MASTER-DIR or on the path associcted with TYPE.
+If the file does not have any of the legal extensions for TYPE,
+try first the default extension and only then the naked file name.
+When DIE is non-nil, throw an error if file not found."
+ (let* ((rec-values (if reftex-search-unrecursed-path-first '(nil t) '(t)))
+ (extensions (cdr (assoc type reftex-file-extensions)))
+ (def-ext (car extensions))
+ (ext-re (concat "\\("
+ (mapconcat 'regexp-quote extensions "\\|")
+ "\\)\\'"))
+ (files (if (string-match ext-re file)
+ (cons file nil)
+ (cons (concat file def-ext) file)))
+ path old-path file1)
+ (cond
+ ((file-name-absolute-p file)
+ (setq file1
+ (or
+ (and (car files) (file-regular-p (car files)) (car files))
+ (and (cdr files) (file-regular-p (cdr files)) (cdr files)))))
+ ((and reftex-use-external-file-finders
+ (assoc type reftex-external-file-finders))
+ (setq file1 (reftex-find-file-externally file type master-dir)))
+ (t
+ (while (and (null file1) rec-values)
+ (setq path (reftex-access-search-path
+ type (pop rec-values) master-dir file))
+ (if (or (null old-path)
+ (not (eq old-path path)))
+ (setq old-path path
+ path (cons master-dir path)
+ file1 (or (and (car files)
+ (reftex-find-file-on-path
+ (car files) path master-dir))
+ (and (cdr files)
+ (reftex-find-file-on-path
+ (cdr files) path master-dir))))))))
+ (cond (file1 file1)
+ (die (error "No such file: %s" file) nil)
+ (t (message "No such file: %s (ignored)" file) nil))))
+
+(defun reftex-find-file-externally (file type &optional master-dir)
+ ;; Use external program to find FILE.
+ ;; The program is taken from `reftex-external-file-finders'.
+ ;; Interprete relative path definitions starting from MASTER-DIR.
+ (let ((default-directory (or master-dir default-directory))
+ (prg (cdr (assoc type reftex-external-file-finders)))
+ out)
+ (if (string-match "%f" prg)
+ (setq prg (replace-match file t t prg)))
+ (setq out (apply 'reftex-process-string (split-string prg)))
+ (if (string-match "[ \t\n]+\\'" out) ; chomp
+ (setq out (replace-match "" nil nil out)))
+ (cond ((equal out "") nil)
+ ((file-regular-p out) (expand-file-name out master-dir))
+ (t nil))))
+
+(defun reftex-process-string (program &rest args)
+ "Execute PROGRAM with arguments ARGS and return its STDOUT as a string."
+ (let ((calling-dir default-directory)) ; remember default directory
+ (with-output-to-string
+ (with-current-buffer standard-output
+ (let ((default-directory calling-dir)) ; set default directory
+ (apply 'call-process program nil '(t nil) nil args))))))
+
+(defun reftex-access-search-path (type &optional recurse master-dir file)
+ ;; Access path from environment variables. TYPE is either "tex" or "bib".
+ ;; When RECURSE is t, expand path elements ending in `//' recursively.
+ ;; Relative path elements are left as they are. However, relative recursive
+ ;; elements are expanded with MASTER-DIR as default directory.
+ ;; The expanded path is cached for the next search.
+ ;; FILE is just for the progress message.
+ ;; Returns the derived path.
+ (let* ((pathvar (intern (concat "reftex-" type "-path"))))
+ (when (null (get pathvar 'status))
+ ;; Get basic path
+ (set pathvar
+ (reftex-uniq
+ (reftex-parse-colon-path
+ (mapconcat
+ (lambda(x)
+ (if (string-match "^!" x)
+ (apply 'reftex-process-string
+ (split-string (substring x 1)))
+ (or (getenv x) x)))
+ ;; For consistency, the next line should look like this:
+ ;; (cdr (assoc type reftex-path-environment))
+ ;; However, historically we have separate options for the
+ ;; environment variables, so we have to do this:
+ (symbol-value (intern (concat "reftex-" type
+ "path-environment-variables")))
+ path-separator))))
+ (put pathvar 'status 'split)
+ ;; Check if we have recursive elements
+ (let ((path (symbol-value pathvar)) dir rec)
+ (while (setq dir (pop path))
+ (when (string= (substring dir -2) "//")
+ (if (file-name-absolute-p dir)
+ (setq rec (or rec 'absolute))
+ (setq rec 'relative))))
+ (put pathvar 'rec-type rec)))
+
+ (if recurse
+ ;; Return the recursive expansion of the path
+ (cond
+ ((not (get pathvar 'rec-type))
+ ;; Path does not contain recursive elements - use simple path
+ (symbol-value pathvar))
+ ((or (not (get pathvar 'recursive-path))
+ (and (eq (get pathvar 'rec-type) 'relative)
+ (not (equal master-dir (get pathvar 'master-dir)))))
+ ;; Either: We don't have a recursive expansion yet.
+ ;; or: Relative recursive path elements need to be expanded
+ ;; relative to new default directory
+ (message "Expanding search path to find %s file: %s ..." type file)
+ (put pathvar 'recursive-path
+ (reftex-expand-path (symbol-value pathvar) master-dir))
+ (put pathvar 'master-dir master-dir)
+ (get pathvar 'recursive-path))
+ (t
+ ;; Recursive path computed earlier is still OK.
+ (get pathvar 'recursive-path)))
+ ;; The simple path was requested
+ (symbol-value pathvar))))
+
+(defun reftex-find-file-on-path (file path &optional def-dir)
+ ;; Find FILE along the directory list PATH.
+ ;; DEF-DIR is the default directory for expanding relative path elements.
+ (catch 'exit
+ (when (file-name-absolute-p file)
+ (if (file-regular-p file)
+ (throw 'exit file)
+ (throw 'exit nil)))
+ (let* ((thepath path) file1 dir)
+ (while (setq dir (pop thepath))
+ (when (string= (substring dir -2) "//")
+ (setq dir (substring dir 0 -1)))
+ (setq file1 (expand-file-name file (expand-file-name dir def-dir)))
+ (if (file-regular-p file1)
+ (throw 'exit file1)))
+ ;; No such file
nil)))
-;; Internal list with index numbers of labels in the selection menu
-(defvar reftex-label-index-list nil)
-
-(defun reftex-offer-label-menu (typekey)
- ;; Offer a menu with the appropriate labels. Return (label . file).
- (let* ((buf (current-buffer))
- (near-label (reftex-find-nearby-label))
- (toc (reftex-typekey-check typekey reftex-label-menu-flags 0))
- (context (not (reftex-typekey-check
- typekey reftex-label-menu-flags 3)))
- (counter (reftex-typekey-check
- typekey reftex-label-menu-flags 2))
- (follow (reftex-typekey-check
- typekey reftex-label-menu-flags 4))
- offset rtn key cnt entry)
-
- (setq reftex-call-back-to-this-buffer buf)
- (setq entry (cons nil nil))
+(defun reftex-parse-colon-path (path)
+ ;; Like parse-colon-parse, but // or /~ are left alone.
+ ;; Trailing ! or !! will be converted into `//' (emTeX convention)
+ (mapcar
+ (lambda (dir)
+ (if (string-match "\\(//+\\|/*!+\\)\\'" dir)
+ (setq dir (replace-match "//" t t dir)))
+ (file-name-as-directory dir))
+ (delete "" (split-string path (concat path-separator "+")))))
+
+(defun reftex-expand-path (path &optional default-dir)
+ ;; Expand parts of path ending in `//' recursively into directory list.
+ ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
+ (let (path1 dir recursive)
+ (while (setq dir (pop path))
+ (if (setq recursive (string= (substring dir -2) "//"))
+ (setq dir (substring dir 0 -1)))
+ (if (and recursive
+ (not (file-name-absolute-p dir)))
+ (setq dir (expand-file-name dir default-dir)))
+ (if recursive
+ ;; Expand recursively
+ (setq path1 (append (reftex-recursive-directory-list dir) path1))
+ ;; Keep unchanged
+ (push dir path1)))
+ (nreverse path1)))
+
+(defun reftex-recursive-directory-list (dir)
+ ;; Return a list of all directories below DIR, including DIR itself
+ (let ((path (list dir)) path1 file files)
+ (while (setq dir (pop path))
+ (when (file-directory-p dir)
+ (setq files (nreverse (directory-files dir t "[^.]")))
+ (while (setq file (pop files))
+ (if (file-directory-p file)
+ (push (file-name-as-directory file) path)))
+ (push dir path1)))
+ path1))
+
+(defun reftex-uniq (list)
+ (let (new)
+ (while list
+ (or (member (car list) new)
+ (push (car list) new))
+ (pop list))
+ (nreverse new)))
- (unwind-protect
- (catch 'exit
- (while t
- (save-window-excursion
- (switch-to-buffer-other-window "*RefTeX Select*")
- (erase-buffer)
- (setq truncate-lines t)
- (setq reftex-label-index-list (reftex-make-and-insert-label-list
- typekey buf toc context counter
- near-label))
- (setq near-label "_ ") ; turn off search for near label
- (setq offset (or (car reftex-label-index-list) offset))
- ;; use only when searched
- (setq reftex-label-index-list (cdr reftex-label-index-list))
- ;; only this is the true list
- (if (not reftex-label-index-list)
- (error "No labels of type \"%s\"" typekey))
- (setq rtn
- (reftex-select-item
- nil
- "Label: [n]ext [p]rev [r]escan [t]oc [ ]context [q]uit RETURN [?]HELP+more"
- "^>"
- "\n[^.]"
- 2
- reftex-reference-label-help
- '(?r ?c ?t ?s ?# ?a)
- offset
- 'reftex-select-label-callback follow))
- (setq key (car rtn)
- cnt (cdr rtn)
- offset (1+ cnt))
- (if (not key) (throw 'exit nil))
- (cond
- ((equal key ?r)
- ;; rescan buffer
- (reftex-parse-document buf))
- ((equal key ?c)
- ;; toggle context mode
- (setq context (not context)))
- ((equal key ?s)
- ;; switch type
- (setq typekey (reftex-query-label-type)))
- ((equal key ?t)
- ;; toggle tabel of contents display
- (setq toc (not toc)))
- ((equal key ?#)
- ;; toggle counter display
- (setq counter (not counter)))
- ((equal key ?a)
- ;; reuse the last referenced label again
- (setq entry reftex-last-used-reference)
- (throw 'exit t))
- (t
- (set-buffer buf)
- (setq entry (nth (nth cnt reftex-label-index-list)
- (symbol-value reftex-list-of-labels-symbol)))
- (setq reftex-last-used-reference entry)
- (throw 'exit t))))))
- (kill-buffer "*RefTeX Select*")
- (reftex-kill-temporary-buffers))
- (cons (reftex-no-props (nth 0 entry)) (nth 3 entry))))
-
-;; Indentation for table of context lines in the menu
-(defconst reftex-toc-indent " ")
-;; Indentation for the lines containing the label
-(defconst reftex-label-indent "> ")
-;; Indentation for context lines
-(defconst reftex-context-indent ". ")
-;; Indentation per section level
-(defvar reftex-level-indent 2
- "*Number of spaces to be used for indentation per section level.
-With more indentation, the label menu looks nicer, but shows less context.
-Changing this is only fully operational after the next buffer scan.")
-
-(defun reftex-make-and-insert-label-list (typekey0 buf toc context
- counter near-label)
- ;; Insert a menu of all labels in buffer BUF into current buffer.
- ;; Return the list of labels, with the index of NEAR-LABEL as extra car.
- (let (ins-list index-list offset)
- (save-excursion
- (set-buffer buf)
- (let* ((all nil)
- (font (reftex-use-fonts))
- (cnt 0)
- (file nil)
- (index -1)
- (toc-indent reftex-toc-indent)
- (label-indent
- (concat reftex-label-indent
- (if toc (make-string (* 7 reftex-level-indent) ?\ ) "")))
- (context-indent
- (concat reftex-context-indent
- (if toc (make-string (* 7 reftex-level-indent) ?\ ) "")))
- cell text label typekey note comment)
-
- ; Ensure access to scanning info
- (reftex-access-scan-info)
-
- (setq all (symbol-value reftex-list-of-labels-symbol))
-
- (while all
-
- (setq index (1+ index)
- cell (car all)
- all (cdr all))
-
- (if (null (nth 2 cell))
- ;; No context yet. Quick update
- (progn
- (setq cell (reftex-label-info-update cell))
- (setcar (nthcdr index
- (symbol-value reftex-list-of-labels-symbol))
- cell)))
-
- ;; in the following setq we *copy* the label, since we will change
- ;; its properties, and we cannot have any properties in the list
- ;; (because of assoc searches)
- (setq label (copy-sequence (nth 0 cell))
- typekey (nth 1 cell)
- text (nth 2 cell)
- file (nth 3 cell)
- note (nth 4 cell)
- comment (get-text-property 0 'in-comment text))
-
- (if (string= label near-label)
- (setq offset (1+ cnt)))
- (cond
- ((and toc (string= typekey "toc"))
- (setq ins-list
- (cons (concat toc-indent text "\n")
- ins-list)))
- ((string= typekey "toc"))
- ((and (or (string= typekey typekey0) (string= typekey0 " "))
- (or (nth 5 reftex-label-menu-flags) ; show-commented?
- (null comment)))
- (setq cnt (1+ cnt))
- (if comment (setq label (concat "% " label)))
- (if font
- (put-text-property
- 0 (length label)
- 'face
- (if comment
- 'font-lock-comment-face
- 'font-lock-reference-face)
- label))
- (setq index-list (cons index index-list))
- (setq ins-list
- (cons (concat
- label-indent
- label
- (if counter (format " (%d) " cnt))
- (if comment " LABEL IS COMMENTED OUT ")
- (if note (concat " " note) "")
- "\n"
- (if context (concat context-indent text "\n")))
- ins-list))))
- )))
-
- (apply 'insert (nreverse ins-list))
- (cons offset (nreverse index-list))))
-
-(defun reftex-query-label-type ()
- ;; Ask for label type
- (message reftex-type-query-prompt)
- (let ((key (read-char)))
- (if (equal key ?\?)
- (progn
- (save-window-excursion
- (with-output-to-temp-buffer "*RefTeX Help*"
- (princ reftex-type-query-help))
- (setq key (read-char))
- (kill-buffer "*RefTeX Help*"))))
- (if (not (member (char-to-string key) reftex-typekey-list))
- (error "No such label type: %s" (char-to-string key)))
- (char-to-string key)))
-
-(defun reftex-find-nearby-label ()
- ;; Find a nearby label.
- (save-excursion
- (if (or (re-search-backward "\\\\label{\\([^}]+\\)}" nil t)
- (re-search-forward "\\\\label{\\([^}]+\\)}" nil t))
- (reftex-no-props (match-string 1))
- nil)))
+;;; =========================================================================
+;;;
+;;; Parser functions
+
+(autoload 'reftex-parse-one "reftex-parse"
+ "Re-parse this file." t)
+(autoload 'reftex-parse-all "reftex-parse"
+ "Re-parse entire document." t)
+(autoload 'reftex-do-parse "reftex-parse")
+(autoload 'reftex-where-am-I "reftex-parse")
+(autoload 'reftex-init-section-numbers "reftex-parse")
+(autoload 'reftex-section-info "reftex-parse")
+(autoload 'reftex-section-number "reftex-parse")
+(autoload 'reftex-what-macro "reftex-parse")
+(autoload 'reftex-what-macro-safe "reftex-parse")
+(autoload 'reftex-index-info "reftex-parse")
+(autoload 'reftex-index-info-safe "reftex-parse")
+(autoload 'reftex-short-context "reftex-parse")
+(autoload 'reftex-what-environment "reftex-parse")
+(autoload 'reftex-what-special-env "reftex-parse")
+(autoload 'reftex-move-over-touching-args "reftex-parse")
+(autoload 'reftex-notice-new "reftex-parse")
+(autoload 'reftex-nth-arg "reftex-parse")
+(autoload 'reftex-locate-bibliography-files "reftex-parse")
+(autoload 'reftex-all-document-files "reftex-parse")
+(autoload 'reftex-ensure-index-support "reftex-parse")
+(autoload 'reftex-everything-regexp "reftex-parse")
+
+
+;;; =========================================================================
+;;;
+;;; Labels and References
+
+(autoload 'reftex-label-location "reftex-ref")
+(autoload 'reftex-label-info-update "reftex-ref")
+(autoload 'reftex-label-info "reftex-ref")
+(autoload 'reftex-label "reftex-ref"
+ "Insert a unique label." t)
+(autoload 'reftex-reference "reftex-ref"
+ "Make a LaTeX reference." t)
+(autoload 'reftex-varioref-vref "reftex-ref"
+ "Make a varioref reference." t)
+(autoload 'reftex-fancyref-fref "reftex-ref"
+ "Make a fancyref \\fref reference." t)
+(autoload 'reftex-fancyref-Fref "reftex-ref"
+ "Make a fancyref \\Fref reference." t)
+(autoload 'reftex-show-label-location "reftex-ref")
+(autoload 'reftex-query-label-type "reftex-ref")
+
+
+;;; =========================================================================
+;;;
+;;; Table of contents
-;; Variable holding the vector with section numbers
-(defvar reftex-section-numbers [0 0 0 0 0 0 0 0])
+(autoload 'reftex-toc "reftex-toc"
+ "Show the table of contents for the current document." t)
-(defun reftex-scan-buffer-for-labels (label-numbers-symbol label-list-symbol)
- ;; Scan the buffer for labels and save them in a list.
- (save-excursion
- (let ((regexp (concat "\\\\label{\\([^}]*\\)}" "\\|"
- reftex-section-regexp))
- (font (reftex-use-fonts))
- (bound 0)
- (highest-level 100)
- file (level 1) start star text text1 label section-number macro find)
- (set label-list-symbol nil)
- (goto-char 0)
-
- ;; reset label numbers
- (set label-numbers-symbol
- (mapcar '(lambda(x) (cons x 0)) reftex-typekey-list))
-
- ;; reset section numbers
- (reftex-section-number reftex-section-numbers -1)
-
- (while (re-search-forward regexp nil t)
- (setq file (get-text-property (match-beginning 0) 'file))
- (if (string= (buffer-substring (match-beginning 0)
- (+ 7 (match-beginning 0))) "\\label{")
- ;; It is a label
- (progn
- (setq label (reftex-no-props (match-string 1)))
- (set label-list-symbol
- (cons (reftex-label-info label file bound)
- (symbol-value label-list-symbol))))
-
- ;; It is a section
- (setq bound (point))
- (setq star (= ?* (char-after (match-end 2))))
- (setq find (buffer-substring-no-properties
- (1- (match-beginning 2)) (match-end 0)))
- (setq macro (reftex-no-props (match-string 2)))
- (setq level (cdr (assoc macro reftex-section-levels)))
-
- (setq section-number (reftex-section-number
- reftex-section-numbers level star))
- (setq highest-level (min highest-level level))
- (if (= level highest-level)
- (message
- "Scanning %s %s ..."
- (car (nth level reftex-section-levels))
- section-number))
-
- ;; get the title
- (save-match-data
- (setq text1 (reftex-context-substring))
- (setq text (reftex-nicify-text text1)))
-
- (setq find (reftex-allow-for-ctrl-m (concat find text1)))
-
- ;; add section number and indentation
- (setq text
- (concat
- (make-string (* reftex-level-indent level) ?\ )
- (if (nth 1 reftex-label-menu-flags) ; section number flag
- (concat section-number " "))
- text))
- ;; fontify
- (if font (put-text-property 0 (length text)
- 'face 'font-lock-comment-face text))
-
- ;; insert in list
- (set label-list-symbol
- (cons (list nil "toc" text file find)
- (symbol-value label-list-symbol)))))
- (set label-list-symbol
- (nreverse (symbol-value label-list-symbol))))))
-
-
-(defun reftex-label-info-update (cell)
- ;; Update information about just one label in a different file.
- ;; CELL contains the old info list
- (let* ((label (nth 0 cell))
- (typekey (nth 1 cell))
- (text (nth 2 cell))
- (file (nth 3 cell))
- (note (nth 4 cell))
- (buf (reftex-get-file-buffer-force
- file (not reftex-keep-temporary-buffers))))
- (if (not buf)
- (list label typekey "" file "LOST LABEL. RESCAN TO FIX.")
- (save-excursion
- (set-buffer buf)
- (save-restriction
- (widen)
- (goto-char 1)
-
- (if (re-search-forward (concat "\\\\label{" (regexp-quote label) "}")
- nil t)
- (append (reftex-label-info label file) (list note))
- (list label typekey "" file "LOST LABEL. RESCAN TO FIX.")))))))
-
-(defun reftex-label-info (label &optional file bound)
- ;; Return info list on LABEL at point.
- (let* ((env-or-mac (reftex-label-location bound))
- (typekey (nth 1 (assoc env-or-mac reftex-env-or-mac-alist)))
- (file (or file (buffer-file-name)))
- (parse (if (reftex-typekey-check
- typekey reftex-use-text-after-label-as-context)
- nil
- (nth 2 (assoc env-or-mac reftex-env-or-mac-alist))))
- (text (reftex-short-context env-or-mac parse reftex-location-start)))
- (if (reftex-in-comment)
- (put-text-property 0 1 'in-comment t text))
- (list label typekey text file)))
-(defun reftex-in-comment ()
- (save-excursion
- (skip-chars-backward "^%\n\r")
- (= (preceding-char) ?%)))
-
-(defun reftex-short-context (env parse &optional bound)
- ;; Get about one line of useful context for the label definition at point.
-
- (reftex-nicify-text
-
- (cond
-
- ((null parse)
- (save-excursion
- (reftex-context-substring)))
-
- ((eq parse t)
- (if (string= env "section")
- ;; special treatment for section labels
- (save-excursion
- (if (re-search-backward reftex-section-regexp (point-min) t)
- (progn
- (goto-char (match-end 0))
- (reftex-context-substring))
- "SECTION HEADING NOT FOUND"))
- (save-excursion
- (goto-char reftex-default-context-position)
- (reftex-context-substring))))
-
- ((stringp parse)
- (save-excursion
- (if (re-search-backward parse bound t)
- (progn
- (goto-char (match-end 0))
- (reftex-context-substring))
- "NO MATCH FOR CONTEXT REGEXP")))
- ((fboundp parse)
- ;; A hook function. Call it.
- (save-excursion
- (condition-case error-var
- (funcall parse env)
- ('error (format "HOOK ERROR: %s" (cdr error-var))))))
- (t
- "ILLEGAL VALUE OF PARSE"))))
-
-(defun reftex-context-substring ()
- ;; Return up to 100 chars from point
- ;; When point is just after a { or [, limit string to matching parenthesis
- (cond
- ((or (= (preceding-char) ?\{)
- (= (preceding-char) ?\[))
- ;; inside a list - get only the list, with modified syntax to be perfect
- (buffer-substring
- (point)
- (min (+ 100 (point))
- (point-max)
- (condition-case nil
- (progn
- (up-list 1)
- (1- (point)))
- ('error (point-max))))))
- (t
- ;; no list - just grab 100 characters
- (buffer-substring (point) (min (+ 100 (point)) (point-max))))))
-
-(defun reftex-section-number (section-numbers &optional level star)
- ;; Return a string with the current section number.
- ;; When LEVEL is non-nil, increase section numbers on that level.
- (let* ((depth 6) idx n (string ""))
- (if level
- (progn
- (if (and (> level -1) (not star))
- (aset section-numbers level (1+ (aref section-numbers level))))
- (setq idx (1+ level))
- (while (<= idx depth)
- (aset section-numbers idx 0)
- (setq idx (1+ idx)))))
- (setq idx 0)
- (while (<= idx depth)
- (setq n (aref section-numbers idx))
- (setq string (concat string (if (not (string= string "")) "." "")
- (int-to-string n)))
- (setq idx (1+ idx)))
- (save-match-data
- (if (string-match "\\`\\(0\\.\\)+" string)
- (setq string (replace-match "" nil nil string)))
- (if (string-match "\\(\\.0\\)+\\'" string)
- (setq string (replace-match "" nil nil string))))
- (if star
- (concat (make-string (1- (length string)) ?\ ) "*")
- string)))
-
-;; A variable to remember the index of the last label context shown
-(defvar reftex-last-cnt 0)
-
-(defun reftex-select-label-callback (cnt)
- ;; Callback function called from the label selection in order to
- ;; show context in another window
- (let* ((this-window (selected-window))
- index entry label file buffer)
- ;; pop to original buffer in order to get correct variables
- (catch 'exit
- (save-excursion
- (set-buffer reftex-call-back-to-this-buffer)
- (setq index (nth (or cnt 1) reftex-label-index-list)
- entry (nth index (symbol-value reftex-list-of-labels-symbol))
- label (nth 0 entry)
- file (nth 3 entry)))
-
- ;; goto the file in another window
- (setq buffer (reftex-get-file-buffer-force
- file (not reftex-keep-temporary-buffers)))
- (if buffer
- ;; good - the file is available
- (switch-to-buffer-other-window buffer)
- ;; we have got a problem here. The file does not exist.
- ;; Let' get out of here..
- (ding)
- (throw 'exit nil))
-
-
- ;; search for that label
- (if (not (and (integerp cnt)
- (integerp reftex-last-cnt)
- (if (> cnt reftex-last-cnt)
- (search-forward (concat "\\label{" label "}") nil t)
- (search-backward (concat "\\label{" label "}") nil t))))
- (progn
- (goto-char 1)
- (search-forward (concat "\\label{" label "}") nil t)))
- (reftex-highlight 0 (match-beginning 0) (match-end 0))
- (reftex-show-entry)
- (recenter (/ (window-height) 2))
- (select-window this-window))))
-
-(defun reftex-pop-to-label (label file-list &optional mark-to-kill highlight)
- ;; Find LABEL in any file in FILE-LIST in another window.
- ;; If mark-to-kill is non-nil, mark new buffer for killing.
- ;; If HIGHLIGHT is non-nil, highlight the label definition.
- (let* ((re (concat "\\\\label{" (regexp-quote label) "}"))
- file buf)
- (catch 'exit
- (while file-list
- (setq file (car file-list)
- file-list (cdr file-list))
- (if (not (setq buf (reftex-get-file-buffer-force file mark-to-kill)))
- (error "No such file %s" file))
- (set-buffer buf)
- (widen)
- (goto-char (point-min))
- (if (re-search-forward re nil t)
- (progn
- (switch-to-buffer-other-window buf)
- (goto-char (match-beginning 0))
- (recenter (/ (window-height) 2))
- (if highlight
- (reftex-highlight 0 (match-beginning 0) (match-end 0)))
- (throw 'exit (selected-window)))))
- (error "Label %s not found" label))))
+;;; =========================================================================
+;;;
+;;; BibTeX citations.
-(defun reftex-find-duplicate-labels ()
- "Produce a list of all duplicate labels in the document."
+(autoload 'reftex-citep "reftex-cite")
+(autoload 'reftex-citet "reftex-cite")
+(autoload 'reftex-make-cite-echo-string "reftex-cite")
+(autoload 'reftex-get-bibfile-list "reftex-cite")
+(autoload 'reftex-pop-to-bibtex-entry "reftex-cite")
+(autoload 'reftex-end-of-bib-entry "reftex-cite")
+(autoload 'reftex-parse-bibtex-entry "reftex-cite")
+(autoload 'reftex-citation "reftex-cite"
+ "Make a citation using BibTeX database files." t)
+(autoload 'reftex-default-bibliography "reftex-cite")
- (interactive)
- ;; Rescan the document to make sure
- (reftex-access-scan-info t)
-
- (let ((master (reftex-TeX-master-file))
- (dlist
- (mapcar
- '(lambda(x)
- (let (x1)
- (cond
- ((car x)
- (setq x1 (reftex-all-assoc-string
- (car x) (symbol-value reftex-list-of-labels-symbol)))
- (if (< 1 (length x1))
- (append (list (reftex-no-props (car x)))
- (mapcar '(lambda(x)
- (abbreviate-file-name (nth 3 x))) x1))
- (list nil)))
- (t nil))))
- (reftex-uniquify (symbol-value reftex-list-of-labels-symbol)))))
- (setq dlist (reftex-uniquify dlist))
- (if (null dlist) (error "No duplicate labels in document"))
- (switch-to-buffer-other-window "*Help*")
- (make-local-variable 'TeX-master)
- (setq TeX-master master)
- (erase-buffer)
- (insert " MULTIPLE LABELS IN CURRENT DOCUMENT:\n")
- (insert " Move point to label and type `M-x reftex-change-label'\n"
- " This will run a query-replace on the label and its references\n")
- (insert " LABEL FILE\n")
- (insert " -------------------------------------------------------------\n")
- (while dlist
- (if (and (car (car dlist))
- (cdr (car dlist)))
- (progn
- (insert (mapconcat '(lambda(x) x) (car dlist) "\n ") "\n")))
- (setq dlist (cdr dlist)))
- (goto-char (point-min))))
+;;; =========================================================================
+;;;
+;;; Selection
-(defun reftex-all-assoc-string (key list)
- ;; Return a list of all associations of KEY in LIST. Comparison with string=
- (let (rtn)
- (while list
- (if (string= (car (car list)) key)
- (setq rtn (cons (car list) rtn)))
- (setq list (cdr list)))
- (nreverse rtn)))
+(autoload 'reftex-select-label-mode "reftex-sel")
+(autoload 'reftex-select-bib-mode "reftex-sel")
+(autoload 'reftex-find-start-point "reftex-sel")
+(autoload 'reftex-insert-docstruct "reftex-sel")
+(autoload 'reftex-get-offset "reftex-sel")
+(autoload 'reftex-select-item "reftex-sel")
-(defun reftex-kill-temporary-buffers ()
- ;; Kill all buffers in the list reftex-kill-temporary-buffers.
- (while reftex-buffers-to-kill
- (if (bufferp (car reftex-buffers-to-kill))
- (progn
- (and (buffer-modified-p (car reftex-buffers-to-kill))
- (y-or-n-p (format "Save file %s? "
- (buffer-file-name
- (car reftex-buffers-to-kill))))
- (save-excursion
- (set-buffer (car reftex-buffers-to-kill))
- (save-buffer)))
- (kill-buffer (car reftex-buffers-to-kill))))
- (setq reftex-buffers-to-kill (cdr reftex-buffers-to-kill))))
-
-(defun reftex-show-entry ()
- ;; Show entry if point is hidden by outline mode
- (let ((pos (point)))
- (if (and reftex-auto-show-entry
- (boundp 'outline-minor-mode)
- outline-minor-mode
- (looking-at "[^\n\r]*\r"))
- (progn
- (outline-back-to-heading)
- (show-entry)
- (goto-char pos)))))
+;;; =========================================================================
+;;;
+;;; Index support
+
+(autoload 'reftex-index "reftex-index"
+ "Query for an index macro and insert it along with its argments." t)
+(autoload 'reftex-index-selection-or-word "reftex-index"
+ "Put selection or the word near point into the default index macro." t)
+(autoload 'reftex-index-phrase-selection-or-word "reftex-index"
+ "Put selection or the word near point into Index Phrases File." t)
+(autoload 'reftex-display-index "reftex-index"
+ "Display a buffer with an index compiled from the current document." t)
+(autoload 'reftex-index-visit-phrases-buffer "reftex-index"
+ "Visit the Index Phrases File." t)
+(autoload 'reftex-index-phrases-mode "reftex-index"
+ "Major mode for managing the Index phrases of a LaTeX document." t)
+(autoload 'reftex-index-complete-tag "reftex-index")
+(autoload 'reftex-index-complete-key "reftex-index")
+(autoload 'reftex-index-show-entry "reftex-index")
+(autoload 'reftex-index-select-tag "reftex-index")
+
+
+;;; =========================================================================
+;;;
+;;; View cross references
+
+(autoload 'reftex-view-crossref "reftex-dcr"
+ "View cross reference of \\ref or \\cite macro at point." t)
+(autoload 'reftex-mouse-view-crossref "reftex-dcr"
+ "View cross reference of \\ref or \\cite macro where you click." t)
+(autoload 'reftex-toggle-auto-view-crossref "reftex-dcr")
+(autoload 'reftex-view-crossref-from-bibtex "reftex-dcr"
+ "View location in a LaTeX document which cites the BibTeX entry at point." t)
-(defun reftex-nicify-text (text)
- ;; Make TEXT nice for inclusion into label menu
- (while (string-match "[\n\r\t]\\|[ \t][ \t]+" text) ; remove extra whitespace
- (setq text (replace-match " " nil t text)))
- (if (string-match "\\\\end{.*" text) ; nothing beyond \end{
- (setq text (replace-match "" nil t text)))
- (if (string-match "\\\\label{[^}]*}" text) ; kill the label
- (setq text (replace-match "" nil t text)))
- (if (string-match "^ +" text) ; leading whitespace
- (setq text (replace-match "" nil t text)))
- (cond
- ((> (length text) 100) ; not to long
- (setq text (substring text 0 100)))
- ((= (length text) 0) ; not empty
- (setq text " ")))
- text)
+
+;;; =========================================================================
+;;;
+;;; Operations on entire Multifile documents
+
+(autoload 'reftex-create-tags-file "reftex-global"
+ "Create TAGS file by running `etags' on the current document." t)
+(autoload 'reftex-grep-document "reftex-global"
+ "Run grep query through all files related to this document." t)
+(autoload 'reftex-search-document "reftex-global"
+ "Regexp search through all files of the current TeX document." t)
+(autoload 'reftex-query-replace-document "reftex-global"
+ "Run a query-replace-regexp of FROM with TO over the entire TeX document." t)
+(autoload 'reftex-find-duplicate-labels "reftex-global"
+ "Produce a list of all duplicate labels in the document." t)
+(autoload 'reftex-change-label "reftex-global"
+ "Query replace FROM with TO in all \\label and \\ref commands." t)
+(autoload 'reftex-renumber-simple-labels "reftex-global"
+ "Renumber all simple labels in the document to make them sequentially." t)
+(autoload 'reftex-save-all-document-buffers "reftex-global"
+ "Save all documents associated with the current document." t)
+
+
+;;; =========================================================================
+;;;
+;;; AUCTeX Interface
+
+(autoload 'reftex-arg-label "reftex-auc")
+(autoload 'reftex-arg-cite "reftex-auc")
+(autoload 'reftex-arg-index-tag "reftex-auc")
+(autoload 'reftex-arg-index "reftex-auc")
+(autoload 'reftex-plug-into-AUCTeX "reftex-auc")
+(autoload 'reftex-toggle-plug-into-AUCTeX "reftex-auc"
+ "Toggle Interface between AUCTeX and RefTeX on and off." t)
+(autoload 'reftex-add-label-environments "reftex-auc")
+(autoload 'reftex-add-to-label-alist "reftex-auc")
+(autoload 'reftex-add-section-levels "reftex-auc")
+(autoload 'reftex-notice-new-section "reftex-auc")
+
+;;; =========================================================================
+;;;
+;;; Some generally useful functions
(defun reftex-typekey-check (typekey conf-variable &optional n)
;; Check if CONF-VARIABLE is true or contains TYPEKEY
(and n (setq conf-variable (nth n conf-variable)))
- (or (equal conf-variable t)
+ (or (eq conf-variable t)
(and (stringp conf-variable)
(string-match (concat "[" conf-variable "]") typekey))))
-;;; ===========================================================================
-;;;
-;;; Table of contents (contributed from Stephen Eglen, changed by C. Dominik)
-
-;; We keep at most one *toc* buffer - it is easy to make them
-
-(defvar reftex-last-toc-master nil
- "Stores the name of the tex file that `reftex-toc' was last run on.")
-
-(defvar reftex-last-toc-file nil
- "Stores the file name from which `reftex-toc' was called. For redo command.")
-
-(defvar reftex-toc-return-marker (make-marker)
- "Marker which makes it possible to return from toc to old position.")
-
-(defun reftex-toc ()
- "Show the table of contents for the current document.
-To see the corresponding part of the LaTeX document, use within the
-*toc* buffer:
-
-SPC Show the corresponding section of the LaTeX document
-RET Goto the section and hide the *toc* buffer
-q Hide the *toc* window and return to position of last reftex-toc command
-Q Kill the *toc* buffer and return to position of last reftex-toc command
-f Toggle follow mode on and off
-
-When called with a raw C-u prefix, rescan the document first."
-
- (interactive)
-
- (and (not (string= reftex-last-toc-master (reftex-TeX-master-file)))
- (get-buffer "*toc*")
- (kill-buffer "*toc*"))
-
- (setq reftex-last-toc-file (buffer-file-name))
- (setq reftex-last-toc-master (reftex-TeX-master-file))
-
- (set-marker reftex-toc-return-marker (point))
-
- ;; if follow mode is active, arrange to delay it one command
- (if reftex-toc-follow-mode
- (setq reftex-toc-follow-mode 1))
-
- (if (and current-prefix-arg
- (get-buffer "*toc*"))
- (kill-buffer "*toc*"))
-
- ;; Ensure access to scanning info and rescan buffer if prefix are is '(4)
- (reftex-access-scan-info current-prefix-arg)
+(defun reftex-check-recursive-edit ()
+ ;; Check if we are already in a recursive edit. Abort with helpful
+ ;; message if so.
+ (if (marker-position reftex-recursive-edit-marker)
+ (error
+ (substitute-command-keys
+ "In unfinished selection process. Finish, or abort with \\[abort-recursive-edit]"))))
- (let* ((all (symbol-value reftex-list-of-labels-symbol))
- (where (reftex-nearest-section))
- toc toc1 cell label file find startpos)
+(defun reftex-in-comment ()
+ (save-excursion
+ (skip-chars-backward "^%\n\r")
+ (eq (preceding-char) ?%)))
- (if (and (get-buffer "*toc*")
- (get-buffer-window (get-buffer "*toc*")))
- (select-window (get-buffer-window (get-buffer "*toc*")))
- (delete-other-windows)
- (switch-to-buffer-other-window (current-buffer))
- (switch-to-buffer-other-window (get-buffer-create "*toc*")))
+(defun reftex-no-props (string)
+ ;; Return STRING with all text properties removed
+ (and (stringp string)
+ (set-text-properties 0 (length string) nil string))
+ string)
- (cond
- ;; buffer is empty - fill it with the table of contents
- ((= (buffer-size) 0)
-
- (local-set-key " " 'reftex-toc-view-line)
- (local-set-key "\C-m" 'reftex-toc-goto-line-and-hide)
- (local-set-key "r" 'reftex-toc-redo)
- (local-set-key "q" 'reftex-toc-quit)
- (local-set-key "Q" 'reftex-toc-quit-and-kill)
- (local-set-key "f" 'reftex-toc-toggle-follow)
- (setq truncate-lines t)
- (make-local-hook 'post-command-hook)
- (make-local-hook 'pre-command-hook)
- (setq post-command-hook '(reftex-toc-post-command-hook))
- (setq pre-command-hook '(reftex-toc-pre-command-hook))
-
- (insert (format
-"TABLE-OF-CONTENTS on %s
-MENU: SPC=view RET=goto [q]uit [Q]uit+kill [r]escan [f]ollow-mode on/off
--------------------------------------------------------------------------------
-" (abbreviate-file-name reftex-last-toc-master)))
- (setq startpos (point))
-
- (if (reftex-use-fonts)
- (put-text-property 1 (point) 'face 'font-lock-keyword-face))
- (put-text-property 1 (point) 'intangible t)
-
- (while all
- (setq cell (car all)
- all (cdr all))
- (setq label (nth 0 cell)
- toc (nth 2 cell)
- file (nth 3 cell)
- find (nth 4 cell))
- (if (not label)
- (progn
- (setq toc1 (concat toc "\n"))
- (put-text-property 0 (length toc1)
- 'file file toc1)
- (put-text-property 0 (length toc1)
- 'find find toc1)
- (insert toc1)
- )))
+(defun reftex-match-string (n)
+ ;; Match string without properties
+ (when (match-beginning n)
+ (buffer-substring-no-properties (match-beginning n) (match-end n))))
- (backward-delete-char 1)
+(defun reftex-kill-buffer (buffer)
+ ;; Kill buffer if it exists.
+ (and (setq buffer (get-buffer buffer))
+ (kill-buffer buffer)))
- (setq buffer-read-only t))
- (t
- (goto-line 3)
- (beginning-of-line)
- (setq startpos (point))))
-
- ;; Find the correct section
- (goto-char (point-max))
- (beginning-of-line)
- (while (and (> (point) startpos)
- (or (not (string= (get-text-property (point) 'file)
- (car where)))
- (not (string= (get-text-property (point) 'find)
- (cdr where)))))
- (beginning-of-line 0))))
-
-(defun reftex-nearest-section ()
- ;; Return (file . find) of nearest section command
- (let (cell label rest)
- (save-excursion
- (cond
- ;; Try to find a section heading
- ((or (re-search-backward reftex-section-regexp nil t)
- (re-search-forward reftex-section-regexp nil t))
- (goto-char (match-end 0))
- (cons (buffer-file-name)
- (reftex-allow-for-ctrl-m
- (concat (buffer-substring-no-properties
- (1- (match-beginning 1)) (match-end 0))
- (reftex-context-substring)))))
- ;; Try to find a label
- ((and (or (re-search-backward "\\\\label{\\([^}]+\\)}" nil t)
- (re-search-forward "\\\\label{\\([^}]+\\)}" nil t))
- (setq label (reftex-no-props (match-string 1)))
- (setq cell (assoc label (symbol-value
- reftex-list-of-labels-symbol)))
- (setq rest (memq cell (symbol-value reftex-list-of-labels-symbol)))
- (setq cell (car (memq (assoc nil rest) rest)))
- (null (car cell)))
- (cons (nth 3 cell) (nth 4 cell)))
- (t nil)))))
-
-(defun reftex-toc-pre-command-hook ()
- ;; used as pre command hook in *toc* buffer
- (reftex-unhighlight 0)
- (reftex-unhighlight 1))
-
-(defun reftex-toc-post-command-hook ()
- ;; used in the post-command-hook for the *toc* buffer
- (and (> (point) 1)
- (save-excursion
- (reftex-highlight 1
- (progn (beginning-of-line) (point))
- (progn (end-of-line) (point)))))
+(defun reftex-erase-buffer (&optional buffer)
+ ;; Erase BUFFER if it exists. BUFFER defaults to current buffer.
+ ;; This even erases read-only buffers.
(cond
- ((integerp reftex-toc-follow-mode)
- ;; remove delayed action
- (setq reftex-toc-follow-mode t))
- (reftex-toc-follow-mode
- ;; show context in other window
- (condition-case nil
- (reftex-toc-visit-line)
- ('error t)))))
-
-(defun reftex-toc-toggle-follow ()
- "Toggle toc-follow mode.
-(it is not really a mode, just a flag)."
- (interactive)
- (setq reftex-toc-follow-mode (not reftex-toc-follow-mode)))
-(defun reftex-toc-view-line ()
- "View document location in other window."
- (interactive)
- (reftex-toc-visit-line))
-(defun reftex-toc-goto-line-and-hide ()
- "Go to document location in other window. Hide the *toc* window."
- (interactive)
- (reftex-toc-visit-line 'hide))
-(defun reftex-toc-quit ()
- "Hide the *toc* window and do not move point."
- (interactive)
- (delete-window)
- (switch-to-buffer (marker-buffer reftex-toc-return-marker))
- (goto-char (marker-position reftex-toc-return-marker)))
-(defun reftex-toc-quit-and-kill ()
- "Kill the *toc* buffer."
- (interactive)
- (kill-buffer "*toc*")
- (delete-window)
- (switch-to-buffer (marker-buffer reftex-toc-return-marker))
- (goto-char (marker-position reftex-toc-return-marker)))
-(defun reftex-toc-redo ()
- "Regenerate the *toc* buffer. Call only from within the *toc* buffer"
- (interactive)
- (switch-to-buffer (reftex-get-file-buffer-force reftex-last-toc-file))
- (delete-other-windows)
- (setq current-prefix-arg '(4))
- (reftex-toc))
-
-(defun reftex-toc-visit-line (&optional final)
- ;; Visit the tex file corresponding to the toc entry on the current line.
- ;; If FINAL is t, stay there
- ;; If FINAL is 'hide, hide the *toc* window.
- ;; Otherwise, move cursor back into *toc* window
-
- (let (file find beg end (toc-window (selected-window)) show-window)
+ ((null buffer)
+ ;; erase current buffer
+ (let ((buffer-read-only nil)) (erase-buffer)))
+ ((setq buffer (get-buffer buffer))
+ ;; buffer exists
(save-excursion
- (beginning-of-line)
- (setq beg (point))
- (end-of-line)
- (setq end (point)))
-
- ;; get the file and the search string
- (setq file (get-text-property (point) 'file))
- (setq find (get-text-property (point) 'find))
- (if (or (not file) (not find))
- (error "Cannot visit line"))
-
- (switch-to-buffer-other-window (reftex-get-file-buffer-force file))
- (setq show-window (selected-window))
- (goto-char (point-min))
-
- (if (not (re-search-forward find nil t))
- (error "Cannot visit line"))
+ (set-buffer buffer)
+ (let ((buffer-read-only nil)) (erase-buffer))))))
- (setq beg (match-beginning 0)
- end (match-end 0))
+(defun reftex-this-word (&optional class)
+ ;; Grab the word around point.
+ (setq class (or class "-a-zA-Z0-9:_/.*;|"))
+ (save-excursion
+ (buffer-substring-no-properties
+ (progn (skip-chars-backward class) (point))
+ (progn (skip-chars-forward class) (point)))))
- (goto-char beg)
- (recenter 1)
- (reftex-highlight 0 beg end (current-buffer))
+(defun reftex-number (n unit &optional ending)
+ (if (and (integerp n) (stringp unit))
+ (format "%d %s%s" n unit (if (= n 1) "" (or ending "s")))
+ ""))
- (select-window toc-window)
+(defun reftex-all-assq (key list)
+ ;; Return a list of all associations of KEY in LIST. Comparison with eq.
+ (let (rtn)
+ (while (setq list (memq (assq key list) list))
+ (push (car list) rtn)
+ (pop list))
+ (nreverse rtn)))
- ;; use the `final' parameter to decide what to do next
- (cond
- ((equal final t)
- (reftex-unhighlight 0)
- (select-window show-window))
- ((eq final 'hide)
- (reftex-unhighlight 0)
- (delete-window))
- (t nil))))
-
-;;; ===========================================================================
-;;;
-;;; BibTeX citations.
+(defun reftex-all-assoc-string (key list)
+ ;; Return a list of all associations of KEY in LIST. Comparison with string=.
+ (let (rtn)
+ (while list
+ (if (string= (car (car list)) key)
+ (push (car list) rtn))
+ (pop list))
+ (nreverse rtn)))
-;; Variables and constants
-
-;; Internal variable, but used from different functions
-(defvar reftex-cite-format1 nil)
-
-;; The history list of regular expressions used for citations
-(defvar reftex-cite-regexp-hist nil)
-
-;; Help string for citation selection
-(defconst reftex-citation-help
- "AVAILABLE KEYS IN MAKE CITATION MENU
----------------------------------------
- n / p Go to next/previous entry (Cursor motion works as well)
- r restrict selection with another regexp
- SPACE Show full database entry in other window
- f Toggle follow mode: Other window will follow with full db entry
- q Quit without inserting \\cite macro into buffer
- ? Display this help message
- C-r Recursive edit into other window
- RETURN ... Accept current entry and insert in format according to
- reftex-cite-format")
-
-(defconst reftex-cite-format-default "\\cite{KEY}"
- "The default value for reftex-cite-format.
-Uses the string version of scitex-cite-format.")
-
-(defconst reftex-cite-format-1-author-simple
- '( "\\cite{KEY}" "AUTHOR \\cite{KEY}" "AUTHOR {\it et al.} \\cite{KEY}")
- "Value for reftex-cite format establishing a simple citation with name
-of the first author.
-Uses the list version of reftex-cite-format.")
-
-(defconst reftex-cite-format-2-authors
- '((?\C-m
- . ( "\\cite{KEY}" "AUTHOR \\cite{KEY}"
- "AUTHOR \\& AUTHOR \\cite{KEY}" "AUTHOR \\etal{} \\cite{KEY}"))
- (?\,
- . ("\\cite{KEY}" "AUTHOR, \\cite{KEY}"
- "AUTHOR \\& AUTHOR, \\cite{KEY}" "AUTHOR \\etal{}, \\cite{KEY}"))
- (?\;
- . ("\\cite{KEY}" "AUTHOR; \\cite{KEY}"
- "AUTHOR \\& AUTHOR; \\cite{KEY}" "AUTHOR \\etal{}; \\cite{KEY}"))
- (?\:
- . ("\\cite{KEY}" "AUTHOR: \\cite{KEY}"
- "AUTHOR \\& AUTHOR: \\cite{KEY}" "AUTHOR \\etal{}: \\cite{KEY}"))
- (?\(
- . ("(\\cite{KEY})" "AUTHOR (\\cite{KEY})"
- "AUTHOR \\& AUTHOR (\\cite{KEY})" "AUTHOR \\etal{} (\\cite{KEY})"))
- (?\[
- . ("[\\cite{KEY}]" "AUTHOR [\\cite{KEY}]"
- "AUTHOR \\& AUTHOR [\\cite{KEY}]" "AUTHOR \\etal{} [\\cite{KEY}]")))
- "Value for reftex-cite-format that estabishes an Author/Year citation
-where the year is supplied from BibTeX. Depending on which character
-is used during selection to accept the label, an extra ,;: or pair of
-parenthesis will be inserted.
-Uses the list-of-cons-cells version of reftex-cite-format.")
-
-;; Find bibtex files
-
-(defun reftex-get-bibfile-list ()
- ;; Return list of bibfiles for current document
-
- ;; Ensure access to scanning info
- (reftex-access-scan-info)
-
- (or (symbol-value reftex-bibfile-list-symbol)
- (error "No BibTeX files to parse. Add \\bibliography statment to document and reparse.")))
-
-(defun reftex-scan-buffer-for-bibliography-statement (bib-list-symbol)
- ;; Scan buffer for bibliography macro and store file list in bib-list-symbol.
- (let (file-list dir-list)
- (setq dir-list
- (reftex-split
- (concat path-separator "+")
- (mapconcat '(lambda(x)
- (if (getenv x) (getenv x) ""))
- reftex-bibpath-environment-variables
- path-separator)))
- (goto-char (point-min))
- (if (re-search-forward "^[ \t]*\\\\bibliography{[ \t]*\\([^}]+\\)" nil t)
- (progn
- (setq dir-list
- (cons (file-name-directory
- (get-text-property (match-beginning 0) 'file))
- dir-list))
- (setq file-list
- (mapcar '(lambda (x) (concat x ".bib"))
- (reftex-delete-list
- reftex-bibfile-ignore-list
- (reftex-split
- "[ \t\n]*,[ \t\n]*"
- (reftex-no-props (match-string 1)))))))
- (message "No \\bibliography command in document."))
- (set bib-list-symbol
- (if file-list
- (reftex-find-files-on-path file-list dir-list
- "While parsing \\bibliography{}:")
- nil))))
-
-(defun reftex-find-files-on-path (file-list path-list &optional error-string)
- ;; Search for all files in FILE-LIST on the PATH-LIST. Return absolute names.
- ;; A missing file throws an exception with the error message ERROR-STRING.
- (let (found-list found file)
- (while file-list
- (setq file (car file-list)
- file-list (cdr file-list)
- found nil)
- (if (file-name-absolute-p file)
- (setq found (expand-file-name file))
- (let ((dirs path-list))
- (while (and dirs (not found))
- (if (and (not (string= (car dirs) ""))
- (file-exists-p (expand-file-name file (car dirs))))
- (setq found (expand-file-name file (car dirs))))
- (setq dirs (cdr dirs)))))
- (if (and found
- (file-exists-p found))
- (add-to-list 'found-list (expand-file-name found))
- (error "%s No such file %s."
- (or error-string "") file)))
- (nreverse found-list)))
-
-;; Find a certain reference in any of the BibTeX files.
-
-(defun reftex-pop-to-bibtex-entry (key file-list
- &optional mark-to-kill highlight)
- ;; Find BibTeX KEY in any file in FILE-LIST in another window.
- ;; If mark-to-kill is non-nil, mark new buffer to kill."
-
- (let* ((re (concat "@[a-zA-Z]+[ \t\n\r]*{[ \t\n\r]*" (regexp-quote key) "[ \t\n\r,]"))
- (window-conf (current-window-configuration))
- file buf)
- (catch 'exit
- (switch-to-buffer-other-window (current-buffer))
- (while file-list
- (setq file (car file-list)
- file-list (cdr file-list))
- (if (not (setq buf (reftex-get-file-buffer-force file mark-to-kill)))
- (error "No such file %s" file))
- (switch-to-buffer buf)
- (widen)
- (goto-char 0)
- (if (re-search-forward re nil t)
- (progn
- (goto-char (match-beginning 0))
- (recenter 0)
- (if highlight
- (reftex-highlight 0 (match-beginning 0) (match-end 0)))
- (throw 'exit (selected-window)))))
- (set-window-configuration window-conf)
- (beep)
- (message "No BibTeX entry with citation key %s" key))))
-
-;; Parse bibtex buffers
-
-(defun reftex-extract-bib-entries (buffers &optional get-word)
- ;; Extract bib entries which match regexps from BUFFERS.
- ;; BUFFERS is a list of buffers or file names.
- ;; Return list with entries."
- (let* (re-list first-re rest-re
- ;; avoid fontification of lookup buffers
- (lazy-lock-minimum-size 1)
- (buffer-list (if (listp buffers) buffers (list buffers)))
- found-list entry buffer1 buffer alist
- key-point start-point end-point)
-
- (setq re-list (reftex-split "[ \t]*&&[ \t]*"
- (read-string "RegExp [ && RegExp...]: "
- nil 'reftex-cite-regexp-hist)))
-
- (setq first-re (car re-list) ; We'll use the first re to find things,
- rest-re (cdr re-list)) ; the other to narrow down.
- (if (string-match "\\`[ \t]*\\'" first-re)
- (error "Empty regular expression"))
+(defun reftex-last-assoc-before-elt (key elt list &optional exclusive)
+ ;; Find the last association of KEY in LIST before or at ELT
+ ;; ELT is found in LIST with equal, not eq.
+ ;; Returns nil when either KEY or elt are not found in LIST.
+ ;; When EXCLUSIVE is non-nil, ELT cannot be the return value.
+ ;; On success, returns the association.
+ (let* ((elt (car (member elt list))) (ex (not exclusive)) ass last-ass)
+ (while (and (setq ass (assoc key list))
+ (setq list (memq ass list))
+ (or ex (not (eq elt (car list))))
+ (memq elt list))
+ (setq last-ass ass
+ list (cdr list)))
+ last-ass))
- (save-excursion
- (save-window-excursion
-
- ;; walk through all bibtex files
- (while buffer-list
- (setq buffer (car buffer-list)
- buffer-list (cdr buffer-list))
- (if (and (bufferp buffer)
- (buffer-live-p buffer))
- (setq buffer1 buffer)
- (setq buffer1 (reftex-get-file-buffer-force
- buffer (not reftex-keep-temporary-buffers))))
- (if (not buffer1)
- (error "Cannot find BibTeX file %s" buffer)
- (message "Scanning bibliography database %s" buffer1))
-
- (set-buffer buffer1)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward first-re nil t)
- (catch 'search-again
- (setq key-point (point))
- (if (not (re-search-backward
- "^[ \t]*@\\([a-zA-Z]+\\)[ \t\n\r]*{" nil t))
- (throw 'search-again nil))
- (setq start-point (point))
- (goto-char (match-end 0))
- (condition-case nil
- (up-list 1)
- ('error (goto-char key-point)
- (throw 'search-again nil)))
- (setq end-point (point))
-
- ;; Ignore @string, @comment and @c entries or things
- ;; outside entries
- (if (or (string= (downcase (match-string 1)) "string")
- (string= (downcase (match-string 1)) "comment")
- (string= (downcase (match-string 1)) "c")
- (< (point) key-point)) ; this means match not in {}
- (progn
- (goto-char key-point)
- (throw 'search-again nil)))
-
- ;; Well, we have got a match
- (setq entry (concat
- (buffer-substring start-point (point)) "\n"))
-
- ;; Check if other regexp match as well
- (setq re-list rest-re)
- (while re-list
- (if (not (string-match (car re-list) entry))
- ;; nope - move on
- (throw 'search-again nil))
- (setq re-list (cdr re-list)))
-
- (setq alist (reftex-parse-bibtex-entry
- nil start-point end-point))
- (setq alist (cons (cons "&entry" entry) alist))
-
- ;; check for crossref entries
- (if (assoc "crossref" alist)
- (setq alist
- (append
- alist (reftex-get-crossref-alist alist))))
-
- ;; format the entry
- (setq alist
- (cons
- (cons "&formatted"
- (reftex-format-bib-entry alist))
- alist))
-
- ;; add it to the list
- (setq found-list (cons alist found-list)))))
- (reftex-kill-temporary-buffers))))
- (setq found-list (nreverse found-list))
-
- ;; Sorting
- (cond
- ((eq 'author reftex-sort-bibtex-matches)
- (sort found-list 'reftex-bib-sort-author))
- ((eq 'year reftex-sort-bibtex-matches)
- (sort found-list 'reftex-bib-sort-year))
- ((eq 'reverse-year reftex-sort-bibtex-matches)
- (sort found-list 'reftex-bib-sort-year-reverse))
- (t found-list))))
-
-(defun reftex-bib-sort-author (e1 e2)
- (let ((al1 (reftex-get-bib-authors e1)) (al2 (reftex-get-bib-authors e2)))
- (while (and al1 al2 (string= (car al1) (car al2)))
- (setq al1 (cdr al1)
- al2 (cdr al2)))
- (if (and (stringp (car al1))
- (stringp (car al2)))
- (string< (car al1) (car al2))
- (not (stringp (car al1))))))
-
-(defun reftex-bib-sort-year (e1 e2)
- (< (string-to-int (cdr (assoc "year" e1)))
- (string-to-int (cdr (assoc "year" e2)))))
-
-(defun reftex-bib-sort-year-reverse (e1 e2)
- (> (string-to-int (or (cdr (assoc "year" e1)) "0"))
- (string-to-int (or (cdr (assoc "year" e2)) "0"))))
-
-(defun reftex-get-crossref-alist (entry)
- ;; return the alist from a crossref entry
- (let ((crkey (cdr (assoc "crossref" entry)))
- start)
- (save-excursion
- (save-restriction
- (widen)
- (if (re-search-forward
- (concat "@\\w+{[ \t\n\r]*" (regexp-quote crkey) "[ \t\n\r]*,") nil t)
- (progn
- (setq start (match-beginning 0))
- (condition-case nil
- (up-list 1)
- ('error nil))
- (reftex-parse-bibtex-entry nil start (point)))
- nil)))))
-
-;; Parse and format individual entries
-
-(defun reftex-get-bib-authors (entry)
- ;; Return a list with the author names in ENTRY
- (let (authors)
- (setq authors (reftex-get-bib-field "author" entry))
- (if (equal "" authors)
- (setq authors (reftex-get-bib-field "editor" entry)))
- (while (string-match "\\band\\b[ \t]*" authors)
- (setq authors (replace-match "\n" nil t authors)))
- (while (string-match "[\\.a-zA-Z\\-]+\\.[ \t]*\\|,.*\\|[{}]+" authors)
- (setq authors (replace-match "" nil t authors)))
- (while (string-match "^[ \t]+\\|[ \t]+$" authors)
- (setq authors (replace-match "" nil t authors)))
- (while (string-match "[ \t][ \t]+" authors)
- (setq authors (replace-match " " nil t authors)))
- (reftex-split "\n" authors)))
-
-(defun reftex-parse-bibtex-entry (entry &optional from to)
- (let (alist key start field)
- (save-excursion
- (save-restriction
- (if entry
- (progn
- (switch-to-buffer "*RefTeX-scratch*")
- (fundamental-mode)
- (erase-buffer)
- (insert entry))
- (widen)
- (narrow-to-region from to))
- (goto-char (point-min))
-
- (if (re-search-forward
- "@\\(\\w+\\)[ \t\n\r]*{[ \t\n\r]*\\([^ \t\n\r,]+\\)" nil t)
- (setq alist
- (list
- (cons "&type" (downcase (reftex-no-props (match-string 1))))
- (cons "&key" (reftex-no-props (match-string 2))))))
- (while (re-search-forward "\\(\\w+\\)[ \t\n\r]*=[ \t\n\r]*" nil t)
- (setq key (reftex-no-props (downcase (match-string 1))))
- (cond
- ((= (following-char) ?{)
- (forward-char 1)
- (setq start (point))
- (condition-case nil
- (up-list 1)
- ('error nil)))
- ((= (following-char) ?\")
- (forward-char 1)
- (setq start (point))
- (while (and (search-forward "\"" nil t)
- (= ?\\ (char-after (- (point) 2))))))
- (t
- (setq start (point))
- (re-search-forward "[ \t\n\r,}]" nil 1)))
- (setq field (buffer-substring-no-properties start (1- (point))))
- ;; remove extra whitesp
- (while (string-match "[\n\t\r]\\|[ \t][ \t]+" field)
- (setq field (replace-match " " nil t field)))
- ;; remove leading garbage
- (if (string-match "^[ \t{]+" field)
- (setq field (replace-match "" nil t field)))
- ;; remove trailing garbage
- (if (string-match "[ \t}]+$" field)
- (setq field (replace-match "" nil t field)))
- (setq alist (cons (cons key field) alist)))
- alist))))
-
-(defun reftex-get-bib-field (fieldname entry)
- ;; Extract the field FIELDNAME from an ENTRY
- (or (cdr (assoc fieldname entry))
- ""))
-
-(defun reftex-format-bib-entry (entry)
- ;; Format a BibTeX ENTRY so that it is nice to look at
- (let*
- ((rtn nil)
- (auth-list (reftex-get-bib-authors entry))
- (authors (mapconcat '(lambda (x) x) auth-list ", "))
- (year (reftex-get-bib-field "year" entry))
- (title (reftex-get-bib-field "title" entry))
- (type (reftex-get-bib-field "&type" entry))
- (key (reftex-get-bib-field "&key" entry))
- (extra
- (cond
- ((equal type "article")
- (concat (reftex-get-bib-field "journal" entry) " "
- (reftex-get-bib-field "volume" entry) ", "
- (reftex-get-bib-field "pages" entry)))
- ((equal type "book")
- (concat "book (" (reftex-get-bib-field "publisher" entry) ")"))
- ((equal type "phdthesis")
- (concat "PhD: " (reftex-get-bib-field "school" entry)))
- ((equal type "mastersthesis")
- (concat "Master: " (reftex-get-bib-field "school" entry)))
- ((equal type "inbook")
- (concat "Chap: " (reftex-get-bib-field "chapter" entry)
- ", pp. " (reftex-get-bib-field "pages" entry)))
- ((or (equal type "conference")
- (equal type "incollection")
- (equal type "inproceedings"))
- (concat "in: " (reftex-get-bib-field "booktitle" entry)))
- (t ""))))
- (setq authors
- (if (> (length authors) 30)
- (concat (substring authors 0 27) "...")
- (format "%-30s" authors))
- title
- (if (> (length title) 70)
- (concat (substring title 0 67) "...")
- (format "%-70s" title))
- extra
- (if (> (length extra) 40)
- (concat (substring extra 0 37) "...")
- (format "%-40s" extra)))
- (if (reftex-use-fonts)
- (progn
- (put-text-property 0 (length authors) 'face 'font-lock-keyword-face
- authors)
- (put-text-property 0 (length title) 'face 'font-lock-comment-face
- title)
- (put-text-property 0 (length extra) 'face 'font-lock-reference-face
- extra)))
- (setq rtn (concat key "\n " authors " " year " " extra
- "\n " title "\n\n"))
- rtn))
-
-;; Make a citation
-
-(defun reftex-citation (&optional arg no-insert)
- "Make a citation unsing BibTeX database files.
-After asking for a Regular Expression, it scans the buffers with
-bibtex entries (taken from the \\bibliography command) and offers the
-matching entries for selection. The selected entry is formated according
-to reftex-cite-format and inserted into the buffer.
-If NO-INSERT is non-nil, nothing is inserted, only the selected key returned.
-The regular expression uses an expanded syntax: && is interpreted as 'and'.
-Thus, aaaa&&bbb matches entries which contain both aaaa and bbb.
-When this function is called with point inside the braces of a \\cite{}
-command, it will add another key, ignoring the value of reftex-cite-format.
-When called with a numeric prefix, that many citations will be made and all
-put into the same \\cite{} command.
-When called with just C-u as prefix, enforces rescan of buffer for
-bibliography statement (e.g. if it was changed)."
+(defun reftex-sublist-nth (list nth predicate &optional completion)
+ ;; Make a list of the NTH elements of all members of LIST which
+ ;; fulfill PREDICATE.
+ ;; When COMPLETION is non-nil, make all elements of the resulting
+ ;; list also a list, so that the result can be used for completion.
+ (let (rtn)
+ (while list
+ (if (funcall predicate (car list))
+ (push (if completion
+ (list (nth nth (car list)))
+ (nth nth (car list)))
+ rtn))
+ (setq list (cdr list)))
+ (nreverse rtn)))
- (interactive "P")
+(defun reftex-make-selection-buffer-name (type &optional index)
+ ;; Make unique name for a selection buffer.
+ (format " *RefTeX[%s][%d]*"
+ type (or index (get reftex-docstruct-symbol :master-index) 0)))
+
+(defun reftex-make-index-buffer-name (tag &optional cnt)
+ ;; Make unique name for an index buffer.
+ (format "*Index[%s][%d]*"
+ tag (or cnt (get reftex-docstruct-symbol :master-index) 0)))
+
+(defun reftex-truncate (string ncols &optional ellipses padding)
+ ;; Truncate STRING to NCOLS characters.
+ ;; When PADDING is non-nil, and string is shorter than NCOLS, fill with
+ ;; white space to NCOLS characters. When ELLIPSES is non-nil and the
+ ;; string needs to be truncated, replace last 3 characters by dots.
+ (setq string
+ (if (<= (length string) ncols)
+ string
+ (if ellipses
+ (concat (substring string 0 (- ncols 3)) "...")
+ (substring string 0 ncols))))
+ (if padding
+ (format (format "%%-%ds" ncols) string)
+ string))
- ;; check for recursive edit
- (reftex-check-recursive-edit)
-
- ;; if there is just 1 C-u prefix arg, force to rescan buffer
- (if (and current-prefix-arg
- (listp current-prefix-arg)
- (= 4 (prefix-numeric-value arg)))
- (reftex-reset-scanning-information))
-
- ;; check if there is already a cite command at point and change cite format
- ;; in order to only add another reference in the same cite command.
- (let ((pos (point)))
- (search-backward "\\" (point-min) 1)
- (if (and (looking-at "\\\\[a-zA-Z]*cite\\*?\\(\\[[^]]*\\]\\)*{\\([^}]*\\)")
- (>= (match-end 0) pos)
- (>= pos (match-beginning 2)))
- (progn
- (goto-char pos)
+(defun reftex-nearest-match (regexp &optional max-length)
+ ;; Find the nearest match of REGEXP. Set the match data.
+ ;; If POS is given, calculate distances relative to it.
+ ;; Return nil if there is no match.
+ (let ((pos (point))
+ (dist (or max-length (length regexp)))
+ match1 match2 match)
+ (goto-char (min (+ pos dist) (point-max)))
+ (when (re-search-backward regexp nil t)
+ (setq match1 (match-data)))
+ (goto-char (max (- pos dist) (point-min)))
+ (when (re-search-forward regexp nil t)
+ (setq match2 (match-data)))
+ (goto-char pos)
+ (setq match
(cond
- ((or (not arg)
- (not (listp arg)))
- (setq reftex-cite-format1
- (concat
- (if (not (or (= (preceding-char) ?{)
- (= (preceding-char) ?,)))
- ","
- "")
- "KEY"
- (if (not (or (= (following-char) ?})
- (= (following-char) ?,)))
- ","
- ""))))
- (t
- (setq reftex-cite-format1 "KEY"))))
- (setq reftex-cite-format1
- (if (symbolp reftex-cite-format)
- (symbol-value reftex-cite-format)
- reftex-cite-format))
- (goto-char pos)))
-
- (let* (key entry cnt rtn ins-string re-list re
- ;; scan bibtex files
- (lazy-lock-minimum-size 1)
- (found-list (reftex-extract-bib-entries
- (reftex-get-bibfile-list)))
- (found-list-r nil)
- (accept-keys
- (if (and (listp reftex-cite-format1)
- (listp (car reftex-cite-format1)))
- (mapcar 'car reftex-cite-format1)
- '(?\C-m))))
- (if (not found-list)
- (error "Sorry, no matches found"))
-
- ;; remember where we came from
- (setq reftex-call-back-to-this-buffer (current-buffer))
-
- ;; offer selection
+ ((not match1) match2)
+ ((not match2) match1)
+ ((< (abs (- pos (car match1))) (abs (- pos (car match2)))) match1)
+ (t match2)))
+ (if match (progn (set-match-data match) t) nil)))
+
+(defun reftex-auto-mode-alist ()
+ ;; Return an `auto-mode-alist' with only the .gz (etc) thingies.
+ ;; Stolen from gnus nnheader.
+ (let ((alist auto-mode-alist)
+ out)
+ (while alist
+ (when (listp (cdr (car alist)))
+ (push (car alist) out))
+ (pop alist))
+ (nreverse out)))
+
+(defun reftex-window-height ()
+ (if (fboundp 'window-displayed-height)
+ (window-displayed-height)
+ (window-height)))
+
+(defun reftex-enlarge-to-fit (buf2 &optional keep-current)
+ ;; Enlarge other window displaying buffer to show whole buffer if possible.
+ ;; If KEEP-CURRENT in non-nil, current buffer must remain visible.
+ (let* ((win1 (selected-window))
+ (buf1 (current-buffer))
+ (win2 (get-buffer-window buf2))) ;; Only on current frame.
+ (when win2
+ (select-window win2)
+ (unless (and (pos-visible-in-window-p 1)
+ (pos-visible-in-window-p (point-max)))
+ (enlarge-window (1+ (- (count-lines 1 (point-max))
+ (reftex-window-height))))))
+ (cond
+ ((window-live-p win1) (select-window win1))
+ (keep-current
+ ;; we must have the old buffer!
+ (switch-to-buffer-other-window buf1)
+ (shrink-window (- (window-height) window-min-height))))))
+
+(defun reftex-select-with-char (prompt help-string &optional delay-time scroll)
+ ;; Offer to select something with PROMPT and, after DELAY-TIME seconds,
+ ;; also with HELP-STRING.
+ ;; When SCROLL is non-nil, use SPC and DEL to scroll help window.
+ (let ((char ?\?))
(save-window-excursion
- (switch-to-buffer-other-window "*RefTeX Select*")
- (erase-buffer)
- (mapcar '(lambda (x) (insert (cdr (assoc "&formatted" x))))
- found-list)
- (if (= 0 (buffer-size))
- (error "Sorry, no matches found"))
- (setq truncate-lines t)
- (goto-char 1)
- (if (catch 'exit
- (while t
- (setq rtn
- (reftex-select-item
- nil
- (concat
- "Select: [n]ext [p]rev [r]estrict [q]uit [?]Help ||"
- " RETURN "
- (condition-case nil
- (mapconcat 'char-to-string accept-keys " ")
- (error (error "Illegal reftex-cite-format"))))
- "^[^ \t\n]"
- "\n\n"
- 4
- reftex-citation-help
- (cons ?r accept-keys)
- nil
- 'reftex-bibtex-selection-callback nil))
- (setq key (car rtn)
- cnt (cdr rtn))
- (if (not key) (throw 'exit nil))
- (cond
- ((equal key ?r)
- ;; restrict with new regular expression
- (setq re-list
- (reftex-split "[ \t]*&&[ \t]*"
- (read-string "RegExp [ && RegExp...]: "
- nil 'reftex-cite-regexp-hist)))
- (while re-list
- (setq re (car re-list)
- re-list (cdr re-list))
- (setq found-list-r
- (delete ""
- (mapcar
- '(lambda (x)
- (if (string-match re
- (cdr (assoc "&entry" x)))
- x
- ""))
- found-list))))
- (if found-list-r
- (setq found-list found-list-r)
- (ding))
- (erase-buffer)
- (mapcar '(lambda (x) (insert (cdr (assoc "&formatted" x))))
- found-list)
- (goto-char 1))
- ((or (member key accept-keys)
- (equal key ?\C-m)
- (equal key 'return))
- (setq entry (nth cnt found-list))
- (throw 'exit t))
- (t
- (ding)))))
- (progn
- ;; format the entry
- (if (not (integerp key)) (setq key ?\C-m))
- (setq ins-string (reftex-format-citation entry key)))
- (setq ins-string "")
- (message "Quit")))
- (kill-buffer "*RefTeX Select*")
-
- (if (not no-insert)
- (insert ins-string))
- (message "")
-
- ;; Check if the prefix arg was numeric, and call reftex-citation recursively
- (if (and (integerp arg)
- (> arg 1)
- (re-search-backward
- "\\\\[a-zA-Z]*cite\\*?\\(\\[[^]]*\\]\\)*{\\([^}]*\\)" nil t))
- (progn
- (goto-char (match-end 0))
- (setq arg (1- arg))
- (reftex-citation arg))
- (reftex-kill-temporary-buffers))
- ;; Return the citation key
- (reftex-get-bib-field "&key" entry)))
-
-(defun reftex-format-citation (entry key)
- ;; Format a citation from the info in the BibTeX ENTRY
- (let* ((cite-key (reftex-get-bib-field "&key" entry))
- (year (reftex-get-bib-field "year" entry))
- (auth-list (reftex-get-bib-authors entry))
- (nauthors (length auth-list))
- format)
+ (catch 'exit
+ (message (concat prompt " (?=Help)"))
+ (when (or (sit-for (or delay-time 0))
+ (= ?\? (setq char (read-char-exclusive))))
+ (reftex-kill-buffer "*RefTeX Select*")
+ (switch-to-buffer-other-window "*RefTeX Select*")
+ (insert help-string)
+ (goto-char 1)
+ (unless (and (pos-visible-in-window-p 1)
+ (pos-visible-in-window-p (point-max)))
+ (enlarge-window (1+ (- (count-lines 1 (point-max))
+ (reftex-window-height)))))
+ (setq truncate-lines t))
+ (if (and (pos-visible-in-window-p 1)
+ (pos-visible-in-window-p (point-max)))
+ nil
+ (setq prompt (concat prompt (if scroll " (SPC/DEL=Scroll)" ""))))
+ (message prompt)
+ (and (equal char ?\?) (setq char (read-char-exclusive)))
+ (while t
+ (cond ((equal char ?\C-g) (keyboard-quit))
+ ((equal char ?\?))
+ ((and scroll (equal char ?\ ))
+ (condition-case nil (scroll-up) (error nil))
+ (message prompt))
+ ((and scroll (equal char ?\C-? ))
+ (condition-case nil (scroll-down) (error nil))
+ (message prompt))
+ (t (message "")
+ (throw 'exit char)))
+ (setq char (read-char-exclusive)))))))
+
- (save-excursion
- ;; Find the correct format
- (if (and (listp reftex-cite-format1)
- (listp (car reftex-cite-format1)))
- (if (integerp (car (car reftex-cite-format1)))
- (if (assoc key reftex-cite-format1)
- (setq format (cdr (assoc key reftex-cite-format1)))
- (if (or (equal key ?\C-m)
- (equal key 'return))
- (setq format (cdr (car reftex-cite-format1)))
- (error "Error in reftex-cite-format")))
- (error "Error in reftex-cite-format"))
- (setq format reftex-cite-format1))
-
- (if (listp format)
- (let ((nn (min nauthors (1- (length format)))))
- (while (and (> nn 0) (string= "" (nth nn format)))
- (setq nn (1- nn)))
- (setq format (nth nn format))))
- (if (stringp format)
- (setq format format)
- (setq format "\\cite{KEY}"))
-
- ;; Insert the author names
- (while (string-match "\\bAUTHOR\\b" format)
- (setq format (replace-match (car auth-list) t t format))
- (setq auth-list (cdr auth-list)))
- (while (string-match "\\bKEY\\b" format)
- (setq format (replace-match cite-key t t format)))
- (while (string-match "\\bYEAR\\b" format)
- (setq format (replace-match year t t format)))
- format)))
-
-;; this is slow and not recommended for follow mode
-(defun reftex-bibtex-selection-callback (cnt)
- ;; Callback function to be called from the BibTeX selection, in
- ;; order to display context. This function is relatively slow and not
- ;; recommended for follow mode, just for individual lookups.
- ;; When compiled, this gives a warning about found-list. However,
- ;; the calling function binds found-list with let.
- (let ((win (selected-window))
- (key (reftex-get-bib-field "&key" (nth cnt found-list)))
- (bibfile-list (save-excursion
- (set-buffer reftex-call-back-to-this-buffer)
- (reftex-get-bibfile-list))))
- (reftex-pop-to-bibtex-entry key bibfile-list
- (not reftex-keep-temporary-buffers) t)
- (select-window win)))
-
-;;; ===========================================================================
-;;;
-;;; Here is the routine used for selection
+(defun reftex-make-regexp-allow-for-ctrl-m (string)
+ ;; convert STRING into a regexp, allowing ^M for \n and vice versa
+ (let ((start -2))
+ (setq string (regexp-quote string))
+ (while (setq start (string-match "[\n\r]" string (+ 3 start)))
+ (setq string (replace-match "[\n\r]" nil t string)))
+ string))
-;; Marker for return point from recursive edit
-(defvar reftex-recursive-edit-marker (make-marker))
+(defun reftex-get-buffer-visiting (file)
+ ;; return a buffer visiting FILE
+ (cond
+ ((boundp 'find-file-compare-truenames) ; XEmacs
+ (let ((find-file-compare-truenames t))
+ (get-file-buffer file)))
+ ((fboundp 'find-buffer-visiting) ; Emacs
+ (find-buffer-visiting file))
+ (t (error "This should not happen (reftex-get-buffer-visiting)"))))
-(defun reftex-check-recursive-edit ()
- ;; Check if we are already in a recursive edit. Abort with helpful
- ;; message if so.
- (if (marker-position reftex-recursive-edit-marker)
- (error
- (substitute-command-keys
- "In unfinished recursive edit. Finish (\\[exit-recursive-edit]) or abort (\\[abort-recursive-edit])."))))
-
-(defun reftex-select-item (buffer prompt next-re end-re size help-string
- event-list &optional offset
- call-back cb-flag)
-;; Select an item from the buffer BUFFER. Show PROMPT to user, find
-;; next item with NEXT-RE regular expression, return on any of the
-;; events listed in EVENT-LIST. The function returns the event along
-;; with an integer indicating which item was selected. When OFFSET is
-;; specified, starts at that item in the list. When CALL-BACK is
-;; given, it is a function which is called with the match of the
-;; NEXT-RE match and the index of the element.
- (let* (key key-sq b e ev cnt cmd
- (offset1 (or offset 1)))
- (setq ev
- (catch 'exit
- (save-window-excursion
- (if buffer
- (switch-to-buffer-other-window buffer))
- (if (= 0 (buffer-size))
- (throw 'exit nil))
- (setq truncate-lines t)
- (goto-char 1)
- (if (not (re-search-forward next-re nil t offset1))
- (progn ; in case the offset is illegal
- (setq offset1 1)
- (if (not (re-search-forward next-re nil t offset1))
- (throw 'exit nil))))
- (beginning-of-line 1)
- (setq cnt (if offset1 (1- offset1) 0))
- (while t
- (if (and cb-flag call-back)
- (funcall call-back cnt))
- (setq b (point)
- e (save-excursion
- (save-match-data
- (re-search-forward end-re nil 1))
- (point)))
- (reftex-highlight 1 b e)
- (if (or (not (pos-visible-in-window-p b))
- (not (pos-visible-in-window-p e)))
- (recenter (/ (window-height) 2)))
- (setq key-sq (read-key-sequence prompt))
- (setq key (car
- (cond
- ((fboundp 'listify-key-sequence) ; Emacs
- (listify-key-sequence key-sq))
- ((fboundp 'event-to-character) ; XEmacs
- (mapcar 'event-to-character key-sq))
- (t (error "Please report this problem to dominik@strw.leidenuniv.nl")))))
-
- (setq cmd (key-binding key-sq))
-
- (reftex-unhighlight 0)
-
- (cond
-
- ((or (equal key ?n)
- (equal key ?\C-i)
- (equal cmd 'next-line))
- (if (re-search-forward next-re nil t 2)
- (setq cnt (1+ cnt)))
- (beginning-of-line 1))
-
- ((equal cmd 'scroll-up)
- (setq cnt (1- cnt))
- (while (and (pos-visible-in-window-p)
- (re-search-forward next-re nil t))
- (setq cnt (1+ cnt)))
- (beginning-of-line 1)
- (recenter 1))
-
- ((or (equal key ?p)
- (equal cmd 'previous-line))
- (if (re-search-backward next-re nil t)
- (setq cnt (1- cnt))))
-
- ((equal cmd 'scroll-down)
- (while (and (pos-visible-in-window-p)
- (re-search-backward next-re nil t))
- (setq cnt (1- cnt)))
- (recenter (- (window-height) size 2)))
-
- ((equal key ?q)
- (throw 'exit nil))
-
- ((equal key ?\C-g)
- (bury-buffer)
- (error "Abort"))
-
- ((or (equal key ?\C-m)
- (equal key 'return)
- (equal cmd 'newline))
- (throw 'exit 'return))
-
- ((or (equal key ?C) ; backward compatibility
- (equal key ?f))
- (setq cb-flag (not cb-flag)))
-
- ((equal key ?\ )
- (funcall call-back cnt))
-
- ((equal key ?\?)
- (save-window-excursion
- (with-output-to-temp-buffer "*RefTeX Help*"
- (princ help-string))
- (setq unread-command-events
- (cons
- (cond
- ((fboundp 'read-event) ; Emacs
- (read-event))
- ((fboundp 'next-command-event) ; XEmacs
- (next-command-event))
- (t (error "Please report this problem to dominik@strw.leidenuniv.nl")))
- nil)))
- (kill-buffer "*RefTeX Help*"))
-
- ((equal key ?\C-r)
- ;; sje - code copied from ispell.el for
- ;; performing recursive edit
- (set-marker reftex-recursive-edit-marker (point))
- (unwind-protect
- (progn
- (save-window-excursion
- (save-excursion
- (other-window 1)
- (message
- (substitute-command-keys
- "Recursive edit. Return to selection with \\[exit-recursive-edit]"))
- (recursive-edit)))
- (if (not (equal (marker-buffer
- reftex-recursive-edit-marker)
- (current-buffer)))
- (error
- "Cannot continue RefTeX from this buffer."))
- (goto-char reftex-recursive-edit-marker))
- (set-marker reftex-recursive-edit-marker nil)))
-
- ((member key event-list)
- (throw 'exit key))
- (t
- (ding)))))))
- (message "")
- (cons ev cnt)))
-
-;;; ===========================================================================
-;;;
-;;; View cross references
+;; Define `current-message' for compatibility with XEmacs prior to 20.4
+(defvar message-stack)
+(if (and (featurep 'xemacs)
+ (not (fboundp 'current-message)))
+ (defun current-message (&optional frame)
+ (cdr (car message-stack))))
-(defun reftex-view-crossref (&optional arg)
- "View cross reference of \\ref{} or \\cite{} macro at point.
-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.
-When you call this function several times in direct successtion, point will
-move to view subsequent cross references further down in the buffer.
-With argument, actually select the window showing the cross reference."
+(defun reftex-visited-files (list)
+ ;; Takes a list of filenames and returns the buffers of those already visited
+ (delq nil (mapcar (lambda (x) (if (reftex-get-buffer-visiting x) x nil))
+ list)))
- (interactive "P")
+(defun reftex-get-file-buffer-force (file &optional mark-to-kill)
+ ;; Return a buffer visiting file. Make one, if necessary.
+ ;; If neither such a buffer nor the file exist, return nil.
+ ;; If MARK-TO-KILL is t and there is no live buffer, visit the file with
+ ;; initializations according to `reftex-initialize-temporary-buffers',
+ ;; and mark the buffer to be killed after use.
- ;; See where we are.
- (let* ((pos (point))
- (re "\\\\[a-z]*\\(cite\\|ref\\)\\(\\[[^{}]*\\]\\)?{\\([^}]+\\)}")
- (my-window (get-buffer-window (current-buffer)))
- pop-window cmd args macro label entry key-start point)
-
- (if (save-excursion
- (forward-char 1)
- (and (search-backward "\\" nil t)
- (looking-at re)
- (< pos (match-end 0))))
- (setq macro (match-string 1)
- key-start (match-beginning 3)))
-
- (if (and macro (eq last-command this-command))
- (if (and (string= macro "cite")
- (skip-chars-forward "^}, \t\n\r")
- (= (following-char) ?,))
- (setq key-start (1+ (point)))
- (setq macro nil)))
-
- (if (not macro)
- (if (re-search-forward re nil t)
- (setq macro (match-string 1)
- key-start (match-beginning 3))
- (error "No further cross references in buffer")))
-
- (goto-char key-start)
-
- ;; Ensure access to scanning info
- (reftex-access-scan-info)
-
- (cond
- ((string= macro "cite")
- (setq cmd 'reftex-pop-to-bibtex-entry
- args (list
- (reftex-no-props (reftex-this-word "^{},"))
- (reftex-get-bibfile-list) nil t)))
- ((string= macro "ref")
- (let ((label (reftex-no-props (reftex-this-word "^{}")))
- (entry (assoc label (symbol-value reftex-list-of-labels-symbol))))
- (if entry
- (setq cmd 'reftex-pop-to-label
- args (list label (list (nth 3 entry)) nil t))
- (error "Label %s not known - reparse document might help" label))))
- (t (error "This should not happen")))
- (setq point (point))
- (apply cmd args)
- (setq pop-window (selected-window))
- (add-hook 'pre-command-hook 'reftex-highlight-shall-die)
- (select-window my-window)
- (goto-char point)
- (and arg (select-window pop-window))))
-
-(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.
-When you call this function several times in direct successtion, point will
-move to view subsequent cross references further down in the buffer.
-With argument, actually select the window showing the cross reference."
- (interactive "e")
- (mouse-set-point ev)
- (reftex-view-crossref current-prefix-arg))
-
-;;; ===========================================================================
-;;;
-;;; Functions that check out the surroundings
+ (let ((buf (reftex-get-buffer-visiting file)))
-(defun reftex-what-macro (which &optional bound)
- ;; Find out if point is within the arguments of any TeX-macro.
- ;; The return value is either (\"\\\\macro\" . (point)) or a list of them.
+ (cond (buf
+ ;; We have it already as a buffer - just return it
+ buf)
- ;; If WHICH is nil, immediately return nil.
- ;; If WHICH is t, return list of all macros enclosing point.
- ;; If WHICH is a list of macros, look only for those macros and return the
- ;; name of the first macro in this list found to enclose point.
- ;; If the optional BOUND is an integer, bound backwards directed
- ;; searches to this point. If it is nil, limit to nearest \\section -
- ;; like statement.
+ ((file-readable-p file)
+ ;; At least there is such a file and we can read it.
- ;; This function is pretty stable, but can be fooled if the text contains
- ;; things like \\macro{aa}{bb} where \\macro is defined to take only one
- ;; argument. As RefTeX cannot know this, the string \"bb\" would still be
- ;; considered an argument of macro \\macro.
+ (if (or (not mark-to-kill)
+ (eq t reftex-initialize-temporary-buffers))
- (catch 'exit
- (if (null which) (throw 'exit nil))
- (let ((bound (or bound (save-excursion (re-search-backward
- reftex-section-regexp nil 1)
- (point))))
- pos cmd-list cmd)
- (save-restriction
- (save-excursion
- (narrow-to-region (max 1 bound) (point-max))
- ;; move back out of the current parenthesis
- (while (condition-case nil
- (progn (up-list -1) t)
- (error nil))
- ;; move back over any touching sexps
- (while (or (= (preceding-char) ?\])
- (= (preceding-char) ?\}))
- (backward-sexp))
- (setq pos (point))
- (if (and (or (= (following-char) ?\[)
- (= (following-char) ?\{))
- (and (re-search-backward "\\(\\\\[a-zA-Z]+\\)" nil t)
- (= (match-end 0) pos)))
- (progn
- (setq cmd (buffer-substring-no-properties
- (match-beginning 0) (match-end 0)))
- (if (eq t which)
- (setq cmd-list (cons (cons cmd (point)) cmd-list))
- (if (member cmd which)
- (throw 'exit (cons cmd (point)))))))
- (goto-char pos)))
- (nreverse cmd-list)))))
-
-(defun reftex-what-environment (which &optional bound)
- ;; Find out if point is inside a LaTeX environment.
- ;; The return value is (e.g.) either (\"equation\" . (point)) or a list of
- ;; them.
-
- ;; If WHICH is nil, immediately return nil.
- ;; If WHICH is t, return list of all environments enclosing point.
- ;; If WHICH is a list of environments, look only for those environments and
- ;; return the name of the first environment in this list found to enclose
- ;; point.
-
- ;; If the optional BOUND is an integer, bound backwards directed searches to
- ;; this point. If it is nil, limit to nearest \\section - like statement.
+ ;; Visit the file with full magic
+ (setq buf (find-file-noselect file))
- (catch 'exit
- (save-excursion
- (if (null which) (throw 'exit nil))
- (let ((bound (or bound (save-excursion (re-search-backward
- reftex-section-regexp nil 1)
- (point))))
- env-list end-list env)
- (while (re-search-backward "\\\\\\(begin\\|end\\){\\([^}]+\\)}"
- bound t)
- (setq env (buffer-substring-no-properties
- (match-beginning 2) (match-end 2)))
- (cond
- ((string= (match-string 1) "end")
- (add-to-list 'end-list env))
- ((member env end-list)
- (setq end-list (delete env end-list)))
- ((eq t which)
- (setq env-list (cons (cons env (point)) env-list)))
- ((member env which)
- (throw 'exit (cons env (point))))))
- (nreverse env-list)))))
-
-(defun reftex-word-before-point ()
- ;; Return the word before point. Word means here:
- ;; Consists of [a-zA-Z0-9.:] and ends at point or whitespace.
- (let ((pos (point)))
- (save-excursion
- (re-search-backward "[^ \t\n\r]" (point-min) 1)
- (setq pos (1+ (point)))
- (if (re-search-backward "[^a-zA-Z0-9\\\.:]" (point-min) 1)
- (forward-char 1))
- (buffer-substring-no-properties (point) pos))))
+ ;; Else: Visit the file just briefly, without or
+ ;; with limited Magic
-;; ============================================================================
-;;
-;; Some generally useful functions
+ ;; The magic goes away
+ (let ((format-alist nil)
+ (auto-mode-alist (reftex-auto-mode-alist))
+ (default-major-mode 'fundamental-mode)
+ (enable-local-variables nil)
+ (after-insert-file-functions nil))
+ (setq buf (find-file-noselect file)))
-(defun reftex-no-props (string)
- ;; Return STRING with all text properties removed
- (and (stringp string)
- (set-text-properties 0 (length string) nil string))
- string)
+ ;; Is there a hook to run?
+ (when (listp reftex-initialize-temporary-buffers)
+ (save-excursion
+ (set-buffer buf)
+ (run-hooks 'reftex-initialize-temporary-buffers))))
-(defun reftex-split (regexp string)
- ;; Split like perl
- (let ((start 0) list)
- (while (string-match regexp string start)
- (setq list (cons (substring string start (match-beginning 0)) list))
- (setq start (match-end 0)))
- (setq list (nreverse (cons (substring string start) list)))))
+ ;; Lets see if we got a license to kill :-|
+ (and mark-to-kill
+ (add-to-list 'reftex-buffers-to-kill buf))
-(defun reftex-allow-for-ctrl-m (string)
- ;; convert STRING into a regexp, allowing ^M for \n
- (let ((start -2))
- (setq string (regexp-quote string))
- (while (setq start (string-match "[\n\r]" string (+ 3 start)))
- (setq string (replace-match "[\n\r]" nil t string)))
- string))
+ ;; Return the new buffer
+ buf)
-(defun reftex-delete-list (elt-list list)
- ;; like delete, but with a list of things to delete
- ;; (original code from Rory Molinari)
- (while elt-list
- (setq list (delete (car elt-list) list)
- elt-list (cdr elt-list)))
- list)
+ ;; If no such file exists, return nil
+ (t nil))))
-(defun reftex-get-buffer-visiting (file)
- ;; return a buffer visiting FILE
+(defun reftex-kill-temporary-buffers (&optional buffer)
+ ;; Kill all buffers in the list reftex-kill-temporary-buffers.
(cond
- ((fboundp 'find-buffer-visiting) ; Emacs
- (find-buffer-visiting file))
- ((boundp 'find-file-compare-truenames) ; XEmacs
- (let ((find-file-compare-truenames t))
- (get-file-buffer file)))
- (t (error "Please report this problem to dominik@strw.leidenuniv.nl"))))
-
-(defun reftex-get-file-buffer-force (file &optional mark-to-kill)
- ;; Return a buffer visiting file. Make one, if necessary.
- ;; If neither such a buffer no the file exist, return nil.
- ;; If MARK-TO-KILL in non-nil, put any new buffers into the kill list."
-
- (let ((buf (reftex-get-buffer-visiting file)))
- (cond
- (buf buf)
- ((file-exists-p file)
- (setq buf (find-file-noselect file))
- (if mark-to-kill
- (add-to-list 'reftex-buffers-to-kill buf))
- buf)
- (t nil))))
+ (buffer
+ (when (member buffer reftex-buffers-to-kill)
+ (kill-buffer buffer)
+ (setq reftex-buffers-to-kill
+ (delete buffer reftex-buffers-to-kill))))
+ (t
+ (while (setq buffer (pop reftex-buffers-to-kill))
+ (when (bufferp buffer)
+ (and (buffer-modified-p buffer)
+ (y-or-n-p (format "Save file %s? "
+ (buffer-file-name buffer)))
+ (save-excursion
+ (set-buffer buffer)
+ (save-buffer)))
+ (kill-buffer buffer))
+ (pop reftex-buffers-to-kill)))))
(defun reftex-splice-symbols-into-list (list alist)
;; Splice the association in ALIST of any symbols in LIST into the list.
;; Return new list.
(let (rtn tmp)
(while list
- (while (and (not (null (car list)))
- (symbolp (car list)))
+ (while (and (not (null (car list))) ;; keep list elements nil
+ (symbolp (car list)))
(setq tmp (car list))
(cond
((assoc tmp alist)
- (setq list (append (cdr (cdr (assoc tmp alist))) (cdr list))))
+ (setq list (append (nth 2 (assoc tmp alist)) (cdr list))))
(t
(error "Cannot treat symbol %s in reftex-label-alist"
(symbol-name tmp)))))
- (setq rtn (cons (car list) rtn)
- list (cdr list)))
+ (push (pop list) rtn))
(nreverse rtn)))
-(defun reftex-uniquify (alist &optional keep-list)
- ;; Return a list of all elements in ALIST, but each car only once
- ;; Elements of KEEP-LIST are not removed even if duplicate
+(defun reftex-remove-symbols-from-list (list)
+ ;; Remove all symbols from list
+ (let (rtn)
+ (while list
+ (unless (symbolp (car list))
+ (push (car list) rtn))
+ (setq list (cdr list)))
+ (nreverse rtn)))
+
+(defun reftex-uniquify (list)
+ ;; Return a list of all elements in LIST, but each only once
+ (let (new elm)
+ (while list
+ (setq elm (pop list))
+ (unless (member elm new)
+ (push elm new)))
+ (nreverse new)))
+
+(defun reftex-uniquify-by-car (alist &optional keep-list)
+ ;; Return a list of all elements in ALIST, but each car only once.
+ ;; Elements of KEEP-LIST are not removed even if duplicate.
(let (new elm)
(while alist
- (setq elm (car alist)
- alist (cdr alist))
+ (setq elm (pop alist))
(if (or (member (car elm) keep-list)
- (not (assoc (car elm) new)))
- (setq new (cons elm new))))
- (setq new (nreverse new))
- new))
+ (not (assoc (car elm) new)))
+ (push elm new)))
+ (nreverse new)))
+
+(defun reftex-abbreviate-title (string)
+ (reftex-convert-string string "[-~ \t\n\r,;]" nil t t
+ 5 40 nil 1 " " (nth 5 reftex-derive-label-parameters)))
+
+(defun reftex-convert-string (string split-re illegal-re dot keep-fp
+ nwords maxchar illegal abbrev sep
+ ignore-words &optional downcase)
+ "Convert a string (a sentence) to something shorter.
+SPLIT-RE is the regular expression used to split the string into words.
+ILLEGAL-RE matches characters which are illegal in the final string.
+DOT t means add dots to abbreviated words.
+KEEP-FP t means to keep a final punctuation when applicable.
+NWORDS Number of words to use.
+MAXCHAR Maximum number of characters in the final string.
+ILLEGAL nil: Throw away any words containing stuff matched with ILLEGAL-RE.
+ t: Throw away only the matched part, not the whole word.
+ABBREV nil: Never abbreviate words.
+ t: Always abbreviate words (see `reftex-abbrev-parameters').
+ not t and not nil: Abbreviate words if necessary to shorten
+ string below MAXCHAR.
+SEP String separating different words in the output string.
+IGNORE-WORDS List of words which should be removed from the string."
+
+ (let* ((words0 (split-string string (or split-re "[ \t\n\r]")))
+ (reftex-label-illegal-re (or illegal-re "\000"))
+ (abbrev-re (concat
+ "\\`\\("
+ (make-string (nth 0 reftex-abbrev-parameters) ?.)
+ "[" (nth 2 reftex-abbrev-parameters) "]*"
+ "\\)"
+ "[" (nth 3 reftex-abbrev-parameters) "]"
+ (make-string (1- (nth 1 reftex-abbrev-parameters)) ?.)))
+ words word)
+
+ ;; Remove words from the ignore list or with funny characters
+ (while (setq word (pop words0))
+ (if downcase (setq word (downcase word)))
+ (cond
+ ((member (downcase word) ignore-words))
+ ((string-match reftex-label-illegal-re word)
+ (when illegal
+ (while (string-match reftex-label-illegal-re word)
+ (setq word (replace-match "" nil nil word)))
+ (push word words)))
+ (t
+ (push word words))))
+ (setq words (nreverse words))
+
+ ;; Restrict number of words
+ (if (> (length words) nwords)
+ (setcdr (nthcdr (1- nwords) words) nil))
+
+ ;; First, try to use all words
+ (setq string (mapconcat 'identity words sep))
+
+ ;; Abbreviate words if enforced by user settings or string length
+ (if (or (eq t abbrev)
+ (and abbrev
+ (> (length string) maxchar)))
+ (setq words
+ (mapcar
+ (lambda (w) (if (string-match abbrev-re w)
+ (if dot
+ (concat (match-string 1 w) ".")
+ (match-string 1 w))
+ w))
+ words)
+ string (mapconcat 'identity words sep)))
+
+ ;; Shorten if still to long
+ (setq string
+ (if (> (length string) maxchar)
+ (substring string 0 maxchar)
+ string))
+
+ ;; Delete the final punctuation, if any
+ (if (and (not keep-fp) (string-match "\\s.+\\'" string))
+ (setq string (replace-match "" nil nil string)))
+ string))
+
+(defun reftex-nicify-text (text)
+ ;; Make TEXT nice for inclusion as context into label menu.
+ ;; 1. remove line breaks and extra white space
+ (while (string-match "[\n\r\t]\\|[ \t][ \t]+" text)
+ (setq text (replace-match " " nil t text)))
+ ;; 2. cut before the next `\end{' or `\item' or `\\'
+ (if (string-match "\\(\\\\end{\\|\\\\item\\|\\\\\\\\\\).*" text)
+ (setq text (replace-match "" nil t text)))
+ ;; 3. kill the embedded label
+ (if (string-match "\\\\label{[^}]*}" text)
+ (setq text (replace-match "" nil t text)))
+ ;; 4. remove leading garbage
+ (if (string-match "\\`[ }]+" text)
+ (setq text (replace-match "" nil t text)))
+ ;; 5. limit length
+ (cond
+ ((> (length text) 100) (substring text 0 100))
+ ((= (length text) 0) (make-string 1 ?\ ))
+ (t text)))
+
+;;; =========================================================================
+;;;
+;;; Fontification and Highlighting
(defun reftex-use-fonts ()
- ;; Return t if we can and want to use fonts
+ ;; Return t if we can and want to use fonts.
(and window-system
reftex-use-fonts
- (boundp 'font-lock-keyword-face)))
+ (featurep 'font-lock)))
+
+(defun reftex-refontify ()
+ ;; Return t if we need to refontify context
+ (and (reftex-use-fonts)
+ (or (eq t reftex-refontify-context)
+ (and (eq 1 reftex-refontify-context)
+ ;; Test of we use the font-lock version of x-symbol
+ (and (featurep 'x-symbol-tex) (not (boundp 'x-symbol-mode)))))))
+
+(defvar font-lock-defaults-computed)
+(defun reftex-fontify-select-label-buffer (parent-buffer)
+ ;; Fontify the `*RefTeX Select*' buffer. Buffer is temporarily renamed to
+ ;; start with none-SPC char, beacuse Font-Lock otherwise refuses operation.
+ (run-hook-with-args 'reftex-pre-refontification-functions
+ parent-buffer 'reftex-ref)
+ (let* ((oldname (buffer-name))
+ (newname (concat "Fontify-me-" oldname)))
+ (unwind-protect
+ (progn
+ ;; Rename buffer temporarily to start w/o space (because of font-lock)
+ (rename-buffer newname t)
+ (cond
+ ((fboundp 'font-lock-default-fontify-region)
+ ;; Good: we have the indirection functions
+ (set (make-local-variable 'font-lock-fontify-region-function)
+ 'reftex-select-font-lock-fontify-region)
+ (let ((major-mode 'latex-mode))
+ (font-lock-mode 1)))
+ ((fboundp 'font-lock-set-defaults-1)
+ ;; Looks like the XEmacs font-lock stuff.
+ ;; FIXME: this is still kind of a hack, but it works.
+ (set (make-local-variable 'font-lock-keywords) nil)
+ (let ((major-mode 'latex-mode)
+ (font-lock-defaults-computed nil))
+ (font-lock-set-defaults-1)
+ (reftex-select-font-lock-fontify-region (point-min) (point-max))))
+ (t
+ ;; Oops?
+ (message "Sorry: cannot refontify RefTeX Select buffer."))))
+ (rename-buffer oldname))))
+
+(defun reftex-select-font-lock-fontify-region (beg end &optional loudly)
+ ;; Fontify a region, but only lines starting with a dot.
+ (let ((func (if (fboundp 'font-lock-default-fontify-region)
+ 'font-lock-default-fontify-region
+ 'font-lock-fontify-region))
+ beg1 end1)
+ (goto-char beg)
+ (while (re-search-forward "^\\." end t)
+ (setq beg1 (point) end1 (progn (skip-chars-forward "^\n") (point)))
+ (funcall func beg1 end1 nil)
+ (goto-char end1))))
+
+(defun reftex-select-font-lock-unfontify (&rest ignore) t)
+
+(defun reftex-verified-face (&rest faces)
+ ;; Return the first valid face in FACES, or nil if none is valid.
+ ;; Also, when finding a nil element in FACES, return nil. This
+ ;; function is just a safety net to catch name changes of builtin
+ ;; fonts. Currently it is only used for reftex-label-face, which has
+ ;; as default font-lock-reference-face, which was recently renamed
+ ;; to font-lock-constant-face.
+ (let (face)
+ (catch 'exit
+ (while (setq face (pop faces))
+ (if (featurep 'xemacs)
+ (if (find-face face) (throw 'exit face))
+ (if (facep face) (throw 'exit face)))))))
-;; Highlighting uses overlays. If this is for XEmacs, we need to load
-;; the overlay library, available in version 19.15
-(and (not (fboundp 'make-overlay))
- (condition-case nil
- (require 'overlay)
- ('error
- (error "RefTeX needs overlay emulation (available in XEmacs 19.15)"))))
+;; Highlighting uses overlays. For XEmacs, we need the emulation.
+(if (featurep 'xemacs) (require 'overlay))
;; We keep a vector with several different overlays to do our highlighting.
(defvar reftex-highlight-overlays [nil nil])
;; Initialize the overlays
(aset reftex-highlight-overlays 0 (make-overlay 1 1))
-(overlay-put (aref reftex-highlight-overlays 0) 'face 'highlight)
+(overlay-put (aref reftex-highlight-overlays 0)
+ 'face 'highlight)
(aset reftex-highlight-overlays 1 (make-overlay 1 1))
-(overlay-put (aref reftex-highlight-overlays 1) 'face 'highlight)
+(overlay-put (aref reftex-highlight-overlays 1)
+ 'face reftex-cursor-selected-face)
;; Two functions for activating and deactivation highlight overlays
(defun reftex-highlight (index begin end &optional buffer)
(move-overlay (aref reftex-highlight-overlays index)
begin end (or buffer (current-buffer))))
(defun reftex-unhighlight (index)
- "Detatch overlay INDEX."
+ "Detach overlay INDEX."
(delete-overlay (aref reftex-highlight-overlays index)))
(defun reftex-highlight-shall-die ()
- ;; Function used in pre-command-hook to remove highlights
+ ;; Function used in pre-command-hook to remove highlights.
(remove-hook 'pre-command-hook 'reftex-highlight-shall-die)
(reftex-unhighlight 0))
-;;; ---------------------------------------------------------------------------
-;;;
-;;; Cursor position after insertion of forms
-
-(defun reftex-position-cursor ()
- ;; Search back to question mark, delete it, leave point there
- (if (search-backward "\?" (- (point) 100) t)
- (delete-char 1)))
-
-(defun reftex-item ()
- "Insert an \\item and provide a label if the environments supports that."
- (interactive)
- (let ((env (car
- (reftex-what-environment '("itemize" "enumerate" "eqnarray")))))
-
- (if (and env (not (bolp))) (newline))
-
- (cond
-
- ((string= env "eqnarray")
- (if (not (bolp))
- (newline))
- (reftex-label env)
- (insert "\n & & ")
- (beginning-of-line 1))
-
- ((string= env "itemize")
- (newline)
- (insert "\\item "))
-
- ((string= env "enumerate")
- (newline)
- (insert "\\item")
- (reftex-label env)
- (insert " "))
- (t
- (error "\\item command does not make sense here...")))))
-
-;;; ---------------------------------------------------------------------------
-;;; ---------------------------------------------------------------------------
-;;; ---------------------------------------------------------------------------
+;;; =========================================================================
;;;
-;;; Data Section: Definition of large constants
-
-
-(defconst reftex-label-alist-builtin
- '(
- (LaTeX
- "LaTeX default environments"
- ("section" ?s "sec:" "~\\ref{%s}" t
- ("Part" "Chapter" "Chap." "Section" "Sec." "Sect." "Paragraph" "Par."
- "\\S" "Teil" "Kapitel" "Kap." "Abschnitt" ))
-
- ("enumerate" ?n "item:" "~\\ref{%s}" "\\\\item\\(\\[[^]]*\\]\\)?"
- ("Item" "Punkt"))
-
- ("equation" ?e "eq:" "~(\\ref{%s})" t
- ("Equation" "Eq." "Eqn." "Gleichung" "Gl."))
- ("eqnarray" ?e "eq:" nil "\\\\begin{eqnarray}\\|\\\\\\\\")
-
- ("figure" ?f "fig:" "~\\ref{%s}" "\\\\caption\\(\\[[^]]*\\]\\)?{"
- ("Figure" "Fig." "Abbildung" "Abb."))
- ("figure*" ?f nil nil "\\\\caption\\(\\[[^]]*\\]\\)?{")
-
- ("table" ?t "tab:" "~\\ref{%s}" "\\\\caption\\(\\[[^]]*\\]\\)?{"
- ("Table" "Tab." "Tabelle"))
- ("table*" ?t nil nil "\\\\caption\\(\\[[^]]*\\]\\)?{")
-
- ("any" ?\ " " "\\ref{%s}" nil))
-
- (Sideways
- "Sidewaysfigure and sidewaystable"
- ("sidewaysfigure" ?f nil nil "\\\\caption\\(\\[[^]]*\\]\\)?{")
- ("sidewaystable" ?t nil nil "\\\\caption\\(\\[[^]]*\\]\\)?{"))
-
- (AMSTeX
- "AMS-LaTeX: amsmath package environents"
- ("align" ?e "eq:" "~\\eqref{%s}" "\\\\begin{align}\\|\\\\\\\\")
- ("gather" ?e "eq:" nil "\\\\begin{gather}\\|\\\\\\\\")
- ("multline" ?e "eq:" nil t)
- ("flalign" ?e "eq:" nil "\\\\begin{flalign}\\|\\\\\\\\")
- ("alignat" ?e "eq:" nil "\\\\begin{alignat}{[0-9]*}\\|\\\\\\\\"))
-
- (AASTeX
- "AAS deluxetable environment"
- ("deluxetable" ?t "tab:" nil "\\\\caption{")))
- "The default label environment descriptions.")
+;;; Keybindings
+
+;; The default bindings in the mode map.
+(loop for x in
+ '(("\C-c=" . reftex-toc)
+ ("\C-c(" . reftex-label)
+ ("\C-c)" . reftex-reference)
+ ("\C-c[" . reftex-citation)
+ ("\C-c<" . reftex-index)
+ ("\C-c>" . reftex-display-index)
+ ("\C-c/" . reftex-index-selection-or-word)
+ ("\C-c\\" . reftex-index-phrase-selection-or-word)
+ ("\C-c|" . reftex-index-visit-phrases-buffer)
+ ("\C-c&" . reftex-view-crossref))
+ do (define-key reftex-mode-map (car x) (cdr x)))
+
+;; Bind `reftex-mouse-view-crossref' only when the key is still free
+(if (featurep 'xemacs)
+ (unless (key-binding [(shift button2)])
+ (define-key reftex-mode-map [(shift button2)]
+ 'reftex-mouse-view-crossref))
+ (unless (key-binding [(shift mouse-2)])
+ (define-key reftex-mode-map [(shift mouse-2)]
+ 'reftex-mouse-view-crossref)))
+
+;; Bind `reftex-view-crossref-from-bibtex' in BibTeX mode map
+(eval-after-load
+ "bibtex"
+ '(define-key bibtex-mode-map "\C-c&" 'reftex-view-crossref-from-bibtex))
-;;; ---------------------------------------------------------------------------
+;; If the user requests so, she can have a few more bindings:
+(when reftex-extra-bindings
+ (loop for x in
+ '(("\C-ct" . reftex-toc)
+ ("\C-cl" . reftex-label)
+ ("\C-cr" . reftex-reference)
+ ("\C-cc" . reftex-citation)
+ ("\C-cv" . reftex-view-crossref)
+ ("\C-cg" . reftex-grep-document)
+ ("\C-cs" . reftex-search-document))
+ do (define-key reftex-mode-map (car x) (cdr x))))
+
+;;; =========================================================================
;;;
-;;; Functions to compile the tables, reset the mode etc.
-
-(defun reftex-reset-mode ()
- "Reset RefTeX Mode. Required to implement changes to some list variables.
-This function will compile the information in reftex-label-alist and similar
-variables. It is called when RefTeX is first used, and after changes to
-these variables via reftex-add-to-label-alist."
- (interactive)
-
- ; record that we have done this
- (setq reftex-tables-dirty nil)
+;;; Menu
- ;; To update buffer-local variables
- (hack-local-variables)
- (message "updating internal tables...")
- (reftex-compute-ref-cite-tables)
- (message "updating internal tables... done")
- (reftex-reset-scanning-information))
+;; Define a menu for the menu bar if Emacs is running under X
-(defun reftex-reset-scanning-information ()
- "Reset the symbols containing information from buffer scanning.
-This enforces rescanning the buffer on next use."
- (if (and (string= reftex-last-toc-master (reftex-TeX-master-file))
- (get-buffer "*toc*"))
- (kill-buffer "*toc*"))
- (let ((symlist reftex-multifile-symbols)
- symbol)
- (while symlist
- (setq symbol (car symlist)
- symlist (cdr symlist))
- (if (and (symbolp (symbol-value symbol))
- (not (null (symbol-value symbol))))
- (set (symbol-value symbol) nil)))))
+(require 'easymenu)
-(defun reftex-compute-ref-cite-tables ()
- ;; Update ref and cite tables
+(easy-menu-define reftex-mode-menu reftex-mode-map
+ "Menu used in RefTeX mode"
+ `("Ref"
+ ["Table of Contents" reftex-toc t]
+ "--"
+ ["\\label" reftex-label t]
+ ["\\ref" reftex-reference t]
+ ["\\cite" reftex-citation t]
+ ("\\index"
+ ["\\index" reftex-index t]
+ ["\\index{THIS}" reftex-index-selection-or-word t]
+ "--"
+ ["Add THIS to Index Phrases" reftex-index-phrase-selection-or-word t]
+ ["Visit Phrase Buffer" reftex-index-visit-phrases-buffer t]
+ ["Apply Phrases to Region" reftex-index-phrases-apply-to-region t]
+ "--"
+ ["Display the Index" reftex-display-index t])
+ "--"
+ ["View Crossref" reftex-view-crossref t]
+ "--"
+ ("Parse Document"
+ ["One File" reftex-parse-one reftex-enable-partial-scans]
+ ["Entire Document" reftex-parse-all t]
+ ["Save to File" (reftex-access-parse-file 'write)
+ (> (length (symbol-value reftex-docstruct-symbol)) 0)]
+ ["Restore from File" (reftex-access-parse-file 'restore) t]
+ "--"
+ ["Reset RefTeX Mode" reftex-reset-mode t])
+ ("Global Actions"
+ ["Search Whole Document" reftex-search-document t]
+ ["Replace in Document" reftex-query-replace-document t]
+ ["Grep on Document" reftex-grep-document t]
+ "--"
+ ["Find Duplicate Labels" reftex-find-duplicate-labels t]
+ ["Change Label and Refs" reftex-change-label t]
+ ["Renumber Simple Labels" reftex-renumber-simple-labels t]
+ "--"
+ ["Create TAGS File" reftex-create-tags-file t]
+ "--"
+ ["Save Document" reftex-save-all-document-buffers t])
+ "--"
+ ("Options"
+ "PARSER"
+ ["Partial Scans"
+ (setq reftex-enable-partial-scans (not reftex-enable-partial-scans))
+ :style toggle :selected reftex-enable-partial-scans]
+ ["Auto-Save Parse Info"
+ (setq reftex-save-parse-info (not reftex-save-parse-info))
+ :style toggle :selected reftex-save-parse-info]
+ "--"
+ "CROSSREF INFO"
+ ["Automatic Info" reftex-toggle-auto-view-crossref
+ :style toggle :selected reftex-auto-view-crossref-timer]
+ ["...in Echo Area" (setq reftex-auto-view-crossref t)
+ :style radio :selected (eq reftex-auto-view-crossref t)]
+ ["...in Other Window" (setq reftex-auto-view-crossref 'window)
+ :style radio :selected (eq reftex-auto-view-crossref 'window)]
+ "--"
+ "MISC"
+ ["AUC TeX Interface" reftex-toggle-plug-into-AUCTeX
+ :style toggle :selected reftex-plug-into-AUCTeX])
+ ("Reference Style"
+ ["Default" (setq reftex-vref-is-default nil
+ reftex-fref-is-default nil)
+ :style radio :selected (not (or reftex-vref-is-default
+ reftex-fref-is-default))]
+ ["Varioref" (setq reftex-vref-is-default t
+ reftex-fref-is-default nil)
+ :style radio :selected reftex-vref-is-default]
+ ["Fancyref" (setq reftex-fref-is-default t
+ reftex-vref-is-default nil)
+ :style radio :selected reftex-fref-is-default])
+ ("Citation Style"
+ ,@(mapcar
+ (lambda (x)
+ (vector
+ (capitalize (symbol-name (car x)))
+ (list 'reftex-set-cite-format (list 'quote (car x)))
+ :style 'radio :selected
+ (list 'eq (list 'reftex-get-cite-format) (list 'quote (car x)))))
+ reftex-cite-format-builtin)
+ "--"
+ "Sort Database Matches"
+ ["Not" (setq reftex-sort-bibtex-matches nil)
+ :style radio :selected (eq reftex-sort-bibtex-matches nil)]
+ ["by Author" (setq reftex-sort-bibtex-matches 'author)
+ :style radio :selected (eq reftex-sort-bibtex-matches 'author)]
+ ["by Year" (setq reftex-sort-bibtex-matches 'year)
+ :style radio :selected (eq reftex-sort-bibtex-matches 'year)]
+ ["by Year, reversed" (setq reftex-sort-bibtex-matches 'reverse-year)
+ :style radio :selected (eq reftex-sort-bibtex-matches 'reverse-year)])
+ ("Index Style"
+ ,@(mapcar
+ (lambda (x)
+ (vector
+ (capitalize (symbol-name (car x)))
+ (list 'reftex-add-index-macros (list 'list (list 'quote (car x))))
+ :style 'radio :selected
+ (list 'memq (list 'quote (car x))
+ (list 'get 'reftex-docstruct-symbol
+ (list 'quote 'reftex-index-macros-style)))))
+ reftex-index-macros-builtin))
+ "--"
+ ("Customize"
+ ["Browse RefTeX Group" reftex-customize t]
+ "--"
+ ["Build Full Customize Menu" reftex-create-customize-menu
+ (fboundp 'customize-menu-create)])
+ ("Documentation"
+ ["Info" reftex-info t]
+ ["Commentary" reftex-show-commentary t])))
+(defun reftex-customize ()
+ "Call the customize function with reftex as argument."
(interactive)
+ (customize-browse 'reftex))
- ;; Compile information in reftex-label-alist
- (let ((tmp (reftex-uniquify (reftex-splice-symbols-into-list
- (append
- reftex-label-alist
- reftex-label-alist-external-add-ons
- reftex-default-label-alist-entries)
- reftex-label-alist-builtin)
- '(nil)))
- entry env-or-mac typekeychar typekey prefix regexp
- fmt wordlist cmd qh-list)
-
- (setq reftex-words-to-typekey-alist nil
- reftex-typekey-list nil
- reftex-typekey-to-format-alist nil
- reftex-typekey-to-prefix-alist nil
- reftex-env-or-mac-alist nil
- reftex-label-env-list nil
- reftex-label-mac-list nil)
- (while tmp
- (catch 'next-entry
- (setq entry (car tmp)
- env-or-mac (car entry)
- entry (cdr entry)
- tmp (cdr tmp))
- (if (null env-or-mac)
- (setq env-or-mac ""))
- (if (stringp (car entry))
- ;; This is before version 2.00 - convert entry to new format
- ;; This is just to keep old users happy
- (setq entry (cons (string-to-char (car entry))
- (cons (concat (car entry) ":")
- (cdr entry)))))
- (setq typekeychar (nth 0 entry)
- typekey (char-to-string typekeychar)
- prefix (nth 1 entry)
- fmt (nth 2 entry)
- regexp (nth 3 entry)
- wordlist (nth 4 entry))
- (if (stringp wordlist)
- ;; This is before version 2.04 - convert to new format
- (setq wordlist (nthcdr 4 entry)))
- (if typekey
- (add-to-list 'reftex-typekey-list typekey))
- (if (and typekey prefix)
- (add-to-list 'reftex-typekey-to-prefix-alist (cons typekey prefix)))
- (cond
- ((string-match "\\`\\\\" env-or-mac)
- ;; It's a macro
- (add-to-list 'reftex-label-mac-list env-or-mac))
- (t
- (or (string= env-or-mac "any")
- (string= env-or-mac "")
- (add-to-list 'reftex-label-env-list env-or-mac))))
- (and fmt
- (not (assoc typekey reftex-typekey-to-format-alist))
- (setq reftex-typekey-to-format-alist
- (cons (cons typekey fmt)
- reftex-typekey-to-format-alist)))
- (and (not (string= env-or-mac "any"))
- (not (string= env-or-mac ""))
- (not (assoc env-or-mac reftex-env-or-mac-alist))
- (setq reftex-env-or-mac-alist
- (cons (list env-or-mac typekey regexp)
- reftex-env-or-mac-alist)))
- (while (and wordlist (stringp (car wordlist)))
- (or (assoc (car wordlist) reftex-words-to-typekey-alist)
- (setq reftex-words-to-typekey-alist
- (cons (cons (downcase (car wordlist)) typekey)
- reftex-words-to-typekey-alist)))
- (setq wordlist (cdr wordlist)))
- (cond
- ((string= "" env-or-mac) nil)
- ((assoc typekey qh-list)
- (setcdr (assoc typekey qh-list)
- (concat (cdr (assoc typekey qh-list)) " " env-or-mac)))
- (t
- (setq qh-list (cons (cons typekey env-or-mac) qh-list))))))
-
- (setq qh-list (nreverse qh-list))
- (setq reftex-typekey-to-prefix-alist
- (nreverse reftex-typekey-to-prefix-alist))
- (setq reftex-type-query-prompt
- (concat "Label type: "
- (mapconcat '(lambda(x)
- (format "[%s]" (car x)))
- qh-list " ")
- " (?=Help)"))
- (setq reftex-type-query-help
- (concat "SELECT A LABEL TYPE:\n--------------------\n"
- (mapconcat '(lambda(x)
- (format " [%s] %s"
- (car x) (cdr x)))
- qh-list "\n")))))
-
-;;; Keybindings --------------------------------------------------------------
-
-(define-key reftex-mode-map "\C-c-" 'reftex-item)
-(define-key reftex-mode-map "\C-c=" 'reftex-toc)
-(define-key reftex-mode-map "\C-c(" 'reftex-label)
-(define-key reftex-mode-map "\C-c)" 'reftex-reference)
-(define-key reftex-mode-map "\C-c[" 'reftex-citation)
-(define-key reftex-mode-map "\C-c&" 'reftex-view-crossref)
-
-;; If the user requests so, she can have a few more bindings:
-(cond
- (reftex-extra-bindings
- (define-key reftex-mode-map "\C-ct" 'reftex-toc)
- (define-key reftex-mode-map "\C-cl" 'reftex-label)
- (define-key reftex-mode-map "\C-cr" 'reftex-reference)
- (define-key reftex-mode-map "\C-cc" 'reftex-citation)
- (define-key reftex-mode-map "\C-cv" 'reftex-view-crossref)
- (define-key reftex-mode-map "\C-cg" 'reftex-grep-document)
- (define-key reftex-mode-map "\C-cs" 'reftex-search-document)))
-
-;;; Menus --------------------------------------------------------------------
+(defun reftex-create-customize-menu ()
+ "Create a full customization menu for RefTeX, insert it into the menu."
+ (interactive)
+ (if (fboundp 'customize-menu-create)
+ (progn
+ (easy-menu-change
+ '("Ref") "Customize"
+ `(["Browse RefTeX group" reftex-customize t]
+ "--"
+ ,(customize-menu-create 'reftex)
+ ["Set" Custom-set t]
+ ["Save" Custom-save t]
+ ["Reset to Current" Custom-reset-current t]
+ ["Reset to Saved" Custom-reset-saved t]
+ ["Reset to Standard Settings" Custom-reset-standard t]))
+ (message "\"Ref\"-menu now contains full customization menu"))
+ (error "Cannot expand menu (outdated version of cus-edit.el)")))
+
+(defun reftex-show-commentary ()
+ "Use the finder to view the file documentation from `reftex.el'."
+ (interactive)
+ (require 'finder)
+ (finder-commentary "reftex.el"))
-;; Define a menu for the menu bar if Emacs is running under X
+(defun reftex-info (&optional node)
+ "Read documentation for RefTeX in the info system.
+With optional NODE, go directly to that node."
+ (interactive)
+ (require 'info)
+ (Info-goto-node (format "(reftex)%s" (or node ""))))
-(require 'easymenu)
+;;; Install the kill-buffer and kill-emacs hooks ------------------------------
-(easy-menu-define
- reftex-mode-menu reftex-mode-map
- "Menu used in RefTeX mode"
- '("Ref"
- ["Table of Contents" reftex-toc t]
- "----"
- ["\\label{}" reftex-label t]
- ["\\ref{}" reftex-reference t]
- ["\\cite{}" reftex-citation t]
- ["View crossref" reftex-view-crossref t]
- "----"
- ("Search and Replace"
- ["Search whole document" reftex-search-document t]
- ["Replace in document" reftex-query-replace-document t]
- ["Grep on document" reftex-grep-document t]
- "----"
- ["Find duplicate labels" reftex-find-duplicate-labels t]
- ["Change label and refs" reftex-change-label t]
- "----"
- ["Create TAGS file" reftex-create-tags-file t])
- "----"
- ["Parse document" reftex-parse-document t]
- ["Reset RefTeX Mode" reftex-reset-mode t]
- ["Customize RefTeX" reftex-customize t]))
+(add-hook 'kill-buffer-hook 'reftex-kill-buffer-hook)
+(add-hook 'kill-emacs-hook 'reftex-kill-emacs-hook)
;;; Run Hook ------------------------------------------------------------------
;;; That's it! ----------------------------------------------------------------
-; Make sure tabels are compiled
-(message "updating internal tables...")
-(reftex-compute-ref-cite-tables)
-(setq reftex-tables-dirty nil)
-
-(provide 'reftex)
+(setq reftex-tables-dirty t) ; in case this file is evaluated by hand
+(provide 'reftex)
;;;============================================================================
-;;; reftex.el end here
+;;; reftex.el ends here