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