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                 RESET_FORMAL_DEFAULT,
 227                 ///
 228                 UNSET_ALL_LINES,
 229                 ///
 230                 TOGGLE_LONGTABULAR,
 231                 ///
 232                 SET_LONGTABULAR,
 233                 ///
 234                 UNSET_LONGTABULAR,
 235                 ///
 236                 SET_PWIDTH,
 237                 ///
 238                 SET_MPWIDTH,
 239                 ///
 240                 TOGGLE_VARWIDTH_COLUMN,
 241                 ///
 242                 SET_ROTATE_TABULAR,
 243                 ///
 244                 UNSET_ROTATE_TABULAR,
 245                 ///
 246                 TOGGLE_ROTATE_TABULAR,
 247                 ///
 248                 SET_ROTATE_CELL,
 249                 ///
 250                 UNSET_ROTATE_CELL,
 251                 ///
 252                 TOGGLE_ROTATE_CELL,
 253                 ///
 254                 SET_USEBOX,
 255                 ///
 256                 SET_LTHEAD,
 257                 UNSET_LTHEAD,
 258                 ///
 259                 SET_LTFIRSTHEAD,
 260                 UNSET_LTFIRSTHEAD,
 261                 ///
 262                 SET_LTFOOT,
 263                 UNSET_LTFOOT,
 264                 ///
 265                 SET_LTLASTFOOT,
 266                 UNSET_LTLASTFOOT,
 267                 ///
 268                 SET_LTNEWPAGE,
 269                 UNSET_LTNEWPAGE,
 270                 ///
 271                 TOGGLE_LTCAPTION,
 272                 ///
 273                 SET_LTCAPTION,
 274                 ///
 275                 UNSET_LTCAPTION,
 276                 ///
 277                 SET_SPECIAL_COLUMN,
 278                 ///
 279                 SET_SPECIAL_MULTICOLUMN,
 280                 ///
 281                 TOGGLE_BOOKTABS,
 282                 ///
 283                 SET_BOOKTABS,
 284                 ///
 285                 UNSET_BOOKTABS,
 286                 ///
 287                 SET_TOP_SPACE,
 288                 ///
 289                 SET_BOTTOM_SPACE,
 290                 ///
 291                 SET_INTERLINE_SPACE,
 292                 ///
 293                 SET_BORDER_LINES,
 294                 ///
 295                 TABULAR_VALIGN_TOP,
 296                 ///
 297                 TABULAR_VALIGN_MIDDLE,
 298                 ///
 299                 TABULAR_VALIGN_BOTTOM,
 300                 ///
 301                 LONGTABULAR_ALIGN_LEFT,
 302                 ///
 303                 LONGTABULAR_ALIGN_CENTER,
 304                 ///
 305                 LONGTABULAR_ALIGN_RIGHT,
 306                 ///
 307                 SET_DECIMAL_POINT,
 308                 ///
 309                 SET_TABULAR_WIDTH,
 310                 ///
 311                 SET_INNER_LINES,
 312                 ///
 313                 LAST_ACTION
 314         };
 315         ///
 316         enum {
 317                 ///
 318                 CELL_NORMAL = 0,
 319                 ///
 320                 CELL_BEGIN_OF_MULTICOLUMN,
 321                 ///
 322                 CELL_PART_OF_MULTICOLUMN,
 323                 ///
 324                 CELL_BEGIN_OF_MULTIROW,
 325                 ///
 326                 CELL_PART_OF_MULTIROW
 327         };
 328
 329         ///
 330         enum VAlignment {
 331                 ///
 332                 LYX_VALIGN_TOP = 0,
 333                 ///
 334                 LYX_VALIGN_MIDDLE = 1,
 335                 ///
 336                 LYX_VALIGN_BOTTOM = 2
 337
 338         };
 339         ///
 340         enum HAlignment {
 341                 ///
 342                 LYX_LONGTABULAR_ALIGN_LEFT = 0,
 343                 ///
 344                 LYX_LONGTABULAR_ALIGN_CENTER = 1,
 345                 ///
 346                 LYX_LONGTABULAR_ALIGN_RIGHT = 2
 347         };
 348
 349         enum BoxType {
 350                 ///
 351                 BOX_NONE = 0,
 352                 ///
 353                 BOX_PARBOX = 1,
 354                 ///
 355                 BOX_MINIPAGE = 2,
 356                 ///
 357                 BOX_VARWIDTH = 3
 358         };
 359
 360         enum CaptionType {
 361                 ///
 362                 CAPTION_FIRSTHEAD,
 363                 ///
 364                 CAPTION_HEAD,
 365                 ///
 366                 CAPTION_FOOT,
 367                 ///
 368                 CAPTION_LASTFOOT,
 369                 ///
 370                 CAPTION_ANY
 371         };
 372
 373         enum RowDirection {
 374                 UP,
 375                 DOWN
 376         };
 377
 378         enum ColDirection {
 379                 RIGHT,
 380                 LEFT
 381         };
 382
 383         class ltType {
 384         public:
 385                 // constructor
 386                 ltType();
 387                 // we have this header type (is set in the getLT... functions)
 388                 bool set;
 389                 // double borders on top
 390                 bool topDL;
 391                 // double borders on bottom
 392                 bool bottomDL;
 393                 // used for FirstHeader & LastFooter and if this is true
 394                 // all the rows marked as FirstHeader or LastFooter are
 395                 // ignored in the output and it is set to be empty!
 396                 bool empty;
 397         };
 398
 399         /// type for row numbers
 400         typedef size_t row_type;
 401         /// type for column numbers
 402         typedef size_t col_type;
 403         /// type for cell indices
 404         typedef size_t idx_type;
 405         /// index indicating an invalid position
 406         static const idx_type npos = static_cast<idx_type>(-1);
 407
 408         /// constructor
 409         Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
 410
 411         /// Returns true if there is a topline, returns false if not
 412         bool topLine(idx_type cell) const;
 413         /// Returns true if there is a topline, returns false if not
 414         bool bottomLine(idx_type cell) const;
 415         /// Returns true if there is a topline, returns false if not
 416         bool leftLine(idx_type cell) const;
 417         /// Returns true if there is a topline, returns false if not
 418         bool rightLine(idx_type cell) const;
 419
 420         /// return space occupied by the second horizontal line and
 421         /// interline space above row \p row in pixels
 422         int interRowSpace(row_type row) const;
 423         ///
 424         int interColumnSpace(idx_type cell) const;
 425
 426         /* returns the maximum over all rows */
 427         ///
 428         int cellWidth(idx_type cell) const;
 429         ///
 430         int cellHeight(idx_type cell) const;
 431         ///
 432         int width() const;
 433         ///
 434         int height() const;
 435         ///
 436         row_type nrows() const {return row_info.size();}
 437         ///
 438         col_type ncols() const {return column_info.size();}
 439         ///
 440         int rowAscent(row_type row) const;
 441         ///
 442         int rowDescent(row_type row) const;
 443         ///
 444         void setRowAscent(row_type row, int height);
 445         ///
 446         void setRowDescent(row_type row, int height);
 447         ///
 448         void setTopLine(idx_type cell, bool line);
 449         ///
 450         void setBottomLine(idx_type cell, bool line);
 451         ///
 452         void setLeftLine(idx_type cell, bool line);
 453         ///
 454         void setRightLine(idx_type cell, bool line);
 455         ///
 456         bool rowTopLine(row_type row) const;
 457         ///
 458         bool rowBottomLine(row_type row) const;
 459         ///
 460         bool columnLeftLine(col_type column) const;
 461         ///
 462         bool columnRightLine(col_type column) const;
 463
 464         void setAlignment(idx_type cell, LyXAlignment align,
 465                           bool onlycolumn = false);
 466         ///
 467         void setVAlignment(idx_type cell, VAlignment align,
 468                            bool onlycolumn = false);
 469         ///
 470         void setTabularWidth(Length const & l) { tabular_width = l; }
 471         ///
 472         Length tabularWidth() const { return tabular_width; }
 473         ///
 474         void setColumnPWidth(Cursor &, idx_type, Length const &);
 475         ///
 476         bool setMColumnPWidth(Cursor &, idx_type, Length const &);
 477         ///
 478         bool toggleVarwidth(idx_type, bool const);
 479         ///
 480         bool setMROffset(Cursor &, idx_type, Length const &);
 481         ///
 482         void setAlignSpecial(idx_type cell, docstring const & special,
 483                              Feature what);
 484         ///
 485         LyXAlignment getAlignment(idx_type cell,
 486                                   bool onlycolumn = false) const;
 487         ///
 488         VAlignment getVAlignment(idx_type cell,
 489                                  bool onlycolumn = false) const;
 490         /// The vertical offset of the table due to the vertical
 491         /// alignment with respect to the baseline.
 492         int offsetVAlignment() const;
 493         ///
 494         Length const getPWidth(idx_type cell) const;
 495         ///
 496         Length const getMROffset(idx_type cell) const;
 497         ///
 498         int textHOffset(idx_type cell) const;
 499         ///
 500         int textVOffset(idx_type cell) const;
 501         ///
 502         void appendRow(row_type row);
 503         ///
 504         void deleteRow(row_type row);
 505         ///
 506         void copyRow(row_type row);
 507         ///
 508         void insertRow(row_type row, bool copy);
 509         ///
 510         void moveColumn(col_type col, ColDirection direction);
 511         ///
 512         void moveRow(row_type row, RowDirection direction);
 513         ///
 514         void appendColumn(col_type column);
 515         ///
 516         void deleteColumn(col_type column);
 517         ///
 518         void copyColumn(col_type column);
 519         ///
 520         void insertColumn(col_type column, bool copy);
 521         ///
 522         idx_type getFirstCellInRow(row_type row) const;
 523         ///
 524         idx_type getLastCellInRow(row_type row) const;
 525         ///
 526         idx_type numberOfCellsInRow(row_type row) const;
 527         ///
 528         void write(std::ostream &) const;
 529         ///
 530         void read(Lexer &);
 531         ///
 532         void latex(otexstream &, OutputParams const &) const;
 533         ///
 534         int docbook(odocstream & os, OutputParams const &) const;
 535         ///
 536         docstring xhtml(XHTMLStream & os, OutputParams const &) const;
 537         ///
 538         void plaintext(odocstringstream &,
 539                        OutputParams const & runparams, int const depth,
 540                        bool onlydata, char_type delim, size_t max_length = INT_MAX) const;
 541         ///
 542         bool isMultiColumn(idx_type cell) const;
 543         ///
 544         bool hasMultiColumn(col_type cell) const;
 545         ///
 546         bool hasVarwidthColumn() const;
 547         ///
 548         bool isVTypeColumn(col_type cell) const;
 549         ///
 550         idx_type setMultiColumn(Cursor & cur, idx_type cell, idx_type number,
 551                              bool const right_border);
 552         ///
 553         void unsetMultiColumn(idx_type cell);
 554         ///
 555         bool isPartOfMultiColumn(row_type row, col_type column) const;
 556         ///
 557         bool isPartOfMultiRow(row_type row, col_type column) const;
 558         ///
 559         bool isMultiRow(idx_type cell) const;
 560         ///
 561         bool hasMultiRow(row_type r) const;
 562         ///
 563         idx_type setMultiRow(Cursor & cur, idx_type cell, idx_type number,
 564                              bool const bottom_border,
 565                              LyXAlignment const halign);
 566         ///
 567         void unsetMultiRow(idx_type cell);
 568         ///
 569         row_type cellRow(idx_type cell) const;
 570         ///
 571         col_type cellColumn(idx_type cell) const;
 572         ///
 573         void setRotateCell(idx_type cell, int);
 574         ///
 575         int getRotateCell(idx_type cell) const;
 576         ///
 577         bool needRotating() const;
 578         ///
 579         bool isLastCell(idx_type cell) const;
 580         ///
 581         idx_type cellAbove(idx_type cell) const;
 582         ///
 583         idx_type cellBelow(idx_type cell) const;
 584         /// \return the index of the VISIBLE cell at row, column
 585         /// this will be the same as the cell in the previous row,
 586         /// e.g., if the cell is part of a multirow
 587         idx_type cellIndex(row_type row, col_type column) const;
 588         ///
 589         void setUsebox(idx_type cell, BoxType);
 590         ///
 591         BoxType getUsebox(idx_type cell) const;
 592         //
 593         // Long Tabular Options support functions
 594         ///
 595         void setLTHead(row_type row, bool flag, ltType const &, bool first);
 596         ///
 597         bool getRowOfLTHead(row_type row, ltType &) const;
 598         ///
 599         bool getRowOfLTFirstHead(row_type row, ltType &) const;
 600         ///
 601         void setLTFoot(row_type row, bool flag, ltType const &, bool last);
 602         ///
 603         bool getRowOfLTFoot(row_type row, ltType &) const;
 604         ///
 605         bool getRowOfLTLastFoot(row_type row, ltType &) const;
 606         ///
 607         void setLTNewPage(row_type row, bool what);
 608         ///
 609         bool getLTNewPage(row_type row) const;
 610         ///
 611         idx_type setLTCaption(Cursor & cur, row_type row, bool what);
 612         ///
 613         bool ltCaption(row_type row) const;
 614         ///
 615         bool haveLTHead(bool withcaptions = true) const;
 616         ///
 617         bool haveLTFirstHead(bool withcaptions = true) const;
 618         ///
 619         bool haveLTFoot(bool withcaptions = true) const;
 620         ///
 621         bool haveLTLastFoot(bool withcaptions = true) const;
 622         ///
 623         bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
 624         ///
 625         // end longtable support
 626
 627         //@{
 628         /// there is a subtle difference between these two methods.
 629         ///   cellInset(r,c);
 630         /// and
 631         ///   cellInset(cellIndex(r,c));
 632         /// can return different things. this is because cellIndex(r,c)
 633         /// returns the VISIBLE cell at r,c, which may be the same as the
 634         /// cell at the previous row or column, if we're dealing with some
 635         /// multirow or multicell.
 636         std::shared_ptr<InsetTableCell> cellInset(idx_type cell);
 637         std::shared_ptr<InsetTableCell> cellInset(row_type row, col_type column);
 638         InsetTableCell const * cellInset(idx_type cell) const;
 639         //@}
 640         ///
 641         void setCellInset(row_type row, col_type column,
 642                           std::shared_ptr<InsetTableCell>);
 643         /// Search for \param inset in the tabular, with the
 644         ///
 645         void validate(LaTeXFeatures &) const;
 646
 647         //private:
 648         // FIXME Now that cells have an InsetTableCell as their insets, rather
 649         // than an InsetText, it'd be possible to reverse the relationship here,
 650         // so that cell_vector was a vector<InsetTableCell> rather than a
 651         // vector<CellData>, and an InsetTableCell had a CellData as a member,
 652         // or perhaps just had its members as members.
 653         ///
 654         class CellData {
 655         public:
 656                 ///
 657                 CellData(Buffer *);
 658                 ///
 659                 CellData(CellData const &);
 660                 ///
 661                 CellData & operator=(CellData const &);
 662                 ///
 663                 idx_type cellno;
 664                 ///
 665                 int width;
 666                 ///
 667                 int multicolumn;
 668                 ///
 669                 int multirow;
 670                 ///
 671                 Length mroffset;
 672                 ///
 673                 LyXAlignment alignment;
 674                 ///
 675                 VAlignment valignment;
 676                 /// width of the part before the decimal
 677                 int decimal_hoffset;
 678                 /// width of the decimal part
 679                 int decimal_width;
 680                 ///
 681                 int voffset;
 682                 ///
 683                 bool top_line;
 684                 ///
 685                 bool bottom_line;
 686                 ///
 687                 bool left_line;
 688                 ///
 689                 bool right_line;
 690                 ///
 691                 BoxType usebox;
 692                 ///
 693                 int rotate;
 694                 ///
 695                 docstring align_special;
 696                 ///
 697                 Length p_width; // this is only set for multicolumn!!!
 698                 ///
 699                 std::shared_ptr<InsetTableCell> inset;
 700         };
 701         ///
 702         CellData const & cellInfo(idx_type cell) const;
 703         ///
 704         CellData & cellInfo(idx_type cell);
 705         ///
 706         typedef std::vector<CellData> cell_vector;
 707         ///
 708         typedef std::vector<cell_vector> cell_vvector;
 709
 710         ///
 711         class RowData {
 712         public:
 713                 ///
 714                 RowData();
 715                 ///
 716                 int ascent;
 717                 ///
 718                 int descent;
 719                 /// Extra space between the top line and this row
 720                 Length top_space;
 721                 /// Ignore top_space if true and use the default top space
 722                 bool top_space_default;
 723                 /// Extra space between this row and the bottom line
 724                 Length bottom_space;
 725                 /// Ignore bottom_space if true and use the default bottom space
 726                 bool bottom_space_default;
 727                 /// Extra space between the bottom line and the next top line
 728                 Length interline_space;
 729                 /// Ignore interline_space if true and use the default interline space
 730                 bool interline_space_default;
 731                 /// This are for longtabulars only
 732                 /// a row of endhead
 733                 bool endhead;
 734                 /// a row of endfirsthead
 735                 bool endfirsthead;
 736                 /// a row of endfoot
 737                 bool endfoot;
 738                 /// row of endlastfoot
 739                 bool endlastfoot;
 740                 /// row for a newpage
 741                 bool newpage;
 742                 /// caption
 743                 bool caption;
 744         };
 745         ///
 746         typedef std::vector<RowData> row_vector;
 747
 748         ///
 749         class ColumnData {
 750                 public:
 751                 ///
 752                 ColumnData();
 753                 ///
 754                 LyXAlignment alignment;
 755                 ///
 756                 VAlignment valignment;
 757                 ///
 758                 int width;
 759                 ///
 760                 Length p_width;
 761                 ///
 762                 docstring align_special;
 763                 ///
 764                 docstring decimal_point;
 765                 ///
 766                 bool varwidth;
 767         };
 768         ///
 769         typedef std::vector<ColumnData> column_vector;
 770
 771         ///
 772         idx_type numberofcells;
 773         ///
 774         std::vector<row_type> rowofcell;
 775         ///
 776         std::vector<col_type> columnofcell;
 777         ///
 778         row_vector row_info;
 779         ///
 780         column_vector column_info;
 781         ///
 782         cell_vvector cell_info;
 783         ///
 784         Length tabular_width;
 785         ///
 786         bool use_booktabs;
 787         ///
 788         int rotate;
 789         ///
 790         VAlignment tabular_valignment;
 791         //
 792         // for long tabulars
 793         ///
 794         HAlignment longtabular_alignment;
 795         //
 796         bool is_long_tabular;
 797         /// endhead data
 798         ltType endhead;
 799         /// endfirsthead data
 800         ltType endfirsthead;
 801         /// endfoot data
 802         ltType endfoot;
 803         /// endlastfoot data
 804         ltType endlastfoot;
 805
 806         ///
 807         void init(Buffer *, row_type rows_arg,
 808                   col_type columns_arg);
 809         ///
 810         void updateIndexes();
 811         ///
 812         bool setFixedWidth(row_type r, col_type c);
 813         /// return true of update is needed
 814         bool updateColumnWidths(MetricsInfo & mi);
 815         ///
 816         idx_type columnSpan(idx_type cell) const;
 817         ///
 818         idx_type rowSpan(idx_type cell) const;
 819         ///
 820         BoxType useBox(idx_type cell) const;
 821         ///
 822         // helper function for Latex
 823         ///
 824         void TeXTopHLine(otexstream &, row_type row, std::string const & lang,
 825                          std::list<col_type>) const;
 826         ///
 827         void TeXBottomHLine(otexstream &, row_type row, std::string const & lang,
 828                             std::list<col_type>) const;
 829         ///
 830         void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow,
 831                              bool const bidi) const;
 832         ///
 833         void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
 834         ///
 835         void TeXLongtableHeaderFooter(otexstream &, OutputParams const &, std::list<col_type>) const;
 836         ///
 837         bool isValidRow(row_type const row) const;
 838         ///
 839         void TeXRow(otexstream &, row_type const row,
 840                     OutputParams const &, std::list<col_type>) const;
 841         ///
 842         // helper functions for plain text
 843         ///
 844         bool plaintextTopHLine(odocstringstream &, row_type row,
 845                                std::vector<unsigned int> const &) const;
 846         ///
 847         bool plaintextBottomHLine(odocstringstream &, row_type row,
 848                                   std::vector<unsigned int> const &) const;
 849         ///
 850         void plaintextPrintCell(odocstringstream &,
 851                                 OutputParams const &,
 852                                 idx_type cell, row_type row, col_type column,
 853                                 std::vector<unsigned int> const &,
 854                                 bool onlydata, size_t max_length) const;
 855         /// auxiliary function for docbook
 856         int docbookRow(odocstream & os, row_type, OutputParams const &) const;
 857         ///
 858         docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
 859                            bool header = false) const;
 860
 861         /// change associated Buffer
 862         void setBuffer(Buffer & buffer);
 863         /// retrieve associated Buffer
 864         Buffer const & buffer() const { return *buffer_; }
 865         /// retrieve associated Buffer
 866         Buffer & buffer() { return *buffer_; }
 867
 868 private:
 869         Buffer * buffer_;
 870
 871 }; // Tabular
 872
 873
 874 class InsetTabular : public Inset
 875 {
 876 public:
 877         ///
 878         InsetTabular(Buffer *, row_type rows = 1,
 879                      col_type columns = 1);
 880         ///
 881         ~InsetTabular();
 882         ///
 883         void setBuffer(Buffer & buffer);
 884
 885         ///
 886         static void string2params(std::string const &, InsetTabular &);
 887         ///
 888         static std::string params2string(InsetTabular const &);
 889         ///
 890         void read(Lexer &);
 891         ///
 892         void write(std::ostream &) const;
 893         ///
 894         void metrics(MetricsInfo &, Dimension &) const;
 895         ///
 896         void draw(PainterInfo & pi, int x, int y) const;
 897         ///
 898         void drawSelection(PainterInfo & pi, int x, int y) const;
 899         ///
 900         void drawBackground(PainterInfo & pi, int x, int y) const;
 901         ///
 902         bool editable() const { return true; }
 903         ///
 904         bool hasSettings() const { return true; }
 905         ///
 906         bool insetAllowed(InsetCode code) const;
 907         ///
 908         bool allowSpellCheck() const { return true; }
 909         ///
 910         bool canTrackChanges() const { return true; }
 911         ///
 912         bool canPaintChange(BufferView const &) const { return true; }
 913         /** returns false if, when outputing LaTeX, font changes should
 914             be closed before generating this inset. This is needed for
 915             insets that may contain several paragraphs */
 916         bool inheritFont() const { return false; }
 917         ///
 918         bool allowsCaptionVariation(std::string const &) const;
 919         //
 920         bool isTable() const { return true; }
 921         ///
 922         DisplayType display() const;
 923         ///
 924         void latex(otexstream &, OutputParams const &) const;
 925         ///
 926         int plaintext(odocstringstream & ods, OutputParams const & op,
 927                       size_t max_length = INT_MAX) const;
 928         ///
 929         int docbook(odocstream &, OutputParams const &) const;
 930         ///
 931         docstring xhtml(XHTMLStream &, OutputParams const &) const;
 932         ///
 933         void validate(LaTeXFeatures & features) const;
 934         ///
 935         InsetCode lyxCode() const { return TABULAR_CODE; }
 936         ///
 937         std::string contextMenu(BufferView const &, int, int) const;
 938         ///
 939         std::string contextMenuName() const;
 940         /// get offset of this cursor slice relative to our upper left corner
 941         void cursorPos(BufferView const & bv, CursorSlice const & sl,
 942                 bool boundary, int & x, int & y) const;
 943         /// Executes a space-separated sequence of tabular-features requests
 944         void tabularFeatures(Cursor & cur, std::string const & what);
 945         /// Change a single tabular feature; does not handle undo.
 946         void tabularFeatures(Cursor & cur, Tabular::Feature feature,
 947                              std::string const & val = std::string());
 948         /// number of cells
 949         size_t nargs() const { return tabular.numberofcells; }
 950         ///
 951         std::shared_ptr<InsetTableCell const> cell(idx_type) const;
 952         ///
 953         std::shared_ptr<InsetTableCell> cell(idx_type);
 954         ///
 955         Text * getText(int) const;
 956
 957         /// set the change for the entire inset
 958         void setChange(Change const & change);
 959         /// accept the changes within the inset
 960         void acceptChanges();
 961         /// reject the changes within the inset
 962         void rejectChanges();
 963
 964         // this should return true if we have a "normal" cell, otherwise false.
 965         // "normal" means without width set!
 966         /// should all paragraphs be output with "Standard" layout?
 967         virtual bool allowParagraphCustomization(idx_type cell = 0) const;
 968         ///
 969         virtual bool forcePlainLayout(idx_type cell = 0) const;
 970         ///
 971         void addPreview(DocIterator const & inset_pos,
 972                 graphics::PreviewLoader &) const;
 973
 974         /// lock cell with given index
 975         void edit(Cursor & cur, bool front, EntryDirection entry_from);
 976         /// get table row from x coordinate
 977         int rowFromY(Cursor & cur, int y) const;
 978         /// get table column from y coordinate
 979         int columnFromX(Cursor & cur, int x) const;
 980         ///
 981         Inset * editXY(Cursor & cur, int x, int y);
 982         /// can we go further down on mouse click?
 983         bool descendable(BufferView const &) const { return true; }
 984         /// Update the counters of this inset and of its contents
 985         void updateBuffer(ParIterator const &, UpdateType);
 986         ///
 987         void addToToc(DocIterator const & di, bool output_active,
 988                                   UpdateType utype, TocBackend & backend) const;
 989
 990         ///
 991         bool completionSupported(Cursor const &) const;
 992         ///
 993         bool inlineCompletionSupported(Cursor const & cur) const;
 994         ///
 995         bool automaticInlineCompletion() const;
 996         ///
 997         bool automaticPopupCompletion() const;
 998         ///
 999         bool showCompletionCursor() const;
1000         ///
1001         CompletionList const * createCompletionList(Cursor const & cur) const;
1002         ///
1003         docstring completionPrefix(Cursor const & cur) const;
1004         ///
1005         bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
1006         ///
1007         void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
1008         ///
1009         virtual bool usePlainLayout() const { return true; }
1010         ///
1011         docstring layoutName() const { return from_ascii("Tabular"); }
1012
1013
1014         ///
1015         InsetTabular * asInsetTabular() { return this; }
1016         ///
1017         InsetTabular const * asInsetTabular() const { return this; }
1018         ///
1019         bool isRightToLeft(Cursor & cur) const;
1020         /// writes the cells between stidx and enidx as a string, optionally
1021         /// descending into the insets
1022         docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
1023
1024         /// Returns whether the cell in the specified row and column is selected.
1025         bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
1026         ///
1027         void setLayoutForHiddenCells(DocumentClass const & dc);
1028         //
1029         // Public structures and variables
1030         ///
1031         mutable Tabular tabular;
1032
1033 private:
1034         ///
1035         InsetTabular(InsetTabular const &);
1036         ///
1037         void doDispatch(Cursor & cur, FuncRequest & cmd);
1038         ///
1039         bool getFeatureStatus(Cursor & cur, std::string const & s,
1040                          std::string const & argument, FuncStatus & status) const;
1041         ///
1042         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
1043         ///
1044         Inset * clone() const { return new InsetTabular(*this); }
1045
1046         ///
1047         bool hitSelectRow(BufferView const & bv, int x) const;
1048         ///
1049         bool hitSelectColumn(BufferView const & bv, int y) const;
1050         /// Returns true if coordinates are on row/column selection zones
1051         bool clickable(BufferView const &, int x, int y) const;
1052
1053         ///
1054         void drawCellLines(PainterInfo &, int x, int y, row_type row,
1055                            idx_type cell) const;
1056         ///
1057         void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
1058
1059         ///
1060         void moveNextCell(Cursor & cur,
1061                                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1062         ///
1063         void movePrevCell(Cursor & cur,
1064                                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1065         ///
1066         int cellXPos(idx_type cell) const;
1067         ///
1068         int cellYPos(idx_type cell) const;
1069         ///
1070         bool copySelection(Cursor & cur);
1071         ///
1072         bool pasteClipboard(Cursor & cur);
1073         ///
1074         void cutSelection(Cursor & cur);
1075         ///
1076         void getSelection(Cursor & cur, row_type & rs, row_type & re,
1077                           col_type & cs, col_type & ce) const;
1078         ///
1079         bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
1080
1081         /// return the "Manhattan distance" to nearest corner
1082         int dist(BufferView &, idx_type cell, int x, int y) const;
1083         /// return the cell nearest to x, y
1084         idx_type getNearestCell(BufferView &, int x, int y) const;
1085
1086         /// test the rotation state of the given cell range.
1087         bool oneCellHasRotationState(bool rotated,
1088                                 row_type row_start, row_type row_end,
1089                                 col_type col_start, col_type col_end) const;
1090
1091         /// true when selecting rows with the mouse
1092         bool rowselect_;
1093         /// true when selecting columns with the mouse
1094         bool colselect_;
1095 };
1096
1097 std::string const featureAsString(Tabular::Feature feature);
1098
1099 /// Split cell on decimal symbol
1100 InsetTableCell splitCell(InsetTableCell & head, docstring const & decimal_sym, bool & hassep);
1101
1102 } // namespace lyx
1103
1104 #endif // INSET_TABULAR_H