3 * \file CiteEnginesList.cpp
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Jürgen Spitzmüller
10 * Full author contact details are available in file CREDITS.
15 #include "CiteEnginesList.h"
18 #include "LaTeXFeatures.h"
21 #include "support/debug.h"
22 #include "support/FileName.h"
23 #include "support/gettext.h"
24 #include "support/filetools.h"
25 #include "support/lstrings.h"
26 #include "support/Translator.h"
31 using namespace lyx::support;
36 //global variable: cite engine list
37 CiteEnginesList theCiteEnginesList;
40 LyXCiteEngine::LyXCiteEngine(string const & n, string const & i,
41 vector<string> const & cet, string const & cfm,
42 vector<string> const & dbs,
43 string const & d, vector<string> const & p):
44 name_(n), id_(i), engine_types_(cet), cite_framework_(cfm), default_biblios_(dbs),
45 description_(d), package_list_(p), checked_(false), available_(false)
47 filename_ = id_ + ".citeengine";
51 vector<string> LyXCiteEngine::prerequisites() const
55 return prerequisites_;
59 bool LyXCiteEngine::isAvailable() const
61 if (package_list_.empty())
67 //check whether all of the required packages are available
68 vector<string>::const_iterator it = package_list_.begin();
69 vector<string>::const_iterator end = package_list_.end();
70 for (; it != end; ++it) {
71 if (!LaTeXFeatures::isAvailable(*it)) {
73 prerequisites_.push_back(*it);
80 bool LyXCiteEngine::hasEngineType(CiteEngineType const & et) const
82 return std::find(engine_types_.begin(), engine_types_.end(),
83 theCiteEnginesList.getTypeAsString(et)) != engine_types_.end();
87 string LyXCiteEngine::getDefaultBiblio(CiteEngineType const & cet) const
90 string const etp = theCiteEnginesList.getTypeAsString(cet) + ":";
91 //check whether all of the required packages are available
92 for (string const &s: default_biblios_) {
95 else if (!contains(s, ':') && res.empty())
102 bool LyXCiteEngine::isDefaultBiblio(string const & bf) const
104 string const bfs = ":" + bf;
105 for (string const &s: default_biblios_)
106 if (suffixIs(s, bfs) || bf == s)
113 bool LyXCiteEngine::requires(const string p) const
115 return find(package_list_.begin(), package_list_.end(), p) != package_list_.end();
119 // used when sorting the cite engine list.
122 int operator()(LyXCiteEngine const & ce1, LyXCiteEngine const & ce2) const
124 return _(ce1.getName()) < _(ce2.getName());
132 typedef Translator<string, CiteEngineType> CiteEngineTypeTranslator;
135 CiteEngineTypeTranslator const init_citeenginetypetranslator()
137 CiteEngineTypeTranslator translator("authoryear", ENGINE_TYPE_AUTHORYEAR);
138 translator.addPair("numerical", ENGINE_TYPE_NUMERICAL);
139 translator.addPair("default", ENGINE_TYPE_DEFAULT);
144 CiteEngineTypeTranslator const & citeenginetypetranslator()
146 static CiteEngineTypeTranslator const translator =
147 init_citeenginetypetranslator();
154 string CiteEnginesList::getTypeAsString(CiteEngineType const & et) const
156 return citeenginetypetranslator().find(et);
160 CiteEngineType CiteEnginesList::getType(string const & et) const
162 return citeenginetypetranslator().find(et);
166 // Much of this is borrowed from LayoutFileList::read()
167 bool CiteEnginesList::read()
169 FileName const real_file = libFileSearch("", "lyxciteengines.lst");
170 LYXERR(Debug::TCLASS, "Reading cite engines from `" << real_file << '\'');
172 if (real_file.empty()) {
173 LYXERR0("unable to find cite engines file `citeengines.lst'.\n"
174 << "No cite engines will be available.");
179 if (!lex.setFile(real_file)) {
180 LYXERR0("lyxlex was not able to set file: "
181 << real_file << ".\nNo cite engines will be available.");
186 LYXERR0("unable to open cite engines file `"
187 << to_utf8(makeDisplayPath(real_file.absFileName(), 1000))
188 << "'\nNo cite engines will be available.");
192 bool finished = false;
193 // Parse cite engines files
194 LYXERR(Debug::TCLASS, "Starting parsing of lyxciteengines.lst");
195 while (lex.isOK() && !finished) {
196 LYXERR(Debug::TCLASS, "\tline by line");
198 case Lexer::LEX_FEOF:
202 string const cename = lex.getString();
203 LYXERR(Debug::TCLASS, "Engine name: " << cename);
206 string const fname = lex.getString();
207 LYXERR(Debug::TCLASS, "Filename: " << fname);
210 string cet = lex.getString();
211 LYXERR(Debug::TCLASS, "Engine Type: " << cet);
213 while (!cet.empty()) {
215 cet = split(cet, p, '|');
220 string const citeframework = lex.getString();
221 LYXERR(Debug::TCLASS, "CiteFramework: " << citeframework);
224 string db = lex.getString();
225 LYXERR(Debug::TCLASS, "Default Biblio: " << db);
227 while (!db.empty()) {
229 db = split(db, p, '|');
234 string const desc = lex.getString();
235 LYXERR(Debug::TCLASS, "Description: " << desc);
239 string str = lex.getString();
240 LYXERR(Debug::TCLASS, "Packages: " << str);
242 while (!str.empty()) {
244 str = split(str, p, ',');
247 // This code is run when we have
248 // cename, fname, cets, citeframework, dbs, desc, pkgs
249 addCiteEngine(cename, fname, cets, citeframework, dbs, desc, pkgs);
253 LYXERR(Debug::TCLASS, "End of parsing of lyxciteengines.lst");
255 if (!theCiteEnginesList.empty())
256 sort(theCiteEnginesList.begin(), theCiteEnginesList.end(), EngineSorter());
261 void CiteEnginesList::addCiteEngine(string const & cename,
262 string const & filename, vector<string> const & cets,
263 string const & citeframework, vector<string> const & dbs,
264 string const & description, vector<string> const & pkgs)
266 LyXCiteEngine ce(cename, filename, cets, citeframework, dbs, description, pkgs);
267 englist_.push_back(ce);
271 LyXCiteEnginesList::const_iterator CiteEnginesList::begin() const
273 return englist_.begin();
277 LyXCiteEnginesList::iterator CiteEnginesList::begin()
279 return englist_.begin();
283 LyXCiteEnginesList::const_iterator CiteEnginesList::end() const
285 return englist_.end();
289 LyXCiteEnginesList::iterator CiteEnginesList::end()
291 return englist_.end();
295 LyXCiteEngine const * CiteEnginesList::operator[](string const & str) const
297 LyXCiteEnginesList::const_iterator it = englist_.begin();
298 for (; it != englist_.end(); ++it)
299 if (it->getID() == str) {
300 LyXCiteEngine const & eng = *it;
307 LyXCiteEngine * CiteEnginesList::operator[](string const & str)
309 LyXCiteEnginesList::iterator it = englist_.begin();
310 for (; it != englist_.end(); ++it)
311 if (it->getID() == str) {
312 LyXCiteEngine & eng = *it;