src/tabular.h

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