X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ftabular.h;h=ad2818fc890180f5b12e894d999276b9cb4b65d1;hb=cd424d78530c9e38502ee7f989ef5c426c97ad61;hp=fb7a56f98e0b37251ad18e935e7a919ce7d5cbb6;hpb=4ad21513e9dfd8d0b8c557e6d850d9bf3234c1e1;p=lyx.git diff --git a/src/tabular.h b/src/tabular.h index fb7a56f98e..ad2818fc89 100644 --- a/src/tabular.h +++ b/src/tabular.h @@ -1,505 +1,569 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright 2000 The LyX Team. +/** + * \file tabular.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * @author: Jürgen Vigna + * \author Lars Gullik Bjønnes + * \author Matthias Ettrich + * \author André Pönitz + * \author Jürgen Vigna * - * ====================================================== */ + * Full author contact details are available in file CREDITS. + */ + #ifndef TABULAR_H #define TABULAR_H -#ifdef __GNUG__ -#pragma interface -#endif +#include "lyxlength.h" +#include "insets/insettext.h" #include #include -#include "lyxlex.h" -#include "LString.h" -#include "insets/insettext.h" - class InsetTabular; -class LaTeXFeatures; -class Buffer; +class OutputParams; -/* The features the text class offers for tables */ +/* The features the text class offers for tables */ /// class LyXTabular { public: - /// - enum { /// - APPEND_ROW = 0, + enum Feature { + /// + APPEND_ROW = 0, + /// + APPEND_COLUMN, + /// + DELETE_ROW, + /// + DELETE_COLUMN, + /// + TOGGLE_LINE_TOP, + /// + TOGGLE_LINE_BOTTOM, + /// + TOGGLE_LINE_LEFT, + /// + TOGGLE_LINE_RIGHT, + /// + ALIGN_LEFT, + /// + ALIGN_RIGHT, + /// + ALIGN_CENTER, + /// + ALIGN_BLOCK, + /// + VALIGN_TOP, + /// + VALIGN_BOTTOM, + /// + VALIGN_MIDDLE, + /// + M_TOGGLE_LINE_TOP, + /// + M_TOGGLE_LINE_BOTTOM, + /// + M_TOGGLE_LINE_LEFT, + /// + M_TOGGLE_LINE_RIGHT, + /// + M_ALIGN_LEFT, + /// + M_ALIGN_RIGHT, + /// + M_ALIGN_CENTER, + /// + M_VALIGN_TOP, + /// + M_VALIGN_BOTTOM, + /// + M_VALIGN_MIDDLE, + /// + MULTICOLUMN, + /// + SET_ALL_LINES, + /// + UNSET_ALL_LINES, + /// + SET_LONGTABULAR, + /// + UNSET_LONGTABULAR, + /// + SET_PWIDTH, + /// + SET_MPWIDTH, + /// + SET_ROTATE_TABULAR, + /// + UNSET_ROTATE_TABULAR, + /// + SET_ROTATE_CELL, + /// + UNSET_ROTATE_CELL, + /// + SET_USEBOX, + /// + SET_LTHEAD, + UNSET_LTHEAD, + /// + SET_LTFIRSTHEAD, + UNSET_LTFIRSTHEAD, + /// + SET_LTFOOT, + UNSET_LTFOOT, + /// + SET_LTLASTFOOT, + UNSET_LTLASTFOOT, + /// + SET_LTNEWPAGE, + /// + SET_SPECIAL_COLUMN, + /// + SET_SPECIAL_MULTI, + /// + LAST_ACTION + }; + /// + enum { + /// + CELL_NORMAL = 0, + /// + CELL_BEGIN_OF_MULTICOLUMN, + /// + CELL_PART_OF_MULTICOLUMN + }; + /// - APPEND_COLUMN, + enum VAlignment { + /// + LYX_VALIGN_TOP = 0, + /// + LYX_VALIGN_BOTTOM = 1, + /// + LYX_VALIGN_MIDDLE = 2 + }; + + enum BoxType { + /// + BOX_NONE = 0, + /// + BOX_PARBOX = 1, + /// + BOX_MINIPAGE = 2 + }; + + struct ltType { + // constructor + ltType(); + // we have this header type (is set in the getLT... functions) + bool set; + // double borders on top + bool topDL; + // double borders on bottom + bool bottomDL; + // used for FirstHeader & LastFooter and if this is true + // all the rows marked as FirstHeader or LastFooter are + // ignored in the output and it is set to be empty! + bool empty; + }; + + /// constructor + LyXTabular(BufferParams const &, int columns_arg, int rows_arg); /// - DELETE_ROW, + void setOwner(InsetTabular * inset); + + /// Returns true if there is a topline, returns false if not + bool topLine(int cell, bool onlycolumn = false) const; + /// Returns true if there is a topline, returns false if not + bool bottomLine(int cell, bool onlycolumn = false) const; + /// Returns true if there is a topline, returns false if not + bool leftLine(int cell, bool onlycolumn = false) const; + /// Returns true if there is a topline, returns false if not + bool rightLine(int cell, bool onlycolumn = false) const; + + /// + bool topAlreadyDrawn(int cell) const; + /// + bool leftAlreadyDrawn(int cell) const; /// - DELETE_COLUMN, + bool isLastRow(int cell) const; + /// - TOGGLE_LINE_TOP, + int getAdditionalHeight(int row) const; /// - TOGGLE_LINE_BOTTOM, + int getAdditionalWidth(int cell) const; + + /* returns the maximum over all rows */ /// - TOGGLE_LINE_LEFT, + int getWidthOfColumn(int cell) const; /// - TOGGLE_LINE_RIGHT, + int getWidthOfTabular() const; /// - ALIGN_LEFT, + int getAscentOfRow(int row) const; /// - ALIGN_RIGHT, + int getDescentOfRow(int row) const; /// - ALIGN_CENTER, + int getHeightOfTabular() const; + /// Returns true if a complete update is necessary, otherwise false + void setAscentOfRow(int row, int height); + /// Returns true if a complete update is necessary, otherwise false + void setDescentOfRow(int row, int height); + /// Returns true if a complete update is necessary, otherwise false + void setWidthOfCell(int cell, int new_width); /// - VALIGN_TOP, + void setAllLines(int cell, bool line); /// - VALIGN_BOTTOM, + void setTopLine(int cell, bool line, bool onlycolumn = false); /// - VALIGN_CENTER, + void setBottomLine(int cell, bool line, bool onlycolumn = false); /// - M_TOGGLE_LINE_TOP, + void setLeftLine(int cell, bool line, bool onlycolumn = false); /// - M_TOGGLE_LINE_BOTTOM, + void setRightLine(int cell, bool line, bool onlycolumn = false); /// - M_TOGGLE_LINE_LEFT, + void setAlignment(int cell, LyXAlignment align, + bool onlycolumn = false); /// - M_TOGGLE_LINE_RIGHT, + void setVAlignment(int cell, VAlignment align, + bool onlycolumn = false); /// - M_ALIGN_LEFT, + void setColumnPWidth(int cell, LyXLength const & width); /// - M_ALIGN_RIGHT, + bool setMColumnPWidth(int cell, LyXLength const & width); /// - M_ALIGN_CENTER, + void setAlignSpecial(int cell, std::string const & special, Feature what); /// - M_VALIGN_TOP, + LyXAlignment getAlignment(int cell, bool onlycolumn = false) const; /// - M_VALIGN_BOTTOM, + VAlignment getVAlignment(int cell, bool onlycolumn = false) const; /// - M_VALIGN_CENTER, + LyXLength const getPWidth(int cell) const; /// - DELETE_TABULAR, + LyXLength const getColumnPWidth(int cell) const; /// - MULTICOLUMN, + LyXLength const getMColumnPWidth(int cell) const; /// - SET_ALL_LINES, + std::string const getAlignSpecial(int cell, int what) const; /// - UNSET_ALL_LINES, + int getWidthOfCell(int cell) const; /// - SET_LONGTABULAR, + int getBeginningOfTextInCell(int cell) const; /// - UNSET_LONGTABULAR, + void appendRow(BufferParams const &, int cell); /// - SET_PWIDTH, + void deleteRow(int row); /// - SET_MPWIDTH, + void appendColumn(BufferParams const &, int cell); /// - SET_ROTATE_TABULAR, + void deleteColumn(int column); /// - UNSET_ROTATE_TABULAR, + bool isFirstCellInRow(int cell) const; /// - SET_ROTATE_CELL, + int getFirstCellInRow(int row) const; /// - UNSET_ROTATE_CELL, + bool isLastCellInRow(int cell) const; /// - SET_USEBOX, + int getLastCellInRow(int row) const; /// - SET_LTHEAD, + int getNumberOfCells() const; /// - SET_LTFIRSTHEAD, + int numberOfCellsInRow(int cell) const; /// - SET_LTFOOT, + void write(Buffer const &, std::ostream &) const; /// - SET_LTLASTFOOT, + void read(Buffer const &, LyXLex &); /// - SET_LTNEWPAGE, + int latex(Buffer const &, std::ostream &, + OutputParams const &) const; + // + int linuxdoc(Buffer const & buf, std::ostream & os, + OutputParams const &) const; /// - SET_SPECIAL_COLUMN, + int docbook(Buffer const & buf, std::ostream & os, + OutputParams const &) const; /// - SET_SPECIAL_MULTI, + int plaintext(Buffer const &, std::ostream &, + OutputParams const & runparams, + int const depth, + bool onlydata, unsigned char delim) const; /// - LAST_ACTION - }; - /// - enum { + bool isMultiColumn(int cell) const; /// - CELL_NORMAL = 0, + bool isMultiColumnReal(int cell) const; /// - CELL_BEGIN_OF_MULTICOLUMN, + void setMultiColumn(Buffer *, int cell, int number); /// - CELL_PART_OF_MULTICOLUMN - }; - - /// - enum VAlignment { + int unsetMultiColumn(int cell); // returns number of new cells /// - LYX_VALIGN_TOP = 0, + bool isPartOfMultiColumn(int row, int column) const; /// - LYX_VALIGN_BOTTOM = 1, + int row_of_cell(int cell) const; /// - LYX_VALIGN_CENTER = 2 - }; - - enum BoxType { + int column_of_cell(int cell) const; + /// + int right_column_of_cell(int cell) const; + /// + void setLongTabular(bool); + /// + bool isLongTabular() const; + /// + void setRotateTabular(bool); + /// + bool getRotateTabular() const; + /// + void setRotateCell(int cell, bool); + /// + bool getRotateCell(int cell) const; + /// + bool needRotating() const; + /// + bool isLastCell(int cell) const; + /// + int getCellAbove(int cell) const; + /// + int getCellBelow(int cell) const; + /// + int getLastCellAbove(int cell) const; + /// + int getLastCellBelow(int cell) const; + /// + int getCellNumber(int row, int column) const; + /// + void setUsebox(int cell, BoxType); + /// + BoxType getUsebox(int cell) const; + // + // Long Tabular Options support functions /// - BOX_NONE = 0, + bool checkLTType(int row, ltType const &) const; /// - BOX_PARBOX = 1, + void setLTHead(int row, bool flag, ltType const &, bool first); /// - BOX_MINIPAGE = 2 - }; + bool getRowOfLTHead(int row, ltType &) const; + /// + bool getRowOfLTFirstHead(int row, ltType &) const; + /// + void setLTFoot(int row, bool flag, ltType const &, bool last); + /// + bool getRowOfLTFoot(int row, ltType &) const; + /// + bool getRowOfLTLastFoot(int row, ltType &) const; + /// + void setLTNewPage(int row, bool what); + /// + bool getLTNewPage(int row) const; + /// + bool haveLTHead() const; + /// + bool haveLTFirstHead() const; + /// + bool haveLTFoot() const; + /// + bool haveLTLastFoot() const; + /// + // end longtable support + /// + InsetText & getCellInset(int cell) const; + /// + InsetText & getCellInset(int row, int column) const; + /// Search for \param inset in the tabular, with the + /// + int getCellFromInset(InsetOld const * inset) const; + /// + int rows() const { return rows_; } + /// + int columns() const { return columns_;} + /// + void validate(LaTeXFeatures &) const; + /// Appends \c list with all labels found within this inset. + void getLabelList(Buffer const &, std::vector & list) const; + /// +//private: + /// + struct cellstruct { + /// + cellstruct(BufferParams const &); + /// + int cellno; + /// + int width_of_cell; + /// + int multicolumn; + /// + LyXAlignment alignment; + /// + VAlignment valignment; + /// + bool top_line; + /// + bool bottom_line; + /// + bool left_line; + /// + bool right_line; + /// + BoxType usebox; + /// + bool rotate; + /// + std::string align_special; + /// + LyXLength p_width; // this is only set for multicolumn!!! + /// + InsetText inset; + }; + cellstruct & cellinfo_of_cell(int cell) const; + /// + typedef std::vector cell_vector; + /// + typedef std::vector cell_vvector; - /* konstruktor */ - /// - LyXTabular(InsetTabular *, int columns_arg, int rows_arg); - /// - LyXTabular(InsetTabular *, LyXTabular const &); - /// - explicit - LyXTabular(Buffer const *, InsetTabular *, LyXLex & lex); - /// - ~LyXTabular(); - /// - LyXTabular & operator=(LyXTabular const &); - /// - LyXTabular * Clone(InsetTabular *); - - /// Returns true if there is a topline, returns false if not - bool TopLine(int cell, bool onlycolumn=false) const; - /// Returns true if there is a topline, returns false if not - bool BottomLine(int cell, bool onlycolumn=false) const; - /// Returns true if there is a topline, returns false if not - bool LeftLine(int cell, bool onlycolumn=false) const; - /// Returns true if there is a topline, returns false if not - bool RightLine(int cell, bool onlycolumn=false) const; - - /// - bool TopAlreadyDrawed(int cell) const; - /// - bool LeftAlreadyDrawed(int cell) const; - /// - bool IsLastRow(int cell) const; - - /// - int GetAdditionalHeight(int cell) const; - /// - int GetAdditionalWidth(int cell) const; - - /* returns the maximum over all rows */ - /// - int GetWidthOfColumn(int cell) const; - /// - int GetWidthOfTabular() const; - /// - int GetAscentOfRow(int row) const; - /// - int GetDescentOfRow(int row) const; - /// - int GetHeightOfTabular() const; - /// Returns true if a complete update is necessary, otherwise false - bool SetAscentOfRow(int row, int height); - /// Returns true if a complete update is necessary, otherwise false - bool SetDescentOfRow(int row, int height); - /// Returns true if a complete update is necessary, otherwise false - bool SetWidthOfCell(int cell, int new_width); - /// Returns true if a complete update is necessary, otherwise false - bool SetAllLines(int cell, bool line); - /// Returns true if a complete update is necessary, otherwise false - bool SetTopLine(int cell, bool line, bool onlycolumn=false); - /// Returns true if a complete update is necessary, otherwise false - bool SetBottomLine(int cell, bool line, bool onlycolumn=false); - /// Returns true if a complete update is necessary, otherwise false - bool SetLeftLine(int cell, bool line, bool onlycolumn=false); - /// Returns true if a complete update is necessary, otherwise false - bool SetRightLine(int cell, bool line, bool onlycolumn=false); - /// Returns true if a complete update is necessary, otherwise false - bool SetAlignment(int cell, char align, bool onlycolumn = false); - /// Returns true if a complete update is necessary, otherwise false - bool SetVAlignment(int cell, char align, bool onlycolumn = false); - /// - bool SetColumnPWidth(int cell, string const & width); - /// - bool SetMColumnPWidth(int cell, string const & width); - /// - bool SetAlignSpecial(int cell, string const & special, int what); - /// - char GetAlignment(int cell, bool onlycolumn = false) const; - /// - char GetVAlignment(int cell, bool onlycolumn = false) const; - /// - string GetPWidth(int cell) const; - /// - string GetColumnPWidth(int cell) const; - /// - string GetMColumnPWidth(int cell) const; - /// - string GetAlignSpecial(int cell, int what) const; - /// - int GetWidthOfCell(int cell) const; - /// - int GetBeginningOfTextInCell(int cell) const; - /// - void AppendRow(int cell); - /// - void DeleteRow(int cell); - /// - void AppendColumn(int cell); - /// - void DeleteColumn(int cell); - /// - bool IsFirstCellInRow(int cell) const; - /// - int GetFirstCellInRow(int row) const; - /// - bool IsLastCellInRow(int cell) const; - /// - int GetLastCellInRow(int row) const; - /// - int GetNumberOfCells() const; - /// - int NumberOfCellsInRow(int cell) const; - /// - void Write(Buffer const *, std::ostream &) const; - /// - void Read(Buffer const *, LyXLex &); - /// - void OldFormatRead(LyXLex &, string const &); - // - // helper function for Latex returns number of newlines - /// - int TeXTopHLine(std::ostream &, int row) const; - /// - int TeXBottomHLine(std::ostream &, int row) const; - /// - int TeXCellPreamble(std::ostream &, int cell) const; - /// - int TeXCellPostamble(std::ostream &, int cell) const; - /// - int Latex(Buffer const *, std::ostream &, bool, bool) const; - /// - int DocBookEndOfCell(std::ostream &, int cell, int & depth) const; -#if 0 - /// - int RoffEndOfCell(std::ostream &, int cell); -#endif - /// - char const * GetDocBookAlign(int cell, bool isColumn = false) const; + /// + struct rowstruct { + /// + rowstruct(); + /// + int ascent_of_row; + /// + int descent_of_row; + /// + bool top_line; + /// + bool bottom_line; + /// This are for longtabulars only + /// a row of endhead + bool endhead; + /// a row of endfirsthead + bool endfirsthead; + /// a row of endfoot + bool endfoot; + /// row of endlastfoot + bool endlastfoot; + /// row for a pagebreak + bool newpage; + }; + /// + typedef std::vector row_vector; - /// - bool IsMultiColumn(int cell, bool real = false) const; - /// - void SetMultiColumn(int cell, int number); - /// - int UnsetMultiColumn(int cell); // returns number of new cells - /// - bool IsPartOfMultiColumn(int row, int column) const; - /// - int row_of_cell(int cell) const; - /// - int column_of_cell(int cell) const; - /// - int right_column_of_cell(int cell) const; - /// - void SetLongTabular(int what); - /// - bool IsLongTabular() const; - /// - void SetRotateTabular(bool); - /// - bool GetRotateTabular() const; - /// - void SetRotateCell(int cell, bool); - /// - bool GetRotateCell(int cell) const; - /// - bool NeedRotating() const; - /// - bool IsLastCell(int cell) const; - /// - int GetCellAbove(int cell) const; - /// - int GetCellBelow(int cell) const; - /// - int GetLastCellAbove(int cell) const; - /// - int GetLastCellBelow(int cell) const; - /// - int GetCellNumber(int row, int column) const; - /// - void SetUsebox(int cell, BoxType); - /// - int GetUsebox(int cell) const; - // - // Long Tabular Options - /// - void SetLTHead(int cell, bool first); - /// - bool GetRowOfLTHead(int cell, int & row) const; - /// - bool GetRowOfLTFirstHead(int cell, int & row) const; - /// - void SetLTFoot(int cell, bool last); - /// - bool GetRowOfLTFoot(int cell, int & row) const; - /// - bool GetRowOfLTLastFoot(int cell, int & row) const; - /// - void SetLTNewPage(int cell, bool what); - /// - bool GetLTNewPage(int cell) const; - /// - InsetText * GetCellInset(int cell) const; - /// - int rows() const { return rows_; } - /// - int columns() const { return columns_;} - /// - InsetTabular * owner() const { return owner_; } - /// - void Validate(LaTeXFeatures &) const; + /// + struct columnstruct { + /// + columnstruct(); + /// + LyXAlignment alignment; + /// + VAlignment valignment; + /// + bool left_line; + /// + bool right_line; + /// + int width_of_column; + /// + LyXLength p_width; + /// + std::string align_special; + }; + /// + typedef std::vector column_vector; -private: ////////////////////////////////////////////////////////////////// - /// - struct cellstruct { /// - cellstruct(); + int rows_; /// - int cellno; + int columns_; /// - int width_of_cell; + int numberofcells; /// - int multicolumn; + std::vector rowofcell; /// - int alignment; + std::vector columnofcell; /// - int valignment; + row_vector row_info; /// - bool top_line; + column_vector column_info; /// - bool bottom_line; + mutable cell_vvector cell_info; /// - bool left_line; + int width_of_tabular; /// - bool right_line; + bool rotate; + // + // for long tabulars + // + bool is_long_tabular; + /// endhead data + ltType endhead; + /// endfirsthead data + ltType endfirsthead; + /// endfoot data + ltType endfoot; + /// endlastfoot data + ltType endlastfoot; + /// - int usebox; + void init(BufferParams const &, int rows_arg, int columns_arg); /// - bool rotate; + void set_row_column_number_info(); + /// Returns true if a complete update is necessary, otherwise false + bool setWidthOfMulticolCell(int cell, int new_width); /// - string align_special; + void recalculateMulticolumnsOfColumn(int column); + /// Returns true if change + void calculate_width_of_column(int column); /// - string p_width; // this is only set for multicolumn!!! + bool calculate_width_of_column_NMC(int column); // no multi cells /// - InsetText inset; - }; - /// - typedef std::vector cell_vector; - /// - typedef std::vector cell_vvector; - - /// - struct rowstruct { + void calculate_width_of_tabular(); /// - rowstruct(); + void delete_column(int column); /// - bool top_line; + int cells_in_multicolumn(int cell) const; /// - bool bottom_line; + BoxType useParbox(int cell) const; /// - int ascent_of_row; + void setHeaderFooterRows(int header, int fheader, int footer, int lfooter); /// - int descent_of_row; - /// This are for longtabulars only - bool newpage; - }; - /// - typedef std::vector row_vector; - - /// - struct columnstruct { + // helper function for Latex returns number of newlines + /// + int TeXTopHLine(std::ostream &, int row) const; + /// + int TeXBottomHLine(std::ostream &, int row) const; + /// + int TeXCellPreamble(std::ostream &, int cell) const; /// - columnstruct(); + int TeXCellPostamble(std::ostream &, int cell) const; /// - int alignment; + int TeXLongtableHeaderFooter(std::ostream &, Buffer const & buf, + OutputParams const &) const; /// - int valignment; + bool isValidRow(int const row) const; /// - bool left_line; + int TeXRow(std::ostream &, int const row, Buffer const & buf, + OutputParams const &) const; /// - bool right_line; + // helper function for ASCII returns number of newlines /// - int width_of_column; + int asciiTopHLine(std::ostream &, int row, + std::vector const &) const; /// - string p_width; + int asciiBottomHLine(std::ostream &, int row, + std::vector const &) const; /// - string align_special; - }; - /// - typedef std::vector column_vector; + int asciiPrintCell(Buffer const &, std::ostream &, + OutputParams const &, + int cell, int row, int column, + std::vector const &, + bool onlydata) const; + /// auxiliary function for docbook + int docbookRow(Buffer const & buf, std::ostream & os, int, + OutputParams const &) const; - /// - int rows_; - /// - int columns_; - /// - int numberofcells; - /// - int * rowofcell; - /// - int * columnofcell; - /// - row_vector row_info; - /// - column_vector column_info; - /// - mutable cell_vvector cell_info; - /// - int width_of_tabular; - /// - bool rotate; - // - // for long tabulars - /// - bool is_long_tabular; - /// row of endhead - int endhead; - /// row of endfirsthead - int endfirsthead; - /// row of endfoot - int endfoot; - /// row of endlastfoot - int endlastfoot; - /// - InsetTabular * owner_; - - /// - void Init(int columns_arg, int rows_arg); - /// - void Reinit(); - /// - void set_row_column_number_info(); - /// Returns true if a complete update is necessary, otherwise false - bool SetWidthOfMulticolCell(int cell, int new_width); - void recalculateMulticolCells(int cell, int new_width); - /// Returns true if change - bool calculate_width_of_column(int column); - /// - bool calculate_width_of_column_NMC(int column); // no multi cells - /// - void calculate_width_of_tabular(); - /// - cellstruct * cellinfo_of_cell(int cell) const; - /// - void delete_column(int column); - /// - int cells_in_multicolumn(int cell) const; - /// - bool UseParbox(int cell) const; +private: + /// renumber cells after structural changes + void fixCellNums(); }; #endif