src/mathed/InsetMathGrid.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMathGrid.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef MATH_GRID_H
  13 #define MATH_GRID_H
  14
  15 #include "InsetMathNest.h"
  16 #include "Length.h"
  17
  18
  19 namespace lyx {
  20
  21
  22 /** Gridded math inset base class.
  23  *  This is the base to all grid-like editable math objects
  24  */
  25 class InsetMathGrid : public InsetMathNest {
  26 public:
  27
  28         enum Multicolumn {
  29                 /// A normal cell
  30                 CELL_NORMAL = 0,
  31                 /// A multicolumn cell. The number of columns is <tt>1 + number
  32                 /// of CELL_PART_OF_MULTICOLUMN cells</tt> that follow directly
  33                 CELL_BEGIN_OF_MULTICOLUMN = 1,
  34                 /// This is a dummy cell (part of a multicolumn cell)
  35                 CELL_PART_OF_MULTICOLUMN = 2
  36         };
  37
  38         /// additional per-cell information
  39         class CellInfo {
  40         public:
  41                 ///
  42                 CellInfo();
  43                 /// multicolumn flag
  44                 Multicolumn multi_;
  45                 /// special multi colums alignment
  46                 docstring align_;
  47         };
  48
  49         /// additional per-row information
  50         class RowInfo {
  51         public:
  52                 ///
  53                 RowInfo();
  54                 ///
  55                 int skipPixels(MetricsInfo const & mi) const;
  56                 /// cached descent
  57                 mutable int descent_;
  58                 /// cached ascent
  59                 mutable int ascent_;
  60                 /// cached offset
  61                 mutable int offset_;
  62                 /// how many hlines above this row?
  63                 unsigned int lines_;
  64                 /// parameter to the line break
  65                 Length crskip_;
  66                 /// extra distance between lines
  67                 int skip_;
  68                 /// Is a page break allowed after this row?
  69                 bool allow_newpage_;
  70         };
  71
  72         // additional per-row information
  73         class ColInfo {
  74         public:
  75                 ///
  76                 ColInfo();
  77                 /// currently possible: 'l', 'c', 'r'
  78                 char align_;
  79                 /// cached width
  80                 mutable int width_;
  81                 /// cached offset
  82                 mutable int offset_;
  83                 /// how many lines to the left of this column?
  84                 unsigned int lines_;
  85                 /// additional amount to the right to be skipped when drawing
  86                 int skip_;
  87                 /// Special alignment.
  88                 /// This does also contain align_ and lines_ if it is nonempty.
  89                 /// It needs to be in sync with align_ and lines_ because some
  90                 /// code only uses align_ and lines_.
  91                 docstring special_;
  92         };
  93
  94 public:
  95         /// sets nrows and ncols to 1, vertical alingment to 'c'
  96         InsetMathGrid(Buffer * buf);
  97         /// Note: columns first!
  98         InsetMathGrid(Buffer * buf, col_type m, row_type n);
  99         ///
 100         InsetMathGrid(Buffer * buf, col_type m, row_type n, char valign,
 101                 docstring const & halign);
 102         ///
 103         void metrics(MetricsInfo & mi, Dimension &) const;
 104         ///
 105         void draw(PainterInfo & pi, int x, int y) const;
 106         ///
 107         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
 108         ///
 109         void drawT(TextPainter & pi, int x, int y) const;
 110         ///
 111         void updateBuffer(ParIterator const &, UpdateType);
 112         /// extract number of columns from alignment string
 113         static col_type guessColumns(docstring const & halign);
 114         /// accepts some LaTeX column codes: p,m,!,@,M,<,>
 115         void setHorizontalAlignments(docstring const & align);
 116         ///
 117         void setHorizontalAlignment(char c, col_type col);
 118         ///
 119         char horizontalAlignment(col_type col) const;
 120         ///
 121         docstring horizontalAlignments() const;
 122         /// 't', 'b', or 'm'
 123         void setVerticalAlignment(char c);
 124         ///
 125         char verticalAlignment() const;
 126         ///
 127         void vcrskip(Length const &, row_type row);
 128         ///
 129         Length vcrskip(row_type row) const;
 130         ///
 131         void resize(short int type, col_type cols);
 132         ///
 133         const RowInfo & rowinfo(row_type row) const;
 134         /// returns topmost row if passed (-1)
 135         RowInfo & rowinfo(row_type row);
 136         ///
 137         const CellInfo & cellinfo(idx_type idx) const { return cellinfo_[idx]; }
 138         ///
 139         CellInfo & cellinfo(idx_type idx) { return cellinfo_[idx]; }
 140         /// identifies GridInset
 141         InsetMathGrid * asGridInset() { return this; }
 142         /// identifies GridInset
 143         InsetMathGrid const * asGridInset() const { return this; }
 144         //
 145         bool isTable() const { return true; }
 146         ///
 147         col_type ncols() const;
 148         ///
 149         row_type nrows() const;
 150         ///
 151         col_type col(idx_type idx) const;
 152         ///
 153         row_type row(idx_type idx) const;
 154         /// number of columns of cell \p idx
 155         col_type ncellcols(idx_type idx) const;
 156
 157         ///
 158         bool idxUpDown(Cursor &, bool up) const;
 159         ///
 160         bool idxBackward(Cursor &) const;
 161         ///
 162         bool idxForward(Cursor &) const;
 163         ///
 164         bool idxFirst(Cursor &) const;
 165         ///
 166         bool idxLast(Cursor &) const;
 167         ///
 168         bool idxDelete(idx_type & idx);
 169         /// pulls cell after pressing erase
 170         void idxGlue(idx_type idx);
 171
 172         /// add a row, one row down
 173         virtual void addRow(row_type r);
 174         /// delete a row
 175         virtual void delRow(row_type r);
 176         /// copy a row
 177         virtual void copyRow(row_type r);
 178         /// swap two rows
 179         virtual void swapRow(row_type r);
 180         /// add a column, here
 181         virtual void addCol(col_type c);
 182         /// delete a column
 183         virtual void delCol(col_type c);
 184         /// copy a column
 185         virtual void copyCol(col_type c);
 186         /// swap two columns
 187         virtual void swapCol(col_type c);
 188         ///
 189         idx_type index(row_type r, col_type c) const;
 190         ///
 191         bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
 192         ///
 193         virtual int defaultColSpace(col_type) { return 0; }
 194         ///
 195         virtual char defaultColAlign(col_type) { return 'c'; }
 196         ///
 197         void setDefaults();
 198         ///
 199         virtual bool interpretString(Cursor & cur, docstring const & str);
 200
 201         ///
 202         virtual int colsep() const;
 203         ///
 204         virtual int rowsep() const;
 205         ///
 206         virtual int hlinesep() const;
 207         ///
 208         virtual int vlinesep() const;
 209         ///
 210         virtual int border() const;
 211         ///
 212         virtual bool handlesMulticolumn() const { return false; }
 213
 214         ///
 215         void write(WriteStream & os) const;
 216         ///
 217         void write(WriteStream & os,
 218                    row_type beg_row, col_type beg_col,
 219                    row_type end_row, col_type end_col) const;
 220         ///
 221         void normalize(NormalStream &) const;
 222         ///
 223         //void maple(MapleStream &) const;
 224         ///
 225         void mathmlize(MathStream &) const;
 226         ///
 227         void htmlize(HtmlStream &) const;
 228         ///
 229         void htmlize(HtmlStream &, std::string attrib) const;
 230         ///
 231         void validate(LaTeXFeatures & features) const;
 232         ///
 233         //void octave(OctaveStream &) const;
 234
 235 protected:
 236         ///
 237         void doDispatch(Cursor & cur, FuncRequest & cmd);
 238         ///
 239         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 240                 FuncStatus & flag) const;
 241         /// returns x offset of cell compared to inset
 242         int cellXOffset(BufferView const &, idx_type idx) const;
 243         /// returns y offset of cell compared to inset
 244         int cellYOffset(idx_type idx) const;
 245         /// Width of cell, taking combined columns into account
 246         int cellWidth(idx_type idx) const;
 247         ///
 248         virtual int leftMargin() const { return 0; }
 249         ///
 250         virtual int rightMargin() const { return 0; }
 251
 252         /// returns proper 'end of line' code for LaTeX
 253         virtual docstring eolString(row_type row, bool fragile, bool latex,
 254                         bool last_eoln) const;
 255         /// returns proper 'end of column' code for LaTeX
 256         virtual docstring eocString(col_type col, col_type lastcol) const;
 257         /// splits cells and shifts right part to the next cell
 258         void splitCell(Cursor & cur);
 259         /// Column alignment for display of cell \p idx.
 260         /// Must not be written to file!
 261         virtual char displayColAlign(idx_type idx) const;
 262         /// Column spacing for display of column \p col.
 263         /// Must not be written to file!
 264         virtual int displayColSpace(col_type col) const;
 265
 266         // The following two functions are used in InsetMathHull and
 267         // InsetMathSplit.
 268         /// The value of a fixed col align for a certain hull type
 269         static char colAlign(HullType type, col_type col);
 270         /// The value of a fixed col spacing for a certain hull type
 271         static int colSpace(HullType type, col_type col);
 272
 273         /// positions of vertical and horizontal lines
 274         int vLineHOffset(col_type col, unsigned int line) const;
 275         int hLineVOffset(row_type row, unsigned int line) const;
 276
 277         /// row info.
 278         /// rowinfo_[nrows()] is a dummy row used only for hlines.
 279         std::vector<RowInfo> rowinfo_;
 280         /// column info.
 281         /// colinfo_[ncols()] is a dummy column used only for vlines.
 282         std::vector<ColInfo> colinfo_;
 283         /// cell info
 284         std::vector<CellInfo> cellinfo_;
 285         ///
 286         InsetCode lyxCode() const { return MATH_GRID_CODE; }
 287
 288 private:
 289         ///
 290         char v_align_; // FIXME: add approp. type
 291         ///
 292         Inset * clone() const;
 293 };
 294
 295
 296 } // namespace lyx
 297
 298 #endif