mirror of https://github.com/Chizi123/.emacs.d.git

Chizi123
2018-11-21 5ddac8bd2392ec5b64392e8750d725029bf5aa79
commit | author | age
76bbd0 1 ;;; org-bibtex.el --- Org links to BibTeX entries    -*- lexical-binding: t; -*-
C 2 ;;
3 ;; Copyright (C) 2007-2018 Free Software Foundation, Inc.
4 ;;
5 ;; Authors: Bastien Guerry <bzg@gnu.org>
6 ;;       Carsten Dominik <carsten dot dominik at gmail dot com>
7 ;;       Eric Schulte <schulte dot eric at gmail dot com>
8 ;; Keywords: org, wp, capture
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
24 ;;
25 ;;; Commentary:
26 ;;
27 ;; This file implements links to database entries in BibTeX files.
28 ;; Instead of defining a special link prefix, it uses the normal file
29 ;; links combined with a custom search mechanism to find entries
30 ;; by reference key.  And it constructs a nice description tag for
31 ;; the link that contains the author name, the year and a short title.
32 ;;
33 ;; It also stores detailed information about the entry so that
34 ;; capture templates can access and enter this information easily.
35 ;;
36 ;; The available properties for each entry are listed here:
37 ;;
38 ;; :author        :publisher      :volume      :pages
39 ;; :editor        :url            :number      :journal
40 ;; :title         :year           :series      :address
41 ;; :booktitle     :month          :annote      :abstract
42 ;; :key           :btype
43 ;;
44 ;; Here is an example of a capture template that use some of this
45 ;; information (:author :year :title :journal :pages):
46 ;;
47 ;; (setq org-capture-templates
48 ;;   '((?b "* READ %?\n\n%a\n\n%:author (%:year): %:title\n   \
49 ;;          In %:journal, %:pages.")))
50 ;;
51 ;; Let's say you want to capture this BibTeX entry:
52 ;;
53 ;; @Article{dolev83,
54 ;;   author =      {Danny Dolev and Andrew C. Yao},
55 ;;   title =      {On the security of public-key protocols},
56 ;;   journal =      {IEEE Transaction on Information Theory},
57 ;;   year =      1983,
58 ;;   volume =     2,
59 ;;   number =     29,
60 ;;   pages =     {198--208},
61 ;;   month =     {Mars}
62 ;; }
63 ;;
64 ;; M-x `org-capture' on this entry will produce this buffer:
65 ;;
66 ;; =====================================================================
67 ;; * READ <== [point here]
68 ;;
69 ;; [[file:file.bib::dolev83][Dolev & Yao 1983: security of public key protocols]]
70 ;;
71 ;; Danny Dolev and Andrew C. Yao (1983): On the security of public-key protocols
72 ;; In IEEE Transaction on Information Theory, 198--208.
73 ;; =====================================================================
74 ;;
75 ;; Additionally, the following functions are now available for storing
76 ;; bibtex entries within Org documents.
77 ;;
78 ;; - Run `org-bibtex' to export the current file to a .bib.
79 ;;
80 ;; - Run `org-bibtex-check' or `org-bibtex-check-all' to check and
81 ;;   fill in missing field of either the current, or all headlines
82 ;;
83 ;; - Run `org-bibtex-create' to add a bibtex entry
84 ;;
85 ;; - Use `org-bibtex-read' to read a bibtex entry after `point' or in
86 ;;   the active region, then call `org-bibtex-write' in a .org file to
87 ;;   insert a heading for the read bibtex entry
88 ;;
89 ;; - All Bibtex information is taken from the document compiled by
90 ;;   Andrew Roberts from the Bibtex manual, available at
91 ;;   http://www.andy-roberts.net/res/writing/latex/bibentries.pdf
92 ;;
93 ;;; History:
94 ;;
95 ;; The link creation part has been part of Org for a long time.
96 ;;
97 ;; Creating better capture template information was inspired by a request
98 ;; of Austin Frank: http://article.gmane.org/gmane.emacs.orgmode/4112
99 ;; and then implemented by Bastien Guerry.
100 ;;
101 ;; Eric Schulte eventually added the functions for translating between
102 ;; Org headlines and Bibtex entries, and for fleshing out the Bibtex
103 ;; fields of existing Org headlines.
104 ;;
105 ;; Org mode loads this module by default - if this is not what you want,
106 ;; configure the variable `org-modules'.
107
108 ;;; Code:
109
110 (require 'org)
111 (require 'bibtex)
112 (require 'cl-lib)
113 (require 'org-compat)
114
115 (defvar org-agenda-overriding-header)
116 (defvar org-agenda-search-view-always-boolean)
117 (defvar org-bibtex-description nil) ; dynamically scoped from org.el
118 (defvar org-id-locations)
119
120 (declare-function bibtex-beginning-of-entry "bibtex" ())
121 (declare-function bibtex-generate-autokey "bibtex" ())
122 (declare-function bibtex-parse-entry "bibtex" (&optional content))
123 (declare-function bibtex-url "bibtex" (&optional pos no-browse))
124
125
126 ;;; Bibtex data
127 (defvar org-bibtex-types
128   '((:article
129      (:description . "An article from a journal or magazine")
130      (:required :author :title :journal :year)
131      (:optional :volume :number :pages :month :note))
132     (:book
133      (:description . "A book with an explicit publisher")
134      (:required (:editor :author) :title :publisher :year)
135      (:optional (:volume :number) :series :address :edition :month :note))
136     (:booklet
137      (:description . "A work that is printed and bound, but without a named publisher or sponsoring institution.")
138      (:required :title)
139      (:optional :author :howpublished :address :month :year :note))
140     (:conference
141      (:description . "")
142      (:required :author :title :booktitle :year)
143      (:optional :editor :pages :organization :publisher :address :month :note))
144     (:inbook
145      (:description . "A part of a book, which may be a chapter (or section or whatever) and/or a range of pages.")
146      (:required (:author :editor) :title (:chapter :pages) :publisher :year)
147      (:optional :crossref (:volume :number) :series :type :address :edition :month :note))
148     (:incollection
149      (:description . "A part of a book having its own title.")
150      (:required :author :title :booktitle :publisher :year)
151      (:optional :crossref :editor (:volume :number) :series :type :chapter :pages :address :edition :month :note))
152     (:inproceedings
153      (:description . "An article in a conference proceedings")
154      (:required :author :title :booktitle :year)
155      (:optional :crossref :editor (:volume :number) :series :pages :address :month :organization :publisher :note))
156     (:manual
157      (:description . "Technical documentation.")
158      (:required :title)
159      (:optional :author :organization :address :edition :month :year :note))
160     (:mastersthesis
161      (:description . "A Master’s thesis.")
162      (:required :author :title :school :year)
163      (:optional :type :address :month :note))
164     (:misc
165      (:description . "Use this type when nothing else fits.")
166      (:required)
167      (:optional :author :title :howpublished :month :year :note))
168     (:phdthesis
169      (:description . "A PhD thesis.")
170      (:required :author :title :school :year)
171      (:optional :type :address :month :note))
172     (:proceedings
173      (:description . "The proceedings of a conference.")
174      (:required :title :year)
175      (:optional :editor (:volume :number) :series :address :month :organization :publisher :note))
176     (:techreport
177      (:description . "A report published by a school or other institution.")
178      (:required :author :title :institution :year)
179      (:optional :type :address :month :note))
180     (:unpublished
181      (:description . "A document having an author and title, but not formally published.")
182      (:required :author :title :note)
183      (:optional :month :year)))
184   "Bibtex entry types with required and optional parameters.")
185
186 (defvar org-bibtex-fields
187   '((:address      . "Usually the address of the publisher or other type of institution.  For major publishing houses, van Leunen recommends omitting the information entirely.  For small publishers, on the other hand, you can help the reader by giving the complete address.")
188     (:annote       . "An annotation.  It is not used by the standard bibliography styles, but may be used by others that produce an annotated bibliography.")
189     (:author       . "The name(s) of the author(s), in the format described in the LaTeX book.  Remember, all names are separated with the and keyword, and not commas.")
190     (:booktitle    . "Title of a book, part of which is being cited.  See the LaTeX book for how to type titles.  For book entries, use the title field instead.")
191     (:chapter      . "A chapter (or section or whatever) number.")
192     (:crossref     . "The database key of the entry being cross referenced.")
193     (:edition      . "The edition of a book for example, 'Second'.  This should be an ordinal, and should have the first letter capitalized, as shown here; the standard styles convert to lower case when necessary.")
194     (:editor       . "Name(s) of editor(s), typed as indicated in the LaTeX book.  If there is also an author field, then the editor field gives the editor of the book or collection in which the reference appears.")
195     (:howpublished . "How something strange has been published.  The first word should be capitalized.")
196     (:institution  . "The sponsoring institution of a technical report.")
197     (:journal      . "A journal name.")
198     (:key          . "Used for alphabetizing, cross-referencing, and creating a label when the author information is missing.  This field should not be confused with the key that appears in the \\cite command and at the beginning of the database entry.")
199     (:month        . "The month in which the work was published or, for an unpublished work, in which it was written.  You should use the standard three-letter abbreviation,")
200     (:note         . "Any additional information that can help the reader.  The first word should be capitalized.")
201     (:number       . "Any additional information that can help the reader.  The first word should be capitalized.")
202     (:organization . "The organization that sponsors a conference or that publishes a manual.")
203     (:pages        . "One or more page numbers or range of numbers, such as 42-111 or 7,41,73-97 or 43+ (the â€˜+’ in this last example indicates pages following that don’t form simple range). BibTEX requires double dashes for page ranges (--).")
204     (:publisher    . "The publisher’s name.")
205     (:school       . "The name of the school where a thesis was written.")
206     (:series       . "The name of a series or set of books.  When citing an entire book, the title field gives its title and an optional series field gives the name of a series or multi-volume set in which the book is published.")
207     (:title        . "The work’s title, typed as explained in the LaTeX book.")
208     (:type         . "The type of a technical report for example, 'Research Note'.")
209     (:volume       . "The volume of a journal or multi-volume book.")
210     (:year         . "The year of publication or, for an unpublished work, the year it was written.  Generally it should consist of four numerals, such as 1984, although the standard styles can handle any year whose last four nonpunctuation characters are numerals, such as '(about 1984)'"))
211   "Bibtex fields with descriptions.")
212
213 (defvar org-bibtex-entries nil
214   "List to hold parsed bibtex entries.")
215
216 (defcustom org-bibtex-autogen-keys nil
217   "Set to a truth value to use `bibtex-generate-autokey' to generate keys."
218   :group 'org-bibtex
219   :version "24.1"
220   :type  'boolean)
221
222 (defcustom org-bibtex-prefix nil
223   "Optional prefix for all bibtex property names.
224 For example setting to `BIB_' would allow interoperability with fireforg."
225   :group 'org-bibtex
226   :version "24.1"
227   :type  '(choice
228        (const nil)
229        (string)))
230
231 (defcustom org-bibtex-treat-headline-as-title t
232   "Treat headline text as title if title property is absent.
233 If an entry is missing a title property, use the headline text as
234 the property.  If this value is t, `org-bibtex-check' will ignore
235 a missing title field."
236   :group 'org-bibtex
237   :version "24.1"
238   :type 'boolean)
239
240 (defcustom org-bibtex-headline-format-function
241   (lambda (entry) (cdr (assq :title entry)))
242   "Function returning the headline text for `org-bibtex-write'.
243 It should take a single argument, the bibtex entry (an alist as
244 returned by `org-bibtex-read').  The default value simply returns
245 the entry title."
246   :group 'org-bibtex
247   :version "26.1"
248   :package-version '(Org . "9.1")
249   :type 'function)
250
251 (defcustom org-bibtex-export-arbitrary-fields nil
252   "When converting to bibtex allow fields not defined in `org-bibtex-fields'.
253 This only has effect if `org-bibtex-prefix' is defined, so as to
254 ensure that other org-properties, such as CATEGORY or LOGGING are
255 not placed in the exported bibtex entry."
256   :group 'org-bibtex
257   :version "24.1"
258   :type 'boolean)
259
260 (defcustom org-bibtex-key-property "CUSTOM_ID"
261   "Property that holds the bibtex key.
262 By default, this is CUSTOM_ID, which enables easy linking to
263 bibtex headlines from within an org file.  This can be set to ID
264 to enable global links, but only with great caution, as global
265 IDs must be unique."
266   :group 'org-bibtex
267   :version "24.1"
268   :type 'string)
269
270 (defcustom org-bibtex-tags nil
271   "List of tag(s) that should be added to new bib entries."
272   :group 'org-bibtex
273   :version "24.1"
274   :type '(repeat  :tag "Tag" (string)))
275
276 (defcustom org-bibtex-tags-are-keywords nil
277   "Convert the value of the keywords field to tags and vice versa.
278
279 When non-nil, comma-separated entries in a bibtex entry's keywords
280 field will be converted to Org tags.  Note: spaces will be escaped
281 with underscores, and characters that are not permitted in Org
282 tags will be removed.
283
284 When non-nil, local tags in an Org entry will be exported as
285 a comma-separated string of keywords when exported to bibtex.
286 If `org-bibtex-inherit-tags' is non-nil, inherited tags will also
287 be exported as keywords.  Tags defined in `org-bibtex-tags' or
288 `org-bibtex-no-export-tags' will not be exported."
289   :group 'org-bibtex
290   :version "24.1"
291   :type 'boolean)
292
293 (defcustom org-bibtex-no-export-tags nil
294   "List of tag(s) that should not be converted to keywords.
295 This variable is relevant only if `org-bibtex-tags-are-keywords'
296 is non-nil."
297   :group 'org-bibtex
298   :version "24.1"
299   :type '(repeat :tag "Tag" (string)))
300
301 (defcustom org-bibtex-inherit-tags nil
302   "Controls whether inherited tags are converted to bibtex keywords.
303 It is relevant only if `org-bibtex-tags-are-keywords' is non-nil.
304 Tag inheritance itself is controlled by `org-use-tag-inheritance'
305 and `org-exclude-tags-from-inheritance'."
306   :group 'org-bibtex
307   :version "26.1"
308   :package-version '(Org . "8.3")
309   :type 'boolean)
310
311 (defcustom org-bibtex-type-property-name "btype"
312   "Property in which to store bibtex entry type (e.g., article)."
313   :group 'org-bibtex
314   :version "24.1"
315   :type 'string)
316
317
318 ;;; Utility functions
319 (defun org-bibtex-get (property)
320   (let ((it (let ((org-special-properties
321                    (delete "FILE" (copy-sequence org-special-properties))))
322               (or
323                (org-entry-get (point) (upcase property))
324                (org-entry-get (point) (concat org-bibtex-prefix
325                                               (upcase property)))))))
326     (when it (org-trim it))))
327
328 (defun org-bibtex-put (property value)
329   (let ((prop (upcase (if (keywordp property)
330                           (substring (symbol-name property) 1)
331                         property))))
332     (org-set-property
333      (concat (unless (string= org-bibtex-key-property prop) org-bibtex-prefix)
334          prop)
335      value)))
336
337 (defun org-bibtex-headline ()
338   "Return a bibtex entry of the given headline as a string."
339   (letrec ((val (lambda (key lst) (cdr (assoc key lst))))
340        (to (lambda (string) (intern (concat ":" string))))
341        (from (lambda (key) (substring (symbol-name key) 1)))
342        (flatten (lambda (&rest lsts)
343               (apply #'append (mapcar
344                        (lambda (e)
345                      (if (listp e) (apply flatten e) (list e)))
346                        lsts))))
347        (id (org-bibtex-get org-bibtex-key-property))
348        (type (org-bibtex-get org-bibtex-type-property-name))
349        (tags (when org-bibtex-tags-are-keywords
350            (delq nil
351              (mapcar
352               (lambda (tag)
353                 (unless (member tag
354                         (append org-bibtex-tags
355                             org-bibtex-no-export-tags))
356                   tag))
357               (if org-bibtex-inherit-tags
358                   (org-get-tags-at)
359                 (org-get-local-tags-at)))))))
360     (when type
361       (let ((entry (format
362             "@%s{%s,\n%s\n}\n" type id
363             (mapconcat
364              (lambda (pair)
365                (format "  %s={%s}" (car pair) (cdr pair)))
366              (remove nil
367                  (if (and org-bibtex-export-arbitrary-fields
368                       org-bibtex-prefix)
369                  (mapcar
370                   (lambda (kv)
371                     (let ((key (car kv)) (val0 (cdr kv)))
372                       (when (and
373                          (string-match org-bibtex-prefix key)
374                          (not (string=
375                            (downcase (concat org-bibtex-prefix
376                                      org-bibtex-type-property-name))
377                            (downcase key))))
378                     (cons (downcase (replace-regexp-in-string
379                              org-bibtex-prefix "" key))
380                           val0))))
381                   (org-entry-properties nil 'standard))
382                    (mapcar
383                 (lambda (field)
384                   (let ((value (or (org-bibtex-get (funcall from field))
385                            (and (eq :title field)
386                             (nth 4 (org-heading-components))))))
387                     (when value (cons (funcall from field) value))))
388                 (funcall flatten
389                      (funcall val :required (funcall val (funcall to type) org-bibtex-types))
390                      (funcall val :optional (funcall val (funcall to type) org-bibtex-types))))))
391              ",\n"))))
392     (with-temp-buffer
393       (insert entry)
394       (when tags
395         (bibtex-beginning-of-entry)
396         (if (re-search-forward "keywords.*=.*{\\(.*\\)}" nil t)
397         (progn (goto-char (match-end 1)) (insert ", "))
398           (search-forward ",\n" nil t)
399           (insert "  keywords={},\n")
400           (search-backward "}," nil t))
401         (insert (mapconcat #'identity tags ", ")))
402       (buffer-string))))))
403
404 (defun org-bibtex-ask (field)
405   (unless (assoc field org-bibtex-fields)
406     (error "Field:%s is not known" field))
407   (save-window-excursion
408     (let* ((name (substring (symbol-name field) 1))
409        (buf-name (format "*Bibtex Help %s*" name)))
410       (with-output-to-temp-buffer buf-name
411     (princ (cdr (assoc field org-bibtex-fields))))
412       (with-current-buffer buf-name (visual-line-mode 1))
413       (org-fit-window-to-buffer (get-buffer-window buf-name))
414       (let ((result (read-from-minibuffer (format "%s: " name))))
415         (when (> (length result) 0) result)))))
416
417 (defun org-bibtex-autokey ()
418   "Generate an autokey for the current headline."
419   (org-bibtex-put org-bibtex-key-property
420                   (if org-bibtex-autogen-keys
421                       (let* ((entry (org-bibtex-headline))
422                  (key
423                   (with-temp-buffer
424                 (insert entry)
425                 (bibtex-generate-autokey))))
426             ;; test for duplicate IDs if using global ID
427             (when (and
428                    (equal org-bibtex-key-property "ID")
429                    (featurep 'org-id)
430                    (hash-table-p org-id-locations)
431                    (gethash key org-id-locations))
432               (warn "Another entry has the same ID"))
433             key)
434                     (read-from-minibuffer "id: "))))
435
436 (defun org-bibtex-fleshout (type &optional optional)
437   "Fleshout current heading, ensuring all required fields are present.
438 With optional argument OPTIONAL, also prompt for optional fields."
439   (let ((val (lambda (key lst) (cdr (assoc key lst))))
440     (keyword (lambda (name) (intern (concat ":" (downcase name)))))
441     (name (lambda (keyword) (substring (symbol-name keyword) 1))))
442     (dolist (field (append
443             (if org-bibtex-treat-headline-as-title
444             (remove :title (funcall val :required (funcall val type org-bibtex-types)))
445               (funcall val :required (funcall val type org-bibtex-types)))
446             (when optional (funcall val :optional (funcall val type org-bibtex-types)))))
447       (when (consp field) ; or'd pair of fields e.g., (:editor :author)
448         (let ((present (nth 0 (remove
449                    nil
450                    (mapcar
451                 (lambda (f)
452                   (when (org-bibtex-get (funcall name f)) f))
453                 field)))))
454           (setf field (or present (funcall keyword
455                        (completing-read
456                         "Field: " (mapcar name field)))))))
457       (let ((name (funcall name field)))
458         (unless (org-bibtex-get name)
459           (let ((prop (org-bibtex-ask field)))
460             (when prop (org-bibtex-put name prop)))))))
461   (when (and type (assoc type org-bibtex-types)
462              (not (org-bibtex-get org-bibtex-key-property)))
463     (org-bibtex-autokey)))
464
465
466 ;;; Bibtex link functions
467 (org-link-set-parameters "bibtex"
468              :follow #'org-bibtex-open
469              :store #'org-bibtex-store-link)
470
471 (defun org-bibtex-open (path)
472   "Visit the bibliography entry on PATH."
473   (let* ((search (when (string-match "::\\(.+\\)\\'" path)
474            (match-string 1 path)))
475      (path (substring path 0 (match-beginning 0))))
476     (org-open-file path t nil search)))
477
478 (defun org-bibtex-store-link ()
479   "Store a link to a BibTeX entry."
480   (when (eq major-mode 'bibtex-mode)
481     (let* ((search (org-create-file-search-in-bibtex))
482        (link (concat "file:" (abbreviate-file-name buffer-file-name)
483              "::" search))
484        (entry (mapcar ; repair strings enclosed in "..." or {...}
485            (lambda(c)
486              (if (string-match
487               "^\\(?:{\\|\"\\)\\(.*\\)\\(?:}\\|\"\\)$" (cdr c))
488              (cons (car c) (match-string 1 (cdr c))) c))
489            (save-excursion
490              (bibtex-beginning-of-entry)
491              (bibtex-parse-entry)))))
492       (org-store-link-props
493        :key (cdr (assoc "=key=" entry))
494        :author (or (cdr (assoc "author" entry)) "[no author]")
495        :editor (or (cdr (assoc "editor" entry)) "[no editor]")
496        :title (or (cdr (assoc "title" entry)) "[no title]")
497        :booktitle (or (cdr (assoc "booktitle" entry)) "[no booktitle]")
498        :journal (or (cdr (assoc "journal" entry)) "[no journal]")
499        :publisher (or (cdr (assoc "publisher" entry)) "[no publisher]")
500        :pages (or (cdr (assoc "pages" entry)) "[no pages]")
501        :url (or (cdr (assoc "url" entry)) "[no url]")
502        :year (or (cdr (assoc "year" entry)) "[no year]")
503        :month (or (cdr (assoc "month" entry)) "[no month]")
504        :address (or (cdr (assoc "address" entry)) "[no address]")
505        :volume (or (cdr (assoc "volume" entry)) "[no volume]")
506        :number (or (cdr (assoc "number" entry)) "[no number]")
507        :annote (or (cdr (assoc "annote" entry)) "[no annotation]")
508        :series (or (cdr (assoc "series" entry)) "[no series]")
509        :abstract (or (cdr (assoc "abstract" entry)) "[no abstract]")
510        :btype (or (cdr (assoc "=type=" entry)) "[no type]")
511        :type "bibtex"
512        :link link
513        :description org-bibtex-description))))
514
515 (defun org-create-file-search-in-bibtex ()
516   "Create the search string and description for a BibTeX database entry."
517   ;; Make a good description for this entry, using names, year and the title
518   ;; Put it into the `description' variable which is dynamically scoped.
519   (let ((bibtex-autokey-names 1)
520     (bibtex-autokey-names-stretch 1)
521     (bibtex-autokey-name-case-convert-function 'identity)
522     (bibtex-autokey-name-separator " & ")
523     (bibtex-autokey-additional-names " et al.")
524     (bibtex-autokey-year-length 4)
525     (bibtex-autokey-name-year-separator " ")
526     (bibtex-autokey-titlewords 3)
527     (bibtex-autokey-titleword-separator " ")
528     (bibtex-autokey-titleword-case-convert-function 'identity)
529     (bibtex-autokey-titleword-length 'infty)
530     (bibtex-autokey-year-title-separator ": "))
531     (setq org-bibtex-description (bibtex-generate-autokey)))
532   ;; Now parse the entry, get the key and return it.
533   (save-excursion
534     (bibtex-beginning-of-entry)
535     (cdr (assoc "=key=" (bibtex-parse-entry)))))
536
537 (defun org-execute-file-search-in-bibtex (s)
538   "Find the link search string S as a key for a database entry."
539   (when (eq major-mode 'bibtex-mode)
540     ;; Yes, we want to do the search in this file.
541     ;; We construct a regexp that searches for "@entrytype{" followed by the key
542     (goto-char (point-min))
543     (and (re-search-forward (concat "@[a-zA-Z]+[ \t\n]*{[ \t\n]*"
544                     (regexp-quote s) "[ \t\n]*,") nil t)
545      (goto-char (match-beginning 0)))
546     (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
547     ;; Use double prefix to indicate that any web link should be browsed
548     (let ((b (current-buffer)) (p (point)))
549       ;; Restore the window configuration because we just use the web link
550       (set-window-configuration org-window-config-before-follow-link)
551       (with-current-buffer b
552         (goto-char p)
553         (bibtex-url)))
554       (recenter 0))  ; Move entry start to beginning of window
555     ;; return t to indicate that the search is done.
556     t))
557
558 ;; Finally add the link search function to the right hook.
559 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
560
561
562 ;;; Bibtex <-> Org headline translation functions
563 (defun org-bibtex (filename)
564   "Export each headline in the current file to a bibtex entry.
565 Headlines are exported using `org-bibtex-headline'."
566   (interactive
567    (list (read-file-name
568       "Bibtex file: " nil nil nil
569       (let ((file (buffer-file-name (buffer-base-buffer))))
570         (and file
571          (file-name-nondirectory
572           (concat (file-name-sans-extension file) ".bib")))))))
573   (let ((error-point
574          (catch 'bib
575            (let ((bibtex-entries
576                   (remove nil (org-map-entries
577                                (lambda ()
578                                  (condition-case nil
579                                      (org-bibtex-headline)
580                                    (error (throw 'bib (point)))))))))
581              (with-temp-file filename
582                (insert (mapconcat #'identity bibtex-entries "\n")))
583              (message "Successfully exported %d BibTeX entries to %s"
584                       (length bibtex-entries) filename) nil))))
585     (when error-point
586       (goto-char error-point)
587       (message "Bibtex error at %S" (nth 4 (org-heading-components))))))
588
589 (defun org-bibtex-check (&optional optional)
590   "Check the current headline for required fields.
591 With prefix argument OPTIONAL also prompt for optional fields."
592   (interactive "P")
593   (save-restriction
594     (org-narrow-to-subtree)
595     (let ((type (let ((name (org-bibtex-get org-bibtex-type-property-name)))
596                   (when name (intern (concat ":" name))))))
597       (when type (org-bibtex-fleshout type optional)))))
598
599 (defun org-bibtex-check-all (&optional optional)
600   "Check all headlines in the current file.
601 With prefix argument OPTIONAL also prompt for optional fields."
602   (interactive) (org-map-entries (lambda () (org-bibtex-check optional))))
603
604 (defun org-bibtex-create (&optional arg nonew)
605   "Create a new entry at the given level.
606 With a prefix arg, query for optional fields as well.
607 If nonew is t, add data to the headline of the entry at point."
608   (interactive "P")
609   (let* ((type (completing-read
610         "Type: " (mapcar (lambda (type)
611                    (substring (symbol-name (car type)) 1))
612                  org-bibtex-types)
613         nil nil (when nonew
614               (org-bibtex-get org-bibtex-type-property-name))))
615      (type (if (keywordp type) type (intern (concat ":" type))))
616      (org-bibtex-treat-headline-as-title (if nonew nil t)))
617     (unless (assoc type org-bibtex-types)
618       (error "Type:%s is not known" type))
619     (if nonew
620     (org-back-to-heading)
621       (org-insert-heading)
622       (let ((title (org-bibtex-ask :title)))
623     (insert title)
624     (org-bibtex-put "TITLE" title)))
625     (org-bibtex-put org-bibtex-type-property-name
626             (substring (symbol-name type) 1))
627     (org-bibtex-fleshout type arg)
628     (dolist (tag org-bibtex-tags) (org-toggle-tag tag 'on))))
629
630 (defun org-bibtex-create-in-current-entry (&optional arg)
631   "Add bibliographical data to the current entry.
632 With a prefix arg, query for optional fields."
633   (interactive "P")
634   (org-bibtex-create arg t))
635
636 (defun org-bibtex-read ()
637   "Read a bibtex entry and save to `org-bibtex-entries'.
638 This uses `bibtex-parse-entry'."
639   (interactive)
640   (let ((keyword (lambda (str) (intern (concat ":" (downcase str)))))
641     (clean-space (lambda (str) (replace-regexp-in-string
642                    "[[:space:]\n\r]+" " " str)))
643     (strip-delim
644      (lambda (str)             ; strip enclosing "..." and {...}
645        (dolist (pair '((34 . 34) (123 . 125)))
646          (when (and (> (length str) 1)
647             (= (aref str 0) (car pair))
648             (= (aref str (1- (length str))) (cdr pair)))
649            (setf str (substring str 1 (1- (length str)))))) str)))
650     (push (mapcar
651            (lambda (pair)
652              (cons (let ((field (funcall keyword (car pair))))
653                      (pcase field
654                        (:=type= :type)
655                        (:=key= :key)
656                        (_ field)))
657                    (funcall clean-space (funcall strip-delim (cdr pair)))))
658            (save-excursion (bibtex-beginning-of-entry) (bibtex-parse-entry)))
659           org-bibtex-entries)))
660
661 (defun org-bibtex-read-buffer (buffer)
662   "Read all bibtex entries in BUFFER and save to `org-bibtex-entries'.
663 Return the number of saved entries."
664   (interactive "bBuffer: ")
665   (let ((start-length (length org-bibtex-entries)))
666     (with-current-buffer buffer
667       (save-excursion
668     (goto-char (point-max))
669     (while (not (= (point) (point-min)))
670       (backward-char 1)
671       (org-bibtex-read)
672       (bibtex-beginning-of-entry))))
673     (let ((added (- (length org-bibtex-entries) start-length)))
674       (message "Parsed %d entries" added)
675       added)))
676
677 (defun org-bibtex-read-file (file)
678   "Read FILE with `org-bibtex-read-buffer'."
679   (interactive "fFile: ")
680   (org-bibtex-read-buffer (find-file-noselect file 'nowarn 'rawfile)))
681
682 (defun org-bibtex-write ()
683   "Insert a heading built from the first element of `org-bibtex-entries'."
684   (interactive)
685   (when (= (length org-bibtex-entries) 0)
686     (error "No entries in `org-bibtex-entries'"))
687   (let* ((entry (pop org-bibtex-entries))
688      (org-special-properties nil) ; avoids errors with `org-entry-put'
689      (val (lambda (field) (cdr (assoc field entry))))
690      (togtag (lambda (tag) (org-toggle-tag tag 'on))))
691     (org-insert-heading)
692     (insert (funcall org-bibtex-headline-format-function entry))
693     (org-bibtex-put "TITLE" (funcall val :title))
694     (org-bibtex-put org-bibtex-type-property-name
695             (downcase (funcall val :type)))
696     (dolist (pair entry)
697       (pcase (car pair)
698     (:title    nil)
699     (:type     nil)
700     (:key      (org-bibtex-put org-bibtex-key-property (cdr pair)))
701     (:keywords (if org-bibtex-tags-are-keywords
702                (dolist (kw (split-string (cdr pair) ", *"))
703              (funcall
704               togtag
705               (replace-regexp-in-string
706                "[^[:alnum:]_@#%]" ""
707                (replace-regexp-in-string "[ \t]+" "_" kw))))
708              (org-bibtex-put (car pair) (cdr pair))))
709     (_ (org-bibtex-put (car pair) (cdr pair)))))
710     (mapc togtag org-bibtex-tags)))
711
712 (defun org-bibtex-yank ()
713   "If kill ring holds a bibtex entry yank it as an Org headline."
714   (interactive)
715   (let (entry)
716     (with-temp-buffer (yank 1) (setf entry (org-bibtex-read)))
717     (if entry
718     (org-bibtex-write)
719       (error "Yanked text does not appear to contain a BibTeX entry"))))
720
721 (defun org-bibtex-import-from-file (file)
722   "Read bibtex entries from FILE and insert as Org headlines after point."
723   (interactive "fFile: ")
724   (dotimes (_ (org-bibtex-read-file file))
725     (save-excursion (org-bibtex-write))
726     (re-search-forward org-property-end-re)
727     (open-line 1) (forward-char 1)))
728
729 (defun org-bibtex-export-to-kill-ring ()
730   "Export current headline to kill ring as bibtex entry."
731   (interactive)
732   (let ((result (org-bibtex-headline)))
733     (kill-new result) result))
734
735 (defun org-bibtex-search (string)
736   "Search for bibliographical entries in agenda files.
737 This function relies `org-search-view' to locate results."
738   (interactive "sSearch string: ")
739   (let ((org-agenda-overriding-header "Bib search results:")
740         (org-agenda-search-view-always-boolean t))
741     (org-search-view nil
742              (format "%s +{:%s%s:}"
743                  string (or org-bibtex-prefix "")
744                  org-bibtex-type-property-name))))
745
746 (provide 'org-bibtex)
747
748 ;;; org-bibtex.el ends here