#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 "LaTeXFeatures.h"
-#include "MetricsInfo.h"
#include "output_xhtml.h"
#include "OutputParams.h"
+#include "PDFOptions.h"
#include "TextClass.h"
-#include "TocBackend.h"
#include "frontends/alert.h"
#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"
#include "support/os.h"
-#include "support/Path.h"
+#include "support/PathChanger.h"
#include "support/textutils.h"
#include <limits>
InsetBibtex::InsetBibtex(Buffer * buf, InsetCommandParams const & p)
- : InsetCommand(buf, p, "bibtex")
+ : InsetCommand(buf, p)
{
- buffer_->invalidateBibinfoCache();
+ buffer().invalidateBibfileCache();
+ buffer().removeBiblioTempFiles();
}
InsetBibtex::~InsetBibtex()
{
- if (isBufferValid())
- buffer_->invalidateBibinfoCache();
+ if (isBufferLoaded()) {
+ buffer().invalidateBibfileCache();
+ buffer().removeBiblioTempFiles();
+ }
}
void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- switch (cmd.action) {
+ switch (cmd.action()) {
case LFUN_INSET_EDIT:
editDatabases();
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;
}
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;
vector<docstring>::const_iterator it = bibfilelist.begin();
vector<docstring>::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));
}
tip += _("all uncited references");
else
tip += _("all cited references");
-
+
if (toc) {
tip += ", ";
tip += _("included in TOC");
static string normalizeName(Buffer const & buffer,
OutputParams const & runparams, string const & name, string const & ext)
{
- string const fname = makeAbsPath(name, buffer.filePath()).absFilename();
+ string const fname = makeAbsPath(name, buffer.filePath()).absFileName();
if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
return name;
if (!runparams.nice)
}
-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}
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 =
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));
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
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);
os << "\\bibliographystyle{"
<< from_utf8(latex_path(normalizeName(buffer(), runparams, base, ".bst")))
<< "}\n";
- nlines += 1;
}
// Post this warning only once.
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}";
}
docstring btprint = getParam("btprint");
if (btprint == "btPrintAll") {
os << "\\nocite{*}\n";
- nlines += 1;
}
os << "\\bibliography{" << db_out << "}\n";
- nlines += 1;
}
-
- return nlines;
}
{
FileName path(buffer().filePath());
support::PathChanger p(path);
-
+
support::FileNameList vec;
-
+
vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
vector<docstring>::const_iterator it = bibfilelist.begin();
vector<docstring>::const_iterator en = bibfilelist.end();
else
LYXERR0("Couldn't find " + to_utf8(*it) + " in InsetBibtex::getBibFiles()!");
}
-
+
return vec;
}
/// @return true if a string of length > 0 could be read.
///
bool readTypeOrKey(docstring & val, ifdocstream & ifs,
- docstring const & delimChars, docstring const &illegalChars,
+ docstring const & delimChars, docstring const & illegalChars,
charCase chCase) {
char_type ch;
// 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);
val += ch;
ifs.get(ch);
}
-
+
if (!legalChar) {
ifs.putback(ch);
return false;
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;
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
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)
}
-// 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.
// 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();
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;
}
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;
}
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;
}
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;
}
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;
// 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;
}
} //< 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())
file = FileName(makeAbsPath(texfile, buf.filePath()));
return file;
}
-
+
bool InsetBibtex::addDatabase(docstring const & db)
{
// 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.addPreambleSnippet("<style type=\"text/css\">\n"
- "div.bibtexentry { margin-left: 2em; text-indent: -2em; }\n"
+ features.addCSSSnippet("div.bibtexentry { margin-left: 2em; text-indent: -2em; }\n"
"span.bibtexlabel:before{ content: \"[\"; }\n"
- "span.bibtexlabel:after{ content: \"] \"; }\n"
- "</style>");
+ "span.bibtexlabel:after{ content: \"] \"; }");
}
-namespace {
- // used in xhtml to sort a list of BibTeXInfo objects
- bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs)
- {
- return lhs->getAbbreviatedAuthor() < rhs->getAbbreviatedAuthor();
+int InsetBibtex::plaintext(odocstream & os, OutputParams const &) const
+{
+ BiblioInfo bibinfo = buffer().masterBibInfo();
+ bibinfo.makeCitationLabels(buffer());
+ vector<docstring> const & cites = bibinfo.citedEntries();
+
+ docstring refoutput;
+ docstring const reflabel = buffer().B_("References");
+
+ refoutput += reflabel + "\n\n";
+
+ // Now we loop over the entries
+ vector<docstring>::const_iterator vit = cites.begin();
+ vector<docstring>::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;
+ refoutput += "[" + entry.label() + "] ";
+ // 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";
}
+ os << refoutput;
+ return refoutput.size();
}
+// FIXME
+// docstring InsetBibtex::entriesAsXHTML(vector<docstring> const & entries)
+// And then here just: entriesAsXHTML(buffer().masterBibInfo().citedEntries())
docstring InsetBibtex::xhtml(XHTMLStream & xs, OutputParams const &) const
{
- // We are going to collect all the citation keys used in the document,
- // getting them from the TOC.
- Toc const & toc = buffer().tocBackend().toc("citation");
- Toc::const_iterator it = toc.begin();
- Toc::const_iterator const en = toc.end();
- vector<docstring> citekeys;
- for (; it != en; ++it) {
- if (it->str().empty())
- continue;
- vector<docstring> const keys = getVectorFromString(it->str());
- citekeys.insert(citekeys.end(), keys.begin(), keys.end());
- }
- if (citekeys.empty())
- return docstring();
- sort(citekeys.begin(), citekeys.end());
- vector<docstring>::iterator uit =
- unique(citekeys.begin(), citekeys.end());
- citekeys.erase(uit, citekeys.end());
- // We now have a sorted, unique list of the keys used in this document.
- // We will now convert it to a list of the BibTeXInfo objects used in
- // this document...
- vector<BibTeXInfo const *> binfo;
- vector<docstring>::const_iterator cit = citekeys.begin();
- vector<docstring>::const_iterator const cen = citekeys.end();
- BiblioInfo const & bi = buffer().masterBibInfo();
- for (; cit != cen; ++cit) {
- BiblioInfo::const_iterator const bt = bi.find(*cit);
- if (bt == bi.end() || !bt->second.isBibTeX())
- continue;
- binfo.push_back(&(bt->second));
- }
- // ...and sort it.
- sort(binfo.begin(), binfo.end(), lSorter);
- // Finally, then, we are ready for output.
- xs << StartTag("h2", "class='bibtex'")
- << _("References")
- << EndTag("h2")
- << StartTag("div", "class='bibtex'");
+ BiblioInfo const & bibinfo = buffer().masterBibInfo();
+ vector<docstring> const & cites = bibinfo.citedEntries();
+
+ docstring const reflabel = buffer().B_("References");
+
+ xs << html::StartTag("h2", "class='bibtex'")
+ << reflabel
+ << html::EndTag("h2")
+ << html::StartTag("div", "class='bibtex'");
// Now we loop over the entries
- vector<BibTeXInfo const *>::const_iterator vit = binfo.begin();
- vector<BibTeXInfo const *>::const_iterator const ven = binfo.end();
+ vector<docstring>::const_iterator vit = cites.begin();
+ vector<docstring>::const_iterator const ven = cites.end();
for (; vit != ven; ++vit) {
- BibTeXInfo const * bip = *vit;
- xs << StartTag("div", "class='bibtexentry'");
+ 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='" + to_utf8(bip->key()) + "'";
- xs << CompTag("a", attr);
- docstring label = bip->label();
- if (label.empty())
- label = bip->key();
- xs << StartTag("span", "class='bibtexlabel'")
- << label
- << EndTag("span");
+ string const attr =
+ "id='LyXCite-" + to_utf8(html::cleanAttr(entry.key())) + "'";
+ xs << html::CompTag("a", attr);
+ 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 << StartTag("span", "class='bibtexinfo'")
- << bi.getInfo(bip->key())
- << EndTag("span")
- << EndTag("div");
+ xs << html::StartTag("span", "class='bibtexinfo'")
+ << XHTMLStream::ESCAPE_AND
+ << bibinfo.getInfo(entry.key(), buffer(), true)
+ << html::EndTag("span")
+ << html::EndTag("div")
+ << html::CR();
}
- xs << EndTag("div");
+ 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";
}