2008-08-08 Maxime Britto <britto@apple.com>
[WebKit-https.git] / WebCore / rendering / RenderObject.h
1 /*
2  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
3  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
5  *           (C) 2004 Allan Sandfeld Jensen (kde@carewolf.com)
6  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef RenderObject_h
26 #define RenderObject_h
27
28 #include "CachedResourceClient.h"
29 #include "Document.h"
30 #include "RenderStyle.h"
31 #include "ScrollTypes.h"
32 #include "VisiblePosition.h"
33 #include <wtf/HashMap.h>
34
35 namespace WebCore {
36
37 class AffineTransform;
38 class AnimationController;
39 class Color;
40 class Document;
41 class Element;
42 class Event;
43 class FloatRect;
44 class FrameView;
45 class HTMLAreaElement;
46 class HitTestResult;
47 class InlineBox;
48 class InlineFlowBox;
49 class PlatformScrollbar;
50 class Position;
51 class RenderArena;
52 class RenderBlock;
53 class RenderFlow;
54 class RenderFrameSet;
55 class RenderLayer;
56 class RenderTable;
57 class RenderText;
58 class RenderView;
59 class String;
60
61 struct HitTestRequest;
62
63 /*
64  *  The painting of a layer occurs in three distinct phases.  Each phase involves
65  *  a recursive descent into the layer's render objects. The first phase is the background phase.
66  *  The backgrounds and borders of all blocks are painted.  Inlines are not painted at all.
67  *  Floats must paint above block backgrounds but entirely below inline content that can overlap them.
68  *  In the foreground phase, all inlines are fully painted.  Inline replaced elements will get all
69  *  three phases invoked on them during this phase.
70  */
71
72 enum PaintPhase {
73     PaintPhaseBlockBackground,
74     PaintPhaseChildBlockBackground,
75     PaintPhaseChildBlockBackgrounds,
76     PaintPhaseFloat,
77     PaintPhaseForeground,
78     PaintPhaseOutline,
79     PaintPhaseChildOutlines,
80     PaintPhaseSelfOutline,
81     PaintPhaseSelection,
82     PaintPhaseCollapsedTableBorders,
83     PaintPhaseTextClip,
84     PaintPhaseMask
85 };
86
87 enum PaintRestriction {
88     PaintRestrictionNone,
89     PaintRestrictionSelectionOnly,
90     PaintRestrictionSelectionOnlyBlackText
91 };
92
93 enum HitTestFilter {
94     HitTestAll,
95     HitTestSelf,
96     HitTestDescendants
97 };
98
99 enum HitTestAction {
100     HitTestBlockBackground,
101     HitTestChildBlockBackground,
102     HitTestChildBlockBackgrounds,
103     HitTestFloat,
104     HitTestForeground
105 };
106
107 enum VerticalPositionHint {
108     PositionTop = -0x7fffffff,
109     PositionBottom = 0x7fffffff,
110     PositionUndefined = static_cast<int>(0x80000000)
111 };
112
113 #if ENABLE(DASHBOARD_SUPPORT)
114 struct DashboardRegionValue {
115     bool operator==(const DashboardRegionValue& o) const
116     {
117         return type == o.type && bounds == o.bounds && clip == o.clip && label == o.label;
118     }
119     bool operator!=(const DashboardRegionValue& o) const
120     {
121         return !(*this == o);
122     }
123
124     String label;
125     IntRect bounds;
126     IntRect clip;
127     int type;
128 };
129 #endif
130
131 // FIXME: This should be a HashSequencedSet, but we don't have that data structure yet.
132 // This means the paint order of outlines will be wrong, although this is a minor issue.
133 typedef HashSet<RenderFlow*> RenderFlowSequencedSet;
134
135 // Base class for all rendering tree objects.
136 class RenderObject : public CachedResourceClient {
137     friend class RenderContainer;
138     friend class RenderSVGContainer;
139     friend class RenderLayer;
140 public:
141     // Anonymous objects should pass the document as their node, and they will then automatically be
142     // marked as anonymous in the constructor.
143     RenderObject(Node*);
144     virtual ~RenderObject();
145
146     virtual const char* renderName() const { return "RenderObject"; }
147
148     RenderObject* parent() const { return m_parent; }
149     bool isDescendantOf(const RenderObject*) const;
150
151     RenderObject* previousSibling() const { return m_previous; }
152     RenderObject* nextSibling() const { return m_next; }
153
154     virtual RenderObject* firstChild() const { return 0; }
155     virtual RenderObject* lastChild() const { return 0; }
156
157     RenderObject* nextInPreOrder() const;
158     RenderObject* nextInPreOrder(RenderObject* stayWithin) const;
159     RenderObject* nextInPreOrderAfterChildren() const;
160     RenderObject* nextInPreOrderAfterChildren(RenderObject* stayWithin) const;
161     RenderObject* previousInPreOrder() const;
162     RenderObject* childAt(unsigned) const;
163
164     RenderObject* firstLeafChild() const;
165     RenderObject* lastLeafChild() const;
166
167     virtual RenderLayer* layer() const { return 0; }
168     RenderLayer* enclosingLayer() const;
169     void addLayers(RenderLayer* parentLayer, RenderObject* newObject);
170     void removeLayers(RenderLayer* parentLayer);
171     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
172     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint, bool checkParent = true);
173     virtual void positionChildLayers() { }
174     virtual bool requiresLayer();
175
176     virtual IntRect getOverflowClipRect(int /*tx*/, int /*ty*/) { return IntRect(0, 0, 0, 0); }
177     virtual IntRect getClipRect(int /*tx*/, int /*ty*/) { return IntRect(0, 0, 0, 0); }
178     bool hasClip() { return isPositioned() && style()->hasClip(); }
179
180     virtual int getBaselineOfFirstLineBox() const { return -1; }
181     virtual int getBaselineOfLastLineBox() const { return -1; }
182
183     virtual bool isEmpty() const { return firstChild() == 0; }
184
185     virtual bool isEdited() const { return false; }
186     virtual void setEdited(bool) { }
187
188 #ifndef NDEBUG
189     void setHasAXObject(bool flag) { m_hasAXObject = flag; }
190     bool hasAXObject() const { return m_hasAXObject; }
191 #endif
192
193     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
194     // children.
195     virtual RenderBlock* firstLineBlock() const;
196
197     // Called when an object that was floating or positioned becomes a normal flow object
198     // again.  We have to make sure the render tree updates as needed to accommodate the new
199     // normal flow object.
200     void handleDynamicFloatPositionChange();
201
202     // This function is a convenience helper for creating an anonymous block that inherits its
203     // style from this RenderObject.
204     RenderBlock* createAnonymousBlock();
205
206     // Whether or not a positioned element requires normal flow x/y to be computed
207     // to determine its position.
208     bool hasStaticX() const;
209     bool hasStaticY() const;
210     virtual void setStaticX(int /*staticX*/) { }
211     virtual void setStaticY(int /*staticY*/) { }
212     virtual int staticX() const { return 0; }
213     virtual int staticY() const { return 0; }
214
215     // RenderObject tree manipulation
216     //////////////////////////////////////////
217     virtual bool canHaveChildren() const;
218     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const { return true; }
219     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0);
220     virtual void removeChild(RenderObject*);
221     virtual bool createsAnonymousWrapper() const { return false; }
222
223     // raw tree manipulation
224     virtual RenderObject* removeChildNode(RenderObject*, bool fullRemove = true);
225     virtual void appendChildNode(RenderObject*, bool fullAppend = true);
226     virtual void insertChildNode(RenderObject* child, RenderObject* before, bool fullInsert = true);
227     // Designed for speed.  Don't waste time doing a bunch of work like layer updating and repainting when we know that our
228     // change in parentage is not going to affect anything.
229     virtual void moveChildNode(RenderObject*);
230     //////////////////////////////////////////
231
232 protected:
233     //////////////////////////////////////////
234     // Helper functions. Dangerous to use!
235     void setPreviousSibling(RenderObject* previous) { m_previous = previous; }
236     void setNextSibling(RenderObject* next) { m_next = next; }
237     void setParent(RenderObject* parent) { m_parent = parent; }
238     //////////////////////////////////////////
239 private:
240     void addAbsoluteRectForLayer(IntRect& result);
241
242 public:
243 #ifndef NDEBUG
244     void showTreeForThis() const;
245 #endif
246
247     static RenderObject* createObject(Node*, RenderStyle*);
248
249     // Overloaded new operator.  Derived classes must override operator new
250     // in order to allocate out of the RenderArena.
251     void* operator new(size_t, RenderArena*) throw();
252
253     // Overridden to prevent the normal delete from being called.
254     void operator delete(void*, size_t);
255
256 private:
257     // The normal operator new is disallowed on all render objects.
258     void* operator new(size_t) throw();
259
260 public:
261     RenderArena* renderArena() const { return document()->renderArena(); }
262
263     virtual bool isApplet() const { return false; }
264     virtual bool isBR() const { return false; }
265     virtual bool isBlockFlow() const { return false; }
266     virtual bool isCounter() const { return false; }
267     virtual bool isFrame() const { return false; }
268     virtual bool isFrameSet() const { return false; }
269     virtual bool isImage() const { return false; }
270     virtual bool isInlineBlockOrInlineTable() const { return false; }
271     virtual bool isInlineContinuation() const;
272     virtual bool isInlineFlow() const { return false; }
273     virtual bool isListBox() const { return false; }
274     virtual bool isListItem() const { return false; }
275     virtual bool isListMarker() const { return false; }
276     virtual bool isMedia() const { return false; }
277     virtual bool isMenuList() const { return false; }
278     virtual bool isRenderBlock() const { return false; }
279     virtual bool isRenderImage() const { return false; }
280     virtual bool isRenderInline() const { return false; }
281     virtual bool isRenderPart() const { return false; }
282     virtual bool isRenderView() const { return false; }
283     virtual bool isSlider() const { return false; }
284     virtual bool isTable() const { return false; }
285     virtual bool isTableCell() const { return false; }
286     virtual bool isTableCol() const { return false; }
287     virtual bool isTableRow() const { return false; }
288     virtual bool isTableSection() const { return false; }
289     virtual bool isTextArea() const { return false; }
290     virtual bool isTextField() const { return false; }
291     virtual bool isWidget() const { return false; }
292
293
294     bool isRoot() const { return document()->documentElement() == node(); }
295     bool isBody() const;
296     bool isHR() const;
297
298     bool isHTMLMarquee() const;
299
300     virtual bool childrenInline() const { return false; }
301     virtual void setChildrenInline(bool) { }
302
303     virtual RenderFlow* continuation() const;
304
305 #if ENABLE(SVG)
306     virtual bool isSVGRoot() const { return false; }
307     virtual bool isSVGContainer() const { return false; }
308     virtual bool isSVGHiddenContainer() const { return false; }
309     virtual bool isRenderPath() const { return false; }
310     virtual bool isSVGText() const { return false; }
311
312     virtual FloatRect relativeBBox(bool includeStroke = true) const;
313
314     virtual AffineTransform localTransform() const;
315     virtual AffineTransform absoluteTransform() const;
316 #endif
317
318     virtual bool isEditable() const;
319
320     bool isAnonymous() const { return m_isAnonymous; }
321     void setIsAnonymous(bool b) { m_isAnonymous = b; }
322     bool isAnonymousBlock() const
323     {
324         return m_isAnonymous && style()->display() == BLOCK && style()->styleType() == RenderStyle::NOPSEUDO && !isListMarker();
325     }
326
327     bool isFloating() const { return m_floating; }
328     bool isPositioned() const { return m_positioned; } // absolute or fixed positioning
329     bool isRelPositioned() const { return m_relPositioned; } // relative positioning
330     bool isText() const  { return m_isText; }
331     bool isInline() const { return m_inline; }  // inline object
332     bool isCompact() const { return style()->display() == COMPACT; } // compact object
333     bool isRunIn() const { return style()->display() == RUN_IN; } // run-in object
334     bool isDragging() const { return m_isDragging; }
335     bool isReplaced() const { return m_replaced; } // a "replaced" element (see CSS)
336     
337     bool hasLayer() const { return m_hasLayer; }
338     
339     bool hasBoxDecorations() const { return m_paintBackground; }
340     bool mustRepaintBackgroundOrBorder() const;
341
342     bool hasHorizontalBordersPaddingOrMargin() const { return hasHorizontalBordersOrPadding() || marginLeft() != 0 || marginRight() != 0; }
343     bool hasHorizontalBordersOrPadding() const { return borderLeft() != 0 || borderRight() != 0 || paddingLeft() != 0 || paddingRight() != 0; }
344                                                               
345     bool needsLayout() const { return m_needsLayout || m_normalChildNeedsLayout || m_posChildNeedsLayout || m_needsPositionedMovementLayout; }
346     bool selfNeedsLayout() const { return m_needsLayout; }
347     bool needsPositionedMovementLayout() const { return m_needsPositionedMovementLayout; }
348     bool needsPositionedMovementLayoutOnly() const { return m_needsPositionedMovementLayout && !m_needsLayout && !m_normalChildNeedsLayout && !m_posChildNeedsLayout; }
349     bool posChildNeedsLayout() const { return m_posChildNeedsLayout; }
350     bool normalChildNeedsLayout() const { return m_normalChildNeedsLayout; }
351     
352     bool prefWidthsDirty() const { return m_prefWidthsDirty; }
353
354     bool isSelectionBorder() const;
355
356     bool hasOverflowClip() const { return m_hasOverflowClip; }
357     virtual bool hasControlClip() const { return false; }
358     virtual IntRect controlClipRect(int /*tx*/, int /*ty*/) const { return IntRect(); }
359
360     bool hasAutoVerticalScrollbar() const { return hasOverflowClip() && (style()->overflowY() == OAUTO || style()->overflowY() == OOVERLAY); }
361     bool hasAutoHorizontalScrollbar() const { return hasOverflowClip() && (style()->overflowX() == OAUTO || style()->overflowX() == OOVERLAY); }
362
363     bool scrollsOverflow() const { return scrollsOverflowX() || scrollsOverflowY(); }
364     bool scrollsOverflowX() const { return hasOverflowClip() && (style()->overflowX() == OSCROLL || hasAutoHorizontalScrollbar()); }
365     bool scrollsOverflowY() const { return hasOverflowClip() && (style()->overflowY() == OSCROLL || hasAutoVerticalScrollbar()); }
366
367     virtual int verticalScrollbarWidth() const;
368     virtual int horizontalScrollbarHeight() const;
369     
370     bool hasTransform() const { return m_hasTransform; }
371     bool hasMask() const { return style() && style()->hasMask(); }
372     virtual IntRect maskClipRect() { return borderBox(); }
373
374 private:
375     bool includeVerticalScrollbarSize() const { return hasOverflowClip() && (style()->overflowY() == OSCROLL || style()->overflowY() == OAUTO); }
376     bool includeHorizontalScrollbarSize() const { return hasOverflowClip() && (style()->overflowX() == OSCROLL || style()->overflowX() == OAUTO); }
377
378 public:
379     RenderStyle* getPseudoStyle(RenderStyle::PseudoId, RenderStyle* parentStyle = 0) const;
380
381     void updateDragState(bool dragOn);
382
383     RenderView* view() const;
384
385     // don't even think about making this method virtual!
386     Node* element() const { return m_isAnonymous ? 0 : m_node; }
387     Document* document() const { return m_node->document(); }
388     void setNode(Node* node) { m_node = node; }
389     Node* node() const { return m_node; }
390
391     bool hasOutlineAnnotation() const;
392     bool hasOutline() const { return style()->hasOutline() || hasOutlineAnnotation(); }
393
394    /**
395      * returns the object containing this one. can be different from parent for
396      * positioned elements
397      */
398     RenderObject* container() const;
399     RenderObject* hoverAncestor() const;
400
401     virtual void markAllDescendantsWithFloatsForLayout(RenderObject* floatToRemove = 0);
402     void markContainingBlocksForLayout(bool scheduleRelayout = true, RenderObject* newRoot = 0);
403     void setNeedsLayout(bool b, bool markParents = true);
404     void setChildNeedsLayout(bool b, bool markParents = true);
405     void setNeedsPositionedMovementLayout();
406     void setPrefWidthsDirty(bool, bool markParents = true);
407     void invalidateContainerPrefWidths();
408     
409     void setNeedsLayoutAndPrefWidthsRecalc()
410     {
411         setNeedsLayout(true);
412         setPrefWidthsDirty(true);
413     }
414
415     void setPositioned(bool b = true)  { m_positioned = b;  }
416     void setRelPositioned(bool b = true) { m_relPositioned = b; }
417     void setFloating(bool b = true) { m_floating = b; }
418     void setInline(bool b = true) { m_inline = b; }
419     void setHasBoxDecorations(bool b = true) { m_paintBackground = b; }
420     void setRenderText() { m_isText = true; }
421     void setReplaced(bool b = true) { m_replaced = b; }
422     void setHasOverflowClip(bool b = true) { m_hasOverflowClip = b; }
423     void setHasLayer(bool b = true) { m_hasLayer = b; }
424     void setHasTransform(bool b = true) { m_hasTransform = b; }
425     void setHasReflection(bool b = true) { m_hasReflection = b; }
426
427     void scheduleRelayout();
428
429     void updateFillImages(const FillLayer*, const FillLayer*);
430     void updateImage(StyleImage*, StyleImage*);
431
432     virtual InlineBox* createInlineBox(bool makePlaceHolderBox, bool isRootLineBox, bool isOnlyRun = false);
433     virtual void dirtyLineBoxes(bool fullLayout, bool isRootLineBox = false);
434
435     // For inline replaced elements, this function returns the inline box that owns us.  Enables
436     // the replaced RenderObject to quickly determine what line it is contained on and to easily
437     // iterate over structures on the line.
438     virtual InlineBox* inlineBoxWrapper() const;
439     virtual void setInlineBoxWrapper(InlineBox*);
440     virtual void deleteLineBoxWrapper();
441
442     // for discussion of lineHeight see CSS2 spec
443     virtual int lineHeight(bool firstLine, bool isRootLineBox = false) const;
444     // for the vertical-align property of inline elements
445     // the difference between this objects baseline position and the lines baseline position.
446     virtual int verticalPositionHint(bool firstLine) const;
447     // the offset of baseline from the top of the object.
448     virtual int baselinePosition(bool firstLine, bool isRootLineBox = false) const;
449
450     /*
451      * Paint the object and its children, clipped by (x|y|w|h).
452      * (tx|ty) is the calculated position of the parent
453      */
454     struct PaintInfo {
455         PaintInfo(GraphicsContext* newContext, const IntRect& newRect, PaintPhase newPhase, bool newForceBlackText,
456                   RenderObject* newPaintingRoot, RenderFlowSequencedSet* newOutlineObjects)
457             : context(newContext)
458             , rect(newRect)
459             , phase(newPhase)
460             , forceBlackText(newForceBlackText)
461             , paintingRoot(newPaintingRoot)
462             , outlineObjects(newOutlineObjects)
463         {
464         }
465
466         GraphicsContext* context;
467         IntRect rect;
468         PaintPhase phase;
469         bool forceBlackText;
470         RenderObject* paintingRoot; // used to draw just one element and its visual kids
471         RenderFlowSequencedSet* outlineObjects; // used to list outlines that should be painted by a block with inline children
472     };
473
474     virtual void paint(PaintInfo&, int tx, int ty);
475     void paintBorder(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*, bool begin = true, bool end = true);
476     bool paintNinePieceImage(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*, const NinePieceImage&, CompositeOperator = CompositeSourceOver);
477     void paintOutline(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*);
478     void paintBoxShadow(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*, bool begin = true, bool end = true);
479
480     // RenderBox implements this.
481     virtual void paintBoxDecorations(PaintInfo&, int tx, int ty) { }
482     virtual void paintMask(PaintInfo&, int tx, int ty) { }
483     virtual void paintFillLayerExtended(const PaintInfo&, const Color&, const FillLayer*,
484                                         int clipy, int cliph, int tx, int ty, int width, int height,
485                                         InlineFlowBox* box = 0, CompositeOperator = CompositeSourceOver) { }
486
487     
488     /*
489      * Calculates the actual width of the object (only for non inline
490      * objects)
491      */
492     virtual void calcWidth() { }
493
494     /*
495      * This function should cause the Element to calculate its
496      * width and height and the layout of its content
497      *
498      * when the Element calls setNeedsLayout(false), layout() is no
499      * longer called during relayouts, as long as there is no
500      * style sheet change. When that occurs, m_needsLayout will be
501      * set to true and the Element receives layout() calls
502      * again.
503      */
504     virtual void layout() = 0;
505
506     /* This function performs a layout only if one is needed. */
507     void layoutIfNeeded() { if (needsLayout()) layout(); }
508
509     // Called when a positioned object moves but doesn't change size.  A simplified layout is done
510     // that just updates the object's position.
511     virtual void layoutDoingPositionedMovementOnly() {};
512     
513     // used for element state updates that cannot be fixed with a
514     // repaint and do not need a relayout
515     virtual void updateFromElement() { }
516
517     // Block flows subclass availableWidth to handle multi column layout (shrinking the width available to children when laying out.)
518     virtual int availableWidth() const { return contentWidth(); }
519     
520     virtual int availableHeight() const { return 0; }
521
522     virtual void updateWidgetPosition();
523
524 #if ENABLE(DASHBOARD_SUPPORT)
525     void addDashboardRegions(Vector<DashboardRegionValue>&);
526     void collectDashboardRegions(Vector<DashboardRegionValue>&);
527 #endif
528
529     // Used to signal a specific subrect within an object that must be repainted after
530     // layout is complete.
531     struct RepaintInfo {
532         RepaintInfo(RenderObject* object = 0, const IntRect& repaintRect = IntRect())
533             : m_object(object)
534             , m_repaintRect(repaintRect)
535         {
536         }
537
538         RenderObject* m_object;
539         IntRect m_repaintRect;
540     };
541
542     bool hitTest(const HitTestRequest&, HitTestResult&, const IntPoint&, int tx, int ty, HitTestFilter = HitTestAll);
543     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);
544     void updateHitTestResult(HitTestResult&, const IntPoint&);
545
546     virtual VisiblePosition positionForCoordinates(int x, int y);
547     VisiblePosition positionForPoint(const IntPoint& point) { return positionForCoordinates(point.x(), point.y()); }
548
549     virtual void dirtyLinesFromChangedChild(RenderObject*);
550
551     // Called to update a style that is allowed to trigger animations.
552     // FIXME: Right now this will typically be called only when updating happens from the DOM on explicit elements.
553     // We don't yet handle generated content animation such as first-letter or before/after (we'll worry about this later).
554     void setAnimatableStyle(RenderStyle*);
555
556     // Set the style of the object and update the state of the object accordingly.
557     virtual void setStyle(RenderStyle*);
558
559     // Updates only the local style ptr of the object.  Does not update the state of the object,
560     // and so only should be called when the style is known not to have changed (or from setStyle).
561     void setStyleInternal(RenderStyle*);
562
563     // returns the containing block level element for this element.
564     RenderBlock* containingBlock() const;
565
566     // return just the width of the containing block
567     virtual int containingBlockWidth() const;
568     // return just the height of the containing block
569     virtual int containingBlockHeight() const;
570
571     // content area (box minus padding/border)
572     IntRect contentBox() const;
573     IntRect absoluteContentBox() const;
574     int contentWidth() const { return clientWidth() - paddingLeft() - paddingRight(); }
575     int contentHeight() const { return clientHeight() - paddingTop() - paddingBottom(); }
576
577     // used by flexible boxes to impose a flexed width/height override
578     virtual int overrideSize() const { return 0; }
579     virtual int overrideWidth() const { return 0; }
580     virtual int overrideHeight() const { return 0; }
581     virtual void setOverrideSize(int /*overrideSize*/) { }
582
583     // relative to parent node
584     virtual void setPos(int /*xPos*/, int /*yPos*/) { }
585     virtual void setWidth(int /*width*/) { }
586     virtual void setHeight(int /*height*/) { }
587
588     virtual int xPos() const { return 0; }
589     virtual int yPos() const { return 0; }
590
591     // calculate client position of box
592     virtual bool absolutePosition(int& x, int& y, bool fixed = false) const;
593
594     // This function is used to deal with the extra top space that can occur in table cells (called borderTopExtra).
595     // The children of the cell do not factor this space in, so we have to add it in.  Any code that wants to
596     // accurately deal with the contents of a cell must call this function instad of absolutePosition.
597     bool absolutePositionForContent(int& xPos, int& yPos, bool fixed = false) const
598     {
599         bool result = absolutePosition(xPos, yPos, fixed);
600         yPos += borderTopExtra();
601         return result;
602     }
603
604     // width and height are without margins but include paddings and borders
605     virtual int width() const { return 0; }
606     virtual int height() const { return 0; }
607
608     virtual IntRect borderBox() const { return IntRect(0, 0, width(), height()); }
609     IntRect absoluteOutlineBox() const;
610
611     // The height of a block when you include normal flow overflow spillage out of the bottom
612     // of the block (e.g., a <div style="height:25px"> that has a 100px tall image inside
613     // it would have an overflow height of borderTop() + paddingTop() + 100px.
614     virtual int overflowHeight(bool /*includeInterior*/ = true) const { return height(); }
615     virtual int overflowWidth(bool /*includeInterior*/ = true) const { return width(); }
616     virtual void setOverflowHeight(int) { }
617     virtual void setOverflowWidth(int) { }
618     virtual int overflowLeft(bool /*includeInterior*/ = true) const { return 0; }
619     virtual int overflowTop(bool /*includeInterior*/ = true) const { return 0; }
620     virtual IntRect overflowRect(bool /*includeInterior*/ = true) const { return borderBox(); }
621
622     // IE extensions. Used to calculate offsetWidth/Height.  Overridden by inlines (RenderFlow)
623     // to return the remaining width on a given line (and the height of a single line).
624     virtual int offsetWidth() const { return width(); }
625     virtual int offsetHeight() const { return height() + borderTopExtra() + borderBottomExtra(); }
626
627     // IE extensions.  Also supported by Gecko.  We override in render flow to get the
628     // left and top correct. -dwh
629     virtual int offsetLeft() const;
630     virtual int offsetTop() const;
631     virtual RenderObject* offsetParent() const;
632
633     // More IE extensions.  clientWidth and clientHeight represent the interior of an object
634     // excluding border and scrollbar.  clientLeft/Top are just the borderLeftWidth and borderTopWidth.
635     int clientLeft() const { return borderLeft(); }
636     int clientTop() const { return borderTop(); }
637     int clientWidth() const;
638     int clientHeight() const;
639
640     // scrollWidth/scrollHeight will be the same as clientWidth/clientHeight unless the
641     // object has overflow:hidden/scroll/auto specified and also has overflow.
642     // scrollLeft/Top return the current scroll position.  These methods are virtual so that objects like
643     // textareas can scroll shadow content (but pretend that they are the objects that are
644     // scrolling).
645     virtual int scrollLeft() const;
646     virtual int scrollTop() const;
647     virtual int scrollWidth() const;
648     virtual int scrollHeight() const;
649     virtual void setScrollLeft(int);
650     virtual void setScrollTop(int);
651
652     virtual bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1.0f);
653     virtual bool canBeProgramaticallyScrolled(bool) const;
654     bool hasScrollableView() const;
655     virtual void autoscroll();
656     virtual void stopAutoscroll() { }
657
658     virtual void panScroll(const IntPoint&);
659
660     virtual bool isScrollable() const;
661
662     // The following seven functions are used to implement collapsing margins.
663     // All objects know their maximal positive and negative margins.  The
664     // formula for computing a collapsed margin is |maxPosMargin|-|maxNegmargin|.
665     // For a non-collapsing, e.g., a leaf element, this formula will simply return
666     // the margin of the element.  Blocks override the maxTopMargin and maxBottomMargin
667     // methods.
668     virtual bool isSelfCollapsingBlock() const { return false; }
669     virtual int collapsedMarginTop() const { return maxTopMargin(true) - maxTopMargin(false); }
670     virtual int collapsedMarginBottom() const { return maxBottomMargin(true) - maxBottomMargin(false); }
671     virtual bool isTopMarginQuirk() const { return false; }
672     virtual bool isBottomMarginQuirk() const { return false; }
673
674     virtual int maxTopMargin(bool positive) const;
675     virtual int maxBottomMargin(bool positive) const;
676
677     virtual int marginTop() const { return 0; }
678     virtual int marginBottom() const { return 0; }
679     virtual int marginLeft() const { return 0; }
680     virtual int marginRight() const { return 0; }
681
682     // Virtual since table cells override
683     virtual int paddingTop() const;
684     virtual int paddingBottom() const;
685     virtual int paddingLeft() const;
686     virtual int paddingRight() const;
687
688     virtual int borderTop() const { return style()->borderTopWidth(); }
689     virtual int borderBottom() const { return style()->borderBottomWidth(); }
690     virtual int borderTopExtra() const { return 0; }
691     virtual int borderBottomExtra() const { return 0; }
692     virtual int borderLeft() const { return style()->borderLeftWidth(); }
693     virtual int borderRight() const { return style()->borderRightWidth(); }
694
695     virtual void addLineBoxRects(Vector<IntRect>&, unsigned startOffset = 0, unsigned endOffset = UINT_MAX, bool useSelectionHeight = false);
696
697     virtual void absoluteRects(Vector<IntRect>&, int tx, int ty, bool topLevel = true);
698     IntRect absoluteBoundingBoxRect();
699
700     // the rect that will be painted if this object is passed as the paintingRoot
701     IntRect paintingRootRect(IntRect& topLevelRect);
702
703     void addPDFURLRect(GraphicsContext*, const IntRect&);
704
705     virtual void addFocusRingRects(GraphicsContext*, int tx, int ty);
706
707     virtual int minPrefWidth() const { return 0; }
708     virtual int maxPrefWidth() const { return 0; }
709
710     RenderStyle* style() const { return m_style; }
711     RenderStyle* firstLineStyle() const;
712     RenderStyle* style(bool firstLine) const { return firstLine ? firstLineStyle() : style(); }
713
714     void getTextDecorationColors(int decorations, Color& underline, Color& overline,
715                                  Color& linethrough, bool quirksMode = false);
716
717     enum BorderSide {
718         BSTop,
719         BSBottom,
720         BSLeft,
721         BSRight
722     };
723
724     void drawBorderArc(GraphicsContext*, int x, int y, float thickness, IntSize radius, int angleStart,
725                        int angleSpan, BorderSide, Color, const Color& textcolor, EBorderStyle, bool firstCorner);
726     void drawBorder(GraphicsContext*, int x1, int y1, int x2, int y2, BorderSide,
727                     Color, const Color& textcolor, EBorderStyle, int adjbw1, int adjbw2);
728
729     // Repaint the entire object.  Called when, e.g., the color of a border changes, or when a border
730     // style changes.
731     void repaint(bool immediate = false);
732
733     // Repaint a specific subrectangle within a given object.  The rect |r| is in the object's coordinate space.
734     void repaintRectangle(const IntRect&, bool immediate = false);
735
736     // Repaint only if our old bounds and new bounds are different.
737     bool repaintAfterLayoutIfNeeded(const IntRect& oldBounds, const IntRect& oldOutlineBox);
738
739     // Repaint only if the object moved.
740     virtual void repaintDuringLayoutIfMoved(const IntRect& rect);
741
742     // Called to repaint a block's floats.
743     virtual void repaintOverhangingFloats(bool paintAllDescendants = false);
744
745     bool checkForRepaintDuringLayout() const;
746
747     // Returns the rect that should be repainted whenever this object changes.  The rect is in the view's
748     // coordinate space.  This method deals with outlines and overflow.
749     virtual IntRect absoluteClippedOverflowRect();
750
751     IntRect getAbsoluteRepaintRectWithOutline(int ow);
752
753     // Given a rect in the object's coordinate space, this method converts the rectangle to the view's
754     // coordinate space.
755     virtual void computeAbsoluteRepaintRect(IntRect&, bool fixed = false);
756
757     virtual unsigned int length() const { return 1; }
758
759     bool isFloatingOrPositioned() const { return (isFloating() || isPositioned()); }
760     virtual bool containsFloats() { return false; }
761     virtual bool containsFloat(RenderObject*) { return false; }
762     virtual bool hasOverhangingFloats() { return false; }
763     virtual bool expandsToEncloseOverhangingFloats() const { return isFloating() && style()->height().isAuto(); }
764
765     virtual void removePositionedObjects(RenderBlock*) { }
766
767     virtual bool avoidsFloats() const;
768     bool shrinkToAvoidFloats() const;
769
770     // positioning of inline children (bidi)
771     virtual void position(InlineBox*) { }
772
773     bool isTransparent() const { return style()->opacity() < 1.0f; }
774     float opacity() const { return style()->opacity(); }
775
776     bool hasReflection() const { return m_hasReflection; }
777     IntRect reflectionBox() const;
778     int reflectionOffset() const;
779
780     // Applied as a "slop" to dirty rect checks during the outline painting phase's dirty-rect checks.
781     int maximalOutlineSize(PaintPhase) const;
782
783     enum SelectionState {
784         SelectionNone, // The object is not selected.
785         SelectionStart, // The object either contains the start of a selection run or is the start of a run
786         SelectionInside, // The object is fully encompassed by a selection run
787         SelectionEnd, // The object either contains the end of a selection run or is the end of a run
788         SelectionBoth // The object contains an entire run or is the sole selected object in that run
789     };
790
791     // The current selection state for an object.  For blocks, the state refers to the state of the leaf
792     // descendants (as described above in the SelectionState enum declaration).
793     virtual SelectionState selectionState() const { return SelectionNone; }
794
795     // Sets the selection state for an object.
796     virtual void setSelectionState(SelectionState state) { if (parent()) parent()->setSelectionState(state); }
797
798     // A single rectangle that encompasses all of the selected objects within this object.  Used to determine the tightest
799     // possible bounding box for the selection.
800     virtual IntRect selectionRect(bool) { return IntRect(); }
801
802     // Whether or not an object can be part of the leaf elements of the selection.
803     virtual bool canBeSelectionLeaf() const { return false; }
804
805     // Whether or not a block has selected children.
806     virtual bool hasSelectedChildren() const { return false; }
807
808     // Obtains the selection colors that should be used when painting a selection.
809     Color selectionBackgroundColor() const;
810     Color selectionForegroundColor() const;
811
812     // Whether or not a given block needs to paint selection gaps.
813     virtual bool shouldPaintSelectionGaps() const { return false; }
814
815     // This struct is used when the selection changes to cache the old and new state of the selection for each RenderObject.
816     struct SelectionInfo {
817         SelectionInfo()
818             : m_object(0)
819             , m_state(SelectionNone)
820         {
821         }
822
823         SelectionInfo(RenderObject* o, bool clipToVisibleContent)
824             : m_object(o)
825             , m_rect(o->needsLayout() ? IntRect() : o->selectionRect(clipToVisibleContent))
826             , m_state(o->selectionState())
827         {
828         }
829
830         RenderObject* object() const { return m_object; }
831         IntRect rect() const { return m_rect; }
832         SelectionState state() const { return m_state; }
833
834         RenderObject* m_object;
835         IntRect m_rect;
836         SelectionState m_state;
837     };
838
839     Node* draggableNode(bool dhtmlOK, bool uaOK, int x, int y, bool& dhtmlWillDrag) const;
840
841     /**
842      * Returns the content coordinates of the caret within this render object.
843      * @param offset zero-based offset determining position within the render object.
844      * @param override @p true if input overrides existing characters,
845      * @p false if it inserts them. The width of the caret depends on this one.
846      * @param extraWidthToEndOfLine optional out arg to give extra width to end of line -
847      * useful for character range rect computations
848      */
849     virtual IntRect caretRect(InlineBox*, int caretOffset, int* extraWidthToEndOfLine = 0);
850
851     virtual int lowestPosition(bool /*includeOverflowInterior*/ = true, bool /*includeSelf*/ = true) const { return 0; }
852     virtual int rightmostPosition(bool /*includeOverflowInterior*/ = true, bool /*includeSelf*/ = true) const { return 0; }
853     virtual int leftmostPosition(bool /*includeOverflowInterior*/ = true, bool /*includeSelf*/ = true) const { return 0; }
854
855     virtual void calcVerticalMargins() { }
856     void removeFromObjectLists();
857
858     // When performing a global document tear-down, the renderer of the document is cleared.  We use this
859     // as a hook to detect the case of document destruction and don't waste time doing unnecessary work.
860     bool documentBeingDestroyed() const;
861
862     virtual void destroy();
863
864     // Virtual function helpers for CSS3 Flexible Box Layout
865     virtual bool isFlexibleBox() const { return false; }
866     virtual bool isFlexingChildren() const { return false; }
867     virtual bool isStretchingChildren() const { return false; }
868
869     // Convenience, to avoid repeating the code to dig down to get this.
870     UChar backslashAsCurrencySymbol() const;
871
872     virtual int caretMinOffset() const;
873     virtual int caretMaxOffset() const;
874     virtual unsigned caretMaxRenderedOffset() const;
875
876     virtual int previousOffset(int current) const;
877     virtual int nextOffset(int current) const;
878
879     virtual void imageChanged(CachedImage* image);
880     virtual void imageChanged(WrappedImagePtr data) { };
881     virtual bool willRenderImage(CachedImage*);
882
883     virtual void selectionStartEnd(int& spos, int& epos) const;
884
885     RenderObject* paintingRootForChildren(PaintInfo& paintInfo) const
886     {
887         // if we're the painting root, kids draw normally, and see root of 0
888         return (!paintInfo.paintingRoot || paintInfo.paintingRoot == this) ? 0 : paintInfo.paintingRoot;
889     }
890
891     bool shouldPaintWithinRoot(PaintInfo& paintInfo) const
892     {
893         return !paintInfo.paintingRoot || paintInfo.paintingRoot == this;
894     }
895
896     bool hasOverrideSize() const { return m_hasOverrideSize; }
897     void setHasOverrideSize(bool b) { m_hasOverrideSize = b; }
898     
899     void remove() { if (parent()) parent()->removeChild(this); }
900
901     void invalidateVerticalPosition() { m_verticalPosition = PositionUndefined; }
902     
903     virtual void removeLeftoverAnonymousBlock(RenderBlock* child);
904     
905     virtual void capsLockStateMayHaveChanged() { }
906
907     AnimationController* animation() const;
908
909 protected:
910     virtual void printBoxDecorations(GraphicsContext*, int /*x*/, int /*y*/, int /*w*/, int /*h*/, int /*tx*/, int /*ty*/) { }
911
912     virtual IntRect viewRect() const;
913
914     int getVerticalPosition(bool firstLine) const;
915
916     void adjustRectForOutlineAndShadow(IntRect&) const;
917
918     void arenaDelete(RenderArena*, void* objectBase);
919
920 private:
921     RenderStyle* m_style;
922
923     Node* m_node;
924
925     RenderObject* m_parent;
926     RenderObject* m_previous;
927     RenderObject* m_next;
928
929 #ifndef NDEBUG
930     bool m_hasAXObject;
931 #endif
932     mutable int m_verticalPosition;
933
934     bool m_needsLayout               : 1;
935     bool m_needsPositionedMovementLayout :1;
936     bool m_normalChildNeedsLayout    : 1;
937     bool m_posChildNeedsLayout       : 1;
938     bool m_prefWidthsDirty           : 1;
939     bool m_floating                  : 1;
940
941     bool m_positioned                : 1;
942     bool m_relPositioned             : 1;
943     bool m_paintBackground           : 1; // if the box has something to paint in the
944                                           // background painting phase (background, border, etc)
945
946     bool m_isAnonymous               : 1;
947     bool m_isText                    : 1;
948     bool m_inline                    : 1;
949     bool m_replaced                  : 1;
950     bool m_isDragging                : 1;
951
952     bool m_hasLayer                  : 1;
953     bool m_hasOverflowClip           : 1;
954     bool m_hasTransform              : 1;
955     bool m_hasReflection             : 1;
956
957     bool m_hasOverrideSize           : 1;
958     
959 public:
960     bool m_hasCounterNodeMap         : 1;
961     bool m_everHadLayout             : 1;
962 };
963
964 } // namespace WebCore
965
966 #ifndef NDEBUG
967 // Outside the WebCore namespace for ease of invocation from gdb.
968 void showTree(const WebCore::RenderObject*);
969 #endif
970
971 #endif // RenderObject_h