]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCitation.cpp
Fix GRAPHICS_EDIT of InsetGraphics
[lyx.git] / src / insets / InsetCitation.cpp
index 88a3cb120284408d9c125d316eea9987adbb79f7..260bd41bf23aef70e81c2d1524ca8bdff70c2d61 100644 (file)
 #include "InsetCitation.h"
 
 #include "Buffer.h"
+#include "buffer_funcs.h"
 #include "BufferParams.h"
 #include "DispatchResult.h"
-#include "support/gettext.h"
 #include "EmbeddedFiles.h"
 #include "FuncRequest.h"
 #include "LaTeXFeatures.h"
+#include "ParIterator.h"
+#include "TocBackend.h"
 
 #include "support/debug.h"
 #include "support/docstream.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 
 #include <algorithm>
@@ -53,15 +56,15 @@ 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(biblio::CiteEngine engine)
 {
        string str;
        switch (engine) {
@@ -82,10 +85,9 @@ string const default_cite_command(biblio::CiteEngine engine)
 }
 
                
-string const 
-               asValidLatexCommand(string const & input, biblio::CiteEngine const engine)
+string asValidLatexCommand(string const & input, biblio::CiteEngine const engine)
 {
-       string const default_str = default_cite_command(engine);
+       string const default_str = defaultCiteCommand(engine);
        if (!InsetCitation::isCompatibleCommand(input))
                return default_str;
 
@@ -126,7 +128,7 @@ string const
 }
 
 
-docstring const getComplexLabel(Buffer const & buffer,
+docstring complexLabel(Buffer const & buffer,
                            string const & citeType, docstring const & keyList,
                            docstring const & before, docstring const & after,
                            biblio::CiteEngine engine)
@@ -350,7 +352,7 @@ docstring const getComplexLabel(Buffer const & buffer,
 }
 
 
-docstring const getBasicLabel(docstring const & keyList, docstring const & after)
+docstring basicLabel(docstring const & keyList, docstring const & after)
 {
        docstring keys = keyList;
        docstring label;
@@ -363,8 +365,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;
@@ -375,59 +378,69 @@ docstring const getBasicLabel(docstring const & keyList, docstring const & after
 } // anon namespace
 
 
+ParamInfo InsetCitation::param_info_;
+
+
 InsetCitation::InsetCitation(InsetCommandParams const & p)
        : InsetCommand(p, "citation")
 {}
 
 
-CommandInfo const * InsetCitation::findInfo(string const & /* cmdName */)
+ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
 {
        // standard cite does only take one argument if jurabib is
        // not used, but jurabib extends this to two arguments, so
        // we have to allow both here. InsetCitation takes care that
        // LaTeX output is nevertheless correct.
-       static const char * const paramnames[] =
-               {"after", "before", "key", ""};
-       static const bool isoptional[] = {true, true, false};
-       static const CommandInfo info = {3, paramnames, isoptional};
-       return &info;
+       if (param_info_.empty()) {
+               param_info_.add("after", ParamInfo::LATEX_OPTIONAL);
+               param_info_.add("before", ParamInfo::LATEX_OPTIONAL);
+               param_info_.add("key", ParamInfo::LATEX_REQUIRED);
+       }
+       return param_info_;
 }
 
 
 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;
 }
 
 
-docstring const InsetCitation::generateLabel(Buffer const & buffer) const
+docstring InsetCitation::generateLabel() const
 {
        docstring const before = getParam("before");
        docstring const after  = getParam("after");
 
        docstring label;
-       biblio::CiteEngine const engine = buffer.params().getEngine();
-       label = getComplexLabel(buffer, getCmdName(), getParam("key"),
+       biblio::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;
 }
 
 
-docstring const InsetCitation::getScreenLabel(Buffer const & buffer) const
+docstring InsetCitation::screenLabel() const
 {
-       biblio::CiteEngine const engine = buffer.params().getEngine();
+       return cache.screen_label;
+}
+
+
+void InsetCitation::updateLabels(ParIterator const &)
+{
+       biblio::CiteEngine const engine = buffer().params().citeEngine();
        if (cache.params == params() && cache.engine == engine)
-               return cache.screen_label;
+               return;
 
        // The label has changed, so we have to re-create it.
-       docstring const glabel = generateLabel(buffer);
+       docstring const glabel = generateLabel();
 
        unsigned int const maxLabelChars = 45;
 
@@ -441,24 +454,20 @@ docstring const InsetCitation::getScreenLabel(Buffer const & buffer) const
        cache.params = params();
        cache.generated_label = glabel;
        cache.screen_label = label;
-
-       return label;
 }
 
 
-int InsetCitation::plaintext(Buffer const & buffer, odocstream & os,
-                            OutputParams const &) const
+void InsetCitation::addToToc(ParConstIterator const & cpit) const
 {
-       docstring str;
+       Toc & toc = buffer().tocBackend().toc("citation");
+       toc.push_back(TocItem(cpit, 0, cache.screen_label));
+}
 
-       if (cache.params == params() &&
-           cache.engine == buffer.params().getEngine())
-               str = cache.generated_label;
-       else
-               str = generateLabel(buffer);
 
-       os << str;
-       return str.size();
+int InsetCitation::plaintext(odocstream & os, OutputParams const &) const
+{
+       os << cache.generated_label;
+       return cache.generated_label.size();
 }
 
 
@@ -480,8 +489,7 @@ static docstring const cleanupWhitespace(docstring const & citelist)
 }
 
 
-int InsetCitation::docbook(Buffer const &, odocstream & os,
-                          OutputParams const &) const
+int InsetCitation::docbook(odocstream & os, OutputParams const &) const
 {
        os << from_ascii("<citation>")
           << cleanupWhitespace(getParam("key"))
@@ -490,9 +498,9 @@ int InsetCitation::docbook(Buffer const &, odocstream & os,
 }
 
 
-void InsetCitation::textString(Buffer const & buf, odocstream & os) const
+void InsetCitation::textString(odocstream & os) const
 {
-       plaintext(buf, os, OutputParams(0));
+       plaintext(os, OutputParams(0));
 }
 
 
@@ -500,10 +508,9 @@ void InsetCitation::textString(Buffer const & buf, odocstream & os) const
 // 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
 // should revert to \cite[]{}
-int InsetCitation::latex(Buffer const & buffer, odocstream & os,
-                        OutputParams const &) const
+int InsetCitation::latex(odocstream & os, OutputParams const &) const
 {
-       biblio::CiteEngine cite_engine = buffer.params().getEngine();
+       biblio::CiteEngine cite_engine = buffer().params().citeEngine();
        // FIXME UNICODE
        docstring const cite_str = from_utf8(
                asValidLatexCommand(getCmdName(), cite_engine));
@@ -525,7 +532,7 @@ int InsetCitation::latex(Buffer const & buffer, odocstream & os,
 
 void InsetCitation::validate(LaTeXFeatures & features) const
 {
-       switch (features.bufferParams().getEngine()) {
+       switch (features.bufferParams().citeEngine()) {
        case biblio::ENGINE_BASIC:
                break;
        case biblio::ENGINE_NATBIB_AUTHORYEAR: