4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Lars Gullik Bjønnes
9 * \author Matthias Ettrich
10 * \author André Pönitz
11 * \author Jürgen Vigna
13 * Full author contact details are available in file CREDITS.
17 // This is Juergen's rewrite of the tabular (table) support.
19 // Things to think of when designing the new tabular support:
20 // - color support (colortbl, color)
21 // - decimal alignment (dcloumn)
22 // - custom lines (hhline)
28 // This is what I have written about tabular support in the LyX3-Tasks file:
30 // o rewrite of table code. Should probably be written as some
31 // kind of an inset. [Done]
32 // o enhance longtable support
36 #ifndef INSETTABULAR_H
37 #define INSETTABULAR_H
40 #include "InsetText.h"
43 #include "MailInset.h"
45 #include <boost/shared_ptr.hpp>
61 namespace frontend { class Painter; }
69 // A helper struct for tables
138 UNSET_ROTATE_TABULAR,
140 TOGGLE_ROTATE_TABULAR,
187 CELL_BEGIN_OF_MULTICOLUMN,
189 CELL_PART_OF_MULTICOLUMN
197 LYX_VALIGN_BOTTOM = 1,
199 LYX_VALIGN_MIDDLE = 2
215 // we have this header type (is set in the getLT... functions)
217 // double borders on top
219 // double borders on bottom
221 // used for FirstHeader & LastFooter and if this is true
222 // all the rows marked as FirstHeader or LastFooter are
223 // ignored in the output and it is set to be empty!
227 /// type for row numbers
228 typedef size_t row_type;
229 /// type for column numbers
230 typedef size_t col_type;
231 /// type for cell indices
232 typedef size_t idx_type;
233 /// index indicating an invalid position
234 static const idx_type npos = static_cast<idx_type>(-1);
239 Tabular(Buffer const &, col_type columns_arg, row_type rows_arg);
241 /// Returns true if there is a topline, returns false if not
242 bool topLine(idx_type cell) const;
243 /// Returns true if there is a topline, returns false if not
244 bool bottomLine(idx_type cell) const;
245 /// Returns true if there is a topline, returns false if not
246 bool leftLine(idx_type cell) const;
247 /// Returns true if there is a topline, returns false if not
248 bool rightLine(idx_type cell) const;
251 bool topAlreadyDrawn(idx_type cell) const;
253 bool leftAlreadyDrawn(idx_type cell) const;
255 bool isLastRow(idx_type cell) const;
257 /// return space occupied by the second horizontal line and
258 /// interline space above row \p row in pixels
259 int getAdditionalHeight(row_type row) const;
261 int getAdditionalWidth(idx_type cell) const;
263 /* returns the maximum over all rows */
265 int columnWidth(idx_type cell) const;
271 int rowAscent(row_type row) const;
273 int rowDescent(row_type row) const;
275 void setRowAscent(row_type row, int height);
277 void setRowDescent(row_type row, int height);
279 void setCellWidth(idx_type cell, int new_width);
281 void setAllLines(idx_type cell, bool line);
283 void setTopLine(idx_type cell, bool line);
285 void setBottomLine(idx_type cell, bool line);
287 void setLeftLine(idx_type cell, bool line);
289 void setRightLine(idx_type cell, bool line);
291 bool rowTopLine(row_type row) const;
293 bool rowBottomLine(row_type row) const;
295 bool columnLeftLine(col_type column) const;
297 bool columnRightLine(col_type column) const;
299 void setAlignment(idx_type cell, LyXAlignment align,
300 bool onlycolumn = false);
302 void setVAlignment(idx_type cell, VAlignment align,
303 bool onlycolumn = false);
305 void setColumnPWidth(Cursor &, idx_type, Length const &);
307 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
309 void setAlignSpecial(idx_type cell, docstring const & special,
312 LyXAlignment getAlignment(idx_type cell,
313 bool onlycolumn = false) const;
315 VAlignment getVAlignment(idx_type cell,
316 bool onlycolumn = false) const;
318 Length const getPWidth(idx_type cell) const;
320 Length const getColumnPWidth(idx_type cell) const;
322 Length const getMColumnPWidth(idx_type cell) const;
324 docstring const getAlignSpecial(idx_type cell, int what) const;
326 int cellWidth(idx_type cell) const;
328 int getBeginningOfTextInCell(idx_type cell) const;
330 void appendRow(idx_type cell);
332 void deleteRow(row_type row);
334 void copyRow(row_type);
336 void appendColumn(idx_type cell);
338 void deleteColumn(col_type column);
340 void copyColumn(col_type);
342 bool isFirstCellInRow(idx_type cell) const;
344 idx_type getFirstCellInRow(row_type row) const;
346 bool isLastCellInRow(idx_type cell) const;
348 idx_type getLastCellInRow(row_type row) const;
350 idx_type cellCount() const;
352 idx_type numberOfCellsInRow(idx_type cell) const;
354 void write(std::ostream &) const;
358 int latex(odocstream &, OutputParams const &) const;
360 int docbook(odocstream & os, OutputParams const &) const;
362 void plaintext(odocstream &,
363 OutputParams const & runparams, int const depth,
364 bool onlydata, char_type delim) const;
366 bool isMultiColumn(idx_type cell) const;
368 bool isMultiColumnReal(idx_type cell) const;
370 void setMultiColumn(idx_type cell, idx_type number);
372 idx_type unsetMultiColumn(idx_type cell); // returns number of new cells
374 bool isPartOfMultiColumn(row_type row, col_type column) const;
376 row_type cellRow(idx_type cell) const;
378 col_type cellColumn(idx_type cell) const;
380 col_type cellRightColumn(idx_type cell) const;
382 void setBookTabs(bool);
384 bool useBookTabs() const;
386 void setLongTabular(bool);
388 bool isLongTabular() const;
390 void setRotateTabular(bool);
392 bool getRotateTabular() const;
394 void setRotateCell(idx_type cell, bool);
396 bool getRotateCell(idx_type cell) const;
398 bool needRotating() const;
400 bool isLastCell(idx_type cell) const;
402 idx_type getCellAbove(idx_type cell) const;
404 idx_type getCellBelow(idx_type cell) const;
406 idx_type getLastCellAbove(idx_type cell) const;
408 idx_type getLastCellBelow(idx_type cell) const;
410 idx_type cellIndex(row_type row, col_type column) const;
412 void setUsebox(idx_type cell, BoxType);
414 BoxType getUsebox(idx_type cell) const;
416 // Long Tabular Options support functions
418 bool checkLTType(row_type row, ltType const &) const;
420 void setLTHead(row_type row, bool flag, ltType const &, bool first);
422 bool getRowOfLTHead(row_type row, ltType &) const;
424 bool getRowOfLTFirstHead(row_type row, ltType &) const;
426 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
428 bool getRowOfLTFoot(row_type row, ltType &) const;
430 bool getRowOfLTLastFoot(row_type row, ltType &) const;
432 void setLTNewPage(row_type row, bool what);
434 bool getLTNewPage(row_type row) const;
436 bool haveLTHead() const;
438 bool haveLTFirstHead() const;
440 bool haveLTFoot() const;
442 bool haveLTLastFoot() const;
444 // end longtable support
446 boost::shared_ptr<InsetText> getCellInset(idx_type cell) const;
448 boost::shared_ptr<InsetText> getCellInset(row_type row,
449 col_type column) const;
451 void setCellInset(row_type row, col_type column,
452 boost::shared_ptr<InsetText>) const;
453 /// Search for \param inset in the tabular, with the
455 idx_type getCellFromInset(Inset const * inset) const;
457 row_type rowCount() const { return row_info.size(); }
459 col_type columnCount() const { return column_info.size();}
461 void validate(LaTeXFeatures &) const;
468 CellData(Buffer const &);
470 CellData(CellData const &);
472 CellData & operator=(CellData);
474 void swap(CellData & rhs);
482 LyXAlignment alignment;
484 VAlignment valignment;
498 docstring align_special;
500 Length p_width; // this is only set for multicolumn!!!
502 boost::shared_ptr<InsetText> inset;
504 CellData & cellinfo_of_cell(idx_type cell) const;
506 typedef std::vector<CellData> cell_vector;
508 typedef std::vector<cell_vector> cell_vvector;
523 /// Extra space between the top line and this row
525 /// Ignore top_space if true and use the default top space
526 bool top_space_default;
527 /// Extra space between this row and the bottom line
529 /// Ignore bottom_space if true and use the default bottom space
530 bool bottom_space_default;
531 /// Extra space between the bottom line and the next top line
532 Length interline_space;
533 /// Ignore interline_space if true and use the default interline space
534 bool interline_space_default;
535 /// This are for longtabulars only
538 /// a row of endfirsthead
542 /// row of endlastfoot
544 /// row for a newpage
548 typedef std::vector<RowData> row_vector;
556 LyXAlignment alignment;
558 VAlignment valignment;
568 docstring align_special;
571 typedef std::vector<ColumnData> column_vector;
574 idx_type numberofcells;
576 std::vector<row_type> rowofcell;
578 std::vector<col_type> columnofcell;
582 column_vector column_info;
584 mutable cell_vvector cell_info;
592 bool is_long_tabular;
595 /// endfirsthead data
603 void init(Buffer const &, row_type rows_arg,
604 col_type columns_arg);
606 void updateIndexes();
607 /// Returns true if a complete update is necessary, otherwise false
608 bool setWidthOfMulticolCell(idx_type cell, int new_width);
610 void recalculateMulticolumnsOfColumn(col_type column);
611 /// Returns true if change
612 void calculate_width_of_column(col_type column);
614 bool calculate_width_of_column_NMC(col_type column); // no multi cells
616 idx_type columnSpan(idx_type cell) const;
618 BoxType useParbox(idx_type cell) const;
620 // helper function for Latex returns number of newlines
622 int TeXTopHLine(odocstream &, row_type row) const;
624 int TeXBottomHLine(odocstream &, row_type row) const;
626 int TeXCellPreamble(odocstream &, idx_type cell) const;
628 int TeXCellPostamble(odocstream &, idx_type cell) const;
630 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
632 bool isValidRow(row_type const row) const;
634 int TeXRow(odocstream &, row_type const row,
635 OutputParams const &) const;
637 // helper functions for plain text
639 bool plaintextTopHLine(odocstream &, row_type row,
640 std::vector<unsigned int> const &) const;
642 bool plaintextBottomHLine(odocstream &, row_type row,
643 std::vector<unsigned int> const &) const;
645 void plaintextPrintCell(odocstream &,
646 OutputParams const &,
647 idx_type cell, row_type row, col_type column,
648 std::vector<unsigned int> const &,
649 bool onlydata) const;
650 /// auxiliary function for docbook
651 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
653 /// change associated Buffer
654 void setBuffer(Buffer const & buffer) { buffer_ = &buffer; }
655 /// retrieve associated Buffer
656 Buffer const & buffer() const { return *buffer_; }
659 Buffer const * buffer_;
661 /// renumber cells after structural changes
667 class InsetTabular : public Inset {
670 InsetTabular(Buffer const &, row_type rows = 1,
671 col_type columns = 1);
677 void write(std::ostream &) const;
679 void metrics(MetricsInfo &, Dimension &) const;
681 void draw(PainterInfo & pi, int x, int y) const;
683 void drawSelection(PainterInfo & pi, int x, int y) const;
685 docstring editMessage() const;
687 EDITABLE editable() const { return HIGHLY_EDITABLE; }
689 bool insetAllowed(InsetCode code) const;
691 bool allowSpellCheck() const { return true; }
693 bool canTrackChanges() const { return true; }
694 /** returns true if, when outputing LaTeX, font changes should
695 be closed before generating this inset. This is needed for
696 insets that may contain several paragraphs */
697 bool noFontChange() const { return true; }
699 DisplayType display() const { return tabular.isLongTabular() ? AlignCenter : Inline; }
701 int latex(odocstream &, OutputParams const &) const;
703 int plaintext(odocstream &, OutputParams const &) const;
705 int docbook(odocstream &, OutputParams const &) const;
707 void validate(LaTeXFeatures & features) const;
709 InsetCode lyxCode() const { return TABULAR_CODE; }
710 /// get offset of this cursor slice relative to our upper left corner
711 void cursorPos(BufferView const & bv, CursorSlice const & sl,
712 bool boundary, int & x, int & y) const;
714 bool tabularFeatures(Cursor & cur, std::string const & what);
716 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
717 std::string const & val = std::string());
719 void openLayoutDialog(BufferView *) const;
721 bool showInsetDialog(BufferView *) const;
723 size_t nargs() const { return tabular.cellCount(); }
725 boost::shared_ptr<InsetText const> cell(idx_type) const;
727 boost::shared_ptr<InsetText> cell(idx_type);
729 Text * getText(int) const;
731 /// set the change for the entire inset
732 void setChange(Change const & change);
733 /// accept the changes within the inset
734 void acceptChanges(BufferParams const & bparams);
735 /// reject the changes within the inset
736 void rejectChanges(BufferParams const & bparams);
738 // this should return true if we have a "normal" cell, otherwise false.
739 // "normal" means without width set!
740 /// should all paragraphs be output with "Standard" layout?
741 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
743 virtual bool forceEmptyLayout(idx_type cell = 0) const;
745 virtual bool useEmptyLayout() { return true; }
747 void addPreview(graphics::PreviewLoader &) const;
749 /// lock cell with given index
750 void edit(Cursor & cur, bool front, EntryDirection entry_from);
751 /// get table row from x coordinate
752 int rowFromY(Cursor & cur, int y) const;
753 /// get table column from y coordinate
754 int columnFromX(Cursor & cur, int x) const;
756 Inset * editXY(Cursor & cur, int x, int y);
757 /// can we go further down on mouse click?
758 bool descendable() const { return true; }
759 // Update the counters of this inset and of its contents
760 void updateLabels(ParIterator const &);
763 bool completionSupported(Cursor const &) const;
765 bool inlineCompletionSupported(Cursor const & cur) const;
767 bool automaticInlineCompletion() const;
769 bool automaticPopupCompletion() const;
771 bool showCompletionCursor() const;
773 CompletionList const * createCompletionList(Cursor const & cur) const;
775 docstring completionPrefix(Cursor const & cur) const;
777 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
779 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
782 // Public structures and variables
784 mutable Tabular tabular;
788 InsetTabular(InsetTabular const &);
790 void doDispatch(Cursor & cur, FuncRequest & cmd);
792 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
794 int scroll() const { return scx_; }
796 Inset * clone() const { return new InsetTabular(*this); }
799 void drawCellLines(frontend::Painter &, int x, int y, row_type row,
800 idx_type cell, bool erased) const;
802 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
805 void moveNextCell(Cursor & cur);
807 void movePrevCell(Cursor & cur);
809 int getCellXPos(idx_type cell) const;
811 void resetPos(Cursor & cur) const;
813 void removeTabularRow();
815 bool copySelection(Cursor & cur);
817 bool pasteClipboard(Cursor & cur);
819 void cutSelection(Cursor & cur);
821 bool isRightToLeft(Cursor & cur) const;
823 void getSelection(Cursor & cur, row_type & rs, row_type & re,
824 col_type & cs, col_type & ce) const;
826 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
827 /// are we operating on several cells?
828 bool tablemode(Cursor & cur) const;
830 /// return the "Manhattan distance" to nearest corner
831 int dist(BufferView &, idx_type cell, int x, int y) const;
832 /// return the cell nearest to x, y
833 idx_type getNearestCell(BufferView &, int x, int y) const;
835 /// test the rotation state of the give cell range.
836 bool oneCellHasRotationState(bool rotated,
837 row_type row_start, row_type row_end,
838 col_type col_start, col_type col_end) const;
840 mutable idx_type first_visible_cell;
846 class InsetTabularMailer : public MailInset {
849 InsetTabularMailer(InsetTabular const & inset);
851 virtual Inset & inset() const { return inset_; }
853 virtual std::string const & name() const { return name_; }
855 virtual std::string const inset2string(Buffer const &) const;
857 static void string2params(std::string const &, InsetTabular &);
859 static std::string const params2string(InsetTabular const &);
862 static std::string const name_;
864 InsetTabular & inset_;
867 std::string const featureAsString(Tabular::Feature feature);