2009-01-31 David Hyatt <hyatt@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, 2009 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 "FloatQuad.h"
30 #include "Document.h"
31 #include "RenderObjectChildList.h"
32 #include "RenderStyle.h"
33
34 namespace WebCore {
35
36 class AnimationController;
37 class HitTestResult;
38 class InlineBox;
39 class InlineFlowBox;
40 class RenderInline;
41 class RenderBlock;
42 class RenderFlow;
43 class RenderLayer;
44 class VisiblePosition;
45
46 /*
47  *  The painting of a layer occurs in three distinct phases.  Each phase involves
48  *  a recursive descent into the layer's render objects. The first phase is the background phase.
49  *  The backgrounds and borders of all blocks are painted.  Inlines are not painted at all.
50  *  Floats must paint above block backgrounds but entirely below inline content that can overlap them.
51  *  In the foreground phase, all inlines are fully painted.  Inline replaced elements will get all
52  *  three phases invoked on them during this phase.
53  */
54
55 enum PaintPhase {
56     PaintPhaseBlockBackground,
57     PaintPhaseChildBlockBackground,
58     PaintPhaseChildBlockBackgrounds,
59     PaintPhaseFloat,
60     PaintPhaseForeground,
61     PaintPhaseOutline,
62     PaintPhaseChildOutlines,
63     PaintPhaseSelfOutline,
64     PaintPhaseSelection,
65     PaintPhaseCollapsedTableBorders,
66     PaintPhaseTextClip,
67     PaintPhaseMask
68 };
69
70 enum PaintRestriction {
71     PaintRestrictionNone,
72     PaintRestrictionSelectionOnly,
73     PaintRestrictionSelectionOnlyBlackText
74 };
75
76 enum HitTestFilter {
77     HitTestAll,
78     HitTestSelf,
79     HitTestDescendants
80 };
81
82 enum HitTestAction {
83     HitTestBlockBackground,
84     HitTestChildBlockBackground,
85     HitTestChildBlockBackgrounds,
86     HitTestFloat,
87     HitTestForeground
88 };
89
90 // Values for verticalPosition.
91 const int PositionTop = -0x7fffffff;
92 const int PositionBottom = 0x7fffffff;
93 const int PositionUndefined = 0x80000000;
94
95 #if ENABLE(DASHBOARD_SUPPORT)
96 struct DashboardRegionValue {
97     bool operator==(const DashboardRegionValue& o) const
98     {
99         return type == o.type && bounds == o.bounds && clip == o.clip && label == o.label;
100     }
101     bool operator!=(const DashboardRegionValue& o) const
102     {
103         return !(*this == o);
104     }
105
106     String label;
107     IntRect bounds;
108     IntRect clip;
109     int type;
110 };
111 #endif
112
113 // Base class for all rendering tree objects.
114 class RenderObject : public CachedResourceClient {
115     friend class RenderBlock;
116     friend class RenderContainer;
117     friend class RenderLayer;
118     friend class RenderSVGContainer;
119 public:
120     // Anonymous objects should pass the document as their node, and they will then automatically be
121     // marked as anonymous in the constructor.
122     RenderObject(Node*);
123     virtual ~RenderObject();
124
125     virtual const char* renderName() const { return "RenderObject"; }
126
127     RenderObject* parent() const { return m_parent; }
128     bool isDescendantOf(const RenderObject*) const;
129
130     RenderObject* previousSibling() const { return m_previous; }
131     RenderObject* nextSibling() const { return m_next; }
132
133     RenderObject* firstChild() const
134     {
135         if (const RenderObjectChildList* children = virtualChildren())
136             return children->firstChild();
137         return 0;
138     }
139     RenderObject* lastChild() const
140     {
141         if (const RenderObjectChildList* children = virtualChildren())
142             return children->lastChild();
143         return 0;
144     }
145     virtual RenderObjectChildList* virtualChildren() { return 0; }
146     virtual const RenderObjectChildList* virtualChildren() const { return 0; }
147
148     RenderObject* nextInPreOrder() const;
149     RenderObject* nextInPreOrder(RenderObject* stayWithin) const;
150     RenderObject* nextInPreOrderAfterChildren() const;
151     RenderObject* nextInPreOrderAfterChildren(RenderObject* stayWithin) const;
152     RenderObject* previousInPreOrder() const;
153     RenderObject* childAt(unsigned) const;
154
155     RenderObject* firstLeafChild() const;
156     RenderObject* lastLeafChild() const;
157
158     // The following five functions are used when the render tree hierarchy changes to make sure layers get
159     // properly added and removed.  Since containership can be implemented by any subclass, and since a hierarchy
160     // can contain a mixture of boxes and other object types, these functions need to be in the base class.
161     RenderLayer* enclosingLayer() const;
162     void addLayers(RenderLayer* parentLayer, RenderObject* newObject);
163     void removeLayers(RenderLayer* parentLayer);
164     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
165     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint, bool checkParent = true);
166
167     // Convenience function for getting to the nearest enclosing box of a RenderObject.
168     RenderBox* enclosingBox() const;
169     
170     virtual IntRect getOverflowClipRect(int /*tx*/, int /*ty*/) { return IntRect(0, 0, 0, 0); }
171     virtual IntRect getClipRect(int /*tx*/, int /*ty*/) { return IntRect(0, 0, 0, 0); }
172     bool hasClip() { return isPositioned() && style()->hasClip(); }
173
174     virtual int getBaselineOfFirstLineBox() const { return -1; }
175     virtual int getBaselineOfLastLineBox() const { return -1; }
176
177     virtual bool isEmpty() const { return firstChild() == 0; }
178
179     virtual bool isEdited() const { return false; }
180     virtual void setEdited(bool) { }
181
182 #ifndef NDEBUG
183     void setHasAXObject(bool flag) { m_hasAXObject = flag; }
184     bool hasAXObject() const { return m_hasAXObject; }
185 #endif
186
187     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
188     // children.
189     virtual RenderBlock* firstLineBlock() const;
190
191     // Called when an object that was floating or positioned becomes a normal flow object
192     // again.  We have to make sure the render tree updates as needed to accommodate the new
193     // normal flow object.
194     void handleDynamicFloatPositionChange();
195
196     // This function is a convenience helper for creating an anonymous block that inherits its
197     // style from this RenderObject.
198     RenderBlock* createAnonymousBlock();
199
200     // Whether or not a positioned element requires normal flow x/y to be computed
201     // to determine its position.
202     bool hasStaticX() const;
203     bool hasStaticY() const;
204     virtual void setStaticX(int /*staticX*/) { }
205     virtual void setStaticY(int /*staticY*/) { }
206     virtual int staticX() const { return 0; }
207     virtual int staticY() const { return 0; }
208
209     // RenderObject tree manipulation
210     //////////////////////////////////////////
211     virtual bool canHaveChildren() const { return virtualChildren(); }
212     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const { return true; }
213     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0);
214     virtual void removeChild(RenderObject*);
215     virtual bool createsAnonymousWrapper() const { return false; }
216
217     // raw tree manipulation
218     virtual RenderObject* removeChildNode(RenderObject*, bool fullRemove = true);
219     virtual void appendChildNode(RenderObject*, bool fullAppend = true);
220     virtual void insertChildNode(RenderObject* child, RenderObject* before, bool fullInsert = true);
221     // Designed for speed.  Don't waste time doing a bunch of work like layer updating and repainting when we know that our
222     // change in parentage is not going to affect anything.
223     virtual void moveChildNode(RenderObject*);
224     //////////////////////////////////////////
225
226 protected:
227     //////////////////////////////////////////
228     // Helper functions. Dangerous to use!
229     void setPreviousSibling(RenderObject* previous) { m_previous = previous; }
230     void setNextSibling(RenderObject* next) { m_next = next; }
231     void setParent(RenderObject* parent) { m_parent = parent; }
232     //////////////////////////////////////////
233 private:
234     void addAbsoluteRectForLayer(IntRect& result);
235
236 public:
237 #ifndef NDEBUG
238     void showTreeForThis() const;
239 #endif
240
241     static RenderObject* createObject(Node*, RenderStyle*);
242
243     // Overloaded new operator.  Derived classes must override operator new
244     // in order to allocate out of the RenderArena.
245     void* operator new(size_t, RenderArena*) throw();
246
247     // Overridden to prevent the normal delete from being called.
248     void operator delete(void*, size_t);
249
250 private:
251     // The normal operator new is disallowed on all render objects.
252     void* operator new(size_t) throw();
253
254 public:
255     RenderArena* renderArena() const { return document()->renderArena(); }
256
257     virtual bool isApplet() const { return false; }
258     virtual bool isBR() const { return false; }
259     virtual bool isBlockFlow() const { return false; }
260     virtual bool isCounter() const { return false; }
261     virtual bool isFieldset() const { return false; }
262     virtual bool isFrame() const { return false; }
263     virtual bool isFrameSet() const { return false; }
264     virtual bool isImage() const { return false; }
265     virtual bool isInlineBlockOrInlineTable() const { return false; }
266     virtual bool isListBox() const { return false; }
267     virtual bool isListItem() const { return false; }
268     virtual bool isListMarker() const { return false; }
269     virtual bool isMedia() const { return false; }
270     virtual bool isMenuList() const { return false; }
271     virtual bool isRenderBlock() const { return false; }
272     virtual bool isRenderImage() const { return false; }
273     virtual bool isRenderInline() const { return false; }
274     virtual bool isRenderPart() const { return false; }
275     virtual bool isRenderView() const { return false; }
276     virtual bool isSlider() const { return false; }
277     virtual bool isTable() const { return false; }
278     virtual bool isTableCell() const { return false; }
279     virtual bool isTableCol() const { return false; }
280     virtual bool isTableRow() const { return false; }
281     virtual bool isTableSection() const { return false; }
282     virtual bool isTextArea() const { return false; }
283     virtual bool isTextField() const { return false; }
284     virtual bool isWidget() const { return false; }
285
286     bool isRoot() const { return document()->documentElement() == node(); }
287     bool isBody() const;
288     bool isHR() const;
289
290     bool isHTMLMarquee() const;
291
292     bool childrenInline() const { return m_childrenInline; }
293     void setChildrenInline(bool b = true) { m_childrenInline = b; }
294     bool hasColumns() const { return m_hasColumns; }
295     void setHasColumns(bool b = true) { m_hasColumns = b; }
296     bool cellWidthChanged() const { return m_cellWidthChanged; }
297     void setCellWidthChanged(bool b = true) { m_cellWidthChanged = b; }
298
299 #if ENABLE(SVG)
300     virtual bool isSVGRoot() const { return false; }
301     virtual bool isSVGContainer() const { return false; }
302     virtual bool isSVGHiddenContainer() const { return false; }
303     virtual bool isRenderPath() const { return false; }
304     virtual bool isSVGText() const { return false; }
305
306     virtual FloatRect relativeBBox(bool includeStroke = true) const;
307
308     virtual TransformationMatrix localTransform() const;
309     virtual TransformationMatrix absoluteTransform() const;
310 #endif
311
312     virtual bool isEditable() const;
313
314     bool isAnonymous() const { return m_isAnonymous; }
315     void setIsAnonymous(bool b) { m_isAnonymous = b; }
316     bool isAnonymousBlock() const
317     {
318         return m_isAnonymous && style()->display() == BLOCK && style()->styleType() == RenderStyle::NOPSEUDO && !isListMarker();
319     }
320     bool isInlineContinuation() const { return isInline() && isBox() && (element() ? element()->renderer() != this : false); }
321     bool isFloating() const { return m_floating; }
322     bool isPositioned() const { return m_positioned; } // absolute or fixed positioning
323     bool isRelPositioned() const { return m_relPositioned; } // relative positioning
324     bool isText() const  { return m_isText; }
325     bool isBox() const { return m_isBox; }
326     bool isInline() const { return m_inline; }  // inline object
327     bool isRunIn() const { return style()->display() == RUN_IN; } // run-in object
328     bool isDragging() const { return m_isDragging; }
329     bool isReplaced() const { return m_replaced; } // a "replaced" element (see CSS)
330     
331     bool hasLayer() const { return m_hasLayer; }
332     
333     bool hasBoxDecorations() const { return m_paintBackground; }
334     bool mustRepaintBackgroundOrBorder() const;
335                                                               
336     bool needsLayout() const { return m_needsLayout || m_normalChildNeedsLayout || m_posChildNeedsLayout || m_needsPositionedMovementLayout; }
337     bool selfNeedsLayout() const { return m_needsLayout; }
338     bool needsPositionedMovementLayout() const { return m_needsPositionedMovementLayout; }
339     bool needsPositionedMovementLayoutOnly() const { return m_needsPositionedMovementLayout && !m_needsLayout && !m_normalChildNeedsLayout && !m_posChildNeedsLayout; }
340     bool posChildNeedsLayout() const { return m_posChildNeedsLayout; }
341     bool normalChildNeedsLayout() const { return m_normalChildNeedsLayout; }
342     
343     bool prefWidthsDirty() const { return m_prefWidthsDirty; }
344
345     bool isSelectionBorder() const;
346
347     bool hasOverflowClip() const { return m_hasOverflowClip; }
348     virtual bool hasControlClip() const { return false; }
349     virtual IntRect controlClipRect(int /*tx*/, int /*ty*/) const { return IntRect(); }
350
351     bool hasTransform() const { return m_hasTransform; }
352     bool hasMask() const { return style() && style()->hasMask(); }
353
354 public:
355     // The pseudo element style can be cached or uncached.  Use the cached method if the pseudo element doesn't respect
356     // any pseudo classes (and therefore has no concept of changing state).
357     RenderStyle* getCachedPseudoStyle(RenderStyle::PseudoId, RenderStyle* parentStyle = 0) const;
358     PassRefPtr<RenderStyle> getUncachedPseudoStyle(RenderStyle::PseudoId, RenderStyle* parentStyle = 0) const;
359     
360     virtual void updateDragState(bool dragOn);
361
362     RenderView* view() const;
363
364     // don't even think about making this method virtual!
365     Node* element() const { return m_isAnonymous ? 0 : m_node; }
366     Document* document() const { return m_node->document(); }
367     void setNode(Node* node) { m_node = node; }
368     Node* node() const { return m_node; }
369
370     bool hasOutlineAnnotation() const;
371     bool hasOutline() const { return style()->hasOutline() || hasOutlineAnnotation(); }
372
373    /**
374      * returns the object containing this one. can be different from parent for
375      * positioned elements
376      */
377     RenderObject* container() const;
378     virtual RenderObject* hoverAncestor() const { return parent(); }
379
380     void markContainingBlocksForLayout(bool scheduleRelayout = true, RenderObject* newRoot = 0);
381     void setNeedsLayout(bool b, bool markParents = true);
382     void setChildNeedsLayout(bool b, bool markParents = true);
383     void setNeedsPositionedMovementLayout();
384     void setPrefWidthsDirty(bool, bool markParents = true);
385     void invalidateContainerPrefWidths();
386     virtual void invalidateCounters() { }
387     
388     void setNeedsLayoutAndPrefWidthsRecalc()
389     {
390         setNeedsLayout(true);
391         setPrefWidthsDirty(true);
392     }
393
394     void setPositioned(bool b = true)  { m_positioned = b;  }
395     void setRelPositioned(bool b = true) { m_relPositioned = b; }
396     void setFloating(bool b = true) { m_floating = b; }
397     void setInline(bool b = true) { m_inline = b; }
398     void setHasBoxDecorations(bool b = true) { m_paintBackground = b; }
399     void setIsText() { m_isText = true; }
400     void setIsBox() { m_isBox = true; }
401     void setReplaced(bool b = true) { m_replaced = b; }
402     void setHasOverflowClip(bool b = true) { m_hasOverflowClip = b; }
403     void setHasLayer(bool b = true) { m_hasLayer = b; }
404     void setHasTransform(bool b = true) { m_hasTransform = b; }
405     void setHasReflection(bool b = true) { m_hasReflection = b; }
406
407     void scheduleRelayout();
408
409     void updateFillImages(const FillLayer*, const FillLayer*);
410     void updateImage(StyleImage*, StyleImage*);
411
412     virtual InlineBox* createInlineBox(bool makePlaceHolderBox, bool isRootLineBox, bool isOnlyRun = false);
413     virtual void dirtyLineBoxes(bool fullLayout, bool isRootLineBox = false);
414
415     // For inline replaced elements, this function returns the inline box that owns us.  Enables
416     // the replaced RenderObject to quickly determine what line it is contained on and to easily
417     // iterate over structures on the line.
418     virtual InlineBox* inlineBoxWrapper() const;
419     virtual void setInlineBoxWrapper(InlineBox*);
420     virtual void deleteLineBoxWrapper();
421
422     // for discussion of lineHeight see CSS2 spec
423     virtual int lineHeight(bool firstLine, bool isRootLineBox = false) const;
424     // for the vertical-align property of inline elements
425     // the difference between this objects baseline position and the lines baseline position.
426     virtual int verticalPositionHint(bool firstLine) const;
427     // the offset of baseline from the top of the object.
428     virtual int baselinePosition(bool firstLine, bool isRootLineBox = false) const;
429
430     /*
431      * Paint the object and its children, clipped by (x|y|w|h).
432      * (tx|ty) is the calculated position of the parent
433      */
434     struct PaintInfo {
435         PaintInfo(GraphicsContext* newContext, const IntRect& newRect, PaintPhase newPhase, bool newForceBlackText,
436                   RenderObject* newPaintingRoot, ListHashSet<RenderInline*>* newOutlineObjects)
437             : context(newContext)
438             , rect(newRect)
439             , phase(newPhase)
440             , forceBlackText(newForceBlackText)
441             , paintingRoot(newPaintingRoot)
442             , outlineObjects(newOutlineObjects)
443         {
444         }
445
446         GraphicsContext* context;
447         IntRect rect;
448         PaintPhase phase;
449         bool forceBlackText;
450         RenderObject* paintingRoot; // used to draw just one element and its visual kids
451         ListHashSet<RenderInline*>* outlineObjects; // used to list outlines that should be painted by a block with inline children
452     };
453
454     virtual void paint(PaintInfo&, int tx, int ty);
455     void paintBorder(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*, bool begin = true, bool end = true);
456     bool paintNinePieceImage(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*, const NinePieceImage&, CompositeOperator = CompositeSourceOver);
457     void paintBoxShadow(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*, bool begin = true, bool end = true);
458
459     // RenderBox implements this.
460     virtual void paintBoxDecorations(PaintInfo&, int /*tx*/, int /*ty*/) { }
461     virtual void paintMask(PaintInfo&, int /*tx*/, int /*ty*/) { }
462     virtual void paintFillLayerExtended(const PaintInfo&, const Color&, const FillLayer*,
463                                         int /*clipY*/, int /*clipH*/, int /*tx*/, int /*ty*/, int /*width*/, int /*height*/,
464                                         InlineFlowBox* = 0, CompositeOperator = CompositeSourceOver) { }
465
466     /*
467      * Calculates the actual width of the object (only for non inline
468      * objects)
469      */
470     virtual void calcWidth() { }
471
472     // Recursive function that computes the size and position of this object and all its descendants.
473     virtual void layout();
474
475     /* This function performs a layout only if one is needed. */
476     void layoutIfNeeded() { if (needsLayout()) layout(); }
477
478     // Called when a positioned object moves but doesn't necessarily change size.  A simplified layout is attempted
479     // that just updates the object's position. If the size does change, the object remains dirty.
480     virtual void tryLayoutDoingPositionedMovementOnly() { }
481     
482     // used for element state updates that cannot be fixed with a
483     // repaint and do not need a relayout
484     virtual void updateFromElement() { }
485
486     virtual void updateWidgetPosition();
487
488 #if ENABLE(DASHBOARD_SUPPORT)
489     void addDashboardRegions(Vector<DashboardRegionValue>&);
490     void collectDashboardRegions(Vector<DashboardRegionValue>&);
491 #endif
492
493     bool hitTest(const HitTestRequest&, HitTestResult&, const IntPoint&, int tx, int ty, HitTestFilter = HitTestAll);
494     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);
495     virtual void updateHitTestResult(HitTestResult&, const IntPoint&);
496
497     virtual VisiblePosition positionForCoordinates(int x, int y);
498     VisiblePosition positionForPoint(const IntPoint&);
499
500     virtual void dirtyLinesFromChangedChild(RenderObject*);
501
502     // Called to update a style that is allowed to trigger animations.
503     // FIXME: Right now this will typically be called only when updating happens from the DOM on explicit elements.
504     // We don't yet handle generated content animation such as first-letter or before/after (we'll worry about this later).
505     void setAnimatableStyle(PassRefPtr<RenderStyle>);
506
507     // Set the style of the object and update the state of the object accordingly.
508     virtual void setStyle(PassRefPtr<RenderStyle>);
509
510     // Updates only the local style ptr of the object.  Does not update the state of the object,
511     // and so only should be called when the style is known not to have changed (or from setStyle).
512     void setStyleInternal(PassRefPtr<RenderStyle>);
513
514     // returns the containing block level element for this element.
515     RenderBlock* containingBlock() const;
516
517     // return just the width of the containing block
518     virtual int containingBlockWidth() const;
519     // return just the height of the containing block
520     virtual int containingBlockHeight() const;
521
522     // used by flexible boxes to impose a flexed width/height override
523     virtual int overrideSize() const { return 0; }
524     virtual int overrideWidth() const { return 0; }
525     virtual int overrideHeight() const { return 0; }
526     virtual void setOverrideSize(int /*overrideSize*/) { }
527
528     // Convert the given local point to absolute coordinates
529     // FIXME: Temporary. If useTransforms is true, take transforms into account. Eventually localToAbsolute() will always be transform-aware.
530     virtual FloatPoint localToAbsolute(FloatPoint localPoint = FloatPoint(), bool fixed = false, bool useTransforms = false) const;
531     virtual FloatPoint absoluteToLocal(FloatPoint, bool fixed = false, bool useTransforms = false) const;
532
533     // Convert a local quad to absolute coordinates, taking transforms into account.
534     FloatQuad localToAbsoluteQuad(const FloatQuad& quad, bool fixed = false) const
535     {
536         return localToContainerQuad(quad, 0, fixed);
537     }
538     // Convert a local quad into the coordinate system of container, taking transforms into account.
539     virtual FloatQuad localToContainerQuad(const FloatQuad&, RenderBox* repaintContainer, bool fixed = false) const;
540
541     // Return the offset from the container() renderer (excluding transforms)
542     virtual IntSize offsetFromContainer(RenderObject*) const;
543
544     virtual void addLineBoxRects(Vector<IntRect>&, unsigned startOffset = 0, unsigned endOffset = UINT_MAX, bool useSelectionHeight = false);
545     
546     virtual void absoluteRects(Vector<IntRect>&, int, int, bool = true) { }
547     // FIXME: useTransforms should go away eventually
548     IntRect absoluteBoundingBoxRect(bool useTransforms = false);
549
550     // Build an array of quads in absolute coords for line boxes
551     virtual void collectAbsoluteLineBoxQuads(Vector<FloatQuad>&, unsigned /*startOffset*/ = 0, unsigned /*endOffset*/ = UINT_MAX, bool /*useSelectionHeight*/ = false) { }
552     virtual void absoluteQuads(Vector<FloatQuad>&, bool /*topLevel*/ = true) { }
553
554     // the rect that will be painted if this object is passed as the paintingRoot
555     IntRect paintingRootRect(IntRect& topLevelRect);
556
557     virtual int minPrefWidth() const { return 0; }
558     virtual int maxPrefWidth() const { return 0; }
559
560     RenderStyle* style() const { return m_style.get(); }
561     RenderStyle* firstLineStyle() const;
562     RenderStyle* style(bool firstLine) const { return firstLine ? firstLineStyle() : style(); }
563     
564     // Anonymous blocks that are part of of a continuation chain will return their inline continuation's outline style instead.
565     // This is typically only relevant when repainting.
566     virtual RenderStyle* outlineStyleForRepaint() const { return style(); }
567     
568     void getTextDecorationColors(int decorations, Color& underline, Color& overline,
569                                  Color& linethrough, bool quirksMode = false);
570
571     enum BorderSide {
572         BSTop,
573         BSBottom,
574         BSLeft,
575         BSRight
576     };
577
578     void drawBorderArc(GraphicsContext*, int x, int y, float thickness, IntSize radius, int angleStart,
579                        int angleSpan, BorderSide, Color, const Color& textcolor, EBorderStyle, bool firstCorner);
580     void drawBorder(GraphicsContext*, int x1, int y1, int x2, int y2, BorderSide,
581                     Color, const Color& textcolor, EBorderStyle, int adjbw1, int adjbw2);
582
583     // Return the RenderBox in the container chain which is responsible for painting this object, or 0
584     // if painting is root-relative. This is the container that should be passed to the 'forRepaint'
585     // methods.
586     RenderBox* containerForRepaint() const;
587     // Actually do the repaint of rect r for this object which has been computed in the coordinate space
588     // of repaintContainer. If repaintContainer is 0, repaint via the view.
589     void repaintUsingContainer(RenderBox* repaintContainer, const IntRect& r, bool immediate = false);
590     
591     // Repaint the entire object.  Called when, e.g., the color of a border changes, or when a border
592     // style changes.
593     void repaint(bool immediate = false);
594
595     // Repaint a specific subrectangle within a given object.  The rect |r| is in the object's coordinate space.
596     void repaintRectangle(const IntRect&, bool immediate = false);
597
598     // Repaint only if our old bounds and new bounds are different.
599     bool repaintAfterLayoutIfNeeded(RenderBox* repaintContainer, const IntRect& oldBounds, const IntRect& oldOutlineBox);
600
601     // Repaint only if the object moved.
602     virtual void repaintDuringLayoutIfMoved(const IntRect& rect);
603
604     // Called to repaint a block's floats.
605     virtual void repaintOverhangingFloats(bool paintAllDescendants = false);
606
607     bool checkForRepaintDuringLayout() const;
608
609     // Returns the rect that should be repainted whenever this object changes.  The rect is in the view's
610     // coordinate space.  This method deals with outlines and overflow.
611     IntRect absoluteClippedOverflowRect()
612     {
613         return clippedOverflowRectForRepaint(0);
614     }
615     virtual IntRect clippedOverflowRectForRepaint(RenderBox* repaintContainer);    
616     virtual IntRect rectWithOutlineForRepaint(RenderBox* repaintContainer, int outlineWidth);
617
618     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
619     // that rect in view coordinates.
620     void computeAbsoluteRepaintRect(IntRect& r, bool fixed = false)
621     {
622         return computeRectForRepaint(0, r, fixed);
623     }
624     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
625     // that rect in the coordinate space of repaintContainer.
626     virtual void computeRectForRepaint(RenderBox* repaintContainer, IntRect&, bool fixed = false);
627
628     virtual unsigned int length() const { return 1; }
629
630     bool isFloatingOrPositioned() const { return (isFloating() || isPositioned()); }
631     virtual bool containsFloats() { return false; }
632     virtual bool containsFloat(RenderObject*) { return false; }
633     virtual bool hasOverhangingFloats() { return false; }
634
635     virtual bool avoidsFloats() const;
636     bool shrinkToAvoidFloats() const;
637
638     // positioning of inline children (bidi)
639     virtual void position(InlineBox*) { }
640
641     bool isTransparent() const { return style()->opacity() < 1.0f; }
642     float opacity() const { return style()->opacity(); }
643
644     bool hasReflection() const { return m_hasReflection; }
645
646     // Applied as a "slop" to dirty rect checks during the outline painting phase's dirty-rect checks.
647     int maximalOutlineSize(PaintPhase) const;
648
649     void setHasMarkupTruncation(bool b = true) { m_hasMarkupTruncation = b; }
650     bool hasMarkupTruncation() const { return m_hasMarkupTruncation; }
651
652     enum SelectionState {
653         SelectionNone, // The object is not selected.
654         SelectionStart, // The object either contains the start of a selection run or is the start of a run
655         SelectionInside, // The object is fully encompassed by a selection run
656         SelectionEnd, // The object either contains the end of a selection run or is the end of a run
657         SelectionBoth // The object contains an entire run or is the sole selected object in that run
658     };
659
660     // The current selection state for an object.  For blocks, the state refers to the state of the leaf
661     // descendants (as described above in the SelectionState enum declaration).
662     SelectionState selectionState() const { return static_cast<SelectionState>(m_selectionState);; }
663
664     // Sets the selection state for an object.
665     virtual void setSelectionState(SelectionState state) { m_selectionState = state; }
666
667     // A single rectangle that encompasses all of the selected objects within this object.  Used to determine the tightest
668     // possible bounding box for the selection.
669     virtual IntRect selectionRect(bool) { return IntRect(); }
670
671     // Whether or not an object can be part of the leaf elements of the selection.
672     virtual bool canBeSelectionLeaf() const { return false; }
673
674     // Whether or not a block has selected children.
675     bool hasSelectedChildren() const { return m_selectionState != SelectionNone; }
676
677     // Obtains the selection colors that should be used when painting a selection.
678     Color selectionBackgroundColor() const;
679     Color selectionForegroundColor() const;
680
681     // Whether or not a given block needs to paint selection gaps.
682     virtual bool shouldPaintSelectionGaps() const { return false; }
683
684     // This struct is used when the selection changes to cache the old and new state of the selection for each RenderObject.
685     struct SelectionInfo {
686         SelectionInfo()
687             : m_object(0)
688             , m_state(SelectionNone)
689         {
690         }
691
692         SelectionInfo(RenderObject* o, bool clipToVisibleContent)
693             : m_object(o)
694             , m_rect(o->needsLayout() ? IntRect() : o->selectionRect(clipToVisibleContent))
695             , m_state(o->selectionState())
696         {
697         }
698
699         RenderObject* object() const { return m_object; }
700         IntRect rect() const { return m_rect; }
701         SelectionState state() const { return m_state; }
702
703         RenderObject* m_object;
704         IntRect m_rect;
705         SelectionState m_state;
706     };
707
708     Node* draggableNode(bool dhtmlOK, bool uaOK, int x, int y, bool& dhtmlWillDrag) const;
709
710     /**
711      * Returns the local coordinates of the caret within this render object.
712      * @param caretOffset zero-based offset determining position within the render object.
713      * @param extraWidthToEndOfLine optional out arg to give extra width to end of line -
714      * useful for character range rect computations
715      */
716     virtual IntRect localCaretRect(InlineBox*, int caretOffset, int* extraWidthToEndOfLine = 0);
717
718     virtual int lowestPosition(bool /*includeOverflowInterior*/ = true, bool /*includeSelf*/ = true) const { return 0; }
719     virtual int rightmostPosition(bool /*includeOverflowInterior*/ = true, bool /*includeSelf*/ = true) const { return 0; }
720     virtual int leftmostPosition(bool /*includeOverflowInterior*/ = true, bool /*includeSelf*/ = true) const { return 0; }
721
722     virtual void calcVerticalMargins() { }
723     bool isTopMarginQuirk() const { return m_topMarginQuirk; }
724     bool isBottomMarginQuirk() const { return m_bottomMarginQuirk; }
725     void setTopMarginQuirk(bool b = true) { m_topMarginQuirk = b; }
726     void setBottomMarginQuirk(bool b = true) { m_bottomMarginQuirk = b; }
727
728     void removeFromObjectLists();
729
730     // When performing a global document tear-down, the renderer of the document is cleared.  We use this
731     // as a hook to detect the case of document destruction and don't waste time doing unnecessary work.
732     bool documentBeingDestroyed() const;
733
734     virtual void destroy();
735
736     // Virtual function helpers for CSS3 Flexible Box Layout
737     virtual bool isFlexibleBox() const { return false; }
738     virtual bool isFlexingChildren() const { return false; }
739     virtual bool isStretchingChildren() const { return false; }
740
741     virtual int caretMinOffset() const;
742     virtual int caretMaxOffset() const;
743     virtual unsigned caretMaxRenderedOffset() const;
744
745     virtual int previousOffset(int current) const;
746     virtual int nextOffset(int current) const;
747
748     virtual void imageChanged(CachedImage*, const IntRect* = 0);
749     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) { }
750     virtual bool willRenderImage(CachedImage*);
751
752     virtual void selectionStartEnd(int& spos, int& epos) const;
753
754     RenderObject* paintingRootForChildren(PaintInfo& paintInfo) const
755     {
756         // if we're the painting root, kids draw normally, and see root of 0
757         return (!paintInfo.paintingRoot || paintInfo.paintingRoot == this) ? 0 : paintInfo.paintingRoot;
758     }
759
760     bool shouldPaintWithinRoot(PaintInfo& paintInfo) const
761     {
762         return !paintInfo.paintingRoot || paintInfo.paintingRoot == this;
763     }
764
765     bool hasOverrideSize() const { return m_hasOverrideSize; }
766     void setHasOverrideSize(bool b) { m_hasOverrideSize = b; }
767     
768     void remove() { if (parent()) parent()->removeChild(this); }
769
770     void invalidateVerticalPosition() { m_verticalPosition = PositionUndefined; }
771
772     virtual void capsLockStateMayHaveChanged() { }
773
774     AnimationController* animation() const;
775
776     bool visibleToHitTesting() const { return style()->visibility() == VISIBLE && style()->pointerEvents() != PE_NONE; }
777     
778     virtual void addFocusRingRects(GraphicsContext*, int /*tx*/, int /*ty*/) { };
779
780     IntRect absoluteOutlineBounds() const
781     {
782         return outlineBoundsForRepaint(0);
783     }
784
785 protected:
786     // Overrides should call the superclass at the end
787     virtual void styleWillChange(RenderStyle::Diff, const RenderStyle* newStyle);
788     // Overrides should call the superclass at the start
789     virtual void styleDidChange(RenderStyle::Diff, const RenderStyle* oldStyle);
790     
791     virtual void printBoxDecorations(GraphicsContext*, int /*x*/, int /*y*/, int /*w*/, int /*h*/, int /*tx*/, int /*ty*/) { }
792
793     void paintOutline(GraphicsContext*, int tx, int ty, int w, int h, const RenderStyle*);
794     void addPDFURLRect(GraphicsContext*, const IntRect&);
795
796     virtual IntRect viewRect() const;
797
798     int getVerticalPosition(bool firstLine) const;
799
800     void adjustRectForOutlineAndShadow(IntRect&) const;
801
802     void arenaDelete(RenderArena*, void* objectBase);
803
804     virtual IntRect outlineBoundsForRepaint(RenderBox* /*repaintContainer*/) const { return IntRect(); }
805
806     class LayoutRepainter {
807     public:
808         LayoutRepainter(RenderObject& object, bool checkForRepaint, const IntRect* oldBounds = 0)
809             : m_object(object)
810             , m_repaintContainer(0)
811             , m_checkForRepaint(checkForRepaint)
812         {
813             if (m_checkForRepaint) {
814                 m_repaintContainer = m_object.containerForRepaint();
815                 m_oldBounds = oldBounds ? *oldBounds : m_object.clippedOverflowRectForRepaint(m_repaintContainer);
816                 m_oldOutlineBox = m_object.outlineBoundsForRepaint(m_repaintContainer);
817             }
818         }
819         
820         // Return true if it repainted.
821         bool repaintAfterLayout()
822         {
823             return m_checkForRepaint ? m_object.repaintAfterLayoutIfNeeded(m_repaintContainer, m_oldBounds, m_oldOutlineBox) : false;
824         }
825         
826         bool checkForRepaint() const { return m_checkForRepaint; }
827         
828     private:
829         RenderObject& m_object;
830         RenderBox* m_repaintContainer;
831         IntRect m_oldBounds;
832         IntRect m_oldOutlineBox;
833         bool m_checkForRepaint;
834     };
835     
836 private:
837     RefPtr<RenderStyle> m_style;
838
839     Node* m_node;
840
841     RenderObject* m_parent;
842     RenderObject* m_previous;
843     RenderObject* m_next;
844
845 #ifndef NDEBUG
846     bool m_hasAXObject;
847 #endif
848     mutable int m_verticalPosition;
849
850     // 31 bits have been used here.  Count the bits before you add any and update the comment
851     // with the new total.
852     bool m_needsLayout               : 1;
853     bool m_needsPositionedMovementLayout :1;
854     bool m_normalChildNeedsLayout    : 1;
855     bool m_posChildNeedsLayout       : 1;
856     bool m_prefWidthsDirty           : 1;
857     bool m_floating                  : 1;
858
859     bool m_positioned                : 1;
860     bool m_relPositioned             : 1;
861     bool m_paintBackground           : 1; // if the box has something to paint in the
862                                           // background painting phase (background, border, etc)
863
864     bool m_isAnonymous               : 1;
865     bool m_isText                    : 1;
866     bool m_isBox                     : 1;
867     bool m_inline                    : 1;
868     bool m_replaced                  : 1;
869     bool m_isDragging                : 1;
870
871     bool m_hasLayer                  : 1;
872     bool m_hasOverflowClip           : 1;
873     bool m_hasTransform              : 1;
874     bool m_hasReflection             : 1;
875
876     bool m_hasOverrideSize           : 1;
877     
878 public:
879     bool m_hasCounterNodeMap         : 1;
880     bool m_everHadLayout             : 1;
881
882 private:
883     // These bitfields are moved here from subclasses to pack them together
884     // from RenderBlock
885     bool m_childrenInline : 1;
886     bool m_topMarginQuirk : 1;
887     bool m_bottomMarginQuirk : 1;
888     bool m_hasMarkupTruncation : 1;
889     unsigned m_selectionState : 3; // SelectionState
890     bool m_hasColumns : 1;
891     
892     // from RenderTableCell
893     bool m_cellWidthChanged : 1;
894
895 private:
896     // Store state between styleWillChange and styleDidChange
897     static bool s_affectsParentBlock;
898 };
899
900 } // namespace WebCore
901
902 #ifndef NDEBUG
903 // Outside the WebCore namespace for ease of invocation from gdb.
904 void showTree(const WebCore::RenderObject*);
905 #endif
906
907 #endif // RenderObject_h