1 ;;; reftex-cite.el --- creating citations with RefTeX
2 ;; Copyright (c) 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
4 ;; Author: Carsten Dominik <dominik@science.uva.nl>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
28 (eval-when-compile (require 'cl))
29 (provide 'reftex-cite)
33 ;; Variables and constants
35 ;; The history list of regular expressions used for citations
36 (defvar reftex-cite-regexp-hist nil)
38 ;; Prompt and help string for citation selection
39 (defconst reftex-citation-prompt
40 "Select: [n]ext [p]revious [r]estrict [ ]full_entry [q]uit RET [?]Help+more")
42 (defconst reftex-citation-help
43 " n / p Go to next/previous entry (Cursor motion works as well).
44 g / r Start over with new regexp / Refine with additional regexp.
45 SPC Show full database entry in other window.
46 f Toggle follow mode: Other window will follow with full db entry.
47 . Show insertion point.
48 q Quit without inserting \\cite macro into buffer.
49 TAB Enter citation key with completion.
50 RET Accept current entry (also on mouse-2) and create \\cite macro.
51 m / u Mark/Unmark the entry.
52 a / A Put all (marked) entries into one/many \\cite commands.")
57 (defmacro reftex-with-special-syntax-for-bib (&rest body)
58 `(let ((saved-syntax (syntax-table)))
61 (set-syntax-table reftex-syntax-table-for-bib)
63 (set-syntax-table saved-syntax))))
65 (defun reftex-default-bibliography ()
66 ;; Return the expanded value of `reftex-default-bibliography'.
67 ;; The expanded value is cached.
68 (unless (eq (get 'reftex-default-bibliography :reftex-raw)
69 reftex-default-bibliography)
70 (put 'reftex-default-bibliography :reftex-expanded
71 (reftex-locate-bibliography-files
72 default-directory reftex-default-bibliography))
73 (put 'reftex-default-bibliography :reftex-raw
74 reftex-default-bibliography))
75 (get 'reftex-default-bibliography :reftex-expanded))
77 (defun reftex-bib-or-thebib ()
78 ;; Tests if BibTeX or \begin{tehbibliography} should be used for the
80 ;; Find the bof of the current file
81 (let* ((docstruct (symbol-value reftex-docstruct-symbol))
82 (rest (or (member (list 'bof (buffer-file-name)) docstruct)
84 (bib (assq 'bib rest))
85 (thebib (assq 'thebib rest))
86 (bibmem (memq bib rest))
87 (thebibmem (memq thebib rest)))
88 (when (not (or thebib bib))
89 (setq bib (assq 'bib docstruct)
90 thebib (assq 'thebib docstruct)
91 bibmem (memq bib docstruct)
92 thebibmem (memq thebib docstruct)))
93 (if (> (length bibmem) (length thebibmem))
95 (if thebib 'thebib nil))))
97 (defun reftex-get-bibfile-list ()
98 ;; Return list of bibfiles for current document.
99 ;; When using the chapterbib or bibunits package you should either
100 ;; use the same database files everywhere, or separate parts using
101 ;; different databases into different files (included into the mater file).
102 ;; Then this function will return the applicable database files.
104 ;; Ensure access to scanning info
105 (reftex-access-scan-info)
107 ;; Try inside this file (and its includes)
108 (cdr (reftex-last-assoc-before-elt
109 'bib (list 'eof (buffer-file-name))
110 (member (list 'bof (buffer-file-name))
111 (symbol-value reftex-docstruct-symbol))))
112 ;; Try after the beginning of this file
113 (cdr (assq 'bib (member (list 'bof (buffer-file-name))
114 (symbol-value reftex-docstruct-symbol))))
115 ;; Anywhere in the entire document
116 (cdr (assq 'bib (symbol-value reftex-docstruct-symbol)))
117 (error "\\bibliography statement missing or .bib files not found")))
119 ;; Find a certain reference in any of the BibTeX files.
121 (defun reftex-pop-to-bibtex-entry (key file-list &optional mark-to-kill
122 highlight item return)
123 ;; Find BibTeX KEY in any file in FILE-LIST in another window.
124 ;; If MARK-TO-KILL is non-nil, mark new buffer to kill.
125 ;; If HIGHLIGHT is non-nil, highlight the match.
126 ;; If ITEM in non-nil, search for bibitem instead of database entry.
127 ;; If RETURN is non-nil, just return the entry.
131 (concat "\\\\bibitem\\(\\[[^]]*\\]\\)?{" (regexp-quote key) "}")
132 (concat "@[a-zA-Z]+[ \t\n\r]*[{(][ \t\n\r]*" (regexp-quote key)
134 (buffer-conf (current-buffer))
139 (setq file (car file-list)
140 file-list (cdr file-list))
141 (unless (setq buf (reftex-get-file-buffer-force file mark-to-kill))
142 (error "No such file %s" file))
145 (goto-char (point-min))
146 (when (re-search-forward re nil t)
147 (goto-char (match-beginning 0))
150 ;; Just return the relevant entry
151 (if item (goto-char (match-end 0)))
152 (setq return (buffer-substring
153 (point) (reftex-end-of-bib-entry item)))
154 (set-buffer buffer-conf)
155 (throw 'exit return))
156 (switch-to-buffer-other-window buf)
160 (reftex-highlight 0 (match-beginning 0) (match-end 0)))
161 (throw 'exit (selected-window))))
162 (set-buffer buffer-conf)
164 (error "No \\bibitem with citation key %s" key)
165 (error "No BibTeX entry with citation key %s" key)))))
167 (defun reftex-end-of-bib-entry (item)
173 "\\\\bibitem\\|\\end{thebibliography}")
174 (1- (match-beginning 0)))
175 (progn (forward-list 1) (point)))
176 (error (min (point-max) (+ 300 (point)))))))
178 ;; Parse bibtex buffers
180 (defun reftex-extract-bib-entries (buffers)
181 ;; Extract bib entries which match regexps from BUFFERS.
182 ;; BUFFERS is a list of buffers or file names.
183 ;; Return list with entries."
184 (let* (re-list first-re rest-re
185 (buffer-list (if (listp buffers) buffers (list buffers)))
186 found-list entry buffer1 buffer alist
187 key-point start-point end-point default)
189 ;; Read a regexp, completing on known citation keys.
190 (setq default (regexp-quote (reftex-get-bibkey-default)))
195 "Regex { && Regex...}: "
198 (if (fboundp 'LaTeX-bibitem-list)
200 (cdr (assoc 'bibview-cache
201 (symbol-value reftex-docstruct-symbol))))
203 nil nil nil 'reftex-cite-regexp-hist)
206 (if (or (null re-list ) (equal re-list '("")))
207 (setq re-list (list default)))
209 (setq first-re (car re-list) ; We'll use the first re to find things,
210 rest-re (cdr re-list)) ; the others to narrow down.
211 (if (string-match "\\`[ \t]*\\'" (or first-re ""))
212 (error "Empty regular expression"))
215 (save-window-excursion
217 ;; Walk through all bibtex files
219 (setq buffer (car buffer-list)
220 buffer-list (cdr buffer-list))
221 (if (and (bufferp buffer)
222 (buffer-live-p buffer))
223 (setq buffer1 buffer)
224 (setq buffer1 (reftex-get-file-buffer-force
225 buffer (not reftex-keep-temporary-buffers))))
227 (message "No such BibTeX file %s (ignored)" buffer)
228 (message "Scanning bibliography database %s" buffer1))
231 (reftex-with-special-syntax-for-bib
233 (goto-char (point-min))
234 (while (re-search-forward first-re nil t)
236 (setq key-point (point))
237 (unless (re-search-backward
238 "\\(\\`\\|[\n\r]\\)[ \t]*@\\([a-zA-Z]+\\)[ \t\n\r]*[{(]" nil t)
239 (throw 'search-again nil))
240 (setq start-point (point))
241 (goto-char (match-end 0))
244 (error (goto-char key-point)
245 (throw 'search-again nil)))
246 (setq end-point (point))
248 ;; Ignore @string, @comment and @c entries or things
250 (when (or (string= (downcase (match-string 2)) "string")
251 (string= (downcase (match-string 2)) "comment")
252 (string= (downcase (match-string 2)) "c")
253 (< (point) key-point)) ; this means match not in {}
254 (goto-char key-point)
255 (throw 'search-again nil))
257 ;; Well, we have got a match
259 (buffer-substring start-point (point)) "\n"))
261 ;; Check if other regexp match as well
262 (setq re-list rest-re)
264 (unless (string-match (car re-list) entry)
266 (throw 'search-again nil))
269 (setq alist (reftex-parse-bibtex-entry
270 nil start-point end-point))
271 (push (cons "&entry" entry) alist)
273 ;; check for crossref entries
274 (if (assoc "crossref" alist)
277 alist (reftex-get-crossref-alist alist))))
280 (push (cons "&formatted" (reftex-format-bib-entry alist))
283 ;; make key the first element
284 (push (reftex-get-bib-field "&key" alist) alist)
286 ;; add it to the list
287 (push alist found-list)))))
288 (reftex-kill-temporary-buffers))))
289 (setq found-list (nreverse found-list))
293 ((eq 'author reftex-sort-bibtex-matches)
294 (sort found-list 'reftex-bib-sort-author))
295 ((eq 'year reftex-sort-bibtex-matches)
296 (sort found-list 'reftex-bib-sort-year))
297 ((eq 'reverse-year reftex-sort-bibtex-matches)
298 (sort found-list 'reftex-bib-sort-year-reverse))
301 (defun reftex-bib-sort-author (e1 e2)
302 (let ((al1 (reftex-get-bib-names "author" e1))
303 (al2 (reftex-get-bib-names "author" e2)))
304 (while (and al1 al2 (string= (car al1) (car al2)))
307 (if (and (stringp (car al1))
309 (string< (car al1) (car al2))
310 (not (stringp (car al1))))))
312 (defun reftex-bib-sort-year (e1 e2)
313 (< (string-to-int (cdr (assoc "year" e1)))
314 (string-to-int (cdr (assoc "year" e2)))))
316 (defun reftex-bib-sort-year-reverse (e1 e2)
317 (> (string-to-int (or (cdr (assoc "year" e1)) "0"))
318 (string-to-int (or (cdr (assoc "year" e2)) "0"))))
320 (defun reftex-get-crossref-alist (entry)
321 ;; return the alist from a crossref entry
322 (let ((crkey (cdr (assoc "crossref" entry)))
327 (if (re-search-forward
328 (concat "@\\w+[{(][ \t\n\r]*" (regexp-quote crkey)
329 "[ \t\n\r]*,") nil t)
331 (setq start (match-beginning 0))
335 (reftex-parse-bibtex-entry nil start (point)))
338 ;; Parse the bibliography environment
339 (defun reftex-extract-bib-entries-from-thebibliography (files)
340 ;; Extract bib-entries from the \begin{thebibliography} environment.
341 ;; Parsing is not as good as for the BibTeX database stuff.
342 ;; The environment should be located in file FILE.
344 (let* (start end buf entries re re-list file default)
346 (error "Need file name to find thebibliography environment"))
347 (while (setq file (pop files))
348 (setq buf (reftex-get-file-buffer-force
349 file (not reftex-keep-temporary-buffers)))
351 (error "No such file %s" file))
352 (message "Scanning thebibliography environment in %s" file)
358 (goto-char (point-min))
359 (while (re-search-forward
360 "\\(\\`\\|[\n\r]\\)[ \t]*\\\\begin{thebibliography}" nil t)
361 (beginning-of-line 2)
363 (if (re-search-forward
364 "\\(\\`\\|[\n\r]\\)[ \t]*\\\\end{thebibliography}" nil t)
366 (beginning-of-line 1)
368 (when (and start end)
371 (mapcar 'reftex-parse-bibitem
374 (buffer-substring-no-properties start end)
375 "[ \t\n\r]*\\\\bibitem\\(\\[[^]]*]\\)*"))))))
378 (error "No bibitems found"))
380 ;; Read a regexp, completing on known citation keys.
381 (setq default (regexp-quote (reftex-get-bibkey-default)))
386 "Regex { && Regex...}: "
389 (if (fboundp 'LaTeX-bibitem-list)
391 (cdr (assoc 'bibview-cache
392 (symbol-value reftex-docstruct-symbol))))
394 nil nil nil 'reftex-cite-regexp-hist)
397 (if (or (null re-list ) (equal re-list '("")))
398 (setq re-list (list default)))
400 (if (string-match "\\`[ \t]*\\'" (car re-list))
401 (error "Empty regular expression"))
403 (while (and (setq re (pop re-list)) entries)
407 (if (string-match re (cdr (assoc "&entry" x)))
413 (push (cons "&formatted" (reftex-format-bibitem x)) x)
414 (push (reftex-get-bib-field "&key" x) x)
420 (defun reftex-get-bibkey-default ()
421 ;; Return the word before the cursor. If the cursor is in a
422 ;; citation macro, return the word before the macro.
423 (let* ((macro (reftex-what-macro 1)))
425 (if (and macro (string-match "cite" (car macro)))
426 (goto-char (cdr macro)))
427 (skip-chars-backward "^a-zA-Z0-9")
428 (reftex-this-word))))
430 ;; Parse and format individual entries
432 (defun reftex-get-bib-names (field entry)
433 ;; Return a list with the author or editor names in ENTRY
434 (let ((names (reftex-get-bib-field field entry)))
436 (setq names (reftex-get-bib-field "editor" entry)))
437 (while (string-match "\\band\\b[ \t]*" names)
438 (setq names (replace-match "\n" nil t names)))
439 (while (string-match "[\\.a-zA-Z\\-]+\\.[ \t]*\\|,.*\\|[{}]+" names)
440 (setq names (replace-match "" nil t names)))
441 (while (string-match "^[ \t]+\\|[ \t]+$" names)
442 (setq names (replace-match "" nil t names)))
443 (while (string-match "[ \t][ \t]+" names)
444 (setq names (replace-match " " nil t names)))
445 (split-string names "\n")))
447 (defun reftex-parse-bibtex-entry (entry &optional from to)
448 (let (alist key start field)
453 (set-buffer (get-buffer-create " *RefTeX-scratch*"))
455 (set-syntax-table reftex-syntax-table-for-bib)
459 (narrow-to-region from to))
460 (goto-char (point-min))
462 (if (re-search-forward
463 "@\\(\\w+\\)[ \t\n\r]*[{(][ \t\n\r]*\\([^ \t\n\r,]+\\)" nil t)
466 (cons "&type" (downcase (reftex-match-string 1)))
467 (cons "&key" (reftex-match-string 2)))))
468 (while (re-search-forward "\\(\\w+\\)[ \t\n\r]*=[ \t\n\r]*" nil t)
469 (setq key (downcase (reftex-match-string 1)))
471 ((= (following-char) ?{)
477 ((= (following-char) ?\")
480 (while (and (search-forward "\"" nil t)
481 (= ?\\ (char-after (- (point) 2))))))
484 (re-search-forward "[ \t]*[\n\r,}]" nil 1)))
485 (setq field (buffer-substring-no-properties start (1- (point))))
486 ;; remove extra whitespace
487 (while (string-match "[\n\t\r]\\|[ \t][ \t]+" field)
488 (setq field (replace-match " " nil t field)))
489 ;; remove leading garbage
490 (if (string-match "^[ \t{]+" field)
491 (setq field (replace-match "" nil t field)))
492 ;; remove trailing garbage
493 (if (string-match "[ \t}]+$" field)
494 (setq field (replace-match "" nil t field)))
495 (push (cons key field) alist))))
498 (defun reftex-get-bib-field (fieldname entry &optional format)
499 ;; Extract the field FIELDNAME from an ENTRY
500 (let ((cell (assoc fieldname entry)))
503 (format format (cdr cell))
507 (defun reftex-format-bib-entry (entry)
508 ;; Format a BibTeX ENTRY so that it is nice to look at
510 ((auth-list (reftex-get-bib-names "author" entry))
511 (authors (mapconcat 'identity auth-list ", "))
512 (year (reftex-get-bib-field "year" entry))
513 (title (reftex-get-bib-field "title" entry))
514 (type (reftex-get-bib-field "&type" entry))
515 (key (reftex-get-bib-field "&key" entry))
518 ((equal type "article")
519 (concat (reftex-get-bib-field "journal" entry) " "
520 (reftex-get-bib-field "volume" entry) ", "
521 (reftex-get-bib-field "pages" entry)))
523 (concat "book (" (reftex-get-bib-field "publisher" entry) ")"))
524 ((equal type "phdthesis")
525 (concat "PhD: " (reftex-get-bib-field "school" entry)))
526 ((equal type "mastersthesis")
527 (concat "Master: " (reftex-get-bib-field "school" entry)))
528 ((equal type "inbook")
529 (concat "Chap: " (reftex-get-bib-field "chapter" entry)
530 ", pp. " (reftex-get-bib-field "pages" entry)))
531 ((or (equal type "conference")
532 (equal type "incollection")
533 (equal type "inproceedings"))
534 (reftex-get-bib-field "booktitle" entry "in: %s"))
536 (setq authors (reftex-truncate authors 30 t t))
537 (when (reftex-use-fonts)
538 (put-text-property 0 (length key) 'face
539 (reftex-verified-face reftex-label-face
540 'font-lock-constant-face
541 'font-lock-reference-face)
543 (put-text-property 0 (length authors) 'face reftex-bib-author-face
545 (put-text-property 0 (length year) 'face reftex-bib-year-face
547 (put-text-property 0 (length title) 'face reftex-bib-title-face
549 (put-text-property 0 (length extra) 'face reftex-bib-extra-face
551 (concat key "\n " authors " " year " " extra "\n " title "\n\n")))
553 (defun reftex-parse-bibitem (item)
554 ;; Parse a \bibitem entry
555 (let ((key "") (text ""))
556 (when (string-match "\\`{\\([^}]+\\)}\\([^\000]*\\)" item)
557 (setq key (match-string 1 item)
558 text (match-string 2 item)))
559 ;; Clean up the text a little bit
560 (while (string-match "[\n\r\t]\\|[ \t][ \t]+" text)
561 (setq text (replace-match " " nil t text)))
562 (if (string-match "\\`[ \t]+" text)
563 (setq text (replace-match "" nil t text)))
567 (cons "&entry" (concat key " " text)))))
569 (defun reftex-format-bibitem (item)
570 ;; Format a \bibitem entry so that it is (relatively) nice to look at.
571 (let ((text (reftex-get-bib-field "&text" item))
572 (key (reftex-get-bib-field "&key" item))
575 ;; Wrap the text into several lines.
576 (while (and (> (length text) 70)
577 (string-match " " (substring text 60)))
578 (push (substring text 0 (+ 60 (match-beginning 0))) lines)
579 (setq text (substring text (+ 61 (match-beginning 0)))))
581 (setq text (mapconcat 'identity (nreverse lines) "\n "))
583 (when (reftex-use-fonts)
584 (put-text-property 0 (length text) 'face reftex-bib-author-face text))
585 (concat key "\n " text "\n\n")))
590 (defun reftex-citation (&optional no-insert format-key)
591 "Make a citation using BibTeX database files.
592 After prompting for a regular expression, scans the buffers with
593 bibtex entries (taken from the \\bibliography command) and offers the
594 matching entries for selection. The selected entry is formatted according
595 to `reftex-cite-format' and inserted into the buffer.
597 If NO-INSERT is non-nil, nothing is inserted, only the selected key returned.
599 FORAT-KEY can be used to pre-select a citation format.
601 When called with one or two `C-u' prefixes, first rescans the document.
602 When called with a numeric prefix, make that many citations. When
603 called with point inside the braces of a `\\cite' command, it will
604 add another key, ignoring the value of `reftex-cite-format'.
606 The regular expression uses an expanded syntax: && is interpreted as `and'.
607 Thus, `aaaa&&bbb' matches entries which contain both `aaaa' and `bbb'.
608 While entering the regexp, completion on knows citation keys is possible.
609 `=' is a good regular expression to match all entries in all files."
613 ;; check for recursive edit
614 (reftex-check-recursive-edit)
616 ;; This function may also be called outside reftex-mode.
617 ;; Thus look for the scanning info only if in reftex-mode.
620 (reftex-access-scan-info current-prefix-arg))
622 ;; Call reftex-do-citation, but protected
624 (reftex-do-citation current-prefix-arg no-insert format-key)
625 (reftex-kill-temporary-buffers)))
627 (defun reftex-do-citation (&optional arg no-insert format-key)
628 ;; This really does the work of reftex-citation.
630 (let* ((format (reftex-figure-out-cite-format arg no-insert format-key))
631 (docstruct-symbol reftex-docstruct-symbol)
632 (selected-entries (reftex-offer-bib-menu))
633 (insert-entries selected-entries)
634 entry string cite-view)
636 (unless selected-entries (error "Quit"))
638 (if (stringp selected-entries)
640 (setq selected-entries nil
641 insert-entries (list (list selected-entries
642 (cons "&key" selected-entries))))
643 ;; It makes sense to compute the cite-view strings.
646 (when (eq (car selected-entries) 'concat)
647 ;; All keys go into a single command - we need to trick a little
648 (pop selected-entries)
649 (let ((concat-keys (mapconcat 'car selected-entries ",")))
651 (list (list concat-keys (cons "&key" concat-keys))))))
655 ;; We shall insert this into the buffer...
656 (message "Formatting...")
658 (while (setq entry (pop insert-entries))
659 ;; Format the citation and insert it
660 (setq string (if reftex-format-cite-function
661 (funcall reftex-format-cite-function
662 (reftex-get-bib-field "&key" entry)
664 (reftex-format-citation entry format)))
667 ;; Reposition cursor?
668 (when (string-match "\\?" string)
669 (search-backward "?")
673 (when (and reftex-mode
674 (fboundp 'LaTeX-add-bibitems)
675 reftex-plug-into-AUCTeX)
676 (apply 'LaTeX-add-bibitems (mapcar 'car selected-entries)))
678 ;; Produce the cite-view strings
679 (when (and reftex-mode reftex-cache-cite-echo cite-view)
680 (mapcar (lambda (entry)
681 (reftex-make-cite-echo-string entry docstruct-symbol))
686 (set-marker reftex-select-return-marker nil)
687 (reftex-kill-buffer "*RefTeX Select*")
689 ;; Check if the prefix arg was numeric, and call recursively
693 (skip-chars-backward "}")
695 (reftex-do-citation arg))
698 ;; Return the citation key
699 (car (car selected-entries))))
701 (defun reftex-figure-out-cite-format (arg &optional no-insert format-key)
702 ;; Check if there is already a cite command at point and change cite format
703 ;; in order to only add another reference in the same cite command.
704 (let ((macro (car (reftex-what-macro 1)))
705 (cite-format-value (reftex-get-cite-format))
709 ;; Format does not really matter because nothing will be inserted.
712 ((and (stringp macro)
713 (string-match "\\`\\\\cite\\|cite\\'" macro))
714 ;; We are already inside a cite macro
715 (if (or (not arg) (not (listp arg)))
718 (if (member (preceding-char) '(?\{ ?,)) "" ",")
720 (if (member (following-char) '(?\} ?,)) "" ",")))
723 ;; Figure out the correct format
725 (if (and (symbolp cite-format-value)
726 (assq cite-format-value reftex-cite-format-builtin))
727 (nth 2 (assq cite-format-value reftex-cite-format-builtin))
732 (reftex-select-with-char
733 "" (concat "SELECT A CITATION FORMAT\n\n"
736 (format "[%c] %s %s" (car x)
737 (if (> (car x) 31) " " "")
740 (if (assq key format)
741 (setq format (cdr (assq key format)))
742 (error "No citation format associated with key `%c'" key)))))
745 (defun reftex-citep ()
746 "Call `reftex-citation' with a format selector `?p'."
748 (reftex-citation nil ?p))
750 (defun reftex-citet ()
751 "Call `reftex-citation' with a format selector `?t'."
753 (reftex-citation nil ?t))
755 (defvar reftex-select-bib-map)
756 (defun reftex-offer-bib-menu ()
757 ;; Offer bib menu and return list of selected items
759 (let ((bibtype (reftex-bib-or-thebib))
760 found-list rtn key data selected-entries)
768 ; ((assq 'bib (symbol-value reftex-docstruct-symbol))
769 ;; using BibTeX database files.
770 (reftex-extract-bib-entries (reftex-get-bibfile-list)))
771 ((eq bibtype 'thebib)
772 ; ((assq 'thebib (symbol-value reftex-docstruct-symbol))
773 ;; using thebibliography environment.
774 (reftex-extract-bib-entries-from-thebibliography
778 'thebib (symbol-value reftex-docstruct-symbol))))))
779 (reftex-default-bibliography
780 (message "Using default bibliography")
781 (reftex-extract-bib-entries (reftex-default-bibliography)))
782 (t (error "No valid bibliography in this document, and no default available"))))
785 (error "Sorry, no matches found"))
787 ;; Remember where we came from
788 (setq reftex-call-back-to-this-buffer (current-buffer))
789 (set-marker reftex-select-return-marker (point))
792 (save-window-excursion
793 (delete-other-windows)
794 (let ((default-major-mode 'reftex-select-bib-mode))
795 (reftex-kill-buffer "*RefTeX Select*")
796 (switch-to-buffer-other-window "*RefTeX Select*")
797 (unless (eq major-mode 'reftex-select-bib-mode)
798 (reftex-select-bib-mode))
799 (let ((buffer-read-only nil))
801 (reftex-insert-bib-matches found-list)))
802 (setq buffer-read-only t)
803 (if (= 0 (buffer-size))
804 (error "No matches found"))
805 (setq truncate-lines t)
810 reftex-citation-prompt
812 reftex-select-bib-map
814 'reftex-bibtex-selection-callback nil))
817 (unless key (throw 'done t))
823 ;; Restrict with new regular expression
824 (setq found-list (reftex-restrict-bib-matches found-list))
825 (let ((buffer-read-only nil))
827 (reftex-insert-bib-matches found-list))
831 (setq selected-entries
832 (if reftex-select-marked
833 (mapcar 'car (nreverse reftex-select-marked))
837 ;; Take all (marked), and push the symbol 'concat
838 (setq selected-entries
840 (if reftex-select-marked
841 (mapcar 'car (nreverse reftex-select-marked))
847 (setq selected-entries
848 (if reftex-select-marked
850 (mapcar 'car (nreverse reftex-select-marked)))
851 (if data (list data) nil)))
854 ;; Got this one with completion
855 (setq selected-entries key)
861 (defun reftex-restrict-bib-matches (found-list)
862 ;; Limit FOUND-LIST with more regular expressions
863 (let ((re-list (split-string (read-string
864 "RegExp [ && RegExp...]: "
865 nil 'reftex-cite-regexp-hist)
867 (found-list-r found-list)
869 (while (setq re (pop re-list))
875 re (cdr (assoc "&entry" x)))
884 (defun reftex-insert-bib-matches (list)
885 ;; Insert the bib matches and number them correctly
887 (if (memq reftex-highlight-selection '(mouse both))
888 reftex-mouse-selected-face
893 (setq tmp (cdr (assoc "&formatted" x))
895 (put-text-property 0 len :data x tmp)
896 (put-text-property 0 (1- len) 'mouse-face mouse-face tmp)
899 (run-hooks 'reftex-display-copied-context-hook))
901 (defun reftex-format-names (namelist n)
902 (let (last (len (length namelist)))
903 (if (= n 0) (setq n len))
906 ((= 1 len) (car namelist))
907 ((> len n) (concat (car namelist) (nth 2 reftex-cite-punctuation)))
910 last (nth (1- n) namelist))
911 (setcdr (nthcdr (- n 2) namelist) nil)
913 (mapconcat 'identity namelist (nth 0 reftex-cite-punctuation))
914 (nth 1 reftex-cite-punctuation)
917 (defun reftex-format-citation (entry format)
918 ;; Format a citation from the info in the BibTeX ENTRY
920 (unless (stringp format) (setq format "\\cite{%l}"))
922 (if (and reftex-comment-citations
923 (string-match "%l" reftex-cite-comment-format))
924 (error "reftex-cite-comment-format contains illegal %%l"))
927 "\\(\\`\\|[^%]\\)\\(\\(%\\([0-9]*\\)\\([a-zA-Z]\\)\\)[.,;: ]*\\)"
929 (let ((n (string-to-int (match-string 4 format)))
930 (l (string-to-char (match-string 5 format)))
936 (reftex-get-bib-field "&key" entry)
937 (if reftex-comment-citations
938 reftex-cite-comment-format
940 ((= l ?a) (reftex-format-names
941 (reftex-get-bib-names "author" entry)
943 ((= l ?A) (car (reftex-get-bib-names "author" entry)))
944 ((= l ?b) (reftex-get-bib-field "booktitle" entry "in: %s"))
945 ((= l ?B) (reftex-abbreviate-title
946 (reftex-get-bib-field "booktitle" entry "in: %s")))
947 ((= l ?c) (reftex-get-bib-field "chapter" entry))
948 ((= l ?d) (reftex-get-bib-field "edition" entry))
949 ((= l ?e) (reftex-format-names
950 (reftex-get-bib-names "editor" entry)
952 ((= l ?E) (car (reftex-get-bib-names "editor" entry)))
953 ((= l ?h) (reftex-get-bib-field "howpublished" entry))
954 ((= l ?i) (reftex-get-bib-field "institution" entry))
955 ((= l ?j) (reftex-get-bib-field "journal" entry))
956 ((= l ?k) (reftex-get-bib-field "key" entry))
957 ((= l ?m) (reftex-get-bib-field "month" entry))
958 ((= l ?n) (reftex-get-bib-field "number" entry))
959 ((= l ?o) (reftex-get-bib-field "organization" entry))
960 ((= l ?p) (reftex-get-bib-field "pages" entry))
961 ((= l ?P) (car (split-string
962 (reftex-get-bib-field "pages" entry)
964 ((= l ?s) (reftex-get-bib-field "school" entry))
965 ((= l ?u) (reftex-get-bib-field "publisher" entry))
966 ((= l ?r) (reftex-get-bib-field "address" entry))
967 ((= l ?t) (reftex-get-bib-field "title" entry))
968 ((= l ?T) (reftex-abbreviate-title
969 (reftex-get-bib-field "title" entry)))
970 ((= l ?v) (reftex-get-bib-field "volume" entry))
971 ((= l ?y) (reftex-get-bib-field "year" entry)))))
974 (setq b (match-beginning 2) e (match-end 2))
975 (setq b (match-beginning 3) e (match-end 3)))
976 (setq format (concat (substring format 0 b) rpl (substring format e)))))
977 (while (string-match "%%" format)
978 (setq format (replace-match "%" t t format)))
979 (while (string-match "[ ,.;:]*%<" format)
980 (setq format (replace-match "" t t format)))
983 (defun reftex-make-cite-echo-string (entry docstruct-symbol)
984 ;; Format a bibtex entry for the echo area and cache the result.
985 (let* ((key (reftex-get-bib-field "&key" entry))
987 (let* ((reftex-cite-punctuation '(" " " & " " etal.")))
988 (reftex-format-citation entry reftex-cite-view-format)))
989 (cache (assq 'bibview-cache (symbol-value docstruct-symbol)))
990 (cache-entry (assoc key (cdr cache))))
992 ;; This docstruct has no cache - make one.
993 (set docstruct-symbol (cons (cons 'bibview-cache nil)
994 (symbol-value docstruct-symbol))))
995 (when reftex-cache-cite-echo
996 (setq key (copy-sequence key))
997 (set-text-properties 0 (length key) nil key)
998 (set-text-properties 0 (length string) nil string)
1000 (unless (string= (cdr cache-entry) string)
1001 (setcdr cache-entry string)
1002 (put reftex-docstruct-symbol 'modified t))
1003 (push (cons key string) (cdr cache))
1004 (put reftex-docstruct-symbol 'modified t)))
1007 (defun reftex-bibtex-selection-callback (data ignore no-revisit)
1008 ;; Callback function to be called from the BibTeX selection, in
1009 ;; order to display context. This function is relatively slow and not
1010 ;; recommended for follow mode. It works OK for individual lookups.
1011 (let ((win (selected-window))
1012 (key (reftex-get-bib-field "&key" data))
1013 bibfile-list item bibtype)
1017 (set-buffer reftex-call-back-to-this-buffer)
1018 (setq bibtype (reftex-bib-or-thebib))
1021 ; ((assq 'bib (symbol-value reftex-docstruct-symbol))
1022 (setq bibfile-list (reftex-get-bibfile-list)))
1023 ((eq bibtype 'thebib)
1024 ; ((assq 'thebib (symbol-value reftex-docstruct-symbol))
1029 'thebib (symbol-value reftex-docstruct-symbol))))
1031 (reftex-default-bibliography
1032 (setq bibfile-list (reftex-default-bibliography)))
1033 (t (ding) (throw 'exit nil))))
1036 (setq bibfile-list (reftex-visited-files bibfile-list)))
1039 (reftex-pop-to-bibtex-entry
1040 key bibfile-list (not reftex-keep-temporary-buffers) t item)
1043 (select-window win)))
1045 ;;; reftex-cite.el ends here