]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCitation.cpp
Properly terminate command
[lyx.git] / src / insets / InsetCitation.cpp
index 0a5da5b1192f63a04d4210e7f1489e64e35c461c..564ea5bb9a5e75b1b72516c4a2aa22bd2a8b5916 100644 (file)
@@ -42,9 +42,6 @@ using namespace lyx::support;
 
 namespace lyx {
 
-ParamInfo InsetCitation::param_info_;
-
-
 InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
        : InsetCommand(buf, p)
 {
@@ -55,20 +52,38 @@ InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
 InsetCitation::~InsetCitation()
 {
        if (isBufferLoaded())
-               buffer().removeBiblioTempFiles();
+               /* We do not use buffer() because Coverity believes that this
+                * may throw an exception. Actually this code path is not
+                * taken when buffer_ == 0 */
+               buffer_->removeBiblioTempFiles();
 }
 
 
+// May well be over-ridden when session settings are loaded
+// in GuiCitation. Unfortunately, that will not happen until
+// such a dialog is created.
+bool InsetCitation::last_literal = true;
+
+
 ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
 {
+       static ParamInfo param_info_;
+
        // 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("after", ParamInfo::LATEX_OPTIONAL,
+                               ParamInfo::HANDLING_LATEXIFY);
+               param_info_.add("before", ParamInfo::LATEX_OPTIONAL,
+                               ParamInfo::HANDLING_LATEXIFY);
                param_info_.add("key", ParamInfo::LATEX_REQUIRED);
+               param_info_.add("pretextlist", ParamInfo::LATEX_OPTIONAL,
+                               ParamInfo::HANDLING_LATEXIFY);
+               param_info_.add("posttextlist", ParamInfo::LATEX_OPTIONAL,
+                               ParamInfo::HANDLING_LATEXIFY);
+               param_info_.add("literal", ParamInfo::LYX_INTERNAL);
        }
        return param_info_;
 }
@@ -142,6 +157,7 @@ void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd)
                        cmd = FuncRequest(LFUN_INSET_MODIFY, "changetype " + newcmdname);
                }
        }
+       // fall through
        default:
                InsetCommand::doDispatch(cur, cmd);
        }
@@ -242,8 +258,8 @@ docstring InsetCitation::toolTip(BufferView const & bv, int, int) const
        docstring tip;
        tip += "<ol>";
        int count = 0;
