Add a "notifyutil" callback for dumping the RenderLayer tree, and move the registrati...
[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, 2012 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 "CachedImageClient.h"
30 #include "Element.h"
31 #include "FloatQuad.h"
32 #include "Frame.h"
33 #include "LayoutRect.h"
34 #include "PaintPhase.h"
35 #include "RenderStyle.h"
36 #include "ScrollBehavior.h"
37 #include "StyleImage.h"
38 #include "TextAffinity.h"
39
40 namespace WebCore {
41
42 class AffineTransform;
43 class AnimationController;
44 class Color;
45 class Cursor;
46 class Document;
47 class HitTestLocation;
48 class HitTestRequest;
49 class HitTestResult;
50 class InlineBox;
51 class Path;
52 class Position;
53 class PseudoStyleRequest;
54 class RenderBoxModelObject;
55 class RenderInline;
56 class RenderBlock;
57 class RenderElement;
58 class RenderFlowThread;
59 class RenderGeometryMap;
60 class RenderLayer;
61 class RenderLayerModelObject;
62 class RenderNamedFlowFragment;
63 class RenderNamedFlowThread;
64 class RenderRegion;
65 class RenderTheme;
66 class SelectionSubtreeRoot;
67 class TransformState;
68 class VisiblePosition;
69
70 #if PLATFORM(IOS)
71 class SelectionRect;
72 #endif
73
74 struct PaintInfo;
75
76 enum CursorDirective {
77     SetCursorBasedOnStyle,
78     SetCursor,
79     DoNotSetCursor
80 };
81
82 enum HitTestFilter {
83     HitTestAll,
84     HitTestSelf,
85     HitTestDescendants
86 };
87
88 enum HitTestAction {
89     HitTestBlockBackground,
90     HitTestChildBlockBackground,
91     HitTestChildBlockBackgrounds,
92     HitTestFloat,
93     HitTestForeground
94 };
95
96 // Sides used when drawing borders and outlines. The values should run clockwise from top.
97 enum BoxSide {
98     BSTop,
99     BSRight,
100     BSBottom,
101     BSLeft
102 };
103
104 enum MarkingBehavior {
105     MarkOnlyThis,
106     MarkContainingBlockChain,
107 };
108
109 enum class ScheduleRelayout { No, Yes };
110
111 enum MapCoordinatesMode {
112     IsFixed             = 1 << 0,
113     UseTransforms       = 1 << 1,
114     ApplyContainerFlip  = 1 << 2
115 };
116 typedef unsigned MapCoordinatesFlags;
117
118 #if PLATFORM(IOS)
119 const int caretWidth = 2; // This value should be kept in sync with UIKit. See <rdar://problem/15580601>.
120 #else
121 const int caretWidth = 1;
122 #endif
123
124 #if ENABLE(DASHBOARD_SUPPORT)
125 struct AnnotatedRegionValue {
126     bool operator==(const AnnotatedRegionValue& o) const
127     {
128         return type == o.type && bounds == o.bounds && clip == o.clip && label == o.label;
129     }
130     bool operator!=(const AnnotatedRegionValue& o) const
131     {
132         return !(*this == o);
133     }
134
135     LayoutRect bounds;
136     String label;
137     LayoutRect clip;
138     int type;
139 };
140 #endif
141
142 // Base class for all rendering tree objects.
143 class RenderObject : public CachedImageClient {
144     WTF_MAKE_FAST_ALLOCATED;
145     friend class RenderBlock;
146     friend class RenderBlockFlow;
147     friend class RenderElement;
148     friend class RenderLayer;
149 public:
150     // Anonymous objects should pass the document as their node, and they will then automatically be
151     // marked as anonymous in the constructor.
152     explicit RenderObject(Node&);
153     virtual ~RenderObject();
154
155     RenderTheme& theme() const;
156
157     virtual const char* renderName() const = 0;
158
159     RenderElement* parent() const { return m_parent; }
160     bool isDescendantOf(const RenderObject*) const;
161
162     RenderObject* previousSibling() const { return m_previous; }
163     RenderObject* nextSibling() const { return m_next; }
164
165     // Use RenderElement versions instead.
166     virtual RenderObject* firstChildSlow() const { return nullptr; }
167     virtual RenderObject* lastChildSlow() const { return nullptr; }
168
169     RenderObject* nextInPreOrder() const;
170     RenderObject* nextInPreOrder(const RenderObject* stayWithin) const;
171     RenderObject* nextInPreOrderAfterChildren() const;
172     RenderObject* nextInPreOrderAfterChildren(const RenderObject* stayWithin) const;
173     RenderObject* previousInPreOrder() const;
174     RenderObject* previousInPreOrder(const RenderObject* stayWithin) const;
175     WEBCORE_EXPORT RenderObject* childAt(unsigned) const;
176
177     RenderObject* firstLeafChild() const;
178     RenderObject* lastLeafChild() const;
179
180 #if ENABLE(IOS_TEXT_AUTOSIZING)
181     // Minimal distance between the block with fixed height and overflowing content and the text block to apply text autosizing.
182     // The greater this constant is the more potential places we have where autosizing is turned off.
183     // So it should be as low as possible. There are sites that break at 2.
184     static const int TextAutoSizingFixedHeightDepth = 3;
185
186     enum BlockContentHeightType {
187         FixedHeight,
188         FlexibleHeight,
189         OverflowHeight
190     };
191
192     RenderObject* traverseNext(const RenderObject* stayWithin) const;
193     typedef bool (*TraverseNextInclusionFunction)(const RenderObject*);
194     typedef BlockContentHeightType (*HeightTypeTraverseNextInclusionFunction)(const RenderObject*);
195
196     RenderObject* traverseNext(const RenderObject* stayWithin, TraverseNextInclusionFunction) const;
197     RenderObject* traverseNext(const RenderObject* stayWithin, HeightTypeTraverseNextInclusionFunction, int& currentDepth,  int& newFixedDepth) const;
198
199     void adjustComputedFontSizesOnBlocks(float size, float visibleWidth);
200     WEBCORE_EXPORT void resetTextAutosizing();
201 #endif
202
203     WEBCORE_EXPORT RenderLayer* enclosingLayer() const;
204
205     // Scrolling is a RenderBox concept, however some code just cares about recursively scrolling our enclosing ScrollableArea(s).
206     WEBCORE_EXPORT bool scrollRectToVisible(const LayoutRect&, const ScrollAlignment& alignX = ScrollAlignment::alignCenterIfNeeded, const ScrollAlignment& alignY = ScrollAlignment::alignCenterIfNeeded);
207
208     // Convenience function for getting to the nearest enclosing box of a RenderObject.
209     RenderBox& enclosingBox() const;
210     RenderBoxModelObject& enclosingBoxModelObject() const;
211
212     bool fixedPositionedWithNamedFlowContainingBlock() const;
213
214     // Function to return our enclosing flow thread if we are contained inside one. This
215     // function follows the containing block chain.
216     RenderFlowThread* flowThreadContainingBlock() const
217     {
218         if (flowThreadState() == NotInsideFlowThread)
219             return nullptr;
220
221         return locateFlowThreadContainingBlock();
222     }
223
224     RenderNamedFlowFragment* currentRenderNamedFlowFragment() const;
225
226     // FIXME: The meaning of this function is unclear.
227     virtual bool isEmpty() const { return !firstChildSlow(); }
228
229 #ifndef NDEBUG
230     void setHasAXObject(bool flag) { m_hasAXObject = flag; }
231     bool hasAXObject() const { return m_hasAXObject; }
232
233     // Helper class forbidding calls to setNeedsLayout() during its lifetime.
234     class SetLayoutNeededForbiddenScope {
235     public:
236         explicit SetLayoutNeededForbiddenScope(RenderObject*, bool isForbidden = true);
237         ~SetLayoutNeededForbiddenScope();
238     private:
239         RenderObject* m_renderObject;
240         bool m_preexistingForbidden;
241     };
242 #endif
243
244     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
245     // children.
246     virtual RenderBlock* firstLineBlock() const;
247     
248     // RenderObject tree manipulation
249     //////////////////////////////////////////
250     virtual bool canHaveChildren() const = 0;
251     virtual bool canHaveGeneratedChildren() const;
252     virtual bool createsAnonymousWrapper() const { return false; }
253     //////////////////////////////////////////
254
255 #if ENABLE(TREE_DEBUGGING)
256     void showNodeTreeForThis() const;
257     void showRenderTreeForThis() const;
258     void showLineTreeForThis() const;
259
260     void showRenderObject(bool mark, int depth) const;
261     void showRenderSubTreeAndMark(const RenderObject* markedObject, int depth) const;
262     void showRegionsInformation() const;
263 #endif
264
265     bool isPseudoElement() const { return node() && node()->isPseudoElement(); }
266
267     bool isRenderElement() const { return !isText(); }
268     bool isRenderReplaced() const;
269     bool isBoxModelObject() const;
270     bool isRenderBlock() const;
271     bool isRenderBlockFlow() const;
272     bool isRenderInline() const;
273     bool isRenderLayerModelObject() const;
274
275     virtual bool isCounter() const { return false; }
276     virtual bool isQuote() const { return false; }
277
278 #if ENABLE(DETAILS_ELEMENT)
279     virtual bool isDetailsMarker() const { return false; }
280 #endif
281     virtual bool isEmbeddedObject() const { return false; }
282     virtual bool isFieldset() const { return false; }
283     virtual bool isFileUploadControl() const { return false; }
284     virtual bool isFrame() const { return false; }
285     virtual bool isFrameSet() const { return false; }
286     virtual bool isImage() const { return false; }
287     virtual bool isInlineBlockOrInlineTable() const { return false; }
288     virtual bool isListBox() const { return false; }
289     virtual bool isListItem() const { return false; }
290     virtual bool isListMarker() const { return false; }
291     virtual bool isMedia() const { return false; }
292     virtual bool isMenuList() const { return false; }
293 #if ENABLE(METER_ELEMENT)
294     virtual bool isMeter() const { return false; }
295 #endif
296     virtual bool isSnapshottedPlugIn() const { return false; }
297     virtual bool isProgress() const { return false; }
298     virtual bool isRenderSVGBlock() const { return false; };
299     virtual bool isRenderButton() const { return false; }
300     virtual bool isRenderIFrame() const { return false; }
301     virtual bool isRenderImage() const { return false; }
302     virtual bool isRenderRegion() const { return false; }
303     virtual bool isRenderNamedFlowFragment() const { return false; }
304     virtual bool isReplica() const { return false; }
305
306     virtual bool isRubyInline() const { return false; }
307     virtual bool isRubyBlock() const { return false; }
308     virtual bool isRubyBase() const { return false; }
309     virtual bool isRubyRun() const { return false; }
310     virtual bool isRubyText() const { return false; }
311
312     virtual bool isSlider() const { return false; }
313     virtual bool isSliderThumb() const { return false; }
314     virtual bool isTable() const { return false; }
315     virtual bool isTableCell() const { return false; }
316     virtual bool isRenderTableCol() const { return false; }
317     virtual bool isTableCaption() const { return false; }
318     virtual bool isTableRow() const { return false; }
319     virtual bool isTableSection() const { return false; }
320     virtual bool isTextControl() const { return false; }
321     virtual bool isTextArea() const { return false; }
322     virtual bool isTextField() const { return false; }
323     virtual bool isTextControlInnerBlock() const { return false; }
324     virtual bool isVideo() const { return false; }
325     virtual bool isWidget() const { return false; }
326     virtual bool isCanvas() const { return false; }
327 #if ENABLE(ATTACHMENT_ELEMENT)
328     virtual bool isAttachment() const { return false; }
329 #endif
330 #if ENABLE(FULLSCREEN_API)
331     virtual bool isRenderFullScreen() const { return false; }
332     virtual bool isRenderFullScreenPlaceholder() const { return false; }
333 #endif
334 #if ENABLE(CSS_GRID_LAYOUT)
335     virtual bool isRenderGrid() const { return false; }
336 #endif
337     virtual bool isRenderNamedFlowThread() const { return false; }
338     bool isInFlowRenderFlowThread() const { return isRenderFlowThread() && !isOutOfFlowPositioned(); }
339     bool isOutOfFlowRenderFlowThread() const { return isRenderFlowThread() && isOutOfFlowPositioned(); }
340
341     virtual bool isMultiColumnBlockFlow() const { return false; }
342     virtual bool isRenderMultiColumnSet() const { return false; }
343     virtual bool isRenderMultiColumnFlowThread() const { return false; }
344     virtual bool isRenderMultiColumnSpannerPlaceholder() const { return false; }
345
346     virtual bool isRenderScrollbarPart() const { return false; }
347
348     bool isDocumentElementRenderer() const { return document().documentElement() == &m_node; }
349     bool isBody() const { return node() && node()->hasTagName(HTMLNames::bodyTag); }
350     bool isHR() const { return node() && node()->hasTagName(HTMLNames::hrTag); }
351     bool isLegend() const;
352
353     bool isHTMLMarquee() const;
354
355     bool isTablePart() const { return isTableCell() || isRenderTableCol() || isTableCaption() || isTableRow() || isTableSection(); }
356
357     inline bool isBeforeContent() const;
358     inline bool isAfterContent() const;
359     inline bool isBeforeOrAfterContent() const;
360     static inline bool isBeforeContent(const RenderObject* obj) { return obj && obj->isBeforeContent(); }
361     static inline bool isAfterContent(const RenderObject* obj) { return obj && obj->isAfterContent(); }
362     static inline bool isBeforeOrAfterContent(const RenderObject* obj) { return obj && obj->isBeforeOrAfterContent(); }
363
364     bool beingDestroyed() const { return m_bitfields.beingDestroyed(); }
365
366     bool everHadLayout() const { return m_bitfields.everHadLayout(); }
367
368     bool childrenInline() const { return m_bitfields.childrenInline(); }
369     void setChildrenInline(bool b) { m_bitfields.setChildrenInline(b); }
370     
371     enum FlowThreadState {
372         NotInsideFlowThread = 0,
373         InsideOutOfFlowThread = 1,
374         InsideInFlowThread = 2,
375     };
376
377     void setFlowThreadStateIncludingDescendants(FlowThreadState);
378
379     FlowThreadState flowThreadState() const { return m_bitfields.flowThreadState(); }
380     void setFlowThreadState(FlowThreadState state) { m_bitfields.setFlowThreadState(state); }
381
382     virtual bool requiresForcedStyleRecalcPropagation() const { return false; }
383
384 #if ENABLE(MATHML)
385     virtual bool isRenderMathMLBlock() const { return false; }
386     virtual bool isRenderMathMLTable() const { return false; }
387     virtual bool isRenderMathMLOperator() const { return false; }
388     virtual bool isRenderMathMLRadicalOperator() const { return false; }
389     virtual bool isRenderMathMLRow() const { return false; }
390     virtual bool isRenderMathMLMath() const { return false; }
391     virtual bool isRenderMathMLMenclose() const { return false; }
392     virtual bool isRenderMathMLFenced() const { return false; }
393     virtual bool isRenderMathMLFraction() const { return false; }
394     virtual bool isRenderMathMLRoot() const { return false; }
395     virtual bool isRenderMathMLRootWrapper() const { return false; }
396     virtual bool isRenderMathMLSpace() const { return false; }
397     virtual bool isRenderMathMLSquareRoot() const { return false; }
398     virtual bool isRenderMathMLScripts() const { return false; }
399     virtual bool isRenderMathMLScriptsWrapper() const { return false; }
400     virtual bool isRenderMathMLToken() const { return false; }
401     virtual bool isRenderMathMLUnderOver() const { return false; }
402 #endif // ENABLE(MATHML)
403
404     // FIXME: Until all SVG renders can be subclasses of RenderSVGModelObject we have
405     // to add SVG renderer methods to RenderObject with an ASSERT_NOT_REACHED() default implementation.
406     virtual bool isRenderSVGModelObject() const { return false; }
407     virtual bool isSVGRoot() const { return false; }
408     virtual bool isSVGContainer() const { return false; }
409     virtual bool isSVGTransformableContainer() const { return false; }
410     virtual bool isSVGViewportContainer() const { return false; }
411     virtual bool isSVGGradientStop() const { return false; }
412     virtual bool isSVGHiddenContainer() const { return false; }
413     virtual bool isSVGPath() const { return false; }
414     virtual bool isSVGShape() const { return false; }
415     virtual bool isSVGText() const { return false; }
416     virtual bool isSVGTextPath() const { return false; }
417     virtual bool isSVGTSpan() const { return false; }
418     virtual bool isSVGInline() const { return false; }
419     virtual bool isSVGInlineText() const { return false; }
420     virtual bool isSVGImage() const { return false; }
421     virtual bool isSVGForeignObject() const { return false; }
422     virtual bool isSVGResourceContainer() const { return false; }
423     virtual bool isSVGResourceFilter() const { return false; }
424     virtual bool isSVGResourceClipper() const { return false; }
425     virtual bool isSVGResourceFilterPrimitive() const { return false; }
426
427     // FIXME: Those belong into a SVG specific base-class for all renderers (see above)
428     // Unfortunately we don't have such a class yet, because it's not possible for all renderers
429     // to inherit from RenderSVGObject -> RenderObject (some need RenderBlock inheritance for instance)
430     virtual void setNeedsTransformUpdate() { }
431     virtual void setNeedsBoundariesUpdate();
432     virtual bool needsBoundariesUpdate() { return false; }
433
434     // Per SVG 1.1 objectBoundingBox ignores clipping, masking, filter effects, opacity and stroke-width.
435     // This is used for all computation of objectBoundingBox relative units and by SVGLocatable::getBBox().
436     // NOTE: Markers are not specifically ignored here by SVG 1.1 spec, but we ignore them
437     // since stroke-width is ignored (and marker size can depend on stroke-width).
438     // objectBoundingBox is returned local coordinates.
439     // The name objectBoundingBox is taken from the SVG 1.1 spec.
440     virtual FloatRect objectBoundingBox() const;
441     virtual FloatRect strokeBoundingBox() const;
442
443     // Returns the smallest rectangle enclosing all of the painted content
444     // respecting clipping, masking, filters, opacity, stroke-width and markers
445     virtual FloatRect repaintRectInLocalCoordinates() const;
446
447     // This only returns the transform="" value from the element
448     // most callsites want localToParentTransform() instead.
449     virtual AffineTransform localTransform() const;
450
451     // Returns the full transform mapping from local coordinates to local coords for the parent SVG renderer
452     // This includes any viewport transforms and x/y offsets as well as the transform="" value off the element.
453     virtual const AffineTransform& localToParentTransform() const;
454
455     // SVG uses FloatPoint precise hit testing, and passes the point in parent
456     // coordinates instead of in repaint container coordinates.  Eventually the
457     // rest of the rendering tree will move to a similar model.
458     virtual bool nodeAtFloatPoint(const HitTestRequest&, HitTestResult&, const FloatPoint& pointInParent, HitTestAction);
459
460     bool hasAspectRatio() const { return isReplaced() && (isImage() || isVideo() || isCanvas()); }
461     bool isAnonymous() const { return m_bitfields.isAnonymous(); }
462     bool isAnonymousBlock() const
463     {
464         // This function is kept in sync with anonymous block creation conditions in
465         // RenderBlock::createAnonymousBlock(). This includes creating an anonymous
466         // RenderBlock having a BLOCK or BOX display. Other classes such as RenderTextFragment
467         // are not RenderBlocks and will return false. See https://bugs.webkit.org/show_bug.cgi?id=56709. 
468         return isAnonymous() && (style().display() == BLOCK || style().display() == BOX) && style().styleType() == NOPSEUDO && isRenderBlock() && !isListMarker() && !isRenderFlowThread() && !isRenderMultiColumnSet() && !isRenderView()
469 #if ENABLE(FULLSCREEN_API)
470             && !isRenderFullScreen()
471             && !isRenderFullScreenPlaceholder()
472 #endif
473 #if ENABLE(MATHML)
474             && !isRenderMathMLBlock()
475 #endif
476             ;
477     }
478     bool isAnonymousInlineBlock() const;
479     bool isElementContinuation() const { return node() && node()->renderer() != this; }
480     bool isInlineElementContinuation() const { return isElementContinuation() && isInline(); }
481     bool isBlockElementContinuation() const { return isElementContinuation() && !isInline(); }
482     virtual RenderBoxModelObject* virtualContinuation() const { return nullptr; }
483
484     bool isFloating() const { return m_bitfields.floating(); }
485
486     bool isOutOfFlowPositioned() const { return m_bitfields.isOutOfFlowPositioned(); } // absolute or fixed positioning
487     bool isInFlowPositioned() const { return m_bitfields.isRelPositioned() || m_bitfields.isStickyPositioned(); } // relative or sticky positioning
488     bool isRelPositioned() const { return m_bitfields.isRelPositioned(); } // relative positioning
489     bool isStickyPositioned() const { return m_bitfields.isStickyPositioned(); }
490     bool isPositioned() const { return m_bitfields.isPositioned(); }
491
492     bool isText() const  { return !m_bitfields.isBox() && m_bitfields.isTextOrRenderView(); }
493     bool isLineBreak() const { return m_bitfields.isLineBreak(); }
494     bool isBR() const { return isLineBreak() && !isWBR(); }
495     bool isLineBreakOpportunity() const { return isLineBreak() && isWBR(); }
496     bool isTextOrLineBreak() const { return isText() || isLineBreak(); }
497     bool isBox() const { return m_bitfields.isBox(); }
498     bool isRenderView() const  { return m_bitfields.isBox() && m_bitfields.isTextOrRenderView(); }
499     bool isInline() const { return m_bitfields.isInline(); } // inline object
500     bool isReplaced() const { return m_bitfields.isReplaced(); } // a "replaced" element (see CSS)
501     bool isHorizontalWritingMode() const { return m_bitfields.horizontalWritingMode(); }
502
503     bool isDragging() const { return m_bitfields.hasRareData() && rareData().isDragging(); }
504     bool hasReflection() const { return m_bitfields.hasRareData() && rareData().hasReflection(); }
505     bool isRenderFlowThread() const { return m_bitfields.hasRareData() && rareData().isRenderFlowThread(); }
506     bool hasOutlineAutoAncestor() const { return m_bitfields.hasRareData() && rareData().hasOutlineAutoAncestor(); }
507     bool isRegisteredForVisibleInViewportCallback() { return m_bitfields.hasRareData() && rareData().isRegisteredForVisibleInViewportCallback(); }
508
509     enum VisibleInViewportState {
510         VisibilityUnknown,
511         VisibleInViewport,
512         NotVisibleInViewport,
513     };
514     VisibleInViewportState visibleInViewportState() { return m_bitfields.hasRareData() ? rareData().visibleInViewportState() : VisibilityUnknown; }
515
516     bool hasLayer() const { return m_bitfields.hasLayer(); }
517
518     enum BoxDecorationState {
519         NoBoxDecorations,
520         HasBoxDecorationsAndBackgroundObscurationStatusInvalid,
521         HasBoxDecorationsAndBackgroundIsKnownToBeObscured,
522         HasBoxDecorationsAndBackgroundMayBeVisible,
523     };
524     bool hasBoxDecorations() const { return m_bitfields.boxDecorationState() != NoBoxDecorations; }
525     bool backgroundIsKnownToBeObscured(const LayoutPoint& paintOffset);
526     bool hasEntirelyFixedBackground() const;
527
528     bool needsLayout() const
529     {
530         return m_bitfields.needsLayout() || m_bitfields.normalChildNeedsLayout() || m_bitfields.posChildNeedsLayout()
531             || m_bitfields.needsSimplifiedNormalFlowLayout() || m_bitfields.needsPositionedMovementLayout();
532     }
533
534     bool selfNeedsLayout() const { return m_bitfields.needsLayout(); }
535     bool needsPositionedMovementLayout() const { return m_bitfields.needsPositionedMovementLayout(); }
536     bool needsPositionedMovementLayoutOnly() const
537     {
538         return m_bitfields.needsPositionedMovementLayout() && !m_bitfields.needsLayout() && !m_bitfields.normalChildNeedsLayout()
539             && !m_bitfields.posChildNeedsLayout() && !m_bitfields.needsSimplifiedNormalFlowLayout();
540     }
541
542     bool posChildNeedsLayout() const { return m_bitfields.posChildNeedsLayout(); }
543     bool needsSimplifiedNormalFlowLayout() const { return m_bitfields.needsSimplifiedNormalFlowLayout(); }
544     bool normalChildNeedsLayout() const { return m_bitfields.normalChildNeedsLayout(); }
545     
546     bool preferredLogicalWidthsDirty() const { return m_bitfields.preferredLogicalWidthsDirty(); }
547
548     bool isSelectionBorder() const;
549
550     bool hasOverflowClip() const { return m_bitfields.hasOverflowClip(); }
551
552     bool hasTransformRelatedProperty() const { return m_bitfields.hasTransformRelatedProperty(); } // Transform, perspective or transform-style: preserve-3d.
553     bool hasTransform() const { return hasTransformRelatedProperty() && style().hasTransform(); }
554
555     inline bool preservesNewline() const;
556
557     virtual void updateDragState(bool dragOn);
558
559     RenderView& view() const { return *document().renderView(); };
560
561     // Returns true if this renderer is rooted.
562     bool isRooted() const;
563
564     Node* node() const { return isAnonymous() ? nullptr : &m_node; }
565     Node* nonPseudoNode() const { return isPseudoElement() ? nullptr : node(); }
566
567     // Returns the styled node that caused the generation of this renderer.
568     // This is the same as node() except for renderers of :before and :after
569     // pseudo elements for which their parent node is returned.
570     Node* generatingNode() const { return isPseudoElement() ? generatingPseudoHostElement() : node(); }
571
572     Document& document() const { return m_node.document(); }
573     Frame& frame() const;
574
575     bool hasOutlineAnnotation() const;
576     bool hasOutline() const { return style().hasOutline() || hasOutlineAnnotation(); }
577
578     // Returns the object containing this one. Can be different from parent for positioned elements.
579     // If repaintContainer and repaintContainerSkipped are not null, on return *repaintContainerSkipped
580     // is true if the renderer returned is an ancestor of repaintContainer.
581     RenderElement* container(const RenderLayerModelObject* repaintContainer = nullptr, bool* repaintContainerSkipped = nullptr) const;
582
583     RenderBoxModelObject* offsetParent() const;
584
585     void markContainingBlocksForLayout(ScheduleRelayout = ScheduleRelayout::Yes, RenderElement* newRoot = nullptr);
586     void setNeedsLayout(MarkingBehavior = MarkContainingBlockChain);
587     void clearNeedsLayout();
588     void setPreferredLogicalWidthsDirty(bool, MarkingBehavior = MarkContainingBlockChain);
589     void invalidateContainerPreferredLogicalWidths();
590     
591     void setNeedsLayoutAndPrefWidthsRecalc()
592     {
593         setNeedsLayout();
594         setPreferredLogicalWidthsDirty(true);
595     }
596
597     void setPositionState(EPosition position)
598     {
599         ASSERT((position != AbsolutePosition && position != FixedPosition) || isBox());
600         m_bitfields.setPositionedState(position);
601     }
602     void clearPositionedState() { m_bitfields.clearPositionedState(); }
603
604     void setFloating(bool b = true) { m_bitfields.setFloating(b); }
605     void setInline(bool b = true) { m_bitfields.setIsInline(b); }
606
607     void setHasBoxDecorations(bool = true);
608     void invalidateBackgroundObscurationStatus();
609     virtual bool computeBackgroundIsKnownToBeObscured(const LayoutPoint&) { return false; }
610
611     void setIsText() { ASSERT(!isBox()); m_bitfields.setIsTextOrRenderView(true); }
612     void setIsLineBreak() { m_bitfields.setIsLineBreak(true); }
613     void setIsBox() { m_bitfields.setIsBox(true); }
614     void setIsRenderView() { ASSERT(isBox()); m_bitfields.setIsTextOrRenderView(true); }
615     void setReplaced(bool b = true) { m_bitfields.setIsReplaced(b); }
616     void setHorizontalWritingMode(bool b = true) { m_bitfields.setHorizontalWritingMode(b); }
617     void setHasOverflowClip(bool b = true) { m_bitfields.setHasOverflowClip(b); }
618     void setHasLayer(bool b = true) { m_bitfields.setHasLayer(b); }
619     void setHasTransformRelatedProperty(bool b = true) { m_bitfields.setHasTransformRelatedProperty(b); }
620
621     void setIsDragging(bool);
622     void setHasReflection(bool = true);
623     void setIsRenderFlowThread(bool = true);
624     void setHasOutlineAutoAncestor(bool = true);
625     void setIsRegisteredForVisibleInViewportCallback(bool);
626     void setVisibleInViewportState(VisibleInViewportState);
627
628     // Hook so that RenderTextControl can return the line height of its inner renderer.
629     // For other renderers, the value is the same as lineHeight(false).
630     virtual int innerLineHeight() const;
631
632     // used for element state updates that cannot be fixed with a
633     // repaint and do not need a relayout
634     virtual void updateFromElement() { }
635
636 #if ENABLE(DASHBOARD_SUPPORT)
637     virtual void addAnnotatedRegions(Vector<AnnotatedRegionValue>&);
638     void collectAnnotatedRegions(Vector<AnnotatedRegionValue>&);
639 #endif
640
641     bool isComposited() const;
642
643     bool hitTest(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestFilter = HitTestAll);
644     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&);
645     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
646
647     virtual VisiblePosition positionForPoint(const LayoutPoint&, const RenderRegion*);
648     VisiblePosition createVisiblePosition(int offset, EAffinity) const;
649     VisiblePosition createVisiblePosition(const Position&) const;
650
651     // returns the containing block level element for this element.
652     RenderBlock* containingBlock() const;
653
654     // Convert the given local point to absolute coordinates. If MapCoordinatesFlags includes UseTransforms, take transforms into account.
655     WEBCORE_EXPORT FloatPoint localToAbsolute(const FloatPoint& localPoint = FloatPoint(), MapCoordinatesFlags = 0, bool* wasFixed = nullptr) const;
656     FloatPoint absoluteToLocal(const FloatPoint&, MapCoordinatesFlags = 0) const;
657
658     // Convert a local quad to absolute coordinates, taking transforms into account.
659     FloatQuad localToAbsoluteQuad(const FloatQuad& quad, MapCoordinatesFlags mode = UseTransforms, bool* wasFixed = nullptr) const
660     {
661         return localToContainerQuad(quad, nullptr, mode, wasFixed);
662     }
663     // Convert an absolute quad to local coordinates.
664     FloatQuad absoluteToLocalQuad(const FloatQuad&, MapCoordinatesFlags mode = UseTransforms) const;
665
666     // Convert a local quad into the coordinate system of container, taking transforms into account.
667     WEBCORE_EXPORT FloatQuad localToContainerQuad(const FloatQuad&, const RenderLayerModelObject* repaintContainer, MapCoordinatesFlags = UseTransforms, bool* wasFixed = nullptr) const;
668     WEBCORE_EXPORT FloatPoint localToContainerPoint(const FloatPoint&, const RenderLayerModelObject* repaintContainer, MapCoordinatesFlags = UseTransforms, bool* wasFixed = nullptr) const;
669
670     // Return the offset from the container() renderer (excluding transforms). In multi-column layout,
671     // different offsets apply at different points, so return the offset that applies to the given point.
672     virtual LayoutSize offsetFromContainer(RenderElement&, const LayoutPoint&, bool* offsetDependsOnPoint = nullptr) const;
673     // Return the offset from an object up the container() chain. Asserts that none of the intermediate objects have transforms.
674     LayoutSize offsetFromAncestorContainer(RenderElement&) const;
675
676 #if PLATFORM(IOS)
677     virtual void collectSelectionRects(Vector<SelectionRect>&, unsigned startOffset = 0, unsigned endOffset = std::numeric_limits<unsigned>::max());
678     virtual void absoluteQuadsForSelection(Vector<FloatQuad>& quads) const { absoluteQuads(quads); }
679 #endif
680
681     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint&) const { }
682
683     // FIXME: useTransforms should go away eventually
684     WEBCORE_EXPORT IntRect absoluteBoundingBoxRect(bool useTransform = true, bool* wasFixed = nullptr) const;
685     IntRect absoluteBoundingBoxRectIgnoringTransforms() const { return absoluteBoundingBoxRect(false); }
686
687     // Build an array of quads in absolute coords for line boxes
688     virtual void absoluteQuads(Vector<FloatQuad>&, bool* /*wasFixed*/ = nullptr) const { }
689
690     virtual void absoluteFocusRingQuads(Vector<FloatQuad>&);
691
692     static FloatRect absoluteBoundingBoxRectForRange(const Range*);
693
694     // the rect that will be painted if this object is passed as the paintingRoot
695     WEBCORE_EXPORT LayoutRect paintingRootRect(LayoutRect& topLevelRect);
696
697     virtual LayoutUnit minPreferredLogicalWidth() const { return 0; }
698     virtual LayoutUnit maxPreferredLogicalWidth() const { return 0; }
699
700     RenderStyle& style() const;
701     RenderStyle& firstLineStyle() const;
702
703     // Anonymous blocks that are part of of a continuation chain will return their inline continuation's outline style instead.
704     // This is typically only relevant when repainting.
705     virtual const RenderStyle& outlineStyleForRepaint() const { return style(); }
706     
707     virtual CursorDirective getCursor(const LayoutPoint&, Cursor&) const;
708
709     void getTextDecorationColorsAndStyles(int decorations, Color& underlineColor, Color& overlineColor, Color& linethroughColor,
710         TextDecorationStyle& underlineStyle, TextDecorationStyle& overlineStyle, TextDecorationStyle& linethroughStyle, bool firstlineStyle = false) const;
711
712     // Return the RenderLayerModelObject in the container chain which is responsible for painting this object, or nullptr
713     // if painting is root-relative. This is the container that should be passed to the 'forRepaint'
714     // methods.
715     RenderLayerModelObject* containerForRepaint() const;
716     // Actually do the repaint of rect r for this object which has been computed in the coordinate space
717     // of repaintContainer. If repaintContainer is nullptr, repaint via the view.
718     void repaintUsingContainer(const RenderLayerModelObject* repaintContainer, const LayoutRect&, bool shouldClipToLayer = true) const;
719     
720     // Repaint the entire object.  Called when, e.g., the color of a border changes, or when a border
721     // style changes.
722     void repaint() const;
723
724     // Repaint a specific subrectangle within a given object.  The rect |r| is in the object's coordinate space.
725     WEBCORE_EXPORT void repaintRectangle(const LayoutRect&, bool shouldClipToLayer = true) const;
726
727     // Repaint a slow repaint object, which, at this time, means we are repainting an object with background-attachment:fixed.
728     void repaintSlowRepaintObject() const;
729
730     bool checkForRepaintDuringLayout() const;
731
732     // Returns the rect that should be repainted whenever this object changes.  The rect is in the view's
733     // coordinate space.  This method deals with outlines and overflow.
734     LayoutRect absoluteClippedOverflowRect() const
735     {
736         return clippedOverflowRectForRepaint(nullptr);
737     }
738     WEBCORE_EXPORT IntRect pixelSnappedAbsoluteClippedOverflowRect() const;
739     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const;
740     virtual LayoutRect rectWithOutlineForRepaint(const RenderLayerModelObject* repaintContainer, LayoutUnit outlineWidth) const;
741     virtual LayoutRect outlineBoundsForRepaint(const RenderLayerModelObject* /*repaintContainer*/, const RenderGeometryMap* = nullptr) const { return LayoutRect(); }
742
743     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
744     // that rect in view coordinates.
745     LayoutRect computeAbsoluteRepaintRect(const LayoutRect& r, bool fixed = false) const
746     {
747         return computeRectForRepaint(r, nullptr, fixed);
748     }
749     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
750     // that rect in the coordinate space of repaintContainer.
751     virtual LayoutRect computeRectForRepaint(const LayoutRect&, const RenderLayerModelObject* repaintContainer, bool fixed = false) const;
752     virtual FloatRect computeFloatRectForRepaint(const FloatRect&, const RenderLayerModelObject* repaintContainer, bool fixed = false) const;
753
754     virtual unsigned int length() const { return 1; }
755
756     bool isFloatingOrOutOfFlowPositioned() const { return (isFloating() || isOutOfFlowPositioned()); }
757
758     enum SelectionState {
759         SelectionNone, // The object is not selected.
760         SelectionStart, // The object either contains the start of a selection run or is the start of a run
761         SelectionInside, // The object is fully encompassed by a selection run
762         SelectionEnd, // The object either contains the end of a selection run or is the end of a run
763         SelectionBoth // The object contains an entire run or is the sole selected object in that run
764     };
765
766     // The current selection state for an object.  For blocks, the state refers to the state of the leaf
767     // descendants (as described above in the SelectionState enum declaration).
768     SelectionState selectionState() const { return m_bitfields.selectionState(); }
769     virtual void setSelectionState(SelectionState state) { m_bitfields.setSelectionState(state); }
770     inline void setSelectionStateIfNeeded(SelectionState);
771     bool canUpdateSelectionOnRootLineBoxes();
772
773     // A single rectangle that encompasses all of the selected objects within this object.  Used to determine the tightest
774     // possible bounding box for the selection.
775     LayoutRect selectionRect(bool clipToVisibleContent = true) { return selectionRectForRepaint(nullptr, clipToVisibleContent); }
776     virtual LayoutRect selectionRectForRepaint(const RenderLayerModelObject* /*repaintContainer*/, bool /*clipToVisibleContent*/ = true) { return LayoutRect(); }
777
778     virtual bool canBeSelectionLeaf() const { return false; }
779     bool hasSelectedChildren() const { return selectionState() != SelectionNone; }
780
781     // Whether or not a given block needs to paint selection gaps.
782     virtual bool shouldPaintSelectionGaps() const { return false; }
783
784     /**
785      * Returns the local coordinates of the caret within this render object.
786      * @param caretOffset zero-based offset determining position within the render object.
787      * @param extraWidthToEndOfLine optional out arg to give extra width to end of line -
788      * useful for character range rect computations
789      */
790     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = nullptr);
791
792     // When performing a global document tear-down, the renderer of the document is cleared.  We use this
793     // as a hook to detect the case of document destruction and don't waste time doing unnecessary work.
794     bool documentBeingDestroyed() const;
795
796     void destroyAndCleanupAnonymousWrappers();
797     void destroy();
798
799     // Virtual function helpers for the deprecated Flexible Box Layout (display: -webkit-box).
800     virtual bool isDeprecatedFlexibleBox() const { return false; }
801
802     // Virtual function helper for the new FlexibleBox Layout (display: -webkit-flex).
803     virtual bool isFlexibleBox() const { return false; }
804
805     bool isFlexibleBoxIncludingDeprecated() const
806     {
807         return isFlexibleBox() || isDeprecatedFlexibleBox();
808     }
809
810     virtual bool isCombineText() const { return false; }
811
812     virtual int caretMinOffset() const;
813     virtual int caretMaxOffset() const;
814
815     virtual int previousOffset(int current) const;
816     virtual int previousOffsetForBackwardDeletion(int current) const;
817     virtual int nextOffset(int current) const;
818
819     void imageChanged(CachedImage*, const IntRect* = nullptr) override;
820     virtual void imageChanged(WrappedImagePtr, const IntRect* = nullptr) { }
821
822     SelectionSubtreeRoot& selectionRoot() const;
823     void selectionStartEnd(int& spos, int& epos) const;
824     
825     void removeFromParent();
826
827     AnimationController& animation() const;
828
829     // Map points and quads through elements, potentially via 3d transforms. You should never need to call these directly; use
830     // localToAbsolute/absoluteToLocal methods instead.
831     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags, bool* wasFixed = nullptr) const;
832     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const;
833
834     // Pushes state onto RenderGeometryMap about how to map coordinates from this renderer to its container, or ancestorToStopAt (whichever is encountered first).
835     // Returns the renderer which was mapped to (container or ancestorToStopAt).
836     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const;
837     
838     bool shouldUseTransformFromContainer(const RenderObject* container) const;
839     void getTransformFromContainer(const RenderObject* container, const LayoutSize& offsetInContainer, TransformationMatrix&) const;
840     
841     virtual void addFocusRingRects(Vector<LayoutRect>&, const LayoutPoint& /* additionalOffset */, const RenderLayerModelObject* /* paintContainer */ = nullptr) { };
842
843     LayoutRect absoluteOutlineBounds() const
844     {
845         return outlineBoundsForRepaint(nullptr);
846     }
847
848     RespectImageOrientationEnum shouldRespectImageOrientation() const;
849
850 protected:
851     //////////////////////////////////////////
852     // Helper functions. Dangerous to use!
853     void setPreviousSibling(RenderObject* previous) { m_previous = previous; }
854     void setNextSibling(RenderObject* next) { m_next = next; }
855     void setParent(RenderElement*);
856     //////////////////////////////////////////
857     void addPDFURLRect(PaintInfo&, const LayoutPoint&);
858     Node& nodeForNonAnonymous() const { ASSERT(!isAnonymous()); return m_node; }
859
860     void adjustRectForOutlineAndShadow(LayoutRect&) const;
861
862     virtual void willBeDestroyed();
863
864     virtual void insertedIntoTree();
865     virtual void willBeRemovedFromTree();
866
867     void setNeedsPositionedMovementLayoutBit(bool b) { m_bitfields.setNeedsPositionedMovementLayout(b); }
868     void setNormalChildNeedsLayoutBit(bool b) { m_bitfields.setNormalChildNeedsLayout(b); }
869     void setPosChildNeedsLayoutBit(bool b) { m_bitfields.setPosChildNeedsLayout(b); }
870     void setNeedsSimplifiedNormalFlowLayoutBit(bool b) { m_bitfields.setNeedsSimplifiedNormalFlowLayout(b); }
871
872     virtual RenderFlowThread* locateFlowThreadContainingBlock() const;
873     void invalidateFlowThreadContainingBlockIncludingDescendants(RenderFlowThread* = nullptr);
874     static void calculateBorderStyleColor(const EBorderStyle&, const BoxSide&, Color&);
875
876 private:
877 #ifndef NDEBUG
878     bool isSetNeedsLayoutForbidden() const { return m_setNeedsLayoutForbidden; }
879     void setNeedsLayoutIsForbidden(bool flag) { m_setNeedsLayoutForbidden = flag; }
880 #endif
881
882     void addAbsoluteRectForLayer(LayoutRect& result);
883     void setLayerNeedsFullRepaint();
884     void setLayerNeedsFullRepaintForPositionedMovementLayout();
885
886     void removeFromRenderFlowThread();
887     void removeFromRenderFlowThreadIncludingDescendants(bool);
888     Node* generatingPseudoHostElement() const;
889
890     void propagateRepaintToParentWithOutlineAutoIfNeeded(const RenderLayerModelObject& repaintContainer, const LayoutRect& repaintRect) const;
891
892     virtual bool isWBR() const { ASSERT_NOT_REACHED(); return false; }
893
894     void setEverHadLayout(bool b) { m_bitfields.setEverHadLayout(b); }
895
896     bool hasRareData() const { return m_bitfields.hasRareData(); }
897     void setHasRareData(bool b) { m_bitfields.setHasRareData(b); }
898
899 #ifndef NDEBUG
900     void checkBlockPositionedObjectsNeedLayout();
901 #endif
902
903     Node& m_node;
904
905     RenderElement* m_parent;
906     RenderObject* m_previous;
907     RenderObject* m_next;
908
909 #ifndef NDEBUG
910     bool m_hasAXObject             : 1;
911     bool m_setNeedsLayoutForbidden : 1;
912 #endif
913
914 #define ADD_BOOLEAN_BITFIELD(name, Name) \
915     private:\
916         unsigned m_##name : 1;\
917     public:\
918         bool name() const { return m_##name; }\
919         void set##Name(bool name) { m_##name = name; }\
920
921 #define ADD_ENUM_BITFIELD(name, Name, Type, width) \
922     private:\
923         unsigned m_##name : width;\
924     public:\
925         Type name() const { return static_cast<Type>(m_##name); }\
926         void set##Name(Type name) { m_##name = static_cast<unsigned>(name); }\
927
928     class RenderObjectBitfields {
929         enum PositionedState {
930             IsStaticallyPositioned = 0,
931             IsRelativelyPositioned = 1,
932             IsOutOfFlowPositioned = 2,
933             IsStickyPositioned = 3
934         };
935
936     public:
937         RenderObjectBitfields(const Node& node)
938             : m_hasRareData(false)
939             , m_beingDestroyed(false)
940             , m_needsLayout(false)
941             , m_needsPositionedMovementLayout(false)
942             , m_normalChildNeedsLayout(false)
943             , m_posChildNeedsLayout(false)
944             , m_needsSimplifiedNormalFlowLayout(false)
945             , m_preferredLogicalWidthsDirty(false)
946             , m_floating(false)
947             , m_isAnonymous(node.isDocumentNode())
948             , m_isTextOrRenderView(false)
949             , m_isBox(false)
950             , m_isInline(true)
951             , m_isReplaced(false)
952             , m_isLineBreak(false)
953             , m_horizontalWritingMode(true)
954             , m_hasLayer(false)
955             , m_hasOverflowClip(false)
956             , m_hasTransformRelatedProperty(false)
957             , m_everHadLayout(false)
958             , m_childrenInline(false)
959             , m_positionedState(IsStaticallyPositioned)
960             , m_selectionState(SelectionNone)
961             , m_flowThreadState(NotInsideFlowThread)
962             , m_boxDecorationState(NoBoxDecorations)
963         {
964         }
965
966         ADD_BOOLEAN_BITFIELD(hasRareData, HasRareData);
967         
968         ADD_BOOLEAN_BITFIELD(beingDestroyed, BeingDestroyed);
969         ADD_BOOLEAN_BITFIELD(needsLayout, NeedsLayout);
970         ADD_BOOLEAN_BITFIELD(needsPositionedMovementLayout, NeedsPositionedMovementLayout);
971         ADD_BOOLEAN_BITFIELD(normalChildNeedsLayout, NormalChildNeedsLayout);
972         ADD_BOOLEAN_BITFIELD(posChildNeedsLayout, PosChildNeedsLayout);
973         ADD_BOOLEAN_BITFIELD(needsSimplifiedNormalFlowLayout, NeedsSimplifiedNormalFlowLayout);
974         ADD_BOOLEAN_BITFIELD(preferredLogicalWidthsDirty, PreferredLogicalWidthsDirty);
975         ADD_BOOLEAN_BITFIELD(floating, Floating);
976
977         ADD_BOOLEAN_BITFIELD(isAnonymous, IsAnonymous);
978         ADD_BOOLEAN_BITFIELD(isTextOrRenderView, IsTextOrRenderView);
979         ADD_BOOLEAN_BITFIELD(isBox, IsBox);
980         ADD_BOOLEAN_BITFIELD(isInline, IsInline);
981         ADD_BOOLEAN_BITFIELD(isReplaced, IsReplaced);
982         ADD_BOOLEAN_BITFIELD(isLineBreak, IsLineBreak);
983         ADD_BOOLEAN_BITFIELD(horizontalWritingMode, HorizontalWritingMode);
984
985         ADD_BOOLEAN_BITFIELD(hasLayer, HasLayer);
986         ADD_BOOLEAN_BITFIELD(hasOverflowClip, HasOverflowClip); // Set in the case of overflow:auto/scroll/hidden
987         ADD_BOOLEAN_BITFIELD(hasTransformRelatedProperty, HasTransformRelatedProperty);
988         ADD_BOOLEAN_BITFIELD(unused, Unused);
989
990         ADD_BOOLEAN_BITFIELD(everHadLayout, EverHadLayout);
991
992         // from RenderBlock
993         ADD_BOOLEAN_BITFIELD(childrenInline, ChildrenInline);
994
995     private:
996         unsigned m_positionedState : 2; // PositionedState
997         unsigned m_selectionState : 3; // SelectionState
998         unsigned m_flowThreadState : 2; // FlowThreadState
999         unsigned m_boxDecorationState : 2; // BoxDecorationState
1000
1001     public:
1002         bool isOutOfFlowPositioned() const { return m_positionedState == IsOutOfFlowPositioned; }
1003         bool isRelPositioned() const { return m_positionedState == IsRelativelyPositioned; }
1004         bool isStickyPositioned() const { return m_positionedState == IsStickyPositioned; }
1005         bool isPositioned() const { return m_positionedState != IsStaticallyPositioned; }
1006
1007         void setPositionedState(int positionState)
1008         {
1009             // This mask maps FixedPosition and AbsolutePosition to IsOutOfFlowPositioned, saving one bit.
1010             m_positionedState = static_cast<PositionedState>(positionState & 0x3);
1011         }
1012         void clearPositionedState() { m_positionedState = StaticPosition; }
1013
1014         ALWAYS_INLINE SelectionState selectionState() const { return static_cast<SelectionState>(m_selectionState); }
1015         ALWAYS_INLINE void setSelectionState(SelectionState selectionState) { m_selectionState = selectionState; }
1016         
1017         ALWAYS_INLINE FlowThreadState flowThreadState() const { return static_cast<FlowThreadState>(m_flowThreadState); }
1018         ALWAYS_INLINE void setFlowThreadState(FlowThreadState flowThreadState) { m_flowThreadState = flowThreadState; }
1019
1020         ALWAYS_INLINE BoxDecorationState boxDecorationState() const { return static_cast<BoxDecorationState>(m_boxDecorationState); }
1021         ALWAYS_INLINE void setBoxDecorationState(BoxDecorationState boxDecorationState) { m_boxDecorationState = boxDecorationState; }
1022     };
1023
1024     RenderObjectBitfields m_bitfields;
1025
1026     class RenderObjectRareData {
1027     public:
1028         RenderObjectRareData()
1029             : m_isDragging(false)
1030             , m_hasReflection(false)
1031             , m_isRenderFlowThread(false)
1032             , m_hasOutlineAutoAncestor(false)
1033             , m_isRegisteredForVisibleInViewportCallback(false)
1034             , m_visibleInViewportState(VisibilityUnknown)
1035         {
1036         }
1037         ADD_BOOLEAN_BITFIELD(isDragging, IsDragging);
1038         ADD_BOOLEAN_BITFIELD(hasReflection, HasReflection);
1039         ADD_BOOLEAN_BITFIELD(isRenderFlowThread, IsRenderFlowThread);
1040         ADD_BOOLEAN_BITFIELD(hasOutlineAutoAncestor, HasOutlineAutoAncestor);
1041
1042         // From RenderElement
1043         ADD_BOOLEAN_BITFIELD(isRegisteredForVisibleInViewportCallback, IsRegisteredForVisibleInViewportCallback);
1044         ADD_ENUM_BITFIELD(visibleInViewportState, VisibleInViewportState, VisibleInViewportState, 2);
1045
1046     };
1047     
1048     RenderObjectRareData rareData() const;
1049     RenderObjectRareData& ensureRareData();
1050     void removeRareData();
1051     
1052     // Note: RenderObjectRareData is stored by value.
1053     typedef HashMap<const RenderObject*, RenderObjectRareData> RareDataHash;
1054
1055     static RareDataHash& rareDataMap();
1056
1057 #undef ADD_BOOLEAN_BITFIELD
1058 };
1059
1060 inline Frame& RenderObject::frame() const
1061 {
1062     return *document().frame();
1063 }
1064
1065 inline AnimationController& RenderObject::animation() const
1066 {
1067     return frame().animation();
1068 }
1069
1070 inline bool RenderObject::documentBeingDestroyed() const
1071 {
1072     return document().renderTreeBeingDestroyed();
1073 }
1074
1075 inline bool RenderObject::isBeforeContent() const
1076 {
1077     // Text nodes don't have their own styles, so ignore the style on a text node.
1078     if (isText())
1079         return false;
1080     if (style().styleType() != BEFORE)
1081         return false;
1082     return true;
1083 }
1084
1085 inline bool RenderObject::isAfterContent() const
1086 {
1087     // Text nodes don't have their own styles, so ignore the style on a text node.
1088     if (isText())
1089         return false;
1090     if (style().styleType() != AFTER)
1091         return false;
1092     return true;
1093 }
1094
1095 inline bool RenderObject::isBeforeOrAfterContent() const
1096 {
1097     return isBeforeContent() || isAfterContent();
1098 }
1099
1100 inline void RenderObject::setNeedsLayout(MarkingBehavior markParents)
1101 {
1102     ASSERT(!isSetNeedsLayoutForbidden());
1103     if (m_bitfields.needsLayout())
1104         return;
1105     m_bitfields.setNeedsLayout(true);
1106     if (markParents == MarkContainingBlockChain)
1107         markContainingBlocksForLayout();
1108     if (hasLayer())
1109         setLayerNeedsFullRepaint();
1110 }
1111
1112 inline bool RenderObject::preservesNewline() const
1113 {
1114     if (isSVGInlineText())
1115         return false;
1116         
1117     return style().preserveNewline();
1118 }
1119
1120 inline void RenderObject::setSelectionStateIfNeeded(SelectionState state)
1121 {
1122     if (selectionState() == state)
1123         return;
1124
1125     setSelectionState(state);
1126 }
1127
1128 inline void RenderObject::setHasBoxDecorations(bool b)
1129 {
1130     if (!b) {
1131         m_bitfields.setBoxDecorationState(NoBoxDecorations);
1132         return;
1133     }
1134     if (hasBoxDecorations())
1135         return;
1136     m_bitfields.setBoxDecorationState(HasBoxDecorationsAndBackgroundObscurationStatusInvalid);
1137 }
1138
1139 inline void RenderObject::invalidateBackgroundObscurationStatus()
1140 {
1141     if (!hasBoxDecorations())
1142         return;
1143     m_bitfields.setBoxDecorationState(HasBoxDecorationsAndBackgroundObscurationStatusInvalid);
1144 }
1145
1146 inline bool RenderObject::backgroundIsKnownToBeObscured(const LayoutPoint& paintOffset)
1147 {
1148     if (m_bitfields.boxDecorationState() == HasBoxDecorationsAndBackgroundObscurationStatusInvalid) {
1149         BoxDecorationState boxDecorationState = computeBackgroundIsKnownToBeObscured(paintOffset) ? HasBoxDecorationsAndBackgroundIsKnownToBeObscured : HasBoxDecorationsAndBackgroundMayBeVisible;
1150         m_bitfields.setBoxDecorationState(boxDecorationState);
1151     }
1152     return m_bitfields.boxDecorationState() == HasBoxDecorationsAndBackgroundIsKnownToBeObscured;
1153 }
1154
1155 #if ENABLE(TREE_DEBUGGING)
1156 void printRenderTreeForLiveDocuments();
1157 void printLayerTreeForLiveDocuments();
1158 #endif
1159
1160 } // namespace WebCore
1161
1162 #define SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(ToValueTypeName, predicate) \
1163 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
1164     static bool isType(const WebCore::RenderObject& renderer) { return renderer.predicate; } \
1165 SPECIALIZE_TYPE_TRAITS_END()
1166
1167 #if ENABLE(TREE_DEBUGGING)
1168 // Outside the WebCore namespace for ease of invocation from gdb.
1169 void showNodeTree(const WebCore::RenderObject*);
1170 void showLineTree(const WebCore::RenderObject*);
1171 void showRenderTree(const WebCore::RenderObject*);
1172 #endif
1173
1174 #endif // RenderObject_h