Unreviewed, rolling out r100473.
[WebKit-https.git] / Source / 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  * Copyright (C) 2009 Google Inc. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  *
24  */
25
26 #ifndef RenderObject_h
27 #define RenderObject_h
28
29 #include "CachedImage.h"
30 #include "Document.h"
31 #include "Element.h"
32 #include "FloatQuad.h"
33 #include "LayoutTypes.h"
34 #include "PaintPhase.h"
35 #include "RenderObjectChildList.h"
36 #include "RenderStyle.h"
37 #include "TextAffinity.h"
38 #include "TransformationMatrix.h"
39 #include <wtf/UnusedParam.h>
40
41 #if USE(CG) || USE(CAIRO) || USE(SKIA) || PLATFORM(QT)
42 #define HAVE_PATH_BASED_BORDER_RADIUS_DRAWING 1
43 #endif
44
45 namespace WebCore {
46
47 class AffineTransform;
48 class AnimationController;
49 class Cursor;
50 class HitTestResult;
51 class InlineBox;
52 class InlineFlowBox;
53 class OverlapTestRequestClient;
54 class Path;
55 class Position;
56 class RenderBoxModelObject;
57 class RenderInline;
58 class RenderBlock;
59 class RenderFlowThread;
60 class RenderLayer;
61 class RenderTheme;
62 class TransformState;
63 class VisiblePosition;
64 #if ENABLE(SVG)
65 class RenderSVGResourceContainer;
66 #endif
67
68 struct PaintInfo;
69
70 enum CursorDirective {
71     SetCursorBasedOnStyle,
72     SetCursor,
73     DoNotSetCursor
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 // Sides used when drawing borders and outlines. The values should run clockwise from top.
91 enum BoxSide {
92     BSTop,
93     BSRight,
94     BSBottom,
95     BSLeft
96 };
97
98 const int caretWidth = 1;
99
100 #if ENABLE(DASHBOARD_SUPPORT)
101 struct DashboardRegionValue {
102     bool operator==(const DashboardRegionValue& o) const
103     {
104         return type == o.type && bounds == o.bounds && clip == o.clip && label == o.label;
105     }
106     bool operator!=(const DashboardRegionValue& o) const
107     {
108         return !(*this == o);
109     }
110
111     String label;
112     LayoutRect bounds;
113     LayoutRect clip;
114     int type;
115 };
116 #endif
117
118 #ifndef NDEBUG
119 const int showTreeCharacterOffset = 39;
120 #endif
121
122 // Base class for all rendering tree objects.
123 class RenderObject : public CachedImageClient {
124     friend class LayoutRepainter;
125     friend class RenderBlock;
126     friend class RenderBox;
127     friend class RenderLayer;
128     friend class RenderObjectChildList;
129     friend class RenderSVGContainer;
130 public:
131     // Anonymous objects should pass the document as their node, and they will then automatically be
132     // marked as anonymous in the constructor.
133     RenderObject(Node*);
134     virtual ~RenderObject();
135
136     RenderTheme* theme() const;
137
138     virtual const char* renderName() const = 0;
139
140     RenderObject* parent() const { return m_parent; }
141     bool isDescendantOf(const RenderObject*) const;
142
143     RenderObject* previousSibling() const { return m_previous; }
144     RenderObject* nextSibling() const { return m_next; }
145
146     RenderObject* firstChild() const
147     {
148         if (const RenderObjectChildList* children = virtualChildren())
149             return children->firstChild();
150         return 0;
151     }
152     RenderObject* lastChild() const
153     {
154         if (const RenderObjectChildList* children = virtualChildren())
155             return children->lastChild();
156         return 0;
157     }
158     RenderObject* beforePseudoElementRenderer() const
159     {
160         if (const RenderObjectChildList* children = virtualChildren())
161             return children->beforePseudoElementRenderer(this);
162         return 0;
163     }
164
165     // This function only returns the renderer of the "after" pseudoElement if it is a child of
166     // this renderer. If "continuations" exist, the function returns 0 even if the element that
167     // generated this renderer has an "after" pseudo-element.
168     RenderObject* afterPseudoElementRenderer() const
169     {
170         if (const RenderObjectChildList* children = virtualChildren())
171             return children->afterPseudoElementRenderer(this);
172         return 0;
173     }
174
175     virtual RenderObjectChildList* virtualChildren() { return 0; }
176     virtual const RenderObjectChildList* virtualChildren() const { return 0; }
177
178     RenderObject* nextInPreOrder() const;
179     RenderObject* nextInPreOrder(const RenderObject* stayWithin) const;
180     RenderObject* nextInPreOrderAfterChildren() const;
181     RenderObject* nextInPreOrderAfterChildren(const RenderObject* stayWithin) const;
182     RenderObject* previousInPreOrder() const;
183     RenderObject* childAt(unsigned) const;
184
185     RenderObject* firstLeafChild() const;
186     RenderObject* lastLeafChild() const;
187
188     // The following six functions are used when the render tree hierarchy changes to make sure layers get
189     // properly added and removed.  Since containership can be implemented by any subclass, and since a hierarchy
190     // can contain a mixture of boxes and other object types, these functions need to be in the base class.
191     RenderLayer* enclosingLayer() const;
192     void addLayers(RenderLayer* parentLayer);
193     void removeLayers(RenderLayer* parentLayer);
194     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
195     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint, bool checkParent = true);
196
197     // Convenience function for getting to the nearest enclosing box of a RenderObject.
198     RenderBox* enclosingBox() const;
199     RenderBoxModelObject* enclosingBoxModelObject() const;
200
201     // Function to return our enclosing flow thread if we are contained inside one.
202     RenderFlowThread* enclosingRenderFlowThread() const;
203
204     virtual bool isEmpty() const { return firstChild() == 0; }
205
206 #ifndef NDEBUG
207     void setHasAXObject(bool flag) { m_hasAXObject = flag; }
208     bool hasAXObject() const { return m_hasAXObject; }
209     bool isSetNeedsLayoutForbidden() const { return m_setNeedsLayoutForbidden; }
210     void setNeedsLayoutIsForbidden(bool flag) { m_setNeedsLayoutForbidden = flag; }
211 #endif
212
213     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
214     // children.
215     virtual RenderBlock* firstLineBlock() const;
216
217     // Called when an object that was floating or positioned becomes a normal flow object
218     // again.  We have to make sure the render tree updates as needed to accommodate the new
219     // normal flow object.
220     void handleDynamicFloatPositionChange();
221     
222     // RenderObject tree manipulation
223     //////////////////////////////////////////
224     virtual bool canHaveChildren() const { return virtualChildren(); }
225     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const { return true; }
226     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0);
227     virtual void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild = 0) { return addChild(newChild, beforeChild); }
228     virtual void removeChild(RenderObject*);
229     virtual bool createsAnonymousWrapper() const { return false; }
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)
238     {
239         m_parent = parent;
240         if (parent && parent->inRenderFlowThread())
241             setInRenderFlowThread(true);
242         else if (!parent && inRenderFlowThread())
243             setInRenderFlowThread(false);
244     }
245     //////////////////////////////////////////
246 private:
247     void addAbsoluteRectForLayer(LayoutRect& result);
248     void setLayerNeedsFullRepaint();
249
250 public:
251 #ifndef NDEBUG
252     void showTreeForThis() const;
253     void showRenderTreeForThis() const;
254     void showLineTreeForThis() const;
255
256     void showRenderObject() const;
257     // We don't make printedCharacters an optional parameter so that
258     // showRenderObject can be called from gdb easily.
259     void showRenderObject(int printedCharacters) const;
260     void showRenderTreeAndMark(const RenderObject* markedObject1 = 0, const char* markedLabel1 = 0, const RenderObject* markedObject2 = 0, const char* markedLabel2 = 0, int depth = 0) const;
261 #endif
262
263     static RenderObject* createObject(Node*, RenderStyle*);
264
265     // Overloaded new operator.  Derived classes must override operator new
266     // in order to allocate out of the RenderArena.
267     void* operator new(size_t, RenderArena*) throw();
268
269     // Overridden to prevent the normal delete from being called.
270     void operator delete(void*, size_t);
271
272 private:
273     // The normal operator new is disallowed on all render objects.
274     void* operator new(size_t) throw();
275
276 public:
277     RenderArena* renderArena() const { return document()->renderArena(); }
278
279     virtual bool isApplet() const { return false; }
280     virtual bool isBR() const { return false; }
281     virtual bool isBlockFlow() const { return false; }
282     virtual bool isBoxModelObject() const { return false; }
283     virtual bool isCounter() const { return false; }
284     virtual bool isQuote() const { return false; }
285 #if ENABLE(DETAILS)
286     virtual bool isDetails() const { return false; }
287     virtual bool isDetailsMarker() const { return false; }
288 #endif
289     virtual bool isEmbeddedObject() const { return false; }
290     virtual bool isFieldset() const { return false; }
291     virtual bool isFileUploadControl() const { return false; }
292     virtual bool isFrame() const { return false; }
293     virtual bool isFrameSet() const { return false; }
294     virtual bool isImage() const { return false; }
295     virtual bool isInlineBlockOrInlineTable() const { return false; }
296     virtual bool isListBox() const { return false; }
297     virtual bool isListItem() const { return false; }
298     virtual bool isListMarker() const { return false; }
299     virtual bool isMedia() const { return false; }
300     virtual bool isMenuList() const { return false; }
301 #if ENABLE(METER_TAG)
302     virtual bool isMeter() const { return false; }
303 #endif
304 #if ENABLE(PROGRESS_TAG)
305     virtual bool isProgress() const { return false; }
306 #endif
307     virtual bool isRenderBlock() const { return false; }
308     virtual bool isRenderButton() const { return false; }
309     virtual bool isRenderIFrame() const { return false; }
310     virtual bool isRenderImage() const { return false; }
311     virtual bool isRenderInline() const { return false; }
312     virtual bool isRenderPart() const { return false; }
313     virtual bool isRenderRegion() const { return false; }
314     virtual bool isRenderView() const { return false; }
315     virtual bool isReplica() const { return false; }
316
317     virtual bool isRuby() const { return false; }
318     virtual bool isRubyBase() const { return false; }
319     virtual bool isRubyRun() const { return false; }
320     virtual bool isRubyText() const { return false; }
321
322     virtual bool isSlider() const { return false; }
323     virtual bool isSliderThumb() const { return false; }
324 #if ENABLE(DETAILS)
325     virtual bool isSummary() const { return false; }
326 #endif
327     virtual bool isTable() const { return false; }
328     virtual bool isTableCell() const { return false; }
329     virtual bool isTableCol() const { return false; }
330     virtual bool isTableRow() const { return false; }
331     virtual bool isTableSection() const { return false; }
332     virtual bool isTextControl() const { return false; }
333     virtual bool isTextArea() const { return false; }
334     virtual bool isTextField() const { return false; }
335     virtual bool isVideo() const { return false; }
336     virtual bool isWidget() const { return false; }
337     virtual bool isCanvas() const { return false; }
338 #if ENABLE(FULLSCREEN_API)
339     virtual bool isRenderFullScreen() const { return false; }
340     virtual bool isRenderFullScreenPlaceholder() const { return false; }
341 #endif
342
343     virtual bool isRenderFlowThread() const { return false; }
344
345     bool isRoot() const { return document()->documentElement() == m_node; }
346     bool isBody() const;
347     bool isHR() const;
348     bool isLegend() const;
349
350     bool isHTMLMarquee() const;
351
352     inline bool isBeforeContent() const;
353     inline bool isAfterContent() const;
354     inline bool isBeforeOrAfterContent() const;
355     static inline bool isBeforeContent(const RenderObject* obj) { return obj && obj->isBeforeContent(); }
356     static inline bool isAfterContent(const RenderObject* obj) { return obj && obj->isAfterContent(); }
357     static inline bool isBeforeOrAfterContent(const RenderObject* obj) { return obj && obj->isBeforeOrAfterContent(); }
358
359     inline RenderObject* findBeforeContentRenderer() const
360     {
361         RenderObject* renderer = beforePseudoElementRenderer();
362         return isBeforeContent(renderer) ? renderer : 0;
363     }
364
365     inline RenderObject* findAfterContentRenderer() const
366     {
367         RenderObject* renderer = afterPseudoElementRenderer();
368         return isAfterContent(renderer) ? renderer : 0;
369     }
370
371     inline RenderObject* anonymousContainer(RenderObject* child)
372     {
373          RenderObject* container = child;
374          while (container->parent() != this)
375              container = container->parent();
376
377          ASSERT(container->isAnonymous());
378          return container;
379     }
380
381     bool childrenInline() const { return m_childrenInline; }
382     void setChildrenInline(bool b = true) { m_childrenInline = b; }
383     bool hasColumns() const { return m_hasColumns; }
384     void setHasColumns(bool b = true) { m_hasColumns = b; }
385
386     bool inRenderFlowThread() const { return m_inRenderFlowThread; }
387     void setInRenderFlowThread(bool b = true) { m_inRenderFlowThread = b; }
388
389     virtual bool requiresForcedStyleRecalcPropagation() const { return false; }
390
391 #if ENABLE(MATHML)
392     virtual bool isRenderMathMLBlock() const { return false; }
393 #endif // ENABLE(MATHML)
394
395 #if ENABLE(SVG)
396     // FIXME: Until all SVG renders can be subclasses of RenderSVGModelObject we have
397     // to add SVG renderer methods to RenderObject with an ASSERT_NOT_REACHED() default implementation.
398     virtual bool isSVGRoot() const { return false; }
399     virtual bool isSVGContainer() const { return false; }
400     virtual bool isSVGViewportContainer() const { return false; } 
401     virtual bool isSVGGradientStop() const { return false; }
402     virtual bool isSVGHiddenContainer() const { return false; }
403     virtual bool isSVGPath() const { return false; }
404     virtual bool isSVGText() const { return false; }
405     virtual bool isSVGTextPath() const { return false; }
406     virtual bool isSVGInline() const { return false; }
407     virtual bool isSVGInlineText() const { return false; }
408     virtual bool isSVGImage() const { return false; }
409     virtual bool isSVGForeignObject() const { return false; }
410     virtual bool isSVGResourceContainer() const { return false; }
411     virtual bool isSVGResourceFilter() const { return false; }
412     virtual bool isSVGResourceFilterPrimitive() const { return false; }
413     virtual bool isSVGShadowTreeRootContainer() const { return false; }
414
415     virtual RenderSVGResourceContainer* toRenderSVGResourceContainer();
416
417     // FIXME: Those belong into a SVG specific base-class for all renderers (see above)
418     // Unfortunately we don't have such a class yet, because it's not possible for all renderers
419     // to inherit from RenderSVGObject -> RenderObject (some need RenderBlock inheritance for instance)
420     virtual void setNeedsTransformUpdate() { }
421     virtual void setNeedsBoundariesUpdate();
422
423     // Per SVG 1.1 objectBoundingBox ignores clipping, masking, filter effects, opacity and stroke-width.
424     // This is used for all computation of objectBoundingBox relative units and by SVGLocatable::getBBox().
425     // NOTE: Markers are not specifically ignored here by SVG 1.1 spec, but we ignore them
426     // since stroke-width is ignored (and marker size can depend on stroke-width).
427     // objectBoundingBox is returned local coordinates.
428     // The name objectBoundingBox is taken from the SVG 1.1 spec.
429     virtual FloatRect objectBoundingBox() const;
430     virtual FloatRect strokeBoundingBox() const;
431
432     // Returns the smallest rectangle enclosing all of the painted content
433     // respecting clipping, masking, filters, opacity, stroke-width and markers
434     virtual FloatRect repaintRectInLocalCoordinates() const;
435
436     // This only returns the transform="" value from the element
437     // most callsites want localToParentTransform() instead.
438     virtual AffineTransform localTransform() const;
439
440     // Returns the full transform mapping from local coordinates to local coords for the parent SVG renderer
441     // This includes any viewport transforms and x/y offsets as well as the transform="" value off the element.
442     virtual const AffineTransform& localToParentTransform() const;
443
444     // SVG uses FloatPoint precise hit testing, and passes the point in parent
445     // coordinates instead of in repaint container coordinates.  Eventually the
446     // rest of the rendering tree will move to a similar model.
447     virtual bool nodeAtFloatPoint(const HitTestRequest&, HitTestResult&, const FloatPoint& pointInParent, HitTestAction);
448 #endif
449
450     bool isAnonymous() const { return m_isAnonymous; }
451     void setIsAnonymous(bool b) { m_isAnonymous = b; }
452     bool isAnonymousBlock() const
453     {
454         // This function is kept in sync with anonymous block creation conditions in
455         // RenderBlock::createAnonymousBlock(). This includes creating an anonymous
456         // RenderBlock having a BLOCK or BOX display. Other classes such as RenderTextFragment
457         // are not RenderBlocks and will return false. See https://bugs.webkit.org/show_bug.cgi?id=56709. 
458         return m_isAnonymous && (style()->display() == BLOCK || style()->display() == BOX) && style()->styleType() == NOPSEUDO && isRenderBlock() && !isListMarker()
459 #if ENABLE(FULLSCREEN_API)
460             && !isRenderFullScreen()
461             && !isRenderFullScreenPlaceholder()
462 #endif
463             ;
464     }
465     bool isAnonymousColumnsBlock() const { return style()->specifiesColumns() && isAnonymousBlock(); }
466     bool isAnonymousColumnSpanBlock() const { return style()->columnSpan() && isAnonymousBlock(); }
467     bool isElementContinuation() const { return node() && node()->renderer() != this; }
468     bool isInlineElementContinuation() const { return isElementContinuation() && isInline(); }
469     bool isBlockElementContinuation() const { return isElementContinuation() && !isInline(); }
470     virtual RenderBoxModelObject* virtualContinuation() const { return 0; }
471
472     bool isFloating() const { return m_floating; }
473     bool isPositioned() const { return m_positioned; } // absolute or fixed positioning
474     bool isRelPositioned() const { return m_relPositioned; } // relative positioning
475     bool isText() const  { return m_isText; }
476     bool isBox() const { return m_isBox; }
477     bool isInline() const { return m_inline; }  // inline object
478     bool isRunIn() const { return style()->display() == RUN_IN; } // run-in object
479     bool isDragging() const { return m_isDragging; }
480     bool isReplaced() const { return m_replaced; } // a "replaced" element (see CSS)
481     bool isHorizontalWritingMode() const { return m_horizontalWritingMode; }
482
483     bool hasLayer() const { return m_hasLayer; }
484     
485     bool hasBoxDecorations() const { return m_paintBackground; }
486     bool borderImageIsLoadedAndCanBeRendered() const;
487     bool mustRepaintBackgroundOrBorder() const;
488     bool hasBackground() const { return style()->hasBackground(); }
489     bool needsLayout() const { return m_needsLayout || m_normalChildNeedsLayout || m_posChildNeedsLayout || m_needsSimplifiedNormalFlowLayout || m_needsPositionedMovementLayout; }
490     bool selfNeedsLayout() const { return m_needsLayout; }
491     bool needsPositionedMovementLayout() const { return m_needsPositionedMovementLayout; }
492     bool needsPositionedMovementLayoutOnly() const { return m_needsPositionedMovementLayout && !m_needsLayout && !m_normalChildNeedsLayout && !m_posChildNeedsLayout && !m_needsSimplifiedNormalFlowLayout; }
493     bool posChildNeedsLayout() const { return m_posChildNeedsLayout; }
494     bool needsSimplifiedNormalFlowLayout() const { return m_needsSimplifiedNormalFlowLayout; }
495     bool normalChildNeedsLayout() const { return m_normalChildNeedsLayout; }
496     
497     bool preferredLogicalWidthsDirty() const { return m_preferredLogicalWidthsDirty; }
498
499     bool isSelectionBorder() const;
500
501     bool hasClip() const { return isPositioned() && style()->hasClip(); }
502     bool hasOverflowClip() const { return m_hasOverflowClip; }
503
504     bool hasTransform() const { return m_hasTransform; }
505     bool hasMask() const { return style() && style()->hasMask(); }
506
507 #if ENABLE(CSS_FILTERS)
508     bool hasFilter() const { return style() && style()->hasFilter(); }
509 #else
510     bool hasFilter() const { return false; }
511 #endif
512
513     inline bool preservesNewline() const;
514
515 #if !HAVE(PATH_BASED_BORDER_RADIUS_DRAWING)
516     // FIXME: This function should be removed when all ports implement GraphicsContext::clipConvexPolygon()!!
517     // At that time, everyone can use RenderObject::drawBoxSideFromPath() instead. This should happen soon.
518     void drawArcForBoxSide(GraphicsContext*, int x, int y, float thickness, const IntSize& radius, int angleStart,
519                            int angleSpan, BoxSide, Color, EBorderStyle, bool firstCorner);
520 #endif
521
522     // The pseudo element style can be cached or uncached.  Use the cached method if the pseudo element doesn't respect
523     // any pseudo classes (and therefore has no concept of changing state).
524     RenderStyle* getCachedPseudoStyle(PseudoId, RenderStyle* parentStyle = 0) const;
525     PassRefPtr<RenderStyle> getUncachedPseudoStyle(PseudoId, RenderStyle* parentStyle = 0, RenderStyle* ownStyle = 0) const;
526     
527     virtual void updateDragState(bool dragOn);
528
529     RenderView* view() const;
530
531     // Returns true if this renderer is rooted, and optionally returns the hosting view (the root of the hierarchy).
532     bool isRooted(RenderView** = 0);
533
534     Node* node() const { return m_isAnonymous ? 0 : m_node; }
535
536     // Returns the styled node that caused the generation of this renderer.
537     // This is the same as node() except for renderers of :before and :after
538     // pseudo elements for which their parent node is returned.
539     Node* generatingNode() const { return m_node == document() ? 0 : m_node; }
540     void setNode(Node* node) { m_node = node; }
541
542     Document* document() const { return m_node->document(); }
543     Frame* frame() const { return document()->frame(); }
544
545     bool hasOutlineAnnotation() const;
546     bool hasOutline() const { return style()->hasOutline() || hasOutlineAnnotation(); }
547
548     // Returns the object containing this one. Can be different from parent for positioned elements.
549     // If repaintContainer and repaintContainerSkipped are not null, on return *repaintContainerSkipped
550     // is true if the renderer returned is an ancestor of repaintContainer.
551     RenderObject* container(RenderBoxModelObject* repaintContainer = 0, bool* repaintContainerSkipped = 0) const;
552
553     virtual RenderObject* hoverAncestor() const { return parent(); }
554
555     // IE Extension that can be called on any RenderObject.  See the implementation for the details.
556     RenderBoxModelObject* offsetParent() const;
557
558     void markContainingBlocksForLayout(bool scheduleRelayout = true, RenderObject* newRoot = 0);
559     void setNeedsLayout(bool b, bool markParents = true);
560     void setChildNeedsLayout(bool b, bool markParents = true);
561     void setNeedsPositionedMovementLayout();
562     void setNeedsSimplifiedNormalFlowLayout();
563     void setPreferredLogicalWidthsDirty(bool, bool markParents = true);
564     void invalidateContainerPreferredLogicalWidths();
565     
566     void setNeedsLayoutAndPrefWidthsRecalc()
567     {
568         setNeedsLayout(true);
569         setPreferredLogicalWidthsDirty(true);
570     }
571
572     void setPositioned(bool b = true)  { m_positioned = b;  }
573     void setRelPositioned(bool b = true) { m_relPositioned = b; }
574     void setFloating(bool b = true) { m_floating = b; }
575     void setInline(bool b = true) { m_inline = b; }
576     void setHasBoxDecorations(bool b = true) { m_paintBackground = b; }
577     void setIsText() { m_isText = true; }
578     void setIsBox() { m_isBox = true; }
579     void setReplaced(bool b = true) { m_replaced = b; }
580     void setHorizontalWritingMode(bool b = true) { m_horizontalWritingMode = b; }
581     void setHasOverflowClip(bool b = true) { m_hasOverflowClip = b; }
582     void setHasLayer(bool b = true) { m_hasLayer = b; }
583     void setHasTransform(bool b = true) { m_hasTransform = b; }
584     void setHasReflection(bool b = true) { m_hasReflection = b; }
585
586     void scheduleRelayout();
587
588     void updateFillImages(const FillLayer*, const FillLayer*);
589     void updateImage(StyleImage*, StyleImage*);
590
591     virtual void paint(PaintInfo&, const LayoutPoint&);
592
593     // Recursive function that computes the size and position of this object and all its descendants.
594     virtual void layout();
595
596     /* This function performs a layout only if one is needed. */
597     void layoutIfNeeded() { if (needsLayout()) layout(); }
598     
599     // used for element state updates that cannot be fixed with a
600     // repaint and do not need a relayout
601     virtual void updateFromElement() { }
602
603 #if ENABLE(DASHBOARD_SUPPORT)
604     virtual void addDashboardRegions(Vector<DashboardRegionValue>&);
605     void collectDashboardRegions(Vector<DashboardRegionValue>&);
606 #endif
607
608     bool hitTest(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestFilter = HitTestAll);
609     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
610     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&);
611
612     virtual VisiblePosition positionForPoint(const LayoutPoint&);
613     VisiblePosition createVisiblePosition(int offset, EAffinity);
614     VisiblePosition createVisiblePosition(const Position&);
615
616     virtual void dirtyLinesFromChangedChild(RenderObject*);
617
618     // Called to update a style that is allowed to trigger animations.
619     // FIXME: Right now this will typically be called only when updating happens from the DOM on explicit elements.
620     // We don't yet handle generated content animation such as first-letter or before/after (we'll worry about this later).
621     void setAnimatableStyle(PassRefPtr<RenderStyle>);
622
623     // Set the style of the object and update the state of the object accordingly.
624     virtual void setStyle(PassRefPtr<RenderStyle>);
625
626     // Updates only the local style ptr of the object.  Does not update the state of the object,
627     // and so only should be called when the style is known not to have changed (or from setStyle).
628     void setStyleInternal(PassRefPtr<RenderStyle>);
629
630     // returns the containing block level element for this element.
631     RenderBlock* containingBlock() const;
632
633     // Convert the given local point to absolute coordinates
634     // FIXME: Temporary. If useTransforms is true, take transforms into account. Eventually localToAbsolute() will always be transform-aware.
635     FloatPoint localToAbsolute(const FloatPoint& localPoint = FloatPoint(), bool fixed = false, bool useTransforms = false) const;
636     FloatPoint absoluteToLocal(const FloatPoint&, bool fixed = false, bool useTransforms = false) const;
637
638     // Convert a local quad to absolute coordinates, taking transforms into account.
639     FloatQuad localToAbsoluteQuad(const FloatQuad& quad, bool fixed = false, bool* wasFixed = 0) const
640     {
641         return localToContainerQuad(quad, 0, fixed, wasFixed);
642     }
643     // Convert a local quad into the coordinate system of container, taking transforms into account.
644     FloatQuad localToContainerQuad(const FloatQuad&, RenderBoxModelObject* repaintContainer, bool fixed = false, bool* wasFixed = 0) const;
645
646     // Return the offset from the container() renderer (excluding transforms). In multi-column layout,
647     // different offsets apply at different points, so return the offset that applies to the given point.
648     virtual LayoutSize offsetFromContainer(RenderObject*, const LayoutPoint&) const;
649     // Return the offset from an object up the container() chain. Asserts that none of the intermediate objects have transforms.
650     LayoutSize offsetFromAncestorContainer(RenderObject*) const;
651     
652     virtual void absoluteRects(Vector<LayoutRect>&, const LayoutPoint&) const { }
653
654     // FIXME: useTransforms should go away eventually
655     LayoutRect absoluteBoundingBoxRect(bool useTransform = true) const;
656     LayoutRect absoluteBoundingBoxRectIgnoringTransforms() const { return absoluteBoundingBoxRect(false); }
657
658     // Build an array of quads in absolute coords for line boxes
659     virtual void absoluteQuads(Vector<FloatQuad>&, bool* /*wasFixed*/ = 0) const { }
660
661     void absoluteFocusRingQuads(Vector<FloatQuad>&);
662
663     // the rect that will be painted if this object is passed as the paintingRoot
664     LayoutRect paintingRootRect(LayoutRect& topLevelRect);
665
666     virtual LayoutUnit minPreferredLogicalWidth() const { return 0; }
667     virtual LayoutUnit maxPreferredLogicalWidth() const { return 0; }
668
669     RenderStyle* style() const { return m_style.get(); }
670     RenderStyle* firstLineStyle() const { return document()->usesFirstLineRules() ? firstLineStyleSlowCase() : style(); }
671     RenderStyle* style(bool firstLine) const { return firstLine ? firstLineStyle() : style(); }
672
673     // Used only by Element::pseudoStyleCacheIsInvalid to get a first line style based off of a
674     // given new style, without accessing the cache.
675     PassRefPtr<RenderStyle> uncachedFirstLineStyle(RenderStyle*) const;
676
677     // Anonymous blocks that are part of of a continuation chain will return their inline continuation's outline style instead.
678     // This is typically only relevant when repainting.
679     virtual RenderStyle* outlineStyleForRepaint() const { return style(); }
680     
681     virtual CursorDirective getCursor(const LayoutPoint&, Cursor&) const;
682
683     void getTextDecorationColors(int decorations, Color& underline, Color& overline, Color& linethrough, bool quirksMode = false);
684
685     // Return the RenderBox in the container chain which is responsible for painting this object, or 0
686     // if painting is root-relative. This is the container that should be passed to the 'forRepaint'
687     // methods.
688     RenderBoxModelObject* containerForRepaint() const;
689     // Actually do the repaint of rect r for this object which has been computed in the coordinate space
690     // of repaintContainer. If repaintContainer is 0, repaint via the view.
691     void repaintUsingContainer(RenderBoxModelObject* repaintContainer, const LayoutRect&, bool immediate = false);
692     
693     // Repaint the entire object.  Called when, e.g., the color of a border changes, or when a border
694     // style changes.
695     void repaint(bool immediate = false);
696
697     // Repaint a specific subrectangle within a given object.  The rect |r| is in the object's coordinate space.
698     void repaintRectangle(const LayoutRect&, bool immediate = false);
699
700     // Repaint only if our old bounds and new bounds are different. The caller may pass in newBounds and newOutlineBox if they are known.
701     bool repaintAfterLayoutIfNeeded(RenderBoxModelObject* repaintContainer, const LayoutRect& oldBounds, const LayoutRect& oldOutlineBox, const LayoutRect* newBoundsPtr = 0, const LayoutRect* newOutlineBoxPtr = 0);
702
703     // Repaint only if the object moved.
704     virtual void repaintDuringLayoutIfMoved(const LayoutRect&);
705
706     // Called to repaint a block's floats.
707     virtual void repaintOverhangingFloats(bool paintAllDescendants = false);
708
709     bool checkForRepaintDuringLayout() const;
710
711     // Returns the rect that should be repainted whenever this object changes.  The rect is in the view's
712     // coordinate space.  This method deals with outlines and overflow.
713     LayoutRect absoluteClippedOverflowRect() const
714     {
715         return clippedOverflowRectForRepaint(0);
716     }
717     virtual LayoutRect clippedOverflowRectForRepaint(RenderBoxModelObject* repaintContainer) const;
718     virtual LayoutRect rectWithOutlineForRepaint(RenderBoxModelObject* repaintContainer, LayoutUnit outlineWidth) const;
719
720     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
721     // that rect in view coordinates.
722     void computeAbsoluteRepaintRect(LayoutRect& r, bool fixed = false) const
723     {
724         return computeRectForRepaint(0, r, fixed);
725     }
726     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
727     // that rect in the coordinate space of repaintContainer.
728     virtual void computeRectForRepaint(RenderBoxModelObject* repaintContainer, LayoutRect&, bool fixed = false) const;
729
730     // If multiple-column layout results in applying an offset to the given point, add the same
731     // offset to the given size.
732     virtual void adjustForColumns(LayoutSize&, const LayoutPoint&) const { }
733
734     virtual unsigned int length() const { return 1; }
735
736     bool isFloatingOrPositioned() const { return (isFloating() || isPositioned()); }
737
738     bool isTransparent() const { return style()->opacity() < 1.0f; }
739     float opacity() const { return style()->opacity(); }
740
741     bool hasReflection() const { return m_hasReflection; }
742
743     // Applied as a "slop" to dirty rect checks during the outline painting phase's dirty-rect checks.
744     LayoutUnit maximalOutlineSize(PaintPhase) const;
745
746     void setHasMarkupTruncation(bool b = true) { m_hasMarkupTruncation = b; }
747     bool hasMarkupTruncation() const { return m_hasMarkupTruncation; }
748
749     enum SelectionState {
750         SelectionNone, // The object is not selected.
751         SelectionStart, // The object either contains the start of a selection run or is the start of a run
752         SelectionInside, // The object is fully encompassed by a selection run
753         SelectionEnd, // The object either contains the end of a selection run or is the end of a run
754         SelectionBoth // The object contains an entire run or is the sole selected object in that run
755     };
756
757     // The current selection state for an object.  For blocks, the state refers to the state of the leaf
758     // descendants (as described above in the SelectionState enum declaration).
759     SelectionState selectionState() const { return static_cast<SelectionState>(m_selectionState);; }
760
761     // Sets the selection state for an object.
762     virtual void setSelectionState(SelectionState state) { m_selectionState = state; }
763
764     // A single rectangle that encompasses all of the selected objects within this object.  Used to determine the tightest
765     // possible bounding box for the selection.
766     LayoutRect selectionRect(bool clipToVisibleContent = true) { return selectionRectForRepaint(0, clipToVisibleContent); }
767     virtual LayoutRect selectionRectForRepaint(RenderBoxModelObject* /*repaintContainer*/, bool /*clipToVisibleContent*/ = true) { return LayoutRect(); }
768
769     // Whether or not an object can be part of the leaf elements of the selection.
770     virtual bool canBeSelectionLeaf() const { return false; }
771
772     // Whether or not a block has selected children.
773     bool hasSelectedChildren() const { return m_selectionState != SelectionNone; }
774
775     // Obtains the selection colors that should be used when painting a selection.
776     Color selectionBackgroundColor() const;
777     Color selectionForegroundColor() const;
778     Color selectionEmphasisMarkColor() const;
779
780     // Whether or not a given block needs to paint selection gaps.
781     virtual bool shouldPaintSelectionGaps() const { return false; }
782
783     /**
784      * Returns the local coordinates of the caret within this render object.
785      * @param caretOffset zero-based offset determining position within the render object.
786      * @param extraWidthToEndOfLine optional out arg to give extra width to end of line -
787      * useful for character range rect computations
788      */
789     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0);
790
791     bool isMarginBeforeQuirk() const { return m_marginBeforeQuirk; }
792     bool isMarginAfterQuirk() const { return m_marginAfterQuirk; }
793     void setMarginBeforeQuirk(bool b = true) { m_marginBeforeQuirk = b; }
794     void setMarginAfterQuirk(bool b = true) { m_marginAfterQuirk = b; }
795
796     // When performing a global document tear-down, the renderer of the document is cleared.  We use this
797     // as a hook to detect the case of document destruction and don't waste time doing unnecessary work.
798     bool documentBeingDestroyed() const;
799
800     virtual void destroy();
801
802     // Virtual function helpers for the deprecated Flexible Box Layout (display: -webkit-box).
803     virtual bool isDeprecatedFlexibleBox() const { return false; }
804     virtual bool isFlexingChildren() const { return false; }
805     virtual bool isStretchingChildren() const { return false; }
806
807     // Virtual function helper for the new FlexibleBox Layout (display: -webkit-flexbox).
808     virtual bool isFlexibleBox() const { return false; }
809
810     bool isFlexibleBoxIncludingDeprecated() const
811     {
812         return isFlexibleBox() || isDeprecatedFlexibleBox();
813     }
814
815     virtual bool isCombineText() const { return false; }
816
817     virtual int caretMinOffset() const;
818     virtual int caretMaxOffset() const;
819
820     virtual int previousOffset(int current) const;
821     virtual int previousOffsetForBackwardDeletion(int current) const;
822     virtual int nextOffset(int current) const;
823
824     virtual void imageChanged(CachedImage*, const IntRect* = 0);
825     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) { }
826     virtual bool willRenderImage(CachedImage*);
827
828     void selectionStartEnd(int& spos, int& epos) const;
829     
830     void remove() { if (parent()) parent()->removeChild(this); }
831
832     AnimationController* animation() const;
833
834     bool visibleToHitTesting() const { return style()->visibility() == VISIBLE && style()->pointerEvents() != PE_NONE; }
835
836     // Map points and quads through elements, potentially via 3d transforms. You should never need to call these directly; use
837     // localToAbsolute/absoluteToLocal methods instead.
838     virtual void mapLocalToContainer(RenderBoxModelObject* repaintContainer, bool useTransforms, bool fixed, TransformState&, bool* wasFixed = 0) const;
839     virtual void mapAbsoluteToLocalPoint(bool fixed, bool useTransforms, TransformState&) const;
840
841     bool shouldUseTransformFromContainer(const RenderObject* container) const;
842     void getTransformFromContainer(const RenderObject* container, const LayoutSize& offsetInContainer, TransformationMatrix&) const;
843     
844     virtual void addFocusRingRects(Vector<LayoutRect>&, const LayoutPoint&) { };
845
846     LayoutRect absoluteOutlineBounds() const
847     {
848         return outlineBoundsForRepaint(0);
849     }
850
851 protected:
852     // Overrides should call the superclass at the end
853     virtual void styleWillChange(StyleDifference, const RenderStyle* newStyle);
854     // Overrides should call the superclass at the start
855     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
856     void propagateStyleToAnonymousChildren(bool blockChildrenOnly = false);
857
858     void drawLineForBoxSide(GraphicsContext*, LayoutUnit x1, LayoutUnit y1, LayoutUnit x2, LayoutUnit y2, BoxSide,
859                             Color, EBorderStyle, int adjbw1, int adjbw2, bool antialias = false);
860
861     void paintFocusRing(GraphicsContext*, const LayoutPoint&, RenderStyle*);
862     void paintOutline(GraphicsContext*, const LayoutRect&);
863     void addPDFURLRect(GraphicsContext*, const LayoutRect&);
864
865     virtual LayoutRect viewRect() const;
866
867     void adjustRectForOutlineAndShadow(LayoutRect&) const;
868
869     virtual void willBeDestroyed();
870     void arenaDelete(RenderArena*, void* objectBase);
871
872     virtual LayoutRect outlineBoundsForRepaint(RenderBoxModelObject* /*repaintContainer*/, LayoutPoint* /*cachedOffsetToRepaintContainer*/ = 0) const { return LayoutRect(); }
873
874 private:
875     RenderStyle* firstLineStyleSlowCase() const;
876     StyleDifference adjustStyleDifference(StyleDifference, unsigned contextSensitiveProperties) const;
877
878     Color selectionColor(int colorProperty) const;
879     
880     RefPtr<RenderStyle> m_style;
881
882     Node* m_node;
883
884     RenderObject* m_parent;
885     RenderObject* m_previous;
886     RenderObject* m_next;
887
888 #ifndef NDEBUG
889     bool m_hasAXObject;
890     bool m_setNeedsLayoutForbidden : 1;
891 #endif
892
893     // 32 bits have been used here. THERE ARE NO FREE BITS AVAILABLE.
894     bool m_needsLayout               : 1;
895     bool m_needsPositionedMovementLayout :1;
896     bool m_normalChildNeedsLayout    : 1;
897     bool m_posChildNeedsLayout       : 1;
898     bool m_needsSimplifiedNormalFlowLayout  : 1;
899     bool m_preferredLogicalWidthsDirty           : 1;
900     bool m_floating                  : 1;
901
902     bool m_positioned                : 1;
903     bool m_relPositioned             : 1;
904     bool m_paintBackground           : 1; // if the box has something to paint in the
905                                           // background painting phase (background, border, etc)
906
907     bool m_isAnonymous               : 1;
908     bool m_isText                    : 1;
909     bool m_isBox                     : 1;
910     bool m_inline                    : 1;
911     bool m_replaced                  : 1;
912     bool m_horizontalWritingMode : 1;
913     bool m_isDragging                : 1;
914
915     bool m_hasLayer                  : 1;
916     bool m_hasOverflowClip           : 1; // Set in the case of overflow:auto/scroll/hidden
917     bool m_hasTransform              : 1;
918     bool m_hasReflection             : 1;
919     
920 public:
921     bool m_hasCounterNodeMap         : 1;
922     bool m_everHadLayout             : 1;
923
924 private:
925     // These bitfields are moved here from subclasses to pack them together
926     // from RenderBlock
927     bool m_childrenInline : 1;
928     bool m_marginBeforeQuirk : 1;
929     bool m_marginAfterQuirk : 1;
930     bool m_hasMarkupTruncation : 1;
931     unsigned m_selectionState : 3; // SelectionState
932     bool m_hasColumns : 1;
933     bool m_inRenderFlowThread : 1;
934
935 private:
936     // Store state between styleWillChange and styleDidChange
937     static bool s_affectsParentBlock;
938 };
939
940 inline bool RenderObject::documentBeingDestroyed() const
941 {
942     return !document()->renderer();
943 }
944
945 inline bool RenderObject::isBeforeContent() const
946 {
947     if (style()->styleType() != BEFORE)
948         return false;
949     // Text nodes don't have their own styles, so ignore the style on a text node.
950     if (isText() && !isBR())
951         return false;
952     return true;
953 }
954
955 inline bool RenderObject::isAfterContent() const
956 {
957     if (style()->styleType() != AFTER)
958         return false;
959     // Text nodes don't have their own styles, so ignore the style on a text node.
960     if (isText() && !isBR())
961         return false;
962     return true;
963 }
964
965 inline bool RenderObject::isBeforeOrAfterContent() const
966 {
967     return isBeforeContent() || isAfterContent();
968 }
969
970 inline void RenderObject::setNeedsLayout(bool b, bool markParents)
971 {
972     bool alreadyNeededLayout = m_needsLayout;
973     m_needsLayout = b;
974     if (b) {
975         ASSERT(!isSetNeedsLayoutForbidden());
976         if (!alreadyNeededLayout) {
977             if (markParents)
978                 markContainingBlocksForLayout();
979             if (hasLayer())
980                 setLayerNeedsFullRepaint();
981         }
982     } else {
983         m_everHadLayout = true;
984         m_posChildNeedsLayout = false;
985         m_needsSimplifiedNormalFlowLayout = false;
986         m_normalChildNeedsLayout = false;
987         m_needsPositionedMovementLayout = false;
988     }
989 }
990
991 inline void RenderObject::setChildNeedsLayout(bool b, bool markParents)
992 {
993     bool alreadyNeededLayout = m_normalChildNeedsLayout;
994     m_normalChildNeedsLayout = b;
995     if (b) {
996         ASSERT(!isSetNeedsLayoutForbidden());
997         if (!alreadyNeededLayout && markParents)
998             markContainingBlocksForLayout();
999     } else {
1000         m_posChildNeedsLayout = false;
1001         m_needsSimplifiedNormalFlowLayout = false;
1002         m_normalChildNeedsLayout = false;
1003         m_needsPositionedMovementLayout = false;
1004     }
1005 }
1006
1007 inline void RenderObject::setNeedsPositionedMovementLayout()
1008 {
1009     bool alreadyNeededLayout = m_needsPositionedMovementLayout;
1010     m_needsPositionedMovementLayout = true;
1011     ASSERT(!isSetNeedsLayoutForbidden());
1012     if (!alreadyNeededLayout) {
1013         markContainingBlocksForLayout();
1014         if (hasLayer())
1015             setLayerNeedsFullRepaint();
1016     }
1017 }
1018
1019 inline void RenderObject::setNeedsSimplifiedNormalFlowLayout()
1020 {
1021     bool alreadyNeededLayout = m_needsSimplifiedNormalFlowLayout;
1022     m_needsSimplifiedNormalFlowLayout = true;
1023     ASSERT(!isSetNeedsLayoutForbidden());
1024     if (!alreadyNeededLayout) {
1025         markContainingBlocksForLayout();
1026         if (hasLayer())
1027             setLayerNeedsFullRepaint();
1028     }
1029 }
1030
1031 inline bool RenderObject::preservesNewline() const
1032 {
1033 #if ENABLE(SVG)
1034     if (isSVGInlineText())
1035         return false;
1036 #endif
1037         
1038     return style()->preserveNewline();
1039 }
1040
1041 inline void makeMatrixRenderable(TransformationMatrix& matrix, bool has3DRendering)
1042 {
1043 #if !ENABLE(3D_RENDERING)
1044     UNUSED_PARAM(has3DRendering);
1045     matrix.makeAffine();
1046 #else
1047     if (!has3DRendering)
1048         matrix.makeAffine();
1049 #endif
1050 }
1051
1052 inline int adjustForAbsoluteZoom(int value, RenderObject* renderer)
1053 {
1054     return adjustForAbsoluteZoom(value, renderer->style());
1055 }
1056
1057 inline void adjustFloatQuadForAbsoluteZoom(FloatQuad& quad, RenderObject* renderer)
1058 {
1059     float zoom = renderer->style()->effectiveZoom();
1060     if (zoom != 1)
1061         quad.scale(1 / zoom, 1 / zoom);
1062 }
1063
1064 inline void adjustFloatRectForAbsoluteZoom(FloatRect& rect, RenderObject* renderer)
1065 {
1066     float zoom = renderer->style()->effectiveZoom();
1067     if (zoom != 1)
1068         rect.scale(1 / zoom, 1 / zoom);
1069 }
1070
1071 inline void adjustFloatQuadForPageScale(FloatQuad& quad, float pageScale)
1072 {
1073     if (pageScale != 1)
1074         quad.scale(1 / pageScale, 1 / pageScale);
1075 }
1076
1077 inline void adjustFloatRectForPageScale(FloatRect& rect, float pageScale)
1078 {
1079     if (pageScale != 1)
1080         rect.scale(1 / pageScale, 1 / pageScale);
1081 }
1082
1083 } // namespace WebCore
1084
1085 #ifndef NDEBUG
1086 // Outside the WebCore namespace for ease of invocation from gdb.
1087 void showTree(const WebCore::RenderObject*);
1088 void showLineTree(const WebCore::RenderObject*);
1089 void showRenderTree(const WebCore::RenderObject* object1);
1090 // We don't make object2 an optional parameter so that showRenderTree
1091 // can be called from gdb easily.
1092 void showRenderTree(const WebCore::RenderObject* object1, const WebCore::RenderObject* object2);
1093 #endif
1094
1095 #endif // RenderObject_h