]> git.lyx.org Git - features.git/blobdiff - src/BiblioInfo.cpp
Implement display of starred cite commands
[features.git] / src / BiblioInfo.cpp
index 421d71756b145926349f90fa5d16ab7c73f83991..44e517a18fc01b345f880aabec1def157319a98b 100644 (file)
@@ -17,6 +17,7 @@
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "buffer_funcs.h"
+#include "Citation.h"
 #include "Encoding.h"
 #include "InsetIterator.h"
 #include "Language.h"
@@ -255,9 +256,13 @@ BibTeXInfo::BibTeXInfo(docstring const & key, docstring const & type)
 {}
 
 
-docstring const BibTeXInfo::getAbbreviatedAuthor(
-    Buffer const * buf, bool jurabib_style) const
+docstring const BibTeXInfo::getAuthorList(
+    Buffer const * buf, bool full, bool forceshort) const
 {
+       // Maxnames treshold depend on engine
+       size_t maxnames = buf ?
+               buf->params().documentClass().max_citenames() : 2;
+
        if (!is_bibtex_) {
                docstring const opt = label();
                if (opt.empty())
@@ -294,21 +299,51 @@ docstring const BibTeXInfo::getAbbreviatedAuthor(
                        shortauthor += "/" + familyName(authors[2]);
                return convertLaTeXCommands(shortauthor);
        }
+       docstring retval;
 
-       docstring retval = familyName(authors[0]);
-
-       if (authors.size() == 2 && authors[1] != "others") {
-               docstring const dformat = buf ? 
-                       buf->B_("%1$s and %2$s") : from_ascii("%1$s and %2$s");
-               retval = bformat(dformat, familyName(authors[0]), familyName(authors[1]));
-       } else if (authors.size() >= 2) {
-               // we get here either if the author list is longer than two names
-               // or if the second 'name' is "others". we do the same thing either
-               // way.
-               docstring const dformat = buf ? 
-                       buf->B_("%1$s et al.") : from_ascii("%1$s et al.");
-               retval = bformat(dformat, familyName(authors[0]));
+       CiteEngineType const engine_type = buf ? buf->params().citeEngineType()
+                                              : ENGINE_TYPE_DEFAULT;
+
+       // These are defined in the styles
+       string const etal =
+               buf ? buf->params().documentClass().getCiteMacro(engine_type, "_etal")
+                   : " et al.";
+       string const namesep =
+               buf ? buf->params().documentClass().getCiteMacro(engine_type, "_namesep")
+                  : ", ";
+       string const lastnamesep =
+               buf ? buf->params().documentClass().getCiteMacro(engine_type, "_lastnamesep")
+                   : ", and ";
+       string const pairnamesep =
+               buf ? buf->params().documentClass().getCiteMacro(engine_type, "_pairnamesep")
+                    : " and ";
+
+       // Shorten the list (with et al.) if forceshort is set
+       // and the list can actually be shorten, else if maxcitenames
+       // is passed and full is not set.
+       bool shorten = forceshort && authors.size() > 1;
+       vector<docstring>::const_iterator it = authors.begin();
+       vector<docstring>::const_iterator en = authors.end();
+       for (size_t i = 0; it != en; ++it, ++i) {
+               if (i >= maxnames && !full) {
+                       shorten = true;
+                       break;
+               }
+               if (*it == "others") {
+                       retval += buf ? buf->B_(etal) : from_ascii(etal);
+                       break;
+               }
+               if (i > 0 && i == authors.size() - 1) {
+                       if (authors.size() == 2)
+                               retval += buf ? buf->B_(pairnamesep) : from_ascii(pairnamesep);
+                       else
+                               retval += buf ? buf->B_(lastnamesep) : from_ascii(lastnamesep);
+               } else if (i > 0)
+                       retval += buf ? buf->B_(namesep) : from_ascii(namesep);
+               retval += familyName(*it);
        }
+       if (shorten)
+               retval = familyName(authors[0]) + (buf ? buf->B_(etal) : from_ascii(etal));
 
        return convertLaTeXCommands(retval);
 }
@@ -326,7 +361,7 @@ docstring const BibTeXInfo::getYear() const
                // Format is [-]YYYY-MM-DD*/[-]YYYY-MM-DD*
                // We only want the years.
                static regex const yreg("[-]?([\\d]{4}).*");
-               static regex const ereg(".*/([\\d]{4}).*");
+               static regex const ereg(".*/[-]?([\\d]{4}).*");
                smatch sm;
                string const date = to_utf8(year);
                regex_match(date, sm, yreg);
@@ -478,7 +513,7 @@ bit of work, however.
 */
 docstring BibTeXInfo::expandFormat(docstring const & format,
                BibTeXInfoList const xrefs, int & counter, Buffer const & buf,
-               docstring before, docstring after, docstring dialog, bool next) const
+               CiteItem const & ci, bool next, bool second) const
 {
        // incorrect use of macros could put us in an infinite loop
        static int const max_passes = 5000;
@@ -526,7 +561,7 @@ docstring BibTeXInfo::expandFormat(docstring const & format,
                                        ret << trans;
                                } else {
                                        docstring const val =
-                                               getValueForKey(key, buf, before, after, dialog, xrefs, max_keysize);
+                                               getValueForKey(key, buf, ci, xrefs, max_keysize);
                                        if (!scanning_rich)
                                                ret << from_ascii("{!<span class=\"bib-" + key + "\">!}");
                                        ret << val;
@@ -557,17 +592,17 @@ docstring BibTeXInfo::expandFormat(docstring const & format,
                                                return _("ERROR!");
                                        fmt = newfmt;
                                        docstring const val =
-                                               getValueForKey(optkey, buf, before, after, dialog, xrefs);
+                                               getValueForKey(optkey, buf, ci, xrefs);
                                        if (optkey == "next" && next)
                                                ret << ifpart; // without expansion
                                        else if (!val.empty()) {
                                                int newcounter = 0;
                                                ret << expandFormat(ifpart, xrefs, newcounter, buf,
-                                                       before, after, dialog, next);
+                                                       ci, next);
                                        } else if (!elsepart.empty()) {
                                                int newcounter = 0;
                                                ret << expandFormat(elsepart, xrefs, newcounter, buf,
-                                                       before, after, dialog, next);
+                                                       ci, next);
                                        }
                                        // fmt will have been shortened for us already
                                        continue;
@@ -616,8 +651,10 @@ docstring BibTeXInfo::expandFormat(docstring const & format,
 
 
 docstring const & BibTeXInfo::getInfo(BibTeXInfoList const xrefs,
-       Buffer const & buf, bool richtext) const
+       Buffer const & buf, CiteItem const & ci) const
 {
+       bool const richtext = ci.richtext;
+
        if (!richtext && !info_.empty())
                return info_;
        if (richtext && !info_richtext_.empty())
@@ -635,7 +672,7 @@ docstring const & BibTeXInfo::getInfo(BibTeXInfoList const xrefs,
                from_utf8(dc.getCiteFormat(engine_type, to_utf8(entry_type_)));
        int counter = 0;
        info_ = expandFormat(format, xrefs, counter, buf,
-               docstring(), docstring(), docstring(), false);
+               ci, false, false);
 
        if (info_.empty()) {
                // this probably shouldn't happen
@@ -653,18 +690,16 @@ docstring const & BibTeXInfo::getInfo(BibTeXInfoList const xrefs,
 
 
 docstring const BibTeXInfo::getLabel(BibTeXInfoList const xrefs,
-       Buffer const & buf, docstring const & format, bool richtext,
-       docstring const & before, docstring const & after, 
-       docstring const & dialog, bool next) const
+       Buffer const & buf, docstring const & format,
+       CiteItem const & ci, bool next, bool second) const
 {
        docstring loclabel;
 
        int counter = 0;
-       loclabel = expandFormat(format, xrefs, counter, buf,
-               before, after, dialog, next);
+       loclabel = expandFormat(format, xrefs, counter, buf, ci, next, second);
 
        if (!loclabel.empty() && !next) {
-               loclabel = processRichtext(loclabel, richtext);
+               loclabel = processRichtext(loclabel, ci.richtext);
                loclabel = convertLaTeXCommands(loclabel);
        }
 
@@ -689,8 +724,7 @@ docstring const & BibTeXInfo::operator[](string const & field) const
 
 
 docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf,
-       docstring const & before, docstring const & after, docstring const & dialog,
-       BibTeXInfoList const xrefs, size_t maxsize) const
+       CiteItem const & ci, BibTeXInfoList const xrefs, size_t maxsize) const
 {
        // anything less is pointless
        LASSERT(maxsize >= 16, maxsize = 16);
@@ -715,8 +749,10 @@ docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf,
        if (ret.empty()) {
                // some special keys
                // FIXME: dialog, textbefore and textafter have nothing to do with this
-               if (key == "dialog")
-                       ret = dialog;
+               if (key == "dialog" && ci.context == CiteItem::Dialog)
+                       ret = from_ascii("x"); // any non-empty string will do
+               else if (key == "ifstar" && ci.Starred)
+                       ret = from_ascii("x"); // any non-empty string will do
                else if (key == "entrytype")
                        ret = entry_type_;
                else if (key == "key")
@@ -727,9 +763,6 @@ docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf,
                        ret = modifier_;
                else if (key == "numericallabel")
                        ret = cite_number_;
-               else if (key == "abbrvauthor")
-                       // Special key to provide abbreviated author names.
-                       ret = getAbbreviatedAuthor(&buf, false);
                else if (key == "shortauthor")
                        // When shortauthor is not defined, jurabib automatically
                        // provides jurabib-style abbreviated author names. We do
@@ -744,6 +777,23 @@ docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf,
                                        + " [" + operator[]("year") + "]";
                        else
                                ret = operator[]("title");
+               else if (key == "abbrvauthor") {
+                       // Special key to provide abbreviated author names,
+                       // with respect to maxcitenames.
+                       ret = getAuthorList(&buf, false, false);
+                       if (ci.forceUpperCase && isLowerCase(ret[0]))
+                               ret[0] = uppercase(ret[0]);
+               } else if (key == "fullauthor") {
+                       // Return a full author list
+                       ret = getAuthorList(&buf, true, false);
+                       if (ci.forceUpperCase && isLowerCase(ret[0]))
+                               ret[0] = uppercase(ret[0]);
+               } else if (key == "forceabbrvauthor") {
+                       // Special key to provide abbreviated author names,
+                       // irrespective of maxcitenames.
+                       ret = getAuthorList(&buf, false, true);
+                       if (ci.forceUpperCase && isLowerCase(ret[0]))
+                               ret[0] = uppercase(ret[0]);
                } else if (key == "bibentry") {
                        // Special key to provide the full bibliography entry: see getInfo()
                        CiteEngineType const engine_type = buf.params().citeEngineType();
@@ -751,12 +801,11 @@ docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf,
                        docstring const & format =
                                from_utf8(dc.getCiteFormat(engine_type, to_utf8(entry_type_)));
                        int counter = 0;
-                       ret = expandFormat(format, xrefs, counter, buf,
-                               docstring(), docstring(), docstring(), false);
+                       ret = expandFormat(format, xrefs, counter, buf, ci, false, false);
                } else if (key == "textbefore")
-                       ret = before;
+                       ret = ci.textBefore;
                else if (key == "textafter")
-                       ret = after;
+                       ret = ci.textAfter;
                else if (key == "year")
                        ret = getYear();
        }
@@ -796,20 +845,36 @@ vector<docstring> const BiblioInfo::getXRefs(BibTeXInfo const & data, bool const
        if (!data.isBibTeX())
                return result;
        // Legacy crossref field. This is not nestable.
-       if (!nested && !data["crossref"].empty())
-               result.push_back(data["crossref"]);
-       // Biblatex's xdata field. Infinitely nestable.
-       docstring const xdatakey = data["xdata"];
-       if (!xdatakey.empty()) {
-               result.push_back(xdatakey);
-               BiblioInfo::const_iterator it = find(xdatakey);
+       if (!nested && !data["crossref"].empty()) {
+               docstring const xrefkey = data["crossref"];
+               result.push_back(xrefkey);
+               // However, check for nested xdatas
+               BiblioInfo::const_iterator it = find(xrefkey);
                if (it != end()) {
-                       BibTeXInfo const & xdata = it->second;
-                       vector<docstring> const nxdata = getXRefs(xdata, true);
+                       BibTeXInfo const & xref = it->second;
+                       vector<docstring> const nxdata = getXRefs(xref, true);
                        if (!nxdata.empty())
                                result.insert(result.end(), nxdata.begin(), nxdata.end());
                }
        }
+       // Biblatex's xdata field. Infinitely nestable.
+       // XData field can consist of a comma-separated list of keys
+       vector<docstring> const xdatakeys = getVectorFromString(data["xdata"]);
+       if (!xdatakeys.empty()) {
+               vector<docstring>::const_iterator xit = xdatakeys.begin();
+               vector<docstring>::const_iterator xen = xdatakeys.end();
+               for (; xit != xen; ++xit) {
+                       docstring const xdatakey = *xit;
+                       result.push_back(xdatakey);
+                       BiblioInfo::const_iterator it = find(xdatakey);
+                       if (it != end()) {
+                               BibTeXInfo const & xdata = it->second;
+                               vector<docstring> const nxdata = getXRefs(xdata, true);
+                               if (!nxdata.empty())
+                                       result.insert(result.end(), nxdata.begin(), nxdata.end());
+                       }
+               }
+       }
        return result;
 }
 
@@ -849,13 +914,13 @@ vector<docstring> const BiblioInfo::getEntries() const
 }
 
 
-docstring const BiblioInfo::getAbbreviatedAuthor(docstring const & key, Buffer const & buf) const
+docstring const BiblioInfo::getAuthorList(docstring const & key, Buffer const & buf) const
 {
        BiblioInfo::const_iterator it = find(key);
        if (it == end())
                return docstring();
        BibTeXInfo const & data = it->second;
-       return data.getAbbreviatedAuthor(&buf, false);
+       return data.getAuthorList(&buf, false);
 }
 
 
@@ -911,7 +976,7 @@ docstring const BiblioInfo::getYear(docstring const & key, Buffer const & buf, b
 
 
 docstring const BiblioInfo::getInfo(docstring const & key,
-       Buffer const & buf, bool richtext) const
+       Buffer const & buf, CiteItem const & ci) const
 {
        BiblioInfo::const_iterator it = find(key);
        if (it == end())
@@ -928,15 +993,14 @@ docstring const BiblioInfo::getInfo(docstring const & key,
                                xrefptrs.push_back(&(xrefit->second));
                }
        }
-       return data.getInfo(xrefptrs, buf, richtext);
+       return data.getInfo(xrefptrs, buf, ci);
 }
 
 
 docstring const BiblioInfo::getLabel(vector<docstring> keys,
-       Buffer const & buf, string const & style, bool for_xhtml,
-       size_t max_size, docstring const & before, docstring const & after,
-       docstring const & dialog) const
+       Buffer const & buf, string const & style, CiteItem const & ci) const
 {
+       size_t max_size = ci.max_size;
        // shorter makes no sense
        LASSERT(max_size >= 16, max_size = 16);
 
@@ -970,8 +1034,7 @@ docstring const BiblioInfo::getLabel(vector<docstring> keys,
                                }
                        }
                }
-               ret = data.getLabel(xrefptrs, buf, ret, for_xhtml,
-                       before, after, dialog, key + 1 != ken);
+               ret = data.getLabel(xrefptrs, buf, ret, ci, key + 1 != ken, i == 1);
        }
 
        if (too_many_keys)
