X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCitation.cpp;h=0a5da5b1192f63a04d4210e7f1489e64e35c461c;hb=3391fed36a574fb729f243888258d1b6d45b0251;hp=b1e48a672c5e2603fecf9f4a7e27a7b2d9cb3275;hpb=9f62413b103b74dbbd223388101b537a4988cae2;p=features.git diff --git a/src/insets/InsetCitation.cpp b/src/insets/InsetCitation.cpp index b1e48a672c..0a5da5b119 100644 --- a/src/insets/InsetCitation.cpp +++ b/src/insets/InsetCitation.cpp @@ -21,9 +21,11 @@ #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" @@ -33,6 +35,7 @@ #include "support/lstrings.h" #include +#include using namespace std; using namespace lyx::support; @@ -58,8 +61,8 @@ InsetCitation::~InsetCitation() 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 + // 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()) { @@ -71,54 +74,121 @@ ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */) } -namespace { - -vector const init_possible_cite_commands() +// 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 &) { - 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(possible, possible + size_possible); + return true; } -vector const & possibleCiteCommands() +CitationStyle InsetCitation::getCitationStyle(BufferParams const & bp, string const & input, + vector const & valid_styles) const { - static vector const possible = init_possible_cite_commands(); - return possible; -} + 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); -} // anon namespace + string const alias = bp.getCiteAlias(normalized_input); + if (!alias.empty()) + normalized_input = alias; + vector::const_iterator it = valid_styles.begin(); + vector::const_iterator end = valid_styles.end(); + for (; it != end; ++it) { + CitationStyle this_cs = *it; + if (this_cs.name == normalized_input) { + cs = *it; + break; + } + } -// FIXME: use the citeCommands provided by the TextClass -// instead of possibleCiteCommands defined in this file. -bool InsetCitation::isCompatibleCommand(string const & cmd) -{ - vector const & possibles = possibleCiteCommands(); - vector::const_iterator const end = possibles.end(); - return find(possibles.begin(), end, cmd) != end; + return cs; } void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd) { - if (cmd.action() == LFUN_INSET_MODIFY) { + 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); + } +} + + +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 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); } - InsetCommand::doDispatch(cur, cmd); } @@ -163,52 +233,67 @@ docstring InsetCitation::toolTip(BufferView const & bv, int, int) const if (key.empty()) return _("No citations selected!"); + CiteItem ci; + ci.richtext = true; vector keys = getVectorFromString(key); - vector::const_iterator it = keys.begin(); - vector::const_iterator en = keys.end(); + if (keys.size() == 1) + return bi.getInfo(keys[0], buffer(), ci); + docstring tip; - for (; it != en; ++it) { - docstring const key_info = bi.getInfo(*it, buffer()); + tip += "
    "; + 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 += "

    " + + bformat(_("+ %1$d more entries."), int(keys.size() - count)) + + "

    "; + break; + } if (key_info.empty()) continue; - if (!tip.empty()) - tip += "\n"; - tip += wrap(key_info, -4); + tip += "
  1. " + key_info + "
    2. "; + ++count; } + tip += "
"; return tip; } namespace { - -CitationStyle asValidLatexCommand(string const & input, vector const valid_styles) +CitationStyle asValidLatexCommand(BufferParams const & bp, string const & input, + vector const & valid_styles) { CitationStyle cs = valid_styles[0]; cs.forceUpperCase = false; - cs.fullAuthorList = false; - if (!InsetCitation::isCompatibleCommand(input)) - return cs; + cs.hasStarredVersion = false; string normalized_input = input; string::size_type const n = input.size() - 1; - if (input[0] == 'C') - normalized_input[0] = 'c'; + 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::const_iterator it = valid_styles.begin(); vector::const_iterator end = valid_styles.end(); for (; it != end; ++it) { CitationStyle this_cs = *it; - if (this_cs.cmd == normalized_input) { + if (this_cs.name == normalized_input) { cs = *it; break; } } - cs.forceUpperCase &= input[0] == 'C'; - cs.fullAuthorList &= input[n] == '*'; + cs.forceUpperCase &= input[0] == uppercase(input[0]); + cs.hasStarredVersion &= input[n] == '*'; return cs; } @@ -221,7 +306,7 @@ inline docstring wrapCitation(docstring const & key, 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 "" + + return "" + html::htmlize(content, XHTMLStream::ESCAPE_ALL) + ""; } @@ -255,17 +340,18 @@ docstring InsetCitation::complexLabel(bool for_xhtml) const 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 + 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); - docstring const & before = getParam("before"); - docstring const & after = getParam("after"); + // handle alias + string const alias = buf.masterParams().getCiteAlias(cite_type); + if (!alias.empty()) + cite_type = alias; // FIXME: allow to add cite macros /* @@ -273,8 +359,19 @@ docstring InsetCitation::complexLabel(bool for_xhtml) const buffer().params().documentClass().addCiteMacro("!textafter", to_utf8(after)); */ docstring label; - vector const keys = getVectorFromString(key); - label = biblist.getLabel(keys, buffer(), cite_type, for_xhtml, before, after); + vector 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; + } + ci.richtext = for_xhtml; + label = biblist.getLabel(keys, buffer(), cite_type, ci); return label; } @@ -312,40 +409,41 @@ void InsetCitation::updateBuffer(ParIterator const &, UpdateType) { if (!cache.recalculate && buffer().citeLabelsValid()) return; - // 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.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) const +void InsetCitation::addToToc(DocIterator const & cpit, bool output_active, + UpdateType, TocBackend & backend) 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. + // 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"); - Toc & toc = buffer().tocBackend().toc("citation"); - toc.push_back(TocItem(cpit, 0, tocitem)); + 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(); } @@ -391,11 +489,13 @@ docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const void InsetCitation::toString(odocstream & os) const { - plaintext(os, OutputParams(0)); + odocstringstream ods; + plaintext(ods, OutputParams(0)); + os << ods.str(); } -void InsetCitation::forToc(docstring & os, size_t) const +void InsetCitation::forOutliner(docstring & os, size_t const, bool const) const { os += screenLabel(); } @@ -408,13 +508,23 @@ void InsetCitation::forToc(docstring & os, size_t) const // engine, e.g. \cite[]{} for the basic engine. void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const { - vector citation_styles = buffer().params().citeStyles(); - CitationStyle cs = asValidLatexCommand(getCmdName(), citation_styles); 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 citation_styles = buffer().masterParams().citeStyles(); + CitationStyle cs = asValidLatexCommand(buffer().masterParams(), + getCmdName(), citation_styles); // FIXME UNICODE - docstring const cite_str = from_utf8(citationStyleToString(cs)); + docstring const cite_str = from_utf8(citationStyleToString(cs, true)); - if (runparams.inulemcmd) + if (runparams.inulemcmd > 0) os << "\\mbox{"; os << "\\" << cite_str;