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