mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-27 07:37:33 +00:00
2527 lines
94 KiB
EmacsLisp
2527 lines
94 KiB
EmacsLisp
;;; 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>
|
||
;; Version: 4.16
|
||
;; Keywords: tex
|
||
|
||
;; This file is part of GNU Emacs.
|
||
|
||
;; GNU Emacs is free software; you can redistribute it and/or modify
|
||
;; it under the terms of the GNU General Public License as published by
|
||
;; the Free Software Foundation; either version 2, or (at your option)
|
||
;; any later version.
|
||
|
||
;; GNU Emacs is distributed in the hope that it will be useful,
|
||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
;; GNU General Public License for more details.
|
||
|
||
;; You should have received a copy of the GNU General Public License
|
||
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
||
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
||
;; Boston, MA 02111-1307, USA.
|
||
|
||
;;---------------------------------------------------------------------------
|
||
;;
|
||
;;; 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.
|
||
;;
|
||
;;
|
||
;; INSTALLATION
|
||
;; ------------
|
||
;;
|
||
;; - 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'.
|
||
;;
|
||
;; 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) ; AUCTeX LaTeX mode
|
||
;; (add-hook 'latex-mode-hook 'turn-on-reftex) ; Emacs latex mode
|
||
;;
|
||
;;
|
||
;; DOCUMENTATION
|
||
;; -------------
|
||
;;
|
||
;; See below for a short summary of how to use RefTeX.
|
||
;;
|
||
;; There is an extensive texinfo document describing RefTeX in detail.
|
||
;; One way to view this documentation is `M-x reftex-info RET'.
|
||
;;
|
||
;; The documentation in various formats is also available at
|
||
;;
|
||
;; http://www.strw.leidenuniv.nl/~dominik/Tools/
|
||
;;
|
||
;;---------------------------------------------------------------------------
|
||
;;
|
||
;; Introduction
|
||
;; ************
|
||
;;
|
||
;; 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.
|
||
;;
|
||
;; *Note Imprint::, for information about who to contact for help, bug
|
||
;; reports or suggestions.
|
||
;;
|
||
;; 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.
|
||
;;
|
||
;;---------------------------------------------------------------------------
|
||
;;
|
||
;; AUTHOR
|
||
;; ======
|
||
;;
|
||
;; Carsten Dominik <dominik@strw.LeidenUniv.nl>
|
||
;;
|
||
;; with contributions from Stephen Eglen
|
||
;;
|
||
;; 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/
|
||
;;
|
||
;; THANKS TO:
|
||
;; ---------
|
||
;; Thanks to the people on the Net who have used RefTeX and helped
|
||
;; developing it with their reports. In particular thanks to
|
||
;;
|
||
;; 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.
|
||
;;
|
||
;; 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).
|
||
;;
|
||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||
;;
|
||
;;;;;;
|
||
|
||
;;; Code:
|
||
|
||
(eval-when-compile (require 'cl))
|
||
|
||
;; Stuff that needs to be there when we use defcustom
|
||
(require 'custom)
|
||
|
||
(defvar reftex-tables-dirty t
|
||
"Flag showing if tables need to be re-computed.")
|
||
|
||
(eval-and-compile
|
||
(defun reftex-set-dirty (symbol value)
|
||
(setq reftex-tables-dirty t)
|
||
(set symbol value)))
|
||
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; Configuration variables
|
||
|
||
(require 'reftex-vars)
|
||
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; 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 mode is active.")
|
||
(make-variable-buffer-local 'reftex-mode)
|
||
|
||
(defvar reftex-mode-map (make-sparse-keymap)
|
||
"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 mode."
|
||
(reftex-mode t))
|
||
|
||
;;;###autoload
|
||
(defun reftex-mode (&optional arg)
|
||
"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.
|
||
|
||
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.
|
||
|
||
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
|
||
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 and other functions will also be available as `Ref' menu
|
||
on the menu bar.
|
||
|
||
------------------------------------------------------------------------------"
|
||
|
||
(interactive "P")
|
||
(setq reftex-mode (not (or (and (null arg) reftex-mode)
|
||
(<= (prefix-numeric-value arg) 0))))
|
||
|
||
(if reftex-mode
|
||
(progn
|
||
;; 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)))
|
||
|
||
(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))))
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; 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))
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; Multibuffer Variables
|
||
;;;
|
||
;;; 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
|
||
;;; of each master file with the symbols holding the information on that
|
||
;;; 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-docstruct-symbol))
|
||
|
||
;; Alist connecting master file names with the corresponding lisp symbols.
|
||
(defvar reftex-master-index-list nil)
|
||
|
||
;; Last index used for a master file.
|
||
(defvar reftex-multifile-index 0)
|
||
|
||
;; Variable holding the symbol with the label list of the document.
|
||
(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.
|
||
(incf reftex-multifile-index))
|
||
|
||
(defun reftex-tie-multifile-symbols ()
|
||
;; Tie the buffer-local symbols to globals connected with the master file.
|
||
;; If the symbols for the current master file do not exist, they are created.
|
||
|
||
(let* ((master (file-truename (reftex-TeX-master-file)))
|
||
(index (assoc master reftex-master-index-list))
|
||
(symlist reftex-multifile-symbols)
|
||
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.
|
||
(setq index (reftex-next-multifile-index)
|
||
newflag t)
|
||
(push (cons master index) reftex-master-index-list))
|
||
|
||
;; 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))))
|
||
(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.
|
||
(not newflag)))
|
||
|
||
(defun reftex-untie-multifile-symbols ()
|
||
;; Remove ties from multifile symbols, so that next use makes new ones.
|
||
(let ((symlist reftex-multifile-symbols)
|
||
(symbol nil))
|
||
(while symlist
|
||
(setq symbol (car symlist)
|
||
symlist (cdr symlist))
|
||
(set symbol nil))))
|
||
|
||
(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.
|
||
(let
|
||
((master
|
||
(cond
|
||
((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)
|
||
(buffer-file-name))
|
||
((eq TeX-master 'shared)
|
||
(setq TeX-master (read-file-name "Master file: "
|
||
nil nil t nil)))
|
||
(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.
|
||
(cond
|
||
((stringp tex-main-file)
|
||
;; ok, this must be it
|
||
tex-main-file)
|
||
(t
|
||
;; In this case, the buffer is its own master.
|
||
(buffer-file-name))))
|
||
(t
|
||
;; 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 (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
|
||
;; Use buffer file name.
|
||
(buffer-file-name)))
|
||
(expand-file-name master)))
|
||
|
||
(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 compile the tables, reset the mode etc.
|
||
|
||
;; The following constants are derived from `reftex-label-alist'.
|
||
|
||
;; Prompt used for label type queries directed to the user.
|
||
(defconst reftex-type-query-prompt nil)
|
||
|
||
;; Help string for label type queries.
|
||
(defconst reftex-type-query-help nil)
|
||
|
||
;; Alist relating label type to reference format.
|
||
(defconst reftex-typekey-to-format-alist nil)
|
||
|
||
;; 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.
|
||
(defconst reftex-env-or-mac-alist nil)
|
||
|
||
;; 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.
|
||
(defconst reftex-label-env-list nil)
|
||
|
||
;; List of all typekey letters in use.
|
||
(defconst reftex-typekey-list nil)
|
||
|
||
;; 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.
|
||
(defvar reftex-last-used-reference (list nil nil nil nil))
|
||
|
||
;; 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.
|
||
(defvar reftex-buffers-to-kill nil)
|
||
|
||
;; 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)
|
||
|
||
;; 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))
|
||
|
||
;; 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))
|
||
|
||
;; Make sure the current document will be rescanned soon.
|
||
(reftex-reset-scanning-information)
|
||
|
||
;; Remove any parse info file
|
||
(reftex-access-parse-file 'kill)
|
||
|
||
;; Plug functions into AUCTeX if the user option says so.
|
||
(and reftex-plug-into-AUCTeX
|
||
(reftex-plug-into-AUCTeX))
|
||
|
||
(reftex-compile-variables))
|
||
|
||
(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)))))
|
||
|
||
(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)))))
|
||
|
||
(defun reftex-compile-variables ()
|
||
;; Compile the information in reftex-label-alist & Co.
|
||
|
||
(message "Compiling label environment definitions...")
|
||
|
||
;; Update AUCTeX style information
|
||
(when (and (featurep 'tex-site) (fboundp 'TeX-update-style))
|
||
(condition-case nil (TeX-update-style) (error nil)))
|
||
|
||
;; 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)))
|
||
|
||
;; 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)
|
||
|
||
(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)))))
|
||
|
||
(setq reftex-typekey-to-prefix-alist
|
||
(nreverse reftex-typekey-to-prefix-alist))
|
||
|
||
;; 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
|
||
|
||
(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.
|
||
|
||
;; Make sure we have the symbols tied
|
||
(if (eq reftex-docstruct-symbol nil)
|
||
;; Symbols are not yet tied: Tie them.
|
||
(reftex-tie-multifile-symbols))
|
||
|
||
(reftex-ensure-compiled-variables)
|
||
|
||
(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)))
|
||
|
||
(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))
|
||
|
||
(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)))
|
||
|
||
(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)))
|
||
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; 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
|
||
|
||
(autoload 'reftex-toc "reftex-toc"
|
||
"Show the table of contents for the current document." t)
|
||
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; BibTeX citations.
|
||
|
||
(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")
|
||
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; Selection
|
||
|
||
(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")
|
||
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; 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)
|
||
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; 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 (eq conf-variable t)
|
||
(and (stringp conf-variable)
|
||
(string-match (concat "[" conf-variable "]") typekey))))
|
||
|
||
(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]"))))
|
||
|
||
(defun reftex-in-comment ()
|
||
(save-excursion
|
||
(skip-chars-backward "^%\n\r")
|
||
(eq (preceding-char) ?%)))
|
||
|
||
(defun reftex-no-props (string)
|
||
;; Return STRING with all text properties removed
|
||
(and (stringp string)
|
||
(set-text-properties 0 (length string) nil string))
|
||
string)
|
||
|
||
(defun reftex-match-string (n)
|
||
;; Match string without properties
|
||
(when (match-beginning n)
|
||
(buffer-substring-no-properties (match-beginning n) (match-end n))))
|
||
|
||
(defun reftex-kill-buffer (buffer)
|
||
;; Kill buffer if it exists.
|
||
(and (setq buffer (get-buffer buffer))
|
||
(kill-buffer buffer)))
|
||
|
||
(defun reftex-erase-buffer (&optional buffer)
|
||
;; Erase BUFFER if it exists. BUFFER defaults to current buffer.
|
||
;; This even erases read-only buffers.
|
||
(cond
|
||
((null buffer)
|
||
;; erase current buffer
|
||
(let ((buffer-read-only nil)) (erase-buffer)))
|
||
((setq buffer (get-buffer buffer))
|
||
;; buffer exists
|
||
(save-excursion
|
||
(set-buffer buffer)
|
||
(let ((buffer-read-only nil)) (erase-buffer))))))
|
||
|
||
(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-number (n unit &optional ending)
|
||
(if (and (integerp n) (stringp unit))
|
||
(format "%d %s%s" n unit (if (= n 1) "" (or ending "s")))
|
||
""))
|
||
|
||
(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)))
|
||
|
||
(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)))
|
||
|
||
(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))
|
||
|
||
(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)))
|
||
|
||
(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))
|
||
|
||
(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
|
||
((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
|
||
(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)))))))
|
||
|
||
|
||
(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))
|
||
|
||
(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)"))))
|
||
|
||
;; 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-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)))
|
||
|
||
(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.
|
||
|
||
(let ((buf (reftex-get-buffer-visiting file)))
|
||
|
||
(cond (buf
|
||
;; We have it already as a buffer - just return it
|
||
buf)
|
||
|
||
((file-readable-p file)
|
||
;; At least there is such a file and we can read it.
|
||
|
||
(if (or (not mark-to-kill)
|
||
(eq t reftex-initialize-temporary-buffers))
|
||
|
||
;; Visit the file with full magic
|
||
(setq buf (find-file-noselect file))
|
||
|
||
;; Else: Visit the file just briefly, without or
|
||
;; with limited Magic
|
||
|
||
;; 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)))
|
||
|
||
;; Is there a hook to run?
|
||
(when (listp reftex-initialize-temporary-buffers)
|
||
(save-excursion
|
||
(set-buffer buf)
|
||
(run-hooks 'reftex-initialize-temporary-buffers))))
|
||
|
||
;; Lets see if we got a license to kill :-|
|
||
(and mark-to-kill
|
||
(add-to-list 'reftex-buffers-to-kill buf))
|
||
|
||
;; Return the new buffer
|
||
buf)
|
||
|
||
;; If no such file exists, return nil
|
||
(t nil))))
|
||
|
||
(defun reftex-kill-temporary-buffers (&optional buffer)
|
||
;; Kill all buffers in the list reftex-kill-temporary-buffers.
|
||
(cond
|
||
(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))) ;; keep list elements nil
|
||
(symbolp (car list)))
|
||
(setq tmp (car list))
|
||
(cond
|
||
((assoc tmp alist)
|
||
(setq list (append (nth 2 (assoc tmp alist)) (cdr list))))
|
||
(t
|
||
(error "Cannot treat symbol %s in reftex-label-alist"
|
||
(symbol-name tmp)))))
|
||
(push (pop list) rtn))
|
||
(nreverse rtn)))
|
||
|
||
(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 (pop alist))
|
||
(if (or (member (car elm) keep-list)
|
||
(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.
|
||
(and window-system
|
||
reftex-use-fonts
|
||
(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. 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)
|
||
(aset reftex-highlight-overlays 1 (make-overlay 1 1))
|
||
(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)
|
||
"Highlight a region with overlay INDEX."
|
||
(move-overlay (aref reftex-highlight-overlays index)
|
||
begin end (or buffer (current-buffer))))
|
||
(defun reftex-unhighlight (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.
|
||
(remove-hook 'pre-command-hook 'reftex-highlight-shall-die)
|
||
(reftex-unhighlight 0))
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; 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))))
|
||
|
||
;;; =========================================================================
|
||
;;;
|
||
;;; Menu
|
||
|
||
;; Define a menu for the menu bar if Emacs is running under X
|
||
|
||
(require 'easymenu)
|
||
|
||
(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))
|
||
|
||
(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"))
|
||
|
||
(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 ""))))
|
||
|
||
;;; Install the kill-buffer and kill-emacs hooks ------------------------------
|
||
|
||
(add-hook 'kill-buffer-hook 'reftex-kill-buffer-hook)
|
||
(add-hook 'kill-emacs-hook 'reftex-kill-emacs-hook)
|
||
|
||
;;; Run Hook ------------------------------------------------------------------
|
||
|
||
(run-hooks 'reftex-load-hook)
|
||
|
||
;;; That's it! ----------------------------------------------------------------
|
||
|
||
(setq reftex-tables-dirty t) ; in case this file is evaluated by hand
|
||
(provide 'reftex)
|
||
|
||
;;;============================================================================
|
||
|
||
;;; reftex.el ends here
|