InsetIndex: revamp IndexEntry to handle both legacy and modern index insets; simplify...

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

diff --git a/src/insets/InsetIndex.h b/src/insets/InsetIndex.h
index 80d8149bc4cab58a93814baafe6eef8270800343..6a74b796016404b68f9b7a29ac7643c66c8d8374 100644 (file)
--- a/src/insets/InsetIndex.h
+++ b/src/insets/InsetIndex.h
@@ -13,29 +13,40 @@
 #define INSET_INDEX_H
 
 
-#include "InsetCollapsable.h"
+#include "InsetCollapsible.h"
 #include "InsetCommand.h"
 
 
 namespace lyx {
 
+class IndexEntry;
+
 class InsetIndexParams {
 public:
+       enum PageRange {
+               None,
+               Start,
+               End
+       };
        ///
        explicit InsetIndexParams(docstring const & b = docstring())
-               : index(b) {}
+               : index(b), range(None), pagefmt("default") {}
        ///
        void write(std::ostream & os) const;
        ///
        void read(Lexer & lex);
        ///
        docstring index;
+       ///
+       PageRange range;
+       ///
+       std::string pagefmt;
 };
 
 
 /** Used to insert index labels
   */
-class InsetIndex : public InsetCollapsable {
+class InsetIndex : public InsetCollapsible {
 public:
        ///
        InsetIndex(Buffer *, InsetIndexParams const &);
@@ -45,50 +56,83 @@ public:
        static void string2params(std::string const &, InsetIndexParams &);
 private:
        ///
-       bool hasSettings() const;
+       bool hasSettings() const override;
        ///
-       InsetCode lyxCode() const { return INDEX_CODE; }
+       InsetCode lyxCode() const override { return INDEX_CODE; }
        ///
-       docstring layoutName() const { return from_ascii("Index"); }
+       docstring layoutName() const override { return from_ascii("Index"); }
        ///
-       ColorCode labelColor() const;
+       ColorCode labelColor() const override;
        ///
-       void write(std::ostream & os) const;
+       void write(std::ostream & os) const override;
        ///
-       void read(Lexer & lex);
+       void read(Lexer & lex) override;
+       ///
+       void docbook(XMLStream &, OutputParams const &) const override;
        ///
-       int docbook(odocstream &, OutputParams const &) const;
+       docstring xhtml(XMLStream &, OutputParams const &) const override;
        ///
-       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       void latex(otexstream &, OutputParams const &) const override;
        ///
-       void latex(otexstream &, OutputParams const &) const;
+       void processLatexSorting(otexstream &, OutputParams const &,
+                                docstring const, docstring const) const;
        ///
-       bool showInsetDialog(BufferView *) const;
+       bool showInsetDialog(BufferView *) const override;
        ///
-       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
        ///
-       void doDispatch(Cursor & cur, FuncRequest & cmd);
-       /// should paragraph indendation be omitted in any case?
-       bool neverIndent() const { return true; }
+       void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+       /// should paragraph indentation be omitted in any case?
+       bool neverIndent() const override { return true; }
        ///
        void addToToc(DocIterator const & di, bool output_active,
-                                 UpdateType utype, TocBackend & backend) const;
+                                 UpdateType utype, TocBackend & backend) const override;
        ///
-       docstring toolTip(BufferView const & bv, int x, int y) const;
+       docstring toolTip(BufferView const & bv, int x, int y) const override;
        ///
-       docstring const buttonLabel(BufferView const & bv) const;
+       docstring const buttonLabel(BufferView const & bv) const override;
        /// Updates needed features for this inset.
-       void validate(LaTeXFeatures & features) const;
+       void validate(LaTeXFeatures & features) const override;
+       ///
+       void getSortkey(otexstream &, OutputParams const &) const;
+       ///
+       docstring getSortkeyAsText(OutputParams const &) const;
+       ///
+       void getSubentries(otexstream &, OutputParams const &) const;
+       ///
+       std::vector<docstring> getSubentriesAsText(OutputParams const &) const;
+       ///
+       docstring getMainSubentryAsText(OutputParams const & runparams) const;
        ///
-       std::string contextMenuName() const;
+       void getSeeRefs(otexstream &, OutputParams const &) const;
        ///
-       Inset * clone() const { return new InsetIndex(*this); }
+       docstring getSeeAsText(OutputParams const & runparams) const;
+       ///
+       std::vector<docstring> getSeeAlsoesAsText(OutputParams const & runparams) const;
+       ///
+       bool hasSubentries() const;
+       ///
+       bool hasSeeRef() const;
+       ///
+       bool hasSortKey() const;
+       ///
+       bool macrosPossible(std::string const type) const;
+       ///
+       std::string contextMenuName() const override;
+       ///
+       std::string contextMenu(BufferView const &, int, int) const override;
+       ///
+       Inset * clone() const override { return new InsetIndex(*this); }
        /// Is the content of this inset part of the immediate text sequence?
-       bool isPartOfTextSequence() const { return false; }
+       bool isPartOfTextSequence() const override { return false; }
+       ///
+       bool insetAllowed(InsetCode code) const override;
 
        ///
        friend class InsetIndexParams;
        ///
+       friend class IndexEntry;
+       ///
        InsetIndexParams params_;
 };
 
@@ -101,23 +145,25 @@ public:
        /// \name Public functions inherited from Inset class
        //@{
        ///
-       InsetCode lyxCode() const { return INDEX_PRINT_CODE; }
+       InsetCode lyxCode() const override { return INDEX_PRINT_CODE; }
+       ///
+       void latex(otexstream &, OutputParams const &) const override;
        ///
-       void latex(otexstream &, OutputParams const &) const;
+       docstring xhtml(XMLStream &, OutputParams const &) const override;
        ///
-       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       void doDispatch(Cursor & cur, FuncRequest & cmd) override;
        ///
-       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
        ///
-       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
+       void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
        ///
-       std::string contextMenuName() const;
+       std::string contextMenuName() const override;
        /// Updates needed features for this inset.
-       void validate(LaTeXFeatures & features) const;
+       void validate(LaTeXFeatures & features) const override;
        ///
-       bool hasSettings() const;
+       bool hasSettings() const override;
        ///
-       DisplayType display() const { return AlignCenter; }
+       int rowFlags() const override { return Display; }
        //@}
 
        /// \name Static public methods obligated for InsetCommand derived classes
@@ -134,13 +180,13 @@ private:
        /// \name Private functions inherited from Inset class
        //@{
        ///
-       Inset * clone() const { return new InsetPrintIndex(*this); }
+       Inset * clone() const override { return new InsetPrintIndex(*this); }
        //@}
 
        /// \name Private functions inherited from InsetCommand class
        //@{
        ///
-       docstring screenLabel() const;
+       docstring screenLabel() const override;
        //@}
 };