* \author Angus Leeming
* \author Herbert Voß
* \author Richard Heck
+ * \author Julien Rioux
*
* Full author contact details are available in file CREDITS.
*/
#include "Citation.h"
-#include <vector>
#include <map>
#include <set>
+#include <vector>
namespace lyx {
-
+
class Buffer;
-/// FIXME: To Citation.cpp?
-/// Returns a vector of available Citation styles.
-std::vector<CiteStyle> citeStyles(CiteEngine);
/// \param latex_str a LaTeX command, "cite", "Citep*", etc
CitationStyle citationStyleFromString(std::string const & latex_str);
/// the other way round
/// std::map.
class BibTeXInfo {
public:
- /// The keys are BibTeX fields (e.g., author, title, etc),
+ /// 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() : is_bibtex_(true), modifier_(0) {}
/// argument sets isBibTeX_, so should be false only if it's coming
/// from a bibliography environment
- BibTeXInfo(bool ib) : is_bibtex_(ib) {}
+ BibTeXInfo(bool ib) : is_bibtex_(ib), modifier_(0) {}
/// constructor that sets the entryType
BibTeXInfo(docstring const & key, docstring const & type);
- /// \return the short form of an authorlist
- docstring const getAbbreviatedAuthor() const;
- ///
+ /// \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;
+ ///
docstring const getYear() const;
///
docstring const getXRef() const;
/// \param pointer to crossref information
docstring const & getInfo(BibTeXInfo const * const xref,
Buffer const & buf, bool richtext) const;
+ /// \return formatted BibTeX data for a citation label
+ docstring const getLabel(BibTeXInfo const * const xref,
+ Buffer const & buf, docstring const & format, bool richtext,
+ const docstring & before, const docstring & after,
+ const docstring & dialog, bool next = false) const;
///
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)
+ docstring & operator[](docstring const & f)
{ return bimap_[f]; }
/// \return value for field f
/// this one, since it is const, will simply return docstring() if
///
void label(docstring const & d) { label_= d; }
///
+ void key(docstring const & d) { bib_key_= d; }
+ ///
docstring const & label() const { return label_; }
///
docstring const & key() const { return bib_key_; }
docstring citeNumber() const { return cite_number_; }
///
void setCiteNumber(docstring const & num) { cite_number_ = num; }
- /// a,b,c, etc, for author-year. currently used only by XHTML
+ /// a,b,c, etc, for author-year. currently used only by XHTML
/// output routines.
char modifier() const { return modifier_; }
///
void setModifier(char c) { modifier_ = c; }
///
docstring entryType() const { return entry_type_; }
- ///
+ ///
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.
- docstring getValueForKey(std::string const & key,
- BibTeXInfo const * const xref = 0) const;
+ docstring getValueForKey(std::string const & key, Buffer const & buf,
+ docstring const & before, docstring const & after, docstring const & dialog,
+ BibTeXInfo const * const xref, size_t maxsize = 4096) const;
/// replace %keys% in a format string with their values
/// called from getInfo()
/// format strings may contain:
/// {%key%[[format]]}, which prints format if key is non-empty
/// the latter may optionally contain an `else' clause as well:
/// {%key%[[if format]][[else format]]}
- /// material intended only for rich text (HTML) output should be
- /// wrapped in "{!" and "!}". it will be removed if richtext is
- /// false.
+ /// Material intended only for rich text (HTML) output should be
+ /// wrapped in "{!" and "!}". These markers are to be postprocessed
+ /// by processRichtext(); this step is left as a separate routine since
+ /// expandFormat() is recursive while postprocessing should be done
+ /// only once on the final string (just like convertLaTeXCommands).
/// a simple macro facility is also available. keys that look like
/// "%!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, bool richtext) const;
+ docstring expandFormat(docstring const & fmt,
+ BibTeXInfo const * const xref, int & counter,
+ Buffer const & buf, docstring before = docstring(),
+ docstring after = docstring(), docstring dialog = docstring(),
+ bool next = false) const;
/// true if from BibTeX; false if from bibliography environment
bool is_bibtex_;
/// the BibTeX key for this entry
docstring entry_type_;
/// a cache for getInfo()
mutable docstring info_;
- ///
+ /// a cache for getInfo(richtext = true)
+ mutable docstring info_richtext_;
+ ///
docstring cite_number_;
///
char modifier_;
/// \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) const;
+ docstring const getAbbreviatedAuthor(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.
+ /// 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 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;
///
docstring const getCiteNumber(docstring const & key) const;
/// \return formatted BibTeX data associated with a given key.
- /// Empty if no info exists.
+ /// 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.
docstring const getInfo(docstring const & key, Buffer const & buf,
bool richtext = false) const;
+ /// \return formatted BibTeX data for citation labels.
+ /// Citation labels can have more than one key.
+ docstring const getLabel(std::vector<docstring> keys,
+ Buffer const & buf, std::string const & style, bool for_xhtml,
+ size_t max_size, docstring const & before, docstring const & after,
+ docstring const & dialog = docstring()) const;
/// Is this a reference from a bibtex database
/// or from a bibliography environment?
bool isBibtex(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
- * below for those methods.)
- */
- std::vector<docstring> const
- getCiteStrings(docstring const & key, Buffer const & buf) const;
- /**
- * "Translates" the available Citation Styles into strings for a given key.
- * The returned string is displayed by the GUI.
- * [XX] is used in place of the actual reference
- * Eg, the vector will contain: [XX], Jones et al. [XX], ...
- * User supplies :
- * the key,
- * the buffer
- */
- std::vector<docstring> const
- getNumericalStrings(docstring const & key, Buffer const & buf) const;
- /**
- * "Translates" the available Citation Styles into strings for a given key.
- * The returned string is displayed by the GUI.
- * Eg, the vector will contain:
- * Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ...
- * User supplies :
- * the key,
- * the buffer
- */
- std::vector<docstring> const
- getAuthorYearStrings(docstring const & key, Buffer const & buf) const;
- /// Collects the cited entries from buf.
- void collectCitedEntries(Buffer const & buf);
+ /// 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,
+ docstring const & before, docstring const & after, docstring const & dialog,
+ size_t max_size) 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
+ /// Make sure you have called collectCitedEntries() before you try to
/// use this. You should probably call it just before you use this.
- std::vector<docstring> const & citedEntries() const
+ std::vector<docstring> const & citedEntries() const
{ return cited_entries_; }
///
void makeCitationLabels(Buffer const & buf);
///
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_;
///
std::map<docstring, BibTeXInfo> bimap_;
/// a possibly sorted list of entries cited in our Buffer.
/// do not try to make this a vector<BibTeXInfo *> or anything of
- /// the sort, because reloads will invalidate those pointers.
+ /// the sort, because reloads will invalidate those pointers.
std::vector<docstring> cited_entries_;
};
projects / lyx.git / blobdiff