1 ;;; bibtex.el --- BibTeX mode for GNU Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1992, 1994-1999, 2001-2013 Free Software Foundation,
6 ;; Author: Stefan Schoef <schoef@offis.uni-oldenburg.de>
7 ;; Bengt Martensson <bengt@mathematik.uni-Bremen.de>
8 ;; Marc Shapiro <marc.shapiro@acm.org>
9 ;; Mike Newton <newton@gumby.cs.caltech.edu>
10 ;; Aaron Larson <alarson@src.honeywell.com>
11 ;; Dirk Herrmann <D.Herrmann@tu-bs.de>
12 ;; Maintainer: Roland Winkler <winkler@gnu.org>
13 ;; Keywords: BibTeX, LaTeX, TeX
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software: you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation, either version 3 of the License, or
20 ;; (at your option) any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 ;; Major mode for editing and validating BibTeX files.
35 ;; See documentation for `bibtex-mode' or type "M-x describe-mode"
36 ;; when you are in BibTeX mode.
39 ;; Distribute texinfo file.
53 (defgroup bibtex-autokey nil
54 "Generate automatically a key from the author/editor and the title field."
56 :prefix
"bibtex-autokey-")
58 (defcustom bibtex-mode-hook nil
59 "List of functions to call on entry to BibTeX mode."
63 (defcustom bibtex-field-delimiters
'braces
64 "Type of field delimiters. Allowed values are `braces' or `double-quotes'."
66 :type
'(choice (const braces
)
67 (const double-quotes
)))
69 (defcustom bibtex-entry-delimiters
'braces
70 "Type of entry delimiters. Allowed values are `braces' or `parentheses'."
72 :type
'(choice (const braces
)
75 (defcustom bibtex-include-OPTcrossref
'("InProceedings" "InCollection")
76 "List of BibTeX entries that get an OPTcrossref field."
78 :type
'(repeat string
))
80 (defcustom bibtex-include-OPTkey t
81 "If non-nil, all newly created entries get an OPTkey field.
82 If this is a string, use it as the initial field text.
83 If this is a function, call it to generate the initial field text."
85 :type
'(choice (const :tag
"None" nil
)
86 (string :tag
"Initial text")
87 (function :tag
"Initialize Function")
88 (const :tag
"Default" t
)))
89 (put 'bibtex-include-OPTkey
'risky-local-variable t
)
91 (defcustom bibtex-user-optional-fields
92 '(("annote" "Personal annotation (ignored)"))
93 "List of optional fields the user wants to have always present.
94 Entries should be of the same form as the OPTIONAL list
95 in `bibtex-BibTeX-entry-alist' (which see)."
97 :type
'(repeat (group (string :tag
"Field")
98 (string :tag
"Comment")
99 (option (choice :tag
"Init"
100 (const nil
) string function
)))))
101 (put 'bibtex-user-optional-fields
'risky-local-variable t
)
103 (defcustom bibtex-entry-format
104 '(opts-or-alts required-fields numerical-fields
)
105 "Type of formatting performed by `bibtex-clean-entry'.
106 It may be t, nil, or a list of symbols out of the following:
107 opts-or-alts Delete empty optional and alternative fields and
108 remove OPT and ALT prefixes from used fields.
109 required-fields Signal an error if a required field is missing.
110 numerical-fields Delete delimiters around numeral fields.
111 page-dashes Change double dashes in page field to single dash
112 (for scribe compatibility).
113 whitespace Delete whitespace at the beginning and end of fields.
114 inherit-booktitle If entry contains a crossref field and the booktitle
115 field is empty, set the booktitle field to the content
116 of the title field of the crossreferenced entry.
117 realign Realign entries, so that field texts and perhaps equal
118 signs (depending on the value of
119 `bibtex-align-at-equal-sign') begin in the same column.
121 last-comma Add or delete comma on end of last field in entry,
122 according to value of `bibtex-comma-after-last-field'.
123 delimiters Change delimiters according to variables
124 `bibtex-field-delimiters' and `bibtex-entry-delimiters'.
125 unify-case Change case of entry types and field names.
126 braces Enclose parts of field entries by braces according to
127 `bibtex-field-braces-alist'.
128 strings Replace parts of field entries by string constants
129 according to `bibtex-field-strings-alist'.
130 sort-fields Sort fields to match the field order in
131 `bibtex-BibTeX-entry-alist'.
133 The value t means do all of the above formatting actions.
134 The value nil means do no formatting at all."
136 :type
'(choice (const :tag
"None" nil
)
138 (set :menu-tag
"Some"
140 (const required-fields
)
141 (const numerical-fields
)
144 (const inherit-booktitle
)
151 (const sort-fields
))))
152 (put 'bibtex-entry-format
'safe-local-variable
157 (unless (memq (pop x
)
158 '(opts-or-alts required-fields numerical-fields
159 page-dashes whitespace inherit-booktitle realign
160 last-comma delimiters unify-case braces strings
163 (unless (null x
) (setq OK nil
))
166 (defcustom bibtex-field-braces-alist nil
167 "Alist of field regexps that \\[bibtex-clean-entry] encloses by braces.
168 Each element has the form (FIELDS REGEXP), where FIELDS is a list
169 of BibTeX field names and REGEXP is a regexp.
170 Space characters in REGEXP will be replaced by \"[ \\t\\n]+\"."
172 :type
'(repeat (list (repeat (string :tag
"field name"))
173 (choice (regexp :tag
"regexp")
174 (sexp :tag
"sexp")))))
176 (defcustom bibtex-field-strings-alist nil
177 "Alist of regexps that \\[bibtex-clean-entry] replaces by string constants.
178 Each element has the form (FIELDS REGEXP TO-STR), where FIELDS is a list
179 of BibTeX field names. In FIELDS search for REGEXP, which are replaced
180 by the BibTeX string constant TO-STR.
181 Space characters in REGEXP will be replaced by \"[ \\t\\n]+\"."
183 :type
'(repeat (list (repeat (string :tag
"field name"))
184 (regexp :tag
"From regexp")
185 (regexp :tag
"To string constant"))))
187 (defcustom bibtex-clean-entry-hook nil
188 "List of functions to call when entry has been cleaned.
189 Functions are called with point inside the cleaned entry, and the buffer
190 narrowed to just the entry."
194 (defcustom bibtex-maintain-sorted-entries nil
195 "If non-nil, BibTeX mode maintains all entries in sorted order.
196 Allowed non-nil values are:
197 plain or t All entries are sorted alphabetically.
198 crossref All entries are sorted alphabetically unless an entry has a
199 crossref field. These crossrefed entries are placed in
200 alphabetical order immediately preceding the main entry.
201 entry-class The entries are divided into classes according to their
202 entry type, see `bibtex-sort-entry-class'. Within each class
203 the entries are sorted alphabetically.
204 See also `bibtex-sort-ignore-string-entries'."
206 :type
'(choice (const nil
)
211 (put 'bibtex-maintain-sorted-entries
'safe-local-variable
212 (lambda (a) (memq a
'(nil t plain crossref entry-class
))))
214 (defcustom bibtex-sort-entry-class
217 ("Book" "Proceedings"))
218 "List of classes of BibTeX entry types, used for sorting entries.
219 If value of `bibtex-maintain-sorted-entries' is `entry-class'
220 entries are ordered according to the classes they belong to. Each
221 class contains a list of entry types. An entry `catch-all' applies
222 to all entries not explicitly mentioned."
224 :type
'(repeat (choice :tag
"Class"
225 (const :tag
"catch-all" (catch-all))
226 (repeat :tag
"Entry type" string
))))
227 (put 'bibtex-sort-entry-class
'safe-local-variable
228 (lambda (x) (let ((OK t
))
233 (unless (or (stringp z
) (eq z
'catch-all
))
235 (unless (null y
) (setq OK nil
))))
236 (unless (null x
) (setq OK nil
))
239 (defcustom bibtex-sort-ignore-string-entries t
240 "If non-nil, BibTeX @String entries are not sort-significant.
241 That means they are ignored when determining ordering of the buffer
242 \(e.g., sorting, locating alphabetical position for new entries, etc.)."
246 (defcustom bibtex-field-kill-ring-max
20
247 "Max length of `bibtex-field-kill-ring' before discarding oldest elements."
251 (defcustom bibtex-entry-kill-ring-max
20
252 "Max length of `bibtex-entry-kill-ring' before discarding oldest elements."
256 (defcustom bibtex-parse-keys-timeout
60
257 "Time interval in seconds for parsing BibTeX buffers during idle time.
258 Parsing initializes `bibtex-reference-keys' and `bibtex-strings'."
262 (defcustom bibtex-parse-keys-fast t
263 "If non-nil, use fast but simplified algorithm for parsing BibTeX keys.
264 If parsing fails, try to set this variable to nil."
268 (define-widget 'bibtex-entry-alist
'lazy
269 "Format of `bibtex-BibTeX-entry-alist' and friends."
270 :type
'(repeat (group (string :tag
"Entry type")
271 (string :tag
"Documentation")
272 (repeat :tag
"Required fields"
273 (group (string :tag
"Field")
274 (option (choice :tag
"Comment" :value nil
276 (option (choice :tag
"Init" :value nil
277 (const nil
) string function
))
278 (option (choice :tag
"Alternative" :value nil
279 (const nil
) integer
))))
280 (repeat :tag
"Crossref fields"
281 (group (string :tag
"Field")
282 (option (choice :tag
"Comment" :value nil
284 (option (choice :tag
"Init" :value nil
285 (const nil
) string function
))
286 (option (choice :tag
"Alternative" :value nil
287 (const nil
) integer
))))
288 (repeat :tag
"Optional fields"
289 (group (string :tag
"Field")
290 (option (choice :tag
"Comment" :value nil
292 (option (choice :tag
"Init" :value nil
293 (const nil
) string function
)))))))
295 (define-obsolete-variable-alias 'bibtex-entry-field-alist
296 'bibtex-BibTeX-entry-alist
"24.1")
297 (defcustom bibtex-BibTeX-entry-alist
298 '(("Article" "Article in Journal"
300 ("title" "Title of the article (BibTeX converts it to lowercase)"))
301 (("journal") ("year"))
302 (("volume" "Volume of the journal")
303 ("number" "Number of the journal (only allowed if entry contains volume)")
304 ("pages" "Pages in the journal")
306 ("InProceedings" "Article in Conference Proceedings"
308 ("title" "Title of the article in proceedings (BibTeX converts it to lowercase)"))
309 (("booktitle" "Name of the conference proceedings")
312 ("volume" "Volume of the conference proceedings in the series")
313 ("number" "Number of the conference proceedings in a small series (overwritten by volume)")
314 ("series" "Series in which the conference proceedings appeared")
315 ("pages" "Pages in the conference proceedings")
316 ("month") ("address")
317 ("organization" "Sponsoring organization of the conference")
318 ("publisher" "Publishing company, its location")
320 ("InCollection" "Article in a Collection"
322 ("title" "Title of the article in book (BibTeX converts it to lowercase)")
323 ("booktitle" "Name of the book"))
324 (("publisher") ("year"))
326 ("volume" "Volume of the book in the series")
327 ("number" "Number of the book in a small series (overwritten by volume)")
328 ("series" "Series in which the book appeared")
329 ("type" "Word to use instead of \"chapter\"")
330 ("chapter" "Chapter in the book")
331 ("pages" "Pages in the book")
332 ("edition" "Edition of the book as a capitalized English word")
333 ("month") ("address") ("note")))
334 ("InBook" "Chapter or Pages in a Book"
335 (("author" nil nil
0)
337 ("title" "Title of the book")
338 ("chapter" "Chapter in the book"))
339 (("publisher") ("year"))
340 (("volume" "Volume of the book in the series")
341 ("number" "Number of the book in a small series (overwritten by volume)")
342 ("series" "Series in which the book appeared")
343 ("type" "Word to use instead of \"chapter\"")
345 ("edition" "Edition of the book as a capitalized English word")
347 ("pages" "Pages in the book")
349 ("Proceedings" "Conference Proceedings"
350 (("title" "Title of the conference proceedings")
353 (("booktitle" "Title of the proceedings for cross references")
355 ("volume" "Volume of the conference proceedings in the series")
356 ("number" "Number of the conference proceedings in a small series (overwritten by volume)")
357 ("series" "Series in which the conference proceedings appeared")
360 ("organization" "Sponsoring organization of the conference")
361 ("publisher" "Publishing company, its location")
364 (("author" nil nil
0)
366 ("title" "Title of the book"))
367 (("publisher") ("year"))
368 (("volume" "Volume of the book in the series")
369 ("number" "Number of the book in a small series (overwritten by volume)")
370 ("series" "Series in which the book appeared")
372 ("edition" "Edition of the book as a capitalized English word")
374 ("Booklet" "Booklet (Bound, but no Publisher)"
375 (("title" "Title of the booklet (BibTeX converts it to lowercase)"))
378 ("howpublished" "The way in which the booklet was published")
379 ("address") ("month") ("year") ("note")))
380 ("PhdThesis" "PhD. Thesis"
382 ("title" "Title of the PhD. thesis")
383 ("school" "School where the PhD. thesis was written")
386 (("type" "Type of the PhD. thesis")
387 ("address" "Address of the school (if not part of field \"school\") or country")
389 ("MastersThesis" "Master's Thesis"
391 ("title" "Title of the master's thesis (BibTeX converts it to lowercase)")
392 ("school" "School where the master's thesis was written")
395 (("type" "Type of the master's thesis (if other than \"Master's thesis\")")
396 ("address" "Address of the school (if not part of field \"school\") or country")
398 ("TechReport" "Technical Report"
400 ("title" "Title of the technical report (BibTeX converts it to lowercase)")
401 ("institution" "Sponsoring institution of the report")
404 (("type" "Type of the report (if other than \"technical report\")")
405 ("number" "Number of the technical report")
406 ("address") ("month") ("note")))
407 ("Manual" "Technical Manual"
408 (("title" "Title of the manual"))
411 ("organization" "Publishing organization of the manual")
413 ("edition" "Edition of the manual as a capitalized English word")
414 ("month") ("year") ("note")))
415 ("Unpublished" "Unpublished"
417 ("title" "Title of the unpublished work (BibTeX converts it to lowercase)")
420 (("month") ("year")))
421 ("Misc" "Miscellaneous" nil nil
423 ("title" "Title of the work (BibTeX converts it to lowercase)")
424 ("howpublished" "The way in which the work was published")
425 ("month") ("year") ("note"))))
426 "Alist of BibTeX entry types and their associated fields.
427 Elements are lists (ENTRY-TYPE DOC REQUIRED CROSSREF OPTIONAL).
428 ENTRY-TYPE is the type of a BibTeX entry.
429 DOC is a brief doc string used for menus. If nil ENTRY-TYPE is used.
430 REQUIRED is a list of required fields.
431 CROSSREF is a list of fields that are optional if a crossref field
432 is present; but these fields are required otherwise.
433 OPTIONAL is a list of optional fields.
435 Each element of these lists is a list of the form
436 \(FIELD COMMENT INIT ALTERNATIVE).
437 COMMENT, INIT, and ALTERNATIVE are optional.
439 FIELD is the name of the field.
440 COMMENT is the comment string that appears in the echo area.
441 If COMMENT is nil use `bibtex-BibTeX-field-alist' if possible.
442 INIT is either the initial content of the field or a function,
443 which is called to determine the initial content of the field.
444 ALTERNATIVE if non-nil is an integer that numbers sets of
445 alternatives, starting from zero."
448 :type
'bibtex-entry-alist
)
449 (put 'bibtex-BibTeX-entry-alist
'risky-local-variable t
)
451 (defcustom bibtex-biblatex-entry-alist
452 ;; Compare in biblatex documentation:
453 ;; Sec. 2.1.1 Regular types (required and optional fields)
454 ;; Appendix A Default Crossref setup
455 '(("Article" "Article in Journal"
456 (("author") ("title") ("journaltitle")
457 ("year" nil nil
0) ("date" nil nil
0))
459 (("translator") ("annotator") ("commentator") ("subtitle") ("titleaddon")
460 ("editor") ("editora") ("editorb") ("editorc")
461 ("journalsubtitle") ("issuetitle") ("issuesubtitle")
462 ("language") ("origlanguage") ("series") ("volume") ("number") ("eid")
463 ("issue") ("month") ("pages") ("version") ("note") ("issn")
464 ("addendum") ("pubstate") ("doi") ("eprint") ("eprintclass")
465 ("eprinttype") ("url") ("urldate")))
466 ("Book" "Single-Volume Book"
467 (("author") ("title") ("year" nil nil
0) ("date" nil nil
0))
469 (("editor") ("editora") ("editorb") ("editorc")
470 ("translator") ("annotator") ("commentator")
471 ("introduction") ("foreword") ("afterword") ("titleaddon")
472 ("maintitle") ("mainsubtitle") ("maintitleaddon")
473 ("language") ("origlanguage") ("volume") ("part") ("edition") ("volumes")
474 ("series") ("number") ("note") ("publisher") ("location") ("isbn")
475 ("chapter") ("pages") ("pagetotal") ("addendum") ("pubstate") ("doi")
476 ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
477 ("MVBook" "Multi-Volume Book"
478 (("author") ("title") ("year" nil nil
0) ("date" nil nil
0))
480 (("editor") ("editora") ("editorb") ("editorc")
481 ("translator") ("annotator") ("commentator")
482 ("introduction") ("foreword") ("afterword") ("subtitle")
483 ("titleaddon") ("language") ("origlanguage") ("edition") ("volumes")
484 ("series") ("number") ("note") ("publisher")
485 ("location") ("isbn") ("pagetotal") ("addendum") ("pubstate") ("doi")
486 ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
487 ("InBook" "Chapter or Pages in a Book"
488 (("title") ("year" nil nil
0) ("date" nil nil
0))
489 (("author") ("booktitle"))
490 (("bookauthor") ("editor") ("editora") ("editorb") ("editorc")
491 ("translator") ("annotator") ("commentator") ("introduction") ("foreword")
492 ("afterword") ("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
493 ("maintitleaddon") ("booksubtitle") ("booktitleaddon")
494 ("language") ("origlanguage") ("volume") ("part") ("edition") ("volumes")
495 ("series") ("number") ("note") ("publisher") ("location") ("isbn")
496 ("chapter") ("pages") ("addendum") ("pubstate")
497 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
498 ("BookInBook" "Book in Collection" ; same as @inbook
499 (("title") ("year" nil nil
0) ("date" nil nil
0))
500 (("author") ("booktitle"))
501 (("bookauthor") ("editor") ("editora") ("editorb") ("editorc")
502 ("translator") ("annotator") ("commentator") ("introduction") ("foreword")
503 ("afterword") ("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
504 ("maintitleaddon") ("booksubtitle") ("booktitleaddon")
505 ("language") ("origlanguage") ("volume") ("part") ("edition") ("volumes")
506 ("series") ("number") ("note") ("publisher") ("location") ("isbn")
507 ("chapter") ("pages") ("addendum") ("pubstate")
508 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
509 ("SuppBook" "Supplemental Material in a Book" ; same as @inbook
510 (("title") ("year" nil nil
0) ("date" nil nil
0))
511 (("author") ("booktitle"))
512 (("bookauthor") ("editor") ("editora") ("editorb") ("editorc")
513 ("translator") ("annotator") ("commentator") ("introduction") ("foreword")
514 ("afterword") ("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
515 ("maintitleaddon") ("booksubtitle") ("booktitleaddon")
516 ("language") ("origlanguage") ("volume") ("part") ("edition") ("volumes")
517 ("series") ("number") ("note") ("publisher") ("location") ("isbn")
518 ("chapter") ("pages") ("addendum") ("pubstate")
519 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
520 ("Booklet" "Booklet (Bound, but no Publisher)"
521 (("author" nil nil
0) ("editor" nil nil
0) ("title")
522 ("year" nil nil
1) ("date" nil nil
1))
524 (("subtitle") ("titleaddon") ("language") ("howpublished") ("type")
525 ("note") ("location") ("chapter") ("pages") ("pagetotal") ("addendum")
526 ("pubstate") ("doi") ("eprint") ("eprintclass") ("eprinttype")
527 ("url") ("urldate")))
528 ("Collection" "Single-Volume Collection"
529 (("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
531 (("editora") ("editorb") ("editorc") ("translator") ("annotator")
532 ("commentator") ("introduction") ("foreword") ("afterword")
533 ("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
534 ("maintitleaddon") ("language") ("origlanguage") ("volume")
535 ("part") ("edition") ("volumes") ("series") ("number") ("note")
536 ("publisher") ("location") ("isbn") ("chapter") ("pages") ("pagetotal")
537 ("addendum") ("pubstate") ("doi") ("eprint") ("eprintclass")
538 ("eprinttype") ("url") ("urldate")))
539 ("MVCollection" "Multi-Volume Collection"
540 (("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
542 (("editora") ("editorb") ("editorc") ("translator") ("annotator")
543 ("commentator") ("introduction") ("foreword") ("afterword")
544 ("subtitle") ("titleaddon") ("language") ("origlanguage") ("edition")
545 ("volumes") ("series") ("number") ("note") ("publisher")
546 ("location") ("isbn") ("pagetotal") ("addendum") ("pubstate") ("doi")
547 ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
548 ("InCollection" "Article in a Collection"
549 (("author") ("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
551 (("editora") ("editorb") ("editorc") ("translator") ("annotator")
552 ("commentator") ("introduction") ("foreword") ("afterword")
553 ("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
554 ("maintitleaddon") ("booksubtitle") ("booktitleaddon")
555 ("language") ("origlanguage") ("volume") ("part") ("edition")
556 ("volumes") ("series") ("number") ("note") ("publisher") ("location")
557 ("isbn") ("chapter") ("pages") ("addendum") ("pubstate") ("doi")
558 ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
559 ("SuppCollection" "Supplemental Material in a Collection" ; same as @incollection
560 (("author") ("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
562 (("editora") ("editorb") ("editorc") ("translator") ("annotator")
563 ("commentator") ("introduction") ("foreword") ("afterword")
564 ("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
565 ("maintitleaddon") ("booksubtitle") ("booktitleaddon")
566 ("language") ("origlanguage") ("volume") ("part") ("edition")
567 ("volumes") ("series") ("number") ("note") ("publisher") ("location")
568 ("isbn") ("chapter") ("pages") ("addendum") ("pubstate") ("doi")
569 ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
570 ("Manual" "Technical Manual"
571 (("author" nil nil
0) ("editor" nil nil
0) ("title")
572 ("year" nil nil
1) ("date" nil nil
1))
574 (("subtitle") ("titleaddon") ("language") ("edition")
575 ("type") ("series") ("number") ("version") ("note")
576 ("organization") ("publisher") ("location") ("isbn") ("chapter")
577 ("pages") ("pagetotal") ("addendum") ("pubstate")
578 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
579 ("Misc" "Miscellaneous"
580 (("author" nil nil
0) ("editor" nil nil
0) ("title")
581 ("year" nil nil
1) ("date" nil nil
1))
583 (("subtitle") ("titleaddon") ("language") ("howpublished") ("type")
584 ("version") ("note") ("organization") ("location")
585 ("date") ("month") ("year") ("addendum") ("pubstate")
586 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
587 ("Online" "Online Resource"
588 (("author" nil nil
0) ("editor" nil nil
0) ("title")
589 ("year" nil nil
1) ("date" nil nil
1) ("url"))
591 (("subtitle") ("titleaddon") ("language") ("version") ("note")
592 ("organization") ("date") ("month") ("year") ("addendum")
593 ("pubstate") ("urldate")))
595 (("author") ("title") ("number") ("year" nil nil
0) ("date" nil nil
0))
597 (("holder") ("subtitle") ("titleaddon") ("type") ("version") ("location")
598 ("note") ("date") ("month") ("year") ("addendum") ("pubstate")
599 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
600 ("Periodical" "Complete Issue of a Periodical"
601 (("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
603 (("editora") ("editorb") ("editorc") ("subtitle") ("issuetitle")
604 ("issuesubtitle") ("language") ("series") ("volume") ("number") ("issue")
605 ("date") ("month") ("year") ("note") ("issn") ("addendum") ("pubstate")
606 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
607 ("SuppPeriodical" "Supplemental Material in a Periodical" ; same as @article
608 (("author") ("title") ("journaltitle")
609 ("year" nil nil
0) ("date" nil nil
0))
611 (("translator") ("annotator") ("commentator") ("subtitle") ("titleaddon")
612 ("editor") ("editora") ("editorb") ("editorc")
613 ("journalsubtitle") ("issuetitle") ("issuesubtitle")
614 ("language") ("origlanguage") ("series") ("volume") ("number") ("eid")
615 ("issue") ("month") ("pages") ("version") ("note") ("issn")
616 ("addendum") ("pubstate") ("doi") ("eprint") ("eprintclass")
617 ("eprinttype") ("url") ("urldate")))
618 ("Proceedings" "Single-Volume Conference Proceedings"
619 (("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
621 (("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
622 ("maintitleaddon") ("eventtitle") ("eventdate") ("venue") ("language")
623 ("volume") ("part") ("volumes") ("series") ("number") ("note")
624 ("organization") ("publisher") ("location") ("month")
625 ("isbn") ("chapter") ("pages") ("pagetotal") ("addendum") ("pubstate")
626 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
627 ("MVProceedings" "Multi-Volume Conference Proceedings"
628 (("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
630 (("subtitle") ("titleaddon") ("eventtitle") ("eventdate") ("venue")
631 ("language") ("volumes") ("series") ("number") ("note")
632 ("organization") ("publisher") ("location") ("month")
633 ("isbn") ("pagetotal") ("addendum") ("pubstate")
634 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
635 ("InProceedings" "Article in Conference Proceedings"
636 (("author") ("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
638 (("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
639 ("maintitleaddon") ("booksubtitle") ("booktitleaddon")
640 ("eventtitle") ("eventdate") ("venue") ("language")
641 ("volume") ("part") ("volumes") ("series") ("number") ("note")
642 ("organization") ("publisher") ("location") ("month") ("isbn")
643 ("chapter") ("pages") ("addendum") ("pubstate")
644 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
645 ("Reference" "Single-Volume Work of Reference" ; same as @collection
646 (("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
648 (("editora") ("editorb") ("editorc") ("translator") ("annotator")
649 ("commentator") ("introduction") ("foreword") ("afterword")
650 ("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
651 ("maintitleaddon") ("language") ("origlanguage") ("volume")
652 ("part") ("edition") ("volumes") ("series") ("number") ("note")
653 ("publisher") ("location") ("isbn") ("chapter") ("pages") ("pagetotal")
654 ("addendum") ("pubstate") ("doi") ("eprint") ("eprintclass")
655 ("eprinttype") ("url") ("urldate")))
656 ("MVReference" "Multi-Volume Work of Reference" ; same as @mvcollection
657 (("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
659 (("editora") ("editorb") ("editorc") ("translator") ("annotator")
660 ("commentator") ("introduction") ("foreword") ("afterword")
661 ("subtitle") ("titleaddon") ("language") ("origlanguage") ("edition")
662 ("volumes") ("series") ("number") ("note") ("publisher")
663 ("location") ("isbn") ("pagetotal") ("addendum") ("pubstate") ("doi")
664 ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
665 ("InReference" "Article in a Work of Reference" ; same as @incollection
666 (("author") ("editor") ("title") ("year" nil nil
0) ("date" nil nil
0))
668 (("editora") ("editorb") ("editorc") ("translator") ("annotator")
669 ("commentator") ("introduction") ("foreword") ("afterword")
670 ("subtitle") ("titleaddon") ("maintitle") ("mainsubtitle")
671 ("maintitleaddon") ("booksubtitle") ("booktitleaddon")
672 ("language") ("origlanguage") ("volume") ("part") ("edition")
673 ("volumes") ("series") ("number") ("note") ("publisher") ("location")
674 ("isbn") ("chapter") ("pages") ("addendum") ("pubstate") ("doi")
675 ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
676 ("Report" "Technical or Research Report"
677 (("author") ("title") ("type") ("institution")
678 ("year" nil nil
0) ("date" nil nil
0))
680 (("subtitle") ("titleaddon") ("language") ("number") ("version") ("note")
681 ("location") ("month") ("isrn") ("chapter") ("pages") ("pagetotal")
682 ("addendum") ("pubstate")
683 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
684 ("Thesis" "PhD. or Master's Thesis"
685 (("author") ("title") ("type") ("institution")
686 ("year" nil nil
0) ("date" nil nil
0))
688 (("subtitle") ("titleaddon") ("language") ("note") ("location")
689 ("month") ("isbn") ("chapter") ("pages") ("pagetotal")
690 ("addendum") ("pubstate")
691 ("doi") ("eprint") ("eprintclass") ("eprinttype") ("url") ("urldate")))
692 ("Unpublished" "Unpublished"
693 (("author") ("title") ("year" nil nil
0) ("date" nil nil
0))
695 (("subtitle") ("titleaddon") ("language") ("howpublished")
696 ("note") ("location") ("isbn") ("date") ("month") ("year")
697 ("addendum") ("pubstate") ("url") ("urldate"))))
698 "Alist of biblatex entry types and their associated fields.
699 It has the same format as `bibtex-BibTeX-entry-alist'."
702 :type
'bibtex-entry-alist
)
703 (put 'bibtex-biblatex-entry-alist
'risky-local-variable t
)
705 (define-widget 'bibtex-field-alist
'lazy
706 "Format of `bibtex-BibTeX-entry-alist' and friends."
707 :type
'(repeat (group (string :tag
"Field type")
708 (string :tag
"Comment"))))
710 (defcustom bibtex-BibTeX-field-alist
711 '(("author" "Author1 [and Author2 ...] [and others]")
712 ("editor" "Editor1 [and Editor2 ...] [and others]")
713 ("journal" "Name of the journal (use string, remove braces)")
714 ("year" "Year of publication")
715 ("month" "Month of the publication as a string (remove braces)")
716 ("note" "Remarks to be put at the end of the \\bibitem")
717 ("publisher" "Publishing company")
718 ("address" "Address of the publisher"))
719 "Alist of BibTeX fields.
720 Each element is a list (FIELD COMMENT). COMMENT is used as a default
721 if `bibtex-BibTeX-entry-alist' does not define a comment for FIELD."
724 :type
'bibtex-field-alist
)
726 (defcustom bibtex-biblatex-field-alist
727 ;; See 2.2.2 Data Fields
728 '(("abstract" "Abstract of the work")
729 ("addendum" "Miscellaneous bibliographic data")
730 ("afterword" "Author(s) of an afterword to the work")
731 ("annotation" "Annotation")
732 ("annotator" "Author(s) of annotations to the work")
733 ("author" "Author(s) of the title")
734 ("bookauthor" "Author(s) of the booktitle.")
735 ("bookpagination" "Pagination scheme of the enclosing work")
736 ("booksubtitle" "Subtitle related to the booktitle")
737 ("booktitle" "Title of the book")
738 ("booktitleaddon" "Annex to the booktitle")
739 ("chapter" "Chapter, section, or any other unit of a work")
740 ("commentator" "Author(s) of a commentary to the work")
741 ("date" "Publication date")
742 ("doi" "Digital Object Identifier")
743 ("edition" "Edition of a printed publication")
744 ("editor" "Editor(s) of the title, booktitle, or maintitle")
745 ("editora" "Secondary editor")
746 ("editorb" "Secondary editor")
747 ("editorc" "Secondary editor")
748 ("editortype" "Type of editorial role performed by the editor")
749 ("editoratype" "Type of editorial role performed by editora")
750 ("editorbtype" "Type of editorial role performed by editorb")
751 ("editorctype" "Type of editorial role performed by editorc")
752 ("eid" "Electronic identifier of an article")
753 ("eprint" "Electronic identifier of an online publication")
754 ("eprintclass" "Additional information related to the eprinttype")
755 ("eprinttype" "Type of eprint identifier")
756 ("eventdate" "Date of a conference or some other event")
757 ("eventtitle" "Title of a conference or some other event")
758 ("file" "Local link to an electronic version of the work")
759 ("foreword" "Author(s) of a foreword to the work")
760 ("holder" "Holder(s) of a patent")
761 ("howpublished" "Publication notice for unusual publications")
762 ("indextitle" "Title to use for indexing instead of the regular title")
763 ("institution" "Name of a university or some other institution")
764 ("introduction" "Author(s) of an introduction to the work")
765 ("isan" "International Standard Audiovisual Number of an audiovisual work")
766 ("isbn" "International Standard Book Number of a book.")
767 ("ismn" "International Standard Music Number for printed music")
768 ("isrn" "International Standard Technical Report Number")
769 ("issn" "International Standard Serial Number of a periodical.")
770 ("issue" "Issue of a journal")
771 ("issuesubtitle" "Subtitle of a specific issue of a journal or other periodical.")
772 ("issuetitle" "Title of a specific issue of a journal or other periodical.")
773 ("iswc" "International Standard Work Code of a musical work")
774 ("journalsubtitle" "Subtitle of a journal, a newspaper, or some other periodical.")
775 ("journaltitle" "Name of a journal, a newspaper, or some other periodical.")
776 ("label" "Substitute for the regular label to be used by the citation style")
777 ("language" "Language(s) of the work")
778 ("library" "Library name and a call number")
779 ("location" "Place(s) of publication")
780 ("mainsubtitle" "Subtitle related to the maintitle")
781 ("maintitle" "Main title of a multi-volume book, such as Collected Works")
782 ("maintitleaddon" "Annex to the maintitle")
783 ("month" "Publication month")
784 ("nameaddon" "Addon to be printed immediately after the author name")
785 ("note" "Miscellaneous bibliographic data")
786 ("number" "Number of a journal or the volume/number of a book in a series")
787 ("organization" "Organization(s) that published a work")
788 ("origdate" "Publication date of the original edition")
789 ("origlanguage" "Original publication language of a translated edition")
790 ("origlocation" "Location of the original edition")
791 ("origpublisher" "Publisher of the original edition")
792 ("origtitle" "Title of the original work")
793 ("pages" "Page number(s) or page range(s)")
794 ("pagetotal" "Total number of pages of the work.")
795 ("pagination" "Pagination of the work")
796 ("part" "Number of a partial volume")
797 ("publisher" "Name(s) of the publisher(s)")
798 ("pubstate" "Publication state of the work, e. g.,'in press'")
799 ("reprinttitle" "Title of a reprint of the work")
800 ("series" "Name of a publication series")
801 ("shortauthor" "Author(s) of the work, given in an abbreviated form")
802 ("shorteditor" "Editor(s) of the work, given in an abbreviated form")
803 ("shortjournal" "Short version or an acronym of the journal title")
804 ("shortseries" "Short version or an acronym of the series field")
805 ("shorttitle" "Title in an abridged form")
806 ("subtitle" "Subtitle of the work")
807 ("title" "Title of the work")
808 ("titleaddon" "Annex to the title")
809 ("translator" "Translator(s) of the work")
810 ("type" "Type of a manual, patent, report, or thesis")
811 ("url" " URL of an online publication.")
812 ("urldate" "Access date of the address specified in the url field")
813 ("venue" "Location of a conference, a symposium, or some other event")
814 ("version" "Revision number of a piece of software, a manual, etc.")
815 ("volume" "Volume of a multi-volume book or a periodical")
816 ("volumes" "Total number of volumes of a multi-volume work")
817 ("year" "Year of publication"))
818 "Alist of biblatex fields.
819 It has the same format as `bibtex-BibTeX-entry-alist'."
822 :type
'bibtex-field-alist
)
824 (defcustom bibtex-dialect-list
'(BibTeX biblatex
)
825 "List of BibTeX dialects known to BibTeX mode.
826 For each DIALECT (a symbol) a variable bibtex-DIALECT-entry-alist defines
827 the allowed entries and bibtex-DIALECT-field-alist defines known field types.
828 Predefined dialects include BibTeX and biblatex."
831 :type
'(repeat (symbol :tag
"Dialect")))
833 (defcustom bibtex-dialect
'BibTeX
834 "Current BibTeX dialect. For allowed values see `bibtex-dialect-list'.
835 To interactively change the dialect use the command `bibtex-set-dialect'."
838 :set
'(lambda (symbol value
)
839 (set-default symbol value
)
840 ;; `bibtex-set-dialect' is undefined during loading (no problem)
841 (if (fboundp 'bibtex-set-dialect
)
842 (bibtex-set-dialect value
)))
843 :type
'(choice (const BibTeX
)
845 (symbol :tag
"Custom")))
846 (put 'bibtex-dialect
'safe-local-variable
'symbolp
)
848 (defcustom bibtex-no-opt-remove-re
"\\`option"
849 "If a field name matches this regexp, the prefix OPT is not removed.
850 If nil prefix OPT is always removed"
853 :type
'(choice (regexp) (const nil
)))
855 (defcustom bibtex-comment-start
"@Comment"
856 "String starting a BibTeX comment."
860 (defcustom bibtex-add-entry-hook nil
861 "List of functions to call when BibTeX entry has been inserted."
865 (defcustom bibtex-predefined-month-strings
866 '(("jan" .
"January")
874 ("sep" .
"September")
877 ("dec" .
"December"))
878 "Alist of month string definitions used in the BibTeX style files.
879 Each element is a pair of strings (ABBREVIATION . EXPANSION)."
881 :type
'(repeat (cons (string :tag
"Month abbreviation")
882 (string :tag
"Month expansion"))))
884 (defcustom bibtex-predefined-strings
886 bibtex-predefined-month-strings
887 '(("acmcs" .
"ACM Computing Surveys")
888 ("acta" .
"Acta Informatica")
889 ("cacm" .
"Communications of the ACM")
890 ("ibmjrd" .
"IBM Journal of Research and Development")
891 ("ibmsj" .
"IBM Systems Journal")
892 ("ieeese" .
"IEEE Transactions on Software Engineering")
893 ("ieeetc" .
"IEEE Transactions on Computers")
894 ("ieeetcad" .
"IEEE Transactions on Computer-Aided Design of Integrated Circuits")
895 ("ipl" .
"Information Processing Letters")
896 ("jacm" .
"Journal of the ACM")
897 ("jcss" .
"Journal of Computer and System Sciences")
898 ("scp" .
"Science of Computer Programming")
899 ("sicomp" .
"SIAM Journal on Computing")
900 ("tcs" .
"Theoretical Computer Science")
901 ("tocs" .
"ACM Transactions on Computer Systems")
902 ("tods" .
"ACM Transactions on Database Systems")
903 ("tog" .
"ACM Transactions on Graphics")
904 ("toms" .
"ACM Transactions on Mathematical Software")
905 ("toois" .
"ACM Transactions on Office Information Systems")
906 ("toplas" .
"ACM Transactions on Programming Languages and Systems")))
907 "Alist of string definitions used in the BibTeX style files.
908 Each element is a pair of strings (ABBREVIATION . EXPANSION)."
910 :type
'(repeat (cons (string :tag
"String")
911 (string :tag
"String expansion"))))
913 (defcustom bibtex-string-files nil
914 "List of BibTeX files containing string definitions.
915 List elements can be absolute file names or file names relative
916 to the directories specified in `bibtex-string-file-path'."
918 :type
'(repeat file
))
920 (defcustom bibtex-string-file-path
(getenv "BIBINPUTS")
921 "Colon-separated list of paths to search for `bibtex-string-files'."
925 (defcustom bibtex-files nil
926 "List of BibTeX files that are searched for entry keys.
927 List elements can be absolute file names or file names relative to the
928 directories specified in `bibtex-file-path'. If an element is a directory,
929 check all BibTeX files in this directory. If an element is the symbol
930 `bibtex-file-path', check all BibTeX files in `bibtex-file-path'.
931 See also `bibtex-search-entry-globally'."
933 :type
'(repeat (choice (const :tag
"bibtex-file-path" bibtex-file-path
)
936 (defcustom bibtex-file-path
(getenv "BIBINPUTS")
937 "Colon separated list of paths to search for `bibtex-files'."
941 (defcustom bibtex-search-entry-globally nil
942 "If non-nil, interactive calls of `bibtex-search-entry' search globally.
943 A global search includes all files in `bibtex-files'."
948 (defcustom bibtex-help-message t
949 "If non-nil print help messages in the echo area on entering a new field."
953 (defcustom bibtex-autokey-prefix-string
""
954 "String prefix for automatically generated reference keys.
955 See `bibtex-generate-autokey' for details."
956 :group
'bibtex-autokey
959 (defcustom bibtex-autokey-names
1
960 "Number of names to use for the automatically generated reference key.
961 Possibly more names are used according to `bibtex-autokey-names-stretch'.
962 If this variable is nil, all names are used.
963 See `bibtex-generate-autokey' for details."
964 :group
'bibtex-autokey
965 :type
'(choice (const :tag
"All" infty
)
968 (defcustom bibtex-autokey-names-stretch
0
969 "Number of names that can additionally be used for reference keys.
970 These names are used only, if all names are used then.
971 See `bibtex-generate-autokey' for details."
972 :group
'bibtex-autokey
975 (defcustom bibtex-autokey-additional-names
""
976 "String to append to the generated key if not all names could be used.
977 See `bibtex-generate-autokey' for details."
978 :group
'bibtex-autokey
981 (defcustom bibtex-autokey-expand-strings nil
982 "If non-nil, expand strings when extracting the content of a BibTeX field.
983 See `bibtex-generate-autokey' for details."
984 :group
'bibtex-autokey
987 (defvar bibtex-autokey-transcriptions
988 '(;; language specific characters
989 ("\\\\aa" .
"a") ; \aa -> a
990 ("\\\\AA" .
"A") ; \AA -> A
991 ("\\\"a\\|\\\\\\\"a\\|\\\\ae" .
"ae") ; "a,\"a,\ae -> ae
992 ("\\\"A\\|\\\\\\\"A\\|\\\\AE" .
"Ae") ; "A,\"A,\AE -> Ae
993 ("\\\\i" .
"i") ; \i -> i
994 ("\\\\j" .
"j") ; \j -> j
995 ("\\\\l" .
"l") ; \l -> l
996 ("\\\\L" .
"L") ; \L -> L
997 ("\\\"o\\|\\\\\\\"o\\|\\\\o\\|\\\\oe" .
"oe") ; "o,\"o,\o,\oe -> oe
998 ("\\\"O\\|\\\\\\\"O\\|\\\\O\\|\\\\OE" .
"Oe") ; "O,\"O,\O,\OE -> Oe
999 ("\\\"s\\|\\\\\\\"s\\|\\\\3" .
"ss") ; "s,\"s,\3 -> ss
1000 ("\\\"u\\|\\\\\\\"u" .
"ue") ; "u,\"u -> ue
1001 ("\\\"U\\|\\\\\\\"U" .
"Ue") ; "U,\"U -> Ue
1003 ("\\\\`\\|\\\\'\\|\\\\\\^\\|\\\\~\\|\\\\=\\|\\\\\\.\\|\\\\u\\|\\\\v\\|\\\\H\\|\\\\t\\|\\\\c\\|\\\\d\\|\\\\b" .
"")
1004 ;; braces, quotes, concatenation.
1006 ("\\\\-" .
"") ; \- ->
1008 ("\\\\?[ \t\n]+\\|~" .
" "))
1009 "Alist of (OLD-REGEXP . NEW-STRING) pairs.
1010 Used by the default values of `bibtex-autokey-name-change-strings' and
1011 `bibtex-autokey-titleword-change-strings'. Defaults to translating some
1012 language specific characters to their ASCII transcriptions, and
1013 removing any character accents.")
1015 (defcustom bibtex-autokey-name-change-strings
1016 bibtex-autokey-transcriptions
1017 "Alist of (OLD-REGEXP . NEW-STRING) pairs.
1018 Any part of a name matching OLD-REGEXP is replaced by NEW-STRING.
1019 Case is significant in OLD-REGEXP. All regexps are tried in the
1020 order in which they appear in the list.
1021 See `bibtex-generate-autokey' for details."
1022 :group
'bibtex-autokey
1023 :type
'(repeat (cons (regexp :tag
"Old")
1024 (string :tag
"New"))))
1026 (defcustom bibtex-autokey-name-case-convert-function
'downcase
1027 "Function called for each name to perform case conversion.
1028 See `bibtex-generate-autokey' for details."
1029 :group
'bibtex-autokey
1030 :type
'(choice (const :tag
"Preserve case" identity
)
1031 (const :tag
"Downcase" downcase
)
1032 (const :tag
"Capitalize" capitalize
)
1033 (const :tag
"Upcase" upcase
)
1034 (function :tag
"Conversion function")))
1035 (put 'bibtex-autokey-name-case-convert-function
'safe-local-variable
1036 (lambda (x) (memq x
'(upcase downcase capitalize identity
))))
1037 (defvaralias 'bibtex-autokey-name-case-convert
1038 'bibtex-autokey-name-case-convert-function
)
1040 (defcustom bibtex-autokey-name-length
'infty
1041 "Number of characters from name to incorporate into key.
1042 If this is set to anything but a number, all characters are used.
1043 See `bibtex-generate-autokey' for details."
1044 :group
'bibtex-autokey
1045 :type
'(choice (const :tag
"All" infty
)
1048 (defcustom bibtex-autokey-name-separator
""
1049 "String that comes between any two names in the key.
1050 See `bibtex-generate-autokey' for details."
1051 :group
'bibtex-autokey
1054 (defcustom bibtex-autokey-year-length
2
1055 "Number of rightmost digits from the year field to incorporate into key.
1056 See `bibtex-generate-autokey' for details."
1057 :group
'bibtex-autokey
1060 (defcustom bibtex-autokey-use-crossref t
1061 "If non-nil use fields from crossreferenced entry if necessary.
1062 If this variable is non-nil and some field has no entry, but a
1063 valid crossref entry, the field from the crossreferenced entry is used.
1064 See `bibtex-generate-autokey' for details."
1065 :group
'bibtex-autokey
1068 (defcustom bibtex-autokey-titlewords
5
1069 "Number of title words to use for the automatically generated reference key.
1070 If this is set to anything but a number, all title words are used.
1071 Possibly more words from the title are used according to
1072 `bibtex-autokey-titlewords-stretch'.
1073 See `bibtex-generate-autokey' for details."
1074 :group
'bibtex-autokey
1075 :type
'(choice (const :tag
"All" infty
)
1078 (defcustom bibtex-autokey-title-terminators
"[.!?:;]\\|--"
1079 "Regexp defining the termination of the main part of the title.
1080 Case of the regexps is ignored. See `bibtex-generate-autokey' for details."
1081 :group
'bibtex-autokey
1084 (defcustom bibtex-autokey-titlewords-stretch
2
1085 "Number of words that can additionally be used from the title.
1086 These words are used only, if a sentence from the title can be ended then.
1087 See `bibtex-generate-autokey' for details."
1088 :group
'bibtex-autokey
1091 (defcustom bibtex-autokey-titleword-ignore
1092 '("A" "An" "On" "The" "Eine?" "Der" "Die" "Das"
1093 "[^[:upper:]].*" ".*[^[:upper:][:lower:]0-9].*")
1094 "Determines words from the title that are not to be used in the key.
1095 Each item of the list is a regexp. If a word of the title matches a
1096 regexp from that list, it is not included in the title part of the key.
1097 Case is significant. See `bibtex-generate-autokey' for details."
1098 :group
'bibtex-autokey
1099 :type
'(repeat regexp
))
1101 (defcustom bibtex-autokey-titleword-case-convert-function
'downcase
1102 "Function called for each titleword to perform case conversion.
1103 See `bibtex-generate-autokey' for details."
1104 :group
'bibtex-autokey
1105 :type
'(choice (const :tag
"Preserve case" identity
)
1106 (const :tag
"Downcase" downcase
)
1107 (const :tag
"Capitalize" capitalize
)
1108 (const :tag
"Upcase" upcase
)
1109 (function :tag
"Conversion function")))
1110 (defvaralias 'bibtex-autokey-titleword-case-convert
1111 'bibtex-autokey-titleword-case-convert-function
)
1113 (defcustom bibtex-autokey-titleword-abbrevs nil
1114 "Determines exceptions to the usual abbreviation mechanism.
1115 An alist of (OLD-REGEXP . NEW-STRING) pairs. Case is ignored
1116 in matching against OLD-REGEXP, and the first matching pair is used.
1117 See `bibtex-generate-autokey' for details."
1118 :group
'bibtex-autokey
1119 :type
'(repeat (cons (regexp :tag
"Old")
1120 (string :tag
"New"))))
1122 (defcustom bibtex-autokey-titleword-change-strings
1123 bibtex-autokey-transcriptions
1124 "Alist of (OLD-REGEXP . NEW-STRING) pairs.
1125 Any part of title word matching a OLD-REGEXP is replaced by NEW-STRING.
1126 Case is significant in OLD-REGEXP. All regexps are tried in the
1127 order in which they appear in the list.
1128 See `bibtex-generate-autokey' for details."
1129 :group
'bibtex-autokey
1130 :type
'(repeat (cons (regexp :tag
"Old")
1131 (string :tag
"New"))))
1133 (defcustom bibtex-autokey-titleword-length
5
1134 "Number of characters from title words to incorporate into key.
1135 If this is set to anything but a number, all characters are used.
1136 See `bibtex-generate-autokey' for details."
1137 :group
'bibtex-autokey
1138 :type
'(choice (const :tag
"All" infty
)
1141 (defcustom bibtex-autokey-titleword-separator
"_"
1142 "String to be put between the title words.
1143 See `bibtex-generate-autokey' for details."
1144 :group
'bibtex-autokey
1147 (defcustom bibtex-autokey-name-year-separator
""
1148 "String to be put between name part and year part of key.
1149 See `bibtex-generate-autokey' for details."
1150 :group
'bibtex-autokey
1153 (defcustom bibtex-autokey-year-title-separator
":_"
1154 "String to be put between year part and title part of key.
1155 See `bibtex-generate-autokey' for details."
1156 :group
'bibtex-autokey
1159 (defcustom bibtex-autokey-edit-before-use t
1160 "If non-nil, user is allowed to edit the generated key before it is used."
1161 :group
'bibtex-autokey
1164 (defcustom bibtex-autokey-before-presentation-function nil
1165 "If non-nil, function to call before generated key is presented.
1166 The function must take one argument (the automatically generated key),
1167 and must return a string (the key to use)."
1168 :group
'bibtex-autokey
1169 :type
'(choice (const nil
) function
))
1171 (defcustom bibtex-entry-offset
0
1172 "Offset for BibTeX entries.
1173 Added to the value of all other variables which determine columns."
1177 (defcustom bibtex-field-indentation
2
1178 "Starting column for the name part in BibTeX fields."
1182 (defcustom bibtex-text-indentation
1183 (+ bibtex-field-indentation
1184 (length "organization = "))
1185 "Starting column for the text part in BibTeX fields.
1186 Should be equal to the space needed for the longest name part."
1190 (defcustom bibtex-contline-indentation
1191 (+ bibtex-text-indentation
1)
1192 "Starting column for continuation lines of BibTeX fields."
1196 (defcustom bibtex-align-at-equal-sign nil
1197 "If non-nil, align fields at equal sign instead of field text.
1198 If non-nil, the column for the equal sign is the value of
1199 `bibtex-text-indentation', minus 2."
1203 (defcustom bibtex-comma-after-last-field nil
1204 "If non-nil, a comma is put at end of last field in the entry template."
1208 (defcustom bibtex-autoadd-commas t
1209 "If non-nil automatically add missing commas at end of BibTeX fields."
1213 (defcustom bibtex-autofill-types
'("Proceedings")
1214 "Automatically fill fields if possible for those BibTeX entry types."
1216 :type
'(repeat string
))
1218 (defcustom bibtex-summary-function
'bibtex-summary
1219 "Function to call for generating a summary of current BibTeX entry.
1220 It takes no arguments. Point must be at beginning of entry.
1221 Used by `bibtex-complete-crossref-cleanup' and `bibtex-copy-summary-as-kill'."
1223 :type
'(choice (const :tag
"Default" bibtex-summary
)
1224 (function :tag
"Personalized function")))
1226 (defcustom bibtex-generate-url-list
1227 '((("url" .
".*:.*")))
1228 "List of schemes for generating the URL of a BibTeX entry.
1229 These schemes are used by `bibtex-url'.
1231 Each scheme should have one of these forms:
1234 ((FIELD . REGEXP) STEP...)
1235 ((FIELD . REGEXP) STRING STEP...)
1237 FIELD is a field name as returned by `bibtex-parse-entry'.
1238 REGEXP is matched against the text of FIELD. If the match succeeds,
1239 then this scheme is used. If no STRING and STEPs are specified
1240 the matched text is used as the URL, otherwise the URL is built
1241 by evaluating STEPs. If no STRING is specified the STEPs must result
1242 in strings which are concatenated. Otherwise the resulting objects
1243 are passed through `format' using STRING as format control string.
1245 A STEP is a list (FIELD REGEXP REPLACE). The text of FIELD
1246 is matched against REGEXP, and is replaced with REPLACE.
1247 REPLACE can be a string, or a number (which selects the corresponding
1248 submatch), or a function called with the field's text as argument
1249 and with the `match-data' properly set.
1251 Case is always ignored. Always remove the field delimiters.
1252 If `bibtex-expand-strings' is non-nil, BibTeX strings are expanded
1253 for generating the URL.
1254 Set this variable before loading BibTeX mode.
1256 The following is a complex example, see URL `http://link.aps.org/'.
1258 (((\"journal\" . \"\\\\=<\\(PR[ABCDEL]?\\|RMP\\)\\\\=>\")
1259 \"http://link.aps.org/abstract/%s/v%s/p%s\"
1260 (\"journal\" \".*\" upcase)
1261 (\"volume\" \".*\" 0)
1262 (\"pages\" \"\\`[A-Z]?[0-9]+\" 0)))"
1266 (cons :tag
"Matcher" :extra-offset
4
1267 (string :tag
"BibTeX field")
1268 (regexp :tag
"Regexp"))
1270 (const :tag
"Take match as is" nil
)
1271 (cons :tag
"Formatted"
1272 (string :tag
"Format control string")
1273 (repeat :tag
"Steps to generate URL"
1274 (list (string :tag
"BibTeX field")
1275 (regexp :tag
"Regexp")
1276 (choice (string :tag
"Replacement")
1277 (integer :tag
"Sub-match")
1278 (function :tag
"Filter")))))
1279 (repeat :tag
"Concatenated"
1280 (list (string :tag
"BibTeX field")
1281 (regexp :tag
"Regexp")
1282 (choice (string :tag
"Replacement")
1283 (integer :tag
"Sub-match")
1284 (function :tag
"Filter"))))))))
1285 (put 'bibtex-generate-url-list
'risky-local-variable t
)
1287 (defcustom bibtex-cite-matcher-alist
1288 '(("\\\\cite[ \t\n]*{\\([^}]+\\)}" .
1))
1289 "Alist of rules to identify cited keys in a BibTeX entry.
1290 Each rule should be of the form (REGEXP . SUBEXP), where SUBEXP
1291 specifies which parenthesized expression in REGEXP is a cited key.
1292 Case is significant.
1293 Used by `bibtex-search-crossref' and for font-locking.
1294 Set this variable before loading BibTeX mode."
1296 :type
'(repeat (cons (regexp :tag
"Regexp")
1297 (integer :tag
"Number")))
1300 (defcustom bibtex-expand-strings nil
1301 "If non-nil, expand strings when extracting the content of a BibTeX field."
1305 (defcustom bibtex-search-buffer
"*BibTeX Search*"
1306 "Buffer for BibTeX search results."
1311 ;; `bibtex-font-lock-keywords' is a user option, too. But since the
1312 ;; patterns used to define this variable are defined in a later
1313 ;; section of this file, it is defined later.
1316 ;; Syntax Table and Keybindings
1317 (defvar bibtex-mode-syntax-table
1318 (let ((st (make-syntax-table)))
1319 (modify-syntax-entry ?
\" "\"" st
)
1320 (modify-syntax-entry ?$
"$$ " st
)
1321 (modify-syntax-entry ?%
"< " st
)
1322 (modify-syntax-entry ?
' "w " st
) ;FIXME: Not allowed in @string keys.
1323 (modify-syntax-entry ?
@ "w " st
)
1324 (modify-syntax-entry ?
\\ "\\" st
)
1325 (modify-syntax-entry ?
\f "> " st
)
1326 (modify-syntax-entry ?
\n "> " st
)
1327 ;; Keys cannot have = in them (wrong font-lock of @string{foo=bar}).
1328 (modify-syntax-entry ?
= "." st
)
1329 (modify-syntax-entry ?~
" " st
)
1331 "Syntax table used in BibTeX mode buffers.")
1333 (defvar bibtex-mode-map
1334 (let ((km (make-sparse-keymap)))
1335 ;; The Key `C-c&' is reserved for reftex.el
1336 (define-key km
"\t" 'bibtex-find-text
)
1337 (define-key km
"\n" 'bibtex-next-field
)
1338 (define-key km
"\M-\t" 'completion-at-point
)
1339 (define-key km
"\C-c\"" 'bibtex-remove-delimiters
)
1340 (define-key km
"\C-c{" 'bibtex-remove-delimiters
)
1341 (define-key km
"\C-c}" 'bibtex-remove-delimiters
)
1342 (define-key km
"\C-c\C-c" 'bibtex-clean-entry
)
1343 (define-key km
"\C-c\C-q" 'bibtex-fill-entry
)
1344 (define-key km
"\C-c\C-s" 'bibtex-search-entry
)
1345 (define-key km
"\C-c\C-x" 'bibtex-search-crossref
)
1346 (define-key km
"\C-c\C-t" 'bibtex-copy-summary-as-kill
)
1347 (define-key km
"\C-c?" 'bibtex-print-help-message
)
1348 (define-key km
"\C-c\C-p" 'bibtex-pop-previous
)
1349 (define-key km
"\C-c\C-n" 'bibtex-pop-next
)
1350 (define-key km
"\C-c\C-k" 'bibtex-kill-field
)
1351 (define-key km
"\C-c\M-k" 'bibtex-copy-field-as-kill
)
1352 (define-key km
"\C-c\C-w" 'bibtex-kill-entry
)
1353 (define-key km
"\C-c\M-w" 'bibtex-copy-entry-as-kill
)
1354 (define-key km
"\C-c\C-y" 'bibtex-yank
)
1355 (define-key km
"\C-c\M-y" 'bibtex-yank-pop
)
1356 (define-key km
"\C-c\C-d" 'bibtex-empty-field
)
1357 (define-key km
"\C-c\C-f" 'bibtex-make-field
)
1358 (define-key km
"\C-c\C-u" 'bibtex-entry-update
)
1359 (define-key km
"\C-c$" 'bibtex-ispell-abstract
)
1360 (define-key km
"\M-\C-a" 'bibtex-beginning-of-entry
)
1361 (define-key km
"\M-\C-e" 'bibtex-end-of-entry
)
1362 (define-key km
"\C-\M-l" 'bibtex-reposition-window
)
1363 (define-key km
"\C-\M-h" 'bibtex-mark-entry
)
1364 (define-key km
"\C-c\C-b" 'bibtex-entry
)
1365 (define-key km
"\C-c\C-rn" 'bibtex-narrow-to-entry
)
1366 (define-key km
"\C-c\C-rw" 'widen
)
1367 (define-key km
"\C-c\C-l" 'bibtex-url
)
1368 (define-key km
"\C-c\C-a" 'bibtex-search-entries
)
1369 (define-key km
"\C-c\C-o" 'bibtex-remove-OPT-or-ALT
)
1370 (define-key km
"\C-c\C-e\C-i" 'bibtex-InProceedings
)
1371 (define-key km
"\C-c\C-ei" 'bibtex-InCollection
)
1372 (define-key km
"\C-c\C-eI" 'bibtex-InBook
)
1373 (define-key km
"\C-c\C-e\C-a" 'bibtex-Article
)
1374 (define-key km
"\C-c\C-e\C-b" 'bibtex-InBook
)
1375 (define-key km
"\C-c\C-eb" 'bibtex-Book
)
1376 (define-key km
"\C-c\C-eB" 'bibtex-Booklet
)
1377 (define-key km
"\C-c\C-e\C-c" 'bibtex-InCollection
)
1378 (define-key km
"\C-c\C-e\C-m" 'bibtex-Manual
)
1379 (define-key km
"\C-c\C-em" 'bibtex-MastersThesis
)
1380 (define-key km
"\C-c\C-eM" 'bibtex-Misc
)
1381 (define-key km
"\C-c\C-e\C-p" 'bibtex-InProceedings
)
1382 (define-key km
"\C-c\C-ep" 'bibtex-Proceedings
)
1383 (define-key km
"\C-c\C-eP" 'bibtex-PhdThesis
)
1384 (define-key km
"\C-c\C-e\M-p" 'bibtex-Preamble
)
1385 (define-key km
"\C-c\C-e\C-s" 'bibtex-String
)
1386 (define-key km
"\C-c\C-e\C-t" 'bibtex-TechReport
)
1387 (define-key km
"\C-c\C-e\C-u" 'bibtex-Unpublished
)
1389 "Keymap used in BibTeX mode.")
1392 bibtex-edit-menu bibtex-mode-map
"BibTeX-Edit Menu in BibTeX mode"
1394 ("Moving inside an Entry"
1395 ["End of Field" bibtex-find-text t
]
1396 ["Next Field" bibtex-next-field t
]
1397 ["Beginning of Entry" bibtex-beginning-of-entry t
]
1398 ["End of Entry" bibtex-end-of-entry t
]
1400 ["Make Entry Visible" bibtex-reposition-window t
])
1401 ("Moving in BibTeX Buffers"
1402 ["Search Entry" bibtex-search-entry t
]
1403 ["Search Crossref Entry" bibtex-search-crossref t
])
1405 ("Operating on Current Field"
1406 ["Fill Field" fill-paragraph t
]
1407 ["Remove Delimiters" bibtex-remove-delimiters t
]
1408 ["Remove OPT or ALT Prefix" bibtex-remove-OPT-or-ALT t
]
1409 ["Clear Field" bibtex-empty-field t
]
1411 ["Kill Field" bibtex-kill-field t
]
1412 ["Copy Field to Kill Ring" bibtex-copy-field-as-kill t
]
1413 ["Paste Most Recently Killed Field" bibtex-yank t
]
1414 ["Paste Previously Killed Field" bibtex-yank-pop t
]
1416 ["Make New Field" bibtex-make-field t
]
1418 ["Snatch from Similar Following Field" bibtex-pop-next t
]
1419 ["Snatch from Similar Preceding Field" bibtex-pop-previous t
]
1421 ["String or Key Complete" bibtex-complete t
]
1423 ["Help about Current Field" bibtex-print-help-message t
])
1424 ("Operating on Current Entry"
1425 ["Fill Entry" bibtex-fill-entry t
]
1426 ["Clean Entry" bibtex-clean-entry t
]
1427 ["Update Entry" bibtex-entry-update t
]
1429 ["Kill Entry" bibtex-kill-entry t
]
1430 ["Copy Entry to Kill Ring" bibtex-copy-entry-as-kill t
]
1431 ["Paste Most Recently Killed Entry" bibtex-yank t
]
1432 ["Paste Previously Killed Entry" bibtex-yank-pop t
]
1434 ["Copy Summary to Kill Ring" bibtex-copy-summary-as-kill t
]
1435 ["Browse URL" bibtex-url t
]
1437 ["Ispell Entry" bibtex-ispell-entry t
]
1438 ["Ispell Entry Abstract" bibtex-ispell-abstract t
]
1440 ["Narrow to Entry" bibtex-narrow-to-entry t
]
1441 ["Mark Entry" bibtex-mark-entry t
]
1443 ["View Cite Locations (RefTeX)" reftex-view-crossref-from-bibtex
1444 (fboundp 'reftex-view-crossref-from-bibtex
)])
1445 ("Operating on Buffer or Region"
1446 ["Search Entries" bibtex-search-entries t
]
1448 ["Validate Entries" bibtex-validate t
]
1449 ["Sort Entries" bibtex-sort-buffer t
]
1450 ["Reformat Entries" bibtex-reformat t
]
1451 ["Count Entries" bibtex-count-entries t
]
1453 ["Convert Alien Buffer" bibtex-convert-alien t
])
1454 ("Operating on Multiple Buffers"
1455 ["(Re)Initialize BibTeX Buffers" bibtex-initialize t
]
1456 ["Validate Entries" bibtex-validate-globally t
])))
1459 ;; Internal Variables
1461 (defvar bibtex-entry-alist nil
1462 "Alist of currently active entry types.
1463 Initialized by `bibtex-set-dialect'.")
1465 (defvar bibtex-field-alist nil
1466 "Alist of currently active field types.
1467 Initialized by `bibtex-set-dialect'.")
1469 (defvar bibtex-field-braces-opt nil
1470 "Optimized value of `bibtex-field-braces-alist'.
1471 Created by `bibtex-field-re-init'.
1472 It is an alist with elements (FIELD . REGEXP).")
1474 (defvar bibtex-field-strings-opt nil
1475 "Optimized value of `bibtex-field-strings-alist'.
1476 Created by `bibtex-field-re-init'.
1477 It is an alist with elements (FIELD RULE1 RULE2 ...),
1478 where each RULE is (REGEXP . TO-STR).")
1480 (defvar bibtex-pop-previous-search-point nil
1481 "Next point where `bibtex-pop-previous' starts looking for a similar entry.")
1483 (defvar bibtex-pop-next-search-point nil
1484 "Next point where `bibtex-pop-next' starts looking for a similar entry.")
1486 (defvar bibtex-field-kill-ring nil
1487 "Ring of least recently killed fields.
1488 At most `bibtex-field-kill-ring-max' items are kept here.")
1490 (defvar bibtex-field-kill-ring-yank-pointer nil
1491 "The tail of `bibtex-field-kill-ring' whose car is the last item yanked.")
1493 (defvar bibtex-entry-kill-ring nil
1494 "Ring of least recently killed entries.
1495 At most `bibtex-entry-kill-ring-max' items are kept here.")
1497 (defvar bibtex-entry-kill-ring-yank-pointer nil
1498 "The tail of `bibtex-entry-kill-ring' whose car is the last item yanked.")
1500 (defvar bibtex-last-kill-command nil
1501 "Type of the last kill command (either 'field or 'entry).")
1503 (defvar bibtex-strings
1504 (lazy-completion-table bibtex-strings
1506 (bibtex-parse-strings (bibtex-string-files-init))))
1507 "Completion table for BibTeX string keys.
1508 Initialized from `bibtex-predefined-strings' and `bibtex-string-files'.")
1509 (make-variable-buffer-local 'bibtex-strings
)
1510 (put 'bibtex-strings
'risky-local-variable t
)
1512 (defvar bibtex-reference-keys
1513 (lazy-completion-table bibtex-reference-keys
1514 (lambda () (bibtex-parse-keys nil t
)))
1515 "Completion table for BibTeX reference keys.
1516 The CDRs of the elements are t for header keys and nil for crossref keys.")
1517 (make-variable-buffer-local 'bibtex-reference-keys
)
1518 (put 'bibtex-reference-keys
'risky-local-variable t
)
1520 (defvar bibtex-buffer-last-parsed-tick nil
1521 "Value of `buffer-modified-tick' last time buffer was parsed for keys.")
1523 (defvar bibtex-parse-idle-timer nil
1524 "Stores if timer is already installed.")
1526 (defvar bibtex-progress-lastperc nil
1527 "Last reported percentage for the progress message.")
1529 (defvar bibtex-progress-lastmes nil
1530 "Last reported progress message.")
1532 (defvar bibtex-progress-interval nil
1533 "Interval for progress messages.")
1535 (defvar bibtex-key-history nil
1536 "History list for reading keys.")
1538 (defvar bibtex-entry-type-history nil
1539 "History list for reading entry types.")
1541 (defvar bibtex-field-history nil
1542 "History list for reading field names.")
1544 (defvar bibtex-reformat-previous-options nil
1545 "Last reformat options given.")
1547 (defvar bibtex-reformat-previous-reference-keys nil
1548 "Last reformat reference keys option given.")
1550 (defconst bibtex-field-name
"[^\"#%'(),={} \t\n0-9][^\"#%'(),={} \t\n]*"
1551 "Regexp matching the name of a BibTeX field.")
1553 (defconst bibtex-name-part
1554 (concat ",[ \t\n]*\\(" bibtex-field-name
"\\)")
1555 "Regexp matching the name part of a BibTeX field.")
1557 (defconst bibtex-reference-key
"[][[:alnum:].:;?!`'/*@+|()<>&_^$-]+"
1558 "Regexp matching the reference key part of a BibTeX entry.")
1560 (defconst bibtex-field-const
"[][[:alnum:].:;?!`'/*@+=|<>&_^$-]+"
1561 "Regexp matching a BibTeX field constant.")
1563 (defvar bibtex-entry-type nil
1564 "Regexp matching the type of a BibTeX entry.
1565 Initialized by `bibtex-set-dialect'.")
1567 (defvar bibtex-entry-head nil
1568 "Regexp matching the header line of a BibTeX entry (including key).
1569 Initialized by `bibtex-set-dialect'.")
1571 (defvar bibtex-entry-maybe-empty-head nil
1572 "Regexp matching the header line of a BibTeX entry (possibly without key).
1573 Initialized by `bibtex-set-dialect'.")
1575 (defconst bibtex-any-entry-maybe-empty-head
1576 (concat "^[ \t]*\\(@[ \t]*" bibtex-field-name
"\\)[ \t]*[({][ \t\n]*\\("
1577 bibtex-reference-key
"\\)?")
1578 "Regexp matching the header line of any BibTeX entry (possibly without key).")
1580 (defvar bibtex-any-valid-entry-type nil
1581 "Regexp matching any valid BibTeX entry (including String and Preamble).
1582 Initialized by `bibtex-set-dialect'.")
1584 (defconst bibtex-type-in-head
1
1585 "Regexp subexpression number of the type part in `bibtex-entry-head'.")
1587 (defconst bibtex-key-in-head
2
1588 "Regexp subexpression number of the key part in `bibtex-entry-head'.")
1590 (defconst bibtex-string-type
"^[ \t]*\\(@[ \t]*String\\)[ \t]*[({][ \t\n]*"
1591 "Regexp matching the name of a BibTeX String entry.")
1593 (defconst bibtex-string-maybe-empty-head
1594 (concat bibtex-string-type
"\\(" bibtex-reference-key
"\\)?")
1595 "Regexp matching the header line of a BibTeX String entry.")
1597 (defconst bibtex-preamble-prefix
1598 "[ \t]*\\(@[ \t]*Preamble\\)[ \t]*[({][ \t\n]*"
1599 "Regexp matching the prefix part of a BibTeX Preamble entry.")
1601 (defconst bibtex-font-lock-syntactic-keywords
1602 `((,(concat "^[ \t]*\\(" (substring bibtex-comment-start
0 1) "\\)"
1603 (substring bibtex-comment-start
1) "\\>")
1606 (defvar bibtex-font-lock-keywords
1607 ;; entry type and reference key
1608 `((,bibtex-any-entry-maybe-empty-head
1609 (,bibtex-type-in-head font-lock-function-name-face
)
1610 (,bibtex-key-in-head font-lock-constant-face nil t
))
1611 ;; optional field names (treated as comments)
1612 (,(concat "^[ \t]*\\(OPT" bibtex-field-name
"\\)[ \t]*=")
1613 1 font-lock-comment-face
)
1615 (,(concat "^[ \t]*\\(" bibtex-field-name
"\\)[ \t]*=")
1616 1 font-lock-variable-name-face
)
1618 (bibtex-font-lock-url) (bibtex-font-lock-crossref)
1620 ,@(mapcar (lambda (matcher)
1621 `((lambda (bound) (bibtex-font-lock-cite ',matcher bound
))))
1622 bibtex-cite-matcher-alist
))
1623 "Default expressions to highlight in BibTeX mode.")
1625 (defvar bibtex-font-lock-url-regexp
1626 ;; Assume that field names begin at the beginning of a line.
1628 (regexp-opt (delete-dups (mapcar 'caar bibtex-generate-url-list
)) t
)
1630 "Regexp for `bibtex-font-lock-url' derived from `bibtex-generate-url-list'.")
1632 (defvar bibtex-string-empty-key nil
1633 "If non-nil, `bibtex-parse-string' accepts empty key.")
1635 (defvar bibtex-sort-entry-class-alist nil
1636 "Alist mapping entry types to their sorting index.
1637 Auto-generated from `bibtex-sort-entry-class'.
1638 Used when `bibtex-maintain-sorted-entries' is `entry-class'.")
1641 (defun bibtex-parse-association (parse-lhs parse-rhs
)
1642 "Parse a string of the format <left-hand-side = right-hand-side>.
1643 The functions PARSE-LHS and PARSE-RHS are used to parse the corresponding
1644 substrings. These functions are expected to return nil if parsing is not
1645 successful. If the returned values of both functions are non-nil,
1646 return a cons pair of these values. Do not move point."
1649 (let ((left (funcall parse-lhs
))
1652 (looking-at "[ \t\n]*=[ \t\n]*")
1653 (goto-char (match-end 0))
1654 (setq right
(funcall parse-rhs
)))
1655 (cons left right
))))))
1657 (defun bibtex-parse-field-name ()
1658 "Parse the name part of a BibTeX field.
1659 If the field name is found, return a triple consisting of the position of the
1660 very first character of the match, the actual starting position of the name
1661 part and end position of the match. Move point to end of field name.
1662 If `bibtex-autoadd-commas' is non-nil add missing comma at end of preceding
1663 BibTeX field as necessary."
1664 (cond ((looking-at bibtex-name-part
)
1665 (goto-char (match-end 0))
1666 (list (match-beginning 0) (match-beginning 1) (match-end 0)))
1667 ;; Maybe add a missing comma.
1668 ((and bibtex-autoadd-commas
1669 (looking-at (concat "[ \t\n]*\\(?:" bibtex-field-name
1671 (skip-chars-backward " \t\n")
1672 ;; It can be confusing if non-editing commands try to
1673 ;; modify the buffer.
1674 (if buffer-read-only
1675 (error "Comma missing at buffer position %s" (point)))
1679 (bibtex-parse-field-name))))
1681 (defconst bibtex-braced-string-syntax-table
1682 (let ((st (make-syntax-table)))
1683 (modify-syntax-entry ?\
{ "(}" st
)
1684 (modify-syntax-entry ?\
} "){" st
)
1685 (modify-syntax-entry ?\
[ "." st
)
1686 (modify-syntax-entry ?\
] "." st
)
1687 (modify-syntax-entry ?\
( "." st
)
1688 (modify-syntax-entry ?\
) "." st
)
1689 (modify-syntax-entry ?
\\ "." st
)
1690 (modify-syntax-entry ?
\" "." st
)
1692 "Syntax-table to parse matched braces.")
1694 (defconst bibtex-quoted-string-syntax-table
1695 (let ((st (make-syntax-table)))
1696 (modify-syntax-entry ?
\\ "\\" st
)
1697 (modify-syntax-entry ?
\" "\"" st
)
1699 "Syntax-table to parse matched quotes.")
1701 (defun bibtex-parse-field-string ()
1702 "Parse a BibTeX field string enclosed by braces or quotes.
1703 If a syntactically correct string is found, a pair containing the start and
1704 end position of the field string is returned, nil otherwise.
1707 (or (and (eq (following-char) ?
\")
1709 (with-syntax-table bibtex-quoted-string-syntax-table
1712 (and (eq (following-char) ?\
{)
1714 (with-syntax-table bibtex-braced-string-syntax-table
1718 (cons (point) end-point
))))
1720 (defun bibtex-parse-field-text ()
1721 "Parse the text part of a BibTeX field.
1722 The text part is either a string, or an empty string, or a constant followed
1723 by one or more <# (string|constant)> pairs. If a syntactically correct text
1724 is found, a pair containing the start and end position of the text is
1725 returned, nil otherwise. Move point to end of field text."
1726 (let ((starting-point (point))
1727 end-point failure boundaries
)
1728 (while (not (or end-point failure
))
1729 (cond ((looking-at bibtex-field-const
)
1730 (goto-char (match-end 0)))
1731 ((setq boundaries
(bibtex-parse-field-string))
1732 (goto-char (cdr boundaries
)))
1734 (if (looking-at "[ \t\n]*#[ \t\n]*")
1735 (goto-char (match-end 0))
1736 (setq end-point
(point))))
1737 (skip-chars-forward " \t\n")
1738 (if (and (not failure
)
1740 (list starting-point end-point
(point)))))
1742 (defun bibtex-parse-field ()
1743 "Parse the BibTeX field beginning at the position of point.
1744 If a syntactically correct field is found, return a cons pair containing
1745 the boundaries of the name and text parts of the field. Do not move point."
1746 (bibtex-parse-association 'bibtex-parse-field-name
1747 'bibtex-parse-field-text
))
1749 (defsubst bibtex-start-of-field
(bounds)
1750 (nth 0 (car bounds
)))
1751 (defsubst bibtex-start-of-name-in-field
(bounds)
1752 (nth 1 (car bounds
)))
1753 (defsubst bibtex-end-of-name-in-field
(bounds)
1754 (nth 2 (car bounds
)))
1755 (defsubst bibtex-start-of-text-in-field
(bounds)
1757 (defsubst bibtex-end-of-text-in-field
(bounds)
1759 (defsubst bibtex-end-of-field
(bounds)
1762 (defun bibtex-search-forward-field (name &optional bound
)
1763 "Search forward to find a BibTeX field of name NAME.
1764 If a syntactically correct field is found, return a pair containing
1765 the boundaries of the name and text parts of the field. The search
1766 is limited by optional arg BOUND. If BOUND is t the search is limited
1767 by the end of the current entry. Do not move point."
1771 (let ((regexp (concat bibtex-name-part
"[ \t\n]*=\\|"
1772 bibtex-any-entry-maybe-empty-head
))
1773 (case-fold-search t
) bounds
)
1775 (if (looking-at "[ \t]*@") (goto-char (match-end 0)))
1776 (while (and (not bounds
)
1777 (re-search-forward regexp nil t
))
1778 (if (match-beginning 2)
1779 ;; We found a new entry
1782 (goto-char (match-beginning 0))
1783 (setq bounds
(bibtex-parse-field))))
1784 ;; Step through all fields so that we cannot overshoot.
1786 (goto-char (bibtex-start-of-name-in-field bounds
))
1787 (if (looking-at name
) (throw 'done bounds
))
1788 (goto-char (bibtex-end-of-field bounds
))
1789 (setq bounds
(bibtex-parse-field)))))
1790 ;; Bounded search or bound is nil (i.e. we cannot overshoot).
1791 ;; Indeed, the search is bounded when `bibtex-search-forward-field'
1792 ;; is called many times. So we optimize this part of this function.
1793 (let ((name-part (concat ",[ \t\n]*\\(" name
"\\)[ \t\n]*=[ \t\n]*"))
1794 (case-fold-search t
) left right
)
1795 (while (and (not right
)
1796 (re-search-forward name-part bound t
))
1797 (setq left
(list (match-beginning 0) (match-beginning 1)
1799 ;; Don't worry that the field text could be past bound.
1800 right
(bibtex-parse-field-text)))
1801 (if right
(cons left right
)))))))
1803 (defun bibtex-search-backward-field (name &optional bound
)
1804 "Search backward to find a BibTeX field of name NAME.
1805 If a syntactically correct field is found, return a pair containing
1806 the boundaries of the name and text parts of the field. The search
1807 is limited by the optional arg BOUND. If BOUND is t the search is
1808 limited by the beginning of the current entry. Do not move point."
1811 (setq bound
(save-excursion (bibtex-beginning-of-entry))))
1812 (let ((name-part (concat ",[ \t\n]*\\(" name
"\\)[ \t\n]*=[ \t\n]*"))
1813 (case-fold-search t
) left right
)
1815 ;; the parsing functions are not designed for parsing backwards :-(
1816 (when (search-backward "," bound t
)
1818 (when (looking-at name-part
)
1819 (setq left
(list (match-beginning 0) (match-beginning 1)
1821 (goto-char (match-end 0))
1822 (setq right
(bibtex-parse-field-text))))
1823 (while (and (not right
)
1824 (re-search-backward name-part bound t
))
1825 (setq left
(list (match-beginning 0) (match-beginning 1)
1828 (goto-char (match-end 0))
1829 (setq right
(bibtex-parse-field-text)))))
1830 (if right
(cons left right
)))))))
1832 (defun bibtex-name-in-field (bounds &optional remove-opt-alt
)
1833 "Get content of name in BibTeX field defined via BOUNDS.
1834 If optional arg REMOVE-OPT-ALT is non-nil remove \"OPT\" and \"ALT\"."
1835 (let ((name (buffer-substring-no-properties
1836 (bibtex-start-of-name-in-field bounds
)
1837 (bibtex-end-of-name-in-field bounds
))))
1838 (if (and remove-opt-alt
1839 (string-match "\\`\\(OPT\\|ALT\\)" name
)
1840 (not (and bibtex-no-opt-remove-re
1841 (string-match bibtex-no-opt-remove-re name
))))
1845 (defun bibtex-text-in-field-bounds (bounds &optional content
)
1846 "Get text in BibTeX field defined via BOUNDS.
1847 If optional arg CONTENT is non-nil extract content of field
1848 by removing field delimiters and concatenating the resulting string.
1849 If `bibtex-expand-strings' is non-nil, also expand BibTeX strings."
1852 (goto-char (bibtex-start-of-text-in-field bounds
))
1853 (let ((epoint (bibtex-end-of-text-in-field bounds
))
1855 (while (< (point) epoint
)
1856 (if (looking-at bibtex-field-const
)
1857 (let ((mtch (match-string-no-properties 0)))
1858 (push (or (if bibtex-expand-strings
1859 (cdr (assoc-string mtch
(bibtex-strings) t
)))
1861 (goto-char (match-end 0)))
1862 (let ((bounds (bibtex-parse-field-string)))
1863 (push (buffer-substring-no-properties
1864 (1+ (car bounds
)) (1- (cdr bounds
))) content
)
1865 (goto-char (cdr bounds
))))
1866 (re-search-forward "\\=[ \t\n]*#[ \t\n]*" nil t
))
1867 (apply 'concat
(nreverse content
))))
1868 (buffer-substring-no-properties (bibtex-start-of-text-in-field bounds
)
1869 (bibtex-end-of-text-in-field bounds
))))
1871 (defun bibtex-text-in-field (field &optional follow-crossref
)
1872 "Get content of field FIELD of current BibTeX entry.
1873 Return nil if not found.
1874 If optional arg FOLLOW-CROSSREF is non-nil, follow crossref."
1876 (let* ((end (if follow-crossref
(bibtex-end-of-entry) t
))
1877 (beg (bibtex-beginning-of-entry)) ; move point
1878 (bounds (bibtex-search-forward-field field end
)))
1879 (cond (bounds (bibtex-text-in-field-bounds bounds t
))
1880 ((and follow-crossref
1881 (progn (goto-char beg
)
1882 (setq bounds
(bibtex-search-forward-field
1883 "\\(OPT\\)?crossref" end
))))
1884 (let ((crossref-field (bibtex-text-in-field-bounds bounds t
)))
1885 (if (bibtex-search-crossref crossref-field
)
1886 ;; Do not pass FOLLOW-CROSSREF because we want
1887 ;; to follow crossrefs only one level of recursion.
1888 (bibtex-text-in-field field
))))))))
1890 (defun bibtex-parse-string-prefix ()
1891 "Parse the prefix part of a BibTeX string entry, including reference key.
1892 If the string prefix is found, return a triple consisting of the position of
1893 the very first character of the match, the actual starting position of the
1894 reference key and the end position of the match.
1895 If `bibtex-string-empty-key' is non-nil accept empty string key."
1896 (let ((case-fold-search t
))
1897 (if (looking-at bibtex-string-type
)
1898 (let ((start (point)))
1899 (goto-char (match-end 0))
1900 (cond ((looking-at bibtex-reference-key
)
1901 (goto-char (match-end 0))
1905 ((and bibtex-string-empty-key
1907 (skip-chars-backward " \t\n")
1908 (list start
(point) (point))))))))
1910 (defun bibtex-parse-string-postfix ()
1911 "Parse the postfix part of a BibTeX string entry, including the text.
1912 If the string postfix is found, return a triple consisting of the position of
1913 the actual starting and ending position of the text and the very last
1914 character of the string entry. Move point past BibTeX string entry."
1915 (let* ((case-fold-search t
)
1916 (bounds (bibtex-parse-field-text)))
1918 (goto-char (nth 1 bounds
))
1919 (when (looking-at "[ \t\n]*[})]")
1920 (goto-char (match-end 0))
1925 (defun bibtex-parse-string (&optional empty-key
)
1926 "Parse a BibTeX string entry beginning at the position of point.
1927 If a syntactically correct entry is found, return a cons pair containing
1928 the boundaries of the reference key and text parts of the entry.
1929 If EMPTY-KEY is non-nil, key may be empty. Do not move point."
1930 (let ((bibtex-string-empty-key empty-key
))
1931 (bibtex-parse-association 'bibtex-parse-string-prefix
1932 'bibtex-parse-string-postfix
)))
1934 (defun bibtex-search-forward-string (&optional empty-key
)
1935 "Search forward to find a BibTeX string entry.
1936 If a syntactically correct entry is found, a pair containing the boundaries of
1937 the reference key and text parts of the string is returned.
1938 If EMPTY-KEY is non-nil, key may be empty. Do not move point."
1941 (let ((case-fold-search t
) bounds
)
1942 (while (and (not bounds
)
1943 (search-forward-regexp bibtex-string-type nil t
))
1944 (save-excursion (goto-char (match-beginning 0))
1945 (setq bounds
(bibtex-parse-string empty-key
))))
1948 (defun bibtex-reference-key-in-string (bounds)
1949 "Return the key part of a BibTeX string defined via BOUNDS."
1950 (buffer-substring-no-properties (nth 1 (car bounds
))
1951 (nth 2 (car bounds
))))
1953 (defun bibtex-text-in-string (bounds &optional content
)
1954 "Get text in BibTeX string field defined via BOUNDS.
1955 If optional arg CONTENT is non-nil extract content
1956 by removing field delimiters and concatenating the resulting string.
1957 If `bibtex-expand-strings' is non-nil, also expand BibTeX strings."
1958 (bibtex-text-in-field-bounds bounds content
))
1960 (defsubst bibtex-start-of-text-in-string
(bounds)
1961 (nth 0 (cdr bounds
)))
1962 (defsubst bibtex-end-of-text-in-string
(bounds)
1963 (nth 1 (cdr bounds
)))
1964 (defsubst bibtex-end-of-string
(bounds)
1965 (nth 2 (cdr bounds
)))
1967 (defsubst bibtex-type-in-head
()
1968 "Extract BibTeX type in head."
1970 (buffer-substring-no-properties (1+ (match-beginning bibtex-type-in-head
))
1971 (match-end bibtex-type-in-head
)))
1973 (defsubst bibtex-key-in-head
(&optional empty
)
1974 "Extract BibTeX key in head. Return optional arg EMPTY if key is empty."
1975 (or (match-string-no-properties bibtex-key-in-head
)
1978 (defun bibtex-parse-preamble ()
1979 "Parse BibTeX preamble.
1980 Point must be at beginning of preamble. Do not move point."
1981 (let ((case-fold-search t
))
1982 (when (looking-at bibtex-preamble-prefix
)
1983 (let ((start (match-beginning 0)) (pref-start (match-beginning 1))
1984 (bounds (save-excursion (goto-char (match-end 0))
1985 (bibtex-parse-string-postfix))))
1986 (if bounds
(cons (list start pref-start
) bounds
))))))
1990 (defsubst bibtex-string
= (str1 str2
)
1991 "Return t if STR1 and STR2 are equal, ignoring case."
1992 (eq t
(compare-strings str1
0 nil str2
0 nil t
)))
1994 (defun bibtex-delete-whitespace ()
1995 "Delete all whitespace starting at point."
1996 (if (looking-at "[ \t\n]+")
1997 (delete-region (point) (match-end 0))))
1999 (defun bibtex-current-line ()
2000 "Compute line number of point regardless whether the buffer is narrowed."
2001 (+ (count-lines 1 (point))
2004 (defun bibtex-valid-entry (&optional empty-key
)
2005 "Parse a valid BibTeX entry (maybe without key if EMPTY-KEY is t).
2006 A valid entry is a syntactical correct one with type contained in
2007 `bibtex-BibTeX-entry-alist'. Ignore @String and @Preamble entries.
2008 Return a cons pair with buffer positions of beginning and end of entry
2009 if a valid entry is found, nil otherwise. Do not move point.
2010 After a call to this function `match-data' corresponds to the header
2011 of the entry, see regexp `bibtex-entry-head'."
2012 (let ((case-fold-search t
) end
)
2013 (if (looking-at (if empty-key bibtex-entry-maybe-empty-head
2017 (goto-char (match-end 0))
2020 (goto-char (match-end bibtex-type-in-head
))
2021 (looking-at "[ \t]*("))
2022 ",?[ \t\n]*)" ; entry opened with `('
2023 ",?[ \t\n]*}")) ; entry opened with `{'
2025 (skip-chars-forward " \t\n")
2026 ;; loop over all BibTeX fields
2027 (while (setq bounds
(bibtex-parse-field))
2028 (goto-char (bibtex-end-of-field bounds
)))
2029 ;; This matches the infix* part.
2030 (if (looking-at entry-closer
) (setq end
(match-end 0)))))
2031 (if end
(cons (match-beginning 0) end
))))))
2033 (defun bibtex-skip-to-valid-entry (&optional backward
)
2034 "Move point to beginning of the next valid BibTeX entry.
2035 Do not move if we are already at beginning of a valid BibTeX entry.
2036 With optional argument BACKWARD non-nil, move backward to
2037 beginning of previous valid one. A valid entry is a syntactical correct one
2038 with type contained in `bibtex-BibTeX-entry-alist' or, if
2039 `bibtex-sort-ignore-string-entries' is nil, a syntactical correct string
2040 entry. Return buffer position of beginning and end of entry if a valid
2041 entry is found, nil otherwise."
2043 (let ((case-fold-search t
)
2046 ;; Loop till we look at a valid entry.
2047 (while (not (or found
(if backward
(bobp) (eobp))))
2048 (cond ((setq found
(or (bibtex-valid-entry)
2049 (and (not bibtex-sort-ignore-string-entries
)
2050 (setq bounds
(bibtex-parse-string))
2051 (cons (bibtex-start-of-field bounds
)
2052 (bibtex-end-of-string bounds
))))))
2053 (backward (re-search-backward "^[ \t]*@" nil
'move
))
2054 (t (if (re-search-forward "\n\\([ \t]*@\\)" nil
'move
)
2055 (goto-char (match-beginning 1))))))
2058 (defun bibtex-map-entries (fun)
2059 "Call FUN for each BibTeX entry in buffer (possibly narrowed).
2060 FUN is called with three arguments, the key of the entry and the buffer
2061 positions of beginning and end of entry. Also, point is at beginning of
2062 entry and `match-data' corresponds to the header of the entry,
2063 see regexp `bibtex-entry-head'. If `bibtex-sort-ignore-string-entries'
2064 is non-nil, FUN is not called for @String entries."
2065 (let ((case-fold-search t
)
2066 (end-marker (make-marker))
2068 ;; Use marker to keep track of the buffer position of the end of
2069 ;; a BibTeX entry as this position may change during reformatting.
2070 (set-marker-insertion-type end-marker t
)
2072 (goto-char (point-min))
2073 (while (setq found
(bibtex-skip-to-valid-entry))
2074 (set-marker end-marker
(cdr found
))
2075 (looking-at bibtex-any-entry-maybe-empty-head
)
2076 (funcall fun
(bibtex-key-in-head "") (car found
) end-marker
)
2077 (goto-char end-marker
)))))
2079 (defun bibtex-progress-message (&optional flag interval
)
2080 "Echo a message about progress of current buffer.
2081 If FLAG is a string, the message is initialized (in this case a
2082 value for INTERVAL may be given as well (if not this is set to 5)).
2083 If FLAG is `done', the message is deinitialized.
2084 If FLAG is nil, a message is echoed if point was incremented at least
2085 `bibtex-progress-interval' percent since last message was echoed."
2086 (cond ((stringp flag
)
2087 (setq bibtex-progress-lastmes flag
2088 bibtex-progress-interval
(or interval
5)
2089 bibtex-progress-lastperc
0))
2091 (message "%s (done)" bibtex-progress-lastmes
)
2092 (setq bibtex-progress-lastmes nil
))
2094 (let* ((size (- (point-max) (point-min)))
2095 (perc (if (= size
0)
2097 (/ (* 100 (- (point) (point-min))) size
))))
2098 (when (>= perc
(+ bibtex-progress-lastperc
2099 bibtex-progress-interval
))
2100 (setq bibtex-progress-lastperc perc
)
2101 (message "%s (%d%%)" bibtex-progress-lastmes perc
))))))
2103 (defun bibtex-field-left-delimiter ()
2104 "Return a string dependent on `bibtex-field-delimiters'."
2105 (if (eq bibtex-field-delimiters
'braces
)
2109 (defun bibtex-field-right-delimiter ()
2110 "Return a string dependent on `bibtex-field-delimiters'."
2111 (if (eq bibtex-field-delimiters
'braces
)
2115 (defun bibtex-entry-left-delimiter ()
2116 "Return a string dependent on `bibtex-entry-delimiters'."
2117 (if (eq bibtex-entry-delimiters
'braces
)
2121 (defun bibtex-entry-right-delimiter ()
2122 "Return a string dependent on `bibtex-entry-delimiters'."
2123 (if (eq bibtex-entry-delimiters
'braces
)
2127 (defun bibtex-flash-head (prompt)
2128 "Flash at BibTeX entry head before point, if it exists."
2129 (let ((case-fold-search t
)
2132 (bibtex-beginning-of-entry)
2133 (when (and (looking-at bibtex-any-entry-maybe-empty-head
)
2135 (goto-char (match-beginning bibtex-type-in-head
))
2136 (if (and (< 0 blink-matching-delay
)
2137 (pos-visible-in-window-p (point)))
2138 (sit-for blink-matching-delay
)
2139 (message "%s%s" prompt
(buffer-substring-no-properties
2140 (point) (match-end bibtex-key-in-head
))))))))
2142 (defun bibtex-make-optional-field (field)
2143 "Make an optional field named FIELD in current BibTeX entry."
2145 (bibtex-make-field (cons (concat "OPT" (car field
)) (cdr field
)))
2146 (bibtex-make-field (concat "OPT" field
))))
2148 (defun bibtex-move-outside-of-entry ()
2149 "Make sure point is outside of a BibTeX entry."
2150 (let ((orig-point (point)))
2151 (bibtex-end-of-entry)
2152 (when (< (point) orig-point
)
2153 ;; We moved backward, so we weren't inside an entry to begin with.
2154 ;; Leave point at the beginning of a line, and preferably
2155 ;; at the beginning of a paragraph.
2156 (goto-char orig-point
)
2157 (beginning-of-line 1)
2158 (unless (= ?
\n (char-before (1- (point))))
2159 (re-search-forward "^[ \t]*[@\n]" nil
'move
)
2161 (skip-chars-forward " \t\n")))
2163 (defun bibtex-beginning-of-first-entry ()
2164 "Go to beginning of line of first BibTeX entry in buffer.
2165 If `bibtex-sort-ignore-string-entries' is non-nil, @String entries
2166 are ignored. Return point"
2167 (goto-char (point-min))
2168 (bibtex-skip-to-valid-entry)
2171 (defun bibtex-enclosing-field (&optional comma noerr
)
2172 "Search for BibTeX field enclosing point.
2173 For `bibtex-mode''s internal algorithms, a field begins at the comma
2174 following the preceding field. Usually, this is not what the user expects.
2175 Thus if COMMA is non-nil, the \"current field\" includes the terminating comma
2176 as well as the entry delimiter if it appears on the same line.
2177 Unless NOERR is non-nil, signal an error if no enclosing field is found.
2178 On success return bounds, nil otherwise. Do not move point."
2182 (skip-chars-backward " \t")
2183 ;; Ignore entry delimiter and comma at end of line.
2184 (if (memq (preceding-char) '(?
} ?\
))) (forward-char -
1))
2185 (if (= (preceding-char) ?
,) (forward-char -
1)))
2187 (let ((bounds (bibtex-search-backward-field bibtex-field-name t
)))
2189 (<= (bibtex-start-of-field bounds
) (point))
2190 (>= (bibtex-end-of-field bounds
) (point)))
2193 (error "Can't find enclosing BibTeX field"))))))
2195 (defun bibtex-beginning-first-field (&optional beg
)
2196 "Move point to beginning of first field.
2197 Optional arg BEG is beginning of entry."
2198 (if beg
(goto-char beg
) (bibtex-beginning-of-entry))
2199 (looking-at bibtex-any-entry-maybe-empty-head
)
2200 (goto-char (match-end 0)))
2202 (defun bibtex-insert-kill (n &optional comma
)
2203 "Reinsert the Nth stretch of killed BibTeX text (field or entry).
2204 Optional arg COMMA is as in `bibtex-enclosing-field'."
2205 (unless bibtex-last-kill-command
(error "BibTeX kill ring is empty"))
2206 (let ((fun (lambda (kryp kr
) ; adapted from `current-kill'
2207 (car (set kryp
(nthcdr (mod (- n
(length (eval kryp
)))
2208 (length kr
)) kr
))))))
2209 ;; We put the mark at the beginning of the inserted field or entry
2210 ;; and point at its end - a behavior similar to what `yank' does.
2211 ;; The mark is then used by `bibtex-yank-pop', which needs to know
2212 ;; what we have inserted.
2213 (if (eq bibtex-last-kill-command
'field
)
2215 ;; insert past the current field
2216 (goto-char (bibtex-end-of-field (bibtex-enclosing-field comma
)))
2218 (bibtex-make-field (funcall fun
'bibtex-field-kill-ring-yank-pointer
2219 bibtex-field-kill-ring
) t nil t
))
2220 ;; insert past the current entry
2221 (bibtex-skip-to-valid-entry)
2223 (insert (funcall fun
'bibtex-entry-kill-ring-yank-pointer
2224 bibtex-entry-kill-ring
))
2225 ;; If we copied an entry from a buffer containing only this one entry,
2226 ;; it can be missing the second "\n".
2227 (unless (looking-back "\n\n") (insert "\n"))
2228 (unless (functionp bibtex-reference-keys
)
2229 ;; update `bibtex-reference-keys'
2231 (goto-char (mark t
))
2232 (looking-at bibtex-any-entry-maybe-empty-head
)
2233 (let ((key (bibtex-key-in-head)))
2234 (if key
(push (cons key t
) bibtex-reference-keys
))))))))
2236 (defsubst bibtex-vec-push
(vec idx newelt
)
2237 "Add NEWELT to the list stored in VEC at index IDX."
2238 (aset vec idx
(cons newelt
(aref vec idx
))))
2240 (defsubst bibtex-vec-incr
(vec idx
)
2241 "Increment by 1 the counter which is stored in VEC at index IDX."
2242 (aset vec idx
(1+ (aref vec idx
))))
2244 (defun bibtex-format-entry ()
2245 "Helper function for `bibtex-clean-entry'.
2246 Formats current entry according to variable `bibtex-entry-format'."
2247 ;; initialize `bibtex-field-braces-opt' if necessary
2248 (if (and bibtex-field-braces-alist
(not bibtex-field-braces-opt
))
2249 (setq bibtex-field-braces-opt
2250 (bibtex-field-re-init bibtex-field-braces-alist
'braces
)))
2251 ;; initialize `bibtex-field-strings-opt' if necessary
2252 (if (and bibtex-field-strings-alist
(not bibtex-field-strings-opt
))
2253 (setq bibtex-field-strings-opt
2254 (bibtex-field-re-init bibtex-field-strings-alist
'strings
)))
2256 (let ((case-fold-search t
)
2257 (format (if (eq bibtex-entry-format t
)
2258 '(realign opts-or-alts required-fields numerical-fields
2259 page-dashes whitespace inherit-booktitle
2260 last-comma delimiters unify-case braces
2261 strings sort-fields
)
2262 bibtex-entry-format
))
2263 (left-delim-re (regexp-quote (bibtex-field-left-delimiter)))
2264 bounds crossref-key req-field-list default-field-list field-list
2265 num-alt alt-fields idx error-field-name
)
2267 ;; formatting (undone if error occurs)
2268 (atomic-change-group
2271 (bibtex-narrow-to-entry)
2273 ;; There are more elegant high-level functions for several tasks
2274 ;; done by `bibtex-format-entry'. However, they contain some
2275 ;; redundancy compared with what we need to do anyway.
2276 ;; So for speed-up we avoid using them.
2277 ;; (`bibtex-format-entry' is called often by `bibtex-reformat'.)
2279 ;; identify entry type
2280 (goto-char (point-min))
2281 (or (re-search-forward bibtex-entry-type nil t
)
2282 (error "Not inside a BibTeX entry"))
2283 (let* ((beg-type (1+ (match-beginning 0)))
2284 (end-type (match-end 0))
2285 (entry-list (assoc-string (buffer-substring-no-properties
2287 bibtex-entry-alist t
)))
2289 ;; unify case of entry type
2290 (when (memq 'unify-case format
)
2291 (delete-region beg-type end-type
)
2292 (insert (car entry-list
)))
2294 ;; update left entry delimiter
2295 (when (memq 'delimiters format
)
2296 (goto-char end-type
)
2297 (skip-chars-forward " \t\n")
2299 (insert (bibtex-entry-left-delimiter)))
2301 ;; Do we have a crossref key?
2302 (goto-char (point-min))
2303 (if (setq bounds
(bibtex-search-forward-field
2304 "\\(OPT\\)?crossref"))
2305 (let ((text (bibtex-text-in-field-bounds bounds t
)))
2306 (unless (equal "" text
)
2307 (setq crossref-key text
))))
2309 ;; list of required fields appropriate for an entry with
2310 ;; or without crossref key.
2311 (setq req-field-list
(if crossref-key
(nth 2 entry-list
)
2312 (append (nth 2 entry-list
) (nth 3 entry-list
)))
2313 ;; default list of fields that may appear in this entry
2314 default-field-list
(append (nth 2 entry-list
) (nth 3 entry-list
)
2316 bibtex-user-optional-fields
)
2317 ;; number of ALT fields we expect to find
2318 num-alt
(length (delq nil
(delete-dups
2319 (mapcar (lambda (x) (nth 3 x
))
2321 ;; ALT fields of respective groups
2322 alt-fields
(make-vector num-alt nil
))
2324 (when (memq 'sort-fields format
)
2325 (goto-char (point-min))
2326 (let ((beg-fields (save-excursion (bibtex-beginning-first-field)))
2327 (fields-alist (bibtex-parse-entry))
2328 bibtex-help-message elt
)
2329 (delete-region beg-fields
(point))
2330 (dolist (field default-field-list
)
2331 (when (setq elt
(assoc-string (car field
) fields-alist t
))
2332 (setq fields-alist
(delete elt fields-alist
))
2333 (bibtex-make-field (list (car elt
) nil
(cdr elt
)) nil nil t
)))
2334 (dolist (field fields-alist
)
2335 (unless (member (car field
) '("=key=" "=type="))
2336 (bibtex-make-field (list (car field
) nil
(cdr field
)) nil nil t
))))))
2338 ;; process all fields
2339 (bibtex-beginning-first-field (point-min))
2340 (while (setq bounds
(bibtex-parse-field))
2341 (let* ((beg-field (copy-marker (bibtex-start-of-field bounds
)))
2342 (end-field (copy-marker (bibtex-end-of-field bounds
) t
))
2343 (beg-name (copy-marker (bibtex-start-of-name-in-field bounds
)))
2344 (end-name (copy-marker (bibtex-end-of-name-in-field bounds
)))
2345 (beg-text (copy-marker (bibtex-start-of-text-in-field bounds
)))
2346 (end-text (copy-marker (bibtex-end-of-text-in-field bounds
) t
))
2347 (empty-field (equal "" (bibtex-text-in-field-bounds bounds t
)))
2348 (field-name (buffer-substring-no-properties beg-name end-name
))
2349 (opt-alt (and (string-match "\\`\\(OPT\\|ALT\\)" field-name
)
2350 (not (and bibtex-no-opt-remove-re
2351 (string-match bibtex-no-opt-remove-re
2354 (if opt-alt
(setq field-name
(substring field-name
3)))
2356 ;; keep track of alternatives
2357 (if (setq idx
(nth 3 (assoc-string field-name req-field-list t
)))
2358 (bibtex-vec-push alt-fields idx field-name
))
2360 (if (memq 'opts-or-alts format
)
2361 ;; delete empty optional and alternative fields
2362 ;; (but keep empty required fields)
2363 (cond ((and empty-field
2365 (let ((field (assoc-string
2366 field-name req-field-list t
)))
2367 (or (not field
) ; OPT field
2368 (nth 3 field
))))) ; ALT field
2369 (delete-region beg-field end-field
)
2371 ;; otherwise nonempty field: delete "OPT" or "ALT"
2373 (goto-char beg-name
)
2377 (push field-name field-list
)
2379 ;; Remove whitespace at beginning and end of field.
2380 ;; We do not look at individual parts of the field
2381 ;; as {foo } # bar # { baz} is a fine field.
2382 (when (memq 'whitespace format
)
2383 (goto-char beg-text
)
2384 (if (looking-at "\\([{\"]\\)[ \t\n]+")
2385 (replace-match "\\1"))
2386 (goto-char end-text
)
2387 (if (looking-back "[ \t\n]+\\([}\"]\\)" beg-text t
)
2388 (replace-match "\\1")))
2390 ;; remove delimiters from purely numerical fields
2391 (when (and (memq 'numerical-fields format
)
2392 (progn (goto-char beg-text
)
2393 (looking-at "\"[0-9]+\"\\|{[0-9]+}")))
2394 (goto-char end-text
)
2396 (goto-char beg-text
)
2399 ;; update delimiters
2400 (when (memq 'delimiters format
)
2401 (goto-char beg-text
)
2402 ;; simplified from `bibtex-parse-field-text', as we
2403 ;; already checked that the field format is correct
2404 (while (< (point) end-text
)
2405 (if (looking-at bibtex-field-const
)
2406 (goto-char (match-end 0))
2407 (let ((boundaries (bibtex-parse-field-string)))
2408 (if (looking-at left-delim-re
)
2409 (goto-char (cdr boundaries
))
2411 (insert (bibtex-field-left-delimiter))
2412 (goto-char (1- (cdr boundaries
)))
2414 (insert (bibtex-field-right-delimiter)))))
2415 (if (looking-at "[ \t\n]*#[ \t\n]*")
2416 (goto-char (match-end 0)))))
2418 ;; update page dashes
2419 (if (and (memq 'page-dashes format
)
2420 (bibtex-string= field-name
"pages")
2421 (progn (goto-char beg-text
)
2423 "\\([\"{][0-9]+\\)[ \t\n]*--?[ \t\n]*\\([0-9]+[\"}]\\)")))
2424 (replace-match "\\1-\\2"))
2426 ;; enclose field text by braces according to
2427 ;; `bibtex-field-braces-alist'.
2428 (let (case-fold-search temp
) ; Case-sensitive search
2429 (when (and (memq 'braces format
)
2430 (setq temp
(cdr (assoc-string field-name
2431 bibtex-field-braces-opt t
))))
2432 (goto-char beg-text
)
2433 (while (re-search-forward temp end-text t
)
2434 (let ((beg (match-beginning 0))
2435 (bounds (bibtex-find-text-internal nil t
)))
2436 (unless (or (nth 4 bounds
) ; string constant
2437 ;; match already surrounded by braces
2438 ;; (braces are inside field delimiters)
2439 (and (< (point) (1- (nth 2 bounds
)))
2440 (< (1+ (nth 1 bounds
)) beg
)
2442 (save-excursion (goto-char (1- beg
))
2448 ;; replace field text by BibTeX string constants
2449 ;; according to `bibtex-field-strings-alist'.
2450 (when (and (memq 'strings format
)
2451 (setq temp
(cdr (assoc-string field-name
2452 bibtex-field-strings-opt t
))))
2453 (goto-char beg-text
)
2455 (while (re-search-forward (car re
) end-text t
)
2456 (let ((bounds (save-match-data
2457 (bibtex-find-text-internal nil t
))))
2458 (unless (nth 4 bounds
)
2459 ;; if match not at right subfield boundary...
2460 (if (< (match-end 0) (1- (nth 2 bounds
)))
2461 (insert " # " (bibtex-field-left-delimiter))
2463 (replace-match (cdr re
))
2464 (goto-char (match-beginning 0))
2465 ;; if match not at left subfield boundary...
2466 (if (< (1+ (nth 1 bounds
)) (match-beginning 0))
2467 (insert (bibtex-field-right-delimiter) " # ")
2468 (delete-char -
1))))))))
2470 ;; use book title of crossref'd entry
2471 (if (and (memq 'inherit-booktitle format
)
2473 (bibtex-string= field-name
"booktitle")
2475 (let ((title (save-excursion
2478 (if (bibtex-search-entry crossref-key t
)
2479 (bibtex-text-in-field "title"))))))
2481 (setq empty-field nil
)
2482 (goto-char (1+ beg-text
))
2485 ;; if empty field is a required field, complain
2486 (when (and empty-field
2487 (memq 'required-fields format
)
2488 (assoc-string field-name req-field-list t
))
2489 (setq error-field-name field-name
)
2490 (error "Mandatory field `%s' is empty" field-name
))
2492 ;; unify case of field name
2493 (if (memq 'unify-case format
)
2494 (let ((fname (car (assoc-string field-name
2495 default-field-list t
))))
2498 (delete-region beg-name end-name
)
2499 (goto-char beg-name
)
2501 ;; there are no rules we could follow
2502 (downcase-region beg-name end-name
))))
2505 (goto-char end-field
))))
2507 ;; check whether all required fields are present
2508 (if (memq 'required-fields format
)
2509 (let ((alt-expect (make-vector num-alt nil
))
2510 (alt-found (make-vector num-alt
0)))
2511 (dolist (fname req-field-list
)
2512 (cond ((setq idx
(nth 3 fname
))
2513 ;; t if field has alternative flag
2514 (bibtex-vec-push alt-expect idx
(car fname
))
2515 (if (member-ignore-case (car fname
) field-list
)
2516 (bibtex-vec-incr alt-found idx
)))
2517 ((not (member-ignore-case (car fname
) field-list
))
2518 ;; If we use the crossref field, a required field
2519 ;; can have the OPT prefix. So if it was empty,
2520 ;; we have deleted by now. Nonetheless we can
2521 ;; move point on this empty field.
2522 (setq error-field-name
(car fname
))
2523 (error "Mandatory field `%s' is missing" (car fname
)))))
2524 (dotimes (idx num-alt
)
2525 (cond ((= 0 (aref alt-found idx
))
2526 (setq error-field-name
(car (last (aref alt-fields idx
))))
2527 (error "Alternative mandatory field `%s' is missing"
2528 (aref alt-expect idx
)))
2529 ((< 1 (aref alt-found idx
))
2530 (setq error-field-name
(car (last (aref alt-fields idx
))))
2531 (error "Alternative fields `%s' are defined %s times"
2532 (aref alt-expect idx
)
2533 (length (aref alt-fields idx
))))))))
2535 ;; update comma after last field
2536 (if (memq 'last-comma format
)
2537 (cond ((and bibtex-comma-after-last-field
2538 (not (looking-at ",")))
2540 ((and (not bibtex-comma-after-last-field
)
2544 ;; update right entry delimiter
2545 (if (looking-at ",")
2547 (when (memq 'delimiters format
)
2548 (skip-chars-forward " \t\n")
2550 (insert (bibtex-entry-right-delimiter)))
2552 ;; realign and fill entry
2553 (if (memq 'realign format
)
2554 (bibtex-fill-entry)))))
2556 ;; Unwindform: move point to location where error occurred if possible
2557 (if error-field-name
2559 (when (save-excursion
2560 (bibtex-beginning-of-entry)
2562 (bibtex-search-forward-field
2563 ;; If we use the crossref field, a required field
2564 ;; can have the OPT prefix
2565 (concat "\\(OPT\\|ALT\\)?" error-field-name
) t
)))
2566 (goto-char (bibtex-start-of-text-in-field bounds
))
2567 (bibtex-find-text)))))))
2569 (defun bibtex-field-re-init (regexp-alist type
)
2570 "Calculate optimized value for bibtex-regexp-TYPE-opt.
2571 This value is based on bibtex-regexp-TYPE-alist. TYPE is 'braces or 'strings.
2572 Return optimized value to be used by `bibtex-format-entry'."
2576 (replace-regexp-in-string " +" "[ \t\n]+" (nth 1 e
))
2577 (nth 2 e
))) ; nil for 'braces'.
2580 ;; Loop over field names
2581 (dolist (field (delete-dups (apply 'append
(mapcar 'car regexp-alist
))))
2583 ;; Collect all matches we have for this field name
2584 (dolist (e regexp-alist
)
2585 (if (assoc-string field
(car e
) t
)
2586 (push (cons (nth 1 e
) (nth 2 e
)) rules
)))
2587 (if (eq type
'braces
)
2588 ;; concatenate all regexps to a single regexp
2589 (setq rules
(concat "\\(?:" (mapconcat 'car rules
"\\|") "\\)")))
2590 ;; create list of replacement rules.
2591 (push (cons field rules
) opt-list
)))
2595 (defun bibtex-autokey-abbrev (string len
)
2596 "Return an abbreviation of STRING with at least LEN characters.
2597 If LEN is positive the abbreviation is terminated only after a consonant
2598 or at the word end. If LEN is negative the abbreviation is strictly
2599 enforced using abs (LEN) characters. If LEN is not a number, STRING
2600 is returned unchanged."
2601 (cond ((or (not (numberp len
))
2602 (<= (length string
) (abs len
)))
2607 (substring string
0 (abs len
)))
2608 (t (let* ((case-fold-search t
)
2609 (abort-char (string-match "[^aeiou]" string
(1- len
))))
2611 (substring string
0 (1+ abort-char
))
2614 (defun bibtex-autokey-get-field (field &optional change-list
)
2615 "Get content of BibTeX field FIELD. Return empty string if not found.
2616 Optional arg CHANGE-LIST is a list of substitution patterns that is
2617 applied to the content of FIELD. It is an alist with pairs
2618 \(OLD-REGEXP . NEW-STRING\)."
2619 (let* ((bibtex-expand-strings bibtex-autokey-expand-strings
)
2620 (content (bibtex-text-in-field field bibtex-autokey-use-crossref
))
2622 (unless content
(setq content
""))
2623 (dolist (pattern change-list
)
2624 (setq content
(replace-regexp-in-string (car pattern
)
2629 (defun bibtex-autokey-get-names ()
2630 "Get contents of the name field of the current entry.
2631 Do some modifications based on `bibtex-autokey-name-change-strings'.
2632 Return the names as a concatenated string obeying `bibtex-autokey-names'
2633 and `bibtex-autokey-names-stretch'."
2634 (let ((names (bibtex-autokey-get-field "author\\|editor"
2635 bibtex-autokey-name-change-strings
)))
2636 ;; Some entries do not have a name field.
2637 (if (string= "" names
)
2639 (let* ((case-fold-search t
)
2640 (name-list (mapcar 'bibtex-autokey-demangle-name
2641 (split-string names
"[ \t\n]+and[ \t\n]+")))
2643 (unless (or (not (numberp bibtex-autokey-names
))
2644 (<= (length name-list
)
2645 (+ bibtex-autokey-names
2646 bibtex-autokey-names-stretch
)))
2647 ;; Take `bibtex-autokey-names' elements from beginning of name-list
2648 (setq name-list
(nreverse (nthcdr (- (length name-list
)
2649 bibtex-autokey-names
)
2650 (nreverse name-list
)))
2651 additional-names bibtex-autokey-additional-names
))
2652 (concat (mapconcat 'identity name-list
2653 bibtex-autokey-name-separator
)
2654 additional-names
)))))
2656 (defun bibtex-autokey-demangle-name (fullname)
2657 "Get the last part from a well-formed FULLNAME and perform abbreviations."
2658 (let* (case-fold-search
2659 (name (cond ((string-match "\\([[:upper:]][^, ]*\\)[^,]*," fullname
)
2660 ;; Name is of the form "von Last, First" or
2661 ;; "von Last, Jr, First"
2662 ;; --> Take the first capital part before the comma
2663 (match-string 1 fullname
))
2664 ((string-match "\\([^, ]*\\)," fullname
)
2665 ;; Strange name: we have a comma, but nothing capital
2666 ;; So we accept even lowercase names
2667 (match-string 1 fullname
))
2668 ((string-match "\\(\\<[[:lower:]][^ ]* +\\)+\\([[:upper:]][^ ]*\\)"
2670 ;; name is of the form "First von Last", "von Last",
2671 ;; "First von von Last", or "d'Last"
2672 ;; --> take the first capital part after the "von" parts
2673 (match-string 2 fullname
))
2674 ((string-match "\\([^ ]+\\) *\\'" fullname
)
2675 ;; name is of the form "First Middle Last" or "Last"
2676 ;; --> take the last token
2677 (match-string 1 fullname
))
2678 (t (error "Name `%s' is incorrectly formed" fullname
)))))
2679 (funcall bibtex-autokey-name-case-convert-function
2680 (bibtex-autokey-abbrev name bibtex-autokey-name-length
))))
2682 (defun bibtex-autokey-get-year ()
2683 "Return year field contents as a string obeying `bibtex-autokey-year-length'."
2684 (let ((yearfield (bibtex-autokey-get-field "year")))
2685 (substring yearfield
(max 0 (- (length yearfield
)
2686 bibtex-autokey-year-length
)))))
2688 (defun bibtex-autokey-get-title ()
2689 "Get title field contents up to a terminator.
2690 Return the result as a string"
2691 (let ((case-fold-search t
)
2693 (bibtex-autokey-get-field "title"
2694 bibtex-autokey-titleword-change-strings
)))
2695 ;; ignore everything past a terminator
2696 (if (string-match bibtex-autokey-title-terminators titlestring
)
2697 (setq titlestring
(substring titlestring
0 (match-beginning 0))))
2698 ;; gather words from titlestring into a list. Ignore
2699 ;; specific words and use only a specific amount of words.
2701 (ignore-re (concat "\\`\\(?:"
2702 (mapconcat 'identity
2703 bibtex-autokey-titleword-ignore
"\\|")
2705 titlewords titlewords-extra word
)
2706 (while (and (or (not (numberp bibtex-autokey-titlewords
))
2707 (< counter
(+ bibtex-autokey-titlewords
2708 bibtex-autokey-titlewords-stretch
)))
2709 (string-match "\\b\\w+" titlestring
))
2710 (setq word
(match-string 0 titlestring
)
2711 titlestring
(substring titlestring
(match-end 0)))
2712 ;; Ignore words matched by one of the elements of
2713 ;; `bibtex-autokey-titleword-ignore'. Case is significant.
2714 (unless (let (case-fold-search)
2715 (string-match ignore-re word
))
2716 (setq counter
(1+ counter
))
2717 (if (or (not (numberp bibtex-autokey-titlewords
))
2718 (<= counter bibtex-autokey-titlewords
))
2719 (push word titlewords
)
2720 (push word titlewords-extra
))))
2721 ;; Obey `bibtex-autokey-titlewords-stretch':
2722 ;; If by now we have processed all words in titlestring, we include
2723 ;; titlewords-extra in titlewords. Otherwise, we ignore titlewords-extra.
2724 (unless (string-match "\\b\\w+" titlestring
)
2725 (setq titlewords
(append titlewords-extra titlewords
)))
2726 (mapconcat 'bibtex-autokey-demangle-title
(nreverse titlewords
)
2727 bibtex-autokey-titleword-separator
))))
2729 (defun bibtex-autokey-demangle-title (titleword)
2730 "Do some abbreviations on TITLEWORD.
2731 The rules are defined in `bibtex-autokey-titleword-abbrevs'
2732 and `bibtex-autokey-titleword-length'."
2733 (let ((case-fold-search t
)
2734 (alist bibtex-autokey-titleword-abbrevs
))
2736 (not (string-match (concat "\\`\\(?:" (caar alist
) "\\)\\'")
2738 (setq alist
(cdr alist
)))
2741 (funcall bibtex-autokey-titleword-case-convert-function
2742 (bibtex-autokey-abbrev titleword bibtex-autokey-titleword-length
)))))
2744 (defun bibtex-generate-autokey ()
2745 "Generate automatically a key for a BibTeX entry.
2746 Use the author/editor, the year and the title field.
2747 The algorithm works as follows.
2750 1. Use the author or editor field to generate the name part of the key.
2751 Expand BibTeX strings if `bibtex-autokey-expand-strings' is non-nil.
2752 2. Change the content of the name field according to
2753 `bibtex-autokey-name-change-strings' (see there for further detail).
2754 3. Use the first `bibtex-autokey-names' names in the name field. If there
2755 are up to `bibtex-autokey-names' + `bibtex-autokey-names-stretch' names,
2757 4. Use only the last names to form the name part. From these last names,
2758 take at least `bibtex-autokey-name-length' characters (truncate only
2759 after a consonant or at a word end).
2760 5. Convert all last names using the function
2761 `bibtex-autokey-name-case-convert-function'.
2762 6. Build the name part of the key by concatenating all abbreviated last
2763 names with the string `bibtex-autokey-name-separator' between any two.
2764 If there are more names in the name field than names used in the name
2765 part, append the string `bibtex-autokey-additional-names'.
2768 1. Build the year part of the key by truncating the content of the year
2769 field to the rightmost `bibtex-autokey-year-length' digits (useful
2770 values are 2 and 4).
2771 2. If the year field (or any other field required to generate the key)
2772 is absent, but the entry has a valid crossref field and
2773 `bibtex-autokey-use-crossref' is non-nil, use the field of the
2774 crossreferenced entry instead.
2777 1. Change the content of the title field according to
2778 `bibtex-autokey-titleword-change-strings' (see there for further detail).
2779 2. Truncate the title before the first match of
2780 `bibtex-autokey-title-terminators' and delete those words which appear
2781 in `bibtex-autokey-titleword-ignore'. Build the title part using the
2782 first `bibtex-autokey-titlewords' words from this truncated title.
2783 If the truncated title ends after up to `bibtex-autokey-titlewords' +
2784 `bibtex-autokey-titlewords-stretch' words, use all words from the
2786 3. For every title word that appears in `bibtex-autokey-titleword-abbrevs'
2787 use the corresponding abbreviation (see documentation of this variable
2788 for further detail).
2789 4. From every title word not generated by an abbreviation, take at least
2790 `bibtex-autokey-titleword-length' characters (truncate only after
2791 a consonant or at a word end).
2792 5. Convert all title words using the function
2793 `bibtex-autokey-titleword-case-convert-function'.
2794 6. Build the title part by concatenating all abbreviated title words with
2795 the string `bibtex-autokey-titleword-separator' between any two.
2797 Concatenate the key:
2798 1. Concatenate `bibtex-autokey-prefix-string', the name part, the year
2799 part and the title part. If the name part and the year part are both
2800 non-empty insert `bibtex-autokey-name-year-separator' between the two.
2801 If the title part and the year (or name) part are non-empty, insert
2802 `bibtex-autokey-year-title-separator' between the two.
2803 2. If `bibtex-autokey-before-presentation-function' is non-nil, it must be
2804 a function taking one argument. Call this function with the generated
2805 key as the argument. Use the return value of this function (a string)
2807 3. If `bibtex-autokey-edit-before-use' is non-nil, present the key in the
2808 minibuffer to the user for editing. Insert the key given by the user."
2809 (let* ((names (bibtex-autokey-get-names))
2810 (year (bibtex-autokey-get-year))
2811 (title (bibtex-autokey-get-title))
2812 (autokey (concat bibtex-autokey-prefix-string
2814 (unless (or (equal names
"")
2816 bibtex-autokey-name-year-separator
)
2818 (unless (or (and (equal names
"")
2821 bibtex-autokey-year-title-separator
)
2823 (if bibtex-autokey-before-presentation-function
2824 (funcall bibtex-autokey-before-presentation-function autokey
)
2828 (defun bibtex-global-key-alist ()
2829 "Return global key alist based on `bibtex-files'."
2832 (mapcar (lambda (buf)
2833 (with-current-buffer buf bibtex-reference-keys
))
2834 ;; include current buffer only if it uses `bibtex-mode'
2835 (bibtex-initialize (eq major-mode
'bibtex-mode
))))
2836 (if (eq major-mode
'bibtex-mode
)
2837 bibtex-reference-keys
)))
2839 (defun bibtex-read-key (prompt &optional key global
)
2840 "Read BibTeX key from minibuffer using PROMPT and default KEY.
2841 If optional arg GLOBAL is non-nil, completion is based on the keys in
2842 `bibtex-reference-keys' of `bibtex-files',"
2843 (let (completion-ignore-case)
2844 (completing-read prompt
(if global
(bibtex-global-key-alist)
2845 bibtex-reference-keys
)
2846 nil nil key
'bibtex-key-history
)))
2848 (defun bibtex-read-string-key (&optional key
)
2849 "Read BibTeX string key from minibuffer using default KEY."
2850 (let ((completion-ignore-case t
))
2851 (completing-read "String key: " bibtex-strings
2852 nil nil key
'bibtex-key-history
)))
2854 (defun bibtex-parse-keys (&optional abortable verbose
)
2855 "Set `bibtex-reference-keys' to the keys used in the whole buffer.
2856 Find both entry keys and crossref entries. If ABORTABLE is non-nil abort
2857 on user input. If VERBOSE is non-nil give messages about progress.
2858 Return alist of keys if parsing was completed, `aborted' otherwise.
2859 If `bibtex-parse-keys-fast' is non-nil, use fast but simplified algorithm
2860 for parsing BibTeX keys. If parsing fails, try to set this variable to nil."
2861 (if (eq major-mode
'bibtex-mode
)
2862 (let (ref-keys crossref-keys
)
2866 (bibtex-progress-message
2867 (concat (buffer-name) ": parsing reference keys")))
2869 (goto-char (point-min))
2870 (if bibtex-parse-keys-fast
2871 (let ((case-fold-search t
)
2872 (re (concat bibtex-entry-head
"\\|"
2873 ",[ \t\n]*crossref[ \t\n]*=[ \t\n]*"
2874 "\\(\"[^\"]*\"\\|{[^}]*}\\)[ \t\n]*[,})]")))
2875 (while (re-search-forward re nil t
)
2876 (if (and abortable
(input-pending-p))
2877 ;; user has aborted by typing a key: return `aborted'
2878 (throw 'userkey
'aborted
))
2879 (cond ((match-end 3)
2880 ;; This is a crossref.
2881 (let ((key (buffer-substring-no-properties
2882 (1+ (match-beginning 3)) (1- (match-end 3)))))
2883 (unless (assoc key crossref-keys
)
2884 (push (list key
) crossref-keys
))))
2885 ;; only keys of known entries
2886 ((assoc-string (bibtex-type-in-head)
2887 bibtex-entry-alist t
)
2888 ;; This is an entry.
2889 (let ((key (bibtex-key-in-head)))
2890 (unless (assoc key ref-keys
)
2891 (push (cons key t
) ref-keys
)))))))
2893 (let (;; ignore @String entries because they are handled
2894 ;; separately by `bibtex-parse-strings'
2895 (bibtex-sort-ignore-string-entries t
)
2898 (lambda (key _beg end
)
2901 ;; user has aborted by typing a key: return `aborted'
2902 (throw 'userkey
'aborted
))
2903 (if verbose
(bibtex-progress-message))
2904 (unless (assoc key ref-keys
)
2905 (push (cons key t
) ref-keys
))
2906 (if (and (setq bounds
(bibtex-search-forward-field "crossref" end
))
2907 (setq key
(bibtex-text-in-field-bounds bounds t
))
2908 (not (assoc key crossref-keys
)))
2909 (push (list key
) crossref-keys
))))))
2911 (dolist (key crossref-keys
)
2912 (unless (assoc (car key
) ref-keys
) (push key ref-keys
)))
2914 (bibtex-progress-message 'done
))
2915 ;; successful operation --> return `bibtex-reference-keys'
2916 (setq bibtex-reference-keys ref-keys
)))))))
2918 (defun bibtex-parse-strings (&optional add abortable
)
2919 "Set `bibtex-strings' to the string definitions in the whole buffer.
2920 If ADD is non-nil add the new strings to `bibtex-strings' instead of
2921 simply resetting it. If ADD is an alist of strings, also add ADD to
2922 `bibtex-strings'. If ABORTABLE is non-nil abort on user input.
2923 Return alist of strings if parsing was completed, `aborted' otherwise."
2926 (goto-char (point-min))
2927 (let ((strings (if (and add
(not (functionp bibtex-strings
)))
2931 (dolist (string add
)
2932 (unless (assoc-string (car string
) strings t
)
2933 (push string strings
))))
2935 (while (setq bounds
(bibtex-search-forward-string))
2938 ;; user has aborted by typing a key --> return `aborted'
2939 (throw 'userkey
'aborted
))
2940 (setq key
(bibtex-reference-key-in-string bounds
))
2941 (unless (assoc-string key strings t
)
2942 (push (cons key
(bibtex-text-in-string bounds t
))
2944 (goto-char (bibtex-end-of-text-in-string bounds
)))
2945 ;; successful operation --> return `bibtex-strings'
2946 (setq bibtex-strings strings
))))))
2948 (defun bibtex-strings ()
2949 "Return `bibtex-strings'. Initialize this variable if necessary."
2950 (if (functionp bibtex-strings
)
2951 (bibtex-parse-strings (bibtex-string-files-init))
2954 (defun bibtex-string-files-init ()
2955 "Return initialization for `bibtex-strings'.
2956 Use `bibtex-predefined-strings' and BibTeX files `bibtex-string-files'."
2958 (let ((dirlist (split-string (or bibtex-string-file-path default-directory
)
2961 string-files fullfilename compl bounds found
)
2962 ;; collect absolute file names of valid string files
2963 (dolist (filename bibtex-string-files
)
2964 (unless (string-match "\\.bib\\'" filename
)
2965 (setq filename
(concat filename
".bib")))
2967 (if (file-name-absolute-p filename
)
2968 (if (file-readable-p filename
)
2969 (push filename string-files
)
2970 (error "BibTeX strings file %s not found" filename
))
2971 (dolist (dir dirlist
)
2972 (when (file-readable-p
2973 (setq fullfilename
(expand-file-name filename dir
)))
2974 (push fullfilename string-files
)
2977 (error "File %s not in paths defined via bibtex-string-file-path"
2979 ;; parse string files
2980 (dolist (filename string-files
)
2982 (insert-file-contents filename
)
2983 (goto-char (point-min))
2984 (while (setq bounds
(bibtex-search-forward-string))
2985 (push (cons (bibtex-reference-key-in-string bounds
)
2986 (bibtex-text-in-string bounds t
))
2988 (goto-char (bibtex-end-of-string bounds
)))))
2989 (append bibtex-predefined-strings
(nreverse compl
)))))
2991 (defun bibtex-parse-buffers-stealthily ()
2992 "Parse buffer in the background during idle time.
2993 Called by `run-with-idle-timer'. Whenever Emacs has been idle
2994 for `bibtex-parse-keys-timeout' seconds, parse all BibTeX buffers
2995 which have been modified after last parsing.
2996 Parsing initializes `bibtex-reference-keys' and `bibtex-strings'."
2998 (let ((buffers (buffer-list))
2999 (strings-init (bibtex-string-files-init)))
3000 (while (and buffers
(not (input-pending-p)))
3001 (set-buffer (car buffers
))
3002 (if (and (eq major-mode
'bibtex-mode
)
3003 (not (eq (buffer-modified-tick)
3004 bibtex-buffer-last-parsed-tick
)))
3007 ;; Output no progress messages in `bibtex-parse-keys'
3008 ;; because when in `y-or-n-p' that can hide the question.
3009 (if (and (listp (bibtex-parse-keys t
))
3010 ;; update `bibtex-strings'
3011 (listp (bibtex-parse-strings strings-init t
)))
3013 ;; remember that parsing was successful
3014 (setq bibtex-buffer-last-parsed-tick
(buffer-modified-tick)))))
3015 (setq buffers
(cdr buffers
))))))
3018 (defun bibtex-initialize (&optional current force select
)
3019 "(Re)Initialize BibTeX buffers.
3020 Visit the BibTeX files defined by `bibtex-files' and return a list
3021 of corresponding buffers.
3022 Initialize in these buffers `bibtex-reference-keys' if not yet set.
3023 List of BibTeX buffers includes current buffer if CURRENT is non-nil
3024 and the current buffer visits a file using `bibtex-mode'.
3025 If FORCE is non-nil, (re)initialize `bibtex-reference-keys' even if
3026 already set. If SELECT is non-nil interactively select a BibTeX buffer.
3028 When called interactively, FORCE is t, CURRENT is t if current buffer
3029 visits a file using `bibtex-mode', and SELECT is t if current buffer
3030 does not use `bibtex-mode',"
3031 (interactive (list (eq major-mode
'bibtex-mode
) t
3032 (not (eq major-mode
'bibtex-mode
))))
3033 (let ((file-path (split-string (or bibtex-file-path default-directory
) ":+"))
3034 file-list dir-list buffer-list
)
3035 ;; generate list of BibTeX files
3036 (dolist (file bibtex-files
)
3037 (cond ((eq file
'bibtex-file-path
)
3038 (setq dir-list
(append dir-list file-path
)))
3039 ((file-accessible-directory-p file
)
3040 (push file dir-list
))
3041 ((progn (unless (string-match "\\.bib\\'" file
)
3042 (setq file
(concat file
".bib")))
3043 (file-name-absolute-p file
))
3044 (push file file-list
))
3046 (let (expanded-file-name found
)
3047 (dolist (dir file-path
)
3048 (when (file-readable-p
3049 (setq expanded-file-name
(expand-file-name file dir
)))
3050 (push expanded-file-name file-list
)
3053 (error "File `%s' not in paths defined via bibtex-file-path"
3055 (dolist (file file-list
)
3056 (unless (file-readable-p file
)
3057 (error "BibTeX file `%s' not found" file
)))
3059 (dolist (dir dir-list
)
3061 (append file-list
(directory-files dir t
"\\.bib\\'" t
))))
3062 (delete-dups file-list
)
3063 ;; visit files in FILE-LIST
3064 (dolist (file file-list
)
3065 (if (file-readable-p file
)
3066 (push (find-file-noselect file
) buffer-list
)))
3067 ;; Include current buffer iff we want it.
3068 ;; Exclude current buffer if it does not visit a file using `bibtex-mode'.
3069 ;; This way we exclude BibTeX buffers such as `bibtex-search-buffer'
3070 ;; that are not visiting a BibTeX file. Also, calling `bibtex-initialize'
3071 ;; gives meaningful results for any current buffer.
3072 (unless (and current
(eq major-mode
'bibtex-mode
) buffer-file-name
)
3074 (cond ((and current
(not (memq (current-buffer) buffer-list
)))
3075 (push (current-buffer) buffer-list
))
3076 ((and (not current
) (memq (current-buffer) buffer-list
))
3077 (setq buffer-list
(delq (current-buffer) buffer-list
))))
3080 (dolist (buffer buffer-list
)
3081 (with-current-buffer buffer
3082 (if (or force
(functionp bibtex-reference-keys
))
3083 (bibtex-parse-keys))
3084 (when (or force
(functionp bibtex-strings
))
3085 (unless string-init
(setq string-init
(bibtex-string-files-init)))
3086 (bibtex-parse-strings string-init
)))))
3087 ;; select BibTeX buffer
3091 (completing-read "Switch to BibTeX buffer: "
3092 (mapcar 'buffer-name buffer-list
)
3094 (if current
(buffer-name (current-buffer)))))
3095 (message "No BibTeX buffers defined")))
3098 (defun bibtex-complete-string-cleanup (compl) (lambda (str status
) ;Curried.
3099 "Cleanup after inserting string STR.
3100 Remove enclosing field delimiters for STR. Display message with
3101 expansion of STR using expansion list COMPL."
3102 (when (memq status
'(exact finished sole
))
3103 (let ((abbr (cdr (assoc-string str compl t
))))
3105 (message "%s = abbreviation for `%s'" str abbr
)))
3106 (when (eq status
'finished
)
3107 (save-excursion (bibtex-remove-delimiters))))))
3109 (defun bibtex-complete-crossref-cleanup (buf) (lambda (key status
) ;Curried.
3110 "Display summary message on entry KEY after completion of a crossref key.
3111 Use `bibtex-summary-function' to generate summary."
3112 (when (memq status
'(exact sole finished
))
3114 (with-current-buffer buf
3116 (if (bibtex-search-entry key t
)
3117 (funcall bibtex-summary-function
))))))
3119 (message "%s %s" key summary
))))))
3121 (defun bibtex-copy-summary-as-kill (&optional arg
)
3122 "Push summery of current BibTeX entry to kill ring.
3123 Use `bibtex-summary-function' to generate summary.
3124 If prefix ARG is non-nil push BibTeX entry's URL to kill ring
3125 that is generated by calling `bibtex-url'."
3127 (if arg
(let ((url (bibtex-url nil t
)))
3128 (if url
(kill-new (message "%s" url
))
3129 (message "No URL known")))
3131 (bibtex-beginning-of-entry)
3132 (if (looking-at bibtex-entry-maybe-empty-head
)
3133 (kill-new (message "%s" (funcall bibtex-summary-function
)))
3134 (error "No entry found")))))
3136 (defun bibtex-summary ()
3137 "Return summary of current BibTeX entry.
3138 Used as default value of `bibtex-summary-function'."
3139 ;; It would be neat to make this function customizable. How?
3140 (if (looking-at bibtex-entry-maybe-empty-head
)
3141 (let* ((bibtex-autokey-name-case-convert-function 'identity
)
3142 (bibtex-autokey-name-length 'infty
)
3143 (bibtex-autokey-names 1)
3144 (bibtex-autokey-names-stretch 0)
3145 (bibtex-autokey-name-separator " ")
3146 (bibtex-autokey-additional-names " etal")
3147 (names (bibtex-autokey-get-names))
3148 (bibtex-autokey-year-length 4)
3149 (year (bibtex-autokey-get-year))
3150 (bibtex-autokey-titlewords 5)
3151 (bibtex-autokey-titlewords-stretch 2)
3152 (bibtex-autokey-titleword-case-convert-function 'identity
)
3153 (bibtex-autokey-titleword-length 5)
3154 (bibtex-autokey-titleword-separator " ")
3155 (title (bibtex-autokey-get-title))
3156 (journal (bibtex-autokey-get-field
3157 "journal" bibtex-autokey-transcriptions
))
3158 (volume (bibtex-autokey-get-field "volume"))
3159 (pages (bibtex-autokey-get-field "pages" '(("-.*\\'" .
"")))))
3160 (mapconcat (lambda (arg)
3161 (if (not (string= "" (cdr arg
)))
3162 (concat (car arg
) (cdr arg
))))
3163 `((" " .
,names
) (" " .
,year
) (": " .
,title
)
3164 (", " .
,journal
) (" " .
,volume
) (":" .
,pages
))
3166 (error "Entry not found")))
3168 (defun bibtex-pop (arg direction
)
3169 "Fill current field from the ARGth same field's text in DIRECTION.
3170 Generic function used by `bibtex-pop-previous' and `bibtex-pop-next'."
3171 ;; parse current field
3172 (let* ((bounds (bibtex-enclosing-field t
))
3173 (start-old-field (bibtex-start-of-field bounds
))
3174 (start-old-text (bibtex-start-of-text-in-field bounds
))
3175 (end-old-text (bibtex-end-of-text-in-field bounds
))
3176 (field-name (bibtex-name-in-field bounds t
))
3179 ;; if executed several times in a row, start each search where
3180 ;; the last one was finished
3181 (cond ((eq last-command
'bibtex-pop
)
3182 (goto-char (if (eq direction
'previous
)
3183 bibtex-pop-previous-search-point
3184 bibtex-pop-next-search-point
)))
3185 ((eq direction
'previous
)
3186 (bibtex-beginning-of-entry))
3187 (t (bibtex-end-of-entry)))
3188 ;; Search for arg'th previous/next similar field
3189 (while (and (not failure
)
3190 (>= (setq arg
(1- arg
)) 0))
3191 ;; The search of BibTeX fields is not bounded by entry boundaries
3192 (if (eq direction
'previous
)
3193 (if (setq bounds
(bibtex-search-backward-field field-name
))
3194 (goto-char (bibtex-start-of-field bounds
))
3196 (if (setq bounds
(bibtex-search-forward-field field-name
))
3197 (goto-char (bibtex-end-of-field bounds
))
3200 (error "No %s matching BibTeX field"
3201 (if (eq direction
'previous
) "previous" "next"))
3202 ;; Found a matching field. Remember boundaries.
3203 (let ((new-text (bibtex-text-in-field-bounds bounds
))
3204 (nbeg (copy-marker (bibtex-start-of-field bounds
)))
3205 (nend (copy-marker (bibtex-end-of-field bounds
))))
3206 (bibtex-flash-head "From: ")
3207 ;; Go back to where we started, delete old text, and pop new.
3208 (goto-char end-old-text
)
3209 (delete-region start-old-text end-old-text
)
3210 (if (= nbeg start-old-field
)
3211 (insert (bibtex-field-left-delimiter)
3212 (bibtex-field-right-delimiter))
3214 (setq bibtex-pop-previous-search-point
(marker-position nbeg
)
3215 bibtex-pop-next-search-point
(marker-position nend
))))))
3216 (bibtex-find-text nil nil nil t
)
3217 (setq this-command
'bibtex-pop
))
3219 (defun bibtex-beginning-of-field ()
3220 "Move point backward to beginning of field.
3221 This function uses a simple, fast algorithm assuming that the field
3222 begins at the beginning of a line. We use this function for font-locking."
3223 (let ((field-reg (concat "^[ \t]*" bibtex-field-name
"[ \t]*=")))
3225 (unless (looking-at field-reg
)
3226 (re-search-backward field-reg nil t
))))
3228 (defun bibtex-font-lock-url (bound &optional no-button
)
3229 "Font-lock for URLs. BOUND limits the search.
3230 If NO-BUTTON is non-nil do not generate buttons."
3231 (let ((case-fold-search t
)
3233 name bounds start end found
)
3234 (bibtex-beginning-of-field)
3235 (while (and (not found
)
3237 (prog1 (re-search-forward bibtex-font-lock-url-regexp bound t
)
3238 (setq name
(match-string-no-properties 1)))
3239 (setq bounds
(bibtex-parse-field-text))
3241 (setq start
(car bounds
) end
(nth 1 bounds
))
3242 ;; Always ignore field delimiters
3243 (if (memq (char-before end
) '(?\
} ?
\"))
3244 (setq end
(1- end
)))
3245 (if (memq (char-after start
) '(?\
{ ?
\"))
3246 (setq start
(1+ start
)))
3247 (if (< start pnt
) (setq start
(min pnt end
)))
3250 (let ((lst bibtex-generate-url-list
) url
)
3251 (while (and (not found
) (setq url
(car (pop lst
))))
3253 (setq found
(and (bibtex-string= name
(car url
))
3254 (re-search-forward (cdr url
) end t
))))))
3255 (unless found
(goto-char end
)))
3256 (if (and found
(not no-button
))
3257 (bibtex-button (match-beginning 0) (match-end 0)
3258 'bibtex-url
(match-beginning 0)))
3261 (defun bibtex-font-lock-crossref (bound)
3262 "Font-lock for crossref fields. BOUND limits the search."
3263 (let ((case-fold-search t
)
3265 (crossref-reg (concat "^[ \t]*crossref[ \t]*=[ \t\n]*"
3266 "\\(\"[^\"]*\"\\|{[^}]*}\\)[ \t\n]*[,})]"))
3268 (bibtex-beginning-of-field)
3269 (while (and (not found
)
3270 (re-search-forward crossref-reg bound t
))
3271 (setq start
(1+ (match-beginning 1))
3272 end
(1- (match-end 1))
3273 found
(>= start pnt
)))
3274 (if found
(bibtex-button start end
'bibtex-search-crossref
3275 (buffer-substring-no-properties start end
)
3279 (defun bibtex-font-lock-cite (matcher bound
)
3280 "Font-lock for cited keys.
3281 MATCHER identifies the cited key, see `bibtex-cite-matcher-alist'.
3282 BOUND limits the search."
3283 (let (case-fold-search)
3284 (if (re-search-forward (car matcher
) bound t
)
3285 (let ((start (match-beginning (cdr matcher
)))
3286 (end (match-end (cdr matcher
))))
3287 (bibtex-button start end
'bibtex-search-crossref
3288 (buffer-substring-no-properties start end
)
3292 (defun bibtex-button-action (button)
3293 "Call BUTTON's BibTeX function."
3294 (apply (button-get button
'bibtex-function
)
3295 (button-get button
'bibtex-args
)))
3297 (define-button-type 'bibtex-url
3298 'action
'bibtex-button-action
3299 'bibtex-function
'bibtex-url
3300 'help-echo
(purecopy "mouse-2, RET: follow URL"))
3302 (define-button-type 'bibtex-search-crossref
3303 'action
'bibtex-button-action
3304 'bibtex-function
'bibtex-search-crossref
3305 'help-echo
(purecopy "mouse-2, RET: follow crossref"))
3307 (defun bibtex-button (beg end type
&rest args
)
3308 "Make a BibTeX button from BEG to END of type TYPE in the current buffer."
3309 (make-text-button beg end
'type type
'bibtex-args args
))
3312 ;; Interactive Functions:
3315 (define-derived-mode bibtex-mode nil
"BibTeX"
3316 "Major mode for editing BibTeX files.
3318 General information on working with BibTeX mode:
3320 Use commands such as \\<bibtex-mode-map>\\[bibtex-Book] to get a template for a specific entry.
3321 Then fill in all desired fields using \\[bibtex-next-field] to jump from field
3322 to field. After having filled in all desired fields in the entry, clean the
3323 new entry with the command \\[bibtex-clean-entry].
3325 Some features of BibTeX mode are available only by setting the variable
3326 `bibtex-maintain-sorted-entries' to non-nil. However, then BibTeX mode
3327 works only with buffers containing valid (syntactically correct) and sorted
3328 entries. This is usually the case, if you have created a buffer completely
3329 with BibTeX mode and finished every new entry with \\[bibtex-clean-entry].
3331 For third party BibTeX files, call the command \\[bibtex-convert-alien]
3332 to fully take advantage of all features of BibTeX mode.
3335 Special information:
3337 A command such as \\[bibtex-Book] outlines the fields for a BibTeX book entry.
3339 The names of optional fields start with the string OPT, and are thus ignored
3340 by BibTeX. The names of alternative fields from which only one is required
3341 start with the string ALT. The OPT or ALT string may be removed from
3342 the name of a field with \\[bibtex-remove-OPT-or-ALT].
3343 \\[bibtex-make-field] inserts a new field after the current one.
3344 \\[bibtex-kill-field] kills the current field entirely.
3345 \\[bibtex-yank] yanks the last recently killed field after the current field.
3346 \\[bibtex-remove-delimiters] removes the double-quotes or braces around the text of the current field.
3347 \\[bibtex-empty-field] replaces the text of the current field with the default \"\" or {}.
3348 \\[bibtex-find-text] moves point to the end of the current field.
3349 \\[completion-at-point] completes word fragment before point according to context.
3351 The command \\[bibtex-clean-entry] cleans the current entry, i.e. it removes OPT/ALT
3352 from the names of all non-empty optional or alternative fields, checks that
3353 no required fields are empty, and does some formatting dependent on the value
3354 of `bibtex-entry-format'. Furthermore, it can automatically generate a key
3355 for the BibTeX entry, see `bibtex-generate-autokey'.
3356 Note: some functions in BibTeX mode depend on entries being in a special
3357 format (all fields beginning on separate lines), so it is usually a bad
3358 idea to remove `realign' from `bibtex-entry-format'.
3360 BibTeX mode supports Imenu and hideshow minor mode (`hs-minor-mode').
3362 ----------------------------------------------------------
3363 Entry to BibTeX mode calls the value of `bibtex-mode-hook'
3364 if that value is non-nil.
3366 \\{bibtex-mode-map}"
3367 (add-hook 'completion-at-point-functions
3368 'bibtex-completion-at-point-function nil
'local
)
3369 (make-local-variable 'bibtex-buffer-last-parsed-tick
)
3370 ;; Install stealthy parse function if not already installed
3371 (unless bibtex-parse-idle-timer
3372 (setq bibtex-parse-idle-timer
(run-with-idle-timer
3373 bibtex-parse-keys-timeout t
3374 'bibtex-parse-buffers-stealthily
)))
3375 (set (make-local-variable 'paragraph-start
) "[ \f\n\t]*$")
3376 (set (make-local-variable 'comment-start
) bibtex-comment-start
)
3377 (set (make-local-variable 'comment-start-skip
)
3378 (concat (regexp-quote bibtex-comment-start
) "\\>[ \t]*"))
3379 (set (make-local-variable 'comment-column
) 0)
3380 (set (make-local-variable 'defun-prompt-regexp
) "^[ \t]*@[[:alnum:]]+[ \t]*")
3381 (set (make-local-variable 'outline-regexp
) "[ \t]*@")
3382 (set (make-local-variable 'fill-paragraph-function
) 'bibtex-fill-field
)
3383 (set (make-local-variable 'fill-prefix
)
3384 (make-string (+ bibtex-entry-offset bibtex-contline-indentation
) ?\s
))
3385 (set (make-local-variable 'font-lock-defaults
)
3386 '(bibtex-font-lock-keywords
3388 ;; Mathematical expressions should be fontified as strings
3390 ;; Quotes are field delimiters and quote-delimited
3391 ;; entries should be fontified in the same way as
3392 ;; brace-delimited ones
3395 (font-lock-extra-managed-props .
(category))
3396 (font-lock-mark-block-function
3398 (set-mark (bibtex-end-of-entry))
3399 (bibtex-beginning-of-entry)))))
3400 (set (make-local-variable 'syntax-propertize-function
)
3401 (syntax-propertize-via-font-lock
3402 bibtex-font-lock-syntactic-keywords
))
3403 (setq imenu-generic-expression
3404 (list (list nil bibtex-entry-head bibtex-key-in-head
))
3405 imenu-case-fold-search t
)
3406 ;; Allow `bibtex-dialect' as a file-local variable.
3407 (add-hook 'hack-local-variables-hook
'bibtex-set-dialect nil t
))
3409 (defun bibtex-entry-alist (dialect)
3410 "Return entry-alist for DIALECT."
3411 (let ((var (intern (format "bibtex-%s-entry-alist" dialect
)))
3414 (setq entry-alist
(symbol-value var
))
3415 (error "BibTeX dialect `%s' undefined" dialect
))
3416 (if (not (consp (nth 1 (car entry-alist
))))
3419 ;; Convert old format of `bibtex-entry-field-alist'
3420 (unless (get var
'entry-list-format
)
3421 (put var
'entry-list-format
"pre-24")
3422 (message "Old format of `%s' (pre GNU Emacs 24).
3423 Please convert to the new format."
3424 (if (eq (indirect-variable 'bibtex-entry-field-alist
) var
)
3425 'bibtex-entry-field-alist var
))
3428 (dolist (entry entry-alist
)
3429 (let ((fl (nth 1 entry
)) req xref opt
)
3430 (dolist (field (copy-tree (car fl
)))
3431 (if (nth 3 field
) (setcar (nthcdr 3 field
) 0))
3432 (if (or (not (nth 2 entry
))
3433 (assoc-string (car field
) (car (nth 2 entry
)) t
))
3436 (dolist (field (nth 1 fl
))
3438 (push (list (car entry
) nil
(nreverse req
)
3439 (nreverse xref
) (nreverse opt
))
3443 (defun bibtex-set-dialect (&optional dialect local
)
3444 "Select BibTeX DIALECT for editing BibTeX files.
3445 This sets the user variable `bibtex-dialect' as well as the dialect-dependent
3446 internal variables. Allowed dialects are listed in `bibtex-dialect-list'.
3447 If DIALECT is nil use current value of `bibtex-dialect'.
3448 If LOCAL is non-nil make buffer-local bindings for these variables rather than
3449 setting the global values. The dialect-dependent internal variables
3450 are also bound buffer-locally if `bibtex-dialect' is already buffer-local
3451 in the current buffer (for example, as a file-local variable).
3452 LOCAL is t for interactive calls."
3453 (interactive (list (intern (completing-read "Dialect: "
3454 (mapcar 'list bibtex-dialect-list
)
3456 (let ((setfun (if (or local
(local-variable-p 'bibtex-dialect
))
3457 (lambda (var val
) (set (make-local-variable var
) val
))
3459 (if dialect
(funcall setfun
'bibtex-dialect dialect
))
3461 ;; Set internal variables
3462 (funcall setfun
'bibtex-entry-alist
(bibtex-entry-alist bibtex-dialect
))
3463 (funcall setfun
'bibtex-field-alist
3464 (let ((var (intern (format "bibtex-%s-field-alist"
3468 (error "Field types for BibTeX dialect `%s' undefined"
3470 (funcall setfun
'bibtex-entry-type
3471 (concat "@[ \t]*\\(?:"
3472 (regexp-opt (mapcar 'car bibtex-entry-alist
)) "\\)"))
3473 (funcall setfun
'bibtex-entry-head
3474 (concat "^[ \t]*\\(" bibtex-entry-type
"\\)[ \t]*[({][ \t\n]*\\("
3475 bibtex-reference-key
"\\)"))
3476 (funcall setfun
'bibtex-entry-maybe-empty-head
3477 (concat bibtex-entry-head
"?"))
3478 (funcall setfun
'bibtex-any-valid-entry-type
3479 (concat "^[ \t]*@[ \t]*\\(?:"
3481 (append '("String" "Preamble")
3482 (mapcar 'car bibtex-entry-alist
))) "\\)"))))
3484 ;; Entry commands and menus for BibTeX dialects
3485 ;; We do not use `easy-menu-define' here because this gets confused
3486 ;; if we want to have multiple versions of the "same" menu.
3487 (let ((select-map (make-sparse-keymap)))
3488 ;; Submenu for selecting the dialect
3489 (dolist (dialect (reverse bibtex-dialect-list
))
3490 (define-key select-map
(vector dialect
)
3491 `(menu-item ,(symbol-name dialect
)
3492 (lambda () (interactive) (bibtex-set-dialect ',dialect t
))
3493 :button
(:radio .
(eq bibtex-dialect
',dialect
)))))
3494 ;; We define a menu for each dialect.
3495 ;; Then we select the menu we want via the :visible keyword
3496 (dolist (dialect bibtex-dialect-list
)
3497 (let ((entry-alist (bibtex-entry-alist dialect
))
3498 (menu-map (make-sparse-keymap)))
3499 (define-key menu-map
[select]
3500 `(menu-item "BibTeX dialect" ,select-map))
3501 (define-key menu-map [nil-2] '(menu-item "--"))
3502 (define-key menu-map [bibtex-preamble]
3503 '(menu-item "Preamble" bibtex-Preamble))
3504 (define-key menu-map [bibtex-String]
3505 '(menu-item "String" bibtex-String))
3506 (define-key menu-map [nil-1] '(menu-item "--"))
3507 (dolist (elt (reverse entry-alist))
3509 (let* ((entry (car elt))
3510 (fname (intern (format "bibtex-%s" entry))))
3511 (unless (fboundp fname)
3512 (eval (list 'defun fname nil
3513 (format "Insert a template for a @%s entry; see also `bibtex-entry'."
3516 `(bibtex-entry ,entry))))
3518 (define-key menu-map (vector fname)
3519 `(menu-item ,(or (nth 1 elt) (car elt)) ,fname))))
3520 (define-key bibtex-mode-map
3521 (vector 'menu-bar dialect)
3522 `(menu-item "Entry-Types" ,menu-map
3523 :visible (eq bibtex-dialect ',dialect))))))
3525 (defun bibtex-field-list (entry-type)
3526 "Return list of allowed fields for entry ENTRY-TYPE.
3527 More specifically, the return value is a cons pair (REQUIRED . OPTIONAL),
3528 where REQUIRED and OPTIONAL are lists of the required and optional field
3529 names for ENTRY-TYPE according to `bibtex-BibTeX-entry-alist' and friends,
3530 `bibtex-include-OPTkey', `bibtex-include-OPTcrossref',
3531 and `bibtex-user-optional-fields'."
3532 (let ((e-list (assoc-string entry-type bibtex-entry-alist t))
3535 (error "Fields for BibTeX entry type %s not defined" entry-type))
3536 (if (member-ignore-case entry-type bibtex-include-OPTcrossref)
3537 (setq required (nth 2 e-list)
3538 optional (append (nth 3 e-list) (nth 4 e-list)))
3539 (setq required (append (nth 2 e-list) (nth 3 e-list))
3540 optional (nth 4 e-list)))
3541 (if bibtex-include-OPTkey
3543 "Used for reference key creation if author and editor fields are missing"
3544 (if (or (stringp bibtex-include-OPTkey)
3545 (functionp bibtex-include-OPTkey))
3546 bibtex-include-OPTkey))
3548 (if (member-ignore-case entry-type bibtex-include-OPTcrossref)
3549 (push '("crossref" "Reference key of the cross-referenced entry")
3551 (setq optional (append optional bibtex-user-optional-fields))
3552 (cons required optional)))
3554 (defun bibtex-entry (entry-type)
3555 "Insert a template for a BibTeX entry of type ENTRY-TYPE.
3556 After insertion call the value of `bibtex-add-entry-hook' if that value
3559 (let ((completion-ignore-case t))
3560 (list (completing-read "Entry Type: " bibtex-entry-alist
3561 nil t nil 'bibtex-entry-type-history))))
3562 (let ((key (if bibtex-maintain-sorted-entries
3563 (bibtex-read-key (format "%s key: " entry-type))))
3564 (field-list (bibtex-field-list entry-type)))
3565 (unless (bibtex-prepare-new-entry (list key nil entry-type))
3566 (error "Entry with key `%s' already exists" key))
3567 (indent-to-column bibtex-entry-offset)
3568 (insert "@" entry-type (bibtex-entry-left-delimiter))
3569 (if key (insert key))
3571 (mapc 'bibtex-make-field (car field-list))
3572 (mapc 'bibtex-make-optional-field (cdr field-list))
3573 (if bibtex-comma-after-last-field
3576 (indent-to-column bibtex-entry-offset)
3577 (insert (bibtex-entry-right-delimiter) "\n\n"))
3578 (bibtex-next-field t)
3579 (if (member-ignore-case entry-type bibtex-autofill-types)
3580 (bibtex-autofill-entry))
3581 (run-hooks 'bibtex-add-entry-hook)))
3583 (defun bibtex-entry-update (&optional entry-type)
3584 "Update an existing BibTeX entry.
3585 In the BibTeX entry at point, make new fields for those items that may occur
3586 according to `bibtex-field-list', but are not yet present.
3587 Also, add field delimiters to numerical fields if they are not present.
3588 If ENTRY-TYPE is non-nil, change first the entry type to ENTRY-TYPE.
3589 When called interactively with a prefix arg, query for a value of ENTRY-TYPE."
3591 (list (if current-prefix-arg
3592 (let ((completion-ignore-case t))
3593 (completing-read "New entry type: " bibtex-entry-alist
3594 nil t nil 'bibtex-entry-type-history)))))
3596 (bibtex-beginning-of-entry)
3597 (when (looking-at bibtex-entry-maybe-empty-head)
3598 (goto-char (match-end 0))
3601 (replace-match (concat "@" entry-type) nil nil nil 1))
3602 (setq entry-type (bibtex-type-in-head)))
3603 (let* ((field-list (bibtex-field-list entry-type))
3604 (required (copy-tree (car field-list)))
3605 (optional (copy-tree (cdr field-list)))
3607 (while (setq bounds (bibtex-parse-field))
3608 (let ((fname (bibtex-name-in-field bounds t))
3609 (end (copy-marker (bibtex-end-of-field bounds) t)))
3610 (setq required (delete (assoc-string fname required t) required)
3611 optional (delete (assoc-string fname optional t) optional))
3612 (when (string-match "\\`[0-9]+\\'"
3613 (bibtex-text-in-field-bounds bounds))
3614 (goto-char (bibtex-end-of-text-in-field bounds))
3615 (insert (bibtex-field-right-delimiter))
3616 (goto-char (bibtex-start-of-text-in-field bounds))
3617 (insert (bibtex-field-left-delimiter)))
3619 (skip-chars-backward " \t\n")
3620 (mapc 'bibtex-make-field required)
3621 (mapc 'bibtex-make-optional-field optional)))))
3623 (defun bibtex-parse-entry (&optional content)
3624 "Parse entry at point, return an alist.
3625 The alist elements have the form (FIELD . TEXT), where FIELD can also be
3626 the special strings \"=type=\" and \"=key=\". For the FIELD \"=key=\"
3627 TEXT may be nil. Remove \"OPT\" and \"ALT\" from FIELD.
3628 Move point to the end of the last field.
3629 If optional arg CONTENT is non-nil extract content of text fields."
3631 (when (looking-at bibtex-entry-maybe-empty-head)
3632 (push (cons "=type=" (bibtex-type-in-head)) alist)
3633 (push (cons "=key=" (bibtex-key-in-head)) alist)
3634 (goto-char (match-end 0))
3635 (while (setq bounds (bibtex-parse-field))
3636 (push (cons (bibtex-name-in-field bounds t)
3637 (bibtex-text-in-field-bounds bounds content))
3639 (goto-char (bibtex-end-of-field bounds))))
3642 (defun bibtex-autofill-entry ()
3643 "Try to fill fields of current BibTeX entry based on neighboring entries.
3644 The current entry must have a key. Determine the neighboring entry
3645 \(previous or next\) whose key is more similar to the key of the current
3646 entry. For all empty fields of the current entry insert the corresponding
3647 field contents of the neighboring entry. Finally try to update the text
3648 based on the difference between the keys of the neighboring and the current
3649 entry (for example, the year parts of the keys)."
3651 (bibtex-beginning-of-entry)
3652 (when (looking-at bibtex-entry-head)
3653 (let ((type (bibtex-type-in-head))
3654 (key (bibtex-key-in-head))
3655 (key-end (match-end bibtex-key-in-head))
3656 (case-fold-search t)
3657 (bibtex-sort-ignore-string-entries t)
3658 tmp other-key other bounds)
3659 ;; The fields we want to change start right after the key.
3661 ;; First see whether to use the previous or the next entry
3662 ;; for "inspiration".
3664 (goto-char (1- (match-beginning 0)))
3665 (bibtex-beginning-of-entry)
3666 (if (and (looking-at bibtex-entry-head)
3667 (bibtex-string= type (bibtex-type-in-head))
3668 ;; In case we found ourselves :-(
3669 (not (equal key (setq tmp (bibtex-key-in-head)))))
3673 (bibtex-end-of-entry)
3674 (bibtex-skip-to-valid-entry)
3675 (if (and (looking-at bibtex-entry-head)
3676 (bibtex-string= type (bibtex-type-in-head))
3677 ;; In case we found ourselves :-(
3678 (not (equal key (setq tmp (bibtex-key-in-head))))
3680 ;; Check which is the best match.
3681 (< (length (try-completion "" (list key other-key)))
3682 (length (try-completion "" (list key tmp))))))
3685 ;; Then fill the new entry's fields with the chosen other entry.
3687 (setq other (save-excursion (goto-char other) (bibtex-parse-entry)))
3688 (setq key-end (point)) ;In case parse-entry changed the buffer.
3689 (while (setq bounds (bibtex-parse-field))
3690 (let ((text (assoc-string (bibtex-name-in-field bounds t)
3693 (equal "" (bibtex-text-in-field-bounds bounds t))))
3694 (goto-char (bibtex-end-of-field bounds))
3695 (goto-char (bibtex-start-of-text-in-field bounds))
3696 (delete-region (point) (bibtex-end-of-text-in-field bounds))
3697 (insert (cdr text)))))
3698 ;; Finally try to update the text based on the difference between
3700 (let* ((prefix (try-completion "" (list key other-key)))
3701 ;; If the keys are foo91 and foo92, don't replace 1 for 2
3702 ;; but 91 for 92 instead.
3703 (_ (if (string-match "[0-9]+\\'" prefix)
3704 (setq prefix (substring prefix 0 (match-beginning 0)))))
3705 (suffix (substring key (length prefix)))
3706 (other-suffix (substring other-key (length prefix))))
3707 (while (re-search-backward (regexp-quote other-suffix) key-end 'move)
3708 (replace-match suffix)))))))
3710 (defun bibtex-print-help-message (&optional field comma)
3711 "Print helpful information about current FIELD in current BibTeX entry.
3712 Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
3714 (interactive (list nil t))
3715 (unless field (setq field (car (bibtex-find-text-internal nil nil comma))))
3716 (if (string-match "@" field)
3717 (cond ((bibtex-string= field "@string")
3718 (message "String definition"))
3719 ((bibtex-string= field "@preamble")
3720 (message "Preamble definition"))
3721 (t (message "Entry key")))
3722 (let* ((case-fold-search t)
3723 (type (save-excursion
3724 (bibtex-beginning-of-entry)
3725 (looking-at bibtex-entry-maybe-empty-head)
3726 (bibtex-type-in-head)))
3727 (field-list (bibtex-field-list type))
3728 (comment (assoc-string field (append (car field-list)
3729 (cdr field-list)) t)))
3730 (message "%s" (cond ((nth 1 comment) (nth 1 comment))
3731 ((setq comment (assoc-string field bibtex-field-alist t))
3733 (t "No comment available"))))))
3735 (defun bibtex-make-field (field &optional move interactive nodelim)
3736 "Make a field named FIELD in current BibTeX entry.
3737 FIELD is either a string or a list of the form
3738 \(FIELD-NAME COMMENT-STRING INIT ALTERNATIVE-FLAG) as in
3739 `bibtex-BibTeX-entry-alist' and friends.
3740 If MOVE is non-nil, move point past the present field before making
3741 the new field. If INTERACTIVE is non-nil, move point to the end of
3742 the new field. Otherwise move point past the new field.
3743 MOVE and INTERACTIVE are t when called interactively.
3744 INIT is surrounded by field delimiters, unless NODELIM is non-nil."
3746 (list (let ((completion-ignore-case t)
3747 (field-list (bibtex-field-list
3749 (bibtex-beginning-of-entry)
3750 (looking-at bibtex-any-entry-maybe-empty-head)
3751 (bibtex-type-in-head)))))
3752 (completing-read "BibTeX field name: "
3753 (append (car field-list) (cdr field-list))
3754 nil nil nil bibtex-field-history))
3756 (unless (consp field)
3757 (setq field (list field)))
3760 (if (looking-at "[}\"]")
3763 (indent-to-column (+ bibtex-entry-offset bibtex-field-indentation))
3764 ;; If there are multiple sets of alternatives, we could use
3765 ;; the numeric value of (nth 3 field) to number these sets. Useful??
3766 (if (nth 3 field) (insert "ALT"))
3767 (insert (car field) " ")
3768 (if bibtex-align-at-equal-sign
3769 (indent-to-column (+ bibtex-entry-offset
3770 (- bibtex-text-indentation 2))))
3772 (unless bibtex-align-at-equal-sign
3773 (indent-to-column (+ bibtex-entry-offset
3774 bibtex-text-indentation)))
3775 (let ((init (nth 2 field)))
3776 (if (not init) (setq init "")
3777 (if (functionp init) (setq init (funcall init)))
3778 (unless (stringp init) (error "`%s' is not a string" init)))
3779 ;; NODELIM is required by `bibtex-insert-kill'
3780 (if nodelim (insert init)
3781 (insert (bibtex-field-left-delimiter) init
3782 (bibtex-field-right-delimiter))))
3784 ;; (bibtex-find-text nil nil bibtex-help-message)
3785 (if (memq (preceding-char) '(?} ?\")) (forward-char -1))
3786 (if bibtex-help-message (bibtex-print-help-message (car field)))))
3788 (defun bibtex-beginning-of-entry ()
3789 "Move to beginning of BibTeX entry (beginning of line).
3790 If inside an entry, move to the beginning of it, otherwise move to the
3791 beginning of the previous entry. If point is ahead of all BibTeX entries
3792 move point to the beginning of buffer. Return the new location of point."
3794 (skip-chars-forward " \t")
3795 (if (looking-at "@")
3797 (re-search-backward "^[ \t]*@" nil 'move)
3800 (defun bibtex-end-of-entry ()
3801 "Move to end of BibTeX entry (past the closing brace).
3802 If inside an entry, move to the end of it, otherwise move to the end
3803 of the previous entry. Do not move if ahead of first entry.
3804 Return the new location of point."
3806 (let ((case-fold-search t)
3808 (_ (bibtex-beginning-of-entry))
3809 (bounds (bibtex-valid-entry t)))
3810 (cond (bounds (goto-char (cdr bounds))) ; regular entry
3811 ;; @String or @Preamble
3812 ((setq bounds (or (bibtex-parse-string t) (bibtex-parse-preamble)))
3813 (goto-char (bibtex-end-of-string bounds)))
3814 ((looking-at bibtex-any-valid-entry-type)
3815 ;; Parsing of entry failed
3816 (error "Syntactically incorrect BibTeX entry starts here"))
3817 (t (if (called-interactively-p 'interactive)
3818 (message "Not on a known BibTeX entry."))
3822 (defun bibtex-goto-line (arg)
3823 "Goto line ARG, counting from beginning of (narrowed) buffer."
3824 ;; code adapted from `goto-line'
3825 (goto-char (point-min))
3826 (if (eq selective-display t)
3827 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
3828 (forward-line (1- arg))))
3830 (defun bibtex-reposition-window ()
3831 "Make the current BibTeX entry visible.
3832 If entry is smaller than `window-body-height', entry is centered in window.
3833 Otherwise display the beginning of entry."
3836 (beg (line-number-at-pos (bibtex-beginning-of-entry)))
3837 (end (line-number-at-pos (bibtex-end-of-entry))))
3838 (if (> (window-body-height) (- end beg))
3839 ;; entry fits in current window
3841 (bibtex-goto-line (/ (+ 1 beg end) 2))
3844 ;; entry too large for current window
3845 (bibtex-goto-line beg)
3847 (if (> (1+ (- (line-number-at-pos pnt) beg))
3848 (window-body-height))
3849 (bibtex-goto-line beg)
3852 (defun bibtex-mark-entry ()
3853 "Put mark at beginning, point at end of current BibTeX entry."
3855 (push-mark (bibtex-beginning-of-entry))
3856 (bibtex-end-of-entry))
3858 (defun bibtex-count-entries (&optional count-string-entries)
3859 "Count number of entries in current buffer or region.
3860 With prefix argument COUNT-STRING-ENTRIES count all entries,
3861 otherwise count all entries except @String entries.
3862 If mark is active count entries in region, if not in whole buffer."
3865 (bibtex-sort-ignore-string-entries (not count-string-entries)))
3867 (if mark-active (narrow-to-region (region-beginning) (region-end)))
3868 (bibtex-map-entries (lambda (_key _beg _end) (setq number (1+ number)))))
3869 (message "%s contains %d entries."
3870 (if mark-active "Region" "Buffer")
3873 (defun bibtex-ispell-entry ()
3874 "Check BibTeX entry for spelling errors."
3876 (ispell-region (save-excursion (bibtex-beginning-of-entry))
3877 (save-excursion (bibtex-end-of-entry))))
3879 (defun bibtex-ispell-abstract ()
3880 "Check abstract of BibTeX entry for spelling errors."
3882 (let ((bounds (save-excursion
3883 (bibtex-beginning-of-entry)
3884 (bibtex-search-forward-field "abstract" t))))
3886 (ispell-region (bibtex-start-of-text-in-field bounds)
3887 (bibtex-end-of-text-in-field bounds))
3888 (error "No abstract in entry"))))
3890 (defun bibtex-narrow-to-entry ()
3891 "Narrow buffer to current BibTeX entry."
3895 (narrow-to-region (bibtex-beginning-of-entry)
3896 (bibtex-end-of-entry))))
3898 (defun bibtex-entry-index ()
3899 "Return index of BibTeX entry head at or past position of point.
3900 The index is a list (KEY CROSSREF-KEY ENTRY-TYPE) that is used for sorting
3901 the entries of the BibTeX buffer. CROSSREF-KEY is nil unless the value
3902 of `bibtex-maintain-sorted-entries' is `crossref'. Move point to the end
3903 of the head of the entry found. Return nil if no entry found."
3904 (let ((case-fold-search t))
3905 (if (re-search-forward bibtex-entry-maybe-empty-head nil t)
3906 (let ((key (bibtex-key-in-head))
3907 ;; all entry types should be downcase (for ease of comparison)
3908 (entry-type (downcase (bibtex-type-in-head))))
3909 ;; Don't search CROSSREF-KEY if we don't need it.
3910 (if (eq bibtex-maintain-sorted-entries 'crossref)
3911 (let ((bounds (bibtex-search-forward-field
3912 "\\(OPT\\)?crossref" t)))
3914 (if bounds (bibtex-text-in-field-bounds bounds t))
3916 (list key nil entry-type))))))
3918 (defun bibtex-init-sort-entry-class-alist ()
3919 "Initialize `bibtex-sort-entry-class-alist' (buffer-local)."
3920 (unless (local-variable-p 'bibtex-sort-entry-class-alist)
3921 (set (make-local-variable 'bibtex-sort-entry-class-alist)
3923 (dolist (class bibtex-sort-entry-class)
3925 (dolist (entry class)
3926 ;; All entry types should be downcase (for ease of comparison).
3927 (push (cons (if (stringp entry) (downcase entry) entry) i)
3931 (defun bibtex-lessp (index1 index2)
3932 "Predicate for sorting BibTeX entries with indices INDEX1 and INDEX2.
3933 Each index is a list (KEY CROSSREF-KEY ENTRY-TYPE).
3934 The predicate depends on the variable `bibtex-maintain-sorted-entries'.
3935 If its value is nil use plain sorting."
3936 (cond ((not index1) (not index2)) ; indices can be nil
3938 ((eq bibtex-maintain-sorted-entries 'crossref)
3939 ;; CROSSREF-KEY may be nil or it can point to an entry
3940 ;; in another BibTeX file. In both cases we ignore CROSSREF-KEY.
3941 (if (and (nth 1 index1)
3942 (cdr (assoc-string (nth 1 index1) bibtex-reference-keys)))
3943 (if (and (nth 1 index2)
3944 (cdr (assoc-string (nth 1 index2) bibtex-reference-keys)))
3945 (or (string-lessp (nth 1 index1) (nth 1 index2))
3946 (and (string-equal (nth 1 index1) (nth 1 index2))
3947 (string-lessp (nth 0 index1) (nth 0 index2))))
3948 (not (string-lessp (nth 0 index2) (nth 1 index1))))
3949 (if (and (nth 1 index2)
3950 (cdr (assoc-string (nth 1 index2) bibtex-reference-keys)))
3951 (string-lessp (nth 0 index1) (nth 1 index2))
3952 (string-lessp (nth 0 index1) (nth 0 index2)))))
3953 ((eq bibtex-maintain-sorted-entries 'entry-class)
3954 (let ((n1 (cdr (or (assoc (nth 2 index1) bibtex-sort-entry-class-alist)
3955 (assoc 'catch-all bibtex-sort-entry-class-alist)
3956 '(nil . 1000)))) ; if there is nothing else
3957 (n2 (cdr (or (assoc (nth 2 index2) bibtex-sort-entry-class-alist)
3958 (assoc 'catch-all bibtex-sort-entry-class-alist)
3959 '(nil . 1000))))) ; if there is nothing else
3962 (string-lessp (car index1) (car index2))))))
3963 (t ; (eq bibtex-maintain-sorted-entries 'plain)
3964 (string-lessp (car index1) (car index2)))))
3966 (defun bibtex-sort-buffer ()
3967 "Sort BibTeX buffer alphabetically by key.
3968 The predicate for sorting is defined via `bibtex-maintain-sorted-entries'.
3969 If its value is nil use plain sorting. Text outside of BibTeX entries is not
3970 affected. If `bibtex-sort-ignore-string-entries' is non-nil, @String entries
3973 (bibtex-beginning-of-first-entry) ; Needed by `sort-subr'
3974 (bibtex-init-sort-entry-class-alist) ; Needed by `bibtex-lessp'.
3975 (if (and (eq bibtex-maintain-sorted-entries 'crossref)
3976 (functionp bibtex-reference-keys))
3977 (bibtex-parse-keys)) ; Needed by `bibtex-lessp'.
3979 'bibtex-skip-to-valid-entry ; NEXTREC function
3980 'bibtex-end-of-entry ; ENDREC function
3981 'bibtex-entry-index ; STARTKEY function
3982 nil ; ENDKEY function
3983 'bibtex-lessp)) ; PREDICATE
3985 (defun bibtex-search-crossref (crossref-key &optional pnt split noerror)
3986 "Move point to the beginning of BibTeX entry CROSSREF-KEY.
3987 If `bibtex-files' is non-nil, search all these files.
3988 Otherwise the search is limited to the current buffer.
3989 Return position of entry if CROSSREF-KEY is found or nil otherwise.
3990 If CROSSREF-KEY is in the same buffer like current entry but before it
3991 an error is signaled. If NOERROR is non-nil this error is suppressed.
3992 Optional arg PNT is the position of the referencing entry. It defaults
3993 to position of point. If optional arg SPLIT is non-nil, split window
3994 so that both the referencing and the crossrefed entry are displayed.
3996 If called interactively, CROSSREF-KEY defaults to either the crossref key
3997 of current entry or a key matched by `bibtex-cite-matcher-alist',
3998 whatever is nearer to the position of point. SPLIT is t. NOERROR is nil
3999 for a crossref key, t otherwise."
4002 (let* ((pnt (point))
4003 (_ (bibtex-beginning-of-entry))
4004 (end (cdr (bibtex-valid-entry t)))
4005 (_ (unless end (error "Not inside valid entry")))
4006 (beg (match-end 0)) ; set by `bibtex-valid-entry'
4007 (bounds (bibtex-search-forward-field "\\(OPT\\)?crossref" end))
4008 case-fold-search best temp crossref-key)
4010 (setq crossref-key (bibtex-text-in-field-bounds bounds t)
4011 best (cons (bibtex-dist pnt (bibtex-end-of-field bounds)
4012 (bibtex-start-of-field bounds))
4014 (dolist (matcher bibtex-cite-matcher-alist)
4016 (while (re-search-forward (car matcher) end t)
4017 (setq temp (bibtex-dist pnt (match-end (cdr matcher))
4018 (match-beginning (cdr matcher))))
4019 ;; Accept the key closest to the position of point.
4020 (if (or (not best) (< temp (car best)))
4021 (setq best (cons temp (match-string-no-properties
4024 (setq temp (bibtex-read-key "Find crossref key: " (cdr best) t))
4025 (list temp (point) t (not (and crossref-key
4026 (string= temp crossref-key)))))))
4028 (let (buffer pos eqb)
4030 (setq pos (bibtex-search-entry crossref-key t)
4031 buffer (current-buffer)))
4032 (setq eqb (eq buffer (current-buffer)))
4034 (if split (message "Crossref key `%s' not found" crossref-key)))
4035 (split ; called (quasi) interactively
4036 (unless pnt (setq pnt (point)))
4038 (if (and eqb (= pos (save-excursion (bibtex-beginning-of-entry))))
4039 (message "Key `%s' is current entry" crossref-key)
4040 (if eqb (select-window (split-window))
4041 (pop-to-buffer buffer))
4043 (bibtex-reposition-window)
4045 (if (and eqb (> pnt pos) (not noerror))
4046 (error "The referencing entry must precede the crossrefed entry!"))))
4047 ;; `bibtex-search-crossref' is called noninteractively during
4048 ;; clean-up of an entry. Then it is not possible to check
4049 ;; whether the current entry and the crossrefed entry have
4050 ;; the correct sorting order.
4051 (eqb (goto-char pos))
4052 (t (set-buffer buffer) (goto-char pos)))
4054 ;; backward compatibility
4055 (defalias 'bibtex-find-crossref 'bibtex-search-crossref)
4057 (defun bibtex-dist (pos beg end)
4058 "Return distance between POS and region delimited by BEG and END."
4059 (cond ((and (<= beg pos) (<= pos end)) 0)
4060 ((< pos beg) (- beg pos))
4064 (defun bibtex-search-entry (key &optional global start display)
4065 "Move point to the beginning of BibTeX entry named KEY.
4066 Return position of entry if KEY is found or nil if not found.
4067 With GLOBAL non-nil, search KEY in `bibtex-files'. Otherwise the search
4068 is limited to the current buffer. Optional arg START is buffer position
4069 where the search starts. If it is nil, start search at beginning of buffer.
4070 If DISPLAY is non-nil, display the buffer containing KEY.
4071 Otherwise, use `set-buffer'.
4072 When called interactively, START is nil, DISPLAY is t.
4073 Also, GLOBAL is t if the current mode is not `bibtex-mode'
4074 or `bibtex-search-entry-globally' is non-nil.
4075 A prefix arg negates the value of `bibtex-search-entry-globally'."
4077 (let ((global (or (not (eq major-mode 'bibtex-mode))
4078 (if bibtex-search-entry-globally
4079 (not current-prefix-arg)
4080 current-prefix-arg))))
4081 (list (bibtex-read-key "Find key: " nil global) global nil t)))
4082 (if (and global bibtex-files)
4083 (let ((buffer-list (bibtex-initialize t))
4085 (while (and (not found)
4086 (setq buffer (pop buffer-list)))
4087 (with-current-buffer buffer
4088 (if (cdr (assoc-string key bibtex-reference-keys))
4089 ;; `bibtex-search-entry' moves point if key found
4090 (setq found (bibtex-search-entry key)))))
4091 (cond ((and found display)
4092 (switch-to-buffer buffer)
4093 (bibtex-reposition-window))
4094 (found (set-buffer buffer))
4095 (display (message "Key `%s' not found" key)))
4098 (let* ((case-fold-search t)
4099 (pnt (save-excursion
4100 (goto-char (or start (point-min)))
4101 (if (re-search-forward (concat "^[ \t]*\\("
4103 "\\)[ \t]*[({][ \t\n]*\\("
4107 (match-beginning 0)))))
4110 (if display (bibtex-reposition-window)))
4111 (display (message "Key `%s' not found" key)))
4113 ;; backward compatibility
4114 (defalias 'bibtex-find-entry 'bibtex-search-entry)
4116 (defun bibtex-prepare-new-entry (index)
4117 "Prepare a new BibTeX entry with index INDEX.
4118 INDEX is a list (KEY CROSSREF-KEY ENTRY-TYPE).
4119 Move point where the entry KEY should be placed.
4120 If `bibtex-maintain-sorted-entries' is non-nil, perform a binary
4121 search to look for place for KEY. This requires that buffer is sorted,
4122 see `bibtex-validate'.
4123 Return t if preparation was successful or nil if entry KEY already exists."
4124 (bibtex-init-sort-entry-class-alist) ; Needed by `bibtex-lessp'.
4125 (if (and (eq bibtex-maintain-sorted-entries 'crossref)
4126 (functionp bibtex-reference-keys))
4127 (bibtex-parse-keys)) ; Needed by `bibtex-lessp'.
4128 (let ((key (nth 0 index))
4130 (cond ((or (null key)
4132 (string-equal key ""))
4133 (and (not (setq key-exist (bibtex-search-entry key)))
4134 (not bibtex-maintain-sorted-entries)))
4135 (bibtex-move-outside-of-entry))
4136 ;; if key-exist is non-nil due to the previous cond clause
4137 ;; then point will be at beginning of entry named key.
4139 (t ; `bibtex-maintain-sorted-entries' is non-nil
4140 (let* ((case-fold-search t)
4141 (left (save-excursion (bibtex-beginning-of-first-entry)))
4142 (bounds (save-excursion (goto-char (point-max))
4143 (bibtex-skip-to-valid-entry t)))
4144 (right (if bounds (cdr bounds) (point-min)))
4145 (found (if (>= left right) left))
4150 (goto-char (/ (+ left right) 2))
4151 (bibtex-skip-to-valid-entry t)
4152 (setq actual-index (bibtex-entry-index))
4153 (cond ((bibtex-lessp index actual-index)
4154 (setq new (bibtex-beginning-of-entry))
4155 (if (equal right new)
4159 (bibtex-end-of-entry)
4160 (bibtex-skip-to-valid-entry)
4162 (if (equal left new)
4164 (setq left new))))))
4166 (bibtex-beginning-of-entry)
4167 (setq actual-index (save-excursion (bibtex-entry-index)))
4168 (when (or (not actual-index)
4169 (bibtex-lessp actual-index index))
4170 ;; buffer contains no valid entries or
4171 ;; greater than last entry --> append
4172 (bibtex-end-of-entry)
4173 (unless (bobp) (newline (forward-line 2)))
4174 (beginning-of-line)))))
4175 (unless key-exist t)))
4177 (defun bibtex-validate (&optional test-thoroughly)
4178 "Validate if buffer or region is syntactically correct.
4179 Check also for duplicate keys and correct sort order provided
4180 `bibtex-maintain-sorted-entries' is non-nil.
4181 With optional argument TEST-THOROUGHLY non-nil check also for
4182 the absence of required fields and for questionable month fields.
4183 If mark is active, validate current region, if not the whole buffer.
4184 Only check known entry types, so you can put comments outside of entries.
4185 Return t if test was successful, nil otherwise."
4187 (let* ((case-fold-search t)
4188 error-list syntax-error)
4191 (if mark-active (narrow-to-region (region-beginning) (region-end)))
4193 ;; Check syntactical structure of entries
4194 (goto-char (point-min))
4195 (bibtex-progress-message "Checking syntactical structure")
4197 (while (setq end (re-search-forward "^[ \t]*@" nil t))
4198 (bibtex-progress-message)
4199 (goto-char (match-beginning 0))
4200 (cond ((setq bounds (bibtex-valid-entry))
4201 (goto-char (cdr bounds)))
4202 ((setq bounds (or (bibtex-parse-string)
4203 (bibtex-parse-preamble)))
4204 (goto-char (bibtex-end-of-string bounds)))
4205 ((looking-at bibtex-any-valid-entry-type)
4206 (push (cons (bibtex-current-line)
4207 "Syntax error (check esp. commas, braces, and quotes)")
4209 (goto-char (match-end 0)))
4210 (t (goto-char end)))))
4211 (bibtex-progress-message 'done)
4214 ;; Continue only if there were no syntax errors.
4215 (setq syntax-error t)
4217 ;; Check for duplicate keys and correct sort order
4218 (bibtex-init-sort-entry-class-alist) ; Needed by `bibtex-lessp'.
4219 (bibtex-parse-keys) ; Possibly needed by `bibtex-lessp'.
4220 ; Always needed by subsequent global key check.
4221 (let (previous current key-list)
4222 (bibtex-progress-message "Checking for duplicate keys")
4224 (lambda (key _beg _end)
4225 (bibtex-progress-message)
4226 (setq current (bibtex-entry-index))
4227 (cond ((not previous))
4228 ((member key key-list)
4229 (push (cons (bibtex-current-line)
4230 (format "Duplicate key `%s'" key))
4232 ((and bibtex-maintain-sorted-entries
4233 (not (bibtex-lessp previous current)))
4234 (push (cons (bibtex-current-line)
4235 "Entries out of order")
4238 (setq previous current)))
4239 (bibtex-progress-message 'done))
4241 ;; Check for duplicate keys in `bibtex-files'.
4242 ;; `bibtex-validate' only compares keys in current buffer with keys
4243 ;; in `bibtex-files'. `bibtex-validate-globally' compares keys for
4244 ;; each file in `bibtex-files' with keys of all other files in
4246 ;; We don't want to be fooled by outdated `bibtex-reference-keys'.
4247 (dolist (buffer (bibtex-initialize nil t))
4248 (dolist (key (with-current-buffer buffer bibtex-reference-keys))
4249 (when (and (cdr key)
4250 (cdr (assoc-string (car key) bibtex-reference-keys)))
4251 (bibtex-search-entry (car key))
4252 (push (cons (bibtex-current-line)
4253 (format "Duplicate key `%s' in %s" (car key)
4254 (abbreviate-file-name (buffer-file-name buffer))))
4257 (when test-thoroughly
4258 (bibtex-progress-message
4259 "Checking required fields and month fields")
4260 (let ((bibtex-sort-ignore-string-entries t))
4262 (lambda (_key beg end)
4263 (bibtex-progress-message)
4264 (bibtex-beginning-first-field beg)
4265 (let* ((beg-line (save-excursion (goto-char beg)
4266 (bibtex-current-line)))
4267 (entry-list (assoc-string (bibtex-type-in-head)
4268 bibtex-entry-alist t))
4269 (crossref (bibtex-search-forward-field "crossref" end))
4270 (req (if crossref (copy-sequence (nth 2 entry-list))
4271 (append (nth 2 entry-list)
4272 (copy-sequence (nth 3 entry-list)))))
4273 (num-alt (length (delq nil (delete-dups
4274 (mapcar (lambda (x) (nth 3 x))
4276 (alt-fields (make-vector num-alt nil))
4278 (while (setq bounds (bibtex-parse-field))
4279 (let ((field-name (bibtex-name-in-field bounds)))
4280 (if (and (bibtex-string= field-name "month")
4281 ;; Check only abbreviated month fields.
4282 (let ((month (bibtex-text-in-field-bounds bounds)))
4283 (not (or (string-match "\\`[\"{].+[\"}]\\'" month)
4286 bibtex-predefined-month-strings t)))))
4287 (push (cons (bibtex-current-line)
4288 "Questionable month field")
4290 (setq field (assoc-string field-name req t)
4291 req (delete field req))
4292 (if (setq idx (nth 3 field))
4293 (if (aref alt-fields idx)
4294 (push (cons (bibtex-current-line)
4295 "More than one non-empty alternative")
4297 (aset alt-fields idx t))))
4298 (goto-char (bibtex-end-of-field bounds)))
4299 (let ((alt-expect (make-vector num-alt nil)))
4300 (dolist (field req) ; absent required fields
4301 (if (setq idx (nth 3 field))
4302 (bibtex-vec-push alt-expect idx (car field))
4303 (push (cons beg-line
4304 (format "Required field `%s' missing"
4307 (dotimes (idx num-alt)
4308 (unless (aref alt-fields idx)
4309 (push (cons beg-line
4310 (format "Alternative fields `%s' missing"
4311 (aref alt-expect idx)))
4313 (bibtex-progress-message 'done)))))
4316 (let ((file (file-name-nondirectory (buffer-file-name)))
4317 (dir default-directory)
4318 (err-buf "*BibTeX validation errors*"))
4319 (setq error-list (sort error-list 'car-less-than-car))
4320 (with-current-buffer (get-buffer-create err-buf)
4321 (setq default-directory dir)
4322 (unless (eq major-mode 'compilation-mode) (compilation-mode))
4323 (let ((inhibit-read-only t))
4324 (delete-region (point-min) (point-max))
4325 (insert "BibTeX mode command `bibtex-validate'\n"
4327 "Maybe undetected errors due to syntax errors. \
4328 Correct and validate again.\n"
4330 (dolist (err error-list)
4331 (insert (format "%s:%d: %s\n" file (car err) (cdr err))))
4332 (set-buffer-modified-p nil))
4333 (goto-char (point-min))
4334 (forward-line 2)) ; first error message
4335 (display-buffer err-buf)
4336 nil) ; return `nil' (i.e., buffer is invalid)
4337 (message "%s is syntactically correct"
4338 (if mark-active "Region" "Buffer"))
4339 t))) ; return `t' (i.e., buffer is valid)
4341 (defun bibtex-validate-globally (&optional strings)
4342 "Check for duplicate keys in `bibtex-files'.
4343 With optional prefix arg STRINGS, check for duplicate strings, too.
4344 Return t if test was successful, nil otherwise."
4346 (let ((buffer-list (bibtex-initialize t))
4347 buffer-key-list current-buf current-keys error-list)
4348 ;; Check for duplicate keys within BibTeX buffer
4349 (dolist (buffer buffer-list)
4350 (with-current-buffer buffer
4352 (let (entry-type key key-list)
4353 (goto-char (point-min))
4354 (while (re-search-forward bibtex-entry-head nil t)
4355 (setq entry-type (bibtex-type-in-head)
4356 key (bibtex-key-in-head))
4357 (if (or (and strings (bibtex-string= entry-type "string"))
4358 (assoc-string entry-type bibtex-entry-alist t))
4359 (if (member key key-list)
4360 (push (format "%s:%d: Duplicate key `%s'\n"
4362 (bibtex-current-line) key)
4364 (push key key-list))))
4365 (push (cons buffer key-list) buffer-key-list)))))
4367 ;; Check for duplicate keys among BibTeX buffers
4368 (while (setq current-buf (pop buffer-list))
4369 (setq current-keys (cdr (assq current-buf buffer-key-list)))
4370 (with-current-buffer current-buf
4371 (dolist (buffer buffer-list)
4372 (dolist (key (cdr (assq buffer buffer-key-list)))
4373 (when (assoc-string key current-keys)
4374 (bibtex-search-entry key)
4375 (push (format "%s:%d: Duplicate key `%s' in %s\n"
4376 (buffer-file-name) (bibtex-current-line) key
4377 (abbreviate-file-name (buffer-file-name buffer)))
4380 ;; Process error list
4382 (let ((err-buf "*BibTeX validation errors*"))
4383 (with-current-buffer (get-buffer-create err-buf)
4384 (unless (eq major-mode 'compilation-mode) (compilation-mode))
4385 (let ((inhibit-read-only t))
4386 (delete-region (point-min) (point-max))
4387 (insert "BibTeX mode command `bibtex-validate-globally'\n\n")
4388 (dolist (err (sort error-list 'string-lessp)) (insert err))
4389 (set-buffer-modified-p nil))
4390 (goto-char (point-min))
4391 (forward-line 2)) ; first error message
4392 (display-buffer err-buf)
4393 nil) ; return `nil' (i.e., buffer is invalid)
4394 (message "No duplicate keys.")
4395 t))) ; return `t' (i.e., buffer is valid)
4397 (defun bibtex-next-field (begin &optional comma)
4398 "Move point to end of text of next BibTeX field or entry head.
4399 With prefix BEGIN non-nil, move point to its beginning. Optional arg COMMA
4400 is as in `bibtex-enclosing-field'. It is t for interactive calls."
4401 (interactive (list current-prefix-arg t))
4402 (let ((bounds (bibtex-find-text-internal t nil comma))
4405 (setq end-of-entry t)
4406 (goto-char (nth 3 bounds))
4407 (if (assoc-string (car bounds) '("@String" "@Preamble") t)
4408 (setq end-of-entry t)
4409 ;; BibTeX key or field
4410 (if (looking-at ",[ \t\n]*") (goto-char (match-end 0)))
4412 (if (looking-at "[)}][ \t\n]*") (setq end-of-entry t))))
4413 (if (and end-of-entry
4414 (re-search-forward bibtex-any-entry-maybe-empty-head nil t))
4415 (goto-char (match-beginning 0)))
4416 (bibtex-find-text begin nil bibtex-help-message)))
4418 (defun bibtex-find-text (&optional begin noerror help comma)
4419 "Move point to end of text of current BibTeX field or entry head.
4420 With optional prefix BEGIN non-nil, move point to its beginning.
4421 Unless NOERROR is non-nil, an error is signaled if point is not
4422 on a BibTeX field. If optional arg HELP is non-nil print help message.
4423 When called interactively, the value of HELP is `bibtex-help-message'.
4424 Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
4426 (interactive (list current-prefix-arg nil bibtex-help-message t))
4427 (let ((bounds (bibtex-find-text-internal t nil comma)))
4430 (progn (goto-char (nth 1 bounds))
4431 (if (looking-at "[{\"]")
4433 (goto-char (nth 2 bounds))
4434 (if (memq (preceding-char) '(?} ?\"))
4436 (if help (bibtex-print-help-message (car bounds))))
4437 ((not noerror) (error "Not on BibTeX field")))))
4439 (defun bibtex-find-text-internal (&optional noerror subfield comma)
4440 "Find text part of current BibTeX field or entry head.
4441 Return list (NAME START-TEXT END-TEXT END STRING-CONST) with field name
4442 or entry type, start and end of text, and end of field or entry head.
4443 STRING-CONST is a flag which is non-nil if current subfield delimited by #
4444 is a BibTeX string constant. Return value is nil if field or entry head
4446 If optional arg NOERROR is non-nil, an error message is suppressed
4447 if text is not found. If optional arg SUBFIELD is non-nil START-TEXT
4448 and END-TEXT correspond to the current subfield delimited by #.
4449 Optional arg COMMA is as in `bibtex-enclosing-field'."
4452 (bounds (bibtex-enclosing-field comma t))
4453 (case-fold-search t)
4454 name start-text end-text end failure done no-sub string-const)
4455 (bibtex-beginning-of-entry)
4457 (setq name (bibtex-name-in-field bounds t)
4458 start-text (bibtex-start-of-text-in-field bounds)
4459 end-text (bibtex-end-of-text-in-field bounds)
4460 end (bibtex-end-of-field bounds)))
4462 ((setq bounds (bibtex-parse-string t))
4463 (if (<= pnt (bibtex-end-of-string bounds))
4464 (setq name "@String" ;; not a field name!
4465 start-text (bibtex-start-of-text-in-string bounds)
4466 end-text (bibtex-end-of-text-in-string bounds)
4467 end (bibtex-end-of-string bounds))
4470 ((setq bounds (bibtex-parse-preamble))
4471 (if (<= pnt (bibtex-end-of-string bounds))
4472 (setq name "@Preamble" ;; not a field name!
4473 start-text (bibtex-start-of-text-in-string bounds)
4474 end-text (bibtex-end-of-text-in-string bounds)
4475 end (bibtex-end-of-string bounds))
4478 ((looking-at bibtex-entry-maybe-empty-head)
4479 (goto-char (match-end 0))
4480 (if comma (save-match-data
4481 (re-search-forward "\\=[ \t\n]*," nil t)))
4482 (if (<= pnt (point))
4483 (setq name (match-string-no-properties bibtex-type-in-head)
4484 start-text (or (match-beginning bibtex-key-in-head)
4486 end-text (or (match-end bibtex-key-in-head)
4489 no-sub t) ; subfields do not make sense
4491 (t (setq failure t)))
4492 (when (and subfield (not failure))
4493 (setq failure no-sub)
4495 (goto-char start-text)
4497 (if (or (prog1 (looking-at bibtex-field-const)
4498 (setq end-text (match-end 0)
4500 (prog1 (setq bounds (bibtex-parse-field-string))
4501 (setq end-text (cdr bounds)
4504 (if (and (<= start-text pnt) (<= pnt end-text))
4506 (goto-char end-text))
4507 (if (looking-at "[ \t\n]*#[ \t\n]*")
4508 (setq start-text (goto-char (match-end 0)))))
4509 (setq done t failure t)))))
4510 (cond ((not failure)
4511 (list name start-text end-text end string-const))
4512 ((and no-sub (not noerror))
4513 (error "Not on text part of BibTeX field"))
4514 ((not noerror) (error "Not on BibTeX field"))))))
4516 (defun bibtex-remove-OPT-or-ALT (&optional comma)
4517 "Remove the string starting optional/alternative fields.
4518 Align text and go thereafter to end of text. Optional arg COMMA
4519 is as in `bibtex-enclosing-field'. It is t for interactive calls."
4520 (interactive (list t))
4521 (let ((case-fold-search t)
4522 (bounds (bibtex-enclosing-field comma)))
4524 (goto-char (bibtex-start-of-name-in-field bounds))
4525 (when (and (looking-at "OPT\\|ALT")
4526 (not (and bibtex-no-opt-remove-re
4528 bibtex-no-opt-remove-re
4529 (buffer-substring-no-properties
4530 (bibtex-start-of-name-in-field bounds)
4531 (bibtex-end-of-name-in-field bounds))))))
4532 (delete-region (match-beginning 0) (match-end 0))
4533 ;; make field non-OPT
4534 (search-forward "=")
4536 (delete-horizontal-space)
4537 (if bibtex-align-at-equal-sign
4538 (indent-to-column (- bibtex-text-indentation 2))
4540 (search-forward "=")
4541 (delete-horizontal-space)
4542 (if bibtex-align-at-equal-sign
4544 (indent-to-column bibtex-text-indentation))))))
4546 (defun bibtex-remove-delimiters (&optional comma)
4547 "Remove \"\" or {} around current BibTeX field text.
4548 Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
4550 (interactive (list t))
4551 (let ((bounds (bibtex-find-text-internal nil t comma)))
4552 (unless (nth 4 bounds)
4553 (delete-region (1- (nth 2 bounds)) (nth 2 bounds))
4554 (delete-region (nth 1 bounds) (1+ (nth 1 bounds))))))
4556 (defun bibtex-kill-field (&optional copy-only comma)
4557 "Kill the entire enclosing BibTeX field.
4558 With prefix arg COPY-ONLY, copy the current field to `bibtex-field-kill-ring',
4559 but do not actually kill it. Optional arg COMMA is as in
4560 `bibtex-enclosing-field'. It is t for interactive calls."
4561 (interactive (list current-prefix-arg t))
4563 (let* ((case-fold-search t)
4564 (bounds (bibtex-enclosing-field comma))
4565 (end (bibtex-end-of-field bounds))
4566 (beg (bibtex-start-of-field bounds)))
4568 ;; Preserve white space at end of BibTeX entry
4569 (if (looking-at "[ \t\n]*[)}]")
4570 (progn (skip-chars-backward " \t\n")
4572 (skip-chars-forward ","))
4573 (push (list (bibtex-name-in-field bounds) nil
4574 (bibtex-text-in-field-bounds bounds))
4575 bibtex-field-kill-ring)
4576 (if (> (length bibtex-field-kill-ring) bibtex-field-kill-ring-max)
4577 (setcdr (nthcdr (1- bibtex-field-kill-ring-max)
4578 bibtex-field-kill-ring)
4580 (setq bibtex-field-kill-ring-yank-pointer bibtex-field-kill-ring)
4582 (delete-region beg end))))
4583 (setq bibtex-last-kill-command 'field))
4585 (defun bibtex-copy-field-as-kill (&optional comma)
4586 "Copy the BibTeX field at point to `bibtex-field-kill-ring'.
4587 Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
4589 (interactive (list t))
4590 (bibtex-kill-field t comma))
4592 (defun bibtex-kill-entry (&optional copy-only)
4593 "Kill the entire enclosing BibTeX entry.
4594 With prefix arg COPY-ONLY, copy the current entry to `bibtex-entry-kill-ring',
4595 but do not actually kill it."
4598 (let* ((case-fold-search t)
4599 (beg (bibtex-beginning-of-entry))
4600 (key (progn (looking-at bibtex-any-entry-maybe-empty-head)
4601 (bibtex-key-in-head)))
4602 (end (progn (bibtex-end-of-entry)
4603 (if (re-search-forward
4604 bibtex-any-entry-maybe-empty-head nil 'move)
4605 (goto-char (match-beginning 0)))
4607 (push (buffer-substring-no-properties beg end)
4608 bibtex-entry-kill-ring)
4609 (if (> (length bibtex-entry-kill-ring) bibtex-entry-kill-ring-max)
4610 (setcdr (nthcdr (1- bibtex-entry-kill-ring-max)
4611 bibtex-entry-kill-ring)
4613 (setq bibtex-entry-kill-ring-yank-pointer bibtex-entry-kill-ring)
4615 (delete-region beg end)
4616 ;; remove key from `bibtex-reference-keys'.
4617 (unless (functionp bibtex-reference-keys)
4618 (setq bibtex-reference-keys
4619 (delete (cons key t) bibtex-reference-keys))))))
4620 (setq bibtex-last-kill-command 'entry))
4622 (defun bibtex-copy-entry-as-kill ()
4623 "Copy the entire enclosing BibTeX entry to `bibtex-entry-kill-ring'."
4625 (bibtex-kill-entry t))
4627 (defun bibtex-yank (&optional n)
4628 "Reinsert the last BibTeX item.
4629 More precisely, reinsert the field or entry killed or yanked most recently.
4630 With argument N, reinsert the Nth most recently killed BibTeX item.
4631 See also the command \\[bibtex-yank-pop]."
4633 (unless n (setq n 1))
4634 (bibtex-insert-kill (1- n) t)
4635 (setq this-command 'bibtex-yank))
4637 (defun bibtex-yank-pop (n)
4638 "Replace just-yanked killed BibTeX item with a different item.
4639 This command is allowed only immediately after a `bibtex-yank' or a
4640 `bibtex-yank-pop'. In this case, the region contains a reinserted
4641 previously killed BibTeX item. `bibtex-yank-pop' deletes that item
4642 and inserts in its place a different killed BibTeX item.
4644 With no argument, the previous kill is inserted.
4645 With argument N, insert the Nth previous kill.
4646 If N is negative, this is a more recent kill.
4648 The sequence of kills wraps around, so that after the oldest one
4649 comes the newest one."
4651 (unless (eq last-command 'bibtex-yank)
4652 (error "Previous command was not a BibTeX yank"))
4653 (setq this-command 'bibtex-yank)
4654 (let ((inhibit-read-only t) key)
4655 ;; point is at end of yanked entry
4656 (unless (functionp bibtex-reference-keys)
4657 ;; remove key of yanked entry from `bibtex-reference-keys'
4659 (goto-char (mark t))
4660 (if (and (looking-at bibtex-any-entry-maybe-empty-head)
4661 (setq key (bibtex-key-in-head)))
4662 (setq bibtex-reference-keys
4663 (delete (cons key t) bibtex-reference-keys)))))
4664 (delete-region (point) (mark t))
4665 (bibtex-insert-kill n t)))
4667 (defun bibtex-empty-field (&optional comma)
4668 "Delete the text part of the current field, replace with empty text.
4669 Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
4671 (interactive (list t))
4672 (let ((bounds (bibtex-enclosing-field comma)))
4673 (goto-char (bibtex-start-of-text-in-field bounds))
4674 (delete-region (point) (bibtex-end-of-text-in-field bounds))
4675 (insert (bibtex-field-left-delimiter)
4676 (bibtex-field-right-delimiter))
4677 (bibtex-find-text t nil bibtex-help-message)))
4679 (defun bibtex-pop-previous (arg)
4680 "Replace text of current field with the similar field in previous entry.
4681 With arg, goes up ARG entries. Repeated, goes up so many times. May be
4682 intermixed with \\[bibtex-pop-next] (bibtex-pop-next)."
4684 (bibtex-pop arg 'previous))
4686 (defun bibtex-pop-next (arg)
4687 "Replace text of current field with the text of similar field in next entry.
4688 With arg, goes down ARG entries. Repeated, goes down so many times. May be
4689 intermixed with \\[bibtex-pop-previous] (bibtex-pop-previous)."
4691 (bibtex-pop arg 'next))
4693 (defun bibtex-clean-entry (&optional new-key called-by-reformat)
4694 "Finish editing the current BibTeX entry and clean it up.
4695 Check that no required fields are empty and format entry dependent
4696 on the value of `bibtex-entry-format'.
4697 If the reference key of the entry is empty or a prefix argument is given,
4698 calculate a new reference key. (Note: this works only if fields in entry
4699 begin on separate lines prior to calling `bibtex-clean-entry' or if
4700 'realign is contained in `bibtex-entry-format'.)
4701 Don't call `bibtex-clean-entry' on @Preamble entries.
4702 At end of the cleaning process, the functions in
4703 `bibtex-clean-entry-hook' are called with region narrowed to entry."
4704 ;; Opt. arg CALLED-BY-REFORMAT is t if `bibtex-clean-entry'
4705 ;; is called by `bibtex-reformat'
4707 (let ((case-fold-search t)
4708 (start (bibtex-beginning-of-entry))
4709 (_ (or (looking-at bibtex-any-entry-maybe-empty-head)
4710 (error "Not inside a BibTeX entry")))
4711 (entry-type (bibtex-type-in-head))
4712 (key (bibtex-key-in-head)))
4713 (cond ((bibtex-string= entry-type "preamble")
4714 ;; (bibtex-format-preamble)
4715 (error "No clean up of @Preamble entries"))
4716 ((bibtex-string= entry-type "string")
4717 (setq entry-type 'string))
4718 ;; (bibtex-format-string)
4719 (t (bibtex-format-entry)))
4721 (if (or new-key (not key))
4723 ;; First delete the old key so that a customized algorithm
4724 ;; for generating the new key does not get confused by the
4726 (re-search-forward (if (eq entry-type 'string)
4727 bibtex-string-maybe-empty-head
4728 bibtex-entry-maybe-empty-head))
4729 (if (match-beginning bibtex-key-in-head)
4730 (delete-region (match-beginning bibtex-key-in-head)
4731 (match-end bibtex-key-in-head)))
4732 (setq key (bibtex-generate-autokey))
4733 ;; Sometimes `bibtex-generate-autokey' returns an empty string
4734 (if (or bibtex-autokey-edit-before-use (string= "" key))
4735 (setq key (if (eq entry-type 'string)
4736 (bibtex-read-string-key key)
4737 (bibtex-read-key "Key to use: " key))))
4740 (unless called-by-reformat
4741 (let* ((end (save-excursion
4742 (bibtex-end-of-entry)
4743 (if (re-search-forward
4744 bibtex-entry-maybe-empty-head nil 'move)
4745 (goto-char (match-beginning 0)))
4747 (entry (buffer-substring start end))
4748 ;; include the crossref key in index
4749 (index (let ((bibtex-maintain-sorted-entries 'crossref))
4750 (bibtex-entry-index))) ; moves point to end of head
4753 (if (and bibtex-maintain-sorted-entries
4754 (not (and bibtex-sort-ignore-string-entries
4755 (eq entry-type 'string))))
4757 (delete-region start end)
4758 (setq error (not (bibtex-prepare-new-entry index))
4759 start (point)) ; update start
4760 (save-excursion (insert entry)))
4761 (bibtex-search-entry key)
4762 (setq error (or (/= (point) start)
4763 (bibtex-search-entry key nil end))))
4765 (error "New inserted entry yields duplicate key"))
4766 (dolist (buffer (bibtex-initialize))
4767 (with-current-buffer buffer
4768 (if (cdr (assoc-string key bibtex-reference-keys))
4769 (error "Duplicate key in %s" (buffer-file-name)))))
4771 ;; Only update `bibtex-strings' and `bibtex-reference-keys'
4772 ;; if they have been built already.
4773 (cond ((eq entry-type 'string)
4774 ;; We have a @String entry.
4775 (unless (or (functionp bibtex-strings)
4776 (assoc key bibtex-strings))
4777 (push (cons key (bibtex-text-in-string
4778 (bibtex-parse-string) t))
4780 ;; We have a normal entry.
4781 ((not (functionp bibtex-reference-keys))
4782 (let ((found (assoc key bibtex-reference-keys)))
4784 (push (cons key t) bibtex-reference-keys))
4786 ;; Turn a crossref key into a header key
4787 (setq bibtex-reference-keys
4789 (delete (list key) bibtex-reference-keys))))))
4790 ;; If entry has a crossref key, it goes into the list
4791 ;; `bibtex-reference-keys', too.
4792 (if (and (nth 1 index)
4793 (not (assoc (nth 1 index) bibtex-reference-keys)))
4794 (push (list (nth 1 index)) bibtex-reference-keys)))))
4797 (if bibtex-clean-entry-hook
4800 (bibtex-narrow-to-entry)
4801 (run-hooks 'bibtex-clean-entry-hook)))))))
4803 (defun bibtex-fill-field-bounds (bounds justify &optional move)
4804 "Fill BibTeX field delimited by BOUNDS.
4805 If JUSTIFY is non-nil justify as well.
4806 If optional arg MOVE is non-nil move point to end of field."
4807 (let ((end-field (copy-marker (bibtex-end-of-field bounds))))
4809 (goto-char (bibtex-start-of-text-in-field bounds))
4810 (goto-char (bibtex-start-of-field bounds))
4811 (forward-char) ; leading comma
4812 (bibtex-delete-whitespace)
4814 (indent-to-column (+ bibtex-entry-offset
4815 bibtex-field-indentation))
4816 (re-search-forward "[ \t\n]*=" end-field)
4819 (if bibtex-align-at-equal-sign
4821 (+ bibtex-entry-offset (- bibtex-text-indentation 2)))
4824 (bibtex-delete-whitespace)
4825 (if bibtex-align-at-equal-sign
4827 (indent-to-column bibtex-text-indentation)))
4828 ;; Paragraphs within fields are not preserved. Bother?
4829 (fill-region-as-paragraph (line-beginning-position) end-field
4830 default-justification nil (point))
4831 (if move (goto-char end-field))))
4833 (defun bibtex-fill-field (&optional justify)
4834 "Like \\[fill-paragraph], but fill current BibTeX field.
4835 If optional prefix JUSTIFY is non-nil justify as well.
4836 In BibTeX mode this function is bound to `fill-paragraph-function'."
4838 (let ((pnt (copy-marker (point)))
4839 (bounds (bibtex-enclosing-field t)))
4840 (bibtex-fill-field-bounds bounds justify)
4843 (defun bibtex-fill-entry ()
4844 "Fill current BibTeX entry.
4845 Realign entry, so that every field starts on a separate line. Field
4846 names appear in column `bibtex-field-indentation', field text starts in
4847 column `bibtex-text-indentation' and continuation lines start here, too.
4848 If `bibtex-align-at-equal-sign' is non-nil, align equal signs, too."
4850 (let ((pnt (copy-marker (point)))
4851 (beg (bibtex-beginning-of-entry)) ; move point
4853 (bibtex-delete-whitespace)
4854 (indent-to-column bibtex-entry-offset)
4855 (bibtex-beginning-first-field beg)
4856 (while (setq bounds (bibtex-parse-field))
4857 (bibtex-fill-field-bounds bounds t t))
4858 (if (looking-at ",")
4860 (skip-chars-backward " \t\n")
4861 (bibtex-delete-whitespace)
4863 (indent-to-column bibtex-entry-offset)
4866 (defun bibtex-realign ()
4867 "Realign BibTeX entries such that they are separated by one blank line."
4868 (goto-char (point-min))
4869 (let ((case-fold-search t)
4870 (entry-type (concat "[ \t\n]*\\(" bibtex-entry-type "\\)")))
4871 ;; No blank lines prior to the first entry if there no
4872 ;; non-white characters in front of it.
4873 (when (looking-at entry-type)
4874 (replace-match "\\1"))
4875 ;; Entries are separated by one blank line.
4876 (while (re-search-forward entry-type nil t)
4877 (replace-match "\n\n\\1"))
4878 ;; One blank line past the last entry if it is followed by
4879 ;; non-white characters, no blank line otherwise.
4881 (when (re-search-forward bibtex-entry-type nil t)
4882 (bibtex-end-of-entry)
4883 (bibtex-delete-whitespace)
4884 (open-line (if (eobp) 1 2)))))
4886 (defun bibtex-reformat (&optional read-options)
4887 "Reformat all BibTeX entries in buffer or region.
4888 Without prefix argument, reformatting is based on `bibtex-entry-format'.
4889 With prefix argument, read options for reformatting from minibuffer.
4890 With \\[universal-argument] \\[universal-argument] prefix argument, reuse previous answers (if any) again.
4891 If mark is active reformat entries in region, if not in whole buffer."
4893 (let* ((pnt (point))
4894 (use-previous-options
4895 (and (equal (prefix-numeric-value read-options) 16)
4896 (or bibtex-reformat-previous-options
4897 bibtex-reformat-previous-reference-keys)))
4898 (bibtex-entry-format
4900 (if use-previous-options
4901 bibtex-reformat-previous-options
4902 (setq bibtex-reformat-previous-options
4904 (mapcar (lambda (option)
4905 (if (y-or-n-p (car option)) (cdr option)))
4906 `(("Realign entries (recommended)? " . realign)
4907 ("Remove empty optional and alternative fields? " . opts-or-alts)
4908 ("Remove delimiters around pure numerical fields? " . numerical-fields)
4909 (,(concat (if bibtex-comma-after-last-field "Insert" "Remove")
4910 " comma at end of entry? ") . last-comma)
4911 ("Replace double page dashes by single ones? " . page-dashes)
4912 ("Delete whitespace at the beginning and end of fields? " . whitespace)
4913 ("Inherit booktitle? " . inherit-booktitle)
4914 ("Force delimiters? " . delimiters)
4915 ("Unify case of entry types and field names? " . unify-case)
4916 ("Enclose parts of field entries by braces? " . braces)
4917 ("Replace parts of field entries by string constants? " . strings)
4918 ("Sort fields? " . sort-fields)))))))
4919 ;; Do not include required-fields because `bibtex-reformat'
4920 ;; cannot handle the error messages of `bibtex-format-entry'.
4921 ;; Use `bibtex-validate' to check for required fields.
4922 ((eq t bibtex-entry-format)
4923 '(realign opts-or-alts numerical-fields delimiters
4924 last-comma page-dashes unify-case inherit-booktitle
4925 whitespace braces strings sort-fields))
4927 (cons 'realign (remove 'required-fields bibtex-entry-format)))))
4928 (reformat-reference-keys
4930 (if use-previous-options
4931 bibtex-reformat-previous-reference-keys
4932 (setq bibtex-reformat-previous-reference-keys
4933 (y-or-n-p "Generate new reference keys automatically? ")))))
4934 (bibtex-sort-ignore-string-entries t)
4935 bibtex-autokey-edit-before-use)
4938 (if mark-active (narrow-to-region (region-beginning) (region-end)))
4939 (if (memq 'realign bibtex-entry-format)
4941 (bibtex-progress-message "Formatting" 1)
4942 (bibtex-map-entries (lambda (_key _beg _end)
4943 (bibtex-progress-message)
4944 (bibtex-clean-entry reformat-reference-keys t)))
4945 (bibtex-progress-message 'done))
4946 (when reformat-reference-keys
4947 (kill-local-variable 'bibtex-reference-keys)
4948 (when bibtex-maintain-sorted-entries
4949 (bibtex-progress-message "Sorting" 1)
4950 (bibtex-sort-buffer)
4951 (bibtex-progress-message 'done)))
4954 (defun bibtex-convert-alien (&optional read-options)
4955 "Make an alien BibTeX buffer fully usable by BibTeX mode.
4956 If a file does not conform with all standards used by BibTeX mode,
4957 some of the high-level features of BibTeX mode are not available.
4958 This function tries to convert current buffer to conform with these standards.
4959 With prefix argument READ-OPTIONS non-nil, read options for reformatting
4960 entries from minibuffer."
4962 (message "Starting to validate buffer...")
4965 (deactivate-mark) ; So `bibtex-validate' works on the whole buffer.
4966 (if (not (let (bibtex-maintain-sorted-entries)
4968 (message "Correct errors and call `bibtex-convert-alien' again")
4969 (message "Starting to reformat entries...")
4971 (bibtex-reformat read-options)
4972 (goto-char (point-max))
4973 (message "Buffer is now parsable. Please save it.")))
4975 (define-obsolete-function-alias 'bibtex-complete 'completion-at-point "24.1")
4976 (defun bibtex-completion-at-point-function ()
4978 (case-fold-search t)
4979 (beg (save-excursion
4980 (re-search-backward "[ \t{\"]")
4986 (if (and (setq bounds (bibtex-enclosing-field nil t))
4987 (>= pnt (bibtex-start-of-text-in-field bounds))
4988 (<= pnt (bibtex-end-of-text-in-field bounds)))
4989 (setq name (bibtex-name-in-field bounds t)
4990 compl (cond ((bibtex-string= name "crossref")
4991 ;; point is in crossref field
4993 ((bibtex-string= name "month")
4994 ;; point is in month field
4995 bibtex-predefined-month-strings)
4996 ;; point is in other field
4997 (t (bibtex-strings))))
4998 (bibtex-beginning-of-entry)
4999 (cond ((setq bounds (bibtex-parse-string t))
5000 ;; point is inside a @String key
5001 (cond ((and (>= pnt (nth 1 (car bounds)))
5002 (<= pnt (nth 2 (car bounds))))
5003 (setq compl 'string))
5004 ;; point is inside a @String field
5005 ((and (>= pnt (bibtex-start-of-text-in-string bounds))
5006 (<= pnt (bibtex-end-of-text-in-string bounds)))
5007 (setq compl (bibtex-strings)))))
5008 ;; point is inside a @Preamble field
5009 ((setq bounds (bibtex-parse-preamble))
5010 (if (and (>= pnt (bibtex-start-of-text-in-string bounds))
5011 (<= pnt (bibtex-end-of-text-in-string bounds)))
5012 (setq compl (bibtex-strings))))
5013 ((and (looking-at bibtex-entry-maybe-empty-head)
5014 ;; point is inside a key
5015 (or (and (match-beginning bibtex-key-in-head)
5016 (>= pnt (match-beginning bibtex-key-in-head))
5017 (<= pnt (match-end bibtex-key-in-head)))
5018 ;; or point is on empty key
5019 (and (not (match-beginning bibtex-key-in-head))
5020 (= pnt (match-end 0)))))
5021 (setq compl 'key)))))
5023 (cond ((eq compl 'key)
5024 ;; Key completion: no cleanup needed.
5027 (let (completion-ignore-case)
5028 (complete-with-action a (bibtex-global-key-alist) s p)))))
5030 ((eq compl 'crossref-key)
5031 ;; Crossref key completion.
5032 (let* ((buf (current-buffer)))
5036 ((eq a 'metadata) `(metadata (category . bibtex-key)))
5037 (t (let ((completion-ignore-case nil))
5038 (complete-with-action
5039 a (bibtex-global-key-alist) s p)))))
5040 :exit-function (bibtex-complete-crossref-cleanup buf))))
5043 ;; String key completion: no cleanup needed.
5046 (let ((completion-ignore-case t))
5047 (complete-with-action a bibtex-strings s p)))))
5050 ;; String completion.
5054 ((eq a 'metadata) `(metadata (category . bibtex-string)))
5055 (t (let ((completion-ignore-case t))
5056 (complete-with-action a compl s p)))))
5057 :exit-function (bibtex-complete-string-cleanup compl))))))
5059 (defun bibtex-String (&optional key)
5060 "Insert a new BibTeX @String entry with key KEY."
5061 (interactive (list (bibtex-read-string-key)))
5062 (let ((bibtex-maintain-sorted-entries
5063 (unless bibtex-sort-ignore-string-entries
5064 bibtex-maintain-sorted-entries))
5066 (unless (bibtex-prepare-new-entry (list key nil "String"))
5067 (error "Entry with key `%s' already exists" key))
5068 (if (zerop (length key)) (setq key nil))
5069 (indent-to-column bibtex-entry-offset)
5071 (bibtex-entry-left-delimiter))
5074 (setq endpos (point)))
5076 (bibtex-field-left-delimiter))
5078 (setq endpos (point)))
5079 (insert (bibtex-field-right-delimiter)
5080 (bibtex-entry-right-delimiter)
5082 (goto-char endpos)))
5084 (defun bibtex-Preamble ()
5085 "Insert a new BibTeX @Preamble entry."
5087 (bibtex-move-outside-of-entry)
5088 (indent-to-column bibtex-entry-offset)
5090 (bibtex-entry-left-delimiter)
5091 (bibtex-field-left-delimiter))
5092 (let ((endpos (point)))
5093 (insert (bibtex-field-right-delimiter)
5094 (bibtex-entry-right-delimiter)
5096 (goto-char endpos)))
5098 (defun bibtex-url (&optional pos no-browse)
5099 "Browse a URL for the BibTeX entry at point.
5100 Optional POS is the location of the BibTeX entry.
5101 The URL is generated using the schemes defined in `bibtex-generate-url-list'
5102 \(see there\). If multiple schemes match for this entry, or the same scheme
5103 matches more than once, use the one for which the first step's match is the
5104 closest to POS. The URL is passed to `browse-url' unless NO-BROWSE is t.
5105 Return the URL or nil if none can be generated."
5107 (unless pos (setq pos (point)))
5110 (bibtex-beginning-of-entry)
5111 (let ((end (save-excursion (bibtex-end-of-entry)))
5112 (fields-alist (save-excursion (bibtex-parse-entry t)))
5113 ;; Always ignore case,
5114 (case-fold-search t)
5115 text url scheme obj fmt fl-match)
5116 ;; The return value of `bibtex-parse-entry' (i.e., FIELDS-ALIST)
5117 ;; is always used to generate the URL. However, if the BibTeX
5118 ;; entry contains more than one URL, we have multiple matches
5119 ;; for the first step defining the generation of the URL.
5120 ;; Therefore, we try to initiate the generation of the URL
5121 ;; based on the match of `bibtex-font-lock-url' that is the
5122 ;; closest to POS. If that fails (no match found) we try to
5123 ;; initiate the generation of the URL based on the properly
5124 ;; concatenated CONTENT of the field as returned by
5125 ;; `bibtex-text-in-field-bounds'. The latter approach can
5126 ;; differ from the former because `bibtex-font-lock-url' uses
5127 ;; the buffer itself.
5128 (while (bibtex-font-lock-url end t)
5129 (push (list (bibtex-dist pos (match-beginning 0) (match-end 0))
5131 (buffer-substring-no-properties
5132 (match-beginning 0) (match-end 0)))
5134 ;; `bibtex-font-lock-url' moves point to end of match.
5137 (setq fl-match (car (sort fl-match (lambda (x y) (< (car x) (car y))))))
5138 (goto-char (nth 1 fl-match))
5139 (bibtex-beginning-of-field) (re-search-backward ",")
5140 (let* ((bounds (bibtex-parse-field))
5141 (name (bibtex-name-in-field bounds))
5142 (content (bibtex-text-in-field-bounds bounds t))
5143 (lst bibtex-generate-url-list))
5144 ;; This match can fail when CONTENT differs from text in buffer.
5145 (when (string-match (regexp-quote (nth 2 fl-match)) content)
5146 ;; TEXT is the part of CONTENT that starts with the match
5147 ;; of `bibtex-font-lock-url' we are looking for.
5148 (setq text (substring content (match-beginning 0)))
5149 (while (and (not url) (setq scheme (pop lst)))
5150 ;; Verify the match of `bibtex-font-lock-url' by
5151 ;; comparing with TEXT.
5152 (when (and (bibtex-string= (caar scheme) name)
5153 (string-match (cdar scheme) text))
5154 (setq url t scheme (cdr scheme)))))))
5156 ;; If the match of `bibtex-font-lock-url' was not approved
5157 ;; parse FIELDS-ALIST, i.e., the output of `bibtex-parse-entry'.
5159 (let ((lst bibtex-generate-url-list))
5160 (while (and (not url) (setq scheme (pop lst)))
5161 (when (and (setq text (cdr (assoc-string (caar scheme)
5163 (string-match (cdar scheme) text))
5164 (setq url t scheme (cdr scheme))))))
5167 (setq url (if (null scheme) (match-string 0 text)
5168 (if (stringp (car scheme))
5169 (setq fmt (pop scheme)))
5170 (dolist (step scheme)
5171 (setq text (cdr (assoc-string (car step) fields-alist t)))
5172 (if (string-match (nth 1 step) text)
5173 (push (cond ((functionp (nth 2 step))
5174 (funcall (nth 2 step) text))
5175 ((numberp (nth 2 step))
5176 (match-string (nth 2 step) text))
5178 (replace-match (nth 2 step) t nil text)))
5180 ;; If SCHEME is set up correctly,
5181 ;; we should never reach this point
5182 (error "Match failed: %s" text)))
5183 (if fmt (apply 'format fmt (nreverse obj))
5184 (apply 'concat (nreverse obj)))))
5185 (if (called-interactively-p 'interactive) (message "%s" url))
5186 (unless no-browse (browse-url url)))
5187 (if (and (not url) (called-interactively-p 'interactive))
5188 (message "No URL known."))
5191 ;; We could combine multiple search results with set operations
5192 ;; AND, OR, MINUS, and NOT. Would this be useful?
5193 ;; How complicated are searches in real life?
5194 ;; We could also have other searches such as "publication year newer than...".
5195 (defun bibtex-search-entries (field regexp &optional global display)
5196 "Search BibTeX entries for FIELD matching REGEXP.
5197 REGEXP may be a regexp to search for.
5198 If REGEXP is a function, it is called for each entry with two args,
5199 the buffer positions of beginning and end of entry. Then an entry
5200 is accepted if this function returns non-nil.
5201 If FIELD is an empty string perform search for REGEXP in whole entry.
5202 With GLOBAL non-nil, search in `bibtex-files'. Otherwise the search
5203 is limited to the current buffer.
5204 If DISPLAY is non-nil, display search results in `bibtex-search-buffer'.
5205 When called interactively, DISPLAY is t.
5206 Also, GLOBAL is t if `bibtex-search-entry-globally' is non-nil.
5207 A prefix arg negates the value of `bibtex-search-entry-globally'.
5208 Return alist with elements (KEY FILE ENTRY),
5209 where FILE is the BibTeX file of ENTRY."
5211 (list (completing-read
5215 bibtex-user-optional-fields
5216 (mapcar (lambda (x) (mapcar 'car (apply 'append (nthcdr 2 x))))
5217 bibtex-entry-alist))) nil t)
5218 (read-string "Regexp: ")
5219 (if bibtex-search-entry-globally
5220 (not current-prefix-arg)
5223 (let ((funp (functionp regexp))
5225 ;; If REGEXP is a function, the value of FIELD is ignored anyway.
5226 ;; Yet to ensure the code below does not fail, we make FIELD
5227 ;; a non-empty string.
5228 (if (and funp (string= "" field)) (setq field "unrestricted"))
5229 (dolist (buffer (if (and global bibtex-files)
5230 (bibtex-initialize t)
5231 (list (current-buffer))))
5232 (with-current-buffer buffer
5233 (setq file (if buffer-file-name
5234 (file-name-nondirectory buffer-file-name)
5235 (buffer-name buffer)))
5237 (goto-char (point-min))
5238 (if (string= "" field)
5239 ;; Unrestricted search.
5240 (while (re-search-forward regexp nil t)
5241 (let ((beg (bibtex-beginning-of-entry))
5242 (end (bibtex-end-of-entry))
5244 (if (and (<= beg (match-beginning 0))
5245 (<= (match-end 0) end)
5248 (and (looking-at bibtex-entry-head)
5249 (setq key (bibtex-key-in-head))))
5250 (not (assoc key entries)))
5251 (push (list key file
5252 (buffer-substring-no-properties beg end))
5254 ;; The following is slow. But it works reliably even in more
5255 ;; complicated cases with BibTeX string constants and crossrefed
5256 ;; entries. If you prefer speed over reliability, perform an
5257 ;; unrestricted search.
5259 (lambda (key beg end)
5260 (if (and (cond (funp (funcall regexp beg end))
5261 ((and (setq text (bibtex-text-in-field field t))
5262 (string-match regexp text))))
5263 (not (assoc key entries)))
5264 (push (list key file
5265 (buffer-substring-no-properties beg end))
5269 (bibtex-display-entries entries)
5270 (message "No BibTeX entries %smatching `%s'"
5271 (if (string= "" field) ""
5272 (format "with field `%s' " field))
5276 (defun bibtex-display-entries (entries &optional append)
5277 "Display BibTeX ENTRIES in `bibtex-search-buffer'.
5278 ENTRIES is an alist with elements (KEY FILE ENTRY),
5279 where FILE is the BibTeX file of ENTRY.
5280 If APPEND is non-nil, append ENTRIES to those already displayed."
5281 (pop-to-buffer (get-buffer-create bibtex-search-buffer))
5282 ;; It would be nice if this buffer was editable, though editing
5283 ;; can be meaningful only for individual existing entries
5284 ;; (unlike reordering or creating new entries).
5285 ;; Fancy workaround: Editing commands in the virtual buffer could
5286 ;; jump to the real entry in the real buffer.
5287 (let (buffer-read-only)
5288 (if append (goto-char (point-max)) (erase-buffer))
5289 (dolist (entry (sort entries (lambda (x y) (string< (car x) (car y)))))
5290 (insert "% " (nth 1 entry) "\n" (nth 2 entry) "\n\n")))
5291 ;; `bibtex-sort-buffer' fails with the file names associated with
5292 ;; each entry. Prior to sorting we could make the file name
5293 ;; a BibTeX field of each entry (using `bibtex-make-field').
5294 ;; Or we could make it a text property that we unfold afterwards.
5295 ;; (bibtex-sort-buffer)
5297 (set-buffer-modified-p nil)
5298 (setq buffer-read-only t)
5299 (goto-char (point-min)))
5302 ;; Make BibTeX a Feature
5305 ;;; bibtex.el ends here