]> git.lyx.org Git - lyx.git/blobdiff - src/BiblioInfo.cpp
installer: further preparation
[lyx.git] / src / BiblioInfo.cpp
index 7142f7b7e7719f59f8501e26377aeb462cd77732..3298990a00d4e8a7486efa6c1f8eba3f2d094d69 100644 (file)
@@ -6,6 +6,7 @@
  * \author Angus Leeming
  * \author Herbert Voß
  * \author Richard Heck
+ * \author Julien Rioux
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -19,6 +20,7 @@
 #include "Encoding.h"
 #include "InsetIterator.h"
 #include "Language.h"
+#include "output_xhtml.h"
 #include "Paragraph.h"
 #include "TextClass.h"
 #include "TocBackend.h"
@@ -195,6 +197,49 @@ docstring convertLaTeXCommands(docstring const & str)
        return ret;
 }
 
+
+// Escape '<' and '>' and remove richtext markers (e.g. {!this is richtext!}) from a string.
+docstring processRichtext(docstring const & str, bool richtext)
+{
+       docstring val = str;
+       docstring ret;
+
+       bool scanning_rich = false;
+       while (!val.empty()) {
+               char_type const ch = val[0];
+               if (ch == '{' && val.size() > 1 && val[1] == '!') {
+                       // beginning of rich text
+                       scanning_rich = true;
+                       val = val.substr(2);
+                       continue;
+               }
+               if (scanning_rich && ch == '!' && val.size() > 1 && val[1] == '}') {
+                       // end of rich text
+                       scanning_rich = false;
+                       val = val.substr(2);
+                       continue;
+               }
+               if (richtext) {
+                       if (scanning_rich)
+                               ret += ch;
+                       else {
+                               // we need to escape '<' and '>'
+                               if (ch == '<')
+                                       ret += "&lt;";
+                               else if (ch == '>')
+                                       ret += "&gt;";
+                               else
+                                       ret += ch;
+                       }
+               } else if (!scanning_rich /* && !richtext */)
+                       ret += ch;
+               // else the character is discarded, which will happen only if
+               // richtext == false and we are scanning rich text
+               val = val.substr(1);
+       }
+       return ret;
+}
+
 } // anon namespace
 
 
@@ -249,17 +294,33 @@ docstring const BibTeXInfo::getAbbreviatedAuthor(bool jurabib_style) const
                return shortauthor;
        }
 
-       if (authors.size() == 2)
-               return bformat(_("%1$s and %2$s"),
+       if (authors.size() == 2 && authors[1] != "others")
+               return bformat(from_ascii("%1$s and %2$s"),
                        familyName(authors[0]), familyName(authors[1]));
 
-       if (authors.size() > 2)
-               return bformat(_("%1$s et al."), familyName(authors[0]));
+       if (authors.size() >= 2)
+               return bformat(from_ascii("%1$s et al."),
+                       familyName(authors[0]));
 
        return familyName(authors[0]);
 }
 
 
+docstring const BibTeXInfo::getAbbreviatedAuthor(Buffer const & buf, bool jurabib_style) const
+{
+       docstring const author = getAbbreviatedAuthor(jurabib_style);
+       if (!is_bibtex_)
+               return author;
+       vector<docstring> const authors = getVectorFromString(author, from_ascii(" and "));
+       if (authors.size() == 2)
+               return bformat(buf.B_("%1$s and %2$s"), authors[0], authors[1]);
+       docstring::size_type const idx = author.rfind(from_ascii(" et al."));
+       if (idx != docstring::npos)
+               return bformat(buf.B_("%1$s et al."), author.substr(0, idx));
+       return author;
+}
+
+
 docstring const BibTeXInfo::getYear() const
 {
        if (is_bibtex_)
@@ -309,9 +370,10 @@ string parseEmbeddedOption(string const & format, string & ifelsepart)
                LYXERR0("ERROR! Couldn't parse `" << format <<"'.");
                return format;
        }
-       LASSERT(rest.size() <= format.size(), /* */);
+       LASSERT(rest.size() <= format.size(),
+               { ifelsepart = ""; return format; });
        ifelsepart = format.substr(0, format.size() - rest.size());
-               return rest;
+       return rest;
 }
 
 
