Commit | Line | Data |
---|---|---|
818226ac | 1 | ;;; reftex-auc.el --- RefTeX's interface to AUCTeX |
ceb4c4d3 TTN |
2 | ;; Copyright (C) 1997, 1998, 1999, 2000, 2003, 2004, 2005, |
3 | ;; 2006 Free Software Foundation, Inc. | |
3ba2590f | 4 | |
6fbeb429 | 5 | ;; Author: Carsten Dominik <dominik@science.uva.nl> |
5d2a58e0 | 6 | ;; Version: 4.31 |
3ba2590f RS |
7 | |
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
27e81652 TTN |
22 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
23 | ;; Boston, MA 02110-1301, USA. | |
1a9461d0 | 24 | |
3afbc435 PJ |
25 | ;;; Commentary: |
26 | ||
27 | ;;; Code: | |
28 | ||
7c4d13cc | 29 | (eval-when-compile (require 'cl)) |
1a9461d0 CD |
30 | (provide 'reftex-auc) |
31 | (require 'reftex) | |
32 | ;;; | |
33 | ||
34 | (defun reftex-plug-flag (which) | |
35 | ;; Tell if a certain flag is set in reftex-plug-into-AUCTeX | |
36 | (or (eq t reftex-plug-into-AUCTeX) | |
37 | (and (listp reftex-plug-into-AUCTeX) | |
3666daf6 | 38 | (nth which reftex-plug-into-AUCTeX)))) |
1a9461d0 CD |
39 | |
40 | (defun reftex-arg-label (optional &optional prompt definition) | |
41 | "Use `reftex-label', `reftex-reference' or AUCTeX's code to insert label arg. | |
42 | What is being used depends upon `reftex-plug-into-AUCTeX'." | |
43 | (let (label) | |
44 | (cond | |
45 | ((and definition (reftex-plug-flag 1)) | |
46 | ;; Create a new label, with a temporary brace for `reftex-what-macro' | |
47 | (unwind-protect | |
3666daf6 CD |
48 | (progn (insert "{") (setq label (or (reftex-label nil t) ""))) |
49 | (delete-backward-char 1))) | |
1a9461d0 CD |
50 | ((and (not definition) (reftex-plug-flag 2)) |
51 | ;; Reference a label with RefTeX | |
52 | (setq label (reftex-reference nil t))) | |
53 | (t | |
54 | ;; AUCTeX's default mechanism | |
55 | (setq label (completing-read (TeX-argument-prompt optional prompt "Key") | |
3666daf6 | 56 | (LaTeX-label-list))))) |
1a9461d0 | 57 | (if (and definition (not (string-equal "" label))) |
3666daf6 | 58 | (LaTeX-add-labels label)) |
1a9461d0 CD |
59 | (TeX-argument-insert label optional))) |
60 | ||
61 | (defun reftex-arg-cite (optional &optional prompt definition) | |
62 | "Use `reftex-citation' or AUCTeX's code to insert a cite-key macro argument. | |
63 | What is being used depends upon `reftex-plug-into-AUCTeX'." | |
64 | (let (items) | |
65 | (cond | |
66 | ((and (not definition) (reftex-plug-flag 3)) | |
67 | (setq items (list (or (reftex-citation t) "")))) | |
68 | (t | |
69 | (setq prompt (concat (if optional "(Optional) " "") | |
5b76833f RF |
70 | (if prompt prompt "Add key") |
71 | " (default none): ")) | |
1a9461d0 CD |
72 | (setq items (multi-prompt "," t prompt (LaTeX-bibitem-list))))) |
73 | (apply 'LaTeX-add-bibitems items) | |
74 | (TeX-argument-insert (mapconcat 'identity items ",") optional))) | |
75 | ||
76 | ||
77 | (defun reftex-arg-index-tag (optional &optional prompt &rest args) | |
ceb4c4d3 | 78 | "Prompt for an index tag with completion. |
1a9461d0 CD |
79 | This is the name of an index, not the entry." |
80 | (let (tag taglist) | |
81 | (setq prompt (concat (if optional "(Optional) " "") | |
5b76833f RF |
82 | (if prompt prompt "Index tag") |
83 | " (default none): ")) | |
1a9461d0 | 84 | (if (and reftex-support-index (reftex-plug-flag 4)) |
3666daf6 CD |
85 | ;; Use RefTeX completion |
86 | (progn | |
87 | (reftex-access-scan-info nil) | |
ceb4c4d3 TTN |
88 | (setq taglist |
89 | (cdr (assoc 'index-tags | |
3666daf6 CD |
90 | (symbol-value reftex-docstruct-symbol))) |
91 | tag (completing-read prompt (mapcar 'list taglist)))) | |
1a9461d0 CD |
92 | ;; Just ask like AUCTeX does. |
93 | (setq tag (read-string prompt))) | |
94 | (TeX-argument-insert tag optional))) | |
95 | ||
96 | (defun reftex-arg-index (optional &optional prompt &rest args) | |
97 | "Prompt for an index entry completing with known entries. | |
98 | Completion is specific for just one index, if the macro or a tag | |
99 | argument identify one of multiple indices." | |
100 | (let* (tag key) | |
101 | (if (and reftex-support-index (reftex-plug-flag 4)) | |
3666daf6 CD |
102 | (progn |
103 | (reftex-access-scan-info nil) | |
104 | (setq tag (reftex-what-index-tag) | |
105 | key (reftex-index-complete-key (or tag "idx")))) | |
1a9461d0 | 106 | (setq key (completing-read (TeX-argument-prompt optional prompt "Key") |
3666daf6 | 107 | (LaTeX-index-entry-list)))) |
1a9461d0 CD |
108 | (unless (string-equal "" key) |
109 | (LaTeX-add-index-entries key)) | |
110 | (TeX-argument-insert key optional))) | |
111 | ||
112 | (defun reftex-what-index-tag () | |
113 | ;; Look backward to find out what index the macro at point belongs to | |
114 | (let ((macro (save-excursion | |
3666daf6 CD |
115 | (and (re-search-backward "\\\\[a-zA-Z*]+" nil t) |
116 | (match-string 0)))) | |
117 | tag entry) | |
1a9461d0 | 118 | (when (and macro |
3666daf6 | 119 | (setq entry (assoc macro reftex-index-macro-alist))) |
1a9461d0 CD |
120 | (setq tag (nth 1 entry)) |
121 | (cond | |
122 | ((stringp tag) tag) | |
123 | ((integerp tag) | |
3666daf6 CD |
124 | (save-excursion |
125 | (goto-char (match-end 1)) | |
126 | (or (reftex-nth-arg tag (nth 6 entry)) "idx"))) | |
1a9461d0 CD |
127 | (t "idx"))))) |
128 | ||
129 | (defvar LaTeX-label-function) | |
130 | (defun reftex-plug-into-AUCTeX () | |
131 | ;; Replace AUCTeX functions with RefTeX functions. | |
132 | ;; Which functions are replaced is controlled by the variable | |
133 | ;; `reftex-plug-into-AUCTeX'. | |
ceb4c4d3 | 134 | |
1a9461d0 CD |
135 | (if (reftex-plug-flag 0) |
136 | (setq LaTeX-label-function 'reftex-label) | |
137 | (setq LaTeX-label-function nil)) | |
138 | ||
139 | (and (or (reftex-plug-flag 1) (reftex-plug-flag 2)) | |
140 | (fboundp 'TeX-arg-label) | |
141 | (fset 'TeX-arg-label 'reftex-arg-label)) | |
142 | ||
143 | (and (reftex-plug-flag 3) | |
144 | (fboundp 'TeX-arg-cite) | |
145 | (fset 'TeX-arg-cite 'reftex-arg-cite)) | |
ceb4c4d3 TTN |
146 | |
147 | (and (reftex-plug-flag 4) | |
1a9461d0 CD |
148 | (fboundp 'TeX-arg-index-tag) |
149 | (fset 'TeX-arg-index-tag 'reftex-arg-index-tag)) | |
ceb4c4d3 | 150 | (and (reftex-plug-flag 4) |
1a9461d0 CD |
151 | (fboundp 'TeX-arg-index) |
152 | (fset 'TeX-arg-index 'reftex-arg-index))) | |
153 | ||
154 | (defun reftex-toggle-plug-into-AUCTeX () | |
155 | "Toggle Interface between AUCTeX and RefTeX on and off." | |
156 | (interactive) | |
157 | (unless (and (featurep 'tex-site) (featurep 'latex)) | |
158 | (error "AUCTeX's LaTeX mode does not seem to be loaded")) | |
159 | (setq reftex-plug-into-AUCTeX (not reftex-plug-into-AUCTeX)) | |
160 | (reftex-plug-into-AUCTeX) | |
161 | (if reftex-plug-into-AUCTeX | |
162 | (message "RefTeX has been plugged into AUCTeX.") | |
163 | (message "RefTeX no longer interacts with AUCTeX."))) | |
164 | ||
165 | (defun reftex-add-label-environments (entry-list) | |
166 | "Add label environment descriptions to `reftex-label-alist-style'. | |
167 | The format of ENTRY-LIST is exactly like `reftex-label-alist'. See there | |
168 | for details. | |
169 | This function makes it possible to support RefTeX from AUCTeX style files. | |
170 | The entries in ENTRY-LIST will be processed after the user settings in | |
171 | `reftex-label-alist', and before the defaults (specified in | |
172 | `reftex-default-label-alist-entries'). Any changes made to | |
173 | `reftex-label-alist-style' will raise a flag to the effect that | |
174 | the label information is recompiled on next use." | |
175 | (unless reftex-docstruct-symbol | |
176 | (reftex-tie-multifile-symbols)) | |
177 | (when (and reftex-docstruct-symbol | |
3666daf6 | 178 | (symbolp reftex-docstruct-symbol)) |
1a9461d0 | 179 | (let ((list (get reftex-docstruct-symbol 'reftex-label-alist-style)) |
3666daf6 | 180 | entry changed) |
1a9461d0 | 181 | (while entry-list |
3666daf6 CD |
182 | (setq entry (pop entry-list)) |
183 | (unless (member entry list) | |
184 | (setq reftex-tables-dirty t | |
185 | changed t) | |
186 | (push entry list))) | |
1a9461d0 | 187 | (when changed |
3666daf6 | 188 | (put reftex-docstruct-symbol 'reftex-label-alist-style list))))) |
1a9461d0 CD |
189 | (defalias 'reftex-add-to-label-alist 'reftex-add-label-environments) |
190 | ||
191 | (defun reftex-add-section-levels (entry-list) | |
192 | "Add entries to the value of `reftex-section-levels'. | |
193 | The added values are kept local to the current document. The format | |
194 | of ENTRY-LIST is a list of cons cells (\"MACRONAME\" . LEVEL). See | |
195 | `reftex-section-levels' for an example." | |
196 | (unless reftex-docstruct-symbol | |
197 | (reftex-tie-multifile-symbols)) | |
198 | (when (and reftex-docstruct-symbol | |
3666daf6 | 199 | (symbolp reftex-docstruct-symbol)) |
1a9461d0 | 200 | (let ((list (get reftex-docstruct-symbol 'reftex-section-levels)) |
3666daf6 | 201 | entry changed) |
1a9461d0 | 202 | (while entry-list |
3666daf6 CD |
203 | (setq entry (pop entry-list)) |
204 | (unless (member entry list) | |
205 | (setq reftex-tables-dirty t | |
206 | changed t) | |
207 | (push entry list))) | |
1a9461d0 | 208 | (when changed |
3666daf6 | 209 | (put reftex-docstruct-symbol 'reftex-section-levels list))))) |
1a9461d0 CD |
210 | |
211 | (defun reftex-notice-new-section () | |
212 | (reftex-notice-new 1 'force)) | |
213 | ||
ab5796a9 | 214 | ;;; arch-tag: 4a798e68-3405-421c-a09b-0269aac64ab4 |
1a9461d0 | 215 | ;;; reftex-auc.el ends here |