*
* \author Angus Leeming
* \author Herbert Voß
- * \author Richard Heck
+ * \author Richard Kimberly Heck
* \author Julien Rioux
*
* Full author contact details are available in file CREDITS.
#include "support/docstring.h"
-#include "Citation.h"
-
-#include <vector>
#include <map>
#include <set>
+#include <vector>
namespace lyx {
class Buffer;
+class BufferParams;
+class CitationStyle;
+class CiteItem;
+class XMLStream;
/// \param latex_str a LaTeX command, "cite", "Citep*", etc
-CitationStyle citationStyleFromString(std::string const & latex_str);
+CitationStyle citationStyleFromString(std::string const & latex_str,
+ BufferParams const &);
/// the other way round
-std::string citationStyleToString(CitationStyle const &);
+std::string citationStyleToString(CitationStyle const &, bool const latex = false);
+
+/// Transforms the information about authors into a <authorgroup> (directly written to a XMLStream).
+docstring authorsToDocBookAuthorGroup(docstring const & authorsString, XMLStream & xs, Buffer const & buf);
/// Class to represent information about a BibTeX or
/// and the values are the associated field values.
typedef std::map<docstring, docstring>::const_iterator const_iterator;
///
- BibTeXInfo() : is_bibtex_(true), modifier_(0) {}
+ typedef std::vector<BibTeXInfo const *> const BibTeXInfoList;
+ ///
+ BibTeXInfo() : is_bibtex_(true), num_bib_key_(0), modifier_(0) {}
/// argument sets isBibTeX_, so should be false only if it's coming
/// from a bibliography environment
- BibTeXInfo(bool ib) : is_bibtex_(ib), modifier_(0) {}
+ BibTeXInfo(bool ib) : is_bibtex_(ib), num_bib_key_(0), modifier_(0) {}
/// constructor that sets the entryType
BibTeXInfo(docstring const & key, docstring const & type);
- /// \return the short form of an authorlist, used for sorting
- docstring const getAbbreviatedAuthor(bool jurabib_style = false) const;
- /// \return the short form of an authorlist, translated to the
- /// buffer language.
- docstring const getAbbreviatedAuthor(Buffer const & buf, bool jurabib_style = false) const;
+ /// \return an author or editor list (short form by default),
+ /// used for sorting.
+ /// This will be translated to the UI language if buf is null
+ /// otherwise, it will be translated to the buffer language.
+ docstring const getAuthorOrEditorList(Buffer const * buf = nullptr,
+ bool full = false, bool forceshort = false) const;
+ /// Same for a specific author role (editor, author etc.)
+ docstring const getAuthorList(Buffer const * buf, docstring const & author,
+ bool const full = false, bool const forceshort = false,
+ bool const allnames = false, bool const beginning = true) const;
///
docstring const getYear() const;
///
- docstring const getXRef() const;
+ void getLocators(docstring & doi, docstring & url, docstring & file) const;
/// \return formatted BibTeX data suitable for framing.
- /// \param pointer to crossref information
- docstring const & getInfo(BibTeXInfo const * const xref,
- Buffer const & buf, bool richtext) const;
+ /// \param vector of pointers to crossref/xdata information
+ docstring const & getInfo(BibTeXInfoList const & xrefs,
+ Buffer const & buf, CiteItem const & ci,
+ docstring const & format = docstring()) const;
/// \return formatted BibTeX data for a citation label
- docstring const getLabel(BibTeXInfo const * const xref,
- Buffer const & buf, std::string const & format, bool richtext,
- docstring before, docstring after, docstring dialog, bool next = false) const;
+ docstring const getLabel(BibTeXInfoList const & xrefs,
+ Buffer const & buf, docstring const & format,
+ CiteItem const & ci, bool next = false, bool second = false) const;
///
const_iterator find(docstring const & f) const { return bimap_.find(f); }
///
void label(docstring const & d) { label_= d; }
///
void key(docstring const & d) { bib_key_= d; }
+ /// Record the number of occurences of the same key
+ /// (duplicates are allowed with qualified citation lists)
+ void numKey(int const i) { num_bib_key_ = i; }
///
docstring const & label() const { return label_; }
///
bool isBibTeX() const { return is_bibtex_; }
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.
+ /// to get the data from xref BibTeXInfo objects, which would normally
+ /// be the one referenced in the crossref or xdata field.
docstring getValueForKey(std::string const & key, Buffer const & buf,
- docstring const & before, docstring const & after, docstring const & dialog,
- BibTeXInfo const * const xref = 0) const;
+ CiteItem const & ci, BibTeXInfoList const & xrefs, size_t maxsize = 4096) const;
/// replace %keys% in a format string with their values
/// called from getInfo()
/// format strings may contain:
/// "%!key%" are substituted with their definition.
/// moreover, keys that look like "%_key%" are treated as translatable
/// so that things like "pp." and "vol." can be translated.
- docstring expandFormat(std::string const & fmt,
- BibTeXInfo const * const xref, int & counter,
- Buffer const & buf, docstring before = docstring(),
- docstring after = docstring(), docstring dialog = docstring(),
- bool next = false) const;
+ docstring expandFormat(docstring const & fmt,
+ BibTeXInfoList const & xrefs, int & counter,
+ Buffer const & buf, CiteItem const & ci,
+ bool next = false, bool second = false) const;
/// true if from BibTeX; false if from bibliography environment
bool is_bibtex_;
/// the BibTeX key for this entry
docstring bib_key_;
+ /// Number of occurences of the same key
+ int num_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
mutable docstring info_;
/// a cache for getInfo(richtext = true)
mutable docstring info_richtext_;
+ /// cache for last format pattern
+ mutable docstring format_;
///
docstring cite_number_;
///
/// from BibTeX or from bibliography environments.
class BiblioInfo {
public:
+ ///
+ typedef std::vector<BibTeXInfo const *> BibTeXInfoList;
/// bibliography key --> data for that key
typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
+ /// Get a vector with all external data (crossref, xdata)
+ std::vector<docstring> const getXRefs(BibTeXInfo const & data,
+ bool const nested = false) const;
/// \return a sorted vector of bibliography keys
std::vector<docstring> const getKeys() const;
/// \return a sorted vector of present BibTeX fields
std::vector<docstring> const getFields() const;
/// \return a sorted vector of BibTeX entry types in use
std::vector<docstring> const getEntries() const;
- /// \return the short form of an authorlist
- docstring const getAbbreviatedAuthor(docstring const & key, Buffer const & buf) const;
+ /// \return author or editor list (abbreviated form by default)
+ docstring const getAuthorOrEditorList(docstring const & key, Buffer const & buf) const;
/// \return the year from the bibtex data record for \param key
/// if \param use_modifier is true, then we will also append any
/// modifier for this entry (e.g., 1998b).
- /// Note that this will get the year from the crossref if it's
- /// not present in the record itself.
+ /// If no legacy year field is present, check for date (common in
+ /// biblatex) and extract the year from there.
+ /// Note further that this will get the year from the crossref or xdata
+ /// if it's not present in the record itself.
docstring const getYear(docstring const & key,
bool use_modifier = false) const;
/// \return the year from the bibtex data record for \param key
/// if \param use_modifier is true, then we will also append any
/// modifier for this entry (e.g., 1998b).
- /// Note that this will get the year from the crossref if it's
- /// not present in the record itself.
+ /// If no legacy year field is present, check for date (common in
+ /// biblatex) and extract the year from there.
+ /// Note further that this will get the year from the crossref or xdata
+ /// if it's not present in the record itself.
/// If no year is found, \return "No year" translated to the buffer
/// language.
docstring const getYear(docstring const & key, Buffer const & buf,
bool use_modifier = false) const;
+ /// get either local pdf or web location of the citation referenced by key.
+ /// DOI/file are prefixed so they form proper URL for generic qt handler
+ void getLocators(docstring const & key, docstring & doi, docstring & url, docstring & file) const;
///
docstring const getCiteNumber(docstring const & key) const;
/// \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.
- /// If \param richtext is true, then it will output any richtext tags
- /// marked in the citation format and escape < and > elsewhere.
+ /// Note that this will retrieve data from the crossref or xdata as needed.
+ /// \param ci contains further context information, such as if it should
+ /// output any richtext tags marked in the citation format and escape < and >
+ /// elsewhere, and the general output context.
docstring const getInfo(docstring const & key, Buffer const & buf,
- bool richtext = false) const;
+ CiteItem const & ci, docstring const & format = docstring()) const;
/// \return formatted BibTeX data for citation labels.
/// Citation labels can have more than one key.
- docstring const getLabel(std::vector<docstring> const & keys,
- Buffer const & buf, std::string const & style, bool richtext = false,
- docstring const & before = docstring(),
- docstring const & after = docstring(),
- docstring const & dialog = docstring()) const;
+ docstring const getLabel(std::vector<docstring> keys, Buffer const & buf,
+ std::string const & style, CiteItem const & ci) const;
/// Is this a reference from a bibtex database
/// or from a bibliography environment?
bool isBibtex(docstring const & key) const;
+ /// A vector holding a pair of lyx cite command and the respective
+ /// output for a given (list of) key(s).
+ typedef std::vector<std::pair<docstring,docstring>> CiteStringMap;
/// Translates the available citation styles into strings for a given
/// list of keys, using either numerical or author-year style depending
- /// upon the active engine.
- std::vector<docstring> const getCiteStrings(std::vector<docstring> const & keys,
- std::vector<CitationStyle> const & styles, Buffer const & buf, bool richtext = false,
- docstring const & before = docstring(),
- docstring const & after = docstring(),
- docstring const & dialog = docstring()) const;
- /// Collects the cited entries from buf.
- void collectCitedEntries(Buffer const & buf);
+ /// upon the active engine. The function returns a CiteStringMap with the first
+ /// element being the lyx cite command, the second being the formatted
+ /// citation reference.
+ CiteStringMap const getCiteStrings(
+ std::vector<docstring> const & keys,
+ std::vector<CitationStyle> const & styles, Buffer const & buf,
+ CiteItem const & ci) const;
/// A list of BibTeX keys cited in the current document, sorted by
/// the last name of the author.
/// Make sure you have called collectCitedEntries() before you try to
///
void addEntryType(docstring const & f) { entry_types_.insert(f); }
private:
+ /// Collects the cited entries from buf.
+ void collectCitedEntries(Buffer const & buf);
///
std::set<docstring> field_names_;
///
projects / lyx.git / blobdiff