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"
24 #include "LaTeXFeatures.h"
25 #include "output_xhtml.h"
26 #include "OutputParams.h"
27 #include "PDFOptions.h"
28 #include "TextClass.h"
30 #include "frontends/alert.h"
32 #include "support/convert.h"
33 #include "support/debug.h"
34 #include "support/docstream.h"
35 #include "support/ExceptionMessage.h"
36 #include "support/filetools.h"
37 #include "support/gettext.h"
38 #include "support/lstrings.h"
39 #include "support/os.h"
40 #include "support/Path.h"
41 #include "support/textutils.h"
46 using namespace lyx::support;
50 namespace Alert = frontend::Alert;
51 namespace os = support::os;
54 InsetBibtex::InsetBibtex(Buffer * buf, InsetCommandParams const & p)
55 : InsetCommand(buf, p)
57 buffer().invalidateBibinfoCache();
61 InsetBibtex::~InsetBibtex()
64 buffer().invalidateBibfileCache();
68 ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */)
70 static ParamInfo param_info_;
71 if (param_info_.empty()) {
72 param_info_.add("btprint", ParamInfo::LATEX_OPTIONAL);
73 param_info_.add("bibfiles", ParamInfo::LATEX_REQUIRED);
74 param_info_.add("options", ParamInfo::LYX_INTERNAL);
80 void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
82 switch (cmd.action()) {
88 case LFUN_INSET_MODIFY: {
89 InsetCommandParams p(BIBTEX_CODE);
91 if (!InsetCommand::string2params(to_utf8(cmd.argument()), p)) {
95 } catch (ExceptionMessage const & message) {
96 if (message.type_ == WarningException) {
97 Alert::warning(message.title_, message.details_);
105 buffer().invalidateBibfileCache();
106 cur.forceBufferUpdate();
111 InsetCommand::doDispatch(cur, cmd);
117 bool InsetBibtex::getStatus(Cursor & cur, FuncRequest const & cmd,
118 FuncStatus & flag) const
120 switch (cmd.action()) {
121 case LFUN_INSET_EDIT:
122 flag.setEnabled(true);
126 return InsetCommand::getStatus(cur, cmd, flag);
131 void InsetBibtex::editDatabases() const
133 vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
135 if (bibfilelist.empty())
138 int nr_databases = bibfilelist.size();
139 if (nr_databases > 1) {
140 docstring message = bformat(_("The BibTeX inset includes %1$s databases.\n"
141 "If you proceed, all of them will be opened."),
142 convert<docstring>(nr_databases));
143 int const ret = Alert::prompt(_("Open Databases?"),
144 message, 0, 1, _("&Cancel"), _("&Proceed"));
150 vector<docstring>::const_iterator it = bibfilelist.begin();
151 vector<docstring>::const_iterator en = bibfilelist.end();
152 for (; it != en; ++it) {
153 FileName bibfile = getBibTeXPath(*it, buffer());
154 formats.edit(buffer(), bibfile,
155 formats.getFormatFromFile(bibfile));
160 docstring InsetBibtex::screenLabel() const
162 return _("BibTeX Generated Bibliography");
166 docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
168 docstring item = from_ascii("* ");
169 docstring tip = _("Databases:") + "\n";
170 vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
172 if (bibfilelist.empty()) {
176 vector<docstring>::const_iterator it = bibfilelist.begin();
177 vector<docstring>::const_iterator en = bibfilelist.end();
178 for (; it != en; ++it) {
186 docstring style = getParam("options"); // maybe empty! and with bibtotoc
187 docstring bibtotoc = from_ascii("bibtotoc");
188 if (prefixIs(style, bibtotoc)) {
190 if (contains(style, char_type(',')))
191 style = split(style, bibtotoc, char_type(','));
194 tip += _("Style File:") +"\n";
201 tip += "\n" + _("Lists:") + " ";
202 docstring btprint = getParam("btprint");
203 if (btprint == "btPrintAll")
204 tip += _("all references");
205 else if (btprint == "btPrintNotCited")
206 tip += _("all uncited references");
208 tip += _("all cited references");
212 tip += _("included in TOC");
219 static string normalizeName(Buffer const & buffer,
220 OutputParams const & runparams, string const & name, string const & ext)
222 string const fname = makeAbsPath(name, buffer.filePath()).absFileName();
223 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
229 return to_utf8(makeRelPath(from_utf8(fname),
230 from_utf8(buffer.masterBuffer()->filePath())));
234 int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
236 // the sequence of the commands:
237 // 1. \bibliographystyle{style}
238 // 2. \addcontentsline{...} - if option bibtotoc set
239 // 3. \bibliography{database}
240 // and with bibtopic:
241 // 1. \bibliographystyle{style}
242 // 2. \begin{btSect}{database}
243 // 3. \btPrint{Cited|NotCited|All}
247 // If we are processing the LaTeX file in a temp directory then
248 // copy the .bib databases to this temp directory, mangling their
249 // names in the process. Store this mangled name in the list of
251 // (We need to do all this because BibTeX *really*, *really*
252 // can't handle "files with spaces" and Windows users tend to
253 // use such filenames.)
254 // Otherwise, store the (maybe absolute) path to the original,
255 // unmangled database name.
256 vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
257 vector<docstring>::const_iterator it = bibfilelist.begin();
258 vector<docstring>::const_iterator en = bibfilelist.end();
259 odocstringstream dbs;
262 for (; it != en; ++it) {
263 string utf8input = to_utf8(*it);
265 normalizeName(buffer(), runparams, utf8input, ".bib");
266 FileName const try_in_file =
267 makeAbsPath(database + ".bib", buffer().filePath());
268 bool const not_from_texmf = try_in_file.isReadableFile();
270 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 if (!isValidLaTeXFileName(database)) {
286 frontend::Alert::warning(_("Invalid filename"),
287 _("The following filename will cause troubles "
288 "when running the exported file through LaTeX: ") +
289 from_utf8(database));
291 if (!isValidDVIFileName(database)) {
292 frontend::Alert::warning(_("Problematic filename for DVI"),
293 _("The following filename can cause troubles "
294 "when running the exported file through LaTeX "
295 "and opening the resulting DVI: ") +
296 from_utf8(database), true);
305 dbs << from_utf8(latex_path(database));
307 docstring const db_out = dbs.str();
309 // Post this warning only once.
310 static bool warned_about_spaces = false;
311 if (!warned_about_spaces &&
312 runparams.nice && db_out.find(' ') != docstring::npos) {
313 warned_about_spaces = true;
314 Alert::warning(_("Export Warning!"),
315 _("There are spaces in the paths to your BibTeX databases.\n"
316 "BibTeX will be unable to find them."));
319 string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
321 if (prefixIs(style, "bibtotoc")) {
322 bibtotoc = "bibtotoc";
323 if (contains(style, ','))
324 style = split(style, bibtotoc, ',');
330 if (!style.empty()) {
331 string base = normalizeName(buffer(), runparams, style, ".bst");
332 FileName const try_in_file =
333 makeAbsPath(base + ".bst", buffer().filePath());
334 bool const not_from_texmf = try_in_file.isReadableFile();
335 // If this style does not come from texmf and we are not
336 // exporting to .tex copy it to the tmp directory.
337 // This prevents problems with spaces and 8bit charcaters
339 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
341 // use new style name
342 DocFileName const in_file = DocFileName(try_in_file);
343 base = removeExtension(in_file.mangledFileName());
344 FileName const out_file = makeAbsPath(base + ".bst",
345 buffer().masterBuffer()->temppath());
346 bool const success = in_file.copyTo(out_file);
348 lyxerr << "Failed to copy '" << in_file
349 << "' to '" << out_file << "'"
354 os << "\\bibliographystyle{"
355 << from_utf8(latex_path(normalizeName(buffer(), runparams, base, ".bst")))
360 // Post this warning only once.
361 static bool warned_about_bst_spaces = false;
362 if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) {
363 warned_about_bst_spaces = true;
364 Alert::warning(_("Export Warning!"),
365 _("There are spaces in the path to your BibTeX style file.\n"
366 "BibTeX will be unable to find it."));
369 if (!db_out.empty() && buffer().params().use_bibtopic) {
370 os << "\\begin{btSect}{" << db_out << "}\n";
371 docstring btprint = getParam("btprint");
374 btprint = from_ascii("btPrintCited");
375 os << "\\" << btprint << "\n"
376 << "\\end{btSect}\n";
381 if (!bibtotoc.empty() && !buffer().params().use_bibtopic) {
382 // set label for hyperref, see http://www.lyx.org/trac/ticket/6470
383 if (buffer().params().pdfoptions().use_hyperref)
384 os << "\\phantomsection";
385 if (buffer().params().documentClass().hasLaTeXLayout("chapter"))
386 os << "\\addcontentsline{toc}{chapter}{\\bibname}";
387 else if (buffer().params().documentClass().hasLaTeXLayout("section"))
388 os << "\\addcontentsline{toc}{section}{\\refname}";
391 if (!db_out.empty() && !buffer().params().use_bibtopic) {
392 docstring btprint = getParam("btprint");
393 if (btprint == "btPrintAll") {
394 os << "\\nocite{*}\n";
397 os << "\\bibliography{" << db_out << "}\n";
405 support::FileNameList InsetBibtex::getBibFiles() const
407 FileName path(buffer().filePath());
408 support::PathChanger p(path);
410 support::FileNameList vec;
412 vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
413 vector<docstring>::const_iterator it = bibfilelist.begin();
414 vector<docstring>::const_iterator en = bibfilelist.end();
415 for (; it != en; ++it) {
416 FileName const file = getBibTeXPath(*it, buffer());
421 LYXERR0("Couldn't find " + to_utf8(*it) + " in InsetBibtex::getBibFiles()!");
430 // methods for parsing bibtex files
432 typedef map<docstring, docstring> VarMap;
434 /// remove whitespace characters, optionally a single comma,
435 /// and further whitespace characters from the stream.
436 /// @return true if a comma was found, false otherwise
438 bool removeWSAndComma(ifdocstream & ifs) {
447 } while (ifs && isSpace(ch));
460 } while (ifs && isSpace(ch));
475 /// remove whitespace characters, read characer sequence
476 /// not containing whitespace characters or characters in
477 /// delimChars, and remove further whitespace characters.
479 /// @return true if a string of length > 0 could be read.
481 bool readTypeOrKey(docstring & val, ifdocstream & ifs,
482 docstring const & delimChars, docstring const & illegalChars,
495 } while (ifs && isSpace(ch));
501 bool legalChar = true;
502 while (ifs && !isSpace(ch) &&
503 delimChars.find(ch) == docstring::npos &&
504 (legalChar = (illegalChars.find(ch) == docstring::npos))
507 if (chCase == makeLowerCase)
508 val += lowercase(ch);
520 while (ifs && isSpace(ch)) {
528 return val.length() > 0;
531 /// read subsequent bibtex values that are delimited with a #-character.
532 /// Concatenate all parts and replace names with the associated string in
533 /// the variable strings.
534 /// @return true if reading was successfull (all single parts were delimited
536 bool readValue(docstring & val, ifdocstream & ifs, const VarMap & strings) {
549 } while (ifs && isSpace(ch));
554 // check for field type
557 // read integer value
561 } while (ifs && isDigit(ch));
566 } else if (ch == '"' || ch == '{') {
568 char_type delim = ch == '"' ? '"': '}';
573 } while (ifs && isSpace(ch));
578 // We now have the first non-whitespace character
579 // We'll collapse adjacent whitespace.
580 bool lastWasWhiteSpace = false;
582 // inside this delimited text braces must match.
583 // Thus we can have a closing delimiter only
584 // when nestLevel == 0
587 while (ifs && (nestLevel > 0 || ch != delim)) {
589 lastWasWhiteSpace = true;
593 // We output the space only after we stop getting
594 // whitespace so as not to output any whitespace
595 // at the end of the value.
596 if (lastWasWhiteSpace) {
597 lastWasWhiteSpace = false;
603 // update nesting level
622 // FIXME Why is this here?
630 // reading a string name
633 while (ifs && !isSpace(ch) && ch != '#' && ch != ',' && ch != '}' && ch != ')') {
634 strName += lowercase(ch);
641 // replace the string with its assigned value or
642 // discard it if it's not assigned
643 if (strName.length()) {
644 VarMap::const_iterator pos = strings.find(strName);
645 if (pos != strings.end()) {
652 while (ifs && isSpace(ch)) {
659 // continue reading next value on concatenate with '#'
669 // This method returns a comma separated list of Bibtex entries
670 void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
671 InsetIterator const & /*di*/) const
673 // This bibtex parser is a first step to parse bibtex files
676 // - it reads the whole bibtex entry and does a syntax check
677 // (matching delimiters, missing commas,...
678 // - it recovers from errors starting with the next @-character
679 // - it reads @string definitions and replaces them in the
681 // - it accepts more characters in keys or value names than
684 // Officially bibtex does only support ASCII, but in practice
685 // you can use the encoding of the main document as long as
686 // some elements like keys and names are pure ASCII. Therefore
687 // we convert the file from the buffer encoding.
688 // We don't restrict keys to ASCII in LyX, since our own
689 // InsetBibitem can generate non-ASCII keys, and nonstandard
690 // 8bit clean bibtex forks exist.
691 support::FileNameList const files = getBibFiles();
692 support::FileNameList::const_iterator it = files.begin();
693 support::FileNameList::const_iterator en = files.end();
694 for (; it != en; ++ it) {
695 ifdocstream ifs(it->toFilesystemEncoding().c_str(),
696 ios_base::in, buffer().params().encoding().iconvName());
712 if (!readTypeOrKey(entryType, ifs, from_ascii("{("), docstring(), makeLowerCase)) {
713 lyxerr << "BibTeX Parser: Error reading entry type." << std::endl;
718 lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl;
722 if (entryType == from_ascii("comment")) {
723 ifs.ignore(numeric_limits<int>::max(), '\n');
729 lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl;
733 if ((ch != '(') && (ch != '{')) {
734 lyxerr << "BibTeX Parser: Invalid entry delimiter." << std::endl;
740 if (entryType == from_ascii("string")) {
742 // read string and add it to the strings map
743 // (or replace it's old value)
747 if (!readTypeOrKey(name, ifs, from_ascii("="), from_ascii("#{}(),"), makeLowerCase)) {
748 lyxerr << "BibTeX Parser: Error reading string name." << std::endl;
753 lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl;
757 // next char must be an equal sign
759 if (!ifs || ch != '=') {
760 lyxerr << "BibTeX Parser: No `=' after string name: " <<
761 name << "." << std::endl;
765 if (!readValue(value, ifs, strings)) {
766 lyxerr << "BibTeX Parser: Unable to read value for string: " <<
767 name << "." << std::endl;
771 strings[name] = value;
773 } else if (entryType == from_ascii("preamble")) {
775 // preamble definitions are discarded.
776 // can they be of any use in lyx?
779 if (!readValue(value, ifs, strings)) {
780 lyxerr << "BibTeX Parser: Unable to read preamble value." << std::endl;
786 // Citation entry. Try to read the key.
789 if (!readTypeOrKey(key, ifs, from_ascii(","), from_ascii("}"), keepCase)) {
790 lyxerr << "BibTeX Parser: Unable to read key for entry type:" <<
791 entryType << "." << std::endl;
796 lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl;
800 /////////////////////////////////////////////
801 // now we have a key, so we will add an entry
802 // (even if it's empty, as bibtex does)
804 // we now read the field = value pairs.
805 // all items must be separated by a comma. If
806 // it is missing the scanning of this entry is
807 // stopped and the next is searched.
811 BibTeXInfo keyvalmap(key, entryType);
813 bool readNext = removeWSAndComma(ifs);
815 while (ifs && readNext) {
818 if (!readTypeOrKey(name, ifs, from_ascii("="),
819 from_ascii("{}(),"), makeLowerCase) || !ifs)
822 // next char must be an equal sign
823 // FIXME Whitespace??
826 lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl;
830 lyxerr << "BibTeX Parser: Missing `=' after field name: " <<
831 name << ", for key: " << key << "." << std::endl;
837 if (!readValue(value, ifs, strings)) {
838 lyxerr << "BibTeX Parser: Unable to read value for field: " <<
839 name << ", for key: " << key << "." << std::endl;
843 keyvalmap[name] = value;
844 data += "\n\n" + value;
845 keylist.addFieldName(name);
846 readNext = removeWSAndComma(ifs);
850 keylist.addEntryType(entryType);
851 keyvalmap.setAllData(data);
852 keylist[key] = keyvalmap;
853 } //< else (citation entry)
855 } //< for loop over files
859 FileName InsetBibtex::getBibTeXPath(docstring const & filename, Buffer const & buf)
861 string texfile = changeExtension(to_utf8(filename), "bib");
862 // note that, if the filename can be found directly from the path,
863 // findtexfile will just return a FileName object for that path.
864 FileName file(findtexfile(texfile, "bib"));
866 file = FileName(makeAbsPath(texfile, buf.filePath()));
871 bool InsetBibtex::addDatabase(docstring const & db)
873 docstring bibfiles = getParam("bibfiles");
874 if (tokenPos(bibfiles, ',', db) != -1)
876 if (!bibfiles.empty())
878 setParam("bibfiles", bibfiles + db);
883 bool InsetBibtex::delDatabase(docstring const & db)
885 docstring bibfiles = getParam("bibfiles");
886 if (contains(bibfiles, db)) {
887 int const n = tokenPos(bibfiles, ',', db);
890 // this is not the first database
891 docstring tmp = ',' + bd;
892 setParam("bibfiles", subst(bibfiles, tmp, docstring()));
894 // this is the first (or only) database
895 setParam("bibfiles", split(bibfiles, bd, ','));
903 void InsetBibtex::validate(LaTeXFeatures & features) const
905 if (features.bufferParams().use_bibtopic)
906 features.require("bibtopic");
908 // It'd be better to be able to get this from an InsetLayout, but at present
909 // InsetLayouts do not seem really to work for things that aren't InsetTexts.
910 if (features.runparams().flavor == OutputParams::HTML)
911 features.addPreambleSnippet("<style type=\"text/css\">\n"
912 "div.bibtexentry { margin-left: 2em; text-indent: -2em; }\n"
913 "span.bibtexlabel:before{ content: \"[\"; }\n"
914 "span.bibtexlabel:after{ content: \"] \"; }\n"
920 // docstring InsetBibtex::entriesAsXHTML(vector<docstring> const & entries)
921 // And then here just: entriesAsXHTML(buffer().masterBibInfo().citedEntries())
922 docstring InsetBibtex::xhtml(XHTMLStream & xs, OutputParams const &) const
924 BiblioInfo const & bibinfo = buffer().masterBibInfo();
925 vector<docstring> const & cites = bibinfo.citedEntries();
926 CiteEngine const engine = buffer().params().citeEngine();
928 (engine == ENGINE_BASIC || engine == ENGINE_NATBIB_NUMERICAL);
930 docstring reflabel = from_ascii("References");
931 Language const * l = buffer().params().language;
933 reflabel = translateIfPossible(reflabel, l->code());
935 xs << html::StartTag("h2", "class='bibtex'")
937 << html::EndTag("h2")
938 << html::StartTag("div", "class='bibtex'");
940 // Now we loop over the entries
941 vector<docstring>::const_iterator vit = cites.begin();
942 vector<docstring>::const_iterator const ven = cites.end();
943 for (; vit != ven; ++vit) {
944 BiblioInfo::const_iterator const biit = bibinfo.find(*vit);
945 if (biit == bibinfo.end())
947 BibTeXInfo const & entry = biit->second;
948 xs << html::StartTag("div", "class='bibtexentry'");
950 // The same name/id problem we have elsewhere.
951 string const attr = "id='" + to_utf8(entry.key()) + "'";
952 xs << html::CompTag("a", attr);
955 citekey = entry.citeNumber();
957 docstring const auth = entry.getAbbreviatedAuthor();
958 // we do it this way so as to access the xref, if necessary
959 // note that this also gives us the modifier
960 docstring const year = bibinfo.getYear(*vit, true);
961 if (!auth.empty() && !year.empty())
962 citekey = auth + ' ' + year;
964 if (citekey.empty()) {
965 citekey = entry.label();
967 citekey = entry.key();
969 xs << html::StartTag("span", "class='bibtexlabel'")
971 << html::EndTag("span");
972 // FIXME Right now, we are calling BibInfo::getInfo on the key,
973 // which will give us all the cross-referenced info. But for every
974 // entry, so there's a lot of repitition. This should be fixed.
975 xs << html::StartTag("span", "class='bibtexinfo'")
976 << XHTMLStream::NextRaw()
977 << bibinfo.getInfo(entry.key(), buffer(), true)
978 << html::EndTag("span")
979 << html::EndTag("div");
982 xs << html::EndTag("div");
987 docstring InsetBibtex::contextMenu(BufferView const &, int, int) const
989 return from_ascii("context-bibtex");