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 setContentAlignment(LyXAlignment al) {contentAlign = al; }
67 /// writes the contents of the cell as a string, optionally
68 /// descending into insets
69 docstring asString(bool intoInsets = true);
71 docstring xhtml(XHTMLStream &, OutputParams const &) const;
73 void addToToc(DocIterator const & di, bool output_active,
74 UpdateType utype) const;
79 void operator=(InsetTableCell const &);
81 // This boolean is supposed to track whether the cell has had its
82 // width explicitly set. We need to know this to determine whether
83 // layout changes and paragraph customization are allowed---that is,
84 // we need it in forcePlainLayout() and allowParagraphCustomization().
85 // Unfortunately, that information is not readily available in
86 // InsetTableCell. In the case of multicolumn cells, it is present
87 // in CellData, and so would be available here if CellData were to
88 // become a member of InsetTableCell. But in the other case, it isn't
89 // even available there, but is held in Tabular::ColumnData.
90 // So, the present solution uses this boolean to track the information
91 // we need to track, and tries to keep it updated. This is not ideal,
92 // but the other solutions are no better. These are:
93 // (i) Keep a pointer in InsetTableCell to the table;
94 // (ii) Find the table by iterating over the Buffer's insets.
95 // Solution (i) raises the problem of updating the pointer when an
96 // InsetTableCell is copied, and we'd therefore need a copy constructor
97 // in InsetTabular and then in Tabular, which seems messy, given how
98 // complicated those classes are. Solution (ii) involves a lot of
99 // iterating, since this information is needed quite often, and so may
101 // So, well, if someone can do better, please do!
105 // FIXME: Here the thoughts from the comment above also apply.
107 LyXAlignment contentAlign;
108 /// should paragraph indendation be omitted in any case?
109 bool neverIndent() const { return true; }
111 LyXAlignment contentAlignment() const { return contentAlign; }
113 virtual bool usePlainLayout() const { return true; }
115 virtual bool forcePlainLayout(idx_type = 0) const;
117 virtual bool allowParagraphCustomization(idx_type = 0) const;
119 virtual bool forceLocalFontSwitch() const;
120 /// Is the width forced to some value?
121 bool hasFixedWidth() const { return isFixedWidth; }
122 /// Can the cell contain several paragraphs?
123 /** FIXME this is wrong for multirows, that are limited to one
124 * paragraph. However, we cannot test for this (see the big
127 bool allowMultiPar() const { return isFixedWidth; }
132 // A helper struct for tables
233 UNSET_ROTATE_TABULAR,
235 TOGGLE_ROTATE_TABULAR,
268 SET_SPECIAL_MULTICOLUMN,
286 TABULAR_VALIGN_MIDDLE,
288 TABULAR_VALIGN_BOTTOM,
290 LONGTABULAR_ALIGN_LEFT,
292 LONGTABULAR_ALIGN_CENTER,
294 LONGTABULAR_ALIGN_RIGHT,
307 CELL_BEGIN_OF_MULTICOLUMN,
309 CELL_PART_OF_MULTICOLUMN,
311 CELL_BEGIN_OF_MULTIROW,
313 CELL_PART_OF_MULTIROW
321 LYX_VALIGN_MIDDLE = 1,
323 LYX_VALIGN_BOTTOM = 2
329 LYX_LONGTABULAR_ALIGN_LEFT = 0,
331 LYX_LONGTABULAR_ALIGN_CENTER = 1,
333 LYX_LONGTABULAR_ALIGN_RIGHT = 2
372 // we have this header type (is set in the getLT... functions)
374 // double borders on top
376 // double borders on bottom
378 // used for FirstHeader & LastFooter and if this is true
379 // all the rows marked as FirstHeader or LastFooter are
380 // ignored in the output and it is set to be empty!
384 /// type for row numbers
385 typedef size_t row_type;
386 /// type for column numbers
387 typedef size_t col_type;
388 /// type for cell indices
389 typedef size_t idx_type;
390 /// index indicating an invalid position
391 static const idx_type npos = static_cast<idx_type>(-1);
394 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
396 /// Returns true if there is a topline, returns false if not
397 bool topLine(idx_type cell) const;
398 /// Returns true if there is a topline, returns false if not
399 bool bottomLine(idx_type cell) const;
400 /// Returns true if there is a topline, returns false if not
401 bool leftLine(idx_type cell) const;
402 /// Returns true if there is a topline, returns false if not
403 bool rightLine(idx_type cell) const;
405 /// return space occupied by the second horizontal line and
406 /// interline space above row \p row in pixels
407 int interRowSpace(row_type row) const;
409 int interColumnSpace(idx_type cell) const;
411 /* returns the maximum over all rows */
413 int cellWidth(idx_type cell) const;
415 int cellHeight(idx_type cell) const;
421 row_type nrows() const {return row_info.size();}
423 col_type ncols() const {return column_info.size();}
425 int rowAscent(row_type row) const;
427 int rowDescent(row_type row) const;
429 void setRowAscent(row_type row, int height);
431 void setRowDescent(row_type row, int height);
433 void setTopLine(idx_type cell, bool line);
435 void setBottomLine(idx_type cell, bool line);
437 void setLeftLine(idx_type cell, bool line);
439 void setRightLine(idx_type cell, bool line);
441 bool rowTopLine(row_type row) const;
443 bool rowBottomLine(row_type row) const;
445 bool columnLeftLine(col_type column) const;
447 bool columnRightLine(col_type column) const;
449 void setAlignment(idx_type cell, LyXAlignment align,
450 bool onlycolumn = false);
452 void setVAlignment(idx_type cell, VAlignment align,
453 bool onlycolumn = false);
455 void setTabularWidth(Length const & l) { tabular_width = l; }
457 Length tabularWidth() const { return tabular_width; }
459 void setColumnPWidth(Cursor &, idx_type, Length const &);
461 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
463 bool setMROffset(Cursor &, idx_type, Length const &);
465 void setAlignSpecial(idx_type cell, docstring const & special,
468 LyXAlignment getAlignment(idx_type cell,
469 bool onlycolumn = false) const;
471 VAlignment getVAlignment(idx_type cell,
472 bool onlycolumn = false) const;
474 Length const getPWidth(idx_type cell) const;
476 Length const getMROffset(idx_type cell) const;
478 int textHOffset(idx_type cell) const;
480 int textVOffset(idx_type cell) const;
482 void appendRow(row_type row);
484 void deleteRow(row_type row);
486 void copyRow(row_type row);
488 void insertRow(row_type row, bool copy);
490 void moveColumn(col_type col, ColDirection direction);
492 void moveRow(row_type row, RowDirection direction);
494 void appendColumn(col_type column);
496 void deleteColumn(col_type column);
498 void copyColumn(col_type column);
500 void insertColumn(col_type column, bool copy);
502 idx_type getFirstCellInRow(row_type row) const;
504 idx_type getLastCellInRow(row_type row) const;
506 idx_type numberOfCellsInRow(row_type row) const;
508 void write(std::ostream &) const;
512 void latex(otexstream &, OutputParams const &) const;
514 int docbook(odocstream & os, OutputParams const &) const;
516 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
518 void plaintext(odocstringstream &,
519 OutputParams const & runparams, int const depth,
520 bool onlydata, char_type delim, size_t max_length = INT_MAX) const;
522 bool isMultiColumn(idx_type cell) const;
524 bool hasMultiColumn(col_type cell) const;
526 idx_type setMultiColumn(idx_type cell, idx_type number,
527 bool const right_border);
529 void unsetMultiColumn(idx_type cell);
531 bool isPartOfMultiColumn(row_type row, col_type column) const;
533 bool isPartOfMultiRow(row_type row, col_type column) const;
535 bool isMultiRow(idx_type cell) const;
537 bool hasMultiRow(row_type r) const;
539 idx_type setMultiRow(idx_type cell, idx_type number,
540 bool const bottom_border,
541 LyXAlignment const halign);
543 void unsetMultiRow(idx_type cell);
545 row_type cellRow(idx_type cell) const;
547 col_type cellColumn(idx_type cell) const;
549 void setRotateCell(idx_type cell, int);
551 int getRotateCell(idx_type cell) const;
553 bool needRotating() const;
555 bool isLastCell(idx_type cell) const;
557 idx_type cellAbove(idx_type cell) const;
559 idx_type cellBelow(idx_type cell) const;
560 /// \return the index of the VISIBLE cell at row, column
561 /// this will be the same as the cell in the previous row,
562 /// e.g., if the cell is part of a multirow
563 idx_type cellIndex(row_type row, col_type column) const;
565 void setUsebox(idx_type cell, BoxType);
567 BoxType getUsebox(idx_type cell) const;
569 // Long Tabular Options support functions
571 void setLTHead(row_type row, bool flag, ltType const &, bool first);
573 bool getRowOfLTHead(row_type row, ltType &) const;
575 bool getRowOfLTFirstHead(row_type row, ltType &) const;
577 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
579 bool getRowOfLTFoot(row_type row, ltType &) const;
581 bool getRowOfLTLastFoot(row_type row, ltType &) const;
583 void setLTNewPage(row_type row, bool what);
585 bool getLTNewPage(row_type row) const;
587 idx_type setLTCaption(row_type row, bool what);
589 bool ltCaption(row_type row) const;
591 bool haveLTHead(bool withcaptions = true) const;
593 bool haveLTFirstHead(bool withcaptions = true) const;
595 bool haveLTFoot(bool withcaptions = true) const;
597 bool haveLTLastFoot(bool withcaptions = true) const;
599 bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
601 // end longtable support
604 /// there is a subtle difference between these two methods.
607 /// cellInset(cellIndex(r,c));
608 /// can return different things. this is because cellIndex(r,c)
609 /// returns the VISIBLE cell at r,c, which may be the same as the
610 /// cell at the previous row or column, if we're dealing with some
611 /// multirow or multicell.
612 std::shared_ptr<InsetTableCell> cellInset(idx_type cell);
613 std::shared_ptr<InsetTableCell> cellInset(row_type row, col_type column);
614 InsetTableCell const * cellInset(idx_type cell) const;
617 void setCellInset(row_type row, col_type column,
618 std::shared_ptr<InsetTableCell>);
619 /// Search for \param inset in the tabular, with the
621 void validate(LaTeXFeatures &) const;
624 // FIXME Now that cells have an InsetTableCell as their insets, rather
625 // than an InsetText, it'd be possible to reverse the relationship here,
626 // so that cell_vector was a vector<InsetTableCell> rather than a
627 // vector<CellData>, and an InsetTableCell had a CellData as a member,
628 // or perhaps just had its members as members.
635 CellData(CellData const &);
637 CellData & operator=(CellData const &);
649 LyXAlignment alignment;
651 VAlignment valignment;
652 /// width of the part before the decimal
654 /// width of the decimal part
671 docstring align_special;
673 Length p_width; // this is only set for multicolumn!!!
675 std::shared_ptr<InsetTableCell> inset;
678 CellData const & cellInfo(idx_type cell) const;
680 CellData & cellInfo(idx_type cell);
682 typedef std::vector<CellData> cell_vector;
684 typedef std::vector<cell_vector> cell_vvector;
695 /// Extra space between the top line and this row
697 /// Ignore top_space if true and use the default top space
698 bool top_space_default;
699 /// Extra space between this row and the bottom line
701 /// Ignore bottom_space if true and use the default bottom space
702 bool bottom_space_default;
703 /// Extra space between the bottom line and the next top line
704 Length interline_space;
705 /// Ignore interline_space if true and use the default interline space
706 bool interline_space_default;
707 /// This are for longtabulars only
710 /// a row of endfirsthead
714 /// row of endlastfoot
716 /// row for a newpage
722 typedef std::vector<RowData> row_vector;
730 LyXAlignment alignment;
732 VAlignment valignment;
738 docstring align_special;
740 docstring decimal_point;
743 typedef std::vector<ColumnData> column_vector;
746 idx_type numberofcells;
748 std::vector<row_type> rowofcell;
750 std::vector<col_type> columnofcell;
754 column_vector column_info;
756 mutable cell_vvector cell_info;
758 Length tabular_width;
764 VAlignment tabular_valignment;
768 HAlignment longtabular_alignment;
770 bool is_long_tabular;
773 /// endfirsthead data
781 void init(Buffer *, row_type rows_arg,
782 col_type columns_arg);
784 void updateIndexes();
786 bool setFixedWidth(row_type r, col_type c);
787 /// return true of update is needed
788 bool updateColumnWidths();
790 idx_type columnSpan(idx_type cell) const;
792 idx_type rowSpan(idx_type cell) const;
794 BoxType useParbox(idx_type cell) const;
796 // helper function for Latex
798 void TeXTopHLine(otexstream &, row_type row, std::string const & lang) const;
800 void TeXBottomHLine(otexstream &, row_type row, std::string const & lang) const;
802 void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
804 void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
806 void TeXLongtableHeaderFooter(otexstream &, OutputParams const &) const;
808 bool isValidRow(row_type const row) const;
810 void TeXRow(otexstream &, row_type const row,
811 OutputParams const &) const;
813 // helper functions for plain text
815 bool plaintextTopHLine(odocstringstream &, row_type row,
816 std::vector<unsigned int> const &) const;
818 bool plaintextBottomHLine(odocstringstream &, row_type row,
819 std::vector<unsigned int> const &) const;
821 void plaintextPrintCell(odocstringstream &,
822 OutputParams const &,
823 idx_type cell, row_type row, col_type column,
824 std::vector<unsigned int> const &,
825 bool onlydata, size_t max_length) const;
826 /// auxiliary function for docbook
827 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
829 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
830 bool header = false) const;
832 /// change associated Buffer
833 void setBuffer(Buffer & buffer);
834 /// retrieve associated Buffer
835 Buffer const & buffer() const { return *buffer_; }
836 /// retrieve associated Buffer
837 Buffer & buffer() { return *buffer_; }
845 class InsetTabular : public Inset
849 InsetTabular(Buffer *, row_type rows = 1,
850 col_type columns = 1);
854 void setBuffer(Buffer & buffer);
857 static void string2params(std::string const &, InsetTabular &);
859 static std::string params2string(InsetTabular const &);
863 void write(std::ostream &) const;
865 void metrics(MetricsInfo &, Dimension &) const;
867 void draw(PainterInfo & pi, int x, int y) const;
869 void drawSelection(PainterInfo & pi, int x, int y) const;
871 void drawBackground(PainterInfo & pi, int x, int y) const;
873 bool editable() const { return true; }
875 bool hasSettings() const { return true; }
877 bool insetAllowed(InsetCode code) const;
879 bool allowSpellCheck() const { return true; }
881 bool canTrackChanges() const { return true; }
883 bool canPaintChange(BufferView const &) const { return true; }
884 /** returns false if, when outputing LaTeX, font changes should
885 be closed before generating this inset. This is needed for
886 insets that may contain several paragraphs */
887 bool inheritFont() const { return false; }
889 bool allowsCaptionVariation(std::string const &) const;
891 bool isTable() const { return true; }
893 DisplayType display() const;
895 void latex(otexstream &, OutputParams const &) const;
897 int plaintext(odocstringstream & ods, OutputParams const & op,
898 size_t max_length = INT_MAX) const;
900 int docbook(odocstream &, OutputParams const &) const;
902 docstring xhtml(XHTMLStream &, OutputParams const &) const;
904 void validate(LaTeXFeatures & features) const;
906 InsetCode lyxCode() const { return TABULAR_CODE; }
908 std::string contextMenu(BufferView const &, int, int) const;
910 std::string contextMenuName() const;
911 /// get offset of this cursor slice relative to our upper left corner
912 void cursorPos(BufferView const & bv, CursorSlice const & sl,
913 bool boundary, int & x, int & y) const;
914 /// Executes a space-separated sequence of tabular-features requests
915 void tabularFeatures(Cursor & cur, std::string const & what);
916 /// Change a single tabular feature; does not handle undo.
917 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
918 std::string const & val = std::string());
920 size_t nargs() const { return tabular.numberofcells; }
922 std::shared_ptr<InsetTableCell const> cell(idx_type) const;
924 std::shared_ptr<InsetTableCell> cell(idx_type);
926 Text * getText(int) const;
928 /// set the change for the entire inset
929 void setChange(Change const & change);
930 /// accept the changes within the inset
931 void acceptChanges();
932 /// reject the changes within the inset
933 void rejectChanges();
935 // this should return true if we have a "normal" cell, otherwise false.
936 // "normal" means without width set!
937 /// should all paragraphs be output with "Standard" layout?
938 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
940 virtual bool forcePlainLayout(idx_type cell = 0) const;
942 void addPreview(DocIterator const & inset_pos,
943 graphics::PreviewLoader &) const;
945 /// lock cell with given index
946 void edit(Cursor & cur, bool front, EntryDirection entry_from);
947 /// get table row from x coordinate
948 int rowFromY(Cursor & cur, int y) const;
949 /// get table column from y coordinate
950 int columnFromX(Cursor & cur, int x) const;
952 Inset * editXY(Cursor & cur, int x, int y);
953 /// can we go further down on mouse click?
954 bool descendable(BufferView const &) const { return true; }
955 /// Update the counters of this inset and of its contents
956 void updateBuffer(ParIterator const &, UpdateType);
958 void addToToc(DocIterator const & di, bool output_active,
959 UpdateType utype) const;
962 bool completionSupported(Cursor const &) const;
964 bool inlineCompletionSupported(Cursor const & cur) const;
966 bool automaticInlineCompletion() const;
968 bool automaticPopupCompletion() const;
970 bool showCompletionCursor() const;
972 CompletionList const * createCompletionList(Cursor const & cur) const;
974 docstring completionPrefix(Cursor const & cur) const;
976 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
978 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
980 virtual bool usePlainLayout() const { return true; }
983 InsetTabular * asInsetTabular() { return this; }
985 InsetTabular const * asInsetTabular() const { return this; }
987 bool isRightToLeft(Cursor & cur) const;
988 /// writes the cells between stidx and enidx as a string, optionally
989 /// descending into the insets
990 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
992 /// Returns whether the cell in the specified row and column is selected.
993 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
995 void setLayoutForHiddenCells(DocumentClass const & dc);
997 // Public structures and variables
999 mutable Tabular tabular;
1003 InsetTabular(InsetTabular const &);
1005 void doDispatch(Cursor & cur, FuncRequest & cmd);
1007 bool getFeatureStatus(Cursor & cur, std::string const & s,
1008 std::string const & argument, FuncStatus & status) const;
1010 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
1012 Inset * clone() const { return new InsetTabular(*this); }
1015 bool hitSelectRow(BufferView const & bv, int x) const;
1017 bool hitSelectColumn(BufferView const & bv, int y) const;
1018 /// Returns true if coordinates are on row/column selection zones
1019 bool clickable(BufferView const &, int x, int y) const;
1022 void drawCellLines(PainterInfo &, int x, int y, row_type row,
1023 idx_type cell) const;
1025 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
1028 void moveNextCell(Cursor & cur,
1029 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1031 void movePrevCell(Cursor & cur,
1032 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1034 int cellXPos(idx_type cell) const;
1036 int cellYPos(idx_type cell) const;
1038 bool copySelection(Cursor & cur);
1040 bool pasteClipboard(Cursor & cur);
1042 void cutSelection(Cursor & cur);
1044 void getSelection(Cursor & cur, row_type & rs, row_type & re,
1045 col_type & cs, col_type & ce) const;
1047 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
1049 /// return the "Manhattan distance" to nearest corner
1050 int dist(BufferView &, idx_type cell, int x, int y) const;
1051 /// return the cell nearest to x, y
1052 idx_type getNearestCell(BufferView &, int x, int y) const;
1054 /// test the rotation state of the give cell range.
1055 bool oneCellHasRotationState(bool rotated,
1056 row_type row_start, row_type row_end,
1057 col_type col_start, col_type col_end) const;
1059 mutable idx_type first_visible_cell_;
1060 /// The vertical offset of the table due to the vertical
1061 /// alignment with respect to the baseline.
1062 mutable int offset_valign_;
1063 /// true when selecting rows with the mouse
1065 /// true when selecting columns with the mouse
1069 std::string const featureAsString(Tabular::Feature feature);
1071 /// Split cell on decimal symbol
1072 InsetTableCell splitCell(InsetTableCell & head, docstring const & decimal_sym, bool & hassep);
1076 #endif // INSET_TABULAR_H