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);
57 bool hasField(docstring const & field) const;
58 /// \return the short form of an authorlist
59 docstring const getAbbreviatedAuthor() const;
61 docstring const getYear() const;
63 docstring const getXRef() const;
64 /// \return formatted BibTeX data suitable for framing.
65 /// \param pointer to crossref information
66 docstring const & getInfo(BibTeXInfo const * const xref = 0) const;
68 int count(docstring const & f) const { return bimap_.count(f); }
70 const_iterator find(docstring const & f) const { return bimap_.find(f); }
72 const_iterator end() const { return bimap_.end(); }
73 /// \return value for field f
74 /// note that this will create an empty field if it does not exist
75 docstring & operator[](docstring const & f)
77 /// \return value for field f
78 /// this one, since it is const, will simply return docstring() if
79 /// we don't have the field and will NOT create an empty field
80 docstring const & operator[](docstring const & field) const;
82 docstring const & operator[](std::string const & field) const;
84 docstring const & allData() const { return all_data_; }
86 void setAllData(docstring const & d) { all_data_ = d; }
88 docstring entryType() const { return entry_type_; }
90 /// like operator[], except, if the field is empty, it will attempt
91 /// to get the data from xref BibTeXInfo object, which would normally
92 /// be the one referenced in the crossref field.
93 docstring getValueForKey(std::string const & key,
94 BibTeXInfo const * const xref = 0) const;
95 /// true if from BibTeX; false if from bibliography environment
97 /// the BibTeX key for this entry
99 /// a single string containing all BibTeX data associated with this key
101 /// the BibTeX entry type (article, book, incollection, ...)
102 docstring entry_type_;
103 /// a cache for getInfo()
104 mutable docstring info_;
105 /// our map: <field, value>
106 std::map <docstring, docstring> bimap_;
110 /// Class to represent a collection of bibliographical data, whether
111 /// from BibTeX or from bibliography environments.
114 /// bibliography key --> data for that key
115 typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
116 /// \return a sorted vector of bibliography keys
117 std::vector<docstring> const getKeys() const;
118 /// \return a sorted vector of present BibTeX fields
119 std::vector<docstring> const getFields() const;
120 /// \return a sorted vector of BibTeX entry types in use
121 std::vector<docstring> const getEntries() const;
122 /// \return the short form of an authorlist
123 docstring const getAbbreviatedAuthor(docstring const & key) const;
124 /// \return the year from the bibtex data record
125 /// Note that this will get the year from the crossref if it's
126 /// not present in the record itself
127 docstring const getYear(docstring const & key) const;
128 /// \return formatted BibTeX data associated with a given key.
129 /// Empty if no info exists.
130 /// Note that this will retrieve data from the crossref as needed.
131 docstring const getInfo(docstring const & key) const;
133 * "Translates" the available Citation Styles into strings for a given key,
134 * either numerical or author-year depending upon the active engine. (See
135 * below for those methods.)
137 std::vector<docstring> const
138 getCiteStrings(docstring const & key, Buffer const & buf) const;
140 * "Translates" the available Citation Styles into strings for a given key.
141 * The returned string is displayed by the GUI.
142 * [XX] is used in place of the actual reference
143 * Eg, the vector will contain: [XX], Jones et al. [XX], ...
148 std::vector<docstring> const
149 getNumericalStrings(docstring const & key, Buffer const & buf) const;
151 * "Translates" the available Citation Styles into strings for a given key.
152 * The returned string is displayed by the GUI.
153 * Eg, the vector will contain:
154 * Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ...
159 std::vector<docstring> const
160 getAuthorYearStrings(docstring const & key, Buffer const & buf) const;
162 const_iterator begin() const { return bimap_.begin(); }
164 void clear() { bimap_.clear(); }
166 bool empty() const { return bimap_.empty(); }
168 const_iterator end() const { return bimap_.end(); }
170 const_iterator find(docstring const & f) const { return bimap_.find(f); }
172 void mergeBiblioInfo(BiblioInfo const & info);
174 BibTeXInfo & operator[](docstring const & f) { return bimap_[f]; }
176 void addFieldName(docstring const & f) { field_names_.insert(f); }
178 void addEntryType(docstring const & f) { entry_types_.insert(f); }
181 std::set<docstring> field_names_;
183 std::set<docstring> entry_types_;
184 /// our map: keys --> BibTeXInfo
185 std::map<docstring, BibTeXInfo> bimap_;
190 #endif // BIBLIOINFO_H