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"
32 ENGINE_NATBIB_AUTHORYEAR,
33 ENGINE_NATBIB_NUMERICAL,
53 CitationStyle(CiteStyle s = CITE, bool f = false, bool force = false)
54 : style(s), full(f), forceUCase(force) {}
55 /// \param latex_str a LaTeX command, "cite", "Citep*", etc
56 CitationStyle(std::string const & latex_str);
58 std::string const asLatexStr() const;
67 /// Returns a vector of available Citation styles.
68 std::vector<CiteStyle> const getCiteStyles(CiteEngine const );
72 /// Class to represent information about a BibTeX or
73 /// bibliography entry.
74 /// The keys are BibTeX fields (e.g., author, title, etc),
75 /// and the values are the associated field values.
79 typedef std::map<docstring, docstring>::const_iterator const_iterator;
80 /// argument sets isBibTeX_, so should be false only if it's coming
81 /// from a bibliography environment
82 BibTeXInfo(bool ib = true);
83 /// constructor that sets the entryType
84 BibTeXInfo(docstring const & key, docstring const & type);
85 /// Search for the given field and return the associated info.
86 /// The point of this is that BibTeXInfo::operator[] has no const
88 docstring const & getValueForField(docstring const & field) const;
90 docstring const & getValueForField(std::string const & field) const;
92 bool hasField(docstring const & field) const;
93 /// return the short form of an authorlist
94 docstring const getAbbreviatedAuthor() const;
96 docstring const getYear() const;
97 /// Returns formatted BibTeX data suitable for framing.
98 docstring const getInfo() const;
100 int count(docstring const & f) const { return bimap_.count(f); }
102 const_iterator find(docstring const & f) const { return bimap_.find(f); }
104 const_iterator end() const { return bimap_.end(); }
106 docstring & operator[](docstring const & f)
107 { return bimap_[f]; }
109 docstring const & allData() const { return all_data_; }
111 void setAllData(docstring const & d) { all_data_ = d; }
113 docstring entryType() const { return entry_type_; }
115 /// true if from BibTeX; false if from bibliography environment
117 /// the BibTeX key for this entry
119 /// a single string containing all BibTeX data associated with this key
121 /// the BibTeX entry type (article, book, incollection, ...)
122 docstring entry_type_;
123 /// our map: <field, value>
124 std::map <docstring, docstring> bimap_;
128 /// Class to represent a collection of bibliographical data, whether
129 /// from BibTeX or from bibliography environments.
130 /// BiblioInfo.first is the bibliography key
131 /// BiblioInfo.second is the data for that key
135 typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
136 /// Returns a sorted vector of bibliography keys
137 std::vector<docstring> const getKeys() const;
138 /// Returns a sorted vector of present BibTeX fields
139 std::vector<docstring> const getFields() const;
140 /// Returns a sorted vector of BibTeX entry types in use
141 std::vector<docstring> const getEntries() const;
142 /// Fills keys with BibTeX information derived from the various insets
143 /// in a given buffer, in its master document.
144 void fillWithBibKeys(Buffer const * const buf);
145 /// return the short form of an authorlist
146 docstring const getAbbreviatedAuthor(docstring const & key) const;
147 /// return the year from the bibtex data record
148 docstring const getYear(docstring const & key) const;
149 /// Returns formatted BibTeX data associated with a given key.
150 /// Empty if no info exists.
151 docstring const getInfo(docstring const & key) const;
154 * "Translates" the available Citation Styles into strings for a given key,
155 * either numerical or author-year depending upon the active engine. (See
156 * below for those methods.)
158 std::vector<docstring> const
159 getCiteStrings(docstring const & key, Buffer const & buf) const;
161 * "Translates" the available Citation Styles into strings for a given key.
162 * The returned string is displayed by the GUI.
163 * [XX] is used in place of the actual reference
164 * Eg, the vector will contain: [XX], Jones et al. [XX], ...
169 std::vector<docstring> const
170 getNumericalStrings(docstring const & key, Buffer const & buf) const;
172 * "Translates" the available Citation Styles into strings for a given key.
173 * The returned string is displayed by the GUI.
174 * Eg, the vector will contain:
175 * Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ...
180 std::vector<docstring> const
181 getAuthorYearStrings(docstring const & key, Buffer const & buf) const;
183 const_iterator begin() const { return bimap_.begin(); }
185 void clear() { bimap_.clear(); }
187 bool empty() const { return bimap_.empty(); }
189 const_iterator end() const { return bimap_.end(); }
191 const_iterator find(docstring const & f) const { return bimap_.find(f); }
193 BibTeXInfo & operator[](docstring const & f) { return bimap_[f]; }
195 void addFieldName(docstring const & f) { field_names_.insert(f); }
197 void addEntryType(docstring const & f) { entry_types_.insert(f); }
200 std::set<docstring> field_names_;
202 std::set<docstring> entry_types_;
203 /// our map: keys --> BibTeXInfo
204 std::map<docstring, BibTeXInfo> bimap_;