X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ftabular.h;h=163f33a2b746aa364181e4bd20f9b6f967078b52;hb=d4f8fe124906af839a02d1ad3b7894e14fb69a37;hp=8f4c08ec63cb1762591619c83b9c8a78a23ee5cc;hpb=69204a88fd944a5ef5b8e64480fb7235da753c86;p=lyx.git diff --git a/src/tabular.h b/src/tabular.h index 8f4c08ec63..163f33a2b7 100644 --- a/src/tabular.h +++ b/src/tabular.h @@ -1,33 +1,36 @@ // -*- 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 -#include "lyxlex.h" -#include "LString.h" -#include "insets/insettext.h" + +namespace lyx { class InsetTabular; -class LaTeXFeatures; -class Buffer; +class LCursor; +class OutputParams; -/* The features the text class offers for tables */ +/* The features the text class offers for tables */ /// class LyXTabular { @@ -43,6 +46,10 @@ public: /// DELETE_COLUMN, /// + COPY_ROW, + /// + COPY_COLUMN, + /// TOGGLE_LINE_TOP, /// TOGGLE_LINE_BOTTOM, @@ -57,11 +64,13 @@ public: /// ALIGN_CENTER, /// + ALIGN_BLOCK, + /// VALIGN_TOP, /// VALIGN_BOTTOM, /// - VALIGN_CENTER, + VALIGN_MIDDLE, /// M_TOGGLE_LINE_TOP, /// @@ -81,7 +90,7 @@ public: /// M_VALIGN_BOTTOM, /// - M_VALIGN_CENTER, + M_VALIGN_MIDDLE, /// MULTICOLUMN, /// @@ -108,12 +117,16 @@ public: SET_USEBOX, /// SET_LTHEAD, + UNSET_LTHEAD, /// SET_LTFIRSTHEAD, + UNSET_LTFIRSTHEAD, /// SET_LTFOOT, + UNSET_LTFOOT, /// SET_LTLASTFOOT, + UNSET_LTLASTFOOT, /// SET_LTNEWPAGE, /// @@ -121,6 +134,16 @@ public: /// SET_SPECIAL_MULTI, /// + SET_BOOKTABS, + /// + UNSET_BOOKTABS, + /// + SET_TOP_SPACE, + /// + SET_BOTTOM_SPACE, + /// + SET_INTERLINE_SPACE, + /// LAST_ACTION }; /// @@ -140,7 +163,7 @@ public: /// LYX_VALIGN_BOTTOM = 1, /// - LYX_VALIGN_CENTER = 2 + LYX_VALIGN_MIDDLE = 2 }; enum BoxType { @@ -152,232 +175,264 @@ public: BOX_MINIPAGE = 2 }; - /* konstruktor */ + class ltType { + public: + // 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; + }; + + /// type for row numbers + typedef size_t row_type; + /// type for column numbers + typedef size_t col_type; + /// type for cell indices + typedef size_t idx_type; + /// index indicating an invalid position + static const idx_type npos = static_cast(-1); + + /// constructor + LyXTabular(BufferParams const &, col_type columns_arg, + row_type rows_arg); + + /// Returns true if there is a topline, returns false if not + bool topLine(idx_type cell, bool wholerow = false) const; + /// Returns true if there is a topline, returns false if not + bool bottomLine(idx_type cell, bool wholerow = false) const; + /// Returns true if there is a topline, returns false if not + bool leftLine(idx_type cell, bool wholecolumn = false) const; + /// Returns true if there is a topline, returns false if not + bool rightLine(idx_type cell, bool wholecolumn = false) const; + /// - LyXTabular(InsetTabular *, int columns_arg, int rows_arg); + bool topAlreadyDrawn(idx_type cell) const; /// - LyXTabular(InsetTabular *, LyXTabular const &); + bool leftAlreadyDrawn(idx_type cell) const; /// - explicit - LyXTabular(Buffer const *, InsetTabular *, LyXLex & lex); + bool isLastRow(idx_type cell) const; + + /// return space occupied by the second horizontal line and + /// interline space above row \p row in pixels + int getAdditionalHeight(row_type row) const; /// - LyXTabular & operator=(LyXTabular const &); + int getAdditionalWidth(idx_type cell) const; + + /* returns the maximum over all rows */ /// - 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; - + int getWidthOfColumn(idx_type cell) const; /// - bool TopAlreadyDrawed(int cell) const; + int getWidthOfTabular() const; /// - bool LeftAlreadyDrawed(int cell) const; + int getAscentOfRow(row_type row) const; /// - bool IsLastRow(int cell) const; - + int getDescentOfRow(row_type row) const; /// - int GetAdditionalHeight(int row) const; + int getHeightOfTabular() const; /// - int GetAdditionalWidth(int cell) const; - - /* returns the maximum over all rows */ + void setAscentOfRow(row_type row, int height); /// - int GetWidthOfColumn(int cell) const; + void setDescentOfRow(row_type row, int height); /// - int GetWidthOfTabular() const; + void setWidthOfCell(idx_type cell, int new_width); /// - int GetAscentOfRow(int row) const; + void setAllLines(idx_type cell, bool line); /// - int GetDescentOfRow(int row) const; + void setTopLine(idx_type cell, bool line, bool wholerow = false); /// - 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, LyXAlignment align, + void setBottomLine(idx_type cell, bool line, bool wholerow = false); + /// + void setLeftLine(idx_type cell, bool line, bool wholecolumn = false); + /// + void setRightLine(idx_type cell, bool line, bool wholecolumn = false); + /// + void setAlignment(idx_type cell, LyXAlignment align, bool onlycolumn = false); - /// Returns true if a complete update is necessary, otherwise false - bool SetVAlignment(int cell, VAlignment align, + /// + void setVAlignment(idx_type cell, VAlignment align, bool onlycolumn = false); /// - bool SetColumnPWidth(int cell, string const & width); + void setColumnPWidth(LCursor &, idx_type, LyXLength const &); + /// + bool setMColumnPWidth(LCursor &, idx_type, LyXLength const &); + /// + void setAlignSpecial(idx_type cell, docstring const & special, + Feature what); /// - bool SetMColumnPWidth(int cell, string const & width); + LyXAlignment getAlignment(idx_type cell, + bool onlycolumn = false) const; /// - bool SetAlignSpecial(int cell, string const & special, Feature what); + VAlignment getVAlignment(idx_type cell, + bool onlycolumn = false) const; /// - LyXAlignment GetAlignment(int cell, bool onlycolumn = false) const; + LyXLength const getPWidth(idx_type cell) const; /// - VAlignment GetVAlignment(int cell, bool onlycolumn = false) const; + LyXLength const getColumnPWidth(idx_type cell) const; /// - string const GetPWidth(int cell) const; + LyXLength const getMColumnPWidth(idx_type cell) const; /// - string const GetColumnPWidth(int cell) const; + docstring const getAlignSpecial(idx_type cell, int what) const; /// - string const GetMColumnPWidth(int cell) const; + int getWidthOfCell(idx_type cell) const; /// - string const GetAlignSpecial(int cell, int what) const; + int getBeginningOfTextInCell(idx_type cell) const; /// - int GetWidthOfCell(int cell) const; + void appendRow(BufferParams const &, idx_type cell); /// - int GetBeginningOfTextInCell(int cell) const; + void deleteRow(row_type row); /// - void AppendRow(int cell); + void copyRow(BufferParams const &, row_type); /// - void DeleteRow(int row); + void appendColumn(BufferParams const &, idx_type cell); /// - void AppendColumn(int cell); + void deleteColumn(col_type column); /// - void DeleteColumn(int column); + void copyColumn(BufferParams const &, col_type); /// - bool IsFirstCellInRow(int cell) const; + bool isFirstCellInRow(idx_type cell) const; /// - int GetFirstCellInRow(int row) const; + idx_type getFirstCellInRow(row_type row) const; /// - bool IsLastCellInRow(int cell) const; + bool isLastCellInRow(idx_type cell) const; /// - int GetLastCellInRow(int row) const; + idx_type getLastCellInRow(row_type row) const; /// - int GetNumberOfCells() const; + idx_type getNumberOfCells() const; /// - int NumberOfCellsInRow(int cell) const; + idx_type numberOfCellsInRow(idx_type cell) const; /// - void Write(Buffer const *, std::ostream &) const; + void write(Buffer const &, std::ostream &) const; /// - void Read(Buffer const *, LyXLex &); + void read(Buffer const &, LyXLex &); /// - void OldFormatRead(LyXLex &, string const &); + int latex(Buffer const &, odocstream &, OutputParams const &) const; // - // helper function for Latex returns number of newlines + int docbook(Buffer const & buf, odocstream & os, OutputParams const &) const; /// - int TeXTopHLine(std::ostream &, int row) const; + int plaintext(Buffer const &, odocstream &, + OutputParams const & runparams, + int const depth, + bool onlydata, unsigned char delim) const; /// - int TeXBottomHLine(std::ostream &, int row) const; + bool isMultiColumn(idx_type cell) const; /// - int TeXCellPreamble(std::ostream &, int cell) const; + bool isMultiColumnReal(idx_type cell) const; /// - int TeXCellPostamble(std::ostream &, int cell) const; + void setMultiColumn(Buffer *, idx_type cell, idx_type number); /// - int Latex(Buffer const *, std::ostream &, bool, bool) const; + idx_type unsetMultiColumn(idx_type cell); // returns number of new cells /// - int DocBook(Buffer const * buf, std::ostream & os) const; + bool isPartOfMultiColumn(row_type row, col_type column) const; /// - // helper function for Latex returns number of newlines + row_type row_of_cell(idx_type cell) const; /// - int AsciiTopHLine(std::ostream &, int row, - std::vector const &) const; + col_type column_of_cell(idx_type cell) const; /// - int AsciiBottomHLine(std::ostream &, int row, - std::vector const &) const; + col_type right_column_of_cell(idx_type cell) const; /// - int AsciiPrintCell(Buffer const *, std::ostream &, - int cell, int row, int column, - std::vector const &) const; + void setBookTabs(bool); /// - int Ascii(Buffer const *, std::ostream &) const; + bool useBookTabs() const; /// - bool IsMultiColumn(int cell, bool real = false) const; + void setLongTabular(bool); /// - void SetMultiColumn(int cell, int number); + bool isLongTabular() const; /// - int UnsetMultiColumn(int cell); // returns number of new cells + void setRotateTabular(bool); /// - bool IsPartOfMultiColumn(int row, int column) const; + bool getRotateTabular() const; /// - int row_of_cell(int cell) const; + void setRotateCell(idx_type cell, bool); /// - int column_of_cell(int cell) const; + bool getRotateCell(idx_type cell) const; /// - int right_column_of_cell(int cell) const; + bool needRotating() const; /// - void SetLongTabular(bool); + bool isLastCell(idx_type cell) const; /// - bool IsLongTabular() const; + idx_type getCellAbove(idx_type cell) const; /// - void SetRotateTabular(bool); + idx_type getCellBelow(idx_type cell) const; /// - bool GetRotateTabular() const; + idx_type getLastCellAbove(idx_type cell) const; /// - void SetRotateCell(int cell, bool); + idx_type getLastCellBelow(idx_type cell) const; /// - bool GetRotateCell(int cell) const; + idx_type getCellNumber(row_type row, col_type column) const; /// - bool NeedRotating() const; + void setUsebox(idx_type cell, BoxType); /// - bool IsLastCell(int cell) const; + BoxType getUsebox(idx_type cell) const; + // + // Long Tabular Options support functions /// - int GetCellAbove(int cell) const; + bool checkLTType(row_type row, ltType const &) const; /// - int GetCellBelow(int cell) const; + void setLTHead(row_type row, bool flag, ltType const &, bool first); /// - int GetLastCellAbove(int cell) const; + bool getRowOfLTHead(row_type row, ltType &) const; /// - int GetLastCellBelow(int cell) const; + bool getRowOfLTFirstHead(row_type row, ltType &) const; /// - int GetCellNumber(int row, int column) const; + void setLTFoot(row_type row, bool flag, ltType const &, bool last); /// - void SetUsebox(int cell, BoxType); + bool getRowOfLTFoot(row_type row, ltType &) const; /// - BoxType GetUsebox(int cell) const; - // - // Long Tabular Options + bool getRowOfLTLastFoot(row_type row, ltType &) const; /// - void SetLTHead(int cell, bool first); + void setLTNewPage(row_type row, bool what); /// - bool GetRowOfLTHead(int cell, int & row) const; + bool getLTNewPage(row_type row) const; /// - bool GetRowOfLTFirstHead(int cell, int & row) const; + bool haveLTHead() const; /// - void SetLTFoot(int cell, bool last); + bool haveLTFirstHead() const; /// - bool GetRowOfLTFoot(int cell, int & row) const; + bool haveLTFoot() const; /// - bool GetRowOfLTLastFoot(int cell, int & row) const; + bool haveLTLastFoot() const; /// - void SetLTNewPage(int cell, bool what); + // end longtable support /// - bool GetLTNewPage(int cell) const; + boost::shared_ptr getCellInset(idx_type cell) const; /// - InsetText * GetCellInset(int cell) const; + boost::shared_ptr getCellInset(row_type row, + col_type column) const; /// - InsetText * GetCellInset(int row, int column) const; + void setCellInset(row_type row, col_type column, + boost::shared_ptr) const; + /// Search for \param inset in the tabular, with the /// - int rows() const { return rows_; } + idx_type getCellFromInset(InsetBase const * inset) const; /// - int columns() const { return columns_;} + row_type rows() const { return rows_; } /// - InsetTabular * owner() const { return owner_; } + col_type columns() const { return columns_;} /// - void Validate(LaTeXFeatures &) const; + void validate(LaTeXFeatures &) const; /// - std::vector const getLabelList() const; -private: +//private: /// - struct cellstruct { + class cellstruct { + public: + /// + cellstruct(BufferParams const &); + /// + cellstruct(cellstruct const &); + /// + cellstruct & operator=(cellstruct); /// - cellstruct(); + void swap(cellstruct & rhs); /// - int cellno; + idx_type cellno; /// int width_of_cell; /// @@ -399,37 +454,61 @@ private: /// bool rotate; /// - string align_special; + docstring align_special; /// - string p_width; // this is only set for multicolumn!!! + LyXLength p_width; // this is only set for multicolumn!!! /// - InsetText inset; + boost::shared_ptr inset; }; + cellstruct & cellinfo_of_cell(idx_type cell) const; /// typedef std::vector cell_vector; /// typedef std::vector cell_vvector; /// - struct rowstruct { + class rowstruct { + public: /// rowstruct(); /// - bool top_line; - /// - bool bottom_line; - /// int ascent_of_row; /// int descent_of_row; + /// + bool top_line; + /// + bool bottom_line; + /// Extra space between the top line and this row + LyXLength top_space; + /// Ignore top_space if true and use the default top space + bool top_space_default; + /// Extra space between this row and the bottom line + LyXLength bottom_space; + /// Ignore bottom_space if true and use the default bottom space + bool bottom_space_default; + /// Extra space between the bottom line and the next top line + LyXLength interline_space; + /// Ignore interline_space if true and use the default interline space + bool interline_space_default; /// 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; /// - struct columnstruct { + class columnstruct { + public: /// columnstruct(); /// @@ -443,29 +522,23 @@ private: /// int width_of_column; /// - string p_width; + LyXLength p_width; /// - string align_special; + docstring align_special; }; /// typedef std::vector column_vector; /// - void ReadNew(Buffer const * buf, std::istream & is, - LyXLex & lex, string const & l); - /// - void ReadOld(Buffer const * buf, std::istream & is, - LyXLex & lex, string const & l); + row_type rows_; /// - int rows_; + col_type columns_; /// - int columns_; + idx_type numberofcells; /// - int numberofcells; + std::vector rowofcell; /// - std::vector rowofcell; - /// - std::vector columnofcell; + std::vector columnofcell; /// row_vector row_info; /// @@ -475,46 +548,85 @@ private: /// int width_of_tabular; /// + bool use_booktabs; + /// 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, LyXTabular const * lt = 0); + /// endhead data + ltType endhead; + /// endfirsthead data + ltType endfirsthead; + /// endfoot data + ltType endfoot; + /// endlastfoot data + ltType endlastfoot; + /// - void Reinit(); + void init(BufferParams const &, row_type rows_arg, + col_type columns_arg); /// - void set_row_column_number_info(bool oldformat = false); + void set_row_column_number_info(); /// Returns true if a complete update is necessary, otherwise false - bool SetWidthOfMulticolCell(int cell, int new_width); + bool setWidthOfMulticolCell(idx_type cell, int new_width); /// - void recalculateMulticolCells(int cell, int new_width); + void recalculateMulticolumnsOfColumn(col_type column); /// Returns true if change - bool calculate_width_of_column(int column); + void calculate_width_of_column(col_type column); /// - bool calculate_width_of_column_NMC(int column); // no multi cells + bool calculate_width_of_column_NMC(col_type column); // no multi cells /// void calculate_width_of_tabular(); /// - cellstruct * cellinfo_of_cell(int cell) const; + void delete_column(col_type column); + /// + idx_type cells_in_multicolumn(idx_type cell) const; + /// + BoxType useParbox(idx_type cell) const; + /// + // helper function for Latex returns number of newlines + /// + int TeXTopHLine(odocstream &, row_type row) const; + /// + int TeXBottomHLine(odocstream &, row_type row) const; /// - void delete_column(int column); + int TeXCellPreamble(odocstream &, idx_type cell) const; /// - int cells_in_multicolumn(int cell) const; + int TeXCellPostamble(odocstream &, idx_type cell) const; /// - BoxType UseParbox(int cell) const; + int TeXLongtableHeaderFooter(odocstream &, Buffer const & buf, + OutputParams const &) const; + /// + bool isValidRow(row_type const row) const; + /// + int TeXRow(odocstream &, row_type const row, Buffer const & buf, + OutputParams const &) const; + /// + // helper functions for plain text return number of newlines + /// + int plaintextTopHLine(odocstream &, row_type row, + std::vector const &) const; + /// + int plaintextBottomHLine(odocstream &, row_type row, + std::vector const &) const; + /// + int plaintextPrintCell(Buffer const &, odocstream &, + OutputParams const &, + idx_type cell, row_type row, col_type column, + std::vector const &, + bool onlydata) const; + /// auxiliary function for docbook + int docbookRow(Buffer const & buf, odocstream & os, row_type, + OutputParams const &) const; + +private: + /// renumber cells after structural changes + void fixCellNums(); }; + +} // namespace lyx + #endif