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();
 165     ///
 166     LyXTabular & operator=(LyXTabular const &);
 167     ///
 168     LyXTabular * Clone(InsetTabular *);
 169
 170     /// Returns true if there is a topline, returns false if not
 171     bool TopLine(int cell, bool onlycolumn=false) const;
 172     /// Returns true if there is a topline, returns false if not
 173     bool BottomLine(int cell, bool onlycolumn=false) const;
 174     /// Returns true if there is a topline, returns false if not
 175     bool LeftLine(int cell, bool onlycolumn=false) const;
 176     /// Returns true if there is a topline, returns false if not
 177     bool RightLine(int cell, bool onlycolumn=false) const;
 178
 179     ///
 180     bool TopAlreadyDrawed(int cell) const;
 181     ///
 182     bool LeftAlreadyDrawed(int cell) const;
 183     ///
 184     bool IsLastRow(int cell) const;
 185
 186     ///
 187     int GetAdditionalHeight(int cell) const;
 188     ///
 189     int GetAdditionalWidth(int cell) const;
 190
 191     /* returns the maximum over all rows */
 192     ///
 193     int GetWidthOfColumn(int cell) const;
 194     ///
 195     int GetWidthOfTabular() const;
 196     ///
 197     int GetAscentOfRow(int row) const;
 198     ///
 199     int GetDescentOfRow(int row) const;
 200     ///
 201     int GetHeightOfTabular() const;
 202     /// Returns true if a complete update is necessary, otherwise false
 203     bool SetAscentOfRow(int row, int height);
 204     /// Returns true if a complete update is necessary, otherwise false
 205     bool SetDescentOfRow(int row, int height);
 206     /// Returns true if a complete update is necessary, otherwise false
 207     bool SetWidthOfCell(int cell, int new_width);
 208     /// Returns true if a complete update is necessary, otherwise false
 209     bool SetAllLines(int cell, bool line);
 210     /// Returns true if a complete update is necessary, otherwise false
 211     bool SetTopLine(int cell, bool line, bool onlycolumn=false);
 212     /// Returns true if a complete update is necessary, otherwise false
 213     bool SetBottomLine(int cell, bool line, bool onlycolumn=false);
 214     /// Returns true if a complete update is necessary, otherwise false
 215     bool SetLeftLine(int cell, bool line, bool onlycolumn=false);
 216     /// Returns true if a complete update is necessary, otherwise false
 217     bool SetRightLine(int cell, bool line, bool onlycolumn=false);
 218     /// Returns true if a complete update is necessary, otherwise false
 219     bool SetAlignment(int cell, LyXAlignment align, bool onlycolumn = false);
 220     /// Returns true if a complete update is necessary, otherwise false
 221     bool SetVAlignment(int cell, VAlignment align, bool onlycolumn = false);
 222     ///
 223     bool SetColumnPWidth(int cell, string const & width);
 224     ///
 225     bool SetMColumnPWidth(int cell, string const & width);
 226     ///
 227     bool SetAlignSpecial(int cell, string const & special, Feature what);
 228     ///
 229     LyXAlignment GetAlignment(int cell, bool onlycolumn = false) const;
 230     ///
 231     VAlignment GetVAlignment(int cell, bool onlycolumn = false) const;
 232     ///
 233     string const GetPWidth(int cell) const;
 234     ///
 235     string const GetColumnPWidth(int cell) const;
 236     ///
 237     string const GetMColumnPWidth(int cell) const;
 238     ///
 239     string const GetAlignSpecial(int cell, int what) const;
 240     ///
 241     int GetWidthOfCell(int cell) const;
 242     ///
 243     int GetBeginningOfTextInCell(int cell) const;
 244     ///
 245     void AppendRow(int cell);
 246     ///
 247     void DeleteRow(int cell);
 248     ///
 249     void AppendColumn(int cell);
 250     ///
 251     void DeleteColumn(int cell);
 252     ///
 253     bool IsFirstCellInRow(int cell) const;
 254     ///
 255     int GetFirstCellInRow(int row) const;
 256     ///
 257     bool IsLastCellInRow(int cell) const;
 258     ///
 259     int GetLastCellInRow(int row) const;
 260     ///
 261     int GetNumberOfCells() const;
 262     ///
 263     int NumberOfCellsInRow(int cell) const;
 264     ///
 265     void Write(Buffer const *, std::ostream &) const;
 266     ///
 267     void Read(Buffer const *, LyXLex &);
 268     ///
 269     void OldFormatRead(LyXLex &, string const &);
 270     //
 271     // helper function for Latex returns number of newlines
 272     ///
 273     int TeXTopHLine(std::ostream &, int row) const;
 274     ///
 275     int TeXBottomHLine(std::ostream &, int row) const;
 276     ///
 277     int TeXCellPreamble(std::ostream &, int cell) const;
 278     ///
 279     int TeXCellPostamble(std::ostream &, int cell) const;
 280     ///
 281     int Latex(Buffer const *, std::ostream &, bool, bool) const;
 282     ///
 283     int DocBookEndOfCell(std::ostream &, int cell, int & depth) const;
 284 #if 0
 285     ///
 286     int RoffEndOfCell(std::ostream &, int cell);
 287 #endif
 288     ///
 289     string const  GetDocBookAlign(int cell, bool isColumn = false) const;
 290
 291     ///
 292     bool IsMultiColumn(int cell, bool real = false) const;
 293     ///
 294     void SetMultiColumn(int cell, int number);
 295     ///
 296     int UnsetMultiColumn(int cell); // returns number of new cells
 297     ///
 298     bool IsPartOfMultiColumn(int row, int column) const;
 299     ///
 300     int row_of_cell(int cell) const;
 301     ///
 302     int column_of_cell(int cell) const;
 303     ///
 304     int right_column_of_cell(int cell) const;
 305     ///
 306     void SetLongTabular(bool);
 307     ///
 308     bool IsLongTabular() const;
 309     ///
 310     void SetRotateTabular(bool);
 311     ///
 312     bool GetRotateTabular() const;
 313     ///
 314     void SetRotateCell(int cell, bool);
 315     ///
 316     bool GetRotateCell(int cell) const;
 317     ///
 318     bool NeedRotating() const;
 319     ///
 320     bool IsLastCell(int cell) const;
 321     ///
 322     int GetCellAbove(int cell) const;
 323     ///
 324     int GetCellBelow(int cell) const;
 325     ///
 326     int GetLastCellAbove(int cell) const;
 327     ///
 328     int GetLastCellBelow(int cell) const;
 329     ///
 330     int GetCellNumber(int row, int column) const;
 331     ///
 332     void SetUsebox(int cell, BoxType);
 333     ///
 334     BoxType GetUsebox(int cell) const;
 335     //
 336     // Long Tabular Options
 337     ///
 338     void SetLTHead(int cell, bool first);
 339     ///
 340     bool GetRowOfLTHead(int cell, int & row) const;
 341     ///
 342     bool GetRowOfLTFirstHead(int cell, int & row) const;
 343     ///
 344     void SetLTFoot(int cell, bool last);
 345     ///
 346     bool GetRowOfLTFoot(int cell, int & row) const;
 347     ///
 348     bool GetRowOfLTLastFoot(int cell, int & row) const;
 349     ///
 350     void SetLTNewPage(int cell, bool what);
 351     ///
 352     bool GetLTNewPage(int cell) const;
 353     ///
 354     InsetText * GetCellInset(int cell) const;
 355     ///
 356     int rows() const { return rows_; }
 357     ///
 358     int columns() const { return columns_;}
 359     ///
 360     InsetTabular * owner() const { return owner_; }
 361     ///
 362     void Validate(LaTeXFeatures &) const;
 363
 364 private: //////////////////////////////////////////////////////////////////
 365     ///
 366     struct cellstruct {
 367         ///
 368         cellstruct();
 369         ///
 370         int cellno;
 371         ///
 372         int width_of_cell;
 373         ///
 374         int multicolumn;
 375         ///
 376         LyXAlignment alignment;
 377         ///
 378         VAlignment valignment;
 379         ///
 380         bool top_line;
 381         ///
 382         bool bottom_line;
 383         ///
 384         bool left_line;
 385         ///
 386         bool right_line;
 387         ///
 388         BoxType usebox;
 389         ///
 390         bool rotate;
 391         ///
 392         string align_special;
 393         ///
 394         string p_width; // this is only set for multicolumn!!!
 395         ///
 396         InsetText inset;
 397     };
 398     ///
 399     typedef std::vector<cellstruct> cell_vector;
 400     ///
 401     typedef std::vector<cell_vector> cell_vvector;
 402
 403     ///
 404     struct rowstruct {
 405         ///
 406         rowstruct();
 407         ///
 408         bool top_line;
 409         ///
 410         bool bottom_line;
 411         ///
 412         int ascent_of_row;
 413         ///
 414         int descent_of_row;
 415         /// This are for longtabulars only
 416         bool newpage;
 417     };
 418     ///
 419     typedef std::vector<rowstruct> row_vector;
 420
 421     ///
 422     struct columnstruct {
 423         ///
 424         columnstruct();
 425         ///
 426         LyXAlignment alignment;
 427         ///
 428         VAlignment valignment;
 429         ///
 430         bool left_line;
 431         ///
 432         bool right_line;
 433         ///
 434         int  width_of_column;
 435         ///
 436         string p_width;
 437         ///
 438         string align_special;
 439     };
 440     ///
 441     typedef std::vector<columnstruct> column_vector;
 442
 443     ///
 444     int rows_;
 445     ///
 446     int columns_;
 447     ///
 448     int numberofcells;
 449     ///
 450     int * rowofcell;
 451     ///
 452     int * columnofcell;
 453     ///
 454     row_vector row_info;
 455     ///
 456     column_vector column_info;
 457     ///
 458     mutable cell_vvector cell_info;
 459     ///
 460     int width_of_tabular;
 461     ///
 462     bool rotate;
 463     //
 464     // for long tabulars
 465     ///
 466     bool is_long_tabular;
 467     /// row of endhead
 468     int endhead;
 469     /// row of endfirsthead
 470     int endfirsthead;
 471     /// row of endfoot
 472     int endfoot;
 473     /// row of endlastfoot
 474     int endlastfoot;
 475     ///
 476     InsetTabular * owner_;
 477
 478     ///
 479     void Init(int columns_arg, int rows_arg);
 480     ///
 481     void Reinit();
 482     ///
 483     void set_row_column_number_info(bool oldformat=false);
 484     /// Returns true if a complete update is necessary, otherwise false
 485     bool SetWidthOfMulticolCell(int cell, int new_width);
 486     ///
 487     void recalculateMulticolCells(int cell, int new_width);
 488     /// Returns true if change
 489     bool calculate_width_of_column(int column);
 490     ///
 491     bool calculate_width_of_column_NMC(int column); // no multi cells
 492     ///
 493     void calculate_width_of_tabular();
 494     ///
 495     cellstruct * cellinfo_of_cell(int cell) const;
 496     ///
 497     void delete_column(int column);
 498     ///
 499     int cells_in_multicolumn(int cell) const;
 500     ///
 501     BoxType UseParbox(int cell) const;
 502 };
 503
 504 #endif