(eval-when-compile (require 'cl))
(require 'custom)
(defvar reftex-tables-dirty t
"Flag showing if tables need to be re-computed.")
(eval-and-compile
(defun reftex-set-dirty (symbol value)
(setq reftex-tables-dirty t)
(set symbol value)))
(require 'reftex-vars)
(defconst reftex-version "RefTeX version 4.31"
"Version string for RefTeX.")
(defvar reftex-mode nil
"Determines if RefTeX mode is active.")
(make-variable-buffer-local 'reftex-mode)
(defvar reftex-mode-map (make-sparse-keymap)
"Keymap for RefTeX mode.")
(defvar reftex-mode-menu nil)
(defvar reftex-syntax-table nil)
(defvar reftex-syntax-table-for-bib nil)
(unless reftex-syntax-table
(setq reftex-syntax-table (copy-syntax-table))
(modify-syntax-entry ?\( "." reftex-syntax-table)
(modify-syntax-entry ?\) "." reftex-syntax-table))
(unless reftex-syntax-table-for-bib
(setq reftex-syntax-table-for-bib
(copy-syntax-table reftex-syntax-table))
(modify-syntax-entry ?\' "." reftex-syntax-table-for-bib)
(modify-syntax-entry ?\" "." reftex-syntax-table-for-bib)
(modify-syntax-entry ?\[ "." reftex-syntax-table-for-bib)
(modify-syntax-entry ?\] "." reftex-syntax-table-for-bib))
;; The following definitions are out of place, but I need them here
;; to make the compilation of reftex-mode not complain.
(defvar reftex-auto-view-crossref-timer nil
"The timer used for auto-view-crossref.")
(defvar reftex-toc-auto-recenter-timer nil
"The idle timer used to recenter the toc window.")
;;;###autoload
(defun turn-on-reftex ()
"Turn on RefTeX mode."
(reftex-mode t))
;;;###autoload
(defun reftex-mode (&optional arg)
"Minor mode with distinct support for \\label, \\ref and \\cite in LaTeX.
\\<reftex-mode-map>A Table of Contents of the entire (multifile) document with browsing
capabilities is available with `\\[reftex-toc]'.
Labels can be created with `\\[reftex-label]' and referenced with `\\[reftex-reference]'.
When referencing, you get a menu with all labels of a given type and
context of the label definition. The selected label is inserted as a
\\ref macro.
Citations can be made with `\\[reftex-citation]' which will use a regular expression
to pull out a *formatted* list of articles from your BibTeX
database. The selected citation is inserted as a \\cite macro.
Index entries can be made with `\\[reftex-index-selection-or-word]' which indexes the word at point
or the current selection. More general index entries are created with
`\\[reftex-index]'. `\\[reftex-display-index]' displays the compiled index.
Most command have help available on the fly. This help is accessed by
pressing `?' to any prompt mentioning this feature.
Extensive documentation about RefTeX is available in Info format.
You can view this information with `\\[reftex-info]'.
\\{reftex-mode-map}
Under X, these and other functions will also be available as `Ref' menu
on the menu bar.
------------------------------------------------------------------------------"
(interactive "P")
(setq reftex-mode (not (or (and (null arg) reftex-mode)
(<= (prefix-numeric-value arg) 0))))
(if reftex-mode
(progn
;; Mode was turned on
(easy-menu-add reftex-mode-menu)
(and reftex-plug-into-AUCTeX
(reftex-plug-into-AUCTeX))
(unless (get 'reftex-auto-view-crossref 'initialized)
(and reftex-auto-view-crossref
(reftex-toggle-auto-view-crossref))
(put 'reftex-auto-view-crossref 'initialized t))
(unless (get 'reftex-auto-recenter-toc 'initialized)
(and (eq reftex-auto-recenter-toc t)
(reftex-toggle-auto-toc-recenter))
(put 'reftex-auto-recenter-toc 'initialized t))
;; Prepare the special syntax tables.
(setq reftex-syntax-table (copy-syntax-table (syntax-table)))
(modify-syntax-entry ?\( "." reftex-syntax-table)
(modify-syntax-entry ?\) "." reftex-syntax-table)
(setq reftex-syntax-table-for-bib
(copy-syntax-table reftex-syntax-table))
(modify-syntax-entry ?\' "." reftex-syntax-table-for-bib)
(modify-syntax-entry ?\" "." reftex-syntax-table-for-bib)
(modify-syntax-entry ?\[ "." reftex-syntax-table-for-bib)
(modify-syntax-entry ?\] "." reftex-syntax-table-for-bib)
(run-hooks 'reftex-mode-hook))
;; Mode was turned off
(easy-menu-remove reftex-mode-menu)))
(if (fboundp 'add-minor-mode)
;; Use it so that we get the extras
(progn
(put 'reftex-mode :included '(memq major-mode '(latex-mode tex-mode)))
(put 'reftex-mode :menu-tag "RefTeX Mode")
(add-minor-mode 'reftex-mode " Ref" reftex-mode-map))
;; The standard way
(unless (assoc 'reftex-mode minor-mode-alist)
(push '(reftex-mode " Ref") minor-mode-alist))
(unless (assoc 'reftex-mode minor-mode-map-alist)
(push (cons 'reftex-mode reftex-mode-map) minor-mode-map-alist)))
(defvar reftex-docstruct-symbol)
(defun reftex-kill-buffer-hook ()
"Save RefTeX's parse file for this buffer if the information has changed."
;; Save the parsing information if it was modified.
;; This function should be installed in `kill-buffer-hook'.
;; We are careful to make sure nothing goes wring in this function.
(when (and (boundp 'reftex-mode) reftex-mode
(boundp 'reftex-save-parse-info) reftex-save-parse-info
(boundp 'reftex-docstruct-symbol) reftex-docstruct-symbol
(symbol-value reftex-docstruct-symbol)
(get reftex-docstruct-symbol 'modified))
;; Write the file.
(condition-case nil
(reftex-access-parse-file 'write)
(error nil))))
(defun reftex-kill-emacs-hook ()
"Call `reftex-kill-buffer-hook' on all buffers."
;; This function should be installed in `kill-emacs-hook'.
(save-excursion
(mapcar (lambda (buf)
(set-buffer buf)
(reftex-kill-buffer-hook))
(buffer-list))))
;;; =========================================================================
;;;
;;; Silence warnings about variables in other packages.
(eval-when-compile
(defvar TeX-master)
(defvar LaTeX-section-hook)
(defvar LaTeX-label-function)
(defvar tex-main-file)
(defvar outline-minor-mode)
(defvar font-lock-mode)
(defvar font-lock-keywords)
(defvar font-lock-fontify-region-function)
(defvar font-lock-syntactic-keywords))
;;; =========================================================================
;;;
;;; Multibuffer Variables
;;;
;;; Technical notes: These work as follows: We keep just one list
;;; of labels for each master file - this can save a lot of memory.
;;; `reftex-master-index-list' is an alist which connects the true file name
;;; of each master file with the symbols holding the information on that
;;; document. Each buffer has local variables which point to these symbols.
;; List of variables which handle the multifile stuff.
;; This list is used to tie, untie, and reset these symbols.
(defconst reftex-multifile-symbols
'(reftex-docstruct-symbol))
;; Alist connecting master file names with the corresponding lisp symbols.
(defvar reftex-master-index-list nil)
;; Last index used for a master file.
(defvar reftex-multifile-index 0)
;; Variable holding the symbol with the label list of the document.
(defvar reftex-docstruct-symbol nil)
(make-variable-buffer-local 'reftex-docstruct-symbol)
(defun reftex-next-multifile-index ()
;; Return the next free index for multifile symbols.
(incf reftex-multifile-index))
(defun reftex-tie-multifile-symbols ()
;; Tie the buffer-local symbols to globals connected with the master file.
;; If the symbols for the current master file do not exist, they are created.
(let* ((master (file-truename (reftex-TeX-master-file)))
(index (assoc master reftex-master-index-list))
(symlist reftex-multifile-symbols)
symbol symname newflag)
;; Find the correct index.
(if index
;; symbols do exist
(setq index (cdr index))
;; Get a new index and add info to the alist.
(setq index (reftex-next-multifile-index)
newflag t)
(push (cons master index) reftex-master-index-list))
;; Get/create symbols and tie them.
(while symlist
(setq symbol (car symlist)
symlist (cdr symlist)
symname (symbol-name symbol))
(set symbol (intern (concat symname "-" (int-to-string index))))
(put (symbol-value symbol) :master-index index)
;; Initialize if new symbols.
(when newflag
(set (symbol-value symbol) nil)
(put (symbol-value symbol) 'reftex-index-macros-style '(default))))
;; Return t if the symbols did already exist, nil when we've made them.
(not newflag)))
(defun reftex-untie-multifile-symbols ()
;; Remove ties from multifile symbols, so that next use makes new ones.
(let ((symlist reftex-multifile-symbols)
(symbol nil))
(while symlist
(setq symbol (car symlist)
symlist (cdr symlist))
(set symbol nil))))
(defun reftex-TeX-master-file ()
;; Return the name of the master file associated with the current buffer.
;; When AUCTeX is loaded, we will use it's more sophisticated method.
;; We also support the default TeX and LaTeX modes by checking for a
;; variable tex-main-file.
(let
((master
(cond
((fboundp 'TeX-master-file) ; AUCTeX is loaded. Use its mechanism.
(condition-case nil
(TeX-master-file t)
(error (buffer-file-name))))
((fboundp 'tex-main-file) (tex-main-file)) ; Emacs LaTeX mode
((boundp 'TeX-master) ; The variable is defined - lets use it.
(cond
((eq TeX-master t)
(buffer-file-name))
((eq TeX-master 'shared)
(setq TeX-master (read-file-name "Master file: "
nil nil t nil)))
(TeX-master)
(t
(setq TeX-master (read-file-name "Master file: "
nil nil t nil)))))
((boundp 'tex-main-file)
;; This is the variable from the default TeX modes.
(cond
((stringp tex-main-file)
;; ok, this must be it
tex-main-file)
(t
;; In this case, the buffer is its own master.
(buffer-file-name))))
(t
;; Know nothing about master file. Assume this is a master file.
(buffer-file-name)))))
(cond
((null master)
(error "Need a filename for this buffer, please save it first"))
((or (file-exists-p (concat master ".tex"))
(reftex-get-buffer-visiting (concat master ".tex")))
;; Ahh, an extra .tex was missing...
(setq master (concat master ".tex")))
((or (file-exists-p master)
(reftex-get-buffer-visiting master))
;; We either see the file, or have a buffer on it. OK.
)
(t
;; Use buffer file name.
(setq master (buffer-file-name))))
(expand-file-name master)))
(defun reftex-is-multi ()
;; Tell if this is a multifile document. When not sure, say yes.
(let ((entry (assq 'is-multi (symbol-value reftex-docstruct-symbol))))
(if entry
(nth 1 entry)
t)))
(defun reftex-set-cite-format (value)
"Set the document-local value of `reftex-cite-format'.
When such a value exists, it overwrites the setting given with
`reftex-cite-format'. See the documentation of `reftex-cite-format'
for possible values. This function should be used from AUCTeX style files."
(unless reftex-docstruct-symbol
(reftex-tie-multifile-symbols))
(when (and reftex-docstruct-symbol
(symbolp reftex-docstruct-symbol))
(put reftex-docstruct-symbol 'reftex-cite-format value)))
(defun reftex-get-cite-format ()
;; Return the current citation format. Either the document-local value in
;; reftex-cite-format-symbol, or the global value in reftex-cite-format.
(if (and reftex-docstruct-symbol
(symbolp reftex-docstruct-symbol)
(get reftex-docstruct-symbol 'reftex-cite-format))
(get reftex-docstruct-symbol 'reftex-cite-format)
reftex-cite-format))
(defun reftex-add-index-macros (entry-list)
"Add index macro descriptions to `reftex-index-macros-style'.
The format of ENTRY-LIST is exactly like `reftex-index-macros'. See there
for details.
This function makes it possible to support RefTeX from AUCTeX style files.
The entries in ENTRY-LIST will be processed after the user settings in
`reftex-index-entries', and before the defaults. Any changes made to
`reftex-label-alist-style' will raise a flag to the effect that
the label information is recompiled on next use."
(unless reftex-docstruct-symbol
(reftex-tie-multifile-symbols))
(when (and reftex-docstruct-symbol
(symbolp reftex-docstruct-symbol))
(let ((list (get reftex-docstruct-symbol 'reftex-index-macros-style))
entry changed)
(while entry-list
(setq entry (pop entry-list))
;; When it is a symbol, remove all other symbols
(and (symbolp entry)
(not (memq entry list))
(setq list (reftex-remove-symbols-from-list list)))
;; Add to list unless already member
(unless (member entry list)
(setq reftex-tables-dirty t
changed t)
(push entry list)))
(when changed
(put reftex-docstruct-symbol 'reftex-index-macros-style list)))))
;;; =========================================================================
;;;
;;; Functions to compile the tables, reset the mode etc.
;; The following constants are derived from `reftex-label-alist'.
;; Prompt used for label type queries directed to the user.
(defvar reftex-type-query-prompt nil)
;; Help string for label type queries.
(defvar reftex-type-query-help nil)
;; Alist relating label type to reference format.
(defvar reftex-typekey-to-format-alist nil)
;; Alist relating label type to label prefix.
(defvar reftex-typekey-to-prefix-alist nil)
;; Alist relating environments or macros to label type and context regexp.
(defvar reftex-env-or-mac-alist nil)
;; List of special environment parser functions
(defvar reftex-special-env-parsers nil)
;; List of macros carrying a label.
(defvar reftex-label-mac-list nil)
;; List of environments carrying a label.
(defvar reftex-label-env-list nil)
;; List of all typekey letters in use.
(defvar reftex-typekey-list nil)
;; Alist relating magic words to a label type.
(defvar reftex-words-to-typekey-alist nil)
;; Alist relating label prefixes to a label type.
(defvar reftex-prefix-to-typekey-alist nil)
;; The last list-of-labels entry used in a reference.
(defvar reftex-last-used-reference (list nil nil nil nil))
;; Alist relating index macros to other info.
(defvar reftex-key-to-index-macro-alist nil)
;; Prompt for index macro queries
(defvar reftex-query-index-macro-prompt nil)
;; Help string for index macro queries
(defvar reftex-query-index-macro-help nil)
;; The message when follow-mode is suspended
(defvar reftex-no-follow-message
"No follow-mode into unvisited file. Press SPC to visit it.")
(defvar reftex-no-info-message
"%s: info not available, use `\\[reftex-view-crossref]' to get it.")
;; Global variables used for communication between functions.
(defvar reftex-default-context-position nil)
(defvar reftex-location-start nil)
(defvar reftex-call-back-to-this-buffer nil)
(defvar reftex-select-return-marker (make-marker))
(defvar reftex-active-toc nil)
(defvar reftex-tex-path nil)
(defvar reftex-bib-path nil)
(defvar reftex-select-marked nil)
(defvar reftex-last-follow-point nil)
(defvar reftex-latex-syntax-table nil)
(defvar reftex-prefix nil)
(defvar reftex-section-levels-all nil)
(defvar reftex-buffers-with-changed-invisibility nil)
(defvar reftex-callback-fwd t)
(defvar reftex-last-toc-master nil
"Stores the name of the tex file that `reftex-toc' was last run on.")
;; Marker for return point from recursive edit
(defvar reftex-recursive-edit-marker (make-marker))
;; List of buffers created temporarily for lookup, which should be killed.
(defvar reftex-buffers-to-kill nil)
;; Regexp to find anything.
(defvar reftex-section-regexp nil)
(defvar reftex-section-or-include-regexp nil)
(defvar reftex-index-macro-regexp nil)
(defvar reftex-index-level-re nil)
(defvar reftex-index-key-end-re nil)
(defvar reftex-find-index-entry-regexp-format nil)
(defvar reftex-everything-regexp nil)
(defvar reftex-everything-regexp-no-index nil)
(defvar reftex-index-re nil)
(defvar reftex-find-citation-regexp-format
"\\\\\\([a-zA-Z]*cite[*a-zA-Z]*\\*?\\|bibentry\\)\\(\\[[^]]*\\]\\|{[^}]*}\\)*{\\([^}]*,\\)?\\(%s\\)[},]")
(defvar reftex-find-reference-format
"\\\\\\(ref[a-zA-Z]*\\|[a-zA-Z]*ref\\(range\\)?\\)\\*?\\(\\[[^]]*\\]\\|{[^}]*}\\)*{\\(%s\\)}")
(defvar reftex-macros-with-labels nil)
(defvar reftex-macros-with-index nil)
(defvar reftex-index-macro-alist nil)
(defvar reftex-find-label-regexp-format nil)
(defvar reftex-find-label-regexp-format2 nil)
(defvar reftex-memory nil
"Memorizes old variable values to indicate changes in these variables.")
;; A list of all variables in the cache.
;; The cache is used to save the compiled versions of some variables.
(defconst reftex-cache-variables
'(reftex-memory ;; This MUST ALWAYS be the first!
;; Outline
reftex-section-levels-all
;; Labels
reftex-env-or-mac-alist
reftex-special-env-parsers
reftex-macros-with-labels
reftex-label-mac-list
reftex-label-env-list
reftex-typekey-list
reftex-typekey-to-format-alist
reftex-typekey-to-prefix-alist
reftex-words-to-typekey-alist
reftex-prefix-to-typekey-alist
reftex-type-query-prompt
reftex-type-query-help
;; Index
reftex-index-macro-alist
reftex-macros-with-index
reftex-query-index-macro-prompt
reftex-query-index-macro-help
reftex-key-to-index-macro-alist
;; Regular expressions
reftex-section-regexp
reftex-section-or-include-regexp
reftex-index-re
reftex-everything-regexp
reftex-everything-regexp-no-index
reftex-find-label-regexp-format
reftex-find-label-regexp-format2
reftex-find-index-entry-regexp-format
))
(defun reftex-ensure-compiled-variables ()
;; Recompile the label alist when necessary
(let* ((mem reftex-memory)
(cache (get reftex-docstruct-symbol 'reftex-cache))
(cmem (car cache))
(alist reftex-label-alist)
(levels (get reftex-docstruct-symbol 'reftex-section-levels))
(style (get reftex-docstruct-symbol 'reftex-label-alist-style))
(default reftex-default-label-alist-entries)
(index reftex-index-macros)
(istyle (get reftex-docstruct-symbol 'reftex-index-macros-style)))
(cond
(reftex-tables-dirty (reftex-compile-variables))
((and (eq alist (nth 0 mem))
(eq levels (nth 1 mem))
(eq style (nth 2 mem))
(eq default (nth 3 mem))
(eq index (nth 4 mem))
(eq istyle (nth 5 mem)))) ;; everything is OK
((and (eq alist (nth 0 cmem))
(eq levels (nth 1 cmem))
(eq style (nth 2 cmem))
(eq default (nth 2 cmem))
(eq index (nth 4 cmem))
(eq istyle (nth 5 cmem)))
;; restore the cache
(message "Restoring cache")
(mapcar (lambda (sym) (set sym (pop cache))) reftex-cache-variables))
(t (reftex-compile-variables)))))
(defun reftex-reset-mode ()
"Reset RefTeX Mode.
This will re-compile the configuration information and remove all
current scanning information and the parse file to enforce a rescan
on next use."
(interactive)
;; Reset the file search path variables
(loop for prop in '(status master-dir recursive-path rec-type) do
(put 'reftex-tex-path prop nil)
(put 'reftex-bib-path prop nil))
;; Kill temporary buffers associated with RefTeX - just in case they
;; were not cleaned up properly
(save-excursion
(let ((buffer-list '("*RefTeX Help*" "*RefTeX Select*"
"*Duplicate Labels*" "*toc*" " *RefTeX-scratch*"))
buf)
(while (setq buf (pop buffer-list))
(if (get-buffer buf)
(kill-buffer buf))))
(reftex-erase-all-selection-and-index-buffers))
;; Make sure the current document will be rescanned soon.
(reftex-reset-scanning-information)
;; Remove any parse info file
(reftex-access-parse-file 'kill)
;; Plug functions into AUCTeX if the user option says so.
(and reftex-plug-into-AUCTeX
(reftex-plug-into-AUCTeX))
(reftex-compile-variables))
;;;###autoload
(defun reftex-reset-scanning-information ()
"Reset the symbols containing information from buffer scanning.
This enforces rescanning the buffer on next use."
(if (string= reftex-last-toc-master (reftex-TeX-master-file))
(reftex-erase-buffer "*toc*"))
(let ((symlist reftex-multifile-symbols)
symbol)
(while symlist
(setq symbol (car symlist)
symlist (cdr symlist))
(if (and (symbolp (symbol-value symbol))
(not (null (symbol-value symbol))))
(set (symbol-value symbol) nil)))))
(defun reftex-erase-all-selection-and-index-buffers ()
;; Remove all selection buffers associated with current document.
(mapcar
(lambda (type)
(reftex-erase-buffer (reftex-make-selection-buffer-name type)))
reftex-typekey-list)
;; Kill all index buffers
(mapcar
(lambda (tag)
(reftex-kill-buffer (reftex-make-index-buffer-name tag)))
(cdr (assoc 'index-tags (symbol-value reftex-docstruct-symbol)))))
(defun reftex-compile-variables ()
;; Compile the information in reftex-label-alist & Co.
(message "Compiling label environment definitions...")
;; Update AUCTeX style information
(when (and (featurep 'tex-site) (fboundp 'TeX-update-style))
(condition-case nil (TeX-update-style) (error nil)))
;; Record that we have done this, and what we have used.
(setq reftex-tables-dirty nil)
(setq reftex-memory
(list reftex-label-alist
(get reftex-docstruct-symbol 'reftex-section-levels)
(get reftex-docstruct-symbol 'reftex-label-alist-style)
reftex-default-label-alist-entries
reftex-index-macros
(get reftex-docstruct-symbol 'reftex-index-macros-style)))
;; Compile information in reftex-label-alist
(let ((all (reftex-uniquify-by-car
(reftex-splice-symbols-into-list
(append reftex-label-alist
(get reftex-docstruct-symbol
'reftex-label-alist-style)
reftex-default-label-alist-entries)
reftex-label-alist-builtin)
'(nil)))
(all-index (reftex-uniquify-by-car
(reftex-splice-symbols-into-list
(append reftex-index-macros
(get reftex-docstruct-symbol
'reftex-index-macros-style)
'(default))
reftex-index-macros-builtin)))
entry env-or-mac typekeychar typekey prefix context word
fmt reffmt labelfmt wordlist qh-list macros-with-labels
nargs nlabel opt-args cell sum i
macro verify repeat nindex tag key toc-level toc-levels)
(setq reftex-words-to-typekey-alist nil
reftex-prefix-to-typekey-alist
'(("sec:" . "s") ("cha:" . "s") ("chap:" . "s"))
reftex-typekey-list nil
reftex-typekey-to-format-alist nil
reftex-typekey-to-prefix-alist nil
reftex-env-or-mac-alist nil
reftex-label-env-list nil
reftex-label-mac-list nil)
(while all
(catch 'next-entry
(setq entry (car all)
env-or-mac (car entry)
entry (cdr entry)
all (cdr all))
(if (null env-or-mac)
(setq env-or-mac ""))
(if (stringp (car entry))
;; This is before version 2.00 - convert entry to new format
;; This is just to keep old users happy
(setq entry (cons (string-to-char (car entry))
(cons (concat (car entry) ":")
(cdr entry)))))
(setq typekeychar (nth 0 entry)
typekey (if typekeychar (char-to-string typekeychar) nil)
prefix (nth 1 entry)
fmt (nth 2 entry)
context (nth 3 entry)
wordlist (nth 4 entry)
toc-level (nth 5 entry))
(if (stringp wordlist)
;; This is before version 2.04 - convert to new format
(setq wordlist (nthcdr 4 entry)))
(if (and (stringp fmt)
(string-match "@" fmt))
;; Special syntax for specifying a label format
(setq fmt (split-string fmt "@+"))
(setq fmt (list "\\label{%s}" fmt)))
(setq labelfmt (car fmt)
reffmt (nth 1 fmt))
;; Note a new typekey
(if typekey
(add-to-list 'reftex-typekey-list typekey))
(if (and typekey prefix
(not (assoc prefix reftex-prefix-to-typekey-alist)))
(add-to-list 'reftex-prefix-to-typekey-alist
(cons prefix typekey)))
(if (and typekey prefix
(not (assoc typekey reftex-typekey-to-prefix-alist)))
(add-to-list 'reftex-typekey-to-prefix-alist
(cons typekey prefix)))
;; Check if this is a macro or environment
(cond
((symbolp env-or-mac)
;; A special parser function
(unless (fboundp env-or-mac)
(message "Warning: %s does not seem to be a valid function"
env-or-mac))
(setq nargs nil nlabel nil opt-args nil)
(add-to-list 'reftex-special-env-parsers env-or-mac)
(setq env-or-mac (symbol-name env-or-mac)))
((string-match "\\`\\\\" env-or-mac)
;; It's a macro
(let ((result (reftex-parse-args env-or-mac)))
(setq env-or-mac (or (first result) env-or-mac)
nargs (second result)
nlabel (third result)
opt-args (fourth result))
(if nlabel (add-to-list 'macros-with-labels env-or-mac)))
(if typekey (add-to-list 'reftex-label-mac-list env-or-mac)))
(t
;; It's an environment
(setq nargs nil nlabel nil opt-args nil)
(cond ((string= env-or-mac "any"))
((string= env-or-mac ""))
((string= env-or-mac "section"))
(t
(add-to-list 'reftex-label-env-list env-or-mac)
(if toc-level
(let ((string (format "begin{%s}" env-or-mac)))
(or (assoc string toc-levels)
(push (cons string toc-level) toc-levels))))))))
;; Translate some special context cases
(when (assq context reftex-default-context-regexps)
(setq context
(format
(cdr (assq context reftex-default-context-regexps))
(regexp-quote env-or-mac))))
;; See if this is the first format for this typekey
(and reffmt
(not (assoc typekey reftex-typekey-to-format-alist))
(push (cons typekey reffmt) reftex-typekey-to-format-alist))
;; See if this is the first definition for this env-or-mac
(and (not (string= env-or-mac "any"))
(not (string= env-or-mac ""))
(not (assoc env-or-mac reftex-env-or-mac-alist))
(push (list env-or-mac typekey context labelfmt
nargs nlabel opt-args)
reftex-env-or-mac-alist))
;; Are the magic words regular expressions? Quote normal words.
(if (eq (car wordlist) 'regexp)
(setq wordlist (cdr wordlist))
(setq wordlist (mapcar 'regexp-quote wordlist)))
;; Remember the first association of each word.
(while (stringp (setq word (pop wordlist)))
(or (assoc word reftex-words-to-typekey-alist)
(push (cons word typekey) reftex-words-to-typekey-alist)))
(cond
((string= "" env-or-mac) nil)
((setq cell (assoc typekey qh-list))
(push env-or-mac (cdr cell)))
(typekey
(push (list typekey env-or-mac) qh-list)))))
(setq reftex-typekey-to-prefix-alist
(nreverse reftex-typekey-to-prefix-alist))
;; Prepare the typekey query prompt and help string.
(setq qh-list
(sort qh-list
(lambda (x1 x2)
(string< (downcase (car x1)) (downcase (car x2))))))
(setq reftex-type-query-prompt
(concat "Label type: ["
(mapconcat (lambda(x) (format "%s" (car x)))
qh-list "")
"]"))
;; In the help string, we need to wrap lines...
(setq reftex-type-query-help
(concat
"SELECT A LABEL TYPE:\n--------------------\n"
(mapconcat
(lambda(x)
(setq sum 0)
(format " [%s] %s"
(car x)
(mapconcat (lambda(env)
(setq sum (+ sum (length env)))
(if (< sum 60)
env
(setq sum 0)
(concat "\n " env)))
(cdr x) " ")))
qh-list "\n")))
;; Convert magic words to regular expressions. We make regular expressions
;; which allow for some chars from the ref format to be in the buffer.
;; These characters will be seen and removed.
(setq reftex-words-to-typekey-alist
(mapcar
(lambda (x)
(setq word (car x)
typekey (cdr x)
fmt (cdr (assoc typekey reftex-typekey-to-format-alist)))
(setq word (concat "\\W\\(" word "[ \t\n\r]*\\)\\("))
(setq i 0)
(while (and (< i 10) ; maximum number of format chars allowed
(< i (length fmt))
(not (member (aref fmt i) '(?%))))
(setq word (concat word "\\|" (regexp-quote
(substring fmt 0 (1+ i)))))
(incf i))
(cons (concat word "\\)\\=") typekey))
(nreverse reftex-words-to-typekey-alist)))
;; Parse the index macros
(setq reftex-index-macro-alist nil
reftex-key-to-index-macro-alist nil
reftex-macros-with-index nil)
(while all-index
(setq entry (car all-index)
macro (car entry)
tag (nth 1 entry)
key (nth 2 entry)
prefix (or (nth 3 entry) "")
verify (nth 4 entry)
;; For repeat, we need to be compatible with older code
;; This information used to be given only for the default macro,
;; but later we required to have it for *every* index macro
repeat (cond ((> (length entry) 5) (nth 5 entry))
((and (eq key (car reftex-index-default-macro))
(> (length reftex-index-default-macro) 2))
;; User has old setting - respect it
(nth 2 reftex-index-default-macro))
(t t))
all-index (cdr all-index))
(let ((result (reftex-parse-args macro)))
(setq macro (or (first result) macro)
nargs (second result)
nindex (third result)
opt-args (fourth result))
(unless (member macro reftex-macros-with-index)
;; 0 1 2 3 4 5 6 7
(push (list macro tag prefix verify nargs nindex opt-args repeat)
reftex-index-macro-alist)
(or (assoc key reftex-key-to-index-macro-alist)
(push (list key macro) reftex-key-to-index-macro-alist))
(push macro reftex-macros-with-index))))
;; Make the prompt and help string for index macros query
(setq reftex-key-to-index-macro-alist
(sort reftex-key-to-index-macro-alist
(lambda (a b) (< (downcase (car a)) (downcase (car b))))))
(setq reftex-query-index-macro-prompt
(concat "Index macro: ["
(mapconcat (lambda (x) (char-to-string (car x)))
reftex-key-to-index-macro-alist "")
"]"))
(setq i 0
reftex-query-index-macro-help
(concat
"SELECT A MACRO:\n---------------\n"
(mapconcat
(lambda(x)
(format "[%c] %-20.20s%s" (car x) (nth 1 x)
(if (= 0 (mod (incf i) 3)) "\n" "")))
reftex-key-to-index-macro-alist "")))
;; Make the full list of section levels
(setq reftex-section-levels-all
(append toc-levels
(get reftex-docstruct-symbol 'reftex-section-levels)
reftex-section-levels))
;; Calculate the regular expressions
(let* (
; (wbol "\\(\\`\\|[\n\r]\\)[ \t]*")
(wbol "\\(^\\)[ \t]*") ; Need to keep the empty group because
;;; because match number are hard coded
(label-re "\\\\label{\\([^}]*\\)}")
(include-re (concat wbol
"\\\\\\("
(mapconcat 'identity
reftex-include-file-commands "\\|")
"\\)[{ \t]+\\([^} \t\n\r]+\\)"))
(section-re
(concat wbol "\\\\\\("
(mapconcat (lambda (x) (regexp-quote (car x)))
reftex-section-levels-all "\\|")
"\\)\\*?\\(\\[[^]]*\\]\\)?[[{ \t\r\n]"))
(appendix-re (concat wbol "\\(\\\\appendix\\)"))
(macro-re
(if macros-with-labels
(concat "\\("
(mapconcat 'regexp-quote macros-with-labels "\\|")
"\\)[[{]")
""))
(index-re
(concat "\\("
(mapconcat 'regexp-quote reftex-macros-with-index "\\|")
"\\)[[{]"))
(find-index-re-format
(concat "\\("
(mapconcat 'regexp-quote reftex-macros-with-index "\\|")
"\\)\\([[{][^]}]*[]}]\\)*[[{]\\(%s\\)[]}]"))
(find-label-re-format
(concat "\\("
(mapconcat 'regexp-quote (append '("\\label")
macros-with-labels) "\\|")
"\\)\\([[{][^]}]*[]}]\\)*[[{]\\(%s\\)[]}]"))
(index-level-re
(regexp-quote (nth 0 reftex-index-special-chars)))
(index-key-end-re ;; ^]- not allowed
(concat "[^" (nth 3 reftex-index-special-chars) "]"
"[" (nth 1 reftex-index-special-chars)
(nth 2 reftex-index-special-chars) "]"))
)
(setq reftex-section-regexp section-re
reftex-section-or-include-regexp
(concat section-re "\\|" include-re)
reftex-everything-regexp
(concat label-re "\\|" section-re "\\|" include-re
"\\|" appendix-re
"\\|" index-re
(if macros-with-labels "\\|" "") macro-re)
reftex-everything-regexp-no-index
(concat label-re "\\|" section-re "\\|" include-re
"\\|" appendix-re
"\\|" "\\(\\\\6\\\\3\\\\1\\)" ; This is unlikely to match
(if macros-with-labels "\\|" "") macro-re)
reftex-index-re index-re
reftex-index-level-re index-level-re
reftex-index-key-end-re index-key-end-re
reftex-macros-with-labels macros-with-labels
reftex-find-index-entry-regexp-format find-index-re-format
reftex-find-label-regexp-format find-label-re-format
reftex-find-label-regexp-format2
"\\([]} \t\n\r]\\)\\([[{]\\)\\(%s\\)[]}]")
(message "Compiling label environment definitions...done")))
(put reftex-docstruct-symbol 'reftex-cache
(mapcar 'symbol-value reftex-cache-variables)))
(defun reftex-parse-args (macro)
;; Return a list of macro name, nargs, arg-nr which is label and a list of
;; optional argument indices.
(if (string-match "[[{]\\*?[]}]" macro)
(progn
(let ((must-match (substring macro 0 (match-beginning 0)))
(args (substring macro (match-beginning 0)))
opt-list nlabel (cnt 0))
(while (string-match "\\`[[{]\\(\\*\\)?[]}]" args)
(incf cnt)
(when (eq ?\[ (string-to-char args))
(push cnt opt-list))
(when (and (match-end 1)
(not nlabel))
(setq nlabel cnt))
(setq args (substring args (match-end 0))))
(list must-match cnt nlabel opt-list)))
nil))
;;; =========================================================================
;;;
;;; Accessing the parse information
(defun reftex-access-scan-info (&optional rescan file)
"Ensure access to the scanning info for the current file."
;; When the multifile symbols are not yet tied,
;; tie them. When they are empty or RESCAN is non-nil, scan the document.
;; But, when RESCAN is -1, don't rescan even if docstruct is empty.
;; When FILE is non-nil, parse only from that file.
;; Error out in a buffer without a file.
(if (and reftex-mode
(not (buffer-file-name)))
(error "RefTeX works only in buffers visiting a file"))
;; Make sure we have the symbols tied
(if (eq reftex-docstruct-symbol nil)
;; Symbols are not yet tied: Tie them.
(reftex-tie-multifile-symbols))
(reftex-ensure-compiled-variables)
(when (or (null (symbol-value reftex-docstruct-symbol))
(member rescan '(t 1 (4) (16))))
;; The docstruct will change: Remove selection buffers.
(save-excursion
(reftex-erase-buffer "*toc*")
(reftex-erase-all-selection-and-index-buffers)))
(if (and (null (symbol-value reftex-docstruct-symbol))
(not (member rescan '(t 1 (4) (16))))
reftex-save-parse-info)
;; Try to read the stuff from a file
(reftex-access-parse-file 'read))
(cond
((equal rescan -1)) ;; We are not allowed to scan.
((not (symbol-value reftex-docstruct-symbol))
;; Scan the whole document
(reftex-do-parse 1 file))
((member rescan '(t 1 (4) (16)))
;; Scan whatever was required by the caller.
(reftex-do-parse rescan file))))
(defun reftex-scanning-info-available-p ()
"Is the scanning info about the current document available?"
(unless reftex-docstruct-symbol
(reftex-tie-multifile-symbols))
(and (symbolp reftex-docstruct-symbol)
(symbol-value reftex-docstruct-symbol)
t))
(defun reftex-silence-toc-markers (list n)
;; Set all toc markers in the first N entries in list to nil
(while (and list (> (decf n) -1))
(and (eq (car (car list)) 'toc)
(markerp (nth 4 (car list)))
(set-marker (nth 4 (car list)) nil))
(pop list)))
(defun reftex-access-parse-file (action)
"Perform ACTION on the parse file (the .rel file).
Valid actions are: readable, restore, read, kill, write."
(let* ((list (symbol-value reftex-docstruct-symbol))
(docstruct-symbol reftex-docstruct-symbol)
(master (reftex-TeX-master-file))
(enable-local-variables nil)
(file (if (string-match "\\.[a-zA-Z]+\\'" master)
(concat (substring master 0 (match-beginning 0))
reftex-parse-file-extension)
(concat master reftex-parse-file-extension))))
(cond
((eq action 'readable)
(file-readable-p file))
((eq action 'restore)
(put reftex-docstruct-symbol 'modified nil)
(if (eq reftex-docstruct-symbol nil)
;; Symbols are not yet tied: Tie them.
(reftex-tie-multifile-symbols))
(if (file-exists-p file)
;; load the file and return t for success
(condition-case nil
(progn (load-file file) t)
(error (set reftex-docstruct-symbol nil)
(error "Error while loading file %s" file)))
;; Throw an exception if the file does not exist
(error "No restore file %s" file)))
((eq action 'read)
(put reftex-docstruct-symbol 'modified nil)
(if (file-exists-p file)
;; load the file and return t for success
(condition-case nil
(progn
(load-file file)
(reftex-check-parse-consistency)
t)
(error (message "Error while restoring file %s" file)
(set reftex-docstruct-symbol nil)
nil))
;; return nil for failure, but no exception
nil))
((eq action 'kill)
;; Remove the file
(when (and (file-exists-p file) (file-writable-p file))
(message "Unlinking file %s" file)
(delete-file file)))
(t
(put docstruct-symbol 'modified nil)
(save-excursion
(if (file-writable-p file)
(progn
(message "Writing parse file %s" (abbreviate-file-name file))
(find-file file)
(erase-buffer)
(insert (format " (insert (format ";; File: %s\n" master))
(insert (format ";; User: %s (%s)\n\n"
(user-login-name) (user-full-name)))
(insert "(set reftex-docstruct-symbol '(\n\n")
(let ((standard-output (current-buffer)))
(mapcar
(lambda (x)
(cond ((eq (car x) 'toc)
(print (list 'toc "toc" (nth 2 x) (nth 3 x)
nil (nth 5 x) (nth 6 x) (nth 7 x)
(or (and (markerp (nth 4 x))
(marker-position (nth 4 x)))
(nth 8 x)))))
((and (not (eq t reftex-support-index))
(eq (car x) 'index))
)
(t (print x))))
list))
(insert "))\n\n")
(save-buffer 0)
(kill-buffer (current-buffer)))
(error "Cannot write to file %s" file)))
t))))
(defun reftex-check-parse-consistency ()
(let* ((real-master (reftex-TeX-master-file))
(parsed-master
(nth 1 (assq 'bof (symbol-value reftex-docstruct-symbol)))))
(unless (string= (file-truename real-master) (file-truename parsed-master))
(message "Master file name in load file is different: %s versus %s"
parsed-master real-master)
(error "Master file name error")))
)
(defun reftex-select-external-document (xr-alist xr-index)
(let* ((len (length xr-alist)) (highest (1- (+ ?0 len)))
(prompt (format "[%c-%c] Select TAB: Read prefix with completion"
?0 highest))
key prefix)
(cond
((= len 1)
(message "No external documents available")
(ding) (sit-for 1) 0)
((= len 2)
(- 1 xr-index))
(t
(save-excursion
(let* ((length (apply 'max (mapcar
(lambda(x) (length (car x))) xr-alist)))
(fmt (format " [%%c] %%-%ds %%s\n" length))
(n (1- ?0)))
(setq key
(reftex-select-with-char
prompt
(concat
"SELECT EXTERNAL DOCUMENT\n------------------------\n"
(mapconcat
(lambda (x)
(format fmt (incf n) (or (car x) "")
(abbreviate-file-name (cdr x))))
xr-alist ""))
nil t))
(cond
((and (>= key ?0) (<= key highest)) (- key ?0))
((= key ?\C-i)
(setq prefix (completing-read "Prefix: " xr-alist nil t))
(- len (length (memq (assoc prefix xr-alist) xr-alist))))
(t (error "Invalid document selection [%c]" key)))))))))
(defun reftex-locate-file (file type master-dir &optional die)
"Find FILE of type TYPE in MASTER-DIR or on the path associcted with TYPE.
If the file does not have any of the valid extensions for TYPE,
try first the default extension and only then the naked file name.
When DIE is non-nil, throw an error if file not found."
(let* ((rec-values (if reftex-search-unrecursed-path-first '(nil t) '(t)))
(extensions (cdr (assoc type reftex-file-extensions)))
(def-ext (car extensions))
(ext-re (concat "\\("
(mapconcat 'regexp-quote extensions "\\|")
"\\)\\'"))
(files (if (string-match ext-re file)
(cons file nil)
(if reftex-try-all-extensions
(append (mapcar (lambda (x) (concat file x))
extensions)
(list file))
(list (concat file def-ext) file))))
path old-path file1 f fs)
(cond
((file-name-absolute-p file)
(while (setq f (pop files))
(if (file-regular-p f)
(setq file1 f files nil))))
((and reftex-use-external-file-finders
(assoc type reftex-external-file-finders))
(setq file1 (reftex-find-file-externally file type master-dir)))
(t
(while (and (null file1) rec-values)
(setq path (reftex-access-search-path
type (pop rec-values) master-dir file))
(setq fs files)
(while (and (null file1) (setq f (pop fs)))
(when (or (null old-path)
(not (eq old-path path)))
(setq old-path path
path (cons master-dir path))
(setq file1 (reftex-find-file-on-path f path master-dir)))))))
(cond (file1 file1)
(die (error "No such file: %s" file) nil)
(t (message "No such file: %s (ignored)" file) nil))))
(defun reftex-find-file-externally (file type &optional master-dir)
(let ((default-directory (or master-dir default-directory))
(prg (cdr (assoc type reftex-external-file-finders)))
out)
(if (string-match "%f" prg)
(setq prg (replace-match file t t prg)))
(setq out (apply 'reftex-process-string (split-string prg)))
(if (string-match "[ \t\n]+\\'" out) (setq out (replace-match "" nil nil out)))
(cond ((equal out "") nil)
((file-regular-p out) (expand-file-name out master-dir))
(t nil))))
(defun reftex-process-string (program &rest args)
"Execute PROGRAM with arguments ARGS and return its STDOUT as a string."
(let ((calling-dir default-directory)) (with-output-to-string
(with-current-buffer standard-output
(let ((default-directory calling-dir)) (apply 'call-process program nil '(t nil) nil args))))))
(defun reftex-access-search-path (type &optional recurse master-dir file)
(let* ((pathvar (intern (concat "reftex-" type "-path"))))
(when (null (get pathvar 'status))
(set pathvar
(reftex-uniquify
(reftex-parse-colon-path
(mapconcat
(lambda(x)
(if (string-match "^!" x)
(apply 'reftex-process-string
(split-string (substring x 1)))
(or (getenv x) x)))
(symbol-value (intern (concat "reftex-" type
"path-environment-variables")))
path-separator))))
(put pathvar 'status 'split)
(let ((path (symbol-value pathvar)) dir rec)
(while (setq dir (pop path))
(when (string= (substring dir -2) "//")
(if (file-name-absolute-p dir)
(setq rec (or rec 'absolute))
(setq rec 'relative))))
(put pathvar 'rec-type rec)))
(if recurse
(cond
((not (get pathvar 'rec-type))
(symbol-value pathvar))
((or (not (get pathvar 'recursive-path))
(and (eq (get pathvar 'rec-type) 'relative)
(not (equal master-dir (get pathvar 'master-dir)))))
(message "Expanding search path to find %s file: %s ..." type file)
(put pathvar 'recursive-path
(reftex-expand-path (symbol-value pathvar) master-dir))
(put pathvar 'master-dir master-dir)
(get pathvar 'recursive-path))
(t
(get pathvar 'recursive-path)))
(symbol-value pathvar))))
(defun reftex-find-file-on-path (file path &optional def-dir)
(catch 'exit
(when (file-name-absolute-p file)
(if (file-regular-p file)
(throw 'exit file)
(throw 'exit nil)))
(let* ((thepath path) file1 dir)
(while (setq dir (pop thepath))
(when (string= (substring dir -2) "//")
(setq dir (substring dir 0 -1)))
(setq file1 (expand-file-name file (expand-file-name dir def-dir)))
(if (file-regular-p file1)
(throw 'exit file1)))
nil)))
(defun reftex-parse-colon-path (path)
(mapcar
(lambda (dir)
(if (string-match "\\(//+\\|/*!+\\)\\'" dir)
(setq dir (replace-match "//" t t dir)))
(file-name-as-directory dir))
(delete "" (split-string path (concat path-separator "+")))))
(defun reftex-expand-path (path &optional default-dir)
(let (path1 dir recursive)
(while (setq dir (pop path))
(if (setq recursive (string= (substring dir -2) "//"))
(setq dir (substring dir 0 -1)))
(if (and recursive
(not (file-name-absolute-p dir)))
(setq dir (expand-file-name dir default-dir)))
(if recursive
(setq path1 (append (reftex-recursive-directory-list dir) path1))
(push dir path1)))
(nreverse path1)))
(defun reftex-recursive-directory-list (dir)
(let ((path (list dir)) path1 file files)
(while (setq dir (pop path))
(when (file-directory-p dir)
(setq files (nreverse (directory-files dir t "[^.]")))
(while (setq file (pop files))
(if (file-directory-p file)
(push (file-name-as-directory file) path)))
(push dir path1)))
path1))
(autoload 'reftex-parse-one "reftex-parse"
"Re-parse this file." t)
(autoload 'reftex-parse-all "reftex-parse"
"Re-parse entire document." t)
(autoload 'reftex-do-parse "reftex-parse")
(autoload 'reftex-where-am-I "reftex-parse")
(autoload 'reftex-init-section-numbers "reftex-parse")
(autoload 'reftex-section-info "reftex-parse")
(autoload 'reftex-section-number "reftex-parse")
(autoload 'reftex-what-macro "reftex-parse")
(autoload 'reftex-what-macro-safe "reftex-parse")
(autoload 'reftex-index-info "reftex-parse")
(autoload 'reftex-index-info-safe "reftex-parse")
(autoload 'reftex-short-context "reftex-parse")
(autoload 'reftex-what-environment "reftex-parse")
(autoload 'reftex-what-special-env "reftex-parse")
(autoload 'reftex-move-over-touching-args "reftex-parse")
(autoload 'reftex-notice-new "reftex-parse")
(autoload 'reftex-nth-arg "reftex-parse")
(autoload 'reftex-locate-bibliography-files "reftex-parse")
(autoload 'reftex-ensure-index-support "reftex-parse")
(autoload 'reftex-everything-regexp "reftex-parse")
(autoload 'reftex-label-location "reftex-ref")
(autoload 'reftex-label-info-update "reftex-ref")
(autoload 'reftex-label-info "reftex-ref")
(autoload 'reftex-label "reftex-ref"
"Insert a unique label." t)
(autoload 'reftex-reference "reftex-ref"
"Make a LaTeX reference." t)
(autoload 'reftex-varioref-vref "reftex-ref"
"Make a varioref reference." t)
(autoload 'reftex-fancyref-fref "reftex-ref"
"Make a fancyref \\fref reference." t)
(autoload 'reftex-fancyref-Fref "reftex-ref"
"Make a fancyref \\Fref reference." t)
(autoload 'reftex-show-label-location "reftex-ref")
(autoload 'reftex-query-label-type "reftex-ref")
(autoload 'reftex-goto-label "reftex-ref"
"Prompt for label name and go to that location." t)
(autoload 'reftex-toc "reftex-toc"
"Show the table of contents for the current document." t)
(autoload 'reftex-toc-recenter "reftex-toc"
"Display the TOC window and highlight line corresponding to current position." t)
(autoload 'reftex-toggle-auto-toc-recenter "reftex-toc"
"Toggle automatic recentering of TOC window." t)
(autoload 'reftex-citep "reftex-cite")
(autoload 'reftex-citet "reftex-cite")
(autoload 'reftex-make-cite-echo-string "reftex-cite")
(autoload 'reftex-get-bibfile-list "reftex-cite")
(autoload 'reftex-pop-to-bibtex-entry "reftex-cite")
(autoload 'reftex-end-of-bib-entry "reftex-cite")
(autoload 'reftex-parse-bibtex-entry "reftex-cite")
(autoload 'reftex-citation "reftex-cite"
"Make a citation using BibTeX database files." t)
(autoload 'reftex-default-bibliography "reftex-cite")
(autoload 'reftex-bib-or-thebib "reftex-cite")
(autoload 'reftex-create-bibtex-file "reftex-cite")
(autoload 'reftex-select-label-mode "reftex-sel")
(autoload 'reftex-select-bib-mode "reftex-sel")
(autoload 'reftex-find-start-point "reftex-sel")
(autoload 'reftex-insert-docstruct "reftex-sel")
(autoload 'reftex-get-offset "reftex-sel")
(autoload 'reftex-select-item "reftex-sel")
(autoload 'reftex-index "reftex-index"
"Query for an index macro and insert it along with its argments." t)
(autoload 'reftex-index-selection-or-word "reftex-index"
"Put selection or the word near point into the default index macro." t)
(autoload 'reftex-index-phrase-selection-or-word "reftex-index"
"Put selection or the word near point into Index Phrases File." t)
(autoload 'reftex-display-index "reftex-index"
"Display a buffer with an index compiled from the current document." t)
(autoload 'reftex-index-visit-phrases-buffer "reftex-index"
"Visit the Index Phrases File." t)
(autoload 'reftex-index-phrases-mode "reftex-index"
"Major mode for managing the Index phrases of a LaTeX document." t)
(autoload 'reftex-index-complete-tag "reftex-index")
(autoload 'reftex-index-complete-key "reftex-index")
(autoload 'reftex-index-show-entry "reftex-index")
(autoload 'reftex-index-select-tag "reftex-index")
(autoload 'reftex-view-crossref "reftex-dcr"
"View cross reference of \\ref or \\cite macro at point." t)
(autoload 'reftex-mouse-view-crossref "reftex-dcr"
"View cross reference of \\ref or \\cite macro where you click." t)
(autoload 'reftex-toggle-auto-view-crossref "reftex-dcr")
(autoload 'reftex-view-crossref-from-bibtex "reftex-dcr"
"View location in a LaTeX document which cites the BibTeX entry at point." t)
(autoload 'reftex-create-tags-file "reftex-global"
"Create TAGS file by running `etags' on the current document." t)
(autoload 'reftex-grep-document "reftex-global"
"Run grep query through all files related to this document." t)
(autoload 'reftex-search-document "reftex-global"
"Regexp search through all files of the current TeX document." t)
(autoload 'reftex-query-replace-document "reftex-global"
"Run a query-replace-regexp of FROM with TO over the entire TeX document." t)
(autoload 'reftex-find-duplicate-labels "reftex-global"
"Produce a list of all duplicate labels in the document." t)
(autoload 'reftex-change-label "reftex-global"
"Query replace FROM with TO in all \\label and \\ref commands." t)
(autoload 'reftex-renumber-simple-labels "reftex-global"
"Renumber all simple labels in the document to make them sequentially." t)
(autoload 'reftex-save-all-document-buffers "reftex-global"
"Save all documents associated with the current document." t)
(autoload 'reftex-arg-label "reftex-auc")
(autoload 'reftex-arg-cite "reftex-auc")
(autoload 'reftex-arg-index-tag "reftex-auc")
(autoload 'reftex-arg-index "reftex-auc")
(autoload 'reftex-plug-into-AUCTeX "reftex-auc")
(autoload 'reftex-toggle-plug-into-AUCTeX "reftex-auc"
"Toggle Interface between AUCTeX and RefTeX on and off." t)
(autoload 'reftex-add-label-environments "reftex-auc")
(autoload 'reftex-add-to-label-alist "reftex-auc")
(autoload 'reftex-add-section-levels "reftex-auc")
(autoload 'reftex-notice-new-section "reftex-auc")
(defun reftex-typekey-check (typekey conf-variable &optional n)
(and n (setq conf-variable (nth n conf-variable)))
(or (eq conf-variable t)
(and (stringp conf-variable)
(string-match (concat "[" conf-variable "]") typekey))))
(defun reftex-check-recursive-edit ()
(if (marker-position reftex-recursive-edit-marker)
(error
(substitute-command-keys
"In unfinished selection process. Finish, or abort with \\[abort-recursive-edit]"))))
(defun reftex-in-comment ()
(save-excursion
(skip-chars-backward "^%\n\r")
(eq (preceding-char) ?%)))
(defun reftex-no-props (string)
(and (stringp string)
(set-text-properties 0 (length string) nil string))
string)
(defun reftex-match-string (n)
(when (match-beginning n)
(buffer-substring-no-properties (match-beginning n) (match-end n))))
(defun reftex-region-active-p ()
"Is transient-mark-mode on and the region active?
Works on both Emacs and XEmacs."
(if (featurep 'xemacs)
(and zmacs-regions (region-active-p))
(and transient-mark-mode mark-active)))
(defun reftex-kill-buffer (buffer)
(and (setq buffer (get-buffer buffer))
(kill-buffer buffer)))
(defun reftex-erase-buffer (&optional buffer)
(cond
((null buffer)
(let ((buffer-read-only nil)) (erase-buffer)))
((setq buffer (get-buffer buffer))
(save-excursion
(set-buffer buffer)
(let ((buffer-read-only nil)) (erase-buffer))))))
(defun reftex-this-word (&optional class)
(setq class (or class "-a-zA-Z0-9:_/.*;|"))
(save-excursion
(buffer-substring-no-properties
(progn (skip-chars-backward class) (point))
(progn (skip-chars-forward class) (point)))))
(defun reftex-number (n unit &optional ending)
(if (and (integerp n) (stringp unit))
(format "%d %s%s" n unit (if (= n 1) "" (or ending "s")))
""))
(defun reftex-all-assq (key list)
(let (rtn)
(while (setq list (memq (assq key list) list))
(push (car list) rtn)
(pop list))
(nreverse rtn)))
(defun reftex-all-assoc-string (key list)
(let (rtn)
(while list
(if (string= (car (car list)) key)
(push (car list) rtn))
(pop list))
(nreverse rtn)))
(defun reftex-last-assoc-before-elt (key elt list &optional exclusive)
(let* ((elt (car (member elt list))) (ex (not exclusive)) ass last-ass)
(while (and (setq ass (assoc key list))
(setq list (memq ass list))
(or ex (not (eq elt (car list))))
(memq elt list))
(setq last-ass ass
list (cdr list)))
last-ass))
(defun reftex-sublist-nth (list nth predicate &optional completion)
(let (rtn)
(while list
(if (funcall predicate (car list))
(push (if completion
(list (nth nth (car list)))
(nth nth (car list)))
rtn))
(setq list (cdr list)))
(nreverse rtn)))
(defun reftex-make-selection-buffer-name (type &optional index)
(format " *RefTeX[%s][%d]*"
type (or index (get reftex-docstruct-symbol :master-index) 0)))
(defun reftex-make-index-buffer-name (tag &optional cnt)
(format "*Index[%s][%d]*"
tag (or cnt (get reftex-docstruct-symbol :master-index) 0)))
(defun reftex-truncate (string ncols &optional ellipses padding)
(setq string
(if (<= (length string) ncols)
string
(if ellipses
(concat (substring string 0 (- ncols 3)) "...")
(substring string 0 ncols))))
(if padding
(format (format "%%-%ds" ncols) string)
string))
(defun reftex-nearest-match (regexp &optional max-length)
(let ((pos (point))
(dist (or max-length (length regexp)))
match1 match2 match)
(goto-char (min (+ pos dist) (point-max)))
(when (re-search-backward regexp nil t)
(setq match1 (match-data)))
(goto-char (max (- pos dist) (point-min)))
(when (re-search-forward regexp nil t)
(setq match2 (match-data)))
(goto-char pos)
(setq match
(cond
((not match1) match2)
((not match2) match1)
((< (abs (- pos (car match1))) (abs (- pos (car match2)))) match1)
(t match2)))
(if match (progn (set-match-data match) t) nil)))
(defun reftex-auto-mode-alist ()
(let ((alist auto-mode-alist)
out)
(while alist
(when (listp (cdr (car alist)))
(push (car alist) out))
(pop alist))
(nreverse out)))
(defun reftex-window-height ()
(if (fboundp 'window-displayed-height)
(window-displayed-height)
(window-height)))
(defun reftex-enlarge-to-fit (buf2 &optional keep-current)
(let* ((win1 (selected-window))
(buf1 (current-buffer))
(win2 (get-buffer-window buf2))) (when win2
(select-window win2)
(unless (and (pos-visible-in-window-p (point-min))
(pos-visible-in-window-p (point-max)))
(enlarge-window (1+ (- (count-lines (point-min) (point-max))
(reftex-window-height))))))
(cond
((window-live-p win1) (select-window win1))
(keep-current
(switch-to-buffer-other-window buf1)
(shrink-window (- (window-height) window-min-height))))))
(defun reftex-select-with-char (prompt help-string &optional delay-time scroll)
(let ((char ?\?))
(save-window-excursion
(catch 'exit
(message (concat prompt " (?=Help)"))
(when (or (sit-for (or delay-time 0))
(= ?\? (setq char (read-char-exclusive))))
(reftex-kill-buffer "*RefTeX Select*")
(switch-to-buffer-other-window "*RefTeX Select*")
(insert help-string)
(goto-char 1)
(unless (and (pos-visible-in-window-p (point-min))
(pos-visible-in-window-p (point-max)))
(enlarge-window (1+ (- (count-lines (point-min) (point-max))
(reftex-window-height)))))
(setq truncate-lines t))
(if (and (pos-visible-in-window-p (point-min))
(pos-visible-in-window-p (point-max)))
nil
(setq prompt (concat prompt (if scroll " (SPC/DEL=Scroll)" ""))))
(message prompt)
(and (equal char ?\?) (setq char (read-char-exclusive)))
(while t
(cond ((equal char ?\C-g) (keyboard-quit))
((equal char ?\?))
((and scroll (equal char ?\ ))
(condition-case nil (scroll-up) (error nil))
(message prompt))
((and scroll (equal char ?\C-? ))
(condition-case nil (scroll-down) (error nil))
(message prompt))
(t (message "")
(throw 'exit char)))
(setq char (read-char-exclusive)))))))
(defun reftex-make-regexp-allow-for-ctrl-m (string)
(let ((start -2))
(setq string (regexp-quote string))
(while (setq start (string-match "[\n\r]" string (+ 3 start)))
(setq string (replace-match "[\n\r]" nil t string)))
string))
(defun reftex-get-buffer-visiting (file)
(cond
((boundp 'find-file-compare-truenames) (let ((find-file-compare-truenames t))
(get-file-buffer file)))
((fboundp 'find-buffer-visiting) (find-buffer-visiting file))
(t (error "This should not happen (reftex-get-buffer-visiting)"))))
(defvar message-stack)
(if (and (featurep 'xemacs)
(not (fboundp 'current-message)))
(defun current-message (&optional frame)
(cdr (car message-stack))))
(defun reftex-visited-files (list)
(delq nil (mapcar (lambda (x) (if (reftex-get-buffer-visiting x) x nil))
list)))
(defun reftex-get-file-buffer-force (file &optional mark-to-kill)
(let ((buf (reftex-get-buffer-visiting file)))
(cond (buf
buf)
((file-readable-p file)
(if (or (not mark-to-kill)
(eq t reftex-initialize-temporary-buffers))
(setq buf (find-file-noselect file))
(let ((format-alist nil)
(auto-mode-alist (reftex-auto-mode-alist))
(default-major-mode 'fundamental-mode)
(enable-local-variables nil)
(after-insert-file-functions nil))
(setq buf (find-file-noselect file)))
(when (listp reftex-initialize-temporary-buffers)
(save-excursion
(set-buffer buf)
(run-hooks 'reftex-initialize-temporary-buffers))))
(and mark-to-kill
(add-to-list 'reftex-buffers-to-kill buf))
buf)
(t nil))))
(defun reftex-kill-temporary-buffers (&optional buffer)
(cond
(buffer
(when (member buffer reftex-buffers-to-kill)
(kill-buffer buffer)
(setq reftex-buffers-to-kill
(delete buffer reftex-buffers-to-kill))))
(t
(while (setq buffer (pop reftex-buffers-to-kill))
(when (bufferp buffer)
(and (buffer-modified-p buffer)
(y-or-n-p (format "Save file %s? "
(buffer-file-name buffer)))
(save-excursion
(set-buffer buffer)
(save-buffer)))
(kill-buffer buffer))
(pop reftex-buffers-to-kill)))))
(defun reftex-splice-symbols-into-list (list alist)
(let (rtn tmp)
(while list
(while (and (not (null (car list))) (symbolp (car list)))
(setq tmp (car list))
(cond
((assoc tmp alist)
(setq list (append (nth 2 (assoc tmp alist)) (cdr list))))
(t
(error "Cannot treat symbol %s in reftex-label-alist"
(symbol-name tmp)))))
(push (pop list) rtn))
(nreverse rtn)))
(defun reftex-remove-symbols-from-list (list)
(let (rtn)
(while list
(unless (symbolp (car list))
(push (car list) rtn))
(setq list (cdr list)))
(nreverse rtn)))
(defun reftex-uniquify (list)
(let (new elm)
(while list
(setq elm (pop list))
(unless (member elm new)
(push elm new)))
(nreverse new)))
(defun reftex-uniquify-by-car (alist &optional keep-list)
(let (new elm)
(while alist
(setq elm (pop alist))
(if (or (member (car elm) keep-list)
(not (assoc (car elm) new)))
(push elm new)))
(nreverse new)))
(defun reftex-abbreviate-title (string)
(reftex-convert-string string "[-~ \t\n\r,;]" nil t t
5 40 nil 1 " " (nth 5 reftex-derive-label-parameters)))
(defun reftex-convert-string (string split-re invalid-re dot keep-fp
nwords maxchar invalid abbrev sep
ignore-words &optional downcase)
"Convert a string (a sentence) to something shorter.
SPLIT-RE is the regular expression used to split the string into words.
INVALID-RE matches characters which are invalid in the final string.
DOT t means add dots to abbreviated words.
KEEP-FP t means to keep a final punctuation when applicable.
NWORDS Number of words to use.
MAXCHAR Maximum number of characters in the final string.
INVALID nil: Throw away any words containing stuff matched with INVALID-RE.
t: Throw away only the matched part, not the whole word.
ABBREV nil: Never abbreviate words.
t: Always abbreviate words (see `reftex-abbrev-parameters').
not t and not nil: Abbreviate words if necessary to shorten
string below MAXCHAR.
SEP String separating different words in the output string.
IGNORE-WORDS List of words which should be removed from the string."
(let* ((words0 (split-string string (or split-re "[ \t\n\r]")))
(reftex-label-illegal-re (or invalid-re "\000"))
(abbrev-re (concat
"\\`\\("
(make-string (nth 0 reftex-abbrev-parameters) ?.)
"[" (nth 2 reftex-abbrev-parameters) "]*"
"\\)"
"[" (nth 3 reftex-abbrev-parameters) "]"
(make-string (1- (nth 1 reftex-abbrev-parameters)) ?.)))
words word)
(while (setq word (pop words0))
(if downcase (setq word (downcase word)))
(cond
((member (downcase word) ignore-words))
((string-match reftex-label-illegal-re word)
(when invalid
(while (string-match reftex-label-illegal-re word)
(setq word (replace-match "" nil nil word)))
(push word words)))
(t
(push word words))))
(setq words (nreverse words))
(if (> (length words) nwords)
(setcdr (nthcdr (1- nwords) words) nil))
(setq string (mapconcat 'identity words sep))
(if (or (eq t abbrev)
(and abbrev
(> (length string) maxchar)))
(setq words
(mapcar
(lambda (w) (if (string-match abbrev-re w)
(if dot
(concat (match-string 1 w) ".")
(match-string 1 w))
w))
words)
string (mapconcat 'identity words sep)))
(setq string
(if (> (length string) maxchar)
(substring string 0 maxchar)
string))
(if (and (not keep-fp) (string-match "\\s.+\\'" string))
(setq string (replace-match "" nil nil string)))
string))
(defun reftex-nicify-text (text)
(while (string-match "[\n\r\t]\\|[ \t][ \t]+" text)
(setq text (replace-match " " nil t text)))
(if (string-match "\\(\\\\end{\\|\\\\item\\|\\\\\\\\\\).*" text)
(setq text (replace-match "" nil t text)))
(if (string-match "\\\\label{[^}]*}" text)
(setq text (replace-match "" nil t text)))
(if (string-match "\\`[ }]+" text)
(setq text (replace-match "" nil t text)))
(cond
((> (length text) 100) (substring text 0 100))
((= (length text) 0) (make-string 1 ?\ ))
(t text)))
(defun reftex-use-fonts ()
(and reftex-use-fonts
(featurep 'font-lock)))
(defun reftex-refontify ()
(and (reftex-use-fonts)
(or (eq t reftex-refontify-context)
(and (eq 1 reftex-refontify-context)
(and (featurep 'x-symbol-tex) (not (boundp 'x-symbol-mode)))))))
(defvar font-lock-defaults-computed)
(defun reftex-fontify-select-label-buffer (parent-buffer)
(run-hook-with-args 'reftex-pre-refontification-functions
parent-buffer 'reftex-ref)
(let* ((oldname (buffer-name))
(newname (concat "Fontify-me-" oldname)))
(unwind-protect
(progn
(rename-buffer newname t)
(cond
((fboundp 'font-lock-default-fontify-region)
(set (make-local-variable 'font-lock-fontify-region-function)
'reftex-select-font-lock-fontify-region)
(let ((major-mode 'latex-mode))
(font-lock-mode 1)))
((fboundp 'font-lock-set-defaults-1)
(set (make-local-variable 'font-lock-keywords) nil)
(let ((major-mode 'latex-mode)
(font-lock-defaults-computed nil))
(font-lock-set-defaults-1)
(reftex-select-font-lock-fontify-region (point-min) (point-max))))
(t
(message "Sorry: cannot refontify RefTeX Select buffer."))))
(rename-buffer oldname))))
(defun reftex-select-font-lock-fontify-region (beg end &optional loudly)
(let ((func (if (fboundp 'font-lock-default-fontify-region)
'font-lock-default-fontify-region
'font-lock-fontify-region))
beg1 end1)
(goto-char beg)
(while (re-search-forward "^\\." end t)
(setq beg1 (point) end1 (progn (skip-chars-forward "^\n") (point)))
(funcall func beg1 end1 nil)
(goto-char end1))))
(defun reftex-select-font-lock-unfontify (&rest ignore) t)
(defun reftex-verified-face (&rest faces)
(let (face)
(catch 'exit
(while (setq face (pop faces))
(if (featurep 'xemacs)
(if (find-face face) (throw 'exit face))
(if (facep face) (throw 'exit face)))))))
(if (featurep 'xemacs)
(progn
(defalias 'reftex-make-overlay 'make-extent)
(defalias 'reftex-overlay-put 'set-extent-property)
(defalias 'reftex-move-overlay 'set-extent-endpoints)
(defalias 'reftex-delete-overlay 'detach-extent))
(defalias 'reftex-make-overlay 'make-overlay)
(defalias 'reftex-overlay-put 'overlay-put)
(defalias 'reftex-move-overlay 'move-overlay)
(defalias 'reftex-delete-overlay 'delete-overlay))
(defvar reftex-highlight-overlays [nil nil nil])
(aset reftex-highlight-overlays 0 (reftex-make-overlay 1 1))
(reftex-overlay-put (aref reftex-highlight-overlays 0)
'face 'highlight)
(aset reftex-highlight-overlays 1 (reftex-make-overlay 1 1))
(reftex-overlay-put (aref reftex-highlight-overlays 1)
'face reftex-cursor-selected-face)
(aset reftex-highlight-overlays 2 (reftex-make-overlay 1 1))
(reftex-overlay-put (aref reftex-highlight-overlays 2)
'face reftex-cursor-selected-face)
(defun reftex-highlight (index begin end &optional buffer)
"Highlight a region with overlay INDEX."
(reftex-move-overlay (aref reftex-highlight-overlays index)
begin end (or buffer (current-buffer))))
(defun reftex-unhighlight (index)
"Detach overlay INDEX."
(reftex-delete-overlay (aref reftex-highlight-overlays index)))
(defun reftex-highlight-shall-die ()
(remove-hook 'pre-command-hook 'reftex-highlight-shall-die)
(reftex-unhighlight 0))
(loop for x in
'(("\C-c=" . reftex-toc)
("\C-c-" . reftex-toc-recenter)
("\C-c(" . reftex-label)
("\C-c)" . reftex-reference)
("\C-c[" . reftex-citation)
("\C-c<" . reftex-index)
("\C-c>" . reftex-display-index)
("\C-c/" . reftex-index-selection-or-word)
("\C-c\\" . reftex-index-phrase-selection-or-word)
("\C-c|" . reftex-index-visit-phrases-buffer)
("\C-c&" . reftex-view-crossref))
do (define-key reftex-mode-map (car x) (cdr x)))
(if (featurep 'xemacs)
(unless (key-binding [(shift button2)])
(define-key reftex-mode-map [(shift button2)]
'reftex-mouse-view-crossref))
(unless (key-binding [(shift mouse-2)])
(define-key reftex-mode-map [(shift mouse-2)]
'reftex-mouse-view-crossref)))
(eval-after-load
"bibtex"
'(define-key bibtex-mode-map "\C-c&" 'reftex-view-crossref-from-bibtex))
(when reftex-extra-bindings
(loop for x in
'(("\C-ct" . reftex-toc)
("\C-cl" . reftex-label)
("\C-cr" . reftex-reference)
("\C-cc" . reftex-citation)
("\C-cv" . reftex-view-crossref)
("\C-cg" . reftex-grep-document)
("\C-cs" . reftex-search-document))
do (define-key reftex-mode-map (car x) (cdr x))))
(defvar reftex-isearch-minor-mode nil)
(make-variable-buffer-local 'reftex-isearch-minor-mode)
(require 'easymenu)
(easy-menu-define reftex-mode-menu reftex-mode-map
"Menu used in RefTeX mode"
`("Ref"
["Table of Contents" reftex-toc t]
["Recenter TOC" reftex-toc-recenter t]
"--"
["\\label" reftex-label t]
["\\ref" reftex-reference t]
["\\cite" reftex-citation t]
("\\index"
["\\index" reftex-index t]
["\\index{THIS}" reftex-index-selection-or-word t]
"--"
["Add THIS to Index Phrases" reftex-index-phrase-selection-or-word t]
["Visit Phrase Buffer" reftex-index-visit-phrases-buffer t]
["Apply Phrases to Region" reftex-index-phrases-apply-to-region t]
"--"
["Display the Index" reftex-display-index t])
"--"
["View Crossref" reftex-view-crossref t]
"--"
("Parse Document"
["One File" reftex-parse-one reftex-enable-partial-scans]
["Entire Document" reftex-parse-all t]
["Save to File" (reftex-access-parse-file 'write)
(> (length (symbol-value reftex-docstruct-symbol)) 0)]
["Restore from File" (reftex-access-parse-file 'restore) t])
("Global Actions"
["Search Whole Document" reftex-search-document t]
["Search Again" tags-loop-continue t]
["Replace in Document" reftex-query-replace-document t]
["Grep on Document" reftex-grep-document t]
"--"
["Goto Label" reftex-goto-label t]
["Find Duplicate Labels" reftex-find-duplicate-labels t]
["Change Label and Refs" reftex-change-label t]
["Renumber Simple Labels" reftex-renumber-simple-labels t]
"--"
["Create BibTeX File" reftex-create-bibtex-file t]
"--"
["Create TAGS File" reftex-create-tags-file t]
"--"
["Save Document" reftex-save-all-document-buffers t])
"--"
("Options"
"PARSER"
["Partial Scans"
(setq reftex-enable-partial-scans (not reftex-enable-partial-scans))
:style toggle :selected reftex-enable-partial-scans]
["Auto-Save Parse Info"
(setq reftex-save-parse-info (not reftex-save-parse-info))
:style toggle :selected reftex-save-parse-info]
"--"
"TOC RECENTER"
["Automatic Recenter" reftex-toggle-auto-toc-recenter
:style toggle :selected reftex-toc-auto-recenter-timer]
"--"
"CROSSREF INFO"
["Automatic Info" reftex-toggle-auto-view-crossref
:style toggle :selected reftex-auto-view-crossref-timer]
["...in Echo Area" (setq reftex-auto-view-crossref t)
:style radio :selected (eq reftex-auto-view-crossref t)]
["...in Other Window" (setq reftex-auto-view-crossref 'window)
:style radio :selected (eq reftex-auto-view-crossref 'window)]
"--"
"MISC"
["AUC TeX Interface" reftex-toggle-plug-into-AUCTeX
:style toggle :selected reftex-plug-into-AUCTeX]
["isearch whole document" reftex-isearch-minor-mode
:style toggle :selected reftex-isearch-minor-mode])
("Reference Style"
["Default" (setq reftex-vref-is-default nil
reftex-fref-is-default nil)
:style radio :selected (not (or reftex-vref-is-default
reftex-fref-is-default))]
["Varioref" (setq reftex-vref-is-default t
reftex-fref-is-default nil)
:style radio :selected reftex-vref-is-default]
["Fancyref" (setq reftex-fref-is-default t
reftex-vref-is-default nil)
:style radio :selected reftex-fref-is-default])
("Citation Style"
,@(mapcar
(lambda (x)
(vector
(capitalize (symbol-name (car x)))
(list 'reftex-set-cite-format (list 'quote (car x)))
:style 'radio :selected
(list 'eq (list 'reftex-get-cite-format) (list 'quote (car x)))))
reftex-cite-format-builtin)
"--"
"Sort Database Matches"
["Not" (setq reftex-sort-bibtex-matches nil)
:style radio :selected (eq reftex-sort-bibtex-matches nil)]
["by Author" (setq reftex-sort-bibtex-matches 'author)
:style radio :selected (eq reftex-sort-bibtex-matches 'author)]
["by Year" (setq reftex-sort-bibtex-matches 'year)
:style radio :selected (eq reftex-sort-bibtex-matches 'year)]
["by Year, reversed" (setq reftex-sort-bibtex-matches 'reverse-year)
:style radio :selected (eq reftex-sort-bibtex-matches 'reverse-year)])
("Index Style"
,@(mapcar
(lambda (x)
(vector
(capitalize (symbol-name (car x)))
(list 'reftex-add-index-macros (list 'list (list 'quote (car x))))
:style 'radio :selected
(list 'memq (list 'quote (car x))
(list 'get 'reftex-docstruct-symbol
(list 'quote 'reftex-index-macros-style)))))
reftex-index-macros-builtin))
"--"
["Reset RefTeX Mode" reftex-reset-mode t]
"--"
("Customize"
["Browse RefTeX Group" reftex-customize t]
"--"
["Build Full Customize Menu" reftex-create-customize-menu
(fboundp 'customize-menu-create)])
("Documentation"
["Info" reftex-info t]
["Commentary" reftex-show-commentary t])))
(defun reftex-customize ()
"Call the customize function with reftex as argument."
(interactive)
(customize-browse 'reftex))
(defun reftex-create-customize-menu ()
"Create a full customization menu for RefTeX, insert it into the menu."
(interactive)
(if (fboundp 'customize-menu-create)
(progn
(easy-menu-change
'("Ref") "Customize"
`(["Browse RefTeX group" reftex-customize t]
"--"
,(customize-menu-create 'reftex)
["Set" Custom-set t]
["Save" Custom-save t]
["Reset to Current" Custom-reset-current t]
["Reset to Saved" Custom-reset-saved t]
["Reset to Standard Settings" Custom-reset-standard t]))
(message "\"Ref\"-menu now contains full customization menu"))
(error "Cannot expand menu (outdated version of cus-edit.el)")))
(defun reftex-show-commentary ()
"Use the finder to view the file documentation from `reftex.el'."
(interactive)
(require 'finder)
(finder-commentary "reftex.el"))
(defun reftex-info (&optional node)
"Read documentation for RefTeX in the info system.
With optional NODE, go directly to that node."
(interactive)
(require 'info)
(Info-goto-node (format "(reftex)%s" (or node ""))))
(add-hook 'kill-buffer-hook 'reftex-kill-buffer-hook)
(add-hook 'kill-emacs-hook 'reftex-kill-emacs-hook)
(run-hooks 'reftex-load-hook)
(setq reftex-tables-dirty t) (provide 'reftex)