X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetBibtex.cpp;h=0db4555ce0f0d31bd5bb394d6bf2fbe4f03a041b;hb=00e00b32fd1df4e3c90a63ff067400f0f7153dee;hp=97d8ed09c67bf5123e2550a34284c8c179027211;hpb=23c231c761dda80d220927c15e15c14493a57bc2;p=lyx.git diff --git a/src/insets/InsetBibtex.cpp b/src/insets/InsetBibtex.cpp index 97d8ed09c6..0db4555ce0 100644 --- a/src/insets/InsetBibtex.cpp +++ b/src/insets/InsetBibtex.cpp @@ -5,6 +5,7 @@ * * \author Alejandro Aguilar Sierra * \author Richard Heck (BibTeX parser improvements) + * \author Jürgen Spitzmüller * * Full author contact details are available in file CREDITS. */ @@ -16,6 +17,7 @@ #include "BiblioInfo.h" #include "Buffer.h" #include "BufferParams.h" +#include "CiteEnginesList.h" #include "Cursor.h" #include "DispatchResult.h" #include "Encoding.h" @@ -57,19 +59,7 @@ namespace os = support::os; InsetBibtex::InsetBibtex(Buffer * buf, InsetCommandParams const & p) : InsetCommand(buf, p) -{ - buffer().invalidateBibfileCache(); - buffer().removeBiblioTempFiles(); -} - - -InsetBibtex::~InsetBibtex() -{ - if (isBufferLoaded()) { - buffer().invalidateBibfileCache(); - buffer().removeBiblioTempFiles(); - } -} +{} ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */) @@ -79,6 +69,7 @@ ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */) param_info_.add("btprint", ParamInfo::LATEX_OPTIONAL); param_info_.add("bibfiles", ParamInfo::LATEX_REQUIRED); param_info_.add("options", ParamInfo::LYX_INTERNAL); + param_info_.add("biblatexopts", ParamInfo::LATEX_OPTIONAL); } return param_info_; } @@ -110,8 +101,6 @@ void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd) cur.recordUndo(); setParams(p); - buffer().invalidateBibfileCache(); - buffer().removeBiblioTempFiles(); cur.forceBufferUpdate(); break; } @@ -146,9 +135,10 @@ void InsetBibtex::editDatabases() const int nr_databases = bibfilelist.size(); if (nr_databases > 1) { - docstring message = bformat(_("The BibTeX inset includes %1$s databases.\n" + docstring const engine = usingBiblatex() ? _("Biblatex") : _("BibTeX"); + docstring message = bformat(_("The %1$s[[BibTeX/Biblatex]] inset includes %2$s databases.\n" "If you proceed, all of them will be opened."), - convert(nr_databases)); + engine, convert(nr_databases)); int const ret = Alert::prompt(_("Open Databases?"), message, 0, 1, _("&Cancel"), _("&Proceed")); @@ -160,15 +150,22 @@ void InsetBibtex::editDatabases() const vector::const_iterator en = bibfilelist.end(); for (; it != en; ++it) { FileName const bibfile = getBibTeXPath(*it, buffer()); - formats.edit(buffer(), bibfile, - formats.getFormatFromFile(bibfile)); + theFormats().edit(buffer(), bibfile, + theFormats().getFormatFromFile(bibfile)); } } +bool InsetBibtex::usingBiblatex() const +{ + return buffer().masterParams().useBiblatex(); +} + + docstring InsetBibtex::screenLabel() const { - return _("BibTeX Generated Bibliography"); + return usingBiblatex() ? _("Biblatex Generated Bibliography") + : _("BibTeX Generated Bibliography"); } @@ -195,130 +192,73 @@ docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) style = split(style, bibtotoc, char_type(',')); } - tip += _("Style File:"); - tip += "
  • " + (style.empty() ? _("none") : style) + "
"; + docstring const btprint = getParam("btprint"); + if (!usingBiblatex()) { + tip += _("Style File:"); + tip += "
  • " + (style.empty() ? _("none") : style) + "
