Computing animated style should not require renderers
[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 #pragma once
24
25 #include "LengthFunctions.h"
26 #include "RenderObject.h"
27
28 namespace WebCore {
29
30 class ControlStates;
31 class RenderBlock;
32
33 class RenderElement : public RenderObject {
34 public:
35     virtual ~RenderElement();
36
37     enum RendererCreationType { CreateAllRenderers, OnlyCreateBlockAndFlexboxRenderers };
38     static RenderPtr<RenderElement> createFor(Element&, RenderStyle&&, RendererCreationType = CreateAllRenderers);
39
40     bool hasInitializedStyle() const { return m_hasInitializedStyle; }
41
42     const RenderStyle& style() const { return m_style; }
43     const RenderStyle& firstLineStyle() const;
44
45     // FIXME: Style shouldn't be mutated.
46     RenderStyle& mutableStyle() { return m_style; }
47
48     void initializeStyle();
49
50     // Calling with minimalStyleDifference > StyleDifferenceEqual indicates that
51     // out-of-band state (e.g. animations) requires that styleDidChange processing
52     // continue even if the style isn't different from the current style.
53     void setStyle(RenderStyle&&, StyleDifference minimalStyleDifference = StyleDifferenceEqual);
54
55     // The pseudo element style can be cached or uncached.  Use the cached method if the pseudo element doesn't respect
56     // any pseudo classes (and therefore has no concept of changing state).
57     const RenderStyle* getCachedPseudoStyle(PseudoId, const RenderStyle* parentStyle = nullptr) const;
58     std::unique_ptr<RenderStyle> getUncachedPseudoStyle(const PseudoStyleRequest&, const RenderStyle* parentStyle = nullptr, const RenderStyle* ownStyle = nullptr) const;
59
60     // This is null for anonymous renderers.
61     Element* element() const { return downcast<Element>(RenderObject::node()); }
62     Element* nonPseudoElement() const { return downcast<Element>(RenderObject::nonPseudoNode()); }
63     Element* generatingElement() const;
64
65     RenderObject* firstChild() const { return m_firstChild; }
66     RenderObject* lastChild() const { return m_lastChild; }
67
68     bool canContainFixedPositionObjects() const;
69     bool canContainAbsolutelyPositionedObjects() const;
70
71     Color selectionColor(int colorProperty) const;
72     std::unique_ptr<RenderStyle> selectionPseudoStyle() const;
73
74     // Obtains the selection colors that should be used when painting a selection.
75     Color selectionBackgroundColor() const;
76     Color selectionForegroundColor() const;
77     Color selectionEmphasisMarkColor() const;
78
79     // FIXME: Make these standalone and move to relevant files.
80     bool isRenderLayerModelObject() const;
81     bool isBoxModelObject() const;
82     bool isRenderBlock() const;
83     bool isRenderBlockFlow() const;
84     bool isRenderReplaced() const;
85     bool isRenderInline() const;
86     bool isRenderNamedFlowFragmentContainer() const;
87
88     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const { return true; }
89     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = nullptr);
90     virtual void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild = nullptr) { return addChild(newChild, beforeChild); }
91     virtual void removeChild(RenderObject&);
92
93     // The following functions are used when the render tree hierarchy changes to make sure layers get
94     // properly added and removed. Since containership can be implemented by any subclass, and since a hierarchy
95     // can contain a mixture of boxes and other object types, these functions need to be in the base class.
96     void addLayers(RenderLayer* parentLayer);
97     void removeLayers(RenderLayer* parentLayer);
98     void moveLayers(RenderLayer* oldParent, RenderLayer* newParent);
99     RenderLayer* findNextLayer(RenderLayer* parentLayer, RenderObject* startPoint, bool checkParent = true);
100
101     enum NotifyChildrenType { NotifyChildren, DontNotifyChildren };
102     void insertChildInternal(RenderObject*, RenderObject* beforeChild, NotifyChildrenType);
103     void removeChildInternal(RenderObject&, NotifyChildrenType);
104
105     virtual RenderElement* hoverAncestor() const;
106
107     virtual void dirtyLinesFromChangedChild(RenderObject&) { }
108
109     bool ancestorLineBoxDirty() const { return m_ancestorLineBoxDirty; }
110     void setAncestorLineBoxDirty(bool f = true);
111
112     void setChildNeedsLayout(MarkingBehavior = MarkContainingBlockChain);
113     void clearChildNeedsLayout();
114     void setNeedsPositionedMovementLayout(const RenderStyle* oldStyle);
115     void setNeedsSimplifiedNormalFlowLayout();
116
117     virtual void paint(PaintInfo&, const LayoutPoint&) = 0;
118
119     // inline-block elements paint all phases atomically. This function ensures that. Certain other elements
120     // (grid items, flex items) require this behavior as well, and this function exists as a helper for them.
121     // It is expected that the caller will call this function independent of the value of paintInfo.phase.
122     void paintAsInlineBlock(PaintInfo&, const LayoutPoint&);
123
124     // Recursive function that computes the size and position of this object and all its descendants.
125     virtual void layout();
126
127     /* This function performs a layout only if one is needed. */
128     void layoutIfNeeded() { if (needsLayout()) layout(); }
129
130     // Updates only the local style ptr of the object. Does not update the state of the object,
131     // and so only should be called when the style is known not to have changed (or from setStyle).
132     void setStyleInternal(RenderStyle&& style) { m_style = WTFMove(style); }
133
134     // Repaint only if our old bounds and new bounds are different. The caller may pass in newBounds and newOutlineBox if they are known.
135     bool repaintAfterLayoutIfNeeded(const RenderLayerModelObject* repaintContainer, const LayoutRect& oldBounds, const LayoutRect& oldOutlineBox, const LayoutRect* newBoundsPtr = nullptr, const LayoutRect* newOutlineBoxPtr = nullptr);
136
137     bool borderImageIsLoadedAndCanBeRendered() const;
138     bool mayCauseRepaintInsideViewport(const IntRect* visibleRect = nullptr) const;
139     bool isVisibleInDocumentRect(const IntRect& documentRect) const;
140
141     // Returns true if this renderer requires a new stacking context.
142     static bool createsGroupForStyle(const RenderStyle&);
143     bool createsGroup() const { return createsGroupForStyle(style()); }
144
145     bool isTransparent() const { return style().opacity() < 1.0f; }
146     float opacity() const { return style().opacity(); }
147
148     bool visibleToHitTesting() const { return style().visibility() == VISIBLE && style().pointerEvents() != PE_NONE; }
149
150     bool hasBackground() const { return style().hasBackground(); }
151     bool hasMask() const { return style().hasMask(); }
152     bool hasClip() const { return isOutOfFlowPositioned() && style().hasClip(); }
153     bool hasClipOrOverflowClip() const { return hasClip() || hasOverflowClip(); }
154     bool hasClipPath() const { return style().clipPath(); }
155     bool hasHiddenBackface() const { return style().backfaceVisibility() == BackfaceVisibilityHidden; }
156     bool hasOutlineAnnotation() const;
157     bool hasOutline() const { return style().hasOutline() || hasOutlineAnnotation(); }
158     bool hasSelfPaintingLayer() const;
159
160     bool checkForRepaintDuringLayout() const;
161
162     // anchorRect() is conceptually similar to absoluteBoundingBoxRect(), but is intended for scrolling to an anchor.
163     // For inline renderers, this gets the logical top left of the first leaf child and the logical bottom right of the
164     // last leaf child, converts them to absolute coordinates, and makes a box out of them.
165     LayoutRect absoluteAnchorRect(bool* insideFixed = nullptr) const;
166
167     bool hasFilter() const { return style().hasFilter(); }
168     bool hasBackdropFilter() const
169     {
170 #if ENABLE(FILTERS_LEVEL_2)
171         return style().hasBackdropFilter();
172 #else
173         return false;
174 #endif
175     }
176
177
178 #if ENABLE(CSS_COMPOSITING)
179     bool hasBlendMode() const { return style().hasBlendMode(); }
180 #else
181     bool hasBlendMode() const { return false; }
182 #endif
183
184     bool hasShapeOutside() const { return style().shapeOutside(); }
185
186     void registerForVisibleInViewportCallback();
187     void unregisterForVisibleInViewportCallback();
188
189     VisibleInViewportState visibleInViewportState() const { return static_cast<VisibleInViewportState>(m_visibleInViewportState); }
190     void setVisibleInViewportState(VisibleInViewportState);
191     virtual void visibleInViewportStateChanged();
192
193     bool repaintForPausedImageAnimationsIfNeeded(const IntRect& visibleRect, CachedImage&);
194     bool hasPausedImageAnimations() const { return m_hasPausedImageAnimations; }
195     void setHasPausedImageAnimations(bool b) { m_hasPausedImageAnimations = b; }
196
197     void setRenderBoxNeedsLazyRepaint(bool b) { m_renderBoxNeedsLazyRepaint = b; }
198     bool renderBoxNeedsLazyRepaint() const { return m_renderBoxNeedsLazyRepaint; }
199
200     bool hasCounterNodeMap() const { return m_hasCounterNodeMap; }
201     void setHasCounterNodeMap(bool f) { m_hasCounterNodeMap = f; }
202
203     const RenderElement* enclosingRendererWithTextDecoration(TextDecoration, bool firstLine) const;
204     void drawLineForBoxSide(GraphicsContext&, const FloatRect&, BoxSide, Color, EBorderStyle, float adjacentWidth1, float adjacentWidth2, bool antialias = false) const;
205
206     bool childRequiresTable(const RenderObject& child) const;
207     bool hasContinuation() const { return m_hasContinuation; }
208
209 #if ENABLE(TEXT_AUTOSIZING)
210     void adjustComputedFontSizesOnBlocks(float size, float visibleWidth);
211     WEBCORE_EXPORT void resetTextAutosizing();
212 #endif
213     RenderBlock* containingBlockForFixedPosition() const;
214     RenderBlock* containingBlockForAbsolutePosition() const;
215
216     RespectImageOrientationEnum shouldRespectImageOrientation() const;
217
218     void removeFromRenderFlowThread();
219     virtual void resetFlowThreadContainingBlockAndChildInfoIncludingDescendants(RenderFlowThread*);
220
221     // Called before anonymousChild.setStyle(). Override to set custom styles for
222     // the child.
223     virtual void updateAnonymousChildStyle(const RenderObject&, RenderStyle&) const { };
224
225 protected:
226     enum BaseTypeFlag {
227         RenderLayerModelObjectFlag  = 1 << 0,
228         RenderBoxModelObjectFlag    = 1 << 1,
229         RenderInlineFlag            = 1 << 2,
230         RenderReplacedFlag          = 1 << 3,
231         RenderBlockFlag             = 1 << 4,
232         RenderBlockFlowFlag         = 1 << 5,
233     };
234     
235     typedef unsigned BaseTypeFlags;
236
237     RenderElement(Element&, RenderStyle&&, BaseTypeFlags);
238     RenderElement(Document&, RenderStyle&&, BaseTypeFlags);
239
240     bool layerCreationAllowedForSubtree() const;
241
242     enum StylePropagationType { PropagateToAllChildren, PropagateToBlockChildrenOnly };
243     void propagateStyleToAnonymousChildren(StylePropagationType);
244
245     LayoutUnit valueForLength(const Length&, LayoutUnit maximumValue) const;
246     LayoutUnit minimumValueForLength(const Length&, LayoutUnit maximumValue) const;
247
248     void setFirstChild(RenderObject* child) { m_firstChild = child; }
249     void setLastChild(RenderObject* child) { m_lastChild = child; }
250     void destroyLeftoverChildren();
251
252     virtual void styleWillChange(StyleDifference, const RenderStyle& newStyle);
253     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
254
255     void insertedIntoTree() override;
256     void willBeRemovedFromTree() override;
257     void willBeDestroyed() override;
258
259     void setRenderInlineAlwaysCreatesLineBoxes(bool b) { m_renderInlineAlwaysCreatesLineBoxes = b; }
260     bool renderInlineAlwaysCreatesLineBoxes() const { return m_renderInlineAlwaysCreatesLineBoxes; }
261
262     void setHasContinuation(bool b) { m_hasContinuation = b; }
263
264     void setRenderBlockHasMarginBeforeQuirk(bool b) { m_renderBlockHasMarginBeforeQuirk = b; }
265     void setRenderBlockHasMarginAfterQuirk(bool b) { m_renderBlockHasMarginAfterQuirk = b; }
266     void setRenderBlockShouldForceRelayoutChildren(bool b) { m_renderBlockShouldForceRelayoutChildren = b; }
267     bool renderBlockHasMarginBeforeQuirk() const { return m_renderBlockHasMarginBeforeQuirk; }
268     bool renderBlockHasMarginAfterQuirk() const { return m_renderBlockHasMarginAfterQuirk; }
269     bool renderBlockShouldForceRelayoutChildren() const { return m_renderBlockShouldForceRelayoutChildren; }
270
271     void setRenderBlockFlowLineLayoutPath(unsigned u) { m_renderBlockFlowLineLayoutPath = u; }
272     void setRenderBlockFlowHasMarkupTruncation(bool b) { m_renderBlockFlowHasMarkupTruncation = b; }
273     unsigned renderBlockFlowLineLayoutPath() const { return m_renderBlockFlowLineLayoutPath; }
274     bool renderBlockFlowHasMarkupTruncation() const { return m_renderBlockFlowHasMarkupTruncation; }
275
276     void paintFocusRing(PaintInfo&, const RenderStyle&, const Vector<LayoutRect>& focusRingRects);
277     void paintOutline(PaintInfo&, const LayoutRect&);
278     void updateOutlineAutoAncestor(bool hasOutlineAuto);
279
280     void removeFromRenderFlowThreadIncludingDescendants(bool shouldUpdateState);
281     void adjustFlowThreadStateOnContainingBlockChangeIfNeeded();
282     
283     bool noLongerAffectsParentBlock() const { return s_noLongerAffectsParentBlock; }
284     bool isVisibleInViewport() const;
285
286 private:
287     RenderElement(ContainerNode&, RenderStyle&&, BaseTypeFlags);
288     void node() const = delete;
289     void nonPseudoNode() const = delete;
290     void generatingNode() const = delete;
291     void isText() const = delete;
292     void isRenderElement() const = delete;
293
294     RenderObject* firstChildSlow() const final { return firstChild(); }
295     RenderObject* lastChildSlow() const final { return lastChild(); }
296
297     // Called when an object that was floating or positioned becomes a normal flow object
298     // again.  We have to make sure the render tree updates as needed to accommodate the new
299     // normal flow object.
300     void handleDynamicFloatPositionChange();
301     void removeAnonymousWrappersForInlinesIfNecessary();
302
303     bool shouldRepaintForStyleDifference(StyleDifference) const;
304     bool hasImmediateNonWhitespaceTextChildOrBorderOrOutline() const;
305
306     void updateFillImages(const FillLayer*, const FillLayer&);
307     void updateImage(StyleImage*, StyleImage*);
308     void updateShapeImage(const ShapeValue*, const ShapeValue*);
309
310     StyleDifference adjustStyleDifference(StyleDifference, unsigned contextSensitiveProperties) const;
311     std::unique_ptr<RenderStyle> computeFirstLineStyle() const;
312     void invalidateCachedFirstLineStyle();
313
314     bool canDestroyDecodedData() final { return !isVisibleInViewport(); }
315     VisibleInViewportState imageFrameAvailable(CachedImage&, ImageAnimatingState, const IntRect* changeRect) final;
316     void didRemoveCachedImageClient(CachedImage&) final;
317
318     bool getLeadingCorner(FloatPoint& output, bool& insideFixed) const;
319     bool getTrailingCorner(FloatPoint& output, bool& insideFixed) const;
320
321     void clearLayoutRootIfNeeded() const;
322     
323     bool shouldWillChangeCreateStackingContext() const;
324     void issueRepaintForOutlineAuto(float outlineSize);
325
326     unsigned m_baseTypeFlags : 6;
327     unsigned m_ancestorLineBoxDirty : 1;
328     unsigned m_hasInitializedStyle : 1;
329
330     unsigned m_renderInlineAlwaysCreatesLineBoxes : 1;
331     unsigned m_renderBoxNeedsLazyRepaint : 1;
332     unsigned m_hasPausedImageAnimations : 1;
333     unsigned m_hasCounterNodeMap : 1;
334     unsigned m_hasContinuation : 1;
335     mutable unsigned m_hasValidCachedFirstLineStyle : 1;
336
337     unsigned m_renderBlockHasMarginBeforeQuirk : 1;
338     unsigned m_renderBlockHasMarginAfterQuirk : 1;
339     unsigned m_renderBlockShouldForceRelayoutChildren : 1;
340     unsigned m_renderBlockFlowHasMarkupTruncation : 1;
341     unsigned m_renderBlockFlowLineLayoutPath : 2;
342
343     unsigned m_isRegisteredForVisibleInViewportCallback : 1;
344     unsigned m_visibleInViewportState : 2;
345
346     RenderObject* m_firstChild;
347     RenderObject* m_lastChild;
348
349     RenderStyle m_style;
350
351     // FIXME: Get rid of this hack.
352     // Store state between styleWillChange and styleDidChange
353     static bool s_affectsParentBlock;
354     static bool s_noLongerAffectsParentBlock;
355
356 protected:
357 #if !ASSERT_DISABLED
358     bool m_reparentingChild { false };
359 #endif
360 };
361
362 inline void RenderElement::setAncestorLineBoxDirty(bool f)
363 {
364     m_ancestorLineBoxDirty = f;
365     if (m_ancestorLineBoxDirty)
366         setNeedsLayout();
367 }
368
369 inline void RenderElement::setChildNeedsLayout(MarkingBehavior markParents)
370 {
371     ASSERT(!isSetNeedsLayoutForbidden());
372     if (normalChildNeedsLayout())
373         return;
374     setNormalChildNeedsLayoutBit(true);
375     if (markParents == MarkContainingBlockChain)
376         markContainingBlocksForLayout();
377 }
378
379 inline LayoutUnit RenderElement::valueForLength(const Length& length, LayoutUnit maximumValue) const
380 {
381     return WebCore::valueForLength(length, maximumValue);
382 }
383
384 inline LayoutUnit RenderElement::minimumValueForLength(const Length& length, LayoutUnit maximumValue) const
385 {
386     return WebCore::minimumValueForLength(length, maximumValue);
387 }
388
389 inline bool RenderElement::isRenderLayerModelObject() const
390 {
391     return m_baseTypeFlags & RenderLayerModelObjectFlag;
392 }
393
394 inline bool RenderElement::isBoxModelObject() const
395 {
396     return m_baseTypeFlags & RenderBoxModelObjectFlag;
397 }
398
399 inline bool RenderElement::isRenderBlock() const
400 {
401     return m_baseTypeFlags & RenderBlockFlag;
402 }
403
404 inline bool RenderElement::isRenderBlockFlow() const
405 {
406     return m_baseTypeFlags & RenderBlockFlowFlag;
407 }
408
409 inline bool RenderElement::isRenderReplaced() const
410 {
411     return m_baseTypeFlags & RenderReplacedFlag;
412 }
413
414 inline bool RenderElement::isRenderInline() const
415 {
416     return m_baseTypeFlags & RenderInlineFlag;
417 }
418
419 inline Element* RenderElement::generatingElement() const
420 {
421     if (parent() && isRenderNamedFlowFragment())
422         return parent()->generatingElement();
423     return downcast<Element>(RenderObject::generatingNode());
424 }
425
426 inline bool RenderElement::canContainFixedPositionObjects() const
427 {
428     return isRenderView()
429         || (hasTransform() && isRenderBlock())
430         || isSVGForeignObject()
431         || isOutOfFlowRenderFlowThread();
432 }
433
434 inline bool RenderElement::canContainAbsolutelyPositionedObjects() const
435 {
436     return style().position() != StaticPosition
437         || (isRenderBlock() && hasTransformRelatedProperty())
438         || isSVGForeignObject()
439         || isRenderView();
440 }
441
442 inline bool RenderElement::createsGroupForStyle(const RenderStyle& style)
443 {
444     return style.opacity() < 1.0f || style.hasMask() || style.clipPath() || style.hasFilter() || style.hasBackdropFilter() || style.hasBlendMode();
445 }
446
447 inline bool RenderObject::isRenderLayerModelObject() const
448 {
449     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderLayerModelObject();
450 }
451
452 inline bool RenderObject::isBoxModelObject() const
453 {
454     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isBoxModelObject();
455 }
456
457 inline bool RenderObject::isRenderBlock() const
458 {
459     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderBlock();
460 }
461
462 inline bool RenderObject::isRenderBlockFlow() const
463 {
464     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderBlockFlow();
465 }
466
467 inline bool RenderObject::isRenderReplaced() const
468 {
469     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderReplaced();
470 }
471
472 inline bool RenderObject::isRenderInline() const
473 {
474     return is<RenderElement>(*this) && downcast<RenderElement>(*this).isRenderInline();
475 }
476
477 inline const RenderStyle& RenderObject::style() const
478 {
479     if (isText())
480         return m_parent->style();
481     return downcast<RenderElement>(*this).style();
482 }
483
484 inline const RenderStyle& RenderObject::firstLineStyle() const
485 {
486     if (isText())
487         return m_parent->firstLineStyle();
488     return downcast<RenderElement>(*this).firstLineStyle();
489 }
490
491 inline RenderElement* ContainerNode::renderer() const
492 {
493     return downcast<RenderElement>(Node::renderer());
494 }
495
496 inline int adjustForAbsoluteZoom(int value, const RenderElement& renderer)
497 {
498     return adjustForAbsoluteZoom(value, renderer.style());
499 }
500
501 inline LayoutUnit adjustLayoutUnitForAbsoluteZoom(LayoutUnit value, const RenderElement& renderer)
502 {
503     return adjustLayoutUnitForAbsoluteZoom(value, renderer.style());
504 }
505
506 } // namespace WebCore
507
508 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderElement, isRenderElement())