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     int DocBookEndOfCell(std::ostream &, int cell, int & depth) const;
 297 #if 0
 298     ///
 299     int RoffEndOfCell(std::ostream &, int cell);
 300 #endif
 301     ///
 302     string const  GetDocBookAlign(int cell, bool isColumn = false) const;
 303
 304     ///
 305     bool IsMultiColumn(int cell, bool real = false) const;
 306     ///
 307     void SetMultiColumn(int cell, int number);
 308     ///
 309     int UnsetMultiColumn(int cell); // returns number of new cells
 310     ///
 311     bool IsPartOfMultiColumn(int row, int column) const;
 312     ///
 313     int row_of_cell(int cell) const;
 314     ///
 315     int column_of_cell(int cell) const;
 316     ///
 317     int right_column_of_cell(int cell) const;
 318     ///
 319     void SetLongTabular(bool);
 320     ///
 321     bool IsLongTabular() const;
 322     ///
 323     void SetRotateTabular(bool);
 324     ///
 325     bool GetRotateTabular() const;
 326     ///
 327     void SetRotateCell(int cell, bool);
 328     ///
 329     bool GetRotateCell(int cell) const;
 330     ///
 331     bool NeedRotating() const;
 332     ///
 333     bool IsLastCell(int cell) const;
 334     ///
 335     int GetCellAbove(int cell) const;
 336     ///
 337     int GetCellBelow(int cell) const;
 338     ///
 339     int GetLastCellAbove(int cell) const;
 340     ///
 341     int GetLastCellBelow(int cell) const;
 342     ///
 343     int GetCellNumber(int row, int column) const;
 344     ///
 345     void SetUsebox(int cell, BoxType);
 346     ///
 347     BoxType GetUsebox(int cell) const;
 348     //
 349     // Long Tabular Options
 350     ///
 351     void SetLTHead(int cell, bool first);
 352     ///
 353     bool GetRowOfLTHead(int cell, int & row) const;
 354     ///
 355     bool GetRowOfLTFirstHead(int cell, int & row) const;
 356     ///
 357     void SetLTFoot(int cell, bool last);
 358     ///
 359     bool GetRowOfLTFoot(int cell, int & row) const;
 360     ///
 361     bool GetRowOfLTLastFoot(int cell, int & row) const;
 362     ///
 363     void SetLTNewPage(int cell, bool what);
 364     ///
 365     bool GetLTNewPage(int cell) const;
 366     ///
 367     InsetText * GetCellInset(int cell) const;
 368     ///
 369     InsetText * GetCellInset(int row, int column) const;
 370     ///
 371     int rows() const { return rows_; }
 372     ///
 373     int columns() const { return columns_;}
 374     ///
 375     InsetTabular * owner() const { return owner_; }
 376     ///
 377     void Validate(LaTeXFeatures &) const;
 378
 379 private: //////////////////////////////////////////////////////////////////
 380     ///
 381     struct cellstruct {
 382         ///
 383         cellstruct();
 384         ///
 385         int cellno;
 386         ///
 387         int width_of_cell;
 388         ///
 389         int multicolumn;
 390         ///
 391         LyXAlignment alignment;
 392         ///
 393         VAlignment valignment;
 394         ///
 395         bool top_line;
 396         ///
 397         bool bottom_line;
 398         ///
 399         bool left_line;
 400         ///
 401         bool right_line;
 402         ///
 403         BoxType usebox;
 404         ///
 405         bool rotate;
 406         ///
 407         string align_special;
 408         ///
 409         string p_width; // this is only set for multicolumn!!!
 410         ///
 411         InsetText inset;
 412     };
 413     ///
 414     typedef std::vector<cellstruct> cell_vector;
 415     ///
 416     typedef std::vector<cell_vector> cell_vvector;
 417
 418     ///
 419     struct rowstruct {
 420         ///
 421         rowstruct();
 422         ///
 423         bool top_line;
 424         ///
 425         bool bottom_line;
 426         ///
 427         int ascent_of_row;
 428         ///
 429         int descent_of_row;
 430         /// This are for longtabulars only
 431         bool newpage;
 432     };
 433     ///
 434     typedef std::vector<rowstruct> row_vector;
 435
 436     ///
 437     struct columnstruct {
 438         ///
 439         columnstruct();
 440         ///
 441         LyXAlignment alignment;
 442         ///
 443         VAlignment valignment;
 444         ///
 445         bool left_line;
 446         ///
 447         bool right_line;
 448         ///
 449         int  width_of_column;
 450         ///
 451         string p_width;
 452         ///
 453         string align_special;
 454     };
 455     ///
 456     typedef std::vector<columnstruct> column_vector;
 457
 458     ///
 459     void ReadNew(Buffer const * buf, std::istream & is,
 460              LyXLex & lex, string const & l);
 461     ///
 462     void ReadOld(Buffer const * buf, std::istream & is,
 463              LyXLex & lex, string const & l);
 464     ///
 465     int rows_;
 466     ///
 467     int columns_;
 468     ///
 469     int numberofcells;
 470     ///
 471     std::vector<int> rowofcell;
 472     ///
 473     std::vector<int> columnofcell;
 474     ///
 475     row_vector row_info;
 476     ///
 477     column_vector column_info;
 478     ///
 479     mutable cell_vvector cell_info;
 480     ///
 481     int width_of_tabular;
 482     ///
 483     bool rotate;
 484     //
 485     // for long tabulars
 486     ///
 487     bool is_long_tabular;
 488     /// row of endhead
 489     int endhead;
 490     /// row of endfirsthead
 491     int endfirsthead;
 492     /// row of endfoot
 493     int endfoot;
 494     /// row of endlastfoot
 495     int endlastfoot;
 496     ///
 497     InsetTabular * owner_;
 498
 499     ///
 500     void Init(int columns_arg, int rows_arg);
 501     ///
 502     void Reinit();
 503     ///
 504     void set_row_column_number_info(bool oldformat = false);
 505     /// Returns true if a complete update is necessary, otherwise false
 506     bool SetWidthOfMulticolCell(int cell, int new_width);
 507     ///
 508     void recalculateMulticolCells(int cell, int new_width);
 509     /// Returns true if change
 510     bool calculate_width_of_column(int column);
 511     ///
 512     bool calculate_width_of_column_NMC(int column); // no multi cells
 513     ///
 514     void calculate_width_of_tabular();
 515     ///
 516     cellstruct * cellinfo_of_cell(int cell) const;
 517     ///
 518     void delete_column(int column);
 519     ///
 520     int cells_in_multicolumn(int cell) const;
 521     ///
 522     BoxType UseParbox(int cell) const;
 523 };
 524
 525 #endif