1 ;;; reftex.el --- minor mode for doing \label, \ref, \cite, \index in LaTeX
2 ;; Copyright (c) 1997, 1998, 1999, 2000, 2003, 2004, 2005
3 ;; Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <dominik@science.uva.nl>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;---------------------------------------------------------------------------
30 ;; RefTeX is a minor mode with distinct support for \ref, \label, \cite,
31 ;; and \index commands in (multi-file) LaTeX documents.
32 ;; - A table of contents provides easy access to any part of a document.
33 ;; - Labels are created semi-automatically.
34 ;; - Definition context of labels is provided when creating a reference.
35 ;; - Citations are simplified with efficient database lookup.
36 ;; - Text phrases can be collected in a file, for later global indexing.
37 ;; - The index preview buffer helps to check and edit index entries.
43 ;; - If this file is part of an X/Emacs distribution, it is installed.
44 ;; - For XEmacs 21.x, you need to install the RefTeX plug-in package
45 ;; available from the XEmacs distribution sites.
46 ;; - If you have downloaded this file from the maintainers webpage, follow
47 ;; the instructions in the INSTALL file of the distrubution.
49 ;; To turn RefTeX Mode on and off in a buffer, use `M-x reftex-mode'.
51 ;; To turn on RefTeX Mode for all LaTeX files, add the following lines
52 ;; to your .emacs file:
54 ;; (add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; AUCTeX LaTeX mode
55 ;; (add-hook 'latex-mode-hook 'turn-on-reftex) ; Emacs latex mode
61 ;; See below for a short summary of how to use RefTeX.
63 ;; There is an extensive texinfo document describing RefTeX in detail.
64 ;; One way to view this documentation is `M-x reftex-info RET'.
66 ;; The documentation in various formats is also available at
68 ;; http://zon.astro.uva.nl/~dominik/Tools/
70 ;;---------------------------------------------------------------------------
75 ;; RefTeX is a specialized package for support of labels, references,
76 ;; citations, and the index in LaTeX. RefTeX wraps itself round 4 LaTeX
77 ;; macros: `\label', `\ref', `\cite', and `\index'. Using these macros
78 ;; usually requires looking up different parts of the document and
79 ;; searching through BibTeX database files. RefTeX automates these
80 ;; time-consuming tasks almost entirely. It also provides functions to
81 ;; display the structure of a document and to move around in this
84 ;; *Note Imprint::, for information about who to contact for help, bug
85 ;; reports or suggestions.
90 ;; RefTeX needs to access all files which are part of a multifile
91 ;; document, and the BibTeX database files requested by the
92 ;; `\bibliography' command. To find these files, RefTeX will require a
93 ;; search path, i.e. a list of directories to check. Normally this list
94 ;; is stored in the environment variables `TEXINPUTS' and `BIBINPUTS'
95 ;; which are also used by RefTeX. However, on some systems these
96 ;; variables do not contain the full search path. If RefTeX does not work
97 ;; for you because it cannot find some files, read *Note Finding Files::.
99 ;; Entering RefTeX Mode
100 ;; ====================
102 ;; To turn RefTeX Mode on and off in a particular buffer, use `M-x
103 ;; reftex-mode'. To turn on RefTeX Mode for all LaTeX files, add the
104 ;; following lines to your `.emacs' file:
106 ;; (add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; with AUCTeX LaTeX mode
107 ;; (add-hook 'latex-mode-hook 'turn-on-reftex) ; with Emacs latex mode
109 ;; RefTeX in a Nutshell
110 ;; ====================
112 ;; 1. Table of Contents
113 ;; Typing `C-c =' (`reftex-toc') will show a table of contents of the
114 ;; document. This buffer can display sections, labels and index
115 ;; entries defined in the document. From the buffer, you can jump
116 ;; quickly to every part of your document. Press `?' to get help.
118 ;; 2. Labels and References
119 ;; RefTeX helps to create unique labels and to find the correct key
120 ;; for references quickly. It distinguishes labels for different
121 ;; environments, knows about all standard environments (and many
122 ;; others), and can be configured to recognize any additional labeled
123 ;; environments you have defined yourself (variable
124 ;; `reftex-label-alist').
127 ;; Type `C-c (' (`reftex-label') to insert a label at point.
128 ;; RefTeX will either
129 ;; - derive a label from context (default for section labels)
130 ;; - prompt for a label string (default for figures and
132 ;; - insert a simple label made of a prefix and a number (all
133 ;; other environments)
135 ;; Which labels are created how is configurable with the variable
136 ;; `reftex-insert-label-flags'.
138 ;; * Referencing Labels
139 ;; To make a reference, type `C-c )' (`reftex-reference'). This
140 ;; shows an outline of the document with all labels of a certain
141 ;; type (figure, equation,...) and some label context.
142 ;; Selecting a label inserts a `\ref{LABEL}' macro into the
146 ;; Typing `C-c [' (`reftex-citation') will let you specify a regular
147 ;; expression to search in current BibTeX database files (as
148 ;; specified in the `\bibliography' command) and pull out a list of
149 ;; matches for you to choose from. The list is _formatted_ and
150 ;; sorted. The selected article is referenced as `\cite{KEY}' (see
151 ;; the variable `reftex-cite-format' if you want to insert different
155 ;; RefTeX helps to enter index entries. It also compiles all entries
156 ;; into an alphabetically sorted `*Index*' buffer which you can use
157 ;; to check and edit the entries. RefTeX knows about the standard
158 ;; index macros and can be configured to recognize any additional
159 ;; macros you have defined (`reftex-index-macros'). Multiple indices
162 ;; * Creating Index Entries
163 ;; To index the current selection or the word at point, type
164 ;; `C-c /' (`reftex-index-selection-or-word'). The default macro
165 ;; `reftex-index-default-macro' will be used. For a more
166 ;; complex entry type `C-c <' (`reftex-index'), select any of
167 ;; the index macros and enter the arguments with completion.
169 ;; * The Index Phrases File (Delayed Indexing)
170 ;; Type `C-c \' (`reftex-index-phrase-selection-or-word') to add
171 ;; the current word or selection to a special _index phrase
172 ;; file_. RefTeX can later search the document for occurrences
173 ;; of these phrases and let you interactively index the matches.
175 ;; * Displaying and Editing the Index
176 ;; To display the compiled index in a special buffer, type `C-c
177 ;; >' (`reftex-display-index'). From that buffer you can check
178 ;; and edit all entries.
180 ;; 5. Viewing Cross-References
181 ;; When point is on the KEY argument of a cross-referencing macro
182 ;; (`\label', `\ref', `\cite', `\bibitem', `\index', and variations)
183 ;; or inside a BibTeX database entry, you can press `C-c &'
184 ;; (`reftex-view-crossref') to display corresponding locations in the
185 ;; document and associated BibTeX database files.
186 ;; When the enclosing macro is `\cite' or `\ref' and no other message
187 ;; occupies the echo area, information about the citation or label
188 ;; will automatically be displayed in the echo area.
190 ;; 6. Multifile Documents
191 ;; Multifile Documents are fully supported. The included files must
192 ;; have a file variable `TeX-master' or `tex-main-file' pointing to
193 ;; the master file. RefTeX provides cross-referencing information
194 ;; from all parts of the document, and across document borders
197 ;; 7. Document Parsing
198 ;; RefTeX needs to parse the document in order to find labels and
199 ;; other information. It does it automatically once and updates its
200 ;; list internally when `reftex-label' and `reftex-index' are used.
201 ;; To enforce reparsing, call any of the commands described above
202 ;; with a raw `C-u' prefix, or press the `r' key in the label
203 ;; selection buffer, the table of contents buffer, or the index
207 ;; If your major LaTeX mode is AUCTeX, RefTeX can cooperate with it
208 ;; (see variable `reftex-plug-into-AUCTeX'). AUCTeX contains style
209 ;; files which trigger appropriate settings in RefTeX, so that for
210 ;; many of the popular LaTeX packages no additional customizations
211 ;; will be necessary.
213 ;; 9. Useful Settings
214 ;; To make RefTeX faster for large documents, try these:
215 ;; (setq reftex-enable-partial-scans t)
216 ;; (setq reftex-save-parse-info t)
217 ;; (setq reftex-use-multiple-selection-buffers t)
219 ;; To integrate with AUCTeX, use
220 ;; (setq reftex-plug-into-AUCTeX t)
222 ;; To make your own LaTeX macro definitions known to RefTeX,
223 ;; customize the variables
224 ;; `reftex-label-alist' (for label macros/environments)
225 ;; `reftex-section-levels' (for sectioning commands)
226 ;; `reftex-cite-format' (for `\cite'-like macros)
227 ;; `reftex-index-macros' (for `\index'-like macros)
228 ;; `reftex-index-default-macro' (to set the default macro)
229 ;; If you have a large number of macros defined, you may want to write
230 ;; an AUCTeX style file to support them with both AUCTeX and RefTeX.
233 ;; Go ahead and use RefTeX. Use its menus until you have picked up
234 ;; the key bindings. For an overview of what you can do in each of
235 ;; the different special buffers, press `?'. Read the manual if you
236 ;; get stuck, of if you are curious what else might be available.
237 ;; The first part of the manual explains in a tutorial way how to use
238 ;; and customize RefTeX. The second part is a command and variable
241 ;;---------------------------------------------------------------------------
246 ;; Carsten Dominik <dominik@science.uva.nl>
248 ;; with contributions from Stephen Eglen
250 ;; RefTeX is bundled with Emacs and available as a plug-in package for
251 ;; XEmacs 21.x. If you need to install it yourself, you can find a
254 ;; http://zon.astro.uva.nl/~dominik/Tools/
258 ;; Thanks to the people on the Net who have used RefTeX and helped
259 ;; developing it with their reports. In particular thanks to
261 ;; Fran Burstall, Alastair Burt, Soren Dayton, Stephen Eglen,
262 ;; Karl Eichwalder, Peter Galbraith, Dieter Kraft, Kai Grossjohann,
263 ;; Frank Harrell, Adrian Lanz, Rory Molinari, Stefan Monnier,
264 ;; Laurent Mugnier, Sudeep Kumar Palat, Daniel Polani, Robin Socha,
265 ;; Richard Stanton, Allan Strand, Jan Vroonhof, Christoph Wedler,
268 ;; Finally thanks to Uwe Bolick who first got me (some years ago) into
269 ;; supporting LaTeX labels and references with an editor (which was
270 ;; MicroEmacs at the time).
272 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
278 (eval-when-compile (require 'cl
))
280 ;; Stuff that needs to be there when we use defcustom
283 (defvar reftex-tables-dirty t
284 "Flag showing if tables need to be re-computed.")
287 (defun reftex-set-dirty (symbol value
)
288 (setq reftex-tables-dirty t
)
292 ;;; =========================================================================
294 ;;; Configuration variables
296 (require 'reftex-vars
)
299 ;;; =========================================================================
301 ;;; Define the formal stuff for a minor mode named RefTeX.
304 (defconst reftex-version
"RefTeX version 4.28"
305 "Version string for RefTeX.")
307 (defvar reftex-mode nil
308 "Determines if RefTeX mode is active.")
309 (make-variable-buffer-local 'reftex-mode
)
311 (defvar reftex-mode-map
(make-sparse-keymap)
312 "Keymap for RefTeX mode.")
314 (defvar reftex-mode-menu nil
)
315 (defvar reftex-syntax-table nil
)
316 (defvar reftex-syntax-table-for-bib nil
)
318 (unless reftex-syntax-table
319 (setq reftex-syntax-table
(copy-syntax-table))
320 (modify-syntax-entry ?\
( "." reftex-syntax-table
)
321 (modify-syntax-entry ?\
) "." reftex-syntax-table
))
323 (unless reftex-syntax-table-for-bib
324 (setq reftex-syntax-table-for-bib
325 (copy-syntax-table reftex-syntax-table
))
326 (modify-syntax-entry ?
\' "." reftex-syntax-table-for-bib
)
327 (modify-syntax-entry ?
\" "." reftex-syntax-table-for-bib
)
328 (modify-syntax-entry ?\
[ "." reftex-syntax-table-for-bib
)
329 (modify-syntax-entry ?\
] "." reftex-syntax-table-for-bib
))
331 ;; The following definitions are out of place, but I need them here
332 ;; to make the compilation of reftex-mode not complain.
333 (defvar reftex-auto-view-crossref-timer nil
334 "The timer used for auto-view-crossref.")
335 (defvar reftex-toc-auto-recenter-timer nil
336 "The idle timer used to recenter the toc window.")
339 (defun turn-on-reftex ()
340 "Turn on RefTeX mode."
344 (defun reftex-mode (&optional arg
)
345 "Minor mode with distinct support for \\label, \\ref and \\cite in LaTeX.
347 \\<reftex-mode-map>A Table of Contents of the entire (multifile) document with browsing
348 capabilities is available with `\\[reftex-toc]'.
350 Labels can be created with `\\[reftex-label]' and referenced with `\\[reftex-reference]'.
351 When referencing, you get a menu with all labels of a given type and
352 context of the label definition. The selected label is inserted as a
355 Citations can be made with `\\[reftex-citation]' which will use a regular expression
356 to pull out a *formatted* list of articles from your BibTeX
357 database. The selected citation is inserted as a \\cite macro.
359 Index entries can be made with `\\[reftex-index-selection-or-word]' which indexes the word at point
360 or the current selection. More general index entries are created with
361 `\\[reftex-index]'. `\\[reftex-display-index]' displays the compiled index.
363 Most command have help available on the fly. This help is accessed by
364 pressing `?' to any prompt mentioning this feature.
366 Extensive documentation about RefTeX is available in Info format.
367 You can view this information with `\\[reftex-info]'.
370 Under X, these and other functions will also be available as `Ref' menu
373 ------------------------------------------------------------------------------"
376 (setq reftex-mode
(not (or (and (null arg
) reftex-mode
)
377 (<= (prefix-numeric-value arg
) 0))))
381 ;; Mode was turned on
382 (easy-menu-add reftex-mode-menu
)
383 (and reftex-plug-into-AUCTeX
384 (reftex-plug-into-AUCTeX))
385 (unless (get 'reftex-auto-view-crossref
'initialized
)
386 (and reftex-auto-view-crossref
387 (reftex-toggle-auto-view-crossref))
388 (put 'reftex-auto-view-crossref
'initialized t
))
389 (unless (get 'reftex-auto-recenter-toc
'initialized
)
390 (and (eq reftex-auto-recenter-toc t
)
391 (reftex-toggle-auto-toc-recenter))
392 (put 'reftex-auto-recenter-toc
'initialized t
))
394 ;; Prepare the special syntax tables.
395 (setq reftex-syntax-table
(copy-syntax-table (syntax-table)))
396 (modify-syntax-entry ?\
( "." reftex-syntax-table
)
397 (modify-syntax-entry ?\
) "." reftex-syntax-table
)
399 (setq reftex-syntax-table-for-bib
400 (copy-syntax-table reftex-syntax-table
))
401 (modify-syntax-entry ?
\' "." reftex-syntax-table-for-bib
)
402 (modify-syntax-entry ?
\" "." reftex-syntax-table-for-bib
)
403 (modify-syntax-entry ?\
[ "." reftex-syntax-table-for-bib
)
404 (modify-syntax-entry ?\
] "." reftex-syntax-table-for-bib
)
406 (run-hooks 'reftex-mode-hook
))
407 ;; Mode was turned off
408 (easy-menu-remove reftex-mode-menu
)))
410 (if (fboundp 'add-minor-mode
)
411 ;; Use it so that we get the extras
413 (put 'reftex-mode
:included
'(memq major-mode
'(latex-mode tex-mode
)))
414 (put 'reftex-mode
:menu-tag
"RefTeX Mode")
415 (add-minor-mode 'reftex-mode
" Ref" reftex-mode-map
))
417 (unless (assoc 'reftex-mode minor-mode-alist
)
418 (push '(reftex-mode " Ref") minor-mode-alist
))
419 (unless (assoc 'reftex-mode minor-mode-map-alist
)
420 (push (cons 'reftex-mode reftex-mode-map
) minor-mode-map-alist
)))
422 (defvar reftex-docstruct-symbol
)
423 (defun reftex-kill-buffer-hook ()
424 "Save RefTeX's parse file for this buffer if the information has changed."
425 ;; Save the parsing information if it was modified.
426 ;; This function should be installed in `kill-buffer-hook'.
427 ;; We are careful to make sure nothing goes wring in this function.
428 (when (and (boundp 'reftex-mode
) reftex-mode
429 (boundp 'reftex-save-parse-info
) reftex-save-parse-info
430 (boundp 'reftex-docstruct-symbol
) reftex-docstruct-symbol
431 (symbol-value reftex-docstruct-symbol
)
432 (get reftex-docstruct-symbol
'modified
))
435 (reftex-access-parse-file 'write
)
438 (defun reftex-kill-emacs-hook ()
439 "Call `reftex-kill-buffer-hook' on all buffers."
440 ;; This function should be installed in `kill-emacs-hook'.
442 (mapcar (lambda (buf)
444 (reftex-kill-buffer-hook))
447 ;;; =========================================================================
449 ;;; Silence warnings about variables in other packages.
452 (defvar LaTeX-section-hook
)
453 (defvar LaTeX-label-function
)
454 (defvar tex-main-file
)
455 (defvar outline-minor-mode
)
456 (defvar font-lock-mode
)
457 (defvar font-lock-fontify-region-function
)
458 (defvar font-lock-syntactic-keywords
))
460 ;;; =========================================================================
462 ;;; Multibuffer Variables
464 ;;; Technical notes: These work as follows: We keep just one list
465 ;;; of labels for each master file - this can save a lot of memory.
466 ;;; `reftex-master-index-list' is an alist which connects the true file name
467 ;;; of each master file with the symbols holding the information on that
468 ;;; document. Each buffer has local variables which point to these symbols.
470 ;; List of variables which handle the multifile stuff.
471 ;; This list is used to tie, untie, and reset these symbols.
472 (defconst reftex-multifile-symbols
473 '(reftex-docstruct-symbol))
475 ;; Alist connecting master file names with the corresponding lisp symbols.
476 (defvar reftex-master-index-list nil
)
478 ;; Last index used for a master file.
479 (defvar reftex-multifile-index
0)
481 ;; Variable holding the symbol with the label list of the document.
482 (defvar reftex-docstruct-symbol nil
)
483 (make-variable-buffer-local 'reftex-docstruct-symbol
)
485 (defun reftex-next-multifile-index ()
486 ;; Return the next free index for multifile symbols.
487 (incf reftex-multifile-index
))
489 (defun reftex-tie-multifile-symbols ()
490 ;; Tie the buffer-local symbols to globals connected with the master file.
491 ;; If the symbols for the current master file do not exist, they are created.
493 (let* ((master (file-truename (reftex-TeX-master-file)))
494 (index (assoc master reftex-master-index-list
))
495 (symlist reftex-multifile-symbols
)
496 symbol symname newflag
)
497 ;; Find the correct index.
500 (setq index
(cdr index
))
501 ;; Get a new index and add info to the alist.
502 (setq index
(reftex-next-multifile-index)
504 (push (cons master index
) reftex-master-index-list
))
506 ;; Get/create symbols and tie them.
508 (setq symbol
(car symlist
)
509 symlist
(cdr symlist
)
510 symname
(symbol-name symbol
))
511 (set symbol
(intern (concat symname
"-" (int-to-string index
))))
512 (put (symbol-value symbol
) :master-index index
)
513 ;; Initialize if new symbols.
515 (set (symbol-value symbol
) nil
)
516 (put (symbol-value symbol
) 'reftex-index-macros-style
'(default))))
518 ;; Return t if the symbols did already exist, nil when we've made them.
521 (defun reftex-untie-multifile-symbols ()
522 ;; Remove ties from multifile symbols, so that next use makes new ones.
523 (let ((symlist reftex-multifile-symbols
)
526 (setq symbol
(car symlist
)
527 symlist
(cdr symlist
))
530 (defun reftex-TeX-master-file ()
531 ;; Return the name of the master file associated with the current buffer.
532 ;; When AUCTeX is loaded, we will use it's more sophisticated method.
533 ;; We also support the default TeX and LaTeX modes by checking for a
534 ;; variable tex-main-file.
538 ((fboundp 'TeX-master-file
) ; AUCTeX is loaded. Use its mechanism.
541 (error (buffer-file-name))))
542 ((fboundp 'tex-main-file
) (tex-main-file)) ; Emacs LaTeX mode
543 ((boundp 'TeX-master
) ; The variable is defined - lets use it.
547 ((eq TeX-master
'shared
)
548 (setq TeX-master
(read-file-name "Master file: "
552 (setq TeX-master
(read-file-name "Master file: "
554 ((boundp 'tex-main-file
)
555 ;; This is the variable from the default TeX modes.
557 ((stringp tex-main-file
)
558 ;; ok, this must be it
561 ;; In this case, the buffer is its own master.
562 (buffer-file-name))))
564 ;; Know nothing about master file. Assume this is a master file.
565 (buffer-file-name)))))
568 (error "Need a filename for this buffer, please save it first"))
569 ((or (file-exists-p (concat master
".tex"))
570 (reftex-get-buffer-visiting (concat master
".tex")))
571 ;; Ahh, an extra .tex was missing...
572 (setq master
(concat master
".tex")))
573 ((or (file-exists-p master
)
574 (reftex-get-buffer-visiting master
))
575 ;; We either see the file, or have a buffer on it. OK.
578 ;; Use buffer file name.
580 (expand-file-name master
)))
582 (defun reftex-is-multi ()
583 ;; Tell if this is a multifile document. When not sure, say yes.
584 (let ((entry (assq 'is-multi
(symbol-value reftex-docstruct-symbol
))))
589 (defun reftex-set-cite-format (value)
590 "Set the document-local value of `reftex-cite-format'.
591 When such a value exists, it overwrites the setting given with
592 `reftex-cite-format'. See the documentation of `reftex-cite-format'
593 for possible values. This function should be used from AUCTeX style files."
594 (unless reftex-docstruct-symbol
595 (reftex-tie-multifile-symbols))
596 (when (and reftex-docstruct-symbol
597 (symbolp reftex-docstruct-symbol
))
598 (put reftex-docstruct-symbol
'reftex-cite-format value
)))
600 (defun reftex-get-cite-format ()
601 ;; Return the current citation format. Either the document-local value in
602 ;; reftex-cite-format-symbol, or the global value in reftex-cite-format.
603 (if (and reftex-docstruct-symbol
604 (symbolp reftex-docstruct-symbol
)
605 (get reftex-docstruct-symbol
'reftex-cite-format
))
606 (get reftex-docstruct-symbol
'reftex-cite-format
)
609 (defun reftex-add-index-macros (entry-list)
610 "Add index macro descriptions to `reftex-index-macros-style'.
611 The format of ENTRY-LIST is exactly like `reftex-index-macros'. See there
613 This function makes it possible to support RefTeX from AUCTeX style files.
614 The entries in ENTRY-LIST will be processed after the user settings in
615 `reftex-index-entries', and before the defaults. Any changes made to
616 `reftex-label-alist-style' will raise a flag to the effect that
617 the label information is recompiled on next use."
618 (unless reftex-docstruct-symbol
619 (reftex-tie-multifile-symbols))
620 (when (and reftex-docstruct-symbol
621 (symbolp reftex-docstruct-symbol
))
622 (let ((list (get reftex-docstruct-symbol
'reftex-index-macros-style
))
625 (setq entry
(pop entry-list
))
626 ;; When it is a symbol, remove all other symbols
628 (not (memq entry list
))
629 (setq list
(reftex-remove-symbols-from-list list
)))
630 ;; Add to list unless already member
631 (unless (member entry list
)
632 (setq reftex-tables-dirty t
636 (put reftex-docstruct-symbol
'reftex-index-macros-style list
)))))
638 ;;; =========================================================================
640 ;;; Functions to compile the tables, reset the mode etc.
642 ;; The following constants are derived from `reftex-label-alist'.
644 ;; Prompt used for label type queries directed to the user.
645 (defvar reftex-type-query-prompt nil
)
647 ;; Help string for label type queries.
648 (defvar reftex-type-query-help nil
)
650 ;; Alist relating label type to reference format.
651 (defvar reftex-typekey-to-format-alist nil
)
653 ;; Alist relating label type to label prefix.
654 (defvar reftex-typekey-to-prefix-alist nil
)
656 ;; Alist relating environments or macros to label type and context regexp.
657 (defvar reftex-env-or-mac-alist nil
)
659 ;; List of special environment parser functions
660 (defvar reftex-special-env-parsers nil
)
662 ;; List of macros carrying a label.
663 (defvar reftex-label-mac-list nil
)
665 ;; List of environments carrying a label.
666 (defvar reftex-label-env-list nil
)
668 ;; List of all typekey letters in use.
669 (defvar reftex-typekey-list nil
)
671 ;; Alist relating magic words to a label type.
672 (defvar reftex-words-to-typekey-alist nil
)
673 ;; Alist relating label prefixes to a label type.
674 (defvar reftex-prefix-to-typekey-alist nil
)
676 ;; The last list-of-labels entry used in a reference.
677 (defvar reftex-last-used-reference
(list nil nil nil nil
))
679 ;; Alist relating index macros to other info.
680 (defvar reftex-key-to-index-macro-alist nil
)
681 ;; Prompt for index macro queries
682 (defvar reftex-query-index-macro-prompt nil
)
683 ;; Help string for index macro queries
684 (defvar reftex-query-index-macro-help nil
)
686 ;; The message when follow-mode is suspended
687 (defvar reftex-no-follow-message
688 "No follow-mode into unvisited file. Press SPC to visit it.")
689 (defvar reftex-no-info-message
690 "%s: info not available, use `\\[reftex-view-crossref]' to get it.")
692 ;; Global variables used for communication between functions.
693 (defvar reftex-default-context-position nil
)
694 (defvar reftex-location-start nil
)
695 (defvar reftex-call-back-to-this-buffer nil
)
696 (defvar reftex-select-return-marker
(make-marker))
697 (defvar reftex-active-toc nil
)
698 (defvar reftex-tex-path nil
)
699 (defvar reftex-bib-path nil
)
700 (defvar reftex-select-marked nil
)
701 (defvar reftex-last-follow-point nil
)
702 (defvar reftex-latex-syntax-table nil
)
703 (defvar reftex-prefix nil
)
704 (defvar reftex-section-levels-all nil
)
705 (defvar reftex-buffers-with-changed-invisibility nil
)
706 (defvar reftex-callback-fwd t
)
707 (defvar reftex-last-toc-master nil
708 "Stores the name of the tex file that `reftex-toc' was last run on.")
709 ;; Marker for return point from recursive edit
710 (defvar reftex-recursive-edit-marker
(make-marker))
712 ;; List of buffers created temporarily for lookup, which should be killed.
713 (defvar reftex-buffers-to-kill nil
)
715 ;; Regexp to find anything.
716 (defvar reftex-section-regexp nil
)
717 (defvar reftex-section-or-include-regexp nil
)
718 (defvar reftex-index-macro-regexp nil
)
719 (defvar reftex-index-level-re nil
)
720 (defvar reftex-index-key-end-re nil
)
721 (defvar reftex-find-index-entry-regexp-format nil
)
722 (defvar reftex-everything-regexp nil
)
723 (defvar reftex-everything-regexp-no-index nil
)
724 (defvar reftex-index-re nil
)
725 (defvar reftex-find-citation-regexp-format
726 "\\\\\\([a-zA-Z]*cite[*a-zA-Z]*\\*?\\|bibentry\\)\\(\\[[^]]*\\]\\|{[^}]*}\\)*{\\([^}]*,\\)?\\(%s\\)[},]")
727 (defvar reftex-find-reference-format
728 "\\\\\\(ref[a-zA-Z]*\\|[a-zA-Z]*ref\\(range\\)?\\)\\*?\\(\\[[^]]*\\]\\|{[^}]*}\\)*{\\(%s\\)}")
729 (defvar reftex-macros-with-labels nil
)
730 (defvar reftex-macros-with-index nil
)
731 (defvar reftex-index-macro-alist nil
)
732 (defvar reftex-find-label-regexp-format nil
)
733 (defvar reftex-find-label-regexp-format2 nil
)
735 (defvar reftex-memory nil
736 "Memorizes old variable values to indicate changes in these variables.")
738 ;; A list of all variables in the cache.
739 ;; The cache is used to save the compiled versions of some variables.
740 (defconst reftex-cache-variables
741 '(reftex-memory ;; This MUST ALWAYS be the first!
744 reftex-section-levels-all
747 reftex-env-or-mac-alist
748 reftex-special-env-parsers
749 reftex-macros-with-labels
750 reftex-label-mac-list
751 reftex-label-env-list
753 reftex-typekey-to-format-alist
754 reftex-typekey-to-prefix-alist
755 reftex-words-to-typekey-alist
756 reftex-prefix-to-typekey-alist
757 reftex-type-query-prompt
758 reftex-type-query-help
761 reftex-index-macro-alist
762 reftex-macros-with-index
763 reftex-query-index-macro-prompt
764 reftex-query-index-macro-help
765 reftex-key-to-index-macro-alist
767 ;; Regular expressions
768 reftex-section-regexp
769 reftex-section-or-include-regexp
771 reftex-everything-regexp
772 reftex-everything-regexp-no-index
773 reftex-find-label-regexp-format
774 reftex-find-label-regexp-format2
775 reftex-find-index-entry-regexp-format
778 (defun reftex-ensure-compiled-variables ()
779 ;; Recompile the label alist when necessary
780 (let* ((mem reftex-memory
)
781 (cache (get reftex-docstruct-symbol
'reftex-cache
))
783 (alist reftex-label-alist
)
784 (levels (get reftex-docstruct-symbol
'reftex-section-levels
))
785 (style (get reftex-docstruct-symbol
'reftex-label-alist-style
))
786 (default reftex-default-label-alist-entries
)
787 (index reftex-index-macros
)
788 (istyle (get reftex-docstruct-symbol
'reftex-index-macros-style
)))
790 (reftex-tables-dirty (reftex-compile-variables))
791 ((and (eq alist
(nth 0 mem
))
792 (eq levels
(nth 1 mem
))
793 (eq style
(nth 2 mem
))
794 (eq default
(nth 3 mem
))
795 (eq index
(nth 4 mem
))
796 (eq istyle
(nth 5 mem
)))) ;; everything is OK
797 ((and (eq alist
(nth 0 cmem
))
798 (eq levels
(nth 1 cmem
))
799 (eq style
(nth 2 cmem
))
800 (eq default
(nth 2 cmem
))
801 (eq index
(nth 4 cmem
))
802 (eq istyle
(nth 5 cmem
)))
804 (message "Restoring cache")
805 (mapcar (lambda (sym) (set sym
(pop cache
))) reftex-cache-variables
))
806 (t (reftex-compile-variables)))))
808 (defun reftex-reset-mode ()
810 This will re-compile the configuration information and remove all
811 current scanning information and the parse file to enforce a rescan
815 ;; Reset the file search path variables
816 (loop for prop in
'(status master-dir recursive-path rec-type
) do
817 (put 'reftex-tex-path prop nil
)
818 (put 'reftex-bib-path prop nil
))
820 ;; Kill temporary buffers associated with RefTeX - just in case they
821 ;; were not cleaned up properly
823 (let ((buffer-list '("*RefTeX Help*" "*RefTeX Select*"
824 "*Duplicate Labels*" "*toc*" " *RefTeX-scratch*"))
826 (while (setq buf
(pop buffer-list
))
829 (reftex-erase-all-selection-and-index-buffers))
831 ;; Make sure the current document will be rescanned soon.
832 (reftex-reset-scanning-information)
834 ;; Remove any parse info file
835 (reftex-access-parse-file 'kill
)
837 ;; Plug functions into AUCTeX if the user option says so.
838 (and reftex-plug-into-AUCTeX
839 (reftex-plug-into-AUCTeX))
841 (reftex-compile-variables))
844 (defun reftex-reset-scanning-information ()
845 "Reset the symbols containing information from buffer scanning.
846 This enforces rescanning the buffer on next use."
847 (if (string= reftex-last-toc-master
(reftex-TeX-master-file))
848 (reftex-erase-buffer "*toc*"))
849 (let ((symlist reftex-multifile-symbols
)
852 (setq symbol
(car symlist
)
853 symlist
(cdr symlist
))
854 (if (and (symbolp (symbol-value symbol
))
855 (not (null (symbol-value symbol
))))
856 (set (symbol-value symbol
) nil
)))))
858 (defun reftex-erase-all-selection-and-index-buffers ()
859 ;; Remove all selection buffers associated with current document.
862 (reftex-erase-buffer (reftex-make-selection-buffer-name type
)))
864 ;; Kill all index buffers
867 (reftex-kill-buffer (reftex-make-index-buffer-name tag
)))
868 (cdr (assoc 'index-tags
(symbol-value reftex-docstruct-symbol
)))))
870 (defun reftex-compile-variables ()
871 ;; Compile the information in reftex-label-alist & Co.
873 (message "Compiling label environment definitions...")
875 ;; Update AUCTeX style information
876 (when (and (featurep 'tex-site
) (fboundp 'TeX-update-style
))
877 (condition-case nil
(TeX-update-style) (error nil
)))
879 ;; Record that we have done this, and what we have used.
880 (setq reftex-tables-dirty nil
)
882 (list reftex-label-alist
883 (get reftex-docstruct-symbol
'reftex-section-levels
)
884 (get reftex-docstruct-symbol
'reftex-label-alist-style
)
885 reftex-default-label-alist-entries
887 (get reftex-docstruct-symbol
'reftex-index-macros-style
)))
889 ;; Compile information in reftex-label-alist
890 (let ((all (reftex-uniquify-by-car
891 (reftex-splice-symbols-into-list
892 (append reftex-label-alist
893 (get reftex-docstruct-symbol
894 'reftex-label-alist-style
)
895 reftex-default-label-alist-entries
)
896 reftex-label-alist-builtin
)
898 (all-index (reftex-uniquify-by-car
899 (reftex-splice-symbols-into-list
900 (append reftex-index-macros
901 (get reftex-docstruct-symbol
902 'reftex-index-macros-style
)
904 reftex-index-macros-builtin
)))
905 entry env-or-mac typekeychar typekey prefix context word
906 fmt reffmt labelfmt wordlist qh-list macros-with-labels
907 nargs nlabel opt-args cell sum i
908 macro verify repeat nindex tag key toc-level toc-levels
)
910 (setq reftex-words-to-typekey-alist nil
911 reftex-prefix-to-typekey-alist
912 '(("sec:" .
"s") ("cha:" .
"s") ("chap:" .
"s"))
913 reftex-typekey-list nil
914 reftex-typekey-to-format-alist nil
915 reftex-typekey-to-prefix-alist nil
916 reftex-env-or-mac-alist nil
917 reftex-label-env-list nil
918 reftex-label-mac-list nil
)
921 (setq entry
(car all
)
922 env-or-mac
(car entry
)
925 (if (null env-or-mac
)
926 (setq env-or-mac
""))
927 (if (stringp (car entry
))
928 ;; This is before version 2.00 - convert entry to new format
929 ;; This is just to keep old users happy
930 (setq entry
(cons (string-to-char (car entry
))
931 (cons (concat (car entry
) ":")
933 (setq typekeychar
(nth 0 entry
)
934 typekey
(if typekeychar
(char-to-string typekeychar
) nil
)
937 context
(nth 3 entry
)
938 wordlist
(nth 4 entry
)
939 toc-level
(nth 5 entry
))
940 (if (stringp wordlist
)
941 ;; This is before version 2.04 - convert to new format
942 (setq wordlist
(nthcdr 4 entry
)))
944 (if (and (stringp fmt
)
945 (string-match "@" fmt
))
946 ;; Special syntax for specifying a label format
947 (setq fmt
(split-string fmt
"@+"))
948 (setq fmt
(list "\\label{%s}" fmt
)))
949 (setq labelfmt
(car fmt
)
951 ;; Note a new typekey
953 (add-to-list 'reftex-typekey-list typekey
))
954 (if (and typekey prefix
955 (not (assoc prefix reftex-prefix-to-typekey-alist
)))
956 (add-to-list 'reftex-prefix-to-typekey-alist
957 (cons prefix typekey
)))
958 (if (and typekey prefix
959 (not (assoc typekey reftex-typekey-to-prefix-alist
)))
960 (add-to-list 'reftex-typekey-to-prefix-alist
961 (cons typekey prefix
)))
962 ;; Check if this is a macro or environment
964 ((symbolp env-or-mac
)
965 ;; A special parser function
966 (unless (fboundp env-or-mac
)
967 (message "Warning: %s does not seem to be a valid function"
969 (setq nargs nil nlabel nil opt-args nil
)
970 (add-to-list 'reftex-special-env-parsers env-or-mac
)
971 (setq env-or-mac
(symbol-name env-or-mac
)))
972 ((string-match "\\`\\\\" env-or-mac
)
974 (let ((result (reftex-parse-args env-or-mac
)))
975 (setq env-or-mac
(or (first result
) env-or-mac
)
976 nargs
(second result
)
977 nlabel
(third result
)
978 opt-args
(fourth result
))
979 (if nlabel
(add-to-list 'macros-with-labels env-or-mac
)))
980 (if typekey
(add-to-list 'reftex-label-mac-list env-or-mac
)))
982 ;; It's an environment
983 (setq nargs nil nlabel nil opt-args nil
)
984 (cond ((string= env-or-mac
"any"))
985 ((string= env-or-mac
""))
986 ((string= env-or-mac
"section"))
988 (add-to-list 'reftex-label-env-list env-or-mac
)
990 (let ((string (format "begin{%s}" env-or-mac
)))
991 (or (assoc string toc-levels
)
992 (push (cons string toc-level
) toc-levels
))))))))
993 ;; Translate some special context cases
994 (when (assq context reftex-default-context-regexps
)
997 (cdr (assq context reftex-default-context-regexps
))
998 (regexp-quote env-or-mac
))))
999 ;; See if this is the first format for this typekey
1001 (not (assoc typekey reftex-typekey-to-format-alist
))
1002 (push (cons typekey reffmt
) reftex-typekey-to-format-alist
))
1003 ;; See if this is the first definition for this env-or-mac
1004 (and (not (string= env-or-mac
"any"))
1005 (not (string= env-or-mac
""))
1006 (not (assoc env-or-mac reftex-env-or-mac-alist
))
1007 (push (list env-or-mac typekey context labelfmt
1008 nargs nlabel opt-args
)
1009 reftex-env-or-mac-alist
))
1010 ;; Are the magic words regular expressions? Quote normal words.
1011 (if (eq (car wordlist
) 'regexp
)
1012 (setq wordlist
(cdr wordlist
))
1013 (setq wordlist
(mapcar 'regexp-quote wordlist
)))
1014 ;; Remember the first association of each word.
1015 (while (stringp (setq word
(pop wordlist
)))
1016 (or (assoc word reftex-words-to-typekey-alist
)
1017 (push (cons word typekey
) reftex-words-to-typekey-alist
)))
1019 ((string= "" env-or-mac
) nil
)
1020 ((setq cell
(assoc typekey qh-list
))
1021 (push env-or-mac
(cdr cell
)))
1023 (push (list typekey env-or-mac
) qh-list
)))))
1025 (setq reftex-typekey-to-prefix-alist
1026 (nreverse reftex-typekey-to-prefix-alist
))
1028 ;; Prepare the typekey query prompt and help string.
1032 (string< (downcase (car x1
)) (downcase (car x2
))))))
1033 (setq reftex-type-query-prompt
1034 (concat "Label type: ["
1035 (mapconcat (lambda(x) (format "%s" (car x
)))
1038 ;; In the help string, we need to wrap lines...
1039 (setq reftex-type-query-help
1041 "SELECT A LABEL TYPE:\n--------------------\n"
1047 (mapconcat (lambda(env)
1048 (setq sum
(+ sum
(length env
)))
1052 (concat "\n " env
)))
1056 ;; Convert magic words to regular expressions. We make regular expressions
1057 ;; which allow for some chars from the ref format to be in the buffer.
1058 ;; These characters will be seen and removed.
1059 (setq reftex-words-to-typekey-alist
1064 fmt
(cdr (assoc typekey reftex-typekey-to-format-alist
)))
1065 (setq word
(concat "\\W\\(" word
"[ \t\n\r]*\\)\\("))
1067 (while (and (< i
10) ; maximum number of format chars allowed
1069 (not (member (aref fmt i
) '(?%
))))
1070 (setq word
(concat word
"\\|" (regexp-quote
1071 (substring fmt
0 (1+ i
)))))
1073 (cons (concat word
"\\)\\=") typekey
))
1074 (nreverse reftex-words-to-typekey-alist
)))
1076 ;; Parse the index macros
1077 (setq reftex-index-macro-alist nil
1078 reftex-key-to-index-macro-alist nil
1079 reftex-macros-with-index nil
)
1081 (setq entry
(car all-index
)
1085 prefix
(or (nth 3 entry
) "")
1086 verify
(nth 4 entry
)
1087 ;; For repeat, we need to be compatible with older code
1088 ;; This information used to be given only for the default macro,
1089 ;; but later we required to have it for *every* index macro
1090 repeat
(cond ((> (length entry
) 5) (nth 5 entry
))
1091 ((and (eq key
(car reftex-index-default-macro
))
1092 (> (length reftex-index-default-macro
) 2))
1093 ;; User has old setting - respect it
1094 (nth 2 reftex-index-default-macro
))
1096 all-index
(cdr all-index
))
1097 (let ((result (reftex-parse-args macro
)))
1098 (setq macro
(or (first result
) macro
)
1099 nargs
(second result
)
1100 nindex
(third result
)
1101 opt-args
(fourth result
))
1102 (unless (member macro reftex-macros-with-index
)
1104 (push (list macro tag prefix verify nargs nindex opt-args repeat
)
1105 reftex-index-macro-alist
)
1106 (or (assoc key reftex-key-to-index-macro-alist
)
1107 (push (list key macro
) reftex-key-to-index-macro-alist
))
1108 (push macro reftex-macros-with-index
))))
1109 ;; Make the prompt and help string for index macros query
1110 (setq reftex-key-to-index-macro-alist
1111 (sort reftex-key-to-index-macro-alist
1112 (lambda (a b
) (< (downcase (car a
)) (downcase (car b
))))))
1113 (setq reftex-query-index-macro-prompt
1114 (concat "Index macro: ["
1115 (mapconcat (lambda (x) (char-to-string (car x
)))
1116 reftex-key-to-index-macro-alist
"")
1119 reftex-query-index-macro-help
1121 "SELECT A MACRO:\n---------------\n"
1124 (format "[%c] %-20.20s%s" (car x
) (nth 1 x
)
1125 (if (= 0 (mod (incf i
) 3)) "\n" "")))
1126 reftex-key-to-index-macro-alist
"")))
1128 ;; Make the full list of section levels
1129 (setq reftex-section-levels-all
1131 (get reftex-docstruct-symbol
'reftex-section-levels
)
1132 reftex-section-levels
))
1134 ;; Calculate the regular expressions
1136 ; (wbol "\\(\\`\\|[\n\r]\\)[ \t]*")
1137 (wbol "\\(^\\)[ \t]*") ; Need to keep the empty group because
1138 ;;; because match number are hard coded
1139 (label-re "\\\\label{\\([^}]*\\)}")
1140 (include-re (concat wbol
1142 (mapconcat 'identity
1143 reftex-include-file-commands
"\\|")
1144 "\\)[{ \t]+\\([^} \t\n\r]+\\)"))
1146 (concat wbol
"\\\\\\("
1147 (mapconcat (lambda (x) (regexp-quote (car x
)))
1148 reftex-section-levels-all
"\\|")
1149 "\\)\\*?\\(\\[[^]]*\\]\\)?[[{ \t\r\n]"))
1150 (appendix-re (concat wbol
"\\(\\\\appendix\\)"))
1152 (if macros-with-labels
1154 (mapconcat 'regexp-quote macros-with-labels
"\\|")
1159 (mapconcat 'regexp-quote reftex-macros-with-index
"\\|")
1161 (find-index-re-format
1163 (mapconcat 'regexp-quote reftex-macros-with-index
"\\|")
1164 "\\)\\([[{][^]}]*[]}]\\)*[[{]\\(%s\\)[]}]"))
1165 (find-label-re-format
1167 (mapconcat 'regexp-quote
(append '("\\label")
1168 macros-with-labels
) "\\|")
1169 "\\)\\([[{][^]}]*[]}]\\)*[[{]\\(%s\\)[]}]"))
1171 (regexp-quote (nth 0 reftex-index-special-chars
)))
1172 (index-key-end-re ;; ^]- not allowed
1173 (concat "[^" (nth 3 reftex-index-special-chars
) "]"
1174 "[" (nth 1 reftex-index-special-chars
)
1175 (nth 2 reftex-index-special-chars
) "]"))
1177 (setq reftex-section-regexp section-re
1178 reftex-section-or-include-regexp
1179 (concat section-re
"\\|" include-re
)
1180 reftex-everything-regexp
1181 (concat label-re
"\\|" section-re
"\\|" include-re
1184 (if macros-with-labels
"\\|" "") macro-re
)
1185 reftex-everything-regexp-no-index
1186 (concat label-re
"\\|" section-re
"\\|" include-re
1188 "\\|" "\\(\\\\6\\\\3\\\\1\\)" ; This is unlikely to match
1189 (if macros-with-labels
"\\|" "") macro-re
)
1190 reftex-index-re index-re
1191 reftex-index-level-re index-level-re
1192 reftex-index-key-end-re index-key-end-re
1193 reftex-macros-with-labels macros-with-labels
1194 reftex-find-index-entry-regexp-format find-index-re-format
1195 reftex-find-label-regexp-format find-label-re-format
1196 reftex-find-label-regexp-format2
1197 "\\([]} \t\n\r]\\)\\([[{]\\)\\(%s\\)[]}]")
1198 (message "Compiling label environment definitions...done")))
1199 (put reftex-docstruct-symbol
'reftex-cache
1200 (mapcar 'symbol-value reftex-cache-variables
)))
1202 (defun reftex-parse-args (macro)
1203 ;; Return a list of macro name, nargs, arg-nr which is label and a list of
1204 ;; optional argument indices.
1205 (if (string-match "[[{]\\*?[]}]" macro
)
1207 (let ((must-match (substring macro
0 (match-beginning 0)))
1208 (args (substring macro
(match-beginning 0)))
1209 opt-list nlabel
(cnt 0))
1210 (while (string-match "\\`[[{]\\(\\*\\)?[]}]" args
)
1212 (when (eq ?\
[ (string-to-char args
))
1213 (push cnt opt-list
))
1214 (when (and (match-end 1)
1217 (setq args
(substring args
(match-end 0))))
1218 (list must-match cnt nlabel opt-list
)))
1221 ;;; =========================================================================
1223 ;;; Accessing the parse information
1225 (defun reftex-access-scan-info (&optional rescan file
)
1226 "Ensure access to the scanning info for the current file."
1227 ;; When the multifile symbols are not yet tied,
1228 ;; tie them. When they are empty or RESCAN is non-nil, scan the document.
1229 ;; But, when RESCAN is -1, don't rescan even if docstruct is empty.
1230 ;; When FILE is non-nil, parse only from that file.
1232 ;; Error out in a buffer without a file.
1233 (if (and reftex-mode
1234 (not (buffer-file-name)))
1235 (error "RefTeX works only in buffers visiting a file."))
1237 ;; Make sure we have the symbols tied
1238 (if (eq reftex-docstruct-symbol nil
)
1239 ;; Symbols are not yet tied: Tie them.
1240 (reftex-tie-multifile-symbols))
1242 (reftex-ensure-compiled-variables)
1244 (when (or (null (symbol-value reftex-docstruct-symbol
))
1245 (member rescan
'(t 1 (4) (16))))
1246 ;; The docstruct will change: Remove selection buffers.
1248 (reftex-erase-buffer "*toc*")
1249 (reftex-erase-all-selection-and-index-buffers)))
1251 (if (and (null (symbol-value reftex-docstruct-symbol
))
1252 (not (member rescan
'(t 1 (4) (16))))
1253 reftex-save-parse-info
)
1254 ;; Try to read the stuff from a file
1255 (reftex-access-parse-file 'read
))
1258 ((equal rescan -
1)) ;; We are not allowed to scan.
1259 ((not (symbol-value reftex-docstruct-symbol
))
1260 ;; Scan the whole document
1261 (reftex-do-parse 1 file
))
1262 ((member rescan
'(t 1 (4) (16)))
1263 ;; Scan whatever was required by the caller.
1264 (reftex-do-parse rescan file
))))
1266 (defun reftex-scanning-info-available-p ()
1267 "Is the scanning info about the current document available?"
1268 (unless reftex-docstruct-symbol
1269 (reftex-tie-multifile-symbols))
1270 (and (symbolp reftex-docstruct-symbol
)
1271 (symbol-value reftex-docstruct-symbol
)
1274 (defun reftex-silence-toc-markers (list n
)
1275 ;; Set all toc markers in the first N entries in list to nil
1276 (while (and list
(> (decf n
) -
1))
1277 (and (eq (car (car list
)) 'toc
)
1278 (markerp (nth 4 (car list
)))
1279 (set-marker (nth 4 (car list
)) nil
))
1282 (defun reftex-access-parse-file (action)
1283 "Perform ACTION on the parse file (the .rel file).
1284 Valid actions are: readable, restore, read, kill, write."
1285 (let* ((list (symbol-value reftex-docstruct-symbol
))
1286 (docstruct-symbol reftex-docstruct-symbol
)
1287 (master (reftex-TeX-master-file))
1288 (enable-local-variables nil
)
1289 (file (if (string-match "\\.[a-zA-Z]+\\'" master
)
1290 (concat (substring master
0 (match-beginning 0))
1291 reftex-parse-file-extension
)
1292 (concat master reftex-parse-file-extension
))))
1294 ((eq action
'readable
)
1295 (file-readable-p file
))
1296 ((eq action
'restore
)
1297 (put reftex-docstruct-symbol
'modified nil
)
1298 (if (eq reftex-docstruct-symbol nil
)
1299 ;; Symbols are not yet tied: Tie them.
1300 (reftex-tie-multifile-symbols))
1301 (if (file-exists-p file
)
1302 ;; load the file and return t for success
1304 (progn (load-file file
) t
)
1305 (error (set reftex-docstruct-symbol nil
)
1306 (error "Error while loading file %s" file
)))
1307 ;; Throw an exception if the file does not exist
1308 (error "No restore file %s" file
)))
1310 (put reftex-docstruct-symbol
'modified nil
)
1311 (if (file-exists-p file
)
1312 ;; load the file and return t for success
1316 (reftex-check-parse-consistency)
1318 (error (message "Error while restoring file %s" file
)
1319 (set reftex-docstruct-symbol nil
)
1321 ;; return nil for failure, but no exception
1325 (when (and (file-exists-p file
) (file-writable-p file
))
1326 (message "Unlinking file %s" file
)
1327 (delete-file file
)))
1329 (put docstruct-symbol
'modified nil
)
1331 (if (file-writable-p file
)
1333 (message "Writing parse file %s" (abbreviate-file-name file
))
1336 (insert (format ";; RefTeX parse info file\n"))
1337 (insert (format ";; File: %s\n" master
))
1338 (insert (format ";; User: %s (%s)\n\n"
1339 (user-login-name) (user-full-name)))
1340 (insert "(set reftex-docstruct-symbol '(\n\n")
1341 (let ((standard-output (current-buffer)))
1344 (cond ((eq (car x
) 'toc
)
1345 ;; A toc entry. Do not save the marker.
1346 ;; Save the markers position at position 8
1347 (print (list 'toc
"toc" (nth 2 x
) (nth 3 x
)
1348 nil
(nth 5 x
) (nth 6 x
) (nth 7 x
)
1349 (or (and (markerp (nth 4 x
))
1350 (marker-position (nth 4 x
)))
1352 ((and (not (eq t reftex-support-index
))
1353 (eq (car x
) 'index
))
1354 ;; Don't save index entries
1360 (kill-buffer (current-buffer)))
1361 (error "Cannot write to file %s" file
)))
1364 (defun reftex-check-parse-consistency ()
1365 ;; Check if parse file is consistent, throw an error if not.
1367 ;; Check if the master is the same: when moving a document, this will see it.
1368 (let* ((real-master (reftex-TeX-master-file))
1370 (nth 1 (assq 'bof
(symbol-value reftex-docstruct-symbol
)))))
1371 (unless (string= (file-truename real-master
) (file-truename parsed-master
))
1372 (message "Master file name in load file is different: %s versus %s"
1373 parsed-master real-master
)
1374 (error "Master file name error")))
1376 ;; Check for the existence of all document files
1377 ;;; (let* ((all (symbol-value reftex-docstruct-symbol)))
1379 ;;; (when (and (eq (car (car all)) 'bof)
1380 ;;; (not (file-regular-p (nth 1 (car all)))))
1381 ;;; (message "File %s in saved parse info not avalable" (cdr (car all)))
1382 ;;; (error "File not found"))
1383 ;;; (setq all (cdr all))))
1386 (defun reftex-select-external-document (xr-alist xr-index
)
1387 ;; Return index of an external document.
1388 (let* ((len (length xr-alist
)) (highest (1- (+ ?
0 len
)))
1389 (prompt (format "[%c-%c] Select TAB: Read prefix with completion"
1394 (message "No external documents available")
1395 (ding) (sit-for 1) 0)
1400 (let* ((length (apply 'max
(mapcar
1401 (lambda(x) (length (car x
))) xr-alist
)))
1402 (fmt (format " [%%c] %%-%ds %%s\n" length
))
1405 (reftex-select-with-char
1408 "SELECT EXTERNAL DOCUMENT\n------------------------\n"
1411 (format fmt
(incf n
) (or (car x
) "")
1412 (abbreviate-file-name (cdr x
))))
1416 ((and (>= key ?
0) (<= key highest
)) (- key ?
0))
1418 (setq prefix
(completing-read "Prefix: " xr-alist nil t
))
1419 (- len
(length (memq (assoc prefix xr-alist
) xr-alist
))))
1420 (t (error "Invalid document selection [%c]" key
)))))))))
1422 ;;; =========================================================================
1426 (defun reftex-locate-file (file type master-dir
&optional die
)
1427 "Find FILE of type TYPE in MASTER-DIR or on the path associcted with TYPE.
1428 If the file does not have any of the valid extensions for TYPE,
1429 try first the default extension and only then the naked file name.
1430 When DIE is non-nil, throw an error if file not found."
1431 (let* ((rec-values (if reftex-search-unrecursed-path-first
'(nil t
) '(t)))
1432 (extensions (cdr (assoc type reftex-file-extensions
)))
1433 (def-ext (car extensions
))
1434 (ext-re (concat "\\("
1435 (mapconcat 'regexp-quote extensions
"\\|")
1437 (files (if (string-match ext-re file
)
1439 (cons (concat file def-ext
) file
)))
1440 path old-path file1
)
1442 ((file-name-absolute-p file
)
1445 (and (car files
) (file-regular-p (car files
)) (car files
))
1446 (and (cdr files
) (file-regular-p (cdr files
)) (cdr files
)))))
1447 ((and reftex-use-external-file-finders
1448 (assoc type reftex-external-file-finders
))
1449 (setq file1
(reftex-find-file-externally file type master-dir
)))
1451 (while (and (null file1
) rec-values
)
1452 (setq path
(reftex-access-search-path
1453 type
(pop rec-values
) master-dir file
))
1454 (if (or (null old-path
)
1455 (not (eq old-path path
)))
1457 path
(cons master-dir path
)
1458 file1
(or (and (car files
)
1459 (reftex-find-file-on-path
1460 (car files
) path master-dir
))
1462 (reftex-find-file-on-path
1463 (cdr files
) path master-dir
))))))))
1465 (die (error "No such file: %s" file
) nil
)
1466 (t (message "No such file: %s (ignored)" file
) nil
))))
1468 (defun reftex-find-file-externally (file type
&optional master-dir
)
1469 ;; Use external program to find FILE.
1470 ;; The program is taken from `reftex-external-file-finders'.
1471 ;; Interprete relative path definitions starting from MASTER-DIR.
1472 (let ((default-directory (or master-dir default-directory
))
1473 (prg (cdr (assoc type reftex-external-file-finders
)))
1475 (if (string-match "%f" prg
)
1476 (setq prg
(replace-match file t t prg
)))
1477 (setq out
(apply 'reftex-process-string
(split-string prg
)))
1478 (if (string-match "[ \t\n]+\\'" out
) ; chomp
1479 (setq out
(replace-match "" nil nil out
)))
1480 (cond ((equal out
"") nil
)
1481 ((file-regular-p out
) (expand-file-name out master-dir
))
1484 (defun reftex-process-string (program &rest args
)
1485 "Execute PROGRAM with arguments ARGS and return its STDOUT as a string."
1486 (let ((calling-dir default-directory
)) ; remember default directory
1487 (with-output-to-string
1488 (with-current-buffer standard-output
1489 (let ((default-directory calling-dir
)) ; set default directory
1490 (apply 'call-process program nil
'(t nil
) nil args
))))))
1492 (defun reftex-access-search-path (type &optional recurse master-dir file
)
1493 ;; Access path from environment variables. TYPE is either "tex" or "bib".
1494 ;; When RECURSE is t, expand path elements ending in `//' recursively.
1495 ;; Relative path elements are left as they are. However, relative recursive
1496 ;; elements are expanded with MASTER-DIR as default directory.
1497 ;; The expanded path is cached for the next search.
1498 ;; FILE is just for the progress message.
1499 ;; Returns the derived path.
1500 (let* ((pathvar (intern (concat "reftex-" type
"-path"))))
1501 (when (null (get pathvar
'status
))
1505 (reftex-parse-colon-path
1508 (if (string-match "^!" x
)
1509 (apply 'reftex-process-string
1510 (split-string (substring x
1)))
1512 ;; For consistency, the next line should look like this:
1513 ;; (cdr (assoc type reftex-path-environment))
1514 ;; However, historically we have separate options for the
1515 ;; environment variables, so we have to do this:
1516 (symbol-value (intern (concat "reftex-" type
1517 "path-environment-variables")))
1519 (put pathvar
'status
'split
)
1520 ;; Check if we have recursive elements
1521 (let ((path (symbol-value pathvar
)) dir rec
)
1522 (while (setq dir
(pop path
))
1523 (when (string= (substring dir -
2) "//")
1524 (if (file-name-absolute-p dir
)
1525 (setq rec
(or rec
'absolute
))
1526 (setq rec
'relative
))))
1527 (put pathvar
'rec-type rec
)))
1530 ;; Return the recursive expansion of the path
1532 ((not (get pathvar
'rec-type
))
1533 ;; Path does not contain recursive elements - use simple path
1534 (symbol-value pathvar
))
1535 ((or (not (get pathvar
'recursive-path
))
1536 (and (eq (get pathvar
'rec-type
) 'relative
)
1537 (not (equal master-dir
(get pathvar
'master-dir
)))))
1538 ;; Either: We don't have a recursive expansion yet.
1539 ;; or: Relative recursive path elements need to be expanded
1540 ;; relative to new default directory
1541 (message "Expanding search path to find %s file: %s ..." type file
)
1542 (put pathvar
'recursive-path
1543 (reftex-expand-path (symbol-value pathvar
) master-dir
))
1544 (put pathvar
'master-dir master-dir
)
1545 (get pathvar
'recursive-path
))
1547 ;; Recursive path computed earlier is still OK.
1548 (get pathvar
'recursive-path
)))
1549 ;; The simple path was requested
1550 (symbol-value pathvar
))))
1552 (defun reftex-find-file-on-path (file path
&optional def-dir
)
1553 ;; Find FILE along the directory list PATH.
1554 ;; DEF-DIR is the default directory for expanding relative path elements.
1556 (when (file-name-absolute-p file
)
1557 (if (file-regular-p file
)
1560 (let* ((thepath path
) file1 dir
)
1561 (while (setq dir
(pop thepath
))
1562 (when (string= (substring dir -
2) "//")
1563 (setq dir
(substring dir
0 -
1)))
1564 (setq file1
(expand-file-name file
(expand-file-name dir def-dir
)))
1565 (if (file-regular-p file1
)
1566 (throw 'exit file1
)))
1570 (defun reftex-parse-colon-path (path)
1571 ;; Like parse-colon-parse, but // or /~ are left alone.
1572 ;; Trailing ! or !! will be converted into `//' (emTeX convention)
1575 (if (string-match "\\(//+\\|/*!+\\)\\'" dir
)
1576 (setq dir
(replace-match "//" t t dir
)))
1577 (file-name-as-directory dir
))
1578 (delete "" (split-string path
(concat path-separator
"+")))))
1580 (defun reftex-expand-path (path &optional default-dir
)
1581 ;; Expand parts of path ending in `//' recursively into directory list.
1582 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
1583 (let (path1 dir recursive
)
1584 (while (setq dir
(pop path
))
1585 (if (setq recursive
(string= (substring dir -
2) "//"))
1586 (setq dir
(substring dir
0 -
1)))
1588 (not (file-name-absolute-p dir
)))
1589 (setq dir
(expand-file-name dir default-dir
)))
1591 ;; Expand recursively
1592 (setq path1
(append (reftex-recursive-directory-list dir
) path1
))
1597 (defun reftex-recursive-directory-list (dir)
1598 ;; Return a list of all directories below DIR, including DIR itself
1599 (let ((path (list dir
)) path1 file files
)
1600 (while (setq dir
(pop path
))
1601 (when (file-directory-p dir
)
1602 (setq files
(nreverse (directory-files dir t
"[^.]")))
1603 (while (setq file
(pop files
))
1604 (if (file-directory-p file
)
1605 (push (file-name-as-directory file
) path
)))
1609 ;;; =========================================================================
1611 ;;; Parser functions
1613 (autoload 'reftex-parse-one
"reftex-parse"
1614 "Re-parse this file." t
)
1615 (autoload 'reftex-parse-all
"reftex-parse"
1616 "Re-parse entire document." t
)
1617 (autoload 'reftex-do-parse
"reftex-parse")
1618 (autoload 'reftex-where-am-I
"reftex-parse")
1619 (autoload 'reftex-init-section-numbers
"reftex-parse")
1620 (autoload 'reftex-section-info
"reftex-parse")
1621 (autoload 'reftex-section-number
"reftex-parse")
1622 (autoload 'reftex-what-macro
"reftex-parse")
1623 (autoload 'reftex-what-macro-safe
"reftex-parse")
1624 (autoload 'reftex-index-info
"reftex-parse")
1625 (autoload 'reftex-index-info-safe
"reftex-parse")
1626 (autoload 'reftex-short-context
"reftex-parse")
1627 (autoload 'reftex-what-environment
"reftex-parse")
1628 (autoload 'reftex-what-special-env
"reftex-parse")
1629 (autoload 'reftex-move-over-touching-args
"reftex-parse")
1630 (autoload 'reftex-notice-new
"reftex-parse")
1631 (autoload 'reftex-nth-arg
"reftex-parse")
1632 (autoload 'reftex-locate-bibliography-files
"reftex-parse")
1633 (autoload 'reftex-ensure-index-support
"reftex-parse")
1634 (autoload 'reftex-everything-regexp
"reftex-parse")
1637 ;;; =========================================================================
1639 ;;; Labels and References
1641 (autoload 'reftex-label-location
"reftex-ref")
1642 (autoload 'reftex-label-info-update
"reftex-ref")
1643 (autoload 'reftex-label-info
"reftex-ref")
1644 (autoload 'reftex-label
"reftex-ref"
1645 "Insert a unique label." t
)
1646 (autoload 'reftex-reference
"reftex-ref"
1647 "Make a LaTeX reference." t
)
1648 (autoload 'reftex-varioref-vref
"reftex-ref"
1649 "Make a varioref reference." t
)
1650 (autoload 'reftex-fancyref-fref
"reftex-ref"
1651 "Make a fancyref \\fref reference." t
)
1652 (autoload 'reftex-fancyref-Fref
"reftex-ref"
1653 "Make a fancyref \\Fref reference." t
)
1654 (autoload 'reftex-show-label-location
"reftex-ref")
1655 (autoload 'reftex-query-label-type
"reftex-ref")
1656 (autoload 'reftex-goto-label
"reftex-ref"
1657 "Prompt for label name and go to that location." t
)
1659 ;;; =========================================================================
1661 ;;; Table of contents
1663 (autoload 'reftex-toc
"reftex-toc"
1664 "Show the table of contents for the current document." t
)
1665 (autoload 'reftex-toc-recenter
"reftex-toc"
1666 "Display the TOC window and highlight line corresponding to current position." t
)
1667 (autoload 'reftex-toggle-auto-toc-recenter
"reftex-toc"
1668 "Toggle automatic recentering of TOC window." t
)
1670 ;;; =========================================================================
1672 ;;; BibTeX citations.
1674 (autoload 'reftex-citep
"reftex-cite")
1675 (autoload 'reftex-citet
"reftex-cite")
1676 (autoload 'reftex-make-cite-echo-string
"reftex-cite")
1677 (autoload 'reftex-get-bibfile-list
"reftex-cite")
1678 (autoload 'reftex-pop-to-bibtex-entry
"reftex-cite")
1679 (autoload 'reftex-end-of-bib-entry
"reftex-cite")
1680 (autoload 'reftex-parse-bibtex-entry
"reftex-cite")
1681 (autoload 'reftex-citation
"reftex-cite"
1682 "Make a citation using BibTeX database files." t
)
1683 (autoload 'reftex-default-bibliography
"reftex-cite")
1684 (autoload 'reftex-bib-or-thebib
"reftex-cite")
1685 (autoload 'reftex-create-bibtex-file
"reftex-cite")
1687 ;;; =========================================================================
1691 (autoload 'reftex-select-label-mode
"reftex-sel")
1692 (autoload 'reftex-select-bib-mode
"reftex-sel")
1693 (autoload 'reftex-find-start-point
"reftex-sel")
1694 (autoload 'reftex-insert-docstruct
"reftex-sel")
1695 (autoload 'reftex-get-offset
"reftex-sel")
1696 (autoload 'reftex-select-item
"reftex-sel")
1699 ;;; =========================================================================
1703 (autoload 'reftex-index
"reftex-index"
1704 "Query for an index macro and insert it along with its argments." t
)
1705 (autoload 'reftex-index-selection-or-word
"reftex-index"
1706 "Put selection or the word near point into the default index macro." t
)
1707 (autoload 'reftex-index-phrase-selection-or-word
"reftex-index"
1708 "Put selection or the word near point into Index Phrases File." t
)
1709 (autoload 'reftex-display-index
"reftex-index"
1710 "Display a buffer with an index compiled from the current document." t
)
1711 (autoload 'reftex-index-visit-phrases-buffer
"reftex-index"
1712 "Visit the Index Phrases File." t
)
1713 (autoload 'reftex-index-phrases-mode
"reftex-index"
1714 "Major mode for managing the Index phrases of a LaTeX document." t
)
1715 (autoload 'reftex-index-complete-tag
"reftex-index")
1716 (autoload 'reftex-index-complete-key
"reftex-index")
1717 (autoload 'reftex-index-show-entry
"reftex-index")
1718 (autoload 'reftex-index-select-tag
"reftex-index")
1721 ;;; =========================================================================
1723 ;;; View cross references
1725 (autoload 'reftex-view-crossref
"reftex-dcr"
1726 "View cross reference of \\ref or \\cite macro at point." t
)
1727 (autoload 'reftex-mouse-view-crossref
"reftex-dcr"
1728 "View cross reference of \\ref or \\cite macro where you click." t
)
1729 (autoload 'reftex-toggle-auto-view-crossref
"reftex-dcr")
1730 (autoload 'reftex-view-crossref-from-bibtex
"reftex-dcr"
1731 "View location in a LaTeX document which cites the BibTeX entry at point." t
)
1734 ;;; =========================================================================
1736 ;;; Operations on entire Multifile documents
1738 (autoload 'reftex-create-tags-file
"reftex-global"
1739 "Create TAGS file by running `etags' on the current document." t
)
1740 (autoload 'reftex-grep-document
"reftex-global"
1741 "Run grep query through all files related to this document." t
)
1742 (autoload 'reftex-search-document
"reftex-global"
1743 "Regexp search through all files of the current TeX document." t
)
1744 (autoload 'reftex-query-replace-document
"reftex-global"
1745 "Run a query-replace-regexp of FROM with TO over the entire TeX document." t
)
1746 (autoload 'reftex-find-duplicate-labels
"reftex-global"
1747 "Produce a list of all duplicate labels in the document." t
)
1748 (autoload 'reftex-change-label
"reftex-global"
1749 "Query replace FROM with TO in all \\label and \\ref commands." t
)
1750 (autoload 'reftex-renumber-simple-labels
"reftex-global"
1751 "Renumber all simple labels in the document to make them sequentially." t
)
1752 (autoload 'reftex-save-all-document-buffers
"reftex-global"
1753 "Save all documents associated with the current document." t
)
1756 ;;; =========================================================================
1758 ;;; AUCTeX Interface
1760 (autoload 'reftex-arg-label
"reftex-auc")
1761 (autoload 'reftex-arg-cite
"reftex-auc")
1762 (autoload 'reftex-arg-index-tag
"reftex-auc")
1763 (autoload 'reftex-arg-index
"reftex-auc")
1764 (autoload 'reftex-plug-into-AUCTeX
"reftex-auc")
1765 (autoload 'reftex-toggle-plug-into-AUCTeX
"reftex-auc"
1766 "Toggle Interface between AUCTeX and RefTeX on and off." t
)
1767 (autoload 'reftex-add-label-environments
"reftex-auc")
1768 (autoload 'reftex-add-to-label-alist
"reftex-auc")
1769 (autoload 'reftex-add-section-levels
"reftex-auc")
1770 (autoload 'reftex-notice-new-section
"reftex-auc")
1772 ;;; =========================================================================
1774 ;;; Some generally useful functions
1776 (defun reftex-typekey-check (typekey conf-variable
&optional n
)
1777 ;; Check if CONF-VARIABLE is true or contains TYPEKEY
1778 (and n
(setq conf-variable
(nth n conf-variable
)))
1779 (or (eq conf-variable t
)
1780 (and (stringp conf-variable
)
1781 (string-match (concat "[" conf-variable
"]") typekey
))))
1783 (defun reftex-check-recursive-edit ()
1784 ;; Check if we are already in a recursive edit. Abort with helpful
1786 (if (marker-position reftex-recursive-edit-marker
)
1788 (substitute-command-keys
1789 "In unfinished selection process. Finish, or abort with \\[abort-recursive-edit]"))))
1791 (defun reftex-in-comment ()
1793 (skip-chars-backward "^%\n\r")
1794 (eq (preceding-char) ?%
)))
1796 (defun reftex-no-props (string)
1797 ;; Return STRING with all text properties removed
1798 (and (stringp string
)
1799 (set-text-properties 0 (length string
) nil string
))
1802 (defun reftex-match-string (n)
1803 ;; Match string without properties
1804 (when (match-beginning n
)
1805 (buffer-substring-no-properties (match-beginning n
) (match-end n
))))
1807 (defun reftex-region-active-p ()
1808 "Is transient-mark-mode on and the region active?
1809 Works on both Emacs and XEmacs."
1810 (if (featurep 'xemacs
)
1811 (and zmacs-regions
(region-active-p))
1812 (and transient-mark-mode mark-active
)))
1814 (defun reftex-kill-buffer (buffer)
1815 ;; Kill buffer if it exists.
1816 (and (setq buffer
(get-buffer buffer
))
1817 (kill-buffer buffer
)))
1819 (defun reftex-erase-buffer (&optional buffer
)
1820 ;; Erase BUFFER if it exists. BUFFER defaults to current buffer.
1821 ;; This even erases read-only buffers.
1824 ;; erase current buffer
1825 (let ((buffer-read-only nil
)) (erase-buffer)))
1826 ((setq buffer
(get-buffer buffer
))
1830 (let ((buffer-read-only nil
)) (erase-buffer))))))
1832 (defun reftex-this-word (&optional class
)
1833 ;; Grab the word around point.
1834 (setq class
(or class
"-a-zA-Z0-9:_/.*;|"))
1836 (buffer-substring-no-properties
1837 (progn (skip-chars-backward class
) (point))
1838 (progn (skip-chars-forward class
) (point)))))
1840 (defun reftex-number (n unit
&optional ending
)
1841 (if (and (integerp n
) (stringp unit
))
1842 (format "%d %s%s" n unit
(if (= n
1) "" (or ending
"s")))
1845 (defun reftex-all-assq (key list
)
1846 ;; Return a list of all associations of KEY in LIST. Comparison with eq.
1848 (while (setq list
(memq (assq key list
) list
))
1849 (push (car list
) rtn
)
1853 (defun reftex-all-assoc-string (key list
)
1854 ;; Return a list of all associations of KEY in LIST. Comparison with string=.
1857 (if (string= (car (car list
)) key
)
1858 (push (car list
) rtn
))
1862 (defun reftex-last-assoc-before-elt (key elt list
&optional exclusive
)
1863 ;; Find the last association of KEY in LIST before or at ELT
1864 ;; ELT is found in LIST with equal, not eq.
1865 ;; Returns nil when either KEY or elt are not found in LIST.
1866 ;; When EXCLUSIVE is non-nil, ELT cannot be the return value.
1867 ;; On success, returns the association.
1868 (let* ((elt (car (member elt list
))) (ex (not exclusive
)) ass last-ass
)
1869 (while (and (setq ass
(assoc key list
))
1870 (setq list
(memq ass list
))
1871 (or ex
(not (eq elt
(car list
))))
1877 (defun reftex-sublist-nth (list nth predicate
&optional completion
)
1878 ;; Make a list of the NTH elements of all members of LIST which
1879 ;; fulfill PREDICATE.
1880 ;; When COMPLETION is non-nil, make all elements of the resulting
1881 ;; list also a list, so that the result can be used for completion.
1884 (if (funcall predicate
(car list
))
1885 (push (if completion
1886 (list (nth nth
(car list
)))
1887 (nth nth
(car list
)))
1889 (setq list
(cdr list
)))
1892 (defun reftex-make-selection-buffer-name (type &optional index
)
1893 ;; Make unique name for a selection buffer.
1894 (format " *RefTeX[%s][%d]*"
1895 type
(or index
(get reftex-docstruct-symbol
:master-index
) 0)))
1897 (defun reftex-make-index-buffer-name (tag &optional cnt
)
1898 ;; Make unique name for an index buffer.
1899 (format "*Index[%s][%d]*"
1900 tag
(or cnt
(get reftex-docstruct-symbol
:master-index
) 0)))
1902 (defun reftex-truncate (string ncols
&optional ellipses padding
)
1903 ;; Truncate STRING to NCOLS characters.
1904 ;; When PADDING is non-nil, and string is shorter than NCOLS, fill with
1905 ;; white space to NCOLS characters. When ELLIPSES is non-nil and the
1906 ;; string needs to be truncated, replace last 3 characters by dots.
1908 (if (<= (length string
) ncols
)
1911 (concat (substring string
0 (- ncols
3)) "...")
1912 (substring string
0 ncols
))))
1914 (format (format "%%-%ds" ncols
) string
)
1917 (defun reftex-nearest-match (regexp &optional max-length
)
1918 ;; Find the nearest match of REGEXP. Set the match data.
1919 ;; If POS is given, calculate distances relative to it.
1920 ;; Return nil if there is no match.
1922 (dist (or max-length
(length regexp
)))
1923 match1 match2 match
)
1924 (goto-char (min (+ pos dist
) (point-max)))
1925 (when (re-search-backward regexp nil t
)
1926 (setq match1
(match-data)))
1927 (goto-char (max (- pos dist
) (point-min)))
1928 (when (re-search-forward regexp nil t
)
1929 (setq match2
(match-data)))
1933 ((not match1
) match2
)
1934 ((not match2
) match1
)
1935 ((< (abs (- pos
(car match1
))) (abs (- pos
(car match2
)))) match1
)
1937 (if match
(progn (set-match-data match
) t
) nil
)))
1939 (defun reftex-auto-mode-alist ()
1940 ;; Return an `auto-mode-alist' with only the .gz (etc) thingies.
1941 ;; Stolen from gnus nnheader.
1942 (let ((alist auto-mode-alist
)
1945 (when (listp (cdr (car alist
)))
1946 (push (car alist
) out
))
1950 (defun reftex-window-height ()
1951 (if (fboundp 'window-displayed-height
)
1952 (window-displayed-height)
1955 (defun reftex-enlarge-to-fit (buf2 &optional keep-current
)
1956 ;; Enlarge other window displaying buffer to show whole buffer if possible.
1957 ;; If KEEP-CURRENT in non-nil, current buffer must remain visible.
1958 (let* ((win1 (selected-window))
1959 (buf1 (current-buffer))
1960 (win2 (get-buffer-window buf2
))) ;; Only on current frame.
1962 (select-window win2
)
1963 (unless (and (pos-visible-in-window-p (point-min))
1964 (pos-visible-in-window-p (point-max)))
1965 (enlarge-window (1+ (- (count-lines (point-min) (point-max))
1966 (reftex-window-height))))))
1968 ((window-live-p win1
) (select-window win1
))
1970 ;; we must have the old buffer!
1971 (switch-to-buffer-other-window buf1
)
1972 (shrink-window (- (window-height) window-min-height
))))))
1974 (defun reftex-select-with-char (prompt help-string
&optional delay-time scroll
)
1975 ;; Offer to select something with PROMPT and, after DELAY-TIME seconds,
1976 ;; also with HELP-STRING.
1977 ;; When SCROLL is non-nil, use SPC and DEL to scroll help window.
1979 (save-window-excursion
1981 (message (concat prompt
" (?=Help)"))
1982 (when (or (sit-for (or delay-time
0))
1983 (= ?
\? (setq char
(read-char-exclusive))))
1984 (reftex-kill-buffer "*RefTeX Select*")
1985 (switch-to-buffer-other-window "*RefTeX Select*")
1986 (insert help-string
)
1988 (unless (and (pos-visible-in-window-p (point-min))
1989 (pos-visible-in-window-p (point-max)))
1990 (enlarge-window (1+ (- (count-lines (point-min) (point-max))
1991 (reftex-window-height)))))
1992 (setq truncate-lines t
))
1993 (if (and (pos-visible-in-window-p (point-min))
1994 (pos-visible-in-window-p (point-max)))
1996 (setq prompt
(concat prompt
(if scroll
" (SPC/DEL=Scroll)" ""))))
1998 (and (equal char ?
\?) (setq char
(read-char-exclusive)))
2000 (cond ((equal char ?\C-g
) (keyboard-quit))
2002 ((and scroll
(equal char ?\
))
2003 (condition-case nil
(scroll-up) (error nil
))
2005 ((and scroll
(equal char ?\C-?
))
2006 (condition-case nil
(scroll-down) (error nil
))
2009 (throw 'exit char
)))
2010 (setq char
(read-char-exclusive)))))))
2013 (defun reftex-make-regexp-allow-for-ctrl-m (string)
2014 ;; convert STRING into a regexp, allowing ^M for \n and vice versa
2016 (setq string
(regexp-quote string
))
2017 (while (setq start
(string-match "[\n\r]" string
(+ 3 start
)))
2018 (setq string
(replace-match "[\n\r]" nil t string
)))
2021 (defun reftex-get-buffer-visiting (file)
2022 ;; return a buffer visiting FILE
2024 ((boundp 'find-file-compare-truenames
) ; XEmacs
2025 (let ((find-file-compare-truenames t
))
2026 (get-file-buffer file
)))
2027 ((fboundp 'find-buffer-visiting
) ; Emacs
2028 (find-buffer-visiting file
))
2029 (t (error "This should not happen (reftex-get-buffer-visiting)"))))
2031 ;; Define `current-message' for compatibility with XEmacs prior to 20.4
2032 (defvar message-stack
)
2033 (if (and (featurep 'xemacs
)
2034 (not (fboundp 'current-message
)))
2035 (defun current-message (&optional frame
)
2036 (cdr (car message-stack
))))
2038 (defun reftex-visited-files (list)
2039 ;; Takes a list of filenames and returns the buffers of those already visited
2040 (delq nil
(mapcar (lambda (x) (if (reftex-get-buffer-visiting x
) x nil
))
2043 (defun reftex-get-file-buffer-force (file &optional mark-to-kill
)
2044 ;; Return a buffer visiting file. Make one, if necessary.
2045 ;; If neither such a buffer nor the file exist, return nil.
2046 ;; If MARK-TO-KILL is t and there is no live buffer, visit the file with
2047 ;; initializations according to `reftex-initialize-temporary-buffers',
2048 ;; and mark the buffer to be killed after use.
2050 (let ((buf (reftex-get-buffer-visiting file
)))
2053 ;; We have it already as a buffer - just return it
2056 ((file-readable-p file
)
2057 ;; At least there is such a file and we can read it.
2059 (if (or (not mark-to-kill
)
2060 (eq t reftex-initialize-temporary-buffers
))
2062 ;; Visit the file with full magic
2063 (setq buf
(find-file-noselect file
))
2065 ;; Else: Visit the file just briefly, without or
2066 ;; with limited Magic
2068 ;; The magic goes away
2069 (let ((format-alist nil
)
2070 (auto-mode-alist (reftex-auto-mode-alist))
2071 (default-major-mode 'fundamental-mode
)
2072 (enable-local-variables nil
)
2073 (after-insert-file-functions nil
))
2074 (setq buf
(find-file-noselect file
)))
2076 ;; Is there a hook to run?
2077 (when (listp reftex-initialize-temporary-buffers
)
2080 (run-hooks 'reftex-initialize-temporary-buffers
))))
2082 ;; Lets see if we got a license to kill :-|
2084 (add-to-list 'reftex-buffers-to-kill buf
))
2086 ;; Return the new buffer
2089 ;; If no such file exists, return nil
2092 (defun reftex-kill-temporary-buffers (&optional buffer
)
2093 ;; Kill all buffers in the list reftex-kill-temporary-buffers.
2096 (when (member buffer reftex-buffers-to-kill
)
2097 (kill-buffer buffer
)
2098 (setq reftex-buffers-to-kill
2099 (delete buffer reftex-buffers-to-kill
))))
2101 (while (setq buffer
(pop reftex-buffers-to-kill
))
2102 (when (bufferp buffer
)
2103 (and (buffer-modified-p buffer
)
2104 (y-or-n-p (format "Save file %s? "
2105 (buffer-file-name buffer
)))
2109 (kill-buffer buffer
))
2110 (pop reftex-buffers-to-kill
)))))
2112 (defun reftex-splice-symbols-into-list (list alist
)
2113 ;; Splice the association in ALIST of any symbols in LIST into the list.
2117 (while (and (not (null (car list
))) ;; keep list elements nil
2118 (symbolp (car list
)))
2119 (setq tmp
(car list
))
2122 (setq list
(append (nth 2 (assoc tmp alist
)) (cdr list
))))
2124 (error "Cannot treat symbol %s in reftex-label-alist"
2125 (symbol-name tmp
)))))
2126 (push (pop list
) rtn
))
2129 (defun reftex-remove-symbols-from-list (list)
2130 ;; Remove all symbols from list
2133 (unless (symbolp (car list
))
2134 (push (car list
) rtn
))
2135 (setq list
(cdr list
)))
2138 (defun reftex-uniquify (list)
2139 ;; Return a list of all elements in LIST, but each only once, keeping order
2142 (setq elm
(pop list
))
2143 (unless (member elm new
)
2147 (defun reftex-uniquify-by-car (alist &optional keep-list
)
2148 ;; Return a list of all elements in ALIST, but each car only once.
2149 ;; Elements of KEEP-LIST are not removed even if duplicate.
2152 (setq elm
(pop alist
))
2153 (if (or (member (car elm
) keep-list
)
2154 (not (assoc (car elm
) new
)))
2158 (defun reftex-abbreviate-title (string)
2159 (reftex-convert-string string
"[-~ \t\n\r,;]" nil t t
2160 5 40 nil
1 " " (nth 5 reftex-derive-label-parameters
)))
2162 (defun reftex-convert-string (string split-re invalid-re dot keep-fp
2163 nwords maxchar invalid abbrev sep
2164 ignore-words
&optional downcase
)
2165 "Convert a string (a sentence) to something shorter.
2166 SPLIT-RE is the regular expression used to split the string into words.
2167 INVALID-RE matches characters which are invalid in the final string.
2168 DOT t means add dots to abbreviated words.
2169 KEEP-FP t means to keep a final punctuation when applicable.
2170 NWORDS Number of words to use.
2171 MAXCHAR Maximum number of characters in the final string.
2172 INVALID nil: Throw away any words containing stuff matched with INVALID-RE.
2173 t: Throw away only the matched part, not the whole word.
2174 ABBREV nil: Never abbreviate words.
2175 t: Always abbreviate words (see `reftex-abbrev-parameters').
2176 not t and not nil: Abbreviate words if necessary to shorten
2177 string below MAXCHAR.
2178 SEP String separating different words in the output string.
2179 IGNORE-WORDS List of words which should be removed from the string."
2181 (let* ((words0 (split-string string
(or split-re
"[ \t\n\r]")))
2182 (reftex-label-illegal-re (or invalid-re
"\000"))
2185 (make-string (nth 0 reftex-abbrev-parameters
) ?.
)
2186 "[" (nth 2 reftex-abbrev-parameters
) "]*"
2188 "[" (nth 3 reftex-abbrev-parameters
) "]"
2189 (make-string (1- (nth 1 reftex-abbrev-parameters
)) ?.
)))
2192 ;; Remove words from the ignore list or with funny characters
2193 (while (setq word
(pop words0
))
2194 (if downcase
(setq word
(downcase word
)))
2196 ((member (downcase word
) ignore-words
))
2197 ((string-match reftex-label-illegal-re word
)
2199 (while (string-match reftex-label-illegal-re word
)
2200 (setq word
(replace-match "" nil nil word
)))
2203 (push word words
))))
2204 (setq words
(nreverse words
))
2206 ;; Restrict number of words
2207 (if (> (length words
) nwords
)
2208 (setcdr (nthcdr (1- nwords
) words
) nil
))
2210 ;; First, try to use all words
2211 (setq string
(mapconcat 'identity words sep
))
2213 ;; Abbreviate words if enforced by user settings or string length
2214 (if (or (eq t abbrev
)
2216 (> (length string
) maxchar
)))
2219 (lambda (w) (if (string-match abbrev-re w
)
2221 (concat (match-string 1 w
) ".")
2225 string
(mapconcat 'identity words sep
)))
2227 ;; Shorten if still to long
2229 (if (> (length string
) maxchar
)
2230 (substring string
0 maxchar
)
2233 ;; Delete the final punctuation, if any
2234 (if (and (not keep-fp
) (string-match "\\s.+\\'" string
))
2235 (setq string
(replace-match "" nil nil string
)))
2238 (defun reftex-nicify-text (text)
2239 ;; Make TEXT nice for inclusion as context into label menu.
2240 ;; 1. remove line breaks and extra white space
2241 (while (string-match "[\n\r\t]\\|[ \t][ \t]+" text
)
2242 (setq text
(replace-match " " nil t text
)))
2243 ;; 2. cut before the next `\end{' or `\item' or `\\'
2244 (if (string-match "\\(\\\\end{\\|\\\\item\\|\\\\\\\\\\).*" text
)
2245 (setq text
(replace-match "" nil t text
)))
2246 ;; 3. kill the embedded label
2247 (if (string-match "\\\\label{[^}]*}" text
)
2248 (setq text
(replace-match "" nil t text
)))
2249 ;; 4. remove leading garbage
2250 (if (string-match "\\`[ }]+" text
)
2251 (setq text
(replace-match "" nil t text
)))
2254 ((> (length text
) 100) (substring text
0 100))
2255 ((= (length text
) 0) (make-string 1 ?\
))
2258 ;;; =========================================================================
2260 ;;; Fontification and Highlighting
2262 (defun reftex-use-fonts ()
2263 ;; Return t if we can and want to use fonts.
2266 (featurep 'font-lock
)))
2268 (defun reftex-refontify ()
2269 ;; Return t if we need to refontify context
2270 (and (reftex-use-fonts)
2271 (or (eq t reftex-refontify-context
)
2272 (and (eq 1 reftex-refontify-context
)
2273 ;; Test of we use the font-lock version of x-symbol
2274 (and (featurep 'x-symbol-tex
) (not (boundp 'x-symbol-mode
)))))))
2276 (defvar font-lock-defaults-computed
)
2277 (defun reftex-fontify-select-label-buffer (parent-buffer)
2278 ;; Fontify the `*RefTeX Select*' buffer. Buffer is temporarily renamed to
2279 ;; start with none-SPC char, beacuse Font-Lock otherwise refuses operation.
2280 (run-hook-with-args 'reftex-pre-refontification-functions
2281 parent-buffer
'reftex-ref
)
2282 (let* ((oldname (buffer-name))
2283 (newname (concat "Fontify-me-" oldname
)))
2286 ;; Rename buffer temporarily to start w/o space (because of font-lock)
2287 (rename-buffer newname t
)
2289 ((fboundp 'font-lock-default-fontify-region
)
2290 ;; Good: we have the indirection functions
2291 (set (make-local-variable 'font-lock-fontify-region-function
)
2292 'reftex-select-font-lock-fontify-region
)
2293 (let ((major-mode 'latex-mode
))
2294 (font-lock-mode 1)))
2295 ((fboundp 'font-lock-set-defaults-1
)
2296 ;; Looks like the XEmacs font-lock stuff.
2297 ;; FIXME: this is still kind of a hack, but it works.
2298 (set (make-local-variable 'font-lock-keywords
) nil
)
2299 (let ((major-mode 'latex-mode
)
2300 (font-lock-defaults-computed nil
))
2301 (font-lock-set-defaults-1)
2302 (reftex-select-font-lock-fontify-region (point-min) (point-max))))
2305 (message "Sorry: cannot refontify RefTeX Select buffer."))))
2306 (rename-buffer oldname
))))
2308 (defun reftex-select-font-lock-fontify-region (beg end
&optional loudly
)
2309 ;; Fontify a region, but only lines starting with a dot.
2310 (let ((func (if (fboundp 'font-lock-default-fontify-region
)
2311 'font-lock-default-fontify-region
2312 'font-lock-fontify-region
))
2315 (while (re-search-forward "^\\." end t
)
2316 (setq beg1
(point) end1
(progn (skip-chars-forward "^\n") (point)))
2317 (funcall func beg1 end1 nil
)
2320 (defun reftex-select-font-lock-unfontify (&rest ignore
) t
)
2322 (defun reftex-verified-face (&rest faces
)
2323 ;; Return the first valid face in FACES, or nil if none is valid.
2324 ;; Also, when finding a nil element in FACES, return nil. This
2325 ;; function is just a safety net to catch name changes of builtin
2326 ;; fonts. Currently it is only used for reftex-label-face, which has
2327 ;; as default font-lock-reference-face, which was recently renamed
2328 ;; to font-lock-constant-face.
2331 (while (setq face
(pop faces
))
2332 (if (featurep 'xemacs
)
2333 (if (find-face face
) (throw 'exit face
))
2334 (if (facep face
) (throw 'exit face
)))))))
2336 ;; Highlighting uses overlays. For XEmacs, we use extends.
2337 (if (featurep 'xemacs
)
2339 (defalias 'reftex-make-overlay
'make-extent
)
2340 (defalias 'reftex-overlay-put
'set-extent-property
)
2341 (defalias 'reftex-move-overlay
'set-extent-endpoints
)
2342 (defalias 'reftex-delete-overlay
'detach-extent
))
2343 (defalias 'reftex-make-overlay
'make-overlay
)
2344 (defalias 'reftex-overlay-put
'overlay-put
)
2345 (defalias 'reftex-move-overlay
'move-overlay
)
2346 (defalias 'reftex-delete-overlay
'delete-overlay
))
2348 ;; We keep a vector with several different overlays to do our highlighting.
2349 (defvar reftex-highlight-overlays
[nil nil nil
])
2351 ;; Initialize the overlays
2352 (aset reftex-highlight-overlays
0 (reftex-make-overlay 1 1))
2353 (reftex-overlay-put (aref reftex-highlight-overlays
0)
2355 (aset reftex-highlight-overlays
1 (reftex-make-overlay 1 1))
2356 (reftex-overlay-put (aref reftex-highlight-overlays
1)
2357 'face reftex-cursor-selected-face
)
2358 (aset reftex-highlight-overlays
2 (reftex-make-overlay 1 1))
2359 (reftex-overlay-put (aref reftex-highlight-overlays
2)
2360 'face reftex-cursor-selected-face
)
2362 ;; Two functions for activating and deactivation highlight overlays
2363 (defun reftex-highlight (index begin end
&optional buffer
)
2364 "Highlight a region with overlay INDEX."
2365 (reftex-move-overlay (aref reftex-highlight-overlays index
)
2366 begin end
(or buffer
(current-buffer))))
2367 (defun reftex-unhighlight (index)
2368 "Detach overlay INDEX."
2369 (reftex-delete-overlay (aref reftex-highlight-overlays index
)))
2371 (defun reftex-highlight-shall-die ()
2372 ;; Function used in pre-command-hook to remove highlights.
2373 (remove-hook 'pre-command-hook
'reftex-highlight-shall-die
)
2374 (reftex-unhighlight 0))
2376 ;;; =========================================================================
2380 ;; The default bindings in the mode map.
2382 '(("\C-c=" . reftex-toc
)
2383 ("\C-c-" . reftex-toc-recenter
)
2384 ("\C-c(" . reftex-label
)
2385 ("\C-c)" . reftex-reference
)
2386 ("\C-c[" . reftex-citation
)
2387 ("\C-c<" . reftex-index
)
2388 ("\C-c>" . reftex-display-index
)
2389 ("\C-c/" . reftex-index-selection-or-word
)
2390 ("\C-c\\" . reftex-index-phrase-selection-or-word
)
2391 ("\C-c|" . reftex-index-visit-phrases-buffer
)
2392 ("\C-c&" . reftex-view-crossref
))
2393 do
(define-key reftex-mode-map
(car x
) (cdr x
)))
2395 ;; Bind `reftex-mouse-view-crossref' only when the key is still free
2396 (if (featurep 'xemacs
)
2397 (unless (key-binding [(shift button2
)])
2398 (define-key reftex-mode-map
[(shift button2
)]
2399 'reftex-mouse-view-crossref
))
2400 (unless (key-binding [(shift mouse-2
)])
2401 (define-key reftex-mode-map
[(shift mouse-2
)]
2402 'reftex-mouse-view-crossref
)))
2404 ;; Bind `reftex-view-crossref-from-bibtex' in BibTeX mode map
2407 '(define-key bibtex-mode-map
"\C-c&" 'reftex-view-crossref-from-bibtex
))
2409 ;; If the user requests so, she can have a few more bindings:
2410 (when reftex-extra-bindings
2412 '(("\C-ct" . reftex-toc
)
2413 ("\C-cl" . reftex-label
)
2414 ("\C-cr" . reftex-reference
)
2415 ("\C-cc" . reftex-citation
)
2416 ("\C-cv" . reftex-view-crossref
)
2417 ("\C-cg" . reftex-grep-document
)
2418 ("\C-cs" . reftex-search-document
))
2419 do
(define-key reftex-mode-map
(car x
) (cdr x
))))
2421 ;;; =========================================================================
2425 ;; Define a menu for the menu bar if Emacs is running under X
2427 (defvar reftex-isearch-minor-mode nil
)
2428 (make-variable-buffer-local 'reftex-isearch-minor-mode
)
2432 (easy-menu-define reftex-mode-menu reftex-mode-map
2433 "Menu used in RefTeX mode"
2435 ["Table of Contents" reftex-toc t
]
2436 ["Recenter TOC" reftex-toc-recenter t
]
2438 ["\\label" reftex-label t
]
2439 ["\\ref" reftex-reference t
]
2440 ["\\cite" reftex-citation t
]
2442 ["\\index" reftex-index t
]
2443 ["\\index{THIS}" reftex-index-selection-or-word t
]
2445 ["Add THIS to Index Phrases" reftex-index-phrase-selection-or-word t
]
2446 ["Visit Phrase Buffer" reftex-index-visit-phrases-buffer t
]
2447 ["Apply Phrases to Region" reftex-index-phrases-apply-to-region t
]
2449 ["Display the Index" reftex-display-index t
])
2451 ["View Crossref" reftex-view-crossref t
]
2454 ["One File" reftex-parse-one reftex-enable-partial-scans
]
2455 ["Entire Document" reftex-parse-all t
]
2456 ["Save to File" (reftex-access-parse-file 'write
)
2457 (> (length (symbol-value reftex-docstruct-symbol
)) 0)]
2458 ["Restore from File" (reftex-access-parse-file 'restore
) t
])
2460 ["Search Whole Document" reftex-search-document t
]
2461 ["Search Again" tags-loop-continue t
]
2462 ["Replace in Document" reftex-query-replace-document t
]
2463 ["Grep on Document" reftex-grep-document t
]
2465 ["Goto Label" reftex-goto-label t
]
2466 ["Find Duplicate Labels" reftex-find-duplicate-labels t
]
2467 ["Change Label and Refs" reftex-change-label t
]
2468 ["Renumber Simple Labels" reftex-renumber-simple-labels t
]
2470 ["Create BibTeX File" reftex-create-bibtex-file t
]
2472 ["Create TAGS File" reftex-create-tags-file t
]
2474 ["Save Document" reftex-save-all-document-buffers t
])
2479 (setq reftex-enable-partial-scans
(not reftex-enable-partial-scans
))
2480 :style toggle
:selected reftex-enable-partial-scans
]
2481 ["Auto-Save Parse Info"
2482 (setq reftex-save-parse-info
(not reftex-save-parse-info
))
2483 :style toggle
:selected reftex-save-parse-info
]
2486 ["Automatic Recenter" reftex-toggle-auto-toc-recenter
2487 :style toggle
:selected reftex-toc-auto-recenter-timer
]
2490 ["Automatic Info" reftex-toggle-auto-view-crossref
2491 :style toggle
:selected reftex-auto-view-crossref-timer
]
2492 ["...in Echo Area" (setq reftex-auto-view-crossref t
)
2493 :style radio
:selected
(eq reftex-auto-view-crossref t
)]
2494 ["...in Other Window" (setq reftex-auto-view-crossref
'window
)
2495 :style radio
:selected
(eq reftex-auto-view-crossref
'window
)]
2498 ["AUC TeX Interface" reftex-toggle-plug-into-AUCTeX
2499 :style toggle
:selected reftex-plug-into-AUCTeX
]
2500 ["isearch whole document" reftex-isearch-minor-mode
2501 :style toggle
:selected reftex-isearch-minor-mode
])
2503 ["Default" (setq reftex-vref-is-default nil
2504 reftex-fref-is-default nil
)
2505 :style radio
:selected
(not (or reftex-vref-is-default
2506 reftex-fref-is-default
))]
2507 ["Varioref" (setq reftex-vref-is-default t
2508 reftex-fref-is-default nil
)
2509 :style radio
:selected reftex-vref-is-default
]
2510 ["Fancyref" (setq reftex-fref-is-default t
2511 reftex-vref-is-default nil
)
2512 :style radio
:selected reftex-fref-is-default
])
2517 (capitalize (symbol-name (car x
)))
2518 (list 'reftex-set-cite-format
(list 'quote
(car x
)))
2519 :style
'radio
:selected
2520 (list 'eq
(list 'reftex-get-cite-format
) (list 'quote
(car x
)))))
2521 reftex-cite-format-builtin
)
2523 "Sort Database Matches"
2524 ["Not" (setq reftex-sort-bibtex-matches nil
)
2525 :style radio
:selected
(eq reftex-sort-bibtex-matches nil
)]
2526 ["by Author" (setq reftex-sort-bibtex-matches
'author
)
2527 :style radio
:selected
(eq reftex-sort-bibtex-matches
'author
)]
2528 ["by Year" (setq reftex-sort-bibtex-matches
'year
)
2529 :style radio
:selected
(eq reftex-sort-bibtex-matches
'year
)]
2530 ["by Year, reversed" (setq reftex-sort-bibtex-matches
'reverse-year
)
2531 :style radio
:selected
(eq reftex-sort-bibtex-matches
'reverse-year
)])
2536 (capitalize (symbol-name (car x
)))
2537 (list 'reftex-add-index-macros
(list 'list
(list 'quote
(car x
))))
2538 :style
'radio
:selected
2539 (list 'memq
(list 'quote
(car x
))
2540 (list 'get
'reftex-docstruct-symbol
2541 (list 'quote
'reftex-index-macros-style
)))))
2542 reftex-index-macros-builtin
))
2544 ["Reset RefTeX Mode" reftex-reset-mode t
]
2547 ["Browse RefTeX Group" reftex-customize t
]
2549 ["Build Full Customize Menu" reftex-create-customize-menu
2550 (fboundp 'customize-menu-create
)])
2552 ["Info" reftex-info t
]
2553 ["Commentary" reftex-show-commentary t
])))
2555 (defun reftex-customize ()
2556 "Call the customize function with reftex as argument."
2558 (customize-browse 'reftex
))
2560 (defun reftex-create-customize-menu ()
2561 "Create a full customization menu for RefTeX, insert it into the menu."
2563 (if (fboundp 'customize-menu-create
)
2566 '("Ref") "Customize"
2567 `(["Browse RefTeX group" reftex-customize t
]
2569 ,(customize-menu-create 'reftex
)
2570 ["Set" Custom-set t
]
2571 ["Save" Custom-save t
]
2572 ["Reset to Current" Custom-reset-current t
]
2573 ["Reset to Saved" Custom-reset-saved t
]
2574 ["Reset to Standard Settings" Custom-reset-standard t
]))
2575 (message "\"Ref\"-menu now contains full customization menu"))
2576 (error "Cannot expand menu (outdated version of cus-edit.el)")))
2578 (defun reftex-show-commentary ()
2579 "Use the finder to view the file documentation from `reftex.el'."
2582 (finder-commentary "reftex.el"))
2584 (defun reftex-info (&optional node
)
2585 "Read documentation for RefTeX in the info system.
2586 With optional NODE, go directly to that node."
2589 (Info-goto-node (format "(reftex)%s" (or node
""))))
2591 ;;; Install the kill-buffer and kill-emacs hooks ------------------------------
2593 (add-hook 'kill-buffer-hook
'reftex-kill-buffer-hook
)
2594 (add-hook 'kill-emacs-hook
'reftex-kill-emacs-hook
)
2596 ;;; Run Hook ------------------------------------------------------------------
2598 (run-hooks 'reftex-load-hook
)
2600 ;;; That's it! ----------------------------------------------------------------
2602 (setq reftex-tables-dirty t
) ; in case this file is evaluated by hand
2605 ;;;============================================================================
2607 ;;; arch-tag: 49e0da4e-bd5e-4cfc-a717-fb444fccb9e6
2608 ;;; reftex.el ends here