1;;; reftex-index.el --- index support with RefTeX 2 3;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 4;; 2006, 2007 Free Software Foundation, Inc. 5 6;; Author: Carsten Dominik <dominik@science.uva.nl> 7;; Maintainer: auctex-devel@gnu.org 8;; Version: 4.31 9 10;; This file is part of GNU Emacs. 11 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 2, or (at your option) 15;; any later version. 16 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. 21 22;; You should have received a copy of the GNU General Public License 23;; along with GNU Emacs; see the file COPYING. If not, write to the 24;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 25;; Boston, MA 02110-1301, USA. 26 27;;; Commentary: 28 29;;; Code: 30 31(eval-when-compile (require 'cl)) 32(provide 'reftex-index) 33(require 'reftex) 34;;; 35 36;; START remove for XEmacs release 37(defvar mark-active) 38(defvar zmacs-regions) 39(defvar transient-mark-mode) 40(defvar TeX-master) 41;; END remove for XEmacs release 42(defun reftex-index-selection-or-word (&optional arg phrase) 43 "Put selection or the word near point into the default index macro. 44This uses the information in `reftex-index-default-macro' to make an index 45entry. The phrase indexed is the current selection or the word near point. 46When called with one `C-u' prefix, let the user have a chance to edit the 47index entry. When called with 2 `C-u' as prefix, also ask for the index 48macro and other stuff. 49When called inside TeX math mode as determined by the `texmathp.el' library 50which is part of AUCTeX, the string is first processed with the 51`reftex-index-math-format', which see." 52 (interactive "P") 53 (let* ((use-default (not (equal arg '(16)))) ; check for double prefix 54 ;; check if we have an active selection 55 (active (if (boundp 'zmacs-regions) 56 (and zmacs-regions (region-exists-p)) ; XEmacs 57 (and transient-mark-mode mark-active))) ; Emacs 58 (beg (if active 59 (region-beginning) 60 (save-excursion 61 (skip-syntax-backward "w\\") (point)))) 62 (end (if active 63 (region-end) 64 (save-excursion 65 (skip-syntax-forward "w\\") (point)))) 66 (sel (buffer-substring beg end)) 67 (mathp (condition-case nil (texmathp) (error nil))) 68 (current-prefix-arg nil) ; we want to call reftex-index without prefix. 69 key def-char def-tag full-entry) 70 71 (if phrase 72 (progn 73 (reftex-index-visit-phrases-buffer) 74 (reftex-index-new-phrase sel)) 75 76 (if (equal sel "") 77 ;; Nothing selected, no word, so use full reftex-index command 78 (reftex-index) 79 ;; OK, we have something to index here. 80 ;; Add the dollars when necessary 81 (setq key (if mathp 82 (format reftex-index-math-format sel) 83 sel)) 84 ;; Get info from `reftex-index-default-macro' 85 (setq def-char (if use-default (car reftex-index-default-macro))) 86 (setq def-tag (if use-default (nth 1 reftex-index-default-macro))) 87 ;; Does the user want to edit the entry? 88 (setq full-entry (if arg 89 (reftex-index-complete-key 90 def-tag nil (cons key 0)) 91 key)) 92 ;; Delete what is in the buffer and make the index entry 93 (delete-region beg end) 94 (reftex-index def-char full-entry def-tag sel))))) 95 96(defun reftex-index (&optional char key tag sel no-insert) 97 "Query for an index macro and insert it along with its argments. 98The index macros available are those defined in `reftex-index-macro' or 99by a call to `reftex-add-index-macros', typically from an AUCTeX style file. 100RefteX provides completion for the index tag and the index key, and 101will prompt for other arguments." 102 103 (interactive) 104 105 ;; Ensure access to scanning info 106 (reftex-ensure-index-support t) 107 (reftex-access-scan-info current-prefix-arg) 108 109 ;; Find out which macro we are going to use 110 (let* ((char (or char 111 (reftex-select-with-char reftex-query-index-macro-prompt 112 reftex-query-index-macro-help))) 113 (macro (nth 1 (assoc char reftex-key-to-index-macro-alist))) 114 (entry (or (assoc macro reftex-index-macro-alist) 115 (error "No index macro associated with %c" char))) 116 (ntag (nth 1 entry)) 117 (tag (or tag (nth 1 entry))) 118 (nargs (nth 4 entry)) 119 (nindex (nth 5 entry)) 120 (opt-args (nth 6 entry)) 121 (repeat (nth 7 entry)) 122 opt tag1 value) 123 124 ;; Get the supported arguments 125 (if (stringp tag) 126 (setq tag1 tag) 127 (setq tag1 (or (reftex-index-complete-tag tag opt-args) ""))) 128 (setq key (or key 129 (reftex-index-complete-key 130 (if (string= tag1 "") "idx" tag1) 131 (member nindex opt-args)))) 132 133 ;; Insert the macro and ask for any additional args 134 (insert macro) 135 (loop for i from 1 to nargs do 136 (setq opt (member i opt-args) 137 value (cond ((= nindex i) key) 138 ((equal ntag i) tag1) 139 (t (read-string (concat "Macro arg nr. " 140 (int-to-string i) 141 (if opt " (optional)" "") 142 ": "))))) 143 (unless (and opt (string= value "")) 144 (insert (if opt "[" "{") value (if opt "]" "}")))) 145 (and repeat (stringp sel) (insert sel)) 146 (and key reftex-plug-into-AUCTeX (fboundp 'LaTeX-add-index-entries) 147 (LaTeX-add-index-entries key)) 148 (reftex-index-update-taglist tag1) 149 (reftex-notice-new))) 150 151(defun reftex-default-index () 152 (cond ((null reftex-index-default-tag) nil) 153 ((stringp reftex-index-default-tag) reftex-index-default-tag) 154 (t (or (get reftex-docstruct-symbol 'default-index-tag) 155 "idx")))) 156 157(defun reftex-update-default-index (tag &optional tag-list) 158 (if (and (not (equal tag "")) 159 (stringp tag) 160 (eq reftex-index-default-tag 'last) 161 (or (null tag-list) 162 (member tag tag-list))) 163 (put reftex-docstruct-symbol 'default-index-tag tag))) 164 165(defun reftex-index-complete-tag (&optional itag opt-args) 166 ;; Ask the user for a tag, completing on known tags. 167 ;; ITAG is the argument number which contains the tag. 168 ;; OPT-ARGS is a list of optional argument indices, as given by 169 ;; `reftex-parse-args'. 170 (let* ((opt (and (integerp itag) (member itag opt-args))) 171 (index-tags (cdr (assq 'index-tags 172 (symbol-value reftex-docstruct-symbol)))) 173 (default (reftex-default-index)) 174 (prompt (concat "Index tag" 175 (if (or opt default) 176 (format " (%s): " 177 (concat 178 (if opt "optional" "") 179 (if default 180 (concat (if opt ", " "") 181 (format "default %s" default)) 182 ""))) 183 ": "))) 184 (tag (completing-read prompt (mapcar 'list index-tags)))) 185 (if (and default (equal tag "")) (setq tag default)) 186 (reftex-update-default-index tag) 187 tag)) 188 189(defun reftex-index-select-tag () 190 ;; Have the user select an index tag. 191 ;; FIXME: should we cache tag-alist, prompt and help? 192 (let* ((index-tags (cdr (assoc 'index-tags 193 (symbol-value reftex-docstruct-symbol)))) 194 (default (reftex-default-index))) 195 (cond 196 ((null index-tags) 197 (error "No index tags available")) 198 199 ((= (length index-tags) 1) 200 ;; Just one index, use it 201 (car index-tags)) 202 203 ((> (length index-tags) 1) 204 ;; Several indices, ask. 205 (let* ((tags (copy-sequence index-tags)) 206 (cnt 0) 207 tag-alist i val len tag prompt help rpl) 208 ;; Move idx and glo up in the list to ensure ?i and ?g shortcuts 209 (if (member "glo" tags) 210 (setq tags (cons "glo" (delete "glo" tags)))) 211 (if (member "idx" tags) 212 (setq tags (cons "idx" (delete "idx" tags)))) 213 ;; Find unique shortcuts for each index. 214 (while (setq tag (pop tags)) 215 (setq len (length tag) 216 i -1 217 val nil) 218 (catch 'exit 219 (while (and (< (incf i) len) (null val)) 220 (unless (assq (aref tag i) tag-alist) 221 (push (list (aref tag i) 222 tag 223 (concat (substring tag 0 i) 224 "[" (substring tag i (incf i)) "]" 225 (substring tag i))) 226 tag-alist) 227 (throw 'exit t))) 228 (push (list (+ ?0 (incf cnt)) tag 229 (concat "[" (int-to-string cnt) "]:" tag)) 230 tag-alist))) 231 (setq tag-alist (nreverse tag-alist)) 232 ;; Compute Prompt and Help strings 233 (setq prompt 234 (concat 235 (format "Select Index%s: " 236 (if default (format " (Default <%s>)" default) "")) 237 (mapconcat (lambda(x) (nth 2 x)) tag-alist " "))) 238 (setq help 239 (concat "Select an Index\n===============\n" 240 (if default 241 (format "[^M] %s (the default)\n" default) 242 "") 243 (mapconcat (lambda(x) 244 (apply 'format "[%c] %s" x)) 245 tag-alist "\n"))) 246 ;; Query the user for an index-tag 247 (setq rpl (reftex-select-with-char prompt help 3 t)) 248 (message "") 249 (if (and default (equal rpl ?\C-m)) 250 default 251 (if (assq rpl tag-alist) 252 (progn 253 (reftex-update-default-index (nth 1 (assq rpl tag-alist))) 254 (nth 1 (assq rpl tag-alist))) 255 (error "No index tag associated with %c" rpl))))) 256 (t (error "This should not happen (reftex-index-select-tag)"))))) 257 258(defun reftex-index-complete-key (&optional tag optional initial) 259 ;; Read an index key, with completion. 260 ;; Restrict completion table on index tag TAG. 261 ;; OPTIONAL indicates if the arg is optional. 262 (let* ((table (reftex-sublist-nth 263 (symbol-value reftex-docstruct-symbol) 6 264 (lambda(x) (and (eq (car x) 'index) 265 (string= (nth 1 x) (or tag "")))) 266 t)) 267 (prompt (concat "Index key" (if optional " (optional)" "") ": ")) 268 (key (completing-read prompt table nil nil initial))) 269 key)) 270 271(defun reftex-index-update-taglist (newtag) 272 ;; add NEWTAG to the list of available index tags. 273 (let ((cell (assoc 'index-tags (symbol-value reftex-docstruct-symbol)))) 274 (and newtag (cdr cell) (not (member newtag (cdr cell))) 275 (push newtag (cdr cell))))) 276 277(defvar reftex-index-map (make-sparse-keymap) 278 "Keymap used for *Index* buffers.") 279 280(defvar reftex-index-menu) 281 282(defvar reftex-last-index-file nil 283 "Stores the file name from which `reftex-display-index' was called.") 284(defvar reftex-index-tag nil 285 "Stores the tag of the index in an index buffer.") 286 287(defvar reftex-index-return-marker (make-marker) 288 "Marker which makes it possible to return from index to old position.") 289 290(defvar reftex-index-restriction-indicator nil) 291(defvar reftex-index-restriction-data nil) 292 293(defun reftex-index-mode () 294 "Major mode for managing Index buffers for LaTeX files. 295This buffer was created with RefTeX. 296Press `?' for a summary of important key bindings, or check the menu. 297 298Here are all local bindings. 299 300\\{reftex-index-map}" 301 (interactive) 302 (kill-all-local-variables) 303 (setq major-mode 'reftex-index-mode 304 mode-name "RefTeX Index") 305 (use-local-map reftex-index-map) 306 (set (make-local-variable 'revert-buffer-function) 'reftex-index-revert) 307 (set (make-local-variable 'reftex-index-restriction-data) nil) 308 (set (make-local-variable 'reftex-index-restriction-indicator) nil) 309 (setq mode-line-format 310 (list "---- " 'mode-line-buffer-identification 311 " " 'global-mode-string 312 " R<" 'reftex-index-restriction-indicator ">" 313 " -%-")) 314 (setq truncate-lines t) 315 (when (featurep 'xemacs) 316 ;; XEmacs needs the call to make-local-hook 317 (make-local-hook 'post-command-hook) 318 (make-local-hook 'pre-command-hook)) 319 (make-local-variable 'reftex-last-follow-point) 320 (easy-menu-add reftex-index-menu reftex-index-map) 321 (add-hook 'post-command-hook 'reftex-index-post-command-hook nil t) 322 (add-hook 'pre-command-hook 'reftex-index-pre-command-hook nil t) 323 (run-hooks 'reftex-index-mode-hook)) 324 325(defconst reftex-index-help 326" AVAILABLE KEYS IN INDEX BUFFER 327 ============================== 328! A..Z Goto the section of entries starting with this letter. 329n / p next-entry / previous-entry 330SPC / TAB Show/Goto the corresponding entry in the LaTeX document. 331RET Goto the entry and hide the *Index* window (also on mouse-2). 332q / k Hide/Kill *Index* buffer. 333C-c = Switch to the TOC buffer. 334f / c Toggle follow mode / Toggle display of [c]ontext. 335g Refresh *Index* buffer. 336r / C-u r Reparse the LaTeX document / Reparse entire LaTeX document. 337s Switch to a different index (for documents with multiple indices). 338e / C-k Edit/Kill the entry. 339* | @ Edit specific part of entry: [*]key [|]attribute [@]visual 340 With prefix: kill that part. 341\( ) Toggle entry's beginning/end of page range property. 342_ ^ Add/Remove parent key (to make this item a subitem). 343} / { Restrict Index to a single document section / Widen. 344< / > When restricted, move restriction to previous/next section.") 345 346(defun reftex-index-show-entry (data &optional no-revisit) 347 ;; Find an index entry associated with DATA and display it highlighted 348 ;; in another window. NO-REVISIT means we are not allowed to visit 349 ;; files for this. 350 ;; Note: This function just looks for the nearest match of the 351 ;; context string and may fail if the entry moved and an identical 352 ;; entry is close to the old position. Frequent rescans make this 353 ;; safer. 354 (let* ((file (nth 3 data)) 355 (literal (nth 2 data)) 356 (pos (nth 4 data)) 357 (re (regexp-quote literal)) 358 (match 359 (cond 360 ((or (not no-revisit) 361 (reftex-get-buffer-visiting file)) 362 (switch-to-buffer-other-window 363 (reftex-get-file-buffer-force file nil)) 364 (goto-char (or pos (point-min))) 365 (or (looking-at re) 366 (reftex-nearest-match re (length literal)))) 367 (t (message reftex-no-follow-message) nil)))) 368 (when match 369 (goto-char (match-beginning 0)) 370 (recenter '(4)) 371 (reftex-highlight 0 (match-beginning 0) (match-end 0) (current-buffer))) 372 match)) 373 374(defun reftex-display-index (&optional tag overriding-restriction redo 375 &rest locations) 376 "Display a buffer with an index compiled from the current document. 377When the document has multiple indices, first prompts for the correct one. 378When index support is turned off, offer to turn it on. 379With one or two `C-u' prefixes, rescan document first. 380With prefix 2, restrict index to current document section. 381With prefix 3, restrict index to region." 382 383 (interactive) 384 385 ;; Ensure access to scanning info and rescan buffer if prefix are is '(4). 386 (let ((current-prefix-arg current-prefix-arg)) 387 (reftex-ensure-index-support t) 388 (reftex-access-scan-info current-prefix-arg)) 389 390 (set-marker reftex-index-return-marker (point)) 391 (setq reftex-last-follow-point 1) 392 393 ;; Determine the correct index to process 394 (let* ((docstruct (symbol-value reftex-docstruct-symbol)) 395 (docstruct-symbol reftex-docstruct-symbol) 396 (index-tag (or tag (reftex-index-select-tag))) 397 (master (reftex-TeX-master-file)) 398 (calling-file (buffer-file-name)) 399 (restriction 400 (or overriding-restriction 401 (and (not redo) 402 (reftex-get-restriction current-prefix-arg docstruct)))) 403 (locations 404 ;; See if we are on an index macro as initial position 405 (or locations 406 (let* ((what-macro (reftex-what-macro-safe 1)) 407 (macro (car what-macro)) 408 (here-I-am (when (member macro reftex-macros-with-index) 409 (save-excursion 410 (goto-char (+ (cdr what-macro) 411 (length macro))) 412 (reftex-move-over-touching-args) 413 (reftex-where-am-I))))) 414 (if (eq (car (car here-I-am)) 'index) 415 (list (car here-I-am)))))) 416 buffer-name) 417 418 (setq buffer-name (reftex-make-index-buffer-name index-tag)) 419 420 ;; Goto the buffer and put it into the correct mode 421 422 (when (or restriction current-prefix-arg) 423 (reftex-kill-buffer buffer-name)) 424 425 (if (get-buffer-window buffer-name) 426 (select-window (get-buffer-window buffer-name)) 427 (let ((default-major-mode 'reftex-index-mode)) 428 (switch-to-buffer buffer-name))) 429 430 (or (eq major-mode 'reftex-index-mode) (reftex-index-mode)) 431 432 ;; If the buffer is currently restricted, empty it to force update. 433 (when reftex-index-restriction-data 434 (reftex-erase-buffer)) 435 (set (make-local-variable 'reftex-last-index-file) calling-file) 436 (set (make-local-variable 'reftex-index-tag) index-tag) 437 (set (make-local-variable 'reftex-docstruct-symbol) docstruct-symbol) 438 (if restriction 439 (setq reftex-index-restriction-indicator (car restriction) 440 reftex-index-restriction-data (cdr restriction)) 441 (if (not redo) 442 (setq reftex-index-restriction-indicator nil 443 reftex-index-restriction-data nil))) 444 (when (= (buffer-size) 0) 445 ;; buffer is empty - fill it 446 (message "Building %s buffer..." buffer-name) 447 448 (setq buffer-read-only nil) 449 (insert (format 450"INDEX <%s> on %s 451Restriction: <%s> 452SPC=view TAB=goto RET=goto+hide [e]dit [q]uit [r]escan [f]ollow [?]Help 453------------------------------------------------------------------------------ 454" index-tag (abbreviate-file-name master) 455(if (eq (car (car reftex-index-restriction-data)) 'toc) 456 (nth 2 (car reftex-index-restriction-data)) 457 reftex-index-restriction-indicator))) 458 459 (if (reftex-use-fonts) 460 (put-text-property 1 (point) 'face reftex-index-header-face)) 461 (put-text-property 1 (point) 'intangible t) 462 463 (reftex-insert-index docstruct index-tag) 464 (goto-char (point-min)) 465 (run-hooks 'reftex-display-copied-context-hook) 466 (message "Building %s buffer...done." buffer-name) 467 (setq buffer-read-only t)) 468 (and locations (apply 'reftex-find-start-point (point) locations)) 469 (if reftex-index-restriction-indicator 470 (message "Index restricted: <%s>" reftex-index-restriction-indicator)))) 471 472(defun reftex-insert-index (docstruct tag &optional update-one remark) 473 ;; Insert an index into the current buffer. Entries are from the 474 ;; DOCSTRUCT. 475 ;; TAG is the subindex to process. 476 ;; UPDATE-ONE: When non-nil, delete the entry at point and replace 477 ;; it with whatever the DOCSTRUCT contains. 478 ;; REMARK can be a note to add to the entry. 479 (let* ((all docstruct) 480 (indent " ") 481 (context reftex-index-include-context) 482 (context-indent (concat indent " ")) 483 (section-chars (mapcar 'identity reftex-index-section-letters)) 484 (this-section-char 0) 485 (font (reftex-use-fonts)) 486 (bor (car reftex-index-restriction-data)) 487 (eor (nth 1 reftex-index-restriction-data)) 488 (mouse-face 489 (if (memq reftex-highlight-selection '(mouse both)) 490 reftex-mouse-selected-face 491 nil)) 492 (index-face (reftex-verified-face reftex-label-face 493 'font-lock-constant-face 494 'font-lock-reference-face)) 495 sublist cell from to first-char) 496 497 ;; Make the sublist and sort it 498 (when bor 499 (setq all (or (memq bor all) all))) 500 501 (while (setq cell (pop all)) 502 (if (eq cell eor) 503 (setq all nil) 504 (and (eq (car cell) 'index) 505 (equal (nth 1 cell) tag) 506 (push cell sublist)))) 507 (setq sublist (sort (nreverse sublist) 508 (lambda (a b) (string< (nth 8 a) (nth 8 b))))) 509 510 (when update-one 511 ;; Delete the entry at place 512 (and (bolp) (forward-char 1)) 513 (delete-region (previous-single-property-change (1+ (point)) :data) 514 (or (next-single-property-change (point) :data) 515 (point-max)))) 516 517 ;; Walk through the list and insert all entries 518 (while (setq cell (pop sublist)) 519 (unless update-one 520 (setq first-char (upcase (string-to-char (nth 6 cell)))) 521 (when (and (not (equal first-char this-section-char)) 522 (member first-char section-chars)) 523 ;; There is a new initial letter, so start a new section 524 (reftex-index-insert-new-letter first-char font) 525 (setq section-chars (delete first-char section-chars) 526 this-section-char first-char)) 527 (when (= this-section-char 0) 528 (setq this-section-char ?!) 529 (reftex-index-insert-new-letter this-section-char font))) 530 531 (setq from (point)) 532 (insert indent (nth 7 cell)) 533 (when font 534 (setq to (point)) 535 (put-text-property 536 (- (point) (length (nth 7 cell))) to 537 'face index-face) 538 (goto-char to)) 539 540 (when (or remark (nth 9 cell)) 541 (and (< (current-column) 40) 542 ;; FIXME: maybe this is too slow? 543 (insert (make-string (max (- 40 (current-column)) 0) ?\ ))) 544 (and (nth 9 cell) (insert " " (substring (nth 5 cell) (nth 9 cell)))) 545 (and remark (insert " " remark))) 546 547 (insert "\n") 548 (setq to (point)) 549 550 (when context 551 (insert context-indent (nth 2 cell) "\n") 552 (setq to (point))) 553 (put-text-property from to :data cell) 554 (when mouse-face 555 (put-text-property from (1- to) 556 'mouse-face mouse-face)) 557 (goto-char to)))) 558 559 560(defun reftex-index-insert-new-letter (letter &optional font) 561 ;; Start a new section in the index 562 (let ((from (point))) 563 (insert "\n" letter letter letter 564 "-----------------------------------------------------------------") 565 (when font 566 (put-text-property from (point) 'face reftex-index-section-face)) 567 (insert "\n"))) 568 569(defun reftex-get-restriction (arg docstruct) 570 ;; Interprete the prefix ARG and derive index restriction specs. 571 (let* ((beg (min (point) (or (condition-case nil (mark) (error nil)) 572 (point-max)))) 573 (end (max (point) (or (condition-case nil (mark) (error nil)) 574 (point-min)))) 575 bor eor label here-I-am) 576 (cond 577 ((eq arg 2) 578 (setq here-I-am (car (reftex-where-am-I)) 579 bor (if (eq (car here-I-am) 'toc) 580 here-I-am 581 (reftex-last-assoc-before-elt 582 'toc here-I-am docstruct)) 583 eor (car (memq (assq 'toc (cdr (memq bor docstruct))) docstruct)) 584 label (nth 6 bor))) 585 ((eq arg 3) 586 (save-excursion 587 (setq label "region") 588 (goto-char beg) 589 (setq bor (car (reftex-where-am-I))) 590 (setq bor (nth 1 (memq bor docstruct))) 591 (goto-char end) 592 (setq eor (nth 1 (memq (car (reftex-where-am-I)) docstruct))))) 593 (t nil)) 594 (if (and label (or bor eor)) 595 (list label bor eor) 596 nil))) 597 598(defun reftex-index-pre-command-hook () 599 ;; Used as pre command hook in *Index* buffer 600 (reftex-unhighlight 0) 601 (reftex-unhighlight 1)) 602 603(defun reftex-index-post-command-hook () 604 ;; Used in the post-command-hook for the *Index* buffer 605 (when (get-text-property (point) :data) 606 (and (> (point) 1) 607 (not (get-text-property (point) 'intangible)) 608 (memq reftex-highlight-selection '(cursor both)) 609 (reftex-highlight 1 610 (or (previous-single-property-change (1+ (point)) :data) 611 (point-min)) 612 (or (next-single-property-change (point) :data) 613 (point-max))))) 614 (if (integerp reftex-index-follow-mode) 615 ;; Remove delayed action 616 (setq reftex-index-follow-mode t) 617 (and reftex-index-follow-mode 618 (not (equal reftex-last-follow-point (point))) 619 ;; Show context in other window 620 (setq reftex-last-follow-point (point)) 621 (condition-case nil 622 (reftex-index-visit-location nil (not reftex-revisit-to-follow)) 623 (error t))))) 624 625(defun reftex-index-show-help () 626 "Show a summary of special key bindings." 627 (interactive) 628 (with-output-to-temp-buffer "*RefTeX Help*" 629 (princ reftex-index-help)) 630 (reftex-enlarge-to-fit "*RefTeX Help*" t) 631 ;; If follow mode is active, arrange to delay it one command 632 (if reftex-index-follow-mode 633 (setq reftex-index-follow-mode 1))) 634 635(defun reftex-index-next (&optional arg) 636 "Move to next selectable item." 637 (interactive "p") 638 (setq reftex-callback-fwd t) 639 (or (eobp) (forward-char 1)) 640 (goto-char (or (next-single-property-change (point) :data) 641 (point))) 642 (unless (get-text-property (point) :data) 643 (goto-char (or (next-single-property-change (point) :data) 644 (point))))) 645(defun reftex-index-previous (&optional arg) 646 "Move to previous selectable item." 647 (interactive "p") 648 (setq reftex-callback-fwd nil) 649 (goto-char (or (previous-single-property-change (point) :data) 650 (point))) 651 (unless (get-text-property (point) :data) 652 (goto-char (or (previous-single-property-change (point) :data) 653 (point))))) 654(defun reftex-index-toggle-follow () 655 "Toggle follow (other window follows with context)." 656 (interactive) 657 (setq reftex-last-follow-point -1) 658 (setq reftex-index-follow-mode (not reftex-index-follow-mode))) 659(defun reftex-index-toggle-context () 660 "Toggle inclusion of label context in *Index* buffer. 661Label context is only displayed when the labels are there as well." 662 (interactive) 663 (setq reftex-index-include-context (not reftex-index-include-context)) 664 (reftex-index-revert)) 665(defun reftex-index-view-entry () 666 "View document location in other window." 667 (interactive) 668 (reftex-index-visit-location)) 669(defun reftex-index-goto-entry-and-hide () 670 "Go to document location in other window. Hide the *Index* window." 671 (interactive) 672 (reftex-index-visit-location 'hide)) 673(defun reftex-index-goto-entry () 674 "Go to document location in other window. *Index* window stays." 675 (interactive) 676 (reftex-index-visit-location t)) 677(defun reftex-index-mouse-goto-line-and-hide (ev) 678 "Go to document location in other window. Hide the *Index* window." 679 (interactive "e") 680 (mouse-set-point ev) 681 (reftex-index-visit-location 'hide)) 682(defun reftex-index-quit () 683 "Hide the *Index* window and do not move point." 684 (interactive) 685 (or (one-window-p) (delete-window)) 686 (switch-to-buffer (marker-buffer reftex-index-return-marker)) 687 (goto-char (or (marker-position reftex-index-return-marker) (point)))) 688(defun reftex-index-quit-and-kill () 689 "Kill the *Index* buffer." 690 (interactive) 691 (kill-buffer (current-buffer)) 692 (or (one-window-p) (delete-window)) 693 (switch-to-buffer (marker-buffer reftex-index-return-marker)) 694 (goto-char (or (marker-position reftex-index-return-marker) (point)))) 695(defun reftex-index-goto-toc (&rest ignore) 696 "Switch to the table of contents of the current document. 697The function will go to the section where the entry at point was defined." 698 (interactive) 699 (if (get-text-property (point) :data) 700 (reftex-index-goto-entry) 701 (switch-to-buffer (marker-buffer reftex-index-return-marker))) 702 (delete-other-windows) 703 (reftex-toc)) 704(defun reftex-index-rescan (&rest ignore) 705 "Regenerate the *Index* buffer after reparsing file of section at point." 706 (interactive) 707 (let ((index-tag reftex-index-tag)) 708 (if (and reftex-enable-partial-scans 709 (null current-prefix-arg)) 710 (let* ((data (get-text-property (point) :data)) 711 (file (nth 3 data)) 712 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0)))) 713 (if (not file) 714 (error "Don't know which file to rescan. Try `C-u r'") 715 (switch-to-buffer (reftex-get-file-buffer-force file)) 716 (setq current-prefix-arg '(4)) 717 (reftex-display-index index-tag nil 'redo line))) 718 (reftex-index-Rescan)) 719 (reftex-kill-temporary-buffers))) 720(defun reftex-index-Rescan (&rest ignore) 721 "Regenerate the *Index* buffer after reparsing the entire document." 722 (interactive) 723 (let ((index-tag reftex-index-tag) 724 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0)))) 725 (switch-to-buffer 726 (reftex-get-file-buffer-force reftex-last-index-file)) 727 (setq current-prefix-arg '(16)) 728 (reftex-display-index index-tag nil 'redo line))) 729(defun reftex-index-revert (&rest ignore) 730 "Regenerate the *Index* from the internal lists. No reparsing os done." 731 (interactive) 732 (let ((buf (current-buffer)) 733 (index-tag reftex-index-tag) 734 (data (get-text-property (point) :data)) 735 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0)))) 736 (switch-to-buffer 737 (reftex-get-file-buffer-force reftex-last-index-file)) 738 (reftex-erase-buffer buf) 739 (setq current-prefix-arg nil 740 reftex-last-follow-point 1) 741 (reftex-display-index index-tag nil 'redo data line))) 742(defun reftex-index-switch-index-tag (&rest ignore) 743 "Switch to a different index of the same document." 744 (interactive) 745 (switch-to-buffer 746 (reftex-get-file-buffer-force reftex-last-index-file)) 747 (setq current-prefix-arg nil) 748 (reftex-display-index nil nil 'redo)) 749 750(defun reftex-index-restrict-to-section (&optional force) 751 "Restrict index to entries defined in same document sect. as entry at point." 752 ;; Optional FORCE means, even if point is not on an index entry. 753 (interactive) 754 (let* ((data (get-text-property (point) :data)) 755 (docstruct (symbol-value reftex-docstruct-symbol)) 756 bor eor) 757 (if (and (not data) force) 758 (setq data (assq 'toc docstruct))) 759 (when data 760 (setq bor (reftex-last-assoc-before-elt 'toc data docstruct) 761 eor (car (memq (assq 'toc (cdr (memq bor docstruct))) 762 docstruct)) 763 reftex-index-restriction-data (list bor eor) 764 reftex-index-restriction-indicator (nth 6 bor) ))) 765 (reftex-index-revert)) 766 767(defun reftex-index-widen (&rest ignore) 768 "Show the unrestricted index (all entries)." 769 (interactive) 770 (setq reftex-index-restriction-indicator nil 771 reftex-index-restriction-data nil) 772 (reftex-index-revert) 773 (message "Index widened")) 774(defun reftex-index-restriction-forward (&rest ignore) 775 "Restrict to previous section. 776When index is currently unrestricted, restrict it to a section. 777When index is restricted, select the next section as restriction criterion." 778 (interactive) 779 (let* ((docstruct (symbol-value reftex-docstruct-symbol)) 780 (bor (nth 1 reftex-index-restriction-data))) 781 (if (or (not bor) 782 (not (eq (car bor) 'toc))) 783 (reftex-index-restrict-to-section t) 784 (setq reftex-index-restriction-indicator (nth 6 bor) 785 reftex-index-restriction-data 786 (list bor 787 (car (memq (assq 'toc (cdr (memq bor docstruct))) 788 docstruct)))) 789 (reftex-index-revert)))) 790(defun reftex-index-restriction-backward (&rest ignore) 791 "Restrict to next section. 792When index is currently unrestricted, restrict it to a section. 793When index is restricted, select the previous section as restriction criterion." 794 (interactive) 795 (let* ((docstruct (symbol-value reftex-docstruct-symbol)) 796 (eor (car reftex-index-restriction-data)) 797 (bor (reftex-last-assoc-before-elt 'toc eor docstruct t))) 798 (if (or (not bor) 799 (not (eq (car bor) 'toc))) 800 (reftex-index-restrict-to-section t) 801 (setq reftex-index-restriction-indicator (nth 6 bor) 802 reftex-index-restriction-data 803 (list bor eor)) 804 (reftex-index-revert)))) 805 806(defun reftex-index-visit-location (&optional final no-revisit) 807 ;; Visit the tex file corresponding to the index entry on the current line. 808 ;; If FINAL is t, stay there 809 ;; If FINAL is 'hide, hide the *Index* window. 810 ;; Otherwise, move cursor back into *Index* window. 811 ;; NO-REVISIT means don't visit files, just use live biffers. 812 813 (let* ((data (get-text-property (point) :data)) 814 (index-window (selected-window)) 815 show-window show-buffer match) 816 817 (unless data (error "Don't know which index entry to visit")) 818 819 (if (eq (car data) 'index) 820 (setq match (reftex-index-show-entry data no-revisit))) 821 822 (setq show-window (selected-window) 823 show-buffer (current-buffer)) 824 825 (unless match 826 (select-window index-window) 827 (error "Cannot find location")) 828 829 (select-window index-window) 830 831 ;; Use the `final' parameter to decide what to do next 832 (cond 833 ((eq final t) 834 (reftex-unhighlight 0) 835 (select-window show-window)) 836 ((eq final 'hide) 837 (reftex-unhighlight 0) 838 (or (one-window-p) (delete-window)) 839 (switch-to-buffer show-buffer)) 840 (t nil)))) 841 842(defun reftex-index-analyze-entry (data) 843 ;; This splits the index context so that key, attribute and visual 844 ;; values are accessible individually. 845 (interactive) 846 (let* ((arg (nth 5 data)) 847 (context (nth 2 data)) 848 (sc reftex-index-special-chars) 849 (boa (if (string-match (regexp-quote (concat "{" arg "}")) context) 850 (1+ (match-beginning 0)) 851 (error "Something is wrong here"))) 852 (eoa (1- (match-end 0))) 853 (boactual (if (string-match (concat "[^" (nth 3 sc) "]" (nth 2 sc)) 854 context boa) 855 (1+ (match-beginning 0)) 856 eoa)) 857 (boattr (if (string-match (concat "[^" (nth 3 sc) "]" (nth 1 sc)) 858 context boa) 859 (1+ (match-beginning 0)) 860 boactual)) 861 (pre (substring context 0 boa)) 862 (key (substring context boa boattr)) 863 (attr (substring context boattr boactual)) 864 (actual (substring context boactual eoa)) 865 (post (substring context eoa))) 866 (list pre key attr actual post))) 867 868(defun reftex-index-edit () 869 "Edit the index entry at point." 870 (interactive) 871 (let* ((data (get-text-property (point) :data)) 872 old new) 873 (unless data (error "Don't know which index entry to edit")) 874 (reftex-index-view-entry) 875 (setq old (nth 2 data) new (read-string "Edit: " old)) 876 (reftex-index-change-entry new))) 877 878(defun reftex-index-toggle-range-beginning () 879 "Toggle the page range start attribute `|('." 880 (interactive) 881 (let* ((data (get-text-property (point) :data)) 882 (bor (concat (nth 1 reftex-index-special-chars) "(")) 883 new analyze attr) 884 (unless data (error "Don't know which index entry to edit")) 885 (setq analyze (reftex-index-analyze-entry data) 886 attr (nth 2 analyze)) 887 (setf (nth 2 analyze) (if (string= attr bor) "" bor)) 888 (setq new (apply 'concat analyze)) 889 (reftex-index-change-entry 890 new (if (string= (nth 2 analyze) bor) 891 "Entry is now START-OF-PAGE-RANGE" 892 "START-OF-PAGE-RANGE canceled")))) 893 894(defun reftex-index-toggle-range-end () 895 "Toggle the page-range-end attribute `|)'." 896 (interactive) 897 (let* ((data (get-text-property (point) :data)) 898 (eor (concat (nth 1 reftex-index-special-chars) ")")) 899 new analyze attr) 900 (unless data (error "Don't know which index entry to edit")) 901 (setq analyze (reftex-index-analyze-entry data) 902 attr (nth 2 analyze)) 903 (setf (nth 2 analyze) (if (string= attr eor) "" eor)) 904 (setq new (apply 'concat analyze)) 905 (reftex-index-change-entry 906 new (if (string= (nth 2 analyze) eor) 907 "Entry is now END-OF-PAGE-RANGE" 908 "END-OF-PAGE-RANGE canceled")))) 909 910(defun reftex-index-edit-key () 911 "Edit the KEY part of the index entry." 912 (interactive) 913 (reftex-index-edit-part nil 1 "" "Key: " t)) 914 915(defun reftex-index-edit-attribute (&optional arg) 916 "EDIT the ATTRIBUTE part of the entry. With arg: remove entire ATTRIBUTE." 917 (interactive "P") 918 (reftex-index-edit-part arg 2 (nth 1 reftex-index-special-chars) 919 "Attribute: ")) 920 921(defun reftex-index-edit-visual (&optional arg) 922 "EDIT the VISUAL part of the entry. With arg: remove entire VISUAL string." 923 (interactive "P") 924 (reftex-index-edit-part arg 3 (nth 2 reftex-index-special-chars) "Visual: ")) 925 926(defun reftex-index-edit-part (arg n initial prompt &optional dont-allow-empty) 927 ;; This function does the work for all partial editing commands 928 (let* ((data (get-text-property (point) :data)) 929 new analyze opart npart) 930 (unless data (error "Don't know which index entry to edit")) 931 ;; Analyze the whole context string 932 (setq analyze (reftex-index-analyze-entry data) 933 opart (nth n analyze)) 934 (and (> (length opart) 0) (setq opart (substring opart 1))) 935 ;; Have the user editing the part 936 (setq npart (if arg "" (read-string (concat prompt initial) opart))) 937 ;; Tests: 938 (cond ((string= npart opart) 939 (error "Not changed")) 940 ((string= npart "") 941 (if dont-allow-empty 942 (error "Invalid value") 943 (setf (nth n analyze) npart))) 944 (t (setf (nth n analyze) (concat initial npart)))) 945 (setq new (apply 'concat analyze)) 946 ;; Change the entry and insert the changed version into the index. 947 (reftex-index-change-entry 948 new (if (string= npart "") 949 (format "Deleted: %s" opart) 950 (format "New value is: %s" npart))))) 951 952(defun reftex-index-level-down () 953 "Make index entry a subitem of another entry." 954 (interactive) 955 (let* ((data (get-text-property (point) :data)) 956 (docstruct (symbol-value reftex-docstruct-symbol)) 957 old new prefix key) 958 (unless data (error "Don't know which index entry to change")) 959 (setq old (nth 2 data) 960 key (nth 6 data) 961 prefix (completing-read 962 "Prefix: " 963 (reftex-sublist-nth 964 docstruct 6 965 (lambda (x) 966 (and (eq (car x) 'index) 967 (string= (nth 1 x) reftex-index-tag))) t))) 968 (unless (string-match 969 (concat (regexp-quote (car reftex-index-special-chars)) "\\'") 970 prefix) 971 (setq prefix (concat prefix (car reftex-index-special-chars)))) 972 (if (string-match (regexp-quote key) old) 973 (setq new (replace-match (concat prefix key) t t old)) 974 (error "Cannot construct new index key")) 975 (reftex-index-change-entry new (format "Added prefix: %s" prefix)))) 976 977(defun reftex-index-level-up () 978 "Remove the highest level of a hierarchical index entry." 979 (interactive) 980 (let* ((data (get-text-property (point) :data)) 981 old new prefix) 982 (unless data (error "Don't know which entry to change")) 983 (setq old (nth 2 data)) 984 (if (string-match (concat "{\\([^" (nth 0 reftex-index-special-chars) "]*" 985 "[^" (nth 3 reftex-index-special-chars) "]" 986 (regexp-quote (nth 0 reftex-index-special-chars)) 987 "\\)") 988 old) 989 (setq prefix (substring old (match-beginning 1) (match-end 1)) 990 new (concat (substring old 0 (match-beginning 1)) 991 (substring old (match-end 1)))) 992 (error "Entry is not a subitem")) 993 (reftex-index-change-entry new (format "Removed prefix: %s" prefix)))) 994 995(defun reftex-index-kill () 996 "FIXME: Not yet implemented" 997 (interactive) 998 (error "This function is currently not implemented")) 999 1000(defun reftex-index-undo () 1001 "FIXME: Not yet implemented" 1002 (interactive) 1003 (error "This function is currently not implemented")) 1004 1005(defun reftex-index-change-entry (new &optional message) 1006 ;; Change the full context string of the index entry at point to 1007 ;; NEW. This actually edits the buffer where the entry is defined. 1008 1009 (let* ((data (get-text-property (point) :data)) 1010 old beg end info) 1011 (unless data (error "Cannot change entry")) 1012 (reftex-index-view-entry) 1013 (setq beg (match-beginning 0) end (match-end 0)) 1014 (setq old (nth 2 data)) 1015 (and (equal old new) (error "Entry unchanged")) 1016 (save-excursion 1017 (set-buffer (get-file-buffer (nth 3 data))) 1018 (goto-char beg) 1019 (unless (looking-at (regexp-quote old)) 1020 (error "This should not happen (reftex-index-change-entry)")) 1021 (delete-region beg end) 1022 (insert new) 1023 (goto-char (1- beg)) 1024 (when (and (re-search-forward (reftex-everything-regexp) nil t) 1025 (match-end 10) 1026 (< (abs (- (match-beginning 10) beg)) (length new)) 1027 (setq info (reftex-index-info-safe buffer-file-name))) 1028 (setcdr data (cdr info)))) 1029 (let ((buffer-read-only nil)) 1030 (save-excursion 1031 (reftex-insert-index (list data) reftex-index-tag t 1032 "EDITED"))) 1033 (setq reftex-last-follow-point 1) 1034 (and message (message "%s" message)))) 1035 1036;; Index map 1037(define-key reftex-index-map (if (featurep 'xemacs) [(button2)] [(mouse-2)]) 1038 'reftex-index-mouse-goto-line-and-hide) 1039(define-key reftex-index-map [follow-link] 'mouse-face) 1040 1041(substitute-key-definition 1042 'next-line 'reftex-index-next reftex-index-map global-map) 1043(substitute-key-definition 1044 'previous-line 'reftex-index-previous reftex-index-map global-map) 1045 1046(loop for x in 1047 '(("n" . reftex-index-next) 1048 ("p" . reftex-index-previous) 1049 ("?" . reftex-index-show-help) 1050 (" " . reftex-index-view-entry) 1051 ("\C-m" . reftex-index-goto-entry-and-hide) 1052 ("\C-i" . reftex-index-goto-entry) 1053 ("\C-k" . reftex-index-kill) 1054 ("r" . reftex-index-rescan) 1055 ("R" . reftex-index-Rescan) 1056 ("g" . revert-buffer) 1057 ("q" . reftex-index-quit) 1058 ("k" . reftex-index-quit-and-kill) 1059 ("f" . reftex-index-toggle-follow) 1060 ("s" . reftex-index-switch-index-tag) 1061 ("e" . reftex-index-edit) 1062 ("^" . reftex-index-level-up) 1063 ("_" . reftex-index-level-down) 1064 ("}" . reftex-index-restrict-to-section) 1065 ("{" . reftex-index-widen) 1066 (">" . reftex-index-restriction-forward) 1067 ("<" . reftex-index-restriction-backward) 1068 ("(" . reftex-index-toggle-range-beginning) 1069 (")" . reftex-index-toggle-range-end) 1070 ("|" . reftex-index-edit-attribute) 1071 ("@" . reftex-index-edit-visual) 1072 ("*" . reftex-index-edit-key) 1073 ("\C-c=". reftex-index-goto-toc) 1074 ("c" . reftex-index-toggle-context)) 1075 do (define-key reftex-index-map (car x) (cdr x))) 1076 1077(loop for key across "0123456789" do 1078 (define-key reftex-index-map (vector (list key)) 'digit-argument)) 1079(define-key reftex-index-map "-" 'negative-argument) 1080 1081;; The capital letters and the exclamation mark 1082(loop for key across (concat "!" reftex-index-section-letters) do 1083 (define-key reftex-index-map (vector (list key)) 1084 (list 'lambda '() '(interactive) 1085 (list 'reftex-index-goto-letter key)))) 1086 1087(defun reftex-index-goto-letter (char) 1088 "Go to the CHAR section in the index." 1089 (let ((pos (point)) 1090 (case-fold-search nil)) 1091 (goto-line 3) 1092 (if (re-search-forward (concat "^" (char-to-string char)) nil t) 1093 (progn 1094 (beginning-of-line) 1095 (recenter 0) 1096 (reftex-index-next)) 1097 (goto-char pos) 1098 (if (eq char ?!) 1099 (error "This <%s> index does not contain entries sorted before the letters" 1100 reftex-index-tag) 1101 (error "This <%s> index does not contain entries starting with `%c'" 1102 reftex-index-tag char))))) 1103 1104(easy-menu-define 1105 reftex-index-menu reftex-index-map 1106 "Menu for Index buffer" 1107 `("Index" 1108 ["Goto section A-Z" 1109 (message "To go to a section, just press any of: !%s" 1110 reftex-index-section-letters) t] 1111 ["Show Entry" reftex-index-view-entry t] 1112 ["Go To Entry" reftex-index-goto-entry t] 1113 ["Exit & Go To Entry" reftex-index-goto-entry-and-hide t] 1114 ["Table of Contents" reftex-index-goto-toc t] 1115 ["Quit" reftex-index-quit t] 1116 "--" 1117 ("Update" 1118 ["Rebuilt *Index* Buffer" revert-buffer t] 1119 "--" 1120 ["Rescan One File" reftex-index-rescan reftex-enable-partial-scans] 1121 ["Rescan Entire Document" reftex-index-Rescan t]) 1122 ("Restrict" 1123 ["Restrict to section" reftex-index-restrict-to-section t] 1124 ["Widen" reftex-index-widen reftex-index-restriction-indicator] 1125 ["Next Section" reftex-index-restriction-forward 1126 reftex-index-restriction-indicator] 1127 ["Previous Section" reftex-index-restriction-backward 1128 reftex-index-restriction-indicator]) 1129 ("Edit" 1130 ["Edit Entry" reftex-index-edit t] 1131 ["Edit Key" reftex-index-edit-key t] 1132 ["Edit Attribute" reftex-index-edit-attribute t] 1133 ["Edit Visual" reftex-index-edit-visual t] 1134 "--" 1135 ["Add Parentkey" reftex-index-level-down t] 1136 ["Remove Parentkey " reftex-index-level-up t] 1137 "--" 1138 ["Make Start-of-Range" reftex-index-toggle-range-beginning t] 1139 ["Make End-of-Range" reftex-index-toggle-range-end t] 1140 "--" 1141 ["Kill Entry" reftex-index-kill nil] 1142 "--" 1143 ["Undo" reftex-index-undo nil]) 1144 ("Options" 1145 ["Context" reftex-index-toggle-context :style toggle 1146 :selected reftex-index-include-context] 1147 "--" 1148 ["Follow Mode" reftex-index-toggle-follow :style toggle 1149 :selected reftex-index-follow-mode]) 1150 "--" 1151 ["Help" reftex-index-show-help t])) 1152 1153 1154;;---------------------------------------------------------------------- 1155;; The Index Phrases File 1156 1157;; Some constants and variables 1158(defconst reftex-index-phrases-comment-regexp "^[ \t]*%.*" 1159 "Regular expression to match comment lines in phrases buffer") 1160(defconst reftex-index-phrases-macrodef-regexp 1161 "^\\(>>>INDEX_MACRO_DEFINITION:\\)[ \t]+\\(\\S-\\)\\( *\t[ \t]*\\)\\([^\t]*[^ \t]\\)\\( *\t[ \t]*\\)\\(\\S-+\\)" 1162 "Regular expression to match macro definition lines the phrases buffer.") 1163;(defconst reftex-index-phrases-macrodef-regexp 1164; "^\\(>>>INDEX_MACRO_DEFINITION:\\)[ \t]+\\(\\S-\\)\\([ \t]*\\)\\([^\t]*[^ \t]\\)\\([ \t]*\\)\\(nil\\|t\\)[ \t]*$" 1165; "Regular expression to match macro definition lines the phrases buffer. 1166;This version would allow just spaces as separators.") 1167(defconst reftex-index-phrases-phrase-regexp1 1168 "^\\(\\S-?\\)\\(\t\\)\\([^\t\n]*\\S-\\)\\([ \t]*\\)$" 1169 "Regular expression matching phrases which have no separate index key.") 1170(defconst reftex-index-phrases-phrase-regexp2 1171 "^\\(\\S-?\\)\\(\t\\)\\([^\t]*\\S-\\)\\(\t[ \t]*\\)\\([^\n\t]*\\S-\\)[ \t]*$" 1172 "Regular expression matching phrases which have a separate index key.") 1173(defconst reftex-index-phrases-phrase-regexp12 1174 "^\\(\\S-?\\)\\(\t\\)\\([^\n\t]*\\S-\\)\\(\\(\t[ \t]*\\)\\([^\n\t]*\\S-\\)\\)?[ \t]*$" 1175 "Regular expression matching all types of phrase lines.") 1176(defvar reftex-index-phrases-macro-data nil 1177 "Alist containing the information taken from the macro definition lines. 1178This gets refreshed in every phrases command.") 1179(defvar reftex-index-phrases-files nil 1180 "List of document files relevant for the phrases file.") 1181 1182(defvar reftex-index-phrases-font-lock-keywords nil 1183 "Font lock keywords for reftex-index-phrases-mode.") 1184(defvar reftex-index-phrases-font-lock-defaults nil 1185 "Font lock defaults for reftex-index-phrases-mode.") 1186(defvar reftex-index-phrases-map (make-sparse-keymap) 1187 "Keymap used for *toc* buffer.") 1188 1189 1190(defun reftex-index-phrase-selection-or-word (arg) 1191 "Add current selection or word at point to the phrases buffer. 1192When you are in transient-mark-mode and the region is active, the 1193selection will be used - otherwise the word at point. 1194You get a chance to edit the entry in the phrases buffer - finish with 1195`C-c C-c'." 1196 (interactive "P") 1197 (set-marker reftex-index-return-marker (point)) 1198 (reftex-index-selection-or-word arg 'phrase) 1199 (if (eq major-mode 'reftex-index-phrases-mode) 1200 (message "%s" 1201 (substitute-command-keys 1202 "Return to LaTeX with \\[reftex-index-phrases-save-and-return]")))) 1203 1204(defun reftex-index-visit-phrases-buffer () 1205 "Switch to the phrases buffer, initialize if empty." 1206 (interactive) 1207 (reftex-access-scan-info) 1208 (let* ((master (reftex-TeX-master-file)) 1209 (name (concat (file-name-sans-extension master) 1210 reftex-index-phrase-file-extension))) 1211 (find-file name) 1212 (unless (eq major-mode 'reftex-index-phrases-mode) 1213 (reftex-index-phrases-mode)) 1214 (if (= (buffer-size) 0) 1215 (reftex-index-initialize-phrases-buffer master)))) 1216 1217(defun reftex-index-initialize-phrases-buffer (&optional master) 1218 "Initialize the phrases buffer by creating the header. 1219If the buffer is non-empty, delete the old header first." 1220 (interactive) 1221 (let* ((case-fold-search t) 1222 (default-key (car reftex-index-default-macro)) 1223 (default-macro (nth 1 (assoc default-key 1224 reftex-key-to-index-macro-alist))) 1225 (macro-alist 1226 (sort (copy-sequence reftex-index-macro-alist) 1227 (lambda (a b) (equal (car a) default-macro)))) 1228 macro entry key repeat) 1229 1230 (if master (set (make-local-variable 'TeX-master) 1231 (file-name-nondirectory master))) 1232 1233 (when (> (buffer-size) 0) 1234 (goto-char 1) 1235 (set-mark (point)) 1236 (while (re-search-forward reftex-index-phrases-macrodef-regexp nil t) 1237 (end-of-line)) 1238 (beginning-of-line 2) 1239 (if (looking-at reftex-index-phrases-comment-regexp) 1240 (beginning-of-line 2)) 1241 (while (looking-at "^[ \t]*$") 1242 (beginning-of-line 2)) 1243 (cond ((fboundp 'zmacs-activate-region) (zmacs-activate-region)) 1244 ((boundp 'make-active) (setq mark-active t))) 1245 (if (yes-or-no-p "Delete and rebuild header? ") 1246 (delete-region (point-min) (point)))) 1247 1248 ;; Insert the mode line 1249 (insert 1250 (format "%% -*- mode: reftex-index-phrases; TeX-master: \"%s\" -*-\n" 1251 (file-name-nondirectory (reftex-index-phrase-tex-master)))) 1252 ;; Insert the macro definitions 1253 (insert "% Key Macro Format Repeat\n") 1254 (insert "%---------------------------------------------------------------------\n") 1255 (while (setq entry (pop macro-alist)) 1256 (setq macro (car entry) 1257 repeat (nth 7 entry) 1258 key (car (delq nil (mapcar (lambda (x) (if (equal (nth 1 x) macro) 1259 (car x) 1260 nil)) 1261 reftex-key-to-index-macro-alist)))) 1262 (insert (format ">>>INDEX_MACRO_DEFINITION:\t%s\t%-20s\t%s\n" 1263 (char-to-string key) (concat macro "{%s}") 1264 (if repeat "t" "nil")))) 1265 (insert "%---------------------------------------------------------------------\n\n\n"))) 1266 1267(defvar TeX-master) 1268(defun reftex-index-phrase-tex-master (&optional dir) 1269 "Return the name of the master file associated with a phrase buffer." 1270 (if (and (boundp 'TeX-master) 1271 (local-variable-p 'TeX-master (current-buffer)) 1272 (stringp TeX-master)) 1273 ;; We have a local variable which tells us which file to use 1274 (expand-file-name TeX-master dir) 1275 ;; have to guess 1276 (concat (file-name-sans-extension (buffer-file-name)) ".tex"))) 1277 1278(defun reftex-index-phrases-save-and-return () 1279 "Return to where the `reftex-index-phrase-selection-or-word' was called." 1280 (interactive) 1281 (save-buffer) 1282 (switch-to-buffer (marker-buffer reftex-index-return-marker)) 1283 (goto-char (or (marker-position reftex-index-return-marker) (point)))) 1284 1285 1286(defvar reftex-index-phrases-menu) 1287(defvar reftex-index-phrases-marker) 1288(defvar reftex-index-phrases-restrict-file nil) 1289;;;###autoload 1290(defun reftex-index-phrases-mode () 1291 "Major mode for managing the Index phrases of a LaTeX document. 1292This buffer was created with RefTeX. 1293 1294To insert new phrases, use 1295 - `C-c \\' in the LaTeX document to copy selection or word 1296 - `\\[reftex-index-new-phrase]' in the phrases buffer. 1297 1298To index phrases use one of: 1299 1300\\[reftex-index-this-phrase] index current phrase 1301\\[reftex-index-next-phrase] index next phrase (or N with prefix arg) 1302\\[reftex-index-all-phrases] index all phrases 1303\\[reftex-index-remaining-phrases] index current and following phrases 1304\\[reftex-index-region-phrases] index the phrases in the region 1305 1306You can sort the phrases in this buffer with \\[reftex-index-sort-phrases]. 1307To display information about the phrase at point, use \\[reftex-index-phrases-info]. 1308 1309For more information see the RefTeX User Manual. 1310 1311Here are all local bindings. 1312 1313\\{reftex-index-phrases-map}" 1314 (interactive) 1315 (kill-all-local-variables) 1316 (setq major-mode 'reftex-index-phrases-mode 1317 mode-name "Phrases") 1318 (use-local-map reftex-index-phrases-map) 1319 (set (make-local-variable 'font-lock-defaults) 1320 reftex-index-phrases-font-lock-defaults) 1321 (easy-menu-add reftex-index-phrases-menu reftex-index-phrases-map) 1322 (set (make-local-variable 'reftex-index-phrases-marker) (make-marker)) 1323 (run-hooks 'reftex-index-phrases-mode-hook)) 1324(add-hook 'reftex-index-phrases-mode-hook 'turn-on-font-lock) 1325 1326;; Font Locking stuff 1327(let ((ss (if (featurep 'xemacs) 'secondary-selection ''secondary-selection))) 1328 (setq reftex-index-phrases-font-lock-keywords 1329 (list 1330 (cons reftex-index-phrases-comment-regexp 'font-lock-comment-face) 1331 (list reftex-index-phrases-macrodef-regexp 1332 '(1 font-lock-type-face) 1333 '(2 font-lock-keyword-face) 1334 (list 3 ss) 1335 '(4 font-lock-function-name-face) 1336 (list 5 ss) 1337 '(6 font-lock-string-face)) 1338 (list reftex-index-phrases-phrase-regexp1 1339 '(1 font-lock-keyword-face) 1340 (list 2 ss) 1341 '(3 font-lock-string-face) 1342 (list 4 ss)) 1343 (list reftex-index-phrases-phrase-regexp2 1344 '(1 font-lock-keyword-face) 1345 (list 2 ss) 1346 '(3 font-lock-string-face) 1347 (list 4 ss) 1348 '(5 font-lock-function-name-face)) 1349 (cons "^\t$" ss))) 1350 (setq reftex-index-phrases-font-lock-defaults 1351 '((reftex-index-phrases-font-lock-keywords) 1352 nil t nil beginning-of-line)) 1353 (put 'reftex-index-phrases-mode 'font-lock-defaults 1354 reftex-index-phrases-font-lock-defaults) ; XEmacs 1355 ) 1356 1357(defun reftex-index-next-phrase (&optional arg) 1358 "Index the next ARG phrases in the phrases buffer." 1359 (interactive "p") 1360 (reftex-index-phrases-parse-header t) 1361 (while (> arg 0) 1362 (decf arg) 1363 (end-of-line) 1364 (if (re-search-forward reftex-index-phrases-phrase-regexp12 nil t) 1365 (progn 1366 (goto-char (match-beginning 0)) 1367 (reftex-index-this-phrase 'slave)) 1368 (error "No more phrase lines after point")))) 1369 1370(defun reftex-index-this-phrase (&optional slave) 1371 "Index the phrase in the current line. 1372Does a global search and replace in the entire document. At each 1373match, the user will be asked to confirm the replacement." 1374 (interactive) 1375 (if (not slave) (reftex-index-phrases-parse-header t)) 1376 (save-excursion 1377 (beginning-of-line) 1378 (cond ((looking-at reftex-index-phrases-comment-regexp) 1379 (if (not slave) (error "Comment line"))) 1380 ((looking-at "^[ \t]*$") 1381 (if (not slave) (error "Empty line"))) 1382 ((looking-at reftex-index-phrases-macrodef-regexp) 1383 (if (not slave) (error "Macro definition line"))) 1384 ((looking-at reftex-index-phrases-phrase-regexp12) 1385 ;; This is a phrase 1386 (let* ((char (if (not (equal (match-string 1) "")) 1387 (string-to-char (match-string 1)))) 1388 (phrase (match-string 3)) 1389 (index-key (match-string 6)) 1390 (macro-data (cdr (if (null char) 1391 (car reftex-index-phrases-macro-data) 1392 (assoc char reftex-index-phrases-macro-data)))) 1393 (macro-fmt (car macro-data)) 1394 (repeat (nth 1 macro-data)) 1395 (files 1396 (cond ((and (stringp reftex-index-phrases-restrict-file) 1397 (file-regular-p reftex-index-phrases-restrict-file)) 1398 (list reftex-index-phrases-restrict-file)) 1399 ((stringp reftex-index-phrases-restrict-file) 1400 (error "Invalid restriction file %s" 1401 reftex-index-phrases-restrict-file)) 1402 (t reftex-index-phrases-files))) 1403 (as-words reftex-index-phrases-search-whole-words)) 1404 (unless macro-data 1405 (error "No macro associated with key %c" char)) 1406 (unwind-protect 1407 (let ((overlay-arrow-string "=>") 1408 (overlay-arrow-position 1409 reftex-index-phrases-marker) 1410 (replace-count 0)) 1411 ;; Show the overlay arrow 1412 (move-marker reftex-index-phrases-marker 1413 (match-beginning 0) (current-buffer)) 1414 ;; Start the query-replace 1415 (reftex-query-index-phrase-globally 1416 files phrase macro-fmt 1417 index-key repeat as-words) 1418 (message "%s replaced" 1419 (reftex-number replace-count "occurrence")))))) 1420 (t (error "Cannot parse this line"))))) 1421 1422(defun reftex-index-all-phrases () 1423 "Index all phrases in the phrases buffer. 1424Calls `reftex-index-this-phrase' on each line in the buffer." 1425 (interactive) 1426 (reftex-index-region-phrases (point-min) (point-max))) 1427 1428(defun reftex-index-remaining-phrases () 1429 "Index all phrases in the phrases buffer. 1430Calls `reftex-index-this-phrase' on each line ay and below point in 1431the buffer." 1432 (interactive) 1433 (beginning-of-line) 1434 (reftex-index-region-phrases (point) (point-max))) 1435 1436(defun reftex-index-region-phrases (beg end) 1437 "Index all phrases in the phrases buffer. 1438Calls `reftex-index-this-phrase' on each line in the region." 1439 (interactive "r") 1440 (reftex-index-phrases-parse-header t) 1441 (goto-char beg) 1442 (while (not (or (eobp) 1443 (>= (point) end))) 1444 (save-excursion (reftex-index-this-phrase 'slave)) 1445 (beginning-of-line 2))) 1446 1447(defun reftex-index-phrases-parse-header (&optional get-files) 1448 "Parse the header of a phrases file to extract the macro definitions. 1449The definitions get stored in `reftex-index-phrases-macro-data'. 1450Also switches to the LaTeX document to find out which files belong to 1451the document and stores the list in `reftex-index-phrases-files'." 1452 (let* ((master (reftex-index-phrase-tex-master)) 1453 buf) 1454 (if get-files 1455 ;; Get the file list 1456 (save-excursion 1457 (setq buf (reftex-get-file-buffer-force master)) 1458 (unless buf (error "Master file %s not found" master)) 1459 (set-buffer buf) 1460 (reftex-access-scan-info) 1461 (setq reftex-index-phrases-files 1462 (reftex-all-document-files)))) 1463 ;; Parse the files header for macro definitions 1464 (setq reftex-index-phrases-macro-data nil) 1465 (save-excursion 1466 (goto-char (point-min)) 1467 (while (re-search-forward reftex-index-phrases-macrodef-regexp nil t) 1468 (push (list 1469 (string-to-char (match-string 2)) 1470 (match-string 4) 1471 (equal (match-string 6) "t")) 1472 reftex-index-phrases-macro-data)) 1473 ;; Reverse the list, so that the first macro is first 1474 (if (null reftex-index-phrases-macro-data) 1475 (error "No valid MACRO DEFINITION line in %s file (make sure to use TAB separators)" reftex-index-phrase-file-extension)) 1476 (setq reftex-index-phrases-macro-data 1477 (nreverse reftex-index-phrases-macro-data)) 1478 (goto-char (point-min))))) 1479 1480(defun reftex-index-phrases-apply-to-region (beg end) 1481 "Index all index phrases in the current region. 1482This works exactly like global indexing from the index phrases buffer, 1483but operation is restricted to the current region. This is useful if 1484you need to add/change text in an already indexed document and want to 1485index the new part without having to go over the unchanged parts again." 1486 (interactive "r") 1487 (let ((win-conf (current-window-configuration)) 1488 (reftex-index-phrases-restrict-file (buffer-file-name))) 1489 (save-excursion 1490 (save-restriction 1491 (narrow-to-region beg end) 1492 (unwind-protect 1493 (progn 1494 ;; Hide the region highlighting 1495 (cond ((fboundp 'zmacs-deactivate-region) (zmacs-deactivate-region)) 1496 ((fboundp 'deactivate-mark) (deactivate-mark))) 1497 (delete-other-windows) 1498 (reftex-index-visit-phrases-buffer) 1499 (reftex-index-all-phrases)) 1500 (set-window-configuration win-conf)))))) 1501 1502(defun reftex-index-new-phrase (&optional text) 1503 "Open a new line in the phrases buffer, insert TEXT." 1504 (interactive) 1505 (if (and text (stringp text)) 1506 (progn 1507 ;; Check if the phrase is already in the buffer 1508 (setq text (reftex-index-simplify-phrase text)) 1509 (goto-char (point-min)) 1510 (if (re-search-forward 1511 (concat "^\\(\\S-*\\)\t\\(" (regexp-quote text) 1512 "\\) *[\t\n]") nil t) 1513 (progn 1514 (goto-char (match-end 2)) 1515 (error "Phrase is already in phrases buffer"))))) 1516 ;; Add the new phrase line after the last in the buffer 1517 (goto-char (point-max)) 1518 (if (re-search-backward reftex-index-phrases-phrase-regexp12 nil t) 1519 (end-of-line)) 1520 (if (not (bolp)) 1521 (insert "\n")) 1522 (insert "\t") 1523 (if (and text (stringp text)) 1524 (insert text))) 1525 1526(defun reftex-index-find-next-conflict-phrase (&optional arg) 1527 "Find the next a phrase which is has conflicts in the phrase buffer. 1528The command helps to find possible conflicts in the phrase indexing process. 1529It searches downward from point for a phrase which is repeated elsewhere 1530in the buffer, or which is a subphrase of another phrase. If such a 1531phrase is found, the phrase info is displayed. 1532To check the whole buffer, start at the beginning and continue by calling 1533this function repeatedly." 1534 (interactive "P") 1535 (if (catch 'exit 1536 (while (re-search-forward reftex-index-phrases-phrase-regexp12 nil t) 1537 (goto-char (match-beginning 3)) 1538 (let* ((phrase (match-string 3)) 1539 (case-fold-search reftex-index-phrases-case-fold-search) 1540 (re (reftex-index-phrases-find-dup-re phrase t))) 1541 (if (save-excursion 1542 (goto-char (point-min)) 1543 (and (re-search-forward re nil t) 1544 (re-search-forward re nil t))) 1545 (throw 'exit t))))) 1546 (progn 1547 (reftex-index-phrases-info) 1548 (message "Phrase with match conflict discovered")) 1549 (goto-char (point-max)) 1550 (error "No further problematic phrases found"))) 1551 1552(defun reftex-index-phrases-info () 1553 "Display information about the phrase at point." 1554 (interactive) 1555 (save-excursion 1556 (beginning-of-line) 1557 (unless (looking-at reftex-index-phrases-phrase-regexp12) 1558 (error "Not a phrase line")) 1559 (save-match-data (reftex-index-phrases-parse-header t)) 1560 (let* ((char (if (not (equal (match-string 1) "")) 1561 (string-to-char (match-string 1)))) 1562 (phrase (match-string 3)) 1563 (index-key (match-string 6)) 1564 (index-keys (split-string 1565 (or index-key phrase) 1566 reftex-index-phrases-logical-or-regexp)) 1567 (macro-data (cdr (if (null char) 1568 (car reftex-index-phrases-macro-data) 1569 (assoc char reftex-index-phrases-macro-data)))) 1570 (macro-fmt (car macro-data)) 1571 (repeat (nth 1 macro-data)) 1572 (as-words reftex-index-phrases-search-whole-words) 1573 (example (reftex-index-make-replace-string 1574 macro-fmt (downcase phrase) (car index-keys) repeat)) 1575 (re (reftex-index-make-phrase-regexp phrase as-words t)) 1576 (re1 (reftex-index-phrases-find-dup-re phrase)) 1577 (re2 (reftex-index-phrases-find-dup-re phrase 'sub)) 1578 superphrases 1579 (nmatches 0) 1580 (ntimes1 0) 1581 (ntimes2 0) 1582 (case-fold-search reftex-index-phrases-case-fold-search) 1583 file files buf) 1584 (setq files reftex-index-phrases-files) 1585 (save-excursion 1586 (save-restriction 1587 (widen) 1588 (goto-char (point-min)) 1589 (while (re-search-forward re1 nil t) 1590 (incf ntimes1)) 1591 (goto-char (point-min)) 1592 (while (re-search-forward re2 nil t) 1593 (push (cons (count-lines 1 (point)) (match-string 1)) superphrases) 1594 (incf ntimes2)))) 1595 (save-excursion 1596 (while (setq file (pop files)) 1597 (setq buf (reftex-get-file-buffer-force file)) 1598 (when buf 1599 (set-buffer buf) 1600 (save-excursion 1601 (save-restriction 1602 (widen) 1603 (goto-char (point-min)) 1604 (let ((case-fold-search reftex-index-phrases-case-fold-search)) 1605 (while (re-search-forward re nil t) 1606 (or (reftex-in-comment) 1607 (incf nmatches))))))))) 1608 (with-output-to-temp-buffer "*Help*" 1609 (princ (format " Phrase: %s\n" phrase)) 1610 (princ (format " Macro key: %s\n" char)) 1611 (princ (format " Macro format: %s\n" macro-fmt)) 1612 (princ (format " Repeat: %s\n" repeat)) 1613 (cond 1614 (index-key 1615 (let ((iks index-keys) (cnt 0) ik) 1616 (while (setq ik (pop iks)) 1617 (princ (format "Index entry %d: %s\n" (incf cnt) ik))))) 1618 (repeat 1619 (princ (format " Index entry: %s\n" phrase))) 1620 (t 1621 (princ (format " Index key: <<Given by the match>>\n")))) 1622 (princ (format " Example: %s\n" example)) 1623 (terpri) 1624 (princ (format "Total matches: %s in %s\n" 1625 (reftex-number nmatches "match" "es") 1626 (reftex-number (length reftex-index-phrases-files) 1627 "LaTeX file"))) 1628 (princ (format " Uniqueness: Phrase occurs %s in phrase buffer\n" 1629 (reftex-number ntimes1 "time"))) 1630 (if (> ntimes2 1) 1631 (progn 1632 (princ (format " Superphrases: Phrase matches the following %s in the phrase buffer:\n" 1633 (reftex-number ntimes2 "line"))) 1634 (mapcar (lambda(x) 1635 (princ (format " Line %4d: %s\n" (car x) (cdr x)))) 1636 (nreverse superphrases)))))))) 1637 1638(defun reftex-index-phrases-set-macro-key () 1639 "Change the macro key for the current line. 1640Prompts for a macro key and insert is at the beginning of the line. 1641If you reply with SPACE, the macro keyn will be removed, so that the 1642default macro will be used. If you reply with `RET', just prints 1643information about the currently selected macro." 1644 (interactive) 1645 (reftex-index-phrases-parse-header) 1646 (save-excursion 1647 (beginning-of-line) 1648 (unless (or (looking-at reftex-index-phrases-phrase-regexp12) 1649 (looking-at "\t")) 1650 (error "This is not a phrase line")) 1651 (let* ((nc (reftex-index-select-phrases-macro 0)) 1652 (macro-data (assoc nc reftex-index-phrases-macro-data)) 1653 macro-fmt repeat) 1654 (cond (macro-data) 1655 ((equal nc ?\ ) 1656 (setq nc "" 1657 macro-data (car reftex-index-phrases-macro-data))) 1658 ((equal nc ?\C-m) 1659 (setq nc (char-after (point))) 1660 (if (equal nc ?\t) 1661 (setq nc "" 1662 macro-data (car reftex-index-phrases-macro-data)) 1663 (setq macro-data (assoc nc reftex-index-phrases-macro-data)))) 1664 (t (error "No macro associated with %c" nc))) 1665 1666 (setq macro-fmt (nth 1 macro-data) 1667 repeat (nth 2 macro-data)) 1668 (if macro-data 1669 (progn 1670 (if (looking-at "[^\t]") (delete-char 1)) 1671 (insert nc) 1672 (message "Line will use %s %s repeat" macro-fmt 1673 (if repeat "with" "without"))) 1674 (error "Abort"))))) 1675 1676(defun reftex-index-sort-phrases (&optional chars-first) 1677 "Sort the phrases lines in the buffer alphabetically. 1678Normally, this looks only at the phrases. With a prefix arg CHARS-FIRST, 1679it first compares the macro identifying chars and then the phrases." 1680 (interactive "P") 1681 ;; Remember the current line, so that we can return 1682 (let ((line (buffer-substring (progn (beginning-of-line) (point)) 1683 (progn (end-of-line) (point)))) 1684 beg end) 1685 (goto-char (point-min)) 1686 ;; Find first and last phrase line in buffer 1687 (setq beg 1688 (and (re-search-forward reftex-index-phrases-phrase-regexp12 nil t) 1689 (match-beginning 0))) 1690 (goto-char (point-max)) 1691 (setq end (re-search-backward reftex-index-phrases-phrase-regexp12 nil t)) 1692 (if end (setq end (progn (goto-char end) (end-of-line) (point)))) 1693 ;; Take the lines, sort them and re-insert. 1694 (if (and beg end) 1695 (progn 1696 (message "Sorting lines...") 1697 (let* ((lines (split-string (buffer-substring beg end) "\n")) 1698 (lines1 (sort lines 'reftex-compare-phrase-lines))) 1699 (message "Sorting lines...done") 1700 (let ((inhibit-quit t)) ;; make sure we do not loose lines 1701 (delete-region beg end) 1702 (insert (mapconcat 'identity lines1 "\n")))) 1703 (goto-char (point-max)) 1704 (re-search-backward (concat "^" (regexp-quote line) "$") nil t)) 1705 (error "Cannot find phrases lines to sort")))) 1706 1707(defvar chars-first) 1708(defun reftex-compare-phrase-lines (a b) 1709 "The comparison function used for sorting." 1710 (let (ca cb pa pb c-p p-p) 1711 (if (string-match reftex-index-phrases-phrase-regexp12 a) 1712 (progn 1713 ;; Extract macro char and phrase-or-key for a 1714 (setq ca (match-string 1 a) 1715 pa (downcase 1716 (or (and reftex-index-phrases-sort-prefers-entry 1717 (match-string 6 a)) 1718 (match-string 3 a)))) 1719 (if (string-match reftex-index-phrases-phrase-regexp12 b) 1720 (progn 1721 ;; Extract macro char and phrase-or-key for b 1722 (setq cb (match-string 1 b) 1723 pb (downcase 1724 (or (and reftex-index-phrases-sort-prefers-entry 1725 (match-string 6 b)) 1726 (match-string 3 b)))) 1727 (setq c-p (string< ca cb) 1728 p-p (string< pa pb)) 1729 ;; Do the right comparison, based on the value of `chars-first' 1730 ;; `chars-first' is bound locally in the calling function 1731 (if chars-first 1732 (if (string= ca cb) p-p c-p) 1733 (if (string= pa pb) c-p p-p))))) 1734 ;; If line a does not match, the answer we return determines 1735 ;; if non-matching lines are collected at the beginning. 1736 ;; When we return t here, non-matching lines form 1737 ;; block separators for searches. 1738 (not reftex-index-phrases-sort-in-blocks)))) 1739 1740(defvar reftex-index-phrases-menu) 1741(defun reftex-index-make-phrase-regexp (phrase &optional 1742 as-words allow-newline) 1743 "Return a regexp matching PHRASE, even if distributed over lines. 1744With optional arg AS-WORDS, require word boundary at beginning and end. 1745With optional arg ALLOW-NEWLINE, allow single newline between words." 1746 (let* ((words (split-string phrase)) 1747 (space-re (if allow-newline 1748 "\\([ \t]*\\(\n[ \t]*\\)?\\|[ \t]\\)" 1749 "\\([ \t]+\\)"))) 1750 (concat (if (and as-words (string-match "\\`\\w" (car words))) 1751 "\\(\\<\\|[`']\\)" "") 1752 (mapconcat (lambda (w) (regexp-quote 1753 (if reftex-index-phrases-case-fold-search 1754 (downcase w) 1755 w))) 1756 words space-re) 1757 (if (and as-words 1758 (string-match "\\w\\'" (nth (1- (length words)) words))) 1759 "\\(\\>\\|'\\)" "")))) 1760 1761(defun reftex-index-simplify-phrase (phrase) 1762 "Make phrase single spaces and single line." 1763 (mapconcat 'identity (split-string phrase) " ")) 1764 1765(defun reftex-index-phrases-find-dup-re (phrase &optional sub) 1766 "Return a regexp which matches variations of PHRASE (with additional space). 1767When SUB ins non-nil, the regexp will also match when PHRASE is a subphrase 1768of another phrase. The regexp works lonly in the phrase buffer." 1769 (concat (if sub "^\\S-?\t\\([^\t\n]*" "^\\S-?\t") 1770 (mapconcat 'regexp-quote (split-string phrase) " +") 1771 (if sub "[^\t\n]*\\)\\([\t\n]\\|$\\)" " *\\([\t\n]\\|$\\)"))) 1772 1773(defun reftex-index-make-replace-string (macro-fmt match index-key 1774 &optional repeat mathp) 1775 "Return the string which can be used as replacement. 1776Treats the logical `and' for index phrases." 1777 (let ((index-keys (split-string (or index-key match) 1778 reftex-index-phrases-logical-and-regexp))) 1779 (concat 1780 (mapconcat (lambda (x) 1781 (format macro-fmt 1782 (format (if mathp reftex-index-math-format "%s") x))) 1783 index-keys "") 1784 (if repeat (reftex-index-simplify-phrase match) "")))) 1785 1786(defun reftex-query-index-phrase-globally (files &rest args) 1787 "Call `reftex-query-index-phrase' for all files in FILES." 1788 (let ((win-conf (current-window-configuration)) 1789 (file)) 1790 (unless files (error "No files")) 1791 (unwind-protect 1792 (progn 1793 (switch-to-buffer-other-window (reftex-get-file-buffer-force 1794 (car files))) 1795 (catch 'no-more-files 1796 (while (setq file (pop files)) 1797 (switch-to-buffer (reftex-get-file-buffer-force file)) 1798 (save-excursion 1799 (save-restriction 1800 (unless (stringp reftex-index-phrases-restrict-file) 1801 (widen)) 1802 (goto-char (point-min)) 1803 (apply 'reftex-query-index-phrase args)))))) 1804 (reftex-unhighlight 0) 1805 (set-window-configuration win-conf)))) 1806 1807(defconst reftex-index-phrases-help 1808 " Keys for query-index search 1809 =========================== 1810y Replace this match 1811n Skip this match 1812! Replace this and all further matches in this file 1813q / Q Skip match, start next file / start next phrase 1814o Use a different indexing macro for this match 18151 - 9 Select one of the multiple phrases 1816e Edit the replacement text 1817C-r Recursive edit. 1818s / S Save this buffer / Save all document buffers 1819C-g Abort" 1820 "The help string for indexing phrases.") 1821 1822(defvar replace-count) 1823(defun reftex-query-index-phrase (phrase macro-fmt &optional 1824 index-key repeat as-words) 1825 "Search through buffer for PHRASE, and offer to replace it with an indexed 1826version. The index version is derived by applying `format' with MACRO-FMT 1827to INDEX-KEY or PHRASE. When REPEAT is non-nil, the PHRASE is inserted 1828again after the macro. 1829AS-WORDS means, the search for PHRASE should require word boundaries at 1830both ends." 1831 (let* ((re (reftex-index-make-phrase-regexp phrase as-words 'allow-newline)) 1832 (case-fold-search reftex-index-phrases-case-fold-search) 1833 (index-keys (split-string 1834 (or index-key phrase) 1835 reftex-index-phrases-logical-or-regexp)) 1836 (nkeys (length index-keys)) 1837 (ckey (nth 0 index-keys)) 1838 (all-yes nil) 1839 match rpl char (beg (make-marker)) (end (make-marker)) mathp) 1840 (move-marker beg 1) 1841 (move-marker end 1) 1842 (unwind-protect 1843 (while (re-search-forward re nil t) 1844 (catch 'next-match 1845 (if (reftex-in-comment) 1846 (throw 'next-match nil)) 1847 (if (and (fboundp reftex-index-verify-function) 1848 (not (funcall reftex-index-verify-function))) 1849 (throw 'next-match nil)) 1850 (setq match (match-string 0)) 1851 (setq mathp 1852 (save-match-data 1853 (condition-case nil (texmathp) (error nil)))) 1854 (setq beg (move-marker beg (match-beginning 0)) 1855 end (move-marker end (match-end 0))) 1856 (if (and reftex-index-phrases-skip-indexed-matches 1857 (save-match-data 1858 (reftex-index-phrase-match-is-indexed beg 1859 end))) 1860 (throw 'next-match nil)) 1861 (reftex-highlight 0 (match-beginning 0) (match-end 0)) 1862 (setq rpl 1863 (save-match-data 1864 (reftex-index-make-replace-string 1865 macro-fmt (match-string 0) ckey repeat mathp))) 1866 (while 1867 (not 1868 (catch 'loop 1869 (message "REPLACE: %s? (yn!qoe%s?)" 1870 rpl 1871 (if (> nkeys 1) 1872 (concat "1-" (int-to-string nkeys)) 1873 "")) 1874 (setq char (if all-yes ?y (read-char-exclusive))) 1875 (cond ((member char '(?y ?Y ?\ )) 1876 ;; Yes! 1877 (replace-match rpl t t) 1878 (incf replace-count) 1879 ;; See if we should insert newlines to shorten lines 1880 (and reftex-index-phrases-wrap-long-lines 1881 (reftex-index-phrases-fixup-line beg end)) 1882 (throw 'loop t)) 1883 ((member char '(?n ?N ?\C-h ?\C-?));; FIXME: DEL 1884 ;; No 1885 (throw 'loop t)) 1886 ((equal char ?!) 1887 ;; Yes for all in this buffer 1888 (setq all-yes t)) 1889 ((equal char ?q) 1890 ;; Stop this one in this file 1891 (goto-char (point-max)) 1892 (throw 'loop t)) 1893 ((equal char ?Q) 1894 ;; Stop this one 1895 (throw 'no-more-files t)) 1896 ((equal char ?s) 1897 (save-buffer)) 1898 ((equal char ?S) 1899 (reftex-save-all-document-buffers)) 1900 ((equal char ?\C-g) 1901 (keyboard-quit)) 1902 ((member char '(?o ?O)) 1903 ;; Select a differnt macro 1904 (let* ((nc (reftex-index-select-phrases-macro 2)) 1905 (macro-data 1906 (cdr (assoc nc reftex-index-phrases-macro-data))) 1907 (macro-fmt (car macro-data)) 1908 (repeat (nth 1 macro-data))) 1909 (if macro-data 1910 (setq rpl (save-match-data 1911 (reftex-index-make-replace-string 1912 macro-fmt match 1913 ckey repeat mathp))) 1914 (ding)))) 1915 ((equal char ?\?) 1916 ;; Help 1917 (with-output-to-temp-buffer "*Help*" 1918 (princ reftex-index-phrases-help))) 1919 ((equal char ?\C-r) 1920 ;; Recursive edit 1921 (save-match-data 1922 (save-excursion 1923 (message "%s" 1924 (substitute-command-keys 1925 "Recursive edit. Resume with \\[exit-recursive-edit]")) 1926 (recursive-edit)))) 1927 ((equal char ?e) 1928 (setq rpl (read-string "Edit: " rpl))) 1929 ((equal char ?0) 1930 (setq ckey (or index-key phrase) 1931 rpl (save-match-data 1932 (reftex-index-make-replace-string 1933 macro-fmt match ckey repeat mathp)))) 1934 ((and (> char ?0) 1935 (<= char (+ ?0 nkeys))) 1936 (setq ckey (nth (1- (- char ?0)) index-keys) 1937 rpl (save-match-data 1938 (reftex-index-make-replace-string 1939 macro-fmt match ckey repeat mathp)))) 1940 (t (ding))) 1941 nil))))) 1942 (message "") 1943 (move-marker beg nil) 1944 (move-marker end nil) 1945 (setq all-yes nil) 1946 (reftex-unhighlight 0)))) 1947 1948(defun reftex-index-phrase-match-is-indexed (beg end) 1949 ;; Check if match is in an argument of an index macro, or if an 1950 ;; index macro is directly attached to the match. 1951 (save-excursion 1952 (goto-char end) 1953 (let* ((all-macros (reftex-what-macro t)) 1954; (this-macro (car (car all-macros))) 1955 (before-macro 1956 (and (> beg 2) 1957 (goto-char (1- beg)) 1958 (memq (char-after (point)) '(?\] ?\})) 1959 (car (reftex-what-macro 1)))) 1960 (after-macro 1961 (and (goto-char end) 1962 (looking-at "\\(\\\\[a-zA-Z]+\\*?\\)[[{]") 1963 (match-string 1))) 1964 macro) 1965 (or (catch 'matched 1966 (while (setq macro (pop all-macros)) 1967 (if (member (car macro) reftex-macros-with-index) 1968 (throw 'matched t))) 1969 nil) 1970 (and before-macro 1971 (member before-macro reftex-macros-with-index)) 1972 (and after-macro 1973 (member after-macro reftex-macros-with-index)))))) 1974 1975(defun reftex-index-phrases-fixup-line (beg end) 1976 "Insert newlines before BEG and/or after END to shorten line." 1977 (let (bol eol space1 space2) 1978 (save-excursion 1979 ;; Find line boundaries and possible line breaks near BEG and END 1980 (beginning-of-line) 1981 (setq bol (point)) 1982 (end-of-line) 1983 (setq eol (point)) 1984 (goto-char beg) 1985 (skip-chars-backward "^ \n") 1986 (if (and (equal (preceding-char) ?\ ) 1987 (string-match "\\S-" (buffer-substring bol (point)))) 1988 (setq space1 (1- (point)))) 1989 (goto-char end) 1990 (skip-chars-forward "^ \n") 1991 (if (and (equal (following-char) ?\ ) 1992 (string-match "\\S-" (buffer-substring (point) eol))) 1993 (setq space2 (point))) 1994 ;; Now check what we have and insert the newlines 1995 (if (<= (- eol bol) fill-column) 1996 ;; Line is already short 1997 nil 1998 (cond 1999 ((and (not space1) (not space2))) ; No spaces available 2000 ((not space2) ; Do space1 2001 (reftex-index-phrases-replace-space space1)) 2002 ((not space1) ; Do space2 2003 (reftex-index-phrases-replace-space space2)) 2004 (t ; We have both spaces 2005 (let ((l1 (- space1 bol)) 2006 (l2 (- space2 space1)) 2007 (l3 (- eol space2))) 2008 (if (> l2 fill-column) 2009 ;; The central part alone is more than one line 2010 (progn 2011 (reftex-index-phrases-replace-space space1) 2012 (reftex-index-phrases-replace-space space2)) 2013 (if (> (+ l1 l2) fill-column) 2014 ;; Need to split beginning 2015 (reftex-index-phrases-replace-space space1)) 2016 (if (> (+ l2 l3) fill-column) 2017 ;; Need to split end 2018 (reftex-index-phrases-replace-space space2)))))))))) 2019 2020(defun reftex-index-phrases-replace-space (pos) 2021 "If there is a space at POS, replace it with a newline char. 2022Does not do a save-excursion." 2023 (when (equal (char-after pos) ?\ ) 2024 (goto-char pos) 2025 (delete-char 1) 2026 (insert "\n"))) 2027 2028(defun reftex-index-select-phrases-macro (&optional delay) 2029 "Offer a list of possible index macros and have the user select one." 2030 (let* ((prompt (concat "Select macro: [" 2031 (mapconcat (lambda (x) (char-to-string (car x))) 2032 reftex-index-phrases-macro-data "") 2033 "] ")) 2034 (help (concat "Select an indexing macro\n========================\n" 2035 (mapconcat (lambda (x) 2036 (format " [%c] %s" 2037 (car x) (nth 1 x))) 2038 reftex-index-phrases-macro-data "\n")))) 2039 (reftex-select-with-char prompt help delay))) 2040 2041;; Keybindings and Menu for phrases buffer 2042 2043(loop for x in 2044 '(("\C-c\C-c" . reftex-index-phrases-save-and-return) 2045 ("\C-c\C-x" . reftex-index-this-phrase) 2046 ("\C-c\C-f" . reftex-index-next-phrase) 2047 ("\C-c\C-r" . reftex-index-region-phrases) 2048 ("\C-c\C-a" . reftex-index-all-phrases) 2049 ("\C-c\C-d" . reftex-index-remaining-phrases) 2050 ("\C-c\C-s" . reftex-index-sort-phrases) 2051 ("\C-c\C-n" . reftex-index-new-phrase) 2052 ("\C-c\C-m" . reftex-index-phrases-set-macro-key) 2053 ("\C-c\C-i" . reftex-index-phrases-info) 2054 ("\C-c\C-t" . reftex-index-find-next-conflict-phrase) 2055 ("\C-i" . self-insert-command)) 2056 do (define-key reftex-index-phrases-map (car x) (cdr x))) 2057 2058(easy-menu-define 2059 reftex-index-phrases-menu reftex-index-phrases-map 2060 "Menu for Phrases buffer" 2061 '("Phrases" 2062 ["New Phrase" reftex-index-new-phrase t] 2063 ["Set Phrase Macro" reftex-index-phrases-set-macro-key t] 2064 ["Recreate File Header" reftex-index-initialize-phrases-buffer t] 2065 "--" 2066 ("Sort Phrases" 2067 ["Sort" reftex-index-sort-phrases t] 2068 "--" 2069 "Sort Options" 2070 ["by Search Phrase" (setq reftex-index-phrases-sort-prefers-entry nil) 2071 :style radio :selected (not reftex-index-phrases-sort-prefers-entry)] 2072 ["by Index Entry" (setq reftex-index-phrases-sort-prefers-entry t) 2073 :style radio :selected reftex-index-phrases-sort-prefers-entry] 2074 ["in Blocks" (setq reftex-index-phrases-sort-in-blocks 2075 (not reftex-index-phrases-sort-in-blocks)) 2076 :style toggle :selected reftex-index-phrases-sort-in-blocks]) 2077 ["Describe Phrase" reftex-index-phrases-info t] 2078 ["Next Phrase Conflict" reftex-index-find-next-conflict-phrase t] 2079 "--" 2080 ("Find and Index in Document" 2081 ["Current Phrase" reftex-index-this-phrase t] 2082 ["Next Phrase" reftex-index-next-phrase t] 2083 ["Current and Following" reftex-index-remaining-phrases t] 2084 ["Region Phrases" reftex-index-region-phrases t] 2085 ["All Phrases" reftex-index-all-phrases t] 2086 "--" 2087 "Options" 2088 ["Match Whole Words" (setq reftex-index-phrases-search-whole-words 2089 (not reftex-index-phrases-search-whole-words)) 2090 :style toggle :selected reftex-index-phrases-search-whole-words] 2091 ["Case Sensitive Search" (setq reftex-index-phrases-case-fold-search 2092 (not reftex-index-phrases-case-fold-search)) 2093 :style toggle :selected (not 2094 reftex-index-phrases-case-fold-search)] 2095 ["Wrap Long Lines" (setq reftex-index-phrases-wrap-long-lines 2096 (not reftex-index-phrases-wrap-long-lines)) 2097 :style toggle :selected reftex-index-phrases-wrap-long-lines] 2098 ["Skip Indexed Matches" (setq reftex-index-phrases-skip-indexed-matches 2099 (not reftex-index-phrases-skip-indexed-matches)) 2100 :style toggle :selected reftex-index-phrases-skip-indexed-matches]) 2101 "--" 2102 ["Save and Return" reftex-index-phrases-save-and-return t])) 2103 2104 2105;;; arch-tag: 4b2362af-c156-42c1-8932-ea2823e205c1 2106;;; reftex-index.el ends here 2107