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> Separator;
155 typedef boost::tokenizer<Separator> Tokenizer;
157 Separator const separator(",");
158 Tokenizer const tokens(to_utf8(getParam("bibfiles")), separator);
159 Tokenizer::const_iterator const begin = tokens.begin();
160 Tokenizer::const_iterator const end = tokens.end();
162 std::ostringstream dbs;
163 for (Tokenizer::const_iterator it = begin; it != end; ++it) {
164 string const input = trim(*it);
166 normalize_name(buffer, runparams, input, ".bib");
167 string const in_file = database + ".bib";
169 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
170 isFileReadable(in_file)) {
172 // mangledFilename() needs the extension
173 database = removeExtension(FileName(in_file).mangledFilename());
174 string const out_file = makeAbsPath(database + ".bib",
175 buffer.getMasterBuffer()->temppath());
177 bool const success = copy(in_file, out_file);
179 lyxerr << "Failed to copy '" << in_file
180 << "' to '" << out_file << "'"
187 dbs << latex_path(database);
190 docstring const db_out = from_utf8(dbs.str());
192 // Post this warning only once.
193 static bool warned_about_spaces = false;
194 if (!warned_about_spaces &&
195 runparams.nice && db_out.find(' ') != docstring::npos) {
196 warned_about_spaces = true;
198 Alert::warning(_("Export Warning!"),
199 _("There are spaces in the paths to your BibTeX databases.\n"
200 "BibTeX will be unable to find them."));
205 string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
207 if (prefixIs(style, "bibtotoc")) {
208 bibtotoc = "bibtotoc";
209 if (contains(style, ',')) {
210 style = split(style, bibtotoc, ',');
217 if (!style.empty()) {
219 normalize_name(buffer, runparams, style, ".bst");
220 string const in_file = base + ".bst";
221 // If this style does not come from texmf and we are not
222 // exporting to .tex copy it to the tmp directory.
223 // This prevents problems with spaces and 8bit charcaters
225 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
226 isFileReadable(in_file)) {
227 // use new style name
228 base = removeExtension(
229 FileName(in_file).mangledFilename());
230 string const out_file = makeAbsPath(base + ".bst",
231 buffer.getMasterBuffer()->temppath());
232 bool const success = copy(in_file, out_file);
234 lyxerr << "Failed to copy '" << in_file
235 << "' to '" << out_file << "'"
240 os << "\\bibliographystyle{"
241 << from_utf8(latex_path(normalize_name(buffer, runparams, base, ".bst")))
246 // Post this warning only once.
247 static bool warned_about_bst_spaces = false;
248 if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) {
249 warned_about_bst_spaces = true;
250 Alert::warning(_("Export Warning!"),
251 _("There are spaces in the path to your BibTeX style file.\n"
252 "BibTeX will be unable to find it."));
255 if (!db_out.empty() && buffer.params().use_bibtopic){
256 os << "\\begin{btSect}{" << db_out << "}\n";
257 docstring btprint = getParam("btprint");
260 btprint = from_ascii("btPrintCited");
261 os << "\\" << btprint << "\n"
262 << "\\end{btSect}\n";
267 if (!bibtotoc.empty() && !buffer.params().use_bibtopic) {
268 // maybe a problem when a textclass has no "art" as
269 // part of its name, because it's than book.
270 // For the "official" lyx-layouts it's no problem to support
272 if (!contains(buffer.params().getLyXTextClass().name(),
274 if (buffer.params().sides == LyXTextClass::OneSide) {
279 os << "\\cleardoublepage";
283 os << "\\addcontentsline{toc}{chapter}{\\bibname}";
287 os << "\\addcontentsline{toc}{section}{\\refname}";
291 if (!db_out.empty() && !buffer.params().use_bibtopic){
292 os << "\\bibliography{" << db_out << "}\n";
300 vector<string> const InsetBibtex::getFiles(Buffer const & buffer) const
302 Path p(buffer.filePath());
308 string bibfiles = to_utf8(getParam("bibfiles"));
309 bibfiles = split(bibfiles, tmp, ',');
310 while (!tmp.empty()) {
311 string file = findtexfile(changeExtension(tmp, "bib"), "bib");
312 lyxerr[Debug::LATEX] << "Bibfile: " << file << endl;
314 // If we didn't find a matching file name just fail silently
318 // Get next file name
319 bibfiles = split(bibfiles, tmp, ',');
326 // This method returns a comma separated list of Bibtex entries
327 void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
328 std::vector<std::pair<string, string> > & keys) const
330 vector<string> const files = getFiles(buffer);
331 for (vector<string>::const_iterator it = files.begin();
332 it != files.end(); ++ it) {
333 // This is a _very_ simple parser for Bibtex database
334 // files. All it does is to look for lines starting
335 // in @ and not being @preamble and @string entries.
336 // It does NOT do any syntax checking!
337 ifstream ifs(it->c_str());
339 while (getline(ifs, linebuf0)) {
340 string linebuf = trim(linebuf0);
341 if (linebuf.empty()) continue;
342 if (prefixIs(linebuf, "@")) {
343 linebuf = subst(linebuf, '{', '(');
345 linebuf = split(linebuf, tmp, '(');
346 tmp = ascii_lowercase(tmp);
347 if (!prefixIs(tmp, "@string")
348 && !prefixIs(tmp, "@preamble")) {
349 linebuf = split(linebuf, tmp, ',');
350 tmp = ltrim(tmp, " \t");
352 keys.push_back(pair<string,string>(tmp,string()));
355 } else if (!keys.empty()) {
356 keys.back().second += linebuf + "\n";
363 bool InsetBibtex::addDatabase(string const & db)
366 string bibfiles(to_utf8(getParam("bibfiles")));
367 if (tokenPos(bibfiles, ',', db) == -1) {
368 if (!bibfiles.empty())
370 setParam("bibfiles", from_utf8(bibfiles + db));
377 bool InsetBibtex::delDatabase(string const & db)
380 string bibfiles(to_utf8(getParam("bibfiles")));
381 if (contains(bibfiles, db)) {
382 int const n = tokenPos(bibfiles, ',', db);
385 // this is not the first database
386 string tmp = ',' + bd;
387 setParam("bibfiles", from_utf8(subst(bibfiles, tmp, string())));
389 // this is the first (or only) database
390 setParam("bibfiles", from_utf8(split(bibfiles, bd, ',')));
398 void InsetBibtex::validate(LaTeXFeatures & features) const
400 if (features.bufferParams().use_bibtopic)
401 features.require("bibtopic");