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
238 TOGGLE_VARWIDTH_COLUMN,
242 UNSET_ROTATE_TABULAR,
244 TOGGLE_ROTATE_TABULAR,
277 SET_SPECIAL_MULTICOLUMN,
295 TABULAR_VALIGN_MIDDLE,
297 TABULAR_VALIGN_BOTTOM,
299 LONGTABULAR_ALIGN_LEFT,
301 LONGTABULAR_ALIGN_CENTER,
303 LONGTABULAR_ALIGN_RIGHT,
316 CELL_BEGIN_OF_MULTICOLUMN,
318 CELL_PART_OF_MULTICOLUMN,
320 CELL_BEGIN_OF_MULTIROW,
322 CELL_PART_OF_MULTIROW
330 LYX_VALIGN_MIDDLE = 1,
332 LYX_VALIGN_BOTTOM = 2
338 LYX_LONGTABULAR_ALIGN_LEFT = 0,
340 LYX_LONGTABULAR_ALIGN_CENTER = 1,
342 LYX_LONGTABULAR_ALIGN_RIGHT = 2
383 // we have this header type (is set in the getLT... functions)
385 // double borders on top
387 // double borders on bottom
389 // used for FirstHeader & LastFooter and if this is true
390 // all the rows marked as FirstHeader or LastFooter are
391 // ignored in the output and it is set to be empty!
395 /// type for row numbers
396 typedef size_t row_type;
397 /// type for column numbers
398 typedef size_t col_type;
399 /// type for cell indices
400 typedef size_t idx_type;
401 /// index indicating an invalid position
402 static const idx_type npos = static_cast<idx_type>(-1);
405 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
407 /// Returns true if there is a topline, returns false if not
408 bool topLine(idx_type cell) const;
409 /// Returns true if there is a topline, returns false if not
410 bool bottomLine(idx_type cell) const;
411 /// Returns true if there is a topline, returns false if not
412 bool leftLine(idx_type cell) const;
413 /// Returns true if there is a topline, returns false if not
414 bool rightLine(idx_type cell) const;
416 /// return space occupied by the second horizontal line and
417 /// interline space above row \p row in pixels
418 int interRowSpace(row_type row) const;
420 int interColumnSpace(idx_type cell) const;
422 /* returns the maximum over all rows */
424 int cellWidth(idx_type cell) const;
426 int cellHeight(idx_type cell) const;
432 row_type nrows() const {return row_info.size();}
434 col_type ncols() const {return column_info.size();}
436 int rowAscent(row_type row) const;
438 int rowDescent(row_type row) const;
440 void setRowAscent(row_type row, int height);
442 void setRowDescent(row_type row, int height);
444 void setTopLine(idx_type cell, bool line);
446 void setBottomLine(idx_type cell, bool line);
448 void setLeftLine(idx_type cell, bool line);
450 void setRightLine(idx_type cell, bool line);
452 bool rowTopLine(row_type row) const;
454 bool rowBottomLine(row_type row) const;
456 bool columnLeftLine(col_type column) const;
458 bool columnRightLine(col_type column) const;
460 void setAlignment(idx_type cell, LyXAlignment align,
461 bool onlycolumn = false);
463 void setVAlignment(idx_type cell, VAlignment align,
464 bool onlycolumn = false);
466 void setTabularWidth(Length const & l) { tabular_width = l; }
468 Length tabularWidth() const { return tabular_width; }
470 void setColumnPWidth(Cursor &, idx_type, Length const &);
472 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
474 bool toggleVarwidth(idx_type, bool const);
476 bool setMROffset(Cursor &, idx_type, Length const &);
478 void setAlignSpecial(idx_type cell, docstring const & special,
481 LyXAlignment getAlignment(idx_type cell,
482 bool onlycolumn = false) const;
484 VAlignment getVAlignment(idx_type cell,
485 bool onlycolumn = false) const;
486 /// The vertical offset of the table due to the vertical
487 /// alignment with respect to the baseline.
488 int offsetVAlignment() const;
490 Length const getPWidth(idx_type cell) const;
492 Length const getMROffset(idx_type cell) const;
494 int textHOffset(idx_type cell) const;
496 int textVOffset(idx_type cell) const;
498 void appendRow(row_type row);
500 void deleteRow(row_type row);
502 void copyRow(row_type row);
504 void insertRow(row_type row, bool copy);
506 void moveColumn(col_type col, ColDirection direction);
508 void moveRow(row_type row, RowDirection direction);
510 void appendColumn(col_type column);
512 void deleteColumn(col_type column);
514 void copyColumn(col_type column);
516 void insertColumn(col_type column, bool copy);
518 idx_type getFirstCellInRow(row_type row) const;
520 idx_type getLastCellInRow(row_type row) const;
522 idx_type numberOfCellsInRow(row_type row) const;
524 void write(std::ostream &) const;
528 void latex(otexstream &, OutputParams const &) const;
530 int docbook(odocstream & os, OutputParams const &) const;
532 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
534 void plaintext(odocstringstream &,
535 OutputParams const & runparams, int const depth,
536 bool onlydata, char_type delim, size_t max_length = INT_MAX) const;
538 bool isMultiColumn(idx_type cell) const;
540 bool hasMultiColumn(col_type cell) const;
542 bool hasVarwidthColumn() const;
544 bool isVTypeColumn(col_type cell) const;
546 idx_type setMultiColumn(Cursor & cur, idx_type cell, idx_type number,
547 bool const right_border);
549 void unsetMultiColumn(idx_type cell);
551 bool isPartOfMultiColumn(row_type row, col_type column) const;
553 bool isPartOfMultiRow(row_type row, col_type column) const;
555 bool isMultiRow(idx_type cell) const;
557 bool hasMultiRow(row_type r) const;
559 idx_type setMultiRow(Cursor & cur, idx_type cell, idx_type number,
560 bool const bottom_border,
561 LyXAlignment const halign);
563 void unsetMultiRow(idx_type cell);
565 row_type cellRow(idx_type cell) const;
567 col_type cellColumn(idx_type cell) const;
569 void setRotateCell(idx_type cell, int);
571 int getRotateCell(idx_type cell) const;
573 bool needRotating() const;
575 bool isLastCell(idx_type cell) const;
577 idx_type cellAbove(idx_type cell) const;
579 idx_type cellBelow(idx_type cell) const;
580 /// \return the index of the VISIBLE cell at row, column
581 /// this will be the same as the cell in the previous row,
582 /// e.g., if the cell is part of a multirow
583 idx_type cellIndex(row_type row, col_type column) const;
585 void setUsebox(idx_type cell, BoxType);
587 BoxType getUsebox(idx_type cell) const;
589 // Long Tabular Options support functions
591 void setLTHead(row_type row, bool flag, ltType const &, bool first);
593 bool getRowOfLTHead(row_type row, ltType &) const;
595 bool getRowOfLTFirstHead(row_type row, ltType &) const;
597 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
599 bool getRowOfLTFoot(row_type row, ltType &) const;
601 bool getRowOfLTLastFoot(row_type row, ltType &) const;
603 void setLTNewPage(row_type row, bool what);
605 bool getLTNewPage(row_type row) const;
607 idx_type setLTCaption(Cursor & cur, row_type row, bool what);
609 bool ltCaption(row_type row) const;
611 bool haveLTHead(bool withcaptions = true) const;
613 bool haveLTFirstHead(bool withcaptions = true) const;
615 bool haveLTFoot(bool withcaptions = true) const;
617 bool haveLTLastFoot(bool withcaptions = true) const;
619 bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
621 // end longtable support
624 /// there is a subtle difference between these two methods.
627 /// cellInset(cellIndex(r,c));
628 /// can return different things. this is because cellIndex(r,c)
629 /// returns the VISIBLE cell at r,c, which may be the same as the
630 /// cell at the previous row or column, if we're dealing with some
631 /// multirow or multicell.
632 std::shared_ptr<InsetTableCell> cellInset(idx_type cell);
633 std::shared_ptr<InsetTableCell> cellInset(row_type row, col_type column);
634 InsetTableCell const * cellInset(idx_type cell) const;
637 void setCellInset(row_type row, col_type column,
638 std::shared_ptr<InsetTableCell>);
639 /// Search for \param inset in the tabular, with the
641 void validate(LaTeXFeatures &) const;
644 // FIXME Now that cells have an InsetTableCell as their insets, rather
645 // than an InsetText, it'd be possible to reverse the relationship here,
646 // so that cell_vector was a vector<InsetTableCell> rather than a
647 // vector<CellData>, and an InsetTableCell had a CellData as a member,
648 // or perhaps just had its members as members.
655 CellData(CellData const &);
657 CellData & operator=(CellData const &);
669 LyXAlignment alignment;
671 VAlignment valignment;
672 /// width of the part before the decimal
674 /// width of the decimal part
691 docstring align_special;
693 Length p_width; // this is only set for multicolumn!!!
695 std::shared_ptr<InsetTableCell> inset;
698 CellData const & cellInfo(idx_type cell) const;
700 CellData & cellInfo(idx_type cell);
702 typedef std::vector<CellData> cell_vector;
704 typedef std::vector<cell_vector> cell_vvector;
715 /// Extra space between the top line and this row
717 /// Ignore top_space if true and use the default top space
718 bool top_space_default;
719 /// Extra space between this row and the bottom line
721 /// Ignore bottom_space if true and use the default bottom space
722 bool bottom_space_default;
723 /// Extra space between the bottom line and the next top line
724 Length interline_space;
725 /// Ignore interline_space if true and use the default interline space
726 bool interline_space_default;
727 /// This are for longtabulars only
730 /// a row of endfirsthead
734 /// row of endlastfoot
736 /// row for a newpage
742 typedef std::vector<RowData> row_vector;
750 LyXAlignment alignment;
752 VAlignment valignment;
758 docstring align_special;
760 docstring decimal_point;
765 typedef std::vector<ColumnData> column_vector;
768 idx_type numberofcells;
770 std::vector<row_type> rowofcell;
772 std::vector<col_type> columnofcell;
776 column_vector column_info;
778 cell_vvector cell_info;
780 Length tabular_width;
786 VAlignment tabular_valignment;
790 HAlignment longtabular_alignment;
792 bool is_long_tabular;
795 /// endfirsthead data
803 void init(Buffer *, row_type rows_arg,
804 col_type columns_arg);
806 void updateIndexes();
808 bool setFixedWidth(row_type r, col_type c);
809 /// return true of update is needed
810 bool updateColumnWidths(MetricsInfo & mi);
812 idx_type columnSpan(idx_type cell) const;
814 idx_type rowSpan(idx_type cell) const;
816 BoxType useBox(idx_type cell) const;
818 // helper function for Latex
820 void TeXTopHLine(otexstream &, row_type row, std::string const & lang,
821 std::list<col_type>) const;
823 void TeXBottomHLine(otexstream &, row_type row, std::string const & lang,
824 std::list<col_type>) const;
826 void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow,
827 bool const bidi) const;
829 void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
831 void TeXLongtableHeaderFooter(otexstream &, OutputParams const &, std::list<col_type>) const;
833 bool isValidRow(row_type const row) const;
835 void TeXRow(otexstream &, row_type const row,
836 OutputParams const &, std::list<col_type>) const;
838 // helper functions for plain text
840 bool plaintextTopHLine(odocstringstream &, row_type row,
841 std::vector<unsigned int> const &) const;
843 bool plaintextBottomHLine(odocstringstream &, row_type row,
844 std::vector<unsigned int> const &) const;
846 void plaintextPrintCell(odocstringstream &,
847 OutputParams const &,
848 idx_type cell, row_type row, col_type column,
849 std::vector<unsigned int> const &,
850 bool onlydata, size_t max_length) const;
851 /// auxiliary function for docbook
852 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
854 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
855 bool header = false) const;
857 /// change associated Buffer
858 void setBuffer(Buffer & buffer);
859 /// retrieve associated Buffer
860 Buffer const & buffer() const { return *buffer_; }
861 /// retrieve associated Buffer
862 Buffer & buffer() { return *buffer_; }
870 class InsetTabular : public Inset
874 InsetTabular(Buffer *, row_type rows = 1,
875 col_type columns = 1);
879 void setBuffer(Buffer & buffer);
882 static void string2params(std::string const &, InsetTabular &);
884 static std::string params2string(InsetTabular const &);
888 void write(std::ostream &) const;
890 void metrics(MetricsInfo &, Dimension &) const;
892 void draw(PainterInfo & pi, int x, int y) const;
894 void drawSelection(PainterInfo & pi, int x, int y) const;
896 void drawBackground(PainterInfo & pi, int x, int y) const;
898 bool editable() const { return true; }
900 bool hasSettings() const { return true; }
902 bool insetAllowed(InsetCode code) const;
904 bool allowSpellCheck() const { return true; }
906 bool canTrackChanges() const { return true; }
908 bool canPaintChange(BufferView const &) const { return true; }
909 /** returns false if, when outputing LaTeX, font changes should
910 be closed before generating this inset. This is needed for
911 insets that may contain several paragraphs */
912 bool inheritFont() const { return false; }
914 bool allowsCaptionVariation(std::string const &) const;
916 bool isTable() const { return true; }
918 DisplayType display() const;
920 void latex(otexstream &, OutputParams const &) const;
922 int plaintext(odocstringstream & ods, OutputParams const & op,
923 size_t max_length = INT_MAX) const;
925 int docbook(odocstream &, OutputParams const &) const;
927 docstring xhtml(XHTMLStream &, OutputParams const &) const;
929 void validate(LaTeXFeatures & features) const;
931 InsetCode lyxCode() const { return TABULAR_CODE; }
933 std::string contextMenu(BufferView const &, int, int) const;
935 std::string contextMenuName() const;
936 /// get offset of this cursor slice relative to our upper left corner
937 void cursorPos(BufferView const & bv, CursorSlice const & sl,
938 bool boundary, int & x, int & y) const;
939 /// Executes a space-separated sequence of tabular-features requests
940 void tabularFeatures(Cursor & cur, std::string const & what);
941 /// Change a single tabular feature; does not handle undo.
942 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
943 std::string const & val = std::string());
945 size_t nargs() const { return tabular.numberofcells; }
947 std::shared_ptr<InsetTableCell const> cell(idx_type) const;
949 std::shared_ptr<InsetTableCell> cell(idx_type);
951 Text * getText(int) const;
953 /// set the change for the entire inset
954 void setChange(Change const & change);
955 /// accept the changes within the inset
956 void acceptChanges();
957 /// reject the changes within the inset
958 void rejectChanges();
960 // this should return true if we have a "normal" cell, otherwise false.
961 // "normal" means without width set!
962 /// should all paragraphs be output with "Standard" layout?
963 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
965 virtual bool forcePlainLayout(idx_type cell = 0) const;
967 void addPreview(DocIterator const & inset_pos,
968 graphics::PreviewLoader &) const;
970 /// lock cell with given index
971 void edit(Cursor & cur, bool front, EntryDirection entry_from);
972 /// get table row from x coordinate
973 int rowFromY(Cursor & cur, int y) const;
974 /// get table column from y coordinate
975 int columnFromX(Cursor & cur, int x) const;
977 Inset * editXY(Cursor & cur, int x, int y);
978 /// can we go further down on mouse click?
979 bool descendable(BufferView const &) const { return true; }
980 /// Update the counters of this inset and of its contents
981 void updateBuffer(ParIterator const &, UpdateType);
983 void addToToc(DocIterator const & di, bool output_active,
984 UpdateType utype, TocBackend & backend) const;
987 bool completionSupported(Cursor const &) const;
989 bool inlineCompletionSupported(Cursor const & cur) const;
991 bool automaticInlineCompletion() const;
993 bool automaticPopupCompletion() const;
995 bool showCompletionCursor() const;
997 CompletionList const * createCompletionList(Cursor const & cur) const;
999 docstring completionPrefix(Cursor const & cur) const;
1001 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
1003 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
1005 virtual bool usePlainLayout() const { return true; }
1007 docstring layoutName() const { return from_ascii("Tabular"); }
1011 InsetTabular * asInsetTabular() { return this; }
1013 InsetTabular const * asInsetTabular() const { return this; }
1015 bool isRightToLeft(Cursor & cur) const;
1016 /// writes the cells between stidx and enidx as a string, optionally
1017 /// descending into the insets
1018 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
1020 /// Returns whether the cell in the specified row and column is selected.
1021 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
1023 void setLayoutForHiddenCells(DocumentClass const & dc);
1025 // Public structures and variables
1027 mutable Tabular tabular;
1031 InsetTabular(InsetTabular const &);
1033 void doDispatch(Cursor & cur, FuncRequest & cmd);
1035 bool getFeatureStatus(Cursor & cur, std::string const & s,
1036 std::string const & argument, FuncStatus & status) const;
1038 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
1040 Inset * clone() const { return new InsetTabular(*this); }
1043 bool hitSelectRow(BufferView const & bv, int x) const;
1045 bool hitSelectColumn(BufferView const & bv, int y) const;
1046 /// Returns true if coordinates are on row/column selection zones
1047 bool clickable(BufferView const &, int x, int y) const;
1050 void drawCellLines(PainterInfo &, int x, int y, row_type row,
1051 idx_type cell) const;
1053 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
1056 void moveNextCell(Cursor & cur,
1057 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1059 void movePrevCell(Cursor & cur,
1060 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1062 int cellXPos(idx_type cell) const;
1064 int cellYPos(idx_type cell) const;
1066 bool copySelection(Cursor & cur);
1068 bool pasteClipboard(Cursor & cur);
1070 void cutSelection(Cursor & cur);
1072 void getSelection(Cursor & cur, row_type & rs, row_type & re,
1073 col_type & cs, col_type & ce) const;
1075 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
1077 /// return the "Manhattan distance" to nearest corner
1078 int dist(BufferView &, idx_type cell, int x, int y) const;
1079 /// return the cell nearest to x, y
1080 idx_type getNearestCell(BufferView &, int x, int y) const;
1082 /// test the rotation state of the given cell range.
1083 bool oneCellHasRotationState(bool rotated,
1084 row_type row_start, row_type row_end,
1085 col_type col_start, col_type col_end) const;
1087 /// true when selecting rows with the mouse
1089 /// true when selecting columns with the mouse
1093 std::string const featureAsString(Tabular::Feature feature);
1095 /// Split cell on decimal symbol
1096 InsetTableCell splitCell(InsetTableCell & head, docstring const & decimal_sym, bool & hassep);
1100 #endif // INSET_TABULAR_H