1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
|
;;; reftex-parse.el --- parser functions for RefTeX -*- lexical-binding: t; -*-
;; Copyright (C) 1997-2025 Free Software Foundation, Inc.
;; Author: Carsten Dominik <dominik@science.uva.nl>
;; Maintainer: auctex-devel@gnu.org
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(eval-when-compile (require 'cl-lib))
(require 'reftex)
(defmacro reftex-with-special-syntax (&rest body)
`(let ((saved-syntax (syntax-table)))
(unwind-protect
(progn
(set-syntax-table reftex-syntax-table)
(let ((case-fold-search nil))
,@body))
(set-syntax-table saved-syntax))))
;;;###autoload
(defun reftex-parse-one ()
"Re-parse this file."
(interactive)
(let ((reftex-enable-partial-scans t))
(reftex-access-scan-info '(4))))
;;;###autoload
(defun reftex-parse-all ()
"Re-parse entire document."
(interactive)
(reftex-access-scan-info '(16)))
(defvar reftex--index-tags)
;;;###autoload
(defun reftex-do-parse (rescan &optional file)
"Do a document rescan.
When allowed, do only a partial scan from FILE."
;; Normalize the rescan argument
(setq rescan (cond ((eq rescan t) t)
((eq rescan 1) 1)
((equal rescan '(4)) t)
((equal rescan '(16)) 1)
(t 1)))
;; Partial scans only when allowed
(unless reftex-enable-partial-scans
(setq rescan 1))
;; Do the scanning.
(let* ((old-list (symbol-value reftex-docstruct-symbol))
(master (reftex-TeX-master-file))
(true-master (file-truename master))
(master-dir (file-name-as-directory (file-name-directory master)))
(file (or file (buffer-file-name)))
(true-file (file-truename file))
(bibview-cache (assq 'bibview-cache old-list))
(reftex--index-tags (cdr (assq 'index-tags old-list)))
from-file appendix docstruct tmp)
;; Make sure replacement is really an option here
(when (and (eq rescan t)
(not (and (member (list 'bof file) old-list)
(member (list 'eof file) old-list))))
;; Scan whole document because no such file section exists
(setq rescan 1))
(when (string= true-file true-master)
;; Scan whole document because this file is the master
(setq rescan 1))
;; From which file do we start?
(setq from-file
(cond ((eq rescan t) (or file master))
((eq rescan 1) master)
(t (error "This should not happen (reftex-do-parse)"))))
;; Reset index-tags if we scan everything
(if (equal rescan 1) (setq reftex--index-tags nil))
;; Find active toc entry and initialize section-numbers
(setq reftex-active-toc (reftex-last-assoc-before-elt
'toc (list 'bof from-file) old-list)
appendix (reftex-last-assoc-before-elt
'appendix (list 'bof from-file) old-list))
(reftex-init-section-numbers reftex-active-toc appendix)
(if (eq rescan 1)
(message "Scanning entire document...")
(message "Scanning document from %s..." from-file))
(reftex-with-special-syntax
(save-window-excursion
(save-excursion
(unwind-protect
(setq docstruct
(reftex-parse-from-file
from-file docstruct master-dir))
(reftex-kill-temporary-buffers)))))
(message "Scanning document... done")
;; Turn the list around.
(setq docstruct (nreverse docstruct))
;; Set or insert
(setq docstruct (reftex-replace-label-list-segment
old-list docstruct (eq rescan 1)))
;; Add all missing information
(unless (assq 'label-numbers docstruct)
(push (cons 'label-numbers nil) docstruct))
(unless (assq 'master-dir docstruct)
(push (cons 'master-dir master-dir) docstruct))
(unless (assq 'bibview-cache docstruct)
(push (cons 'bibview-cache (cdr bibview-cache)) docstruct))
(let* ((bof1 (memq (assq 'bof docstruct) docstruct))
(bof2 (assq 'bof (cdr bof1)))
(is-multi (not (not (and bof1 bof2))))
(entry (or (assq 'is-multi docstruct)
(car (push (list 'is-multi is-multi) docstruct)))))
(setcdr entry (cons is-multi nil)))
(and reftex--index-tags
(setq reftex--index-tags (sort reftex--index-tags #'string<)))
(let ((index-tag-cell (assq 'index-tags docstruct)))
(if index-tag-cell
(setcdr index-tag-cell reftex--index-tags)
(push (cons 'index-tags reftex--index-tags) docstruct)))
(unless (assq 'xr docstruct)
(let* ((allxr (reftex-all-assq 'xr-doc docstruct))
(alist (mapcar
(lambda (x)
(if (setq tmp (reftex-locate-file (nth 2 x) "tex"
master-dir))
(cons (nth 1 x) tmp)
(message "Can't find external document %s"
(nth 2 x))
nil))
allxr))
(alist (delq nil alist))
(allprefix (delq nil (mapcar #'car alist)))
(regexp (if allprefix
(concat "\\`\\("
(mapconcat #'identity allprefix "\\|")
"\\)")
"\\\\\\\\\\\\"))) ; this will never match
(push (list 'xr alist regexp) docstruct)))
(set reftex-docstruct-symbol docstruct)
(put reftex-docstruct-symbol 'modified t)))
;;;###autoload
(defun reftex-everything-regexp ()
(if reftex-support-index
reftex-everything-regexp
reftex-everything-regexp-no-index))
;; NB this is a global autoload - see reftex.el.
;;;###autoload
(defun reftex-all-document-files (&optional relative)
"Return a list of all files belonging to the current document.
When RELATIVE is non-nil, give file names relative to directory
of master file."
(let* ((all (symbol-value reftex-docstruct-symbol))
(master-dir (file-name-directory (reftex-TeX-master-file)))
(re (concat "\\`" (regexp-quote master-dir)))
file-list tmp file)
(while (setq tmp (assoc 'bof all))
(setq file (nth 1 tmp)
all (cdr (memq tmp all)))
(and relative
(string-match re file)
(setq file (substring file (match-end 0))))
(push file file-list))
(nreverse file-list)))
;; Bound in the caller, reftex-do-parse.
(defun reftex-parse-from-file (file docstruct master-dir)
"Scan the buffer for labels and save them in a list."
(let ((regexp (reftex-everything-regexp))
(bound 0)
file-found tmp include-file
(level 1)
(highest-level 100)
toc-entry index-entry next-buf buf)
(catch 'exit
(setq file-found (reftex-locate-file file "tex" master-dir))
(if (and (not file-found)
(setq buf (find-buffer-visiting file)))
(setq file-found (buffer-file-name buf)))
(unless file-found
(push (list 'file-error file) docstruct)
(throw 'exit nil))
(save-excursion
(message "Scanning file %s" file)
(set-buffer
(setq next-buf
(reftex-get-file-buffer-force
file-found
(not (eq t reftex-keep-temporary-buffers)))))
;; Begin of file mark
(setq file (buffer-file-name))
(push (list 'bof file) docstruct)
(reftex-with-special-syntax
(save-excursion
(save-restriction
(widen)
(goto-char 1)
(while (re-search-forward regexp nil t)
(cond
((match-end 1)
;; It is a label
(when (or (null reftex-label-ignored-macros-and-environments)
;; \label{} defs should always be honored,
;; just no keyval style [label=foo] defs.
(string-equal "\\label{" (substring (reftex-match-string 0) 0 7))
(if (and (fboundp 'TeX-current-macro)
(fboundp 'LaTeX-current-environment))
(not (or (member (save-match-data (TeX-current-macro))
reftex-label-ignored-macros-and-environments)
(member (save-match-data (LaTeX-current-environment))
reftex-label-ignored-macros-and-environments)))
t))
(push (reftex-label-info (reftex-match-string 1) file bound)
docstruct)))
((match-end 3)
;; It is a section
;; Use the beginning as bound and not the end
;; (i.e. (point)) because the section command might
;; be the start of the current environment to be
;; found by `reftex-label-info'.
(setq bound (match-beginning 0))
;; The section regexp matches a character at the end
;; we are not interested in. Especially if it is the
;; backslash of a following macro we want to find in
;; the next parsing iteration.
(when (eq (char-before) ?\\) (backward-char))
;; Insert in List
(setq toc-entry (funcall reftex-section-info-function file))
(when (and toc-entry
(eq ;; Either both are t or both are nil.
(= (char-after bound) ?%)
(string-suffix-p ".dtx" file)))
;; It can happen that section info returns nil
(setq level (nth 5 toc-entry))
(setq highest-level (min highest-level level))
(if (= level highest-level)
(message
"Scanning %s %s ..."
(car (rassoc level reftex-section-levels-all))
(nth 6 toc-entry)))
(push toc-entry docstruct)
(setq reftex-active-toc toc-entry)))
((match-end 7)
;; It's an include or input
(setq include-file (reftex-match-string 7))
;; Test if this file should be ignored
(unless (delq nil (mapcar
(lambda (x) (string-match x include-file))
reftex-no-include-regexps))
;; Parse it
(setq docstruct
(reftex-parse-from-file
include-file
docstruct master-dir))))
((match-end 9)
;; Appendix starts here
(reftex-init-section-numbers nil t)
(push (cons 'appendix t) docstruct))
((match-end 10)
;; Index entry
(when reftex-support-index
(setq index-entry (reftex-index-info file))
(when index-entry
(cl-pushnew (nth 1 index-entry) reftex--index-tags :test #'equal)
(push index-entry docstruct))))
((match-end 11)
;; A macro with label
(save-excursion
(let* ((mac (reftex-match-string 11))
(label (progn (goto-char (match-end 11))
(save-match-data
(reftex-no-props
(reftex-nth-arg-wrapper
mac)))))
(typekey (nth 1 (assoc mac reftex-env-or-mac-alist)))
(entry (progn (if typekey
;; A typing macro
(goto-char (match-end 0))
;; A neutral macro
(goto-char (match-end 11))
(reftex-move-over-touching-args))
(reftex-label-info
label file bound nil nil))))
(push entry docstruct))))
(t (error "This should not happen (reftex-parse-from-file)")))
)
;; Find bibliography statement
(when (setq tmp (reftex-locate-bibliography-files master-dir))
(push (cons 'bib tmp) docstruct))
(goto-char 1)
(when (re-search-forward
"\\(\\`\\|[\n\r]\\)[ \t]*\\\\begin{thebibliography}" nil t)
(push (cons 'thebib file) docstruct))
;; Find external document specifications
(goto-char 1)
(while (re-search-forward
(concat "[\n\r][ \t]*"
;; Support \externalcitedocument macro
"\\\\external\\(?:cite\\)?document"
;; The optional prefix
"\\(\\[\\([^]]*\\)\\]\\)?"
;; The 2nd opt. arg can only be nocite
"\\(?:\\[nocite\\]\\)?"
;; Mandatory file argument
"{\\([^}]+\\)}")
nil t)
(push (list 'xr-doc (reftex-match-string 2)
(reftex-match-string 3))
docstruct))
;; End of file mark
(push (list 'eof file) docstruct)))))
;; Kill the scanned buffer
(reftex-kill-temporary-buffers next-buf))
;; Return the list
docstruct))
(defun reftex-using-biblatex-p ()
"Return non-nil if we are using biblatex or other specific cite package.
biblatex and other similar packages like multibib allow multiple macro
calls to load a bibliography file. This function should be able to
detect those packages."
(if (boundp 'TeX-active-styles)
;; the sophisticated AUCTeX way
(or (member "biblatex" TeX-active-styles)
(member "multibib" TeX-active-styles))
;; poor-man's check...
(save-excursion
(re-search-forward
"^[^%\n]*?\\\\usepackage\\(\\[[^]]*\\]\\)?{biblatex\\|multibib}" nil t))))
;;;###autoload
(defun reftex-locate-bibliography-files (master-dir &optional files)
"Scan buffer for bibliography macros and return file list."
(unless files
(save-excursion
(goto-char (point-min))
;; when biblatex or multibib are used, multiple \bibliography or
;; \addbibresource macros are allowed. With plain bibtex, only
;; the first is used.
(let ((using-biblatex (reftex-using-biblatex-p))
(again t))
(while (and again
(re-search-forward
(concat
;; "\\(\\`\\|[\n\r]\\)[^%]*\\\\\\("
"\\(^\\)[^%\n\r]*\\\\\\("
(mapconcat #'identity reftex-bibliography-commands "\\|")
"\\)\\(\\[.+?\\]\\)?{[ \t]*\\([^}]+\\)")
nil t))
(setq files
(append files
(split-string (reftex-match-string 4)
"[ \t\n\r]*,[ \t\n\r]*")))
(unless using-biblatex
(setq again nil))))))
(when files
(setq files
(mapcar
(lambda (x)
(if (or (member x reftex-bibfile-ignore-list)
(delq nil (mapcar (lambda (re) (string-match re x))
reftex-bibfile-ignore-regexps)))
;; excluded file
nil
;; find the file
(reftex-locate-file x "bib" master-dir)))
files))
(delq nil (delete-dups files))))
(defun reftex-replace-label-list-segment (old insert &optional entirely)
"Replace the segment in OLD which corresponds to INSERT.
Works with side effects, directly changes old.
If ENTIRELY is t, just return INSERT.
This function also makes sure the old toc markers do not point anywhere."
(cond
(entirely
(reftex-silence-toc-markers old (length old))
insert)
(t (let* ((new old)
(file (nth 1 (car insert)))
(eof-list (member (list 'eof file) old))
(bof-list (member (list 'bof file) old))
n)
(if (not (and bof-list eof-list))
(error "Cannot splice")
;; Splice
(reftex-silence-toc-markers bof-list (- (length bof-list)
(length eof-list)))
(setq n (- (length old) (length bof-list)))
(setcdr (nthcdr n new) (cdr insert))
(setcdr (nthcdr (1- (length new)) new) (cdr eof-list)))
new))))
;;;###autoload
(defun reftex-section-info (file)
"Return a section entry for the current match.
Careful: This function expects the `match-data' to still be in
place!"
(let* ((marker (set-marker (make-marker) (1- (match-beginning 3))))
(macro (reftex-match-string 3))
(prefix (save-match-data
(if (string-match "begin{\\([^}]+\\)}" macro)
(match-string 1 macro))))
(level-exp (cdr (assoc macro reftex-section-levels-all)))
(level (if (symbolp level-exp)
(save-match-data (funcall level-exp))
level-exp))
(star (= ?* (char-after (match-end 3))))
(unnumbered (or star (< level 0)))
(level (abs level))
(section-number (reftex-section-number level unnumbered))
(text1 (save-match-data
(save-excursion
(reftex-context-substring prefix))))
(literal (buffer-substring-no-properties
(1- (match-beginning 3))
(min (point-max) (+ (match-end 0) (length text1) 1))))
;; Literal can be too short since text1 too short. No big problem.
(text (reftex-nicify-text text1)))
;; Add section number and indentation
(setq text
(concat
(make-string (* reftex-level-indent level) ?\ )
(if (nth 1 reftex-label-menu-flags) ; section number flag
(concat section-number " "))
(if prefix (concat (capitalize prefix) ": ") "")
text))
(list 'toc "toc" text file marker level section-number
literal (marker-position marker))))
;;;###autoload
(defun reftex-ensure-index-support (&optional abort)
"When index support is turned off, ask to turn it on and
set the current prefix argument so that `reftex-access-scan-info'
will rescan the entire document."
(cond
(reftex-support-index t)
((y-or-n-p "Turn on index support and rescan entire document? ")
(setq reftex-support-index 'demanded
current-prefix-arg '(16)))
(t (if abort
(error "No index support")
(message "No index support")
(ding)
(sit-for 1)))))
;;;###autoload
(defun reftex-index-info-safe (file)
(reftex-with-special-syntax
(reftex-index-info file)))
(defvar test-dummy)
;;;###autoload
(defun reftex-index-info (file)
"Return an index entry for the current match.
Careful: This function expects the `match-data' to still be in
place!"
(catch 'exit
(let* ((macro (reftex-match-string 10))
(bom (match-beginning 10))
(boa (match-end 10))
(entry (or (assoc macro reftex-index-macro-alist)
(throw 'exit nil)))
(exclude (nth 3 entry))
;; The following is a test if this match should be excluded
(test-dummy (and (fboundp exclude)
(funcall exclude)
(throw 'exit nil)))
(itag (nth 1 entry))
(prefix (nth 2 entry))
(index-tag
(cond ((stringp itag) itag)
((integerp itag)
(progn (goto-char boa)
(or (reftex-nth-arg itag (nth 6 entry)) "idx")))
(t "idx")))
(arg (or (progn (goto-char boa)
(reftex-nth-arg (nth 5 entry) (nth 6 entry)))
""))
(end-of-args (progn (goto-char boa)
(reftex-move-over-touching-args)
(point)))
(end-of-context (progn (skip-chars-forward "^ \t\n\r") (point)))
(begin-of-context
(progn (goto-char bom)
(skip-chars-backward "^ \t\r\n")
(point)))
(context (buffer-substring-no-properties
begin-of-context end-of-context))
(key-end (if (string-match reftex-index-key-end-re arg)
(1+ (match-beginning 0))))
(rawkey (substring arg 0 key-end))
(key (if prefix (concat prefix rawkey) rawkey))
(sortkey (downcase key))
(showkey (mapconcat #'identity
(split-string key reftex-index-level-re)
" ! ")))
(goto-char end-of-args)
;; 0 1 2 3 4 5 6 7 8 9
(list 'index index-tag context file bom arg key showkey sortkey key-end))))
;;;###autoload
(defun reftex-short-context (env parse &optional bound derive)
"Get about one line of useful context for the label definition at point."
(if (consp parse)
(setq parse (if derive (cdr parse) (car parse))))
(reftex-nicify-text
(cond
((null parse)
(save-excursion
(reftex-context-substring)))
((eq parse t)
(if (string= env "section")
;; special treatment for section labels
(save-excursion
(if (and (re-search-backward reftex-section-or-include-regexp
(point-min) t)
(match-end 2))
(progn
(goto-char (match-end 0))
(reftex-context-substring))
(if reftex-active-toc
(progn
(string-match "{\\([^}]*\\)" (nth 7 reftex-active-toc))
(match-string 1 (nth 7 reftex-active-toc)))
"SECTION HEADING NOT FOUND")))
(save-excursion
(goto-char reftex-default-context-position)
(unless (eq (string-to-char env) ?\\)
(reftex-move-over-touching-args))
(reftex-context-substring))))
((stringp parse)
(save-excursion
(if (re-search-backward parse bound t)
(progn
(goto-char (match-end 0))
(reftex-context-substring))
"NO MATCH FOR CONTEXT REGEXP")))
((integerp parse)
(or (save-excursion
(goto-char reftex-default-context-position)
(reftex-nth-arg
parse
(nth 6 (assoc env reftex-env-or-mac-alist))))
""))
((fboundp parse)
;; A hook function. Call it.
(save-excursion
(condition-case error-var
(funcall parse env)
(error (format "HOOK ERROR: %s" (cdr error-var))))))
(t
"INVALID VALUE OF PARSE"))))
;;;###autoload
(defun reftex-where-am-I ()
"Return the docstruct entry above point.
Actually returns a cons cell in which the cdr is a flag indicating
if the information is exact (t) or approximate (nil)."
(let ((docstruct (symbol-value reftex-docstruct-symbol))
(cnt 0) rtn rtn-if-no-other
found)
(save-excursion
(while (not rtn)
(cl-incf cnt)
(setq found (re-search-backward (reftex-everything-regexp) nil t))
(setq rtn
(cond
((not found)
;; no match
(or
(car (member (list 'bof (buffer-file-name)) docstruct))
(not (setq cnt 2))
(assq 'bof docstruct) ;; for safety reasons
'corrupted))
((match-end 1)
;; Label
(assoc (reftex-match-string 1)
(symbol-value reftex-docstruct-symbol)))
((match-end 3)
;; Section
(goto-char (1- (match-beginning 3)))
(let* ((list (member (list 'bof (buffer-file-name))
docstruct))
(endelt (car (member (list 'eof (buffer-file-name))
list)))
rtn1)
(while (and list (not (eq endelt (car list))))
(if (and (eq (car (car list)) 'toc)
(string= (buffer-file-name)
(nth 3 (car list))))
(cond
((equal (point)
(or (and (markerp (nth 4 (car list)))
(marker-position (nth 4 (car list))))
(nth 8 (car list))))
;; Fits with marker position or recorded position
(setq rtn1 (car list) list nil))
((looking-at (reftex-make-regexp-allow-for-ctrl-m
(nth 7 (car list))))
;; Same title: remember, but keep looking
(setq rtn-if-no-other (car list)))))
(pop list))
rtn1))
((match-end 7)
;; Input or include...
(car
(member (list 'eof (reftex-locate-file
(reftex-match-string 7) "tex"
(cdr (assq 'master-dir docstruct))))
docstruct)))
((match-end 9)
(assq 'appendix (symbol-value reftex-docstruct-symbol)))
((match-end 10)
;; Index entry
(when reftex-support-index
(let* ((index-info (save-excursion
(reftex-index-info-safe nil)))
(list (member (list 'bof (buffer-file-name))
docstruct))
(endelt (car (member (list 'eof (buffer-file-name))
list)))
dist last-dist last (n 0))
;; Check all index entries with equal text
(while (and list (not (eq endelt (car list))))
(when (and (eq (car (car list)) 'index)
(string= (nth 2 index-info)
(nth 2 (car list))))
(cl-incf n)
(setq dist (abs (- (point) (nth 4 (car list)))))
(if (or (not last-dist) (< dist last-dist))
(setq last-dist dist last (car list))))
(setq list (cdr list)))
;; We are sure if we have only one, or a zero distance
(cond ((or (= n 1) (equal dist 0)) last)
((> n 1) (setq cnt 2) last)
(t nil)))))
((match-end 11)
(save-excursion
(goto-char (match-end 11))
(assoc (reftex-no-props
(reftex-nth-arg-wrapper
(reftex-match-string 11)))
(symbol-value reftex-docstruct-symbol))))
(t
(error "This should not happen (reftex-where-am-I)"))))))
;; Check if there was only a by-name match for the section.
(when (and (not rtn) rtn-if-no-other)
(setq rtn rtn-if-no-other
cnt 2))
(cons rtn (eq cnt 1))))
;;;###autoload
(defun reftex-notice-new (&optional n force)
"Hook to handshake with RefTeX after something new has been inserted."
;; Add a new entry to the docstruct list. If it is a section, renumber
;; the following sections.
;; FIXME: Put in a WHAT parameter and search backward until one is found.
;; When N is given, go back that many matches of reftex-everything-regexp
;; When FORCE is non-nil, also insert if `reftex-where-am-I' was uncertain.
(condition-case nil
(catch 'exit
(unless reftex-mode (throw 'exit nil))
(reftex-access-scan-info)
(let* ((docstruct (symbol-value reftex-docstruct-symbol))
here-I-am appendix tail entry star level
section-number context)
(save-excursion
(when (re-search-backward (reftex-everything-regexp) nil t (or n 1))
;; Find where we are
(setq here-I-am (reftex-where-am-I))
(or here-I-am (throw 'exit nil))
(unless (or force (cdr here-I-am)) (throw 'exit nil))
(setq tail (memq (car here-I-am) docstruct))
(or tail (throw 'exit nil))
(setq reftex-active-toc (reftex-last-assoc-before-elt
'toc (car here-I-am) docstruct)
appendix (reftex-last-assoc-before-elt
'appendix (car here-I-am) docstruct))
;; Initialize section numbers
(if (eq (car (car here-I-am)) 'appendix)
(reftex-init-section-numbers nil t)
(reftex-init-section-numbers reftex-active-toc appendix))
;; Match the section command
(when (re-search-forward (reftex-everything-regexp) nil t)
(cond
((match-end 1)
(push (reftex-label-info (reftex-match-string 1) buffer-file-name)
(cdr tail)))
((match-end 3)
(setq star (= ?* (char-after (match-end 3)))
entry (reftex-section-info (buffer-file-name))
level (nth 5 entry))
;; Insert the section info
(push entry (cdr tail))
;; We are done unless we use section numbers
(unless (nth 1 reftex-label-menu-flags) (throw 'exit nil))
;; Update the remaining toc items
(setq tail (cdr tail))
(while (and (setq tail (memq (assq 'toc (cdr tail)) tail))
(setq entry (car tail))
(>= (nth 5 entry) level))
(setq star (string-search "*" (nth 6 entry))
context (nth 2 entry)
section-number
(reftex-section-number (nth 5 entry) star))
(when (string-match "\\`\\([ \t]*\\)\\([.0-9A-Z]+\\)\\(.*\\)"
context)
(when (and (not appendix)
(>= (string-to-char (match-string 2)) ?A))
;; Just entered the appendix. Get out.
(throw 'exit nil))
;; Change the section number.
(setf (nth 2 entry)
(concat (match-string 1 context)
section-number
(match-string 3 context))))))
((match-end 10)
;; Index entry
(and reftex-support-index
(setq entry (reftex-index-info-safe buffer-file-name))
;; FIXME: (add-to-list 'reftex--index-tags (nth 1 index-entry))
(push entry (cdr tail))))))))))
(error nil))
)
(defsubst reftex-move-to-previous-arg (&optional bound)
"Move backward to the closing parenthesis of the previous argument.
This happens under the assumption that we are in front of a macro
argument. This function understands the splitting of macros over
several lines in TeX."
(cond
;; Just to be quick:
((memq (preceding-char) '(?\] ?\) ?\})))
;; Do a search
((and reftex-allow-detached-macro-args
(re-search-backward
"[])}][ \t]*[\n\r]?\\([ \t]*%[^\n\r]*[\n\r]\\)*[ \t]*\\=" bound t))
(goto-char (1+ (match-beginning 0)))
t)
(t nil)))
;;;###autoload
(defun reftex-what-macro-safe (which &optional bound)
"Call `reftex-what-macro' with special syntax table."
(reftex-with-special-syntax
(reftex-what-macro which bound)))
;;;###autoload
(defun reftex-what-macro (which &optional bound)
"Find out if point is within the arguments of any TeX-macro.
The return value is either (\"\\macro\" . (point)) or a list of them.
If WHICH is nil, immediately return nil.
If WHICH is 1, return innermost enclosing macro.
If WHICH is t, return list of all macros enclosing point.
If WHICH is a list of macros, look only for those macros and return the
name of the first macro in this list found to enclose point.
If the optional BOUND is an integer, bound backwards directed
searches to this point. If it is nil, limit to nearest \\section -
like statement.
This function is pretty stable, but can be fooled if the text contains
things like \\macro{aa}{bb} where \\macro is defined to take only one
argument. As RefTeX cannot know this, the string \"bb\" would still be
considered an argument of macro \\macro."
(unless reftex-section-regexp (reftex-compile-variables))
(catch 'exit
(if (null which) (throw 'exit nil))
(let ((bound (or bound (save-excursion (re-search-backward
reftex-section-regexp nil 1)
(point))))
pos cmd-list cmd cnt cnt-opt entry)
(save-restriction
(save-excursion
(narrow-to-region (max (point-min) bound) (point-max))
;; move back out of the current parenthesis
(while (condition-case nil
(let ((forward-sexp-function nil))
(up-list -1) t)
(error nil))
(setq cnt 1 cnt-opt 0)
;; move back over any touching sexps
(while (and (reftex-move-to-previous-arg bound)
(condition-case nil
(let ((forward-sexp-function nil))
(if (eq (preceding-char) ?\))
;; '?\(' and '?\)' receive the
;; punctuation syntax "." in
;; `reftex-syntax-table', so we have
;; to change it in order move back
;; over the optional arg in
;; parentheses correctly:
(let ((temp-table (make-syntax-table)))
(modify-syntax-entry ?\( "()" temp-table)
(modify-syntax-entry ?\) ")(" temp-table)
(with-syntax-table temp-table
(backward-sexp)))
(backward-sexp))
t)
(error nil)))
(if (memq (following-char) '(?\( ?\[)) (cl-incf cnt-opt))
(cl-incf cnt))
(setq pos (point))
(when (and (memq (following-char) '(?\[ ?\( ?\{))
(re-search-backward "\\\\[*a-zA-Z]+\\=" nil t))
(setq cmd (reftex-match-string 0))
(when (looking-at "\\\\begin{[^}]*}")
(setq cmd (reftex-match-string 0)
cnt (1- cnt)))
;; This does ignore optional arguments. Very hard to fix.
(when (setq entry (assoc cmd reftex-env-or-mac-alist))
(if (> cnt (or (nth 4 entry) 100))
(setq cmd nil)))
(cond
((null cmd))
((eq t which)
(push (cons cmd (point)) cmd-list))
((or (eq 1 which) (member cmd which))
(throw 'exit (cons cmd (point))))))
(goto-char pos)))
(nreverse cmd-list)))))
;;;###autoload
(defun reftex-what-environment (which &optional bound)
"Find out if point is inside a LaTeX environment.
The return value is (e.g.) either (\"equation\" . (point)) or a list of
them.
If WHICH is nil, immediately return nil.
If WHICH is 1, return innermost enclosing environment.
If WHICH is t, return list of all environments enclosing point.
If WHICH is a list of environments, look only for those environments and
return the name of the first environment in this list found to enclose
point.
If the optional BOUND is an integer, bound backwards directed searches to
this point. If it is nil, limit to nearest \\section - like statement."
(unless reftex-section-regexp (reftex-compile-variables))
(catch 'exit
(save-excursion
(if (null which) (throw 'exit nil))
(let ((bound (or bound (save-excursion (re-search-backward
reftex-section-regexp nil 1)
(point))))
env-list end-list env)
(while (re-search-backward "\\\\\\(begin\\|end\\){\\([^}]+\\)}"
bound t)
(setq env (buffer-substring-no-properties
(match-beginning 2) (match-end 2)))
(cond
((string= (match-string 1) "end")
(push env end-list))
((equal env (car end-list))
(setq end-list (cdr end-list)))
((eq t which)
(push (cons env (point)) env-list))
((or (eq 1 which) (member env which))
(throw 'exit (cons env (point))))))
(nreverse env-list)))))
;;;###autoload
(defun reftex-what-special-env (which &optional bound)
"Run the special environment parsers and return the matches.
The return value is (e.g.) either (\"my-parser-function\" . (point))
or a list of them.
If WHICH is nil, immediately return nil.
If WHICH is 1, return innermost enclosing environment.
If WHICH is t, return list of all environments enclosing point.
If WHICH is a list of environments, look only for those environments and
return the name of the first environment in this list found to enclose
point."
(unless reftex-section-regexp (reftex-compile-variables))
(catch 'exit
(save-excursion
(if (null reftex-special-env-parsers) (throw 'exit nil))
(if (null which) (throw 'exit nil))
(let ((bound (or bound (save-excursion (re-search-backward
reftex-section-regexp nil 1)
(point))))
(fun-list (if (listp which)
(mapcar (lambda (x) (if (memq x which) x nil))
reftex-special-env-parsers)
reftex-special-env-parsers))
specials rtn)
;; Call all functions
(setq specials (mapcar
(lambda (fun)
(save-excursion
(setq rtn (and fun (funcall fun bound)))
(if rtn (cons (symbol-name fun) rtn) nil)))
fun-list))
;; Delete the non-matches
(setq specials (delq nil specials))
;; Sort
(setq specials (sort specials (lambda (a b) (> (cdr a) (cdr b)))))
(if (eq which t)
specials
(car specials))))))
(defsubst reftex-move-to-next-arg (&optional _ignore)
"Assuming that we are at the end of a macro name or a macro argument,
move forward to the opening parenthesis of the next argument.
This function understands the splitting of macros over several lines
in TeX."
(cond
;; Just to be quick:
((memq (following-char) '(?\[ ?\{)))
;; Do a search
((and reftex-allow-detached-macro-args
(looking-at "[ \t]*[\n\r]?\\([ \t]*%[^\n\r]*[\n\r]\\)*[ \t]*[[{]"))
(goto-char (1- (match-end 0)))
t)
(t nil)))
(defun reftex-nth-arg-wrapper (key)
(let ((entry (assoc key reftex-env-or-mac-alist)))
(reftex-nth-arg (nth 5 entry) (nth 6 entry))))
;;;###autoload
(defun reftex-nth-arg (n &optional opt-args)
"Return the Nth following {} or [] parentheses content.
OPT-ARGS is a list of argument numbers which are optional."
;; If we are sitting at a macro start, skip to end of macro name.
(and (eq (following-char) ?\\) (skip-chars-forward "a-zA-Z*\\\\"))
(if (= n 1000)
;; Special case: Skip all touching arguments
(progn
(reftex-move-over-touching-args)
(reftex-context-substring))
;; Do the real thing.
(let ((cnt 1))
(when (reftex-move-to-next-arg)
(while (< cnt n)
(while (and (member cnt opt-args)
(eq (following-char) ?\{))
(cl-incf cnt))
(when (< cnt n)
(unless (and (condition-case nil
(or (forward-list 1) t)
(error nil))
(reftex-move-to-next-arg)
(cl-incf cnt))
(setq cnt 1000))))
(while (and (memq cnt opt-args)
(eq (following-char) ?\{))
(cl-incf cnt)))
(if (and (= n cnt)
(> (skip-chars-forward "{[") 0))
(reftex-context-substring)
nil))))
;;;###autoload
(defun reftex-move-over-touching-args ()
(condition-case nil
(while (memq (following-char) '(?\[ ?\{))
(forward-list 1))
(error nil)))
(defun reftex-context-substring (&optional to-end)
"Return up to 150 chars from point.
When point is just after a { or [, limit string to matching parenthesis."
(cond
(to-end
;; Environment - find next \end
(buffer-substring-no-properties
(point)
(min (+ (point) 150)
(save-match-data
;; FIXME: This is not perfect
(if (re-search-forward "\\\\end{" nil t)
(match-beginning 0)
(point-max))))))
((memq (preceding-char) '(?\{ ?\[))
;; Inside a list - get only the list.
(buffer-substring-no-properties
(point)
(min (+ (point) 150)
(point-max)
(condition-case nil
(let ((forward-sexp-function nil)) ;Unneeded fanciness.
(up-list 1)
(1- (point)))
(error (point-max))))))
(t
;; no list - just grab 150 characters
(buffer-substring-no-properties (point)
(min (+ (point) 150) (point-max))))))
;; Variable holding the vector with section numbers
(defvar reftex-section-numbers (make-vector reftex-max-section-depth 0))
;;;###autoload
(defun reftex-init-section-numbers (&optional toc-entry appendix)
"Initialize section numbers with zeros or with what is found in the TOC-ENTRY."
(let* ((level (or (nth 5 toc-entry) -1))
(numbers (nreverse (split-string (or (nth 6 toc-entry) "") "\\.")))
(depth (1- (length reftex-section-numbers)))
(i depth) number-string)
(while (>= i 0)
(if (> i level)
(aset reftex-section-numbers i 0)
(setq number-string (or (car numbers) "0"))
(if (string-match "\\`[A-Z]\\'" number-string)
(aset reftex-section-numbers i
(- (string-to-char number-string) ?A -1))
(aset reftex-section-numbers i (string-to-number number-string)))
(pop numbers))
(cl-decf i)))
(put 'reftex-section-numbers 'appendix appendix))
;;;###autoload
(defun reftex-section-number (&optional level star)
"Return a string with the current section number.
When LEVEL is non-nil, increase section numbers on that level."
(let* ((depth (1- (length reftex-section-numbers))) idx n (string "")
(appendix (get 'reftex-section-numbers 'appendix))
(partspecial (and (not reftex-part-resets-chapter)
(equal level 0))))
;; partspecial means, this is a part statement.
;; Parts do not reset the chapter counter, and the part number is
;; not included in the numbering of other sectioning levels.
(when level
(when (and (> level -1) (not star))
(aset reftex-section-numbers
level (1+ (aref reftex-section-numbers level))))
(setq idx (1+ level))
(when (not star)
(while (<= idx depth)
(if (or (not partspecial)
(not (= idx 1)))
(aset reftex-section-numbers idx 0))
(cl-incf idx))))
(if partspecial
(setq string (concat "Part " (reftex-roman-number
(aref reftex-section-numbers 0))))
(setq idx (if reftex-part-resets-chapter 0 1))
(while (<= idx depth)
(setq n (aref reftex-section-numbers idx))
(if (not (and partspecial (not (equal string ""))))
(setq string (concat string (if (not (string= string "")) "." "")
(int-to-string n))))
(cl-incf idx))
(save-match-data
(if (string-match "\\`\\([@0]\\.\\)+" string)
(setq string (replace-match "" nil nil string)))
(if (string-match "\\(\\.0\\)+\\'" string)
(setq string (replace-match "" nil nil string)))
(if (and appendix
(string-match "\\`[0-9]+" string))
(setq string
(concat
(char-to-string
(1- (+ ?A (string-to-number (match-string 0 string)))))
(substring string (match-end 0))))))
(if star
(concat (make-string (1- (length string)) ?\ ) "*")
string))))
(defun reftex-roman-number (n)
"Return as a string the roman number equal to N."
(let ((nrest n)
(string "")
(list '((1000 . "M") ( 900 . "CM") ( 500 . "D") ( 400 . "CD")
( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
( 1 . "I")))
listel i s)
(while (>= nrest 1)
(setq listel (pop list)
i (car listel)
s (cdr listel))
(while (>= nrest i)
(setq string (concat string s)
nrest (- nrest i))))
string))
(provide 'reftex-parse)
;;; reftex-parse.el ends here
;; Local Variables:
;; generated-autoload-file: "reftex-loaddefs.el"
;; End:
|