Commit | Line | Data |
---|---|---|
3afbc435 | 1 | ;;; reftex-toc.el --- RefTeX's table of contents mode |
3a1e8128 CD |
2 | ;; Copyright (c) 1997, 1998, 1999, 2000, 2003, 2004, 2005 |
3 | ;; Free Software Foundation, Inc. | |
3ba2590f | 4 | |
6fbeb429 | 5 | ;; Author: Carsten Dominik <dominik@science.uva.nl> |
3a1e8128 | 6 | ;; Version: 4.28 |
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 | |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
1a9461d0 | 24 | |
3afbc435 PJ |
25 | ;;; Commentary: |
26 | ||
27 | ;;; Code: | |
28 | ||
7c4d13cc | 29 | (eval-when-compile (require 'cl)) |
1a9461d0 CD |
30 | (provide 'reftex-toc) |
31 | (require 'reftex) | |
32 | ;;; | |
33 | ||
34 | (defvar reftex-toc-map (make-sparse-keymap) | |
35 | "Keymap used for *toc* buffer.") | |
36 | ||
37 | (defvar reftex-toc-menu) | |
38 | ||
39 | (defun reftex-toc-mode () | |
40 | "Major mode for managing Table of Contents for LaTeX files. | |
41 | This buffer was created with RefTeX. | |
42 | Press `?' for a summary of important key bindings. | |
43 | ||
44 | Here are all local bindings. | |
45 | ||
46 | \\{reftex-toc-map}" | |
47 | (interactive) | |
48 | (kill-all-local-variables) | |
49 | (setq major-mode 'reftex-toc-mode | |
3666daf6 | 50 | mode-name "TOC") |
1a9461d0 | 51 | (use-local-map reftex-toc-map) |
3666daf6 CD |
52 | (set (make-local-variable 'transient-mark-mode) t) |
53 | (set (make-local-variable 'zmacs-regions) t) | |
1a9461d0 CD |
54 | (set (make-local-variable 'revert-buffer-function) 'reftex-toc-revert) |
55 | (set (make-local-variable 'reftex-toc-include-labels-indicator) "") | |
7c4d13cc CD |
56 | (set (make-local-variable 'reftex-toc-max-level-indicator) |
57 | (if (= reftex-toc-max-level 100) | |
3666daf6 CD |
58 | "ALL" |
59 | (int-to-string reftex-toc-max-level))) | |
1a9461d0 | 60 | (setq mode-line-format |
3666daf6 CD |
61 | (list "---- " 'mode-line-buffer-identification |
62 | " " 'global-mode-string " (" mode-name ")" | |
63 | " L<" 'reftex-toc-include-labels-indicator ">" | |
64 | " I<" 'reftex-toc-include-index-indicator ">" | |
65 | " T<" 'reftex-toc-max-level-indicator ">" | |
66 | " -%-")) | |
1a9461d0 | 67 | (setq truncate-lines t) |
7ac7387b CD |
68 | (when (featurep 'xemacs) |
69 | ;; XEmacs needs the call to make-local-hook | |
70 | (make-local-hook 'post-command-hook) | |
71 | (make-local-hook 'pre-command-hook)) | |
1a9461d0 CD |
72 | (make-local-variable 'reftex-last-follow-point) |
73 | (add-hook 'post-command-hook 'reftex-toc-post-command-hook nil t) | |
74 | (add-hook 'pre-command-hook 'reftex-toc-pre-command-hook nil t) | |
75 | (easy-menu-add reftex-toc-menu reftex-toc-map) | |
7023d838 | 76 | (run-mode-hooks 'reftex-toc-mode-hook)) |
1a9461d0 CD |
77 | |
78 | (defvar reftex-last-toc-file nil | |
79 | "Stores the file name from which `reftex-toc' was called. For redo command.") | |
80 | ||
81 | (defvar reftex-last-window-height nil) | |
6fbeb429 | 82 | (defvar reftex-last-window-width nil) |
1a9461d0 CD |
83 | (defvar reftex-toc-include-labels-indicator nil) |
84 | (defvar reftex-toc-include-index-indicator nil) | |
7c4d13cc | 85 | (defvar reftex-toc-max-level-indicator nil) |
1a9461d0 CD |
86 | |
87 | (defvar reftex-toc-return-marker (make-marker) | |
88 | "Marker which makes it possible to return from toc to old position.") | |
89 | ||
90 | (defconst reftex-toc-help | |
91 | " AVAILABLE KEYS IN TOC BUFFER | |
92 | ============================ | |
93 | n / p next-line / previous-line | |
94 | SPC Show the corresponding location of the LaTeX document. | |
95 | TAB Goto the location and keep the *toc* window. | |
96 | RET Goto the location and hide the *toc* window (also on mouse-2). | |
3666daf6 | 97 | < / > Promote / Demote section, or all sections in region. |
1a9461d0 CD |
98 | C-c > Display Index. With prefix arg, restrict index to current section. |
99 | q / k Hide/Kill *toc* buffer, return to position of reftex-toc command. | |
100 | l i c F Toggle display of [l]abels, [i]ndex, [c]ontext, [F]ile borders. | |
7c4d13cc | 101 | t Change maximum toc depth (e.g. `3 t' hides levels greater than 3). |
3666daf6 CD |
102 | f / g Toggle follow mode / Refresh *toc* buffer. |
103 | a / d Toggle auto recenter / Toggle dedicated frame | |
1a9461d0 CD |
104 | r / C-u r Reparse the LaTeX document / Reparse entire LaTeX document. |
105 | . In other window, show position from where `reftex-toc' was called. | |
3666daf6 | 106 | M-% Global search and replace to rename label at point. |
70d797cd | 107 | x Switch to TOC of external document (with LaTeX package `xr'). |
3666daf6 | 108 | z Jump to a specific section (e.g. '3 z' goes to section 3).") |
1a9461d0 | 109 | |
3666daf6 | 110 | (defun reftex-toc (&optional rebuild reuse) |
1a9461d0 CD |
111 | "Show the table of contents for the current document. |
112 | When called with a raw C-u prefix, rescan the document first." | |
113 | ||
3666daf6 CD |
114 | ;; The REUSE argument means, search all visible frames for a window |
115 | ;; displaying the toc window. If yes, reuse this window. | |
116 | ||
1a9461d0 CD |
117 | (interactive) |
118 | ||
119 | (if (or (not (string= reftex-last-toc-master (reftex-TeX-master-file))) | |
120 | current-prefix-arg) | |
121 | (reftex-erase-buffer "*toc*")) | |
122 | ||
123 | (setq reftex-last-toc-file (buffer-file-name)) | |
124 | (setq reftex-last-toc-master (reftex-TeX-master-file)) | |
125 | ||
126 | (set-marker reftex-toc-return-marker (point)) | |
127 | ||
128 | ;; If follow mode is active, arrange to delay it one command | |
129 | (if reftex-toc-follow-mode | |
130 | (setq reftex-toc-follow-mode 1)) | |
131 | ||
132 | (and reftex-toc-include-index-entries | |
133 | (reftex-ensure-index-support)) | |
134 | (or reftex-support-index | |
135 | (setq reftex-toc-include-index-entries nil)) | |
136 | ||
137 | ;; Ensure access to scanning info and rescan buffer if prefix are is '(4) | |
138 | (reftex-access-scan-info current-prefix-arg) | |
139 | ||
140 | (let* ((this-buf (current-buffer)) | |
3666daf6 CD |
141 | (docstruct-symbol reftex-docstruct-symbol) |
142 | (xr-data (assq 'xr (symbol-value reftex-docstruct-symbol))) | |
143 | (xr-alist (cons (cons "" (buffer-file-name)) (nth 1 xr-data))) | |
144 | (here-I-am (if (boundp 'reftex-rebuilding-toc) | |
145 | (get 'reftex-toc :reftex-data) | |
146 | (car (reftex-where-am-I)))) | |
147 | (unsplittable (if (fboundp 'frame-property) | |
148 | (frame-property (selected-frame) 'unsplittable) | |
149 | (frame-parameter (selected-frame) 'unsplittable))) | |
150 | offset toc-window) | |
151 | ||
52ebd91d | 152 | (if (setq toc-window (get-buffer-window |
3666daf6 CD |
153 | "*toc*" |
154 | (if reuse 'visible))) | |
155 | (select-window toc-window) | |
1a9461d0 | 156 | (when (or (not reftex-toc-keep-other-windows) |
3666daf6 CD |
157 | (< (window-height) (* 2 window-min-height))) |
158 | (delete-other-windows)) | |
6fbeb429 CD |
159 | |
160 | (setq reftex-last-window-width (window-width) | |
3666daf6 CD |
161 | reftex-last-window-height (window-height)) ; remember |
162 | ||
163 | (unless unsplittable | |
164 | (if reftex-toc-split-windows-horizontally | |
165 | (split-window-horizontally | |
166 | (floor (* (window-width) | |
167 | reftex-toc-split-windows-fraction))) | |
52ebd91d | 168 | (split-window-vertically |
3666daf6 CD |
169 | (floor (* (window-height) |
170 | reftex-toc-split-windows-fraction))))) | |
6fbeb429 | 171 | |
1a9461d0 | 172 | (let ((default-major-mode 'reftex-toc-mode)) |
3666daf6 | 173 | (switch-to-buffer "*toc*"))) |
1a9461d0 CD |
174 | |
175 | (or (eq major-mode 'reftex-toc-mode) (reftex-toc-mode)) | |
176 | (set (make-local-variable 'reftex-docstruct-symbol) docstruct-symbol) | |
177 | (setq reftex-toc-include-labels-indicator | |
3666daf6 CD |
178 | (if (eq reftex-toc-include-labels t) |
179 | "ALL" | |
180 | reftex-toc-include-labels)) | |
1a9461d0 | 181 | (setq reftex-toc-include-index-indicator |
3666daf6 CD |
182 | (if (eq reftex-toc-include-index-entries t) |
183 | "ALL" | |
184 | reftex-toc-include-index-entries)) | |
1a9461d0 CD |
185 | |
186 | (cond | |
187 | ((= (buffer-size) 0) | |
188 | ;; buffer is empty - fill it with the table of contents | |
189 | (message "Building *toc* buffer...") | |
190 | ||
191 | (setq buffer-read-only nil) | |
192 | (insert (format | |
193 | "TABLE-OF-CONTENTS on %s | |
194 | SPC=view TAB=goto RET=goto+hide [q]uit [r]escan [l]abels [f]ollow [x]r [?]Help | |
195 | ------------------------------------------------------------------------------ | |
196 | " (abbreviate-file-name reftex-last-toc-master))) | |
197 | ||
198 | (if (reftex-use-fonts) | |
4a9699d8 SM |
199 | (put-text-property (point-min) (point) 'face reftex-toc-header-face)) |
200 | (put-text-property (point-min) (point) 'intangible t) | |
201 | (put-text-property (point-min) (1+ (point-min)) 'xr-alist xr-alist) | |
1a9461d0 CD |
202 | |
203 | (setq offset | |
3666daf6 CD |
204 | (reftex-insert-docstruct |
205 | this-buf | |
206 | t ; include toc | |
207 | reftex-toc-include-labels | |
208 | reftex-toc-include-index-entries | |
209 | reftex-toc-include-file-boundaries | |
210 | reftex-toc-include-context | |
211 | nil ; counter | |
212 | nil ; commented | |
52ebd91d | 213 | here-I-am |
3666daf6 CD |
214 | "" ; xr-prefix |
215 | t ; a toc buffer | |
216 | )) | |
52ebd91d | 217 | |
1a9461d0 CD |
218 | (run-hooks 'reftex-display-copied-context-hook) |
219 | (message "Building *toc* buffer...done.") | |
220 | (setq buffer-read-only t)) | |
221 | (t | |
222 | ;; Only compute the offset | |
223 | (setq offset | |
3666daf6 CD |
224 | (or (reftex-get-offset this-buf here-I-am |
225 | (if reftex-toc-include-labels " " nil) | |
226 | t | |
227 | reftex-toc-include-index-entries | |
228 | reftex-toc-include-file-boundaries) | |
52ebd91d | 229 | (reftex-last-assoc-before-elt |
3666daf6 CD |
230 | 'toc here-I-am |
231 | (symbol-value reftex-docstruct-symbol)))) | |
1a9461d0 CD |
232 | (put 'reftex-toc :reftex-line 3) |
233 | (goto-line 3) | |
234 | (beginning-of-line))) | |
235 | ||
236 | ;; Find the correct starting point | |
237 | (reftex-find-start-point (point) offset (get 'reftex-toc :reftex-line)) | |
238 | (setq reftex-last-follow-point (point)))) | |
239 | ||
3b919c9f CD |
240 | (defun reftex-toc-recenter (&optional arg) |
241 | "Display the TOC window and highlight line corresponding to current position." | |
242 | (interactive "P") | |
3666daf6 CD |
243 | (let ((buf (current-buffer)) |
244 | (frame (selected-frame))) | |
245 | (reftex-toc arg t) | |
3b919c9f | 246 | (if (= (count-lines 1 (point)) 2) |
3666daf6 CD |
247 | (let ((current-prefix-arg nil)) |
248 | (select-window (get-buffer-window buf frame)) | |
249 | (reftex-toc nil t))) | |
3b919c9f | 250 | (and (> (point) 1) |
3666daf6 CD |
251 | (not (get-text-property (point) 'intangible)) |
252 | (memq reftex-highlight-selection '(cursor both)) | |
253 | (reftex-highlight 2 | |
52ebd91d | 254 | (or (previous-single-property-change |
3666daf6 CD |
255 | (min (point-max) (1+ (point))) :data) |
256 | (point-min)) | |
257 | (or (next-single-property-change (point) :data) | |
258 | (point-max)))) | |
259 | (select-window (get-buffer-window buf frame)))) | |
3b919c9f | 260 | |
1a9461d0 CD |
261 | (defun reftex-toc-pre-command-hook () |
262 | ;; used as pre command hook in *toc* buffer | |
263 | (reftex-unhighlight 0) | |
3b919c9f | 264 | ) |
1a9461d0 CD |
265 | |
266 | (defun reftex-toc-post-command-hook () | |
267 | ;; used in the post-command-hook for the *toc* buffer | |
268 | (when (get-text-property (point) :data) | |
269 | (put 'reftex-toc :reftex-data (get-text-property (point) :data)) | |
270 | (and (> (point) 1) | |
3666daf6 CD |
271 | (not (get-text-property (point) 'intangible)) |
272 | (memq reftex-highlight-selection '(cursor both)) | |
273 | (reftex-highlight 2 | |
274 | (or (previous-single-property-change (1+ (point)) :data) | |
275 | (point-min)) | |
276 | (or (next-single-property-change (point) :data) | |
277 | (point-max))))) | |
1a9461d0 CD |
278 | (if (integerp reftex-toc-follow-mode) |
279 | ;; remove delayed action | |
280 | (setq reftex-toc-follow-mode t) | |
3666daf6 CD |
281 | (and (not (reftex-toc-dframe-p)) |
282 | reftex-toc-follow-mode | |
283 | (not (equal reftex-last-follow-point (point))) | |
284 | ;; show context in other window | |
285 | (setq reftex-last-follow-point (point)) | |
286 | (condition-case nil | |
287 | (reftex-toc-visit-location nil (not reftex-revisit-to-follow)) | |
288 | (error t))))) | |
1a9461d0 CD |
289 | |
290 | (defun reftex-re-enlarge () | |
4a9699d8 | 291 | ;; Enlarge window to a remembered size. |
6fbeb429 CD |
292 | (if reftex-toc-split-windows-horizontally |
293 | (enlarge-window-horizontally | |
294 | (max 0 (- (or reftex-last-window-width (window-width)) | |
3666daf6 | 295 | (window-width)))) |
6fbeb429 CD |
296 | (enlarge-window |
297 | (max 0 (- (or reftex-last-window-height (window-height)) | |
3666daf6 CD |
298 | (window-height)))))) |
299 | ||
300 | (defun reftex-toc-dframe-p (&optional frame error) | |
52ebd91d | 301 | ;; Check if FRAME is the dedicated TOC frame. |
3666daf6 CD |
302 | ;; If yes, and ERROR is non-nil, throw an error. |
303 | (setq frame (or frame (selected-frame))) | |
52ebd91d | 304 | (let ((res (equal |
3666daf6 CD |
305 | (if (fboundp 'frame-property) |
306 | (frame-property frame 'name) | |
307 | (frame-parameter frame 'name)) | |
308 | "RefTeX TOC Frame"))) | |
309 | (if (and res error) | |
52ebd91d | 310 | (error "This frame is view-only. Use `C-c =' to create toc window for commands")) |
3666daf6 | 311 | res)) |
1a9461d0 CD |
312 | |
313 | (defun reftex-toc-show-help () | |
314 | "Show a summary of special key bindings." | |
315 | (interactive) | |
3666daf6 | 316 | (reftex-toc-dframe-p nil 'error) |
1a9461d0 CD |
317 | (with-output-to-temp-buffer "*RefTeX Help*" |
318 | (princ reftex-toc-help)) | |
319 | (reftex-enlarge-to-fit "*RefTeX Help*" t) | |
320 | ;; If follow mode is active, arrange to delay it one command | |
321 | (if reftex-toc-follow-mode | |
322 | (setq reftex-toc-follow-mode 1))) | |
323 | ||
324 | (defun reftex-toc-next (&optional arg) | |
325 | "Move to next selectable item." | |
326 | (interactive "p") | |
3666daf6 | 327 | (if (boundp 'zmacs-region-stays) (setq zmacs-region-stays t)) |
1a9461d0 CD |
328 | (setq reftex-callback-fwd t) |
329 | (or (eobp) (forward-char 1)) | |
52ebd91d | 330 | (goto-char (or (next-single-property-change (point) :data) |
3666daf6 | 331 | (point)))) |
1a9461d0 CD |
332 | (defun reftex-toc-previous (&optional arg) |
333 | "Move to previous selectable item." | |
334 | (interactive "p") | |
3666daf6 | 335 | (if (boundp 'zmacs-region-stays) (setq zmacs-region-stays t)) |
1a9461d0 CD |
336 | (setq reftex-callback-fwd nil) |
337 | (goto-char (or (previous-single-property-change (point) :data) | |
3666daf6 | 338 | (point)))) |
1a9461d0 CD |
339 | (defun reftex-toc-next-heading (&optional arg) |
340 | "Move to next table of contentes line." | |
341 | (interactive "p") | |
3666daf6 | 342 | (if (boundp 'zmacs-region-stays) (setq zmacs-region-stays t)) |
1a9461d0 CD |
343 | (end-of-line) |
344 | (re-search-forward "^ " nil t arg) | |
345 | (beginning-of-line)) | |
346 | (defun reftex-toc-previous-heading (&optional arg) | |
347 | "Move to previous table of contentes line." | |
348 | (interactive "p") | |
3666daf6 | 349 | (if (boundp 'zmacs-region-stays) (setq zmacs-region-stays t)) |
1a9461d0 CD |
350 | (re-search-backward "^ " nil t arg)) |
351 | (defun reftex-toc-toggle-follow () | |
352 | "Toggle follow (other window follows with context)." | |
353 | (interactive) | |
354 | (setq reftex-last-follow-point -1) | |
355 | (setq reftex-toc-follow-mode (not reftex-toc-follow-mode))) | |
356 | (defun reftex-toc-toggle-file-boundary () | |
357 | "Toggle inclusion of file boundaries in *toc* buffer." | |
358 | (interactive) | |
359 | (setq reftex-toc-include-file-boundaries | |
3666daf6 | 360 | (not reftex-toc-include-file-boundaries)) |
1a9461d0 CD |
361 | (reftex-toc-revert)) |
362 | (defun reftex-toc-toggle-labels (arg) | |
363 | "Toggle inclusion of labels in *toc* buffer. | |
364 | With prefix ARG, prompt for a label type and include only labels of | |
365 | that specific type." | |
366 | (interactive "P") | |
52ebd91d | 367 | (setq reftex-toc-include-labels |
3666daf6 CD |
368 | (if arg (reftex-query-label-type) |
369 | (not reftex-toc-include-labels))) | |
1a9461d0 CD |
370 | (reftex-toc-revert)) |
371 | (defun reftex-toc-toggle-index (arg) | |
372 | "Toggle inclusion of index in *toc* buffer. | |
373 | With prefix arg, prompt for an index tag and include only entries of that | |
374 | specific index." | |
375 | (interactive "P") | |
376 | (setq reftex-toc-include-index-entries | |
3666daf6 CD |
377 | (if arg (reftex-index-select-tag) |
378 | (not reftex-toc-include-index-entries))) | |
1a9461d0 CD |
379 | (reftex-toc-revert)) |
380 | (defun reftex-toc-toggle-context () | |
381 | "Toggle inclusion of label context in *toc* buffer. | |
382 | Label context is only displayed when the labels are there as well." | |
383 | (interactive) | |
384 | (setq reftex-toc-include-context (not reftex-toc-include-context)) | |
385 | (reftex-toc-revert)) | |
7c4d13cc CD |
386 | (defun reftex-toc-max-level (arg) |
387 | "Set the maximum level of toc lines in this buffer to value of prefix ARG. | |
388 | When no prefix is given, set the max level to a large number, so that all | |
389 | levels are shown. For eaxample, to set the level to 3, type `3 m'." | |
390 | (interactive "P") | |
391 | (setq reftex-toc-max-level (if arg | |
3666daf6 CD |
392 | (prefix-numeric-value arg) |
393 | 100)) | |
7c4d13cc | 394 | (setq reftex-toc-max-level-indicator |
3666daf6 | 395 | (if arg (int-to-string reftex-toc-max-level) "ALL")) |
7c4d13cc | 396 | (reftex-toc-revert)) |
1a9461d0 CD |
397 | (defun reftex-toc-view-line () |
398 | "View document location in other window." | |
399 | (interactive) | |
3666daf6 | 400 | (reftex-toc-dframe-p nil 'error) |
1a9461d0 CD |
401 | (reftex-toc-visit-location)) |
402 | (defun reftex-toc-goto-line-and-hide () | |
403 | "Go to document location in other window. Hide the *toc* window." | |
404 | (interactive) | |
3666daf6 | 405 | (reftex-toc-dframe-p nil 'error) |
1a9461d0 CD |
406 | (reftex-toc-visit-location 'hide)) |
407 | (defun reftex-toc-goto-line () | |
408 | "Go to document location in other window. *toc* window stays." | |
409 | (interactive) | |
3666daf6 | 410 | (reftex-toc-dframe-p nil 'error) |
1a9461d0 CD |
411 | (reftex-toc-visit-location t)) |
412 | (defun reftex-toc-mouse-goto-line-and-hide (ev) | |
413 | "Go to document location in other window. Hide the *toc* window." | |
414 | (interactive "e") | |
415 | (mouse-set-point ev) | |
3666daf6 | 416 | (reftex-toc-dframe-p nil 'error) |
1a9461d0 CD |
417 | (reftex-toc-visit-location 'hide)) |
418 | (defun reftex-toc-show-calling-point () | |
419 | "Show point where reftex-toc was called from." | |
420 | (interactive) | |
3666daf6 | 421 | (reftex-toc-dframe-p nil 'error) |
1a9461d0 CD |
422 | (let ((this-window (selected-window))) |
423 | (unwind-protect | |
3666daf6 CD |
424 | (progn |
425 | (switch-to-buffer-other-window | |
426 | (marker-buffer reftex-toc-return-marker)) | |
427 | (goto-char (marker-position reftex-toc-return-marker)) | |
428 | (recenter '(4))) | |
1a9461d0 CD |
429 | (select-window this-window)))) |
430 | (defun reftex-toc-quit () | |
3666daf6 CD |
431 | "Hide the *toc* window and do not move point. |
432 | If the toc window is the only window on the dedicated TOC frame, the frame | |
433 | is destroyed." | |
1a9461d0 | 434 | (interactive) |
3666daf6 CD |
435 | (if (and (one-window-p) |
436 | (reftex-toc-dframe-p) | |
437 | (> (length (frame-list)) 1)) | |
438 | (delete-frame) | |
439 | (or (one-window-p) (delete-window)) | |
440 | (switch-to-buffer (marker-buffer reftex-toc-return-marker)) | |
441 | (reftex-re-enlarge) | |
442 | (goto-char (or (marker-position reftex-toc-return-marker) (point))))) | |
1a9461d0 CD |
443 | (defun reftex-toc-quit-and-kill () |
444 | "Kill the *toc* buffer." | |
445 | (interactive) | |
446 | (kill-buffer "*toc*") | |
447 | (or (one-window-p) (delete-window)) | |
448 | (switch-to-buffer (marker-buffer reftex-toc-return-marker)) | |
449 | (reftex-re-enlarge) | |
450 | (goto-char (marker-position reftex-toc-return-marker))) | |
451 | (defun reftex-toc-display-index (&optional arg) | |
452 | "Display the index buffer for the current document. | |
453 | This works just like `reftex-display-index' from a LaTeX buffer. | |
454 | With prefix arg 1, restrict index to the section at point." | |
455 | (interactive "P") | |
3666daf6 | 456 | (reftex-toc-dframe-p nil 'error) |
1a9461d0 | 457 | (let ((data (get-text-property (point) :data)) |
3666daf6 CD |
458 | (docstruct (symbol-value reftex-docstruct-symbol)) |
459 | bor eor restr) | |
1a9461d0 CD |
460 | (when (equal arg 2) |
461 | (setq bor (reftex-last-assoc-before-elt 'toc data docstruct) | |
3666daf6 CD |
462 | eor (assoc 'toc (cdr (memq bor docstruct))) |
463 | restr (list (nth 6 bor) bor eor))) | |
1a9461d0 CD |
464 | (reftex-toc-goto-line) |
465 | (reftex-display-index (if restr nil arg) restr))) | |
3666daf6 CD |
466 | |
467 | ;; Rescanning the document and rebuilding the TOC buffer. | |
1a9461d0 CD |
468 | (defun reftex-toc-rescan (&rest ignore) |
469 | "Regenerate the *toc* buffer by reparsing file of section at point." | |
470 | (interactive) | |
52ebd91d | 471 | (if (and reftex-enable-partial-scans |
3666daf6 | 472 | (null current-prefix-arg)) |
1a9461d0 | 473 | (let* ((data (get-text-property (point) :data)) |
3666daf6 CD |
474 | (what (car data)) |
475 | (file (cond ((eq what 'toc) (nth 3 data)) | |
476 | ((memq what '(eof bof file-error)) (nth 1 data)) | |
477 | ((stringp what) (nth 3 data)) | |
478 | ((eq what 'index) (nth 3 data)))) | |
479 | (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0)))) | |
1a9461d0 CD |
480 | (if (not file) |
481 | (error "Don't know which file to rescan. Try `C-u r'") | |
3666daf6 | 482 | (put 'reftex-toc :reftex-line line) |
1a9461d0 CD |
483 | (switch-to-buffer-other-window |
484 | (reftex-get-file-buffer-force file)) | |
3666daf6 CD |
485 | (setq current-prefix-arg '(4)) |
486 | (let ((reftex-rebuilding-toc t)) | |
487 | (reftex-toc)))) | |
1a9461d0 CD |
488 | (reftex-toc-Rescan)) |
489 | (reftex-kill-temporary-buffers)) | |
3666daf6 | 490 | |
1a9461d0 CD |
491 | (defun reftex-toc-Rescan (&rest ignore) |
492 | "Regenerate the *toc* buffer by reparsing the entire document." | |
493 | (interactive) | |
3b919c9f CD |
494 | (let* ((line (+ (count-lines (point-min) (point)) (if (bolp) 1 0)))) |
495 | (put 'reftex-toc :reftex-line line)) | |
1a9461d0 CD |
496 | (switch-to-buffer-other-window |
497 | (reftex-get-file-buffer-force reftex-last-toc-file)) | |
498 | (setq current-prefix-arg '(16)) | |
3b919c9f CD |
499 | (let ((reftex-rebuilding-toc t)) |
500 | (reftex-toc))) | |
3666daf6 | 501 | |
1a9461d0 CD |
502 | (defun reftex-toc-revert (&rest ignore) |
503 | "Regenerate the *toc* from the internal lists." | |
504 | (interactive) | |
52ebd91d | 505 | (let ((unsplittable |
3666daf6 CD |
506 | (if (fboundp 'frame-property) |
507 | (frame-property (selected-frame) 'unsplittable) | |
508 | (frame-parameter (selected-frame) 'unsplittable))) | |
509 | (reftex-rebuilding-toc t)) | |
510 | (if unsplittable | |
511 | (switch-to-buffer | |
512 | (reftex-get-file-buffer-force reftex-last-toc-file)) | |
513 | (switch-to-buffer-other-window | |
514 | (reftex-get-file-buffer-force reftex-last-toc-file)))) | |
1a9461d0 CD |
515 | (reftex-erase-buffer "*toc*") |
516 | (setq current-prefix-arg nil) | |
3666daf6 CD |
517 | (reftex-toc t)) |
518 | ||
1a9461d0 CD |
519 | (defun reftex-toc-external (&rest ignore) |
520 | "Switch to table of contents of an external document." | |
521 | (interactive) | |
3666daf6 | 522 | (reftex-toc-dframe-p nil 'error) |
1a9461d0 | 523 | (let* ((old-buf (current-buffer)) |
3666daf6 CD |
524 | (xr-alist (get-text-property 1 'xr-alist)) |
525 | (xr-index (reftex-select-external-document | |
526 | xr-alist 0))) | |
1a9461d0 | 527 | (switch-to-buffer-other-window (or (reftex-get-file-buffer-force |
3666daf6 CD |
528 | (cdr (nth xr-index xr-alist))) |
529 | (error "Cannot switch document"))) | |
1a9461d0 CD |
530 | (reftex-toc) |
531 | (if (equal old-buf (current-buffer)) | |
3666daf6 | 532 | (message "") |
1a9461d0 CD |
533 | (message "Switched document")))) |
534 | ||
70d797cd CD |
535 | (defun reftex-toc-jump (arg) |
536 | "Jump to a specific section. E.g. '3 z' jumps to section 3. | |
537 | Useful for large TOC's." | |
538 | (interactive "P") | |
539 | (goto-char (point-min)) | |
540 | (re-search-forward | |
541 | (concat "^ *" (number-to-string (if (numberp arg) arg 1)) " ") | |
542 | nil t) | |
543 | (beginning-of-line)) | |
544 | ||
3666daf6 CD |
545 | ;; Promotion/Demotion stuff |
546 | ||
547 | (defun reftex-toc-demote (&optional arg) | |
548 | "Demote section at point. If region is active, apply to all in region." | |
549 | (interactive "p") | |
550 | (reftex-toc-do-promote 1)) | |
551 | (defun reftex-toc-promote (&optional arg) | |
552 | "Promote section at point. If region is active, apply to all in region." | |
553 | (interactive "p") | |
554 | (reftex-toc-do-promote -1)) | |
555 | (defun reftex-toc-do-promote (delta) | |
556 | "Workhorse for reftex-toc-promote and reftex-to-demote. | |
557 | Changes the level of sections in the current region, or just the section at | |
558 | point." | |
559 | ;; We should not do anything unless we are sure this is going to work for | |
560 | ;; each section in the region. Therefore we first collect information and | |
561 | ;; test. | |
562 | (let* ((start-line (+ (count-lines (point-min) (point)) | |
563 | (if (bolp) 1 0))) | |
564 | (mark-line (if (reftex-region-active-p) | |
565 | (save-excursion (goto-char (mark)) | |
566 | (+ (count-lines (point-min) (point)) | |
567 | (if (bolp) 1 0))))) | |
568 | (start-pos (point)) | |
569 | (pro-or-de (if (> delta 0) "de" "pro")) | |
570 | beg end entries data sections nsec mpos msg) | |
571 | (setq msg | |
572 | (catch 'exit | |
573 | (if (reftex-region-active-p) | |
574 | ;; A region is dangerous, check if we have a brandnew scan, | |
575 | ;; to make sure we are not missing any section statements. | |
576 | (if (not (reftex-toc-check-docstruct)) | |
577 | (reftex-toc-load-all-files-for-promotion) ;; exits | |
578 | (setq beg (min (point) (mark)) | |
579 | end (max (point) (mark)))) | |
580 | (setq beg (point) end (point))) | |
581 | (goto-char beg) | |
582 | (while (and (setq data (get-text-property (point) :data)) | |
583 | (<= (point) end)) | |
584 | (if (eq (car data) 'toc) (push (cons data (point)) entries)) | |
585 | (goto-char (or (next-single-property-change (point) :data) | |
586 | (point-max)))) | |
587 | (setq entries (nreverse entries)) | |
588 | ;; Get the relevant section numbers, for an informative message | |
589 | (goto-char start-pos) | |
590 | (setq sections (reftex-toc-extract-section-number (car entries))) | |
591 | (if (> (setq nsec (length entries)) 1) | |
52ebd91d | 592 | (setq sections |
3666daf6 CD |
593 | (concat sections "-" |
594 | (reftex-toc-extract-section-number | |
595 | (nth (1- nsec) entries))))) | |
596 | ;; Run through the list and prepare the changes. | |
597 | (setq entries (mapcar 'reftex-toc-promote-prepare entries)) | |
598 | ;; Ask for permission | |
599 | (if (or (not reftex-toc-confirm-promotion) ; never confirm | |
600 | (and (integerp reftex-toc-confirm-promotion) ; confirm if many | |
601 | (< nsec reftex-toc-confirm-promotion)) | |
602 | (yes-or-no-p ; ask | |
603 | (format "%s %d toc-entr%s (section%s %s)? " | |
604 | (if (< delta 0) "Promote" "Demote") | |
605 | nsec | |
606 | (if (= 1 nsec) "y" "ies") | |
607 | (if (= 1 nsec) "" "s") | |
608 | sections))) | |
609 | nil ; we have permission, do nothing | |
610 | (error "Abort")) ; abort, we don't have permission | |
611 | ;; Do the changes | |
612 | (mapcar 'reftex-toc-promote-action entries) | |
613 | ;; Rescan the document and rebuilt the toc buffer | |
614 | (save-window-excursion | |
615 | (reftex-toc-Rescan)) | |
616 | (reftex-toc-restore-region start-line mark-line) | |
52ebd91d | 617 | (message "%d section%s %smoted" |
3666daf6 CD |
618 | nsec (if (= 1 nsec) "" "s") pro-or-de) |
619 | nil)) | |
620 | (if msg (progn (ding) (message msg))))) | |
621 | ||
622 | (defvar delta) | |
623 | (defvar mpos) | |
624 | (defvar pro-or-de) | |
625 | (defvar start-pos) | |
626 | (defvar start-line) | |
627 | (defvar mark-line) | |
628 | ||
629 | (defun reftex-toc-restore-region (point-line &optional mark-line) | |
630 | (if mark-line | |
631 | (progn (goto-line mark-line) | |
632 | (setq mpos (point)))) | |
633 | (if point-line (goto-line point-line)) | |
634 | (if mark-line | |
635 | (progn | |
636 | (set-mark mpos) | |
637 | (if (fboundp 'zmacs-activate-region) | |
638 | (zmacs-activate-region) | |
639 | (setq mark-active t | |
640 | deactivate-mark nil))))) | |
641 | ||
642 | (defun reftex-toc-promote-prepare (x) | |
643 | "Look at a toc entry and see if we could pro/demote it. | |
644 | Expects the level change DELTA to be dynamically scoped into this function. | |
645 | This function prepares everything for the changes, but does not do it. | |
646 | The return value is a list with information needed when doing the | |
647 | promotion/demotion later." | |
648 | (let* ((data (car x)) | |
649 | (toc-point (cdr x)) | |
650 | (marker (nth 4 data)) | |
651 | (literal (nth 7 data)) | |
652 | (load nil) | |
653 | (name nil) | |
654 | ;; Here follows some paranoid code to make very sure we are not | |
655 | ;; going to break anything | |
656 | (name1 ; dummy | |
657 | (if (and (markerp marker) (marker-buffer marker)) | |
658 | ;; Buffer is still live and we have the marker. | |
659 | (progn | |
660 | (save-excursion | |
661 | ;; Goto the buffer and check of section is unchanged | |
662 | (set-buffer (marker-buffer marker)) | |
663 | (goto-char (marker-position marker)) | |
664 | (if (looking-at (regexp-quote literal)) | |
665 | ;; OK, get the makro name | |
666 | (progn | |
667 | (beginning-of-line 1) | |
668 | (if (looking-at reftex-section-regexp) | |
669 | (setq name (reftex-match-string 2)) | |
52ebd91d | 670 | (error "Something is wrong! Contact maintainer!"))) |
3666daf6 CD |
671 | ;; Section has changed, request scan and loading |
672 | ;; We use a variable to delay until after the safe-exc. | |
673 | ;; because otherwise we loose the region. | |
674 | (setq load t))) | |
675 | ;; Scan document and load all files, this exits command | |
676 | (if load (reftex-toc-load-all-files-for-promotion))) ; exits | |
677 | ;; We don't have a live marker: scan and load files. | |
678 | (reftex-toc-load-all-files-for-promotion))) | |
679 | (level (cdr (assoc name reftex-section-levels-all))) | |
680 | (dummy (if (not (integerp level)) | |
681 | (progn | |
682 | (goto-char toc-point) | |
683 | (error "Cannot %smote special sections" pro-or-de)))) | |
684 | ;; Delta is dynamically scoped into here... | |
685 | (newlevel (if (>= level 0) (+ delta level) (- level delta))) | |
686 | (dummy2 (if (or (and (>= level 0) (= newlevel -1)) | |
687 | (and (< level 0) (= newlevel 0))) | |
688 | (error "Cannot %smote \\%s" pro-or-de name))) | |
689 | (newname (reftex-toc-newhead-from-alist newlevel name | |
690 | reftex-section-levels-all))) | |
691 | (if (and name newname) | |
692 | (list data name newname toc-point) | |
693 | (goto-char toc-point) | |
694 | (error "Cannot %smote \\%s" pro-or-de name)))) | |
695 | ||
696 | (defun reftex-toc-promote-action (x) | |
697 | "Change the level of a toc entry. | |
698 | DELTA and PRO-OR-DE are assumed to be dynamically scoped into this function." | |
699 | (let* ((data (car x)) | |
700 | (name (nth 1 x)) | |
701 | (newname (nth 2 x)) | |
702 | (marker (nth 4 data))) | |
703 | (save-excursion | |
704 | (set-buffer (marker-buffer marker)) | |
705 | (goto-char (marker-position marker)) | |
706 | (if (looking-at (concat "\\([ \t]*\\\\\\)" (regexp-quote name))) | |
707 | (replace-match (concat "\\1" newname)) | |
708 | (error "Fatal error during %smotion" pro-or-de))))) | |
709 | ||
710 | (defun reftex-toc-extract-section-number (entry) | |
711 | "Get the numbering of a toc entry, for message purposes." | |
712 | (if (string-match "\\s-*\\(\\S-+\\)" (nth 2 (car entry))) | |
713 | (match-string 1 (nth 2 (car entry))) | |
714 | "?")) | |
715 | ||
716 | (defun reftex-toc-newhead-from-alist (nlevel head alist) | |
717 | "Get new heading with level NLEVEL from ALIST. | |
718 | If there are no such entries, return nil. | |
719 | If there are several different entries with same new level, choose | |
720 | the one with the smallest distance to the assocation of HEAD in the alist. | |
721 | This makes it possible for promotion to work several sets of headings, | |
722 | if these sets are sorted blocks in the alist." | |
723 | (let* ((al alist) | |
724 | (ass (assoc head al)) | |
725 | (pos (length (memq ass al))) | |
726 | dist (mindist 1000) newhead) | |
727 | (while al | |
728 | (if (equal (cdar al) nlevel) | |
729 | (progn | |
730 | (setq dist (abs (- (length al) pos))) | |
731 | (if (< dist mindist) | |
732 | (setq newhead (car (car al)) | |
733 | mindist dist)))) | |
734 | (setq al (cdr al))) | |
735 | newhead)) | |
736 | ||
737 | (defun reftex-toc-check-docstruct () | |
738 | "Check if the current docstruct is fully up to date and all files visited." | |
739 | ;; We do this by checking if all sections are on the right position | |
740 | (let ((docstruct (symbol-value reftex-docstruct-symbol)) | |
741 | entry marker empoint) | |
742 | (catch 'exit | |
743 | (while (setq entry (pop docstruct)) | |
744 | (if (eq (car entry) 'toc) | |
745 | (progn | |
746 | (setq marker (nth 4 entry) | |
747 | empoint (nth 8 entry)) | |
748 | (if (not (and (markerp marker) | |
749 | (marker-buffer marker) | |
750 | (= (marker-position marker) empoint))) | |
751 | (throw 'exit nil))))) | |
752 | t))) | |
753 | ||
754 | (defun reftex-toc-load-all-files-for-promotion () | |
755 | "Make sure all files of the document are being visited by buffers, | |
756 | and that the scanning info is absolutely up to date. | |
757 | We do this by rescanning with reftex-keep-temporary-buffers bound to t. | |
42187e99 | 758 | The variable PRO-OR-DE is assumed to be dynamically scoped into this function. |
3666daf6 CD |
759 | When finished, we exit with an error message." |
760 | (let ((reftex-keep-temporary-buffers t)) | |
761 | (reftex-toc-Rescan) | |
762 | (reftex-toc-restore-region start-line mark-line) | |
763 | (throw 'exit | |
42187e99 | 764 | "TOC had to be updated first. Please check selection and repeat the command."))) |
3666daf6 CD |
765 | |
766 | (defun reftex-toc-rename-label () | |
767 | "Rename the currently selected label in the *TOC* buffer. | |
768 | This launches a global search and replace in order to rename a label. | |
769 | Renaming a label is hardly ever necessary - the only exeption is after | |
770 | promotion/demotion in connection with a package like fancyref, where the | |
771 | label prefix determines the wording of a reference." | |
772 | (interactive) | |
773 | (let* ((toc (get-text-property (point) :data)) | |
774 | (label (car toc)) newlabel) | |
775 | (if (not (stringp label)) | |
776 | (error "This is not a label entry.")) | |
777 | (setq newlabel (read-string (format "Rename label \"%s\" to:" label))) | |
778 | (if (assoc newlabel (symbol-value reftex-docstruct-symbol)) | |
52ebd91d | 779 | (if (not (y-or-n-p |
3666daf6 CD |
780 | (format "Label '%s' exists. Use anyway? " label))) |
781 | (error "Abort"))) | |
782 | (save-excursion | |
783 | (save-window-excursion | |
784 | (reftex-toc-visit-location t) | |
785 | (condition-case nil | |
786 | (reftex-query-replace-document | |
787 | (concat "{" (regexp-quote label) "}") | |
788 | (format "{%s}" newlabel)) | |
52ebd91d | 789 | (error t)))) |
3666daf6 CD |
790 | (reftex-toc-rescan))) |
791 | ||
792 | ||
1a9461d0 CD |
793 | (defun reftex-toc-visit-location (&optional final no-revisit) |
794 | ;; Visit the tex file corresponding to the toc entry on the current line. | |
795 | ;; If FINAL is t, stay there | |
796 | ;; If FINAL is 'hide, hide the *toc* window. | |
797 | ;; Otherwise, move cursor back into *toc* window. | |
4a9699d8 | 798 | ;; NO-REVISIT means don't visit files, just use live buffers. |
1a9461d0 CD |
799 | ;; This function is pretty clever about finding back a section heading, |
800 | ;; even if the buffer is not live, or things like outline, x-symbol etc. | |
801 | ;; have been active. | |
802 | ||
803 | (let* ((toc (get-text-property (point) :data)) | |
804 | (toc-window (selected-window)) | |
805 | show-window show-buffer match) | |
806 | ||
807 | (unless toc (error "Don't know which toc line to visit")) | |
52ebd91d | 808 | |
1a9461d0 | 809 | (cond |
52ebd91d | 810 | |
1a9461d0 CD |
811 | ((eq (car toc) 'toc) |
812 | ;; a toc entry | |
813 | (setq match (reftex-toc-find-section toc no-revisit))) | |
814 | ||
815 | ((eq (car toc) 'index) | |
816 | ;; an index entry | |
817 | (setq match (reftex-index-show-entry toc no-revisit))) | |
818 | ||
819 | ((memq (car toc) '(bof eof)) | |
820 | ;; A file entry | |
821 | (setq match | |
3666daf6 CD |
822 | (let ((where (car toc)) |
823 | (file (nth 1 toc))) | |
824 | (if (or (not no-revisit) (reftex-get-buffer-visiting file)) | |
825 | (progn | |
52ebd91d | 826 | (switch-to-buffer-other-window |
3666daf6 CD |
827 | (reftex-get-file-buffer-force file nil)) |
828 | (goto-char (if (eq where 'bof) (point-min) (point-max)))) | |
829 | (message reftex-no-follow-message) nil)))) | |
1a9461d0 CD |
830 | |
831 | ((stringp (car toc)) | |
832 | ;; a label | |
833 | (setq match (reftex-show-label-location toc reftex-callback-fwd | |
3666daf6 | 834 | no-revisit t)))) |
1a9461d0 CD |
835 | |
836 | (setq show-window (selected-window) | |
837 | show-buffer (current-buffer)) | |
838 | ||
839 | (unless match | |
840 | (select-window toc-window) | |
841 | (error "Cannot find location")) | |
842 | ||
843 | (select-window toc-window) | |
844 | ||
845 | ;; use the `final' parameter to decide what to do next | |
846 | (cond | |
847 | ((eq final t) | |
848 | (reftex-unhighlight 0) | |
849 | (select-window show-window)) | |
850 | ((eq final 'hide) | |
851 | (reftex-unhighlight 0) | |
852 | (or (one-window-p) (delete-window)) | |
4a9699d8 SM |
853 | ;; If `show-window' is still live, show-buffer is already visible |
854 | ;; so let's not make it visible in yet-another-window. | |
855 | (if (window-live-p show-window) | |
3666daf6 | 856 | (set-buffer show-buffer) |
4a9699d8 | 857 | (switch-to-buffer show-buffer)) |
1a9461d0 CD |
858 | (reftex-re-enlarge)) |
859 | (t nil)))) | |
860 | ||
861 | (defun reftex-toc-find-section (toc &optional no-revisit) | |
862 | (let* ((file (nth 3 toc)) | |
3666daf6 CD |
863 | (marker (nth 4 toc)) |
864 | (level (nth 5 toc)) | |
865 | (literal (nth 7 toc)) | |
866 | (emergency-point (nth 8 toc)) | |
867 | (match | |
868 | (cond | |
869 | ((and (markerp marker) (marker-buffer marker)) | |
870 | ;; Buffer is still live and we have the marker. Should be easy. | |
871 | (switch-to-buffer-other-window (marker-buffer marker)) | |
f3c18bd0 | 872 | (push-mark nil) |
3666daf6 CD |
873 | (goto-char (marker-position marker)) |
874 | (or (looking-at (regexp-quote literal)) | |
875 | (looking-at (reftex-make-regexp-allow-for-ctrl-m literal)) | |
876 | (looking-at (reftex-make-desperate-section-regexp literal)) | |
877 | (looking-at (concat "\\\\" | |
878 | (regexp-quote | |
52ebd91d JB |
879 | (car |
880 | (rassq level | |
3666daf6 CD |
881 | reftex-section-levels-all))) |
882 | "[[{]?")))) | |
883 | ((or (not no-revisit) | |
884 | (reftex-get-buffer-visiting file)) | |
885 | ;; Marker is lost. Use the backup method. | |
886 | (switch-to-buffer-other-window | |
887 | (reftex-get-file-buffer-force file nil)) | |
888 | (goto-char (or emergency-point (point-min))) | |
889 | (or (looking-at (regexp-quote literal)) | |
890 | (let ((len (length literal))) | |
891 | (or (reftex-nearest-match (regexp-quote literal) len) | |
892 | (reftex-nearest-match | |
893 | (reftex-make-regexp-allow-for-ctrl-m literal) len) | |
894 | (reftex-nearest-match | |
895 | (reftex-make-desperate-section-regexp literal) len))))) | |
896 | (t (message reftex-no-follow-message) nil)))) | |
1a9461d0 CD |
897 | (when match |
898 | (goto-char (match-beginning 0)) | |
899 | (if (not (= (point) (point-max))) (recenter 1)) | |
900 | (reftex-highlight 0 (match-beginning 0) (match-end 0) (current-buffer))) | |
901 | match)) | |
902 | ||
903 | (defun reftex-make-desperate-section-regexp (old) | |
904 | ;; Return a regexp which will still match a section statement even if | |
905 | ;; x-symbol or isotex or the like have been at work in the mean time. | |
906 | (let* ((n (1+ (string-match "[[{]" old))) | |
907 | (new (regexp-quote (substring old 0 (1+ (string-match "[[{]" old))))) | |
908 | (old (substring old n))) | |
909 | (while (string-match | |
910 | "\\([\r\n]\\)\\|\\(\\`\\|[ \t\n\r]\\)\\([a-zA-Z0-9]+\\)\\([ \t\n\r]\\|}\\'\\)" | |
911 | old) | |
912 | (if (match-beginning 1) | |
913 | (setq new (concat new "[^\n\r]*[\n\r]")) | |
914 | (setq new (concat new "[^\n\r]*" (match-string 3 old)))) | |
915 | (setq old (substring old (match-end 0)))) | |
916 | new)) | |
917 | ||
3666daf6 | 918 | ;; Auto recentering of TOC window |
3b919c9f CD |
919 | |
920 | (defun reftex-recenter-toc-when-idle () | |
921 | (and (> (buffer-size) 5) | |
922 | reftex-mode | |
923 | (not (active-minibuffer-window)) | |
924 | (fboundp 'reftex-toc-mode) | |
3666daf6 | 925 | (get-buffer-window "*toc*" 'visible) |
3b919c9f | 926 | (string= reftex-last-toc-master (reftex-TeX-master-file)) |
3666daf6 CD |
927 | (let (current-prefix-arg) |
928 | (reftex-toc-recenter)))) | |
3b919c9f CD |
929 | |
930 | (defun reftex-toggle-auto-toc-recenter () | |
931 | "Toggle the automatic recentering of the toc window. | |
932 | When active, leaving point idle will make the toc window jump to the correct | |
933 | section." | |
934 | (interactive) | |
935 | (if reftex-toc-auto-recenter-timer | |
936 | (progn | |
3666daf6 CD |
937 | (if (featurep 'xemacs) |
938 | (delete-itimer reftex-toc-auto-recenter-timer) | |
939 | (cancel-timer reftex-toc-auto-recenter-timer)) | |
940 | (setq reftex-toc-auto-recenter-timer nil) | |
941 | (message "Automatic recentering of toc windwo was turned off")) | |
3b919c9f | 942 | (setq reftex-toc-auto-recenter-timer |
3666daf6 CD |
943 | (if (featurep 'xemacs) |
944 | (start-itimer "RefTeX Idle Timer for recenter" | |
945 | 'reftex-recenter-toc-when-idle | |
946 | reftex-idle-time reftex-idle-time t) | |
947 | (run-with-idle-timer | |
948 | reftex-idle-time t 'reftex-recenter-toc-when-idle))) | |
3b919c9f CD |
949 | (message "Automatic recentering of toc window was turned on"))) |
950 | ||
3666daf6 CD |
951 | (defun reftex-toc-toggle-dedicated-frame () |
952 | "Toggle the display of a separate frame for the TOC. | |
953 | This frame is not used by the `reftex-toc' commands, but it is useful to | |
954 | always show the current section in connection with the option | |
955 | `reftex-auto-recenter-toc'." | |
956 | (interactive) | |
957 | (catch 'exit | |
958 | (let* ((frames (frame-list)) frame | |
959 | (get-frame-prop-func (if (fboundp 'frame-property) | |
960 | 'frame-property | |
961 | 'frame-parameter))) | |
962 | (while (setq frame (pop frames)) | |
963 | (if (equal (funcall get-frame-prop-func frame 'name) | |
964 | "RefTeX TOC Frame") | |
965 | (progn | |
966 | (delete-frame frame) | |
967 | (throw 'exit nil)))) | |
968 | (reftex-make-separate-toc-frame)))) | |
969 | ||
970 | (defun reftex-make-separate-toc-frame () | |
971 | ;; Create a new fame showing only the toc buffer. | |
972 | (let ((current-frame (selected-frame)) | |
973 | (current-window (selected-window)) | |
974 | (current-toc-window (get-buffer-window "*toc*" 'visible)) | |
975 | current-toc-frame) | |
976 | (if (and current-toc-window | |
977 | (not (equal (selected-frame) (window-frame current-toc-window)))) | |
978 | nil | |
979 | (setq current-toc-frame | |
980 | (make-frame | |
981 | '((name . "RefTeX TOC Frame") | |
982 | (height . 20) (width . 60) | |
983 | (unsplittable . t) | |
984 | (minibuffer . nil) | |
985 | (default-toolbar-visible-p . nil) | |
986 | (menubar-visible-p . nil) | |
987 | (horizontal-scrollbar-visible-p . nil)))) | |
988 | (select-frame current-toc-frame) | |
989 | (switch-to-buffer "*toc*") | |
990 | (select-frame current-frame) | |
991 | (if (fboundp 'focus-frame) (focus-frame current-frame) | |
992 | (if (fboundp 'x-focus-frame) (x-focus-frame current-frame))) | |
993 | (select-window current-window) | |
994 | (when (eq reftex-auto-recenter-toc 'frame) | |
995 | (unless reftex-toc-auto-recenter-timer | |
996 | (reftex-toggle-auto-toc-recenter)) | |
997 | (add-hook 'delete-frame-hook 'reftex-toc-delete-frame-hook))))) | |
998 | ||
999 | (defun reftex-toc-delete-frame-hook (frame) | |
1000 | (if (and reftex-toc-auto-recenter-timer | |
1001 | (reftex-toc-dframe-p frame)) | |
1002 | (progn | |
1003 | (reftex-toggle-auto-toc-recenter)))) | |
3b919c9f | 1004 | |
1a9461d0 CD |
1005 | ;; Table of Contents map |
1006 | (define-key reftex-toc-map (if (featurep 'xemacs) [(button2)] [(mouse-2)]) | |
1007 | 'reftex-toc-mouse-goto-line-and-hide) | |
1008 | ||
1009 | (substitute-key-definition | |
1010 | 'next-line 'reftex-toc-next reftex-toc-map global-map) | |
1011 | (substitute-key-definition | |
1012 | 'previous-line 'reftex-toc-previous reftex-toc-map global-map) | |
1013 | ||
1014 | (loop for x in | |
3666daf6 CD |
1015 | '(("n" . reftex-toc-next) |
1016 | ("p" . reftex-toc-previous) | |
1017 | ("?" . reftex-toc-show-help) | |
1018 | (" " . reftex-toc-view-line) | |
1019 | ("\C-m" . reftex-toc-goto-line-and-hide) | |
1020 | ("\C-i" . reftex-toc-goto-line) | |
1021 | ("\C-c>" . reftex-toc-display-index) | |
1022 | ("r" . reftex-toc-rescan) | |
1023 | ("R" . reftex-toc-Rescan) | |
1024 | ("g" . revert-buffer) | |
1025 | ("q" . reftex-toc-quit); | |
1026 | ("k" . reftex-toc-quit-and-kill) | |
1027 | ("f" . reftex-toc-toggle-follow); | |
1028 | ("a" . reftex-toggle-auto-toc-recenter) | |
1029 | ("d" . reftex-toc-toggle-dedicated-frame) | |
1030 | ("F" . reftex-toc-toggle-file-boundary) | |
1031 | ("i" . reftex-toc-toggle-index) | |
1032 | ("l" . reftex-toc-toggle-labels) | |
1033 | ("t" . reftex-toc-max-level) | |
1034 | ("c" . reftex-toc-toggle-context) | |
1035 | ; ("%" . reftex-toc-toggle-commented) | |
1036 | ("\M-%" . reftex-toc-rename-label) | |
1037 | ("x" . reftex-toc-external) | |
1038 | ("z" . reftex-toc-jump) | |
1039 | ("." . reftex-toc-show-calling-point) | |
1040 | ("\C-c\C-n" . reftex-toc-next-heading) | |
1041 | ("\C-c\C-p" . reftex-toc-previous-heading) | |
1042 | (">" . reftex-toc-demote) | |
1043 | ("<" . reftex-toc-promote)) | |
1a9461d0 CD |
1044 | do (define-key reftex-toc-map (car x) (cdr x))) |
1045 | ||
1046 | (loop for key across "0123456789" do | |
1047 | (define-key reftex-toc-map (vector (list key)) 'digit-argument)) | |
1048 | (define-key reftex-toc-map "-" 'negative-argument) | |
1049 | ||
52ebd91d | 1050 | (easy-menu-define |
1a9461d0 CD |
1051 | reftex-toc-menu reftex-toc-map |
1052 | "Menu for Table of Contents buffer" | |
1053 | '("TOC" | |
1054 | ["Show Location" reftex-toc-view-line t] | |
1055 | ["Go To Location" reftex-toc-goto-line t] | |
1056 | ["Exit & Go To Location" reftex-toc-goto-line-and-hide t] | |
3666daf6 | 1057 | ["Show Calling Point" reftex-toc-show-calling-point t] |
1a9461d0 CD |
1058 | ["Quit" reftex-toc-quit t] |
1059 | "--" | |
3666daf6 CD |
1060 | ("Edit" |
1061 | ["Promote" reftex-toc-promote t] | |
1062 | ["Demote" reftex-toc-demote t] | |
1063 | ["Rename Label" reftex-toc-rename-label t]) | |
1064 | "--" | |
1065 | ["Index" reftex-toc-display-index t] | |
1a9461d0 CD |
1066 | ["External Document TOC " reftex-toc-external t] |
1067 | "--" | |
1068 | ("Update" | |
11b4a0d2 | 1069 | ["Rebuilt *toc* Buffer" revert-buffer t] |
1a9461d0 CD |
1070 | ["Rescan One File" reftex-toc-rescan reftex-enable-partial-scans] |
1071 | ["Rescan Entire Document" reftex-toc-Rescan t]) | |
1072 | ("Options" | |
1073 | "TOC Items" | |
1074 | ["File Boundaries" reftex-toc-toggle-file-boundary :style toggle | |
1075 | :selected reftex-toc-include-file-boundaries] | |
1076 | ["Labels" reftex-toc-toggle-labels :style toggle | |
1077 | :selected reftex-toc-include-labels] | |
1078 | ["Index Entries" reftex-toc-toggle-index :style toggle | |
1079 | :selected reftex-toc-include-index-entries] | |
1080 | ["Context" reftex-toc-toggle-context :style toggle | |
1081 | :selected reftex-toc-include-context] | |
1082 | "--" | |
52ebd91d | 1083 | ["Follow Mode" reftex-toc-toggle-follow :style toggle |
3666daf6 CD |
1084 | :selected reftex-toc-follow-mode] |
1085 | ["Auto Recenter" reftex-toggle-auto-toc-recenter :style toggle | |
1086 | :selected reftex-toc-auto-recenter-timer] | |
1087 | ["Dedicated Frame" reftex-toc-toggle-dedicated-frame t]) | |
1a9461d0 CD |
1088 | "--" |
1089 | ["Help" reftex-toc-show-help t])) | |
1090 | ||
1091 | ||
ab5796a9 | 1092 | ;;; arch-tag: 92400ce2-0b86-4c89-a606-4ed71acea17e |
f3c18bd0 | 1093 | ;;; reftex-toc.el ends here |