Implement object-fit CSS property
[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 "DocumentStyleSheetCollection.h"
31 #include "Element.h"
32 #include "FloatQuad.h"
33 #include "LayoutRect.h"
34 #include "PaintPhase.h"
35 #include "RenderObjectChildList.h"
36 #include "RenderStyle.h"
37 #include "ScrollBehavior.h"
38 #include "StyleInheritedData.h"
39 #include "TextAffinity.h"
40 #include <wtf/HashSet.h>
41
42 namespace WebCore {
43
44 class AffineTransform;
45 class AnimationController;
46 class Cursor;
47 class Document;
48 class HitTestLocation;
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 RenderFlowThread;
58 class RenderGeometryMap;
59 class RenderLayer;
60 class RenderLayerModelObject;
61 class RenderNamedFlowThread;
62 class RenderTheme;
63 class TransformState;
64 class VisiblePosition;
65 #if ENABLE(SVG)
66 class RenderSVGResourceContainer;
67 #endif
68
69 struct PaintInfo;
70
71 enum CursorDirective {
72     SetCursorBasedOnStyle,
73     SetCursor,
74     DoNotSetCursor
75 };
76
77 enum HitTestFilter {
78     HitTestAll,
79     HitTestSelf,
80     HitTestDescendants
81 };
82
83 enum HitTestAction {
84     HitTestBlockBackground,
85     HitTestChildBlockBackground,
86     HitTestChildBlockBackgrounds,
87     HitTestFloat,
88     HitTestForeground
89 };
90
91 // Sides used when drawing borders and outlines. The values should run clockwise from top.
92 enum BoxSide {
93     BSTop,
94     BSRight,
95     BSBottom,
96     BSLeft
97 };
98
99 enum MarkingBehavior {
100     MarkOnlyThis,
101     MarkContainingBlockChain,
102 };
103
104 enum MapCoordinatesMode {
105     IsFixed = 1 << 0,
106     UseTransforms = 1 << 1,
107     ApplyContainerFlip = 1 << 2
108 };
109 typedef unsigned MapCoordinatesFlags;
110
111 const int caretWidth = 1;
112
113 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
114 struct AnnotatedRegionValue {
115     bool operator==(const AnnotatedRegionValue& o) const
116     {
117 #if ENABLE(DASHBOARD_SUPPORT)
118         return type == o.type && bounds == o.bounds && clip == o.clip && label == o.label;
119 #else // ENABLE(DRAGGABLE_REGION)
120         return draggable == o.draggable && bounds == o.bounds;
121 #endif
122     }
123     bool operator!=(const AnnotatedRegionValue& o) const
124     {
125         return !(*this == o);
126     }
127
128     LayoutRect bounds;
129 #if ENABLE(DASHBOARD_SUPPORT)
130     String label;
131     LayoutRect clip;
132     int type;
133 #else // ENABLE(DRAGGABLE_REGION)
134     bool draggable;
135 #endif
136 };
137 #endif
138
139 typedef WTF::HashSet<const RenderObject*> RenderObjectAncestorLineboxDirtySet;
140
141 #ifndef NDEBUG
142 const int showTreeCharacterOffset = 39;
143 #endif
144
145 // Base class for all rendering tree objects.
146 class RenderObject : public CachedImageClient {
147     friend class RenderBlock;
148     friend class RenderLayer;
149     friend class RenderObjectChildList;
150 public:
151     // Anonymous objects should pass the document as their node, and they will then automatically be
152     // marked as anonymous in the constructor.
153     explicit RenderObject(Node*);
154     virtual ~RenderObject();
155
156     RenderTheme* theme() const;
157
158     virtual const char* renderName() const = 0;
159
160     RenderObject* parent() const { return m_parent; }
161     bool isDescendantOf(const RenderObject*) const;
162
163     RenderObject* previousSibling() const { return m_previous; }
164     RenderObject* nextSibling() const { return m_next; }
165
166     // FIXME: These should be renamed slowFirstChild, slowLastChild, etc.
167     // to discourage their use. The virtualChildren() call inside these
168     // can be slow for hot code paths.
169     // Currently, some subclasses like RenderBlock, override these NON-virtual
170     // functions to make these fast when we already have a more specific pointer type.
171     RenderObject* firstChild() const
172     {
173         if (const RenderObjectChildList* children = virtualChildren())
174             return children->firstChild();
175         return 0;
176     }
177     RenderObject* lastChild() const
178     {
179         if (const RenderObjectChildList* children = virtualChildren())
180             return children->lastChild();
181         return 0;
182     }
183
184     virtual RenderObjectChildList* virtualChildren() { return 0; }
185     virtual const RenderObjectChildList* virtualChildren() const { return 0; }
186
187     RenderObject* nextInPreOrder() const;
188     RenderObject* nextInPreOrder(const RenderObject* stayWithin) const;
189     RenderObject* nextInPreOrderAfterChildren() const;
190     RenderObject* nextInPreOrderAfterChildren(const RenderObject* stayWithin) const;
191     RenderObject* previousInPreOrder() const;
192     RenderObject* previousInPreOrder(const RenderObject* stayWithin) const;
193     RenderObject* childAt(unsigned) const;
194
195     RenderObject* firstLeafChild() const;
196     RenderObject* lastLeafChild() const;
197
198     // The following six functions are used when the render tree hierarchy changes to make sure layers get
199     // properly added and removed.  Since containership can be implemented by any subclass, and since a hierarchy
200     // can contain a mixture of boxes and other object types, these functions need to be in the base class.
201     RenderLayer* enclosingLayer() const;
202     void addLayers(RenderLayer* parentLayer);
203     void removeLayers(RenderLayer* parentLayer);
204     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
205     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint, bool checkParent = true);
206
207     // Scrolling is a RenderBox concept, however some code just cares about recursively scrolling our enclosing ScrollableArea(s).
208     bool scrollRectToVisible(const LayoutRect&, const ScrollAlignment& alignX = ScrollAlignment::alignCenterIfNeeded, const ScrollAlignment& alignY = ScrollAlignment::alignCenterIfNeeded);
209
210     // Convenience function for getting to the nearest enclosing box of a RenderObject.
211     RenderBox* enclosingBox() const;
212     RenderBoxModelObject* enclosingBoxModelObject() const;
213
214     // Function to return our enclosing flow thread if we are contained inside one. This
215     // function follows the containing block chain.
216     RenderFlowThread* flowThreadContainingBlock() const
217     {
218         if (flowThreadState() == NotInsideFlowThread)
219             return 0;
220         return locateFlowThreadContainingBlock();
221     }
222
223     RenderNamedFlowThread* renderNamedFlowThreadWrapper() const;
224
225     virtual bool isEmpty() const { return firstChild() == 0; }
226
227 #ifndef NDEBUG
228     void setHasAXObject(bool flag) { m_hasAXObject = flag; }
229     bool hasAXObject() const { return m_hasAXObject; }
230
231     // Helper class forbidding calls to setNeedsLayout() during its lifetime.
232     class SetLayoutNeededForbiddenScope {
233     public:
234         explicit SetLayoutNeededForbiddenScope(RenderObject*, bool isForbidden = true);
235         ~SetLayoutNeededForbiddenScope();
236     private:
237         RenderObject* m_renderObject;
238         bool m_preexistingForbidden;
239     };
240 #endif
241
242     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
243     // children.
244     virtual RenderBlock* firstLineBlock() const;
245
246     // Called when an object that was floating or positioned becomes a normal flow object
247     // again.  We have to make sure the render tree updates as needed to accommodate the new
248     // normal flow object.
249     void handleDynamicFloatPositionChange();
250     void removeAnonymousWrappersForInlinesIfNecessary();
251     
252     // RenderObject tree manipulation
253     //////////////////////////////////////////
254     virtual bool canHaveChildren() const { return virtualChildren(); }
255     virtual bool canHaveGeneratedChildren() const;
256     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const { return true; }
257     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0);
258     virtual void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild = 0) { return addChild(newChild, beforeChild); }
259     virtual void removeChild(RenderObject*);
260     virtual bool createsAnonymousWrapper() const { return false; }
261     //////////////////////////////////////////
262
263 protected:
264     //////////////////////////////////////////
265     // Helper functions. Dangerous to use!
266     void setPreviousSibling(RenderObject* previous) { m_previous = previous; }
267     void setNextSibling(RenderObject* next) { m_next = next; }
268     void setParent(RenderObject* parent)
269     {
270         m_parent = parent;
271         
272         // Only update if our flow thread state is different from our new parent and if we're not a RenderFlowThread.
273         // A RenderFlowThread is always considered to be inside itself, so it never has to change its state
274         // in response to parent changes.
275         FlowThreadState newState = parent ? parent->flowThreadState() : NotInsideFlowThread;
276         if (newState != flowThreadState() && !isRenderFlowThread())
277             setFlowThreadStateIncludingDescendants(newState);
278     }
279
280     //////////////////////////////////////////
281 private:
282 #ifndef NDEBUG
283     bool isSetNeedsLayoutForbidden() const { return m_setNeedsLayoutForbidden; }
284     void setNeedsLayoutIsForbidden(bool flag) { m_setNeedsLayoutForbidden = flag; }
285 #endif
286
287     void addAbsoluteRectForLayer(LayoutRect& result);
288     void setLayerNeedsFullRepaint();
289     void setLayerNeedsFullRepaintForPositionedMovementLayout();
290
291 public:
292 #ifndef NDEBUG
293     void showTreeForThis() const;
294     void showRenderTreeForThis() const;
295     void showLineTreeForThis() const;
296
297     void showRenderObject() const;
298     // We don't make printedCharacters an optional parameter so that
299     // showRenderObject can be called from gdb easily.
300     void showRenderObject(int printedCharacters) const;
301     void showRenderTreeAndMark(const RenderObject* markedObject1 = 0, const char* markedLabel1 = 0, const RenderObject* markedObject2 = 0, const char* markedLabel2 = 0, int depth = 0) const;
302 #endif
303
304     static RenderObject* createObject(Element*, RenderStyle*);
305
306     // Overloaded new operator.  Derived classes must override operator new
307     // in order to allocate out of the RenderArena.
308     void* operator new(size_t, RenderArena*);
309
310     // Overridden to prevent the normal delete from being called.
311     void operator delete(void*, size_t);
312
313 private:
314     // The normal operator new is disallowed on all render objects.
315     void* operator new(size_t) throw();
316
317 public:
318     RenderArena* renderArena() const { return document().renderArena(); }
319
320     bool isPseudoElement() const { return node() && node()->isPseudoElement(); }
321
322     virtual bool isBR() const { return false; }
323     virtual bool isBlockFlow() const { return false; }
324     virtual bool isBoxModelObject() const { return false; }
325     virtual bool isCounter() const { return false; }
326     virtual bool isQuote() const { return false; }
327
328 #if ENABLE(DETAILS_ELEMENT)
329     virtual bool isDetailsMarker() const { return false; }
330 #endif
331     virtual bool isEmbeddedObject() const { return false; }
332     virtual bool isFieldset() const { return false; }
333     virtual bool isFileUploadControl() const { return false; }
334     virtual bool isFrame() const { return false; }
335     virtual bool isFrameSet() const { return false; }
336     virtual bool isImage() const { return false; }
337     virtual bool isInlineBlockOrInlineTable() const { return false; }
338     virtual bool isLayerModelObject() const { return false; }
339     virtual bool isListBox() const { return false; }
340     virtual bool isListItem() const { return false; }
341     virtual bool isListMarker() const { return false; }
342     virtual bool isMedia() const { return false; }
343     virtual bool isMenuList() const { return false; }
344 #if ENABLE(METER_ELEMENT)
345     virtual bool isMeter() const { return false; }
346 #endif
347     virtual bool isSnapshottedPlugIn() const { return false; }
348 #if ENABLE(PROGRESS_ELEMENT)
349     virtual bool isProgress() const { return false; }
350 #endif
351     virtual bool isRenderBlock() const { return false; }
352     virtual bool isRenderSVGBlock() const { return false; };
353     virtual bool isRenderButton() const { return false; }
354     virtual bool isRenderIFrame() const { return false; }
355     virtual bool isRenderImage() const { return false; }
356     virtual bool isRenderInline() const { return false; }
357     virtual bool isRenderPart() const { return false; }
358     virtual bool isRenderRegion() const { return false; }
359     virtual bool isRenderReplaced() const { return false; }
360     virtual bool isRenderView() const { return false; }
361     virtual bool isReplica() const { return false; }
362
363     virtual bool isRuby() const { return false; }
364     virtual bool isRubyBase() const { return false; }
365     virtual bool isRubyRun() const { return false; }
366     virtual bool isRubyText() const { return false; }
367
368     virtual bool isSlider() const { return false; }
369     virtual bool isSliderThumb() const { return false; }
370     virtual bool isTable() const { return false; }
371     virtual bool isTableCell() const { return false; }
372     virtual bool isRenderTableCol() const { return false; }
373     virtual bool isTableCaption() const { return false; }
374     virtual bool isTableRow() const { return false; }
375     virtual bool isTableSection() const { return false; }
376     virtual bool isTextControl() const { return false; }
377     virtual bool isTextArea() const { return false; }
378     virtual bool isTextField() const { return false; }
379     virtual bool isVideo() const { return false; }
380     virtual bool isWidget() const { return false; }
381     virtual bool isCanvas() const { return false; }
382 #if ENABLE(FULLSCREEN_API)
383     virtual bool isRenderFullScreen() const { return false; }
384     virtual bool isRenderFullScreenPlaceholder() const { return false; }
385 #endif
386
387     virtual bool isRenderGrid() const { return false; }
388
389     virtual bool isRenderFlowThread() const { return false; }
390     virtual bool isRenderNamedFlowThread() const { return false; }
391     bool isInFlowRenderFlowThread() const { return isRenderFlowThread() && !isOutOfFlowPositioned(); }
392     bool isOutOfFlowRenderFlowThread() const { return isRenderFlowThread() && isOutOfFlowPositioned(); }
393
394     virtual bool isRenderMultiColumnBlock() const { return false; }
395     virtual bool isRenderMultiColumnSet() const { return false; }
396
397     virtual bool isRenderScrollbarPart() const { return false; }
398
399     bool isRoot() const { return document().documentElement() == m_node; }
400     bool isBody() const;
401     bool isHR() const;
402     bool isLegend() const;
403
404     bool isHTMLMarquee() const;
405
406     bool isTablePart() const { return isTableCell() || isRenderTableCol() || isTableCaption() || isTableRow() || isTableSection(); }
407
408     inline bool isBeforeContent() const;
409     inline bool isAfterContent() const;
410     inline bool isBeforeOrAfterContent() const;
411     static inline bool isBeforeContent(const RenderObject* obj) { return obj && obj->isBeforeContent(); }
412     static inline bool isAfterContent(const RenderObject* obj) { return obj && obj->isAfterContent(); }
413     static inline bool isBeforeOrAfterContent(const RenderObject* obj) { return obj && obj->isBeforeOrAfterContent(); }
414
415     bool hasCounterNodeMap() const { return m_bitfields.hasCounterNodeMap(); }
416     void setHasCounterNodeMap(bool hasCounterNodeMap) { m_bitfields.setHasCounterNodeMap(hasCounterNodeMap); }
417     bool everHadLayout() const { return m_bitfields.everHadLayout(); }
418
419     bool childrenInline() const { return m_bitfields.childrenInline(); }
420     void setChildrenInline(bool b) { m_bitfields.setChildrenInline(b); }
421     bool hasColumns() const { return m_bitfields.hasColumns(); }
422     void setHasColumns(bool b = true) { m_bitfields.setHasColumns(b); }
423
424     bool ancestorLineBoxDirty() const { return s_ancestorLineboxDirtySet && s_ancestorLineboxDirtySet->contains(this); }
425     void setAncestorLineBoxDirty(bool b = true)
426     {
427         if (b) {
428             if (!s_ancestorLineboxDirtySet)
429                 s_ancestorLineboxDirtySet = new RenderObjectAncestorLineboxDirtySet;
430             s_ancestorLineboxDirtySet->add(this);
431             setNeedsLayout(true);
432         } else if (s_ancestorLineboxDirtySet) {
433             s_ancestorLineboxDirtySet->remove(this);
434             if (s_ancestorLineboxDirtySet->isEmpty()) {
435                 delete s_ancestorLineboxDirtySet;
436                 s_ancestorLineboxDirtySet = 0;
437             }
438         }
439     }
440
441     enum FlowThreadState {
442         NotInsideFlowThread = 0,
443         InsideOutOfFlowThread = 1,
444         InsideInFlowThread = 2,
445     };
446
447     void setFlowThreadStateIncludingDescendants(FlowThreadState);
448
449     FlowThreadState flowThreadState() const { return m_bitfields.flowThreadState(); }
450     void setFlowThreadState(FlowThreadState state) { m_bitfields.setFlowThreadState(state); }
451
452     virtual bool requiresForcedStyleRecalcPropagation() const { return false; }
453
454 #if ENABLE(MATHML)
455     virtual bool isRenderMathMLBlock() const { return false; }
456 #endif // ENABLE(MATHML)
457
458 #if ENABLE(SVG)
459     // FIXME: Until all SVG renders can be subclasses of RenderSVGModelObject we have
460     // to add SVG renderer methods to RenderObject with an ASSERT_NOT_REACHED() default implementation.
461     virtual bool isSVGRoot() const { return false; }
462     virtual bool isSVGContainer() const { return false; }
463     virtual bool isSVGTransformableContainer() const { return false; }
464     virtual bool isSVGViewportContainer() const { return false; }
465     virtual bool isSVGGradientStop() const { return false; }
466     virtual bool isSVGHiddenContainer() const { return false; }
467     virtual bool isSVGPath() const { return false; }
468     virtual bool isSVGShape() const { return false; }
469     virtual bool isSVGText() const { return false; }
470     virtual bool isSVGTextPath() const { return false; }
471     virtual bool isSVGInline() const { return false; }
472     virtual bool isSVGInlineText() const { return false; }
473     virtual bool isSVGImage() const { return false; }
474     virtual bool isSVGForeignObject() const { return false; }
475     virtual bool isSVGResourceContainer() const { return false; }
476     virtual bool isSVGResourceFilter() const { return false; }
477     virtual bool isSVGResourceFilterPrimitive() const { return false; }
478
479     virtual RenderSVGResourceContainer* toRenderSVGResourceContainer();
480
481     // FIXME: Those belong into a SVG specific base-class for all renderers (see above)
482     // Unfortunately we don't have such a class yet, because it's not possible for all renderers
483     // to inherit from RenderSVGObject -> RenderObject (some need RenderBlock inheritance for instance)
484     virtual void setNeedsTransformUpdate() { }
485     virtual void setNeedsBoundariesUpdate();
486     virtual bool needsBoundariesUpdate() { return false; }
487
488     // Per SVG 1.1 objectBoundingBox ignores clipping, masking, filter effects, opacity and stroke-width.
489     // This is used for all computation of objectBoundingBox relative units and by SVGLocatable::getBBox().
490     // NOTE: Markers are not specifically ignored here by SVG 1.1 spec, but we ignore them
491     // since stroke-width is ignored (and marker size can depend on stroke-width).
492     // objectBoundingBox is returned local coordinates.
493     // The name objectBoundingBox is taken from the SVG 1.1 spec.
494     virtual FloatRect objectBoundingBox() const;
495     virtual FloatRect strokeBoundingBox() const;
496
497     // Returns the smallest rectangle enclosing all of the painted content
498     // respecting clipping, masking, filters, opacity, stroke-width and markers
499     virtual FloatRect repaintRectInLocalCoordinates() const;
500
501     // This only returns the transform="" value from the element
502     // most callsites want localToParentTransform() instead.
503     virtual AffineTransform localTransform() const;
504
505     // Returns the full transform mapping from local coordinates to local coords for the parent SVG renderer
506     // This includes any viewport transforms and x/y offsets as well as the transform="" value off the element.
507     virtual const AffineTransform& localToParentTransform() const;
508
509     // SVG uses FloatPoint precise hit testing, and passes the point in parent
510     // coordinates instead of in repaint container coordinates.  Eventually the
511     // rest of the rendering tree will move to a similar model.
512     virtual bool nodeAtFloatPoint(const HitTestRequest&, HitTestResult&, const FloatPoint& pointInParent, HitTestAction);
513 #endif
514
515     bool hasAspectRatio() const { return isReplaced() && (isImage() || isVideo() || isCanvas()); }
516     bool isAnonymous() const { return m_bitfields.isAnonymous(); }
517     bool isAnonymousBlock() const
518     {
519         // This function is kept in sync with anonymous block creation conditions in
520         // RenderBlock::createAnonymousBlock(). This includes creating an anonymous
521         // RenderBlock having a BLOCK or BOX display. Other classes such as RenderTextFragment
522         // are not RenderBlocks and will return false. See https://bugs.webkit.org/show_bug.cgi?id=56709. 
523         return isAnonymous() && (style()->display() == BLOCK || style()->display() == BOX) && style()->styleType() == NOPSEUDO && isRenderBlock() && !isListMarker() && !isRenderFlowThread()
524 #if ENABLE(FULLSCREEN_API)
525             && !isRenderFullScreen()
526             && !isRenderFullScreenPlaceholder()
527 #endif
528 #if ENABLE(MATHML)
529             && !isRenderMathMLBlock()
530 #endif
531             ;
532     }
533     bool isAnonymousColumnsBlock() const { return style()->specifiesColumns() && isAnonymousBlock(); }
534     bool isAnonymousColumnSpanBlock() const { return style()->columnSpan() && isAnonymousBlock(); }
535     bool isElementContinuation() const { return node() && node()->renderer() != this; }
536     bool isInlineElementContinuation() const { return isElementContinuation() && isInline(); }
537     bool isBlockElementContinuation() const { return isElementContinuation() && !isInline(); }
538     virtual RenderBoxModelObject* virtualContinuation() const { return 0; }
539
540     bool isFloating() const { return m_bitfields.floating(); }
541
542     bool isOutOfFlowPositioned() const { return m_bitfields.isOutOfFlowPositioned(); } // absolute or fixed positioning
543     bool isInFlowPositioned() const { return m_bitfields.isRelPositioned() || m_bitfields.isStickyPositioned(); } // relative or sticky positioning
544     bool isRelPositioned() const { return m_bitfields.isRelPositioned(); } // relative positioning
545     bool isStickyPositioned() const { return m_bitfields.isStickyPositioned(); }
546     bool isPositioned() const { return m_bitfields.isPositioned(); }
547
548     bool isText() const  { return m_bitfields.isText(); }
549     bool isBox() const { return m_bitfields.isBox(); }
550     bool isInline() const { return m_bitfields.isInline(); } // inline object
551     bool isRunIn() const { return style()->display() == RUN_IN; } // run-in object
552     bool isDragging() const { return m_bitfields.isDragging(); }
553     bool isReplaced() const { return m_bitfields.isReplaced(); } // a "replaced" element (see CSS)
554     bool isHorizontalWritingMode() const { return m_bitfields.horizontalWritingMode(); }
555
556     bool hasLayer() const { return m_bitfields.hasLayer(); }
557
558     enum BoxDecorationState {
559         NoBoxDecorations,
560         HasBoxDecorationsAndBackgroundObscurationStatusInvalid,
561         HasBoxDecorationsAndBackgroundIsKnownToBeObscured,
562         HasBoxDecorationsAndBackgroundMayBeVisible,
563     };
564     bool hasBoxDecorations() const { return m_bitfields.boxDecorationState() != NoBoxDecorations; }
565     bool backgroundIsKnownToBeObscured();
566     bool borderImageIsLoadedAndCanBeRendered() const;
567     bool mustRepaintBackgroundOrBorder() const;
568     bool hasBackground() const { return style()->hasBackground(); }
569     bool hasEntirelyFixedBackground() const;
570
571     bool needsLayout() const
572     {
573         return m_bitfields.needsLayout() || m_bitfields.normalChildNeedsLayout() || m_bitfields.posChildNeedsLayout()
574             || m_bitfields.needsSimplifiedNormalFlowLayout() || m_bitfields.needsPositionedMovementLayout();
575     }
576
577     bool selfNeedsLayout() const { return m_bitfields.needsLayout(); }
578     bool needsPositionedMovementLayout() const { return m_bitfields.needsPositionedMovementLayout(); }
579     bool needsPositionedMovementLayoutOnly() const
580     {
581         return m_bitfields.needsPositionedMovementLayout() && !m_bitfields.needsLayout() && !m_bitfields.normalChildNeedsLayout()
582             && !m_bitfields.posChildNeedsLayout() && !m_bitfields.needsSimplifiedNormalFlowLayout();
583     }
584
585     bool posChildNeedsLayout() const { return m_bitfields.posChildNeedsLayout(); }
586     bool needsSimplifiedNormalFlowLayout() const { return m_bitfields.needsSimplifiedNormalFlowLayout(); }
587     bool normalChildNeedsLayout() const { return m_bitfields.normalChildNeedsLayout(); }
588     
589     bool preferredLogicalWidthsDirty() const { return m_bitfields.preferredLogicalWidthsDirty(); }
590
591     bool isSelectionBorder() const;
592
593     bool hasClip() const { return isOutOfFlowPositioned() && style()->hasClip(); }
594     bool hasOverflowClip() const { return m_bitfields.hasOverflowClip(); }
595     bool hasClipOrOverflowClip() const { return hasClip() || hasOverflowClip(); }
596
597     bool hasTransform() const { return m_bitfields.hasTransform(); }
598     bool hasMask() const { return style() && style()->hasMask(); }
599     bool hasClipPath() const { return style() && style()->clipPath(); }
600     bool hasHiddenBackface() const { return style() && style()->backfaceVisibility() == BackfaceVisibilityHidden; }
601
602 #if ENABLE(CSS_FILTERS)
603     bool hasFilter() const { return style() && style()->hasFilter(); }
604 #else
605     bool hasFilter() const { return false; }
606 #endif
607
608 #if ENABLE(CSS_COMPOSITING)
609     bool hasBlendMode() const { return style() && style()->hasBlendMode(); }
610 #else
611     bool hasBlendMode() const { return false; }
612 #endif
613
614     inline bool preservesNewline() const;
615
616     // The pseudo element style can be cached or uncached.  Use the cached method if the pseudo element doesn't respect
617     // any pseudo classes (and therefore has no concept of changing state).
618     RenderStyle* getCachedPseudoStyle(PseudoId, RenderStyle* parentStyle = 0) const;
619     PassRefPtr<RenderStyle> getUncachedPseudoStyle(const PseudoStyleRequest&, RenderStyle* parentStyle = 0, RenderStyle* ownStyle = 0) const;
620     
621     virtual void updateDragState(bool dragOn);
622
623     RenderView& view() const { return *document().renderView(); };
624
625     // Returns true if this renderer is rooted, and optionally returns the hosting view (the root of the hierarchy).
626     bool isRooted(RenderView** = 0) const;
627
628     Node* node() const { return isAnonymous() ? 0 : m_node; }
629     Node* nonPseudoNode() const { return isPseudoElement() ? 0 : node(); }
630
631     // FIXME: Why does RenderWidget need this?
632     void clearNode() { m_node = 0; }
633
634     // Returns the styled node that caused the generation of this renderer.
635     // This is the same as node() except for renderers of :before and :after
636     // pseudo elements for which their parent node is returned.
637     Node* generatingNode() const { return isPseudoElement() ? generatingPseudoHostElement() : node(); }
638
639     Document& document() const { return *m_node->document(); }
640     Frame& frame() const; // Defined in RenderView.h
641
642     bool hasOutlineAnnotation() const;
643     bool hasOutline() const { return style()->hasOutline() || hasOutlineAnnotation(); }
644
645     // Returns the object containing this one. Can be different from parent for positioned elements.
646     // If repaintContainer and repaintContainerSkipped are not null, on return *repaintContainerSkipped
647     // is true if the renderer returned is an ancestor of repaintContainer.
648     RenderObject* container(const RenderLayerModelObject* repaintContainer = 0, bool* repaintContainerSkipped = 0) const;
649
650     virtual RenderObject* hoverAncestor() const;
651
652     RenderBoxModelObject* offsetParent() const;
653
654     void markContainingBlocksForLayout(bool scheduleRelayout = true, RenderObject* newRoot = 0);
655     void setNeedsLayout(bool needsLayout, MarkingBehavior = MarkContainingBlockChain);
656     void setChildNeedsLayout(bool childNeedsLayout, MarkingBehavior = MarkContainingBlockChain);
657     void setNeedsPositionedMovementLayout(const RenderStyle* oldStyle);
658     void setNeedsSimplifiedNormalFlowLayout();
659     void setPreferredLogicalWidthsDirty(bool, MarkingBehavior = MarkContainingBlockChain);
660     void invalidateContainerPreferredLogicalWidths();
661     
662     void setNeedsLayoutAndPrefWidthsRecalc()
663     {
664         setNeedsLayout(true);
665         setPreferredLogicalWidthsDirty(true);
666     }
667
668     void setPositionState(EPosition position)
669     {
670         ASSERT((position != AbsolutePosition && position != FixedPosition) || isBox());
671         m_bitfields.setPositionedState(position);
672     }
673     void clearPositionedState() { m_bitfields.clearPositionedState(); }
674
675     void setFloating(bool b = true) { m_bitfields.setFloating(b); }
676     void setInline(bool b = true) { m_bitfields.setIsInline(b); }
677
678     void setHasBoxDecorations(bool = true);
679     void invalidateBackgroundObscurationStatus();
680     virtual bool computeBackgroundIsKnownToBeObscured() { return false; }
681
682     void setIsText() { m_bitfields.setIsText(true); }
683     void setIsBox() { m_bitfields.setIsBox(true); }
684     void setReplaced(bool b = true) { m_bitfields.setIsReplaced(b); }
685     void setHorizontalWritingMode(bool b = true) { m_bitfields.setHorizontalWritingMode(b); }
686     void setHasOverflowClip(bool b = true) { m_bitfields.setHasOverflowClip(b); }
687     void setHasLayer(bool b = true) { m_bitfields.setHasLayer(b); }
688     void setHasTransform(bool b = true) { m_bitfields.setHasTransform(b); }
689     void setHasReflection(bool b = true) { m_bitfields.setHasReflection(b); }
690
691     void scheduleRelayout();
692
693     void updateFillImages(const FillLayer*, const FillLayer*);
694     void updateImage(StyleImage*, StyleImage*);
695 #if ENABLE(CSS_SHAPES)
696     void updateShapeImage(const ShapeValue*, const ShapeValue*);
697 #endif
698
699     virtual void paint(PaintInfo&, const LayoutPoint&);
700
701     // Recursive function that computes the size and position of this object and all its descendants.
702     virtual void layout();
703
704     /* This function performs a layout only if one is needed. */
705     void layoutIfNeeded() { if (needsLayout()) layout(); }
706     
707     // used for element state updates that cannot be fixed with a
708     // repaint and do not need a relayout
709     virtual void updateFromElement() { }
710
711 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
712     virtual void addAnnotatedRegions(Vector<AnnotatedRegionValue>&);
713     void collectAnnotatedRegions(Vector<AnnotatedRegionValue>&);
714 #endif
715
716     bool isComposited() const;
717
718     bool hitTest(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestFilter = HitTestAll);
719     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&);
720     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
721
722     virtual VisiblePosition positionForPoint(const LayoutPoint&);
723     VisiblePosition createVisiblePosition(int offset, EAffinity);
724     VisiblePosition createVisiblePosition(const Position&);
725
726     virtual void dirtyLinesFromChangedChild(RenderObject*);
727
728     // Called to update a style that is allowed to trigger animations.
729     // FIXME: Right now this will typically be called only when updating happens from the DOM on explicit elements.
730     // We don't yet handle generated content animation such as first-letter or before/after (we'll worry about this later).
731     void setAnimatableStyle(PassRefPtr<RenderStyle>);
732
733     // Set the style of the object and update the state of the object accordingly.
734     virtual void setStyle(PassRefPtr<RenderStyle>);
735
736     // Set the style of the object if it's generated content.
737     void setPseudoStyle(PassRefPtr<RenderStyle>);
738
739     // Updates only the local style ptr of the object.  Does not update the state of the object,
740     // and so only should be called when the style is known not to have changed (or from setStyle).
741     void setStyleInternal(PassRefPtr<RenderStyle> style) { m_style = style; }
742
743     // returns the containing block level element for this element.
744     RenderBlock* containingBlock() const;
745
746     bool canContainFixedPositionObjects() const
747     {
748         return isRenderView() || (hasTransform() && isRenderBlock())
749 #if ENABLE(SVG)
750                 || isSVGForeignObject()
751 #endif
752                 || isOutOfFlowRenderFlowThread();
753     }
754
755     // Convert the given local point to absolute coordinates
756     // FIXME: Temporary. If UseTransforms is true, take transforms into account. Eventually localToAbsolute() will always be transform-aware.
757     FloatPoint localToAbsolute(const FloatPoint& localPoint = FloatPoint(), MapCoordinatesFlags = 0) const;
758     FloatPoint absoluteToLocal(const FloatPoint&, MapCoordinatesFlags = 0) const;
759
760     // Convert a local quad to absolute coordinates, taking transforms into account.
761     FloatQuad localToAbsoluteQuad(const FloatQuad& quad, MapCoordinatesFlags mode = 0, bool* wasFixed = 0) const
762     {
763         return localToContainerQuad(quad, 0, mode, wasFixed);
764     }
765     // Convert an absolute quad to local coordinates.
766     FloatQuad absoluteToLocalQuad(const FloatQuad&, MapCoordinatesFlags mode = 0) const;
767
768     // Convert a local quad into the coordinate system of container, taking transforms into account.
769     FloatQuad localToContainerQuad(const FloatQuad&, const RenderLayerModelObject* repaintContainer, MapCoordinatesFlags = 0, bool* wasFixed = 0) const;
770     FloatPoint localToContainerPoint(const FloatPoint&, const RenderLayerModelObject* repaintContainer, MapCoordinatesFlags = 0, bool* wasFixed = 0) const;
771
772     // Return the offset from the container() renderer (excluding transforms). In multi-column layout,
773     // different offsets apply at different points, so return the offset that applies to the given point.
774     virtual LayoutSize offsetFromContainer(RenderObject*, const LayoutPoint&, bool* offsetDependsOnPoint = 0) const;
775     // Return the offset from an object up the container() chain. Asserts that none of the intermediate objects have transforms.
776     LayoutSize offsetFromAncestorContainer(RenderObject*) const;
777     
778     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint&) const { }
779
780     // FIXME: useTransforms should go away eventually
781     IntRect absoluteBoundingBoxRect(bool useTransform = true) const;
782     IntRect absoluteBoundingBoxRectIgnoringTransforms() const { return absoluteBoundingBoxRect(false); }
783
784     // Build an array of quads in absolute coords for line boxes
785     virtual void absoluteQuads(Vector<FloatQuad>&, bool* /*wasFixed*/ = 0) const { }
786
787     virtual void absoluteFocusRingQuads(Vector<FloatQuad>&);
788
789     static FloatRect absoluteBoundingBoxRectForRange(const Range*);
790
791     // the rect that will be painted if this object is passed as the paintingRoot
792     LayoutRect paintingRootRect(LayoutRect& topLevelRect);
793
794     virtual LayoutUnit minPreferredLogicalWidth() const { return 0; }
795     virtual LayoutUnit maxPreferredLogicalWidth() const { return 0; }
796
797     RenderStyle* style() const { return m_style.get(); }
798     RenderStyle* firstLineStyle() const { return document().styleSheetCollection()->usesFirstLineRules() ? cachedFirstLineStyle() : style(); }
799     RenderStyle* style(bool firstLine) const { return firstLine ? firstLineStyle() : style(); }
800
801     // Used only by Element::pseudoStyleCacheIsInvalid to get a first line style based off of a
802     // given new style, without accessing the cache.
803     PassRefPtr<RenderStyle> uncachedFirstLineStyle(RenderStyle*) const;
804
805     // Anonymous blocks that are part of of a continuation chain will return their inline continuation's outline style instead.
806     // This is typically only relevant when repainting.
807     virtual RenderStyle* outlineStyleForRepaint() const { return style(); }
808     
809     virtual CursorDirective getCursor(const LayoutPoint&, Cursor&) const;
810
811     void getTextDecorationColors(int decorations, Color& underline, Color& overline, Color& linethrough, bool quirksMode = false, bool firstlineStyle = false);
812
813     // Return the RenderLayerModelObject in the container chain which is responsible for painting this object, or 0
814     // if painting is root-relative. This is the container that should be passed to the 'forRepaint'
815     // methods.
816     RenderLayerModelObject* containerForRepaint() const;
817     // Actually do the repaint of rect r for this object which has been computed in the coordinate space
818     // of repaintContainer. If repaintContainer is 0, repaint via the view.
819     void repaintUsingContainer(const RenderLayerModelObject* repaintContainer, const IntRect&, bool immediate = false) const;
820     
821     // Repaint the entire object.  Called when, e.g., the color of a border changes, or when a border
822     // style changes.
823     void repaint(bool immediate = false) const;
824
825     // Repaint a specific subrectangle within a given object.  The rect |r| is in the object's coordinate space.
826     void repaintRectangle(const LayoutRect&, bool immediate = false) const;
827
828     // Repaint only if our old bounds and new bounds are different. The caller may pass in newBounds and newOutlineBox if they are known.
829     bool repaintAfterLayoutIfNeeded(const RenderLayerModelObject* repaintContainer, const LayoutRect& oldBounds, const LayoutRect& oldOutlineBox, const LayoutRect* newBoundsPtr = 0, const LayoutRect* newOutlineBoxPtr = 0);
830
831     bool checkForRepaintDuringLayout() const;
832
833     // Returns the rect that should be repainted whenever this object changes.  The rect is in the view's
834     // coordinate space.  This method deals with outlines and overflow.
835     LayoutRect absoluteClippedOverflowRect() const
836     {
837         return clippedOverflowRectForRepaint(0);
838     }
839     IntRect pixelSnappedAbsoluteClippedOverflowRect() const;
840     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const;
841     virtual LayoutRect rectWithOutlineForRepaint(const RenderLayerModelObject* repaintContainer, LayoutUnit outlineWidth) const;
842     virtual LayoutRect outlineBoundsForRepaint(const RenderLayerModelObject* /*repaintContainer*/, const RenderGeometryMap* = 0) const { return LayoutRect(); }
843
844     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
845     // that rect in view coordinates.
846     void computeAbsoluteRepaintRect(LayoutRect& r, bool fixed = false) const
847     {
848         computeRectForRepaint(0, r, fixed);
849     }
850     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
851     // that rect in the coordinate space of repaintContainer.
852     virtual void computeRectForRepaint(const RenderLayerModelObject* repaintContainer, LayoutRect&, bool fixed = false) const;
853     virtual void computeFloatRectForRepaint(const RenderLayerModelObject* repaintContainer, FloatRect& repaintRect, bool fixed = false) const;
854
855     // If multiple-column layout results in applying an offset to the given point, add the same
856     // offset to the given size.
857     virtual void adjustForColumns(LayoutSize&, const LayoutPoint&) const { }
858     LayoutSize offsetForColumns(const LayoutPoint& point) const
859     {
860         LayoutSize offset;
861         adjustForColumns(offset, point);
862         return offset;
863     }
864
865     virtual unsigned int length() const { return 1; }
866
867     bool isFloatingOrOutOfFlowPositioned() const { return (isFloating() || isOutOfFlowPositioned()); }
868 #if ENABLE(CSS_SHAPES)
869     bool isFloatingWithShapeOutside() const { return isBox() && isFloating() && style()->shapeOutside(); }
870 #endif
871
872     bool isTransparent() const { return style()->opacity() < 1.0f; }
873     float opacity() const { return style()->opacity(); }
874
875     bool hasReflection() const { return m_bitfields.hasReflection(); }
876
877     // Applied as a "slop" to dirty rect checks during the outline painting phase's dirty-rect checks.
878     int maximalOutlineSize(PaintPhase) const;
879
880     enum SelectionState {
881         SelectionNone, // The object is not selected.
882         SelectionStart, // The object either contains the start of a selection run or is the start of a run
883         SelectionInside, // The object is fully encompassed by a selection run
884         SelectionEnd, // The object either contains the end of a selection run or is the end of a run
885         SelectionBoth // The object contains an entire run or is the sole selected object in that run
886     };
887
888     // The current selection state for an object.  For blocks, the state refers to the state of the leaf
889     // descendants (as described above in the SelectionState enum declaration).
890     SelectionState selectionState() const { return m_bitfields.selectionState(); }
891     virtual void setSelectionState(SelectionState state) { m_bitfields.setSelectionState(state); }
892     inline void setSelectionStateIfNeeded(SelectionState);
893     bool canUpdateSelectionOnRootLineBoxes();
894
895     // A single rectangle that encompasses all of the selected objects within this object.  Used to determine the tightest
896     // possible bounding box for the selection.
897     LayoutRect selectionRect(bool clipToVisibleContent = true) { return selectionRectForRepaint(0, clipToVisibleContent); }
898     virtual LayoutRect selectionRectForRepaint(const RenderLayerModelObject* /*repaintContainer*/, bool /*clipToVisibleContent*/ = true) { return LayoutRect(); }
899
900     virtual bool canBeSelectionLeaf() const { return false; }
901     bool hasSelectedChildren() const { return selectionState() != SelectionNone; }
902
903     // Obtains the selection colors that should be used when painting a selection.
904     Color selectionBackgroundColor() const;
905     Color selectionForegroundColor() const;
906     Color selectionEmphasisMarkColor() const;
907
908     // Whether or not a given block needs to paint selection gaps.
909     virtual bool shouldPaintSelectionGaps() const { return false; }
910
911     /**
912      * Returns the local coordinates of the caret within this render object.
913      * @param caretOffset zero-based offset determining position within the render object.
914      * @param extraWidthToEndOfLine optional out arg to give extra width to end of line -
915      * useful for character range rect computations
916      */
917     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0);
918
919     // When performing a global document tear-down, the renderer of the document is cleared.  We use this
920     // as a hook to detect the case of document destruction and don't waste time doing unnecessary work.
921     bool documentBeingDestroyed() const;
922
923     void destroyAndCleanupAnonymousWrappers();
924     virtual void destroy();
925
926     // Virtual function helpers for the deprecated Flexible Box Layout (display: -webkit-box).
927     virtual bool isDeprecatedFlexibleBox() const { return false; }
928     virtual bool isStretchingChildren() const { return false; }
929
930     // Virtual function helper for the new FlexibleBox Layout (display: -webkit-flex).
931     virtual bool isFlexibleBox() const { return false; }
932
933     bool isFlexibleBoxIncludingDeprecated() const
934     {
935         return isFlexibleBox() || isDeprecatedFlexibleBox();
936     }
937
938     virtual bool isCombineText() const { return false; }
939
940     virtual int caretMinOffset() const;
941     virtual int caretMaxOffset() const;
942
943     virtual int previousOffset(int current) const;
944     virtual int previousOffsetForBackwardDeletion(int current) const;
945     virtual int nextOffset(int current) const;
946
947     virtual void imageChanged(CachedImage*, const IntRect* = 0);
948     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) { }
949     virtual bool willRenderImage(CachedImage*);
950
951     void selectionStartEnd(int& spos, int& epos) const;
952     
953     void remove() { if (parent()) parent()->removeChild(this); }
954
955     AnimationController& animation() const;
956
957     bool visibleToHitTesting() const { return style()->visibility() == VISIBLE && style()->pointerEvents() != PE_NONE; }
958
959     // Map points and quads through elements, potentially via 3d transforms. You should never need to call these directly; use
960     // localToAbsolute/absoluteToLocal methods instead.
961     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags = ApplyContainerFlip, bool* wasFixed = 0) const;
962     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const;
963
964     // Pushes state onto RenderGeometryMap about how to map coordinates from this renderer to its container, or ancestorToStopAt (whichever is encountered first).
965     // Returns the renderer which was mapped to (container or ancestorToStopAt).
966     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const;
967     
968     bool shouldUseTransformFromContainer(const RenderObject* container) const;
969     void getTransformFromContainer(const RenderObject* container, const LayoutSize& offsetInContainer, TransformationMatrix&) const;
970     
971     // return true if this object requires a new stacking context
972     bool createsGroup() const { return isTransparent() || hasMask() || hasFilter() || hasBlendMode(); } 
973     
974     virtual void addFocusRingRects(Vector<IntRect>&, const LayoutPoint& /* additionalOffset */, const RenderLayerModelObject* /* paintContainer */ = 0) { };
975
976     LayoutRect absoluteOutlineBounds() const
977     {
978         return outlineBoundsForRepaint(0);
979     }
980
981     // Return the renderer whose background style is used to paint the root background. Should only be called on the renderer for which isRoot() is true.
982     RenderObject* rendererForRootBackground();
983
984     RespectImageOrientationEnum shouldRespectImageOrientation() const;
985
986 protected:
987     inline bool layerCreationAllowedForSubtree() const;
988
989     // Overrides should call the superclass at the end
990     virtual void styleWillChange(StyleDifference, const RenderStyle* newStyle);
991     // Overrides should call the superclass at the start
992     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
993     void propagateStyleToAnonymousChildren(bool blockChildrenOnly = false);
994
995     void drawLineForBoxSide(GraphicsContext*, int x1, int y1, int x2, int y2, BoxSide,
996                             Color, EBorderStyle, int adjbw1, int adjbw2, bool antialias = false);
997
998     void paintFocusRing(PaintInfo&, const LayoutPoint&, RenderStyle*);
999     void paintOutline(PaintInfo&, const LayoutRect&);
1000     void addPDFURLRect(GraphicsContext*, const LayoutRect&);
1001     
1002     virtual LayoutRect viewRect() const;
1003
1004     void adjustRectForOutlineAndShadow(LayoutRect&) const;
1005
1006     void clearLayoutRootIfNeeded() const;
1007     virtual void willBeDestroyed();
1008     void arenaDelete(RenderArena*, void* objectBase);
1009
1010     virtual bool canBeReplacedWithInlineRunIn() const;
1011
1012     virtual void insertedIntoTree();
1013     virtual void willBeRemovedFromTree();
1014
1015     void setDocumentForAnonymous(Document* document) { ASSERT(isAnonymous()); m_node = document; }
1016
1017 private:
1018     RenderFlowThread* locateFlowThreadContainingBlock() const;
1019     void removeFromRenderFlowThread();
1020     void removeFromRenderFlowThreadRecursive(RenderFlowThread*);
1021
1022     bool shouldRepaintForStyleDifference(StyleDifference) const;
1023     bool hasImmediateNonWhitespaceTextChild() const;
1024
1025     RenderStyle* cachedFirstLineStyle() const;
1026     StyleDifference adjustStyleDifference(StyleDifference, unsigned contextSensitiveProperties) const;
1027
1028     Color selectionColor(int colorProperty) const;
1029
1030     Node* generatingPseudoHostElement() const;
1031
1032 #if ENABLE(CSS_SHAPES)
1033     void removeShapeImageClient(ShapeValue*);
1034 #endif
1035
1036 #ifndef NDEBUG
1037     void checkBlockPositionedObjectsNeedLayout();
1038 #endif
1039
1040     RefPtr<RenderStyle> m_style;
1041
1042     Node* m_node;
1043
1044     RenderObject* m_parent;
1045     RenderObject* m_previous;
1046     RenderObject* m_next;
1047
1048     static RenderObjectAncestorLineboxDirtySet* s_ancestorLineboxDirtySet;
1049
1050 #ifndef NDEBUG
1051     bool m_hasAXObject             : 1;
1052     bool m_setNeedsLayoutForbidden : 1;
1053 #endif
1054
1055 #define ADD_BOOLEAN_BITFIELD(name, Name) \
1056     private:\
1057         unsigned m_##name : 1;\
1058     public:\
1059         bool name() const { return m_##name; }\
1060         void set##Name(bool name) { m_##name = name; }\
1061
1062     class RenderObjectBitfields {
1063         enum PositionedState {
1064             IsStaticallyPositioned = 0,
1065             IsRelativelyPositioned = 1,
1066             IsOutOfFlowPositioned = 2,
1067             IsStickyPositioned = 3
1068         };
1069
1070     public:
1071         RenderObjectBitfields(Node* node)
1072             : m_needsLayout(false)
1073             , m_needsPositionedMovementLayout(false)
1074             , m_normalChildNeedsLayout(false)
1075             , m_posChildNeedsLayout(false)
1076             , m_needsSimplifiedNormalFlowLayout(false)
1077             , m_preferredLogicalWidthsDirty(false)
1078             , m_floating(false)
1079             , m_isAnonymous(!node)
1080             , m_isText(false)
1081             , m_isBox(false)
1082             , m_isInline(true)
1083             , m_isReplaced(false)
1084             , m_horizontalWritingMode(true)
1085             , m_isDragging(false)
1086             , m_hasLayer(false)
1087             , m_hasOverflowClip(false)
1088             , m_hasTransform(false)
1089             , m_hasReflection(false)
1090             , m_hasCounterNodeMap(false)
1091             , m_everHadLayout(false)
1092             , m_childrenInline(false)
1093             , m_hasColumns(false)
1094             , m_positionedState(IsStaticallyPositioned)
1095             , m_selectionState(SelectionNone)
1096             , m_flowThreadState(NotInsideFlowThread)
1097             , m_boxDecorationState(NoBoxDecorations)
1098         {
1099         }
1100         
1101         // 31 bits have been used here. There is one bit available.
1102         ADD_BOOLEAN_BITFIELD(needsLayout, NeedsLayout);
1103         ADD_BOOLEAN_BITFIELD(needsPositionedMovementLayout, NeedsPositionedMovementLayout);
1104         ADD_BOOLEAN_BITFIELD(normalChildNeedsLayout, NormalChildNeedsLayout);
1105         ADD_BOOLEAN_BITFIELD(posChildNeedsLayout, PosChildNeedsLayout);
1106         ADD_BOOLEAN_BITFIELD(needsSimplifiedNormalFlowLayout, NeedsSimplifiedNormalFlowLayout);
1107         ADD_BOOLEAN_BITFIELD(preferredLogicalWidthsDirty, PreferredLogicalWidthsDirty);
1108         ADD_BOOLEAN_BITFIELD(floating, Floating);
1109
1110         ADD_BOOLEAN_BITFIELD(isAnonymous, IsAnonymous);
1111         ADD_BOOLEAN_BITFIELD(isText, IsText);
1112         ADD_BOOLEAN_BITFIELD(isBox, IsBox);
1113         ADD_BOOLEAN_BITFIELD(isInline, IsInline);
1114         ADD_BOOLEAN_BITFIELD(isReplaced, IsReplaced);
1115         ADD_BOOLEAN_BITFIELD(horizontalWritingMode, HorizontalWritingMode);
1116         ADD_BOOLEAN_BITFIELD(isDragging, IsDragging);
1117
1118         ADD_BOOLEAN_BITFIELD(hasLayer, HasLayer);
1119         ADD_BOOLEAN_BITFIELD(hasOverflowClip, HasOverflowClip); // Set in the case of overflow:auto/scroll/hidden
1120         ADD_BOOLEAN_BITFIELD(hasTransform, HasTransform);
1121         ADD_BOOLEAN_BITFIELD(hasReflection, HasReflection);
1122
1123         ADD_BOOLEAN_BITFIELD(hasCounterNodeMap, HasCounterNodeMap);
1124         ADD_BOOLEAN_BITFIELD(everHadLayout, EverHadLayout);
1125
1126         // from RenderBlock
1127         ADD_BOOLEAN_BITFIELD(childrenInline, ChildrenInline);
1128         ADD_BOOLEAN_BITFIELD(hasColumns, HasColumns);
1129
1130     private:
1131         unsigned m_positionedState : 2; // PositionedState
1132         unsigned m_selectionState : 3; // SelectionState
1133         unsigned m_flowThreadState : 2; // FlowThreadState
1134         unsigned m_boxDecorationState : 2; // BoxDecorationState
1135
1136     public:
1137         bool isOutOfFlowPositioned() const { return m_positionedState == IsOutOfFlowPositioned; }
1138         bool isRelPositioned() const { return m_positionedState == IsRelativelyPositioned; }
1139         bool isStickyPositioned() const { return m_positionedState == IsStickyPositioned; }
1140         bool isPositioned() const { return m_positionedState != IsStaticallyPositioned; }
1141
1142         void setPositionedState(int positionState)
1143         {
1144             // This mask maps FixedPosition and AbsolutePosition to IsOutOfFlowPositioned, saving one bit.
1145             m_positionedState = static_cast<PositionedState>(positionState & 0x3);
1146         }
1147         void clearPositionedState() { m_positionedState = StaticPosition; }
1148
1149         ALWAYS_INLINE SelectionState selectionState() const { return static_cast<SelectionState>(m_selectionState); }
1150         ALWAYS_INLINE void setSelectionState(SelectionState selectionState) { m_selectionState = selectionState; }
1151         
1152         ALWAYS_INLINE FlowThreadState flowThreadState() const { return static_cast<FlowThreadState>(m_flowThreadState); }
1153         ALWAYS_INLINE void setFlowThreadState(FlowThreadState flowThreadState) { m_flowThreadState = flowThreadState; }
1154
1155         ALWAYS_INLINE BoxDecorationState boxDecorationState() const { return static_cast<BoxDecorationState>(m_boxDecorationState); }
1156         ALWAYS_INLINE void setBoxDecorationState(BoxDecorationState boxDecorationState) { m_boxDecorationState = boxDecorationState; }
1157     };
1158
1159 #undef ADD_BOOLEAN_BITFIELD
1160
1161     RenderObjectBitfields m_bitfields;
1162
1163     void setNeedsPositionedMovementLayout(bool b) { m_bitfields.setNeedsPositionedMovementLayout(b); }
1164     void setNormalChildNeedsLayout(bool b) { m_bitfields.setNormalChildNeedsLayout(b); }
1165     void setPosChildNeedsLayout(bool b) { m_bitfields.setPosChildNeedsLayout(b); }
1166     void setNeedsSimplifiedNormalFlowLayout(bool b) { m_bitfields.setNeedsSimplifiedNormalFlowLayout(b); }
1167     void setIsDragging(bool b) { m_bitfields.setIsDragging(b); }
1168     void setEverHadLayout(bool b) { m_bitfields.setEverHadLayout(b); }
1169
1170 private:
1171     // Store state between styleWillChange and styleDidChange
1172     static bool s_affectsParentBlock;
1173     static bool s_noLongerAffectsParentBlock;
1174 };
1175
1176 inline bool RenderObject::documentBeingDestroyed() const
1177 {
1178     return document().renderTreeBeingDestroyed();
1179 }
1180
1181 inline bool RenderObject::isBeforeContent() const
1182 {
1183     if (style()->styleType() != BEFORE)
1184         return false;
1185     // Text nodes don't have their own styles, so ignore the style on a text node.
1186     if (isText() && !isBR())
1187         return false;
1188     return true;
1189 }
1190
1191 inline bool RenderObject::isAfterContent() const
1192 {
1193     if (style()->styleType() != AFTER)
1194         return false;
1195     // Text nodes don't have their own styles, so ignore the style on a text node.
1196     if (isText() && !isBR())
1197         return false;
1198     return true;
1199 }
1200
1201 inline bool RenderObject::isBeforeOrAfterContent() const
1202 {
1203     return isBeforeContent() || isAfterContent();
1204 }
1205
1206 inline void RenderObject::setNeedsLayout(bool needsLayout, MarkingBehavior markParents)
1207 {
1208     bool alreadyNeededLayout = m_bitfields.needsLayout();
1209     m_bitfields.setNeedsLayout(needsLayout);
1210     if (needsLayout) {
1211         ASSERT(!isSetNeedsLayoutForbidden());
1212         if (!alreadyNeededLayout) {
1213             if (markParents == MarkContainingBlockChain)
1214                 markContainingBlocksForLayout();
1215             if (hasLayer())
1216                 setLayerNeedsFullRepaint();
1217         }
1218     } else {
1219         setEverHadLayout(true);
1220         setPosChildNeedsLayout(false);
1221         setNeedsSimplifiedNormalFlowLayout(false);
1222         setNormalChildNeedsLayout(false);
1223         setNeedsPositionedMovementLayout(false);
1224         setAncestorLineBoxDirty(false);
1225 #ifndef NDEBUG
1226         checkBlockPositionedObjectsNeedLayout();
1227 #endif
1228     }
1229 }
1230
1231 inline void RenderObject::setChildNeedsLayout(bool childNeedsLayout, MarkingBehavior markParents)
1232 {
1233     bool alreadyNeededLayout = normalChildNeedsLayout();
1234     setNormalChildNeedsLayout(childNeedsLayout);
1235     if (childNeedsLayout) {
1236         ASSERT(!isSetNeedsLayoutForbidden());
1237         if (!alreadyNeededLayout && markParents == MarkContainingBlockChain)
1238             markContainingBlocksForLayout();
1239     } else {
1240         setPosChildNeedsLayout(false);
1241         setNeedsSimplifiedNormalFlowLayout(false);
1242         setNormalChildNeedsLayout(false);
1243         setNeedsPositionedMovementLayout(false);
1244     }
1245 }
1246
1247 inline void RenderObject::setNeedsPositionedMovementLayout(const RenderStyle* oldStyle)
1248 {
1249     bool alreadyNeededLayout = needsPositionedMovementLayout();
1250     setNeedsPositionedMovementLayout(true);
1251     ASSERT(!isSetNeedsLayoutForbidden());
1252     if (!alreadyNeededLayout) {
1253         markContainingBlocksForLayout();
1254         if (hasLayer()) {
1255             if (oldStyle && m_style->diffRequiresRepaint(oldStyle))
1256                 setLayerNeedsFullRepaint();
1257             else
1258                 setLayerNeedsFullRepaintForPositionedMovementLayout();
1259         }
1260     }
1261 }
1262
1263 inline void RenderObject::setNeedsSimplifiedNormalFlowLayout()
1264 {
1265     bool alreadyNeededLayout = needsSimplifiedNormalFlowLayout();
1266     setNeedsSimplifiedNormalFlowLayout(true);
1267     ASSERT(!isSetNeedsLayoutForbidden());
1268     if (!alreadyNeededLayout) {
1269         markContainingBlocksForLayout();
1270         if (hasLayer())
1271             setLayerNeedsFullRepaint();
1272     }
1273 }
1274
1275 inline bool RenderObject::preservesNewline() const
1276 {
1277 #if ENABLE(SVG)
1278     if (isSVGInlineText())
1279         return false;
1280 #endif
1281         
1282     return style()->preserveNewline();
1283 }
1284
1285 inline bool RenderObject::layerCreationAllowedForSubtree() const
1286 {
1287 #if ENABLE(SVG)
1288     RenderObject* parentRenderer = parent();
1289     while (parentRenderer) {
1290         if (parentRenderer->isSVGHiddenContainer())
1291             return false;
1292         parentRenderer = parentRenderer->parent();
1293     }
1294 #endif
1295
1296     return true;
1297 }
1298
1299 inline void RenderObject::setSelectionStateIfNeeded(SelectionState state)
1300 {
1301     if (selectionState() == state)
1302         return;
1303
1304     setSelectionState(state);
1305 }
1306
1307 inline void RenderObject::setHasBoxDecorations(bool b)
1308 {
1309     if (!b) {
1310         m_bitfields.setBoxDecorationState(NoBoxDecorations);
1311         return;
1312     }
1313     if (hasBoxDecorations())
1314         return;
1315     m_bitfields.setBoxDecorationState(HasBoxDecorationsAndBackgroundObscurationStatusInvalid);
1316 }
1317
1318 inline void RenderObject::invalidateBackgroundObscurationStatus()
1319 {
1320     if (!hasBoxDecorations())
1321         return;
1322     m_bitfields.setBoxDecorationState(HasBoxDecorationsAndBackgroundObscurationStatusInvalid);
1323 }
1324
1325 inline bool RenderObject::backgroundIsKnownToBeObscured()
1326 {
1327     if (m_bitfields.boxDecorationState() == HasBoxDecorationsAndBackgroundObscurationStatusInvalid) {
1328         BoxDecorationState boxDecorationState = computeBackgroundIsKnownToBeObscured() ? HasBoxDecorationsAndBackgroundIsKnownToBeObscured : HasBoxDecorationsAndBackgroundMayBeVisible;
1329         m_bitfields.setBoxDecorationState(boxDecorationState);
1330     }
1331     return m_bitfields.boxDecorationState() == HasBoxDecorationsAndBackgroundIsKnownToBeObscured;
1332 }
1333
1334 inline int adjustForAbsoluteZoom(int value, RenderObject* renderer)
1335 {
1336     return adjustForAbsoluteZoom(value, renderer->style());
1337 }
1338
1339 #if ENABLE(SUBPIXEL_LAYOUT)
1340 inline LayoutUnit adjustLayoutUnitForAbsoluteZoom(LayoutUnit value, RenderObject* renderer)
1341 {
1342     return adjustLayoutUnitForAbsoluteZoom(value, renderer->style());
1343 }
1344 #endif
1345
1346 inline void adjustFloatQuadForAbsoluteZoom(FloatQuad& quad, RenderObject* renderer)
1347 {
1348     float zoom = renderer->style()->effectiveZoom();
1349     if (zoom != 1)
1350         quad.scale(1 / zoom, 1 / zoom);
1351 }
1352
1353 inline void adjustFloatRectForAbsoluteZoom(FloatRect& rect, RenderObject* renderer)
1354 {
1355     float zoom = renderer->style()->effectiveZoom();
1356     if (zoom != 1)
1357         rect.scale(1 / zoom, 1 / zoom);
1358 }
1359
1360 } // namespace WebCore
1361
1362 #ifndef NDEBUG
1363 // Outside the WebCore namespace for ease of invocation from gdb.
1364 void showTree(const WebCore::RenderObject*);
1365 void showLineTree(const WebCore::RenderObject*);
1366 void showRenderTree(const WebCore::RenderObject* object1);
1367 // We don't make object2 an optional parameter so that showRenderTree
1368 // can be called from gdb easily.
1369 void showRenderTree(const WebCore::RenderObject* object1, const WebCore::RenderObject* object2);
1370 #endif
1371
1372 #endif // RenderObject_h