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