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
12 * Full author contact details are available in file CREDITS.
16 // This is Juergen's rewrite of the tabular (table) support.
18 // Things to think of when designing the new tabular support:
19 // - color support (colortbl, color)
20 // - decimal alignment (dcloumn)
21 // - custom lines (hhline)
27 // This is what I have written about tabular support in the LyX3-Tasks file:
29 // o rewrite of table code. Should probably be written as some
30 // kind of an inset. [Done]
31 // o enhance longtable support
35 #ifndef INSET_TABULAR_H
36 #define INSET_TABULAR_H
39 #include "InsetText.h"
43 #include <boost/shared_ptr.hpp>
60 namespace frontend { class Painter; }
68 // A helper struct for tables
137 UNSET_ROTATE_TABULAR,
139 TOGGLE_ROTATE_TABULAR,
188 CELL_BEGIN_OF_MULTICOLUMN,
190 CELL_PART_OF_MULTICOLUMN
198 LYX_VALIGN_BOTTOM = 1,
200 LYX_VALIGN_MIDDLE = 2
216 // we have this header type (is set in the getLT... functions)
218 // double borders on top
220 // double borders on bottom
222 // used for FirstHeader & LastFooter and if this is true
223 // all the rows marked as FirstHeader or LastFooter are
224 // ignored in the output and it is set to be empty!
228 /// type for row numbers
229 typedef size_t row_type;
230 /// type for column numbers
231 typedef size_t col_type;
232 /// type for cell indices
233 typedef size_t idx_type;
234 /// index indicating an invalid position
235 static const idx_type npos = static_cast<idx_type>(-1);
238 Tabular(Buffer &, col_type columns_arg, row_type rows_arg);
240 /// Returns true if there is a topline, returns false if not
241 bool topLine(idx_type cell) const;
242 /// Returns true if there is a topline, returns false if not
243 bool bottomLine(idx_type cell) const;
244 /// Returns true if there is a topline, returns false if not
245 bool leftLine(idx_type cell) const;
246 /// Returns true if there is a topline, returns false if not
247 bool rightLine(idx_type cell) const;
250 bool topAlreadyDrawn(idx_type cell) const;
252 bool leftAlreadyDrawn(idx_type cell) const;
254 bool isLastRow(idx_type cell) const;
256 /// return space occupied by the second horizontal line and
257 /// interline space above row \p row in pixels
258 int getAdditionalHeight(row_type row) const;
260 int getAdditionalWidth(idx_type cell) const;
262 /* returns the maximum over all rows */
264 int columnWidth(idx_type cell) const;
270 int rowAscent(row_type row) const;
272 int rowDescent(row_type row) const;
274 void setRowAscent(row_type row, int height);
276 void setRowDescent(row_type row, int height);
278 void setCellWidth(idx_type cell, int new_width);
280 void setAllLines(idx_type cell, bool line);
282 void setTopLine(idx_type cell, bool line);
284 void setBottomLine(idx_type cell, bool line);
286 void setLeftLine(idx_type cell, bool line);
288 void setRightLine(idx_type cell, bool line);
290 bool rowTopLine(row_type row) const;
292 bool rowBottomLine(row_type row) const;
294 bool columnLeftLine(col_type column) const;
296 bool columnRightLine(col_type column) const;
298 void setAlignment(idx_type cell, LyXAlignment align,
299 bool onlycolumn = false);
301 void setVAlignment(idx_type cell, VAlignment align,
302 bool onlycolumn = false);
304 void setColumnPWidth(Cursor &, idx_type, Length const &);
306 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
308 void setAlignSpecial(idx_type cell, docstring const & special,
311 LyXAlignment getAlignment(idx_type cell,
312 bool onlycolumn = false) const;
314 VAlignment getVAlignment(idx_type cell,
315 bool onlycolumn = false) const;
317 Length const getPWidth(idx_type cell) const;
319 int cellWidth(idx_type cell) const;
321 int getBeginningOfTextInCell(idx_type cell) const;
323 void appendRow(idx_type cell);
325 void deleteRow(row_type row);
327 void copyRow(row_type);
329 void appendColumn(idx_type cell);
331 void deleteColumn(col_type column);
333 void copyColumn(col_type);
335 bool isFirstCellInRow(idx_type cell) const;
337 idx_type getFirstCellInRow(row_type row) const;
339 bool isLastCellInRow(idx_type cell) const;
341 idx_type getLastCellInRow(row_type row) const;
343 idx_type numberOfCellsInRow(idx_type cell) const;
345 void write(std::ostream &) const;
349 int latex(odocstream &, OutputParams const &) const;
351 int docbook(odocstream & os, OutputParams const &) const;
353 void plaintext(odocstream &,
354 OutputParams const & runparams, int const depth,
355 bool onlydata, char_type delim) const;
357 bool isMultiColumn(idx_type cell) const;
359 bool isMultiColumnReal(idx_type cell) const;
361 void setMultiColumn(idx_type cell, idx_type number);
363 idx_type unsetMultiColumn(idx_type cell); // returns number of new cells
365 bool isPartOfMultiColumn(row_type row, col_type column) const;
367 row_type cellRow(idx_type cell) const;
369 col_type cellColumn(idx_type cell) const;
371 col_type cellRightColumn(idx_type cell) const;
373 void setRotateCell(idx_type cell, bool);
375 bool getRotateCell(idx_type cell) const;
377 bool needRotating() const;
379 bool isLastCell(idx_type cell) const;
381 idx_type cellAbove(idx_type cell) const;
383 idx_type cellBelow(idx_type cell) const;
385 idx_type cellIndex(row_type row, col_type column) const;
387 void setUsebox(idx_type cell, BoxType);
389 BoxType getUsebox(idx_type cell) const;
391 // Long Tabular Options support functions
393 bool checkLTType(row_type row, ltType const &) const;
395 void setLTHead(row_type row, bool flag, ltType const &, bool first);
397 bool getRowOfLTHead(row_type row, ltType &) const;
399 bool getRowOfLTFirstHead(row_type row, ltType &) const;
401 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
403 bool getRowOfLTFoot(row_type row, ltType &) const;
405 bool getRowOfLTLastFoot(row_type row, ltType &) const;
407 void setLTNewPage(row_type row, bool what);
409 bool getLTNewPage(row_type row) const;
411 idx_type setLTCaption(row_type row, bool what);
413 bool ltCaption(row_type row) const;
415 bool haveLTHead() const;
417 bool haveLTFirstHead() const;
419 bool haveLTFoot() const;
421 bool haveLTLastFoot() const;
423 // end longtable support
425 boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
427 boost::shared_ptr<InsetTableCell> cellInset(row_type row,
428 col_type column) const;
430 void setCellInset(row_type row, col_type column,
431 boost::shared_ptr<InsetTableCell>) const;
432 /// Search for \param inset in the tabular, with the
434 void validate(LaTeXFeatures &) const;
436 // FIXME Now that cells have an InsetTableCell as their insets, rather
437 // than an InsetText, it'd be possible to reverse the relationship here,
438 // so that cell_vector was a vector<InsetTableCell> rather than a
439 // vector<CellData>, and an InsetTableCell had a CellData as a member,
440 // or perhaps just had its members as members.
447 CellData(CellData const &);
449 CellData & operator=(CellData);
451 void swap(CellData & rhs);
459 LyXAlignment alignment;
461 VAlignment valignment;
475 docstring align_special;
477 Length p_width; // this is only set for multicolumn!!!
479 boost::shared_ptr<InsetTableCell> inset;
481 CellData & cellInfo(idx_type cell) const;
483 typedef std::vector<CellData> cell_vector;
485 typedef std::vector<cell_vector> cell_vvector;
496 /// Extra space between the top line and this row
498 /// Ignore top_space if true and use the default top space
499 bool top_space_default;
500 /// Extra space between this row and the bottom line
502 /// Ignore bottom_space if true and use the default bottom space
503 bool bottom_space_default;
504 /// Extra space between the bottom line and the next top line
505 Length interline_space;
506 /// Ignore interline_space if true and use the default interline space
507 bool interline_space_default;
508 /// This are for longtabulars only
511 /// a row of endfirsthead
515 /// row of endlastfoot
517 /// row for a newpage
523 typedef std::vector<RowData> row_vector;
531 LyXAlignment alignment;
533 VAlignment valignment;
539 docstring align_special;
542 typedef std::vector<ColumnData> column_vector;
545 idx_type numberofcells;
547 std::vector<row_type> rowofcell;
549 std::vector<col_type> columnofcell;
553 column_vector column_info;
555 mutable cell_vvector cell_info;
563 bool is_long_tabular;
566 /// endfirsthead data
574 void init(Buffer &, row_type rows_arg,
575 col_type columns_arg);
577 void updateIndexes();
579 bool setFixedWidth(row_type r, col_type c);
581 void updateContentAlignment(row_type r, col_type c);
582 /// return true of update is needed
583 bool updateColumnWidths();
585 idx_type columnSpan(idx_type cell) const;
587 BoxType useParbox(idx_type cell) const;
589 // helper function for Latex returns number of newlines
591 int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
593 int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
595 int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol) const;
597 int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol) const;
599 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
601 bool isValidRow(row_type const row) const;
603 int TeXRow(odocstream &, row_type const row,
604 OutputParams const &) const;
606 // helper functions for plain text
608 bool plaintextTopHLine(odocstream &, row_type row,
609 std::vector<unsigned int> const &) const;
611 bool plaintextBottomHLine(odocstream &, row_type row,
612 std::vector<unsigned int> const &) const;
614 void plaintextPrintCell(odocstream &,
615 OutputParams const &,
616 idx_type cell, row_type row, col_type column,
617 std::vector<unsigned int> const &,
618 bool onlydata) const;
619 /// auxiliary function for docbook
620 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
622 /// change associated Buffer
623 void setBuffer(Buffer & buffer);
624 /// retrieve associated Buffer
625 Buffer & buffer() const { return *buffer_; }
634 class InsetTableCell : public InsetText
638 InsetTableCell(Buffer & buf);
640 InsetCode lyxCode() const { return CELL_CODE; }
642 Inset * clone() { return new InsetTableCell(*this); }
644 bool getStatus(Cursor & cur, FuncRequest const & cmd,
645 FuncStatus & status) const;
647 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
649 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
650 /// writes the contents of the cell as a string, optionally
651 /// descending into insets
652 docstring asString(bool intoInsets = true);
657 void operator=(InsetTableCell const &);
659 // This boolean is supposed to track whether the cell has had its
660 // width explicitly set. We need to know this to determine whether
661 // layout changes and paragraph customization are allowed---that is,
662 // we need it in forcePlainLayout() and allowParagraphCustomization().
663 // Unfortunately, that information is not readily available in
664 // InsetTableCell. In the case of multicolumn cells, it is present
665 // in CellData, and so would be available here if CellData were to
666 // become a member of InsetTableCell. But in the other case, it isn't
667 // even available there, but is held in Tabular::ColumnData.
668 // So, the present solution uses this boolean to track the information
669 // we need to track, and tries to keep it updated. This is not ideal,
670 // but the other solutions are no better. These are:
671 // (i) Keep a pointer in InsetTableCell to the table;
672 // (ii) Find the table by iterating over the Buffer's insets.
673 // Solution (i) raises the problem of updating the pointer when an
674 // InsetTableCell is copied, and we'd therefore need a copy constructor
675 // in InsetTabular and then in Tabular, which seems messy, given how
676 // complicated those classes are. Solution (ii) involves a lot of
677 // iterating, since this information is needed quite often, and so may
679 // So, well, if someone can do better, please do!
683 // FIXME: Here the thoughts from the comment above also apply.
685 LyXAlignment contentAlign;
686 /// should paragraph indendation be omitted in any case?
687 bool neverIndent() const { return true; }
689 LyXAlignment contentAlignment() const { return contentAlign; }
691 virtual bool usePlainLayout() const { return true; }
693 virtual bool forcePlainLayout(idx_type = 0) const;
695 virtual bool allowParagraphCustomization(idx_type = 0) const;
696 /// Is the width forced to some value?
697 bool hasFixedWidth() const { return isFixedWidth; }
701 class InsetTabular : public Inset
705 InsetTabular(Buffer &, row_type rows = 1,
706 col_type columns = 1);
710 void setBuffer(Buffer & buffer);
713 static void string2params(std::string const &, InsetTabular &);
715 static std::string params2string(InsetTabular const &);
719 void write(std::ostream &) const;
721 void metrics(MetricsInfo &, Dimension &) const;
723 void draw(PainterInfo & pi, int x, int y) const;
725 void drawSelection(PainterInfo & pi, int x, int y) const;
727 docstring editMessage() const;
729 EDITABLE editable() const { return HIGHLY_EDITABLE; }
731 bool insetAllowed(InsetCode code) const;
733 bool allowSpellCheck() const { return true; }
735 bool canTrackChanges() const { return true; }
736 /** returns true if, when outputing LaTeX, font changes should
737 be closed before generating this inset. This is needed for
738 insets that may contain several paragraphs */
739 bool noFontChange() const { return true; }
741 DisplayType display() const { return tabular.is_long_tabular ? AlignCenter : Inline; }
743 int latex(odocstream &, OutputParams const &) const;
745 int plaintext(odocstream &, OutputParams const &) const;
747 int docbook(odocstream &, OutputParams const &) const;
749 void validate(LaTeXFeatures & features) const;
751 InsetCode lyxCode() const { return TABULAR_CODE; }
753 docstring contextMenu(BufferView const & bv, int x, int y) const;
754 /// get offset of this cursor slice relative to our upper left corner
755 void cursorPos(BufferView const & bv, CursorSlice const & sl,
756 bool boundary, int & x, int & y) const;
758 bool tabularFeatures(Cursor & cur, std::string const & what);
760 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
761 std::string const & val = std::string());
763 void openLayoutDialog(BufferView *) const;
765 bool showInsetDialog(BufferView *) const;
767 size_t nargs() const { return tabular.numberofcells; }
769 boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
771 boost::shared_ptr<InsetTableCell> cell(idx_type);
773 Text * getText(int) const;
775 /// set the change for the entire inset
776 void setChange(Change const & change);
777 /// accept the changes within the inset
778 void acceptChanges(BufferParams const & bparams);
779 /// reject the changes within the inset
780 void rejectChanges(BufferParams const & bparams);
782 // this should return true if we have a "normal" cell, otherwise false.
783 // "normal" means without width set!
784 /// should all paragraphs be output with "Standard" layout?
785 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
787 virtual bool forcePlainLayout(idx_type cell = 0) const;
789 virtual bool usePlainLayout() { return true; }
791 void addPreview(graphics::PreviewLoader &) const;
793 /// lock cell with given index
794 void edit(Cursor & cur, bool front, EntryDirection entry_from);
795 /// get table row from x coordinate
796 int rowFromY(Cursor & cur, int y) const;
797 /// get table column from y coordinate
798 int columnFromX(Cursor & cur, int x) const;
800 Inset * editXY(Cursor & cur, int x, int y);
801 /// can we go further down on mouse click?
802 bool descendable() const { return true; }
803 // Update the counters of this inset and of its contents
804 void updateLabels(ParIterator const &);
807 bool completionSupported(Cursor const &) const;
809 bool inlineCompletionSupported(Cursor const & cur) const;
811 bool automaticInlineCompletion() const;
813 bool automaticPopupCompletion() const;
815 bool showCompletionCursor() const;
817 CompletionList const * createCompletionList(Cursor const & cur) const;
819 docstring completionPrefix(Cursor const & cur) const;
821 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
823 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
825 virtual bool usePlainLayout() const { return true; }
828 virtual InsetTabular * asInsetTabular() { return this; }
830 virtual InsetTabular const * asInsetTabular() const { return this; }
832 bool isRightToLeft(Cursor & cur) const;
833 /// writes the cells between stidx and enidx as a string, optionally
834 /// descending into the insets
835 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
837 /// Returns whether the cell in the specified row and column is selected.
838 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
840 // Public structures and variables
842 mutable Tabular tabular;
846 InsetTabular(InsetTabular const &);
848 void doDispatch(Cursor & cur, FuncRequest & cmd);
850 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
852 int scroll() const { return scx_; }
854 Inset * clone() const { return new InsetTabular(*this); }
857 void drawCellLines(frontend::Painter &, int x, int y, row_type row,
858 idx_type cell, bool erased) const;
860 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
863 void moveNextCell(Cursor & cur,
864 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
866 void movePrevCell(Cursor & cur,
867 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
869 int cellXPos(idx_type cell) const;
871 void resetPos(Cursor & cur) const;
873 void removeTabularRow();
875 bool copySelection(Cursor & cur);
877 bool pasteClipboard(Cursor & cur);
879 void cutSelection(Cursor & cur);
881 void getSelection(Cursor & cur, row_type & rs, row_type & re,
882 col_type & cs, col_type & ce) const;
884 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
886 /// return the "Manhattan distance" to nearest corner
887 int dist(BufferView &, idx_type cell, int x, int y) const;
888 /// return the cell nearest to x, y
889 idx_type getNearestCell(BufferView &, int x, int y) const;
891 /// test the rotation state of the give cell range.
892 bool oneCellHasRotationState(bool rotated,
893 row_type row_start, row_type row_end,
894 col_type col_start, col_type col_end) const;
896 mutable idx_type first_visible_cell;
899 /// true when selecting rows with the mouse
901 /// true when selecting columns with the mouse
905 std::string const featureAsString(Tabular::Feature feature);
909 #endif // INSET_TABULAR_H