]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCitation.cpp
Strip et al. for citation search
[lyx.git] / src / insets / InsetCitation.cpp
index ba45f691a37cbe0cef69fdab1313ca90e6e2c02a..d878056cd6a3be952cde07254d49c0c5155a267d 100644 (file)
 #include "buffer_funcs.h"
 #include "BufferParams.h"
 #include "BufferView.h"
+#include "Citation.h"
 #include "DispatchResult.h"
 #include "FuncCode.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
 #include "LaTeXFeatures.h"
+#include "LyX.h"
+#include "LyXRC.h"
 #include "output_xhtml.h"
+#include "output_docbook.h"
 #include "ParIterator.h"
 #include "texstream.h"
 #include "TocBackend.h"
@@ -46,6 +50,7 @@ InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
        : InsetCommand(buf, p)
 {
        buffer().removeBiblioTempFiles();
+       cleanKeys();
 }
 
 
@@ -132,6 +137,9 @@ CitationStyle InsetCitation::getCitationStyle(BufferParams const & bp, string co
 void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action()) {
+       case LFUN_INSET_EDIT:
+               openCitation();
+               break;
        case LFUN_INSET_MODIFY: {
                buffer().removeBiblioTempFiles();
                cache.recalculate = true;
@@ -160,6 +168,73 @@ void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd)
        // fall through
        default:
                InsetCommand::doDispatch(cur, cmd);
+               if (cmd.action() == LFUN_INSET_MODIFY)
+                       cleanKeys();
+       }
+}
+
+bool InsetCitation::openCitationPossible() const
+{
+       Buffer const & buf = *buffer_;
+       // only after the buffer is loaded from file...
+       if (!buf.isFullyLoaded())
+               return false;
+
+       BiblioInfo const & bi = buf.masterBibInfo();
+       if (bi.empty())
+               return false;
+
+       docstring const & key = getParam("key");
+       if (key.empty())
+               return false;
+
+       // does bibtex item contains some locator?
+       vector<docstring> keys = getVectorFromString(key);
+       docstring doi, url, file;
+       for (docstring const & kvar : keys) {
+               bi.getLocators(kvar, doi, url, file);
+               if (!file.empty() || !doi.empty() || !url.empty())
+                       return true;
+       }
+
+       // last resort: is external script activated?
+       return lyxrc.citation_search;
+}
+
+void InsetCitation::openCitation()
+{
+       Buffer const & buf = *buffer_;
+       BiblioInfo const & bi = buf.masterBibInfo();
+       docstring const & key = getParam("key");
+
+       vector<docstring> keys = getVectorFromString(key);
+       docstring titledata, doi, url, file;
+       for (docstring const & kvar : keys) {
+               CiteItem ci;
+               titledata = bi.getInfo(kvar, buffer(), ci,
+                                      from_ascii(lyxrc.citation_search_pattern));
+               // some cleanup: commas, " and " and " et al.", as used in name lists,
+               // are not expected in file names
+               titledata = subst(titledata, from_ascii(","), docstring());
+               titledata = subst(titledata, from_ascii(" and "), from_ascii(" "));
+               titledata = subst(titledata, from_ascii(" et al."), docstring());
+               bi.getLocators(kvar, doi, url, file);
+               LYXERR(Debug::INSETS, "Locators: doi:" << doi << " url:"
+                       << url << " file:" << file << " title data:" << titledata
+                       << " citation search: " << lyxrc.citation_search
+                       << " citation search pattern: " << lyxrc.citation_search_pattern);
+               docstring locator;
+               if (!file.empty()) {
+                       locator = file;
+               } else if (!doi.empty()) {
+                       locator = doi;
+               } else if (!url.empty()) {
+                       locator = url;
+               } else {
+                       locator = "EXTERNAL " + titledata;
+               }
+               FuncRequest cmd = FuncRequest(LFUN_CITATION_OPEN, locator);
+               lyx::dispatch(cmd);
        }
 }
 
@@ -202,6 +277,8 @@ bool InsetCitation::getStatus(Cursor & cur, FuncRequest const & cmd,
                        }
                }
                return true;
+       case LFUN_INSET_EDIT:
+               return openCitationPossible();
        default:
                return InsetCommand::getStatus(cur, cmd, status);
        }
