;;; bibtex.el --- BibTeX mode for GNU Emacs
-;; Copyright (C) 1992,94,95,96,97,98,1999,2003 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2001, 2002,
+;; 2003, 2004, 2005, 2006, 2007 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>
+;; Marc Shapiro <marc.shapiro@acm.org>
;; Mike Newton <newton@gumby.cs.caltech.edu>
;; Aaron Larson <alarson@src.honeywell.com>
;; Dirk Herrmann <D.Herrmann@tu-bs.de>
;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, 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).
+;; See documentation for `bibtex-mode' or type "M-x describe-mode"
+;; when you are in BibTeX mode.
;; Todo:
;; Distribute texinfo file.
;;; Code:
+(require 'button)
+
\f
;; User Options:
(defgroup bibtex nil
- "BibTeX mode"
+ "BibTeX mode."
:group 'tex
:prefix "bibtex-")
(defgroup bibtex-autokey nil
- "Generate automatically a key from the author/editor and the title field"
+ "Generate automatically a key from the author/editor and the title field."
:group 'bibtex
:prefix "bibtex-autokey-")
:type 'hook)
(defcustom bibtex-field-delimiters 'braces
- "*Type of field delimiters. Allowed values are `braces' or `double-quotes'."
+ "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'."
+ "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 entries that get an OPTcrossref field."
+ "List of BibTeX entries that get an OPTcrossref field."
:group 'bibtex
:type '(repeat string))
(defcustom bibtex-include-OPTkey t
- "*If non-nil, all entries will have an OPTkey field.
-If this is a string, it will be used as the initial field text.
-If this is a function, it will be called to generate the initial field text."
+ "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)))
+ (function :tag "Initialize Function")
+ (const :tag "Default" t)))
+(put 'bibtex-include-OPTkey 'risky-local-variable t)
(defcustom bibtex-user-optional-fields
'(("annote" "Personal annotation (ignored)"))
- "*List of optional fields the user wants to have always present.
+ "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' (see documentation
-of this variable for details)."
+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))))))
+ (option (choice :tag "Init"
+ (const nil) string function)))))
+(put 'bibtex-user-optional-fields 'risky-local-variable t)
(defcustom bibtex-entry-format
'(opts-or-alts required-fields numerical-fields)
- "*Type of formatting performed by `bibtex-clean-entry'.
+ "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.
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 booktitle
- field is empty, it is set to the contents of the
- title field of the crossreferenced entry.
- Caution: this will work only if buffer is
- correctly sorted.
+whitespace Delete whitespace at the beginning and end of fields.
+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.
delimiters Change delimiters according to variables
`bibtex-field-delimiters' and `bibtex-entry-delimiters'.
unify-case Change case of entry and field names.
+braces Enclose parts of field entries by braces according to
+ `bibtex-field-braces-alist'.
+strings Replace parts of field entries by string constants
+ according to `bibtex-field-strings-alist'.
The value t means do all of the above formatting actions.
The value nil means do no formatting at all."
(const required-fields)
(const numerical-fields)
(const page-dashes)
+ (const whitespace)
(const inherit-booktitle)
(const realign)
(const last-comma)
(const delimiters)
- (const unify-case))))
+ (const unify-case)
+ (const braces)
+ (const strings))))
+
+(defcustom bibtex-field-braces-alist nil
+ "Alist of field regexps that \\[bibtex-clean-entry] encloses by braces.
+Each element has the form (FIELDS REGEXP), where FIELDS is a list
+of BibTeX field names and REGEXP is a regexp.
+Whitespace in REGEXP will be replaced by \"[ \\t\\n]+\"."
+ :group 'bibtex
+ :type '(repeat (list (repeat (string :tag "field name"))
+ (choice (regexp :tag "regexp")
+ (sexp :tag "sexp")))))
+
+(defcustom bibtex-field-strings-alist nil
+ "Alist of regexps that \\[bibtex-clean-entry] replaces by string constants.
+Each element has the form (FIELDS REGEXP TO-STR), where FIELDS is a list
+of BibTeX field names. In FIELDS search for REGEXP, which are replaced
+by the BibTeX string constant TO-STR.
+Whitespace in REGEXP will be replaced by \"[ \\t\\n]+\"."
+ :group 'bibtex
+ :type '(repeat (list (repeat (string :tag "field name"))
+ (regexp :tag "From regexp")
+ (regexp :tag "To string constant"))))
(defcustom bibtex-clean-entry-hook nil
- "*List of functions to call when entry has been cleaned.
+ "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 BibTeX entries in sorted order.
-If it is nil this will strip off some comfort (e.g., TAB
-completion for reference keys in minibuffer, automatic detection of
-duplicates) from BibTeX mode. Allowed non-nil values are:
-plain All entries are sorted alphabetically.
+ "If non-nil, BibTeX mode maintains all entries in sorted order.
+Allowed non-nil values are:
+plain or t All entries are sorted alphabetically.
crossref All entries are sorted alphabetically unless an entry has a
- crossref field. These crossrefed entries are placed in
+ 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
+ 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)))
+ (const entry-class)
+ (const t)))
+(put 'bibtex-maintain-sorted-entries 'safe-local-variable
+ '(lambda (a) (memq a '(nil t plain crossref entry-class))))
-(defvar bibtex-sort-entry-class
+(defcustom bibtex-sort-entry-class
'(("String")
- ("Article" "InBook" "InCollection" "InProceedings")
- ("Book" "Proceedings")
- ("Booklet" "Manual" "MastersThesis" "PhdThesis" "TechReport" )
- ("Misc" "Unpublished"))
- "*List of classes of BibTeX entry names, used for sorting entries.
-Each class contains a list of entry names. If value of
-`bibtex-maintain-sorted-entries' is `entry-class' entries are ordered
-according to the classes they belong to.")
-
-(defcustom bibtex-sort-ignore-string-entries
- (not (equal bibtex-maintain-sorted-entries 'entry-class))
- "*If non-nil, BibTeX @String entries are not sort-significant.
+ (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))))
+(put 'bibtex-sort-entry-class 'safe-local-variable
+ (lambda (x) (let ((OK t))
+ (while (consp x)
+ (let ((y (pop x)))
+ (while (consp y)
+ (let ((z (pop y)))
+ (unless (or (stringp z) (eq z 'catch-all))
+ (setq OK nil))))
+ (unless (null y) (setq OK nil))))
+ (unless (null x) (setq OK nil))
+ OK)))
+
+(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."
+ "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
- "*Specify interval for parsing BibTeX buffers.
-All BibTeX buffers in Emacs are parsed if Emacs has been idle
-`bibtex-parse-keys-timeout' seconds. Only buffers which were modified
-after last parsing and which are maintained in sorted order are parsed."
+ "Time interval in seconds for parsing BibTeX buffers during idle time.
+Parsing initializes `bibtex-reference-keys' and `bibtex-strings'."
:group 'bibtex
:type 'integer)
-(defvar bibtex-entry-field-alist
- '(
- ("Article"
+(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)
+
+(defcustom 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)")
- ("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"))))
+ ("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]" "" t)
- ("editor" "Editor1 [and Editor2 ...] [and others]" "" 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]" "" t)
- ("editor" "Editor1 [and Editor2 ...] [and others]" "" 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")))
+ ((("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"))))
+ (("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]" "" t)
- ("editor" "Editor1 [and Editor2 ...] [and others]" "" 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]" "" t)
- ("editor" "Editor1 [and Editor2 ...] [and others]" "" 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"))))
+ ((("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"))))
+ ("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"))))
+ ("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"))))
+ (("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"))))
+ ("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"))))
+ (("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"))))
+ ("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"))))
+ ("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"))))
+ ("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"))))
- )
-
- "Defines entry types and their associated fields.
-List of
-\(ENTRY-NAME (REQUIRED OPTIONAL) (CROSSREF-REQUIRED CROSSREF-OPTIONAL))
-triples.
-If the third element is nil, the first pair is always used.
-If not, the second pair is used in the case of presence of a crossref
-field and the third in the case of absence.
+ ("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 the comment to
-appear in the echo area, INIT is either the initial content of the
+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.")
-
-(defvar bibtex-comment-start "@Comment"
- "String starting a BibTeX comment.")
+REQUIRED or CROSSREF-REQUIRED lists."
+ :group 'bibtex
+ :type '(repeat (group (string :tag "Entry name")
+ (group (repeat :tag "Required fields"
+ (group (string :tag "Field")
+ (string :tag "Comment")
+ (option (choice :tag "Init" :value nil
+ (const nil) string function))
+ (option (choice :tag "Alternative"
+ (const :tag "No" nil)
+ (const :tag "Yes" t)))))
+ (repeat :tag "Optional fields"
+ (group (string :tag "Field")
+ (string :tag "Comment")
+ (option (choice :tag "Init" :value nil
+ (const nil) string function)))))
+ (option :extra-offset -4
+ (group (repeat :tag "Crossref: required fields"
+ (group (string :tag "Field")
+ (string :tag "Comment")
+ (option (choice :tag "Init" :value nil
+ (const nil) string function))
+ (option (choice :tag "Alternative"
+ (const :tag "No" nil)
+ (const :tag "Yes" t)))))
+ (repeat :tag "Crossref: optional fields"
+ (group (string :tag "Field")
+ (string :tag "Comment")
+ (option (choice :tag "Init" :value nil
+ (const nil) string function)))))))))
+(put 'bibtex-entry-field-alist 'risky-local-variable t)
+
+(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 entry has been inserted."
+ "List of functions to call when BibTeX entry has been inserted."
:group 'bibtex
:type 'hook)
("nov" . "November")
("dec" . "December"))
"Alist of month string definitions used in the BibTeX style files.
-Each element is a pair of strings (ABBREVIATION EXPANSION)."
+Each element is a pair of strings (ABBREVIATION . EXPANSION)."
:group 'bibtex
:type '(repeat (cons (string :tag "Month abbreviation")
(string :tag "Month expansion"))))
("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)."
+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.
-Those files must be specified using pathnames relative to the
-directories specified in `bibtex-string-file-path'. This variable is only
-evaluated when BibTeX mode is entered (i.e., when loading the BibTeX
-file)."
+ "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 (choice (const :tag "bibtex-file-path" bibtex-file-path)
+ directory file)))
+
+(defvar bibtex-file-path (getenv "BIBINPUTS")
+ "*Colon separated list of paths to search for `bibtex-files'.")
+
(defcustom bibtex-help-message t
- "*If not nil print help messages in the echo area on entering a new field."
+ "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 to use as a prefix for all generated keys.
-See the documentation of function `bibtex-generate-autokey' for more detail."
+ "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.
-If this variable is nil, all names are used.
+ "Number of names to use for the automatically generated reference key.
Possibly more names are used according to `bibtex-autokey-names-stretch'.
-See the documentation of function `bibtex-generate-autokey' for more detail."
+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.
+ "Number of names that can additionally be used for reference keys.
These names are used only, if all names are used then.
-See the documentation of function `bibtex-generate-autokey' for details."
+See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'integer)
(defcustom bibtex-autokey-additional-names ""
- "*String to prepend to the generated key if not all names could be used.
-See the documentation of function `bibtex-generate-autokey' for details."
+ "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)
+(defcustom bibtex-autokey-expand-strings nil
+ "If non-nil, expand strings when extracting the content of a BibTeX field.
+See `bibtex-generate-autokey' for details."
+ :group 'bibtex-autokey
+ :type 'boolean)
+
(defvar bibtex-autokey-transcriptions
'(;; language specific characters
("\\\\aa" . "a") ; \aa -> a
("\\\"U\\|\\\\\\\"U" . "Ue") ; "U,\"U -> Ue
;; accents
("\\\\`\\|\\\\'\\|\\\\\\^\\|\\\\~\\|\\\\=\\|\\\\\\.\\|\\\\u\\|\\\\v\\|\\\\H\\|\\\\t\\|\\\\c\\|\\\\d\\|\\\\b" . "")
- ("`\\|'\\|\\\"" . "")
- ;; braces
- ("{" . "") ("}" . "")
+ ;; braces, quotes, concatenation.
+ ("[`'\"{}#]" . "")
;; spaces
- ("[ \t\n]+" . " "))
- "Alist of (OLD-REGEXP NEW-STRING) pairs.
+ ("\\\\?[ \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
(defcustom bibtex-autokey-name-change-strings
bibtex-autokey-transcriptions
- "Alist of (OLD-REGEXP NEW-STRING) pairs.
-Any part of name matching a OLD-REGEXP is replaced by NEW-STRING.
+ "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 the documentation of function `bibtex-generate-autokey' for details."
+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 the documentation of function `bibtex-generate-autokey' for details."
+(defcustom bibtex-autokey-name-case-convert-function '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")))
+(put 'bibtex-autokey-name-case-convert-function 'safe-local-variable
+ (lambda (x) (memq x '(upcase downcase capitalize identity))))
+(defvaralias 'bibtex-autokey-name-case-convert
+ 'bibtex-autokey-name-case-convert-function)
(defcustom bibtex-autokey-name-length 'infty
- "*Number of characters from name to incorporate into key.
+ "Number of characters from name to incorporate into key.
If this is set to anything but a number, all characters are used.
-See the documentation of function `bibtex-generate-autokey' for details."
+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 the documentation of function `bibtex-generate-autokey' for details."
+ "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 the documentation of function `bibtex-generate-autokey' for details."
+ "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 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 the documentation of function `bibtex-generate-autokey' for details."
+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.
+ "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 the documentation of function `bibtex-generate-autokey' for details."
+See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type '(choice (const :tag "All" infty)
integer))
-(defcustom bibtex-autokey-title-terminators
- '("\\." "!" "\\?" ":" ";" "--")
- "*Regexp list defining the termination of the main part of the title.
-Case of the regexps is ignored.
-See the documentation of function `bibtex-generate-autokey' for details."
+(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 '(repeat regexp))
+ :type 'regexp)
(defcustom bibtex-autokey-titlewords-stretch 2
- "*Number of words that can additionally be used from the title.
+ "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 the documentation of function `bibtex-generate-autokey' for details."
+See `bibtex-generate-autokey' for details."
:group 'bibtex-autokey
:type 'integer)
(defcustom bibtex-autokey-titleword-ignore
'("A" "An" "On" "The" "Eine?" "Der" "Die" "Das"
- "[^A-Z].*" ".*[^a-zA-Z0-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 matchs a
+ "[^[: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 the documentation of function `bibtex-generate-autokey' for details."
+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 the documentation of function `bibtex-generate-autokey' for details."
+(defcustom bibtex-autokey-titleword-case-convert-function '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")))
+(defvaralias 'bibtex-autokey-titleword-case-convert
+ 'bibtex-autokey-titleword-case-convert-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
+ "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 the documentation of function `bibtex-generate-autokey' for details."
+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.
+ "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 the documentation of function `bibtex-generate-autokey' for details."
+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.
+ "Number of characters from title words to incorporate into key.
If this is set to anything but a number, all characters are used.
-See the documentation of function `bibtex-generate-autokey' for details."
+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 the documentation of function `bibtex-generate-autokey' for details."
+ "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 the documentation of function `bibtex-generate-autokey' for details."
+ "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 the documentation of function `bibtex-generate-autokey' for details."
+ "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."
+ "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
- "*Function to call before the generated key is presented.
-If non-nil this should be a single function, which is called before
-the generated key is presented (in entry or, if
-`bibtex-autokey-edit-before-use' is t, in minibuffer). This function
-must take one argument (the automatically generated key), and must
-return with a string (the key to use)."
+ "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 colums."
+ "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."
+ "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.
+ "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."
+ "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, 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."
+ "If non-nil, a comma is put at end of last field in the entry template."
:group 'bibtex
:type 'boolean)
-(defcustom bibtex-complete-key-cleanup nil
- "*Function called by `bibtex-complete' after insertion of a key fragment."
- :group 'bibtex-autokey
- :type '(choice (const :tag "None" nil)
- (function :tag "Cleanup function")))
+(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 summary of current BibTeX entry.
+It takes no arguments. Point must be at beginning of 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.
+If `bibtex-expand-strings' is non-nil, BibTeX strings are expanded
+for generating the URL.
+
+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"))))))))
+(put 'bibtex-generate-url-list 'risky-local-variable t)
+
+(defcustom bibtex-cite-matcher-alist
+ '(("\\\\cite[ \t\n]*{\\([^}]+\\)}" . 1))
+ "Alist of rules to identify cited keys in a BibTeX entry.
+Each rule should be of the form (REGEXP . SUBEXP), where SUBEXP
+specifies which parenthesized expression in REGEXP is a cited key.
+Case is significant.
+Used by `bibtex-find-crossref' and for font-locking."
+ :group 'bibtex
+ :type '(repeat (cons (regexp :tag "Regexp")
+ (integer :tag "Number"))))
-;; bibtex-font-lock-keywords is a user option as well, but since the
+(defcustom bibtex-expand-strings nil
+ "If non-nil, expand strings when extracting the content of a BibTeX field."
+ :group 'bibtex
+ :type 'boolean)
+
+;; `bibtex-font-lock-keywords' is a user option, too. But since the
;; patterns used to define this variable are defined in a later
;; section of this file, it is defined later.
\f
-;; Syntax Table, Keybindings and BibTeX Entry List
+;; Syntax Table and Keybindings
(defvar bibtex-mode-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?\" "\"" st)
(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\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-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)
["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])
- ("Operating on Current Entry"
- ["Fill Entry" bibtex-fill-entry t]
- ["Clean Entry" bibtex-clean-entry 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]
- "--"
- ["Ispell Entry" bibtex-ispell-entry t]
- ["Ispell Entry Abstract" bibtex-ispell-abstract t]
- ["Narrow to Entry" bibtex-narrow-to-entry t]
- "--"
- ["View Cite Locations (RefTeX)" reftex-view-crossref-from-bibtex
- (fboundp 'reftex-view-crossref-from-bibtex)])
+ ["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]
["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])
- ("Miscellaneous"
- ["Convert Alien Buffer" bibtex-convert-alien 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"
["Technical Manual" bibtex-Manual t]
["Unpublished" bibtex-Unpublished t]
["Miscellaneous" bibtex-Misc t]
+ "--"
["String" bibtex-String t]
["Preamble" bibtex-Preamble t]))
\f
;; Internal Variables
+(defvar bibtex-field-braces-opt nil
+ "Optimized value of `bibtex-field-braces-alist'.
+Created by `bibtex-field-re-init'.
+It is a an alist with elements (FIELD . REGEXP).")
+
+(defvar bibtex-field-strings-opt nil
+ "Optimized value of `bibtex-field-strings-alist'.
+Created by `bibtex-field-re-init'.
+It is a an alist with elements (FIELD RULE1 RULE2 ...),
+where each RULE is (REGEXP . TO-STR).")
+
(defvar bibtex-pop-previous-search-point nil
"Next point where `bibtex-pop-previous' starts looking for a similar entry.")
(defvar bibtex-last-kill-command nil
"Type of the last kill command (either 'field or 'entry).")
-(defvar bibtex-strings nil
- "Candidates for `bibtex-complete' (string completion).
+(defvar bibtex-strings
+ (lazy-completion-table bibtex-strings
+ (lambda ()
+ (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)
+(put 'bibtex-strings 'risky-local-variable t)
-(defvar bibtex-reference-keys nil
- "Candidates for TAB completion when entering a reference key using
-the minibuffer. Also used for `bibtex-complete' (key completion).
-Initialized in `bibtex-mode' and updated for each new entry.")
+(defvar bibtex-reference-keys
+ (lazy-completion-table bibtex-reference-keys
+ (lambda () (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)
+(put 'bibtex-reference-keys 'risky-local-variable t)
(defvar bibtex-buffer-last-parsed-tick nil
- "Last value returned by `buffer-modified-tick' when buffer
-was parsed for keys the last time.")
+ "Value of `buffer-modified-tick' last time buffer was parsed for keys.")
(defvar bibtex-parse-idle-timer nil
"Stores if timer is already installed.")
"History list for reading keys.")
(defvar bibtex-entry-type-history nil
- "Used to store the history list for reading entry types.")
+ "History list for reading entry types.")
(defvar bibtex-field-history nil
"History list for reading field names.")
"Last reformat reference keys option given.")
(defconst bibtex-field-name "[^\"#%'(),={} \t\n0-9][^\"#%'(),={} \t\n]*"
- "Regexp matching the name part of a BibTeX field.")
+ "Regexp matching the name of a BibTeX field.")
-(defconst bibtex-entry-type (concat "@" bibtex-field-name)
- "Regexp matching the type part of a BibTeX entry.")
+(defconst bibtex-name-part
+ (concat ",[ \t\n]*\\(" bibtex-field-name "\\)")
+ "Regexp matching the name part of a BibTeX field.")
-(defconst bibtex-reference-key "[][a-zA-Z0-9.:;?!`'/*@+|()<>&_^$-]+"
+(defconst bibtex-reference-key "[][[:alnum:].:;?!`'/*@+|()<>&_^$-]+"
"Regexp matching the reference key part of a BibTeX entry.")
-(defconst bibtex-field-const "[][a-zA-Z0-9.:;?!`'/*@+=|<>&_^$-]+"
+(defconst bibtex-field-const "[][[:alnum:].:;?!`'/*@+=|<>&_^$-]+"
"Regexp matching a BibTeX field constant.")
-(defconst bibtex-entry-head
+(defvar bibtex-entry-type
+ (concat "@[ \t]*\\(?:"
+ (regexp-opt (mapcar 'car bibtex-entry-field-alist)) "\\)")
+ "Regexp matching the name of a BibTeX entry.")
+
+(defvar bibtex-entry-head
(concat "^[ \t]*\\("
bibtex-entry-type
"\\)[ \t]*[({][ \t\n]*\\("
bibtex-reference-key
"\\)")
- "Regexp matching the header line of a BibTeX entry.")
+ "Regexp matching the header line of a BibTeX entry (including key).")
-(defconst bibtex-entry-maybe-empty-head
+(defvar bibtex-entry-maybe-empty-head
(concat bibtex-entry-head "?")
- "Regexp matching the header line of a maybe empty BibTeX entry
-\(possibly without reference key).")
+ "Regexp matching the header line of a BibTeX entry (possibly without key).")
+
+(defconst bibtex-any-entry-maybe-empty-head
+ (concat "^[ \t]*\\(@[ \t]*" bibtex-field-name "\\)[ \t]*[({][ \t\n]*\\("
+ bibtex-reference-key "\\)?")
+ "Regexp matching the header line of any BibTeX entry (possibly without key).")
+
+(defvar bibtex-any-valid-entry-type
+ (concat "^[ \t]*@[ \t]*\\(?:"
+ (regexp-opt (append '("String" "Preamble")
+ (mapcar 'car bibtex-entry-field-alist))) "\\)")
+ "Regexp matching any valid BibTeX entry (including String and Preamble).")
(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-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 type.")
+(defconst bibtex-string-type "^[ \t]*\\(@[ \t]*String\\)[ \t]*[({][ \t\n]*"
+ "Regexp matching the name of a BibTeX String entry.")
-(defvar bibtex-valid-entry-re
- (concat "@[ \t]*\\(" bibtex-known-entry-type-re "\\)")
- "Regexp matching the name of a valid BibTeX entry.")
+(defconst bibtex-string-maybe-empty-head
+ (concat bibtex-string-type "\\(" bibtex-reference-key "\\)?")
+ "Regexp matching the header line of a BibTeX String 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 an empty field.")
-
-(defconst bibtex-quoted-string-re
- (concat "\""
- "\\("
- "[^\"\\]" ; anything but quote or backslash
- "\\|"
- "\\("
- "\\\\\\(.\\|\n\\)" ; any backslash quoted character
- "\\)"
- "\\)*"
- "\"")
- "Regexp matching a field string enclosed by quotes.")
+(defconst bibtex-preamble-prefix
+ "[ \t]*\\(@[ \t]*Preamble\\)[ \t]*[({][ \t\n]*"
+ "Regexp matching the prefix part of a BibTeX Preamble entry.")
(defconst bibtex-font-lock-syntactic-keywords
`((,(concat "^[ \t]*\\(" (substring bibtex-comment-start 0 1) "\\)"
1 '(11))))
(defvar bibtex-font-lock-keywords
- (list
- ;; entry type and reference key
- (list bibtex-entry-maybe-empty-head
- (list bibtex-type-in-head 'font-lock-function-name-face)
- (list bibtex-key-in-head 'font-lock-constant-face nil t))
- ;; optional field names (treated as comments)
- (list
- (concat "^[ \t]*\\(OPT" bibtex-field-name "\\)[ \t]*=")
- 1 'font-lock-comment-face)
- ;; field names
- (list (concat "^[ \t]*\\(" bibtex-field-name "\\)[ \t]*=")
- 1 'font-lock-variable-name-face))
+ ;; entry type and reference key
+ `((,bibtex-any-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)
+ ;; cite
+ ,@(mapcar (lambda (matcher)
+ `((lambda (bound) (bibtex-font-lock-cite ',matcher bound))))
+ bibtex-cite-matcher-alist))
"*Default expressions to highlight in BibTeX mode.")
-(defvar bibtex-field-name-for-parsing nil
- "Temporary variable storing the name string to be parsed by the callback
-function `bibtex-parse-field-name'.")
+(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' derived from `bibtex-generate-url-list'.")
-(defvar bibtex-sort-entry-class-alist
- (let ((i -1) alist)
- (dolist (class bibtex-sort-entry-class alist)
- (setq i (1+ i))
- (dolist (entry class)
- (push (cons entry i) alist))))
- "Alist for the classes of the entry types if the value of
-`bibtex-maintain-sorted-entries' is `entry-class'.")
+(defvar bibtex-string-empty-key nil
+ "If non-nil, `bibtex-parse-string' accepts empty key.")
-\f
-;; Special support taking care of variants
-(defvar zmacs-regions)
-(if (boundp 'mark-active)
- (defun bibtex-mark-active ()
- ;; In Emacs mark-active indicates if mark is active.
- mark-active)
- (defun bibtex-mark-active ()
- ;; In XEmacs (mark) returns nil when not active.
- (if zmacs-regions (mark) (mark t))))
-
-(if (fboundp 'run-with-idle-timer)
- ;; timer.el is distributed with Emacs
- (fset 'bibtex-run-with-idle-timer 'run-with-idle-timer)
- ;; timer.el is not distributed with XEmacs
- ;; Notice that this does not (yet) pass the arguments, but they
- ;; are not used (yet) in bibtex.el. Fix if needed.
- (defun bibtex-run-with-idle-timer (secs repeat function &rest args)
- (start-itimer "bibtex" function secs (if repeat secs nil) t)))
+(defvar bibtex-sort-entry-class-alist nil
+ "Alist mapping entry types to their sorting index.
+Auto-generated from `bibtex-sort-entry-class'.
+Used when `bibtex-maintain-sorted-entries' is `entry-class'.")
\f
;; Support for hideshow minor mode
(defun bibtex-hs-forward-sexp (arg)
- "Replacement for `forward-sexp' to be used by `hs-minor-mode'."
- (if (< arg 0)
- (backward-sexp 1)
- (if (looking-at "@\\S(*\\s(")
- (progn
- (goto-char (match-end 0))
- (forward-char -1)
- (forward-sexp 1))
- (forward-sexp 1))))
+ "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))
\f
-;; Functions to Parse the BibTeX Entries
-
-(defun bibtex-parse-nested-braces (nesting-level)
- "Starting on an opening brace, find the corresponding closing brace.
-When the function is called, NESTING-LEVEL has to be set to `0'."
- (cond ((looking-at "{")
- (search-forward-regexp "{[^{}]*")
- (bibtex-parse-nested-braces (+ nesting-level 1)))
- ((looking-at "}")
- (forward-char 1)
- (if (= nesting-level 1)
- (point)
- (search-forward-regexp "[^{}]*")
- (bibtex-parse-nested-braces (- nesting-level 1))))
- (t nil)))
-
-(defun bibtex-parse-field-string ()
- "Parse a 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."
- (save-match-data
- (let ((end-point (or (and (looking-at bibtex-quoted-string-re)
- (match-end 0))
- (and (looking-at "{")
- (save-excursion (bibtex-parse-nested-braces 0))))))
- (if end-point
- (cons (point) end-point)))))
-
(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
-successfull. If both functions return non-nil, a pair containing the returned
-values of the functions PARSE-LHS and PARSE-RHS is returned."
+successful. If the returned values of both functions are non-nil,
+return a cons pair of these values. Do not move point."
(save-match-data
(save-excursion
- (let (left right)
- (if (and (setq left (funcall parse-lhs))
+ (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'.
+ "Parse the name part of a BibTeX field.
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 (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))))))
+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 bibtex-name-part)
+ (goto-char (match-end 0))
+ (list (match-beginning 0) (match-beginning 1) (match-end 0)))
+ ;; Maybe add a missing comma.
+ ((and bibtex-autoadd-commas
+ (looking-at (concat "[ \t\n]*\\(?:" bibtex-field-name
+ "\\)[ \t\n]*=")))
+ (skip-chars-backward " \t\n")
+ ;; It can be confusing if non-editing commands try to
+ ;; modify the buffer.
+ (if buffer-read-only
+ (error "Comma missing at buffer position %s" (point)))
+ (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.
+Do not move point."
+ (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."
+returned, nil otherwise. Move point to end of field text."
(let ((starting-point (point))
end-point failure boundaries)
- (while (and (not end-point)
- (not failure))
+ (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 (not (looking-at "[ \t\n]*#[ \t\n]*"))
- (setq end-point (point))
- (goto-char (match-end 0))))
+ (if (looking-at "[ \t\n]*#[ \t\n]*")
+ (goto-char (match-end 0))
+ (setq end-point (point))))
+ (skip-chars-forward " \t\n")
(if (and (not failure)
end-point)
- (cons starting-point end-point))))
+ (list starting-point end-point (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-parse-field ()
+ "Parse the BibTeX field beginning at the position of point.
+If a syntactically correct field is found, return a cons pair containing
+the boundaries of the name and text parts of the field. Do not move point."
+ (bibtex-parse-association 'bibtex-parse-field-name
+ 'bibtex-parse-field-text))
+
+(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-start-of-text-in-field (bounds)
+ (nth 1 bounds))
+(defsubst bibtex-end-of-text-in-field (bounds)
+ (nth 2 bounds))
+(defsubst bibtex-end-of-field (bounds)
+ (nth 3 bounds))
(defun bibtex-search-forward-field (name &optional bound)
- "Search forward to find a 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. Do not move point."
+ "Search forward to find a BibTeX field of name NAME.
+If a syntactically correct field is found, return a pair containing
+the boundaries of the name and text parts of the field. 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 bound (setq bound (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))))
+ (if (eq bound t)
+ (let ((regexp (concat bibtex-name-part "[ \t\n]*=\\|"
+ bibtex-any-entry-maybe-empty-head))
+ (case-fold-search t) bounds)
+ (catch 'done
+ (if (looking-at "[ \t]*@") (goto-char (match-end 0)))
+ (while (and (not bounds)
+ (re-search-forward regexp nil t))
+ (if (match-beginning 2)
+ ;; We found a new entry
+ (throw 'done nil)
+ ;; We found a field
+ (goto-char (match-beginning 0))
+ (setq bounds (bibtex-parse-field))))
+ ;; Step through all fields so that we cannot overshoot.
+ (while bounds
+ (goto-char (bibtex-start-of-name-in-field bounds))
+ (if (looking-at name) (throw 'done bounds))
+ (goto-char (bibtex-end-of-field bounds))
+ (setq bounds (bibtex-parse-field)))))
+ ;; Bounded search or bound is nil (i.e. we cannot overshoot).
+ ;; Indeed, the search is bounded when `bibtex-search-forward-field'
+ ;; is called many times. So we optimize this part of this function.
+ (let ((name-part (concat ",[ \t\n]*\\(" name "\\)[ \t\n]*=[ \t\n]*"))
+ (case-fold-search t) left right)
+ (while (and (not right)
+ (re-search-forward name-part bound t))
+ (setq left (list (match-beginning 0) (match-beginning 1)
+ (match-end 1))
+ ;; Don't worry that the field text could be past bound.
+ right (bibtex-parse-field-text)))
+ (if right (cons left right)))))))
(defun bibtex-search-backward-field (name &optional bound)
- "Search backward to find a 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. Do not move point."
+ "Search backward to find a BibTeX field of name NAME.
+If a syntactically correct field is found, return a pair containing
+the boundaries of the name and text parts of the field. The search
+is limited by the 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 bound (setq bound (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))))
-
-(defun bibtex-start-of-field (bounds)
- (nth 0 (car bounds)))
-(defun bibtex-start-of-name-in-field (bounds)
- (nth 1 (car bounds)))
-(defun bibtex-end-of-name-in-field (bounds)
- (nth 2 (car bounds)))
-(defun bibtex-end-of-field (bounds)
- (cddr bounds))
-(defun bibtex-start-of-text-in-field (bounds)
- (cadr bounds))
-(defun bibtex-end-of-text-in-field (bounds)
- (cddr bounds))
-
-(defun bibtex-name-in-field (bounds)
- "Get content of name in BibTeX field defined via BOUNDS."
- (buffer-substring-no-properties (nth 1 (car bounds))
- (nth 2 (car bounds))))
-
-(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 (and remove-delim
- (string-match "\\`[{\"]\\(.*\\)[}\"]\\'" content))
- (substring content (match-beginning 1) (match-end 1))
- content)))
+ (if (eq bound t)
+ (setq bound (save-excursion (bibtex-beginning-of-entry))))
+ (let ((name-part (concat ",[ \t\n]*\\(" name "\\)[ \t\n]*=[ \t\n]*"))
+ (case-fold-search t) left right)
+ (save-excursion
+ ;; the parsing functions are not designed for parsing backwards :-(
+ (when (search-backward "," bound t)
+ (or (save-excursion
+ (when (looking-at name-part)
+ (setq left (list (match-beginning 0) (match-beginning 1)
+ (match-end 1)))
+ (goto-char (match-end 0))
+ (setq right (bibtex-parse-field-text))))
+ (while (and (not right)
+ (re-search-backward name-part bound t))
+ (setq left (list (match-beginning 0) (match-beginning 1)
+ (match-end 1)))
+ (save-excursion
+ (goto-char (match-end 0))
+ (setq right (bibtex-parse-field-text)))))
+ (if right (cons left right)))))))
+
+(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
+ (bibtex-start-of-name-in-field bounds)
+ (bibtex-end-of-name-in-field bounds))))
+ (if (and remove-opt-alt
+ (string-match "\\`\\(OPT\\|ALT\\)" name))
+ (substring name 3)
+ name)))
+
+(defun bibtex-text-in-field-bounds (bounds &optional content)
+ "Get text in BibTeX field defined via BOUNDS.
+If optional arg CONTENT is non-nil extract content of field
+by removing field delimiters and concatenating the resulting string.
+If `bibtex-expand-strings' is non-nil, also expand BibTeX strings."
+ (if content
+ (save-excursion
+ (goto-char (bibtex-start-of-text-in-field bounds))
+ (let ((epoint (bibtex-end-of-text-in-field bounds))
+ content opoint)
+ (while (< (setq opoint (point)) epoint)
+ (if (looking-at bibtex-field-const)
+ (let ((mtch (match-string-no-properties 0)))
+ (push (or (if bibtex-expand-strings
+ (cdr (assoc-string mtch (bibtex-strings) t)))
+ mtch) content)
+ (goto-char (match-end 0)))
+ (let ((bounds (bibtex-parse-field-string)))
+ (push (buffer-substring-no-properties
+ (1+ (car bounds)) (1- (cdr bounds))) content)
+ (goto-char (cdr bounds))))
+ (re-search-forward "\\=[ \t\n]*#[ \t\n]*" nil t))
+ (apply 'concat (nreverse content))))
+ (buffer-substring-no-properties (bibtex-start-of-text-in-field bounds)
+ (bibtex-end-of-text-in-field bounds))))
(defun bibtex-text-in-field (field &optional follow-crossref)
- "Get content of field FIELD of current BibTeX entry. Return nil if not found.
+ "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
- (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)
+ (let* ((end (if follow-crossref (bibtex-end-of-entry) t))
+ (beg (bibtex-beginning-of-entry)) ; move point
+ (bounds (bibtex-search-forward-field field end)))
+ (cond (bounds (bibtex-text-in-field-bounds bounds t))
+ ((and follow-crossref
+ (progn (goto-char beg)
+ (setq bounds (bibtex-search-forward-field
+ "\\(OPT\\)?crossref" end))))
+ (let ((crossref-field (bibtex-text-in-field-bounds bounds t)))
(if (bibtex-find-crossref crossref-field)
;; Do not pass FOLLOW-CROSSREF because we want
;; to follow crossrefs only one level of recursion.
"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."
+reference key and the end position of the match.
+If `bibtex-string-empty-key' is non-nil accept empty string key."
(let ((case-fold-search t))
- (if (looking-at "^[ \t]*@string[ \t\n]*[({][ \t\n]*")
+ (if (looking-at bibtex-string-type)
(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)))))))
+ (cond ((looking-at bibtex-reference-key)
+ (goto-char (match-end 0))
+ (list start
+ (match-beginning 0)
+ (match-end 0)))
+ ((and bibtex-string-empty-key
+ (looking-at "="))
+ (skip-chars-backward " \t\n")
+ (list start (point) (point))))))))
(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."
+character of the string entry. Move point past BibTeX string entry."
(let* ((case-fold-search t)
- (text-boundaries (bibtex-parse-field-text)))
- (when text-boundaries
- (goto-char (cdr text-boundaries))
+ (bounds (bibtex-parse-field-text)))
+ (when bounds
+ (goto-char (nth 1 bounds))
(when (looking-at "[ \t\n]*[})]")
(goto-char (match-end 0))
- (list (car text-boundaries)
- (cdr text-boundaries)
+ (list (car bounds)
+ (nth 1 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-parse-string (&optional empty-key)
+ "Parse a BibTeX string entry beginning at the position of point.
+If a syntactically correct entry is found, return a cons pair containing
+the boundaries of the reference key and text parts of the entry.
+If EMPTY-KEY is non-nil, key may be empty. Do not move point."
+ (let ((bibtex-string-empty-key empty-key))
+ (bibtex-parse-association 'bibtex-parse-string-prefix
+ 'bibtex-parse-string-postfix)))
-(defun bibtex-search-forward-string ()
+(defun bibtex-search-forward-string (&optional empty-key)
"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."
+the reference key and text parts of the string is returned.
+If EMPTY-KEY is non-nil, key may be empty. 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))))
+ (let ((case-fold-search t) bounds)
+ (while (and (not bounds)
+ (search-forward-regexp bibtex-string-type nil t))
+ (save-excursion (goto-char (match-beginning 0))
+ (setq bounds (bibtex-parse-string empty-key))))
+ bounds))))
(defun bibtex-reference-key-in-string (bounds)
+ "Return the key part of a BibTeX string defined via 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 (and remove-delim
- (string-match "\\`{\\(.*\\)}\\'" content))
- (substring content (match-beginning 1) (match-end 1))
- content)))
-
-(defun bibtex-start-of-text-in-string (bounds)
+(defun bibtex-text-in-string (bounds &optional content)
+ "Get text in BibTeX string field defined via BOUNDS.
+If optional arg CONTENT is non-nil extract content
+by removing field delimiters and concatenating the resulting string.
+If `bibtex-expand-strings' is non-nil, also expand BibTeX strings."
+ (bibtex-text-in-field-bounds bounds content))
+
+(defsubst bibtex-start-of-text-in-string (bounds)
(nth 0 (cdr bounds)))
-(defun bibtex-end-of-text-in-string (bounds)
+(defsubst bibtex-end-of-text-in-string (bounds)
(nth 1 (cdr bounds)))
-(defun bibtex-end-of-string (bounds)
+(defsubst bibtex-end-of-string (bounds)
(nth 2 (cdr bounds)))
-(defun bibtex-type-in-head ()
+(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)))
-(defun bibtex-key-in-head (&optional empty)
- "Extract BibTeX key in head. Return optional arg EMPTY if key is empty."
- (if (match-beginning bibtex-key-in-head)
- (buffer-substring-no-properties (match-beginning bibtex-key-in-head)
- (match-end bibtex-key-in-head))
- empty))
+(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))
+
+(defun bibtex-parse-preamble ()
+ "Parse BibTeX preamble.
+Point must be at beginning of preamble. Do not move point."
+ (let ((case-fold-search t))
+ (when (looking-at bibtex-preamble-prefix)
+ (let ((start (match-beginning 0)) (pref-start (match-beginning 1))
+ (bounds (save-excursion (goto-char (match-end 0))
+ (bibtex-parse-string-postfix))))
+ (if bounds (cons (list start pref-start) bounds))))))
;; Helper Functions
+(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]+")
(defun bibtex-current-line ()
"Compute line number of point regardless whether the buffer is narrowed."
(+ (count-lines 1 (point))
- (if (equal (current-column) 0) 1 0)))
-
-(defun bibtex-member-of-regexp (string list)
- "Return non-nil if STRING is exactly matched by an element of LIST.
-The value is actually the tail of LIST whose car matches STRING."
- (let (case-fold-search)
- (while (and list
- (not (string-match (concat "\\`\\(?:" (car list) "\\)\\'") string)))
- (setq list (cdr list)))
- list))
-
-(defun bibtex-assoc-of-regexp (string alist)
- "Return non-nil if STRING is exactly matched by the car of an
-element of ALIST (case ignored). The value is actually the element
-of LIST whose car matches STRING."
- (let ((case-fold-search t))
- (while (and alist
- (not (string-match (concat "\\`\\(?:" (caar alist) "\\)\\'") string)))
- (setq alist (cdr alist)))
- (car alist)))
+ (if (bolp) 1 0)))
+
+(defun bibtex-valid-entry (&optional empty-key)
+ "Parse a valid BibTeX entry (maybe without key if EMPTY-KEY is t).
+A valid entry is a syntactical correct one with type contained in
+`bibtex-entry-field-alist'. Ignore @String and @Preamble entries.
+Return a cons pair with buffer positions of beginning and end of entry
+if a valid entry is found, nil otherwise. Do not move point.
+After a call to this function `match-data' corresponds to the header
+of the entry, see regexp `bibtex-entry-head'."
+ (let ((case-fold-search t) end)
+ (if (looking-at (if empty-key bibtex-entry-maybe-empty-head
+ bibtex-entry-head))
+ (save-excursion
+ (save-match-data
+ (goto-char (match-end 0))
+ (let ((entry-closer
+ (if (save-excursion
+ (goto-char (match-end bibtex-type-in-head))
+ (looking-at "[ \t]*("))
+ ",?[ \t\n]*)" ; entry opened with `('
+ ",?[ \t\n]*}")) ; entry opened with `{'
+ bounds)
+ (skip-chars-forward " \t\n")
+ ;; loop over all BibTeX fields
+ (while (setq bounds (bibtex-parse-field))
+ (goto-char (bibtex-end-of-field bounds)))
+ ;; This matches the infix* part.
+ (if (looking-at entry-closer) (setq end (match-end 0)))))
+ (if end (cons (match-beginning 0) end))))))
(defun bibtex-skip-to-valid-entry (&optional backward)
- "Unless at beginning of a valid BibTeX entry, move point to beginning of the
-next valid one. With optional argument BACKWARD non-nil, move backward to
-beginning of previous valid one. A valid entry is a syntactical correct one
+ "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 if a valid entry is found, nil otherwise."
+entry. Return buffer position of beginning and end of entry if a valid
+entry is found, nil otherwise."
+ (interactive "P")
(let ((case-fold-search t)
- found)
- (while (and (not found)
- (not (if backward (bobp) (eobp))))
- (let ((pnt (point)))
- (cond ((or (and (looking-at bibtex-valid-entry-re)
- (bibtex-search-entry nil nil t)
- (equal (match-beginning 0) pnt))
- (and (not bibtex-sort-ignore-string-entries)
- (bibtex-parse-string)))
- (setq found pnt)
- (goto-char pnt))
- (backward
- (goto-char (1- pnt))
- (if (re-search-backward "^[ \t]*\\(@\\)" nil 'move)
- (goto-char (match-beginning 1))))
- (t (goto-char (1+ pnt))
- (if (re-search-forward "^[ \t]*@" nil 'move)
- (forward-char -1))))))
+ found bounds)
+ (beginning-of-line)
+ ;; Loop till we look at a valid entry.
+ (while (not (or found (if backward (bobp) (eobp))))
+ (cond ((setq found (or (bibtex-valid-entry)
+ (and (not bibtex-sort-ignore-string-entries)
+ (setq bounds (bibtex-parse-string))
+ (cons (bibtex-start-of-field bounds)
+ (bibtex-end-of-string bounds))))))
+ (backward (re-search-backward "^[ \t]*@" nil 'move))
+ (t (if (re-search-forward "\n\\([ \t]*@\\)" nil 'move)
+ (goto-char (match-beginning 1))))))
found))
(defun bibtex-map-entries (fun)
- "Call FUN for each BibTeX entry starting with the current.
-Do this to the end of the file. FUN is called with one argument, the key
-of the entry, and with point inside the entry.
-If `bibtex-sort-ignore-string-entries' is non-nil, FUN will not be
-called for @String entries."
- (let ((case-fold-search t))
- (bibtex-beginning-of-entry)
- (while (re-search-forward bibtex-entry-maybe-empty-head nil t)
- (save-excursion
- (let ((entry-type (downcase (bibtex-type-in-head)))
- (key (bibtex-key-in-head "")))
- (if (or (and (not bibtex-sort-ignore-string-entries)
- (string-equal "string" entry-type))
- (assoc-ignore-case entry-type bibtex-entry-field-alist))
- (funcall fun key))))
- (bibtex-end-of-entry))))
+ "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 of beginning and end of entry. Also, point is at beginning of
+entry and `match-data' corresponds to the header of the entry,
+see regexp `bibtex-entry-head'. If `bibtex-sort-ignore-string-entries'
+is non-nil, FUN is not called for @String entries."
+ (let ((case-fold-search t)
+ found)
+ (save-excursion
+ (goto-char (point-min))
+ (while (setq found (bibtex-skip-to-valid-entry))
+ (looking-at bibtex-any-entry-maybe-empty-head)
+ (funcall fun (bibtex-key-in-head "") (car found) (cdr found))
+ (goto-char (cdr found))))))
(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 absent, a message is echoed if point was incremented
-at least INTERVAL percent since last message was echoed."
+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)
- (setq bibtex-progress-interval (or interval 5)
+ (setq bibtex-progress-lastmes flag
+ bibtex-progress-interval (or interval 5)
bibtex-progress-lastperc 0))
- ((equal flag 'done)
+ ((eq flag 'done)
(message "%s (done)" bibtex-progress-lastmes)
(setq bibtex-progress-lastmes nil))
(t
(defun bibtex-field-left-delimiter ()
"Return a string dependent on `bibtex-field-delimiters'."
- (if (equal bibtex-field-delimiters 'braces)
+ (if (eq bibtex-field-delimiters 'braces)
"{"
"\""))
(defun bibtex-field-right-delimiter ()
"Return a string dependent on `bibtex-field-delimiters'."
- (if (equal bibtex-field-delimiters 'braces)
+ (if (eq bibtex-field-delimiters 'braces)
"}"
"\""))
(defun bibtex-entry-left-delimiter ()
- "Return a string dependent on `bibtex-field-delimiters'."
- (if (equal bibtex-entry-delimiters 'braces)
+ "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-field-delimiters'."
- (if (equal bibtex-entry-delimiters 'braces)
+ "Return a string dependent on `bibtex-entry-delimiters'."
+ (if (eq bibtex-entry-delimiters 'braces)
"}"
")"))
-(defun bibtex-search-entry (empty-head &optional bound noerror backward)
- "A helper function necessary since the failure stack size limit for
-regexps was reduced in emacs 19.32.
-It searches for a BibTeX entry (maybe without a reference key if
-EMPTY-HEAD is t).
-BOUND and NOERROR are exactly as in `re-search-forward'. If
-BACKWARD is non-nil, search is done in reverse direction. 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))
- (prefix (if empty-head
- bibtex-entry-maybe-empty-head
- bibtex-entry-head)))
- (if backward
- (let (found)
- (while (and (not found)
- (re-search-backward prefix bound noerror))
- (setq found (bibtex-search-entry empty-head pnt t)))
- (if found
- (goto-char (match-beginning 0))
- (cond ((equal noerror nil)
- ;; yell
- (error "Search of BibTeX entry failed"))
- ((equal noerror t)
- ;; don't move
- (goto-char pnt)))
- nil))
- (let ((limit (or bound (point-max)))
- found)
- (while (and (not found)
- (re-search-forward prefix 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" limit)
- (if (and (setq bounds (bibtex-parse-field bibtex-field-name))
- (<= (bibtex-end-of-field bounds) limit))
- (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) limit))
- (goto-char (match-end 0))
- (setq found t)))))
- (if found
- (point)
- (cond ((not noerror)
- ;; yell
- (error "Search of BibTeX entry failed"))
- ((equal noerror t)
- ;; don't move
- (goto-char pnt)))
- nil)))))
-
-(defun bibtex-flash-head ()
+(defun bibtex-flash-head (prompt)
"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 (e-t)
- "Make an optional field named E-T in current BibTeX entry."
- (if (consp e-t)
- (bibtex-make-field (cons (concat "OPT" (car e-t)) (cdr e-t)))
- (bibtex-make-field (concat "OPT" e-t))))
+ (pnt (point)))
+ (save-excursion
+ (bibtex-beginning-of-entry)
+ (when (and (looking-at bibtex-any-entry-maybe-empty-head)
+ (< (point) pnt))
+ (goto-char (match-beginning bibtex-type-in-head))
+ (if (pos-visible-in-window-p (point))
+ (sit-for blink-matching-delay)
+ (message "%s%s" prompt (buffer-substring-no-properties
+ (point) (match-end bibtex-key-in-head))))))))
+
+(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)
+ (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)
- (let ((cb (char-before (1- (point)))))
- (unless (and cb (= ?\n cb))
- (re-search-forward "^[ \t]*[@\n]" nil 'move)
- (backward-char 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."
+ "Go to beginning of line of first BibTeX entry in buffer.
+If `bibtex-sort-ignore-string-entries' is non-nil, @String entries
+are ignored. 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))
+ (bibtex-skip-to-valid-entry)
(point))
-(defun bibtex-inside-field ()
- "Try to avoid point being at end of a BibTeX field."
- (end-of-line)
- (skip-chars-backward " \t")
- (cond ((= (preceding-char) ?,)
- (forward-char -2)))
- (cond ((or (= (preceding-char) ?})
- (= (preceding-char) ?\"))
- (forward-char -1))))
-
-(defun bibtex-enclosing-field (&optional noerr)
- "Search for BibTeX field enclosing point. Point moves to end of field.
-Use `match-beginning' and `match-end' to parse the field. If NOERR is non-nil,
-no error is signalled. In this case, bounds are returned on success,
-nil otherwise."
- (let* ((case-fold-search t)
- (old-point (point))
- (boe (save-excursion (bibtex-beginning-of-entry)))
- (bounds (bibtex-search-backward-field bibtex-field-name boe)))
- (if (and bounds
- (<= (bibtex-start-of-field bounds) old-point)
- (>= (bibtex-end-of-field bounds) old-point))
- bounds
- (unless noerr
- (error "Can't find enclosing BibTeX field")))))
-
-(defun bibtex-enclosing-entry-maybe-empty-head ()
- "Search for BibTeX entry enclosing point. Point moves 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)
- (error "Can't find enclosing BibTeX entry")
- (goto-char old-point))
- (goto-char (match-beginning bibtex-type-in-head))
- (unless (bibtex-search-entry t nil t)
- (error "Can't find enclosing BibTeX entry")
- (goto-char old-point))))
-
-(defun bibtex-insert-current-kill (n)
- (if (not bibtex-last-kill-command)
- (error "BibTeX kill ring is empty")
- (let* ((kr (if (equal bibtex-last-kill-command 'field)
- 'bibtex-field-kill-ring
- 'bibtex-entry-kill-ring))
- (kryp (if (equal bibtex-last-kill-command 'field)
- 'bibtex-field-kill-ring-yank-pointer
- 'bibtex-entry-kill-ring-yank-pointer))
- (ARGth-kill-element (nthcdr (mod (- n (length (eval kryp)))
- (length (eval kr)))
- (eval kr)))
- (current (car (set kryp ARGth-kill-element))))
- (cond
- ((equal bibtex-last-kill-command 'field)
- (let (bibtex-help-message)
- (bibtex-find-text nil t)
- (if (looking-at "[}\"]")
- (forward-char)))
- (set-mark (point))
- (message "Mark set")
- (bibtex-make-field (list (elt current 1) nil (elt current 2)) t))
- ((equal bibtex-last-kill-command 'entry)
- (if (not (eobp))
- (bibtex-beginning-of-entry))
- (set-mark (point))
- (message "Mark set")
- (insert (elt current 1)))
- (t
- (error "Unknown tag field: %s. Please submit a bug report"
- bibtex-last-kill-command))))))
+(defun bibtex-enclosing-field (&optional comma noerr)
+ "Search for BibTeX field enclosing point.
+For `bibtex-mode''s internal algorithms, a field begins at the comma
+following the preceding field. Usually, this is not what the user expects.
+Thus if COMMA is non-nil, the \"current field\" includes the terminating comma.
+Unless NOERR is non-nil, signal an error if no enclosing field is found.
+On success return bounds, nil otherwise. Do not move point."
+ (save-excursion
+ (when comma
+ (end-of-line)
+ (skip-chars-backward " \t")
+ (if (= (preceding-char) ?,) (forward-char -1)))
+
+ (let ((bounds (bibtex-search-backward-field bibtex-field-name t)))
+ (cond ((and bounds
+ (<= (bibtex-start-of-field bounds) (point))
+ (>= (bibtex-end-of-field bounds) (point)))
+ bounds)
+ ((not noerr)
+ (error "Can't find enclosing BibTeX field"))))))
+
+(defun bibtex-beginning-first-field (&optional beg)
+ "Move point to beginning of first field.
+Optional arg BEG is beginning of entry."
+ (if beg (goto-char beg) (bibtex-beginning-of-entry))
+ (looking-at bibtex-any-entry-maybe-empty-head)
+ (goto-char (match-end 0)))
+
+(defun bibtex-insert-kill (n &optional comma)
+ "Reinsert the Nth stretch of killed BibTeX text (field or entry).
+Optional arg COMMA is as in `bibtex-enclosing-field'."
+ (unless bibtex-last-kill-command (error "BibTeX kill ring is empty"))
+ (let ((fun (lambda (kryp kr) ; adapted from `current-kill'
+ (car (set kryp (nthcdr (mod (- n (length (eval kryp)))
+ (length kr)) kr))))))
+ (if (eq bibtex-last-kill-command 'field)
+ (progn
+ ;; insert past the current field
+ (goto-char (bibtex-end-of-field (bibtex-enclosing-field comma)))
+ (push-mark)
+ (bibtex-make-field (funcall fun 'bibtex-field-kill-ring-yank-pointer
+ bibtex-field-kill-ring) t nil t))
+ ;; insert past the current entry
+ (bibtex-skip-to-valid-entry)
+ (push-mark)
+ (insert (funcall fun 'bibtex-entry-kill-ring-yank-pointer
+ bibtex-entry-kill-ring)))))
(defun bibtex-format-entry ()
"Helper function for `bibtex-clean-entry'.
(save-restriction
(bibtex-narrow-to-entry)
(let ((case-fold-search t)
- (format (if (equal bibtex-entry-format 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 creq field-done field-list)
+ entry-list req-field-list field-list)
+
+ ;; Initialize `bibtex-field-braces-opt' and `bibtex-field-strings-opt'
+ ;; if necessary.
+ (unless bibtex-field-braces-opt
+ (setq bibtex-field-braces-opt
+ (bibtex-field-re-init bibtex-field-braces-alist 'braces)))
+ (unless bibtex-field-strings-opt
+ (setq bibtex-field-strings-opt
+ (bibtex-field-re-init bibtex-field-strings-alist 'strings)))
;; identify entry type
(goto-char (point-min))
- (re-search-forward bibtex-entry-type)
+ (or (re-search-forward bibtex-entry-type nil t)
+ (error "Not inside a BibTeX entry"))
(let ((beg-type (1+ (match-beginning 0)))
(end-type (match-end 0)))
- (setq entry-list (assoc-ignore-case (buffer-substring-no-properties
- beg-type end-type)
- bibtex-entry-field-alist)
- req (nth 0 (nth 1 entry-list)) ; required part
- creq (nth 0 (nth 2 entry-list))) ; crossref part
+ (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)
;; determine if entry has crossref field and if at least
;; one alternative is non-empty
(goto-char (point-min))
- (while (setq bounds (bibtex-search-forward-field
- bibtex-field-name))
- (goto-char (bibtex-start-of-name-in-field bounds))
- (cond ((looking-at "ALT")
- (setq alternatives-there t)
- (goto-char (bibtex-start-of-text-in-field bounds))
- (if (not (looking-at bibtex-empty-field-re))
- (setq non-empty-alternative t)))
- ((and (looking-at "\\(OPT\\)?crossref\\>")
- (progn (goto-char (bibtex-start-of-text-in-field bounds))
- (not (looking-at bibtex-empty-field-re))))
- (setq crossref-key
- (bibtex-text-in-field-bounds bounds t))))
- (goto-char (bibtex-end-of-field bounds)))
+ (let* ((fields-alist (bibtex-parse-entry t))
+ (field (assoc-string "crossref" fields-alist t)))
+ (setq crossref-key (and field
+ (not (equal "" (cdr field)))
+ (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 (equal "" (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))
+ (bibtex-beginning-first-field (point-min))
+ (while (setq bounds (bibtex-parse-field))
(let* ((beg-field (copy-marker (bibtex-start-of-field bounds)))
- (end-field (copy-marker (bibtex-end-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)))
+ (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))))
+ (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-field end-field)))
+ (empty-field (equal "" (bibtex-text-in-field-bounds bounds t)))
deleted)
;; We have more elegant high-level functions for several
- ;; tasks done by bibtex-format-entry. However, they contain
+ ;; 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.
-
- (when (and opt-alt
- (memq 'opts-or-alts format))
- (if empty-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.
- (progn (delete-region beg-field end-field)
- (setq deleted t))
- ;; otherwise: not empty, delete "OPT" or "ALT"
- (goto-char beg-name)
- (delete-char 3)))
+ ;; 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)
;; update page dashes
(if (and (memq 'page-dashes format)
- (string-match "\\`\\(OPT\\)?pages\\'" field-name)
+ (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 crossrefed entry
+ ;; remove whitespace at beginning and end of field
+ (when (memq 'whitespace format)
+ (goto-char beg-text)
+ (if (looking-at "\\([{\"]\\)[ \t\n]+")
+ (replace-match "\\1"))
+ (goto-char end-text)
+ (if (looking-back "[ \t\n]+\\([}\"]\\)" beg-text t)
+ (replace-match "\\1")))
+
+ ;; enclose field text by braces according to
+ ;; `bibtex-field-braces-alist'.
+ (let (case-fold-search temp) ; Case-sensitive search
+ (when (and (memq 'braces format)
+ (setq temp (cdr (assoc-string field-name
+ bibtex-field-braces-opt t))))
+ (goto-char beg-text)
+ (while (re-search-forward temp end-text t)
+ (let ((beg (match-beginning 0))
+ (bounds (bibtex-find-text-internal nil t)))
+ (unless (or (nth 4 bounds) ; string constant
+ ;; match already surrounded by braces
+ ;; (braces are inside field delimiters)
+ (and (< (point) (1- (nth 2 bounds)))
+ (< (1+ (nth 1 bounds)) beg)
+ (looking-at "}")
+ (save-excursion (goto-char (1- beg))
+ (looking-at "{"))))
+ (insert "}")
+ (goto-char beg)
+ (insert "{")))))
+
+ ;; replace field text by BibTeX string constants according to
+ ;; `bibtex-field-strings-alist'.
+ (when (and (memq 'strings format)
+ (setq temp (cdr (assoc-string field-name
+ bibtex-field-strings-opt t))))
+ (goto-char beg-text)
+ (dolist (re temp)
+ (while (re-search-forward (car re) end-text t)
+ (let ((bounds (save-match-data
+ (bibtex-find-text-internal nil t))))
+ (unless (nth 4 bounds)
+ ;; if match not at right subfield boundary...
+ (if (< (match-end 0) (1- (nth 2 bounds)))
+ (insert " # " (bibtex-field-left-delimiter))
+ (delete-char 1))
+ (replace-match (cdr re))
+ (goto-char (match-beginning 0))
+ ;; if match not at left subfield boundary...
+ (if (< (1+ (nth 1 bounds)) (match-beginning 0))
+ (insert (bibtex-field-right-delimiter) " # ")
+ (delete-backward-char 1))))))))
+
+ ;; use book title of crossref'd entry
(if (and (memq 'inherit-booktitle format)
- (equal (downcase field-name) "booktitle")
empty-field
+ (bibtex-string= field-name "booktitle")
crossref-key)
- (let ((title (save-restriction
- (widen)
- (if (bibtex-find-entry crossref-key)
- (bibtex-text-in-field "title")))))
+ (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-ignore-case field-name
- (if crossref-key creq req)))
+ (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-ignore-case
- field-name (append (nth 0 (nth 1 entry-list))
- (nth 1 (nth 1 entry-list))
- bibtex-user-optional-fields)))))
+ (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)
;; check whether all required fields are present
(if (memq 'required-fields format)
- (let (altlist (found 0))
- (dolist (fname (if crossref-key creq req))
+ (let ((found 0) altlist)
+ (dolist (fname req-field-list)
(if (nth 3 fname)
(push (car fname) altlist))
(unless (or (member (car fname) field-list)
(error "Alternative mandatory field `%s' is missing"
altlist))
((> found 1)
- (error "Alternative fields `%s' is defined %s times"
+ (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
(if (memq 'realign format)
(bibtex-fill-entry))))))
+(defun bibtex-field-re-init (regexp-alist type)
+ "Calculate optimized value for bibtex-regexp-TYPE-opt.
+This value is based on bibtex-regexp-TYPE-alist. TYPE is 'braces or 'strings.
+Return optimized value to be used by `bibtex-format-entry'."
+ (setq regexp-alist
+ (mapcar (lambda (e)
+ (list (car e)
+ (replace-regexp-in-string "[ \t\n]+" "[ \t\n]+" (nth 1 e))
+ (nth 2 e))) ; nil for 'braces'.
+ regexp-alist))
+ (let (opt-list)
+ ;; Loop over field names
+ (dolist (field (delete-dups (apply 'append (mapcar 'car regexp-alist))))
+ (let (rules)
+ ;; Collect all matches we have for this field name
+ (dolist (e regexp-alist)
+ (if (assoc-string field (car e) t)
+ (push (cons (nth 1 e) (nth 2 e)) rules)))
+ (if (eq type 'braces)
+ ;; concatenate all regexps to a single regexp
+ (setq rules (concat "\\(?:" (mapconcat 'car rules "\\|") "\\)")))
+ ;; create list of replacement rules.
+ (push (cons field rules) opt-list)))
+ opt-list))
+
\f
(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
+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)))))
(defun bibtex-autokey-get-field (field &optional change-list)
- "Get content of BibTeX field FIELD. Return empty string if not found.
+ "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
+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))
+ (let* ((bibtex-expand-strings bibtex-autokey-expand-strings)
+ (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)))))
+ 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'
-and return results as a list."
- (let ((case-fold-search t))
- (mapcar 'bibtex-autokey-demangle-name
- (split-string (bibtex-autokey-get-field
- "\\(author\\)\\|\\(editor\\)"
- bibtex-autokey-name-change-strings)
- "[ ]+and[ ]+"))))
+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 name and perform abbreviations."
+ "Get the last part from a well-formed FULLNAME and perform abbreviations."
(let* (case-fold-search
- (name (cond ((string-match "\\([A-Z][^, ]*\\)[^,]*," fullname)
+ (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
;; Strange name: we have a comma, but nothing capital
;; So we accept even lowercase names
(match-string 1 fullname))
- ((string-match "\\(\\<[a-z][^ ]* +\\)+\\([A-Z][^ ]*\\)"
+ ((string-match "\\(\\<[[:lower:]][^ ]* +\\)+\\([[:upper:]][^ ]*\\)"
fullname)
;; name is of the form "First von Last", "von Last",
;; "First von von Last", or "d'Last"
;; --> take the last token
(match-string 1 fullname))
(t (error "Name `%s' is incorrectly formed" fullname)))))
- (bibtex-autokey-abbrev
- (funcall bibtex-autokey-name-case-convert name)
- bibtex-autokey-name-length)))
+ (funcall bibtex-autokey-name-case-convert-function
+ (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."
- (let ((titlestring
+ "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
- (let ((case-fold-search t))
- (dolist (terminator bibtex-autokey-title-terminators)
- (if (string-match terminator titlestring)
- (setq titlestring (substring titlestring 0 (match-beginning 0))))))
- ;; gather words from titlestring into a list. Ignore
+ (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 (case-fold-search titlewords titlewords-extra titleword end-match
- (counter 0))
+ (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 end-match (match-end 0)
- titleword (substring titlestring
- (match-beginning 0) end-match))
- (unless (bibtex-member-of-regexp titleword
- bibtex-autokey-titleword-ignore)
- (setq titleword
- (funcall bibtex-autokey-titleword-case-convert titleword))
+ (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))
- (setq titlewords (append titlewords (list titleword)))
- (setq titlewords-extra
- (append titlewords-extra (list titleword))))
- (setq counter (1+ counter)))
- (setq titlestring (substring titlestring end-match)))
+ (<= 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 titlewords-extra)))
- (mapcar 'bibtex-autokey-demangle-title titlewords))))
+ (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 ((abbrev (bibtex-assoc-of-regexp
- titleword bibtex-autokey-titleword-abbrevs)))
- (if abbrev
- (cdr abbrev)
- (bibtex-autokey-abbrev titleword
- 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-function
+ (bibtex-autokey-abbrev titleword bibtex-autokey-titleword-length)))))
(defun bibtex-generate-autokey ()
- "Generate automatically a key from the author/editor and the title field.
-This will only work for entries where each field begins on a separate line.
-The generation algorithm works as follows:
- 1. Use the value of `bibtex-autokey-prefix-string' as a prefix.
- 2. If there is a non-empty author (preferred) or editor field,
- use it as the name part of the key.
- 3. Change any substring found in
- `bibtex-autokey-name-change-strings' to the corresponding new
- one (see documentation of this variable for further detail).
- 4. For every of at least first `bibtex-autokey-names' names in
- the name field, determine the last name. If there are maximal
- `bibtex-autokey-names' + `bibtex-autokey-names-stretch'
- names, all names are used.
- 5. From every last name, take at least `bibtex-autokey-name-length'
- characters (abort only after a consonant or at a word end).
- 6. Convert all last names according to the conversion function
- `bibtex-autokey-name-case-convert'.
- 7. 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 than are used in the name part, prepend the string
- contained in `bibtex-autokey-additional-names'.
- 8. Build the year part of the key by truncating the contents of
- the year field to the rightmost `bibtex-autokey-year-length'
- digits (useful values are 2 and 4). If the year field (or any
- other field required to generate the key) is absent, but the entry
- has a valid crossref field and the variable
+ "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.
+ Expand BibTeX strings if `bibtex-autokey-expand-strings' is non-nil.
+ 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-function'.
+ 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.
- 9. For the title part of the key change the contents of the
- title field of the entry according to
- `bibtex-autokey-titleword-change-strings' to the
- corresponding new one (see documentation of this variable for
- further detail).
-10. Abbreviate the result to the string up to (but not including)
- the first occurrence of a regexp matched by the items of
- `bibtex-autokey-title-terminators' and delete those words which
- appear in `bibtex-autokey-titleword-ignore'.
- Build the title part of the key by using at least the first
- `bibtex-autokey-titlewords' words from this
- abbreviated title. If the abbreviated title ends after
- maximal `bibtex-autokey-titlewords' +
- `bibtex-autokey-titlewords-stretch' words, all
- words from the abbreviated title are used.
-11. Convert all used titlewords according to the conversion function
- `bibtex-autokey-titleword-case-convert'.
-12. For every used title word that appears in
- `bibtex-autokey-titleword-abbrevs' use the corresponding
- abbreviation (see documentation of this variable for further
- detail).
-13. From every title word not generated by an abbreviation, take
- at least `bibtex-autokey-titleword-length' characters (abort
- only after a consonant or at a word end).
-14. Build the title part of the key by concatenating all
- abbreviated title words with the string
- `bibtex-autokey-titleword-separator' between any two.
-15. At least, to get the key, concatenate
- `bibtex-autokey-prefix-string', the name part, the year part
- and the title part with `bibtex-autokey-name-year-separator'
- between the name part and the year part if both are non-empty
- and `bibtex-autokey-year-title-separator' between the year
- part and the title part if both are non-empty. If the year
- part is empty, but not the other two parts,
- `bibtex-autokey-year-title-separator' is used as well.
-16. If the value of `bibtex-autokey-before-presentation-function'
- is non-nil, it must be a function taking one argument. This
- function is then called with the generated key as the
- argument. The return value of this function (a string) is
- used as the key.
-17. If the value of `bibtex-autokey-edit-before-use' is non-nil,
- the key is then presented in the minibuffer to the user,
- where it can be edited. The key given by the user is then
- used."
- (let* ((name-etal "")
- (namelist
- (let ((nl (bibtex-autokey-get-names))
- nnl)
- (if (or (not (numberp bibtex-autokey-names))
- (<= (length nl)
- (+ bibtex-autokey-names
- bibtex-autokey-names-stretch)))
- nl
- (setq name-etal bibtex-autokey-additional-names)
- (while (< (length nnl) bibtex-autokey-names)
- (setq nnl (append nnl (list (car nl)))
- nl (cdr nl)))
- nnl)))
- (namepart (concat (mapconcat (lambda (name) name)
- namelist
- bibtex-autokey-name-separator)
- name-etal))
- (yearfield (bibtex-autokey-get-field "year"))
- (yearpart (if (equal yearfield "")
- ""
- (substring yearfield
- (- (length yearfield)
- bibtex-autokey-year-length))))
- (titlepart (mapconcat (lambda (name) name)
- (bibtex-autokey-get-title)
- bibtex-autokey-titleword-separator))
+
+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-function'.
+ 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
- namepart
- (unless (or (equal namepart "")
- (equal yearpart ""))
+ names
+ (unless (or (equal names "")
+ (equal year ""))
bibtex-autokey-name-year-separator)
- yearpart
- (unless (or (and (equal namepart "")
- (equal yearpart ""))
- (equal titlepart ""))
+ year
+ (unless (or (and (equal names "")
+ (equal year ""))
+ (equal title ""))
bibtex-autokey-year-title-separator)
- titlepart)))
+ title)))
(if bibtex-autokey-before-presentation-function
(funcall bibtex-autokey-before-presentation-function autokey)
autokey)))
\f
-(defun bibtex-parse-keys (add verbose &optional abortable)
+(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.
-The buffer might possibly be restricted.
-Find both entry keys and crossref entries.
-If ADD is non-nil adds the new keys to `bibtex-reference-keys' instead of
-simply resetting it. If VERBOSE is non-nil gives messages about
-progress. If ABORTABLE is non-nil abort on user input.
-Return t if parsing was completed, nil if aborted."
- (let ((reference-keys (if add bibtex-reference-keys)))
+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.
+If `bibtex-parse-keys-fast' is non-nil, use fast but simplified algorithm
+for parsing BibTeX keys. If parsing fails, try to set this variable to nil."
+ (let (ref-keys crossref-keys)
(save-excursion
(save-match-data
- (goto-char (point-min))
(if verbose
(bibtex-progress-message
(concat (buffer-name) ": parsing reference keys")))
- (if (catch 'userkey
- (while (bibtex-skip-to-valid-entry)
- (if (and abortable
- (input-pending-p))
- (throw 'userkey t))
- (if verbose
- (bibtex-progress-message))
- (let ((case-fold-search t)
- key crossref-key bounds)
- (cond ((looking-at bibtex-entry-head)
- (setq key (bibtex-key-in-head))
- (let ((p (point))
- (m (bibtex-end-of-entry)))
- (goto-char p)
- (if (setq bounds (bibtex-search-forward-field "crossref" m))
- (setq crossref-key (bibtex-text-in-field-bounds bounds t)))))
- ((setq bounds (bibtex-parse-string))
- (setq key (bibtex-reference-key-in-string bounds))))
- (forward-char)
- (unless (assoc key reference-keys)
- (push (list key) reference-keys))
- (if (and crossref-key
- (not (assoc crossref-key reference-keys)))
- (push (list crossref-key) reference-keys)))))
- ;; user has aborted by typing a key --> return nil
- nil
- ;; successful operation --> return t
- (setq bibtex-reference-keys 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))
- t)))))
+ ;; successful operation --> return `bibtex-reference-keys'
+ (setq bibtex-reference-keys ref-keys))))))
-(defun bibtex-parse-strings (&optional init abortable)
+(defun bibtex-parse-strings (&optional add abortable)
"Set `bibtex-strings' to the string definitions in the whole buffer.
-The buffer might possibly be restricted.
-Optional arg INIT is used to initialize `bibtex-strings'.
-If ABORTABLE is non-nil abort on user input.
-Return t if parsing was completed, nil if aborted."
+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 init)
+ (let ((strings (if (and add
+ (listp bibtex-strings))
+ bibtex-strings))
bounds key)
- (if (catch 'userkey
- (while (setq bounds (bibtex-search-forward-string))
- (if (and abortable
- (input-pending-p))
- (throw 'userkey t))
- (setq key (bibtex-reference-key-in-string bounds))
- (if (not (assoc-ignore-case key strings))
- (push (cons key (bibtex-text-in-string bounds t))
- strings))
- (goto-char (bibtex-end-of-text-in-string bounds))))
- ;; user has aborted by typing a key --> return nil
- nil
- ;; successful operation --> return t
- (setq bibtex-strings strings)
- t)))))
+ (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-strings ()
+ "Return `bibtex-strings'. Initialize this variable if necessary."
+ (if (listp bibtex-strings) bibtex-strings
+ (bibtex-parse-strings (bibtex-string-files-init))))
(defun bibtex-string-files-init ()
"Return initialization for `bibtex-strings'.
-Use `bibtex-predefined-strings' and bib files `bibtex-string-files'."
+Use `bibtex-predefined-strings' and BibTeX files `bibtex-string-files'."
(save-match-data
- ;; collect pathnames
- (let ((dirlist (split-string (or bibtex-string-file-path ".")
+ (let ((dirlist (split-string (or bibtex-string-file-path default-directory)
":+"))
(case-fold-search)
- compl)
+ 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
- (let (fullfilename bounds found)
+ (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)))
- ;; file was found
- (with-temp-buffer
- (insert-file-contents fullfilename)
- (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))))
+ (push fullfilename string-files)
(setq found t)))
(unless found
- (error "File %s not in paths defined by bibtex-string-file-path variable"
+ (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 ()
- "Called by `bibtex-run-with-idle-timer'. Whenever emacs has been idle
-for `bibtex-parse-keys-timeout' seconds, all BibTeX buffers (starting
-with the current) are parsed."
+ "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)))
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 (if bibtex-maintain-sorted-entries
- (bibtex-parse-keys nil nil t)
- t)
- ;; update bibtex-strings
- (bibtex-parse-strings strings-init t))
+ ;; 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 one
-string defined in list COMPLETIONS. If point is not after the part
-of a word, all strings are listed. Return completion."
+ "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."
+ ;; Return value is used by cleanup functions.
+ ;; Code inspired by `lisp-complete-symbol'.
(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)))
+ (pattern (buffer-substring-no-properties beg end))
+ (completion (try-completion pattern completions)))
(cond ((not completion)
- (error "Can't find completion for `%s'" part-of-word))
+ (error "Can't find completion for `%s'" pattern))
((eq completion t)
- part-of-word)
- ((not (string= part-of-word completion))
+ pattern)
+ ((not (string= pattern completion))
(delete-region beg end)
(insert completion)
+ ;; Don't leave around a completions buffer that's out of date.
+ (let ((win (get-buffer-window "*Completions*" 0)))
+ (if win (with-selected-window win (bury-buffer))))
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")
+ (let ((minibuf-is-in-use
+ (eq (minibuffer-window) (selected-window))))
+ (unless minibuf-is-in-use (message "Making completion list..."))
+ (with-output-to-temp-buffer "*Completions*"
+ (display-completion-list
+ (sort (all-completions pattern completions) 'string<) pattern))
+ (unless minibuf-is-in-use
+ (message "Making completion list...done")))
nil))))
-(defun bibtex-complete-string-cleanup (str)
- "Remove enclosing field delimiters."
- (let ((pair (assoc str bibtex-strings)))
- (when pair
- (if (cdr pair)
- (message "Abbreviation for `%s'" (cdr pair)))
- (save-excursion
- (bibtex-inside-field)
- (let ((bounds (bibtex-enclosing-field)))
- (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-choose-completion-string (choice buffer mini-p base-size)
- ;; Code borrowed from choose-completion-string:
- ;; We must duplicate the code from choose-completion-string
- ;; because it runs the hook choose-completion-string-functions
- ;; before it inserts the completion. But we want to do something
- ;; after the completion has been inserted.
- ;;
- ;; Insert the completion into the buffer where it was requested.
- (set-buffer buffer)
- (if base-size
- (delete-region (+ base-size (point-min))
- (point))
- ;; Delete the longest partial match for CHOICE
- ;; that can be found before point.
- (choose-completion-delete-max-match choice))
- (insert choice)
- (remove-text-properties (- (point) (length choice)) (point)
- '(mouse-face nil))
- ;; Update point in the window that BUFFER is showing in.
- (let ((window (get-buffer-window buffer t)))
- (set-window-point window (point))))
+(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."
+ ;; point is at position inside field where completion was requested
+ (save-excursion
+ (let ((abbr (cdr (if (stringp str)
+ (assoc-string str compl t)))))
+ (if abbr (message "Abbreviation for `%s'" abbr))
+ (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)))))
+
+(defun bibtex-copy-summary-as-kill (&optional arg)
+ "Push summery of current BibTeX entry to kill ring.
+Use `bibtex-summary-function' to generate summary.
+If prefix ARG is non-nil push BibTeX entry's URL to kill ring
+that is generated by calling `bibtex-url'."
+ (interactive "P")
+ (if arg (let ((url (bibtex-url nil t)))
+ (if url (kill-new (message "%s" url))
+ (message "No URL known")))
+ (save-excursion
+ (bibtex-beginning-of-entry)
+ (if (looking-at bibtex-entry-maybe-empty-head)
+ (kill-new (message "%s" (funcall bibtex-summary-function)))
+ (error "No entry found")))))
+
+(defun bibtex-summary ()
+ "Return summary of current BibTeX entry.
+Used as default value of `bibtex-summary-function'."
+ ;; It would be neat to make this function customizable. How?
+ (if (looking-at bibtex-entry-maybe-empty-head)
+ (let* ((bibtex-autokey-name-case-convert-function '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-function '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 "Entry not found")))
(defun bibtex-pop (arg direction)
- "Generic function to be used by `bibtex-pop-previous' and `bibtex-pop-next'."
- (let (bibtex-help-message)
- (bibtex-find-text nil))
- (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))
- (start-name (bibtex-start-of-name-in-field bounds))
- (stop-name (bibtex-end-of-name-in-field bounds))
- ;; construct regexp for field with same name as this one,
- ;; ignoring possible OPT's or ALT's
- (field-name (progn
- (goto-char start-name)
- (buffer-substring-no-properties
- (if (looking-at "\\(OPT\\)\\|\\(ALT\\)")
- (match-end 0)
- (point))
- stop-name))))
+ "Fill current field from the ARGth same field's text in DIRECTION.
+Generic function used by `bibtex-pop-previous' and `bibtex-pop-next'."
+ ;; parse current field
+ (let* ((bounds (bibtex-enclosing-field t))
+ (start-old-field (bibtex-start-of-field bounds))
+ (start-old-text (bibtex-start-of-text-in-field bounds))
+ (end-old-text (bibtex-end-of-text-in-field bounds))
+ (field-name (bibtex-name-in-field bounds t))
+ failure)
+ (save-excursion
;; 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)
+ (cond ((eq last-command 'bibtex-pop)
+ (goto-char (if (eq direction 'previous)
+ bibtex-pop-previous-search-point
+ bibtex-pop-next-search-point)))
+ ((eq direction 'previous)
+ (bibtex-beginning-of-entry))
+ (t (bibtex-end-of-entry)))
+ ;; Search for arg'th previous/next similar field
+ (while (and (not failure)
+ (>= (setq arg (1- arg)) 0))
+ ;; The search of BibTeX fields is not bounded by entry boundaries
+ (if (eq direction 'previous)
+ (if (setq bounds (bibtex-search-backward-field field-name))
+ (goto-char (bibtex-start-of-field bounds))
+ (setq failure t))
+ (if (setq bounds (bibtex-search-forward-field field-name))
+ (goto-char (bibtex-end-of-field bounds))
+ (setq failure t))))
+ (if failure
+ (error "No %s matching BibTeX field"
+ (if (eq direction 'previous) "previous" "next"))
+ ;; Found a matching field. Remember boundaries.
+ (let ((new-text (bibtex-text-in-field-bounds bounds))
+ (nbeg (copy-marker (bibtex-start-of-field bounds)))
+ (nend (copy-marker (bibtex-end-of-field bounds))))
+ (bibtex-flash-head "From: ")
;; 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 nil))
+ (goto-char end-old-text)
+ (delete-region start-old-text end-old-text)
+ (if (= nbeg start-old-field)
+ (insert (bibtex-field-left-delimiter)
+ (bibtex-field-right-delimiter))
+ (insert new-text))
+ (setq bibtex-pop-previous-search-point (marker-position nbeg)
+ bibtex-pop-next-search-point (marker-position nend))))))
+ (bibtex-find-text nil nil nil t)
(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 &optional no-button)
+ "Font-lock for URLs. BOUND limits the search.
+If NO-BUTTON is non-nil do not generate buttons."
+ (let ((case-fold-search t)
+ (pnt (point))
+ name bounds start end found)
+ (bibtex-beginning-of-field)
+ (while (and (not found)
+ (<= (point) bound)
+ (prog1 (re-search-forward bibtex-font-lock-url-regexp bound t)
+ (setq name (match-string-no-properties 1)))
+ (setq bounds (bibtex-parse-field-text))
+ (progn
+ (setq start (car bounds) end (nth 1 bounds))
+ ;; Always ignore field delimiters
+ (if (memq (char-before end) '(?\} ?\"))
+ (setq end (1- end)))
+ (if (memq (char-after start) '(?\{ ?\"))
+ (setq start (1+ start)))
+ (if (< start pnt) (setq start (min pnt end)))
+ (<= start bound)))
+ (if (<= pnt start)
+ (let ((lst bibtex-generate-url-list) url)
+ (while (and (not found) (setq url (car (pop lst))))
+ (goto-char start)
+ (setq found (and (bibtex-string= name (car url))
+ (re-search-forward (cdr url) end t))))))
+ (unless found (goto-char end)))
+ (if (and found (not no-button))
+ (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-font-lock-cite (matcher bound)
+ "Font-lock for cited keys.
+MATCHER identifies the cited key, see `bibtex-cite-matcher-alist'.
+BOUND limits the search."
+ (let (case-fold-search)
+ (if (re-search-forward (car matcher) bound t)
+ (let ((start (match-beginning (cdr matcher)))
+ (end (match-end (cdr matcher))))
+ (bibtex-button start end 'bibtex-find-crossref
+ (buffer-substring-no-properties start end)
+ start t t)
+ t))))
+
+(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))
+
\f
;; Interactive Functions:
General information on working with BibTeX mode:
-You should use commands as \\[bibtex-Book] to get a template for a
-specific entry. You should 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, you should clean the new entry
-with command \\[bibtex-clean-entry].
+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 variable
-`bibtex-maintain-sorted-entries' to t. However, then BibTeX mode will
-work with buffer containing only valid (syntactical correct) entries
-and with entries being sorted. This is usually the case, if you have
-created a buffer completely with BibTeX mode and finished every new
-entry with \\[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 buffers, please call the function
-`bibtex-convert-alien' to fully take advantage of all features of
-BibTeX mode.
+For third party BibTeX files, call the command \\[bibtex-convert-alien]
+to fully take advantage of all features of BibTeX mode.
Special information:
-A command such as \\[bibtex-Book] will outline the fields for a BibTeX book entry.
+A command such as \\[bibtex-Book] outlines the fields for a BibTeX book entry.
-The optional fields start with the string OPT, and are thus ignored by BibTeX.
-Alternatives from which only one is required start with the string ALT.
-The OPT or ALT string may be removed from a field with \\[bibtex-remove-OPT-or-ALT].
+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] will yank the last recently killed field after the
-current field.
+\\[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-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 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'.
+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'.
-Use \\[bibtex-find-text] to position the cursor at the end of the current field.
-Use \\[bibtex-next-field] to move to end of the next field.
-
-The following may be of interest as well:
-
- Functions:
- `bibtex-entry'
- `bibtex-kill-entry'
- `bibtex-yank-pop'
- `bibtex-pop-previous'
- `bibtex-pop-next'
- `bibtex-complete'
- `bibtex-print-help-message'
- `bibtex-generate-autokey'
- `bibtex-beginning-of-entry'
- `bibtex-end-of-entry'
- `bibtex-reposition-window'
- `bibtex-mark-entry'
- `bibtex-ispell-abstract'
- `bibtex-ispell-entry'
- `bibtex-narrow-to-entry'
- `bibtex-sort-buffer'
- `bibtex-validate'
- `bibtex-count'
- `bibtex-fill-entry'
- `bibtex-reformat'
- `bibtex-convert-alien'
-
- Variables:
- `bibtex-field-delimiters'
- `bibtex-include-OPTcrossref'
- `bibtex-include-OPTkey'
- `bibtex-user-optional-fields'
- `bibtex-entry-format'
- `bibtex-sort-ignore-string-entries'
- `bibtex-maintain-sorted-entries'
- `bibtex-entry-field-alist'
- `bibtex-predefined-strings'
- `bibtex-string-files'
-
----------------------------------------------------------
-Entry to BibTeX mode calls the value of `bibtex-mode-hook' if that value is
-non-nil.
+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)
(setq major-mode 'bibtex-mode)
(setq mode-name "BibTeX")
(set-syntax-table bibtex-mode-syntax-table)
- (make-local-variable 'bibtex-strings)
- (make-local-variable 'bibtex-reference-keys)
(make-local-variable 'bibtex-buffer-last-parsed-tick)
- (bibtex-parse-strings (bibtex-string-files-init))
- (if bibtex-maintain-sorted-entries
- (bibtex-parse-keys nil nil t))
;; Install stealthy parse function if not already installed
(unless bibtex-parse-idle-timer
- (setq bibtex-parse-idle-timer (bibtex-run-with-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-skip)
(concat (regexp-quote bibtex-comment-start) "\\>[ \t]*"))
(set (make-local-variable 'comment-column) 0)
- (set (make-local-variable 'defun-prompt-regexp) "^[ \t]*@[a-zA-Z0-9]+[ \t]*")
+ (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)
- ? ))
+ bibtex-contline-indentation)
+ ?\s))
(set (make-local-variable 'font-lock-defaults)
'(bibtex-font-lock-keywords
nil t ((?$ . "\"")
;; brace-delimited ones
)
nil
- (font-lock-syntactic-keywords . bibtex-font-lock-syntactic-keywords)))
- (set (make-local-variable 'font-lock-mark-block-function)
- (lambda ()
- (set-mark (bibtex-end-of-entry))
- (bibtex-beginning-of-entry)))
+ (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)))
+ (list (list nil bibtex-entry-head bibtex-key-in-head))
+ imenu-case-fold-search t)
(make-local-variable 'choose-completion-string-functions)
- (setq imenu-case-fold-search t)
- ;; XEmacs needs easy-menu-add, Emacs does not care
+ ;; XEmacs needs `easy-menu-add', Emacs does not care
(easy-menu-add bibtex-edit-menu)
(easy-menu-add bibtex-entry-menu)
- (run-hooks 'bibtex-mode-hook))
+ (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 "Fields for 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)
+ (functionp 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.
-After insertion it calls the functions in `bibtex-add-entry-hook'."
- (interactive (let* ((completion-ignore-case t)
- (e-t (completing-read
- "Entry Type: "
- bibtex-entry-field-alist
- nil t nil 'bibtex-entry-type-history)))
- (list e-t)))
- (unless (consp bibtex-reference-keys) (bibtex-parse-keys nil t))
- (let* (required
- optional
- (key (if bibtex-maintain-sorted-entries
- (completing-read (format "%s key: " entry-type)
- bibtex-reference-keys
- nil nil nil 'bibtex-key-history)))
- (e (assoc-ignore-case entry-type bibtex-entry-field-alist))
- (r-n-o (elt e 1))
- (c-ref (elt e 2)))
- (if (not e)
- (error "Bibtex entry type %s not defined" entry-type))
- (if (and (member entry-type bibtex-include-OPTcrossref)
- c-ref)
- (setq required (elt c-ref 0)
- optional (elt c-ref 1))
- (setq required (elt r-n-o 0)
- optional (elt r-n-o 1)))
+ "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))
+ (if key (insert key))
(save-excursion
- (mapcar 'bibtex-make-field required)
- (if (member entry-type bibtex-include-OPTcrossref)
- (bibtex-make-optional-field '("crossref")))
- (if bibtex-include-OPTkey
- (if (or (stringp bibtex-include-OPTkey)
- (fboundp bibtex-include-OPTkey))
- (bibtex-make-optional-field
- (list "key" nil bibtex-include-OPTkey))
- (bibtex-make-optional-field '("key"))))
- (mapcar 'bibtex-make-optional-field optional)
- (mapcar 'bibtex-make-optional-field bibtex-user-optional-fields)
+ (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-print-help-message ()
- "Print helpful information about current field in current BibTeX entry."
- (interactive)
+(defun bibtex-entry-update (&optional entry-type)
+ "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.
+Also, add field delimiters to numerical fields if they are not present.
+If ENTRY-TYPE is non-nil, change first the entry type to ENTRY-TYPE.
+When called interactively with a prefix arg, query for a value of ENTRY-TYPE."
+ (interactive
+ (list (if current-prefix-arg
+ (let ((completion-ignore-case t))
+ (completing-read "New entry type: " bibtex-entry-field-alist
+ nil t nil 'bibtex-entry-type-history)))))
(save-excursion
+ (bibtex-beginning-of-entry)
+ (when (looking-at bibtex-entry-maybe-empty-head)
+ (goto-char (match-end 0))
+ (if entry-type
+ (save-excursion
+ (replace-match (concat "@" entry-type) nil nil nil 1))
+ (setq entry-type (bibtex-type-in-head)))
+ (let* ((field-list (bibtex-field-list entry-type))
+ (required (copy-tree (car field-list)))
+ (optional (copy-tree (cdr field-list)))
+ bounds)
+ (while (setq bounds (bibtex-parse-field))
+ (let ((fname (bibtex-name-in-field bounds t))
+ (end (copy-marker (bibtex-end-of-field bounds) t)))
+ (setq required (delete (assoc-string fname required t) required)
+ optional (delete (assoc-string fname optional t) optional))
+ (when (string-match "\\`[0-9]+\\'"
+ (bibtex-text-in-field-bounds bounds))
+ (goto-char (bibtex-end-of-text-in-field bounds))
+ (insert (bibtex-field-right-delimiter))
+ (goto-char (bibtex-start-of-text-in-field bounds))
+ (insert (bibtex-field-left-delimiter)))
+ (goto-char end)))
+ (skip-chars-backward " \t\n")
+ (dolist (field required) (bibtex-make-field field))
+ (dolist (field optional) (bibtex-make-optional-field field))))))
+
+(defun bibtex-parse-entry (&optional content)
+ "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.
+If optional arg CONTENT is non-nil extract content of text fields."
+ (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))
+ (push (cons (bibtex-name-in-field bounds t)
+ (bibtex-text-in-field-bounds bounds content))
+ 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)
+ (bibtex-sort-ignore-string-entries 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))
+ (let ((text (assoc-string (bibtex-name-in-field bounds t)
+ other t)))
+ (if (not (and text
+ (equal "" (bibtex-text-in-field-bounds bounds t))))
+ (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 (&optional field comma)
+ "Print helpful information about current FIELD in current BibTeX entry.
+Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
+interactive calls."
+ (interactive (list nil t))
+ (unless field (setq field (car (bibtex-find-text-internal nil nil comma))))
+ (if (string-match "@" field)
+ (cond ((bibtex-string= field "@string")
+ (message "String definition"))
+ ((bibtex-string= field "@preamble")
+ (message "Preamble definition"))
+ (t (message "Entry key")))
(let* ((case-fold-search t)
- (bounds (bibtex-enclosing-field))
- (mb (bibtex-start-of-name-in-field bounds))
- (field-name (buffer-substring-no-properties
- (if (progn (goto-char mb)
- (looking-at "OPT\\|ALT"))
- (+ 3 mb) mb)
- (bibtex-end-of-name-in-field bounds)))
- (entry-type (progn (re-search-backward
- bibtex-entry-maybe-empty-head nil t)
- (bibtex-type-in-head)))
- (entry-list (assoc-ignore-case entry-type
- bibtex-entry-field-alist))
- (c-r-list (elt entry-list 2))
- (req-opt-list (if (and (member entry-type
- bibtex-include-OPTcrossref)
- c-r-list)
- c-r-list
- (elt entry-list 1)))
- (list-of-entries (append (elt req-opt-list 0)
- (elt req-opt-list 1)
- bibtex-user-optional-fields
- (if (member entry-type
- bibtex-include-OPTcrossref)
- '(("crossref" "Reference key of the cross-referenced entry")))
- (if bibtex-include-OPTkey
- '(("key" "Used for reference key creation if author and editor fields are missing")))))
- (comment (assoc-ignore-case field-name list-of-entries)))
- (if comment
- (message (elt comment 1))
+ (type (save-excursion
+ (bibtex-beginning-of-entry)
+ (looking-at bibtex-entry-maybe-empty-head)
+ (bibtex-type-in-head)))
+ (field-list (bibtex-field-list type))
+ (comment (assoc-string field (append (car field-list)
+ (cdr field-list)) t)))
+ (if comment (message "%s" (nth 1 comment))
(message "No comment available")))))
-(defun bibtex-make-field (e-t &optional called-by-yank)
- "Make a field named E-T in current BibTeX entry."
+(defun bibtex-make-field (field &optional move interactive nodelim)
+ "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.
+INIT is surrounded by field delimiters, unless NODELIM is non-nil."
(interactive
- (list (let* ((entry-type
- (save-excursion
- (bibtex-enclosing-entry-maybe-empty-head)
- (bibtex-type-in-head)))
- (fl (cadr (assoc-ignore-case
- entry-type bibtex-entry-field-alist)))
- (field-list (append (elt fl 0)
- (elt fl 1)
- bibtex-user-optional-fields
- (if bibtex-include-OPTcrossref
- '(("crossref" nil)))
- (if bibtex-include-OPTkey
- '(("key" nil)))))
- (completion-ignore-case t))
- (completing-read "BibTeX field name: " field-list
- nil nil nil bibtex-field-history))))
- (unless (consp e-t)
- (setq e-t (list e-t)))
- (let ((name (if (elt e-t 3)
- (concat "ALT" (car e-t))
- (car e-t))))
- (if (or (interactive-p) called-by-yank)
- (let (bibtex-help-message)
- (bibtex-find-text nil t t)
- (if (looking-at "[}\"]")
- (forward-char))))
- (insert ",\n")
- (indent-to-column (+ bibtex-entry-offset bibtex-field-indentation))
- (insert name " ")
- (if bibtex-align-at-equal-sign
- (indent-to-column (+ bibtex-entry-offset
- (- bibtex-text-indentation 2))))
- (insert "= ")
- (if (not bibtex-align-at-equal-sign)
- (indent-to-column (+ bibtex-entry-offset
- bibtex-text-indentation)))
- (insert (if called-by-yank
- ""
- (bibtex-field-left-delimiter))
- (let ((init (elt e-t 2)))
- (cond ((stringp init)
- init)
- ((fboundp init)
- (funcall init))
- (t "")))
- (if called-by-yank
- ""
- (bibtex-field-right-delimiter)))
- (if (interactive-p)
- (forward-char -1))))
+ (list (let ((completion-ignore-case t)
+ (field-list (bibtex-field-list
+ (save-excursion
+ (bibtex-beginning-of-entry)
+ (looking-at bibtex-any-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)))
+ (when move
+ (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)))
+ (if (not init) (setq init "")
+ (if (functionp init) (setq init (funcall init)))
+ (unless (stringp init) (error "`%s' is not a string" init)))
+ ;; NODELIM is required by `bibtex-insert-kill'
+ (if nodelim (insert init)
+ (insert (bibtex-field-left-delimiter) init
+ (bibtex-field-right-delimiter))))
+ (when interactive
+ ;; (bibtex-find-text nil nil bibtex-help-message)
+ (if (memq (preceding-char) '(?} ?\")) (forward-char -1))
+ (if bibtex-help-message (bibtex-print-help-message (car field)))))
(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 called from a program, this function returns the new location of point."
+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))
+ (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.
-If called from a program, this function returns the new location of point."
+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 ((setq bounds (bibtex-parse-string))
+ (pnt (point))
+ (_ (bibtex-beginning-of-entry))
+ (bounds (bibtex-valid-entry t)))
+ (cond (bounds (goto-char (cdr bounds))) ; regular entry
+ ;; @String or @Preamble
+ ((setq bounds (or (bibtex-parse-string t) (bibtex-parse-preamble)))
(goto-char (bibtex-end-of-string bounds)))
- ((looking-at "[ \t]*@[ \t]*preamble[ \t\n]*")
- (goto-char (match-end 0))
- (cond ((looking-at "(")
- (unless (re-search-forward ")[ \t]*\n\n" nil 'move)
- (setq err t)))
- ((looking-at "{")
- (unless (re-search-forward "}[ \t]*\n\n" nil 'move)
- (setq err t)))
- (t
- (setq err t)))
- (unless err
- (goto-char (match-beginning 0))
- (forward-char)))
- ((looking-at bibtex-valid-entry-whitespace-re)
- (bibtex-search-entry t nil t)
- (unless (equal (match-beginning 0) pnt)
- (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))
+ ((looking-at bibtex-any-valid-entry-type)
+ ;; Parsing of entry failed
+ (error "Syntactically incorrect BibTeX entry starts here"))
+ (t (if (interactive-p) (message "Not on a known BibTeX entry."))
+ (goto-char pnt)))
+ (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 (&optional arg)
+(defun bibtex-reposition-window ()
"Make the current BibTeX entry visible.
-Optional argument ARG is exactly as in `recenter'."
- (interactive "P")
- (save-excursion
- (goto-char
- (/ (+ (bibtex-beginning-of-entry) (bibtex-end-of-entry)) 2))
- (recenter arg)))
+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))
+ (push-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 it counts all entries,
-otherwise it counts all except Strings.
-If mark is active it counts entries in region, if not in whole buffer."
+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 (bibtex-mark-active)
- (region-beginning)
- (bibtex-beginning-of-first-entry))
- (if (bibtex-mark-active)
- (region-end)
- (point-max)))
- (goto-char (point-min))
- (bibtex-map-entries (lambda (current)
- (setq number (1+ number))))))
+ (bibtex-sort-ignore-string-entries (not count-string-entries)))
+ (save-restriction
+ (if mark-active (narrow-to-region (region-beginning) (region-end)))
+ (bibtex-map-entries (lambda (key beg end) (setq number (1+ number)))))
(message "%s contains %d entries."
- (if (bibtex-mark-active) "Region" "Buffer")
- number)))
+ (if mark-active "Region" "Buffer")
+ number)))
(defun bibtex-ispell-entry ()
- "Spell whole BibTeX entry."
+ "Check BibTeX entry for spelling errors."
(interactive)
- (ispell-region (bibtex-beginning-of-entry)
- (bibtex-end-of-entry)))
+ (ispell-region (save-excursion (bibtex-beginning-of-entry))
+ (save-excursion (bibtex-end-of-entry))))
(defun bibtex-ispell-abstract ()
- "Spell abstract of BibTeX entry."
+ "Check abstract of BibTeX entry for spelling errors."
(interactive)
- (bibtex-beginning-of-entry)
- (let ((bounds (bibtex-search-forward-field "abstract"
- (bibtex-end-of-entry))))
+ (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))
(bibtex-end-of-entry))))
(defun bibtex-entry-index ()
- "Return the index of the BibTeX entry at point. Move point.
+ "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. Return nil if no entry found."
+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))
- (entry-name (bibtex-type-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 (equal bibtex-maintain-sorted-entries 'crossref)
- (save-excursion
- (save-restriction
- (bibtex-narrow-to-entry)
- (goto-char (point-min))
- (let ((bounds (bibtex-search-forward-field
- "\\(OPT\\)?crossref")))
- (list key
- (if bounds (bibtex-text-in-field-bounds bounds t))
- entry-name))))
+ (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-init-sort-entry-class-alist ()
+ "Initialize `bibtex-sort-entry-class-alist' (buffer-local)."
+ (unless (local-variable-p 'bibtex-sort-entry-class-alist)
+ (set (make-local-variable '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)))))))
+
(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'."
+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)
- ((equal bibtex-maintain-sorted-entries 'crossref)
+ ((eq bibtex-maintain-sorted-entries 'crossref)
(if (nth 1 index1)
(if (nth 1 index2)
(or (string-lessp (nth 1 index1) (nth 1 index2))
(if (nth 1 index2)
(string-lessp (nth 0 index1) (nth 1 index2))
(string-lessp (nth 0 index1) (nth 0 index2)))))
- ((equal bibtex-maintain-sorted-entries 'entry-class)
- (let ((n1 (cdr (assoc-ignore-case (nth 2 index1)
- bibtex-sort-entry-class-alist)))
- (n2 (cdr (assoc-ignore-case (nth 2 index2)
- bibtex-sort-entry-class-alist))))
+ ((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 ; (equal bibtex-maintain-sorted-entries 'plain)
+ (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'.
-Text outside of BibTeX entries is not affected. If
-`bibtex-sort-ignore-string-entries' is non-nil, @String entries will be
-ignored."
+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)
- (unless bibtex-maintain-sorted-entries
- (error "You must choose a sorting scheme"))
- (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)
+ (bibtex-beginning-of-first-entry) ; Needed by `sort-subr'
+ (bibtex-init-sort-entry-class-alist) ; Needed by `bibtex-lessp'.
+ (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 noerror)
"Move point to the beginning of BibTeX entry CROSSREF-KEY.
-Return position of entry if CROSSREF-KEY is found and nil otherwise.
-If position of current entry is after CROSSREF-KEY an error is signaled."
- (let ((pos (save-excursion (bibtex-find-entry crossref-key))))
- (if (and pos (> (point) pos))
- (error "This entry must not follow the crossrefed entry!"))
- (goto-char pos)))
-
-(defun bibtex-find-entry (key)
- "Move point to the beginning of BibTeX entry named KEY.
-Return position of entry if KEY is found or nil if not found."
+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. If NOERRER is non-nil this error is suppressed.
+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 either the crossref key
+of current entry or a key matched by `bibtex-cite-matcher-alist',
+whatever is nearer to the position of point. SPLIT is t. NOERROR is nil
+for a crossref key, t otherwise."
(interactive
- (list (if bibtex-maintain-sorted-entries
- (completing-read "Find key: "
- bibtex-reference-keys
- nil nil nil 'bibtex-key-history)
- (read-from-minibuffer "Find key: " nil nil nil
- 'bibtex-key-history))))
- (let* (case-fold-search
- (pnt (save-excursion
- (goto-char (point-min))
- (when (re-search-forward (concat "^[ \t]*\\("
+ (save-excursion
+ (let* ((pnt (point))
+ (_ (bibtex-beginning-of-entry))
+ (end (cdr (bibtex-valid-entry t)))
+ (_ (unless end (error "Not inside valid entry")))
+ (beg (match-end 0)) ; set by `bibtex-valid-entry'
+ (bounds (bibtex-search-forward-field "crossref" end))
+ case-fold-search best temp crossref-key)
+ (if bounds
+ (setq crossref-key (bibtex-text-in-field-bounds bounds t)
+ best (cons (bibtex-dist pnt (bibtex-end-of-field bounds)
+ (bibtex-start-of-field bounds))
+ crossref-key)))
+ (dolist (matcher bibtex-cite-matcher-alist)
+ (goto-char beg)
+ (while (re-search-forward (car matcher) end t)
+ (setq temp (bibtex-dist pnt (match-end (cdr matcher))
+ (match-beginning (cdr matcher))))
+ ;; Accept the key closest to the position of point.
+ (if (or (not best) (< temp (car best)))
+ (setq best (cons temp (match-string-no-properties
+ (cdr matcher)))))))
+ (goto-char pnt)
+ (setq temp (bibtex-read-key "Find crossref key: " (cdr best) t))
+ (list temp (point) t (not (and crossref-key
+ (string= temp crossref-key)))))))
+
+ (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 (and eqb (= pos (save-excursion (bibtex-beginning-of-entry))))
+ (message "Key `%s' is current entry" crossref-key)
+ (if eqb (select-window (split-window))
+ (pop-to-buffer buffer))
+ (goto-char pos)
+ (bibtex-reposition-window)
+ (beginning-of-line)
+ (if (and eqb (> pnt pos) (not noerror))
+ (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-dist (pos beg end)
+ "Return distance between POS and region delimited by BEG and END."
+ (cond ((and (<= beg pos) (<= pos end)) 0)
+ ((< pos beg) (- beg pos))
+ (t (- pos end))))
+
+(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 t)
+ (pnt (save-excursion
+ (goto-char (or start (point-min)))
+ (if (re-search-forward (concat "^[ \t]*\\("
bibtex-entry-type
"\\)[ \t]*[({][ \t\n]*\\("
- (regexp-quote key) "\\)")
+ (regexp-quote key)
+ "\\)[ \t\n]*[,=]")
nil t)
- (match-beginning 2)))))
- (cond (pnt
- (goto-char pnt)
- (bibtex-beginning-of-entry))
- ((interactive-p)
- (message "Key `%s' not found" key)))))
+ (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 will fail if buffer is not in
-sorted order, see \\[bibtex-validate].)
+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."
+ (bibtex-init-sort-entry-class-alist) ; Needed by `bibtex-lessp'.
(let ((key (nth 0 index))
key-exist)
(cond ((or (null key)
;; 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
+ (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)))
+ (left (save-excursion (bibtex-beginning-of-first-entry)))
+ (bounds (save-excursion (goto-char (point-max))
+ (bibtex-skip-to-valid-entry t)))
+ (right (if bounds (cdr bounds) (point-min)))
(found (if (>= left right) left))
actual-index new)
(save-excursion
;; buffer contains no valid entries or
;; greater than last entry --> append
(bibtex-end-of-entry)
- (if (not (bobp))
- (newline (forward-line 2)))
+ (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.
-Only known entry types are checked, so you can put comments
-outside of entries.
-With optional argument TEST-THOROUGHLY non-nil it checks for absence of
-required fields and questionable month fields as well.
+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.
-Returns t if test was successful, nil otherwise."
+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 (bibtex-mark-active)
- (region-beginning)
- (bibtex-beginning-of-first-entry))
- (if (bibtex-mark-active)
- (region-end)
- (point-max)))
-
- ;; looking if entries fit syntactical structure
+ (if mark-active (narrow-to-region (region-beginning) (region-end)))
+
+ ;; Check syntactical structure of entries
(goto-char (point-min))
(bibtex-progress-message "Checking syntactical structure")
- (let (bibtex-sort-ignore-string-entries)
- (while (re-search-forward "^[ \t]*@" nil t)
+ (let (bounds end)
+ (while (setq end (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 (list (bibtex-current-line)
- "Syntax error (check esp. commas, braces, and quotes)")
- error-list)
- (forward-char))))))
+ (goto-char (match-beginning 0))
+ (cond ((setq bounds (bibtex-valid-entry))
+ (goto-char (cdr bounds)))
+ ((setq bounds (or (bibtex-parse-string)
+ (bibtex-parse-preamble)))
+ (goto-char (bibtex-end-of-string bounds)))
+ ((looking-at bibtex-any-valid-entry-type)
+ (push (cons (bibtex-current-line)
+ "Syntax error (check esp. commas, braces, and quotes)")
+ error-list)
+ (goto-char (match-end 0)))
+ (t (goto-char end)))))
(bibtex-progress-message 'done)
(if error-list
+ ;; Continue only if there were no syntax errors.
(setq syntax-error t)
- ;; looking for correct sort order and duplicates (only if
- ;; there were no syntax errors)
- (if bibtex-maintain-sorted-entries
- (let (previous current)
- (goto-char (point-min))
- (bibtex-progress-message "Checking correct sort order")
- (bibtex-map-entries
- (lambda (dummy)
- (bibtex-progress-message)
- (bibtex-beginning-of-entry)
- (setq current (bibtex-entry-index))
- (cond ((or (not previous)
- (bibtex-lessp previous current))
- (setq previous current))
- ((string-equal (car previous) (car current))
- (push (list (bibtex-current-line)
- "Duplicate key with previous")
- error-list))
- (t
- (setq previous current)
- (push (list (bibtex-current-line)
- "Entries out of order")
- error-list)))))
- (bibtex-progress-message 'done)))
+
+ ;; Check 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)
+ (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
- (goto-char (point-min))
(bibtex-progress-message
"Checking required fields and month fields")
- (let ((bibtex-sort-ignore-string-entries t)
- (questionable-month
- (regexp-opt (mapcar 'car bibtex-predefined-month-strings))))
+ (let ((bibtex-sort-ignore-string-entries t))
(bibtex-map-entries
- (lambda (current)
+ (lambda (key beg end)
(bibtex-progress-message)
- (let* ((beg (bibtex-beginning-of-entry))
- (end (bibtex-end-of-entry))
- (entry-list (progn
- (goto-char beg)
- (bibtex-search-entry nil end)
- (assoc-ignore-case (bibtex-type-in-head)
- bibtex-entry-field-alist)))
+ (let* ((entry-list (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)
- (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 (downcase (bibtex-name-in-field bounds)))
- case-fold-search)
- (if (and (equal field-name "month")
- (not (string-match questionable-month
- (bibtex-text-in-field-bounds bounds))))
- (push (list (bibtex-current-line)
+ crossref-there bounds alt-there field)
+ (bibtex-beginning-first-field beg)
+ (while (setq bounds (bibtex-parse-field))
+ (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 req (delete (assoc-ignore-case field-name req) req)
- creq (delete (assoc-ignore-case field-name creq) creq))
- (if (equal field-name "crossref")
- (setq crossref-there t))))
- (if crossref-there
- (setq req creq))
- (if (or (> (length req) 1)
- (and (= (length req) 1)
- (not (elt (car req) 3))))
- ;; two (or more) fields missed or one field
- ;; missed and this isn't flagged alternative
- ;; (notice that this fails if there are more
- ;; than two alternatives in a BibTeX entry,
- ;; which isn't the case momentarily)
- (push (list (save-excursion
- (bibtex-beginning-of-entry)
- (bibtex-current-line))
- (concat "Required field `" (caar req) "' missing"))
- error-list))))))
+ (setq field (assoc-string field-name req t)
+ req (delete field req)
+ creq (delete (assoc-string field-name creq t) creq))
+ (if (nth 3 field)
+ (if alt-there
+ (push (cons (bibtex-current-line)
+ "More than one non-empty alternative")
+ error-list)
+ (setq alt-there t)))
+ (if (bibtex-string= field-name "crossref")
+ (setq crossref-there t)))
+ (goto-char (bibtex-end-of-field bounds)))
+ (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 ((bufnam (buffer-name))
- (dir default-directory))
- (setq error-list
- (sort error-list
- (lambda (a b)
- (< (car a) (car b)))))
- (let ((pop-up-windows t))
- (pop-to-buffer nil t))
- (switch-to-buffer
- (get-buffer-create "*BibTeX validation errors*") t)
- ;; don't use switch-to-buffer-other-window, since this
- ;; doesn't allow the second parameter NORECORD
- (setq default-directory dir)
- (toggle-read-only -1)
- (compilation-mode)
- (delete-region (point-min) (point-max))
- (goto-char (point-min))
- (insert "BibTeX mode command `bibtex-validate'\n"
- (if syntax-error
- "Maybe undetected errors due to syntax errors. Correct and validate again."
- "")
- "\n")
- (dolist (err error-list)
- (insert bufnam ":" (number-to-string (elt err 0))
- ": " (elt err 1) "\n"))
- (compilation-parse-errors nil nil)
- (setq compilation-old-error-list compilation-error-list)
- ;; this is necessary to avoid reparsing of buffer if you
- ;; switch to compilation buffer and enter `compile-goto-error'
- (set-buffer-modified-p nil)
- (toggle-read-only 1)
- (goto-char (point-min))
- (other-window -1)
- ;; return nil
- nil)
- (if (bibtex-mark-active)
- (message "Region is syntactically correct")
- (message "Buffer is syntactically correct"))
- t)))
-
-(defun bibtex-next-field (arg)
- "Find end of text of next BibTeX field; with ARG, 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 arg t))
-
-(defun bibtex-find-text (arg &optional as-if-interactive no-error)
- "Go to end of text of current field; with ARG, go to beginning."
+ (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)
+ nil) ; return `nil' (i.e., buffer is invalid)
+ (message "%s is syntactically correct"
+ (if mark-active "Region" "Buffer"))
+ t))) ; return `t' (i.e., buffer is valid)
+
+(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")
- (bibtex-inside-field)
- (let ((bounds (bibtex-enclosing-field (or (interactive-p)
- as-if-interactive))))
- (if bounds
- (progn (if arg
- (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)))
- (beginning-of-line)
- (cond ((setq bounds (bibtex-parse-string))
- (goto-char (if arg
- (bibtex-start-of-text-in-string bounds)
- (bibtex-end-of-text-in-string bounds))))
+ (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: Duplicate 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)
+ nil) ; return `nil' (i.e., buffer is invalid)
+ (message "No duplicate keys.")
+ t))) ; return `t' (i.e., buffer is valid)
+
+(defun bibtex-next-field (begin &optional comma)
+ "Move point to end of text of next BibTeX field or entry head.
+With prefix BEGIN non-nil, move point to its beginning. Optional arg COMMA
+is as in `bibtex-enclosing-field'. It is t for interactive calls."
+ (interactive (list current-prefix-arg t))
+ (let ((bounds (bibtex-find-text-internal t nil comma))
+ end-of-entry)
+ (if (not bounds)
+ (setq end-of-entry t)
+ (goto-char (nth 3 bounds))
+ (if (assoc-string (car bounds) '("@String" "@Preamble") t)
+ (setq end-of-entry t)
+ ;; BibTeX key or field
+ (if (looking-at ",[ \t\n]*") (goto-char (match-end 0)))
+ ;; end of entry
+ (if (looking-at "[)}][ \t\n]*") (setq end-of-entry t))))
+ (if (and end-of-entry
+ (re-search-forward bibtex-any-entry-maybe-empty-head nil t))
+ (goto-char (match-beginning 0)))
+ (bibtex-find-text begin nil bibtex-help-message)))
+
+(defun bibtex-find-text (&optional begin noerror help comma)
+ "Move point to end of text of current BibTeX field or entry head.
+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. If optional arg HELP is non-nil print help message.
+When called interactively, the value of HELP is `bibtex-help-message'.
+Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
+interactive calls."
+ (interactive (list current-prefix-arg nil bibtex-help-message t))
+ (let ((bounds (bibtex-find-text-internal t nil comma)))
+ (cond (bounds
+ (if begin
+ (progn (goto-char (nth 1 bounds))
+ (if (looking-at "[{\"]")
+ (forward-char)))
+ (goto-char (nth 2 bounds))
+ (if (memq (preceding-char) '(?} ?\"))
+ (forward-char -1)))
+ (if help (bibtex-print-help-message (car bounds))))
+ ((not noerror) (error "Not on BibTeX field")))))
+
+(defun bibtex-find-text-internal (&optional noerror subfield comma)
+ "Find text part of current BibTeX field or entry head.
+Return list (NAME START-TEXT END-TEXT END STRING-CONST) with field
+or entry name, start and end of text, and end of field or entry head.
+STRING-CONST is a flag which is non-nil if current subfield delimited by #
+is a BibTeX string constant. Return value is nil if field or entry head
+are not found.
+If optional arg NOERROR is non-nil, an error message is suppressed
+if text is not found. If optional arg SUBFIELD is non-nil START-TEXT
+and END-TEXT correspond to the current subfield delimited by #.
+Optional arg COMMA is as in `bibtex-enclosing-field'."
+ (save-excursion
+ (let ((pnt (point))
+ (bounds (bibtex-enclosing-field comma t))
+ (case-fold-search t)
+ name start-text end-text end failure done no-sub string-const)
+ (bibtex-beginning-of-entry)
+ (cond (bounds
+ (setq name (bibtex-name-in-field bounds t)
+ start-text (bibtex-start-of-text-in-field bounds)
+ end-text (bibtex-end-of-text-in-field bounds)
+ end (bibtex-end-of-field bounds)))
+ ;; @String
+ ((setq bounds (bibtex-parse-string t))
+ (if (<= pnt (bibtex-end-of-string bounds))
+ (setq name "@String" ;; not a field name!
+ start-text (bibtex-start-of-text-in-string bounds)
+ end-text (bibtex-end-of-text-in-string bounds)
+ end (bibtex-end-of-string bounds))
+ (setq failure t)))
+ ;; @Preamble
+ ((setq bounds (bibtex-parse-preamble))
+ (if (<= pnt (bibtex-end-of-string bounds))
+ (setq name "@Preamble" ;; not a field name!
+ start-text (bibtex-start-of-text-in-string bounds)
+ end-text (bibtex-end-of-text-in-string bounds)
+ end (bibtex-end-of-string bounds))
+ (setq failure t)))
+ ;; BibTeX head
((looking-at bibtex-entry-maybe-empty-head)
- (goto-char (if arg
- (match-beginning bibtex-key-in-head)
- (match-end 0))))
- (t
- (unless no-error
- (error "Not on BibTeX field")))))))
-
-(defun bibtex-remove-OPT-or-ALT ()
+ (goto-char (match-end 0))
+ (if comma (save-match-data
+ (re-search-forward "\\=[ \t\n]*," nil t)))
+ (if (<= pnt (point))
+ (setq name (match-string-no-properties bibtex-type-in-head)
+ start-text (or (match-beginning bibtex-key-in-head)
+ (match-end 0))
+ end-text (or (match-end bibtex-key-in-head)
+ (match-end 0))
+ end end-text
+ no-sub t) ; subfields do not make sense
+ (setq failure t)))
+ (t (setq failure t)))
+ (when (and subfield (not failure))
+ (setq failure no-sub)
+ (unless failure
+ (goto-char start-text)
+ (while (not done)
+ (if (or (prog1 (looking-at bibtex-field-const)
+ (setq end-text (match-end 0)
+ string-const t))
+ (prog1 (setq bounds (bibtex-parse-field-string))
+ (setq end-text (cdr bounds)
+ string-const nil)))
+ (progn
+ (if (and (<= start-text pnt) (<= pnt end-text))
+ (setq done t)
+ (goto-char end-text))
+ (if (looking-at "[ \t\n]*#[ \t\n]*")
+ (setq start-text (goto-char (match-end 0)))))
+ (setq done t failure t)))))
+ (cond ((not failure)
+ (list name start-text end-text end string-const))
+ ((and no-sub (not noerror))
+ (error "Not on text part of BibTeX field"))
+ ((not noerror) (error "Not on BibTeX field"))))))
+
+(defun bibtex-remove-OPT-or-ALT (&optional comma)
"Remove the string starting optional/alternative fields.
-Align text and go thereafter to end of text."
- (interactive)
- (bibtex-inside-field)
+Align text and go thereafter to end of text. Optional arg COMMA
+is as in `bibtex-enclosing-field'. It is t for interactive calls."
+ (interactive (list t))
(let ((case-fold-search t)
- (bounds (bibtex-enclosing-field)))
+ (bounds (bibtex-enclosing-field comma)))
(save-excursion
(goto-char (bibtex-start-of-name-in-field bounds))
(when (looking-at "OPT\\|ALT")
- (delete-char (length "OPT"))
+ (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
(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)))
- (goto-char (bibtex-start-of-text-in-field bounds))
- (delete-char 1)
- (goto-char (1- (bibtex-end-of-text-in-field bounds)))
- (delete-backward-char 1))))
-
-(defun bibtex-kill-field (&optional copy-only)
+ (indent-to-column bibtex-text-indentation))))))
+
+(defun bibtex-remove-delimiters (&optional comma)
+ "Remove \"\" or {} around current BibTeX field text.
+Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
+interactive calls."
+ (interactive (list t))
+ (let ((bounds (bibtex-find-text-internal nil t comma)))
+ (unless (nth 4 bounds)
+ (delete-region (1- (nth 2 bounds)) (nth 2 bounds))
+ (delete-region (nth 1 bounds) (1+ (nth 1 bounds))))))
+
+(defun bibtex-kill-field (&optional copy-only comma)
"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")
+but do not actually kill it. Optional arg COMMA is as in
+`bibtex-enclosing-field'. It is t for interactive calls."
+ (interactive (list current-prefix-arg t))
(save-excursion
- (bibtex-inside-field)
(let* ((case-fold-search t)
- (bounds (bibtex-enclosing-field))
+ (bounds (bibtex-enclosing-field comma))
(end (bibtex-end-of-field bounds))
(beg (bibtex-start-of-field bounds)))
(goto-char end)
- (skip-chars-forward " \t\n,")
- (push (list 'field (bibtex-name-in-field bounds)
+ (skip-chars-forward ",")
+ (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)
(delete-region beg end))))
(setq bibtex-last-kill-command 'field))
-(defun bibtex-copy-field-as-kill ()
- (interactive)
- (bibtex-kill-field t))
+(defun bibtex-copy-field-as-kill (&optional comma)
+ "Copy the BibTeX field at point to the kill ring.
+Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
+interactive calls."
+ (interactive (list t))
+ (bibtex-kill-field t comma))
(defun bibtex-kill-entry (&optional copy-only)
"Kill the entire enclosing BibTeX entry.
-With prefix arg COPY-ONLY the current entry to
-`bibtex-entry-kill-ring', but do not actually kill it."
+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)
+ bibtex-any-entry-maybe-empty-head nil 'move)
(goto-char (match-beginning 0)))
(point))))
- (push (list 'entry (buffer-substring-no-properties beg end))
+ (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-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))
"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]]."
+See also the command \\[bibtex-yank-pop]."
(interactive "*p")
- (bibtex-insert-current-kill (1- n))
+ (bibtex-insert-kill (1- n) t)
(setq this-command 'bibtex-yank))
(defun bibtex-yank-pop (n)
- "Replace just-yanked killed BibTeX item with a different.
+ "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.
+`bibtex-yank-pop'. In this case, 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.
The sequence of kills wraps around, so that after the oldest one
comes the newest one."
(interactive "*p")
- (if (not (eq last-command 'bibtex-yank))
- (error "Previous command was not a BibTeX yank"))
+ (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-current-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)))
+ (bibtex-insert-kill n t)))
+
+(defun bibtex-empty-field (&optional comma)
+ "Delete the text part of the current field, replace with empty text.
+Optional arg COMMA is as in `bibtex-enclosing-field'. It is t for
+interactive calls."
+ (interactive (list t))
+ (let ((bounds (bibtex-enclosing-field comma)))
(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)))
+ (insert (bibtex-field-left-delimiter)
+ (bibtex-field-right-delimiter))
+ (bibtex-find-text t nil bibtex-help-message)))
(defun bibtex-pop-previous (arg)
"Replace text of current field with the similar field in previous entry.
(defun bibtex-clean-entry (&optional new-key called-by-reformat)
"Finish editing the current BibTeX entry and clean it up.
-Checks that no required fields are empty and formats entry dependent
+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 only will work if fields in entry
+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 this on @String or @Preamble entries.
+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
+ ;; Opt. arg CALLED-BY-REFORMAT is t if `bibtex-clean-entry'
+ ;; is called by `bibtex-reformat'
(interactive "P")
- (bibtex-format-entry)
(let ((case-fold-search t)
- key)
- (bibtex-beginning-of-entry)
- (setq key (save-excursion
- (if (re-search-forward bibtex-entry-maybe-empty-head nil t)
- (bibtex-key-in-head))))
+ (start (bibtex-beginning-of-entry))
+ (_ (or (looking-at bibtex-any-entry-maybe-empty-head)
+ (error "Not inside a BibTeX entry")))
+ (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 (if bibtex-autokey-edit-before-use
- (read-from-minibuffer
- "Key to use: " (bibtex-generate-autokey) nil nil
- 'bibtex-key-history)
- (bibtex-generate-autokey)))
- (bibtex-beginning-of-entry)
- (re-search-forward 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))
- (let* ((start (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)))
- (entry (buffer-substring start end))
- (index (progn (goto-char start)
- (bibtex-entry-index))))
- (delete-region start end)
- (unless (prog1 (or called-by-reformat
- (if bibtex-maintain-sorted-entries
- (bibtex-prepare-new-entry index)
- (not (bibtex-find-entry (car index)))))
- (insert entry)
- (forward-char -1)
- (bibtex-beginning-of-entry) ; moves backward
- (re-search-forward bibtex-entry-head))
- (error "New inserted entry yields duplicate key")))
- (unless called-by-reformat
+ (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
- (save-restriction
- (bibtex-narrow-to-entry)
- ;; Only update the list of keys if it's been built already.
- (if (consp bibtex-reference-keys) (bibtex-parse-keys t nil))
- (run-hooks 'bibtex-clean-entry-hook))))))
+ (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
+ (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))))
+ (if (not justify)
+ (goto-char (bibtex-start-of-text-in-field bounds))
+ (goto-char (bibtex-start-of-field bounds))
+ (forward-char) ; leading comma
+ (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)))
+ ;; Paragraphs within fields are not preserved. Bother?
+ (fill-region-as-paragraph (line-beginning-position) end-field
+ default-justification nil (point))
+ (if move (goto-char end-field))))
+
+(defun bibtex-fill-field (&optional justify)
+ "Like \\[fill-paragraph], but fill current BibTeX field.
+If optional prefix JUSTIFY is non-nil 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 t)))
+ (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 also."
+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)))
+ (beg (bibtex-beginning-of-entry)) ; move point
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))
- (let* ((begin-field (copy-marker (bibtex-start-of-field bounds)))
- (end-field (copy-marker (bibtex-end-of-field bounds))))
- (goto-char begin-field)
- (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)
- (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))
- (while (re-search-forward "[ \t\n]+" end-field 'move)
- (replace-match " "))
- (do-auto-fill)
- (goto-char end-field)))
+ (bibtex-beginning-first-field beg)
+ (while (setq bounds (bibtex-parse-field))
+ (bibtex-fill-field-bounds bounds t t))
(if (looking-at ",")
(forward-char))
+ (skip-chars-backward " \t\n")
(bibtex-delete-whitespace)
(open-line 1)
(forward-char)
(indent-to-column bibtex-entry-offset)
(goto-char pnt)))
-(defun bibtex-reformat (&optional additional-options called-by-convert-alien)
+(defun bibtex-realign ()
+ "Realign BibTeX entries such that they are separated by one blank line."
+ (goto-char (point-min))
+ (let ((case-fold-search t)
+ (entry-type (concat "[ \t\n]*\\(" bibtex-entry-type "\\)")))
+ ;; No blank lines prior to the first entry if there no
+ ;; non-white characters in front of it.
+ (when (looking-at entry-type)
+ (replace-match "\\1"))
+ ;; Entries are separated by one blank line.
+ (while (re-search-forward entry-type nil t)
+ (replace-match "\n\n\\1"))
+ ;; One blank line past the last entry if it is followed by
+ ;; non-white characters, no blank line otherwise.
+ (beginning-of-line)
+ (when (re-search-forward bibtex-entry-type 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 it reformats entries in region, if not in whole buffer."
+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 additional-options) 16)
+ (and (equal (prefix-numeric-value read-options) 16)
(or bibtex-reformat-previous-options
bibtex-reformat-previous-reference-keys)))
(bibtex-entry-format
- (if additional-options
+ (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)
+ ("Delete whitespace at the beginning and end of fields? " . 'whitespace)
+ ("Inherit booktitle? " . 'inherit-booktitle)
+ ("Force delimiters? " . 'delimiters)
+ ("Unify case of entry types and field names? " . 'unify-case)
+ ("Enclose parts of field entries by braces? " . 'braces)
+ ("Replace parts of field entries by string constants? " . 'strings))))))
+ ;; 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
+ whitespace braces strings))
+ (t
+ (remove 'required-fields (push 'realign bibtex-entry-format)))))
+ (reformat-reference-keys
+ (if read-options
(if use-previous-options
- bibtex-reformat-previous-options
- (setq bibtex-reformat-previous-options
- (delq nil (list
- (if (or called-by-convert-alien
- (y-or-n-p "Realign entries (recommended)? "))
- 'realign)
- (if (y-or-n-p "Remove empty optional and alternative fields? ")
- 'opts-or-alts)
- (if (y-or-n-p "Remove delimiters around pure numerical fields? ")
- 'numerical-fields)
- (if (y-or-n-p (concat (if bibtex-comma-after-last-field "Insert" "Remove")
- " comma at end of entry? "))
- 'last-comma)
- (if (y-or-n-p "Replace double page dashes by single ones? ")
- 'page-dashes)
- (if (y-or-n-p "Force delimiters? ")
- 'delimiters)
- (if (y-or-n-p "Unify case of entry types and field names? ")
- 'unify-case)))))
- '(realign)))
- (reformat-reference-keys (if additional-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-autokey-edit-before-use
+ 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)
- (start-point (if (bibtex-mark-active)
- (region-beginning)
- (bibtex-beginning-of-first-entry)
- (bibtex-skip-to-valid-entry)
- (point)))
- (end-point (if (bibtex-mark-active)
- (region-end)
- (point-max))))
+ bibtex-autokey-edit-before-use)
+
(save-restriction
- (narrow-to-region start-point end-point)
- (when (memq 'realign bibtex-entry-format)
- (goto-char (point-min))
- (while (re-search-forward bibtex-valid-entry-whitespace-re nil t)
- (replace-match "\n\\1")))
- (goto-char start-point)
+ (if mark-active (narrow-to-region (region-beginning) (region-end)))
+ (if (memq 'realign bibtex-entry-format)
+ (bibtex-realign))
(bibtex-progress-message "Formatting" 1)
- (bibtex-map-entries (lambda (current)
+ (bibtex-map-entries (lambda (key beg end)
(bibtex-progress-message)
- (bibtex-clean-entry reformat-reference-keys t)
- (when (memq 'realign bibtex-entry-format)
- (bibtex-end-of-entry)
- (bibtex-delete-whitespace)
- (open-line 2))))
+ (bibtex-clean-entry reformat-reference-keys t)))
(bibtex-progress-message 'done))
- (when (and reformat-reference-keys
- bibtex-maintain-sorted-entries
- (not called-by-convert-alien))
- (bibtex-sort-buffer)
- (setq bibtex-reference-keys nil)
- (bibtex-parse-keys nil t t))
+ (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 do-additional-reformatting)
- "Convert an alien BibTeX buffer to be fully usable by BibTeX mode.
-If a file does not conform with some standards used by BibTeX mode,
-some of the high-level features of BibTeX mode will not be available.
+(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 DO-ADDITIONAL-REFORMATTING
-non-nil, read options for reformatting entries from minibuffer."
+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)
- (goto-char (point-min))
- (while (re-search-forward "[ \t\n]+@" nil t)
- (replace-match "\n@"))
- (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))
+ (bibtex-realign)
+ (deactivate-mark) ; So `bibtex-validate' works on the whole buffer.
+ (if (not (let (bibtex-maintain-sorted-entries)
+ (bibtex-validate)))
+ (message "Correct errors and call `bibtex-convert-alien' again")
(message "Starting to reformat entries...")
(sit-for 2 nil t)
- (bibtex-reformat do-additional-reformatting t)
- (when bibtex-maintain-sorted-entries
- (message "Starting to sort buffer...")
- (bibtex-sort-buffer))
+ (bibtex-reformat read-options)
(goto-char (point-max))
- (message "Buffer is now parsable. Please save it.")))
+ (message "Buffer is now parsable. Please save it.")))
(defun bibtex-complete ()
"Complete word fragment before point according to context.
-If inside key or crossref field complete key based on
-`bibtex-reference-keys'. Inside any other field perform string
-completion based on `bibtex-strings'. An error is signaled if point
-is outside key or BibTeX field."
+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
+\(including a String or Preamble definition) 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 compl)
+ (let ((pnt (point))
+ (case-fold-search t)
+ bounds name compl)
(save-excursion
- (if (and (setq bounds (bibtex-enclosing-field t))
+ (if (and (setq bounds (bibtex-enclosing-field nil t))
(>= pnt (bibtex-start-of-text-in-field bounds))
(<= pnt (bibtex-end-of-text-in-field bounds)))
- (progn
- (goto-char (bibtex-start-of-name-in-field bounds))
- (setq compl (if (string= "crossref"
- (downcase
- (buffer-substring-no-properties
- (if (looking-at "\\(OPT\\)\\|\\(ALT\\)")
- (match-end 0)
- (point))
- (bibtex-end-of-name-in-field bounds))))
- 'key
- 'str)))
+ (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 (bibtex-strings))))
(bibtex-beginning-of-entry)
- (if (and (re-search-forward bibtex-entry-maybe-empty-head nil t)
- ;; 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 ((equal compl 'key)
- ;; key completion
- (unless (consp bibtex-reference-keys) (bibtex-parse-keys nil t))
- (setq choose-completion-string-functions
- (lambda (choice buffer mini-p base-size)
- (bibtex-choose-completion-string choice buffer mini-p base-size)
- (if bibtex-complete-key-cleanup
- (funcall bibtex-complete-key-cleanup choice))
- ;; return t (required by choose-completion-string-functions)
- t))
- (let ((choice (bibtex-complete-internal bibtex-reference-keys)))
- (if bibtex-complete-key-cleanup
- (funcall bibtex-complete-key-cleanup choice))))
-
- ((equal compl 'str)
+ (cond ((setq bounds (bibtex-parse-string t))
+ ;; point is inside a @String key
+ (cond ((and (>= pnt (nth 1 (car bounds)))
+ (<= pnt (nth 2 (car bounds))))
+ (setq compl 'string))
+ ;; point is inside a @String field
+ ((and (>= pnt (bibtex-start-of-text-in-string bounds))
+ (<= pnt (bibtex-end-of-text-in-string bounds)))
+ (setq compl (bibtex-strings)))))
+ ;; point is inside a @Preamble field
+ ((setq bounds (bibtex-parse-preamble))
+ (if (and (>= pnt (bibtex-start-of-text-in-string bounds))
+ (<= pnt (bibtex-end-of-text-in-string bounds)))
+ (setq compl (bibtex-strings))))
+ ((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
+ (setq choose-completion-string-functions nil)
+ (let (completion-ignore-case)
+ (bibtex-complete-internal (bibtex-global-key-alist))))
+
+ ((eq compl 'crossref-key)
+ ;; crossref key completion
+ ;;
+ ;; If we quit the *Completions* buffer without requesting
+ ;; a completion, `choose-completion-string-functions' is still
+ ;; non-nil. Therefore, `choose-completion-string-functions' is
+ ;; always set (either to non-nil or nil) when a new completion
+ ;; is requested.
+ (let (completion-ignore-case)
+ (setq choose-completion-string-functions
+ (lambda (choice buffer mini-p base-size)
+ (setq choose-completion-string-functions nil)
+ (choose-completion-string choice buffer base-size)
+ (bibtex-complete-crossref-cleanup choice)
+ t)) ; needed by choose-completion-string-functions
+ (bibtex-complete-crossref-cleanup
+ (bibtex-complete-internal (bibtex-global-key-alist)))))
+
+ ((eq compl 'string)
+ ;; string key completion: no cleanup needed
+ (setq choose-completion-string-functions nil)
+ (let ((completion-ignore-case t))
+ (bibtex-complete-internal bibtex-strings)))
+
+ (compl
;; string completion
- (setq choose-completion-string-functions
- (lambda (choice buffer mini-p base-size)
- (bibtex-choose-completion-string choice buffer mini-p base-size)
- (bibtex-complete-string-cleanup choice)
- ;; return t (required by choose-completion-string-functions)
- t))
- (bibtex-complete-string-cleanup (bibtex-complete-internal bibtex-strings)))
-
- (t (error "Point outside key or BibTeX field")))))
+ (let ((completion-ignore-case t))
+ (setq choose-completion-string-functions
+ `(lambda (choice buffer mini-p base-size)
+ (setq choose-completion-string-functions nil)
+ (choose-completion-string choice buffer base-size)
+ (bibtex-complete-string-cleanup choice ',compl)
+ t)) ; needed by `choose-completion-string-functions'
+ (bibtex-complete-string-cleanup (bibtex-complete-internal compl)
+ compl)))
+
+ (t (setq choose-completion-string-functions nil)
+ (error "Point outside key or BibTeX field")))))
(defun bibtex-Article ()
"Insert a new BibTeX @Article entry; see also `bibtex-entry'."
(defun bibtex-String (&optional key)
"Insert a new BibTeX @String entry with key KEY."
- (interactive
- (progn (unless (consp bibtex-reference-keys) (bibtex-parse-keys nil t))
- (list (completing-read "String key: " bibtex-reference-keys
- nil nil nil 'bibtex-key-history))))
- ;; If we want to sort String entries only the sorting scheme
- ;; entry-class is meaningful
+ (interactive (list (bibtex-read-string-key)))
(let ((bibtex-maintain-sorted-entries
- (if (and (not bibtex-sort-ignore-string-entries)
- bibtex-maintain-sorted-entries)
- 'entry-class))
+ (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))
(indent-to-column bibtex-entry-offset)
(insert "@Preamble"
(bibtex-entry-left-delimiter)
- (bibtex-entry-right-delimiter)
- "\n")
- (forward-line -1)
- (forward-char 10))
+ (bibtex-field-left-delimiter))
+ (let ((endpos (point)))
+ (insert (bibtex-field-right-delimiter)
+ (bibtex-entry-right-delimiter)
+ "\n")
+ (goto-char endpos)))
+
+(defun bibtex-url (&optional pos no-browse)
+ "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\). If multiple schemes match for this entry, or the same scheme
+matches more than once, use the one for which the first step's match is the
+closest to POS. The URL is passed to `browse-url' unless NO-BROWSE is t.
+Return the URL or nil if none can be generated."
+ (interactive)
+ (unless pos (setq pos (point)))
+ (save-excursion
+ (goto-char pos)
+ (bibtex-beginning-of-entry)
+ (let ((end (save-excursion (bibtex-end-of-entry)))
+ (fields-alist (save-excursion (bibtex-parse-entry t)))
+ ;; Always ignore case,
+ (case-fold-search t)
+ text url scheme obj fmt fl-match step)
+ ;; The return value of `bibtex-parse-entry' (i.e., FIELDS-ALIST)
+ ;; is always used to generate the URL. However, if the BibTeX
+ ;; entry contains more than one URL, we have multiple matches
+ ;; for the first step defining the generation of the URL.
+ ;; Therefore, we try to initiate the generation of the URL
+ ;; based on the match of `bibtex-font-lock-url' that is the
+ ;; closest to POS. If that fails (no match found) we try to
+ ;; initiate the generation of the URL based on the properly
+ ;; concatenated CONTENT of the field as returned by
+ ;; `bibtex-text-in-field-bounds'. The latter approach can
+ ;; differ from the former because `bibtex-font-lock-url' uses
+ ;; the buffer itself.
+ (while (bibtex-font-lock-url end t)
+ (push (list (bibtex-dist pos (match-beginning 0) (match-end 0))
+ (match-beginning 0)
+ (buffer-substring-no-properties
+ (match-beginning 0) (match-end 0)))
+ fl-match)
+ ;; `bibtex-font-lock-url' moves point to end of match.
+ (forward-char))
+ (when fl-match
+ (setq fl-match (car (sort fl-match (lambda (x y) (< (car x) (car y))))))
+ (goto-char (nth 1 fl-match))
+ (bibtex-beginning-of-field) (re-search-backward ",")
+ (let* ((bounds (bibtex-parse-field))
+ (name (bibtex-name-in-field bounds))
+ (content (bibtex-text-in-field-bounds bounds t))
+ (lst bibtex-generate-url-list))
+ ;; This match can fail when CONTENT differs from text in buffer.
+ (when (string-match (regexp-quote (nth 2 fl-match)) content)
+ ;; TEXT is the part of CONTENT that starts with the match
+ ;; of `bibtex-font-lock-url' we are looking for.
+ (setq text (substring content (match-beginning 0)))
+ (while (and (not url) (setq scheme (pop lst)))
+ ;; Verify the match of `bibtex-font-lock-url' by
+ ;; comparing with TEXT.
+ (when (and (bibtex-string= (caar scheme) name)
+ (string-match (cdar scheme) text))
+ (setq url t scheme (cdr scheme)))))))
+
+ ;; If the match of `bibtex-font-lock-url' was not approved
+ ;; parse FIELDS-ALIST, i.e., the output of `bibtex-parse-entry'.
+ (unless url
+ (let ((lst bibtex-generate-url-list))
+ (while (and (not url) (setq scheme (pop lst)))
+ (when (and (setq text (cdr (assoc-string (caar scheme)
+ fields-alist t)))
+ (string-match (cdar scheme) text))
+ (setq url t scheme (cdr scheme))))))
+
+ (when url
+ (setq url (if (null scheme) (match-string 0 text)
+ (if (stringp (car scheme))
+ (setq fmt (pop scheme)))
+ (dotimes (i (length scheme))
+ (setq step (nth i scheme))
+ ;; The first step shall use TEXT as obtained earlier.
+ (unless (= i 0)
+ (setq text (cdr (assoc-string (car step) fields-alist t))))
+ (if (string-match (nth 1 step) text)
+ (push (cond ((functionp (nth 2 step))
+ (funcall (nth 2 step) text))
+ ((numberp (nth 2 step))
+ (match-string (nth 2 step) text))
+ (t
+ (replace-match (nth 2 step) t nil text)))
+ obj)
+ ;; If SCHEME is set up correctly,
+ ;; we should never reach this point
+ (error "Match failed: %s" text)))
+ (if fmt (apply 'format fmt (nreverse obj))
+ (apply 'concat (nreverse obj)))))
+ (if (interactive-p) (message "%s" url))
+ (unless no-browse (browse-url url)))
+ (if (and (not url) (interactive-p)) (message "No URL known."))
+ url)))
\f
;; Make BibTeX a Feature
(provide 'bibtex)
+;; arch-tag: ee2be3af-caad-427f-b42a-d20fad630d04
;;; bibtex.el ends here