1 ;;; bibtex.el --- BibTeX mode for GNU Emacs
3 ;; Copyright (C) 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2003, 2004, 2005
4 ;; Free Software Foundation, Inc.
6 ;; Author: Stefan Schoef <schoef@offis.uni-oldenburg.de>
7 ;; Bengt Martensson <bengt@mathematik.uni-Bremen.de>
8 ;; Mark Shapiro <shapiro@corto.inria.fr>
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 <roland.winkler@physik.uni-erlangen.de>
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 2, or (at your option)
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; see the file COPYING. If not, write to the
29 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
30 ;; Boston, MA 02111-1307, USA.
34 ;; Major mode for editing and validating BibTeX files.
37 ;; See documentation for function bibtex-mode or type "\M-x describe-mode"
38 ;; when you are in BibTeX mode.
41 ;; Distribute texinfo file.
55 (defgroup bibtex-autokey nil
56 "Generate automatically a key from the author/editor and the title field"
58 :prefix
"bibtex-autokey-")
60 (defcustom bibtex-mode-hook nil
61 "List of functions to call on entry to BibTeX mode."
65 (defcustom bibtex-field-delimiters
'braces
66 "Type of field delimiters. Allowed values are `braces' or `double-quotes'."
68 :type
'(choice (const braces
)
69 (const double-quotes
)))
71 (defcustom bibtex-entry-delimiters
'braces
72 "Type of entry delimiters. Allowed values are `braces' or `parentheses'."
74 :type
'(choice (const braces
)
77 (defcustom bibtex-include-OPTcrossref
'("InProceedings" "InCollection")
78 "List of BibTeX entries that get an OPTcrossref field."
80 :type
'(repeat string
))
82 (defcustom bibtex-include-OPTkey t
83 "If non-nil, all newly created entries get an OPTkey field.
84 If this is a string, use it as the initial field text.
85 If this is a function, call it to generate the initial field text."
87 :type
'(choice (const :tag
"None" nil
)
88 (string :tag
"Initial text")
89 (function :tag
"Initialize Function" :value fun
)
90 (other :tag
"Default" t
)))
92 (defcustom bibtex-user-optional-fields
93 '(("annote" "Personal annotation (ignored)"))
94 "List of optional fields the user wants to have always present.
95 Entries should be of the same form as the OPTIONAL and
96 CROSSREF-OPTIONAL lists in `bibtex-entry-field-alist' (which see)."
98 :type
'(repeat (group (string :tag
"Field")
99 (string :tag
"Comment")
100 (option (group :inline t
102 (choice :tag
"Init" :value
""
106 (defcustom bibtex-entry-format
107 '(opts-or-alts required-fields numerical-fields
)
108 "Type of formatting performed by `bibtex-clean-entry'.
109 It may be t, nil, or a list of symbols out of the following:
110 opts-or-alts Delete empty optional and alternative fields and
111 remove OPT and ALT prefixes from used fields.
112 required-fields Signal an error if a required field is missing.
113 numerical-fields Delete delimiters around numeral fields.
114 page-dashes Change double dashes in page field to single dash
115 (for scribe compatibility).
116 inherit-booktitle If entry contains a crossref field and the booktitle
117 field is empty, set the booktitle field to the content
118 of the title field of the crossreferenced entry.
119 realign Realign entries, so that field texts and perhaps equal
120 signs (depending on the value of
121 `bibtex-align-at-equal-sign') begin in the same column.
122 last-comma Add or delete comma on end of last field in entry,
123 according to value of `bibtex-comma-after-last-field'.
124 delimiters Change delimiters according to variables
125 `bibtex-field-delimiters' and `bibtex-entry-delimiters'.
126 unify-case Change case of entry and field names.
128 The value t means do all of the above formatting actions.
129 The value nil means do no formatting at all."
131 :type
'(choice (const :tag
"None" nil
)
133 (set :menu-tag
"Some"
135 (const required-fields
)
136 (const numerical-fields
)
138 (const inherit-booktitle
)
142 (const unify-case
))))
144 (defcustom bibtex-clean-entry-hook nil
145 "List of functions to call when entry has been cleaned.
146 Functions are called with point inside the cleaned entry, and the buffer
147 narrowed to just the entry."
151 (defcustom bibtex-maintain-sorted-entries nil
152 "If non-nil, BibTeX mode maintains all entries in sorted order.
153 Allowed non-nil values are:
154 plain All entries are sorted alphabetically.
155 crossref All entries are sorted alphabetically unless an entry has a
156 crossref field. These crossrefed entries are placed in
157 alphabetical order immediately preceding the main entry.
158 entry-class The entries are divided into classes according to their
159 entry name, see `bibtex-sort-entry-class'. Within each class
160 the entries are sorted alphabetically.
161 See also `bibtex-sort-ignore-string-entries'."
163 :type
'(choice (const nil
)
166 (const entry-class
)))
168 (defcustom bibtex-sort-entry-class
171 ("Book" "Proceedings"))
172 "List of classes of BibTeX entry names, used for sorting entries.
173 If value of `bibtex-maintain-sorted-entries' is `entry-class'
174 entries are ordered according to the classes they belong to. Each
175 class contains a list of entry names. An entry `catch-all' applies
176 to all entries not explicitly mentioned."
178 :type
'(repeat (choice :tag
"Class"
179 (const :tag
"catch-all" (catch-all))
180 (repeat :tag
"Entry name" string
))))
182 (defcustom bibtex-sort-ignore-string-entries t
183 "If non-nil, BibTeX @String entries are not sort-significant.
184 That means they are ignored when determining ordering of the buffer
185 \(e.g., sorting, locating alphabetical position for new entries, etc.)."
189 (defcustom bibtex-field-kill-ring-max
20
190 "Max length of `bibtex-field-kill-ring' before discarding oldest elements."
194 (defcustom bibtex-entry-kill-ring-max
20
195 "Max length of `bibtex-entry-kill-ring' before discarding oldest elements."
199 (defcustom bibtex-parse-keys-timeout
60
200 "Time interval in seconds for parsing BibTeX buffers during idle time.
201 Parsing initializes `bibtex-reference-keys' and `bibtex-strings'."
205 (defcustom bibtex-parse-keys-fast t
206 "If non-nil, use fast but simplified algorithm for parsing BibTeX keys.
207 If parsing fails, try to set this variable to nil."
211 (defvar bibtex-entry-field-alist
213 ((("author" "Author1 [and Author2 ...] [and others]")
214 ("title" "Title of the article (BibTeX converts it to lowercase)")
215 ("journal" "Name of the journal (use string, remove braces)")
216 ("year" "Year of publication"))
217 (("volume" "Volume of the journal")
218 ("number" "Number of the journal (only allowed if entry contains volume)")
219 ("pages" "Pages in the journal")
220 ("month" "Month of the publication as a string (remove braces)")
221 ("note" "Remarks to be put at the end of the \\bibitem")))
222 ((("author" "Author1 [and Author2 ...] [and others]")
223 ("title" "Title of the article (BibTeX converts it to lowercase)"))
224 (("pages" "Pages in the journal")
225 ("journal" "Name of the journal (use string, remove braces)")
226 ("year" "Year of publication")
227 ("volume" "Volume of the journal")
228 ("number" "Number of the journal")
229 ("month" "Month of the publication as a string (remove braces)")
230 ("note" "Remarks to be put at the end of the \\bibitem"))))
232 ((("author" "Author1 [and Author2 ...] [and others]" nil t
)
233 ("editor" "Editor1 [and Editor2 ...] [and others]" nil t
)
234 ("title" "Title of the book")
235 ("publisher" "Publishing company")
236 ("year" "Year of publication"))
237 (("volume" "Volume of the book in the series")
238 ("number" "Number of the book in a small series (overwritten by volume)")
239 ("series" "Series in which the book appeared")
240 ("address" "Address of the publisher")
241 ("edition" "Edition of the book as a capitalized English word")
242 ("month" "Month of the publication as a string (remove braces)")
243 ("note" "Remarks to be put at the end of the \\bibitem")))
244 ((("author" "Author1 [and Author2 ...] [and others]" nil t
)
245 ("editor" "Editor1 [and Editor2 ...] [and others]" nil t
)
246 ("title" "Title of the book"))
247 (("publisher" "Publishing company")
248 ("year" "Year of publication")
249 ("volume" "Volume of the book in the series")
250 ("number" "Number of the book in a small series (overwritten by volume)")
251 ("series" "Series in which the book appeared")
252 ("address" "Address of the publisher")
253 ("edition" "Edition of the book as a capitalized English word")
254 ("month" "Month of the publication as a string (remove braces)")
255 ("note" "Remarks to be put at the end of the \\bibitem"))))
257 ((("title" "Title of the booklet (BibTeX converts it to lowercase)"))
258 (("author" "Author1 [and Author2 ...] [and others]")
259 ("howpublished" "The way in which the booklet was published")
260 ("address" "Address of the publisher")
261 ("month" "Month of the publication as a string (remove braces)")
262 ("year" "Year of publication")
263 ("note" "Remarks to be put at the end of the \\bibitem"))))
265 ((("author" "Author1 [and Author2 ...] [and others]" nil t
)
266 ("editor" "Editor1 [and Editor2 ...] [and others]" nil t
)
267 ("title" "Title of the book")
268 ("chapter" "Chapter in the book")
269 ("publisher" "Publishing company")
270 ("year" "Year of publication"))
271 (("volume" "Volume of the book in the series")
272 ("number" "Number of the book in a small series (overwritten by volume)")
273 ("series" "Series in which the book appeared")
274 ("type" "Word to use instead of \"chapter\"")
275 ("address" "Address of the publisher")
276 ("edition" "Edition of the book as a capitalized English word")
277 ("month" "Month of the publication as a string (remove braces)")
278 ("pages" "Pages in the book")
279 ("note" "Remarks to be put at the end of the \\bibitem")))
280 ((("author" "Author1 [and Author2 ...] [and others]" nil t
)
281 ("editor" "Editor1 [and Editor2 ...] [and others]" nil t
)
282 ("title" "Title of the book")
283 ("chapter" "Chapter in the book"))
284 (("pages" "Pages in the book")
285 ("publisher" "Publishing company")
286 ("year" "Year of publication")
287 ("volume" "Volume of the book in the series")
288 ("number" "Number of the book in a small series (overwritten by volume)")
289 ("series" "Series in which the book appeared")
290 ("type" "Word to use instead of \"chapter\"")
291 ("address" "Address of the publisher")
292 ("edition" "Edition of the book as a capitalized English word")
293 ("month" "Month of the publication as a string (remove braces)")
294 ("note" "Remarks to be put at the end of the \\bibitem"))))
296 ((("author" "Author1 [and Author2 ...] [and others]")
297 ("title" "Title of the article in book (BibTeX converts it to lowercase)")
298 ("booktitle" "Name of the book")
299 ("publisher" "Publishing company")
300 ("year" "Year of publication"))
301 (("editor" "Editor1 [and Editor2 ...] [and others]")
302 ("volume" "Volume of the book in the series")
303 ("number" "Number of the book in a small series (overwritten by volume)")
304 ("series" "Series in which the book appeared")
305 ("type" "Word to use instead of \"chapter\"")
306 ("chapter" "Chapter in the book")
307 ("pages" "Pages in the book")
308 ("address" "Address of the publisher")
309 ("edition" "Edition of the book as a capitalized English word")
310 ("month" "Month of the publication as a string (remove braces)")
311 ("note" "Remarks to be put at the end of the \\bibitem")))
312 ((("author" "Author1 [and Author2 ...] [and others]")
313 ("title" "Title of the article in book (BibTeX converts it to lowercase)")
314 ("booktitle" "Name of the book"))
315 (("pages" "Pages in the book")
316 ("publisher" "Publishing company")
317 ("year" "Year of publication")
318 ("editor" "Editor1 [and Editor2 ...] [and others]")
319 ("volume" "Volume of the book in the series")
320 ("number" "Number of the book in a small series (overwritten by volume)")
321 ("series" "Series in which the book appeared")
322 ("type" "Word to use instead of \"chapter\"")
323 ("chapter" "Chapter in the book")
324 ("address" "Address of the publisher")
325 ("edition" "Edition of the book as a capitalized English word")
326 ("month" "Month of the publication as a string (remove braces)")
327 ("note" "Remarks to be put at the end of the \\bibitem"))))
329 ((("author" "Author1 [and Author2 ...] [and others]")
330 ("title" "Title of the article in proceedings (BibTeX converts it to lowercase)")
331 ("booktitle" "Name of the conference proceedings")
332 ("year" "Year of publication"))
333 (("editor" "Editor1 [and Editor2 ...] [and others]")
334 ("volume" "Volume of the conference proceedings in the series")
335 ("number" "Number of the conference proceedings in a small series (overwritten by volume)")
336 ("series" "Series in which the conference proceedings appeared")
337 ("pages" "Pages in the conference proceedings")
338 ("address" "Location of the Proceedings")
339 ("month" "Month of the publication as a string (remove braces)")
340 ("organization" "Sponsoring organization of the conference")
341 ("publisher" "Publishing company, its location")
342 ("note" "Remarks to be put at the end of the \\bibitem")))
343 ((("author" "Author1 [and Author2 ...] [and others]")
344 ("title" "Title of the article in proceedings (BibTeX converts it to lowercase)"))
345 (("booktitle" "Name of the conference proceedings")
346 ("pages" "Pages in the conference proceedings")
347 ("year" "Year of publication")
348 ("editor" "Editor1 [and Editor2 ...] [and others]")
349 ("volume" "Volume of the conference proceedings in the series")
350 ("number" "Number of the conference proceedings in a small series (overwritten by volume)")
351 ("series" "Series in which the conference proceedings appeared")
352 ("address" "Location of the Proceedings")
353 ("month" "Month of the publication as a string (remove braces)")
354 ("organization" "Sponsoring organization of the conference")
355 ("publisher" "Publishing company, its location")
356 ("note" "Remarks to be put at the end of the \\bibitem"))))
358 ((("title" "Title of the manual"))
359 (("author" "Author1 [and Author2 ...] [and others]")
360 ("organization" "Publishing organization of the manual")
361 ("address" "Address of the organization")
362 ("edition" "Edition of the manual as a capitalized English word")
363 ("month" "Month of the publication as a string (remove braces)")
364 ("year" "Year of publication")
365 ("note" "Remarks to be put at the end of the \\bibitem"))))
367 ((("author" "Author1 [and Author2 ...] [and others]")
368 ("title" "Title of the master\'s thesis (BibTeX converts it to lowercase)")
369 ("school" "School where the master\'s thesis was written")
370 ("year" "Year of publication"))
371 (("type" "Type of the master\'s thesis (if other than \"Master\'s thesis\")")
372 ("address" "Address of the school (if not part of field \"school\") or country")
373 ("month" "Month of the publication as a string (remove braces)")
374 ("note" "Remarks to be put at the end of the \\bibitem"))))
377 (("author" "Author1 [and Author2 ...] [and others]")
378 ("title" "Title of the work (BibTeX converts it to lowercase)")
379 ("howpublished" "The way in which the work was published")
380 ("month" "Month of the publication as a string (remove braces)")
381 ("year" "Year of publication")
382 ("note" "Remarks to be put at the end of the \\bibitem"))))
384 ((("author" "Author1 [and Author2 ...] [and others]")
385 ("title" "Title of the PhD. thesis")
386 ("school" "School where the PhD. thesis was written")
387 ("year" "Year of publication"))
388 (("type" "Type of the PhD. thesis")
389 ("address" "Address of the school (if not part of field \"school\") or country")
390 ("month" "Month of the publication as a string (remove braces)")
391 ("note" "Remarks to be put at the end of the \\bibitem"))))
393 ((("title" "Title of the conference proceedings")
394 ("year" "Year of publication"))
395 (("booktitle" "Title of the proceedings for cross references")
396 ("editor" "Editor1 [and Editor2 ...] [and others]")
397 ("volume" "Volume of the conference proceedings in the series")
398 ("number" "Number of the conference proceedings in a small series (overwritten by volume)")
399 ("series" "Series in which the conference proceedings appeared")
400 ("address" "Location of the Proceedings")
401 ("month" "Month of the publication as a string (remove braces)")
402 ("organization" "Sponsoring organization of the conference")
403 ("publisher" "Publishing company, its location")
404 ("note" "Remarks to be put at the end of the \\bibitem"))))
406 ((("author" "Author1 [and Author2 ...] [and others]")
407 ("title" "Title of the technical report (BibTeX converts it to lowercase)")
408 ("institution" "Sponsoring institution of the report")
409 ("year" "Year of publication"))
410 (("type" "Type of the report (if other than \"technical report\")")
411 ("number" "Number of the technical report")
412 ("address" "Address of the institution (if not part of field \"institution\") or country")
413 ("month" "Month of the publication as a string (remove braces)")
414 ("note" "Remarks to be put at the end of the \\bibitem"))))
416 ((("author" "Author1 [and Author2 ...] [and others]")
417 ("title" "Title of the unpublished work (BibTeX converts it to lowercase)")
418 ("note" "Remarks to be put at the end of the \\bibitem"))
419 (("month" "Month of the publication as a string (remove braces)")
420 ("year" "Year of publication")))))
422 "List of BibTeX entry types and their associated fields.
423 List elements are triples
424 \(ENTRY-NAME (REQUIRED OPTIONAL) (CROSSREF-REQUIRED CROSSREF-OPTIONAL)).
425 ENTRY-NAME is the name of a BibTeX entry. The remaining pairs contain
426 the required and optional fields of the BibTeX entry.
427 The second pair is used if a crossref field is present
428 and the first pair is used if a crossref field is absent.
429 If the second pair is nil, the first pair is always used.
430 REQUIRED, OPTIONAL, CROSSREF-REQUIRED and CROSSREF-OPTIONAL are lists.
431 Each element of these lists is a list of the form
432 \(FIELD-NAME COMMENT-STRING INIT ALTERNATIVE-FLAG).
433 COMMENT-STRING, INIT, and ALTERNATIVE-FLAG are optional.
434 FIELD-NAME is the name of the field, COMMENT-STRING is the comment that
435 appears in the echo area, INIT is either the initial content of the
436 field or a function, which is called to determine the initial content
437 of the field, and ALTERNATIVE-FLAG (either nil or t) marks if the
438 field is an alternative. ALTERNATIVE-FLAG may be t only in the
439 REQUIRED or CROSSREF-REQUIRED lists.")
441 (defcustom bibtex-comment-start
"@Comment"
442 "String starting a BibTeX comment."
446 (defcustom bibtex-add-entry-hook nil
447 "List of functions to call when BibTeX entry has been inserted."
451 (defcustom bibtex-predefined-month-strings
452 '(("jan" .
"January")
460 ("sep" .
"September")
463 ("dec" .
"December"))
464 "Alist of month string definitions used in the BibTeX style files.
465 Each element is a pair of strings (ABBREVIATION . EXPANSION)."
467 :type
'(repeat (cons (string :tag
"Month abbreviation")
468 (string :tag
"Month expansion"))))
470 (defcustom bibtex-predefined-strings
472 bibtex-predefined-month-strings
473 '(("acmcs" .
"ACM Computing Surveys")
474 ("acta" .
"Acta Informatica")
475 ("cacm" .
"Communications of the ACM")
476 ("ibmjrd" .
"IBM Journal of Research and Development")
477 ("ibmsj" .
"IBM Systems Journal")
478 ("ieeese" .
"IEEE Transactions on Software Engineering")
479 ("ieeetc" .
"IEEE Transactions on Computers")
480 ("ieeetcad" .
"IEEE Transactions on Computer-Aided Design of Integrated Circuits")
481 ("ipl" .
"Information Processing Letters")
482 ("jacm" .
"Journal of the ACM")
483 ("jcss" .
"Journal of Computer and System Sciences")
484 ("scp" .
"Science of Computer Programming")
485 ("sicomp" .
"SIAM Journal on Computing")
486 ("tcs" .
"Theoretical Computer Science")
487 ("tocs" .
"ACM Transactions on Computer Systems")
488 ("tods" .
"ACM Transactions on Database Systems")
489 ("tog" .
"ACM Transactions on Graphics")
490 ("toms" .
"ACM Transactions on Mathematical Software")
491 ("toois" .
"ACM Transactions on Office Information Systems")
492 ("toplas" .
"ACM Transactions on Programming Languages and Systems")))
493 "Alist of string definitions used in the BibTeX style files.
494 Each element is a pair of strings (ABBREVIATION . EXPANSION)."
496 :type
'(repeat (cons (string :tag
"String")
497 (string :tag
"String expansion"))))
499 (defcustom bibtex-string-files nil
500 "List of BibTeX files containing string definitions.
501 List elements can be absolute file names or file names relative
502 to the directories specified in `bibtex-string-file-path'."
504 :type
'(repeat file
))
506 (defvar bibtex-string-file-path
(getenv "BIBINPUTS")
507 "*Colon separated list of paths to search for `bibtex-string-files'.")
509 (defcustom bibtex-files nil
510 "List of BibTeX files that are searched for entry keys.
511 List elements can be absolute file names or file names relative to the
512 directories specified in `bibtex-file-path'. If an element is a directory,
513 check all BibTeX files in this directory. If an element is the symbol
514 `bibtex-file-path', check all BibTeX files in `bibtex-file-path'."
516 :type
'(repeat file
))
518 (defvar bibtex-file-path
(getenv "BIBINPUTS")
519 "*Colon separated list of paths to search for `bibtex-files'.")
521 (defcustom bibtex-help-message t
522 "If non-nil print help messages in the echo area on entering a new field."
526 (defcustom bibtex-autokey-prefix-string
""
527 "String prefix for automatically generated reference keys.
528 See `bibtex-generate-autokey' for details."
529 :group
'bibtex-autokey
532 (defcustom bibtex-autokey-names
1
533 "Number of names to use for the automatically generated reference key.
534 Possibly more names are used according to `bibtex-autokey-names-stretch'.
535 If this variable is nil, all names are used.
536 See `bibtex-generate-autokey' for details."
537 :group
'bibtex-autokey
538 :type
'(choice (const :tag
"All" infty
)
541 (defcustom bibtex-autokey-names-stretch
0
542 "Number of names that can additionally be used for reference keys.
543 These names are used only, if all names are used then.
544 See `bibtex-generate-autokey' for details."
545 :group
'bibtex-autokey
548 (defcustom bibtex-autokey-additional-names
""
549 "String to append to the generated key if not all names could be used.
550 See `bibtex-generate-autokey' for details."
551 :group
'bibtex-autokey
554 (defvar bibtex-autokey-transcriptions
555 '(;; language specific characters
556 ("\\\\aa" .
"a") ; \aa -> a
557 ("\\\\AA" .
"A") ; \AA -> A
558 ("\\\"a\\|\\\\\\\"a\\|\\\\ae" .
"ae") ; "a,\"a,\ae -> ae
559 ("\\\"A\\|\\\\\\\"A\\|\\\\AE" .
"Ae") ; "A,\"A,\AE -> Ae
560 ("\\\\i" .
"i") ; \i -> i
561 ("\\\\j" .
"j") ; \j -> j
562 ("\\\\l" .
"l") ; \l -> l
563 ("\\\\L" .
"L") ; \L -> L
564 ("\\\"o\\|\\\\\\\"o\\|\\\\o\\|\\\\oe" .
"oe") ; "o,\"o,\o,\oe -> oe
565 ("\\\"O\\|\\\\\\\"O\\|\\\\O\\|\\\\OE" .
"Oe") ; "O,\"O,\O,\OE -> Oe
566 ("\\\"s\\|\\\\\\\"s\\|\\\\3" .
"ss") ; "s,\"s,\3 -> ss
567 ("\\\"u\\|\\\\\\\"u" .
"ue") ; "u,\"u -> ue
568 ("\\\"U\\|\\\\\\\"U" .
"Ue") ; "U,\"U -> Ue
570 ("\\\\`\\|\\\\'\\|\\\\\\^\\|\\\\~\\|\\\\=\\|\\\\\\.\\|\\\\u\\|\\\\v\\|\\\\H\\|\\\\t\\|\\\\c\\|\\\\d\\|\\\\b" .
"")
571 ;; braces, quotes, concatenation.
574 ("\\\\?[ \t\n]+\\|~" .
" "))
575 "Alist of (OLD-REGEXP . NEW-STRING) pairs.
576 Used by the default values of `bibtex-autokey-name-change-strings' and
577 `bibtex-autokey-titleword-change-strings'. Defaults to translating some
578 language specific characters to their ASCII transcriptions, and
579 removing any character accents.")
581 (defcustom bibtex-autokey-name-change-strings
582 bibtex-autokey-transcriptions
583 "Alist of (OLD-REGEXP . NEW-STRING) pairs.
584 Any part of a name matching OLD-REGEXP is replaced by NEW-STRING.
585 Case is significant in OLD-REGEXP. All regexps are tried in the
586 order in which they appear in the list.
587 See `bibtex-generate-autokey' for details."
588 :group
'bibtex-autokey
589 :type
'(repeat (cons (regexp :tag
"Old")
590 (string :tag
"New"))))
592 (defcustom bibtex-autokey-name-case-convert
'downcase
593 "Function called for each name to perform case conversion.
594 See `bibtex-generate-autokey' for details."
595 :group
'bibtex-autokey
596 :type
'(choice (const :tag
"Preserve case" identity
)
597 (const :tag
"Downcase" downcase
)
598 (const :tag
"Capitalize" capitalize
)
599 (const :tag
"Upcase" upcase
)
600 (function :tag
"Conversion function")))
602 (defcustom bibtex-autokey-name-length
'infty
603 "Number of characters from name to incorporate into key.
604 If this is set to anything but a number, all characters are used.
605 See `bibtex-generate-autokey' for details."
606 :group
'bibtex-autokey
607 :type
'(choice (const :tag
"All" infty
)
610 (defcustom bibtex-autokey-name-separator
""
611 "String that comes between any two names in the key.
612 See `bibtex-generate-autokey' for details."
613 :group
'bibtex-autokey
616 (defcustom bibtex-autokey-year-length
2
617 "Number of rightmost digits from the year field to incorporate into key.
618 See `bibtex-generate-autokey' for details."
619 :group
'bibtex-autokey
622 (defcustom bibtex-autokey-use-crossref t
623 "If non-nil use fields from crossreferenced entry if necessary.
624 If this variable is non-nil and some field has no entry, but a
625 valid crossref entry, the field from the crossreferenced entry is used.
626 See `bibtex-generate-autokey' for details."
627 :group
'bibtex-autokey
630 (defcustom bibtex-autokey-titlewords
5
631 "Number of title words to use for the automatically generated reference key.
632 If this is set to anything but a number, all title words are used.
633 Possibly more words from the title are used according to
634 `bibtex-autokey-titlewords-stretch'.
635 See `bibtex-generate-autokey' for details."
636 :group
'bibtex-autokey
637 :type
'(choice (const :tag
"All" infty
)
640 (defcustom bibtex-autokey-title-terminators
"[.!?:;]\\|--"
641 "Regexp defining the termination of the main part of the title.
642 Case of the regexps is ignored. See `bibtex-generate-autokey' for details."
643 :group
'bibtex-autokey
646 (defcustom bibtex-autokey-titlewords-stretch
2
647 "Number of words that can additionally be used from the title.
648 These words are used only, if a sentence from the title can be ended then.
649 See `bibtex-generate-autokey' for details."
650 :group
'bibtex-autokey
653 (defcustom bibtex-autokey-titleword-ignore
654 '("A" "An" "On" "The" "Eine?" "Der" "Die" "Das"
655 "[^[:upper:]].*" ".*[^[:upper:]0-9].*")
656 "Determines words from the title that are not to be used in the key.
657 Each item of the list is a regexp. If a word of the title matches a
658 regexp from that list, it is not included in the title part of the key.
659 See `bibtex-generate-autokey' for details."
660 :group
'bibtex-autokey
661 :type
'(repeat regexp
))
663 (defcustom bibtex-autokey-titleword-case-convert
'downcase
664 "Function called for each titleword to perform case conversion.
665 See `bibtex-generate-autokey' for details."
666 :group
'bibtex-autokey
667 :type
'(choice (const :tag
"Preserve case" identity
)
668 (const :tag
"Downcase" downcase
)
669 (const :tag
"Capitalize" capitalize
)
670 (const :tag
"Upcase" upcase
)
671 (function :tag
"Conversion function")))
673 (defcustom bibtex-autokey-titleword-abbrevs nil
674 "Determines exceptions to the usual abbreviation mechanism.
675 An alist of (OLD-REGEXP . NEW-STRING) pairs. Case is ignored
676 in matching against OLD-REGEXP, and the first matching pair is used.
677 See `bibtex-generate-autokey' for details."
678 :group
'bibtex-autokey
679 :type
'(repeat (cons (regexp :tag
"Old")
680 (string :tag
"New"))))
682 (defcustom bibtex-autokey-titleword-change-strings
683 bibtex-autokey-transcriptions
684 "Alist of (OLD-REGEXP . NEW-STRING) pairs.
685 Any part of title word matching a OLD-REGEXP is replaced by NEW-STRING.
686 Case is significant in OLD-REGEXP. All regexps are tried in the
687 order in which they appear in the list.
688 See `bibtex-generate-autokey' for details."
689 :group
'bibtex-autokey
690 :type
'(repeat (cons (regexp :tag
"Old")
691 (string :tag
"New"))))
693 (defcustom bibtex-autokey-titleword-length
5
694 "Number of characters from title words to incorporate into key.
695 If this is set to anything but a number, all characters are used.
696 See `bibtex-generate-autokey' for details."
697 :group
'bibtex-autokey
698 :type
'(choice (const :tag
"All" infty
)
701 (defcustom bibtex-autokey-titleword-separator
"_"
702 "String to be put between the title words.
703 See `bibtex-generate-autokey' for details."
704 :group
'bibtex-autokey
707 (defcustom bibtex-autokey-name-year-separator
""
708 "String to be put between name part and year part of key.
709 See `bibtex-generate-autokey' for details."
710 :group
'bibtex-autokey
713 (defcustom bibtex-autokey-year-title-separator
":_"
714 "String to be put between name part and year part of key.
715 See `bibtex-generate-autokey' for details."
716 :group
'bibtex-autokey
719 (defcustom bibtex-autokey-edit-before-use t
720 "If non-nil, user is allowed to edit the generated key before it is used."
721 :group
'bibtex-autokey
724 (defcustom bibtex-autokey-before-presentation-function nil
725 "If non-nil, function to call before generated key is presented.
726 The function must take one argument (the automatically generated key),
727 and must return a string (the key to use)."
728 :group
'bibtex-autokey
729 :type
'(choice (const nil
) function
))
731 (defcustom bibtex-entry-offset
0
732 "Offset for BibTeX entries.
733 Added to the value of all other variables which determine columns."
737 (defcustom bibtex-field-indentation
2
738 "Starting column for the name part in BibTeX fields."
742 (defcustom bibtex-text-indentation
743 (+ bibtex-field-indentation
744 (length "organization = "))
745 "Starting column for the text part in BibTeX fields.
746 Should be equal to the space needed for the longest name part."
750 (defcustom bibtex-contline-indentation
751 (+ bibtex-text-indentation
1)
752 "Starting column for continuation lines of BibTeX fields."
756 (defcustom bibtex-align-at-equal-sign nil
757 "If non-nil, align fields at equal sign instead of field text.
758 If non-nil, the column for the equal sign is the value of
759 `bibtex-text-indentation', minus 2."
763 (defcustom bibtex-comma-after-last-field nil
764 "If non-nil, a comma is put at end of last field in the entry template."
768 (defcustom bibtex-autoadd-commas t
769 "If non-nil automatically add missing commas at end of BibTeX fields."
773 (defcustom bibtex-autofill-types
'("Proceedings")
774 "Automatically fill fields if possible for those BibTeX entry types."
776 :type
'(repeat string
))
778 (defcustom bibtex-summary-function
'bibtex-summary
779 "Function to call for generating a summary of current BibTeX entry.
780 It takes no arguments. Point must be at beginning of entry.
781 Used by `bibtex-complete-crossref-cleanup' and `bibtex-copy-summary-as-kill'."
783 :type
'(choice (const :tag
"Default" bibtex-summary
)
784 (function :tag
"Personalized function")))
786 (defcustom bibtex-generate-url-list
787 '((("url" .
".*:.*")))
788 "List of schemes for generating the URL of a BibTeX entry.
789 These schemes are used by `bibtex-url'.
791 Each scheme should have one of these forms:
794 ((FIELD . REGEXP) STEP...)
795 ((FIELD . REGEXP) STRING STEP...)
797 FIELD is a field name as returned by `bibtex-parse-entry'.
798 REGEXP is matched against the text of FIELD. If the match succeeds,
799 then this scheme is used. If no STRING and STEPs are specified
800 the matched text is used as the URL, otherwise the URL is built
801 by evaluating STEPs. If no STRING is specified the STEPs must result
802 in strings which are concatenated. Otherwise the resulting objects
803 are passed through `format' using STRING as format control string.
805 A STEP is a list (FIELD REGEXP REPLACE). The text of FIELD
806 is matched against REGEXP, and is replaced with REPLACE.
807 REPLACE can be a string, or a number (which selects the corresponding
808 submatch), or a function called with the field's text as argument
809 and with the `match-data' properly set.
811 Case is always ignored. Always remove the field delimiters.
813 The following is a complex example, see http://link.aps.org/linkfaq.html.
815 (((\"journal\" . \"\\\\=<\\(PR[ABCDEL]?\\|RMP\\)\\\\=>\")
816 \"http://link.aps.org/abstract/%s/v%s/p%s\"
817 (\"journal\" \".*\" downcase)
818 (\"volume\" \".*\" 0)
819 (\"pages\" \"\\`[A-Z]?[0-9]+\" 0)))"
823 (cons :tag
"Matcher" :extra-offset
4
824 (string :tag
"BibTeX field")
825 (regexp :tag
"Regexp"))
827 (const :tag
"Take match as is" nil
)
828 (cons :tag
"Formatted"
829 (string :tag
"Format control string")
830 (repeat :tag
"Steps to generate URL"
831 (list (string :tag
"BibTeX field")
832 (regexp :tag
"Regexp")
833 (choice (string :tag
"Replacement")
834 (integer :tag
"Sub-match")
835 (function :tag
"Filter")))))
836 (repeat :tag
"Concatenated"
837 (list (string :tag
"BibTeX field")
838 (regexp :tag
"Regexp")
839 (choice (string :tag
"Replacement")
840 (integer :tag
"Sub-match")
841 (function :tag
"Filter"))))))))
843 ;; bibtex-font-lock-keywords is a user option as well, but since the
844 ;; patterns used to define this variable are defined in a later
845 ;; section of this file, it is defined later.
848 ;; Syntax Table, Keybindings and BibTeX Entry List
849 (defvar bibtex-mode-syntax-table
850 (let ((st (make-syntax-table)))
851 (modify-syntax-entry ?
\" "\"" st
)
852 (modify-syntax-entry ?$
"$$ " st
)
853 (modify-syntax-entry ?%
"< " st
)
854 (modify-syntax-entry ?
' "w " st
)
855 (modify-syntax-entry ?
@ "w " st
)
856 (modify-syntax-entry ?
\\ "\\" st
)
857 (modify-syntax-entry ?
\f "> " st
)
858 (modify-syntax-entry ?
\n "> " st
)
859 ;; Keys cannot have = in them (wrong font-lock of @string{foo=bar}).
860 (modify-syntax-entry ?
= "." st
)
861 (modify-syntax-entry ?~
" " st
)
863 "Syntax table used in BibTeX mode buffers.")
865 (defvar bibtex-mode-map
866 (let ((km (make-sparse-keymap)))
867 ;; The Key `C-c&' is reserved for reftex.el
868 (define-key km
"\t" 'bibtex-find-text
)
869 (define-key km
"\n" 'bibtex-next-field
)
870 (define-key km
"\M-\t" 'bibtex-complete
)
871 (define-key km
"\C-c\"" 'bibtex-remove-delimiters
)
872 (define-key km
"\C-c{" 'bibtex-remove-delimiters
)
873 (define-key km
"\C-c}" 'bibtex-remove-delimiters
)
874 (define-key km
"\C-c\C-c" 'bibtex-clean-entry
)
875 (define-key km
"\C-c\C-q" 'bibtex-fill-entry
)
876 (define-key km
"\C-c\C-s" 'bibtex-find-entry
)
877 (define-key km
"\C-c\C-x" 'bibtex-find-crossref
)
878 (define-key km
"\C-c\C-t" 'bibtex-copy-summary-as-kill
)
879 (define-key km
"\C-c?" 'bibtex-print-help-message
)
880 (define-key km
"\C-c\C-p" 'bibtex-pop-previous
)
881 (define-key km
"\C-c\C-n" 'bibtex-pop-next
)
882 (define-key km
"\C-c\C-k" 'bibtex-kill-field
)
883 (define-key km
"\C-c\M-k" 'bibtex-copy-field-as-kill
)
884 (define-key km
"\C-c\C-w" 'bibtex-kill-entry
)
885 (define-key km
"\C-c\M-w" 'bibtex-copy-entry-as-kill
)
886 (define-key km
"\C-c\C-y" 'bibtex-yank
)
887 (define-key km
"\C-c\M-y" 'bibtex-yank-pop
)
888 (define-key km
"\C-c\C-d" 'bibtex-empty-field
)
889 (define-key km
"\C-c\C-f" 'bibtex-make-field
)
890 (define-key km
"\C-c\C-u" 'bibtex-entry-update
)
891 (define-key km
"\C-c$" 'bibtex-ispell-abstract
)
892 (define-key km
"\M-\C-a" 'bibtex-beginning-of-entry
)
893 (define-key km
"\M-\C-e" 'bibtex-end-of-entry
)
894 (define-key km
"\C-\M-l" 'bibtex-reposition-window
)
895 (define-key km
"\C-\M-h" 'bibtex-mark-entry
)
896 (define-key km
"\C-c\C-b" 'bibtex-entry
)
897 (define-key km
"\C-c\C-rn" 'bibtex-narrow-to-entry
)
898 (define-key km
"\C-c\C-rw" 'widen
)
899 (define-key km
"\C-c\C-l" 'bibtex-url
)
900 (define-key km
"\C-c\C-o" 'bibtex-remove-OPT-or-ALT
)
901 (define-key km
"\C-c\C-e\C-i" 'bibtex-InProceedings
)
902 (define-key km
"\C-c\C-ei" 'bibtex-InCollection
)
903 (define-key km
"\C-c\C-eI" 'bibtex-InBook
)
904 (define-key km
"\C-c\C-e\C-a" 'bibtex-Article
)
905 (define-key km
"\C-c\C-e\C-b" 'bibtex-InBook
)
906 (define-key km
"\C-c\C-eb" 'bibtex-Book
)
907 (define-key km
"\C-c\C-eB" 'bibtex-Booklet
)
908 (define-key km
"\C-c\C-e\C-c" 'bibtex-InCollection
)
909 (define-key km
"\C-c\C-e\C-m" 'bibtex-Manual
)
910 (define-key km
"\C-c\C-em" 'bibtex-MastersThesis
)
911 (define-key km
"\C-c\C-eM" 'bibtex-Misc
)
912 (define-key km
"\C-c\C-e\C-p" 'bibtex-InProceedings
)
913 (define-key km
"\C-c\C-ep" 'bibtex-Proceedings
)
914 (define-key km
"\C-c\C-eP" 'bibtex-PhdThesis
)
915 (define-key km
"\C-c\C-e\M-p" 'bibtex-Preamble
)
916 (define-key km
"\C-c\C-e\C-s" 'bibtex-String
)
917 (define-key km
"\C-c\C-e\C-t" 'bibtex-TechReport
)
918 (define-key km
"\C-c\C-e\C-u" 'bibtex-Unpublished
)
920 "Keymap used in BibTeX mode.")
923 bibtex-edit-menu bibtex-mode-map
"BibTeX-Edit Menu in BibTeX mode"
925 ("Moving inside an Entry"
926 ["End of Field" bibtex-find-text t
]
927 ["Next Field" bibtex-next-field t
]
928 ["Beginning of Entry" bibtex-beginning-of-entry t
]
929 ["End of Entry" bibtex-end-of-entry t
]
931 ["Make Entry Visible" bibtex-reposition-window t
])
932 ("Moving in BibTeX Buffers"
933 ["Find Entry" bibtex-find-entry t
]
934 ["Find Crossref Entry" bibtex-find-crossref t
])
936 ("Operating on Current Field"
937 ["Fill Field" fill-paragraph t
]
938 ["Remove Delimiters" bibtex-remove-delimiters t
]
939 ["Remove OPT or ALT Prefix" bibtex-remove-OPT-or-ALT t
]
940 ["Clear Field" bibtex-empty-field t
]
942 ["Kill Field" bibtex-kill-field t
]
943 ["Copy Field to Kill Ring" bibtex-copy-field-as-kill t
]
944 ["Paste Most Recently Killed Field" bibtex-yank t
]
945 ["Paste Previously Killed Field" bibtex-yank-pop t
]
947 ["Make New Field" bibtex-make-field t
]
949 ["Snatch from Similar Following Field" bibtex-pop-next t
]
950 ["Snatch from Similar Preceding Field" bibtex-pop-previous t
]
952 ["String or Key Complete" bibtex-complete t
]
954 ["Help about Current Field" bibtex-print-help-message t
])
955 ("Operating on Current Entry"
956 ["Fill Entry" bibtex-fill-entry t
]
957 ["Clean Entry" bibtex-clean-entry t
]
958 ["Update Entry" bibtex-entry-update t
]
960 ["Kill Entry" bibtex-kill-entry t
]
961 ["Copy Entry to Kill Ring" bibtex-copy-entry-as-kill t
]
962 ["Paste Most Recently Killed Entry" bibtex-yank t
]
963 ["Paste Previously Killed Entry" bibtex-yank-pop t
]
965 ["Copy Summary to Kill Ring" bibtex-copy-summary-as-kill t
]
966 ["Browse URL" bibtex-url t
]
968 ["Ispell Entry" bibtex-ispell-entry t
]
969 ["Ispell Entry Abstract" bibtex-ispell-abstract t
]
971 ["Narrow to Entry" bibtex-narrow-to-entry t
]
972 ["Mark Entry" bibtex-mark-entry t
]
974 ["View Cite Locations (RefTeX)" reftex-view-crossref-from-bibtex
975 (fboundp 'reftex-view-crossref-from-bibtex
)])
976 ("Operating on Buffer or Region"
977 ["Validate Entries" bibtex-validate t
]
978 ["Sort Entries" bibtex-sort-buffer t
]
979 ["Reformat Entries" bibtex-reformat t
]
980 ["Count Entries" bibtex-count-entries t
]
982 ["Convert Alien Buffer" bibtex-convert-alien t
])
983 ("Operating on Multiple Buffers"
984 ["Validate Entries" bibtex-validate-globally t
])))
987 bibtex-entry-menu bibtex-mode-map
"Entry-Types Menu in BibTeX mode"
989 ["Article in Journal" bibtex-Article t
]
990 ["Article in Conference Proceedings" bibtex-InProceedings t
]
991 ["Article in a Collection" bibtex-InCollection t
]
992 ["Chapter or Pages in a Book" bibtex-InBook t
]
993 ["Conference Proceedings" bibtex-Proceedings t
]
994 ["Book" bibtex-Book t
]
995 ["Booklet (Bound, but no Publisher/Institution)" bibtex-Booklet t
]
996 ["PhD. Thesis" bibtex-PhdThesis t
]
997 ["Master's Thesis" bibtex-MastersThesis t
]
998 ["Technical Report" bibtex-TechReport t
]
999 ["Technical Manual" bibtex-Manual t
]
1000 ["Unpublished" bibtex-Unpublished t
]
1001 ["Miscellaneous" bibtex-Misc t
]
1003 ["String" bibtex-String t
]
1004 ["Preamble" bibtex-Preamble t
]))
1007 ;; Internal Variables
1009 (defvar bibtex-pop-previous-search-point nil
1010 "Next point where `bibtex-pop-previous' starts looking for a similar entry.")
1012 (defvar bibtex-pop-next-search-point nil
1013 "Next point where `bibtex-pop-next' starts looking for a similar entry.")
1015 (defvar bibtex-field-kill-ring nil
1016 "Ring of least recently killed fields.
1017 At most `bibtex-field-kill-ring-max' items are kept here.")
1019 (defvar bibtex-field-kill-ring-yank-pointer nil
1020 "The tail of `bibtex-field-kill-ring' whose car is the last item yanked.")
1022 (defvar bibtex-entry-kill-ring nil
1023 "Ring of least recently killed entries.
1024 At most `bibtex-entry-kill-ring-max' items are kept here.")
1026 (defvar bibtex-entry-kill-ring-yank-pointer nil
1027 "The tail of `bibtex-entry-kill-ring' whose car is the last item yanked.")
1029 (defvar bibtex-last-kill-command nil
1030 "Type of the last kill command (either 'field or 'entry).")
1032 (defvar bibtex-strings
1033 (lazy-completion-table bibtex-strings
1034 bibtex-parse-strings
(bibtex-string-files-init))
1035 "Completion table for BibTeX string keys.
1036 Initialized from `bibtex-predefined-strings' and `bibtex-string-files'.")
1037 (make-variable-buffer-local 'bibtex-strings
)
1039 (defvar bibtex-reference-keys
1040 (lazy-completion-table bibtex-reference-keys bibtex-parse-keys nil t
)
1041 "Completion table for BibTeX reference keys.
1042 The CDRs of the elements are t for header keys and nil for crossref keys.")
1043 (make-variable-buffer-local 'bibtex-reference-keys
)
1045 (defvar bibtex-buffer-last-parsed-tick nil
1046 "Value of `buffer-modified-tick' last time buffer was parsed for keys.")
1048 (defvar bibtex-parse-idle-timer nil
1049 "Stores if timer is already installed.")
1051 (defvar bibtex-progress-lastperc nil
1052 "Last reported percentage for the progress message.")
1054 (defvar bibtex-progress-lastmes nil
1055 "Last reported progress message.")
1057 (defvar bibtex-progress-interval nil
1058 "Interval for progress messages.")
1060 (defvar bibtex-key-history nil
1061 "History list for reading keys.")
1063 (defvar bibtex-entry-type-history nil
1064 "History list for reading entry types.")
1066 (defvar bibtex-field-history nil
1067 "History list for reading field names.")
1069 (defvar bibtex-reformat-previous-options nil
1070 "Last reformat options given.")
1072 (defvar bibtex-reformat-previous-reference-keys nil
1073 "Last reformat reference keys option given.")
1075 (defconst bibtex-field-name
"[^\"#%'(),={} \t\n0-9][^\"#%'(),={} \t\n]*"
1076 "Regexp matching the name part of a BibTeX field.")
1078 (defconst bibtex-entry-type
(concat "@" bibtex-field-name
)
1079 "Regexp matching the type part of a BibTeX entry.")
1081 (defconst bibtex-reference-key
"[][[:alnum:].:;?!`'/*@+|()<>&_^$-]+"
1082 "Regexp matching the reference key part of a BibTeX entry.")
1084 (defconst bibtex-field-const
"[][[:alnum:].:;?!`'/*@+=|<>&_^$-]+"
1085 "Regexp matching a BibTeX field constant.")
1087 (defconst bibtex-entry-head
1088 (concat "^[ \t]*\\("
1090 "\\)[ \t]*[({][ \t\n]*\\("
1091 bibtex-reference-key
1093 "Regexp matching the header line of a BibTeX entry.")
1095 (defconst bibtex-entry-maybe-empty-head
1096 (concat bibtex-entry-head
"?")
1097 "Regexp matching the header line of a BibTeX entry (possibly without key).")
1099 (defconst bibtex-type-in-head
1
1100 "Regexp subexpression number of the type part in `bibtex-entry-head'.")
1102 (defconst bibtex-key-in-head
2
1103 "Regexp subexpression number of the key part in `bibtex-entry-head'.")
1105 (defconst bibtex-string-maybe-empty-head
1106 (concat "^[ \t]*\\(@String\\)[ \t]*[({]\\("
1107 bibtex-reference-key
1109 "Regexp matching the header line of a BibTeX String entry.")
1111 (defconst bibtex-entry-postfix
"[ \t\n]*,?[ \t\n]*[})]"
1112 "Regexp matching the postfix of a BibTeX entry.")
1114 (defvar bibtex-known-entry-type-re
1115 (regexp-opt (mapcar 'car bibtex-entry-field-alist
))
1116 "Regexp matching the name of a BibTeX entry.")
1118 (defvar bibtex-valid-entry-re
1119 (concat "@[ \t]*\\(" bibtex-known-entry-type-re
"\\)")
1120 "Regexp matching the name of a valid BibTeX entry.")
1122 (defvar bibtex-valid-entry-whitespace-re
1123 (concat "[ \t\n]*\\(" bibtex-valid-entry-re
"\\)")
1124 "Regexp matching the name of a valid BibTeX entry preceded by whitespace.")
1126 (defvar bibtex-any-valid-entry-re
1128 (regexp-opt (append '("String")
1129 (mapcar 'car bibtex-entry-field-alist
))
1131 "Regexp matching the name of any valid BibTeX entry (including string).")
1133 (defconst bibtex-empty-field-re
"\\`\\(\"\"\\|{}\\)\\'"
1134 "Regexp matching the text part (as a string) of an empty field.")
1136 (defconst bibtex-font-lock-syntactic-keywords
1137 `((,(concat "^[ \t]*\\(" (substring bibtex-comment-start
0 1) "\\)"
1138 (substring bibtex-comment-start
1) "\\>")
1141 (defvar bibtex-font-lock-keywords
1142 ;; entry type and reference key
1143 `((,bibtex-entry-maybe-empty-head
1144 (,bibtex-type-in-head font-lock-function-name-face
)
1145 (,bibtex-key-in-head font-lock-constant-face nil t
))
1146 ;; optional field names (treated as comments)
1147 (,(concat "^[ \t]*\\(OPT" bibtex-field-name
"\\)[ \t]*=")
1148 1 font-lock-comment-face
)
1150 (,(concat "^[ \t]*\\(" bibtex-field-name
"\\)[ \t]*=")
1151 1 font-lock-variable-name-face
)
1153 bibtex-font-lock-url bibtex-font-lock-crossref
)
1154 "*Default expressions to highlight in BibTeX mode.")
1156 (defvar bibtex-font-lock-url-regexp
1157 ;; Assume that field names begin at the beginning of a line.
1159 (regexp-opt (delete-dups (mapcar 'caar bibtex-generate-url-list
)) t
)
1161 "Regexp for `bibtex-font-lock-url'.")
1163 (defvar bibtex-field-name-for-parsing nil
1164 "Regexp of field name to be parsed by function `bibtex-parse-field-name'.
1165 Passed by dynamic scoping.")
1167 (defvar bibtex-sort-entry-class-alist
1169 (dolist (class bibtex-sort-entry-class alist
)
1171 (dolist (entry class
)
1172 ;; all entry names should be downcase (for ease of comparison)
1173 (push (cons (if (stringp entry
) (downcase entry
) entry
) i
) alist
))))
1174 "Alist mapping entry types to their sorting index.
1175 Auto-generated from `bibtex-sort-entry-class'.
1176 Used when `bibtex-maintain-sorted-entries' is `entry-class'.")
1179 ;; Support for hideshow minor mode
1180 (defun bibtex-hs-forward-sexp (arg)
1181 "Replacement for `forward-sexp' to be used by `hs-minor-mode'.
1183 (if (looking-at "@\\S(*\\s(")
1184 (goto-char (1- (match-end 0))))
1188 'hs-special-modes-alist
1189 '(bibtex-mode "@\\S(*\\s(" "\\s)" nil bibtex-hs-forward-sexp nil
))
1192 (defun bibtex-parse-association (parse-lhs parse-rhs
)
1193 "Parse a string of the format <left-hand-side = right-hand-side>.
1194 The functions PARSE-LHS and PARSE-RHS are used to parse the corresponding
1195 substrings. These functions are expected to return nil if parsing is not
1196 successful. If both functions return non-nil, a pair containing the returned
1197 values of the functions PARSE-LHS and PARSE-RHS is returned."
1200 (let ((left (funcall parse-lhs
))
1203 (looking-at "[ \t\n]*=[ \t\n]*")
1204 (goto-char (match-end 0))
1205 (setq right
(funcall parse-rhs
)))
1206 (cons left right
))))))
1208 (defun bibtex-parse-field-name ()
1209 "Parse the field name stored in `bibtex-field-name-for-parsing'.
1210 If the field name is found, return a triple consisting of the position of the
1211 very first character of the match, the actual starting position of the name
1212 part and end position of the match. Move point to end of field name.
1213 If `bibtex-autoadd-commas' is non-nil add missing comma at end of preceding
1214 BibTeX field as necessary."
1215 (cond ((looking-at ",[ \t\n]*")
1216 (let ((start (point)))
1217 (goto-char (match-end 0))
1218 (when (looking-at bibtex-field-name-for-parsing
)
1219 (goto-char (match-end 0))
1220 (list start
(match-beginning 0) (match-end 0)))))
1221 ;; Maybe add a missing comma.
1222 ((and bibtex-autoadd-commas
1223 (looking-at (concat "[ \t\n]*\\(?:" bibtex-field-name-for-parsing
1225 (skip-chars-backward " \t\n")
1229 (bibtex-parse-field-name))))
1231 (defconst bibtex-braced-string-syntax-table
1232 (let ((st (make-syntax-table)))
1233 (modify-syntax-entry ?\
{ "(}" st
)
1234 (modify-syntax-entry ?\
} "){" st
)
1235 (modify-syntax-entry ?\
[ "." st
)
1236 (modify-syntax-entry ?\
] "." st
)
1237 (modify-syntax-entry ?\
( "." st
)
1238 (modify-syntax-entry ?\
) "." st
)
1239 (modify-syntax-entry ?
\\ "." st
)
1240 (modify-syntax-entry ?
\" "." st
)
1242 "Syntax-table to parse matched braces.")
1244 (defconst bibtex-quoted-string-syntax-table
1245 (let ((st (make-syntax-table)))
1246 (modify-syntax-entry ?
\\ "\\" st
)
1247 (modify-syntax-entry ?
\" "\"" st
)
1249 "Syntax-table to parse matched quotes.")
1251 (defun bibtex-parse-field-string ()
1252 "Parse a BibTeX field string enclosed by braces or quotes.
1253 If a syntactically correct string is found, a pair containing the start and
1254 end position of the field string is returned, nil otherwise."
1256 (or (and (eq (following-char) ?
\")
1258 (with-syntax-table bibtex-quoted-string-syntax-table
1261 (and (eq (following-char) ?\
{)
1263 (with-syntax-table bibtex-braced-string-syntax-table
1267 (cons (point) end-point
))))
1269 (defun bibtex-parse-field-text ()
1270 "Parse the text part of a BibTeX field.
1271 The text part is either a string, or an empty string, or a constant followed
1272 by one or more <# (string|constant)> pairs. If a syntactically correct text
1273 is found, a pair containing the start and end position of the text is
1274 returned, nil otherwise. Move point to end of field text."
1275 (let ((starting-point (point))
1276 end-point failure boundaries
)
1277 (while (not (or end-point failure
))
1278 (cond ((looking-at bibtex-field-const
)
1279 (goto-char (match-end 0)))
1280 ((setq boundaries
(bibtex-parse-field-string))
1281 (goto-char (cdr boundaries
)))
1283 (if (looking-at "[ \t\n]*#[ \t\n]*")
1284 (goto-char (match-end 0))
1285 (setq end-point
(point))))
1286 (if (and (not failure
)
1288 (cons starting-point end-point
))))
1290 (defun bibtex-parse-field (name)
1291 "Parse a BibTeX field of regexp NAME.
1292 If a syntactically correct field is found, a pair containing the boundaries of
1293 the name and text parts of the field is returned."
1294 (let ((bibtex-field-name-for-parsing name
))
1295 (bibtex-parse-association 'bibtex-parse-field-name
1296 'bibtex-parse-field-text
)))
1298 (defun bibtex-search-forward-field (name &optional bound
)
1299 "Search forward to find a BibTeX field of name NAME.
1300 If a syntactically correct field is found, a pair containing the boundaries of
1301 the name and text parts of the field is returned. The search is limited by
1302 optional arg BOUND. If BOUND is t the search is limited by the end of the
1303 current entry. Do not move point."
1306 (unless (integer-or-marker-p bound
)
1307 (setq bound
(if bound
1308 (save-excursion (bibtex-end-of-entry))
1310 (let ((case-fold-search t
)
1311 (bibtex-field-name-for-parsing name
)
1312 boundaries temp-boundaries
)
1313 (while (and (not boundaries
)
1315 (search-forward "," bound t
))
1316 (goto-char (match-beginning 0))
1317 (if (and (setq temp-boundaries
1318 (bibtex-parse-association 'bibtex-parse-field-name
1319 'bibtex-parse-field-text
))
1320 (<= (cddr temp-boundaries
) bound
))
1321 (setq boundaries temp-boundaries
)
1325 (defun bibtex-search-backward-field (name &optional bound
)
1326 "Search backward to find a BibTeX field of name NAME.
1327 If a syntactically correct field is found, a pair containing the boundaries of
1328 the name and text parts of the field is returned. The search is limited by
1329 optional arg BOUND. If BOUND is t the search is limited by the beginning of the
1330 current entry. Do not move point."
1333 (unless (integer-or-marker-p bound
)
1334 (setq bound
(if bound
1335 (save-excursion (bibtex-beginning-of-entry))
1337 (let ((case-fold-search t
)
1338 (bibtex-field-name-for-parsing name
)
1339 boundaries temp-boundaries
)
1340 (while (and (not boundaries
)
1342 (search-backward "," bound t
))
1343 (if (setq temp-boundaries
1344 (bibtex-parse-association 'bibtex-parse-field-name
1345 'bibtex-parse-field-text
))
1346 (setq boundaries temp-boundaries
)))
1349 (defsubst bibtex-start-of-field
(bounds)
1350 (nth 0 (car bounds
)))
1351 (defsubst bibtex-start-of-name-in-field
(bounds)
1352 (nth 1 (car bounds
)))
1353 (defsubst bibtex-end-of-name-in-field
(bounds)
1354 (nth 2 (car bounds
)))
1355 (defsubst bibtex-end-of-field
(bounds)
1357 (defsubst bibtex-start-of-text-in-field
(bounds)
1359 (defsubst bibtex-end-of-text-in-field
(bounds)
1362 (defun bibtex-name-in-field (bounds &optional remove-opt-alt
)
1363 "Get content of name in BibTeX field defined via BOUNDS.
1364 If optional arg REMOVE-OPT-ALT is non-nil remove \"OPT\" and \"ALT\"."
1365 (let ((name (buffer-substring-no-properties (nth 1 (car bounds
))
1366 (nth 2 (car bounds
)))))
1367 (if (and remove-opt-alt
1368 (string-match "\\`\\(OPT\\|ALT\\)" name
))
1372 (defun bibtex-text-in-field-bounds (bounds &optional remove-delim
)
1373 "Get content of text in BibTeX field defined via BOUNDS.
1374 If optional arg REMOVE-DELIM is non-nil remove enclosing field delimiters
1376 (let ((content (buffer-substring-no-properties (cadr bounds
)
1379 (bibtex-remove-delimiters-string content
)
1382 (defun bibtex-text-in-field (field &optional follow-crossref
)
1383 "Get content of field FIELD of current BibTeX entry.
1384 Return nil if not found.
1385 If optional arg FOLLOW-CROSSREF is non-nil, follow crossref."
1388 ;; We want to jump back and forth while searching FIELD
1389 (bibtex-narrow-to-entry)
1390 (goto-char (point-min))
1391 (let ((bounds (bibtex-search-forward-field field
))
1393 (cond (bounds (bibtex-text-in-field-bounds bounds t
))
1394 ((and follow-crossref
1395 (progn (goto-char (point-min))
1396 (setq bounds
(bibtex-search-forward-field
1397 "\\(OPT\\)?crossref"))))
1398 (setq crossref-field
(bibtex-text-in-field-bounds bounds t
))
1400 (if (bibtex-find-crossref crossref-field
)
1401 ;; Do not pass FOLLOW-CROSSREF because we want
1402 ;; to follow crossrefs only one level of recursion.
1403 (bibtex-text-in-field field
))))))))
1405 (defun bibtex-parse-string-prefix ()
1406 "Parse the prefix part of a BibTeX string entry, including reference key.
1407 If the string prefix is found, return a triple consisting of the position of
1408 the very first character of the match, the actual starting position of the
1409 reference key and the end position of the match."
1410 (let ((case-fold-search t
))
1411 (if (looking-at "^[ \t]*@string[ \t\n]*[({][ \t\n]*")
1412 (let ((start (point)))
1413 (goto-char (match-end 0))
1414 (when (looking-at bibtex-reference-key
)
1415 (goto-char (match-end 0))
1420 (defun bibtex-parse-string-postfix ()
1421 "Parse the postfix part of a BibTeX string entry, including the text.
1422 If the string postfix is found, return a triple consisting of the position of
1423 the actual starting and ending position of the text and the very last
1424 character of the string entry. Move point past BibTeX string entry."
1425 (let* ((case-fold-search t
)
1426 (bounds (bibtex-parse-field-text)))
1428 (goto-char (cdr bounds
))
1429 (when (looking-at "[ \t\n]*[})]")
1430 (goto-char (match-end 0))
1435 (defun bibtex-parse-string ()
1436 "Parse a BibTeX string entry.
1437 If a syntactically correct entry is found, a pair containing the boundaries of
1438 the reference key and text parts of the entry is returned.
1439 Move point past BibTeX string entry."
1440 (bibtex-parse-association 'bibtex-parse-string-prefix
1441 'bibtex-parse-string-postfix
))
1443 (defun bibtex-search-forward-string ()
1444 "Search forward to find a BibTeX string entry.
1445 If a syntactically correct entry is found, a pair containing the boundaries of
1446 the reference key and text parts of the string is returned. Do not move point."
1449 (let ((case-fold-search t
)
1451 (while (and (not boundaries
)
1452 (search-forward-regexp
1453 "^[ \t]*@string[ \t\n]*[({][ \t\n]*" nil t
))
1454 (goto-char (match-beginning 0))
1455 (unless (setq boundaries
(bibtex-parse-string))
1459 (defun bibtex-search-backward-string ()
1460 "Search backward to find a BibTeX string entry.
1461 If a syntactically correct entry is found, a pair containing the boundaries of
1462 the reference key and text parts of the field is returned. Do not move point."
1465 (let ((case-fold-search t
)
1467 (while (and (not boundaries
)
1468 (search-backward-regexp
1469 "^[ \t]*@string[ \t\n]*[({][ \t\n]*" nil t
))
1470 (goto-char (match-beginning 0))
1471 (setq boundaries
(bibtex-parse-string)))
1474 (defun bibtex-reference-key-in-string (bounds)
1475 (buffer-substring-no-properties (nth 1 (car bounds
))
1476 (nth 2 (car bounds
))))
1478 (defun bibtex-text-in-string (bounds &optional remove-delim
)
1479 "Get content of text in BibTeX string field defined via BOUNDS.
1480 If optional arg REMOVE-DELIM is non-nil remove enclosing field
1481 delimiters if present."
1482 (let ((content (buffer-substring-no-properties (nth 0 (cdr bounds
))
1483 (nth 1 (cdr bounds
)))))
1485 (bibtex-remove-delimiters-string content
)
1488 (defsubst bibtex-start-of-text-in-string
(bounds)
1489 (nth 0 (cdr bounds
)))
1490 (defsubst bibtex-end-of-text-in-string
(bounds)
1491 (nth 1 (cdr bounds
)))
1492 (defsubst bibtex-end-of-string
(bounds)
1493 (nth 2 (cdr bounds
)))
1495 (defsubst bibtex-type-in-head
()
1496 "Extract BibTeX type in head."
1498 (buffer-substring-no-properties (1+ (match-beginning bibtex-type-in-head
))
1499 (match-end bibtex-type-in-head
)))
1501 (defsubst bibtex-key-in-head
(&optional empty
)
1502 "Extract BibTeX key in head. Return optional arg EMPTY if key is empty."
1503 (or (match-string-no-properties bibtex-key-in-head
)
1508 (defun bibtex-remove-delimiters-string (str)
1509 "Remove delimiters of string STR."
1510 (if (and (memq (aref str
0) '(?\
{ ?
\"))
1511 (memq (aref str
(1- (length str
))) '(?\
} ?
\")))
1512 (substring str
1 -
1)
1515 (defsubst bibtex-string
= (str1 str2
)
1516 "Return t if STR1 and STR2 are equal, ignoring case."
1517 (eq t
(compare-strings str1
0 nil str2
0 nil t
)))
1519 (defun bibtex-delete-whitespace ()
1520 "Delete all whitespace starting at point."
1521 (if (looking-at "[ \t\n]+")
1522 (delete-region (point) (match-end 0))))
1524 (defun bibtex-current-line ()
1525 "Compute line number of point regardless whether the buffer is narrowed."
1526 (+ (count-lines 1 (point))
1529 (defun bibtex-skip-to-valid-entry (&optional backward
)
1530 "Move point to beginning of the next valid BibTeX entry.
1531 Do not move if we are already at beginning of a valid BibTeX entry.
1532 With optional argument BACKWARD non-nil, move backward to
1533 beginning of previous valid one. A valid entry is a syntactical correct one
1534 with type contained in `bibtex-entry-field-alist' or, if
1535 `bibtex-sort-ignore-string-entries' is nil, a syntactical correct string
1536 entry. Return buffer position of beginning and ending of entry if a valid
1537 entry is found, nil otherwise."
1539 (let ((case-fold-search t
)
1541 (while (not (or found
(if backward
(bobp) (eobp))))
1544 (cond ((or (and (looking-at bibtex-valid-entry-re
)
1545 (setq found
(bibtex-search-entry nil nil t
))
1546 (equal (match-beginning 0) pnt
))
1547 (and (not bibtex-sort-ignore-string-entries
)
1548 (setq bounds
(bibtex-parse-string))
1549 (setq found
(cons (bibtex-start-of-field bounds
)
1550 (bibtex-end-of-string bounds
)))))
1553 (if (re-search-backward "^[ \t]*\\(@\\)" nil
'move
)
1554 (goto-char (match-beginning 1))))
1555 (t (if (re-search-forward "\n[ \t]*@" nil
'move
)
1556 (forward-char -
1))))))
1559 (defun bibtex-map-entries (fun)
1560 "Call FUN for each BibTeX entry in buffer (possibly narrowed).
1561 FUN is called with three arguments, the key of the entry and the buffer
1562 positions (marker) of beginning and end of entry. Point is inside the entry.
1563 If `bibtex-sort-ignore-string-entries' is non-nil, FUN is not called for
1565 (let ((case-fold-search t
))
1567 (goto-char (point-min))
1568 (while (re-search-forward bibtex-entry-head nil t
)
1569 (let ((entry-type (bibtex-type-in-head))
1570 (key (bibtex-key-in-head ""))
1571 (beg (copy-marker (match-beginning 0)))
1572 (end (copy-marker (save-excursion (bibtex-end-of-entry)))))
1574 (if (or (and (not bibtex-sort-ignore-string-entries
)
1575 (bibtex-string= entry-type
"string"))
1576 (assoc-string entry-type bibtex-entry-field-alist t
))
1577 (funcall fun key beg end
)))
1578 (goto-char end
))))))
1580 (defun bibtex-progress-message (&optional flag interval
)
1581 "Echo a message about progress of current buffer.
1582 If FLAG is a string, the message is initialized (in this case a
1583 value for INTERVAL may be given as well (if not this is set to 5)).
1584 If FLAG is `done', the message is deinitialized.
1585 If FLAG is nil, a message is echoed if point was incremented at least
1586 `bibtex-progress-interval' percent since last message was echoed."
1587 (cond ((stringp flag
)
1588 (setq bibtex-progress-lastmes flag
1589 bibtex-progress-interval
(or interval
5)
1590 bibtex-progress-lastperc
0))
1592 (message "%s (done)" bibtex-progress-lastmes
)
1593 (setq bibtex-progress-lastmes nil
))
1595 (let* ((size (- (point-max) (point-min)))
1596 (perc (if (= size
0)
1598 (/ (* 100 (- (point) (point-min))) size
))))
1599 (when (>= perc
(+ bibtex-progress-lastperc
1600 bibtex-progress-interval
))
1601 (setq bibtex-progress-lastperc perc
)
1602 (message "%s (%d%%)" bibtex-progress-lastmes perc
))))))
1604 (defun bibtex-field-left-delimiter ()
1605 "Return a string dependent on `bibtex-field-delimiters'."
1606 (if (eq bibtex-field-delimiters
'braces
)
1610 (defun bibtex-field-right-delimiter ()
1611 "Return a string dependent on `bibtex-field-delimiters'."
1612 (if (eq bibtex-field-delimiters
'braces
)
1616 (defun bibtex-entry-left-delimiter ()
1617 "Return a string dependent on `bibtex-entry-delimiters'."
1618 (if (eq bibtex-entry-delimiters
'braces
)
1622 (defun bibtex-entry-right-delimiter ()
1623 "Return a string dependent on `bibtex-entry-delimiters'."
1624 (if (eq bibtex-entry-delimiters
'braces
)
1628 (defun bibtex-search-entry (empty-head &optional bound noerror backward
)
1629 "Search for a BibTeX entry (maybe without reference key if EMPTY-HEAD is t).
1630 BOUND and NOERROR are exactly as in `re-search-forward'. If BACKWARD
1631 is non-nil, search in reverse direction. Move point past the closing
1632 delimiter (at the beginning of entry if BACKWARD is non-nil).
1633 Return a cons pair with buffer positions of beginning and end of entry.
1634 After call to this function MATCH-BEGINNING and MATCH-END functions
1635 are defined, but only for the head part of the entry
1636 \(especially (match-end 0) just gives the end of the head part)."
1638 (entry-head-re (if empty-head
1639 bibtex-entry-maybe-empty-head
1640 bibtex-entry-head
)))
1643 (while (and (not found
)
1644 (re-search-backward entry-head-re bound noerror
))
1645 (setq found
(bibtex-search-entry empty-head pnt t
)))
1647 (progn (goto-char (match-beginning 0))
1649 (cond ((not noerror
)
1651 (error "Backward search of BibTeX entry failed"))
1657 (unless bound
(setq bound
(point-max)))
1658 (while (and (not found
)
1659 (re-search-forward entry-head-re bound noerror
))
1663 (goto-char (match-end bibtex-type-in-head
))
1664 (looking-at "[ \t]*("))
1665 ;; entry opened with parenthesis
1668 (infix-start (point))
1670 (while (not finished
)
1671 (skip-chars-forward " \t\n" bound
)
1672 (if (and (setq bounds
(bibtex-parse-field bibtex-field-name
))
1673 (<= (bibtex-end-of-field bounds
) bound
))
1674 (setq infix-start
(bibtex-end-of-field bounds
))
1676 (goto-char infix-start
))
1677 ;; This matches the infix* part. The AND construction assures
1678 ;; that BOUND is respected.
1679 (when (and (looking-at bibtex-entry-postfix
)
1680 (eq (char-before (match-end 0)) entry-closer
)
1681 (<= (match-end 0) bound
))
1682 (goto-char (match-end 0))
1685 (cons (match-beginning 0) (point))
1686 (cond ((not noerror
)
1688 (error "Search of BibTeX entry failed"))
1694 (defun bibtex-flash-head ()
1695 "Flash at BibTeX entry head before point, if exists."
1696 (let ((case-fold-search t
)
1698 (cond ((re-search-backward bibtex-entry-head nil t
)
1699 (goto-char (match-beginning bibtex-type-in-head
))
1700 (setq flash
(match-end bibtex-key-in-head
)))
1703 (skip-chars-backward " \t")
1704 (setq flash
(point))
1706 (skip-chars-forward " \t")))
1707 (if (pos-visible-in-window-p (point))
1710 (buffer-substring (point) flash
)))))
1712 (defun bibtex-make-optional-field (field)
1713 "Make an optional field named FIELD in current BibTeX entry."
1715 (bibtex-make-field (cons (concat "OPT" (car field
)) (cdr field
)))
1716 (bibtex-make-field (concat "OPT" field
))))
1718 (defun bibtex-move-outside-of-entry ()
1719 "Make sure point is outside of a BibTeX entry."
1720 (let ((orig-point (point)))
1721 (bibtex-end-of-entry)
1722 (when (< (point) orig-point
)
1723 ;; We moved backward, so we weren't inside an entry to begin with.
1724 ;; Leave point at the beginning of a line, and preferably
1725 ;; at the beginning of a paragraph.
1726 (goto-char orig-point
)
1727 (beginning-of-line 1)
1728 (unless (= ?
\n (char-before (1- (point))))
1729 (re-search-forward "^[ \t]*[@\n]" nil
'move
)
1731 (skip-chars-forward " \t\n")))
1733 (defun bibtex-beginning-of-first-entry ()
1734 "Go to the beginning of the first BibTeX entry in buffer. Return point."
1735 (goto-char (point-min))
1736 (if (re-search-forward "^[ \t]*@" nil
'move
)
1737 (beginning-of-line))
1740 (defun bibtex-beginning-of-last-entry ()
1741 "Go to the beginning of the last BibTeX entry in buffer."
1742 (goto-char (point-max))
1743 (if (re-search-backward "^[ \t]*@" nil
'move
)
1744 (beginning-of-line))
1747 (defun bibtex-inside-field ()
1748 "Try to avoid point being at end of a BibTeX field."
1750 (skip-chars-backward " \t")
1751 (if (= (preceding-char) ?
,)
1753 (if (or (= (preceding-char) ?
})
1754 (= (preceding-char) ?
\"))
1757 (defun bibtex-enclosing-field (&optional noerr
)
1758 "Search for BibTeX field enclosing point.
1759 Unless NOERR is non-nil, signal an error if no enclosing field is found.
1760 On success return bounds, nil otherwise. Do not move point."
1761 (let ((bounds (bibtex-search-backward-field bibtex-field-name t
)))
1763 (<= (bibtex-start-of-field bounds
) (point))
1764 (>= (bibtex-end-of-field bounds
) (point)))
1767 (error "Can't find enclosing BibTeX field")))))
1769 (defun bibtex-enclosing-entry-maybe-empty-head ()
1770 "Search for BibTeX entry enclosing point. Move point to end of entry.
1771 Beginning (but not end) of entry is given by (`match-beginning' 0)."
1772 (let ((case-fold-search t
)
1773 (old-point (point)))
1774 (unless (re-search-backward bibtex-entry-maybe-empty-head nil t
)
1775 (goto-char old-point
)
1776 (error "Can't find beginning of enclosing BibTeX entry"))
1777 (goto-char (match-beginning bibtex-type-in-head
))
1778 (unless (bibtex-search-entry t nil t
)
1779 (goto-char old-point
)
1780 (error "Can't find end of enclosing BibTeX entry"))))
1782 (defun bibtex-insert-kill (n)
1783 "Reinsert the Nth stretch of killed BibTeX text."
1784 (if (not bibtex-last-kill-command
)
1785 (error "BibTeX kill ring is empty")
1786 (let* ((kr (if (eq bibtex-last-kill-command
'field
)
1787 'bibtex-field-kill-ring
1788 'bibtex-entry-kill-ring
))
1789 (kryp (if (eq bibtex-last-kill-command
'field
)
1790 'bibtex-field-kill-ring-yank-pointer
1791 'bibtex-entry-kill-ring-yank-pointer
))
1792 (current (car (set kryp
(nthcdr (mod (- n
(length (eval kryp
)))
1795 (if (eq bibtex-last-kill-command
'field
)
1796 (let (bibtex-help-message)
1798 (if (looking-at "[}\"]")
1801 (message "Mark set")
1802 (bibtex-make-field current t
))
1803 (unless (eobp) (bibtex-beginning-of-entry))
1805 (message "Mark set")
1806 (insert current
)))))
1808 (defun bibtex-format-entry ()
1809 "Helper function for `bibtex-clean-entry'.
1810 Formats current entry according to variable `bibtex-entry-format'."
1813 (bibtex-narrow-to-entry)
1814 (let ((case-fold-search t
)
1815 (format (if (eq bibtex-entry-format t
)
1816 '(realign opts-or-alts required-fields
1818 last-comma page-dashes delimiters
1819 unify-case inherit-booktitle
)
1820 bibtex-entry-format
))
1821 crossref-key bounds alternatives-there non-empty-alternative
1822 entry-list req-field-list field-list
)
1824 ;; identify entry type
1825 (goto-char (point-min))
1826 (re-search-forward bibtex-entry-type
)
1827 (let ((beg-type (1+ (match-beginning 0)))
1828 (end-type (match-end 0)))
1829 (setq entry-list
(assoc-string (buffer-substring-no-properties
1831 bibtex-entry-field-alist
1834 ;; unify case of entry name
1835 (when (memq 'unify-case format
)
1836 (delete-region beg-type end-type
)
1837 (insert (car entry-list
)))
1839 ;; update left entry delimiter
1840 (when (memq 'delimiters format
)
1841 (goto-char end-type
)
1842 (skip-chars-forward " \t\n")
1844 (insert (bibtex-entry-left-delimiter))))
1846 ;; determine if entry has crossref field and if at least
1847 ;; one alternative is non-empty
1848 (goto-char (point-min))
1849 (let* ((fields-alist (bibtex-parse-entry))
1850 (field (assoc-string "crossref" fields-alist t
)))
1851 (setq crossref-key
(and field
1852 (not (string-match bibtex-empty-field-re
1854 (bibtex-remove-delimiters-string (cdr field
)))
1855 req-field-list
(if crossref-key
1856 (nth 0 (nth 2 entry-list
)) ; crossref part
1857 (nth 0 (nth 1 entry-list
)))) ; required part
1859 (dolist (rfield req-field-list
)
1860 (when (nth 3 rfield
) ; we should have an alternative
1861 (setq alternatives-there t
1862 field
(assoc-string (car rfield
) fields-alist t
))
1864 (not (string-match bibtex-empty-field-re
1866 (cond ((not non-empty-alternative
)
1867 (setq non-empty-alternative t
))
1868 ((memq 'required-fields format
)
1869 (error "More than one non-empty alternative")))))))
1871 (if (and alternatives-there
1872 (not non-empty-alternative
)
1873 (memq 'required-fields format
))
1874 (error "All alternatives are empty"))
1876 ;; process all fields
1877 (goto-char (point-min))
1878 (while (setq bounds
(bibtex-search-forward-field bibtex-field-name
))
1879 (let* ((beg-field (copy-marker (bibtex-start-of-field bounds
)))
1880 (end-field (copy-marker (bibtex-end-of-field bounds
) t
))
1881 (beg-name (copy-marker (bibtex-start-of-name-in-field bounds
)))
1882 (end-name (copy-marker (bibtex-end-of-name-in-field bounds
)))
1883 (beg-text (copy-marker (bibtex-start-of-text-in-field bounds
)))
1884 (end-text (copy-marker (bibtex-end-of-text-in-field bounds
) t
))
1885 (opt-alt (string-match "OPT\\|ALT"
1886 (buffer-substring-no-properties
1887 beg-name
(+ beg-name
3))))
1888 (field-name (buffer-substring-no-properties
1889 (if opt-alt
(+ beg-name
3) beg-name
) end-name
))
1890 (empty-field (string-match bibtex-empty-field-re
1891 (buffer-substring-no-properties
1892 beg-text end-text
)))
1895 ;; We have more elegant high-level functions for several
1896 ;; tasks done by bibtex-format-entry. However, they contain
1897 ;; quite some redundancy compared with what we need to do
1898 ;; anyway. So for speed-up we avoid using them.
1900 (if (memq 'opts-or-alts format
)
1901 (cond ((and empty-field
1903 (let ((field (assoc-string
1904 field-name req-field-list t
)))
1905 (or (not field
) ; OPT field
1906 (nth 3 field
))))) ; ALT field
1907 ;; Either it is an empty ALT field. Then we have checked
1908 ;; already that we have one non-empty alternative. Or it
1909 ;; is an empty OPT field that we do not miss anyway.
1910 ;; So we can safely delete this field.
1911 (delete-region beg-field end-field
)
1913 ;; otherwise: not empty, delete "OPT" or "ALT"
1915 (goto-char beg-name
)
1919 (push field-name field-list
)
1921 ;; remove delimiters from purely numerical fields
1922 (when (and (memq 'numerical-fields format
)
1923 (progn (goto-char beg-text
)
1924 (looking-at "\\(\"[0-9]+\"\\)\\|\\({[0-9]+}\\)")))
1925 (goto-char end-text
)
1927 (goto-char beg-text
)
1930 ;; update delimiters
1931 (when (memq 'delimiters format
)
1932 (goto-char beg-text
)
1933 (when (looking-at "[{\"]")
1935 (insert (bibtex-field-left-delimiter)))
1936 (goto-char (1- (marker-position end-text
)))
1937 (when (looking-at "[}\"]")
1939 (insert (bibtex-field-right-delimiter))))
1941 ;; update page dashes
1942 (if (and (memq 'page-dashes format
)
1943 (bibtex-string= field-name
"pages")
1944 (progn (goto-char beg-text
)
1946 "\\([\"{][0-9]+\\)[ \t\n]*--?[ \t\n]*\\([0-9]+[\"}]\\)")))
1947 (replace-match "\\1-\\2"))
1949 ;; use book title of crossref'd entry
1950 (if (and (memq 'inherit-booktitle format
)
1952 (bibtex-string= field-name
"booktitle")
1954 (let ((title (save-excursion
1957 (if (bibtex-find-entry crossref-key t
)
1958 (bibtex-text-in-field "title"))))))
1960 (setq empty-field nil
)
1961 (goto-char (1+ beg-text
))
1964 ;; Use booktitle to set a missing title.
1965 (if (and empty-field
1966 (bibtex-string= field-name
"title"))
1967 (let ((booktitle (bibtex-text-in-field "booktitle")))
1969 (setq empty-field nil
)
1970 (goto-char (1+ beg-text
))
1971 (insert booktitle
))))
1973 ;; if empty field, complain
1974 (if (and empty-field
1975 (memq 'required-fields format
)
1976 (assoc-string field-name req-field-list t
))
1977 (error "Mandatory field `%s' is empty" field-name
))
1979 ;; unify case of field name
1980 (if (memq 'unify-case format
)
1981 (let ((fname (car (assoc-string
1983 (append (nth 0 (nth 1 entry-list
))
1984 (nth 1 (nth 1 entry-list
))
1985 bibtex-user-optional-fields
)
1989 (delete-region beg-name end-name
)
1990 (goto-char beg-name
)
1992 ;; there are no rules we could follow
1993 (downcase-region beg-name end-name
))))
1996 (goto-char end-field
))))
1998 ;; check whether all required fields are present
1999 (if (memq 'required-fields format
)
2000 (let ((found 0) altlist
)
2001 (dolist (fname req-field-list
)
2003 (push (car fname
) altlist
))
2004 (unless (or (member (car fname
) field-list
)
2006 (error "Mandatory field `%s' is missing" (car fname
))))
2008 (dolist (fname altlist
)
2009 (if (member fname field-list
)
2010 (setq found
(1+ found
))))
2012 (error "Alternative mandatory field `%s' is missing"
2015 (error "Alternative fields `%s' are defined %s times"
2019 (if (looking-at (bibtex-field-right-delimiter))
2022 ;; update comma after last field
2023 (if (memq 'last-comma format
)
2024 (cond ((and bibtex-comma-after-last-field
2025 (not (looking-at ",")))
2027 ((and (not bibtex-comma-after-last-field
)
2031 ;; update right entry delimiter
2032 (if (looking-at ",")
2034 (when (memq 'delimiters format
)
2035 (skip-chars-forward " \t\n")
2037 (insert (bibtex-entry-right-delimiter)))
2040 (if (memq 'realign format
)
2041 (bibtex-fill-entry))))))
2044 (defun bibtex-autokey-abbrev (string len
)
2045 "Return an abbreviation of STRING with at least LEN characters.
2046 If LEN is positive the abbreviation is terminated only after a consonant
2047 or at the word end. If LEN is negative the abbreviation is strictly
2048 enforced using abs (LEN) characters. If LEN is not a number, STRING
2049 is returned unchanged."
2050 (cond ((or (not (numberp len
))
2051 (<= (length string
) (abs len
)))
2056 (substring string
0 (abs len
)))
2057 (t (let* ((case-fold-search t
)
2058 (abort-char (string-match "[^aeiou]" string
(1- len
))))
2060 (substring string
0 (1+ abort-char
))
2063 (defun bibtex-autokey-get-field (field &optional change-list
)
2064 "Get content of BibTeX field FIELD. Return empty string if not found.
2065 Optional arg CHANGE-LIST is a list of substitution patterns that is
2066 applied to the content of FIELD. It is an alist with pairs
2067 \(OLD-REGEXP . NEW-STRING\)."
2068 (let ((content (bibtex-text-in-field field bibtex-autokey-use-crossref
))
2070 (unless content
(setq content
""))
2071 (dolist (pattern change-list content
)
2072 (setq content
(replace-regexp-in-string (car pattern
)
2076 (defun bibtex-autokey-get-names ()
2077 "Get contents of the name field of the current entry.
2078 Do some modifications based on `bibtex-autokey-name-change-strings'.
2079 Return the names as a concatenated string obeying `bibtex-autokey-names'
2080 and `bibtex-autokey-names-stretch'."
2081 (let ((names (bibtex-autokey-get-field "author\\|editor"
2082 bibtex-autokey-name-change-strings
)))
2083 ;; Some entries do not have a name field.
2084 (if (string= "" names
)
2086 (let* ((case-fold-search t
)
2087 (name-list (mapcar 'bibtex-autokey-demangle-name
2088 (split-string names
"[ \t\n]+and[ \t\n]+")))
2090 (unless (or (not (numberp bibtex-autokey-names
))
2091 (<= (length name-list
)
2092 (+ bibtex-autokey-names
2093 bibtex-autokey-names-stretch
)))
2094 ;; Take bibtex-autokey-names elements from beginning of name-list
2095 (setq name-list
(nreverse (nthcdr (- (length name-list
)
2096 bibtex-autokey-names
)
2097 (nreverse name-list
)))
2098 additional-names bibtex-autokey-additional-names
))
2099 (concat (mapconcat 'identity name-list
2100 bibtex-autokey-name-separator
)
2101 additional-names
)))))
2103 (defun bibtex-autokey-demangle-name (fullname)
2104 "Get the last part from a well-formed FULLNAME and perform abbreviations."
2105 (let* (case-fold-search
2106 (name (cond ((string-match "\\([[:upper:]][^, ]*\\)[^,]*," fullname
)
2107 ;; Name is of the form "von Last, First" or
2108 ;; "von Last, Jr, First"
2109 ;; --> Take the first capital part before the comma
2110 (match-string 1 fullname
))
2111 ((string-match "\\([^, ]*\\)," fullname
)
2112 ;; Strange name: we have a comma, but nothing capital
2113 ;; So we accept even lowercase names
2114 (match-string 1 fullname
))
2115 ((string-match "\\(\\<[[:lower:]][^ ]* +\\)+\\([[:upper:]][^ ]*\\)"
2117 ;; name is of the form "First von Last", "von Last",
2118 ;; "First von von Last", or "d'Last"
2119 ;; --> take the first capital part after the "von" parts
2120 (match-string 2 fullname
))
2121 ((string-match "\\([^ ]+\\) *\\'" fullname
)
2122 ;; name is of the form "First Middle Last" or "Last"
2123 ;; --> take the last token
2124 (match-string 1 fullname
))
2125 (t (error "Name `%s' is incorrectly formed" fullname
)))))
2126 (funcall bibtex-autokey-name-case-convert
2127 (bibtex-autokey-abbrev name bibtex-autokey-name-length
))))
2129 (defun bibtex-autokey-get-year ()
2130 "Return year field contents as a string obeying `bibtex-autokey-year-length'."
2131 (let ((yearfield (bibtex-autokey-get-field "year")))
2132 (substring yearfield
(max 0 (- (length yearfield
)
2133 bibtex-autokey-year-length
)))))
2135 (defun bibtex-autokey-get-title ()
2136 "Get title field contents up to a terminator.
2137 Return the result as a string"
2138 (let ((case-fold-search t
)
2140 (bibtex-autokey-get-field "title"
2141 bibtex-autokey-titleword-change-strings
)))
2142 ;; ignore everything past a terminator
2143 (if (string-match bibtex-autokey-title-terminators titlestring
)
2144 (setq titlestring
(substring titlestring
0 (match-beginning 0))))
2145 ;; gather words from titlestring into a list. Ignore
2146 ;; specific words and use only a specific amount of words.
2148 titlewords titlewords-extra word
)
2149 (while (and (or (not (numberp bibtex-autokey-titlewords
))
2150 (< counter
(+ bibtex-autokey-titlewords
2151 bibtex-autokey-titlewords-stretch
)))
2152 (string-match "\\b\\w+" titlestring
))
2153 (setq word
(match-string 0 titlestring
)
2154 titlestring
(substring titlestring
(match-end 0)))
2155 ;; Ignore words matched by one of the elements of
2156 ;; bibtex-autokey-titleword-ignore
2157 (unless (let ((lst bibtex-autokey-titleword-ignore
))
2159 (not (string-match (concat "\\`\\(?:" (car lst
)
2161 (setq lst
(cdr lst
)))
2163 (setq counter
(1+ counter
))
2164 (if (or (not (numberp bibtex-autokey-titlewords
))
2165 (<= counter bibtex-autokey-titlewords
))
2166 (push word titlewords
)
2167 (push word titlewords-extra
))))
2168 ;; Obey bibtex-autokey-titlewords-stretch:
2169 ;; If by now we have processed all words in titlestring, we include
2170 ;; titlewords-extra in titlewords. Otherwise, we ignore titlewords-extra.
2171 (unless (string-match "\\b\\w+" titlestring
)
2172 (setq titlewords
(append titlewords-extra titlewords
)))
2173 (mapconcat 'bibtex-autokey-demangle-title
(nreverse titlewords
)
2174 bibtex-autokey-titleword-separator
))))
2176 (defun bibtex-autokey-demangle-title (titleword)
2177 "Do some abbreviations on TITLEWORD.
2178 The rules are defined in `bibtex-autokey-titleword-abbrevs'
2179 and `bibtex-autokey-titleword-length'."
2180 (let ((case-fold-search t
)
2181 (alist bibtex-autokey-titleword-abbrevs
))
2183 (not (string-match (concat "\\`\\(?:" (caar alist
) "\\)\\'")
2185 (setq alist
(cdr alist
)))
2188 (funcall bibtex-autokey-titleword-case-convert
2189 (bibtex-autokey-abbrev titleword bibtex-autokey-titleword-length
)))))
2191 (defun bibtex-generate-autokey ()
2192 "Generate automatically a key for a BibTeX entry.
2193 Use the author/editor, the year and the title field.
2194 The algorithm works as follows.
2197 1. Use the author or editor field to generate the name part of the key.
2198 2. Change the content of the name field according to
2199 `bibtex-autokey-name-change-strings' (see there for further detail).
2200 3. Use the first `bibtex-autokey-names' names in the name field. If there
2201 are up to `bibtex-autokey-names' + `bibtex-autokey-names-stretch' names,
2203 4. Use only the last names to form the name part. From these last names,
2204 take at least `bibtex-autokey-name-length' characters (truncate only
2205 after a consonant or at a word end).
2206 5. Convert all last names using the function
2207 `bibtex-autokey-name-case-convert'.
2208 6. Build the name part of the key by concatenating all abbreviated last
2209 names with the string `bibtex-autokey-name-separator' between any two.
2210 If there are more names in the name field than names used in the name
2211 part, append the string `bibtex-autokey-additional-names'.
2214 1. Build the year part of the key by truncating the content of the year
2215 field to the rightmost `bibtex-autokey-year-length' digits (useful
2216 values are 2 and 4).
2217 2. If the year field (or any other field required to generate the key)
2218 is absent, but the entry has a valid crossref field and
2219 `bibtex-autokey-use-crossref' is non-nil, use the field of the
2220 crossreferenced entry instead.
2223 1. Change the content of the title field according to
2224 `bibtex-autokey-titleword-change-strings' (see there for further detail).
2225 2. Truncate the title before the first match of
2226 `bibtex-autokey-title-terminators' and delete those words which appear
2227 in `bibtex-autokey-titleword-ignore'. Build the title part using the
2228 first `bibtex-autokey-titlewords' words from this truncated title.
2229 If the truncated title ends after up to `bibtex-autokey-titlewords' +
2230 `bibtex-autokey-titlewords-stretch' words, use all words from the
2232 3. For every title word that appears in `bibtex-autokey-titleword-abbrevs'
2233 use the corresponding abbreviation (see documentation of this variable
2234 for further detail).
2235 4. From every title word not generated by an abbreviation, take at least
2236 `bibtex-autokey-titleword-length' characters (truncate only after
2237 a consonant or at a word end).
2238 5. Convert all title words using the function
2239 `bibtex-autokey-titleword-case-convert'.
2240 6. Build the title part by concatenating all abbreviated title words with
2241 the string `bibtex-autokey-titleword-separator' between any two.
2243 Concatenate the key:
2244 1. Concatenate `bibtex-autokey-prefix-string', the name part, the year
2245 part and the title part. If the name part and the year part are both
2246 non-empty insert `bibtex-autokey-name-year-separator' between the two.
2247 If the title part and the year (or name) part are non-empty, insert
2248 `bibtex-autokey-year-title-separator' between the two.
2249 2. If `bibtex-autokey-before-presentation-function' is non-nil, it must be
2250 a function taking one argument. Call this function with the generated
2251 key as the argument. Use the return value of this function (a string)
2253 3. If `bibtex-autokey-edit-before-use' is non-nil, present the key in the
2254 minibuffer to the user for editing. Insert the key given by the user."
2255 (let* ((names (bibtex-autokey-get-names))
2256 (year (bibtex-autokey-get-year))
2257 (title (bibtex-autokey-get-title))
2258 (autokey (concat bibtex-autokey-prefix-string
2260 (unless (or (equal names
"")
2262 bibtex-autokey-name-year-separator
)
2264 (unless (or (and (equal names
"")
2267 bibtex-autokey-year-title-separator
)
2269 (if bibtex-autokey-before-presentation-function
2270 (funcall bibtex-autokey-before-presentation-function autokey
)
2274 (defun bibtex-global-key-alist ()
2275 "Return global key alist based on `bibtex-files'."
2278 (mapcar (lambda (buf)
2279 (with-current-buffer buf bibtex-reference-keys
))
2280 (bibtex-files-expand t
)))
2281 bibtex-reference-keys
))
2283 (defun bibtex-read-key (prompt &optional key global
)
2284 "Read BibTeX key from minibuffer using PROMPT and default KEY.
2285 If optional arg GLOBAL is non-nil, completion is based on the keys in
2286 `bibtex-reference-keys' of `bibtex-files',"
2287 (let (completion-ignore-case)
2288 (completing-read prompt
(if global
(bibtex-global-key-alist)
2289 bibtex-reference-keys
)
2290 nil nil key
'bibtex-key-history
)))
2292 (defun bibtex-read-string-key (&optional key
)
2293 "Read BibTeX string key from minibuffer using default KEY."
2294 (let ((completion-ignore-case t
))
2295 (completing-read "String key: " bibtex-strings
2296 nil nil key
'bibtex-key-history
)))
2298 (defun bibtex-parse-keys (&optional abortable verbose
)
2299 "Set `bibtex-reference-keys' to the keys used in the whole buffer.
2300 Find both entry keys and crossref entries. If ABORTABLE is non-nil abort
2301 on user input. If VERBOSE is non-nil give messages about progress.
2302 Return alist of keys if parsing was completed, `aborted' otherwise."
2303 (let (ref-keys crossref-keys
)
2307 (bibtex-progress-message
2308 (concat (buffer-name) ": parsing reference keys")))
2310 (goto-char (point-min))
2311 (if bibtex-parse-keys-fast
2312 (let ((case-fold-search t
)
2313 (re (concat bibtex-entry-head
"\\|"
2314 ",[ \t\n]*crossref[ \t\n]*=[ \t\n]*"
2315 "\\(\"[^\"]*\"\\|{[^}]*}\\)[ \t\n]*[,})]")))
2316 (while (re-search-forward re nil t
)
2317 (if (and abortable
(input-pending-p))
2318 ;; user has aborted by typing a key --> return `aborted'
2319 (throw 'userkey
'aborted
))
2320 (cond ((match-end 3)
2321 ;; This is a crossref.
2322 (let ((key (buffer-substring-no-properties
2323 (1+ (match-beginning 3)) (1- (match-end 3)))))
2324 (unless (assoc key crossref-keys
)
2325 (push (list key
) crossref-keys
))))
2326 ;; only keys of known entries
2327 ((assoc-string (bibtex-type-in-head)
2328 bibtex-entry-field-alist t
)
2329 ;; This is an entry.
2330 (let ((key (bibtex-key-in-head)))
2331 (unless (assoc key ref-keys
)
2332 (push (cons key t
) ref-keys
)))))))
2334 (let (;; ignore @String entries because they are handled
2335 ;; separately by bibtex-parse-strings
2336 (bibtex-sort-ignore-string-entries t
)
2339 (lambda (key beg end
)
2342 ;; user has aborted by typing a key --> return `aborted'
2343 (throw 'userkey
'aborted
))
2344 (if verbose
(bibtex-progress-message))
2345 (unless (assoc key ref-keys
)
2346 (push (cons key t
) ref-keys
))
2347 (if (and (setq bounds
(bibtex-search-forward-field "crossref" end
))
2348 (setq key
(bibtex-text-in-field-bounds bounds t
))
2349 (not (assoc key crossref-keys
)))
2350 (push (list key
) crossref-keys
))))))
2352 (dolist (key crossref-keys
)
2353 (unless (assoc (car key
) ref-keys
) (push key ref-keys
)))
2355 (bibtex-progress-message 'done
))
2356 ;; successful operation --> return `bibtex-reference-keys'
2357 (setq bibtex-reference-keys ref-keys
))))))
2359 (defun bibtex-parse-strings (&optional add abortable
)
2360 "Set `bibtex-strings' to the string definitions in the whole buffer.
2361 If ADD is non-nil add the new strings to `bibtex-strings' instead of
2362 simply resetting it. If ADD is an alist of strings, also add ADD to
2363 `bibtex-strings'. If ABORTABLE is non-nil abort on user input.
2364 Return alist of strings if parsing was completed, `aborted' otherwise."
2367 (goto-char (point-min))
2368 (let ((strings (if (and add
2369 (listp bibtex-strings
))
2373 (dolist (string add
)
2374 (unless (assoc-string (car string
) strings t
)
2375 (push string strings
))))
2377 (while (setq bounds
(bibtex-search-forward-string))
2380 ;; user has aborted by typing a key --> return `aborted'
2381 (throw 'userkey
'aborted
))
2382 (setq key
(bibtex-reference-key-in-string bounds
))
2383 (unless (assoc-string key strings t
)
2384 (push (cons key
(bibtex-text-in-string bounds t
))
2386 (goto-char (bibtex-end-of-text-in-string bounds
)))
2387 ;; successful operation --> return `bibtex-strings'
2388 (setq bibtex-strings strings
))))))
2390 (defun bibtex-string-files-init ()
2391 "Return initialization for `bibtex-strings'.
2392 Use `bibtex-predefined-strings' and BibTeX files `bibtex-string-files'."
2394 (let ((dirlist (split-string (or bibtex-string-file-path default-directory
)
2397 string-files fullfilename compl bounds found
)
2398 ;; collect absolute file names of valid string files
2399 (dolist (filename bibtex-string-files
)
2400 (unless (string-match "\\.bib\\'" filename
)
2401 (setq filename
(concat filename
".bib")))
2403 (if (file-name-absolute-p filename
)
2404 (if (file-readable-p filename
)
2405 (push filename string-files
)
2406 (error "BibTeX strings file %s not found" filename
))
2407 (dolist (dir dirlist
)
2408 (when (file-readable-p
2409 (setq fullfilename
(expand-file-name filename dir
)))
2410 (push fullfilename string-files
)
2413 (error "File %s not in paths defined via bibtex-string-file-path"
2415 ;; parse string files
2416 (dolist (filename string-files
)
2418 (insert-file-contents filename
)
2419 (goto-char (point-min))
2420 (while (setq bounds
(bibtex-search-forward-string))
2421 (push (cons (bibtex-reference-key-in-string bounds
)
2422 (bibtex-text-in-string bounds t
))
2424 (goto-char (bibtex-end-of-string bounds
)))))
2425 (append bibtex-predefined-strings
(nreverse compl
)))))
2427 (defun bibtex-parse-buffers-stealthily ()
2428 "Parse buffer in the background during idle time.
2429 Called by `run-with-idle-timer'. Whenever Emacs has been idle
2430 for `bibtex-parse-keys-timeout' seconds, parse all BibTeX buffers
2431 which have been modified after last parsing.
2432 Parsing initializes `bibtex-reference-keys' and `bibtex-strings'."
2434 (let ((buffers (buffer-list))
2435 (strings-init (bibtex-string-files-init)))
2436 (while (and buffers
(not (input-pending-p)))
2437 (set-buffer (car buffers
))
2438 (if (and (eq major-mode
'bibtex-mode
)
2439 (not (eq (buffer-modified-tick)
2440 bibtex-buffer-last-parsed-tick
)))
2443 ;; Output no progress messages in bibtex-parse-keys
2444 ;; because when in y-or-n-p that can hide the question.
2445 (if (and (listp (bibtex-parse-keys t
))
2446 ;; update bibtex-strings
2447 (listp (bibtex-parse-strings strings-init t
)))
2449 ;; remember that parsing was successful
2450 (setq bibtex-buffer-last-parsed-tick
(buffer-modified-tick)))))
2451 (setq buffers
(cdr buffers
))))))
2453 (defun bibtex-files-expand (&optional current force
)
2454 "Return an expanded list of BibTeX buffers based on `bibtex-files'.
2455 Initialize in these buffers `bibtex-reference-keys' if not yet set.
2456 List of BibTeX buffers includes current buffer if CURRENT is non-nil.
2457 If FORCE is non-nil, (re)initialize `bibtex-reference-keys' even if
2459 (let ((file-path (split-string (or bibtex-file-path default-directory
) ":+"))
2460 file-list dir-list buffer-list
)
2461 (dolist (file bibtex-files
)
2462 (cond ((eq file
'bibtex-file-path
)
2463 (setq dir-list
(append dir-list file-path
)))
2464 ((file-accessible-directory-p file
)
2465 (push file dir-list
))
2466 ((progn (unless (string-match "\\.bib\\'" file
)
2467 (setq file
(concat file
".bib")))
2468 (file-name-absolute-p file
))
2469 (push file file-list
))
2471 (let (fullfilename found
)
2472 (dolist (dir file-path
)
2473 (when (file-readable-p
2474 (setq fullfilename
(expand-file-name file dir
)))
2475 (push fullfilename file-list
)
2478 (error "File %s not in paths defined via bibtex-file-path"
2480 (dolist (file file-list
)
2481 (unless (file-readable-p file
)
2482 (error "BibTeX file %s not found" file
)))
2484 (dolist (dir dir-list
)
2486 (append file-list
(directory-files dir t
"\\.bib\\'" t
))))
2487 (delete-dups file-list
)
2488 (dolist (file file-list
)
2489 (when (file-readable-p file
)
2490 (push (find-file-noselect file
) buffer-list
)
2491 (with-current-buffer (car buffer-list
)
2492 (if (or force
(not (listp bibtex-reference-keys
)))
2493 (bibtex-parse-keys)))))
2494 (cond ((and current
(not (memq (current-buffer) buffer-list
)))
2495 (push (current-buffer) buffer-list
)
2496 (if force
(bibtex-parse-keys)))
2497 ((and (not current
) (memq (current-buffer) buffer-list
))
2498 (setq buffer-list
(delq (current-buffer) buffer-list
))))
2501 (defun bibtex-complete-internal (completions)
2502 "Complete word fragment before point to longest prefix of COMPLETIONS.
2503 COMPLETIONS is an alist of strings. If point is not after the part
2504 of a word, all strings are listed. Return completion."
2505 (let* ((case-fold-search t
)
2506 (beg (save-excursion
2507 (re-search-backward "[ \t{\"]")
2511 (part-of-word (buffer-substring-no-properties beg end
))
2512 (completion (try-completion part-of-word completions
)))
2513 (cond ((not completion
)
2514 (error "Can't find completion for `%s'" part-of-word
))
2517 ((not (string= part-of-word completion
))
2518 (delete-region beg end
)
2522 (message "Making completion list...")
2523 (with-output-to-temp-buffer "*Completions*"
2524 (display-completion-list (all-completions part-of-word
2526 (message "Making completion list...done")
2527 ;; return value is handled by choose-completion-string-functions
2530 (defun bibtex-complete-string-cleanup (str compl
)
2531 "Cleanup after inserting string STR.
2532 Remove enclosing field delimiters for STR. Display message with
2533 expansion of STR using expansion list COMPL."
2535 (bibtex-inside-field)
2536 (let ((bounds (bibtex-enclosing-field))
2537 (abbr (cdr (if (stringp str
)
2538 (assoc-string str compl t
)))))
2539 (if abbr
(message "Abbreviation for `%s'" abbr
))
2540 (goto-char (bibtex-start-of-text-in-field bounds
))
2541 (let ((boundaries (bibtex-parse-field-string)))
2543 (equal (cdr boundaries
)
2544 (bibtex-end-of-text-in-field bounds
)))
2545 (bibtex-remove-delimiters))))))
2547 (defun bibtex-complete-crossref-cleanup (key)
2548 "Display summary message on entry KEY after completion of a crossref key.
2549 Use `bibtex-summary-function' to generate summary."
2551 (if (and (stringp key
)
2552 (bibtex-find-entry key t
))
2553 (message "Ref: %s" (funcall bibtex-summary-function
)))))
2555 (defun bibtex-copy-summary-as-kill ()
2556 "Push summery of current BibTeX entry to kill ring.
2557 Use `bibtex-summary-function' to generate summary."
2560 (bibtex-beginning-of-entry)
2561 (if (looking-at bibtex-entry-maybe-empty-head
)
2562 (kill-new (message "%s" (funcall bibtex-summary-function
)))
2563 (error "No entry found"))))
2565 (defun bibtex-summary ()
2566 "Return summary of current BibTeX entry.
2567 Used as default value of `bibtex-summary-function'."
2568 ;; It would be neat to customize this function. How?
2570 (if (looking-at bibtex-entry-maybe-empty-head
)
2571 (let* ((bibtex-autokey-name-case-convert 'identity
)
2572 (bibtex-autokey-name-length 'infty
)
2573 (bibtex-autokey-names 1)
2574 (bibtex-autokey-names-stretch 0)
2575 (bibtex-autokey-name-separator " ")
2576 (bibtex-autokey-additional-names " etal")
2577 (names (bibtex-autokey-get-names))
2578 (bibtex-autokey-year-length 4)
2579 (year (bibtex-autokey-get-year))
2580 (bibtex-autokey-titlewords 5)
2581 (bibtex-autokey-titlewords-stretch 2)
2582 (bibtex-autokey-titleword-case-convert 'identity
)
2583 (bibtex-autokey-titleword-length 5)
2584 (bibtex-autokey-titleword-separator " ")
2585 (title (bibtex-autokey-get-title))
2586 (journal (bibtex-autokey-get-field
2587 "journal" bibtex-autokey-transcriptions
))
2588 (volume (bibtex-autokey-get-field "volume"))
2589 (pages (bibtex-autokey-get-field "pages" '(("-.*\\'" .
"")))))
2590 (mapconcat (lambda (arg)
2591 (if (not (string= "" (cdr arg
)))
2592 (concat (car arg
) (cdr arg
))))
2593 `((" " .
,names
) (" " .
,year
) (": " .
,title
)
2594 (", " .
,journal
) (" " .
,volume
) (":" .
,pages
))
2596 (error "Entry not found"))))
2598 (defun bibtex-pop (arg direction
)
2599 "Fill current field from the ARGth same field's text in DIRECTION.
2600 Generic function used by `bibtex-pop-previous' and `bibtex-pop-next'."
2601 (let (bibtex-help-message)
2604 ;; parse current field
2605 (bibtex-inside-field)
2606 (let* ((case-fold-search t
)
2607 (bounds (bibtex-enclosing-field))
2608 (start-old-text (bibtex-start-of-text-in-field bounds
))
2609 (stop-old-text (bibtex-end-of-text-in-field bounds
))
2610 (field-name (bibtex-name-in-field bounds t
)))
2611 ;; if executed several times in a row, start each search where
2612 ;; the last one was finished
2613 (unless (eq last-command
'bibtex-pop
)
2614 (bibtex-enclosing-entry-maybe-empty-head)
2615 (setq bibtex-pop-previous-search-point
(match-beginning 0)
2616 bibtex-pop-next-search-point
(point)))
2617 (if (eq direction
'previous
)
2618 (goto-char bibtex-pop-previous-search-point
)
2619 (goto-char bibtex-pop-next-search-point
))
2620 ;; Now search for arg'th previous/next similar field
2621 (let (bounds failure new-text
)
2622 (while (and (not failure
)
2624 (cond ((eq direction
'previous
)
2625 (if (setq bounds
(bibtex-search-backward-field field-name
))
2626 (goto-char (bibtex-start-of-field bounds
))
2628 ((eq direction
'next
)
2629 (if (setq bounds
(bibtex-search-forward-field field-name
))
2630 (goto-char (bibtex-end-of-field bounds
))
2632 (setq arg
(- arg
1)))
2634 (error "No %s matching BibTeX field"
2635 (if (eq direction
'previous
) "previous" "next"))
2636 ;; Found a matching field. Remember boundaries.
2637 (setq bibtex-pop-previous-search-point
(bibtex-start-of-field bounds
)
2638 bibtex-pop-next-search-point
(bibtex-end-of-field bounds
)
2639 new-text
(bibtex-text-in-field-bounds bounds
))
2641 ;; Go back to where we started, delete old text, and pop new.
2642 (goto-char stop-old-text
)
2643 (delete-region start-old-text stop-old-text
)
2644 (insert new-text
)))))
2645 (let (bibtex-help-message)
2647 (setq this-command
'bibtex-pop
))
2649 (defun bibtex-beginning-of-field ()
2650 "Move point backward to beginning of field.
2651 This function uses a simple, fast algorithm assuming that the field
2652 begins at the beginning of a line. We use this function for font-locking."
2653 (let ((field-reg (concat "^[ \t]*" bibtex-field-name
"[ \t]*=")))
2655 (unless (looking-at field-reg
)
2656 (re-search-backward field-reg nil t
))))
2658 (defun bibtex-font-lock-url (bound)
2659 "Font-lock for URLs. BOUND limits the search."
2660 (let ((case-fold-search t
)
2662 field bounds start end found
)
2663 (bibtex-beginning-of-field)
2664 (while (and (not found
)
2665 (prog1 (re-search-forward bibtex-font-lock-url-regexp bound t
)
2666 (setq field
(match-string-no-properties 1)))
2667 (setq bounds
(bibtex-parse-field-text))
2669 (setq start
(car bounds
) end
(cdr bounds
))
2670 ;; Always ignore field delimiters
2671 (if (memq (char-before end
) '(?\
} ?
\"))
2672 (setq end
(1- end
)))
2673 (if (memq (char-after start
) '(?\
{ ?
\"))
2674 (setq start
(1+ start
)))
2676 (let ((lst bibtex-generate-url-list
) url
)
2678 (while (and (not found
)
2679 (setq url
(car (pop lst
))))
2680 (setq found
(and (bibtex-string= field
(car url
))
2681 (re-search-forward (cdr url
) end t
)
2682 (>= (match-beginning 0) pnt
)))))
2684 (if found
(bibtex-button (match-beginning 0) (match-end 0)
2685 'bibtex-url
(match-beginning 0)))
2688 (defun bibtex-font-lock-crossref (bound)
2689 "Font-lock for crossref fields. BOUND limits the search."
2690 (let ((case-fold-search t
)
2692 (crossref-reg (concat "^[ \t]*crossref[ \t]*=[ \t\n]*"
2693 "\\(\"[^\"]*\"\\|{[^}]*}\\)[ \t\n]*[,})]"))
2695 (bibtex-beginning-of-field)
2696 (while (and (not found
)
2697 (re-search-forward crossref-reg bound t
))
2698 (setq start
(1+ (match-beginning 1))
2699 end
(1- (match-end 1))
2700 found
(>= start pnt
)))
2701 (if found
(bibtex-button start end
'bibtex-find-crossref
2702 (buffer-substring-no-properties start end
)
2706 (defun bibtex-button-action (button)
2707 "Call BUTTON's BibTeX function."
2708 (apply (button-get button
'bibtex-function
)
2709 (button-get button
'bibtex-args
)))
2711 (define-button-type 'bibtex-url
2712 'action
'bibtex-button-action
2713 'bibtex-function
'bibtex-url
2714 'help-echo
(purecopy "mouse-2, RET: follow URL"))
2716 (define-button-type 'bibtex-find-crossref
2717 'action
'bibtex-button-action
2718 'bibtex-function
'bibtex-find-crossref
2719 'help-echo
(purecopy "mouse-2, RET: follow crossref"))
2721 (defun bibtex-button (beg end type
&rest args
)
2722 "Make a BibTeX button from BEG to END of type TYPE in the current buffer."
2723 (make-text-button beg end
'type type
'bibtex-args args
))
2726 ;; Interactive Functions:
2729 (defun bibtex-mode ()
2730 "Major mode for editing BibTeX files.
2732 General information on working with BibTeX mode:
2734 Use commands such as \\[bibtex-Book] to get a template for a specific entry.
2735 Then fill in all desired fields using \\[bibtex-next-field] to jump from field
2736 to field. After having filled in all desired fields in the entry, clean the
2737 new entry with the command \\[bibtex-clean-entry].
2739 Some features of BibTeX mode are available only by setting the variable
2740 `bibtex-maintain-sorted-entries' to non-nil. However, then BibTeX mode
2741 works only with buffers containing valid (syntactical correct) and sorted
2742 entries. This is usually the case, if you have created a buffer completely
2743 with BibTeX mode and finished every new entry with \\[bibtex-clean-entry].
2745 For third party BibTeX files, call the command \\[bibtex-convert-alien]
2746 to fully take advantage of all features of BibTeX mode.
2749 Special information:
2751 A command such as \\[bibtex-Book] outlines the fields for a BibTeX book entry.
2753 The names of optional fields start with the string OPT, and are thus ignored
2754 by BibTeX. The names of alternative fields from which only one is required
2755 start with the string ALT. The OPT or ALT string may be removed from
2756 the name of a field with \\[bibtex-remove-OPT-or-ALT].
2757 \\[bibtex-make-field] inserts a new field after the current one.
2758 \\[bibtex-kill-field] kills the current field entirely.
2759 \\[bibtex-yank] yanks the last recently killed field after the current field.
2760 \\[bibtex-remove-delimiters] removes the double-quotes or braces around the text of the current field.
2761 \\[bibtex-empty-field] replaces the text of the current field with the default \"\" or {}.
2762 \\[bibtex-find-text] moves point to the end of the current field.
2763 \\[bibtex-complete] completes word fragment before point according to context.
2765 The command \\[bibtex-clean-entry] cleans the current entry, i.e. it removes OPT/ALT
2766 from the names of all non-empty optional or alternative fields, checks that
2767 no required fields are empty, and does some formatting dependent on the value
2768 of `bibtex-entry-format'. Furthermore, it can automatically generate a key
2769 for the BibTeX entry, see `bibtex-generate-autokey'.
2770 Note: some functions in BibTeX mode depend on entries being in a special
2771 format (all fields beginning on separate lines), so it is usually a bad
2772 idea to remove `realign' from `bibtex-entry-format'.
2774 BibTeX mode supports Imenu and hideshow minor mode (`hs-minor-mode').
2776 ----------------------------------------------------------
2777 Entry to BibTeX mode calls the value of `bibtex-mode-hook'
2778 if that value is non-nil.
2780 \\{bibtex-mode-map}"
2782 (kill-all-local-variables)
2783 (use-local-map bibtex-mode-map
)
2784 (setq major-mode
'bibtex-mode
)
2785 (setq mode-name
"BibTeX")
2786 (set-syntax-table bibtex-mode-syntax-table
)
2787 (make-local-variable 'bibtex-buffer-last-parsed-tick
)
2788 ;; Install stealthy parse function if not already installed
2789 (unless bibtex-parse-idle-timer
2790 (setq bibtex-parse-idle-timer
(run-with-idle-timer
2791 bibtex-parse-keys-timeout t
2792 'bibtex-parse-buffers-stealthily
)))
2793 (set (make-local-variable 'paragraph-start
) "[ \f\n\t]*$")
2794 (set (make-local-variable 'comment-start
) bibtex-comment-start
)
2795 (set (make-local-variable 'comment-start-skip
)
2796 (concat (regexp-quote bibtex-comment-start
) "\\>[ \t]*"))
2797 (set (make-local-variable 'comment-column
) 0)
2798 (set (make-local-variable 'defun-prompt-regexp
) "^[ \t]*@[[:alnum:]]+[ \t]*")
2799 (set (make-local-variable 'outline-regexp
) "[ \t]*@")
2800 (set (make-local-variable 'fill-paragraph-function
) 'bibtex-fill-field
)
2801 (set (make-local-variable 'fill-prefix
) (make-string (+ bibtex-entry-offset
2802 bibtex-contline-indentation
)
2804 (set (make-local-variable 'font-lock-defaults
)
2805 '(bibtex-font-lock-keywords
2807 ;; Mathematical expressions should be fontified as strings
2809 ;; Quotes are field delimiters and quote-delimited
2810 ;; entries should be fontified in the same way as
2811 ;; brace-delimited ones
2814 (font-lock-syntactic-keywords . bibtex-font-lock-syntactic-keywords
)
2815 (font-lock-extra-managed-props .
(category))
2816 (font-lock-mark-block-function
2818 (set-mark (bibtex-end-of-entry))
2819 (bibtex-beginning-of-entry)))))
2820 (setq imenu-generic-expression
2821 (list (list nil bibtex-entry-head bibtex-key-in-head
))
2822 imenu-case-fold-search t
)
2823 (make-local-variable 'choose-completion-string-functions
)
2824 ;; XEmacs needs easy-menu-add, Emacs does not care
2825 (easy-menu-add bibtex-edit-menu
)
2826 (easy-menu-add bibtex-entry-menu
)
2827 (run-mode-hooks 'bibtex-mode-hook
))
2829 (defun bibtex-field-list (entry-type)
2830 "Return list of allowed fields for entry ENTRY-TYPE.
2831 More specifically, the return value is a cons pair (REQUIRED . OPTIONAL),
2832 where REQUIRED and OPTIONAL are lists of the required and optional field
2833 names for ENTRY-TYPE according to `bibtex-entry-field-alist',
2834 `bibtex-include-OPTkey', `bibtex-include-OPTcrossref',
2835 and `bibtex-user-optional-fields'."
2836 (let ((e (assoc-string entry-type bibtex-entry-field-alist t
))
2839 (error "BibTeX entry type %s not defined" entry-type
))
2840 (if (and (member-ignore-case entry-type bibtex-include-OPTcrossref
)
2842 (setq required
(nth 0 (nth 2 e
))
2843 optional
(nth 1 (nth 2 e
)))
2844 (setq required
(nth 0 (nth 1 e
))
2845 optional
(nth 1 (nth 1 e
))))
2846 (if bibtex-include-OPTkey
2848 "Used for reference key creation if author and editor fields are missing"
2849 (if (or (stringp bibtex-include-OPTkey
)
2850 (fboundp bibtex-include-OPTkey
))
2851 bibtex-include-OPTkey
))
2853 (if (member-ignore-case entry-type bibtex-include-OPTcrossref
)
2854 (push '("crossref" "Reference key of the cross-referenced entry")
2856 (setq optional
(append optional bibtex-user-optional-fields
))
2857 (cons required optional
)))
2859 (defun bibtex-entry (entry-type)
2860 "Insert a new BibTeX entry of type ENTRY-TYPE.
2861 After insertion call the value of `bibtex-add-entry-hook' if that value
2864 (let ((completion-ignore-case t
))
2865 (list (completing-read "Entry Type: " bibtex-entry-field-alist
2866 nil t nil
'bibtex-entry-type-history
))))
2867 (let ((key (if bibtex-maintain-sorted-entries
2868 (bibtex-read-key (format "%s key: " entry-type
))))
2869 (field-list (bibtex-field-list entry-type
)))
2870 (unless (bibtex-prepare-new-entry (list key nil entry-type
))
2871 (error "Entry with key `%s' already exists" key
))
2872 (indent-to-column bibtex-entry-offset
)
2873 (insert "@" entry-type
(bibtex-entry-left-delimiter))
2874 (if key
(insert key
))
2876 (mapc 'bibtex-make-field
(car field-list
))
2877 (mapc 'bibtex-make-optional-field
(cdr field-list
))
2878 (if bibtex-comma-after-last-field
2881 (indent-to-column bibtex-entry-offset
)
2882 (insert (bibtex-entry-right-delimiter) "\n\n"))
2883 (bibtex-next-field t
)
2884 (if (member-ignore-case entry-type bibtex-autofill-types
)
2885 (bibtex-autofill-entry))
2886 (run-hooks 'bibtex-add-entry-hook
)))
2888 (defun bibtex-entry-update ()
2889 "Update an existing BibTeX entry.
2890 In the BibTeX entry at point, make new fields for those items that may occur
2891 according to `bibtex-field-list', but are not yet present."
2894 (bibtex-beginning-of-entry)
2895 ;; For inserting new fields, we use the fact that
2896 ;; bibtex-parse-entry moves point to the end of the last field.
2897 (let* ((fields-alist (bibtex-parse-entry))
2898 (field-list (bibtex-field-list
2899 (cdr (assoc "=type=" fields-alist
)))))
2900 (dolist (field (car field-list
))
2901 (unless (assoc-string (car field
) fields-alist t
)
2902 (bibtex-make-field field
)))
2903 (dolist (field (cdr field-list
))
2904 (unless (assoc-string (car field
) fields-alist t
)
2905 (bibtex-make-optional-field field
))))))
2907 (defun bibtex-parse-entry ()
2908 "Parse entry at point, return an alist.
2909 The alist elements have the form (FIELD . TEXT), where FIELD can also be
2910 the special strings \"=type=\" and \"=key=\". For the FIELD \"=key=\"
2911 TEXT may be nil. Remove \"OPT\" and \"ALT\" from FIELD.
2912 Move point to the end of the last field."
2914 (when (looking-at bibtex-entry-maybe-empty-head
)
2915 (push (cons "=type=" (bibtex-type-in-head)) alist
)
2916 (push (cons "=key=" (bibtex-key-in-head)) alist
)
2917 (goto-char (match-end 0))
2918 (while (setq bounds
(bibtex-parse-field bibtex-field-name
))
2919 (push (cons (bibtex-name-in-field bounds t
)
2920 (bibtex-text-in-field-bounds bounds
))
2922 (goto-char (bibtex-end-of-field bounds
))))
2925 (defun bibtex-autofill-entry ()
2926 "Try to fill fields of current BibTeX entry based on neighboring entries.
2927 The current entry must have a key. Determine the neighboring entry
2928 \(previouse or next\) whose key is more similar to the key of the current
2929 entry. For all empty fields of the current entry insert the corresponding
2930 field contents of the neighboring entry. Finally try to update the text
2931 based on the difference between the keys of the neighboring and the current
2932 entry (for example, the year parts of the keys)."
2934 (undo-boundary) ;So you can easily undo it, if it didn't work right.
2935 (bibtex-beginning-of-entry)
2936 (when (looking-at bibtex-entry-head
)
2937 (let ((type (bibtex-type-in-head))
2938 (key (bibtex-key-in-head))
2939 (key-end (match-end bibtex-key-in-head
))
2940 (case-fold-search t
)
2941 tmp other-key other bounds
)
2942 ;; The fields we want to change start right after the key.
2944 ;; First see whether to use the previous or the next entry
2945 ;; for "inspiration".
2947 (goto-char (1- (match-beginning 0)))
2948 (bibtex-beginning-of-entry)
2949 (if (and (looking-at bibtex-entry-head
)
2950 (bibtex-string= type
(bibtex-type-in-head))
2951 ;; In case we found ourselves :-(
2952 (not (equal key
(setq tmp
(bibtex-key-in-head)))))
2956 (bibtex-end-of-entry)
2957 (bibtex-skip-to-valid-entry)
2958 (if (and (looking-at bibtex-entry-head
)
2959 (bibtex-string= type
(bibtex-type-in-head))
2960 ;; In case we found ourselves :-(
2961 (not (equal key
(setq tmp
(bibtex-key-in-head))))
2963 ;; Check which is the best match.
2964 (< (length (try-completion "" (list key other-key
)))
2965 (length (try-completion "" (list key tmp
))))))
2968 ;; Then fill the new entry's fields with the chosen other entry.
2970 (setq other
(save-excursion (goto-char other
) (bibtex-parse-entry)))
2971 (setq key-end
(point)) ;In case parse-entry changed the buffer.
2972 (while (setq bounds
(bibtex-parse-field bibtex-field-name
))
2973 (let ((text (assoc-string (bibtex-name-in-field bounds t
)
2976 (string-match bibtex-empty-field-re
2977 (buffer-substring-no-properties
2978 (bibtex-start-of-text-in-field bounds
)
2979 (bibtex-end-of-text-in-field bounds
)))))
2980 (goto-char (bibtex-end-of-field bounds
))
2981 (goto-char (bibtex-start-of-text-in-field bounds
))
2982 (delete-region (point) (bibtex-end-of-text-in-field bounds
))
2983 (insert (cdr text
)))))
2984 ;; Finally try to update the text based on the difference between
2986 (let* ((prefix (try-completion "" (list key other-key
)))
2987 ;; If the keys are foo91 and foo92, don't replace 1 for 2
2988 ;; but 91 for 92 instead.
2989 (_ (if (string-match "[0-9]+\\'" prefix
)
2990 (setq prefix
(substring prefix
0 (match-beginning 0)))))
2991 (suffix (substring key
(length prefix
)))
2992 (other-suffix (substring other-key
(length prefix
))))
2993 (while (re-search-backward (regexp-quote other-suffix
) key-end
'move
)
2994 (replace-match suffix
)))))))
2996 (defun bibtex-print-help-message ()
2997 "Print helpful information about current field in current BibTeX entry."
3000 (let* ((case-fold-search t
)
3001 (field-name (bibtex-name-in-field (bibtex-enclosing-field) t
))
3002 (field-list (bibtex-field-list (progn (re-search-backward
3003 bibtex-entry-maybe-empty-head nil t
)
3004 (bibtex-type-in-head))))
3005 (comment (assoc-string field-name
3006 (append (car field-list
)
3010 (message (nth 1 comment
))
3011 (message "No comment available")))))
3013 (defun bibtex-make-field (field &optional move interactive
)
3014 "Make a field named FIELD in current BibTeX entry.
3015 FIELD is either a string or a list of the form
3016 \(FIELD-NAME COMMENT-STRING INIT ALTERNATIVE-FLAG) as in
3017 `bibtex-entry-field-alist'.
3018 If MOVE is non-nil, move point past the present field before making
3019 the new field. If INTERACTIVE is non-nil, move point to the end of
3020 the new field. Otherwise move point past the new field.
3021 MOVE and INTERACTIVE are t when called interactively."
3023 (list (let ((completion-ignore-case t
)
3024 (field-list (bibtex-field-list
3026 (bibtex-enclosing-entry-maybe-empty-head)
3027 (bibtex-type-in-head)))))
3028 (completing-read "BibTeX field name: "
3029 (append (car field-list
) (cdr field-list
))
3030 nil nil nil bibtex-field-history
))
3032 (unless (consp field
)
3033 (setq field
(list field
)))
3035 (let (bibtex-help-message)
3037 (if (looking-at "[}\"]")
3040 (indent-to-column (+ bibtex-entry-offset bibtex-field-indentation
))
3041 (if (nth 3 field
) (insert "ALT"))
3042 (insert (car field
) " ")
3043 (if bibtex-align-at-equal-sign
3044 (indent-to-column (+ bibtex-entry-offset
3045 (- bibtex-text-indentation
2))))
3047 (unless bibtex-align-at-equal-sign
3048 (indent-to-column (+ bibtex-entry-offset
3049 bibtex-text-indentation
)))
3050 (let ((init (nth 2 field
)))
3051 (insert (cond ((stringp init
) init
)
3052 ((fboundp init
) (funcall init
))
3053 (t (concat (bibtex-field-left-delimiter)
3054 (bibtex-field-right-delimiter))))))
3057 (bibtex-print-help-message)))
3059 (defun bibtex-beginning-of-entry ()
3060 "Move to beginning of BibTeX entry (beginning of line).
3061 If inside an entry, move to the beginning of it, otherwise move to the
3062 beginning of the previous entry. If point is ahead of all BibTeX entries
3063 move point to the beginning of buffer. Return the new location of point."
3065 (skip-chars-forward " \t")
3066 (if (looking-at "@")
3068 (re-search-backward "^[ \t]*@" nil
'move
)
3071 (defun bibtex-end-of-entry ()
3072 "Move to end of BibTeX entry (past the closing brace).
3073 If inside an entry, move to the end of it, otherwise move to the end
3074 of the previous entry. Do not move if ahead of first entry.
3075 Return the new location of point."
3077 (let ((case-fold-search t
)
3079 (pnt (bibtex-beginning-of-entry))
3081 (cond ((looking-at bibtex-valid-entry-whitespace-re
)
3082 (bibtex-search-entry t nil t
)
3083 (unless (equal (match-beginning 0) pnt
)
3085 ((setq bounds
(bibtex-parse-string))
3086 (goto-char (bibtex-end-of-string bounds
)))
3087 ((looking-at "[ \t]*@[ \t]*preamble[ \t\n]*")
3088 (goto-char (match-end 0))
3089 (if (looking-at "[({]")
3094 (message "Not on a known BibTeX entry."))
3098 (error "Syntactically incorrect BibTeX entry starts here")))
3101 (defun bibtex-goto-line (arg)
3102 "Goto line ARG, counting from beginning of (narrowed) buffer."
3103 ;; code adapted from `goto-line'
3104 (goto-char (point-min))
3105 (if (eq selective-display t
)
3106 (re-search-forward "[\n\C-m]" nil
'end
(1- arg
))
3107 (forward-line (1- arg
))))
3109 (defun bibtex-reposition-window ()
3110 "Make the current BibTeX entry visible.
3111 If entry is smaller than `window-body-height', entry is centered in window.
3112 Otherwise display the beginning of entry."
3115 (beg (line-number-at-pos (bibtex-beginning-of-entry)))
3116 (end (line-number-at-pos (bibtex-end-of-entry))))
3117 (if (> (window-body-height) (- end beg
))
3118 ;; entry fits in current window
3120 (bibtex-goto-line (/ (+ 1 beg end
) 2))
3123 ;; entry too large for current window
3124 (bibtex-goto-line beg
)
3126 (if (> (1+ (- (line-number-at-pos pnt
) beg
))
3127 (window-body-height))
3128 (bibtex-goto-line beg
)
3131 (defun bibtex-mark-entry ()
3132 "Put mark at beginning, point at end of current BibTeX entry."
3134 (set-mark (bibtex-beginning-of-entry))
3135 (bibtex-end-of-entry))
3137 (defun bibtex-count-entries (&optional count-string-entries
)
3138 "Count number of entries in current buffer or region.
3139 With prefix argument COUNT-STRING-ENTRIES count all entries,
3140 otherwise count all entries except @String entries.
3141 If mark is active count entries in region, if not in whole buffer."
3144 (bibtex-sort-ignore-string-entries
3145 (not count-string-entries
)))
3148 (narrow-to-region (if mark-active
(region-beginning)
3149 (bibtex-beginning-of-first-entry))
3150 (if mark-active
(region-end) (point-max)))
3151 (bibtex-map-entries (lambda (key beg end
)
3152 (setq number
(1+ number
))))))
3153 (message "%s contains %d entries."
3154 (if mark-active
"Region" "Buffer")
3157 (defun bibtex-ispell-entry ()
3158 "Check BibTeX entry for spelling errors."
3160 (ispell-region (save-excursion (bibtex-beginning-of-entry))
3161 (save-excursion (bibtex-end-of-entry))))
3163 (defun bibtex-ispell-abstract ()
3164 "Check abstract of BibTeX entry for spelling errors."
3166 (let ((bounds (save-excursion
3167 (bibtex-beginning-of-entry)
3168 (bibtex-search-forward-field "abstract" t
))))
3170 (ispell-region (bibtex-start-of-text-in-field bounds
)
3171 (bibtex-end-of-text-in-field bounds
))
3172 (error "No abstract in entry"))))
3174 (defun bibtex-narrow-to-entry ()
3175 "Narrow buffer to current BibTeX entry."
3179 (narrow-to-region (bibtex-beginning-of-entry)
3180 (bibtex-end-of-entry))))
3182 (defun bibtex-entry-index ()
3183 "Return index of BibTeX entry head at or past position of point.
3184 The index is a list (KEY CROSSREF-KEY ENTRY-NAME) that is used for sorting
3185 the entries of the BibTeX buffer. CROSSREF-KEY is nil unless the value
3186 of `bibtex-maintain-sorted-entries' is `crossref'. Move point to the end
3187 of the head of the entry found. Return nil if no entry found."
3188 (let ((case-fold-search t
))
3189 (if (re-search-forward bibtex-entry-maybe-empty-head nil t
)
3190 (let ((key (bibtex-key-in-head))
3191 ;; all entry names should be downcase (for ease of comparison)
3192 (entry-name (downcase (bibtex-type-in-head))))
3193 ;; Don't search CROSSREF-KEY if we don't need it.
3194 (if (eq bibtex-maintain-sorted-entries
'crossref
)
3195 (let ((bounds (bibtex-search-forward-field
3196 "\\(OPT\\)?crossref" t
)))
3198 (if bounds
(bibtex-text-in-field-bounds bounds t
))
3200 (list key nil entry-name
))))))
3202 (defun bibtex-lessp (index1 index2
)
3203 "Predicate for sorting BibTeX entries with indices INDEX1 and INDEX2.
3204 Each index is a list (KEY CROSSREF-KEY ENTRY-NAME).
3205 The predicate depends on the variable `bibtex-maintain-sorted-entries'.
3206 If its value is nil use plain sorting."
3207 (cond ((not index1
) (not index2
)) ; indices can be nil
3209 ((eq bibtex-maintain-sorted-entries
'crossref
)
3212 (or (string-lessp (nth 1 index1
) (nth 1 index2
))
3213 (and (string-equal (nth 1 index1
) (nth 1 index2
))
3214 (string-lessp (nth 0 index1
) (nth 0 index2
))))
3215 (not (string-lessp (nth 0 index2
) (nth 1 index1
))))
3217 (string-lessp (nth 0 index1
) (nth 1 index2
))
3218 (string-lessp (nth 0 index1
) (nth 0 index2
)))))
3219 ((eq bibtex-maintain-sorted-entries
'entry-class
)
3220 (let ((n1 (cdr (or (assoc (nth 2 index1
) bibtex-sort-entry-class-alist
)
3221 (assoc 'catch-all bibtex-sort-entry-class-alist
)
3222 '(nil .
1000)))) ; if there is nothing else
3223 (n2 (cdr (or (assoc (nth 2 index2
) bibtex-sort-entry-class-alist
)
3224 (assoc 'catch-all bibtex-sort-entry-class-alist
)
3225 '(nil .
1000))))) ; if there is nothing else
3228 (string-lessp (car index1
) (car index2
))))))
3229 (t ; (eq bibtex-maintain-sorted-entries 'plain)
3230 (string-lessp (car index1
) (car index2
)))))
3232 (defun bibtex-sort-buffer ()
3233 "Sort BibTeX buffer alphabetically by key.
3234 The predicate for sorting is defined via `bibtex-maintain-sorted-entries'.
3235 If its value is nil use plain sorting. Text outside of BibTeX entries is not
3236 affected. If `bibtex-sort-ignore-string-entries' is non-nil, @String entries
3240 (narrow-to-region (bibtex-beginning-of-first-entry)
3241 (save-excursion (goto-char (point-max))
3242 (bibtex-end-of-entry)))
3243 (bibtex-skip-to-valid-entry)
3245 'bibtex-skip-to-valid-entry
; NEXTREC function
3246 'bibtex-end-of-entry
; ENDREC function
3247 'bibtex-entry-index
; STARTKEY function
3248 nil
; ENDKEY function
3249 'bibtex-lessp
))) ; PREDICATE
3251 (defun bibtex-find-crossref (crossref-key &optional pnt split
)
3252 "Move point to the beginning of BibTeX entry CROSSREF-KEY.
3253 If `bibtex-files' is non-nil, search all these files.
3254 Otherwise the search is limited to the current buffer.
3255 Return position of entry if CROSSREF-KEY is found or nil otherwise.
3256 If CROSSREF-KEY is in the same buffer like current entry but before it
3257 an error is signaled. Optional arg PNT is the position of the referencing
3258 entry. It defaults to position of point. If optional arg SPLIT is non-nil,
3259 split window so that both the referencing and the crossrefed entry are
3261 If called interactively, CROSSREF-KEY defaults to crossref key of current
3262 entry and SPLIT is t."
3266 (bibtex-beginning-of-entry)
3267 (let ((bounds (bibtex-search-forward-field "crossref" t
)))
3269 (bibtex-text-in-field-bounds bounds t
))))))
3270 (list (bibtex-read-key "Find crossref key: " crossref-key t
)
3272 (let (buffer pos eqb
)
3274 (setq pos
(bibtex-find-entry crossref-key t
)
3275 buffer
(current-buffer)))
3276 (setq eqb
(eq buffer
(current-buffer)))
3278 (if split
(message "Crossref key `%s' not found" crossref-key
)))
3279 (split ; called (quasi) interactively
3280 (unless pnt
(setq pnt
(point)))
3282 (if eqb
(select-window (split-window))
3283 (pop-to-buffer buffer
))
3285 (bibtex-reposition-window)
3287 (if (and eqb
(> pnt pos
))
3288 (error "The referencing entry must precede the crossrefed entry!")))
3289 ;; `bibtex-find-crossref' is called noninteractively during
3290 ;; clean-up of an entry. Then it is not possible to check
3291 ;; whether the current entry and the crossrefed entry have
3292 ;; the correct sorting order.
3293 (eqb (goto-char pos
))
3294 (t (set-buffer buffer
) (goto-char pos
)))
3297 (defun bibtex-find-entry (key &optional global start display
)
3298 "Move point to the beginning of BibTeX entry named KEY.
3299 Return position of entry if KEY is found or nil if not found.
3300 With prefix arg GLOBAL non-nil, search KEY in `bibtex-files'.
3301 Otherwise the search is limited to the current buffer.
3302 Optional arg START is buffer position where the search starts.
3303 If it is nil, start search at beginning of buffer.
3304 If DISPLAY is non-nil, display the buffer containing KEY.
3305 Otherwise, use `set-buffer'. DISPLAY is t when called interactively."
3306 (interactive (list (bibtex-read-key "Find key: " nil current-prefix-arg
)
3307 current-prefix-arg nil t
))
3308 (if (and global bibtex-files
)
3309 (let ((buffer-list (bibtex-files-expand t
))
3311 (while (and (not found
)
3312 (setq buffer
(pop buffer-list
)))
3313 (with-current-buffer buffer
3314 (if (cdr (assoc-string key bibtex-reference-keys
))
3315 ;; `bibtex-find-entry' moves point if key found
3316 (setq found
(bibtex-find-entry key
)))))
3317 (cond ((and found display
)
3318 (let ((same-window-buffer-names
3319 (cons (buffer-name buffer
) same-window-buffer-names
)))
3320 (pop-to-buffer buffer
)
3321 (bibtex-reposition-window)))
3322 (found (set-buffer buffer
))
3323 (display (message "Key `%s' not found" key
)))
3326 (let* (case-fold-search
3327 (pnt (save-excursion
3328 (goto-char (or start
(point-min)))
3329 (if (re-search-forward (concat "^[ \t]*\\("
3331 "\\)[ \t]*[({][ \t\n]*\\("
3335 (match-beginning 0)))))
3338 (if display
(bibtex-reposition-window)))
3339 (display (message "Key `%s' not found" key
)))
3342 (defun bibtex-prepare-new-entry (index)
3343 "Prepare a new BibTeX entry with index INDEX.
3344 INDEX is a list (KEY CROSSREF-KEY ENTRY-NAME).
3345 Move point where the entry KEY should be placed.
3346 If `bibtex-maintain-sorted-entries' is non-nil, perform a binary
3347 search to look for place for KEY. This requires that buffer is sorted,
3348 see `bibtex-validate'.
3349 Return t if preparation was successful or nil if entry KEY already exists."
3350 (let ((key (nth 0 index
))
3352 (cond ((or (null key
)
3354 (string-equal key
""))
3355 (and (not (setq key-exist
(bibtex-find-entry key
)))
3356 (not bibtex-maintain-sorted-entries
)))
3357 (bibtex-move-outside-of-entry))
3358 ;; if key-exist is non-nil due to the previous cond clause
3359 ;; then point will be at beginning of entry named key.
3361 (t ; bibtex-maintain-sorted-entries is non-nil
3362 (let* ((case-fold-search t
)
3363 (left (save-excursion (bibtex-beginning-of-first-entry)
3364 (bibtex-skip-to-valid-entry)
3366 (right (save-excursion (bibtex-beginning-of-last-entry)
3367 (bibtex-end-of-entry)))
3368 (found (if (>= left right
) left
))
3373 (goto-char (/ (+ left right
) 2))
3374 (bibtex-skip-to-valid-entry t
)
3375 (setq actual-index
(bibtex-entry-index))
3376 (cond ((bibtex-lessp index actual-index
)
3377 (setq new
(bibtex-beginning-of-entry))
3378 (if (equal right new
)
3382 (bibtex-end-of-entry)
3383 (bibtex-skip-to-valid-entry)
3385 (if (equal left new
)
3387 (setq left new
))))))
3389 (bibtex-beginning-of-entry)
3390 (setq actual-index
(save-excursion (bibtex-entry-index)))
3391 (when (or (not actual-index
)
3392 (bibtex-lessp actual-index index
))
3393 ;; buffer contains no valid entries or
3394 ;; greater than last entry --> append
3395 (bibtex-end-of-entry)
3396 (unless (bobp) (newline (forward-line 2)))
3397 (beginning-of-line)))))
3398 (unless key-exist t
)))
3400 (defun bibtex-validate (&optional test-thoroughly
)
3401 "Validate if buffer or region is syntactically correct.
3402 Check also for duplicate keys and correct sort order provided
3403 `bibtex-maintain-sorted-entries' is non-nil.
3404 With optional argument TEST-THOROUGHLY non-nil check also for
3405 the absence of required fields and for questionable month fields.
3406 If mark is active, validate current region, if not the whole buffer.
3407 Only check known entry types, so you can put comments outside of entries.
3408 Return t if test was successful, nil otherwise."
3410 (let* ((case-fold-search t
)
3411 error-list syntax-error
)
3414 (narrow-to-region (if mark-active
(region-beginning)
3415 (bibtex-beginning-of-first-entry))
3416 (if mark-active
(region-end) (point-max)))
3418 ;; looking if entries fit syntactical structure
3419 (goto-char (point-min))
3420 (bibtex-progress-message "Checking syntactical structure")
3421 (let (bibtex-sort-ignore-string-entries)
3422 (while (re-search-forward "^[ \t]*@" nil t
)
3423 (bibtex-progress-message)
3425 (let ((pnt (point)))
3426 (if (not (looking-at bibtex-any-valid-entry-re
))
3428 (bibtex-skip-to-valid-entry)
3429 (if (equal (point) pnt
)
3432 (push (cons (bibtex-current-line)
3433 "Syntax error (check esp. commas, braces, and quotes)")
3436 (bibtex-progress-message 'done
)
3439 ;; proceed only if there were no syntax errors.
3440 (setq syntax-error t
)
3442 ;; looking for duplicate keys and correct sort order
3443 (let (previous current key-list
)
3444 (bibtex-progress-message "Checking for duplicate keys")
3446 (lambda (key beg end
)
3447 (bibtex-progress-message)
3449 (setq current
(bibtex-entry-index))
3450 (cond ((not previous
))
3451 ((member key key-list
)
3452 (push (cons (bibtex-current-line)
3453 (format "Duplicate key `%s'" key
))
3455 ((and bibtex-maintain-sorted-entries
3456 (not (bibtex-lessp previous current
)))
3457 (push (cons (bibtex-current-line)
3458 "Entries out of order")
3461 (setq previous current
)))
3462 (bibtex-progress-message 'done
))
3464 ;; Check for duplicate keys in `bibtex-files'.
3466 ;; We don't want to be fooled by outdated `bibtex-reference-keys'.
3467 (dolist (buffer (bibtex-files-expand nil t
))
3468 (dolist (key (with-current-buffer buffer bibtex-reference-keys
))
3469 (when (and (cdr key
)
3470 (cdr (assoc-string (car key
) bibtex-reference-keys
)))
3471 (bibtex-find-entry (car key
))
3472 (push (cons (bibtex-current-line)
3473 (format "Duplicate key `%s' in %s" (car key
)
3474 (abbreviate-file-name (buffer-file-name buffer
))))
3477 (when test-thoroughly
3478 (bibtex-progress-message
3479 "Checking required fields and month fields")
3480 (let ((bibtex-sort-ignore-string-entries t
))
3482 (lambda (key beg end
)
3483 (bibtex-progress-message)
3484 (let* ((entry-list (progn
3486 (bibtex-search-entry nil end
)
3487 (assoc-string (bibtex-type-in-head)
3488 bibtex-entry-field-alist t
)))
3489 (req (copy-sequence (elt (elt entry-list
1) 0)))
3490 (creq (copy-sequence (elt (elt entry-list
2) 0)))
3491 crossref-there bounds alt-there field
)
3493 (while (setq bounds
(bibtex-search-forward-field
3494 bibtex-field-name end
))
3495 (goto-char (bibtex-start-of-text-in-field bounds
))
3496 (let ((field-name (bibtex-name-in-field bounds
)))
3497 (if (and (bibtex-string= field-name
"month")
3498 ;; Check only abbreviated month fields.
3499 (let ((month (bibtex-text-in-field-bounds bounds
)))
3500 (not (or (string-match "\\`[\"{].+[\"}]\\'" month
)
3503 bibtex-predefined-month-strings t
)))))
3504 (push (cons (bibtex-current-line)
3505 "Questionable month field")
3507 (setq field
(assoc-string field-name req t
))
3509 (if alt-there
(push (cons (bibtex-current-line)
3510 "More than one non-empty alternative")
3512 (setq alt-there t
)))
3513 (setq req
(delete field req
)
3514 creq
(delete (assoc-string field-name creq t
) creq
))
3515 (if (bibtex-string= field-name
"crossref")
3516 (setq crossref-there t
))))
3522 (push (car field
) alt
)
3523 (push (cons (save-excursion (goto-char beg
)
3524 (bibtex-current-line))
3525 (format "Required field `%s' missing"
3528 ;; The following fails if there are more than two
3529 ;; alternatives in a BibTeX entry, which isn't
3530 ;; the case momentarily.
3532 (push (cons (save-excursion (goto-char beg
)
3533 (bibtex-current-line))
3534 (format "Alternative fields `%s'/`%s' missing"
3535 (car alt
) (cadr alt
)))
3537 (bibtex-progress-message 'done
)))))
3540 (let ((file (file-name-nondirectory (buffer-file-name)))
3541 (dir default-directory
)
3542 (err-buf "*BibTeX validation errors*"))
3543 (setq error-list
(sort error-list
'car-less-than-car
))
3544 (with-current-buffer (get-buffer-create err-buf
)
3545 (setq default-directory dir
)
3546 (unless (eq major-mode
'compilation-mode
) (compilation-mode))
3547 (toggle-read-only -
1)
3548 (delete-region (point-min) (point-max))
3549 (insert "BibTeX mode command `bibtex-validate'\n"
3551 "Maybe undetected errors due to syntax errors. Correct and validate again.\n"
3553 (dolist (err error-list
)
3554 (insert (format "%s:%d: %s\n" file
(car err
) (cdr err
))))
3555 (set-buffer-modified-p nil
)
3556 (toggle-read-only 1)
3557 (goto-line 3)) ; first error message
3558 (display-buffer err-buf
)
3561 (message "%s is syntactically correct"
3562 (if mark-active
"Region" "Buffer"))
3565 (defun bibtex-validate-globally (&optional strings
)
3566 "Check for duplicate keys in `bibtex-files'.
3567 With optional prefix arg STRINGS, check for duplicate strings, too.
3568 Return t if test was successful, nil otherwise."
3570 (let ((buffer-list (bibtex-files-expand t
))
3571 buffer-key-list current-buf current-keys error-list
)
3572 ;; Check for duplicate keys within BibTeX buffer
3573 (dolist (buffer buffer-list
)
3576 (let (entry-type key key-list
)
3577 (goto-char (point-min))
3578 (while (re-search-forward bibtex-entry-head nil t
)
3579 (setq entry-type
(bibtex-type-in-head)
3580 key
(bibtex-key-in-head))
3581 (if (or (and strings
(bibtex-string= entry-type
"string"))
3582 (assoc-string entry-type bibtex-entry-field-alist t
))
3583 (if (member key key-list
)
3584 (push (format "%s:%d: Duplicate key `%s'\n"
3586 (bibtex-current-line) key
)
3588 (push key key-list
))))
3589 (push (cons buffer key-list
) buffer-key-list
))))
3591 ;; Check for duplicate keys among BibTeX buffers
3592 (while (setq current-buf
(pop buffer-list
))
3593 (setq current-keys
(cdr (assq current-buf buffer-key-list
)))
3594 (with-current-buffer current-buf
3595 (dolist (buffer buffer-list
)
3596 (dolist (key (cdr (assq buffer buffer-key-list
)))
3597 (when (assoc-string key current-keys
)
3598 (bibtex-find-entry key
)
3599 (push (format "%s:%d: Duplicat key `%s' in %s\n"
3600 (buffer-file-name) (bibtex-current-line) key
3601 (abbreviate-file-name (buffer-file-name buffer
)))
3604 ;; Process error list
3606 (let ((err-buf "*BibTeX validation errors*"))
3607 (with-current-buffer (get-buffer-create err-buf
)
3608 (unless (eq major-mode
'compilation-mode
) (compilation-mode))
3609 (toggle-read-only -
1)
3610 (delete-region (point-min) (point-max))
3611 (insert "BibTeX mode command `bibtex-validate-globally'\n\n")
3612 (dolist (err (sort error-list
'string-lessp
)) (insert err
))
3613 (set-buffer-modified-p nil
)
3614 (toggle-read-only 1)
3615 (goto-line 3)) ; first error message
3616 (display-buffer err-buf
)
3619 (message "No duplicate keys.")
3622 (defun bibtex-next-field (begin)
3623 "Move point to end of text of next BibTeX field.
3624 With prefix BEGIN non-nil, move point to its beginning."
3626 (bibtex-inside-field)
3627 (let ((start (point)))
3629 (let ((bounds (bibtex-enclosing-field)))
3630 (goto-char (bibtex-end-of-field bounds
))
3636 (bibtex-find-text begin
))
3638 (defun bibtex-find-text (&optional begin noerror
)
3639 "Move point to end of text of current BibTeX field.
3640 With optional prefix BEGIN non-nil, move point to its beginning.
3641 Unless NOERROR is non-nil, an error is signaled if point is not
3644 (let* ((pnt (point))
3645 (_ (bibtex-inside-field))
3646 (bounds (bibtex-enclosing-field t
)))
3650 (progn (goto-char (bibtex-start-of-text-in-field bounds
))
3651 (if (looking-at "[{\"]")
3653 (goto-char (bibtex-end-of-text-in-field bounds
))
3654 (if (or (= (preceding-char) ?
})
3655 (= (preceding-char) ?
\"))
3657 (if bibtex-help-message
3658 (bibtex-print-help-message)))
3659 ((setq bounds
(bibtex-parse-string))
3660 (goto-char (if begin
3661 (1+ (bibtex-start-of-text-in-string bounds
))
3662 (1- (bibtex-end-of-text-in-string bounds
)))))
3663 ((looking-at bibtex-entry-maybe-empty-head
)
3664 (goto-char (if begin
3665 (match-beginning bibtex-key-in-head
)
3669 (unless noerror
(error "Not on BibTeX field"))))))
3671 (defun bibtex-remove-OPT-or-ALT ()
3672 "Remove the string starting optional/alternative fields.
3673 Align text and go thereafter to end of text."
3675 (bibtex-inside-field)
3676 (let ((case-fold-search t
)
3677 (bounds (bibtex-enclosing-field)))
3679 (goto-char (bibtex-start-of-name-in-field bounds
))
3680 (when (looking-at "OPT\\|ALT")
3681 (delete-region (match-beginning 0) (match-end 0))
3682 ;; make field non-OPT
3683 (search-forward "=")
3685 (delete-horizontal-space)
3686 (if bibtex-align-at-equal-sign
3687 (indent-to-column (- bibtex-text-indentation
2))
3689 (search-forward "=")
3690 (delete-horizontal-space)
3691 (if bibtex-align-at-equal-sign
3693 (indent-to-column bibtex-text-indentation
))))
3694 (bibtex-inside-field)))
3696 (defun bibtex-remove-delimiters ()
3697 "Remove \"\" or {} around string."
3700 (bibtex-inside-field)
3701 (let* ((bounds (bibtex-enclosing-field))
3702 (end (bibtex-end-of-text-in-field bounds
))
3703 (start (bibtex-start-of-text-in-field bounds
)))
3704 (if (memq (char-before end
) '(?\
} ?
\"))
3705 (delete-region (1- end
) end
))
3706 (if (memq (char-after start
) '(?\
{ ?
\"))
3707 (delete-region start
(1+ start
))))))
3709 (defun bibtex-kill-field (&optional copy-only
)
3710 "Kill the entire enclosing BibTeX field.
3711 With prefix arg COPY-ONLY, copy the current field to `bibtex-field-kill-ring',
3712 but do not actually kill it."
3715 (bibtex-inside-field)
3716 (let* ((case-fold-search t
)
3717 (bounds (bibtex-enclosing-field))
3718 (end (bibtex-end-of-field bounds
))
3719 (beg (bibtex-start-of-field bounds
)))
3721 (skip-chars-forward " \t\n,")
3722 (push (list (bibtex-name-in-field bounds
) nil
3723 (bibtex-text-in-field-bounds bounds
))
3724 bibtex-field-kill-ring
)
3725 (if (> (length bibtex-field-kill-ring
) bibtex-field-kill-ring-max
)
3726 (setcdr (nthcdr (1- bibtex-field-kill-ring-max
)
3727 bibtex-field-kill-ring
)
3729 (setq bibtex-field-kill-ring-yank-pointer bibtex-field-kill-ring
)
3731 (delete-region beg end
))))
3732 (setq bibtex-last-kill-command
'field
))
3734 (defun bibtex-copy-field-as-kill ()
3735 "Copy the BibTeX field at point to the kill ring."
3737 (bibtex-kill-field t
))
3739 (defun bibtex-kill-entry (&optional copy-only
)
3740 "Kill the entire enclosing BibTeX entry.
3741 With prefix arg COPY-ONLY, copy the current entry to `bibtex-entry-kill-ring',
3742 but do not actually kill it."
3745 (let* ((case-fold-search t
)
3746 (beg (bibtex-beginning-of-entry))
3747 (end (progn (bibtex-end-of-entry)
3748 (if (re-search-forward
3749 bibtex-entry-maybe-empty-head nil
'move
)
3750 (goto-char (match-beginning 0)))
3752 (push (buffer-substring-no-properties beg end
)
3753 bibtex-entry-kill-ring
)
3754 (if (> (length bibtex-entry-kill-ring
) bibtex-entry-kill-ring-max
)
3755 (setcdr (nthcdr (1- bibtex-entry-kill-ring-max
)
3756 bibtex-entry-kill-ring
)
3758 (setq bibtex-entry-kill-ring-yank-pointer bibtex-entry-kill-ring
)
3760 (delete-region beg end
))))
3761 (setq bibtex-last-kill-command
'entry
))
3763 (defun bibtex-copy-entry-as-kill ()
3764 "Copy the entire enclosing BibTeX entry to `bibtex-entry-kill-ring'."
3766 (bibtex-kill-entry t
))
3768 (defun bibtex-yank (&optional n
)
3769 "Reinsert the last BibTeX item.
3770 More precisely, reinsert the field or entry killed or yanked most recently.
3771 With argument N, reinsert the Nth most recently killed BibTeX item.
3772 See also the command \\[bibtex-yank-pop]."
3774 (bibtex-insert-kill (1- n
))
3775 (setq this-command
'bibtex-yank
))
3777 (defun bibtex-yank-pop (n)
3778 "Replace just-yanked killed BibTeX item with a different item.
3779 This command is allowed only immediately after a `bibtex-yank' or a
3780 `bibtex-yank-pop'. At such a time, the region contains a reinserted
3781 previously killed BibTeX item. `bibtex-yank-pop' deletes that item
3782 and inserts in its place a different killed BibTeX item.
3784 With no argument, the previous kill is inserted.
3785 With argument N, insert the Nth previous kill.
3786 If N is negative, this is a more recent kill.
3788 The sequence of kills wraps around, so that after the oldest one
3789 comes the newest one."
3791 (unless (eq last-command
'bibtex-yank
)
3792 (error "Previous command was not a BibTeX yank"))
3793 (setq this-command
'bibtex-yank
)
3794 (let ((inhibit-read-only t
))
3795 (delete-region (point) (mark t
))
3796 (bibtex-insert-kill n
)))
3798 (defun bibtex-empty-field ()
3799 "Delete the text part of the current field, replace with empty text."
3801 (bibtex-inside-field)
3802 (let ((bounds (bibtex-enclosing-field)))
3803 (goto-char (bibtex-start-of-text-in-field bounds
))
3804 (delete-region (point) (bibtex-end-of-text-in-field bounds
))
3805 (insert (concat (bibtex-field-left-delimiter)
3806 (bibtex-field-right-delimiter)) )
3807 (bibtex-find-text t
)))
3809 (defun bibtex-pop-previous (arg)
3810 "Replace text of current field with the similar field in previous entry.
3811 With arg, goes up ARG entries. Repeated, goes up so many times. May be
3812 intermixed with \\[bibtex-pop-next] (bibtex-pop-next)."
3814 (bibtex-pop arg
'previous
))
3816 (defun bibtex-pop-next (arg)
3817 "Replace text of current field with the text of similar field in next entry.
3818 With arg, goes down ARG entries. Repeated, goes down so many times. May be
3819 intermixed with \\[bibtex-pop-previous] (bibtex-pop-previous)."
3821 (bibtex-pop arg
'next
))
3823 (defun bibtex-clean-entry (&optional new-key called-by-reformat
)
3824 "Finish editing the current BibTeX entry and clean it up.
3825 Check that no required fields are empty and formats entry dependent
3826 on the value of `bibtex-entry-format'.
3827 If the reference key of the entry is empty or a prefix argument is given,
3828 calculate a new reference key. (Note: this works only if fields in entry
3829 begin on separate lines prior to calling `bibtex-clean-entry' or if
3830 'realign is contained in `bibtex-entry-format'.)
3831 Don't call `bibtex-clean-entry' on @Preamble entries.
3832 At end of the cleaning process, the functions in
3833 `bibtex-clean-entry-hook' are called with region narrowed to entry."
3834 ;; Opt. arg called-by-reformat is t if bibtex-clean-entry
3835 ;; is called by bibtex-reformat
3837 (let ((case-fold-search t
)
3838 (start (bibtex-beginning-of-entry))
3839 (_ (looking-at bibtex-entry-maybe-empty-head
))
3840 (entry-type (bibtex-type-in-head))
3841 (key (bibtex-key-in-head)))
3843 (cond ((bibtex-string= entry-type
"preamble")
3844 ;; (bibtex-format-preamble)
3845 (error "No clean up of @Preamble entries"))
3846 ((bibtex-string= entry-type
"string")
3847 (setq entry-type
'string
))
3848 ;; (bibtex-format-string)
3849 (t (bibtex-format-entry)))
3851 (when (or new-key
(not key
))
3852 (setq key
(bibtex-generate-autokey))
3853 ;; Sometimes bibtex-generate-autokey returns an empty string
3854 (if (or bibtex-autokey-edit-before-use
(string= "" key
))
3855 (setq key
(if (eq entry-type
'string
)
3856 (bibtex-read-string-key key
)
3857 (bibtex-read-key "Key to use: " key
))))
3859 (re-search-forward (if (eq entry-type
'string
)
3860 bibtex-string-maybe-empty-head
3861 bibtex-entry-maybe-empty-head
))
3862 (if (match-beginning bibtex-key-in-head
)
3863 (delete-region (match-beginning bibtex-key-in-head
)
3864 (match-end bibtex-key-in-head
)))
3867 (unless called-by-reformat
3868 (let* ((end (save-excursion
3869 (bibtex-end-of-entry)
3870 (if (re-search-forward
3871 bibtex-entry-maybe-empty-head nil
'move
)
3872 (goto-char (match-beginning 0)))
3874 (entry (buffer-substring start end
))
3875 ;; include the crossref key in index
3876 (index (let ((bibtex-maintain-sorted-entries 'crossref
))
3877 (bibtex-entry-index))) ; moves point to end of head
3880 (if (and bibtex-maintain-sorted-entries
3881 (not (and bibtex-sort-ignore-string-entries
3882 (eq entry-type
'string
))))
3884 (delete-region start end
)
3885 (setq error
(not (bibtex-prepare-new-entry index
))
3886 start
(point)) ; update start
3887 (save-excursion (insert entry
)))
3888 (bibtex-find-entry key
)
3889 (setq error
(or (/= (point) start
)
3890 (bibtex-find-entry key nil end
))))
3892 (error "New inserted entry yields duplicate key"))
3893 (dolist (buffer (bibtex-files-expand))
3894 (with-current-buffer buffer
3895 (if (cdr (assoc-string key bibtex-reference-keys
))
3896 (error "Duplicate key in %s" (buffer-file-name)))))
3898 ;; Only update the list of keys if it has been built already.
3899 (cond ((eq entry-type
'string
)
3900 (if (and (listp bibtex-strings
)
3901 (not (assoc key bibtex-strings
)))
3902 (push (cons key
(bibtex-text-in-string
3903 (save-excursion (bibtex-parse-string)) t
))
3905 ;; We have a normal entry.
3906 ((listp bibtex-reference-keys
)
3907 (cond ((not (assoc key bibtex-reference-keys
))
3908 (push (cons key t
) bibtex-reference-keys
))
3909 ((not (cdr (assoc key bibtex-reference-keys
)))
3910 ;; Turn a crossref key into a header key
3911 (setq bibtex-reference-keys
3913 (delete (list key
) bibtex-reference-keys
)))))
3914 ;; Handle crossref key.
3915 (if (and (nth 1 index
)
3916 (not (assoc (nth 1 index
) bibtex-reference-keys
)))
3917 (push (list (nth 1 index
)) bibtex-reference-keys
)))))
3920 (if bibtex-clean-entry-hook
3923 (bibtex-narrow-to-entry)
3924 (run-hooks 'bibtex-clean-entry-hook
)))))))
3926 (defun bibtex-fill-field-bounds (bounds justify
&optional move
)
3927 "Fill BibTeX field delimited by BOUNDS.
3928 If JUSTIFY is non-nil justify as well.
3929 If optional arg MOVE is non-nil move point to end of field."
3930 (let ((end-field (copy-marker (bibtex-end-of-field bounds
))))
3931 (goto-char (bibtex-start-of-field bounds
))
3935 (bibtex-delete-whitespace)
3938 (indent-to-column (+ bibtex-entry-offset
3939 bibtex-field-indentation
))
3940 (re-search-forward "[ \t\n]*=" end-field
)
3943 (if bibtex-align-at-equal-sign
3945 (+ bibtex-entry-offset
(- bibtex-text-indentation
2)))
3948 (bibtex-delete-whitespace)
3949 (if bibtex-align-at-equal-sign
3951 (indent-to-column bibtex-text-indentation
)))
3952 (re-search-forward "[ \t\n]*=[ \t\n]*" end-field
))
3953 (while (re-search-forward "[ \t\n]+" end-field
'move
)
3954 (replace-match " "))
3956 (if move
(goto-char end-field
))))
3958 (defun bibtex-fill-field (&optional justify
)
3959 "Like \\[fill-paragraph], but fill current BibTeX field.
3960 Optional prefix arg JUSTIFY non-nil means justify as well.
3961 In BibTeX mode this function is bound to `fill-paragraph-function'."
3963 (let ((pnt (copy-marker (point)))
3964 (bounds (bibtex-enclosing-field)))
3966 (bibtex-fill-field-bounds bounds justify
)
3969 (defun bibtex-fill-entry ()
3970 "Fill current BibTeX entry.
3971 Realign entry, so that every field starts on a separate line. Field
3972 names appear in column `bibtex-field-indentation', field text starts in
3973 column `bibtex-text-indentation' and continuation lines start here, too.
3974 If `bibtex-align-at-equal-sign' is non-nil, align equal signs, too."
3976 (let ((pnt (copy-marker (point)))
3977 (end (copy-marker (bibtex-end-of-entry)))
3979 (bibtex-beginning-of-entry)
3980 (bibtex-delete-whitespace)
3981 (indent-to-column bibtex-entry-offset
)
3982 (while (setq bounds
(bibtex-search-forward-field bibtex-field-name end
))
3983 (bibtex-fill-field-bounds bounds t t
))
3984 (if (looking-at ",")
3986 (bibtex-delete-whitespace)
3989 (indent-to-column bibtex-entry-offset
)
3992 (defun bibtex-realign ()
3993 "Realign BibTeX entries such that they are separated by one blank line."
3994 (goto-char (point-min))
3995 (let ((case-fold-search t
))
3996 ;; No blank lines prior to the first valid entry if there no
3997 ;; non-white characters in front of it.
3998 (when (looking-at bibtex-valid-entry-whitespace-re
)
3999 (replace-match "\\1"))
4000 ;; Valid entries are separated by one blank line.
4001 (while (re-search-forward bibtex-valid-entry-whitespace-re nil t
)
4002 (replace-match "\n\n\\1"))
4003 ;; One blank line past the last valid entry if it is followed by
4004 ;; non-white characters, no blank line otherwise.
4006 (when (re-search-forward bibtex-valid-entry-re nil t
)
4007 (bibtex-end-of-entry)
4008 (bibtex-delete-whitespace)
4009 (open-line (if (eobp) 1 2)))))
4011 (defun bibtex-reformat (&optional read-options
)
4012 "Reformat all BibTeX entries in buffer or region.
4013 Without prefix argument, reformatting is based on `bibtex-entry-format'.
4014 With prefix argument, read options for reformatting from minibuffer.
4015 With \\[universal-argument] \\[universal-argument] prefix argument, reuse previous answers (if any) again.
4016 If mark is active reformat entries in region, if not in whole buffer."
4018 (let* ((pnt (point))
4019 (use-previous-options
4020 (and (equal (prefix-numeric-value read-options
) 16)
4021 (or bibtex-reformat-previous-options
4022 bibtex-reformat-previous-reference-keys
)))
4023 (bibtex-entry-format
4025 (if use-previous-options
4026 bibtex-reformat-previous-options
4027 (setq bibtex-reformat-previous-options
4028 (mapcar (lambda (option)
4029 (if (y-or-n-p (car option
)) (cdr option
)))
4030 `(("Realign entries (recommended)? " .
'realign
)
4031 ("Remove empty optional and alternative fields? " .
'opts-or-alts
)
4032 ("Remove delimiters around pure numerical fields? " .
'numerical-fields
)
4033 (,(concat (if bibtex-comma-after-last-field
"Insert" "Remove")
4034 " comma at end of entry? ") .
'last-comma
)
4035 ("Replace double page dashes by single ones? " .
'page-dashes
)
4036 ("Inherit booktitle? " .
'inherit-booktitle
)
4037 ("Force delimiters? " .
'delimiters
)
4038 ("Unify case of entry types and field names? " .
'unify-case
))))))
4039 ;; Do not include required-fields because `bibtex-reformat'
4040 ;; cannot handle the error messages of `bibtex-format-entry'.
4041 ;; Use `bibtex-validate' to check for required fields.
4042 ((eq t bibtex-entry-format
)
4043 '(realign opts-or-alts numerical-fields delimiters
4044 last-comma page-dashes unify-case inherit-booktitle
))
4046 (remove 'required-fields
(push 'realign bibtex-entry-format
)))))
4047 (reformat-reference-keys
4049 (if use-previous-options
4050 bibtex-reformat-previous-reference-keys
4051 (setq bibtex-reformat-previous-reference-keys
4052 (y-or-n-p "Generate new reference keys automatically? ")))))
4053 (bibtex-sort-ignore-string-entries t
)
4054 bibtex-autokey-edit-before-use
)
4057 (narrow-to-region (if mark-active
(region-beginning) (point-min))
4058 (if mark-active
(region-end) (point-max)))
4059 (if (memq 'realign bibtex-entry-format
)
4061 (bibtex-progress-message "Formatting" 1)
4062 (bibtex-map-entries (lambda (key beg end
)
4063 (bibtex-progress-message)
4064 (bibtex-clean-entry reformat-reference-keys t
)))
4065 (bibtex-progress-message 'done
))
4066 (when reformat-reference-keys
4067 (kill-local-variable 'bibtex-reference-keys
)
4068 (when bibtex-maintain-sorted-entries
4069 (bibtex-progress-message "Sorting" 1)
4070 (bibtex-sort-buffer)
4071 (bibtex-progress-message 'done
)))
4074 (defun bibtex-convert-alien (&optional read-options
)
4075 "Make an alien BibTeX buffer fully usable by BibTeX mode.
4076 If a file does not conform with all standards used by BibTeX mode,
4077 some of the high-level features of BibTeX mode are not available.
4078 This function tries to convert current buffer to conform with these standards.
4079 With prefix argument READ-OPTIONS non-nil, read options for reformatting
4080 entries from minibuffer."
4082 (message "Starting to validate buffer...")
4086 "If errors occur, correct them and call `bibtex-convert-alien' again")
4088 (deactivate-mark) ; So bibtex-validate works on the whole buffer.
4089 (when (let (bibtex-maintain-sorted-entries)
4091 (message "Starting to reformat entries...")
4093 (bibtex-reformat read-options
)
4094 (goto-char (point-max))
4095 (message "Buffer is now parsable. Please save it.")))
4097 (defun bibtex-complete ()
4098 "Complete word fragment before point according to context.
4099 If point is inside key or crossref field perform key completion based on
4100 `bibtex-reference-keys'. Inside a month field perform key completion
4101 based on `bibtex-predefined-month-strings'. Inside any other field
4102 perform string completion based on `bibtex-strings'. An error is
4103 signaled if point is outside key or BibTeX field."
4106 (case-fold-search t
)
4109 (if (and (setq bounds
(bibtex-enclosing-field t
))
4110 (>= pnt
(bibtex-start-of-text-in-field bounds
))
4111 (<= pnt
(bibtex-end-of-text-in-field bounds
)))
4112 (setq name
(bibtex-name-in-field bounds t
)
4113 compl
(cond ((bibtex-string= name
"crossref")
4114 ;; point is in crossref field
4116 ((bibtex-string= name
"month")
4117 ;; point is in month field
4118 bibtex-predefined-month-strings
)
4119 ;; point is in other field
4120 (t (if (listp bibtex-strings
)
4122 ;; so that bibtex-complete-string-cleanup
4124 (bibtex-parse-strings
4125 (bibtex-string-files-init))))))
4126 (bibtex-beginning-of-entry)
4127 (cond ((and (looking-at bibtex-string-maybe-empty-head
)
4128 ;; point is inside a string key
4129 (or (and (match-beginning bibtex-key-in-head
)
4130 (>= pnt
(match-beginning bibtex-key-in-head
))
4131 (<= pnt
(match-end bibtex-key-in-head
)))
4132 ;; or point is on empty string key
4133 (and (not (match-beginning bibtex-key-in-head
))
4134 (= pnt
(match-end 0)))))
4135 (setq compl
'string
))
4136 ((and (looking-at bibtex-entry-maybe-empty-head
)
4137 ;; point is inside a key
4138 (or (and (match-beginning bibtex-key-in-head
)
4139 (>= pnt
(match-beginning bibtex-key-in-head
))
4140 (<= pnt
(match-end bibtex-key-in-head
)))
4141 ;; or point is on empty key
4142 (and (not (match-beginning bibtex-key-in-head
))
4143 (= pnt
(match-end 0)))))
4144 (setq compl
'key
)))))
4146 (cond ((eq compl
'key
)
4147 ;; key completion: no cleanup needed
4148 (let (completion-ignore-case)
4149 (bibtex-complete-internal (bibtex-global-key-alist))))
4151 ((eq compl
'crossref-key
)
4152 ;; crossref key completion
4153 (let (completion-ignore-case)
4154 (setq choose-completion-string-functions
4155 (lambda (choice buffer mini-p base-size
)
4156 (let ((choose-completion-string-functions nil
))
4157 (choose-completion-string choice buffer base-size
))
4158 (bibtex-complete-crossref-cleanup choice
)
4159 ;; return t (needed by choose-completion-string-functions)
4161 (bibtex-complete-crossref-cleanup (bibtex-complete-internal
4162 (bibtex-global-key-alist)))))
4165 ;; string key completion: no cleanup needed
4166 (let ((completion-ignore-case t
))
4167 (bibtex-complete-internal bibtex-strings
)))
4170 ;; string completion
4171 (let ((completion-ignore-case t
))
4172 (setq choose-completion-string-functions
4173 `(lambda (choice buffer mini-p base-size
)
4174 (let ((choose-completion-string-functions nil
))
4175 (choose-completion-string choice buffer base-size
))
4176 (bibtex-complete-string-cleanup choice
',compl
)
4177 ;; return t (needed by choose-completion-string-functions)
4179 (bibtex-complete-string-cleanup (bibtex-complete-internal compl
)
4182 (t (error "Point outside key or BibTeX field")))))
4184 (defun bibtex-Article ()
4185 "Insert a new BibTeX @Article entry; see also `bibtex-entry'."
4187 (bibtex-entry "Article"))
4189 (defun bibtex-Book ()
4190 "Insert a new BibTeX @Book entry; see also `bibtex-entry'."
4192 (bibtex-entry "Book"))
4194 (defun bibtex-Booklet ()
4195 "Insert a new BibTeX @Booklet entry; see also `bibtex-entry'."
4197 (bibtex-entry "Booklet"))
4199 (defun bibtex-InBook ()
4200 "Insert a new BibTeX @InBook entry; see also `bibtex-entry'."
4202 (bibtex-entry "InBook"))
4204 (defun bibtex-InCollection ()
4205 "Insert a new BibTeX @InCollection entry; see also `bibtex-entry'."
4207 (bibtex-entry "InCollection"))
4209 (defun bibtex-InProceedings ()
4210 "Insert a new BibTeX @InProceedings entry; see also `bibtex-entry'."
4212 (bibtex-entry "InProceedings"))
4214 (defun bibtex-Manual ()
4215 "Insert a new BibTeX @Manual entry; see also `bibtex-entry'."
4217 (bibtex-entry "Manual"))
4219 (defun bibtex-MastersThesis ()
4220 "Insert a new BibTeX @MastersThesis entry; see also `bibtex-entry'."
4222 (bibtex-entry "MastersThesis"))
4224 (defun bibtex-Misc ()
4225 "Insert a new BibTeX @Misc entry; see also `bibtex-entry'."
4227 (bibtex-entry "Misc"))
4229 (defun bibtex-PhdThesis ()
4230 "Insert a new BibTeX @PhdThesis entry; see also `bibtex-entry'."
4232 (bibtex-entry "PhdThesis"))
4234 (defun bibtex-Proceedings ()
4235 "Insert a new BibTeX @Proceedings entry; see also `bibtex-entry'."
4237 (bibtex-entry "Proceedings"))
4239 (defun bibtex-TechReport ()
4240 "Insert a new BibTeX @TechReport entry; see also `bibtex-entry'."
4242 (bibtex-entry "TechReport"))
4244 (defun bibtex-Unpublished ()
4245 "Insert a new BibTeX @Unpublished entry; see also `bibtex-entry'."
4247 (bibtex-entry "Unpublished"))
4249 (defun bibtex-String (&optional key
)
4250 "Insert a new BibTeX @String entry with key KEY."
4251 (interactive (list (bibtex-read-string-key)))
4252 (let ((bibtex-maintain-sorted-entries
4253 (unless bibtex-sort-ignore-string-entries
4254 bibtex-maintain-sorted-entries
))
4256 (unless (bibtex-prepare-new-entry (list key nil
"String"))
4257 (error "Entry with key `%s' already exists" key
))
4258 (if (zerop (length key
)) (setq key nil
))
4259 (indent-to-column bibtex-entry-offset
)
4261 (bibtex-entry-left-delimiter))
4264 (setq endpos
(point)))
4266 (bibtex-field-left-delimiter))
4268 (setq endpos
(point)))
4269 (insert (bibtex-field-right-delimiter)
4270 (bibtex-entry-right-delimiter)
4272 (goto-char endpos
)))
4274 (defun bibtex-Preamble ()
4275 "Insert a new BibTeX @Preamble entry."
4277 (bibtex-move-outside-of-entry)
4278 (indent-to-column bibtex-entry-offset
)
4280 (bibtex-entry-left-delimiter))
4281 (let ((endpos (point)))
4282 (insert (bibtex-entry-right-delimiter)
4284 (goto-char endpos
)))
4286 (defun bibtex-url (&optional pos
)
4287 "Browse a URL for the BibTeX entry at point.
4288 Optional POS is the location of the BibTeX entry.
4289 The URL is generated using the schemes defined in `bibtex-generate-url-list'
4290 \(see there\). Then the URL is passed to `browse-url'."
4293 (if pos
(goto-char pos
))
4294 (bibtex-beginning-of-entry)
4295 (let ((fields-alist (bibtex-parse-entry))
4296 ;; Always ignore case,
4297 (case-fold-search t
)
4298 (lst bibtex-generate-url-list
)
4299 field url scheme obj fmt
)
4300 (while (setq scheme
(pop lst
))
4301 (when (and (setq field
(cdr (assoc-string (caar scheme
)
4303 ;; Always remove field delimiters
4304 (progn (setq field
(bibtex-remove-delimiters-string field
))
4305 (string-match (cdar scheme
) field
)))
4308 url
(if (null scheme
) (match-string 0 field
)
4309 (if (stringp (car scheme
))
4310 (setq fmt
(pop scheme
)))
4311 (dolist (step scheme
)
4312 ;; Always remove field delimiters
4313 (setq field
(bibtex-remove-delimiters-string
4314 (cdr (assoc-string (car step
) fields-alist t
))))
4315 (if (string-match (nth 1 step
) field
)
4316 (setq field
(cond ((functionp (nth 2 step
))
4317 (funcall (nth 2 step
) field
))
4318 ((numberp (nth 2 step
))
4319 (match-string (nth 2 step
) field
))
4321 (replace-match (nth 2 step
) t nil field
))))
4322 ;; If the scheme is set up correctly,
4323 ;; we should never reach this point
4324 (error "Match failed: %s" field
))
4326 (if fmt
(apply 'format fmt
(nreverse obj
))
4327 (apply 'concat
(nreverse obj
)))))
4328 (browse-url (message "%s" url
))))
4329 (unless url
(message "No URL known.")))))
4332 ;; Make BibTeX a Feature
4336 ;; arch-tag: ee2be3af-caad-427f-b42a-d20fad630d04
4337 ;;; bibtex.el ends here
