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