RenderElement::m_style should be a Ref.
[WebKit-https.git] / Source / WebCore / rendering / RenderElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2003, 2006, 2007, 2009, 2013 Apple Inc. All rights reserved.
5  * Copyright (C) 2010, 2012 Google Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef RenderElement_h
24 #define RenderElement_h
25
26 #include "RenderObject.h"
27
28 namespace WebCore {
29
30 class RenderElement : public RenderObject {
31 public:
32     virtual ~RenderElement();
33
34     static RenderElement* createFor(Element&, PassRef<RenderStyle>);
35
36     bool hasInitializedStyle() const { return m_hasInitializedStyle; }
37
38     RenderStyle* style() const { return const_cast<RenderStyle*>(&m_style.get()); }
39     RenderStyle* firstLineStyle() const;
40
41     void initializeStyle();
42
43     virtual void setStyle(PassRef<RenderStyle>);
44     // Called to update a style that is allowed to trigger animations.
45     void setAnimatableStyle(PassRef<RenderStyle>);
46
47     // This is null for anonymous renderers.
48     Element* element() const { return toElement(RenderObject::node()); }
49     Element* nonPseudoElement() const { return toElement(RenderObject::nonPseudoNode()); }
50     Element* generatingElement() const;
51
52     RenderObject* firstChild() const { return m_firstChild; }
53     RenderObject* lastChild() const { return m_lastChild; }
54
55     // FIXME: Make these standalone and move to relevant files.
56     bool isRenderLayerModelObject() const;
57     bool isBoxModelObject() const;
58     bool isRenderBlock() const;
59     bool isRenderBlockFlow() const;
60     bool isRenderReplaced() const;
61     bool isRenderInline() const;
62     bool isRenderNamedFlowFragmentContainer() const;
63
64     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const { return true; }
65     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0);
66     virtual void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild = 0) { return addChild(newChild, beforeChild); }
67     virtual void removeChild(RenderObject&);
68
69     // The following functions are used when the render tree hierarchy changes to make sure layers get
70     // properly added and removed. Since containership can be implemented by any subclass, and since a hierarchy
71     // can contain a mixture of boxes and other object types, these functions need to be in the base class.
72     void addLayers(RenderLayer* parentLayer);
73     void removeLayers(RenderLayer* parentLayer);
74     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
75     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint, bool checkParent = true);
76
77     enum NotifyChildrenType { NotifyChildren, DontNotifyChildren };
78     void insertChildInternal(RenderObject*, RenderObject* beforeChild, NotifyChildrenType);
79     void removeChildInternal(RenderObject&, NotifyChildrenType);
80
81     virtual RenderElement* hoverAncestor() const;
82
83     virtual void dirtyLinesFromChangedChild(RenderObject*) { }
84
85     bool ancestorLineBoxDirty() const { return m_ancestorLineBoxDirty; }
86     void setAncestorLineBoxDirty(bool f = true);
87
88     void setChildNeedsLayout(MarkingBehavior = MarkContainingBlockChain);
89     void clearChildNeedsLayout();
90     void setNeedsPositionedMovementLayout(const RenderStyle* oldStyle);
91     void setNeedsSimplifiedNormalFlowLayout();
92
93     virtual void paint(PaintInfo&, const LayoutPoint&) = 0;
94
95     // Recursive function that computes the size and position of this object and all its descendants.
96     virtual void layout();
97
98     /* This function performs a layout only if one is needed. */
99     void layoutIfNeeded() { if (needsLayout()) layout(); }
100
101     // 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.
102     RenderElement* rendererForRootBackground();
103
104     // Used only by Element::pseudoStyleCacheIsInvalid to get a first line style based off of a
105     // given new style, without accessing the cache.
106     PassRefPtr<RenderStyle> uncachedFirstLineStyle(RenderStyle*) const;
107
108     // Updates only the local style ptr of the object. Does not update the state of the object,
109     // and so only should be called when the style is known not to have changed (or from setStyle).
110     void setStyleInternal(PassRef<RenderStyle> style) { m_style = std::move(style); }
111
112 protected:
113     enum BaseTypeFlags {
114         RenderLayerModelObjectFlag = 1 << 0,
115         RenderBoxModelObjectFlag = 1 << 1,
116         RenderInlineFlag = 1 << 2,
117         RenderReplacedFlag = 1 << 3,
118         RenderBlockFlag = 1 << 4,
119         RenderBlockFlowFlag = 1 << 5,
120     };
121
122     RenderElement(Element&, PassRef<RenderStyle>, unsigned baseTypeFlags);
123     RenderElement(Document&, PassRef<RenderStyle>, unsigned baseTypeFlags);
124
125     bool layerCreationAllowedForSubtree() const;
126
127     enum StylePropagationType { PropagateToAllChildren, PropagateToBlockChildrenOnly };
128     void propagateStyleToAnonymousChildren(StylePropagationType);
129
130     LayoutUnit valueForLength(const Length&, LayoutUnit maximumValue, bool roundPercentages = false) const;
131     LayoutUnit minimumValueForLength(const Length&, LayoutUnit maximumValue, bool roundPercentages = false) const;
132
133     void setFirstChild(RenderObject* child) { m_firstChild = child; }
134     void setLastChild(RenderObject* child) { m_lastChild = child; }
135     void destroyLeftoverChildren();
136
137     virtual void styleWillChange(StyleDifference, const RenderStyle& newStyle);
138     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
139
140     virtual void insertedIntoTree() OVERRIDE;
141     virtual void willBeRemovedFromTree() OVERRIDE;
142     virtual void willBeDestroyed() OVERRIDE;
143
144 private:
145     void node() const WTF_DELETED_FUNCTION;
146     void nonPseudoNode() const WTF_DELETED_FUNCTION;
147     void generatingNode() const WTF_DELETED_FUNCTION;
148     void isText() const WTF_DELETED_FUNCTION;
149     void isRenderElement() const WTF_DELETED_FUNCTION;
150
151     virtual RenderObject* firstChildSlow() const OVERRIDE FINAL { return firstChild(); }
152     virtual RenderObject* lastChildSlow() const OVERRIDE FINAL { return lastChild(); }
153
154     bool shouldRepaintForStyleDifference(StyleDifference) const;
155     bool hasImmediateNonWhitespaceTextChildOrBorderOrOutline() const;
156
157     void updateFillImages(const FillLayer*, const FillLayer*);
158     void updateImage(StyleImage*, StyleImage*);
159 #if ENABLE(CSS_SHAPES)
160     void updateShapeImage(const ShapeValue*, const ShapeValue*);
161 #endif
162
163     StyleDifference adjustStyleDifference(StyleDifference, unsigned contextSensitiveProperties) const;
164     RenderStyle* cachedFirstLineStyle() const;
165
166     unsigned m_baseTypeFlags : 6;
167     bool m_ancestorLineBoxDirty : 1;
168     bool m_hasInitializedStyle : 1;
169
170     RenderObject* m_firstChild;
171     RenderObject* m_lastChild;
172
173     Ref<RenderStyle> m_style;
174
175     // FIXME: Get rid of this hack.
176     // Store state between styleWillChange and styleDidChange
177     static bool s_affectsParentBlock;
178     static bool s_noLongerAffectsParentBlock;
179 };
180
181 inline RenderStyle* RenderElement::firstLineStyle() const
182 {
183     return document().styleSheetCollection().usesFirstLineRules() ? cachedFirstLineStyle() : style();
184 }
185
186 inline void RenderElement::setAncestorLineBoxDirty(bool f)
187 {
188     m_ancestorLineBoxDirty = f;
189     if (m_ancestorLineBoxDirty)
190         setNeedsLayout();
191 }
192
193 inline void RenderElement::setChildNeedsLayout(MarkingBehavior markParents)
194 {
195     ASSERT(!isSetNeedsLayoutForbidden());
196     if (normalChildNeedsLayout())
197         return;
198     setNormalChildNeedsLayoutBit(true);
199     if (markParents == MarkContainingBlockChain)
200         markContainingBlocksForLayout();
201 }
202
203 inline LayoutUnit RenderElement::valueForLength(const Length& length, LayoutUnit maximumValue, bool roundPercentages) const
204 {
205     return WebCore::valueForLength(length, maximumValue, &view(), roundPercentages);
206 }
207
208 inline LayoutUnit RenderElement::minimumValueForLength(const Length& length, LayoutUnit maximumValue, bool roundPercentages) const
209 {
210     return WebCore::minimumValueForLength(length, maximumValue, &view(), roundPercentages);
211 }
212
213 inline bool RenderElement::isRenderLayerModelObject() const
214 {
215     return m_baseTypeFlags & RenderLayerModelObjectFlag;
216 }
217
218 inline bool RenderElement::isBoxModelObject() const
219 {
220     return m_baseTypeFlags & RenderBoxModelObjectFlag;
221 }
222
223 inline bool RenderElement::isRenderBlock() const
224 {
225     return m_baseTypeFlags & RenderBlockFlag;
226 }
227
228 inline bool RenderElement::isRenderBlockFlow() const
229 {
230     return m_baseTypeFlags & RenderBlockFlowFlag;
231 }
232
233 inline bool RenderElement::isRenderReplaced() const
234 {
235     return m_baseTypeFlags & RenderReplacedFlag;
236 }
237
238 inline bool RenderElement::isRenderInline() const
239 {
240     return m_baseTypeFlags & RenderInlineFlag;
241 }
242
243 RENDER_OBJECT_TYPE_CASTS(RenderElement, isRenderElement())
244
245 inline Element* RenderElement::generatingElement() const
246 {
247     if (parent() && isRenderNamedFlowFragment())
248         return parent()->generatingElement();
249     return toElement(RenderObject::generatingNode());
250 }
251
252 inline bool RenderObject::isRenderLayerModelObject() const
253 {
254     return isRenderElement() && toRenderElement(this)->isRenderLayerModelObject();
255 }
256
257 inline bool RenderObject::isBoxModelObject() const
258 {
259     return isRenderElement() && toRenderElement(this)->isBoxModelObject();
260 }
261
262 inline bool RenderObject::isRenderBlock() const
263 {
264     return isRenderElement() && toRenderElement(this)->isRenderBlock();
265 }
266
267 inline bool RenderObject::isRenderBlockFlow() const
268 {
269     return isRenderElement() && toRenderElement(this)->isRenderBlockFlow();
270 }
271
272 inline bool RenderObject::isRenderReplaced() const
273 {
274     return isRenderElement() && toRenderElement(this)->isRenderReplaced();
275 }
276
277 inline bool RenderObject::isRenderInline() const
278 {
279     return isRenderElement() && toRenderElement(this)->isRenderInline();
280 }
281
282 inline RenderStyle* RenderObject::style() const
283 {
284     if (isText())
285         return m_parent->style();
286     return toRenderElement(this)->style();
287 }
288
289 inline RenderStyle* RenderObject::firstLineStyle() const
290 {
291     if (isText())
292         return m_parent->firstLineStyle();
293     return toRenderElement(this)->firstLineStyle();
294 }
295
296 inline RenderElement* ContainerNode::renderer() const
297 {
298     return toRenderElement(Node::renderer());
299 }
300
301 } // namespace WebCore
302
303 #endif // RenderElement_h