@@ -994,8 +1057,7 @@ bool BiblioInfo::isBibtex(docstring const & key) const
 
 vector<docstring> const BiblioInfo::getCiteStrings(
        vector<docstring> const & keys, vector<CitationStyle> const & styles,
-       Buffer const & buf, docstring const & before,
-       docstring const & after, docstring const & dialog, size_t max_size) const
+       Buffer const & buf, CiteItem const & ci) const
 {
        if (empty())
                return vector<docstring>();
@@ -1003,8 +1065,8 @@ vector<docstring> const BiblioInfo::getCiteStrings(
        string style;
        vector<docstring> vec(styles.size());
        for (size_t i = 0; i != vec.size(); ++i) {
-               style = styles[i].cmd;
-               vec[i] = getLabel(keys, buf, style, false, max_size, before, after, dialog);
+               style = styles[i].name;
+               vec[i] = getLabel(keys, buf, style, ci);
        }
 
        return vec;
@@ -1024,8 +1086,8 @@ namespace {
 // used in xhtml to sort a list of BibTeXInfo objects
 bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs)
 {
-       docstring const lauth = lhs->getAbbreviatedAuthor();
-       docstring const rauth = rhs->getAbbreviatedAuthor();
+       docstring const lauth = lhs->getAuthorList();
+       docstring const rauth = rhs->getAuthorList();
        docstring const lyear = lhs->getYear();
        docstring const ryear = rhs->getYear();
        docstring const ltitl = lhs->operator[]("title");
@@ -1113,7 +1175,7 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf)
                        // the first test.
                        // coverity[FORWARD_NULL]
                        if (it != cited_entries_.begin()
-                           && entry.getAbbreviatedAuthor() == last->second.getAbbreviatedAuthor()
+                           && entry.getAuthorList() == last->second.getAuthorList()
                            // we access the year via getYear() so as to get it from the xref,
                            // if we need to do so
                            && getYear(entry.key()) == getYear(last->second.key())) {
@@ -1145,7 +1207,7 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf)
                if (numbers) {
                        entry.label(entry.citeNumber());
                } else {
-                       docstring const auth = entry.getAbbreviatedAuthor(&buf, false);
+                       docstring const auth = entry.getAuthorList(&buf, false);
                        // we do it this way so as to access the xref, if necessary
                        // note that this also gives us the modifier
                        docstring const year = getYear(*it, buf, true);
@@ -1165,35 +1227,38 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf)
 //////////////////////////////////////////////////////////////////////
 
 
-CitationStyle citationStyleFromString(string const & command)
+CitationStyle citationStyleFromString(string const & command,
+                                     BufferParams const & params)
 {
        CitationStyle cs;
        if (command.empty())
                return cs;
 
-       string cmd = command;
-       if (cmd[0] == 'C') {
+       string const alias = params.getCiteAlias(command);
+       string cmd = alias.empty() ? command : alias;
+       if (isUpperCase(command[0])) {
                cs.forceUpperCase = true;
-               cmd[0] = 'c';
+               cmd[0] = lowercase(cmd[0]);
        }
 
-       size_t const n = cmd.size() - 1;
-       if (cmd[n] == '*') {
-               cs.fullAuthorList = true;
-               cmd = cmd.substr(0, n);
+       size_t const n = command.size() - 1;
+       if (command[n] == '*') {
+               cs.hasStarredVersion = true;
+               if (suffixIs(cmd, '*'))
+                       cmd = cmd.substr(0, cmd.size() - 1);
        }
 
-       cs.cmd = cmd;
+       cs.name = cmd;
        return cs;
 }
 
 
-string citationStyleToString(const CitationStyle & cs)
+string citationStyleToString(const CitationStyle & cs, bool const latex)
 {
-       string cmd = cs.cmd;
+       string cmd = latex ? cs.cmd : cs.name;
        if (cs.forceUpperCase)
                cmd[0] = uppercase(cmd[0]);
-       if (cs.fullAuthorList)
+       if (cs.hasStarredVersion)
                cmd += '*';
        return cmd;
 }