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