+docstring const BibTeXInfo::getXRef() const
+{
+ if (!is_bibtex_)
+ return docstring();
+ return operator[]("crossref");
+}
+
+
+namespace {
+
+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.
+docstring parseEmbeddedOption(docstring const & format, docstring & ifelsepart)
+{
+ LASSERT(format[0] == '{' && format[1] == '%', return format);
+ string optkey;
+ 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(),
+ { ifelsepart = docstring(); return format; });
+ ifelsepart = format.substr(0, format.size() - rest.size());
+ 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.
+docstring getClause(docstring const & format, docstring & clause)
+{
+ docstring fmt = format;
+ // remove '[['
+ fmt = fmt.substr(2);
+ // we'll remove characters from the front of fmt as we
+ // deal with them
+ while (!fmt.empty()) {
+ if (fmt[0] == ']' && fmt.size() > 1 && fmt[1] == ']') {
+ // that's the end
+ fmt = fmt.substr(2);
+ break;
+ }
+ // check for an embedded option
+ if (fmt[0] == '{' && fmt.size() > 1 && fmt[1] == '%') {
+ docstring part;
+ docstring const rest = parseEmbeddedOption(fmt, part);
+ if (fmt == rest) {
+ LYXERR0("ERROR! Couldn't parse embedded option in `" << format <<"'.");
+ return format;
+ }
+ clause += part;
+ fmt = rest;
+ } else { // it's just a normal character
+ clause += fmt[0];
+ fmt = fmt.substr(1);
+ }
+ }
+ return fmt;
+}
+
+
+// parse an options string, which must appear at the start of the
+// 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.
+docstring parseOptions(docstring const & format, string & optkey,
+ docstring & ifpart, docstring & elsepart)
+{
+ LASSERT(format[0] == '{' && format[1] == '%', return format);
+ // strip '{%'
+ 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 = to_utf8(fmt.substr(0, pos));
+ fmt = fmt.substr(pos + 1);
+ // [[format]] should be next
+ if (fmt[0] != '[' || fmt[1] != '[') {
+ LYXERR0("Error parsing `" << format <<"'. Can't find '[[' after key.");
+ return format;
+ }
+
+ docstring curfmt = fmt;
+ fmt = getClause(curfmt, ifpart);
+ if (fmt == curfmt) {
+ LYXERR0("Error parsing `" << format <<"'. Couldn't get if clause.");
+ return format;
+ }
+
+ if (fmt[0] == '}') // we're done, no else clause
+ return fmt.substr(1);
+
+ // else part should follow
+ if (fmt[0] != '[' || fmt[1] != '[') {
+ LYXERR0("Error parsing `" << format <<"'. Can't find else clause.");
+ return format;
+ }
+
+ curfmt = fmt;
+ fmt = getClause(curfmt, elsepart);
+ // we should be done
+ if (fmt == curfmt || fmt[0] != '}') {
+ LYXERR0("Error parsing `" << format <<"'. Can't find end of option.");
+ return format;
+ }
+ return fmt.substr(1);
+}
+
+
+} // anon 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,
+ BibTeXInfo const * const xref, int & counter, Buffer const & buf,
+ docstring before, docstring after, docstring dialog, bool next) const
+{
+ // incorrect use of macros could put us in an infinite loop
+ 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. This is perhaps not the best solution, but it will have to
+ // do for now.
+ static size_t const max_keysize = 128;
+ odocstringstream ret; // return value
+ string key;
+ bool scanning_key = false;
+ bool scanning_rich = false;
+
+ CiteEngineType const engine_type = buf.params().citeEngineType();
+ docstring fmt = format;
+ // we'll remove characters from the front of fmt as we
+ // deal with them
+ while (!fmt.empty()) {
+ if (counter > max_passes) {
+ LYXERR0("Recursion limit reached while parsing `"
+ << format << "'.");
+ return _("ERROR!");
+ }
+
+ char_type thischar = fmt[0];
+ if (thischar == '%') {
+ // beginning or end of key
+ if (scanning_key) {
+ // end of key
+ scanning_key = false;
+ // so we replace the key with its value, which may be empty
+ if (key[0] == '!') {
+ // macro
+ string const val =
+ buf.params().documentClass().getCiteMacro(engine_type, key);
+ fmt = from_utf8(val) + fmt.substr(1);
+ counter += 1;
+ continue;
+ } else if (key[0] == '_') {
+ // a translatable bit
+ string const val =
+ buf.params().documentClass().getCiteMacro(engine_type, key);
+ docstring const trans =
+ translateIfPossible(from_utf8(val), buf.params().language->code());
+ ret << trans;
+ } else {
+ docstring const val =
+ getValueForKey(key, buf, before, after, dialog, xref, max_keysize);
+ if (!scanning_rich)
+ ret << from_ascii("{!<span class=\"bib-" + key + "\">!}");
+ ret << val;
+ if (!scanning_rich)
+ ret << from_ascii("{!</span>!}");
+ }
+ } else {
+ // beginning of key
+ key.clear();
+ scanning_key = true;
+ }
+ }
+ else if (thischar == '{') {
+ // beginning of option?
+ if (scanning_key) {
+ LYXERR0("ERROR: Found `{' when scanning key in `" << format << "'.");
+ return _("ERROR!");
+ }
+ if (fmt.size() > 1) {
+ if (fmt[1] == '%') {
+ // it is the beginning of an optional format
+ string optkey;
+ 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);
+ if (optkey == "next" && next)
+ ret << ifpart; // without expansion
+ else if (!val.empty()) {
+ int newcounter = 0;
+ ret << expandFormat(ifpart, xref, newcounter, buf,
+ before, after, dialog, next);
+ } else if (!elsepart.empty()) {
+ int newcounter = 0;
+ ret << expandFormat(elsepart, xref, newcounter, buf,
+ before, after, dialog, next);
+ }
+ // fmt will have been shortened for us already
+ continue;
+ }
+ if (fmt[1] == '!') {
+ // beginning of rich text
+ scanning_rich = true;
+ fmt = fmt.substr(2);
+ ret << from_ascii("{!");
+ continue;
+ }
+ }
+ // we are here if '{' was not followed by % or !.
+ // So it's just a character.
+ 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("!}");
+ continue;
+ }
+ else if (scanning_key)
+ key += char(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) {
+ LYXERR0("Never found end of key in `" << format << "'!");
+ return _("ERROR!");
+ }
+ if (scanning_rich) {
+ LYXERR0("Never found end of rich text in `" << format << "'!");
+ return _("ERROR!");
+ }
+ return ret.str();
+}
+
+
+docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref,
+ Buffer const & buf, bool richtext) const