* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
- * \author Herbert Voß
+ * \author Herbert Voß
*
* Full author contact details are available in file CREDITS.
*/
#include "InsetCitation.h"
-#include "Biblio.h"
#include "Buffer.h"
+#include "buffer_funcs.h"
#include "BufferParams.h"
-#include "debug.h"
+#include "BufferView.h"
#include "DispatchResult.h"
#include "FuncRequest.h"
#include "LaTeXFeatures.h"
-
-#include "frontends/controllers/frontend_helpers.h"
-
-#include "support/fs_extras.h"
+#include "output_xhtml.h"
+#include "ParIterator.h"
+#include "TocBackend.h"
+
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/FileNameList.h"
+#include "support/gettext.h"
#include "support/lstrings.h"
#include <algorithm>
-#include <boost/filesystem/operations.hpp>
-#include <boost/filesystem/exception.hpp>
-
+using namespace std;
+using namespace lyx::support;
namespace lyx {
-using support::ascii_lowercase;
-using support::contains;
-using support::FileName;
-using support::getStringFromVector;
-using support::getVectorFromString;
-using support::ltrim;
-using support::prefixIs;
-using support::rtrim;
-using support::split;
-using support::tokenPos;
-
-using std::endl;
-using std::replace;
-using std::string;
-using std::ostream;
-using std::vector;
-using std::map;
-
-namespace fs = boost::filesystem;
-
-
namespace {
vector<string> const init_possible_cite_commands()
{
- char const * const pos[] = {
- "cite", "citet", "citep", "citealt", "citealp",
+ char const * const possible[] = {
+ "cite", "nocite", "citet", "citep", "citealt", "citealp",
"citeauthor", "citeyear", "citeyearpar",
"citet*", "citep*", "citealt*", "citealp*", "citeauthor*",
"Citet", "Citep", "Citealt", "Citealp", "Citeauthor",
"footcitealp", "footciteauthor", "footciteyear", "footciteyearpar",
"citefield", "citetitle", "cite*"
};
- size_t const size_pos = sizeof(pos) / sizeof(pos[0]);
+ size_t const size_possible = sizeof(possible) / sizeof(possible[0]);
- return vector<string>(pos, pos + size_pos);
+ return vector<string>(possible, possible + size_possible);
}
-vector<string> const & possible_cite_commands()
+vector<string> const & possibleCiteCommands()
{
- static vector<string> const pos = init_possible_cite_commands();
- return pos;
+ static vector<string> const possible = init_possible_cite_commands();
+ return possible;
}
-bool is_possible_cite_command(string const & input)
-{
- vector<string> const & possibles = possible_cite_commands();
- vector<string>::const_iterator const end = possibles.end();
- return std::find(possibles.begin(), end, input) != end;
-}
-
-
-string const default_cite_command(biblio::CiteEngine engine)
+// FIXME See the header for the issue.
+string defaultCiteCommand(CiteEngine engine)
{
string str;
switch (engine) {
- case biblio::ENGINE_BASIC:
+ case ENGINE_BASIC:
str = "cite";
break;
- case biblio::ENGINE_NATBIB_AUTHORYEAR:
+ case ENGINE_NATBIB_AUTHORYEAR:
str = "citet";
break;
- case biblio::ENGINE_NATBIB_NUMERICAL:
+ case ENGINE_NATBIB_NUMERICAL:
str = "citep";
break;
- case biblio::ENGINE_JURABIB:
+ case ENGINE_JURABIB:
str = "cite";
break;
}
return str;
}
-
-string const
- asValidLatexCommand(string const & input, biblio::CiteEngine const engine)
+
+string asValidLatexCommand(string const & input, CiteEngine const engine)
{
- string const default_str = default_cite_command(engine);
- if (!is_possible_cite_command(input))
+ string const default_str = defaultCiteCommand(engine);
+ if (!InsetCitation::isCompatibleCommand(input))
return default_str;
string output;
switch (engine) {
- case biblio::ENGINE_BASIC:
- output = default_str;
+ case ENGINE_BASIC:
+ if (input == "nocite")
+ output = input;
+ else
+ output = default_str;
break;
- case biblio::ENGINE_NATBIB_AUTHORYEAR:
- case biblio::ENGINE_NATBIB_NUMERICAL:
- if (input == "cite" || input == "citefield" ||
- input == "citetitle" || input == "cite*")
+ case ENGINE_NATBIB_AUTHORYEAR:
+ case ENGINE_NATBIB_NUMERICAL:
+ if (input == "cite" || input == "citefield"
+ || input == "citetitle" || input == "cite*")
output = default_str;
else if (prefixIs(input, "foot"))
output = input.substr(4);
output = input;
break;
- case biblio::ENGINE_JURABIB: {
- // Jurabib does not support the 'uppercase' natbib style.
- if (input[0] == 'C')
- output = string(1, 'c') + input.substr(1);
- else
- output = input;
+ case ENGINE_JURABIB: {
+ // Jurabib does not support the 'uppercase' natbib style.
+ if (input[0] == 'C')
+ output = string(1, 'c') + input.substr(1);
+ else
+ output = input;
- // Jurabib does not support the 'full' natbib style.
- string::size_type const n = output.size() - 1;
- if (output != "cite*" && output[n] == '*')
- output = output.substr(0, n);
+ // Jurabib does not support the 'full' natbib style.
+ string::size_type const n = output.size() - 1;
+ if (output != "cite*" && output[n] == '*')
+ output = output.substr(0, n);
- break;
- }
+ break;
+ }
}
return output;
}
-docstring const getNatbibLabel(Buffer const & buffer,
+docstring complexLabel(Buffer const & buffer,
string const & citeType, docstring const & keyList,
docstring const & before, docstring const & after,
- biblio::CiteEngine engine)
+ CiteEngine engine)
{
// Only start the process off after the buffer is loaded from file.
- if (!buffer.fully_loaded())
+ if (!buffer.isFullyLoaded())
return docstring();
- // Cache the labels
- typedef std::map<Buffer const *, BiblioInfo> CachedMap;
- static CachedMap cached_keys;
-
- // and cache the timestamp of the bibliography files.
- static std::map<FileName, time_t> bibfileStatus;
-
- BiblioInfo biblist;
-
- vector<FileName> const & bibfilesCache = buffer.getBibfilesCache();
- // compare the cached timestamps with the actual ones.
- bool changed = false;
- for (vector<FileName>::const_iterator it = bibfilesCache.begin();
- it != bibfilesCache.end(); ++ it) {
- FileName const f = *it;
- try {
- std::time_t lastw = fs::last_write_time(f.toFilesystemEncoding());
- if (lastw != bibfileStatus[f]) {
- changed = true;
- bibfileStatus[f] = lastw;
- }
- }
- catch (fs::filesystem_error & fserr) {
- changed = true;
- lyxerr << "Couldn't find or read bibtex file "
- << f << endl;
- LYXERR(Debug::DEBUG) << "Fs error: "
- << fserr.what() << endl;
- }
- }
-
- // build the list only if the bibfiles have been changed
- if (cached_keys[&buffer].empty() || bibfileStatus.empty() || changed) {
- biblist.fillWithBibKeys(&buffer);
- cached_keys[&buffer] = biblist;
- } else
- // use the cached keys
- biblist = cached_keys[&buffer];
-
+ BiblioInfo const & biblist = buffer.masterBibInfo();
if (biblist.empty())
return docstring();
}
docstring after_str;
- if (!after.empty()) {
- // The "after" key is appended only to the end of the whole.
+ // The "after" key is appended only to the end of the whole.
+ if (cite_type == "nocite")
+ after_str = " (" + _("not cited") + ')';
+ else if (!after.empty()) {
after_str = ", " + after;
}
// One day, these might be tunable (as they are in BibTeX).
- char const op = '('; // opening parenthesis.
- char const cp = ')'; // closing parenthesis.
- // puctuation mark separating citation entries.
- char const * const sep = ";";
+ char op, cp; // opening and closing parenthesis.
+ const char * sep; // punctuation mark separating citation entries.
+ if (engine == ENGINE_BASIC) {
+ op = '[';
+ cp = ']';
+ sep = ",";
+ } else {
+ op = '(';
+ cp = ')';
+ sep = ";";
+ }
- docstring const op_str(' ' + docstring(1, op));
- docstring const cp_str(docstring(1, cp) + ' ');
- docstring const sep_str(from_ascii(sep) + ' ');
+ docstring const op_str = ' ' + docstring(1, op);
+ docstring const cp_str = docstring(1, cp) + ' ';
+ docstring const sep_str = from_ascii(sep) + ' ';
docstring label;
vector<docstring> keys = getVectorFromString(keyList);
// authors1/<before>; ... ;
// authors_last, <after>
- if (cite_type == "cite" && engine == biblio::ENGINE_JURABIB) {
- if (it == keys.begin())
- label += author + before_str + sep_str;
- else
- label += author + sep_str;
+ if (cite_type == "cite") {
+ if (engine == ENGINE_BASIC) {
+ label += *it + sep_str;
+ } else if (engine == ENGINE_JURABIB) {
+ if (it == keys.begin())
+ label += author + before_str + sep_str;
+ else
+ label += author + sep_str;
+ }
+
+ // nocite
+ } else if (cite_type == "nocite") {
+ label += *it + sep_str;
// (authors1 (<before> year); ... ;
// authors_last (<before> year, <after>)
} else if (cite_type == "citet") {
switch (engine) {
- case biblio::ENGINE_NATBIB_AUTHORYEAR:
+ case ENGINE_NATBIB_AUTHORYEAR:
label += author + op_str + before_str +
year + cp + sep_str;
break;
- case biblio::ENGINE_NATBIB_NUMERICAL:
+ case ENGINE_NATBIB_NUMERICAL:
label += author + op_str + before_str + '#' + *it + cp + sep_str;
break;
- case biblio::ENGINE_JURABIB:
+ case ENGINE_JURABIB:
label += before_str + author + op_str +
year + cp + sep_str;
break;
- case biblio::ENGINE_BASIC:
+ case ENGINE_BASIC:
break;
}
// author, year; author, year; ...
} else if (cite_type == "citep" ||
cite_type == "citealp") {
- if (engine == biblio::ENGINE_NATBIB_NUMERICAL) {
+ if (engine == ENGINE_NATBIB_NUMERICAL) {
label += *it + sep_str;
} else {
label += author + ", " + year + sep_str;
// authors_last <before> year, <after>)
} else if (cite_type == "citealt") {
switch (engine) {
- case biblio::ENGINE_NATBIB_AUTHORYEAR:
+ case ENGINE_NATBIB_AUTHORYEAR:
label += author + ' ' + before_str +
year + sep_str;
break;
- case biblio::ENGINE_NATBIB_NUMERICAL:
+ case ENGINE_NATBIB_NUMERICAL:
label += author + ' ' + before_str + '#' + *it + sep_str;
break;
- case biblio::ENGINE_JURABIB:
+ case ENGINE_JURABIB:
label += before_str + author + ' ' +
year + sep_str;
break;
- case biblio::ENGINE_BASIC:
+ case ENGINE_BASIC:
break;
}
label.insert(label.size() - 1, after_str);
} else {
bool const add =
- !(engine == biblio::ENGINE_NATBIB_NUMERICAL &&
+ !(engine == ENGINE_NATBIB_NUMERICAL &&
(cite_type == "citeauthor" ||
cite_type == "citeyear"));
if (add)
label = before_str + label;
}
- if (cite_type == "citep" || cite_type == "citeyearpar")
+ if (cite_type == "citep" || cite_type == "citeyearpar" ||
+ (cite_type == "cite" && engine == ENGINE_BASIC) )
label = op + label + cp;
return label;
}
-docstring const getBasicLabel(docstring const & keyList, docstring const & after)
+docstring basicLabel(docstring const & keyList, docstring const & after)
{
- docstring keys(keyList);
+ docstring keys = keyList;
docstring label;
if (contains(keys, ',')) {
keys = ltrim(split(keys, key, ','));
label += ", " + key;
}
- } else
+ } else {
label = keys;
+ }
if (!after.empty())
label += ", " + after;
} // anon namespace
-InsetCitation::InsetCitation(InsetCommandParams const & p)
- : InsetCommand(p, "citation")
+ParamInfo InsetCitation::param_info_;
+
+
+InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p, "citation")
{}
-docstring const InsetCitation::generateLabel(Buffer const & buffer) const
+ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
{
- docstring const before = getParam("before");
- docstring const after = getParam("after");
+ // standard cite does only take one argument if jurabib is
+ // not used, but jurabib extends this to two arguments, so
+ // we have to allow both here. InsetCitation takes care that
+ // LaTeX output is nevertheless correct.
+ if (param_info_.empty()) {
+ param_info_.add("after", ParamInfo::LATEX_OPTIONAL);
+ param_info_.add("before", ParamInfo::LATEX_OPTIONAL);
+ param_info_.add("key", ParamInfo::LATEX_REQUIRED);
+ }
+ return param_info_;
+}
- docstring label;
- biblio::CiteEngine const engine = buffer.params().getEngine();
- if (engine != biblio::ENGINE_BASIC) {
- label = getNatbibLabel(buffer, getCmdName(), getParam("key"),
- before, after, engine);
+
+bool InsetCitation::isCompatibleCommand(string const & cmd)
+{
+ vector<string> const & possibles = possibleCiteCommands();
+ vector<string>::const_iterator const end = possibles.end();
+ return find(possibles.begin(), end, cmd) != end;
+}
+
+
+docstring InsetCitation::toolTip(BufferView const & bv, int, int) const
+{
+ Buffer const & buf = bv.buffer();
+ // Only after the buffer is loaded from file...
+ if (!buf.isFullyLoaded())
+ return docstring();
+
+ BiblioInfo const & bi = buf.masterBibInfo();
+ if (bi.empty())
+ return _("No bibliography defined!");
+
+ docstring const & key = getParam("key");
+ if (key.empty())
+ return _("No citations selected!");
+
+ vector<docstring> keys = getVectorFromString(key);
+ vector<docstring>::const_iterator it = keys.begin();
+ vector<docstring>::const_iterator en = keys.end();
+ docstring tip;
+ for (; it != en; ++it) {
+ docstring const key_info = bi.getInfo(*it);
+ if (key_info.empty())
+ continue;
+ if (!tip.empty())
+ tip += "\n";
+ tip += wrap(key_info, -4);
}
+ return tip;
+}
+
+
+
+docstring InsetCitation::generateLabel() const
+{
+ docstring const & before = getParam("before");
+ docstring const & after = getParam("after");
+
+ docstring label;
+ CiteEngine const engine = buffer().params().citeEngine();
+ label = complexLabel(buffer(), getCmdName(), getParam("key"),
+ before, after, engine);
// Fallback to fail-safe
- if (label.empty()) {
- label = getBasicLabel(getParam("key"), after);
- }
+ if (label.empty())
+ label = basicLabel(getParam("key"), after);
return label;
}
-docstring const InsetCitation::getScreenLabel(Buffer const & buffer) const
+docstring InsetCitation::screenLabel() const
+{
+ return cache.screen_label;
+}
+
+
+void InsetCitation::updateLabels(ParIterator const &)
{
- biblio::CiteEngine const engine = buffer.params().getEngine();
+ CiteEngine const engine = buffer().params().citeEngine();
if (cache.params == params() && cache.engine == engine)
- return cache.screen_label;
+ return;
// The label has changed, so we have to re-create it.
- docstring const glabel = generateLabel(buffer);
+ docstring const glabel = generateLabel();
unsigned int const maxLabelChars = 45;
cache.params = params();
cache.generated_label = glabel;
cache.screen_label = label;
-
- return label;
}
-int InsetCitation::plaintext(Buffer const & buffer, odocstream & os,
- OutputParams const &) const
+void InsetCitation::addToToc(DocIterator const & cpit)
{
- docstring str;
+ Toc & toc = buffer().tocBackend().toc("citation");
+ toc.push_back(TocItem(cpit, 0, getParam("key")));
+}
- if (cache.params == params() &&
- cache.engine == buffer.params().getEngine())
- str = cache.generated_label;
- else
- str = generateLabel(buffer);
- os << str;
- return str.size();
+int InsetCitation::plaintext(odocstream & os, OutputParams const &) const
+{
+ os << cache.generated_label;
+ return cache.generated_label.size();
}
-namespace {
-
-docstring const cleanupWhitespace(docstring const & citelist)
+static docstring const cleanupWhitespace(docstring const & citelist)
{
docstring::const_iterator it = citelist.begin();
docstring::const_iterator end = citelist.end();
return result;
}
-// end anon namyspace
-}
-int InsetCitation::docbook(Buffer const &, odocstream & os,
- OutputParams const &) const
+int InsetCitation::docbook(odocstream & os, OutputParams const &) const
{
- os << "<citation>"
+ os << from_ascii("<citation>")
<< cleanupWhitespace(getParam("key"))
- << "</citation>";
+ << from_ascii("</citation>");
return 0;
}
-int InsetCitation::textString(Buffer const & buf, odocstream & os,
- OutputParams const & op) const
+docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const
{
- return plaintext(buf, os, op);
+ BiblioInfo const & bi = buffer().masterBibInfo();
+ docstring const & key_list = getParam("key");
+ if (key_list.empty())
+ return docstring();
+
+ // FIXME We shuld do a better job outputing different things for the
+ // different citation styles. For now, we use square brackets for every
+ // case.
+ xs << "[";
+ docstring const & before = getParam("before");
+ if (!before.empty())
+ xs << before << " ";
+
+ vector<docstring> const keys = getVectorFromString(key_list);
+ vector<docstring>::const_iterator it = keys.begin();
+ vector<docstring>::const_iterator const en = keys.end();
+ bool first = true;
+ for (; it != en; ++it) {
+ BiblioInfo::const_iterator const bt = bi.find(*it);
+ if (bt == bi.end())
+ continue;
+ BibTeXInfo const & bibinfo = bt->second;
+ if (!first) {
+ xs << ", ";
+ first = false;
+ }
+ docstring const & label = bibinfo.label();
+ docstring const & target = label.empty() ? *it : label;
+ string const attr = "href='#" + to_utf8(*it) + "'";
+ xs << StartTag("a", attr) << target << EndTag("a");
+ }
+
+ docstring const & after = getParam("after");
+ if (!after.empty())
+ xs << ", " << after;
+ xs << "]";
+ return docstring();
+}
+
+
+void InsetCitation::tocString(odocstream & os) const
+{
+ plaintext(os, OutputParams(0));
}
// the \cite command is valid. Eg, the user has natbib enabled, inputs some
// citations and then changes his mind, turning natbib support off. The output
// should revert to \cite[]{}
-int InsetCitation::latex(Buffer const & buffer, odocstream & os,
- OutputParams const &) const
+int InsetCitation::latex(odocstream & os, OutputParams const & runparams) const
{
- biblio::CiteEngine cite_engine = buffer.params().getEngine();
+ CiteEngine cite_engine = buffer().params().citeEngine();
// FIXME UNICODE
docstring const cite_str = from_utf8(
asValidLatexCommand(getCmdName(), cite_engine));
+ if (runparams.inulemcmd)
+ os << "\\mbox{";
+
os << "\\" << cite_str;
docstring const & before = getParam("before");
docstring const & after = getParam("after");
- if (!before.empty() && cite_engine != biblio::ENGINE_BASIC)
+ if (!before.empty() && cite_engine != ENGINE_BASIC)
os << '[' << before << "][" << after << ']';
else if (!after.empty())
os << '[' << after << ']';
os << '{' << cleanupWhitespace(getParam("key")) << '}';
+ if (runparams.inulemcmd)
+ os << "}";
+
return 0;
}
void InsetCitation::validate(LaTeXFeatures & features) const
{
- switch (features.bufferParams().getEngine()) {
- case biblio::ENGINE_BASIC:
+ switch (features.bufferParams().citeEngine()) {
+ case ENGINE_BASIC:
break;
- case biblio::ENGINE_NATBIB_AUTHORYEAR:
- case biblio::ENGINE_NATBIB_NUMERICAL:
+ case ENGINE_NATBIB_AUTHORYEAR:
+ case ENGINE_NATBIB_NUMERICAL:
features.require("natbib");
break;
- case biblio::ENGINE_JURABIB:
+ case ENGINE_JURABIB:
features.require("jurabib");
break;
}
}
-void InsetCitation::replaceContents(string const & from, string const & to)
+docstring InsetCitation::contextMenu(BufferView const &, int, int) const
{
- if (tokenPos(getContents(), ',', from) != -1) {
- vector<string> items = getVectorFromString(getContents());
- replace(items.begin(), items.end(), from, to);
- setContents(getStringFromVector(items));
- }
+ return from_ascii("context-citation");
}
projects / lyx.git / blobdiff