src/BiblioInfo.cpp

   1 /**
   2  * \file BiblioInfo.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  * \author Herbert Voß
   8  * \author Richard Heck
   9  * \author Julien Rioux
  10  * \author Jürgen Spitzmüller
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "BiblioInfo.h"
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "buffer_funcs.h"
  21 #include "Citation.h"
  22 #include "Encoding.h"
  23 #include "InsetIterator.h"
  24 #include "Language.h"
  25 #include "output_xhtml.h"
  26 #include "Paragraph.h"
  27 #include "TextClass.h"
  28 #include "TocBackend.h"
  29
  30 #include "support/convert.h"
  31 #include "support/debug.h"
  32 #include "support/docstream.h"
  33 #include "support/gettext.h"
  34 #include "support/lassert.h"
  35 #include "support/lstrings.h"
  36 #include "support/regex.h"
  37 #include "support/textutils.h"
  38
  39 #include <map>
  40 #include <set>
  41
  42 using namespace std;
  43 using namespace lyx::support;
  44
  45
  46 namespace lyx {
  47
  48 namespace {
  49
  50 // Remove placeholders from names
  51 docstring renormalize(docstring const & input)
  52 {
  53         docstring res = subst(input, from_ascii("$$space!"), from_ascii(" "));
  54         return subst(res, from_ascii("$$comma!"), from_ascii(","));
  55 }
  56
  57
  58 // Split the surname into prefix ("von-part") and family name
  59 pair<docstring, docstring> parseSurname(docstring const & sname)
  60 {
  61         // Split the surname into its tokens
  62         vector<docstring> pieces = getVectorFromString(sname, from_ascii(" "));
  63         if (pieces.size() < 2)
  64                 return make_pair(docstring(), sname);
  65
  66         // Now we look for pieces that begin with a lower case letter.
  67         // All except for the very last token constitute the "von-part".
  68         docstring prefix;
  69         vector<docstring>::const_iterator it = pieces.begin();
  70         vector<docstring>::const_iterator const en = pieces.end();
  71         bool first = true;
  72         for (; it != en; ++it) {
  73                 if ((*it).empty())
  74                         continue;
  75                 // If this is the last piece, then what we now have is
  76                 // the family name, notwithstanding the casing.
  77                 if (it + 1 == en)
  78                         break;
  79                 char_type const c = (*it)[0];
  80                 // If the piece starts with a upper case char, we assume
  81                 // this is part of the surname.
  82                 if (!isLower(c))
  83                         break;
  84                 // Nothing of the former, so add this piece to the prename
  85                 if (!first)
  86                         prefix += " ";
  87                 else
  88                         first = false;
  89                 prefix += *it;
  90         }
  91
  92         // Reconstruct the family name.
  93         // Note that if we left the loop with because it + 1 == en,
  94         // then this will still do the right thing, i.e., make surname
  95         // just be the last piece.
  96         docstring surname;
  97         first = true;
  98         for (; it != en; ++it) {
  99                 if (!first)
 100                         surname += " ";
 101                 else
 102                         first = false;
 103                 surname += *it;
 104         }
 105         return make_pair(prefix, surname);
 106 }
 107
 108
 109 struct name_parts {
 110         docstring surname;
 111         docstring prename;
 112         docstring suffix;
 113         docstring prefix;
 114 };
 115
 116
 117 // gets the name parts (prename, surname, prefix, suffix) from an author-type string
 118 name_parts nameParts(docstring const & iname)
 119 {
 120         name_parts res;
 121         if (iname.empty())
 122                 return res;
 123
 124         // First we check for goupings (via {...}) and replace blanks and
 125         // commas inside groups with temporary placeholders
 126         docstring name;
 127         int gl = 0;
 128         docstring::const_iterator p = iname.begin();
 129         while (p != iname.end()) {
 130                 // count grouping level
 131                 if (*p == '{')
 132                         ++gl;
 133                 else if (*p == '}')
 134                         --gl;
 135                 // generate string with probable placeholders
 136                 if (*p == ' ' && gl > 0)
 137                         name += from_ascii("$$space!");
 138                 else if (*p == ',' && gl > 0)
 139                         name += from_ascii("$$comma!");
 140                 else
 141                         name += *p;
 142                 ++p;
 143         }
 144
 145         // Now we look for a comma, and take the last name to be everything
 146         // preceding the right-most one, so that we also get the name suffix
 147         // (aka "jr" part).
 148         vector<docstring> pieces = getVectorFromString(name);
 149         if (pieces.size() > 1) {
 150                 // Whether we have a name suffix or not, the prename is
 151                 // always last item
 152                 res.prename = renormalize(pieces.back());
 153                 // The family name, conversely, is always the first item.
 154                 // However, it might contain a prefix (aka "von" part)
 155                 docstring const sname = pieces.front();
 156                 res.prefix = renormalize(parseSurname(sname).first);
 157                 res.surname = renormalize(parseSurname(sname).second);
 158                 // If we have three pieces (the maximum allowed by BibTeX),
 159                 // the second one is the name suffix.
 160                 if (pieces.size() > 2)
 161                         res.suffix = renormalize(pieces.at(1));
 162                 return res;
 163         }
 164
 165         // OK, so now we want to look for the last name.
 166         // Split on spaces, to get various tokens.
 167         pieces = getVectorFromString(name, from_ascii(" "));
 168         // No space: Only a family name given
 169         if (pieces.size() < 2) {
 170                 res.surname = renormalize(pieces.back());
 171                 return res;
 172         }
 173         // If we get two pieces, assume "prename surname"
 174         if (pieces.size() == 2) {
 175                 res.prename = renormalize(pieces.front());
 176                 res.surname = renormalize(pieces.back());
 177                 return res;
 178         }
 179
 180         // More than 3 pieces: A name prefix (aka "von" part) might be included.
 181         // We look for the first piece that begins with a lower case letter
 182         // (which is the name prefix, if it is not the last token) or the last token.
 183         docstring prename;
 184         vector<docstring>::const_iterator it = pieces.begin();
 185         vector<docstring>::const_iterator const en = pieces.end();
 186         bool first = true;
 187         for (; it != en; ++it) {
 188                 if ((*it).empty())
 189                         continue;
 190                 char_type const c = (*it)[0];
 191                 // If the piece starts with a lower case char, we assume
 192                 // this is the name prefix and thus prename is complete.
 193                 if (isLower(c))
 194                         break;
 195                 // Same if this is the last piece, which is always the surname.
 196                 if (it + 1 == en)
 197                         break;
 198                 // Nothing of the former, so add this piece to the prename
 199                 if (!first)
 200                         prename += " ";
 201                 else
 202                         first = false;
 203                 prename += *it;
 204         }
 205
 206         // Now reconstruct the family name and strip the prefix.
 207         // Note that if we left the loop because it + 1 == en,
 208         // then this will still do the right thing, i.e., make surname
 209         // just be the last piece.
 210         docstring surname;
 211         first = true;
 212         for (; it != en; ++it) {
 213                 if (!first)
 214                         surname += " ";
 215                 else
 216                         first = false;
 217                 surname += *it;
 218         }
 219         res.prename = renormalize(prename);
 220         res.prefix = renormalize(parseSurname(surname).first);
 221         res.surname = renormalize(parseSurname(surname).second);
 222         return res;
 223 }
 224
 225
 226 docstring constructName(docstring const & name, string const & scheme)
 227 {
 228         // re-constructs a name from name parts according
 229         // to a given scheme
 230         docstring const prename = nameParts(name).prename;
 231         docstring const surname = nameParts(name).surname;
 232         docstring const prefix = nameParts(name).prefix;
 233         docstring const suffix = nameParts(name).suffix;
 234         string res = scheme;
 235         static regex const reg1("(.*)(\\{%prename%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)");
 236         static regex const reg2("(.*)(\\{%suffix%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)");
 237         static regex const reg3("(.*)(\\{%prefix%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)");
 238         smatch sub;
 239         // Changing the first parameter of regex_match() may corrupt the
 240         // second one. In this case we use the temporary string tmp.
 241         if (regex_match(scheme, sub, reg1)) {
 242                 res = sub.str(1);
 243                 if (!prename.empty())
 244                         res += sub.str(3);
 245                 res += sub.str(5);
 246         }
 247         if (regex_match(res, sub, reg2)) {
 248                 string tmp = sub.str(1);
 249                 if (!suffix.empty())
 250                         tmp += sub.str(3);
 251                 res = tmp + sub.str(5);
 252         }
 253         if (regex_match(res, sub, reg3)) {
 254                 string tmp = sub.str(1);
 255                 if (!prefix.empty())
 256                         tmp += sub.str(3);
 257                 res = tmp + sub.str(5);
 258         }
 259         docstring result = from_ascii(res);
 260         result = subst(result, from_ascii("%prename%"), prename);
 261         result = subst(result, from_ascii("%surname%"), surname);
 262         result = subst(result, from_ascii("%prefix%"), prefix);
 263         result = subst(result, from_ascii("%suffix%"), suffix);
 264         return result;
 265 }
 266
 267
 268 vector<docstring> const getAuthors(docstring const & author)
 269 {
 270         // We check for goupings (via {...}) and only consider " and "
 271         // outside groups as author separator. This is to account
 272         // for cases such as {{Barnes and Noble, Inc.}}, which
 273         // need to be treated as one single family name.
 274         // We use temporary placeholders in order to differentiate the
 275         // diverse " and " cases.
 276
 277         // First, we temporarily replace all ampersands. It is rather unusual
 278         // in author names, but can happen (consider cases such as "C \& A Corp.").
 279         docstring iname = subst(author, from_ascii("&"), from_ascii("$$amp!"));
 280         // Then, we temporarily make all " and " strings to ampersands in order
 281         // to handle them later on a per-char level.
 282         iname = subst(iname, from_ascii(" and "), from_ascii(" & "));
 283         // Now we traverse through the string and replace the "&" by the proper
 284         // output in- and outside groups
 285         docstring name;
 286         int gl = 0;
 287         docstring::const_iterator p = iname.begin();
 288         while (p != iname.end()) {
 289                 // count grouping level
 290                 if (*p == '{')
 291                         ++gl;
 292                 else if (*p == '}')
 293                         --gl;
 294                 // generate string with probable placeholders
 295                 if (*p == '&') {
 296                         if (gl > 0)
 297                                 // Inside groups, we output "and"
 298                                 name += from_ascii("and");
 299                         else
 300                                 // Outside groups, we output a separator
 301                                 name += from_ascii("$$namesep!");
 302                 }
 303                 else
 304                         name += *p;
 305                 ++p;
 306         }
 307
 308         // re-insert the literal ampersands
 309         name = subst(name, from_ascii("$$amp!"), from_ascii("&"));
 310
 311         // Now construct the actual vector
 312         return getVectorFromString(name, from_ascii(" $$namesep! "));
 313 }
 314
 315
 316 bool multipleAuthors(docstring const & author)
 317 {
 318         return getAuthors(author).size() > 1;
 319 }
 320
 321
 322 // converts a string containing LaTeX commands into unicode
 323 // for display.
 324 docstring convertLaTeXCommands(docstring const & str)
 325 {
 326         docstring val = str;
 327         docstring ret;
 328
 329         bool scanning_cmd = false;
 330         bool scanning_math = false;
 331         bool escaped = false; // used to catch \$, etc.
 332         while (!val.empty()) {
 333                 char_type const ch = val[0];
 334
 335                 // if we're scanning math, we output everything until we
 336                 // find an unescaped $, at which point we break out.
 337                 if (scanning_math) {
 338                         if (escaped)
 339                                 escaped = false;
 340                         else if (ch == '\\')
 341                                 escaped = true;
 342                         else if (ch == '$')
 343                                 scanning_math = false;
 344                         ret += ch;
 345                         val = val.substr(1);
 346                         continue;
 347                 }
 348
 349                 // if we're scanning a command name, then we just
 350                 // discard characters until we hit something that
 351                 // isn't alpha.
 352                 if (scanning_cmd) {
 353                         if (isAlphaASCII(ch)) {
 354                                 val = val.substr(1);
 355                                 escaped = false;
 356                                 continue;
 357                         }
 358                         // so we're done with this command.
 359                         // now we fall through and check this character.
 360                         scanning_cmd = false;
 361                 }
 362
 363                 // was the last character a \? If so, then this is something like:
 364                 // \\ or \$, so we'll just output it. That's probably not always right...
 365                 if (escaped) {
 366                         // exception: output \, as THIN SPACE
 367                         if (ch == ',')
 368                                 ret.push_back(0x2009);
 369                         else
 370                                 ret += ch;
 371                         val = val.substr(1);
 372                         escaped = false;
 373                         continue;
 374                 }
 375
 376                 if (ch == '$') {
 377                         ret += ch;
 378                         val = val.substr(1);
 379                         scanning_math = true;
 380                         continue;
 381                 }
 382
 383                 // Change text mode accents in the form
 384                 // {\v a} to \v{a} (see #9340).
 385                 // FIXME: This is a sort of mini-tex2lyx.
 386                 //        Use the real tex2lyx instead!
 387                 static lyx::regex const tma_reg("^\\{\\\\[bcCdfGhHkrtuUv]\\s\\w\\}");
 388                 if (lyx::regex_search(to_utf8(val), tma_reg)) {
 389                         val = val.substr(1);
 390                         val.replace(2, 1, from_ascii("{"));
 391                         continue;
 392                 }
 393
 394                 // Apart from the above, we just ignore braces
 395                 if (ch == '{' || ch == '}') {
 396                         val = val.substr(1);
 397                         continue;
 398                 }
 399
 400                 // we're going to check things that look like commands, so if
 401                 // this doesn't, just output it.
 402                 if (ch != '\\') {
 403                         ret += ch;
 404                         val = val.substr(1);
 405                         continue;
 406                 }
 407
 408                 // ok, could be a command of some sort
 409                 // let's see if it corresponds to some unicode
 410                 // unicodesymbols has things in the form: \"{u},
 411                 // whereas we may see things like: \"u. So we'll
 412                 // look for that and change it, if necessary.
 413                 // FIXME: This is a sort of mini-tex2lyx.
 414                 //        Use the real tex2lyx instead!
 415                 static lyx::regex const reg("^\\\\\\W\\w");
 416                 if (lyx::regex_search(to_utf8(val), reg)) {
 417                         val.insert(3, from_ascii("}"));
 418                         val.insert(2, from_ascii("{"));
 419                 }
 420                 bool termination;
 421                 docstring rem;
 422                 docstring const cnvtd = Encodings::fromLaTeXCommand(val,
 423                                 Encodings::TEXT_CMD, termination, rem);
 424                 if (!cnvtd.empty()) {
 425                         // it did, so we'll take that bit and proceed with what's left
 426                         ret += cnvtd;
 427                         val = rem;
 428                         continue;
 429                 }
 430                 // it's a command of some sort
 431                 scanning_cmd = true;
 432                 escaped = true;
 433                 val = val.substr(1);
 434         }
 435         return ret;
 436 }
 437
 438
 439 // Escape '<' and '>' and remove richtext markers (e.g. {!this is richtext!}) from a string.
 440 docstring processRichtext(docstring const & str, bool richtext)
 441 {
 442         docstring val = str;
 443         docstring ret;
 444
 445         bool scanning_rich = false;
 446         while (!val.empty()) {
 447                 char_type const ch = val[0];
 448                 if (ch == '{' && val.size() > 1 && val[1] == '!') {
 449                         // beginning of rich text
 450                         scanning_rich = true;
 451                         val = val.substr(2);
 452                         continue;
 453                 }
 454                 if (scanning_rich && ch == '!' && val.size() > 1 && val[1] == '}') {
 455                         // end of rich text
 456                         scanning_rich = false;
 457                         val = val.substr(2);
 458                         continue;
 459                 }
 460                 if (richtext) {
 461                         if (scanning_rich)
 462                                 ret += ch;
 463                         else {
 464                                 // we need to escape '<' and '>'
 465                                 if (ch == '<')
 466                                         ret += "&lt;";
 467                                 else if (ch == '>')
 468                                         ret += "&gt;";
 469                                 else
 470                                         ret += ch;
 471                         }
 472                 } else if (!scanning_rich /* && !richtext */)
 473                         ret += ch;
 474                 // else the character is discarded, which will happen only if
 475                 // richtext == false and we are scanning rich text
 476                 val = val.substr(1);
 477         }
 478         return ret;
 479 }
 480
 481 } // namespace
 482
 483
 484 //////////////////////////////////////////////////////////////////////
 485 //
 486 // BibTeXInfo
 487 //
 488 //////////////////////////////////////////////////////////////////////
 489
 490 BibTeXInfo::BibTeXInfo(docstring const & key, docstring const & type)
 491         : is_bibtex_(true), bib_key_(key), num_bib_key_(0), entry_type_(type), info_(),
 492           modifier_(0)
 493 {}
 494
 495
 496
 497 docstring const BibTeXInfo::getAuthorOrEditorList(Buffer const * buf,
 498                                           bool full, bool forceshort) const
 499 {
 500         docstring author = operator[]("author");
 501         if (author.empty())
 502                 author = operator[]("editor");
 503
 504         return getAuthorList(buf, author, full, forceshort);
 505 }
 506
 507
 508 docstring const BibTeXInfo::getAuthorList(Buffer const * buf,
 509                 docstring const & author, bool const full, bool const forceshort,
 510                 bool const allnames, bool const beginning) const
 511 {
 512         // Maxnames treshold depend on engine
 513         size_t maxnames = buf ?
 514                 buf->params().documentClass().max_citenames() : 2;
 515
 516         if (!is_bibtex_) {
 517                 docstring const opt = label();
 518                 if (opt.empty())
 519                         return docstring();
 520
 521                 docstring authors;
 522                 docstring const remainder = trim(split(opt, authors, '('));
 523                 if (remainder.empty())
 524                         // in this case, we didn't find a "(",
 525                         // so we don't have author (year)
 526                         return docstring();
 527                 if (full) {
 528                         // Natbib syntax is "Jones et al.(1990)Jones, Baker, and Williams"
 529                         docstring const fullauthors = trim(rsplit(remainder, ')'));
 530                         if (!fullauthors.empty())
 531                                 return fullauthors;
 532                 }
 533                 return authors;
 534         }
 535
 536         if (author.empty())
 537                 return author;
 538
 539         // OK, we've got some names. Let's format them.
 540         // Try to split the author list
 541         vector<docstring> const authors = getAuthors(author);
 542
 543         docstring retval;
 544
 545         CiteEngineType const engine_type = buf ? buf->params().citeEngineType()
 546                                                : ENGINE_TYPE_DEFAULT;
 547
 548         // These are defined in the styles
 549         string const etal =
 550                 buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_etal")
 551                     : " et al.";
 552         string const namesep =
 553                 buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_namesep")
 554                    : ", ";
 555         string const lastnamesep =
 556                 buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_lastnamesep")
 557                     : ", and ";
 558         string const pairnamesep =
 559                 buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_pairnamesep")
 560                      : " and ";
 561         string firstnameform =
 562                         buf ? buf->params().documentClass().getCiteMacro(engine_type, "!firstnameform")
 563                              : "{%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}{%prename%[[, %prename%]]}";
 564         if (!beginning)
 565                 firstnameform = buf ? buf->params().documentClass().getCiteMacro(engine_type, "!firstbynameform")
 566                                              : "%prename% {%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}";
 567         string othernameform = buf ? buf->params().documentClass().getCiteMacro(engine_type, "!othernameform")
 568                              : "{%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}{%prename%[[, %prename%]]}";
 569         if (!beginning)
 570                 othernameform = buf ? buf->params().documentClass().getCiteMacro(engine_type, "!otherbynameform")
 571                                              : "%prename% {%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}";
 572         string citenameform = buf ? buf->params().documentClass().getCiteMacro(engine_type, "!citenameform")
 573                              : "{%prefix%[[%prefix% ]]}%surname%";
 574
 575         // Shorten the list (with et al.) if forceshort is set
 576         // and the list can actually be shortened, else if maxcitenames
 577         // is passed and full is not set.
 578         bool shorten = forceshort && authors.size() > 1;
 579         vector<docstring>::const_iterator it = authors.begin();
 580         vector<docstring>::const_iterator en = authors.end();
 581         for (size_t i = 0; it != en; ++it, ++i) {
 582                 if (i >= maxnames && !full) {
 583                         shorten = true;
 584                         break;
 585                 }
 586                 if (*it == "others") {
 587                         retval += buf ? buf->B_(etal) : from_ascii(etal);
 588                         break;
 589                 }
 590                 if (i > 0 && i == authors.size() - 1) {
 591                         if (authors.size() == 2)
 592                                 retval += buf ? buf->B_(pairnamesep) : from_ascii(pairnamesep);
 593                         else
 594                                 retval += buf ? buf->B_(lastnamesep) : from_ascii(lastnamesep);
 595                 } else if (i > 0)
 596                         retval += buf ? buf->B_(namesep) : from_ascii(namesep);
 597                 if (allnames)
 598                         retval += (i == 0) ? constructName(*it, firstnameform)
 599                                 : constructName(*it, othernameform);
 600                 else
 601                         retval += constructName(*it, citenameform);
 602         }
 603         if (shorten) {
 604                 if (allnames)
 605                         retval = constructName(authors[0], firstnameform) + (buf ? buf->B_(etal) : from_ascii(etal));
 606                 else
 607                         retval = constructName(authors[0], citenameform) + (buf ? buf->B_(etal) : from_ascii(etal));
 608         }
 609
 610         return convertLaTeXCommands(retval);
 611 }
 612
 613
 614 docstring const BibTeXInfo::getYear() const
 615 {
 616         if (is_bibtex_) {
 617                 // first try legacy year field
 618                 docstring year = operator[]("year");
 619                 if (!year.empty())
 620                         return year;
 621                 // now try biblatex's date field
 622                 year = operator[]("date");
 623                 // Format is [-]YYYY-MM-DD*/[-]YYYY-MM-DD*
 624                 // We only want the years.
 625                 static regex const yreg("[-]?([\\d]{4}).*");
 626                 static regex const ereg(".*/[-]?([\\d]{4}).*");
 627                 smatch sm;
 628                 string const date = to_utf8(year);
 629                 if (!regex_match(date, sm, yreg))
 630                         // cannot parse year.
 631                         return docstring();
 632                 year = from_ascii(sm[1]);
 633                 // check for an endyear
 634                 if (regex_match(date, sm, ereg))
 635                         year += char_type(0x2013) + from_ascii(sm[1]);
 636                 return year;
 637         }
 638
 639         docstring const opt = label();
 640         if (opt.empty())
 641                 return docstring();
 642
 643         docstring authors;
 644         docstring tmp = split(opt, authors, '(');
 645         if (tmp.empty())
 646                 // we don't have author (year)
 647                 return docstring();
 648         docstring year;
 649         tmp = split(tmp, year, ')');
 650         return year;
 651 }
 652
 653
 654 namespace {
 655
 656 docstring parseOptions(docstring const & format, string & optkey,
 657                     docstring & ifpart, docstring & elsepart);
 658
 659 // Calls parseOptions to deal with an embedded option, such as:
 660 //   {%number%[[, no.~%number%]]}
 661 // which must appear at the start of format. ifelsepart gets the
 662 // whole of the option, and we return what's left after the option.
 663 // we return format if there is an error.
 664 docstring parseEmbeddedOption(docstring const & format, docstring & ifelsepart)
 665 {
 666         LASSERT(format[0] == '{' && format[1] == '%', return format);
 667         string optkey;
 668         docstring ifpart;
 669         docstring elsepart;
 670         docstring const rest = parseOptions(format, optkey, ifpart, elsepart);
 671         if (format == rest) { // parse error
 672                 LYXERR0("ERROR! Couldn't parse `" << format <<"'.");
 673                 return format;
 674         }
 675         LASSERT(rest.size() <= format.size(),
 676                 { ifelsepart = docstring(); return format; });
 677         ifelsepart = format.substr(0, format.size() - rest.size());
 678         return rest;
 679 }
 680
 681
 682 // Gets a "clause" from a format string, where the clause is
 683 // delimited by '[[' and ']]'. Returns what is left after the
 684 // clause is removed, and returns format if there is an error.
 685 docstring getClause(docstring const & format, docstring & clause)
 686 {
 687         docstring fmt = format;
 688         // remove '[['
 689         fmt = fmt.substr(2);
 690         // we'll remove characters from the front of fmt as we
 691         // deal with them
 692         while (!fmt.empty()) {
 693                 if (fmt[0] == ']' && fmt.size() > 1 && fmt[1] == ']') {
 694                         // that's the end
 695                         fmt = fmt.substr(2);
 696                         break;
 697                 }
 698                 // check for an embedded option
 699                 if (fmt[0] == '{' && fmt.size() > 1 && fmt[1] == '%') {
 700                         docstring part;
 701                         docstring const rest = parseEmbeddedOption(fmt, part);
 702                         if (fmt == rest) {
 703                                 LYXERR0("ERROR! Couldn't parse embedded option in `" << format <<"'.");
 704                                 return format;
 705                         }
 706                         clause += part;
 707                         fmt = rest;
 708                 } else { // it's just a normal character
 709                                 clause += fmt[0];
 710                                 fmt = fmt.substr(1);
 711                 }
 712         }
 713         return fmt;
 714 }
 715
 716
 717 // parse an options string, which must appear at the start of the
 718 // format parameter. puts the parsed bits in optkey, ifpart, and
 719 // elsepart and returns what's left after the option is removed.
 720 // if there's an error, it returns format itself.
 721 docstring parseOptions(docstring const & format, string & optkey,
 722                     docstring & ifpart, docstring & elsepart)
 723 {
 724         LASSERT(format[0] == '{' && format[1] == '%', return format);
 725         // strip '{%'
 726         docstring fmt = format.substr(2);
 727         size_t pos = fmt.find('%'); // end of key
 728         if (pos == string::npos) {
 729                 LYXERR0("Error parsing  `" << format <<"'. Can't find end of key.");
 730                 return format;
 731         }
 732         optkey = to_utf8(fmt.substr(0, pos));
 733         fmt = fmt.substr(pos + 1);
 734         // [[format]] should be next
 735         if (fmt[0] != '[' || fmt[1] != '[') {
 736                 LYXERR0("Error parsing  `" << format <<"'. Can't find '[[' after key.");
 737                 return format;
 738         }
 739
 740         docstring curfmt = fmt;
 741         fmt = getClause(curfmt, ifpart);
 742         if (fmt == curfmt) {
 743                 LYXERR0("Error parsing  `" << format <<"'. Couldn't get if clause.");
 744                 return format;
 745         }
 746
 747         if (fmt[0] == '}') // we're done, no else clause
 748                 return fmt.substr(1);
 749
 750         // else part should follow
 751         if (fmt[0] != '[' || fmt[1] != '[') {
 752                 LYXERR0("Error parsing  `" << format <<"'. Can't find else clause.");
 753                 return format;
 754         }
 755
 756         curfmt = fmt;
 757         fmt = getClause(curfmt, elsepart);
 758         // we should be done
 759         if (fmt == curfmt || fmt[0] != '}') {
 760                 LYXERR0("Error parsing  `" << format <<"'. Can't find end of option.");
 761                 return format;
 762         }
 763         return fmt.substr(1);
 764 }
 765
 766
 767 } // namespace
 768
 769 /* FIXME
 770 Bug #9131 revealed an oddity in how we are generating citation information
 771 when more than one key is given. We end up building a longer and longer format
 772 string as we go, which we then have to re-parse, over and over and over again,
 773 rather than generating the information for the individual keys and then putting
 774 all of that together. We do that to deal with the way separators work, from what
 775 I can tell, but it still feels like a hack. Fixing this would require quite a
 776 bit of work, however.
 777 */
 778 docstring BibTeXInfo::expandFormat(docstring const & format,
 779                 BibTeXInfoList const & xrefs, int & counter, Buffer const & buf,
 780                 CiteItem const & ci, bool next, bool second) const
 781 {
 782         // incorrect use of macros could put us in an infinite loop
 783         static int const max_passes = 5000;
 784         // the use of overly large keys can lead to performance problems, due
 785         // to eventual attempts to convert LaTeX macros to unicode. See bug
 786         // #8944. By default, the size is limited to 128 (in CiteItem), but
 787         // for specific purposes (such as XHTML export), it needs to be enlarged
 788         // This is perhaps not the best solution, but it will have to do for now.
 789         size_t const max_keysize = ci.max_key_size;
 790         odocstringstream ret; // return value
 791         string key;
 792         bool scanning_key = false;
 793         bool scanning_rich = false;
 794
 795         CiteEngineType const engine_type = buf.params().citeEngineType();
 796         docstring fmt = format;
 797         // we'll remove characters from the front of fmt as we
 798         // deal with them
 799         while (!fmt.empty()) {
 800                 if (counter > max_passes) {
 801                         LYXERR0("Recursion limit reached while parsing `"
 802                                 << format << "'.");
 803                         return _("ERROR!");
 804                 }
 805
 806                 char_type thischar = fmt[0];
 807                 if (thischar == '%') {
 808                         // beginning or end of key
 809                         if (scanning_key) {
 810                                 // end of key
 811                                 scanning_key = false;
 812                                 // so we replace the key with its value, which may be empty
 813                                 if (key[0] == '!') {
 814                                         // macro
 815                                         string const val =
 816                                                 buf.params().documentClass().getCiteMacro(engine_type, key);
 817                                         fmt = from_utf8(val) + fmt.substr(1);
 818                                         counter += 1;
 819                                         continue;
 820                                 } else if (prefixIs(key, "B_")) {
 821                                         // a translatable bit (to the Buffer language)
 822                                         string const val =
 823                                                 buf.params().documentClass().getCiteMacro(engine_type, key);
 824                                         docstring const trans =
 825                                                 translateIfPossible(from_utf8(val), buf.params().language->code());
 826                                         ret << trans;
 827                                 } else if (key[0] == '_') {
 828                                         // a translatable bit (to the GUI language)
 829                                         string const val =
 830                                                 buf.params().documentClass().getCiteMacro(engine_type, key);
 831                                         docstring const trans =
 832                                                 translateIfPossible(from_utf8(val));
 833                                         ret << trans;
 834                                 } else {
 835                                         docstring const val =
 836                                                 getValueForKey(key, buf, ci, xrefs, max_keysize);
 837                                         if (!scanning_rich)
 838                                                 ret << from_ascii("{!<span class=\"bib-" + key + "\">!}");
 839                                         ret << val;
 840                                         if (!scanning_rich)
 841                                                 ret << from_ascii("{!</span>!}");
 842                                 }
 843                         } else {
 844                                 // beginning of key
 845                                 key.clear();
 846                                 scanning_key = true;
 847                         }
 848                 }
 849                 else if (thischar == '{') {
 850                         // beginning of option?
 851                         if (scanning_key) {
 852                                 LYXERR0("ERROR: Found `{' when scanning key in `" << format << "'.");
 853                                 return _("ERROR!");
 854                         }
 855                         if (fmt.size() > 1) {
 856                                 if (fmt[1] == '%') {
 857                                         // it is the beginning of an optional format
 858                                         string optkey;
 859                                         docstring ifpart;
 860                                         docstring elsepart;
 861                                         docstring const newfmt =
 862                                                 parseOptions(fmt, optkey, ifpart, elsepart);
 863                                         if (newfmt == fmt) // parse error
 864                                                 return _("ERROR!");
 865                                         fmt = newfmt;
 866                                         docstring const val =
 867                                                 getValueForKey(optkey, buf, ci, xrefs);
 868                                         if (optkey == "next" && next)
 869                                                 ret << ifpart; // without expansion
 870                                         else if (optkey == "second" && second) {
 871                                                 int newcounter = 0;
 872                                                 ret << expandFormat(ifpart, xrefs, newcounter, buf,
 873                                                         ci, next);
 874                                         } else if (!val.empty()) {
 875                                                 int newcounter = 0;
 876                                                 ret << expandFormat(ifpart, xrefs, newcounter, buf,
 877                                                         ci, next);
 878                                         } else if (!elsepart.empty()) {
 879                                                 int newcounter = 0;
 880                                                 ret << expandFormat(elsepart, xrefs, newcounter, buf,
 881                                                         ci, next);
 882                                         }
 883                                         // fmt will have been shortened for us already
 884                                         continue;
 885                                 }
 886                                 if (fmt[1] == '!') {
 887                                         // beginning of rich text
 888                                         scanning_rich = true;
 889                                         fmt = fmt.substr(2);
 890                                         ret << from_ascii("{!");
 891                                         continue;
 892                                 }
 893                         }
 894                         // we are here if '{' was not followed by % or !.
 895                         // So it's just a character.
 896                         ret << thischar;
 897                 }
 898                 else if (scanning_rich && thischar == '!'
 899                          && fmt.size() > 1 && fmt[1] == '}') {
 900                         // end of rich text
 901                         scanning_rich = false;
 902                         fmt = fmt.substr(2);
 903                         ret << from_ascii("!}");
 904                         continue;
 905                 }
 906                 else if (scanning_key)
 907                         key += char(thischar);
 908                 else {
 909                         try {
 910                                 ret.put(thischar);
 911                         } catch (EncodingException & /* e */) {
 912                                 LYXERR0("Uncodable character '" << docstring(1, thischar) << " in citation label!");
 913                         }
 914                 }
 915                 fmt = fmt.substr(1);
 916         } // for loop
 917         if (scanning_key) {
 918                 LYXERR0("Never found end of key in `" << format << "'!");
 919                 return _("ERROR!");
 920         }
 921         if (scanning_rich) {
 922                 LYXERR0("Never found end of rich text in `" << format << "'!");
 923                 return _("ERROR!");
 924         }
 925         return ret.str();
 926 }
 927
 928
 929 docstring const & BibTeXInfo::getInfo(BibTeXInfoList const & xrefs,
 930         Buffer const & buf, CiteItem const & ci) const
 931 {
 932         bool const richtext = ci.richtext;
 933
 934         if (!richtext && !info_.empty())
 935                 return info_;
 936         if (richtext && !info_richtext_.empty())
 937                 return info_richtext_;
 938
 939         if (!is_bibtex_) {
 940                 BibTeXInfo::const_iterator it = find(from_ascii("ref"));
 941                 info_ = it->second;
 942                 return info_;
 943         }
 944
 945         CiteEngineType const engine_type = buf.params().citeEngineType();
 946         DocumentClass const & dc = buf.params().documentClass();
 947         docstring const & format =
 948                 from_utf8(dc.getCiteFormat(engine_type, to_utf8(entry_type_)));
 949         int counter = 0;
 950         info_ = expandFormat(format, xrefs, counter, buf,
 951                 ci, false, false);
 952
 953         if (info_.empty()) {
 954                 // this probably shouldn't happen
 955                 return info_;
 956         }
 957
 958         if (richtext) {
 959                 info_richtext_ = convertLaTeXCommands(processRichtext(info_, true));
 960                 return info_richtext_;
 961         }
 962
 963         info_ = convertLaTeXCommands(processRichtext(info_, false));
 964         return info_;
 965 }
 966
 967
 968 docstring const BibTeXInfo::getLabel(BibTeXInfoList const xrefs,
 969         Buffer const & buf, docstring const & format,
 970         CiteItem const & ci, bool next, bool second) const
 971 {
 972         docstring loclabel;
 973
 974         int counter = 0;
 975         loclabel = expandFormat(format, xrefs, counter, buf, ci, next, second);
 976
 977         if (!loclabel.empty() && !next) {
 978                 loclabel = processRichtext(loclabel, ci.richtext);
 979                 loclabel = convertLaTeXCommands(loclabel);
 980         }
 981
 982         return loclabel;
 983 }
 984
 985
 986 docstring const & BibTeXInfo::operator[](docstring const & field) const
 987 {
 988         BibTeXInfo::const_iterator it = find(field);
 989         if (it != end())
 990                 return it->second;
 991         static docstring const empty_value = docstring();
 992         return empty_value;
 993 }
 994
 995
 996 docstring const & BibTeXInfo::operator[](string const & field) const
 997 {
 998         return operator[](from_ascii(field));
 999 }
