1 ;;; reftex-parse.el --- parser functions for RefTeX
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <dominik@science.uva.nl>
7 ;; Maintainer: auctex-devel@gnu.org
11 ;; This file is part of GNU Emacs.
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.
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.
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/>.
30 (eval-when-compile (require 'cl))
31 (provide 'reftex-parse)
34 (defmacro reftex-with-special-syntax (&rest body)
35 `(let ((saved-syntax (syntax-table)))
38 (set-syntax-table reftex-syntax-table)
39 (let ((case-fold-search nil))
41 (set-syntax-table saved-syntax))))
43 (defun reftex-parse-one ()
46 (let ((reftex-enable-partial-scans t))
47 (reftex-access-scan-info '(4))))
49 (defun reftex-parse-all ()
50 "Re-parse entire document."
52 (reftex-access-scan-info '(16)))
54 (defun reftex-do-parse (rescan &optional file)
55 "Do a document rescan. When allowed, do only a partial scan from FILE."
57 ;; Normalize the rescan argument
58 (setq rescan (cond ((eq rescan t) t)
60 ((equal rescan '(4)) t)
61 ((equal rescan '(16)) 1)
64 ;; Partial scans only when allowed
65 (unless reftex-enable-partial-scans
70 (let* ((old-list (symbol-value reftex-docstruct-symbol))
71 (master (reftex-TeX-master-file))
72 (true-master (file-truename master))
73 (master-dir (file-name-as-directory (file-name-directory master)))
74 (file (or file (buffer-file-name)))
75 (true-file (file-truename file))
76 (bibview-cache (assq 'bibview-cache old-list))
77 (index-tags (cdr (assq 'index-tags old-list)))
78 from-file appendix docstruct tmp)
80 ;; Make sure replacement is really an option here
81 (when (and (eq rescan t)
82 (not (and (member (list 'bof file) old-list)
83 (member (list 'eof file) old-list))))
84 ;; Scan whole document because no such file section exists
86 (when (string= true-file true-master)
87 ;; Scan whole document because this file is the master
90 ;; From which file do we start?
92 (cond ((eq rescan t) (or file master))
93 ((eq rescan 1) master)
94 (t (error "This should not happen (reftex-do-parse)"))))
96 ;; Reset index-tags if we scan everything
97 (if (equal rescan 1) (setq index-tags nil))
99 ;; Find active toc entry and initialize section-numbers
100 (setq reftex-active-toc (reftex-last-assoc-before-elt
101 'toc (list 'bof from-file) old-list)
102 appendix (reftex-last-assoc-before-elt
103 'appendix (list 'bof from-file) old-list))
105 (reftex-init-section-numbers reftex-active-toc appendix)
108 (message "Scanning entire document...")
109 (message "Scanning document from %s..." from-file))
111 (reftex-with-special-syntax
112 (save-window-excursion
116 (reftex-parse-from-file
117 from-file docstruct master-dir))
118 (reftex-kill-temporary-buffers)))))
120 (message "Scanning document... done")
122 ;; Turn the list around.
123 (setq docstruct (nreverse docstruct))
126 (setq docstruct (reftex-replace-label-list-segment
127 old-list docstruct (eq rescan 1)))
129 ;; Add all missing information
130 (unless (assq 'label-numbers docstruct)
131 (push (cons 'label-numbers nil) docstruct))
132 (unless (assq 'master-dir docstruct)
133 (push (cons 'master-dir master-dir) docstruct))
134 (unless (assq 'bibview-cache docstruct)
135 (push (cons 'bibview-cache (cdr bibview-cache)) docstruct))
136 (let* ((bof1 (memq (assq 'bof docstruct) docstruct))
137 (bof2 (assq 'bof (cdr bof1)))
138 (is-multi (not (not (and bof1 bof2))))
139 (entry (or (assq 'is-multi docstruct)
140 (car (push (list 'is-multi is-multi) docstruct)))))
141 (setcdr entry (cons is-multi nil)))
142 (and index-tags (setq index-tags (sort index-tags 'string<)))
143 (let ((index-tag-cell (assq 'index-tags docstruct)))
145 (setcdr index-tag-cell index-tags)
146 (push (cons 'index-tags index-tags) docstruct)))
147 (unless (assq 'xr docstruct)
148 (let* ((allxr (reftex-all-assq 'xr-doc docstruct))
151 (if (setq tmp (reftex-locate-file (nth 2 x) "tex"
154 (message "Can't find external document %s"
158 (alist (delq nil alist))
159 (allprefix (delq nil (mapcar 'car alist)))
160 (regexp (if allprefix
162 (mapconcat 'identity allprefix "\\|")
164 "\\\\\\\\\\\\"))) ; this will never match
165 (push (list 'xr alist regexp) docstruct)))
167 (set reftex-docstruct-symbol docstruct)
168 (put reftex-docstruct-symbol 'modified t)))
170 (defun reftex-everything-regexp ()
171 (if reftex-support-index
172 reftex-everything-regexp
173 reftex-everything-regexp-no-index))
176 (defun reftex-all-document-files (&optional relative)
177 "Return a list of all files belonging to the current document.
178 When RELATIVE is non-nil, give file names relative to directory
180 (let* ((all (symbol-value reftex-docstruct-symbol))
181 (master-dir (file-name-directory (reftex-TeX-master-file)))
182 (re (concat "\\`" (regexp-quote master-dir)))
184 (while (setq tmp (assoc 'bof all))
185 (setq file (nth 1 tmp)
186 all (cdr (memq tmp all)))
188 (string-match re file)
189 (setq file (substring file (match-end 0))))
190 (push file file-list))
191 (nreverse file-list)))
193 (defun reftex-parse-from-file (file docstruct master-dir)
194 ;; Scan the buffer for labels and save them in a list.
195 (let ((regexp (reftex-everything-regexp))
197 file-found tmp include-file
200 toc-entry index-entry next-buf buf)
203 (setq file-found (reftex-locate-file file "tex" master-dir))
204 (if (and (not file-found)
205 (setq buf (reftex-get-buffer-visiting file)))
206 (setq file-found (buffer-file-name buf)))
209 (push (list 'file-error file) docstruct)
214 (message "Scanning file %s" file)
217 (reftex-get-file-buffer-force
219 (not (eq t reftex-keep-temporary-buffers)))))
221 ;; Begin of file mark
222 (setq file (buffer-file-name))
223 (push (list 'bof file) docstruct)
225 (reftex-with-special-syntax
231 (while (re-search-forward regexp nil t)
237 (push (reftex-label-info (reftex-match-string 1) file bound)
245 (setq toc-entry (reftex-section-info file))
247 ;; It can happen that section info returns nil
248 (setq level (nth 5 toc-entry))
249 (setq highest-level (min highest-level level))
250 (if (= level highest-level)
253 (car (rassoc level reftex-section-levels-all))
256 (push toc-entry docstruct)
257 (setq reftex-active-toc toc-entry)))
260 ;; It's an include or input
261 (setq include-file (reftex-match-string 7))
262 ;; Test if this file should be ignored
263 (unless (delq nil (mapcar
264 (lambda (x) (string-match x include-file))
265 reftex-no-include-regexps))
268 (reftex-parse-from-file
270 docstruct master-dir))))
273 ;; Appendix starts here
274 (reftex-init-section-numbers nil t)
275 (push (cons 'appendix t) docstruct))
279 (when reftex-support-index
280 (setq index-entry (reftex-index-info file))
282 (add-to-list 'index-tags (nth 1 index-entry))
283 (push index-entry docstruct))))
286 ;; A macro with label
288 (let* ((mac (reftex-match-string 11))
289 (label (progn (goto-char (match-end 11))
292 (reftex-nth-arg-wrapper
294 (typekey (nth 1 (assoc mac reftex-env-or-mac-alist)))
295 (entry (progn (if typekey
297 (goto-char (match-end 0))
299 (goto-char (match-end 11))
300 (reftex-move-over-touching-args))
302 label file bound nil nil))))
303 (push entry docstruct))))
304 (t (error "This should not happen (reftex-parse-from-file)")))
307 ;; Find bibliography statement
308 (when (setq tmp (reftex-locate-bibliography-files master-dir))
309 (push (cons 'bib tmp) docstruct))
312 (when (re-search-forward
313 "\\(\\`\\|[\n\r]\\)[ \t]*\\\\begin{thebibliography}" nil t)
314 (push (cons 'thebib file) docstruct))
316 ;; Find external document specifications
318 (while (re-search-forward "[\n\r][ \t]*\\\\externaldocument\\(\\[\\([^]]*\\)\\]\\)?{\\([^}]+\\)}" nil t)
319 (push (list 'xr-doc (reftex-match-string 2)
320 (reftex-match-string 3))
324 (push (list 'eof file) docstruct)))))
326 ;; Kill the scanned buffer
327 (reftex-kill-temporary-buffers next-buf))
332 (defun reftex-locate-bibliography-files (master-dir &optional files)
333 ;; Scan buffer for bibliography macro and return file list.
337 (goto-char (point-min))
338 (if (re-search-forward
340 ; "\\(\\`\\|[\n\r]\\)[^%]*\\\\\\("
341 "\\(^\\)[^%\n\r]*\\\\\\("
342 (mapconcat 'identity reftex-bibliography-commands "\\|")
343 "\\){[ \t]*\\([^}]+\\)") nil t)
345 (split-string (reftex-match-string 3)
346 "[ \t\n\r]*,[ \t\n\r]*")))))
351 (if (or (member x reftex-bibfile-ignore-list)
352 (delq nil (mapcar (lambda (re) (string-match re x))
353 reftex-bibfile-ignore-regexps)))
357 (reftex-locate-file x "bib" master-dir)))
361 (defun reftex-replace-label-list-segment (old insert &optional entirely)
362 ;; Replace the segment in OLD which corresponds to INSERT.
363 ;; Works with side effects, directly changes old.
364 ;; If entirely is t, just return INSERT.
365 ;; This function also makes sure the old toc markers do not point anywhere.
369 (reftex-silence-toc-markers old (length old))
372 (file (nth 1 (car insert)))
373 (eof-list (member (list 'eof file) old))
374 (bof-list (member (list 'bof file) old))
376 (if (not (and bof-list eof-list))
377 (error "Cannot splice")
379 (reftex-silence-toc-markers bof-list (- (length bof-list)
381 (setq n (- (length old) (length bof-list)))
382 (setcdr (nthcdr n new) (cdr insert))
383 (setcdr (nthcdr (1- (length new)) new) (cdr eof-list)))
386 (defun reftex-section-info (file)
387 ;; Return a section entry for the current match.
388 ;; Careful: This function expects the match-data to be still in place!
389 (let* ((marker (set-marker (make-marker) (1- (match-beginning 3))))
390 (macro (reftex-match-string 3))
391 (prefix (save-match-data
392 (if (string-match "begin{\\([^}]+\\)}" macro)
393 (match-string 1 macro))))
394 (level-exp (cdr (assoc macro reftex-section-levels-all)))
395 (level (if (symbolp level-exp)
396 (save-match-data (funcall level-exp))
398 (star (= ?* (char-after (match-end 3))))
399 (unnumbered (or star (< level 0)))
401 (section-number (reftex-section-number level unnumbered))
402 (text1 (save-match-data
404 (reftex-context-substring prefix))))
405 (literal (buffer-substring-no-properties
406 (1- (match-beginning 3))
407 (min (point-max) (+ (match-end 0) (length text1) 1))))
408 ;; Literal can be too short since text1 too short. No big problem.
409 (text (reftex-nicify-text text1)))
411 ;; Add section number and indentation
414 (make-string (* reftex-level-indent level) ?\ )
415 (if (nth 1 reftex-label-menu-flags) ; section number flag
416 (concat section-number " "))
417 (if prefix (concat (capitalize prefix) ": ") "")
419 (list 'toc "toc" text file marker level section-number
420 literal (marker-position marker))))
422 (defun reftex-ensure-index-support (&optional abort)
423 ;; When index support is turned off, ask to turn it on and
424 ;; set the current prefix argument so that `reftex-access-scan-info'
425 ;; will rescan the entire document.
427 (reftex-support-index t)
428 ((y-or-n-p "Turn on index support and rescan entire document? ")
429 (setq reftex-support-index 'demanded
430 current-prefix-arg '(16)))
432 (error "No index support")
433 (message "No index support")
437 (defun reftex-index-info-safe (file)
438 (reftex-with-special-syntax
439 (reftex-index-info file)))
442 (defun reftex-index-info (file)
443 ;; Return an index entry for the current match.
444 ;; Carefull: This function expects the match-data to be still in place!
446 (let* ((macro (reftex-match-string 10))
447 (bom (match-beginning 10))
449 (entry (or (assoc macro reftex-index-macro-alist)
451 (exclude (nth 3 entry))
452 ;; The following is a test if this match should be excluded
453 (test-dummy (and (fboundp exclude)
457 (prefix (nth 2 entry))
459 (cond ((stringp itag) itag)
461 (progn (goto-char boa)
462 (or (reftex-nth-arg itag (nth 6 entry)) "idx")))
464 (arg (or (progn (goto-char boa)
465 (reftex-nth-arg (nth 5 entry) (nth 6 entry)))
467 (end-of-args (progn (goto-char boa)
468 (reftex-move-over-touching-args)
470 (end-of-context (progn (skip-chars-forward "^ \t\n\r") (point)))
472 (progn (goto-char bom)
473 (skip-chars-backward "^ \t\r\n")
475 (context (buffer-substring-no-properties
476 begin-of-context end-of-context))
477 (key-end (if (string-match reftex-index-key-end-re arg)
478 (1+ (match-beginning 0))))
479 (rawkey (substring arg 0 key-end))
481 (key (if prefix (concat prefix rawkey) rawkey))
482 (sortkey (downcase key))
483 (showkey (mapconcat 'identity
484 (split-string key reftex-index-level-re)
486 (goto-char end-of-args)
487 ;; 0 1 2 3 4 5 6 7 8 9
488 (list 'index index-tag context file bom arg key showkey sortkey key-end))))
490 (defun reftex-short-context (env parse &optional bound derive)
491 ;; Get about one line of useful context for the label definition at point.
494 (setq parse (if derive (cdr parse) (car parse))))
502 (reftex-context-substring)))
505 (if (string= env "section")
506 ;; special treatment for section labels
508 (if (and (re-search-backward reftex-section-or-include-regexp
512 (goto-char (match-end 0))
513 (reftex-context-substring))
514 (if reftex-active-toc
516 (string-match "{\\([^}]*\\)" (nth 7 reftex-active-toc))
517 (match-string 1 (nth 7 reftex-active-toc)))
518 "SECTION HEADING NOT FOUND")))
520 (goto-char reftex-default-context-position)
521 (unless (eq (string-to-char env) ?\\)
522 (reftex-move-over-touching-args))
523 (reftex-context-substring))))
527 (if (re-search-backward parse bound t)
529 (goto-char (match-end 0))
530 (reftex-context-substring))
531 "NO MATCH FOR CONTEXT REGEXP")))
535 (goto-char reftex-default-context-position)
538 (nth 6 (assoc env reftex-env-or-mac-alist))))
542 ;; A hook function. Call it.
544 (condition-case error-var
546 (error (format "HOOK ERROR: %s" (cdr error-var))))))
548 "INVALID VALUE OF PARSE"))))
550 (defun reftex-where-am-I ()
551 ;; Return the docstruct entry above point. Actually returns a cons
552 ;; cell in which the cdr is a flag indicating if the information is
553 ;; exact (t) or approximate (nil).
555 (let ((docstruct (symbol-value reftex-docstruct-symbol))
556 (cnt 0) rtn rtn-if-no-other
561 (setq found (re-search-backward (reftex-everything-regexp) nil t))
567 (car (member (list 'bof (buffer-file-name)) docstruct))
569 (assq 'bof docstruct) ;; for safety reasons
573 (assoc (reftex-match-string 1)
574 (symbol-value reftex-docstruct-symbol)))
577 (goto-char (1- (match-beginning 3)))
578 (let* ((list (member (list 'bof (buffer-file-name))
580 (endelt (car (member (list 'eof (buffer-file-name))
583 (while (and list (not (eq endelt (car list))))
584 (if (and (eq (car (car list)) 'toc)
585 (string= (buffer-file-name)
589 (or (and (markerp (nth 4 (car list)))
590 (marker-position (nth 4 (car list))))
592 ;; Fits with marker position or recorded position
593 (setq rtn1 (car list) list nil))
594 ((looking-at (reftex-make-regexp-allow-for-ctrl-m
596 ;; Same title: remember, but keep looking
597 (setq rtn-if-no-other (car list)))))
601 ;; Input or include...
603 (member (list 'eof (reftex-locate-file
604 (reftex-match-string 7) "tex"
605 (cdr (assq 'master-dir docstruct))))
608 (assq 'appendix (symbol-value reftex-docstruct-symbol)))
611 (when reftex-support-index
612 (let* ((index-info (save-excursion
613 (reftex-index-info-safe nil)))
614 (list (member (list 'bof (buffer-file-name))
616 (endelt (car (member (list 'eof (buffer-file-name))
618 dist last-dist last (n 0))
619 ;; Check all index entries with equal text
620 (while (and list (not (eq endelt (car list))))
621 (when (and (eq (car (car list)) 'index)
622 (string= (nth 2 index-info)
625 (setq dist (abs (- (point) (nth 4 (car list)))))
626 (if (or (not last-dist) (< dist last-dist))
627 (setq last-dist dist last (car list))))
628 (setq list (cdr list)))
629 ;; We are sure if we have only one, or a zero distance
630 (cond ((or (= n 1) (equal dist 0)) last)
631 ((> n 1) (setq cnt 2) last)
635 (goto-char (match-end 11))
636 (assoc (reftex-no-props
637 (reftex-nth-arg-wrapper
638 (reftex-match-string 11)))
639 (symbol-value reftex-docstruct-symbol))))
641 (error "This should not happen (reftex-where-am-I)"))))))
642 ;; Check if there was only a by-name match for the section.
643 (when (and (not rtn) rtn-if-no-other)
644 (setq rtn rtn-if-no-other
646 (cons rtn (eq cnt 1))))
648 (defun reftex-notice-new (&optional n force)
649 "Hook to handshake with RefTeX after something new has been inserted."
650 ;; Add a new entry to the docstruct list. If it is a section, renumber
651 ;; the following sections.
652 ;; FIXME: Put in a WHAT parameter and search backward until one is found.
653 ;; When N is given, go back that many matches of reftex-everything-regexp
654 ;; When FORCE is non-nil, also insert if `reftex-where-am-I' was uncertain.
657 (unless reftex-mode (throw 'exit nil))
658 (reftex-access-scan-info)
659 (let* ((docstruct (symbol-value reftex-docstruct-symbol))
660 here-I-am appendix tail entry star level
661 section-number context)
664 (when (re-search-backward (reftex-everything-regexp) nil t (or n 1))
667 (setq here-I-am (reftex-where-am-I))
668 (or here-I-am (throw 'exit nil))
669 (unless (or force (cdr here-I-am)) (throw 'exit nil))
670 (setq tail (memq (car here-I-am) docstruct))
671 (or tail (throw 'exit nil))
672 (setq reftex-active-toc (reftex-last-assoc-before-elt
673 'toc (car here-I-am) docstruct)
674 appendix (reftex-last-assoc-before-elt
675 'appendix (car here-I-am) docstruct))
677 ;; Initialize section numbers
678 (if (eq (car (car here-I-am)) 'appendix)
679 (reftex-init-section-numbers nil t)
680 (reftex-init-section-numbers reftex-active-toc appendix))
682 ;; Match the section command
683 (when (re-search-forward (reftex-everything-regexp) nil t)
686 (push (reftex-label-info (reftex-match-string 1) buffer-file-name)
690 (setq star (= ?* (char-after (match-end 3)))
691 entry (reftex-section-info (buffer-file-name))
693 ;; Insert the section info
694 (push entry (cdr tail))
696 ;; We are done unless we use section numbers
697 (unless (nth 1 reftex-label-menu-flags) (throw 'exit nil))
699 ;; Update the remaining toc items
700 (setq tail (cdr tail))
701 (while (and (setq tail (memq (assq 'toc (cdr tail)) tail))
702 (setq entry (car tail))
703 (>= (nth 5 entry) level))
704 (setq star (string-match "\\*" (nth 6 entry))
705 context (nth 2 entry)
707 (reftex-section-number (nth 5 entry) star))
708 (when (string-match "\\`\\([ \t]*\\)\\([.0-9A-Z]+\\)\\(.*\\)"
710 (when (and (not appendix)
711 (>= (string-to-char (match-string 2)) ?A))
712 ;; Just entered the appendex. Get out.
715 ;; Change the section number.
717 (concat (match-string 1 context)
719 (match-string 3 context))))))
722 (and reftex-support-index
723 (setq entry (reftex-index-info-safe buffer-file-name))
724 ;; FIXME: (add-to-list 'index-tags (nth 1 index-entry))
725 (push entry (cdr tail))))))))))
730 (defsubst reftex-move-to-previous-arg (&optional bound)
731 ;; Assuming that we are in front of a macro argument,
732 ;; move backward to the closing parenthesis of the previous argument.
733 ;; This function understands the splitting of macros over several lines
737 ((memq (preceding-char) '(?\] ?\})))
739 ((and reftex-allow-detached-macro-args
741 "[]}][ \t]*[\n\r]?\\([ \t]*%[^\n\r]*[\n\r]\\)*[ \t]*\\=" bound t))
742 (goto-char (1+ (match-beginning 0)))
746 (defun reftex-what-macro-safe (which &optional bound)
747 ;; reftex-what-macro with special syntax table.
748 (reftex-with-special-syntax
749 (reftex-what-macro which bound)))
751 (defun reftex-what-macro (which &optional bound)
752 ;; Find out if point is within the arguments of any TeX-macro.
753 ;; The return value is either ("\\macro" . (point)) or a list of them.
755 ;; If WHICH is nil, immediately return nil.
756 ;; If WHICH is 1, return innermost enclosing macro.
757 ;; If WHICH is t, return list of all macros enclosing point.
758 ;; If WHICH is a list of macros, look only for those macros and return the
759 ;; name of the first macro in this list found to enclose point.
760 ;; If the optional BOUND is an integer, bound backwards directed
761 ;; searches to this point. If it is nil, limit to nearest \section -
764 ;; This function is pretty stable, but can be fooled if the text contains
765 ;; things like \macro{aa}{bb} where \macro is defined to take only one
766 ;; argument. As RefTeX cannot know this, the string "bb" would still be
767 ;; considered an argument of macro \macro.
769 (unless reftex-section-regexp (reftex-compile-variables))
771 (if (null which) (throw 'exit nil))
772 (let ((bound (or bound (save-excursion (re-search-backward
773 reftex-section-regexp nil 1)
775 pos cmd-list cmd cnt cnt-opt entry)
778 (narrow-to-region (max (point-min) bound) (point-max))
779 ;; move back out of the current parenthesis
780 (while (condition-case nil
781 (let ((forward-sexp-function nil))
784 (setq cnt 1 cnt-opt 0)
785 ;; move back over any touching sexps
786 (while (and (reftex-move-to-previous-arg bound)
788 (let ((forward-sexp-function nil))
791 (if (eq (following-char) ?\[) (incf cnt-opt))
794 (when (and (or (= (following-char) ?\[)
795 (= (following-char) ?\{))
796 (re-search-backward "\\\\[*a-zA-Z]+\\=" nil t))
797 (setq cmd (reftex-match-string 0))
798 (when (looking-at "\\\\begin{[^}]*}")
799 (setq cmd (reftex-match-string 0)
801 ;; This does ignore optional arguments. Very hard to fix.
802 (when (setq entry (assoc cmd reftex-env-or-mac-alist))
803 (if (> cnt (or (nth 4 entry) 100))
808 (push (cons cmd (point)) cmd-list))
809 ((or (eq 1 which) (member cmd which))
810 (throw 'exit (cons cmd (point))))))
812 (nreverse cmd-list)))))
814 (defun reftex-what-environment (which &optional bound)
815 ;; Find out if point is inside a LaTeX environment.
816 ;; The return value is (e.g.) either ("equation" . (point)) or a list of
819 ;; If WHICH is nil, immediately return nil.
820 ;; If WHICH is 1, return innermost enclosing environment.
821 ;; If WHICH is t, return list of all environments enclosing point.
822 ;; If WHICH is a list of environments, look only for those environments and
823 ;; return the name of the first environment in this list found to enclose
826 ;; If the optional BOUND is an integer, bound backwards directed searches to
827 ;; this point. If it is nil, limit to nearest \section - like statement.
829 (unless reftex-section-regexp (reftex-compile-variables))
832 (if (null which) (throw 'exit nil))
833 (let ((bound (or bound (save-excursion (re-search-backward
834 reftex-section-regexp nil 1)
836 env-list end-list env)
837 (while (re-search-backward "\\\\\\(begin\\|end\\){\\([^}]+\\)}"
839 (setq env (buffer-substring-no-properties
840 (match-beginning 2) (match-end 2)))
842 ((string= (match-string 1) "end")
844 ((equal env (car end-list))
845 (setq end-list (cdr end-list)))
847 (push (cons env (point)) env-list))
848 ((or (eq 1 which) (member env which))
849 (throw 'exit (cons env (point))))))
850 (nreverse env-list)))))
852 (defun reftex-what-special-env (which &optional bound)
853 ;; Run the special environment parsers and return the matches.
855 ;; The return value is (e.g.) either ("my-parser-function" . (point))
856 ;; or a list of them.
858 ;; If WHICH is nil, immediately return nil.
859 ;; If WHICH is 1, return innermost enclosing environment.
860 ;; If WHICH is t, return list of all environments enclosing point.
861 ;; If WHICH is a list of environments, look only for those environments and
862 ;; return the name of the first environment in this list found to enclose
865 (unless reftex-section-regexp (reftex-compile-variables))
868 (if (null reftex-special-env-parsers) (throw 'exit nil))
869 (if (null which) (throw 'exit nil))
870 (let ((bound (or bound (save-excursion (re-search-backward
871 reftex-section-regexp nil 1)
873 (fun-list (if (listp which)
874 (mapcar (lambda (x) (if (memq x which) x nil))
875 reftex-special-env-parsers)
876 reftex-special-env-parsers))
878 ;; Call all functions
879 (setq specials (mapcar
882 (setq rtn (and fun (funcall fun bound)))
883 (if rtn (cons (symbol-name fun) rtn) nil)))
885 ;; Delete the non-matches
886 (setq specials (delq nil specials))
888 (setq specials (sort specials (lambda (a b) (> (cdr a) (cdr b)))))
893 (defsubst reftex-move-to-next-arg (&optional ignore)
894 ;; Assuming that we are at the end of a macro name or a macro argument,
895 ;; move forward to the opening parenthesis of the next argument.
896 ;; This function understands the splitting of macros over several lines
900 ((memq (following-char) '(?\[ ?\{)))
902 ((and reftex-allow-detached-macro-args
903 (looking-at "[ \t]*[\n\r]?\\([ \t]*%[^\n\r]*[\n\r]\\)*[ \t]*[[{]"))
904 (goto-char (1- (match-end 0)))
908 (defun reftex-nth-arg-wrapper (key)
909 (let ((entry (assoc key reftex-env-or-mac-alist)))
910 (reftex-nth-arg (nth 5 entry) (nth 6 entry))))
912 (defun reftex-nth-arg (n &optional opt-args)
913 ;; Return the nth following {} or [] parentheses content.
914 ;; OPT-ARGS is a list of argument numbers which are optional.
916 ;; If we are sitting at a macro start, skip to end of macro name.
917 (and (eq (following-char) ?\\) (skip-chars-forward "a-zA-Z*\\\\"))
920 ;; Special case: Skip all touching arguments
922 (reftex-move-over-touching-args)
923 (reftex-context-substring))
925 ;; Do the real thing.
928 (when (reftex-move-to-next-arg)
931 (while (and (member cnt opt-args)
932 (eq (following-char) ?\{))
935 (unless (and (condition-case nil
936 (or (forward-list 1) t)
938 (reftex-move-to-next-arg)
942 (while (and (memq cnt opt-args)
943 (eq (following-char) ?\{))
946 (> (skip-chars-forward "{\\[") 0))
947 (reftex-context-substring)
950 (defun reftex-move-over-touching-args ()
952 (while (memq (following-char) '(?\[ ?\{))
956 (defun reftex-context-substring (&optional to-end)
957 ;; Return up to 150 chars from point
958 ;; When point is just after a { or [, limit string to matching parenthesis
961 ;; Environment - find next \end
962 (buffer-substring-no-properties
966 ;; FIXME: This is not perfect
967 (if (re-search-forward "\\\\end{" nil t)
970 ((memq (preceding-char) '(?\{ ?\[))
971 ;; Inside a list - get only the list.
972 (buffer-substring-no-properties
977 (let ((forward-sexp-function nil)) ;Unneeded fanciness.
980 (error (point-max))))))
982 ;; no list - just grab 150 characters
983 (buffer-substring-no-properties (point)
984 (min (+ (point) 150) (point-max))))))
986 ;; Variable holding the vector with section numbers
987 (defvar reftex-section-numbers (make-vector reftex-max-section-depth 0))
989 (defun reftex-init-section-numbers (&optional toc-entry appendix)
990 ;; Initialize the section numbers with zeros or with what is found
992 (let* ((level (or (nth 5 toc-entry) -1))
993 (numbers (nreverse (split-string (or (nth 6 toc-entry) "") "\\.")))
994 (depth (1- (length reftex-section-numbers)))
995 (i depth) number-string)
998 (aset reftex-section-numbers i 0)
999 (setq number-string (or (car numbers) "0"))
1000 (if (string-match "\\`[A-Z]\\'" number-string)
1001 (aset reftex-section-numbers i
1002 (- (string-to-char number-string) ?A -1))
1003 (aset reftex-section-numbers i (string-to-number number-string)))
1006 (put 'reftex-section-numbers 'appendix appendix))
1008 (defun reftex-section-number (&optional level star)
1009 ;; Return a string with the current section number.
1010 ;; When LEVEL is non-nil, increase section numbers on that level.
1011 (let* ((depth (1- (length reftex-section-numbers))) idx n (string "")
1012 (appendix (get 'reftex-section-numbers 'appendix))
1013 (partspecial (and (not reftex-part-resets-chapter)
1015 ;; partspecial means, this is a part statement.
1016 ;; Parts do not reset the chapter counter, and the part number is
1017 ;; not included in the numbering of other sectioning levels.
1019 (when (and (> level -1) (not star))
1020 (aset reftex-section-numbers
1021 level (1+ (aref reftex-section-numbers level))))
1022 (setq idx (1+ level))
1024 (while (<= idx depth)
1025 (if (or (not partspecial)
1027 (aset reftex-section-numbers idx 0))
1030 (setq string (concat "Part " (reftex-roman-number
1031 (aref reftex-section-numbers 0))))
1032 (setq idx (if reftex-part-resets-chapter 0 1))
1033 (while (<= idx depth)
1034 (setq n (aref reftex-section-numbers idx))
1035 (if (not (and partspecial (not (equal string ""))))
1036 (setq string (concat string (if (not (string= string "")) "." "")
1037 (int-to-string n))))
1040 (if (string-match "\\`\\([@0]\\.\\)+" string)
1041 (setq string (replace-match "" nil nil string)))
1042 (if (string-match "\\(\\.0\\)+\\'" string)
1043 (setq string (replace-match "" nil nil string)))
1045 (string-match "\\`[0-9]+" string))
1049 (1- (+ ?A (string-to-number (match-string 0 string)))))
1050 (substring string (match-end 0))))))
1052 (concat (make-string (1- (length string)) ?\ ) "*")
1055 (defun reftex-roman-number (n)
1056 ;; Return as a string the roman number equal to N.
1059 (list '((1000 . "M") ( 900 . "CM") ( 500 . "D") ( 400 . "CD")
1060 ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
1061 ( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
1065 (setq listel (pop list)
1069 (setq string (concat string s)
1070 nrest (- nrest i))))
1073 ;; arch-tag: 6a8168f7-abb9-4576-99dc-fcbc7ba901a3
1074 ;;; reftex-parse.el ends here