src/tabular.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 2000-2001 The LyX Team.
   8  *
   9  *           @author: Jürgen Vigna
  10  *
  11  * ====================================================== */
  12 #ifndef TABULAR_H
  13 #define TABULAR_H
  14
  15 #include "layout.h"
  16 #include "LString.h"
  17 #include "lyxlength.h"
  18
  19 #include "insets/insettext.h"
  20
  21 #include <iosfwd>
  22 #include <vector>
  23
  24 class InsetTabular;
  25 class BufferParams;
  26 class LaTeXFeatures;
  27 class LatexRunParams;
  28 class Buffer;
  29 class LyXLex;
  30
  31 /* The features the text class offers for tables */
  32
  33 ///
  34 class LyXTabular  {
  35 public:
  36         ///
  37         enum Feature {
  38                 ///
  39                 APPEND_ROW = 0,
  40                 ///
  41                 APPEND_COLUMN,
  42                 ///
  43                 DELETE_ROW,
  44                 ///
  45                 DELETE_COLUMN,
  46                 ///
  47                 TOGGLE_LINE_TOP,
  48                 ///
  49                 TOGGLE_LINE_BOTTOM,
  50                 ///
  51                 TOGGLE_LINE_LEFT,
  52                 ///
  53                 TOGGLE_LINE_RIGHT,
  54                 ///
  55                 ALIGN_LEFT,
  56                 ///
  57                 ALIGN_RIGHT,
  58                 ///
  59                 ALIGN_CENTER,
  60                 ///
  61                 ALIGN_BLOCK,
  62                 ///
  63                 VALIGN_TOP,
  64                 ///
  65                 VALIGN_BOTTOM,
  66                 ///
  67                 VALIGN_CENTER,
  68                 ///
  69                 M_TOGGLE_LINE_TOP,
  70                 ///
  71                 M_TOGGLE_LINE_BOTTOM,
  72                 ///
  73                 M_TOGGLE_LINE_LEFT,
  74                 ///
  75                 M_TOGGLE_LINE_RIGHT,
  76                 ///
  77                 M_ALIGN_LEFT,
  78                 ///
  79                 M_ALIGN_RIGHT,
  80                 ///
  81                 M_ALIGN_CENTER,
  82                 ///
  83                 M_VALIGN_TOP,
  84                 ///
  85                 M_VALIGN_BOTTOM,
  86                 ///
  87                 M_VALIGN_CENTER,
  88                 ///
  89                 MULTICOLUMN,
  90                 ///
  91                 SET_ALL_LINES,
  92                 ///
  93                 UNSET_ALL_LINES,
  94                 ///
  95                 SET_LONGTABULAR,
  96                 ///
  97                 UNSET_LONGTABULAR,
  98                 ///
  99                 SET_PWIDTH,
 100                 ///
 101                 SET_MPWIDTH,
 102                 ///
 103                 SET_ROTATE_TABULAR,
 104                 ///
 105                 UNSET_ROTATE_TABULAR,
 106                 ///
 107                 SET_ROTATE_CELL,
 108                 ///
 109                 UNSET_ROTATE_CELL,
 110                 ///
 111                 SET_USEBOX,
 112                 ///
 113                 SET_LTHEAD,
 114                 UNSET_LTHEAD,
 115                 ///
 116                 SET_LTFIRSTHEAD,
 117                 UNSET_LTFIRSTHEAD,
 118                 ///
 119                 SET_LTFOOT,
 120                 UNSET_LTFOOT,
 121                 ///
 122                 SET_LTLASTFOOT,
 123                 UNSET_LTLASTFOOT,
 124                 ///
 125                 SET_LTNEWPAGE,
 126                 ///
 127                 SET_SPECIAL_COLUMN,
 128                 ///
 129                 SET_SPECIAL_MULTI,
 130                 ///
 131                 LAST_ACTION
 132         };
 133         ///
 134         enum {
 135                 ///
 136                 CELL_NORMAL = 0,
 137                 ///
 138                 CELL_BEGIN_OF_MULTICOLUMN,
 139                 ///
 140                 CELL_PART_OF_MULTICOLUMN
 141         };
 142
 143         ///
 144         enum VAlignment {
 145                 ///
 146                 LYX_VALIGN_TOP = 0,
 147                 ///
 148                 LYX_VALIGN_BOTTOM = 1,
 149                 ///
 150                 LYX_VALIGN_CENTER = 2
 151         };
 152
 153         enum BoxType {
 154                 ///
 155                 BOX_NONE = 0,
 156                 ///
 157                 BOX_PARBOX = 1,
 158                 ///
 159                 BOX_MINIPAGE = 2
 160         };
 161
 162         struct ltType {
 163                 // constructor
 164                 ltType();
 165                 // we have this header type (is set in the GetLT... functions)
 166                 bool set;
 167                 // double borders on top
 168                 bool topDL;
 169                 // double borders on bottom
 170                 bool bottomDL;
 171                 // used for FirstHeader & LastFooter and if this is true
 172                 // all the rows marked as FirstHeader or LastFooter are
 173                 // ignored in the output and it is set to be empty!
 174                 bool empty;
 175         };
 176
 177         /* konstruktor */
 178         ///
 179         LyXTabular(BufferParams const &,
 180                    InsetTabular *, int columns_arg, int rows_arg);
 181         ///
 182         LyXTabular(BufferParams const &,
 183                    InsetTabular *, LyXTabular const &, bool same_id = false);
 184         ///
 185         explicit
 186         LyXTabular(Buffer const *, InsetTabular *, LyXLex & lex);
 187         ///
 188         LyXTabular & operator=(LyXTabular const &);
 189         ///
 190         LyXTabular * clone(BufferParams const &,
 191                            InsetTabular *, bool same_id = false);
 192
 193         /// Returns true if there is a topline, returns false if not
 194         bool TopLine(int cell, bool onlycolumn = false) const;
 195         /// Returns true if there is a topline, returns false if not
 196         bool BottomLine(int cell, bool onlycolumn = false) const;
 197         /// Returns true if there is a topline, returns false if not
 198         bool LeftLine(int cell, bool onlycolumn = false) const;
 199         /// Returns true if there is a topline, returns false if not
 200         bool RightLine(int cell, bool onlycolumn = false) const;
 201
 202         ///
 203         bool topAlreadyDrawn(int cell) const;
 204         ///
 205         bool leftAlreadyDrawn(int cell) const;
 206         ///
 207         bool IsLastRow(int cell) const;
 208
 209         ///
 210         int GetAdditionalHeight(int row) const;
 211         ///
 212         int GetAdditionalWidth(int cell) const;
 213
 214         /* returns the maximum over all rows */
 215         ///
 216         int GetWidthOfColumn(int cell) const;
 217         ///
 218         int GetWidthOfTabular() const;
 219         ///
 220         int GetAscentOfRow(int row) const;
 221         ///
 222         int GetDescentOfRow(int row) const;
 223         ///
 224         int GetHeightOfTabular() const;
 225         /// Returns true if a complete update is necessary, otherwise false
 226         bool SetAscentOfRow(int row, int height);
 227         /// Returns true if a complete update is necessary, otherwise false
 228         bool SetDescentOfRow(int row, int height);
 229         /// Returns true if a complete update is necessary, otherwise false
 230         bool SetWidthOfCell(int cell, int new_width);
 231         /// Returns true if a complete update is necessary, otherwise false
 232         bool SetAllLines(int cell, bool line);
 233         /// Returns true if a complete update is necessary, otherwise false
 234         bool SetTopLine(int cell, bool line, bool onlycolumn = false);
 235         /// Returns true if a complete update is necessary, otherwise false
 236         bool SetBottomLine(int cell, bool line, bool onlycolumn = false);
 237         /// Returns true if a complete update is necessary, otherwise false
 238         bool SetLeftLine(int cell, bool line, bool onlycolumn = false);
 239         /// Returns true if a complete update is necessary, otherwise false
 240         bool SetRightLine(int cell, bool line, bool onlycolumn = false);
 241         /// Returns true if a complete update is necessary, otherwise false
 242         bool SetAlignment(int cell, LyXAlignment align,
 243                           bool onlycolumn = false);
 244         /// Returns true if a complete update is necessary, otherwise false
 245         bool SetVAlignment(int cell, VAlignment align,
 246                            bool onlycolumn = false);
 247         ///
 248         bool SetColumnPWidth(int cell, LyXLength const & width);
 249         ///
 250         bool SetMColumnPWidth(int cell, LyXLength const & width);
 251         ///
 252         bool SetAlignSpecial(int cell, string const & special, Feature what);
 253         ///
 254         LyXAlignment GetAlignment(int cell, bool onlycolumn = false) const;
 255         ///
 256         VAlignment GetVAlignment(int cell, bool onlycolumn = false) const;
 257         ///
 258         LyXLength const GetPWidth(int cell) const;
 259         ///
 260         LyXLength const GetColumnPWidth(int cell) const;
 261         ///
 262         LyXLength const GetMColumnPWidth(int cell) const;
 263         ///
 264         string const GetAlignSpecial(int cell, int what) const;
 265         ///
 266         int GetWidthOfCell(int cell) const;
 267         ///
 268         int GetBeginningOfTextInCell(int cell) const;
 269         ///
 270         void AppendRow(BufferParams const &, int cell);
 271         ///
 272         void DeleteRow(int row);
 273         ///
 274         void AppendColumn(BufferParams const &, int cell);
 275         ///
 276         void DeleteColumn(int column);
 277         ///
 278         bool IsFirstCellInRow(int cell) const;
 279         ///
 280         int GetFirstCellInRow(int row) const;
 281         ///
 282         bool IsLastCellInRow(int cell) const;
 283         ///
 284         int GetLastCellInRow(int row) const;
 285         ///
 286         int GetNumberOfCells() const;
 287         ///
 288         int NumberOfCellsInRow(int cell) const;
 289         ///
 290         void Write(Buffer const *, std::ostream &) const;
 291         ///
 292         void Read(Buffer const *, LyXLex &);
 293         ///
 294         int latex(Buffer const *, std::ostream &, LatexRunParams const &, bool, bool) const;
 295         ///
 296         int docbook(Buffer const * buf, std::ostream & os, bool mixcont) const;
 297         ///
 298         int ascii(Buffer const *, std::ostream &, int const depth,
 299                   bool onlydata, unsigned char delim) const;
 300         ///
 301         bool IsMultiColumn(int cell, bool real = false) const;
 302         ///
 303         void SetMultiColumn(Buffer *, int cell, int number);
 304         ///
 305         int UnsetMultiColumn(int cell); // returns number of new cells
 306         ///
 307         bool IsPartOfMultiColumn(int row, int column) const;
 308         ///
 309         int row_of_cell(int cell) const;
 310         ///
 311         int column_of_cell(int cell) const;
 312         ///
 313         int right_column_of_cell(int cell) const;
 314         ///
 315         void SetLongTabular(bool);
 316         ///
 317         bool IsLongTabular() const;
 318         ///
 319         void SetRotateTabular(bool);
 320         ///
 321         bool GetRotateTabular() const;
 322         ///
 323         void SetRotateCell(int cell, bool);
 324         ///
 325         bool GetRotateCell(int cell) const;
 326         ///
 327         bool NeedRotating() const;
 328         ///
 329         bool IsLastCell(int cell) const;
 330         ///
 331         int GetCellAbove(int cell) const;
 332         ///
 333         int GetCellBelow(int cell) const;
 334         ///
 335         int GetLastCellAbove(int cell) const;
 336         ///
 337         int GetLastCellBelow(int cell) const;
 338         ///
 339         int GetCellNumber(int row, int column) const;
 340         ///
 341         void SetUsebox(int cell, BoxType);
 342         ///
 343         BoxType GetUsebox(int cell) const;
 344         //
 345         // Long Tabular Options support functions
 346         ///
 347         bool checkLTType(int row, ltType const &) const;
 348         ///
 349         void SetLTHead(int row, bool flag, ltType const &, bool first);
 350         ///
 351         bool GetRowOfLTHead(int row, ltType &) const;
 352         ///
 353         bool GetRowOfLTFirstHead(int row, ltType &) const;
 354         ///
 355         void SetLTFoot(int row, bool flag, ltType const &, bool last);
 356         ///
 357         bool GetRowOfLTFoot(int row, ltType &) const;
 358         ///
 359         bool GetRowOfLTLastFoot(int row, ltType &) const;
 360         ///
 361         void SetLTNewPage(int row, bool what);
 362         ///
 363         bool GetLTNewPage(int row) const;
 364         ///
 365         bool haveLTHead() const;
 366         ///
 367         bool haveLTFirstHead() const;
 368         ///
 369         bool haveLTFoot() const;
 370         ///
 371         bool haveLTLastFoot() const;
 372         ///
 373         // end longtable support
 374         ///
 375         InsetText * GetCellInset(int cell) const;
 376         ///
 377         InsetText * GetCellInset(int row, int column) const;
 378         /// Search for \param inset in the tabular, with the
 379         /// additional hint that it could be at \param maybe_cell
 380         int GetCellFromInset(Inset const * inset, int maybe_cell = -1) const;
 381         ///
 382         int rows() const { return rows_; }
 383         ///
 384         int columns() const { return columns_;}
 385         ///
 386         InsetTabular * owner() const { return owner_; }
 387         ///
 388         void Validate(LaTeXFeatures &) const;
 389         ///
 390         std::vector<string> const getLabelList() const;
 391         ///
 392         /// recalculate the widths/heights only!
 393         void reinit();
 394         ///
 395         mutable int cur_cell;
 396 private:
 397         ///
 398         struct cellstruct {
 399                 ///
 400                 cellstruct(BufferParams const &);
 401                 ///
 402                 int cellno;
 403                 ///
 404                 int width_of_cell;
 405                 ///
 406                 int multicolumn;
 407                 ///
 408                 LyXAlignment alignment;
 409                 ///
 410                 VAlignment valignment;
 411                 ///
 412                 bool top_line;
 413                 ///
 414                 bool bottom_line;
 415                 ///
 416                 bool left_line;
 417                 ///
 418                 bool right_line;
 419                 ///
 420                 BoxType usebox;
 421                 ///
 422                 bool rotate;
 423                 ///
 424                 string align_special;
 425                 ///
 426                 LyXLength p_width; // this is only set for multicolumn!!!
 427                 ///
 428                 InsetText inset;
 429         };
 430         ///
 431         typedef std::vector<cellstruct> cell_vector;
 432         ///
 433         typedef std::vector<cell_vector> cell_vvector;
 434
 435         ///
 436         struct rowstruct {
 437                 ///
 438                 rowstruct();
 439                 ///
 440                 int ascent_of_row;
 441                 ///
 442                 int descent_of_row;
 443                 ///
 444                 bool top_line;
 445                 ///
 446                 bool bottom_line;
 447                 /// This are for longtabulars only
 448                 /// a row of endhead
 449                 bool endhead;
 450                 /// a row of endfirsthead
 451                 bool endfirsthead;
 452                 /// a row of endfoot
 453                 bool endfoot;
 454                 /// row of endlastfoot
 455                 bool endlastfoot;
 456                 /// row for a pagebreak
 457                 bool newpage;
 458         };
 459         ///
 460         typedef std::vector<rowstruct> row_vector;
 461
 462         ///
 463         struct columnstruct {
 464                 ///
 465                 columnstruct();
 466                 ///
 467                 LyXAlignment alignment;
 468                 ///
 469                 VAlignment valignment;
 470                 ///
 471                 bool left_line;
 472                 ///
 473                 bool right_line;
 474                 ///
 475                 int  width_of_column;
 476                 ///
 477                 LyXLength p_width;
 478                 ///
 479                 string align_special;
 480         };
 481         ///
 482         typedef std::vector<columnstruct> column_vector;
 483
 484         ///
 485         void read(Buffer const * buf, std::istream & is,
 486                   LyXLex & lex, string const & l, int const version);
 487         ///
 488         ///
 489         int rows_;
 490         ///
 491         int columns_;
 492         ///
 493         int numberofcells;
 494         ///
 495         std::vector<int> rowofcell;
 496         ///
 497         std::vector<int> columnofcell;
 498         ///
 499         row_vector row_info;
 500         ///
 501         column_vector column_info;
 502         ///
 503         mutable cell_vvector cell_info;
 504         ///
 505         int width_of_tabular;
 506         ///
 507         bool rotate;
 508         //
 509         // for long tabulars
 510         //
 511         bool is_long_tabular;
 512         /// endhead data
 513         ltType endhead;
 514         /// endfirsthead data
 515         ltType endfirsthead;
 516         /// endfoot data
 517         ltType endfoot;
 518         /// endlastfoot data
 519         ltType endlastfoot;
 520         //
 521         ///
 522         InsetTabular * owner_;
 523
 524         ///
 525         void Init(BufferParams const &,
 526                   int columns_arg, int rows_arg, LyXTabular const * lt = 0);
 527         ///
 528         void Reinit(bool reset_widths = true);
 529         ///
 530         void set_row_column_number_info(bool oldformat = false);
 531         /// Returns true if a complete update is necessary, otherwise false
 532         bool SetWidthOfMulticolCell(int cell, int new_width);
 533         ///
 534         void recalculateMulticolumnsOfColumn(int column);
 535         /// Returns true if change
 536         bool calculate_width_of_column(int column);
 537         ///
 538         bool calculate_width_of_column_NMC(int column); // no multi cells
 539         ///
 540         void calculate_width_of_tabular();
 541         ///
 542         cellstruct * cellinfo_of_cell(int cell) const;
 543         ///
 544         void delete_column(int column);
 545         ///
 546         int cells_in_multicolumn(int cell) const;
 547         ///
 548         BoxType UseParbox(int cell) const;
 549         ///
 550         void setHeaderFooterRows(int header, int fheader, int footer, int lfooter);
 551         ///
 552         // helper function for Latex returns number of newlines
 553         ///
 554         int TeXTopHLine(std::ostream &, int row) const;
 555         ///
 556         int TeXBottomHLine(std::ostream &, int row) const;
 557         ///
 558         int TeXCellPreamble(std::ostream &, int cell) const;
 559         ///
 560         int TeXCellPostamble(std::ostream &, int cell) const;
 561         ///
 562         int TeXLongtableHeaderFooter(std::ostream &, Buffer const * buf,
 563                                      LatexRunParams const &, bool fragile, bool fp) const;
 564         ///
 565         bool isValidRow(int const row) const;
 566         ///
 567         int TeXRow(std::ostream &, int const row, Buffer const * buf,
 568                    LatexRunParams const &, bool fragile, bool fp) const;
 569         ///
 570         // helper function for ASCII returns number of newlines
 571         ///
 572         int asciiTopHLine(std::ostream &, int row,
 573                           std::vector<unsigned int> const &) const;
 574         ///
 575         int asciiBottomHLine(std::ostream &, int row,
 576                              std::vector<unsigned int> const &) const;
 577         ///
 578         int asciiPrintCell(Buffer const *, std::ostream &,
 579                            int cell, int row, int column,
 580                            std::vector<unsigned int> const &,
 581                                            bool onlydata) const;
 582         /// auxiliary function for docbook
 583         int docbookRow(Buffer const * buf, std::ostream & os, int row) const;
 584 };
 585
 586 #endif