@@ -405,7 +467,7 @@ string parseOptions(string const & format, string & optkey,
 
 docstring BibTeXInfo::expandFormat(string const & format,
                BibTeXInfo const * const xref, int & counter, Buffer const & buf,
-               bool richtext, docstring before, docstring after, docstring dialog, bool next) const
+               docstring before, docstring after, docstring dialog, bool next) const
 {
        // incorrect use of macros could put us in an infinite loop
        static int max_passes = 5000;
@@ -434,8 +496,6 @@ docstring BibTeXInfo::expandFormat(string const & format,
                                // so we replace the key with its value, which may be empty
                                if (key[0] == '!') {
                                        // macro
-                                       // FIXME: instead of passing the buf, just past the macros
-                                       // FIXME: and the language code
                                        string const val =
                                                buf.params().documentClass().getCiteMacro(engine_type, key);
                                        fmt = val + fmt.substr(1);
@@ -448,8 +508,13 @@ docstring BibTeXInfo::expandFormat(string const & format,
                                                translateIfPossible(from_utf8(val), buf.params().language->code());
                                        ret += trans;
                                } else {
-                                       docstring const val = getValueForKey(key, before, after, dialog, xref);
+                                       docstring const val =
+                                               getValueForKey(key, buf, before, after, dialog, xref);
+                                       if (!scanning_rich)
+                                               ret += from_ascii("{!<span class=\"bib-" + key + "\">!}");
                                        ret += val;
+                                       if (!scanning_rich)
+                                               ret += from_ascii("{!</span>!}");
                                }
                        } else {
                                // beginning of key
@@ -474,15 +539,16 @@ docstring BibTeXInfo::expandFormat(string const & format,
                                        if (newfmt == fmt) // parse error
                                                return _("ERROR!");
                                        fmt = newfmt;
-                                       docstring const val = getValueForKey(optkey, before, after, dialog, xref);
+                                       docstring const val =
+                                               getValueForKey(optkey, buf, before, after, dialog, xref);
                                        if (optkey == "next" && next)
                                                ret += from_utf8(ifpart); // without expansion
                                        else if (!val.empty())
                                                ret += expandFormat(ifpart, xref, counter, buf,
-                                                       richtext, before, after, dialog, next);
+                                                       before, after, dialog, next);
                                        else if (!elsepart.empty())
                                                ret += expandFormat(elsepart, xref, counter, buf,
-                                                       richtext, before, after, dialog, next);
+                                                       before, after, dialog, next);
                                        // fmt will have been shortened for us already
                                        continue;
                                }
@@ -490,6 +556,7 @@ docstring BibTeXInfo::expandFormat(string const & format,
                                        // beginning of rich text
                                        scanning_rich = true;
                                        fmt = fmt.substr(2);
+                                       ret += from_ascii("{!");
                                        continue;
                                }
                        }
@@ -502,26 +569,13 @@ docstring BibTeXInfo::expandFormat(string const & format,
                        // end of rich text
                        scanning_rich = false;
                        fmt = fmt.substr(2);
+                       ret += from_ascii("!}");
                        continue;
                }
                else if (scanning_key)
                        key += char(thischar);
