3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
10 * \author Jürgen Spitzmüller
12 * Full author contact details are available in file CREDITS.
17 #include "BiblioInfo.h"
19 #include "BufferParams.h"
20 #include "buffer_funcs.h"
23 #include "InsetIterator.h"
25 #include "output_xhtml.h"
26 #include "Paragraph.h"
27 #include "TextClass.h"
28 #include "TocBackend.h"
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"
43 using namespace lyx::support;
50 // Remove placeholders from names
51 docstring renormalize(docstring const & input)
53 docstring res = subst(input, from_ascii("$$space!"), from_ascii(" "));
54 return subst(res, from_ascii("$$comma!"), from_ascii(","));
58 // Split the surname into prefix ("von-part") and family name
59 pair<docstring, docstring> parseSurname(docstring const & sname)
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);
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".
69 vector<docstring>::const_iterator it = pieces.begin();
70 vector<docstring>::const_iterator const en = pieces.end();
72 for (; it != en; ++it) {
75 // If this is the last piece, then what we now have is
76 // the family name, notwithstanding the casing.
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.
84 // Nothing of the former, so add this piece to the prename
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.
98 for (; it != en; ++it) {
105 return make_pair(prefix, surname);
117 // gets the name parts (prename, surname, prefix, suffix) from an author-type string
118 name_parts nameParts(docstring const & iname)
124 // First we check for goupings (via {...}) and replace blanks and
125 // commas inside groups with temporary placeholders
128 docstring::const_iterator p = iname.begin();
129 while (p != iname.end()) {
130 // count grouping level
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!");
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
148 vector<docstring> pieces = getVectorFromString(name);
149 if (pieces.size() > 1) {
150 // Whether we have a name suffix or not, the prename is
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));
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());
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());
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.
184 vector<docstring>::const_iterator it = pieces.begin();
185 vector<docstring>::const_iterator const en = pieces.end();
187 for (; it != en; ++it) {
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.
195 // Same if this is the last piece, which is always the surname.
198 // Nothing of the former, so add this piece to the prename
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.
212 for (; it != en; ++it) {
219 res.prename = renormalize(prename);
220 res.prefix = renormalize(parseSurname(surname).first);
221 res.surname = renormalize(parseSurname(surname).second);
226 docstring constructName(docstring const & name, string const & scheme)
228 // re-constructs a name from name parts according
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;
235 static regex const reg1("(.*)(\\{%prename%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)");
236 static regex const reg2("(.*)(\\{%suffix%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)");
237 static regex const reg3("(.*)(\\{%prefix%\\[\\[)([^\\]]+)(\\]\\]\\})(.*)");
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)) {
243 if (!prename.empty())
247 if (regex_match(res, sub, reg2)) {
248 string tmp = sub.str(1);
251 res = tmp + sub.str(5);
253 if (regex_match(res, sub, reg3)) {
254 string tmp = sub.str(1);
257 res = tmp + sub.str(5);
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);
268 vector<docstring> const getAuthors(docstring const & author)
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.
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
287 docstring::const_iterator p = iname.begin();
288 while (p != iname.end()) {
289 // count grouping level
294 // generate string with probable placeholders
297 // Inside groups, we output "and"
298 name += from_ascii("and");
300 // Outside groups, we output a separator
301 name += from_ascii("$$namesep!");
308 // re-insert the literal ampersands
309 name = subst(name, from_ascii("$$amp!"), from_ascii("&"));
311 // Now construct the actual vector
312 return getVectorFromString(name, from_ascii(" $$namesep! "));
316 bool multipleAuthors(docstring const & author)
318 return getAuthors(author).size() > 1;
322 // converts a string containing LaTeX commands into unicode
324 docstring convertLaTeXCommands(docstring const & str)
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];
335 // if we're scanning math, we output everything until we
336 // find an unescaped $, at which point we break out.
343 scanning_math = false;
349 // if we're scanning a command name, then we just
350 // discard characters until we hit something that
353 if (isAlphaASCII(ch)) {
358 // so we're done with this command.
359 // now we fall through and check this character.
360 scanning_cmd = false;
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...
366 // exception: output \, as THIN SPACE
368 ret.push_back(0x2009);
379 scanning_math = true;
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)) {
390 val.replace(2, 1, from_ascii("{"));
394 // Apart from the above, we just ignore braces
395 if (ch == '{' || ch == '}') {
400 // we're going to check things that look like commands, so if
401 // this doesn't, just output it.
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("{"));
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
430 // it's a command of some sort
439 // Escape '<' and '>' and remove richtext markers (e.g. {!this is richtext!}) from a string.
440 docstring processRichtext(docstring const & str, bool richtext)
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;
454 if (scanning_rich && ch == '!' && val.size() > 1 && val[1] == '}') {
456 scanning_rich = false;
464 // we need to escape '<' and '>'
472 } else if (!scanning_rich /* && !richtext */)
474 // else the character is discarded, which will happen only if
475 // richtext == false and we are scanning rich text
484 //////////////////////////////////////////////////////////////////////
488 //////////////////////////////////////////////////////////////////////
490 BibTeXInfo::BibTeXInfo(docstring const & key, docstring const & type)
491 : is_bibtex_(true), bib_key_(key), num_bib_key_(0), entry_type_(type), info_(),
497 docstring const BibTeXInfo::getAuthorOrEditorList(Buffer const * buf,
498 bool full, bool forceshort) const
500 docstring author = operator[]("author");
502 author = operator[]("editor");
504 return getAuthorList(buf, author, full, forceshort);
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
512 // Maxnames treshold depend on engine
513 size_t maxnames = buf ?
514 buf->params().documentClass().max_citenames() : 2;
517 docstring const opt = label();
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)
528 // Natbib syntax is "Jones et al.(1990)Jones, Baker, and Williams"
529 docstring const fullauthors = trim(rsplit(remainder, ')'));
530 if (!fullauthors.empty())
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);
545 CiteEngineType const engine_type = buf ? buf->params().citeEngineType()
546 : ENGINE_TYPE_DEFAULT;
548 // These are defined in the styles
550 buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_etal")
552 string const namesep =
553 buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_namesep")
555 string const lastnamesep =
556 buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_lastnamesep")
558 string const pairnamesep =
559 buf ? buf->params().documentClass().getCiteMacro(engine_type, "B_pairnamesep")
561 string firstnameform =
562 buf ? buf->params().documentClass().getCiteMacro(engine_type, "!firstnameform")
563 : "{%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}{%prename%[[, %prename%]]}";
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%]]}";
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%";
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) {
586 if (*it == "others") {
587 retval += buf ? buf->B_(etal) : from_ascii(etal);
590 if (i > 0 && i == authors.size() - 1) {
591 if (authors.size() == 2)
592 retval += buf ? buf->B_(pairnamesep) : from_ascii(pairnamesep);
594 retval += buf ? buf->B_(lastnamesep) : from_ascii(lastnamesep);
596 retval += buf ? buf->B_(namesep) : from_ascii(namesep);
598 retval += (i == 0) ? constructName(*it, firstnameform)
599 : constructName(*it, othernameform);
601 retval += constructName(*it, citenameform);
605 retval = constructName(authors[0], firstnameform) + (buf ? buf->B_(etal) : from_ascii(etal));
607 retval = constructName(authors[0], citenameform) + (buf ? buf->B_(etal) : from_ascii(etal));
610 return convertLaTeXCommands(retval);
614 docstring const BibTeXInfo::getYear() const
617 // first try legacy year field
618 docstring year = operator[]("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}).*");
628 string const date = to_utf8(year);
629 if (!regex_match(date, sm, yreg))
630 // cannot parse year.
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]);
639 docstring const opt = label();
644 docstring tmp = split(opt, authors, '(');
646 // we don't have author (year)
649 tmp = split(tmp, year, ')');
656 docstring parseOptions(docstring const & format, string & optkey,
657 docstring & ifpart, docstring & elsepart);
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)
666 LASSERT(format[0] == '{' && format[1] == '%', return format);
670 docstring const rest = parseOptions(format, optkey, ifpart, elsepart);
671 if (format == rest) { // parse error
672 LYXERR0("ERROR! Couldn't parse `" << format <<"'.");
675 LASSERT(rest.size() <= format.size(),
676 { ifelsepart = docstring(); return format; });
677 ifelsepart = format.substr(0, format.size() - rest.size());
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)
687 docstring fmt = format;
690 // we'll remove characters from the front of fmt as we
692 while (!fmt.empty()) {
693 if (fmt[0] == ']' && fmt.size() > 1 && fmt[1] == ']') {
698 // check for an embedded option
699 if (fmt[0] == '{' && fmt.size() > 1 && fmt[1] == '%') {
701 docstring const rest = parseEmbeddedOption(fmt, part);
703 LYXERR0("ERROR! Couldn't parse embedded option in `" << format <<"'.");
708 } else { // it's just a normal character
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)
724 LASSERT(format[0] == '{' && format[1] == '%', return format);
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.");
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.");
740 docstring curfmt = fmt;
741 fmt = getClause(curfmt, ifpart);
743 LYXERR0("Error parsing `" << format <<"'. Couldn't get if clause.");
747 if (fmt[0] == '}') // we're done, no else clause
748 return fmt.substr(1);
750 // else part should follow
751 if (fmt[0] != '[' || fmt[1] != '[') {
752 LYXERR0("Error parsing `" << format <<"'. Can't find else clause.");
757 fmt = getClause(curfmt, elsepart);
759 if (fmt == curfmt || fmt[0] != '}') {
760 LYXERR0("Error parsing `" << format <<"'. Can't find end of option.");
763 return fmt.substr(1);
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.
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
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
792 bool scanning_key = false;
793 bool scanning_rich = false;
795 CiteEngineType const engine_type = buf.params().citeEngineType();
796 docstring fmt = format;
797 // we'll remove characters from the front of fmt as we
799 while (!fmt.empty()) {
800 if (counter > max_passes) {
801 LYXERR0("Recursion limit reached while parsing `"
806 char_type thischar = fmt[0];
807 if (thischar == '%') {
808 // beginning or end of key
811 scanning_key = false;
812 // so we replace the key with its value, which may be empty
816 buf.params().documentClass().getCiteMacro(engine_type, key);
817 fmt = from_utf8(val) + fmt.substr(1);
820 } else if (prefixIs(key, "B_")) {
821 // a translatable bit (to the Buffer language)
823 buf.params().documentClass().getCiteMacro(engine_type, key);
824 docstring const trans =
825 translateIfPossible(from_utf8(val), buf.params().language->code());
827 } else if (key[0] == '_') {
828 // a translatable bit (to the GUI language)
830 buf.params().documentClass().getCiteMacro(engine_type, key);
831 docstring const trans =
832 translateIfPossible(from_utf8(val));
835 docstring const val =
836 getValueForKey(key, buf, ci, xrefs, max_keysize);
838 ret << from_ascii("{!<span class=\"bib-" + key + "\">!}");
841 ret << from_ascii("{!</span>!}");
849 else if (thischar == '{') {
850 // beginning of option?
852 LYXERR0("ERROR: Found `{' when scanning key in `" << format << "'.");
855 if (fmt.size() > 1) {
857 // it is the beginning of an optional format
861 docstring const newfmt =
862 parseOptions(fmt, optkey, ifpart, elsepart);
863 if (newfmt == fmt) // parse error
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) {
872 ret << expandFormat(ifpart, xrefs, newcounter, buf,
874 } else if (!val.empty()) {
876 ret << expandFormat(ifpart, xrefs, newcounter, buf,
878 } else if (!elsepart.empty()) {
880 ret << expandFormat(elsepart, xrefs, newcounter, buf,
883 // fmt will have been shortened for us already
887 // beginning of rich text
888 scanning_rich = true;
890 ret << from_ascii("{!");
894 // we are here if '{' was not followed by % or !.
895 // So it's just a character.
898 else if (scanning_rich && thischar == '!'
899 && fmt.size() > 1 && fmt[1] == '}') {
901 scanning_rich = false;
903 ret << from_ascii("!}");
906 else if (scanning_key)
907 key += char(thischar);
911 } catch (EncodingException & /* e */) {
912 LYXERR0("Uncodable character '" << docstring(1, thischar) << " in citation label!");
918 LYXERR0("Never found end of key in `" << format << "'!");
922 LYXERR0("Never found end of rich text in `" << format << "'!");
929 docstring const & BibTeXInfo::getInfo(BibTeXInfoList const & xrefs,
930 Buffer const & buf, CiteItem const & ci) const
932 bool const richtext = ci.richtext;
934 if (!richtext && !info_.empty())
936 if (richtext && !info_richtext_.empty())
937 return info_richtext_;
940 BibTeXInfo::const_iterator it = find(from_ascii("ref"));
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_)));
950 info_ = expandFormat(format, xrefs, counter, buf,
954 // this probably shouldn't happen
959 info_richtext_ = convertLaTeXCommands(processRichtext(info_, true));
960 return info_richtext_;
963 info_ = convertLaTeXCommands(processRichtext(info_, false));
968 docstring const BibTeXInfo::getLabel(BibTeXInfoList const xrefs,
969 Buffer const & buf, docstring const & format,
970 CiteItem const & ci, bool next, bool second) const
975 loclabel = expandFormat(format, xrefs, counter, buf, ci, next, second);
977 if (!loclabel.empty() && !next) {
978 loclabel = processRichtext(loclabel, ci.richtext);
979 loclabel = convertLaTeXCommands(loclabel);
986 docstring const & BibTeXInfo::operator[](docstring const & field) const
988 BibTeXInfo::const_iterator it = find(field);
991 static docstring const empty_value = docstring();
996 docstring const & BibTeXInfo::operator[](string const & field) const
998 return operator[](from_ascii(field));
1002 docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf,
1003 CiteItem const & ci, BibTeXInfoList const & xrefs, size_t maxsize) const
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);
1014 docstring ret = operator[](key);
1015 if (ret.empty() && !xrefs.empty()) {
1016 // xr is a (reference to a) BibTeXInfo const *
1017 for (auto const & xr : xrefs) {
1018 if (xr && !(*xr)[key].empty()) {
1025 // some special keys
1026 // FIXME: dialog, textbefore and textafter have nothing to do with this
1027 if (key == "dialog" && ci.context == CiteItem::Dialog)
1028 ret = from_ascii("x"); // any non-empty string will do
1029 else if (key == "export" && ci.context == CiteItem::Export)
1030 ret = from_ascii("x"); // any non-empty string will do
1031 else if (key == "ifstar" && ci.Starred)
1032 ret = from_ascii("x"); // any non-empty string will do
1033 else if (key == "ifqualified" && ci.isQualified)
1034 ret = from_ascii("x"); // any non-empty string will do
1035 else if (key == "entrytype")
1037 else if (prefixIs(key, "ifentrytype:")
1038 && from_ascii(key.substr(12)) == entry_type_)
1039 ret = from_ascii("x"); // any non-empty string will do
1040 else if (key == "key")
1042 else if (key == "label")
1044 else if (key == "modifier" && modifier_ != 0)
1046 else if (key == "numericallabel")
1048 else if (prefixIs(key, "ifmultiple:")) {
1049 // Return whether we have multiple authors
1050 docstring const kind = operator[](from_ascii(key.substr(11)));
1051 if (multipleAuthors(kind))
1052 ret = from_ascii("x"); // any non-empty string will do
1054 else if (prefixIs(key, "abbrvnames:")) {
1055 // Special key to provide abbreviated name list,
1056 // with respect to maxcitenames. Suitable for Bibliography
1058 docstring const kind = operator[](from_ascii(key.substr(11)));
1059 ret = getAuthorList(&buf, kind, false, false, true);
1060 if (ci.forceUpperCase && isLowerCase(ret[0]))
1061 ret[0] = uppercase(ret[0]);
1062 } else if (prefixIs(key, "fullnames:")) {
1063 // Return a full name list. Suitable for Bibliography
1065 docstring const kind = operator[](from_ascii(key.substr(10)));
1066 ret = getAuthorList(&buf, kind, true, false, true);
1067 if (ci.forceUpperCase && isLowerCase(ret[0]))
1068 ret[0] = uppercase(ret[0]);
1069 } else if (prefixIs(key, "forceabbrvnames:")) {
1070 // Special key to provide abbreviated name lists,
1071 // irrespective of maxcitenames. Suitable for Bibliography
1073 docstring const kind = operator[](from_ascii(key.substr(15)));
1074 ret = getAuthorList(&buf, kind, false, true, true);
1075 if (ci.forceUpperCase && isLowerCase(ret[0]))
1076 ret[0] = uppercase(ret[0]);
1077 } else if (prefixIs(key, "abbrvbynames:")) {
1078 // Special key to provide abbreviated name list,
1079 // with respect to maxcitenames. Suitable for further names inside a
1080 // bibliography item // (such as "ed. by ...")
1081 docstring const kind = operator[](from_ascii(key.substr(11)));
1082 ret = getAuthorList(&buf, kind, false, false, true, false);
1083 if (ci.forceUpperCase && isLowerCase(ret[0]))
1084 ret[0] = uppercase(ret[0]);
1085 } else if (prefixIs(key, "fullbynames:")) {
1086 // Return a full name list. Suitable for further names inside a
1087 // bibliography item // (such as "ed. by ...")
1088 docstring const kind = operator[](from_ascii(key.substr(10)));
1089 ret = getAuthorList(&buf, kind, true, false, true, false);
1090 if (ci.forceUpperCase && isLowerCase(ret[0]))
1091 ret[0] = uppercase(ret[0]);
1092 } else if (prefixIs(key, "forceabbrvbynames:")) {
1093 // Special key to provide abbreviated name lists,
1094 // irrespective of maxcitenames. Suitable for further names inside a
1095 // bibliography item // (such as "ed. by ...")
1096 docstring const kind = operator[](from_ascii(key.substr(15)));
1097 ret = getAuthorList(&buf, kind, false, true, true, false);
1098 if (ci.forceUpperCase && isLowerCase(ret[0]))
1099 ret[0] = uppercase(ret[0]);
1100 } else if (key == "abbrvciteauthor") {
1101 // Special key to provide abbreviated author or
1102 // editor names (suitable for citation labels),
1103 // with respect to maxcitenames.
1104 ret = getAuthorOrEditorList(&buf, false, false);
1105 if (ci.forceUpperCase && isLowerCase(ret[0]))
1106 ret[0] = uppercase(ret[0]);
1107 } else if (key == "fullciteauthor") {
1108 // Return a full author or editor list (for citation labels)
1109 ret = getAuthorOrEditorList(&buf, true, false);
1110 if (ci.forceUpperCase && isLowerCase(ret[0]))
1111 ret[0] = uppercase(ret[0]);
1112 } else if (key == "forceabbrvciteauthor") {
1113 // Special key to provide abbreviated author or
1114 // editor names (suitable for citation labels),
1115 // irrespective of maxcitenames.
1116 ret = getAuthorOrEditorList(&buf, false, true);
1117 if (ci.forceUpperCase && isLowerCase(ret[0]))
1118 ret[0] = uppercase(ret[0]);
1119 } else if (key == "bibentry") {
1120 // Special key to provide the full bibliography entry: see getInfo()
1121 CiteEngineType const engine_type = buf.params().citeEngineType();
1122 DocumentClass const & dc = buf.params().documentClass();
1123 docstring const & format =
1124 from_utf8(dc.getCiteFormat(engine_type, to_utf8(entry_type_), false));
1126 ret = expandFormat(format, xrefs, counter, buf, ci, false, false);
1127 } else if (key == "textbefore")
1128 ret = ci.textBefore;
1129 else if (key == "textafter")
1131 else if (key == "curpretext") {
1132 vector<pair<docstring, docstring>> pres = ci.getPretexts();
1133 vector<pair<docstring, docstring>>::iterator it = pres.begin();
1135 for (; it != pres.end() ; ++it) {
1136 if ((*it).first == bib_key_ && numkey == num_bib_key_) {
1141 if ((*it).first == bib_key_)
1144 } else if (key == "curposttext") {
1145 vector<pair<docstring, docstring>> posts = ci.getPosttexts();
1146 vector<pair<docstring, docstring>>::iterator it = posts.begin();
1148 for (; it != posts.end() ; ++it) {
1149 if ((*it).first == bib_key_ && numkey == num_bib_key_) {
1154 if ((*it).first == bib_key_)
1157 } else if (key == "year")
1162 ret = html::cleanAttr(ret);
1164 // make sure it is not too big
1165 support::truncateWithEllipsis(ret, maxsize);
1170 //////////////////////////////////////////////////////////////////////
1174 //////////////////////////////////////////////////////////////////////
1178 // A functor for use with sort, leading to case insensitive sorting
1179 class compareNoCase: public binary_function<docstring, docstring, bool>
1182 bool operator()(docstring const & s1, docstring const & s2) const {
1183 return compare_no_case(s1, s2) < 0;
1190 vector<docstring> const BiblioInfo::getXRefs(BibTeXInfo const & data, bool const nested) const
1192 vector<docstring> result;
1193 if (!data.isBibTeX())
1195 // Legacy crossref field. This is not nestable.
1196 if (!nested && !data["crossref"].empty()) {
1197 docstring const xrefkey = data["crossref"];
1198 result.push_back(xrefkey);
1199 // However, check for nested xdatas
1200 BiblioInfo::const_iterator it = find(xrefkey);
1202 BibTeXInfo const & xref = it->second;
1203 vector<docstring> const nxdata = getXRefs(xref, true);
1204 if (!nxdata.empty())
1205 result.insert(result.end(), nxdata.begin(), nxdata.end());
1208 // Biblatex's xdata field. Infinitely nestable.
1209 // XData field can consist of a comma-separated list of keys
1210 vector<docstring> const xdatakeys = getVectorFromString(data["xdata"]);
1211 if (!xdatakeys.empty()) {
1212 for (auto const & xdatakey : xdatakeys) {
1213 result.push_back(xdatakey);
1214 BiblioInfo::const_iterator it = find(xdatakey);
1216 BibTeXInfo const & xdata = it->second;
1217 vector<docstring> const nxdata = getXRefs(xdata, true);
1218 if (!nxdata.empty())
1219 result.insert(result.end(), nxdata.begin(), nxdata.end());
1227 vector<docstring> const BiblioInfo::getKeys() const
1229 vector<docstring> bibkeys;
1230 for (auto const & bi : *this)
1231 bibkeys.push_back(bi.first);
1232 sort(bibkeys.begin(), bibkeys.end(), compareNoCase());
1237 vector<docstring> const BiblioInfo::getFields() const
1239 vector<docstring> bibfields;
1240 for (auto const & fn : field_names_)
1241 bibfields.push_back(fn);
1242 sort(bibfields.begin(), bibfields.end());
1247 vector<docstring> const BiblioInfo::getEntries() const
1249 vector<docstring> bibentries;
1250 for (auto const & et : entry_types_)
1251 bibentries.push_back(et);
1252 sort(bibentries.begin(), bibentries.end());
1257 docstring const BiblioInfo::getAuthorOrEditorList(docstring const & key, Buffer const & buf) const
1259 BiblioInfo::const_iterator it = find(key);
1262 BibTeXInfo const & data = it->second;
1263 return data.getAuthorOrEditorList(&buf, false);
1267 docstring const BiblioInfo::getCiteNumber(docstring const & key) const
1269 BiblioInfo::const_iterator it = find(key);
1272 BibTeXInfo const & data = it->second;
1273 return data.citeNumber();
1277 docstring const BiblioInfo::getYear(docstring const & key, bool use_modifier) const
1279 BiblioInfo::const_iterator it = find(key);
1282 BibTeXInfo const & data = it->second;
1283 docstring year = data.getYear();
1285 // let's try the crossrefs
1286 vector<docstring> const xrefs = getXRefs(data);
1290 for (docstring const & xref : xrefs) {
1291 BiblioInfo::const_iterator const xrefit = find(xref);
1292 if (xrefit == end())
1294 BibTeXInfo const & xref_data = xrefit->second;
1295 year = xref_data.getYear();
1301 if (use_modifier && data.modifier() != 0)
1302 year += data.modifier();
1307 docstring const BiblioInfo::getYear(docstring const & key, Buffer const & buf, bool use_modifier) const
1309 docstring const year = getYear(key, use_modifier);
1311 return buf.B_("No year");
1316 docstring const BiblioInfo::getInfo(docstring const & key,
1317 Buffer const & buf, CiteItem const & ci) const
1319 BiblioInfo::const_iterator it = find(key);
1321 return docstring(_("Bibliography entry not found!"));
1322 BibTeXInfo const & data = it->second;
1323 BibTeXInfoList xrefptrs;
1324 for (docstring const & xref : getXRefs(data)) {
1325 BiblioInfo::const_iterator const xrefit = find(xref);
1326 if (xrefit != end())
1327 xrefptrs.push_back(&(xrefit->second));
1329 return data.getInfo(xrefptrs, buf, ci);
1333 docstring const BiblioInfo::getLabel(vector<docstring> keys,
1334 Buffer const & buf, string const & style, CiteItem const & ci) const
1336 size_t max_size = ci.max_size;
1337 // shorter makes no sense
1338 LASSERT(max_size >= 16, max_size = 16);
1340 // we can't display more than 10 of these, anyway
1341 // but since we truncate in the middle,
1342 // we need to split into two halfs.
1343 bool const too_many_keys = keys.size() > 10;
1344 vector<docstring> lkeys;
1345 if (too_many_keys) {
1346 lkeys.insert(lkeys.end(), keys.end() - 5, keys.end());
1348 keys.insert(keys.end(), lkeys.begin(), lkeys.end());
1351 CiteEngineType const engine_type = buf.params().citeEngineType();
1352 DocumentClass const & dc = buf.params().documentClass();
1353 docstring const & format = from_utf8(dc.getCiteFormat(engine_type, style, false, "cite"));
1354 docstring ret = format;
1355 vector<docstring>::const_iterator key = keys.begin();
1356 vector<docstring>::const_iterator ken = keys.end();
1357 vector<docstring> handled_keys;
1358 for (int i = 0; key != ken; ++key, ++i) {
1359 handled_keys.push_back(*key);
1361 for (auto const & k : handled_keys) {
1365 BiblioInfo::const_iterator it = find(*key);
1366 BibTeXInfo empty_data;
1367 empty_data.key(*key);
1368 BibTeXInfo & data = empty_data;
1369 vector<BibTeXInfo const *> xrefptrs;
1372 for (docstring const & xref : getXRefs(data)) {
1373 BiblioInfo::const_iterator const xrefit = find(xref);
1374 if (xrefit != end())
1375 xrefptrs.push_back(&(xrefit->second));
1379 ret = data.getLabel(xrefptrs, buf, ret, ci, key + 1 != ken, i == 1);
1382 support::truncateWithEllipsis(ret, max_size, true);
1388 bool BiblioInfo::isBibtex(docstring const & key) const
1391 split(key, key1, ',');
1392 BiblioInfo::const_iterator it = find(key1);
1395 return it->second.isBibTeX();
1399 BiblioInfo::CiteStringMap const BiblioInfo::getCiteStrings(
1400 vector<docstring> const & keys, vector<CitationStyle> const & styles,
1401 Buffer const & buf, CiteItem const & ci) const
1404 return vector<pair<docstring,docstring>>();
1407 CiteStringMap csm(styles.size());
1408 for (size_t i = 0; i != csm.size(); ++i) {
1409 style = styles[i].name;
1410 csm[i] = make_pair(from_ascii(style), getLabel(keys, buf, style, ci));
1417 void BiblioInfo::mergeBiblioInfo(BiblioInfo const & info)
1419 bimap_.insert(info.begin(), info.end());
1420 field_names_.insert(info.field_names_.begin(), info.field_names_.end());
1421 entry_types_.insert(info.entry_types_.begin(), info.entry_types_.end());
1427 // used in xhtml to sort a list of BibTeXInfo objects
1428 bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs)
1430 docstring const lauth = lhs->getAuthorOrEditorList();
1431 docstring const rauth = rhs->getAuthorOrEditorList();
1432 docstring const lyear = lhs->getYear();
1433 docstring const ryear = rhs->getYear();
1434 docstring const ltitl = lhs->operator[]("title");
1435 docstring const rtitl = rhs->operator[]("title");
1436 return (lauth < rauth)
1437 || (lauth == rauth && lyear < ryear)
1438 || (lauth == rauth && lyear == ryear && ltitl < rtitl);
1444 void BiblioInfo::collectCitedEntries(Buffer const & buf)
1446 cited_entries_.clear();
1447 // We are going to collect all the citation keys used in the document,
1448 // getting them from the TOC.
1449 // FIXME We may want to collect these differently, in the first case,
1450 // so that we might have them in order of appearance.
1451 set<docstring> citekeys;
1452 Toc const toc = *buf.tocBackend().toc("citation");
1453 for (auto const & t : toc) {
1454 if (t.str().empty())
1456 vector<docstring> const keys = getVectorFromString(t.str());
1457 citekeys.insert(keys.begin(), keys.end());
1459 if (citekeys.empty())
1462 // We have a set of the keys used in this document.
1463 // We will now convert it to a list of the BibTeXInfo objects used in
1465 vector<BibTeXInfo const *> bi;
1466 for (auto const & ck : citekeys) {
1467 BiblioInfo::const_iterator const bt = find(ck);
1468 if (bt == end() || !bt->second.isBibTeX())
1470 bi.push_back(&(bt->second));
1473 sort(bi.begin(), bi.end(), lSorter);
1475 // Now we can write the sorted keys
1476 // b is a BibTeXInfo const *
1477 for (auto const & b : bi)
1478 cited_entries_.push_back(b->key());
1482 void BiblioInfo::makeCitationLabels(Buffer const & buf)
1484 collectCitedEntries(buf);
1485 CiteEngineType const engine_type = buf.params().citeEngineType();
1486 bool const numbers = (engine_type & ENGINE_TYPE_NUMERICAL);
1490 // used to remember the last one we saw
1491 // we'll be comparing entries to see if we need to add
1492 // modifiers, like "1984a"
1493 map<docstring, BibTeXInfo>::iterator last = bimap_.end();
1495 // add letters to years
1496 for (auto const & ce : cited_entries_) {
1497 map<docstring, BibTeXInfo>::iterator const biit = bimap_.find(ce);
1498 // this shouldn't happen, but...
1499 if (biit == bimap_.end())
1500 // ...fail gracefully, anyway.
1502 BibTeXInfo & entry = biit->second;
1504 docstring const num = convert<docstring>(++keynumber);
1505 entry.setCiteNumber(num);
1507 // The first test here is checking whether this is the first
1508 // time through the loop. If so, then we do not have anything
1509 // with which to compare.
1510 if (last != bimap_.end()
1511 && entry.getAuthorOrEditorList() == last->second.getAuthorOrEditorList()
1512 // we access the year via getYear() so as to get it from the xref,
1513 // if we need to do so
1514 && getYear(entry.key()) == getYear(last->second.key())) {
1515 if (modifier == 0) {
1516 // so the last one should have been 'a'
1517 last->second.setModifier('a');
1519 } else if (modifier == 'z')
1526 entry.setModifier(modifier);
1527 // remember the last one
1532 for (auto const & ce : cited_entries_) {
1533 map<docstring, BibTeXInfo>::iterator const biit = bimap_.find(ce);
1534 // this shouldn't happen, but...
1535 if (biit == bimap_.end())
1536 // ...fail gracefully, anyway.
1538 BibTeXInfo & entry = biit->second;
1540 entry.label(entry.citeNumber());
1542 docstring const auth = entry.getAuthorOrEditorList(&buf, false);
1543 // we do it this way so as to access the xref, if necessary
1544 // note that this also gives us the modifier
1545 docstring const year = getYear(ce, buf, true);
1546 if (!auth.empty() && !year.empty())
1547 entry.label(auth + ' ' + year);
1549 entry.label(entry.key());
1555 //////////////////////////////////////////////////////////////////////
1559 //////////////////////////////////////////////////////////////////////
1562 CitationStyle citationStyleFromString(string const & command,
1563 BufferParams const & params)
1566 if (command.empty())
1569 string const alias = params.getCiteAlias(command);
1570 string cmd = alias.empty() ? command : alias;
1571 if (isUpperCase(command[0])) {
1572 cs.forceUpperCase = true;
1573 cmd[0] = lowercase(cmd[0]);
1576 size_t const n = command.size() - 1;
1577 if (command[n] == '*') {
1578 cs.hasStarredVersion = true;
1579 if (suffixIs(cmd, '*'))
1580 cmd = cmd.substr(0, cmd.size() - 1);
1588 string citationStyleToString(const CitationStyle & cs, bool const latex)
1590 string cmd = latex ? cs.cmd : cs.name;
1591 if (cs.forceUpperCase)
1592 cmd[0] = uppercase(cmd[0]);
1593 if (cs.hasStarredVersion)