* 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 "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 "FuncStatus.h"
#include "LaTeXFeatures.h"
+#include "output_xhtml.h"
#include "ParIterator.h"
+#include "texstream.h"
#include "TocBackend.h"
#include "support/debug.h"
#include "support/lstrings.h"
#include <algorithm>
+#include <climits>
using namespace std;
using namespace lyx::support;
namespace lyx {
-namespace {
+ParamInfo InsetCitation::param_info_;
+
-vector<string> const init_possible_cite_commands()
+InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p)
{
- char const * const possible[] = {
- "cite", "nocite", "citet", "citep", "citealt", "citealp",
- "citeauthor", "citeyear", "citeyearpar",
- "citet*", "citep*", "citealt*", "citealp*", "citeauthor*",
- "Citet", "Citep", "Citealt", "Citealp", "Citeauthor",
- "Citet*", "Citep*", "Citealt*", "Citealp*", "Citeauthor*",
- "fullcite",
- "footcite", "footcitet", "footcitep", "footcitealt",
- "footcitealp", "footciteauthor", "footciteyear", "footciteyearpar",
- "citefield", "citetitle", "cite*"
- };
- size_t const size_possible = sizeof(possible) / sizeof(possible[0]);
-
- return vector<string>(possible, possible + size_possible);
+ buffer().removeBiblioTempFiles();
}
-vector<string> const & possibleCiteCommands()
+InsetCitation::~InsetCitation()
{
- static vector<string> const possible = init_possible_cite_commands();
- return possible;
+ if (isBufferLoaded())
+ buffer().removeBiblioTempFiles();
}
-// FIXME See the header for the issue.
-string defaultCiteCommand(CiteEngine engine)
+ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
{
- 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;
+ // standard cite does only take one argument, but biblatex, jurabib
+ // and natbib extend 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 str;
+ return param_info_;
}
-
-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;
+// We allow any command here, since we fall back to cite
+// anyway if a command is not allowed by a style
+bool InsetCitation::isCompatibleCommand(string const &)
+{
+ return true;
+}
- // 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);
+CitationStyle InsetCitation::getCitationStyle(BufferParams const & bp, string const & input,
+ vector<CitationStyle> const & valid_styles) const
+{
+ CitationStyle cs = valid_styles[0];
+ cs.forceUpperCase = false;
+ cs.hasStarredVersion = false;
+
+ string normalized_input = input;
+ string::size_type const n = input.size() - 1;
+ if (isUpperCase(input[0]))
+ normalized_input[0] = lowercase(input[0]);
+ if (input[n] == '*')
+ normalized_input = normalized_input.substr(0, n);
+
+ string const alias = bp.getCiteAlias(normalized_input);
+ if (!alias.empty())
+ normalized_input = alias;
+
+ 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.name == normalized_input) {
+ cs = *it;
break;
}
}
- return output;
+ return cs;
}
-docstring complexLabel(Buffer const & buffer,
- string const & citeType, docstring const & keyList,
- docstring const & before, docstring const & after,
- CiteEngine engine)
+void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- // Only start the process off after the buffer is loaded from file.
- if (!buffer.isFullyLoaded())
- return docstring();
+ switch (cmd.action()) {
+ case LFUN_INSET_MODIFY: {
+ buffer().removeBiblioTempFiles();
+ cache.recalculate = true;
+ if (cmd.getArg(0) == "toggleparam") {
+ string cmdname = getCmdName();
+ string const alias =
+ buffer().masterParams().getCiteAlias(cmdname);
+ if (!alias.empty())
+ cmdname = alias;
+ string const par = cmd.getArg(1);
+ string newcmdname = cmdname;
+ if (par == "star") {
+ if (suffixIs(cmdname, "*"))
+ newcmdname = rtrim(cmdname, "*");
+ else
+ newcmdname = cmdname + "*";
+ } else if (par == "casing") {
+ if (isUpperCase(cmdname[0]))
+ newcmdname[0] = lowercase(cmdname[0]);
+ else
+ newcmdname[0] = uppercase(newcmdname[0]);
+ }
+ cmd = FuncRequest(LFUN_INSET_MODIFY, "changetype " + newcmdname);
+ }
+ }
+ default:
+ InsetCommand::doDispatch(cur, cmd);
+ }
+}
- 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;
+bool InsetCitation::getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & status) const
+{
+ switch (cmd.action()) {
+ // Handle the alias case
+ case LFUN_INSET_MODIFY:
+ if (cmd.getArg(0) == "changetype") {
+ string cmdname = getCmdName();
+ string const alias =
+ buffer().masterParams().getCiteAlias(cmdname);
+ if (!alias.empty())
+ cmdname = alias;
+ if (suffixIs(cmdname, "*"))
+ cmdname = rtrim(cmdname, "*");
+ string const newtype = cmd.getArg(1);
+ status.setEnabled(isCompatibleCommand(newtype));
+ status.setOnOff(newtype == cmdname);
+ }
+ if (cmd.getArg(0) == "toggleparam") {
+ string cmdname = getCmdName();
+ string const alias =
+ buffer().masterParams().getCiteAlias(cmdname);
+ if (!alias.empty())
+ cmdname = alias;
+ vector<CitationStyle> citation_styles =
+ buffer().masterParams().citeStyles();
+ CitationStyle cs = getCitationStyle(buffer().masterParams(),
+ cmdname, citation_styles);
+ if (cmd.getArg(1) == "star") {
+ status.setEnabled(cs.hasStarredVersion);
+ status.setOnOff(suffixIs(cmdname, "*"));
+ }
+ else if (cmd.getArg(1) == "casing") {
+ status.setEnabled(cs.forceUpperCase);
+ status.setOnOff(isUpperCase(cmdname[0]));
+ }
+ }
+ return true;
+ default:
+ return InsetCommand::getStatus(cur, cmd, status);
}
+}
- 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.
- char * sep; // punctuation mark separating citation entries.
- if (engine == ENGINE_BASIC) {
- op = '[';
- cp = ']';
- sep = ",";
- } else {
- op = '(';
- cp = ')';
- sep = ";";
+bool InsetCitation::addKey(string const & key)
+{
+ docstring const ukey = from_utf8(key);
+ docstring const & curkeys = getParam("key");
+ if (curkeys.empty()) {
+ setParam("key", ukey);
+ cache.recalculate = true;
+ return true;
}
- docstring const op_str = ' ' + docstring(1, op);
- docstring const cp_str = docstring(1, cp) + ' ';
- docstring const sep_str = from_ascii(sep) + ' ';
+ 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;
+}
- 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;
- }
+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();
- // 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;
- }
+ BiblioInfo const & bi = buf.masterBibInfo();
+ if (bi.empty())
+ return _("No bibliography defined!");
+
+ docstring const & key = getParam("key");
+ if (key.empty())
+ return _("No citations selected!");
+
+ CiteItem ci;
+ ci.richtext = true;
+ vector<docstring> keys = getVectorFromString(key);
+ if (keys.size() == 1)
+ return bi.getInfo(keys[0], buffer(), ci);
+
+ docstring tip;
+ tip += "<ol>";
+ int count = 0;
+ for (docstring const & key : keys) {
+ docstring const key_info = bi.getInfo(key, buffer(), ci);
+ // limit to reasonable size.
+ if (count > 9 && keys.size() > 11) {
+ tip.push_back(0x2026);// HORIZONTAL ELLIPSIS
+ tip += "<p>"
+ + bformat(_("+ %1$d more entries."), int(keys.size() - count))
+ + "</p>";
+ break;
+ }
+ if (key_info.empty())
+ continue;
+ tip += "<li>" + key_info + "</li>";
+ ++count;
+ }
+ tip += "</ol>";
+ return tip;
+}
- // (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;
+namespace {
- // 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;
+CitationStyle asValidLatexCommand(BufferParams const & bp, string const & input,
+ vector<CitationStyle> const & valid_styles)
+{
+ CitationStyle cs = valid_styles[0];
+ cs.forceUpperCase = false;
+ cs.hasStarredVersion = false;
+
+ string normalized_input = input;
+ string::size_type const n = input.size() - 1;
+ if (isUpperCase(input[0]))
+ normalized_input[0] = lowercase(input[0]);
+ if (input[n] == '*')
+ normalized_input = normalized_input.substr(0, n);
+
+ string const alias = bp.getCiteAlias(normalized_input);
+ if (!alias.empty())
+ normalized_input = alias;
+
+ 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.name == normalized_input) {
+ cs = *it;
+ break;
}
}
- if (!before_str.empty() && (cite_type == "citep" ||
- cite_type == "citealp" ||
- cite_type == "citeyearpar")) {
- label = before_str + label;
- }
+ cs.forceUpperCase &= input[0] == uppercase(input[0]);
+ cs.hasStarredVersion &= input[n] == '*';
- if (cite_type == "citep" || cite_type == "citeyearpar" ||
- (cite_type == "cite" && engine == ENGINE_BASIC) )
- label = op + label + cp;
+ return cs;
+}
- return label;
+
+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-" + html::cleanAttr(key) + "'>" +
+ html::htmlize(content, XHTMLStream::ESCAPE_ALL) + "</a>";
}
+} // anonymous namespace
-docstring basicLabel(docstring const & keyList, docstring const & after)
+docstring InsetCitation::generateLabel(bool for_xhtml) const
{
- docstring keys = keyList;
docstring label;
+ label = complexLabel(for_xhtml);
- 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 (!after.empty())
- label += ", " + after;
+ // Fallback to fail-safe
+ if (label.empty())
+ label = basicLabel(for_xhtml);
- return '[' + label + ']';
+ return label;
}
-} // anon namespace
+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();
-ParamInfo InsetCitation::param_info_;
+ BiblioInfo const & biblist = buf.masterBibInfo();
+ if (biblist.empty())
+ return docstring();
+ docstring const & key = getParam("key");
+ if (key.empty())
+ return _("No citations selected!");
-InsetCitation::InsetCitation(InsetCommandParams const & p)
- : InsetCommand(p, "citation")
-{}
+ string cite_type = getCmdName();
+ bool const uppercase = isUpperCase(cite_type[0]);
+ if (uppercase)
+ cite_type[0] = lowercase(cite_type[0]);
+ bool const starred = (cite_type[cite_type.size() - 1] == '*');
+ if (starred)
+ cite_type = cite_type.substr(0, cite_type.size() - 1);
+ // handle alias
+ string const alias = buf.masterParams().getCiteAlias(cite_type);
+ if (!alias.empty())
+ cite_type = alias;
-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);
+ // 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> keys = getVectorFromString(key);
+ CiteItem ci;
+ ci.textBefore = getParam("before");
+ ci.textAfter = getParam("after");
+ ci.forceUpperCase = uppercase;
+ ci.Starred = starred;
+ ci.max_size = UINT_MAX;
+ if (for_xhtml) {
+ ci.max_key_size = UINT_MAX;
+ ci.context = CiteItem::Export;
}
- 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;
+ ci.richtext = for_xhtml;
+ label = biblist.getLabel(keys, buffer(), cite_type, ci);
+ return label;
}
-docstring InsetCitation::generateLabel() const
+docstring InsetCitation::basicLabel(bool for_xhtml) const
{
- docstring const before = getParam("before");
- docstring const after = getParam("after");
-
+ docstring keys = getParam("key");
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 = basicLabel(getParam("key"), after);
+ 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;
+ return '[' + label + ']';
}
-
docstring InsetCitation::screenLabel() const
{
return cache.screen_label;
}
-void InsetCitation::updateLabels(ParIterator const &)
+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 += "...";
- }
-
- cache.engine = engine;
- cache.params = params();
+ cache.recalculate = false;
cache.generated_label = glabel;
- cache.screen_label = label;
+ unsigned int const maxLabelChars = 45;
+ cache.screen_label = glabel.substr(0, maxLabelChars + 1);
+ support::truncateWithEllipsis(cache.screen_label, maxLabelChars);
}
-void InsetCitation::addToToc(DocIterator const & cpit)
+void InsetCitation::addToToc(DocIterator const & cpit, bool output_active,
+ UpdateType, TocBackend & backend) const
{
- Toc & toc = buffer().tocBackend().toc("citation");
- toc.push_back(TocItem(cpit, 0, cache.screen_label));
+ // NOTE
+ // BiblioInfo::collectCitedEntries() uses the TOC to collect the citations
+ // from the document. It is used indirectly, via BiblioInfo::makeCitationLables,
+ // by both XHTML and plaintext output. So, if we change what goes into the TOC,
+ // then we will also need to change that routine.
+ docstring const tocitem = getParam("key");
+ TocBuilder & b = backend.builder("citation");
+ b.pushItem(cpit, tocitem, output_active);
+ b.pop();
}
-int InsetCitation::plaintext(odocstream & os, OutputParams const &) const
+int InsetCitation::plaintext(odocstringstream & os,
+ OutputParams const &, size_t) const
{
- os << cache.generated_label;
- return cache.generated_label.size();
+ string const & cmd = getCmdName();
+ if (cmd == "nocite")
+ return 0;
+
+ docstring const label = generateLabel(false);
+ os << label;
+ return label.size();
}
}
-void InsetCitation::textString(odocstream & os) const
+docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const
+{
+ string const & cmd = getCmdName();
+ if (cmd == "nocite")
+ return docstring();
+
+ // have to output this raw, because generateLabel() will include tags
+ xs << XHTMLStream::ESCAPE_NONE << generateLabel(true);
+
+ return docstring();
+}
+
+
+void InsetCitation::toString(odocstream & os) const
{
- plaintext(os, OutputParams(0));
+ odocstringstream ods;
+ plaintext(ods, OutputParams(0));
+ os << ods.str();
+}
+
+
+void InsetCitation::forOutliner(docstring & os, size_t const, bool const) 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 &) 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();
+ BiblioInfo const & bi = buffer().masterBibInfo();
+ if (getCmdName() == "keyonly") {
+ // Special command to only return the key
+ if (!bi.isBibtex(getParam("key")))
+ // escape chars with bibitems
+ os << escape(cleanupWhitespace(getParam("key")));
+ else
+ os << cleanupWhitespace(getParam("key"));
+ return;
+ }
+ vector<CitationStyle> citation_styles = buffer().masterParams().citeStyles();
+ CitationStyle cs = asValidLatexCommand(buffer().masterParams(),
+ getCmdName(), citation_styles);
// FIXME UNICODE
- docstring const cite_str = from_utf8(
- asValidLatexCommand(getCmdName(), cite_engine));
+ docstring const cite_str = from_utf8(citationStyleToString(cs, true));
+
+ if (runparams.inulemcmd > 0)
+ os << "\\mbox{";
os << "\\" << cite_str;
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")) << '}';
-
- return 0;
-}
-
+ if (!bi.isBibtex(getParam("key")))
+ // escape chars with bibitems
+ os << '{' << escape(cleanupWhitespace(getParam("key"))) << '}';
+ else
+ os << '{' << cleanupWhitespace(getParam("key")) << '}';
-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;
- }
+ if (runparams.inulemcmd)
+ os << "}";
}
-docstring InsetCitation::contextMenu(BufferView const &, int, int) const
+string InsetCitation::contextMenuName() const
{
- return from_ascii("context-citation");
+ return "context-citation";
}