4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
11 * Full author contact details are available in file CREDITS.
17 #include "support/docstring.h"
30 /// FIXME: To Citation.cpp?
31 /// Returns a vector of available Citation styles.
32 std::vector<CiteStyle> citeStyles(CiteEngine);
33 /// \param latex_str a LaTeX command, "cite", "Citep*", etc
34 CitationStyle citationStyleFromString(std::string const & latex_str);
35 /// the other way round
36 std::string citationStyleToString(CitationStyle const &);
39 /// Class to represent information about a BibTeX or
40 /// bibliography entry.
41 /// This class basically wraps a std::map, and many of its
42 /// methods simply delegate to the corresponding methods of
46 /// The keys are BibTeX fields (e.g., author, title, etc),
47 /// and the values are the associated field values.
48 typedef std::map<docstring, docstring>::const_iterator const_iterator;
50 BibTeXInfo() : is_bibtex_(true) {}
51 /// argument sets isBibTeX_, so should be false only if it's coming
52 /// from a bibliography environment
53 BibTeXInfo(bool ib) : is_bibtex_(ib) {}
54 /// constructor that sets the entryType
55 BibTeXInfo(docstring const & key, docstring const & type);
56 /// \return the short form of an authorlist
57 docstring const getAbbreviatedAuthor() const;
59 docstring const getYear() const;
61 docstring const getXRef() const;
62 /// \return formatted BibTeX data suitable for framing.
63 /// \param pointer to crossref information
64 docstring const & getInfo(BibTeXInfo const * const xref = 0) const;
66 const_iterator find(docstring const & f) const { return bimap_.find(f); }
68 const_iterator end() const { return bimap_.end(); }
69 /// \return value for field f
70 /// note that this will create an empty field if it does not exist
71 docstring & operator[](docstring const & f)
73 /// \return value for field f
74 /// this one, since it is const, will simply return docstring() if
75 /// we don't have the field and will NOT create an empty field
76 docstring const & operator[](docstring const & field) const;
78 docstring const & operator[](std::string const & field) const;
80 docstring const & allData() const { return all_data_; }
82 void setAllData(docstring const & d) { all_data_ = d; }
84 void label(docstring const & d) { label_= d; }
86 docstring const & label() const { return label_; }
88 docstring const & key() const { return bib_key_; }
90 docstring citeKey() const { return cite_key_; }
92 void setCiteKey(docstring const & k) { cite_key_ = k; }
94 docstring entryType() const { return entry_type_; }
96 bool isBibTeX() const { return is_bibtex_; }
98 /// like operator[], except, if the field is empty, it will attempt
99 /// to get the data from xref BibTeXInfo object, which would normally
100 /// be the one referenced in the crossref field.
101 docstring getValueForKey(std::string const & key,
102 BibTeXInfo const * const xref = 0) const;
103 /// true if from BibTeX; false if from bibliography environment
105 /// the BibTeX key for this entry
107 /// the label that will appear in citations
108 /// this is easily set from bibliography environments, but has
109 /// to be calculated for entries we get from BibTeX
111 /// a single string containing all BibTeX data associated with this key
113 /// the BibTeX entry type (article, book, incollection, ...)
114 docstring entry_type_;
115 /// a cache for getInfo()
116 mutable docstring info_;
117 /// key to use when citing this entry
118 /// currently used only by XHTML output routines
120 /// our map: <field, value>
121 std::map <docstring, docstring> bimap_;
125 /// Class to represent a collection of bibliographical data, whether
126 /// from BibTeX or from bibliography environments.
129 /// bibliography key --> data for that key
130 typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
131 /// \return a sorted vector of bibliography keys
132 std::vector<docstring> const getKeys() const;
133 /// \return a sorted vector of present BibTeX fields
134 std::vector<docstring> const getFields() const;
135 /// \return a sorted vector of BibTeX entry types in use
136 std::vector<docstring> const getEntries() const;
137 /// \return the short form of an authorlist
138 docstring const getAbbreviatedAuthor(docstring const & key) const;
139 /// \return the year from the bibtex data record
140 /// Note that this will get the year from the crossref if it's
141 /// not present in the record itself
142 docstring const getYear(docstring const & key) const;
143 /// \return formatted BibTeX data associated with a given key.
144 /// Empty if no info exists.
145 /// Note that this will retrieve data from the crossref as needed.
146 docstring const getInfo(docstring const & key) const;
148 * "Translates" the available Citation Styles into strings for a given key,
149 * either numerical or author-year depending upon the active engine. (See
150 * below for those methods.)
152 std::vector<docstring> const
153 getCiteStrings(docstring const & key, Buffer const & buf) const;
155 * "Translates" the available Citation Styles into strings for a given key.
156 * The returned string is displayed by the GUI.
157 * [XX] is used in place of the actual reference
158 * Eg, the vector will contain: [XX], Jones et al. [XX], ...
163 std::vector<docstring> const
164 getNumericalStrings(docstring const & key, Buffer const & buf) const;
166 * "Translates" the available Citation Styles into strings for a given key.
167 * The returned string is displayed by the GUI.
168 * Eg, the vector will contain:
169 * Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ...
174 std::vector<docstring> const
175 getAuthorYearStrings(docstring const & key, Buffer const & buf) const;
176 /// Collects the cited entries from buf.
177 void collectCitedEntries(Buffer const & buf);
178 /// A list of BibTeX keys cited in the current document, sorted by
179 /// the last name of the author.
180 std::vector<docstring> const & citedEntries() const { return cited_entries_; }
182 void makeCitationLabels(Buffer const & buf);
184 const_iterator begin() const { return bimap_.begin(); }
186 void clear() { bimap_.clear(); }
188 bool empty() const { return bimap_.empty(); }
190 const_iterator end() const { return bimap_.end(); }
192 const_iterator find(docstring const & f) const { return bimap_.find(f); }
194 void mergeBiblioInfo(BiblioInfo const & info);
196 BibTeXInfo & operator[](docstring const & f) { return bimap_[f]; }
198 void addFieldName(docstring const & f) { field_names_.insert(f); }
200 void addEntryType(docstring const & f) { entry_types_.insert(f); }
203 std::set<docstring> field_names_;
205 std::set<docstring> entry_types_;
206 /// our map: keys --> BibTeXInfo
207 std::map<docstring, BibTeXInfo> bimap_;
208 /// a possibly sorted list of entries cited in our Buffer.
209 /// do not try to make this a vector<BibTeXInfo *> or anything of
210 /// the sort, because reloads will invalidate those pointers.
211 std::vector<docstring> cited_entries_;
216 #endif // BIBLIOINFO_H