]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMathGrid.h
Rename MathStream to MathMLStream.
[lyx.git] / src / mathed / InsetMathGrid.h
index 7ff533be998e4f978b16d500c3e9cb95c3a39434..992844cfb875cd25a7c6b02e8ee238f1b9fb7706 100644 (file)
 #define MATH_GRID_H
 
 #include "InsetMathNest.h"
-#include "Length.h"
 
+#include "support/Length.h"
+
+#include <map>
 
 namespace lyx {
 
+class BufferView;
 
 /** Gridded math inset base class.
  *  This is the base to all grid-like editable math objects
@@ -25,93 +28,83 @@ namespace lyx {
 class InsetMathGrid : public InsetMathNest {
 public:
 
+       enum Multicolumn {
+               /// A normal cell
+               CELL_NORMAL = 0,
+               /// A multicolumn cell. The number of columns is <tt>1 + number
+               /// of CELL_PART_OF_MULTICOLUMN cells</tt> that follow directly
+               CELL_BEGIN_OF_MULTICOLUMN = 1,
+               /// This is a dummy cell (part of a multicolumn cell)
+               CELL_PART_OF_MULTICOLUMN = 2
+       };
+
        /// additional per-cell information
-       class CellInfo {
-       public:
-               ///
-               CellInfo();
-               /// a dummy cell before a multicolumn cell
-               int dummy_;
-               /// special multi colums alignment
-               docstring align_;
-               /// these should be a per-cell property, but ok to have it here
-               /// for single-column grids like paragraphs
-               mutable int glue_;
-               ///
-               mutable pos_type begin_;
-               ///
-               mutable pos_type end_;
+       struct CellInfo {
+               /// multicolumn flag
+               Multicolumn multi = CELL_NORMAL;
+               /// special multi columns alignment
+               docstring align;
        };
 
        /// additional per-row information
-       class RowInfo {
-       public:
-               ///
-               RowInfo();
+       struct RowInfo {
                ///
                int skipPixels(MetricsInfo const & mi) const;
                /// cached descent
-               mutable int descent_;
+               mutable int descent = 0;
                /// cached ascent
-               mutable int ascent_;
-               /// cached offset
-               mutable int offset_;
+               mutable int ascent = 0;
+               /// cached offset for each bufferview
+               mutable std::map<BufferView const *, int> offset;
                /// how many hlines above this row?
-               unsigned int lines_;
+               unsigned int lines = 0;
                /// parameter to the line break
-               Length crskip_;
+               Length crskip;
                /// extra distance between lines
-               int skip_;
+               int skip = 0;
                /// Is a page break allowed after this row?
-               bool allow_newpage_;
+               bool allow_newpage = true;
        };
 
        // additional per-row information
-       class ColInfo {
-       public:
-               ///
-               ColInfo();
+       struct ColInfo {
                /// currently possible: 'l', 'c', 'r'
-               char align_;
+               char align = 'c';
                /// cached width
-               mutable int width_;
+               mutable int width = 0;
                /// cached offset
-               mutable int offset_;
+               mutable int offset = 0;
                /// how many lines to the left of this column?
-               unsigned int lines_;
-               /// additional amount to be skipped when drawing
-               int skip_;
+               unsigned int lines = 0;
+               /// additional amount to the right to be skipped when drawing
+               int skip = 0;
                /// Special alignment.
                /// This does also contain align_ and lines_ if it is nonempty.
                /// It needs to be in sync with align_ and lines_ because some
                /// code only uses align_ and lines_.
-               docstring special_;
+               docstring special;
        };
 
 public:
-       /// sets nrows and ncols to 1, vertical alingment to 'c'
-       InsetMathGrid(Buffer * buf);
+       /// sets nrows and ncols to 1, vertical alignment to 'c'
+       explicit InsetMathGrid(Buffer * buf);
        /// Note: columns first!
        InsetMathGrid(Buffer * buf, col_type m, row_type n);
        ///
        InsetMathGrid(Buffer * buf, col_type m, row_type n, char valign,
                docstring const & halign);
        ///
-       void metrics(MetricsInfo & mi, Dimension &) const;
+       marker_type marker(BufferView const *) const override { return marker_type::MARKER2; };
        ///
-       void draw(PainterInfo & pi, int x, int y) const;
+       void metrics(MetricsInfo & mi, Dimension &) const override;
        ///
-       void drawWithMargin(PainterInfo & pi, int x, int y,
-               int lmargin = 0, int rmargin = 0) const;
-       /// draw decorations.
-       void drawDecoration(PainterInfo & pi, int x, int y) const
-       { drawMarkers2(pi, x, y); }
+       void draw(PainterInfo & pi, int x, int y) const override;
        ///
-       void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
+       void metricsT(TextMetricsInfo const & mi, Dimension & dim) const override;
        ///
-       void drawT(TextPainter & pi, int x, int y) const;
+       void drawT(TextPainter & pi, int x, int y) const override;
        ///
-       void updateBuffer(ParIterator const &, UpdateType);
+       void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false) override;
        /// extract number of columns from alignment string
        static col_type guessColumns(docstring const & halign);
        /// accepts some LaTeX column codes: p,m,!,@,M,<,>
@@ -141,32 +134,36 @@ public:
        ///
        CellInfo & cellinfo(idx_type idx) { return cellinfo_[idx]; }
        /// identifies GridInset
-       InsetMathGrid * asGridInset() { return this; }
+       InsetMathGrid * asGridInset() override { return this; }
        /// identifies GridInset
-       InsetMathGrid const * asGridInset() const { return this; }
+       InsetMathGrid const * asGridInset() const override { return this; }
+       //
+       bool isTable() const override { return true; }
        ///
-       col_type ncols() const;
+       col_type ncols() const override;
        ///
-       row_type nrows() const;
+       row_type nrows() const override;
        ///
-       col_type col(idx_type idx) const;
+       col_type col(idx_type idx) const override;
        ///
-       row_type row(idx_type idx) const;
+       row_type row(idx_type idx) const override;
+       /// number of columns of cell \p idx
+       col_type ncellcols(idx_type idx) const;
 
        ///
-       bool idxUpDown(Cursor &, bool up) const;
-       ///
-       bool idxBackward(Cursor &) const;
+       bool idxUpDown(Cursor &, bool up) const override;
        ///
-       bool idxForward(Cursor &) const;
+       bool idxBackward(Cursor &) const override;
        ///
-       bool idxFirst(Cursor &) const;
+       bool idxForward(Cursor &) const override;
+       //
+       idx_type firstIdx() const override;
+       //
+       idx_type lastIdx() const override;
        ///
-       bool idxLast(Cursor &) const;
-       ///
-       bool idxDelete(idx_type & idx);
+       bool idxDelete(idx_type & idx) override;
        /// pulls cell after pressing erase
-       void idxGlue(idx_type idx);
+       void idxGlue(idx_type idx) override;
 
        /// add a row, one row down
        virtual void addRow(row_type r);
@@ -185,9 +182,9 @@ public:
        /// swap two columns
        virtual void swapCol(col_type c);
        ///
-       idx_type index(row_type r, col_type c) const;
+       idx_type index(row_type r, col_type c) const override;
        ///
-       bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
+       bool idxBetween(idx_type idx, idx_type from, idx_type to) const override;
        ///
        virtual int defaultColSpace(col_type) { return 0; }
        ///
@@ -195,7 +192,7 @@ public:
        ///
        void setDefaults();
        ///
-       virtual bool interpretString(Cursor & cur, docstring const & str);
+       bool interpretString(Cursor & cur, docstring const & str) override;
 
        ///
        virtual int colsep() const;
@@ -207,36 +204,47 @@ public:
        virtual int vlinesep() const;
        ///
        virtual int border() const;
+       ///
+       virtual bool handlesMulticolumn() const { return false; }
 
        ///
-       void write(WriteStream & os) const;
+       void write(WriteStream & os) const override;
        ///
        void write(WriteStream & os,
                   row_type beg_row, col_type beg_col,
                   row_type end_row, col_type end_col) const;
        ///
-       void normalize(NormalStream &) const;
+       void normalize(NormalStream &) const override;
+       ///
+       //void maple(MapleStream &) const override;
        ///
-       //void maple(MapleStream &) const;
+       void mathmlize(MathMLStream &) const override;
        ///
-       void mathmlize(MathStream &) const;
-       /// 
-       void htmlize(HtmlStream &) const;
+       void htmlize(HtmlStream &) const override;
        ///
-       void htmlize(HtmlStream &, std::string attrib) const;
+       void htmlize(HtmlStream &, std::string const & attrib) const;
        ///
-       //void octave(OctaveStream &) const;
+       void validate(LaTeXFeatures & features) const override;
+       ///
+       //void octave(OctaveStream &) const override;
 
 protected:
        ///
-       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       void doDispatch(Cursor & cur, FuncRequest & cmd) override;
        ///
        bool getStatus(Cursor & cur, FuncRequest const & cmd,
-               FuncStatus & flag) const;
+               FuncStatus & flag) const override;
        /// returns x offset of cell compared to inset
        int cellXOffset(BufferView const &, idx_type idx) const;
        /// returns y offset of cell compared to inset
-       int cellYOffset(idx_type idx) const;
+       int cellYOffset(BufferView const &, idx_type idx) const;
+       /// Width of cell, taking combined columns into account
+       int cellWidth(idx_type idx) const;
+       ///
+       virtual int leftMargin() const { return 0; }
+       ///
+       virtual int rightMargin() const { return 0; }
+
        /// returns proper 'end of line' code for LaTeX
        virtual docstring eolString(row_type row, bool fragile, bool latex,
                        bool last_eoln) const;
@@ -244,11 +252,29 @@ protected:
        virtual docstring eocString(col_type col, col_type lastcol) const;
        /// splits cells and shifts right part to the next cell
        void splitCell(Cursor & cur);
-       /// Column aligmment for display of cell at (\p row, \p col).
+       /// Column alignment for display of cell \p idx.
+       /// Must not be written to file!
+       virtual char displayColAlign(idx_type idx) const;
+       /// Column spacing for display of column \p col.
        /// Must not be written to file!
-       virtual char displayColAlign(col_type col, row_type) const { return colinfo_[col].align_; }
+       virtual int displayColSpace(col_type col) const;
+
+       // The following two functions are used in InsetMathHull and
+       // InsetMathSplit.
+       /// The value of a fixed col align for a certain hull type (can
+       /// depend on the "indent math" setting).
+       char colAlign(HullType type, col_type col) const;
+       /// The value of a fixed col spacing for a certain hull type
+       static int colSpace(HullType type, col_type col);
 
+       /// positions of vertical and horizontal lines
+       int vLineHOffset(col_type col, unsigned int line) const;
+       int hLineVOffset(BufferView const &, row_type row, unsigned int line) const;
 
+       ///
+       InsetCode lyxCode() const override { return MATH_GRID_CODE; }
+
+private:
        /// row info.
        /// rowinfo_[nrows()] is a dummy row used only for hlines.
        std::vector<RowInfo> rowinfo_;
@@ -258,13 +284,9 @@ protected:
        /// cell info
        std::vector<CellInfo> cellinfo_;
        ///
-       InsetCode lyxCode() const { return MATH_GRID_CODE; }
-
-private:
-       ///
-       char v_align_; // add approp. type
+       char v_align_; // FIXME: add approp. type
        ///
-       Inset * clone() const;
+       Inset * clone() const override;
 };