]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetcite.C
The speed patch: redraw only rows that have changed
[lyx.git] / src / insets / insetcite.C
index 0699b955d6fd031b4dee76d03f5ab9c95e56a3d6..75e64fe66933138f07812e542e6922fb1aa420be 100644 (file)
@@ -36,13 +36,15 @@ using std::ostream;
 using std::vector;
 using std::map;
 
+namespace biblio = lyx::biblio;
+
 
 namespace {
 
 string const getNatbibLabel(Buffer const & buffer,
                            string const & citeType, string const & keyList,
                            string const & before, string const & after,
-                           bool numerical, bool jura)
+                           biblio::CiteEngine engine)
 {
        // Only start the process off after the buffer is loaded from file.
        if (!buffer.fully_loaded())
@@ -80,12 +82,11 @@ string const getNatbibLabel(Buffer const & buffer,
        // CITE:        author/<before field>
 
        // We don't currently use the full or forceUCase fields.
-       // bool const forceUCase = citeType[0] == 'C';
-       bool const full = citeType[citeType.size() - 1] == '*';
-
-       string const cite_type = full ?
-               ascii_lowercase(citeType.substr(0, citeType.size() - 1)) :
-               ascii_lowercase(citeType);
+       string cite_type = biblio::asValidLatexCommand(citeType, engine);
+       if (cite_type[0] == 'C')
+               cite_type = string(1, 'c') + cite_type.substr(1);
+       if (cite_type[cite_type.size() - 1] == '*')
+               cite_type = cite_type.substr(0, cite_type.size() - 1);
 
        string before_str;
        if (!before.empty()) {
@@ -138,7 +139,7 @@ string const getNatbibLabel(Buffer const & buffer,
 
                // authors1/<before>;  ... ;
                //  authors_last, <after>
-               if (cite_type == "cite" && jura) {
+               if (cite_type == "cite" && engine == biblio::ENGINE_JURABIB) {
                        if (it == keys.begin())
                                label += author + before_str + sep_str;
                        else
@@ -147,18 +148,27 @@ string const getNatbibLabel(Buffer const & buffer,
                // (authors1 (<before> year);  ... ;
                //  authors_last (<before> year, <after>)
                } else if (cite_type == "citet") {
-                       string const tmp = numerical ? '#' + *it : year;
-                       if (!jura)
-                               label += author + op_str + before_str + tmp +
-                               cp + sep_str;
-                       else
-                               label += before_str + author + op_str + tmp +
-                               cp + sep_str;
+                       switch (engine) {
+                       case biblio::ENGINE_NATBIB_AUTHORYEAR:
+                               label += author + op_str + before_str +
+                                       year + cp + sep_str;
+                               break;
+                       case biblio::ENGINE_NATBIB_NUMERICAL:
+                               label += author + op_str + before_str +
+                                       '#' + *it + cp + sep_str;
+                               break;
+                       case biblio::ENGINE_JURABIB:
+                               label += before_str + author + op_str +
+                                       year + cp + sep_str;
+                               break;
+                       case biblio::ENGINE_BASIC:
+                               break;
+                       }
 
                // author, year; author, year; ...
                } else if (cite_type == "citep" ||
                           cite_type == "citealp") {
-                       if (numerical) {
+                       if (engine == biblio::ENGINE_NATBIB_NUMERICAL) {
                                label += *it + sep_str;
                        } else {
                                label += author + ", " + year + sep_str;
@@ -167,11 +177,22 @@ string const getNatbibLabel(Buffer const & buffer,
                // (authors1 <before> year;
                //  authors_last <before> year, <after>)
                } else if (cite_type == "citealt") {
-                       string const tmp = numerical ? '#' + *it : year;
-                       if (!jura)
-                               label += author + ' ' + before_str + tmp + sep_str;
-                       else
-                               label += before_str + author + ' ' + tmp + sep_str;
+                       switch (engine) {
+                       case biblio::ENGINE_NATBIB_AUTHORYEAR:
+                               label += author + ' ' + before_str +
+                                       year + sep_str;
+                               break;
+                       case biblio::ENGINE_NATBIB_NUMERICAL:
+                               label += author + ' ' + before_str +
+                                       '#' + *it + sep_str;
+                               break;
+                       case biblio::ENGINE_JURABIB:
+                               label += before_str + author + ' ' +
+                                       year + sep_str;
+                               break;
+                       case biblio::ENGINE_BASIC:
+                               break;
+                       }
 
                // author; author; ...
                } else if (cite_type == "citeauthor") {
@@ -190,9 +211,10 @@ string const getNatbibLabel(Buffer const & buffer,
                        // insert "after" before last ')'
                        label.insert(label.size() - 1, after_str);
                } else {
-                       bool const add = !(numerical &&
-                                          (cite_type == "citeauthor" ||
-                                           cite_type == "citeyear"));
+                       bool const add =
+                               !(engine == biblio::ENGINE_NATBIB_NUMERICAL &&
+                                 (cite_type == "citeauthor" ||
+                                  cite_type == "citeyear"));
                        if (add)
                                label += after_str;
                }
@@ -247,23 +269,10 @@ string const InsetCitation::generateLabel(Buffer const & buffer) const
        string const after  = getOptions();
 
        string label;
-       if (buffer.params().use_natbib || buffer.params().use_jurabib) {
-               string cmd = getCmdName();
-               if (buffer.params().use_natbib && cmd == "cite") {
-                       // We may be "upgrading" from an older LyX version.
-                       // If, however, we use "cite" because the necessary
-                       // author/year info is not present in the biblio
-                       // database, then getNatbibLabel will exit gracefully
-                       // and we'll call getBasicLabel.
-                       if (buffer.params().use_numerical_citations)
-                               cmd = "citep";
-                       else
-                               cmd = "citet";
-               }
-               label = getNatbibLabel(buffer, cmd, getContents(),
-                                      before, after,
-                                      buffer.params().use_numerical_citations,
-                                      buffer.params().use_jurabib);
+       biblio::CiteEngine const engine = buffer.params().cite_engine;
+       if (engine != biblio::ENGINE_BASIC) {
+               label = getNatbibLabel(buffer, getCmdName(), getContents(),
+                                      before, after, engine);
        }
 
        // Fallback to fail-safe
@@ -275,29 +284,10 @@ string const InsetCitation::generateLabel(Buffer const & buffer) const
 }
 
 
-InsetCitation::Cache::Style InsetCitation::getStyle(Buffer const & buffer) const
-{
-       Cache::Style style = Cache::BASIC;
-
-       if (buffer.params().use_natbib) {
-               if (buffer.params().use_numerical_citations) {
-                       style = Cache::NATBIB_NUM;
-               } else {
-                       style = Cache::NATBIB_AY;
-               }
-       }
-
-       if (buffer.params().use_jurabib)
-               style = Cache::JURABIB;
-
-       return style;
-}
-
-
 string const InsetCitation::getScreenLabel(Buffer const & buffer) const
 {
-       Cache::Style const style = getStyle(buffer);
-       if (cache.params == params() && cache.style == style)
+       biblio::CiteEngine const engine = biblio::getEngine(buffer);
+       if (cache.params == params() && cache.engine == engine)
                return cache.screen_label;
 
        // The label has changed, so we have to re-create it.
@@ -314,7 +304,7 @@ string const InsetCitation::getScreenLabel(Buffer const & buffer) const
                label += "...";
        }
 
-       cache.style  = style;
+       cache.engine  = engine;
        cache.params = params();
        cache.generated_label = glabel;
        cache.screen_label = label;
@@ -323,9 +313,10 @@ string const InsetCitation::getScreenLabel(Buffer const & buffer) const
 }
 
 
-int InsetCitation::plaintext(Buffer const & buffer, ostream & os, int) const
+int InsetCitation::plaintext(Buffer const & buffer, ostream & os, OutputParams const &) const
 {
-       if (cache.params == params() && cache.style == getStyle(buffer))
+       if (cache.params == params() &&
+           cache.engine == biblio::getEngine(buffer))
                os << cache.generated_label;
        else
                os << generateLabel(buffer);
@@ -333,6 +324,42 @@ int InsetCitation::plaintext(Buffer const & buffer, ostream & os, int) const
 }
 
 
+namespace {
+
+string const cleanupWhitespace(string const & citelist)
+{
+       string::const_iterator it  = citelist.begin();
+       string::const_iterator end = citelist.end();
+       // Paranoia check: make sure that there is no whitespace in here
+       // -- at least not behind commas or at the beginning
+       string result;
+       char last = ',';
+       for (; it != end; ++it) {
+               if (*it != ' ')
+                       last = *it;
+               if (*it != ' ' || last != ',')
+                       result += *it;
+       }
+       return result;
+}
+
+// end anon namyspace
+}
+
+int InsetCitation::docbook(Buffer const &, ostream & os, OutputParams const &) const
+{
+       os << "<citation>" << cleanupWhitespace(getContents()) << "</citation>";
+       return 0;
+}
+
+
+int InsetCitation::textString(Buffer const & buf, ostream & os,
+                      OutputParams const & op) const
+{
+       return plaintext(buf, os, op);
+}
+
+
 // Have to overwrite the default InsetCommand method in order to check that
 // the \cite command is valid. Eg, the user has natbib enabled, inputs some
 // citations and then changes his mind, turning natbib support off. The output
@@ -340,43 +367,20 @@ int InsetCitation::plaintext(Buffer const & buffer, ostream & os, int) const
 int InsetCitation::latex(Buffer const & buffer, ostream & os,
                         OutputParams const &) const
 {
-       os << "\\";
-       if (buffer.params().use_natbib)
-               os << getCmdName();
-       else if (buffer.params().use_jurabib) {
-               // jurabib does not (yet) support "force upper case"
-               // and "full author name". Fallback.
-               string cmd = getCmdName();
-               if (cmd[0] == 'C')
-                       cmd[0] = 'c';
-               size_t n = cmd.size() - 1;
-               if (cmd[n] == '*')
-                       cmd = cmd.substr(0,n);
-               os << cmd;
-       } else
-               os << "cite";
+       biblio::CiteEngine const cite_engine = buffer.params().cite_engine;
+       string const cite_str =
+               biblio::asValidLatexCommand(getCmdName(), cite_engine);
+
+       os << "\\" << cite_str;
 
        string const before = getSecOptions();
        string const after  = getOptions();
-       if (!before.empty()
-               && (buffer.params().use_natbib || buffer.params().use_jurabib))
+       if (!before.empty() && cite_engine != biblio::ENGINE_BASIC)
                os << '[' << before << "][" << after << ']';
        else if (!after.empty())
                os << '[' << after << ']';
 
-       string::const_iterator it  = getContents().begin();
-       string::const_iterator end = getContents().end();
-       // Paranoia check: make sure that there is no whitespace in here
-       string content;
-       char last = ',';
-       for (; it != end; ++it) {
-               if (*it != ' ')
-                       last = *it;
-               if (*it != ' ' || last != ',')
-                       content += *it;
-       }
-
-       os << '{' << content << '}';
+       os << '{' << cleanupWhitespace(getContents()) << '}';
 
        return 0;
 }
@@ -384,8 +388,15 @@ int InsetCitation::latex(Buffer const & buffer, ostream & os,
 
 void InsetCitation::validate(LaTeXFeatures & features) const
 {
-       if (features.bufferParams().use_natbib)
+       switch (features.bufferParams().cite_engine) {
+       case biblio::ENGINE_BASIC:
+               break;
+       case biblio::ENGINE_NATBIB_AUTHORYEAR:
+       case biblio::ENGINE_NATBIB_NUMERICAL:
                features.require("natbib");
-       else if (features.bufferParams().use_jurabib)
+               break;
+       case biblio::ENGINE_JURABIB:
                features.require("jurabib");
+               break;
+       }
 }