Loop refactoring

[lyx.git] / src / insets / InsetCitation.h

diff --git a/src/insets/InsetCitation.h b/src/insets/InsetCitation.h
index 986f9fb34f2a0a1a9eae544f8f975627add1c0bf..b085a2c9428c30f5eb411225bc943b96dfec051a 100644 (file)
--- a/src/insets/InsetCitation.h
+++ b/src/insets/InsetCitation.h
@@ -14,10 +14,7 @@
 #define INSET_CITATION_H
 
 #include "InsetCommand.h"
-#include "InsetCode.h"
-
-#include "BiblioInfo.h"
-
+#include "Citation.h"
 
 namespace lyx {
 
@@ -32,63 +29,102 @@ class InsetCitation : public InsetCommand
 {
 public:
        ///
-       explicit InsetCitation(InsetCommandParams const &);
+       InsetCitation(Buffer * buf, InsetCommandParams const &);
+       ///
+       ~InsetCitation();
+
+       ///
+       bool addKey(std::string const & key);
+
+       /// \name Public functions inherited from Inset class
+       //@{
        ///
-       bool isLabeled() const { return true; }
+       bool isLabeled() const override { return true; }
        ///
-       docstring screenLabel() const;
+       bool hasSettings() const override { return true; }
        ///
-       bool hasSettings() const { return true; }
+       docstring toolTip(BufferView const & bv, int x, int y) const override;
        ///
-       docstring toolTip(BufferView const & bv, int x, int y) const;
+       void doDispatch(Cursor & cur, FuncRequest & cmd) override;
        ///
-       InsetCode lyxCode() const { return CITE_CODE; }
+       bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const override;
        ///
-       int latex(odocstream &, OutputParams const &) const;
+       InsetCode lyxCode() const override { return CITE_CODE; }
        ///
-       int plaintext(odocstream &, OutputParams const &) const;
+       void latex(otexstream &, OutputParams const &) const override;
        ///
-       int docbook(odocstream &, OutputParams const &) const;
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const override;
        ///
-       void xhtml(odocstream &, OutputParams const &) const;
-       /// the string that is passed to the TOC
-       void tocString(odocstream &) const;
+       void docbook(XMLStream &, OutputParams const &) const override;
        ///
-       void validate(LaTeXFeatures &) const;
+       docstring xhtml(XMLStream &, OutputParams const &) const override;
        ///
-       void updateLabels(ParIterator const & it);
+       void toString(odocstream &) const override;
        ///
-       void addToToc(DocIterator const &);
+       void forOutliner(docstring &, size_t const, bool const) const override;
+       ///
+       void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
+       ///
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const override;
+       ///
+       std::string contextMenuName() const override;
+       ///
+       bool forceLTR(OutputParams const &) const override;
+       //@}
 
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
        ///
        static ParamInfo const & findInfo(std::string const &);
-       // FIXME This is the locus of the design problem we have.
-       // It really ought to do what default_cite_command() does,
-       // but to do that it needs to know what CiteEngine we are
-       // using.
+       ///
        static std::string defaultCommand() { return "cite"; }
        ///
-       static bool isCompatibleCommand(std::string const & cmd);
+       static bool isCompatibleCommand(std::string const &);
+       //@}
        ///
-       virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
+       typedef std::vector<std::pair<docstring, docstring>> QualifiedList;
+       ///
+       void redoLabel() { cache.recalculate = true; }
+       ///
+       CitationStyle getCitationStyle(BufferParams const & bp, std::string const & input,
+                                      std::vector<CitationStyle> const & valid_styles) const;
+       ///
+       QualifiedList getQualifiedLists(docstring const & p) const;
+       ///
+       static bool last_literal;
+       /// Check whether citation contains necessary url/file entries
+       /// or external search script is available
+       bool openCitationPossible() const;
+       /// search and open citation source
+       void openCitation();
+
 private:
+       /// tries to make a pretty label and makes a basic one if not
+       docstring generateLabel(bool for_xhtml = false) const;
+       /// makes a pretty label
+       docstring complexLabel(bool for_xhtml = false) const;
+       /// makes a very basic label, in case we can't make a pretty one
+       docstring basicLabel(bool for_xhtml = false) const;
+
+       /// \name Private functions inherited from Inset class
+       //@{
        ///
-       Inset * clone() const { return new InsetCitation(*this); }
-       /// we'll eventually want to be able to get info on this from the 
-       /// various CiteEngines
-       static ParamInfo param_info_;
-       /// This function does the donkey work of creating the pretty label
-       docstring generateLabel() const;
+       Inset * clone() const override { return new InsetCitation(*this); }
+       //@}
 
+       /// \name Private functions inherited from InsetCommand class
+       //@{
        ///
-       class Cache {
-       public:
-               ///
-               Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {}
-               ///
-               CiteEngine engine;
+       docstring screenLabel() const override;
+       //@}
+
+       ///
+       struct Cache {
+               Cache() : recalculate(true) {}
                ///
-               InsetCommandParams params;
+               bool recalculate;
                ///
                docstring generated_label;
                ///
@@ -98,6 +134,7 @@ private:
        mutable Cache cache;
 };
 
+
 } // namespace lyx
 
 #endif // INSET_CITATION_H