f30436ad0de208fd218cbed22f7507f57a75acc8
[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 isRenderView() const { return false; }
360     virtual bool isReplica() const { return false; }
361
362     virtual bool isRuby() const { return false; }
363     virtual bool isRubyBase() const { return false; }
364     virtual bool isRubyRun() const { return false; }
365     virtual bool isRubyText() const { return false; }
366
367     virtual bool isSlider() const { return false; }
368     virtual bool isSliderThumb() const { return false; }
369     virtual bool isTable() const { return false; }
370     virtual bool isTableCell() const { return false; }
371     virtual bool isRenderTableCol() const { return false; }
372     virtual bool isTableCaption() const { return false; }
373     virtual bool isTableRow() const { return false; }
374     virtual bool isTableSection() const { return false; }
375     virtual bool isTextControl() const { return false; }
376     virtual bool isTextArea() const { return false; }
377     virtual bool isTextField() const { return false; }
378     virtual bool isVideo() const { return false; }
379     virtual bool isWidget() const { return false; }
380     virtual bool isCanvas() const { return false; }
381 #if ENABLE(FULLSCREEN_API)
382     virtual bool isRenderFullScreen() const { return false; }
383     virtual bool isRenderFullScreenPlaceholder() const { return false; }
384 #endif
385
386     virtual bool isRenderGrid() const { return false; }
387
388     virtual bool isRenderFlowThread() const { return false; }
389     virtual bool isRenderNamedFlowThread() const { return false; }
390     bool isInFlowRenderFlowThread() const { return isRenderFlowThread() && !isOutOfFlowPositioned(); }
391     bool isOutOfFlowRenderFlowThread() const { return isRenderFlowThread() && isOutOfFlowPositioned(); }
392
393     virtual bool isRenderMultiColumnBlock() const { return false; }
394     virtual bool isRenderMultiColumnSet() const { return false; }
395
396     virtual bool isRenderScrollbarPart() const { return false; }
397
398     bool isRoot() const { return document().documentElement() == m_node; }
399     bool isBody() const;
400     bool isHR() const;
401     bool isLegend() const;
402
403     bool isHTMLMarquee() const;
404
405     bool isTablePart() const { return isTableCell() || isRenderTableCol() || isTableCaption() || isTableRow() || isTableSection(); }
406
407     inline bool isBeforeContent() const;
408     inline bool isAfterContent() const;
409     inline bool isBeforeOrAfterContent() const;
410     static inline bool isBeforeContent(const RenderObject* obj) { return obj && obj->isBeforeContent(); }
411     static inline bool isAfterContent(const RenderObject* obj) { return obj && obj->isAfterContent(); }
412     static inline bool isBeforeOrAfterContent(const RenderObject* obj) { return obj && obj->isBeforeOrAfterContent(); }
413
414     bool hasCounterNodeMap() const { return m_bitfields.hasCounterNodeMap(); }
415     void setHasCounterNodeMap(bool hasCounterNodeMap) { m_bitfields.setHasCounterNodeMap(hasCounterNodeMap); }
416     bool everHadLayout() const { return m_bitfields.everHadLayout(); }
417
418     bool childrenInline() const { return m_bitfields.childrenInline(); }
419     void setChildrenInline(bool b) { m_bitfields.setChildrenInline(b); }
420     bool hasColumns() const { return m_bitfields.hasColumns(); }
421     void setHasColumns(bool b = true) { m_bitfields.setHasColumns(b); }
422
423     bool ancestorLineBoxDirty() const { return s_ancestorLineboxDirtySet && s_ancestorLineboxDirtySet->contains(this); }
424     void setAncestorLineBoxDirty(bool b = true)
425     {
426         if (b) {
427             if (!s_ancestorLineboxDirtySet)
428                 s_ancestorLineboxDirtySet = new RenderObjectAncestorLineboxDirtySet;
429             s_ancestorLineboxDirtySet->add(this);
430             setNeedsLayout(true);
431         } else if (s_ancestorLineboxDirtySet) {
432             s_ancestorLineboxDirtySet->remove(this);
433             if (s_ancestorLineboxDirtySet->isEmpty()) {
434                 delete s_ancestorLineboxDirtySet;
435                 s_ancestorLineboxDirtySet = 0;
436             }
437         }
438     }
439
440     enum FlowThreadState {
441         NotInsideFlowThread = 0,
442         InsideOutOfFlowThread = 1,
443         InsideInFlowThread = 2,
444     };
445
446     void setFlowThreadStateIncludingDescendants(FlowThreadState);
447
448     FlowThreadState flowThreadState() const { return m_bitfields.flowThreadState(); }
449     void setFlowThreadState(FlowThreadState state) { m_bitfields.setFlowThreadState(state); }
450
451     virtual bool requiresForcedStyleRecalcPropagation() const { return false; }
452
453 #if ENABLE(MATHML)
454     virtual bool isRenderMathMLBlock() const { return false; }
455 #endif // ENABLE(MATHML)
456
457 #if ENABLE(SVG)
458     // FIXME: Until all SVG renders can be subclasses of RenderSVGModelObject we have
459     // to add SVG renderer methods to RenderObject with an ASSERT_NOT_REACHED() default implementation.
460     virtual bool isSVGRoot() const { return false; }
461     virtual bool isSVGContainer() const { return false; }
462     virtual bool isSVGTransformableContainer() const { return false; }
463     virtual bool isSVGViewportContainer() const { return false; }
464     virtual bool isSVGGradientStop() const { return false; }
465     virtual bool isSVGHiddenContainer() const { return false; }
466     virtual bool isSVGPath() const { return false; }
467     virtual bool isSVGShape() const { return false; }
468     virtual bool isSVGText() const { return false; }
469     virtual bool isSVGTextPath() const { return false; }
470     virtual bool isSVGInline() const { return false; }
471     virtual bool isSVGInlineText() const { return false; }
472     virtual bool isSVGImage() const { return false; }
473     virtual bool isSVGForeignObject() const { return false; }
474     virtual bool isSVGResourceContainer() const { return false; }
475     virtual bool isSVGResourceFilter() const { return false; }
476     virtual bool isSVGResourceFilterPrimitive() const { return false; }
477
478     virtual RenderSVGResourceContainer* toRenderSVGResourceContainer();
479
480     // FIXME: Those belong into a SVG specific base-class for all renderers (see above)
481     // Unfortunately we don't have such a class yet, because it's not possible for all renderers
482     // to inherit from RenderSVGObject -> RenderObject (some need RenderBlock inheritance for instance)
483     virtual void setNeedsTransformUpdate() { }
484     virtual void setNeedsBoundariesUpdate();
485     virtual bool needsBoundariesUpdate() { return false; }
486
487     // Per SVG 1.1 objectBoundingBox ignores clipping, masking, filter effects, opacity and stroke-width.
488     // This is used for all computation of objectBoundingBox relative units and by SVGLocatable::getBBox().
489     // NOTE: Markers are not specifically ignored here by SVG 1.1 spec, but we ignore them
490     // since stroke-width is ignored (and marker size can depend on stroke-width).
491     // objectBoundingBox is returned local coordinates.
492     // The name objectBoundingBox is taken from the SVG 1.1 spec.
493     virtual FloatRect objectBoundingBox() const;
494     virtual FloatRect strokeBoundingBox() const;
495
496     // Returns the smallest rectangle enclosing all of the painted content
497     // respecting clipping, masking, filters, opacity, stroke-width and markers
498     virtual FloatRect repaintRectInLocalCoordinates() const;
499
500     // This only returns the transform="" value from the element
501     // most callsites want localToParentTransform() instead.
502     virtual AffineTransform localTransform() const;
503
504     // Returns the full transform mapping from local coordinates to local coords for the parent SVG renderer
505     // This includes any viewport transforms and x/y offsets as well as the transform="" value off the element.
506     virtual const AffineTransform& localToParentTransform() const;
507
508     // SVG uses FloatPoint precise hit testing, and passes the point in parent
509     // coordinates instead of in repaint container coordinates.  Eventually the
510     // rest of the rendering tree will move to a similar model.
511     virtual bool nodeAtFloatPoint(const HitTestRequest&, HitTestResult&, const FloatPoint& pointInParent, HitTestAction);
512 #endif
513
514     bool hasAspectRatio() const { return isReplaced() && (isImage() || isVideo() || isCanvas()); }
515     bool isAnonymous() const { return m_bitfields.isAnonymous(); }
516     bool isAnonymousBlock() const
517     {
518         // This function is kept in sync with anonymous block creation conditions in
519         // RenderBlock::createAnonymousBlock(). This includes creating an anonymous
520         // RenderBlock having a BLOCK or BOX display. Other classes such as RenderTextFragment
521         // are not RenderBlocks and will return false. See https://bugs.webkit.org/show_bug.cgi?id=56709. 
522         return isAnonymous() && (style()->display() == BLOCK || style()->display() == BOX) && style()->styleType() == NOPSEUDO && isRenderBlock() && !isListMarker() && !isRenderFlowThread()
523 #if ENABLE(FULLSCREEN_API)
524             && !isRenderFullScreen()
525             && !isRenderFullScreenPlaceholder()
526 #endif
527 #if ENABLE(MATHML)
528             && !isRenderMathMLBlock()
529 #endif
530             ;
531     }
532     bool isAnonymousColumnsBlock() const { return style()->specifiesColumns() && isAnonymousBlock(); }
533     bool isAnonymousColumnSpanBlock() const { return style()->columnSpan() && isAnonymousBlock(); }
534     bool isElementContinuation() const { return node() && node()->renderer() != this; }
535     bool isInlineElementContinuation() const { return isElementContinuation() && isInline(); }
536     bool isBlockElementContinuation() const { return isElementContinuation() && !isInline(); }
537     virtual RenderBoxModelObject* virtualContinuation() const { return 0; }
538
539     bool isFloating() const { return m_bitfields.floating(); }
540
541     bool isOutOfFlowPositioned() const { return m_bitfields.isOutOfFlowPositioned(); } // absolute or fixed positioning
542     bool isInFlowPositioned() const { return m_bitfields.isRelPositioned() || m_bitfields.isStickyPositioned(); } // relative or sticky positioning
543     bool isRelPositioned() const { return m_bitfields.isRelPositioned(); } // relative positioning
544     bool isStickyPositioned() const { return m_bitfields.isStickyPositioned(); }
545     bool isPositioned() const { return m_bitfields.isPositioned(); }
546
547     bool isText() const  { return m_bitfields.isText(); }
548     bool isBox() const { return m_bitfields.isBox(); }
549     bool isInline() const { return m_bitfields.isInline(); } // inline object
550     bool isRunIn() const { return style()->display() == RUN_IN; } // run-in object
551     bool isDragging() const { return m_bitfields.isDragging(); }
552     bool isReplaced() const { return m_bitfields.isReplaced(); } // a "replaced" element (see CSS)
553     bool isHorizontalWritingMode() const { return m_bitfields.horizontalWritingMode(); }
554
555     bool hasLayer() const { return m_bitfields.hasLayer(); }
556
557     enum BoxDecorationState {
558         NoBoxDecorations,
559         HasBoxDecorationsAndBackgroundObscurationStatusInvalid,
560         HasBoxDecorationsAndBackgroundIsKnownToBeObscured,
561         HasBoxDecorationsAndBackgroundMayBeVisible,
562     };
563     bool hasBoxDecorations() const { return m_bitfields.boxDecorationState() != NoBoxDecorations; }
564     bool backgroundIsKnownToBeObscured();
565     bool borderImageIsLoadedAndCanBeRendered() const;
566     bool mustRepaintBackgroundOrBorder() const;
567     bool hasBackground() const { return style()->hasBackground(); }
568     bool hasEntirelyFixedBackground() const;
569
570     bool needsLayout() const
571     {
572         return m_bitfields.needsLayout() || m_bitfields.normalChildNeedsLayout() || m_bitfields.posChildNeedsLayout()
573             || m_bitfields.needsSimplifiedNormalFlowLayout() || m_bitfields.needsPositionedMovementLayout();
574     }
575
576     bool selfNeedsLayout() const { return m_bitfields.needsLayout(); }
577     bool needsPositionedMovementLayout() const { return m_bitfields.needsPositionedMovementLayout(); }
578     bool needsPositionedMovementLayoutOnly() const
579     {
580         return m_bitfields.needsPositionedMovementLayout() && !m_bitfields.needsLayout() && !m_bitfields.normalChildNeedsLayout()
581             && !m_bitfields.posChildNeedsLayout() && !m_bitfields.needsSimplifiedNormalFlowLayout();
582     }
583
584     bool posChildNeedsLayout() const { return m_bitfields.posChildNeedsLayout(); }
585     bool needsSimplifiedNormalFlowLayout() const { return m_bitfields.needsSimplifiedNormalFlowLayout(); }
586     bool normalChildNeedsLayout() const { return m_bitfields.normalChildNeedsLayout(); }
587     
588     bool preferredLogicalWidthsDirty() const { return m_bitfields.preferredLogicalWidthsDirty(); }
589
590     bool isSelectionBorder() const;
591
592     bool hasClip() const { return isOutOfFlowPositioned() && style()->hasClip(); }
593     bool hasOverflowClip() const { return m_bitfields.hasOverflowClip(); }
594     bool hasClipOrOverflowClip() const { return hasClip() || hasOverflowClip(); }
595
596     bool hasTransform() const { return m_bitfields.hasTransform(); }
597     bool hasMask() const { return style() && style()->hasMask(); }
598     bool hasClipPath() const { return style() && style()->clipPath(); }
599     bool hasHiddenBackface() const { return style() && style()->backfaceVisibility() == BackfaceVisibilityHidden; }
600
601 #if ENABLE(CSS_FILTERS)
602     bool hasFilter() const { return style() && style()->hasFilter(); }
603 #else
604     bool hasFilter() const { return false; }
605 #endif
606
607 #if ENABLE(CSS_COMPOSITING)
608     bool hasBlendMode() const { return style() && style()->hasBlendMode(); }
609 #else
610     bool hasBlendMode() const { return false; }
611 #endif
612
613     inline bool preservesNewline() const;
614
615     // The pseudo element style can be cached or uncached.  Use the cached method if the pseudo element doesn't respect
616     // any pseudo classes (and therefore has no concept of changing state).
617     RenderStyle* getCachedPseudoStyle(PseudoId, RenderStyle* parentStyle = 0) const;
618     PassRefPtr<RenderStyle> getUncachedPseudoStyle(const PseudoStyleRequest&, RenderStyle* parentStyle = 0, RenderStyle* ownStyle = 0) const;
619     
620     virtual void updateDragState(bool dragOn);
621
622     RenderView& view() const { return *document().renderView(); };
623
624     // Returns true if this renderer is rooted, and optionally returns the hosting view (the root of the hierarchy).
625     bool isRooted(RenderView** = 0) const;
626
627     Node* node() const { return isAnonymous() ? 0 : m_node; }
628     Node* nonPseudoNode() const { return isPseudoElement() ? 0 : node(); }
629
630     // FIXME: Why does RenderWidget need this?
631     void clearNode() { m_node = 0; }
632
633     // Returns the styled node that caused the generation of this renderer.
634     // This is the same as node() except for renderers of :before and :after
635     // pseudo elements for which their parent node is returned.
636     Node* generatingNode() const { return isPseudoElement() ? generatingPseudoHostElement() : node(); }
637
638     Document& document() const { return *m_node->document(); }
639     Frame& frame() const; // Defined in RenderView.h
640
641     bool hasOutlineAnnotation() const;
642     bool hasOutline() const { return style()->hasOutline() || hasOutlineAnnotation(); }
643
644     // Returns the object containing this one. Can be different from parent for positioned elements.
645     // If repaintContainer and repaintContainerSkipped are not null, on return *repaintContainerSkipped
646     // is true if the renderer returned is an ancestor of repaintContainer.
647     RenderObject* container(const RenderLayerModelObject* repaintContainer = 0, bool* repaintContainerSkipped = 0) const;
648
649     virtual RenderObject* hoverAncestor() const;
650
651     RenderBoxModelObject* offsetParent() const;
652
653     void markContainingBlocksForLayout(bool scheduleRelayout = true, RenderObject* newRoot = 0);
654     void setNeedsLayout(bool needsLayout, MarkingBehavior = MarkContainingBlockChain);
655     void setChildNeedsLayout(bool childNeedsLayout, MarkingBehavior = MarkContainingBlockChain);
656     void setNeedsPositionedMovementLayout(const RenderStyle* oldStyle);
657     void setNeedsSimplifiedNormalFlowLayout();
658     void setPreferredLogicalWidthsDirty(bool, MarkingBehavior = MarkContainingBlockChain);
659     void invalidateContainerPreferredLogicalWidths();
660     
661     void setNeedsLayoutAndPrefWidthsRecalc()
662     {
663         setNeedsLayout(true);
664         setPreferredLogicalWidthsDirty(true);
665     }
666
667     void setPositionState(EPosition position)
668     {
669         ASSERT((position != AbsolutePosition && position != FixedPosition) || isBox());
670         m_bitfields.setPositionedState(position);
671     }
672     void clearPositionedState() { m_bitfields.clearPositionedState(); }
673
674     void setFloating(bool b = true) { m_bitfields.setFloating(b); }
675     void setInline(bool b = true) { m_bitfields.setIsInline(b); }
676
677     void setHasBoxDecorations(bool = true);
678     void invalidateBackgroundObscurationStatus();
679     virtual bool computeBackgroundIsKnownToBeObscured() { return false; }
680
681     void setIsText() { m_bitfields.setIsText(true); }
682     void setIsBox() { m_bitfields.setIsBox(true); }
683     void setReplaced(bool b = true) { m_bitfields.setIsReplaced(b); }
684     void setHorizontalWritingMode(bool b = true) { m_bitfields.setHorizontalWritingMode(b); }
685     void setHasOverflowClip(bool b = true) { m_bitfields.setHasOverflowClip(b); }
686     void setHasLayer(bool b = true) { m_bitfields.setHasLayer(b); }
687     void setHasTransform(bool b = true) { m_bitfields.setHasTransform(b); }
688     void setHasReflection(bool b = true) { m_bitfields.setHasReflection(b); }
689
690     void scheduleRelayout();
691
692     void updateFillImages(const FillLayer*, const FillLayer*);
693     void updateImage(StyleImage*, StyleImage*);
694 #if ENABLE(CSS_SHAPES)
695     void updateShapeImage(const ShapeValue*, const ShapeValue*);
696 #endif
697
698     virtual void paint(PaintInfo&, const LayoutPoint&);
699
700     // Recursive function that computes the size and position of this object and all its descendants.
701     virtual void layout();
702
703     /* This function performs a layout only if one is needed. */
704     void layoutIfNeeded() { if (needsLayout()) layout(); }
705     
706     // used for element state updates that cannot be fixed with a
707     // repaint and do not need a relayout
708     virtual void updateFromElement() { }
709
710 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
711     virtual void addAnnotatedRegions(Vector<AnnotatedRegionValue>&);
712     void collectAnnotatedRegions(Vector<AnnotatedRegionValue>&);
713 #endif
714
715     bool isComposited() const;
716
717     bool hitTest(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestFilter = HitTestAll);
718     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&);
719     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
720
721     virtual VisiblePosition positionForPoint(const LayoutPoint&);
722     VisiblePosition createVisiblePosition(int offset, EAffinity);
723     VisiblePosition createVisiblePosition(const Position&);
724
725     virtual void dirtyLinesFromChangedChild(RenderObject*);
726
727     // Called to update a style that is allowed to trigger animations.
728     // FIXME: Right now this will typically be called only when updating happens from the DOM on explicit elements.
729     // We don't yet handle generated content animation such as first-letter or before/after (we'll worry about this later).
730     void setAnimatableStyle(PassRefPtr<RenderStyle>);
731
732     // Set the style of the object and update the state of the object accordingly.
733     virtual void setStyle(PassRefPtr<RenderStyle>);
734
735     // Set the style of the object if it's generated content.
736     void setPseudoStyle(PassRefPtr<RenderStyle>);
737
738     // Updates only the local style ptr of the object.  Does not update the state of the object,
739     // and so only should be called when the style is known not to have changed (or from setStyle).
740     void setStyleInternal(PassRefPtr<RenderStyle> style) { m_style = style; }
741
742     // returns the containing block level element for this element.
743     RenderBlock* containingBlock() const;
744
745     bool canContainFixedPositionObjects() const
746     {
747         return isRenderView() || (hasTransform() && isRenderBlock())
748 #if ENABLE(SVG)
749                 || isSVGForeignObject()
750 #endif
751                 || isOutOfFlowRenderFlowThread();
752     }
753
754     // Convert the given local point to absolute coordinates
755     // FIXME: Temporary. If UseTransforms is true, take transforms into account. Eventually localToAbsolute() will always be transform-aware.
756     FloatPoint localToAbsolute(const FloatPoint& localPoint = FloatPoint(), MapCoordinatesFlags = 0) const;
757     FloatPoint absoluteToLocal(const FloatPoint&, MapCoordinatesFlags = 0) const;
758
759     // Convert a local quad to absolute coordinates, taking transforms into account.
760     FloatQuad localToAbsoluteQuad(const FloatQuad& quad, MapCoordinatesFlags mode = 0, bool* wasFixed = 0) const
761     {
762         return localToContainerQuad(quad, 0, mode, wasFixed);
763     }
764     // Convert an absolute quad to local coordinates.
765     FloatQuad absoluteToLocalQuad(const FloatQuad&, MapCoordinatesFlags mode = 0) const;
766
767     // Convert a local quad into the coordinate system of container, taking transforms into account.
768     FloatQuad localToContainerQuad(const FloatQuad&, const RenderLayerModelObject* repaintContainer, MapCoordinatesFlags = 0, bool* wasFixed = 0) const;
769     FloatPoint localToContainerPoint(const FloatPoint&, const RenderLayerModelObject* repaintContainer, MapCoordinatesFlags = 0, bool* wasFixed = 0) const;
770
771     // Return the offset from the container() renderer (excluding transforms). In multi-column layout,
772     // different offsets apply at different points, so return the offset that applies to the given point.
773     virtual LayoutSize offsetFromContainer(RenderObject*, const LayoutPoint&, bool* offsetDependsOnPoint = 0) const;
774     // Return the offset from an object up the container() chain. Asserts that none of the intermediate objects have transforms.
775     LayoutSize offsetFromAncestorContainer(RenderObject*) const;
776     
777     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint&) const { }
778
779     // FIXME: useTransforms should go away eventually
780     IntRect absoluteBoundingBoxRect(bool useTransform = true) const;
781     IntRect absoluteBoundingBoxRectIgnoringTransforms() const { return absoluteBoundingBoxRect(false); }
782
783     // Build an array of quads in absolute coords for line boxes
784     virtual void absoluteQuads(Vector<FloatQuad>&, bool* /*wasFixed*/ = 0) const { }
785
786     virtual void absoluteFocusRingQuads(Vector<FloatQuad>&);
787
788     static FloatRect absoluteBoundingBoxRectForRange(const Range*);
789
790     // the rect that will be painted if this object is passed as the paintingRoot
791     LayoutRect paintingRootRect(LayoutRect& topLevelRect);
792
793     virtual LayoutUnit minPreferredLogicalWidth() const { return 0; }
794     virtual LayoutUnit maxPreferredLogicalWidth() const { return 0; }
795
796     RenderStyle* style() const { return m_style.get(); }
797     RenderStyle* firstLineStyle() const { return document().styleSheetCollection()->usesFirstLineRules() ? cachedFirstLineStyle() : style(); }
798     RenderStyle* style(bool firstLine) const { return firstLine ? firstLineStyle() : style(); }
799
800     // Used only by Element::pseudoStyleCacheIsInvalid to get a first line style based off of a
801     // given new style, without accessing the cache.
802     PassRefPtr<RenderStyle> uncachedFirstLineStyle(RenderStyle*) const;
803
804     // Anonymous blocks that are part of of a continuation chain will return their inline continuation's outline style instead.
805     // This is typically only relevant when repainting.
806     virtual RenderStyle* outlineStyleForRepaint() const { return style(); }
807     
808     virtual CursorDirective getCursor(const LayoutPoint&, Cursor&) const;
809
810     void getTextDecorationColors(int decorations, Color& underline, Color& overline, Color& linethrough, bool quirksMode = false, bool firstlineStyle = false);
811
812     // Return the RenderLayerModelObject in the container chain which is responsible for painting this object, or 0
813     // if painting is root-relative. This is the container that should be passed to the 'forRepaint'
814     // methods.
815     RenderLayerModelObject* containerForRepaint() const;
816     // Actually do the repaint of rect r for this object which has been computed in the coordinate space
817     // of repaintContainer. If repaintContainer is 0, repaint via the view.
818     void repaintUsingContainer(const RenderLayerModelObject* repaintContainer, const IntRect&, bool immediate = false) const;
819     
820     // Repaint the entire object.  Called when, e.g., the color of a border changes, or when a border
821     // style changes.
822     void repaint(bool immediate = false) const;
823
824     // Repaint a specific subrectangle within a given object.  The rect |r| is in the object's coordinate space.
825     void repaintRectangle(const LayoutRect&, bool immediate = false) const;
826
827     // Repaint only if our old bounds and new bounds are different. The caller may pass in newBounds and newOutlineBox if they are known.
828     bool repaintAfterLayoutIfNeeded(const RenderLayerModelObject* repaintContainer, const LayoutRect& oldBounds, const LayoutRect& oldOutlineBox, const LayoutRect* newBoundsPtr = 0, const LayoutRect* newOutlineBoxPtr = 0);
829
830     bool checkForRepaintDuringLayout() const;
831
832     // Returns the rect that should be repainted whenever this object changes.  The rect is in the view's
833     // coordinate space.  This method deals with outlines and overflow.
834     LayoutRect absoluteClippedOverflowRect() const
835     {
836         return clippedOverflowRectForRepaint(0);
837     }
838     IntRect pixelSnappedAbsoluteClippedOverflowRect() const;
839     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const;
840     virtual LayoutRect rectWithOutlineForRepaint(const RenderLayerModelObject* repaintContainer, LayoutUnit outlineWidth) const;
841     virtual LayoutRect outlineBoundsForRepaint(const RenderLayerModelObject* /*repaintContainer*/, const RenderGeometryMap* = 0) const { return LayoutRect(); }
842
843     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
844     // that rect in view coordinates.
845     void computeAbsoluteRepaintRect(LayoutRect& r, bool fixed = false) const
846     {
847         computeRectForRepaint(0, r, fixed);
848     }
849     // Given a rect in the object's coordinate space, compute a rect suitable for repainting
850     // that rect in the coordinate space of repaintContainer.
851     virtual void computeRectForRepaint(const RenderLayerModelObject* repaintContainer, LayoutRect&, bool fixed = false) const;
852     virtual void computeFloatRectForRepaint(const RenderLayerModelObject* repaintContainer, FloatRect& repaintRect, bool fixed = false) const;
853
854     // If multiple-column layout results in applying an offset to the given point, add the same
855     // offset to the given size.
856     virtual void adjustForColumns(LayoutSize&, const LayoutPoint&) const { }
857     LayoutSize offsetForColumns(const LayoutPoint& point) const
858     {
859         LayoutSize offset;
860         adjustForColumns(offset, point);
861         return offset;
862     }
863
864     virtual unsigned int length() const { return 1; }
865
866     bool isFloatingOrOutOfFlowPositioned() const { return (isFloating() || isOutOfFlowPositioned()); }
867 #if ENABLE(CSS_SHAPES)
868     bool isFloatingWithShapeOutside() const { return isBox() && isFloating() && style()->shapeOutside(); }
869 #endif
870
871     bool isTransparent() const { return style()->opacity() < 1.0f; }
872     float opacity() const { return style()->opacity(); }
873
874     bool hasReflection() const { return m_bitfields.hasReflection(); }
875
876     // Applied as a "slop" to dirty rect checks during the outline painting phase's dirty-rect checks.
877     int maximalOutlineSize(PaintPhase) const;
878
879     enum SelectionState {
880         SelectionNone, // The object is not selected.
881         SelectionStart, // The object either contains the start of a selection run or is the start of a run
882         SelectionInside, // The object is fully encompassed by a selection run
883         SelectionEnd, // The object either contains the end of a selection run or is the end of a run
884         SelectionBoth // The object contains an entire run or is the sole selected object in that run
885     };
886
887     // The current selection state for an object.  For blocks, the state refers to the state of the leaf
888     // descendants (as described above in the SelectionState enum declaration).
889     SelectionState selectionState() const { return m_bitfields.selectionState(); }
890     virtual void setSelectionState(SelectionState state) { m_bitfields.setSelectionState(state); }
891     inline void setSelectionStateIfNeeded(SelectionState);
892     bool canUpdateSelectionOnRootLineBoxes();
893
894     // A single rectangle that encompasses all of the selected objects within this object.  Used to determine the tightest
895     // possible bounding box for the selection.
896     LayoutRect selectionRect(bool clipToVisibleContent = true) { return selectionRectForRepaint(0, clipToVisibleContent); }
897     virtual LayoutRect selectionRectForRepaint(const RenderLayerModelObject* /*repaintContainer*/, bool /*clipToVisibleContent*/ = true) { return LayoutRect(); }
898
899     virtual bool canBeSelectionLeaf() const { return false; }
900     bool hasSelectedChildren() const { return selectionState() != SelectionNone; }
901
902     // Obtains the selection colors that should be used when painting a selection.
903     Color selectionBackgroundColor() const;
904     Color selectionForegroundColor() const;
905     Color selectionEmphasisMarkColor() const;
906
907     // Whether or not a given block needs to paint selection gaps.
908     virtual bool shouldPaintSelectionGaps() const { return false; }
909
910     /**
911      * Returns the local coordinates of the caret within this render object.
912      * @param caretOffset zero-based offset determining position within the render object.
913      * @param extraWidthToEndOfLine optional out arg to give extra width to end of line -
914      * useful for character range rect computations
915      */
916     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0);
917
918     // When performing a global document tear-down, the renderer of the document is cleared.  We use this
919     // as a hook to detect the case of document destruction and don't waste time doing unnecessary work.
920     bool documentBeingDestroyed() const;
921
922     void destroyAndCleanupAnonymousWrappers();
923     virtual void destroy();
924
925     // Virtual function helpers for the deprecated Flexible Box Layout (display: -webkit-box).
926     virtual bool isDeprecatedFlexibleBox() const { return false; }
927     virtual bool isStretchingChildren() const { return false; }
928
929     // Virtual function helper for the new FlexibleBox Layout (display: -webkit-flex).
930     virtual bool isFlexibleBox() const { return false; }
931
932     bool isFlexibleBoxIncludingDeprecated() const
933     {
934         return isFlexibleBox() || isDeprecatedFlexibleBox();
935     }
936
937     virtual bool isCombineText() const { return false; }
938
939     virtual int caretMinOffset() const;
940     virtual int caretMaxOffset() const;
941
942     virtual int previousOffset(int current) const;
943     virtual int previousOffsetForBackwardDeletion(int current) const;
944     virtual int nextOffset(int current) const;
945
946     virtual void imageChanged(CachedImage*, const IntRect* = 0);
947     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) { }
948     virtual bool willRenderImage(CachedImage*);
949
950     void selectionStartEnd(int& spos, int& epos) const;
951     
952     void remove() { if (parent()) parent()->removeChild(this); }
953
954     AnimationController& animation() const;
955
956     bool visibleToHitTesting() const { return style()->visibility() == VISIBLE && style()->pointerEvents() != PE_NONE; }
957
958     // Map points and quads through elements, potentially via 3d transforms. You should never need to call these directly; use
959     // localToAbsolute/absoluteToLocal methods instead.
960     virtual void mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState&, MapCoordinatesFlags = ApplyContainerFlip, bool* wasFixed = 0) const;
961     virtual void mapAbsoluteToLocalPoint(MapCoordinatesFlags, TransformState&) const;
962
963     // Pushes state onto RenderGeometryMap about how to map coordinates from this renderer to its container, or ancestorToStopAt (whichever is encountered first).
964     // Returns the renderer which was mapped to (container or ancestorToStopAt).
965     virtual const RenderObject* pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap&) const;
966     
967     bool shouldUseTransformFromContainer(const RenderObject* container) const;
968     void getTransformFromContainer(const RenderObject* container, const LayoutSize& offsetInContainer, TransformationMatrix&) const;
969     
970     // return true if this object requires a new stacking context
971     bool createsGroup() const { return isTransparent() || hasMask() || hasFilter() || hasBlendMode(); } 
972     
973     virtual void addFocusRingRects(Vector<IntRect>&, const LayoutPoint& /* additionalOffset */, const RenderLayerModelObject* /* paintContainer */ = 0) { };
974
975     LayoutRect absoluteOutlineBounds() const
976     {
977         return outlineBoundsForRepaint(0);
978     }
979
980     // 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.
981     RenderObject* rendererForRootBackground();
982
983     RespectImageOrientationEnum shouldRespectImageOrientation() const;
984
985 protected:
986     inline bool layerCreationAllowedForSubtree() const;
987
988     // Overrides should call the superclass at the end
989     virtual void styleWillChange(StyleDifference, const RenderStyle* newStyle);
990     // Overrides should call the superclass at the start
991     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
992     void propagateStyleToAnonymousChildren(bool blockChildrenOnly = false);
993
994     void drawLineForBoxSide(GraphicsContext*, int x1, int y1, int x2, int y2, BoxSide,
995                             Color, EBorderStyle, int adjbw1, int adjbw2, bool antialias = false);
996
997     void paintFocusRing(PaintInfo&, const LayoutPoint&, RenderStyle*);
998     void paintOutline(PaintInfo&, const LayoutRect&);
999     void addPDFURLRect(GraphicsContext*, const LayoutRect&);
1000     
1001     virtual LayoutRect viewRect() const;
1002
1003     void adjustRectForOutlineAndShadow(LayoutRect&) const;
1004
1005     void clearLayoutRootIfNeeded() const;
1006     virtual void willBeDestroyed();
1007     void arenaDelete(RenderArena*, void* objectBase);
1008
1009     virtual bool canBeReplacedWithInlineRunIn() const;
1010
1011     virtual void insertedIntoTree();
1012     virtual void willBeRemovedFromTree();
1013
1014     void setDocumentForAnonymous(Document* document) { ASSERT(isAnonymous()); m_node = document; }
1015
1016 private:
1017     RenderFlowThread* locateFlowThreadContainingBlock() const;
1018     void removeFromRenderFlowThread();
1019     void removeFromRenderFlowThreadRecursive(RenderFlowThread*);
1020
1021     bool shouldRepaintForStyleDifference(StyleDifference) const;
1022     bool hasImmediateNonWhitespaceTextChild() const;
1023
1024     RenderStyle* cachedFirstLineStyle() const;
1025     StyleDifference adjustStyleDifference(StyleDifference, unsigned contextSensitiveProperties) const;
1026
1027     Color selectionColor(int colorProperty) const;
1028
1029     Node* generatingPseudoHostElement() const;
1030
1031 #if ENABLE(CSS_SHAPES)
1032     void removeShapeImageClient(ShapeValue*);
1033 #endif
1034
1035 #ifndef NDEBUG
1036     void checkBlockPositionedObjectsNeedLayout();
1037 #endif
1038
1039     RefPtr<RenderStyle> m_style;
1040
1041     Node* m_node;
1042
1043     RenderObject* m_parent;
1044     RenderObject* m_previous;
1045     RenderObject* m_next;
1046
1047     static RenderObjectAncestorLineboxDirtySet* s_ancestorLineboxDirtySet;
1048
1049 #ifndef NDEBUG
1050     bool m_hasAXObject             : 1;
1051     bool m_setNeedsLayoutForbidden : 1;
1052 #endif
1053
1054 #define ADD_BOOLEAN_BITFIELD(name, Name) \
1055     private:\
1056         unsigned m_##name : 1;\
1057     public:\
1058         bool name() const { return m_##name; }\
1059         void set##Name(bool name) { m_##name = name; }\
1060
1061     class RenderObjectBitfields {
1062         enum PositionedState {
1063             IsStaticallyPositioned = 0,
1064             IsRelativelyPositioned = 1,
1065             IsOutOfFlowPositioned = 2,
1066             IsStickyPositioned = 3
1067         };
1068
1069     public:
1070         RenderObjectBitfields(Node* node)
1071             : m_needsLayout(false)
1072             , m_needsPositionedMovementLayout(false)
1073             , m_normalChildNeedsLayout(false)
1074             , m_posChildNeedsLayout(false)
1075             , m_needsSimplifiedNormalFlowLayout(false)
1076             , m_preferredLogicalWidthsDirty(false)
1077             , m_floating(false)
1078             , m_isAnonymous(!node)
1079             , m_isText(false)
1080             , m_isBox(false)
1081             , m_isInline(true)
1082             , m_isReplaced(false)
1083             , m_horizontalWritingMode(true)
1084             , m_isDragging(false)
1085             , m_hasLayer(false)
1086             , m_hasOverflowClip(false)
1087             , m_hasTransform(false)
1088             , m_hasReflection(false)
1089             , m_hasCounterNodeMap(false)
1090             , m_everHadLayout(false)
1091             , m_childrenInline(false)
1092             , m_hasColumns(false)
1093             , m_positionedState(IsStaticallyPositioned)
1094             , m_selectionState(SelectionNone)
1095             , m_flowThreadState(NotInsideFlowThread)
1096             , m_boxDecorationState(NoBoxDecorations)
1097         {
1098         }
1099         
1100         // 31 bits have been used here. There is one bit available.
1101         ADD_BOOLEAN_BITFIELD(needsLayout, NeedsLayout);
1102         ADD_BOOLEAN_BITFIELD(needsPositionedMovementLayout, NeedsPositionedMovementLayout);
1103         ADD_BOOLEAN_BITFIELD(normalChildNeedsLayout, NormalChildNeedsLayout);
1104         ADD_BOOLEAN_BITFIELD(posChildNeedsLayout, PosChildNeedsLayout);
1105         ADD_BOOLEAN_BITFIELD(needsSimplifiedNormalFlowLayout, NeedsSimplifiedNormalFlowLayout);
1106         ADD_BOOLEAN_BITFIELD(preferredLogicalWidthsDirty, PreferredLogicalWidthsDirty);
1107         ADD_BOOLEAN_BITFIELD(floating, Floating);
1108
1109         ADD_BOOLEAN_BITFIELD(isAnonymous, IsAnonymous);
1110         ADD_BOOLEAN_BITFIELD(isText, IsText);
1111         ADD_BOOLEAN_BITFIELD(isBox, IsBox);
1112         ADD_BOOLEAN_BITFIELD(isInline, IsInline);
1113         ADD_BOOLEAN_BITFIELD(isReplaced, IsReplaced);
1114         ADD_BOOLEAN_BITFIELD(horizontalWritingMode, HorizontalWritingMode);
1115         ADD_BOOLEAN_BITFIELD(isDragging, IsDragging);
1116
1117         ADD_BOOLEAN_BITFIELD(hasLayer, HasLayer);
1118         ADD_BOOLEAN_BITFIELD(hasOverflowClip, HasOverflowClip); // Set in the case of overflow:auto/scroll/hidden
1119         ADD_BOOLEAN_BITFIELD(hasTransform, HasTransform);
1120         ADD_BOOLEAN_BITFIELD(hasReflection, HasReflection);
1121
1122         ADD_BOOLEAN_BITFIELD(hasCounterNodeMap, HasCounterNodeMap);
1123         ADD_BOOLEAN_BITFIELD(everHadLayout, EverHadLayout);
1124
1125         // from RenderBlock
1126         ADD_BOOLEAN_BITFIELD(childrenInline, ChildrenInline);
1127         ADD_BOOLEAN_BITFIELD(hasColumns, HasColumns);
1128
1129     private:
1130         unsigned m_positionedState : 2; // PositionedState
1131         unsigned m_selectionState : 3; // SelectionState
1132         unsigned m_flowThreadState : 2; // FlowThreadState
1133         unsigned m_boxDecorationState : 2; // BoxDecorationState
1134
1135     public:
1136         bool isOutOfFlowPositioned() const { return m_positionedState == IsOutOfFlowPositioned; }
1137         bool isRelPositioned() const { return m_positionedState == IsRelativelyPositioned; }
1138         bool isStickyPositioned() const { return m_positionedState == IsStickyPositioned; }
1139         bool isPositioned() const { return m_positionedState != IsStaticallyPositioned; }
1140
1141         void setPositionedState(int positionState)
1142         {
1143             // This mask maps FixedPosition and AbsolutePosition to IsOutOfFlowPositioned, saving one bit.
1144             m_positionedState = static_cast<PositionedState>(positionState & 0x3);
1145         }
1146         void clearPositionedState() { m_positionedState = StaticPosition; }
1147
1148         ALWAYS_INLINE SelectionState selectionState() const { return static_cast<SelectionState>(m_selectionState); }
1149         ALWAYS_INLINE void setSelectionState(SelectionState selectionState) { m_selectionState = selectionState; }
1150         
1151         ALWAYS_INLINE FlowThreadState flowThreadState() const { return static_cast<FlowThreadState>(m_flowThreadState); }
1152         ALWAYS_INLINE void setFlowThreadState(FlowThreadState flowThreadState) { m_flowThreadState = flowThreadState; }
1153
1154         ALWAYS_INLINE BoxDecorationState boxDecorationState() const { return static_cast<BoxDecorationState>(m_boxDecorationState); }
1155         ALWAYS_INLINE void setBoxDecorationState(BoxDecorationState boxDecorationState) { m_boxDecorationState = boxDecorationState; }
1156     };
1157
1158 #undef ADD_BOOLEAN_BITFIELD
1159
1160     RenderObjectBitfields m_bitfields;
1161
1162     void setNeedsPositionedMovementLayout(bool b) { m_bitfields.setNeedsPositionedMovementLayout(b); }
1163     void setNormalChildNeedsLayout(bool b) { m_bitfields.setNormalChildNeedsLayout(b); }
1164     void setPosChildNeedsLayout(bool b) { m_bitfields.setPosChildNeedsLayout(b); }
1165     void setNeedsSimplifiedNormalFlowLayout(bool b) { m_bitfields.setNeedsSimplifiedNormalFlowLayout(b); }
1166     void setIsDragging(bool b) { m_bitfields.setIsDragging(b); }
1167     void setEverHadLayout(bool b) { m_bitfields.setEverHadLayout(b); }
1168
1169 private:
1170     // Store state between styleWillChange and styleDidChange
1171     static bool s_affectsParentBlock;
1172     static bool s_noLongerAffectsParentBlock;
1173 };
1174
1175 inline bool RenderObject::documentBeingDestroyed() const
1176 {
1177     return document().renderTreeBeingDestroyed();
1178 }
1179
1180 inline bool RenderObject::isBeforeContent() const
1181 {
1182     if (style()->styleType() != BEFORE)
1183         return false;
1184     // Text nodes don't have their own styles, so ignore the style on a text node.
1185     if (isText() && !isBR())
1186         return false;
1187     return true;
1188 }
1189
1190 inline bool RenderObject::isAfterContent() const
1191 {
1192     if (style()->styleType() != AFTER)
1193         return false;
1194     // Text nodes don't have their own styles, so ignore the style on a text node.
1195     if (isText() && !isBR())
1196         return false;
1197     return true;
1198 }
1199
1200 inline bool RenderObject::isBeforeOrAfterContent() const
1201 {
1202     return isBeforeContent() || isAfterContent();
1203 }
1204
1205 inline void RenderObject::setNeedsLayout(bool needsLayout, MarkingBehavior markParents)
1206 {
1207     bool alreadyNeededLayout = m_bitfields.needsLayout();
1208     m_bitfields.setNeedsLayout(needsLayout);
1209     if (needsLayout) {
1210         ASSERT(!isSetNeedsLayoutForbidden());
1211         if (!alreadyNeededLayout) {
1212             if (markParents == MarkContainingBlockChain)
1213                 markContainingBlocksForLayout();
1214             if (hasLayer())
1215                 setLayerNeedsFullRepaint();
1216         }
1217     } else {
1218         setEverHadLayout(true);
1219         setPosChildNeedsLayout(false);
1220         setNeedsSimplifiedNormalFlowLayout(false);
1221         setNormalChildNeedsLayout(false);
1222         setNeedsPositionedMovementLayout(false);
1223         setAncestorLineBoxDirty(false);
1224 #ifndef NDEBUG
1225         checkBlockPositionedObjectsNeedLayout();
1226 #endif
1227     }
1228 }
1229
1230 inline void RenderObject::setChildNeedsLayout(bool childNeedsLayout, MarkingBehavior markParents)
1231 {
1232     bool alreadyNeededLayout = normalChildNeedsLayout();
1233     setNormalChildNeedsLayout(childNeedsLayout);
1234     if (childNeedsLayout) {
1235         ASSERT(!isSetNeedsLayoutForbidden());
1236         if (!alreadyNeededLayout && markParents == MarkContainingBlockChain)
1237             markContainingBlocksForLayout();
1238     } else {
1239         setPosChildNeedsLayout(false);
1240         setNeedsSimplifiedNormalFlowLayout(false);
1241         setNormalChildNeedsLayout(false);
1242         setNeedsPositionedMovementLayout(false);
1243     }
1244 }
1245
1246 inline void RenderObject::setNeedsPositionedMovementLayout(const RenderStyle* oldStyle)
1247 {
1248     bool alreadyNeededLayout = needsPositionedMovementLayout();
1249     setNeedsPositionedMovementLayout(true);
1250     ASSERT(!isSetNeedsLayoutForbidden());
1251     if (!alreadyNeededLayout) {
1252         markContainingBlocksForLayout();
1253         if (hasLayer()) {
1254             if (oldStyle && m_style->diffRequiresRepaint(oldStyle))
1255                 setLayerNeedsFullRepaint();
1256             else
1257                 setLayerNeedsFullRepaintForPositionedMovementLayout();
1258         }
1259     }
1260 }
1261
1262 inline void RenderObject::setNeedsSimplifiedNormalFlowLayout()
1263 {
1264     bool alreadyNeededLayout = needsSimplifiedNormalFlowLayout();
1265     setNeedsSimplifiedNormalFlowLayout(true);
1266     ASSERT(!isSetNeedsLayoutForbidden());
1267     if (!alreadyNeededLayout) {
1268         markContainingBlocksForLayout();
1269         if (hasLayer())
1270             setLayerNeedsFullRepaint();
1271     }
1272 }
1273
1274 inline bool RenderObject::preservesNewline() const
1275 {
1276 #if ENABLE(SVG)
1277     if (isSVGInlineText())
1278         return false;
1279 #endif
1280         
1281     return style()->preserveNewline();
1282 }
1283
1284 inline bool RenderObject::layerCreationAllowedForSubtree() const
1285 {
1286 #if ENABLE(SVG)
1287     RenderObject* parentRenderer = parent();
1288     while (parentRenderer) {
1289         if (parentRenderer->isSVGHiddenContainer())
1290             return false;
1291         parentRenderer = parentRenderer->parent();
1292     }
1293 #endif
1294
1295     return true;
1296 }
1297
1298 inline void RenderObject::setSelectionStateIfNeeded(SelectionState state)
1299 {
1300     if (selectionState() == state)
1301         return;
1302
1303     setSelectionState(state);
1304 }
1305
1306 inline void RenderObject::setHasBoxDecorations(bool b)
1307 {
1308     if (!b) {
1309         m_bitfields.setBoxDecorationState(NoBoxDecorations);
1310         return;
1311     }
1312     if (hasBoxDecorations())
1313         return;
1314     m_bitfields.setBoxDecorationState(HasBoxDecorationsAndBackgroundObscurationStatusInvalid);
1315 }
1316
1317 inline void RenderObject::invalidateBackgroundObscurationStatus()
1318 {
1319     if (!hasBoxDecorations())
1320         return;
1321     m_bitfields.setBoxDecorationState(HasBoxDecorationsAndBackgroundObscurationStatusInvalid);
1322 }
1323
1324 inline bool RenderObject::backgroundIsKnownToBeObscured()
1325 {
1326     if (m_bitfields.boxDecorationState() == HasBoxDecorationsAndBackgroundObscurationStatusInvalid) {
1327         BoxDecorationState boxDecorationState = computeBackgroundIsKnownToBeObscured() ? HasBoxDecorationsAndBackgroundIsKnownToBeObscured : HasBoxDecorationsAndBackgroundMayBeVisible;
1328         m_bitfields.setBoxDecorationState(boxDecorationState);
1329     }
1330     return m_bitfields.boxDecorationState() == HasBoxDecorationsAndBackgroundIsKnownToBeObscured;
1331 }
1332
1333 inline int adjustForAbsoluteZoom(int value, RenderObject* renderer)
1334 {
1335     return adjustForAbsoluteZoom(value, renderer->style());
1336 }
1337
1338 #if ENABLE(SUBPIXEL_LAYOUT)
1339 inline LayoutUnit adjustLayoutUnitForAbsoluteZoom(LayoutUnit value, RenderObject* renderer)
1340 {
1341     return adjustLayoutUnitForAbsoluteZoom(value, renderer->style());
1342 }
1343 #endif
1344
1345 inline void adjustFloatQuadForAbsoluteZoom(FloatQuad& quad, RenderObject* renderer)
1346 {
1347     float zoom = renderer->style()->effectiveZoom();
1348     if (zoom != 1)
1349         quad.scale(1 / zoom, 1 / zoom);
1350 }
1351
1352 inline void adjustFloatRectForAbsoluteZoom(FloatRect& rect, RenderObject* renderer)
1353 {
1354     float zoom = renderer->style()->effectiveZoom();
1355     if (zoom != 1)
1356         rect.scale(1 / zoom, 1 / zoom);
1357 }
1358
1359 } // namespace WebCore
1360
1361 #ifndef NDEBUG
1362 // Outside the WebCore namespace for ease of invocation from gdb.
1363 void showTree(const WebCore::RenderObject*);
1364 void showLineTree(const WebCore::RenderObject*);
1365 void showRenderTree(const WebCore::RenderObject* object1);
1366 // We don't make object2 an optional parameter so that showRenderTree
1367 // can be called from gdb easily.
1368 void showRenderTree(const WebCore::RenderObject* object1, const WebCore::RenderObject* object2);
1369 #endif
1370
1371 #endif // RenderObject_h