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