#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 "OutputParams.h"
#include "frontends/alert.h"
+#include "support/convert.h"
#include "support/debug.h"
-#include "support/ExceptionMessage.h"
#include "support/docstream.h"
+#include "support/ExceptionMessage.h"
#include "support/filetools.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/Path.h"
#include "support/textutils.h"
-#include <boost/tokenizer.hpp>
#include <limits>
using namespace std;
namespace os = support::os;
-InsetBibtex::InsetBibtex(InsetCommandParams const & p)
+InsetBibtex::InsetBibtex(Buffer const & buf, InsetCommandParams const & p)
: InsetCommand(p, "bibtex")
-{}
+{
+ Inset::setBuffer(const_cast<Buffer &>(buf));
+ buffer_->invalidateBibinfoCache();
+}
+
+
+InsetBibtex::~InsetBibtex()
+{
+ if (isBufferValid())
+ buffer_->invalidateBibinfoCache();
+}
ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */)
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_;
}
-Inset * InsetBibtex::clone() const
-{
- return new InsetBibtex(*this);
-}
-
-
void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
{
switch (cmd.action) {
+ case LFUN_INSET_EDIT:
+ editDatabases();
+ break;
+
case LFUN_INSET_MODIFY: {
InsetCommandParams p(BIBTEX_CODE);
try {
- if (!InsetCommandMailer::string2params("bibtex",
+ if (!InsetCommand::string2params("bibtex",
to_utf8(cmd.argument()), p)) {
cur.noUpdate();
break;
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);
- 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;
}
}
+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)
{
// use such filenames.)
// Otherwise, store the (maybe absolute) path to the original,
// unmangled database name.
- EmbeddedFileList const bibs = embeddedFiles();
- EmbeddedFileList::const_iterator it = bibs.begin();
- EmbeddedFileList::const_iterator it_end = bibs.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 =
from_utf8(database));
}
- if (it != bibs.begin())
+ if (didone)
dbs << ',';
+ else
+ didone = true;
// FIXME UNICODE
dbs << from_utf8(latex_path(database));
}
_("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;
style = split(style, bibtotoc, ',');
}
+
// line count
int nlines = 0;
// bibtotoc-Option
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().documentClass().name(), "art")) {
+ if (buffer().params().documentClass().hasLaTeXLayout("chapter")) {
if (buffer().params().sides == OneSide) {
// oneside
os << "\\clearpage";
// twoside
os << "\\cleardoublepage";
}
-
- // bookclass
os << "\\addcontentsline{toc}{chapter}{\\bibname}";
-
- } else {
- // article class
+ } else if (buffer().params().documentClass().hasLaTeXLayout("section"))
os << "\\addcontentsline{toc}{section}{\\refname}";
- }
}
if (!db_out.empty() && !buffer().params().use_bibtopic) {
}
-EmbeddedFileList InsetBibtex::embeddedFiles() const
+support::FileNameList InsetBibtex::getBibFiles() const
{
FileName path(buffer().filePath());
- PathChanger p(path);
-
- 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()) {
- 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());
+ 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 =
+ findtexfile(changeExtension(to_utf8(*it), "bib"), "bib");
+
+ if (!file.empty())
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, ',');
+ else
+ LYXERR0("Couldn't find " + to_utf8(*it) + " in InsetBibtex::getBibFiles()!");
}
-
+
return vec;
+
}
namespace {
// 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 += ' ';
void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
InsetIterator const & /*di*/) const
{
- EmbeddedFileList const files = embeddedFiles();
- for (vector<EmbeddedFile>::const_iterator it = files.begin();
- it != files.end(); ++ it) {
- // This bibtex parser is a first step to parse bibtex files
- // more precisely.
- //
- // - it reads the whole bibtex entry and does a syntax check
- // (matching delimiters, missing commas,...
- // - it recovers from errors starting with the next @-character
- // - it reads @string definitions and replaces them in the
- // field values.
- // - it accepts more characters in keys or value names than
- // bibtex does.
- //
- // Officially bibtex does only support ASCII, but in practice
- // you can use the encoding of the main document as long as
- // some elements like keys and names are pure ASCII. Therefore
- // we convert the file from the buffer encoding.
- // 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.
-
- idocfstream ifs(it->availableFile().toFilesystemEncoding().c_str(),
+ // This bibtex parser is a first step to parse bibtex files
+ // more precisely.
+ //
+ // - it reads the whole bibtex entry and does a syntax check
+ // (matching delimiters, missing commas,...
+ // - it recovers from errors starting with the next @-character
+ // - it reads @string definitions and replaces them in the
+ // field values.
+ // - it accepts more characters in keys or value names than
+ // bibtex does.
+ //
+ // Officially bibtex does only support ASCII, but in practice
+ // you can use the encoding of the main document as long as
+ // some elements like keys and names are pure ASCII. Therefore
+ // we convert the file from the buffer encoding.
+ // 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.
+ 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(),
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
}
+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,
+ // 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(string const & db)
+bool InsetBibtex::addDatabase(docstring const & db)
{
- // FIXME UNICODE
- string bibfiles(to_utf8(getParam("bibfiles")));
- if (tokenPos(bibfiles, ',', db) == -1) {
- if (!bibfiles.empty())
- bibfiles += ',';
- setParam("bibfiles", from_utf8(bibfiles + db));
- return true;
- }
- return false;
+ docstring bibfiles = getParam("bibfiles");
+ if (tokenPos(bibfiles, ',', db) != -1)
+ return false;
+ if (!bibfiles.empty())
+ bibfiles += ',';
+ setParam("bibfiles", bibfiles + db);
+ return true;
}
-bool InsetBibtex::delDatabase(string const & db)
+bool InsetBibtex::delDatabase(docstring const & db)
{
- // FIXME UNICODE
- string bibfiles(to_utf8(getParam("bibfiles")));
+ docstring bibfiles = getParam("bibfiles");
if (contains(bibfiles, db)) {
int const n = tokenPos(bibfiles, ',', db);
- string bd = db;
+ docstring bd = db;
if (n > 0) {
// this is not the first database
- string tmp = ',' + bd;
- setParam("bibfiles", from_utf8(subst(bibfiles, tmp, string())));
+ docstring tmp = ',' + bd;
+ setParam("bibfiles", subst(bibfiles, tmp, docstring()));
} else if (n == 0)
// this is the first (or only) database
- setParam("bibfiles", from_utf8(split(bibfiles, bd, ',')));
+ setParam("bibfiles", split(bibfiles, bd, ','));
else
return false;
}
}
-void InsetBibtex::registerEmbeddedFiles(EmbeddedFileList & files) const
+docstring InsetBibtex::contextMenu(BufferView const &, int, int) const
{
- EmbeddedFileList const dbs = embeddedFiles();
- for (vector<EmbeddedFile>::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);
+ return from_ascii("context-bibtex");
}
projects / lyx.git / blobdiff