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;
62 /// \return formatted BibTeX data suitable for framing.
63 docstring const getInfo() const;
65 int count(docstring const & f) const { return bimap_.count(f); }
67 const_iterator find(docstring const & f) const { return bimap_.find(f); }
69 const_iterator end() const { return bimap_.end(); }
70 /// \return value for field f
71 /// note that this will create an empty field if it does not exist
72 docstring & operator[](docstring const & f)
74 /// \return value for field f
75 /// this one, since it is const, will simply return docstring() if
76 /// we don't have the field and will NOT create an empty field
77 docstring const & operator[](docstring const & field) const;
79 docstring const & operator[](std::string const & field) const;
81 docstring const & allData() const { return all_data_; }
83 void setAllData(docstring const & d) { all_data_ = d; }
85 docstring entryType() const { return entry_type_; }
87 /// true if from BibTeX; false if from bibliography environment
89 /// the BibTeX key for this entry
91 /// a single string containing all BibTeX data associated with this key
93 /// the BibTeX entry type (article, book, incollection, ...)
94 docstring entry_type_;
95 /// a cache for getInfo()
96 mutable docstring info_;
97 /// our map: <field, value>
98 std::map <docstring, docstring> bimap_;
102 /// Class to represent a collection of bibliographical data, whether
103 /// from BibTeX or from bibliography environments.
106 /// bibliography key --> data for that key
107 typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
108 /// \return a sorted vector of bibliography keys
109 std::vector<docstring> const getKeys() const;
110 /// \return a sorted vector of present BibTeX fields
111 std::vector<docstring> const getFields() const;
112 /// \return a sorted vector of BibTeX entry types in use
113 std::vector<docstring> const getEntries() const;
114 /// \return the short form of an authorlist
115 docstring const getAbbreviatedAuthor(docstring const & key) const;
116 /// \return the year from the bibtex data record
117 docstring const getYear(docstring const & key) const;
118 /// \return formatted BibTeX data associated with a given key.
119 /// Empty if no info exists.
120 docstring const getInfo(docstring const & key) const;
122 * "Translates" the available Citation Styles into strings for a given key,
123 * either numerical or author-year depending upon the active engine. (See
124 * below for those methods.)
126 std::vector<docstring> const
127 getCiteStrings(docstring const & key, Buffer const & buf) const;
129 * "Translates" the available Citation Styles into strings for a given key.
130 * The returned string is displayed by the GUI.
131 * [XX] is used in place of the actual reference
132 * Eg, the vector will contain: [XX], Jones et al. [XX], ...
137 std::vector<docstring> const
138 getNumericalStrings(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 * Eg, the vector will contain:
143 * Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ...
148 std::vector<docstring> const
149 getAuthorYearStrings(docstring const & key, Buffer const & buf) const;
151 const_iterator begin() const { return bimap_.begin(); }
153 void clear() { bimap_.clear(); }
155 bool empty() const { return bimap_.empty(); }
157 const_iterator end() const { return bimap_.end(); }
159 const_iterator find(docstring const & f) const { return bimap_.find(f); }
161 void mergeBiblioInfo(BiblioInfo const & info);
163 BibTeXInfo & operator[](docstring const & f) { return bimap_[f]; }
165 void addFieldName(docstring const & f) { field_names_.insert(f); }
167 void addEntryType(docstring const & f) { entry_types_.insert(f); }
170 std::set<docstring> field_names_;
172 std::set<docstring> entry_types_;
173 /// our map: keys --> BibTeXInfo
174 std::map<docstring, BibTeXInfo> bimap_;
179 #endif // BIBLIOINFO_H