src/insets/InsetTabular.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetTabular.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Matthias Ettrich
   9  * \author André Pönitz
  10  * \author Jürgen Vigna
  11  * \author Edwin Leuven
  12  * \author Uwe Stöhr
  13  * \author Scott Kostyshak
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 // Things to think of when designing the new tabular support:
  19 // - color support (colortbl, color)
  20 // - decimal alignment (dcloumn)
  21 // - custom lines (hhline)
  22 // - column styles
  23
  24 #ifndef INSET_TABULAR_H
  25 #define INSET_TABULAR_H
  26
  27 #include "InsetText.h"
  28 #include "Length.h"
  29
  30 #include <climits>
  31 #include <iosfwd>
  32 #include <memory>
  33 #include <vector>
  34
  35
  36 namespace lyx {
  37
  38 class Buffer;
  39 class BufferView;
  40 class CompletionList;
  41 class Cursor;
  42 class CursorSlice;
  43 class FuncStatus;
  44 class Lexer;
  45 class OutputParams;
  46 class Paragraph;
  47 class XHTMLStream;
  48
  49
  50 ///
  51 class InsetTableCell : public InsetText
  52 {
  53 public:
  54         ///
  55         InsetTableCell(Buffer * buf);
  56         ///
  57         InsetCode lyxCode() const { return CELL_CODE; }
  58         ///
  59         Inset * clone() const { return new InsetTableCell(*this); }
  60         ///
  61         bool getStatus(Cursor & cur, FuncRequest const & cmd,
  62                 FuncStatus & status) const;
  63         ///
  64         void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
  65         ///
  66         void toggleMultiCol(bool m) { isMultiColumn = m; }
  67         ///
  68         void toggleMultiRow(bool m) { isMultiRow = m; }
  69         ///
  70         void setContentAlignment(LyXAlignment al) {contentAlign = al; }
  71         /// writes the contents of the cell as a string, optionally
  72         /// descending into insets
  73         docstring asString(bool intoInsets = true);
  74         ///
  75         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  76         ///
  77         void addToToc(DocIterator const & di, bool output_active,
  78                                   UpdateType utype, TocBackend & backend) const;
  79         ///
  80         void metrics(MetricsInfo &, Dimension &) const;
  81 private:
  82         /// unimplemented
  83         InsetTableCell();
  84         /// unimplemented
  85         void operator=(InsetTableCell const &);
  86         // FIXME
  87         // These booleans are supposed to track whether the cell has had its
  88         // width explicitly set and whether it is part of a multicolumn, respectively.
  89         // We need to know this to determine whether
  90         // layout changes and paragraph customization are allowed---that is,
  91         // we need it in forcePlainLayout() and allowParagraphCustomization().
  92         // Unfortunately, that information is not readily available in
  93         // InsetTableCell. In the case of multicolumn cells, it is present
  94         // in CellData, and so would be available here if CellData were to
  95         // become a member of InsetTableCell. But in the other case, it isn't
  96         // even available there, but is held in Tabular::ColumnData.
  97         // So, the present solution uses this boolean to track the information
  98         // we need to track, and tries to keep it updated. This is not ideal,
  99         // but the other solutions are no better. These are:
 100         // (i)  Keep a pointer in InsetTableCell to the table;
 101         // (ii) Find the table by iterating over the Buffer's insets.
 102         // Solution (i) raises the problem of updating the pointer when an
 103         // InsetTableCell is copied, and we'd therefore need a copy constructor
 104         // in InsetTabular and then in Tabular, which seems messy, given how
 105         // complicated those classes are. Solution (ii) involves a lot of
 106         // iterating, since this information is needed quite often, and so may
 107         // be quite slow.
 108         // So, well, if someone can do better, please do!
 109         // --rgh
 110         ///
 111         bool isFixedWidth;
 112         ///
 113         bool isMultiColumn;
 114         ///
 115         bool isMultiRow;
 116         // FIXME: Here the thoughts from the comment above also apply.
 117         ///
 118         LyXAlignment contentAlign;
 119         /// should paragraph indendation be omitted in any case?
 120         bool neverIndent() const { return true; }
 121         ///
 122         LyXAlignment contentAlignment() const { return contentAlign; }
 123         ///
 124         virtual bool usePlainLayout() const { return true; }
 125         ///
 126         virtual bool forcePlainLayout(idx_type = 0) const;
 127         ///
 128         virtual bool allowParagraphCustomization(idx_type = 0) const;
 129         ///
 130         virtual bool forceLocalFontSwitch() const;
 131         /// Is the width forced to some value?
 132         bool hasFixedWidth() const { return isFixedWidth; }
 133         /// Can the cell contain several paragraphs?
 134         bool allowMultiPar() const { return !isMultiRow && (!isMultiColumn || isFixedWidth); }
 135 };
 136
 137
 138 //
 139 // A helper struct for tables
 140 //
 141 class Tabular {
 142 public:
 143         ///
 144         enum Feature {
 145                 ///
 146                 APPEND_ROW = 0,
 147                 ///
 148                 APPEND_COLUMN,
 149                 ///
 150                 DELETE_ROW,
 151                 ///
 152                 DELETE_COLUMN,
 153                 ///
 154                 COPY_ROW,
 155                 ///
 156                 COPY_COLUMN,
 157                 ///
 158                 MOVE_COLUMN_RIGHT,
 159                 ///
 160                 MOVE_COLUMN_LEFT,
 161                 ///
 162                 MOVE_ROW_DOWN,
 163                 ///
 164                 MOVE_ROW_UP,
 165                 ///
 166                 SET_LINE_TOP,
 167                 ///
 168                 SET_LINE_BOTTOM,
 169                 ///
 170                 SET_LINE_LEFT,
 171                 ///
 172                 SET_LINE_RIGHT,
 173                 ///FIXME: remove
 174                 TOGGLE_LINE_TOP,
 175                 ///FIXME: remove
 176                 TOGGLE_LINE_BOTTOM,
 177                 ///FIXME: remove
 178                 TOGGLE_LINE_LEFT,
 179                 ///FIXME: remove
 180                 TOGGLE_LINE_RIGHT,
 181                 ///
 182                 ALIGN_LEFT,
 183                 ///
 184                 ALIGN_RIGHT,
 185                 ///
 186                 ALIGN_CENTER,
 187                 ///
 188                 ALIGN_BLOCK,
 189                 ///
 190                 ALIGN_DECIMAL,
 191                 ///
 192                 VALIGN_TOP,
 193                 ///
 194                 VALIGN_BOTTOM,
 195                 ///
 196                 VALIGN_MIDDLE,
 197                 ///
 198                 M_ALIGN_LEFT,
 199                 ///
 200                 M_ALIGN_RIGHT,
 201                 ///
 202                 M_ALIGN_CENTER,
 203                 ///
 204                 M_VALIGN_TOP,
 205                 ///
 206                 M_VALIGN_BOTTOM,
 207                 ///
 208                 M_VALIGN_MIDDLE,
 209                 ///
 210                 MULTICOLUMN,
 211                 ///
 212                 SET_MULTICOLUMN,
 213                 ///
 214                 UNSET_MULTICOLUMN,
 215                 ///
 216                 MULTIROW,
 217                 ///
 218                 SET_MULTIROW,
 219                 ///
 220                 UNSET_MULTIROW,
 221                 ///
 222                 SET_MROFFSET,
 223                 ///
 224                 SET_ALL_LINES,
 225                 ///
 226                 UNSET_ALL_LINES,
 227                 ///
 228                 TOGGLE_LONGTABULAR,
 229                 ///
 230                 SET_LONGTABULAR,
 231                 ///
 232                 UNSET_LONGTABULAR,
 233                 ///
 234                 SET_PWIDTH,
 235                 ///
 236                 SET_MPWIDTH,
 237                 ///
 238                 TOGGLE_VARWIDTH_COLUMN,
 239                 ///
 240                 SET_ROTATE_TABULAR,
 241                 ///
 242                 UNSET_ROTATE_TABULAR,
 243                 ///
 244                 TOGGLE_ROTATE_TABULAR,
 245                 ///
 246                 SET_ROTATE_CELL,
 247                 ///
 248                 UNSET_ROTATE_CELL,
 249                 ///
 250                 TOGGLE_ROTATE_CELL,
 251                 ///
 252                 SET_USEBOX,
 253                 ///
 254                 SET_LTHEAD,
 255                 UNSET_LTHEAD,
 256                 ///
 257                 SET_LTFIRSTHEAD,
 258                 UNSET_LTFIRSTHEAD,
 259                 ///
 260                 SET_LTFOOT,
 261                 UNSET_LTFOOT,
 262                 ///
 263                 SET_LTLASTFOOT,
 264                 UNSET_LTLASTFOOT,
 265                 ///
 266                 SET_LTNEWPAGE,
 267                 UNSET_LTNEWPAGE,
 268                 ///
 269                 TOGGLE_LTCAPTION,
 270                 ///
 271                 SET_LTCAPTION,
 272                 ///
 273                 UNSET_LTCAPTION,
 274                 ///
 275                 SET_SPECIAL_COLUMN,
 276                 ///
 277                 SET_SPECIAL_MULTICOLUMN,
 278                 ///
 279                 TOGGLE_BOOKTABS,
 280                 ///
 281                 SET_BOOKTABS,
 282                 ///
 283                 UNSET_BOOKTABS,
 284                 ///
 285                 SET_TOP_SPACE,
 286                 ///
 287                 SET_BOTTOM_SPACE,
 288                 ///
 289                 SET_INTERLINE_SPACE,
 290                 ///
 291                 SET_BORDER_LINES,
 292                 ///
 293                 TABULAR_VALIGN_TOP,
 294                 ///
 295                 TABULAR_VALIGN_MIDDLE,
 296                 ///
 297                 TABULAR_VALIGN_BOTTOM,
 298                 ///
 299                 LONGTABULAR_ALIGN_LEFT,
 300                 ///
 301                 LONGTABULAR_ALIGN_CENTER,
 302                 ///
 303                 LONGTABULAR_ALIGN_RIGHT,
 304                 ///
 305                 SET_DECIMAL_POINT,
 306                 ///
 307                 SET_TABULAR_WIDTH,
 308                 ///
 309                 SET_INNER_LINES,
 310                 ///
 311                 LAST_ACTION
 312         };
 313         ///
 314         enum {
 315                 ///
 316                 CELL_NORMAL = 0,
 317                 ///
 318                 CELL_BEGIN_OF_MULTICOLUMN,
 319                 ///
 320                 CELL_PART_OF_MULTICOLUMN,
 321                 ///
 322                 CELL_BEGIN_OF_MULTIROW,
 323                 ///
 324                 CELL_PART_OF_MULTIROW
 325         };
 326
 327         ///
 328         enum VAlignment {
 329                 ///
 330                 LYX_VALIGN_TOP = 0,
 331                 ///
 332                 LYX_VALIGN_MIDDLE = 1,
 333                 ///
 334                 LYX_VALIGN_BOTTOM = 2
 335
 336         };
 337         ///
 338         enum HAlignment {
 339                 ///
 340                 LYX_LONGTABULAR_ALIGN_LEFT = 0,
 341                 ///
 342                 LYX_LONGTABULAR_ALIGN_CENTER = 1,
 343                 ///
 344                 LYX_LONGTABULAR_ALIGN_RIGHT = 2
 345         };
 346
 347         enum BoxType {
 348                 ///
 349                 BOX_NONE = 0,
 350                 ///
 351                 BOX_PARBOX = 1,
 352                 ///
 353                 BOX_MINIPAGE = 2,
 354                 ///
 355                 BOX_VARWIDTH = 3
 356         };
 357
 358         enum CaptionType {
 359                 ///
 360                 CAPTION_FIRSTHEAD,
 361                 ///
 362                 CAPTION_HEAD,
 363                 ///
 364                 CAPTION_FOOT,
 365                 ///
 366                 CAPTION_LASTFOOT,
 367                 ///
 368                 CAPTION_ANY
 369         };
 370
 371         enum RowDirection {
 372                 UP,
 373                 DOWN
 374         };
 375
 376         enum ColDirection {
 377                 RIGHT,
 378                 LEFT
 379         };
 380
 381         class ltType {
 382         public:
 383                 // constructor
 384                 ltType();
 385                 // we have this header type (is set in the getLT... functions)
 386                 bool set;
 387                 // double borders on top
 388                 bool topDL;
 389                 // double borders on bottom
 390                 bool bottomDL;
 391                 // used for FirstHeader & LastFooter and if this is true
 392                 // all the rows marked as FirstHeader or LastFooter are
 393                 // ignored in the output and it is set to be empty!
 394                 bool empty;
 395         };
 396
 397         /// type for row numbers
 398         typedef size_t row_type;
 399         /// type for column numbers
 400         typedef size_t col_type;
 401         /// type for cell indices
 402         typedef size_t idx_type;
 403         /// index indicating an invalid position
 404         static const idx_type npos = static_cast<idx_type>(-1);
 405
 406         /// constructor
 407         Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
 408
 409         /// Returns true if there is a topline, returns false if not
 410         bool topLine(idx_type cell) const;
 411         /// Returns true if there is a topline, returns false if not
 412         bool bottomLine(idx_type cell) const;
 413         /// Returns true if there is a topline, returns false if not
 414         bool leftLine(idx_type cell) const;
 415         /// Returns true if there is a topline, returns false if not
 416         bool rightLine(idx_type cell) const;
 417
 418         /// return space occupied by the second horizontal line and
 419         /// interline space above row \p row in pixels
 420         int interRowSpace(row_type row) const;
 421         ///
 422         int interColumnSpace(idx_type cell) const;
 423
 424         /* returns the maximum over all rows */
 425         ///
 426         int cellWidth(idx_type cell) const;
 427         ///
 428         int cellHeight(idx_type cell) const;
 429         ///
 430         int width() const;
 431         ///
 432         int height() const;
 433         ///
 434         row_type nrows() const {return row_info.size();}
 435         ///
 436         col_type ncols() const {return column_info.size();}
 437         ///
 438         int rowAscent(row_type row) const;
 439         ///
 440         int rowDescent(row_type row) const;
 441         ///
 442         void setRowAscent(row_type row, int height);
 443         ///
 444         void setRowDescent(row_type row, int height);
 445         ///
 446         void setTopLine(idx_type cell, bool line);
 447         ///
 448         void setBottomLine(idx_type cell, bool line);
 449         ///
 450         void setLeftLine(idx_type cell, bool line);
 451         ///
 452         void setRightLine(idx_type cell, bool line);
 453         ///
 454         bool rowTopLine(row_type row) const;
 455         ///
 456         bool rowBottomLine(row_type row) const;
 457         ///
 458         bool columnLeftLine(col_type column) const;
 459         ///
 460         bool columnRightLine(col_type column) const;
 461
 462         void setAlignment(idx_type cell, LyXAlignment align,
 463                           bool onlycolumn = false);
 464         ///
 465         void setVAlignment(idx_type cell, VAlignment align,
 466                            bool onlycolumn = false);
 467         ///
 468         void setTabularWidth(Length const & l) { tabular_width = l; }
 469         ///
 470         Length tabularWidth() const { return tabular_width; }
 471         ///
 472         void setColumnPWidth(Cursor &, idx_type, Length const &);
 473         ///
 474         bool setMColumnPWidth(Cursor &, idx_type, Length const &);
 475         ///
 476         bool toggleVarwidth(idx_type, bool const);
 477         ///
 478         bool setMROffset(Cursor &, idx_type, Length const &);
 479         ///
 480         void setAlignSpecial(idx_type cell, docstring const & special,
 481                              Feature what);
 482         ///
 483         LyXAlignment getAlignment(idx_type cell,
 484                                   bool onlycolumn = false) const;
 485         ///
 486         VAlignment getVAlignment(idx_type cell,
 487                                  bool onlycolumn = false) const;
 488         /// The vertical offset of the table due to the vertical
 489         /// alignment with respect to the baseline.
 490         int offsetVAlignment() const;
 491         ///
 492         Length const getPWidth(idx_type cell) const;
 493         ///
 494         Length const getMROffset(idx_type cell) const;
 495         ///
 496         int textHOffset(idx_type cell) const;
 497         ///
 498         int textVOffset(idx_type cell) const;
 499         ///
 500         void appendRow(row_type row);
 501         ///
 502         void deleteRow(row_type row);
 503         ///
 504         void copyRow(row_type row);
 505         ///
 506         void insertRow(row_type row, bool copy);
 507         ///
 508         void moveColumn(col_type col, ColDirection direction);
 509         ///
 510         void moveRow(row_type row, RowDirection direction);
 511         ///
 512         void appendColumn(col_type column);
 513         ///
 514         void deleteColumn(col_type column);
 515         ///
 516         void copyColumn(col_type column);
 517         ///
 518         void insertColumn(col_type column, bool copy);
 519         ///
 520         idx_type getFirstCellInRow(row_type row) const;
 521         ///
 522         idx_type getLastCellInRow(row_type row) const;
 523         ///
 524         idx_type numberOfCellsInRow(row_type row) const;
 525         ///
 526         void write(std::ostream &) const;
 527         ///
 528         void read(Lexer &);
 529         ///
 530         void latex(otexstream &, OutputParams const &) const;
 531         ///
 532         int docbook(odocstream & os, OutputParams const &) const;
 533         ///
 534         docstring xhtml(XHTMLStream & os, OutputParams const &) const;
 535         ///
 536         void plaintext(odocstringstream &,
 537                        OutputParams const & runparams, int const depth,
 538                        bool onlydata, char_type delim, size_t max_length = INT_MAX) const;
 539         ///
 540         bool isMultiColumn(idx_type cell) const;
 541         ///
 542         bool hasMultiColumn(col_type cell) const;
 543         ///
 544         bool hasVarwidthColumn() const;
 545         ///
 546         bool isVTypeColumn(col_type cell) const;
 547         ///
 548         idx_type setMultiColumn(Cursor & cur, idx_type cell, idx_type number,
 549                              bool const right_border);
 550         ///
 551         void unsetMultiColumn(idx_type cell);
 552         ///
 553         bool isPartOfMultiColumn(row_type row, col_type column) const;
 554         ///
 555         bool isPartOfMultiRow(row_type row, col_type column) const;
 556         ///
 557         bool isMultiRow(idx_type cell) const;
 558         ///
 559         bool hasMultiRow(row_type r) const;
 560         ///
 561         idx_type setMultiRow(Cursor & cur, idx_type cell, idx_type number,
 562                              bool const bottom_border,
 563                              LyXAlignment const halign);
 564         ///
 565         void unsetMultiRow(idx_type cell);
 566         ///
 567         row_type cellRow(idx_type cell) const;
 568         ///
 569         col_type cellColumn(idx_type cell) const;
 570         ///
 571         void setRotateCell(idx_type cell, int);
 572         ///
 573         int getRotateCell(idx_type cell) const;
 574         ///
 575         bool needRotating() const;
 576         ///
 577         bool isLastCell(idx_type cell) const;
 578         ///
 579         idx_type cellAbove(idx_type cell) const;
 580         ///
 581         idx_type cellBelow(idx_type cell) const;
 582         /// \return the index of the VISIBLE cell at row, column
 583         /// this will be the same as the cell in the previous row,
 584         /// e.g., if the cell is part of a multirow
 585         idx_type cellIndex(row_type row, col_type column) const;
 586         ///
 587         void setUsebox(idx_type cell, BoxType);
 588         ///
 589         BoxType getUsebox(idx_type cell) const;
 590         //
 591         // Long Tabular Options support functions
 592         ///
 593         void setLTHead(row_type row, bool flag, ltType const &, bool first);
 594         ///
 595         bool getRowOfLTHead(row_type row, ltType &) const;
 596         ///
 597         bool getRowOfLTFirstHead(row_type row, ltType &) const;
 598         ///
 599         void setLTFoot(row_type row, bool flag, ltType const &, bool last);
 600         ///
 601         bool getRowOfLTFoot(row_type row, ltType &) const;
 602         ///
 603         bool getRowOfLTLastFoot(row_type row, ltType &) const;
 604         ///
 605         void setLTNewPage(row_type row, bool what);
 606         ///
 607         bool getLTNewPage(row_type row) const;
 608         ///
 609         idx_type setLTCaption(Cursor & cur, row_type row, bool what);
 610         ///
 611         bool ltCaption(row_type row) const;
 612         ///
 613         bool haveLTHead(bool withcaptions = true) const;
 614         ///
 615         bool haveLTFirstHead(bool withcaptions = true) const;
 616         ///
 617         bool haveLTFoot(bool withcaptions = true) const;
 618         ///
 619         bool haveLTLastFoot(bool withcaptions = true) const;
 620         ///
 621         bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
 622         ///
 623         // end longtable support
 624
 625         //@{
 626         /// there is a subtle difference between these two methods.
 627         ///   cellInset(r,c);
 628         /// and
 629         ///   cellInset(cellIndex(r,c));
 630         /// can return different things. this is because cellIndex(r,c)
 631         /// returns the VISIBLE cell at r,c, which may be the same as the
 632         /// cell at the previous row or column, if we're dealing with some
 633         /// multirow or multicell.
 634         std::shared_ptr<InsetTableCell> cellInset(idx_type cell);
 635         std::shared_ptr<InsetTableCell> cellInset(row_type row, col_type column);
 636         InsetTableCell const * cellInset(idx_type cell) const;
 637         //@}
 638         ///
 639         void setCellInset(row_type row, col_type column,
 640                           std::shared_ptr<InsetTableCell>);
 641         /// Search for \param inset in the tabular, with the
 642         ///
 643         void validate(LaTeXFeatures &) const;
 644
 645         //private:
 646         // FIXME Now that cells have an InsetTableCell as their insets, rather
 647         // than an InsetText, it'd be possible to reverse the relationship here,
 648         // so that cell_vector was a vector<InsetTableCell> rather than a
 649         // vector<CellData>, and an InsetTableCell had a CellData as a member,
 650         // or perhaps just had its members as members.
 651         ///
 652         class CellData {
 653         public:
 654                 ///
 655                 CellData(Buffer *);
 656                 ///
 657                 CellData(CellData const &);
 658                 ///
 659                 CellData & operator=(CellData const &);
 660                 ///
 661                 idx_type cellno;
 662                 ///
 663                 int width;
 664                 ///
 665                 int multicolumn;
 666                 ///
 667                 int multirow;
 668                 ///
 669                 Length mroffset;
 670                 ///
 671                 LyXAlignment alignment;
 672                 ///
 673                 VAlignment valignment;
 674                 /// width of the part before the decimal
 675                 int decimal_hoffset;
 676                 /// width of the decimal part
 677                 int decimal_width;
 678                 ///
 679                 int voffset;
 680                 ///
 681                 bool top_line;
 682                 ///
 683                 bool bottom_line;
 684                 ///
 685                 bool left_line;
 686                 ///
 687                 bool right_line;
 688                 ///
 689                 BoxType usebox;
 690                 ///
 691                 int rotate;
 692                 ///
 693                 docstring align_special;
 694                 ///
 695                 Length p_width; // this is only set for multicolumn!!!
 696                 ///
 697                 std::shared_ptr<InsetTableCell> inset;
 698         };
 699         ///
 700         CellData const & cellInfo(idx_type cell) const;
 701         ///
 702         CellData & cellInfo(idx_type cell);
 703         ///
 704         typedef std::vector<CellData> cell_vector;
 705         ///
 706         typedef std::vector<cell_vector> cell_vvector;
 707
 708         ///
 709         class RowData {
 710         public:
 711                 ///
 712                 RowData();
 713                 ///
 714                 int ascent;
 715                 ///
 716                 int descent;
 717                 /// Extra space between the top line and this row
 718                 Length top_space;
 719                 /// Ignore top_space if true and use the default top space
 720                 bool top_space_default;
 721                 /// Extra space between this row and the bottom line
 722                 Length bottom_space;
 723                 /// Ignore bottom_space if true and use the default bottom space
 724                 bool bottom_space_default;
 725                 /// Extra space between the bottom line and the next top line
 726                 Length interline_space;
 727                 /// Ignore interline_space if true and use the default interline space
 728                 bool interline_space_default;
 729                 /// This are for longtabulars only
 730                 /// a row of endhead
 731                 bool endhead;
 732                 /// a row of endfirsthead
 733                 bool endfirsthead;
 734                 /// a row of endfoot
 735                 bool endfoot;
 736                 /// row of endlastfoot
 737                 bool endlastfoot;
 738                 /// row for a newpage
 739                 bool newpage;
 740                 /// caption
 741                 bool caption;
 742         };
 743         ///
 744         typedef std::vector<RowData> row_vector;
 745
 746         ///
 747         class ColumnData {
 748                 public:
 749                 ///
 750                 ColumnData();
 751                 ///
 752                 LyXAlignment alignment;
 753                 ///
 754                 VAlignment valignment;
 755                 ///
 756                 int width;
 757                 ///
 758                 Length p_width;
 759                 ///
 760                 docstring align_special;
 761                 ///
 762                 docstring decimal_point;
 763                 ///
 764                 bool varwidth;
 765         };
 766         ///
 767         typedef std::vector<ColumnData> column_vector;
 768
 769         ///
 770         idx_type numberofcells;
 771         ///
 772         std::vector<row_type> rowofcell;
 773         ///
 774         std::vector<col_type> columnofcell;
 775         ///
 776         row_vector row_info;
 777         ///
 778         column_vector column_info;
 779         ///
 780         cell_vvector cell_info;
 781         ///
 782         Length tabular_width;
 783         ///
 784         bool use_booktabs;
 785         ///
 786         int rotate;
 787         ///
 788         VAlignment tabular_valignment;
 789         //
 790         // for long tabulars
 791         ///
 792         HAlignment longtabular_alignment;
 793         //
 794         bool is_long_tabular;
 795         /// endhead data
 796         ltType endhead;
 797         /// endfirsthead data
 798         ltType endfirsthead;
 799         /// endfoot data
 800         ltType endfoot;
 801         /// endlastfoot data
 802         ltType endlastfoot;
 803
 804         ///
 805         void init(Buffer *, row_type rows_arg,
 806                   col_type columns_arg);
 807         ///
 808         void updateIndexes();
 809         ///
 810         bool setFixedWidth(row_type r, col_type c);
 811         /// return true of update is needed
 812         bool updateColumnWidths(MetricsInfo & mi);
 813         ///
 814         idx_type columnSpan(idx_type cell) const;
 815         ///
 816         idx_type rowSpan(idx_type cell) const;
 817         ///
 818         BoxType useBox(idx_type cell) const;
 819         ///
 820         // helper function for Latex
 821         ///
 822         void TeXTopHLine(otexstream &, row_type row, std::string const & lang,
 823                          std::list<col_type>) const;
 824         ///
 825         void TeXBottomHLine(otexstream &, row_type row, std::string const & lang,
 826                             std::list<col_type>) const;
 827         ///
 828         void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow,
 829                              bool const bidi) const;
 830         ///
 831         void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
 832         ///
 833         void TeXLongtableHeaderFooter(otexstream &, OutputParams const &, std::list<col_type>) const;
 834         ///
 835         bool isValidRow(row_type const row) const;
 836         ///
 837         void TeXRow(otexstream &, row_type const row,
 838                     OutputParams const &, std::list<col_type>) const;
 839         ///
 840         // helper functions for plain text
 841         ///
 842         bool plaintextTopHLine(odocstringstream &, row_type row,
 843                                std::vector<unsigned int> const &) const;
 844         ///
 845         bool plaintextBottomHLine(odocstringstream &, row_type row,
 846                                   std::vector<unsigned int> const &) const;
 847         ///
 848         void plaintextPrintCell(odocstringstream &,
 849                                 OutputParams const &,
 850                                 idx_type cell, row_type row, col_type column,
 851                                 std::vector<unsigned int> const &,
 852                                 bool onlydata, size_t max_length) const;
 853         /// auxiliary function for docbook
 854         int docbookRow(odocstream & os, row_type, OutputParams const &) const;
 855         ///
 856         docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
 857                            bool header = false) const;
 858
 859         /// change associated Buffer
 860         void setBuffer(Buffer & buffer);
 861         /// retrieve associated Buffer
 862         Buffer const & buffer() const { return *buffer_; }
 863         /// retrieve associated Buffer
 864         Buffer & buffer() { return *buffer_; }
 865
 866 private:
 867         Buffer * buffer_;
 868
 869 }; // Tabular
 870
 871
 872 class InsetTabular : public Inset
 873 {
 874 public:
 875         ///
 876         InsetTabular(Buffer *, row_type rows = 1,
 877                      col_type columns = 1);
 878         ///
 879         ~InsetTabular();
 880         ///
 881         void setBuffer(Buffer & buffer);
 882
 883         ///
 884         static void string2params(std::string const &, InsetTabular &);
 885         ///
 886         static std::string params2string(InsetTabular const &);
 887         ///
 888         void read(Lexer &);
 889         ///
 890         void write(std::ostream &) const;
 891         ///
 892         void metrics(MetricsInfo &, Dimension &) const;
 893         ///
 894         void draw(PainterInfo & pi, int x, int y) const;
 895         ///
 896         void drawSelection(PainterInfo & pi, int x, int y) const;
 897         ///
 898         void drawBackground(PainterInfo & pi, int x, int y) const;
 899         ///
 900         bool editable() const { return true; }
 901         ///
 902         bool hasSettings() const { return true; }
 903         ///
 904         bool insetAllowed(InsetCode code) const;
 905         ///
 906         bool allowSpellCheck() const { return true; }
 907         ///
 908         bool canTrackChanges() const { return true; }
 909         ///
 910         bool canPaintChange(BufferView const &) const { return true; }
 911         /** returns false if, when outputing LaTeX, font changes should
 912             be closed before generating this inset. This is needed for
 913             insets that may contain several paragraphs */
 914         bool inheritFont() const { return false; }
 915         ///
 916         bool allowsCaptionVariation(std::string const &) const;
 917         //
 918         bool isTable() const { return true; }
 919         ///
 920         DisplayType display() const;
 921         ///
 922         void latex(otexstream &, OutputParams const &) const;
 923         ///
 924         int plaintext(odocstringstream & ods, OutputParams const & op,
 925                       size_t max_length = INT_MAX) const;
 926         ///
 927         int docbook(odocstream &, OutputParams const &) const;
 928         ///
 929         docstring xhtml(XHTMLStream &, OutputParams const &) const;
 930         ///
 931         void validate(LaTeXFeatures & features) const;
 932         ///
 933         InsetCode lyxCode() const { return TABULAR_CODE; }
 934         ///
 935         std::string contextMenu(BufferView const &, int, int) const;
 936         ///
 937         std::string contextMenuName() const;
 938         /// get offset of this cursor slice relative to our upper left corner
 939         void cursorPos(BufferView const & bv, CursorSlice const & sl,
 940                 bool boundary, int & x, int & y) const;
 941         /// Executes a space-separated sequence of tabular-features requests
 942         void tabularFeatures(Cursor & cur, std::string const & what);
 943         /// Change a single tabular feature; does not handle undo.
 944         void tabularFeatures(Cursor & cur, Tabular::Feature feature,
 945                              std::string const & val = std::string());
 946         /// number of cells
 947         size_t nargs() const { return tabular.numberofcells; }
 948         ///
 949         std::shared_ptr<InsetTableCell const> cell(idx_type) const;
 950         ///
 951         std::shared_ptr<InsetTableCell> cell(idx_type);
 952         ///
 953         Text * getText(int) const;
 954
 955         /// set the change for the entire inset
 956         void setChange(Change const & change);
 957         /// accept the changes within the inset
 958         void acceptChanges();
 959         /// reject the changes within the inset
 960         void rejectChanges();
 961
 962         // this should return true if we have a "normal" cell, otherwise false.
 963         // "normal" means without width set!
 964         /// should all paragraphs be output with "Standard" layout?
 965         virtual bool allowParagraphCustomization(idx_type cell = 0) const;
 966         ///
 967         virtual bool forcePlainLayout(idx_type cell = 0) const;
 968         ///
 969         void addPreview(DocIterator const & inset_pos,
 970                 graphics::PreviewLoader &) const;
 971
 972         /// lock cell with given index
 973         void edit(Cursor & cur, bool front, EntryDirection entry_from);
 974         /// get table row from x coordinate
 975         int rowFromY(Cursor & cur, int y) const;
 976         /// get table column from y coordinate
 977         int columnFromX(Cursor & cur, int x) const;
 978         ///
 979         Inset * editXY(Cursor & cur, int x, int y);
 980         /// can we go further down on mouse click?
 981         bool descendable(BufferView const &) const { return true; }
 982         /// Update the counters of this inset and of its contents
 983         void updateBuffer(ParIterator const &, UpdateType);
 984         ///
 985         void addToToc(DocIterator const & di, bool output_active,
 986                                   UpdateType utype, TocBackend & backend) const;
 987
 988         ///
 989         bool completionSupported(Cursor const &) const;
 990         ///
 991         bool inlineCompletionSupported(Cursor const & cur) const;
 992         ///
 993         bool automaticInlineCompletion() const;
 994         ///
 995         bool automaticPopupCompletion() const;
 996         ///
 997         bool showCompletionCursor() const;
 998         ///
 999         CompletionList const * createCompletionList(Cursor const & cur) const;
1000         ///
1001         docstring completionPrefix(Cursor const & cur) const;
1002         ///
1003         bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
1004         ///
1005         void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
1006         ///
1007         virtual bool usePlainLayout() const { return true; }
1008         ///
1009         docstring layoutName() const { return from_ascii("Tabular"); }
1010
1011
1012         ///
1013         InsetTabular * asInsetTabular() { return this; }
1014         ///
1015         InsetTabular const * asInsetTabular() const { return this; }
1016         ///
1017         bool isRightToLeft(Cursor & cur) const;
1018         /// writes the cells between stidx and enidx as a string, optionally
1019         /// descending into the insets
1020         docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
1021
1022         /// Returns whether the cell in the specified row and column is selected.
1023         bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
1024         ///
1025         void setLayoutForHiddenCells(DocumentClass const & dc);
1026         //
1027         // Public structures and variables
1028         ///
1029         mutable Tabular tabular;
1030
1031 private:
1032         ///
1033         InsetTabular(InsetTabular const &);
1034         ///
1035         void doDispatch(Cursor & cur, FuncRequest & cmd);
1036         ///
1037         bool getFeatureStatus(Cursor & cur, std::string const & s,
1038                          std::string const & argument, FuncStatus & status) const;
1039         ///
1040         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
1041         ///
1042         Inset * clone() const { return new InsetTabular(*this); }
1043
1044         ///
1045         bool hitSelectRow(BufferView const & bv, int x) const;
1046         ///
1047         bool hitSelectColumn(BufferView const & bv, int y) const;
1048         /// Returns true if coordinates are on row/column selection zones
1049         bool clickable(BufferView const &, int x, int y) const;
1050
1051         ///
1052         void drawCellLines(PainterInfo &, int x, int y, row_type row,
1053                            idx_type cell) const;
1054         ///
1055         void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
1056
1057         ///
1058         void moveNextCell(Cursor & cur,
1059                                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1060         ///
1061         void movePrevCell(Cursor & cur,
1062                                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1063         ///
1064         int cellXPos(idx_type cell) const;
1065         ///
1066         int cellYPos(idx_type cell) const;
1067         ///
1068         bool copySelection(Cursor & cur);
1069         ///
1070         bool pasteClipboard(Cursor & cur);
1071         ///
1072         void cutSelection(Cursor & cur);
1073         ///
1074         void getSelection(Cursor & cur, row_type & rs, row_type & re,
1075                           col_type & cs, col_type & ce) const;
1076         ///
1077         bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
1078
1079         /// return the "Manhattan distance" to nearest corner
1080         int dist(BufferView &, idx_type cell, int x, int y) const;
1081         /// return the cell nearest to x, y
1082         idx_type getNearestCell(BufferView &, int x, int y) const;
1083
1084         /// test the rotation state of the given cell range.
1085         bool oneCellHasRotationState(bool rotated,
1086                                 row_type row_start, row_type row_end,
1087                                 col_type col_start, col_type col_end) const;
1088
1089         /// true when selecting rows with the mouse
1090         bool rowselect_;
1091         /// true when selecting columns with the mouse
1092         bool colselect_;
1093 };
1094
1095 std::string const featureAsString(Tabular::Feature feature);
1096
1097 /// Split cell on decimal symbol
1098 InsetTableCell splitCell(InsetTableCell & head, docstring const & decimal_sym, bool & hassep);
1099
1100 } // namespace lyx
1101
1102 #endif // INSET_TABULAR_H