]> git.lyx.org Git - lyx.git/blobdiff - src/BiblioInfo.cpp
Add FIXME
[lyx.git] / src / BiblioInfo.cpp
index a6113cf509b1a5fec1ef594ef9e802a503c1a43c..896d8fc4a8a1d895f1805c2641a47fdf3cb9fb1c 100644 (file)
@@ -16,7 +16,6 @@
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "buffer_funcs.h"
-#include "gettext.h"
 #include "InsetIterator.h"
 #include "Paragraph.h"
 
 #include "insets/InsetBibtex.h"
 #include "insets/InsetInclude.h"
 
-#include "support/lstrings.h"
+#include "support/lassert.h"
 #include "support/docstream.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
 
 #include "boost/regex.hpp"
 
-using std::string;
-using std::vector;
-using std::pair;
-using std::endl;
-using std::set;
+using namespace std;
+using namespace lyx::support;
+
 
 namespace lyx {
-using support::bformat;
-using support::compare_no_case;
-using support::getVectorFromString;
-using support::ltrim;
-using support::rtrim;
 
-////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////
 //
 // BibTeXInfo
 //
-////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////
 
-BibTeXInfo::BibTeXInfo() : isBibTeX(true)
+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;
@@ -75,38 +70,35 @@ docstring const & BibTeXInfo::getValueForField(string const & field) const
 }
 
 
-namespace {
-       docstring const familyName(docstring const & name)
-       {
-               if (name.empty())
-                       return docstring();
-
-               // Very simple parser
-               docstring fname = name;
-
-               // possible authorname combinations are:
-               // "Surname, FirstName"
-               // "Surname, F."
-               // "FirstName Surname"
-               // "F. Surname"
-               docstring::size_type idx = fname.find(',');
-               if (idx != docstring::npos)
-                       return ltrim(fname.substr(0, idx));
-               idx = fname.rfind('.');
-               if (idx != docstring::npos && idx + 1 < fname.size())
-                       fname = ltrim(fname.substr(idx + 1));
-               // test if we have a LaTeX Space in front
-               if (fname[0] == '\\')
-                       return fname.substr(2);
-               return rtrim(fname);
-       }
-} // namespace anon
+docstring familyName(docstring const & name)
+{
+       if (name.empty())
+               return docstring();
 
+       // Very simple parser
+       docstring fname = name;
+
+       // possible authorname combinations are:
+       // "Surname, FirstName"
+       // "Surname, F."
+       // "FirstName Surname"
+       // "F. Surname"
+       docstring::size_type idx = fname.find(',');
+       if (idx != docstring::npos)
+               return ltrim(fname.substr(0, idx));
+       idx = fname.rfind('.');
+       if (idx != docstring::npos && idx + 1 < fname.size())
+               fname = ltrim(fname.substr(idx + 1));
+       // test if we have a LaTeX Space in front
+       if (fname[0] == '\\')
+               return fname.substr(2);
+       return rtrim(fname);
+}
 
 
 docstring const BibTeXInfo::getAbbreviatedAuthor() const
 {
-       if (!isBibTeX
+       if (!is_bibtex_
                return docstring();
  
        docstring author = getValueForField("author");
@@ -114,26 +106,28 @@ docstring const BibTeXInfo::getAbbreviatedAuthor() const
        if (author.empty()) {
                author = getValueForField("editor");
                if (author.empty())
-                       return bibKey;
+                       return bib_key_;
        }
 
-       //OK, we've got some names. Let's format them.
-       //Try to split the author list on " and "
+       // OK, we've got some names. Let's format them.
+       // Try to split the author list on " and "
        vector<docstring> const authors =
                getVectorFromString(author, from_ascii(" and "));
        
        if (authors.size() == 2)
                return bformat(_("%1$s and %2$s"),
                        familyName(authors[0]), familyName(authors[1]));
-       else if (authors.size() > 2)
+
+       if (authors.size() > 2)
                return bformat(_("%1$s et al."), familyName(authors[0]));
-       else  
-               return familyName(authors[0]);
+
+       return familyName(authors[0]);
 }
 
+
 docstring const BibTeXInfo::getYear() const
 {
-       if (!isBibTeX
+       if (!is_bibtex_
                return docstring();
  
        docstring year = getValueForField("year");
@@ -145,16 +139,16 @@ docstring const BibTeXInfo::getYear() const
 
 docstring const BibTeXInfo::getInfo() const
 {
-       if (!isBibTeX) {
+       if (!is_bibtex_) {
                BibTeXInfo::const_iterator it = find(from_ascii("ref"));
                return it->second;
        }
  
-       //FIXME
-       //This could be made alot better using the entryType
-       //field to customize the output based upon entry type.
+       // FIXME
+       // This could be made a lot better using the entryType
+       // field to customize the output based upon entry type.
        
-       //Search for all possible "required" fields
+       // Search for all possible "required" fields
        docstring author = getValueForField("author");
        if (author.empty())
                author = getValueForField("editor");
@@ -166,49 +160,51 @@ docstring const BibTeXInfo::getInfo() const
                docLoc = getValueForField("chapter");
                if (!docLoc.empty())
                        docLoc = from_ascii("Ch. ") + docLoc;
-       }       else 
+       }       else {
                docLoc = from_ascii("pp. ") + docLoc;
-               docstring media = getValueForField("journal");
+       }
+
+       docstring media = getValueForField("journal");
+       if (media.empty()) {
+               media = getValueForField("publisher");
                if (media.empty()) {
-                       media = getValueForField("publisher");
-                       if (media.empty()) {
-                               media = getValueForField("school");
-                               if (media.empty())
-                                       media = getValueForField("institution");
-                       }
+                       media = getValueForField("school");
+                       if (media.empty())
+                               media = getValueForField("institution");
                }
-               docstring volume = getValueForField("volume");
-               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())
-                       return result_str;
-       // This should never happen (or at least be very unusual!)
-               return docstring();
+       }
+       docstring volume = getValueForField("volume");
+
+       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())
+               return result_str;
+
+       // This should never happen (or at least be very unusual!)
+       return docstring();
 }
 
 
-////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////
 //
 // BiblioInfo
 //
-////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////
 
 namespace {
-// A functor for use with std::sort, leading to case insensitive sorting
-       class compareNoCase: public std::binary_function<docstring, docstring, bool>
+// A functor for use with sort, leading to case insensitive sorting
+       class compareNoCase: public binary_function<docstring, docstring, bool>
        {
                public:
                        bool operator()(docstring const & s1, docstring const & s2) const {
@@ -224,7 +220,7 @@ vector<docstring> const BiblioInfo::getKeys() const
        BiblioInfo::const_iterator it  = begin();
        for (; it != end(); ++it)
                bibkeys.push_back(it->first);
-       std::sort(bibkeys.begin(), bibkeys.end(), compareNoCase());
+       sort(bibkeys.begin(), bibkeys.end(), compareNoCase());
        return bibkeys;
 }
 
@@ -232,11 +228,11 @@ vector<docstring> const BiblioInfo::getKeys() const
 vector<docstring> const BiblioInfo::getFields() const
 {
        vector<docstring> bibfields;
-       set<docstring>::const_iterator it = fieldNames.begin();
-       set<docstring>::const_iterator end = fieldNames.end();
+       set<docstring>::const_iterator it = field_names_.begin();
+       set<docstring>::const_iterator end = field_names_.end();
        for (; it != end; ++it)
                bibfields.push_back(*it);
-       std::sort(bibfields.begin(), bibfields.end());
+       sort(bibfields.begin(), bibfields.end());
        return bibfields;
 }
 
@@ -244,11 +240,11 @@ vector<docstring> const BiblioInfo::getFields() const
 vector<docstring> const BiblioInfo::getEntries() const
 {
        vector<docstring> bibentries;
-       set<docstring>::const_iterator it = entryTypes.begin();
-       set<docstring>::const_iterator end = entryTypes.end();
+       set<docstring>::const_iterator it = entry_types_.begin();
+       set<docstring>::const_iterator end = entry_types_.end();
        for (; it != end; ++it)
                bibentries.push_back(*it);
-       std::sort(bibentries.begin(), bibentries.end());
+       sort(bibentries.begin(), bibentries.end());
        return bibentries;
 }
 
@@ -286,8 +282,8 @@ docstring const BiblioInfo::getInfo(docstring const & key) const
 vector<docstring> const BiblioInfo::getCiteStrings(
        docstring const & key, Buffer const & buf) const
 {
-       biblio::CiteEngine const engine = buf.params().getEngine();
-       if (engine == biblio::ENGINE_NATBIB_NUMERICAL)
+       CiteEngine const engine = buf.params().citeEngine();
+       if (engine == ENGINE_BASIC || engine == ENGINE_NATBIB_NUMERICAL)
                return getNumericalStrings(key, buf);
        else
                return getAuthorYearStrings(key, buf);
@@ -305,40 +301,43 @@ vector<docstring> const BiblioInfo::getNumericalStrings(
        if (author.empty() || year.empty())
                return vector<docstring>();
 
-       vector<biblio::CiteStyle> const & styles = 
-               biblio::getCiteStyles(buf.params().getEngine());
+       vector<CiteStyle> const & styles = citeStyles(buf.params().citeEngine());
        
        vector<docstring> vec(styles.size());
-       for (vector<docstring>::size_type i = 0; i != vec.size(); ++i) {
+       for (size_t i = 0; i != vec.size(); ++i) {
                docstring str;
 
                switch (styles[i]) {
-                       case biblio::CITE:
-                       case biblio::CITEP:
+                       case CITE:
+                       case CITEP:
                                str = from_ascii("[#ID]");
                                break;
 
-                       case biblio::CITET:
+                       case NOCITE:
+                               str = _("Add to bibliography only.");
+                               break;
+
+                       case CITET:
                                str = author + " [#ID]";
                                break;
 
-                       case biblio::CITEALT:
+                       case CITEALT:
                                str = author + " #ID";
                                break;
 
-                       case biblio::CITEALP:
+                       case CITEALP:
                                str = from_ascii("#ID");
                                break;
 
-                       case biblio::CITEAUTHOR:
+                       case CITEAUTHOR:
                                str = author;
                                break;
 
-                       case biblio::CITEYEAR:
+                       case CITEYEAR:
                                str = year;
                                break;
 
-                       case biblio::CITEYEARPAR:
+                       case CITEYEARPAR:
                                str = '(' + year + ')';
                                break;
                }
@@ -361,45 +360,48 @@ vector<docstring> const BiblioInfo::getAuthorYearStrings(
        if (author.empty() || year.empty())
                return vector<docstring>();
 
-       vector<biblio::CiteStyle> const & styles = 
-               getCiteStyles(buf.params().getEngine());
+       vector<CiteStyle> const & styles = citeStyles(buf.params().citeEngine());
        
        vector<docstring> vec(styles.size());
-       for (vector<docstring>::size_type i = 0; i != vec.size(); ++i) {
+       for (size_t i = 0; i != vec.size(); ++i) {
                docstring str;
 
                switch (styles[i]) {
-                       case biblio::CITE:
+                       case CITE:
                // jurabib only: Author/Annotator
                // (i.e. the "before" field, 2nd opt arg)
                                str = author + "/<" + _("before") + '>';
                                break;
 
-                       case biblio::CITET:
+                       case NOCITE:
+                               str = _("Add to bibliography only.");
+                               break;
+
+                       case CITET:
                                str = author + " (" + year + ')';
                                break;
 
-                       case biblio::CITEP:
+                       case CITEP:
                                str = '(' + author + ", " + year + ')';
                                break;
 
-                       case biblio::CITEALT:
+                       case CITEALT:
                                str = author + ' ' + year ;
                                break;
 
-                       case biblio::CITEALP:
+                       case CITEALP:
                                str = author + ", " + year ;
                                break;
 
-                       case biblio::CITEAUTHOR:
+                       case CITEAUTHOR:
                                str = author;
                                break;
 
-                       case biblio::CITEYEAR:
+                       case CITEYEAR:
                                str = year;
                                break;
 
-                       case biblio::CITEYEARPAR:
+                       case CITEYEARPAR:
                                str = '(' + year + ')';
                                break;
                }
@@ -409,49 +411,34 @@ vector<docstring> const BiblioInfo::getAuthorYearStrings(
 }
 
 
-void BiblioInfo::fillWithBibKeys(Buffer const * const buf)
-{      
-       /// if this is a child document and the parent is already loaded
-       /// use the parent's list instead  [ale990412]
-       Buffer const * const tmp = buf->masterBuffer();
-       BOOST_ASSERT(tmp);
-       if (tmp != buf) {
-               this->fillWithBibKeys(tmp);
-               return;
-       }
-
-       // Pre-load all child documents.
-       buf->loadChildDocuments();
-
-       for (InsetIterator it = inset_iterator_begin(buf->inset()); it; ++it)
-               it->fillWithBibKeys(*buf, *this, it);
+void BiblioInfo::mergeBiblioInfo(BiblioInfo const & info)
+{
+       bimap_.insert(info.begin(), info.end());
 }
 
 
-namespace biblio {
-
-////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////
 //
 // CitationStyle
 //
-////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////
 
 namespace {
 
 
 char const * const citeCommands[] = {
-       "cite", "citet", "citep", "citealt", "citealp", "citeauthor",
-       "citeyear", "citeyearpar" };
+       "cite", "nocite", "citet", "citep", "citealt", "citealp",
+       "citeauthor", "citeyear", "citeyearpar" };
 
 unsigned int const nCiteCommands =
                sizeof(citeCommands) / sizeof(char *);
 
-CiteStyle const citeStyles[] = {
-       CITE, CITET, CITEP, CITEALT, CITEALP,
-CITEAUTHOR, CITEYEAR, CITEYEARPAR };
+CiteStyle const citeStylesArray[] = {
+       CITE, NOCITE, CITET, CITEP, CITEALT,
+       CITEALP, CITEAUTHOR, CITEYEAR, CITEYEARPAR };
 
 unsigned int const nCiteStyles =
-               sizeof(citeStyles) / sizeof(CiteStyle);
+               sizeof(citeStylesArray) / sizeof(CiteStyle);
 
 CiteStyle const citeStylesFull[] = {
        CITET, CITEP, CITEALT, CITEALP, CITEAUTHOR };
@@ -468,61 +455,61 @@ unsigned int const nCiteStylesUCase =
 } // namespace anon
 
 
-CitationStyle::CitationStyle(string const & command)
-       : style(CITE), full(false), forceUCase(false)
+CitationStyle citationStyleFromString(string const & command)
 {
+       CitationStyle s;
        if (command.empty())
-               return;
+               return s;
 
        string cmd = command;
        if (cmd[0] == 'C') {
-               forceUCase = true;
+               s.forceUpperCase = true;
                cmd[0] = 'c';
        }
 
-       string::size_type const n = cmd.size() - 1;
+       size_t const n = cmd.size() - 1;
        if (cmd != "cite" && cmd[n] == '*') {
-               full = true;
+               s.full = true;
                cmd = cmd.substr(0,n);
        }
 
        char const * const * const last = citeCommands + nCiteCommands;
-       char const * const * const ptr = std::find(citeCommands, last, cmd);
+       char const * const * const ptr = find(citeCommands, last, cmd);
 
        if (ptr != last) {
                size_t idx = ptr - citeCommands;
-               style = citeStyles[idx];
+               s.style = citeStylesArray[idx];
        }
+       return s;
 }
 
 
-string const CitationStyle::asLatexStr() const
+string citationStyleToString(const CitationStyle & s)
 {
-       string cite = citeCommands[style];
-       if (full) {
+       string cite = citeCommands[s.style];
+       if (s.full) {
                CiteStyle const * last = citeStylesFull + nCiteStylesFull;
-               if (std::find(citeStylesFull, last, style) != last)
+               if (find(citeStylesFull, last, s.style) != last)
                        cite += '*';
        }
 
-       if (forceUCase) {
+       if (s.forceUpperCase) {
                CiteStyle const * last = citeStylesUCase + nCiteStylesUCase;
-               if (std::find(citeStylesUCase, last, style) != last)
+               if (find(citeStylesUCase, last, s.style) != last)
                        cite[0] = 'C';
        }
 
        return cite;
 }
 
-
-vector<CiteStyle> const getCiteStyles(CiteEngine const engine)
+vector<CiteStyle> citeStyles(CiteEngine engine)
 {
        unsigned int nStyles = 0;
        unsigned int start = 0;
 
        switch (engine) {
                case ENGINE_BASIC:
-                       nStyles = 1;
+                       nStyles = 2;
                        start = 0;
                        break;
                case ENGINE_NATBIB_AUTHORYEAR:
@@ -536,17 +523,14 @@ vector<CiteStyle> const getCiteStyles(CiteEngine const engine)
                        break;
        }
 
-       typedef vector<CiteStyle> cite_vec;
-
-       cite_vec styles(nStyles);
-       cite_vec::size_type i = 0;
+       vector<CiteStyle> styles(nStyles);
+       size_t i = 0;
        int j = start;
        for (; i != styles.size(); ++i, ++j)
-               styles[i] = citeStyles[j];
+               styles[i] = citeStylesArray[j];
 
        return styles;
 }
 
-} // namespace biblio
 } // namespace lyx