1 ;;; reftex-index.el --- index support with RefTeX
2 ;; Copyright (c) 1997, 1998, 1999, 2000, 2003, 2004, 2005
3 ;; Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <dominik@science.uva.nl>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval-when-compile (require 'cl))
30 (provide 'reftex-index)
34 ;; START remove for XEmacs release
36 (defvar zmacs-regions)
37 (defvar transient-mark-mode)
38 ;; END remove for XEmacs release
39 (defun reftex-index-selection-or-word (&optional arg phrase)
40 "Put selection or the word near point into the default index macro.
41 This uses the information in `reftex-index-default-macro' to make an index
42 entry. The phrase indexed is the current selection or the word near point.
43 When called with one `C-u' prefix, let the user have a chance to edit the
44 index entry. When called with 2 `C-u' as prefix, also ask for the index
45 macro and other stuff.
46 When called inside TeX math mode as determined by the `texmathp.el' library
47 which is part of AUCTeX, the string is first processed with the
48 `reftex-index-math-format', which see."
50 (let* ((use-default (not (equal arg '(16)))) ; check for double prefix
51 ;; check if we have an active selection
52 (active (if (boundp 'zmacs-regions)
53 (and zmacs-regions (region-exists-p)) ; XEmacs
54 (and transient-mark-mode mark-active))) ; Emacs
58 (skip-syntax-backward "w\\") (point))))
62 (skip-syntax-forward "w\\") (point))))
63 (sel (buffer-substring beg end))
64 (mathp (condition-case nil (texmathp) (error nil)))
65 (current-prefix-arg nil) ; we want to call reftex-index without prefix.
66 key def-char def-tag full-entry)
70 (reftex-index-visit-phrases-buffer)
71 (reftex-index-new-phrase sel))
74 ;; Nothing selected, no word, so use full reftex-index command
76 ;; OK, we have something to index here.
77 ;; Add the dollars when necessary
79 (format reftex-index-math-format sel)
81 ;; Get info from `reftex-index-default-macro'
82 (setq def-char (if use-default (car reftex-index-default-macro)))
83 (setq def-tag (if use-default (nth 1 reftex-index-default-macro)))
84 ;; Does the user want to edit the entry?
85 (setq full-entry (if arg
86 (reftex-index-complete-key
87 def-tag nil (cons key 0))
89 ;; Delete what is in the buffer and make the index entry
90 (delete-region beg end)
91 (reftex-index def-char full-entry def-tag sel)))))
93 (defun reftex-index (&optional char key tag sel no-insert)
94 "Query for an index macro and insert it along with its argments.
95 The index macros available are those defined in `reftex-index-macro' or
96 by a call to `reftex-add-index-macros', typically from an AUCTeX style file.
97 RefteX provides completion for the index tag and the index key, and
98 will prompt for other arguments."
102 ;; Ensure access to scanning info
103 (reftex-ensure-index-support t)
104 (reftex-access-scan-info current-prefix-arg)
106 ;; Find out which macro we are going to use
107 (let* ((char (or char
108 (reftex-select-with-char reftex-query-index-macro-prompt
109 reftex-query-index-macro-help)))
110 (macro (nth 1 (assoc char reftex-key-to-index-macro-alist)))
111 (entry (or (assoc macro reftex-index-macro-alist)
112 (error "No index macro associated with %c" char)))
114 (tag (or tag (nth 1 entry)))
115 (nargs (nth 4 entry))
116 (nindex (nth 5 entry))
117 (opt-args (nth 6 entry))
118 (repeat (nth 7 entry))
121 ;; Get the supported arguments
124 (setq tag1 (or (reftex-index-complete-tag tag opt-args) "")))
126 (reftex-index-complete-key
127 (if (string= tag1 "") "idx" tag1)
128 (member nindex opt-args))))
130 ;; Insert the macro and ask for any additional args
132 (loop for i from 1 to nargs do
133 (setq opt (member i opt-args)
134 value (cond ((= nindex i) key)
135 ((equal ntag i) tag1)
136 (t (read-string (concat "Macro arg nr. "
138 (if opt " (optional)" "")
140 (unless (and opt (string= value ""))
141 (insert (if opt "[" "{") value (if opt "]" "}"))))
142 (and repeat (stringp sel) (insert sel))
143 (and key reftex-plug-into-AUCTeX (fboundp 'LaTeX-add-index-entries)
144 (LaTeX-add-index-entries key))
145 (reftex-index-update-taglist tag1)
146 (reftex-notice-new)))
148 (defun reftex-default-index ()
149 (cond ((null reftex-index-default-tag) nil)
150 ((stringp reftex-index-default-tag) reftex-index-default-tag)
151 (t (or (get reftex-docstruct-symbol 'default-index-tag)
154 (defun reftex-update-default-index (tag &optional tag-list)
155 (if (and (not (equal tag ""))
157 (eq reftex-index-default-tag 'last)
159 (member tag tag-list)))
160 (put reftex-docstruct-symbol 'default-index-tag tag)))
162 (defun reftex-index-complete-tag (&optional itag opt-args)
163 ;; Ask the user for a tag, completing on known tags.
164 ;; ITAG is the argument number which contains the tag.
165 ;; OPT-ARGS is a list of optional argument indices, as given by
166 ;; `reftex-parse-args'.
167 (let* ((opt (and (integerp itag) (member itag opt-args)))
168 (index-tags (cdr (assq 'index-tags
169 (symbol-value reftex-docstruct-symbol))))
170 (default (reftex-default-index))
171 (prompt (concat "Index tag"
172 (if default (format " (default: %s)" default) "")
173 (if opt " (optional)" "") ": "))
174 (tag (completing-read prompt (mapcar 'list index-tags))))
175 (if (and default (equal tag "")) (setq tag default))
176 (reftex-update-default-index tag)
179 (defun reftex-index-select-tag ()
180 ;; Have the user select an index tag.
181 ;; FIXME: should we cache tag-alist, prompt and help?
182 (let* ((index-tags (cdr (assoc 'index-tags
183 (symbol-value reftex-docstruct-symbol))))
184 (default (reftex-default-index)))
187 (error "No index tags available"))
189 ((= (length index-tags) 1)
190 ;; Just one index, use it
193 ((> (length index-tags) 1)
194 ;; Several indices, ask.
195 (let* ((tags (copy-sequence index-tags))
197 tag-alist i val len tag prompt help rpl)
198 ;; Move idx and glo up in the list to ensure ?i and ?g shortcuts
199 (if (member "glo" tags)
200 (setq tags (cons "glo" (delete "glo" tags))))
201 (if (member "idx" tags)
202 (setq tags (cons "idx" (delete "idx" tags))))
203 ;; Find unique shortcuts for each index.
204 (while (setq tag (pop tags))
205 (setq len (length tag)
209 (while (and (< (incf i) len) (null val))
210 (unless (assq (aref tag i) tag-alist)
211 (push (list (aref tag i)
213 (concat (substring tag 0 i)
214 "[" (substring tag i (incf i)) "]"
218 (push (list (+ ?0 (incf cnt)) tag
219 (concat "[" (int-to-string cnt) "]:" tag))
221 (setq tag-alist (nreverse tag-alist))
222 ;; Compute Prompt and Help strings
225 (format "Select Index%s: "
226 (if default (format " (Default <%s>)" default) ""))
227 (mapconcat (lambda(x) (nth 2 x)) tag-alist " ")))
229 (concat "Select an Index\n===============\n"
231 (format "[^M] %s (the default)\n" default)
233 (mapconcat (lambda(x)
234 (apply 'format "[%c] %s" x))
236 ;; Query the user for an index-tag
237 (setq rpl (reftex-select-with-char prompt help 3 t))
239 (if (and default (equal rpl ?\C-m))
241 (if (assq rpl tag-alist)
243 (reftex-update-default-index (nth 1 (assq rpl tag-alist)))
244 (nth 1 (assq rpl tag-alist)))
245 (error "No index tag associated with %c" rpl)))))
246 (t (error "This should not happen (reftex-index-select-tag)")))))
248 (defun reftex-index-complete-key (&optional tag optional initial)
249 ;; Read an index key, with completion.
250 ;; Restrict completion table on index tag TAG.
251 ;; OPTIONAL indicates if the arg is optional.
252 (let* ((table (reftex-sublist-nth
253 (symbol-value reftex-docstruct-symbol) 6
254 (lambda(x) (and (eq (car x) 'index)
255 (string= (nth 1 x) (or tag ""))))
257 (prompt (concat "Index key" (if optional " (optional)" "") ": "))
258 (key (completing-read prompt table nil nil initial)))
261 (defun reftex-index-update-taglist (newtag)
262 ;; add NEWTAG to the list of available index tags.
263 (let ((cell (assoc 'index-tags (symbol-value reftex-docstruct-symbol))))
264 (and newtag (cdr cell) (not (member newtag (cdr cell)))
265 (push newtag (cdr cell)))))
267 (defvar reftex-index-map (make-sparse-keymap)
268 "Keymap used for *Index* buffers.")
270 (defvar reftex-index-menu)
272 (defvar reftex-last-index-file nil
273 "Stores the file name from which `reftex-display-index' was called.")
274 (defvar reftex-index-tag nil
275 "Stores the tag of the index in an index buffer.")
277 (defvar reftex-index-return-marker (make-marker)
278 "Marker which makes it possible to return from index to old position.")
280 (defvar reftex-index-restriction-indicator nil)
281 (defvar reftex-index-restriction-data nil)
283 (defun reftex-index-mode ()
284 "Major mode for managing Index buffers for LaTeX files.
285 This buffer was created with RefTeX.
286 Press `?' for a summary of important key bindings, or check the menu.
288 Here are all local bindings.
290 \\{reftex-index-map}"
292 (kill-all-local-variables)
293 (setq major-mode 'reftex-index-mode
294 mode-name "RefTeX Index")
295 (use-local-map reftex-index-map)
296 (set (make-local-variable 'revert-buffer-function) 'reftex-index-revert)
297 (set (make-local-variable 'reftex-index-restriction-data) nil)
298 (set (make-local-variable 'reftex-index-restriction-indicator) nil)
299 (setq mode-line-format
300 (list "---- " 'mode-line-buffer-identification
301 " " 'global-mode-string
302 " R<" 'reftex-index-restriction-indicator ">"
304 (setq truncate-lines t)
305 (when (featurep 'xemacs)
306 ;; XEmacs needs the call to make-local-hook
307 (make-local-hook 'post-command-hook)
308 (make-local-hook 'pre-command-hook))
309 (make-local-variable 'reftex-last-follow-point)
310 (easy-menu-add reftex-index-menu reftex-index-map)
311 (add-hook 'post-command-hook 'reftex-index-post-command-hook nil t)
312 (add-hook 'pre-command-hook 'reftex-index-pre-command-hook nil t)
313 (run-mode-hooks 'reftex-index-mode-hook))
315 (defconst reftex-index-help
316 " AVAILABLE KEYS IN INDEX BUFFER
317 ==============================
318 ! A..Z Goto the section of entries starting with this letter.
319 n / p next-entry / previous-entry
320 SPC / TAB Show/Goto the corresponding entry in the LaTeX document.
321 RET Goto the entry and hide the *Index* window (also on mouse-2).
322 q / k Hide/Kill *Index* buffer.
323 C-c = Switch to the TOC buffer.
324 f / c Toggle follow mode / Toggle display of [c]ontext.
325 g Refresh *Index* buffer.
326 r / C-u r Reparse the LaTeX document / Reparse entire LaTeX document.
327 s Switch to a different index (for documents with multiple indices).
328 e / C-k Edit/Kill the entry.
329 * | @ Edit specific part of entry: [*]key [|]attribute [@]visual
330 With prefix: kill that part.
331 \( ) Toggle entry's beginning/end of page range property.
332 _ ^ Add/Remove parent key (to make this item a subitem).
333 } / { Restrict Index to a single document section / Widen.
334 < / > When restricted, move restriction to previous/next section.")
336 (defun reftex-index-show-entry (data &optional no-revisit)
337 ;; Find an index entry associated with DATA and display it highlighted
338 ;; in another window. NO-REVISIT means we are not allowed to visit
340 ;; Note: This function just looks for the nearest match of the
341 ;; context string and may fail if the entry moved and an identical
342 ;; entry is close to the old position. Frequent rescans make this
344 (let* ((file (nth 3 data))
345 (literal (nth 2 data))
347 (re (regexp-quote literal))
350 ((or (not no-revisit)
351 (reftex-get-buffer-visiting file))
352 (switch-to-buffer-other-window
353 (reftex-get-file-buffer-force file nil))
354 (goto-char (or pos (point-min)))
356 (reftex-nearest-match re (length literal))))
357 (t (message reftex-no-follow-message) nil))))
359 (goto-char (match-beginning 0))
361 (reftex-highlight 0 (match-beginning 0) (match-end 0) (current-buffer)))
364 (defun reftex-display-index (&optional tag overriding-restriction redo
366 "Display a buffer with an index compiled from the current document.
367 When the document has multiple indices, first prompts for the correct one.
368 When index support is turned off, offer to turn it on.
369 With one or two `C-u' prefixes, rescan document first.
370 With prefix 2, restrict index to current document section.
371 With prefix 3, restrict index to region."
375 ;; Ensure access to scanning info and rescan buffer if prefix are is '(4).
376 (let ((current-prefix-arg current-prefix-arg))
377 (reftex-ensure-index-support t)
378 (reftex-access-scan-info current-prefix-arg))
380 (set-marker reftex-index-return-marker (point))
381 (setq reftex-last-follow-point 1)
383 ;; Determine the correct index to process
384 (let* ((docstruct (symbol-value reftex-docstruct-symbol))
385 (docstruct-symbol reftex-docstruct-symbol)
386 (index-tag (or tag (reftex-index-select-tag)))
387 (master (reftex-TeX-master-file))
388 (calling-file (buffer-file-name))
390 (or overriding-restriction
392 (reftex-get-restriction current-prefix-arg docstruct))))
394 ;; See if we are on an index macro as initial position
396 (let* ((what-macro (reftex-what-macro-safe 1))
397 (macro (car what-macro))
398 (here-I-am (when (member macro reftex-macros-with-index)
400 (goto-char (+ (cdr what-macro)
402 (reftex-move-over-touching-args)
403 (reftex-where-am-I)))))
404 (if (eq (car (car here-I-am)) 'index)
405 (list (car here-I-am))))))
408 (setq buffer-name (reftex-make-index-buffer-name index-tag))
410 ;; Goto the buffer and put it into the correct mode
412 (when (or restriction current-prefix-arg)
413 (reftex-kill-buffer buffer-name))
415 (if (get-buffer-window buffer-name)
416 (select-window (get-buffer-window buffer-name))
417 (let ((default-major-mode 'reftex-index-mode))
418 (switch-to-buffer buffer-name)))
420 (or (eq major-mode 'reftex-index-mode) (reftex-index-mode))
422 ;; If the buffer is currently restricted, empty it to force update.
423 (when reftex-index-restriction-data
424 (reftex-erase-buffer))
425 (set (make-local-variable 'reftex-last-index-file) calling-file)
426 (set (make-local-variable 'reftex-index-tag) index-tag)
427 (set (make-local-variable 'reftex-docstruct-symbol) docstruct-symbol)
429 (setq reftex-index-restriction-indicator (car restriction)
430 reftex-index-restriction-data (cdr restriction))
432 (setq reftex-index-restriction-indicator nil
433 reftex-index-restriction-data nil)))
434 (when (= (buffer-size) 0)
435 ;; buffer is empty - fill it
436 (message "Building %s buffer..." buffer-name)
438 (setq buffer-read-only nil)
442 SPC=view TAB=goto RET=goto+hide [e]dit [q]uit [r]escan [f]ollow [?]Help
443 ------------------------------------------------------------------------------
444 " index-tag (abbreviate-file-name master)
445 (if (eq (car (car reftex-index-restriction-data)) 'toc)
446 (nth 2 (car reftex-index-restriction-data))
447 reftex-index-restriction-indicator)))
449 (if (reftex-use-fonts)
450 (put-text-property 1 (point) 'face reftex-index-header-face))
451 (put-text-property 1 (point) 'intangible t)
453 (reftex-insert-index docstruct index-tag)
454 (goto-char (point-min))
455 (run-hooks 'reftex-display-copied-context-hook)
456 (message "Building %s buffer...done." buffer-name)
457 (setq buffer-read-only t))
458 (and locations (apply 'reftex-find-start-point (point) locations))
459 (if reftex-index-restriction-indicator
460 (message "Index restricted: <%s>" reftex-index-restriction-indicator))))
462 (defun reftex-insert-index (docstruct tag &optional update-one remark)
463 ;; Insert an index into the current buffer. Entries are from the
465 ;; TAG is the subindex to process.
466 ;; UPDATE-ONE: When non-nil, delete the entry at point and replace
467 ;; it with whatever the DOCSTRUCT contains.
468 ;; REMARK can be a note to add to the entry.
469 (let* ((all docstruct)
471 (context reftex-index-include-context)
472 (context-indent (concat indent " "))
473 (section-chars (mapcar 'identity reftex-index-section-letters))
474 (this-section-char 0)
475 (font (reftex-use-fonts))
476 (bor (car reftex-index-restriction-data))
477 (eor (nth 1 reftex-index-restriction-data))
479 (if (memq reftex-highlight-selection '(mouse both))
480 reftex-mouse-selected-face
482 (index-face (reftex-verified-face reftex-label-face
483 'font-lock-constant-face
484 'font-lock-reference-face))
485 sublist cell from to first-char)
487 ;; Make the sublist and sort it
489 (setq all (or (memq bor all) all)))
491 (while (setq cell (pop all))
494 (and (eq (car cell) 'index)
495 (equal (nth 1 cell) tag)
496 (push cell sublist))))
497 (setq sublist (sort (nreverse sublist)
498 (lambda (a b) (string< (nth 8 a) (nth 8 b)))))
501 ;; Delete the entry at place
502 (and (bolp) (forward-char 1))
503 (delete-region (previous-single-property-change (1+ (point)) :data)
504 (or (next-single-property-change (point) :data)
507 ;; Walk through the list and insert all entries
508 (while (setq cell (pop sublist))
510 (setq first-char (upcase (string-to-char (nth 6 cell))))
511 (when (and (not (equal first-char this-section-char))
512 (member first-char section-chars))
513 ;; There is a new initial letter, so start a new section
514 (reftex-index-insert-new-letter first-char font)
515 (setq section-chars (delete first-char section-chars)
516 this-section-char first-char))
517 (when (= this-section-char 0)
518 (setq this-section-char ?!)
519 (reftex-index-insert-new-letter this-section-char font)))
522 (insert indent (nth 7 cell))
526 (- (point) (length (nth 7 cell))) to
530 (when (or remark (nth 9 cell))
531 (and (< (current-column) 40)
532 ;; FIXME: maybe this is too slow?
533 (insert (make-string (max (- 40 (current-column)) 0) ?\ )))
534 (and (nth 9 cell) (insert " " (substring (nth 5 cell) (nth 9 cell))))
535 (and remark (insert " " remark)))
541 (insert context-indent (nth 2 cell) "\n")
543 (put-text-property from to :data cell)
545 (put-text-property from (1- to)
546 'mouse-face mouse-face))
550 (defun reftex-index-insert-new-letter (letter &optional font)
551 ;; Start a new section in the index
552 (let ((from (point)))
553 (insert "\n" letter letter letter
554 "-----------------------------------------------------------------")
556 (put-text-property from (point) 'face reftex-index-section-face))
559 (defun reftex-get-restriction (arg docstruct)
560 ;; Interprete the prefix ARG and derive index restriction specs.
561 (let* ((beg (min (point) (or (condition-case nil (mark) (error nil))
563 (end (max (point) (or (condition-case nil (mark) (error nil))
565 bor eor label here-I-am)
568 (setq here-I-am (car (reftex-where-am-I))
569 bor (if (eq (car here-I-am) 'toc)
571 (reftex-last-assoc-before-elt
572 'toc here-I-am docstruct))
573 eor (car (memq (assq 'toc (cdr (memq bor docstruct))) docstruct))
577 (setq label "region")
579 (setq bor (car (reftex-where-am-I)))
580 (setq bor (nth 1 (memq bor docstruct)))
582 (setq eor (nth 1 (memq (car (reftex-where-am-I)) docstruct)))))
584 (if (and label (or bor eor))
588 (defun reftex-index-pre-command-hook ()
589 ;; Used as pre command hook in *Index* buffer
590 (reftex-unhighlight 0)
591 (reftex-unhighlight 1))
593 (defun reftex-index-post-command-hook ()
594 ;; Used in the post-command-hook for the *Index* buffer
595 (when (get-text-property (point) :data)
597 (not (get-text-property (point) 'intangible))
598 (memq reftex-highlight-selection '(cursor both))
600 (or (previous-single-property-change (1+ (point)) :data)
602 (or (next-single-property-change (point) :data)
604 (if (integerp reftex-index-follow-mode)
605 ;; Remove delayed action
606 (setq reftex-index-follow-mode t)
607 (and reftex-index-follow-mode
608 (not (equal reftex-last-follow-point (point)))
609 ;; Show context in other window
610 (setq reftex-last-follow-point (point))
612 (reftex-index-visit-location nil (not reftex-revisit-to-follow))
615 (defun reftex-index-show-help ()
616 "Show a summary of special key bindings."
618 (with-output-to-temp-buffer "*RefTeX Help*"
619 (princ reftex-index-help))
620 (reftex-enlarge-to-fit "*RefTeX Help*" t)
621 ;; If follow mode is active, arrange to delay it one command
622 (if reftex-index-follow-mode
623 (setq reftex-index-follow-mode 1)))
625 (defun reftex-index-next (&optional arg)
626 "Move to next selectable item."
628 (setq reftex-callback-fwd t)
629 (or (eobp) (forward-char 1))
630 (goto-char (or (next-single-property-change (point) :data)
632 (unless (get-text-property (point) :data)
633 (goto-char (or (next-single-property-change (point) :data)
635 (defun reftex-index-previous (&optional arg)
636 "Move to previous selectable item."
638 (setq reftex-callback-fwd nil)
639 (goto-char (or (previous-single-property-change (point) :data)
641 (unless (get-text-property (point) :data)
642 (goto-char (or (previous-single-property-change (point) :data)
644 (defun reftex-index-toggle-follow ()
645 "Toggle follow (other window follows with context)."
647 (setq reftex-last-follow-point -1)
648 (setq reftex-index-follow-mode (not reftex-index-follow-mode)))
649 (defun reftex-index-toggle-context ()
650 "Toggle inclusion of label context in *Index* buffer.
651 Label context is only displayed when the labels are there as well."
653 (setq reftex-index-include-context (not reftex-index-include-context))
654 (reftex-index-revert))
655 (defun reftex-index-view-entry ()
656 "View document location in other window."
658 (reftex-index-visit-location))
659 (defun reftex-index-goto-entry-and-hide ()
660 "Go to document location in other window. Hide the *Index* window."
662 (reftex-index-visit-location 'hide))
663 (defun reftex-index-goto-entry ()
664 "Go to document location in other window. *Index* window stays."
666 (reftex-index-visit-location t))
667 (defun reftex-index-mouse-goto-line-and-hide (ev)
668 "Go to document location in other window. Hide the *Index* window."
671 (reftex-index-visit-location 'hide))
672 (defun reftex-index-quit ()
673 "Hide the *Index* window and do not move point."
675 (or (one-window-p) (delete-window))
676 (switch-to-buffer (marker-buffer reftex-index-return-marker))
677 (goto-char (or (marker-position reftex-index-return-marker) (point))))
678 (defun reftex-index-quit-and-kill ()
679 "Kill the *Index* buffer."
681 (kill-buffer (current-buffer))
682 (or (one-window-p) (delete-window))
683 (switch-to-buffer (marker-buffer reftex-index-return-marker))
684 (goto-char (or (marker-position reftex-index-return-marker) (point))))
685 (defun reftex-index-goto-toc (&rest ignore)
686 "Switch to the table of contents of the current document.
687 The function will go to the section where the entry at point was defined."
689 (if (get-text-property (point) :data)
690 (reftex-index-goto-entry)
691 (switch-to-buffer (marker-buffer reftex-index-return-marker)))
692 (delete-other-windows)
694 (defun reftex-index-rescan (&rest ignore)
695 "Regenerate the *Index* buffer after reparsing file of section at point."
697 (let ((index-tag reftex-index-tag))
698 (if (and reftex-enable-partial-scans
699 (null current-prefix-arg))
700 (let* ((data (get-text-property (point) :data))
702 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0))))
704 (error "Don't know which file to rescan. Try `C-u r'")
705 (switch-to-buffer (reftex-get-file-buffer-force file))
706 (setq current-prefix-arg '(4))
707 (reftex-display-index index-tag nil 'redo line)))
708 (reftex-index-Rescan))
709 (reftex-kill-temporary-buffers)))
710 (defun reftex-index-Rescan (&rest ignore)
711 "Regenerate the *Index* buffer after reparsing the entire document."
713 (let ((index-tag reftex-index-tag)
714 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0))))
716 (reftex-get-file-buffer-force reftex-last-index-file))
717 (setq current-prefix-arg '(16))
718 (reftex-display-index index-tag nil 'redo line)))
719 (defun reftex-index-revert (&rest ignore)
720 "Regenerate the *Index* from the internal lists. No reparsing os done."
722 (let ((buf (current-buffer))
723 (index-tag reftex-index-tag)
724 (data (get-text-property (point) :data))
725 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0))))
727 (reftex-get-file-buffer-force reftex-last-index-file))
728 (reftex-erase-buffer buf)
729 (setq current-prefix-arg nil
730 reftex-last-follow-point 1)
731 (reftex-display-index index-tag nil 'redo data line)))
732 (defun reftex-index-switch-index-tag (&rest ignore)
733 "Switch to a different index of the same document."
736 (reftex-get-file-buffer-force reftex-last-index-file))
737 (setq current-prefix-arg nil)
738 (reftex-display-index nil nil 'redo))
740 (defun reftex-index-restrict-to-section (&optional force)
741 "Restrict index to entries defined in same document sect. as entry at point."
742 ;; Optional FORCE means, even if point is not on an index entry.
744 (let* ((data (get-text-property (point) :data))
745 (docstruct (symbol-value reftex-docstruct-symbol))
747 (if (and (not data) force)
748 (setq data (assq 'toc docstruct)))
750 (setq bor (reftex-last-assoc-before-elt 'toc data docstruct)
751 eor (car (memq (assq 'toc (cdr (memq bor docstruct)))
753 reftex-index-restriction-data (list bor eor)
754 reftex-index-restriction-indicator (nth 6 bor) )))
755 (reftex-index-revert))
757 (defun reftex-index-widen (&rest ignore)
758 "Show the unrestricted index (all entries)."
760 (setq reftex-index-restriction-indicator nil
761 reftex-index-restriction-data nil)
762 (reftex-index-revert)
763 (message "Index widened"))
764 (defun reftex-index-restriction-forward (&rest ignore)
765 "Restrict to previous section.
766 When index is currently unrestricted, restrict it to a section.
767 When index is restricted, select the next section as restriction criterion."
769 (let* ((docstruct (symbol-value reftex-docstruct-symbol))
770 (bor (nth 1 reftex-index-restriction-data)))
772 (not (eq (car bor) 'toc)))
773 (reftex-index-restrict-to-section t)
774 (setq reftex-index-restriction-indicator (nth 6 bor)
775 reftex-index-restriction-data
777 (car (memq (assq 'toc (cdr (memq bor docstruct)))
779 (reftex-index-revert))))
780 (defun reftex-index-restriction-backward (&rest ignore)
781 "Restrict to next section.
782 When index is currently unrestricted, restrict it to a section.
783 When index is restricted, select the previous section as restriction criterion."
785 (let* ((docstruct (symbol-value reftex-docstruct-symbol))
786 (eor (car reftex-index-restriction-data))
787 (bor (reftex-last-assoc-before-elt 'toc eor docstruct t)))
789 (not (eq (car bor) 'toc)))
790 (reftex-index-restrict-to-section t)
791 (setq reftex-index-restriction-indicator (nth 6 bor)
792 reftex-index-restriction-data
794 (reftex-index-revert))))
796 (defun reftex-index-visit-location (&optional final no-revisit)
797 ;; Visit the tex file corresponding to the index entry on the current line.
798 ;; If FINAL is t, stay there
799 ;; If FINAL is 'hide, hide the *Index* window.
800 ;; Otherwise, move cursor back into *Index* window.
801 ;; NO-REVISIT means don't visit files, just use live biffers.
803 (let* ((data (get-text-property (point) :data))
804 (index-window (selected-window))
805 show-window show-buffer match)
807 (unless data (error "Don't know which index entry to visit"))
809 (if (eq (car data) 'index)
810 (setq match (reftex-index-show-entry data no-revisit)))
812 (setq show-window (selected-window)
813 show-buffer (current-buffer))
816 (select-window index-window)
817 (error "Cannot find location"))
819 (select-window index-window)
821 ;; Use the `final' parameter to decide what to do next
824 (reftex-unhighlight 0)
825 (select-window show-window))
827 (reftex-unhighlight 0)
828 (or (one-window-p) (delete-window))
829 (switch-to-buffer show-buffer))
832 (defun reftex-index-analyze-entry (data)
833 ;; This splits the index context so that key, attribute and visual
834 ;; values are accessible individually.
836 (let* ((arg (nth 5 data))
837 (context (nth 2 data))
838 (sc reftex-index-special-chars)
839 (boa (if (string-match (regexp-quote (concat "{" arg "}")) context)
840 (1+ (match-beginning 0))
841 (error "Something is wrong here")))
842 (eoa (1- (match-end 0)))
843 (boactual (if (string-match (concat "[^" (nth 3 sc) "]" (nth 2 sc))
845 (1+ (match-beginning 0))
847 (boattr (if (string-match (concat "[^" (nth 3 sc) "]" (nth 1 sc))
849 (1+ (match-beginning 0))
851 (pre (substring context 0 boa))
852 (key (substring context boa boattr))
853 (attr (substring context boattr boactual))
854 (actual (substring context boactual eoa))
855 (post (substring context eoa)))
856 (list pre key attr actual post)))
858 (defun reftex-index-edit ()
859 "Edit the index entry at point."
861 (let* ((data (get-text-property (point) :data))
863 (unless data (error "Don't know which index entry to edit"))
864 (reftex-index-view-entry)
865 (setq old (nth 2 data) new (read-string "Edit: " old))
866 (reftex-index-change-entry new)))
868 (defun reftex-index-toggle-range-beginning ()
869 "Toggle the page range start attribute `|('."
871 (let* ((data (get-text-property (point) :data))
872 (bor (concat (nth 1 reftex-index-special-chars) "("))
874 (unless data (error "Don't know which index entry to edit"))
875 (setq analyze (reftex-index-analyze-entry data)
876 attr (nth 2 analyze))
877 (setf (nth 2 analyze) (if (string= attr bor) "" bor))
878 (setq new (apply 'concat analyze))
879 (reftex-index-change-entry
880 new (if (string= (nth 2 analyze) bor)
881 "Entry is now START-OF-PAGE-RANGE"
882 "START-OF-PAGE-RANGE canceled"))))
884 (defun reftex-index-toggle-range-end ()
885 "Toggle the page-range-end attribute `|)'."
887 (let* ((data (get-text-property (point) :data))
888 (eor (concat (nth 1 reftex-index-special-chars) ")"))
890 (unless data (error "Don't know which index entry to edit"))
891 (setq analyze (reftex-index-analyze-entry data)
892 attr (nth 2 analyze))
893 (setf (nth 2 analyze) (if (string= attr eor) "" eor))
894 (setq new (apply 'concat analyze))
895 (reftex-index-change-entry
896 new (if (string= (nth 2 analyze) eor)
897 "Entry is now END-OF-PAGE-RANGE"
898 "END-OF-PAGE-RANGE canceled"))))
900 (defun reftex-index-edit-key ()
901 "Edit the KEY part of the index entry."
903 (reftex-index-edit-part nil 1 "" "Key: " t))
905 (defun reftex-index-edit-attribute (&optional arg)
906 "EDIT the ATTRIBUTE part of the entry. With arg: remove entire ATTRIBUTE."
908 (reftex-index-edit-part arg 2 (nth 1 reftex-index-special-chars)
911 (defun reftex-index-edit-visual (&optional arg)
912 "EDIT the VISUAL part of the entry. With arg: remove entire VISUAL string."
914 (reftex-index-edit-part arg 3 (nth 2 reftex-index-special-chars) "Visual: "))
916 (defun reftex-index-edit-part (arg n initial prompt &optional dont-allow-empty)
917 ;; This function does the work for all partial editing commands
918 (let* ((data (get-text-property (point) :data))
919 new analyze opart npart)
920 (unless data (error "Don't know which index entry to edit"))
921 ;; Analyze the whole context string
922 (setq analyze (reftex-index-analyze-entry data)
923 opart (nth n analyze))
924 (and (> (length opart) 0) (setq opart (substring opart 1)))
925 ;; Have the user editing the part
926 (setq npart (if arg "" (read-string (concat prompt initial) opart)))
928 (cond ((string= npart opart)
929 (error "Not changed"))
932 (error "Invalid value")
933 (setf (nth n analyze) npart)))
934 (t (setf (nth n analyze) (concat initial npart))))
935 (setq new (apply 'concat analyze))
936 ;; Change the entry and insert the changed version into the index.
937 (reftex-index-change-entry
938 new (if (string= npart "")
939 (format "Deleted: %s" opart)
940 (format "New value is: %s" npart)))))
942 (defun reftex-index-level-down ()
943 "Make index entry a subitem of another entry."
945 (let* ((data (get-text-property (point) :data))
946 (docstruct (symbol-value reftex-docstruct-symbol))
948 (unless data (error "Don't know which index entry to change"))
949 (setq old (nth 2 data)
951 prefix (completing-read
956 (and (eq (car x) 'index)
957 (string= (nth 1 x) reftex-index-tag))) t)))
958 (unless (string-match
959 (concat (regexp-quote (car reftex-index-special-chars)) "\\'")
961 (setq prefix (concat prefix (car reftex-index-special-chars))))
962 (if (string-match (regexp-quote key) old)
963 (setq new (replace-match (concat prefix key) t t old))
964 (error "Cannot construct new index key"))
965 (reftex-index-change-entry new (format "Added prefix: %s" prefix))))
967 (defun reftex-index-level-up ()
968 "Remove the highest level of a hierarchical index entry."
970 (let* ((data (get-text-property (point) :data))
972 (unless data (error "Don't know which entry to change"))
973 (setq old (nth 2 data))
974 (if (string-match (concat "{\\([^" (nth 0 reftex-index-special-chars) "]*"
975 "[^" (nth 3 reftex-index-special-chars) "]"
976 (regexp-quote (nth 0 reftex-index-special-chars))
979 (setq prefix (substring old (match-beginning 1) (match-end 1))
980 new (concat (substring old 0 (match-beginning 1))
981 (substring old (match-end 1))))
982 (error "Entry is not a subitem"))
983 (reftex-index-change-entry new (format "Removed prefix: %s" prefix))))
985 (defun reftex-index-kill ()
986 "FIXME: Not yet implemented"
988 (error "This function is currently not implemented"))
990 (defun reftex-index-undo ()
991 "FIXME: Not yet implemented"
993 (error "This function is currently not implemented"))
995 (defun reftex-index-change-entry (new &optional message)
996 ;; Change the full context string of the index entry at point to
997 ;; NEW. This actually edits the buffer where the entry is defined.
999 (let* ((data (get-text-property (point) :data))
1001 (unless data (error "Cannot change entry"))
1002 (reftex-index-view-entry)
1003 (setq beg (match-beginning 0) end (match-end 0))
1004 (setq old (nth 2 data))
1005 (and (equal old new) (error "Entry unchanged"))
1007 (set-buffer (get-file-buffer (nth 3 data)))
1009 (unless (looking-at (regexp-quote old))
1010 (error "This should not happen (reftex-index-change-entry)"))
1011 (delete-region beg end)
1013 (goto-char (1- beg))
1014 (when (and (re-search-forward (reftex-everything-regexp) nil t)
1016 (< (abs (- (match-beginning 10) beg)) (length new))
1017 (setq info (reftex-index-info-safe buffer-file-name)))
1018 (setcdr data (cdr info))))
1019 (let ((buffer-read-only nil))
1021 (reftex-insert-index (list data) reftex-index-tag t
1023 (setq reftex-last-follow-point 1)
1024 (and message (message message))))
1027 (define-key reftex-index-map (if (featurep 'xemacs) [(button2)] [(mouse-2)])
1028 'reftex-index-mouse-goto-line-and-hide)
1030 (substitute-key-definition
1031 'next-line 'reftex-index-next reftex-index-map global-map)
1032 (substitute-key-definition
1033 'previous-line 'reftex-index-previous reftex-index-map global-map)
1036 '(("n" . reftex-index-next)
1037 ("p" . reftex-index-previous)
1038 ("?" . reftex-index-show-help)
1039 (" " . reftex-index-view-entry)
1040 ("\C-m" . reftex-index-goto-entry-and-hide)
1041 ("\C-i" . reftex-index-goto-entry)
1042 ("\C-k" . reftex-index-kill)
1043 ("r" . reftex-index-rescan)
1044 ("R" . reftex-index-Rescan)
1045 ("g" . revert-buffer)
1046 ("q" . reftex-index-quit)
1047 ("k" . reftex-index-quit-and-kill)
1048 ("f" . reftex-index-toggle-follow)
1049 ("s" . reftex-index-switch-index-tag)
1050 ("e" . reftex-index-edit)
1051 ("^" . reftex-index-level-up)
1052 ("_" . reftex-index-level-down)
1053 ("}" . reftex-index-restrict-to-section)
1054 ("{" . reftex-index-widen)
1055 (">" . reftex-index-restriction-forward)
1056 ("<" . reftex-index-restriction-backward)
1057 ("(" . reftex-index-toggle-range-beginning)
1058 (")" . reftex-index-toggle-range-end)
1059 ("|" . reftex-index-edit-attribute)
1060 ("@" . reftex-index-edit-visual)
1061 ("*" . reftex-index-edit-key)
1062 ("\C-c=". reftex-index-goto-toc)
1063 ("c" . reftex-index-toggle-context))
1064 do (define-key reftex-index-map (car x) (cdr x)))
1066 (loop for key across "0123456789" do
1067 (define-key reftex-index-map (vector (list key)) 'digit-argument))
1068 (define-key reftex-index-map "-" 'negative-argument)
1070 ;; The capital letters and the exclamation mark
1071 (loop for key across (concat "!" reftex-index-section-letters) do
1072 (define-key reftex-index-map (vector (list key))
1073 (list 'lambda '() '(interactive)
1074 (list 'reftex-index-goto-letter key))))
1076 (defun reftex-index-goto-letter (char)
1077 "Go to the CHAR section in the index."
1079 (case-fold-search nil))
1081 (if (re-search-forward (concat "^" (char-to-string char)) nil t)
1085 (reftex-index-next))
1088 (error "This <%s> index does not contain entries sorted before the letters"
1090 (error "This <%s> index does not contain entries starting with `%c'"
1091 reftex-index-tag char)))))
1094 reftex-index-menu reftex-index-map
1095 "Menu for Index buffer"
1098 (message "To go to a section, just press any of: !%s"
1099 reftex-index-section-letters) t]
1100 ["Show Entry" reftex-index-view-entry t]
1101 ["Go To Entry" reftex-index-goto-entry t]
1102 ["Exit & Go To Entry" reftex-index-goto-entry-and-hide t]
1103 ["Table of Contents" reftex-index-goto-toc t]
1104 ["Quit" reftex-index-quit t]
1107 ["Rebuilt *Index* Buffer" revert-buffer t]
1109 ["Rescan One File" reftex-index-rescan reftex-enable-partial-scans]
1110 ["Rescan Entire Document" reftex-index-Rescan t])
1112 ["Restrict to section" reftex-index-restrict-to-section t]
1113 ["Widen" reftex-index-widen reftex-index-restriction-indicator]
1114 ["Next Section" reftex-index-restriction-forward
1115 reftex-index-restriction-indicator]
1116 ["Previous Section" reftex-index-restriction-backward
1117 reftex-index-restriction-indicator])
1119 ["Edit Entry" reftex-index-edit t]
1120 ["Edit Key" reftex-index-edit-key t]
1121 ["Edit Attribute" reftex-index-edit-attribute t]
1122 ["Edit Visual" reftex-index-edit-visual t]
1124 ["Add Parentkey" reftex-index-level-down t]
1125 ["Remove Parentkey " reftex-index-level-up t]
1127 ["Make Start-of-Range" reftex-index-toggle-range-beginning t]
1128 ["Make End-of-Range" reftex-index-toggle-range-end t]
1130 ["Kill Entry" reftex-index-kill nil]
1132 ["Undo" reftex-index-undo nil])
1134 ["Context" reftex-index-toggle-context :style toggle
1135 :selected reftex-index-include-context]
1137 ["Follow Mode" reftex-index-toggle-follow :style toggle
1138 :selected reftex-index-follow-mode])
1140 ["Help" reftex-index-show-help t]))
1143 ;;----------------------------------------------------------------------
1144 ;; The Index Phrases File
1146 ;; Some constants and variables
1147 (defconst reftex-index-phrases-comment-regexp "^[ \t]*%.*"
1148 "Regular expression to match comment lines in phrases buffer")
1149 (defconst reftex-index-phrases-macrodef-regexp
1150 "^\\(>>>INDEX_MACRO_DEFINITION:\\)[ \t]+\\(\\S-\\)\\( *\t[ \t]*\\)\\([^\t]*[^ \t]\\)\\( *\t[ \t]*\\)\\(\\S-+\\)"
1151 "Regular expression to match macro definition lines the phrases buffer.")
1152 ;(defconst reftex-index-phrases-macrodef-regexp
1153 ; "^\\(>>>INDEX_MACRO_DEFINITION:\\)[ \t]+\\(\\S-\\)\\([ \t]*\\)\\([^\t]*[^ \t]\\)\\([ \t]*\\)\\(nil\\|t\\)[ \t]*$"
1154 ; "Regular expression to match macro definition lines the phrases buffer.
1155 ;This version would allow just spaces as separators.")
1156 (defconst reftex-index-phrases-phrase-regexp1
1157 "^\\(\\S-?\\)\\(\t\\)\\([^\t\n]*\\S-\\)\\([ \t]*\\)$"
1158 "Regular expression matching phrases which have no separate index key.")
1159 (defconst reftex-index-phrases-phrase-regexp2
1160 "^\\(\\S-?\\)\\(\t\\)\\([^\t]*\\S-\\)\\(\t[ \t]*\\)\\([^\n\t]*\\S-\\)[ \t]*$"
1161 "Regular expression matching phrases which have a separate index key.")
1162 (defconst reftex-index-phrases-phrase-regexp12
1163 "^\\(\\S-?\\)\\(\t\\)\\([^\n\t]*\\S-\\)\\(\\(\t[ \t]*\\)\\([^\n\t]*\\S-\\)\\)?[ \t]*$"
1164 "Regular expression matching all types of phrase lines.")
1165 (defvar reftex-index-phrases-macro-data nil
1166 "Alist containing the information taken from the macro definition lines.
1167 This gets refreshed in every phrases command.")
1168 (defvar reftex-index-phrases-files nil
1169 "List of document files relevant for the phrases file.")
1171 (defvar reftex-index-phrases-font-lock-keywords nil
1172 "Font lock keywords for reftex-index-phrases-mode.")
1173 (defvar reftex-index-phrases-font-lock-defaults nil
1174 "Font lock defaults for reftex-index-phrases-mode.")
1175 (defvar reftex-index-phrases-map (make-sparse-keymap)
1176 "Keymap used for *toc* buffer.")
1179 (defun reftex-index-phrase-selection-or-word (arg)
1180 "Add current selection or word at point to the phrases buffer.
1181 When you are in transient-mark-mode and the region is active, the
1182 selection will be used - otherwise the word at point.
1183 You get a chance to edit the entry in the phrases buffer - finish with
1186 (set-marker reftex-index-return-marker (point))
1187 (reftex-index-selection-or-word arg 'phrase)
1188 (if (eq major-mode 'reftex-index-phrases-mode)
1190 (substitute-command-keys
1191 "Return to LaTeX with \\[reftex-index-phrases-save-and-return]"))))
1193 (defun reftex-index-visit-phrases-buffer ()
1194 "Switch to the phrases buffer, initialize if empty."
1196 (reftex-access-scan-info)
1197 (let* ((master (reftex-TeX-master-file))
1198 (name (concat (file-name-sans-extension master)
1199 reftex-index-phrase-file-extension)))
1201 (unless (eq major-mode 'reftex-index-phrases-mode)
1202 (reftex-index-phrases-mode))
1203 (if (= (buffer-size) 0)
1204 (reftex-index-initialize-phrases-buffer master))))
1206 (defun reftex-index-initialize-phrases-buffer (&optional master)
1207 "Initialize the phrases buffer by creating the header.
1208 If the buffer is non-empty, delete the old header first."
1210 (let* ((case-fold-search t)
1211 (default-key (car reftex-index-default-macro))
1212 (default-macro (nth 1 (assoc default-key
1213 reftex-key-to-index-macro-alist)))
1215 (sort (copy-sequence reftex-index-macro-alist)
1216 (lambda (a b) (equal (car a) default-macro))))
1217 macro entry key repeat)
1219 (if master (set (make-local-variable 'TeX-master)
1220 (file-name-nondirectory master)))
1222 (when (> (buffer-size) 0)
1225 (while (re-search-forward reftex-index-phrases-macrodef-regexp nil t)
1227 (beginning-of-line 2)
1228 (if (looking-at reftex-index-phrases-comment-regexp)
1229 (beginning-of-line 2))
1230 (while (looking-at "^[ \t]*$")
1231 (beginning-of-line 2))
1232 (cond ((fboundp 'zmacs-activate-region) (zmacs-activate-region))
1233 ((boundp 'make-active) (setq mark-active t)))
1234 (if (yes-or-no-p "Delete and rebuilt header ")
1235 (delete-region (point-min) (point))))
1237 ;; Insert the mode line
1239 (format "%% -*- mode: reftex-index-phrases; TeX-master: \"%s\" -*-\n"
1240 (file-name-nondirectory (reftex-index-phrase-tex-master))))
1241 ;; Insert the macro definitions
1242 (insert "% Key Macro Format Repeat\n")
1243 (insert "%---------------------------------------------------------------------\n")
1244 (while (setq entry (pop macro-alist))
1245 (setq macro (car entry)
1246 repeat (nth 7 entry)
1247 key (car (delq nil (mapcar (lambda (x) (if (equal (nth 1 x) macro)
1250 reftex-key-to-index-macro-alist))))
1251 (insert (format ">>>INDEX_MACRO_DEFINITION:\t%s\t%-20s\t%s\n"
1252 (char-to-string key) (concat macro "{%s}")
1253 (if repeat "t" "nil"))))
1254 (insert "%---------------------------------------------------------------------\n\n\n")))
1257 (defun reftex-index-phrase-tex-master (&optional dir)
1258 "Return the name of the master file associated with a phrase buffer."
1259 (if (and (boundp 'TeX-master)
1260 (local-variable-p 'TeX-master (current-buffer))
1261 (stringp TeX-master))
1262 ;; We have a local variable which tells us which file to use
1263 (expand-file-name TeX-master dir)
1265 (concat (file-name-sans-extension (buffer-file-name)) ".tex")))
1267 (defun reftex-index-phrases-save-and-return ()
1268 "Return to where the `reftex-index-phrase-selection-or-word' was called."
1271 (switch-to-buffer (marker-buffer reftex-index-return-marker))
1272 (goto-char (or (marker-position reftex-index-return-marker) (point))))
1275 (defvar reftex-index-phrases-menu)
1276 (defvar reftex-index-phrases-restrict-file nil)
1278 (defun reftex-index-phrases-mode ()
1279 "Major mode for managing the Index phrases of a LaTeX document.
1280 This buffer was created with RefTeX.
1282 To insert new phrases, use
1283 - `C-c \\' in the LaTeX document to copy selection or word
1284 - `\\[reftex-index-new-phrase]' in the phrases buffer.
1286 To index phrases use one of:
1288 \\[reftex-index-this-phrase] index current phrase
1289 \\[reftex-index-next-phrase] index next phrase (or N with prefix arg)
1290 \\[reftex-index-all-phrases] index all phrases
1291 \\[reftex-index-remaining-phrases] index current and following phrases
1292 \\[reftex-index-region-phrases] index the phrases in the region
1294 You can sort the phrases in this buffer with \\[reftex-index-sort-phrases].
1295 To display information about the phrase at point, use \\[reftex-index-phrases-info].
1297 For more information see the RefTeX User Manual.
1299 Here are all local bindings.
1301 \\{reftex-index-phrases-map}"
1303 (kill-all-local-variables)
1304 (setq major-mode 'reftex-index-phrases-mode
1305 mode-name "Phrases")
1306 (use-local-map reftex-index-phrases-map)
1307 (set (make-local-variable 'font-lock-defaults)
1308 reftex-index-phrases-font-lock-defaults)
1309 (easy-menu-add reftex-index-phrases-menu reftex-index-phrases-map)
1310 (set (make-local-variable 'reftex-index-phrases-marker) (make-marker))
1311 (run-mode-hooks 'reftex-index-phrases-mode-hook))
1312 (add-hook 'reftex-index-phrases-mode-hook 'turn-on-font-lock)
1314 ;; Font Locking stuff
1315 (let ((ss (if (featurep 'xemacs) 'secondary-selection ''secondary-selection)))
1316 (setq reftex-index-phrases-font-lock-keywords
1318 (cons reftex-index-phrases-comment-regexp 'font-lock-comment-face)
1319 (list reftex-index-phrases-macrodef-regexp
1320 '(1 font-lock-type-face)
1321 '(2 font-lock-keyword-face)
1323 '(4 font-lock-function-name-face)
1325 '(6 font-lock-string-face))
1326 (list reftex-index-phrases-phrase-regexp1
1327 '(1 font-lock-keyword-face)
1329 '(3 font-lock-string-face)
1331 (list reftex-index-phrases-phrase-regexp2
1332 '(1 font-lock-keyword-face)
1334 '(3 font-lock-string-face)
1336 '(5 font-lock-function-name-face))
1338 (setq reftex-index-phrases-font-lock-defaults
1339 '((reftex-index-phrases-font-lock-keywords)
1340 nil t nil beginning-of-line))
1341 (put 'reftex-index-phrases-mode 'font-lock-defaults
1342 reftex-index-phrases-font-lock-defaults) ; XEmacs
1345 (defvar reftex-index-phrases-marker)
1346 (defun reftex-index-next-phrase (&optional arg)
1347 "Index the next ARG phrases in the phrases buffer."
1349 (reftex-index-phrases-parse-header t)
1353 (if (re-search-forward reftex-index-phrases-phrase-regexp12 nil t)
1355 (goto-char (match-beginning 0))
1356 (reftex-index-this-phrase 'slave))
1357 (error "No more phrase lines after point"))))
1359 (defun reftex-index-this-phrase (&optional slave)
1360 "Index the phrase in the current line.
1361 Does a global search and replace in the entire document. At each
1362 match, the user will be asked to confirm the replacement."
1364 (if (not slave) (reftex-index-phrases-parse-header t))
1367 (cond ((looking-at reftex-index-phrases-comment-regexp)
1368 (if (not slave) (error "Comment line")))
1369 ((looking-at "^[ \t]*$")
1370 (if (not slave) (error "Empty line")))
1371 ((looking-at reftex-index-phrases-macrodef-regexp)
1372 (if (not slave) (error "Macro definition line")))
1373 ((looking-at reftex-index-phrases-phrase-regexp12)
1375 (let* ((char (if (not (equal (match-string 1) ""))
1376 (string-to-char (match-string 1))))
1377 (phrase (match-string 3))
1378 (index-key (match-string 6))
1379 (macro-data (cdr (if (null char)
1380 (car reftex-index-phrases-macro-data)
1381 (assoc char reftex-index-phrases-macro-data))))
1382 (macro-fmt (car macro-data))
1383 (repeat (nth 1 macro-data))
1385 (cond ((and (stringp reftex-index-phrases-restrict-file)
1386 (file-regular-p reftex-index-phrases-restrict-file))
1387 (list reftex-index-phrases-restrict-file))
1388 ((stringp reftex-index-phrases-restrict-file)
1389 (error "Invalid restriction file %s"
1390 reftex-index-phrases-restrict-file))
1391 (t reftex-index-phrases-files)))
1392 (as-words reftex-index-phrases-search-whole-words))
1394 (error "No macro associated with key %c" char))
1396 (let ((overlay-arrow-string "=>")
1397 (overlay-arrow-position
1398 reftex-index-phrases-marker)
1400 ;; Show the overlay arrow
1401 (move-marker reftex-index-phrases-marker
1402 (match-beginning 0) (current-buffer))
1403 ;; Start the query-replace
1404 (reftex-query-index-phrase-globally
1405 files phrase macro-fmt
1406 index-key repeat as-words)
1407 (message "%s replaced"
1408 (reftex-number replace-count "occurrence"))))))
1409 (t (error "Cannot parse this line")))))
1411 (defun reftex-index-all-phrases ()
1412 "Index all phrases in the phrases buffer.
1413 Calls `reftex-index-this-phrase' on each line in the buffer."
1415 (reftex-index-region-phrases (point-min) (point-max)))
1417 (defun reftex-index-remaining-phrases ()
1418 "Index all phrases in the phrases buffer.
1419 Calls `reftex-index-this-phrase' on each line ay and below point in
1423 (reftex-index-region-phrases (point) (point-max)))
1425 (defun reftex-index-region-phrases (beg end)
1426 "Index all phrases in the phrases buffer.
1427 Calls `reftex-index-this-phrase' on each line in the region."
1429 (reftex-index-phrases-parse-header t)
1431 (while (not (or (eobp)
1433 (save-excursion (reftex-index-this-phrase 'slave))
1434 (beginning-of-line 2)))
1436 (defun reftex-index-phrases-parse-header (&optional get-files)
1437 "Parse the header of a phrases file to extract the macro definitions.
1438 The definitions get stored in `reftex-index-phrases-macro-data'.
1439 Also switches to the LaTeX document to find out which files belong to
1440 the document and stores the list in `reftex-index-phrases-files'."
1441 (let* ((master (reftex-index-phrase-tex-master))
1444 ;; Get the file list
1446 (setq buf (reftex-get-file-buffer-force master))
1447 (unless buf (error "Master file %s not found" master))
1449 (reftex-access-scan-info)
1450 (setq reftex-index-phrases-files
1451 (reftex-all-document-files))))
1452 ;; Parse the files header for macro definitions
1453 (setq reftex-index-phrases-macro-data nil)
1455 (goto-char (point-min))
1456 (while (re-search-forward reftex-index-phrases-macrodef-regexp nil t)
1458 (string-to-char (match-string 2))
1460 (equal (match-string 6) "t"))
1461 reftex-index-phrases-macro-data))
1462 ;; Reverse the list, so that the first macro is first
1463 (if (null reftex-index-phrases-macro-data)
1464 (error "No valid MACRO DEFINITION line in %s file (make sure to use TAB separators)" reftex-index-phrase-file-extension))
1465 (setq reftex-index-phrases-macro-data
1466 (nreverse reftex-index-phrases-macro-data))
1467 (goto-char (point-min)))))
1469 (defun reftex-index-phrases-apply-to-region (beg end)
1470 "Index all index phrases in the current region.
1471 This works exactly like global indexing from the index phrases buffer,
1472 but operation is restricted to the current region. This is useful if
1473 you need to add/change text in an already indexed document and want to
1474 index the new part without having to go over the unchanged parts again."
1476 (let ((win-conf (current-window-configuration))
1477 (reftex-index-phrases-restrict-file (buffer-file-name)))
1480 (narrow-to-region beg end)
1483 ;; Hide the region highlighting
1484 (cond ((fboundp 'zmacs-deactivate-region) (zmacs-deactivate-region))
1485 ((fboundp 'deactivate-mark) (deactivate-mark)))
1486 (delete-other-windows)
1487 (reftex-index-visit-phrases-buffer)
1488 (reftex-index-all-phrases))
1489 (set-window-configuration win-conf))))))
1491 (defun reftex-index-new-phrase (&optional text)
1492 "Open a new line in the phrases buffer, insert TEXT."
1494 (if (and text (stringp text))
1496 ;; Check if the phrase is already in the buffer
1497 (setq text (reftex-index-simplify-phrase text))
1498 (goto-char (point-min))
1499 (if (re-search-forward
1500 (concat "^\\(\\S-*\\)\t\\(" (regexp-quote text)
1501 "\\) *[\t\n]") nil t)
1503 (goto-char (match-end 2))
1504 (error "Phrase is already in phrases buffer")))))
1505 ;; Add the new phrase line after the last in the buffer
1506 (goto-char (point-max))
1507 (if (re-search-backward reftex-index-phrases-phrase-regexp12 nil t)
1512 (if (and text (stringp text))
1515 (defun reftex-index-find-next-conflict-phrase (&optional arg)
1516 "Find the next a phrase which is has conflicts in the phrase buffer.
1517 The command helps to find possible conflicts in the phrase indexing process.
1518 It searches downward from point for a phrase which is repeated elsewhere
1519 in the buffer, or which is a subphrase of another phrase. If such a
1520 phrase is found, the phrase info is displayed.
1521 To check the whole buffer, start at the beginning and continue by calling
1522 this function repeatedly."
1525 (while (re-search-forward reftex-index-phrases-phrase-regexp12 nil t)
1526 (goto-char (match-beginning 3))
1527 (let* ((phrase (match-string 3))
1528 (case-fold-search reftex-index-phrases-case-fold-search)
1529 (re (reftex-index-phrases-find-dup-re phrase t)))
1531 (goto-char (point-min))
1532 (and (re-search-forward re nil t)
1533 (re-search-forward re nil t)))
1536 (reftex-index-phrases-info)
1537 (message "Phrase with match conflict discovered"))
1538 (goto-char (point-max))
1539 (error "No further problematic phrases found")))
1541 (defun reftex-index-phrases-info ()
1542 "Display information about the phrase at point."
1546 (unless (looking-at reftex-index-phrases-phrase-regexp12)
1547 (error "Not a phrase line"))
1548 (save-match-data (reftex-index-phrases-parse-header t))
1549 (let* ((char (if (not (equal (match-string 1) ""))
1550 (string-to-char (match-string 1))))
1551 (phrase (match-string 3))
1552 (index-key (match-string 6))
1553 (index-keys (split-string
1554 (or index-key phrase)
1555 reftex-index-phrases-logical-or-regexp))
1556 (macro-data (cdr (if (null char)
1557 (car reftex-index-phrases-macro-data)
1558 (assoc char reftex-index-phrases-macro-data))))
1559 (macro-fmt (car macro-data))
1560 (repeat (nth 1 macro-data))
1561 (as-words reftex-index-phrases-search-whole-words)
1562 (example (reftex-index-make-replace-string
1563 macro-fmt (downcase phrase) (car index-keys) repeat))
1564 (re (reftex-index-make-phrase-regexp phrase as-words t))
1565 (re1 (reftex-index-phrases-find-dup-re phrase))
1566 (re2 (reftex-index-phrases-find-dup-re phrase 'sub))
1571 (case-fold-search reftex-index-phrases-case-fold-search)
1573 (setq files reftex-index-phrases-files)
1577 (goto-char (point-min))
1578 (while (re-search-forward re1 nil t)
1580 (goto-char (point-min))
1581 (while (re-search-forward re2 nil t)
1582 (push (cons (count-lines 1 (point)) (match-string 1)) superphrases)
1585 (while (setq file (pop files))
1586 (setq buf (reftex-get-file-buffer-force file))
1592 (goto-char (point-min))
1593 (let ((case-fold-search reftex-index-phrases-case-fold-search))
1594 (while (re-search-forward re nil t)
1595 (or (reftex-in-comment)
1596 (incf nmatches)))))))))
1597 (with-output-to-temp-buffer "*Help*"
1598 (princ (format " Phrase: %s\n" phrase))
1599 (princ (format " Macro key: %s\n" char))
1600 (princ (format " Macro format: %s\n" macro-fmt))
1601 (princ (format " Repeat: %s\n" repeat))
1604 (let ((iks index-keys) (cnt 0) ik)
1605 (while (setq ik (pop iks))
1606 (princ (format "Index entry %d: %s\n" (incf cnt) ik)))))
1608 (princ (format " Index entry: %s\n" phrase)))
1610 (princ (format " Index key: <<Given by the match>>\n"))))
1611 (princ (format " Example: %s\n" example))
1613 (princ (format "Total matches: %s in %s\n"
1614 (reftex-number nmatches "match" "es")
1615 (reftex-number (length reftex-index-phrases-files)
1617 (princ (format " Uniqueness: Phrase occurs %s in phrase buffer\n"
1618 (reftex-number ntimes1 "time")))
1621 (princ (format " Superphrases: Phrase matches the following %s in the phrase buffer:\n"
1622 (reftex-number ntimes2 "line")))
1624 (princ (format " Line %4d: %s\n" (car x) (cdr x))))
1625 (nreverse superphrases))))))))
1627 (defun reftex-index-phrases-set-macro-key ()
1628 "Change the macro key for the current line.
1629 Prompts for a macro key and insert is at the beginning of the line.
1630 If you reply with SPACE, the macro keyn will be removed, so that the
1631 default macro will be used. If you reply with `RET', just prints
1632 information about the currently selected macro."
1634 (reftex-index-phrases-parse-header)
1637 (unless (or (looking-at reftex-index-phrases-phrase-regexp12)
1639 (error "This is not a phrase line"))
1640 (let* ((nc (reftex-index-select-phrases-macro 0))
1641 (macro-data (assoc nc reftex-index-phrases-macro-data))
1646 macro-data (car reftex-index-phrases-macro-data)))
1648 (setq nc (char-after (point)))
1651 macro-data (car reftex-index-phrases-macro-data))
1652 (setq macro-data (assoc nc reftex-index-phrases-macro-data))))
1653 (t (error "No macro associated with %c" nc)))
1655 (setq macro-fmt (nth 1 macro-data)
1656 repeat (nth 2 macro-data))
1659 (if (looking-at "[^\t]") (delete-char 1))
1661 (message "Line will use %s %s repeat" macro-fmt
1662 (if repeat "with" "without")))
1665 (defun reftex-index-sort-phrases (&optional chars-first)
1666 "Sort the phrases lines in the buffer alphabetically.
1667 Normally, this looks only at the phrases. With a prefix arg CHARS-FIRST,
1668 it first compares the macro identifying chars and then the phrases."
1670 ;; Remember the current line, so that we can return
1671 (let ((line (buffer-substring (progn (beginning-of-line) (point))
1672 (progn (end-of-line) (point))))
1674 (goto-char (point-min))
1675 ;; Find first and last phrase line in buffer
1677 (and (re-search-forward reftex-index-phrases-phrase-regexp12 nil t)
1678 (match-beginning 0)))
1679 (goto-char (point-max))
1680 (setq end (re-search-backward reftex-index-phrases-phrase-regexp12 nil t))
1681 (if end (setq end (progn (goto-char end) (end-of-line) (point))))
1682 ;; Take the lines, sort them and re-insert.
1685 (message "Sorting lines...")
1686 (let* ((lines (split-string (buffer-substring beg end) "\n"))
1687 (lines1 (sort lines 'reftex-compare-phrase-lines)))
1688 (message "Sorting lines...done")
1689 (let ((inhibit-quit t)) ;; make sure we do not loose lines
1690 (delete-region beg end)
1691 (insert (mapconcat 'identity lines1 "\n"))))
1692 (goto-char (point-max))
1693 (re-search-backward (concat "^" (regexp-quote line) "$") nil t))
1694 (error "Cannot find phrases lines to sort"))))
1696 (defvar chars-first)
1697 (defun reftex-compare-phrase-lines (a b)
1698 "The comparison function used for sorting."
1699 (let (ca cb pa pb c-p p-p)
1700 (if (string-match reftex-index-phrases-phrase-regexp12 a)
1702 ;; Extract macro char and phrase-or-key for a
1703 (setq ca (match-string 1 a)
1705 (or (and reftex-index-phrases-sort-prefers-entry
1707 (match-string 3 a))))
1708 (if (string-match reftex-index-phrases-phrase-regexp12 b)
1710 ;; Extract macro char and phrase-or-key for b
1711 (setq cb (match-string 1 b)
1713 (or (and reftex-index-phrases-sort-prefers-entry
1715 (match-string 3 b))))
1716 (setq c-p (string< ca cb)
1717 p-p (string< pa pb))
1718 ;; Do the right comparison, based on the value of `chars-first'
1719 ;; `chars-first' is bound locally in the calling function
1721 (if (string= ca cb) p-p c-p)
1722 (if (string= pa pb) c-p p-p)))))
1723 ;; If line a does not match, the answer we return determines
1724 ;; if non-matching lines are collected at the beginning.
1725 ;; When we return t here, non-matching lines form
1726 ;; block separators for searches.
1727 (not reftex-index-phrases-sort-in-blocks))))
1729 (defvar reftex-index-phrases-menu)
1730 (defun reftex-index-make-phrase-regexp (phrase &optional
1731 as-words allow-newline)
1732 "Return a regexp matching PHRASE, even if distributed over lines.
1733 With optional arg AS-WORDS, require word boundary at beginning and end.
1734 With optional arg ALLOW-NEWLINE, allow single newline between words."
1735 (let* ((words (split-string phrase))
1736 (space-re (if allow-newline
1737 "\\([ \t]*\\(\n[ \t]*\\)?\\|[ \t]\\)"
1739 (concat (if (and as-words (string-match "\\`\\w" (car words)))
1740 "\\(\\<\\|[`']\\)" "")
1741 (mapconcat (lambda (w) (regexp-quote
1742 (if reftex-index-phrases-case-fold-search
1747 (string-match "\\w\\'" (nth (1- (length words)) words)))
1748 "\\(\\>\\|'\\)" ""))))
1750 (defun reftex-index-simplify-phrase (phrase)
1751 "Make phrase single spaces and single line."
1752 (mapconcat 'identity (split-string phrase) " "))
1754 (defun reftex-index-phrases-find-dup-re (phrase &optional sub)
1755 "Return a regexp which matches variations of PHRASE (with additional space).
1756 When SUB ins non-nil, the regexp will also match when PHRASE is a subphrase
1757 of another phrase. The regexp works lonly in the phrase buffer."
1758 (concat (if sub "^\\S-?\t\\([^\t\n]*" "^\\S-?\t")
1759 (mapconcat 'regexp-quote (split-string phrase) " +")
1760 (if sub "[^\t\n]*\\)\\([\t\n]\\|$\\)" " *\\([\t\n]\\|$\\)")))
1762 (defun reftex-index-make-replace-string (macro-fmt match index-key
1763 &optional repeat mathp)
1764 "Return the string which can be used as replacement.
1765 Treats the logical `and' for index phrases."
1766 (let ((index-keys (split-string (or index-key match)
1767 reftex-index-phrases-logical-and-regexp)))
1769 (mapconcat (lambda (x)
1771 (format (if mathp reftex-index-math-format "%s") x)))
1773 (if repeat (reftex-index-simplify-phrase match) ""))))
1775 (defun reftex-query-index-phrase-globally (files &rest args)
1776 "Call `reftex-query-index-phrase' for all files in FILES."
1777 (let ((win-conf (current-window-configuration))
1779 (unless files (error "No files"))
1782 (switch-to-buffer-other-window (reftex-get-file-buffer-force
1784 (catch 'no-more-files
1785 (while (setq file (pop files))
1786 (switch-to-buffer (reftex-get-file-buffer-force file))
1789 (unless (stringp reftex-index-phrases-restrict-file)
1791 (goto-char (point-min))
1792 (apply 'reftex-query-index-phrase args))))))
1793 (reftex-unhighlight 0)
1794 (set-window-configuration win-conf))))
1796 (defconst reftex-index-phrases-help
1797 " Keys for query-index search
1798 ===========================
1799 y Replace this match
1801 ! Replace this and all further matches in this file
1802 q / Q Skip match, start next file / start next phrase
1803 o Use a different indexing macro for this match
1804 1 - 9 Select one of the multiple phrases
1805 e Edit the replacement text
1807 s / S Save this buffer / Save all document buffers
1809 "The help string for indexing phrases.")
1811 (defvar replace-count)
1812 (defun reftex-query-index-phrase (phrase macro-fmt &optional
1813 index-key repeat as-words)
1814 "Search through buffer for PHRASE, and offer to replace it with an indexed
1815 version. The index version is derived by applying `format' with MACRO-FMT
1816 to INDEX-KEY or PHRASE. When REPEAT is non-nil, the PHRASE is inserted
1817 again after the macro.
1818 AS-WORDS means, the search for PHRASE should require word boundaries at
1820 (let* ((re (reftex-index-make-phrase-regexp phrase as-words 'allow-newline))
1821 (case-fold-search reftex-index-phrases-case-fold-search)
1822 (index-keys (split-string
1823 (or index-key phrase)
1824 reftex-index-phrases-logical-or-regexp))
1825 (nkeys (length index-keys))
1826 (ckey (nth 0 index-keys))
1828 match rpl char beg end mathp)
1830 (while (re-search-forward re nil t)
1832 (if (reftex-in-comment)
1833 (throw 'next-match nil))
1834 (if (and (fboundp reftex-index-verify-function)
1835 (not (funcall reftex-index-verify-function)))
1836 (throw 'next-match nil))
1837 (setq match (match-string 0))
1840 (condition-case nil (texmathp) (error nil))))
1841 (setq beg (car (match-data))
1842 end (nth 1 (match-data)))
1843 (if (and reftex-index-phrases-skip-indexed-matches
1845 (reftex-index-phrase-match-is-indexed beg
1847 (throw 'next-match nil))
1848 (reftex-highlight 0 (match-beginning 0) (match-end 0))
1851 (reftex-index-make-replace-string
1852 macro-fmt (match-string 0) ckey repeat mathp)))
1856 (message "REPLACE: %s? (yn!qoe%s?)"
1859 (concat "1-" (int-to-string nkeys))
1861 (setq char (if all-yes ?y (read-char-exclusive)))
1862 (cond ((member char '(?y ?Y ?\ ))
1864 (replace-match rpl t t)
1865 (incf replace-count)
1866 ;; See if we should insert newlines to shorten lines
1867 (and reftex-index-phrases-wrap-long-lines
1868 (reftex-index-phrases-fixup-line beg end))
1870 ((member char '(?n ?N ?\C-h ?\C-?));; FIXME: DEL
1874 ;; Yes for all in this buffer
1877 ;; Stop this one in this file
1878 (goto-char (point-max))
1882 (throw 'no-more-files t))
1886 (reftex-save-all-document-buffers))
1889 ((member char '(?o ?O))
1890 ;; Select a differnt macro
1891 (let* ((nc (reftex-index-select-phrases-macro 2))
1893 (cdr (assoc nc reftex-index-phrases-macro-data)))
1894 (macro-fmt (car macro-data))
1895 (repeat (nth 1 macro-data)))
1897 (setq rpl (save-match-data
1898 (reftex-index-make-replace-string
1900 ckey repeat mathp)))
1904 (with-output-to-temp-buffer "*Help*"
1905 (princ reftex-index-phrases-help)))
1911 (substitute-command-keys
1912 "Recursive edit. Resume with \\[exit-recursive-edit]"))
1915 (setq rpl (read-string "Edit: " rpl)))
1917 (setq ckey (or index-key phrase)
1918 rpl (save-match-data
1919 (reftex-index-make-replace-string
1920 macro-fmt match ckey repeat mathp))))
1922 (<= char (+ ?0 nkeys)))
1923 (setq ckey (nth (1- (- char ?0)) index-keys)
1924 rpl (save-match-data
1925 (reftex-index-make-replace-string
1926 macro-fmt match ckey repeat mathp))))
1931 (reftex-unhighlight 0))))
1933 (defun reftex-index-phrase-match-is-indexed (beg end)
1934 ;; Check if match is in an argument of an index macro, or if an
1935 ;; index macro is directly attached to the match.
1938 (let* ((all-macros (reftex-what-macro t))
1939 (this-macro (car (car all-macros)))
1942 (goto-char (1- beg))
1943 (memq (char-after (point)) '(?\] ?\}))
1944 (car (reftex-what-macro 1))))
1946 (and (goto-char end)
1947 (looking-at "\\(\\\\[a-zA-Z]+\\*?\\)[[{]")
1951 (while (setq macro (pop all-macros))
1952 (if (member (car macro) reftex-macros-with-index)
1953 (throw 'matched t)))
1956 (member before-macro reftex-macros-with-index))
1958 (member after-macro reftex-macros-with-index))))))
1960 (defun reftex-index-phrases-fixup-line (beg end)
1961 "Insert newlines before BEG and/or after END to shorten line."
1962 (let (bol eol space1 space2)
1964 ;; Find line boundaries and possible line breaks near BEG and END
1970 (skip-chars-backward "^ \n")
1971 (if (and (equal (preceding-char) ?\ )
1972 (string-match "\\S-" (buffer-substring bol (point))))
1973 (setq space1 (1- (point))))
1975 (skip-chars-forward "^ \n")
1976 (if (and (equal (following-char) ?\ )
1977 (string-match "\\S-" (buffer-substring (point) eol)))
1978 (setq space2 (point)))
1979 ;; Now check what we have and insert the newlines
1980 (if (<= (- eol bol) fill-column)
1981 ;; Line is already short
1984 ((and (not space1) (not space2))) ; No spaces available
1985 ((not space2) ; Do space1
1986 (reftex-index-phrases-replace-space space1))
1987 ((not space1) ; Do space2
1988 (reftex-index-phrases-replace-space space2))
1989 (t ; We have both spaces
1990 (let ((l1 (- space1 bol))
1991 (l2 (- space2 space1))
1992 (l3 (- eol space2)))
1993 (if (> l2 fill-column)
1994 ;; The central part alone is more than one line
1996 (reftex-index-phrases-replace-space space1)
1997 (reftex-index-phrases-replace-space space2))
1998 (if (> (+ l1 l2) fill-column)
1999 ;; Need to split beginning
2000 (reftex-index-phrases-replace-space space1))
2001 (if (> (+ l2 l3) fill-column)
2002 ;; Need to split end
2003 (reftex-index-phrases-replace-space space2))))))))))
2005 (defun reftex-index-phrases-replace-space (pos)
2006 "If there is a space at POS, replace it with a newline char.
2007 Does not do a save-excursion."
2008 (when (equal (char-after pos) ?\ )
2013 (defun reftex-index-select-phrases-macro (&optional delay)
2014 "Offer a list of possible index macros and have the user select one."
2015 (let* ((prompt (concat "Select macro: ["
2016 (mapconcat (lambda (x) (char-to-string (car x)))
2017 reftex-index-phrases-macro-data "")
2019 (help (concat "Select an indexing macro\n========================\n"
2020 (mapconcat (lambda (x)
2023 reftex-index-phrases-macro-data "\n"))))
2024 (reftex-select-with-char prompt help delay)))
2026 ;; Keybindings and Menu for phrases buffer
2029 '(("\C-c\C-c" . reftex-index-phrases-save-and-return)
2030 ("\C-c\C-x" . reftex-index-this-phrase)
2031 ("\C-c\C-f" . reftex-index-next-phrase)
2032 ("\C-c\C-r" . reftex-index-region-phrases)
2033 ("\C-c\C-a" . reftex-index-all-phrases)
2034 ("\C-c\C-d" . reftex-index-remaining-phrases)
2035 ("\C-c\C-s" . reftex-index-sort-phrases)
2036 ("\C-c\C-n" . reftex-index-new-phrase)
2037 ("\C-c\C-m" . reftex-index-phrases-set-macro-key)
2038 ("\C-c\C-i" . reftex-index-phrases-info)
2039 ("\C-c\C-t" . reftex-index-find-next-conflict-phrase)
2040 ("\C-i" . self-insert-command))
2041 do (define-key reftex-index-phrases-map (car x) (cdr x)))
2044 reftex-index-phrases-menu reftex-index-phrases-map
2045 "Menu for Phrases buffer"
2047 ["New Phrase" reftex-index-new-phrase t]
2048 ["Set Phrase Macro" reftex-index-phrases-set-macro-key t]
2049 ["Recreate File Header" reftex-index-initialize-phrases-buffer t]
2052 ["Sort" reftex-index-sort-phrases t]
2055 ["by Search Phrase" (setq reftex-index-phrases-sort-prefers-entry nil)
2056 :style radio :selected (not reftex-index-phrases-sort-prefers-entry)]
2057 ["by Index Entry" (setq reftex-index-phrases-sort-prefers-entry t)
2058 :style radio :selected reftex-index-phrases-sort-prefers-entry]
2059 ["in Blocks" (setq reftex-index-phrases-sort-in-blocks
2060 (not reftex-index-phrases-sort-in-blocks))
2061 :style toggle :selected reftex-index-phrases-sort-in-blocks])
2062 ["Describe Phrase" reftex-index-phrases-info t]
2063 ["Next Phrase Conflict" reftex-index-find-next-conflict-phrase t]
2065 ("Find and Index in Document"
2066 ["Current Phrase" reftex-index-this-phrase t]
2067 ["Next Phrase" reftex-index-next-phrase t]
2068 ["Current and Following" reftex-index-remaining-phrases t]
2069 ["Region Phrases" reftex-index-region-phrases t]
2070 ["All Phrases" reftex-index-all-phrases t]
2073 ["Match Whole Words" (setq reftex-index-phrases-search-whole-words
2074 (not reftex-index-phrases-search-whole-words))
2075 :style toggle :selected reftex-index-phrases-search-whole-words]
2076 ["Case Sensitive Search" (setq reftex-index-phrases-case-fold-search
2077 (not reftex-index-phrases-case-fold-search))
2078 :style toggle :selected (not
2079 reftex-index-phrases-case-fold-search)]
2080 ["Wrap Long Lines" (setq reftex-index-phrases-wrap-long-lines
2081 (not reftex-index-phrases-wrap-long-lines))
2082 :style toggle :selected reftex-index-phrases-wrap-long-lines]
2083 ["Skip Indexed Matches" (setq reftex-index-phrases-skip-indexed-matches
2084 (not reftex-index-phrases-skip-indexed-matches))
2085 :style toggle :selected reftex-index-phrases-skip-indexed-matches])
2087 ["Save and Return" reftex-index-phrases-save-and-return t]))
2090 ;;; arch-tag: 4b2362af-c156-42c1-8932-ea2823e205c1
2091 ;;; reftex-index.el ends here