@@ -210,7 +287,7 @@ bool InsetCitation::getStatus(Cursor & cur, FuncRequest const & cmd,
 
 bool InsetCitation::addKey(string const & key)
 {
-       docstring const ukey = from_utf8(key);
+       docstring const ukey = from_utf8(trim(key));
        docstring const & curkeys = getParam("key");
        if (curkeys.empty()) {
                setParam("key", ukey);
@@ -219,10 +296,8 @@ bool InsetCitation::addKey(string const & key)
        }
 
        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) {
+       for (auto const & k : keys) {
+               if (k == ukey) {
                        LYXERR0("Key " << key << " already present.");
                        return false;
                }
@@ -322,22 +397,24 @@ 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 "<a href='#LyXCite-" + html::cleanAttr(key) + "'>" +
-                       html::htmlize(content, XHTMLStream::ESCAPE_ALL) + "</a>";
+       return "<a href='#LyXCite-" + xml::cleanAttr(key) + "'>" +
+                       xml::escapeString(content, XMLStream::ESCAPE_ALL) + "</a>";
 }
 
 } // anonymous namespace
 
 
-map<docstring, docstring> InsetCitation::getQualifiedLists(docstring const p) const
+vector<pair<docstring, docstring>> InsetCitation::getQualifiedLists(docstring const & p) const
 {
        vector<docstring> ps =
                getVectorFromString(p, from_ascii("\t"));
-       std::map<docstring, docstring> res;
+       QualifiedList res;
        for (docstring const & s: ps) {
-               docstring key;
-               docstring val = split(s, key, ' ');
-               res[key] = val;
+               docstring key = s;
+               docstring val;
+               if (contains(s, ' '))
+                       val = split(s, key, ' ');
+               res.push_back(make_pair(key, val));
        }
        return res;
 }
@@ -362,14 +439,33 @@ docstring InsetCitation::complexLabel(bool for_xhtml) const
        if (!buf.isFullyLoaded())
                return docstring();
 
+       docstring const & key = getParam("key");
+
        BiblioInfo const & biblist = buf.masterBibInfo();
-       if (biblist.empty())
+
+       // mark broken citations
+       setBroken(false);
+
+       if (biblist.empty()) {
+               setBroken(true);
                return docstring();
+       }
 
-       docstring const & key = getParam("key");
        if (key.empty())
                return _("No citations selected!");
 
+       // check all citations
+       // 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);
+       for (auto const & k : keys) {
+               if (biblist.find(k) == biblist.end()) {
+                       setBroken(true);
+                       break;
+               }
+       }
+       
        string cite_type = getCmdName();
        bool const uppercase = isUpperCase(cite_type[0]);
        if (uppercase)
@@ -389,18 +485,14 @@ docstring InsetCitation::complexLabel(bool for_xhtml) const
        buffer().params().documentClass().addCiteMacro("!textafter", to_utf8(after));
        */
        docstring label;
-       // 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());
-       map<docstring, docstring> pres = getQualifiedLists(getParam("pretextlist"));
-       map<docstring, docstring> posts = getQualifiedLists(getParam("posttextlist"));
+       QualifiedList pres = getQualifiedLists(getParam("pretextlist"));
+       QualifiedList posts = getQualifiedLists(getParam("posttextlist"));
 
        CiteItem ci;
        ci.textBefore = getParam("before");
@@ -443,13 +535,25 @@ 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;
 }
 
 
-void InsetCitation::updateBuffer(ParIterator const &, UpdateType)
+void InsetCitation::updateBuffer(ParIterator const &, UpdateType, bool const /*deleted*/)
 {
        if (!cache.recalculate && buffer().citeLabelsValid())
                return;
@@ -458,8 +562,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);
 }
 
 
@@ -471,10 +575,17 @@ void InsetCitation::addToToc(DocIterator const & cpit, bool output_active,
        // 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");
+       docstring tocitem;
+       if (isBroken())
+               tocitem = _("BROKEN: ");
+       tocitem += getParam("key");
        TocBuilder & b = backend.builder("citation");
        b.pushItem(cpit, tocitem, output_active);
        b.pop();
+       if (isBroken()) {
+               shared_ptr<Toc> toc2 = backend.toc("brokenrefs");
+               toc2->push_back(TocItem(cpit, 0, tocitem, output_active));
+       }
 }
 
 
