X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetBibtex.cpp;h=8f33a2de3c37ca2c2c1501cc7028aaedac1b0c11;hb=3588f2f69675df8dbf829800b0ed6e4a455c68b4;hp=95dc99c53c40566965d704eb166f6984cef1fa56;hpb=8a64579d9c3c4eda99f35c7336b0895ad1c4f5ee;p=lyx.git diff --git a/src/insets/InsetBibtex.cpp b/src/insets/InsetBibtex.cpp index 95dc99c53c..8f33a2de3c 100644 --- a/src/insets/InsetBibtex.cpp +++ b/src/insets/InsetBibtex.cpp @@ -13,16 +13,21 @@ #include "InsetBibtex.h" +#include "BiblioInfo.h" #include "Buffer.h" #include "BufferParams.h" +#include "Cursor.h" #include "DispatchResult.h" #include "Encoding.h" +#include "Exporter.h" #include "Format.h" #include "FuncRequest.h" #include "FuncStatus.h" +#include "Language.h" #include "LaTeXFeatures.h" -#include "MetricsInfo.h" +#include "output_xhtml.h" #include "OutputParams.h" +#include "PDFOptions.h" #include "TextClass.h" #include "frontends/alert.h" @@ -31,6 +36,7 @@ #include "support/debug.h" #include "support/docstream.h" #include "support/ExceptionMessage.h" +#include "support/FileNameList.h" #include "support/filetools.h" #include "support/gettext.h" #include "support/lstrings.h" @@ -49,18 +55,20 @@ namespace Alert = frontend::Alert; namespace os = support::os; -InsetBibtex::InsetBibtex(Buffer const & buf, InsetCommandParams const & p) - : InsetCommand(p, "bibtex") +InsetBibtex::InsetBibtex(Buffer * buf, InsetCommandParams const & p) + : InsetCommand(buf, p) { - Inset::setBuffer(const_cast(buf)); - buffer_->invalidateBibinfoCache(); + buffer().invalidateBibfileCache(); + buffer().removeBiblioTempFiles(); } InsetBibtex::~InsetBibtex() { - if (buffer_) - buffer_->invalidateBibinfoCache(); + if (isBufferLoaded()) { + buffer().invalidateBibfileCache(); + buffer().removeBiblioTempFiles(); + } } @@ -78,7 +86,7 @@ ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */) void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd) { - switch (cmd.action) { + switch (cmd.action()) { case LFUN_INSET_EDIT: editDatabases(); @@ -87,22 +95,24 @@ void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd) case LFUN_INSET_MODIFY: { InsetCommandParams p(BIBTEX_CODE); try { - if (!InsetCommand::string2params("bibtex", - to_utf8(cmd.argument()), p)) { - cur.noUpdate(); + if (!InsetCommand::string2params(to_utf8(cmd.argument()), p)) { + cur.noScreenUpdate(); break; } } catch (ExceptionMessage const & message) { if (message.type_ == WarningException) { Alert::warning(message.title_, message.details_); - cur.noUpdate(); - } else + cur.noScreenUpdate(); + } else throw message; break; } - // + + cur.recordUndo(); setParams(p); - buffer().updateBibfilesCache(); + buffer().invalidateBibfileCache(); + buffer().removeBiblioTempFiles(); + cur.forceBufferUpdate(); break; } @@ -116,7 +126,7 @@ void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd) bool InsetBibtex::getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & flag) const { - switch (cmd.action) { + switch (cmd.action()) { case LFUN_INSET_EDIT: flag.setEnabled(true); return true; @@ -149,7 +159,7 @@ void InsetBibtex::editDatabases() const vector::const_iterator it = bibfilelist.begin(); vector::const_iterator en = bibfilelist.end(); for (; it != en; ++it) { - FileName bibfile = getBibTeXPath(*it, buffer()); + FileName const bibfile = getBibTeXPath(*it, buffer()); formats.edit(buffer(), bibfile, formats.getFormatFromFile(bibfile)); } @@ -205,7 +215,7 @@ docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) tip += _("all uncited references"); else tip += _("all cited references"); - + if (toc) { tip += ", "; tip += _("included in TOC"); @@ -218,8 +228,8 @@ docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) 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(name).isAbsolute() || !FileName(fname + ext).isReadableFile()) + string const fname = makeAbsPath(name, buffer.filePath()).absFileName(); + if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile()) return name; if (!runparams.nice) return fname; @@ -230,7 +240,7 @@ static string normalizeName(Buffer const & buffer, } -int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const +void InsetBibtex::latex(otexstream & os, OutputParams const & runparams) const { // the sequence of the commands: // 1. \bibliographystyle{style} @@ -258,6 +268,9 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const 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 = @@ -268,30 +281,37 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const if (!runparams.inComment && !runparams.dryrun && !runparams.nice && not_from_texmf) { - - // mangledFilename() needs the extension + // mangledFileName() needs the extension DocFileName const in_file = DocFileName(try_in_file); - database = removeExtension(in_file.mangledFilename()); + 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 && - !isValidLaTeXFilename(database)) { + } 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 is likely to cause trouble " - "when running the exported file through LaTeX: ") + - from_utf8(database)); + _("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 + else didone = true; // FIXME UNICODE dbs << from_utf8(latex_path(database)); @@ -303,7 +323,6 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const 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.")); @@ -317,13 +336,12 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const style = split(style, bibtotoc, ','); } - - // line count - int nlines = 0; + if (style == "default") + style = buffer().params().biblio_style; if (!style.empty()) { string base = normalizeName(buffer(), runparams, style, ".bst"); - FileName const try_in_file = + 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 @@ -334,7 +352,7 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const not_from_texmf) { // use new style name DocFileName const in_file = DocFileName(try_in_file); - base = removeExtension(in_file.mangledFilename()); + base = removeExtension(in_file.mangledFileName()); FileName const out_file = makeAbsPath(base + ".bst", buffer().masterBuffer()->temppath()); bool const success = in_file.copyTo(out_file); @@ -348,7 +366,6 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const os << "\\bibliographystyle{" << from_utf8(latex_path(normalizeName(buffer(), runparams, base, ".bst"))) << "}\n"; - nlines += 1; } // Post this warning only once. @@ -368,21 +385,16 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const btprint = from_ascii("btPrintCited"); os << "\\" << btprint << "\n" << "\\end{btSect}\n"; - nlines += 3; } // bibtotoc-Option if (!bibtotoc.empty() && !buffer().params().use_bibtopic) { - if (buffer().params().documentClass().hasLaTeXLayout("chapter")) { - if (buffer().params().sides == OneSide) { - // oneside - os << "\\clearpage"; - } else { - // twoside - os << "\\cleardoublepage"; - } + // 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")) + else if (buffer().params().documentClass().hasLaTeXLayout("section")) os << "\\addcontentsline{toc}{section}{\\refname}"; } @@ -390,13 +402,9 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const docstring btprint = getParam("btprint"); if (btprint == "btPrintAll") { os << "\\nocite{*}\n"; - nlines += 1; } os << "\\bibliography{" << db_out << "}\n"; - nlines += 1; } - - return nlines; } @@ -404,22 +412,21 @@ support::FileNameList InsetBibtex::getBibFiles() const { FileName path(buffer().filePath()); support::PathChanger p(path); - + support::FileNameList vec; - + vector bibfilelist = getVectorFromString(getParam("bibfiles")); vector::const_iterator it = bibfilelist.begin(); vector::const_iterator en = bibfilelist.end(); for (; it != en; ++it) { - FileName const file = - findtexfile(changeExtension(to_utf8(*it), "bib"), "bib"); + FileName const file = getBibTeXPath(*it, buffer()); if (!file.empty()) vec.push_back(file); else LYXERR0("Couldn't find " + to_utf8(*it) + " in InsetBibtex::getBibFiles()!"); } - + return vec; } @@ -434,7 +441,7 @@ namespace { /// and further whitespace characters from the stream. /// @return true if a comma was found, false otherwise /// - bool removeWSAndComma(idocfstream & ifs) { + bool removeWSAndComma(ifdocstream & ifs) { char_type ch; if (!ifs) @@ -477,8 +484,8 @@ namespace { /// /// @return true if a string of length > 0 could be read. /// - bool readTypeOrKey(docstring & val, idocfstream & ifs, - docstring const & delimChars, docstring const &illegalChars, + bool readTypeOrKey(docstring & val, ifdocstream & ifs, + docstring const & delimChars, docstring const & illegalChars, charCase chCase) { char_type ch; @@ -498,10 +505,10 @@ namespace { // read value bool legalChar = true; - while (ifs && !isSpace(ch) && + while (ifs && !isSpace(ch) && delimChars.find(ch) == docstring::npos && (legalChar = (illegalChars.find(ch) == docstring::npos)) - ) + ) { if (chCase == makeLowerCase) val += lowercase(ch); @@ -509,7 +516,7 @@ namespace { val += ch; ifs.get(ch); } - + if (!legalChar) { ifs.putback(ch); return false; @@ -532,7 +539,7 @@ namespace { /// the variable strings. /// @return true if reading was successfull (all single parts were delimited /// correctly) - bool readValue(docstring & val, idocfstream & ifs, const VarMap & strings) { + bool readValue(docstring & val, ifdocstream & ifs, const VarMap & strings) { char_type ch; @@ -551,13 +558,13 @@ namespace { return false; // check for field type - if (isDigit(ch)) { + if (isDigitASCII(ch)) { // read integer value do { val += ch; ifs.get(ch); - } while (ifs && isDigit(ch)); + } while (ifs && isDigitASCII(ch)); if (!ifs) return false; @@ -570,33 +577,33 @@ namespace { do { ifs.get(ch); } while (ifs && isSpace(ch)); - + if (!ifs) return false; - + // We now have the first non-whitespace character // We'll collapse adjacent whitespace. bool lastWasWhiteSpace = false; - + // inside this delimited text braces must match. // Thus we can have a closing delimiter only // when nestLevel == 0 int nestLevel = 0; - + while (ifs && (nestLevel > 0 || ch != delim)) { if (isSpace(ch)) { lastWasWhiteSpace = true; ifs.get(ch); continue; } - // We output the space only after we stop getting + // We output the space only after we stop getting // whitespace so as not to output any whitespace // at the end of the value. if (lastWasWhiteSpace) { lastWasWhiteSpace = false; val += ' '; } - + val += ch; // update nesting level @@ -606,16 +613,19 @@ namespace { break; case '}': --nestLevel; - if (nestLevel < 0) return false; + if (nestLevel < 0) + return false; break; } - ifs.get(ch); + if (ifs) + ifs.get(ch); } if (!ifs) return false; + // FIXME Why is this here? ifs.get(ch); if (!ifs) @@ -662,9 +672,13 @@ namespace { } -// This method returns a comma separated list of Bibtex entries -void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, - InsetIterator const & /*di*/) const +void InsetBibtex::collectBibKeys(InsetIterator const & /*di*/) const +{ + parseBibTeXFiles(); +} + + +void InsetBibtex::parseBibTeXFiles() const { // This bibtex parser is a first step to parse bibtex files // more precisely. @@ -684,11 +698,14 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, // We don't restrict keys to ASCII in LyX, since our own // InsetBibitem can generate non-ASCII keys, and nonstandard // 8bit clean bibtex forks exist. + + BiblioInfo keylist; + support::FileNameList const files = getBibFiles(); support::FileNameList::const_iterator it = files.begin(); support::FileNameList::const_iterator en = files.end(); for (; it != en; ++ it) { - idocfstream ifs(it->toFilesystemEncoding().c_str(), + ifdocstream ifs(it->toFilesystemEncoding().c_str(), ios_base::in, buffer().params().encoding().iconvName()); char_type ch; @@ -706,12 +723,12 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, docstring entryType; if (!readTypeOrKey(entryType, ifs, from_ascii("{("), docstring(), makeLowerCase)) { - lyxerr << "InsetBibtex::fillWithBibKeys: Error reading entry type." << std::endl; + lyxerr << "BibTeX Parser: Error reading entry type." << std::endl; continue; } if (!ifs) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl; + lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl; continue; } @@ -722,12 +739,12 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, ifs.get(ch); if (!ifs) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl; + lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl; break; } if ((ch != '(') && (ch != '{')) { - lyxerr << "InsetBibtex::fillWithBibKeys: Invalid entry delimiter." << std::endl; + lyxerr << "BibTeX Parser: Invalid entry delimiter." << std::endl; ifs.putback(ch); continue; } @@ -741,25 +758,25 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, docstring value; if (!readTypeOrKey(name, ifs, from_ascii("="), from_ascii("#{}(),"), makeLowerCase)) { - lyxerr << "InsetBibtex::fillWithBibKeys: Error reading string name." << std::endl; + lyxerr << "BibTeX Parser: Error reading string name." << std::endl; continue; } if (!ifs) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl; + lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl; continue; } // next char must be an equal sign ifs.get(ch); if (!ifs || ch != '=') { - lyxerr << "InsetBibtex::fillWithBibKeys: No `=' after string name: " << + lyxerr << "BibTeX Parser: No `=' after string name: " << name << "." << std::endl; continue; } if (!readValue(value, ifs, strings)) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for string: " << + lyxerr << "BibTeX Parser: Unable to read value for string: " << name << "." << std::endl; continue; } @@ -773,7 +790,7 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, docstring value; if (!readValue(value, ifs, strings)) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read preamble value." << std::endl; + lyxerr << "BibTeX Parser: Unable to read preamble value." << std::endl; continue; } @@ -783,48 +800,47 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, docstring key; if (!readTypeOrKey(key, ifs, from_ascii(","), from_ascii("}"), keepCase)) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read key for entry type:" << + lyxerr << "BibTeX Parser: Unable to read key for entry type:" << entryType << "." << std::endl; continue; } if (!ifs) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl; + lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl; continue; } ///////////////////////////////////////////// - // now we have a key, so we will add an entry + // now we have a key, so we will add an entry // (even if it's empty, as bibtex does) // // we now read the field = value pairs. // all items must be separated by a comma. If // it is missing the scanning of this entry is // stopped and the next is searched. - docstring fields; docstring name; docstring value; - docstring commaNewline; docstring data; BibTeXInfo keyvalmap(key, entryType); - + bool readNext = removeWSAndComma(ifs); - + while (ifs && readNext) { // read field name - if (!readTypeOrKey(name, ifs, from_ascii("="), + if (!readTypeOrKey(name, ifs, from_ascii("="), from_ascii("{}(),"), makeLowerCase) || !ifs) break; // next char must be an equal sign + // FIXME Whitespace?? ifs.get(ch); if (!ifs) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl; + lyxerr << "BibTeX Parser: Unexpected end of file." << std::endl; break; } if (ch != '=') { - lyxerr << "InsetBibtex::fillWithBibKeys: Missing `=' after field name: " << + lyxerr << "BibTeX Parser: Missing `=' after field name: " << name << ", for key: " << key << "." << std::endl; ifs.putback(ch); break; @@ -832,7 +848,7 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, // read field value if (!readValue(value, ifs, strings)) { - lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for field: " << + lyxerr << "BibTeX Parser: Unable to read value for field: " << name << ", for key: " << key << "." << std::endl; break; } @@ -850,13 +866,15 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist, } //< else (citation entry) } //< searching '@' } //< for loop over files + + buffer().addBiblioInfo(keylist); } FileName InsetBibtex::getBibTeXPath(docstring const & filename, Buffer const & buf) { string texfile = changeExtension(to_utf8(filename), "bib"); - // note that, if the filename can be found directly from the path, + // note that, if the filename can be found directly from the path, // findtexfile will just return a FileName object for that path. FileName file(findtexfile(texfile, "bib")); if (file.empty()) @@ -901,12 +919,87 @@ void InsetBibtex::validate(LaTeXFeatures & features) const { if (features.bufferParams().use_bibtopic) features.require("bibtopic"); + // 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. + if (features.runparams().flavor == OutputParams::HTML) + features.addCSSSnippet("div.bibtexentry { margin-left: 2em; text-indent: -2em; }\n" + "span.bibtexlabel:before{ content: \"[\"; }\n" + "span.bibtexlabel:after{ content: \"] \"; }"); +} + + +// FIXME +// docstring InsetBibtex::entriesAsXHTML(vector const & entries) +// And then here just: entriesAsXHTML(buffer().masterBibInfo().citedEntries()) +docstring InsetBibtex::xhtml(XHTMLStream & xs, OutputParams const &) const +{ + BiblioInfo const & bibinfo = buffer().masterBibInfo(); + vector const & cites = bibinfo.citedEntries(); + CiteEngineType const engine_type = buffer().params().citeEngineType(); + bool const numbers = (engine_type == ENGINE_TYPE_NUMERICAL); + + docstring reflabel = from_ascii("References"); + Language const * l = buffer().params().language; + if (l) + reflabel = translateIfPossible(reflabel, l->code()); + + xs << html::StartTag("h2", "class='bibtex'") + << reflabel + << html::EndTag("h2") + << html::StartTag("div", "class='bibtex'"); + + // Now we loop over the entries + vector::const_iterator vit = cites.begin(); + vector::const_iterator const ven = cites.end(); + for (; vit != ven; ++vit) { + BiblioInfo::const_iterator const biit = bibinfo.find(*vit); + if (biit == bibinfo.end()) + continue; + BibTeXInfo const & entry = biit->second; + xs << html::StartTag("div", "class='bibtexentry'"); + // FIXME XHTML + // The same name/id problem we have elsewhere. + string const attr = + "id='LyXCite-" + to_utf8(html::cleanAttr(entry.key())) + "'"; + xs << html::CompTag("a", attr); + docstring citekey; + if (numbers) + citekey = entry.citeNumber(); + else { + docstring const auth = entry.getAbbreviatedAuthor(); + // we do it this way so as to access the xref, if necessary + // note that this also gives us the modifier + docstring const year = bibinfo.getYear(*vit, true); + if (!auth.empty() && !year.empty()) + citekey = auth + ' ' + year; + } + if (citekey.empty()) { + citekey = entry.label(); + if (citekey.empty()) + citekey = entry.key(); + } + xs << html::StartTag("span", "class='bibtexlabel'") + << citekey + << 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) + << html::EndTag("span") + << html::EndTag("div") + << html::CR(); + } + xs << html::EndTag("div"); + return docstring(); } -docstring InsetBibtex::contextMenu(BufferView const &, int, int) const +string InsetBibtex::contextMenuName() const { - return from_ascii("context-bibtex"); + return "context-bibtex"; }