-               else if (richtext) {
-                       if (scanning_rich)
-                               ret += thischar;
-                       else {
-                               // we need to escape '<' and '>'
-                               if (thischar == '<')
-                                       ret += "&lt;";
-                               else if (thischar == '>')
-                                       ret += "&gt;";
-                               else
-                                       ret += thischar;
-                       }
-               }       else if (!scanning_rich /* && !richtext */)
+               else
                        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) {
@@ -539,8 +593,10 @@ docstring BibTeXInfo::expandFormat(string const & format,
 docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref,
        Buffer const & buf, bool richtext) const
 {
-       if (!info_.empty())
+       if (!richtext && !info_.empty())
                return info_;
+       if (richtext && !info_richtext_.empty())
+               return info_richtext_;
 
        if (!is_bibtex_) {
                BibTeXInfo::const_iterator it = find(from_ascii("ref"));
@@ -552,10 +608,15 @@ docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref,
        DocumentClass const & dc = buf.params().documentClass();
        string const & format = dc.getCiteFormat(engine_type, to_utf8(entry_type_));
        int counter = 0;
-       info_ = expandFormat(format, xref, counter, buf, richtext);
-
-       if (!info_.empty())
-               info_ = convertLaTeXCommands(info_);
+       info_ = expandFormat(format, xref, counter, buf,
+               docstring(), docstring(), docstring(), false);
+
+       if (!info_.empty()) {
+               info_richtext_ = convertLaTeXCommands(processRichtext(info_, true));
+               info_ = convertLaTeXCommands(processRichtext(info_, false));
+               if (richtext)
+                       return info_richtext_;
+       }
        return info_;
 }
 
@@ -566,20 +627,14 @@ docstring const BibTeXInfo::getLabel(BibTeXInfo const * const xref,
 {
        docstring loclabel;
 
-       /*
-       if (!is_bibtex_) {
-               BibTeXInfo::const_iterator it = find(from_ascii("ref"));
-               label_ = it->second;
-               return label_;
-       }
-       */
-
        int counter = 0;
-       loclabel = expandFormat(format, xref, counter, buf, richtext,
+       loclabel = expandFormat(format, xref, counter, buf,
                before, after, dialog, next);
 
-       if (!loclabel.empty())
+       if (!loclabel.empty() && !next) {
+               loclabel = processRichtext(loclabel, richtext);
                loclabel = convertLaTeXCommands(loclabel);
+       }
        return loclabel;
 }
 
@@ -600,48 +655,70 @@ docstring const & BibTeXInfo::operator[](string const & field) const
 }
 
 
-docstring BibTeXInfo::getValueForKey(string const & key,
+docstring BibTeXInfo::getValueForKey(string const & oldkey, Buffer const & buf,
        docstring const & before, docstring const & after, docstring const & dialog,
        BibTeXInfo const * const xref) const
 {
+       string key = oldkey;
+       bool cleanit = false;
+       if (prefixIs(oldkey, "clean:")) {
+               key = oldkey.substr(6);
+               cleanit = true;
+       }
+
        docstring ret = operator[](key);
        if (ret.empty() && xref)
                ret = (*xref)[key];
-       if (!ret.empty())
-               return ret;
-       // some special keys
-       // FIXME: dialog, textbefore and textafter have nothing to do with this
-       if (key == "dialog")
-               return dialog;
-       else if (key == "entrytype")
-               return entry_type_;
-       else if (key == "key")
-               return bib_key_;
-       else if (key == "label")
-               return label_;
-       else if (key == "abbrvauthor")
-               // Special key to provide abbreviated author names.
-               return getAbbreviatedAuthor();
-       else if (key == "shortauthor")
-               // When shortauthor is not defined, jurabib automatically
-               // provides jurabib-style abbreviated author names. We do
-               // this as well.
-               return getAbbreviatedAuthor(true);
-       else if (key == "shorttitle") {
-               // When shorttitle is not defined, jurabib uses for `article'
-               // and `periodical' entries the form `journal volume [year]'
-               // and for other types of entries it uses the `title' field.
-               if (entry_type_ == "article" || entry_type_ == "periodical")
-                       return operator[]("journal") + " " + operator[]("volume")
-                               + " [" + operator[]("year") + "]";
-               else
-                       return operator[]("title");
-       } else if (key == "textbefore")
-               return before;
-       else if (key == "textafter")
-               return after;
-       else if (key == "year")
-               return getYear();
+       if (ret.empty()) {
+               // some special keys
+               // FIXME: dialog, textbefore and textafter have nothing to do with this
+               if (key == "dialog")
+                       ret = dialog;
+               else if (key == "entrytype")
+                       ret = entry_type_;
+               else if (key == "key")
+                       ret = bib_key_;
+               else if (key == "label")
+                       ret = label_;
+               else if (key == "modifier" && modifier_ != 0)
+                       ret = modifier_;
+               else if (key == "numericallabel")
+                       ret = cite_number_;
+               else if (key == "abbrvauthor")
+                       // Special key to provide abbreviated author names.
+                       ret = getAbbreviatedAuthor(buf, false);
+               else if (key == "shortauthor")
+                       // When shortauthor is not defined, jurabib automatically
+                       // provides jurabib-style abbreviated author names. We do
+                       // this as well.
+                       ret = getAbbreviatedAuthor(buf, true);
+               else if (key == "shorttitle") {
+                       // When shorttitle is not defined, jurabib uses for `article'
+                       // and `periodical' entries the form `journal volume [year]'
+                       // and for other types of entries it uses the `title' field.
+                       if (entry_type_ == "article" || entry_type_ == "periodical")
+                               ret = operator[]("journal") + " " + operator[]("volume")
+                                       + " [" + operator[]("year") + "]";
+                       else
+                               ret = operator[]("title");
+               } else if (key == "bibentry") {
+                       // Special key to provide the full bibliography entry: see getInfo()
+                       CiteEngineType const engine_type = buf.params().citeEngineType();
+                       DocumentClass const & dc = buf.params().documentClass();
+                       string const & format = dc.getCiteFormat(engine_type, to_utf8(entry_type_));
+                       int counter = 0;
+                       ret = expandFormat(format, xref, counter, buf,
+                               docstring(), docstring(), docstring(), false);
+               } else if (key == "textbefore")
+                       ret = before;
+               else if (key == "textafter")
+                       ret = after;
+               else if (key == "year")
+                       ret = getYear();
+       }
+       if (cleanit)
+               return html::cleanAttr(ret);
+
        return ret;
 }
 
@@ -701,13 +778,13 @@ vector<docstring> const BiblioInfo::getEntries() const
 }
 
 
-docstring const BiblioInfo::getAbbreviatedAuthor(docstring const & key) const
+docstring const BiblioInfo::getAbbreviatedAuthor(docstring const & key, Buffer const & buf) const
 {
        BiblioInfo::const_iterator it = find(key);
        if (it == end())
                return docstring();
        BibTeXInfo const & data = it->second;
-       return data.getAbbreviatedAuthor();
+       return data.getAbbreviatedAuthor(buf, false);
 }
 
 
@@ -732,10 +809,12 @@ docstring const BiblioInfo::getYear(docstring const & key, bool use_modifier) co
                // let's try the crossref
                docstring const xref = data.getXRef();
                if (xref.empty())
-                       return _("No year"); // no luck
+                       // no luck
+                       return docstring();
                BiblioInfo::const_iterator const xrefit = find(xref);
                if (xrefit == end())
-                       return _("No year"); // no luck again
+                       // no luck again
+                       return docstring();
                BibTeXInfo const & xref_data = xrefit->second;
                year = xref_data.getYear();
        }
@@ -745,6 +824,15 @@ docstring const BiblioInfo::getYear(docstring const & key, bool use_modifier) co
 }
 
 
+docstring const BiblioInfo::getYear(docstring const & key, Buffer const & buf, bool use_modifier) const
+{
+       docstring const year = getYear(key, use_modifier);
+       if (year.empty())
+               return buf.B_("No year");
+       return year;
+}
+
+
 docstring const BiblioInfo::getInfo(docstring const & key,
        Buffer const & buf, bool richtext) const
 {
@@ -897,7 +985,7 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf)
 {
        collectCitedEntries(buf);
        CiteEngineType const engine_type = buf.params().citeEngineType();
-       bool const numbers = (engine_type == ENGINE_TYPE_NUMERICAL);
+       bool const numbers = (engine_type & ENGINE_TYPE_NUMERICAL);
 
        int keynumber = 0;
        char modifier = 0;
@@ -940,6 +1028,28 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf)
                        last = biit;
                }
        }
+       // Set the labels
+       it = cited_entries_.begin();
+       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) {
+                       entry.label(entry.citeNumber());
+               } else {
+                       docstring const auth = entry.getAbbreviatedAuthor(buf, false);
+                       // we do it this way so as to access the xref, if necessary
+                       // note that this also gives us the modifier
+                       docstring const year = getYear(*it, buf, true);
+                       if (!auth.empty() && !year.empty())
+                               entry.label(auth + ' ' + year);
+                       else
+                               entry.label(entry.key());
+               }
+       }
 }
 
 
@@ -984,4 +1094,3 @@ string citationStyleToString(const CitationStyle & cs)
 }
 
 } // namespace lyx
-