-       for (docstring const & key : keys) {
-               docstring const key_info = bi.getInfo(key, buffer(), ci);
+       for (docstring const & kvar : keys) {
+               docstring const key_info = bi.getInfo(kvar, buffer(), ci);
                // limit to reasonable size.
                if (count > 9 && keys.size() > 11) {
                        tip.push_back(0x2026);// HORIZONTAL ELLIPSIS
@@ -312,6 +328,22 @@ inline docstring wrapCitation(docstring const & key,
 
 } // anonymous namespace
 
+
+vector<pair<docstring, docstring>> InsetCitation::getQualifiedLists(docstring const p) const
+{
+       vector<docstring> ps =
+               getVectorFromString(p, from_ascii("\t"));
+       QualifiedList res;
+       for (docstring const & s: ps) {
+               docstring key = s;
+               docstring val;
+               if (contains(s, ' '))
+                       val = split(s, key, ' ');
+               res.push_back(make_pair(key, val));
+       }
+       return res;
+}
+
 docstring InsetCitation::generateLabel(bool for_xhtml) const
 {
        docstring label;
@@ -359,13 +391,28 @@ docstring InsetCitation::complexLabel(bool for_xhtml) const
        buffer().params().documentClass().addCiteMacro("!textafter", to_utf8(after));
        */
        docstring label;
-       vector<docstring> keys = getVectorFromString(key);
+       // we only really want the last 'false', to suppress trimming, but
+       // we need to give the other defaults, too, to set it.
+       vector<docstring> keys =
+               getVectorFromString(key, from_ascii(","), false, false);
+       CitationStyle cs = getCitationStyle(buffer().masterParams(),
+                       cite_type, buffer().masterParams().citeStyles());
+       bool const qualified = cs.hasQualifiedList
+               && (keys.size() > 1
+                   || !getParam("pretextlist").empty()
+                   || !getParam("posttextlist").empty());
+       QualifiedList pres = getQualifiedLists(getParam("pretextlist"));
+       QualifiedList posts = getQualifiedLists(getParam("posttextlist"));
+
        CiteItem ci;
        ci.textBefore = getParam("before");
        ci.textAfter = getParam("after");
        ci.forceUpperCase = uppercase;
        ci.Starred = starred;
        ci.max_size = UINT_MAX;
+       ci.isQualified = qualified;
+       ci.pretexts = pres;
+       ci.posttexts = posts;
        if (for_xhtml) {
                ci.max_key_size = UINT_MAX;
                ci.context = CiteItem::Export;
@@ -385,8 +432,7 @@ docstring InsetCitation::basicLabel(bool for_xhtml) const
        do {
                // if there is no comma, then everything goes into key
                // and keys will be empty.
-               keys = trim(split(keys, key, ','));
-               key = trim(key);
+               keys = split(keys, key, ',');
                if (!label.empty())
                        label += ", ";
                label += wrapCitation(key, key, for_xhtml);
@@ -399,6 +445,18 @@ docstring InsetCitation::basicLabel(bool for_xhtml) const
        return '[' + label + ']';
 }
 
+
+bool InsetCitation::forceLTR(OutputParams const & rp) const
+{
+       // We have to force LTR for numeric references
+       // [= bibliography, plain BibTeX, numeric natbib
+       // and biblatex]. Except for XeTeX/bidi. See #3005.
+       if (rp.useBidiPackage())
+               return false;
+       return (buffer().masterParams().citeEngine() == "basic"
+               || buffer().masterParams().citeEngineType() == ENGINE_TYPE_NUMERICAL);
+}
+
 docstring InsetCitation::screenLabel() const
 {
        return cache.screen_label;
@@ -414,8 +472,8 @@ void InsetCitation::updateBuffer(ParIterator const &, UpdateType)
        cache.recalculate = false;
        cache.generated_label = glabel;
        unsigned int const maxLabelChars = 45;
-       cache.screen_label = glabel.substr(0, maxLabelChars + 1);
-       support::truncateWithEllipsis(cache.screen_label, maxLabelChars);
+       cache.screen_label = glabel;
+       support::truncateWithEllipsis(cache.screen_label, maxLabelChars, true);
 }
 
 
@@ -423,7 +481,7 @@ void InsetCitation::addToToc(DocIterator const & cpit, bool output_active,
                                                         UpdateType, TocBackend & backend) const
 {
        // NOTE
-       // BiblioInfo::collectCitedEntries() uses the TOC to collect the citations 
+       // 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.
@@ -508,14 +566,19 @@ void InsetCitation::forOutliner(docstring & os, size_t const, bool const) const
 // engine, e.g. \cite[]{} for the basic engine.
 void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
 {
-       BiblioInfo const & bi = buffer().masterBibInfo();
+       // When this is a child compiled on its own, we use the childs
+       // own bibinfo, else the master's
+       BiblioInfo const & bi = runparams.is_child
+                       ? buffer().masterBibInfo() : buffer().bibInfo();
+       docstring const key = getParam("key");
+       // "keyonly" command: output the plain key and stop.
        if (getCmdName() == "keyonly") {
                // Special command to only return the key
                if (!bi.isBibtex(getParam("key")))
                        // escape chars with bibitems
-                       os << escape(cleanupWhitespace(getParam("key")));
+                       os << escape(cleanupWhitespace(key));
                else
-                       os << cleanupWhitespace(getParam("key"));
+                       os << cleanupWhitespace(key);
                return;
        }
        vector<CitationStyle> citation_styles = buffer().masterParams().citeStyles();
@@ -524,23 +587,79 @@ void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
        // FIXME UNICODE
        docstring const cite_str = from_utf8(citationStyleToString(cs, true));
 
+       // check if we have to do a qualified list
+       vector<docstring> keys = getVectorFromString(cleanupWhitespace(key));
+       bool const qualified = cs.hasQualifiedList
+               && (!getParam("pretextlist").empty()
+                   || !getParam("posttextlist").empty());
+
        if (runparams.inulemcmd > 0)
                os << "\\mbox{";
 
        os << "\\" << cite_str;
 
-       docstring const & before = getParam("before");
-       docstring const & after  = getParam("after");
-       if (!before.empty() && cs.textBefore)
-               os << '[' << before << "][" << after << ']';
-       else if (!after.empty() && cs.textAfter)
-               os << '[' << after << ']';
+       if (qualified)
+               os << "s";
+
+       ParamInfo const & pinfo = findInfo(string());
+       docstring before = params().prepareCommand(runparams, getParam("before"),
+                                                  pinfo["before"].handling());
+       docstring after = params().prepareCommand(runparams, getParam("after"),
+                                                  pinfo["after"].handling());
+       if (!before.empty() && cs.textBefore) {
+               if (qualified)
+                       os << '(' << protectArgument(before, '(', ')')
+                          << ")(" << protectArgument(after, '(', ')') << ')';
+               else
+                       os << '[' << protectArgument(before) << "]["
+                          << protectArgument(after) << ']';
+       } else if (!after.empty() && cs.textAfter) {
+               if (qualified)
+                       os << '(' << protectArgument(after, '(', ')') << ')';
+               else
+                       os << '[' << protectArgument(after) << ']';
+       }
 
-       if (!bi.isBibtex(getParam("key")))
+       if (!bi.isBibtex(key))
                // escape chars with bibitems
-               os << '{' << escape(cleanupWhitespace(getParam("key"))) << '}';
-       else
-               os << '{' << cleanupWhitespace(getParam("key")) << '}';
+               os << '{' << escape(cleanupWhitespace(key)) << '}';
+       else {
+               if (qualified) {
+                       QualifiedList pres = getQualifiedLists(getParam("pretextlist"));
+                       QualifiedList posts = getQualifiedLists(getParam("posttextlist"));
+                       for (docstring const & k : keys) {
+                               docstring prenote;
+                               QualifiedList::iterator it = pres.begin();
+                               for (; it != pres.end() ; ++it) {
+                                       if ((*it).first == k) {
+                                               prenote = (*it).second;
+                                               pres.erase(it);
+                                               break;
+                                       }
+                               }
+                               docstring bef = params().prepareCommand(runparams, prenote,
+                                                  pinfo["pretextlist"].handling());
+                               docstring postnote;
+                               QualifiedList::iterator pit = posts.begin();
+                               for (; pit != posts.end() ; ++pit) {
+                                       if ((*pit).first == k) {
+                                               postnote = (*pit).second;
+                                               posts.erase(pit);
+                                               break;
+                                       }
+                               }
+                               docstring aft = params().prepareCommand(runparams, postnote,
+                                                  pinfo["posttextlist"].handling());
+                               if (!bef.empty())
+                                       os << '[' << protectArgument(bef)
+                                          << "][" << protectArgument(aft) << ']';
+                               else if (!aft.empty())
+                                       os << '[' << protectArgument(aft) << ']';
+                               os << '{' << k << '}';
+                       }
+               } else
+                       os << '{' << cleanupWhitespace(key) << '}';
+       }
 
        if (runparams.inulemcmd)
                os << "}";