X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBiblioInfo.h;h=efe4bff233948d61e5785959e87a0f2815bd320f;hb=12f8e7a6f91f4e1c631888f303af5c76c7b0cd6f;hp=658a4ad02731da25504714e90a3eb009a56827a6;hpb=2098f1d8c20d51e63e670bcdc9da8996068975bf;p=lyx.git

diff --git a/src/BiblioInfo.h b/src/BiblioInfo.h
index 658a4ad027..efe4bff233 100644
--- a/src/BiblioInfo.h
+++ b/src/BiblioInfo.h
@@ -53,8 +53,6 @@ public:
 	BibTeXInfo(bool ib) : is_bibtex_(ib) {}
 	/// constructor that sets the entryType
 	BibTeXInfo(docstring const & key, docstring const & type);
-	///
-	bool hasField(docstring const & field) const;
 	/// \return the short form of an authorlist
 	docstring const getAbbreviatedAuthor() const;
 	/// 
@@ -63,9 +61,8 @@ public:
 	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); }
+	docstring const & getInfo(BibTeXInfo const * const xref,
+			Buffer const & buf, bool richtext) const;
 	///
 	const_iterator find(docstring const & f) const { return bimap_.find(f); }
 	///
@@ -90,10 +87,16 @@ public:
 	docstring const & label() const { return label_; }
 	///
 	docstring const & key() const { return bib_key_; }
+	/// numerical key for citing this entry. currently used only
+	/// by XHTML output routines.
+	docstring citeNumber() const { return cite_number_; }
 	///
-	docstring citeKey() const { return cite_key_; }
+	void setCiteNumber(docstring const & num) { cite_number_ = num; }
+	/// a,b,c, etc, for author-year. currently used only by XHTML 
+	/// output routines.
+	char modifier() const { return modifier_; }
 	///
-	void setCiteKey(docstring const & k) { cite_key_ = k; }
+	void setModifier(char c) { modifier_ = c; }
 	///
 	docstring entryType() const { return entry_type_; }
 	/// 
@@ -104,6 +107,23 @@ private:
 	/// be the one referenced in the crossref field.
 	docstring getValueForKey(std::string const & key, 
 			BibTeXInfo const * const xref = 0) const;
+	/// replace %keys% in a format string with their values
+	/// called from getInfo()
+	/// format strings may contain:
+	///   %key%, which represents a key
+	///   {%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.
+	/// 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;
 	/// true if from BibTeX; false if from bibliography environment
 	bool is_bibtex_;
 	/// the BibTeX key for this entry
@@ -118,9 +138,10 @@ private:
 	docstring entry_type_;
 	/// a cache for getInfo()
 	mutable docstring info_;
-	/// key to use when citing this entry 
-	/// currently used only by XHTML output routines
-	docstring cite_key_;
+	/// 
+	docstring cite_number_;
+	///
+	char modifier_;
 	/// our map: <field, value>
 	std::map <docstring, docstring> bimap_;
 };
@@ -140,14 +161,25 @@ public:
 	std::vector<docstring> const getEntries() const;
 	/// \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 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
-	docstring const getYear(docstring const & key) const;
+	/// not present in the record itself.	
+	docstring const getYear(docstring const & key,
+			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. 
 	/// Note that this will retrieve data from the crossref as needed.
-	docstring const getInfo(docstring const & key) const;
+	/// 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;
+	/// 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
@@ -181,7 +213,10 @@ public:
 	void collectCitedEntries(Buffer const & buf);
 	/// A list of BibTeX keys cited in the current document, sorted by
 	/// the last name of the author.
-	std::vector<docstring> const & citedEntries() const { return cited_entries_; }
+	/// 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 
+		{ return cited_entries_; }
 	///
 	void makeCitationLabels(Buffer const & buf);
 	///