* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
- * \author Herbert Voß
+ * \author Herbert Voß
* \author Richard Heck
*
* Full author contact details are available in file CREDITS.
std::vector<CiteStyle> citeStyles(CiteEngine);
/// \param latex_str a LaTeX command, "cite", "Citep*", etc
CitationStyle citationStyleFromString(std::string const & latex_str);
-/// the other way rounf
+/// the other way round
std::string citationStyleToString(CitationStyle const &);
/// Class to represent information about a BibTeX or
/// bibliography entry.
-/// The keys are BibTeX fields (e.g., author, title, etc),
-/// and the values are the associated field values.
+/// This class basically wraps a std::map, and many of its
+/// methods simply delegate to the corresponding methods of
+/// std::map.
class BibTeXInfo {
public:
- ///
+ /// The keys are BibTeX fields (e.g., author, title, etc),
+ /// and the values are the associated field values.
typedef std::map<docstring, docstring>::const_iterator const_iterator;
///
BibTeXInfo() : is_bibtex_(true) {}
BibTeXInfo(bool ib) : is_bibtex_(ib) {}
/// constructor that sets the entryType
BibTeXInfo(docstring const & key, docstring const & type);
- /// Search for the given field and return the associated info.
- /// The point of this is that BibTeXInfo::operator[] has no const
- /// form.
- docstring const & getValueForField(docstring const & field) const;
- ///
- docstring const & getValueForField(std::string const & field) const;
///
bool hasField(docstring const & field) const;
- /// return the short form of an authorlist
+ /// \return the short form of an authorlist
docstring const getAbbreviatedAuthor() const;
///
docstring const getYear() const;
- /// Returns formatted BibTeX data suitable for framing.
- docstring const getInfo() const;
+ ///
+ docstring const getXRef() const;
+ /// \return formatted BibTeX data suitable for framing.
+ /// \param pointer to crossref information
+ docstring const & getInfo(BibTeXInfo const * const xref = 0) const;
///
int count(docstring const & f) const { return bimap_.count(f); }
///
const_iterator find(docstring const & f) const { return bimap_.find(f); }
///
const_iterator end() const { return bimap_.end(); }
- ///
+ /// \return value for field f
+ /// note that this will create an empty field if it does not exist
docstring & operator[](docstring const & f)
{ return bimap_[f]; }
+ /// \return value for field f
+ /// this one, since it is const, will simply return docstring() if
+ /// we don't have the field and will NOT create an empty field
+ docstring const & operator[](docstring const & field) const;
+ ///
+ docstring const & operator[](std::string const & field) const;
///
docstring const & allData() const { return all_data_; }
///
void setAllData(docstring const & d) { all_data_ = d; }
///
+ void label(docstring const & d) { label_= d; }
+ ///
+ docstring const & label() const { return label_; }
+ ///
+ docstring const & key() const { return bib_key_; }
+ ///
docstring entryType() const { return entry_type_; }
private:
+ /// like operator[], except, if the field is empty, it will attempt
+ /// to get the data from xref BibTeXInfo object, which would normally
+ /// be the one referenced in the crossref field.
+ docstring getValueForKey(std::string const & key,
+ BibTeXInfo const * const xref = 0) const;
/// true if from BibTeX; false if from bibliography environment
bool is_bibtex_;
/// the BibTeX key for this entry
docstring bib_key_;
+ /// the label that will appear in citations
+ /// this is easily set from bibliography environments, but has
+ /// to be calculated for entries we get from BibTeX
+ docstring label_;
/// a single string containing all BibTeX data associated with this key
docstring all_data_;
/// the BibTeX entry type (article, book, incollection, ...)
docstring entry_type_;
+ /// a cache for getInfo()
+ mutable docstring info_;
/// our map: <field, value>
std::map <docstring, docstring> bimap_;
};
/// Class to represent a collection of bibliographical data, whether
/// from BibTeX or from bibliography environments.
-/// BiblioInfo.first is the bibliography key
-/// BiblioInfo.second is the data for that key
class BiblioInfo {
public:
- ///
+ /// bibliography key --> data for that key
typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
- /// Returns a sorted vector of bibliography keys
+ /// \return a sorted vector of bibliography keys
std::vector<docstring> const getKeys() const;
- /// Returns a sorted vector of present BibTeX fields
+ /// \return a sorted vector of present BibTeX fields
std::vector<docstring> const getFields() const;
- /// Returns a sorted vector of BibTeX entry types in use
+ /// \return a sorted vector of BibTeX entry types in use
std::vector<docstring> const getEntries() const;
- /// return the short form of an authorlist
+ /// \return the short form of an authorlist
docstring const getAbbreviatedAuthor(docstring const & key) const;
- /// return the year from the bibtex data record
+ /// \return the year from the bibtex data record
+ /// Note that this will get the year from the crossref if it's
+ /// not present in the record itself
docstring const getYear(docstring const & key) const;
- /// Returns formatted BibTeX data associated with a given key.
+ /// \return formatted BibTeX data associated with a given key.
/// Empty if no info exists.
+ /// Note that this will retrieve data from the crossref as needed.
docstring const getInfo(docstring const & key) const;
-
/**
* "Translates" the available Citation Styles into strings for a given key,
* either numerical or author-year depending upon the active engine. (See
projects / lyx.git / blobdiff