* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#define MATH_GRID_H
#include "InsetMathNest.h"
-#include "lyxlength.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
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
- std::string 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:
+ struct RowInfo {
///
- RowInfo();
- ///
- int skipPixels() const;
+ 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
- LyXLength crskip_;
+ Length crskip;
/// extra distance between lines
- int skip_;
+ int skip = 0;
+ /// Is a page break allowed after this row?
+ bool allow_newpage = true;
};
// additional per-row information
- class ColInfo {
- public:
- ///
- ColInfo();
+ struct ColInfo {
/// currently possible: 'l', 'c', 'r'
- char align_;
- /// cache for drawing
- int h_offset;
+ 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;
};
public:
- /// sets nrows and ncols to 1
- InsetMathGrid();
- /// constructor from columns description, creates one row
- InsetMathGrid(char valign, std::string const & halign);
+ /// sets nrows and ncols to 1, vertical alignment to 'c'
+ explicit InsetMathGrid(Buffer * buf);
/// Note: columns first!
- InsetMathGrid(col_type m, row_type n);
- ///
- InsetMathGrid(col_type m, row_type n, char valign, std::string const & halign);
- /// Ensures that the dialog is closed.
- ~InsetMathGrid();
- ///
- void metrics(MetricsInfo & mi) const;
+ InsetMathGrid(Buffer * buf, col_type m, row_type n);
///
- void metrics(MetricsInfo & mi, Dimension &) const;
+ InsetMathGrid(Buffer * buf, col_type m, row_type n, char valign,
+ docstring const & halign);
///
- void draw(PainterInfo & pi, int x, int y) const;
+ marker_type marker(BufferView const *) const override { return marker_type::MARKER2; };
///
- void drawWithMargin(PainterInfo & pi, int x, int y,
- int lmargin = 0, int rmargin = 0) const;
+ void metrics(MetricsInfo & mi, Dimension &) const override;
///
- void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
+ void draw(PainterInfo & pi, int x, int y) const override;
///
- void drawT(TextPainter & pi, int x, int y) const;
+ void metricsT(TextMetricsInfo const & mi, Dimension & dim) const override;
///
- void halign(std::string const & align);
+ void drawT(TextPainter & pi, int x, int y) const override;
///
- void halign(char c, col_type col);
+ 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,<,>
+ void setHorizontalAlignments(docstring const & align);
///
- char halign(col_type col) const;
+ void setHorizontalAlignment(char c, col_type col);
///
- std::string halign() const;
+ char horizontalAlignment(col_type col) const;
///
- void valign(char c);
+ docstring horizontalAlignments() const;
+ /// 't', 'b', or 'm'
+ void setVerticalAlignment(char c);
///
- char valign() const;
+ char verticalAlignment() const;
///
- void vcrskip(LyXLength const &, row_type row);
+ void vcrskip(Length const &, row_type row);
///
- LyXLength vcrskip(row_type row) const;
+ Length vcrskip(row_type row) const;
///
void resize(short int type, col_type cols);
///
///
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(LCursor &, bool up) const;
- ///
- bool idxLeft(LCursor &) const;
+ bool idxUpDown(Cursor &, bool up) const override;
///
- bool idxRight(LCursor &) const;
+ bool idxBackward(Cursor &) const override;
///
- bool idxFirst(LCursor &) const;
+ bool idxForward(Cursor &) const override;
+ //
+ idx_type firstIdx() const override;
+ //
+ idx_type lastIdx() const override;
///
- bool idxLast(LCursor &) 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
+ /// add a row, one row down
virtual void addRow(row_type r);
/// delete a row
virtual void delRow(row_type r);
virtual void copyRow(row_type r);
/// swap two rows
virtual void swapRow(row_type r);
- /// add a column
+ /// add a column, here
virtual void addCol(col_type c);
/// delete a column
virtual void delCol(col_type c);
/// swap two columns
virtual void swapCol(col_type c);
///
- virtual void appendRow();
- ///
- 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; }
///
virtual char defaultColAlign(col_type) { return 'c'; }
///
void setDefaults();
+ ///
+ bool interpretString(Cursor & cur, docstring const & str) override;
///
virtual int colsep() const;
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 normalize(NormalStream &) const;
+ void write(WriteStream & os,
+ row_type beg_row, col_type beg_col,
+ row_type end_row, col_type end_col) const;
///
- //void maple(MapleStream &) const;
+ void normalize(NormalStream &) const override;
///
- void mathmlize(MathMLStream &) const;
+ //void maple(MapleStream &) const override;
///
- //void octave(OctaveStream &) const;
+ void mathmlize(MathMLStream &) const override;
+ ///
+ void htmlize(HtmlStream &) const override;
+ ///
+ void htmlize(HtmlStream &, std::string const & attrib) const;
+ ///
+ void validate(LaTeXFeatures & features) const override;
+ ///
+ //void octave(OctaveStream &) const override;
protected:
- virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
///
- bool getStatus(LCursor & cur, FuncRequest const & cmd,
- FuncStatus & flag) const;
+ void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+ ///
+ bool getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const override;
/// returns x offset of cell compared to inset
- int cellXOffset(idx_type idx) const;
+ 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 std::string eolString(row_type row, bool emptyline,
- bool fragile) const;
+ virtual docstring eolString(row_type row, bool fragile, bool latex,
+ bool last_eoln) const;
/// returns proper 'end of column' code for LaTeX
- virtual std::string eocString(col_type col, col_type lastcol) const;
- /// extract number of columns from alignment string
- col_type guessColumns(std::string const & halign) const;
+ virtual docstring eocString(col_type col, col_type lastcol) const;
/// splits cells and shifts right part to the next cell
- void splitCell(LCursor & cur);
+ void splitCell(Cursor & cur);
+ /// 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 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_;
/// cell info
std::vector<CellInfo> cellinfo_;
///
- char v_align_; // add approp. type
-private:
- virtual std::auto_ptr<InsetBase> doClone() const;
+ char v_align_; // FIXME: add approp. type
+ ///
+ Inset * clone() const override;
};
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff