#include "misc/khtmllayout.h"
#include "misc/loader_client.h"
#include "misc/helper.h"
#include "rendering/render_style.h"
#include "khtml_events.h"
class QPainter;
class QTextStream;
class CSSStyle;
class KHTMLView;
class RenderArena;
#ifndef NDEBUG
#define KHTMLAssert( x ) if( !(x) ) { \
const RenderObject *o = this; while( o->parent() ) o = o->parent(); \
o->printTree(); \
qDebug(" this object = %p", this ); \
assert( false ); \
}
#else
#define KHTMLAssert( x )
#endif
/*
* The painting of a layer occurs in three distinct phases. Each phase involves
* a recursive descent into the layer's render objects. The first phase is the background phase.
* The backgrounds and borders of all blocks are painted. Inlines are not painted at all.
* Floats must paint above block backgrounds but entirely below inline content that can overlap them.
* In the foreground phase, all inlines are fully painted. Inline replaced elements will get all
* three phases invoked on them during this phase.
*/
typedef enum {
PaintActionElementBackground = 0,
PaintActionChildBackground,
PaintActionChildBackgrounds,
PaintActionFloat,
PaintActionForeground,
PaintActionSelection
} PaintAction;
namespace DOM {
class HTMLAreaElementImpl;
class DOMString;
class NodeImpl;
class ElementImpl;
class EventImpl;
};
namespace khtml {
class RenderFlow;
class RenderBlock;
class RenderStyle;
class RenderTable;
class CachedObject;
class RenderCanvas;
class RenderText;
class RenderFrameSet;
class RenderLayer;
class InlineBox;
class InlineFlowBox;
/**
* Base Class for all rendering tree objects.
*/
class RenderObject : public CachedObjectClient
{
public:
RenderObject(DOM::NodeImpl* node);
virtual ~RenderObject();
RenderObject *parent() const { return m_parent; }
RenderObject *previousSibling() const { return m_previous; }
RenderObject *nextSibling() const { return m_next; }
virtual RenderObject *firstChild() const { return 0; }
virtual RenderObject *lastChild() const { return 0; }
virtual RenderLayer* layer() const { return 0; }
RenderLayer* enclosingLayer();
void addLayers(RenderLayer* parentLayer, RenderObject* newObject);
void removeLayers(RenderLayer* parentLayer);
void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint,
bool checkParent=true);
virtual void positionChildLayers() { }
virtual bool requiresLayer();
virtual QRect getOverflowClipRect(int tx, int ty) { return QRect(0,0,0,0); }
virtual QRect getClipRect(int tx, int ty) { return QRect(0,0,0,0); }
bool hasClip() { return isPositioned() && style()->hasClip(); }
bool hasOverflowClip() { return style()->hidesOverflow(); }
virtual int getBaselineOfFirstLineBox() { return -1; } // Tables and blocks implement this.
virtual InlineFlowBox* getFirstLineBox() { return 0; } // Tables and blocks implement this.
// Called when an object that was floating or positioned becomes a normal flow object
// again. We have to make sure the render tree updates as needed to accommodate the new
// normal flow object.
void handleDynamicFloatPositionChange();
// This function is a convenience helper for creating an anonymous block that inherits its
// style from this RenderObject.
RenderBlock* createAnonymousBlock();
// Whether or not a positioned element requires normal flow x/y to be computed
// to determine its position.
bool hasStaticX() const;
bool hasStaticY() const;
virtual void setStaticX(short staticX) {};
virtual void setStaticY(int staticY) {};
// RenderObject tree manipulation
//////////////////////////////////////////
virtual bool canHaveChildren() const;
virtual void addChild(RenderObject *newChild, RenderObject *beforeChild = 0);
virtual void removeChild(RenderObject *oldChild);
// raw tree manipulation
virtual RenderObject* removeChildNode(RenderObject* child);
virtual void appendChildNode(RenderObject* child);
virtual void insertChildNode(RenderObject* child, RenderObject* before);
//////////////////////////////////////////
private:
//////////////////////////////////////////
// Helper functions. Dangerous to use!
void setPreviousSibling(RenderObject *previous) { m_previous = previous; }
void setNextSibling(RenderObject *next) { m_next = next; }
void setParent(RenderObject *parent) { m_parent = parent; }
//////////////////////////////////////////
public:
virtual const char *renderName() const { return "RenderObject"; }
#ifndef NDEBUG
QString information() const;
virtual void printTree(int indent=0) const;
virtual void dump(QTextStream *stream, QString ind = "") const;
#endif
static RenderObject *createObject(DOM::NodeImpl* node, RenderStyle* style);
// Overloaded new operator. Derived classes must override operator new
// in order to allocate out of the RenderArena.
void* operator new(size_t sz, RenderArena* renderArena) throw();
// Overridden to prevent the normal delete from being called.
void operator delete(void* ptr, size_t sz);
private:
// The normal operator new is disallowed on all render objects.
void* operator new(size_t sz) throw();
public:
RenderArena* renderArena() const;
// some helper functions...
virtual bool isRenderBlock() const { return false; }
virtual bool isRenderInline() const { return false; }
virtual bool isInlineFlow() const { return false; }
virtual bool isBlockFlow() const { return false; }
virtual bool isInlineBlockOrInlineTable() const { return false; }
virtual bool childrenInline() const { return false; }
virtual void setChildrenInline(bool b) { };
virtual RenderFlow* continuation() const;
virtual bool isInlineContinuation() const;
virtual bool isListItem() const { return false; }
virtual bool isListMarker() const { return false; }
virtual bool isCanvas() const { return false; }
bool isRoot() const;
bool isBody() const;
virtual bool isBR() const { return false; }
virtual bool isTableCell() const { return false; }
virtual bool isTableRow() const { return false; }
virtual bool isTableSection() const { return false; }
virtual bool isTableCol() const { return false; }
virtual bool isTable() const { return false; }
virtual bool isWidget() const { return false; }
virtual bool isFormElement() const { return false; }
virtual bool isImage() const { return false; }
virtual bool isTextArea() const { return false; }
virtual bool isFrameSet() const { return false; }
virtual bool isApplet() const { return false; }
bool isAnonymousBox() const { return m_isAnonymous; }
void setIsAnonymousBox(bool b) { m_isAnonymous = b; }
bool isFloating() const { return m_floating; }
bool isPositioned() const { return m_positioned; } // absolute or fixed positioning
bool isRelPositioned() const { return m_relPositioned; } // relative positioning
bool isText() const { return m_isText; }
bool isInline() const { return m_inline; } // inline object
bool isCompact() const { return style()->display() == COMPACT; } // compact object
bool isRunIn() const { return style()->display() == RUN_IN; } // run-in object
bool mouseInside() const;
bool isReplaced() const { return m_replaced; } // a "replaced" element (see CSS)
bool shouldPaintBackgroundOrBorder() const { return m_paintBackground; }
bool needsLayout() const { return m_needsLayout; }
bool minMaxKnown() const{ return m_minMaxKnown; }
bool overhangingContents() const { return m_overhangingContents; }
bool hasFirstLine() const { return m_hasFirstLine; }
bool isSelectionBorder() const { return m_isSelectionBorder; }
bool recalcMinMax() const { return m_recalcMinMax; }
RenderCanvas* canvas() const;
// don't even think about making this method virtual!
DOM::NodeImpl* element() const { return m_node; }
/**
* returns the object containing this one. can be different from parent for
* positioned elements
*/
RenderObject *container() const;
void setOverhangingContents(bool p=true);
virtual void markAllDescendantsWithFloatsForLayout(RenderObject* floatToRemove = 0);
void setNeedsLayout(bool b);
void setMinMaxKnown(bool b=true) {
m_minMaxKnown = b;
if ( !b ) {
RenderObject *o = this;
RenderObject *root = this;
while( o ) { // ### && !o->m_recalcMinMax ) {
o->m_recalcMinMax = true;
root = o;
o = o->m_parent;
}
}
}
void setNeedsLayoutAndMinMaxRecalc() {
setMinMaxKnown(false);
setNeedsLayout(true);
}
void setPositioned(bool b=true) { m_positioned = b; }
void setRelPositioned(bool b=true) { m_relPositioned = b; }
void setFloating(bool b=true) { m_floating = b; }
void setInline(bool b=true) { m_inline = b; }
void setMouseInside(bool b=true) { m_mouseInside = b; }
void setShouldPaintBackgroundOrBorder(bool b=true) { m_paintBackground = b; }
void setRenderText() { m_isText = true; }
void setReplaced(bool b=true) { m_replaced = b; }
void setIsSelectionBorder(bool b=true) { m_isSelectionBorder = b; }
void scheduleRelayout(RenderObject* clippedObj = 0);
virtual InlineBox* createInlineBox(bool makePlaceHolderBox, bool isRootLineBox);
// for discussion of lineHeight see CSS2 spec
virtual short lineHeight( bool firstLine, bool isRootLineBox=false ) const;
// for the vertical-align property of inline elements
// the difference between this objects baseline position and the lines baseline position.
virtual short verticalPositionHint( bool firstLine ) const;
// the offset of baseline from the top of the object.
virtual short baselinePosition( bool firstLine, bool isRootLineBox=false ) const;
/*
* Paint the object and its children, clipped by (x|y|w|h).
* (tx|ty) is the calculated position of the parent
*/
virtual void paint(QPainter *p, int x, int y, int w, int h, int tx, int ty,
PaintAction paintAction);
virtual void paintObject( QPainter */*p*/, int /*x*/, int /*y*/,
int /*w*/, int /*h*/, int /*tx*/, int /*ty*/,
PaintAction paintAction /*paintAction*/) {}
void paintBorder(QPainter *p, int _tx, int _ty, int w, int h, const RenderStyle* style, bool begin=true, bool end=true);
void paintOutline(QPainter *p, int _tx, int _ty, int w, int h, const RenderStyle* style);
// RenderBox implements this.
virtual void paintBoxDecorations(QPainter *p,int _x, int _y,
int _w, int _h, int _tx, int _ty) {};
virtual void paintBackgroundExtended(QPainter *p, const QColor &c, CachedImage *bg, int clipy, int cliph,
int _tx, int _ty, int w, int height,
int bleft, int bright) {};
/*
* This function calculates the minimum & maximum width that the object
* can be set to.
*
* when the Element calls setMinMaxKnown(true), calcMinMaxWidth() will
* be no longer called.
*
* when a element has a fixed size, m_minWidth and m_maxWidth should be
* set to the same value. This has the special meaning that m_width,
* contains the actual value.
*
* assumes calcMinMaxWidth has already been called for all children.
*/
virtual void calcMinMaxWidth() { }
/*
* Does the min max width recalculations after changes.
*/
void recalcMinMaxWidths();
/*
* Calculates the actual width of the object (only for non inline
* objects)
*/
virtual void calcWidth() {}
/*
* This function should cause the Element to calculate its
* width and height and the layout of its content
*
* when the Element calls setNeedsLayout(false), layout() is no
* longer called during relayouts, as long as there is no
* style sheet change. When that occurs, m_needsLayout will be
* set to true and the Element receives layout() calls
* again.
*/
virtual void layout() = 0;
/* This function performs a layout only if one is needed. */
void layoutIfNeeded() { if (needsLayout()) layout(); }
// used for element state updates that can not be fixed with a
// repaint and do not need a relayout
virtual void updateFromElement() {};
// The corresponding closing element has been parsed. ### remove me
virtual void close() { }
virtual int availableHeight() const { return 0; }
// Whether or not the element shrinks to its max width (rather than filling the width
// of a containing block). HTML4 buttons, legends, and floating/compact elements do this.
bool sizesToMaxWidth() const;
// does a query on the rendertree and finds the innernode
// and overURL for the given position
// if readonly == false, it will recalc hover styles accordingly
class NodeInfo
{
friend class RenderLayer;
friend class RenderImage;
friend class RenderText;
friend class RenderInline;
friend class RenderObject;
friend class RenderFrameSet;
friend class DOM::HTMLAreaElementImpl;
public:
NodeInfo(bool readonly, bool active)
: m_innerNode(0), m_innerNonSharedNode(0), m_innerURLElement(0), m_readonly(readonly), m_active(active)
{ }
DOM::NodeImpl* innerNode() const { return m_innerNode; }
DOM::NodeImpl* innerNonSharedNode() const { return m_innerNonSharedNode; }
DOM::NodeImpl* URLElement() const { return m_innerURLElement; }
bool readonly() const { return m_readonly; }
bool active() const { return m_active; }
private:
void setInnerNode(DOM::NodeImpl* n) { m_innerNode = n; }
void setInnerNonSharedNode(DOM::NodeImpl* n) { m_innerNonSharedNode = n; }
void setURLElement(DOM::NodeImpl* n) { m_innerURLElement = n; }
DOM::NodeImpl* m_innerNode;
DOM::NodeImpl* m_innerNonSharedNode;
DOM::NodeImpl* m_innerURLElement;
bool m_readonly;
bool m_active;
};
FindSelectionResult checkSelectionPoint(int x, int y, int tx, int ty, DOM::NodeImpl*&, int& offset);
virtual FindSelectionResult checkSelectionPointIgnoringContinuations(int x, int y, int tx, int ty, DOM::NodeImpl*&, int& offset);
virtual bool nodeAtPoint(NodeInfo& info, int x, int y, int tx, int ty, bool inside=false);
void setHoverAndActive(NodeInfo& info, bool oldinside, bool inside);
// set the style of the object.
virtual void setStyle(RenderStyle *style);
// returns the containing block level element for this element.
RenderBlock *containingBlock() const;
// return just the width of the containing block
virtual short containingBlockWidth() const;
// return just the height of the containing block
virtual int containingBlockHeight() const;
// size of the content area (box size minus padding/border)
virtual short contentWidth() const { return 0; }
virtual int contentHeight() const { return 0; }
// intrinsic extend of replaced elements. undefined otherwise
virtual short intrinsicWidth() const { return 0; }
virtual int intrinsicHeight() const { return 0; }
// relative to parent node
virtual void setPos( int /*xPos*/, int /*yPos*/ ) { }
virtual void setWidth( int /*width*/ ) { }
virtual void setHeight( int /*height*/ ) { }
virtual int xPos() const { return 0; }
virtual int yPos() const { return 0; }
// calculate client position of box
virtual bool absolutePosition(int &/*xPos*/, int &/*yPos*/, bool fixed = false);
// width and height are without margins but include paddings and borders
virtual short width() const { return 0; }
virtual int height() const { return 0; }
// The height of a block when you include normal flow overflow spillage out of the bottom
// of the block (e.g., a that has a 100px tall image inside
// it would have an overflow height of borderTop() + paddingTop() + 100px.
virtual int overflowHeight(bool includeInterior=true) const { return height(); }
virtual int overflowWidth(bool includeInterior=true) const { return width(); }
virtual void setOverflowHeight(int) {}
virtual void setOverflowWidth(int) {}
// IE extensions. Used to calculate offsetWidth/Height. Overridden by inlines (render_flow)
// to return the remaining width on a given line (and the height of a single line). -dwh
virtual short offsetWidth() const { return width(); }
virtual int offsetHeight() const { return height(); }
// IE exxtensions. Also supported by Gecko. We override in render flow to get the
// left and top correct. -dwh
virtual int offsetLeft() const;
virtual int offsetTop() const;
virtual RenderObject* offsetParent() const;
// More IE extensions. clientWidth and clientHeight represent the interior of an object
// excluding border and scrollbar.
short clientWidth() const;
short clientHeight() const;
// scrollWidth/scrollHeight will be the same as clientWidth/clientHeight unless the
// object has overflow:hidden/scroll/auto specified and also has overflow.
short scrollWidth() const;
short scrollHeight() const;
// The following seven functions are used to implement collapsing margins.
// All objects know their maximal positive and negative margins. The
// formula for computing a collapsed margin is |maxPosMargin|-|maxNegmargin|.
// For a non-collapsing, e.g., a leaf element, this formula will simply return
// the margin of the element. Blocks override the maxTopMargin and maxBottomMargin
// methods.
virtual bool isSelfCollapsingBlock() const { return false; }
virtual short collapsedMarginTop() const
{ return maxTopMargin(true)-maxTopMargin(false); }
virtual short collapsedMarginBottom() const
{ return maxBottomMargin(true)-maxBottomMargin(false); }
virtual bool isTopMarginQuirk() const { return false; }
virtual bool isBottomMarginQuirk() const { return false; }
virtual short maxTopMargin(bool positive) const {
if (positive)
if (marginTop() > 0)
return marginTop();
else
return 0;
else
if (marginTop() < 0)
return 0 - marginTop();
else
return 0;
}
virtual short maxBottomMargin(bool positive) const {
if (positive)
if (marginBottom() > 0)
return marginBottom();
else
return 0;
else
if (marginBottom() < 0)
return 0 - marginBottom();
else
return 0;
}
virtual short marginTop() const { return 0; }
virtual short marginBottom() const { return 0; }
virtual short marginLeft() const { return 0; }
virtual short marginRight() const { return 0; }
// Virtual since table cells override
virtual int paddingTop() const;
virtual int paddingBottom() const;
virtual int paddingLeft() const;
virtual int paddingRight() const;
virtual int borderTop() const { return style()->borderTopWidth(); }
virtual int borderBottom() const { return style()->borderBottomWidth(); }
virtual int borderLeft() const { return style()->borderLeftWidth(); }
virtual int borderRight() const { return style()->borderRightWidth(); }
virtual short minWidth() const { return 0; }
virtual short maxWidth() const { return 0; }
RenderStyle* style() const { return m_style; }
RenderStyle* style( bool firstLine ) const {
RenderStyle *s = m_style;
if( firstLine && hasFirstLine() ) {
RenderStyle *pseudoStyle = style()->getPseudoStyle(RenderStyle::FIRST_LINE);
if ( pseudoStyle )
s = pseudoStyle;
}
return s;
}
void getTextDecorationColors(int decorations, QColor& underline, QColor& overline,
QColor& linethrough, bool quirksMode=false);
enum BorderSide {
BSTop, BSBottom, BSLeft, BSRight
};
void drawBorder(QPainter *p, int x1, int y1, int x2, int y2, BorderSide s,
QColor c, const QColor& textcolor, EBorderStyle style,
int adjbw1, int adjbw2, bool invalidisInvert = false);
virtual void setTable(RenderTable*) {};
// force a complete repaint
virtual void repaint(bool immediate = false) { if(m_parent) m_parent->repaint(immediate); }
virtual void repaintRectangle(int x, int y, int w, int h, bool immediate = false, bool f=false);
virtual unsigned int length() const { return 1; }
virtual bool isHidden() const { return isFloating() || isPositioned(); }
bool isFloatingOrPositioned() const { return (isFloating() || isPositioned()); };
virtual bool containsFloats() { return false; }
virtual bool containsFloat(RenderObject* o) { return false; }
virtual bool hasOverhangingFloats() { return false; }
// positioning of inline childs (bidi)
virtual void position(InlineBox*, int, int, bool) {}
enum SelectionState {
SelectionNone,
SelectionStart,
SelectionInside,
SelectionEnd,
SelectionBoth
};
virtual SelectionState selectionState() const { return SelectionNone;}
virtual void setSelectionState(SelectionState) {}
virtual void cursorPos(int /*offset*/, int &/*_x*/, int &/*_y*/, int &/*height*/);
virtual int lowestPosition(bool includeOverflowInterior=true) const {return 0;}
virtual int rightmostPosition(bool includeOverflowInterior=true) const {return 0;}
// recursively invalidate current layout
// unused: void invalidateLayout();
virtual void calcVerticalMargins() {}
void removeFromObjectLists();
virtual void detach(RenderArena* renderArena);
const QFont &font(bool firstLine) const {
return style( firstLine )->font();
}
const QFontMetrics &fontMetrics(bool firstLine) const {
return style( firstLine )->fontMetrics();
}
// Virtual function helpers for CSS3 Flexible Box Layout
virtual bool isFlexibleBox() const { return false; }
virtual bool isFlexingChildren() const { return false; }
virtual bool isStretchingChildren() const { return false; }
// Convenience, to avoid repeating the code to dig down to get this.
QChar backslashAsCurrencySymbol() const;
protected:
virtual void selectionStartEnd(int& spos, int& epos);
virtual void printBoxDecorations(QPainter* /*p*/, int /*_x*/, int /*_y*/,
int /*_w*/, int /*_h*/, int /*_tx*/, int /*_ty*/) {}
virtual QRect viewRect() const;
void remove() {
removeFromObjectLists();
if ( parent() )
//have parent, take care of the tree integrity
parent()->removeChild(this);
}
void invalidateVerticalPositions();
short getVerticalPosition( bool firstLine ) const;
virtual void removeLeftoverAnonymousBoxes();
void arenaDelete(RenderArena *arena);
private:
RenderStyle* m_style;
protected:
DOM::NodeImpl* m_node;
private:
RenderObject *m_parent;
RenderObject *m_previous;
RenderObject *m_next;
short m_verticalPosition;
bool m_needsLayout : 1;
bool m_unused : 1;
bool m_minMaxKnown : 1;
bool m_floating : 1;
bool m_positioned : 1;
bool m_overhangingContents : 1;
bool m_relPositioned : 1;
bool m_paintBackground : 1; // if the box has something to paint in the
// background painting phase (background, border, etc)
bool m_isAnonymous : 1;
bool m_recalcMinMax : 1;
bool m_isText : 1;
bool m_inline : 1;
bool m_replaced : 1;
bool m_mouseInside : 1;
bool m_hasFirstLine : 1;
bool m_isSelectionBorder : 1;
void arenaDelete(RenderArena *arena, void *objectBase);
// note: do not add unnecessary bitflags, we have 32 bit already!
friend class RenderListItem;
friend class RenderContainer;
friend class RenderCanvas;
};
enum VerticalPositionHint {
PositionTop = -0x4000,
PositionBottom = 0x4000,
PositionUndefined = 0x3fff
};
}; //namespace
#endif