@@ -485,7 +596,7 @@ int InsetCitation::plaintext(odocstringstream & os,
        if (cmd == "nocite")
                return 0;
 
-       docstring const label = generateLabel(false);
+       docstring const label = generateLabel();
        os << label;
        return label.size();
 }
@@ -493,39 +604,57 @@ int InsetCitation::plaintext(odocstringstream & os,
 
 static docstring const cleanupWhitespace(docstring const & citelist)
 {
-       docstring::const_iterator it  = citelist.begin();
-       docstring::const_iterator end = citelist.end();
        // Paranoia check: make sure that there is no whitespace in here
        // -- at least not behind commas or at the beginning
        docstring result;
        char_type last = ',';
-       for (; it != end; ++it) {
-               if (*it != ' ')
-                       last = *it;
-               if (*it != ' ' || last != ',')
-                       result += *it;
+       for (char_type c : citelist) {
+               if (c != ' ')
+                       last = c;
+               if (c != ' ' || last != ',')
+                       result += c;
        }
        return result;
 }
 
 
-int InsetCitation::docbook(odocstream & os, OutputParams const &) const
+void InsetCitation::cleanKeys() {
+       docstring cleankeys = cleanupWhitespace(getParam("key"));
+       setParam("key", cleankeys);
+}
+
+void InsetCitation::docbook(XMLStream & xs, OutputParams const &) const
 {
-       os << from_ascii("<citation>")
-          << cleanupWhitespace(getParam("key"))
-          << from_ascii("</citation>");
-       return 0;
+       if (getCmdName() == "nocite")
+               return;
+
+       // Split the different citations (on ","), so that one tag can be output for each of them.
+       // DocBook does not support having multiple citations in one tag, so that we have to deal with formatting here.
+       docstring citations = getParam("key");
+       if (citations.find(',') == string::npos) {
+               xs << xml::CompTag("biblioref", "endterm=\"" + to_utf8(xml::cleanID(citations)) + "\"");
+       } else {
+               size_t pos = 0;
+               while (pos != string::npos) {
+                       pos = citations.find(',');
+                       xs << xml::CompTag("biblioref", "endterm=\"" + to_utf8(xml::cleanID(citations.substr(0, pos))) + "\"");
+                       citations.erase(0, pos + 1);
+
+                       if (pos != string::npos) {
+                               xs << ", "; 
+                       }
+               }
+       }
 }
 
 
-docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const
+docstring InsetCitation::xhtml(XMLStream & xs, OutputParams const &) const
 {
-       string const & cmd = getCmdName();
-       if (cmd == "nocite")
+       if (getCmdName() == "nocite")
                return docstring();
 
        // have to output this raw, because generateLabel() will include tags
-       xs << XHTMLStream::ESCAPE_NONE << generateLabel(true);
+       xs << XMLStream::ESCAPE_NONE << generateLabel(true);
 
        return docstring();
 }
@@ -534,7 +663,7 @@ docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const
 void InsetCitation::toString(odocstream & os) const
 {
        odocstringstream ods;
-       plaintext(ods, OutputParams(0));
+       plaintext(ods, OutputParams(nullptr));
        os << ods.str();
 }
 
@@ -552,7 +681,7 @@ 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
 {
-       // When this is a child compiled on its own, we use the childs
+       // When this is a child compiled on its own, we use the children
        // own bibinfo, else the master's
        BiblioInfo const & bi = runparams.is_child
                        ? buffer().masterBibInfo() : buffer().bibInfo();
@@ -611,12 +740,30 @@ void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
                os << '{' << escape(cleanupWhitespace(key)) << '}';
        else {
                if (qualified) {
-                       map<docstring, docstring> pres = getQualifiedLists(getParam("pretextlist"));
-                       map<docstring, docstring> posts = getQualifiedLists(getParam("posttextlist"));
-                       for (docstring const & k: keys) {
-                               docstring bef = params().prepareCommand(runparams, pres[k],
+                       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 aft = params().prepareCommand(runparams, posts[k],
+                               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)
@@ -634,6 +781,13 @@ void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
 }
 
 
+pair<int, int> InsetCitation::isWords() const
+{
+       docstring const label = generateLabel(false);
+       return pair<int, int>(label.size(), wordCount(label));
+}
+
+
 string InsetCitation::contextMenuName() const
 {
        return "context-citation";