]> git.lyx.org Git - lyx.git/blobdiff - src/BiblioInfo.cpp
Give a visual feedback that the BibTeX key could not be found.
[lyx.git] / src / BiblioInfo.cpp
index 50ba5d8e097c6c6e1abe95d5b01b1bdf9e55c288..c2761067d33e2975603791703286bc5b83dc303b 100644 (file)
 #include "buffer_funcs.h"
 #include "Encoding.h"
 #include "InsetIterator.h"
+#include "Language.h"
 #include "Paragraph.h"
+#include "TextClass.h"
 #include "TocBackend.h"
 
-#include "insets/Inset.h"
-#include "insets/InsetBibitem.h"
-#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"
 #include "support/lstrings.h"
+#include "support/regex.h"
 #include "support/textutils.h"
 
-#include "boost/regex.hpp"
-
 #include <set>
 
 using namespace std;
@@ -86,7 +82,7 @@ docstring familyName(docstring const & name)
        for (; it != en; ++it) {
                if (!first)
                        retval += " ";
-               else 
+               else
                        first = false;
                retval += *it;
        }
@@ -113,7 +109,7 @@ docstring convertLaTeXCommands(docstring const & str)
                                escaped = false;
                        else if (ch == '\\')
                                escaped = true;
-                       else if (ch == '$') 
+                       else if (ch == '$')
                                scanning_math = false;
                        ret += ch;
                        val = val.substr(1);
@@ -173,8 +169,8 @@ docstring convertLaTeXCommands(docstring const & str)
                // unicodesymbols has things in the form: \"{u},
                // whereas we may see things like: \"u. So we'll
                // look for that and change it, if necessary.
