]> git.lyx.org Git - lyx.git/blobdiff - src/BiblioInfo.cpp
get rid of the \use_escape_chars pref, which was not used
[lyx.git] / src / BiblioInfo.cpp
index 7251649f5a8bee6b07d1612ab6d8e108c50a8592..c5548af832caff6aa641cf2f6892589d04f40bb8 100644 (file)
@@ -16,6 +16,7 @@
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "buffer_funcs.h"
+#include "Encoding.h"
 #include "InsetIterator.h"
 #include "Paragraph.h"
 
@@ -38,39 +39,9 @@ using namespace lyx::support;
 
 namespace lyx {
 
-//////////////////////////////////////////////////////////////////////
-//
-// BibTeXInfo
-//
-//////////////////////////////////////////////////////////////////////
-
-BibTeXInfo::BibTeXInfo(docstring const & key, docstring const & type)
-       : is_bibtex_(true), bib_key_(key), entry_type_(type)
-{}
-
-
-bool BibTeXInfo::hasField(docstring const & field) const
-{
-       return count(field) == 1;
-}
-
-
-docstring const & BibTeXInfo::operator[](docstring const & field) const
-{
-       BibTeXInfo::const_iterator it = find(field);
-       if (it != end())
-               return it->second;
-       static docstring const empty_value = docstring();
-       return empty_value;
-}
-       
-       
-docstring const & BibTeXInfo::operator[](string const & field) const
-{
-       return operator[](from_ascii(field));
-}
-
+namespace {
 
+// gets the "family name" from an author-type string
 docstring familyName(docstring const & name)
 {
        if (name.empty())
@@ -117,10 +88,128 @@ docstring familyName(docstring const & name)
        return retval;
 }
 
+// converts a string containing LaTeX commands into unicode
+// for display.
+docstring convertLaTeXCommands(docstring const & str)
+{
+       docstring val = str;
+       docstring ret;
+
+       bool scanning_cmd = false;
+       bool scanning_math = false;
+       bool escaped = false; // used to catch \$, etc.
+       while (val.size()) {
+               char_type const ch = val[0];
+
+               // if we're scanning math, we output everything until we
+               // find an unescaped $, at which point we break out.
+               if (scanning_math) {
+                       if (escaped)
+                               escaped = false;
+                       else if (ch == '\\')
+                               escaped = true;
+                       else if (ch == '$') 
+                               scanning_math = false;
+                       ret += ch;
+                       val = val.substr(1);
+                       continue;
+               }
+
+               // if we're scanning a command name, then we just
+               // discard characters until we hit something that
+               // isn't alpha.
+               if (scanning_cmd) {
+                       if (isAlphaASCII(ch)) {
+                               val = val.substr(1);
+                               escaped = false;
+                               continue;
+                       }
+                       // so we're done with this command.
+                       // now we fall through and check this character.
+                       scanning_cmd = false;
+               }
+
+               // was the last character a \? If so, then this is something like: \\,
+               // or \$, so we'll just output it. That's probably not always right...
+               if (escaped) {
+                       ret += ch;
+                       val = val.substr(1);
+                       escaped = false;
+                       continue;
+               }
+
+               if (ch == '$') {
+                       ret += ch;
+                       val = val.substr(1);
+                       scanning_math = true;
+                       continue;
+               }
+
+               // we just ignore braces
+               if (ch == '{' || ch == '}') {
+                       val = val.substr(1);
+                       continue;
+               }
+
+               // we're going to check things that look like commands, so if
+               // this doesn't, just output it.
+               if (ch != '\\') {
+                       ret += ch;
+                       val = val.substr(1);
+                       continue;
+               }
+
+               // ok, could be a command of some sort
+               // let's see if it corresponds to some unicode
+               // 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)) {
+                       val.insert(3, from_ascii("}"));
+                       val.insert(2, from_ascii("{"));
+               }
+               docstring rem;
+               docstring const cnvtd = Encodings::fromLaTeXCommand(val, rem,
+                                                       Encodings::TEXT_CMD);
+               if (!cnvtd.empty()) {
+                       // it did, so we'll take that bit and proceed with what's left
+                       ret += cnvtd;
+                       val = rem;
+                       continue;
+               }
+               // it's a command of some sort
+               scanning_cmd = true;
+               escaped = true;
+               val = val.substr(1);
+       }
+       return ret;
+}
+
+} // anon namespace
+
+
+//////////////////////////////////////////////////////////////////////
+//
+// BibTeXInfo
+//
+//////////////////////////////////////////////////////////////////////
+
+BibTeXInfo::BibTeXInfo(docstring const & key, docstring const & type)
+       : is_bibtex_(true), bib_key_(key), entry_type_(type), info_()
+{}
+
+
+bool BibTeXInfo::hasField(docstring const & field) const
+{
+       return count(field) == 1;
+}
+
+
 docstring const BibTeXInfo::getAbbreviatedAuthor() const
 {
        if (!is_bibtex_) {
-               docstring const opt = trim(operator[]("label"));
+               docstring const opt = label();
                if (opt.empty())
                        return docstring();
 
@@ -129,9 +218,9 @@ docstring const BibTeXInfo::getAbbreviatedAuthor() const
                return authors;
        }
 
-       docstring author = operator[]("author");
+       docstring author = convertLaTeXCommands(operator[]("author"));
        if (author.empty()) {
-               author = operator[]("editor");
+               author = convertLaTeXCommands(operator[]("editor"));
                if (author.empty())
                        return bib_key_;
        }
@@ -154,26 +243,30 @@ docstring const BibTeXInfo::getAbbreviatedAuthor() const
 
 docstring const BibTeXInfo::getYear() const
 {
-       if (!is_bibtex_) {
-               docstring const opt = trim(operator[]("label"));
-               if (opt.empty())
-                       return docstring();
+       if (is_bibtex_) 
+               return operator[]("year");
 
-               docstring authors;
-               docstring const tmp = split(opt, authors, '(');
-               docstring year;
-               split(tmp, year, ')');
-               return year;
-       }
+       docstring const opt = label();
+       if (opt.empty())
+               return docstring();
 
-       docstring year = operator[]("year");
-       if (year.empty())
-               year = _("No year");
+       docstring authors;
+       docstring const tmp = split(opt, authors, '(');
+       docstring year;
+       split(tmp, year, ')');
        return year;
 }
 
 
-docstring const BibTeXInfo::getInfo() const
+docstring const BibTeXInfo::getXRef() const
+{
+       if (!is_bibtex_)
+               return docstring();
+       return operator[]("crossref");
+}
+
+
+docstring const & BibTeXInfo::getInfo(BibTeXInfo const * const xref) const
 {
        if (!info_.empty())
                return info_;
@@ -185,35 +278,35 @@ docstring const BibTeXInfo::getInfo() const
        }
  
        // FIXME
-       // This could be made a lot better using the entryType
+       // 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 = operator[]("author");
+       docstring author = getValueForKey("author", xref);
        if (author.empty())
-               author = operator[]("editor");
+               author = getValueForKey("editor", xref);
  
-       docstring year   = operator[]("year");
-       docstring title  = operator[]("title");
-       docstring docLoc = operator[]("pages");
+       docstring year   = getValueForKey("year", xref);
+       docstring title  = getValueForKey("title", xref);
+       docstring docLoc = getValueForKey("pages", xref);
        if (docLoc.empty()) {
-               docLoc = operator[]("chapter");
+               docLoc = getValueForKey("chapter", xref);
                if (!docLoc.empty())
-                       docLoc = from_ascii("Ch. ") + docLoc;
+                       docLoc = _("Ch. ") + docLoc;
        }       else {
-               docLoc = from_ascii("pp. ") + docLoc;
+               docLoc = _("pp. ") + docLoc;
        }
 
-       docstring media = operator[]("journal");
+       docstring media = getValueForKey("journal", xref);
        if (media.empty()) {
-               media = operator[]("publisher");
+               media = getValueForKey("publisher", xref);
                if (media.empty()) {
-                       media = operator[]("school");
+                       media = getValueForKey("school", xref);
                        if (media.empty())
-                               media = operator[]("institution");
+                               media = getValueForKey("institution");
                }
        }
-       docstring volume = operator[]("volume");
+       docstring volume = getValueForKey("volume", xref);
 
        odocstringstream result;
        if (!author.empty())
@@ -223,18 +316,45 @@ docstring const BibTeXInfo::getInfo() const
        if (!media.empty())
                result << ", " << media;
        if (!year.empty())
-               result << ", " << year;
+               result << " (" << year << ")";
        if (!docLoc.empty())
                result << ", " << docLoc;
 
        docstring const result_str = rtrim(result.str());
        if (!result_str.empty()) {
-               info_ = result_str;
+               info_ = convertLaTeXCommands(result_str);
                return info_;
        }
 
        // This should never happen (or at least be very unusual!)
-       return docstring();
+       static docstring e = docstring();
+       return e;
+}
+
+
+docstring const & BibTeXInfo::operator[](docstring const & field) const
+{
+       BibTeXInfo::const_iterator it = find(field);
+       if (it != end())
+               return it->second;
+       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, 
+               BibTeXInfo const * const xref) const
+{
+       docstring const ret = operator[](key);
+       if (!ret.empty() || !xref)
+               return ret;
+       return (*xref)[key];
 }
 
 
@@ -307,6 +427,18 @@ docstring const BiblioInfo::getYear(docstring const & key) const
        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();
 }
 
@@ -317,7 +449,14 @@ docstring const BiblioInfo::getInfo(docstring const & key) const
        if (it == end())
                return docstring();
        BibTeXInfo const & data = it->second;
-       return data.getInfo();
+       BibTeXInfo const * xrefptr = 0;
+       docstring const xref = data.getXRef();
+       if (!xref.empty()) {
+               BiblioInfo::const_iterator const xrefit = find(xref);
+               if (xrefit != end())
+                       xrefptr = &(xrefit->second);
+       }
+       return data.getInfo(xrefptr);
 }