1 ;;; reftex-index.el --- index support with RefTeX
2 ;; Copyright (C) 1997, 1998, 1999, 2000, 2003, 2004, 2005,
3 ;; 2006 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., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, 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
)
39 ;; END remove for XEmacs release
40 (defun reftex-index-selection-or-word (&optional arg phrase
)
41 "Put selection or the word near point into the default index macro.
42 This uses the information in `reftex-index-default-macro' to make an index
43 entry. The phrase indexed is the current selection or the word near point.
44 When called with one `C-u' prefix, let the user have a chance to edit the
45 index entry. When called with 2 `C-u' as prefix, also ask for the index
46 macro and other stuff.
47 When called inside TeX math mode as determined by the `texmathp.el' library
48 which is part of AUCTeX, the string is first processed with the
49 `reftex-index-math-format', which see."
51 (let* ((use-default (not (equal arg
'(16)))) ; check for double prefix
52 ;; check if we have an active selection
53 (active (if (boundp 'zmacs-regions
)
54 (and zmacs-regions
(region-exists-p)) ; XEmacs
55 (and transient-mark-mode mark-active
))) ; Emacs
59 (skip-syntax-backward "w\\") (point))))
63 (skip-syntax-forward "w\\") (point))))
64 (sel (buffer-substring beg end
))
65 (mathp (condition-case nil
(texmathp) (error nil
)))
66 (current-prefix-arg nil
) ; we want to call reftex-index without prefix.
67 key def-char def-tag full-entry
)
71 (reftex-index-visit-phrases-buffer)
72 (reftex-index-new-phrase sel
))
75 ;; Nothing selected, no word, so use full reftex-index command
77 ;; OK, we have something to index here.
78 ;; Add the dollars when necessary
80 (format reftex-index-math-format sel
)
82 ;; Get info from `reftex-index-default-macro'
83 (setq def-char
(if use-default
(car reftex-index-default-macro
)))
84 (setq def-tag
(if use-default
(nth 1 reftex-index-default-macro
)))
85 ;; Does the user want to edit the entry?
86 (setq full-entry
(if arg
87 (reftex-index-complete-key
88 def-tag nil
(cons key
0))
90 ;; Delete what is in the buffer and make the index entry
91 (delete-region beg end
)
92 (reftex-index def-char full-entry def-tag sel
)))))
94 (defun reftex-index (&optional char key tag sel no-insert
)
95 "Query for an index macro and insert it along with its argments.
96 The index macros available are those defined in `reftex-index-macro' or
97 by a call to `reftex-add-index-macros', typically from an AUCTeX style file.
98 RefteX provides completion for the index tag and the index key, and
99 will prompt for other arguments."
103 ;; Ensure access to scanning info
104 (reftex-ensure-index-support t
)
105 (reftex-access-scan-info current-prefix-arg
)
107 ;; Find out which macro we are going to use
108 (let* ((char (or char
109 (reftex-select-with-char reftex-query-index-macro-prompt
110 reftex-query-index-macro-help
)))
111 (macro (nth 1 (assoc char reftex-key-to-index-macro-alist
)))
112 (entry (or (assoc macro reftex-index-macro-alist
)
113 (error "No index macro associated with %c" char
)))
115 (tag (or tag
(nth 1 entry
)))
116 (nargs (nth 4 entry
))
117 (nindex (nth 5 entry
))
118 (opt-args (nth 6 entry
))
119 (repeat (nth 7 entry
))
122 ;; Get the supported arguments
125 (setq tag1
(or (reftex-index-complete-tag tag opt-args
) "")))
127 (reftex-index-complete-key
128 (if (string= tag1
"") "idx" tag1
)
129 (member nindex opt-args
))))
131 ;; Insert the macro and ask for any additional args
133 (loop for i from
1 to nargs do
134 (setq opt
(member i opt-args
)
135 value
(cond ((= nindex i
) key
)
136 ((equal ntag i
) tag1
)
137 (t (read-string (concat "Macro arg nr. "
139 (if opt
" (optional)" "")
141 (unless (and opt
(string= value
""))
142 (insert (if opt
"[" "{") value
(if opt
"]" "}"))))
143 (and repeat
(stringp sel
) (insert sel
))
144 (and key reftex-plug-into-AUCTeX
(fboundp 'LaTeX-add-index-entries
)
145 (LaTeX-add-index-entries key
))
146 (reftex-index-update-taglist tag1
)
147 (reftex-notice-new)))
149 (defun reftex-default-index ()
150 (cond ((null reftex-index-default-tag
) nil
)
151 ((stringp reftex-index-default-tag
) reftex-index-default-tag
)
152 (t (or (get reftex-docstruct-symbol
'default-index-tag
)
155 (defun reftex-update-default-index (tag &optional tag-list
)
156 (if (and (not (equal tag
""))
158 (eq reftex-index-default-tag
'last
)
160 (member tag tag-list
)))
161 (put reftex-docstruct-symbol
'default-index-tag tag
)))
163 (defun reftex-index-complete-tag (&optional itag opt-args
)
164 ;; Ask the user for a tag, completing on known tags.
165 ;; ITAG is the argument number which contains the tag.
166 ;; OPT-ARGS is a list of optional argument indices, as given by
167 ;; `reftex-parse-args'.
168 (let* ((opt (and (integerp itag
) (member itag opt-args
)))
169 (index-tags (cdr (assq 'index-tags
170 (symbol-value reftex-docstruct-symbol
))))
171 (default (reftex-default-index))
172 (prompt (concat "Index tag"
176 (if opt
"optional" "")
178 (concat (if opt
", " "")
179 (format "default %s" default
))
182 (tag (completing-read prompt
(mapcar 'list index-tags
))))
183 (if (and default
(equal tag
"")) (setq tag default
))
184 (reftex-update-default-index tag
)
187 (defun reftex-index-select-tag ()
188 ;; Have the user select an index tag.
189 ;; FIXME: should we cache tag-alist, prompt and help?
190 (let* ((index-tags (cdr (assoc 'index-tags
191 (symbol-value reftex-docstruct-symbol
))))
192 (default (reftex-default-index)))
195 (error "No index tags available"))
197 ((= (length index-tags
) 1)
198 ;; Just one index, use it
201 ((> (length index-tags
) 1)
202 ;; Several indices, ask.
203 (let* ((tags (copy-sequence index-tags
))
205 tag-alist i val len tag prompt help rpl
)
206 ;; Move idx and glo up in the list to ensure ?i and ?g shortcuts
207 (if (member "glo" tags
)
208 (setq tags
(cons "glo" (delete "glo" tags
))))
209 (if (member "idx" tags
)
210 (setq tags
(cons "idx" (delete "idx" tags
))))
211 ;; Find unique shortcuts for each index.
212 (while (setq tag
(pop tags
))
213 (setq len
(length tag
)
217 (while (and (< (incf i
) len
) (null val
))
218 (unless (assq (aref tag i
) tag-alist
)
219 (push (list (aref tag i
)
221 (concat (substring tag
0 i
)
222 "[" (substring tag i
(incf i
)) "]"
226 (push (list (+ ?
0 (incf cnt
)) tag
227 (concat "[" (int-to-string cnt
) "]:" tag
))
229 (setq tag-alist
(nreverse tag-alist
))
230 ;; Compute Prompt and Help strings
233 (format "Select Index%s: "
234 (if default
(format " (Default <%s>)" default
) ""))
235 (mapconcat (lambda(x) (nth 2 x
)) tag-alist
" ")))
237 (concat "Select an Index\n===============\n"
239 (format "[^M] %s (the default)\n" default
)
241 (mapconcat (lambda(x)
242 (apply 'format
"[%c] %s" x
))
244 ;; Query the user for an index-tag
245 (setq rpl
(reftex-select-with-char prompt help
3 t
))
247 (if (and default
(equal rpl ?\C-m
))
249 (if (assq rpl tag-alist
)
251 (reftex-update-default-index (nth 1 (assq rpl tag-alist
)))
252 (nth 1 (assq rpl tag-alist
)))
253 (error "No index tag associated with %c" rpl
)))))
254 (t (error "This should not happen (reftex-index-select-tag)")))))
256 (defun reftex-index-complete-key (&optional tag optional initial
)
257 ;; Read an index key, with completion.
258 ;; Restrict completion table on index tag TAG.
259 ;; OPTIONAL indicates if the arg is optional.
260 (let* ((table (reftex-sublist-nth
261 (symbol-value reftex-docstruct-symbol
) 6
262 (lambda(x) (and (eq (car x
) 'index
)
263 (string= (nth 1 x
) (or tag
""))))
265 (prompt (concat "Index key" (if optional
" (optional)" "") ": "))
266 (key (completing-read prompt table nil nil initial
)))
269 (defun reftex-index-update-taglist (newtag)
270 ;; add NEWTAG to the list of available index tags.
271 (let ((cell (assoc 'index-tags
(symbol-value reftex-docstruct-symbol
))))
272 (and newtag
(cdr cell
) (not (member newtag
(cdr cell
)))
273 (push newtag
(cdr cell
)))))
275 (defvar reftex-index-map
(make-sparse-keymap)
276 "Keymap used for *Index* buffers.")
278 (defvar reftex-index-menu
)
280 (defvar reftex-last-index-file nil
281 "Stores the file name from which `reftex-display-index' was called.")
282 (defvar reftex-index-tag nil
283 "Stores the tag of the index in an index buffer.")
285 (defvar reftex-index-return-marker
(make-marker)
286 "Marker which makes it possible to return from index to old position.")
288 (defvar reftex-index-restriction-indicator nil
)
289 (defvar reftex-index-restriction-data nil
)
291 (defun reftex-index-mode ()
292 "Major mode for managing Index buffers for LaTeX files.
293 This buffer was created with RefTeX.
294 Press `?' for a summary of important key bindings, or check the menu.
296 Here are all local bindings.
298 \\{reftex-index-map}"
300 (kill-all-local-variables)
301 (setq major-mode
'reftex-index-mode
302 mode-name
"RefTeX Index")
303 (use-local-map reftex-index-map
)
304 (set (make-local-variable 'revert-buffer-function
) 'reftex-index-revert
)
305 (set (make-local-variable 'reftex-index-restriction-data
) nil
)
306 (set (make-local-variable 'reftex-index-restriction-indicator
) nil
)
307 (setq mode-line-format
308 (list "---- " 'mode-line-buffer-identification
309 " " 'global-mode-string
310 " R<" 'reftex-index-restriction-indicator
">"
312 (setq truncate-lines t
)
313 (when (featurep 'xemacs
)
314 ;; XEmacs needs the call to make-local-hook
315 (make-local-hook 'post-command-hook
)
316 (make-local-hook 'pre-command-hook
))
317 (make-local-variable 'reftex-last-follow-point
)
318 (easy-menu-add reftex-index-menu reftex-index-map
)
319 (add-hook 'post-command-hook
'reftex-index-post-command-hook nil t
)
320 (add-hook 'pre-command-hook
'reftex-index-pre-command-hook nil t
)
321 (run-hooks 'reftex-index-mode-hook
))
323 (defconst reftex-index-help
324 " AVAILABLE KEYS IN INDEX BUFFER
325 ==============================
326 ! A..Z Goto the section of entries starting with this letter.
327 n / p next-entry / previous-entry
328 SPC / TAB Show/Goto the corresponding entry in the LaTeX document.
329 RET Goto the entry and hide the *Index* window (also on mouse-2).
330 q / k Hide/Kill *Index* buffer.
331 C-c = Switch to the TOC buffer.
332 f / c Toggle follow mode / Toggle display of [c]ontext.
333 g Refresh *Index* buffer.
334 r / C-u r Reparse the LaTeX document / Reparse entire LaTeX document.
335 s Switch to a different index (for documents with multiple indices).
336 e / C-k Edit/Kill the entry.
337 * | @ Edit specific part of entry: [*]key [|]attribute [@]visual
338 With prefix: kill that part.
339 \( ) Toggle entry's beginning/end of page range property.
340 _ ^ Add/Remove parent key (to make this item a subitem).
341 } / { Restrict Index to a single document section / Widen.
342 < / > When restricted, move restriction to previous/next section.")
344 (defun reftex-index-show-entry (data &optional no-revisit
)
345 ;; Find an index entry associated with DATA and display it highlighted
346 ;; in another window. NO-REVISIT means we are not allowed to visit
348 ;; Note: This function just looks for the nearest match of the
349 ;; context string and may fail if the entry moved and an identical
350 ;; entry is close to the old position. Frequent rescans make this
352 (let* ((file (nth 3 data
))
353 (literal (nth 2 data
))
355 (re (regexp-quote literal
))
358 ((or (not no-revisit
)
359 (reftex-get-buffer-visiting file
))
360 (switch-to-buffer-other-window
361 (reftex-get-file-buffer-force file nil
))
362 (goto-char (or pos
(point-min)))
364 (reftex-nearest-match re
(length literal
))))
365 (t (message reftex-no-follow-message
) nil
))))
367 (goto-char (match-beginning 0))
369 (reftex-highlight 0 (match-beginning 0) (match-end 0) (current-buffer)))
372 (defun reftex-display-index (&optional tag overriding-restriction redo
374 "Display a buffer with an index compiled from the current document.
375 When the document has multiple indices, first prompts for the correct one.
376 When index support is turned off, offer to turn it on.
377 With one or two `C-u' prefixes, rescan document first.
378 With prefix 2, restrict index to current document section.
379 With prefix 3, restrict index to region."
383 ;; Ensure access to scanning info and rescan buffer if prefix are is '(4).
384 (let ((current-prefix-arg current-prefix-arg
))
385 (reftex-ensure-index-support t
)
386 (reftex-access-scan-info current-prefix-arg
))
388 (set-marker reftex-index-return-marker
(point))
389 (setq reftex-last-follow-point
1)
391 ;; Determine the correct index to process
392 (let* ((docstruct (symbol-value reftex-docstruct-symbol
))
393 (docstruct-symbol reftex-docstruct-symbol
)
394 (index-tag (or tag
(reftex-index-select-tag)))
395 (master (reftex-TeX-master-file))
396 (calling-file (buffer-file-name))
398 (or overriding-restriction
400 (reftex-get-restriction current-prefix-arg docstruct
))))
402 ;; See if we are on an index macro as initial position
404 (let* ((what-macro (reftex-what-macro-safe 1))
405 (macro (car what-macro
))
406 (here-I-am (when (member macro reftex-macros-with-index
)
408 (goto-char (+ (cdr what-macro
)
410 (reftex-move-over-touching-args)
411 (reftex-where-am-I)))))
412 (if (eq (car (car here-I-am
)) 'index
)
413 (list (car here-I-am
))))))
416 (setq buffer-name
(reftex-make-index-buffer-name index-tag
))
418 ;; Goto the buffer and put it into the correct mode
420 (when (or restriction current-prefix-arg
)
421 (reftex-kill-buffer buffer-name
))
423 (if (get-buffer-window buffer-name
)
424 (select-window (get-buffer-window buffer-name
))
425 (let ((default-major-mode 'reftex-index-mode
))
426 (switch-to-buffer buffer-name
)))
428 (or (eq major-mode
'reftex-index-mode
) (reftex-index-mode))
430 ;; If the buffer is currently restricted, empty it to force update.
431 (when reftex-index-restriction-data
432 (reftex-erase-buffer))
433 (set (make-local-variable 'reftex-last-index-file
) calling-file
)
434 (set (make-local-variable 'reftex-index-tag
) index-tag
)
435 (set (make-local-variable 'reftex-docstruct-symbol
) docstruct-symbol
)
437 (setq reftex-index-restriction-indicator
(car restriction
)
438 reftex-index-restriction-data
(cdr restriction
))
440 (setq reftex-index-restriction-indicator nil
441 reftex-index-restriction-data nil
)))
442 (when (= (buffer-size) 0)
443 ;; buffer is empty - fill it
444 (message "Building %s buffer..." buffer-name
)
446 (setq buffer-read-only nil
)
450 SPC=view TAB=goto RET=goto+hide [e]dit [q]uit [r]escan [f]ollow [?]Help
451 ------------------------------------------------------------------------------
452 " index-tag
(abbreviate-file-name master
)
453 (if (eq (car (car reftex-index-restriction-data
)) 'toc
)
454 (nth 2 (car reftex-index-restriction-data
))
455 reftex-index-restriction-indicator
)))
457 (if (reftex-use-fonts)
458 (put-text-property 1 (point) 'face reftex-index-header-face
))
459 (put-text-property 1 (point) 'intangible t
)
461 (reftex-insert-index docstruct index-tag
)
462 (goto-char (point-min))
463 (run-hooks 'reftex-display-copied-context-hook
)
464 (message "Building %s buffer...done." buffer-name
)
465 (setq buffer-read-only t
))
466 (and locations
(apply 'reftex-find-start-point
(point) locations
))
467 (if reftex-index-restriction-indicator
468 (message "Index restricted: <%s>" reftex-index-restriction-indicator
))))
470 (defun reftex-insert-index (docstruct tag
&optional update-one remark
)
471 ;; Insert an index into the current buffer. Entries are from the
473 ;; TAG is the subindex to process.
474 ;; UPDATE-ONE: When non-nil, delete the entry at point and replace
475 ;; it with whatever the DOCSTRUCT contains.
476 ;; REMARK can be a note to add to the entry.
477 (let* ((all docstruct
)
479 (context reftex-index-include-context
)
480 (context-indent (concat indent
" "))
481 (section-chars (mapcar 'identity reftex-index-section-letters
))
482 (this-section-char 0)
483 (font (reftex-use-fonts))
484 (bor (car reftex-index-restriction-data
))
485 (eor (nth 1 reftex-index-restriction-data
))
487 (if (memq reftex-highlight-selection
'(mouse both
))
488 reftex-mouse-selected-face
490 (index-face (reftex-verified-face reftex-label-face
491 'font-lock-constant-face
492 'font-lock-reference-face
))
493 sublist cell from to first-char
)
495 ;; Make the sublist and sort it
497 (setq all
(or (memq bor all
) all
)))
499 (while (setq cell
(pop all
))
502 (and (eq (car cell
) 'index
)
503 (equal (nth 1 cell
) tag
)
504 (push cell sublist
))))
505 (setq sublist
(sort (nreverse sublist
)
506 (lambda (a b
) (string< (nth 8 a
) (nth 8 b
)))))
509 ;; Delete the entry at place
510 (and (bolp) (forward-char 1))
511 (delete-region (previous-single-property-change (1+ (point)) :data
)
512 (or (next-single-property-change (point) :data
)
515 ;; Walk through the list and insert all entries
516 (while (setq cell
(pop sublist
))
518 (setq first-char
(upcase (string-to-char (nth 6 cell
))))
519 (when (and (not (equal first-char this-section-char
))
520 (member first-char section-chars
))
521 ;; There is a new initial letter, so start a new section
522 (reftex-index-insert-new-letter first-char font
)
523 (setq section-chars
(delete first-char section-chars
)
524 this-section-char first-char
))
525 (when (= this-section-char
0)
526 (setq this-section-char ?
!)
527 (reftex-index-insert-new-letter this-section-char font
)))
530 (insert indent
(nth 7 cell
))
534 (- (point) (length (nth 7 cell
))) to
538 (when (or remark
(nth 9 cell
))
539 (and (< (current-column) 40)
540 ;; FIXME: maybe this is too slow?
541 (insert (make-string (max (- 40 (current-column)) 0) ?\
)))
542 (and (nth 9 cell
) (insert " " (substring (nth 5 cell
) (nth 9 cell
))))
543 (and remark
(insert " " remark
)))
549 (insert context-indent
(nth 2 cell
) "\n")
551 (put-text-property from to
:data cell
)
553 (put-text-property from
(1- to
)
554 'mouse-face mouse-face
))
558 (defun reftex-index-insert-new-letter (letter &optional font
)
559 ;; Start a new section in the index
560 (let ((from (point)))
561 (insert "\n" letter letter letter
562 "-----------------------------------------------------------------")
564 (put-text-property from
(point) 'face reftex-index-section-face
))
567 (defun reftex-get-restriction (arg docstruct
)
568 ;; Interprete the prefix ARG and derive index restriction specs.
569 (let* ((beg (min (point) (or (condition-case nil
(mark) (error nil
))
571 (end (max (point) (or (condition-case nil
(mark) (error nil
))
573 bor eor label here-I-am
)
576 (setq here-I-am
(car (reftex-where-am-I))
577 bor
(if (eq (car here-I-am
) 'toc
)
579 (reftex-last-assoc-before-elt
580 'toc here-I-am docstruct
))
581 eor
(car (memq (assq 'toc
(cdr (memq bor docstruct
))) docstruct
))
585 (setq label
"region")
587 (setq bor
(car (reftex-where-am-I)))
588 (setq bor
(nth 1 (memq bor docstruct
)))
590 (setq eor
(nth 1 (memq (car (reftex-where-am-I)) docstruct
)))))
592 (if (and label
(or bor eor
))
596 (defun reftex-index-pre-command-hook ()
597 ;; Used as pre command hook in *Index* buffer
598 (reftex-unhighlight 0)
599 (reftex-unhighlight 1))
601 (defun reftex-index-post-command-hook ()
602 ;; Used in the post-command-hook for the *Index* buffer
603 (when (get-text-property (point) :data
)
605 (not (get-text-property (point) 'intangible
))
606 (memq reftex-highlight-selection
'(cursor both
))
608 (or (previous-single-property-change (1+ (point)) :data
)
610 (or (next-single-property-change (point) :data
)
612 (if (integerp reftex-index-follow-mode
)
613 ;; Remove delayed action
614 (setq reftex-index-follow-mode t
)
615 (and reftex-index-follow-mode
616 (not (equal reftex-last-follow-point
(point)))
617 ;; Show context in other window
618 (setq reftex-last-follow-point
(point))
620 (reftex-index-visit-location nil
(not reftex-revisit-to-follow
))
623 (defun reftex-index-show-help ()
624 "Show a summary of special key bindings."
626 (with-output-to-temp-buffer "*RefTeX Help*"
627 (princ reftex-index-help
))
628 (reftex-enlarge-to-fit "*RefTeX Help*" t
)
629 ;; If follow mode is active, arrange to delay it one command
630 (if reftex-index-follow-mode
631 (setq reftex-index-follow-mode
1)))
633 (defun reftex-index-next (&optional arg
)
634 "Move to next selectable item."
636 (setq reftex-callback-fwd t
)
637 (or (eobp) (forward-char 1))
638 (goto-char (or (next-single-property-change (point) :data
)
640 (unless (get-text-property (point) :data
)
641 (goto-char (or (next-single-property-change (point) :data
)
643 (defun reftex-index-previous (&optional arg
)
644 "Move to previous selectable item."
646 (setq reftex-callback-fwd nil
)
647 (goto-char (or (previous-single-property-change (point) :data
)
649 (unless (get-text-property (point) :data
)
650 (goto-char (or (previous-single-property-change (point) :data
)
652 (defun reftex-index-toggle-follow ()
653 "Toggle follow (other window follows with context)."
655 (setq reftex-last-follow-point -
1)
656 (setq reftex-index-follow-mode
(not reftex-index-follow-mode
)))
657 (defun reftex-index-toggle-context ()
658 "Toggle inclusion of label context in *Index* buffer.
659 Label context is only displayed when the labels are there as well."
661 (setq reftex-index-include-context
(not reftex-index-include-context
))
662 (reftex-index-revert))
663 (defun reftex-index-view-entry ()
664 "View document location in other window."
666 (reftex-index-visit-location))
667 (defun reftex-index-goto-entry-and-hide ()
668 "Go to document location in other window. Hide the *Index* window."
670 (reftex-index-visit-location 'hide
))
671 (defun reftex-index-goto-entry ()
672 "Go to document location in other window. *Index* window stays."
674 (reftex-index-visit-location t
))
675 (defun reftex-index-mouse-goto-line-and-hide (ev)
676 "Go to document location in other window. Hide the *Index* window."
679 (reftex-index-visit-location 'hide
))
680 (defun reftex-index-quit ()
681 "Hide the *Index* window and do not move point."
683 (or (one-window-p) (delete-window))
684 (switch-to-buffer (marker-buffer reftex-index-return-marker
))
685 (goto-char (or (marker-position reftex-index-return-marker
) (point))))
686 (defun reftex-index-quit-and-kill ()
687 "Kill the *Index* buffer."
689 (kill-buffer (current-buffer))
690 (or (one-window-p) (delete-window))
691 (switch-to-buffer (marker-buffer reftex-index-return-marker
))
692 (goto-char (or (marker-position reftex-index-return-marker
) (point))))
693 (defun reftex-index-goto-toc (&rest ignore
)
694 "Switch to the table of contents of the current document.
695 The function will go to the section where the entry at point was defined."
697 (if (get-text-property (point) :data
)
698 (reftex-index-goto-entry)
699 (switch-to-buffer (marker-buffer reftex-index-return-marker
)))
700 (delete-other-windows)
702 (defun reftex-index-rescan (&rest ignore
)
703 "Regenerate the *Index* buffer after reparsing file of section at point."
705 (let ((index-tag reftex-index-tag
))
706 (if (and reftex-enable-partial-scans
707 (null current-prefix-arg
))
708 (let* ((data (get-text-property (point) :data
))
710 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0))))
712 (error "Don't know which file to rescan. Try `C-u r'")
713 (switch-to-buffer (reftex-get-file-buffer-force file
))
714 (setq current-prefix-arg
'(4))
715 (reftex-display-index index-tag nil
'redo line
)))
716 (reftex-index-Rescan))
717 (reftex-kill-temporary-buffers)))
718 (defun reftex-index-Rescan (&rest ignore
)
719 "Regenerate the *Index* buffer after reparsing the entire document."
721 (let ((index-tag reftex-index-tag
)
722 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0))))
724 (reftex-get-file-buffer-force reftex-last-index-file
))
725 (setq current-prefix-arg
'(16))
726 (reftex-display-index index-tag nil
'redo line
)))
727 (defun reftex-index-revert (&rest ignore
)
728 "Regenerate the *Index* from the internal lists. No reparsing os done."
730 (let ((buf (current-buffer))
731 (index-tag reftex-index-tag
)
732 (data (get-text-property (point) :data
))
733 (line (+ (count-lines (point-min) (point)) (if (bolp) 1 0))))
735 (reftex-get-file-buffer-force reftex-last-index-file
))
736 (reftex-erase-buffer buf
)
737 (setq current-prefix-arg nil
738 reftex-last-follow-point
1)
739 (reftex-display-index index-tag nil
'redo data line
)))
740 (defun reftex-index-switch-index-tag (&rest ignore
)
741 "Switch to a different index of the same document."
744 (reftex-get-file-buffer-force reftex-last-index-file
))
745 (setq current-prefix-arg nil
)
746 (reftex-display-index nil nil
'redo
))
748 (defun reftex-index-restrict-to-section (&optional force
)
749 "Restrict index to entries defined in same document sect. as entry at point."
750 ;; Optional FORCE means, even if point is not on an index entry.
752 (let* ((data (get-text-property (point) :data
))
753 (docstruct (symbol-value reftex-docstruct-symbol
))
755 (if (and (not data
) force
)
756 (setq data
(assq 'toc docstruct
)))
758 (setq bor
(reftex-last-assoc-before-elt 'toc data docstruct
)
759 eor
(car (memq (assq 'toc
(cdr (memq bor docstruct
)))
761 reftex-index-restriction-data
(list bor eor
)
762 reftex-index-restriction-indicator
(nth 6 bor
) )))
763 (reftex-index-revert))
765 (defun reftex-index-widen (&rest ignore
)
766 "Show the unrestricted index (all entries)."
768 (setq reftex-index-restriction-indicator nil
769 reftex-index-restriction-data nil
)
770 (reftex-index-revert)
771 (message "Index widened"))
772 (defun reftex-index-restriction-forward (&rest ignore
)
773 "Restrict to previous section.
774 When index is currently unrestricted, restrict it to a section.
775 When index is restricted, select the next section as restriction criterion."
777 (let* ((docstruct (symbol-value reftex-docstruct-symbol
))
778 (bor (nth 1 reftex-index-restriction-data
)))
780 (not (eq (car bor
) 'toc
)))
781 (reftex-index-restrict-to-section t
)
782 (setq reftex-index-restriction-indicator
(nth 6 bor
)
783 reftex-index-restriction-data
785 (car (memq (assq 'toc
(cdr (memq bor docstruct
)))
787 (reftex-index-revert))))
788 (defun reftex-index-restriction-backward (&rest ignore
)
789 "Restrict to next section.
790 When index is currently unrestricted, restrict it to a section.
791 When index is restricted, select the previous section as restriction criterion."
793 (let* ((docstruct (symbol-value reftex-docstruct-symbol
))
794 (eor (car reftex-index-restriction-data
))
795 (bor (reftex-last-assoc-before-elt 'toc eor docstruct t
)))
797 (not (eq (car bor
) 'toc
)))
798 (reftex-index-restrict-to-section t
)
799 (setq reftex-index-restriction-indicator
(nth 6 bor
)
800 reftex-index-restriction-data
802 (reftex-index-revert))))
804 (defun reftex-index-visit-location (&optional final no-revisit
)
805 ;; Visit the tex file corresponding to the index entry on the current line.
806 ;; If FINAL is t, stay there
807 ;; If FINAL is 'hide, hide the *Index* window.
808 ;; Otherwise, move cursor back into *Index* window.
809 ;; NO-REVISIT means don't visit files, just use live biffers.
811 (let* ((data (get-text-property (point) :data
))
812 (index-window (selected-window))
813 show-window show-buffer match
)
815 (unless data
(error "Don't know which index entry to visit"))
817 (if (eq (car data
) 'index
)
818 (setq match
(reftex-index-show-entry data no-revisit
)))
820 (setq show-window
(selected-window)
821 show-buffer
(current-buffer))
824 (select-window index-window
)
825 (error "Cannot find location"))
827 (select-window index-window
)
829 ;; Use the `final' parameter to decide what to do next
832 (reftex-unhighlight 0)
833 (select-window show-window
))
835 (reftex-unhighlight 0)
836 (or (one-window-p) (delete-window))
837 (switch-to-buffer show-buffer
))
840 (defun reftex-index-analyze-entry (data)
841 ;; This splits the index context so that key, attribute and visual
842 ;; values are accessible individually.
844 (let* ((arg (nth 5 data
))
845 (context (nth 2 data
))
846 (sc reftex-index-special-chars
)
847 (boa (if (string-match (regexp-quote (concat "{" arg
"}")) context
)
848 (1+ (match-beginning 0))
849 (error "Something is wrong here")))
850 (eoa (1- (match-end 0)))
851 (boactual (if (string-match (concat "[^" (nth 3 sc
) "]" (nth 2 sc
))
853 (1+ (match-beginning 0))
855 (boattr (if (string-match (concat "[^" (nth 3 sc
) "]" (nth 1 sc
))
857 (1+ (match-beginning 0))
859 (pre (substring context
0 boa
))
860 (key (substring context boa boattr
))
861 (attr (substring context boattr boactual
))
862 (actual (substring context boactual eoa
))
863 (post (substring context eoa
)))
864 (list pre key attr actual post
)))
866 (defun reftex-index-edit ()
867 "Edit the index entry at point."
869 (let* ((data (get-text-property (point) :data
))
871 (unless data
(error "Don't know which index entry to edit"))
872 (reftex-index-view-entry)
873 (setq old
(nth 2 data
) new
(read-string "Edit: " old
))
874 (reftex-index-change-entry new
)))
876 (defun reftex-index-toggle-range-beginning ()
877 "Toggle the page range start attribute `|('."
879 (let* ((data (get-text-property (point) :data
))
880 (bor (concat (nth 1 reftex-index-special-chars
) "("))
882 (unless data
(error "Don't know which index entry to edit"))
883 (setq analyze
(reftex-index-analyze-entry data
)
884 attr
(nth 2 analyze
))
885 (setf (nth 2 analyze
) (if (string= attr bor
) "" bor
))
886 (setq new
(apply 'concat analyze
))
887 (reftex-index-change-entry
888 new
(if (string= (nth 2 analyze
) bor
)
889 "Entry is now START-OF-PAGE-RANGE"
890 "START-OF-PAGE-RANGE canceled"))))
892 (defun reftex-index-toggle-range-end ()
893 "Toggle the page-range-end attribute `|)'."
895 (let* ((data (get-text-property (point) :data
))
896 (eor (concat (nth 1 reftex-index-special-chars
) ")"))
898 (unless data
(error "Don't know which index entry to edit"))
899 (setq analyze
(reftex-index-analyze-entry data
)
900 attr
(nth 2 analyze
))
901 (setf (nth 2 analyze
) (if (string= attr eor
) "" eor
))
902 (setq new
(apply 'concat analyze
))
903 (reftex-index-change-entry
904 new
(if (string= (nth 2 analyze
) eor
)
905 "Entry is now END-OF-PAGE-RANGE"
906 "END-OF-PAGE-RANGE canceled"))))
908 (defun reftex-index-edit-key ()
909 "Edit the KEY part of the index entry."
911 (reftex-index-edit-part nil
1 "" "Key: " t
))
913 (defun reftex-index-edit-attribute (&optional arg
)
914 "EDIT the ATTRIBUTE part of the entry. With arg: remove entire ATTRIBUTE."
916 (reftex-index-edit-part arg
2 (nth 1 reftex-index-special-chars
)
919 (defun reftex-index-edit-visual (&optional arg
)
920 "EDIT the VISUAL part of the entry. With arg: remove entire VISUAL string."
922 (reftex-index-edit-part arg
3 (nth 2 reftex-index-special-chars
) "Visual: "))
924 (defun reftex-index-edit-part (arg n initial prompt
&optional dont-allow-empty
)
925 ;; This function does the work for all partial editing commands
926 (let* ((data (get-text-property (point) :data
))
927 new analyze opart npart
)
928 (unless data
(error "Don't know which index entry to edit"))
929 ;; Analyze the whole context string
930 (setq analyze
(reftex-index-analyze-entry data
)
931 opart
(nth n analyze
))
932 (and (> (length opart
) 0) (setq opart
(substring opart
1)))
933 ;; Have the user editing the part
934 (setq npart
(if arg
"" (read-string (concat prompt initial
) opart
)))
936 (cond ((string= npart opart
)
937 (error "Not changed"))
940 (error "Invalid value")
941 (setf (nth n analyze
) npart
)))
942 (t (setf (nth n analyze
) (concat initial npart
))))
943 (setq new
(apply 'concat analyze
))
944 ;; Change the entry and insert the changed version into the index.
945 (reftex-index-change-entry
946 new
(if (string= npart
"")
947 (format "Deleted: %s" opart
)
948 (format "New value is: %s" npart
)))))
950 (defun reftex-index-level-down ()
951 "Make index entry a subitem of another entry."
953 (let* ((data (get-text-property (point) :data
))
954 (docstruct (symbol-value reftex-docstruct-symbol
))
956 (unless data
(error "Don't know which index entry to change"))
957 (setq old
(nth 2 data
)
959 prefix
(completing-read
964 (and (eq (car x
) 'index
)
965 (string= (nth 1 x
) reftex-index-tag
))) t
)))
966 (unless (string-match
967 (concat (regexp-quote (car reftex-index-special-chars
)) "\\'")
969 (setq prefix
(concat prefix
(car reftex-index-special-chars
))))
970 (if (string-match (regexp-quote key
) old
)
971 (setq new
(replace-match (concat prefix key
) t t old
))
972 (error "Cannot construct new index key"))
973 (reftex-index-change-entry new
(format "Added prefix: %s" prefix
))))
975 (defun reftex-index-level-up ()
976 "Remove the highest level of a hierarchical index entry."
978 (let* ((data (get-text-property (point) :data
))
980 (unless data
(error "Don't know which entry to change"))
981 (setq old
(nth 2 data
))
982 (if (string-match (concat "{\\([^" (nth 0 reftex-index-special-chars
) "]*"
983 "[^" (nth 3 reftex-index-special-chars
) "]"
984 (regexp-quote (nth 0 reftex-index-special-chars
))
987 (setq prefix
(substring old
(match-beginning 1) (match-end 1))
988 new
(concat (substring old
0 (match-beginning 1))
989 (substring old
(match-end 1))))
990 (error "Entry is not a subitem"))
991 (reftex-index-change-entry new
(format "Removed prefix: %s" prefix
))))
993 (defun reftex-index-kill ()
994 "FIXME: Not yet implemented"
996 (error "This function is currently not implemented"))
998 (defun reftex-index-undo ()
999 "FIXME: Not yet implemented"
1001 (error "This function is currently not implemented"))
1003 (defun reftex-index-change-entry (new &optional message
)
1004 ;; Change the full context string of the index entry at point to
1005 ;; NEW. This actually edits the buffer where the entry is defined.
1007 (let* ((data (get-text-property (point) :data
))
1009 (unless data
(error "Cannot change entry"))
1010 (reftex-index-view-entry)
1011 (setq beg
(match-beginning 0) end
(match-end 0))
1012 (setq old
(nth 2 data
))
1013 (and (equal old new
) (error "Entry unchanged"))
1015 (set-buffer (get-file-buffer (nth 3 data
)))
1017 (unless (looking-at (regexp-quote old
))
1018 (error "This should not happen (reftex-index-change-entry)"))
1019 (delete-region beg end
)
1021 (goto-char (1- beg
))
1022 (when (and (re-search-forward (reftex-everything-regexp) nil t
)
1024 (< (abs (- (match-beginning 10) beg
)) (length new
))
1025 (setq info
(reftex-index-info-safe buffer-file-name
)))
1026 (setcdr data
(cdr info
))))
1027 (let ((buffer-read-only nil
))
1029 (reftex-insert-index (list data
) reftex-index-tag t
1031 (setq reftex-last-follow-point
1)
1032 (and message
(message "%s" message
))))
1035 (define-key reftex-index-map
(if (featurep 'xemacs
) [(button2)] [(mouse-2)])
1036 'reftex-index-mouse-goto-line-and-hide
)
1037 (define-key reftex-index-map
[follow-link
] 'mouse-face
)
1039 (substitute-key-definition
1040 'next-line
'reftex-index-next reftex-index-map global-map
)
1041 (substitute-key-definition
1042 'previous-line
'reftex-index-previous reftex-index-map global-map
)
1045 '(("n" . reftex-index-next
)
1046 ("p" . reftex-index-previous
)
1047 ("?" . reftex-index-show-help
)
1048 (" " . reftex-index-view-entry
)
1049 ("\C-m" . reftex-index-goto-entry-and-hide
)
1050 ("\C-i" . reftex-index-goto-entry
)
1051 ("\C-k" . reftex-index-kill
)
1052 ("r" . reftex-index-rescan
)
1053 ("R" . reftex-index-Rescan
)
1054 ("g" . revert-buffer
)
1055 ("q" . reftex-index-quit
)
1056 ("k" . reftex-index-quit-and-kill
)
1057 ("f" . reftex-index-toggle-follow
)
1058 ("s" . reftex-index-switch-index-tag
)
1059 ("e" . reftex-index-edit
)
1060 ("^" . reftex-index-level-up
)
1061 ("_" . reftex-index-level-down
)
1062 ("}" . reftex-index-restrict-to-section
)
1063 ("{" . reftex-index-widen
)
1064 (">" . reftex-index-restriction-forward
)
1065 ("<" . reftex-index-restriction-backward
)
1066 ("(" . reftex-index-toggle-range-beginning
)
1067 (")" . reftex-index-toggle-range-end
)
1068 ("|" . reftex-index-edit-attribute
)
1069 ("@" . reftex-index-edit-visual
)
1070 ("*" . reftex-index-edit-key
)
1071 ("\C-c=". reftex-index-goto-toc
)
1072 ("c" . reftex-index-toggle-context
))
1073 do
(define-key reftex-index-map
(car x
) (cdr x
)))
1075 (loop for key across
"0123456789" do
1076 (define-key reftex-index-map
(vector (list key
)) 'digit-argument
))
1077 (define-key reftex-index-map
"-" 'negative-argument
)
1079 ;; The capital letters and the exclamation mark
1080 (loop for key across
(concat "!" reftex-index-section-letters
) do
1081 (define-key reftex-index-map
(vector (list key
))
1082 (list 'lambda
'() '(interactive)
1083 (list 'reftex-index-goto-letter key
))))
1085 (defun reftex-index-goto-letter (char)
1086 "Go to the CHAR section in the index."
1088 (case-fold-search nil
))
1090 (if (re-search-forward (concat "^" (char-to-string char
)) nil t
)
1094 (reftex-index-next))
1097 (error "This <%s> index does not contain entries sorted before the letters"
1099 (error "This <%s> index does not contain entries starting with `%c'"
1100 reftex-index-tag char
)))))
1103 reftex-index-menu reftex-index-map
1104 "Menu for Index buffer"
1107 (message "To go to a section, just press any of: !%s"
1108 reftex-index-section-letters
) t
]
1109 ["Show Entry" reftex-index-view-entry t
]
1110 ["Go To Entry" reftex-index-goto-entry t
]
1111 ["Exit & Go To Entry" reftex-index-goto-entry-and-hide t
]
1112 ["Table of Contents" reftex-index-goto-toc t
]
1113 ["Quit" reftex-index-quit t
]
1116 ["Rebuilt *Index* Buffer" revert-buffer t
]
1118 ["Rescan One File" reftex-index-rescan reftex-enable-partial-scans
]
1119 ["Rescan Entire Document" reftex-index-Rescan t
])
1121 ["Restrict to section" reftex-index-restrict-to-section t
]
1122 ["Widen" reftex-index-widen reftex-index-restriction-indicator
]
1123 ["Next Section" reftex-index-restriction-forward
1124 reftex-index-restriction-indicator
]
1125 ["Previous Section" reftex-index-restriction-backward
1126 reftex-index-restriction-indicator
])
1128 ["Edit Entry" reftex-index-edit t
]
1129 ["Edit Key" reftex-index-edit-key t
]
1130 ["Edit Attribute" reftex-index-edit-attribute t
]
1131 ["Edit Visual" reftex-index-edit-visual t
]
1133 ["Add Parentkey" reftex-index-level-down t
]
1134 ["Remove Parentkey " reftex-index-level-up t
]
1136 ["Make Start-of-Range" reftex-index-toggle-range-beginning t
]
1137 ["Make End-of-Range" reftex-index-toggle-range-end t
]
1139 ["Kill Entry" reftex-index-kill nil
]
1141 ["Undo" reftex-index-undo nil
])
1143 ["Context" reftex-index-toggle-context
:style toggle
1144 :selected reftex-index-include-context
]
1146 ["Follow Mode" reftex-index-toggle-follow
:style toggle
1147 :selected reftex-index-follow-mode
])
1149 ["Help" reftex-index-show-help t
]))
1152 ;;----------------------------------------------------------------------
1153 ;; The Index Phrases File
1155 ;; Some constants and variables
1156 (defconst reftex-index-phrases-comment-regexp
"^[ \t]*%.*"
1157 "Regular expression to match comment lines in phrases buffer")
1158 (defconst reftex-index-phrases-macrodef-regexp
1159 "^\\(>>>INDEX_MACRO_DEFINITION:\\)[ \t]+\\(\\S-\\)\\( *\t[ \t]*\\)\\([^\t]*[^ \t]\\)\\( *\t[ \t]*\\)\\(\\S-+\\)"
1160 "Regular expression to match macro definition lines the phrases buffer.")
1161 ;(defconst reftex-index-phrases-macrodef-regexp
1162 ; "^\\(>>>INDEX_MACRO_DEFINITION:\\)[ \t]+\\(\\S-\\)\\([ \t]*\\)\\([^\t]*[^ \t]\\)\\([ \t]*\\)\\(nil\\|t\\)[ \t]*$"
1163 ; "Regular expression to match macro definition lines the phrases buffer.
1164 ;This version would allow just spaces as separators.")
1165 (defconst reftex-index-phrases-phrase-regexp1
1166 "^\\(\\S-?\\)\\(\t\\)\\([^\t\n]*\\S-\\)\\([ \t]*\\)$"
1167 "Regular expression matching phrases which have no separate index key.")
1168 (defconst reftex-index-phrases-phrase-regexp2
1169 "^\\(\\S-?\\)\\(\t\\)\\([^\t]*\\S-\\)\\(\t[ \t]*\\)\\([^\n\t]*\\S-\\)[ \t]*$"
1170 "Regular expression matching phrases which have a separate index key.")
1171 (defconst reftex-index-phrases-phrase-regexp12
1172 "^\\(\\S-?\\)\\(\t\\)\\([^\n\t]*\\S-\\)\\(\\(\t[ \t]*\\)\\([^\n\t]*\\S-\\)\\)?[ \t]*$"
1173 "Regular expression matching all types of phrase lines.")
1174 (defvar reftex-index-phrases-macro-data nil
1175 "Alist containing the information taken from the macro definition lines.
1176 This gets refreshed in every phrases command.")
1177 (defvar reftex-index-phrases-files nil
1178 "List of document files relevant for the phrases file.")
1180 (defvar reftex-index-phrases-font-lock-keywords nil
1181 "Font lock keywords for reftex-index-phrases-mode.")
1182 (defvar reftex-index-phrases-font-lock-defaults nil
1183 "Font lock defaults for reftex-index-phrases-mode.")
1184 (defvar reftex-index-phrases-map
(make-sparse-keymap)
1185 "Keymap used for *toc* buffer.")
1188 (defun reftex-index-phrase-selection-or-word (arg)
1189 "Add current selection or word at point to the phrases buffer.
1190 When you are in transient-mark-mode and the region is active, the
1191 selection will be used - otherwise the word at point.
1192 You get a chance to edit the entry in the phrases buffer - finish with
1195 (set-marker reftex-index-return-marker
(point))
1196 (reftex-index-selection-or-word arg
'phrase
)
1197 (if (eq major-mode
'reftex-index-phrases-mode
)
1199 (substitute-command-keys
1200 "Return to LaTeX with \\[reftex-index-phrases-save-and-return]"))))
1202 (defun reftex-index-visit-phrases-buffer ()
1203 "Switch to the phrases buffer, initialize if empty."
1205 (reftex-access-scan-info)
1206 (let* ((master (reftex-TeX-master-file))
1207 (name (concat (file-name-sans-extension master
)
1208 reftex-index-phrase-file-extension
)))
1210 (unless (eq major-mode
'reftex-index-phrases-mode
)
1211 (reftex-index-phrases-mode))
1212 (if (= (buffer-size) 0)
1213 (reftex-index-initialize-phrases-buffer master
))))
1215 (defun reftex-index-initialize-phrases-buffer (&optional master
)
1216 "Initialize the phrases buffer by creating the header.
1217 If the buffer is non-empty, delete the old header first."
1219 (let* ((case-fold-search t
)
1220 (default-key (car reftex-index-default-macro
))
1221 (default-macro (nth 1 (assoc default-key
1222 reftex-key-to-index-macro-alist
)))
1224 (sort (copy-sequence reftex-index-macro-alist
)
1225 (lambda (a b
) (equal (car a
) default-macro
))))
1226 macro entry key repeat
)
1228 (if master
(set (make-local-variable 'TeX-master
)
1229 (file-name-nondirectory master
)))
1231 (when (> (buffer-size) 0)
1234 (while (re-search-forward reftex-index-phrases-macrodef-regexp nil t
)
1236 (beginning-of-line 2)
1237 (if (looking-at reftex-index-phrases-comment-regexp
)
1238 (beginning-of-line 2))
1239 (while (looking-at "^[ \t]*$")
1240 (beginning-of-line 2))
1241 (cond ((fboundp 'zmacs-activate-region
) (zmacs-activate-region))
1242 ((boundp 'make-active
) (setq mark-active t
)))
1243 (if (yes-or-no-p "Delete and rebuild header? ")
1244 (delete-region (point-min) (point))))
1246 ;; Insert the mode line
1248 (format "%% -*- mode: reftex-index-phrases; TeX-master: \"%s\" -*-\n"
1249 (file-name-nondirectory (reftex-index-phrase-tex-master))))
1250 ;; Insert the macro definitions
1251 (insert "% Key Macro Format Repeat\n")
1252 (insert "%---------------------------------------------------------------------\n")
1253 (while (setq entry
(pop macro-alist
))
1254 (setq macro
(car entry
)
1255 repeat
(nth 7 entry
)
1256 key
(car (delq nil
(mapcar (lambda (x) (if (equal (nth 1 x
) macro
)
1259 reftex-key-to-index-macro-alist
))))
1260 (insert (format ">>>INDEX_MACRO_DEFINITION:\t%s\t%-20s\t%s\n"
1261 (char-to-string key
) (concat macro
"{%s}")
1262 (if repeat
"t" "nil"))))
1263 (insert "%---------------------------------------------------------------------\n\n\n")))
1266 (defun reftex-index-phrase-tex-master (&optional dir
)
1267 "Return the name of the master file associated with a phrase buffer."
1268 (if (and (boundp 'TeX-master
)
1269 (local-variable-p 'TeX-master
(current-buffer))
1270 (stringp TeX-master
))
1271 ;; We have a local variable which tells us which file to use
1272 (expand-file-name TeX-master dir
)
1274 (concat (file-name-sans-extension (buffer-file-name)) ".tex")))
1276 (defun reftex-index-phrases-save-and-return ()
1277 "Return to where the `reftex-index-phrase-selection-or-word' was called."
1280 (switch-to-buffer (marker-buffer reftex-index-return-marker
))
1281 (goto-char (or (marker-position reftex-index-return-marker
) (point))))
1284 (defvar reftex-index-phrases-menu
)
1285 (defvar reftex-index-phrases-marker
)
1286 (defvar reftex-index-phrases-restrict-file nil
)
1288 (defun reftex-index-phrases-mode ()
1289 "Major mode for managing the Index phrases of a LaTeX document.
1290 This buffer was created with RefTeX.
1292 To insert new phrases, use
1293 - `C-c \\' in the LaTeX document to copy selection or word
1294 - `\\[reftex-index-new-phrase]' in the phrases buffer.
1296 To index phrases use one of:
1298 \\[reftex-index-this-phrase] index current phrase
1299 \\[reftex-index-next-phrase] index next phrase (or N with prefix arg)
1300 \\[reftex-index-all-phrases] index all phrases
1301 \\[reftex-index-remaining-phrases] index current and following phrases
1302 \\[reftex-index-region-phrases] index the phrases in the region
1304 You can sort the phrases in this buffer with \\[reftex-index-sort-phrases].
1305 To display information about the phrase at point, use \\[reftex-index-phrases-info].
1307 For more information see the RefTeX User Manual.
1309 Here are all local bindings.
1311 \\{reftex-index-phrases-map}"
1313 (kill-all-local-variables)
1314 (setq major-mode
'reftex-index-phrases-mode
1315 mode-name
"Phrases")
1316 (use-local-map reftex-index-phrases-map
)
1317 (set (make-local-variable 'font-lock-defaults
)
1318 reftex-index-phrases-font-lock-defaults
)
1319 (easy-menu-add reftex-index-phrases-menu reftex-index-phrases-map
)
1320 (set (make-local-variable 'reftex-index-phrases-marker
) (make-marker))
1321 (run-hooks 'reftex-index-phrases-mode-hook
))
1322 (add-hook 'reftex-index-phrases-mode-hook
'turn-on-font-lock
)
1324 ;; Font Locking stuff
1325 (let ((ss (if (featurep 'xemacs
) 'secondary-selection
''secondary-selection
)))
1326 (setq reftex-index-phrases-font-lock-keywords
1328 (cons reftex-index-phrases-comment-regexp
'font-lock-comment-face
)
1329 (list reftex-index-phrases-macrodef-regexp
1330 '(1 font-lock-type-face
)
1331 '(2 font-lock-keyword-face
)
1333 '(4 font-lock-function-name-face
)
1335 '(6 font-lock-string-face
))
1336 (list reftex-index-phrases-phrase-regexp1
1337 '(1 font-lock-keyword-face
)
1339 '(3 font-lock-string-face
)
1341 (list reftex-index-phrases-phrase-regexp2
1342 '(1 font-lock-keyword-face
)
1344 '(3 font-lock-string-face
)
1346 '(5 font-lock-function-name-face
))
1348 (setq reftex-index-phrases-font-lock-defaults
1349 '((reftex-index-phrases-font-lock-keywords)
1350 nil t nil beginning-of-line
))
1351 (put 'reftex-index-phrases-mode
'font-lock-defaults
1352 reftex-index-phrases-font-lock-defaults
) ; XEmacs
1355 (defun reftex-index-next-phrase (&optional arg
)
1356 "Index the next ARG phrases in the phrases buffer."
1358 (reftex-index-phrases-parse-header t
)
1362 (if (re-search-forward reftex-index-phrases-phrase-regexp12 nil t
)
1364 (goto-char (match-beginning 0))
1365 (reftex-index-this-phrase 'slave
))
1366 (error "No more phrase lines after point"))))
1368 (defun reftex-index-this-phrase (&optional slave
)
1369 "Index the phrase in the current line.
1370 Does a global search and replace in the entire document. At each
1371 match, the user will be asked to confirm the replacement."
1373 (if (not slave
) (reftex-index-phrases-parse-header t
))
1376 (cond ((looking-at reftex-index-phrases-comment-regexp
)
1377 (if (not slave
) (error "Comment line")))
1378 ((looking-at "^[ \t]*$")
1379 (if (not slave
) (error "Empty line")))
1380 ((looking-at reftex-index-phrases-macrodef-regexp
)
1381 (if (not slave
) (error "Macro definition line")))
1382 ((looking-at reftex-index-phrases-phrase-regexp12
)
1384 (let* ((char (if (not (equal (match-string 1) ""))
1385 (string-to-char (match-string 1))))
1386 (phrase (match-string 3))
1387 (index-key (match-string 6))
1388 (macro-data (cdr (if (null char
)
1389 (car reftex-index-phrases-macro-data
)
1390 (assoc char reftex-index-phrases-macro-data
))))
1391 (macro-fmt (car macro-data
))
1392 (repeat (nth 1 macro-data
))
1394 (cond ((and (stringp reftex-index-phrases-restrict-file
)
1395 (file-regular-p reftex-index-phrases-restrict-file
))
1396 (list reftex-index-phrases-restrict-file
))
1397 ((stringp reftex-index-phrases-restrict-file
)
1398 (error "Invalid restriction file %s"
1399 reftex-index-phrases-restrict-file
))
1400 (t reftex-index-phrases-files
)))
1401 (as-words reftex-index-phrases-search-whole-words
))
1403 (error "No macro associated with key %c" char
))
1405 (let ((overlay-arrow-string "=>")
1406 (overlay-arrow-position
1407 reftex-index-phrases-marker
)
1409 ;; Show the overlay arrow
1410 (move-marker reftex-index-phrases-marker
1411 (match-beginning 0) (current-buffer))
1412 ;; Start the query-replace
1413 (reftex-query-index-phrase-globally
1414 files phrase macro-fmt
1415 index-key repeat as-words
)
1416 (message "%s replaced"
1417 (reftex-number replace-count
"occurrence"))))))
1418 (t (error "Cannot parse this line")))))
1420 (defun reftex-index-all-phrases ()
1421 "Index all phrases in the phrases buffer.
1422 Calls `reftex-index-this-phrase' on each line in the buffer."
1424 (reftex-index-region-phrases (point-min) (point-max)))
1426 (defun reftex-index-remaining-phrases ()
1427 "Index all phrases in the phrases buffer.
1428 Calls `reftex-index-this-phrase' on each line ay and below point in
1432 (reftex-index-region-phrases (point) (point-max)))
1434 (defun reftex-index-region-phrases (beg end
)
1435 "Index all phrases in the phrases buffer.
1436 Calls `reftex-index-this-phrase' on each line in the region."
1438 (reftex-index-phrases-parse-header t
)
1440 (while (not (or (eobp)
1442 (save-excursion (reftex-index-this-phrase 'slave
))
1443 (beginning-of-line 2)))
1445 (defun reftex-index-phrases-parse-header (&optional get-files
)
1446 "Parse the header of a phrases file to extract the macro definitions.
1447 The definitions get stored in `reftex-index-phrases-macro-data'.
1448 Also switches to the LaTeX document to find out which files belong to
1449 the document and stores the list in `reftex-index-phrases-files'."
1450 (let* ((master (reftex-index-phrase-tex-master))
1453 ;; Get the file list
1455 (setq buf
(reftex-get-file-buffer-force master
))
1456 (unless buf
(error "Master file %s not found" master
))
1458 (reftex-access-scan-info)
1459 (setq reftex-index-phrases-files
1460 (reftex-all-document-files))))
1461 ;; Parse the files header for macro definitions
1462 (setq reftex-index-phrases-macro-data nil
)
1464 (goto-char (point-min))
1465 (while (re-search-forward reftex-index-phrases-macrodef-regexp nil t
)
1467 (string-to-char (match-string 2))
1469 (equal (match-string 6) "t"))
1470 reftex-index-phrases-macro-data
))
1471 ;; Reverse the list, so that the first macro is first
1472 (if (null reftex-index-phrases-macro-data
)
1473 (error "No valid MACRO DEFINITION line in %s file (make sure to use TAB separators)" reftex-index-phrase-file-extension
))
1474 (setq reftex-index-phrases-macro-data
1475 (nreverse reftex-index-phrases-macro-data
))
1476 (goto-char (point-min)))))
1478 (defun reftex-index-phrases-apply-to-region (beg end
)
1479 "Index all index phrases in the current region.
1480 This works exactly like global indexing from the index phrases buffer,
1481 but operation is restricted to the current region. This is useful if
1482 you need to add/change text in an already indexed document and want to
1483 index the new part without having to go over the unchanged parts again."
1485 (let ((win-conf (current-window-configuration))
1486 (reftex-index-phrases-restrict-file (buffer-file-name)))
1489 (narrow-to-region beg end
)
1492 ;; Hide the region highlighting
1493 (cond ((fboundp 'zmacs-deactivate-region
) (zmacs-deactivate-region))
1494 ((fboundp 'deactivate-mark
) (deactivate-mark)))
1495 (delete-other-windows)
1496 (reftex-index-visit-phrases-buffer)
1497 (reftex-index-all-phrases))
1498 (set-window-configuration win-conf
))))))
1500 (defun reftex-index-new-phrase (&optional text
)
1501 "Open a new line in the phrases buffer, insert TEXT."
1503 (if (and text
(stringp text
))
1505 ;; Check if the phrase is already in the buffer
1506 (setq text
(reftex-index-simplify-phrase text
))
1507 (goto-char (point-min))
1508 (if (re-search-forward
1509 (concat "^\\(\\S-*\\)\t\\(" (regexp-quote text
)
1510 "\\) *[\t\n]") nil t
)
1512 (goto-char (match-end 2))
1513 (error "Phrase is already in phrases buffer")))))
1514 ;; Add the new phrase line after the last in the buffer
1515 (goto-char (point-max))
1516 (if (re-search-backward reftex-index-phrases-phrase-regexp12 nil t
)
1521 (if (and text
(stringp text
))
1524 (defun reftex-index-find-next-conflict-phrase (&optional arg
)
1525 "Find the next a phrase which is has conflicts in the phrase buffer.
1526 The command helps to find possible conflicts in the phrase indexing process.
1527 It searches downward from point for a phrase which is repeated elsewhere
1528 in the buffer, or which is a subphrase of another phrase. If such a
1529 phrase is found, the phrase info is displayed.
1530 To check the whole buffer, start at the beginning and continue by calling
1531 this function repeatedly."
1534 (while (re-search-forward reftex-index-phrases-phrase-regexp12 nil t
)
1535 (goto-char (match-beginning 3))
1536 (let* ((phrase (match-string 3))
1537 (case-fold-search reftex-index-phrases-case-fold-search
)
1538 (re (reftex-index-phrases-find-dup-re phrase t
)))
1540 (goto-char (point-min))
1541 (and (re-search-forward re nil t
)
1542 (re-search-forward re nil t
)))
1545 (reftex-index-phrases-info)
1546 (message "Phrase with match conflict discovered"))
1547 (goto-char (point-max))
1548 (error "No further problematic phrases found")))
1550 (defun reftex-index-phrases-info ()
1551 "Display information about the phrase at point."
1555 (unless (looking-at reftex-index-phrases-phrase-regexp12
)
1556 (error "Not a phrase line"))
1557 (save-match-data (reftex-index-phrases-parse-header t
))
1558 (let* ((char (if (not (equal (match-string 1) ""))
1559 (string-to-char (match-string 1))))
1560 (phrase (match-string 3))
1561 (index-key (match-string 6))
1562 (index-keys (split-string
1563 (or index-key phrase
)
1564 reftex-index-phrases-logical-or-regexp
))
1565 (macro-data (cdr (if (null char
)
1566 (car reftex-index-phrases-macro-data
)
1567 (assoc char reftex-index-phrases-macro-data
))))
1568 (macro-fmt (car macro-data
))
1569 (repeat (nth 1 macro-data
))
1570 (as-words reftex-index-phrases-search-whole-words
)
1571 (example (reftex-index-make-replace-string
1572 macro-fmt
(downcase phrase
) (car index-keys
) repeat
))
1573 (re (reftex-index-make-phrase-regexp phrase as-words t
))
1574 (re1 (reftex-index-phrases-find-dup-re phrase
))
1575 (re2 (reftex-index-phrases-find-dup-re phrase
'sub
))
1580 (case-fold-search reftex-index-phrases-case-fold-search
)
1582 (setq files reftex-index-phrases-files
)
1586 (goto-char (point-min))
1587 (while (re-search-forward re1 nil t
)
1589 (goto-char (point-min))
1590 (while (re-search-forward re2 nil t
)
1591 (push (cons (count-lines 1 (point)) (match-string 1)) superphrases
)
1594 (while (setq file
(pop files
))
1595 (setq buf
(reftex-get-file-buffer-force file
))
1601 (goto-char (point-min))
1602 (let ((case-fold-search reftex-index-phrases-case-fold-search
))
1603 (while (re-search-forward re nil t
)
1604 (or (reftex-in-comment)
1605 (incf nmatches
)))))))))
1606 (with-output-to-temp-buffer "*Help*"
1607 (princ (format " Phrase: %s\n" phrase
))
1608 (princ (format " Macro key: %s\n" char
))
1609 (princ (format " Macro format: %s\n" macro-fmt
))
1610 (princ (format " Repeat: %s\n" repeat
))
1613 (let ((iks index-keys
) (cnt 0) ik
)
1614 (while (setq ik
(pop iks
))
1615 (princ (format "Index entry %d: %s\n" (incf cnt
) ik
)))))
1617 (princ (format " Index entry: %s\n" phrase
)))
1619 (princ (format " Index key: <<Given by the match>>\n"))))
1620 (princ (format " Example: %s\n" example
))
1622 (princ (format "Total matches: %s in %s\n"
1623 (reftex-number nmatches
"match" "es")
1624 (reftex-number (length reftex-index-phrases-files
)
1626 (princ (format " Uniqueness: Phrase occurs %s in phrase buffer\n"
1627 (reftex-number ntimes1
"time")))
1630 (princ (format " Superphrases: Phrase matches the following %s in the phrase buffer:\n"
1631 (reftex-number ntimes2
"line")))
1633 (princ (format " Line %4d: %s\n" (car x
) (cdr x
))))
1634 (nreverse superphrases
))))))))
1636 (defun reftex-index-phrases-set-macro-key ()
1637 "Change the macro key for the current line.
1638 Prompts for a macro key and insert is at the beginning of the line.
1639 If you reply with SPACE, the macro keyn will be removed, so that the
1640 default macro will be used. If you reply with `RET', just prints
1641 information about the currently selected macro."
1643 (reftex-index-phrases-parse-header)
1646 (unless (or (looking-at reftex-index-phrases-phrase-regexp12
)
1648 (error "This is not a phrase line"))
1649 (let* ((nc (reftex-index-select-phrases-macro 0))
1650 (macro-data (assoc nc reftex-index-phrases-macro-data
))
1655 macro-data
(car reftex-index-phrases-macro-data
)))
1657 (setq nc
(char-after (point)))
1660 macro-data
(car reftex-index-phrases-macro-data
))
1661 (setq macro-data
(assoc nc reftex-index-phrases-macro-data
))))
1662 (t (error "No macro associated with %c" nc
)))
1664 (setq macro-fmt
(nth 1 macro-data
)
1665 repeat
(nth 2 macro-data
))
1668 (if (looking-at "[^\t]") (delete-char 1))
1670 (message "Line will use %s %s repeat" macro-fmt
1671 (if repeat
"with" "without")))
1674 (defun reftex-index-sort-phrases (&optional chars-first
)
1675 "Sort the phrases lines in the buffer alphabetically.
1676 Normally, this looks only at the phrases. With a prefix arg CHARS-FIRST,
1677 it first compares the macro identifying chars and then the phrases."
1679 ;; Remember the current line, so that we can return
1680 (let ((line (buffer-substring (progn (beginning-of-line) (point))
1681 (progn (end-of-line) (point))))
1683 (goto-char (point-min))
1684 ;; Find first and last phrase line in buffer
1686 (and (re-search-forward reftex-index-phrases-phrase-regexp12 nil t
)
1687 (match-beginning 0)))
1688 (goto-char (point-max))
1689 (setq end
(re-search-backward reftex-index-phrases-phrase-regexp12 nil t
))
1690 (if end
(setq end
(progn (goto-char end
) (end-of-line) (point))))
1691 ;; Take the lines, sort them and re-insert.
1694 (message "Sorting lines...")
1695 (let* ((lines (split-string (buffer-substring beg end
) "\n"))
1696 (lines1 (sort lines
'reftex-compare-phrase-lines
)))
1697 (message "Sorting lines...done")
1698 (let ((inhibit-quit t
)) ;; make sure we do not loose lines
1699 (delete-region beg end
)
1700 (insert (mapconcat 'identity lines1
"\n"))))
1701 (goto-char (point-max))
1702 (re-search-backward (concat "^" (regexp-quote line
) "$") nil t
))
1703 (error "Cannot find phrases lines to sort"))))
1705 (defvar chars-first
)
1706 (defun reftex-compare-phrase-lines (a b
)
1707 "The comparison function used for sorting."
1708 (let (ca cb pa pb c-p p-p
)
1709 (if (string-match reftex-index-phrases-phrase-regexp12 a
)
1711 ;; Extract macro char and phrase-or-key for a
1712 (setq ca
(match-string 1 a
)
1714 (or (and reftex-index-phrases-sort-prefers-entry
1716 (match-string 3 a
))))
1717 (if (string-match reftex-index-phrases-phrase-regexp12 b
)
1719 ;; Extract macro char and phrase-or-key for b
1720 (setq cb
(match-string 1 b
)
1722 (or (and reftex-index-phrases-sort-prefers-entry
1724 (match-string 3 b
))))
1725 (setq c-p
(string< ca cb
)
1726 p-p
(string< pa pb
))
1727 ;; Do the right comparison, based on the value of `chars-first'
1728 ;; `chars-first' is bound locally in the calling function
1730 (if (string= ca cb
) p-p c-p
)
1731 (if (string= pa pb
) c-p p-p
)))))
1732 ;; If line a does not match, the answer we return determines
1733 ;; if non-matching lines are collected at the beginning.
1734 ;; When we return t here, non-matching lines form
1735 ;; block separators for searches.
1736 (not reftex-index-phrases-sort-in-blocks
))))
1738 (defvar reftex-index-phrases-menu
)
1739 (defun reftex-index-make-phrase-regexp (phrase &optional
1740 as-words allow-newline
)
1741 "Return a regexp matching PHRASE, even if distributed over lines.
1742 With optional arg AS-WORDS, require word boundary at beginning and end.
1743 With optional arg ALLOW-NEWLINE, allow single newline between words."
1744 (let* ((words (split-string phrase
))
1745 (space-re (if allow-newline
1746 "\\([ \t]*\\(\n[ \t]*\\)?\\|[ \t]\\)"
1748 (concat (if (and as-words
(string-match "\\`\\w" (car words
)))
1749 "\\(\\<\\|[`']\\)" "")
1750 (mapconcat (lambda (w) (regexp-quote
1751 (if reftex-index-phrases-case-fold-search
1756 (string-match "\\w\\'" (nth (1- (length words
)) words
)))
1757 "\\(\\>\\|'\\)" ""))))
1759 (defun reftex-index-simplify-phrase (phrase)
1760 "Make phrase single spaces and single line."
1761 (mapconcat 'identity
(split-string phrase
) " "))
1763 (defun reftex-index-phrases-find-dup-re (phrase &optional sub
)
1764 "Return a regexp which matches variations of PHRASE (with additional space).
1765 When SUB ins non-nil, the regexp will also match when PHRASE is a subphrase
1766 of another phrase. The regexp works lonly in the phrase buffer."
1767 (concat (if sub
"^\\S-?\t\\([^\t\n]*" "^\\S-?\t")
1768 (mapconcat 'regexp-quote
(split-string phrase
) " +")
1769 (if sub
"[^\t\n]*\\)\\([\t\n]\\|$\\)" " *\\([\t\n]\\|$\\)")))
1771 (defun reftex-index-make-replace-string (macro-fmt match index-key
1772 &optional repeat mathp
)
1773 "Return the string which can be used as replacement.
1774 Treats the logical `and' for index phrases."
1775 (let ((index-keys (split-string (or index-key match
)
1776 reftex-index-phrases-logical-and-regexp
)))
1778 (mapconcat (lambda (x)
1780 (format (if mathp reftex-index-math-format
"%s") x
)))
1782 (if repeat
(reftex-index-simplify-phrase match
) ""))))
1784 (defun reftex-query-index-phrase-globally (files &rest args
)
1785 "Call `reftex-query-index-phrase' for all files in FILES."
1786 (let ((win-conf (current-window-configuration))
1788 (unless files
(error "No files"))
1791 (switch-to-buffer-other-window (reftex-get-file-buffer-force
1793 (catch 'no-more-files
1794 (while (setq file
(pop files
))
1795 (switch-to-buffer (reftex-get-file-buffer-force file
))
1798 (unless (stringp reftex-index-phrases-restrict-file
)
1800 (goto-char (point-min))
1801 (apply 'reftex-query-index-phrase args
))))))
1802 (reftex-unhighlight 0)
1803 (set-window-configuration win-conf
))))
1805 (defconst reftex-index-phrases-help
1806 " Keys for query-index search
1807 ===========================
1808 y Replace this match
1810 ! Replace this and all further matches in this file
1811 q / Q Skip match, start next file / start next phrase
1812 o Use a different indexing macro for this match
1813 1 - 9 Select one of the multiple phrases
1814 e Edit the replacement text
1816 s / S Save this buffer / Save all document buffers
1818 "The help string for indexing phrases.")
1820 (defvar replace-count
)
1821 (defun reftex-query-index-phrase (phrase macro-fmt
&optional
1822 index-key repeat as-words
)
1823 "Search through buffer for PHRASE, and offer to replace it with an indexed
1824 version. The index version is derived by applying `format' with MACRO-FMT
1825 to INDEX-KEY or PHRASE. When REPEAT is non-nil, the PHRASE is inserted
1826 again after the macro.
1827 AS-WORDS means, the search for PHRASE should require word boundaries at
1829 (let* ((re (reftex-index-make-phrase-regexp phrase as-words
'allow-newline
))
1830 (case-fold-search reftex-index-phrases-case-fold-search
)
1831 (index-keys (split-string
1832 (or index-key phrase
)
1833 reftex-index-phrases-logical-or-regexp
))
1834 (nkeys (length index-keys
))
1835 (ckey (nth 0 index-keys
))
1837 match rpl char
(beg (make-marker)) (end (make-marker)) mathp
)
1841 (while (re-search-forward re nil t
)
1843 (if (reftex-in-comment)
1844 (throw 'next-match nil
))
1845 (if (and (fboundp reftex-index-verify-function
)
1846 (not (funcall reftex-index-verify-function
)))
1847 (throw 'next-match nil
))
1848 (setq match
(match-string 0))
1851 (condition-case nil
(texmathp) (error nil
))))
1852 (setq beg
(move-marker beg
(match-beginning 0))
1853 end
(move-marker end
(match-end 0)))
1854 (if (and reftex-index-phrases-skip-indexed-matches
1856 (reftex-index-phrase-match-is-indexed beg
1858 (throw 'next-match nil
))
1859 (reftex-highlight 0 (match-beginning 0) (match-end 0))
1862 (reftex-index-make-replace-string
1863 macro-fmt
(match-string 0) ckey repeat mathp
)))
1867 (message "REPLACE: %s? (yn!qoe%s?)"
1870 (concat "1-" (int-to-string nkeys
))
1872 (setq char
(if all-yes ?y
(read-char-exclusive)))
1873 (cond ((member char
'(?y ?Y ?\
))
1875 (replace-match rpl t t
)
1876 (incf replace-count
)
1877 ;; See if we should insert newlines to shorten lines
1878 (and reftex-index-phrases-wrap-long-lines
1879 (reftex-index-phrases-fixup-line beg end
))
1881 ((member char
'(?n ?N ?\C-h ?\C-?
));; FIXME: DEL
1885 ;; Yes for all in this buffer
1888 ;; Stop this one in this file
1889 (goto-char (point-max))
1893 (throw 'no-more-files t
))
1897 (reftex-save-all-document-buffers))
1900 ((member char
'(?o ?O
))
1901 ;; Select a differnt macro
1902 (let* ((nc (reftex-index-select-phrases-macro 2))
1904 (cdr (assoc nc reftex-index-phrases-macro-data
)))
1905 (macro-fmt (car macro-data
))
1906 (repeat (nth 1 macro-data
)))
1908 (setq rpl
(save-match-data
1909 (reftex-index-make-replace-string
1911 ckey repeat mathp
)))
1915 (with-output-to-temp-buffer "*Help*"
1916 (princ reftex-index-phrases-help
)))
1922 (substitute-command-keys
1923 "Recursive edit. Resume with \\[exit-recursive-edit]"))
1926 (setq rpl
(read-string "Edit: " rpl
)))
1928 (setq ckey
(or index-key phrase
)
1929 rpl
(save-match-data
1930 (reftex-index-make-replace-string
1931 macro-fmt match ckey repeat mathp
))))
1933 (<= char
(+ ?
0 nkeys
)))
1934 (setq ckey
(nth (1- (- char ?
0)) index-keys
)
1935 rpl
(save-match-data
1936 (reftex-index-make-replace-string
1937 macro-fmt match ckey repeat mathp
))))
1941 (move-marker beg nil
)
1942 (move-marker end nil
)
1944 (reftex-unhighlight 0))))
1946 (defun reftex-index-phrase-match-is-indexed (beg end
)
1947 ;; Check if match is in an argument of an index macro, or if an
1948 ;; index macro is directly attached to the match.
1951 (let* ((all-macros (reftex-what-macro t
))
1952 ; (this-macro (car (car all-macros)))
1955 (goto-char (1- beg
))
1956 (memq (char-after (point)) '(?\
] ?\
}))
1957 (car (reftex-what-macro 1))))
1959 (and (goto-char end
)
1960 (looking-at "\\(\\\\[a-zA-Z]+\\*?\\)[[{]")
1964 (while (setq macro
(pop all-macros
))
1965 (if (member (car macro
) reftex-macros-with-index
)
1966 (throw 'matched t
)))
1969 (member before-macro reftex-macros-with-index
))
1971 (member after-macro reftex-macros-with-index
))))))
1973 (defun reftex-index-phrases-fixup-line (beg end
)
1974 "Insert newlines before BEG and/or after END to shorten line."
1975 (let (bol eol space1 space2
)
1977 ;; Find line boundaries and possible line breaks near BEG and END
1983 (skip-chars-backward "^ \n")
1984 (if (and (equal (preceding-char) ?\
)
1985 (string-match "\\S-" (buffer-substring bol
(point))))
1986 (setq space1
(1- (point))))
1988 (skip-chars-forward "^ \n")
1989 (if (and (equal (following-char) ?\
)
1990 (string-match "\\S-" (buffer-substring (point) eol
)))
1991 (setq space2
(point)))
1992 ;; Now check what we have and insert the newlines
1993 (if (<= (- eol bol
) fill-column
)
1994 ;; Line is already short
1997 ((and (not space1
) (not space2
))) ; No spaces available
1998 ((not space2
) ; Do space1
1999 (reftex-index-phrases-replace-space space1
))
2000 ((not space1
) ; Do space2
2001 (reftex-index-phrases-replace-space space2
))
2002 (t ; We have both spaces
2003 (let ((l1 (- space1 bol
))
2004 (l2 (- space2 space1
))
2005 (l3 (- eol space2
)))
2006 (if (> l2 fill-column
)
2007 ;; The central part alone is more than one line
2009 (reftex-index-phrases-replace-space space1
)
2010 (reftex-index-phrases-replace-space space2
))
2011 (if (> (+ l1 l2
) fill-column
)
2012 ;; Need to split beginning
2013 (reftex-index-phrases-replace-space space1
))
2014 (if (> (+ l2 l3
) fill-column
)
2015 ;; Need to split end
2016 (reftex-index-phrases-replace-space space2
))))))))))
2018 (defun reftex-index-phrases-replace-space (pos)
2019 "If there is a space at POS, replace it with a newline char.
2020 Does not do a save-excursion."
2021 (when (equal (char-after pos
) ?\
)
2026 (defun reftex-index-select-phrases-macro (&optional delay
)
2027 "Offer a list of possible index macros and have the user select one."
2028 (let* ((prompt (concat "Select macro: ["
2029 (mapconcat (lambda (x) (char-to-string (car x
)))
2030 reftex-index-phrases-macro-data
"")
2032 (help (concat "Select an indexing macro\n========================\n"
2033 (mapconcat (lambda (x)
2036 reftex-index-phrases-macro-data
"\n"))))
2037 (reftex-select-with-char prompt help delay
)))
2039 ;; Keybindings and Menu for phrases buffer
2042 '(("\C-c\C-c" . reftex-index-phrases-save-and-return
)
2043 ("\C-c\C-x" . reftex-index-this-phrase
)
2044 ("\C-c\C-f" . reftex-index-next-phrase
)
2045 ("\C-c\C-r" . reftex-index-region-phrases
)
2046 ("\C-c\C-a" . reftex-index-all-phrases
)
2047 ("\C-c\C-d" . reftex-index-remaining-phrases
)
2048 ("\C-c\C-s" . reftex-index-sort-phrases
)
2049 ("\C-c\C-n" . reftex-index-new-phrase
)
2050 ("\C-c\C-m" . reftex-index-phrases-set-macro-key
)
2051 ("\C-c\C-i" . reftex-index-phrases-info
)
2052 ("\C-c\C-t" . reftex-index-find-next-conflict-phrase
)
2053 ("\C-i" . self-insert-command
))
2054 do
(define-key reftex-index-phrases-map
(car x
) (cdr x
)))
2057 reftex-index-phrases-menu reftex-index-phrases-map
2058 "Menu for Phrases buffer"
2060 ["New Phrase" reftex-index-new-phrase t
]
2061 ["Set Phrase Macro" reftex-index-phrases-set-macro-key t
]
2062 ["Recreate File Header" reftex-index-initialize-phrases-buffer t
]
2065 ["Sort" reftex-index-sort-phrases t
]
2068 ["by Search Phrase" (setq reftex-index-phrases-sort-prefers-entry nil
)
2069 :style radio
:selected
(not reftex-index-phrases-sort-prefers-entry
)]
2070 ["by Index Entry" (setq reftex-index-phrases-sort-prefers-entry t
)
2071 :style radio
:selected reftex-index-phrases-sort-prefers-entry
]
2072 ["in Blocks" (setq reftex-index-phrases-sort-in-blocks
2073 (not reftex-index-phrases-sort-in-blocks
))
2074 :style toggle
:selected reftex-index-phrases-sort-in-blocks
])
2075 ["Describe Phrase" reftex-index-phrases-info t
]
2076 ["Next Phrase Conflict" reftex-index-find-next-conflict-phrase t
]
2078 ("Find and Index in Document"
2079 ["Current Phrase" reftex-index-this-phrase t
]
2080 ["Next Phrase" reftex-index-next-phrase t
]
2081 ["Current and Following" reftex-index-remaining-phrases t
]
2082 ["Region Phrases" reftex-index-region-phrases t
]
2083 ["All Phrases" reftex-index-all-phrases t
]
2086 ["Match Whole Words" (setq reftex-index-phrases-search-whole-words
2087 (not reftex-index-phrases-search-whole-words
))
2088 :style toggle
:selected reftex-index-phrases-search-whole-words
]
2089 ["Case Sensitive Search" (setq reftex-index-phrases-case-fold-search
2090 (not reftex-index-phrases-case-fold-search
))
2091 :style toggle
:selected
(not
2092 reftex-index-phrases-case-fold-search
)]
2093 ["Wrap Long Lines" (setq reftex-index-phrases-wrap-long-lines
2094 (not reftex-index-phrases-wrap-long-lines
))
2095 :style toggle
:selected reftex-index-phrases-wrap-long-lines
]
2096 ["Skip Indexed Matches" (setq reftex-index-phrases-skip-indexed-matches
2097 (not reftex-index-phrases-skip-indexed-matches
))
2098 :style toggle
:selected reftex-index-phrases-skip-indexed-matches
])
2100 ["Save and Return" reftex-index-phrases-save-and-return t
]))
2103 ;;; arch-tag: 4b2362af-c156-42c1-8932-ea2823e205c1
2104 ;;; reftex-index.el ends here