1 ;;; reftex-cite.el --- creating citations with RefTeX
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <dominik@science.uva.nl>
7 ;; Maintainer: auctex-devel@gnu.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 (eval-when-compile (require 'cl
))
31 (provide 'reftex-cite
)
35 ;; Variables and constants
37 ;; The history list of regular expressions used for citations
38 (defvar reftex-cite-regexp-hist nil
)
40 ;; Prompt and help string for citation selection
41 (defconst reftex-citation-prompt
42 "Select: [n]ext [p]revious [r]estrict [ ]full_entry [q]uit RET [?]Help+more")
44 (defconst reftex-citation-help
45 " n / p Go to next/previous entry (Cursor motion works as well).
46 g / r Start over with new regexp / Refine with additional regexp.
47 SPC Show full database entry in other window.
48 f Toggle follow mode: Other window will follow with full db entry.
49 . Show insertion point.
50 q Quit without inserting \\cite macro into buffer.
51 TAB Enter citation key with completion.
52 RET Accept current entry (also on mouse-2) and create \\cite macro.
53 m / u Mark/Unmark the entry.
54 e / E Create BibTeX file with all (marked/unmarked) entries
55 a / A Put all (marked) entries into one/many \\cite commands.")
59 (defmacro reftex-with-special-syntax-for-bib
(&rest body
)
60 `(let ((saved-syntax (syntax-table)))
63 (set-syntax-table reftex-syntax-table-for-bib
)
65 (set-syntax-table saved-syntax
))))
67 (defun reftex-default-bibliography ()
68 ;; Return the expanded value of `reftex-default-bibliography'.
69 ;; The expanded value is cached.
70 (unless (eq (get 'reftex-default-bibliography
:reftex-raw
)
71 reftex-default-bibliography
)
72 (put 'reftex-default-bibliography
:reftex-expanded
73 (reftex-locate-bibliography-files
74 default-directory reftex-default-bibliography
))
75 (put 'reftex-default-bibliography
:reftex-raw
76 reftex-default-bibliography
))
77 (get 'reftex-default-bibliography
:reftex-expanded
))
79 (defun reftex-bib-or-thebib ()
80 ;; Tests if BibTeX or \begin{tehbibliography} should be used for the
82 ;; Find the bof of the current file
83 (let* ((docstruct (symbol-value reftex-docstruct-symbol
))
84 (rest (or (member (list 'bof
(buffer-file-name)) docstruct
)
86 (bib (assq 'bib rest
))
87 (thebib (assq 'thebib rest
))
88 (bibmem (memq bib rest
))
89 (thebibmem (memq thebib rest
)))
90 (when (not (or thebib bib
))
91 (setq bib
(assq 'bib docstruct
)
92 thebib
(assq 'thebib docstruct
)
93 bibmem
(memq bib docstruct
)
94 thebibmem
(memq thebib docstruct
)))
95 (if (> (length bibmem
) (length thebibmem
))
97 (if thebib
'thebib nil
))))
99 (defun reftex-get-bibfile-list ()
100 ;; Return list of bibfiles for current document.
101 ;; When using the chapterbib or bibunits package you should either
102 ;; use the same database files everywhere, or separate parts using
103 ;; different databases into different files (included into the mater file).
104 ;; Then this function will return the applicable database files.
106 ;; Ensure access to scanning info
107 (reftex-access-scan-info)
109 ;; Try inside this file (and its includes)
110 (cdr (reftex-last-assoc-before-elt
111 'bib
(list 'eof
(buffer-file-name))
112 (member (list 'bof
(buffer-file-name))
113 (symbol-value reftex-docstruct-symbol
))))
114 ;; Try after the beginning of this file
115 (cdr (assq 'bib
(member (list 'bof
(buffer-file-name))
116 (symbol-value reftex-docstruct-symbol
))))
117 ;; Anywhere in the entire document
118 (cdr (assq 'bib
(symbol-value reftex-docstruct-symbol
)))
119 (error "\\bibliography statement missing or .bib files not found")))
121 ;; Find a certain reference in any of the BibTeX files.
123 (defun reftex-pop-to-bibtex-entry (key file-list
&optional mark-to-kill
124 highlight item return
)
125 ;; Find BibTeX KEY in any file in FILE-LIST in another window.
126 ;; If MARK-TO-KILL is non-nil, mark new buffer to kill.
127 ;; If HIGHLIGHT is non-nil, highlight the match.
128 ;; If ITEM in non-nil, search for bibitem instead of database entry.
129 ;; If RETURN is non-nil, just return the entry and restore point.
133 (concat "\\\\bibitem\\(\\[[^]]*\\]\\)?{" (regexp-quote key
) "}")
134 (concat "@[a-zA-Z]+[ \t\n\r]*[{(][ \t\n\r]*" (regexp-quote key
)
136 (buffer-conf (current-buffer))
141 (setq file
(car file-list
)
142 file-list
(cdr file-list
))
143 (unless (setq buf
(reftex-get-file-buffer-force file mark-to-kill
))
144 (error "No such file %s" file
))
146 (setq oldpos
(point))
148 (goto-char (point-min))
149 (if (not (re-search-forward re nil t
))
150 (goto-char oldpos
) ;; restore previous position of point
151 (goto-char (match-beginning 0))
154 ;; Just return the relevant entry
155 (if item
(goto-char (match-end 0)))
156 (setq return
(buffer-substring
157 (point) (reftex-end-of-bib-entry item
)))
158 (goto-char oldpos
) ;; restore point.
159 (set-buffer buffer-conf
)
160 (throw 'exit return
))
161 (switch-to-buffer-other-window buf
)
165 (reftex-highlight 0 (match-beginning 0) (match-end 0)))
166 (throw 'exit
(selected-window))))
167 (set-buffer buffer-conf
)
169 (error "No \\bibitem with citation key %s" key
)
170 (error "No BibTeX entry with citation key %s" key
)))))
172 (defun reftex-end-of-bib-entry (item)
178 "\\\\bibitem\\|\\end{thebibliography}")
179 (1- (match-beginning 0)))
180 (progn (forward-list 1) (point)))
181 (error (min (point-max) (+ 300 (point)))))))
183 ;; Parse bibtex buffers
185 (defun reftex-extract-bib-entries (buffers)
186 ;; Extract bib entries which match regexps from BUFFERS.
187 ;; BUFFERS is a list of buffers or file names.
188 ;; Return list with entries."
189 (let* (re-list first-re rest-re
190 (buffer-list (if (listp buffers
) buffers
(list buffers
)))
191 found-list entry buffer1 buffer alist
192 key-point start-point end-point default
)
194 ;; Read a regexp, completing on known citation keys.
195 (setq default
(regexp-quote (reftex-get-bibkey-default)))
200 "Regex { && Regex...}: "
203 (if (fboundp 'LaTeX-bibitem-list
)
205 (cdr (assoc 'bibview-cache
206 (symbol-value reftex-docstruct-symbol
))))
208 nil nil nil
'reftex-cite-regexp-hist
)
211 (if (or (null re-list
) (equal re-list
'("")))
212 (setq re-list
(list default
)))
214 (setq first-re
(car re-list
) ; We'll use the first re to find things,
215 rest-re
(cdr re-list
)) ; the others to narrow down.
216 (if (string-match "\\`[ \t]*\\'" (or first-re
""))
217 (error "Empty regular expression"))
220 (save-window-excursion
222 ;; Walk through all bibtex files
224 (setq buffer
(car buffer-list
)
225 buffer-list
(cdr buffer-list
))
226 (if (and (bufferp buffer
)
227 (buffer-live-p buffer
))
228 (setq buffer1 buffer
)
229 (setq buffer1
(reftex-get-file-buffer-force
230 buffer
(not reftex-keep-temporary-buffers
))))
232 (message "No such BibTeX file %s (ignored)" buffer
)
233 (message "Scanning bibliography database %s" buffer1
))
236 (reftex-with-special-syntax-for-bib
238 (goto-char (point-min))
239 (while (re-search-forward first-re nil t
)
241 (setq key-point
(point))
242 (unless (re-search-backward
243 "\\(\\`\\|[\n\r]\\)[ \t]*@\\([a-zA-Z]+\\)[ \t\n\r]*[{(]" nil t
)
244 (throw 'search-again nil
))
245 (setq start-point
(point))
246 (goto-char (match-end 0))
249 (error (goto-char key-point
)
250 (throw 'search-again nil
)))
251 (setq end-point
(point))
253 ;; Ignore @string, @comment and @c entries or things
255 (when (or (string= (downcase (match-string 2)) "string")
256 (string= (downcase (match-string 2)) "comment")
257 (string= (downcase (match-string 2)) "c")
258 (< (point) key-point
)) ; this means match not in {}
259 (goto-char key-point
)
260 (throw 'search-again nil
))
262 ;; Well, we have got a match
263 ;;(setq entry (concat
264 ;; (buffer-substring start-point (point)) "\n"))
265 (setq entry
(buffer-substring start-point
(point)))
267 ;; Check if other regexp match as well
268 (setq re-list rest-re
)
270 (unless (string-match (car re-list
) entry
)
272 (throw 'search-again nil
))
275 (setq alist
(reftex-parse-bibtex-entry
276 nil start-point end-point
))
277 (push (cons "&entry" entry
) alist
)
279 ;; check for crossref entries
280 (if (assoc "crossref" alist
)
283 alist
(reftex-get-crossref-alist alist
))))
286 (push (cons "&formatted" (reftex-format-bib-entry alist
))
289 ;; make key the first element
290 (push (reftex-get-bib-field "&key" alist
) alist
)
292 ;; add it to the list
293 (push alist found-list
)))))
294 (reftex-kill-temporary-buffers))))
295 (setq found-list
(nreverse found-list
))
299 ((eq 'author reftex-sort-bibtex-matches
)
300 (sort found-list
'reftex-bib-sort-author
))
301 ((eq 'year reftex-sort-bibtex-matches
)
302 (sort found-list
'reftex-bib-sort-year
))
303 ((eq 'reverse-year reftex-sort-bibtex-matches
)
304 (sort found-list
'reftex-bib-sort-year-reverse
))
307 (defun reftex-bib-sort-author (e1 e2
)
308 (let ((al1 (reftex-get-bib-names "author" e1
))
309 (al2 (reftex-get-bib-names "author" e2
)))
310 (while (and al1 al2
(string= (car al1
) (car al2
)))
313 (if (and (stringp (car al1
))
315 (string< (car al1
) (car al2
))
316 (not (stringp (car al1
))))))
318 (defun reftex-bib-sort-year (e1 e2
)
319 (< (string-to-number (or (cdr (assoc "year" e1
)) "0"))
320 (string-to-number (or (cdr (assoc "year" e2
)) "0"))))
322 (defun reftex-bib-sort-year-reverse (e1 e2
)
323 (> (string-to-number (or (cdr (assoc "year" e1
)) "0"))
324 (string-to-number (or (cdr (assoc "year" e2
)) "0"))))
326 (defun reftex-get-crossref-alist (entry)
327 ;; return the alist from a crossref entry
328 (let ((crkey (cdr (assoc "crossref" entry
)))
333 (if (re-search-forward
334 (concat "@\\w+[{(][ \t\n\r]*" (regexp-quote crkey
)
335 "[ \t\n\r]*,") nil t
)
337 (setq start
(match-beginning 0))
341 (reftex-parse-bibtex-entry nil start
(point)))
344 ;; Parse the bibliography environment
345 (defun reftex-extract-bib-entries-from-thebibliography (files)
346 ;; Extract bib-entries from the \begin{thebibliography} environment.
347 ;; Parsing is not as good as for the BibTeX database stuff.
348 ;; The environment should be located in file FILE.
350 (let* (start end buf entries re re-list file default
)
352 (error "Need file name to find thebibliography environment"))
353 (while (setq file
(pop files
))
354 (setq buf
(reftex-get-file-buffer-force
355 file
(not reftex-keep-temporary-buffers
)))
357 (error "No such file %s" file
))
358 (message "Scanning thebibliography environment in %s" file
)
360 (with-current-buffer buf
363 (goto-char (point-min))
364 (while (re-search-forward
365 "\\(\\`\\|[\n\r]\\)[ \t]*\\\\begin{thebibliography}" nil t
)
366 (beginning-of-line 2)
368 (if (re-search-forward
369 "\\(\\`\\|[\n\r]\\)[ \t]*\\\\end{thebibliography}" nil t
)
371 (beginning-of-line 1)
373 (when (and start end
)
376 (mapcar 'reftex-parse-bibitem
379 (buffer-substring-no-properties start end
)
380 "[ \t\n\r]*\\\\bibitem\\(\\[[^]]*]\\)*"))))))
383 (error "No bibitems found"))
385 ;; Read a regexp, completing on known citation keys.
386 (setq default
(regexp-quote (reftex-get-bibkey-default)))
391 "Regex { && Regex...}: "
394 (if (fboundp 'LaTeX-bibitem-list
)
396 (cdr (assoc 'bibview-cache
397 (symbol-value reftex-docstruct-symbol
))))
399 nil nil nil
'reftex-cite-regexp-hist
)
402 (if (or (null re-list
) (equal re-list
'("")))
403 (setq re-list
(list default
)))
405 (if (string-match "\\`[ \t]*\\'" (car re-list
))
406 (error "Empty regular expression"))
408 (while (and (setq re
(pop re-list
)) entries
)
412 (if (string-match re
(cdr (assoc "&entry" x
)))
418 (push (cons "&formatted" (reftex-format-bibitem x
)) x
)
419 (push (reftex-get-bib-field "&key" x
) x
)
425 (defun reftex-get-bibkey-default ()
426 ;; Return the word before the cursor. If the cursor is in a
427 ;; citation macro, return the word before the macro.
428 (let* ((macro (reftex-what-macro 1)))
430 (if (and macro
(string-match "cite" (car macro
)))
431 (goto-char (cdr macro
)))
432 (skip-chars-backward "^a-zA-Z0-9")
433 (reftex-this-word))))
435 ;; Parse and format individual entries
437 (defun reftex-get-bib-names (field entry
)
438 ;; Return a list with the author or editor names in ENTRY
439 (let ((names (reftex-get-bib-field field entry
)))
441 (setq names
(reftex-get-bib-field "editor" entry
)))
442 (while (string-match "\\band\\b[ \t]*" names
)
443 (setq names
(replace-match "\n" nil t names
)))
444 (while (string-match "[\\.a-zA-Z\\-]+\\.[ \t]*\\|,.*\\|[{}]+" names
)
445 (setq names
(replace-match "" nil t names
)))
446 (while (string-match "^[ \t]+\\|[ \t]+$" names
)
447 (setq names
(replace-match "" nil t names
)))
448 (while (string-match "[ \t][ \t]+" names
)
449 (setq names
(replace-match " " nil t names
)))
450 (split-string names
"\n")))
452 (defun reftex-parse-bibtex-entry (entry &optional from to
)
453 (let (alist key start field
)
458 (set-buffer (get-buffer-create " *RefTeX-scratch*"))
460 (set-syntax-table reftex-syntax-table-for-bib
)
464 (narrow-to-region from to
))
465 (goto-char (point-min))
467 (if (re-search-forward
468 "@\\(\\w+\\)[ \t\n\r]*[{(][ \t\n\r]*\\([^ \t\n\r,]+\\)" nil t
)
471 (cons "&type" (downcase (reftex-match-string 1)))
472 (cons "&key" (reftex-match-string 2)))))
473 (while (re-search-forward "\\(\\w+\\)[ \t\n\r]*=[ \t\n\r]*" nil t
)
474 (setq key
(downcase (reftex-match-string 1)))
476 ((= (following-char) ?
{)
482 ((= (following-char) ?
\")
485 (while (and (search-forward "\"" nil t
)
486 (= ?
\\ (char-after (- (point) 2))))))
489 (re-search-forward "[ \t]*[\n\r,}]" nil
1)))
490 (setq field
(buffer-substring-no-properties start
(1- (point))))
491 ;; remove extra whitespace
492 (while (string-match "[\n\t\r]\\|[ \t][ \t]+" field
)
493 (setq field
(replace-match " " nil t field
)))
494 ;; remove leading garbage
495 (if (string-match "^[ \t{]+" field
)
496 (setq field
(replace-match "" nil t field
)))
497 ;; remove trailing garbage
498 (if (string-match "[ \t}]+$" field
)
499 (setq field
(replace-match "" nil t field
)))
500 (push (cons key field
) alist
))))
503 (defun reftex-get-bib-field (fieldname entry
&optional format
)
504 ;; Extract the field FIELDNAME from an ENTRY
505 (let ((cell (assoc fieldname entry
)))
508 (format format
(cdr cell
))
512 (defun reftex-format-bib-entry (entry)
513 ;; Format a BibTeX ENTRY so that it is nice to look at
515 ((auth-list (reftex-get-bib-names "author" entry
))
516 (authors (mapconcat 'identity auth-list
", "))
517 (year (reftex-get-bib-field "year" entry
))
518 (title (reftex-get-bib-field "title" entry
))
519 (type (reftex-get-bib-field "&type" entry
))
520 (key (reftex-get-bib-field "&key" entry
))
523 ((equal type
"article")
524 (concat (reftex-get-bib-field "journal" entry
) " "
525 (reftex-get-bib-field "volume" entry
) ", "
526 (reftex-get-bib-field "pages" entry
)))
528 (concat "book (" (reftex-get-bib-field "publisher" entry
) ")"))
529 ((equal type
"phdthesis")
530 (concat "PhD: " (reftex-get-bib-field "school" entry
)))
531 ((equal type
"mastersthesis")
532 (concat "Master: " (reftex-get-bib-field "school" entry
)))
533 ((equal type
"inbook")
534 (concat "Chap: " (reftex-get-bib-field "chapter" entry
)
535 ", pp. " (reftex-get-bib-field "pages" entry
)))
536 ((or (equal type
"conference")
537 (equal type
"incollection")
538 (equal type
"inproceedings"))
539 (reftex-get-bib-field "booktitle" entry
"in: %s"))
541 (setq authors
(reftex-truncate authors
30 t t
))
542 (when (reftex-use-fonts)
543 (put-text-property 0 (length key
) 'face
544 (reftex-verified-face reftex-label-face
545 'font-lock-constant-face
546 'font-lock-reference-face
)
548 (put-text-property 0 (length authors
) 'face reftex-bib-author-face
550 (put-text-property 0 (length year
) 'face reftex-bib-year-face
552 (put-text-property 0 (length title
) 'face reftex-bib-title-face
554 (put-text-property 0 (length extra
) 'face reftex-bib-extra-face
556 (concat key
"\n " authors
" " year
" " extra
"\n " title
"\n\n")))
558 (defun reftex-parse-bibitem (item)
559 ;; Parse a \bibitem entry
560 (let ((key "") (text ""))
561 (when (string-match "\\`{\\([^}]+\\)}\\([^\000]*\\)" item
)
562 (setq key
(match-string 1 item
)
563 text
(match-string 2 item
)))
564 ;; Clean up the text a little bit
565 (while (string-match "[\n\r\t]\\|[ \t][ \t]+" text
)
566 (setq text
(replace-match " " nil t text
)))
567 (if (string-match "\\`[ \t]+" text
)
568 (setq text
(replace-match "" nil t text
)))
572 (cons "&entry" (concat key
" " text
)))))
574 (defun reftex-format-bibitem (item)
575 ;; Format a \bibitem entry so that it is (relatively) nice to look at.
576 (let ((text (reftex-get-bib-field "&text" item
))
577 (key (reftex-get-bib-field "&key" item
))
580 ;; Wrap the text into several lines.
581 (while (and (> (length text
) 70)
582 (string-match " " (substring text
60)))
583 (push (substring text
0 (+ 60 (match-beginning 0))) lines
)
584 (setq text
(substring text
(+ 61 (match-beginning 0)))))
586 (setq text
(mapconcat 'identity
(nreverse lines
) "\n "))
588 (when (reftex-use-fonts)
589 (put-text-property 0 (length text
) 'face reftex-bib-author-face text
))
590 (concat key
"\n " text
"\n\n")))
595 (defun reftex-citation (&optional no-insert format-key
)
596 "Make a citation using BibTeX database files.
597 After prompting for a regular expression, scans the buffers with
598 bibtex entries (taken from the \\bibliography command) and offers the
599 matching entries for selection. The selected entry is formatted according
600 to `reftex-cite-format' and inserted into the buffer.
602 If NO-INSERT is non-nil, nothing is inserted, only the selected key returned.
604 FORMAT-KEY can be used to pre-select a citation format.
606 When called with a `C-u' prefix, prompt for optional arguments in
607 cite macros. When called with a numeric prefix, make that many
608 citations. When called with point inside the braces of a `\\cite'
609 command, it will add another key, ignoring the value of
610 `reftex-cite-format'.
612 The regular expression uses an expanded syntax: && is interpreted as `and'.
613 Thus, `aaaa&&bbb' matches entries which contain both `aaaa' and `bbb'.
614 While entering the regexp, completion on knows citation keys is possible.
615 `=' is a good regular expression to match all entries in all files."
619 ;; check for recursive edit
620 (reftex-check-recursive-edit)
622 ;; This function may also be called outside reftex-mode.
623 ;; Thus look for the scanning info only if in reftex-mode.
626 (reftex-access-scan-info nil
))
628 ;; Call reftex-do-citation, but protected
630 (reftex-do-citation current-prefix-arg no-insert format-key
)
631 (reftex-kill-temporary-buffers)))
633 (defun reftex-do-citation (&optional arg no-insert format-key
)
634 ;; This really does the work of reftex-citation.
636 (let* ((format (reftex-figure-out-cite-format arg no-insert format-key
))
637 (docstruct-symbol reftex-docstruct-symbol
)
638 (selected-entries (reftex-offer-bib-menu))
639 (insert-entries selected-entries
)
640 entry string cite-view
)
642 (when (stringp selected-entries
)
643 (error selected-entries
))
644 (unless selected-entries
(error "Quit"))
646 (if (stringp selected-entries
)
648 (setq selected-entries nil
649 insert-entries
(list (list selected-entries
650 (cons "&key" selected-entries
))))
651 ;; It makes sense to compute the cite-view strings.
654 (when (eq (car selected-entries
) 'concat
)
655 ;; All keys go into a single command - we need to trick a little
656 ;; FIXME: Unfortunately, this meens that commenting does not work right.
657 (pop selected-entries
)
658 (let ((concat-keys (mapconcat 'car selected-entries
",")))
660 (list (list concat-keys
(cons "&key" concat-keys
))))))
664 ;; We shall insert this into the buffer...
665 (message "Formatting...")
667 (while (setq entry
(pop insert-entries
))
668 ;; Format the citation and insert it
669 (setq string
(if reftex-format-cite-function
670 (funcall reftex-format-cite-function
671 (reftex-get-bib-field "&key" entry
)
673 (reftex-format-citation entry format
)))
674 (when (or (eq reftex-cite-prompt-optional-args t
)
675 (and reftex-cite-prompt-optional-args
677 (let ((start 0) (nth 0) value
)
678 (while (setq start
(string-match "\\[\\]" string start
))
679 (setq value
(read-string (format "Optional argument %d: "
680 (setq nth
(1+ nth
)))))
681 (setq string
(replace-match (concat "[" value
"]") t t string
))
682 (setq start
(1+ start
)))))
683 ;; Should we cleanup empty optional arguments?
684 ;; if the first is empty, it can be removed. If the second is empty,
685 ;; it has to go. If there is only a single arg and empty, it can go
687 (when reftex-cite-cleanup-optional-args
689 ((string-match "\\([a-zA-Z0-9]\\)\\[\\]{" string
)
690 (setq string
(replace-match "\\1{" nil nil string
)))
691 ((string-match "\\[\\]\\(\\[[a-zA-Z0-9., ]+\\]\\)" string
)
692 (setq string
(replace-match "\\1" nil nil string
)))
693 ((string-match "\\[\\]\\[\\]" string
)
694 (setq string
(replace-match "" t t string
)))))
697 ;; Reposition cursor?
698 (when (string-match "\\?" string
)
699 (search-backward "?")
703 (when (and reftex-mode
704 (fboundp 'LaTeX-add-bibitems
)
705 reftex-plug-into-AUCTeX
)
706 (apply 'LaTeX-add-bibitems
(mapcar 'car selected-entries
)))
708 ;; Produce the cite-view strings
709 (when (and reftex-mode reftex-cache-cite-echo cite-view
)
710 (mapc (lambda (entry)
711 (reftex-make-cite-echo-string entry docstruct-symbol
))
716 (set-marker reftex-select-return-marker nil
)
717 (reftex-kill-buffer "*RefTeX Select*")
719 ;; Check if the prefix arg was numeric, and call recursively
723 (skip-chars-backward "}")
725 (reftex-do-citation arg
))
728 ;; Return the citation key
729 (car (car selected-entries
))))
731 (defun reftex-figure-out-cite-format (arg &optional no-insert format-key
)
732 ;; Check if there is already a cite command at point and change cite format
733 ;; in order to only add another reference in the same cite command.
734 (let ((macro (car (reftex-what-macro 1)))
735 (cite-format-value (reftex-get-cite-format))
739 ;; Format does not really matter because nothing will be inserted.
742 ((and (stringp macro
)
743 (string-match "\\`\\\\cite\\|cite\\'" macro
))
744 ;; We are already inside a cite macro
745 (if (or (not arg
) (not (listp arg
)))
748 (if (member (preceding-char) '(?\
{ ?
,)) "" ",")
750 (if (member (following-char) '(?\
} ?
,)) "" ",")))
753 ;; Figure out the correct format
755 (if (and (symbolp cite-format-value
)
756 (assq cite-format-value reftex-cite-format-builtin
))
757 (nth 2 (assq cite-format-value reftex-cite-format-builtin
))
762 (reftex-select-with-char
763 "" (concat "SELECT A CITATION FORMAT\n\n"
766 (format "[%c] %s %s" (car x
)
767 (if (> (car x
) 31) " " "")
770 (if (assq key format
)
771 (setq format
(cdr (assq key format
)))
772 (error "No citation format associated with key `%c'" key
)))))
775 (defun reftex-citep ()
776 "Call `reftex-citation' with a format selector `?p'."
778 (reftex-citation nil ?p
))
780 (defun reftex-citet ()
781 "Call `reftex-citation' with a format selector `?t'."
783 (reftex-citation nil ?t
))
785 (defvar reftex-select-bib-map
)
786 (defun reftex-offer-bib-menu ()
787 ;; Offer bib menu and return list of selected items
789 (let ((bibtype (reftex-bib-or-thebib))
790 found-list rtn key data selected-entries
)
798 ; ((assq 'bib (symbol-value reftex-docstruct-symbol))
799 ;; using BibTeX database files.
800 (reftex-extract-bib-entries (reftex-get-bibfile-list)))
801 ((eq bibtype
'thebib
)
802 ; ((assq 'thebib (symbol-value reftex-docstruct-symbol))
803 ;; using thebibliography environment.
804 (reftex-extract-bib-entries-from-thebibliography
808 'thebib
(symbol-value reftex-docstruct-symbol
))))))
809 (reftex-default-bibliography
810 (message "Using default bibliography")
811 (reftex-extract-bib-entries (reftex-default-bibliography)))
812 (t (error "No valid bibliography in this document, and no default available"))))
815 (error "Sorry, no matches found"))
817 ;; Remember where we came from
818 (setq reftex-call-back-to-this-buffer
(current-buffer))
819 (set-marker reftex-select-return-marker
(point))
822 (save-window-excursion
823 (delete-other-windows)
824 (reftex-kill-buffer "*RefTeX Select*")
825 (switch-to-buffer-other-window "*RefTeX Select*")
826 (unless (eq major-mode
'reftex-select-bib-mode
)
827 (reftex-select-bib-mode))
828 (let ((buffer-read-only nil
))
830 (reftex-insert-bib-matches found-list
))
831 (setq buffer-read-only t
)
832 (if (= 0 (buffer-size))
833 (error "No matches found"))
834 (setq truncate-lines t
)
839 reftex-citation-prompt
841 reftex-select-bib-map
843 'reftex-bibtex-selection-callback nil
))
846 (unless key
(throw 'done t
))
852 ;; Restrict with new regular expression
853 (setq found-list
(reftex-restrict-bib-matches found-list
))
854 (let ((buffer-read-only nil
))
856 (reftex-insert-bib-matches found-list
))
860 (setq selected-entries
861 (if reftex-select-marked
862 (mapcar 'car
(nreverse reftex-select-marked
))
866 ;; Take all (marked), and push the symbol 'concat
867 (setq selected-entries
869 (if reftex-select-marked
870 (mapcar 'car
(nreverse reftex-select-marked
))
874 ;; Take all (marked), and push the symbol 'concat
875 (reftex-extract-bib-file found-list reftex-select-marked
)
876 (setq selected-entries
"BibTeX database file created")
879 ;; Take all (marked), and push the symbol 'concat
880 (reftex-extract-bib-file found-list reftex-select-marked
882 (setq selected-entries
"BibTeX database file created")
887 (setq selected-entries
888 (if reftex-select-marked
890 (mapcar 'car
(nreverse reftex-select-marked
)))
891 (if data
(list data
) nil
)))
894 ;; Got this one with completion
895 (setq selected-entries key
)
901 (defun reftex-restrict-bib-matches (found-list)
902 ;; Limit FOUND-LIST with more regular expressions
903 (let ((re-list (split-string (read-string
904 "RegExp [ && RegExp...]: "
905 nil
'reftex-cite-regexp-hist
)
907 (found-list-r found-list
)
909 (while (setq re
(pop re-list
))
915 re
(cdr (assoc "&entry" x
)))
924 (defun reftex-extract-bib-file (all &optional marked complement
)
925 ;; Limit FOUND-LIST with more regular expressions
926 (let ((file (read-file-name "File to create: ")))
927 (find-file-other-window file
)
928 (if (> (buffer-size) 0)
930 (format "Overwrite non-empty file %s? " file
))
937 (if (or (and (assoc x marked
) (not complement
))
938 (and (not (assoc x marked
)) complement
))
939 (cdr (assoc "&entry" x
))
941 (cdr (assoc "&entry" x
))))
943 (insert (mapconcat 'identity all
"\n\n"))
945 (goto-char (point-min))))
947 (defun reftex-insert-bib-matches (list)
948 ;; Insert the bib matches and number them correctly
950 (if (memq reftex-highlight-selection
'(mouse both
))
951 reftex-mouse-selected-face
956 (setq tmp
(cdr (assoc "&formatted" x
))
958 (put-text-property 0 len
:data x tmp
)
959 (put-text-property 0 (1- len
) 'mouse-face mouse-face tmp
)
962 (run-hooks 'reftex-display-copied-context-hook
))
964 (defun reftex-format-names (namelist n
)
965 (let (last (len (length namelist
)))
966 (if (= n
0) (setq n len
))
969 ((= 1 len
) (car namelist
))
970 ((> len n
) (concat (car namelist
) (nth 2 reftex-cite-punctuation
)))
973 last
(nth (1- n
) namelist
))
974 (setcdr (nthcdr (- n
2) namelist
) nil
)
976 (mapconcat 'identity namelist
(nth 0 reftex-cite-punctuation
))
977 (nth 1 reftex-cite-punctuation
)
980 (defun reftex-format-citation (entry format
)
981 ;; Format a citation from the info in the BibTeX ENTRY
983 (unless (stringp format
) (setq format
"\\cite{%l}"))
985 (if (and reftex-comment-citations
986 (string-match "%l" reftex-cite-comment-format
))
987 (error "reftex-cite-comment-format contains invalid %%l"))
990 "\\(\\`\\|[^%]\\)\\(\\(%\\([0-9]*\\)\\([a-zA-Z]\\)\\)[.,;: ]*\\)"
992 (let ((n (string-to-number (match-string 4 format
)))
993 (l (string-to-char (match-string 5 format
)))
999 (reftex-get-bib-field "&key" entry
)
1000 (if reftex-comment-citations
1001 reftex-cite-comment-format
1003 ((= l ?a
) (reftex-format-names
1004 (reftex-get-bib-names "author" entry
)
1006 ((= l ?A
) (car (reftex-get-bib-names "author" entry
)))
1007 ((= l ?b
) (reftex-get-bib-field "booktitle" entry
"in: %s"))
1008 ((= l ?B
) (reftex-abbreviate-title
1009 (reftex-get-bib-field "booktitle" entry
"in: %s")))
1010 ((= l ?c
) (reftex-get-bib-field "chapter" entry
))
1011 ((= l ?d
) (reftex-get-bib-field "edition" entry
))
1012 ((= l ?e
) (reftex-format-names
1013 (reftex-get-bib-names "editor" entry
)
1015 ((= l ?E
) (car (reftex-get-bib-names "editor" entry
)))
1016 ((= l ?h
) (reftex-get-bib-field "howpublished" entry
))
1017 ((= l ?i
) (reftex-get-bib-field "institution" entry
))
1018 ((= l ?j
) (reftex-get-bib-field "journal" entry
))
1019 ((= l ?k
) (reftex-get-bib-field "key" entry
))
1020 ((= l ?m
) (reftex-get-bib-field "month" entry
))
1021 ((= l ?n
) (reftex-get-bib-field "number" entry
))
1022 ((= l ?o
) (reftex-get-bib-field "organization" entry
))
1023 ((= l ?p
) (reftex-get-bib-field "pages" entry
))
1024 ((= l ?P
) (car (split-string
1025 (reftex-get-bib-field "pages" entry
)
1027 ((= l ?s
) (reftex-get-bib-field "school" entry
))
1028 ((= l ?u
) (reftex-get-bib-field "publisher" entry
))
1029 ((= l ?r
) (reftex-get-bib-field "address" entry
))
1030 ((= l ?t
) (reftex-get-bib-field "title" entry
))
1031 ((= l ?T
) (reftex-abbreviate-title
1032 (reftex-get-bib-field "title" entry
)))
1033 ((= l ?v
) (reftex-get-bib-field "volume" entry
))
1034 ((= l ?y
) (reftex-get-bib-field "year" entry
)))))
1036 (if (string= rpl
"")
1037 (setq b
(match-beginning 2) e
(match-end 2))
1038 (setq b
(match-beginning 3) e
(match-end 3)))
1039 (setq format
(concat (substring format
0 b
) rpl
(substring format e
)))))
1040 (while (string-match "%%" format
)
1041 (setq format
(replace-match "%" t t format
)))
1042 (while (string-match "[ ,.;:]*%<" format
)
1043 (setq format
(replace-match "" t t format
)))
1046 (defun reftex-make-cite-echo-string (entry docstruct-symbol
)
1047 ;; Format a bibtex entry for the echo area and cache the result.
1048 (let* ((key (reftex-get-bib-field "&key" entry
))
1050 (let* ((reftex-cite-punctuation '(" " " & " " etal.")))
1051 (reftex-format-citation entry reftex-cite-view-format
)))
1052 (cache (assq 'bibview-cache
(symbol-value docstruct-symbol
)))
1053 (cache-entry (assoc key
(cdr cache
))))
1055 ;; This docstruct has no cache - make one.
1056 (set docstruct-symbol
(cons (cons 'bibview-cache nil
)
1057 (symbol-value docstruct-symbol
))))
1058 (when reftex-cache-cite-echo
1059 (setq key
(copy-sequence key
))
1060 (set-text-properties 0 (length key
) nil key
)
1061 (set-text-properties 0 (length string
) nil string
)
1063 (unless (string= (cdr cache-entry
) string
)
1064 (setcdr cache-entry string
)
1065 (put reftex-docstruct-symbol
'modified t
))
1066 (push (cons key string
) (cdr cache
))
1067 (put reftex-docstruct-symbol
'modified t
)))
1070 (defun reftex-bibtex-selection-callback (data ignore no-revisit
)
1071 ;; Callback function to be called from the BibTeX selection, in
1072 ;; order to display context. This function is relatively slow and not
1073 ;; recommended for follow mode. It works OK for individual lookups.
1074 (let ((win (selected-window))
1075 (key (reftex-get-bib-field "&key" data
))
1076 bibfile-list item bibtype
)
1079 (with-current-buffer reftex-call-back-to-this-buffer
1080 (setq bibtype
(reftex-bib-or-thebib))
1083 ; ((assq 'bib (symbol-value reftex-docstruct-symbol))
1084 (setq bibfile-list
(reftex-get-bibfile-list)))
1085 ((eq bibtype
'thebib
)
1086 ; ((assq 'thebib (symbol-value reftex-docstruct-symbol))
1091 'thebib
(symbol-value reftex-docstruct-symbol
))))
1093 (reftex-default-bibliography
1094 (setq bibfile-list
(reftex-default-bibliography)))
1095 (t (ding) (throw 'exit nil
))))
1098 (setq bibfile-list
(reftex-visited-files bibfile-list
)))
1101 (reftex-pop-to-bibtex-entry
1102 key bibfile-list
(not reftex-keep-temporary-buffers
) t item
)
1105 (select-window win
)))
1107 ;;; Global BibTeX file
1108 (defun reftex-all-used-citation-keys ()
1109 (reftex-access-scan-info)
1110 (let ((files (reftex-all-document-files)) file keys kk k
)
1111 (save-current-buffer
1112 (while (setq file
(pop files
))
1113 (set-buffer (reftex-get-file-buffer-force file
'mark
))
1117 (goto-char (point-min))
1118 (while (re-search-forward "^[^%\n\r]*\\\\\\(bibentry\\|[a-zA-Z]*cite[a-zA-Z]*\\)\\(\\[[^\\]]*\\]\\)?{\\([^}]+\\)}" nil t
)
1119 (setq kk
(match-string-no-properties 3))
1120 (while (string-match "%.*\n?" kk
)
1121 (setq kk
(replace-match "" t t kk
)))
1122 (setq kk
(split-string kk
"[, \t\r\n]+"))
1123 (while (setq k
(pop kk
))
1125 (setq keys
(cons k keys
)))))))))
1126 (reftex-kill-temporary-buffers)
1129 (defun reftex-create-bibtex-file (bibfile)
1130 "Create a new BibTeX database file with all entries referenced in document.
1131 The command prompts for a filename and writes the collected entries to
1132 that file. Only entries referenced in the current document with
1133 any \\cite-like macros are used.
1134 The sequence in the new file is the same as it was in the old database."
1135 (interactive "FNew BibTeX file: ")
1136 (let ((keys (reftex-all-used-citation-keys))
1137 (files (reftex-get-bibfile-list))
1138 file key entries beg end entry
)
1139 (save-current-buffer
1140 (while (setq file
(pop files
))
1141 (set-buffer (reftex-get-file-buffer-force file
'mark
))
1142 (reftex-with-special-syntax-for-bib
1146 (goto-char (point-min))
1147 (while (re-search-forward
1148 "^[ \t]*@[a-zA-Z]+[ \t]*{\\([^ \t\r\n]+\\),"
1150 (setq key
(match-string 1)
1151 beg
(match-beginning 0)
1153 (goto-char (match-beginning 1))
1156 (error (goto-char (match-end 0))))
1158 (when (member key keys
)
1159 (setq entry
(buffer-substring beg end
)
1160 entries
(cons entry entries
)
1161 keys
(delete key keys
)))))))))
1162 (find-file-other-window bibfile
)
1163 (if (> (buffer-size) 0)
1164 (unless (yes-or-no-p
1165 (format "Overwrite non-empty file %s? " bibfile
))
1168 (insert (mapconcat 'identity
(reverse entries
) "\n\n"))
1169 (goto-char (point-min))
1171 (message "%d entries extracted and copied to new database"
1175 ;; arch-tag: d53d0a5a-ab32-4b52-a846-2a7c3527cd89
1176 ;;; reftex-cite.el ends here