Source/WebCore/rendering/RenderTable.h - WebKit - Git at Google

 /*
  * Copyright (C) 1997 Martin Jones (mjones@kde.org)
  *           (C) 1997 Torben Weis (weis@kde.org)
  *           (C) 1998 Waldo Bastian (bastian@kde.org)
  *           (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  * Copyright (C) 2003, 2004, 2005, 2006, 2009, 2010 Apple Inc. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, write to
  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */

 #ifndef RenderTable_h
 #define RenderTable_h

 #include "CSSPropertyNames.h"
 #include "CollapsedBorderValue.h"
 #include "RenderBlock.h"
 #include <wtf/Vector.h>

 namespace WebCore {

 class RenderTableCol;
 class RenderTableCaption;
 class RenderTableCell;
 class RenderTableSection;
 class TableLayout;

 enum SkipEmptySectionsValue { DoNotSkipEmptySections, SkipEmptySections };

 class RenderTable : public RenderBlock {
 public:
     explicit RenderTable(Node*);
     virtual ~RenderTable();

     int getColumnPos(unsigned col) const { return m_columnPos[col]; }

     int hBorderSpacing() const { return m_hSpacing; }
     int vBorderSpacing() const { return m_vSpacing; }

     bool collapseBorders() const { return style()->borderCollapse(); }

     int borderStart() const { return m_borderStart; }
     int borderEnd() const { return m_borderEnd; }
     int borderBefore() const;
     int borderAfter() const;

     int borderLeft() const
     {
         if (style()->isHorizontalWritingMode())
             return style()->isLeftToRightDirection() ? borderStart() : borderEnd();
         return style()->isFlippedBlocksWritingMode() ? borderAfter() : borderBefore();
     }

     int borderRight() const
     {
         if (style()->isHorizontalWritingMode())
             return style()->isLeftToRightDirection() ? borderEnd() : borderStart();
         return style()->isFlippedBlocksWritingMode() ? borderBefore() : borderAfter();
     }

     int borderTop() const
     {
         if (style()->isHorizontalWritingMode())
             return style()->isFlippedBlocksWritingMode() ? borderAfter() : borderBefore();
         return style()->isLeftToRightDirection() ? borderStart() : borderEnd();
     }

     int borderBottom() const
     {
         if (style()->isHorizontalWritingMode())
             return style()->isFlippedBlocksWritingMode() ? borderBefore() : borderAfter();
         return style()->isLeftToRightDirection() ? borderEnd() : borderStart();
     }

     Color bgColor() const { return style()->visitedDependentColor(CSSPropertyBackgroundColor); }

     int outerBorderBefore() const;
     int outerBorderAfter() const;
     int outerBorderStart() const;
     int outerBorderEnd() const;

     int outerBorderLeft() const
     {
         if (style()->isHorizontalWritingMode())
             return style()->isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
         return style()->isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
     }

     int outerBorderRight() const
     {
         if (style()->isHorizontalWritingMode())
             return style()->isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
         return style()->isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
     }

     int outerBorderTop() const
     {
         if (style()->isHorizontalWritingMode())
             return style()->isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
         return style()->isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
     }

     int outerBorderBottom() const
     {
         if (style()->isHorizontalWritingMode())
             return style()->isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
         return style()->isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
     }

     int calcBorderStart() const;
     int calcBorderEnd() const;
     void recalcBordersInRowDirection();

     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0);

     struct ColumnStruct {
         ColumnStruct()
             : span(1)
         {
         }

         unsigned span;
     };

     void forceSectionsRecalc()
     {
         setNeedsSectionRecalc();
         recalcSections();
     }

     Vector<ColumnStruct>& columns() { return m_columns; }
     Vector<int>& columnPositions() { return m_columnPos; }
     RenderTableSection* header() const { return m_head; }
     RenderTableSection* footer() const { return m_foot; }
     RenderTableSection* firstBody() const { return m_firstBody; }

     // This function returns 0 if the table has no section.
     RenderTableSection* topSection() const;
     RenderTableSection* bottomSection() const;

     // This function returns 0 if the table has no non-empty sections.
     RenderTableSection* topNonEmptySection() const;

     unsigned lastColumnIndex() const { return numEffCols() - 1; }

     void splitColumn(unsigned position, unsigned firstSpan);
     void appendColumn(unsigned span);
     unsigned numEffCols() const { return m_columns.size(); }
     unsigned spanOfEffCol(unsigned effCol) const { return m_columns[effCol].span; }

     unsigned colToEffCol(unsigned column) const
     {
         unsigned effColumn = 0;
         unsigned numColumns = numEffCols();
         for (unsigned c = 0; effColumn < numColumns && c + m_columns[effColumn].span - 1 < column; ++effColumn)
             c += m_columns[effColumn].span;
         return effColumn;
     }

     unsigned effColToCol(unsigned effCol) const
     {
         unsigned c = 0;
         for (unsigned i = 0; i < effCol; i++)
             c += m_columns[i].span;
         return c;
     }

     LayoutUnit bordersPaddingAndSpacingInRowDirection() const
     {
         return borderStart() + borderEnd() +
                (collapseBorders() ? ZERO_LAYOUT_UNIT : (paddingStart() + paddingEnd() + static_cast<LayoutUnit>(numEffCols() + 1) * hBorderSpacing()));
     }

     // Return the first column or column-group.
     RenderTableCol* firstColumn() const;

     RenderTableCol* colElement(unsigned col, bool* startEdge = 0, bool* endEdge = 0) const;

     bool needsSectionRecalc() const { return m_needsSectionRecalc; }
     void setNeedsSectionRecalc()
     {
         if (documentBeingDestroyed())
             return;
         m_needsSectionRecalc = true;
         setNeedsLayout(true);
     }

     RenderTableSection* sectionAbove(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;
     RenderTableSection* sectionBelow(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;

     RenderTableCell* cellAbove(const RenderTableCell*) const;
     RenderTableCell* cellBelow(const RenderTableCell*) const;
     RenderTableCell* cellBefore(const RenderTableCell*) const;
     RenderTableCell* cellAfter(const RenderTableCell*) const;

     typedef Vector<CollapsedBorderValue> CollapsedBorderValues;
     void invalidateCollapsedBorders()
     {
         m_collapsedBordersValid = false;
         m_collapsedBorders.clear();
     }
     const CollapsedBorderValue* currentBorderValue() const { return m_currentBorder; }

     bool hasSections() const { return m_head || m_foot || m_firstBody; }

     void recalcSectionsIfNeeded() const
     {
         if (m_needsSectionRecalc)
             recalcSections();
     }

     static RenderTable* createAnonymousWithParentRenderer(const RenderObject*);
     virtual RenderBox* createAnonymousBoxWithSameTypeAs(const RenderObject* parent) const OVERRIDE
     {
         return createAnonymousWithParentRenderer(parent);
     }

     const BorderValue& tableStartBorderAdjoiningCell(const RenderTableCell*) const;
     const BorderValue& tableEndBorderAdjoiningCell(const RenderTableCell*) const;

     void addCaption(const RenderTableCaption*);
     void removeCaption(const RenderTableCaption*);

 protected:
     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);

 private:
     virtual const char* renderName() const { return "RenderTable"; }

     virtual bool isTable() const { return true; }

     virtual bool avoidsFloats() const { return true; }

     virtual void paint(PaintInfo&, const LayoutPoint&);
     virtual void paintObject(PaintInfo&, const LayoutPoint&);
     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&);
     virtual void paintMask(PaintInfo&, const LayoutPoint&);
     virtual void layout();
     virtual void computePreferredLogicalWidths();
     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;

     virtual LayoutUnit baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const OVERRIDE;
     virtual LayoutUnit firstLineBoxBaseline() const OVERRIDE;
     virtual LayoutUnit lastLineBoxBaseline() const OVERRIDE;

     virtual RenderBlock* firstLineBlock() const;
     virtual void updateFirstLetter();

     virtual void setCellLogicalWidths();

     virtual void updateLogicalWidth() OVERRIDE;

     LayoutUnit convertStyleLogicalWidthToComputedWidth(const Length& styleLogicalWidth, LayoutUnit availableWidth);

     virtual LayoutRect overflowClipRect(const LayoutPoint& location, RenderRegion*, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize);

     virtual void addOverflowFromChildren();

     void subtractCaptionRect(LayoutRect&) const;

     void recalcCollapsedBorders();
     void recalcSections() const;
     void layoutCaption(RenderTableCaption*);

     void distributeExtraLogicalHeight(int extraLogicalHeight);

     mutable Vector<int> m_columnPos;
     mutable Vector<ColumnStruct> m_columns;
     mutable Vector<RenderTableCaption*> m_captions;

     mutable RenderTableSection* m_head;
     mutable RenderTableSection* m_foot;
     mutable RenderTableSection* m_firstBody;

     OwnPtr<TableLayout> m_tableLayout;

     CollapsedBorderValues m_collapsedBorders;
     const CollapsedBorderValue* m_currentBorder;
     bool m_collapsedBordersValid : 1;

     mutable bool m_hasColElements : 1;
     mutable bool m_needsSectionRecalc : 1;

     short m_hSpacing;
     short m_vSpacing;
     int m_borderStart;
     int m_borderEnd;
 };

 inline RenderTableSection* RenderTable::topSection() const
 {
     ASSERT(!needsSectionRecalc());
     if (m_head)
         return m_head;
     if (m_firstBody)
         return m_firstBody;
     return m_foot;
 }

 inline RenderTable* toRenderTable(RenderObject* object)
 {
     ASSERT(!object || object->isTable());
     return static_cast<RenderTable*>(object);
 }

 inline const RenderTable* toRenderTable(const RenderObject* object)
 {
     ASSERT(!object || object->isTable());
     return static_cast<const RenderTable*>(object);
 }

 // This will catch anyone doing an unnecessary cast.
 void toRenderTable(const RenderTable*);

 } // namespace WebCore

 #endif // RenderTable_h
	/*
	* Copyright (C) 1997 Martin Jones (mjones@kde.org)
	* (C) 1997 Torben Weis (weis@kde.org)
	* (C) 1998 Waldo Bastian (bastian@kde.org)
	* (C) 1999 Lars Knoll (knoll@kde.org)
	* (C) 1999 Antti Koivisto (koivisto@kde.org)
	* Copyright (C) 2003, 2004, 2005, 2006, 2009, 2010 Apple Inc. All rights reserved.
	*
	* This library is free software; you can redistribute it and/or
	* modify it under the terms of the GNU Library General Public
	* License as published by the Free Software Foundation; either
	* version 2 of the License, or (at your option) any later version.
	*
	* This library is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	* Library General Public License for more details.
	*
	* You should have received a copy of the GNU Library General Public License
	* along with this library; see the file COPYING.LIB. If not, write to
	* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
	* Boston, MA 02110-1301, USA.
	*/

	#ifndef RenderTable_h
	#define RenderTable_h

	#include "CSSPropertyNames.h"
	#include "CollapsedBorderValue.h"
	#include "RenderBlock.h"
	#include <wtf/Vector.h>

	namespace WebCore {

	class RenderTableCol;
	class RenderTableCaption;
	class RenderTableCell;
	class RenderTableSection;
	class TableLayout;

	enum SkipEmptySectionsValue { DoNotSkipEmptySections, SkipEmptySections };

	class RenderTable : public RenderBlock {
	public:
	explicit RenderTable(Node*);
	virtual ~RenderTable();

	int getColumnPos(unsigned col) const { return m_columnPos[col]; }

	int hBorderSpacing() const { return m_hSpacing; }
	int vBorderSpacing() const { return m_vSpacing; }

	bool collapseBorders() const { return style()->borderCollapse(); }

	int borderStart() const { return m_borderStart; }
	int borderEnd() const { return m_borderEnd; }
	int borderBefore() const;
	int borderAfter() const;

	int borderLeft() const
	{
	if (style()->isHorizontalWritingMode())
	return style()->isLeftToRightDirection() ? borderStart() : borderEnd();
	return style()->isFlippedBlocksWritingMode() ? borderAfter() : borderBefore();
	}

	int borderRight() const
	{
	if (style()->isHorizontalWritingMode())
	return style()->isLeftToRightDirection() ? borderEnd() : borderStart();
	return style()->isFlippedBlocksWritingMode() ? borderBefore() : borderAfter();
	}

	int borderTop() const
	{
	if (style()->isHorizontalWritingMode())
	return style()->isFlippedBlocksWritingMode() ? borderAfter() : borderBefore();
	return style()->isLeftToRightDirection() ? borderStart() : borderEnd();
	}

	int borderBottom() const
	{
	if (style()->isHorizontalWritingMode())
	return style()->isFlippedBlocksWritingMode() ? borderBefore() : borderAfter();
	return style()->isLeftToRightDirection() ? borderEnd() : borderStart();
	}

	Color bgColor() const { return style()->visitedDependentColor(CSSPropertyBackgroundColor); }

	int outerBorderBefore() const;
	int outerBorderAfter() const;
	int outerBorderStart() const;
	int outerBorderEnd() const;

	int outerBorderLeft() const
	{
	if (style()->isHorizontalWritingMode())
	return style()->isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
	return style()->isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
	}

	int outerBorderRight() const
	{
	if (style()->isHorizontalWritingMode())
	return style()->isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
	return style()->isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
	}

	int outerBorderTop() const
	{
	if (style()->isHorizontalWritingMode())
	return style()->isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
	return style()->isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
	}

	int outerBorderBottom() const
	{
	if (style()->isHorizontalWritingMode())
	return style()->isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
	return style()->isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
	}

	int calcBorderStart() const;
	int calcBorderEnd() const;
	void recalcBordersInRowDirection();

	virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0);

	struct ColumnStruct {
	ColumnStruct()
	: span(1)
	{
	}

	unsigned span;
	};

	void forceSectionsRecalc()
	{
	setNeedsSectionRecalc();
	recalcSections();
	}

	Vector<ColumnStruct>& columns() { return m_columns; }
	Vector<int>& columnPositions() { return m_columnPos; }
	RenderTableSection* header() const { return m_head; }
	RenderTableSection* footer() const { return m_foot; }
	RenderTableSection* firstBody() const { return m_firstBody; }

	// This function returns 0 if the table has no section.
	RenderTableSection* topSection() const;
	RenderTableSection* bottomSection() const;

	// This function returns 0 if the table has no non-empty sections.
	RenderTableSection* topNonEmptySection() const;

	unsigned lastColumnIndex() const { return numEffCols() - 1; }

	void splitColumn(unsigned position, unsigned firstSpan);
	void appendColumn(unsigned span);
	unsigned numEffCols() const { return m_columns.size(); }
	unsigned spanOfEffCol(unsigned effCol) const { return m_columns[effCol].span; }

	unsigned colToEffCol(unsigned column) const
	{
	unsigned effColumn = 0;
	unsigned numColumns = numEffCols();
	for (unsigned c = 0; effColumn < numColumns && c + m_columns[effColumn].span - 1 < column; ++effColumn)
	c += m_columns[effColumn].span;
	return effColumn;
	}

	unsigned effColToCol(unsigned effCol) const
	{
	unsigned c = 0;
	for (unsigned i = 0; i < effCol; i++)
	c += m_columns[i].span;
	return c;
	}

	LayoutUnit bordersPaddingAndSpacingInRowDirection() const
	{
	return borderStart() + borderEnd() +
	(collapseBorders() ? ZERO_LAYOUT_UNIT : (paddingStart() + paddingEnd() + static_cast<LayoutUnit>(numEffCols() + 1) * hBorderSpacing()));
	}

	// Return the first column or column-group.
	RenderTableCol* firstColumn() const;

	RenderTableCol* colElement(unsigned col, bool* startEdge = 0, bool* endEdge = 0) const;

	bool needsSectionRecalc() const { return m_needsSectionRecalc; }
	void setNeedsSectionRecalc()
	{
	if (documentBeingDestroyed())
	return;
	m_needsSectionRecalc = true;
	setNeedsLayout(true);
	}

	RenderTableSection* sectionAbove(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;
	RenderTableSection* sectionBelow(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;

	RenderTableCell* cellAbove(const RenderTableCell*) const;
	RenderTableCell* cellBelow(const RenderTableCell*) const;
	RenderTableCell* cellBefore(const RenderTableCell*) const;
	RenderTableCell* cellAfter(const RenderTableCell*) const;

	typedef Vector<CollapsedBorderValue> CollapsedBorderValues;
	void invalidateCollapsedBorders()
	{
	m_collapsedBordersValid = false;
	m_collapsedBorders.clear();
	}
	const CollapsedBorderValue* currentBorderValue() const { return m_currentBorder; }

	bool hasSections() const { return m_head \|\| m_foot \|\| m_firstBody; }

	void recalcSectionsIfNeeded() const
	{
	if (m_needsSectionRecalc)
	recalcSections();
	}

	static RenderTable* createAnonymousWithParentRenderer(const RenderObject*);
	virtual RenderBox* createAnonymousBoxWithSameTypeAs(const RenderObject* parent) const OVERRIDE
	{
	return createAnonymousWithParentRenderer(parent);
	}

	const BorderValue& tableStartBorderAdjoiningCell(const RenderTableCell*) const;
	const BorderValue& tableEndBorderAdjoiningCell(const RenderTableCell*) const;

	void addCaption(const RenderTableCaption*);
	void removeCaption(const RenderTableCaption*);

	protected:
	virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);

	private:
	virtual const char* renderName() const { return "RenderTable"; }

	virtual bool isTable() const { return true; }

	virtual bool avoidsFloats() const { return true; }

	virtual void paint(PaintInfo&, const LayoutPoint&);
	virtual void paintObject(PaintInfo&, const LayoutPoint&);
	virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&);
	virtual void paintMask(PaintInfo&, const LayoutPoint&);
	virtual void layout();
	virtual void computePreferredLogicalWidths();
	virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;

	virtual LayoutUnit baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const OVERRIDE;
	virtual LayoutUnit firstLineBoxBaseline() const OVERRIDE;
	virtual LayoutUnit lastLineBoxBaseline() const OVERRIDE;

	virtual RenderBlock* firstLineBlock() const;
	virtual void updateFirstLetter();

	virtual void setCellLogicalWidths();

	virtual void updateLogicalWidth() OVERRIDE;

	LayoutUnit convertStyleLogicalWidthToComputedWidth(const Length& styleLogicalWidth, LayoutUnit availableWidth);

	virtual LayoutRect overflowClipRect(const LayoutPoint& location, RenderRegion*, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize);

	virtual void addOverflowFromChildren();

	void subtractCaptionRect(LayoutRect&) const;

	void recalcCollapsedBorders();
	void recalcSections() const;
	void layoutCaption(RenderTableCaption*);

	void distributeExtraLogicalHeight(int extraLogicalHeight);

	mutable Vector<int> m_columnPos;
	mutable Vector<ColumnStruct> m_columns;
	mutable Vector<RenderTableCaption*> m_captions;

	mutable RenderTableSection* m_head;
	mutable RenderTableSection* m_foot;
	mutable RenderTableSection* m_firstBody;

	OwnPtr<TableLayout> m_tableLayout;

	CollapsedBorderValues m_collapsedBorders;
	const CollapsedBorderValue* m_currentBorder;
	bool m_collapsedBordersValid : 1;

	mutable bool m_hasColElements : 1;
	mutable bool m_needsSectionRecalc : 1;

	short m_hSpacing;
	short m_vSpacing;
	int m_borderStart;
	int m_borderEnd;
	};

	inline RenderTableSection* RenderTable::topSection() const
	{
	ASSERT(!needsSectionRecalc());
	if (m_head)
	return m_head;
	if (m_firstBody)
	return m_firstBody;
	return m_foot;
	}

	inline RenderTable* toRenderTable(RenderObject* object)
	{
	ASSERT(!object \|\| object->isTable());
	return static_cast<RenderTable*>(object);
	}

	inline const RenderTable* toRenderTable(const RenderObject* object)
	{
	ASSERT(!object \|\| object->isTable());
	return static_cast<const RenderTable*>(object);
	}

	// This will catch anyone doing an unnecessary cast.
	void toRenderTable(const RenderTable*);

	} // namespace WebCore

	#endif // RenderTable_h