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