#include "insets/InsetBibtex.h"
#include "insets/InsetInclude.h"
+#include "support/convert.h"
+#include "support/debug.h"
#include "support/docstream.h"
#include "support/gettext.h"
#include "support/lassert.h"
return ret;
}
+// these are used in the expandFormat() routine, etc.
+
+static string const pp_text = N_("pp.");
+static string const ed_text = N_("ed.");
+static string const edby_text = N_("ed. by");
+
} // anon namespace
//////////////////////////////////////////////////////////////////////
BibTeXInfo::BibTeXInfo(docstring const & key, docstring const & type)
- : is_bibtex_(true), bib_key_(key), entry_type_(type), info_()
+ : is_bibtex_(true), bib_key_(key), entry_type_(type), info_(),
+ modifier_(0)
{}
-bool BibTeXInfo::hasField(docstring const & field) const
-{
- return count(field) == 1;
-}
-
-
docstring const BibTeXInfo::getAbbreviatedAuthor() const
{
if (!is_bibtex_) {
return docstring();
docstring authors;
- split(opt, authors, '(');
+ docstring const remainder = trim(split(opt, authors, '('));
+ if (remainder.empty())
+ // in this case, we didn't find a "(",
+ // so we don't have author (year)
+ return docstring();
return authors;
}
return bib_key_;
}
+ // FIXME Move this to a separate routine that can
+ // be called from elsewhere.
+ //
// OK, we've got some names. Let's format them.
// Try to split the author list on " and "
vector<docstring> const authors =
return docstring();
docstring authors;
- docstring const tmp = split(opt, authors, '(');
+ docstring tmp = split(opt, authors, '(');
+ if (tmp.empty())
+ // we don't have author (year)
+ return docstring();
docstring year;
- split(tmp, year, ')');
+ tmp = split(tmp, year, ')');
return year;
}
}
-docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref) const
+namespace {
+ string parseOptions(string const & format, string & optkey,
+ string & ifpart, string & elsepart);
+
+ /// Calls parseOptions to deal with an embedded option, such as:
+ /// {%number%[[, no.~%number%]]}
+ /// which must appear at the start of format. ifelsepart gets the
+ /// whole of the option, and we return what's left after the option.
+ /// we return format if there is an error.
+ string parseEmbeddedOption(string const & format, string & ifelsepart)
+ {
+ LASSERT(format[0] == '{' && format[1] == '%', return format);
+ string optkey;
+ string ifpart;
+ string elsepart;
+ string const rest = parseOptions(format, optkey, ifpart, elsepart);
+ if (format == rest) { // parse error
+ LYXERR0("ERROR! Couldn't parse `" << format <<"'.");
+ return format;
+ }
+ LASSERT(rest.size() <= format.size(), /* */);
+ ifelsepart = format.substr(0, format.size() - rest.size());
+ return rest;
+ }
+
+
+ // Gets a "clause" from a format string, where the clause is
+ // delimited by '[[' and ']]'. Returns what is left after the
+ // clause is removed, and returns format if there is an error.
+ string getClause(string const & format, string & clause)
+ {
+ string fmt = format;
+ // remove '[['
+ fmt = fmt.substr(2);
+ // we'll remove characters from the front of fmt as we
+ // deal with them
+ while (fmt.size()) {
+ if (fmt[0] == ']' && fmt.size() > 1 && fmt[1] == ']') {
+ // that's the end
+ fmt = fmt.substr(2);
+ break;
+ }
+ // check for an embedded option
+ if (fmt[0] == '{' && fmt.size() > 1 && fmt[1] == '%') {
+ string part;
+ string const rest = parseEmbeddedOption(fmt, part);
+ if (fmt == rest) {
+ LYXERR0("ERROR! Couldn't parse `" << format <<"'.");
+ return format;
+ }
+ clause += part;
+ fmt = rest;
+ } else { // it's just a normal character
+ clause += fmt[0];
+ fmt = fmt.substr(1);
+ }
+ }
+ return fmt;
+ }
+
+
+ /// parse an options string, which must appear at the start of the
+ /// format parameter. puts the parsed bits in optkey, ifpart, and
+ /// elsepart and returns what's left after the option is removed.
+ /// if there's an error, it returns format itself.
+ string parseOptions(string const & format, string & optkey,
+ string & ifpart, string & elsepart)
+ {
+ LASSERT(format[0] == '{' && format[1] == '%', return format);
+ // strip '{%'
+ string fmt = format.substr(2);
+ size_t pos = fmt.find('%'); // end of key
+ if (pos == string::npos) {
+ LYXERR0("Error parsing `" << format <<"'. Can't find end of key.");
+ return format;
+ }
+ optkey = fmt.substr(0,pos);
+ fmt = fmt.substr(pos + 1);
+ // [[format]] should be next
+ if (fmt[0] != '[' || fmt[1] != '[') {
+ LYXERR0("Error parsing `" << format <<"'. Can't find '[[' after key.");
+ return format;
+ }
+
+ string curfmt = fmt;
+ fmt = getClause(curfmt, ifpart);
+ if (fmt == curfmt) {
+ LYXERR0("Error parsing `" << format <<"'. Couldn't get if clause.");
+ return format;
+ }
+
+ if (fmt[0] == '}') // we're done, no else clause
+ return fmt.substr(1);
+
+ // else part should follow
+ if (fmt[0] != '[' || fmt[1] != '[') {
+ LYXERR0("Error parsing `" << format <<"'. Can't find else clause.");
+ return format;
+ }
+
+ curfmt = fmt;
+ fmt = getClause(curfmt, elsepart);
+ // we should be done
+ if (fmt == curfmt || fmt[0] != '}') {
+ LYXERR0("Error parsing `" << format <<"'. Can't find end of option.");
+ return format;
+ }
+ return fmt.substr(1);
+}
+
+} // anon namespace
+
+
+docstring BibTeXInfo::expandFormat(string const & format,
+ BibTeXInfo const * const xref, bool richtext) const
+{
+ // return value
+ docstring ret;
+ string key;
+ bool scanning_key = false;
+ bool scanning_rich = false;
+
+ string fmt = format;
+ // we'll remove characters from the front of fmt as we
+ // deal with them
+ while (fmt.size()) {
+ char_type thischar = fmt[0];
+ if (thischar == '%') {
+ // beginning or end of key
+ if (scanning_key) {
+ // end of key
+ scanning_key = false;
+ // so we replace the key with its value, which may be empty
+ if (key == "pp_text")
+ ret += _(pp_text);
+ else if (key == "ed_text")
+ ret += _(ed_text);
+ else if(key == "edby_text")
+ ret += _(edby_text);
+ else {
+ docstring const val = getValueForKey(key, xref);
+ ret += val;
+ }
+ key.clear();
+ } else {
+ // beginning of key
+ scanning_key = true;
+ }
+ }
+ else if (thischar == '{') {
+ // beginning of option?
+ if (scanning_key) {
+ LYXERR0("ERROR: Found `{' when scanning key in `" << format << "'.");
+ return _("ERROR!");
+ }
+ if (fmt.size() > 1) {
+ if (fmt[1] == '%') {
+ // it is the beginning of an optional format
+ string optkey;
+ string ifpart;
+ string elsepart;
+ string const newfmt =
+ parseOptions(fmt, optkey, ifpart, elsepart);
+ if (newfmt == fmt) // parse error
+ return _("ERROR!");
+ fmt = newfmt;
+ docstring const val = getValueForKey(optkey, xref);
+ if (!val.empty())
+ ret += expandFormat(ifpart, xref, richtext);
+ else if (!elsepart.empty())
+ ret += expandFormat(elsepart, xref, richtext);
+ // fmt will have been shortened for us already
+ continue;
+ }
+ if (fmt[1] == '!') {
+ // beginning of rich text
+ scanning_rich = true;
+ fmt = fmt.substr(2);
+ continue;
+ }
+ }
+ // we are here if the '{' was at the end of the format. hmm.
+ ret += thischar;
+ }
+ else if (scanning_rich && thischar == '!'
+ && fmt.size() > 1 && fmt[1] == '}') {
+ // end of rich text
+ scanning_rich = false;
+ fmt = fmt.substr(2);
+ continue;
+ }
+ else if (scanning_key)
+ key += thischar;
+ else if (richtext || !scanning_rich)
+ ret += thischar;
+ // else the character is discarded, which will happen only if
+ // richtext == false and we are scanning rich text
+ fmt = fmt.substr(1);
+ } // for loop
+ if (scanning_key) {
+ LYXERR0("Never found end of key in `" << format << "'!");
+ return _("ERROR!");
+ }
+ if (scanning_rich) {
+ LYXERR0("Never found end of rich text in `" << format << "'!");
+ return _("ERROR!");
+ }
+ return ret;
+}
+
+
+namespace {
+
+// FIXME These would be better read from a file, so that they
+// could be customized.
+
+ static string articleFormat = "%author%, \"%title%\", {!<i>!}%journal%{!</i>!} {%volume%[[ %volume%{%number%[[, %number%]]}]]} (%year%){%pages%[[, %pp_text% %pages%]]}.{%note%[[ %note%]]}";
+
+ static string bookFormat = "{%author%[[%author%]][[%editor%, %ed_text%]]}, {!<i>!}%title%{!</i>!}{%volume%[[ vol. %volume%]][[{%number%[[no. %number%]]}]]}{%edition%[[%edition%]]} ({%address%[[%address%: ]]}%publisher%, %year%).{%note%[[ %note%]]}";
+
+ static string inSomething = "%author%, \"%title%\", in{%editor%[[ %editor%, %ed_text%,]]} {!<i>!}%booktitle%{!</i>!}{%volume%[[ vol. %volume%]][[{%number%[[no. %number%]]}]]}{%edition%[[%edition%]]} ({%address%[[%address%: ]]}%publisher%, %year%){%pages%[[, %pp_text% %pages%]]}.{%note%[[ %note%]]}";
+
+ static string thesis = "%author%, %title% ({%address%[[%address%: ]]}%school%, %year%).{%note%[[ %note%]]}";
+
+ static string defaultFormat = "{%author%[[%author%, ]][[{%editor%[[%editor%, %ed_text%, ]]}]]}\"%title%\"{%journal%[[, {!<i>!}%journal%{!</i>!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}.";
+
+}
+
+docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref,
+ bool richtext) const
{
if (!info_.empty())
return info_;
info_ = it->second;
return info_;
}
-
- // FIXME
- // This could be made a lot better using the entry_type_
- // field to customize the output based upon entry type.
-
- // Search for all possible "required" fields
- docstring author = getValueForKey("author", xref);
- if (author.empty())
- author = getValueForKey("editor", xref);
-
- docstring year = getValueForKey("year", xref);
- docstring title = getValueForKey("title", xref);
- docstring docLoc = getValueForKey("pages", xref);
- if (docLoc.empty()) {
- docLoc = getValueForKey("chapter", xref);
- if (!docLoc.empty())
- docLoc = _("Ch. ") + docLoc;
- } else {
- docLoc = _("pp. ") + docLoc;
- }
- docstring media = getValueForKey("journal", xref);
- if (media.empty()) {
- media = getValueForKey("publisher", xref);
- if (media.empty()) {
- media = getValueForKey("school", xref);
- if (media.empty())
- media = getValueForKey("institution");
- }
- }
- docstring volume = getValueForKey("volume", xref);
-
- odocstringstream result;
- if (!author.empty())
- result << author << ", ";
- if (!title.empty())
- result << title;
- if (!media.empty())
- result << ", " << media;
- if (!year.empty())
- result << " (" << year << ")";
- if (!docLoc.empty())
- result << ", " << docLoc;
-
- docstring const result_str = rtrim(result.str());
- if (!result_str.empty()) {
- info_ = convertLaTeXCommands(result_str);
- return info_;
- }
+ if (entry_type_ == "article")
+ info_ = expandFormat(articleFormat, xref, richtext);
+ else if (entry_type_ == "book")
+ info_ = expandFormat(bookFormat, xref, richtext);
+ else if (entry_type_.substr(0,2) == "in")
+ info_ = expandFormat(inSomething, xref, richtext);
+ else if (entry_type_ == "phdthesis" || entry_type_ == "mastersthesis")
+ info_ = expandFormat(thesis, xref, richtext);
+ else
+ info_ = expandFormat(defaultFormat, xref, richtext);
- // This should never happen (or at least be very unusual!)
- static docstring e = docstring();
- return e;
+ if (!info_.empty())
+ info_ = convertLaTeXCommands(info_);
+ return info_;
}
}
-docstring const BiblioInfo::getYear(docstring const & key) const
+docstring const BiblioInfo::getCiteNumber(docstring const & key) const
+{
+ BiblioInfo::const_iterator it = find(key);
+ if (it == end())
+ return docstring();
+ BibTeXInfo const & data = it->second;
+ return data.citeNumber();
+}
+
+
+docstring const BiblioInfo::getYear(docstring const & key, bool use_modifier) const
{
BiblioInfo::const_iterator it = find(key);
if (it == end())
return docstring();
BibTeXInfo const & data = it->second;
docstring year = data.getYear();
- if (!year.empty())
- return year;
- // let's try the crossref
- docstring const xref = data.getXRef();
- if (xref.empty())
- return _("No year"); // no luck
- BiblioInfo::const_iterator const xrefit = find(xref);
- if (xrefit == end())
- return _("No year"); // no luck again
- BibTeXInfo const & xref_data = xrefit->second;
- return xref_data.getYear();
- return data.getYear();
+ if (year.empty()) {
+ // let's try the crossref
+ docstring const xref = data.getXRef();
+ if (xref.empty())
+ return _("No year"); // no luck
+ BiblioInfo::const_iterator const xrefit = find(xref);
+ if (xrefit == end())
+ return _("No year"); // no luck again
+ BibTeXInfo const & xref_data = xrefit->second;
+ year = xref_data.getYear();
+ }
+ if (use_modifier && data.modifier() != 0)
+ year += data.modifier();
+ return year;
}
-docstring const BiblioInfo::getInfo(docstring const & key) const
+docstring const BiblioInfo::getInfo(docstring const & key, bool richtext) const
{
BiblioInfo::const_iterator it = find(key);
if (it == end())
if (xrefit != end())
xrefptr = &(xrefit->second);
}
- return data.getInfo(xrefptr);
+ return data.getInfo(xrefptr, richtext);
+}
+
+
+bool BiblioInfo::isBibtex(docstring const & key) const
+{
+ BiblioInfo::const_iterator it = find(key);
+ if (it == end())
+ return false;
+ return it->second.isBibTeX();
}
+
vector<docstring> const BiblioInfo::getCiteStrings(
docstring const & key, Buffer const & buf) const
{
// used in xhtml to sort a list of BibTeXInfo objects
bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs)
{
- return lhs->getAbbreviatedAuthor() < rhs->getAbbreviatedAuthor();
+ docstring const lauth = lhs->getAbbreviatedAuthor();
+ docstring const rauth = rhs->getAbbreviatedAuthor();
+ docstring const lyear = lhs->getYear();
+ docstring const ryear = rhs->getYear();
+ docstring const ltitl = lhs->operator[]("title");
+ docstring const rtitl = rhs->operator[]("title");
+ return (lauth < rauth)
+ || (lauth == rauth && lyear < ryear)
+ || (lauth == rauth && lyear == ryear && ltitl < rtitl);
}
}
}
+void BiblioInfo::makeCitationLabels(Buffer const & buf)
+{
+ collectCitedEntries(buf);
+ CiteEngine const engine = buf.params().citeEngine();
+ bool const numbers =
+ (engine == ENGINE_BASIC || engine == ENGINE_NATBIB_NUMERICAL);
+
+ int keynumber = 0;
+ char modifier = 0;
+ // used to remember the last one we saw
+ // we'll be comparing entries to see if we need to add
+ // modifiers, like "1984a"
+ map<docstring, BibTeXInfo>::iterator last;
+
+ vector<docstring>::const_iterator it = cited_entries_.begin();
+ vector<docstring>::const_iterator const en = cited_entries_.end();
+ for (; it != en; ++it) {
+ map<docstring, BibTeXInfo>::iterator const biit = bimap_.find(*it);
+ // this shouldn't happen, but...
+ if (biit == bimap_.end())
+ // ...fail gracefully, anyway.
+ continue;
+ BibTeXInfo & entry = biit->second;
+ if (numbers) {
+ docstring const num = convert<docstring>(++keynumber);
+ entry.setCiteNumber(num);
+ } else {
+ if (it != cited_entries_.begin()
+ && entry.getAbbreviatedAuthor() == last->second.getAbbreviatedAuthor()
+ // we access the year via getYear() so as to get it from the xref,
+ // if we need to do so
+ && getYear(entry.key()) == getYear(last->second.key())) {
+ if (modifier == 0) {
+ // so the last one should have been 'a'
+ last->second.setModifier('a');
+ modifier = 'b';
+ } else if (modifier == 'z')
+ modifier = 'A';
+ else
+ modifier++;
+ } else {
+ modifier = 0;
+ }
+ entry.setModifier(modifier);
+ // remember the last one
+ last = biit;
+ }
+ }
+}
+
+
//////////////////////////////////////////////////////////////////////
//
// CitationStyle
projects / lyx.git / blobdiff