X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBiblioInfo.cpp;h=f45d370ece5b432f7a781121d994b61e05cf1c13;hb=c7d29be153debac82e3d2e8865fcc849f0a5f40d;hp=84ea4f035f4241bef40b625a0e432e931ed1e2f5;hpb=3408ca42044616bd169540ec901ce248e8290a61;p=lyx.git diff --git a/src/BiblioInfo.cpp b/src/BiblioInfo.cpp index 84ea4f035f..f45d370ece 100644 --- a/src/BiblioInfo.cpp +++ b/src/BiblioInfo.cpp @@ -7,6 +7,7 @@ * \author Herbert Voß * \author Richard Heck * \author Julien Rioux + * \author Jürgen Spitzmüller * * Full author contact details are available in file CREDITS. */ @@ -17,9 +18,11 @@ #include "Buffer.h" #include "BufferParams.h" #include "buffer_funcs.h" +#include "Citation.h" #include "Encoding.h" #include "InsetIterator.h" #include "Language.h" +#include "output_xhtml.h" #include "Paragraph.h" #include "TextClass.h" #include "TocBackend.h" @@ -33,6 +36,7 @@ #include "support/regex.h" #include "support/textutils.h" +#include #include using namespace std; @@ -43,51 +47,275 @@ namespace lyx { namespace { -// gets the "family name" from an author-type string -docstring familyName(docstring const & name) +// Remove placeholders from names +docstring renormalize(docstring const & input) { - if (name.empty()) - return docstring(); + docstring res = subst(input, from_ascii("$$space!"), from_ascii(" ")); + return subst(res, from_ascii("$$comma!"), from_ascii(",")); +} + + +// Split the surname into prefix ("von-part") and family name +pair parseSurname(docstring const & sname) +{ + // Split the surname into its tokens + vector pieces = getVectorFromString(sname, from_ascii(" ")); + if (pieces.size() < 2) + return make_pair(docstring(), sname); + + // Now we look for pieces that begin with a lower case letter. + // All except for the very last token constitute the "von-part". + docstring prefix; + vector::const_iterator it = pieces.begin(); + vector::const_iterator const en = pieces.end(); + bool first = true; + for (; it != en; ++it) { + if ((*it).empty()) + continue; + // If this is the last piece, then what we now have is + // the family name, notwithstanding the casing. + if (it + 1 == en) + break; + char_type const c = (*it)[0]; + // If the piece starts with a upper case char, we assume + // this is part of the surname. + if (!isLower(c)) + break; + // Nothing of the former, so add this piece to the prename + if (!first) + prefix += " "; + else + first = false; + prefix += *it; + } + + // Reconstruct the family name. + // Note that if we left the loop with because it + 1 == en, + // then this will still do the right thing, i.e., make surname + // just be the last piece. + docstring surname; + first = true; + for (; it != en; ++it) { + if (!first) + surname += " "; + else + first = false; + surname += *it; + } + return make_pair(prefix, surname); +} - // first we look for a comma, and take the last name to be everything - // preceding the right-most one, so that we also get the "jr" part. - docstring::size_type idx = name.rfind(','); - if (idx != docstring::npos) - return ltrim(name.substr(0, idx)); - // OK, so now we want to look for the last name. We're going to - // include the "von" part. This isn't perfect. +struct name_parts { + docstring surname; + docstring prename; + docstring suffix; + docstring prefix; +}; + + +// gets the name parts (prename, surname, prefix, suffix) from an author-type string +name_parts nameParts(docstring const & iname) +{ + name_parts res; + if (iname.empty()) + return res; + + // First we check for goupings (via {...}) and replace blanks and + // commas inside groups with temporary placeholders + docstring name; + int gl = 0; + docstring::const_iterator p = iname.begin(); + while (p != iname.end()) { + // count grouping level + if (*p == '{') + ++gl; + else if (*p == '}') + --gl; + // generate string with probable placeholders + if (*p == ' ' && gl > 0) + name += from_ascii("$$space!"); + else if (*p == ',' && gl > 0) + name += from_ascii("$$comma!"); + else + name += *p; + ++p; + } + + // Now we look for a comma, and take the last name to be everything + // preceding the right-most one, so that we also get the name suffix + // (aka "jr" part). + vector pieces = getVectorFromString(name); + if (pieces.size() > 1) { + // Whether we have a name suffix or not, the prename is + // always last item + res.prename = renormalize(pieces.back()); + // The family name, conversely, is always the first item. + // However, it might contain a prefix (aka "von" part) + docstring const sname = pieces.front(); + res.prefix = renormalize(parseSurname(sname).first); + res.surname = renormalize(parseSurname(sname).second); + // If we have three pieces (the maximum allowed by BibTeX), + // the second one is the name suffix. + if (pieces.size() > 2) + res.suffix = renormalize(pieces.at(1)); + return res; + } + + // OK, so now we want to look for the last name. // Split on spaces, to get various tokens. - vector pieces = getVectorFromString(name, from_ascii(" ")); - // If we only get two, assume the last one is the last name - if (pieces.size() <= 2) - return pieces.back(); + pieces = getVectorFromString(name, from_ascii(" ")); + // No space: Only a family name given + if (pieces.size() < 2) { + res.surname = renormalize(pieces.back()); + return res; + } + // If we get two pieces, assume "prename surname" + if (pieces.size() == 2) { + res.prename = renormalize(pieces.front()); + res.surname = renormalize(pieces.back()); + return res; + } - // Now we look for the first token that begins with a lower case letter. + // More than 3 pieces: A name prefix (aka "von" part) might be included. + // We look for the first piece that begins with a lower case letter + // (which is the name prefix, if it is not the last token) or the last token. + docstring prename; vector::const_iterator it = pieces.begin(); - vector::const_iterator en = pieces.end(); + vector::const_iterator const en = pieces.end(); + bool first = true; for (; it != en; ++it) { if ((*it).empty()) continue; char_type const c = (*it)[0]; + // If the piece starts with a lower case char, we assume + // this is the name prefix and thus prename is complete. if (isLower(c)) break; + // Same if this is the last piece, which is always the surname. + if (it + 1 == en) + break; + // Nothing of the former, so add this piece to the prename + if (!first) + prename += " "; + else + first = false; + prename += *it; } - if (it == en) // we never found a "von" - return pieces.back(); - - // reconstruct what we need to return - docstring retval; - bool first = true; + // Now reconstruct the family name and strip the prefix. + // Note that if we left the loop because it + 1 == en, + // then this will still do the right thing, i.e., make surname + // just be the last piece. + docstring surname; + first = true; for (; it != en; ++it) { if (!first) - retval += " "; + surname += " "; else first = false; - retval += *it; + surname += *it; } - return retval; + res.prename = renormalize(prename); + res.prefix = renormalize(parseSurname(surname).first); + res.surname = renormalize(parseSurname(surname).second); + return res; +} + + +docstring constructName(docstring const & name, string const scheme) +{ + // re-constructs a name from name parts according + // to a given scheme + docstring const prename = nameParts(name).prename; + docstring const surname = nameParts(name).surname; + docstring const prefix = nameParts(name).prefix; + docstring const suffix = nameParts(name).suffix; + string res = scheme; + static regex const reg1("(.*)(\\{%prename%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)"); + static regex const reg2("(.*)(\\{%suffix%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)"); + static regex const reg3("(.*)(\\{%prefix%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)"); + smatch sub; + // Changing the first parameter of regex_match() may corrupt the + // second one. In this case we use the temporary string tmp. + if (regex_match(scheme, sub, reg1)) { + res = sub.str(1); + if (!prename.empty()) + res += sub.str(3); + res += sub.str(5); + } + if (regex_match(res, sub, reg2)) { + string tmp = sub.str(1); + if (!suffix.empty()) + tmp += sub.str(3); + res = tmp + sub.str(5); + } + if (regex_match(res, sub, reg3)) { + string tmp = sub.str(1); + if (!prefix.empty()) + tmp += sub.str(3); + res = tmp + sub.str(5); + } + docstring result = from_ascii(res); + result = subst(result, from_ascii("%prename%"), prename); + result = subst(result, from_ascii("%surname%"), surname); + result = subst(result, from_ascii("%prefix%"), prefix); + result = subst(result, from_ascii("%suffix%"), suffix); + return result; +} + + +vector const getAuthors(docstring const & author) +{ + // We check for goupings (via {...}) and only consider " and " + // outside groups as author separator. This is to account + // for cases such as {{Barnes and Noble, Inc.}}, which + // need to be treated as one single family name. + // We use temporary placeholders in order to differentiate the + // diverse " and " cases. + + // First, we temporarily replace all ampersands. It is rather unusual + // in author names, but can happen (consider cases such as "C \& A Corp."). + docstring iname = subst(author, from_ascii("&"), from_ascii("$$amp!")); + // Then, we temporarily make all " and " strings to ampersands in order + // to handle them later on a per-char level. + iname = subst(iname, from_ascii(" and "), from_ascii(" & ")); + // Now we traverse through the string and replace the "&" by the proper + // output in- and outside groups + docstring name; + int gl = 0; + docstring::const_iterator p = iname.begin(); + while (p != iname.end()) { + // count grouping level + if (*p == '{') + ++gl; + else if (*p == '}') + --gl; + // generate string with probable placeholders + if (*p == '&') { + if (gl > 0) + // Inside groups, we output "and" + name += from_ascii("and"); + else + // Outside groups, we output a separator + name += from_ascii("$$namesep!"); + } + else + name += *p; + ++p; + } + + // re-insert the literal ampersands + name = subst(name, from_ascii("$$amp!"), from_ascii("&")); + + // Now construct the actual vector + return getVectorFromString(name, from_ascii(" $$namesep! ")); +} + + +bool multipleAuthors(docstring const author) +{ + return getAuthors(author).size() > 1; } @@ -152,7 +380,18 @@ docstring convertLaTeXCommands(docstring const & str) continue; } - // we just ignore braces + // Change text mode accents in the form + // {\v a} to \v{a} (see #9340). + // FIXME: This is a sort of mini-tex2lyx. + // Use the real tex2lyx instead! + static lyx::regex const tma_reg("^\\{\\\\[bcCdfGhHkrtuUv]\\s\\w\\}"); + if (lyx::regex_search(to_utf8(val), tma_reg)) { + val = val.substr(1); + val.replace(2, 1, from_ascii("{")); + continue; + } + + // Apart from the above, we just ignore braces if (ch == '{' || ch == '}') { val = val.substr(1); continue; @@ -239,7 +478,7 @@ docstring processRichtext(docstring const & str, bool richtext) return ret; } -} // anon namespace +} // namespace ////////////////////////////////////////////////////////////////////// @@ -254,8 +493,26 @@ BibTeXInfo::BibTeXInfo(docstring const & key, docstring const & type) {} -docstring const BibTeXInfo::getAbbreviatedAuthor(bool jurabib_style) const + +docstring const BibTeXInfo::getAuthorOrEditorList(Buffer const * buf, + bool full, bool forceshort) const +{ + docstring author = operator[]("author"); + if (author.empty()) + author = operator[]("editor"); + + return getAuthorList(buf, author, full, forceshort); +} + + +docstring const BibTeXInfo::getAuthorList(Buffer const * buf, + docstring const & author, bool const full, bool const forceshort, + bool const allnames, bool const beginning) 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()) @@ -270,60 +527,108 @@ docstring const BibTeXInfo::getAbbreviatedAuthor(bool jurabib_style) const return authors; } - docstring author = convertLaTeXCommands(operator[]("author")); - if (author.empty()) { - author = convertLaTeXCommands(operator[]("editor")); - if (author.empty()) - return author; - } + if (author.empty()) + return author; - // FIXME Move this to a separate routine that can - // be called from elsewhere. - // // OK, we've got some names. Let's format them. - // Try to split the author list on " and " - vector const authors = - getVectorFromString(author, from_ascii(" and ")); - - if (jurabib_style && (authors.size() == 2 || authors.size() == 3)) { - docstring shortauthor = familyName(authors[0]) - + "/" + familyName(authors[1]); - if (authors.size() == 3) - shortauthor += "/" + familyName(authors[2]); - return shortauthor; - } + // Try to split the author list + vector const authors = getAuthors(author); - if (authors.size() == 2 && authors[1] != "others") - return bformat(from_ascii("%1$s and %2$s"), - familyName(authors[0]), familyName(authors[1])); - - if (authors.size() >= 2) - return bformat(from_ascii("%1$s et al."), - familyName(authors[0])); - - return familyName(authors[0]); -} + docstring retval; + 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, "B_etal") + : " et al."; + string const namesep = + buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_namesep") + : ", "; + string const lastnamesep = + buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_lastnamesep") + : ", and "; + string const pairnamesep = + buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_pairnamesep") + : " and "; + string firstnameform = + buf ? buf->params().documentClass().getCiteMacro(engine_type, "!firstnameform") + : "{%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}{%prename%[[, %prename%]]}"; + if (!beginning) + firstnameform = buf ? buf->params().documentClass().getCiteMacro(engine_type, "!firstbynameform") + : "%prename% {%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}"; + string othernameform = buf ? buf->params().documentClass().getCiteMacro(engine_type, "!othernameform") + : "{%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}{%prename%[[, %prename%]]}"; + if (!beginning) + othernameform = buf ? buf->params().documentClass().getCiteMacro(engine_type, "!otherbynameform") + : "%prename% {%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}"; + string citenameform = buf ? buf->params().documentClass().getCiteMacro(engine_type, "!citenameform") + : "{%prefix%[[%prefix% ]]}%surname%"; + + // Shorten the list (with et al.) if forceshort is set + // and the list can actually be shortened, else if maxcitenames + // is passed and full is not set. + bool shorten = forceshort && authors.size() > 1; + vector::const_iterator it = authors.begin(); + vector::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); + if (allnames) + retval += (i == 0) ? constructName(*it, firstnameform) + : constructName(*it, othernameform); + else + retval += constructName(*it, citenameform); + } + if (shorten) { + if (allnames) + retval = constructName(authors[0], firstnameform) + (buf ? buf->B_(etal) : from_ascii(etal)); + else + retval = constructName(authors[0], citenameform) + (buf ? buf->B_(etal) : from_ascii(etal)); + } -docstring const BibTeXInfo::getAbbreviatedAuthor(Buffer const & buf, bool jurabib_style) const -{ - docstring const author = getAbbreviatedAuthor(jurabib_style); - if (!is_bibtex_) - return author; - vector const authors = getVectorFromString(author, from_ascii(" and ")); - if (authors.size() == 2) - return bformat(buf.B_("%1$s and %2$s"), authors[0], authors[1]); - docstring::size_type const idx = author.rfind(from_ascii(" et al.")); - if (idx != docstring::npos) - return bformat(buf.B_("%1$s et al."), author.substr(0, idx)); - return author; + return convertLaTeXCommands(retval); } docstring const BibTeXInfo::getYear() const { - if (is_bibtex_) - return operator[]("year"); + if (is_bibtex_) { + // first try legacy year field + docstring year = operator[]("year"); + if (!year.empty()) + return year; + // now try biblatex's date field + year = operator[]("date"); + // 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}).*"); + smatch sm; + string const date = to_utf8(year); + if (!regex_match(date, sm, yreg)) + // cannot parse year. + return docstring(); + year = from_ascii(sm[1]); + // check for an endyear + if (regex_match(date, sm, ereg)) + year += char_type(0x2013) + from_ascii(sm[1]); + return year; + } docstring const opt = label(); if (opt.empty()) @@ -340,47 +645,40 @@ docstring const BibTeXInfo::getYear() const } -docstring const BibTeXInfo::getXRef() const -{ - if (!is_bibtex_) - return docstring(); - return operator[]("crossref"); -} - - namespace { -string parseOptions(string const & format, string & optkey, - string & ifpart, string & elsepart); +docstring parseOptions(docstring const & format, string & optkey, + docstring & ifpart, docstring & elsepart); // Calls parseOptions to deal with an embedded option, such as: // {%number%[[, no.~%number%]]} // which must appear at the start of format. ifelsepart gets the // whole of the option, and we return what's left after the option. // we return format if there is an error. -string parseEmbeddedOption(string const & format, string & ifelsepart) +docstring parseEmbeddedOption(docstring const & format, docstring & ifelsepart) { LASSERT(format[0] == '{' && format[1] == '%', return format); string optkey; - string ifpart; - string elsepart; - string const rest = parseOptions(format, optkey, ifpart, elsepart); + docstring ifpart; + docstring elsepart; + docstring const rest = parseOptions(format, optkey, ifpart, elsepart); if (format == rest) { // parse error LYXERR0("ERROR! Couldn't parse `" << format <<"'."); return format; } - LASSERT(rest.size() <= format.size(), /* */); + LASSERT(rest.size() <= format.size(), + { ifelsepart = docstring(); return format; }); ifelsepart = format.substr(0, format.size() - rest.size()); - return rest; + return rest; } // Gets a "clause" from a format string, where the clause is // delimited by '[[' and ']]'. Returns what is left after the // clause is removed, and returns format if there is an error. -string getClause(string const & format, string & clause) +docstring getClause(docstring const & format, docstring & clause) { - string fmt = format; + docstring fmt = format; // remove '[[' fmt = fmt.substr(2); // we'll remove characters from the front of fmt as we @@ -393,8 +691,8 @@ string getClause(string const & format, string & clause) } // check for an embedded option if (fmt[0] == '{' && fmt.size() > 1 && fmt[1] == '%') { - string part; - string const rest = parseEmbeddedOption(fmt, part); + docstring part; + docstring const rest = parseEmbeddedOption(fmt, part); if (fmt == rest) { LYXERR0("ERROR! Couldn't parse embedded option in `" << format <<"'."); return format; @@ -414,18 +712,18 @@ string getClause(string const & format, string & clause) // format parameter. puts the parsed bits in optkey, ifpart, and // elsepart and returns what's left after the option is removed. // if there's an error, it returns format itself. -string parseOptions(string const & format, string & optkey, - string & ifpart, string & elsepart) +docstring parseOptions(docstring const & format, string & optkey, + docstring & ifpart, docstring & elsepart) { LASSERT(format[0] == '{' && format[1] == '%', return format); // strip '{%' - string fmt = format.substr(2); + docstring fmt = format.substr(2); size_t pos = fmt.find('%'); // end of key if (pos == string::npos) { LYXERR0("Error parsing `" << format <<"'. Can't find end of key."); return format; } - optkey = fmt.substr(0,pos); + optkey = to_utf8(fmt.substr(0, pos)); fmt = fmt.substr(pos + 1); // [[format]] should be next if (fmt[0] != '[' || fmt[1] != '[') { @@ -433,7 +731,7 @@ string parseOptions(string const & format, string & optkey, return format; } - string curfmt = fmt; + docstring curfmt = fmt; fmt = getClause(curfmt, ifpart); if (fmt == curfmt) { LYXERR0("Error parsing `" << format <<"'. Couldn't get if clause."); @@ -460,26 +758,40 @@ string parseOptions(string const & format, string & optkey, } -} // anon namespace - - -docstring BibTeXInfo::expandFormat(string const & format, - BibTeXInfo const * const xref, int & counter, Buffer const & buf, - docstring before, docstring after, docstring dialog, bool next) const +} // namespace + +/* FIXME +Bug #9131 revealed an oddity in how we are generating citation information +when more than one key is given. We end up building a longer and longer format +string as we go, which we then have to re-parse, over and over and over again, +rather than generating the information for the individual keys and then putting +all of that together. We do that to deal with the way separators work, from what +I can tell, but it still feels like a hack. Fixing this would require quite a +bit of work, however. +*/ +docstring BibTeXInfo::expandFormat(docstring const & format, + BibTeXInfoList const xrefs, int & counter, Buffer const & buf, + CiteItem const & ci, bool next, bool second) const { // incorrect use of macros could put us in an infinite loop - static int max_passes = 5000; - docstring ret; // return value + static int const max_passes = 5000; + // the use of overly large keys can lead to performance problems, due + // to eventual attempts to convert LaTeX macros to unicode. See bug + // #8944. By default, the size is limited to 128 (in CiteItem), but + // for specific purposes (such as XHTML export), it needs to be enlarged + // This is perhaps not the best solution, but it will have to do for now. + size_t const max_keysize = ci.max_key_size; + odocstringstream ret; // return value string key; bool scanning_key = false; bool scanning_rich = false; CiteEngineType const engine_type = buf.params().citeEngineType(); - string fmt = format; + docstring fmt = format; // we'll remove characters from the front of fmt as we // deal with them while (!fmt.empty()) { - if (counter++ > max_passes) { + if (counter > max_passes) { LYXERR0("Recursion limit reached while parsing `" << format << "'."); return _("ERROR!"); @@ -496,23 +808,31 @@ docstring BibTeXInfo::expandFormat(string const & format, // macro string const val = buf.params().documentClass().getCiteMacro(engine_type, key); - fmt = val + fmt.substr(1); + fmt = from_utf8(val) + fmt.substr(1); + counter += 1; continue; - } else if (key[0] == '_') { - // a translatable bit + } else if (prefixIs(key, "B_")) { + // a translatable bit (to the Buffer language) string const val = buf.params().documentClass().getCiteMacro(engine_type, key); docstring const trans = translateIfPossible(from_utf8(val), buf.params().language->code()); - ret += trans; + ret << trans; + } else if (key[0] == '_') { + // a translatable bit (to the GUI language) + string const val = + buf.params().documentClass().getCiteMacro(engine_type, key); + docstring const trans = + translateIfPossible(from_utf8(val)); + ret << trans; } else { docstring const val = - getValueForKey(key, buf, before, after, dialog, xref); + getValueForKey(key, buf, ci, xrefs, max_keysize); if (!scanning_rich) - ret += from_ascii("{!!}"); - ret += val; + ret << from_ascii("{!!}"); + ret << val; if (!scanning_rich) - ret += from_ascii("{!!}"); + ret << from_ascii("{!!}"); } } else { // beginning of key @@ -530,23 +850,30 @@ docstring BibTeXInfo::expandFormat(string const & format, if (fmt[1] == '%') { // it is the beginning of an optional format string optkey; - string ifpart; - string elsepart; - string const newfmt = + docstring ifpart; + docstring elsepart; + docstring const newfmt = parseOptions(fmt, optkey, ifpart, elsepart); if (newfmt == fmt) // parse error return _("ERROR!"); fmt = newfmt; docstring const val = - getValueForKey(optkey, buf, before, after, dialog, xref); + getValueForKey(optkey, buf, ci, xrefs); if (optkey == "next" && next) - ret += from_utf8(ifpart); // without expansion - else if (!val.empty()) - ret += expandFormat(ifpart, xref, counter, buf, - before, after, dialog, next); - else if (!elsepart.empty()) - ret += expandFormat(elsepart, xref, counter, buf, - before, after, dialog, next); + ret << ifpart; // without expansion + else if (optkey == "second" && second) { + int newcounter = 0; + ret << expandFormat(ifpart, xrefs, newcounter, buf, + ci, next); + } else if (!val.empty()) { + int newcounter = 0; + ret << expandFormat(ifpart, xrefs, newcounter, buf, + ci, next); + } else if (!elsepart.empty()) { + int newcounter = 0; + ret << expandFormat(elsepart, xrefs, newcounter, buf, + ci, next); + } // fmt will have been shortened for us already continue; } @@ -554,26 +881,31 @@ docstring BibTeXInfo::expandFormat(string const & format, // beginning of rich text scanning_rich = true; fmt = fmt.substr(2); - ret += from_ascii("{!"); + ret << from_ascii("{!"); continue; } } // we are here if '{' was not followed by % or !. // So it's just a character. - ret += thischar; + ret << thischar; } else if (scanning_rich && thischar == '!' && fmt.size() > 1 && fmt[1] == '}') { // end of rich text scanning_rich = false; fmt = fmt.substr(2); - ret += from_ascii("!}"); + ret << from_ascii("!}"); continue; } else if (scanning_key) key += char(thischar); - else - ret += thischar; + else { + try { + ret.put(thischar); + } catch (EncodingException & /* e */) { + LYXERR0("Uncodable character '" << docstring(1, thischar) << " in citation label!"); + } + } fmt = fmt.substr(1); } // for loop if (scanning_key) { @@ -584,13 +916,15 @@ docstring BibTeXInfo::expandFormat(string const & format, LYXERR0("Never found end of rich text in `" << format << "'!"); return _("ERROR!"); } - return ret; + return ret.str(); } -docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref, - Buffer const & buf, bool richtext) const +docstring const & BibTeXInfo::getInfo(BibTeXInfoList const xrefs, + Buffer const & buf, CiteItem const & ci) const { + bool const richtext = ci.richtext; + if (!richtext && !info_.empty()) return info_; if (richtext && !info_richtext_.empty()) @@ -604,35 +938,41 @@ docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref, CiteEngineType const engine_type = buf.params().citeEngineType(); DocumentClass const & dc = buf.params().documentClass(); - string const & format = dc.getCiteFormat(engine_type, to_utf8(entry_type_)); + docstring const & format = + from_utf8(dc.getCiteFormat(engine_type, to_utf8(entry_type_))); int counter = 0; - info_ = expandFormat(format, xref, counter, buf, - docstring(), docstring(), docstring(), false); + info_ = expandFormat(format, xrefs, counter, buf, + ci, false, false); - if (!info_.empty()) { + if (info_.empty()) { + // this probably shouldn't happen + return info_; + } + + if (richtext) { info_richtext_ = convertLaTeXCommands(processRichtext(info_, true)); - info_ = convertLaTeXCommands(processRichtext(info_, false)); - if (richtext) - return info_richtext_; + return info_richtext_; } + + info_ = convertLaTeXCommands(processRichtext(info_, false)); return info_; } -docstring const BibTeXInfo::getLabel(BibTeXInfo const * const xref, - Buffer const & buf, string const & format, bool richtext, - docstring before, docstring after, docstring dialog, bool next) const +docstring const BibTeXInfo::getLabel(BibTeXInfoList const xrefs, + Buffer const & buf, docstring const & format, + CiteItem const & ci, bool next, bool second) const { docstring loclabel; int counter = 0; - loclabel = expandFormat(format, xref, 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); } + return loclabel; } @@ -653,56 +993,149 @@ docstring const & BibTeXInfo::operator[](string const & field) const } -docstring BibTeXInfo::getValueForKey(string const & key, Buffer const & buf, - docstring const & before, docstring const & after, docstring const & dialog, - BibTeXInfo const * const xref) const +docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf, + CiteItem const & ci, BibTeXInfoList const xrefs, size_t maxsize) const { + // anything less is pointless + LASSERT(maxsize >= 16, maxsize = 16); + string key = oldkey; + bool cleanit = false; + if (prefixIs(oldkey, "clean:")) { + key = oldkey.substr(6); + cleanit = true; + } + docstring ret = operator[](key); - if (ret.empty() && xref) - ret = (*xref)[key]; - if (!ret.empty()) - return ret; - // some special keys - // FIXME: dialog, textbefore and textafter have nothing to do with this - if (key == "dialog") - return dialog; - else if (key == "entrytype") - return entry_type_; - else if (key == "key") - return bib_key_; - else if (key == "label") - return label_; - else if (key == "abbrvauthor") - // Special key to provide abbreviated author names. - return getAbbreviatedAuthor(buf, false); - else if (key == "shortauthor") - // When shortauthor is not defined, jurabib automatically - // provides jurabib-style abbreviated author names. We do - // this as well. - return getAbbreviatedAuthor(buf, true); - else if (key == "shorttitle") { - // When shorttitle is not defined, jurabib uses for `article' - // and `periodical' entries the form `journal volume [year]' - // and for other types of entries it uses the `title' field. - if (entry_type_ == "article" || entry_type_ == "periodical") - return operator[]("journal") + " " + operator[]("volume") - + " [" + operator[]("year") + "]"; - else - return operator[]("title"); - } else if (key == "bibentry") { - // Special key to provide the full bibliography entry: see getInfo() - CiteEngineType const engine_type = buf.params().citeEngineType(); - DocumentClass const & dc = buf.params().documentClass(); - string const & format = dc.getCiteFormat(engine_type, to_utf8(entry_type_)); - int counter = 0; - return expandFormat(format, xref, counter, buf, - docstring(), docstring(), docstring(), false); - } else if (key == "textbefore") - return before; - else if (key == "textafter") - return after; - else if (key == "year") - return getYear(); + if (ret.empty() && !xrefs.empty()) { + vector::const_iterator it = xrefs.begin(); + vector::const_iterator en = xrefs.end(); + for (; it != en; ++it) { + if (*it && !(**it)[key].empty()) { + ret = (**it)[key]; + break; + } + } + } + if (ret.empty()) { + // some special keys + // FIXME: dialog, textbefore and textafter have nothing to do with this + if (key == "dialog" && ci.context == CiteItem::Dialog) + ret = from_ascii("x"); // any non-empty string will do + else if (key == "export" && ci.context == CiteItem::Export) + 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 == "ifqualified" && ci.isQualified) + ret = from_ascii("x"); // any non-empty string will do + else if (key == "entrytype") + ret = entry_type_; + else if (prefixIs(key, "ifentrytype:") + && from_ascii(key.substr(12)) == entry_type_) + ret = from_ascii("x"); // any non-empty string will do + else if (key == "key") + ret = bib_key_; + else if (key == "label") + ret = label_; + else if (key == "modifier" && modifier_ != 0) + ret = modifier_; + else if (key == "numericallabel") + ret = cite_number_; + else if (prefixIs(key, "ifmultiple:")) { + // Return whether we have multiple authors + docstring const kind = operator[](from_ascii(key.substr(11))); + if (multipleAuthors(kind)) + ret = from_ascii("x"); // any non-empty string will do + } + else if (prefixIs(key, "abbrvnames:")) { + // Special key to provide abbreviated name list, + // with respect to maxcitenames. Suitable for Bibliography + // beginnings. + docstring const kind = operator[](from_ascii(key.substr(11))); + ret = getAuthorList(&buf, kind, false, false, true); + if (ci.forceUpperCase && isLowerCase(ret[0])) + ret[0] = uppercase(ret[0]); + } else if (prefixIs(key, "fullnames:")) { + // Return a full name list. Suitable for Bibliography + // beginnings. + docstring const kind = operator[](from_ascii(key.substr(10))); + ret = getAuthorList(&buf, kind, true, false, true); + if (ci.forceUpperCase && isLowerCase(ret[0])) + ret[0] = uppercase(ret[0]); + } else if (prefixIs(key, "forceabbrvnames:")) { + // Special key to provide abbreviated name lists, + // irrespective of maxcitenames. Suitable for Bibliography + // beginnings. + docstring const kind = operator[](from_ascii(key.substr(15))); + ret = getAuthorList(&buf, kind, false, true, true); + if (ci.forceUpperCase && isLowerCase(ret[0])) + ret[0] = uppercase(ret[0]); + } else if (prefixIs(key, "abbrvbynames:")) { + // Special key to provide abbreviated name list, + // with respect to maxcitenames. Suitable for further names inside a + // bibliography item // (such as "ed. by ...") + docstring const kind = operator[](from_ascii(key.substr(11))); + ret = getAuthorList(&buf, kind, false, false, true, false); + if (ci.forceUpperCase && isLowerCase(ret[0])) + ret[0] = uppercase(ret[0]); + } else if (prefixIs(key, "fullbynames:")) { + // Return a full name list. Suitable for further names inside a + // bibliography item // (such as "ed. by ...") + docstring const kind = operator[](from_ascii(key.substr(10))); + ret = getAuthorList(&buf, kind, true, false, true, false); + if (ci.forceUpperCase && isLowerCase(ret[0])) + ret[0] = uppercase(ret[0]); + } else if (prefixIs(key, "forceabbrvbynames:")) { + // Special key to provide abbreviated name lists, + // irrespective of maxcitenames. Suitable for further names inside a + // bibliography item // (such as "ed. by ...") + docstring const kind = operator[](from_ascii(key.substr(15))); + ret = getAuthorList(&buf, kind, false, true, true, false); + if (ci.forceUpperCase && isLowerCase(ret[0])) + ret[0] = uppercase(ret[0]); + } else if (key == "abbrvciteauthor") { + // Special key to provide abbreviated author or + // editor names (suitable for citation labels), + // with respect to maxcitenames. + ret = getAuthorOrEditorList(&buf, false, false); + if (ci.forceUpperCase && isLowerCase(ret[0])) + ret[0] = uppercase(ret[0]); + } else if (key == "fullciteauthor") { + // Return a full author or editor list (for citation labels) + ret = getAuthorOrEditorList(&buf, true, false); + if (ci.forceUpperCase && isLowerCase(ret[0])) + ret[0] = uppercase(ret[0]); + } else if (key == "forceabbrvciteauthor") { + // Special key to provide abbreviated author or + // editor names (suitable for citation labels), + // irrespective of maxcitenames. + ret = getAuthorOrEditorList(&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(); + DocumentClass const & dc = buf.params().documentClass(); + docstring const & format = + from_utf8(dc.getCiteFormat(engine_type, to_utf8(entry_type_), false)); + int counter = 0; + ret = expandFormat(format, xrefs, counter, buf, ci, false, false); + } else if (key == "textbefore") + ret = ci.textBefore; + else if (key == "textafter") + ret = ci.textAfter; + else if (key == "curpretext") + ret = ci.getPretexts()[bib_key_]; + else if (key == "curposttext") + ret = ci.getPosttexts()[bib_key_]; + else if (key == "year") + ret = getYear(); + } + + if (cleanit) + ret = html::cleanAttr(ret); + + // make sure it is not too big + support::truncateWithEllipsis(ret, maxsize); return ret; } @@ -724,7 +1157,47 @@ public: } }; -} // namespace anon +} // namespace + + +vector const BiblioInfo::getXRefs(BibTeXInfo const & data, bool const nested) const +{ + vector result; + if (!data.isBibTeX()) + return result; + // Legacy crossref field. This is not nestable. + 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 & xref = it->second; + vector 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 const xdatakeys = getVectorFromString(data["xdata"]); + if (!xdatakeys.empty()) { + vector::const_iterator xit = xdatakeys.begin(); + vector::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 const nxdata = getXRefs(xdata, true); + if (!nxdata.empty()) + result.insert(result.end(), nxdata.begin(), nxdata.end()); + } + } + } + return result; +} vector const BiblioInfo::getKeys() const @@ -762,13 +1235,13 @@ vector const BiblioInfo::getEntries() const } -docstring const BiblioInfo::getAbbreviatedAuthor(docstring const & key, Buffer const & buf) const +docstring const BiblioInfo::getAuthorOrEditorList(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.getAuthorOrEditorList(&buf, false); } @@ -790,17 +1263,23 @@ docstring const BiblioInfo::getYear(docstring const & key, bool use_modifier) co BibTeXInfo const & data = it->second; docstring year = data.getYear(); if (year.empty()) { - // let's try the crossref - docstring const xref = data.getXRef(); - if (xref.empty()) + // let's try the crossrefs + vector const xrefs = getXRefs(data); + if (xrefs.empty()) // no luck return docstring(); - BiblioInfo::const_iterator const xrefit = find(xref); - if (xrefit == end()) - // no luck again - return docstring(); - BibTeXInfo const & xref_data = xrefit->second; - year = xref_data.getYear(); + vector::const_iterator it = xrefs.begin(); + vector::const_iterator en = xrefs.end(); + for (; it != en; ++it) { + BiblioInfo::const_iterator const xrefit = find(*it); + if (xrefit == end()) + continue; + BibTeXInfo const & xref_data = xrefit->second; + year = xref_data.getYear(); + if (!year.empty()) + // success! + break; + } } if (use_modifier && data.modifier() != 0) year += data.modifier(); @@ -818,80 +1297,100 @@ 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()) return docstring(_("Bibliography entry not found!")); BibTeXInfo const & data = it->second; - BibTeXInfo const * xrefptr = 0; - docstring const xref = data.getXRef(); - if (!xref.empty()) { - BiblioInfo::const_iterator const xrefit = find(xref); - if (xrefit != end()) - xrefptr = &(xrefit->second); + BibTeXInfoList xrefptrs; + vector const xrefs = getXRefs(data); + if (!xrefs.empty()) { + vector::const_iterator it = xrefs.begin(); + vector::const_iterator en = xrefs.end(); + for (; it != en; ++it) { + BiblioInfo::const_iterator const xrefit = find(*it); + if (xrefit != end()) + xrefptrs.push_back(&(xrefit->second)); + } } - return data.getInfo(xrefptr, buf, richtext); + return data.getInfo(xrefptrs, buf, ci); } -docstring const BiblioInfo::getLabel(vector const & keys, - Buffer const & buf, string const & style, bool richtext, - docstring const & before, docstring const & after, docstring const & dialog) const +docstring const BiblioInfo::getLabel(vector keys, + 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); + + // we can't display more than 10 of these, anyway + bool const too_many_keys = keys.size() > 10; + if (too_many_keys) + keys.resize(10); + CiteEngineType const engine_type = buf.params().citeEngineType(); DocumentClass const & dc = buf.params().documentClass(); - string const & format = dc.getCiteFormat(engine_type, style, "cite"); - docstring ret = from_utf8(format); + docstring const & format = from_utf8(dc.getCiteFormat(engine_type, style, false, "cite")); + docstring ret = format; vector::const_iterator key = keys.begin(); vector::const_iterator ken = keys.end(); - for (; key != ken; ++key) { + for (int i = 0; key != ken; ++key, ++i) { BiblioInfo::const_iterator it = find(*key); BibTeXInfo empty_data; empty_data.key(*key); BibTeXInfo & data = empty_data; - BibTeXInfo const * xrefptr = 0; + vector xrefptrs; if (it != end()) { data = it->second; - docstring const xref = data.getXRef(); - if (!xref.empty()) { - BiblioInfo::const_iterator const xrefit = find(xref); - if (xrefit != end()) - xrefptr = &(xrefit->second); + vector const xrefs = getXRefs(data); + if (!xrefs.empty()) { + vector::const_iterator it = xrefs.begin(); + vector::const_iterator en = xrefs.end(); + for (; it != en; ++it) { + BiblioInfo::const_iterator const xrefit = find(*it); + if (xrefit != end()) + xrefptrs.push_back(&(xrefit->second)); + } } } - ret = data.getLabel(xrefptr, buf, to_utf8(ret), richtext, - before, after, dialog, key+1 != ken); + ret = data.getLabel(xrefptrs, buf, ret, ci, key + 1 != ken, i == 1); } + + if (too_many_keys) + ret.push_back(0x2026);//HORIZONTAL ELLIPSIS + support::truncateWithEllipsis(ret, max_size); return ret; } bool BiblioInfo::isBibtex(docstring const & key) const { - BiblioInfo::const_iterator it = find(key); + docstring key1; + split(key, key1, ','); + BiblioInfo::const_iterator it = find(key1); if (it == end()) return false; return it->second.isBibTeX(); } -vector const BiblioInfo::getCiteStrings( +BiblioInfo::CiteStringMap const BiblioInfo::getCiteStrings( vector const & keys, vector const & styles, - Buffer const & buf, bool richtext, docstring const & before, - docstring const & after, docstring const & dialog) const + Buffer const & buf, CiteItem const & ci) const { if (empty()) - return vector(); + return vector>(); string style; - vector vec(styles.size()); - for (size_t i = 0; i != vec.size(); ++i) { - style = styles[i].cmd; - vec[i] = getLabel(keys, buf, style, richtext, before, after, dialog); + CiteStringMap csm(styles.size()); + for (size_t i = 0; i != csm.size(); ++i) { + style = styles[i].name; + csm[i] = make_pair(from_ascii(style), getLabel(keys, buf, style, ci)); } - return vec; + return csm; } @@ -908,8 +1407,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->getAuthorOrEditorList(); + docstring const rauth = rhs->getAuthorOrEditorList(); docstring const lyear = lhs->getYear(); docstring const ryear = rhs->getYear(); docstring const ltitl = lhs->operator[]("title"); @@ -919,7 +1418,7 @@ bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs) || (lauth == rauth && lyear == ryear && ltitl < rtitl); } -} +} // namespace void BiblioInfo::collectCitedEntries(Buffer const & buf) @@ -930,9 +1429,9 @@ void BiblioInfo::collectCitedEntries(Buffer const & buf) // FIXME We may want to collect these differently, in the first case, // so that we might have them in order of appearance. set citekeys; - Toc const & toc = buf.tocBackend().toc("citation"); - Toc::const_iterator it = toc.begin(); - Toc::const_iterator const en = toc.end(); + shared_ptr toc = buf.tocBackend().toc("citation"); + Toc::const_iterator it = toc->begin(); + Toc::const_iterator const en = toc->end(); for (; it != en; ++it) { if (it->str().empty()) continue; @@ -969,14 +1468,14 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf) { collectCitedEntries(buf); CiteEngineType const engine_type = buf.params().citeEngineType(); - bool const numbers = (engine_type == ENGINE_TYPE_NUMERICAL); + bool const numbers = (engine_type & ENGINE_TYPE_NUMERICAL); int keynumber = 0; char modifier = 0; // used to remember the last one we saw // we'll be comparing entries to see if we need to add // modifiers, like "1984a" - map::iterator last; + map::iterator last = bimap_.end(); vector::const_iterator it = cited_entries_.begin(); vector::const_iterator const en = cited_entries_.end(); @@ -991,8 +1490,11 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf) docstring const num = convert(++keynumber); entry.setCiteNumber(num); } else { - if (it != cited_entries_.begin() - && entry.getAbbreviatedAuthor() == last->second.getAbbreviatedAuthor() + // The first test here is checking whether this is the first + // time through the loop. If so, then we do not have anything + // with which to compare. + if (last != bimap_.end() + && entry.getAuthorOrEditorList() == last->second.getAuthorOrEditorList() // 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())) { @@ -1024,7 +1526,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.getAuthorOrEditorList(&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); @@ -1044,35 +1546,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] = 'C'; - if (cs.fullAuthorList) + cmd[0] = uppercase(cmd[0]); + if (cs.hasStarredVersion) cmd += '*'; return cmd; }