3 * \file CiteEnginesList.cpp
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Richard Kimberly Heck
8 * \author Jürgen Spitzmüller
10 * Full author contact details are available in file CREDITS.
15 #include "CiteEnginesList.h"
17 #include "LaTeXFeatures.h"
20 #include "support/debug.h"
21 #include "support/FileName.h"
22 #include "support/gettext.h"
23 #include "support/filetools.h"
24 #include "support/lstrings.h"
25 #include "support/Translator.h"
30 using namespace lyx::support;
35 //global variable: cite engine list
36 CiteEnginesList theCiteEnginesList;
39 LyXCiteEngine::LyXCiteEngine(string const & n, string const & i,
40 vector<string> const & cet, string const & cfm,
41 vector<string> const & dbs,
42 string const & d, vector<string> const & p):
43 name_(n), id_(i), engine_types_(cet), cite_framework_(cfm), default_biblios_(dbs),
44 description_(d), package_list_(p), checked_(false), available_(false)
46 filename_ = id_ + ".citeengine";
50 vector<string> LyXCiteEngine::prerequisites() const
54 return prerequisites_;
58 bool LyXCiteEngine::isAvailable() const
60 if (package_list_.empty())
66 //check whether all of the required packages are available
67 vector<string>::const_iterator it = package_list_.begin();
68 vector<string>::const_iterator end = package_list_.end();
69 for (; it != end; ++it) {
70 if (!LaTeXFeatures::isAvailable(*it)) {
72 prerequisites_.push_back(*it);
79 bool LyXCiteEngine::hasEngineType(CiteEngineType const & et) const
81 return std::find(engine_types_.begin(), engine_types_.end(),
82 theCiteEnginesList.getTypeAsString(et)) != engine_types_.end();
86 string LyXCiteEngine::getDefaultBiblio(CiteEngineType const & cet) const
89 string const etp = theCiteEnginesList.getTypeAsString(cet) + ":";
90 //check whether all of the required packages are available
91 for (string const &s: default_biblios_) {
94 else if (!contains(s, ':') && res.empty())
101 bool LyXCiteEngine::isDefaultBiblio(string const & bf) const
103 string const bfs = ":" + bf;
104 for (string const & s: default_biblios_)
105 if (suffixIs(s, bfs) || bf == s)
112 bool LyXCiteEngine::required(string const & p) const
114 return find(package_list_.begin(), package_list_.end(), p) != package_list_.end();
118 // used when sorting the cite engine list.
121 int operator()(LyXCiteEngine const & ce1, LyXCiteEngine const & ce2) const
123 return _(ce1.getName()) < _(ce2.getName());
131 typedef Translator<string, CiteEngineType> CiteEngineTypeTranslator;
134 CiteEngineTypeTranslator const init_citeenginetypetranslator()
136 CiteEngineTypeTranslator translator("authoryear", ENGINE_TYPE_AUTHORYEAR);
137 translator.addPair("numerical", ENGINE_TYPE_NUMERICAL);
138 translator.addPair("default", ENGINE_TYPE_DEFAULT);
143 CiteEngineTypeTranslator const & citeenginetypetranslator()
145 static CiteEngineTypeTranslator const translator =
146 init_citeenginetypetranslator();
153 string CiteEnginesList::getTypeAsString(CiteEngineType const & et) const
155 return citeenginetypetranslator().find(et);
159 CiteEngineType CiteEnginesList::getType(string const & et) const
161 return citeenginetypetranslator().find(et);
165 // Much of this is borrowed from LayoutFileList::read()
166 bool CiteEnginesList::read()
168 FileName const real_file = libFileSearch("", "lyxciteengines.lst");
169 LYXERR(Debug::TCLASS, "Reading cite engines from `" << real_file << '\'');
171 if (real_file.empty()) {
172 LYXERR0("unable to find cite engines file `citeengines.lst'.\n"
173 << "No cite engines will be available.");
178 if (!lex.setFile(real_file)) {
179 LYXERR0("lyxlex was not able to set file: "
180 << real_file << ".\nNo cite engines will be available.");
185 LYXERR0("unable to open cite engines file `"
186 << to_utf8(makeDisplayPath(real_file.absFileName(), 1000))
187 << "'\nNo cite engines will be available.");
191 bool finished = false;
192 // Parse cite engines files
193 LYXERR(Debug::TCLASS, "Starting parsing of lyxciteengines.lst");
194 while (lex.isOK() && !finished) {
195 LYXERR(Debug::TCLASS, "\tline by line");
197 case Lexer::LEX_FEOF:
201 string const cename = lex.getString();
202 LYXERR(Debug::TCLASS, "Engine name: " << cename);
205 string const fname = lex.getString();
206 LYXERR(Debug::TCLASS, "Filename: " << fname);
209 string cet = lex.getString();
210 LYXERR(Debug::TCLASS, "Engine Type: " << cet);
212 while (!cet.empty()) {
214 cet = split(cet, p, '|');
219 string const citeframework = lex.getString();
220 LYXERR(Debug::TCLASS, "CiteFramework: " << citeframework);
223 string db = lex.getString();
224 LYXERR(Debug::TCLASS, "Default Biblio: " << db);
226 while (!db.empty()) {
228 db = split(db, p, '|');
233 string const desc = lex.getString();
234 LYXERR(Debug::TCLASS, "Description: " << desc);
238 string str = lex.getString();
239 LYXERR(Debug::TCLASS, "Packages: " << str);
241 while (!str.empty()) {
243 str = split(str, p, ',');
246 // This code is run when we have
247 // cename, fname, cets, citeframework, dbs, desc, pkgs
248 addCiteEngine(cename, fname, cets, citeframework, dbs, desc, pkgs);
252 LYXERR(Debug::TCLASS, "End of parsing of lyxciteengines.lst");
254 if (!theCiteEnginesList.empty())
255 sort(theCiteEnginesList.begin(), theCiteEnginesList.end(), EngineSorter());
260 void CiteEnginesList::addCiteEngine(string const & cename,
261 string const & filename, vector<string> const & cets,
262 string const & citeframework, vector<string> const & dbs,
263 string const & description, vector<string> const & pkgs)
265 LyXCiteEngine ce(cename, filename, cets, citeframework, dbs, description, pkgs);
266 englist_.push_back(ce);
270 LyXCiteEnginesList::const_iterator CiteEnginesList::begin() const
272 return englist_.begin();
276 LyXCiteEnginesList::iterator CiteEnginesList::begin()
278 return englist_.begin();
282 LyXCiteEnginesList::const_iterator CiteEnginesList::end() const
284 return englist_.end();
288 LyXCiteEnginesList::iterator CiteEnginesList::end()
290 return englist_.end();
294 LyXCiteEngine const * CiteEnginesList::operator[](string const & str) const
296 for (auto const & eng : englist_)
297 if (eng.getID() == str) {
304 LyXCiteEngine * CiteEnginesList::operator[](string const & str)
306 for (auto & eng : englist_)
307 if (eng.getID() == str) {