1000
1001
1002 docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf,
1003         CiteItem const & ci, BibTeXInfoList const & xrefs, size_t maxsize) const
1004 {
1005         // anything less is pointless
1006         LASSERT(maxsize >= 16, maxsize = 16);
1007         string key = oldkey;
1008         bool cleanit = false;
1009         if (prefixIs(oldkey, "clean:")) {
1010                 key = oldkey.substr(6);
1011                 cleanit = true;
1012         }
1013
1014         docstring ret = operator[](key);
1015         if (ret.empty() && !xrefs.empty()) {
1016                 vector<BibTeXInfo const *>::const_iterator it = xrefs.begin();
1017                 vector<BibTeXInfo const *>::const_iterator en = xrefs.end();
1018                 for (; it != en; ++it) {
1019                         if (*it && !(**it)[key].empty()) {
1020                                 ret = (**it)[key];
1021                                 break;
1022                         }
1023                 }
1024         }
1025         if (ret.empty()) {
1026                 // some special keys
1027                 // FIXME: dialog, textbefore and textafter have nothing to do with this
1028                 if (key == "dialog" && ci.context == CiteItem::Dialog)
1029                         ret = from_ascii("x"); // any non-empty string will do
1030                 else if (key == "export" && ci.context == CiteItem::Export)
1031                         ret = from_ascii("x"); // any non-empty string will do
1032                 else if (key == "ifstar" && ci.Starred)
1033                         ret = from_ascii("x"); // any non-empty string will do
1034                 else if (key == "ifqualified" && ci.isQualified)
1035                         ret = from_ascii("x"); // any non-empty string will do
1036                 else if (key == "entrytype")
1037                         ret = entry_type_;
1038                 else if (prefixIs(key, "ifentrytype:")
1039                          && from_ascii(key.substr(12)) == entry_type_)
1040                         ret = from_ascii("x"); // any non-empty string will do
1041                 else if (key == "key")
1042                         ret = bib_key_;
1043                 else if (key == "label")
1044                         ret = label_;
1045                 else if (key == "modifier" && modifier_ != 0)
1046                         ret = modifier_;
1047                 else if (key == "numericallabel")
1048                         ret = cite_number_;
1049                 else if (prefixIs(key, "ifmultiple:")) {
1050                         // Return whether we have multiple authors
1051                         docstring const kind = operator[](from_ascii(key.substr(11)));
1052                         if (multipleAuthors(kind))
1053                                 ret = from_ascii("x"); // any non-empty string will do
1054                 }
1055                 else if (prefixIs(key, "abbrvnames:")) {
1056                         // Special key to provide abbreviated name list,
1057                         // with respect to maxcitenames. Suitable for Bibliography
1058                         // beginnings.
1059                         docstring const kind = operator[](from_ascii(key.substr(11)));
1060                         ret = getAuthorList(&buf, kind, false, false, true);
1061                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1062                                 ret[0] = uppercase(ret[0]);
1063                 } else if (prefixIs(key, "fullnames:")) {
1064                         // Return a full name list. Suitable for Bibliography
1065                         // beginnings.
1066                         docstring const kind = operator[](from_ascii(key.substr(10)));
1067                         ret = getAuthorList(&buf, kind, true, false, true);
1068                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1069                                 ret[0] = uppercase(ret[0]);
1070                 } else if (prefixIs(key, "forceabbrvnames:")) {
1071                         // Special key to provide abbreviated name lists,
1072                         // irrespective of maxcitenames. Suitable for Bibliography
1073                         // beginnings.
1074                         docstring const kind = operator[](from_ascii(key.substr(15)));
1075                         ret = getAuthorList(&buf, kind, false, true, true);
1076                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1077                                 ret[0] = uppercase(ret[0]);
1078                 } else if (prefixIs(key, "abbrvbynames:")) {
1079                         // Special key to provide abbreviated name list,
1080                         // with respect to maxcitenames. Suitable for further names inside a
1081                         // bibliography item // (such as "ed. by ...")
1082                         docstring const kind = operator[](from_ascii(key.substr(11)));
1083                         ret = getAuthorList(&buf, kind, false, false, true, false);
1084                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1085                                 ret[0] = uppercase(ret[0]);
1086                 } else if (prefixIs(key, "fullbynames:")) {
1087                         // Return a full name list. Suitable for further names inside a
1088                         // bibliography item // (such as "ed. by ...")
1089                         docstring const kind = operator[](from_ascii(key.substr(10)));
1090                         ret = getAuthorList(&buf, kind, true, false, true, false);
1091                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1092                                 ret[0] = uppercase(ret[0]);
1093                 } else if (prefixIs(key, "forceabbrvbynames:")) {
1094                         // Special key to provide abbreviated name lists,
1095                         // irrespective of maxcitenames. Suitable for further names inside a
1096                         // bibliography item // (such as "ed. by ...")
1097                         docstring const kind = operator[](from_ascii(key.substr(15)));
1098                         ret = getAuthorList(&buf, kind, false, true, true, false);
1099                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1100                                 ret[0] = uppercase(ret[0]);
1101                 } else if (key == "abbrvciteauthor") {
1102                         // Special key to provide abbreviated author or
1103                         // editor names (suitable for citation labels),
1104                         // with respect to maxcitenames.
1105                         ret = getAuthorOrEditorList(&buf, false, false);
1106                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1107                                 ret[0] = uppercase(ret[0]);
1108                 } else if (key == "fullciteauthor") {
1109                         // Return a full author or editor list (for citation labels)
1110                         ret = getAuthorOrEditorList(&buf, true, false);
1111                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1112                                 ret[0] = uppercase(ret[0]);
1113                 } else if (key == "forceabbrvciteauthor") {
1114                         // Special key to provide abbreviated author or
1115                         // editor names (suitable for citation labels),
1116                         // irrespective of maxcitenames.
1117                         ret = getAuthorOrEditorList(&buf, false, true);
1118                         if (ci.forceUpperCase && isLowerCase(ret[0]))
1119                                 ret[0] = uppercase(ret[0]);
1120                 } else if (key == "bibentry") {
1121                         // Special key to provide the full bibliography entry: see getInfo()
1122                         CiteEngineType const engine_type = buf.params().citeEngineType();
1123                         DocumentClass const & dc = buf.params().documentClass();
1124                         docstring const & format =
1125                                 from_utf8(dc.getCiteFormat(engine_type, to_utf8(entry_type_), false));
1126                         int counter = 0;
1127                         ret = expandFormat(format, xrefs, counter, buf, ci, false, false);
1128                 } else if (key == "textbefore")
1129                         ret = ci.textBefore;
1130                 else if (key == "textafter")
1131                         ret = ci.textAfter;
1132                 else if (key == "curpretext") {
1133                         vector<pair<docstring, docstring>> pres = ci.getPretexts();
1134                         vector<pair<docstring, docstring>>::iterator it = pres.begin();
1135                         int numkey = 1;
1136                         for (; it != pres.end() ; ++it) {
1137                                 if ((*it).first == bib_key_ && numkey == num_bib_key_) {
1138                                         ret = (*it).second;
1139                                         pres.erase(it);
1140                                         break;
1141                                 }
1142                                 if ((*it).first == bib_key_)
1143                                         ++numkey;
1144                         }
1145                 } else if (key == "curposttext") {
1146                         vector<pair<docstring, docstring>> posts = ci.getPosttexts();
1147                         vector<pair<docstring, docstring>>::iterator it = posts.begin();
1148                         int numkey = 1;
1149                         for (; it != posts.end() ; ++it) {
1150                                 if ((*it).first == bib_key_ && numkey == num_bib_key_) {
1151                                         ret = (*it).second;
1152                                         posts.erase(it);
1153                                         break;
1154                                 }
1155                                 if ((*it).first == bib_key_)
1156                                         ++numkey;
1157                         }
1158                 } else if (key == "year")
1159                         ret = getYear();
1160         }
1161
1162         if (cleanit)
1163                 ret = html::cleanAttr(ret);
1164
1165         // make sure it is not too big
1166         support::truncateWithEllipsis(ret, maxsize);
1167         return ret;
1168 }
1169
1170
1171 //////////////////////////////////////////////////////////////////////
1172 //
1173 // BiblioInfo
1174 //
1175 //////////////////////////////////////////////////////////////////////
1176
1177 namespace {
1178
1179 // A functor for use with sort, leading to case insensitive sorting
1180 class compareNoCase: public binary_function<docstring, docstring, bool>
1181 {
1182 public:
1183         bool operator()(docstring const & s1, docstring const & s2) const {
1184                 return compare_no_case(s1, s2) < 0;
1185         }
1186 };
1187
1188 } // namespace
1189
1190
1191 vector<docstring> const BiblioInfo::getXRefs(BibTeXInfo const & data, bool const nested) const
1192 {
1193         vector<docstring> result;
1194         if (!data.isBibTeX())
1195                 return result;
1196         // Legacy crossref field. This is not nestable.
1197         if (!nested && !data["crossref"].empty()) {
1198                 docstring const xrefkey = data["crossref"];
1199                 result.push_back(xrefkey);
1200                 // However, check for nested xdatas
1201                 BiblioInfo::const_iterator it = find(xrefkey);
1202                 if (it != end()) {
1203                         BibTeXInfo const & xref = it->second;
1204                         vector<docstring> const nxdata = getXRefs(xref, true);
1205                         if (!nxdata.empty())
1206                                 result.insert(result.end(), nxdata.begin(), nxdata.end());
1207                 }
1208         }
1209         // Biblatex's xdata field. Infinitely nestable.
1210         // XData field can consist of a comma-separated list of keys
1211         vector<docstring> const xdatakeys = getVectorFromString(data["xdata"]);
1212         if (!xdatakeys.empty()) {
1213                 vector<docstring>::const_iterator xit = xdatakeys.begin();
1214                 vector<docstring>::const_iterator xen = xdatakeys.end();
1215                 for (; xit != xen; ++xit) {
1216                         docstring const xdatakey = *xit;
1217                         result.push_back(xdatakey);
1218                         BiblioInfo::const_iterator it = find(xdatakey);
1219                         if (it != end()) {
1220                                 BibTeXInfo const & xdata = it->second;
1221                                 vector<docstring> const nxdata = getXRefs(xdata, true);
1222                                 if (!nxdata.empty())
1223                                         result.insert(result.end(), nxdata.begin(), nxdata.end());
1224                         }
1225                 }
1226         }
1227         return result;
1228 }
1229
1230
1231 vector<docstring> const BiblioInfo::getKeys() const
1232 {
1233         vector<docstring> bibkeys;
1234         BiblioInfo::const_iterator it  = begin();
1235         for (; it != end(); ++it)
1236                 bibkeys.push_back(it->first);
1237         sort(bibkeys.begin(), bibkeys.end(), compareNoCase());
1238         return bibkeys;
1239 }
1240
1241
1242 vector<docstring> const BiblioInfo::getFields() const
1243 {
1244         vector<docstring> bibfields;
1245         set<docstring>::const_iterator it = field_names_.begin();
1246         set<docstring>::const_iterator end = field_names_.end();
1247         for (; it != end; ++it)
1248                 bibfields.push_back(*it);
1249         sort(bibfields.begin(), bibfields.end());
1250         return bibfields;
1251 }
1252
1253
1254 vector<docstring> const BiblioInfo::getEntries() const
1255 {
1256         vector<docstring> bibentries;
1257         set<docstring>::const_iterator it = entry_types_.begin();
1258         set<docstring>::const_iterator end = entry_types_.end();
1259         for (; it != end; ++it)
1260                 bibentries.push_back(*it);
1261         sort(bibentries.begin(), bibentries.end());
1262         return bibentries;
1263 }
1264
1265
1266 docstring const BiblioInfo::getAuthorOrEditorList(docstring const & key, Buffer const & buf) const
1267 {
1268         BiblioInfo::const_iterator it = find(key);
1269         if (it == end())
1270                 return docstring();
1271         BibTeXInfo const & data = it->second;
1272         return data.getAuthorOrEditorList(&buf, false);
1273 }
1274
1275
1276 docstring const BiblioInfo::getCiteNumber(docstring const & key) const
1277 {
1278         BiblioInfo::const_iterator it = find(key);
1279         if (it == end())
1280                 return docstring();
1281         BibTeXInfo const & data = it->second;
1282         return data.citeNumber();
1283 }
1284
1285
1286 docstring const BiblioInfo::getYear(docstring const & key, bool use_modifier) const
1287 {
1288         BiblioInfo::const_iterator it = find(key);
1289         if (it == end())
1290                 return docstring();
1291         BibTeXInfo const & data = it->second;
1292         docstring year = data.getYear();
1293         if (year.empty()) {
1294                 // let's try the crossrefs
1295                 vector<docstring> const xrefs = getXRefs(data);
1296                 if (xrefs.empty())
1297                         // no luck
1298                         return docstring();
1299                 for (docstring const & xref : xrefs) {
1300                         BiblioInfo::const_iterator const xrefit = find(xref);
1301                         if (xrefit == end())
1302                                 continue;
1303                         BibTeXInfo const & xref_data = xrefit->second;
1304                         year = xref_data.getYear();
1305                         if (!year.empty())
1306                                 // success!
1307                                 break;
1308                 }
1309         }
1310         if (use_modifier && data.modifier() != 0)
1311                 year += data.modifier();
1312         return year;
1313 }
1314
1315
1316 docstring const BiblioInfo::getYear(docstring const & key, Buffer const & buf, bool use_modifier) const
1317 {
1318         docstring const year = getYear(key, use_modifier);
1319         if (year.empty())
1320                 return buf.B_("No year");
1321         return year;
1322 }
1323
1324
1325 docstring const BiblioInfo::getInfo(docstring const & key,
1326         Buffer const & buf, CiteItem const & ci) const
1327 {
1328         BiblioInfo::const_iterator it = find(key);
1329         if (it == end())
1330                 return docstring(_("Bibliography entry not found!"));
1331         BibTeXInfo const & data = it->second;
1332         BibTeXInfoList xrefptrs;
1333         for (docstring const & xref : getXRefs(data)) {
1334                 BiblioInfo::const_iterator const xrefit = find(xref);
1335                 if (xrefit != end())
1336                         xrefptrs.push_back(&(xrefit->second));
1337         }
1338         return data.getInfo(xrefptrs, buf, ci);
1339 }
1340
1341
1342 docstring const BiblioInfo::getLabel(vector<docstring> keys,
1343         Buffer const & buf, string const & style, CiteItem const & ci) const
1344 {
1345         size_t max_size = ci.max_size;
1346         // shorter makes no sense
1347         LASSERT(max_size >= 16, max_size = 16);
1348
1349         // we can't display more than 10 of these, anyway
1350         // but since we truncate in the middle,
1351         // we need to split into two halfs.
1352         bool const too_many_keys = keys.size() > 10;
1353         vector<docstring> lkeys;
1354         if (too_many_keys) {
1355                 lkeys.insert(lkeys.end(), keys.end() - 5, keys.end());
1356                 keys.resize(5);
1357                 keys.insert(keys.end(), lkeys.begin(), lkeys.end());
1358         }
1359
1360         CiteEngineType const engine_type = buf.params().citeEngineType();
1361         DocumentClass const & dc = buf.params().documentClass();
1362         docstring const & format = from_utf8(dc.getCiteFormat(engine_type, style, false, "cite"));
1363         docstring ret = format;
1364         vector<docstring>::const_iterator key = keys.begin();
1365         vector<docstring>::const_iterator ken = keys.end();
1366         vector<docstring> handled_keys;
1367         for (int i = 0; key != ken; ++key, ++i) {
1368                 handled_keys.push_back(*key);
1369                 int n = 0;
1370                 for (auto const k : handled_keys) {
1371                         if (k == *key)
1372                                 ++n;
1373                 }
1374                 BiblioInfo::const_iterator it = find(*key);
1375                 BibTeXInfo empty_data;
1376                 empty_data.key(*key);
1377                 BibTeXInfo & data = empty_data;
1378                 vector<BibTeXInfo const *> xrefptrs;
1379                 if (it != end()) {
1380                         data = it->second;
1381                         for (docstring const & xref : getXRefs(data)) {
1382                                 BiblioInfo::const_iterator const xrefit = find(xref);
1383                                 if (xrefit != end())
1384                                         xrefptrs.push_back(&(xrefit->second));
1385                         }
1386                 }
1387                 data.numKey(n);
1388                 ret = data.getLabel(xrefptrs, buf, ret, ci, key + 1 != ken, i == 1);
1389         }
1390
1391         support::truncateWithEllipsis(ret, max_size, true);
1392
1393         return ret;
1394 }
1395
1396
1397 bool BiblioInfo::isBibtex(docstring const & key) const
1398 {
1399         docstring key1;
1400         split(key, key1, ',');
1401         BiblioInfo::const_iterator it = find(key1);
1402         if (it == end())
1403                 return false;
1404         return it->second.isBibTeX();
1405 }
1406
1407
1408 BiblioInfo::CiteStringMap const BiblioInfo::getCiteStrings(
1409         vector<docstring> const & keys, vector<CitationStyle> const & styles,
1410         Buffer const & buf, CiteItem const & ci) const
1411 {
1412         if (empty())
1413                 return vector<pair<docstring,docstring>>();
1414
1415         string style;
1416         CiteStringMap csm(styles.size());
1417         for (size_t i = 0; i != csm.size(); ++i) {
1418                 style = styles[i].name;
1419                 csm[i] = make_pair(from_ascii(style), getLabel(keys, buf, style, ci));
1420         }
1421
1422         return csm;
1423 }
1424
1425
1426 void BiblioInfo::mergeBiblioInfo(BiblioInfo const & info)
1427 {
1428         bimap_.insert(info.begin(), info.end());
1429         field_names_.insert(info.field_names_.begin(), info.field_names_.end());
1430         entry_types_.insert(info.entry_types_.begin(), info.entry_types_.end());
1431 }
1432
1433
1434 namespace {
1435
1436 // used in xhtml to sort a list of BibTeXInfo objects
1437 bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs)
1438 {
1439         docstring const lauth = lhs->getAuthorOrEditorList();
1440         docstring const rauth = rhs->getAuthorOrEditorList();
1441         docstring const lyear = lhs->getYear();
1442         docstring const ryear = rhs->getYear();
1443         docstring const ltitl = lhs->operator[]("title");
1444         docstring const rtitl = rhs->operator[]("title");
1445         return  (lauth < rauth)
1446                 || (lauth == rauth && lyear < ryear)
1447                 || (lauth == rauth && lyear == ryear && ltitl < rtitl);
1448 }
1449
1450 } // namespace
1451
1452
1453 void BiblioInfo::collectCitedEntries(Buffer const & buf)
1454 {
1455         cited_entries_.clear();
1456         // We are going to collect all the citation keys used in the document,
1457         // getting them from the TOC.
1458         // FIXME We may want to collect these differently, in the first case,
1459         // so that we might have them in order of appearance.
1460         set<docstring> citekeys;
1461         shared_ptr<Toc const> toc = buf.tocBackend().toc("citation");
1462         Toc::const_iterator it = toc->begin();
1463         Toc::const_iterator const en = toc->end();
1464         for (; it != en; ++it) {
1465                 if (it->str().empty())
1466                         continue;
1467                 vector<docstring> const keys = getVectorFromString(it->str());
1468                 citekeys.insert(keys.begin(), keys.end());
1469         }
1470         if (citekeys.empty())
1471                 return;
1472
1473         // We have a set of the keys used in this document.
1474         // We will now convert it to a list of the BibTeXInfo objects used in
1475         // this document...
1476         vector<BibTeXInfo const *> bi;
1477         set<docstring>::const_iterator cit = citekeys.begin();
1478         set<docstring>::const_iterator const cen = citekeys.end();
1479         for (; cit != cen; ++cit) {
1480                 BiblioInfo::const_iterator const bt = find(*cit);
1481                 if (bt == end() || !bt->second.isBibTeX())
1482                         continue;
1483                 bi.push_back(&(bt->second));
1484         }
1485         // ...and sort it.
1486         sort(bi.begin(), bi.end(), lSorter);
1487
1488         // Now we can write the sorted keys
1489         vector<BibTeXInfo const *>::const_iterator bit = bi.begin();
1490         vector<BibTeXInfo const *>::const_iterator ben = bi.end();
1491         for (; bit != ben; ++bit)
1492                 cited_entries_.push_back((*bit)->key());
1493 }
1494
1495
1496 void BiblioInfo::makeCitationLabels(Buffer const & buf)
1497 {
1498         collectCitedEntries(buf);
1499         CiteEngineType const engine_type = buf.params().citeEngineType();
1500         bool const numbers = (engine_type & ENGINE_TYPE_NUMERICAL);
1501
1502         int keynumber = 0;
1503         char modifier = 0;
1504         // used to remember the last one we saw
1505         // we'll be comparing entries to see if we need to add
1506         // modifiers, like "1984a"
1507         map<docstring, BibTeXInfo>::iterator last = bimap_.end();
1508
1509         vector<docstring>::const_iterator it = cited_entries_.begin();
1510         vector<docstring>::const_iterator const en = cited_entries_.end();
1511         for (; it != en; ++it) {
1512                 map<docstring, BibTeXInfo>::iterator const biit = bimap_.find(*it);
1513                 // this shouldn't happen, but...
1514                 if (biit == bimap_.end())
1515                         // ...fail gracefully, anyway.
1516                         continue;
1517                 BibTeXInfo & entry = biit->second;
1518                 if (numbers) {
1519                         docstring const num = convert<docstring>(++keynumber);
1520                         entry.setCiteNumber(num);
1521                 } else {
1522                         // The first test here is checking whether this is the first
1523                         // time through the loop. If so, then we do not have anything
1524                         // with which to compare.
1525                         if (last != bimap_.end()
1526                             && entry.getAuthorOrEditorList() == last->second.getAuthorOrEditorList()
1527                             // we access the year via getYear() so as to get it from the xref,
1528                             // if we need to do so
1529                             && getYear(entry.key()) == getYear(last->second.key())) {
1530                                 if (modifier == 0) {
1531                                         // so the last one should have been 'a'
1532                                         last->second.setModifier('a');
1533                                         modifier = 'b';
1534                                 } else if (modifier == 'z')
1535                                         modifier = 'A';
1536                                 else
1537                                         modifier++;
1538                         } else {
1539                                 modifier = 0;
1540                         }
1541                         entry.setModifier(modifier);
1542                         // remember the last one
1543                         last = biit;
1544                 }
1545         }
1546         // Set the labels
1547         it = cited_entries_.begin();
1548         for (; it != en; ++it) {
1549                 map<docstring, BibTeXInfo>::iterator const biit = bimap_.find(*it);
1550                 // this shouldn't happen, but...
1551                 if (biit == bimap_.end())
1552                         // ...fail gracefully, anyway.
1553                         continue;
1554                 BibTeXInfo & entry = biit->second;
1555                 if (numbers) {
1556                         entry.label(entry.citeNumber());
1557                 } else {
1558                         docstring const auth = entry.getAuthorOrEditorList(&buf, false);
1559                         // we do it this way so as to access the xref, if necessary
1560                         // note that this also gives us the modifier
1561                         docstring const year = getYear(*it, buf, true);
1562                         if (!auth.empty() && !year.empty())
1563                                 entry.label(auth + ' ' + year);
1564                         else
1565                                 entry.label(entry.key());
1566                 }
1567         }
1568 }
1569
1570
1571 //////////////////////////////////////////////////////////////////////
1572 //
1573 // CitationStyle
1574 //
1575 //////////////////////////////////////////////////////////////////////
1576
1577
1578 CitationStyle citationStyleFromString(string const & command,
1579                                       BufferParams const & params)
1580 {
1581         CitationStyle cs;
1582         if (command.empty())
1583                 return cs;
1584
1585         string const alias = params.getCiteAlias(command);
1586         string cmd = alias.empty() ? command : alias;
1587         if (isUpperCase(command[0])) {
1588                 cs.forceUpperCase = true;
1589                 cmd[0] = lowercase(cmd[0]);
1590         }
1591
1592         size_t const n = command.size() - 1;
1593         if (command[n] == '*') {
1594                 cs.hasStarredVersion = true;
1595                 if (suffixIs(cmd, '*'))
1596                         cmd = cmd.substr(0, cmd.size() - 1);
1597         }
1598
1599         cs.name = cmd;
1600         return cs;
1601 }
1602
1603
1604 string citationStyleToString(const CitationStyle & cs, bool const latex)
1605 {
1606         string cmd = latex ? cs.cmd : cs.name;
1607         if (cs.forceUpperCase)
1608                 cmd[0] = uppercase(cmd[0]);
1609         if (cs.hasStarredVersion)
1610                 cmd += '*';
1611         return cmd;
1612 }
1613
1614 } // namespace lyx