1 ;;; reftex-parse.el --- parser functions for RefTeX
3 ;; Copyright (C) 1997-2011 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <dominik@science.uva.nl>
6 ;; Maintainer: auctex-devel@gnu.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 (eval-when-compile (require 'cl))
30 (provide 'reftex-parse)
33 (defmacro reftex-with-special-syntax (&rest body)
34 `(let ((saved-syntax (syntax-table)))
37 (set-syntax-table reftex-syntax-table)
38 (let ((case-fold-search nil))
40 (set-syntax-table saved-syntax))))
42 (defun reftex-parse-one ()
45 (let ((reftex-enable-partial-scans t))
46 (reftex-access-scan-info '(4))))
48 (defun reftex-parse-all ()
49 "Re-parse entire document."
51 (reftex-access-scan-info '(16)))
53 (defun reftex-do-parse (rescan &optional file)
54 "Do a document rescan. When allowed, do only a partial scan from FILE."
56 ;; Normalize the rescan argument
57 (setq rescan (cond ((eq rescan t) t)
59 ((equal rescan '(4)) t)
60 ((equal rescan '(16)) 1)
63 ;; Partial scans only when allowed
64 (unless reftex-enable-partial-scans
69 (let* ((old-list (symbol-value reftex-docstruct-symbol))
70 (master (reftex-TeX-master-file))
71 (true-master (file-truename master))
72 (master-dir (file-name-as-directory (file-name-directory master)))
73 (file (or file (buffer-file-name)))
74 (true-file (file-truename file))
75 (bibview-cache (assq 'bibview-cache old-list))
76 (index-tags (cdr (assq 'index-tags old-list)))
77 from-file appendix docstruct tmp)
79 ;; Make sure replacement is really an option here
80 (when (and (eq rescan t)
81 (not (and (member (list 'bof file) old-list)
82 (member (list 'eof file) old-list))))
83 ;; Scan whole document because no such file section exists
85 (when (string= true-file true-master)
86 ;; Scan whole document because this file is the master
89 ;; From which file do we start?
91 (cond ((eq rescan t) (or file master))
92 ((eq rescan 1) master)
93 (t (error "This should not happen (reftex-do-parse)"))))
95 ;; Reset index-tags if we scan everything
96 (if (equal rescan 1) (setq index-tags nil))
98 ;; Find active toc entry and initialize section-numbers
99 (setq reftex-active-toc (reftex-last-assoc-before-elt
100 'toc (list 'bof from-file) old-list)
101 appendix (reftex-last-assoc-before-elt
102 'appendix (list 'bof from-file) old-list))
104 (reftex-init-section-numbers reftex-active-toc appendix)
107 (message "Scanning entire document...")
108 (message "Scanning document from %s..." from-file))
110 (reftex-with-special-syntax
111 (save-window-excursion
115 (reftex-parse-from-file
116 from-file docstruct master-dir))
117 (reftex-kill-temporary-buffers)))))
119 (message "Scanning document... done")
121 ;; Turn the list around.
122 (setq docstruct (nreverse docstruct))
125 (setq docstruct (reftex-replace-label-list-segment
126 old-list docstruct (eq rescan 1)))
128 ;; Add all missing information
129 (unless (assq 'label-numbers docstruct)
130 (push (cons 'label-numbers nil) docstruct))
131 (unless (assq 'master-dir docstruct)
132 (push (cons 'master-dir master-dir) docstruct))
133 (unless (assq 'bibview-cache docstruct)
134 (push (cons 'bibview-cache (cdr bibview-cache)) docstruct))
135 (let* ((bof1 (memq (assq 'bof docstruct) docstruct))
136 (bof2 (assq 'bof (cdr bof1)))
137 (is-multi (not (not (and bof1 bof2))))
138 (entry (or (assq 'is-multi docstruct)
139 (car (push (list 'is-multi is-multi) docstruct)))))
140 (setcdr entry (cons is-multi nil)))
141 (and index-tags (setq index-tags (sort index-tags 'string<)))
142 (let ((index-tag-cell (assq 'index-tags docstruct)))
144 (setcdr index-tag-cell index-tags)
145 (push (cons 'index-tags index-tags) docstruct)))
146 (unless (assq 'xr docstruct)
147 (let* ((allxr (reftex-all-assq 'xr-doc docstruct))
150 (if (setq tmp (reftex-locate-file (nth 2 x) "tex"
153 (message "Can't find external document %s"
157 (alist (delq nil alist))
158 (allprefix (delq nil (mapcar 'car alist)))
159 (regexp (if allprefix
161 (mapconcat 'identity allprefix "\\|")
163 "\\\\\\\\\\\\"))) ; this will never match
164 (push (list 'xr alist regexp) docstruct)))
166 (set reftex-docstruct-symbol docstruct)
167 (put reftex-docstruct-symbol 'modified t)))
169 (defun reftex-everything-regexp ()
170 (if reftex-support-index
171 reftex-everything-regexp
172 reftex-everything-regexp-no-index))
175 (defun reftex-all-document-files (&optional relative)
176 "Return a list of all files belonging to the current document.
177 When RELATIVE is non-nil, give file names relative to directory
179 (let* ((all (symbol-value reftex-docstruct-symbol))
180 (master-dir (file-name-directory (reftex-TeX-master-file)))
181 (re (concat "\\`" (regexp-quote master-dir)))
183 (while (setq tmp (assoc 'bof all))
184 (setq file (nth 1 tmp)
185 all (cdr (memq tmp all)))
187 (string-match re file)
188 (setq file (substring file (match-end 0))))
189 (push file file-list))
190 (nreverse file-list)))
192 ;; Bound in the caller, reftex-do-parse.
195 (defun reftex-parse-from-file (file docstruct master-dir)
196 ;; Scan the buffer for labels and save them in a list.
197 (let ((regexp (reftex-everything-regexp))
199 file-found tmp include-file
202 toc-entry index-entry next-buf buf)
205 (setq file-found (reftex-locate-file file "tex" master-dir))
206 (if (and (not file-found)
207 (setq buf (reftex-get-buffer-visiting file)))
208 (setq file-found (buffer-file-name buf)))
211 (push (list 'file-error file) docstruct)
216 (message "Scanning file %s" file)
219 (reftex-get-file-buffer-force
221 (not (eq t reftex-keep-temporary-buffers)))))
223 ;; Begin of file mark
224 (setq file (buffer-file-name))
225 (push (list 'bof file) docstruct)
227 (reftex-with-special-syntax
233 (while (re-search-forward regexp nil t)
239 (push (reftex-label-info (reftex-match-string 1) file bound)
247 (setq toc-entry (reftex-section-info file))
249 ;; It can happen that section info returns nil
250 (setq level (nth 5 toc-entry))
251 (setq highest-level (min highest-level level))
252 (if (= level highest-level)
255 (car (rassoc level reftex-section-levels-all))
258 (push toc-entry docstruct)
259 (setq reftex-active-toc toc-entry)))
262 ;; It's an include or input
263 (setq include-file (reftex-match-string 7))
264 ;; Test if this file should be ignored
265 (unless (delq nil (mapcar
266 (lambda (x) (string-match x include-file))
267 reftex-no-include-regexps))
270 (reftex-parse-from-file
272 docstruct master-dir))))
275 ;; Appendix starts here
276 (reftex-init-section-numbers nil t)
277 (push (cons 'appendix t) docstruct))
281 (when reftex-support-index
282 (setq index-entry (reftex-index-info file))
284 (add-to-list 'index-tags (nth 1 index-entry))
285 (push index-entry docstruct))))
288 ;; A macro with label
290 (let* ((mac (reftex-match-string 11))
291 (label (progn (goto-char (match-end 11))
294 (reftex-nth-arg-wrapper
296 (typekey (nth 1 (assoc mac reftex-env-or-mac-alist)))
297 (entry (progn (if typekey
299 (goto-char (match-end 0))
301 (goto-char (match-end 11))
302 (reftex-move-over-touching-args))
304 label file bound nil nil))))
305 (push entry docstruct))))
306 (t (error "This should not happen (reftex-parse-from-file)")))
309 ;; Find bibliography statement
310 (when (setq tmp (reftex-locate-bibliography-files master-dir))
311 (push (cons 'bib tmp) docstruct))
314 (when (re-search-forward
315 "\\(\\`\\|[\n\r]\\)[ \t]*\\\\begin{thebibliography}" nil t)
316 (push (cons 'thebib file) docstruct))
318 ;; Find external document specifications
320 (while (re-search-forward "[\n\r][ \t]*\\\\externaldocument\\(\\[\\([^]]*\\)\\]\\)?{\\([^}]+\\)}" nil t)
321 (push (list 'xr-doc (reftex-match-string 2)
322 (reftex-match-string 3))
326 (push (list 'eof file) docstruct)))))
328 ;; Kill the scanned buffer
329 (reftex-kill-temporary-buffers next-buf))
334 (defun reftex-locate-bibliography-files (master-dir &optional files)
335 ;; Scan buffer for bibliography macro and return file list.
339 (goto-char (point-min))
340 (if (re-search-forward
342 ; "\\(\\`\\|[\n\r]\\)[^%]*\\\\\\("
343 "\\(^\\)[^%\n\r]*\\\\\\("
344 (mapconcat 'identity reftex-bibliography-commands "\\|")
345 "\\){[ \t]*\\([^}]+\\)") nil t)
347 (split-string (reftex-match-string 3)
348 "[ \t\n\r]*,[ \t\n\r]*")))))
353 (if (or (member x reftex-bibfile-ignore-list)
354 (delq nil (mapcar (lambda (re) (string-match re x))
355 reftex-bibfile-ignore-regexps)))
359 (reftex-locate-file x "bib" master-dir)))
363 (defun reftex-replace-label-list-segment (old insert &optional entirely)
364 ;; Replace the segment in OLD which corresponds to INSERT.
365 ;; Works with side effects, directly changes old.
366 ;; If entirely is t, just return INSERT.
367 ;; This function also makes sure the old toc markers do not point anywhere.
371 (reftex-silence-toc-markers old (length old))
374 (file (nth 1 (car insert)))
375 (eof-list (member (list 'eof file) old))
376 (bof-list (member (list 'bof file) old))
378 (if (not (and bof-list eof-list))
379 (error "Cannot splice")
381 (reftex-silence-toc-markers bof-list (- (length bof-list)
383 (setq n (- (length old) (length bof-list)))
384 (setcdr (nthcdr n new) (cdr insert))
385 (setcdr (nthcdr (1- (length new)) new) (cdr eof-list)))
388 (defun reftex-section-info (file)
389 ;; Return a section entry for the current match.
390 ;; Careful: This function expects the match-data to be still in place!
391 (let* ((marker (set-marker (make-marker) (1- (match-beginning 3))))
392 (macro (reftex-match-string 3))
393 (prefix (save-match-data
394 (if (string-match "begin{\\([^}]+\\)}" macro)
395 (match-string 1 macro))))
396 (level-exp (cdr (assoc macro reftex-section-levels-all)))
397 (level (if (symbolp level-exp)
398 (save-match-data (funcall level-exp))
400 (star (= ?* (char-after (match-end 3))))
401 (unnumbered (or star (< level 0)))
403 (section-number (reftex-section-number level unnumbered))
404 (text1 (save-match-data
406 (reftex-context-substring prefix))))
407 (literal (buffer-substring-no-properties
408 (1- (match-beginning 3))
409 (min (point-max) (+ (match-end 0) (length text1) 1))))
410 ;; Literal can be too short since text1 too short. No big problem.
411 (text (reftex-nicify-text text1)))
413 ;; Add section number and indentation
416 (make-string (* reftex-level-indent level) ?\ )
417 (if (nth 1 reftex-label-menu-flags) ; section number flag
418 (concat section-number " "))
419 (if prefix (concat (capitalize prefix) ": ") "")
421 (list 'toc "toc" text file marker level section-number
422 literal (marker-position marker))))
424 (defun reftex-ensure-index-support (&optional abort)
425 ;; When index support is turned off, ask to turn it on and
426 ;; set the current prefix argument so that `reftex-access-scan-info'
427 ;; will rescan the entire document.
429 (reftex-support-index t)
430 ((y-or-n-p "Turn on index support and rescan entire document? ")
431 (setq reftex-support-index 'demanded
432 current-prefix-arg '(16)))
434 (error "No index support")
435 (message "No index support")
439 (defun reftex-index-info-safe (file)
440 (reftex-with-special-syntax
441 (reftex-index-info file)))
444 (defun reftex-index-info (file)
445 ;; Return an index entry for the current match.
446 ;; Careful: This function expects the match-data to be still in place!
448 (let* ((macro (reftex-match-string 10))
449 (bom (match-beginning 10))
451 (entry (or (assoc macro reftex-index-macro-alist)
453 (exclude (nth 3 entry))
454 ;; The following is a test if this match should be excluded
455 (test-dummy (and (fboundp exclude)
459 (prefix (nth 2 entry))
461 (cond ((stringp itag) itag)
463 (progn (goto-char boa)
464 (or (reftex-nth-arg itag (nth 6 entry)) "idx")))
466 (arg (or (progn (goto-char boa)
467 (reftex-nth-arg (nth 5 entry) (nth 6 entry)))
469 (end-of-args (progn (goto-char boa)
470 (reftex-move-over-touching-args)
472 (end-of-context (progn (skip-chars-forward "^ \t\n\r") (point)))
474 (progn (goto-char bom)
475 (skip-chars-backward "^ \t\r\n")
477 (context (buffer-substring-no-properties
478 begin-of-context end-of-context))
479 (key-end (if (string-match reftex-index-key-end-re arg)
480 (1+ (match-beginning 0))))
481 (rawkey (substring arg 0 key-end))
483 (key (if prefix (concat prefix rawkey) rawkey))
484 (sortkey (downcase key))
485 (showkey (mapconcat 'identity
486 (split-string key reftex-index-level-re)
488 (goto-char end-of-args)
489 ;; 0 1 2 3 4 5 6 7 8 9
490 (list 'index index-tag context file bom arg key showkey sortkey key-end))))
492 (defun reftex-short-context (env parse &optional bound derive)
493 ;; Get about one line of useful context for the label definition at point.
496 (setq parse (if derive (cdr parse) (car parse))))
504 (reftex-context-substring)))
507 (if (string= env "section")
508 ;; special treatment for section labels
510 (if (and (re-search-backward reftex-section-or-include-regexp
514 (goto-char (match-end 0))
515 (reftex-context-substring))
516 (if reftex-active-toc
518 (string-match "{\\([^}]*\\)" (nth 7 reftex-active-toc))
519 (match-string 1 (nth 7 reftex-active-toc)))
520 "SECTION HEADING NOT FOUND")))
522 (goto-char reftex-default-context-position)
523 (unless (eq (string-to-char env) ?\\)
524 (reftex-move-over-touching-args))
525 (reftex-context-substring))))
529 (if (re-search-backward parse bound t)
531 (goto-char (match-end 0))
532 (reftex-context-substring))
533 "NO MATCH FOR CONTEXT REGEXP")))
537 (goto-char reftex-default-context-position)
540 (nth 6 (assoc env reftex-env-or-mac-alist))))
544 ;; A hook function. Call it.
546 (condition-case error-var
548 (error (format "HOOK ERROR: %s" (cdr error-var))))))
550 "INVALID VALUE OF PARSE"))))
552 (defun reftex-where-am-I ()
553 ;; Return the docstruct entry above point. Actually returns a cons
554 ;; cell in which the cdr is a flag indicating if the information is
555 ;; exact (t) or approximate (nil).
557 (let ((docstruct (symbol-value reftex-docstruct-symbol))
558 (cnt 0) rtn rtn-if-no-other
563 (setq found (re-search-backward (reftex-everything-regexp) nil t))
569 (car (member (list 'bof (buffer-file-name)) docstruct))
571 (assq 'bof docstruct) ;; for safety reasons
575 (assoc (reftex-match-string 1)
576 (symbol-value reftex-docstruct-symbol)))
579 (goto-char (1- (match-beginning 3)))
580 (let* ((list (member (list 'bof (buffer-file-name))
582 (endelt (car (member (list 'eof (buffer-file-name))
585 (while (and list (not (eq endelt (car list))))
586 (if (and (eq (car (car list)) 'toc)
587 (string= (buffer-file-name)
591 (or (and (markerp (nth 4 (car list)))
592 (marker-position (nth 4 (car list))))
594 ;; Fits with marker position or recorded position
595 (setq rtn1 (car list) list nil))
596 ((looking-at (reftex-make-regexp-allow-for-ctrl-m
598 ;; Same title: remember, but keep looking
599 (setq rtn-if-no-other (car list)))))
603 ;; Input or include...
605 (member (list 'eof (reftex-locate-file
606 (reftex-match-string 7) "tex"
607 (cdr (assq 'master-dir docstruct))))
610 (assq 'appendix (symbol-value reftex-docstruct-symbol)))
613 (when reftex-support-index
614 (let* ((index-info (save-excursion
615 (reftex-index-info-safe nil)))
616 (list (member (list 'bof (buffer-file-name))
618 (endelt (car (member (list 'eof (buffer-file-name))
620 dist last-dist last (n 0))
621 ;; Check all index entries with equal text
622 (while (and list (not (eq endelt (car list))))
623 (when (and (eq (car (car list)) 'index)
624 (string= (nth 2 index-info)
627 (setq dist (abs (- (point) (nth 4 (car list)))))
628 (if (or (not last-dist) (< dist last-dist))
629 (setq last-dist dist last (car list))))
630 (setq list (cdr list)))
631 ;; We are sure if we have only one, or a zero distance
632 (cond ((or (= n 1) (equal dist 0)) last)
633 ((> n 1) (setq cnt 2) last)
637 (goto-char (match-end 11))
638 (assoc (reftex-no-props
639 (reftex-nth-arg-wrapper
640 (reftex-match-string 11)))
641 (symbol-value reftex-docstruct-symbol))))
643 (error "This should not happen (reftex-where-am-I)"))))))
644 ;; Check if there was only a by-name match for the section.
645 (when (and (not rtn) rtn-if-no-other)
646 (setq rtn rtn-if-no-other
648 (cons rtn (eq cnt 1))))
650 (defun reftex-notice-new (&optional n force)
651 "Hook to handshake with RefTeX after something new has been inserted."
652 ;; Add a new entry to the docstruct list. If it is a section, renumber
653 ;; the following sections.
654 ;; FIXME: Put in a WHAT parameter and search backward until one is found.
655 ;; When N is given, go back that many matches of reftex-everything-regexp
656 ;; When FORCE is non-nil, also insert if `reftex-where-am-I' was uncertain.
659 (unless reftex-mode (throw 'exit nil))
660 (reftex-access-scan-info)
661 (let* ((docstruct (symbol-value reftex-docstruct-symbol))
662 here-I-am appendix tail entry star level
663 section-number context)
666 (when (re-search-backward (reftex-everything-regexp) nil t (or n 1))
669 (setq here-I-am (reftex-where-am-I))
670 (or here-I-am (throw 'exit nil))
671 (unless (or force (cdr here-I-am)) (throw 'exit nil))
672 (setq tail (memq (car here-I-am) docstruct))
673 (or tail (throw 'exit nil))
674 (setq reftex-active-toc (reftex-last-assoc-before-elt
675 'toc (car here-I-am) docstruct)
676 appendix (reftex-last-assoc-before-elt
677 'appendix (car here-I-am) docstruct))
679 ;; Initialize section numbers
680 (if (eq (car (car here-I-am)) 'appendix)
681 (reftex-init-section-numbers nil t)
682 (reftex-init-section-numbers reftex-active-toc appendix))
684 ;; Match the section command
685 (when (re-search-forward (reftex-everything-regexp) nil t)
688 (push (reftex-label-info (reftex-match-string 1) buffer-file-name)
692 (setq star (= ?* (char-after (match-end 3)))
693 entry (reftex-section-info (buffer-file-name))
695 ;; Insert the section info
696 (push entry (cdr tail))
698 ;; We are done unless we use section numbers
699 (unless (nth 1 reftex-label-menu-flags) (throw 'exit nil))
701 ;; Update the remaining toc items
702 (setq tail (cdr tail))
703 (while (and (setq tail (memq (assq 'toc (cdr tail)) tail))
704 (setq entry (car tail))
705 (>= (nth 5 entry) level))
706 (setq star (string-match "\\*" (nth 6 entry))
707 context (nth 2 entry)
709 (reftex-section-number (nth 5 entry) star))
710 (when (string-match "\\`\\([ \t]*\\)\\([.0-9A-Z]+\\)\\(.*\\)"
712 (when (and (not appendix)
713 (>= (string-to-char (match-string 2)) ?A))
714 ;; Just entered the appendex. Get out.
717 ;; Change the section number.
719 (concat (match-string 1 context)
721 (match-string 3 context))))))
724 (and reftex-support-index
725 (setq entry (reftex-index-info-safe buffer-file-name))
726 ;; FIXME: (add-to-list 'index-tags (nth 1 index-entry))
727 (push entry (cdr tail))))))))))
732 (defsubst reftex-move-to-previous-arg (&optional bound)
733 ;; Assuming that we are in front of a macro argument,
734 ;; move backward to the closing parenthesis of the previous argument.
735 ;; This function understands the splitting of macros over several lines
739 ((memq (preceding-char) '(?\] ?\})))
741 ((and reftex-allow-detached-macro-args
743 "[]}][ \t]*[\n\r]?\\([ \t]*%[^\n\r]*[\n\r]\\)*[ \t]*\\=" bound t))
744 (goto-char (1+ (match-beginning 0)))
748 (defun reftex-what-macro-safe (which &optional bound)
749 ;; reftex-what-macro with special syntax table.
750 (reftex-with-special-syntax
751 (reftex-what-macro which bound)))
753 (defun reftex-what-macro (which &optional bound)
754 ;; Find out if point is within the arguments of any TeX-macro.
755 ;; The return value is either ("\\macro" . (point)) or a list of them.
757 ;; If WHICH is nil, immediately return nil.
758 ;; If WHICH is 1, return innermost enclosing macro.
759 ;; If WHICH is t, return list of all macros enclosing point.
760 ;; If WHICH is a list of macros, look only for those macros and return the
761 ;; name of the first macro in this list found to enclose point.
762 ;; If the optional BOUND is an integer, bound backwards directed
763 ;; searches to this point. If it is nil, limit to nearest \section -
766 ;; This function is pretty stable, but can be fooled if the text contains
767 ;; things like \macro{aa}{bb} where \macro is defined to take only one
768 ;; argument. As RefTeX cannot know this, the string "bb" would still be
769 ;; considered an argument of macro \macro.
771 (unless reftex-section-regexp (reftex-compile-variables))
773 (if (null which) (throw 'exit nil))
774 (let ((bound (or bound (save-excursion (re-search-backward
775 reftex-section-regexp nil 1)
777 pos cmd-list cmd cnt cnt-opt entry)
780 (narrow-to-region (max (point-min) bound) (point-max))
781 ;; move back out of the current parenthesis
782 (while (condition-case nil
783 (let ((forward-sexp-function nil))
786 (setq cnt 1 cnt-opt 0)
787 ;; move back over any touching sexps
788 (while (and (reftex-move-to-previous-arg bound)
790 (let ((forward-sexp-function nil))
793 (if (eq (following-char) ?\[) (incf cnt-opt))
796 (when (and (or (= (following-char) ?\[)
797 (= (following-char) ?\{))
798 (re-search-backward "\\\\[*a-zA-Z]+\\=" nil t))
799 (setq cmd (reftex-match-string 0))
800 (when (looking-at "\\\\begin{[^}]*}")
801 (setq cmd (reftex-match-string 0)
803 ;; This does ignore optional arguments. Very hard to fix.
804 (when (setq entry (assoc cmd reftex-env-or-mac-alist))
805 (if (> cnt (or (nth 4 entry) 100))
810 (push (cons cmd (point)) cmd-list))
811 ((or (eq 1 which) (member cmd which))
812 (throw 'exit (cons cmd (point))))))
814 (nreverse cmd-list)))))
816 (defun reftex-what-environment (which &optional bound)
817 ;; Find out if point is inside a LaTeX environment.
818 ;; The return value is (e.g.) either ("equation" . (point)) or a list of
821 ;; If WHICH is nil, immediately return nil.
822 ;; If WHICH is 1, return innermost enclosing environment.
823 ;; If WHICH is t, return list of all environments enclosing point.
824 ;; If WHICH is a list of environments, look only for those environments and
825 ;; return the name of the first environment in this list found to enclose
828 ;; If the optional BOUND is an integer, bound backwards directed searches to
829 ;; this point. If it is nil, limit to nearest \section - like statement.
831 (unless reftex-section-regexp (reftex-compile-variables))
834 (if (null which) (throw 'exit nil))
835 (let ((bound (or bound (save-excursion (re-search-backward
836 reftex-section-regexp nil 1)
838 env-list end-list env)
839 (while (re-search-backward "\\\\\\(begin\\|end\\){\\([^}]+\\)}"
841 (setq env (buffer-substring-no-properties
842 (match-beginning 2) (match-end 2)))
844 ((string= (match-string 1) "end")
846 ((equal env (car end-list))
847 (setq end-list (cdr end-list)))
849 (push (cons env (point)) env-list))
850 ((or (eq 1 which) (member env which))
851 (throw 'exit (cons env (point))))))
852 (nreverse env-list)))))
854 (defun reftex-what-special-env (which &optional bound)
855 ;; Run the special environment parsers and return the matches.
857 ;; The return value is (e.g.) either ("my-parser-function" . (point))
858 ;; or a list of them.
860 ;; If WHICH is nil, immediately return nil.
861 ;; If WHICH is 1, return innermost enclosing environment.
862 ;; If WHICH is t, return list of all environments enclosing point.
863 ;; If WHICH is a list of environments, look only for those environments and
864 ;; return the name of the first environment in this list found to enclose
867 (unless reftex-section-regexp (reftex-compile-variables))
870 (if (null reftex-special-env-parsers) (throw 'exit nil))
871 (if (null which) (throw 'exit nil))
872 (let ((bound (or bound (save-excursion (re-search-backward
873 reftex-section-regexp nil 1)
875 (fun-list (if (listp which)
876 (mapcar (lambda (x) (if (memq x which) x nil))
877 reftex-special-env-parsers)
878 reftex-special-env-parsers))
880 ;; Call all functions
881 (setq specials (mapcar
884 (setq rtn (and fun (funcall fun bound)))
885 (if rtn (cons (symbol-name fun) rtn) nil)))
887 ;; Delete the non-matches
888 (setq specials (delq nil specials))
890 (setq specials (sort specials (lambda (a b) (> (cdr a) (cdr b)))))
895 (defsubst reftex-move-to-next-arg (&optional ignore)
896 ;; Assuming that we are at the end of a macro name or a macro argument,
897 ;; move forward to the opening parenthesis of the next argument.
898 ;; This function understands the splitting of macros over several lines
902 ((memq (following-char) '(?\[ ?\{)))
904 ((and reftex-allow-detached-macro-args
905 (looking-at "[ \t]*[\n\r]?\\([ \t]*%[^\n\r]*[\n\r]\\)*[ \t]*[[{]"))
906 (goto-char (1- (match-end 0)))
910 (defun reftex-nth-arg-wrapper (key)
911 (let ((entry (assoc key reftex-env-or-mac-alist)))
912 (reftex-nth-arg (nth 5 entry) (nth 6 entry))))
914 (defun reftex-nth-arg (n &optional opt-args)
915 ;; Return the nth following {} or [] parentheses content.
916 ;; OPT-ARGS is a list of argument numbers which are optional.
918 ;; If we are sitting at a macro start, skip to end of macro name.
919 (and (eq (following-char) ?\\) (skip-chars-forward "a-zA-Z*\\\\"))
922 ;; Special case: Skip all touching arguments
924 (reftex-move-over-touching-args)
925 (reftex-context-substring))
927 ;; Do the real thing.
930 (when (reftex-move-to-next-arg)
933 (while (and (member cnt opt-args)
934 (eq (following-char) ?\{))
937 (unless (and (condition-case nil
938 (or (forward-list 1) t)
940 (reftex-move-to-next-arg)
944 (while (and (memq cnt opt-args)
945 (eq (following-char) ?\{))
948 (> (skip-chars-forward "{\\[") 0))
949 (reftex-context-substring)
952 (defun reftex-move-over-touching-args ()
954 (while (memq (following-char) '(?\[ ?\{))
958 (defun reftex-context-substring (&optional to-end)
959 ;; Return up to 150 chars from point
960 ;; When point is just after a { or [, limit string to matching parenthesis
963 ;; Environment - find next \end
964 (buffer-substring-no-properties
968 ;; FIXME: This is not perfect
969 (if (re-search-forward "\\\\end{" nil t)
972 ((memq (preceding-char) '(?\{ ?\[))
973 ;; Inside a list - get only the list.
974 (buffer-substring-no-properties
979 (let ((forward-sexp-function nil)) ;Unneeded fanciness.
982 (error (point-max))))))
984 ;; no list - just grab 150 characters
985 (buffer-substring-no-properties (point)
986 (min (+ (point) 150) (point-max))))))
988 ;; Variable holding the vector with section numbers
989 (defvar reftex-section-numbers (make-vector reftex-max-section-depth 0))
991 (defun reftex-init-section-numbers (&optional toc-entry appendix)
992 ;; Initialize the section numbers with zeros or with what is found
994 (let* ((level (or (nth 5 toc-entry) -1))
995 (numbers (nreverse (split-string (or (nth 6 toc-entry) "") "\\.")))
996 (depth (1- (length reftex-section-numbers)))
997 (i depth) number-string)
1000 (aset reftex-section-numbers i 0)
1001 (setq number-string (or (car numbers) "0"))
1002 (if (string-match "\\`[A-Z]\\'" number-string)
1003 (aset reftex-section-numbers i
1004 (- (string-to-char number-string) ?A -1))
1005 (aset reftex-section-numbers i (string-to-number number-string)))
1008 (put 'reftex-section-numbers 'appendix appendix))
1010 (defun reftex-section-number (&optional level star)
1011 ;; Return a string with the current section number.
1012 ;; When LEVEL is non-nil, increase section numbers on that level.
1013 (let* ((depth (1- (length reftex-section-numbers))) idx n (string "")
1014 (appendix (get 'reftex-section-numbers 'appendix))
1015 (partspecial (and (not reftex-part-resets-chapter)
1017 ;; partspecial means, this is a part statement.
1018 ;; Parts do not reset the chapter counter, and the part number is
1019 ;; not included in the numbering of other sectioning levels.
1021 (when (and (> level -1) (not star))
1022 (aset reftex-section-numbers
1023 level (1+ (aref reftex-section-numbers level))))
1024 (setq idx (1+ level))
1026 (while (<= idx depth)
1027 (if (or (not partspecial)
1029 (aset reftex-section-numbers idx 0))
1032 (setq string (concat "Part " (reftex-roman-number
1033 (aref reftex-section-numbers 0))))
1034 (setq idx (if reftex-part-resets-chapter 0 1))
1035 (while (<= idx depth)
1036 (setq n (aref reftex-section-numbers idx))
1037 (if (not (and partspecial (not (equal string ""))))
1038 (setq string (concat string (if (not (string= string "")) "." "")
1039 (int-to-string n))))
1042 (if (string-match "\\`\\([@0]\\.\\)+" string)
1043 (setq string (replace-match "" nil nil string)))
1044 (if (string-match "\\(\\.0\\)+\\'" string)
1045 (setq string (replace-match "" nil nil string)))
1047 (string-match "\\`[0-9]+" string))
1051 (1- (+ ?A (string-to-number (match-string 0 string)))))
1052 (substring string (match-end 0))))))
1054 (concat (make-string (1- (length string)) ?\ ) "*")
1057 (defun reftex-roman-number (n)
1058 ;; Return as a string the roman number equal to N.
1061 (list '((1000 . "M") ( 900 . "CM") ( 500 . "D") ( 400 . "CD")
1062 ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
1063 ( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
1067 (setq listel (pop list)
1071 (setq string (concat string s)
1072 nrest (- nrest i))))
1075 ;;; reftex-parse.el ends here