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