#include "Buffer.h"
#include "BufferParams.h"
#include "DispatchResult.h"
-#include "EmbeddedFiles.h"
#include "Encoding.h"
+#include "Format.h"
#include "FuncRequest.h"
+#include "FuncStatus.h"
#include "LaTeXFeatures.h"
#include "MetricsInfo.h"
+#include "output_xhtml.h"
#include "OutputParams.h"
#include "TextClass.h"
+#include "TocBackend.h"
#include "frontends/alert.h"
+#include "support/convert.h"
#include "support/debug.h"
#include "support/docstream.h"
#include "support/ExceptionMessage.h"
namespace os = support::os;
-InsetBibtex::InsetBibtex(InsetCommandParams const & p)
- : InsetCommand(p, "bibtex"), bibfiles_()
-{}
+InsetBibtex::InsetBibtex(Buffer const & buf, InsetCommandParams const & p)
+ : InsetCommand(p, "bibtex")
+{
+ Inset::setBuffer(const_cast<Buffer &>(buf));
+ buffer_->invalidateBibinfoCache();
+}
-void InsetBibtex::setBuffer(Buffer & buffer)
+InsetBibtex::~InsetBibtex()
{
- // FIXME We ought to have a buffer.
- if (buffer_) {
- EmbeddedFileList::iterator it = bibfiles_.begin();
- EmbeddedFileList::iterator en = bibfiles_.end();
- for (; it != en; ++it) {
- try {
- *it = it->copyTo(buffer);
- } catch (ExceptionMessage const & message) {
- Alert::error(message.title_, message.details_);
- // failed to embed
- it->setEmbed(false);
- }
- }
- }
- InsetCommand::setBuffer(buffer);
+ if (isBufferValid())
+ buffer_->invalidateBibinfoCache();
}
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_;
{
switch (cmd.action) {
+ case LFUN_INSET_EDIT:
+ editDatabases();
+ break;
+
case LFUN_INSET_MODIFY: {
InsetCommandParams p(BIBTEX_CODE);
try {
}
//
setParams(p);
- updateBibFiles();
- updateParam();
buffer().updateBibfilesCache();
break;
}
}
+bool InsetBibtex::getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const
+{
+ switch (cmd.action) {
+ case LFUN_INSET_EDIT:
+ flag.setEnabled(true);
+ return true;
+
+ default:
+ return InsetCommand::getStatus(cur, cmd, flag);
+ }
+}
+
+
+void InsetBibtex::editDatabases() const
+{
+ vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
+
+ if (bibfilelist.empty())
+ return;
+
+ int nr_databases = bibfilelist.size();
+ if (nr_databases > 1) {
+ docstring message = bformat(_("The BibTeX inset includes %1$s databases.\n"
+ "If you proceed, all of them will be opened."),
+ convert<docstring>(nr_databases));
+ int const ret = Alert::prompt(_("Open Databases?"),
+ message, 0, 1, _("&Cancel"), _("&Proceed"));
+
+ if (ret == 0)
+ return;
+ }
+
+ vector<docstring>::const_iterator it = bibfilelist.begin();
+ vector<docstring>::const_iterator en = bibfilelist.end();
+ for (; it != en; ++it) {
+ FileName bibfile = getBibTeXPath(*it, buffer());
+ formats.edit(buffer(), bibfile,
+ formats.getFormatFromFile(bibfile));
+ }
+}
+
+
docstring InsetBibtex::screenLabel() const
{
return _("BibTeX Generated Bibliography");
}
+docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
+{
+ docstring item = from_ascii("* ");
+ docstring tip = _("Databases:") + "\n";
+ vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
+
+ if (bibfilelist.empty()) {
+ tip += item;
+ tip += _("none");
+ } else {
+ vector<docstring>::const_iterator it = bibfilelist.begin();
+ vector<docstring>::const_iterator en = bibfilelist.end();
+ for (; it != en; ++it) {
+ tip += item;
+ tip += *it + "\n";
+ }
+ }
+
+ // Style-Options
+ bool toc = false;
+ docstring style = getParam("options"); // maybe empty! and with bibtotoc
+ docstring bibtotoc = from_ascii("bibtotoc");
+ if (prefixIs(style, bibtotoc)) {
+ toc = true;
+ if (contains(style, char_type(',')))
+ style = split(style, bibtotoc, char_type(','));
+ }
+
+ tip += _("Style File:") +"\n";
+ tip += item;
+ if (!style.empty())
+ tip += style;
+ else
+ tip += _("none");
+
+ tip += "\n" + _("Lists:") + " ";
+ docstring btprint = getParam("btprint");
+ 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");
+ }
+
+ 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(name).isAbsolute() || !FileName(fname + ext).isReadableFile())
+ if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
return name;
if (!runparams.nice)
return fname;
// use such filenames.)
// Otherwise, store the (maybe absolute) path to the original,
// unmangled database name.
- EmbeddedFileList::const_iterator it = bibfiles_.begin();
- EmbeddedFileList::const_iterator it_end = bibfiles_.end();
+ vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
+ vector<docstring>::const_iterator it = bibfilelist.begin();
+ vector<docstring>::const_iterator en = bibfilelist.end();
odocstringstream dbs;
- for (; it != it_end; ++it) {
- string utf8input = removeExtension(it->availableFile().absFilename());
+ bool didone = false;
+
+ for (; it != en; ++it) {
+ string utf8input = to_utf8(*it);
string database =
normalizeName(buffer(), runparams, utf8input, ".bib");
FileName const try_in_file =
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());
from_utf8(database));
}
- if (it != bibfiles_.begin())
+ if (didone)
dbs << ',';
+ else
+ didone = true;
// FIXME UNICODE
dbs << from_utf8(latex_path(database));
}
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;
}
-EmbeddedFileList const & InsetBibtex::getBibFiles() const
+support::FileNameList InsetBibtex::getBibFiles() const
{
- return bibfiles_;
+ 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();
+ for (; it != en; ++it) {
+ 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;
+
}
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)
///
/// @return true if a string of length > 0 could be read.
///
- bool readTypeOrKey(docstring & val, idocfstream & ifs,
+ bool readTypeOrKey(docstring & val, ifdocstream & ifs,
docstring const & delimChars, docstring const &illegalChars,
charCase chCase) {
/// 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;
// set end delimiter
char_type delim = ch == '"' ? '"': '}';
- //Skip whitespace
+ // Skip whitespace
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.
+ // We now have the first non-whitespace character
+ // We'll collapse adjacent whitespace.
bool lastWasWhiteSpace = false;
// inside this delimited text braces must match.
ifs.get(ch);
continue;
}
- //We output the space only after we stop getting
- //whitespace so as not to output any whitespace
- //at the end of the value.
+ // 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 += ' ';
// 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.
- EmbeddedFileList const & files = getBibFiles();
- EmbeddedFileList::const_iterator it = files.begin();
- EmbeddedFileList::const_iterator en = files.end();
+ 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->availableFile().toFilesystemEncoding().c_str(),
+ ifdocstream ifs(it->toFilesystemEncoding().c_str(),
ios_base::in, buffer().params().encoding().iconvName());
char_type ch;
docstring entryType;
- if (!readTypeOrKey(entryType, ifs, from_ascii("{("),
- docstring(), makeLowerCase) || !ifs)
+ if (!readTypeOrKey(entryType, ifs, from_ascii("{("), docstring(), makeLowerCase)) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Error reading entry type." << std::endl;
continue;
+ }
- if (entryType == from_ascii("comment")) {
+ if (!ifs) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
+ continue;
+ }
+ if (entryType == from_ascii("comment")) {
ifs.ignore(numeric_limits<int>::max(), '\n');
continue;
}
ifs.get(ch);
- if (!ifs)
+ if (!ifs) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
break;
+ }
if ((ch != '(') && (ch != '{')) {
- // invalid entry delimiter
+ lyxerr << "InsetBibtex::fillWithBibKeys: Invalid entry delimiter." << std::endl;
ifs.putback(ch);
continue;
}
docstring name;
docstring value;
- if (!readTypeOrKey(name, ifs, from_ascii("="),
- from_ascii("#{}(),"), makeLowerCase) || !ifs)
+ if (!readTypeOrKey(name, ifs, from_ascii("="), from_ascii("#{}(),"), makeLowerCase)) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Error reading string name." << std::endl;
+ continue;
+ }
+
+ if (!ifs) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
continue;
+ }
// next char must be an equal sign
ifs.get(ch);
- if (!ifs || ch != '=')
+ if (!ifs || ch != '=') {
+ lyxerr << "InsetBibtex::fillWithBibKeys: No `=' after string name: " <<
+ name << "." << std::endl;
continue;
+ }
- if (!readValue(value, ifs, strings))
+ if (!readValue(value, ifs, strings)) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for string: " <<
+ name << "." << std::endl;
continue;
+ }
strings[name] = value;
// can they be of any use in lyx?
docstring value;
- if (!readValue(value, ifs, strings))
+ if (!readValue(value, ifs, strings)) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read preamble value." << std::endl;
continue;
+ }
} else {
// Citation entry. Try to read the key.
docstring key;
- if (!readTypeOrKey(key, ifs, from_ascii(","),
- from_ascii("}"), keepCase) || !ifs)
+ if (!readTypeOrKey(key, ifs, from_ascii(","), from_ascii("}"), keepCase)) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read key for entry type:" <<
+ entryType << "." << std::endl;
continue;
+ }
+
+ if (!ifs) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
+ continue;
+ }
/////////////////////////////////////////////
// now we have a key, so we will add an entry
// next char must be an equal sign
ifs.get(ch);
- if (!ifs)
+ if (!ifs) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
break;
+ }
if (ch != '=') {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Missing `=' after field name: " <<
+ name << ", for key: " << key << "." << std::endl;
ifs.putback(ch);
break;
}
// read field value
- if (!readValue(value, ifs, strings))
+ if (!readValue(value, ifs, strings)) {
+ lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for field: " <<
+ name << ", for key: " << key << "." << std::endl;
break;
+ }
keyvalmap[name] = value;
data += "\n\n" + value;
keylist.addEntryType(entryType);
keyvalmap.setAllData(data);
keylist[key] = keyvalmap;
- }
+ } //< else (citation entry)
} //< searching '@'
} //< for loop over files
}
bool InsetBibtex::addDatabase(docstring const & db)
{
- FileName const texPath = getBibTeXPath(db, buffer());
- EmbeddedFileList::const_iterator efp =
- bibfiles_.findFile(texPath.absFilename());
- if (efp != bibfiles_.end())
- //already have it
+ docstring bibfiles = getParam("bibfiles");
+ if (tokenPos(bibfiles, ',', db) != -1)
return false;
-
- EmbeddedFile file(texPath.absFilename(), buffer().filePath());
- bibfiles_.push_back(file);
- updateParam();
+ if (!bibfiles.empty())
+ bibfiles += ',';
+ setParam("bibfiles", bibfiles + db);
return true;
}
bool InsetBibtex::delDatabase(docstring const & db)
{
- FileName const texPath = getBibTeXPath(db, buffer());
- EmbeddedFileList::iterator efp =
- bibfiles_.findFile(texPath.absFilename());
- if (efp == bibfiles_.end())
- // don't have it
- return false;
-
- bibfiles_.erase(efp);
- updateParam();
+ docstring bibfiles = getParam("bibfiles");
+ if (contains(bibfiles, db)) {
+ int const n = tokenPos(bibfiles, ',', db);
+ docstring bd = db;
+ if (n > 0) {
+ // this is not the first database
+ docstring tmp = ',' + bd;
+ setParam("bibfiles", subst(bibfiles, tmp, docstring()));
+ } else if (n == 0)
+ // this is the first (or only) database
+ setParam("bibfiles", split(bibfiles, bd, ','));
+ else
+ return false;
+ }
return true;
}
}
-void InsetBibtex::updateBibFiles() const
-{
- // need to do this to keep old info while also not
- // copying over any files that have been deleted.
- EmbeddedFileList oldlist = bibfiles_;
- bibfiles_.clear();
-
- docstring bibfile;
- docstring embfile;
-
- docstring bibfiles = getParam("bibfiles");
- docstring embfiles = getParam("embed");
-
- bibfiles = split(bibfiles, bibfile, ',');
- embfiles = split(embfiles, embfile, ',');
-
- while (!bibfile.empty()) {
- FileName bib = getBibTeXPath(bibfile, buffer());
- EmbeddedFileList::iterator efp = oldlist.findFile(bib.absFilename());
- if (efp != oldlist.end()) {
- // already have this one, but embedding status may have been changed
- bool old_status = efp->embedded();
- bool new_status = !embfile.empty();
- efp->setEmbed(new_status);
- try {
- // copy file if embedding status changed.
- efp->enable(buffer().embedded(), buffer(), old_status != new_status);
- } catch (ExceptionMessage const & message) {
- Alert::error(message.title_, message.details_);
- // failed to change embeddeing status
- efp->setEmbed(old_status);
- }
- bibfiles_.push_back(*efp);
- } else {
- EmbeddedFile file(bib.absFilename(), buffer().filePath());
- file.setEmbed(!embfile.empty());
- try {
- file.enable(buffer().embedded(), buffer(), true);
- } catch (ExceptionMessage const & message) {
- Alert::error(message.title_, message.details_);
- // failed to embed
- file.setEmbed(false);
- }
- bibfiles_.push_back(file);
- }
- // Get next file name
- bibfiles = split(bibfiles, bibfile, ',');
- embfiles = split(embfiles, embfile, ',');
+namespace {
+ // used in xhtml to sort a list of BibTeXInfo objects
+ bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs)
+ {
+ return lhs->getAbbreviatedAuthor() < rhs->getAbbreviatedAuthor();
}
}
-void InsetBibtex::updateParam()
+docstring InsetBibtex::xhtml(odocstream & os, OutputParams const &) const
{
- docstring bibfiles;
- docstring embed;
-
- bool first = true;
-
- EmbeddedFileList::iterator it = bibfiles_.begin();
- EmbeddedFileList::iterator en = bibfiles_.end();
+ // 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 en = toc.end();
+ vector<docstring> citekeys;
for (; it != en; ++it) {
- if (!first) {
- bibfiles += ',';
- embed += ',';
- } else
- first = false;
- bibfiles += from_utf8(it->outputFilename(buffer().filePath()));
- if (it->embedded())
- embed += from_utf8(it->inzipName());
+ if (it->str().empty())
+ continue;
+ vector<docstring> keys = getVectorFromString(it->str());
+ vector<docstring>::const_iterator dit = keys.begin();
+ vector<docstring>::const_iterator den = keys.end();
+ for (; dit != den; ++dit)
+ citekeys.push_back(*dit);
}
- setParam("bibfiles", bibfiles);
- setParam("embed", embed);
-}
-
-
-void InsetBibtex::registerEmbeddedFiles(EmbeddedFileList & files) const
-{
- if (bibfiles_.empty())
- updateBibFiles();
-
- EmbeddedFileList::const_iterator it = bibfiles_.begin();
- EmbeddedFileList::const_iterator en = bibfiles_.end();
- for (; it != en; ++it)
- files.registerFile(*it, this, buffer());
+ if (citekeys.empty())
+ return docstring();
+ sort(citekeys.begin(), citekeys.end());
+ unique(citekeys.begin(), 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...
+ // FIXME We need to do something here about cross-references, if we
+ // want to be able to display them AS cross-references. Probably the
+ // easiest thing to do is to loop over the list again and add whatever
+ // cross-references we find, then sort and unique it, planning just to
+ // add the cross-references to the bibliography.
+ vector<BibTeXInfo const *> binfo;
+ vector<docstring>::const_iterator cit = citekeys.begin();
+ vector<docstring>::const_iterator cen = citekeys.end();
+ BiblioInfo const & bi = buffer().masterBibInfo();
+ for (; cit != cen; ++cit) {
+ BiblioInfo::const_iterator bt = bi.find(*cit);
+ if (bt == bi.end())
+ continue;
+ binfo.push_back(&(bt->second));
+ }
+ // ...and sort it.
+ sort(binfo.begin(), binfo.end(), lSorter);
+ // Finally, then, we are ready for output.
+ os << "<h2 class='bibliography'>" << _("References") << "</h2>\n";
+ os << "<div class='bibliography'>\n";
+ vector<BibTeXInfo const *>::const_iterator vit = binfo.begin();
+ vector<BibTeXInfo const *>::const_iterator ven = binfo.end();
+ // Now we loop over the entries
+ for (; vit != ven; ++vit) {
+ BibTeXInfo const * bip = *vit;
+ os << "<p class='bibliography'>";
+ os << "<a name='" << html::htmlize(bip->key()) << "'></a>";
+ docstring label = bip->label();
+ if (label.empty())
+ label = bip->key();
+ os << "<span class='biblabel'>[" << label << "]</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.
+ os << "<span class='bibinfo'>" << bi.getInfo(bip->key()) << "</span>";
+ os << "</p>\n";
+ }
+
+ os << "</div>\n";
+ return docstring();
}
-void InsetBibtex::updateEmbeddedFile(EmbeddedFile const & file)
+docstring InsetBibtex::contextMenu(BufferView const &, int, int) const
{
- // look for the item and update status
- string const filename = file.absFilename();
- EmbeddedFileList::iterator it = bibfiles_.findFile(filename);
- if (it == bibfiles_.end())
- return;
- *it = file;
- updateParam();
+ return from_ascii("context-bibtex");
}
projects / lyx.git / blobdiff