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