X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetBibtex.cpp;h=a54b0b4a3a033155d0c5099b4fdf046c1595b9f1;hb=d8a6b5bfd0baa02a4ba03f8c9e9c618baf41b03f;hp=9f9d21398a5e1dbb7c95332a8ff3bec7d8b32d68;hpb=6d20abb1b1573b4a77e01a6b555af0bfa9fe1b48;p=lyx.git diff --git a/src/insets/InsetBibtex.cpp b/src/insets/InsetBibtex.cpp index 9f9d21398a..a54b0b4a3a 100644 --- a/src/insets/InsetBibtex.cpp +++ b/src/insets/InsetBibtex.cpp @@ -16,10 +16,9 @@ #include "Buffer.h" #include "BufferParams.h" #include "DispatchResult.h" -#include "support/debug.h" +#include "EmbeddedFiles.h" #include "Encoding.h" #include "FuncRequest.h" -#include "support/gettext.h" #include "LaTeXFeatures.h" #include "MetricsInfo.h" #include "OutputParams.h" @@ -27,17 +26,18 @@ #include "frontends/alert.h" +#include "support/debug.h" #include "support/ExceptionMessage.h" #include "support/docstream.h" -#include "support/FileNameList.h" #include "support/filetools.h" +#include "support/gettext.h" #include "support/lstrings.h" -#include "support/lyxlib.h" #include "support/os.h" #include "support/Path.h" #include "support/textutils.h" #include +#include using namespace std; using namespace lyx::support; @@ -53,13 +53,16 @@ InsetBibtex::InsetBibtex(InsetCommandParams const & p) {} -CommandInfo const * InsetBibtex::findInfo(string const & /* cmdName */) +ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */) { - static const char * const paramnames[] = - {"options", "btprint", "bibfiles", ""}; - static const bool isoptional[] = {true, true, false}; - static const CommandInfo info = {3, paramnames, isoptional}; - return &info; + static ParamInfo param_info_; + if (param_info_.empty()) { + param_info_.add("btprint", ParamInfo::LATEX_OPTIONAL); + param_info_.add("bibfiles", ParamInfo::LATEX_REQUIRED); + param_info_.add("embed", ParamInfo::LYX_INTERNAL); + param_info_.add("options", ParamInfo::LYX_INTERNAL); + } + return param_info_; } @@ -89,8 +92,50 @@ void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd) throw message; break; } + // + InsetCommandParams orig = params(); + // returned "embed" is composed of "true" or "false", which needs to be adjusted + string tmp; + string emb; + + string newBibfiles; + string newEmbedStatus; + + string bibfiles = to_utf8(p["bibfiles"]); + string embedStatus = to_utf8(p["embed"]); + + bibfiles = split(bibfiles, tmp, ','); + embedStatus = split(embedStatus, emb, ','); + while (!tmp.empty()) { + EmbeddedFile file(changeExtension(tmp, "bib"), buffer().filePath()); + if (!newBibfiles.empty()) + newBibfiles += ","; + newBibfiles += tmp; + if (!newEmbedStatus.empty()) + newEmbedStatus += ","; + if (emb == "true") + newEmbedStatus += file.inzipName(); + // Get next file name + bibfiles = split(bibfiles, tmp, ','); + embedStatus = split(embedStatus, emb, ','); + } + LYXERR(Debug::FILES, "Update parameters from " << p["bibfiles"] + << " " << p["embed"] << " to " << newBibfiles << " " + << newEmbedStatus); + p["bibfiles"] = from_utf8(newBibfiles); + p["embed"] = from_utf8(newEmbedStatus); + setParams(p); - cur.buffer().updateBibfilesCache(); + try { + // test parameter and copy files + embeddedFiles(); + } catch (ExceptionMessage const & message) { + Alert::error(message.title_, message.details_); + // do not set parameter if an error happens + setParams(orig); + break; + } + buffer().updateBibfilesCache(); break; } @@ -101,19 +146,17 @@ void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd) } -docstring const InsetBibtex::getScreenLabel(Buffer const &) const +docstring InsetBibtex::screenLabel() const { return _("BibTeX Generated Bibliography"); } -namespace { - -string normalizeName(Buffer const & buffer, OutputParams const & runparams, - string const & name, string const & ext) +static string normalizeName(Buffer const & buffer, + OutputParams const & runparams, string const & name, string const & ext) { string const fname = makeAbsPath(name, buffer.filePath()).absFilename(); - if (absolutePath(name) || !FileName(fname + ext).isReadableFile()) + if (FileName(name).isAbsolute() || !FileName(fname + ext).isReadableFile()) return name; if (!runparams.nice) return fname; @@ -123,11 +166,8 @@ string normalizeName(Buffer const & buffer, OutputParams const & runparams, from_utf8(buffer.masterBuffer()->filePath()))); } -} - -int InsetBibtex::latex(Buffer const & buffer, odocstream & os, - OutputParams const & runparams) const +int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const { // the sequence of the commands: // 1. \bibliographystyle{style} @@ -149,25 +189,16 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, // use such filenames.) // Otherwise, store the (maybe absolute) path to the original, // unmangled database name. - typedef boost::char_separator Separator; - typedef boost::tokenizer Tokenizer; - - Separator const separator(from_ascii(",").c_str()); - // The tokenizer must not be called with temporary strings, since - // it does not make a copy and uses iterators of the string further - // down. getParam returns a reference, so this is OK. - Tokenizer const tokens(getParam("bibfiles"), separator); - Tokenizer::const_iterator const begin = tokens.begin(); - Tokenizer::const_iterator const end = tokens.end(); - + EmbeddedFileList const bibs = embeddedFiles(); + EmbeddedFileList::const_iterator it = bibs.begin(); + EmbeddedFileList::const_iterator it_end = bibs.end(); odocstringstream dbs; - for (Tokenizer::const_iterator it = begin; it != end; ++it) { - docstring const input = trim(*it); - // FIXME UNICODE - string utf8input = to_utf8(input); + for (; it != it_end; ++it) { + string utf8input = removeExtension(it->availableFile().absFilename()); string database = - normalizeName(buffer, runparams, utf8input, ".bib"); - FileName const try_in_file(makeAbsPath(database + ".bib", buffer.filePath())); + 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 && @@ -177,7 +208,7 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, DocFileName const in_file = DocFileName(try_in_file); database = removeExtension(in_file.mangledFilename()); FileName const out_file = makeAbsPath(database + ".bib", - buffer.masterBuffer()->temppath()); + buffer().masterBuffer()->temppath()); bool const success = in_file.copyTo(out_file); if (!success) { @@ -193,7 +224,7 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, from_utf8(database)); } - if (it != begin) + if (it != bibs.begin()) dbs << ','; // FIXME UNICODE dbs << from_utf8(latex_path(database)); @@ -224,8 +255,9 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, int nlines = 0; if (!style.empty()) { - string base = normalizeName(buffer, runparams, style, ".bst"); - FileName const try_in_file(makeAbsPath(base + ".bst", buffer.filePath())); + 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. @@ -236,8 +268,8 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, // 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())); + 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 @@ -247,7 +279,7 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, } // FIXME UNICODE os << "\\bibliographystyle{" - << from_utf8(latex_path(normalizeName(buffer, runparams, base, ".bst"))) + << from_utf8(latex_path(normalizeName(buffer(), runparams, base, ".bst"))) << "}\n"; nlines += 1; } @@ -261,7 +293,7 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, "BibTeX will be unable to find it.")); } - if (!db_out.empty() && buffer.params().use_bibtopic){ + if (!db_out.empty() && buffer().params().use_bibtopic) { os << "\\begin{btSect}{" << db_out << "}\n"; docstring btprint = getParam("btprint"); if (btprint.empty()) @@ -273,14 +305,13 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, } // bibtotoc-Option - if (!bibtotoc.empty() && !buffer.params().use_bibtopic) { + if (!bibtotoc.empty() && !buffer().params().use_bibtopic) { // maybe a problem when a textclass has no "art" as // part of its name, because it's than book. // For the "official" lyx-layouts it's no problem to support // all well - if (!contains(buffer.params().getTextClass().name(), - "art")) { - if (buffer.params().sides == OneSide) { + if (!contains(buffer().params().documentClass().name(), "art")) { + if (buffer().params().sides == OneSide) { // oneside os << "\\clearpage"; } else { @@ -297,7 +328,12 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, } } - if (!db_out.empty() && !buffer.params().use_bibtopic){ + if (!db_out.empty() && !buffer().params().use_bibtopic) { + docstring btprint = getParam("btprint"); + if (btprint == "btPrintAll") { + os << "\\nocite{*}\n"; + nlines += 1; + } os << "\\bibliography{" << db_out << "}\n"; nlines += 1; } @@ -306,27 +342,43 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os, } -FileNameList const InsetBibtex::getFiles(Buffer const & buffer) const +EmbeddedFileList InsetBibtex::embeddedFiles() const { - FileName path(buffer.filePath()); + FileName path(buffer().filePath()); PathChanger p(path); - FileNameList vec; + EmbeddedFileList vec; string tmp; + string emb; // FIXME UNICODE string bibfiles = to_utf8(getParam("bibfiles")); + string embedStatus = to_utf8(getParam("embed")); bibfiles = split(bibfiles, tmp, ','); + embedStatus = split(embedStatus, emb, ','); while (!tmp.empty()) { - FileName const file = findtexfile(changeExtension(tmp, "bib"), "bib"); - LYXERR(Debug::LATEX, "Bibfile: " << file); - - // If we didn't find a matching file name just fail silently - if (!file.empty()) + if (!emb.empty()) { + EmbeddedFile file(changeExtension(tmp, "bib"), buffer().filePath()); + // If the file structure is correct, this should not fail. + file.setEmbed(true); + file.enable(buffer().embedded(), &buffer()); vec.push_back(file); + } else { + // this includes the cases when the embed parameter is empty + FileName const file = findtexfile(changeExtension(tmp, "bib"), "bib"); + + // If we didn't find a matching file name just fail silently + if (!file.empty()) { + EmbeddedFile efile = EmbeddedFile(file.absFilename(), buffer().filePath()); + efile.setEmbed(false); + efile.enable(buffer().embedded(), &buffer()); + vec.push_back(efile); + } + } // Get next file name bibfiles = split(bibfiles, tmp, ','); + embedStatus = split(embedStatus, emb, ','); } return vec; @@ -571,11 +623,11 @@ namespace { // This method returns a comma separated list of Bibtex entries -void InsetBibtex::fillWithBibKeys(Buffer const & buffer, - BiblioInfo & keylist, InsetIterator const & /*di*/) const +void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, + InsetIterator const & /*di*/) const { - FileNameList const files = getFiles(buffer); - for (vector::const_iterator it = files.begin(); + EmbeddedFileList const files = embeddedFiles(); + for (vector::const_iterator it = files.begin(); it != files.end(); ++ it) { // This bibtex parser is a first step to parse bibtex files // more precisely. @@ -596,9 +648,8 @@ void InsetBibtex::fillWithBibKeys(Buffer const & buffer, // InsetBibitem can generate non-ASCII keys, and nonstandard // 8bit clean bibtex forks exist. - idocfstream ifs(it->toFilesystemEncoding().c_str(), - ios_base::in, - buffer.params().encoding().iconvName()); + idocfstream ifs(it->availableFile().toFilesystemEncoding().c_str(), + ios_base::in, buffer().params().encoding().iconvName()); char_type ch; VarMap strings; @@ -687,8 +738,7 @@ void InsetBibtex::fillWithBibKeys(Buffer const & buffer, docstring value; docstring commaNewline; docstring data; - BibTeXInfo keyvalmap; - keyvalmap.entryType = entryType; + BibTeXInfo keyvalmap(key, entryType); bool readNext = removeWSAndComma(ifs); @@ -714,15 +764,13 @@ void InsetBibtex::fillWithBibKeys(Buffer const & buffer, keyvalmap[name] = value; data += "\n\n" + value; - keylist.fieldNames.insert(name); + keylist.addFieldName(name); readNext = removeWSAndComma(ifs); } // add the new entry - keylist.entryTypes.insert(entryType); - keyvalmap.allData = data; - keyvalmap.isBibTeX = true; - keyvalmap.bibKey = key; + keylist.addEntryType(entryType); + keyvalmap.setAllData(data); keylist[key] = keyvalmap; } } //< searching '@' @@ -773,4 +821,42 @@ void InsetBibtex::validate(LaTeXFeatures & features) const } +void InsetBibtex::registerEmbeddedFiles(EmbeddedFileList & files) const +{ + EmbeddedFileList const dbs = embeddedFiles(); + for (vector::const_iterator it = dbs.begin(); + it != dbs.end(); ++it) + files.registerFile(*it, this, buffer()); +} + + +void InsetBibtex::updateEmbeddedFile(EmbeddedFile const & file) +{ + // look for the item and update status + docstring bibfiles; + docstring embed; + + bool first = true; + EmbeddedFileList dbs = embeddedFiles(); + for (EmbeddedFileList::iterator it = dbs.begin(); + it != dbs.end(); ++it) { + // update from file + if (it->absFilename() == file.absFilename()) + it->setEmbed(file.embedded()); + // write parameter string + if (!first) { + bibfiles += ','; + embed += ','; + } else { + first = false; + } + bibfiles += from_utf8(it->outputFilename(buffer().filePath())); + if (it->embedded()) + embed += from_utf8(it->inzipName()); + } + setParam("bibfiles", bibfiles); + setParam("embed", embed); +} + + } // namespace lyx