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
28 #include "InsetText.h"
37 using std::shared_ptr;
54 class InsetTableCell : public InsetText
58 InsetTableCell(Buffer * buf);
60 InsetCode lyxCode() const { return CELL_CODE; }
62 Inset * clone() const { return new InsetTableCell(*this); }
64 bool getStatus(Cursor & cur, FuncRequest const & cmd,
65 FuncStatus & status) const;
67 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
69 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
70 /// writes the contents of the cell as a string, optionally
71 /// descending into insets
72 docstring asString(bool intoInsets = true);
74 docstring xhtml(XHTMLStream &, OutputParams const &) const;
76 void addToToc(DocIterator const & di, bool output_active,
77 UpdateType utype) const;
82 void operator=(InsetTableCell const &);
84 // This boolean is supposed to track whether the cell has had its
85 // width explicitly set. We need to know this to determine whether
86 // layout changes and paragraph customization are allowed---that is,
87 // we need it in forcePlainLayout() and allowParagraphCustomization().
88 // Unfortunately, that information is not readily available in
89 // InsetTableCell. In the case of multicolumn cells, it is present
90 // in CellData, and so would be available here if CellData were to
91 // become a member of InsetTableCell. But in the other case, it isn't
92 // even available there, but is held in Tabular::ColumnData.
93 // So, the present solution uses this boolean to track the information
94 // we need to track, and tries to keep it updated. This is not ideal,
95 // but the other solutions are no better. These are:
96 // (i) Keep a pointer in InsetTableCell to the table;
97 // (ii) Find the table by iterating over the Buffer's insets.
98 // Solution (i) raises the problem of updating the pointer when an
99 // InsetTableCell is copied, and we'd therefore need a copy constructor
100 // in InsetTabular and then in Tabular, which seems messy, given how
101 // complicated those classes are. Solution (ii) involves a lot of
102 // iterating, since this information is needed quite often, and so may
104 // So, well, if someone can do better, please do!
108 // FIXME: Here the thoughts from the comment above also apply.
110 LyXAlignment contentAlign;
111 /// should paragraph indendation be omitted in any case?
112 bool neverIndent() const { return true; }
114 LyXAlignment contentAlignment() const { return contentAlign; }
116 virtual bool usePlainLayout() const { return true; }
118 virtual bool forcePlainLayout(idx_type = 0) const;
120 virtual bool allowParagraphCustomization(idx_type = 0) const;
122 virtual bool forceLocalFontSwitch() const;
123 /// Is the width forced to some value?
124 bool hasFixedWidth() const { return isFixedWidth; }
125 /// Can the cell contain several paragraphs?
126 /** FIXME this is wrong for multirows, that are limited to one
127 * paragraph. However, we cannot test for this (see the big
130 bool allowMultiPar() const { return isFixedWidth; }
135 // A helper struct for tables
236 UNSET_ROTATE_TABULAR,
238 TOGGLE_ROTATE_TABULAR,
271 SET_SPECIAL_MULTICOLUMN,
289 TABULAR_VALIGN_MIDDLE,
291 TABULAR_VALIGN_BOTTOM,
293 LONGTABULAR_ALIGN_LEFT,
295 LONGTABULAR_ALIGN_CENTER,
297 LONGTABULAR_ALIGN_RIGHT,
310 CELL_BEGIN_OF_MULTICOLUMN,
312 CELL_PART_OF_MULTICOLUMN,
314 CELL_BEGIN_OF_MULTIROW,
316 CELL_PART_OF_MULTIROW
324 LYX_VALIGN_MIDDLE = 1,
326 LYX_VALIGN_BOTTOM = 2
332 LYX_LONGTABULAR_ALIGN_LEFT = 0,
334 LYX_LONGTABULAR_ALIGN_CENTER = 1,
336 LYX_LONGTABULAR_ALIGN_RIGHT = 2
375 // we have this header type (is set in the getLT... functions)
377 // double borders on top
379 // double borders on bottom
381 // used for FirstHeader & LastFooter and if this is true
382 // all the rows marked as FirstHeader or LastFooter are
383 // ignored in the output and it is set to be empty!
387 /// type for row numbers
388 typedef size_t row_type;
389 /// type for column numbers
390 typedef size_t col_type;
391 /// type for cell indices
392 typedef size_t idx_type;
393 /// index indicating an invalid position
394 static const idx_type npos = static_cast<idx_type>(-1);
397 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
399 /// Returns true if there is a topline, returns false if not
400 bool topLine(idx_type cell) const;
401 /// Returns true if there is a topline, returns false if not
402 bool bottomLine(idx_type cell) const;
403 /// Returns true if there is a topline, returns false if not
404 bool leftLine(idx_type cell) const;
405 /// Returns true if there is a topline, returns false if not
406 bool rightLine(idx_type cell) const;
408 /// return space occupied by the second horizontal line and
409 /// interline space above row \p row in pixels
410 int interRowSpace(row_type row) const;
412 int interColumnSpace(idx_type cell) const;
414 /* returns the maximum over all rows */
416 int cellWidth(idx_type cell) const;
418 int cellHeight(idx_type cell) const;
424 row_type nrows() const {return row_info.size();}
426 col_type ncols() const {return column_info.size();}
428 int rowAscent(row_type row) const;
430 int rowDescent(row_type row) const;
432 void setRowAscent(row_type row, int height);
434 void setRowDescent(row_type row, int height);
436 void setTopLine(idx_type cell, bool line);
438 void setBottomLine(idx_type cell, bool line);
440 void setLeftLine(idx_type cell, bool line);
442 void setRightLine(idx_type cell, bool line);
444 bool rowTopLine(row_type row) const;
446 bool rowBottomLine(row_type row) const;
448 bool columnLeftLine(col_type column) const;
450 bool columnRightLine(col_type column) const;
452 void setAlignment(idx_type cell, LyXAlignment align,
453 bool onlycolumn = false);
455 void setVAlignment(idx_type cell, VAlignment align,
456 bool onlycolumn = false);
458 void setTabularWidth(Length const & l) { tabular_width = l; }
460 Length tabularWidth() const { return tabular_width; }
462 void setColumnPWidth(Cursor &, idx_type, Length const &);
464 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
466 bool setMROffset(Cursor &, idx_type, Length const &);
468 void setAlignSpecial(idx_type cell, docstring const & special,
471 LyXAlignment getAlignment(idx_type cell,
472 bool onlycolumn = false) const;
474 VAlignment getVAlignment(idx_type cell,
475 bool onlycolumn = false) const;
477 Length const getPWidth(idx_type cell) const;
479 Length const getMROffset(idx_type cell) const;
481 int textHOffset(idx_type cell) const;
483 int textVOffset(idx_type cell) const;
485 void appendRow(row_type row);
487 void deleteRow(row_type row);
489 void copyRow(row_type row);
491 void insertRow(row_type row, bool copy);
493 void moveColumn(col_type col, ColDirection direction);
495 void moveRow(row_type row, RowDirection direction);
497 void appendColumn(col_type column);
499 void deleteColumn(col_type column);
501 void copyColumn(col_type column);
503 void insertColumn(col_type column, bool copy);
505 idx_type getFirstCellInRow(row_type row) const;
507 idx_type getLastCellInRow(row_type row) const;
509 idx_type numberOfCellsInRow(row_type row) const;
511 void write(std::ostream &) const;
515 void latex(otexstream &, OutputParams const &) const;
517 int docbook(odocstream & os, OutputParams const &) const;
519 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
521 void plaintext(odocstringstream &,
522 OutputParams const & runparams, int const depth,
523 bool onlydata, char_type delim, size_t max_length = INT_MAX) const;
525 bool isMultiColumn(idx_type cell) const;
527 bool hasMultiColumn(col_type cell) const;
529 idx_type setMultiColumn(idx_type cell, idx_type number,
530 bool const right_border);
532 void unsetMultiColumn(idx_type cell);
534 bool isPartOfMultiColumn(row_type row, col_type column) const;
536 bool isPartOfMultiRow(row_type row, col_type column) const;
538 bool isMultiRow(idx_type cell) const;
540 bool hasMultiRow(row_type r) const;
542 idx_type setMultiRow(idx_type cell, idx_type number,
543 bool const bottom_border,
544 LyXAlignment const halign);
546 void unsetMultiRow(idx_type cell);
548 row_type cellRow(idx_type cell) const;
550 col_type cellColumn(idx_type cell) const;
552 void setRotateCell(idx_type cell, int);
554 int getRotateCell(idx_type cell) const;
556 bool needRotating() const;
558 bool isLastCell(idx_type cell) const;
560 idx_type cellAbove(idx_type cell) const;
562 idx_type cellBelow(idx_type cell) const;
563 /// \return the index of the VISIBLE cell at row, column
564 /// this will be the same as the cell in the previous row,
565 /// e.g., if the cell is part of a multirow
566 idx_type cellIndex(row_type row, col_type column) const;
568 void setUsebox(idx_type cell, BoxType);
570 BoxType getUsebox(idx_type cell) const;
572 // Long Tabular Options support functions
574 void setLTHead(row_type row, bool flag, ltType const &, bool first);
576 bool getRowOfLTHead(row_type row, ltType &) const;
578 bool getRowOfLTFirstHead(row_type row, ltType &) const;
580 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
582 bool getRowOfLTFoot(row_type row, ltType &) const;
584 bool getRowOfLTLastFoot(row_type row, ltType &) const;
586 void setLTNewPage(row_type row, bool what);
588 bool getLTNewPage(row_type row) const;
590 idx_type setLTCaption(row_type row, bool what);
592 bool ltCaption(row_type row) const;
594 bool haveLTHead(bool withcaptions = true) const;
596 bool haveLTFirstHead(bool withcaptions = true) const;
598 bool haveLTFoot(bool withcaptions = true) const;
600 bool haveLTLastFoot(bool withcaptions = true) const;
602 bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
604 // end longtable support
607 /// there is a subtle difference between these two methods.
610 /// cellInset(cellIndex(r,c));
611 /// can return different things. this is because cellIndex(r,c)
612 /// returns the VISIBLE cell at r,c, which may be the same as the
613 /// cell at the previous row or column, if we're dealing with some
614 /// multirow or multicell.
615 shared_ptr<InsetTableCell> cellInset(idx_type cell);
616 shared_ptr<InsetTableCell> cellInset(row_type row, col_type column);
617 InsetTableCell const * cellInset(idx_type cell) const;
620 void setCellInset(row_type row, col_type column,
621 shared_ptr<InsetTableCell>);
622 /// Search for \param inset in the tabular, with the
624 void validate(LaTeXFeatures &) const;
627 // FIXME Now that cells have an InsetTableCell as their insets, rather
628 // than an InsetText, it'd be possible to reverse the relationship here,
629 // so that cell_vector was a vector<InsetTableCell> rather than a
630 // vector<CellData>, and an InsetTableCell had a CellData as a member,
631 // or perhaps just had its members as members.
638 CellData(CellData const &);
640 CellData & operator=(CellData const &);
652 LyXAlignment alignment;
654 VAlignment valignment;
655 /// width of the part before the decimal
657 /// width of the decimal part
674 docstring align_special;
676 Length p_width; // this is only set for multicolumn!!!
678 shared_ptr<InsetTableCell> inset;
680 CellData & cellInfo(idx_type cell) const;
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 & buffer() const { return *buffer_; }
843 class InsetTabular : public Inset
847 InsetTabular(Buffer *, row_type rows = 1,
848 col_type columns = 1);
852 void setBuffer(Buffer & buffer);
855 static void string2params(std::string const &, InsetTabular &);
857 static std::string params2string(InsetTabular const &);
861 void write(std::ostream &) const;
863 void metrics(MetricsInfo &, Dimension &) const;
865 void draw(PainterInfo & pi, int x, int y) const;
867 void drawSelection(PainterInfo & pi, int x, int y) const;
869 void drawBackground(PainterInfo & pi, int x, int y) const;
871 bool editable() const { return true; }
873 bool hasSettings() const { return true; }
875 bool insetAllowed(InsetCode code) const;
877 bool allowSpellCheck() const { return true; }
879 bool canTrackChanges() const { return true; }
881 bool canPaintChange(BufferView const &) const { return true; }
882 /** returns false if, when outputing LaTeX, font changes should
883 be closed before generating this inset. This is needed for
884 insets that may contain several paragraphs */
885 bool inheritFont() const { return false; }
887 bool allowsCaptionVariation(std::string const &) const;
889 bool isTable() const { return true; }
891 DisplayType display() const;
893 void latex(otexstream &, OutputParams const &) const;
895 int plaintext(odocstringstream & ods, OutputParams const & op,
896 size_t max_length = INT_MAX) const;
898 int docbook(odocstream &, OutputParams const &) const;
900 docstring xhtml(XHTMLStream &, OutputParams const &) const;
902 void validate(LaTeXFeatures & features) const;
904 InsetCode lyxCode() const { return TABULAR_CODE; }
906 std::string contextMenu(BufferView const &, int, int) const;
908 std::string contextMenuName() const;
909 /// get offset of this cursor slice relative to our upper left corner
910 void cursorPos(BufferView const & bv, CursorSlice const & sl,
911 bool boundary, int & x, int & y) const;
912 /// Executes a space-separated sequence of tabular-features requests
913 void tabularFeatures(Cursor & cur, std::string const & what);
914 /// Change a single tabular feature; does not handle undo.
915 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
916 std::string const & val = std::string());
918 size_t nargs() const { return tabular.numberofcells; }
920 shared_ptr<InsetTableCell const> cell(idx_type) const;
922 shared_ptr<InsetTableCell> cell(idx_type);
924 Text * getText(int) const;
926 /// set the change for the entire inset
927 void setChange(Change const & change);
928 /// accept the changes within the inset
929 void acceptChanges();
930 /// reject the changes within the inset
931 void rejectChanges();
933 // this should return true if we have a "normal" cell, otherwise false.
934 // "normal" means without width set!
935 /// should all paragraphs be output with "Standard" layout?
936 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
938 virtual bool forcePlainLayout(idx_type cell = 0) const;
940 void addPreview(DocIterator const & inset_pos,
941 graphics::PreviewLoader &) const;
943 /// lock cell with given index
944 void edit(Cursor & cur, bool front, EntryDirection entry_from);
945 /// get table row from x coordinate
946 int rowFromY(Cursor & cur, int y) const;
947 /// get table column from y coordinate
948 int columnFromX(Cursor & cur, int x) const;
950 Inset * editXY(Cursor & cur, int x, int y);
951 /// can we go further down on mouse click?
952 bool descendable(BufferView const &) const { return true; }
953 /// Update the counters of this inset and of its contents
954 void updateBuffer(ParIterator const &, UpdateType);
956 void addToToc(DocIterator const & di, bool output_active,
957 UpdateType utype) const;
960 bool completionSupported(Cursor const &) const;
962 bool inlineCompletionSupported(Cursor const & cur) const;
964 bool automaticInlineCompletion() const;
966 bool automaticPopupCompletion() const;
968 bool showCompletionCursor() const;
970 CompletionList const * createCompletionList(Cursor const & cur) const;
972 docstring completionPrefix(Cursor const & cur) const;
974 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
976 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
978 virtual bool usePlainLayout() const { return true; }
981 InsetTabular * asInsetTabular() { return this; }
983 InsetTabular const * asInsetTabular() const { return this; }
985 bool isRightToLeft(Cursor & cur) const;
986 /// writes the cells between stidx and enidx as a string, optionally
987 /// descending into the insets
988 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
990 /// Returns whether the cell in the specified row and column is selected.
991 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
993 void setLayoutForHiddenCells(DocumentClass const & dc);
995 // Public structures and variables
997 mutable Tabular tabular;
1001 InsetTabular(InsetTabular const &);
1003 void doDispatch(Cursor & cur, FuncRequest & cmd);
1005 bool getFeatureStatus(Cursor & cur, std::string const & s,
1006 std::string const & argument, FuncStatus & status) const;
1008 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
1010 Inset * clone() const { return new InsetTabular(*this); }
1013 bool hitSelectRow(BufferView const & bv, int x) const;
1015 bool hitSelectColumn(BufferView const & bv, int y) const;
1016 /// Returns true if coordinates are on row/column selection zones
1017 bool clickable(BufferView const &, int x, int y) const;
1020 void drawCellLines(PainterInfo &, int x, int y, row_type row,
1021 idx_type cell) const;
1023 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
1026 void moveNextCell(Cursor & cur,
1027 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1029 void movePrevCell(Cursor & cur,
1030 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
1032 int cellXPos(idx_type cell) const;
1034 int cellYPos(idx_type cell) const;
1036 bool copySelection(Cursor & cur);
1038 bool pasteClipboard(Cursor & cur);
1040 void cutSelection(Cursor & cur);
1042 void getSelection(Cursor & cur, row_type & rs, row_type & re,
1043 col_type & cs, col_type & ce) const;
1045 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
1047 /// return the "Manhattan distance" to nearest corner
1048 int dist(BufferView &, idx_type cell, int x, int y) const;
1049 /// return the cell nearest to x, y
1050 idx_type getNearestCell(BufferView &, int x, int y) const;
1052 /// test the rotation state of the give cell range.
1053 bool oneCellHasRotationState(bool rotated,
1054 row_type row_start, row_type row_end,
1055 col_type col_start, col_type col_end) const;
1057 mutable idx_type first_visible_cell_;
1058 /// The vertical offset of the table due to the vertical
1059 /// alignment with respect to the baseline.
1060 mutable int offset_valign_;
1061 /// true when selecting rows with the mouse
1063 /// true when selecting columns with the mouse
1067 std::string const featureAsString(Tabular::Feature feature);
1069 /// Split cell on decimal symbol
1070 InsetTableCell splitCell(InsetTableCell & head, docstring const & decimal_sym, bool & hassep);
1074 #endif // INSET_TABULAR_H