X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBiblioInfo.h;h=c4c27e30b09492b6f9372871cd69984a76ec97c7;hb=4db3e641ed6765e005343010cb90ee8af26f8f99;hp=cc62660b41be3e196f8d9ba9ba1dbaff83a93941;hpb=dfdcc56cbaf77b67048cfd7e2ad877b7687f4888;p=lyx.git

diff --git a/src/BiblioInfo.h b/src/BiblioInfo.h
index cc62660b41..c4c27e30b0 100644
--- a/src/BiblioInfo.h
+++ b/src/BiblioInfo.h
@@ -7,6 +7,7 @@
  * \author Angus Leeming
  * \author Herbert Voß
  * \author Richard Heck
+ * \author Julien Rioux
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -27,9 +28,6 @@ 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
@@ -47,14 +45,17 @@ public:
 	/// 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;
 	///
@@ -63,6 +64,10 @@ public:
 	/// \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, std::string const & format, bool richtext,
+		docstring before, docstring after, docstring dialog, bool next = false) const;
 	///
 	const_iterator find(docstring const & f) const { return bimap_.find(f); }
 	///
@@ -84,6 +89,8 @@ public:
 	///
 	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_; }
@@ -105,8 +112,9 @@ 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 = 0) const;
 	/// replace %keys% in a format string with their values
 	/// called from getInfo()
 	/// format strings may contain:
@@ -114,16 +122,20 @@ private:
 	///   {%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;
+		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
@@ -138,6 +150,8 @@ private:
 	docstring entry_type_;
 	/// a cache for getInfo()
 	mutable docstring info_;
+	/// a cache for getInfo(richtext = true)
+	mutable docstring info_richtext_;
 	///
 	docstring cite_number_;
 	///
@@ -160,7 +174,7 @@ public:
 	/// \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).
@@ -168,6 +182,15 @@ public:
 	/// 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.
@@ -177,38 +200,24 @@ public:
 	/// 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> 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;
 	/// 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;
+	/// 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);
 	/// A list of BibTeX keys cited in the current document, sorted by