]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCitation.cpp
move the validation code from InsetFlex to InsetCollapsable
[lyx.git] / src / insets / InsetCitation.cpp
index c4effad34ef604e4e7aae084655a06f75c5ccc1b..859ceba81f4e050b65cb2c9f4c3b78dd3888c0c4 100644 (file)
@@ -17,7 +17,6 @@
 #include "buffer_funcs.h"
 #include "BufferParams.h"
 #include "DispatchResult.h"
-#include "EmbeddedFiles.h"
 #include "FuncRequest.h"
 #include "LaTeXFeatures.h"
 #include "ParIterator.h"
@@ -25,6 +24,7 @@
 
 #include "support/debug.h"
 #include "support/docstream.h"
+#include "support/FileNameList.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
 
@@ -56,52 +56,54 @@ vector<string> const init_possible_cite_commands()
 }
 
 
-vector<string> const & possible_cite_commands()
+vector<string> const & possibleCiteCommands()
 {
        static vector<string> const possible = init_possible_cite_commands();
        return possible;
 }
 
 
-//FIXME See the header for the issue.
-string const default_cite_command(biblio::CiteEngine engine)
+// FIXME See the header for the issue.
+string defaultCiteCommand(CiteEngine engine)
 {
        string str;
        switch (engine) {
-               case biblio::ENGINE_BASIC:
+               case ENGINE_BASIC:
                        str = "cite";
                        break;
-               case biblio::ENGINE_NATBIB_AUTHORYEAR:
+               case ENGINE_NATBIB_AUTHORYEAR:
                        str = "citet";
                        break;
-               case biblio::ENGINE_NATBIB_NUMERICAL:
+               case ENGINE_NATBIB_NUMERICAL:
                        str = "citep";
                        break;
-               case biblio::ENGINE_JURABIB:
+               case ENGINE_JURABIB:
                        str = "cite";
                        break;
        }
        return str;
 }
 
