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