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