-               
-string const 
-               asValidLatexCommand(string const & input, biblio::CiteEngine const engine)
+       
+string asValidLatexCommand(string const & input, CiteEngine const engine)
 {
-       string const default_str = default_cite_command(engine);
+       string const default_str = defaultCiteCommand(engine);
        if (!InsetCitation::isCompatibleCommand(input))
                return default_str;
 
        string output;
        switch (engine) {
-               case biblio::ENGINE_BASIC:
-                       output = input;
+               case ENGINE_BASIC:
+                       if (input == "nocite")
+                               output = input;
+                       else
+                               output = default_str;
                        break;
 
-               case biblio::ENGINE_NATBIB_AUTHORYEAR:
-               case biblio::ENGINE_NATBIB_NUMERICAL:
-                       if (input == "cite" || input == "citefield" ||
-                                                       input == "citetitle" || input == "cite*")
+               case ENGINE_NATBIB_AUTHORYEAR:
+               case ENGINE_NATBIB_NUMERICAL:
+                       if (input == "cite" || input == "citefield"
+                           || input == "citetitle" || input == "cite*")
                                output = default_str;
                        else if (prefixIs(input, "foot"))
                                output = input.substr(4);
@@ -109,7 +111,7 @@ string const
                                output = input;
                        break;
 
-               case biblio::ENGINE_JURABIB: {
+               case ENGINE_JURABIB: {
                        // Jurabib does not support the 'uppercase' natbib style.
                        if (input[0] == 'C')
                                output = string(1, 'c') + input.substr(1);
@@ -129,46 +131,16 @@ string const
 }
 
 
-docstring getComplexLabel(Buffer const & buffer,
+docstring complexLabel(Buffer const & buffer,
                            string const & citeType, docstring const & keyList,
                            docstring const & before, docstring const & after,
-                           biblio::CiteEngine engine)
+                           CiteEngine engine)
 {
        // Only start the process off after the buffer is loaded from file.
        if (!buffer.isFullyLoaded())
                return docstring();
 
-       // Cache the labels
-       typedef map<Buffer const *, BiblioInfo> CachedMap;
-       static CachedMap cached_keys;
-
-       // and cache the timestamp of the bibliography files.
-       static map<FileName, time_t> bibfileStatus;
-
-       BiblioInfo biblist;
-
-       EmbeddedFileList const & bibfilesCache = buffer.getBibfilesCache();
-       // compare the cached timestamps with the actual ones.
-       bool changed = false;
-       for (EmbeddedFileList::const_iterator it = bibfilesCache.begin();
-                       it != bibfilesCache.end(); ++ it) {
-               FileName const f = *it;
-               time_t lastw = f.lastModified();
-               if (lastw != bibfileStatus[f]) {
-                       changed = true;
-                       bibfileStatus[f] = lastw;
-               }
-       }
-
-       // build the list only if the bibfiles have been changed
-       if (cached_keys[&buffer].empty() || bibfileStatus.empty() || changed) {
-               biblist.fillWithBibKeys(&buffer);
-               cached_keys[&buffer] = biblist;
-       } else {
-               // use the cached keys
-               biblist = cached_keys[&buffer];
-       }
-
+       BiblioInfo const & biblist = buffer.masterBibInfo();
        if (biblist.empty())
                return docstring();
 
@@ -223,7 +195,7 @@ docstring getComplexLabel(Buffer const & buffer,
        // One day, these might be tunable (as they are in BibTeX).
        char op, cp;    // opening and closing parenthesis.
        char * sep;     // punctuation mark separating citation entries.
-       if (engine == biblio::ENGINE_BASIC) {
+       if (engine == ENGINE_BASIC) {
                op  = '[';
                cp  = ']';
                sep = ",";
@@ -253,9 +225,9 @@ docstring getComplexLabel(Buffer const & buffer,
                // authors1/<before>;  ... ;
                //  authors_last, <after>
                if (cite_type == "cite") {
-                       if (engine == biblio::ENGINE_BASIC) {
+                       if (engine == ENGINE_BASIC) {
                                label += *it + sep_str;
-                       } else if (engine == biblio::ENGINE_JURABIB) {
+                       } else if (engine == ENGINE_JURABIB) {
                                if (it == keys.begin())
                                        label += author + before_str + sep_str;
                                else
@@ -270,25 +242,25 @@ docstring getComplexLabel(Buffer const & buffer,
                //  authors_last (<before> year, <after>)
                } else if (cite_type == "citet") {
                        switch (engine) {
-                       case biblio::ENGINE_NATBIB_AUTHORYEAR:
+                       case ENGINE_NATBIB_AUTHORYEAR:
                                label += author + op_str + before_str +
                                        year + cp + sep_str;
                                break;
-                       case biblio::ENGINE_NATBIB_NUMERICAL:
+                       case ENGINE_NATBIB_NUMERICAL:
                                label += author + op_str + before_str + '#' + *it + cp + sep_str;
                                break;
-                       case biblio::ENGINE_JURABIB:
+                       case ENGINE_JURABIB:
                                label += before_str + author + op_str +
                                        year + cp + sep_str;
                                break;
-                       case biblio::ENGINE_BASIC:
+                       case ENGINE_BASIC:
                                break;
                        }
 
                // author, year; author, year; ...
                } else if (cite_type == "citep" ||
                           cite_type == "citealp") {
-                       if (engine == biblio::ENGINE_NATBIB_NUMERICAL) {
+                       if (engine == ENGINE_NATBIB_NUMERICAL) {
                                label += *it + sep_str;
                        } else {
                                label += author + ", " + year + sep_str;
@@ -298,18 +270,18 @@ docstring getComplexLabel(Buffer const & buffer,
                //  authors_last <before> year, <after>)
                } else if (cite_type == "citealt") {
                        switch (engine) {
-                       case biblio::ENGINE_NATBIB_AUTHORYEAR:
+                       case ENGINE_NATBIB_AUTHORYEAR:
                                label += author + ' ' + before_str +
                                        year + sep_str;
                                break;
-                       case biblio::ENGINE_NATBIB_NUMERICAL:
+                       case ENGINE_NATBIB_NUMERICAL:
                                label += author + ' ' + before_str + '#' + *it + sep_str;
                                break;
-                       case biblio::ENGINE_JURABIB:
+                       case ENGINE_JURABIB:
                                label += before_str + author + ' ' +
                                        year + sep_str;
                                break;
-                       case biblio::ENGINE_BASIC:
+                       case ENGINE_BASIC:
                                break;
                        }
 
@@ -331,7 +303,7 @@ docstring getComplexLabel(Buffer const & buffer,
                        label.insert(label.size() - 1, after_str);
                } else {
                        bool const add =
-                               !(engine == biblio::ENGINE_NATBIB_NUMERICAL &&
+                               !(engine == ENGINE_NATBIB_NUMERICAL &&
                                  (cite_type == "citeauthor" ||
                                   cite_type == "citeyear"));
                        if (add)
@@ -346,14 +318,14 @@ docstring getComplexLabel(Buffer const & buffer,
        }
 
        if (cite_type == "citep" || cite_type == "citeyearpar" || 
-           (cite_type == "cite" && engine == biblio::ENGINE_BASIC) )
+           (cite_type == "cite" && engine == ENGINE_BASIC) )
                label = op + label + cp;
 
        return label;
 }
 
 
-docstring const getBasicLabel(docstring const & keyList, docstring const & after)
+docstring basicLabel(docstring const & keyList, docstring const & after)
 {
        docstring keys = keyList;
        docstring label;
@@ -366,8 +338,9 @@ docstring const getBasicLabel(docstring const & keyList, docstring const & after
                        keys = ltrim(split(keys, key, ','));
                        label += ", " + key;
                }
-       } else
+       } else {
                label = keys;
+       }
 
        if (!after.empty())
                label += ", " + after;
@@ -403,7 +376,7 @@ ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
 
 bool InsetCitation::isCompatibleCommand(string const & cmd)
 {
-       vector<string> const & possibles = possible_cite_commands();
+       vector<string> const & possibles = possibleCiteCommands();
        vector<string>::const_iterator const end = possibles.end();
        return find(possibles.begin(), end, cmd) != end;
 }
@@ -415,13 +388,13 @@ docstring InsetCitation::generateLabel() const
        docstring const after  = getParam("after");
 
        docstring label;
-       biblio::CiteEngine const engine = buffer().params().getEngine();
-       label = getComplexLabel(buffer(), getCmdName(), getParam("key"),
+       CiteEngine const engine = buffer().params().citeEngine();
+       label = complexLabel(buffer(), getCmdName(), getParam("key"),
                               before, after, engine);
 
        // Fallback to fail-safe
        if (label.empty())
-               label = getBasicLabel(getParam("key"), after);
+               label = basicLabel(getParam("key"), after);
 
        return label;
 }
@@ -435,7 +408,7 @@ docstring InsetCitation::screenLabel() const
 
 void InsetCitation::updateLabels(ParIterator const &)
 {
-       biblio::CiteEngine const engine = buffer().params().getEngine();
+       CiteEngine const engine = buffer().params().citeEngine();
        if (cache.params == params() && cache.engine == engine)
                return;
 
@@ -457,7 +430,7 @@ void InsetCitation::updateLabels(ParIterator const &)
 }
 
 
-void InsetCitation::addToToc(ParConstIterator const & cpit) const
+void InsetCitation::addToToc(DocIterator const & cpit)
 {
        Toc & toc = buffer().tocBackend().toc("citation");
        toc.push_back(TocItem(cpit, 0, cache.screen_label));
@@ -510,7 +483,7 @@ void InsetCitation::textString(odocstream & os) const
 // should revert to \cite[]{}
 int InsetCitation::latex(odocstream & os, OutputParams const &) const
 {
-       biblio::CiteEngine cite_engine = buffer().params().getEngine();
+       CiteEngine cite_engine = buffer().params().citeEngine();
        // FIXME UNICODE
        docstring const cite_str = from_utf8(
                asValidLatexCommand(getCmdName(), cite_engine));
@@ -519,7 +492,7 @@ int InsetCitation::latex(odocstream & os, OutputParams const &) const
 
        docstring const & before = getParam("before");
        docstring const & after  = getParam("after");
-       if (!before.empty() && cite_engine != biblio::ENGINE_BASIC)
+       if (!before.empty() && cite_engine != ENGINE_BASIC)
                os << '[' << before << "][" << after << ']';
        else if (!after.empty())
                os << '[' << after << ']';
@@ -532,18 +505,24 @@ int InsetCitation::latex(odocstream & os, OutputParams const &) const
 
 void InsetCitation::validate(LaTeXFeatures & features) const
 {
-       switch (features.bufferParams().getEngine()) {
-       case biblio::ENGINE_BASIC:
+       switch (features.bufferParams().citeEngine()) {
+       case ENGINE_BASIC:
                break;
-       case biblio::ENGINE_NATBIB_AUTHORYEAR:
-       case biblio::ENGINE_NATBIB_NUMERICAL:
+       case ENGINE_NATBIB_AUTHORYEAR:
+       case ENGINE_NATBIB_NUMERICAL:
                features.require("natbib");
                break;
-       case biblio::ENGINE_JURABIB:
+       case ENGINE_JURABIB:
                features.require("jurabib");
                break;
        }
 }
 
 
+docstring InsetCitation::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-citation");
+}
+
+
 } // namespace lyx