#include "InsetCitation.h"
+#include "BiblioInfo.h"
#include "Buffer.h"
#include "buffer_funcs.h"
#include "BufferParams.h"
#include "BufferView.h"
#include "DispatchResult.h"
+#include "FuncCode.h"
#include "FuncRequest.h"
#include "LaTeXFeatures.h"
#include "output_xhtml.h"
namespace lyx {
+ParamInfo InsetCitation::param_info_;
+
+
+InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p)
+{
+ buffer().removeBiblioTempFiles();
+}
+
+
+InsetCitation::~InsetCitation()
+{
+ if (isBufferLoaded())
+ buffer().removeBiblioTempFiles();
+}
+
+
+ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
+{
+ // 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_;
+}
+
+
namespace {
vector<string> const init_possible_cite_commands()
}
-// FIXME See the header for the issue.
-string defaultCiteCommand(CiteEngine engine)
-{
- string str;
- switch (engine) {
- case ENGINE_BASIC:
- str = "cite";
- break;
- case ENGINE_NATBIB_AUTHORYEAR:
- str = "citet";
- break;
- case ENGINE_NATBIB_NUMERICAL:
- str = "citep";
- break;
- case ENGINE_JURABIB:
- str = "cite";
- break;
- }
- return str;
-}
-
-
-string asValidLatexCommand(string const & input, CiteEngine const engine)
-{
- string const default_str = defaultCiteCommand(engine);
- if (!InsetCitation::isCompatibleCommand(input))
- return default_str;
-
- string output;
- switch (engine) {
- case ENGINE_BASIC:
- if (input == "nocite")
- output = input;
- else
- output = default_str;
- break;
-
- 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);
- else
- output = input;
- break;
-
- 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);
-
- break;
- }
- }
-
- return output;
-}
+} // anon namespace
-docstring complexLabel(Buffer const & buffer,
- string const & citetype, docstring const & keylist,
- docstring const & before, docstring const & after,
- CiteEngine engine)
+// FIXME: use the citeCommands provided by the TextClass
+// instead of possibleCiteCommands defined in this file.
+bool InsetCitation::isCompatibleCommand(string const & cmd)
{
- // Only start the process off after the buffer is loaded from file.
- if (!buffer.isFullyLoaded())
- return docstring();
-
- BiblioInfo const & biblist = buffer.masterBibInfo();
- if (biblist.empty())
- return docstring();
-
- // the natbib citation-styles
- // CITET: author (year)
- // CITEP: (author,year)
- // CITEALT: author year
- // CITEALP: author, year
- // CITEAUTHOR: author
- // CITEYEAR: year
- // CITEYEARPAR: (year)
- // jurabib supports these plus
- // CITE: author/<before field>
-
- // We don't currently use the full or forceUCase fields.
- string cite_type = asValidLatexCommand(citetype, engine);
- if (cite_type[0] == 'C')
- // If we were going to use them, this would mean ForceUCase
- cite_type = string(1, 'c') + cite_type.substr(1);
- if (cite_type[cite_type.size() - 1] == '*')
- // and this would mean FULL
- cite_type = cite_type.substr(0, cite_type.size() - 1);
-
- docstring before_str;
- if (!before.empty()) {
- // In CITET and CITEALT mode, the "before" string is
- // attached to the label associated with each and every key.
- // In CITEP, CITEALP and CITEYEARPAR mode, it is attached
- // to the front of the whole only.
- // In other modes, it is not used at all.
- if (cite_type == "citet" ||
- cite_type == "citealt" ||
- cite_type == "citep" ||
- cite_type == "citealp" ||
- cite_type == "citeyearpar")
- before_str = before + ' ';
- // In CITE (jurabib), the "before" string is used to attach
- // the annotator (of legal texts) to the author(s) of the
- // first reference.
- else if (cite_type == "cite")
- before_str = '/' + before;
- }
-
- docstring after_str;
- // 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 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 label;
- vector<docstring> keys = getVectorFromString(keylist);
- vector<docstring>::const_iterator it = keys.begin();
- vector<docstring>::const_iterator end = keys.end();
- for (; it != end; ++it) {
- // get the bibdata corresponding to the key
- docstring const author = biblist.getAbbreviatedAuthor(*it);
- docstring const year = biblist.getYear(*it);
-
- // Something isn't right. Fail safely.
- if (author.empty() || year.empty())
- return docstring();
-
- // authors1/<before>; ... ;
- // authors_last, <after>
- 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 ENGINE_NATBIB_AUTHORYEAR:
- label += author + op_str + before_str +
- year + cp + sep_str;
- break;
- case ENGINE_NATBIB_NUMERICAL:
- label += author + op_str + before_str + '#' + *it + cp + sep_str;
- break;
- case ENGINE_JURABIB:
- label += before_str + author + op_str +
- year + cp + sep_str;
- break;
- case ENGINE_BASIC:
- break;
- }
-
- // author, year; author, year; ...
- } else if (cite_type == "citep" ||
- cite_type == "citealp") {
- if (engine == ENGINE_NATBIB_NUMERICAL) {
- label += *it + sep_str;
- } else {
- label += author + ", " + year + sep_str;
- }
-
- // (authors1 <before> year;
- // authors_last <before> year, <after>)
- } else if (cite_type == "citealt") {
- switch (engine) {
- case ENGINE_NATBIB_AUTHORYEAR:
- label += author + ' ' + before_str +
- year + sep_str;
- break;
- case ENGINE_NATBIB_NUMERICAL:
- label += author + ' ' + before_str + '#' + *it + sep_str;
- break;
- case ENGINE_JURABIB:
- label += before_str + author + ' ' +
- year + sep_str;
- break;
- case ENGINE_BASIC:
- break;
- }
-
- // author; author; ...
- } else if (cite_type == "citeauthor") {
- label += author + sep_str;
-
- // year; year; ...
- } else if (cite_type == "citeyear" ||
- cite_type == "citeyearpar") {
- label += year + sep_str;
- }
- }
- label = rtrim(rtrim(label), sep);
-
- if (!after_str.empty()) {
- if (cite_type == "citet") {
- // insert "after" before last ')'
- label.insert(label.size() - 1, after_str);
- } else {
- bool const add =
- !(engine == ENGINE_NATBIB_NUMERICAL &&
- (cite_type == "citeauthor" ||
- cite_type == "citeyear"));
- if (add)
- label += after_str;
- }
- }
-
- if (!before_str.empty() && (cite_type == "citep" ||
- cite_type == "citealp" ||
- cite_type == "citeyearpar")) {
- label = before_str + label;
- }
-
- if (cite_type == "citep" || cite_type == "citeyearpar" ||
- (cite_type == "cite" && engine == ENGINE_BASIC) )
- label = op + label + cp;
-
- return label;
+ vector<string> const & possibles = possibleCiteCommands();
+ vector<string>::const_iterator const end = possibles.end();
+ return find(possibles.begin(), end, cmd) != end;
}
-docstring basicLabel(docstring const & keyList, docstring const & after)
+void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- docstring keys = keyList;
- docstring label;
-
- if (contains(keys, ',')) {
- // Final comma allows while loop to cover all keys
- keys = ltrim(split(keys, label, ',')) + ',';
- while (contains(keys, ',')) {
- docstring key;
- keys = ltrim(split(keys, key, ','));
- label += ", " + key;
- }
- } else {
- label = keys;
+ if (cmd.action() == LFUN_INSET_MODIFY) {
+ buffer().removeBiblioTempFiles();
+ cache.recalculate = true;
}
-
- if (!after.empty())
- label += ", " + after;
-
- return '[' + label + ']';
+ InsetCommand::doDispatch(cur, cmd);
}
-} // anon namespace
-
-
-ParamInfo InsetCitation::param_info_;
-
-InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
- : InsetCommand(buf, p, "citation")
-{}
-
-
-ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
+bool InsetCitation::addKey(string const & key)
{
- // 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);
+ docstring const ukey = from_utf8(key);
+ docstring const & curkeys = getParam("key");
+ if (curkeys.empty()) {
+ setParam("key", ukey);
+ cache.recalculate = true;
+ return true;
}
- return param_info_;
-}
-
-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;
+ vector<docstring> keys = getVectorFromString(curkeys);
+ vector<docstring>::const_iterator it = keys.begin();
+ vector<docstring>::const_iterator en = keys.end();
+ for (; it != en; ++it) {
+ if (*it == ukey) {
+ LYXERR0("Key " << key << " already present.");
+ return false;
+ }
+ }
+ keys.push_back(ukey);
+ setParam("key", getStringFromVector(keys));
+ cache.recalculate = true;
+ return true;
}
vector<docstring>::const_iterator en = keys.end();
docstring tip;
for (; it != en; ++it) {
- docstring const key_info = bi.getInfo(*it);
+ docstring const key_info = bi.getInfo(*it, buffer());
if (key_info.empty())
continue;
if (!tip.empty())
}
+namespace {
+
-docstring InsetCitation::generateLabel() const
+CitationStyle asValidLatexCommand(string const & input, vector<CitationStyle> const valid_styles)
{
- docstring const & before = getParam("before");
- docstring const & after = getParam("after");
+ CitationStyle cs = valid_styles[0];
+ cs.forceUpperCase = false;
+ cs.fullAuthorList = false;
+ if (!InsetCitation::isCompatibleCommand(input))
+ return cs;
+
+ string normalized_input = input;
+ string::size_type const n = input.size() - 1;
+ if (input[0] == 'C')
+ normalized_input[0] = 'c';
+ if (input[n] == '*')
+ normalized_input = normalized_input.substr(0, n);
+ vector<CitationStyle>::const_iterator it = valid_styles.begin();
+ vector<CitationStyle>::const_iterator end = valid_styles.end();
+ for (; it != end; ++it) {
+ CitationStyle this_cs = *it;
+ if (this_cs.cmd == normalized_input) {
+ cs = *it;
+ break;
+ }
+ }
+
+ cs.forceUpperCase &= input[0] == 'C';
+ cs.fullAuthorList &= input[n] == '*';
+
+ return cs;
+}
+
+
+inline docstring wrapCitation(docstring const & key,
+ docstring const & content, bool for_xhtml)
+{
+ if (!for_xhtml)
+ return content;
+ // we have to do the escaping here, because we will ultimately
+ // write this as a raw string, so as not to escape the tags.
+ return "<a href='#LyXCite-" + key + "'>" +
+ html::htmlize(content, XHTMLStream::ESCAPE_ALL) + "</a>";
+}
+
+} // anonymous namespace
+
+docstring InsetCitation::generateLabel(bool for_xhtml) const
+{
docstring label;
- CiteEngine const engine = buffer().params().citeEngine();
- label = complexLabel(buffer(), getCmdName(), getParam("key"),
- before, after, engine);
+ label = complexLabel(for_xhtml);
// Fallback to fail-safe
if (label.empty())
- label = basicLabel(getParam("key"), after);
+ label = basicLabel(for_xhtml);
+
+ return label;
+}
+
+
+docstring InsetCitation::complexLabel(bool for_xhtml) const
+{
+ Buffer const & buf = buffer();
+ // Only start the process off after the buffer is loaded from file.
+ if (!buf.isFullyLoaded())
+ return docstring();
+
+ BiblioInfo const & biblist = buf.masterBibInfo();
+ if (biblist.empty())
+ return docstring();
+ docstring const & key = getParam("key");
+ if (key.empty())
+ return _("No citations selected!");
+
+ // We don't currently use the full or forceUCase fields.
+ string cite_type = getCmdName();
+ if (cite_type[0] == 'C')
+ // If we were going to use them, this would mean ForceUCase
+ cite_type = string(1, 'c') + cite_type.substr(1);
+ if (cite_type[cite_type.size() - 1] == '*')
+ // and this would mean FULL
+ cite_type = cite_type.substr(0, cite_type.size() - 1);
+
+ docstring const & before = getParam("before");
+ docstring const & after = getParam("after");
+
+ // FIXME: allow to add cite macros
+ /*
+ buffer().params().documentClass().addCiteMacro("!textbefore", to_utf8(before));
+ buffer().params().documentClass().addCiteMacro("!textafter", to_utf8(after));
+ */
+ docstring label;
+ vector<docstring> const keys = getVectorFromString(key);
+ label = biblist.getLabel(keys, buffer(), cite_type, for_xhtml, before, after);
return label;
}
+docstring InsetCitation::basicLabel(bool for_xhtml) const
+{
+ docstring keys = getParam("key");
+ docstring label;
+
+ docstring key;
+ do {
+ // if there is no comma, then everything goes into key
+ // and keys will be empty.
+ keys = trim(split(keys, key, ','));
+ key = trim(key);
+ if (!label.empty())
+ label += ", ";
+ label += wrapCitation(key, key, for_xhtml);
+ } while (!keys.empty());
+
+ docstring const & after = getParam("after");
+ if (!after.empty())
+ label += ", " + after;
+
+ return '[' + label + ']';
+}
+
docstring InsetCitation::screenLabel() const
{
return cache.screen_label;
}
-void InsetCitation::updateLabels(ParIterator const &, bool)
+void InsetCitation::updateBuffer(ParIterator const &, UpdateType)
{
- CiteEngine const engine = buffer().params().citeEngine();
- if (cache.params == params() && cache.engine == engine)
+ if (!cache.recalculate && buffer().citeLabelsValid())
return;
- // The label has changed, so we have to re-create it.
+ // The label may have changed, so we have to re-create it.
docstring const glabel = generateLabel();
unsigned int const maxLabelChars = 45;
docstring label = glabel;
if (label.size() > maxLabelChars) {
- label.erase(maxLabelChars-3);
+ label.erase(maxLabelChars - 3);
label += "...";
}
- cache.engine = engine;
- cache.params = params();
+ cache.recalculate = false;
cache.generated_label = glabel;
cache.screen_label = label;
}
-void InsetCitation::addToToc(DocIterator const & cpit)
+void InsetCitation::addToToc(DocIterator const & cpit) const
{
+ // NOTE
+ // XHTML output uses the TOC to collect the citations
+ // from the document. So if this gets changed, then we
+ // will need to change how the citations are collected.
+ docstring const tocitem = getParam("key");
Toc & toc = buffer().tocBackend().toc("citation");
- toc.push_back(TocItem(cpit, 0, getParam("key")));
+ toc.push_back(TocItem(cpit, 0, tocitem));
}
if (cmd == "nocite")
return docstring();
- BiblioInfo const & bi = buffer().masterBibInfo();
- docstring const & key_list = getParam("key");
- if (key_list.empty())
- return docstring();
+ // have to output this raw, because generateLabel() will include tags
+ xs << XHTMLStream::ESCAPE_NONE << generateLabel(true);
- // FIXME We should 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 citekey = bibinfo.citeKey();
- if (citekey.empty()) {
- citekey = bibinfo.label();
- if (citekey.empty())
- citekey = *it;
- }
- string const attr = "href='#" + to_utf8(*it) + "'";
- xs << StartTag("a", attr) << citekey << EndTag("a");
- }
-
- docstring const & after = getParam("after");
- if (!after.empty())
- xs << ", " << after;
- xs << "]";
return docstring();
}
-void InsetCitation::tocString(odocstream & os) const
+void InsetCitation::toString(odocstream & os) const
{
plaintext(os, OutputParams(0));
}
+void InsetCitation::forToc(docstring & os, size_t) const
+{
+ os += screenLabel();
+}
+
+
// Have to overwrite the default InsetCommand method in order to check that
// 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(odocstream & os, OutputParams const & runparams) const
+// should revert to the default citation command as provided by the citation
+// engine, e.g. \cite[]{} for the basic engine.
+void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
{
- CiteEngine cite_engine = buffer().params().citeEngine();
+ vector<CitationStyle> citation_styles = buffer().params().citeStyles();
+ CitationStyle cs = asValidLatexCommand(getCmdName(), citation_styles);
+ BiblioInfo const & bi = buffer().masterBibInfo();
// FIXME UNICODE
- docstring const cite_str = from_utf8(
- asValidLatexCommand(getCmdName(), cite_engine));
+ docstring const cite_str = from_utf8(citationStyleToString(cs));
if (runparams.inulemcmd)
os << "\\mbox{";
docstring const & before = getParam("before");
docstring const & after = getParam("after");
- if (!before.empty() && cite_engine != ENGINE_BASIC)
+ if (!before.empty() && cs.textBefore)
os << '[' << before << "][" << after << ']';
- else if (!after.empty())
+ else if (!after.empty() && cs.textAfter)
os << '[' << after << ']';
- os << '{' << cleanupWhitespace(getParam("key")) << '}';
+ if (!bi.isBibtex(getParam("key")))
+ // escape chars with bibitems
+ os << '{' << escape(cleanupWhitespace(getParam("key"))) << '}';
+ else
+ os << '{' << cleanupWhitespace(getParam("key")) << '}';
if (runparams.inulemcmd)
os << "}";
-
- return 0;
-}
-
-
-void InsetCitation::validate(LaTeXFeatures & features) const
-{
- switch (features.bufferParams().citeEngine()) {
- case ENGINE_BASIC:
- break;
- case ENGINE_NATBIB_AUTHORYEAR:
- case ENGINE_NATBIB_NUMERICAL:
- features.require("natbib");
- break;
- case ENGINE_JURABIB:
- features.require("jurabib");
- break;
- }
}
-docstring InsetCitation::contextMenu(BufferView const &, int, int) const
+string InsetCitation::contextMenuName() const
{
- return from_ascii("context-citation");
+ return "context-citation";
}