3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
8 * Full author contact details are available in file CREDITS.
13 #include "insetbibtex.h"
16 #include "bufferparams.h"
17 #include "dispatchresult.h"
19 #include "funcrequest.h"
21 #include "LaTeXFeatures.h"
22 #include "metricsinfo.h"
23 #include "outputparams.h"
25 #include "frontends/Alert.h"
27 #include "support/filename.h"
28 #include "support/filetools.h"
29 #include "support/lstrings.h"
30 #include "support/lyxlib.h"
31 #include "support/os.h"
32 #include "support/path.h"
34 #include <boost/tokenizer.hpp>
42 using support::absolutePath;
43 using support::ascii_lowercase;
44 using support::changeExtension;
45 using support::contains;
47 using support::FileName;
48 using support::findtexfile;
49 using support::isFileReadable;
50 using support::latex_path;
52 using support::makeAbsPath;
53 using support::makeRelPath;
55 using support::prefixIs;
56 using support::removeExtension;
60 using support::tokenPos;
63 namespace Alert = frontend::Alert;
64 namespace os = support::os;
75 InsetBibtex::InsetBibtex(InsetCommandParams const & p)
76 : InsetCommand(p, "bibtex")
80 std::auto_ptr<InsetBase> InsetBibtex::doClone() const
82 return std::auto_ptr<InsetBase>(new InsetBibtex(*this));
86 void InsetBibtex::doDispatch(LCursor & cur, FuncRequest & cmd)
90 case LFUN_INSET_MODIFY: {
91 InsetCommandParams p("bibtex");
92 InsetCommandMailer::string2params("bibtex", to_utf8(cmd.argument()), p);
93 if (!p.getCmdName().empty()) {
95 cur.buffer().updateBibfilesCache();
102 InsetCommand::doDispatch(cur, cmd);
108 docstring const InsetBibtex::getScreenLabel(Buffer const &) const
110 return _("BibTeX Generated Bibliography");
116 string normalize_name(Buffer const & buffer, OutputParams const & runparams,
117 string const & name, string const & ext)
119 string const fname = makeAbsPath(name, buffer.filePath());
120 if (absolutePath(name) || !isFileReadable(fname + ext))
122 else if (!runparams.nice)
125 return makeRelPath(fname, buffer.getMasterBuffer()->filePath());
131 int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
132 OutputParams const & runparams) const
134 // the sequence of the commands:
135 // 1. \bibliographystyle{style}
136 // 2. \addcontentsline{...} - if option bibtotoc set
137 // 3. \bibliography{database}
138 // and with bibtopic:
139 // 1. \bibliographystyle{style}
140 // 2. \begin{btSect}{database}
141 // 3. \btPrint{Cited|NotCited|All}
145 // If we are processing the LaTeX file in a temp directory then
146 // copy the .bib databases to this temp directory, mangling their
147 // names in the process. Store this mangled name in the list of
149 // (We need to do all this because BibTeX *really*, *really*
150 // can't handle "files with spaces" and Windows users tend to
151 // use such filenames.)
152 // Otherwise, store the (maybe absolute) path to the original,
153 // unmangled database name.
154 typedef boost::char_separator<char_type> Separator;
155 typedef boost::tokenizer<Separator, docstring::const_iterator, docstring> Tokenizer;
157 Separator const separator(from_ascii(",").c_str());
158 Tokenizer const tokens(getParam("bibfiles"), separator);
159 Tokenizer::const_iterator const begin = tokens.begin();
160 Tokenizer::const_iterator const end = tokens.end();
162 odocstringstream dbs;
163 for (Tokenizer::const_iterator it = begin; it != end; ++it) {
164 docstring const input = trim(*it);
166 string utf8input(to_utf8(input));
168 normalize_name(buffer, runparams, utf8input, ".bib");
169 string const in_file = database + ".bib";
171 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
172 isFileReadable(in_file)) {
174 // mangledFilename() needs the extension
175 database = removeExtension(FileName(in_file).mangledFilename());
176 string const out_file = makeAbsPath(database + ".bib",
177 buffer.getMasterBuffer()->temppath());
179 bool const success = copy(in_file, out_file);
181 lyxerr << "Failed to copy '" << in_file
182 << "' to '" << out_file << "'"
190 dbs << from_utf8(latex_path(database));
192 docstring const db_out = dbs.str();
194 // Post this warning only once.
195 static bool warned_about_spaces = false;
196 if (!warned_about_spaces &&
197 runparams.nice && db_out.find(' ') != docstring::npos) {
198 warned_about_spaces = true;
200 Alert::warning(_("Export Warning!"),
201 _("There are spaces in the paths to your BibTeX databases.\n"
202 "BibTeX will be unable to find them."));
207 string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
209 if (prefixIs(style, "bibtotoc")) {
210 bibtotoc = "bibtotoc";
211 if (contains(style, ',')) {
212 style = split(style, bibtotoc, ',');
219 if (!style.empty()) {
221 normalize_name(buffer, runparams, style, ".bst");
222 string const in_file = base + ".bst";
223 // If this style does not come from texmf and we are not
224 // exporting to .tex copy it to the tmp directory.
225 // This prevents problems with spaces and 8bit charcaters
227 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
228 isFileReadable(in_file)) {
229 // use new style name
230 base = removeExtension(
231 FileName(in_file).mangledFilename());
232 string const out_file = makeAbsPath(base + ".bst",
233 buffer.getMasterBuffer()->temppath());
234 bool const success = copy(in_file, out_file);
236 lyxerr << "Failed to copy '" << in_file
237 << "' to '" << out_file << "'"
242 os << "\\bibliographystyle{"
243 << from_utf8(latex_path(normalize_name(buffer, runparams, base, ".bst")))
248 // Post this warning only once.
249 static bool warned_about_bst_spaces = false;
250 if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) {
251 warned_about_bst_spaces = true;
252 Alert::warning(_("Export Warning!"),
253 _("There are spaces in the path to your BibTeX style file.\n"
254 "BibTeX will be unable to find it."));
257 if (!db_out.empty() && buffer.params().use_bibtopic){
258 os << "\\begin{btSect}{" << db_out << "}\n";
259 docstring btprint = getParam("btprint");
262 btprint = from_ascii("btPrintCited");
263 os << "\\" << btprint << "\n"
264 << "\\end{btSect}\n";
269 if (!bibtotoc.empty() && !buffer.params().use_bibtopic) {
270 // maybe a problem when a textclass has no "art" as
271 // part of its name, because it's than book.
272 // For the "official" lyx-layouts it's no problem to support
274 if (!contains(buffer.params().getLyXTextClass().name(),
276 if (buffer.params().sides == LyXTextClass::OneSide) {
281 os << "\\cleardoublepage";
285 os << "\\addcontentsline{toc}{chapter}{\\bibname}";
289 os << "\\addcontentsline{toc}{section}{\\refname}";
293 if (!db_out.empty() && !buffer.params().use_bibtopic){
294 os << "\\bibliography{" << db_out << "}\n";
302 vector<string> const InsetBibtex::getFiles(Buffer const & buffer) const
304 Path p(buffer.filePath());
310 string bibfiles = to_utf8(getParam("bibfiles"));
311 bibfiles = split(bibfiles, tmp, ',');
312 while (!tmp.empty()) {
313 string file = findtexfile(changeExtension(tmp, "bib"), "bib");
314 lyxerr[Debug::LATEX] << "Bibfile: " << file << endl;
316 // If we didn't find a matching file name just fail silently
320 // Get next file name
321 bibfiles = split(bibfiles, tmp, ',');
328 // This method returns a comma separated list of Bibtex entries
329 void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
330 std::vector<std::pair<string, string> > & keys) const
332 vector<string> const files = getFiles(buffer);
333 for (vector<string>::const_iterator it = files.begin();
334 it != files.end(); ++ it) {
335 // This is a _very_ simple parser for Bibtex database
336 // files. All it does is to look for lines starting
337 // in @ and not being @preamble and @string entries.
338 // It does NOT do any syntax checking!
339 ifstream ifs(it->c_str());
341 while (getline(ifs, linebuf0)) {
342 string linebuf = trim(linebuf0);
343 if (linebuf.empty()) continue;
344 if (prefixIs(linebuf, "@")) {
345 linebuf = subst(linebuf, '{', '(');
347 linebuf = split(linebuf, tmp, '(');
348 tmp = ascii_lowercase(tmp);
349 if (!prefixIs(tmp, "@string")
350 && !prefixIs(tmp, "@preamble")) {
351 linebuf = split(linebuf, tmp, ',');
352 tmp = ltrim(tmp, " \t");
354 keys.push_back(pair<string,string>(tmp,string()));
357 } else if (!keys.empty()) {
358 keys.back().second += linebuf + "\n";
365 bool InsetBibtex::addDatabase(string const & db)
368 string bibfiles(to_utf8(getParam("bibfiles")));
369 if (tokenPos(bibfiles, ',', db) == -1) {
370 if (!bibfiles.empty())
372 setParam("bibfiles", from_utf8(bibfiles + db));
379 bool InsetBibtex::delDatabase(string const & db)
382 string bibfiles(to_utf8(getParam("bibfiles")));
383 if (contains(bibfiles, db)) {
384 int const n = tokenPos(bibfiles, ',', db);
387 // this is not the first database
388 string tmp = ',' + bd;
389 setParam("bibfiles", from_utf8(subst(bibfiles, tmp, string())));
391 // this is the first (or only) database
392 setParam("bibfiles", from_utf8(split(bibfiles, bd, ',')));
400 void InsetBibtex::validate(LaTeXFeatures & features) const
402 if (features.bufferParams().use_bibtopic)
403 features.require("bibtopic");