+
+class InsetTabular;
+class Cursor;
+class OutputParams;
+
+//
+// A helper struct for tables
+//
+class Tabular {
+public:
+ ///
+ enum Feature {
+ ///
+ APPEND_ROW = 0,
+ ///
+ APPEND_COLUMN,
+ ///
+ DELETE_ROW,
+ ///
+ DELETE_COLUMN,
+ ///
+ COPY_ROW,
+ ///
+ COPY_COLUMN,
+ ///
+ SET_LINE_TOP,
+ ///
+ SET_LINE_BOTTOM,
+ ///
+ SET_LINE_LEFT,
+ ///
+ SET_LINE_RIGHT,
+ ///FIXME: remove
+ TOGGLE_LINE_TOP,
+ ///FIXME: remove
+ TOGGLE_LINE_BOTTOM,
+ ///FIXME: remove
+ TOGGLE_LINE_LEFT,
+ ///FIXME: remove
+ TOGGLE_LINE_RIGHT,
+ ///
+ ALIGN_LEFT,
+ ///
+ ALIGN_RIGHT,
+ ///
+ ALIGN_CENTER,
+ ///
+ ALIGN_BLOCK,
+ ///
+ ALIGN_DECIMAL,
+ ///
+ VALIGN_TOP,
+ ///
+ VALIGN_BOTTOM,
+ ///
+ VALIGN_MIDDLE,
+ ///
+ M_ALIGN_LEFT,
+ ///
+ M_ALIGN_RIGHT,
+ ///
+ M_ALIGN_CENTER,
+ ///
+ M_VALIGN_TOP,
+ ///
+ M_VALIGN_BOTTOM,
+ ///
+ M_VALIGN_MIDDLE,
+ ///
+ MULTICOLUMN,
+ ///
+ MULTIROW,
+ ///
+ SET_ALL_LINES,
+ ///
+ UNSET_ALL_LINES,
+ ///
+ SET_LONGTABULAR,
+ ///
+ UNSET_LONGTABULAR,
+ ///
+ SET_PWIDTH,
+ ///
+ SET_MPWIDTH,
+ ///
+ SET_ROTATE_TABULAR,
+ ///
+ UNSET_ROTATE_TABULAR,
+ ///
+ TOGGLE_ROTATE_TABULAR,
+ ///
+ SET_ROTATE_CELL,
+ ///
+ UNSET_ROTATE_CELL,
+ ///
+ TOGGLE_ROTATE_CELL,
+ ///
+ SET_USEBOX,
+ ///
+ SET_LTHEAD,
+ UNSET_LTHEAD,
+ ///
+ SET_LTFIRSTHEAD,
+ UNSET_LTFIRSTHEAD,
+ ///
+ SET_LTFOOT,
+ UNSET_LTFOOT,
+ ///
+ SET_LTLASTFOOT,
+ UNSET_LTLASTFOOT,
+ ///
+ SET_LTNEWPAGE,
+ ///
+ TOGGLE_LTCAPTION,
+ ///
+ SET_SPECIAL_COLUMN,
+ ///
+ SET_SPECIAL_MULTICOLUMN,
+ ///
+ SET_SPECIAL_MULTIROW,
+ ///
+ SET_BOOKTABS,
+ ///
+ UNSET_BOOKTABS,
+ ///
+ SET_TOP_SPACE,
+ ///
+ SET_BOTTOM_SPACE,
+ ///
+ SET_INTERLINE_SPACE,
+ ///
+ SET_BORDER_LINES,
+ ///
+ TABULAR_VALIGN_TOP,
+ ///
+ TABULAR_VALIGN_MIDDLE,
+ ///
+ TABULAR_VALIGN_BOTTOM,
+ ///
+ LONGTABULAR_ALIGN_LEFT,
+ ///
+ LONGTABULAR_ALIGN_CENTER,
+ ///
+ LONGTABULAR_ALIGN_RIGHT,
+ ///
+ SET_DECIMAL_POINT,
+ ///
+ LAST_ACTION
+ };
+ ///
+ enum {
+ ///
+ CELL_NORMAL = 0,
+ ///
+ CELL_BEGIN_OF_MULTICOLUMN,
+ ///
+ CELL_PART_OF_MULTICOLUMN,
+ ///
+ CELL_BEGIN_OF_MULTIROW,
+ ///
+ CELL_PART_OF_MULTIROW
+ };
+
+ ///
+ enum VAlignment {
+ ///
+ LYX_VALIGN_TOP = 0,
+ ///
+ LYX_VALIGN_MIDDLE = 1,
+ ///
+ LYX_VALIGN_BOTTOM = 2
+
+ };
+ ///
+ enum HAlignment {
+ ///
+ LYX_LONGTABULAR_ALIGN_LEFT = 0,
+ ///
+ LYX_LONGTABULAR_ALIGN_CENTER = 1,
+ ///
+ LYX_LONGTABULAR_ALIGN_RIGHT = 2
+ };
+
+ enum BoxType {
+ ///
+ BOX_NONE = 0,
+ ///
+ BOX_PARBOX = 1,
+ ///
+ BOX_MINIPAGE = 2
+ };
+
+ class ltType {
+ public:
+ // constructor
+ ltType();
+ // we have this header type (is set in the getLT... functions)
+ bool set;
+ // double borders on top
+ bool topDL;
+ // double borders on bottom
+ bool bottomDL;
+ // used for FirstHeader & LastFooter and if this is true
+ // all the rows marked as FirstHeader or LastFooter are
+ // ignored in the output and it is set to be empty!
+ bool empty;
+ };
+
+ /// type for row numbers
+ typedef size_t row_type;
+ /// type for column numbers
+ typedef size_t col_type;
+ /// type for cell indices
+ typedef size_t idx_type;
+ /// index indicating an invalid position
+ static const idx_type npos = static_cast<idx_type>(-1);
+
+ /// constructor
+ Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
+
+ /// Returns true if there is a topline, returns false if not
+ bool topLine(idx_type cell) const;
+ /// Returns true if there is a topline, returns false if not
+ bool bottomLine(idx_type cell) const;
+ /// Returns true if there is a topline, returns false if not
+ bool leftLine(idx_type cell) const;
+ /// Returns true if there is a topline, returns false if not
+ bool rightLine(idx_type cell) const;
+
+ /// return space occupied by the second horizontal line and
+ /// interline space above row \p row in pixels
+ int interRowSpace(row_type row) const;
+ ///
+ int interColumnSpace(idx_type cell) const;
+
+ /* returns the maximum over all rows */
+ ///
+ int cellWidth(idx_type cell) const;
+ ///
+ int cellHeight(idx_type cell) const;
+ ///
+ int width() const;
+ ///
+ int height() const;
+ ///
+ row_type nrows() const {return row_info.size();}
+ ///
+ col_type ncols() const {return column_info.size();}
+ ///
+ int rowAscent(row_type row) const;
+ ///
+ int rowDescent(row_type row) const;
+ ///
+ void setRowAscent(row_type row, int height);
+ ///
+ void setRowDescent(row_type row, int height);
+ ///
+ void setTopLine(idx_type cell, bool line);
+ ///
+ void setBottomLine(idx_type cell, bool line);
+ ///
+ void setLeftLine(idx_type cell, bool line);
+ ///
+ void setRightLine(idx_type cell, bool line);
+ ///
+ bool rowTopLine(row_type row) const;
+ ///
+ bool rowBottomLine(row_type row) const;
+ ///
+ bool columnLeftLine(col_type column) const;
+ ///
+ bool columnRightLine(col_type column) const;
+
+ void setAlignment(idx_type cell, LyXAlignment align,
+ bool onlycolumn = false);
+ ///
+ void setVAlignment(idx_type cell, VAlignment align,
+ bool onlycolumn = false);
+ ///
+ void setColumnPWidth(Cursor &, idx_type, Length const &);
+ ///
+ bool setMColumnPWidth(Cursor &, idx_type, Length const &);
+ ///
+ void setAlignSpecial(idx_type cell, docstring const & special,
+ Feature what);
+ ///
+ LyXAlignment getAlignment(idx_type cell,
+ bool onlycolumn = false) const;
+ ///
+ VAlignment getVAlignment(idx_type cell,
+ bool onlycolumn = false) const;
+ ///
+ Length const getPWidth(idx_type cell) const;
+ ///
+ int textHOffset(idx_type cell) const;
+ ///
+ int textVOffset(idx_type cell) const;
+ ///
+ void appendRow(idx_type cell);
+ ///
+ void deleteRow(row_type row);
+ ///
+ void copyRow(row_type);
+ ///
+ void appendColumn(idx_type cell);
+ ///
+ void deleteColumn(col_type column);
+ ///
+ void copyColumn(col_type);
+ ///
+ idx_type getFirstCellInRow(row_type row) const;
+ ///
+ idx_type getLastCellInRow(row_type row) const;
+ ///
+ idx_type numberOfCellsInRow(row_type row) const;
+ ///
+ void write(std::ostream &) const;
+ ///
+ void read(Lexer &);
+ ///
+ int latex(odocstream &, OutputParams const &) const;
+ ///
+ int docbook(odocstream & os, OutputParams const &) const;
+ ///
+ docstring xhtml(XHTMLStream & os, OutputParams const &) const;
+ ///
+ void plaintext(odocstream &,
+ OutputParams const & runparams, int const depth,
+ bool onlydata, char_type delim) const;
+ ///
+ bool isMultiColumn(idx_type cell) const;
+ ///
+ idx_type setMultiColumn(idx_type cell, idx_type number);
+ ///
+ void unsetMultiColumn(idx_type cell);
+ ///
+ bool isPartOfMultiColumn(row_type row, col_type column) const;
+ ///
+ bool isPartOfMultiRow(row_type row, col_type column) const;
+ ///
+ bool isMultiRow(idx_type cell) const;
+ ///
+ idx_type setMultiRow(idx_type cell, idx_type number);
+ ///
+ void unsetMultiRow(idx_type cell);
+ ///
+ row_type cellRow(idx_type cell) const;
+ ///
+ col_type cellColumn(idx_type cell) const;
+ ///
+ void setRotateCell(idx_type cell, bool);
+ ///
+ bool getRotateCell(idx_type cell) const;
+ ///
+ bool needRotating() const;
+ ///
+ bool isLastCell(idx_type cell) const;
+ ///
+ idx_type cellAbove(idx_type cell) const;
+ ///
+ idx_type cellBelow(idx_type cell) const;
+ ///
+ idx_type cellIndex(row_type row, col_type column) const;
+ ///
+ void setUsebox(idx_type cell, BoxType);
+ ///
+ BoxType getUsebox(idx_type cell) const;
+ //
+ // Long Tabular Options support functions
+ ///
+ bool checkLTType(row_type row, ltType const &) const;
+ ///
+ void setLTHead(row_type row, bool flag, ltType const &, bool first);
+ ///
+ bool getRowOfLTHead(row_type row, ltType &) const;
+ ///
+ bool getRowOfLTFirstHead(row_type row, ltType &) const;
+ ///
+ void setLTFoot(row_type row, bool flag, ltType const &, bool last);
+ ///
+ bool getRowOfLTFoot(row_type row, ltType &) const;
+ ///
+ bool getRowOfLTLastFoot(row_type row, ltType &) const;
+ ///
+ void setLTNewPage(row_type row, bool what);
+ ///
+ bool getLTNewPage(row_type row) const;
+ ///
+ idx_type setLTCaption(row_type row, bool what);
+ ///
+ bool ltCaption(row_type row) const;
+ ///
+ bool haveLTHead() const;
+ ///
+ bool haveLTFirstHead() const;
+ ///
+ bool haveLTFoot() const;
+ ///
+ bool haveLTLastFoot() const;
+ ///
+ bool haveLTCaption() const;
+ ///
+ // end longtable support
+ ///
+ shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
+ ///
+ shared_ptr<InsetTableCell> cellInset(row_type row,
+ col_type column) const;
+ ///
+ void setCellInset(row_type row, col_type column,
+ shared_ptr<InsetTableCell>) const;
+ /// Search for \param inset in the tabular, with the
+ ///
+ void validate(LaTeXFeatures &) const;
+//private:
+ // FIXME Now that cells have an InsetTableCell as their insets, rather
+ // than an InsetText, it'd be possible to reverse the relationship here,
+ // so that cell_vector was a vector<InsetTableCell> rather than a
+ // vector<CellData>, and an InsetTableCell had a CellData as a member,
+ // or perhaps just had its members as members.
+ ///
+ class CellData {
+ public:
+ ///
+ CellData(Buffer *);
+ ///
+ CellData(CellData const &);
+ ///
+ CellData & operator=(CellData);
+ ///
+ void swap(CellData & rhs);
+ ///
+ idx_type cellno;
+ ///
+ int width;
+ ///
+ int multicolumn;
+ ///
+ int multirow;
+ ///
+ LyXAlignment alignment;
+ ///
+ VAlignment valignment;
+ /// width of the part before the decimal
+ int decimal_hoffset;
+ /// width of the decimal part
+ int decimal_width;
+ ///
+ int voffset;
+ ///
+ bool top_line;
+ ///
+ bool bottom_line;
+ ///
+ bool left_line;
+ ///
+ bool right_line;
+ ///
+ BoxType usebox;
+ ///
+ bool rotate;
+ ///
+ docstring align_special;
+ ///
+ Length p_width; // this is only set for multicolumn!!!
+ ///
+ shared_ptr<InsetTableCell> inset;
+ };
+ CellData & cellInfo(idx_type cell) const;
+ ///
+ typedef std::vector<CellData> cell_vector;
+ ///
+ typedef std::vector<cell_vector> cell_vvector;
+
+ ///
+ class RowData {
+ public:
+ ///
+ RowData();
+ ///
+ int ascent;
+ ///
+ int descent;
+ /// Extra space between the top line and this row
+ Length top_space;
+ /// Ignore top_space if true and use the default top space
+ bool top_space_default;
+ /// Extra space between this row and the bottom line
+ Length bottom_space;
+ /// Ignore bottom_space if true and use the default bottom space
+ bool bottom_space_default;
+ /// Extra space between the bottom line and the next top line
+ Length interline_space;
+ /// Ignore interline_space if true and use the default interline space
+ bool interline_space_default;
+ /// This are for longtabulars only
+ /// a row of endhead
+ bool endhead;
+ /// a row of endfirsthead
+ bool endfirsthead;
+ /// a row of endfoot
+ bool endfoot;
+ /// row of endlastfoot
+ bool endlastfoot;
+ /// row for a newpage
+ bool newpage;
+ /// caption
+ bool caption;
+ };
+ ///
+ typedef std::vector<RowData> row_vector;
+
+ ///
+ class ColumnData {
+ public:
+ ///
+ ColumnData();
+ ///
+ LyXAlignment alignment;
+ ///
+ VAlignment valignment;
+ ///
+ int width;
+ ///
+ Length p_width;
+ ///
+ docstring align_special;
+ ///
+ docstring decimal_point;
+ };
+ ///
+ typedef std::vector<ColumnData> column_vector;
+
+ ///
+ idx_type numberofcells;
+ ///
+ std::vector<row_type> rowofcell;
+ ///
+ std::vector<col_type> columnofcell;
+ ///
+ row_vector row_info;
+ ///
+ column_vector column_info;
+ ///
+ mutable cell_vvector cell_info;
+ ///
+ bool use_booktabs;
+ ///
+ bool rotate;
+ ///
+ VAlignment tabular_valignment;
+ //
+ // for long tabulars
+ ///
+ HAlignment longtabular_alignment;
+ //
+ bool is_long_tabular;
+ /// endhead data
+ ltType endhead;
+ /// endfirsthead data
+ ltType endfirsthead;
+ /// endfoot data
+ ltType endfoot;
+ /// endlastfoot data
+ ltType endlastfoot;
+
+ ///
+ void init(Buffer *, row_type rows_arg,
+ col_type columns_arg);
+ ///
+ void updateIndexes();
+ ///
+ bool setFixedWidth(row_type r, col_type c);
+ /// return true of update is needed
+ bool updateColumnWidths();
+ ///
+ idx_type columnSpan(idx_type cell) const;
+ ///
+ idx_type rowSpan(idx_type cell) const;
+ ///
+ BoxType useParbox(idx_type cell) const;
+ ///
+ // helper function for Latex returns number of newlines
+ ///
+ int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
+ ///
+ int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
+ ///
+ int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
+ ///
+ int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
+ ///
+ int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
+ ///
+ bool isValidRow(row_type const row) const;
+ ///
+ int TeXRow(odocstream &, row_type const row,
+ OutputParams const &) const;
+ ///
+ // helper functions for plain text
+ ///
+ bool plaintextTopHLine(odocstream &, row_type row,
+ std::vector<unsigned int> const &) const;
+ ///
+ bool plaintextBottomHLine(odocstream &, row_type row,
+ std::vector<unsigned int> const &) const;
+ ///
+ void plaintextPrintCell(odocstream &,
+ OutputParams const &,
+ idx_type cell, row_type row, col_type column,
+ std::vector<unsigned int> const &,
+ bool onlydata) const;
+ /// auxiliary function for docbook
+ int docbookRow(odocstream & os, row_type, OutputParams const &) const;
+ ///
+ docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
+
+ /// change associated Buffer
+ void setBuffer(Buffer & buffer);
+ /// retrieve associated Buffer
+ Buffer & buffer() const { return *buffer_; }
+
+private:
+ Buffer * buffer_;
+
+}; // Tabular
+
+
+///
+class InsetTableCell : public InsetText
+{
+public:
+ ///
+ InsetTableCell(Buffer * buf);
+ ///
+ InsetCode lyxCode() const { return CELL_CODE; }
+ ///
+ Inset * clone() { return new InsetTableCell(*this); }
+ ///
+ bool getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & status) const;
+ ///
+ void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
+ ///
+ void setContentAlignment(LyXAlignment al) {contentAlign = al; }
+ /// writes the contents of the cell as a string, optionally
+ /// descending into insets
+ docstring asString(bool intoInsets = true);
+ ///
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
+private:
+ /// unimplemented
+ InsetTableCell();
+ /// unimplemented
+ void operator=(InsetTableCell const &);
+ // FIXME
+ // This boolean is supposed to track whether the cell has had its
+ // width explicitly set. We need to know this to determine whether
+ // layout changes and paragraph customization are allowed---that is,
+ // we need it in forcePlainLayout() and allowParagraphCustomization().
+ // Unfortunately, that information is not readily available in
+ // InsetTableCell. In the case of multicolumn cells, it is present
+ // in CellData, and so would be available here if CellData were to
+ // become a member of InsetTableCell. But in the other case, it isn't
+ // even available there, but is held in Tabular::ColumnData.
+ // So, the present solution uses this boolean to track the information
+ // we need to track, and tries to keep it updated. This is not ideal,
+ // but the other solutions are no better. These are:
+ // (i) Keep a pointer in InsetTableCell to the table;
+ // (ii) Find the table by iterating over the Buffer's insets.
+ // Solution (i) raises the problem of updating the pointer when an
+ // InsetTableCell is copied, and we'd therefore need a copy constructor
+ // in InsetTabular and then in Tabular, which seems messy, given how
+ // complicated those classes are. Solution (ii) involves a lot of
+ // iterating, since this information is needed quite often, and so may
+ // be quite slow.
+ // So, well, if someone can do better, please do!
+ // --rgh
+ ///
+ bool isFixedWidth;
+ // FIXME: Here the thoughts from the comment above also apply.
+ ///
+ LyXAlignment contentAlign;
+ /// should paragraph indendation be omitted in any case?
+ bool neverIndent() const { return true; }
+ ///
+ LyXAlignment contentAlignment() const { return contentAlign; }
+ ///
+ virtual bool usePlainLayout() const { return true; }
+ ///
+ virtual bool forcePlainLayout(idx_type = 0) const;
+ ///
+ virtual bool allowParagraphCustomization(idx_type = 0) const;
+ /// Is the width forced to some value?
+ bool hasFixedWidth() const { return isFixedWidth; }
+};
+
+
+class InsetTabular : public Inset
+{