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
14 * Full author contact details are available in file CREDITS.
17 // Things to think of when designing the new tabular support:
18 // - color support (colortbl, color)
19 // - decimal alignment (dcloumn)
20 // - custom lines (hhline)
23 #ifndef INSET_TABULAR_H
24 #define INSET_TABULAR_H
27 #include "InsetText.h"
31 #include "support/shared_ptr.h"
48 namespace frontend { class Painter; }
56 // A helper struct for tables
137 UNSET_ROTATE_TABULAR,
139 TOGGLE_ROTATE_TABULAR,
167 SET_SPECIAL_MULTICOLUMN,
169 SET_SPECIAL_MULTIROW,
185 TABULAR_VALIGN_MIDDLE,
187 TABULAR_VALIGN_BOTTOM,
189 LONGTABULAR_ALIGN_LEFT,
191 LONGTABULAR_ALIGN_CENTER,
193 LONGTABULAR_ALIGN_RIGHT,
204 CELL_BEGIN_OF_MULTICOLUMN,
206 CELL_PART_OF_MULTICOLUMN,
208 CELL_BEGIN_OF_MULTIROW,
210 CELL_PART_OF_MULTIROW
218 LYX_VALIGN_MIDDLE = 1,
220 LYX_VALIGN_BOTTOM = 2
226 LYX_LONGTABULAR_ALIGN_LEFT = 0,
228 LYX_LONGTABULAR_ALIGN_CENTER = 1,
230 LYX_LONGTABULAR_ALIGN_RIGHT = 2
246 // we have this header type (is set in the getLT... functions)
248 // double borders on top
250 // double borders on bottom
252 // used for FirstHeader & LastFooter and if this is true
253 // all the rows marked as FirstHeader or LastFooter are
254 // ignored in the output and it is set to be empty!
258 /// type for row numbers
259 typedef size_t row_type;
260 /// type for column numbers
261 typedef size_t col_type;
262 /// type for cell indices
263 typedef size_t idx_type;
264 /// index indicating an invalid position
265 static const idx_type npos = static_cast<idx_type>(-1);
268 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
270 /// Returns true if there is a topline, returns false if not
271 bool topLine(idx_type cell) const;
272 /// Returns true if there is a topline, returns false if not
273 bool bottomLine(idx_type cell) const;
274 /// Returns true if there is a topline, returns false if not
275 bool leftLine(idx_type cell) const;
276 /// Returns true if there is a topline, returns false if not
277 bool rightLine(idx_type cell) const;
279 /// return space occupied by the second horizontal line and
280 /// interline space above row \p row in pixels
281 int interRowSpace(row_type row) const;
283 int interColumnSpace(idx_type cell) const;
285 /* returns the maximum over all rows */
287 int cellWidth(idx_type cell) const;
289 int cellHeight(idx_type cell) const;
295 row_type nrows() const {return row_info.size();}
297 col_type ncols() const {return column_info.size();}
299 int rowAscent(row_type row) const;
301 int rowDescent(row_type row) const;
303 void setRowAscent(row_type row, int height);
305 void setRowDescent(row_type row, int height);
307 void setTopLine(idx_type cell, bool line);
309 void setBottomLine(idx_type cell, bool line);
311 void setLeftLine(idx_type cell, bool line);
313 void setRightLine(idx_type cell, bool line);
315 bool rowTopLine(row_type row) const;
317 bool rowBottomLine(row_type row) const;
319 bool columnLeftLine(col_type column) const;
321 bool columnRightLine(col_type column) const;
323 void setAlignment(idx_type cell, LyXAlignment align,
324 bool onlycolumn = false);
326 void setVAlignment(idx_type cell, VAlignment align,
327 bool onlycolumn = false);
329 void setColumnPWidth(Cursor &, idx_type, Length const &);
331 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
333 void setAlignSpecial(idx_type cell, docstring const & special,
336 LyXAlignment getAlignment(idx_type cell,
337 bool onlycolumn = false) const;
339 VAlignment getVAlignment(idx_type cell,
340 bool onlycolumn = false) const;
342 Length const getPWidth(idx_type cell) const;
344 int textHOffset(idx_type cell) const;
346 int textVOffset(idx_type cell) const;
348 void appendRow(idx_type cell);
350 void deleteRow(row_type row);
352 void copyRow(row_type);
354 void appendColumn(idx_type cell);
356 void deleteColumn(col_type column);
358 void copyColumn(col_type);
360 idx_type getFirstCellInRow(row_type row) const;
362 idx_type getLastCellInRow(row_type row) const;
364 idx_type numberOfCellsInRow(row_type row) const;
366 void write(std::ostream &) const;
370 int latex(odocstream &, OutputParams const &) const;
372 int docbook(odocstream & os, OutputParams const &) const;
374 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
376 void plaintext(odocstream &,
377 OutputParams const & runparams, int const depth,
378 bool onlydata, char_type delim) const;
380 bool isMultiColumn(idx_type cell) const;
382 idx_type setMultiColumn(idx_type cell, idx_type number);
384 void unsetMultiColumn(idx_type cell);
386 bool isPartOfMultiColumn(row_type row, col_type column) const;
388 bool isPartOfMultiRow(row_type row, col_type column) const;
390 bool isMultiRow(idx_type cell) const;
392 idx_type setMultiRow(idx_type cell, idx_type number);
394 void unsetMultiRow(idx_type cell);
396 row_type cellRow(idx_type cell) const;
398 col_type cellColumn(idx_type cell) const;
400 void setRotateCell(idx_type cell, bool);
402 bool getRotateCell(idx_type cell) const;
404 bool needRotating() const;
406 bool isLastCell(idx_type cell) const;
408 idx_type cellAbove(idx_type cell) const;
410 idx_type cellBelow(idx_type cell) const;
412 idx_type cellIndex(row_type row, col_type column) const;
414 void setUsebox(idx_type cell, BoxType);
416 BoxType getUsebox(idx_type cell) const;
418 // Long Tabular Options support functions
420 bool checkLTType(row_type row, ltType const &) const;
422 void setLTHead(row_type row, bool flag, ltType const &, bool first);
424 bool getRowOfLTHead(row_type row, ltType &) const;
426 bool getRowOfLTFirstHead(row_type row, ltType &) const;
428 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
430 bool getRowOfLTFoot(row_type row, ltType &) const;
432 bool getRowOfLTLastFoot(row_type row, ltType &) const;
434 void setLTNewPage(row_type row, bool what);
436 bool getLTNewPage(row_type row) const;
438 idx_type setLTCaption(row_type row, bool what);
440 bool ltCaption(row_type row) const;
442 bool haveLTHead() const;
444 bool haveLTFirstHead() const;
446 bool haveLTFoot() const;
448 bool haveLTLastFoot() const;
450 bool haveLTCaption() const;
452 // end longtable support
454 shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
456 shared_ptr<InsetTableCell> cellInset(row_type row,
457 col_type column) const;
459 void setCellInset(row_type row, col_type column,
460 shared_ptr<InsetTableCell>) const;
461 /// Search for \param inset in the tabular, with the
463 void validate(LaTeXFeatures &) const;
465 // FIXME Now that cells have an InsetTableCell as their insets, rather
466 // than an InsetText, it'd be possible to reverse the relationship here,
467 // so that cell_vector was a vector<InsetTableCell> rather than a
468 // vector<CellData>, and an InsetTableCell had a CellData as a member,
469 // or perhaps just had its members as members.
476 CellData(CellData const &);
478 CellData & operator=(CellData);
480 void swap(CellData & rhs);
490 LyXAlignment alignment;
492 VAlignment valignment;
493 /// width of the part before the decimal
495 /// width of the decimal part
512 docstring align_special;
514 Length p_width; // this is only set for multicolumn!!!
516 shared_ptr<InsetTableCell> inset;
518 CellData & cellInfo(idx_type cell) const;
520 typedef std::vector<CellData> cell_vector;
522 typedef std::vector<cell_vector> cell_vvector;
533 /// Extra space between the top line and this row
535 /// Ignore top_space if true and use the default top space
536 bool top_space_default;
537 /// Extra space between this row and the bottom line
539 /// Ignore bottom_space if true and use the default bottom space
540 bool bottom_space_default;
541 /// Extra space between the bottom line and the next top line
542 Length interline_space;
543 /// Ignore interline_space if true and use the default interline space
544 bool interline_space_default;
545 /// This are for longtabulars only
548 /// a row of endfirsthead
552 /// row of endlastfoot
554 /// row for a newpage
560 typedef std::vector<RowData> row_vector;
568 LyXAlignment alignment;
570 VAlignment valignment;
576 docstring align_special;
578 docstring decimal_point;
581 typedef std::vector<ColumnData> column_vector;
584 idx_type numberofcells;
586 std::vector<row_type> rowofcell;
588 std::vector<col_type> columnofcell;
592 column_vector column_info;
594 mutable cell_vvector cell_info;
600 VAlignment tabular_valignment;
604 HAlignment longtabular_alignment;
606 bool is_long_tabular;
609 /// endfirsthead data
617 void init(Buffer *, row_type rows_arg,
618 col_type columns_arg);
620 void updateIndexes();
622 bool setFixedWidth(row_type r, col_type c);
623 /// return true of update is needed
624 bool updateColumnWidths();
626 idx_type columnSpan(idx_type cell) const;
628 idx_type rowSpan(idx_type cell) const;
630 BoxType useParbox(idx_type cell) const;
632 // helper function for Latex returns number of newlines
634 int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
636 int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
638 int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
640 int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
642 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
644 bool isValidRow(row_type const row) const;
646 int TeXRow(odocstream &, row_type const row,
647 OutputParams const &) const;
649 // helper functions for plain text
651 bool plaintextTopHLine(odocstream &, row_type row,
652 std::vector<unsigned int> const &) const;
654 bool plaintextBottomHLine(odocstream &, row_type row,
655 std::vector<unsigned int> const &) const;
657 void plaintextPrintCell(odocstream &,
658 OutputParams const &,
659 idx_type cell, row_type row, col_type column,
660 std::vector<unsigned int> const &,
661 bool onlydata) const;
662 /// auxiliary function for docbook
663 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
665 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
667 /// change associated Buffer
668 void setBuffer(Buffer & buffer);
669 /// retrieve associated Buffer
670 Buffer & buffer() const { return *buffer_; }
679 class InsetTableCell : public InsetText
683 InsetTableCell(Buffer * buf);
685 InsetCode lyxCode() const { return CELL_CODE; }
687 Inset * clone() { return new InsetTableCell(*this); }
689 bool getStatus(Cursor & cur, FuncRequest const & cmd,
690 FuncStatus & status) const;
692 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
694 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
695 /// writes the contents of the cell as a string, optionally
696 /// descending into insets
697 docstring asString(bool intoInsets = true);
699 docstring xhtml(XHTMLStream &, OutputParams const &) const;
704 void operator=(InsetTableCell const &);
706 // This boolean is supposed to track whether the cell has had its
707 // width explicitly set. We need to know this to determine whether
708 // layout changes and paragraph customization are allowed---that is,
709 // we need it in forcePlainLayout() and allowParagraphCustomization().
710 // Unfortunately, that information is not readily available in
711 // InsetTableCell. In the case of multicolumn cells, it is present
712 // in CellData, and so would be available here if CellData were to
713 // become a member of InsetTableCell. But in the other case, it isn't
714 // even available there, but is held in Tabular::ColumnData.
715 // So, the present solution uses this boolean to track the information
716 // we need to track, and tries to keep it updated. This is not ideal,
717 // but the other solutions are no better. These are:
718 // (i) Keep a pointer in InsetTableCell to the table;
719 // (ii) Find the table by iterating over the Buffer's insets.
720 // Solution (i) raises the problem of updating the pointer when an
721 // InsetTableCell is copied, and we'd therefore need a copy constructor
722 // in InsetTabular and then in Tabular, which seems messy, given how
723 // complicated those classes are. Solution (ii) involves a lot of
724 // iterating, since this information is needed quite often, and so may
726 // So, well, if someone can do better, please do!
730 // FIXME: Here the thoughts from the comment above also apply.
732 LyXAlignment contentAlign;
733 /// should paragraph indendation be omitted in any case?
734 bool neverIndent() const { return true; }
736 LyXAlignment contentAlignment() const { return contentAlign; }
738 virtual bool usePlainLayout() const { return true; }
740 virtual bool forcePlainLayout(idx_type = 0) const;
742 virtual bool allowParagraphCustomization(idx_type = 0) const;
743 /// Is the width forced to some value?
744 bool hasFixedWidth() const { return isFixedWidth; }
748 class InsetTabular : public Inset
752 InsetTabular(Buffer *, row_type rows = 1,
753 col_type columns = 1);
757 void setBuffer(Buffer & buffer);
760 static void string2params(std::string const &, InsetTabular &);
762 static std::string params2string(InsetTabular const &);
766 void write(std::ostream &) const;
768 void metrics(MetricsInfo &, Dimension &) const;
770 void draw(PainterInfo & pi, int x, int y) const;
772 void drawSelection(PainterInfo & pi, int x, int y) const;
774 bool editable() const { return true; }
776 bool hasSettings() const { return true; }
778 bool insetAllowed(InsetCode code) const;
780 bool allowSpellCheck() const { return true; }
782 bool canTrackChanges() const { return true; }
783 /** returns true if, when outputing LaTeX, font changes should
784 be closed before generating this inset. This is needed for
785 insets that may contain several paragraphs */
786 bool noFontChange() const { return true; }
788 DisplayType display() const;
790 int latex(odocstream &, OutputParams const &) const;
792 int plaintext(odocstream &, OutputParams const &) const;
794 int docbook(odocstream &, OutputParams const &) const;
796 docstring xhtml(XHTMLStream &, OutputParams const &) const;
798 void validate(LaTeXFeatures & features) const;
800 InsetCode lyxCode() const { return TABULAR_CODE; }
802 docstring contextMenu(BufferView const & bv, int x, int y) const;
803 /// get offset of this cursor slice relative to our upper left corner
804 void cursorPos(BufferView const & bv, CursorSlice const & sl,
805 bool boundary, int & x, int & y) const;
807 bool tabularFeatures(Cursor & cur, std::string const & what);
809 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
810 std::string const & val = std::string());
812 size_t nargs() const { return tabular.numberofcells; }
814 shared_ptr<InsetTableCell const> cell(idx_type) const;
816 shared_ptr<InsetTableCell> cell(idx_type);
818 Text * getText(int) const;
820 /// set the change for the entire inset
821 void setChange(Change const & change);
822 /// accept the changes within the inset
823 void acceptChanges();
824 /// reject the changes within the inset
825 void rejectChanges();
827 // this should return true if we have a "normal" cell, otherwise false.
828 // "normal" means without width set!
829 /// should all paragraphs be output with "Standard" layout?
830 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
832 virtual bool forcePlainLayout(idx_type cell = 0) const;
834 void addPreview(DocIterator const & inset_pos,
835 graphics::PreviewLoader &) const;
837 /// lock cell with given index
838 void edit(Cursor & cur, bool front, EntryDirection entry_from);
839 /// get table row from x coordinate
840 int rowFromY(Cursor & cur, int y) const;
841 /// get table column from y coordinate
842 int columnFromX(Cursor & cur, int x) const;
844 Inset * editXY(Cursor & cur, int x, int y);
845 /// can we go further down on mouse click?
846 bool descendable(BufferView const &) const { return true; }
847 /// Update the counters of this inset and of its contents
848 void updateBuffer(ParIterator const &, UpdateType);
850 void addToToc(DocIterator const &);
853 bool completionSupported(Cursor const &) const;
855 bool inlineCompletionSupported(Cursor const & cur) const;
857 bool automaticInlineCompletion() const;
859 bool automaticPopupCompletion() const;
861 bool showCompletionCursor() const;
863 CompletionList const * createCompletionList(Cursor const & cur) const;
865 docstring completionPrefix(Cursor const & cur) const;
867 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
869 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
871 virtual bool usePlainLayout() const { return true; }
874 InsetTabular * asInsetTabular() { return this; }
876 InsetTabular const * asInsetTabular() const { return this; }
878 bool isRightToLeft(Cursor & cur) const;
879 /// writes the cells between stidx and enidx as a string, optionally
880 /// descending into the insets
881 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
883 /// Returns whether the cell in the specified row and column is selected.
884 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
886 // Public structures and variables
888 mutable Tabular tabular;
892 InsetTabular(InsetTabular const &);
894 void doDispatch(Cursor & cur, FuncRequest & cmd);
896 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
898 int scroll() const { return scx_; }
900 Inset * clone() const { return new InsetTabular(*this); }
903 void drawCellLines(frontend::Painter &, int x, int y, row_type row,
904 idx_type cell, Change const & change) const;
906 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
909 void moveNextCell(Cursor & cur,
910 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
912 void movePrevCell(Cursor & cur,
913 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
915 int cellXPos(idx_type cell) const;
917 void resetPos(Cursor & cur) const;
919 bool copySelection(Cursor & cur);
921 bool pasteClipboard(Cursor & cur);
923 void cutSelection(Cursor & cur);
925 void getSelection(Cursor & cur, row_type & rs, row_type & re,
926 col_type & cs, col_type & ce) const;
928 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
930 /// return the "Manhattan distance" to nearest corner
931 int dist(BufferView &, idx_type cell, int x, int y) const;
932 /// return the cell nearest to x, y
933 idx_type getNearestCell(BufferView &, int x, int y) const;
935 /// test the rotation state of the give cell range.
936 bool oneCellHasRotationState(bool rotated,
937 row_type row_start, row_type row_end,
938 col_type col_start, col_type col_end) const;
940 mutable idx_type first_visible_cell;
943 /// true when selecting rows with the mouse
945 /// true when selecting columns with the mouse
949 std::string const featureAsString(Tabular::Feature feature);
951 /// Split cell on decimal symbol
952 InsetTableCell splitCell(InsetTableCell & head, docstring const decimal_sym, bool & hassep);
956 #endif // INSET_TABULAR_H