4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Matthias Ettrich
10 * \author Jürgen Vigna
11 * \author Edwin Leuven
13 * \author Scott Kostyshak
15 * Full author contact details are available in file CREDITS.
18 // Things to think of when designing the new tabular support:
19 // - color support (colortbl, color)
20 // - decimal alignment (dcloumn)
21 // - custom lines (hhline)
24 #ifndef INSET_TABULAR_H
25 #define INSET_TABULAR_H
27 #include "InsetText.h"
51 class InsetTableCell : public InsetText
55 InsetTableCell(Buffer * buf);
57 InsetCode lyxCode() const { return CELL_CODE; }
59 Inset * clone() const { return new InsetTableCell(*this); }
61 bool getStatus(Cursor & cur, FuncRequest const & cmd,
62 FuncStatus & status) const;
64 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
66 void toggleMultiCol(bool m) { isMultiColumn = m; }
68 void toggleMultiRow(bool m) { isMultiRow = m; }
70 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
71 /// writes the contents of the cell as a string, optionally
72 /// descending into insets
73 docstring asString(bool intoInsets = true);
75 docstring xhtml(XHTMLStream &, OutputParams const &) const;
77 void addToToc(DocIterator const & di, bool output_active,
78 UpdateType utype, TocBackend & backend) const;
80 void metrics(MetricsInfo &, Dimension &) const;
85 void operator=(InsetTableCell const &);
87 // These booleans are supposed to track whether the cell has had its
88 // width explicitly set and whether it is part of a multicolumn, respectively.
89 // We need to know this to determine whether
90 // layout changes and paragraph customization are allowed---that is,
91 // we need it in forcePlainLayout() and allowParagraphCustomization().
92 // Unfortunately, that information is not readily available in
93 // InsetTableCell. In the case of multicolumn cells, it is present
94 // in CellData, and so would be available here if CellData were to
95 // become a member of InsetTableCell. But in the other case, it isn't
96 // even available there, but is held in Tabular::ColumnData.
97 // So, the present solution uses this boolean to track the information
98 // we need to track, and tries to keep it updated. This is not ideal,
99 // but the other solutions are no better. These are:
100 // (i) Keep a pointer in InsetTableCell to the table;
101 // (ii) Find the table by iterating over the Buffer's insets.
102 // Solution (i) raises the problem of updating the pointer when an
103 // InsetTableCell is copied, and we'd therefore need a copy constructor
104 // in InsetTabular and then in Tabular, which seems messy, given how
105 // complicated those classes are. Solution (ii) involves a lot of
106 // iterating, since this information is needed quite often, and so may
108 // So, well, if someone can do better, please do!
116 // FIXME: Here the thoughts from the comment above also apply.
118 LyXAlignment contentAlign;
119 /// should paragraph indendation be omitted in any case?
120 bool neverIndent() const { return true; }
122 LyXAlignment contentAlignment() const { return contentAlign; }
124 virtual bool usePlainLayout() const { return true; }
126 virtual bool forcePlainLayout(idx_type = 0) const;
128 virtual bool allowParagraphCustomization(idx_type = 0) const;
130 virtual bool forceLocalFontSwitch() const;
131 /// Is the width forced to some value?
132 bool hasFixedWidth() const { return isFixedWidth; }
133 /// Can the cell contain several paragraphs?
134 bool allowMultiPar() const { return !isMultiRow && (!isMultiColumn || isFixedWidth); }
139 // A helper struct for tables
226 RESET_FORMAL_DEFAULT,
240 TOGGLE_VARWIDTH_COLUMN,
244 UNSET_ROTATE_TABULAR,
246 TOGGLE_ROTATE_TABULAR,
279 SET_SPECIAL_MULTICOLUMN,
297 TABULAR_VALIGN_MIDDLE,
299 TABULAR_VALIGN_BOTTOM,
301 LONGTABULAR_ALIGN_LEFT,
303 LONGTABULAR_ALIGN_CENTER,
305 LONGTABULAR_ALIGN_RIGHT,
320 CELL_BEGIN_OF_MULTICOLUMN,
322 CELL_PART_OF_MULTICOLUMN,
324 CELL_BEGIN_OF_MULTIROW,
326 CELL_PART_OF_MULTIROW
334 LYX_VALIGN_MIDDLE = 1,
336 LYX_VALIGN_BOTTOM = 2
342 LYX_LONGTABULAR_ALIGN_LEFT = 0,
344 LYX_LONGTABULAR_ALIGN_CENTER = 1,
346 LYX_LONGTABULAR_ALIGN_RIGHT = 2
387 // we have this header type (is set in the getLT... functions)
389 // double borders on top
391 // double borders on bottom
393 // used for FirstHeader & LastFooter and if this is true
394 // all the rows marked as FirstHeader or LastFooter are
395 // ignored in the output and it is set to be empty!
399 /// type for row numbers
400 typedef size_t row_type;
401 /// type for column numbers
402 typedef size_t col_type;
403 /// type for cell indices
404 typedef size_t idx_type;
405 /// index indicating an invalid position
406 static const idx_type npos = static_cast<idx_type>(-1);
409 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
411 /// Returns true if there is a topline, returns false if not
412 bool topLine(idx_type cell) const;
413 /// Returns true if there is a topline, returns false if not
414 bool bottomLine(idx_type cell) const;
415 /// Returns true if there is a topline, returns false if not
416 /// If \p ignore_bt is true, we return the state as if booktabs was
418 bool leftLine(idx_type cell, bool const ignore_bt = false) const;
419 /// Returns true if there is a topline, returns false if not
420 /// If \p ignore_bt is true, we return the state as if booktabs was
422 bool rightLine(idx_type cell, bool const ignore_bt = false) const;
424 /// return space occupied by the second horizontal line and
425 /// interline space above row \p row in pixels
426 int interRowSpace(row_type row) const;
428 int interColumnSpace(idx_type cell) const;
430 /* returns the maximum over all rows */
432 int cellWidth(idx_type cell) const;
434 int cellHeight(idx_type cell) const;
440 row_type nrows() const {return row_info.size();}
442 col_type ncols() const {return column_info.size();}
444 int rowAscent(row_type row) const;
446 int rowDescent(row_type row) const;
448 void setRowAscent(row_type row, int height);
450 void setRowDescent(row_type row, int height);
452 void setTopLine(idx_type cell, bool line);
454 void setBottomLine(idx_type cell, bool line);
456 void setLeftLine(idx_type cell, bool line);
458 void setRightLine(idx_type cell, bool line);
460 bool rowTopLine(row_type row) const;
462 bool rowBottomLine(row_type row) const;
464 bool columnLeftLine(col_type column) const;
466 bool columnRightLine(col_type column) const;
468 void setAlignment(idx_type cell, LyXAlignment align,
469 bool onlycolumn = false);
471 void setVAlignment(idx_type cell, VAlignment align,
472 bool onlycolumn = false);
474 void setTabularWidth(Length const & l) { tabular_width = l; }
476 Length tabularWidth() const { return tabular_width; }
478 void setColumnPWidth(Cursor &, idx_type, Length const &);
480 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
482 bool toggleVarwidth(idx_type, bool const);
484 bool setMROffset(Cursor &, idx_type, Length const &);
486 void setAlignSpecial(idx_type cell, docstring const & special,
489 LyXAlignment getAlignment(idx_type cell,
490 bool onlycolumn = false) const;
492 VAlignment getVAlignment(idx_type cell,
493 bool onlycolumn = false) const;
494 /// The vertical offset of the table due to the vertical
495 /// alignment with respect to the baseline.
496 int offsetVAlignment() const;
498 Length const getPWidth(idx_type cell) const;
500 Length const getMROffset(idx_type cell) const;
502 int textHOffset(idx_type cell) const;
504 int textVOffset(idx_type cell) const;
506 void appendRow(row_type row);
508 void deleteRow(row_type row);
510 void copyRow(row_type row);
512 void insertRow(row_type row, bool copy);
514 void moveColumn(col_type col, ColDirection direction);
516 void moveRow(row_type row, RowDirection direction);
518 void appendColumn(col_type column);
520 void deleteColumn(col_type column);
522 void copyColumn(col_type column);
524 void insertColumn(col_type column, bool copy);
526 idx_type getFirstCellInRow(row_type row) const;
528 idx_type getLastCellInRow(row_type row) const;
530 idx_type numberOfCellsInRow(row_type row) const;
532 void write(std::ostream &) const;
536 void latex(otexstream &, OutputParams const &) const;
538 int docbook(odocstream & os, OutputParams const &) const;
540 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
542 void plaintext(odocstringstream &,
543 OutputParams const & runparams, int const depth,
544 bool onlydata, char_type delim, size_t max_length = INT_MAX) const;
546 bool isMultiColumn(idx_type cell) const;
548 bool hasMultiColumn(col_type cell) const;
550 bool hasVarwidthColumn() const;
552 bool isVTypeColumn(col_type cell) const;
554 idx_type setMultiColumn(Cursor & cur, idx_type cell, idx_type number,
555 bool const right_border);
557 void unsetMultiColumn(idx_type cell);
559 bool isPartOfMultiColumn(row_type row, col_type column) const;
561 bool isPartOfMultiRow(row_type row, col_type column) const;
563 bool isMultiRow(idx_type cell) const;
565 bool hasMultiRow(row_type r) const;
567 idx_type setMultiRow(Cursor & cur, idx_type cell, idx_type number,
568 bool const bottom_border,
569 LyXAlignment const halign);
571 void unsetMultiRow(idx_type cell);
573 row_type cellRow(idx_type cell) const;
575 col_type cellColumn(idx_type cell) const;
577 void setRotateCell(idx_type cell, int);
579 int getRotateCell(idx_type cell) const;
581 bool needRotating() const;
583 bool isLastCell(idx_type cell) const;
585 idx_type cellAbove(idx_type cell) const;
587 idx_type cellBelow(idx_type cell) const;
588 /// \return the index of the VISIBLE cell at row, column
589 /// this will be the same as the cell in the previous row,
590 /// e.g., if the cell is part of a multirow
591 idx_type cellIndex(row_type row, col_type column) const;
593 void setUsebox(idx_type cell, BoxType);
595 BoxType getUsebox(idx_type cell) const;
597 // Long Tabular Options support functions
599 void setLTHead(row_type row, bool flag, ltType const &, bool first);
601 bool getRowOfLTHead(row_type row, ltType &) const;
603 bool getRowOfLTFirstHead(row_type row, ltType &) const;
605 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
607 bool getRowOfLTFoot(row_type row, ltType &) const;
609 bool getRowOfLTLastFoot(row_type row, ltType &) const;
611 void setLTNewPage(row_type row, bool what);
613 bool getLTNewPage(row_type row) const;
615 idx_type setLTCaption(Cursor & cur, row_type row, bool what);
617 bool ltCaption(row_type row) const;
619 bool haveLTHead(bool withcaptions = true) const;
621 bool haveLTFirstHead(bool withcaptions = true) const;
623 bool haveLTFoot(bool withcaptions = true) const;
625 bool haveLTLastFoot(bool withcaptions = true) const;
627 bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
629 // end longtable support
632 /// there is a subtle difference between these two methods.
635 /// cellInset(cellIndex(r,c));
636 /// can return different things. this is because cellIndex(r,c)
637 /// returns the VISIBLE cell at r,c, which may be the same as the
638 /// cell at the previous row or column, if we're dealing with some
639 /// multirow or multicell.
640 std::shared_ptr<InsetTableCell> cellInset(idx_type cell);
641 std::shared_ptr<InsetTableCell> cellInset(row_type row, col_type column);
642 InsetTableCell const * cellInset(idx_type cell) const;
645 void setCellInset(row_type row, col_type column,
646 std::shared_ptr<InsetTableCell>);
647 /// Search for \param inset in the tabular, with the
649 void validate(LaTeXFeatures &) const;
652 // FIXME Now that cells have an InsetTableCell as their insets, rather
653 // than an InsetText, it'd be possible to reverse the relationship here,
654 // so that cell_vector was a vector<InsetTableCell> rather than a
655 // vector<CellData>, and an InsetTableCell had a CellData as a member,
656 // or perhaps just had its members as members.
663 CellData(CellData const &);
665 CellData & operator=(CellData const &);
677 LyXAlignment alignment;
679 VAlignment valignment;
680 /// width of the part before the decimal
682 /// width of the decimal part
699 docstring align_special;
701 Length p_width; // this is only set for multicolumn!!!
703 std::shared_ptr<InsetTableCell> inset;
706 CellData const & cellInfo(idx_type cell) const;
708 CellData & cellInfo(idx_type cell);
710 typedef std::vector<CellData> cell_vector;
712 typedef std::vector<cell_vector> cell_vvector;
723 /// Extra space between the top line and this row
725 /// Ignore top_space if true and use the default top space
726 bool top_space_default;
727 /// Extra space between this row and the bottom line
729 /// Ignore bottom_space if true and use the default bottom space
730 bool bottom_space_default;
731 /// Extra space between the bottom line and the next top line
732 Length interline_space;
733 /// Ignore interline_space if true and use the default interline space
734 bool interline_space_default;
735 /// This are for longtabulars only
738 /// a row of endfirsthead
742 /// row of endlastfoot
744 /// row for a newpage
750 typedef std::vector<RowData> row_vector;
758 LyXAlignment alignment;
760 VAlignment valignment;
766 docstring align_special;
768 docstring decimal_point;
773 typedef std::vector<ColumnData> column_vector;
776 idx_type numberofcells;
778 std::vector<row_type> rowofcell;
780 std::vector<col_type> columnofcell;
784 column_vector column_info;
786 cell_vvector cell_info;
788 Length tabular_width;
794 VAlignment tabular_valignment;
798 HAlignment longtabular_alignment;
800 bool is_long_tabular;
803 /// endfirsthead data
811 void init(Buffer *, row_type rows_arg,
812 col_type columns_arg);
814 void updateIndexes();
816 bool setFixedWidth(row_type r, col_type c);
817 /// return true of update is needed
818 bool updateColumnWidths(MetricsInfo & mi);
820 idx_type columnSpan(idx_type cell) const;
822 idx_type rowSpan(idx_type cell) const;
824 BoxType useBox(idx_type cell) const;
826 // helper function for Latex
828 void TeXTopHLine(otexstream &, row_type row, std::string const & lang,
829 std::list<col_type>) const;
831 void TeXBottomHLine(otexstream &, row_type row, std::string const & lang,
832 std::list<col_type>) const;
834 void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow,
835 bool const bidi) const;
837 void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
839 void TeXLongtableHeaderFooter(otexstream &, OutputParams const &, std::list<col_type>) const;
841 bool isValidRow(row_type const row) const;
843 void TeXRow(otexstream &, row_type const row,
844 OutputParams const &, std::list<col_type>) const;
846 // helper functions for plain text
848 bool plaintextTopHLine(odocstringstream &, row_type row,
849 std::vector<unsigned int> const &) const;
851 bool plaintextBottomHLine(odocstringstream &, row_type row,
852 std::vector<unsigned int> const &) const;
854 void plaintextPrintCell(odocstringstream &,
855 OutputParams const &,
856 idx_type cell, row_type row, col_type column,
857 std::vector<unsigned int> const &,
858 bool onlydata, size_t max_length) const;
859 /// auxiliary function for docbook
860 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
862 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
863 bool header = false) const;
865 /// change associated Buffer
866 void setBuffer(Buffer & buffer);
867 /// retrieve associated Buffer
868 Buffer const & buffer() const { return *buffer_; }
869 /// retrieve associated Buffer
870 Buffer & buffer() { return *buffer_; }
878 class InsetTabular : public Inset
882 InsetTabular(Buffer *, row_type rows = 1,
883 col_type columns = 1);
887 void setBuffer(Buffer & buffer);
890 static void string2params(std::string const &, InsetTabular &);
892 static std::string params2string(InsetTabular const &);
896 void write(std::ostream &) const;
898 void metrics(MetricsInfo &, Dimension &) const;
900 void draw(PainterInfo & pi, int x, int y) const;
902 void drawSelection(PainterInfo & pi, int x, int y) const;
904 void drawBackground(PainterInfo & pi, int x, int y) const;
906 bool editable() const { return true; }
908 bool hasSettings() const { return true; }
910 bool insetAllowed(InsetCode code) const;
912 bool allowSpellCheck() const { return true; }
914 bool canTrackChanges() const { return true; }
916 bool canPaintChange(BufferView const &) const { return true; }
917 /** returns false if, when outputing LaTeX, font changes should
918 be closed before generating this inset. This is needed for
919 insets that may contain several paragraphs */
920 bool inheritFont() const { return false; }
922 bool allowsCaptionVariation(std::string const &) const;
924 bool isTable() const { return true; }
926 DisplayType display() const;
928 void latex(otexstream &, OutputParams const &) const;
930 int plaintext(odocstringstream & ods, OutputParams const & op,
931 size_t max_length = INT_MAX) const;
933 int docbook(odocstream &, OutputParams const &) const;
935 docstring xhtml(XHTMLStream &, OutputParams const &) const;
937 void validate(LaTeXFeatures & features) const;
939 InsetCode lyxCode() const { return TABULAR_CODE; }
941 std::string contextMenu(BufferView const &, int, int) const;
943 std::string contextMenuName() const;
944 /// get offset of this cursor slice relative to our upper left corner
945 void cursorPos(BufferView const & bv, CursorSlice const & sl,
946 bool boundary, int & x, int & y) const;
947 /// Executes a space-separated sequence of tabular-features requests
948 void tabularFeatures(Cursor & cur, std::string const & what);
949 /// Change a single tabular feature; does not handle undo.
950 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
951 std::string const & val = std::string());
953 size_t nargs() const { return tabular.numberofcells; }
955 std::shared_ptr<InsetTableCell const> cell(idx_type) const;
957 std::shared_ptr<InsetTableCell> cell(idx_type);
959 Text * getText(int) const;
961 /// set the change for the entire inset
962 void setChange(Change const & change);
963 /// accept the changes within the inset
964 void acceptChanges();
965 /// reject the changes within the inset
966 void rejectChanges();
968 // this should return true if we have a "normal" cell, otherwise false.
969 // "normal" means without width set!
970 /// should all paragraphs be output with "Standard" layout?
971 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
973 virtual bool forcePlainLayout(idx_type cell = 0) const;
975 void addPreview(DocIterator const & inset_pos,
976 graphics::PreviewLoader &) const;
978 /// lock cell with given index
979 void edit(Cursor & cur, bool front, EntryDirection entry_from);
980 /// get table row from x coordinate
981 int rowFromY(Cursor & cur, int y) const;
982 /// get table column from y coordinate
983 int columnFromX(Cursor & cur, int x) const;
985 Inset * editXY(Cursor & cur, int x, int y);
986 /// can we go further down on mouse click?
987 bool descendable(BufferView const &) const { return true; }
988 /// Update the counters of this inset and of its contents
989 void updateBuffer(ParIterator const &, UpdateType);
991 void addToToc(DocIterator const & di, bool output_active,
992 UpdateType utype, TocBackend & backend) const;
995 bool completionSupported(Cursor const &) const;
997 bool inlineCompletionSupported(Cursor const & cur) const;
999 bool automaticInlineCompletion() const;
1001 bool automaticPopupCompletion() const;
1003 bool showCompletionCursor() const;
1005 CompletionList const * createCompletionList(Cursor const & cur) const;
1007 docstring completionPrefix(Cursor const & cur) const;
1009 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
1011 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
1013 virtual bool usePlainLayout() const { return true; }
1015 docstring layoutName() const { return from_ascii("Tabular"); }
1019 InsetTabular * asInsetTabular() { return this; }
1021 InsetTabular const * asInsetTabular() const { return this; }
1023 bool isRightToLeft(Cursor & cur) const;
1024 /// writes the cells between stidx and enidx as a string, optionally
1025 /// descending into the insets
1026 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
1028 /// Returns whether the cell in the specified row and column is selected.
1029 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
1031 void setLayoutForHiddenCells(DocumentClass const & dc);
1033 // Public structures and variables
1035 mutable Tabular tabular;
1039 InsetTabular(InsetTabular const &);
1041 void doDispatch(Cursor & cur, FuncRequest & cmd);
1043 bool getFeatureStatus(Cursor & cur, std::string const & s,
1044 std::string const & argument, FuncStatus & status) const;
1046 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
1048 Inset * clone() const { return new InsetTabular(*this); }
1051 bool hitSelectRow(BufferView const & bv, int x) const;
1053 bool hitSelectColumn(BufferView const & bv, int y) const;
1054 /// Returns true if coordinates are on row/column selection zones
1055 bool clickable(BufferView const &, int x, int y) const;
1058 void drawCellLines(PainterInfo &, int x, int y, row_type row,
1059 idx_type cell) const;
1061 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
1064 void moveNextCell(Cursor & cur,
1065 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1067 void movePrevCell(Cursor & cur,
1068 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1070 int cellXPos(idx_type cell) const;
1072 int cellYPos(idx_type cell) const;
1074 bool copySelection(Cursor & cur);
1076 bool pasteClipboard(Cursor & cur);
1078 void cutSelection(Cursor & cur);
1080 void getSelection(Cursor & cur, row_type & rs, row_type & re,
1081 col_type & cs, col_type & ce) const;
1083 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
1085 /// return the "Manhattan distance" to nearest corner
1086 int dist(BufferView &, idx_type cell, int x, int y) const;
1087 /// return the cell nearest to x, y
1088 idx_type getNearestCell(BufferView &, int x, int y) const;
1090 /// test the rotation state of the given cell range.
1091 bool oneCellHasRotationState(bool rotated,
1092 row_type row_start, row_type row_end,
1093 col_type col_start, col_type col_end) const;
1095 /// true when selecting rows with the mouse
1097 /// true when selecting columns with the mouse
1101 std::string const featureAsString(Tabular::Feature feature);
1103 /// Split cell on decimal symbol
1104 InsetTableCell splitCell(InsetTableCell & head, docstring const & decimal_sym, bool & hassep);
1108 #endif // INSET_TABULAR_H