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