-               static boost::regex const reg("^\\\\\\W\\w");
-               if (boost::regex_search(to_utf8(val), reg)) {
+               static lyx::regex const reg("^\\\\\\W\\w");
+               if (lyx::regex_search(to_utf8(val), reg)) {
                        val.insert(3, from_ascii("}"));
                        val.insert(2, from_ascii("{"));
                }
@@ -195,12 +191,6 @@ docstring convertLaTeXCommands(docstring const & str)
        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
 
 
@@ -226,7 +216,7 @@ docstring const BibTeXInfo::getAbbreviatedAuthor() const
                docstring authors;
                docstring const remainder = trim(split(opt, authors, '('));
                if (remainder.empty())
-                       // in this case, we didn't find a "(", 
+                       // in this case, we didn't find a "(",
                        // so we don't have author (year)
                        return docstring();
                return authors;
@@ -241,7 +231,7 @@ docstring const BibTeXInfo::getAbbreviatedAuthor() const
 
        // 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 =
@@ -260,7 +250,7 @@ docstring const BibTeXInfo::getAbbreviatedAuthor() const
 
 docstring const BibTeXInfo::getYear() const
 {
-       if (is_bibtex_) 
+       if (is_bibtex_)
                return operator[]("year");
 
        docstring const opt = label();
@@ -269,7 +259,7 @@ docstring const BibTeXInfo::getYear() const
 
        docstring authors;
        docstring tmp = split(opt, authors, '(');
-       if (tmp.empty()) 
+       if (tmp.empty())
                // we don't have author (year)
                return docstring();
        docstring year;
@@ -287,7 +277,7 @@ docstring const BibTeXInfo::getXRef() const
 
 
 namespace {
-       string parseOptions(string const & format, string & optkey, 
+       string parseOptions(string const & format, string & optkey,
                        string & ifpart, string & elsepart);
 
        // Calls parseOptions to deal with an embedded option, such as:
@@ -310,9 +300,9 @@ namespace {
                ifelsepart = format.substr(0, format.size() - rest.size());
                return rest;
        }
-       
-       
-       // Gets a "clause" from a format string, where the clause is 
+
+
+       // 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)
@@ -320,9 +310,9 @@ namespace {
                string fmt = format;
                // remove '[['
                fmt = fmt.substr(2);
-               // we'll remove characters from the front of fmt as we 
+               // we'll remove characters from the front of fmt as we
                // deal with them
-               while (fmt.size()) { 
+               while (fmt.size()) {
                        if (fmt[0] == ']' && fmt.size() > 1 && fmt[1] == ']') {
                                // that's the end
                                fmt = fmt.substr(2);
@@ -351,8 +341,8 @@ namespace {
        // 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) 
+       string parseOptions(string const & format, string & optkey,
+                       string & ifpart, string & elsepart)
        {
                LASSERT(format[0] == '{' && format[1] == '%', return format);
                // strip '{%'
@@ -379,13 +369,13 @@ namespace {
 
                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
@@ -399,42 +389,58 @@ namespace {
 } // anon namespace
 
 
-docstring BibTeXInfo::expandFormat(string const & format, 
-               BibTeXInfo const * const xref, bool richtext) const
+docstring BibTeXInfo::expandFormat(string const & format,
+               BibTeXInfo const * const xref, int & counter, Buffer const & buf,
+               bool richtext) const
 {
+       // incorrect use of macros could put us in an infinite loop
+       static int max_passes = 5000;
        docstring ret; // return value
        string key;
        bool scanning_key = false;
        bool scanning_rich = false;
 
        string fmt = format;
-       // we'll remove characters from the front of fmt as we 
+       // we'll remove characters from the front of fmt as we
        // deal with them
        while (fmt.size()) {
+               if (counter++ > max_passes) {
+                       LYXERR0("Recursion limit reached while parsing `"
+                               << format << "'.");
+                       return _("ERROR!");
+               }
+
                char_type thischar = fmt[0];
-               if (thischar == '%') { 
+               if (thischar == '%') {
                        // beginning or end of key
-                       if (scanning_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 {
+                               if (key[0] == '!') {
+                                       // macro
+                                       string const val =
+                                               buf.params().documentClass().getCiteMacro(key);
+                                       fmt = val + fmt.substr(1);
+                                       continue;
+                               } else if (key[0] == '_') {
+                                       // a translatable bit
+                                       string const val =
+                                               buf.params().documentClass().getCiteMacro(key);
+                                       docstring const trans =
+                                               translateIfPossible(from_utf8(val), buf.params().language->code());
+                                       ret += trans;
+                               } else {
                                        docstring const val = getValueForKey(key, xref);
                                        ret += val;
                                }
-                               key.clear();
                        } else {
                                // beginning of key
+                               key.clear();
                                scanning_key = true;
                        }
-               } 
-               else if (thischar == '{') { 
+               }
+               else if (thischar == '{') {
                        // beginning of option?
                        if (scanning_key) {
                                LYXERR0("ERROR: Found `{' when scanning key in `" << format << "'.");
@@ -446,18 +452,18 @@ docstring BibTeXInfo::expandFormat(string const & format,
                                        string optkey;
                                        string ifpart;
                                        string elsepart;
-                                       string const newfmt = 
+                                       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);
+                                               ret += expandFormat(ifpart, xref, counter, buf, richtext);
                                        else if (!elsepart.empty())
-                                               ret += expandFormat(elsepart, xref, richtext);
+                                               ret += expandFormat(elsepart, xref, counter, buf, richtext);
                                        // fmt will have been shortened for us already
-                                       continue; 
+                                       continue;
                                }
                                if (fmt[1] == '!') {
                                        // beginning of rich text
@@ -466,10 +472,11 @@ docstring BibTeXInfo::expandFormat(string const & format,
                                        continue;
                                }
                        }
-                       // we are here if the '{' was at the end of the format. hmm.
+                       // we are here if '{' was not followed by % or !.
+                       // So it's just a character.
                        ret += thischar;
                }
-               else if (scanning_rich && thischar == '!' 
+               else if (scanning_rich && thischar == '!'
                         && fmt.size() > 1 && fmt[1] == '}') {
                        // end of rich text
                        scanning_rich = false;
@@ -478,7 +485,19 @@ docstring BibTeXInfo::expandFormat(string const & format,
                }
                else if (scanning_key)
                        key += char(thischar);
-               else if (richtext || !scanning_rich)
+               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 */)
                        ret += thischar;
                // else the character is discarded, which will happen only if
                // richtext == false and we are scanning rich text
@@ -496,25 +515,8 @@ docstring BibTeXInfo::expandFormat(string const & format,
 }
 
 
-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
+       Buffer const & buf, bool richtext) const
 {
        if (!info_.empty())
                return info_;
@@ -525,16 +527,10 @@ docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref,
                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);
+       DocumentClass const & dc = buf.params().documentClass();
+       string const & format = dc.getCiteFormat(to_utf8(entry_type_));
+       int counter = 0;
+       info_ = expandFormat(format, xref, counter, buf, richtext);
 
        if (!info_.empty())
                info_ = convertLaTeXCommands(info_);
@@ -550,15 +546,15 @@ docstring const & BibTeXInfo::operator[](docstring const & field) const
        static docstring const empty_value = docstring();
        return empty_value;
 }
-       
-       
+
+
 docstring const & BibTeXInfo::operator[](string const & field) const
 {
        return operator[](from_ascii(field));
 }
 
 
-docstring BibTeXInfo::getValueForKey(string const & key, 
+docstring BibTeXInfo::getValueForKey(string const & key,
                BibTeXInfo const * const xref) const
 {
        docstring const ret = operator[](key);
@@ -665,11 +661,12 @@ docstring const BiblioInfo::getYear(docstring const & key, bool use_modifier) co
 }
 
 
-docstring const BiblioInfo::getInfo(docstring const & key, bool richtext) const
+docstring const BiblioInfo::getInfo(docstring const & key,
+       Buffer const & buf, bool richtext) const
 {
        BiblioInfo::const_iterator it = find(key);
        if (it == end())
-               return docstring();
+               return docstring(_("BibTeX entry not found!"));
        BibTeXInfo const & data = it->second;
        BibTeXInfo const * xrefptr = 0;
        docstring const xref = data.getXRef();
@@ -678,7 +675,7 @@ docstring const BiblioInfo::getInfo(docstring const & key, bool richtext) const
                if (xrefit != end())
                        xrefptr = &(xrefit->second);
        }
-       return data.getInfo(xrefptr, richtext);
+       return data.getInfo(xrefptr, buf, richtext);
 }
 
 
@@ -715,7 +712,7 @@ vector<docstring> const BiblioInfo::getNumericalStrings(
                return vector<docstring>();
 
        vector<CiteStyle> const & styles = citeStyles(buf.params().citeEngine());
-       
+
        vector<docstring> vec(styles.size());
        for (size_t i = 0; i != vec.size(); ++i) {
                docstring str;
@@ -774,7 +771,7 @@ vector<docstring> const BiblioInfo::getAuthorYearStrings(
                return vector<docstring>();
 
        vector<CiteStyle> const & styles = citeStyles(buf.params().citeEngine());
-       
+
        vector<docstring> vec(styles.size());
        for (size_t i = 0; i != vec.size(); ++i) {
                docstring str;
@@ -827,6 +824,8 @@ vector<docstring> const BiblioInfo::getAuthorYearStrings(
 void BiblioInfo::mergeBiblioInfo(BiblioInfo const & info)
 {
        bimap_.insert(info.begin(), info.end());
+       field_names_.insert(info.field_names_.begin(), info.field_names_.end());
+       entry_types_.insert(info.entry_types_.begin(), info.entry_types_.end());
 }
 
 
@@ -866,9 +865,9 @@ void BiblioInfo::collectCitedEntries(Buffer const & buf)
        }
        if (citekeys.empty())
                return;
-       
+
        // We have a set of the keys used in this document.
-       // We will now convert it to a list of the BibTeXInfo objects used in 
+       // We will now convert it to a list of the BibTeXInfo objects used in
        // this document...
        vector<BibTeXInfo const *> bi;
        set<docstring>::const_iterator cit = citekeys.begin();
@@ -881,7 +880,7 @@ void BiblioInfo::collectCitedEntries(Buffer const & buf)
        }
        // ...and sort it.
        sort(bi.begin(), bi.end(), lSorter);
-       
+
        // Now we can write the sorted keys
        vector<BibTeXInfo const *>::const_iterator bit = bi.begin();
        vector<BibTeXInfo const *>::const_iterator ben = bi.end();
@@ -894,7 +893,7 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf)
 {
        collectCitedEntries(buf);
        CiteEngine const engine = buf.params().citeEngine();
-       bool const numbers = 
+       bool const numbers =
                (engine == ENGINE_BASIC || engine == ENGINE_NATBIB_NUMERICAL);
 
        int keynumber = 0;
@@ -933,7 +932,7 @@ void BiblioInfo::makeCitationLabels(Buffer const & buf)
                        } else {
                                modifier = 0;
                        }
-                       entry.setModifier(modifier);                            
+                       entry.setModifier(modifier);
                        // remember the last one
                        last = biit;
                }
@@ -1028,30 +1027,35 @@ string citationStyleToString(const CitationStyle & s)
 
 vector<CiteStyle> citeStyles(CiteEngine engine)
 {
-       unsigned int nStyles = 0;
-       unsigned int start = 0;
+       vector<CiteStyle> styles(0);
 
        switch (engine) {
                case ENGINE_BASIC:
-                       nStyles = 2;
-                       start = 0;
+                       styles.push_back(CITE);
                        break;
+               case ENGINE_JURABIB:
+                       styles.push_back(CITE);
                case ENGINE_NATBIB_AUTHORYEAR:
-               case ENGINE_NATBIB_NUMERICAL:
-                       nStyles = nCiteStyles - 1;
-                       start = 1;
+                       styles.push_back(CITET);
+                       styles.push_back(CITEP);
+                       styles.push_back(CITEALT);
+                       styles.push_back(CITEALP);
+                       styles.push_back(CITEAUTHOR);
+                       styles.push_back(CITEYEAR);
+                       styles.push_back(CITEYEARPAR);
                        break;
-               case ENGINE_JURABIB:
-                       nStyles = nCiteStyles;
-                       start = 0;
+               case ENGINE_NATBIB_NUMERICAL:
+                       styles.push_back(CITET);
+                       styles.push_back(CITEALT);
+                       styles.push_back(CITEAUTHOR);
+                       styles.push_back(CITEP);
+                       styles.push_back(CITEALP);
+                       styles.push_back(CITEYEAR);
+                       styles.push_back(CITEYEARPAR);
                        break;
        }
 
-       vector<CiteStyle> styles(nStyles);
-       size_t i = 0;
-       int j = start;
-       for (; i != styles.size(); ++i, ++j)
-               styles[i] = citeStylesArray[j];
+       styles.push_back(NOCITE);
 
        return styles;
 }