mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-14 09:39:42 +00:00
Code Issues Releases Activity
f7f8f37aa6
emacs/lisp/textmodes/bibtex.el
Stefan Monnier a172852f2b (bibtex-autokey-titleword-ignore, bibtex-reference-key) 
(bibtex-autokey-demangle-name, bibtex-mode): Use char-classes to accept
non-ascii letters, accepted in some recent bibtex implementations.
2005-04-10 20:35:00 +00:00

4339 lines
186 KiB
EmacsLisp
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; bibtex.el --- BibTeX mode for GNU Emacs
;; Copyright (C) 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2003, 2004, 2005
;; Free Software Foundation, Inc.
;; Author: Stefan Schoef <schoef@offis.uni-oldenburg.de>
;; Bengt Martensson <bengt@mathematik.uni-Bremen.de>
;; Mark Shapiro <shapiro@corto.inria.fr>
;; Mike Newton <newton@gumby.cs.caltech.edu>
;; Aaron Larson <alarson@src.honeywell.com>
;; Dirk Herrmann <D.Herrmann@tu-bs.de>
;; Maintainer: Roland Winkler <roland.winkler@physik.uni-erlangen.de>
;; Keywords: BibTeX, LaTeX, TeX
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;; Major mode for editing and validating BibTeX files.
;; Usage:
;; See documentation for function bibtex-mode or type "\M-x describe-mode"
;; when you are in BibTeX mode.
;; Todo:
;; Distribute texinfo file.
;;; Code:
(require 'button)
;; User Options:
(defgroup bibtex nil
"BibTeX mode"
:group 'tex
:prefix "bibtex-")
(defgroup bibtex-autokey nil
"Generate automatically a key from the author/editor and the title field"
:group 'bibtex
:prefix "bibtex-autokey-")
(defcustom bibtex-mode-hook nil
"List of functions to call on entry to BibTeX mode."
:group 'bibtex
:type 'hook)
(defcustom bibtex-field-delimiters 'braces
"Type of field delimiters. Allowed values are `braces' or `double-quotes'."
:group 'bibtex
:type '(choice (const braces)
(const double-quotes)))
(defcustom bibtex-entry-delimiters 'braces
"Type of entry delimiters. Allowed values are `braces' or `parentheses'."
:group 'bibtex
:type '(choice (const braces)
(const parentheses)))
(defcustom bibtex-include-OPTcrossref '("InProceedings" "InCollection")
"List of BibTeX entries that get an OPTcrossref field."
:group 'bibtex
:type '(repeat string))
(defcustom bibtex-include-OPTkey t
"If non-nil, all newly created entries get an OPTkey field.
If this is a string, use it as the initial field text.
If this is a function, call it to generate the initial field text."
:group 'bibtex
:type '(choice (const :tag "None" nil)
(string :tag "Initial text")
(function :tag "Initialize Function" :value fun)
(other :tag "Default" t)))
(defcustom bibtex-user-optional-fields
'(("annote" "Personal annotation (ignored)"))
"List of optional fields the user wants to have always present.
Entries should be of the same form as the OPTIONAL and
CROSSREF-OPTIONAL lists in `bibtex-entry-field-alist' (which see)."
:group 'bibtex
:type '(repeat (group (string :tag "Field")
(string :tag "Comment")
(option (group :inline t
:extra-offset -4
(choice :tag "Init" :value ""
string
function))))))
(defcustom bibtex-entry-format
'(opts-or-alts required-fields numerical-fields)
"Type of formatting performed by `bibtex-clean-entry'.
It may be t, nil, or a list of symbols out of the following:
opts-or-alts Delete empty optional and alternative fields and
remove OPT and ALT prefixes from used fields.
required-fields Signal an error if a required field is missing.
numerical-fields Delete delimiters around numeral fields.
page-dashes Change double dashes in page field to single dash
(for scribe compatibility).
inherit-booktitle If entry contains a crossref field and the booktitle
field is empty, set the booktitle field to the content
of the title field of the crossreferenced entry.
realign Realign entries, so that field texts and perhaps equal
signs (depending on the value of
`bibtex-align-at-equal-sign') begin in the same column.
last-comma Add or delete comma on end of last field in entry,
according to value of `bibtex-comma-after-last-field'.
delimiters Change delimiters according to variables
`bibtex-field-delimiters' and `bibtex-entry-delimiters'.
unify-case Change case of entry and field names.
The value t means do all of the above formatting actions.
The value nil means do no formatting at all."
:group 'bibtex
:type '(choice (const :tag "None" nil)
(const :tag "All" t)
(set :menu-tag "Some"
(const opts-or-alts)
(const required-fields)
(const numerical-fields)
(const page-dashes)
(const inherit-booktitle)
(const realign)
(const last-comma)
(const delimiters)
(const unify-case))))
(defcustom bibtex-clean-entry-hook nil
"List of functions to call when entry has been cleaned.
Functions are called with point inside the cleaned entry, and the buffer
narrowed to just the entry."
:group 'bibtex
:type 'hook)
(defcustom bibtex-maintain-sorted-entries nil
"If non-nil, BibTeX mode maintains all entries in sorted order.
Allowed non-nil values are:
plain All entries are sorted alphabetically.
crossref All entries are sorted alphabetically unless an entry has a
crossref field. These crossrefed entries are placed in
alphabetical order immediately preceding the main entry.
entry-class The entries are divided into classes according to their
entry name, see `bibtex-sort-entry-class'. Within each class
the entries are sorted alphabetically.
See also `bibtex-sort-ignore-string-entries'."
:group 'bibtex
:type '(choice (const nil)
(const plain)
(const crossref)
(const entry-class)))
(defcustom bibtex-sort-entry-class
'(("String")
(catch-all)
("Book" "Proceedings"))
"List of classes of BibTeX entry names, used for sorting entries.
If value of `bibtex-maintain-sorted-entries' is `entry-class'
entries are ordered according to the classes they belong to. Each
class contains a list of entry names. An entry `catch-all' applies
to all entries not explicitly mentioned."
:group 'BibTeX
:type '(repeat (choice :tag "Class"
(const :tag "catch-all" (catch-all))
(repeat :tag "Entry name" string))))
(defcustom bibtex-sort-ignore-string-entries t
"If non-nil, BibTeX @String entries are not sort-significant.
That means they are ignored when determining ordering of the buffer
\(e.g., sorting, locating alphabetical position for new entries, etc.)."
:group 'bibtex
:type 'boolean)
(defcustom bibtex-field-kill-ring-max 20
"Max length of `bibtex-field-kill-ring' before discarding oldest elements."
:group 'bibtex
:type 'integer)
(defcustom bibtex-entry-kill-ring-max 20
"Max length of `bibtex-entry-kill-ring' before discarding oldest elements."
:group 'bibtex
:type 'integer)
(defcustom bibtex-parse-keys-timeout 60
"Time interval in seconds for parsing BibTeX buffers during idle time.
Parsing initializes `bibtex-reference-keys' and `bibtex-strings'."
:group 'bibtex
:type 'integer)
(defcustom bibtex-parse-keys-fast t
"If non-nil, use fast but simplified algorithm for parsing BibTeX keys.
If parsing fails, try to set this variable to nil."
:group 'bibtex
:type 'boolean)
(defvar bibtex-entry-field-alist
'(("Article"
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the article (BibTeX converts it to lowercase)")
("journal" "Name of the journal (use string, remove braces)")
("year" "Year of publication"))
(("volume" "Volume of the journal")
("number" "Number of the journal (only allowed if entry contains volume)")
("pages" "Pages in the journal")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem")))
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the article (BibTeX converts it to lowercase)"))
(("pages" "Pages in the journal")
("journal" "Name of the journal (use string, remove braces)")
("year" "Year of publication")
("volume" "Volume of the journal")
("number" "Number of the journal")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem"))))
("Book"
((("author" "Author1 [and Author2 ...] [and others]" nil t)
("editor" "Editor1 [and Editor2 ...] [and others]" nil t)
("title" "Title of the book")
("publisher" "Publishing company")
("year" "Year of publication"))
(("volume" "Volume of the book in the series")
("number" "Number of the book in a small series (overwritten by volume)")
("series" "Series in which the book appeared")
("address" "Address of the publisher")
("edition" "Edition of the book as a capitalized English word")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem")))
((("author" "Author1 [and Author2 ...] [and others]" nil t)
("editor" "Editor1 [and Editor2 ...] [and others]" nil t)
("title" "Title of the book"))
(("publisher" "Publishing company")
("year" "Year of publication")
("volume" "Volume of the book in the series")
("number" "Number of the book in a small series (overwritten by volume)")
("series" "Series in which the book appeared")
("address" "Address of the publisher")
("edition" "Edition of the book as a capitalized English word")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem"))))
("Booklet"
((("title" "Title of the booklet (BibTeX converts it to lowercase)"))
(("author" "Author1 [and Author2 ...] [and others]")
("howpublished" "The way in which the booklet was published")
("address" "Address of the publisher")
("month" "Month of the publication as a string (remove braces)")
("year" "Year of publication")
("note" "Remarks to be put at the end of the \\bibitem"))))
("InBook"
((("author" "Author1 [and Author2 ...] [and others]" nil t)
("editor" "Editor1 [and Editor2 ...] [and others]" nil t)
("title" "Title of the book")
("chapter" "Chapter in the book")
("publisher" "Publishing company")
("year" "Year of publication"))
(("volume" "Volume of the book in the series")
("number" "Number of the book in a small series (overwritten by volume)")
("series" "Series in which the book appeared")
("type" "Word to use instead of \"chapter\"")
("address" "Address of the publisher")
("edition" "Edition of the book as a capitalized English word")
("month" "Month of the publication as a string (remove braces)")
("pages" "Pages in the book")
("note" "Remarks to be put at the end of the \\bibitem")))
((("author" "Author1 [and Author2 ...] [and others]" nil t)
("editor" "Editor1 [and Editor2 ...] [and others]" nil t)
("title" "Title of the book")
("chapter" "Chapter in the book"))
(("pages" "Pages in the book")
("publisher" "Publishing company")
("year" "Year of publication")
("volume" "Volume of the book in the series")
("number" "Number of the book in a small series (overwritten by volume)")
("series" "Series in which the book appeared")
("type" "Word to use instead of \"chapter\"")
("address" "Address of the publisher")
("edition" "Edition of the book as a capitalized English word")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem"))))
("InCollection"
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the article in book (BibTeX converts it to lowercase)")
("booktitle" "Name of the book")
("publisher" "Publishing company")
("year" "Year of publication"))
(("editor" "Editor1 [and Editor2 ...] [and others]")
("volume" "Volume of the book in the series")
("number" "Number of the book in a small series (overwritten by volume)")
("series" "Series in which the book appeared")
("type" "Word to use instead of \"chapter\"")
("chapter" "Chapter in the book")
("pages" "Pages in the book")
("address" "Address of the publisher")
("edition" "Edition of the book as a capitalized English word")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem")))
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the article in book (BibTeX converts it to lowercase)")
("booktitle" "Name of the book"))
(("pages" "Pages in the book")
("publisher" "Publishing company")
("year" "Year of publication")
("editor" "Editor1 [and Editor2 ...] [and others]")
("volume" "Volume of the book in the series")
("number" "Number of the book in a small series (overwritten by volume)")
("series" "Series in which the book appeared")
("type" "Word to use instead of \"chapter\"")
("chapter" "Chapter in the book")
("address" "Address of the publisher")
("edition" "Edition of the book as a capitalized English word")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem"))))
("InProceedings"
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the article in proceedings (BibTeX converts it to lowercase)")
("booktitle" "Name of the conference proceedings")
("year" "Year of publication"))
(("editor" "Editor1 [and Editor2 ...] [and others]")
("volume" "Volume of the conference proceedings in the series")
("number" "Number of the conference proceedings in a small series (overwritten by volume)")
("series" "Series in which the conference proceedings appeared")
("pages" "Pages in the conference proceedings")
("address" "Location of the Proceedings")
("month" "Month of the publication as a string (remove braces)")
("organization" "Sponsoring organization of the conference")
("publisher" "Publishing company, its location")
("note" "Remarks to be put at the end of the \\bibitem")))
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the article in proceedings (BibTeX converts it to lowercase)"))
(("booktitle" "Name of the conference proceedings")
("pages" "Pages in the conference proceedings")
("year" "Year of publication")
("editor" "Editor1 [and Editor2 ...] [and others]")
("volume" "Volume of the conference proceedings in the series")
("number" "Number of the conference proceedings in a small series (overwritten by volume)")
("series" "Series in which the conference proceedings appeared")
("address" "Location of the Proceedings")
("month" "Month of the publication as a string (remove braces)")
("organization" "Sponsoring organization of the conference")
("publisher" "Publishing company, its location")
("note" "Remarks to be put at the end of the \\bibitem"))))
("Manual"
((("title" "Title of the manual"))
(("author" "Author1 [and Author2 ...] [and others]")
("organization" "Publishing organization of the manual")
("address" "Address of the organization")
("edition" "Edition of the manual as a capitalized English word")
("month" "Month of the publication as a string (remove braces)")
("year" "Year of publication")
("note" "Remarks to be put at the end of the \\bibitem"))))
("MastersThesis"
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the master\'s thesis (BibTeX converts it to lowercase)")
("school" "School where the master\'s thesis was written")
("year" "Year of publication"))
(("type" "Type of the master\'s thesis (if other than \"Master\'s thesis\")")
("address" "Address of the school (if not part of field \"school\") or country")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem"))))
("Misc"
(()
(("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the work (BibTeX converts it to lowercase)")
("howpublished" "The way in which the work was published")
("month" "Month of the publication as a string (remove braces)")
("year" "Year of publication")
("note" "Remarks to be put at the end of the \\bibitem"))))
("PhdThesis"
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the PhD. thesis")
("school" "School where the PhD. thesis was written")
("year" "Year of publication"))
(("type" "Type of the PhD. thesis")
("address" "Address of the school (if not part of field \"school\") or country")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem"))))
("Proceedings"
((("title" "Title of the conference proceedings")
("year" "Year of publication"))
(("booktitle" "Title of the proceedings for cross references")
("editor" "Editor1 [and Editor2 ...] [and others]")
("volume" "Volume of the conference proceedings in the series")
("number" "Number of the conference proceedings in a small series (overwritten by volume)")
("series" "Series in which the conference proceedings appeared")
("address" "Location of the Proceedings")
("month" "Month of the publication as a string (remove braces)")
("organization" "Sponsoring organization of the conference")
("publisher" "Publishing company, its location")
("note" "Remarks to be put at the end of the \\bibitem"))))
("TechReport"
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the technical report (BibTeX converts it to lowercase)")
("institution" "Sponsoring institution of the report")
("year" "Year of publication"))
(("type" "Type of the report (if other than \"technical report\")")
("number" "Number of the technical report")
("address" "Address of the institution (if not part of field \"institution\") or country")
("month" "Month of the publication as a string (remove braces)")
("note" "Remarks to be put at the end of the \\bibitem"))))
("Unpublished"
((("author" "Author1 [and Author2 ...] [and others]")
("title" "Title of the unpublished work (BibTeX converts it to lowercase)")
("note" "Remarks to be put at the end of the \\bibitem"))
(("month" "Month of the publication as a string (remove braces)")
("year" "Year of publication")))))
"List of BibTeX entry types and their associated fields.
List elements are triples
\(ENTRY-NAME (REQUIRED OPTIONAL) (CROSSREF-REQUIRED CROSSREF-OPTIONAL)).
ENTRY-NAME is the name of a BibTeX entry. The remaining pairs contain
the required and optional fields of the BibTeX entry.
The second pair is used if a crossref field is present
and the first pair is used if a crossref field is absent.
If the second pair is nil, the first pair is always used.
REQUIRED, OPTIONAL, CROSSREF-REQUIRED and CROSSREF-OPTIONAL are lists.
Each element of these lists is a list of the form
\(FIELD-NAME COMMENT-STRING INIT ALTERNATIVE-FLAG).
COMMENT-STRING, INIT, and ALTERNATIVE-FLAG are optional.
FIELD-NAME is the name of the field, COMMENT-STRING is the comment that
appears in the echo area, INIT is either the initial content of the
field or a function, which is called to determine the initial content
of the field, and ALTERNATIVE-FLAG (either nil or t) marks if the
field is an alternative. ALTERNATIVE-FLAG may be t only in the
REQUIRED or CROSSREF-REQUIRED lists.")
(defcustom bibtex-comment-start "@Comment"
"String starting a BibTeX comment."
:group 'bibtex
:type 'string)
(defcustom bibtex-add-entry-hook nil
"List of functions to call when BibTeX entry has been inserted."
:group 'bibtex
:type 'hook)
(defcustom bibtex-predefined-month-strings
'(("jan" . "January")
("feb" . "February")
("mar" . "March")
("apr" . "April")
("may" . "May")
("jun" . "June")
("jul" . "July")
("aug" . "August")
("sep" . "September")
("oct" . "October")
("nov" . "November")
("dec" . "December"))
"Alist of month string definitions used in the BibTeX style files.
Each element is a pair of strings (ABBREVIATION . EXPANSION)."
:group 'bibtex
:type '(repeat (cons (string :tag "Month abbreviation")
(string :tag "Month expansion"))))
(defcustom bibtex-predefined-strings
(append
bibtex-predefined-month-strings
'(("acmcs" . "ACM Computing Surveys")
("acta" . "Acta Informatica")
("cacm" . "Communications of the ACM")
("ibmjrd" . "IBM Journal of Research and Development")
("ibmsj" . "IBM Systems Journal")
("ieeese" . "IEEE Transactions on Software Engineering")
("ieeetc" . "IEEE Transactions on Computers")
("ieeetcad" . "IEEE Transactions on Computer-Aided Design of Integrated Circuits")
("ipl" . "Information Processing Letters")
("jacm" . "Journal of the ACM")
("jcss" . "Journal of Computer and System Sciences")
("scp" . "Science of Computer Programming")
("sicomp" . "SIAM Journal on Computing")
("tcs" . "Theoretical Computer Science")
("tocs" . "ACM Transactions on Computer Systems")
("tods" . "ACM Transactions on Database Systems")
("tog" . "ACM Transactions on Graphics")
("toms" . "ACM Transactions on Mathematical Software")
("toois" . "ACM Transactions on Office Information Systems")
("toplas" . "ACM Transactions on Programming Languages and Systems")))
"Alist of string definitions used in the BibTeX style files.
Each element is a pair of strings (ABBREVIATION . EXPANSION)."
:group 'bibtex
:type '(repeat (cons (string :tag "String")
(string :tag "String expansion"))))
(defcustom bibtex-string-files nil
"List of BibTeX files containing string definitions.
List elements can be absolute file names or file names relative
to the directories specified in `bibtex-string-file-path'."
:group 'bibtex
:type '(repeat file))
(defvar bibtex-string-file-path (getenv "BIBINPUTS")
"*Colon separated list of paths to search for `bibtex-string-files'.")
(defcustom bibtex-files nil
"List of BibTeX files that are searched for entry keys.
List elements can be absolute file names or file names relative to the
directories specified in `bibtex-file-path'. If an element is a directory,
check all BibTeX files in this directory. If an element is the symbol
`bibtex-file-path', check all BibTeX files in `bibtex-file-path'."
:group 'bibtex
:type '(repeat file))
(defvar bibtex-file-path (getenv "BIBINPUTS")
"*Colon separated list of paths to search for `bibtex-files'.")
(defcustom bibtex-help-message t
"If non-nil print help messages in the echo area on entering a new field."
:group 'bibtex
:type 'boolean)
(defcustom bibtex-autokey-prefix-string ""
"String prefix for automatically generated reference keys.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'string)
(defcustom bibtex-autokey-names 1
"Number of names to use for the automatically generated reference key.
Possibly more names are used according to `bibtex-autokey-names-stretch'.
If this variable is nil, all names are used.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(choice (const :tag "All" infty)
integer))
(defcustom bibtex-autokey-names-stretch 0
"Number of names that can additionally be used for reference keys.
These names are used only, if all names are used then.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'integer)
(defcustom bibtex-autokey-additional-names ""
"String to append to the generated key if not all names could be used.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'string)
(defvar bibtex-autokey-transcriptions
'(;; language specific characters
("\\\\aa" . "a") ; \aa -> a
("\\\\AA" . "A") ; \AA -> A
("\\\"a\\|\\\\\\\"a\\|\\\\ae" . "ae") ; "a,\"a,\ae -> ae
("\\\"A\\|\\\\\\\"A\\|\\\\AE" . "Ae") ; "A,\"A,\AE -> Ae
("\\\\i" . "i") ; \i -> i
("\\\\j" . "j") ; \j -> j
("\\\\l" . "l") ; \l -> l
("\\\\L" . "L") ; \L -> L
("\\\"o\\|\\\\\\\"o\\|\\\\o\\|\\\\oe" . "oe") ; "o,\"o,\o,\oe -> oe
("\\\"O\\|\\\\\\\"O\\|\\\\O\\|\\\\OE" . "Oe") ; "O,\"O,\O,\OE -> Oe
("\\\"s\\|\\\\\\\"s\\|\\\\3" . "ss") ; "s,\"s,\3 -> ss
("\\\"u\\|\\\\\\\"u" . "ue") ; "u,\"u -> ue
("\\\"U\\|\\\\\\\"U" . "Ue") ; "U,\"U -> Ue
;; accents
("\\\\`\\|\\\\'\\|\\\\\\^\\|\\\\~\\|\\\\=\\|\\\\\\.\\|\\\\u\\|\\\\v\\|\\\\H\\|\\\\t\\|\\\\c\\|\\\\d\\|\\\\b" . "")
;; braces, quotes, concatenation.
("[`'\"{}#]" . "")
;; spaces
("\\\\?[ \t\n]+\\|~" . " "))
"Alist of (OLD-REGEXP . NEW-STRING) pairs.
Used by the default values of `bibtex-autokey-name-change-strings' and
`bibtex-autokey-titleword-change-strings'. Defaults to translating some
language specific characters to their ASCII transcriptions, and
removing any character accents.")
(defcustom bibtex-autokey-name-change-strings
bibtex-autokey-transcriptions
"Alist of (OLD-REGEXP . NEW-STRING) pairs.
Any part of a name matching OLD-REGEXP is replaced by NEW-STRING.
Case is significant in OLD-REGEXP. All regexps are tried in the
order in which they appear in the list.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(repeat (cons (regexp :tag "Old")
(string :tag "New"))))
(defcustom bibtex-autokey-name-case-convert 'downcase
"Function called for each name to perform case conversion.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(choice (const :tag "Preserve case" identity)
(const :tag "Downcase" downcase)
(const :tag "Capitalize" capitalize)
(const :tag "Upcase" upcase)
(function :tag "Conversion function")))
(defcustom bibtex-autokey-name-length 'infty
"Number of characters from name to incorporate into key.
If this is set to anything but a number, all characters are used.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(choice (const :tag "All" infty)
integer))
(defcustom bibtex-autokey-name-separator ""
"String that comes between any two names in the key.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'string)
(defcustom bibtex-autokey-year-length 2
"Number of rightmost digits from the year field to incorporate into key.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'integer)
(defcustom bibtex-autokey-use-crossref t
"If non-nil use fields from crossreferenced entry if necessary.
If this variable is non-nil and some field has no entry, but a
valid crossref entry, the field from the crossreferenced entry is used.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'boolean)
(defcustom bibtex-autokey-titlewords 5
"Number of title words to use for the automatically generated reference key.
If this is set to anything but a number, all title words are used.
Possibly more words from the title are used according to
`bibtex-autokey-titlewords-stretch'.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(choice (const :tag "All" infty)
integer))
(defcustom bibtex-autokey-title-terminators "[.!?:;]\\|--"
"Regexp defining the termination of the main part of the title.
Case of the regexps is ignored. See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'regexp)
(defcustom bibtex-autokey-titlewords-stretch 2
"Number of words that can additionally be used from the title.
These words are used only, if a sentence from the title can be ended then.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'integer)
(defcustom bibtex-autokey-titleword-ignore
'("A" "An" "On" "The" "Eine?" "Der" "Die" "Das"
"[^[:upper:]].*" ".*[^[:upper:]0-9].*")
"Determines words from the title that are not to be used in the key.
Each item of the list is a regexp. If a word of the title matches a
regexp from that list, it is not included in the title part of the key.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(repeat regexp))
(defcustom bibtex-autokey-titleword-case-convert 'downcase
"Function called for each titleword to perform case conversion.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(choice (const :tag "Preserve case" identity)
(const :tag "Downcase" downcase)
(const :tag "Capitalize" capitalize)
(const :tag "Upcase" upcase)
(function :tag "Conversion function")))
(defcustom bibtex-autokey-titleword-abbrevs nil
"Determines exceptions to the usual abbreviation mechanism.
An alist of (OLD-REGEXP . NEW-STRING) pairs. Case is ignored
in matching against OLD-REGEXP, and the first matching pair is used.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(repeat (cons (regexp :tag "Old")
(string :tag "New"))))
(defcustom bibtex-autokey-titleword-change-strings
bibtex-autokey-transcriptions
"Alist of (OLD-REGEXP . NEW-STRING) pairs.
Any part of title word matching a OLD-REGEXP is replaced by NEW-STRING.
Case is significant in OLD-REGEXP. All regexps are tried in the
order in which they appear in the list.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(repeat (cons (regexp :tag "Old")
(string :tag "New"))))
(defcustom bibtex-autokey-titleword-length 5
"Number of characters from title words to incorporate into key.
If this is set to anything but a number, all characters are used.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(choice (const :tag "All" infty)
integer))
(defcustom bibtex-autokey-titleword-separator "_"
"String to be put between the title words.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'string)
(defcustom bibtex-autokey-name-year-separator ""
"String to be put between name part and year part of key.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'string)
(defcustom bibtex-autokey-year-title-separator ":_"
"String to be put between name part and year part of key.
See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'string)
(defcustom bibtex-autokey-edit-before-use t
"If non-nil, user is allowed to edit the generated key before it is used."
:group 'bibtex-autokey
:type 'boolean)
(defcustom bibtex-autokey-before-presentation-function nil
"If non-nil, function to call before generated key is presented.
The function must take one argument (the automatically generated key),
and must return a string (the key to use)."
:group 'bibtex-autokey
:type '(choice (const nil) function))
(defcustom bibtex-entry-offset 0
"Offset for BibTeX entries.
Added to the value of all other variables which determine columns."
:group 'bibtex
:type 'integer)
(defcustom bibtex-field-indentation 2
"Starting column for the name part in BibTeX fields."
:group 'bibtex
:type 'integer)
(defcustom bibtex-text-indentation
(+ bibtex-field-indentation
(length "organization = "))
"Starting column for the text part in BibTeX fields.
Should be equal to the space needed for the longest name part."
:group 'bibtex
:type 'integer)
(defcustom bibtex-contline-indentation
(+ bibtex-text-indentation 1)
"Starting column for continuation lines of BibTeX fields."
:group 'bibtex
:type 'integer)
(defcustom bibtex-align-at-equal-sign nil
"If non-nil, align fields at equal sign instead of field text.
If non-nil, the column for the equal sign is the value of
`bibtex-text-indentation', minus 2."
:group 'bibtex
:type 'boolean)
(defcustom bibtex-comma-after-last-field nil
"If non-nil, a comma is put at end of last field in the entry template."
:group 'bibtex
:type 'boolean)
(defcustom bibtex-autoadd-commas t
"If non-nil automatically add missing commas at end of BibTeX fields."
:group 'bibtex
:type 'boolean)
(defcustom bibtex-autofill-types '("Proceedings")
"Automatically fill fields if possible for those BibTeX entry types."
:group 'bibtex
:type '(repeat string))
(defcustom bibtex-summary-function 'bibtex-summary
"Function to call for generating a one-line summary of a BibTeX entry.
It takes one argument, the key of the entry.
Used by `bibtex-complete-crossref-cleanup' and `bibtex-copy-summary-as-kill'."
:group 'bibtex
:type '(choice (const :tag "Default" bibtex-summary)
(function :tag "Personalized function")))
(defcustom bibtex-generate-url-list
'((("url" . ".*:.*")))
"List of schemes for generating the URL of a BibTeX entry.
These schemes are used by `bibtex-url'.
Each scheme should have one of these forms:
((FIELD . REGEXP))
((FIELD . REGEXP) STEP...)
((FIELD . REGEXP) STRING STEP...)
FIELD is a field name as returned by `bibtex-parse-entry'.
REGEXP is matched against the text of FIELD. If the match succeeds,
then this scheme is used. If no STRING and STEPs are specified
the matched text is used as the URL, otherwise the URL is built
by evaluating STEPs. If no STRING is specified the STEPs must result
in strings which are concatenated. Otherwise the resulting objects
are passed through `format' using STRING as format control string.
A STEP is a list (FIELD REGEXP REPLACE). The text of FIELD
is matched against REGEXP, and is replaced with REPLACE.
REPLACE can be a string, or a number (which selects the corresponding
submatch), or a function called with the field's text as argument
and with the `match-data' properly set.
Case is always ignored. Always remove the field delimiters.
The following is a complex example, see http://link.aps.org/linkfaq.html.
(((\"journal\" . \"\\\\=<\\(PR[ABCDEL]?\\|RMP\\)\\\\=>\")
\"http://link.aps.org/abstract/%s/v%s/p%s\"
(\"journal\" \".*\" downcase)
(\"volume\" \".*\" 0)
(\"pages\" \"\\`[A-Z]?[0-9]+\" 0)))"
:group 'bibtex
:type '(repeat
(cons :tag "Scheme"
(cons :tag "Matcher" :extra-offset 4
(string :tag "BibTeX field")
(regexp :tag "Regexp"))
(choice
(const :tag "Take match as is" nil)
(cons :tag "Formatted"
(string :tag "Format control string")
(repeat :tag "Steps to generate URL"
(list (string :tag "BibTeX field")
(regexp :tag "Regexp")
(choice (string :tag "Replacement")
(integer :tag "Sub-match")
(function :tag "Filter")))))
(repeat :tag "Concatenated"
(list (string :tag "BibTeX field")
(regexp :tag "Regexp")
(choice (string :tag "Replacement")
(integer :tag "Sub-match")
(function :tag "Filter"))))))))
;; bibtex-font-lock-keywords is a user option as well, but since the
;; patterns used to define this variable are defined in a later
;; section of this file, it is defined later.
;; Syntax Table, Keybindings and BibTeX Entry List
(defvar bibtex-mode-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?\" "\"" st)
(modify-syntax-entry ?$ "$$ " st)
(modify-syntax-entry ?% "< " st)
(modify-syntax-entry ?' "w " st)
(modify-syntax-entry ?@ "w " st)
(modify-syntax-entry ?\\ "\\" st)
(modify-syntax-entry ?\f "> " st)
(modify-syntax-entry ?\n "> " st)
;; Keys cannot have = in them (wrong font-lock of @string{foo=bar}).
(modify-syntax-entry ?= "." st)
(modify-syntax-entry ?~ " " st)
st)
"Syntax table used in BibTeX mode buffers.")
(defvar bibtex-mode-map
(let ((km (make-sparse-keymap)))
;; The Key `C-c&' is reserved for reftex.el
(define-key km "\t" 'bibtex-find-text)
(define-key km "\n" 'bibtex-next-field)
(define-key km "\M-\t" 'bibtex-complete)
(define-key km "\C-c\"" 'bibtex-remove-delimiters)
(define-key km "\C-c{" 'bibtex-remove-delimiters)
(define-key km "\C-c}" 'bibtex-remove-delimiters)
(define-key km "\C-c\C-c" 'bibtex-clean-entry)
(define-key km "\C-c\C-q" 'bibtex-fill-entry)
(define-key km "\C-c\C-s" 'bibtex-find-entry)
(define-key km "\C-c\C-x" 'bibtex-find-crossref)
(define-key km "\C-c\C-t" 'bibtex-copy-summary-as-kill)
(define-key km "\C-c?" 'bibtex-print-help-message)
(define-key km "\C-c\C-p" 'bibtex-pop-previous)
(define-key km "\C-c\C-n" 'bibtex-pop-next)
(define-key km "\C-c\C-k" 'bibtex-kill-field)
(define-key km "\C-c\M-k" 'bibtex-copy-field-as-kill)
(define-key km "\C-c\C-w" 'bibtex-kill-entry)
(define-key km "\C-c\M-w" 'bibtex-copy-entry-as-kill)
(define-key km "\C-c\C-y" 'bibtex-yank)
(define-key km "\C-c\M-y" 'bibtex-yank-pop)
(define-key km "\C-c\C-d" 'bibtex-empty-field)
(define-key km "\C-c\C-f" 'bibtex-make-field)
(define-key km "\C-c\C-u" 'bibtex-entry-update)
(define-key km "\C-c$" 'bibtex-ispell-abstract)
(define-key km "\M-\C-a" 'bibtex-beginning-of-entry)
(define-key km "\M-\C-e" 'bibtex-end-of-entry)
(define-key km "\C-\M-l" 'bibtex-reposition-window)
(define-key km "\C-\M-h" 'bibtex-mark-entry)
(define-key km "\C-c\C-b" 'bibtex-entry)
(define-key km "\C-c\C-rn" 'bibtex-narrow-to-entry)
(define-key km "\C-c\C-rw" 'widen)
(define-key km "\C-c\C-l" 'bibtex-url)
(define-key km "\C-c\C-o" 'bibtex-remove-OPT-or-ALT)
(define-key km "\C-c\C-e\C-i" 'bibtex-InProceedings)
(define-key km "\C-c\C-ei" 'bibtex-InCollection)
(define-key km "\C-c\C-eI" 'bibtex-InBook)
(define-key km "\C-c\C-e\C-a" 'bibtex-Article)
(define-key km "\C-c\C-e\C-b" 'bibtex-InBook)
(define-key km "\C-c\C-eb" 'bibtex-Book)
(define-key km "\C-c\C-eB" 'bibtex-Booklet)
(define-key km "\C-c\C-e\C-c" 'bibtex-InCollection)
(define-key km "\C-c\C-e\C-m" 'bibtex-Manual)
(define-key km "\C-c\C-em" 'bibtex-MastersThesis)
(define-key km "\C-c\C-eM" 'bibtex-Misc)
(define-key km "\C-c\C-e\C-p" 'bibtex-InProceedings)
(define-key km "\C-c\C-ep" 'bibtex-Proceedings)
(define-key km "\C-c\C-eP" 'bibtex-PhdThesis)
(define-key km "\C-c\C-e\M-p" 'bibtex-Preamble)
(define-key km "\C-c\C-e\C-s" 'bibtex-String)
(define-key km "\C-c\C-e\C-t" 'bibtex-TechReport)
(define-key km "\C-c\C-e\C-u" 'bibtex-Unpublished)
km)
"Keymap used in BibTeX mode.")
(easy-menu-define
bibtex-edit-menu bibtex-mode-map "BibTeX-Edit Menu in BibTeX mode"
'("BibTeX-Edit"
("Moving inside an Entry"
["End of Field" bibtex-find-text t]
["Next Field" bibtex-next-field t]
["Beginning of Entry" bibtex-beginning-of-entry t]
["End of Entry" bibtex-end-of-entry t]
"--"
["Make Entry Visible" bibtex-reposition-window t])
("Moving in BibTeX Buffers"
["Find Entry" bibtex-find-entry t]
["Find Crossref Entry" bibtex-find-crossref t])
"--"
("Operating on Current Field"
["Fill Field" fill-paragraph t]
["Remove Delimiters" bibtex-remove-delimiters t]
["Remove OPT or ALT Prefix" bibtex-remove-OPT-or-ALT t]
["Clear Field" bibtex-empty-field t]
"--"
["Kill Field" bibtex-kill-field t]
["Copy Field to Kill Ring" bibtex-copy-field-as-kill t]
["Paste Most Recently Killed Field" bibtex-yank t]
["Paste Previously Killed Field" bibtex-yank-pop t]
"--"
["Make New Field" bibtex-make-field t]
"--"
["Snatch from Similar Following Field" bibtex-pop-next t]
["Snatch from Similar Preceding Field" bibtex-pop-previous t]
"--"
["String or Key Complete" bibtex-complete t]
"--"
["Help about Current Field" bibtex-print-help-message t])
("Operating on Current Entry"
["Fill Entry" bibtex-fill-entry t]
["Clean Entry" bibtex-clean-entry t]
["Update Entry" bibtex-entry-update t]
"--"
["Kill Entry" bibtex-kill-entry t]
["Copy Entry to Kill Ring" bibtex-copy-entry-as-kill t]
["Paste Most Recently Killed Entry" bibtex-yank t]
["Paste Previously Killed Entry" bibtex-yank-pop t]
"--"
["Copy Summary to Kill Ring" bibtex-copy-summary-as-kill t]
["Browse URL" bibtex-url t]
"--"
["Ispell Entry" bibtex-ispell-entry t]
["Ispell Entry Abstract" bibtex-ispell-abstract t]
"--"
["Narrow to Entry" bibtex-narrow-to-entry t]
["Mark Entry" bibtex-mark-entry t]
"--"
["View Cite Locations (RefTeX)" reftex-view-crossref-from-bibtex
(fboundp 'reftex-view-crossref-from-bibtex)])
("Operating on Buffer or Region"
["Validate Entries" bibtex-validate t]
["Sort Entries" bibtex-sort-buffer t]
["Reformat Entries" bibtex-reformat t]
["Count Entries" bibtex-count-entries t]
"--"
["Convert Alien Buffer" bibtex-convert-alien t])
("Operating on Multiple Buffers"
["Validate Entries" bibtex-validate-globally t])))
(easy-menu-define
bibtex-entry-menu bibtex-mode-map "Entry-Types Menu in BibTeX mode"
(list "Entry-Types"
["Article in Journal" bibtex-Article t]
["Article in Conference Proceedings" bibtex-InProceedings t]
["Article in a Collection" bibtex-InCollection t]
["Chapter or Pages in a Book" bibtex-InBook t]
["Conference Proceedings" bibtex-Proceedings t]
["Book" bibtex-Book t]
["Booklet (Bound, but no Publisher/Institution)" bibtex-Booklet t]
["PhD. Thesis" bibtex-PhdThesis t]
["Master's Thesis" bibtex-MastersThesis t]
["Technical Report" bibtex-TechReport t]
["Technical Manual" bibtex-Manual t]
["Unpublished" bibtex-Unpublished t]
["Miscellaneous" bibtex-Misc t]
"--"
["String" bibtex-String t]
["Preamble" bibtex-Preamble t]))
;; Internal Variables
(defvar bibtex-pop-previous-search-point nil
"Next point where `bibtex-pop-previous' starts looking for a similar entry.")
(defvar bibtex-pop-next-search-point nil
"Next point where `bibtex-pop-next' starts looking for a similar entry.")
(defvar bibtex-field-kill-ring nil
"Ring of least recently killed fields.
At most `bibtex-field-kill-ring-max' items are kept here.")
(defvar bibtex-field-kill-ring-yank-pointer nil
"The tail of `bibtex-field-kill-ring' whose car is the last item yanked.")
(defvar bibtex-entry-kill-ring nil
"Ring of least recently killed entries.
At most `bibtex-entry-kill-ring-max' items are kept here.")
(defvar bibtex-entry-kill-ring-yank-pointer nil
"The tail of `bibtex-entry-kill-ring' whose car is the last item yanked.")
(defvar bibtex-last-kill-command nil
"Type of the last kill command (either 'field or 'entry).")
(defvar bibtex-strings
(lazy-completion-table bibtex-strings
bibtex-parse-strings (bibtex-string-files-init))
"Completion table for BibTeX string keys.
Initialized from `bibtex-predefined-strings' and `bibtex-string-files'.")
(make-variable-buffer-local 'bibtex-strings)
(defvar bibtex-reference-keys
(lazy-completion-table bibtex-reference-keys bibtex-parse-keys nil t)
"Completion table for BibTeX reference keys.
The CDRs of the elements are t for header keys and nil for crossref keys.")
(make-variable-buffer-local 'bibtex-reference-keys)
(defvar bibtex-buffer-last-parsed-tick nil
"Value of `buffer-modified-tick' last time buffer was parsed for keys.")
(defvar bibtex-parse-idle-timer nil
"Stores if timer is already installed.")
(defvar bibtex-progress-lastperc nil
"Last reported percentage for the progress message.")
(defvar bibtex-progress-lastmes nil
"Last reported progress message.")
(defvar bibtex-progress-interval nil
"Interval for progress messages.")
(defvar bibtex-key-history nil
"History list for reading keys.")
(defvar bibtex-entry-type-history nil
"History list for reading entry types.")
(defvar bibtex-field-history nil
"History list for reading field names.")
(defvar bibtex-reformat-previous-options nil
"Last reformat options given.")
(defvar bibtex-reformat-previous-reference-keys nil
"Last reformat reference keys option given.")
(defconst bibtex-field-name "[^\"#%'(),={} \t\n0-9][^\"#%'(),={} \t\n]*"
"Regexp matching the name part of a BibTeX field.")
(defconst bibtex-entry-type (concat "@" bibtex-field-name)
"Regexp matching the type part of a BibTeX entry.")
(defconst bibtex-reference-key "[][[:alnum:].:;?!`'/*@+|()<>&_^$-]+"
"Regexp matching the reference key part of a BibTeX entry.")
(defconst bibtex-field-const "[][[:alnum:].:;?!`'/*@+=|<>&_^$-]+"
"Regexp matching a BibTeX field constant.")
(defconst bibtex-entry-head
(concat "^[ \t]*\\("
bibtex-entry-type
"\\)[ \t]*[({][ \t\n]*\\("
bibtex-reference-key
"\\)")
"Regexp matching the header line of a BibTeX entry.")
(defconst bibtex-entry-maybe-empty-head
(concat bibtex-entry-head "?")
"Regexp matching the header line of a BibTeX entry (possibly without key).")
(defconst bibtex-type-in-head 1
"Regexp subexpression number of the type part in `bibtex-entry-head'.")
(defconst bibtex-key-in-head 2
"Regexp subexpression number of the key part in `bibtex-entry-head'.")
(defconst bibtex-string-maybe-empty-head
(concat "^[ \t]*\\(@String\\)[ \t]*[({]\\("
bibtex-reference-key
"\\)?")
"Regexp matching the header line of a BibTeX String entry.")
(defconst bibtex-entry-postfix "[ \t\n]*,?[ \t\n]*[})]"
"Regexp matching the postfix of a BibTeX entry.")
(defvar bibtex-known-entry-type-re
(regexp-opt (mapcar 'car bibtex-entry-field-alist))
"Regexp matching the name of a BibTeX entry.")
(defvar bibtex-valid-entry-re
(concat "@[ \t]*\\(" bibtex-known-entry-type-re "\\)")
"Regexp matching the name of a valid BibTeX entry.")
(defvar bibtex-valid-entry-whitespace-re
(concat "[ \t\n]*\\(" bibtex-valid-entry-re "\\)")
"Regexp matching the name of a valid BibTeX entry preceded by whitespace.")
(defvar bibtex-any-valid-entry-re
(concat "@[ \t]*"
(regexp-opt (append '("String")
(mapcar 'car bibtex-entry-field-alist))
t))
"Regexp matching the name of any valid BibTeX entry (including string).")
(defconst bibtex-empty-field-re "\\`\\(\"\"\\|{}\\)\\'"
"Regexp matching the text part (as a string) of an empty field.")
(defconst bibtex-font-lock-syntactic-keywords
`((,(concat "^[ \t]*\\(" (substring bibtex-comment-start 0 1) "\\)"
(substring bibtex-comment-start 1) "\\>")
1 '(11))))
(defvar bibtex-font-lock-keywords
;; entry type and reference key
`((,bibtex-entry-maybe-empty-head
(,bibtex-type-in-head font-lock-function-name-face)
(,bibtex-key-in-head font-lock-constant-face nil t))
;; optional field names (treated as comments)
(,(concat "^[ \t]*\\(OPT" bibtex-field-name "\\)[ \t]*=")
1 font-lock-comment-face)
;; field names
(,(concat "^[ \t]*\\(" bibtex-field-name "\\)[ \t]*=")
1 font-lock-variable-name-face)
;; url
bibtex-font-lock-url bibtex-font-lock-crossref)
"*Default expressions to highlight in BibTeX mode.")
(defvar bibtex-font-lock-url-regexp
;; Assume that field names begin at the beginning of a line.
(concat "^[ \t]*"
(regexp-opt (delete-dups (mapcar 'caar bibtex-generate-url-list)) t)
"[ \t]*=[ \t]*")
"Regexp for `bibtex-font-lock-url'.")
(defvar bibtex-field-name-for-parsing nil
"Regexp of field name to be parsed by function `bibtex-parse-field-name'.
Passed by dynamic scoping.")
(defvar bibtex-sort-entry-class-alist
(let ((i -1) alist)
(dolist (class bibtex-sort-entry-class alist)
(setq i (1+ i))
(dolist (entry class)
;; all entry names should be downcase (for ease of comparison)
(push (cons (if (stringp entry) (downcase entry) entry) i) alist))))
"Alist mapping entry types to their sorting index.
Auto-generated from `bibtex-sort-entry-class'.
Used when `bibtex-maintain-sorted-entries' is `entry-class'.")
;; Support for hideshow minor mode
(defun bibtex-hs-forward-sexp (arg)
"Replacement for `forward-sexp' to be used by `hs-minor-mode'.
ARG is ignored."
(if (looking-at "@\\S(*\\s(")
(goto-char (1- (match-end 0))))
(forward-sexp 1))
(add-to-list
'hs-special-modes-alist
'(bibtex-mode "@\\S(*\\s(" "\\s)" nil bibtex-hs-forward-sexp nil))
(defun bibtex-parse-association (parse-lhs parse-rhs)
"Parse a string of the format <left-hand-side = right-hand-side>.
The functions PARSE-LHS and PARSE-RHS are used to parse the corresponding
substrings. These functions are expected to return nil if parsing is not
successful. If both functions return non-nil, a pair containing the returned
values of the functions PARSE-LHS and PARSE-RHS is returned."
(save-match-data
(save-excursion
(let ((left (funcall parse-lhs))
right)
(if (and left
(looking-at "[ \t\n]*=[ \t\n]*")
(goto-char (match-end 0))
(setq right (funcall parse-rhs)))
(cons left right))))))
(defun bibtex-parse-field-name ()
"Parse the field name stored in `bibtex-field-name-for-parsing'.
If the field name is found, return a triple consisting of the position of the
very first character of the match, the actual starting position of the name
part and end position of the match. Move point to end of field name.
If `bibtex-autoadd-commas' is non-nil add missing comma at end of preceding
BibTeX field as necessary."
(cond ((looking-at ",[ \t\n]*")
(let ((start (point)))
(goto-char (match-end 0))
(when (looking-at bibtex-field-name-for-parsing)
(goto-char (match-end 0))
(list start (match-beginning 0) (match-end 0)))))
;; Maybe add a missing comma.
((and bibtex-autoadd-commas
(looking-at (concat "[ \t\n]*\\(?:" bibtex-field-name-for-parsing
"\\)[ \t\n]*=")))
(skip-chars-backward " \t\n")
(insert ",")
(forward-char -1)
;; Now try again.
(bibtex-parse-field-name))))
(defconst bibtex-braced-string-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?\{ "(}" st)
(modify-syntax-entry ?\} "){" st)
(modify-syntax-entry ?\[ "." st)
(modify-syntax-entry ?\] "." st)
(modify-syntax-entry ?\( "." st)
(modify-syntax-entry ?\) "." st)
(modify-syntax-entry ?\\ "." st)
(modify-syntax-entry ?\" "." st)
st)
"Syntax-table to parse matched braces.")
(defconst bibtex-quoted-string-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?\\ "\\" st)
(modify-syntax-entry ?\" "\"" st)
st)
"Syntax-table to parse matched quotes.")
(defun bibtex-parse-field-string ()
"Parse a BibTeX field string enclosed by braces or quotes.
If a syntactically correct string is found, a pair containing the start and
end position of the field string is returned, nil otherwise."
(let ((end-point
(or (and (eq (following-char) ?\")
(save-excursion
(with-syntax-table bibtex-quoted-string-syntax-table
(forward-sexp 1))
(point)))
(and (eq (following-char) ?\{)
(save-excursion
(with-syntax-table bibtex-braced-string-syntax-table
(forward-sexp 1))
(point))))))
(if end-point
(cons (point) end-point))))
(defun bibtex-parse-field-text ()
"Parse the text part of a BibTeX field.
The text part is either a string, or an empty string, or a constant followed
by one or more <# (string|constant)> pairs. If a syntactically correct text
is found, a pair containing the start and end position of the text is
returned, nil otherwise. Move point to end of field text."
(let ((starting-point (point))
end-point failure boundaries)
(while (not (or end-point failure))
(cond ((looking-at bibtex-field-const)
(goto-char (match-end 0)))
((setq boundaries (bibtex-parse-field-string))
(goto-char (cdr boundaries)))
((setq failure t)))
(if (looking-at "[ \t\n]*#[ \t\n]*")
(goto-char (match-end 0))
(setq end-point (point))))
(if (and (not failure)
end-point)
(cons starting-point end-point))))
(defun bibtex-parse-field (name)
"Parse a BibTeX field of regexp NAME.
If a syntactically correct field is found, a pair containing the boundaries of
the name and text parts of the field is returned."
(let ((bibtex-field-name-for-parsing name))
(bibtex-parse-association 'bibtex-parse-field-name
'bibtex-parse-field-text)))
(defun bibtex-search-forward-field (name &optional bound)
"Search forward to find a BibTeX field of name NAME.
If a syntactically correct field is found, a pair containing the boundaries of
the name and text parts of the field is returned. The search is limited by
optional arg BOUND. If BOUND is t the search is limited by the end of the
current entry. Do not move point."
(save-match-data
(save-excursion
(unless (integer-or-marker-p bound)
(setq bound (if bound
(save-excursion (bibtex-end-of-entry))
(point-max))))
(let ((case-fold-search t)
(bibtex-field-name-for-parsing name)
boundaries temp-boundaries)
(while (and (not boundaries)
(< (point) bound)
(search-forward "," bound t))
(goto-char (match-beginning 0))
(if (and (setq temp-boundaries
(bibtex-parse-association 'bibtex-parse-field-name
'bibtex-parse-field-text))
(<= (cddr temp-boundaries) bound))
(setq boundaries temp-boundaries)
(forward-char 1)))
boundaries))))
(defun bibtex-search-backward-field (name &optional bound)
"Search backward to find a BibTeX field of name NAME.
If a syntactically correct field is found, a pair containing the boundaries of
the name and text parts of the field is returned. The search is limited by
optional arg BOUND. If BOUND is t the search is limited by the beginning of the
current entry. Do not move point."
(save-match-data
(save-excursion
(unless (integer-or-marker-p bound)
(setq bound (if bound
(save-excursion (bibtex-beginning-of-entry))
(point-min))))
(let ((case-fold-search t)
(bibtex-field-name-for-parsing name)
boundaries temp-boundaries)
(while (and (not boundaries)
(>= (point) bound)
(search-backward "," bound t))
(if (setq temp-boundaries
(bibtex-parse-association 'bibtex-parse-field-name
'bibtex-parse-field-text))
(setq boundaries temp-boundaries)))
boundaries))))
(defsubst bibtex-start-of-field (bounds)
(nth 0 (car bounds)))
(defsubst bibtex-start-of-name-in-field (bounds)
(nth 1 (car bounds)))
(defsubst bibtex-end-of-name-in-field (bounds)
(nth 2 (car bounds)))
(defsubst bibtex-end-of-field (bounds)
(cddr bounds))
(defsubst bibtex-start-of-text-in-field (bounds)
(cadr bounds))
(defsubst bibtex-end-of-text-in-field (bounds)
(cddr bounds))
(defun bibtex-name-in-field (bounds &optional remove-opt-alt)
"Get content of name in BibTeX field defined via BOUNDS.
If optional arg REMOVE-OPT-ALT is non-nil remove \"OPT\" and \"ALT\"."
(let ((name (buffer-substring-no-properties (nth 1 (car bounds))
(nth 2 (car bounds)))))
(if (and remove-opt-alt
(string-match "\\`\\(OPT\\|ALT\\)" name))
(substring name 3)
name)))
(defun bibtex-text-in-field-bounds (bounds &optional remove-delim)
"Get content of text in BibTeX field defined via BOUNDS.
If optional arg REMOVE-DELIM is non-nil remove enclosing field delimiters
if present."
(let ((content (buffer-substring-no-properties (cadr bounds)
(cddr bounds))))
(if remove-delim
(bibtex-remove-delimiters-string content)
content)))
(defun bibtex-text-in-field (field &optional follow-crossref)
"Get content of field FIELD of current BibTeX entry.
Return nil if not found.
If optional arg FOLLOW-CROSSREF is non-nil, follow crossref."
(save-excursion
(save-restriction
;; We want to jump back and forth while searching FIELD
(bibtex-narrow-to-entry)
(goto-char (point-min))
(let ((bounds (bibtex-search-forward-field field))
crossref-field)
(cond (bounds (bibtex-text-in-field-bounds bounds t))
((and follow-crossref
(progn (goto-char (point-min))
(setq bounds (bibtex-search-forward-field
"\\(OPT\\)?crossref"))))
(setq crossref-field (bibtex-text-in-field-bounds bounds t))
(widen)
(if (bibtex-find-crossref crossref-field)
;; Do not pass FOLLOW-CROSSREF because we want
;; to follow crossrefs only one level of recursion.
(bibtex-text-in-field field))))))))
(defun bibtex-parse-string-prefix ()
"Parse the prefix part of a BibTeX string entry, including reference key.
If the string prefix is found, return a triple consisting of the position of
the very first character of the match, the actual starting position of the
reference key and the end position of the match."
(let ((case-fold-search t))
(if (looking-at "^[ \t]*@string[ \t\n]*[({][ \t\n]*")
(let ((start (point)))
(goto-char (match-end 0))
(when (looking-at bibtex-reference-key)
(goto-char (match-end 0))
(list start
(match-beginning 0)
(match-end 0)))))))
(defun bibtex-parse-string-postfix ()
"Parse the postfix part of a BibTeX string entry, including the text.
If the string postfix is found, return a triple consisting of the position of
the actual starting and ending position of the text and the very last
character of the string entry. Move point past BibTeX string entry."
(let* ((case-fold-search t)
(bounds (bibtex-parse-field-text)))
(when bounds
(goto-char (cdr bounds))
(when (looking-at "[ \t\n]*[})]")
(goto-char (match-end 0))
(list (car bounds)
(cdr bounds)
(match-end 0))))))
(defun bibtex-parse-string ()
"Parse a BibTeX string entry.
If a syntactically correct entry is found, a pair containing the boundaries of
the reference key and text parts of the entry is returned.
Move point past BibTeX string entry."
(bibtex-parse-association 'bibtex-parse-string-prefix
'bibtex-parse-string-postfix))
(defun bibtex-search-forward-string ()
"Search forward to find a BibTeX string entry.
If a syntactically correct entry is found, a pair containing the boundaries of
the reference key and text parts of the string is returned. Do not move point."
(save-excursion
(save-match-data
(let ((case-fold-search t)
boundaries)
(while (and (not boundaries)
(search-forward-regexp
"^[ \t]*@string[ \t\n]*[({][ \t\n]*" nil t))
(goto-char (match-beginning 0))
(unless (setq boundaries (bibtex-parse-string))
(forward-char 1)))
boundaries))))
(defun bibtex-search-backward-string ()
"Search backward to find a BibTeX string entry.
If a syntactically correct entry is found, a pair containing the boundaries of
the reference key and text parts of the field is returned. Do not move point."
(save-excursion
(save-match-data
(let ((case-fold-search t)
boundaries)
(while (and (not boundaries)
(search-backward-regexp
"^[ \t]*@string[ \t\n]*[({][ \t\n]*" nil t))
(goto-char (match-beginning 0))
(setq boundaries (bibtex-parse-string)))
boundaries))))
(defun bibtex-reference-key-in-string (bounds)
(buffer-substring-no-properties (nth 1 (car bounds))
(nth 2 (car bounds))))
(defun bibtex-text-in-string (bounds &optional remove-delim)
"Get content of text in BibTeX string field defined via BOUNDS.
If optional arg REMOVE-DELIM is non-nil remove enclosing field
delimiters if present."
(let ((content (buffer-substring-no-properties (nth 0 (cdr bounds))
(nth 1 (cdr bounds)))))
(if remove-delim
(bibtex-remove-delimiters-string content)
content)))
(defsubst bibtex-start-of-text-in-string (bounds)
(nth 0 (cdr bounds)))
(defsubst bibtex-end-of-text-in-string (bounds)
(nth 1 (cdr bounds)))
(defsubst bibtex-end-of-string (bounds)
(nth 2 (cdr bounds)))
(defsubst bibtex-type-in-head ()
"Extract BibTeX type in head."
;; ignore @
(buffer-substring-no-properties (1+ (match-beginning bibtex-type-in-head))
(match-end bibtex-type-in-head)))
(defsubst bibtex-key-in-head (&optional empty)
"Extract BibTeX key in head. Return optional arg EMPTY if key is empty."
(or (match-string-no-properties bibtex-key-in-head)
empty))
;; Helper Functions
(defun bibtex-remove-delimiters-string (str)
"Remove delimiters of string STR."
(if (and (memq (aref str 0) '(?\{ ?\"))
(memq (aref str (1- (length str))) '(?\} ?\")))
(substring str 1 -1)
str))
(defsubst bibtex-string= (str1 str2)
"Return t if STR1 and STR2 are equal, ignoring case."
(eq t (compare-strings str1 0 nil str2 0 nil t)))
(defun bibtex-delete-whitespace ()
"Delete all whitespace starting at point."
(if (looking-at "[ \t\n]+")
(delete-region (point) (match-end 0))))
(defun bibtex-current-line ()
"Compute line number of point regardless whether the buffer is narrowed."
(+ (count-lines 1 (point))
(if (bolp) 1 0)))
(defun bibtex-skip-to-valid-entry (&optional backward)
"Move point to beginning of the next valid BibTeX entry.
Do not move if we are already at beginning of a valid BibTeX entry.
With optional argument BACKWARD non-nil, move backward to
beginning of previous valid one. A valid entry is a syntactical correct one
with type contained in `bibtex-entry-field-alist' or, if
`bibtex-sort-ignore-string-entries' is nil, a syntactical correct string
entry. Return buffer position of beginning and ending of entry if a valid
entry is found, nil otherwise."
(interactive "P")
(let ((case-fold-search t)
found)
(while (not (or found (if backward (bobp) (eobp))))
(let ((pnt (point))
bounds)
(cond ((or (and (looking-at bibtex-valid-entry-re)
(setq found (bibtex-search-entry nil nil t))
(equal (match-beginning 0) pnt))
(and (not bibtex-sort-ignore-string-entries)
(setq bounds (bibtex-parse-string))
(setq found (cons (bibtex-start-of-field bounds)
(bibtex-end-of-string bounds)))))
(goto-char pnt))
(backward
(if (re-search-backward "^[ \t]*\\(@\\)" nil 'move)
(goto-char (match-beginning 1))))
(t (if (re-search-forward "\n[ \t]*@" nil 'move)
(forward-char -1))))))
found))
(defun bibtex-map-entries (fun)
"Call FUN for each BibTeX entry in buffer (possibly narrowed).
FUN is called with three arguments, the key of the entry and the buffer
positions (marker) of beginning and end of entry. Point is inside the entry.
If `bibtex-sort-ignore-string-entries' is non-nil, FUN is not called for
@String entries."
(let ((case-fold-search t))
(save-excursion
(goto-char (point-min))
(while (re-search-forward bibtex-entry-head nil t)
(let ((entry-type (bibtex-type-in-head))
(key (bibtex-key-in-head ""))
(beg (copy-marker (match-beginning 0)))
(end (copy-marker (save-excursion (bibtex-end-of-entry)))))
(save-excursion
(if (or (and (not bibtex-sort-ignore-string-entries)
(bibtex-string= entry-type "string"))
(assoc-string entry-type bibtex-entry-field-alist t))
(funcall fun key beg end)))
(goto-char end))))))
(defun bibtex-progress-message (&optional flag interval)
"Echo a message about progress of current buffer.
If FLAG is a string, the message is initialized (in this case a
value for INTERVAL may be given as well (if not this is set to 5)).
If FLAG is `done', the message is deinitialized.
If FLAG is nil, a message is echoed if point was incremented at least
`bibtex-progress-interval' percent since last message was echoed."
(cond ((stringp flag)
(setq bibtex-progress-lastmes flag
bibtex-progress-interval (or interval 5)
bibtex-progress-lastperc 0))
((eq flag 'done)
(message "%s (done)" bibtex-progress-lastmes)
(setq bibtex-progress-lastmes nil))
(t
(let* ((size (- (point-max) (point-min)))
(perc (if (= size 0)
100
(/ (* 100 (- (point) (point-min))) size))))
(when (>= perc (+ bibtex-progress-lastperc
bibtex-progress-interval))
(setq bibtex-progress-lastperc perc)
(message "%s (%d%%)" bibtex-progress-lastmes perc))))))
(defun bibtex-field-left-delimiter ()
"Return a string dependent on `bibtex-field-delimiters'."
(if (eq bibtex-field-delimiters 'braces)
"{"
"\""))
(defun bibtex-field-right-delimiter ()
"Return a string dependent on `bibtex-field-delimiters'."
(if (eq bibtex-field-delimiters 'braces)
"}"
"\""))
(defun bibtex-entry-left-delimiter ()
"Return a string dependent on `bibtex-entry-delimiters'."
(if (eq bibtex-entry-delimiters 'braces)
"{"
"("))
(defun bibtex-entry-right-delimiter ()
"Return a string dependent on `bibtex-entry-delimiters'."
(if (eq bibtex-entry-delimiters 'braces)
"}"
")"))
(defun bibtex-search-entry (empty-head &optional bound noerror backward)
"Search for a BibTeX entry (maybe without reference key if EMPTY-HEAD is t).
BOUND and NOERROR are exactly as in `re-search-forward'. If BACKWARD
is non-nil, search in reverse direction. Move point past the closing
delimiter (at the beginning of entry if BACKWARD is non-nil).
Return a cons pair with buffer positions of beginning and end of entry.
After call to this function MATCH-BEGINNING and MATCH-END functions
are defined, but only for the head part of the entry
\(especially (match-end 0) just gives the end of the head part)."
(let ((pnt (point))
(entry-head-re (if empty-head
bibtex-entry-maybe-empty-head
bibtex-entry-head)))
(if backward
(let (found)
(while (and (not found)
(re-search-backward entry-head-re bound noerror))
(setq found (bibtex-search-entry empty-head pnt t)))
(if found
(progn (goto-char (match-beginning 0))
found)
(cond ((not noerror)
;; yell
(error "Backward search of BibTeX entry failed"))
((eq noerror t)
;; don't move
(goto-char pnt)))
nil))
(let (found)
(unless bound (setq bound (point-max)))
(while (and (not found)
(re-search-forward entry-head-re bound noerror))
(save-match-data
(let ((entry-closer
(if (save-excursion
(goto-char (match-end bibtex-type-in-head))
(looking-at "[ \t]*("))
;; entry opened with parenthesis
?\)
?\}))
(infix-start (point))
finished bounds)
(while (not finished)
(skip-chars-forward " \t\n" bound)
(if (and (setq bounds (bibtex-parse-field bibtex-field-name))
(<= (bibtex-end-of-field bounds) bound))
(setq infix-start (bibtex-end-of-field bounds))
(setq finished t))
(goto-char infix-start))
;; This matches the infix* part. The AND construction assures
;; that BOUND is respected.
(when (and (looking-at bibtex-entry-postfix)
(eq (char-before (match-end 0)) entry-closer)
(<= (match-end 0) bound))
(goto-char (match-end 0))
(setq found t)))))
(if found
(cons (match-beginning 0) (point))
(cond ((not noerror)
;; yell
(error "Search of BibTeX entry failed"))
((eq noerror t)
;; don't move
(goto-char pnt)))
nil)))))
(defun bibtex-flash-head ()
"Flash at BibTeX entry head before point, if exists."
(let ((case-fold-search t)
flash)
(cond ((re-search-backward bibtex-entry-head nil t)
(goto-char (match-beginning bibtex-type-in-head))
(setq flash (match-end bibtex-key-in-head)))
(t
(end-of-line)
(skip-chars-backward " \t")
(setq flash (point))
(beginning-of-line)
(skip-chars-forward " \t")))
(if (pos-visible-in-window-p (point))
(sit-for 1)
(message "From: %s"
(buffer-substring (point) flash)))))
(defun bibtex-make-optional-field (field)
"Make an optional field named FIELD in current BibTeX entry."
(if (consp field)
(bibtex-make-field (cons (concat "OPT" (car field)) (cdr field)))
(bibtex-make-field (concat "OPT" field))))
(defun bibtex-move-outside-of-entry ()
"Make sure point is outside of a BibTeX entry."
(let ((orig-point (point)))
(bibtex-end-of-entry)
(when (< (point) orig-point)
;; We moved backward, so we weren't inside an entry to begin with.
;; Leave point at the beginning of a line, and preferably
;; at the beginning of a paragraph.
(goto-char orig-point)
(beginning-of-line 1)
(unless (= ?\n (char-before (1- (point))))
(re-search-forward "^[ \t]*[@\n]" nil 'move)
(backward-char 1)))
(skip-chars-forward " \t\n")))
(defun bibtex-beginning-of-first-entry ()
"Go to the beginning of the first BibTeX entry in buffer. Return point."
(goto-char (point-min))
(if (re-search-forward "^[ \t]*@" nil 'move)
(beginning-of-line))
(point))
(defun bibtex-beginning-of-last-entry ()
"Go to the beginning of the last BibTeX entry in buffer."
(goto-char (point-max))
(if (re-search-backward "^[ \t]*@" nil 'move)
(beginning-of-line))
(point))
(defun bibtex-inside-field ()
"Try to avoid point being at end of a BibTeX field."
(end-of-line)
(skip-chars-backward " \t")
(if (= (preceding-char) ?,)
(forward-char -2))
(if (or (= (preceding-char) ?})
(= (preceding-char) ?\"))
(forward-char -1)))
(defun bibtex-enclosing-field (&optional noerr)
"Search for BibTeX field enclosing point.
Unless NOERR is non-nil, signal an error if no enclosing field is found.
On success return bounds, nil otherwise. Do not move point."
(let ((bounds (bibtex-search-backward-field bibtex-field-name t)))
(if (and bounds
(<= (bibtex-start-of-field bounds) (point))
(>= (bibtex-end-of-field bounds) (point)))
bounds
(unless noerr
(error "Can't find enclosing BibTeX field")))))
(defun bibtex-enclosing-entry-maybe-empty-head ()
"Search for BibTeX entry enclosing point. Move point to end of entry.
Beginning (but not end) of entry is given by (`match-beginning' 0)."
(let ((case-fold-search t)
(old-point (point)))
(unless (re-search-backward bibtex-entry-maybe-empty-head nil t)
(goto-char old-point)
(error "Can't find beginning of enclosing BibTeX entry"))
(goto-char (match-beginning bibtex-type-in-head))
(unless (bibtex-search-entry t nil t)
(goto-char old-point)
(error "Can't find end of enclosing BibTeX entry"))))
(defun bibtex-insert-kill (n)
"Reinsert the Nth stretch of killed BibTeX text."
(if (not bibtex-last-kill-command)
(error "BibTeX kill ring is empty")
(let* ((kr (if (eq bibtex-last-kill-command 'field)
'bibtex-field-kill-ring
'bibtex-entry-kill-ring))
(kryp (if (eq bibtex-last-kill-command 'field)
'bibtex-field-kill-ring-yank-pointer
'bibtex-entry-kill-ring-yank-pointer))
(current (car (set kryp (nthcdr (mod (- n (length (eval kryp)))
(length (eval kr)))
(eval kr))))))
(if (eq bibtex-last-kill-command 'field)
(let (bibtex-help-message)
(bibtex-find-text)
(if (looking-at "[}\"]")
(forward-char))
(set-mark (point))
(message "Mark set")
(bibtex-make-field current t))
(unless (eobp) (bibtex-beginning-of-entry))
(set-mark (point))
(message "Mark set")
(insert current)))))
(defun bibtex-format-entry ()
"Helper function for `bibtex-clean-entry'.
Formats current entry according to variable `bibtex-entry-format'."
(save-excursion
(save-restriction
(bibtex-narrow-to-entry)
(let ((case-fold-search t)
(format (if (eq bibtex-entry-format t)
'(realign opts-or-alts required-fields
numerical-fields
last-comma page-dashes delimiters
unify-case inherit-booktitle)
bibtex-entry-format))
crossref-key bounds alternatives-there non-empty-alternative
entry-list req-field-list field-list)
;; identify entry type
(goto-char (point-min))
(re-search-forward bibtex-entry-type)
(let ((beg-type (1+ (match-beginning 0)))
(end-type (match-end 0)))
(setq entry-list (assoc-string (buffer-substring-no-properties
beg-type end-type)
bibtex-entry-field-alist
t))
;; unify case of entry name
(when (memq 'unify-case format)
(delete-region beg-type end-type)
(insert (car entry-list)))
;; update left entry delimiter
(when (memq 'delimiters format)
(goto-char end-type)
(skip-chars-forward " \t\n")
(delete-char 1)
(insert (bibtex-entry-left-delimiter))))
;; determine if entry has crossref field and if at least
;; one alternative is non-empty
(goto-char (point-min))
(let* ((fields-alist (bibtex-parse-entry))
(field (assoc-string "crossref" fields-alist t)))
(setq crossref-key (and field
(not (string-match bibtex-empty-field-re
(cdr field)))
(bibtex-remove-delimiters-string (cdr field)))
req-field-list (if crossref-key
(nth 0 (nth 2 entry-list)) ; crossref part
(nth 0 (nth 1 entry-list)))) ; required part
(dolist (rfield req-field-list)
(when (nth 3 rfield) ; we should have an alternative
(setq alternatives-there t
field (assoc-string (car rfield) fields-alist t))
(if (and field
(not (string-match bibtex-empty-field-re
(cdr field))))
(cond ((not non-empty-alternative)
(setq non-empty-alternative t))
((memq 'required-fields format)
(error "More than one non-empty alternative")))))))
(if (and alternatives-there
(not non-empty-alternative)
(memq 'required-fields format))
(error "All alternatives are empty"))
;; process all fields
(goto-char (point-min))
(while (setq bounds (bibtex-search-forward-field bibtex-field-name))
(let* ((beg-field (copy-marker (bibtex-start-of-field bounds)))
(end-field (copy-marker (bibtex-end-of-field bounds) t))
(beg-name (copy-marker (bibtex-start-of-name-in-field bounds)))
(end-name (copy-marker (bibtex-end-of-name-in-field bounds)))
(beg-text (copy-marker (bibtex-start-of-text-in-field bounds)))
(end-text (copy-marker (bibtex-end-of-text-in-field bounds) t))
(opt-alt (string-match "OPT\\|ALT"
(buffer-substring-no-properties
beg-name (+ beg-name 3))))
(field-name (buffer-substring-no-properties
(if opt-alt (+ beg-name 3) beg-name) end-name))
(empty-field (string-match bibtex-empty-field-re
(buffer-substring-no-properties
beg-text end-text)))
deleted)
;; We have more elegant high-level functions for several
;; tasks done by bibtex-format-entry. However, they contain
;; quite some redundancy compared with what we need to do
;; anyway. So for speed-up we avoid using them.
(if (memq 'opts-or-alts format)
(cond ((and empty-field
(or opt-alt
(let ((field (assoc-string
field-name req-field-list t)))
(or (not field) ; OPT field
(nth 3 field))))) ; ALT field
;; Either it is an empty ALT field. Then we have checked
;; already that we have one non-empty alternative. Or it
;; is an empty OPT field that we do not miss anyway.
;; So we can safely delete this field.
(delete-region beg-field end-field)
(setq deleted t))
;; otherwise: not empty, delete "OPT" or "ALT"
(opt-alt
(goto-char beg-name)
(delete-char 3))))
(unless deleted
(push field-name field-list)
;; remove delimiters from purely numerical fields
(when (and (memq 'numerical-fields format)
(progn (goto-char beg-text)
(looking-at "\\(\"[0-9]+\"\\)\\|\\({[0-9]+}\\)")))
(goto-char end-text)
(delete-char -1)
(goto-char beg-text)
(delete-char 1))
;; update delimiters
(when (memq 'delimiters format)
(goto-char beg-text)
(when (looking-at "[{\"]")
(delete-char 1)
(insert (bibtex-field-left-delimiter)))
(goto-char (1- (marker-position end-text)))
(when (looking-at "[}\"]")
(delete-char 1)
(insert (bibtex-field-right-delimiter))))
;; update page dashes
(if (and (memq 'page-dashes format)
(bibtex-string= field-name "pages")
(progn (goto-char beg-text)
(looking-at
"\\([\"{][0-9]+\\)[ \t\n]*--?[ \t\n]*\\([0-9]+[\"}]\\)")))
(replace-match "\\1-\\2"))
;; use book title of crossref'd entry
(if (and (memq 'inherit-booktitle format)
empty-field
(bibtex-string= field-name "booktitle")
crossref-key)
(let ((title (save-excursion
(save-restriction
(widen)
(if (bibtex-find-entry crossref-key t)
(bibtex-text-in-field "title"))))))
(when title
(setq empty-field nil)
(goto-char (1+ beg-text))
(insert title))))
;; Use booktitle to set a missing title.
(if (and empty-field
(bibtex-string= field-name "title"))
(let ((booktitle (bibtex-text-in-field "booktitle")))
(when booktitle
(setq empty-field nil)
(goto-char (1+ beg-text))
(insert booktitle))))
;; if empty field, complain
(if (and empty-field
(memq 'required-fields format)
(assoc-string field-name req-field-list t))
(error "Mandatory field `%s' is empty" field-name))
;; unify case of field name
(if (memq 'unify-case format)
(let ((fname (car (assoc-string
field-name
(append (nth 0 (nth 1 entry-list))
(nth 1 (nth 1 entry-list))
bibtex-user-optional-fields)
t))))
(if fname
(progn
(delete-region beg-name end-name)
(goto-char beg-name)
(insert fname))
;; there are no rules we could follow
(downcase-region beg-name end-name))))
;; update point
(goto-char end-field))))
;; check whether all required fields are present
(if (memq 'required-fields format)
(let ((found 0) altlist)
(dolist (fname req-field-list)
(if (nth 3 fname)
(push (car fname) altlist))
(unless (or (member (car fname) field-list)
(nth 3 fname))
(error "Mandatory field `%s' is missing" (car fname))))
(when altlist
(dolist (fname altlist)
(if (member fname field-list)
(setq found (1+ found))))
(cond ((= found 0)
(error "Alternative mandatory field `%s' is missing"
altlist))
((> found 1)
(error "Alternative fields `%s' are defined %s times"
altlist found))))))
;; update point
(if (looking-at (bibtex-field-right-delimiter))
(forward-char))
;; update comma after last field
(if (memq 'last-comma format)
(cond ((and bibtex-comma-after-last-field
(not (looking-at ",")))
(insert ","))
((and (not bibtex-comma-after-last-field)
(looking-at ","))
(delete-char 1))))
;; update right entry delimiter
(if (looking-at ",")
(forward-char))
(when (memq 'delimiters format)
(skip-chars-forward " \t\n")
(delete-char 1)
(insert (bibtex-entry-right-delimiter)))
;; fill entry
(if (memq 'realign format)
(bibtex-fill-entry))))))
(defun bibtex-autokey-abbrev (string len)
"Return an abbreviation of STRING with at least LEN characters.
If LEN is positive the abbreviation is terminated only after a consonant
or at the word end. If LEN is negative the abbreviation is strictly
enforced using abs (LEN) characters. If LEN is not a number, STRING
is returned unchanged."
(cond ((or (not (numberp len))
(<= (length string) (abs len)))
string)
((equal len 0)
"")
((< len 0)
(substring string 0 (abs len)))
(t (let* ((case-fold-search t)
(abort-char (string-match "[^aeiou]" string (1- len))))
(if abort-char
(substring string 0 (1+ abort-char))
string)))))
(defun bibtex-autokey-get-field (field &optional change-list)
"Get content of BibTeX field FIELD. Return empty string if not found.
Optional arg CHANGE-LIST is a list of substitution patterns that is
applied to the content of FIELD. It is an alist with pairs
\(OLD-REGEXP . NEW-STRING\)."
(let ((content (bibtex-text-in-field field bibtex-autokey-use-crossref))
case-fold-search)
(unless content (setq content ""))
(dolist (pattern change-list content)
(setq content (replace-regexp-in-string (car pattern)
(cdr pattern)
content t)))))
(defun bibtex-autokey-get-names ()
"Get contents of the name field of the current entry.
Do some modifications based on `bibtex-autokey-name-change-strings'.
Return the names as a concatenated string obeying `bibtex-autokey-names'
and `bibtex-autokey-names-stretch'."
(let ((names (bibtex-autokey-get-field "author\\|editor"
bibtex-autokey-name-change-strings)))
;; Some entries do not have a name field.
(if (string= "" names)
names
(let* ((case-fold-search t)
(name-list (mapcar 'bibtex-autokey-demangle-name
(split-string names "[ \t\n]+and[ \t\n]+")))
additional-names)
(unless (or (not (numberp bibtex-autokey-names))
(<= (length name-list)
(+ bibtex-autokey-names
bibtex-autokey-names-stretch)))
;; Take bibtex-autokey-names elements from beginning of name-list
(setq name-list (nreverse (nthcdr (- (length name-list)
bibtex-autokey-names)
(nreverse name-list)))
additional-names bibtex-autokey-additional-names))
(concat (mapconcat 'identity name-list
bibtex-autokey-name-separator)
additional-names)))))
(defun bibtex-autokey-demangle-name (fullname)
"Get the last part from a well-formed FULLNAME and perform abbreviations."
(let* (case-fold-search
(name (cond ((string-match "\\([[:upper:]][^, ]*\\)[^,]*," fullname)
;; Name is of the form "von Last, First" or
;; "von Last, Jr, First"
;; --> Take the first capital part before the comma
(match-string 1 fullname))
((string-match "\\([^, ]*\\)," fullname)
;; Strange name: we have a comma, but nothing capital
;; So we accept even lowercase names
(match-string 1 fullname))
((string-match "\\(\\<[[:lower:]][^ ]* +\\)+\\([[:upper:]][^ ]*\\)"
fullname)
;; name is of the form "First von Last", "von Last",
;; "First von von Last", or "d'Last"
;; --> take the first capital part after the "von" parts
(match-string 2 fullname))
((string-match "\\([^ ]+\\) *\\'" fullname)
;; name is of the form "First Middle Last" or "Last"
;; --> take the last token
(match-string 1 fullname))
(t (error "Name `%s' is incorrectly formed" fullname)))))
(funcall bibtex-autokey-name-case-convert
(bibtex-autokey-abbrev name bibtex-autokey-name-length))))
(defun bibtex-autokey-get-year ()
"Return year field contents as a string obeying `bibtex-autokey-year-length'."
(let ((yearfield (bibtex-autokey-get-field "year")))
(substring yearfield (max 0 (- (length yearfield)
bibtex-autokey-year-length)))))
(defun bibtex-autokey-get-title ()
"Get title field contents up to a terminator.
Return the result as a string"
(let ((case-fold-search t)
(titlestring
(bibtex-autokey-get-field "title"
bibtex-autokey-titleword-change-strings)))
;; ignore everything past a terminator
(if (string-match bibtex-autokey-title-terminators titlestring)
(setq titlestring (substring titlestring 0 (match-beginning 0))))
;; gather words from titlestring into a list. Ignore
;; specific words and use only a specific amount of words.
(let ((counter 0)
titlewords titlewords-extra word)
(while (and (or (not (numberp bibtex-autokey-titlewords))
(< counter (+ bibtex-autokey-titlewords
bibtex-autokey-titlewords-stretch)))
(string-match "\\b\\w+" titlestring))
(setq word (match-string 0 titlestring)
titlestring (substring titlestring (match-end 0)))
;; Ignore words matched by one of the elements of
;; bibtex-autokey-titleword-ignore
(unless (let ((lst bibtex-autokey-titleword-ignore))
(while (and lst
(not (string-match (concat "\\`\\(?:" (car lst)
"\\)\\'") word)))
(setq lst (cdr lst)))
lst)
(setq counter (1+ counter))
(if (or (not (numberp bibtex-autokey-titlewords))
(<= counter bibtex-autokey-titlewords))
(push word titlewords)
(push word titlewords-extra))))
;; Obey bibtex-autokey-titlewords-stretch:
;; If by now we have processed all words in titlestring, we include
;; titlewords-extra in titlewords. Otherwise, we ignore titlewords-extra.
(unless (string-match "\\b\\w+" titlestring)
(setq titlewords (append titlewords-extra titlewords)))
(mapconcat 'bibtex-autokey-demangle-title (nreverse titlewords)
bibtex-autokey-titleword-separator))))
(defun bibtex-autokey-demangle-title (titleword)
"Do some abbreviations on TITLEWORD.
The rules are defined in `bibtex-autokey-titleword-abbrevs'
and `bibtex-autokey-titleword-length'."
(let ((case-fold-search t)
(alist bibtex-autokey-titleword-abbrevs))
(while (and alist
(not (string-match (concat "\\`\\(?:" (caar alist) "\\)\\'")
titleword)))
(setq alist (cdr alist)))
(if alist
(cdar alist)
(funcall bibtex-autokey-titleword-case-convert
(bibtex-autokey-abbrev titleword bibtex-autokey-titleword-length)))))
(defun bibtex-generate-autokey ()
"Generate automatically a key for a BibTeX entry.
Use the author/editor, the year and the title field.
The algorithm works as follows.
The name part:
1. Use the author or editor field to generate the name part of the key.
2. Change the content of the name field according to
`bibtex-autokey-name-change-strings' (see there for further detail).
3. Use the first `bibtex-autokey-names' names in the name field. If there
are up to `bibtex-autokey-names' + `bibtex-autokey-names-stretch' names,
use all names.
4. Use only the last names to form the name part. From these last names,
take at least `bibtex-autokey-name-length' characters (truncate only
after a consonant or at a word end).
5. Convert all last names using the function
`bibtex-autokey-name-case-convert'.
6. Build the name part of the key by concatenating all abbreviated last
names with the string `bibtex-autokey-name-separator' between any two.
If there are more names in the name field than names used in the name
part, append the string `bibtex-autokey-additional-names'.
The year part:
1. Build the year part of the key by truncating the content of the year
field to the rightmost `bibtex-autokey-year-length' digits (useful
values are 2 and 4).
2. If the year field (or any other field required to generate the key)
is absent, but the entry has a valid crossref field and
`bibtex-autokey-use-crossref' is non-nil, use the field of the
crossreferenced entry instead.
The title part
1. Change the content of the title field according to
`bibtex-autokey-titleword-change-strings' (see there for further detail).
2. Truncate the title before the first match of
`bibtex-autokey-title-terminators' and delete those words which appear
in `bibtex-autokey-titleword-ignore'. Build the title part using the
first `bibtex-autokey-titlewords' words from this truncated title.
If the truncated title ends after up to `bibtex-autokey-titlewords' +
`bibtex-autokey-titlewords-stretch' words, use all words from the
truncated title.
3. For every title word that appears in `bibtex-autokey-titleword-abbrevs'
use the corresponding abbreviation (see documentation of this variable
for further detail).
4. From every title word not generated by an abbreviation, take at least
`bibtex-autokey-titleword-length' characters (truncate only after
a consonant or at a word end).
5. Convert all title words using the function
`bibtex-autokey-titleword-case-convert'.
6. Build the title part by concatenating all abbreviated title words with
the string `bibtex-autokey-titleword-separator' between any two.
Concatenate the key:
1. Concatenate `bibtex-autokey-prefix-string', the name part, the year
part and the title part. If the name part and the year part are both
non-empty insert `bibtex-autokey-name-year-separator' between the two.
If the title part and the year (or name) part are non-empty, insert
`bibtex-autokey-year-title-separator' between the two.
2. If `bibtex-autokey-before-presentation-function' is non-nil, it must be
a function taking one argument. Call this function with the generated
key as the argument. Use the return value of this function (a string)
as the key.
3. If `bibtex-autokey-edit-before-use' is non-nil, present the key in the
minibuffer to the user for editing. Insert the key given by the user."
(let* ((names (bibtex-autokey-get-names))
(year (bibtex-autokey-get-year))
(title (bibtex-autokey-get-title))
(autokey (concat bibtex-autokey-prefix-string
names
(unless (or (equal names "")
(equal year ""))
bibtex-autokey-name-year-separator)
year
(unless (or (and (equal names "")
(equal year ""))
(equal title ""))
bibtex-autokey-year-title-separator)
title)))
(if bibtex-autokey-before-presentation-function
(funcall bibtex-autokey-before-presentation-function autokey)
autokey)))
(defun bibtex-global-key-alist ()
"Return global key alist based on `bibtex-files'."
(if bibtex-files
(apply 'append
(mapcar (lambda (buf)
(with-current-buffer buf bibtex-reference-keys))
(bibtex-files-expand t)))
bibtex-reference-keys))
(defun bibtex-read-key (prompt &optional key global)
"Read BibTeX key from minibuffer using PROMPT and default KEY.
If optional arg GLOBAL is non-nil, completion is based on the keys in
`bibtex-reference-keys' of `bibtex-files',"
(let (completion-ignore-case)
(completing-read prompt (if global (bibtex-global-key-alist)
bibtex-reference-keys)
nil nil key 'bibtex-key-history)))
(defun bibtex-read-string-key (&optional key)
"Read BibTeX string key from minibuffer using default KEY."
(let ((completion-ignore-case t))
(completing-read "String key: " bibtex-strings
nil nil key 'bibtex-key-history)))
(defun bibtex-parse-keys (&optional abortable verbose)
"Set `bibtex-reference-keys' to the keys used in the whole buffer.
Find both entry keys and crossref entries. If ABORTABLE is non-nil abort
on user input. If VERBOSE is non-nil give messages about progress.
Return alist of keys if parsing was completed, `aborted' otherwise."
(let (ref-keys crossref-keys)
(save-excursion
(save-match-data
(if verbose
(bibtex-progress-message
(concat (buffer-name) ": parsing reference keys")))
(catch 'userkey
(goto-char (point-min))
(if bibtex-parse-keys-fast
(let ((case-fold-search t)
(re (concat bibtex-entry-head "\\|"
",[ \t\n]*crossref[ \t\n]*=[ \t\n]*"
"\\(\"[^\"]*\"\\|{[^}]*}\\)[ \t\n]*[,})]")))
(while (re-search-forward re nil t)
(if (and abortable (input-pending-p))
;; user has aborted by typing a key --> return `aborted'
(throw 'userkey 'aborted))
(cond ((match-end 3)
;; This is a crossref.
(let ((key (buffer-substring-no-properties
(1+ (match-beginning 3)) (1- (match-end 3)))))
(unless (assoc key crossref-keys)
(push (list key) crossref-keys))))
;; only keys of known entries
((assoc-string (bibtex-type-in-head)
bibtex-entry-field-alist t)
;; This is an entry.
(let ((key (bibtex-key-in-head)))
(unless (assoc key ref-keys)
(push (cons key t) ref-keys)))))))
(let (;; ignore @String entries because they are handled
;; separately by bibtex-parse-strings
(bibtex-sort-ignore-string-entries t)
bounds)
(bibtex-map-entries
(lambda (key beg end)
(if (and abortable
(input-pending-p))
;; user has aborted by typing a key --> return `aborted'
(throw 'userkey 'aborted))
(if verbose (bibtex-progress-message))
(unless (assoc key ref-keys)
(push (cons key t) ref-keys))
(if (and (setq bounds (bibtex-search-forward-field "crossref" end))
(setq key (bibtex-text-in-field-bounds bounds t))
(not (assoc key crossref-keys)))
(push (list key) crossref-keys))))))
(dolist (key crossref-keys)
(unless (assoc (car key) ref-keys) (push key ref-keys)))
(if verbose
(bibtex-progress-message 'done))
;; successful operation --> return `bibtex-reference-keys'
(setq bibtex-reference-keys ref-keys))))))
(defun bibtex-parse-strings (&optional add abortable)
"Set `bibtex-strings' to the string definitions in the whole buffer.
If ADD is non-nil add the new strings to `bibtex-strings' instead of
simply resetting it. If ADD is an alist of strings, also add ADD to
`bibtex-strings'. If ABORTABLE is non-nil abort on user input.
Return alist of strings if parsing was completed, `aborted' otherwise."
(save-excursion
(save-match-data
(goto-char (point-min))
(let ((strings (if (and add
(listp bibtex-strings))
bibtex-strings))
bounds key)
(if (listp add)
(dolist (string add)
(unless (assoc-string (car string) strings t)
(push string strings))))
(catch 'userkey
(while (setq bounds (bibtex-search-forward-string))
(if (and abortable
(input-pending-p))
;; user has aborted by typing a key --> return `aborted'
(throw 'userkey 'aborted))
(setq key (bibtex-reference-key-in-string bounds))
(unless (assoc-string key strings t)
(push (cons key (bibtex-text-in-string bounds t))
strings))
(goto-char (bibtex-end-of-text-in-string bounds)))
;; successful operation --> return `bibtex-strings'
(setq bibtex-strings strings))))))
(defun bibtex-string-files-init ()
"Return initialization for `bibtex-strings'.
Use `bibtex-predefined-strings' and BibTeX files `bibtex-string-files'."
(save-match-data
(let ((dirlist (split-string (or bibtex-string-file-path default-directory)
":+"))
(case-fold-search)
string-files fullfilename compl bounds found)
;; collect absolute file names of valid string files
(dolist (filename bibtex-string-files)
(unless (string-match "\\.bib\\'" filename)
(setq filename (concat filename ".bib")))
;; test filenames
(if (file-name-absolute-p filename)
(if (file-readable-p filename)
(push filename string-files)
(error "BibTeX strings file %s not found" filename))
(dolist (dir dirlist)
(when (file-readable-p
(setq fullfilename (expand-file-name filename dir)))
(push fullfilename string-files)
(setq found t)))
(unless found
(error "File %s not in paths defined via bibtex-string-file-path"
filename))))
;; parse string files
(dolist (filename string-files)
(with-temp-buffer
(insert-file-contents filename)
(goto-char (point-min))
(while (setq bounds (bibtex-search-forward-string))
(push (cons (bibtex-reference-key-in-string bounds)
(bibtex-text-in-string bounds t))
compl)
(goto-char (bibtex-end-of-string bounds)))))
(append bibtex-predefined-strings (nreverse compl)))))
(defun bibtex-parse-buffers-stealthily ()
"Parse buffer in the background during idle time.
Called by `run-with-idle-timer'. Whenever Emacs has been idle
for `bibtex-parse-keys-timeout' seconds, parse all BibTeX buffers
which have been modified after last parsing.
Parsing initializes `bibtex-reference-keys' and `bibtex-strings'."
(save-excursion
(let ((buffers (buffer-list))
(strings-init (bibtex-string-files-init)))
(while (and buffers (not (input-pending-p)))
(set-buffer (car buffers))
(if (and (eq major-mode 'bibtex-mode)
(not (eq (buffer-modified-tick)
bibtex-buffer-last-parsed-tick)))
(save-restriction
(widen)
;; Output no progress messages in bibtex-parse-keys
;; because when in y-or-n-p that can hide the question.
(if (and (listp (bibtex-parse-keys t))
;; update bibtex-strings
(listp (bibtex-parse-strings strings-init t)))
;; remember that parsing was successful
(setq bibtex-buffer-last-parsed-tick (buffer-modified-tick)))))
(setq buffers (cdr buffers))))))
(defun bibtex-files-expand (&optional current force)
"Return an expanded list of BibTeX buffers based on `bibtex-files'.
Initialize in these buffers `bibtex-reference-keys' if not yet set.
List of BibTeX buffers includes current buffer if CURRENT is non-nil.
If FORCE is non-nil, (re)initialize `bibtex-reference-keys' even if
already set."
(let ((file-path (split-string (or bibtex-file-path default-directory) ":+"))
file-list dir-list buffer-list)
(dolist (file bibtex-files)
(cond ((eq file 'bibtex-file-path)
(setq dir-list (append dir-list file-path)))
((file-accessible-directory-p file)
(push file dir-list))
((progn (unless (string-match "\\.bib\\'" file)
(setq file (concat file ".bib")))
(file-name-absolute-p file))
(push file file-list))
(t
(let (fullfilename found)
(dolist (dir file-path)
(when (file-readable-p
(setq fullfilename (expand-file-name file dir)))
(push fullfilename file-list)
(setq found t)))
(unless found
(error "File %s not in paths defined via bibtex-file-path"
file))))))
(dolist (file file-list)
(unless (file-readable-p file)
(error "BibTeX file %s not found" file)))
;; expand dir-list
(dolist (dir dir-list)
(setq file-list
(append file-list (directory-files dir t "\\.bib\\'" t))))
(delete-dups file-list)
(dolist (file file-list)
(when (file-readable-p file)
(push (find-file-noselect file) buffer-list)
(with-current-buffer (car buffer-list)
(if (or force (not (listp bibtex-reference-keys)))
(bibtex-parse-keys)))))
(cond ((and current (not (memq (current-buffer) buffer-list)))
(push (current-buffer) buffer-list)
(if force (bibtex-parse-keys)))
((and (not current) (memq (current-buffer) buffer-list))
(setq buffer-list (delq (current-buffer) buffer-list))))
buffer-list))
(defun bibtex-complete-internal (completions)
"Complete word fragment before point to longest prefix of COMPLETIONS.
COMPLETIONS is an alist of strings. If point is not after the part
of a word, all strings are listed. Return completion."
(let* ((case-fold-search t)
(beg (save-excursion
(re-search-backward "[ \t{\"]")
(forward-char)
(point)))
(end (point))
(part-of-word (buffer-substring-no-properties beg end))
(completion (try-completion part-of-word completions)))
(cond ((not completion)
(error "Can't find completion for `%s'" part-of-word))
((eq completion t)
part-of-word)
((not (string= part-of-word completion))
(delete-region beg end)
(insert completion)
completion)
(t
(message "Making completion list...")
(with-output-to-temp-buffer "*Completions*"
(display-completion-list (all-completions part-of-word
completions)))
(message "Making completion list...done")
;; return value is handled by choose-completion-string-functions
nil))))
(defun bibtex-complete-string-cleanup (str compl)
"Cleanup after inserting string STR.
Remove enclosing field delimiters for STR. Display message with
expansion of STR using expansion list COMPL."
(save-excursion
(bibtex-inside-field)
(let ((bounds (bibtex-enclosing-field))
(abbr (cdr (if (stringp str)
(assoc-string str compl t)))))
(if abbr (message "Abbreviation for `%s'" abbr))
(goto-char (bibtex-start-of-text-in-field bounds))
(let ((boundaries (bibtex-parse-field-string)))
(if (and boundaries
(equal (cdr boundaries)
(bibtex-end-of-text-in-field bounds)))
(bibtex-remove-delimiters))))))
(defun bibtex-complete-crossref-cleanup (key)
"Display summary message on entry KEY after completion of a crossref key.
Use `bibtex-summary-function' to generate summary."
(save-excursion
(if (and (stringp key)
(bibtex-find-entry key t))
(message "Ref: %s" (funcall bibtex-summary-function key)))))
(defun bibtex-copy-summary-as-kill ()
"Push summery of current BibTeX entry to kill ring.
Use `bibtex-summary-function' to generate summary."
(interactive)
(let ((key (save-excursion
(bibtex-beginning-of-entry)
(if (looking-at bibtex-entry-maybe-empty-head)
(bibtex-key-in-head)
(error "No key found")))))
(kill-new (message "%s" (funcall bibtex-summary-function key)))))
(defun bibtex-summary (key)
"Return summary of BibTeX entry KEY.
Used as default value of `bibtex-summary-function'."
;; It would be neat to customize this function. How?
(save-excursion
(if (bibtex-find-entry key t)
(let* ((bibtex-autokey-name-case-convert 'identity)
(bibtex-autokey-name-length 'infty)
(bibtex-autokey-names 1)
(bibtex-autokey-names-stretch 0)
(bibtex-autokey-name-separator " ")
(bibtex-autokey-additional-names " etal")
(names (bibtex-autokey-get-names))
(bibtex-autokey-year-length 4)
(year (bibtex-autokey-get-year))
(bibtex-autokey-titlewords 5)
(bibtex-autokey-titlewords-stretch 2)
(bibtex-autokey-titleword-case-convert 'identity)
(bibtex-autokey-titleword-length 5)
(bibtex-autokey-titleword-separator " ")
(title (bibtex-autokey-get-title))
(journal (bibtex-autokey-get-field
"journal" bibtex-autokey-transcriptions))
(volume (bibtex-autokey-get-field "volume"))
(pages (bibtex-autokey-get-field "pages" '(("-.*\\'" . "")))))
(mapconcat (lambda (arg)
(if (not (string= "" (cdr arg)))
(concat (car arg) (cdr arg))))
`((" " . ,names) (" " . ,year) (": " . ,title)
(", " . ,journal) (" " . ,volume) (":" . ,pages))
""))
(error "Key `%s' not found" key))))
(defun bibtex-pop (arg direction)
"Fill current field from the ARGth same field's text in DIRECTION.
Generic function used by `bibtex-pop-previous' and `bibtex-pop-next'."
(let (bibtex-help-message)
(bibtex-find-text))
(save-excursion
;; parse current field
(bibtex-inside-field)
(let* ((case-fold-search t)
(bounds (bibtex-enclosing-field))
(start-old-text (bibtex-start-of-text-in-field bounds))
(stop-old-text (bibtex-end-of-text-in-field bounds))
(field-name (bibtex-name-in-field bounds t)))
;; if executed several times in a row, start each search where
;; the last one was finished
(unless (eq last-command 'bibtex-pop)
(bibtex-enclosing-entry-maybe-empty-head)
(setq bibtex-pop-previous-search-point (match-beginning 0)
bibtex-pop-next-search-point (point)))
(if (eq direction 'previous)
(goto-char bibtex-pop-previous-search-point)
(goto-char bibtex-pop-next-search-point))
;; Now search for arg'th previous/next similar field
(let (bounds failure new-text)
(while (and (not failure)
(> arg 0))
(cond ((eq direction 'previous)
(if (setq bounds (bibtex-search-backward-field field-name))
(goto-char (bibtex-start-of-field bounds))
(setq failure t)))
((eq direction 'next)
(if (setq bounds (bibtex-search-forward-field field-name))
(goto-char (bibtex-end-of-field bounds))
(setq failure t))))
(setq arg (- arg 1)))
(if failure
(error "No %s matching BibTeX field"
(if (eq direction 'previous) "previous" "next"))
;; Found a matching field. Remember boundaries.
(setq bibtex-pop-previous-search-point (bibtex-start-of-field bounds)
bibtex-pop-next-search-point (bibtex-end-of-field bounds)
new-text (bibtex-text-in-field-bounds bounds))
(bibtex-flash-head)
;; Go back to where we started, delete old text, and pop new.
(goto-char stop-old-text)
(delete-region start-old-text stop-old-text)
(insert new-text)))))
(let (bibtex-help-message)
(bibtex-find-text))
(setq this-command 'bibtex-pop))
(defun bibtex-beginning-of-field ()
"Move point backward to beginning of field.
This function uses a simple, fast algorithm assuming that the field
begins at the beginning of a line. We use this function for font-locking."
(let ((field-reg (concat "^[ \t]*" bibtex-field-name "[ \t]*=")))
(beginning-of-line)
(unless (looking-at field-reg)
(re-search-backward field-reg nil t))))
(defun bibtex-font-lock-url (bound)
"Font-lock for URLs. BOUND limits the search."
(let ((case-fold-search t)
(pnt (point))
field bounds start end found)
(bibtex-beginning-of-field)
(while (and (not found)
(prog1 (re-search-forward bibtex-font-lock-url-regexp bound t)
(setq field (match-string-no-properties 1)))
(setq bounds (bibtex-parse-field-text))
(progn
(setq start (car bounds) end (cdr bounds))
;; Always ignore field delimiters
(if (memq (char-before end) '(?\} ?\"))
(setq end (1- end)))
(if (memq (char-after start) '(?\{ ?\"))
(setq start (1+ start)))
(>= bound start)))
(let ((lst bibtex-generate-url-list) url)
(goto-char start)
(while (and (not found)
(setq url (car (pop lst))))
(setq found (and (bibtex-string= field (car url))
(re-search-forward (cdr url) end t)
(>= (match-beginning 0) pnt)))))
(goto-char end))
(if found (bibtex-button (match-beginning 0) (match-end 0)
'bibtex-url (match-beginning 0)))
found))
(defun bibtex-font-lock-crossref (bound)
"Font-lock for crossref fields. BOUND limits the search."
(let ((case-fold-search t)
(pnt (point))
(crossref-reg (concat "^[ \t]*crossref[ \t]*=[ \t\n]*"
"\\(\"[^\"]*\"\\|{[^}]*}\\)[ \t\n]*[,})]"))
start end found)
(bibtex-beginning-of-field)
(while (and (not found)
(re-search-forward crossref-reg bound t))
(setq start (1+ (match-beginning 1))
end (1- (match-end 1))
found (>= start pnt)))
(if found (bibtex-button start end 'bibtex-find-crossref
(buffer-substring-no-properties start end)
start t))
found))
(defun bibtex-button-action (button)
"Call BUTTON's BibTeX function."
(apply (button-get button 'bibtex-function)
(button-get button 'bibtex-args)))
(define-button-type 'bibtex-url
'action 'bibtex-button-action
'bibtex-function 'bibtex-url
'help-echo (purecopy "mouse-2, RET: follow URL"))
(define-button-type 'bibtex-find-crossref
'action 'bibtex-button-action
'bibtex-function 'bibtex-find-crossref
'help-echo (purecopy "mouse-2, RET: follow crossref"))
(defun bibtex-button (beg end type &rest args)
"Make a BibTeX button from BEG to END of type TYPE in the current buffer."
(make-text-button beg end 'type type 'bibtex-args args))
;; Interactive Functions:
;;;###autoload
(defun bibtex-mode ()
"Major mode for editing BibTeX files.
General information on working with BibTeX mode:
Use commands such as \\[bibtex-Book] to get a template for a specific entry.
Then fill in all desired fields using \\[bibtex-next-field] to jump from field
to field. After having filled in all desired fields in the entry, clean the
new entry with the command \\[bibtex-clean-entry].
Some features of BibTeX mode are available only by setting the variable
`bibtex-maintain-sorted-entries' to non-nil. However, then BibTeX mode
works only with buffers containing valid (syntactical correct) and sorted
entries. This is usually the case, if you have created a buffer completely
with BibTeX mode and finished every new entry with \\[bibtex-clean-entry].
For third party BibTeX files, call the function `bibtex-convert-alien'
to fully take advantage of all features of BibTeX mode.
Special information:
A command such as \\[bibtex-Book] outlines the fields for a BibTeX book entry.
The names of optional fields start with the string OPT, and are thus ignored
by BibTeX. The names of alternative fields from which only one is required
start with the string ALT. The OPT or ALT string may be removed from
the name of a field with \\[bibtex-remove-OPT-or-ALT].
\\[bibtex-make-field] inserts a new field after the current one.
\\[bibtex-kill-field] kills the current field entirely.
\\[bibtex-yank] yanks the last recently killed field after the current field.
\\[bibtex-remove-delimiters] removes the double-quotes or braces around the text of the current field.
\\[bibtex-empty-field] replaces the text of the current field with the default \"\" or {}.
\\[bibtex-find-text] moves point to the end of the current field.
\\[bibtex-complete] completes word fragment before point according to context.
The command \\[bibtex-clean-entry] cleans the current entry, i.e. it removes OPT/ALT
from the names of all non-empty optional or alternative fields, checks that
no required fields are empty, and does some formatting dependent on the value
of `bibtex-entry-format'. Furthermore, it can automatically generate a key
for the BibTeX entry, see `bibtex-generate-autokey'.
Note: some functions in BibTeX mode depend on entries being in a special
format (all fields beginning on separate lines), so it is usually a bad
idea to remove `realign' from `bibtex-entry-format'.
BibTeX mode supports Imenu and hideshow minor mode (`hs-minor-mode').
----------------------------------------------------------
Entry to BibTeX mode calls the value of `bibtex-mode-hook'
if that value is non-nil.
\\{bibtex-mode-map}"
(interactive)
(kill-all-local-variables)
(use-local-map bibtex-mode-map)
(setq major-mode 'bibtex-mode)
(setq mode-name "BibTeX")
(set-syntax-table bibtex-mode-syntax-table)
(make-local-variable 'bibtex-buffer-last-parsed-tick)
;; Install stealthy parse function if not already installed
(unless bibtex-parse-idle-timer
(setq bibtex-parse-idle-timer (run-with-idle-timer
bibtex-parse-keys-timeout t
'bibtex-parse-buffers-stealthily)))
(set (make-local-variable 'paragraph-start) "[ \f\n\t]*$")
(set (make-local-variable 'comment-start) bibtex-comment-start)
(set (make-local-variable 'comment-start-skip)
(concat (regexp-quote bibtex-comment-start) "\\>[ \t]*"))
(set (make-local-variable 'comment-column) 0)
(set (make-local-variable 'defun-prompt-regexp) "^[ \t]*@[[:alnum:]]+[ \t]*")
(set (make-local-variable 'outline-regexp) "[ \t]*@")
(set (make-local-variable 'fill-paragraph-function) 'bibtex-fill-field)
(set (make-local-variable 'fill-prefix) (make-string (+ bibtex-entry-offset
bibtex-contline-indentation)
? ))
(set (make-local-variable 'font-lock-defaults)
'(bibtex-font-lock-keywords
nil t ((?$ . "\"")
;; Mathematical expressions should be fontified as strings
(?\" . ".")
;; Quotes are field delimiters and quote-delimited
;; entries should be fontified in the same way as
;; brace-delimited ones
)
nil
(font-lock-syntactic-keywords . bibtex-font-lock-syntactic-keywords)
(font-lock-extra-managed-props . (category))
(font-lock-mark-block-function
. (lambda ()
(set-mark (bibtex-end-of-entry))
(bibtex-beginning-of-entry)))))
(setq imenu-generic-expression
(list (list nil bibtex-entry-head bibtex-key-in-head))
imenu-case-fold-search t)
(make-local-variable 'choose-completion-string-functions)
;; XEmacs needs easy-menu-add, Emacs does not care
(easy-menu-add bibtex-edit-menu)
(easy-menu-add bibtex-entry-menu)
(run-mode-hooks 'bibtex-mode-hook))
(defun bibtex-field-list (entry-type)
"Return list of allowed fields for entry ENTRY-TYPE.
More specifically, the return value is a cons pair (REQUIRED . OPTIONAL),
where REQUIRED and OPTIONAL are lists of the required and optional field
names for ENTRY-TYPE according to `bibtex-entry-field-alist',
`bibtex-include-OPTkey', `bibtex-include-OPTcrossref',
and `bibtex-user-optional-fields'."
(let ((e (assoc-string entry-type bibtex-entry-field-alist t))
required optional)
(unless e
(error "BibTeX entry type %s not defined" entry-type))
(if (and (member-ignore-case entry-type bibtex-include-OPTcrossref)
(nth 2 e))
(setq required (nth 0 (nth 2 e))
optional (nth 1 (nth 2 e)))
(setq required (nth 0 (nth 1 e))
optional (nth 1 (nth 1 e))))
(if bibtex-include-OPTkey
(push (list "key"
"Used for reference key creation if author and editor fields are missing"
(if (or (stringp bibtex-include-OPTkey)
(fboundp bibtex-include-OPTkey))
bibtex-include-OPTkey))
optional))
(if (member-ignore-case entry-type bibtex-include-OPTcrossref)
(push '("crossref" "Reference key of the cross-referenced entry")
optional))
(setq optional (append optional bibtex-user-optional-fields))
(cons required optional)))
(defun bibtex-entry (entry-type)
"Insert a new BibTeX entry of type ENTRY-TYPE.
After insertion call the value of `bibtex-add-entry-hook' if that value
is non-nil."
(interactive
(let ((completion-ignore-case t))
(list (completing-read "Entry Type: " bibtex-entry-field-alist
nil t nil 'bibtex-entry-type-history))))
(let ((key (if bibtex-maintain-sorted-entries
(bibtex-read-key (format "%s key: " entry-type))))
(field-list (bibtex-field-list entry-type)))
(unless (bibtex-prepare-new-entry (list key nil entry-type))
(error "Entry with key `%s' already exists" key))
(indent-to-column bibtex-entry-offset)
(insert "@" entry-type (bibtex-entry-left-delimiter))
(if key (insert key))
(save-excursion
(mapc 'bibtex-make-field (car field-list))
(mapc 'bibtex-make-optional-field (cdr field-list))
(if bibtex-comma-after-last-field
(insert ","))
(insert "\n")
(indent-to-column bibtex-entry-offset)
(insert (bibtex-entry-right-delimiter) "\n\n"))
(bibtex-next-field t)
(if (member-ignore-case entry-type bibtex-autofill-types)
(bibtex-autofill-entry))
(run-hooks 'bibtex-add-entry-hook)))
(defun bibtex-entry-update ()
"Update an existing BibTeX entry.
In the BibTeX entry at point, make new fields for those items that may occur
according to `bibtex-field-list', but are not yet present."
(interactive)
(save-excursion
(bibtex-beginning-of-entry)
;; For inserting new fields, we use the fact that
;; bibtex-parse-entry moves point to the end of the last field.
(let* ((fields-alist (bibtex-parse-entry))
(field-list (bibtex-field-list
(cdr (assoc "=type=" fields-alist)))))
(dolist (field (car field-list))
(unless (assoc-string (car field) fields-alist t)
(bibtex-make-field field)))
(dolist (field (cdr field-list))
(unless (assoc-string (car field) fields-alist t)
(bibtex-make-optional-field field))))))
(defun bibtex-parse-entry ()
"Parse entry at point, return an alist.
The alist elements have the form (FIELD . TEXT), where FIELD can also be
the special strings \"=type=\" and \"=key=\". For the FIELD \"=key=\"
TEXT may be nil. Remove \"OPT\" and \"ALT\" from FIELD.
Move point to the end of the last field."
(let (alist bounds)
(when (looking-at bibtex-entry-maybe-empty-head)
(push (cons "=type=" (bibtex-type-in-head)) alist)
(push (cons "=key=" (bibtex-key-in-head)) alist)
(goto-char (match-end 0))
(while (setq bounds (bibtex-parse-field bibtex-field-name))
(push (cons (bibtex-name-in-field bounds t)
(bibtex-text-in-field-bounds bounds))
alist)
(goto-char (bibtex-end-of-field bounds))))
alist))
(defun bibtex-autofill-entry ()
"Try to fill fields of current BibTeX entry based on neighboring entries.
The current entry must have a key. Determine the neighboring entry
\(previouse or next\) whose key is more similar to the key of the current
entry. For all empty fields of the current entry insert the corresponding
field contents of the neighboring entry. Finally try to update the text
based on the difference between the keys of the neighboring and the current
entry (for example, the year parts of the keys)."
(interactive)
(undo-boundary) ;So you can easily undo it, if it didn't work right.
(bibtex-beginning-of-entry)
(when (looking-at bibtex-entry-head)
(let ((type (bibtex-type-in-head))
(key (bibtex-key-in-head))
(key-end (match-end bibtex-key-in-head))
(case-fold-search t)
tmp other-key other bounds)
;; The fields we want to change start right after the key.
(goto-char key-end)
;; First see whether to use the previous or the next entry
;; for "inspiration".
(save-excursion
(goto-char (1- (match-beginning 0)))
(bibtex-beginning-of-entry)
(if (and (looking-at bibtex-entry-head)
(bibtex-string= type (bibtex-type-in-head))
;; In case we found ourselves :-(
(not (equal key (setq tmp (bibtex-key-in-head)))))
(setq other-key tmp
other (point))))
(save-excursion
(bibtex-end-of-entry)
(bibtex-skip-to-valid-entry)
(if (and (looking-at bibtex-entry-head)
(bibtex-string= type (bibtex-type-in-head))
;; In case we found ourselves :-(
(not (equal key (setq tmp (bibtex-key-in-head))))
(or (not other-key)
;; Check which is the best match.
(< (length (try-completion "" (list key other-key)))
(length (try-completion "" (list key tmp))))))
(setq other-key tmp
other (point))))
;; Then fill the new entry's fields with the chosen other entry.
(when other
(setq other (save-excursion (goto-char other) (bibtex-parse-entry)))
(setq key-end (point)) ;In case parse-entry changed the buffer.
(while (setq bounds (bibtex-parse-field bibtex-field-name))
(let ((text (assoc-string (bibtex-name-in-field bounds t)
other t)))
(if (not (and text
(string-match bibtex-empty-field-re
(buffer-substring-no-properties
(bibtex-start-of-text-in-field bounds)
(bibtex-end-of-text-in-field bounds)))))
(goto-char (bibtex-end-of-field bounds))
(goto-char (bibtex-start-of-text-in-field bounds))
(delete-region (point) (bibtex-end-of-text-in-field bounds))
(insert (cdr text)))))
;; Finally try to update the text based on the difference between
;; the two keys.
(let* ((prefix (try-completion "" (list key other-key)))
;; If the keys are foo91 and foo92, don't replace 1 for 2
;; but 91 for 92 instead.
(_ (if (string-match "[0-9]+\\'" prefix)
(setq prefix (substring prefix 0 (match-beginning 0)))))
(suffix (substring key (length prefix)))
(other-suffix (substring other-key (length prefix))))
(while (re-search-backward (regexp-quote other-suffix) key-end 'move)
(replace-match suffix)))))))
(defun bibtex-print-help-message ()
"Print helpful information about current field in current BibTeX entry."
(interactive)
(save-excursion
(let* ((case-fold-search t)
(field-name (bibtex-name-in-field (bibtex-enclosing-field) t))
(field-list (bibtex-field-list (progn (re-search-backward
bibtex-entry-maybe-empty-head nil t)
(bibtex-type-in-head))))
(comment (assoc-string field-name
(append (car field-list)
(cdr field-list))
t)))
(if comment
(message (nth 1 comment))
(message "No comment available")))))
(defun bibtex-make-field (field &optional move interactive)
"Make a field named FIELD in current BibTeX entry.
FIELD is either a string or a list of the form
\(FIELD-NAME COMMENT-STRING INIT ALTERNATIVE-FLAG) as in
`bibtex-entry-field-alist'.
If MOVE is non-nil, move point past the present field before making
the new field. If INTERACTIVE is non-nil, move point to the end of
the new field. Otherwise move point past the new field.
MOVE and INTERACTIVE are t when called interactively."
(interactive
(list (let ((completion-ignore-case t)
(field-list (bibtex-field-list
(save-excursion
(bibtex-enclosing-entry-maybe-empty-head)
(bibtex-type-in-head)))))
(completing-read "BibTeX field name: "
(append (car field-list) (cdr field-list))
nil nil nil bibtex-field-history))
t t))
(unless (consp field)
(setq field (list field)))
(if move
(let (bibtex-help-message)
(bibtex-find-text)
(if (looking-at "[}\"]")
(forward-char))))
(insert ",\n")
(indent-to-column (+ bibtex-entry-offset bibtex-field-indentation))
(if (nth 3 field) (insert "ALT"))
(insert (car field) " ")
(if bibtex-align-at-equal-sign
(indent-to-column (+ bibtex-entry-offset
(- bibtex-text-indentation 2))))
(insert "= ")
(unless bibtex-align-at-equal-sign
(indent-to-column (+ bibtex-entry-offset
bibtex-text-indentation)))
(let ((init (nth 2 field)))
(insert (cond ((stringp init) init)
((fboundp init) (funcall init))
(t (concat (bibtex-field-left-delimiter)
(bibtex-field-right-delimiter))))))
(when interactive
(forward-char -1)
(bibtex-print-help-message)))
(defun bibtex-beginning-of-entry ()
"Move to beginning of BibTeX entry (beginning of line).
If inside an entry, move to the beginning of it, otherwise move to the
beginning of the previous entry. If point is ahead of all BibTeX entries
move point to the beginning of buffer. Return the new location of point."
(interactive)
(skip-chars-forward " \t")
(if (looking-at "@")
(forward-char))
(re-search-backward "^[ \t]*@" nil 'move)
(point))
(defun bibtex-end-of-entry ()
"Move to end of BibTeX entry (past the closing brace).
If inside an entry, move to the end of it, otherwise move to the end
of the previous entry. Do not move if ahead of first entry.
Return the new location of point."
(interactive)
(let ((case-fold-search t)
(org (point))
(pnt (bibtex-beginning-of-entry))
err bounds)
(cond ((looking-at bibtex-valid-entry-whitespace-re)
(bibtex-search-entry t nil t)
(unless (equal (match-beginning 0) pnt)
(setq err t)))
((setq bounds (bibtex-parse-string))
(goto-char (bibtex-end-of-string bounds)))
((looking-at "[ \t]*@[ \t]*preamble[ \t\n]*")
(goto-char (match-end 0))
(if (looking-at "[({]")
(forward-sexp 1)
(setq err t)))
(t
(if (interactive-p)
(message "Not on a known BibTeX entry."))
(goto-char org)))
(when err
(goto-char pnt)
(error "Syntactically incorrect BibTeX entry starts here")))
(point))
(defun bibtex-goto-line (arg)
"Goto line ARG, counting from beginning of (narrowed) buffer."
;; code adapted from `goto-line'
(goto-char (point-min))
(if (eq selective-display t)
(re-search-forward "[\n\C-m]" nil 'end (1- arg))
(forward-line (1- arg))))
(defun bibtex-reposition-window ()
"Make the current BibTeX entry visible.
If entry is smaller than `window-body-height', entry is centered in window.
Otherwise display the beginning of entry."
(interactive)
(let ((pnt (point))
(beg (line-number-at-pos (bibtex-beginning-of-entry)))
(end (line-number-at-pos (bibtex-end-of-entry))))
(if (> (window-body-height) (- end beg))
;; entry fits in current window
(progn
(bibtex-goto-line (/ (+ 1 beg end) 2))
(recenter)
(goto-char pnt))
;; entry too large for current window
(bibtex-goto-line beg)
(recenter 0)
(if (> (1+ (- (line-number-at-pos pnt) beg))
(window-body-height))
(bibtex-goto-line beg)
(goto-char pnt)))))
(defun bibtex-mark-entry ()
"Put mark at beginning, point at end of current BibTeX entry."
(interactive)
(set-mark (bibtex-beginning-of-entry))
(bibtex-end-of-entry))
(defun bibtex-count-entries (&optional count-string-entries)
"Count number of entries in current buffer or region.
With prefix argument COUNT-STRING-ENTRIES count all entries,
otherwise count all entries except @String entries.
If mark is active count entries in region, if not in whole buffer."
(interactive "P")
(let ((number 0)
(bibtex-sort-ignore-string-entries
(not count-string-entries)))
(save-excursion
(save-restriction
(narrow-to-region (if mark-active (region-beginning)
(bibtex-beginning-of-first-entry))
(if mark-active (region-end) (point-max)))
(bibtex-map-entries (lambda (key beg end)
(setq number (1+ number))))))
(message "%s contains %d entries."
(if mark-active "Region" "Buffer")
number)))
(defun bibtex-ispell-entry ()
"Check BibTeX entry for spelling errors."
(interactive)
(ispell-region (save-excursion (bibtex-beginning-of-entry))
(save-excursion (bibtex-end-of-entry))))
(defun bibtex-ispell-abstract ()
"Check abstract of BibTeX entry for spelling errors."
(interactive)
(let ((bounds (save-excursion
(bibtex-beginning-of-entry)
(bibtex-search-forward-field "abstract" t))))
(if bounds
(ispell-region (bibtex-start-of-text-in-field bounds)
(bibtex-end-of-text-in-field bounds))
(error "No abstract in entry"))))
(defun bibtex-narrow-to-entry ()
"Narrow buffer to current BibTeX entry."
(interactive)
(save-excursion
(widen)
(narrow-to-region (bibtex-beginning-of-entry)
(bibtex-end-of-entry))))
(defun bibtex-entry-index ()
"Return index of BibTeX entry head at or past position of point.
The index is a list (KEY CROSSREF-KEY ENTRY-NAME) that is used for sorting
the entries of the BibTeX buffer. CROSSREF-KEY is nil unless the value
of `bibtex-maintain-sorted-entries' is `crossref'. Move point to the end
of the head of the entry found. Return nil if no entry found."
(let ((case-fold-search t))
(if (re-search-forward bibtex-entry-maybe-empty-head nil t)
(let ((key (bibtex-key-in-head))
;; all entry names should be downcase (for ease of comparison)
(entry-name (downcase (bibtex-type-in-head))))
;; Don't search CROSSREF-KEY if we don't need it.
(if (eq bibtex-maintain-sorted-entries 'crossref)
(let ((bounds (bibtex-search-forward-field
"\\(OPT\\)?crossref" t)))
(list key
(if bounds (bibtex-text-in-field-bounds bounds t))
entry-name))
(list key nil entry-name))))))
(defun bibtex-lessp (index1 index2)
"Predicate for sorting BibTeX entries with indices INDEX1 and INDEX2.
Each index is a list (KEY CROSSREF-KEY ENTRY-NAME).
The predicate depends on the variable `bibtex-maintain-sorted-entries'.
If its value is nil use plain sorting."
(cond ((not index1) (not index2)) ; indices can be nil
((not index2) nil)
((eq bibtex-maintain-sorted-entries 'crossref)
(if (nth 1 index1)
(if (nth 1 index2)
(or (string-lessp (nth 1 index1) (nth 1 index2))
(and (string-equal (nth 1 index1) (nth 1 index2))
(string-lessp (nth 0 index1) (nth 0 index2))))
(not (string-lessp (nth 0 index2) (nth 1 index1))))
(if (nth 1 index2)
(string-lessp (nth 0 index1) (nth 1 index2))
(string-lessp (nth 0 index1) (nth 0 index2)))))
((eq bibtex-maintain-sorted-entries 'entry-class)
(let ((n1 (cdr (or (assoc (nth 2 index1) bibtex-sort-entry-class-alist)
(assoc 'catch-all bibtex-sort-entry-class-alist)
'(nil . 1000)))) ; if there is nothing else
(n2 (cdr (or (assoc (nth 2 index2) bibtex-sort-entry-class-alist)
(assoc 'catch-all bibtex-sort-entry-class-alist)
'(nil . 1000))))) ; if there is nothing else
(or (< n1 n2)
(and (= n1 n2)
(string-lessp (car index1) (car index2))))))
(t ; (eq bibtex-maintain-sorted-entries 'plain)
(string-lessp (car index1) (car index2)))))
(defun bibtex-sort-buffer ()
"Sort BibTeX buffer alphabetically by key.
The predicate for sorting is defined via `bibtex-maintain-sorted-entries'.
If its value is nil use plain sorting. Text outside of BibTeX entries is not
affected. If `bibtex-sort-ignore-string-entries' is non-nil, @String entries
are ignored."
(interactive)
(save-restriction
(narrow-to-region (bibtex-beginning-of-first-entry)
(save-excursion (goto-char (point-max))
(bibtex-end-of-entry)))
(bibtex-skip-to-valid-entry)
(sort-subr nil
'bibtex-skip-to-valid-entry ; NEXTREC function
'bibtex-end-of-entry ; ENDREC function
'bibtex-entry-index ; STARTKEY function
nil ; ENDKEY function
'bibtex-lessp))) ; PREDICATE
(defun bibtex-find-crossref (crossref-key &optional pnt split)
"Move point to the beginning of BibTeX entry CROSSREF-KEY.
If `bibtex-files' is non-nil, search all these files.
Otherwise the search is limited to the current buffer.
Return position of entry if CROSSREF-KEY is found or nil otherwise.
If CROSSREF-KEY is in the same buffer like current entry but before it
an error is signaled. Optional arg PNT is the position of the referencing
entry. It defaults to position of point. If optional arg SPLIT is non-nil,
split window so that both the referencing and the crossrefed entry are
displayed.
If called interactively, CROSSREF-KEY defaults to crossref key of current
entry and SPLIT is t."
(interactive
(let ((crossref-key
(save-excursion
(bibtex-beginning-of-entry)
(let ((bounds (bibtex-search-forward-field "crossref" t)))
(if bounds
(bibtex-text-in-field-bounds bounds t))))))
(list (bibtex-read-key "Find crossref key: " crossref-key t)
(point) t)))
(let (buffer pos eqb)
(save-excursion
(setq pos (bibtex-find-entry crossref-key t)
buffer (current-buffer)))
(setq eqb (eq buffer (current-buffer)))
(cond ((not pos)
(if split (message "Crossref key `%s' not found" crossref-key)))
(split ; called (quasi) interactively
(unless pnt (setq pnt (point)))
(goto-char pnt)
(if eqb (select-window (split-window))
(pop-to-buffer buffer))
(goto-char pos)
(bibtex-reposition-window)
(beginning-of-line)
(if (and eqb (> pnt pos))
(error "The referencing entry must precede the crossrefed entry!")))
;; `bibtex-find-crossref' is called noninteractively during
;; clean-up of an entry. Then it is not possible to check
;; whether the current entry and the crossrefed entry have
;; the correct sorting order.
(eqb (goto-char pos))
(t (set-buffer buffer) (goto-char pos)))
pos))
(defun bibtex-find-entry (key &optional global start display)
"Move point to the beginning of BibTeX entry named KEY.
Return position of entry if KEY is found or nil if not found.
With prefix arg GLOBAL non-nil, search KEY in `bibtex-files'.
Otherwise the search is limited to the current buffer.
Optional arg START is buffer position where the search starts.
If it is nil, start search at beginning of buffer.
If DISPLAY is non-nil, display the buffer containing KEY.
Otherwise, use `set-buffer'. DISPLAY is t when called interactively."
(interactive (list (bibtex-read-key "Find key: " nil current-prefix-arg)
current-prefix-arg nil t))
(if (and global bibtex-files)
(let ((buffer-list (bibtex-files-expand t))
buffer found)
(while (and (not found)
(setq buffer (pop buffer-list)))
(with-current-buffer buffer
(if (cdr (assoc-string key bibtex-reference-keys))
;; `bibtex-find-entry' moves point if key found
(setq found (bibtex-find-entry key)))))
(cond ((and found display)
(let ((same-window-buffer-names
(cons (buffer-name buffer) same-window-buffer-names)))
(pop-to-buffer buffer)
(bibtex-reposition-window)))
(found (set-buffer buffer))
(display (message "Key `%s' not found" key)))
found)
(let* (case-fold-search
(pnt (save-excursion
(goto-char (or start (point-min)))
(if (re-search-forward (concat "^[ \t]*\\("
bibtex-entry-type
"\\)[ \t]*[({][ \t\n]*\\("
(regexp-quote key)
"\\)[ \t\n]*[,=]")
nil t)
(match-beginning 0)))))
(cond (pnt
(goto-char pnt)
(if display (bibtex-reposition-window)))
(display (message "Key `%s' not found" key)))
pnt)))
(defun bibtex-prepare-new-entry (index)
"Prepare a new BibTeX entry with index INDEX.
INDEX is a list (KEY CROSSREF-KEY ENTRY-NAME).
Move point where the entry KEY should be placed.
If `bibtex-maintain-sorted-entries' is non-nil, perform a binary
search to look for place for KEY. This requires that buffer is sorted,
see \\[bibtex-validate].)
Return t if preparation was successful or nil if entry KEY already exists."
(let ((key (nth 0 index))
key-exist)
(cond ((or (null key)
(and (stringp key)
(string-equal key ""))
(and (not (setq key-exist (bibtex-find-entry key)))
(not bibtex-maintain-sorted-entries)))
(bibtex-move-outside-of-entry))
;; if key-exist is non-nil due to the previous cond clause
;; then point will be at beginning of entry named key.
(key-exist)
(t ; bibtex-maintain-sorted-entries is non-nil
(let* ((case-fold-search t)
(left (save-excursion (bibtex-beginning-of-first-entry)
(bibtex-skip-to-valid-entry)
(point)))
(right (save-excursion (bibtex-beginning-of-last-entry)
(bibtex-end-of-entry)))
(found (if (>= left right) left))
actual-index new)
(save-excursion
;; Binary search
(while (not found)
(goto-char (/ (+ left right) 2))
(bibtex-skip-to-valid-entry t)
(setq actual-index (bibtex-entry-index))
(cond ((bibtex-lessp index actual-index)
(setq new (bibtex-beginning-of-entry))
(if (equal right new)
(setq found right)
(setq right new)))
(t
(bibtex-end-of-entry)
(bibtex-skip-to-valid-entry)
(setq new (point))
(if (equal left new)
(setq found right)
(setq left new))))))
(goto-char found)
(bibtex-beginning-of-entry)
(setq actual-index (save-excursion (bibtex-entry-index)))
(when (or (not actual-index)
(bibtex-lessp actual-index index))
;; buffer contains no valid entries or
;; greater than last entry --> append
(bibtex-end-of-entry)
(unless (bobp) (newline (forward-line 2)))
(beginning-of-line)))))
(unless key-exist t)))
(defun bibtex-validate (&optional test-thoroughly)
"Validate if buffer or region is syntactically correct.
Check also for duplicate keys and correct sort order provided
`bibtex-maintain-sorted-entries' is non-nil.
With optional argument TEST-THOROUGHLY non-nil check also for
the absence of required fields and for questionable month fields.
If mark is active, validate current region, if not the whole buffer.
Only check known entry types, so you can put comments outside of entries.
Return t if test was successful, nil otherwise."
(interactive "P")
(let* ((case-fold-search t)
error-list syntax-error)
(save-excursion
(save-restriction
(narrow-to-region (if mark-active (region-beginning)
(bibtex-beginning-of-first-entry))
(if mark-active (region-end) (point-max)))
;; looking if entries fit syntactical structure
(goto-char (point-min))
(bibtex-progress-message "Checking syntactical structure")
(let (bibtex-sort-ignore-string-entries)
(while (re-search-forward "^[ \t]*@" nil t)
(bibtex-progress-message)
(forward-char -1)
(let ((pnt (point)))
(if (not (looking-at bibtex-any-valid-entry-re))
(forward-char)
(bibtex-skip-to-valid-entry)
(if (equal (point) pnt)
(forward-char)
(goto-char pnt)
(push (cons (bibtex-current-line)
"Syntax error (check esp. commas, braces, and quotes)")
error-list)
(forward-char))))))
(bibtex-progress-message 'done)
(if error-list
;; proceed only if there were no syntax errors.
(setq syntax-error t)
;; looking for duplicate keys and correct sort order
(let (previous current key-list)
(bibtex-progress-message "Checking for duplicate keys")
(bibtex-map-entries
(lambda (key beg end)
(bibtex-progress-message)
(goto-char beg)
(setq current (bibtex-entry-index))
(cond ((not previous))
((member key key-list)
(push (cons (bibtex-current-line)
(format "Duplicate key `%s'" key))
error-list))
((and bibtex-maintain-sorted-entries
(not (bibtex-lessp previous current)))
(push (cons (bibtex-current-line)
"Entries out of order")
error-list)))
(push key key-list)
(setq previous current)))
(bibtex-progress-message 'done))
;; Check for duplicate keys in `bibtex-files'.
(bibtex-parse-keys)
;; We don't want to be fooled by outdated `bibtex-reference-keys'.
(dolist (buffer (bibtex-files-expand nil t))
(dolist (key (with-current-buffer buffer bibtex-reference-keys))
(when (and (cdr key)
(cdr (assoc-string (car key) bibtex-reference-keys)))
(bibtex-find-entry (car key))
(push (cons (bibtex-current-line)
(format "Duplicate key `%s' in %s" (car key)
(abbreviate-file-name (buffer-file-name buffer))))
error-list))))
(when test-thoroughly
(bibtex-progress-message
"Checking required fields and month fields")
(let ((bibtex-sort-ignore-string-entries t))
(bibtex-map-entries
(lambda (key beg end)
(bibtex-progress-message)
(let* ((entry-list (progn
(goto-char beg)
(bibtex-search-entry nil end)
(assoc-string (bibtex-type-in-head)
bibtex-entry-field-alist t)))
(req (copy-sequence (elt (elt entry-list 1) 0)))
(creq (copy-sequence (elt (elt entry-list 2) 0)))
crossref-there bounds alt-there field)
(goto-char beg)
(while (setq bounds (bibtex-search-forward-field
bibtex-field-name end))
(goto-char (bibtex-start-of-text-in-field bounds))
(let ((field-name (bibtex-name-in-field bounds)))
(if (and (bibtex-string= field-name "month")
;; Check only abbreviated month fields.
(let ((month (bibtex-text-in-field-bounds bounds)))
(not (or (string-match "\\`[\"{].+[\"}]\\'" month)
(assoc-string
month
bibtex-predefined-month-strings t)))))
(push (cons (bibtex-current-line)
"Questionable month field")
error-list))
(setq field (assoc-string field-name req t))
(if (nth 3 field)
(if alt-there (push (cons (bibtex-current-line)
"More than one non-empty alternative")
error-list)
(setq alt-there t)))
(setq req (delete field req)
creq (delete (assoc-string field-name creq t) creq))
(if (bibtex-string= field-name "crossref")
(setq crossref-there t))))
(if crossref-there
(setq req creq))
(let (alt)
(dolist (field req)
(if (nth 3 field)
(push (car field) alt)
(push (cons (save-excursion (goto-char beg)
(bibtex-current-line))
(format "Required field `%s' missing"
(car field)))
error-list)))
;; The following fails if there are more than two
;; alternatives in a BibTeX entry, which isn't
;; the case momentarily.
(if (cdr alt)
(push (cons (save-excursion (goto-char beg)
(bibtex-current-line))
(format "Alternative fields `%s'/`%s' missing"
(car alt) (cadr alt)))
error-list)))))))
(bibtex-progress-message 'done)))))
(if error-list
(let ((file (file-name-nondirectory (buffer-file-name)))
(dir default-directory)
(err-buf "*BibTeX validation errors*"))
(setq error-list (sort error-list 'car-less-than-car))
(with-current-buffer (get-buffer-create err-buf)
(setq default-directory dir)
(unless (eq major-mode 'compilation-mode) (compilation-mode))
(toggle-read-only -1)
(delete-region (point-min) (point-max))
(insert "BibTeX mode command `bibtex-validate'\n"
(if syntax-error
"Maybe undetected errors due to syntax errors. Correct and validate again.\n"
"\n"))
(dolist (err error-list)
(insert (format "%s:%d: %s\n" file (car err) (cdr err))))
(set-buffer-modified-p nil)
(toggle-read-only 1)
(goto-line 3)) ; first error message
(display-buffer err-buf)
;; return nil
nil)
(message "%s is syntactically correct"
(if mark-active "Region" "Buffer"))
t)))
(defun bibtex-validate-globally (&optional strings)
"Check for duplicate keys in `bibtex-files'.
With optional prefix arg STRINGS, check for duplicate strings, too.
Return t if test was successful, nil otherwise."
(interactive "P")
(let ((buffer-list (bibtex-files-expand t))
buffer-key-list current-buf current-keys error-list)
;; Check for duplicate keys within BibTeX buffer
(dolist (buffer buffer-list)
(save-excursion
(set-buffer buffer)
(let (entry-type key key-list)
(goto-char (point-min))
(while (re-search-forward bibtex-entry-head nil t)
(setq entry-type (bibtex-type-in-head)
key (bibtex-key-in-head))
(if (or (and strings (bibtex-string= entry-type "string"))
(assoc-string entry-type bibtex-entry-field-alist t))
(if (member key key-list)
(push (format "%s:%d: Duplicate key `%s'\n"
(buffer-file-name)
(bibtex-current-line) key)
error-list)
(push key key-list))))
(push (cons buffer key-list) buffer-key-list))))
;; Check for duplicate keys among BibTeX buffers
(while (setq current-buf (pop buffer-list))
(setq current-keys (cdr (assq current-buf buffer-key-list)))
(with-current-buffer current-buf
(dolist (buffer buffer-list)
(dolist (key (cdr (assq buffer buffer-key-list)))
(when (assoc-string key current-keys)
(bibtex-find-entry key)
(push (format "%s:%d: Duplicat key `%s' in %s\n"
(buffer-file-name) (bibtex-current-line) key
(abbreviate-file-name (buffer-file-name buffer)))
error-list))))))
;; Process error list
(if error-list
(let ((err-buf "*BibTeX validation errors*"))
(with-current-buffer (get-buffer-create err-buf)
(unless (eq major-mode 'compilation-mode) (compilation-mode))
(toggle-read-only -1)
(delete-region (point-min) (point-max))
(insert "BibTeX mode command `bibtex-validate-globally'\n\n")
(dolist (err (sort error-list 'string-lessp)) (insert err))
(set-buffer-modified-p nil)
(toggle-read-only 1)
(goto-line 3)) ; first error message
(display-buffer err-buf)
;; return nil
nil)
(message "No duplicate keys.")
t)))
(defun bibtex-next-field (begin)
"Move point to end of text of next BibTeX field.
With prefix BEGIN non-nil, move point to its beginning."
(interactive "P")
(bibtex-inside-field)
(let ((start (point)))
(condition-case ()
(let ((bounds (bibtex-enclosing-field)))
(goto-char (bibtex-end-of-field bounds))
(forward-char 2))
(error
(goto-char start)
(end-of-line)
(forward-char))))
(bibtex-find-text begin))
(defun bibtex-find-text (&optional begin noerror)
"Move point to end of text of current BibTeX field.
With optional prefix BEGIN non-nil, move point to its beginning.
Unless NOERROR is non-nil, an error is signaled if point is not
on a BibTeX field."
(interactive "P")
(let* ((pnt (point))
(_ (bibtex-inside-field))
(bounds (bibtex-enclosing-field t)))
(beginning-of-line)
(cond (bounds
(if begin
(progn (goto-char (bibtex-start-of-text-in-field bounds))
(if (looking-at "[{\"]")
(forward-char)))
(goto-char (bibtex-end-of-text-in-field bounds))
(if (or (= (preceding-char) ?})
(= (preceding-char) ?\"))
(forward-char -1)))
(if bibtex-help-message
(bibtex-print-help-message)))
((setq bounds (bibtex-parse-string))
(goto-char (if begin
(1+ (bibtex-start-of-text-in-string bounds))
(1- (bibtex-end-of-text-in-string bounds)))))
((looking-at bibtex-entry-maybe-empty-head)
(goto-char (if begin
(match-beginning bibtex-key-in-head)
(match-end 0))))
(t
(goto-char pnt)
(unless noerror (error "Not on BibTeX field"))))))
(defun bibtex-remove-OPT-or-ALT ()
"Remove the string starting optional/alternative fields.
Align text and go thereafter to end of text."
(interactive)
(bibtex-inside-field)
(let ((case-fold-search t)
(bounds (bibtex-enclosing-field)))
(save-excursion
(goto-char (bibtex-start-of-name-in-field bounds))
(when (looking-at "OPT\\|ALT")
(delete-region (match-beginning 0) (match-end 0))
;; make field non-OPT
(search-forward "=")
(forward-char -1)
(delete-horizontal-space)
(if bibtex-align-at-equal-sign
(indent-to-column (- bibtex-text-indentation 2))
(insert " "))
(search-forward "=")
(delete-horizontal-space)
(if bibtex-align-at-equal-sign
(insert " ")
(indent-to-column bibtex-text-indentation))))
(bibtex-inside-field)))
(defun bibtex-remove-delimiters ()
"Remove \"\" or {} around string."
(interactive)
(save-excursion
(bibtex-inside-field)
(let* ((bounds (bibtex-enclosing-field))
(end (bibtex-end-of-text-in-field bounds))
(start (bibtex-start-of-text-in-field bounds)))
(if (memq (char-before end) '(?\} ?\"))
(delete-region (1- end) end))
(if (memq (char-after start) '(?\{ ?\"))
(delete-region start (1+ start))))))
(defun bibtex-kill-field (&optional copy-only)
"Kill the entire enclosing BibTeX field.
With prefix arg COPY-ONLY, copy the current field to `bibtex-field-kill-ring',
but do not actually kill it."
(interactive "P")
(save-excursion
(bibtex-inside-field)
(let* ((case-fold-search t)
(bounds (bibtex-enclosing-field))
(end (bibtex-end-of-field bounds))
(beg (bibtex-start-of-field bounds)))
(goto-char end)
(skip-chars-forward " \t\n,")
(push (list (bibtex-name-in-field bounds) nil
(bibtex-text-in-field-bounds bounds))
bibtex-field-kill-ring)
(if (> (length bibtex-field-kill-ring) bibtex-field-kill-ring-max)
(setcdr (nthcdr (1- bibtex-field-kill-ring-max)
bibtex-field-kill-ring)
nil))
(setq bibtex-field-kill-ring-yank-pointer bibtex-field-kill-ring)
(unless copy-only
(delete-region beg end))))
(setq bibtex-last-kill-command 'field))
(defun bibtex-copy-field-as-kill ()
"Copy the BibTeX field at point to the kill ring."
(interactive)
(bibtex-kill-field t))
(defun bibtex-kill-entry (&optional copy-only)
"Kill the entire enclosing BibTeX entry.
With prefix arg COPY-ONLY, copy the current entry to `bibtex-entry-kill-ring',
but do not actually kill it."
(interactive "P")
(save-excursion
(let* ((case-fold-search t)
(beg (bibtex-beginning-of-entry))
(end (progn (bibtex-end-of-entry)
(if (re-search-forward
bibtex-entry-maybe-empty-head nil 'move)
(goto-char (match-beginning 0)))
(point))))
(push (buffer-substring-no-properties beg end)
bibtex-entry-kill-ring)
(if (> (length bibtex-entry-kill-ring) bibtex-entry-kill-ring-max)
(setcdr (nthcdr (1- bibtex-entry-kill-ring-max)
bibtex-entry-kill-ring)
nil))
(setq bibtex-entry-kill-ring-yank-pointer bibtex-entry-kill-ring)
(unless copy-only
(delete-region beg end))))
(setq bibtex-last-kill-command 'entry))
(defun bibtex-copy-entry-as-kill ()
"Copy the entire enclosing BibTeX entry to `bibtex-entry-kill-ring'."
(interactive)
(bibtex-kill-entry t))
(defun bibtex-yank (&optional n)
"Reinsert the last BibTeX item.
More precisely, reinsert the field or entry killed or yanked most recently.
With argument N, reinsert the Nth most recently killed BibTeX item.
See also the command \\[bibtex-yank-pop]]."
(interactive "*p")
(bibtex-insert-kill (1- n))
(setq this-command 'bibtex-yank))
(defun bibtex-yank-pop (n)
"Replace just-yanked killed BibTeX item with a different item.
This command is allowed only immediately after a `bibtex-yank' or a
`bibtex-yank-pop'. At such a time, the region contains a reinserted
previously killed BibTeX item. `bibtex-yank-pop' deletes that item
and inserts in its place a different killed BibTeX item.
With no argument, the previous kill is inserted.
With argument N, insert the Nth previous kill.
If N is negative, this is a more recent kill.
The sequence of kills wraps around, so that after the oldest one
comes the newest one."
(interactive "*p")
(unless (eq last-command 'bibtex-yank)
(error "Previous command was not a BibTeX yank"))
(setq this-command 'bibtex-yank)
(let ((inhibit-read-only t))
(delete-region (point) (mark t))
(bibtex-insert-kill n)))
(defun bibtex-empty-field ()
"Delete the text part of the current field, replace with empty text."
(interactive)
(bibtex-inside-field)
(let ((bounds (bibtex-enclosing-field)))
(goto-char (bibtex-start-of-text-in-field bounds))
(delete-region (point) (bibtex-end-of-text-in-field bounds))
(insert (concat (bibtex-field-left-delimiter)
(bibtex-field-right-delimiter)) )
(bibtex-find-text t)))
(defun bibtex-pop-previous (arg)
"Replace text of current field with the similar field in previous entry.
With arg, goes up ARG entries. Repeated, goes up so many times. May be
intermixed with \\[bibtex-pop-next] (bibtex-pop-next)."
(interactive "p")
(bibtex-pop arg 'previous))
(defun bibtex-pop-next (arg)
"Replace text of current field with the text of similar field in next entry.
With arg, goes down ARG entries. Repeated, goes down so many times. May be
intermixed with \\[bibtex-pop-previous] (bibtex-pop-previous)."
(interactive "p")
(bibtex-pop arg 'next))
(defun bibtex-clean-entry (&optional new-key called-by-reformat)
"Finish editing the current BibTeX entry and clean it up.
Check that no required fields are empty and formats entry dependent
on the value of `bibtex-entry-format'.
If the reference key of the entry is empty or a prefix argument is given,
calculate a new reference key. (Note: this works only if fields in entry
begin on separate lines prior to calling `bibtex-clean-entry' or if
'realign is contained in `bibtex-entry-format'.)
Don't call `bibtex-clean-entry' on @Preamble entries.
At end of the cleaning process, the functions in
`bibtex-clean-entry-hook' are called with region narrowed to entry."
;; Opt. arg called-by-reformat is t if bibtex-clean-entry
;; is called by bibtex-reformat
(interactive "P")
(let ((case-fold-search t)
(start (bibtex-beginning-of-entry))
(_ (looking-at bibtex-entry-maybe-empty-head))
(entry-type (bibtex-type-in-head))
(key (bibtex-key-in-head)))
;; formatting
(cond ((bibtex-string= entry-type "preamble")
;; (bibtex-format-preamble)
(error "No clean up of @Preamble entries"))
((bibtex-string= entry-type "string")
(setq entry-type 'string))
;; (bibtex-format-string)
(t (bibtex-format-entry)))
;; set key
(when (or new-key (not key))
(setq key (bibtex-generate-autokey))
;; Sometimes bibtex-generate-autokey returns an empty string
(if (or bibtex-autokey-edit-before-use (string= "" key))
(setq key (if (eq entry-type 'string)
(bibtex-read-string-key key)
(bibtex-read-key "Key to use: " key))))
(save-excursion
(re-search-forward (if (eq entry-type 'string)
bibtex-string-maybe-empty-head
bibtex-entry-maybe-empty-head))
(if (match-beginning bibtex-key-in-head)
(delete-region (match-beginning bibtex-key-in-head)
(match-end bibtex-key-in-head)))
(insert key)))
(unless called-by-reformat
(let* ((end (save-excursion
(bibtex-end-of-entry)
(if (re-search-forward
bibtex-entry-maybe-empty-head nil 'move)
(goto-char (match-beginning 0)))
(point)))
(entry (buffer-substring start end))
;; include the crossref key in index
(index (let ((bibtex-maintain-sorted-entries 'crossref))
(bibtex-entry-index))) ; moves point to end of head
error)
;; sorting
(if (and bibtex-maintain-sorted-entries
(not (and bibtex-sort-ignore-string-entries
(eq entry-type 'string))))
(progn
(delete-region start end)
(setq error (not (bibtex-prepare-new-entry index))
start (point)) ; update start
(save-excursion (insert entry)))
(bibtex-find-entry key)
(setq error (or (/= (point) start)
(bibtex-find-entry key nil end))))
(if error
(error "New inserted entry yields duplicate key"))
(dolist (buffer (bibtex-files-expand))
(with-current-buffer buffer
(if (cdr (assoc-string key bibtex-reference-keys))
(error "Duplicate key in %s" (buffer-file-name)))))
;; Only update the list of keys if it has been built already.
(cond ((eq entry-type 'string)
(if (and (listp bibtex-strings)
(not (assoc key bibtex-strings)))
(push (cons key (bibtex-text-in-string
(save-excursion (bibtex-parse-string)) t))
bibtex-strings)))
;; We have a normal entry.
((listp bibtex-reference-keys)
(cond ((not (assoc key bibtex-reference-keys))
(push (cons key t) bibtex-reference-keys))
((not (cdr (assoc key bibtex-reference-keys)))
;; Turn a crossref key into a header key
(setq bibtex-reference-keys
(cons (cons key t)
(delete (list key) bibtex-reference-keys)))))
;; Handle crossref key.
(if (and (nth 1 index)
(not (assoc (nth 1 index) bibtex-reference-keys)))
(push (list (nth 1 index)) bibtex-reference-keys)))))
;; final clean up
(if bibtex-clean-entry-hook
(save-excursion
(save-restriction
(bibtex-narrow-to-entry)
(run-hooks 'bibtex-clean-entry-hook)))))))
(defun bibtex-fill-field-bounds (bounds justify &optional move)
"Fill BibTeX field delimited by BOUNDS.
If JUSTIFY is non-nil justify as well.
If optional arg MOVE is non-nil move point to end of field."
(let ((end-field (copy-marker (bibtex-end-of-field bounds))))
(goto-char (bibtex-start-of-field bounds))
(if justify
(progn
(forward-char)
(bibtex-delete-whitespace)
(open-line 1)
(forward-char)
(indent-to-column (+ bibtex-entry-offset
bibtex-field-indentation))
(re-search-forward "[ \t\n]*=" end-field)
(replace-match "=")
(forward-char -1)
(if bibtex-align-at-equal-sign
(indent-to-column
(+ bibtex-entry-offset (- bibtex-text-indentation 2)))
(insert " "))
(forward-char)
(bibtex-delete-whitespace)
(if bibtex-align-at-equal-sign
(insert " ")
(indent-to-column bibtex-text-indentation)))
(re-search-forward "[ \t\n]*=[ \t\n]*" end-field))
(while (re-search-forward "[ \t\n]+" end-field 'move)
(replace-match " "))
(do-auto-fill)
(if move (goto-char end-field))))
(defun bibtex-fill-field (&optional justify)
"Like \\[fill-paragraph], but fill current BibTeX field.
Optional prefix arg JUSTIFY non-nil means justify as well.
In BibTeX mode this function is bound to `fill-paragraph-function'."
(interactive "*P")
(let ((pnt (copy-marker (point)))
(bounds (bibtex-enclosing-field)))
(when bounds
(bibtex-fill-field-bounds bounds justify)
(goto-char pnt))))
(defun bibtex-fill-entry ()
"Fill current BibTeX entry.
Realign entry, so that every field starts on a separate line. Field
names appear in column `bibtex-field-indentation', field text starts in
column `bibtex-text-indentation' and continuation lines start here, too.
If `bibtex-align-at-equal-sign' is non-nil, align equal signs, too."
(interactive "*")
(let ((pnt (copy-marker (point)))
(end (copy-marker (bibtex-end-of-entry)))
bounds)
(bibtex-beginning-of-entry)
(bibtex-delete-whitespace)
(indent-to-column bibtex-entry-offset)
(while (setq bounds (bibtex-search-forward-field bibtex-field-name end))
(bibtex-fill-field-bounds bounds t t))
(if (looking-at ",")
(forward-char))
(bibtex-delete-whitespace)
(open-line 1)
(forward-char)
(indent-to-column bibtex-entry-offset)
(goto-char pnt)))
(defun bibtex-realign ()
"Realign BibTeX entries such that they are separated by one blank line."
(goto-char (point-min))
(let ((case-fold-search t))
;; No blank lines prior to the first valid entry if there no
;; non-white characters in front of it.
(when (looking-at bibtex-valid-entry-whitespace-re)
(replace-match "\\1"))
;; Valid entries are separated by one blank line.
(while (re-search-forward bibtex-valid-entry-whitespace-re nil t)
(replace-match "\n\n\\1"))
;; One blank line past the last valid entry if it is followed by
;; non-white characters, no blank line otherwise.
(beginning-of-line)
(when (re-search-forward bibtex-valid-entry-re nil t)
(bibtex-end-of-entry)
(bibtex-delete-whitespace)
(open-line (if (eobp) 1 2)))))
(defun bibtex-reformat (&optional read-options)
"Reformat all BibTeX entries in buffer or region.
Without prefix argument, reformatting is based on `bibtex-entry-format'.
With prefix argument, read options for reformatting from minibuffer.
With \\[universal-argument] \\[universal-argument] prefix argument, reuse previous answers (if any) again.
If mark is active reformat entries in region, if not in whole buffer."
(interactive "*P")
(let* ((pnt (point))
(use-previous-options
(and (equal (prefix-numeric-value read-options) 16)
(or bibtex-reformat-previous-options
bibtex-reformat-previous-reference-keys)))
(bibtex-entry-format
(cond (read-options
(if use-previous-options
bibtex-reformat-previous-options
(setq bibtex-reformat-previous-options
(mapcar (lambda (option)
(if (y-or-n-p (car option)) (cdr option)))
`(("Realign entries (recommended)? " . 'realign)
("Remove empty optional and alternative fields? " . 'opts-or-alts)
("Remove delimiters around pure numerical fields? " . 'numerical-fields)
(,(concat (if bibtex-comma-after-last-field "Insert" "Remove")
" comma at end of entry? ") . 'last-comma)
("Replace double page dashes by single ones? " . 'page-dashes)
("Inherit booktitle? " . 'inherit-booktitle)
("Force delimiters? " . 'delimiters)
("Unify case of entry types and field names? " . 'unify-case))))))
;; Do not include required-fields because `bibtex-reformat'
;; cannot handle the error messages of `bibtex-format-entry'.
;; Use `bibtex-validate' to check for required fields.
((eq t bibtex-entry-format)
'(realign opts-or-alts numerical-fields delimiters
last-comma page-dashes unify-case inherit-booktitle))
(t
(remove 'required-fields (push 'realign bibtex-entry-format)))))
(reformat-reference-keys
(if read-options
(if use-previous-options
bibtex-reformat-previous-reference-keys
(setq bibtex-reformat-previous-reference-keys
(y-or-n-p "Generate new reference keys automatically? ")))))
(bibtex-sort-ignore-string-entries t)
bibtex-autokey-edit-before-use)
(save-restriction
(narrow-to-region (if mark-active (region-beginning) (point-min))
(if mark-active (region-end) (point-max)))
(if (memq 'realign bibtex-entry-format)
(bibtex-realign))
(bibtex-progress-message "Formatting" 1)
(bibtex-map-entries (lambda (key beg end)
(bibtex-progress-message)
(bibtex-clean-entry reformat-reference-keys t)))
(bibtex-progress-message 'done))
(when reformat-reference-keys
(kill-local-variable 'bibtex-reference-keys)
(when bibtex-maintain-sorted-entries
(bibtex-progress-message "Sorting" 1)
(bibtex-sort-buffer)
(bibtex-progress-message 'done)))
(goto-char pnt)))
(defun bibtex-convert-alien (&optional read-options)
"Make an alien BibTeX buffer fully usable by BibTeX mode.
If a file does not conform with all standards used by BibTeX mode,
some of the high-level features of BibTeX mode are not available.
This function tries to convert current buffer to conform with these standards.
With prefix argument READ-OPTIONS non-nil, read options for reformatting
entries from minibuffer."
(interactive "*P")
(message "Starting to validate buffer...")
(sit-for 1 nil t)
(bibtex-realign)
(message
"If errors occur, correct them and call `bibtex-convert-alien' again")
(sit-for 5 nil t)
(deactivate-mark) ; So bibtex-validate works on the whole buffer.
(when (let (bibtex-maintain-sorted-entries)
(bibtex-validate))
(message "Starting to reformat entries...")
(sit-for 2 nil t)
(bibtex-reformat read-options)
(goto-char (point-max))
(message "Buffer is now parsable. Please save it.")))
(defun bibtex-complete ()
"Complete word fragment before point according to context.
If point is inside key or crossref field perform key completion based on
`bibtex-reference-keys'. Inside a month field perform key completion
based on `bibtex-predefined-month-strings'. Inside any other field
perform string completion based on `bibtex-strings'. An error is
signaled if point is outside key or BibTeX field."
(interactive)
(let ((pnt (point))
(case-fold-search t)
bounds name compl)
(save-excursion
(if (and (setq bounds (bibtex-enclosing-field t))
(>= pnt (bibtex-start-of-text-in-field bounds))
(<= pnt (bibtex-end-of-text-in-field bounds)))
(setq name (bibtex-name-in-field bounds t)
compl (cond ((bibtex-string= name "crossref")
;; point is in crossref field
'crossref-key)
((bibtex-string= name "month")
;; point is in month field
bibtex-predefined-month-strings)
;; point is in other field
(t (if (listp bibtex-strings)
bibtex-strings
;; so that bibtex-complete-string-cleanup
;; can do its job
(bibtex-parse-strings
(bibtex-string-files-init))))))
(bibtex-beginning-of-entry)
(cond ((and (looking-at bibtex-string-maybe-empty-head)
;; point is inside a string key
(or (and (match-beginning bibtex-key-in-head)
(>= pnt (match-beginning bibtex-key-in-head))
(<= pnt (match-end bibtex-key-in-head)))
;; or point is on empty string key
(and (not (match-beginning bibtex-key-in-head))
(= pnt (match-end 0)))))
(setq compl 'string))
((and (looking-at bibtex-entry-maybe-empty-head)
;; point is inside a key
(or (and (match-beginning bibtex-key-in-head)
(>= pnt (match-beginning bibtex-key-in-head))
(<= pnt (match-end bibtex-key-in-head)))
;; or point is on empty key
(and (not (match-beginning bibtex-key-in-head))
(= pnt (match-end 0)))))
(setq compl 'key)))))
(cond ((eq compl 'key)
;; key completion: no cleanup needed
(let (completion-ignore-case)
(bibtex-complete-internal (bibtex-global-key-alist))))
((eq compl 'crossref-key)
;; crossref key completion
(let (completion-ignore-case)
(setq choose-completion-string-functions
(lambda (choice buffer mini-p base-size)
(let ((choose-completion-string-functions nil))
(choose-completion-string choice buffer base-size))
(bibtex-complete-crossref-cleanup choice)
;; return t (needed by choose-completion-string-functions)
t))
(bibtex-complete-crossref-cleanup (bibtex-complete-internal
(bibtex-global-key-alist)))))
((eq compl 'string)
;; string key completion: no cleanup needed
(let ((completion-ignore-case t))
(bibtex-complete-internal bibtex-strings)))
(compl
;; string completion
(let ((completion-ignore-case t))
(setq choose-completion-string-functions
`(lambda (choice buffer mini-p base-size)
(let ((choose-completion-string-functions nil))
(choose-completion-string choice buffer base-size))
(bibtex-complete-string-cleanup choice ',compl)
;; return t (needed by choose-completion-string-functions)
t))
(bibtex-complete-string-cleanup (bibtex-complete-internal compl)
compl)))
(t (error "Point outside key or BibTeX field")))))
(defun bibtex-Article ()
"Insert a new BibTeX @Article entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "Article"))
(defun bibtex-Book ()
"Insert a new BibTeX @Book entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "Book"))
(defun bibtex-Booklet ()
"Insert a new BibTeX @Booklet entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "Booklet"))
(defun bibtex-InBook ()
"Insert a new BibTeX @InBook entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "InBook"))
(defun bibtex-InCollection ()
"Insert a new BibTeX @InCollection entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "InCollection"))
(defun bibtex-InProceedings ()
"Insert a new BibTeX @InProceedings entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "InProceedings"))
(defun bibtex-Manual ()
"Insert a new BibTeX @Manual entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "Manual"))
(defun bibtex-MastersThesis ()
"Insert a new BibTeX @MastersThesis entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "MastersThesis"))
(defun bibtex-Misc ()
"Insert a new BibTeX @Misc entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "Misc"))
(defun bibtex-PhdThesis ()
"Insert a new BibTeX @PhdThesis entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "PhdThesis"))
(defun bibtex-Proceedings ()
"Insert a new BibTeX @Proceedings entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "Proceedings"))
(defun bibtex-TechReport ()
"Insert a new BibTeX @TechReport entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "TechReport"))
(defun bibtex-Unpublished ()
"Insert a new BibTeX @Unpublished entry; see also `bibtex-entry'."
(interactive "*")
(bibtex-entry "Unpublished"))
(defun bibtex-String (&optional key)
"Insert a new BibTeX @String entry with key KEY."
(interactive (list (bibtex-read-string-key)))
(let ((bibtex-maintain-sorted-entries
(unless bibtex-sort-ignore-string-entries
bibtex-maintain-sorted-entries))
endpos)
(unless (bibtex-prepare-new-entry (list key nil "String"))
(error "Entry with key `%s' already exists" key))
(if (zerop (length key)) (setq key nil))
(indent-to-column bibtex-entry-offset)
(insert "@String"
(bibtex-entry-left-delimiter))
(if key
(insert key)
(setq endpos (point)))
(insert " = "
(bibtex-field-left-delimiter))
(if key
(setq endpos (point)))
(insert (bibtex-field-right-delimiter)
(bibtex-entry-right-delimiter)
"\n")
(goto-char endpos)))
(defun bibtex-Preamble ()
"Insert a new BibTeX @Preamble entry."
(interactive "*")
(bibtex-move-outside-of-entry)
(indent-to-column bibtex-entry-offset)
(insert "@Preamble"
(bibtex-entry-left-delimiter))
(let ((endpos (point)))
(insert (bibtex-entry-right-delimiter)
"\n")
(goto-char endpos)))
(defun bibtex-url (&optional pos)
"Browse a URL for the BibTeX entry at point.
Optional POS is the location of the BibTeX entry.
The URL is generated using the schemes defined in `bibtex-generate-url-list'
\(see there\). Then the URL is passed to `browse-url'."
(interactive)
(save-excursion
(if pos (goto-char pos))
(bibtex-beginning-of-entry)
(let ((fields-alist (bibtex-parse-entry))
;; Always ignore case,
(case-fold-search t)
(lst bibtex-generate-url-list)
field url scheme obj fmt)
(while (setq scheme (pop lst))
(when (and (setq field (cdr (assoc-string (caar scheme)
fields-alist t)))
;; Always remove field delimiters
(progn (setq field (bibtex-remove-delimiters-string field))
(string-match (cdar scheme) field)))
(setq lst nil
scheme (cdr scheme)
url (if (null scheme) (match-string 0 field)
(if (stringp (car scheme))
(setq fmt (pop scheme)))
(dolist (step scheme)
;; Always remove field delimiters
(setq field (bibtex-remove-delimiters-string
(cdr (assoc-string (car step) fields-alist t))))
(if (string-match (nth 1 step) field)
(setq field (cond ((functionp (nth 2 step))
(funcall (nth 2 step) field))
((numberp (nth 2 step))
(match-string (nth 2 step) field))
(t
(replace-match (nth 2 step) t nil field))))
;; If the scheme is set up correctly,
;; we should never reach this point
(error "Match failed: %s" field))
(push field obj))
(if fmt (apply 'format fmt (nreverse obj))
(apply 'concat (nreverse obj)))))
(browse-url (message "%s" url))))
(unless url (message "No URL known.")))))
;; Make BibTeX a Feature
(provide 'bibtex)
;; arch-tag: ee2be3af-caad-427f-b42a-d20fad630d04
;;; bibtex.el ends here
Reference in New Issue View Git Blame Copy Permalink