"; - tip += _("Lists:") + " "; - docstring btprint = getParam("btprint"); + tip += _("Lists:") + " "; if (btprint == "btPrintAll") tip += _("all references"); else if (btprint == "btPrintNotCited") tip += _("all uncited references"); else tip += _("all cited references"); - - if (toc) { - tip += ", "; - tip += _("included in TOC"); + if (toc) { + tip += ", "; + tip += _("included in TOC"); + } + if (!buffer().parent() + && buffer().params().multibib == "child") { + tip += "
"; + tip += _("Note: This bibliography is not output, since bibliographies in the master file " + "are not allowed with the setting 'Multiple bibliographies per child document'"); + } + } else { + tip += _("Lists:") + " "; + if (btprint == "bibbysection") + tip += _("all reference units"); + else if (btprint == "btPrintAll") + tip += _("all references"); + else + tip += _("all cited references"); + if (toc) { + tip += ", "; + tip += _("included in TOC"); + } + if (!getParam("biblatexopts").empty()) { + if (toc) + tip += "
"; + tip += _("Options: ") + getParam("biblatexopts"); + } } return tip; } -static string normalizeName(Buffer const & buffer, - OutputParams const & runparams, string const & name, string const & ext) -{ - string const fname = makeAbsPath(name, buffer.filePath()).absFileName(); - if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile()) - return name; - if (!runparams.nice) - return fname; - - // FIXME UNICODE - return to_utf8(makeRelPath(from_utf8(fname), - from_utf8(buffer.masterBuffer()->filePath()))); -} - - void InsetBibtex::latex(otexstream & os, OutputParams const & runparams) const { - // the sequence of the commands: + // The sequence of the commands: + // With normal BibTeX: // 1. \bibliographystyle{style} // 2. \addcontentsline{...} - if option bibtotoc set // 3. \bibliography{database} - // and with bibtopic: + // With bibtopic: // 1. \bibliographystyle{style} // 2. \begin{btSect}{database} // 3. \btPrint{Cited|NotCited|All} // 4. \end{btSect} + // With Biblatex: + // \printbibliography[biblatexopts] + // or + // \bibbysection[biblatexopts] - if btprint is "bibbysection" + + // chapterbib does not allow bibliographies in the master + if (!usingBiblatex() && !runparams.is_child + && buffer().params().multibib == "child") + return; - // Database(s) - // If we are processing the LaTeX file in a temp directory then - // copy the .bib databases to this temp directory, mangling their - // names in the process. Store this mangled name in the list of - // all databases. - // (We need to do all this because BibTeX *really*, *really* - // can't handle "files with spaces" and Windows users tend to - // use such filenames.) - // Otherwise, store the (maybe absolute) path to the original, - // unmangled database name. - vector bibfilelist = getVectorFromString(getParam("bibfiles")); - vector::const_iterator it = bibfilelist.begin(); - vector::const_iterator en = bibfilelist.end(); - odocstringstream dbs; - bool didone = false; - - // determine the export format - string const tex_format = flavor2format(runparams.flavor); - - for (; it != en; ++it) { - string utf8input = to_utf8(*it); - string database = - normalizeName(buffer(), runparams, utf8input, ".bib"); - FileName const try_in_file = - makeAbsPath(database + ".bib", buffer().filePath()); - bool const not_from_texmf = try_in_file.isReadableFile(); - - if (!runparams.inComment && !runparams.dryrun && !runparams.nice && - not_from_texmf) { - // mangledFileName() needs the extension - DocFileName const in_file = DocFileName(try_in_file); - database = removeExtension(in_file.mangledFileName()); - FileName const out_file = makeAbsPath(database + ".bib", - buffer().masterBuffer()->temppath()); - bool const success = in_file.copyTo(out_file); - if (!success) { - lyxerr << "Failed to copy '" << in_file - << "' to '" << out_file << "'" - << endl; - } - } else if (!runparams.inComment && runparams.nice && not_from_texmf) { - runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib"); - if (!isValidLaTeXFileName(database)) { - frontend::Alert::warning(_("Invalid filename"), - _("The following filename will cause troubles " - "when running the exported file through LaTeX: ") + - from_utf8(database)); - } - if (!isValidDVIFileName(database)) { - frontend::Alert::warning(_("Problematic filename for DVI"), - _("The following filename can cause troubles " - "when running the exported file through LaTeX " - "and opening the resulting DVI: ") + - from_utf8(database), true); - } - } - - if (didone) - dbs << ','; - else - didone = true; - // FIXME UNICODE - dbs << from_utf8(latex_path(database)); - } - docstring const db_out = dbs.str(); - - // Post this warning only once. - static bool warned_about_spaces = false; - if (!warned_about_spaces && - runparams.nice && db_out.find(' ') != docstring::npos) { - warned_about_spaces = true; - Alert::warning(_("Export Warning!"), - _("There are spaces in the paths to your BibTeX databases.\n" - "BibTeX will be unable to find them.")); - } - // Style-Options string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc string bibtotoc; if (prefixIs(style, "bibtotoc")) { @@ -327,90 +267,109 @@ void InsetBibtex::latex(otexstream & os, OutputParams const & runparams) const style = split(style, bibtotoc, ','); } - if (style == "default") - style = buffer().params().defaultBiblioStyle(); - - if (!style.empty() && !buffer().params().use_bibtopic) { - string base = normalizeName(buffer(), runparams, style, ".bst"); - FileName const try_in_file = - makeAbsPath(base + ".bst", buffer().filePath()); - bool const not_from_texmf = try_in_file.isReadableFile(); - // If this style does not come from texmf and we are not - // exporting to .tex copy it to the tmp directory. - // This prevents problems with spaces and 8bit charcaters - // in the file name. - if (!runparams.inComment && !runparams.dryrun && !runparams.nice && - not_from_texmf) { - // use new style name - DocFileName const in_file = DocFileName(try_in_file); - base = removeExtension(in_file.mangledFileName()); - FileName const out_file = makeAbsPath(base + ".bst", - buffer().masterBuffer()->temppath()); - bool const success = in_file.copyTo(out_file); - if (!success) { - lyxerr << "Failed to copy '" << in_file - << "' to '" << out_file << "'" - << endl; - } - } - // FIXME UNICODE - os << "\\bibliographystyle{" - << from_utf8(latex_path(normalizeName(buffer(), runparams, base, ".bst"))) - << "}\n"; - } - - // Post this warning only once. - static bool warned_about_bst_spaces = false; - if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) { - warned_about_bst_spaces = true; - Alert::warning(_("Export Warning!"), - _("There are spaces in the path to your BibTeX style file.\n" - "BibTeX will be unable to find it.")); - } - - if (!db_out.empty() && buffer().params().use_bibtopic) { - os << "\\begin{btSect}"; - if (!style.empty()) - os << "[" << style << "]"; - os << "{" << db_out << "}\n"; + if (usingBiblatex()) { + // Options + string opts = to_utf8(getParam("biblatexopts")); + // bibtotoc-Option + if (!bibtotoc.empty()) + opts = opts.empty() ? "heading=bibintoc" : "heading=bibintoc," + opts; + // The bibliography command docstring btprint = getParam("btprint"); - if (btprint.empty()) - // default - btprint = from_ascii("btPrintCited"); - os << "\\" << btprint << "\n" - << "\\end{btSect}\n"; - } - - // bibtotoc-Option - if (!bibtotoc.empty() && !buffer().params().use_bibtopic) { - // set label for hyperref, see http://www.lyx.org/trac/ticket/6470 - if (buffer().params().pdfoptions().use_hyperref) - os << "\\phantomsection"; - if (buffer().params().documentClass().hasLaTeXLayout("chapter")) - os << "\\addcontentsline{toc}{chapter}{\\bibname}"; - else if (buffer().params().documentClass().hasLaTeXLayout("section")) - os << "\\addcontentsline{toc}{section}{\\refname}"; - } - - if (!db_out.empty() && !buffer().params().use_bibtopic) { - docstring btprint = getParam("btprint"); - if (btprint == "btPrintAll") { + if (btprint == "btPrintAll") os << "\\nocite{*}\n"; + if (btprint == "bibbysection" && !buffer().masterParams().multibib.empty()) + os << "\\bibbysection"; + else + os << "\\printbibliography"; + if (!opts.empty()) + os << "[" << opts << "]"; + os << "\n"; + } else {// using BibTeX + // Database(s) + vector const db_out = + buffer().prepareBibFilePaths(runparams, getBibFiles(), false); + // Style options + if (style == "default") + style = buffer().masterParams().defaultBiblioStyle(); + if (!style.empty() && !buffer().masterParams().useBibtopic()) { + string base = buffer().masterBuffer()->prepareFileNameForLaTeX(style, ".bst", runparams.nice); + FileName const try_in_file = + makeAbsPath(base + ".bst", buffer().filePath()); + bool const not_from_texmf = try_in_file.isReadableFile(); + // If this style does not come from texmf and we are not + // exporting to .tex copy it to the tmp directory. + // This prevents problems with spaces and 8bit characters + // in the file name. + if (!runparams.inComment && !runparams.dryrun && !runparams.nice && + not_from_texmf) { + // use new style name + DocFileName const in_file = DocFileName(try_in_file); + base = removeExtension(in_file.mangledFileName()); + FileName const out_file = makeAbsPath(base + ".bst", + buffer().masterBuffer()->temppath()); + bool const success = in_file.copyTo(out_file); + if (!success) { + LYXERR0("Failed to copy '" << in_file + << "' to '" << out_file << "'"); + } + } + // FIXME UNICODE + os << "\\bibliographystyle{" + << from_utf8(latex_path(buffer().prepareFileNameForLaTeX(base, ".bst", runparams.nice))) + << "}\n"; + } + // Warn about spaces in bst path. Warn only once. + static bool warned_about_bst_spaces = false; + if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) { + warned_about_bst_spaces = true; + Alert::warning(_("Export Warning!"), + _("There are spaces in the path to your BibTeX style file.\n" + "BibTeX will be unable to find it.")); + } + // Handle the bibtopic case + if (!db_out.empty() && buffer().masterParams().useBibtopic()) { + os << "\\begin{btSect}"; + if (!style.empty()) + os << "[" << style << "]"; + os << "{" << getStringFromVector(db_out) << "}\n"; + docstring btprint = getParam("btprint"); + if (btprint.empty()) + // default + btprint = from_ascii("btPrintCited"); + os << "\\" << btprint << "\n" + << "\\end{btSect}\n"; + } + // bibtotoc option + if (!bibtotoc.empty() && !buffer().masterParams().useBibtopic()) { + // set label for hyperref, see http://www.lyx.org/trac/ticket/6470 + if (buffer().masterParams().pdfoptions().use_hyperref) + os << "\\phantomsection"; + if (buffer().masterParams().documentClass().hasLaTeXLayout("chapter")) + os << "\\addcontentsline{toc}{chapter}{\\bibname}"; + else if (buffer().masterParams().documentClass().hasLaTeXLayout("section")) + os << "\\addcontentsline{toc}{section}{\\refname}"; + } + // The bibliography command + if (!db_out.empty() && !buffer().masterParams().useBibtopic()) { + docstring btprint = getParam("btprint"); + if (btprint == "btPrintAll") { + os << "\\nocite{*}\n"; + } + os << "\\bibliography{" << getStringFromVector(db_out) << "}\n"; } - os << "\\bibliography{" << db_out << "}\n"; } } -support::FileNamePairList InsetBibtex::getBibFiles() const +FileNamePairList InsetBibtex::getBibFiles() const { FileName path(buffer().filePath()); - support::PathChanger p(path); + PathChanger p(path); // We need to store both the real FileName and the way it is entered // (with full path, rel path or as a single file name). // The latter is needed for biblatex's central bibfile macro. - support::FileNamePairList vec; + FileNamePairList vec; vector bibfilelist = getVectorFromString(getParam("bibfiles")); vector::const_iterator it = bibfilelist.begin(); @@ -425,7 +384,6 @@ support::FileNamePairList InsetBibtex::getBibFiles() const } return vec; - } namespace { @@ -501,11 +459,9 @@ namespace { return false; // read value - bool legalChar = true; while (ifs && !isSpace(ch) && - delimChars.find(ch) == docstring::npos && - (legalChar = (illegalChars.find(ch) == docstring::npos)) - ) + delimChars.find(ch) == docstring::npos && + illegalChars.find(ch) == docstring::npos) { if (chCase == makeLowerCase) val += lowercase(ch); @@ -514,7 +470,7 @@ namespace { ifs.get(ch); } - if (!legalChar) { + if (illegalChars.find(ch) != docstring::npos) { ifs.putback(ch); return false; } @@ -666,16 +622,16 @@ namespace { return true; } -} +} // namespace -void InsetBibtex::collectBibKeys(InsetIterator const & /*di*/) const +void InsetBibtex::collectBibKeys(InsetIterator const & /*di*/, FileNameList & checkedFiles) const { - parseBibTeXFiles(); + parseBibTeXFiles(checkedFiles); } -void InsetBibtex::parseBibTeXFiles() const +void InsetBibtex::parseBibTeXFiles(FileNameList & checkedFiles) const { // This bibtex parser is a first step to parse bibtex files // more precisely. @@ -698,12 +654,19 @@ void InsetBibtex::parseBibTeXFiles() const BiblioInfo keylist; - support::FileNamePairList const files = getBibFiles(); - support::FileNamePairList::const_iterator it = files.begin(); - support::FileNamePairList::const_iterator en = files.end(); + FileNamePairList const files = getBibFiles(); + FileNamePairList::const_iterator it = files.begin(); + FileNamePairList::const_iterator en = files.end(); for (; it != en; ++ it) { - ifdocstream ifs(it->second.toFilesystemEncoding().c_str(), - ios_base::in, buffer().params().encoding().iconvName()); + FileName const bibfile = it->second; + if (find(checkedFiles.begin(), checkedFiles.end(), bibfile) != checkedFiles.end()) + // already checked this one. Skip. + continue; + else + // record that we check this. + checkedFiles.push_back(bibfile); + ifdocstream ifs(bibfile.toFilesystemEncoding().c_str(), + ios_base::in, buffer().masterParams().encoding().iconvName()); char_type ch; VarMap strings; @@ -914,8 +877,11 @@ bool InsetBibtex::delDatabase(docstring const & db) void InsetBibtex::validate(LaTeXFeatures & features) const { - if (features.bufferParams().use_bibtopic) + BufferParams const & mparams = features.buffer().masterParams(); + if (mparams.useBibtopic()) features.require("bibtopic"); + else if (!mparams.useBiblatex() && mparams.multibib == "child") + features.require("chapterbib"); // FIXME XHTML // It'd be better to be able to get this from an InsetLayout, but at present // InsetLayouts do not seem really to work for things that aren't InsetTexts. @@ -926,6 +892,11 @@ void InsetBibtex::validate(LaTeXFeatures & features) const } +void InsetBibtex::updateBuffer(ParIterator const &, UpdateType) { + buffer().registerBibfiles(getBibFiles()); +} + + int InsetBibtex::plaintext(odocstringstream & os, OutputParams const & op, size_t max_length) const { @@ -947,6 +918,10 @@ int InsetBibtex::plaintext(odocstringstream & os, docstring refoutput; refoutput += reflabel + "\n\n"; + // Tell BiblioInfo our purpose + CiteItem ci; + ci.context = CiteItem::Export; + // Now we loop over the entries vector::const_iterator vit = cites.begin(); vector::const_iterator const ven = cites.end(); @@ -961,7 +936,7 @@ int InsetBibtex::plaintext(odocstringstream & os, // FIXME Right now, we are calling BibInfo::getInfo on the key, // which will give us all the cross-referenced info. But for every // entry, so there's a lot of repitition. This should be fixed. - refoutput += bibinfo.getInfo(entry.key(), buffer(), false) + "\n\n"; + refoutput += bibinfo.getInfo(entry.key(), buffer(), ci) + "\n\n"; } os << refoutput; return refoutput.size(); @@ -975,11 +950,17 @@ docstring InsetBibtex::xhtml(XHTMLStream & xs, OutputParams const &) const { BiblioInfo const & bibinfo = buffer().masterBibInfo(); bool const all_entries = getParam("btprint") == "btPrintAll"; - vector const & cites = + vector const & cites = all_entries ? bibinfo.getKeys() : bibinfo.citedEntries(); docstring const reflabel = buffer().B_("References"); + // tell BiblioInfo our purpose + CiteItem ci; + ci.context = CiteItem::Export; + ci.richtext = true; + ci.max_key_size = UINT_MAX; + xs << html::StartTag("h2", "class='bibtex'") << reflabel << html::EndTag("h2") @@ -994,23 +975,23 @@ docstring InsetBibtex::xhtml(XHTMLStream & xs, OutputParams const &) const continue; BibTeXInfo const & entry = biit->second; - string const attr = "class='bibtexentry' id='LyXCite-" + string const attr = "class='bibtexentry' id='LyXCite-" + to_utf8(html::cleanAttr(entry.key())) + "'"; xs << html::StartTag("div", attr); - + // don't print labels if we're outputting all entries if (!all_entries) { xs << html::StartTag("span", "class='bibtexlabel'") << entry.label() << html::EndTag("span"); } - + // FIXME Right now, we are calling BibInfo::getInfo on the key, // which will give us all the cross-referenced info. But for every // entry, so there's a lot of repitition. This should be fixed. xs << html::StartTag("span", "class='bibtexinfo'") << XHTMLStream::ESCAPE_AND - << bibinfo.getInfo(entry.key(), buffer(), true) + << bibinfo.getInfo(entry.key(), buffer(), ci) << html::EndTag("span") << html::EndTag("div") << html::CR();