2 * \file InsetBibtex.cpp
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
7 * \author Richard Heck (BibTeX parser improvements)
9 * Full author contact details are available in file CREDITS.
14 #include "InsetBibtex.h"
17 #include "BufferParams.h"
18 #include "DispatchResult.h"
21 #include "FuncRequest.h"
22 #include "FuncStatus.h"
23 #include "LaTeXFeatures.h"
24 #include "MetricsInfo.h"
25 #include "OutputParams.h"
26 #include "TextClass.h"
28 #include "frontends/alert.h"
30 #include "support/convert.h"
31 #include "support/debug.h"
32 #include "support/docstream.h"
33 #include "support/ExceptionMessage.h"
34 #include "support/filetools.h"
35 #include "support/gettext.h"
36 #include "support/lstrings.h"
37 #include "support/os.h"
38 #include "support/Path.h"
39 #include "support/textutils.h"
44 using namespace lyx::support;
48 namespace Alert = frontend::Alert;
49 namespace os = support::os;
52 InsetBibtex::InsetBibtex(Buffer const & buf, InsetCommandParams const & p)
53 : InsetCommand(p, "bibtex")
55 Inset::setBuffer(const_cast<Buffer &>(buf));
56 buffer_->invalidateBibinfoCache();
60 InsetBibtex::~InsetBibtex()
63 buffer_->invalidateBibinfoCache();
67 ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */)
69 static ParamInfo param_info_;
70 if (param_info_.empty()) {
71 param_info_.add("btprint", ParamInfo::LATEX_OPTIONAL);
72 param_info_.add("bibfiles", ParamInfo::LATEX_REQUIRED);
73 param_info_.add("options", ParamInfo::LYX_INTERNAL);
79 void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
87 case LFUN_INSET_MODIFY: {
88 InsetCommandParams p(BIBTEX_CODE);
90 if (!InsetCommand::string2params("bibtex",
91 to_utf8(cmd.argument()), p)) {
95 } catch (ExceptionMessage const & message) {
96 if (message.type_ == WarningException) {
97 Alert::warning(message.title_, message.details_);
105 buffer().updateBibfilesCache();
110 InsetCommand::doDispatch(cur, cmd);
116 bool InsetBibtex::getStatus(Cursor & cur, FuncRequest const & cmd,
117 FuncStatus & flag) const
119 switch (cmd.action) {
120 case LFUN_INSET_EDIT:
121 flag.setEnabled(true);
125 return InsetCommand::getStatus(cur, cmd, flag);
130 void InsetBibtex::editDatabases() const
132 vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
134 if (bibfilelist.empty())
137 int nr_databases = bibfilelist.size();
138 if (nr_databases > 1) {
139 docstring message = bformat(_("The BibTeX inset includes %1$s databases.\n"
140 "If you proceed, all of them will be opened."),
141 convert<docstring>(nr_databases));
142 int const ret = Alert::prompt(_("Open Databases?"),
143 message, 0, 1, _("&Cancel"), _("&Proceed"));
149 vector<docstring>::const_iterator it = bibfilelist.begin();
150 vector<docstring>::const_iterator en = bibfilelist.end();
151 for (; it != en; ++it) {
152 FileName bibfile = getBibTeXPath(*it, buffer());
153 formats.edit(buffer(), bibfile,
154 formats.getFormatFromFile(bibfile));
159 docstring InsetBibtex::screenLabel() const
161 return _("BibTeX Generated Bibliography");
165 docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
167 docstring item = from_ascii("* ");
168 docstring tip = _("Databases:") + "\n";
169 vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
171 if (bibfilelist.empty()) {
175 vector<docstring>::const_iterator it = bibfilelist.begin();
176 vector<docstring>::const_iterator en = bibfilelist.end();
177 for (; it != en; ++it) {
185 docstring style = getParam("options"); // maybe empty! and with bibtotoc
186 docstring bibtotoc = from_ascii("bibtotoc");
187 if (prefixIs(style, bibtotoc)) {
189 if (contains(style, char_type(',')))
190 style = split(style, bibtotoc, char_type(','));
193 tip += _("Style File:") +"\n";
200 tip += "\n" + _("Lists:") + " ";
201 docstring btprint = getParam("btprint");
202 if (btprint == "btPrintAll")
203 tip += _("all references");
204 else if (btprint == "btPrintNotCited")
205 tip += _("all uncited references");
207 tip += _("all cited references");
211 tip += _("included in TOC");
218 static string normalizeName(Buffer const & buffer,
219 OutputParams const & runparams, string const & name, string const & ext)
221 string const fname = makeAbsPath(name, buffer.filePath()).absFilename();
222 if (FileName(name).isAbsolute() || !FileName(fname + ext).isReadableFile())
228 return to_utf8(makeRelPath(from_utf8(fname),
229 from_utf8(buffer.masterBuffer()->filePath())));
233 int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
235 // the sequence of the commands:
236 // 1. \bibliographystyle{style}
237 // 2. \addcontentsline{...} - if option bibtotoc set
238 // 3. \bibliography{database}
239 // and with bibtopic:
240 // 1. \bibliographystyle{style}
241 // 2. \begin{btSect}{database}
242 // 3. \btPrint{Cited|NotCited|All}
246 // If we are processing the LaTeX file in a temp directory then
247 // copy the .bib databases to this temp directory, mangling their
248 // names in the process. Store this mangled name in the list of
250 // (We need to do all this because BibTeX *really*, *really*
251 // can't handle "files with spaces" and Windows users tend to
252 // use such filenames.)
253 // Otherwise, store the (maybe absolute) path to the original,
254 // unmangled database name.
255 vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
256 vector<docstring>::const_iterator it = bibfilelist.begin();
257 vector<docstring>::const_iterator en = bibfilelist.end();
258 odocstringstream dbs;
261 for (; it != en; ++it) {
262 string utf8input = to_utf8(*it);
264 normalizeName(buffer(), runparams, utf8input, ".bib");
265 FileName const try_in_file =
266 makeAbsPath(database + ".bib", buffer().filePath());
267 bool const not_from_texmf = try_in_file.isReadableFile();
269 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
272 // mangledFilename() needs the extension
273 DocFileName const in_file = DocFileName(try_in_file);
274 database = removeExtension(in_file.mangledFilename());
275 FileName const out_file = makeAbsPath(database + ".bib",
276 buffer().masterBuffer()->temppath());
278 bool const success = in_file.copyTo(out_file);
280 lyxerr << "Failed to copy '" << in_file
281 << "' to '" << out_file << "'"
284 } else if (!runparams.inComment && runparams.nice && not_from_texmf &&
285 !isValidLaTeXFilename(database)) {
286 frontend::Alert::warning(_("Invalid filename"),
287 _("The following filename is likely to cause trouble "
288 "when running the exported file through LaTeX: ") +
289 from_utf8(database));
297 dbs << from_utf8(latex_path(database));
299 docstring const db_out = dbs.str();
301 // Post this warning only once.
302 static bool warned_about_spaces = false;
303 if (!warned_about_spaces &&
304 runparams.nice && db_out.find(' ') != docstring::npos) {
305 warned_about_spaces = true;
307 Alert::warning(_("Export Warning!"),
308 _("There are spaces in the paths to your BibTeX databases.\n"
309 "BibTeX will be unable to find them."));
312 string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
314 if (prefixIs(style, "bibtotoc")) {
315 bibtotoc = "bibtotoc";
316 if (contains(style, ','))
317 style = split(style, bibtotoc, ',');
324 if (!style.empty()) {
325 string base = normalizeName(buffer(), runparams, style, ".bst");
326 FileName const try_in_file =
327 makeAbsPath(base + ".bst", buffer().filePath());
328 bool const not_from_texmf = try_in_file.isReadableFile();
329 // If this style does not come from texmf and we are not
330 // exporting to .tex copy it to the tmp directory.
331 // This prevents problems with spaces and 8bit charcaters
333 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
335 // use new style name
336 DocFileName const in_file = DocFileName(try_in_file);
337 base = removeExtension(in_file.mangledFilename());
338 FileName const out_file = makeAbsPath(base + ".bst",
339 buffer().masterBuffer()->temppath());
340 bool const success = in_file.copyTo(out_file);
342 lyxerr << "Failed to copy '" << in_file
343 << "' to '" << out_file << "'"
348 os << "\\bibliographystyle{"
349 << from_utf8(latex_path(normalizeName(buffer(), runparams, base, ".bst")))
354 // Post this warning only once.
355 static bool warned_about_bst_spaces = false;
356 if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) {
357 warned_about_bst_spaces = true;
358 Alert::warning(_("Export Warning!"),
359 _("There are spaces in the path to your BibTeX style file.\n"
360 "BibTeX will be unable to find it."));
363 if (!db_out.empty() && buffer().params().use_bibtopic) {
364 os << "\\begin{btSect}{" << db_out << "}\n";
365 docstring btprint = getParam("btprint");
368 btprint = from_ascii("btPrintCited");
369 os << "\\" << btprint << "\n"
370 << "\\end{btSect}\n";
375 if (!bibtotoc.empty() && !buffer().params().use_bibtopic) {
376 if (buffer().params().documentClass().hasLaTeXLayout("chapter")) {
377 if (buffer().params().sides == OneSide) {
382 os << "\\cleardoublepage";
384 os << "\\addcontentsline{toc}{chapter}{\\bibname}";
385 } else if (buffer().params().documentClass().hasLaTeXLayout("section"))
386 os << "\\addcontentsline{toc}{section}{\\refname}";
389 if (!db_out.empty() && !buffer().params().use_bibtopic) {
390 docstring btprint = getParam("btprint");
391 if (btprint == "btPrintAll") {
392 os << "\\nocite{*}\n";
395 os << "\\bibliography{" << db_out << "}\n";
403 support::FileNameList InsetBibtex::getBibFiles() const
405 FileName path(buffer().filePath());
406 support::PathChanger p(path);
408 support::FileNameList vec;
410 vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
411 vector<docstring>::const_iterator it = bibfilelist.begin();
412 vector<docstring>::const_iterator en = bibfilelist.end();
413 for (; it != en; ++it) {
414 FileName const file =
415 findtexfile(changeExtension(to_utf8(*it), "bib"), "bib");
420 LYXERR0("Couldn't find " + to_utf8(*it) + " in InsetBibtex::getBibFiles()!");
429 // methods for parsing bibtex files
431 typedef map<docstring, docstring> VarMap;
433 /// remove whitespace characters, optionally a single comma,
434 /// and further whitespace characters from the stream.
435 /// @return true if a comma was found, false otherwise
437 bool removeWSAndComma(idocfstream & ifs) {
446 } while (ifs && isSpace(ch));
459 } while (ifs && isSpace(ch));
474 /// remove whitespace characters, read characer sequence
475 /// not containing whitespace characters or characters in
476 /// delimChars, and remove further whitespace characters.
478 /// @return true if a string of length > 0 could be read.
480 bool readTypeOrKey(docstring & val, idocfstream & ifs,
481 docstring const & delimChars, docstring const &illegalChars,
494 } while (ifs && isSpace(ch));
500 bool legalChar = true;
501 while (ifs && !isSpace(ch) &&
502 delimChars.find(ch) == docstring::npos &&
503 (legalChar = (illegalChars.find(ch) == docstring::npos))
506 if (chCase == makeLowerCase)
507 val += lowercase(ch);
519 while (ifs && isSpace(ch)) {
527 return val.length() > 0;
530 /// read subsequent bibtex values that are delimited with a #-character.
531 /// Concatenate all parts and replace names with the associated string in
532 /// the variable strings.
533 /// @return true if reading was successfull (all single parts were delimited
535 bool readValue(docstring & val, idocfstream & ifs, const VarMap & strings) {
548 } while (ifs && isSpace(ch));
553 // check for field type
556 // read integer value
560 } while (ifs && isDigit(ch));
565 } else if (ch == '"' || ch == '{') {
567 char_type delim = ch == '"' ? '"': '}';
572 } while (ifs && isSpace(ch));
577 // We now have the first non-whitespace character
578 // We'll collapse adjacent whitespace.
579 bool lastWasWhiteSpace = false;
581 // inside this delimited text braces must match.
582 // Thus we can have a closing delimiter only
583 // when nestLevel == 0
586 while (ifs && (nestLevel > 0 || ch != delim)) {
588 lastWasWhiteSpace = true;
592 // We output the space only after we stop getting
593 // whitespace so as not to output any whitespace
594 // at the end of the value.
595 if (lastWasWhiteSpace) {
596 lastWasWhiteSpace = false;
602 // update nesting level
609 if (nestLevel < 0) return false;
626 // reading a string name
629 while (ifs && !isSpace(ch) && ch != '#' && ch != ',' && ch != '}' && ch != ')') {
630 strName += lowercase(ch);
637 // replace the string with its assigned value or
638 // discard it if it's not assigned
639 if (strName.length()) {
640 VarMap::const_iterator pos = strings.find(strName);
641 if (pos != strings.end()) {
648 while (ifs && isSpace(ch)) {
655 // continue reading next value on concatenate with '#'
665 // This method returns a comma separated list of Bibtex entries
666 void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
667 InsetIterator const & /*di*/) const
669 // This bibtex parser is a first step to parse bibtex files
672 // - it reads the whole bibtex entry and does a syntax check
673 // (matching delimiters, missing commas,...
674 // - it recovers from errors starting with the next @-character
675 // - it reads @string definitions and replaces them in the
677 // - it accepts more characters in keys or value names than
680 // Officially bibtex does only support ASCII, but in practice
681 // you can use the encoding of the main document as long as
682 // some elements like keys and names are pure ASCII. Therefore
683 // we convert the file from the buffer encoding.
684 // We don't restrict keys to ASCII in LyX, since our own
685 // InsetBibitem can generate non-ASCII keys, and nonstandard
686 // 8bit clean bibtex forks exist.
687 support::FileNameList const files = getBibFiles();
688 support::FileNameList::const_iterator it = files.begin();
689 support::FileNameList::const_iterator en = files.end();
690 for (; it != en; ++ it) {
691 idocfstream ifs(it->toFilesystemEncoding().c_str(),
692 ios_base::in, buffer().params().encoding().iconvName());
708 if (!readTypeOrKey(entryType, ifs, from_ascii("{("), docstring(), makeLowerCase)) {
709 lyxerr << "InsetBibtex::fillWithBibKeys: Error reading entry type." << std::endl;
714 lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
718 if (entryType == from_ascii("comment")) {
719 ifs.ignore(numeric_limits<int>::max(), '\n');
725 lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
729 if ((ch != '(') && (ch != '{')) {
730 lyxerr << "InsetBibtex::fillWithBibKeys: Invalid entry delimiter." << std::endl;
736 if (entryType == from_ascii("string")) {
738 // read string and add it to the strings map
739 // (or replace it's old value)
743 if (!readTypeOrKey(name, ifs, from_ascii("="), from_ascii("#{}(),"), makeLowerCase)) {
744 lyxerr << "InsetBibtex::fillWithBibKeys: Error reading string name." << std::endl;
749 lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
753 // next char must be an equal sign
755 if (!ifs || ch != '=') {
756 lyxerr << "InsetBibtex::fillWithBibKeys: No `=' after string name: " <<
757 name << "." << std::endl;
761 if (!readValue(value, ifs, strings)) {
762 lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for string: " <<
763 name << "." << std::endl;
767 strings[name] = value;
769 } else if (entryType == from_ascii("preamble")) {
771 // preamble definitions are discarded.
772 // can they be of any use in lyx?
775 if (!readValue(value, ifs, strings)) {
776 lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read preamble value." << std::endl;
782 // Citation entry. Try to read the key.
785 if (!readTypeOrKey(key, ifs, from_ascii(","), from_ascii("}"), keepCase)) {
786 lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read key for entry type:" <<
787 entryType << "." << std::endl;
792 lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
796 /////////////////////////////////////////////
797 // now we have a key, so we will add an entry
798 // (even if it's empty, as bibtex does)
800 // we now read the field = value pairs.
801 // all items must be separated by a comma. If
802 // it is missing the scanning of this entry is
803 // stopped and the next is searched.
807 docstring commaNewline;
809 BibTeXInfo keyvalmap(key, entryType);
811 bool readNext = removeWSAndComma(ifs);
813 while (ifs && readNext) {
816 if (!readTypeOrKey(name, ifs, from_ascii("="),
817 from_ascii("{}(),"), makeLowerCase) || !ifs)
820 // next char must be an equal sign
823 lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
827 lyxerr << "InsetBibtex::fillWithBibKeys: Missing `=' after field name: " <<
828 name << ", for key: " << key << "." << std::endl;
834 if (!readValue(value, ifs, strings)) {
835 lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for field: " <<
836 name << ", for key: " << key << "." << std::endl;
840 keyvalmap[name] = value;
841 data += "\n\n" + value;
842 keylist.addFieldName(name);
843 readNext = removeWSAndComma(ifs);
847 keylist.addEntryType(entryType);
848 keyvalmap.setAllData(data);
849 keylist[key] = keyvalmap;
850 } //< else (citation entry)
852 } //< for loop over files
856 FileName InsetBibtex::getBibTeXPath(docstring const & filename, Buffer const & buf)
858 string texfile = changeExtension(to_utf8(filename), "bib");
859 // note that, if the filename can be found directly from the path,
860 // findtexfile will just return a FileName object for that path.
861 FileName file(findtexfile(texfile, "bib"));
863 file = FileName(makeAbsPath(texfile, buf.filePath()));
868 bool InsetBibtex::addDatabase(docstring const & db)
870 docstring bibfiles = getParam("bibfiles");
871 if (tokenPos(bibfiles, ',', db) != -1)
873 if (!bibfiles.empty())
875 setParam("bibfiles", bibfiles + db);
880 bool InsetBibtex::delDatabase(docstring const & db)
882 docstring bibfiles = getParam("bibfiles");
883 if (contains(bibfiles, db)) {
884 int const n = tokenPos(bibfiles, ',', db);
887 // this is not the first database
888 docstring tmp = ',' + bd;
889 setParam("bibfiles", subst(bibfiles, tmp, docstring()));
891 // this is the first (or only) database
892 setParam("bibfiles", split(bibfiles, bd, ','));
900 void InsetBibtex::validate(LaTeXFeatures & features) const
902 if (features.bufferParams().use_bibtopic)
903 features.require("bibtopic");
907 docstring InsetBibtex::contextMenu(BufferView const &, int, int) const
909 return from_ascii("context-bibtex");