1 ;;; reftex-cite.el --- creating citations with RefTeX
2 ;; Copyright (c) 1997, 1998, 1999, 2000, 2003 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
258 ;;(setq entry (concat
259 ;; (buffer-substring start-point (point)) "\n"))
260 (setq entry
(buffer-substring start-point
(point)))
262 ;; Check if other regexp match as well
263 (setq re-list rest-re
)
265 (unless (string-match (car re-list
) entry
)
267 (throw 'search-again nil
))
270 (setq alist
(reftex-parse-bibtex-entry
271 nil start-point end-point
))
272 (push (cons "&entry" entry
) alist
)
274 ;; check for crossref entries
275 (if (assoc "crossref" alist
)
278 alist
(reftex-get-crossref-alist alist
))))
281 (push (cons "&formatted" (reftex-format-bib-entry alist
))
284 ;; make key the first element
285 (push (reftex-get-bib-field "&key" alist
) alist
)
287 ;; add it to the list
288 (push alist found-list
)))))
289 (reftex-kill-temporary-buffers))))
290 (setq found-list
(nreverse found-list
))
294 ((eq 'author reftex-sort-bibtex-matches
)
295 (sort found-list
'reftex-bib-sort-author
))
296 ((eq 'year reftex-sort-bibtex-matches
)
297 (sort found-list
'reftex-bib-sort-year
))
298 ((eq 'reverse-year reftex-sort-bibtex-matches
)
299 (sort found-list
'reftex-bib-sort-year-reverse
))
302 (defun reftex-bib-sort-author (e1 e2
)
303 (let ((al1 (reftex-get-bib-names "author" e1
))
304 (al2 (reftex-get-bib-names "author" e2
)))
305 (while (and al1 al2
(string= (car al1
) (car al2
)))
308 (if (and (stringp (car al1
))
310 (string< (car al1
) (car al2
))
311 (not (stringp (car al1
))))))
313 (defun reftex-bib-sort-year (e1 e2
)
314 (< (string-to-int (cdr (assoc "year" e1
)))
315 (string-to-int (cdr (assoc "year" e2
)))))
317 (defun reftex-bib-sort-year-reverse (e1 e2
)
318 (> (string-to-int (or (cdr (assoc "year" e1
)) "0"))
319 (string-to-int (or (cdr (assoc "year" e2
)) "0"))))
321 (defun reftex-get-crossref-alist (entry)
322 ;; return the alist from a crossref entry
323 (let ((crkey (cdr (assoc "crossref" entry
)))
328 (if (re-search-forward
329 (concat "@\\w+[{(][ \t\n\r]*" (regexp-quote crkey
)
330 "[ \t\n\r]*,") nil t
)
332 (setq start
(match-beginning 0))
336 (reftex-parse-bibtex-entry nil start
(point)))
339 ;; Parse the bibliography environment
340 (defun reftex-extract-bib-entries-from-thebibliography (files)
341 ;; Extract bib-entries from the \begin{thebibliography} environment.
342 ;; Parsing is not as good as for the BibTeX database stuff.
343 ;; The environment should be located in file FILE.
345 (let* (start end buf entries re re-list file default
)
347 (error "Need file name to find thebibliography environment"))
348 (while (setq file
(pop files
))
349 (setq buf
(reftex-get-file-buffer-force
350 file
(not reftex-keep-temporary-buffers
)))
352 (error "No such file %s" file
))
353 (message "Scanning thebibliography environment in %s" file
)
359 (goto-char (point-min))
360 (while (re-search-forward
361 "\\(\\`\\|[\n\r]\\)[ \t]*\\\\begin{thebibliography}" nil t
)
362 (beginning-of-line 2)
364 (if (re-search-forward
365 "\\(\\`\\|[\n\r]\\)[ \t]*\\\\end{thebibliography}" nil t
)
367 (beginning-of-line 1)
369 (when (and start end
)
372 (mapcar 'reftex-parse-bibitem
375 (buffer-substring-no-properties start end
)
376 "[ \t\n\r]*\\\\bibitem\\(\\[[^]]*]\\)*"))))))
379 (error "No bibitems found"))
381 ;; Read a regexp, completing on known citation keys.
382 (setq default
(regexp-quote (reftex-get-bibkey-default)))
387 "Regex { && Regex...}: "
390 (if (fboundp 'LaTeX-bibitem-list
)
392 (cdr (assoc 'bibview-cache
393 (symbol-value reftex-docstruct-symbol
))))
395 nil nil nil
'reftex-cite-regexp-hist
)
398 (if (or (null re-list
) (equal re-list
'("")))
399 (setq re-list
(list default
)))
401 (if (string-match "\\`[ \t]*\\'" (car re-list
))
402 (error "Empty regular expression"))
404 (while (and (setq re
(pop re-list
)) entries
)
408 (if (string-match re
(cdr (assoc "&entry" x
)))
414 (push (cons "&formatted" (reftex-format-bibitem x
)) x
)
415 (push (reftex-get-bib-field "&key" x
) x
)
421 (defun reftex-get-bibkey-default ()
422 ;; Return the word before the cursor. If the cursor is in a
423 ;; citation macro, return the word before the macro.
424 (let* ((macro (reftex-what-macro 1)))
426 (if (and macro
(string-match "cite" (car macro
)))
427 (goto-char (cdr macro
)))
428 (skip-chars-backward "^a-zA-Z0-9")
429 (reftex-this-word))))
431 ;; Parse and format individual entries
433 (defun reftex-get-bib-names (field entry
)
434 ;; Return a list with the author or editor names in ENTRY
435 (let ((names (reftex-get-bib-field field entry
)))
437 (setq names
(reftex-get-bib-field "editor" entry
)))
438 (while (string-match "\\band\\b[ \t]*" names
)
439 (setq names
(replace-match "\n" nil t names
)))
440 (while (string-match "[\\.a-zA-Z\\-]+\\.[ \t]*\\|,.*\\|[{}]+" names
)
441 (setq names
(replace-match "" nil t names
)))
442 (while (string-match "^[ \t]+\\|[ \t]+$" names
)
443 (setq names
(replace-match "" nil t names
)))
444 (while (string-match "[ \t][ \t]+" names
)
445 (setq names
(replace-match " " nil t names
)))
446 (split-string names
"\n")))
448 (defun reftex-parse-bibtex-entry (entry &optional from to
)
449 (let (alist key start field
)
454 (set-buffer (get-buffer-create " *RefTeX-scratch*"))
456 (set-syntax-table reftex-syntax-table-for-bib
)
460 (narrow-to-region from to
))
461 (goto-char (point-min))
463 (if (re-search-forward
464 "@\\(\\w+\\)[ \t\n\r]*[{(][ \t\n\r]*\\([^ \t\n\r,]+\\)" nil t
)
467 (cons "&type" (downcase (reftex-match-string 1)))
468 (cons "&key" (reftex-match-string 2)))))
469 (while (re-search-forward "\\(\\w+\\)[ \t\n\r]*=[ \t\n\r]*" nil t
)
470 (setq key
(downcase (reftex-match-string 1)))
472 ((= (following-char) ?
{)
478 ((= (following-char) ?
\")
481 (while (and (search-forward "\"" nil t
)
482 (= ?
\\ (char-after (- (point) 2))))))
485 (re-search-forward "[ \t]*[\n\r,}]" nil
1)))
486 (setq field
(buffer-substring-no-properties start
(1- (point))))
487 ;; remove extra whitespace
488 (while (string-match "[\n\t\r]\\|[ \t][ \t]+" field
)
489 (setq field
(replace-match " " nil t field
)))
490 ;; remove leading garbage
491 (if (string-match "^[ \t{]+" field
)
492 (setq field
(replace-match "" nil t field
)))
493 ;; remove trailing garbage
494 (if (string-match "[ \t}]+$" field
)
495 (setq field
(replace-match "" nil t field
)))
496 (push (cons key field
) alist
))))
499 (defun reftex-get-bib-field (fieldname entry
&optional format
)
500 ;; Extract the field FIELDNAME from an ENTRY
501 (let ((cell (assoc fieldname entry
)))
504 (format format
(cdr cell
))
508 (defun reftex-format-bib-entry (entry)
509 ;; Format a BibTeX ENTRY so that it is nice to look at
511 ((auth-list (reftex-get-bib-names "author" entry
))
512 (authors (mapconcat 'identity auth-list
", "))
513 (year (reftex-get-bib-field "year" entry
))
514 (title (reftex-get-bib-field "title" entry
))
515 (type (reftex-get-bib-field "&type" entry
))
516 (key (reftex-get-bib-field "&key" entry
))
519 ((equal type
"article")
520 (concat (reftex-get-bib-field "journal" entry
) " "
521 (reftex-get-bib-field "volume" entry
) ", "
522 (reftex-get-bib-field "pages" entry
)))
524 (concat "book (" (reftex-get-bib-field "publisher" entry
) ")"))
525 ((equal type
"phdthesis")
526 (concat "PhD: " (reftex-get-bib-field "school" entry
)))
527 ((equal type
"mastersthesis")
528 (concat "Master: " (reftex-get-bib-field "school" entry
)))
529 ((equal type
"inbook")
530 (concat "Chap: " (reftex-get-bib-field "chapter" entry
)
531 ", pp. " (reftex-get-bib-field "pages" entry
)))
532 ((or (equal type
"conference")
533 (equal type
"incollection")
534 (equal type
"inproceedings"))
535 (reftex-get-bib-field "booktitle" entry
"in: %s"))
537 (setq authors
(reftex-truncate authors
30 t t
))
538 (when (reftex-use-fonts)
539 (put-text-property 0 (length key
) 'face
540 (reftex-verified-face reftex-label-face
541 'font-lock-constant-face
542 'font-lock-reference-face
)
544 (put-text-property 0 (length authors
) 'face reftex-bib-author-face
546 (put-text-property 0 (length year
) 'face reftex-bib-year-face
548 (put-text-property 0 (length title
) 'face reftex-bib-title-face
550 (put-text-property 0 (length extra
) 'face reftex-bib-extra-face
552 (concat key
"\n " authors
" " year
" " extra
"\n " title
"\n\n")))
554 (defun reftex-parse-bibitem (item)
555 ;; Parse a \bibitem entry
556 (let ((key "") (text ""))
557 (when (string-match "\\`{\\([^}]+\\)}\\([^\000]*\\)" item
)
558 (setq key
(match-string 1 item
)
559 text
(match-string 2 item
)))
560 ;; Clean up the text a little bit
561 (while (string-match "[\n\r\t]\\|[ \t][ \t]+" text
)
562 (setq text
(replace-match " " nil t text
)))
563 (if (string-match "\\`[ \t]+" text
)
564 (setq text
(replace-match "" nil t text
)))
568 (cons "&entry" (concat key
" " text
)))))
570 (defun reftex-format-bibitem (item)
571 ;; Format a \bibitem entry so that it is (relatively) nice to look at.
572 (let ((text (reftex-get-bib-field "&text" item
))
573 (key (reftex-get-bib-field "&key" item
))
576 ;; Wrap the text into several lines.
577 (while (and (> (length text
) 70)
578 (string-match " " (substring text
60)))
579 (push (substring text
0 (+ 60 (match-beginning 0))) lines
)
580 (setq text
(substring text
(+ 61 (match-beginning 0)))))
582 (setq text
(mapconcat 'identity
(nreverse lines
) "\n "))
584 (when (reftex-use-fonts)
585 (put-text-property 0 (length text
) 'face reftex-bib-author-face text
))
586 (concat key
"\n " text
"\n\n")))
591 (defun reftex-citation (&optional no-insert format-key
)
592 "Make a citation using BibTeX database files.
593 After prompting for a regular expression, scans the buffers with
594 bibtex entries (taken from the \\bibliography command) and offers the
595 matching entries for selection. The selected entry is formatted according
596 to `reftex-cite-format' and inserted into the buffer.
598 If NO-INSERT is non-nil, nothing is inserted, only the selected key returned.
600 FORAT-KEY can be used to pre-select a citation format.
602 When called with one or two `C-u' prefixes, first rescans the document.
603 When called with a numeric prefix, make that many citations. When
604 called with point inside the braces of a `\\cite' command, it will
605 add another key, ignoring the value of `reftex-cite-format'.
607 The regular expression uses an expanded syntax: && is interpreted as `and'.
608 Thus, `aaaa&&bbb' matches entries which contain both `aaaa' and `bbb'.
609 While entering the regexp, completion on knows citation keys is possible.
610 `=' is a good regular expression to match all entries in all files."
614 ;; check for recursive edit
615 (reftex-check-recursive-edit)
617 ;; This function may also be called outside reftex-mode.
618 ;; Thus look for the scanning info only if in reftex-mode.
621 (reftex-access-scan-info current-prefix-arg
))
623 ;; Call reftex-do-citation, but protected
625 (reftex-do-citation current-prefix-arg no-insert format-key
)
626 (reftex-kill-temporary-buffers)))
628 (defun reftex-do-citation (&optional arg no-insert format-key
)
629 ;; This really does the work of reftex-citation.
631 (let* ((format (reftex-figure-out-cite-format arg no-insert format-key
))
632 (docstruct-symbol reftex-docstruct-symbol
)
633 (selected-entries (reftex-offer-bib-menu))
634 (insert-entries selected-entries
)
635 entry string cite-view
)
637 (unless selected-entries
(error "Quit"))
639 (if (stringp selected-entries
)
641 (setq selected-entries nil
642 insert-entries
(list (list selected-entries
643 (cons "&key" selected-entries
))))
644 ;; It makes sense to compute the cite-view strings.
647 (when (eq (car selected-entries
) 'concat
)
648 ;; All keys go into a single command - we need to trick a little
649 (pop selected-entries
)
650 (let ((concat-keys (mapconcat 'car selected-entries
",")))
652 (list (list concat-keys
(cons "&key" concat-keys
))))))
656 ;; We shall insert this into the buffer...
657 (message "Formatting...")
659 (while (setq entry
(pop insert-entries
))
660 ;; Format the citation and insert it
661 (setq string
(if reftex-format-cite-function
662 (funcall reftex-format-cite-function
663 (reftex-get-bib-field "&key" entry
)
665 (reftex-format-citation entry format
)))
668 ;; Reposition cursor?
669 (when (string-match "\\?" string
)
670 (search-backward "?")
674 (when (and reftex-mode
675 (fboundp 'LaTeX-add-bibitems
)
676 reftex-plug-into-AUCTeX
)
677 (apply 'LaTeX-add-bibitems
(mapcar 'car selected-entries
)))
679 ;; Produce the cite-view strings
680 (when (and reftex-mode reftex-cache-cite-echo cite-view
)
681 (mapcar (lambda (entry)
682 (reftex-make-cite-echo-string entry docstruct-symbol
))
687 (set-marker reftex-select-return-marker nil
)
688 (reftex-kill-buffer "*RefTeX Select*")
690 ;; Check if the prefix arg was numeric, and call recursively
694 (skip-chars-backward "}")
696 (reftex-do-citation arg
))
699 ;; Return the citation key
700 (car (car selected-entries
))))
702 (defun reftex-figure-out-cite-format (arg &optional no-insert format-key
)
703 ;; Check if there is already a cite command at point and change cite format
704 ;; in order to only add another reference in the same cite command.
705 (let ((macro (car (reftex-what-macro 1)))
706 (cite-format-value (reftex-get-cite-format))
710 ;; Format does not really matter because nothing will be inserted.
713 ((and (stringp macro
)
714 (string-match "\\`\\\\cite\\|cite\\'" macro
))
715 ;; We are already inside a cite macro
716 (if (or (not arg
) (not (listp arg
)))
719 (if (member (preceding-char) '(?\
{ ?
,)) "" ",")
721 (if (member (following-char) '(?\
} ?
,)) "" ",")))
724 ;; Figure out the correct format
726 (if (and (symbolp cite-format-value
)
727 (assq cite-format-value reftex-cite-format-builtin
))
728 (nth 2 (assq cite-format-value reftex-cite-format-builtin
))
733 (reftex-select-with-char
734 "" (concat "SELECT A CITATION FORMAT\n\n"
737 (format "[%c] %s %s" (car x
)
738 (if (> (car x
) 31) " " "")
741 (if (assq key format
)
742 (setq format
(cdr (assq key format
)))
743 (error "No citation format associated with key `%c'" key
)))))
746 (defun reftex-citep ()
747 "Call `reftex-citation' with a format selector `?p'."
749 (reftex-citation nil ?p
))
751 (defun reftex-citet ()
752 "Call `reftex-citation' with a format selector `?t'."
754 (reftex-citation nil ?t
))
756 (defvar reftex-select-bib-map
)
757 (defun reftex-offer-bib-menu ()
758 ;; Offer bib menu and return list of selected items
760 (let ((bibtype (reftex-bib-or-thebib))
761 found-list rtn key data selected-entries
)
769 ; ((assq 'bib (symbol-value reftex-docstruct-symbol))
770 ;; using BibTeX database files.
771 (reftex-extract-bib-entries (reftex-get-bibfile-list)))
772 ((eq bibtype
'thebib
)
773 ; ((assq 'thebib (symbol-value reftex-docstruct-symbol))
774 ;; using thebibliography environment.
775 (reftex-extract-bib-entries-from-thebibliography
779 'thebib
(symbol-value reftex-docstruct-symbol
))))))
780 (reftex-default-bibliography
781 (message "Using default bibliography")
782 (reftex-extract-bib-entries (reftex-default-bibliography)))
783 (t (error "No valid bibliography in this document, and no default available"))))
786 (error "Sorry, no matches found"))
788 ;; Remember where we came from
789 (setq reftex-call-back-to-this-buffer
(current-buffer))
790 (set-marker reftex-select-return-marker
(point))
793 (save-window-excursion
794 (delete-other-windows)
795 (let ((default-major-mode 'reftex-select-bib-mode
))
796 (reftex-kill-buffer "*RefTeX Select*")
797 (switch-to-buffer-other-window "*RefTeX Select*")
798 (unless (eq major-mode
'reftex-select-bib-mode
)
799 (reftex-select-bib-mode))
800 (let ((buffer-read-only nil
))
802 (reftex-insert-bib-matches found-list
)))
803 (setq buffer-read-only t
)
804 (if (= 0 (buffer-size))
805 (error "No matches found"))
806 (setq truncate-lines t
)
811 reftex-citation-prompt
813 reftex-select-bib-map
815 'reftex-bibtex-selection-callback nil
))
818 (unless key
(throw 'done t
))
824 ;; Restrict with new regular expression
825 (setq found-list
(reftex-restrict-bib-matches found-list
))
826 (let ((buffer-read-only nil
))
828 (reftex-insert-bib-matches found-list
))
832 (setq selected-entries
833 (if reftex-select-marked
834 (mapcar 'car
(nreverse reftex-select-marked
))
838 ;; Take all (marked), and push the symbol 'concat
839 (setq selected-entries
841 (if reftex-select-marked
842 (mapcar 'car
(nreverse reftex-select-marked
))
848 (setq selected-entries
849 (if reftex-select-marked
851 (mapcar 'car
(nreverse reftex-select-marked
)))
852 (if data
(list data
) nil
)))
855 ;; Got this one with completion
856 (setq selected-entries key
)
862 (defun reftex-restrict-bib-matches (found-list)
863 ;; Limit FOUND-LIST with more regular expressions
864 (let ((re-list (split-string (read-string
865 "RegExp [ && RegExp...]: "
866 nil
'reftex-cite-regexp-hist
)
868 (found-list-r found-list
)
870 (while (setq re
(pop re-list
))
876 re
(cdr (assoc "&entry" x
)))
885 (defun reftex-insert-bib-matches (list)
886 ;; Insert the bib matches and number them correctly
888 (if (memq reftex-highlight-selection
'(mouse both
))
889 reftex-mouse-selected-face
894 (setq tmp
(cdr (assoc "&formatted" x
))
896 (put-text-property 0 len
:data x tmp
)
897 (put-text-property 0 (1- len
) 'mouse-face mouse-face tmp
)
900 (run-hooks 'reftex-display-copied-context-hook
))
902 (defun reftex-format-names (namelist n
)
903 (let (last (len (length namelist
)))
904 (if (= n
0) (setq n len
))
907 ((= 1 len
) (car namelist
))
908 ((> len n
) (concat (car namelist
) (nth 2 reftex-cite-punctuation
)))
911 last
(nth (1- n
) namelist
))
912 (setcdr (nthcdr (- n
2) namelist
) nil
)
914 (mapconcat 'identity namelist
(nth 0 reftex-cite-punctuation
))
915 (nth 1 reftex-cite-punctuation
)
918 (defun reftex-format-citation (entry format
)
919 ;; Format a citation from the info in the BibTeX ENTRY
921 (unless (stringp format
) (setq format
"\\cite{%l}"))
923 (if (and reftex-comment-citations
924 (string-match "%l" reftex-cite-comment-format
))
925 (error "reftex-cite-comment-format contains illegal %%l"))
928 "\\(\\`\\|[^%]\\)\\(\\(%\\([0-9]*\\)\\([a-zA-Z]\\)\\)[.,;: ]*\\)"
930 (let ((n (string-to-int (match-string 4 format
)))
931 (l (string-to-char (match-string 5 format
)))
937 (reftex-get-bib-field "&key" entry
)
938 (if reftex-comment-citations
939 reftex-cite-comment-format
941 ((= l ?a
) (reftex-format-names
942 (reftex-get-bib-names "author" entry
)
944 ((= l ?A
) (car (reftex-get-bib-names "author" entry
)))
945 ((= l ?b
) (reftex-get-bib-field "booktitle" entry
"in: %s"))
946 ((= l ?B
) (reftex-abbreviate-title
947 (reftex-get-bib-field "booktitle" entry
"in: %s")))
948 ((= l ?c
) (reftex-get-bib-field "chapter" entry
))
949 ((= l ?d
) (reftex-get-bib-field "edition" entry
))
950 ((= l ?e
) (reftex-format-names
951 (reftex-get-bib-names "editor" entry
)
953 ((= l ?E
) (car (reftex-get-bib-names "editor" entry
)))
954 ((= l ?h
) (reftex-get-bib-field "howpublished" entry
))
955 ((= l ?i
) (reftex-get-bib-field "institution" entry
))
956 ((= l ?j
) (reftex-get-bib-field "journal" entry
))
957 ((= l ?k
) (reftex-get-bib-field "key" entry
))
958 ((= l ?m
) (reftex-get-bib-field "month" entry
))
959 ((= l ?n
) (reftex-get-bib-field "number" entry
))
960 ((= l ?o
) (reftex-get-bib-field "organization" entry
))
961 ((= l ?p
) (reftex-get-bib-field "pages" entry
))
962 ((= l ?P
) (car (split-string
963 (reftex-get-bib-field "pages" entry
)
965 ((= l ?s
) (reftex-get-bib-field "school" entry
))
966 ((= l ?u
) (reftex-get-bib-field "publisher" entry
))
967 ((= l ?r
) (reftex-get-bib-field "address" entry
))
968 ((= l ?t
) (reftex-get-bib-field "title" entry
))
969 ((= l ?T
) (reftex-abbreviate-title
970 (reftex-get-bib-field "title" entry
)))
971 ((= l ?v
) (reftex-get-bib-field "volume" entry
))
972 ((= l ?y
) (reftex-get-bib-field "year" entry
)))))
975 (setq b
(match-beginning 2) e
(match-end 2))
976 (setq b
(match-beginning 3) e
(match-end 3)))
977 (setq format
(concat (substring format
0 b
) rpl
(substring format e
)))))
978 (while (string-match "%%" format
)
979 (setq format
(replace-match "%" t t format
)))
980 (while (string-match "[ ,.;:]*%<" format
)
981 (setq format
(replace-match "" t t format
)))
984 (defun reftex-make-cite-echo-string (entry docstruct-symbol
)
985 ;; Format a bibtex entry for the echo area and cache the result.
986 (let* ((key (reftex-get-bib-field "&key" entry
))
988 (let* ((reftex-cite-punctuation '(" " " & " " etal.")))
989 (reftex-format-citation entry reftex-cite-view-format
)))
990 (cache (assq 'bibview-cache
(symbol-value docstruct-symbol
)))
991 (cache-entry (assoc key
(cdr cache
))))
993 ;; This docstruct has no cache - make one.
994 (set docstruct-symbol
(cons (cons 'bibview-cache nil
)
995 (symbol-value docstruct-symbol
))))
996 (when reftex-cache-cite-echo
997 (setq key
(copy-sequence key
))
998 (set-text-properties 0 (length key
) nil key
)
999 (set-text-properties 0 (length string
) nil string
)
1001 (unless (string= (cdr cache-entry
) string
)
1002 (setcdr cache-entry string
)
1003 (put reftex-docstruct-symbol
'modified t
))
1004 (push (cons key string
) (cdr cache
))
1005 (put reftex-docstruct-symbol
'modified t
)))
1008 (defun reftex-bibtex-selection-callback (data ignore no-revisit
)
1009 ;; Callback function to be called from the BibTeX selection, in
1010 ;; order to display context. This function is relatively slow and not
1011 ;; recommended for follow mode. It works OK for individual lookups.
1012 (let ((win (selected-window))
1013 (key (reftex-get-bib-field "&key" data
))
1014 bibfile-list item bibtype
)
1018 (set-buffer reftex-call-back-to-this-buffer
)
1019 (setq bibtype
(reftex-bib-or-thebib))
1022 ; ((assq 'bib (symbol-value reftex-docstruct-symbol))
1023 (setq bibfile-list
(reftex-get-bibfile-list)))
1024 ((eq bibtype
'thebib
)
1025 ; ((assq 'thebib (symbol-value reftex-docstruct-symbol))
1030 'thebib
(symbol-value reftex-docstruct-symbol
))))
1032 (reftex-default-bibliography
1033 (setq bibfile-list
(reftex-default-bibliography)))
1034 (t (ding) (throw 'exit nil
))))
1037 (setq bibfile-list
(reftex-visited-files bibfile-list
)))
1040 (reftex-pop-to-bibtex-entry
1041 key bibfile-list
(not reftex-keep-temporary-buffers
) t item
)
1044 (select-window win
)))
1046 ;;; arch-tag: d53d0a5a-ab32-4b52-a846-2a7c3527cd89
1047 ;;; reftex-cite.el ends here